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