1 /* Object file "section" support for the BFD library.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005
4 Free Software Foundation, Inc.
5 Written by Cygnus Support.
7 This file is part of BFD, the Binary File Descriptor library.
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 2 of the License, or
12 (at your option) any later version.
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.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
27 The raw data contained within a BFD is maintained through the
28 section abstraction. A single BFD may have any number of
29 sections. It keeps hold of them by pointing to the first;
30 each one points to the next in the list.
32 Sections are supported in BFD in <<section.c>>.
38 @* section prototypes::
42 Section Input, Section Output, Sections, Sections
46 When a BFD is opened for reading, the section structures are
47 created and attached to the BFD.
49 Each section has a name which describes the section in the
50 outside world---for example, <<a.out>> would contain at least
51 three sections, called <<.text>>, <<.data>> and <<.bss>>.
53 Names need not be unique; for example a COFF file may have several
54 sections named <<.data>>.
56 Sometimes a BFD will contain more than the ``natural'' number of
57 sections. A back end may attach other sections containing
58 constructor data, or an application may add a section (using
59 <<bfd_make_section>>) to the sections attached to an already open
60 BFD. For example, the linker creates an extra section
61 <<COMMON>> for each input file's BFD to hold information about
64 The raw data is not necessarily read in when
65 the section descriptor is created. Some targets may leave the
66 data in place until a <<bfd_get_section_contents>> call is
67 made. Other back ends may read in all the data at once. For
68 example, an S-record file has to be read once to determine the
69 size of the data. An IEEE-695 file doesn't contain raw data in
70 sections, but data and relocation expressions intermixed, so
71 the data area has to be parsed to get out the data and
75 Section Output, typedef asection, Section Input, Sections
80 To write a new object style BFD, the various sections to be
81 written have to be created. They are attached to the BFD in
82 the same way as input sections; data is written to the
83 sections using <<bfd_set_section_contents>>.
85 Any program that creates or combines sections (e.g., the assembler
86 and linker) must use the <<asection>> fields <<output_section>> and
87 <<output_offset>> to indicate the file sections to which each
88 section must be written. (If the section is being created from
89 scratch, <<output_section>> should probably point to the section
90 itself and <<output_offset>> should probably be zero.)
92 The data to be written comes from input sections attached
93 (via <<output_section>> pointers) to
94 the output sections. The output section structure can be
95 considered a filter for the input section: the output section
96 determines the vma of the output data and the name, but the
97 input section determines the offset into the output section of
98 the data to be written.
100 E.g., to create a section "O", starting at 0x100, 0x123 long,
101 containing two subsections, "A" at offset 0x0 (i.e., at vma
102 0x100) and "B" at offset 0x20 (i.e., at vma 0x120) the <<asection>>
103 structures would look like:
108 | output_section -----------> section name "O"
110 | section name "B" | size 0x123
111 | output_offset 0x20 |
113 | output_section --------|
118 The data within a section is stored in a @dfn{link_order}.
119 These are much like the fixups in <<gas>>. The link_order
120 abstraction allows a section to grow and shrink within itself.
122 A link_order knows how big it is, and which is the next
123 link_order and where the raw data for it is; it also points to
124 a list of relocations which apply to it.
126 The link_order is used by the linker to perform relaxing on
127 final code. The compiler creates code which is as big as
128 necessary to make it work without relaxing, and the user can
129 select whether to relax. Sometimes relaxing takes a lot of
130 time. The linker runs around the relocations to see if any
131 are attached to data which can be shrunk, if so it does it on
132 a link_order by link_order basis.
144 typedef asection, section prototypes, Section Output, Sections
148 Here is the section structure:
152 .typedef struct bfd_section
154 . {* The name of the section; the name isn't a copy, the pointer is
155 . the same as that passed to bfd_make_section. *}
158 . {* A unique sequence number. *}
161 . {* Which section in the bfd; 0..n-1 as sections are created in a bfd. *}
164 . {* The next section in the list belonging to the BFD, or NULL. *}
165 . struct bfd_section *next;
167 . {* The previous section in the list belonging to the BFD, or NULL. *}
168 . struct bfd_section *prev;
170 . {* The field flags contains attributes of the section. Some
171 . flags are read in from the object file, and some are
172 . synthesized from other information. *}
175 .#define SEC_NO_FLAGS 0x000
177 . {* Tells the OS to allocate space for this section when loading.
178 . This is clear for a section containing debug information only. *}
179 .#define SEC_ALLOC 0x001
181 . {* Tells the OS to load the section from the file when loading.
182 . This is clear for a .bss section. *}
183 .#define SEC_LOAD 0x002
185 . {* The section contains data still to be relocated, so there is
186 . some relocation information too. *}
187 .#define SEC_RELOC 0x004
189 . {* A signal to the OS that the section contains read only data. *}
190 .#define SEC_READONLY 0x008
192 . {* The section contains code only. *}
193 .#define SEC_CODE 0x010
195 . {* The section contains data only. *}
196 .#define SEC_DATA 0x020
198 . {* The section will reside in ROM. *}
199 .#define SEC_ROM 0x040
201 . {* The section contains constructor information. This section
202 . type is used by the linker to create lists of constructors and
203 . destructors used by <<g++>>. When a back end sees a symbol
204 . which should be used in a constructor list, it creates a new
205 . section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
206 . the symbol to it, and builds a relocation. To build the lists
207 . of constructors, all the linker has to do is catenate all the
208 . sections called <<__CTOR_LIST__>> and relocate the data
209 . contained within - exactly the operations it would peform on
211 .#define SEC_CONSTRUCTOR 0x080
213 . {* The section has contents - a data section could be
214 . <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
215 . <<SEC_HAS_CONTENTS>> *}
216 .#define SEC_HAS_CONTENTS 0x100
218 . {* An instruction to the linker to not output the section
219 . even if it has information which would normally be written. *}
220 .#define SEC_NEVER_LOAD 0x200
222 . {* The section contains thread local data. *}
223 .#define SEC_THREAD_LOCAL 0x400
225 . {* The section has GOT references. This flag is only for the
226 . linker, and is currently only used by the elf32-hppa back end.
227 . It will be set if global offset table references were detected
228 . in this section, which indicate to the linker that the section
229 . contains PIC code, and must be handled specially when doing a
231 .#define SEC_HAS_GOT_REF 0x800
233 . {* The section contains common symbols (symbols may be defined
234 . multiple times, the value of a symbol is the amount of
235 . space it requires, and the largest symbol value is the one
236 . used). Most targets have exactly one of these (which we
237 . translate to bfd_com_section_ptr), but ECOFF has two. *}
238 .#define SEC_IS_COMMON 0x1000
240 . {* The section contains only debugging information. For
241 . example, this is set for ELF .debug and .stab sections.
242 . strip tests this flag to see if a section can be
244 .#define SEC_DEBUGGING 0x2000
246 . {* The contents of this section are held in memory pointed to
247 . by the contents field. This is checked by bfd_get_section_contents,
248 . and the data is retrieved from memory if appropriate. *}
249 .#define SEC_IN_MEMORY 0x4000
251 . {* The contents of this section are to be excluded by the
252 . linker for executable and shared objects unless those
253 . objects are to be further relocated. *}
254 .#define SEC_EXCLUDE 0x8000
256 . {* The contents of this section are to be sorted based on the sum of
257 . the symbol and addend values specified by the associated relocation
258 . entries. Entries without associated relocation entries will be
259 . appended to the end of the section in an unspecified order. *}
260 .#define SEC_SORT_ENTRIES 0x10000
262 . {* When linking, duplicate sections of the same name should be
263 . discarded, rather than being combined into a single section as
264 . is usually done. This is similar to how common symbols are
265 . handled. See SEC_LINK_DUPLICATES below. *}
266 .#define SEC_LINK_ONCE 0x20000
268 . {* If SEC_LINK_ONCE is set, this bitfield describes how the linker
269 . should handle duplicate sections. *}
270 .#define SEC_LINK_DUPLICATES 0x40000
272 . {* This value for SEC_LINK_DUPLICATES means that duplicate
273 . sections with the same name should simply be discarded. *}
274 .#define SEC_LINK_DUPLICATES_DISCARD 0x0
276 . {* This value for SEC_LINK_DUPLICATES means that the linker
277 . should warn if there are any duplicate sections, although
278 . it should still only link one copy. *}
279 .#define SEC_LINK_DUPLICATES_ONE_ONLY 0x80000
281 . {* This value for SEC_LINK_DUPLICATES means that the linker
282 . should warn if any duplicate sections are a different size. *}
283 .#define SEC_LINK_DUPLICATES_SAME_SIZE 0x100000
285 . {* This value for SEC_LINK_DUPLICATES means that the linker
286 . should warn if any duplicate sections contain different
288 .#define SEC_LINK_DUPLICATES_SAME_CONTENTS \
289 . (SEC_LINK_DUPLICATES_ONE_ONLY | SEC_LINK_DUPLICATES_SAME_SIZE)
291 . {* This section was created by the linker as part of dynamic
292 . relocation or other arcane processing. It is skipped when
293 . going through the first-pass output, trusting that someone
294 . else up the line will take care of it later. *}
295 .#define SEC_LINKER_CREATED 0x200000
297 . {* This section should not be subject to garbage collection. *}
298 .#define SEC_KEEP 0x400000
300 . {* This section contains "short" data, and should be placed
302 .#define SEC_SMALL_DATA 0x800000
304 . {* Attempt to merge identical entities in the section.
305 . Entity size is given in the entsize field. *}
306 .#define SEC_MERGE 0x1000000
308 . {* If given with SEC_MERGE, entities to merge are zero terminated
309 . strings where entsize specifies character size instead of fixed
311 .#define SEC_STRINGS 0x2000000
313 . {* This section contains data about section groups. *}
314 .#define SEC_GROUP 0x4000000
316 . {* The section is a COFF shared library section. This flag is
317 . only for the linker. If this type of section appears in
318 . the input file, the linker must copy it to the output file
319 . without changing the vma or size. FIXME: Although this
320 . was originally intended to be general, it really is COFF
321 . specific (and the flag was renamed to indicate this). It
322 . might be cleaner to have some more general mechanism to
323 . allow the back end to control what the linker does with
325 .#define SEC_COFF_SHARED_LIBRARY 0x10000000
327 . {* This section contains data which may be shared with other
328 . executables or shared objects. This is for COFF only. *}
329 .#define SEC_COFF_SHARED 0x20000000
331 . {* When a section with this flag is being linked, then if the size of
332 . the input section is less than a page, it should not cross a page
333 . boundary. If the size of the input section is one page or more,
334 . it should be aligned on a page boundary. This is for TI
335 . TMS320C54X only. *}
336 .#define SEC_TIC54X_BLOCK 0x40000000
338 . {* Conditionally link this section; do not link if there are no
339 . references found to any symbol in the section. This is for TI
340 . TMS320C54X only. *}
341 .#define SEC_TIC54X_CLINK 0x80000000
343 . {* End of section flags. *}
345 . {* Some internal packed boolean fields. *}
347 . {* See the vma field. *}
348 . unsigned int user_set_vma : 1;
350 . {* A mark flag used by some of the linker backends. *}
351 . unsigned int linker_mark : 1;
353 . {* Another mark flag used by some of the linker backends. Set for
354 . output sections that have an input section. *}
355 . unsigned int linker_has_input : 1;
357 . {* Mark flags used by some linker backends for garbage collection. *}
358 . unsigned int gc_mark : 1;
359 . unsigned int gc_mark_from_eh : 1;
361 . {* The following flags are used by the ELF linker. *}
363 . {* Mark sections which have been allocated to segments. *}
364 . unsigned int segment_mark : 1;
366 . {* Type of sec_info information. *}
367 . unsigned int sec_info_type:3;
368 .#define ELF_INFO_TYPE_NONE 0
369 .#define ELF_INFO_TYPE_STABS 1
370 .#define ELF_INFO_TYPE_MERGE 2
371 .#define ELF_INFO_TYPE_EH_FRAME 3
372 .#define ELF_INFO_TYPE_JUST_SYMS 4
374 . {* Nonzero if this section uses RELA relocations, rather than REL. *}
375 . unsigned int use_rela_p:1;
377 . {* Bits used by various backends. The generic code doesn't touch
380 . {* Nonzero if this section has TLS related relocations. *}
381 . unsigned int has_tls_reloc:1;
383 . {* Nonzero if this section has a gp reloc. *}
384 . unsigned int has_gp_reloc:1;
386 . {* Nonzero if this section needs the relax finalize pass. *}
387 . unsigned int need_finalize_relax:1;
389 . {* Whether relocations have been processed. *}
390 . unsigned int reloc_done : 1;
392 . {* End of internal packed boolean fields. *}
394 . {* The virtual memory address of the section - where it will be
395 . at run time. The symbols are relocated against this. The
396 . user_set_vma flag is maintained by bfd; if it's not set, the
397 . backend can assign addresses (for example, in <<a.out>>, where
398 . the default address for <<.data>> is dependent on the specific
399 . target and various flags). *}
402 . {* The load address of the section - where it would be in a
403 . rom image; really only used for writing section header
407 . {* The size of the section in octets, as it will be output.
408 . Contains a value even if the section has no contents (e.g., the
409 . size of <<.bss>>). *}
410 . bfd_size_type size;
412 . {* For input sections, the original size on disk of the section, in
413 . octets. This field is used by the linker relaxation code. It is
414 . currently only set for sections where the linker relaxation scheme
415 . doesn't cache altered section and reloc contents (stabs, eh_frame,
416 . SEC_MERGE, some coff relaxing targets), and thus the original size
417 . needs to be kept to read the section multiple times.
418 . For output sections, rawsize holds the section size calculated on
419 . a previous linker relaxation pass. *}
420 . bfd_size_type rawsize;
422 . {* If this section is going to be output, then this value is the
423 . offset in *bytes* into the output section of the first byte in the
424 . input section (byte ==> smallest addressable unit on the
425 . target). In most cases, if this was going to start at the
426 . 100th octet (8-bit quantity) in the output section, this value
427 . would be 100. However, if the target byte size is 16 bits
428 . (bfd_octets_per_byte is "2"), this value would be 50. *}
429 . bfd_vma output_offset;
431 . {* The output section through which to map on output. *}
432 . struct bfd_section *output_section;
434 . {* The alignment requirement of the section, as an exponent of 2 -
435 . e.g., 3 aligns to 2^3 (or 8). *}
436 . unsigned int alignment_power;
438 . {* If an input section, a pointer to a vector of relocation
439 . records for the data in this section. *}
440 . struct reloc_cache_entry *relocation;
442 . {* If an output section, a pointer to a vector of pointers to
443 . relocation records for the data in this section. *}
444 . struct reloc_cache_entry **orelocation;
446 . {* The number of relocation records in one of the above. *}
447 . unsigned reloc_count;
449 . {* Information below is back end specific - and not always used
452 . {* File position of section data. *}
455 . {* File position of relocation info. *}
456 . file_ptr rel_filepos;
458 . {* File position of line data. *}
459 . file_ptr line_filepos;
461 . {* Pointer to data for applications. *}
464 . {* If the SEC_IN_MEMORY flag is set, this points to the actual
466 . unsigned char *contents;
468 . {* Attached line number information. *}
471 . {* Number of line number records. *}
472 . unsigned int lineno_count;
474 . {* Entity size for merging purposes. *}
475 . unsigned int entsize;
477 . {* Points to the kept section if this section is a link-once section,
478 . and is discarded. *}
479 . struct bfd_section *kept_section;
481 . {* When a section is being output, this value changes as more
482 . linenumbers are written out. *}
483 . file_ptr moving_line_filepos;
485 . {* What the section number is in the target world. *}
490 . {* If this is a constructor section then here is a list of the
491 . relocations created to relocate items within it. *}
492 . struct relent_chain *constructor_chain;
494 . {* The BFD which owns the section. *}
497 . {* A symbol which points at this section only. *}
498 . struct bfd_symbol *symbol;
499 . struct bfd_symbol **symbol_ptr_ptr;
501 . {* Early in the link process, map_head and map_tail are used to build
502 . a list of input sections attached to an output section. Later,
503 . output sections use these fields for a list of bfd_link_order
506 . struct bfd_link_order *link_order;
507 . struct bfd_section *s;
508 . } map_head, map_tail;
511 .{* These sections are global, and are managed by BFD. The application
512 . and target back end are not permitted to change the values in
513 . these sections. New code should use the section_ptr macros rather
514 . than referring directly to the const sections. The const sections
515 . may eventually vanish. *}
516 .#define BFD_ABS_SECTION_NAME "*ABS*"
517 .#define BFD_UND_SECTION_NAME "*UND*"
518 .#define BFD_COM_SECTION_NAME "*COM*"
519 .#define BFD_IND_SECTION_NAME "*IND*"
521 .{* The absolute section. *}
522 .extern asection bfd_abs_section;
523 .#define bfd_abs_section_ptr ((asection *) &bfd_abs_section)
524 .#define bfd_is_abs_section(sec) ((sec) == bfd_abs_section_ptr)
525 .{* Pointer to the undefined section. *}
526 .extern asection bfd_und_section;
527 .#define bfd_und_section_ptr ((asection *) &bfd_und_section)
528 .#define bfd_is_und_section(sec) ((sec) == bfd_und_section_ptr)
529 .{* Pointer to the common section. *}
530 .extern asection bfd_com_section;
531 .#define bfd_com_section_ptr ((asection *) &bfd_com_section)
532 .{* Pointer to the indirect section. *}
533 .extern asection bfd_ind_section;
534 .#define bfd_ind_section_ptr ((asection *) &bfd_ind_section)
535 .#define bfd_is_ind_section(sec) ((sec) == bfd_ind_section_ptr)
537 .#define bfd_is_const_section(SEC) \
538 . ( ((SEC) == bfd_abs_section_ptr) \
539 . || ((SEC) == bfd_und_section_ptr) \
540 . || ((SEC) == bfd_com_section_ptr) \
541 . || ((SEC) == bfd_ind_section_ptr))
543 .extern const struct bfd_symbol * const bfd_abs_symbol;
544 .extern const struct bfd_symbol * const bfd_com_symbol;
545 .extern const struct bfd_symbol * const bfd_und_symbol;
546 .extern const struct bfd_symbol * const bfd_ind_symbol;
548 .{* Macros to handle insertion and deletion of a bfd's sections. These
549 . only handle the list pointers, ie. do not adjust section_count,
550 . target_index etc. *}
551 .#define bfd_section_list_remove(ABFD, S) \
554 . asection *_s = S; \
555 . asection *_next = _s->next; \
556 . asection *_prev = _s->prev; \
558 . _prev->next = _next; \
560 . (ABFD)->sections = _next; \
562 . _next->prev = _prev; \
564 . (ABFD)->section_last = _prev; \
567 .#define bfd_section_list_append(ABFD, S) \
570 . asection *_s = S; \
571 . bfd *_abfd = ABFD; \
573 . if (_abfd->section_last) \
575 . _s->prev = _abfd->section_last; \
576 . _abfd->section_last->next = _s; \
581 . _abfd->sections = _s; \
583 . _abfd->section_last = _s; \
586 .#define bfd_section_list_prepend(ABFD, S) \
589 . asection *_s = S; \
590 . bfd *_abfd = ABFD; \
592 . if (_abfd->sections) \
594 . _s->next = _abfd->sections; \
595 . _abfd->sections->prev = _s; \
600 . _abfd->section_last = _s; \
602 . _abfd->sections = _s; \
605 .#define bfd_section_list_insert_after(ABFD, A, S) \
608 . asection *_a = A; \
609 . asection *_s = S; \
610 . asection *_next = _a->next; \
611 . _s->next = _next; \
615 . _next->prev = _s; \
617 . (ABFD)->section_last = _s; \
620 .#define bfd_section_list_insert_before(ABFD, B, S) \
623 . asection *_b = B; \
624 . asection *_s = S; \
625 . asection *_prev = _b->prev; \
626 . _s->prev = _prev; \
630 . _prev->next = _s; \
632 . (ABFD)->sections = _s; \
635 .#define bfd_section_removed_from_list(ABFD, S) \
636 . ((S)->next == NULL ? (ABFD)->section_last != (S) : (S)->next->prev != (S))
640 /* We use a macro to initialize the static asymbol structures because
641 traditional C does not permit us to initialize a union member while
642 gcc warns if we don't initialize it. */
643 /* the_bfd, name, value, attr, section [, udata] */
645 #define GLOBAL_SYM_INIT(NAME, SECTION) \
646 { 0, NAME, 0, BSF_SECTION_SYM, (asection *) SECTION, { 0 }}
648 #define GLOBAL_SYM_INIT(NAME, SECTION) \
649 { 0, NAME, 0, BSF_SECTION_SYM, (asection *) SECTION }
652 /* These symbols are global, not specific to any BFD. Therefore, anything
653 that tries to change them is broken, and should be repaired. */
655 static const asymbol global_syms[] =
657 GLOBAL_SYM_INIT (BFD_COM_SECTION_NAME, &bfd_com_section),
658 GLOBAL_SYM_INIT (BFD_UND_SECTION_NAME, &bfd_und_section),
659 GLOBAL_SYM_INIT (BFD_ABS_SECTION_NAME, &bfd_abs_section),
660 GLOBAL_SYM_INIT (BFD_IND_SECTION_NAME, &bfd_ind_section)
663 #define STD_SECTION(SEC, FLAGS, SYM, NAME, IDX) \
664 const asymbol * const SYM = (asymbol *) &global_syms[IDX]; \
666 /* name, id, index, next, prev, flags, user_set_vma, */ \
667 { NAME, IDX, 0, NULL, NULL, FLAGS, 0, \
669 /* linker_mark, linker_has_input, gc_mark, gc_mark_from_eh, */ \
672 /* segment_mark, sec_info_type, use_rela_p, has_tls_reloc, */ \
675 /* has_gp_reloc, need_finalize_relax, reloc_done, */ \
678 /* vma, lma, size, rawsize */ \
681 /* output_offset, output_section, alignment_power, */ \
682 0, (struct bfd_section *) &SEC, 0, \
684 /* relocation, orelocation, reloc_count, filepos, rel_filepos, */ \
685 NULL, NULL, 0, 0, 0, \
687 /* line_filepos, userdata, contents, lineno, lineno_count, */ \
688 0, NULL, NULL, NULL, 0, \
690 /* entsize, kept_section, moving_line_filepos, */ \
693 /* target_index, used_by_bfd, constructor_chain, owner, */ \
694 0, NULL, NULL, NULL, \
697 (struct bfd_symbol *) &global_syms[IDX], \
699 /* symbol_ptr_ptr, */ \
700 (struct bfd_symbol **) &SYM, \
702 /* map_head, map_tail */ \
706 STD_SECTION (bfd_com_section, SEC_IS_COMMON, bfd_com_symbol,
707 BFD_COM_SECTION_NAME, 0);
708 STD_SECTION (bfd_und_section, 0, bfd_und_symbol, BFD_UND_SECTION_NAME, 1);
709 STD_SECTION (bfd_abs_section, 0, bfd_abs_symbol, BFD_ABS_SECTION_NAME, 2);
710 STD_SECTION (bfd_ind_section, 0, bfd_ind_symbol, BFD_IND_SECTION_NAME, 3);
713 struct section_hash_entry
715 struct bfd_hash_entry root;
719 /* Initialize an entry in the section hash table. */
721 struct bfd_hash_entry *
722 bfd_section_hash_newfunc (struct bfd_hash_entry *entry,
723 struct bfd_hash_table *table,
726 /* Allocate the structure if it has not already been allocated by a
730 entry = (struct bfd_hash_entry *)
731 bfd_hash_allocate (table, sizeof (struct section_hash_entry));
736 /* Call the allocation method of the superclass. */
737 entry = bfd_hash_newfunc (entry, table, string);
739 memset (&((struct section_hash_entry *) entry)->section, 0,
745 #define section_hash_lookup(table, string, create, copy) \
746 ((struct section_hash_entry *) \
747 bfd_hash_lookup ((table), (string), (create), (copy)))
749 /* Initializes a new section. NEWSECT->NAME is already set. */
752 bfd_section_init (bfd *abfd, asection *newsect)
754 static int section_id = 0x10; /* id 0 to 3 used by STD_SECTION. */
756 newsect->id = section_id;
757 newsect->index = abfd->section_count;
758 newsect->owner = abfd;
760 /* Create a symbol whose only job is to point to this section. This
761 is useful for things like relocs which are relative to the base
763 newsect->symbol = bfd_make_empty_symbol (abfd);
764 if (newsect->symbol == NULL)
767 newsect->symbol->name = newsect->name;
768 newsect->symbol->value = 0;
769 newsect->symbol->section = newsect;
770 newsect->symbol->flags = BSF_SECTION_SYM;
772 newsect->symbol_ptr_ptr = &newsect->symbol;
774 if (! BFD_SEND (abfd, _new_section_hook, (abfd, newsect)))
778 abfd->section_count++;
779 bfd_section_list_append (abfd, newsect);
786 section prototypes, , typedef asection, Sections
790 These are the functions exported by the section handling part of BFD.
795 bfd_section_list_clear
798 void bfd_section_list_clear (bfd *);
801 Clears the section list, and also resets the section count and
806 bfd_section_list_clear (bfd *abfd)
808 abfd->sections = NULL;
809 abfd->section_last = NULL;
810 abfd->section_count = 0;
811 memset (abfd->section_htab.table, 0,
812 abfd->section_htab.size * sizeof (struct bfd_hash_entry *));
817 bfd_get_section_by_name
820 asection *bfd_get_section_by_name (bfd *abfd, const char *name);
823 Run through @var{abfd} and return the one of the
824 <<asection>>s whose name matches @var{name}, otherwise <<NULL>>.
825 @xref{Sections}, for more information.
827 This should only be used in special cases; the normal way to process
828 all sections of a given name is to use <<bfd_map_over_sections>> and
829 <<strcmp>> on the name (or better yet, base it on the section flags
830 or something else) for each section.
834 bfd_get_section_by_name (bfd *abfd, const char *name)
836 struct section_hash_entry *sh;
838 sh = section_hash_lookup (&abfd->section_htab, name, FALSE, FALSE);
847 bfd_get_section_by_name_if
850 asection *bfd_get_section_by_name_if
853 bfd_boolean (*func) (bfd *abfd, asection *sect, void *obj),
857 Call the provided function @var{func} for each section
858 attached to the BFD @var{abfd} whose name matches @var{name},
859 passing @var{obj} as an argument. The function will be called
862 | func (abfd, the_section, obj);
864 It returns the first section for which @var{func} returns true,
870 bfd_get_section_by_name_if (bfd *abfd, const char *name,
871 bfd_boolean (*operation) (bfd *,
876 struct section_hash_entry *sh;
879 sh = section_hash_lookup (&abfd->section_htab, name, FALSE, FALSE);
883 hash = sh->root.hash;
886 if ((*operation) (abfd, &sh->section, user_storage))
888 sh = (struct section_hash_entry *) sh->root.next;
890 while (sh != NULL && sh->root.hash == hash
891 && strcmp (sh->root.string, name) == 0);
898 bfd_get_unique_section_name
901 char *bfd_get_unique_section_name
902 (bfd *abfd, const char *templat, int *count);
905 Invent a section name that is unique in @var{abfd} by tacking
906 a dot and a digit suffix onto the original @var{templat}. If
907 @var{count} is non-NULL, then it specifies the first number
908 tried as a suffix to generate a unique name. The value
909 pointed to by @var{count} will be incremented in this case.
913 bfd_get_unique_section_name (bfd *abfd, const char *templat, int *count)
919 len = strlen (templat);
920 sname = bfd_malloc (len + 8);
923 memcpy (sname, templat, len);
930 /* If we have a million sections, something is badly wrong. */
933 sprintf (sname + len, ".%d", num++);
935 while (section_hash_lookup (&abfd->section_htab, sname, FALSE, FALSE));
944 bfd_make_section_old_way
947 asection *bfd_make_section_old_way (bfd *abfd, const char *name);
950 Create a new empty section called @var{name}
951 and attach it to the end of the chain of sections for the
952 BFD @var{abfd}. An attempt to create a section with a name which
953 is already in use returns its pointer without changing the
956 It has the funny name since this is the way it used to be
957 before it was rewritten....
960 o <<bfd_error_invalid_operation>> -
961 If output has already started for this BFD.
962 o <<bfd_error_no_memory>> -
963 If memory allocation fails.
968 bfd_make_section_old_way (bfd *abfd, const char *name)
970 struct section_hash_entry *sh;
973 if (abfd->output_has_begun)
975 bfd_set_error (bfd_error_invalid_operation);
979 if (strcmp (name, BFD_ABS_SECTION_NAME) == 0)
980 return bfd_abs_section_ptr;
982 if (strcmp (name, BFD_COM_SECTION_NAME) == 0)
983 return bfd_com_section_ptr;
985 if (strcmp (name, BFD_UND_SECTION_NAME) == 0)
986 return bfd_und_section_ptr;
988 if (strcmp (name, BFD_IND_SECTION_NAME) == 0)
989 return bfd_ind_section_ptr;
991 sh = section_hash_lookup (&abfd->section_htab, name, TRUE, FALSE);
995 newsect = &sh->section;
996 if (newsect->name != NULL)
998 /* Section already exists. */
1002 newsect->name = name;
1003 return bfd_section_init (abfd, newsect);
1008 bfd_make_section_anyway_with_flags
1011 asection *bfd_make_section_anyway_with_flags
1012 (bfd *abfd, const char *name, flagword flags);
1015 Create a new empty section called @var{name} and attach it to the end of
1016 the chain of sections for @var{abfd}. Create a new section even if there
1017 is already a section with that name. Also set the attributes of the
1018 new section to the value @var{flags}.
1020 Return <<NULL>> and set <<bfd_error>> on error; possible errors are:
1021 o <<bfd_error_invalid_operation>> - If output has already started for @var{abfd}.
1022 o <<bfd_error_no_memory>> - If memory allocation fails.
1026 bfd_make_section_anyway_with_flags (bfd *abfd, const char *name,
1029 struct section_hash_entry *sh;
1032 if (abfd->output_has_begun)
1034 bfd_set_error (bfd_error_invalid_operation);
1038 sh = section_hash_lookup (&abfd->section_htab, name, TRUE, FALSE);
1042 newsect = &sh->section;
1043 if (newsect->name != NULL)
1045 /* We are making a section of the same name. Put it in the
1046 section hash table. Even though we can't find it directly by a
1047 hash lookup, we'll be able to find the section by traversing
1048 sh->root.next quicker than looking at all the bfd sections. */
1049 struct section_hash_entry *new_sh;
1050 new_sh = (struct section_hash_entry *)
1051 bfd_section_hash_newfunc (NULL, &abfd->section_htab, name);
1055 new_sh->root = sh->root;
1056 sh->root.next = &new_sh->root;
1057 newsect = &new_sh->section;
1060 newsect->flags = flags;
1061 newsect->name = name;
1062 return bfd_section_init (abfd, newsect);
1067 bfd_make_section_anyway
1070 asection *bfd_make_section_anyway (bfd *abfd, const char *name);
1073 Create a new empty section called @var{name} and attach it to the end of
1074 the chain of sections for @var{abfd}. Create a new section even if there
1075 is already a section with that name.
1077 Return <<NULL>> and set <<bfd_error>> on error; possible errors are:
1078 o <<bfd_error_invalid_operation>> - If output has already started for @var{abfd}.
1079 o <<bfd_error_no_memory>> - If memory allocation fails.
1083 bfd_make_section_anyway (bfd *abfd, const char *name)
1085 return bfd_make_section_anyway_with_flags (abfd, name, 0);
1090 bfd_make_section_with_flags
1093 asection *bfd_make_section_with_flags
1094 (bfd *, const char *name, flagword flags);
1097 Like <<bfd_make_section_anyway>>, but return <<NULL>> (without calling
1098 bfd_set_error ()) without changing the section chain if there is already a
1099 section named @var{name}. Also set the attributes of the new section to
1100 the value @var{flags}. If there is an error, return <<NULL>> and set
1105 bfd_make_section_with_flags (bfd *abfd, const char *name,
1108 struct section_hash_entry *sh;
1111 if (abfd->output_has_begun)
1113 bfd_set_error (bfd_error_invalid_operation);
1117 if (strcmp (name, BFD_ABS_SECTION_NAME) == 0
1118 || strcmp (name, BFD_COM_SECTION_NAME) == 0
1119 || strcmp (name, BFD_UND_SECTION_NAME) == 0
1120 || strcmp (name, BFD_IND_SECTION_NAME) == 0)
1123 sh = section_hash_lookup (&abfd->section_htab, name, TRUE, FALSE);
1127 newsect = &sh->section;
1128 if (newsect->name != NULL)
1130 /* Section already exists. */
1134 newsect->name = name;
1135 newsect->flags = flags;
1136 return bfd_section_init (abfd, newsect);
1144 asection *bfd_make_section (bfd *, const char *name);
1147 Like <<bfd_make_section_anyway>>, but return <<NULL>> (without calling
1148 bfd_set_error ()) without changing the section chain if there is already a
1149 section named @var{name}. If there is an error, return <<NULL>> and set
1154 bfd_make_section (bfd *abfd, const char *name)
1156 return bfd_make_section_with_flags (abfd, name, 0);
1161 bfd_set_section_flags
1164 bfd_boolean bfd_set_section_flags
1165 (bfd *abfd, asection *sec, flagword flags);
1168 Set the attributes of the section @var{sec} in the BFD
1169 @var{abfd} to the value @var{flags}. Return <<TRUE>> on success,
1170 <<FALSE>> on error. Possible error returns are:
1172 o <<bfd_error_invalid_operation>> -
1173 The section cannot have one or more of the attributes
1174 requested. For example, a .bss section in <<a.out>> may not
1175 have the <<SEC_HAS_CONTENTS>> field set.
1180 bfd_set_section_flags (bfd *abfd ATTRIBUTE_UNUSED,
1184 section->flags = flags;
1190 bfd_map_over_sections
1193 void bfd_map_over_sections
1195 void (*func) (bfd *abfd, asection *sect, void *obj),
1199 Call the provided function @var{func} for each section
1200 attached to the BFD @var{abfd}, passing @var{obj} as an
1201 argument. The function will be called as if by
1203 | func (abfd, the_section, obj);
1205 This is the preferred method for iterating over sections; an
1206 alternative would be to use a loop:
1209 | for (p = abfd->sections; p != NULL; p = p->next)
1210 | func (abfd, p, ...)
1215 bfd_map_over_sections (bfd *abfd,
1216 void (*operation) (bfd *, asection *, void *),
1222 for (sect = abfd->sections; sect != NULL; i++, sect = sect->next)
1223 (*operation) (abfd, sect, user_storage);
1225 if (i != abfd->section_count) /* Debugging */
1231 bfd_sections_find_if
1234 asection *bfd_sections_find_if
1236 bfd_boolean (*operation) (bfd *abfd, asection *sect, void *obj),
1240 Call the provided function @var{operation} for each section
1241 attached to the BFD @var{abfd}, passing @var{obj} as an
1242 argument. The function will be called as if by
1244 | operation (abfd, the_section, obj);
1246 It returns the first section for which @var{operation} returns true.
1251 bfd_sections_find_if (bfd *abfd,
1252 bfd_boolean (*operation) (bfd *, asection *, void *),
1257 for (sect = abfd->sections; sect != NULL; sect = sect->next)
1258 if ((*operation) (abfd, sect, user_storage))
1266 bfd_set_section_size
1269 bfd_boolean bfd_set_section_size
1270 (bfd *abfd, asection *sec, bfd_size_type val);
1273 Set @var{sec} to the size @var{val}. If the operation is
1274 ok, then <<TRUE>> is returned, else <<FALSE>>.
1276 Possible error returns:
1277 o <<bfd_error_invalid_operation>> -
1278 Writing has started to the BFD, so setting the size is invalid.
1283 bfd_set_section_size (bfd *abfd, sec_ptr ptr, bfd_size_type val)
1285 /* Once you've started writing to any section you cannot create or change
1286 the size of any others. */
1288 if (abfd->output_has_begun)
1290 bfd_set_error (bfd_error_invalid_operation);
1300 bfd_set_section_contents
1303 bfd_boolean bfd_set_section_contents
1304 (bfd *abfd, asection *section, const void *data,
1305 file_ptr offset, bfd_size_type count);
1308 Sets the contents of the section @var{section} in BFD
1309 @var{abfd} to the data starting in memory at @var{data}. The
1310 data is written to the output section starting at offset
1311 @var{offset} for @var{count} octets.
1313 Normally <<TRUE>> is returned, else <<FALSE>>. Possible error
1315 o <<bfd_error_no_contents>> -
1316 The output section does not have the <<SEC_HAS_CONTENTS>>
1317 attribute, so nothing can be written to it.
1320 This routine is front end to the back end function
1321 <<_bfd_set_section_contents>>.
1326 bfd_set_section_contents (bfd *abfd,
1328 const void *location,
1330 bfd_size_type count)
1334 if (!(bfd_get_section_flags (abfd, section) & SEC_HAS_CONTENTS))
1336 bfd_set_error (bfd_error_no_contents);
1341 if ((bfd_size_type) offset > sz
1343 || offset + count > sz
1344 || count != (size_t) count)
1346 bfd_set_error (bfd_error_bad_value);
1350 if (!bfd_write_p (abfd))
1352 bfd_set_error (bfd_error_invalid_operation);
1356 /* Record a copy of the data in memory if desired. */
1357 if (section->contents
1358 && location != section->contents + offset)
1359 memcpy (section->contents + offset, location, (size_t) count);
1361 if (BFD_SEND (abfd, _bfd_set_section_contents,
1362 (abfd, section, location, offset, count)))
1364 abfd->output_has_begun = TRUE;
1373 bfd_get_section_contents
1376 bfd_boolean bfd_get_section_contents
1377 (bfd *abfd, asection *section, void *location, file_ptr offset,
1378 bfd_size_type count);
1381 Read data from @var{section} in BFD @var{abfd}
1382 into memory starting at @var{location}. The data is read at an
1383 offset of @var{offset} from the start of the input section,
1384 and is read for @var{count} bytes.
1386 If the contents of a constructor with the <<SEC_CONSTRUCTOR>>
1387 flag set are requested or if the section does not have the
1388 <<SEC_HAS_CONTENTS>> flag set, then the @var{location} is filled
1389 with zeroes. If no errors occur, <<TRUE>> is returned, else
1394 bfd_get_section_contents (bfd *abfd,
1398 bfd_size_type count)
1402 if (section->flags & SEC_CONSTRUCTOR)
1404 memset (location, 0, (size_t) count);
1408 sz = section->rawsize ? section->rawsize : section->size;
1409 if ((bfd_size_type) offset > sz
1411 || offset + count > sz
1412 || count != (size_t) count)
1414 bfd_set_error (bfd_error_bad_value);
1422 if ((section->flags & SEC_HAS_CONTENTS) == 0)
1424 memset (location, 0, (size_t) count);
1428 if ((section->flags & SEC_IN_MEMORY) != 0)
1430 memcpy (location, section->contents + offset, (size_t) count);
1434 return BFD_SEND (abfd, _bfd_get_section_contents,
1435 (abfd, section, location, offset, count));
1440 bfd_malloc_and_get_section
1443 bfd_boolean bfd_malloc_and_get_section
1444 (bfd *abfd, asection *section, bfd_byte **buf);
1447 Read all data from @var{section} in BFD @var{abfd}
1448 into a buffer, *@var{buf}, malloc'd by this function.
1452 bfd_malloc_and_get_section (bfd *abfd, sec_ptr sec, bfd_byte **buf)
1454 bfd_size_type sz = sec->rawsize ? sec->rawsize : sec->size;
1461 p = bfd_malloc (sec->rawsize > sec->size ? sec->rawsize : sec->size);
1466 return bfd_get_section_contents (abfd, sec, p, 0, sz);
1470 bfd_copy_private_section_data
1473 bfd_boolean bfd_copy_private_section_data
1474 (bfd *ibfd, asection *isec, bfd *obfd, asection *osec);
1477 Copy private section information from @var{isec} in the BFD
1478 @var{ibfd} to the section @var{osec} in the BFD @var{obfd}.
1479 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
1482 o <<bfd_error_no_memory>> -
1483 Not enough memory exists to create private data for @var{osec}.
1485 .#define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1486 . BFD_SEND (obfd, _bfd_copy_private_section_data, \
1487 . (ibfd, isection, obfd, osection))
1492 bfd_generic_is_group_section
1495 bfd_boolean bfd_generic_is_group_section (bfd *, const asection *sec);
1498 Returns TRUE if @var{sec} is a member of a group.
1502 bfd_generic_is_group_section (bfd *abfd ATTRIBUTE_UNUSED,
1503 const asection *sec ATTRIBUTE_UNUSED)
1510 bfd_generic_discard_group
1513 bfd_boolean bfd_generic_discard_group (bfd *abfd, asection *group);
1516 Remove all members of @var{group} from the output.
1520 bfd_generic_discard_group (bfd *abfd ATTRIBUTE_UNUSED,
1521 asection *group ATTRIBUTE_UNUSED)