1 /* BFD support for handling relocation entries.
2 Copyright (C) 1990, 91, 92, 93, 94, 95, 96, 97, 98, 1999
3 Free Software Foundation, Inc.
4 Written by Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
26 BFD maintains relocations in much the same way it maintains
27 symbols: they are left alone until required, then read in
28 en-mass and translated into an internal form. A common
29 routine <<bfd_perform_relocation>> acts upon the
30 canonical form to do the fixup.
32 Relocations are maintained on a per section basis,
33 while symbols are maintained on a per BFD basis.
35 All that a back end has to do to fit the BFD interface is to create
36 a <<struct reloc_cache_entry>> for each relocation
37 in a particular section, and fill in the right bits of the structures.
46 /* DO compile in the reloc_code name table from libbfd.h. */
47 #define _BFD_MAKE_TABLE_bfd_reloc_code_real
56 typedef arelent, howto manager, Relocations, Relocations
61 This is the structure of a relocation entry:
65 .typedef enum bfd_reloc_status
67 . {* No errors detected *}
70 . {* The relocation was performed, but there was an overflow. *}
73 . {* The address to relocate was not within the section supplied. *}
74 . bfd_reloc_outofrange,
76 . {* Used by special functions *}
79 . {* Unsupported relocation size requested. *}
80 . bfd_reloc_notsupported,
85 . {* The symbol to relocate against was undefined. *}
86 . bfd_reloc_undefined,
88 . {* The relocation was performed, but may not be ok - presently
89 . generated only when linking i960 coff files with i960 b.out
90 . symbols. If this type is returned, the error_message argument
91 . to bfd_perform_relocation will be set. *}
94 . bfd_reloc_status_type;
97 .typedef struct reloc_cache_entry
99 . {* A pointer into the canonical table of pointers *}
100 . struct symbol_cache_entry **sym_ptr_ptr;
102 . {* offset in section *}
103 . bfd_size_type address;
105 . {* addend for relocation value *}
108 . {* Pointer to how to perform the required relocation *}
109 . reloc_howto_type *howto;
118 Here is a description of each of the fields within an <<arelent>>:
122 The symbol table pointer points to a pointer to the symbol
123 associated with the relocation request. It is
124 the pointer into the table returned by the back end's
125 <<get_symtab>> action. @xref{Symbols}. The symbol is referenced
126 through a pointer to a pointer so that tools like the linker
127 can fix up all the symbols of the same name by modifying only
128 one pointer. The relocation routine looks in the symbol and
129 uses the base of the section the symbol is attached to and the
130 value of the symbol as the initial relocation offset. If the
131 symbol pointer is zero, then the section provided is looked up.
135 The <<address>> field gives the offset in bytes from the base of
136 the section data which owns the relocation record to the first
137 byte of relocatable information. The actual data relocated
138 will be relative to this point; for example, a relocation
139 type which modifies the bottom two bytes of a four byte word
140 would not touch the first byte pointed to in a big endian
145 The <<addend>> is a value provided by the back end to be added (!)
146 to the relocation offset. Its interpretation is dependent upon
147 the howto. For example, on the 68k the code:
153 | return foo[0x12345678];
156 Could be compiled into:
159 | moveb @@#12345678,d0
165 This could create a reloc pointing to <<foo>>, but leave the
166 offset in the data, something like:
169 |RELOCATION RECORDS FOR [.text]:
173 |00000000 4e56 fffc ; linkw fp,#-4
174 |00000004 1039 1234 5678 ; moveb @@#12345678,d0
175 |0000000a 49c0 ; extbl d0
176 |0000000c 4e5e ; unlk fp
180 Using coff and an 88k, some instructions don't have enough
181 space in them to represent the full address range, and
182 pointers have to be loaded in two parts. So you'd get something like:
185 | or.u r13,r0,hi16(_foo+0x12345678)
186 | ld.b r2,r13,lo16(_foo+0x12345678)
190 This should create two relocs, both pointing to <<_foo>>, and with
191 0x12340000 in their addend field. The data would consist of:
194 |RELOCATION RECORDS FOR [.text]:
196 |00000002 HVRT16 _foo+0x12340000
197 |00000006 LVRT16 _foo+0x12340000
199 |00000000 5da05678 ; or.u r13,r0,0x5678
200 |00000004 1c4d5678 ; ld.b r2,r13,0x5678
201 |00000008 f400c001 ; jmp r1
204 The relocation routine digs out the value from the data, adds
205 it to the addend to get the original offset, and then adds the
206 value of <<_foo>>. Note that all 32 bits have to be kept around
207 somewhere, to cope with carry from bit 15 to bit 16.
209 One further example is the sparc and the a.out format. The
210 sparc has a similar problem to the 88k, in that some
211 instructions don't have room for an entire offset, but on the
212 sparc the parts are created in odd sized lumps. The designers of
213 the a.out format chose to not use the data within the section
214 for storing part of the offset; all the offset is kept within
215 the reloc. Anything in the data should be ignored.
218 | sethi %hi(_foo+0x12345678),%g2
219 | ldsb [%g2+%lo(_foo+0x12345678)],%i0
223 Both relocs contain a pointer to <<foo>>, and the offsets
227 |RELOCATION RECORDS FOR [.text]:
229 |00000004 HI22 _foo+0x12345678
230 |00000008 LO10 _foo+0x12345678
232 |00000000 9de3bf90 ; save %sp,-112,%sp
233 |00000004 05000000 ; sethi %hi(_foo+0),%g2
234 |00000008 f048a000 ; ldsb [%g2+%lo(_foo+0)],%i0
235 |0000000c 81c7e008 ; ret
236 |00000010 81e80000 ; restore
241 The <<howto>> field can be imagined as a
242 relocation instruction. It is a pointer to a structure which
243 contains information on what to do with all of the other
244 information in the reloc record and data section. A back end
245 would normally have a relocation instruction set and turn
246 relocations into pointers to the correct structure on input -
247 but it would be possible to create each howto field on demand.
253 <<enum complain_overflow>>
255 Indicates what sort of overflow checking should be done when
256 performing a relocation.
260 .enum complain_overflow
262 . {* Do not complain on overflow. *}
263 . complain_overflow_dont,
265 . {* Complain if the bitfield overflows, whether it is considered
266 . as signed or unsigned. *}
267 . complain_overflow_bitfield,
269 . {* Complain if the value overflows when considered as signed
271 . complain_overflow_signed,
273 . {* Complain if the value overflows when considered as an
274 . unsigned number. *}
275 . complain_overflow_unsigned
284 The <<reloc_howto_type>> is a structure which contains all the
285 information that libbfd needs to know to tie up a back end's data.
288 .struct symbol_cache_entry; {* Forward declaration *}
290 .struct reloc_howto_struct
292 . {* The type field has mainly a documentary use - the back end can
293 . do what it wants with it, though normally the back end's
294 . external idea of what a reloc number is stored
295 . in this field. For example, a PC relative word relocation
296 . in a coff environment has the type 023 - because that's
297 . what the outside world calls a R_PCRWORD reloc. *}
300 . {* The value the final relocation is shifted right by. This drops
301 . unwanted data from the relocation. *}
302 . unsigned int rightshift;
304 . {* The size of the item to be relocated. This is *not* a
305 . power-of-two measure. To get the number of bytes operated
306 . on by a type of relocation, use bfd_get_reloc_size. *}
309 . {* The number of bits in the item to be relocated. This is used
310 . when doing overflow checking. *}
311 . unsigned int bitsize;
313 . {* Notes that the relocation is relative to the location in the
314 . data section of the addend. The relocation function will
315 . subtract from the relocation value the address of the location
316 . being relocated. *}
317 . boolean pc_relative;
319 . {* The bit position of the reloc value in the destination.
320 . The relocated value is left shifted by this amount. *}
321 . unsigned int bitpos;
323 . {* What type of overflow error should be checked for when
325 . enum complain_overflow complain_on_overflow;
327 . {* If this field is non null, then the supplied function is
328 . called rather than the normal function. This allows really
329 . strange relocation methods to be accomodated (e.g., i960 callj
331 . bfd_reloc_status_type (*special_function)
332 . PARAMS ((bfd *abfd,
333 . arelent *reloc_entry,
334 . struct symbol_cache_entry *symbol,
336 . asection *input_section,
338 . char **error_message));
340 . {* The textual name of the relocation type. *}
343 . {* When performing a partial link, some formats must modify the
344 . relocations rather than the data - this flag signals this.*}
345 . boolean partial_inplace;
347 . {* The src_mask selects which parts of the read in data
348 . are to be used in the relocation sum. E.g., if this was an 8 bit
349 . bit of data which we read and relocated, this would be
350 . 0x000000ff. When we have relocs which have an addend, such as
351 . sun4 extended relocs, the value in the offset part of a
352 . relocating field is garbage so we never use it. In this case
353 . the mask would be 0x00000000. *}
356 . {* The dst_mask selects which parts of the instruction are replaced
357 . into the instruction. In most cases src_mask == dst_mask,
358 . except in the above special case, where dst_mask would be
359 . 0x000000ff, and src_mask would be 0x00000000. *}
362 . {* When some formats create PC relative instructions, they leave
363 . the value of the pc of the place being relocated in the offset
364 . slot of the instruction, so that a PC relative relocation can
365 . be made just by adding in an ordinary offset (e.g., sun3 a.out).
366 . Some formats leave the displacement part of an instruction
367 . empty (e.g., m88k bcs); this flag signals the fact.*}
368 . boolean pcrel_offset;
379 The HOWTO define is horrible and will go away.
382 .#define HOWTO(C, R,S,B, P, BI, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
383 . {(unsigned)C,R,S,B, P, BI, O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
386 And will be replaced with the totally magic way. But for the
387 moment, we are compatible, so do it this way.
390 .#define NEWHOWTO( FUNCTION, NAME,SIZE,REL,IN) HOWTO(0,0,SIZE,0,REL,0,complain_overflow_dont,FUNCTION, NAME,false,0,0,IN)
393 Helper routine to turn a symbol into a relocation value.
395 .#define HOWTO_PREPARE(relocation, symbol) \
397 . if (symbol != (asymbol *)NULL) { \
398 . if (bfd_is_com_section (symbol->section)) { \
402 . relocation = symbol->value; \
414 unsigned int bfd_get_reloc_size (reloc_howto_type *);
417 For a reloc_howto_type that operates on a fixed number of bytes,
418 this returns the number of bytes operated on.
422 bfd_get_reloc_size (howto)
423 reloc_howto_type *howto;
444 How relocs are tied together in an <<asection>>:
446 .typedef struct relent_chain {
448 . struct relent_chain *next;
453 /* N_ONES produces N one bits, without overflowing machine arithmetic. */
454 #define N_ONES(n) (((((bfd_vma) 1 << ((n) - 1)) - 1) << 1) | 1)
461 bfd_reloc_status_type
463 (enum complain_overflow how,
464 unsigned int bitsize,
465 unsigned int rightshift,
466 unsigned int addrsize,
470 Perform overflow checking on @var{relocation} which has
471 @var{bitsize} significant bits and will be shifted right by
472 @var{rightshift} bits, on a machine with addresses containing
473 @var{addrsize} significant bits. The result is either of
474 @code{bfd_reloc_ok} or @code{bfd_reloc_overflow}.
478 bfd_reloc_status_type
479 bfd_check_overflow (how, bitsize, rightshift, addrsize, relocation)
480 enum complain_overflow how;
481 unsigned int bitsize;
482 unsigned int rightshift;
483 unsigned int addrsize;
486 bfd_vma fieldmask, addrmask, signmask, ss, a;
487 bfd_reloc_status_type flag = bfd_reloc_ok;
491 /* Note: BITSIZE should always be <= ADDRSIZE, but in case it's not,
492 we'll be permissive: extra bits in the field mask will
493 automatically extend the address mask for purposes of the
495 fieldmask = N_ONES (bitsize);
496 addrmask = N_ONES (addrsize) | fieldmask;
500 case complain_overflow_dont:
503 case complain_overflow_signed:
504 /* If any sign bits are set, all sign bits must be set. That
505 is, A must be a valid negative address after shifting. */
506 a = (a & addrmask) >> rightshift;
507 signmask = ~ (fieldmask >> 1);
509 if (ss != 0 && ss != ((addrmask >> rightshift) & signmask))
510 flag = bfd_reloc_overflow;
513 case complain_overflow_unsigned:
514 /* We have an overflow if the address does not fit in the field. */
515 a = (a & addrmask) >> rightshift;
516 if ((a & ~ fieldmask) != 0)
517 flag = bfd_reloc_overflow;
520 case complain_overflow_bitfield:
521 /* Bitfields are sometimes signed, sometimes unsigned. We
522 overflow if the value has some, but not all, bits set outside
523 the field, or if it has any bits set outside the field but
524 the sign bit is not set. */
526 if ((a & ~ fieldmask) != 0)
528 signmask = (fieldmask >> 1) + 1;
529 ss = (signmask << rightshift) - 1;
530 if ((ss | relocation) != ~ (bfd_vma) 0)
531 flag = bfd_reloc_overflow;
544 bfd_perform_relocation
547 bfd_reloc_status_type
548 bfd_perform_relocation
550 arelent *reloc_entry,
552 asection *input_section,
554 char **error_message);
557 If @var{output_bfd} is supplied to this function, the
558 generated image will be relocatable; the relocations are
559 copied to the output file after they have been changed to
560 reflect the new state of the world. There are two ways of
561 reflecting the results of partial linkage in an output file:
562 by modifying the output data in place, and by modifying the
563 relocation record. Some native formats (e.g., basic a.out and
564 basic coff) have no way of specifying an addend in the
565 relocation type, so the addend has to go in the output data.
566 This is no big deal since in these formats the output data
567 slot will always be big enough for the addend. Complex reloc
568 types with addends were invented to solve just this problem.
569 The @var{error_message} argument is set to an error message if
570 this return @code{bfd_reloc_dangerous}.
575 bfd_reloc_status_type
576 bfd_perform_relocation (abfd, reloc_entry, data, input_section, output_bfd,
579 arelent *reloc_entry;
581 asection *input_section;
583 char **error_message;
586 bfd_reloc_status_type flag = bfd_reloc_ok;
587 bfd_size_type addr = reloc_entry->address;
588 bfd_vma output_base = 0;
589 reloc_howto_type *howto = reloc_entry->howto;
590 asection *reloc_target_output_section;
593 symbol = *(reloc_entry->sym_ptr_ptr);
594 if (bfd_is_abs_section (symbol->section)
595 && output_bfd != (bfd *) NULL)
597 reloc_entry->address += input_section->output_offset;
601 /* If we are not producing relocateable output, return an error if
602 the symbol is not defined. An undefined weak symbol is
603 considered to have a value of zero (SVR4 ABI, p. 4-27). */
604 if (bfd_is_und_section (symbol->section)
605 && (symbol->flags & BSF_WEAK) == 0
606 && output_bfd == (bfd *) NULL)
607 flag = bfd_reloc_undefined;
609 /* If there is a function supplied to handle this relocation type,
610 call it. It'll return `bfd_reloc_continue' if further processing
612 if (howto->special_function)
614 bfd_reloc_status_type cont;
615 cont = howto->special_function (abfd, reloc_entry, symbol, data,
616 input_section, output_bfd,
618 if (cont != bfd_reloc_continue)
622 /* Is the address of the relocation really within the section? */
623 if (reloc_entry->address > input_section->_cooked_size)
624 return bfd_reloc_outofrange;
626 /* Work out which section the relocation is targetted at and the
627 initial relocation command value. */
629 /* Get symbol value. (Common symbols are special.) */
630 if (bfd_is_com_section (symbol->section))
633 relocation = symbol->value;
636 reloc_target_output_section = symbol->section->output_section;
638 /* Convert input-section-relative symbol value to absolute. */
639 if (output_bfd && howto->partial_inplace == false)
642 output_base = reloc_target_output_section->vma;
644 relocation += output_base + symbol->section->output_offset;
646 /* Add in supplied addend. */
647 relocation += reloc_entry->addend;
649 /* Here the variable relocation holds the final address of the
650 symbol we are relocating against, plus any addend. */
652 if (howto->pc_relative == true)
654 /* This is a PC relative relocation. We want to set RELOCATION
655 to the distance between the address of the symbol and the
656 location. RELOCATION is already the address of the symbol.
658 We start by subtracting the address of the section containing
661 If pcrel_offset is set, we must further subtract the position
662 of the location within the section. Some targets arrange for
663 the addend to be the negative of the position of the location
664 within the section; for example, i386-aout does this. For
665 i386-aout, pcrel_offset is false. Some other targets do not
666 include the position of the location; for example, m88kbcs,
667 or ELF. For those targets, pcrel_offset is true.
669 If we are producing relocateable output, then we must ensure
670 that this reloc will be correctly computed when the final
671 relocation is done. If pcrel_offset is false we want to wind
672 up with the negative of the location within the section,
673 which means we must adjust the existing addend by the change
674 in the location within the section. If pcrel_offset is true
675 we do not want to adjust the existing addend at all.
677 FIXME: This seems logical to me, but for the case of
678 producing relocateable output it is not what the code
679 actually does. I don't want to change it, because it seems
680 far too likely that something will break. */
683 input_section->output_section->vma + input_section->output_offset;
685 if (howto->pcrel_offset == true)
686 relocation -= reloc_entry->address;
689 if (output_bfd != (bfd *) NULL)
691 if (howto->partial_inplace == false)
693 /* This is a partial relocation, and we want to apply the relocation
694 to the reloc entry rather than the raw data. Modify the reloc
695 inplace to reflect what we now know. */
696 reloc_entry->addend = relocation;
697 reloc_entry->address += input_section->output_offset;
702 /* This is a partial relocation, but inplace, so modify the
705 If we've relocated with a symbol with a section, change
706 into a ref to the section belonging to the symbol. */
708 reloc_entry->address += input_section->output_offset;
711 if (abfd->xvec->flavour == bfd_target_coff_flavour
712 && strcmp (abfd->xvec->name, "aixcoff-rs6000") != 0
713 && strcmp (abfd->xvec->name, "xcoff-powermac") != 0
714 && strcmp (abfd->xvec->name, "coff-Intel-little") != 0
715 && strcmp (abfd->xvec->name, "coff-Intel-big") != 0)
718 /* For m68k-coff, the addend was being subtracted twice during
719 relocation with -r. Removing the line below this comment
720 fixes that problem; see PR 2953.
722 However, Ian wrote the following, regarding removing the line below,
723 which explains why it is still enabled: --djm
725 If you put a patch like that into BFD you need to check all the COFF
726 linkers. I am fairly certain that patch will break coff-i386 (e.g.,
727 SCO); see coff_i386_reloc in coff-i386.c where I worked around the
728 problem in a different way. There may very well be a reason that the
729 code works as it does.
731 Hmmm. The first obvious point is that bfd_perform_relocation should
732 not have any tests that depend upon the flavour. It's seem like
733 entirely the wrong place for such a thing. The second obvious point
734 is that the current code ignores the reloc addend when producing
735 relocateable output for COFF. That's peculiar. In fact, I really
736 have no idea what the point of the line you want to remove is.
738 A typical COFF reloc subtracts the old value of the symbol and adds in
739 the new value to the location in the object file (if it's a pc
740 relative reloc it adds the difference between the symbol value and the
741 location). When relocating we need to preserve that property.
743 BFD handles this by setting the addend to the negative of the old
744 value of the symbol. Unfortunately it handles common symbols in a
745 non-standard way (it doesn't subtract the old value) but that's a
746 different story (we can't change it without losing backward
747 compatibility with old object files) (coff-i386 does subtract the old
748 value, to be compatible with existing coff-i386 targets, like SCO).
750 So everything works fine when not producing relocateable output. When
751 we are producing relocateable output, logically we should do exactly
752 what we do when not producing relocateable output. Therefore, your
753 patch is correct. In fact, it should probably always just set
754 reloc_entry->addend to 0 for all cases, since it is, in fact, going to
755 add the value into the object file. This won't hurt the COFF code,
756 which doesn't use the addend; I'm not sure what it will do to other
757 formats (the thing to check for would be whether any formats both use
758 the addend and set partial_inplace).
760 When I wanted to make coff-i386 produce relocateable output, I ran
761 into the problem that you are running into: I wanted to remove that
762 line. Rather than risk it, I made the coff-i386 relocs use a special
763 function; it's coff_i386_reloc in coff-i386.c. The function
764 specifically adds the addend field into the object file, knowing that
765 bfd_perform_relocation is not going to. If you remove that line, then
766 coff-i386.c will wind up adding the addend field in twice. It's
767 trivial to fix; it just needs to be done.
769 The problem with removing the line is just that it may break some
770 working code. With BFD it's hard to be sure of anything. The right
771 way to deal with this is simply to build and test at least all the
772 supported COFF targets. It should be straightforward if time and disk
773 space consuming. For each target:
775 2) generate some executable, and link it using -r (I would
776 probably use paranoia.o and link against newlib/libc.a, which
777 for all the supported targets would be available in
778 /usr/cygnus/progressive/H-host/target/lib/libc.a).
779 3) make the change to reloc.c
780 4) rebuild the linker
782 6) if the resulting object files are the same, you have at least
784 7) if they are different you have to figure out which version is
787 relocation -= reloc_entry->addend;
789 reloc_entry->addend = 0;
793 reloc_entry->addend = relocation;
799 reloc_entry->addend = 0;
802 /* FIXME: This overflow checking is incomplete, because the value
803 might have overflowed before we get here. For a correct check we
804 need to compute the value in a size larger than bitsize, but we
805 can't reasonably do that for a reloc the same size as a host
807 FIXME: We should also do overflow checking on the result after
808 adding in the value contained in the object file. */
809 if (howto->complain_on_overflow != complain_overflow_dont
810 && flag == bfd_reloc_ok)
811 flag = bfd_check_overflow (howto->complain_on_overflow,
814 bfd_arch_bits_per_address (abfd),
818 Either we are relocating all the way, or we don't want to apply
819 the relocation to the reloc entry (probably because there isn't
820 any room in the output format to describe addends to relocs)
823 /* The cast to bfd_vma avoids a bug in the Alpha OSF/1 C compiler
824 (OSF version 1.3, compiler version 3.11). It miscompiles the
838 x <<= (unsigned long) s.i0;
842 printf ("succeeded (%lx)\n", x);
846 relocation >>= (bfd_vma) howto->rightshift;
848 /* Shift everything up to where it's going to be used */
850 relocation <<= (bfd_vma) howto->bitpos;
852 /* Wait for the day when all have the mask in them */
855 i instruction to be left alone
856 o offset within instruction
857 r relocation offset to apply
866 i i i i i o o o o o from bfd_get<size>
867 and S S S S S to get the size offset we want
868 + r r r r r r r r r r to get the final value to place
869 and D D D D D to chop to right size
870 -----------------------
873 ... i i i i i o o o o o from bfd_get<size>
874 and N N N N N get instruction
875 -----------------------
881 -----------------------
882 R R R R R R R R R R put into bfd_put<size>
886 x = ( (x & ~howto->dst_mask) | (((x & howto->src_mask) + relocation) & howto->dst_mask))
892 char x = bfd_get_8 (abfd, (char *) data + addr);
894 bfd_put_8 (abfd, x, (unsigned char *) data + addr);
900 short x = bfd_get_16 (abfd, (bfd_byte *) data + addr);
902 bfd_put_16 (abfd, x, (unsigned char *) data + addr);
907 long x = bfd_get_32 (abfd, (bfd_byte *) data + addr);
909 bfd_put_32 (abfd, x, (bfd_byte *) data + addr);
914 long x = bfd_get_32 (abfd, (bfd_byte *) data + addr);
915 relocation = -relocation;
917 bfd_put_32 (abfd, x, (bfd_byte *) data + addr);
923 long x = bfd_get_16 (abfd, (bfd_byte *) data + addr);
924 relocation = -relocation;
926 bfd_put_16 (abfd, x, (bfd_byte *) data + addr);
937 bfd_vma x = bfd_get_64 (abfd, (bfd_byte *) data + addr);
939 bfd_put_64 (abfd, x, (bfd_byte *) data + addr);
946 return bfd_reloc_other;
954 bfd_install_relocation
957 bfd_reloc_status_type
958 bfd_install_relocation
960 arelent *reloc_entry,
961 PTR data, bfd_vma data_start,
962 asection *input_section,
963 char **error_message);
966 This looks remarkably like <<bfd_perform_relocation>>, except it
967 does not expect that the section contents have been filled in.
968 I.e., it's suitable for use when creating, rather than applying
971 For now, this function should be considered reserved for the
977 bfd_reloc_status_type
978 bfd_install_relocation (abfd, reloc_entry, data_start, data_start_offset,
979 input_section, error_message)
981 arelent *reloc_entry;
983 bfd_vma data_start_offset;
984 asection *input_section;
985 char **error_message;
988 bfd_reloc_status_type flag = bfd_reloc_ok;
989 bfd_size_type addr = reloc_entry->address;
990 bfd_vma output_base = 0;
991 reloc_howto_type *howto = reloc_entry->howto;
992 asection *reloc_target_output_section;
996 symbol = *(reloc_entry->sym_ptr_ptr);
997 if (bfd_is_abs_section (symbol->section))
999 reloc_entry->address += input_section->output_offset;
1000 return bfd_reloc_ok;
1003 /* If there is a function supplied to handle this relocation type,
1004 call it. It'll return `bfd_reloc_continue' if further processing
1006 if (howto->special_function)
1008 bfd_reloc_status_type cont;
1010 /* XXX - The special_function calls haven't been fixed up to deal
1011 with creating new relocations and section contents. */
1012 cont = howto->special_function (abfd, reloc_entry, symbol,
1013 /* XXX - Non-portable! */
1014 ((bfd_byte *) data_start
1015 - data_start_offset),
1016 input_section, abfd, error_message);
1017 if (cont != bfd_reloc_continue)
1021 /* Is the address of the relocation really within the section? */
1022 if (reloc_entry->address > input_section->_cooked_size)
1023 return bfd_reloc_outofrange;
1025 /* Work out which section the relocation is targetted at and the
1026 initial relocation command value. */
1028 /* Get symbol value. (Common symbols are special.) */
1029 if (bfd_is_com_section (symbol->section))
1032 relocation = symbol->value;
1034 reloc_target_output_section = symbol->section->output_section;
1036 /* Convert input-section-relative symbol value to absolute. */
1037 if (howto->partial_inplace == false)
1040 output_base = reloc_target_output_section->vma;
1042 relocation += output_base + symbol->section->output_offset;
1044 /* Add in supplied addend. */
1045 relocation += reloc_entry->addend;
1047 /* Here the variable relocation holds the final address of the
1048 symbol we are relocating against, plus any addend. */
1050 if (howto->pc_relative == true)
1052 /* This is a PC relative relocation. We want to set RELOCATION
1053 to the distance between the address of the symbol and the
1054 location. RELOCATION is already the address of the symbol.
1056 We start by subtracting the address of the section containing
1059 If pcrel_offset is set, we must further subtract the position
1060 of the location within the section. Some targets arrange for
1061 the addend to be the negative of the position of the location
1062 within the section; for example, i386-aout does this. For
1063 i386-aout, pcrel_offset is false. Some other targets do not
1064 include the position of the location; for example, m88kbcs,
1065 or ELF. For those targets, pcrel_offset is true.
1067 If we are producing relocateable output, then we must ensure
1068 that this reloc will be correctly computed when the final
1069 relocation is done. If pcrel_offset is false we want to wind
1070 up with the negative of the location within the section,
1071 which means we must adjust the existing addend by the change
1072 in the location within the section. If pcrel_offset is true
1073 we do not want to adjust the existing addend at all.
1075 FIXME: This seems logical to me, but for the case of
1076 producing relocateable output it is not what the code
1077 actually does. I don't want to change it, because it seems
1078 far too likely that something will break. */
1081 input_section->output_section->vma + input_section->output_offset;
1083 if (howto->pcrel_offset == true && howto->partial_inplace == true)
1084 relocation -= reloc_entry->address;
1087 if (howto->partial_inplace == false)
1089 /* This is a partial relocation, and we want to apply the relocation
1090 to the reloc entry rather than the raw data. Modify the reloc
1091 inplace to reflect what we now know. */
1092 reloc_entry->addend = relocation;
1093 reloc_entry->address += input_section->output_offset;
1098 /* This is a partial relocation, but inplace, so modify the
1101 If we've relocated with a symbol with a section, change
1102 into a ref to the section belonging to the symbol. */
1104 reloc_entry->address += input_section->output_offset;
1107 if (abfd->xvec->flavour == bfd_target_coff_flavour
1108 && strcmp (abfd->xvec->name, "aixcoff-rs6000") != 0
1109 && strcmp (abfd->xvec->name, "xcoff-powermac") != 0
1110 && strcmp (abfd->xvec->name, "coff-Intel-little") != 0
1111 && strcmp (abfd->xvec->name, "coff-Intel-big") != 0)
1114 /* For m68k-coff, the addend was being subtracted twice during
1115 relocation with -r. Removing the line below this comment
1116 fixes that problem; see PR 2953.
1118 However, Ian wrote the following, regarding removing the line below,
1119 which explains why it is still enabled: --djm
1121 If you put a patch like that into BFD you need to check all the COFF
1122 linkers. I am fairly certain that patch will break coff-i386 (e.g.,
1123 SCO); see coff_i386_reloc in coff-i386.c where I worked around the
1124 problem in a different way. There may very well be a reason that the
1125 code works as it does.
1127 Hmmm. The first obvious point is that bfd_install_relocation should
1128 not have any tests that depend upon the flavour. It's seem like
1129 entirely the wrong place for such a thing. The second obvious point
1130 is that the current code ignores the reloc addend when producing
1131 relocateable output for COFF. That's peculiar. In fact, I really
1132 have no idea what the point of the line you want to remove is.
1134 A typical COFF reloc subtracts the old value of the symbol and adds in
1135 the new value to the location in the object file (if it's a pc
1136 relative reloc it adds the difference between the symbol value and the
1137 location). When relocating we need to preserve that property.
1139 BFD handles this by setting the addend to the negative of the old
1140 value of the symbol. Unfortunately it handles common symbols in a
1141 non-standard way (it doesn't subtract the old value) but that's a
1142 different story (we can't change it without losing backward
1143 compatibility with old object files) (coff-i386 does subtract the old
1144 value, to be compatible with existing coff-i386 targets, like SCO).
1146 So everything works fine when not producing relocateable output. When
1147 we are producing relocateable output, logically we should do exactly
1148 what we do when not producing relocateable output. Therefore, your
1149 patch is correct. In fact, it should probably always just set
1150 reloc_entry->addend to 0 for all cases, since it is, in fact, going to
1151 add the value into the object file. This won't hurt the COFF code,
1152 which doesn't use the addend; I'm not sure what it will do to other
1153 formats (the thing to check for would be whether any formats both use
1154 the addend and set partial_inplace).
1156 When I wanted to make coff-i386 produce relocateable output, I ran
1157 into the problem that you are running into: I wanted to remove that
1158 line. Rather than risk it, I made the coff-i386 relocs use a special
1159 function; it's coff_i386_reloc in coff-i386.c. The function
1160 specifically adds the addend field into the object file, knowing that
1161 bfd_install_relocation is not going to. If you remove that line, then
1162 coff-i386.c will wind up adding the addend field in twice. It's
1163 trivial to fix; it just needs to be done.
1165 The problem with removing the line is just that it may break some
1166 working code. With BFD it's hard to be sure of anything. The right
1167 way to deal with this is simply to build and test at least all the
1168 supported COFF targets. It should be straightforward if time and disk
1169 space consuming. For each target:
1171 2) generate some executable, and link it using -r (I would
1172 probably use paranoia.o and link against newlib/libc.a, which
1173 for all the supported targets would be available in
1174 /usr/cygnus/progressive/H-host/target/lib/libc.a).
1175 3) make the change to reloc.c
1176 4) rebuild the linker
1178 6) if the resulting object files are the same, you have at least
1180 7) if they are different you have to figure out which version is
1183 relocation -= reloc_entry->addend;
1185 reloc_entry->addend = 0;
1189 reloc_entry->addend = relocation;
1193 /* FIXME: This overflow checking is incomplete, because the value
1194 might have overflowed before we get here. For a correct check we
1195 need to compute the value in a size larger than bitsize, but we
1196 can't reasonably do that for a reloc the same size as a host
1198 FIXME: We should also do overflow checking on the result after
1199 adding in the value contained in the object file. */
1200 if (howto->complain_on_overflow != complain_overflow_dont)
1201 flag = bfd_check_overflow (howto->complain_on_overflow,
1204 bfd_arch_bits_per_address (abfd),
1208 Either we are relocating all the way, or we don't want to apply
1209 the relocation to the reloc entry (probably because there isn't
1210 any room in the output format to describe addends to relocs)
1213 /* The cast to bfd_vma avoids a bug in the Alpha OSF/1 C compiler
1214 (OSF version 1.3, compiler version 3.11). It miscompiles the
1228 x <<= (unsigned long) s.i0;
1230 printf ("failed\n");
1232 printf ("succeeded (%lx)\n", x);
1236 relocation >>= (bfd_vma) howto->rightshift;
1238 /* Shift everything up to where it's going to be used */
1240 relocation <<= (bfd_vma) howto->bitpos;
1242 /* Wait for the day when all have the mask in them */
1245 i instruction to be left alone
1246 o offset within instruction
1247 r relocation offset to apply
1256 i i i i i o o o o o from bfd_get<size>
1257 and S S S S S to get the size offset we want
1258 + r r r r r r r r r r to get the final value to place
1259 and D D D D D to chop to right size
1260 -----------------------
1263 ... i i i i i o o o o o from bfd_get<size>
1264 and N N N N N get instruction
1265 -----------------------
1271 -----------------------
1272 R R R R R R R R R R put into bfd_put<size>
1276 x = ( (x & ~howto->dst_mask) | (((x & howto->src_mask) + relocation) & howto->dst_mask))
1278 data = (bfd_byte *) data_start + (addr - data_start_offset);
1280 switch (howto->size)
1284 char x = bfd_get_8 (abfd, (char *) data);
1286 bfd_put_8 (abfd, x, (unsigned char *) data);
1292 short x = bfd_get_16 (abfd, (bfd_byte *) data);
1294 bfd_put_16 (abfd, x, (unsigned char *) data);
1299 long x = bfd_get_32 (abfd, (bfd_byte *) data);
1301 bfd_put_32 (abfd, x, (bfd_byte *) data);
1306 long x = bfd_get_32 (abfd, (bfd_byte *) data);
1307 relocation = -relocation;
1309 bfd_put_32 (abfd, x, (bfd_byte *) data);
1319 bfd_vma x = bfd_get_64 (abfd, (bfd_byte *) data);
1321 bfd_put_64 (abfd, x, (bfd_byte *) data);
1325 return bfd_reloc_other;
1331 /* This relocation routine is used by some of the backend linkers.
1332 They do not construct asymbol or arelent structures, so there is no
1333 reason for them to use bfd_perform_relocation. Also,
1334 bfd_perform_relocation is so hacked up it is easier to write a new
1335 function than to try to deal with it.
1337 This routine does a final relocation. Whether it is useful for a
1338 relocateable link depends upon how the object format defines
1341 FIXME: This routine ignores any special_function in the HOWTO,
1342 since the existing special_function values have been written for
1343 bfd_perform_relocation.
1345 HOWTO is the reloc howto information.
1346 INPUT_BFD is the BFD which the reloc applies to.
1347 INPUT_SECTION is the section which the reloc applies to.
1348 CONTENTS is the contents of the section.
1349 ADDRESS is the address of the reloc within INPUT_SECTION.
1350 VALUE is the value of the symbol the reloc refers to.
1351 ADDEND is the addend of the reloc. */
1353 bfd_reloc_status_type
1354 _bfd_final_link_relocate (howto, input_bfd, input_section, contents, address,
1356 reloc_howto_type *howto;
1358 asection *input_section;
1366 /* Sanity check the address. */
1367 if (address > input_section->_raw_size)
1368 return bfd_reloc_outofrange;
1370 /* This function assumes that we are dealing with a basic relocation
1371 against a symbol. We want to compute the value of the symbol to
1372 relocate to. This is just VALUE, the value of the symbol, plus
1373 ADDEND, any addend associated with the reloc. */
1374 relocation = value + addend;
1376 /* If the relocation is PC relative, we want to set RELOCATION to
1377 the distance between the symbol (currently in RELOCATION) and the
1378 location we are relocating. Some targets (e.g., i386-aout)
1379 arrange for the contents of the section to be the negative of the
1380 offset of the location within the section; for such targets
1381 pcrel_offset is false. Other targets (e.g., m88kbcs or ELF)
1382 simply leave the contents of the section as zero; for such
1383 targets pcrel_offset is true. If pcrel_offset is false we do not
1384 need to subtract out the offset of the location within the
1385 section (which is just ADDRESS). */
1386 if (howto->pc_relative)
1388 relocation -= (input_section->output_section->vma
1389 + input_section->output_offset);
1390 if (howto->pcrel_offset)
1391 relocation -= address;
1394 return _bfd_relocate_contents (howto, input_bfd, relocation,
1395 contents + address);
1398 /* Relocate a given location using a given value and howto. */
1400 bfd_reloc_status_type
1401 _bfd_relocate_contents (howto, input_bfd, relocation, location)
1402 reloc_howto_type *howto;
1410 unsigned int rightshift = howto->rightshift;
1411 unsigned int bitpos = howto->bitpos;
1413 /* If the size is negative, negate RELOCATION. This isn't very
1415 if (howto->size < 0)
1416 relocation = -relocation;
1418 /* Get the value we are going to relocate. */
1419 size = bfd_get_reloc_size (howto);
1426 x = bfd_get_8 (input_bfd, location);
1429 x = bfd_get_16 (input_bfd, location);
1432 x = bfd_get_32 (input_bfd, location);
1436 x = bfd_get_64 (input_bfd, location);
1443 /* Check for overflow. FIXME: We may drop bits during the addition
1444 which we don't check for. We must either check at every single
1445 operation, which would be tedious, or we must do the computations
1446 in a type larger than bfd_vma, which would be inefficient. */
1448 if (howto->complain_on_overflow != complain_overflow_dont)
1450 bfd_vma addrmask, fieldmask, signmask, ss;
1453 /* Get the values to be added together. For signed and unsigned
1454 relocations, we assume that all values should be truncated to
1455 the size of an address. For bitfields, all the bits matter.
1456 See also bfd_check_overflow. */
1457 fieldmask = N_ONES (howto->bitsize);
1458 addrmask = N_ONES (bfd_arch_bits_per_address (input_bfd)) | fieldmask;
1460 b = x & howto->src_mask;
1462 switch (howto->complain_on_overflow)
1464 case complain_overflow_signed:
1465 a = (a & addrmask) >> rightshift;
1467 /* If any sign bits are set, all sign bits must be set.
1468 That is, A must be a valid negative address after
1470 signmask = ~ (fieldmask >> 1);
1472 if (ss != 0 && ss != ((addrmask >> rightshift) & signmask))
1475 /* We only need this next bit of code if the sign bit of B
1476 is below the sign bit of A. This would only happen if
1477 SRC_MASK had fewer bits than BITSIZE. Note that if
1478 SRC_MASK has more bits than BITSIZE, we can get into
1479 trouble; we would need to verify that B is in range, as
1480 we do for A above. */
1481 signmask = ((~ howto->src_mask) >> 1) & howto->src_mask;
1482 if ((b & signmask) != 0)
1484 /* Set all the bits above the sign bit. */
1485 b -= signmask <<= 1;
1488 b = (b & addrmask) >> bitpos;
1490 /* Now we can do the addition. */
1493 /* See if the result has the correct sign. Bits above the
1494 sign bit are junk now; ignore them. If the sum is
1495 positive, make sure we did not have all negative inputs;
1496 if the sum is negative, make sure we did not have all
1497 positive inputs. The test below looks only at the sign
1498 bits, and it really just
1499 SIGN (A) == SIGN (B) && SIGN (A) != SIGN (SUM)
1501 signmask = (fieldmask >> 1) + 1;
1502 if (((~ (a ^ b)) & (a ^ sum)) & signmask)
1507 case complain_overflow_unsigned:
1508 /* Checking for an unsigned overflow is relatively easy:
1509 trim the addresses and add, and trim the result as well.
1510 Overflow is normally indicated when the result does not
1511 fit in the field. However, we also need to consider the
1512 case when, e.g., fieldmask is 0x7fffffff or smaller, an
1513 input is 0x80000000, and bfd_vma is only 32 bits; then we
1514 will get sum == 0, but there is an overflow, since the
1515 inputs did not fit in the field. Instead of doing a
1516 separate test, we can check for this by or-ing in the
1517 operands when testing for the sum overflowing its final
1519 a = (a & addrmask) >> rightshift;
1520 b = (b & addrmask) >> bitpos;
1521 sum = (a + b) & addrmask;
1522 if ((a | b | sum) & ~ fieldmask)
1527 case complain_overflow_bitfield:
1528 /* Much like unsigned, except no trimming with addrmask. In
1529 addition, the sum overflows if there is a carry out of
1530 the bfd_vma, i.e., the sum is less than either input
1535 /* Bitfields are sometimes used for signed numbers; for
1536 example, a 13-bit field sometimes represents values in
1537 0..8191 and sometimes represents values in -4096..4095.
1538 If the field is signed and a is -4095 (0x1001) and b is
1539 -1 (0x1fff), the sum is -4096 (0x1000), but (0x1001 +
1540 0x1fff is 0x3000). It's not clear how to handle this
1541 everywhere, since there is not way to know how many bits
1542 are significant in the relocation, but the original code
1543 assumed that it was fully sign extended, and we will keep
1545 signmask = (fieldmask >> 1) + 1;
1547 if ((a & ~ fieldmask) != 0)
1549 /* Some bits out of the field are set. This might not
1550 be a problem: if this is a signed bitfield, it is OK
1551 iff all the high bits are set, including the sign
1552 bit. We'll try setting all but the most significant
1553 bit in the original relocation value: if this is all
1554 ones, we are OK, assuming a signed bitfield. */
1555 ss = (signmask << rightshift) - 1;
1556 if ((ss | relocation) != ~ (bfd_vma) 0)
1561 /* We just assume (b & ~ fieldmask) == 0. */
1564 if (sum < a || (sum & ~ fieldmask) != 0)
1566 /* There was a carry out, or the field overflow. Test
1567 for signed operands again. Here is the overflow test
1568 is as for complain_overflow_signed. */
1569 if (((~ (a ^ b)) & (a ^ sum)) & signmask)
1580 /* Put RELOCATION in the right bits. */
1581 relocation >>= (bfd_vma) rightshift;
1582 relocation <<= (bfd_vma) bitpos;
1584 /* Add RELOCATION to the right bits of X. */
1585 x = ((x & ~howto->dst_mask)
1586 | (((x & howto->src_mask) + relocation) & howto->dst_mask));
1588 /* Put the relocated value back in the object file. */
1595 bfd_put_8 (input_bfd, x, location);
1598 bfd_put_16 (input_bfd, x, location);
1601 bfd_put_32 (input_bfd, x, location);
1605 bfd_put_64 (input_bfd, x, location);
1612 return overflow ? bfd_reloc_overflow : bfd_reloc_ok;
1618 howto manager, , typedef arelent, Relocations
1623 When an application wants to create a relocation, but doesn't
1624 know what the target machine might call it, it can find out by
1625 using this bit of code.
1634 The insides of a reloc code. The idea is that, eventually, there
1635 will be one enumerator for every type of relocation we ever do.
1636 Pass one of these values to <<bfd_reloc_type_lookup>>, and it'll
1637 return a howto pointer.
1639 This does mean that the application must determine the correct
1640 enumerator value; you can't get a howto pointer from a random set
1661 Basic absolute relocations of N bits.
1676 PC-relative relocations. Sometimes these are relative to the address
1677 of the relocation itself; sometimes they are relative to the start of
1678 the section containing the relocation. It depends on the specific target.
1680 The 24-bit relocation is used in some Intel 960 configurations.
1683 BFD_RELOC_32_GOT_PCREL
1685 BFD_RELOC_16_GOT_PCREL
1687 BFD_RELOC_8_GOT_PCREL
1693 BFD_RELOC_LO16_GOTOFF
1695 BFD_RELOC_HI16_GOTOFF
1697 BFD_RELOC_HI16_S_GOTOFF
1701 BFD_RELOC_32_PLT_PCREL
1703 BFD_RELOC_24_PLT_PCREL
1705 BFD_RELOC_16_PLT_PCREL
1707 BFD_RELOC_8_PLT_PCREL
1713 BFD_RELOC_LO16_PLTOFF
1715 BFD_RELOC_HI16_PLTOFF
1717 BFD_RELOC_HI16_S_PLTOFF
1724 BFD_RELOC_68K_GLOB_DAT
1726 BFD_RELOC_68K_JMP_SLOT
1728 BFD_RELOC_68K_RELATIVE
1730 Relocations used by 68K ELF.
1733 BFD_RELOC_32_BASEREL
1735 BFD_RELOC_16_BASEREL
1737 BFD_RELOC_LO16_BASEREL
1739 BFD_RELOC_HI16_BASEREL
1741 BFD_RELOC_HI16_S_BASEREL
1747 Linkage-table relative.
1752 Absolute 8-bit relocation, but used to form an address like 0xFFnn.
1755 BFD_RELOC_32_PCREL_S2
1757 BFD_RELOC_16_PCREL_S2
1759 BFD_RELOC_23_PCREL_S2
1761 These PC-relative relocations are stored as word displacements --
1762 i.e., byte displacements shifted right two bits. The 30-bit word
1763 displacement (<<32_PCREL_S2>> -- 32 bits, shifted 2) is used on the
1764 SPARC. (SPARC tools generally refer to this as <<WDISP30>>.) The
1765 signed 16-bit displacement is used on the MIPS, and the 23-bit
1766 displacement is used on the Alpha.
1773 High 22 bits and low 10 bits of 32-bit value, placed into lower bits of
1774 the target word. These are used on the SPARC.
1781 For systems that allocate a Global Pointer register, these are
1782 displacements off that register. These relocation types are
1783 handled specially, because the value the register will have is
1784 decided relatively late.
1788 BFD_RELOC_I960_CALLJ
1790 Reloc types used for i960/b.out.
1795 BFD_RELOC_SPARC_WDISP22
1801 BFD_RELOC_SPARC_GOT10
1803 BFD_RELOC_SPARC_GOT13
1805 BFD_RELOC_SPARC_GOT22
1807 BFD_RELOC_SPARC_PC10
1809 BFD_RELOC_SPARC_PC22
1811 BFD_RELOC_SPARC_WPLT30
1813 BFD_RELOC_SPARC_COPY
1815 BFD_RELOC_SPARC_GLOB_DAT
1817 BFD_RELOC_SPARC_JMP_SLOT
1819 BFD_RELOC_SPARC_RELATIVE
1821 BFD_RELOC_SPARC_UA32
1823 SPARC ELF relocations. There is probably some overlap with other
1824 relocation types already defined.
1827 BFD_RELOC_SPARC_BASE13
1829 BFD_RELOC_SPARC_BASE22
1831 I think these are specific to SPARC a.out (e.g., Sun 4).
1841 BFD_RELOC_SPARC_OLO10
1843 BFD_RELOC_SPARC_HH22
1845 BFD_RELOC_SPARC_HM10
1847 BFD_RELOC_SPARC_LM22
1849 BFD_RELOC_SPARC_PC_HH22
1851 BFD_RELOC_SPARC_PC_HM10
1853 BFD_RELOC_SPARC_PC_LM22
1855 BFD_RELOC_SPARC_WDISP16
1857 BFD_RELOC_SPARC_WDISP19
1865 BFD_RELOC_SPARC_DISP64
1868 BFD_RELOC_SPARC_PLT64
1870 BFD_RELOC_SPARC_HIX22
1872 BFD_RELOC_SPARC_LOX10
1880 BFD_RELOC_SPARC_REGISTER
1885 BFD_RELOC_SPARC_REV32
1887 SPARC little endian relocation
1890 BFD_RELOC_ALPHA_GPDISP_HI16
1892 Alpha ECOFF and ELF relocations. Some of these treat the symbol or
1893 "addend" in some special way.
1894 For GPDISP_HI16 ("gpdisp") relocations, the symbol is ignored when
1895 writing; when reading, it will be the absolute section symbol. The
1896 addend is the displacement in bytes of the "lda" instruction from
1897 the "ldah" instruction (which is at the address of this reloc).
1899 BFD_RELOC_ALPHA_GPDISP_LO16
1901 For GPDISP_LO16 ("ignore") relocations, the symbol is handled as
1902 with GPDISP_HI16 relocs. The addend is ignored when writing the
1903 relocations out, and is filled in with the file's GP value on
1904 reading, for convenience.
1907 BFD_RELOC_ALPHA_GPDISP
1909 The ELF GPDISP relocation is exactly the same as the GPDISP_HI16
1910 relocation except that there is no accompanying GPDISP_LO16
1914 BFD_RELOC_ALPHA_LITERAL
1916 BFD_RELOC_ALPHA_ELF_LITERAL
1918 BFD_RELOC_ALPHA_LITUSE
1920 The Alpha LITERAL/LITUSE relocs are produced by a symbol reference;
1921 the assembler turns it into a LDQ instruction to load the address of
1922 the symbol, and then fills in a register in the real instruction.
1924 The LITERAL reloc, at the LDQ instruction, refers to the .lita
1925 section symbol. The addend is ignored when writing, but is filled
1926 in with the file's GP value on reading, for convenience, as with the
1929 The ELF_LITERAL reloc is somewhere between 16_GOTOFF and GPDISP_LO16.
1930 It should refer to the symbol to be referenced, as with 16_GOTOFF,
1931 but it generates output not based on the position within the .got
1932 section, but relative to the GP value chosen for the file during the
1935 The LITUSE reloc, on the instruction using the loaded address, gives
1936 information to the linker that it might be able to use to optimize
1937 away some literal section references. The symbol is ignored (read
1938 as the absolute section symbol), and the "addend" indicates the type
1939 of instruction using the register:
1940 1 - "memory" fmt insn
1941 2 - byte-manipulation (byte offset reg)
1942 3 - jsr (target of branch)
1944 The GNU linker currently doesn't do any of this optimizing.
1947 BFD_RELOC_ALPHA_HINT
1949 The HINT relocation indicates a value that should be filled into the
1950 "hint" field of a jmp/jsr/ret instruction, for possible branch-
1951 prediction logic which may be provided on some processors.
1954 BFD_RELOC_ALPHA_LINKAGE
1956 The LINKAGE relocation outputs a linkage pair in the object file,
1957 which is filled by the linker.
1960 BFD_RELOC_ALPHA_CODEADDR
1962 The CODEADDR relocation outputs a STO_CA in the object file,
1963 which is filled by the linker.
1968 Bits 27..2 of the relocation address shifted right 2 bits;
1969 simple reloc otherwise.
1972 BFD_RELOC_MIPS16_JMP
1974 The MIPS16 jump instruction.
1977 BFD_RELOC_MIPS16_GPREL
1979 MIPS16 GP relative reloc.
1984 High 16 bits of 32-bit value; simple reloc.
1988 High 16 bits of 32-bit value but the low 16 bits will be sign
1989 extended and added to form the final result. If the low 16
1990 bits form a negative number, we need to add one to the high value
1991 to compensate for the borrow when the low bits are added.
1997 BFD_RELOC_PCREL_HI16_S
1999 Like BFD_RELOC_HI16_S, but PC relative.
2001 BFD_RELOC_PCREL_LO16
2003 Like BFD_RELOC_LO16, but PC relative.
2006 BFD_RELOC_MIPS_GPREL
2009 Relocation relative to the global pointer.
2012 BFD_RELOC_MIPS_LITERAL
2014 Relocation against a MIPS literal section.
2017 BFD_RELOC_MIPS_GOT16
2019 BFD_RELOC_MIPS_CALL16
2021 BFD_RELOC_MIPS_GPREL32
2024 BFD_RELOC_MIPS_GOT_HI16
2026 BFD_RELOC_MIPS_GOT_LO16
2028 BFD_RELOC_MIPS_CALL_HI16
2030 BFD_RELOC_MIPS_CALL_LO16
2033 MIPS ELF relocations.
2044 BFD_RELOC_386_GLOB_DAT
2046 BFD_RELOC_386_JUMP_SLOT
2048 BFD_RELOC_386_RELATIVE
2050 BFD_RELOC_386_GOTOFF
2054 i386/elf relocations
2057 BFD_RELOC_NS32K_IMM_8
2059 BFD_RELOC_NS32K_IMM_16
2061 BFD_RELOC_NS32K_IMM_32
2063 BFD_RELOC_NS32K_IMM_8_PCREL
2065 BFD_RELOC_NS32K_IMM_16_PCREL
2067 BFD_RELOC_NS32K_IMM_32_PCREL
2069 BFD_RELOC_NS32K_DISP_8
2071 BFD_RELOC_NS32K_DISP_16
2073 BFD_RELOC_NS32K_DISP_32
2075 BFD_RELOC_NS32K_DISP_8_PCREL
2077 BFD_RELOC_NS32K_DISP_16_PCREL
2079 BFD_RELOC_NS32K_DISP_32_PCREL
2092 BFD_RELOC_PPC_B16_BRTAKEN
2094 BFD_RELOC_PPC_B16_BRNTAKEN
2098 BFD_RELOC_PPC_BA16_BRTAKEN
2100 BFD_RELOC_PPC_BA16_BRNTAKEN
2104 BFD_RELOC_PPC_GLOB_DAT
2106 BFD_RELOC_PPC_JMP_SLOT
2108 BFD_RELOC_PPC_RELATIVE
2110 BFD_RELOC_PPC_LOCAL24PC
2112 BFD_RELOC_PPC_EMB_NADDR32
2114 BFD_RELOC_PPC_EMB_NADDR16
2116 BFD_RELOC_PPC_EMB_NADDR16_LO
2118 BFD_RELOC_PPC_EMB_NADDR16_HI
2120 BFD_RELOC_PPC_EMB_NADDR16_HA
2122 BFD_RELOC_PPC_EMB_SDAI16
2124 BFD_RELOC_PPC_EMB_SDA2I16
2126 BFD_RELOC_PPC_EMB_SDA2REL
2128 BFD_RELOC_PPC_EMB_SDA21
2130 BFD_RELOC_PPC_EMB_MRKREF
2132 BFD_RELOC_PPC_EMB_RELSEC16
2134 BFD_RELOC_PPC_EMB_RELST_LO
2136 BFD_RELOC_PPC_EMB_RELST_HI
2138 BFD_RELOC_PPC_EMB_RELST_HA
2140 BFD_RELOC_PPC_EMB_BIT_FLD
2142 BFD_RELOC_PPC_EMB_RELSDA
2144 Power(rs6000) and PowerPC relocations.
2149 The type of reloc used to build a contructor table - at the moment
2150 probably a 32 bit wide absolute relocation, but the target can choose.
2151 It generally does map to one of the other relocation types.
2154 BFD_RELOC_ARM_PCREL_BRANCH
2156 ARM 26 bit pc-relative branch. The lowest two bits must be zero and are
2157 not stored in the instruction.
2159 BFD_RELOC_ARM_IMMEDIATE
2161 BFD_RELOC_ARM_OFFSET_IMM
2163 BFD_RELOC_ARM_SHIFT_IMM
2169 BFD_RELOC_ARM_CP_OFF_IMM
2171 BFD_RELOC_ARM_ADR_IMM
2173 BFD_RELOC_ARM_LDR_IMM
2175 BFD_RELOC_ARM_LITERAL
2177 BFD_RELOC_ARM_IN_POOL
2179 BFD_RELOC_ARM_OFFSET_IMM8
2181 BFD_RELOC_ARM_HWLITERAL
2183 BFD_RELOC_ARM_THUMB_ADD
2185 BFD_RELOC_ARM_THUMB_IMM
2187 BFD_RELOC_ARM_THUMB_SHIFT
2189 BFD_RELOC_ARM_THUMB_OFFSET
2195 BFD_RELOC_ARM_JUMP_SLOT
2199 BFD_RELOC_ARM_GLOB_DAT
2203 BFD_RELOC_ARM_RELATIVE
2205 BFD_RELOC_ARM_GOTOFF
2209 These relocs are only used within the ARM assembler. They are not
2210 (at present) written to any object files.
2213 BFD_RELOC_SH_PCDISP8BY2
2215 BFD_RELOC_SH_PCDISP12BY2
2219 BFD_RELOC_SH_IMM4BY2
2221 BFD_RELOC_SH_IMM4BY4
2225 BFD_RELOC_SH_IMM8BY2
2227 BFD_RELOC_SH_IMM8BY4
2229 BFD_RELOC_SH_PCRELIMM8BY2
2231 BFD_RELOC_SH_PCRELIMM8BY4
2233 BFD_RELOC_SH_SWITCH16
2235 BFD_RELOC_SH_SWITCH32
2249 Hitachi SH relocs. Not all of these appear in object files.
2252 BFD_RELOC_THUMB_PCREL_BRANCH9
2254 BFD_RELOC_THUMB_PCREL_BRANCH12
2256 BFD_RELOC_THUMB_PCREL_BRANCH23
2258 Thumb 23-, 12- and 9-bit pc-relative branches. The lowest bit must
2259 be zero and is not stored in the instruction.
2262 BFD_RELOC_ARC_B22_PCREL
2264 Argonaut RISC Core (ARC) relocs.
2265 ARC 22 bit pc-relative branch. The lowest two bits must be zero and are
2266 not stored in the instruction. The high 20 bits are installed in bits 26
2267 through 7 of the instruction.
2271 ARC 26 bit absolute branch. The lowest two bits must be zero and are not
2272 stored in the instruction. The high 24 bits are installed in bits 23
2276 BFD_RELOC_D10V_10_PCREL_R
2278 Mitsubishi D10V relocs.
2279 This is a 10-bit reloc with the right 2 bits
2282 BFD_RELOC_D10V_10_PCREL_L
2284 Mitsubishi D10V relocs.
2285 This is a 10-bit reloc with the right 2 bits
2286 assumed to be 0. This is the same as the previous reloc
2287 except it is in the left container, i.e.,
2288 shifted left 15 bits.
2292 This is an 18-bit reloc with the right 2 bits
2295 BFD_RELOC_D10V_18_PCREL
2297 This is an 18-bit reloc with the right 2 bits
2303 Mitsubishi D30V relocs.
2304 This is a 6-bit absolute reloc.
2306 BFD_RELOC_D30V_9_PCREL
2308 This is a 6-bit pc-relative reloc with
2309 the right 3 bits assumed to be 0.
2311 BFD_RELOC_D30V_9_PCREL_R
2313 This is a 6-bit pc-relative reloc with
2314 the right 3 bits assumed to be 0. Same
2315 as the previous reloc but on the right side
2320 This is a 12-bit absolute reloc with the
2321 right 3 bitsassumed to be 0.
2323 BFD_RELOC_D30V_15_PCREL
2325 This is a 12-bit pc-relative reloc with
2326 the right 3 bits assumed to be 0.
2328 BFD_RELOC_D30V_15_PCREL_R
2330 This is a 12-bit pc-relative reloc with
2331 the right 3 bits assumed to be 0. Same
2332 as the previous reloc but on the right side
2337 This is an 18-bit absolute reloc with
2338 the right 3 bits assumed to be 0.
2340 BFD_RELOC_D30V_21_PCREL
2342 This is an 18-bit pc-relative reloc with
2343 the right 3 bits assumed to be 0.
2345 BFD_RELOC_D30V_21_PCREL_R
2347 This is an 18-bit pc-relative reloc with
2348 the right 3 bits assumed to be 0. Same
2349 as the previous reloc but on the right side
2354 This is a 32-bit absolute reloc.
2356 BFD_RELOC_D30V_32_PCREL
2358 This is a 32-bit pc-relative reloc.
2363 Mitsubishi M32R relocs.
2364 This is a 24 bit absolute address.
2366 BFD_RELOC_M32R_10_PCREL
2368 This is a 10-bit pc-relative reloc with the right 2 bits assumed to be 0.
2370 BFD_RELOC_M32R_18_PCREL
2372 This is an 18-bit reloc with the right 2 bits assumed to be 0.
2374 BFD_RELOC_M32R_26_PCREL
2376 This is a 26-bit reloc with the right 2 bits assumed to be 0.
2378 BFD_RELOC_M32R_HI16_ULO
2380 This is a 16-bit reloc containing the high 16 bits of an address
2381 used when the lower 16 bits are treated as unsigned.
2383 BFD_RELOC_M32R_HI16_SLO
2385 This is a 16-bit reloc containing the high 16 bits of an address
2386 used when the lower 16 bits are treated as signed.
2390 This is a 16-bit reloc containing the lower 16 bits of an address.
2392 BFD_RELOC_M32R_SDA16
2394 This is a 16-bit reloc containing the small data area offset for use in
2395 add3, load, and store instructions.
2398 BFD_RELOC_V850_9_PCREL
2400 This is a 9-bit reloc
2402 BFD_RELOC_V850_22_PCREL
2404 This is a 22-bit reloc
2407 BFD_RELOC_V850_SDA_16_16_OFFSET
2409 This is a 16 bit offset from the short data area pointer.
2411 BFD_RELOC_V850_SDA_15_16_OFFSET
2413 This is a 16 bit offset (of which only 15 bits are used) from the
2414 short data area pointer.
2416 BFD_RELOC_V850_ZDA_16_16_OFFSET
2418 This is a 16 bit offset from the zero data area pointer.
2420 BFD_RELOC_V850_ZDA_15_16_OFFSET
2422 This is a 16 bit offset (of which only 15 bits are used) from the
2423 zero data area pointer.
2425 BFD_RELOC_V850_TDA_6_8_OFFSET
2427 This is an 8 bit offset (of which only 6 bits are used) from the
2428 tiny data area pointer.
2430 BFD_RELOC_V850_TDA_7_8_OFFSET
2432 This is an 8bit offset (of which only 7 bits are used) from the tiny
2435 BFD_RELOC_V850_TDA_7_7_OFFSET
2437 This is a 7 bit offset from the tiny data area pointer.
2439 BFD_RELOC_V850_TDA_16_16_OFFSET
2441 This is a 16 bit offset from the tiny data area pointer.
2444 BFD_RELOC_V850_TDA_4_5_OFFSET
2446 This is a 5 bit offset (of which only 4 bits are used) from the tiny
2449 BFD_RELOC_V850_TDA_4_4_OFFSET
2451 This is a 4 bit offset from the tiny data area pointer.
2453 BFD_RELOC_V850_SDA_16_16_SPLIT_OFFSET
2455 This is a 16 bit offset from the short data area pointer, with the
2456 bits placed non-contigously in the instruction.
2458 BFD_RELOC_V850_ZDA_16_16_SPLIT_OFFSET
2460 This is a 16 bit offset from the zero data area pointer, with the
2461 bits placed non-contigously in the instruction.
2463 BFD_RELOC_V850_CALLT_6_7_OFFSET
2465 This is a 6 bit offset from the call table base pointer.
2467 BFD_RELOC_V850_CALLT_16_16_OFFSET
2469 This is a 16 bit offset from the call table base pointer.
2473 BFD_RELOC_MN10300_32_PCREL
2475 This is a 32bit pcrel reloc for the mn10300, offset by two bytes in the
2478 BFD_RELOC_MN10300_16_PCREL
2480 This is a 16bit pcrel reloc for the mn10300, offset by two bytes in the
2486 This is a 8bit DP reloc for the tms320c30, where the most
2487 significant 8 bits of a 24 bit word are placed into the least
2488 significant 8 bits of the opcode.
2493 This is a 48 bit reloc for the FR30 that stores 32 bits.
2497 This is a 32 bit reloc for the FR30 that stores 20 bits split up into
2500 BFD_RELOC_FR30_6_IN_4
2502 This is a 16 bit reloc for the FR30 that stores a 6 bit word offset in
2505 BFD_RELOC_FR30_8_IN_8
2507 This is a 16 bit reloc for the FR30 that stores an 8 bit byte offset
2510 BFD_RELOC_FR30_9_IN_8
2512 This is a 16 bit reloc for the FR30 that stores a 9 bit short offset
2515 BFD_RELOC_FR30_10_IN_8
2517 This is a 16 bit reloc for the FR30 that stores a 10 bit word offset
2520 BFD_RELOC_FR30_9_PCREL
2522 This is a 16 bit reloc for the FR30 that stores a 9 bit pc relative
2523 short offset into 8 bits.
2525 BFD_RELOC_FR30_12_PCREL
2527 This is a 16 bit reloc for the FR30 that stores a 12 bit pc relative
2528 short offset into 11 bits.
2531 BFD_RELOC_MCORE_PCREL_IMM8BY4
2533 BFD_RELOC_MCORE_PCREL_IMM11BY2
2535 BFD_RELOC_MCORE_PCREL_IMM4BY2
2537 BFD_RELOC_MCORE_PCREL_32
2539 BFD_RELOC_MCORE_PCREL_JSR_IMM11BY2
2541 Motorola Mcore relocations.
2544 BFD_RELOC_VTABLE_INHERIT
2546 BFD_RELOC_VTABLE_ENTRY
2548 These two relocations are used by the linker to determine which of
2549 the entries in a C++ virtual function table are actually used. When
2550 the --gc-sections option is given, the linker will zero out the entries
2551 that are not used, so that the code for those functions need not be
2552 included in the output.
2554 VTABLE_INHERIT is a zero-space relocation used to describe to the
2555 linker the inheritence tree of a C++ virtual function table. The
2556 relocation's symbol should be the parent class' vtable, and the
2557 relocation should be located at the child vtable.
2559 VTABLE_ENTRY is a zero-space relocation that describes the use of a
2560 virtual function table entry. The reloc's symbol should refer to the
2561 table of the class mentioned in the code. Off of that base, an offset
2562 describes the entry that is being used. For Rela hosts, this offset
2563 is stored in the reloc's addend. For Rel hosts, we are forced to put
2564 this offset in the reloc's section offset.
2570 .typedef enum bfd_reloc_code_real bfd_reloc_code_real_type;
2576 bfd_reloc_type_lookup
2580 bfd_reloc_type_lookup (bfd *abfd, bfd_reloc_code_real_type code);
2583 Return a pointer to a howto structure which, when
2584 invoked, will perform the relocation @var{code} on data from the
2591 bfd_reloc_type_lookup (abfd, code)
2593 bfd_reloc_code_real_type code;
2595 return BFD_SEND (abfd, reloc_type_lookup, (abfd, code));
2598 static reloc_howto_type bfd_howto_32 =
2599 HOWTO (0, 00, 2, 32, false, 0, complain_overflow_bitfield, 0, "VRT32", false, 0xffffffff, 0xffffffff, true);
2604 bfd_default_reloc_type_lookup
2607 reloc_howto_type *bfd_default_reloc_type_lookup
2608 (bfd *abfd, bfd_reloc_code_real_type code);
2611 Provides a default relocation lookup routine for any architecture.
2617 bfd_default_reloc_type_lookup (abfd, code)
2619 bfd_reloc_code_real_type code;
2623 case BFD_RELOC_CTOR:
2624 /* The type of reloc used in a ctor, which will be as wide as the
2625 address - so either a 64, 32, or 16 bitter. */
2626 switch (bfd_get_arch_info (abfd)->bits_per_address)
2631 return &bfd_howto_32;
2640 return (reloc_howto_type *) NULL;
2645 bfd_get_reloc_code_name
2648 const char *bfd_get_reloc_code_name (bfd_reloc_code_real_type code);
2651 Provides a printable name for the supplied relocation code.
2652 Useful mainly for printing error messages.
2656 bfd_get_reloc_code_name (code)
2657 bfd_reloc_code_real_type code;
2659 if (code > BFD_RELOC_UNUSED)
2661 return bfd_reloc_code_real_names[(int)code];
2666 bfd_generic_relax_section
2669 boolean bfd_generic_relax_section
2672 struct bfd_link_info *,
2676 Provides default handling for relaxing for back ends which
2677 don't do relaxing -- i.e., does nothing.
2682 bfd_generic_relax_section (abfd, section, link_info, again)
2685 struct bfd_link_info *link_info;
2694 bfd_generic_gc_sections
2697 boolean bfd_generic_gc_sections
2698 (bfd *, struct bfd_link_info *);
2701 Provides default handling for relaxing for back ends which
2702 don't do section gc -- i.e., does nothing.
2707 bfd_generic_gc_sections (abfd, link_info)
2709 struct bfd_link_info *link_info;
2716 bfd_generic_get_relocated_section_contents
2720 bfd_generic_get_relocated_section_contents (bfd *abfd,
2721 struct bfd_link_info *link_info,
2722 struct bfd_link_order *link_order,
2724 boolean relocateable,
2728 Provides default handling of relocation effort for back ends
2729 which can't be bothered to do it efficiently.
2734 bfd_generic_get_relocated_section_contents (abfd, link_info, link_order, data,
2735 relocateable, symbols)
2737 struct bfd_link_info *link_info;
2738 struct bfd_link_order *link_order;
2740 boolean relocateable;
2743 /* Get enough memory to hold the stuff */
2744 bfd *input_bfd = link_order->u.indirect.section->owner;
2745 asection *input_section = link_order->u.indirect.section;
2747 long reloc_size = bfd_get_reloc_upper_bound (input_bfd, input_section);
2748 arelent **reloc_vector = NULL;
2754 reloc_vector = (arelent **) bfd_malloc ((size_t) reloc_size);
2755 if (reloc_vector == NULL && reloc_size != 0)
2758 /* read in the section */
2759 if (!bfd_get_section_contents (input_bfd,
2763 input_section->_raw_size))
2766 /* We're not relaxing the section, so just copy the size info */
2767 input_section->_cooked_size = input_section->_raw_size;
2768 input_section->reloc_done = true;
2770 reloc_count = bfd_canonicalize_reloc (input_bfd,
2774 if (reloc_count < 0)
2777 if (reloc_count > 0)
2780 for (parent = reloc_vector; *parent != (arelent *) NULL;
2783 char *error_message = (char *) NULL;
2784 bfd_reloc_status_type r =
2785 bfd_perform_relocation (input_bfd,
2789 relocateable ? abfd : (bfd *) NULL,
2794 asection *os = input_section->output_section;
2796 /* A partial link, so keep the relocs */
2797 os->orelocation[os->reloc_count] = *parent;
2801 if (r != bfd_reloc_ok)
2805 case bfd_reloc_undefined:
2806 if (!((*link_info->callbacks->undefined_symbol)
2807 (link_info, bfd_asymbol_name (*(*parent)->sym_ptr_ptr),
2808 input_bfd, input_section, (*parent)->address)))
2811 case bfd_reloc_dangerous:
2812 BFD_ASSERT (error_message != (char *) NULL);
2813 if (!((*link_info->callbacks->reloc_dangerous)
2814 (link_info, error_message, input_bfd, input_section,
2815 (*parent)->address)))
2818 case bfd_reloc_overflow:
2819 if (!((*link_info->callbacks->reloc_overflow)
2820 (link_info, bfd_asymbol_name (*(*parent)->sym_ptr_ptr),
2821 (*parent)->howto->name, (*parent)->addend,
2822 input_bfd, input_section, (*parent)->address)))
2825 case bfd_reloc_outofrange:
2834 if (reloc_vector != NULL)
2835 free (reloc_vector);
2839 if (reloc_vector != NULL)
2840 free (reloc_vector);