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