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