1 // mips.h -- ELF definitions specific to EM_MIPS -*- C++ -*-
3 // Copyright (C) 2012-2024 Free Software Foundation, Inc.
4 // Written by Sasa Stankovic <sasa.stankovic@imgtec.com>
5 // and Aleksandar Simeonov <aleksandar.simeonov@rt-rk.com>.
7 // This file is part of elfcpp.
9 // This program is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Library General Public License
11 // as published by the Free Software Foundation; either version 2, or
12 // (at your option) any later version.
14 // In addition to the permissions in the GNU Library General Public
15 // License, the Free Software Foundation gives you unlimited
16 // permission to link the compiled version of this file into
17 // combinations with other programs, and to distribute those
18 // combinations without any restriction coming from the use of this
19 // file. (The Library Public License restrictions do apply in other
20 // respects; for example, they cover modification of the file, and
21 /// distribution when not linked into a combined executable.)
23 // This program is distributed in the hope that it will be useful, but
24 // WITHOUT ANY WARRANTY; without even the implied warranty of
25 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26 // Library General Public License for more details.
28 // You should have received a copy of the GNU Library General Public
29 // License along with this program; if not, write to the Free Software
30 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
36 // Documentation for the MIPS relocs is taken from
37 // http://math-atlas.sourceforge.net/devel/assembly/mipsabi32.pdf
43 // MIPS Relocation Codes
50 R_MIPS_32
= 2, // In Elf 64: alias R_MIPS_ADD
51 R_MIPS_REL32
= 3, // In Elf 64: alias R_MIPS_REL
55 R_MIPS_GPREL16
= 7, // In Elf 64: alias R_MIPS_GPREL
57 R_MIPS_GOT16
= 9, // In Elf 64: alias R_MIPS_GOT
59 R_MIPS_CALL16
= 11, // In Elf 64: alias R_MIPS_CALL
78 R_MIPS_CALL_HI16
= 30,
79 R_MIPS_CALL_LO16
= 31,
82 R_MIPS_ADD_IMMEDIATE
= 34,
87 R_MIPS_TLS_DTPMOD32
= 38,
88 R_MIPS_TLS_DTPREL32
= 39,
89 R_MIPS_TLS_DTPMOD64
= 40,
90 R_MIPS_TLS_DTPREL64
= 41,
93 R_MIPS_TLS_DTPREL_HI16
= 44,
94 R_MIPS_TLS_DTPREL_LO16
= 45,
95 R_MIPS_TLS_GOTTPREL
= 46,
96 R_MIPS_TLS_TPREL32
= 47,
97 R_MIPS_TLS_TPREL64
= 48,
98 R_MIPS_TLS_TPREL_HI16
= 49,
99 R_MIPS_TLS_TPREL_LO16
= 50,
100 R_MIPS_GLOB_DAT
= 51,
107 // These relocs are used for the mips16.
109 R_MIPS16_GPREL
= 101,
110 R_MIPS16_GOT16
= 102,
111 R_MIPS16_CALL16
= 103,
114 R_MIPS16_TLS_GD
= 106,
115 R_MIPS16_TLS_LDM
= 107,
116 R_MIPS16_TLS_DTPREL_HI16
= 108,
117 R_MIPS16_TLS_DTPREL_LO16
= 109,
118 R_MIPS16_TLS_GOTTPREL
= 110,
119 R_MIPS16_TLS_TPREL_HI16
= 111,
120 R_MIPS16_TLS_TPREL_LO16
= 112,
123 R_MIPS_JUMP_SLOT
= 127,
125 // These relocations are specific to microMIPS.
126 R_MICROMIPS_26_S1
= 133,
127 R_MICROMIPS_HI16
= 134,
128 R_MICROMIPS_LO16
= 135,
129 R_MICROMIPS_GPREL16
= 136, // In Elf 64: alias R_MICROMIPS_GPREL
130 R_MICROMIPS_LITERAL
= 137,
131 R_MICROMIPS_GOT16
= 138, // In Elf 64: alias R_MICROMIPS_GOT
132 R_MICROMIPS_PC7_S1
= 139,
133 R_MICROMIPS_PC10_S1
= 140,
134 R_MICROMIPS_PC16_S1
= 141,
135 R_MICROMIPS_CALL16
= 142, // In Elf 64: alias R_MICROMIPS_CALL
136 R_MICROMIPS_GOT_DISP
= 145,
137 R_MICROMIPS_GOT_PAGE
= 146,
138 R_MICROMIPS_GOT_OFST
= 147,
139 R_MICROMIPS_GOT_HI16
= 148,
140 R_MICROMIPS_GOT_LO16
= 149,
141 R_MICROMIPS_SUB
= 150,
142 R_MICROMIPS_HIGHER
= 151,
143 R_MICROMIPS_HIGHEST
= 152,
144 R_MICROMIPS_CALL_HI16
= 153,
145 R_MICROMIPS_CALL_LO16
= 154,
146 R_MICROMIPS_SCN_DISP
= 155,
147 R_MICROMIPS_JALR
= 156,
148 R_MICROMIPS_HI0_LO16
= 157,
150 R_MICROMIPS_TLS_GD
= 162,
151 R_MICROMIPS_TLS_LDM
= 163,
152 R_MICROMIPS_TLS_DTPREL_HI16
= 164,
153 R_MICROMIPS_TLS_DTPREL_LO16
= 165,
154 R_MICROMIPS_TLS_GOTTPREL
= 166,
155 R_MICROMIPS_TLS_TPREL_HI16
= 169,
156 R_MICROMIPS_TLS_TPREL_LO16
= 170,
157 // microMIPS GP- and PC-relative relocations.
158 R_MICROMIPS_GPREL7_S2
= 172,
159 R_MICROMIPS_PC23_S2
= 173,
161 // This was a GNU extension used by embedded-PIC. It was co-opted by
162 // mips-linux for exception-handling data. GCC stopped using it in
163 // May, 2004, then started using it again for compact unwind tables.
166 // This relocation is used internally by gas.
167 R_MIPS_GNU_REL16_S2
= 250,
168 // These are GNU extensions to enable C++ vtable garbage collection.
169 R_MIPS_GNU_VTINHERIT
= 253,
170 R_MIPS_GNU_VTENTRY
= 254
173 // Processor specific flags for the ELF header e_flags field.
176 // At least one .noreorder directive appears in the source.
177 EF_MIPS_NOREORDER
= 0x00000001,
178 // File contains position independent code.
179 EF_MIPS_PIC
= 0x00000002,
180 // Code in file uses the standard calling sequence for calling
181 // position independent code.
182 EF_MIPS_CPIC
= 0x00000004,
183 // ??? Unknown flag, set in IRIX 6's BSDdup2.o in libbsd.a.
184 EF_MIPS_XGOT
= 0x00000008,
185 // Code in file uses UCODE (obsolete)
186 EF_MIPS_UCODE
= 0x00000010,
187 // Code in file uses new ABI (-n32 on Irix 6).
188 EF_MIPS_ABI2
= 0x00000020,
189 // Process the .MIPS.options section first by ld
190 EF_MIPS_OPTIONS_FIRST
= 0x00000080,
191 // Architectural Extensions used by this file
192 EF_MIPS_ARCH_ASE
= 0x0f000000,
193 // Use MDMX multimedia extensions
194 EF_MIPS_ARCH_ASE_MDMX
= 0x08000000,
195 // Use MIPS-16 ISA extensions
196 EF_MIPS_ARCH_ASE_M16
= 0x04000000,
197 // Use MICROMIPS ISA extensions.
198 EF_MIPS_ARCH_ASE_MICROMIPS
= 0x02000000,
199 // Indicates code compiled for a 64-bit machine in 32-bit mode.
200 // (regs are 32-bits wide.)
201 EF_MIPS_32BITMODE
= 0x00000100,
202 // 32-bit machine but FP registers are 64 bit (-mfp64).
203 EF_MIPS_FP64
= 0x00000200,
204 /// Code in file uses the IEEE 754-2008 NaN encoding convention.
205 EF_MIPS_NAN2008
= 0x00000400,
207 EF_MIPS_DYNAMIC
= 0x40
210 // Machine variant if we know it. This field was invented at Cygnus,
211 // but it is hoped that other vendors will adopt it. If some standard
212 // is developed, this code should be changed to follow it.
215 EF_MIPS_MACH
= 0x00FF0000,
217 // Cygnus is choosing values between 80 and 9F;
218 // 00 - 7F should be left for a future standard;
219 // the rest are open.
221 EF_MIPS_MACH_3900
= 0x00810000,
222 EF_MIPS_MACH_4010
= 0x00820000,
223 EF_MIPS_MACH_4100
= 0x00830000,
224 EF_MIPS_MACH_4650
= 0x00850000,
225 EF_MIPS_MACH_4120
= 0x00870000,
226 EF_MIPS_MACH_4111
= 0x00880000,
227 EF_MIPS_MACH_SB1
= 0x008a0000,
228 EF_MIPS_MACH_OCTEON
= 0x008b0000,
229 EF_MIPS_MACH_XLR
= 0x008c0000,
230 EF_MIPS_MACH_OCTEON2
= 0x008d0000,
231 EF_MIPS_MACH_OCTEON3
= 0x008e0000,
232 EF_MIPS_MACH_5400
= 0x00910000,
233 EF_MIPS_MACH_5900
= 0x00920000,
234 EF_MIPS_MACH_5500
= 0x00980000,
235 EF_MIPS_MACH_9000
= 0x00990000,
236 EF_MIPS_MACH_LS2E
= 0x00A00000,
237 EF_MIPS_MACH_LS2F
= 0x00A10000,
238 EF_MIPS_MACH_GS464
= 0x00A20000,
239 EF_MIPS_MACH_GS464E
= 0x00A30000,
240 EF_MIPS_MACH_GS264E
= 0x00A40000,
242 // In order to support backwards compatibility we also
243 // define the old versions of some of these constants.
244 E_MIPS_MACH_3900
= EF_MIPS_MACH_3900
,
245 E_MIPS_MACH_4010
= EF_MIPS_MACH_4010
,
246 E_MIPS_MACH_4100
= EF_MIPS_MACH_4100
,
247 E_MIPS_MACH_4650
= EF_MIPS_MACH_4650
,
248 E_MIPS_MACH_4120
= EF_MIPS_MACH_4120
,
249 E_MIPS_MACH_4111
= EF_MIPS_MACH_4111
,
250 E_MIPS_MACH_SB1
= EF_MIPS_MACH_SB1
,
251 E_MIPS_MACH_OCTEON
= EF_MIPS_MACH_OCTEON
,
252 E_MIPS_MACH_XLR
= EF_MIPS_MACH_XLR
,
253 E_MIPS_MACH_OCTEON2
= EF_MIPS_MACH_OCTEON2
,
254 E_MIPS_MACH_OCTEON3
= EF_MIPS_MACH_OCTEON3
,
255 E_MIPS_MACH_5400
= EF_MIPS_MACH_5400
,
256 E_MIPS_MACH_5900
= EF_MIPS_MACH_5900
,
257 E_MIPS_MACH_5500
= EF_MIPS_MACH_5500
,
258 E_MIPS_MACH_9000
= EF_MIPS_MACH_9000
,
259 E_MIPS_MACH_LS2E
= EF_MIPS_MACH_LS2E
,
260 E_MIPS_MACH_LS2F
= EF_MIPS_MACH_LS2F
,
261 E_MIPS_MACH_GS464
= EF_MIPS_MACH_GS464
,
262 E_MIPS_MACH_GS464E
= EF_MIPS_MACH_GS464E
,
263 E_MIPS_MACH_GS264E
= EF_MIPS_MACH_GS264E
,
269 // Four bit MIPS architecture field.
270 EF_MIPS_ARCH
= 0xf0000000,
272 EF_MIPS_ARCH_1
= 0x00000000,
274 EF_MIPS_ARCH_2
= 0x10000000,
276 EF_MIPS_ARCH_3
= 0x20000000,
278 EF_MIPS_ARCH_4
= 0x30000000,
280 EF_MIPS_ARCH_5
= 0x40000000,
282 EF_MIPS_ARCH_32
= 0x50000000,
284 EF_MIPS_ARCH_64
= 0x60000000,
286 EF_MIPS_ARCH_32R2
= 0x70000000,
288 EF_MIPS_ARCH_64R2
= 0x80000000,
290 EF_MIPS_ARCH_32R6
= 0x90000000,
292 EF_MIPS_ARCH_64R6
= 0xa0000000,
294 // In order to support backwards compatibility we also
295 // define the old versions of some of these constants.
296 E_MIPS_ARCH_1
= EF_MIPS_ARCH_1
,
297 E_MIPS_ARCH_2
= EF_MIPS_ARCH_2
,
298 E_MIPS_ARCH_3
= EF_MIPS_ARCH_3
,
299 E_MIPS_ARCH_4
= EF_MIPS_ARCH_4
,
300 E_MIPS_ARCH_5
= EF_MIPS_ARCH_5
,
301 E_MIPS_ARCH_32
= EF_MIPS_ARCH_32
,
302 E_MIPS_ARCH_64
= EF_MIPS_ARCH_64
,
303 E_MIPS_ARCH_32R2
= EF_MIPS_ARCH_32R2
,
304 E_MIPS_ARCH_64R2
= EF_MIPS_ARCH_64R2
,
305 E_MIPS_ARCH_32R6
= EF_MIPS_ARCH_32R6
,
306 E_MIPS_ARCH_64R6
= EF_MIPS_ARCH_64R6
,
310 // Values for the xxx_size bytes of an ABI flags structure.
319 // 128-bit registers.
323 // Masks for the ases word of an ABI flags structure.
327 AFL_ASE_DSP
= 0x00000001,
329 AFL_ASE_DSPR2
= 0x00000002,
330 // Enhanced VA Scheme.
331 AFL_ASE_EVA
= 0x00000004,
332 // MCU (MicroController) ASE.
333 AFL_ASE_MCU
= 0x00000008,
335 AFL_ASE_MDMX
= 0x00000010,
337 AFL_ASE_MIPS3D
= 0x00000020,
339 AFL_ASE_MT
= 0x00000040,
341 AFL_ASE_SMARTMIPS
= 0x00000080,
343 AFL_ASE_VIRT
= 0x00000100,
345 AFL_ASE_MSA
= 0x00000200,
347 AFL_ASE_MIPS16
= 0x00000400,
349 AFL_ASE_MICROMIPS
= 0x00000800,
351 AFL_ASE_XPA
= 0x00001000,
353 AFL_ASE_LOONGSON_EXT
= 0x00002000
356 // Values for the isa_ext word of an ABI flags structure.
359 // RMI Xlr instruction.
361 // Cavium Networks Octeon2.
363 // Cavium Networks OcteonP.
366 AFL_EXT_LOONGSON_3A
= 4,
367 // Cavium Networks Octeon.
369 // MIPS R5900 instruction.
371 // MIPS R4650 instruction.
373 // LSI R4010 instruction.
375 // NEC VR4100 instruction.
377 // Toshiba R3900 instruction.
379 // MIPS R10000 instruction.
381 // Broadcom SB-1 instruction.
383 // NEC VR4111/VR4181 instruction.
385 // NEC VR4120 instruction.
387 // NEC VR5400 instruction.
389 // NEC VR5500 instruction.
391 // ST Microelectronics Loongson 2E.
392 AFL_EXT_LOONGSON_2E
= 17,
393 // ST Microelectronics Loongson 2F.
394 AFL_EXT_LOONGSON_2F
= 18,
395 // Cavium Networks Octeon3.
399 // Masks for the flags1 word of an ABI flags structure.
402 // Uses odd single-precision registers.
403 AFL_FLAGS1_ODDSPREG
= 1
406 // Object attribute tags.
410 // Floating-point ABI used by this object file.
411 Tag_GNU_MIPS_ABI_FP
= 4,
412 // MSA ABI used by this object file.
413 Tag_GNU_MIPS_ABI_MSA
= 8
416 // Object attribute values.
419 // Values defined for Tag_GNU_MIPS_ABI_FP.
420 // Not tagged or not using any ABIs affected by the differences.
421 Val_GNU_MIPS_ABI_FP_ANY
= 0,
422 // Using hard-float -mdouble-float.
423 Val_GNU_MIPS_ABI_FP_DOUBLE
= 1,
424 // Using hard-float -msingle-float.
425 Val_GNU_MIPS_ABI_FP_SINGLE
= 2,
427 Val_GNU_MIPS_ABI_FP_SOFT
= 3,
428 // Using -mips32r2 -mfp64.
429 Val_GNU_MIPS_ABI_FP_OLD_64
= 4,
431 Val_GNU_MIPS_ABI_FP_XX
= 5,
432 // Using -mips32r2 -mfp64.
433 Val_GNU_MIPS_ABI_FP_64
= 6,
434 // Using -mips32r2 -mfp64 -mno-odd-spreg.
435 Val_GNU_MIPS_ABI_FP_64A
= 7,
436 // This is reserved for backward-compatibility with an earlier
437 // implementation of the MIPS NaN2008 functionality.
438 Val_GNU_MIPS_ABI_FP_NAN2008
= 8,
440 // Values defined for Tag_GNU_MIPS_ABI_MSA.
441 // Not tagged or not using any ABIs affected by the differences.
442 Val_GNU_MIPS_ABI_MSA_ANY
= 0,
443 // Using 128-bit MSA.
444 Val_GNU_MIPS_ABI_MSA_128
= 1
449 // Mask to extract ABI version, not really a flag value.
450 EF_MIPS_ABI
= 0x0000F000,
452 // The original o32 abi.
453 EF_MIPS_ABI_O32
= 0x00001000,
454 // O32 extended to work on 64 bit architectures
455 EF_MIPS_ABI_O64
= 0x00002000,
456 // EABI in 32 bit mode
457 EF_MIPS_ABI_EABI32
= 0x00003000,
458 // EABI in 64 bit mode
459 EF_MIPS_ABI_EABI64
= 0x00004000,
461 // In order to support backwards compatibility we also
462 // define the old versions of some of these constants.
463 E_MIPS_ABI_O32
= EF_MIPS_ABI_O32
,
464 E_MIPS_ABI_O64
= EF_MIPS_ABI_O64
,
465 E_MIPS_ABI_EABI32
= EF_MIPS_ABI_EABI32
,
466 E_MIPS_ABI_EABI64
= EF_MIPS_ABI_EABI64
,
469 // Dynamic section MIPS flags
473 RHF_NONE
= 0x00000000,
474 // Use shortcut pointers
475 RHF_QUICKSTART
= 0x00000001,
476 // Hash size not power of two
477 RHF_NOTPOT
= 0x00000002,
478 // Ignore LD_LIBRARY_PATH
479 RHF_NO_LIBRARY_REPLACEMENT
= 0x00000004
482 // Special values for the st_other field in the symbol table.
485 // Two topmost bits denote the MIPS ISA for .text symbols:
486 // + 00 -- standard MIPS code,
487 // + 10 -- microMIPS code,
488 // + 11 -- MIPS16 code; requires the following two bits to be set too.
489 // Note that one of the MIPS16 bits overlaps with STO_MIPS_PIC.
492 // The mask spanning the rest of MIPS psABI flags. At most one is expected
493 // to be set except for STO_MIPS16.
494 STO_MIPS_FLAGS
= ~(STO_MIPS_ISA
| 0x3),
496 // The MIPS psABI was updated in 2008 with support for PLTs and copy
497 // relocs. There are therefore two types of nonzero SHN_UNDEF functions:
498 // PLT entries and traditional MIPS lazy binding stubs. We mark the former
499 // with STO_MIPS_PLT to distinguish them from the latter.
502 // This value is used to mark PIC functions in an object that mixes
503 // PIC and non-PIC. Note that this bit overlaps with STO_MIPS16,
504 // although MIPS16 symbols are never considered to be MIPS_PIC.
507 // This value is used for a mips16 .text symbol.
510 // This value is used for a microMIPS .text symbol. To distinguish from
511 // STO_MIPS16, we set top two bits to be 10 to denote STO_MICROMIPS. The
512 // mask is STO_MIPS_ISA.
516 // Values for base offsets for thread-local storage
525 elf_st_is_mips16(unsigned char st_other
)
526 { return (st_other
& elfcpp::STO_MIPS16
) == elfcpp::STO_MIPS16
; }
529 elf_st_is_micromips(unsigned char st_other
)
530 { return (st_other
& elfcpp::STO_MIPS_ISA
) == elfcpp::STO_MICROMIPS
; }
532 // Whether the ABI is N32.
534 abi_n32(elfcpp::Elf_Word e_flags
)
535 { return (e_flags
& elfcpp::EF_MIPS_ABI2
) != 0; }
537 // Whether the ISA is R6.
539 r6_isa(elfcpp::Elf_Word e_flags
)
541 return ((e_flags
& elfcpp::EF_MIPS_ARCH
) == elfcpp::EF_MIPS_ARCH_32R6
)
542 || ((e_flags
& elfcpp::EF_MIPS_ARCH
) == elfcpp::EF_MIPS_ARCH_64R6
);
545 // Whether the file has microMIPS code.
547 is_micromips(elfcpp::Elf_Word e_flags
)
548 { return (e_flags
& elfcpp::EF_MIPS_ARCH_ASE_MICROMIPS
) != 0; }
550 // Values which may appear in the kind field of an Elf_Options structure.
555 // Register usage and GP value.
557 // Exception processing information.
559 // Section padding information.
561 // Hardware workarounds performed.
563 // Fill value used by the linker.
565 // Reserved space for desktop tools.
567 // Hardware workarounds, AND bits when merging.
569 // Hardware workarounds, OR bits when merging.
571 // GP group to use for text/data sections.
577 } // End namespace elfcpp.
579 #endif // !defined(ELFCPP_MIPS_H)