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 .extern const struct symbol_cache_entry * const bfd_abs_symbol;
 548 .extern const struct symbol_cache_entry * const bfd_com_symbol;
 549 .extern const struct symbol_cache_entry * const bfd_und_symbol;
 550 .extern const struct symbol_cache_entry * const bfd_ind_symbol;
 551 .#define bfd_get_section_size_before_reloc(section) \
 552 .     ((section)->reloc_done ? (abort (), (bfd_size_type) 1) \
 553 .                            : (section)->_raw_size)
 554 .#define bfd_get_section_size_after_reloc(section) \
 555 .     ((section)->reloc_done ? (section)->_cooked_size \
 556 .                            : (abort (), (bfd_size_type) 1))
 557 */
 558
 559 /* We use a macro to initialize the static asymbol structures because
 560    traditional C does not permit us to initialize a union member while
 561    gcc warns if we don't initialize it.  */
 562  /* the_bfd, name, value, attr, section [, udata] */
 563 #ifdef __STDC__
 564 #define GLOBAL_SYM_INIT(NAME, SECTION) \
 565   { 0, NAME, 0, BSF_SECTION_SYM, (asection *) SECTION, { 0 }}
 566 #else
 567 #define GLOBAL_SYM_INIT(NAME, SECTION) \
 568   { 0, NAME, 0, BSF_SECTION_SYM, (asection *) SECTION }
 569 #endif
 570
 571 /* These symbols are global, not specific to any BFD.  Therefore, anything
 572    that tries to change them is broken, and should be repaired.  */
 573
 574 static const asymbol global_syms[] =
 575 {
 576   GLOBAL_SYM_INIT (BFD_COM_SECTION_NAME, &bfd_com_section),
 577   GLOBAL_SYM_INIT (BFD_UND_SECTION_NAME, &bfd_und_section),
 578   GLOBAL_SYM_INIT (BFD_ABS_SECTION_NAME, &bfd_abs_section),
 579   GLOBAL_SYM_INIT (BFD_IND_SECTION_NAME, &bfd_ind_section)
 580 };
 581
 582 #define STD_SECTION(SEC, FLAGS, SYM, NAME, IDX)                         \
 583   const asymbol * const SYM = (asymbol *) &global_syms[IDX];            \
 584   const asection SEC =                                                  \
 585     /* name, id,  index, next, flags, user_set_vma, reloc_done,      */ \
 586     { NAME,  IDX, 0,     NULL, FLAGS, 0,            0,                  \
 587                                                                         \
 588     /* linker_mark, linker_has_input, gc_mark, segment_mark,         */ \
 589        0,           0,                1,       0,                       \
 590                                                                         \
 591     /* vma, lma, _cooked_size, _raw_size,                            */ \
 592        0,   0,   0,            0,                                       \
 593                                                                         \
 594     /* output_offset, output_section,      alignment_power,          */ \
 595        0,             (struct sec *) &SEC, 0,                           \
 596                                                                         \
 597     /* relocation, orelocation, reloc_count, filepos, rel_filepos,   */ \
 598        NULL,       NULL,        0,           0,       0,                \
 599                                                                         \
 600     /* line_filepos, userdata, contents, lineno, lineno_count,       */ \
 601        0,            NULL,     NULL,     NULL,   0,                     \
 602                                                                         \
 603     /* entsize, comdat, moving_line_filepos,                         */ \
 604        0,       NULL,   0,                                              \
 605                                                                         \
 606     /* target_index, used_by_bfd, constructor_chain, owner,          */ \
 607        0,            NULL,        NULL,              NULL,              \
 608                                                                         \
 609     /* symbol,                                                       */ \
 610        (struct symbol_cache_entry *) &global_syms[IDX],                 \
 611                                                                         \
 612     /* symbol_ptr_ptr,                                               */ \
 613        (struct symbol_cache_entry **) &SYM,                             \
 614                                                                         \
 615     /* link_order_head, link_order_tail                              */ \
 616        NULL,            NULL                                            \
 617     }
 618
 619 STD_SECTION (bfd_com_section, SEC_IS_COMMON, bfd_com_symbol,
 620              BFD_COM_SECTION_NAME, 0);
 621 STD_SECTION (bfd_und_section, 0, bfd_und_symbol, BFD_UND_SECTION_NAME, 1);
 622 STD_SECTION (bfd_abs_section, 0, bfd_abs_symbol, BFD_ABS_SECTION_NAME, 2);
 623 STD_SECTION (bfd_ind_section, 0, bfd_ind_symbol, BFD_IND_SECTION_NAME, 3);
 624 #undef STD_SECTION
 625
 626 /*
 627 DOCDD
 628 INODE
 629 section prototypes,  , typedef asection, Sections
 630 SUBSECTION
 631         Section prototypes
 632
 633 These are the functions exported by the section handling part of BFD.
 634 */
 635
 636 /*
 637 FUNCTION
 638         bfd_get_section_by_name
 639
 640 SYNOPSIS
 641         asection *bfd_get_section_by_name(bfd *abfd, const char *name);
 642
 643 DESCRIPTION
 644         Run through @var{abfd} and return the one of the
 645         <<asection>>s whose name matches @var{name}, otherwise <<NULL>>.
 646         @xref{Sections}, for more information.
 647
 648         This should only be used in special cases; the normal way to process
 649         all sections of a given name is to use <<bfd_map_over_sections>> and
 650         <<strcmp>> on the name (or better yet, base it on the section flags
 651         or something else) for each section.
 652 */
 653
 654 asection *
 655 bfd_get_section_by_name (abfd, name)
 656      bfd *abfd;
 657      const char *name;
 658 {
 659   asection *sect;
 660
 661   for (sect = abfd->sections; sect != NULL; sect = sect->next)
 662     if (!strcmp (sect->name, name))
 663       return sect;
 664   return NULL;
 665 }
 666
 667 /*
 668 FUNCTION
 669         bfd_get_unique_section_name
 670
 671 SYNOPSIS
 672         char *bfd_get_unique_section_name(bfd *abfd,
 673                                           const char *templat,
 674                                           int *count);
 675
 676 DESCRIPTION
 677         Invent a section name that is unique in @var{abfd} by tacking
 678         a dot and a digit suffix onto the original @var{templat}.  If
 679         @var{count} is non-NULL, then it specifies the first number
 680         tried as a suffix to generate a unique name.  The value
 681         pointed to by @var{count} will be incremented in this case.
 682 */
 683
 684 char *
 685 bfd_get_unique_section_name (abfd, templat, count)
 686      bfd *abfd;
 687      const char *templat;
 688      int *count;
 689 {
 690   int num;
 691   unsigned int len;
 692   char *sname;
 693
 694   len = strlen (templat);
 695   sname = bfd_malloc ((bfd_size_type) len + 8);
 696   if (sname == NULL)
 697     return NULL;
 698   strcpy (sname, templat);
 699   num = 1;
 700   if (count != NULL)
 701     num = *count;
 702
 703   do
 704     {
 705       /* If we have a million sections, something is badly wrong.  */
 706       if (num > 999999)
 707         abort ();
 708       sprintf (sname + len, ".%d", num++);
 709     }
 710   while (bfd_get_section_by_name (abfd, sname) != NULL);
 711
 712   if (count != NULL)
 713     *count = num;
 714   return sname;
 715 }
 716
 717 /*
 718 FUNCTION
 719         bfd_make_section_old_way
 720
 721 SYNOPSIS
 722         asection *bfd_make_section_old_way(bfd *abfd, const char *name);
 723
 724 DESCRIPTION
 725         Create a new empty section called @var{name}
 726         and attach it to the end of the chain of sections for the
 727         BFD @var{abfd}. An attempt to create a section with a name which
 728         is already in use returns its pointer without changing the
 729         section chain.
 730
 731         It has the funny name since this is the way it used to be
 732         before it was rewritten....
 733
 734         Possible errors are:
 735         o <<bfd_error_invalid_operation>> -
 736         If output has already started for this BFD.
 737         o <<bfd_error_no_memory>> -
 738         If memory allocation fails.
 739
 740 */
 741
 742 asection *
 743 bfd_make_section_old_way (abfd, name)
 744      bfd *abfd;
 745      const char *name;
 746 {
 747   asection *sec = bfd_get_section_by_name (abfd, name);
 748   if (sec == (asection *) NULL)
 749     {
 750       sec = bfd_make_section (abfd, name);
 751     }
 752   return sec;
 753 }
 754
 755 /*
 756 FUNCTION
 757         bfd_make_section_anyway
 758
 759 SYNOPSIS
 760         asection *bfd_make_section_anyway(bfd *abfd, const char *name);
 761
 762 DESCRIPTION
 763    Create a new empty section called @var{name} and attach it to the end of
 764    the chain of sections for @var{abfd}.  Create a new section even if there
 765    is already a section with that name.
 766
 767    Return <<NULL>> and set <<bfd_error>> on error; possible errors are:
 768    o <<bfd_error_invalid_operation>> - If output has already started for @var{abfd}.
 769    o <<bfd_error_no_memory>> - If memory allocation fails.
 770 */
 771
 772 sec_ptr
 773 bfd_make_section_anyway (abfd, name)
 774      bfd *abfd;
 775      const char *name;
 776 {
 777   static int section_id = 0x10;  /* id 0 to 3 used by STD_SECTION.  */
 778   asection *newsect;
 779   asection **prev = &abfd->sections;
 780   asection *sect = abfd->sections;
 781
 782   if (abfd->output_has_begun)
 783     {
 784       bfd_set_error (bfd_error_invalid_operation);
 785       return NULL;
 786     }
 787
 788   while (sect)
 789     {
 790       prev = &sect->next;
 791       sect = sect->next;
 792     }
 793
 794   newsect = (asection *) bfd_zalloc (abfd, (bfd_size_type) sizeof (asection));
 795   if (newsect == NULL)
 796     return NULL;
 797
 798   newsect->name = name;
 799   newsect->id = section_id++;
 800   newsect->index = abfd->section_count++;
 801   newsect->flags = SEC_NO_FLAGS;
 802
 803   newsect->userdata = NULL;
 804   newsect->contents = NULL;
 805   newsect->next = (asection *) NULL;
 806   newsect->relocation = (arelent *) NULL;
 807   newsect->reloc_count = 0;
 808   newsect->line_filepos = 0;
 809   newsect->owner = abfd;
 810   newsect->comdat = NULL;
 811
 812   /* Create a symbol whos only job is to point to this section. This is
 813      useful for things like relocs which are relative to the base of a
 814      section.  */
 815   newsect->symbol = bfd_make_empty_symbol (abfd);
 816   if (newsect->symbol == NULL)
 817     {
 818       bfd_release (abfd, newsect);
 819       return NULL;
 820     }
 821   newsect->symbol->name = name;
 822   newsect->symbol->value = 0;
 823   newsect->symbol->section = newsect;
 824   newsect->symbol->flags = BSF_SECTION_SYM;
 825
 826   newsect->symbol_ptr_ptr = &newsect->symbol;
 827
 828   if (BFD_SEND (abfd, _new_section_hook, (abfd, newsect)) != true)
 829     {
 830       bfd_release (abfd, newsect);
 831       return NULL;
 832     }
 833
 834   *prev = newsect;
 835   return newsect;
 836 }
 837
 838 /*
 839 FUNCTION
 840         bfd_make_section
 841
 842 SYNOPSIS
 843         asection *bfd_make_section(bfd *, const char *name);
 844
 845 DESCRIPTION
 846    Like <<bfd_make_section_anyway>>, but return <<NULL>> (without calling
 847    bfd_set_error ()) without changing the section chain if there is already a
 848    section named @var{name}.  If there is an error, return <<NULL>> and set
 849    <<bfd_error>>.
 850 */
 851
 852 asection *
 853 bfd_make_section (abfd, name)
 854      bfd *abfd;
 855      const char *name;
 856 {
 857   asection *sect = abfd->sections;
 858
 859   if (strcmp (name, BFD_ABS_SECTION_NAME) == 0)
 860     {
 861       return bfd_abs_section_ptr;
 862     }
 863   if (strcmp (name, BFD_COM_SECTION_NAME) == 0)
 864     {
 865       return bfd_com_section_ptr;
 866     }
 867   if (strcmp (name, BFD_UND_SECTION_NAME) == 0)
 868     {
 869       return bfd_und_section_ptr;
 870     }
 871
 872   if (strcmp (name, BFD_IND_SECTION_NAME) == 0)
 873     {
 874       return bfd_ind_section_ptr;
 875     }
 876
 877   while (sect)
 878     {
 879       if (!strcmp (sect->name, name))
 880         return NULL;
 881       sect = sect->next;
 882     }
 883
 884   /* The name is not already used; go ahead and make a new section.  */
 885   return bfd_make_section_anyway (abfd, name);
 886 }
 887
 888 /*
 889 FUNCTION
 890         bfd_set_section_flags
 891
 892 SYNOPSIS
 893         boolean bfd_set_section_flags(bfd *abfd, asection *sec, flagword flags);
 894
 895 DESCRIPTION
 896         Set the attributes of the section @var{sec} in the BFD
 897         @var{abfd} to the value @var{flags}. Return <<true>> on success,
 898         <<false>> on error. Possible error returns are:
 899
 900         o <<bfd_error_invalid_operation>> -
 901         The section cannot have one or more of the attributes
 902         requested. For example, a .bss section in <<a.out>> may not
 903         have the <<SEC_HAS_CONTENTS>> field set.
 904
 905 */
 906
 907 /*ARGSUSED*/
 908 boolean
 909 bfd_set_section_flags (abfd, section, flags)
 910      bfd *abfd ATTRIBUTE_UNUSED;
 911      sec_ptr section;
 912      flagword flags;
 913 {
 914 #if 0
 915   /* If you try to copy a text section from an input file (where it
 916      has the SEC_CODE flag set) to an output file, this loses big if
 917      the bfd_applicable_section_flags (abfd) doesn't have the SEC_CODE
 918      set - which it doesn't, at least not for a.out.  FIXME */
 919
 920   if ((flags & bfd_applicable_section_flags (abfd)) != flags)
 921     {
 922       bfd_set_error (bfd_error_invalid_operation);
 923       return false;
 924     }
 925 #endif
 926
 927   section->flags = flags;
 928   return true;
 929 }
 930
 931 /*
 932 FUNCTION
 933         bfd_map_over_sections
 934
 935 SYNOPSIS
 936         void bfd_map_over_sections(bfd *abfd,
 937                                    void (*func) (bfd *abfd,
 938                                                 asection *sect,
 939                                                 PTR obj),
 940                                    PTR obj);
 941
 942 DESCRIPTION
 943         Call the provided function @var{func} for each section
 944         attached to the BFD @var{abfd}, passing @var{obj} as an
 945         argument. The function will be called as if by
 946
 947 |       func(abfd, the_section, obj);
 948
 949         This is the prefered method for iterating over sections; an
 950         alternative would be to use a loop:
 951
 952 |          section *p;
 953 |          for (p = abfd->sections; p != NULL; p = p->next)
 954 |             func(abfd, p, ...)
 955
 956 */
 957
 958 /*VARARGS2*/
 959 void
 960 bfd_map_over_sections (abfd, operation, user_storage)
 961      bfd *abfd;
 962      void (*operation) PARAMS ((bfd * abfd, asection * sect, PTR obj));
 963      PTR user_storage;
 964 {
 965   asection *sect;
 966   unsigned int i = 0;
 967
 968   for (sect = abfd->sections; sect != NULL; i++, sect = sect->next)
 969     (*operation) (abfd, sect, user_storage);
 970
 971   if (i != abfd->section_count) /* Debugging */
 972     abort ();
 973 }
 974
 975 /*
 976 FUNCTION
 977         bfd_set_section_size
 978
 979 SYNOPSIS
 980         boolean bfd_set_section_size(bfd *abfd, asection *sec, bfd_size_type val);
 981
 982 DESCRIPTION
 983         Set @var{sec} to the size @var{val}. If the operation is
 984         ok, then <<true>> is returned, else <<false>>.
 985
 986         Possible error returns:
 987         o <<bfd_error_invalid_operation>> -
 988         Writing has started to the BFD, so setting the size is invalid.
 989
 990 */
 991
 992 boolean
 993 bfd_set_section_size (abfd, ptr, val)
 994      bfd *abfd;
 995      sec_ptr ptr;
 996      bfd_size_type val;
 997 {
 998   /* Once you've started writing to any section you cannot create or change
 999      the size of any others.  */
1000
1001   if (abfd->output_has_begun)
1002     {
1003       bfd_set_error (bfd_error_invalid_operation);
1004       return false;
1005     }
1006
1007   ptr->_cooked_size = val;
1008   ptr->_raw_size = val;
1009
1010   return true;
1011 }
1012
1013 /*
1014 FUNCTION
1015         bfd_set_section_contents
1016
1017 SYNOPSIS
1018         boolean bfd_set_section_contents (bfd *abfd, asection *section,
1019                                           PTR data, file_ptr offset,
1020                                           bfd_size_type count);
1021
1022 DESCRIPTION
1023         Sets the contents of the section @var{section} in BFD
1024         @var{abfd} to the data starting in memory at @var{data}. The
1025         data is written to the output section starting at offset
1026         @var{offset} for @var{count} octets.
1027
1028         Normally <<true>> is returned, else <<false>>. Possible error
1029         returns are:
1030         o <<bfd_error_no_contents>> -
1031         The output section does not have the <<SEC_HAS_CONTENTS>>
1032         attribute, so nothing can be written to it.
1033         o and some more too
1034
1035         This routine is front end to the back end function
1036         <<_bfd_set_section_contents>>.
1037
1038 */
1039
1040 #define bfd_get_section_size_now(abfd,sec) \
1041 (sec->reloc_done \
1042  ? bfd_get_section_size_after_reloc (sec) \
1043  : bfd_get_section_size_before_reloc (sec))
1044
1045 boolean
1046 bfd_set_section_contents (abfd, section, location, offset, count)
1047      bfd *abfd;
1048      sec_ptr section;
1049      PTR location;
1050      file_ptr offset;
1051      bfd_size_type count;
1052 {
1053   bfd_size_type sz;
1054
1055   if (!(bfd_get_section_flags (abfd, section) & SEC_HAS_CONTENTS))
1056     {
1057       bfd_set_error (bfd_error_no_contents);
1058       return (false);
1059     }
1060
1061   sz = bfd_get_section_size_now (abfd, section);
1062   if ((bfd_size_type) offset > sz
1063       || count > sz
1064       || offset + count > sz
1065       || count != (size_t) count)
1066     {
1067       bfd_set_error (bfd_error_bad_value);
1068       return false;
1069     }
1070
1071   switch (abfd->direction)
1072     {
1073     case read_direction:
1074     case no_direction:
1075       bfd_set_error (bfd_error_invalid_operation);
1076       return false;
1077
1078     case write_direction:
1079       break;
1080
1081     case both_direction:
1082       /* File is opened for update. `output_has_begun' some time ago when
1083            the file was created.  Do not recompute sections sizes or alignments
1084            in _bfd_set_section_content.  */
1085       abfd->output_has_begun = true;
1086       break;
1087     }
1088
1089   /* Record a copy of the data in memory if desired.  */
1090   if (section->contents
1091       && location != section->contents + offset)
1092     memcpy (section->contents + offset, location, (size_t) count);
1093
1094   if (BFD_SEND (abfd, _bfd_set_section_contents,
1095                 (abfd, section, location, offset, count)))
1096     {
1097       abfd->output_has_begun = true;
1098       return true;
1099     }
1100
1101   return false;
1102 }
1103
1104 /*
1105 FUNCTION
1106         bfd_get_section_contents
1107
1108 SYNOPSIS
1109         boolean bfd_get_section_contents (bfd *abfd, asection *section,
1110                                           PTR location, file_ptr offset,
1111                                           bfd_size_type count);
1112
1113 DESCRIPTION
1114         Read data from @var{section} in BFD @var{abfd}
1115         into memory starting at @var{location}. The data is read at an
1116         offset of @var{offset} from the start of the input section,
1117         and is read for @var{count} bytes.
1118
1119         If the contents of a constructor with the <<SEC_CONSTRUCTOR>>
1120         flag set are requested or if the section does not have the
1121         <<SEC_HAS_CONTENTS>> flag set, then the @var{location} is filled
1122         with zeroes. If no errors occur, <<true>> is returned, else
1123         <<false>>.
1124
1125 */
1126 boolean
1127 bfd_get_section_contents (abfd, section, location, offset, count)
1128      bfd *abfd;
1129      sec_ptr section;
1130      PTR location;
1131      file_ptr offset;
1132      bfd_size_type count;
1133 {
1134   bfd_size_type sz;
1135
1136   if (section->flags & SEC_CONSTRUCTOR)
1137     {
1138       memset (location, 0, (size_t) count);
1139       return true;
1140     }
1141
1142   /* Even if reloc_done is true, this function reads unrelocated
1143      contents, so we want the raw size.  */
1144   sz = section->_raw_size;
1145   if ((bfd_size_type) offset > sz
1146       || count > sz
1147       || offset + count > sz
1148       || count != (size_t) count)
1149     {
1150       bfd_set_error (bfd_error_bad_value);
1151       return false;
1152     }
1153
1154   if (count == 0)
1155     /* Don't bother.  */
1156     return true;
1157
1158   if ((section->flags & SEC_HAS_CONTENTS) == 0)
1159     {
1160       memset (location, 0, (size_t) count);
1161       return true;
1162     }
1163
1164   if ((section->flags & SEC_IN_MEMORY) != 0)
1165     {
1166       memcpy (location, section->contents + offset, (size_t) count);
1167       return true;
1168     }
1169
1170   return BFD_SEND (abfd, _bfd_get_section_contents,
1171                    (abfd, section, location, offset, count));
1172 }
1173
1174 /*
1175 FUNCTION
1176         bfd_copy_private_section_data
1177
1178 SYNOPSIS
1179         boolean bfd_copy_private_section_data (bfd *ibfd, asection *isec,
1180                                                bfd *obfd, asection *osec);
1181
1182 DESCRIPTION
1183         Copy private section information from @var{isec} in the BFD
1184         @var{ibfd} to the section @var{osec} in the BFD @var{obfd}.
1185         Return <<true>> on success, <<false>> on error.  Possible error
1186         returns are:
1187
1188         o <<bfd_error_no_memory>> -
1189         Not enough memory exists to create private data for @var{osec}.
1190
1191 .#define bfd_copy_private_section_data(ibfd, isection, obfd, osection) \
1192 .     BFD_SEND (obfd, _bfd_copy_private_section_data, \
1193 .               (ibfd, isection, obfd, osection))
1194 */
1195
1196 /*
1197 FUNCTION
1198         _bfd_strip_section_from_output
1199
1200 SYNOPSIS
1201         void _bfd_strip_section_from_output
1202         (struct bfd_link_info *info, asection *section);
1203
1204 DESCRIPTION
1205         Remove @var{section} from the output.  If the output section
1206         becomes empty, remove it from the output bfd.  @var{info} may
1207         be NULL; if it is not, it is used to decide whether the output
1208         section is empty.
1209 */
1210 void
1211 _bfd_strip_section_from_output (info, s)
1212      struct bfd_link_info *info;
1213      asection *s;
1214 {
1215   asection **spp, *os;
1216   struct bfd_link_order *p, *pp;
1217   boolean keep_os;
1218
1219   /* Excise the input section from the link order.
1220
1221      FIXME: For all calls that I can see to this function, the link
1222      orders have not yet been set up.  So why are we checking them? --
1223      Ian */
1224   os = s->output_section;
1225
1226   /* Handle a section that wasn't output.  */
1227   if (os == NULL)
1228     return;
1229
1230   for (p = os->link_order_head, pp = NULL; p != NULL; pp = p, p = p->next)
1231     if (p->type == bfd_indirect_link_order
1232         && p->u.indirect.section == s)
1233       {
1234         if (pp)
1235           pp->next = p->next;
1236         else
1237           os->link_order_head = p->next;
1238         if (!p->next)
1239           os->link_order_tail = pp;
1240         break;
1241       }
1242
1243   keep_os = os->link_order_head != NULL;
1244
1245   if (! keep_os && info != NULL)
1246     {
1247       bfd *abfd;
1248       for (abfd = info->input_bfds; abfd != NULL; abfd = abfd->link_next)
1249         {
1250           asection *is;
1251           for (is = abfd->sections; is != NULL; is = is->next)
1252             {
1253               if (is != s && is->output_section == os)
1254                 break;
1255             }
1256           if (is != NULL)
1257             break;
1258         }
1259       if (abfd != NULL)
1260         keep_os = true;
1261     }
1262
1263   /* If the output section is empty, remove it too.  Careful about sections
1264      that have been discarded in the link script -- they are mapped to
1265      bfd_abs_section, which has no owner.  */
1266   if (!keep_os && os->owner != NULL)
1267     {
1268       for (spp = &os->owner->sections; *spp; spp = &(*spp)->next)
1269         if (*spp == os)
1270           {
1271             *spp = os->next;
1272             os->owner->section_count--;
1273             break;
1274           }
1275     }
1276 }