bfd/section.c

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