hash bfd sections for fast lookup and create.
[external/binutils.git] / bfd / section.c
1 /* Object file "section" support for the BFD library.
2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3    2000, 2001
4    Free Software Foundation, Inc.
5    Written by Cygnus Support.
6
7 This file is part of BFD, the Binary File Descriptor library.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
22
23 /*
24 SECTION
25         Sections
26
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.
31
32         Sections are supported in BFD in <<section.c>>.
33
34 @menu
35 @* Section Input::
36 @* Section Output::
37 @* typedef asection::
38 @* section prototypes::
39 @end menu
40
41 INODE
42 Section Input, Section Output, Sections, Sections
43 SUBSECTION
44         Section input
45
46         When a BFD is opened for reading, the section structures are
47         created and attached to the BFD.
48
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>>.
52
53         Names need not be unique; for example a COFF file may have several
54         sections named <<.data>>.
55
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
62         common storage.
63
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
72         relocations.
73
74 INODE
75 Section Output, typedef asection, Section Input, Sections
76
77 SUBSECTION
78         Section output
79
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>>.
84
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.)
91
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.
99
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:
104
105 |   section name          "A"
106 |     output_offset   0x00
107 |     size            0x20
108 |     output_section ----------->  section name    "O"
109 |                             |    vma             0x100
110 |   section name          "B" |    size            0x123
111 |     output_offset   0x20    |
112 |     size            0x103   |
113 |     output_section  --------|
114
115 SUBSECTION
116         Link orders
117
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.
121
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.
125
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.
133
134 */
135
136 #include "bfd.h"
137 #include "sysdep.h"
138 #include "libbfd.h"
139 #include "bfdlink.h"
140
141 /*
142 DOCDD
143 INODE
144 typedef asection, section prototypes, Section Output, Sections
145 SUBSECTION
146         typedef asection
147
148         Here is the section structure:
149
150 CODE_FRAGMENT
151 .
152 .{* This structure is used for a comdat section, as in PE.  A comdat
153 .   section is associated with a particular symbol.  When the linker
154 .   sees a comdat section, it keeps only one of the sections with a
155 .   given name and associated with a given symbol.  *}
156 .
157 .struct bfd_comdat_info
158 .{
159 .  {* The name of the symbol associated with a comdat section.  *}
160 .  const char *name;
161 .
162 .  {* The local symbol table index of the symbol associated with a
163 .     comdat section.  This is only meaningful to the object file format
164 .     specific code; it is not an index into the list returned by
165 .     bfd_canonicalize_symtab.  *}
166 .  long symbol;
167 .};
168 .
169 .typedef struct sec
170 .{
171 .  {* The name of the section; the name isn't a copy, the pointer is
172 .     the same as that passed to bfd_make_section.  *}
173 .
174 .  const char *name;
175 .
176 .  {* A unique sequence number.  *}
177 .
178 .  int id;
179 .
180 .  {* Which section in the bfd; 0..n-1 as sections are created in a bfd.  *}
181 .
182 .  int index;
183 .
184 .  {* The next section in the list belonging to the BFD, or NULL.  *}
185 .
186 .  struct sec *next;
187 .
188 .  {* The field flags contains attributes of the section. Some
189 .     flags are read in from the object file, and some are
190 .     synthesized from other information.  *}
191 .
192 .  flagword flags;
193 .
194 .#define SEC_NO_FLAGS   0x000
195 .
196 .  {* Tells the OS to allocate space for this section when loading.
197 .     This is clear for a section containing debug information only.  *}
198 .#define SEC_ALLOC      0x001
199 .
200 .  {* Tells the OS to load the section from the file when loading.
201 .     This is clear for a .bss section.  *}
202 .#define SEC_LOAD       0x002
203 .
204 .  {* The section contains data still to be relocated, so there is
205 .     some relocation information too.  *}
206 .#define SEC_RELOC      0x004
207 .
208 .  {* ELF reserves 4 processor specific bits and 8 operating system
209 .     specific bits in sh_flags; at present we can get away with just
210 .     one in communicating between the assembler and BFD, but this
211 .     isn't a good long-term solution.  *}
212 .#define SEC_ARCH_BIT_0 0x008
213 .
214 .  {* A signal to the OS that the section contains read only data.  *}
215 .#define SEC_READONLY   0x010
216 .
217 .  {* The section contains code only.  *}
218 .#define SEC_CODE       0x020
219 .
220 .  {* The section contains data only.  *}
221 .#define SEC_DATA       0x040
222 .
223 .  {* The section will reside in ROM.  *}
224 .#define SEC_ROM        0x080
225 .
226 .  {* The section contains constructor information. This section
227 .     type is used by the linker to create lists of constructors and
228 .     destructors used by <<g++>>. When a back end sees a symbol
229 .     which should be used in a constructor list, it creates a new
230 .     section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
231 .     the symbol to it, and builds a relocation. To build the lists
232 .     of constructors, all the linker has to do is catenate all the
233 .     sections called <<__CTOR_LIST__>> and relocate the data
234 .     contained within - exactly the operations it would peform on
235 .     standard data.  *}
236 .#define SEC_CONSTRUCTOR 0x100
237 .
238 .  {* The section is a constructor, and should be placed at the
239 .     end of the text, data, or bss section(?).  *}
240 .#define SEC_CONSTRUCTOR_TEXT 0x1100
241 .#define SEC_CONSTRUCTOR_DATA 0x2100
242 .#define SEC_CONSTRUCTOR_BSS  0x3100
243 .
244 .  {* The section has contents - a data section could be
245 .     <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
246 .     <<SEC_HAS_CONTENTS>>  *}
247 .#define SEC_HAS_CONTENTS 0x200
248 .
249 .  {* An instruction to the linker to not output the section
250 .     even if it has information which would normally be written.  *}
251 .#define SEC_NEVER_LOAD 0x400
252 .
253 .  {* The section is a COFF shared library section.  This flag is
254 .     only for the linker.  If this type of section appears in
255 .     the input file, the linker must copy it to the output file
256 .     without changing the vma or size.  FIXME: Although this
257 .     was originally intended to be general, it really is COFF
258 .     specific (and the flag was renamed to indicate this).  It
259 .     might be cleaner to have some more general mechanism to
260 .     allow the back end to control what the linker does with
261 .     sections.  *}
262 .#define SEC_COFF_SHARED_LIBRARY 0x800
263 .
264 .  {* The section has GOT references.  This flag is only for the
265 .     linker, and is currently only used by the elf32-hppa back end.
266 .     It will be set if global offset table references were detected
267 .     in this section, which indicate to the linker that the section
268 .     contains PIC code, and must be handled specially when doing a
269 .     static link.  *}
270 .#define SEC_HAS_GOT_REF 0x4000
271 .
272 .  {* The section contains common symbols (symbols may be defined
273 .     multiple times, the value of a symbol is the amount of
274 .     space it requires, and the largest symbol value is the one
275 .     used).  Most targets have exactly one of these (which we
276 .     translate to bfd_com_section_ptr), but ECOFF has two.  *}
277 .#define SEC_IS_COMMON 0x8000
278 .
279 .  {* The section contains only debugging information.  For
280 .     example, this is set for ELF .debug and .stab sections.
281 .     strip tests this flag to see if a section can be
282 .     discarded.  *}
283 .#define SEC_DEBUGGING 0x10000
284 .
285 .  {* The contents of this section are held in memory pointed to
286 .     by the contents field.  This is checked by bfd_get_section_contents,
287 .     and the data is retrieved from memory if appropriate.  *}
288 .#define SEC_IN_MEMORY 0x20000
289 .
290 .  {* The contents of this section are to be excluded by the
291 .     linker for executable and shared objects unless those
292 .     objects are to be further relocated.  *}
293 .#define SEC_EXCLUDE 0x40000
294 .
295 .  {* The contents of this section are to be sorted based on the sum of
296 .     the symbol and addend values specified by the associated relocation
297 .     entries.  Entries without associated relocation entries will be
298 .     appended to the end of the section in an unspecified order.  *}
299 .#define SEC_SORT_ENTRIES 0x80000
300 .
301 .  {* When linking, duplicate sections of the same name should be
302 .     discarded, rather than being combined into a single section as
303 .     is usually done.  This is similar to how common symbols are
304 .     handled.  See SEC_LINK_DUPLICATES below.  *}
305 .#define SEC_LINK_ONCE 0x100000
306 .
307 .  {* If SEC_LINK_ONCE is set, this bitfield describes how the linker
308 .     should handle duplicate sections.  *}
309 .#define SEC_LINK_DUPLICATES 0x600000
310 .
311 .  {* This value for SEC_LINK_DUPLICATES means that duplicate
312 .     sections with the same name should simply be discarded.  *}
313 .#define SEC_LINK_DUPLICATES_DISCARD 0x0
314 .
315 .  {* This value for SEC_LINK_DUPLICATES means that the linker
316 .     should warn if there are any duplicate sections, although
317 .     it should still only link one copy.  *}
318 .#define SEC_LINK_DUPLICATES_ONE_ONLY 0x200000
319 .
320 .  {* This value for SEC_LINK_DUPLICATES means that the linker
321 .     should warn if any duplicate sections are a different size.  *}
322 .#define SEC_LINK_DUPLICATES_SAME_SIZE 0x400000
323 .
324 .  {* This value for SEC_LINK_DUPLICATES means that the linker
325 .     should warn if any duplicate sections contain different
326 .     contents.  *}
327 .#define SEC_LINK_DUPLICATES_SAME_CONTENTS 0x600000
328 .
329 .  {* This section was created by the linker as part of dynamic
330 .     relocation or other arcane processing.  It is skipped when
331 .     going through the first-pass output, trusting that someone
332 .     else up the line will take care of it later.  *}
333 .#define SEC_LINKER_CREATED 0x800000
334 .
335 .  {* This section should not be subject to garbage collection.  *}
336 .#define SEC_KEEP 0x1000000
337 .
338 .  {* This section contains "short" data, and should be placed
339 .     "near" the GP.  *}
340 .#define SEC_SMALL_DATA 0x2000000
341 .
342 .  {* This section contains data which may be shared with other
343 .     executables or shared objects.  *}
344 .#define SEC_SHARED 0x4000000
345 .
346 .  {* When a section with this flag is being linked, then if the size of
347 .     the input section is less than a page, it should not cross a page
348 .     boundary.  If the size of the input section is one page or more, it
349 .     should be aligned on a page boundary.  *}
350 .#define SEC_BLOCK 0x8000000
351 .
352 .  {* Conditionally link this section; do not link if there are no
353 .     references found to any symbol in the section.  *}
354 .#define SEC_CLINK 0x10000000
355 .
356 .  {* Attempt to merge identical entities in the section.
357 .     Entity size is given in the entsize field.  *}
358 .#define SEC_MERGE 0x20000000
359 .
360 .  {* If given with SEC_MERGE, entities to merge are zero terminated
361 .     strings where entsize specifies character size instead of fixed
362 .     size entries.  *}
363 .#define SEC_STRINGS 0x40000000
364 .
365 .  {* This section contains data about section groups.  *}
366 .#define SEC_GROUP 0x80000000
367 .
368 .  {*  End of section flags.  *}
369 .
370 .  {* Some internal packed boolean fields.  *}
371 .
372 .  {* See the vma field.  *}
373 .  unsigned int user_set_vma : 1;
374 .
375 .  {* Whether relocations have been processed.  *}
376 .  unsigned int reloc_done : 1;
377 .
378 .  {* A mark flag used by some of the linker backends.  *}
379 .  unsigned int linker_mark : 1;
380 .
381 .  {* Another mark flag used by some of the linker backends.  Set for
382 .     output sections that have an input section.  *}
383 .  unsigned int linker_has_input : 1;
384 .
385 .  {* A mark flag used by some linker backends for garbage collection.  *}
386 .  unsigned int gc_mark : 1;
387 .
388 .  {* Used by the ELF code to mark sections which have been allocated
389 .     to segments.  *}
390 .  unsigned int segment_mark : 1;
391 .
392 .  {* End of internal packed boolean fields.  *}
393 .
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).  *}
400 .
401 .  bfd_vma vma;
402 .
403 .  {*  The load address of the section - where it would be in a
404 .      rom image; really only used for writing section header
405 .      information. *}
406 .
407 .  bfd_vma lma;
408 .
409 .  {* The size of the section in octets, as it will be output.
410 .     Contains a value even if the section has no contents (e.g., the
411 .     size of <<.bss>>).  This will be filled in after relocation.  *}
412 .
413 .  bfd_size_type _cooked_size;
414 .
415 .  {* The original size on disk of the section, in octets.  Normally this
416 .     value is the same as the size, but if some relaxing has
417 .     been done, then this value will be bigger.  *}
418 .
419 .  bfd_size_type _raw_size;
420 .
421 .  {* If this section is going to be output, then this value is the
422 .     offset in *bytes* into the output section of the first byte in the
423 .     input section (byte ==> smallest addressable unit on the
424 .     target).  In most cases, if this was going to start at the
425 .     100th octet (8-bit quantity) in the output section, this value
426 .     would be 100.  However, if the target byte size is 16 bits
427 .     (bfd_octets_per_byte is "2"), this value would be 50.  *}
428 .
429 .  bfd_vma output_offset;
430 .
431 .  {* The output section through which to map on output.  *}
432 .
433 .  struct sec *output_section;
434 .
435 .  {* The alignment requirement of the section, as an exponent of 2 -
436 .     e.g., 3 aligns to 2^3 (or 8).  *}
437 .
438 .  unsigned int alignment_power;
439 .
440 .  {* If an input section, a pointer to a vector of relocation
441 .     records for the data in this section.  *}
442 .
443 .  struct reloc_cache_entry *relocation;
444 .
445 .  {* If an output section, a pointer to a vector of pointers to
446 .     relocation records for the data in this section.  *}
447 .
448 .  struct reloc_cache_entry **orelocation;
449 .
450 .  {* The number of relocation records in one of the above  *}
451 .
452 .  unsigned reloc_count;
453 .
454 .  {* Information below is back end specific - and not always used
455 .     or updated.  *}
456 .
457 .  {* File position of section data.  *}
458 .
459 .  file_ptr filepos;
460 .
461 .  {* File position of relocation info.  *}
462 .
463 .  file_ptr rel_filepos;
464 .
465 .  {* File position of line data.  *}
466 .
467 .  file_ptr line_filepos;
468 .
469 .  {* Pointer to data for applications.  *}
470 .
471 .  PTR userdata;
472 .
473 .  {* If the SEC_IN_MEMORY flag is set, this points to the actual
474 .     contents.  *}
475 .  unsigned char *contents;
476 .
477 .  {* Attached line number information.  *}
478 .
479 .  alent *lineno;
480 .
481 .  {* Number of line number records.  *}
482 .
483 .  unsigned int lineno_count;
484 .
485 .  {* Entity size for merging purposes.  *}
486 .
487 .  unsigned int entsize;
488 .
489 .  {* Optional information about a COMDAT entry; NULL if not COMDAT.  *}
490 .
491 .  struct bfd_comdat_info *comdat;
492 .
493 .  {* When a section is being output, this value changes as more
494 .     linenumbers are written out.  *}
495 .
496 .  file_ptr moving_line_filepos;
497 .
498 .  {* What the section number is in the target world.  *}
499 .
500 .  int target_index;
501 .
502 .  PTR used_by_bfd;
503 .
504 .  {* If this is a constructor section then here is a list of the
505 .     relocations created to relocate items within it.  *}
506 .
507 .  struct relent_chain *constructor_chain;
508 .
509 .  {* The BFD which owns the section.  *}
510 .
511 .  bfd *owner;
512 .
513 .  {* A symbol which points at this section only *}
514 .  struct symbol_cache_entry *symbol;
515 .  struct symbol_cache_entry **symbol_ptr_ptr;
516 .
517 .  struct bfd_link_order *link_order_head;
518 .  struct bfd_link_order *link_order_tail;
519 .} asection ;
520 .
521 .{* These sections are global, and are managed by BFD.  The application
522 .   and target back end are not permitted to change the values in
523 .   these sections.  New code should use the section_ptr macros rather
524 .   than referring directly to the const sections.  The const sections
525 .   may eventually vanish.  *}
526 .#define BFD_ABS_SECTION_NAME "*ABS*"
527 .#define BFD_UND_SECTION_NAME "*UND*"
528 .#define BFD_COM_SECTION_NAME "*COM*"
529 .#define BFD_IND_SECTION_NAME "*IND*"
530 .
531 .{* the absolute section *}
532 .extern const asection bfd_abs_section;
533 .#define bfd_abs_section_ptr ((asection *) &bfd_abs_section)
534 .#define bfd_is_abs_section(sec) ((sec) == bfd_abs_section_ptr)
535 .{* Pointer to the undefined section *}
536 .extern const asection bfd_und_section;
537 .#define bfd_und_section_ptr ((asection *) &bfd_und_section)
538 .#define bfd_is_und_section(sec) ((sec) == bfd_und_section_ptr)
539 .{* Pointer to the common section *}
540 .extern const asection bfd_com_section;
541 .#define bfd_com_section_ptr ((asection *) &bfd_com_section)
542 .{* Pointer to the indirect section *}
543 .extern const asection bfd_ind_section;
544 .#define bfd_ind_section_ptr ((asection *) &bfd_ind_section)
545 .#define bfd_is_ind_section(sec) ((sec) == bfd_ind_section_ptr)
546 .
547 .#define bfd_is_const_section(SEC)              \
548 . (   ((SEC) == bfd_abs_section_ptr)            \
549 .  || ((SEC) == bfd_und_section_ptr)            \
550 .  || ((SEC) == bfd_com_section_ptr)            \
551 .  || ((SEC) == bfd_ind_section_ptr))
552 .
553 .extern const struct symbol_cache_entry * const bfd_abs_symbol;
554 .extern const struct symbol_cache_entry * const bfd_com_symbol;
555 .extern const struct symbol_cache_entry * const bfd_und_symbol;
556 .extern const struct symbol_cache_entry * const bfd_ind_symbol;
557 .#define bfd_get_section_size_before_reloc(section) \
558 .     ((section)->reloc_done ? (abort (), (bfd_size_type) 1) \
559 .                            : (section)->_raw_size)
560 .#define bfd_get_section_size_after_reloc(section) \
561 .     ((section)->reloc_done ? (section)->_cooked_size \
562 .                            : (abort (), (bfd_size_type) 1))
563 */
564
565 /* We use a macro to initialize the static asymbol structures because
566    traditional C does not permit us to initialize a union member while
567    gcc warns if we don't initialize it.  */
568  /* the_bfd, name, value, attr, section [, udata] */
569 #ifdef __STDC__
570 #define GLOBAL_SYM_INIT(NAME, SECTION) \
571   { 0, NAME, 0, BSF_SECTION_SYM, (asection *) SECTION, { 0 }}
572 #else
573 #define GLOBAL_SYM_INIT(NAME, SECTION) \
574   { 0, NAME, 0, BSF_SECTION_SYM, (asection *) SECTION }
575 #endif
576
577 /* These symbols are global, not specific to any BFD.  Therefore, anything
578    that tries to change them is broken, and should be repaired.  */
579
580 static const asymbol global_syms[] =
581 {
582   GLOBAL_SYM_INIT (BFD_COM_SECTION_NAME, &bfd_com_section),
583   GLOBAL_SYM_INIT (BFD_UND_SECTION_NAME, &bfd_und_section),
584   GLOBAL_SYM_INIT (BFD_ABS_SECTION_NAME, &bfd_abs_section),
585   GLOBAL_SYM_INIT (BFD_IND_SECTION_NAME, &bfd_ind_section)
586 };
587
588 #define STD_SECTION(SEC, FLAGS, SYM, NAME, IDX)                         \
589   const asymbol * const SYM = (asymbol *) &global_syms[IDX];            \
590   const asection SEC =                                                  \
591     /* name, id,  index, next, flags, user_set_vma, reloc_done,      */ \
592     { NAME,  IDX, 0,     NULL, FLAGS, 0,            0,                  \
593                                                                         \
594     /* linker_mark, linker_has_input, gc_mark, segment_mark,         */ \
595        0,           0,                1,       0,                       \
596                                                                         \
597     /* vma, lma, _cooked_size, _raw_size,                            */ \
598        0,   0,   0,            0,                                       \
599                                                                         \
600     /* output_offset, output_section,      alignment_power,          */ \
601        0,             (struct sec *) &SEC, 0,                           \
602                                                                         \
603     /* relocation, orelocation, reloc_count, filepos, rel_filepos,   */ \
604        NULL,       NULL,        0,           0,       0,                \
605                                                                         \
606     /* line_filepos, userdata, contents, lineno, lineno_count,       */ \
607        0,            NULL,     NULL,     NULL,   0,                     \
608                                                                         \
609     /* entsize, comdat, moving_line_filepos,                         */ \
610        0,       NULL,   0,                                              \
611                                                                         \
612     /* target_index, used_by_bfd, constructor_chain, owner,          */ \
613        0,            NULL,        NULL,              NULL,              \
614                                                                         \
615     /* symbol,                                                       */ \
616        (struct symbol_cache_entry *) &global_syms[IDX],                 \
617                                                                         \
618     /* symbol_ptr_ptr,                                               */ \
619        (struct symbol_cache_entry **) &SYM,                             \
620                                                                         \
621     /* link_order_head, link_order_tail                              */ \
622        NULL,            NULL                                            \
623     }
624
625 STD_SECTION (bfd_com_section, SEC_IS_COMMON, bfd_com_symbol,
626              BFD_COM_SECTION_NAME, 0);
627 STD_SECTION (bfd_und_section, 0, bfd_und_symbol, BFD_UND_SECTION_NAME, 1);
628 STD_SECTION (bfd_abs_section, 0, bfd_abs_symbol, BFD_ABS_SECTION_NAME, 2);
629 STD_SECTION (bfd_ind_section, 0, bfd_ind_symbol, BFD_IND_SECTION_NAME, 3);
630 #undef STD_SECTION
631
632 struct section_hash_entry
633 {
634   struct bfd_hash_entry root;
635   asection section;
636 };
637
638 /* Initialize an entry in the section hash table.  */
639
640 struct bfd_hash_entry *
641 bfd_section_hash_newfunc (entry, table, string)
642      struct bfd_hash_entry *entry;
643      struct bfd_hash_table *table;
644      const char *string;
645 {
646   /* Allocate the structure if it has not already been allocated by a
647      subclass.  */
648   if (entry == NULL)
649     {
650       entry = bfd_hash_allocate (table, sizeof (struct section_hash_entry));
651       if (entry == NULL)
652         return entry;
653     }
654
655   /* Call the allocation method of the superclass.  */
656   entry = bfd_hash_newfunc (entry, table, string);
657   if (entry != NULL)
658     {
659       memset ((PTR) &((struct section_hash_entry *) entry)->section,
660               0, sizeof (asection));
661     }
662
663   return entry;
664 }
665
666 #define section_hash_lookup(table, string, create, copy) \
667   ((struct section_hash_entry *) \
668    bfd_hash_lookup ((table), (string), (create), (copy)))
669
670 /* Initializes a new section.  NEWSECT->NAME is already set.  */
671
672 static asection *bfd_section_init PARAMS ((bfd *, asection *));
673
674 static asection *
675 bfd_section_init (abfd, newsect)
676      bfd *abfd;
677      asection *newsect;
678 {
679   static int section_id = 0x10;  /* id 0 to 3 used by STD_SECTION.  */
680
681   newsect->id = section_id;
682   newsect->index = abfd->section_count;
683   newsect->flags = SEC_NO_FLAGS;
684
685   newsect->userdata = NULL;
686   newsect->contents = NULL;
687   newsect->next = (asection *) NULL;
688   newsect->relocation = (arelent *) NULL;
689   newsect->reloc_count = 0;
690   newsect->line_filepos = 0;
691   newsect->owner = abfd;
692   newsect->comdat = NULL;
693
694   /* Create a symbol whose only job is to point to this section.  This
695      is useful for things like relocs which are relative to the base
696      of a section.  */
697   newsect->symbol = bfd_make_empty_symbol (abfd);
698   if (newsect->symbol == NULL)
699     return NULL;
700
701   newsect->symbol->name = newsect->name;
702   newsect->symbol->value = 0;
703   newsect->symbol->section = newsect;
704   newsect->symbol->flags = BSF_SECTION_SYM;
705
706   newsect->symbol_ptr_ptr = &newsect->symbol;
707
708   if (! BFD_SEND (abfd, _new_section_hook, (abfd, newsect)))
709     return NULL;
710
711   section_id++;
712   abfd->section_count++;
713   *abfd->section_tail = newsect;
714   abfd->section_tail = &newsect->next;
715   return newsect;
716 }
717
718 /*
719 DOCDD
720 INODE
721 section prototypes,  , typedef asection, Sections
722 SUBSECTION
723         Section prototypes
724
725 These are the functions exported by the section handling part of BFD.
726 */
727
728 /*
729 FUNCTION
730         bfd_get_section_by_name
731
732 SYNOPSIS
733         asection *bfd_get_section_by_name(bfd *abfd, const char *name);
734
735 DESCRIPTION
736         Run through @var{abfd} and return the one of the
737         <<asection>>s whose name matches @var{name}, otherwise <<NULL>>.
738         @xref{Sections}, for more information.
739
740         This should only be used in special cases; the normal way to process
741         all sections of a given name is to use <<bfd_map_over_sections>> and
742         <<strcmp>> on the name (or better yet, base it on the section flags
743         or something else) for each section.
744 */
745
746 asection *
747 bfd_get_section_by_name (abfd, name)
748      bfd *abfd;
749      const char *name;
750 {
751   struct section_hash_entry *sh;
752
753   sh = section_hash_lookup (&abfd->section_htab, name, false, false);
754   if (sh != NULL)
755     return &sh->section;
756
757   return NULL;
758 }
759
760 /*
761 FUNCTION
762         bfd_get_unique_section_name
763
764 SYNOPSIS
765         char *bfd_get_unique_section_name(bfd *abfd,
766                                           const char *templat,
767                                           int *count);
768
769 DESCRIPTION
770         Invent a section name that is unique in @var{abfd} by tacking
771         a dot and a digit suffix onto the original @var{templat}.  If
772         @var{count} is non-NULL, then it specifies the first number
773         tried as a suffix to generate a unique name.  The value
774         pointed to by @var{count} will be incremented in this case.
775 */
776
777 char *
778 bfd_get_unique_section_name (abfd, templat, count)
779      bfd *abfd;
780      const char *templat;
781      int *count;
782 {
783   int num;
784   unsigned int len;
785   char *sname;
786
787   len = strlen (templat);
788   sname = bfd_malloc ((bfd_size_type) len + 8);
789   if (sname == NULL)
790     return NULL;
791   strcpy (sname, templat);
792   num = 1;
793   if (count != NULL)
794     num = *count;
795
796   do
797     {
798       /* If we have a million sections, something is badly wrong.  */
799       if (num > 999999)
800         abort ();
801       sprintf (sname + len, ".%d", num++);
802     }
803   while (section_hash_lookup (&abfd->section_htab, sname, false, false));
804
805   if (count != NULL)
806     *count = num;
807   return sname;
808 }
809
810 /*
811 FUNCTION
812         bfd_make_section_old_way
813
814 SYNOPSIS
815         asection *bfd_make_section_old_way(bfd *abfd, const char *name);
816
817 DESCRIPTION
818         Create a new empty section called @var{name}
819         and attach it to the end of the chain of sections for the
820         BFD @var{abfd}. An attempt to create a section with a name which
821         is already in use returns its pointer without changing the
822         section chain.
823
824         It has the funny name since this is the way it used to be
825         before it was rewritten....
826
827         Possible errors are:
828         o <<bfd_error_invalid_operation>> -
829         If output has already started for this BFD.
830         o <<bfd_error_no_memory>> -
831         If memory allocation fails.
832
833 */
834
835 asection *
836 bfd_make_section_old_way (abfd, name)
837      bfd *abfd;
838      const char *name;
839 {
840   struct section_hash_entry *sh;
841   asection *newsect;
842
843   if (abfd->output_has_begun)
844     {
845       bfd_set_error (bfd_error_invalid_operation);
846       return NULL;
847     }
848
849   if (strcmp (name, BFD_ABS_SECTION_NAME) == 0)
850     return bfd_abs_section_ptr;
851
852   if (strcmp (name, BFD_COM_SECTION_NAME) == 0)
853     return bfd_com_section_ptr;
854
855   if (strcmp (name, BFD_UND_SECTION_NAME) == 0)
856     return bfd_und_section_ptr;
857
858   if (strcmp (name, BFD_IND_SECTION_NAME) == 0)
859     return bfd_ind_section_ptr;
860
861   sh = section_hash_lookup (&abfd->section_htab, name, true, false);
862   if (sh == NULL)
863     return NULL;
864
865   newsect = &sh->section;
866   if (newsect->name != NULL)
867     {
868       /* Section already exists.  */
869       return newsect;
870     }
871
872   newsect->name = name;
873   return bfd_section_init (abfd, newsect);
874 }
875
876 /*
877 FUNCTION
878         bfd_make_section_anyway
879
880 SYNOPSIS
881         asection *bfd_make_section_anyway(bfd *abfd, const char *name);
882
883 DESCRIPTION
884    Create a new empty section called @var{name} and attach it to the end of
885    the chain of sections for @var{abfd}.  Create a new section even if there
886    is already a section with that name.
887
888    Return <<NULL>> and set <<bfd_error>> on error; possible errors are:
889    o <<bfd_error_invalid_operation>> - If output has already started for @var{abfd}.
890    o <<bfd_error_no_memory>> - If memory allocation fails.
891 */
892
893 sec_ptr
894 bfd_make_section_anyway (abfd, name)
895      bfd *abfd;
896      const char *name;
897 {
898   struct section_hash_entry *sh;
899   asection *newsect;
900
901   if (abfd->output_has_begun)
902     {
903       bfd_set_error (bfd_error_invalid_operation);
904       return NULL;
905     }
906
907   sh = section_hash_lookup (&abfd->section_htab, name, true, false);
908   if (sh == NULL)
909     return NULL;
910
911   newsect = &sh->section;
912   if (newsect->name != NULL)
913     {
914       /* We are making a section of the same name.  It can't go in
915          section_htab without generating a unique section name and
916          that would be pointless;  We don't need to traverse the
917          hash table.  */
918       newsect = (asection *) bfd_zalloc (abfd, sizeof (asection));
919       if (newsect == NULL)
920         return NULL;
921     }
922
923   newsect->name = name;
924   return bfd_section_init (abfd, newsect);
925 }
926
927 /*
928 FUNCTION
929         bfd_make_section
930
931 SYNOPSIS
932         asection *bfd_make_section(bfd *, const char *name);
933
934 DESCRIPTION
935    Like <<bfd_make_section_anyway>>, but return <<NULL>> (without calling
936    bfd_set_error ()) without changing the section chain if there is already a
937    section named @var{name}.  If there is an error, return <<NULL>> and set
938    <<bfd_error>>.
939 */
940
941 asection *
942 bfd_make_section (abfd, name)
943      bfd *abfd;
944      const char *name;
945 {
946   struct section_hash_entry *sh;
947   asection *newsect;
948
949   if (abfd->output_has_begun)
950     {
951       bfd_set_error (bfd_error_invalid_operation);
952       return NULL;
953     }
954
955   if (strcmp (name, BFD_ABS_SECTION_NAME) == 0
956       || strcmp (name, BFD_COM_SECTION_NAME) == 0
957       || strcmp (name, BFD_UND_SECTION_NAME) == 0
958       || strcmp (name, BFD_IND_SECTION_NAME) == 0)
959     return NULL;
960
961   sh = section_hash_lookup (&abfd->section_htab, name, true, false);
962   if (sh == NULL)
963     return NULL;
964
965   newsect = &sh->section;
966   if (newsect->name != NULL)
967     {
968       /* Section already exists.  */
969       return newsect;
970     }
971
972   newsect->name = name;
973   return bfd_section_init (abfd, newsect);
974 }
975
976 /*
977 FUNCTION
978         bfd_set_section_flags
979
980 SYNOPSIS
981         boolean bfd_set_section_flags(bfd *abfd, asection *sec, flagword flags);
982
983 DESCRIPTION
984         Set the attributes of the section @var{sec} in the BFD
985         @var{abfd} to the value @var{flags}. Return <<true>> on success,
986         <<false>> on error. Possible error returns are:
987
988         o <<bfd_error_invalid_operation>> -
989         The section cannot have one or more of the attributes
990         requested. For example, a .bss section in <<a.out>> may not
991         have the <<SEC_HAS_CONTENTS>> field set.
992
993 */
994
995 /*ARGSUSED*/
996 boolean
997 bfd_set_section_flags (abfd, section, flags)
998      bfd *abfd ATTRIBUTE_UNUSED;
999      sec_ptr section;
1000      flagword flags;
1001 {
1002 #if 0
1003   /* If you try to copy a text section from an input file (where it
1004      has the SEC_CODE flag set) to an output file, this loses big if
1005      the bfd_applicable_section_flags (abfd) doesn't have the SEC_CODE
1006      set - which it doesn't, at least not for a.out.  FIXME */
1007
1008   if ((flags & bfd_applicable_section_flags (abfd)) != flags)
1009     {
1010       bfd_set_error (bfd_error_invalid_operation);
1011       return false;
1012     }
1013 #endif
1014
1015   section->flags = flags;
1016   return true;
1017 }
1018
1019 /*
1020 FUNCTION
1021         bfd_map_over_sections
1022
1023 SYNOPSIS
1024         void bfd_map_over_sections(bfd *abfd,
1025                                    void (*func) (bfd *abfd,
1026                                                 asection *sect,
1027                                                 PTR obj),
1028                                    PTR obj);
1029
1030 DESCRIPTION
1031         Call the provided function @var{func} for each section
1032         attached to the BFD @var{abfd}, passing @var{obj} as an
1033         argument. The function will be called as if by
1034
1035 |       func(abfd, the_section, obj);
1036
1037         This is the prefered method for iterating over sections; an
1038         alternative would be to use a loop:
1039
1040 |          section *p;
1041 |          for (p = abfd->sections; p != NULL; p = p->next)
1042 |             func(abfd, p, ...)
1043
1044 */
1045
1046 /*VARARGS2*/
1047 void
1048 bfd_map_over_sections (abfd, operation, user_storage)
1049      bfd *abfd;
1050      void (*operation) PARAMS ((bfd * abfd, asection * sect, PTR obj));
1051      PTR user_storage;
1052 {
1053   asection *sect;
1054   unsigned int i = 0;
1055
1056   for (sect = abfd->sections; sect != NULL; i++, sect = sect->next)
1057     (*operation) (abfd, sect, user_storage);
1058
1059   if (i != abfd->section_count) /* Debugging */
1060     abort ();
1061 }
1062
1063 /*
1064 FUNCTION
1065         bfd_set_section_size
1066
1067 SYNOPSIS
1068         boolean bfd_set_section_size(bfd *abfd, asection *sec, bfd_size_type val);
1069
1070 DESCRIPTION
1071         Set @var{sec} to the size @var{val}. If the operation is
1072         ok, then <<true>> is returned, else <<false>>.
1073
1074         Possible error returns:
1075         o <<bfd_error_invalid_operation>> -
1076         Writing has started to the BFD, so setting the size is invalid.
1077
1078 */
1079
1080 boolean
1081 bfd_set_section_size (abfd, ptr, val)
1082      bfd *abfd;
1083      sec_ptr ptr;
1084      bfd_size_type val;
1085 {
1086   /* Once you've started writing to any section you cannot create or change
1087      the size of any others.  */
1088
1089   if (abfd->output_has_begun)
1090     {
1091       bfd_set_error (bfd_error_invalid_operation);
1092       return false;
1093     }
1094
1095   ptr->_cooked_size = val;
1096   ptr->_raw_size = val;
1097
1098   return true;
1099 }
1100
1101 /*
1102 FUNCTION
1103         bfd_set_section_contents
1104
1105 SYNOPSIS
1106         boolean bfd_set_section_contents (bfd *abfd, asection *section,
1107                                           PTR data, file_ptr offset,
1108                                           bfd_size_type count);
1109
1110 DESCRIPTION
1111         Sets the contents of the section @var{section} in BFD
1112         @var{abfd} to the data starting in memory at @var{data}. The
1113         data is written to the output section starting at offset
1114         @var{offset} for @var{count} octets.
1115
1116         Normally <<true>> is returned, else <<false>>. Possible error
1117         returns are:
1118         o <<bfd_error_no_contents>> -
1119         The output section does not have the <<SEC_HAS_CONTENTS>>
1120         attribute, so nothing can be written to it.
1121         o and some more too
1122
1123         This routine is front end to the back end function
1124         <<_bfd_set_section_contents>>.
1125
1126 */
1127
1128 #define bfd_get_section_size_now(abfd,sec) \
1129 (sec->reloc_done \
1130  ? bfd_get_section_size_after_reloc (sec) \
1131  : bfd_get_section_size_before_reloc (sec))
1132
1133 boolean
1134 bfd_set_section_contents (abfd, section, location, offset, count)
1135      bfd *abfd;
1136      sec_ptr section;
1137      PTR location;
1138      file_ptr offset;
1139      bfd_size_type count;
1140 {
1141   bfd_size_type sz;
1142
1143   if (!(bfd_get_section_flags (abfd, section) & SEC_HAS_CONTENTS))
1144     {
1145       bfd_set_error (bfd_error_no_contents);
1146       return (false);
1147     }
1148
1149   sz = bfd_get_section_size_now (abfd, section);
1150   if ((bfd_size_type) offset > sz
1151       || count > sz
1152       || offset + count > sz
1153       || count != (size_t) count)
1154     {
1155       bfd_set_error (bfd_error_bad_value);
1156       return false;
1157     }
1158
1159   switch (abfd->direction)
1160     {
1161     case read_direction:
1162     case no_direction:
1163       bfd_set_error (bfd_error_invalid_operation);
1164       return false;
1165
1166     case write_direction:
1167       break;
1168
1169     case both_direction:
1170       /* File is opened for update. `output_has_begun' some time ago when
1171            the file was created.  Do not recompute sections sizes or alignments
1172            in _bfd_set_section_content.  */
1173       abfd->output_has_begun = true;
1174       break;
1175     }
1176
1177   /* Record a copy of the data in memory if desired.  */
1178   if (section->contents
1179       && location != section->contents + offset)
1180     memcpy (section->contents + offset, location, (size_t) count);
1181
1182   if (BFD_SEND (abfd, _bfd_set_section_contents,
1183                 (abfd, section, location, offset, count)))
1184     {
1185       abfd->output_has_begun = true;
1186       return true;
1187     }
1188
1189   return false;
1190 }
1191
1192 /*
1193 FUNCTION
1194         bfd_get_section_contents
1195
1196 SYNOPSIS
1197         boolean bfd_get_section_contents (bfd *abfd, asection *section,
1198                                           PTR location, file_ptr offset,
1199                                           bfd_size_type count);
1200
1201 DESCRIPTION
1202         Read data from @var{section} in BFD @var{abfd}
1203         into memory starting at @var{location}. The data is read at an
1204         offset of @var{offset} from the start of the input section,
1205         and is read for @var{count} bytes.
1206
1207         If the contents of a constructor with the <<SEC_CONSTRUCTOR>>
1208         flag set are requested or if the section does not have the
1209         <<SEC_HAS_CONTENTS>> flag set, then the @var{location} is filled
1210         with zeroes. If no errors occur, <<true>> is returned, else
1211         <<false>>.
1212
1213 */
1214 boolean
1215 bfd_get_section_contents (abfd, section, location, offset, count)
1216      bfd *abfd;
1217      sec_ptr section;
1218      PTR location;
1219      file_ptr offset;
1220      bfd_size_type count;
1221 {
1222   bfd_size_type sz;
1223
1224   if (section->flags & SEC_CONSTRUCTOR)
1225     {
1226       memset (location, 0, (size_t) count);
1227       return true;
1228     }
1229
1230   /* Even if reloc_done is true, this function reads unrelocated
1231      contents, so we want the raw size.  */
1232   sz = section->_raw_size;
1233   if ((bfd_size_type) offset > sz
1234       || count > sz
1235       || offset + count > sz
1236       || count != (size_t) count)
1237     {
1238       bfd_set_error (bfd_error_bad_value);
1239       return false;
1240     }
1241
1242   if (count == 0)
1243     /* Don't bother.  */
1244     return true;
1245
1246   if ((section->flags & SEC_HAS_CONTENTS) == 0)
1247     {
1248       memset (location, 0, (size_t) count);
1249       return true;
1250     }
1251
1252   if ((section->flags & SEC_IN_MEMORY) != 0)
1253     {
1254       memcpy (location, section->contents + offset, (size_t) count);
1255       return true;
1256     }
1257
1258   return BFD_SEND (abfd, _bfd_get_section_contents,
1259                    (abfd, section, location, offset, count));
1260 }
1261
1262 /*
1263 FUNCTION
1264         bfd_copy_private_section_data
1265
1266 SYNOPSIS
1267         boolean bfd_copy_private_section_data (bfd *ibfd, asection *isec,
1268                                                bfd *obfd, asection *osec);
1269
1270 DESCRIPTION
1271         Copy private section information from @var{isec} in the BFD
1272         @var{ibfd} to the section @var{osec} in the BFD @var{obfd}.
1273         Return <<true>> on success, <<false>> on error.  Possible error
1274         returns are:
1275
1276         o <<bfd_error_no_memory>> -
1277         Not enough memory exists to create private data for @var{osec}.
1278
1279 .#define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1280 .     BFD_SEND (obfd, _bfd_copy_private_section_data, \
1281 .               (ibfd, isection, obfd, osection))
1282 */
1283
1284 /*
1285 FUNCTION
1286         _bfd_strip_section_from_output
1287
1288 SYNOPSIS
1289         void _bfd_strip_section_from_output
1290         (struct bfd_link_info *info, asection *section);
1291
1292 DESCRIPTION
1293         Remove @var{section} from the output.  If the output section
1294         becomes empty, remove it from the output bfd.  @var{info} may
1295         be NULL; if it is not, it is used to decide whether the output
1296         section is empty.
1297 */
1298 void
1299 _bfd_strip_section_from_output (info, s)
1300      struct bfd_link_info *info;
1301      asection *s;
1302 {
1303   asection **spp, *os;
1304   struct bfd_link_order *p, *pp;
1305   boolean keep_os;
1306
1307   /* Excise the input section from the link order.
1308
1309      FIXME: For all calls that I can see to this function, the link
1310      orders have not yet been set up.  So why are we checking them? --
1311      Ian */
1312   os = s->output_section;
1313
1314   /* Handle a section that wasn't output.  */
1315   if (os == NULL)
1316     return;
1317
1318   for (p = os->link_order_head, pp = NULL; p != NULL; pp = p, p = p->next)
1319     if (p->type == bfd_indirect_link_order
1320         && p->u.indirect.section == s)
1321       {
1322         if (pp)
1323           pp->next = p->next;
1324         else
1325           os->link_order_head = p->next;
1326         if (!p->next)
1327           os->link_order_tail = pp;
1328         break;
1329       }
1330
1331   keep_os = os->link_order_head != NULL;
1332
1333   if (! keep_os && info != NULL)
1334     {
1335       bfd *abfd;
1336       for (abfd = info->input_bfds; abfd != NULL; abfd = abfd->link_next)
1337         {
1338           asection *is;
1339           for (is = abfd->sections; is != NULL; is = is->next)
1340             {
1341               if (is != s && is->output_section == os
1342                   && (is->flags & SEC_EXCLUDE) == 0)
1343                 break;
1344             }
1345           if (is != NULL)
1346             break;
1347         }
1348       if (abfd != NULL)
1349         keep_os = true;
1350     }
1351
1352   /* If the output section is empty, remove it too.  Careful about sections
1353      that have been discarded in the link script -- they are mapped to
1354      bfd_abs_section, which has no owner.  */
1355   if (!keep_os && os->owner != NULL)
1356     {
1357       for (spp = &os->owner->sections; *spp; spp = &(*spp)->next)
1358         if (*spp == os)
1359           {
1360             *spp = os->next;
1361             if (os->next == NULL)
1362               os->owner->section_tail = spp;
1363             os->owner->section_count--;
1364             break;
1365           }
1366     }
1367
1368   s->flags |= SEC_EXCLUDE;
1369 }