bfd/section.c

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