Add --compress-debug-sections=[none|zlib|zlib-gnu|zlib-gabi]
[external/binutils.git] / bfd / section.c
1 /* Object file "section" support for the BFD library.
2    Copyright (C) 1990-2015 Free Software Foundation, Inc.
3    Written by Cygnus Support.
4
5    This file is part of BFD, the Binary File Descriptor library.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20    MA 02110-1301, USA.  */
21
22 /*
23 SECTION
24         Sections
25
26         The raw data contained within a BFD is maintained through the
27         section abstraction.  A single BFD may have any number of
28         sections.  It keeps hold of them by pointing to the first;
29         each one points to the next in the list.
30
31         Sections are supported in BFD in <<section.c>>.
32
33 @menu
34 @* Section Input::
35 @* Section Output::
36 @* typedef asection::
37 @* section prototypes::
38 @end menu
39
40 INODE
41 Section Input, Section Output, Sections, Sections
42 SUBSECTION
43         Section input
44
45         When a BFD is opened for reading, the section structures are
46         created and attached to the BFD.
47
48         Each section has a name which describes the section in the
49         outside world---for example, <<a.out>> would contain at least
50         three sections, called <<.text>>, <<.data>> and <<.bss>>.
51
52         Names need not be unique; for example a COFF file may have several
53         sections named <<.data>>.
54
55         Sometimes a BFD will contain more than the ``natural'' number of
56         sections. A back end may attach other sections containing
57         constructor data, or an application may add a section (using
58         <<bfd_make_section>>) to the sections attached to an already open
59         BFD. For example, the linker creates an extra section
60         <<COMMON>> for each input file's BFD to hold information about
61         common storage.
62
63         The raw data is not necessarily read in when
64         the section descriptor is created. Some targets may leave the
65         data in place until a <<bfd_get_section_contents>> call is
66         made. Other back ends may read in all the data at once.  For
67         example, an S-record file has to be read once to determine the
68         size of the data. An IEEE-695 file doesn't contain raw data in
69         sections, but data and relocation expressions intermixed, so
70         the data area has to be parsed to get out the data and
71         relocations.
72
73 INODE
74 Section Output, typedef asection, Section Input, Sections
75
76 SUBSECTION
77         Section output
78
79         To write a new object style BFD, the various sections to be
80         written have to be created. They are attached to the BFD in
81         the same way as input sections; data is written to the
82         sections using <<bfd_set_section_contents>>.
83
84         Any program that creates or combines sections (e.g., the assembler
85         and linker) must use the <<asection>> fields <<output_section>> and
86         <<output_offset>> to indicate the file sections to which each
87         section must be written.  (If the section is being created from
88         scratch, <<output_section>> should probably point to the section
89         itself and <<output_offset>> should probably be zero.)
90
91         The data to be written comes from input sections attached
92         (via <<output_section>> pointers) to
93         the output sections.  The output section structure can be
94         considered a filter for the input section: the output section
95         determines the vma of the output data and the name, but the
96         input section determines the offset into the output section of
97         the data to be written.
98
99         E.g., to create a section "O", starting at 0x100, 0x123 long,
100         containing two subsections, "A" at offset 0x0 (i.e., at vma
101         0x100) and "B" at offset 0x20 (i.e., at vma 0x120) the <<asection>>
102         structures would look like:
103
104 |   section name          "A"
105 |     output_offset   0x00
106 |     size            0x20
107 |     output_section ----------->  section name    "O"
108 |                             |    vma             0x100
109 |   section name          "B" |    size            0x123
110 |     output_offset   0x20    |
111 |     size            0x103   |
112 |     output_section  --------|
113
114 SUBSECTION
115         Link orders
116
117         The data within a section is stored in a @dfn{link_order}.
118         These are much like the fixups in <<gas>>.  The link_order
119         abstraction allows a section to grow and shrink within itself.
120
121         A link_order knows how big it is, and which is the next
122         link_order and where the raw data for it is; it also points to
123         a list of relocations which apply to it.
124
125         The link_order is used by the linker to perform relaxing on
126         final code.  The compiler creates code which is as big as
127         necessary to make it work without relaxing, and the user can
128         select whether to relax.  Sometimes relaxing takes a lot of
129         time.  The linker runs around the relocations to see if any
130         are attached to data which can be shrunk, if so it does it on
131         a link_order by link_order basis.
132
133 */
134
135 #include "sysdep.h"
136 #include "bfd.h"
137 #include "libbfd.h"
138 #include "bfdlink.h"
139
140 /*
141 DOCDD
142 INODE
143 typedef asection, section prototypes, Section Output, Sections
144 SUBSECTION
145         typedef asection
146
147         Here is the section structure:
148
149 CODE_FRAGMENT
150 .
151 .typedef struct bfd_section
152 .{
153 .  {* The name of the section; the name isn't a copy, the pointer is
154 .     the same as that passed to bfd_make_section.  *}
155 .  const char *name;
156 .
157 .  {* A unique sequence number.  *}
158 .  int id;
159 .
160 .  {* Which section in the bfd; 0..n-1 as sections are created in a bfd.  *}
161 .  int index;
162 .
163 .  {* The next section in the list belonging to the BFD, or NULL.  *}
164 .  struct bfd_section *next;
165 .
166 .  {* The previous section in the list belonging to the BFD, or NULL.  *}
167 .  struct bfd_section *prev;
168 .
169 .  {* The field flags contains attributes of the section. Some
170 .     flags are read in from the object file, and some are
171 .     synthesized from other information.  *}
172 .  flagword flags;
173 .
174 .#define SEC_NO_FLAGS   0x000
175 .
176 .  {* Tells the OS to allocate space for this section when loading.
177 .     This is clear for a section containing debug information only.  *}
178 .#define SEC_ALLOC      0x001
179 .
180 .  {* Tells the OS to load the section from the file when loading.
181 .     This is clear for a .bss section.  *}
182 .#define SEC_LOAD       0x002
183 .
184 .  {* The section contains data still to be relocated, so there is
185 .     some relocation information too.  *}
186 .#define SEC_RELOC      0x004
187 .
188 .  {* A signal to the OS that the section contains read only data.  *}
189 .#define SEC_READONLY   0x008
190 .
191 .  {* The section contains code only.  *}
192 .#define SEC_CODE       0x010
193 .
194 .  {* The section contains data only.  *}
195 .#define SEC_DATA       0x020
196 .
197 .  {* The section will reside in ROM.  *}
198 .#define SEC_ROM        0x040
199 .
200 .  {* The section contains constructor information. This section
201 .     type is used by the linker to create lists of constructors and
202 .     destructors used by <<g++>>. When a back end sees a symbol
203 .     which should be used in a constructor list, it creates a new
204 .     section for the type of name (e.g., <<__CTOR_LIST__>>), attaches
205 .     the symbol to it, and builds a relocation. To build the lists
206 .     of constructors, all the linker has to do is catenate all the
207 .     sections called <<__CTOR_LIST__>> and relocate the data
208 .     contained within - exactly the operations it would peform on
209 .     standard data.  *}
210 .#define SEC_CONSTRUCTOR 0x080
211 .
212 .  {* The section has contents - a data section could be
213 .     <<SEC_ALLOC>> | <<SEC_HAS_CONTENTS>>; a debug section could be
214 .     <<SEC_HAS_CONTENTS>>  *}
215 .#define SEC_HAS_CONTENTS 0x100
216 .
217 .  {* An instruction to the linker to not output the section
218 .     even if it has information which would normally be written.  *}
219 .#define SEC_NEVER_LOAD 0x200
220 .
221 .  {* The section contains thread local data.  *}
222 .#define SEC_THREAD_LOCAL 0x400
223 .
224 .  {* The section has GOT references.  This flag is only for the
225 .     linker, and is currently only used by the elf32-hppa back end.
226 .     It will be set if global offset table references were detected
227 .     in this section, which indicate to the linker that the section
228 .     contains PIC code, and must be handled specially when doing a
229 .     static link.  *}
230 .#define SEC_HAS_GOT_REF 0x800
231 .
232 .  {* The section contains common symbols (symbols may be defined
233 .     multiple times, the value of a symbol is the amount of
234 .     space it requires, and the largest symbol value is the one
235 .     used).  Most targets have exactly one of these (which we
236 .     translate to bfd_com_section_ptr), but ECOFF has two.  *}
237 .#define SEC_IS_COMMON 0x1000
238 .
239 .  {* The section contains only debugging information.  For
240 .     example, this is set for ELF .debug and .stab sections.
241 .     strip tests this flag to see if a section can be
242 .     discarded.  *}
243 .#define SEC_DEBUGGING 0x2000
244 .
245 .  {* The contents of this section are held in memory pointed to
246 .     by the contents field.  This is checked by bfd_get_section_contents,
247 .     and the data is retrieved from memory if appropriate.  *}
248 .#define SEC_IN_MEMORY 0x4000
249 .
250 .  {* The contents of this section are to be excluded by the
251 .     linker for executable and shared objects unless those
252 .     objects are to be further relocated.  *}
253 .#define SEC_EXCLUDE 0x8000
254 .
255 .  {* The contents of this section are to be sorted based on the sum of
256 .     the symbol and addend values specified by the associated relocation
257 .     entries.  Entries without associated relocation entries will be
258 .     appended to the end of the section in an unspecified order.  *}
259 .#define SEC_SORT_ENTRIES 0x10000
260 .
261 .  {* When linking, duplicate sections of the same name should be
262 .     discarded, rather than being combined into a single section as
263 .     is usually done.  This is similar to how common symbols are
264 .     handled.  See SEC_LINK_DUPLICATES below.  *}
265 .#define SEC_LINK_ONCE 0x20000
266 .
267 .  {* If SEC_LINK_ONCE is set, this bitfield describes how the linker
268 .     should handle duplicate sections.  *}
269 .#define SEC_LINK_DUPLICATES 0xc0000
270 .
271 .  {* This value for SEC_LINK_DUPLICATES means that duplicate
272 .     sections with the same name should simply be discarded.  *}
273 .#define SEC_LINK_DUPLICATES_DISCARD 0x0
274 .
275 .  {* This value for SEC_LINK_DUPLICATES means that the linker
276 .     should warn if there are any duplicate sections, although
277 .     it should still only link one copy.  *}
278 .#define SEC_LINK_DUPLICATES_ONE_ONLY 0x40000
279 .
280 .  {* This value for SEC_LINK_DUPLICATES means that the linker
281 .     should warn if any duplicate sections are a different size.  *}
282 .#define SEC_LINK_DUPLICATES_SAME_SIZE 0x80000
283 .
284 .  {* This value for SEC_LINK_DUPLICATES means that the linker
285 .     should warn if any duplicate sections contain different
286 .     contents.  *}
287 .#define SEC_LINK_DUPLICATES_SAME_CONTENTS \
288 .  (SEC_LINK_DUPLICATES_ONE_ONLY | SEC_LINK_DUPLICATES_SAME_SIZE)
289 .
290 .  {* This section was created by the linker as part of dynamic
291 .     relocation or other arcane processing.  It is skipped when
292 .     going through the first-pass output, trusting that someone
293 .     else up the line will take care of it later.  *}
294 .#define SEC_LINKER_CREATED 0x100000
295 .
296 .  {* This section should not be subject to garbage collection.
297 .     Also set to inform the linker that this section should not be
298 .     listed in the link map as discarded.  *}
299 .#define SEC_KEEP 0x200000
300 .
301 .  {* This section contains "short" data, and should be placed
302 .     "near" the GP.  *}
303 .#define SEC_SMALL_DATA 0x400000
304 .
305 .  {* Attempt to merge identical entities in the section.
306 .     Entity size is given in the entsize field.  *}
307 .#define SEC_MERGE 0x800000
308 .
309 .  {* If given with SEC_MERGE, entities to merge are zero terminated
310 .     strings where entsize specifies character size instead of fixed
311 .     size entries.  *}
312 .#define SEC_STRINGS 0x1000000
313 .
314 .  {* This section contains data about section groups.  *}
315 .#define SEC_GROUP 0x2000000
316 .
317 .  {* The section is a COFF shared library section.  This flag is
318 .     only for the linker.  If this type of section appears in
319 .     the input file, the linker must copy it to the output file
320 .     without changing the vma or size.  FIXME: Although this
321 .     was originally intended to be general, it really is COFF
322 .     specific (and the flag was renamed to indicate this).  It
323 .     might be cleaner to have some more general mechanism to
324 .     allow the back end to control what the linker does with
325 .     sections.  *}
326 .#define SEC_COFF_SHARED_LIBRARY 0x4000000
327 .
328 .  {* This input section should be copied to output in reverse order
329 .     as an array of pointers.  This is for ELF linker internal use
330 .     only.  *}
331 .#define SEC_ELF_REVERSE_COPY 0x4000000
332 .
333 .  {* This section contains data which may be shared with other
334 .     executables or shared objects. This is for COFF only.  *}
335 .#define SEC_COFF_SHARED 0x8000000
336 .
337 .  {* This section should be compressed.  This is for ELF linker
338 .     internal use only.  *}
339 .#define SEC_ELF_COMPRESS 0x8000000
340 .
341 .  {* When a section with this flag is being linked, then if the size of
342 .     the input section is less than a page, it should not cross a page
343 .     boundary.  If the size of the input section is one page or more,
344 .     it should be aligned on a page boundary.  This is for TI
345 .     TMS320C54X only.  *}
346 .#define SEC_TIC54X_BLOCK 0x10000000
347 .
348 .  {* Conditionally link this section; do not link if there are no
349 .     references found to any symbol in the section.  This is for TI
350 .     TMS320C54X only.  *}
351 .#define SEC_TIC54X_CLINK 0x20000000
352 .
353 .  {* Indicate that section has the no read flag set. This happens
354 .     when memory read flag isn't set. *}
355 .#define SEC_COFF_NOREAD 0x40000000
356 .
357 .  {*  End of section flags.  *}
358 .
359 .  {* Some internal packed boolean fields.  *}
360 .
361 .  {* See the vma field.  *}
362 .  unsigned int user_set_vma : 1;
363 .
364 .  {* A mark flag used by some of the linker backends.  *}
365 .  unsigned int linker_mark : 1;
366 .
367 .  {* Another mark flag used by some of the linker backends.  Set for
368 .     output sections that have an input section.  *}
369 .  unsigned int linker_has_input : 1;
370 .
371 .  {* Mark flag used by some linker backends for garbage collection.  *}
372 .  unsigned int gc_mark : 1;
373 .
374 .  {* Section compression status.  *}
375 .  unsigned int compress_status : 2;
376 .#define COMPRESS_SECTION_NONE    0
377 .#define COMPRESS_SECTION_DONE    1
378 .#define DECOMPRESS_SECTION_SIZED 2
379 .
380 .  {* The following flags are used by the ELF linker. *}
381 .
382 .  {* Mark sections which have been allocated to segments.  *}
383 .  unsigned int segment_mark : 1;
384 .
385 .  {* Type of sec_info information.  *}
386 .  unsigned int sec_info_type:3;
387 .#define SEC_INFO_TYPE_NONE      0
388 .#define SEC_INFO_TYPE_STABS     1
389 .#define SEC_INFO_TYPE_MERGE     2
390 .#define SEC_INFO_TYPE_EH_FRAME  3
391 .#define SEC_INFO_TYPE_JUST_SYMS 4
392 .#define SEC_INFO_TYPE_TARGET    5
393 .
394 .  {* Nonzero if this section uses RELA relocations, rather than REL.  *}
395 .  unsigned int use_rela_p:1;
396 .
397 .  {* Bits used by various backends.  The generic code doesn't touch
398 .     these fields.  *}
399 .
400 .  unsigned int sec_flg0:1;
401 .  unsigned int sec_flg1:1;
402 .  unsigned int sec_flg2:1;
403 .  unsigned int sec_flg3:1;
404 .  unsigned int sec_flg4:1;
405 .  unsigned int sec_flg5:1;
406 .
407 .  {* End of internal packed boolean fields.  *}
408 .
409 .  {*  The virtual memory address of the section - where it will be
410 .      at run time.  The symbols are relocated against this.  The
411 .      user_set_vma flag is maintained by bfd; if it's not set, the
412 .      backend can assign addresses (for example, in <<a.out>>, where
413 .      the default address for <<.data>> is dependent on the specific
414 .      target and various flags).  *}
415 .  bfd_vma vma;
416 .
417 .  {*  The load address of the section - where it would be in a
418 .      rom image; really only used for writing section header
419 .      information.  *}
420 .  bfd_vma lma;
421 .
422 .  {* The size of the section in octets, as it will be output.
423 .     Contains a value even if the section has no contents (e.g., the
424 .     size of <<.bss>>).  *}
425 .  bfd_size_type size;
426 .
427 .  {* For input sections, the original size on disk of the section, in
428 .     octets.  This field should be set for any section whose size is
429 .     changed by linker relaxation.  It is required for sections where
430 .     the linker relaxation scheme doesn't cache altered section and
431 .     reloc contents (stabs, eh_frame, SEC_MERGE, some coff relaxing
432 .     targets), and thus the original size needs to be kept to read the
433 .     section multiple times.  For output sections, rawsize holds the
434 .     section size calculated on a previous linker relaxation pass.  *}
435 .  bfd_size_type rawsize;
436 .
437 .  {* The compressed size of the section in octets.  *}
438 .  bfd_size_type compressed_size;
439 .
440 .  {* Relaxation table. *}
441 .  struct relax_table *relax;
442 .
443 .  {* Count of used relaxation table entries. *}
444 .  int relax_count;
445 .
446 .
447 .  {* If this section is going to be output, then this value is the
448 .     offset in *bytes* into the output section of the first byte in the
449 .     input section (byte ==> smallest addressable unit on the
450 .     target).  In most cases, if this was going to start at the
451 .     100th octet (8-bit quantity) in the output section, this value
452 .     would be 100.  However, if the target byte size is 16 bits
453 .     (bfd_octets_per_byte is "2"), this value would be 50.  *}
454 .  bfd_vma output_offset;
455 .
456 .  {* The output section through which to map on output.  *}
457 .  struct bfd_section *output_section;
458 .
459 .  {* The alignment requirement of the section, as an exponent of 2 -
460 .     e.g., 3 aligns to 2^3 (or 8).  *}
461 .  unsigned int alignment_power;
462 .
463 .  {* If an input section, a pointer to a vector of relocation
464 .     records for the data in this section.  *}
465 .  struct reloc_cache_entry *relocation;
466 .
467 .  {* If an output section, a pointer to a vector of pointers to
468 .     relocation records for the data in this section.  *}
469 .  struct reloc_cache_entry **orelocation;
470 .
471 .  {* The number of relocation records in one of the above.  *}
472 .  unsigned reloc_count;
473 .
474 .  {* Information below is back end specific - and not always used
475 .     or updated.  *}
476 .
477 .  {* File position of section data.  *}
478 .  file_ptr filepos;
479 .
480 .  {* File position of relocation info.  *}
481 .  file_ptr rel_filepos;
482 .
483 .  {* File position of line data.  *}
484 .  file_ptr line_filepos;
485 .
486 .  {* Pointer to data for applications.  *}
487 .  void *userdata;
488 .
489 .  {* If the SEC_IN_MEMORY flag is set, this points to the actual
490 .     contents.  *}
491 .  unsigned char *contents;
492 .
493 .  {* Attached line number information.  *}
494 .  alent *lineno;
495 .
496 .  {* Number of line number records.  *}
497 .  unsigned int lineno_count;
498 .
499 .  {* Entity size for merging purposes.  *}
500 .  unsigned int entsize;
501 .
502 .  {* Points to the kept section if this section is a link-once section,
503 .     and is discarded.  *}
504 .  struct bfd_section *kept_section;
505 .
506 .  {* When a section is being output, this value changes as more
507 .     linenumbers are written out.  *}
508 .  file_ptr moving_line_filepos;
509 .
510 .  {* What the section number is in the target world.  *}
511 .  int target_index;
512 .
513 .  void *used_by_bfd;
514 .
515 .  {* If this is a constructor section then here is a list of the
516 .     relocations created to relocate items within it.  *}
517 .  struct relent_chain *constructor_chain;
518 .
519 .  {* The BFD which owns the section.  *}
520 .  bfd *owner;
521 .
522 .  {* A symbol which points at this section only.  *}
523 .  struct bfd_symbol *symbol;
524 .  struct bfd_symbol **symbol_ptr_ptr;
525 .
526 .  {* Early in the link process, map_head and map_tail are used to build
527 .     a list of input sections attached to an output section.  Later,
528 .     output sections use these fields for a list of bfd_link_order
529 .     structs.  *}
530 .  union {
531 .    struct bfd_link_order *link_order;
532 .    struct bfd_section *s;
533 .  } map_head, map_tail;
534 .} asection;
535 .
536 .{* Relax table contains information about instructions which can
537 .   be removed by relaxation -- replacing a long address with a
538 .   short address.  *}
539 .struct relax_table {
540 .  {* Address where bytes may be deleted. *}
541 .  bfd_vma addr;
542 .
543 .  {* Number of bytes to be deleted.  *}
544 .  int size;
545 .};
546 .
547 .{* Note: the following are provided as inline functions rather than macros
548 .   because not all callers use the return value.  A macro implementation
549 .   would use a comma expression, eg: "((ptr)->foo = val, TRUE)" and some
550 .   compilers will complain about comma expressions that have no effect.  *}
551 .static inline bfd_boolean
552 .bfd_set_section_userdata (bfd * abfd ATTRIBUTE_UNUSED, asection * ptr, void * val)
553 .{
554 .  ptr->userdata = val;
555 .  return TRUE;
556 .}
557 .
558 .static inline bfd_boolean
559 .bfd_set_section_vma (bfd * abfd ATTRIBUTE_UNUSED, asection * ptr, bfd_vma val)
560 .{
561 .  ptr->vma = ptr->lma = val;
562 .  ptr->user_set_vma = TRUE;
563 .  return TRUE;
564 .}
565 .
566 .static inline bfd_boolean
567 .bfd_set_section_alignment (bfd * abfd ATTRIBUTE_UNUSED, asection * ptr, unsigned int val)
568 .{
569 .  ptr->alignment_power = val;
570 .  return TRUE;
571 .}
572 .
573 .{* These sections are global, and are managed by BFD.  The application
574 .   and target back end are not permitted to change the values in
575 .   these sections.  *}
576 .extern asection _bfd_std_section[4];
577 .
578 .#define BFD_ABS_SECTION_NAME "*ABS*"
579 .#define BFD_UND_SECTION_NAME "*UND*"
580 .#define BFD_COM_SECTION_NAME "*COM*"
581 .#define BFD_IND_SECTION_NAME "*IND*"
582 .
583 .{* Pointer to the common section.  *}
584 .#define bfd_com_section_ptr (&_bfd_std_section[0])
585 .{* Pointer to the undefined section.  *}
586 .#define bfd_und_section_ptr (&_bfd_std_section[1])
587 .{* Pointer to the absolute section.  *}
588 .#define bfd_abs_section_ptr (&_bfd_std_section[2])
589 .{* Pointer to the indirect section.  *}
590 .#define bfd_ind_section_ptr (&_bfd_std_section[3])
591 .
592 .#define bfd_is_und_section(sec) ((sec) == bfd_und_section_ptr)
593 .#define bfd_is_abs_section(sec) ((sec) == bfd_abs_section_ptr)
594 .#define bfd_is_ind_section(sec) ((sec) == bfd_ind_section_ptr)
595 .
596 .#define bfd_is_const_section(SEC)              \
597 . (   ((SEC) == bfd_abs_section_ptr)            \
598 .  || ((SEC) == bfd_und_section_ptr)            \
599 .  || ((SEC) == bfd_com_section_ptr)            \
600 .  || ((SEC) == bfd_ind_section_ptr))
601 .
602 .{* Macros to handle insertion and deletion of a bfd's sections.  These
603 .   only handle the list pointers, ie. do not adjust section_count,
604 .   target_index etc.  *}
605 .#define bfd_section_list_remove(ABFD, S) \
606 .  do                                                   \
607 .    {                                                  \
608 .      asection *_s = S;                                \
609 .      asection *_next = _s->next;                      \
610 .      asection *_prev = _s->prev;                      \
611 .      if (_prev)                                       \
612 .        _prev->next = _next;                           \
613 .      else                                             \
614 .        (ABFD)->sections = _next;                      \
615 .      if (_next)                                       \
616 .        _next->prev = _prev;                           \
617 .      else                                             \
618 .        (ABFD)->section_last = _prev;                  \
619 .    }                                                  \
620 .  while (0)
621 .#define bfd_section_list_append(ABFD, S) \
622 .  do                                                   \
623 .    {                                                  \
624 .      asection *_s = S;                                \
625 .      bfd *_abfd = ABFD;                               \
626 .      _s->next = NULL;                                 \
627 .      if (_abfd->section_last)                         \
628 .        {                                              \
629 .          _s->prev = _abfd->section_last;              \
630 .          _abfd->section_last->next = _s;              \
631 .        }                                              \
632 .      else                                             \
633 .        {                                              \
634 .          _s->prev = NULL;                             \
635 .          _abfd->sections = _s;                        \
636 .        }                                              \
637 .      _abfd->section_last = _s;                        \
638 .    }                                                  \
639 .  while (0)
640 .#define bfd_section_list_prepend(ABFD, S) \
641 .  do                                                   \
642 .    {                                                  \
643 .      asection *_s = S;                                \
644 .      bfd *_abfd = ABFD;                               \
645 .      _s->prev = NULL;                                 \
646 .      if (_abfd->sections)                             \
647 .        {                                              \
648 .          _s->next = _abfd->sections;                  \
649 .          _abfd->sections->prev = _s;                  \
650 .        }                                              \
651 .      else                                             \
652 .        {                                              \
653 .          _s->next = NULL;                             \
654 .          _abfd->section_last = _s;                    \
655 .        }                                              \
656 .      _abfd->sections = _s;                            \
657 .    }                                                  \
658 .  while (0)
659 .#define bfd_section_list_insert_after(ABFD, A, S) \
660 .  do                                                   \
661 .    {                                                  \
662 .      asection *_a = A;                                \
663 .      asection *_s = S;                                \
664 .      asection *_next = _a->next;                      \
665 .      _s->next = _next;                                \
666 .      _s->prev = _a;                                   \
667 .      _a->next = _s;                                   \
668 .      if (_next)                                       \
669 .        _next->prev = _s;                              \
670 .      else                                             \
671 .        (ABFD)->section_last = _s;                     \
672 .    }                                                  \
673 .  while (0)
674 .#define bfd_section_list_insert_before(ABFD, B, S) \
675 .  do                                                   \
676 .    {                                                  \
677 .      asection *_b = B;                                \
678 .      asection *_s = S;                                \
679 .      asection *_prev = _b->prev;                      \
680 .      _s->prev = _prev;                                \
681 .      _s->next = _b;                                   \
682 .      _b->prev = _s;                                   \
683 .      if (_prev)                                       \
684 .        _prev->next = _s;                              \
685 .      else                                             \
686 .        (ABFD)->sections = _s;                         \
687 .    }                                                  \
688 .  while (0)
689 .#define bfd_section_removed_from_list(ABFD, S) \
690 .  ((S)->next == NULL ? (ABFD)->section_last != (S) : (S)->next->prev != (S))
691 .
692 .#define BFD_FAKE_SECTION(SEC, FLAGS, SYM, NAME, IDX)                   \
693 .  {* name, id,  index, next, prev, flags, user_set_vma,            *}  \
694 .  { NAME,  IDX, 0,     NULL, NULL, FLAGS, 0,                           \
695 .                                                                       \
696 .  {* linker_mark, linker_has_input, gc_mark, decompress_status,    *}  \
697 .     0,           0,                1,       0,                        \
698 .                                                                       \
699 .  {* segment_mark, sec_info_type, use_rela_p,                      *}  \
700 .     0,            0,             0,                                   \
701 .                                                                       \
702 .  {* sec_flg0, sec_flg1, sec_flg2, sec_flg3, sec_flg4, sec_flg5,   *}  \
703 .     0,        0,        0,        0,        0,        0,              \
704 .                                                                       \
705 .  {* vma, lma, size, rawsize, compressed_size, relax, relax_count, *}  \
706 .     0,   0,   0,    0,       0,               0,     0,               \
707 .                                                                       \
708 .  {* output_offset, output_section, alignment_power,               *}  \
709 .     0,             &SEC,           0,                                 \
710 .                                                                       \
711 .  {* relocation, orelocation, reloc_count, filepos, rel_filepos,   *}  \
712 .     NULL,       NULL,        0,           0,       0,                 \
713 .                                                                       \
714 .  {* line_filepos, userdata, contents, lineno, lineno_count,       *}  \
715 .     0,            NULL,     NULL,     NULL,   0,                      \
716 .                                                                       \
717 .  {* entsize, kept_section, moving_line_filepos,                    *} \
718 .     0,       NULL,          0,                                        \
719 .                                                                       \
720 .  {* target_index, used_by_bfd, constructor_chain, owner,          *}  \
721 .     0,            NULL,        NULL,              NULL,               \
722 .                                                                       \
723 .  {* symbol,                    symbol_ptr_ptr,                    *}  \
724 .     (struct bfd_symbol *) SYM, &SEC.symbol,                           \
725 .                                                                       \
726 .  {* map_head, map_tail                                            *}  \
727 .     { NULL }, { NULL }                                                \
728 .    }
729 .
730 */
731
732 /* We use a macro to initialize the static asymbol structures because
733    traditional C does not permit us to initialize a union member while
734    gcc warns if we don't initialize it.  */
735  /* the_bfd, name, value, attr, section [, udata] */
736 #ifdef __STDC__
737 #define GLOBAL_SYM_INIT(NAME, SECTION) \
738   { 0, NAME, 0, BSF_SECTION_SYM, SECTION, { 0 }}
739 #else
740 #define GLOBAL_SYM_INIT(NAME, SECTION) \
741   { 0, NAME, 0, BSF_SECTION_SYM, SECTION }
742 #endif
743
744 /* These symbols are global, not specific to any BFD.  Therefore, anything
745    that tries to change them is broken, and should be repaired.  */
746
747 static const asymbol global_syms[] =
748 {
749   GLOBAL_SYM_INIT (BFD_COM_SECTION_NAME, bfd_com_section_ptr),
750   GLOBAL_SYM_INIT (BFD_UND_SECTION_NAME, bfd_und_section_ptr),
751   GLOBAL_SYM_INIT (BFD_ABS_SECTION_NAME, bfd_abs_section_ptr),
752   GLOBAL_SYM_INIT (BFD_IND_SECTION_NAME, bfd_ind_section_ptr)
753 };
754
755 #define STD_SECTION(NAME, IDX, FLAGS) \
756   BFD_FAKE_SECTION(_bfd_std_section[IDX], FLAGS, &global_syms[IDX], NAME, IDX)
757
758 asection _bfd_std_section[] = {
759   STD_SECTION (BFD_COM_SECTION_NAME, 0, SEC_IS_COMMON),
760   STD_SECTION (BFD_UND_SECTION_NAME, 1, 0),
761   STD_SECTION (BFD_ABS_SECTION_NAME, 2, 0),
762   STD_SECTION (BFD_IND_SECTION_NAME, 3, 0)
763 };
764 #undef STD_SECTION
765
766 /* Initialize an entry in the section hash table.  */
767
768 struct bfd_hash_entry *
769 bfd_section_hash_newfunc (struct bfd_hash_entry *entry,
770                           struct bfd_hash_table *table,
771                           const char *string)
772 {
773   /* Allocate the structure if it has not already been allocated by a
774      subclass.  */
775   if (entry == NULL)
776     {
777       entry = (struct bfd_hash_entry *)
778         bfd_hash_allocate (table, sizeof (struct section_hash_entry));
779       if (entry == NULL)
780         return entry;
781     }
782
783   /* Call the allocation method of the superclass.  */
784   entry = bfd_hash_newfunc (entry, table, string);
785   if (entry != NULL)
786     memset (&((struct section_hash_entry *) entry)->section, 0,
787             sizeof (asection));
788
789   return entry;
790 }
791
792 #define section_hash_lookup(table, string, create, copy) \
793   ((struct section_hash_entry *) \
794    bfd_hash_lookup ((table), (string), (create), (copy)))
795
796 /* Create a symbol whose only job is to point to this section.  This
797    is useful for things like relocs which are relative to the base
798    of a section.  */
799
800 bfd_boolean
801 _bfd_generic_new_section_hook (bfd *abfd, asection *newsect)
802 {
803   newsect->symbol = bfd_make_empty_symbol (abfd);
804   if (newsect->symbol == NULL)
805     return FALSE;
806
807   newsect->symbol->name = newsect->name;
808   newsect->symbol->value = 0;
809   newsect->symbol->section = newsect;
810   newsect->symbol->flags = BSF_SECTION_SYM;
811
812   newsect->symbol_ptr_ptr = &newsect->symbol;
813   return TRUE;
814 }
815
816 /* Initializes a new section.  NEWSECT->NAME is already set.  */
817
818 static asection *
819 bfd_section_init (bfd *abfd, asection *newsect)
820 {
821   static int section_id = 0x10;  /* id 0 to 3 used by STD_SECTION.  */
822
823   newsect->id = section_id;
824   newsect->index = abfd->section_count;
825   newsect->owner = abfd;
826
827   if (! BFD_SEND (abfd, _new_section_hook, (abfd, newsect)))
828     return NULL;
829
830   section_id++;
831   abfd->section_count++;
832   bfd_section_list_append (abfd, newsect);
833   return newsect;
834 }
835
836 /*
837 DOCDD
838 INODE
839 section prototypes,  , typedef asection, Sections
840 SUBSECTION
841         Section prototypes
842
843 These are the functions exported by the section handling part of BFD.
844 */
845
846 /*
847 FUNCTION
848         bfd_section_list_clear
849
850 SYNOPSIS
851         void bfd_section_list_clear (bfd *);
852
853 DESCRIPTION
854         Clears the section list, and also resets the section count and
855         hash table entries.
856 */
857
858 void
859 bfd_section_list_clear (bfd *abfd)
860 {
861   abfd->sections = NULL;
862   abfd->section_last = NULL;
863   abfd->section_count = 0;
864   memset (abfd->section_htab.table, 0,
865           abfd->section_htab.size * sizeof (struct bfd_hash_entry *));
866   abfd->section_htab.count = 0;
867 }
868
869 /*
870 FUNCTION
871         bfd_get_section_by_name
872
873 SYNOPSIS
874         asection *bfd_get_section_by_name (bfd *abfd, const char *name);
875
876 DESCRIPTION
877         Return the most recently created section attached to @var{abfd}
878         named @var{name}.  Return NULL if no such section exists.
879 */
880
881 asection *
882 bfd_get_section_by_name (bfd *abfd, const char *name)
883 {
884   struct section_hash_entry *sh;
885
886   sh = section_hash_lookup (&abfd->section_htab, name, FALSE, FALSE);
887   if (sh != NULL)
888     return &sh->section;
889
890   return NULL;
891 }
892
893 /*
894 FUNCTION
895        bfd_get_next_section_by_name
896
897 SYNOPSIS
898        asection *bfd_get_next_section_by_name (asection *sec);
899
900 DESCRIPTION
901        Given @var{sec} is a section returned by @code{bfd_get_section_by_name},
902        return the next most recently created section attached to the same
903        BFD with the same name.  Return NULL if no such section exists.
904 */
905
906 asection *
907 bfd_get_next_section_by_name (asection *sec)
908 {
909   struct section_hash_entry *sh;
910   const char *name;
911   unsigned long hash;
912
913   sh = ((struct section_hash_entry *)
914         ((char *) sec - offsetof (struct section_hash_entry, section)));
915
916   hash = sh->root.hash;
917   name = sec->name;
918   for (sh = (struct section_hash_entry *) sh->root.next;
919        sh != NULL;
920        sh = (struct section_hash_entry *) sh->root.next)
921     if (sh->root.hash == hash
922        && strcmp (sh->root.string, name) == 0)
923       return &sh->section;
924
925   return NULL;
926 }
927
928 /*
929 FUNCTION
930         bfd_get_linker_section
931
932 SYNOPSIS
933         asection *bfd_get_linker_section (bfd *abfd, const char *name);
934
935 DESCRIPTION
936         Return the linker created section attached to @var{abfd}
937         named @var{name}.  Return NULL if no such section exists.
938 */
939
940 asection *
941 bfd_get_linker_section (bfd *abfd, const char *name)
942 {
943   asection *sec = bfd_get_section_by_name (abfd, name);
944
945   while (sec != NULL && (sec->flags & SEC_LINKER_CREATED) == 0)
946     sec = bfd_get_next_section_by_name (sec);
947   return sec;
948 }
949
950 /*
951 FUNCTION
952         bfd_get_section_by_name_if
953
954 SYNOPSIS
955         asection *bfd_get_section_by_name_if
956           (bfd *abfd,
957            const char *name,
958            bfd_boolean (*func) (bfd *abfd, asection *sect, void *obj),
959            void *obj);
960
961 DESCRIPTION
962         Call the provided function @var{func} for each section
963         attached to the BFD @var{abfd} whose name matches @var{name},
964         passing @var{obj} as an argument. The function will be called
965         as if by
966
967 |       func (abfd, the_section, obj);
968
969         It returns the first section for which @var{func} returns true,
970         otherwise <<NULL>>.
971
972 */
973
974 asection *
975 bfd_get_section_by_name_if (bfd *abfd, const char *name,
976                             bfd_boolean (*operation) (bfd *,
977                                                       asection *,
978                                                       void *),
979                             void *user_storage)
980 {
981   struct section_hash_entry *sh;
982   unsigned long hash;
983
984   sh = section_hash_lookup (&abfd->section_htab, name, FALSE, FALSE);
985   if (sh == NULL)
986     return NULL;
987
988   hash = sh->root.hash;
989   do
990     {
991       if ((*operation) (abfd, &sh->section, user_storage))
992         return &sh->section;
993       sh = (struct section_hash_entry *) sh->root.next;
994     }
995   while (sh != NULL && sh->root.hash == hash
996          && strcmp (sh->root.string, name) == 0);
997
998   return NULL;
999 }
1000
1001 /*
1002 FUNCTION
1003         bfd_get_unique_section_name
1004
1005 SYNOPSIS
1006         char *bfd_get_unique_section_name
1007           (bfd *abfd, const char *templat, int *count);
1008
1009 DESCRIPTION
1010         Invent a section name that is unique in @var{abfd} by tacking
1011         a dot and a digit suffix onto the original @var{templat}.  If
1012         @var{count} is non-NULL, then it specifies the first number
1013         tried as a suffix to generate a unique name.  The value
1014         pointed to by @var{count} will be incremented in this case.
1015 */
1016
1017 char *
1018 bfd_get_unique_section_name (bfd *abfd, const char *templat, int *count)
1019 {
1020   int num;
1021   unsigned int len;
1022   char *sname;
1023
1024   len = strlen (templat);
1025   sname = (char *) bfd_malloc (len + 8);
1026   if (sname == NULL)
1027     return NULL;
1028   memcpy (sname, templat, len);
1029   num = 1;
1030   if (count != NULL)
1031     num = *count;
1032
1033   do
1034     {
1035       /* If we have a million sections, something is badly wrong.  */
1036       if (num > 999999)
1037         abort ();
1038       sprintf (sname + len, ".%d", num++);
1039     }
1040   while (section_hash_lookup (&abfd->section_htab, sname, FALSE, FALSE));
1041
1042   if (count != NULL)
1043     *count = num;
1044   return sname;
1045 }
1046
1047 /*
1048 FUNCTION
1049         bfd_make_section_old_way
1050
1051 SYNOPSIS
1052         asection *bfd_make_section_old_way (bfd *abfd, const char *name);
1053
1054 DESCRIPTION
1055         Create a new empty section called @var{name}
1056         and attach it to the end of the chain of sections for the
1057         BFD @var{abfd}. An attempt to create a section with a name which
1058         is already in use returns its pointer without changing the
1059         section chain.
1060
1061         It has the funny name since this is the way it used to be
1062         before it was rewritten....
1063
1064         Possible errors are:
1065         o <<bfd_error_invalid_operation>> -
1066         If output has already started for this BFD.
1067         o <<bfd_error_no_memory>> -
1068         If memory allocation fails.
1069
1070 */
1071
1072 asection *
1073 bfd_make_section_old_way (bfd *abfd, const char *name)
1074 {
1075   asection *newsect;
1076
1077   if (abfd->output_has_begun)
1078     {
1079       bfd_set_error (bfd_error_invalid_operation);
1080       return NULL;
1081     }
1082
1083   if (strcmp (name, BFD_ABS_SECTION_NAME) == 0)
1084     newsect = bfd_abs_section_ptr;
1085   else if (strcmp (name, BFD_COM_SECTION_NAME) == 0)
1086     newsect = bfd_com_section_ptr;
1087   else if (strcmp (name, BFD_UND_SECTION_NAME) == 0)
1088     newsect = bfd_und_section_ptr;
1089   else if (strcmp (name, BFD_IND_SECTION_NAME) == 0)
1090     newsect = bfd_ind_section_ptr;
1091   else
1092     {
1093       struct section_hash_entry *sh;
1094
1095       sh = section_hash_lookup (&abfd->section_htab, name, TRUE, FALSE);
1096       if (sh == NULL)
1097         return NULL;
1098
1099       newsect = &sh->section;
1100       if (newsect->name != NULL)
1101         {
1102           /* Section already exists.  */
1103           return newsect;
1104         }
1105
1106       newsect->name = name;
1107       return bfd_section_init (abfd, newsect);
1108     }
1109
1110   /* Call new_section_hook when "creating" the standard abs, com, und
1111      and ind sections to tack on format specific section data.
1112      Also, create a proper section symbol.  */
1113   if (! BFD_SEND (abfd, _new_section_hook, (abfd, newsect)))
1114     return NULL;
1115   return newsect;
1116 }
1117
1118 /*
1119 FUNCTION
1120         bfd_make_section_anyway_with_flags
1121
1122 SYNOPSIS
1123         asection *bfd_make_section_anyway_with_flags
1124           (bfd *abfd, const char *name, flagword flags);
1125
1126 DESCRIPTION
1127    Create a new empty section called @var{name} and attach it to the end of
1128    the chain of sections for @var{abfd}.  Create a new section even if there
1129    is already a section with that name.  Also set the attributes of the
1130    new section to the value @var{flags}.
1131
1132    Return <<NULL>> and set <<bfd_error>> on error; possible errors are:
1133    o <<bfd_error_invalid_operation>> - If output has already started for @var{abfd}.
1134    o <<bfd_error_no_memory>> - If memory allocation fails.
1135 */
1136
1137 sec_ptr
1138 bfd_make_section_anyway_with_flags (bfd *abfd, const char *name,
1139                                     flagword flags)
1140 {
1141   struct section_hash_entry *sh;
1142   asection *newsect;
1143
1144   if (abfd->output_has_begun)
1145     {
1146       bfd_set_error (bfd_error_invalid_operation);
1147       return NULL;
1148     }
1149
1150   sh = section_hash_lookup (&abfd->section_htab, name, TRUE, FALSE);
1151   if (sh == NULL)
1152     return NULL;
1153
1154   newsect = &sh->section;
1155   if (newsect->name != NULL)
1156     {
1157       /* We are making a section of the same name.  Put it in the
1158          section hash table.  Even though we can't find it directly by a
1159          hash lookup, we'll be able to find the section by traversing
1160          sh->root.next quicker than looking at all the bfd sections.  */
1161       struct section_hash_entry *new_sh;
1162       new_sh = (struct section_hash_entry *)
1163         bfd_section_hash_newfunc (NULL, &abfd->section_htab, name);
1164       if (new_sh == NULL)
1165         return NULL;
1166
1167       new_sh->root = sh->root;
1168       sh->root.next = &new_sh->root;
1169       newsect = &new_sh->section;
1170     }
1171
1172   newsect->flags = flags;
1173   newsect->name = name;
1174   return bfd_section_init (abfd, newsect);
1175 }
1176
1177 /*
1178 FUNCTION
1179         bfd_make_section_anyway
1180
1181 SYNOPSIS
1182         asection *bfd_make_section_anyway (bfd *abfd, const char *name);
1183
1184 DESCRIPTION
1185    Create a new empty section called @var{name} and attach it to the end of
1186    the chain of sections for @var{abfd}.  Create a new section even if there
1187    is already a section with that name.
1188
1189    Return <<NULL>> and set <<bfd_error>> on error; possible errors are:
1190    o <<bfd_error_invalid_operation>> - If output has already started for @var{abfd}.
1191    o <<bfd_error_no_memory>> - If memory allocation fails.
1192 */
1193
1194 sec_ptr
1195 bfd_make_section_anyway (bfd *abfd, const char *name)
1196 {
1197   return bfd_make_section_anyway_with_flags (abfd, name, 0);
1198 }
1199
1200 /*
1201 FUNCTION
1202         bfd_make_section_with_flags
1203
1204 SYNOPSIS
1205         asection *bfd_make_section_with_flags
1206           (bfd *, const char *name, flagword flags);
1207
1208 DESCRIPTION
1209    Like <<bfd_make_section_anyway>>, but return <<NULL>> (without calling
1210    bfd_set_error ()) without changing the section chain if there is already a
1211    section named @var{name}.  Also set the attributes of the new section to
1212    the value @var{flags}.  If there is an error, return <<NULL>> and set
1213    <<bfd_error>>.
1214 */
1215
1216 asection *
1217 bfd_make_section_with_flags (bfd *abfd, const char *name,
1218                              flagword flags)
1219 {
1220   struct section_hash_entry *sh;
1221   asection *newsect;
1222
1223   if (abfd->output_has_begun)
1224     {
1225       bfd_set_error (bfd_error_invalid_operation);
1226       return NULL;
1227     }
1228
1229   if (strcmp (name, BFD_ABS_SECTION_NAME) == 0
1230       || strcmp (name, BFD_COM_SECTION_NAME) == 0
1231       || strcmp (name, BFD_UND_SECTION_NAME) == 0
1232       || strcmp (name, BFD_IND_SECTION_NAME) == 0)
1233     return NULL;
1234
1235   sh = section_hash_lookup (&abfd->section_htab, name, TRUE, FALSE);
1236   if (sh == NULL)
1237     return NULL;
1238
1239   newsect = &sh->section;
1240   if (newsect->name != NULL)
1241     {
1242       /* Section already exists.  */
1243       return NULL;
1244     }
1245
1246   newsect->name = name;
1247   newsect->flags = flags;
1248   return bfd_section_init (abfd, newsect);
1249 }
1250
1251 /*
1252 FUNCTION
1253         bfd_make_section
1254
1255 SYNOPSIS
1256         asection *bfd_make_section (bfd *, const char *name);
1257
1258 DESCRIPTION
1259    Like <<bfd_make_section_anyway>>, but return <<NULL>> (without calling
1260    bfd_set_error ()) without changing the section chain if there is already a
1261    section named @var{name}.  If there is an error, return <<NULL>> and set
1262    <<bfd_error>>.
1263 */
1264
1265 asection *
1266 bfd_make_section (bfd *abfd, const char *name)
1267 {
1268   return bfd_make_section_with_flags (abfd, name, 0);
1269 }
1270
1271 /*
1272 FUNCTION
1273         bfd_set_section_flags
1274
1275 SYNOPSIS
1276         bfd_boolean bfd_set_section_flags
1277           (bfd *abfd, asection *sec, flagword flags);
1278
1279 DESCRIPTION
1280         Set the attributes of the section @var{sec} in the BFD
1281         @var{abfd} to the value @var{flags}. Return <<TRUE>> on success,
1282         <<FALSE>> on error. Possible error returns are:
1283
1284         o <<bfd_error_invalid_operation>> -
1285         The section cannot have one or more of the attributes
1286         requested. For example, a .bss section in <<a.out>> may not
1287         have the <<SEC_HAS_CONTENTS>> field set.
1288
1289 */
1290
1291 bfd_boolean
1292 bfd_set_section_flags (bfd *abfd ATTRIBUTE_UNUSED,
1293                        sec_ptr section,
1294                        flagword flags)
1295 {
1296   section->flags = flags;
1297   return TRUE;
1298 }
1299
1300 /*
1301 FUNCTION
1302         bfd_rename_section
1303
1304 SYNOPSIS
1305         void bfd_rename_section
1306           (bfd *abfd, asection *sec, const char *newname);
1307
1308 DESCRIPTION
1309         Rename section @var{sec} in @var{abfd} to @var{newname}.
1310 */
1311
1312 void
1313 bfd_rename_section (bfd *abfd, sec_ptr sec, const char *newname)
1314 {
1315   struct section_hash_entry *sh;
1316
1317   sh = (struct section_hash_entry *)
1318     ((char *) sec - offsetof (struct section_hash_entry, section));
1319   sh->section.name = newname;
1320   bfd_hash_rename (&abfd->section_htab, newname, &sh->root);
1321 }
1322
1323 /*
1324 FUNCTION
1325         bfd_map_over_sections
1326
1327 SYNOPSIS
1328         void bfd_map_over_sections
1329           (bfd *abfd,
1330            void (*func) (bfd *abfd, asection *sect, void *obj),
1331            void *obj);
1332
1333 DESCRIPTION
1334         Call the provided function @var{func} for each section
1335         attached to the BFD @var{abfd}, passing @var{obj} as an
1336         argument. The function will be called as if by
1337
1338 |       func (abfd, the_section, obj);
1339
1340         This is the preferred method for iterating over sections; an
1341         alternative would be to use a loop:
1342
1343 |          asection *p;
1344 |          for (p = abfd->sections; p != NULL; p = p->next)
1345 |             func (abfd, p, ...)
1346
1347 */
1348
1349 void
1350 bfd_map_over_sections (bfd *abfd,
1351                        void (*operation) (bfd *, asection *, void *),
1352                        void *user_storage)
1353 {
1354   asection *sect;
1355   unsigned int i = 0;
1356
1357   for (sect = abfd->sections; sect != NULL; i++, sect = sect->next)
1358     (*operation) (abfd, sect, user_storage);
1359
1360   if (i != abfd->section_count) /* Debugging */
1361     abort ();
1362 }
1363
1364 /*
1365 FUNCTION
1366         bfd_sections_find_if
1367
1368 SYNOPSIS
1369         asection *bfd_sections_find_if
1370           (bfd *abfd,
1371            bfd_boolean (*operation) (bfd *abfd, asection *sect, void *obj),
1372            void *obj);
1373
1374 DESCRIPTION
1375         Call the provided function @var{operation} for each section
1376         attached to the BFD @var{abfd}, passing @var{obj} as an
1377         argument. The function will be called as if by
1378
1379 |       operation (abfd, the_section, obj);
1380
1381         It returns the first section for which @var{operation} returns true.
1382
1383 */
1384
1385 asection *
1386 bfd_sections_find_if (bfd *abfd,
1387                       bfd_boolean (*operation) (bfd *, asection *, void *),
1388                       void *user_storage)
1389 {
1390   asection *sect;
1391
1392   for (sect = abfd->sections; sect != NULL; sect = sect->next)
1393     if ((*operation) (abfd, sect, user_storage))
1394       break;
1395
1396   return sect;
1397 }
1398
1399 /*
1400 FUNCTION
1401         bfd_set_section_size
1402
1403 SYNOPSIS
1404         bfd_boolean bfd_set_section_size
1405           (bfd *abfd, asection *sec, bfd_size_type val);
1406
1407 DESCRIPTION
1408         Set @var{sec} to the size @var{val}. If the operation is
1409         ok, then <<TRUE>> is returned, else <<FALSE>>.
1410
1411         Possible error returns:
1412         o <<bfd_error_invalid_operation>> -
1413         Writing has started to the BFD, so setting the size is invalid.
1414
1415 */
1416
1417 bfd_boolean
1418 bfd_set_section_size (bfd *abfd, sec_ptr ptr, bfd_size_type val)
1419 {
1420   /* Once you've started writing to any section you cannot create or change
1421      the size of any others.  */
1422
1423   if (abfd->output_has_begun)
1424     {
1425       bfd_set_error (bfd_error_invalid_operation);
1426       return FALSE;
1427     }
1428
1429   ptr->size = val;
1430   return TRUE;
1431 }
1432
1433 /*
1434 FUNCTION
1435         bfd_set_section_contents
1436
1437 SYNOPSIS
1438         bfd_boolean bfd_set_section_contents
1439           (bfd *abfd, asection *section, const void *data,
1440            file_ptr offset, bfd_size_type count);
1441
1442 DESCRIPTION
1443         Sets the contents of the section @var{section} in BFD
1444         @var{abfd} to the data starting in memory at @var{data}. The
1445         data is written to the output section starting at offset
1446         @var{offset} for @var{count} octets.
1447
1448         Normally <<TRUE>> is returned, else <<FALSE>>. Possible error
1449         returns are:
1450         o <<bfd_error_no_contents>> -
1451         The output section does not have the <<SEC_HAS_CONTENTS>>
1452         attribute, so nothing can be written to it.
1453         o and some more too
1454
1455         This routine is front end to the back end function
1456         <<_bfd_set_section_contents>>.
1457
1458 */
1459
1460 bfd_boolean
1461 bfd_set_section_contents (bfd *abfd,
1462                           sec_ptr section,
1463                           const void *location,
1464                           file_ptr offset,
1465                           bfd_size_type count)
1466 {
1467   bfd_size_type sz;
1468
1469   if (!(bfd_get_section_flags (abfd, section) & SEC_HAS_CONTENTS))
1470     {
1471       bfd_set_error (bfd_error_no_contents);
1472       return FALSE;
1473     }
1474
1475   sz = section->size;
1476   if ((bfd_size_type) offset > sz
1477       || count > sz
1478       || offset + count > sz
1479       || count != (size_t) count)
1480     {
1481       bfd_set_error (bfd_error_bad_value);
1482       return FALSE;
1483     }
1484
1485   if (!bfd_write_p (abfd))
1486     {
1487       bfd_set_error (bfd_error_invalid_operation);
1488       return FALSE;
1489     }
1490
1491   /* Record a copy of the data in memory if desired.  */
1492   if (section->contents
1493       && location != section->contents + offset)
1494     memcpy (section->contents + offset, location, (size_t) count);
1495
1496   if (BFD_SEND (abfd, _bfd_set_section_contents,
1497                 (abfd, section, location, offset, count)))
1498     {
1499       abfd->output_has_begun = TRUE;
1500       return TRUE;
1501     }
1502
1503   return FALSE;
1504 }
1505
1506 /*
1507 FUNCTION
1508         bfd_get_section_contents
1509
1510 SYNOPSIS
1511         bfd_boolean bfd_get_section_contents
1512           (bfd *abfd, asection *section, void *location, file_ptr offset,
1513            bfd_size_type count);
1514
1515 DESCRIPTION
1516         Read data from @var{section} in BFD @var{abfd}
1517         into memory starting at @var{location}. The data is read at an
1518         offset of @var{offset} from the start of the input section,
1519         and is read for @var{count} bytes.
1520
1521         If the contents of a constructor with the <<SEC_CONSTRUCTOR>>
1522         flag set are requested or if the section does not have the
1523         <<SEC_HAS_CONTENTS>> flag set, then the @var{location} is filled
1524         with zeroes. If no errors occur, <<TRUE>> is returned, else
1525         <<FALSE>>.
1526
1527 */
1528 bfd_boolean
1529 bfd_get_section_contents (bfd *abfd,
1530                           sec_ptr section,
1531                           void *location,
1532                           file_ptr offset,
1533                           bfd_size_type count)
1534 {
1535   bfd_size_type sz;
1536
1537   if (section->flags & SEC_CONSTRUCTOR)
1538     {
1539       memset (location, 0, (size_t) count);
1540       return TRUE;
1541     }
1542
1543   if (abfd->direction != write_direction && section->rawsize != 0)
1544     sz = section->rawsize;
1545   else
1546     sz = section->size;
1547   if ((bfd_size_type) offset > sz
1548       || count > sz
1549       || offset + count > sz
1550       || count != (size_t) count)
1551     {
1552       bfd_set_error (bfd_error_bad_value);
1553       return FALSE;
1554     }
1555
1556   if (count == 0)
1557     /* Don't bother.  */
1558     return TRUE;
1559
1560   if ((section->flags & SEC_HAS_CONTENTS) == 0)
1561     {
1562       memset (location, 0, (size_t) count);
1563       return TRUE;
1564     }
1565
1566   if ((section->flags & SEC_IN_MEMORY) != 0)
1567     {
1568       if (section->contents == NULL)
1569         {
1570           /* This can happen because of errors earlier on in the linking process.
1571              We do not want to seg-fault here, so clear the flag and return an
1572              error code.  */
1573           section->flags &= ~ SEC_IN_MEMORY;
1574           bfd_set_error (bfd_error_invalid_operation);
1575           return FALSE;
1576         }
1577
1578       memmove (location, section->contents + offset, (size_t) count);
1579       return TRUE;
1580     }
1581
1582   return BFD_SEND (abfd, _bfd_get_section_contents,
1583                    (abfd, section, location, offset, count));
1584 }
1585
1586 /*
1587 FUNCTION
1588         bfd_malloc_and_get_section
1589
1590 SYNOPSIS
1591         bfd_boolean bfd_malloc_and_get_section
1592           (bfd *abfd, asection *section, bfd_byte **buf);
1593
1594 DESCRIPTION
1595         Read all data from @var{section} in BFD @var{abfd}
1596         into a buffer, *@var{buf}, malloc'd by this function.
1597 */
1598
1599 bfd_boolean
1600 bfd_malloc_and_get_section (bfd *abfd, sec_ptr sec, bfd_byte **buf)
1601 {
1602   *buf = NULL;
1603   return bfd_get_full_section_contents (abfd, sec, buf);
1604 }
1605 /*
1606 FUNCTION
1607         bfd_copy_private_section_data
1608
1609 SYNOPSIS
1610         bfd_boolean bfd_copy_private_section_data
1611           (bfd *ibfd, asection *isec, bfd *obfd, asection *osec);
1612
1613 DESCRIPTION
1614         Copy private section information from @var{isec} in the BFD
1615         @var{ibfd} to the section @var{osec} in the BFD @var{obfd}.
1616         Return <<TRUE>> on success, <<FALSE>> on error.  Possible error
1617         returns are:
1618
1619         o <<bfd_error_no_memory>> -
1620         Not enough memory exists to create private data for @var{osec}.
1621
1622 .#define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1623 .     BFD_SEND (obfd, _bfd_copy_private_section_data, \
1624 .               (ibfd, isection, obfd, osection))
1625 */
1626
1627 /*
1628 FUNCTION
1629         bfd_generic_is_group_section
1630
1631 SYNOPSIS
1632         bfd_boolean bfd_generic_is_group_section (bfd *, const asection *sec);
1633
1634 DESCRIPTION
1635         Returns TRUE if @var{sec} is a member of a group.
1636 */
1637
1638 bfd_boolean
1639 bfd_generic_is_group_section (bfd *abfd ATTRIBUTE_UNUSED,
1640                               const asection *sec ATTRIBUTE_UNUSED)
1641 {
1642   return FALSE;
1643 }
1644
1645 /*
1646 FUNCTION
1647         bfd_generic_discard_group
1648
1649 SYNOPSIS
1650         bfd_boolean bfd_generic_discard_group (bfd *abfd, asection *group);
1651
1652 DESCRIPTION
1653         Remove all members of @var{group} from the output.
1654 */
1655
1656 bfd_boolean
1657 bfd_generic_discard_group (bfd *abfd ATTRIBUTE_UNUSED,
1658                            asection *group ATTRIBUTE_UNUSED)
1659 {
1660   return TRUE;
1661 }