Don't generate PLT for IFUNC GOT/pointer reference
[deliverable/binutils-gdb.git] / bfd / bfd.c
CommitLineData
252b5132 1/* Generic BFD library interface and support routines.
6f2750fe 2 Copyright (C) 1990-2016 Free Software Foundation, Inc.
252b5132
RH
3 Written by Cygnus Support.
4
3af9a47b 5 This file is part of BFD, the Binary File Descriptor library.
252b5132 6
3af9a47b
NC
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
cd123cb7 9 the Free Software Foundation; either version 3 of the License, or
3af9a47b 10 (at your option) any later version.
252b5132 11
3af9a47b
NC
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
252b5132 16
3af9a47b
NC
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
cd123cb7
NC
19 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
20 MA 02110-1301, USA. */
252b5132
RH
21
22/*
79bb5c23
NC
23INODE
24typedef bfd, Error reporting, BFD front end, BFD front end
25
252b5132
RH
26SECTION
27 <<typedef bfd>>
28
29 A BFD has type <<bfd>>; objects of this type are the
30 cornerstone of any application using BFD. Using BFD
31 consists of making references though the BFD and to data in the BFD.
32
33 Here is the structure that defines the type <<bfd>>. It
34 contains the major data about the file and pointers
35 to the rest of the data.
36
37CODE_FRAGMENT
38.
a50b1753
NC
39.enum bfd_direction
40. {
41. no_direction = 0,
42. read_direction = 1,
43. write_direction = 2,
44. both_direction = 3
45. };
46.
5ae0078c
L
47.enum bfd_plugin_format
48. {
49. bfd_plugin_uknown = 0,
50. bfd_plugin_yes = 1,
51. bfd_plugin_no = 2
52. };
53.
c74f7d1c
JT
54.struct bfd_build_id
55. {
56f40832 56. bfd_size_type size;
c74f7d1c
JT
57. bfd_byte data[1];
58. };
59.
c2852e88 60.struct bfd
252b5132 61.{
b5f79c76
NC
62. {* The filename the application opened the BFD with. *}
63. const char *filename;
252b5132 64.
b5f79c76
NC
65. {* A pointer to the target jump table. *}
66. const struct bfd_target *xvec;
252b5132 67.
40838a72
AC
68. {* The IOSTREAM, and corresponding IO vector that provide access
69. to the file backing the BFD. *}
c58b9523 70. void *iostream;
40838a72 71. const struct bfd_iovec *iovec;
b5f79c76 72.
b5f79c76
NC
73. {* The caching routines use these to maintain a
74. least-recently-used list of BFDs. *}
2ce40c65 75. struct bfd *lru_prev, *lru_next;
b5f79c76
NC
76.
77. {* When a file is closed by the caching routines, BFD retains
78. state information on the file here... *}
79. ufile_ptr where;
80.
b34976b6 81. {* File modified time, if mtime_set is TRUE. *}
b5f79c76
NC
82. long mtime;
83.
b6a1c03a
AM
84. {* A unique identifier of the BFD *}
85. unsigned int id;
b5f79c76
NC
86.
87. {* The format which belongs to the BFD. (object, core, etc.) *}
b6a1c03a 88. ENUM_BITFIELD (bfd_format) format : 3;
b5f79c76
NC
89.
90. {* The direction with which the BFD was opened. *}
b6a1c03a 91. ENUM_BITFIELD (bfd_direction) direction : 2;
b5f79c76
NC
92.
93. {* Format_specific flags. *}
b8871f35 94. flagword flags : 20;
b5f79c76 95.
6ad2759d
L
96. {* Values that may appear in the flags field of a BFD. These also
97. appear in the object_flags field of the bfd_target structure, where
98. they indicate the set of flags used by that backend (not all flags
99. are meaningful for all object file formats) (FIXME: at the moment,
100. the object_flags values have mostly just been copied from backend
101. to another, and are not necessarily correct). *}
102.
103.#define BFD_NO_FLAGS 0x00
104.
105. {* BFD contains relocation entries. *}
106.#define HAS_RELOC 0x01
107.
108. {* BFD is directly executable. *}
109.#define EXEC_P 0x02
110.
111. {* BFD has line number information (basically used for F_LNNO in a
112. COFF header). *}
113.#define HAS_LINENO 0x04
114.
115. {* BFD has debugging information. *}
116.#define HAS_DEBUG 0x08
117.
118. {* BFD has symbols. *}
119.#define HAS_SYMS 0x10
120.
121. {* BFD has local symbols (basically used for F_LSYMS in a COFF
122. header). *}
123.#define HAS_LOCALS 0x20
124.
125. {* BFD is a dynamic object. *}
126.#define DYNAMIC 0x40
127.
128. {* Text section is write protected (if D_PAGED is not set, this is
129. like an a.out NMAGIC file) (the linker sets this by default, but
130. clears it for -r or -N). *}
131.#define WP_TEXT 0x80
132.
133. {* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the
134. linker sets this by default, but clears it for -r or -n or -N). *}
135.#define D_PAGED 0x100
136.
137. {* BFD is relaxable (this means that bfd_relax_section may be able to
138. do something) (sometimes bfd_relax_section can do something even if
139. this is not set). *}
140.#define BFD_IS_RELAXABLE 0x200
141.
142. {* This may be set before writing out a BFD to request using a
143. traditional format. For example, this is used to request that when
144. writing out an a.out object the symbols not be hashed to eliminate
145. duplicates. *}
146.#define BFD_TRADITIONAL_FORMAT 0x400
147.
148. {* This flag indicates that the BFD contents are actually cached
149. in memory. If this is set, iostream points to a bfd_in_memory
150. struct. *}
151.#define BFD_IN_MEMORY 0x800
152.
6ad2759d
L
153. {* This BFD has been created by the linker and doesn't correspond
154. to any input file. *}
b6a1c03a 155.#define BFD_LINKER_CREATED 0x1000
6ad2759d 156.
36e4dce6
CD
157. {* This may be set before writing out a BFD to request that it
158. be written using values for UIDs, GIDs, timestamps, etc. that
159. will be consistent from run to run. *}
b6a1c03a 160.#define BFD_DETERMINISTIC_OUTPUT 0x2000
36e4dce6 161.
4a114e3e 162. {* Compress sections in this BFD. *}
b6a1c03a 163.#define BFD_COMPRESS 0x4000
4a114e3e
L
164.
165. {* Decompress sections in this BFD. *}
b6a1c03a 166.#define BFD_DECOMPRESS 0x8000
4a114e3e 167.
9e2278f5 168. {* BFD is a dummy, for plugins. *}
b6a1c03a 169.#define BFD_PLUGIN 0x10000
9e2278f5 170.
151411f8
L
171. {* Compress sections in this BFD with SHF_COMPRESSED from gABI. *}
172.#define BFD_COMPRESS_GABI 0x20000
173.
b8871f35
L
174. {* Convert ELF common symbol type to STT_COMMON or STT_OBJECT in this
175. BFD. *}
176.#define BFD_CONVERT_ELF_COMMON 0x40000
177.
178. {* Use the ELF STT_COMMON type in this BFD. *}
179.#define BFD_USE_ELF_STT_COMMON 0x80000
180.
4a114e3e
L
181. {* Flags bits to be saved in bfd_preserve_save. *}
182.#define BFD_FLAGS_SAVED \
151411f8 183. (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_PLUGIN \
b8871f35 184. | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
4a114e3e 185.
6b6bc957
L
186. {* Flags bits which are for BFD use only. *}
187.#define BFD_FLAGS_FOR_BFD_USE_MASK \
188. (BFD_IN_MEMORY | BFD_COMPRESS | BFD_DECOMPRESS | BFD_LINKER_CREATED \
151411f8 189. | BFD_PLUGIN | BFD_TRADITIONAL_FORMAT | BFD_DETERMINISTIC_OUTPUT \
b8871f35 190. | BFD_COMPRESS_GABI | BFD_CONVERT_ELF_COMMON | BFD_USE_ELF_STT_COMMON)
6b6bc957 191.
b6a1c03a
AM
192. {* Is the file descriptor being cached? That is, can it be closed as
193. needed, and re-opened when accessed later? *}
194. unsigned int cacheable : 1;
195.
196. {* Marks whether there was a default target specified when the
197. BFD was opened. This is used to select which matching algorithm
198. to use to choose the back end. *}
199. unsigned int target_defaulted : 1;
200.
201. {* ... and here: (``once'' means at least once). *}
202. unsigned int opened_once : 1;
203.
204. {* Set if we have a locally maintained mtime value, rather than
205. getting it from the file each time. *}
206. unsigned int mtime_set : 1;
207.
208. {* Flag set if symbols from this BFD should not be exported. *}
209. unsigned int no_export : 1;
210.
211. {* Remember when output has begun, to stop strange things
212. from happening. *}
213. unsigned int output_has_begun : 1;
214.
215. {* Have archive map. *}
216. unsigned int has_armap : 1;
217.
218. {* Set if this is a thin archive. *}
219. unsigned int is_thin_archive : 1;
220.
221. {* Set if only required symbols should be added in the link hash table for
222. this object. Used by VMS linkers. *}
223. unsigned int selective_search : 1;
224.
225. {* Set if this is the linker output BFD. *}
226. unsigned int is_linker_output : 1;
227.
f6fe1ccd
L
228. {* Set if this is the linker input BFD. *}
229. unsigned int is_linker_input : 1;
230.
5ae0078c
L
231. {* If this is an input for a compiler plug-in library. *}
232. ENUM_BITFIELD (bfd_plugin_format) plugin_format : 2;
233.
ce875075
AM
234. {* Set if this is a plugin output file. *}
235. unsigned int lto_output : 1;
236.
5ae0078c
L
237. {* Set to dummy BFD created when claimed by a compiler plug-in
238. library. *}
239. bfd *plugin_dummy_bfd;
240.
b5f79c76
NC
241. {* Currently my_archive is tested before adding origin to
242. anything. I believe that this can become always an add of
243. origin, with origin set to 0 for non archive files. *}
244. ufile_ptr origin;
245.
a8da6403
NC
246. {* The origin in the archive of the proxy entry. This will
247. normally be the same as origin, except for thin archives,
248. when it will contain the current offset of the proxy in the
249. thin archive rather than the offset of the bfd in its actual
250. container. *}
251. ufile_ptr proxy_origin;
252.
b5f79c76
NC
253. {* A hash table for section names. *}
254. struct bfd_hash_table section_htab;
255.
256. {* Pointer to linked list of sections. *}
198beae2 257. struct bfd_section *sections;
b5f79c76 258.
5daa8fe7
L
259. {* The last section on the section list. *}
260. struct bfd_section *section_last;
b5f79c76
NC
261.
262. {* The number of sections. *}
263. unsigned int section_count;
264.
b6a1c03a
AM
265. {* A field used by _bfd_generic_link_add_archive_symbols. This will
266. be used only for archive elements. *}
267. int archive_pass;
268.
b5f79c76
NC
269. {* Stuff only useful for object files:
270. The start address. *}
271. bfd_vma start_address;
272.
5c1d2f5f
AM
273. {* Symbol table for output BFD (with symcount entries).
274. Also used by the linker to cache input BFD symbols. *}
fc0a2244 275. struct bfd_symbol **outsymbols;
b5f79c76 276.
b6a1c03a
AM
277. {* Used for input and output. *}
278. unsigned int symcount;
279.
1f70368c
DJ
280. {* Used for slurped dynamic symbol tables. *}
281. unsigned int dynsymcount;
282.
b5f79c76
NC
283. {* Pointer to structure which contains architecture information. *}
284. const struct bfd_arch_info *arch_info;
285.
286. {* Stuff only useful for archives. *}
c58b9523 287. void *arelt_data;
2ce40c65 288. struct bfd *my_archive; {* The containing archive BFD. *}
cc481421 289. struct bfd *archive_next; {* The next BFD in the archive. *}
2ce40c65 290. struct bfd *archive_head; {* The first BFD in the archive. *}
a8da6403
NC
291. struct bfd *nested_archives; {* List of nested archive in a flattened
292. thin archive. *}
252b5132 293.
c72f2fb2
AM
294. union {
295. {* For input BFDs, a chain of BFDs involved in a link. *}
296. struct bfd *next;
297. {* For output BFD, the linker hash table. *}
298. struct bfd_link_hash_table *hash;
299. } link;
b5f79c76 300.
b5f79c76
NC
301. {* Used by the back end to hold private data. *}
302. union
303. {
252b5132
RH
304. struct aout_data_struct *aout_data;
305. struct artdata *aout_ar_data;
306. struct _oasys_data *oasys_obj_data;
307. struct _oasys_ar_data *oasys_ar_data;
308. struct coff_tdata *coff_obj_data;
309. struct pe_tdata *pe_obj_data;
310. struct xcoff_tdata *xcoff_obj_data;
311. struct ecoff_tdata *ecoff_obj_data;
312. struct ieee_data_struct *ieee_data;
313. struct ieee_ar_data_struct *ieee_ar_data;
314. struct srec_data_struct *srec_data;
c067354b 315. struct verilog_data_struct *verilog_data;
252b5132
RH
316. struct ihex_data_struct *ihex_data;
317. struct tekhex_data_struct *tekhex_data;
318. struct elf_obj_tdata *elf_obj_data;
319. struct nlm_obj_tdata *nlm_obj_data;
320. struct bout_data_struct *bout_data;
3c3bdf30 321. struct mmo_data_struct *mmo_data;
252b5132
RH
322. struct sun_core_struct *sun_core_data;
323. struct sco5_core_struct *sco5_core_data;
324. struct trad_core_struct *trad_core_data;
325. struct som_data_struct *som_data;
326. struct hpux_core_struct *hpux_core_data;
327. struct hppabsd_core_struct *hppabsd_core_data;
328. struct sgi_core_struct *sgi_core_data;
329. struct lynx_core_struct *lynx_core_data;
330. struct osf_core_struct *osf_core_data;
331. struct cisco_core_struct *cisco_core_data;
332. struct versados_data_struct *versados_data;
333. struct netbsd_core_struct *netbsd_core_data;
3af9a47b
NC
334. struct mach_o_data_struct *mach_o_data;
335. struct mach_o_fat_data_struct *mach_o_fat_data;
ce3c775b 336. struct plugin_data_struct *plugin_data;
3af9a47b
NC
337. struct bfd_pef_data_struct *pef_data;
338. struct bfd_pef_xlib_data_struct *pef_xlib_data;
339. struct bfd_sym_data_struct *sym_data;
c58b9523 340. void *any;
b5f79c76
NC
341. }
342. tdata;
aebad5fe 343.
b5f79c76 344. {* Used by the application to hold private data. *}
c58b9523 345. void *usrdata;
252b5132
RH
346.
347. {* Where all the allocated stuff under this BFD goes. This is a
c58b9523
AM
348. struct objalloc *, but we use void * to avoid requiring the inclusion
349. of objalloc.h. *}
350. void *memory;
c74f7d1c
JT
351.
352. {* For input BFDs, the build ID, if the object has one. *}
353. const struct bfd_build_id *build_id;
252b5132
RH
354.};
355.
27b829ee
NC
356.{* See note beside bfd_set_section_userdata. *}
357.static inline bfd_boolean
358.bfd_set_cacheable (bfd * abfd, bfd_boolean val)
359.{
360. abfd->cacheable = val;
361. return TRUE;
362.}
363.
252b5132
RH
364*/
365
252b5132 366#include "sysdep.h"
252b5132 367#include <stdarg.h>
3db64b00
AM
368#include "bfd.h"
369#include "bfdver.h"
252b5132 370#include "libiberty.h"
3fad56a3 371#include "demangle.h"
3882b010 372#include "safe-ctype.h"
252b5132
RH
373#include "bfdlink.h"
374#include "libbfd.h"
375#include "coff/internal.h"
376#include "coff/sym.h"
377#include "libcoff.h"
378#include "libecoff.h"
379#undef obj_symbols
380#include "elf-bfd.h"
3168356f
AM
381
382#ifndef EXIT_FAILURE
383#define EXIT_FAILURE 1
384#endif
385
252b5132
RH
386\f
387/* provide storage for subsystem, stack and heap data which may have been
388 passed in on the command line. Ld puts this data into a bfd_link_info
389 struct which ultimately gets passed in to the bfd. When it arrives, copy
390 it to the following struct so that the data will be available in coffcode.h
391 where it is needed. The typedef's used are defined in bfd.h */
252b5132
RH
392\f
393/*
79bb5c23
NC
394INODE
395Error reporting, Miscellaneous, typedef bfd, BFD front end
396
252b5132
RH
397SECTION
398 Error reporting
399
400 Most BFD functions return nonzero on success (check their
401 individual documentation for precise semantics). On an error,
402 they call <<bfd_set_error>> to set an error condition that callers
403 can check by calling <<bfd_get_error>>.
404 If that returns <<bfd_error_system_call>>, then check
405 <<errno>>.
406
407 The easiest way to report a BFD error to the user is to
408 use <<bfd_perror>>.
409
410SUBSECTION
411 Type <<bfd_error_type>>
412
413 The values returned by <<bfd_get_error>> are defined by the
414 enumerated type <<bfd_error_type>>.
415
416CODE_FRAGMENT
417.
418.typedef enum bfd_error
419.{
420. bfd_error_no_error = 0,
421. bfd_error_system_call,
422. bfd_error_invalid_target,
423. bfd_error_wrong_format,
3619ad04 424. bfd_error_wrong_object_format,
252b5132
RH
425. bfd_error_invalid_operation,
426. bfd_error_no_memory,
427. bfd_error_no_symbols,
428. bfd_error_no_armap,
429. bfd_error_no_more_archived_files,
430. bfd_error_malformed_archive,
ff5ac77b 431. bfd_error_missing_dso,
252b5132
RH
432. bfd_error_file_not_recognized,
433. bfd_error_file_ambiguously_recognized,
434. bfd_error_no_contents,
435. bfd_error_nonrepresentable_section,
436. bfd_error_no_debug_section,
437. bfd_error_bad_value,
438. bfd_error_file_truncated,
439. bfd_error_file_too_big,
ffda70fc 440. bfd_error_on_input,
252b5132 441. bfd_error_invalid_error_code
b5f79c76
NC
442.}
443.bfd_error_type;
252b5132
RH
444.
445*/
446
447static bfd_error_type bfd_error = bfd_error_no_error;
ffda70fc
AM
448static bfd *input_bfd = NULL;
449static bfd_error_type input_error = bfd_error_no_error;
252b5132 450
55ab10f0
NC
451const char *const bfd_errmsgs[] =
452{
453 N_("No error"),
454 N_("System call error"),
455 N_("Invalid bfd target"),
456 N_("File in wrong format"),
3619ad04 457 N_("Archive object file in wrong format"),
55ab10f0
NC
458 N_("Invalid operation"),
459 N_("Memory exhausted"),
460 N_("No symbols"),
461 N_("Archive has no index; run ranlib to add one"),
462 N_("No more archived files"),
463 N_("Malformed archive"),
ff5ac77b 464 N_("DSO missing from command line"),
55ab10f0
NC
465 N_("File format not recognized"),
466 N_("File format is ambiguous"),
467 N_("Section has no contents"),
468 N_("Nonrepresentable section on output"),
469 N_("Symbol needs debug section which does not exist"),
470 N_("Bad value"),
471 N_("File truncated"),
472 N_("File too big"),
ffda70fc 473 N_("Error reading %s: %s"),
55ab10f0
NC
474 N_("#<Invalid error code>")
475};
252b5132
RH
476
477/*
478FUNCTION
479 bfd_get_error
480
481SYNOPSIS
482 bfd_error_type bfd_get_error (void);
483
484DESCRIPTION
485 Return the current BFD error condition.
486*/
487
488bfd_error_type
c58b9523 489bfd_get_error (void)
252b5132
RH
490{
491 return bfd_error;
492}
493
494/*
495FUNCTION
496 bfd_set_error
497
498SYNOPSIS
ffda70fc 499 void bfd_set_error (bfd_error_type error_tag, ...);
252b5132
RH
500
501DESCRIPTION
502 Set the BFD error condition to be @var{error_tag}.
ffda70fc
AM
503 If @var{error_tag} is bfd_error_on_input, then this function
504 takes two more parameters, the input bfd where the error
505 occurred, and the bfd_error_type error.
252b5132
RH
506*/
507
508void
ffda70fc 509bfd_set_error (bfd_error_type error_tag, ...)
252b5132
RH
510{
511 bfd_error = error_tag;
ffda70fc
AM
512 if (error_tag == bfd_error_on_input)
513 {
514 /* This is an error that occurred during bfd_close when
515 writing an archive, but on one of the input files. */
516 va_list ap;
517
518 va_start (ap, error_tag);
519 input_bfd = va_arg (ap, bfd *);
a50b1753 520 input_error = (bfd_error_type) va_arg (ap, int);
ffda70fc
AM
521 if (input_error >= bfd_error_on_input)
522 abort ();
523 va_end (ap);
524 }
252b5132
RH
525}
526
527/*
528FUNCTION
529 bfd_errmsg
530
531SYNOPSIS
55ab10f0 532 const char *bfd_errmsg (bfd_error_type error_tag);
252b5132
RH
533
534DESCRIPTION
535 Return a string describing the error @var{error_tag}, or
536 the system error if @var{error_tag} is <<bfd_error_system_call>>.
537*/
538
55ab10f0 539const char *
c58b9523 540bfd_errmsg (bfd_error_type error_tag)
252b5132
RH
541{
542#ifndef errno
543 extern int errno;
544#endif
ffda70fc
AM
545 if (error_tag == bfd_error_on_input)
546 {
547 char *buf;
548 const char *msg = bfd_errmsg (input_error);
549
550 if (asprintf (&buf, _(bfd_errmsgs [error_tag]), input_bfd->filename, msg)
551 != -1)
552 return buf;
553
554 /* Ick, what to do on out of memory? */
555 return msg;
556 }
557
252b5132
RH
558 if (error_tag == bfd_error_system_call)
559 return xstrerror (errno);
560
c58b9523
AM
561 if (error_tag > bfd_error_invalid_error_code)
562 error_tag = bfd_error_invalid_error_code; /* sanity check */
252b5132 563
c58b9523 564 return _(bfd_errmsgs [error_tag]);
252b5132
RH
565}
566
567/*
568FUNCTION
569 bfd_perror
570
571SYNOPSIS
55ab10f0 572 void bfd_perror (const char *message);
252b5132
RH
573
574DESCRIPTION
575 Print to the standard error stream a string describing the
576 last BFD error that occurred, or the last system error if
577 the last BFD error was a system call failure. If @var{message}
578 is non-NULL and non-empty, the error string printed is preceded
579 by @var{message}, a colon, and a space. It is followed by a newline.
580*/
581
582void
c58b9523 583bfd_perror (const char *message)
252b5132 584{
4a97a0e5 585 fflush (stdout);
ffda70fc
AM
586 if (message == NULL || *message == '\0')
587 fprintf (stderr, "%s\n", bfd_errmsg (bfd_get_error ()));
55ab10f0 588 else
ffda70fc 589 fprintf (stderr, "%s: %s\n", message, bfd_errmsg (bfd_get_error ()));
4a97a0e5 590 fflush (stderr);
252b5132
RH
591}
592
593/*
594SUBSECTION
595 BFD error handler
596
597 Some BFD functions want to print messages describing the
598 problem. They call a BFD error handler function. This
5c4491d3 599 function may be overridden by the program.
252b5132
RH
600
601 The BFD error handler acts like printf.
602
603CODE_FRAGMENT
604.
c58b9523 605.typedef void (*bfd_error_handler_type) (const char *, ...);
252b5132
RH
606.
607*/
608
609/* The program name used when printing BFD error messages. */
610
611static const char *_bfd_error_program_name;
612
d003868e
AM
613/* This is the default routine to handle BFD error messages.
614 Like fprintf (stderr, ...), but also handles some extra format specifiers.
615
616 %A section name from section. For group components, print group name too.
617 %B file name from bfd. For archive components, prints archive too.
d07676f8
NC
618
619 Note - because these two extra format specifiers require special handling
620 they are scanned for and processed in this function, before calling
621 vfprintf. This means that the *arguments* for these format specifiers
622 must be the first ones in the variable argument list, regardless of where
623 the specifiers appear in the format string. Thus for example calling
624 this function with a format string of:
625
626 "blah %s blah %A blah %d blah %B"
627
628 would involve passing the arguments as:
629
630 "blah %s blah %A blah %d blah %B",
631 asection_for_the_%A,
632 bfd_for_the_%B,
633 string_for_the_%s,
634 integer_for_the_%d);
d003868e 635 */
252b5132 636
185d09ad 637void
d003868e 638_bfd_default_error_handler (const char *fmt, ...)
252b5132 639{
d003868e
AM
640 va_list ap;
641 char *bufp;
642 const char *new_fmt, *p;
643 size_t avail = 1000;
644 char buf[1000];
c58b9523 645
0bc43230
AM
646 /* PR 4992: Don't interrupt output being sent to stdout. */
647 fflush (stdout);
648
252b5132
RH
649 if (_bfd_error_program_name != NULL)
650 fprintf (stderr, "%s: ", _bfd_error_program_name);
651 else
652 fprintf (stderr, "BFD: ");
653
d003868e
AM
654 va_start (ap, fmt);
655 new_fmt = fmt;
656 bufp = buf;
657
658 /* Reserve enough space for the existing format string. */
659 avail -= strlen (fmt) + 1;
660 if (avail > 1000)
3168356f 661 _exit (EXIT_FAILURE);
d003868e
AM
662
663 p = fmt;
3e540f25 664 while (1)
d003868e
AM
665 {
666 char *q;
667 size_t len, extra, trim;
668
669 p = strchr (p, '%');
670 if (p == NULL || p[1] == '\0')
671 {
672 if (new_fmt == buf)
673 {
674 len = strlen (fmt);
675 memcpy (bufp, fmt, len + 1);
676 }
677 break;
678 }
679
680 if (p[1] == 'A' || p[1] == 'B')
681 {
682 len = p - fmt;
683 memcpy (bufp, fmt, len);
684 bufp += len;
685 fmt = p + 2;
686 new_fmt = buf;
687
688 /* If we run out of space, tough, you lose your ridiculously
689 long file or section name. It's not safe to try to alloc
690 memory here; We might be printing an out of memory message. */
691 if (avail == 0)
692 {
693 *bufp++ = '*';
694 *bufp++ = '*';
695 *bufp = '\0';
696 }
697 else
698 {
699 if (p[1] == 'B')
700 {
701 bfd *abfd = va_arg (ap, bfd *);
d07676f8
NC
702
703 if (abfd == NULL)
704 /* Invoking %B with a null bfd pointer is an internal error. */
705 abort ();
b0cffb47
AM
706 else if (abfd->my_archive
707 && !bfd_is_thin_archive (abfd->my_archive))
d003868e
AM
708 snprintf (bufp, avail, "%s(%s)",
709 abfd->my_archive->filename, abfd->filename);
710 else
711 snprintf (bufp, avail, "%s", abfd->filename);
712 }
713 else
714 {
715 asection *sec = va_arg (ap, asection *);
d07676f8 716 bfd *abfd;
d003868e
AM
717 const char *group = NULL;
718 struct coff_comdat_info *ci;
719
d07676f8
NC
720 if (sec == NULL)
721 /* Invoking %A with a null section pointer is an internal error. */
722 abort ();
723 abfd = sec->owner;
d003868e
AM
724 if (abfd != NULL
725 && bfd_get_flavour (abfd) == bfd_target_elf_flavour
726 && elf_next_in_group (sec) != NULL
727 && (sec->flags & SEC_GROUP) == 0)
728 group = elf_group_name (sec);
729 else if (abfd != NULL
730 && bfd_get_flavour (abfd) == bfd_target_coff_flavour
731 && (ci = bfd_coff_get_comdat_section (sec->owner,
732 sec)) != NULL)
733 group = ci->name;
734 if (group != NULL)
735 snprintf (bufp, avail, "%s[%s]", sec->name, group);
736 else
737 snprintf (bufp, avail, "%s", sec->name);
738 }
739 len = strlen (bufp);
740 avail = avail - len + 2;
741
742 /* We need to replace any '%' we printed by "%%".
743 First count how many. */
744 q = bufp;
745 bufp += len;
746 extra = 0;
747 while ((q = strchr (q, '%')) != NULL)
748 {
749 ++q;
750 ++extra;
751 }
752
753 /* If there isn't room, trim off the end of the string. */
754 q = bufp;
755 bufp += extra;
756 if (extra > avail)
757 {
758 trim = extra - avail;
759 bufp -= trim;
760 do
761 {
762 if (*--q == '%')
763 --extra;
764 }
765 while (--trim != 0);
766 *q = '\0';
45fc9e4a 767 avail = extra;
d003868e 768 }
45fc9e4a 769 avail -= extra;
d003868e
AM
770
771 /* Now double all '%' chars, shuffling the string as we go. */
772 while (extra != 0)
773 {
774 while ((q[extra] = *q) != '%')
775 --q;
776 q[--extra] = '%';
777 --q;
778 }
779 }
780 }
781 p = p + 2;
782 }
783
784 vfprintf (stderr, new_fmt, ap);
785 va_end (ap);
252b5132 786
ceae87f3
JB
787 /* On AIX, putc is implemented as a macro that triggers a -Wunused-value
788 warning, so use the fputc function to avoid it. */
789 fputc ('\n', stderr);
4a97a0e5 790 fflush (stderr);
252b5132
RH
791}
792
252b5132
RH
793/* This is a function pointer to the routine which should handle BFD
794 error messages. It is called when a BFD routine encounters an
795 error for which it wants to print a message. Going through a
796 function pointer permits a program linked against BFD to intercept
797 the messages and deal with them itself. */
798
799bfd_error_handler_type _bfd_error_handler = _bfd_default_error_handler;
800
801/*
802FUNCTION
803 bfd_set_error_handler
804
805SYNOPSIS
806 bfd_error_handler_type bfd_set_error_handler (bfd_error_handler_type);
807
808DESCRIPTION
809 Set the BFD error handler function. Returns the previous
810 function.
811*/
812
813bfd_error_handler_type
c58b9523 814bfd_set_error_handler (bfd_error_handler_type pnew)
252b5132
RH
815{
816 bfd_error_handler_type pold;
817
818 pold = _bfd_error_handler;
819 _bfd_error_handler = pnew;
820 return pold;
821}
822
823/*
824FUNCTION
825 bfd_set_error_program_name
826
827SYNOPSIS
828 void bfd_set_error_program_name (const char *);
829
830DESCRIPTION
831 Set the program name to use when printing a BFD error. This
832 is printed before the error message followed by a colon and
833 space. The string must not be changed after it is passed to
834 this function.
835*/
836
837void
c58b9523 838bfd_set_error_program_name (const char *name)
252b5132
RH
839{
840 _bfd_error_program_name = name;
841}
842
252b5132
RH
843/*
844FUNCTION
845 bfd_get_error_handler
846
847SYNOPSIS
848 bfd_error_handler_type bfd_get_error_handler (void);
849
850DESCRIPTION
851 Return the BFD error handler function.
852*/
853
854bfd_error_handler_type
c58b9523 855bfd_get_error_handler (void)
252b5132
RH
856{
857 return _bfd_error_handler;
858}
2b56b3f3
HPN
859
860/*
861SUBSECTION
862 BFD assert handler
863
864 If BFD finds an internal inconsistency, the bfd assert
865 handler is called with information on the BFD version, BFD
866 source file and line. If this happens, most programs linked
867 against BFD are expected to want to exit with an error, or mark
868 the current BFD operation as failed, so it is recommended to
869 override the default handler, which just calls
870 _bfd_error_handler and continues.
871
872CODE_FRAGMENT
873.
874.typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
875. const char *bfd_version,
876. const char *bfd_file,
877. int bfd_line);
878.
879*/
880
881/* Note the use of bfd_ prefix on the parameter names above: we want to
882 show which one is the message and which is the version by naming the
883 parameters, but avoid polluting the program-using-bfd namespace as
884 the typedef is visible in the exported headers that the program
885 includes. Below, it's just for consistency. */
886
887static void
888_bfd_default_assert_handler (const char *bfd_formatmsg,
889 const char *bfd_version,
890 const char *bfd_file,
891 int bfd_line)
892
893{
894 (*_bfd_error_handler) (bfd_formatmsg, bfd_version, bfd_file, bfd_line);
895}
896
897/* Similar to _bfd_error_handler, a program can decide to exit on an
898 internal BFD error. We use a non-variadic type to simplify passing
899 on parameters to other functions, e.g. _bfd_error_handler. */
900
901bfd_assert_handler_type _bfd_assert_handler = _bfd_default_assert_handler;
902
903/*
904FUNCTION
905 bfd_set_assert_handler
906
907SYNOPSIS
908 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
909
910DESCRIPTION
911 Set the BFD assert handler function. Returns the previous
912 function.
913*/
914
915bfd_assert_handler_type
916bfd_set_assert_handler (bfd_assert_handler_type pnew)
917{
918 bfd_assert_handler_type pold;
919
920 pold = _bfd_assert_handler;
921 _bfd_assert_handler = pnew;
922 return pold;
923}
924
925/*
926FUNCTION
927 bfd_get_assert_handler
928
929SYNOPSIS
930 bfd_assert_handler_type bfd_get_assert_handler (void);
931
932DESCRIPTION
933 Return the BFD assert handler function.
934*/
935
936bfd_assert_handler_type
937bfd_get_assert_handler (void)
938{
939 return _bfd_assert_handler;
940}
252b5132
RH
941\f
942/*
79bb5c23
NC
943INODE
944Miscellaneous, Memory Usage, Error reporting, BFD front end
945
252b5132 946SECTION
1b74d094
BW
947 Miscellaneous
948
949SUBSECTION
950 Miscellaneous functions
252b5132
RH
951*/
952
953/*
954FUNCTION
955 bfd_get_reloc_upper_bound
956
957SYNOPSIS
ed781d5d 958 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
252b5132
RH
959
960DESCRIPTION
961 Return the number of bytes required to store the
962 relocation information associated with section @var{sect}
963 attached to bfd @var{abfd}. If an error occurs, return -1.
964
965*/
966
252b5132 967long
c58b9523 968bfd_get_reloc_upper_bound (bfd *abfd, sec_ptr asect)
252b5132 969{
55ab10f0
NC
970 if (abfd->format != bfd_object)
971 {
972 bfd_set_error (bfd_error_invalid_operation);
973 return -1;
974 }
252b5132
RH
975
976 return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
977}
978
979/*
980FUNCTION
981 bfd_canonicalize_reloc
982
983SYNOPSIS
984 long bfd_canonicalize_reloc
c58b9523 985 (bfd *abfd, asection *sec, arelent **loc, asymbol **syms);
252b5132
RH
986
987DESCRIPTION
988 Call the back end associated with the open BFD
989 @var{abfd} and translate the external form of the relocation
990 information attached to @var{sec} into the internal canonical
991 form. Place the table into memory at @var{loc}, which has
992 been preallocated, usually by a call to
993 <<bfd_get_reloc_upper_bound>>. Returns the number of relocs, or
994 -1 on error.
995
996 The @var{syms} table is also needed for horrible internal magic
997 reasons.
998
252b5132
RH
999*/
1000long
c58b9523
AM
1001bfd_canonicalize_reloc (bfd *abfd,
1002 sec_ptr asect,
1003 arelent **location,
1004 asymbol **symbols)
252b5132 1005{
55ab10f0
NC
1006 if (abfd->format != bfd_object)
1007 {
1008 bfd_set_error (bfd_error_invalid_operation);
1009 return -1;
1010 }
1011
252b5132
RH
1012 return BFD_SEND (abfd, _bfd_canonicalize_reloc,
1013 (abfd, asect, location, symbols));
1014}
1015
1016/*
1017FUNCTION
1018 bfd_set_reloc
1019
1020SYNOPSIS
1021 void bfd_set_reloc
b5f79c76 1022 (bfd *abfd, asection *sec, arelent **rel, unsigned int count);
252b5132
RH
1023
1024DESCRIPTION
1025 Set the relocation pointer and count within
1026 section @var{sec} to the values @var{rel} and @var{count}.
1027 The argument @var{abfd} is ignored.
1028
1029*/
aebad5fe 1030
252b5132 1031void
c58b9523
AM
1032bfd_set_reloc (bfd *ignore_abfd ATTRIBUTE_UNUSED,
1033 sec_ptr asect,
1034 arelent **location,
1035 unsigned int count)
252b5132
RH
1036{
1037 asect->orelocation = location;
1038 asect->reloc_count = count;
1039}
1040
1041/*
1042FUNCTION
1043 bfd_set_file_flags
1044
1045SYNOPSIS
ed781d5d 1046 bfd_boolean bfd_set_file_flags (bfd *abfd, flagword flags);
252b5132
RH
1047
1048DESCRIPTION
1049 Set the flag word in the BFD @var{abfd} to the value @var{flags}.
1050
1051 Possible errors are:
1052 o <<bfd_error_wrong_format>> - The target bfd was not of object format.
1053 o <<bfd_error_invalid_operation>> - The target bfd was open for reading.
1054 o <<bfd_error_invalid_operation>> -
1055 The flag word contained a bit which was not applicable to the
1056 type of file. E.g., an attempt was made to set the <<D_PAGED>> bit
1057 on a BFD format which does not support demand paging.
1058
1059*/
1060
b34976b6 1061bfd_boolean
c58b9523 1062bfd_set_file_flags (bfd *abfd, flagword flags)
252b5132 1063{
55ab10f0
NC
1064 if (abfd->format != bfd_object)
1065 {
1066 bfd_set_error (bfd_error_wrong_format);
b34976b6 1067 return FALSE;
55ab10f0 1068 }
252b5132 1069
55ab10f0
NC
1070 if (bfd_read_p (abfd))
1071 {
1072 bfd_set_error (bfd_error_invalid_operation);
b34976b6 1073 return FALSE;
55ab10f0 1074 }
252b5132
RH
1075
1076 bfd_get_file_flags (abfd) = flags;
55ab10f0
NC
1077 if ((flags & bfd_applicable_file_flags (abfd)) != flags)
1078 {
1079 bfd_set_error (bfd_error_invalid_operation);
b34976b6 1080 return FALSE;
55ab10f0 1081 }
252b5132 1082
b34976b6 1083 return TRUE;
252b5132
RH
1084}
1085
1086void
c58b9523 1087bfd_assert (const char *file, int line)
252b5132 1088{
2b56b3f3
HPN
1089 (*_bfd_assert_handler) (_("BFD %s assertion fail %s:%d"),
1090 BFD_VERSION_STRING, file, line);
252b5132
RH
1091}
1092
c0bed66d
ILT
1093/* A more or less friendly abort message. In libbfd.h abort is
1094 defined to call this function. */
1095
c0bed66d 1096void
c58b9523 1097_bfd_abort (const char *file, int line, const char *fn)
c0bed66d
ILT
1098{
1099 if (fn != NULL)
1100 (*_bfd_error_handler)
7ac01895 1101 (_("BFD %s internal error, aborting at %s:%d in %s\n"),
aec2f561 1102 BFD_VERSION_STRING, file, line, fn);
c0bed66d
ILT
1103 else
1104 (*_bfd_error_handler)
7ac01895 1105 (_("BFD %s internal error, aborting at %s:%d\n"),
aec2f561 1106 BFD_VERSION_STRING, file, line);
c0bed66d 1107 (*_bfd_error_handler) (_("Please report this bug.\n"));
3168356f 1108 _exit (EXIT_FAILURE);
c0bed66d 1109}
252b5132 1110
125c4a69
NC
1111/*
1112FUNCTION
1113 bfd_get_arch_size
1114
1115SYNOPSIS
1116 int bfd_get_arch_size (bfd *abfd);
1117
1118DESCRIPTION
4ef27e04
TG
1119 Returns the normalized architecture address size, in bits, as
1120 determined by the object file's format. By normalized, we mean
1121 either 32 or 64. For ELF, this information is included in the
1122 header. Use bfd_arch_bits_per_address for number of bits in
1123 the architecture address.
125c4a69
NC
1124
1125RETURNS
1126 Returns the arch size in bits if known, <<-1>> otherwise.
1127*/
1128
1129int
c58b9523 1130bfd_get_arch_size (bfd *abfd)
125c4a69
NC
1131{
1132 if (abfd->xvec->flavour == bfd_target_elf_flavour)
c58b9523 1133 return get_elf_backend_data (abfd)->s->arch_size;
125c4a69 1134
4ef27e04 1135 return bfd_arch_bits_per_address (abfd) > 32 ? 64 : 32;
125c4a69
NC
1136}
1137
1138/*
1139FUNCTION
1140 bfd_get_sign_extend_vma
1141
1142SYNOPSIS
1143 int bfd_get_sign_extend_vma (bfd *abfd);
1144
1145DESCRIPTION
1146 Indicates if the target architecture "naturally" sign extends
1147 an address. Some architectures implicitly sign extend address
1148 values when they are converted to types larger than the size
1149 of an address. For instance, bfd_get_start_address() will
1150 return an address sign extended to fill a bfd_vma when this is
1151 the case.
1152
1153RETURNS
1154 Returns <<1>> if the target architecture is known to sign
1155 extend addresses, <<0>> if the target architecture is known to
1156 not sign extend addresses, and <<-1>> otherwise.
1157*/
1158
1159int
c58b9523 1160bfd_get_sign_extend_vma (bfd *abfd)
125c4a69 1161{
f47e5071
NC
1162 char *name;
1163
125c4a69 1164 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
c58b9523 1165 return get_elf_backend_data (abfd)->sign_extend_vma;
125c4a69 1166
f47e5071
NC
1167 name = bfd_get_target (abfd);
1168
7148cc28 1169 /* Return a proper value for DJGPP & PE COFF.
f47e5071
NC
1170 This function is required for DWARF2 support, but there is
1171 no place to store this information in the COFF back end.
1172 Should enough other COFF targets add support for DWARF2,
1173 a place will have to be found. Until then, this hack will do. */
0112cd26 1174 if (CONST_STRNEQ (name, "coff-go32")
8a7140c3 1175 || strcmp (name, "pe-i386") == 0
f0927246 1176 || strcmp (name, "pei-i386") == 0
6e3d6dc1
NC
1177 || strcmp (name, "pe-x86-64") == 0
1178 || strcmp (name, "pei-x86-64") == 0
7148cc28 1179 || strcmp (name, "pe-arm-wince-little") == 0
8076289e
TG
1180 || strcmp (name, "pei-arm-wince-little") == 0
1181 || strcmp (name, "aixcoff-rs6000") == 0)
f47e5071
NC
1182 return 1;
1183
09c6f846
TG
1184 if (CONST_STRNEQ (name, "mach-o"))
1185 return 0;
1186
a022216b 1187 bfd_set_error (bfd_error_wrong_format);
125c4a69
NC
1188 return -1;
1189}
1190
252b5132
RH
1191/*
1192FUNCTION
1193 bfd_set_start_address
1194
1195SYNOPSIS
ed781d5d 1196 bfd_boolean bfd_set_start_address (bfd *abfd, bfd_vma vma);
252b5132
RH
1197
1198DESCRIPTION
1199 Make @var{vma} the entry point of output BFD @var{abfd}.
1200
1201RETURNS
b34976b6 1202 Returns <<TRUE>> on success, <<FALSE>> otherwise.
252b5132
RH
1203*/
1204
b34976b6 1205bfd_boolean
c58b9523 1206bfd_set_start_address (bfd *abfd, bfd_vma vma)
252b5132
RH
1207{
1208 abfd->start_address = vma;
b34976b6 1209 return TRUE;
252b5132
RH
1210}
1211
252b5132
RH
1212/*
1213FUNCTION
1214 bfd_get_gp_size
1215
1216SYNOPSIS
ed781d5d 1217 unsigned int bfd_get_gp_size (bfd *abfd);
252b5132
RH
1218
1219DESCRIPTION
1220 Return the maximum size of objects to be optimized using the GP
1221 register under MIPS ECOFF. This is typically set by the <<-G>>
1222 argument to the compiler, assembler or linker.
1223*/
1224
c0846b23 1225unsigned int
c58b9523 1226bfd_get_gp_size (bfd *abfd)
252b5132
RH
1227{
1228 if (abfd->format == bfd_object)
1229 {
1230 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1231 return ecoff_data (abfd)->gp_size;
1232 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1233 return elf_gp_size (abfd);
1234 }
1235 return 0;
1236}
1237
1238/*
1239FUNCTION
1240 bfd_set_gp_size
1241
1242SYNOPSIS
ed781d5d 1243 void bfd_set_gp_size (bfd *abfd, unsigned int i);
252b5132
RH
1244
1245DESCRIPTION
1246 Set the maximum size of objects to be optimized using the GP
1247 register under ECOFF or MIPS ELF. This is typically set by
1248 the <<-G>> argument to the compiler, assembler or linker.
1249*/
1250
1251void
c58b9523 1252bfd_set_gp_size (bfd *abfd, unsigned int i)
252b5132 1253{
55ab10f0 1254 /* Don't try to set GP size on an archive or core file! */
252b5132
RH
1255 if (abfd->format != bfd_object)
1256 return;
55ab10f0 1257
252b5132
RH
1258 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1259 ecoff_data (abfd)->gp_size = i;
1260 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1261 elf_gp_size (abfd) = i;
1262}
1263
1264/* Get the GP value. This is an internal function used by some of the
1265 relocation special_function routines on targets which support a GP
1266 register. */
1267
1268bfd_vma
c58b9523 1269_bfd_get_gp_value (bfd *abfd)
252b5132 1270{
9bcf4de0
TS
1271 if (! abfd)
1272 return 0;
55ab10f0
NC
1273 if (abfd->format != bfd_object)
1274 return 0;
1275
1276 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1277 return ecoff_data (abfd)->gp;
1278 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1279 return elf_gp (abfd);
1280
252b5132
RH
1281 return 0;
1282}
1283
1284/* Set the GP value. */
1285
1286void
c58b9523 1287_bfd_set_gp_value (bfd *abfd, bfd_vma v)
252b5132 1288{
9bcf4de0 1289 if (! abfd)
c2c96631 1290 abort ();
252b5132
RH
1291 if (abfd->format != bfd_object)
1292 return;
55ab10f0 1293
252b5132
RH
1294 if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
1295 ecoff_data (abfd)->gp = v;
1296 else if (abfd->xvec->flavour == bfd_target_elf_flavour)
1297 elf_gp (abfd) = v;
1298}
1299
1300/*
1301FUNCTION
1302 bfd_scan_vma
1303
1304SYNOPSIS
ed781d5d 1305 bfd_vma bfd_scan_vma (const char *string, const char **end, int base);
252b5132
RH
1306
1307DESCRIPTION
1308 Convert, like <<strtoul>>, a numerical expression
1309 @var{string} into a <<bfd_vma>> integer, and return that integer.
1310 (Though without as many bells and whistles as <<strtoul>>.)
1311 The expression is assumed to be unsigned (i.e., positive).
1312 If given a @var{base}, it is used as the base for conversion.
1313 A base of 0 causes the function to interpret the string
1314 in hex if a leading "0x" or "0X" is found, otherwise
1315 in octal if a leading zero is found, otherwise in decimal.
1316
88eaccc2
AM
1317 If the value would overflow, the maximum <<bfd_vma>> value is
1318 returned.
252b5132
RH
1319*/
1320
1321bfd_vma
c58b9523 1322bfd_scan_vma (const char *string, const char **end, int base)
252b5132
RH
1323{
1324 bfd_vma value;
88eaccc2
AM
1325 bfd_vma cutoff;
1326 unsigned int cutlim;
1327 int overflow;
252b5132
RH
1328
1329 /* Let the host do it if possible. */
eb6e10cb 1330 if (sizeof (bfd_vma) <= sizeof (unsigned long))
c58b9523 1331 return strtoul (string, (char **) end, base);
252b5132 1332
49c97a80
ILT
1333#ifdef HAVE_STRTOULL
1334 if (sizeof (bfd_vma) <= sizeof (unsigned long long))
1335 return strtoull (string, (char **) end, base);
1336#endif
1337
252b5132
RH
1338 if (base == 0)
1339 {
1340 if (string[0] == '0')
1341 {
1342 if ((string[1] == 'x') || (string[1] == 'X'))
1343 base = 16;
252b5132
RH
1344 else
1345 base = 8;
1346 }
252b5132 1347 }
55ab10f0 1348
88eaccc2
AM
1349 if ((base < 2) || (base > 36))
1350 base = 10;
1351
1352 if (base == 16
1353 && string[0] == '0'
1354 && (string[1] == 'x' || string[1] == 'X')
1355 && ISXDIGIT (string[2]))
1356 {
1357 string += 2;
1358 }
aebad5fe 1359
88eaccc2
AM
1360 cutoff = (~ (bfd_vma) 0) / (bfd_vma) base;
1361 cutlim = (~ (bfd_vma) 0) % (bfd_vma) base;
1362 value = 0;
1363 overflow = 0;
1364 while (1)
1365 {
1366 unsigned int digit;
1367
1368 digit = *string;
1369 if (ISDIGIT (digit))
1370 digit = digit - '0';
1371 else if (ISALPHA (digit))
1372 digit = TOUPPER (digit) - 'A' + 10;
1373 else
1374 break;
1375 if (digit >= (unsigned int) base)
1376 break;
1377 if (value > cutoff || (value == cutoff && digit > cutlim))
1378 overflow = 1;
1379 value = value * base + digit;
1380 ++string;
1381 }
252b5132 1382
88eaccc2
AM
1383 if (overflow)
1384 value = ~ (bfd_vma) 0;
252b5132 1385
88eaccc2
AM
1386 if (end != NULL)
1387 *end = string;
252b5132
RH
1388
1389 return value;
1390}
1391
80fccad2
BW
1392/*
1393FUNCTION
1394 bfd_copy_private_header_data
1395
1396SYNOPSIS
1397 bfd_boolean bfd_copy_private_header_data (bfd *ibfd, bfd *obfd);
1398
1399DESCRIPTION
1400 Copy private BFD header information from the BFD @var{ibfd} to the
1401 the BFD @var{obfd}. This copies information that may require
1402 sections to exist, but does not require symbol tables. Return
1403 <<true>> on success, <<false>> on error.
1404 Possible error returns are:
1405
1406 o <<bfd_error_no_memory>> -
1407 Not enough memory exists to create private data for @var{obfd}.
1408
1409.#define bfd_copy_private_header_data(ibfd, obfd) \
1410. BFD_SEND (obfd, _bfd_copy_private_header_data, \
1411. (ibfd, obfd))
1412
1413*/
1414
252b5132
RH
1415/*
1416FUNCTION
1417 bfd_copy_private_bfd_data
1418
1419SYNOPSIS
ed781d5d 1420 bfd_boolean bfd_copy_private_bfd_data (bfd *ibfd, bfd *obfd);
252b5132
RH
1421
1422DESCRIPTION
aebad5fe 1423 Copy private BFD information from the BFD @var{ibfd} to the
b34976b6 1424 the BFD @var{obfd}. Return <<TRUE>> on success, <<FALSE>> on error.
252b5132
RH
1425 Possible error returns are:
1426
1427 o <<bfd_error_no_memory>> -
1428 Not enough memory exists to create private data for @var{obfd}.
1429
1430.#define bfd_copy_private_bfd_data(ibfd, obfd) \
1431. BFD_SEND (obfd, _bfd_copy_private_bfd_data, \
1432. (ibfd, obfd))
1433
1434*/
1435
1436/*
1437FUNCTION
1438 bfd_merge_private_bfd_data
1439
1440SYNOPSIS
ed781d5d 1441 bfd_boolean bfd_merge_private_bfd_data (bfd *ibfd, bfd *obfd);
252b5132
RH
1442
1443DESCRIPTION
aebad5fe 1444 Merge private BFD information from the BFD @var{ibfd} to the
b34976b6
AM
1445 the output file BFD @var{obfd} when linking. Return <<TRUE>>
1446 on success, <<FALSE>> on error. Possible error returns are:
252b5132
RH
1447
1448 o <<bfd_error_no_memory>> -
1449 Not enough memory exists to create private data for @var{obfd}.
1450
1451.#define bfd_merge_private_bfd_data(ibfd, obfd) \
1452. BFD_SEND (obfd, _bfd_merge_private_bfd_data, \
1453. (ibfd, obfd))
1454
1455*/
1456
1457/*
1458FUNCTION
1459 bfd_set_private_flags
1460
1461SYNOPSIS
ed781d5d 1462 bfd_boolean bfd_set_private_flags (bfd *abfd, flagword flags);
252b5132
RH
1463
1464DESCRIPTION
1465 Set private BFD flag information in the BFD @var{abfd}.
b34976b6 1466 Return <<TRUE>> on success, <<FALSE>> on error. Possible error
252b5132
RH
1467 returns are:
1468
1469 o <<bfd_error_no_memory>> -
1470 Not enough memory exists to create private data for @var{obfd}.
1471
1472.#define bfd_set_private_flags(abfd, flags) \
ed781d5d 1473. BFD_SEND (abfd, _bfd_set_private_flags, (abfd, flags))
252b5132
RH
1474
1475*/
1476
1477/*
1478FUNCTION
ed781d5d 1479 Other functions
252b5132
RH
1480
1481DESCRIPTION
ed781d5d 1482 The following functions exist but have not yet been documented.
252b5132 1483
a6b96beb
AM
1484.#define bfd_sizeof_headers(abfd, info) \
1485. BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, info))
252b5132
RH
1486.
1487.#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
ed781d5d 1488. BFD_SEND (abfd, _bfd_find_nearest_line, \
fb167eb2 1489. (abfd, syms, sec, off, file, func, line, NULL))
252b5132 1490.
9b8d1a36
CC
1491.#define bfd_find_nearest_line_discriminator(abfd, sec, syms, off, file, func, \
1492. line, disc) \
fb167eb2
AM
1493. BFD_SEND (abfd, _bfd_find_nearest_line, \
1494. (abfd, syms, sec, off, file, func, line, disc))
9b8d1a36 1495.
5420f73d
L
1496.#define bfd_find_line(abfd, syms, sym, file, line) \
1497. BFD_SEND (abfd, _bfd_find_line, \
1498. (abfd, syms, sym, file, line))
1499.
4ab527b0
FF
1500.#define bfd_find_inliner_info(abfd, file, func, line) \
1501. BFD_SEND (abfd, _bfd_find_inliner_info, \
1502. (abfd, file, func, line))
1503.
252b5132 1504.#define bfd_debug_info_start(abfd) \
ed781d5d 1505. BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
252b5132
RH
1506.
1507.#define bfd_debug_info_end(abfd) \
ed781d5d 1508. BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
252b5132
RH
1509.
1510.#define bfd_debug_info_accumulate(abfd, section) \
ed781d5d 1511. BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
252b5132
RH
1512.
1513.#define bfd_stat_arch_elt(abfd, stat) \
ed781d5d 1514. BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
252b5132
RH
1515.
1516.#define bfd_update_armap_timestamp(abfd) \
ed781d5d 1517. BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
252b5132
RH
1518.
1519.#define bfd_set_arch_mach(abfd, arch, mach)\
ed781d5d 1520. BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
252b5132
RH
1521.
1522.#define bfd_relax_section(abfd, section, link_info, again) \
1523. BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
1524.
1525.#define bfd_gc_sections(abfd, link_info) \
1526. BFD_SEND (abfd, _bfd_gc_sections, (abfd, link_info))
8550eb6e 1527.
b9c361e0
JL
1528.#define bfd_lookup_section_flags(link_info, flag_info, section) \
1529. BFD_SEND (abfd, _bfd_lookup_section_flags, (link_info, flag_info, section))
ae17ab41 1530.
8550eb6e
JJ
1531.#define bfd_merge_sections(abfd, link_info) \
1532. BFD_SEND (abfd, _bfd_merge_sections, (abfd, link_info))
252b5132 1533.
72adc230
AM
1534.#define bfd_is_group_section(abfd, sec) \
1535. BFD_SEND (abfd, _bfd_is_group_section, (abfd, sec))
1536.
e61463e1
AM
1537.#define bfd_discard_group(abfd, sec) \
1538. BFD_SEND (abfd, _bfd_discard_group, (abfd, sec))
1539.
252b5132
RH
1540.#define bfd_link_hash_table_create(abfd) \
1541. BFD_SEND (abfd, _bfd_link_hash_table_create, (abfd))
1542.
1543.#define bfd_link_add_symbols(abfd, info) \
1544. BFD_SEND (abfd, _bfd_link_add_symbols, (abfd, info))
1545.
1449d79b 1546.#define bfd_link_just_syms(abfd, sec, info) \
2d653fc7
AM
1547. BFD_SEND (abfd, _bfd_link_just_syms, (sec, info))
1548.
252b5132
RH
1549.#define bfd_final_link(abfd, info) \
1550. BFD_SEND (abfd, _bfd_final_link, (abfd, info))
1551.
1552.#define bfd_free_cached_info(abfd) \
1553. BFD_SEND (abfd, _bfd_free_cached_info, (abfd))
1554.
1555.#define bfd_get_dynamic_symtab_upper_bound(abfd) \
1556. BFD_SEND (abfd, _bfd_get_dynamic_symtab_upper_bound, (abfd))
1557.
1558.#define bfd_print_private_bfd_data(abfd, file)\
1559. BFD_SEND (abfd, _bfd_print_private_bfd_data, (abfd, file))
1560.
1561.#define bfd_canonicalize_dynamic_symtab(abfd, asymbols) \
1562. BFD_SEND (abfd, _bfd_canonicalize_dynamic_symtab, (abfd, asymbols))
1563.
c9727e01
AM
1564.#define bfd_get_synthetic_symtab(abfd, count, syms, dyncount, dynsyms, ret) \
1565. BFD_SEND (abfd, _bfd_get_synthetic_symtab, (abfd, count, syms, \
1566. dyncount, dynsyms, ret))
4c45e5c9 1567.
252b5132
RH
1568.#define bfd_get_dynamic_reloc_upper_bound(abfd) \
1569. BFD_SEND (abfd, _bfd_get_dynamic_reloc_upper_bound, (abfd))
1570.
1571.#define bfd_canonicalize_dynamic_reloc(abfd, arels, asyms) \
1572. BFD_SEND (abfd, _bfd_canonicalize_dynamic_reloc, (abfd, arels, asyms))
1573.
1574.extern bfd_byte *bfd_get_relocated_section_contents
c58b9523
AM
1575. (bfd *, struct bfd_link_info *, struct bfd_link_order *, bfd_byte *,
1576. bfd_boolean, asymbol **);
252b5132
RH
1577.
1578
1579*/
1580
1581bfd_byte *
c58b9523
AM
1582bfd_get_relocated_section_contents (bfd *abfd,
1583 struct bfd_link_info *link_info,
1584 struct bfd_link_order *link_order,
1585 bfd_byte *data,
1586 bfd_boolean relocatable,
1587 asymbol **symbols)
252b5132
RH
1588{
1589 bfd *abfd2;
c58b9523
AM
1590 bfd_byte *(*fn) (bfd *, struct bfd_link_info *, struct bfd_link_order *,
1591 bfd_byte *, bfd_boolean, asymbol **);
252b5132
RH
1592
1593 if (link_order->type == bfd_indirect_link_order)
1594 {
1595 abfd2 = link_order->u.indirect.section->owner;
55ab10f0 1596 if (abfd2 == NULL)
252b5132
RH
1597 abfd2 = abfd;
1598 }
1599 else
1600 abfd2 = abfd;
55ab10f0 1601
252b5132
RH
1602 fn = abfd2->xvec->_bfd_get_relocated_section_contents;
1603
1049f94e 1604 return (*fn) (abfd, link_info, link_order, data, relocatable, symbols);
252b5132
RH
1605}
1606
1607/* Record information about an ELF program header. */
1608
b34976b6 1609bfd_boolean
c58b9523
AM
1610bfd_record_phdr (bfd *abfd,
1611 unsigned long type,
1612 bfd_boolean flags_valid,
1613 flagword flags,
1614 bfd_boolean at_valid,
1615 bfd_vma at,
1616 bfd_boolean includes_filehdr,
1617 bfd_boolean includes_phdrs,
1618 unsigned int count,
1619 asection **secs)
252b5132
RH
1620{
1621 struct elf_segment_map *m, **pm;
dc810e39 1622 bfd_size_type amt;
252b5132
RH
1623
1624 if (bfd_get_flavour (abfd) != bfd_target_elf_flavour)
b34976b6 1625 return TRUE;
252b5132 1626
dc810e39
AM
1627 amt = sizeof (struct elf_segment_map);
1628 amt += ((bfd_size_type) count - 1) * sizeof (asection *);
a50b1753 1629 m = (struct elf_segment_map *) bfd_zalloc (abfd, amt);
252b5132 1630 if (m == NULL)
b34976b6 1631 return FALSE;
252b5132 1632
252b5132
RH
1633 m->p_type = type;
1634 m->p_flags = flags;
1635 m->p_paddr = at;
c58b9523
AM
1636 m->p_flags_valid = flags_valid;
1637 m->p_paddr_valid = at_valid;
1638 m->includes_filehdr = includes_filehdr;
1639 m->includes_phdrs = includes_phdrs;
252b5132
RH
1640 m->count = count;
1641 if (count > 0)
1642 memcpy (m->sections, secs, count * sizeof (asection *));
1643
12bd6957 1644 for (pm = &elf_seg_map (abfd); *pm != NULL; pm = &(*pm)->next)
252b5132
RH
1645 ;
1646 *pm = m;
1647
b34976b6 1648 return TRUE;
252b5132 1649}
ae4221d7 1650
01a3c213
AM
1651#ifdef BFD64
1652/* Return true iff this target is 32-bit. */
1653
1654static bfd_boolean
1655is32bit (bfd *abfd)
ae4221d7
L
1656{
1657 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
01a3c213
AM
1658 {
1659 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
1660 return bed->s->elfclass == ELFCLASS32;
1661 }
1662
6aa341c7
TG
1663 /* For non-ELF targets, use architecture information. */
1664 return bfd_arch_bits_per_address (abfd) <= 32;
ae4221d7 1665}
01a3c213
AM
1666#endif
1667
1668/* bfd_sprintf_vma and bfd_fprintf_vma display an address in the
1669 target's address size. */
ae4221d7
L
1670
1671void
01a3c213 1672bfd_sprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, char *buf, bfd_vma value)
ae4221d7 1673{
970ccc77 1674#ifdef BFD64
01a3c213
AM
1675 if (is32bit (abfd))
1676 {
1677 sprintf (buf, "%08lx", (unsigned long) value & 0xffffffff);
1678 return;
1679 }
970ccc77 1680#endif
01a3c213
AM
1681 sprintf_vma (buf, value);
1682}
1683
1684void
1685bfd_fprintf_vma (bfd *abfd ATTRIBUTE_UNUSED, void *stream, bfd_vma value)
1686{
1687#ifdef BFD64
1688 if (is32bit (abfd))
1689 {
1690 fprintf ((FILE *) stream, "%08lx", (unsigned long) value & 0xffffffff);
1691 return;
1692 }
1693#endif
1694 fprintf_vma ((FILE *) stream, value);
ae4221d7 1695}
8c98ec7d
AO
1696
1697/*
1698FUNCTION
1699 bfd_alt_mach_code
1700
1701SYNOPSIS
ed781d5d 1702 bfd_boolean bfd_alt_mach_code (bfd *abfd, int alternative);
8c98ec7d
AO
1703
1704DESCRIPTION
1705
1706 When more than one machine code number is available for the
1707 same machine type, this function can be used to switch between
47badb7b 1708 the preferred one (alternative == 0) and any others. Currently,
8c98ec7d
AO
1709 only ELF supports this feature, with up to two alternate
1710 machine codes.
1711*/
1712
b34976b6 1713bfd_boolean
c58b9523 1714bfd_alt_mach_code (bfd *abfd, int alternative)
8c98ec7d
AO
1715{
1716 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1717 {
1718 int code;
1719
47badb7b 1720 switch (alternative)
8c98ec7d
AO
1721 {
1722 case 0:
1723 code = get_elf_backend_data (abfd)->elf_machine_code;
1724 break;
1725
1726 case 1:
1727 code = get_elf_backend_data (abfd)->elf_machine_alt1;
1728 if (code == 0)
b34976b6 1729 return FALSE;
8c98ec7d
AO
1730 break;
1731
1732 case 2:
1733 code = get_elf_backend_data (abfd)->elf_machine_alt2;
1734 if (code == 0)
b34976b6 1735 return FALSE;
8c98ec7d
AO
1736 break;
1737
1738 default:
b34976b6 1739 return FALSE;
8c98ec7d
AO
1740 }
1741
1742 elf_elfheader (abfd)->e_machine = code;
1743
b34976b6 1744 return TRUE;
8c98ec7d
AO
1745 }
1746
b34976b6 1747 return FALSE;
8c98ec7d 1748}
e84d6fca 1749
24718e3b
L
1750/*
1751FUNCTION
1752 bfd_emul_get_maxpagesize
1753
1754SYNOPSIS
1755 bfd_vma bfd_emul_get_maxpagesize (const char *);
1756
1757DESCRIPTION
1758 Returns the maximum page size, in bytes, as determined by
1759 emulation.
1760
1761RETURNS
095106a2 1762 Returns the maximum page size in bytes for ELF, 0 otherwise.
24718e3b
L
1763*/
1764
1765bfd_vma
1766bfd_emul_get_maxpagesize (const char *emul)
1767{
1768 const bfd_target *target;
1769
1770 target = bfd_find_target (emul, NULL);
1771 if (target != NULL
1772 && target->flavour == bfd_target_elf_flavour)
1773 return xvec_get_elf_backend_data (target)->maxpagesize;
1774
24718e3b
L
1775 return 0;
1776}
1777
1778static void
1779bfd_elf_set_pagesize (const bfd_target *target, bfd_vma size,
1780 int offset, const bfd_target *orig_target)
1781{
1782 if (target->flavour == bfd_target_elf_flavour)
1783 {
1784 const struct elf_backend_data *bed;
1785
1786 bed = xvec_get_elf_backend_data (target);
1787 *((bfd_vma *) ((char *) bed + offset)) = size;
1788 }
1789
1790 if (target->alternative_target
1791 && target->alternative_target != orig_target)
1792 bfd_elf_set_pagesize (target->alternative_target, size, offset,
1793 orig_target);
1794}
1795
1796/*
1797FUNCTION
1798 bfd_emul_set_maxpagesize
1799
1800SYNOPSIS
1801 void bfd_emul_set_maxpagesize (const char *, bfd_vma);
1802
1803DESCRIPTION
1804 For ELF, set the maximum page size for the emulation. It is
1805 a no-op for other formats.
1806
1807*/
1808
1809void
1810bfd_emul_set_maxpagesize (const char *emul, bfd_vma size)
1811{
1812 const bfd_target *target;
1813
1814 target = bfd_find_target (emul, NULL);
1815 if (target)
1816 bfd_elf_set_pagesize (target, size,
1817 offsetof (struct elf_backend_data,
1818 maxpagesize), target);
1819}
1820
1821/*
1822FUNCTION
1823 bfd_emul_get_commonpagesize
1824
1825SYNOPSIS
1826 bfd_vma bfd_emul_get_commonpagesize (const char *);
1827
1828DESCRIPTION
1829 Returns the common page size, in bytes, as determined by
1830 emulation.
1831
1832RETURNS
095106a2 1833 Returns the common page size in bytes for ELF, 0 otherwise.
24718e3b
L
1834*/
1835
1836bfd_vma
1837bfd_emul_get_commonpagesize (const char *emul)
1838{
1839 const bfd_target *target;
1840
1841 target = bfd_find_target (emul, NULL);
1842 if (target != NULL
1843 && target->flavour == bfd_target_elf_flavour)
1844 return xvec_get_elf_backend_data (target)->commonpagesize;
1845
24718e3b
L
1846 return 0;
1847}
1848
1849/*
1850FUNCTION
1851 bfd_emul_set_commonpagesize
1852
1853SYNOPSIS
1854 void bfd_emul_set_commonpagesize (const char *, bfd_vma);
1855
1856DESCRIPTION
1857 For ELF, set the common page size for the emulation. It is
1858 a no-op for other formats.
1859
1860*/
1861
1862void
1863bfd_emul_set_commonpagesize (const char *emul, bfd_vma size)
1864{
1865 const bfd_target *target;
1866
1867 target = bfd_find_target (emul, NULL);
1868 if (target)
1869 bfd_elf_set_pagesize (target, size,
1870 offsetof (struct elf_backend_data,
1871 commonpagesize), target);
1872}
3fad56a3
AM
1873
1874/*
1875FUNCTION
1876 bfd_demangle
1877
1878SYNOPSIS
1879 char *bfd_demangle (bfd *, const char *, int);
1880
1881DESCRIPTION
1882 Wrapper around cplus_demangle. Strips leading underscores and
1883 other such chars that would otherwise confuse the demangler.
1884 If passed a g++ v3 ABI mangled name, returns a buffer allocated
1885 with malloc holding the demangled name. Returns NULL otherwise
1886 and on memory alloc failure.
1887*/
1888
1889char *
1890bfd_demangle (bfd *abfd, const char *name, int options)
1891{
1892 char *res, *alloc;
1893 const char *pre, *suf;
1894 size_t pre_len;
c29aae59 1895 bfd_boolean skip_lead;
3fad56a3 1896
c29aae59
AM
1897 skip_lead = (abfd != NULL
1898 && *name != '\0'
1899 && bfd_get_symbol_leading_char (abfd) == *name);
1900 if (skip_lead)
3fad56a3
AM
1901 ++name;
1902
1903 /* This is a hack for better error reporting on XCOFF, PowerPC64-ELF
1904 or the MS PE format. These formats have a number of leading '.'s
1905 on at least some symbols, so we remove all dots to avoid
1906 confusing the demangler. */
1907 pre = name;
1908 while (*name == '.' || *name == '$')
1909 ++name;
1910 pre_len = name - pre;
1911
1912 /* Strip off @plt and suchlike too. */
1913 alloc = NULL;
1914 suf = strchr (name, '@');
1915 if (suf != NULL)
1916 {
a50b1753 1917 alloc = (char *) bfd_malloc (suf - name + 1);
3fad56a3
AM
1918 if (alloc == NULL)
1919 return NULL;
1920 memcpy (alloc, name, suf - name);
1921 alloc[suf - name] = '\0';
1922 name = alloc;
1923 }
1924
1925 res = cplus_demangle (name, options);
1926
1927 if (alloc != NULL)
1928 free (alloc);
1929
1930 if (res == NULL)
c29aae59
AM
1931 {
1932 if (skip_lead)
1933 {
1934 size_t len = strlen (pre) + 1;
a50b1753 1935 alloc = (char *) bfd_malloc (len);
c29aae59
AM
1936 if (alloc == NULL)
1937 return NULL;
1938 memcpy (alloc, pre, len);
1939 return alloc;
1940 }
1941 return NULL;
1942 }
3fad56a3
AM
1943
1944 /* Put back any prefix or suffix. */
1945 if (pre_len != 0 || suf != NULL)
1946 {
1947 size_t len;
1948 size_t suf_len;
1949 char *final;
1950
1951 len = strlen (res);
1952 if (suf == NULL)
1953 suf = res + len;
1954 suf_len = strlen (suf) + 1;
a50b1753 1955 final = (char *) bfd_malloc (pre_len + len + suf_len);
32e8a950
NC
1956 if (final != NULL)
1957 {
1958 memcpy (final, pre, pre_len);
1959 memcpy (final + pre_len, res, len);
1960 memcpy (final + pre_len + len, suf, suf_len);
1961 }
3fad56a3
AM
1962 free (res);
1963 res = final;
1964 }
1965
1966 return res;
1967}
151411f8
L
1968
1969/*
1970FUNCTION
1971 bfd_update_compression_header
1972
1973SYNOPSIS
1974 void bfd_update_compression_header
1975 (bfd *abfd, bfd_byte *contents, asection *sec);
1976
1977DESCRIPTION
1978 Set the compression header at CONTENTS of SEC in ABFD and update
1979 elf_section_flags for compression.
1980*/
1981
1982void
1983bfd_update_compression_header (bfd *abfd, bfd_byte *contents,
1984 asection *sec)
1985{
1986 if ((abfd->flags & BFD_COMPRESS) != 0)
1987 {
1988 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
1989 {
1990 if ((abfd->flags & BFD_COMPRESS_GABI) != 0)
1991 {
1992 const struct elf_backend_data *bed
1993 = get_elf_backend_data (abfd);
1994
1995 /* Set the SHF_COMPRESSED bit. */
1996 elf_section_flags (sec) |= SHF_COMPRESSED;
1997
1998 if (bed->s->elfclass == ELFCLASS32)
1999 {
2000 Elf32_External_Chdr *echdr
2001 = (Elf32_External_Chdr *) contents;
2002 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2003 bfd_put_32 (abfd, sec->size, &echdr->ch_size);
2004 bfd_put_32 (abfd, 1 << sec->alignment_power,
2005 &echdr->ch_addralign);
2006 }
2007 else
2008 {
2009 Elf64_External_Chdr *echdr
2010 = (Elf64_External_Chdr *) contents;
c8b187ea 2011 bfd_put_32 (abfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
8c6da3df 2012 bfd_put_32 (abfd, 0, &echdr->ch_reserved);
151411f8
L
2013 bfd_put_64 (abfd, sec->size, &echdr->ch_size);
2014 bfd_put_64 (abfd, 1 << sec->alignment_power,
2015 &echdr->ch_addralign);
2016 }
2017 }
2018 else
dab394de
L
2019 {
2020 /* Clear the SHF_COMPRESSED bit. */
2021 elf_section_flags (sec) &= ~SHF_COMPRESSED;
2022
2023 /* Write the zlib header. It should be "ZLIB" followed by
2024 the uncompressed section size, 8 bytes in big-endian
2025 order. */
2026 memcpy (contents, "ZLIB", 4);
2027 bfd_putb64 (sec->size, contents + 4);
2028 }
151411f8
L
2029 }
2030 }
2031 else
2032 abort ();
2033}
2034
2035/*
2036 FUNCTION
2037 bfd_check_compression_header
2038
2039 SYNOPSIS
2040 bfd_boolean bfd_check_compression_header
2041 (bfd *abfd, bfd_byte *contents, asection *sec,
dab394de 2042 bfd_size_type *uncompressed_size);
151411f8
L
2043
2044DESCRIPTION
dab394de
L
2045 Check the compression header at CONTENTS of SEC in ABFD and
2046 store the uncompressed size in UNCOMPRESSED_SIZE if the
2047 compression header is valid.
151411f8
L
2048
2049RETURNS
2050 Return TRUE if the compression header is valid.
2051*/
2052
2053bfd_boolean
2054bfd_check_compression_header (bfd *abfd, bfd_byte *contents,
2055 asection *sec,
dab394de 2056 bfd_size_type *uncompressed_size)
151411f8
L
2057{
2058 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour
2059 && (elf_section_flags (sec) & SHF_COMPRESSED) != 0)
2060 {
2061 Elf_Internal_Chdr chdr;
2062 const struct elf_backend_data *bed = get_elf_backend_data (abfd);
2063 if (bed->s->elfclass == ELFCLASS32)
2064 {
2065 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2066 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
2067 chdr.ch_size = bfd_get_32 (abfd, &echdr->ch_size);
2068 chdr.ch_addralign = bfd_get_32 (abfd, &echdr->ch_addralign);
2069 }
2070 else
2071 {
2072 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
c8b187ea 2073 chdr.ch_type = bfd_get_32 (abfd, &echdr->ch_type);
151411f8
L
2074 chdr.ch_size = bfd_get_64 (abfd, &echdr->ch_size);
2075 chdr.ch_addralign = bfd_get_64 (abfd, &echdr->ch_addralign);
2076 }
dab394de
L
2077 if (chdr.ch_type == ELFCOMPRESS_ZLIB
2078 && chdr.ch_addralign == 1U << sec->alignment_power)
2079 {
2080 *uncompressed_size = chdr.ch_size;
2081 return TRUE;
2082 }
151411f8
L
2083 }
2084
2085 return FALSE;
2086}
2087
2088/*
2089FUNCTION
2090 bfd_get_compression_header_size
2091
2092SYNOPSIS
2093 int bfd_get_compression_header_size (bfd *abfd, asection *sec);
2094
2095DESCRIPTION
2096 Return the size of the compression header of SEC in ABFD.
2097
2098RETURNS
2099 Return the size of the compression header in bytes.
2100*/
2101
2102int
2103bfd_get_compression_header_size (bfd *abfd, asection *sec)
2104{
2105 if (bfd_get_flavour (abfd) == bfd_target_elf_flavour)
2106 {
2107 if (sec == NULL)
2108 {
2109 if (!(abfd->flags & BFD_COMPRESS_GABI))
2110 return 0;
2111 }
2112 else if (!(elf_section_flags (sec) & SHF_COMPRESSED))
2113 return 0;
2114
2115 if (get_elf_backend_data (abfd)->s->elfclass == ELFCLASS32)
2116 return sizeof (Elf32_External_Chdr);
2117 else
2118 return sizeof (Elf64_External_Chdr);
2119 }
2120
2121 return 0;
2122}
88988473
L
2123
2124/*
2125FUNCTION
2126 bfd_convert_section_size
2127
2128SYNOPSIS
2129 bfd_size_type bfd_convert_section_size
2130 (bfd *ibfd, asection *isec, bfd *obfd, bfd_size_type size);
2131
2132DESCRIPTION
2133 Convert the size @var{size} of the section @var{isec} in input
2134 BFD @var{ibfd} to the section size in output BFD @var{obfd}.
2135*/
2136
2137bfd_size_type
2138bfd_convert_section_size (bfd *ibfd, sec_ptr isec, bfd *obfd,
2139 bfd_size_type size)
2140{
2141 bfd_size_type hdr_size;
2142
2143 /* Do nothing if input file will be decompressed. */
2144 if ((ibfd->flags & BFD_DECOMPRESS))
2145 return size;
2146
2147 /* Do nothing if either input or output aren't ELF. */
2148 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2149 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2150 return size;
2151
2152 /* Do nothing if ELF classes of input and output are the same. */
2153 if (get_elf_backend_data (ibfd)->s->elfclass
2154 == get_elf_backend_data (obfd)->s->elfclass)
2155 return size;
2156
2157 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2158 hdr_size = bfd_get_compression_header_size (ibfd, isec);
2159 if (hdr_size == 0)
2160 return size;
2161
2162 /* Adjust the size of the output SHF_COMPRESSED section. */
2163 if (hdr_size == sizeof (Elf32_External_Chdr))
2164 return (size - sizeof (Elf32_External_Chdr)
2165 + sizeof (Elf64_External_Chdr));
2166 else
2167 return (size - sizeof (Elf64_External_Chdr)
2168 + sizeof (Elf32_External_Chdr));
2169}
2170
2171/*
2172FUNCTION
2173 bfd_convert_section_contents
2174
2175SYNOPSIS
2176 bfd_boolean bfd_convert_section_contents
cbd44e24
L
2177 (bfd *ibfd, asection *isec, bfd *obfd,
2178 bfd_byte **ptr, bfd_size_type *ptr_size);
88988473
L
2179
2180DESCRIPTION
2181 Convert the contents, stored in @var{*ptr}, of the section
2182 @var{isec} in input BFD @var{ibfd} to output BFD @var{obfd}
2183 if needed. The original buffer pointed to by @var{*ptr} may
2184 be freed and @var{*ptr} is returned with memory malloc'd by this
cbd44e24 2185 function, and the new size written to @var{ptr_size}.
88988473
L
2186*/
2187
2188bfd_boolean
2189bfd_convert_section_contents (bfd *ibfd, sec_ptr isec, bfd *obfd,
cbd44e24 2190 bfd_byte **ptr, bfd_size_type *ptr_size)
88988473
L
2191{
2192 bfd_byte *contents;
2193 bfd_size_type ihdr_size, ohdr_size, size;
2194 Elf_Internal_Chdr chdr;
2195 bfd_boolean use_memmove;
2196
2197 /* Do nothing if input file will be decompressed. */
2198 if ((ibfd->flags & BFD_DECOMPRESS))
2199 return TRUE;
2200
2201 /* Do nothing if either input or output aren't ELF. */
2202 if (bfd_get_flavour (ibfd) != bfd_target_elf_flavour
2203 || bfd_get_flavour (obfd) != bfd_target_elf_flavour)
2204 return TRUE;
2205
2206 /* Do nothing if ELF classes of input and output are the same. */
2207 if (get_elf_backend_data (ibfd)->s->elfclass
2208 == get_elf_backend_data (obfd)->s->elfclass)
2209 return TRUE;
2210
2211 /* Do nothing if the input section isn't a SHF_COMPRESSED section. */
2212 ihdr_size = bfd_get_compression_header_size (ibfd, isec);
2213 if (ihdr_size == 0)
2214 return TRUE;
2215
2216 contents = *ptr;
2217
2218 /* Convert the contents of the input SHF_COMPRESSED section to
2219 output. Get the input compression header and the size of the
2220 output compression header. */
2221 if (ihdr_size == sizeof (Elf32_External_Chdr))
2222 {
2223 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2224 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
2225 chdr.ch_size = bfd_get_32 (ibfd, &echdr->ch_size);
2226 chdr.ch_addralign = bfd_get_32 (ibfd, &echdr->ch_addralign);
2227
2228 ohdr_size = sizeof (Elf64_External_Chdr);
2229
2230 use_memmove = FALSE;
2231 }
2232 else
2233 {
2234 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
c8b187ea 2235 chdr.ch_type = bfd_get_32 (ibfd, &echdr->ch_type);
88988473
L
2236 chdr.ch_size = bfd_get_64 (ibfd, &echdr->ch_size);
2237 chdr.ch_addralign = bfd_get_64 (ibfd, &echdr->ch_addralign);
2238
2239 ohdr_size = sizeof (Elf32_External_Chdr);
2240 use_memmove = TRUE;
2241 }
2242
2243 size = bfd_get_section_size (isec) - ihdr_size + ohdr_size;
2244 if (!use_memmove)
2245 {
2246 contents = (bfd_byte *) bfd_malloc (size);
2247 if (contents == NULL)
2248 return FALSE;
2249 }
2250
2251 /* Write out the output compression header. */
2252 if (ohdr_size == sizeof (Elf32_External_Chdr))
2253 {
2254 Elf32_External_Chdr *echdr = (Elf32_External_Chdr *) contents;
2255 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
2256 bfd_put_32 (obfd, chdr.ch_size, &echdr->ch_size);
2257 bfd_put_32 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2258 }
2259 else
2260 {
2261 Elf64_External_Chdr *echdr = (Elf64_External_Chdr *) contents;
c8b187ea 2262 bfd_put_32 (obfd, ELFCOMPRESS_ZLIB, &echdr->ch_type);
8c6da3df 2263 bfd_put_32 (obfd, 0, &echdr->ch_reserved);
88988473
L
2264 bfd_put_64 (obfd, chdr.ch_size, &echdr->ch_size);
2265 bfd_put_64 (obfd, chdr.ch_addralign, &echdr->ch_addralign);
2266 }
2267
2268 /* Copy the compressed contents. */
2269 if (use_memmove)
2270 memmove (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2271 else
2272 {
2273 memcpy (contents + ohdr_size, *ptr + ihdr_size, size - ohdr_size);
2274 free (*ptr);
2275 *ptr = contents;
2276 }
2277
cbd44e24 2278 *ptr_size = size;
88988473
L
2279 return TRUE;
2280}
This page took 0.837282 seconds and 4 git commands to generate.