xref: /netbsd-src/external/gpl3/gdb/dist/include/elf/riscv.h (revision 02f41505626a9ceb584d30d0789203495760ac88)
1 /* RISC-V ELF support for BFD.
2    Copyright (C) 2011-2024 Free Software Foundation, Inc.
3 
4    Contributed by Andrew Waterman (andrew@sifive.com).
5    Based on MIPS ELF support for BFD, by Ian Lance Taylor.
6 
7    This file is part of BFD, the Binary File Descriptor library.
8 
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13 
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18 
19    You should have received a copy of the GNU General Public License
20    along with this program; see the file COPYING3. If not,
21    see <http://www.gnu.org/licenses/>.  */
22 
23 /* This file holds definitions specific to the RISCV ELF ABI.  Note
24    that most of this is not actually implemented by BFD.  */
25 
26 #ifndef _ELF_RISCV_H
27 #define _ELF_RISCV_H
28 
29 #include "elf/reloc-macros.h"
30 #include "libiberty.h"
31 
32 /* Relocation types.  */
33 START_RELOC_NUMBERS (elf_riscv_reloc_type)
34   /* Relocation types used by the dynamic linker.  */
35   RELOC_NUMBER (R_RISCV_NONE, 0)
36   RELOC_NUMBER (R_RISCV_32, 1)
37   RELOC_NUMBER (R_RISCV_64, 2)
38   RELOC_NUMBER (R_RISCV_RELATIVE, 3)
39   RELOC_NUMBER (R_RISCV_COPY, 4)
40   RELOC_NUMBER (R_RISCV_JUMP_SLOT, 5)
41   RELOC_NUMBER (R_RISCV_TLS_DTPMOD32, 6)
42   RELOC_NUMBER (R_RISCV_TLS_DTPMOD64, 7)
43   RELOC_NUMBER (R_RISCV_TLS_DTPREL32, 8)
44   RELOC_NUMBER (R_RISCV_TLS_DTPREL64, 9)
45   RELOC_NUMBER (R_RISCV_TLS_TPREL32, 10)
46   RELOC_NUMBER (R_RISCV_TLS_TPREL64, 11)
47   RELOC_NUMBER (R_RISCV_TLSDESC, 12)
48 
49   /* Relocation types not used by the dynamic linker.  */
50   RELOC_NUMBER (R_RISCV_BRANCH, 16)
51   RELOC_NUMBER (R_RISCV_JAL, 17)
52   RELOC_NUMBER (R_RISCV_CALL, 18)
53   RELOC_NUMBER (R_RISCV_CALL_PLT, 19)
54   RELOC_NUMBER (R_RISCV_GOT_HI20, 20)
55   RELOC_NUMBER (R_RISCV_TLS_GOT_HI20, 21)
56   RELOC_NUMBER (R_RISCV_TLS_GD_HI20, 22)
57   RELOC_NUMBER (R_RISCV_PCREL_HI20, 23)
58   RELOC_NUMBER (R_RISCV_PCREL_LO12_I, 24)
59   RELOC_NUMBER (R_RISCV_PCREL_LO12_S, 25)
60   RELOC_NUMBER (R_RISCV_HI20, 26)
61   RELOC_NUMBER (R_RISCV_LO12_I, 27)
62   RELOC_NUMBER (R_RISCV_LO12_S, 28)
63   RELOC_NUMBER (R_RISCV_TPREL_HI20, 29)
64   RELOC_NUMBER (R_RISCV_TPREL_LO12_I, 30)
65   RELOC_NUMBER (R_RISCV_TPREL_LO12_S, 31)
66   RELOC_NUMBER (R_RISCV_TPREL_ADD, 32)
67   RELOC_NUMBER (R_RISCV_ADD8, 33)
68   RELOC_NUMBER (R_RISCV_ADD16, 34)
69   RELOC_NUMBER (R_RISCV_ADD32, 35)
70   RELOC_NUMBER (R_RISCV_ADD64, 36)
71   RELOC_NUMBER (R_RISCV_SUB8, 37)
72   RELOC_NUMBER (R_RISCV_SUB16, 38)
73   RELOC_NUMBER (R_RISCV_SUB32, 39)
74   RELOC_NUMBER (R_RISCV_SUB64, 40)
75   RELOC_NUMBER (R_RISCV_ALIGN, 43)
76   RELOC_NUMBER (R_RISCV_RVC_BRANCH, 44)
77   RELOC_NUMBER (R_RISCV_RVC_JUMP, 45)
78   RELOC_NUMBER (R_RISCV_RVC_LUI, 46)
79   RELOC_NUMBER (R_RISCV_GPREL_I, 47)
80   RELOC_NUMBER (R_RISCV_GPREL_S, 48)
81   RELOC_NUMBER (R_RISCV_TPREL_I, 49)
82   RELOC_NUMBER (R_RISCV_TPREL_S, 50)
83   RELOC_NUMBER (R_RISCV_RELAX, 51)
84   RELOC_NUMBER (R_RISCV_SUB6, 52)
85   RELOC_NUMBER (R_RISCV_SET6, 53)
86   RELOC_NUMBER (R_RISCV_SET8, 54)
87   RELOC_NUMBER (R_RISCV_SET16, 55)
88   RELOC_NUMBER (R_RISCV_SET32, 56)
89   RELOC_NUMBER (R_RISCV_32_PCREL, 57)
90   RELOC_NUMBER (R_RISCV_IRELATIVE, 58)
91   /* Reserved 59 for R_RISCV_PLT32.  */
92   RELOC_NUMBER (R_RISCV_SET_ULEB128, 60)
93   RELOC_NUMBER (R_RISCV_SUB_ULEB128, 61)
94   RELOC_NUMBER (R_RISCV_TLSDESC_HI20, 62)
95   RELOC_NUMBER (R_RISCV_TLSDESC_LOAD_LO12, 63)
96   RELOC_NUMBER (R_RISCV_TLSDESC_ADD_LO12, 64)
97   RELOC_NUMBER (R_RISCV_TLSDESC_CALL, 65)
98 END_RELOC_NUMBERS (R_RISCV_max)
99 
100 /* Internal relocations used exclusively by the relaxation pass.  */
101 #define R_RISCV_DELETE  (R_RISCV_max)
102 #define R_RISCV_RVC_LUI (R_RISCV_max + 1)
103 #define R_RISCV_GPREL_I (R_RISCV_max + 2)
104 #define R_RISCV_GPREL_S (R_RISCV_max + 3)
105 #define R_RISCV_TPREL_I (R_RISCV_max + 4)
106 #define R_RISCV_TPREL_S (R_RISCV_max + 5)
107 
108 /* Processor specific flags for the ELF header e_flags field.  */
109 
110 /* File may contain compressed instructions.  */
111 #define EF_RISCV_RVC 0x0001
112 
113 /* Which floating-point ABI a file uses.  */
114 #define EF_RISCV_FLOAT_ABI 0x0006
115 
116 /* File uses the soft-float ABI.  */
117 #define EF_RISCV_FLOAT_ABI_SOFT 0x0000
118 
119 /* File uses the single-float ABI.  */
120 #define EF_RISCV_FLOAT_ABI_SINGLE 0x0002
121 
122 /* File uses the double-float ABI.  */
123 #define EF_RISCV_FLOAT_ABI_DOUBLE 0x0004
124 
125 /* File uses the quad-float ABI.  */
126 #define EF_RISCV_FLOAT_ABI_QUAD 0x0006
127 
128 /* File uses the 32E base integer instruction.  */
129 #define EF_RISCV_RVE 0x0008
130 
131 /* The name of the global pointer symbol.  */
132 #define RISCV_GP_SYMBOL "__global_pointer$"
133 
134 /* Processor specific dynamic array tags.  */
135 #define DT_RISCV_VARIANT_CC (DT_LOPROC + 1)
136 
137 /* RISC-V specific values for st_other.  */
138 #define STO_RISCV_VARIANT_CC 0x80
139 
140 /* File uses the TSO model. */
141 #define EF_RISCV_TSO 0x0010
142 
143 /* Additional section types.  */
144 #define SHT_RISCV_ATTRIBUTES 0x70000003 /* Section holds attributes.  */
145 
146 /* Processor specific program header types.  */
147 
148 /* Location of RISC-V ELF attribute section. */
149 #define PT_RISCV_ATTRIBUTES 0x70000003
150 
151 /* Object attributes.  */
152 enum
153 {
154   /* 0-3 are generic.  */
155   Tag_RISCV_stack_align = 4,
156   Tag_RISCV_arch = 5,
157   Tag_RISCV_unaligned_access = 6,
158   Tag_RISCV_priv_spec = 8,
159   Tag_RISCV_priv_spec_minor = 10,
160   Tag_RISCV_priv_spec_revision = 12
161 };
162 
163 #endif /* _ELF_RISCV_H */
164