Merge branch 'vendor/GCC50'
[dragonfly.git] / contrib / binutils-2.24 / ld / ld.texinfo
1 \input texinfo
2 @setfilename ld.info
3 @c Copyright 1991-2013 Free Software Foundation, Inc.
4 @syncodeindex ky cp
5 @c man begin INCLUDE
6 @include configdoc.texi
7 @c (configdoc.texi is generated by the Makefile)
8 @include bfdver.texi
9 @c man end
10
11 @c @smallbook
12
13 @macro gcctabopt{body}
14 @code{\body\}
15 @end macro
16
17 @c man begin NAME
18 @ifset man
19 @c Configure for the generation of man pages
20 @set UsesEnvVars
21 @set GENERIC
22 @set ARM
23 @set C6X
24 @set H8300
25 @set HPPA
26 @set I960
27 @set M68HC11
28 @set M68K
29 @set MIPS
30 @set MMIX
31 @set MSP430
32 @set POWERPC
33 @set POWERPC64
34 @set Renesas
35 @set SPU
36 @set TICOFF
37 @set WIN32
38 @set XTENSA
39 @end ifset
40 @c man end
41
42 @ifnottex
43 @dircategory Software development
44 @direntry
45 * Ld: (ld).                       The GNU linker.
46 @end direntry
47 @end ifnottex
48
49 @copying
50 This file documents the @sc{gnu} linker LD
51 @ifset VERSION_PACKAGE
52 @value{VERSION_PACKAGE}
53 @end ifset
54 version @value{VERSION}.
55
56 Copyright @copyright{} 1991-2013 Free Software Foundation, Inc.
57
58 Permission is granted to copy, distribute and/or modify this document
59 under the terms of the GNU Free Documentation License, Version 1.3
60 or any later version published by the Free Software Foundation;
61 with no Invariant Sections, with no Front-Cover Texts, and with no
62 Back-Cover Texts.  A copy of the license is included in the
63 section entitled ``GNU Free Documentation License''.
64 @end copying
65 @iftex
66 @finalout
67 @setchapternewpage odd
68 @settitle The GNU linker
69 @titlepage
70 @title The GNU linker
71 @sp 1
72 @subtitle @code{ld}
73 @ifset VERSION_PACKAGE
74 @subtitle @value{VERSION_PACKAGE}
75 @end ifset
76 @subtitle Version @value{VERSION}
77 @author Steve Chamberlain
78 @author Ian Lance Taylor
79 @page
80
81 @tex
82 {\parskip=0pt
83 \hfill Red Hat Inc\par
84 \hfill nickc\@credhat.com, doc\@redhat.com\par
85 \hfill {\it The GNU linker}\par
86 \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par
87 }
88 \global\parindent=0pt % Steve likes it this way.
89 @end tex
90
91 @vskip 0pt plus 1filll
92 @c man begin COPYRIGHT
93 Copyright @copyright{} 1991-2013 Free Software Foundation, Inc.
94
95 Permission is granted to copy, distribute and/or modify this document
96 under the terms of the GNU Free Documentation License, Version 1.3
97 or any later version published by the Free Software Foundation;
98 with no Invariant Sections, with no Front-Cover Texts, and with no
99 Back-Cover Texts.  A copy of the license is included in the
100 section entitled ``GNU Free Documentation License''.
101 @c man end
102
103 @end titlepage
104 @end iftex
105 @contents
106 @c FIXME: Talk about importance of *order* of args, cmds to linker!
107
108 @ifnottex
109 @node Top
110 @top LD
111 This file documents the @sc{gnu} linker ld
112 @ifset VERSION_PACKAGE
113 @value{VERSION_PACKAGE}
114 @end ifset
115 version @value{VERSION}.
116
117 This document is distributed under the terms of the GNU Free
118 Documentation License version 1.3.  A copy of the license is included
119 in the section entitled ``GNU Free Documentation License''.
120
121 @menu
122 * Overview::                    Overview
123 * Invocation::                  Invocation
124 * Scripts::                     Linker Scripts
125 @ifset GENERIC
126 * Machine Dependent::           Machine Dependent Features
127 @end ifset
128 @ifclear GENERIC
129 @ifset H8300
130 * H8/300::                      ld and the H8/300
131 @end ifset
132 @ifset Renesas
133 * Renesas::                     ld and other Renesas micros
134 @end ifset
135 @ifset I960
136 * i960::                        ld and the Intel 960 family
137 @end ifset
138 @ifset ARM
139 * ARM::                         ld and the ARM family
140 @end ifset
141 @ifset M68HC11
142 * M68HC11/68HC12::              ld and the Motorola 68HC11 and 68HC12 families
143 @end ifset
144 @ifset HPPA
145 * HPPA ELF32::                  ld and HPPA 32-bit ELF
146 @end ifset
147 @ifset M68K
148 * M68K::                        ld and Motorola 68K family
149 @end ifset
150 @ifset MIPS
151 * MIPS::                        ld and MIPS family
152 @end ifset
153 @ifset POWERPC
154 * PowerPC ELF32::               ld and PowerPC 32-bit ELF Support
155 @end ifset
156 @ifset POWERPC64
157 * PowerPC64 ELF64::             ld and PowerPC64 64-bit ELF Support
158 @end ifset
159 @ifset SPU
160 * SPU ELF::                     ld and SPU ELF Support
161 @end ifset
162 @ifset TICOFF
163 * TI COFF::                     ld and the TI COFF
164 @end ifset
165 @ifset WIN32
166 * Win32::                       ld and WIN32 (cygwin/mingw)
167 @end ifset
168 @ifset XTENSA
169 * Xtensa::                      ld and Xtensa Processors
170 @end ifset
171 @end ifclear
172 @ifclear SingleFormat
173 * BFD::                         BFD
174 @end ifclear
175 @c Following blank line required for remaining bug in makeinfo conds/menus
176
177 * Reporting Bugs::              Reporting Bugs
178 * MRI::                         MRI Compatible Script Files
179 * GNU Free Documentation License::  GNU Free Documentation License
180 * LD Index::                       LD Index
181 @end menu
182 @end ifnottex
183
184 @node Overview
185 @chapter Overview
186
187 @cindex @sc{gnu} linker
188 @cindex what is this?
189
190 @ifset man
191 @c man begin SYNOPSIS
192 ld [@b{options}] @var{objfile} @dots{}
193 @c man end
194
195 @c man begin SEEALSO
196 ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and
197 the Info entries for @file{binutils} and
198 @file{ld}.
199 @c man end
200 @end ifset
201
202 @c man begin DESCRIPTION
203
204 @command{ld} combines a number of object and archive files, relocates
205 their data and ties up symbol references. Usually the last step in
206 compiling a program is to run @command{ld}.
207
208 @command{ld} accepts Linker Command Language files written in
209 a superset of AT&T's Link Editor Command Language syntax,
210 to provide explicit and total control over the linking process.
211
212 @ifset man
213 @c For the man only
214 This man page does not describe the command language; see the
215 @command{ld} entry in @code{info} for full details on the command
216 language and on other aspects of the GNU linker.
217 @end ifset
218
219 @ifclear SingleFormat
220 This version of @command{ld} uses the general purpose BFD libraries
221 to operate on object files. This allows @command{ld} to read, combine, and
222 write object files in many different formats---for example, COFF or
223 @code{a.out}.  Different formats may be linked together to produce any
224 available kind of object file.  @xref{BFD}, for more information.
225 @end ifclear
226
227 Aside from its flexibility, the @sc{gnu} linker is more helpful than other
228 linkers in providing diagnostic information.  Many linkers abandon
229 execution immediately upon encountering an error; whenever possible,
230 @command{ld} continues executing, allowing you to identify other errors
231 (or, in some cases, to get an output file in spite of the error).
232
233 @c man end
234
235 @node Invocation
236 @chapter Invocation
237
238 @c man begin DESCRIPTION
239
240 The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations,
241 and to be as compatible as possible with other linkers.  As a result,
242 you have many choices to control its behavior.
243
244 @c man end
245
246 @ifset UsesEnvVars
247 @menu
248 * Options::                     Command Line Options
249 * Environment::                 Environment Variables
250 @end menu
251
252 @node Options
253 @section Command Line Options
254 @end ifset
255
256 @cindex command line
257 @cindex options
258
259 @c man begin OPTIONS
260
261 The linker supports a plethora of command-line options, but in actual
262 practice few of them are used in any particular context.
263 @cindex standard Unix system
264 For instance, a frequent use of @command{ld} is to link standard Unix
265 object files on a standard, supported Unix system.  On such a system, to
266 link a file @code{hello.o}:
267
268 @smallexample
269 ld -o @var{output} /lib/crt0.o hello.o -lc
270 @end smallexample
271
272 This tells @command{ld} to produce a file called @var{output} as the
273 result of linking the file @code{/lib/crt0.o} with @code{hello.o} and
274 the library @code{libc.a}, which will come from the standard search
275 directories.  (See the discussion of the @samp{-l} option below.)
276
277 Some of the command-line options to @command{ld} may be specified at any
278 point in the command line.  However, options which refer to files, such
279 as @samp{-l} or @samp{-T}, cause the file to be read at the point at
280 which the option appears in the command line, relative to the object
281 files and other file options.  Repeating non-file options with a
282 different argument will either have no further effect, or override prior
283 occurrences (those further to the left on the command line) of that
284 option.  Options which may be meaningfully specified more than once are
285 noted in the descriptions below.
286
287 @cindex object files
288 Non-option arguments are object files or archives which are to be linked
289 together.  They may follow, precede, or be mixed in with command-line
290 options, except that an object file argument may not be placed between
291 an option and its argument.
292
293 Usually the linker is invoked with at least one object file, but you can
294 specify other forms of binary input files using @samp{-l}, @samp{-R},
295 and the script command language.  If @emph{no} binary input files at all
296 are specified, the linker does not produce any output, and issues the
297 message @samp{No input files}.
298
299 If the linker cannot recognize the format of an object file, it will
300 assume that it is a linker script.  A script specified in this way
301 augments the main linker script used for the link (either the default
302 linker script or the one specified by using @samp{-T}).  This feature
303 permits the linker to link against a file which appears to be an object
304 or an archive, but actually merely defines some symbol values, or uses
305 @code{INPUT} or @code{GROUP} to load other objects.  Specifying a
306 script in this way merely augments the main linker script, with the
307 extra commands placed after the main script; use the @samp{-T} option
308 to replace the default linker script entirely, but note the effect of
309 the @code{INSERT} command.  @xref{Scripts}.
310
311 For options whose names are a single letter,
312 option arguments must either follow the option letter without intervening
313 whitespace, or be given as separate arguments immediately following the
314 option that requires them.
315
316 For options whose names are multiple letters, either one dash or two can
317 precede the option name; for example, @samp{-trace-symbol} and
318 @samp{--trace-symbol} are equivalent.  Note---there is one exception to
319 this rule.  Multiple letter options that start with a lower case 'o' can
320 only be preceded by two dashes.  This is to reduce confusion with the
321 @samp{-o} option.  So for example @samp{-omagic} sets the output file
322 name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the
323 output.
324
325 Arguments to multiple-letter options must either be separated from the
326 option name by an equals sign, or be given as separate arguments
327 immediately following the option that requires them.  For example,
328 @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent.
329 Unique abbreviations of the names of multiple-letter options are
330 accepted.
331
332 Note---if the linker is being invoked indirectly, via a compiler driver
333 (e.g. @samp{gcc}) then all the linker command line options should be
334 prefixed by @samp{-Wl,} (or whatever is appropriate for the particular
335 compiler driver) like this:
336
337 @smallexample
338   gcc -Wl,--start-group foo.o bar.o -Wl,--end-group
339 @end smallexample
340
341 This is important, because otherwise the compiler driver program may
342 silently drop the linker options, resulting in a bad link.  Confusion
343 may also arise when passing options that require values through a
344 driver, as the use of a space between option and argument acts as
345 a separator, and causes the driver to pass only the option to the linker
346 and the argument to the compiler.  In this case, it is simplest to use
347 the joined forms of both single- and multiple-letter options, such as:
348
349 @smallexample
350   gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map
351 @end smallexample
352
353 Here is a table of the generic command line switches accepted by the GNU
354 linker:
355
356 @table @gcctabopt
357 @include at-file.texi
358
359 @kindex -a @var{keyword}
360 @item -a @var{keyword}
361 This option is supported for HP/UX compatibility.  The @var{keyword}
362 argument must be one of the strings @samp{archive}, @samp{shared}, or
363 @samp{default}.  @samp{-aarchive} is functionally equivalent to
364 @samp{-Bstatic}, and the other two keywords are functionally equivalent
365 to @samp{-Bdynamic}.  This option may be used any number of times.
366
367 @kindex --audit @var{AUDITLIB}
368 @item --audit @var{AUDITLIB}
369 Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section.
370 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
371 specified in the library.  If specified multiple times @code{DT_AUDIT}
372 will contain a colon separated list of audit interfaces to use. If the linker
373 finds an object with an audit entry while searching for shared libraries,
374 it will add a corresponding @code{DT_DEPAUDIT} entry in the output file.
375 This option is only meaningful on ELF platforms supporting the rtld-audit
376 interface.
377
378 @ifset I960
379 @cindex architectures
380 @kindex -A @var{arch}
381 @item -A @var{architecture}
382 @kindex --architecture=@var{arch}
383 @itemx --architecture=@var{architecture}
384 In the current release of @command{ld}, this option is useful only for the
385 Intel 960 family of architectures.  In that @command{ld} configuration, the
386 @var{architecture} argument identifies the particular architecture in
387 the 960 family, enabling some safeguards and modifying the
388 archive-library search path.  @xref{i960,,@command{ld} and the Intel 960
389 family}, for details.
390
391 Future releases of @command{ld} may support similar functionality for
392 other architecture families.
393 @end ifset
394
395 @ifclear SingleFormat
396 @cindex binary input format
397 @kindex -b @var{format}
398 @kindex --format=@var{format}
399 @cindex input format
400 @cindex input format
401 @item -b @var{input-format}
402 @itemx --format=@var{input-format}
403 @command{ld} may be configured to support more than one kind of object
404 file.  If your @command{ld} is configured this way, you can use the
405 @samp{-b} option to specify the binary format for input object files
406 that follow this option on the command line.  Even when @command{ld} is
407 configured to support alternative object formats, you don't usually need
408 to specify this, as @command{ld} should be configured to expect as a
409 default input format the most usual format on each machine.
410 @var{input-format} is a text string, the name of a particular format
411 supported by the BFD libraries.  (You can list the available binary
412 formats with @samp{objdump -i}.)
413 @xref{BFD}.
414
415 You may want to use this option if you are linking files with an unusual
416 binary format.  You can also use @samp{-b} to switch formats explicitly (when
417 linking object files of different formats), by including
418 @samp{-b @var{input-format}} before each group of object files in a
419 particular format.
420
421 The default format is taken from the environment variable
422 @code{GNUTARGET}.
423 @ifset UsesEnvVars
424 @xref{Environment}.
425 @end ifset
426 You can also define the input format from a script, using the command
427 @code{TARGET};
428 @ifclear man
429 see @ref{Format Commands}.
430 @end ifclear
431 @end ifclear
432
433 @kindex -c @var{MRI-cmdfile}
434 @kindex --mri-script=@var{MRI-cmdfile}
435 @cindex compatibility, MRI
436 @item -c @var{MRI-commandfile}
437 @itemx --mri-script=@var{MRI-commandfile}
438 For compatibility with linkers produced by MRI, @command{ld} accepts script
439 files written in an alternate, restricted command language, described in
440 @ifclear man
441 @ref{MRI,,MRI Compatible Script Files}.
442 @end ifclear
443 @ifset man
444 the MRI Compatible Script Files section of GNU ld documentation.
445 @end ifset
446 Introduce MRI script files with
447 the option @samp{-c}; use the @samp{-T} option to run linker
448 scripts written in the general-purpose @command{ld} scripting language.
449 If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories
450 specified by any @samp{-L} options.
451
452 @cindex common allocation
453 @kindex -d
454 @kindex -dc
455 @kindex -dp
456 @item -d
457 @itemx -dc
458 @itemx -dp
459 These three options are equivalent; multiple forms are supported for
460 compatibility with other linkers.  They assign space to common symbols
461 even if a relocatable output file is specified (with @samp{-r}).  The
462 script command @code{FORCE_COMMON_ALLOCATION} has the same effect.
463 @xref{Miscellaneous Commands}.
464
465 @kindex --depaudit @var{AUDITLIB}
466 @kindex -P @var{AUDITLIB}
467 @item --depaudit @var{AUDITLIB}
468 @itemx -P @var{AUDITLIB}
469 Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section.
470 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
471 specified in the library.  If specified multiple times @code{DT_DEPAUDIT}
472 will contain a colon separated list of audit interfaces to use.  This
473 option is only meaningful on ELF platforms supporting the rtld-audit interface.
474 The -P option is provided for Solaris compatibility.
475
476 @cindex entry point, from command line
477 @kindex -e @var{entry}
478 @kindex --entry=@var{entry}
479 @item -e @var{entry}
480 @itemx --entry=@var{entry}
481 Use @var{entry} as the explicit symbol for beginning execution of your
482 program, rather than the default entry point.  If there is no symbol
483 named @var{entry}, the linker will try to parse @var{entry} as a number,
484 and use that as the entry address (the number will be interpreted in
485 base 10; you may use a leading @samp{0x} for base 16, or a leading
486 @samp{0} for base 8).  @xref{Entry Point}, for a discussion of defaults
487 and other ways of specifying the entry point.
488
489 @kindex --exclude-libs
490 @item --exclude-libs @var{lib},@var{lib},...
491 Specifies a list of archive libraries from which symbols should not be automatically
492 exported.  The library names may be delimited by commas or colons.  Specifying
493 @code{--exclude-libs ALL} excludes symbols in all archive libraries from
494 automatic export.  This option is available only for the i386 PE targeted
495 port of the linker and for ELF targeted ports.  For i386 PE, symbols
496 explicitly listed in a .def file are still exported, regardless of this
497 option.  For ELF targeted ports, symbols affected by this option will
498 be treated as hidden.
499
500 @kindex --exclude-modules-for-implib
501 @item --exclude-modules-for-implib @var{module},@var{module},...
502 Specifies a list of object files or archive members, from which symbols
503 should not be automatically exported, but which should be copied wholesale
504 into the import library being generated during the link.  The module names
505 may be delimited by commas or colons, and must match exactly the filenames
506 used by @command{ld} to open the files; for archive members, this is simply
507 the member name, but for object files the name listed must include and
508 match precisely any path used to specify the input file on the linker's
509 command-line.  This option is available only for the i386 PE targeted port
510 of the linker.  Symbols explicitly listed in a .def file are still exported,
511 regardless of this option.
512
513 @cindex dynamic symbol table
514 @kindex -E
515 @kindex --export-dynamic
516 @kindex --no-export-dynamic
517 @item -E
518 @itemx --export-dynamic
519 @itemx --no-export-dynamic
520 When creating a dynamically linked executable, using the @option{-E}
521 option or the @option{--export-dynamic} option causes the linker to add
522 all symbols to the dynamic symbol table.  The dynamic symbol table is the
523 set of symbols which are visible from dynamic objects at run time.
524
525 If you do not use either of these options (or use the
526 @option{--no-export-dynamic} option to restore the default behavior), the
527 dynamic symbol table will normally contain only those symbols which are
528 referenced by some dynamic object mentioned in the link.
529
530 If you use @code{dlopen} to load a dynamic object which needs to refer
531 back to the symbols defined by the program, rather than some other
532 dynamic object, then you will probably need to use this option when
533 linking the program itself.
534
535 You can also use the dynamic list to control what symbols should
536 be added to the dynamic symbol table if the output format supports it.
537 See the description of @samp{--dynamic-list}.
538
539 Note that this option is specific to ELF targeted ports.  PE targets
540 support a similar function to export all symbols from a DLL or EXE; see
541 the description of @samp{--export-all-symbols} below.
542
543 @ifclear SingleFormat
544 @cindex big-endian objects
545 @cindex endianness
546 @kindex -EB
547 @item -EB
548 Link big-endian objects.  This affects the default output format.
549
550 @cindex little-endian objects
551 @kindex -EL
552 @item -EL
553 Link little-endian objects.  This affects the default output format.
554 @end ifclear
555
556 @kindex -f @var{name}
557 @kindex --auxiliary=@var{name}
558 @item -f @var{name}
559 @itemx --auxiliary=@var{name}
560 When creating an ELF shared object, set the internal DT_AUXILIARY field
561 to the specified name.  This tells the dynamic linker that the symbol
562 table of the shared object should be used as an auxiliary filter on the
563 symbol table of the shared object @var{name}.
564
565 If you later link a program against this filter object, then, when you
566 run the program, the dynamic linker will see the DT_AUXILIARY field.  If
567 the dynamic linker resolves any symbols from the filter object, it will
568 first check whether there is a definition in the shared object
569 @var{name}.  If there is one, it will be used instead of the definition
570 in the filter object.  The shared object @var{name} need not exist.
571 Thus the shared object @var{name} may be used to provide an alternative
572 implementation of certain functions, perhaps for debugging or for
573 machine specific performance.
574
575 This option may be specified more than once.  The DT_AUXILIARY entries
576 will be created in the order in which they appear on the command line.
577
578 @kindex -F @var{name}
579 @kindex --filter=@var{name}
580 @item -F @var{name}
581 @itemx --filter=@var{name}
582 When creating an ELF shared object, set the internal DT_FILTER field to
583 the specified name.  This tells the dynamic linker that the symbol table
584 of the shared object which is being created should be used as a filter
585 on the symbol table of the shared object @var{name}.
586
587 If you later link a program against this filter object, then, when you
588 run the program, the dynamic linker will see the DT_FILTER field.  The
589 dynamic linker will resolve symbols according to the symbol table of the
590 filter object as usual, but it will actually link to the definitions
591 found in the shared object @var{name}.  Thus the filter object can be
592 used to select a subset of the symbols provided by the object
593 @var{name}.
594
595 Some older linkers used the @option{-F} option throughout a compilation
596 toolchain for specifying object-file format for both input and output
597 object files.
598 @ifclear SingleFormat
599 The @sc{gnu} linker uses other mechanisms for this purpose: the
600 @option{-b}, @option{--format}, @option{--oformat} options, the
601 @code{TARGET} command in linker scripts, and the @code{GNUTARGET}
602 environment variable.
603 @end ifclear
604 The @sc{gnu} linker will ignore the @option{-F} option when not
605 creating an ELF shared object.
606
607 @cindex finalization function
608 @kindex -fini=@var{name}
609 @item -fini=@var{name}
610 When creating an ELF executable or shared object, call NAME when the
611 executable or shared object is unloaded, by setting DT_FINI to the
612 address of the function.  By default, the linker uses @code{_fini} as
613 the function to call.
614
615 @kindex -g
616 @item -g
617 Ignored.  Provided for compatibility with other tools.
618
619 @kindex -G @var{value}
620 @kindex --gpsize=@var{value}
621 @cindex object size
622 @item -G @var{value}
623 @itemx --gpsize=@var{value}
624 Set the maximum size of objects to be optimized using the GP register to
625 @var{size}.  This is only meaningful for object file formats such as
626 MIPS ELF that support putting large and small objects into different
627 sections.  This is ignored for other object file formats.
628
629 @cindex runtime library name
630 @kindex -h @var{name}
631 @kindex -soname=@var{name}
632 @item -h @var{name}
633 @itemx -soname=@var{name}
634 When creating an ELF shared object, set the internal DT_SONAME field to
635 the specified name.  When an executable is linked with a shared object
636 which has a DT_SONAME field, then when the executable is run the dynamic
637 linker will attempt to load the shared object specified by the DT_SONAME
638 field rather than the using the file name given to the linker.
639
640 @kindex -i
641 @cindex incremental link
642 @item -i
643 Perform an incremental link (same as option @samp{-r}).
644
645 @cindex initialization function
646 @kindex -init=@var{name}
647 @item -init=@var{name}
648 When creating an ELF executable or shared object, call NAME when the
649 executable or shared object is loaded, by setting DT_INIT to the address
650 of the function.  By default, the linker uses @code{_init} as the
651 function to call.
652
653 @cindex archive files, from cmd line
654 @kindex -l @var{namespec}
655 @kindex --library=@var{namespec}
656 @item -l @var{namespec}
657 @itemx --library=@var{namespec}
658 Add the archive or object file specified by @var{namespec} to the
659 list of files to link.  This option may be used any number of times.
660 If @var{namespec} is of the form @file{:@var{filename}}, @command{ld}
661 will search the library path for a file called @var{filename}, otherwise it
662 will search the library path for a file called @file{lib@var{namespec}.a}.
663
664 On systems which support shared libraries, @command{ld} may also search for
665 files other than @file{lib@var{namespec}.a}.  Specifically, on ELF
666 and SunOS systems, @command{ld} will search a directory for a library
667 called @file{lib@var{namespec}.so} before searching for one called
668 @file{lib@var{namespec}.a}.  (By convention, a @code{.so} extension
669 indicates a shared library.)  Note that this behavior does not apply
670 to @file{:@var{filename}}, which always specifies a file called
671 @var{filename}.
672
673 The linker will search an archive only once, at the location where it is
674 specified on the command line.  If the archive defines a symbol which
675 was undefined in some object which appeared before the archive on the
676 command line, the linker will include the appropriate file(s) from the
677 archive.  However, an undefined symbol in an object appearing later on
678 the command line will not cause the linker to search the archive again.
679
680 See the @option{-(} option for a way to force the linker to search
681 archives multiple times.
682
683 You may list the same archive multiple times on the command line.
684
685 @ifset GENERIC
686 This type of archive searching is standard for Unix linkers.  However,
687 if you are using @command{ld} on AIX, note that it is different from the
688 behaviour of the AIX linker.
689 @end ifset
690
691 @cindex search directory, from cmd line
692 @kindex -L @var{dir}
693 @kindex --library-path=@var{dir}
694 @item -L @var{searchdir}
695 @itemx --library-path=@var{searchdir}
696 Add path @var{searchdir} to the list of paths that @command{ld} will search
697 for archive libraries and @command{ld} control scripts.  You may use this
698 option any number of times.  The directories are searched in the order
699 in which they are specified on the command line.  Directories specified
700 on the command line are searched before the default directories.  All
701 @option{-L} options apply to all @option{-l} options, regardless of the
702 order in which the options appear.  @option{-L} options do not affect
703 how @command{ld} searches for a linker script unless @option{-T}
704 option is specified.
705
706 If @var{searchdir} begins with @code{=}, then the @code{=} will be replaced
707 by the @dfn{sysroot prefix}, a path specified when the linker is configured.
708
709 @ifset UsesEnvVars
710 The default set of paths searched (without being specified with
711 @samp{-L}) depends on which emulation mode @command{ld} is using, and in
712 some cases also on how it was configured.  @xref{Environment}.
713 @end ifset
714
715 The paths can also be specified in a link script with the
716 @code{SEARCH_DIR} command.  Directories specified this way are searched
717 at the point in which the linker script appears in the command line.
718
719 @cindex emulation
720 @kindex -m @var{emulation}
721 @item -m @var{emulation}
722 Emulate the @var{emulation} linker.  You can list the available
723 emulations with the @samp{--verbose} or @samp{-V} options.
724
725 If the @samp{-m} option is not used, the emulation is taken from the
726 @code{LDEMULATION} environment variable, if that is defined.
727
728 Otherwise, the default emulation depends upon how the linker was
729 configured.
730
731 @cindex link map
732 @kindex -M
733 @kindex --print-map
734 @item -M
735 @itemx --print-map
736 Print a link map to the standard output.  A link map provides
737 information about the link, including the following:
738
739 @itemize @bullet
740 @item
741 Where object files are mapped into memory.
742 @item
743 How common symbols are allocated.
744 @item
745 All archive members included in the link, with a mention of the symbol
746 which caused the archive member to be brought in.
747 @item
748 The values assigned to symbols.
749
750 Note - symbols whose values are computed by an expression which
751 involves a reference to a previous value of the same symbol may not
752 have correct result displayed in the link map.  This is because the
753 linker discards intermediate results and only retains the final value
754 of an expression.  Under such circumstances the linker will display
755 the final value enclosed by square brackets.  Thus for example a
756 linker script containing:
757
758 @smallexample
759    foo = 1
760    foo = foo * 4
761    foo = foo + 8
762 @end smallexample
763
764 will produce the following output in the link map if the @option{-M}
765 option is used:
766
767 @smallexample
768    0x00000001                foo = 0x1
769    [0x0000000c]                foo = (foo * 0x4)
770    [0x0000000c]                foo = (foo + 0x8)
771 @end smallexample
772
773 See @ref{Expressions} for more information about expressions in linker
774 scripts.
775 @end itemize
776
777 @kindex -n
778 @cindex read-only text
779 @cindex NMAGIC
780 @kindex --nmagic
781 @item -n
782 @itemx --nmagic
783 Turn off page alignment of sections, and disable linking against shared
784 libraries.  If the output format supports Unix style magic numbers,
785 mark the output as @code{NMAGIC}.
786
787 @kindex -N
788 @kindex --omagic
789 @cindex read/write from cmd line
790 @cindex OMAGIC
791 @item -N
792 @itemx --omagic
793 Set the text and data sections to be readable and writable.  Also, do
794 not page-align the data segment, and disable linking against shared
795 libraries.  If the output format supports Unix style magic numbers,
796 mark the output as @code{OMAGIC}. Note: Although a writable text section
797 is allowed for PE-COFF targets, it does not conform to the format
798 specification published by Microsoft.
799
800 @kindex --no-omagic
801 @cindex OMAGIC
802 @item --no-omagic
803 This option negates most of the effects of the @option{-N} option.  It
804 sets the text section to be read-only, and forces the data segment to
805 be page-aligned.  Note - this option does not enable linking against
806 shared libraries.  Use @option{-Bdynamic} for this.
807
808 @kindex -o @var{output}
809 @kindex --output=@var{output}
810 @cindex naming the output file
811 @item -o @var{output}
812 @itemx --output=@var{output}
813 Use @var{output} as the name for the program produced by @command{ld}; if this
814 option is not specified, the name @file{a.out} is used by default.  The
815 script command @code{OUTPUT} can also specify the output file name.
816
817 @kindex -O @var{level}
818 @cindex generating optimized output
819 @item -O @var{level}
820 If @var{level} is a numeric values greater than zero @command{ld} optimizes
821 the output.  This might take significantly longer and therefore probably
822 should only be enabled for the final binary.  At the moment this
823 option only affects ELF shared library generation.  Future releases of
824 the linker may make more use of this option.  Also currently there is
825 no difference in the linker's behaviour for different non-zero values
826 of this option.  Again this may change with future releases.
827
828 @kindex -q
829 @kindex --emit-relocs
830 @cindex retain relocations in final executable
831 @item -q
832 @itemx --emit-relocs
833 Leave relocation sections and contents in fully linked executables.
834 Post link analysis and optimization tools may need this information in
835 order to perform correct modifications of executables.  This results
836 in larger executables.
837
838 This option is currently only supported on ELF platforms.
839
840 @kindex --force-dynamic
841 @cindex forcing the creation of dynamic sections
842 @item --force-dynamic
843 Force the output file to have dynamic sections.  This option is specific
844 to VxWorks targets.
845
846 @cindex partial link
847 @cindex relocatable output
848 @kindex -r
849 @kindex --relocatable
850 @item -r
851 @itemx --relocatable
852 Generate relocatable output---i.e., generate an output file that can in
853 turn serve as input to @command{ld}.  This is often called @dfn{partial
854 linking}.  As a side effect, in environments that support standard Unix
855 magic numbers, this option also sets the output file's magic number to
856 @code{OMAGIC}.
857 @c ; see @option{-N}.
858 If this option is not specified, an absolute file is produced.  When
859 linking C++ programs, this option @emph{will not} resolve references to
860 constructors; to do that, use @samp{-Ur}.
861
862 When an input file does not have the same format as the output file,
863 partial linking is only supported if that input file does not contain any
864 relocations.  Different output formats can have further restrictions; for
865 example some @code{a.out}-based formats do not support partial linking
866 with input files in other formats at all.
867
868 This option does the same thing as @samp{-i}.
869
870 @kindex -R @var{file}
871 @kindex --just-symbols=@var{file}
872 @cindex symbol-only input
873 @item -R @var{filename}
874 @itemx --just-symbols=@var{filename}
875 Read symbol names and their addresses from @var{filename}, but do not
876 relocate it or include it in the output.  This allows your output file
877 to refer symbolically to absolute locations of memory defined in other
878 programs.  You may use this option more than once.
879
880 For compatibility with other ELF linkers, if the @option{-R} option is
881 followed by a directory name, rather than a file name, it is treated as
882 the @option{-rpath} option.
883
884 @kindex -s
885 @kindex --strip-all
886 @cindex strip all symbols
887 @item -s
888 @itemx --strip-all
889 Omit all symbol information from the output file.
890
891 @kindex -S
892 @kindex --strip-debug
893 @cindex strip debugger symbols
894 @item -S
895 @itemx --strip-debug
896 Omit debugger symbol information (but not all symbols) from the output file.
897
898 @kindex -t
899 @kindex --trace
900 @cindex input files, displaying
901 @item -t
902 @itemx --trace
903 Print the names of the input files as @command{ld} processes them.
904
905 @kindex -T @var{script}
906 @kindex --script=@var{script}
907 @cindex script files
908 @item -T @var{scriptfile}
909 @itemx --script=@var{scriptfile}
910 Use @var{scriptfile} as the linker script.  This script replaces
911 @command{ld}'s default linker script (rather than adding to it), so
912 @var{commandfile} must specify everything necessary to describe the
913 output file.  @xref{Scripts}.  If @var{scriptfile} does not exist in
914 the current directory, @code{ld} looks for it in the directories
915 specified by any preceding @samp{-L} options.  Multiple @samp{-T}
916 options accumulate.
917
918 @kindex -dT @var{script}
919 @kindex --default-script=@var{script}
920 @cindex script files
921 @item -dT @var{scriptfile}
922 @itemx --default-script=@var{scriptfile}
923 Use @var{scriptfile} as the default linker script.  @xref{Scripts}.
924
925 This option is similar to the @option{--script} option except that
926 processing of the script is delayed until after the rest of the
927 command line has been processed.  This allows options placed after the
928 @option{--default-script} option on the command line to affect the
929 behaviour of the linker script, which can be important when the linker
930 command line cannot be directly controlled by the user.  (eg because
931 the command line is being constructed by another tool, such as
932 @samp{gcc}).
933
934 @kindex -u @var{symbol}
935 @kindex --undefined=@var{symbol}
936 @cindex undefined symbol
937 @item -u @var{symbol}
938 @itemx --undefined=@var{symbol}
939 Force @var{symbol} to be entered in the output file as an undefined
940 symbol.  Doing this may, for example, trigger linking of additional
941 modules from standard libraries.  @samp{-u} may be repeated with
942 different option arguments to enter additional undefined symbols.  This
943 option is equivalent to the @code{EXTERN} linker script command.
944
945 @kindex -Ur
946 @cindex constructors
947 @item -Ur
948 For anything other than C++ programs, this option is equivalent to
949 @samp{-r}: it generates relocatable output---i.e., an output file that can in
950 turn serve as input to @command{ld}.  When linking C++ programs, @samp{-Ur}
951 @emph{does} resolve references to constructors, unlike @samp{-r}.
952 It does not work to use @samp{-Ur} on files that were themselves linked
953 with @samp{-Ur}; once the constructor table has been built, it cannot
954 be added to.  Use @samp{-Ur} only for the last partial link, and
955 @samp{-r} for the others.
956
957 @kindex --unique[=@var{SECTION}]
958 @item --unique[=@var{SECTION}]
959 Creates a separate output section for every input section matching
960 @var{SECTION}, or if the optional wildcard @var{SECTION} argument is
961 missing, for every orphan input section.  An orphan section is one not
962 specifically mentioned in a linker script.  You may use this option
963 multiple times on the command line;  It prevents the normal merging of
964 input sections with the same name, overriding output section assignments
965 in a linker script.
966
967 @kindex -v
968 @kindex -V
969 @kindex --version
970 @cindex version
971 @item -v
972 @itemx --version
973 @itemx -V
974 Display the version number for @command{ld}.  The @option{-V} option also
975 lists the supported emulations.
976
977 @kindex -x
978 @kindex --discard-all
979 @cindex deleting local symbols
980 @item -x
981 @itemx --discard-all
982 Delete all local symbols.
983
984 @kindex -X
985 @kindex --discard-locals
986 @cindex local symbols, deleting
987 @item -X
988 @itemx --discard-locals
989 Delete all temporary local symbols.  (These symbols start with
990 system-specific local label prefixes, typically @samp{.L} for ELF systems
991 or @samp{L} for traditional a.out systems.)
992
993 @kindex -y @var{symbol}
994 @kindex --trace-symbol=@var{symbol}
995 @cindex symbol tracing
996 @item -y @var{symbol}
997 @itemx --trace-symbol=@var{symbol}
998 Print the name of each linked file in which @var{symbol} appears.  This
999 option may be given any number of times.  On many systems it is necessary
1000 to prepend an underscore.
1001
1002 This option is useful when you have an undefined symbol in your link but
1003 don't know where the reference is coming from.
1004
1005 @kindex -Y @var{path}
1006 @item -Y @var{path}
1007 Add @var{path} to the default library search path.  This option exists
1008 for Solaris compatibility.
1009
1010 @kindex -z @var{keyword}
1011 @item -z @var{keyword}
1012 The recognized keywords are:
1013 @table @samp
1014
1015 @item combreloc
1016 Combines multiple reloc sections and sorts them to make dynamic symbol
1017 lookup caching possible.
1018
1019 @item defs
1020 Disallows undefined symbols in object files.  Undefined symbols in
1021 shared libraries are still allowed.
1022
1023 @item execstack
1024 Marks the object as requiring executable stack.
1025
1026 @item global
1027 This option is only meaningful when building a shared object.  It makes
1028 the symbols defined by this shared object available for symbol resolution
1029 of subsequently loaded libraries.
1030
1031 @item initfirst
1032 This option is only meaningful when building a shared object.
1033 It marks the object so that its runtime initialization will occur
1034 before the runtime initialization of any other objects brought into
1035 the process at the same time.  Similarly the runtime finalization of
1036 the object will occur after the runtime finalization of any other
1037 objects.
1038
1039 @item interpose
1040 Marks the object that its symbol table interposes before all symbols
1041 but the primary executable.
1042
1043 @item lazy
1044 When generating an executable or shared library, mark it to tell the
1045 dynamic linker to defer function call resolution to the point when
1046 the function is called (lazy binding), rather than at load time.
1047 Lazy binding is the default.
1048
1049 @item loadfltr
1050 Marks  the object that its filters be processed immediately at
1051 runtime.
1052
1053 @item muldefs
1054 Allows multiple definitions.
1055
1056 @item nocombreloc
1057 Disables multiple reloc sections combining.
1058
1059 @item nocopyreloc
1060 Disables production of copy relocs.
1061
1062 @item nodefaultlib
1063 Marks the object that the search for dependencies of this object will
1064 ignore any default library search paths.
1065
1066 @item nodelete
1067 Marks the object shouldn't be unloaded at runtime.
1068
1069 @item nodlopen
1070 Marks the object not available to @code{dlopen}.
1071
1072 @item nodump
1073 Marks the object can not be dumped by @code{dldump}.
1074
1075 @item noexecstack
1076 Marks the object as not requiring executable stack.
1077
1078 @item norelro
1079 Don't create an ELF @code{PT_GNU_RELRO} segment header in the object.
1080
1081 @item now
1082 When generating an executable or shared library, mark it to tell the
1083 dynamic linker to resolve all symbols when the program is started, or
1084 when the shared library is linked to using dlopen, instead of
1085 deferring function call resolution to the point when the function is
1086 first called.
1087
1088 @item origin
1089 Marks the object may contain $ORIGIN.
1090
1091 @item relro
1092 Create an ELF @code{PT_GNU_RELRO} segment header in the object.
1093
1094 @item max-page-size=@var{value}
1095 Set the emulation maximum page size to @var{value}.
1096
1097 @item common-page-size=@var{value}
1098 Set the emulation common page size to @var{value}.
1099
1100 @item stack-size=@var{value}
1101 Specify a stack size for in an ELF @code{PT_GNU_STACK} segment.
1102 Specifying zero will override any default non-zero sized
1103 @code{PT_GNU_STACK} segment creation.
1104
1105 @end table
1106
1107 Other keywords are ignored for Solaris compatibility.
1108
1109 @kindex -(
1110 @cindex groups of archives
1111 @item -( @var{archives} -)
1112 @itemx --start-group @var{archives} --end-group
1113 The @var{archives} should be a list of archive files.  They may be
1114 either explicit file names, or @samp{-l} options.
1115
1116 The specified archives are searched repeatedly until no new undefined
1117 references are created.  Normally, an archive is searched only once in
1118 the order that it is specified on the command line.  If a symbol in that
1119 archive is needed to resolve an undefined symbol referred to by an
1120 object in an archive that appears later on the command line, the linker
1121 would not be able to resolve that reference.  By grouping the archives,
1122 they all be searched repeatedly until all possible references are
1123 resolved.
1124
1125 Using this option has a significant performance cost.  It is best to use
1126 it only when there are unavoidable circular references between two or
1127 more archives.
1128
1129 @kindex --accept-unknown-input-arch
1130 @kindex --no-accept-unknown-input-arch
1131 @item --accept-unknown-input-arch
1132 @itemx --no-accept-unknown-input-arch
1133 Tells the linker to accept input files whose architecture cannot be
1134 recognised.  The assumption is that the user knows what they are doing
1135 and deliberately wants to link in these unknown input files.  This was
1136 the default behaviour of the linker, before release 2.14.  The default
1137 behaviour from release 2.14 onwards is to reject such input files, and
1138 so the @samp{--accept-unknown-input-arch} option has been added to
1139 restore the old behaviour.
1140
1141 @kindex --as-needed
1142 @kindex --no-as-needed
1143 @item --as-needed
1144 @itemx --no-as-needed
1145 This option affects ELF DT_NEEDED tags for dynamic libraries mentioned
1146 on the command line after the @option{--as-needed} option.  Normally
1147 the linker will add a DT_NEEDED tag for each dynamic library mentioned
1148 on the command line, regardless of whether the library is actually
1149 needed or not.  @option{--as-needed} causes a DT_NEEDED tag to only be
1150 emitted for a library that @emph{at that point in the link} satisfies a
1151 non-weak undefined symbol reference from a regular object file or, if
1152 the library is not found in the DT_NEEDED lists of other libraries, a
1153 non-weak undefined symbol reference from another dynamic library.
1154 Object files or libraries appearing on the command line @emph{after}
1155 the library in question do not affect whether the library is seen as
1156 needed.  This is similar to the rules for extraction of object files
1157 from archives.  @option{--no-as-needed} restores the default behaviour.
1158
1159 @kindex --add-needed
1160 @kindex --no-add-needed
1161 @item --add-needed
1162 @itemx --no-add-needed
1163 These two options have been deprecated because of the similarity of
1164 their names to the @option{--as-needed} and @option{--no-as-needed}
1165 options.  They have been replaced by @option{--copy-dt-needed-entries}
1166 and @option{--no-copy-dt-needed-entries}.
1167
1168 @kindex -assert @var{keyword}
1169 @item -assert @var{keyword}
1170 This option is ignored for SunOS compatibility.
1171
1172 @kindex -Bdynamic
1173 @kindex -dy
1174 @kindex -call_shared
1175 @item -Bdynamic
1176 @itemx -dy
1177 @itemx -call_shared
1178 Link against dynamic libraries.  This is only meaningful on platforms
1179 for which shared libraries are supported.  This option is normally the
1180 default on such platforms.  The different variants of this option are
1181 for compatibility with various systems.  You may use this option
1182 multiple times on the command line: it affects library searching for
1183 @option{-l} options which follow it.
1184
1185 @kindex -Bgroup
1186 @item -Bgroup
1187 Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic
1188 section.  This causes the runtime linker to handle lookups in this
1189 object and its dependencies to be performed only inside the group.
1190 @option{--unresolved-symbols=report-all} is implied.  This option is
1191 only meaningful on ELF platforms which support shared libraries.
1192
1193 @kindex -Bstatic
1194 @kindex -dn
1195 @kindex -non_shared
1196 @kindex -static
1197 @item -Bstatic
1198 @itemx -dn
1199 @itemx -non_shared
1200 @itemx -static
1201 Do not link against shared libraries.  This is only meaningful on
1202 platforms for which shared libraries are supported.  The different
1203 variants of this option are for compatibility with various systems.  You
1204 may use this option multiple times on the command line: it affects
1205 library searching for @option{-l} options which follow it.  This
1206 option also implies @option{--unresolved-symbols=report-all}.  This
1207 option can be used with @option{-shared}.  Doing so means that a
1208 shared library is being created but that all of the library's external
1209 references must be resolved by pulling in entries from static
1210 libraries.
1211
1212 @kindex -Bsymbolic
1213 @item -Bsymbolic
1214 When creating a shared library, bind references to global symbols to the
1215 definition within the shared library, if any.  Normally, it is possible
1216 for a program linked against a shared library to override the definition
1217 within the shared library.  This option is only meaningful on ELF
1218 platforms which support shared libraries.
1219
1220 @kindex -Bsymbolic-functions
1221 @item -Bsymbolic-functions
1222 When creating a shared library, bind references to global function
1223 symbols to the definition within the shared library, if any.
1224 This option is only meaningful on ELF platforms which support shared
1225 libraries.
1226
1227 @kindex --dynamic-list=@var{dynamic-list-file}
1228 @item --dynamic-list=@var{dynamic-list-file}
1229 Specify the name of a dynamic list file to the linker.  This is
1230 typically used when creating shared libraries to specify a list of
1231 global symbols whose references shouldn't be bound to the definition
1232 within the shared library, or creating dynamically linked executables
1233 to specify a list of symbols which should be added to the symbol table
1234 in the executable.  This option is only meaningful on ELF platforms
1235 which support shared libraries.
1236
1237 The format of the dynamic list is the same as the version node without
1238 scope and node name.  See @ref{VERSION} for more information.
1239
1240 @kindex --dynamic-list-data
1241 @item --dynamic-list-data
1242 Include all global data symbols to the dynamic list.
1243
1244 @kindex --dynamic-list-cpp-new
1245 @item --dynamic-list-cpp-new
1246 Provide the builtin dynamic list for C++ operator new and delete.  It
1247 is mainly useful for building shared libstdc++.
1248
1249 @kindex --dynamic-list-cpp-typeinfo
1250 @item --dynamic-list-cpp-typeinfo
1251 Provide the builtin dynamic list for C++ runtime type identification.
1252
1253 @kindex --check-sections
1254 @kindex --no-check-sections
1255 @item --check-sections
1256 @itemx --no-check-sections
1257 Asks the linker @emph{not} to check section addresses after they have
1258 been assigned to see if there are any overlaps.  Normally the linker will
1259 perform this check, and if it finds any overlaps it will produce
1260 suitable error messages.  The linker does know about, and does make
1261 allowances for sections in overlays.  The default behaviour can be
1262 restored by using the command line switch @option{--check-sections}.
1263 Section overlap is not usually checked for relocatable links.  You can
1264 force checking in that case by using the @option{--check-sections}
1265 option.
1266
1267 @kindex --copy-dt-needed-entries
1268 @kindex --no-copy-dt-needed-entries
1269 @item --copy-dt-needed-entries
1270 @itemx --no-copy-dt-needed-entries
1271 This option affects the treatment of dynamic libraries referred to
1272 by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the
1273 command line.  Normally the linker won't add a DT_NEEDED tag to the
1274 output binary for each library mentioned in a DT_NEEDED tag in an
1275 input dynamic library.  With @option{--copy-dt-needed-entries}
1276 specified on the command line however any dynamic libraries that
1277 follow it will have their DT_NEEDED entries added.  The default
1278 behaviour can be restored with @option{--no-copy-dt-needed-entries}.
1279
1280 This option also has an effect on the resolution of symbols in dynamic
1281 libraries.  With @option{--copy-dt-needed-entries} dynamic libraries
1282 mentioned on the command line will be recursively searched, following
1283 their DT_NEEDED tags to other libraries, in order to resolve symbols
1284 required by the output binary.  With the default setting however
1285 the searching of dynamic libraries that follow it will stop with the
1286 dynamic library itself.  No DT_NEEDED links will be traversed to resolve
1287 symbols.
1288
1289 @cindex cross reference table
1290 @kindex --cref
1291 @item --cref
1292 Output a cross reference table.  If a linker map file is being
1293 generated, the cross reference table is printed to the map file.
1294 Otherwise, it is printed on the standard output.
1295
1296 The format of the table is intentionally simple, so that it may be
1297 easily processed by a script if necessary.  The symbols are printed out,
1298 sorted by name.  For each symbol, a list of file names is given.  If the
1299 symbol is defined, the first file listed is the location of the
1300 definition.  If the symbol is defined as a common value then any files
1301 where this happens appear next.  Finally any files that reference the
1302 symbol are listed.
1303
1304 @cindex common allocation
1305 @kindex --no-define-common
1306 @item --no-define-common
1307 This option inhibits the assignment of addresses to common symbols.
1308 The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect.
1309 @xref{Miscellaneous Commands}.
1310
1311 The @samp{--no-define-common} option allows decoupling
1312 the decision to assign addresses to Common symbols from the choice
1313 of the output file type; otherwise a non-Relocatable output type
1314 forces assigning addresses to Common symbols.
1315 Using @samp{--no-define-common} allows Common symbols that are referenced
1316 from a shared library to be assigned addresses only in the main program.
1317 This eliminates the unused duplicate space in the shared library,
1318 and also prevents any possible confusion over resolving to the wrong
1319 duplicate when there are many dynamic modules with specialized search
1320 paths for runtime symbol resolution.
1321
1322 @cindex symbols, from command line
1323 @kindex --defsym=@var{symbol}=@var{exp}
1324 @item --defsym=@var{symbol}=@var{expression}
1325 Create a global symbol in the output file, containing the absolute
1326 address given by @var{expression}.  You may use this option as many
1327 times as necessary to define multiple symbols in the command line.  A
1328 limited form of arithmetic is supported for the @var{expression} in this
1329 context: you may give a hexadecimal constant or the name of an existing
1330 symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
1331 constants or symbols.  If you need more elaborate expressions, consider
1332 using the linker command language from a script (@pxref{Assignments,,
1333 Assignment: Symbol Definitions}).  @emph{Note:} there should be no white
1334 space between @var{symbol}, the equals sign (``@key{=}''), and
1335 @var{expression}.
1336
1337 @cindex demangling, from command line
1338 @kindex --demangle[=@var{style}]
1339 @kindex --no-demangle
1340 @item --demangle[=@var{style}]
1341 @itemx --no-demangle
1342 These options control whether to demangle symbol names in error messages
1343 and other output.  When the linker is told to demangle, it tries to
1344 present symbol names in a readable fashion: it strips leading
1345 underscores if they are used by the object file format, and converts C++
1346 mangled symbol names into user readable names.  Different compilers have
1347 different mangling styles.  The optional demangling style argument can be used
1348 to choose an appropriate demangling style for your compiler.  The linker will
1349 demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE}
1350 is set.  These options may be used to override the default.
1351
1352 @cindex dynamic linker, from command line
1353 @kindex -I@var{file}
1354 @kindex --dynamic-linker=@var{file}
1355 @item -I@var{file}
1356 @itemx --dynamic-linker=@var{file}
1357 Set the name of the dynamic linker.  This is only meaningful when
1358 generating dynamically linked ELF executables.  The default dynamic
1359 linker is normally correct; don't use this unless you know what you are
1360 doing.
1361
1362 @kindex --fatal-warnings
1363 @kindex --no-fatal-warnings
1364 @item --fatal-warnings
1365 @itemx --no-fatal-warnings
1366 Treat all warnings as errors.  The default behaviour can be restored
1367 with the option @option{--no-fatal-warnings}.
1368
1369 @kindex --force-exe-suffix
1370 @item  --force-exe-suffix
1371 Make sure that an output file has a .exe suffix.
1372
1373 If a successfully built fully linked output file does not have a
1374 @code{.exe} or @code{.dll} suffix, this option forces the linker to copy
1375 the output file to one of the same name with a @code{.exe} suffix. This
1376 option is useful when using unmodified Unix makefiles on a Microsoft
1377 Windows host, since some versions of Windows won't run an image unless
1378 it ends in a @code{.exe} suffix.
1379
1380 @kindex --gc-sections
1381 @kindex --no-gc-sections
1382 @cindex garbage collection
1383 @item --gc-sections
1384 @itemx --no-gc-sections
1385 Enable garbage collection of unused input sections.  It is ignored on
1386 targets that do not support this option.  The default behaviour (of not
1387 performing this garbage collection) can be restored by specifying
1388 @samp{--no-gc-sections} on the command line.
1389
1390 @samp{--gc-sections} decides which input sections are used by
1391 examining symbols and relocations.  The section containing the entry
1392 symbol and all sections containing symbols undefined on the
1393 command-line will be kept, as will sections containing symbols
1394 referenced by dynamic objects.  Note that when building shared
1395 libraries, the linker must assume that any visible symbol is
1396 referenced.  Once this initial set of sections has been determined,
1397 the linker recursively marks as used any section referenced by their
1398 relocations.  See @samp{--entry} and @samp{--undefined}.
1399
1400 This option can be set when doing a partial link (enabled with option
1401 @samp{-r}).  In this case the root of symbols kept must be explicitly
1402 specified either by an @samp{--entry} or @samp{--undefined} option or by
1403 a @code{ENTRY} command in the linker script.
1404
1405 @kindex --print-gc-sections
1406 @kindex --no-print-gc-sections
1407 @cindex garbage collection
1408 @item --print-gc-sections
1409 @itemx --no-print-gc-sections
1410 List all sections removed by garbage collection.  The listing is
1411 printed on stderr.  This option is only effective if garbage
1412 collection has been enabled via the @samp{--gc-sections}) option.  The
1413 default behaviour (of not listing the sections that are removed) can
1414 be restored by specifying @samp{--no-print-gc-sections} on the command
1415 line.
1416
1417 @kindex --print-output-format
1418 @cindex output format
1419 @item --print-output-format
1420 Print the name of the default output format (perhaps influenced by
1421 other command-line options).  This is the string that would appear
1422 in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}).
1423
1424 @cindex help
1425 @cindex usage
1426 @kindex --help
1427 @item --help
1428 Print a summary of the command-line options on the standard output and exit.
1429
1430 @kindex --target-help
1431 @item --target-help
1432 Print a summary of all target specific options on the standard output and exit.
1433
1434 @kindex -Map=@var{mapfile}
1435 @item -Map=@var{mapfile}
1436 Print a link map to the file @var{mapfile}.  See the description of the
1437 @option{-M} option, above.
1438
1439 @cindex memory usage
1440 @kindex --no-keep-memory
1441 @item --no-keep-memory
1442 @command{ld} normally optimizes for speed over memory usage by caching the
1443 symbol tables of input files in memory.  This option tells @command{ld} to
1444 instead optimize for memory usage, by rereading the symbol tables as
1445 necessary.  This may be required if @command{ld} runs out of memory space
1446 while linking a large executable.
1447
1448 @kindex --no-undefined
1449 @kindex -z defs
1450 @item --no-undefined
1451 @itemx -z defs
1452 Report unresolved symbol references from regular object files.  This
1453 is done even if the linker is creating a non-symbolic shared library.
1454 The switch @option{--[no-]allow-shlib-undefined} controls the
1455 behaviour for reporting unresolved references found in shared
1456 libraries being linked in.
1457
1458 @kindex --allow-multiple-definition
1459 @kindex -z muldefs
1460 @item --allow-multiple-definition
1461 @itemx -z muldefs
1462 Normally when a symbol is defined multiple times, the linker will
1463 report a fatal error. These options allow multiple definitions and the
1464 first definition will be used.
1465
1466 @kindex --allow-shlib-undefined
1467 @kindex --no-allow-shlib-undefined
1468 @item --allow-shlib-undefined
1469 @itemx --no-allow-shlib-undefined
1470 Allows or disallows undefined symbols in shared libraries.
1471 This switch is similar to @option{--no-undefined} except that it
1472 determines the behaviour when the undefined symbols are in a
1473 shared library rather than a regular object file.  It does not affect
1474 how undefined symbols in regular object files are handled.
1475
1476 The default behaviour is to report errors for any undefined symbols
1477 referenced in shared libraries if the linker is being used to create
1478 an executable, but to allow them if the linker is being used to create
1479 a shared library.
1480
1481 The reasons for allowing undefined symbol references in shared
1482 libraries specified at link time are that:
1483
1484 @itemize @bullet
1485 @item
1486 A shared library specified at link time may not be the same as the one
1487 that is available at load time, so the symbol might actually be
1488 resolvable at load time.
1489 @item
1490 There are some operating systems, eg BeOS and HPPA, where undefined
1491 symbols in shared libraries are normal.
1492
1493 The BeOS kernel for example patches shared libraries at load time to
1494 select whichever function is most appropriate for the current
1495 architecture.  This is used, for example, to dynamically select an
1496 appropriate memset function.
1497 @end itemize
1498
1499 @kindex --no-undefined-version
1500 @item --no-undefined-version
1501 Normally when a symbol has an undefined version, the linker will ignore
1502 it. This option disallows symbols with undefined version and a fatal error
1503 will be issued instead.
1504
1505 @kindex --default-symver
1506 @item --default-symver
1507 Create and use a default symbol version (the soname) for unversioned
1508 exported symbols.
1509
1510 @kindex --default-imported-symver
1511 @item --default-imported-symver
1512 Create and use a default symbol version (the soname) for unversioned
1513 imported symbols.
1514
1515 @kindex --no-warn-mismatch
1516 @item --no-warn-mismatch
1517 Normally @command{ld} will give an error if you try to link together input
1518 files that are mismatched for some reason, perhaps because they have
1519 been compiled for different processors or for different endiannesses.
1520 This option tells @command{ld} that it should silently permit such possible
1521 errors.  This option should only be used with care, in cases when you
1522 have taken some special action that ensures that the linker errors are
1523 inappropriate.
1524
1525 @kindex --no-warn-search-mismatch
1526 @item --no-warn-search-mismatch
1527 Normally @command{ld} will give a warning if it finds an incompatible
1528 library during a library search.  This option silences the warning.
1529
1530 @kindex --no-whole-archive
1531 @item --no-whole-archive
1532 Turn off the effect of the @option{--whole-archive} option for subsequent
1533 archive files.
1534
1535 @cindex output file after errors
1536 @kindex --noinhibit-exec
1537 @item --noinhibit-exec
1538 Retain the executable output file whenever it is still usable.
1539 Normally, the linker will not produce an output file if it encounters
1540 errors during the link process; it exits without writing an output file
1541 when it issues any error whatsoever.
1542
1543 @kindex -nostdlib
1544 @item -nostdlib
1545 Only search library directories explicitly specified on the
1546 command line.  Library directories specified in linker scripts
1547 (including linker scripts specified on the command line) are ignored.
1548
1549 @ifclear SingleFormat
1550 @kindex --oformat=@var{output-format}
1551 @item --oformat=@var{output-format}
1552 @command{ld} may be configured to support more than one kind of object
1553 file.  If your @command{ld} is configured this way, you can use the
1554 @samp{--oformat} option to specify the binary format for the output
1555 object file.  Even when @command{ld} is configured to support alternative
1556 object formats, you don't usually need to specify this, as @command{ld}
1557 should be configured to produce as a default output format the most
1558 usual format on each machine.  @var{output-format} is a text string, the
1559 name of a particular format supported by the BFD libraries.  (You can
1560 list the available binary formats with @samp{objdump -i}.)  The script
1561 command @code{OUTPUT_FORMAT} can also specify the output format, but
1562 this option overrides it.  @xref{BFD}.
1563 @end ifclear
1564
1565 @kindex -pie
1566 @kindex --pic-executable
1567 @item -pie
1568 @itemx --pic-executable
1569 @cindex position independent executables
1570 Create a position independent executable.  This is currently only supported on
1571 ELF platforms.  Position independent executables are similar to shared
1572 libraries in that they are relocated by the dynamic linker to the virtual
1573 address the OS chooses for them (which can vary between invocations).  Like
1574 normal dynamically linked executables they can be executed and symbols
1575 defined in the executable cannot be overridden by shared libraries.
1576
1577 @kindex -qmagic
1578 @item -qmagic
1579 This option is ignored for Linux compatibility.
1580
1581 @kindex -Qy
1582 @item -Qy
1583 This option is ignored for SVR4 compatibility.
1584
1585 @kindex --relax
1586 @cindex synthesizing linker
1587 @cindex relaxing addressing modes
1588 @cindex --no-relax
1589 @item --relax
1590 @itemx --no-relax
1591 An option with machine dependent effects.
1592 @ifset GENERIC
1593 This option is only supported on a few targets.
1594 @end ifset
1595 @ifset H8300
1596 @xref{H8/300,,@command{ld} and the H8/300}.
1597 @end ifset
1598 @ifset I960
1599 @xref{i960,, @command{ld} and the Intel 960 family}.
1600 @end ifset
1601 @ifset XTENSA
1602 @xref{Xtensa,, @command{ld} and Xtensa Processors}.
1603 @end ifset
1604 @ifset M68HC11
1605 @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}.
1606 @end ifset
1607 @ifset POWERPC
1608 @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}.
1609 @end ifset
1610
1611 On some platforms the @samp{--relax} option performs target specific,
1612 global optimizations that become possible when the linker resolves
1613 addressing in the program, such as relaxing address modes,
1614 synthesizing new instructions, selecting shorter version of current
1615 instructions, and combining constant values.
1616
1617 On some platforms these link time global optimizations may make symbolic
1618 debugging of the resulting executable impossible.
1619 @ifset GENERIC
1620 This is known to be the case for the Matsushita MN10200 and MN10300
1621 family of processors.
1622 @end ifset
1623
1624 @ifset GENERIC
1625 On platforms where this is not supported, @samp{--relax} is accepted,
1626 but ignored.
1627 @end ifset
1628
1629 On platforms where @samp{--relax} is accepted the option
1630 @samp{--no-relax} can be used to disable the feature.
1631
1632 @cindex retaining specified symbols
1633 @cindex stripping all but some symbols
1634 @cindex symbols, retaining selectively
1635 @kindex --retain-symbols-file=@var{filename}
1636 @item --retain-symbols-file=@var{filename}
1637 Retain @emph{only} the symbols listed in the file @var{filename},
1638 discarding all others.  @var{filename} is simply a flat file, with one
1639 symbol name per line.  This option is especially useful in environments
1640 @ifset GENERIC
1641 (such as VxWorks)
1642 @end ifset
1643 where a large global symbol table is accumulated gradually, to conserve
1644 run-time memory.
1645
1646 @samp{--retain-symbols-file} does @emph{not} discard undefined symbols,
1647 or symbols needed for relocations.
1648
1649 You may only specify @samp{--retain-symbols-file} once in the command
1650 line.  It overrides @samp{-s} and @samp{-S}.
1651
1652 @ifset GENERIC
1653 @item -rpath=@var{dir}
1654 @cindex runtime library search path
1655 @kindex -rpath=@var{dir}
1656 Add a directory to the runtime library search path.  This is used when
1657 linking an ELF executable with shared objects.  All @option{-rpath}
1658 arguments are concatenated and passed to the runtime linker, which uses
1659 them to locate shared objects at runtime.  The @option{-rpath} option is
1660 also used when locating shared objects which are needed by shared
1661 objects explicitly included in the link; see the description of the
1662 @option{-rpath-link} option.  If @option{-rpath} is not used when linking an
1663 ELF executable, the contents of the environment variable
1664 @code{LD_RUN_PATH} will be used if it is defined.
1665
1666 The @option{-rpath} option may also be used on SunOS.  By default, on
1667 SunOS, the linker will form a runtime search patch out of all the
1668 @option{-L} options it is given.  If a @option{-rpath} option is used, the
1669 runtime search path will be formed exclusively using the @option{-rpath}
1670 options, ignoring the @option{-L} options.  This can be useful when using
1671 gcc, which adds many @option{-L} options which may be on NFS mounted
1672 file systems.
1673
1674 For compatibility with other ELF linkers, if the @option{-R} option is
1675 followed by a directory name, rather than a file name, it is treated as
1676 the @option{-rpath} option.
1677 @end ifset
1678
1679 @ifset GENERIC
1680 @cindex link-time runtime library search path
1681 @kindex -rpath-link=@var{dir}
1682 @item -rpath-link=@var{dir}
1683 When using ELF or SunOS, one shared library may require another.  This
1684 happens when an @code{ld -shared} link includes a shared library as one
1685 of the input files.
1686
1687 When the linker encounters such a dependency when doing a non-shared,
1688 non-relocatable link, it will automatically try to locate the required
1689 shared library and include it in the link, if it is not included
1690 explicitly.  In such a case, the @option{-rpath-link} option
1691 specifies the first set of directories to search.  The
1692 @option{-rpath-link} option may specify a sequence of directory names
1693 either by specifying a list of names separated by colons, or by
1694 appearing multiple times.
1695
1696 This option should be used with caution as it overrides the search path
1697 that may have been hard compiled into a shared library. In such a case it
1698 is possible to use unintentionally a different search path than the
1699 runtime linker would do.
1700
1701 The linker uses the following search paths to locate required shared
1702 libraries:
1703 @enumerate
1704 @item
1705 Any directories specified by @option{-rpath-link} options.
1706 @item
1707 Any directories specified by @option{-rpath} options.  The difference
1708 between @option{-rpath} and @option{-rpath-link} is that directories
1709 specified by @option{-rpath} options are included in the executable and
1710 used at runtime, whereas the @option{-rpath-link} option is only effective
1711 at link time. Searching @option{-rpath} in this way is only supported
1712 by native linkers and cross linkers which have been configured with
1713 the @option{--with-sysroot} option.
1714 @item
1715 On an ELF system, for native linkers, if the @option{-rpath} and
1716 @option{-rpath-link} options were not used, search the contents of the
1717 environment variable @code{LD_RUN_PATH}.
1718 @item
1719 On SunOS, if the @option{-rpath} option was not used, search any
1720 directories specified using @option{-L} options.
1721 @item
1722 For a native linker, search the contents of the environment
1723 variable @code{LD_LIBRARY_PATH}.
1724 @item
1725 For a native ELF linker, the directories in @code{DT_RUNPATH} or
1726 @code{DT_RPATH} of a shared library are searched for shared
1727 libraries needed by it. The @code{DT_RPATH} entries are ignored if
1728 @code{DT_RUNPATH} entries exist.
1729 @item
1730 The default directories, normally @file{/lib} and @file{/usr/lib}.
1731 @item
1732 For a native linker on an ELF system, if the file @file{/etc/ld.so.conf}
1733 exists, the list of directories found in that file.
1734 @end enumerate
1735
1736 If the required shared library is not found, the linker will issue a
1737 warning and continue with the link.
1738 @end ifset
1739
1740 @kindex -shared
1741 @kindex -Bshareable
1742 @item -shared
1743 @itemx -Bshareable
1744 @cindex shared libraries
1745 Create a shared library.  This is currently only supported on ELF, XCOFF
1746 and SunOS platforms.  On SunOS, the linker will automatically create a
1747 shared library if the @option{-e} option is not used and there are
1748 undefined symbols in the link.
1749
1750 @kindex --sort-common
1751 @item --sort-common
1752 @itemx --sort-common=ascending
1753 @itemx --sort-common=descending
1754 This option tells @command{ld} to sort the common symbols by alignment in
1755 ascending or descending order when it places them in the appropriate output
1756 sections.  The symbol alignments considered are sixteen-byte or larger,
1757 eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps
1758 between symbols due to alignment constraints.  If no sorting order is
1759 specified, then descending order is assumed.
1760
1761 @kindex --sort-section=name
1762 @item --sort-section=name
1763 This option will apply @code{SORT_BY_NAME} to all wildcard section
1764 patterns in the linker script.
1765
1766 @kindex --sort-section=alignment
1767 @item --sort-section=alignment
1768 This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section
1769 patterns in the linker script.
1770
1771 @kindex --split-by-file
1772 @item --split-by-file[=@var{size}]
1773 Similar to @option{--split-by-reloc} but creates a new output section for
1774 each input file when @var{size} is reached.  @var{size} defaults to a
1775 size of 1 if not given.
1776
1777 @kindex --split-by-reloc
1778 @item --split-by-reloc[=@var{count}]
1779 Tries to creates extra sections in the output file so that no single
1780 output section in the file contains more than @var{count} relocations.
1781 This is useful when generating huge relocatable files for downloading into
1782 certain real time kernels with the COFF object file format; since COFF
1783 cannot represent more than 65535 relocations in a single section.  Note
1784 that this will fail to work with object file formats which do not
1785 support arbitrary sections.  The linker will not split up individual
1786 input sections for redistribution, so if a single input section contains
1787 more than @var{count} relocations one output section will contain that
1788 many relocations.  @var{count} defaults to a value of 32768.
1789
1790 @kindex --stats
1791 @item --stats
1792 Compute and display statistics about the operation of the linker, such
1793 as execution time and memory usage.
1794
1795 @kindex --sysroot=@var{directory}
1796 @item --sysroot=@var{directory}
1797 Use @var{directory} as the location of the sysroot, overriding the
1798 configure-time default.  This option is only supported by linkers
1799 that were configured using @option{--with-sysroot}.
1800
1801 @kindex --traditional-format
1802 @cindex traditional format
1803 @item --traditional-format
1804 For some targets, the output of @command{ld} is different in some ways from
1805 the output of some existing linker.  This switch requests @command{ld} to
1806 use the traditional format instead.
1807
1808 @cindex dbx
1809 For example, on SunOS, @command{ld} combines duplicate entries in the
1810 symbol string table.  This can reduce the size of an output file with
1811 full debugging information by over 30 percent.  Unfortunately, the SunOS
1812 @code{dbx} program can not read the resulting program (@code{gdb} has no
1813 trouble).  The @samp{--traditional-format} switch tells @command{ld} to not
1814 combine duplicate entries.
1815
1816 @kindex --section-start=@var{sectionname}=@var{org}
1817 @item --section-start=@var{sectionname}=@var{org}
1818 Locate a section in the output file at the absolute
1819 address given by @var{org}.  You may use this option as many
1820 times as necessary to locate multiple sections in the command
1821 line.
1822 @var{org} must be a single hexadecimal integer;
1823 for compatibility with other linkers, you may omit the leading
1824 @samp{0x} usually associated with hexadecimal values.  @emph{Note:} there
1825 should be no white space between @var{sectionname}, the equals
1826 sign (``@key{=}''), and @var{org}.
1827
1828 @kindex -Tbss=@var{org}
1829 @kindex -Tdata=@var{org}
1830 @kindex -Ttext=@var{org}
1831 @cindex segment origins, cmd line
1832 @item -Tbss=@var{org}
1833 @itemx -Tdata=@var{org}
1834 @itemx -Ttext=@var{org}
1835 Same as @option{--section-start}, with @code{.bss}, @code{.data} or
1836 @code{.text} as the @var{sectionname}.
1837
1838 @kindex -Ttext-segment=@var{org}
1839 @item -Ttext-segment=@var{org}
1840 @cindex text segment origin, cmd line
1841 When creating an ELF executable or shared object, it will set the address
1842 of the first byte of the text segment.
1843
1844 @kindex -Trodata-segment=@var{org}
1845 @item -Trodata-segment=@var{org}
1846 @cindex rodata segment origin, cmd line
1847 When creating an ELF executable or shared object for a target where
1848 the read-only data is in its own segment separate from the executable
1849 text, it will set the address of the first byte of the read-only data segment.
1850
1851 @kindex -Tldata-segment=@var{org}
1852 @item -Tldata-segment=@var{org}
1853 @cindex ldata segment origin, cmd line
1854 When creating an ELF executable or shared object for x86-64 medium memory
1855 model, it will set the address of the first byte of the ldata segment.
1856
1857 @kindex --unresolved-symbols
1858 @item --unresolved-symbols=@var{method}
1859 Determine how to handle unresolved symbols.  There are four possible
1860 values for @samp{method}:
1861
1862 @table @samp
1863 @item ignore-all
1864 Do not report any unresolved symbols.
1865
1866 @item report-all
1867 Report all unresolved symbols.  This is the default.
1868
1869 @item ignore-in-object-files
1870 Report unresolved symbols that are contained in shared libraries, but
1871 ignore them if they come from regular object files.
1872
1873 @item ignore-in-shared-libs
1874 Report unresolved symbols that come from regular object files, but
1875 ignore them if they come from shared libraries.  This can be useful
1876 when creating a dynamic binary and it is known that all the shared
1877 libraries that it should be referencing are included on the linker's
1878 command line.
1879 @end table
1880
1881 The behaviour for shared libraries on their own can also be controlled
1882 by the @option{--[no-]allow-shlib-undefined} option.
1883
1884 Normally the linker will generate an error message for each reported
1885 unresolved symbol but the option @option{--warn-unresolved-symbols}
1886 can change this to a warning.
1887
1888 @kindex --verbose[=@var{NUMBER}]
1889 @cindex verbose[=@var{NUMBER}]
1890 @item --dll-verbose
1891 @itemx --verbose[=@var{NUMBER}]
1892 Display the version number for @command{ld} and list the linker emulations
1893 supported.  Display which input files can and cannot be opened.  Display
1894 the linker script being used by the linker. If the optional @var{NUMBER}
1895 argument > 1, plugin symbol status will also be displayed.
1896
1897 @kindex --version-script=@var{version-scriptfile}
1898 @cindex version script, symbol versions
1899 @item --version-script=@var{version-scriptfile}
1900 Specify the name of a version script to the linker.  This is typically
1901 used when creating shared libraries to specify additional information
1902 about the version hierarchy for the library being created.  This option
1903 is only fully supported on ELF platforms which support shared libraries;
1904 see @ref{VERSION}.  It is partially supported on PE platforms, which can
1905 use version scripts to filter symbol visibility in auto-export mode: any
1906 symbols marked @samp{local} in the version script will not be exported.
1907 @xref{WIN32}.
1908
1909 @kindex --warn-common
1910 @cindex warnings, on combining symbols
1911 @cindex combining symbols, warnings on
1912 @item --warn-common
1913 Warn when a common symbol is combined with another common symbol or with
1914 a symbol definition.  Unix linkers allow this somewhat sloppy practice,
1915 but linkers on some other operating systems do not.  This option allows
1916 you to find potential problems from combining global symbols.
1917 Unfortunately, some C libraries use this practice, so you may get some
1918 warnings about symbols in the libraries as well as in your programs.
1919
1920 There are three kinds of global symbols, illustrated here by C examples:
1921
1922 @table @samp
1923 @item int i = 1;
1924 A definition, which goes in the initialized data section of the output
1925 file.
1926
1927 @item extern int i;
1928 An undefined reference, which does not allocate space.
1929 There must be either a definition or a common symbol for the
1930 variable somewhere.
1931
1932 @item int i;
1933 A common symbol.  If there are only (one or more) common symbols for a
1934 variable, it goes in the uninitialized data area of the output file.
1935 The linker merges multiple common symbols for the same variable into a
1936 single symbol.  If they are of different sizes, it picks the largest
1937 size.  The linker turns a common symbol into a declaration, if there is
1938 a definition of the same variable.
1939 @end table
1940
1941 The @samp{--warn-common} option can produce five kinds of warnings.
1942 Each warning consists of a pair of lines: the first describes the symbol
1943 just encountered, and the second describes the previous symbol
1944 encountered with the same name.  One or both of the two symbols will be
1945 a common symbol.
1946
1947 @enumerate
1948 @item
1949 Turning a common symbol into a reference, because there is already a
1950 definition for the symbol.
1951 @smallexample
1952 @var{file}(@var{section}): warning: common of `@var{symbol}'
1953    overridden by definition
1954 @var{file}(@var{section}): warning: defined here
1955 @end smallexample
1956
1957 @item
1958 Turning a common symbol into a reference, because a later definition for
1959 the symbol is encountered.  This is the same as the previous case,
1960 except that the symbols are encountered in a different order.
1961 @smallexample
1962 @var{file}(@var{section}): warning: definition of `@var{symbol}'
1963    overriding common
1964 @var{file}(@var{section}): warning: common is here
1965 @end smallexample
1966
1967 @item
1968 Merging a common symbol with a previous same-sized common symbol.
1969 @smallexample
1970 @var{file}(@var{section}): warning: multiple common
1971    of `@var{symbol}'
1972 @var{file}(@var{section}): warning: previous common is here
1973 @end smallexample
1974
1975 @item
1976 Merging a common symbol with a previous larger common symbol.
1977 @smallexample
1978 @var{file}(@var{section}): warning: common of `@var{symbol}'
1979    overridden by larger common
1980 @var{file}(@var{section}): warning: larger common is here
1981 @end smallexample
1982
1983 @item
1984 Merging a common symbol with a previous smaller common symbol.  This is
1985 the same as the previous case, except that the symbols are
1986 encountered in a different order.
1987 @smallexample
1988 @var{file}(@var{section}): warning: common of `@var{symbol}'
1989    overriding smaller common
1990 @var{file}(@var{section}): warning: smaller common is here
1991 @end smallexample
1992 @end enumerate
1993
1994 @kindex --warn-constructors
1995 @item --warn-constructors
1996 Warn if any global constructors are used.  This is only useful for a few
1997 object file formats.  For formats like COFF or ELF, the linker can not
1998 detect the use of global constructors.
1999
2000 @kindex --warn-multiple-gp
2001 @item --warn-multiple-gp
2002 Warn if multiple global pointer values are required in the output file.
2003 This is only meaningful for certain processors, such as the Alpha.
2004 Specifically, some processors put large-valued constants in a special
2005 section.  A special register (the global pointer) points into the middle
2006 of this section, so that constants can be loaded efficiently via a
2007 base-register relative addressing mode.  Since the offset in
2008 base-register relative mode is fixed and relatively small (e.g., 16
2009 bits), this limits the maximum size of the constant pool.  Thus, in
2010 large programs, it is often necessary to use multiple global pointer
2011 values in order to be able to address all possible constants.  This
2012 option causes a warning to be issued whenever this case occurs.
2013
2014 @kindex --warn-once
2015 @cindex warnings, on undefined symbols
2016 @cindex undefined symbols, warnings on
2017 @item --warn-once
2018 Only warn once for each undefined symbol, rather than once per module
2019 which refers to it.
2020
2021 @kindex --warn-section-align
2022 @cindex warnings, on section alignment
2023 @cindex section alignment, warnings on
2024 @item --warn-section-align
2025 Warn if the address of an output section is changed because of
2026 alignment.  Typically, the alignment will be set by an input section.
2027 The address will only be changed if it not explicitly specified; that
2028 is, if the @code{SECTIONS} command does not specify a start address for
2029 the section (@pxref{SECTIONS}).
2030
2031 @kindex --warn-shared-textrel
2032 @item --warn-shared-textrel
2033 Warn if the linker adds a DT_TEXTREL to a shared object.
2034
2035 @kindex --warn-alternate-em
2036 @item --warn-alternate-em
2037 Warn if an object has alternate ELF machine code.
2038
2039 @kindex --warn-unresolved-symbols
2040 @item --warn-unresolved-symbols
2041 If the linker is going to report an unresolved symbol (see the option
2042 @option{--unresolved-symbols}) it will normally generate an error.
2043 This option makes it generate a warning instead.
2044
2045 @kindex --error-unresolved-symbols
2046 @item --error-unresolved-symbols
2047 This restores the linker's default behaviour of generating errors when
2048 it is reporting unresolved symbols.
2049
2050 @kindex --whole-archive
2051 @cindex including an entire archive
2052 @item --whole-archive
2053 For each archive mentioned on the command line after the
2054 @option{--whole-archive} option, include every object file in the archive
2055 in the link, rather than searching the archive for the required object
2056 files.  This is normally used to turn an archive file into a shared
2057 library, forcing every object to be included in the resulting shared
2058 library.  This option may be used more than once.
2059
2060 Two notes when using this option from gcc: First, gcc doesn't know
2061 about this option, so you have to use @option{-Wl,-whole-archive}.
2062 Second, don't forget to use @option{-Wl,-no-whole-archive} after your
2063 list of archives, because gcc will add its own list of archives to
2064 your link and you may not want this flag to affect those as well.
2065
2066 @kindex --wrap=@var{symbol}
2067 @item --wrap=@var{symbol}
2068 Use a wrapper function for @var{symbol}.  Any undefined reference to
2069 @var{symbol} will be resolved to @code{__wrap_@var{symbol}}.  Any
2070 undefined reference to @code{__real_@var{symbol}} will be resolved to
2071 @var{symbol}.
2072
2073 This can be used to provide a wrapper for a system function.  The
2074 wrapper function should be called @code{__wrap_@var{symbol}}.  If it
2075 wishes to call the system function, it should call
2076 @code{__real_@var{symbol}}.
2077
2078 Here is a trivial example:
2079
2080 @smallexample
2081 void *
2082 __wrap_malloc (size_t c)
2083 @{
2084   printf ("malloc called with %zu\n", c);
2085   return __real_malloc (c);
2086 @}
2087 @end smallexample
2088
2089 If you link other code with this file using @option{--wrap malloc}, then
2090 all calls to @code{malloc} will call the function @code{__wrap_malloc}
2091 instead.  The call to @code{__real_malloc} in @code{__wrap_malloc} will
2092 call the real @code{malloc} function.
2093
2094 You may wish to provide a @code{__real_malloc} function as well, so that
2095 links without the @option{--wrap} option will succeed.  If you do this,
2096 you should not put the definition of @code{__real_malloc} in the same
2097 file as @code{__wrap_malloc}; if you do, the assembler may resolve the
2098 call before the linker has a chance to wrap it to @code{malloc}.
2099
2100 @kindex --eh-frame-hdr
2101 @item --eh-frame-hdr
2102 Request creation of @code{.eh_frame_hdr} section and ELF
2103 @code{PT_GNU_EH_FRAME} segment header.
2104
2105 @kindex --ld-generated-unwind-info
2106 @item --no-ld-generated-unwind-info
2107 Request creation of @code{.eh_frame} unwind info for linker
2108 generated code sections like PLT.  This option is on by default
2109 if linker generated unwind info is supported.
2110
2111 @kindex --enable-new-dtags
2112 @kindex --disable-new-dtags
2113 @item --enable-new-dtags
2114 @itemx --disable-new-dtags
2115 This linker can create the new dynamic tags in ELF. But the older ELF
2116 systems may not understand them. If you specify
2117 @option{--enable-new-dtags}, the new dynamic tags will be created as needed
2118 and older dynamic tags will be omitted.
2119 If you specify @option{--disable-new-dtags}, no new dynamic tags will be
2120 created. By default, the new dynamic tags are not created. Note that
2121 those options are only available for ELF systems.
2122
2123 @kindex --hash-size=@var{number}
2124 @item --hash-size=@var{number}
2125 Set the default size of the linker's hash tables to a prime number
2126 close to @var{number}.  Increasing this value can reduce the length of
2127 time it takes the linker to perform its tasks, at the expense of
2128 increasing the linker's memory requirements.  Similarly reducing this
2129 value can reduce the memory requirements at the expense of speed.
2130
2131 @kindex --hash-style=@var{style}
2132 @item --hash-style=@var{style}
2133 Set the type of linker's hash table(s).  @var{style} can be either
2134 @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for
2135 new style GNU @code{.gnu.hash} section or @code{both} for both
2136 the classic ELF @code{.hash} and new style GNU @code{.gnu.hash}
2137 hash tables.  The default is @code{sysv}.
2138
2139 @kindex --reduce-memory-overheads
2140 @item --reduce-memory-overheads
2141 This option reduces memory requirements at ld runtime, at the expense of
2142 linking speed.  This was introduced to select the old O(n^2) algorithm
2143 for link map file generation, rather than the new O(n) algorithm which uses
2144 about 40% more memory for symbol storage.
2145
2146 Another effect of the switch is to set the default hash table size to
2147 1021, which again saves memory at the cost of lengthening the linker's
2148 run time.  This is not done however if the @option{--hash-size} switch
2149 has been used.
2150
2151 The @option{--reduce-memory-overheads} switch may be also be used to
2152 enable other tradeoffs in future versions of the linker.
2153
2154 @kindex --build-id
2155 @kindex --build-id=@var{style}
2156 @item --build-id
2157 @itemx --build-id=@var{style}
2158 Request creation of @code{.note.gnu.build-id} ELF note section.
2159 The contents of the note are unique bits identifying this linked
2160 file.  @var{style} can be @code{uuid} to use 128 random bits,
2161 @code{sha1} to use a 160-bit @sc{SHA1} hash on the normative
2162 parts of the output contents, @code{md5} to use a 128-bit
2163 @sc{MD5} hash on the normative parts of the output contents, or
2164 @code{0x@var{hexstring}} to use a chosen bit string specified as
2165 an even number of hexadecimal digits (@code{-} and @code{:}
2166 characters between digit pairs are ignored).  If @var{style} is
2167 omitted, @code{sha1} is used.
2168
2169 The @code{md5} and @code{sha1} styles produces an identifier
2170 that is always the same in an identical output file, but will be
2171 unique among all nonidentical output files.  It is not intended
2172 to be compared as a checksum for the file's contents.  A linked
2173 file may be changed later by other tools, but the build ID bit
2174 string identifying the original linked file does not change.
2175
2176 Passing @code{none} for @var{style} disables the setting from any
2177 @code{--build-id} options earlier on the command line.
2178 @end table
2179
2180 @c man end
2181
2182 @subsection Options Specific to i386 PE Targets
2183
2184 @c man begin OPTIONS
2185
2186 The i386 PE linker supports the @option{-shared} option, which causes
2187 the output to be a dynamically linked library (DLL) instead of a
2188 normal executable.  You should name the output @code{*.dll} when you
2189 use this option.  In addition, the linker fully supports the standard
2190 @code{*.def} files, which may be specified on the linker command line
2191 like an object file (in fact, it should precede archives it exports
2192 symbols from, to ensure that they get linked in, just like a normal
2193 object file).
2194
2195 In addition to the options common to all targets, the i386 PE linker
2196 support additional command line options that are specific to the i386
2197 PE target.  Options that take values may be separated from their
2198 values by either a space or an equals sign.
2199
2200 @table @gcctabopt
2201
2202 @kindex --add-stdcall-alias
2203 @item --add-stdcall-alias
2204 If given, symbols with a stdcall suffix (@@@var{nn}) will be exported
2205 as-is and also with the suffix stripped.
2206 [This option is specific to the i386 PE targeted port of the linker]
2207
2208 @kindex --base-file
2209 @item --base-file @var{file}
2210 Use @var{file} as the name of a file in which to save the base
2211 addresses of all the relocations needed for generating DLLs with
2212 @file{dlltool}.
2213 [This is an i386 PE specific option]
2214
2215 @kindex --dll
2216 @item --dll
2217 Create a DLL instead of a regular executable.  You may also use
2218 @option{-shared} or specify a @code{LIBRARY} in a given @code{.def}
2219 file.
2220 [This option is specific to the i386 PE targeted port of the linker]
2221
2222 @kindex --enable-long-section-names
2223 @kindex --disable-long-section-names
2224 @item --enable-long-section-names
2225 @itemx --disable-long-section-names
2226 The PE variants of the Coff object format add an extension that permits
2227 the use of section names longer than eight characters, the normal limit
2228 for Coff.  By default, these names are only allowed in object files, as
2229 fully-linked executable images do not carry the Coff string table required
2230 to support the longer names.  As a GNU extension, it is possible to
2231 allow their use in executable images as well, or to (probably pointlessly!)
2232 disallow it in object files, by using these two options.  Executable images
2233 generated with these long section names are slightly non-standard, carrying
2234 as they do a string table, and may generate confusing output when examined
2235 with non-GNU PE-aware tools, such as file viewers and dumpers.  However,
2236 GDB relies on the use of PE long section names to find Dwarf-2 debug
2237 information sections in an executable image at runtime, and so if neither
2238 option is specified on the command-line, @command{ld} will enable long
2239 section names, overriding the default and technically correct behaviour,
2240 when it finds the presence of debug information while linking an executable
2241 image and not stripping symbols.
2242 [This option is valid for all PE targeted ports of the linker]
2243
2244 @kindex --enable-stdcall-fixup
2245 @kindex --disable-stdcall-fixup
2246 @item --enable-stdcall-fixup
2247 @itemx --disable-stdcall-fixup
2248 If the link finds a symbol that it cannot resolve, it will attempt to
2249 do ``fuzzy linking'' by looking for another defined symbol that differs
2250 only in the format of the symbol name (cdecl vs stdcall) and will
2251 resolve that symbol by linking to the match.  For example, the
2252 undefined symbol @code{_foo} might be linked to the function
2253 @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked
2254 to the function @code{_bar}.  When the linker does this, it prints a
2255 warning, since it normally should have failed to link, but sometimes
2256 import libraries generated from third-party dlls may need this feature
2257 to be usable.  If you specify @option{--enable-stdcall-fixup}, this
2258 feature is fully enabled and warnings are not printed.  If you specify
2259 @option{--disable-stdcall-fixup}, this feature is disabled and such
2260 mismatches are considered to be errors.
2261 [This option is specific to the i386 PE targeted port of the linker]
2262
2263 @kindex --leading-underscore
2264 @kindex --no-leading-underscore
2265 @item --leading-underscore
2266 @itemx --no-leading-underscore
2267 For most targets default symbol-prefix is an underscore and is defined
2268 in target's description. By this option it is possible to
2269 disable/enable the default underscore symbol-prefix.
2270
2271 @cindex DLLs, creating
2272 @kindex --export-all-symbols
2273 @item --export-all-symbols
2274 If given, all global symbols in the objects used to build a DLL will
2275 be exported by the DLL.  Note that this is the default if there
2276 otherwise wouldn't be any exported symbols.  When symbols are
2277 explicitly exported via DEF files or implicitly exported via function
2278 attributes, the default is to not export anything else unless this
2279 option is given.  Note that the symbols @code{DllMain@@12},
2280 @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and
2281 @code{impure_ptr} will not be automatically
2282 exported.  Also, symbols imported from other DLLs will not be
2283 re-exported, nor will symbols specifying the DLL's internal layout
2284 such as those beginning with @code{_head_} or ending with
2285 @code{_iname}.  In addition, no symbols from @code{libgcc},
2286 @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported.
2287 Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will
2288 not be exported, to help with C++ DLLs.  Finally, there is an
2289 extensive list of cygwin-private symbols that are not exported
2290 (obviously, this applies on when building DLLs for cygwin targets).
2291 These cygwin-excludes are: @code{_cygwin_dll_entry@@12},
2292 @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12},
2293 @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll},
2294 @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2},
2295 @code{cygwin_premain3}, and @code{environ}.
2296 [This option is specific to the i386 PE targeted port of the linker]
2297
2298 @kindex --exclude-symbols
2299 @item --exclude-symbols @var{symbol},@var{symbol},...
2300 Specifies a list of symbols which should not be automatically
2301 exported.  The symbol names may be delimited by commas or colons.
2302 [This option is specific to the i386 PE targeted port of the linker]
2303
2304 @kindex --exclude-all-symbols
2305 @item --exclude-all-symbols
2306 Specifies no symbols should be automatically exported.
2307 [This option is specific to the i386 PE targeted port of the linker]
2308
2309 @kindex --file-alignment
2310 @item --file-alignment
2311 Specify the file alignment.  Sections in the file will always begin at
2312 file offsets which are multiples of this number.  This defaults to
2313 512.
2314 [This option is specific to the i386 PE targeted port of the linker]
2315
2316 @cindex heap size
2317 @kindex --heap
2318 @item --heap @var{reserve}
2319 @itemx --heap @var{reserve},@var{commit}
2320 Specify the number of bytes of memory to reserve (and optionally commit)
2321 to be used as heap for this program.  The default is 1MB reserved, 4K
2322 committed.
2323 [This option is specific to the i386 PE targeted port of the linker]
2324
2325 @cindex image base
2326 @kindex --image-base
2327 @item --image-base @var{value}
2328 Use @var{value} as the base address of your program or dll.  This is
2329 the lowest memory location that will be used when your program or dll
2330 is loaded.  To reduce the need to relocate and improve performance of
2331 your dlls, each should have a unique base address and not overlap any
2332 other dlls.  The default is 0x400000 for executables, and 0x10000000
2333 for dlls.
2334 [This option is specific to the i386 PE targeted port of the linker]
2335
2336 @kindex --kill-at
2337 @item --kill-at
2338 If given, the stdcall suffixes (@@@var{nn}) will be stripped from
2339 symbols before they are exported.
2340 [This option is specific to the i386 PE targeted port of the linker]
2341
2342 @kindex --large-address-aware
2343 @item --large-address-aware
2344 If given, the appropriate bit in the ``Characteristics'' field of the COFF
2345 header is set to indicate that this executable supports virtual addresses
2346 greater than 2 gigabytes.  This should be used in conjunction with the /3GB
2347 or /USERVA=@var{value} megabytes switch in the ``[operating systems]''
2348 section of the BOOT.INI.  Otherwise, this bit has no effect.
2349 [This option is specific to PE targeted ports of the linker]
2350
2351 @kindex --disable-large-address-aware
2352 @item --disable-large-address-aware
2353 Reverts the effect of a previous @samp{--large-address-aware} option.
2354 This is useful if @samp{--large-address-aware} is always set by the compiler
2355 driver (e.g. Cygwin gcc) and the executable does not support virtual
2356 addresses greater than 2 gigabytes.
2357 [This option is specific to PE targeted ports of the linker]
2358
2359 @kindex --major-image-version
2360 @item --major-image-version @var{value}
2361 Sets the major number of the ``image version''.  Defaults to 1.
2362 [This option is specific to the i386 PE targeted port of the linker]
2363
2364 @kindex --major-os-version
2365 @item --major-os-version @var{value}
2366 Sets the major number of the ``os version''.  Defaults to 4.
2367 [This option is specific to the i386 PE targeted port of the linker]
2368
2369 @kindex --major-subsystem-version
2370 @item --major-subsystem-version @var{value}
2371 Sets the major number of the ``subsystem version''.  Defaults to 4.
2372 [This option is specific to the i386 PE targeted port of the linker]
2373
2374 @kindex --minor-image-version
2375 @item --minor-image-version @var{value}
2376 Sets the minor number of the ``image version''.  Defaults to 0.
2377 [This option is specific to the i386 PE targeted port of the linker]
2378
2379 @kindex --minor-os-version
2380 @item --minor-os-version @var{value}
2381 Sets the minor number of the ``os version''.  Defaults to 0.
2382 [This option is specific to the i386 PE targeted port of the linker]
2383
2384 @kindex --minor-subsystem-version
2385 @item --minor-subsystem-version @var{value}
2386 Sets the minor number of the ``subsystem version''.  Defaults to 0.
2387 [This option is specific to the i386 PE targeted port of the linker]
2388
2389 @cindex DEF files, creating
2390 @cindex DLLs, creating
2391 @kindex --output-def
2392 @item --output-def @var{file}
2393 The linker will create the file @var{file} which will contain a DEF
2394 file corresponding to the DLL the linker is generating.  This DEF file
2395 (which should be called @code{*.def}) may be used to create an import
2396 library with @code{dlltool} or may be used as a reference to
2397 automatically or implicitly exported symbols.
2398 [This option is specific to the i386 PE targeted port of the linker]
2399
2400 @cindex DLLs, creating
2401 @kindex --out-implib
2402 @item --out-implib @var{file}
2403 The linker will create the file @var{file} which will contain an
2404 import lib corresponding to the DLL the linker is generating. This
2405 import lib (which should be called @code{*.dll.a} or @code{*.a}
2406 may be used to link clients against the generated DLL; this behaviour
2407 makes it possible to skip a separate @code{dlltool} import library
2408 creation step.
2409 [This option is specific to the i386 PE targeted port of the linker]
2410
2411 @kindex --enable-auto-image-base
2412 @item --enable-auto-image-base
2413 Automatically choose the image base for DLLs, unless one is specified
2414 using the @code{--image-base} argument.  By using a hash generated
2415 from the dllname to create unique image bases for each DLL, in-memory
2416 collisions and relocations which can delay program execution are
2417 avoided.
2418 [This option is specific to the i386 PE targeted port of the linker]
2419
2420 @kindex --disable-auto-image-base
2421 @item --disable-auto-image-base
2422 Do not automatically generate a unique image base.  If there is no
2423 user-specified image base (@code{--image-base}) then use the platform
2424 default.
2425 [This option is specific to the i386 PE targeted port of the linker]
2426
2427 @cindex DLLs, linking to
2428 @kindex --dll-search-prefix
2429 @item --dll-search-prefix @var{string}
2430 When linking dynamically to a dll without an import library,
2431 search for @code{<string><basename>.dll} in preference to
2432 @code{lib<basename>.dll}. This behaviour allows easy distinction
2433 between DLLs built for the various "subplatforms": native, cygwin,
2434 uwin, pw, etc.  For instance, cygwin DLLs typically use
2435 @code{--dll-search-prefix=cyg}.
2436 [This option is specific to the i386 PE targeted port of the linker]
2437
2438 @kindex --enable-auto-import
2439 @item --enable-auto-import
2440 Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for
2441 DATA imports from DLLs, and create the necessary thunking symbols when
2442 building the import libraries with those DATA exports. Note: Use of the
2443 'auto-import' extension will cause the text section of the image file
2444 to be made writable. This does not conform to the PE-COFF format
2445 specification published by Microsoft.
2446
2447 Note - use of the 'auto-import' extension will also cause read only
2448 data which would normally be placed into the .rdata section to be
2449 placed into the .data section instead.  This is in order to work
2450 around a problem with consts that is described here:
2451 http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
2452
2453 Using 'auto-import' generally will 'just work' -- but sometimes you may
2454 see this message:
2455
2456 "variable '<var>' can't be auto-imported. Please read the
2457 documentation for ld's @code{--enable-auto-import} for details."
2458
2459 This message occurs when some (sub)expression accesses an address
2460 ultimately given by the sum of two constants (Win32 import tables only
2461 allow one).  Instances where this may occur include accesses to member
2462 fields of struct variables imported from a DLL, as well as using a
2463 constant index into an array variable imported from a DLL.  Any
2464 multiword variable (arrays, structs, long long, etc) may trigger
2465 this error condition.  However, regardless of the exact data type
2466 of the offending exported variable, ld will always detect it, issue
2467 the warning, and exit.
2468
2469 There are several ways to address this difficulty, regardless of the
2470 data type of the exported variable:
2471
2472 One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task
2473 of adjusting references in your client code for runtime environment, so
2474 this method works only when runtime environment supports this feature.
2475
2476 A second solution is to force one of the 'constants' to be a variable --
2477 that is, unknown and un-optimizable at compile time.  For arrays,
2478 there are two possibilities: a) make the indexee (the array's address)
2479 a variable, or b) make the 'constant' index a variable.  Thus:
2480
2481 @example
2482 extern type extern_array[];
2483 extern_array[1] -->
2484    @{ volatile type *t=extern_array; t[1] @}
2485 @end example
2486
2487 or
2488
2489 @example
2490 extern type extern_array[];
2491 extern_array[1] -->
2492    @{ volatile int t=1; extern_array[t] @}
2493 @end example
2494
2495 For structs (and most other multiword data types) the only option
2496 is to make the struct itself (or the long long, or the ...) variable:
2497
2498 @example
2499 extern struct s extern_struct;
2500 extern_struct.field -->
2501    @{ volatile struct s *t=&extern_struct; t->field @}
2502 @end example
2503
2504 or
2505
2506 @example
2507 extern long long extern_ll;
2508 extern_ll -->
2509   @{ volatile long long * local_ll=&extern_ll; *local_ll @}
2510 @end example
2511
2512 A third method of dealing with this difficulty is to abandon
2513 'auto-import' for the offending symbol and mark it with
2514 @code{__declspec(dllimport)}.  However, in practice that
2515 requires using compile-time #defines to indicate whether you are
2516 building a DLL, building client code that will link to the DLL, or
2517 merely building/linking to a static library.   In making the choice
2518 between the various methods of resolving the 'direct address with
2519 constant offset' problem, you should consider typical real-world usage:
2520
2521 Original:
2522 @example
2523 --foo.h
2524 extern int arr[];
2525 --foo.c
2526 #include "foo.h"
2527 void main(int argc, char **argv)@{
2528   printf("%d\n",arr[1]);
2529 @}
2530 @end example
2531
2532 Solution 1:
2533 @example
2534 --foo.h
2535 extern int arr[];
2536 --foo.c
2537 #include "foo.h"
2538 void main(int argc, char **argv)@{
2539   /* This workaround is for win32 and cygwin; do not "optimize" */
2540   volatile int *parr = arr;
2541   printf("%d\n",parr[1]);
2542 @}
2543 @end example
2544
2545 Solution 2:
2546 @example
2547 --foo.h
2548 /* Note: auto-export is assumed (no __declspec(dllexport)) */
2549 #if (defined(_WIN32) || defined(__CYGWIN__)) && \
2550   !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2551 #define FOO_IMPORT __declspec(dllimport)
2552 #else
2553 #define FOO_IMPORT
2554 #endif
2555 extern FOO_IMPORT int arr[];
2556 --foo.c
2557 #include "foo.h"
2558 void main(int argc, char **argv)@{
2559   printf("%d\n",arr[1]);
2560 @}
2561 @end example
2562
2563 A fourth way to avoid this problem is to re-code your
2564 library to use a functional interface rather than a data interface
2565 for the offending variables (e.g. set_foo() and get_foo() accessor
2566 functions).
2567 [This option is specific to the i386 PE targeted port of the linker]
2568
2569 @kindex --disable-auto-import
2570 @item --disable-auto-import
2571 Do not attempt to do sophisticated linking of @code{_symbol} to
2572 @code{__imp__symbol} for DATA imports from DLLs.
2573 [This option is specific to the i386 PE targeted port of the linker]
2574
2575 @kindex --enable-runtime-pseudo-reloc
2576 @item --enable-runtime-pseudo-reloc
2577 If your code contains expressions described in --enable-auto-import section,
2578 that is, DATA imports from DLL with non-zero offset, this switch will create
2579 a vector of 'runtime pseudo relocations' which can be used by runtime
2580 environment to adjust references to such data in your client code.
2581 [This option is specific to the i386 PE targeted port of the linker]
2582
2583 @kindex --disable-runtime-pseudo-reloc
2584 @item --disable-runtime-pseudo-reloc
2585 Do not create pseudo relocations for non-zero offset DATA imports from
2586 DLLs.
2587 [This option is specific to the i386 PE targeted port of the linker]
2588
2589 @kindex --enable-extra-pe-debug
2590 @item --enable-extra-pe-debug
2591 Show additional debug info related to auto-import symbol thunking.
2592 [This option is specific to the i386 PE targeted port of the linker]
2593
2594 @kindex --section-alignment
2595 @item --section-alignment
2596 Sets the section alignment.  Sections in memory will always begin at
2597 addresses which are a multiple of this number.  Defaults to 0x1000.
2598 [This option is specific to the i386 PE targeted port of the linker]
2599
2600 @cindex stack size
2601 @kindex --stack
2602 @item --stack @var{reserve}
2603 @itemx --stack @var{reserve},@var{commit}
2604 Specify the number of bytes of memory to reserve (and optionally commit)
2605 to be used as stack for this program.  The default is 2MB reserved, 4K
2606 committed.
2607 [This option is specific to the i386 PE targeted port of the linker]
2608
2609 @kindex --subsystem
2610 @item --subsystem @var{which}
2611 @itemx --subsystem @var{which}:@var{major}
2612 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2613 Specifies the subsystem under which your program will execute.  The
2614 legal values for @var{which} are @code{native}, @code{windows},
2615 @code{console}, @code{posix}, and @code{xbox}.  You may optionally set
2616 the subsystem version also.  Numeric values are also accepted for
2617 @var{which}.
2618 [This option is specific to the i386 PE targeted port of the linker]
2619
2620 The following options set flags in the @code{DllCharacteristics} field
2621 of the PE file header:
2622 [These options are specific to PE targeted ports of the linker]
2623
2624 @kindex --dynamicbase
2625 @item --dynamicbase
2626 The image base address may be relocated using address space layout
2627 randomization (ASLR).  This feature was introduced with MS Windows
2628 Vista for i386 PE targets.
2629
2630 @kindex --forceinteg
2631 @item --forceinteg
2632 Code integrity checks are enforced.
2633
2634 @kindex --nxcompat
2635 @item --nxcompat
2636 The image is compatible with the Data Execution Prevention.
2637 This feature was introduced with MS Windows XP SP2 for i386 PE targets.
2638
2639 @kindex --no-isolation
2640 @item --no-isolation
2641 Although the image understands isolation, do not isolate the image.
2642
2643 @kindex --no-seh
2644 @item --no-seh
2645 The image does not use SEH. No SE handler may be called from
2646 this image.
2647
2648 @kindex --no-bind
2649 @item --no-bind
2650 Do not bind this image.
2651
2652 @kindex --wdmdriver
2653 @item --wdmdriver
2654 The driver uses the MS Windows Driver Model.
2655
2656 @kindex --tsaware
2657 @item --tsaware
2658 The image is Terminal Server aware.
2659
2660 @kindex --insert-timestamp
2661 @item --insert-timestamp
2662 Insert a real timestamp into the image, rather than the default value
2663 of zero.  This will result in a slightly different results with each
2664 invocation, which could be helpful for distributing unique images.
2665 @end table
2666
2667 @c man end
2668
2669 @ifset C6X
2670 @subsection Options specific to C6X uClinux targets
2671
2672 @c man begin OPTIONS
2673
2674 The C6X uClinux target uses a binary format called DSBT to support shared
2675 libraries.  Each shared library in the system needs to have a unique index;
2676 all executables use an index of 0.
2677
2678 @table @gcctabopt
2679
2680 @kindex --dsbt-size
2681 @item --dsbt-size @var{size}
2682 This option sets the number of entires in the DSBT of the current executable
2683 or shared library to @var{size}.  The default is to create a table with 64
2684 entries.
2685
2686 @kindex --dsbt-index
2687 @item --dsbt-index @var{index}
2688 This option sets the DSBT index of the current executable or shared library
2689 to @var{index}.  The default is 0, which is appropriate for generating
2690 executables.  If a shared library is generated with a DSBT index of 0, the
2691 @code{R_C6000_DSBT_INDEX} relocs are copied into the output file.
2692
2693 @kindex --no-merge-exidx-entries
2694 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent
2695 exidx entries in frame unwind info.
2696
2697 @end table
2698
2699 @c man end
2700 @end ifset
2701
2702 @ifset M68HC11
2703 @subsection Options specific to Motorola 68HC11 and 68HC12 targets
2704
2705 @c man begin OPTIONS
2706
2707 The 68HC11 and 68HC12 linkers support specific options to control the
2708 memory bank switching mapping and trampoline code generation.
2709
2710 @table @gcctabopt
2711
2712 @kindex --no-trampoline
2713 @item --no-trampoline
2714 This option disables the generation of trampoline. By default a trampoline
2715 is generated for each far function which is called using a @code{jsr}
2716 instruction (this happens when a pointer to a far function is taken).
2717
2718 @kindex --bank-window
2719 @item --bank-window @var{name}
2720 This option indicates to the linker the name of the memory region in
2721 the @samp{MEMORY} specification that describes the memory bank window.
2722 The definition of such region is then used by the linker to compute
2723 paging and addresses within the memory window.
2724
2725 @end table
2726
2727 @c man end
2728 @end ifset
2729
2730 @ifset M68K
2731 @subsection Options specific to Motorola 68K target
2732
2733 @c man begin OPTIONS
2734
2735 The following options are supported to control handling of GOT generation
2736 when linking for 68K targets.
2737
2738 @table @gcctabopt
2739
2740 @kindex --got
2741 @item --got=@var{type}
2742 This option tells the linker which GOT generation scheme to use.
2743 @var{type} should be one of @samp{single}, @samp{negative},
2744 @samp{multigot} or @samp{target}.  For more information refer to the
2745 Info entry for @file{ld}.
2746
2747 @end table
2748
2749 @c man end
2750 @end ifset
2751
2752 @ifset MIPS
2753 @subsection Options specific to MIPS targets
2754
2755 @c man begin OPTIONS
2756
2757 The following options are supported to control microMIPS instruction
2758 generation when linking for MIPS targets.
2759
2760 @table @gcctabopt
2761
2762 @kindex --insn32
2763 @item --insn32
2764 @kindex --no-insn32
2765 @itemx --no-insn32
2766 These options control the choice of microMIPS instructions used in code
2767 generated by the linker, such as that in the PLT or lazy binding stubs,
2768 or in relaxation.  If @samp{--insn32} is used, then the linker only uses
2769 32-bit instruction encodings.  By default or if @samp{--no-insn32} is
2770 used, all instruction encodings are used, including 16-bit ones where
2771 possible.
2772
2773 @end table
2774
2775 @c man end
2776 @end ifset
2777
2778 @ifset UsesEnvVars
2779 @node Environment
2780 @section Environment Variables
2781
2782 @c man begin ENVIRONMENT
2783
2784 You can change the behaviour of @command{ld} with the environment variables
2785 @ifclear SingleFormat
2786 @code{GNUTARGET},
2787 @end ifclear
2788 @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
2789
2790 @ifclear SingleFormat
2791 @kindex GNUTARGET
2792 @cindex default input format
2793 @code{GNUTARGET} determines the input-file object format if you don't
2794 use @samp{-b} (or its synonym @samp{--format}).  Its value should be one
2795 of the BFD names for an input format (@pxref{BFD}).  If there is no
2796 @code{GNUTARGET} in the environment, @command{ld} uses the natural format
2797 of the target. If @code{GNUTARGET} is set to @code{default} then BFD
2798 attempts to discover the input format by examining binary input files;
2799 this method often succeeds, but there are potential ambiguities, since
2800 there is no method of ensuring that the magic number used to specify
2801 object-file formats is unique.  However, the configuration procedure for
2802 BFD on each system places the conventional format for that system first
2803 in the search-list, so ambiguities are resolved in favor of convention.
2804 @end ifclear
2805
2806 @kindex LDEMULATION
2807 @cindex default emulation
2808 @cindex emulation, default
2809 @code{LDEMULATION} determines the default emulation if you don't use the
2810 @samp{-m} option.  The emulation can affect various aspects of linker
2811 behaviour, particularly the default linker script.  You can list the
2812 available emulations with the @samp{--verbose} or @samp{-V} options.  If
2813 the @samp{-m} option is not used, and the @code{LDEMULATION} environment
2814 variable is not defined, the default emulation depends upon how the
2815 linker was configured.
2816
2817 @kindex COLLECT_NO_DEMANGLE
2818 @cindex demangling, default
2819 Normally, the linker will default to demangling symbols.  However, if
2820 @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will
2821 default to not demangling symbols.  This environment variable is used in
2822 a similar fashion by the @code{gcc} linker wrapper program.  The default
2823 may be overridden by the @samp{--demangle} and @samp{--no-demangle}
2824 options.
2825
2826 @c man end
2827 @end ifset
2828
2829 @node Scripts
2830 @chapter Linker Scripts
2831
2832 @cindex scripts
2833 @cindex linker scripts
2834 @cindex command files
2835 Every link is controlled by a @dfn{linker script}.  This script is
2836 written in the linker command language.
2837
2838 The main purpose of the linker script is to describe how the sections in
2839 the input files should be mapped into the output file, and to control
2840 the memory layout of the output file.  Most linker scripts do nothing
2841 more than this.  However, when necessary, the linker script can also
2842 direct the linker to perform many other operations, using the commands
2843 described below.
2844
2845 The linker always uses a linker script.  If you do not supply one
2846 yourself, the linker will use a default script that is compiled into the
2847 linker executable.  You can use the @samp{--verbose} command line option
2848 to display the default linker script.  Certain command line options,
2849 such as @samp{-r} or @samp{-N}, will affect the default linker script.
2850
2851 You may supply your own linker script by using the @samp{-T} command
2852 line option.  When you do this, your linker script will replace the
2853 default linker script.
2854
2855 You may also use linker scripts implicitly by naming them as input files
2856 to the linker, as though they were files to be linked.  @xref{Implicit
2857 Linker Scripts}.
2858
2859 @menu
2860 * Basic Script Concepts::       Basic Linker Script Concepts
2861 * Script Format::               Linker Script Format
2862 * Simple Example::              Simple Linker Script Example
2863 * Simple Commands::             Simple Linker Script Commands
2864 * Assignments::                 Assigning Values to Symbols
2865 * SECTIONS::                    SECTIONS Command
2866 * MEMORY::                      MEMORY Command
2867 * PHDRS::                       PHDRS Command
2868 * VERSION::                     VERSION Command
2869 * Expressions::                 Expressions in Linker Scripts
2870 * Implicit Linker Scripts::     Implicit Linker Scripts
2871 @end menu
2872
2873 @node Basic Script Concepts
2874 @section Basic Linker Script Concepts
2875 @cindex linker script concepts
2876 We need to define some basic concepts and vocabulary in order to
2877 describe the linker script language.
2878
2879 The linker combines input files into a single output file.  The output
2880 file and each input file are in a special data format known as an
2881 @dfn{object file format}.  Each file is called an @dfn{object file}.
2882 The output file is often called an @dfn{executable}, but for our
2883 purposes we will also call it an object file.  Each object file has,
2884 among other things, a list of @dfn{sections}.  We sometimes refer to a
2885 section in an input file as an @dfn{input section}; similarly, a section
2886 in the output file is an @dfn{output section}.
2887
2888 Each section in an object file has a name and a size.  Most sections
2889 also have an associated block of data, known as the @dfn{section
2890 contents}.  A section may be marked as @dfn{loadable}, which means that
2891 the contents should be loaded into memory when the output file is run.
2892 A section with no contents may be @dfn{allocatable}, which means that an
2893 area in memory should be set aside, but nothing in particular should be
2894 loaded there (in some cases this memory must be zeroed out).  A section
2895 which is neither loadable nor allocatable typically contains some sort
2896 of debugging information.
2897
2898 Every loadable or allocatable output section has two addresses.  The
2899 first is the @dfn{VMA}, or virtual memory address.  This is the address
2900 the section will have when the output file is run.  The second is the
2901 @dfn{LMA}, or load memory address.  This is the address at which the
2902 section will be loaded.  In most cases the two addresses will be the
2903 same.  An example of when they might be different is when a data section
2904 is loaded into ROM, and then copied into RAM when the program starts up
2905 (this technique is often used to initialize global variables in a ROM
2906 based system).  In this case the ROM address would be the LMA, and the
2907 RAM address would be the VMA.
2908
2909 You can see the sections in an object file by using the @code{objdump}
2910 program with the @samp{-h} option.
2911
2912 Every object file also has a list of @dfn{symbols}, known as the
2913 @dfn{symbol table}.  A symbol may be defined or undefined.  Each symbol
2914 has a name, and each defined symbol has an address, among other
2915 information.  If you compile a C or C++ program into an object file, you
2916 will get a defined symbol for every defined function and global or
2917 static variable.  Every undefined function or global variable which is
2918 referenced in the input file will become an undefined symbol.
2919
2920 You can see the symbols in an object file by using the @code{nm}
2921 program, or by using the @code{objdump} program with the @samp{-t}
2922 option.
2923
2924 @node Script Format
2925 @section Linker Script Format
2926 @cindex linker script format
2927 Linker scripts are text files.
2928
2929 You write a linker script as a series of commands.  Each command is
2930 either a keyword, possibly followed by arguments, or an assignment to a
2931 symbol.  You may separate commands using semicolons.  Whitespace is
2932 generally ignored.
2933
2934 Strings such as file or format names can normally be entered directly.
2935 If the file name contains a character such as a comma which would
2936 otherwise serve to separate file names, you may put the file name in
2937 double quotes.  There is no way to use a double quote character in a
2938 file name.
2939
2940 You may include comments in linker scripts just as in C, delimited by
2941 @samp{/*} and @samp{*/}.  As in C, comments are syntactically equivalent
2942 to whitespace.
2943
2944 @node Simple Example
2945 @section Simple Linker Script Example
2946 @cindex linker script example
2947 @cindex example of linker script
2948 Many linker scripts are fairly simple.
2949
2950 The simplest possible linker script has just one command:
2951 @samp{SECTIONS}.  You use the @samp{SECTIONS} command to describe the
2952 memory layout of the output file.
2953
2954 The @samp{SECTIONS} command is a powerful command.  Here we will
2955 describe a simple use of it.  Let's assume your program consists only of
2956 code, initialized data, and uninitialized data.  These will be in the
2957 @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively.
2958 Let's assume further that these are the only sections which appear in
2959 your input files.
2960
2961 For this example, let's say that the code should be loaded at address
2962 0x10000, and that the data should start at address 0x8000000.  Here is a
2963 linker script which will do that:
2964 @smallexample
2965 SECTIONS
2966 @{
2967   . = 0x10000;
2968   .text : @{ *(.text) @}
2969   . = 0x8000000;
2970   .data : @{ *(.data) @}
2971   .bss : @{ *(.bss) @}
2972 @}
2973 @end smallexample
2974
2975 You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS},
2976 followed by a series of symbol assignments and output section
2977 descriptions enclosed in curly braces.
2978
2979 The first line inside the @samp{SECTIONS} command of the above example
2980 sets the value of the special symbol @samp{.}, which is the location
2981 counter.  If you do not specify the address of an output section in some
2982 other way (other ways are described later), the address is set from the
2983 current value of the location counter.  The location counter is then
2984 incremented by the size of the output section.  At the start of the
2985 @samp{SECTIONS} command, the location counter has the value @samp{0}.
2986
2987 The second line defines an output section, @samp{.text}.  The colon is
2988 required syntax which may be ignored for now.  Within the curly braces
2989 after the output section name, you list the names of the input sections
2990 which should be placed into this output section.  The @samp{*} is a
2991 wildcard which matches any file name.  The expression @samp{*(.text)}
2992 means all @samp{.text} input sections in all input files.
2993
2994 Since the location counter is @samp{0x10000} when the output section
2995 @samp{.text} is defined, the linker will set the address of the
2996 @samp{.text} section in the output file to be @samp{0x10000}.
2997
2998 The remaining lines define the @samp{.data} and @samp{.bss} sections in
2999 the output file.  The linker will place the @samp{.data} output section
3000 at address @samp{0x8000000}.  After the linker places the @samp{.data}
3001 output section, the value of the location counter will be
3002 @samp{0x8000000} plus the size of the @samp{.data} output section.  The
3003 effect is that the linker will place the @samp{.bss} output section
3004 immediately after the @samp{.data} output section in memory.
3005
3006 The linker will ensure that each output section has the required
3007 alignment, by increasing the location counter if necessary.  In this
3008 example, the specified addresses for the @samp{.text} and @samp{.data}
3009 sections will probably satisfy any alignment constraints, but the linker
3010 may have to create a small gap between the @samp{.data} and @samp{.bss}
3011 sections.
3012
3013 That's it!  That's a simple and complete linker script.
3014
3015 @node Simple Commands
3016 @section Simple Linker Script Commands
3017 @cindex linker script simple commands
3018 In this section we describe the simple linker script commands.
3019
3020 @menu
3021 * Entry Point::                 Setting the entry point
3022 * File Commands::               Commands dealing with files
3023 @ifclear SingleFormat
3024 * Format Commands::             Commands dealing with object file formats
3025 @end ifclear
3026
3027 * REGION_ALIAS::                Assign alias names to memory regions
3028 * Miscellaneous Commands::      Other linker script commands
3029 @end menu
3030
3031 @node Entry Point
3032 @subsection Setting the Entry Point
3033 @kindex ENTRY(@var{symbol})
3034 @cindex start of execution
3035 @cindex first instruction
3036 @cindex entry point
3037 The first instruction to execute in a program is called the @dfn{entry
3038 point}.  You can use the @code{ENTRY} linker script command to set the
3039 entry point.  The argument is a symbol name:
3040 @smallexample
3041 ENTRY(@var{symbol})
3042 @end smallexample
3043
3044 There are several ways to set the entry point.  The linker will set the
3045 entry point by trying each of the following methods in order, and
3046 stopping when one of them succeeds:
3047 @itemize @bullet
3048 @item
3049 the @samp{-e} @var{entry} command-line option;
3050 @item
3051 the @code{ENTRY(@var{symbol})} command in a linker script;
3052 @item
3053 the value of a target specific symbol, if it is defined;  For many
3054 targets this is @code{start}, but PE and BeOS based systems for example
3055 check a list of possible entry symbols, matching the first one found.
3056 @item
3057 the address of the first byte of the @samp{.text} section, if present;
3058 @item
3059 The address @code{0}.
3060 @end itemize
3061
3062 @node File Commands
3063 @subsection Commands Dealing with Files
3064 @cindex linker script file commands
3065 Several linker script commands deal with files.
3066
3067 @table @code
3068 @item INCLUDE @var{filename}
3069 @kindex INCLUDE @var{filename}
3070 @cindex including a linker script
3071 Include the linker script @var{filename} at this point.  The file will
3072 be searched for in the current directory, and in any directory specified
3073 with the @option{-L} option.  You can nest calls to @code{INCLUDE} up to
3074 10 levels deep.
3075
3076 You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or
3077 @code{SECTIONS} commands, or in output section descriptions.
3078
3079 @item INPUT(@var{file}, @var{file}, @dots{})
3080 @itemx INPUT(@var{file} @var{file} @dots{})
3081 @kindex INPUT(@var{files})
3082 @cindex input files in linker scripts
3083 @cindex input object files in linker scripts
3084 @cindex linker script input object files
3085 The @code{INPUT} command directs the linker to include the named files
3086 in the link, as though they were named on the command line.
3087
3088 For example, if you always want to include @file{subr.o} any time you do
3089 a link, but you can't be bothered to put it on every link command line,
3090 then you can put @samp{INPUT (subr.o)} in your linker script.
3091
3092 In fact, if you like, you can list all of your input files in the linker
3093 script, and then invoke the linker with nothing but a @samp{-T} option.
3094
3095 In case a @dfn{sysroot prefix} is configured, and the filename starts
3096 with the @samp{/} character, and the script being processed was
3097 located inside the @dfn{sysroot prefix}, the filename will be looked
3098 for in the @dfn{sysroot prefix}.  Otherwise, the linker will try to
3099 open the file in the current directory.  If it is not found, the
3100 linker will search through the archive library search path.  See the
3101 description of @samp{-L} in @ref{Options,,Command Line Options}.
3102
3103 If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the
3104 name to @code{lib@var{file}.a}, as with the command line argument
3105 @samp{-l}.
3106
3107 When you use the @code{INPUT} command in an implicit linker script, the
3108 files will be included in the link at the point at which the linker
3109 script file is included.  This can affect archive searching.
3110
3111 @item GROUP(@var{file}, @var{file}, @dots{})
3112 @itemx GROUP(@var{file} @var{file} @dots{})
3113 @kindex GROUP(@var{files})
3114 @cindex grouping input files
3115 The @code{GROUP} command is like @code{INPUT}, except that the named
3116 files should all be archives, and they are searched repeatedly until no
3117 new undefined references are created.  See the description of @samp{-(}
3118 in @ref{Options,,Command Line Options}.
3119
3120 @item AS_NEEDED(@var{file}, @var{file}, @dots{})
3121 @itemx AS_NEEDED(@var{file} @var{file} @dots{})
3122 @kindex AS_NEEDED(@var{files})
3123 This construct can appear only inside of the @code{INPUT} or @code{GROUP}
3124 commands, among other filenames.  The files listed will be handled
3125 as if they appear directly in the @code{INPUT} or @code{GROUP} commands,
3126 with the exception of ELF shared libraries, that will be added only
3127 when they are actually needed.  This construct essentially enables
3128 @option{--as-needed} option for all the files listed inside of it
3129 and restores previous @option{--as-needed} resp. @option{--no-as-needed}
3130 setting afterwards.
3131
3132 @item OUTPUT(@var{filename})
3133 @kindex OUTPUT(@var{filename})
3134 @cindex output file name in linker script
3135 The @code{OUTPUT} command names the output file.  Using
3136 @code{OUTPUT(@var{filename})} in the linker script is exactly like using
3137 @samp{-o @var{filename}} on the command line (@pxref{Options,,Command
3138 Line Options}).  If both are used, the command line option takes
3139 precedence.
3140
3141 You can use the @code{OUTPUT} command to define a default name for the
3142 output file other than the usual default of @file{a.out}.
3143
3144 @item SEARCH_DIR(@var{path})
3145 @kindex SEARCH_DIR(@var{path})
3146 @cindex library search path in linker script
3147 @cindex archive search path in linker script
3148 @cindex search path in linker script
3149 The @code{SEARCH_DIR} command adds @var{path} to the list of paths where
3150 @command{ld} looks for archive libraries.  Using
3151 @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}}
3152 on the command line (@pxref{Options,,Command Line Options}).  If both
3153 are used, then the linker will search both paths.  Paths specified using
3154 the command line option are searched first.
3155
3156 @item STARTUP(@var{filename})
3157 @kindex STARTUP(@var{filename})
3158 @cindex first input file
3159 The @code{STARTUP} command is just like the @code{INPUT} command, except
3160 that @var{filename} will become the first input file to be linked, as
3161 though it were specified first on the command line.  This may be useful
3162 when using a system in which the entry point is always the start of the
3163 first file.
3164 @end table
3165
3166 @ifclear SingleFormat
3167 @node Format Commands
3168 @subsection Commands Dealing with Object File Formats
3169 A couple of linker script commands deal with object file formats.
3170
3171 @table @code
3172 @item OUTPUT_FORMAT(@var{bfdname})
3173 @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little})
3174 @kindex OUTPUT_FORMAT(@var{bfdname})
3175 @cindex output file format in linker script
3176 The @code{OUTPUT_FORMAT} command names the BFD format to use for the
3177 output file (@pxref{BFD}).  Using @code{OUTPUT_FORMAT(@var{bfdname})} is
3178 exactly like using @samp{--oformat @var{bfdname}} on the command line
3179 (@pxref{Options,,Command Line Options}).  If both are used, the command
3180 line option takes precedence.
3181
3182 You can use @code{OUTPUT_FORMAT} with three arguments to use different
3183 formats based on the @samp{-EB} and @samp{-EL} command line options.
3184 This permits the linker script to set the output format based on the
3185 desired endianness.
3186
3187 If neither @samp{-EB} nor @samp{-EL} are used, then the output format
3188 will be the first argument, @var{default}.  If @samp{-EB} is used, the
3189 output format will be the second argument, @var{big}.  If @samp{-EL} is
3190 used, the output format will be the third argument, @var{little}.
3191
3192 For example, the default linker script for the MIPS ELF target uses this
3193 command:
3194 @smallexample
3195 OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
3196 @end smallexample
3197 This says that the default format for the output file is
3198 @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line
3199 option, the output file will be created in the @samp{elf32-littlemips}
3200 format.
3201
3202 @item TARGET(@var{bfdname})
3203 @kindex TARGET(@var{bfdname})
3204 @cindex input file format in linker script
3205 The @code{TARGET} command names the BFD format to use when reading input
3206 files.  It affects subsequent @code{INPUT} and @code{GROUP} commands.
3207 This command is like using @samp{-b @var{bfdname}} on the command line
3208 (@pxref{Options,,Command Line Options}).  If the @code{TARGET} command
3209 is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET}
3210 command is also used to set the format for the output file.  @xref{BFD}.
3211 @end table
3212 @end ifclear
3213
3214 @node REGION_ALIAS
3215 @subsection Assign alias names to memory regions
3216 @kindex REGION_ALIAS(@var{alias}, @var{region})
3217 @cindex region alias
3218 @cindex region names
3219
3220 Alias names can be added to existing memory regions created with the
3221 @ref{MEMORY} command.  Each name corresponds to at most one memory region.
3222
3223 @smallexample
3224 REGION_ALIAS(@var{alias}, @var{region})
3225 @end smallexample
3226
3227 The @code{REGION_ALIAS} function creates an alias name @var{alias} for the
3228 memory region @var{region}.  This allows a flexible mapping of output sections
3229 to memory regions.  An example follows.
3230
3231 Suppose we have an application for embedded systems which come with various
3232 memory storage devices.  All have a general purpose, volatile memory @code{RAM}
3233 that allows code execution or data storage.  Some may have a read-only,
3234 non-volatile memory @code{ROM} that allows code execution and read-only data
3235 access.  The last variant is a read-only, non-volatile memory @code{ROM2} with
3236 read-only data access and no code execution capability.  We have four output
3237 sections:
3238
3239 @itemize @bullet
3240 @item
3241 @code{.text} program code;
3242 @item
3243 @code{.rodata} read-only data;
3244 @item
3245 @code{.data} read-write initialized data;
3246 @item
3247 @code{.bss} read-write zero initialized data.
3248 @end itemize
3249
3250 The goal is to provide a linker command file that contains a system independent
3251 part defining the output sections and a system dependent part mapping the
3252 output sections to the memory regions available on the system.  Our embedded
3253 systems come with three different memory setups @code{A}, @code{B} and
3254 @code{C}:
3255 @multitable @columnfractions .25 .25 .25 .25
3256 @item Section @tab Variant A @tab Variant B @tab Variant C
3257 @item .text @tab RAM @tab ROM @tab ROM
3258 @item .rodata @tab RAM @tab ROM @tab ROM2
3259 @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2
3260 @item .bss @tab RAM @tab RAM @tab RAM
3261 @end multitable
3262 The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is
3263 loaded into region @code{ROM} or @code{ROM2} respectively.  Please note that
3264 the load address of the @code{.data} section starts in all three variants at
3265 the end of the @code{.rodata} section.
3266
3267 The base linker script that deals with the output sections follows.  It
3268 includes the system dependent @code{linkcmds.memory} file that describes the
3269 memory layout:
3270 @smallexample
3271 INCLUDE linkcmds.memory
3272
3273 SECTIONS
3274   @{
3275     .text :
3276       @{
3277         *(.text)
3278       @} > REGION_TEXT
3279     .rodata :
3280       @{
3281         *(.rodata)
3282         rodata_end = .;
3283       @} > REGION_RODATA
3284     .data : AT (rodata_end)
3285       @{
3286         data_start = .;
3287         *(.data)
3288       @} > REGION_DATA
3289     data_size = SIZEOF(.data);
3290     data_load_start = LOADADDR(.data);
3291     .bss :
3292       @{
3293         *(.bss)
3294       @} > REGION_BSS
3295   @}
3296 @end smallexample
3297
3298 Now we need three different @code{linkcmds.memory} files to define memory
3299 regions and alias names.  The content of @code{linkcmds.memory} for the three
3300 variants @code{A}, @code{B} and @code{C}:
3301 @table @code
3302 @item A
3303 Here everything goes into the @code{RAM}.
3304 @smallexample
3305 MEMORY
3306   @{
3307     RAM : ORIGIN = 0, LENGTH = 4M
3308   @}
3309
3310 REGION_ALIAS("REGION_TEXT", RAM);
3311 REGION_ALIAS("REGION_RODATA", RAM);
3312 REGION_ALIAS("REGION_DATA", RAM);
3313 REGION_ALIAS("REGION_BSS", RAM);
3314 @end smallexample
3315 @item B
3316 Program code and read-only data go into the @code{ROM}.  Read-write data goes
3317 into the @code{RAM}.  An image of the initialized data is loaded into the
3318 @code{ROM} and will be copied during system start into the @code{RAM}.
3319 @smallexample
3320 MEMORY
3321   @{
3322     ROM : ORIGIN = 0, LENGTH = 3M
3323     RAM : ORIGIN = 0x10000000, LENGTH = 1M
3324   @}
3325
3326 REGION_ALIAS("REGION_TEXT", ROM);
3327 REGION_ALIAS("REGION_RODATA", ROM);
3328 REGION_ALIAS("REGION_DATA", RAM);
3329 REGION_ALIAS("REGION_BSS", RAM);
3330 @end smallexample
3331 @item C
3332 Program code goes into the @code{ROM}.  Read-only data goes into the
3333 @code{ROM2}.  Read-write data goes into the @code{RAM}.  An image of the
3334 initialized data is loaded into the @code{ROM2} and will be copied during
3335 system start into the @code{RAM}.
3336 @smallexample
3337 MEMORY
3338   @{
3339     ROM : ORIGIN = 0, LENGTH = 2M
3340     ROM2 : ORIGIN = 0x10000000, LENGTH = 1M
3341     RAM : ORIGIN = 0x20000000, LENGTH = 1M
3342   @}
3343
3344 REGION_ALIAS("REGION_TEXT", ROM);
3345 REGION_ALIAS("REGION_RODATA", ROM2);
3346 REGION_ALIAS("REGION_DATA", RAM);
3347 REGION_ALIAS("REGION_BSS", RAM);
3348 @end smallexample
3349 @end table
3350
3351 It is possible to write a common system initialization routine to copy the
3352 @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if
3353 necessary:
3354 @smallexample
3355 #include <string.h>
3356
3357 extern char data_start [];
3358 extern char data_size [];
3359 extern char data_load_start [];
3360
3361 void copy_data(void)
3362 @{
3363   if (data_start != data_load_start)
3364     @{
3365       memcpy(data_start, data_load_start, (size_t) data_size);
3366     @}
3367 @}
3368 @end smallexample
3369
3370 @node Miscellaneous Commands
3371 @subsection Other Linker Script Commands
3372 There are a few other linker scripts commands.
3373
3374 @table @code
3375 @item ASSERT(@var{exp}, @var{message})
3376 @kindex ASSERT
3377 @cindex assertion in linker script
3378 Ensure that @var{exp} is non-zero.  If it is zero, then exit the linker
3379 with an error code, and print @var{message}.
3380
3381 @item EXTERN(@var{symbol} @var{symbol} @dots{})
3382 @kindex EXTERN
3383 @cindex undefined symbol in linker script
3384 Force @var{symbol} to be entered in the output file as an undefined
3385 symbol.  Doing this may, for example, trigger linking of additional
3386 modules from standard libraries.  You may list several @var{symbol}s for
3387 each @code{EXTERN}, and you may use @code{EXTERN} multiple times.  This
3388 command has the same effect as the @samp{-u} command-line option.
3389
3390 @item FORCE_COMMON_ALLOCATION
3391 @kindex FORCE_COMMON_ALLOCATION
3392 @cindex common allocation in linker script
3393 This command has the same effect as the @samp{-d} command-line option:
3394 to make @command{ld} assign space to common symbols even if a relocatable
3395 output file is specified (@samp{-r}).
3396
3397 @item INHIBIT_COMMON_ALLOCATION
3398 @kindex INHIBIT_COMMON_ALLOCATION
3399 @cindex common allocation in linker script
3400 This command has the same effect as the @samp{--no-define-common}
3401 command-line option: to make @code{ld} omit the assignment of addresses
3402 to common symbols even for a non-relocatable output file.
3403
3404 @item INSERT [ AFTER | BEFORE ] @var{output_section}
3405 @kindex INSERT
3406 @cindex insert user script into default script
3407 This command is typically used in a script specified by @samp{-T} to
3408 augment the default @code{SECTIONS} with, for example, overlays.  It
3409 inserts all prior linker script statements after (or before)
3410 @var{output_section}, and also causes @samp{-T} to not override the
3411 default linker script.  The exact insertion point is as for orphan
3412 sections.  @xref{Location Counter}.  The insertion happens after the
3413 linker has mapped input sections to output sections.  Prior to the
3414 insertion, since @samp{-T} scripts are parsed before the default
3415 linker script, statements in the @samp{-T} script occur before the
3416 default linker script statements in the internal linker representation
3417 of the script.  In particular, input section assignments will be made
3418 to @samp{-T} output sections before those in the default script.  Here
3419 is an example of how a @samp{-T} script using @code{INSERT} might look:
3420
3421 @smallexample
3422 SECTIONS
3423 @{
3424   OVERLAY :
3425   @{
3426     .ov1 @{ ov1*(.text) @}
3427     .ov2 @{ ov2*(.text) @}
3428   @}
3429 @}
3430 INSERT AFTER .text;
3431 @end smallexample
3432
3433 @item NOCROSSREFS(@var{section} @var{section} @dots{})
3434 @kindex NOCROSSREFS(@var{sections})
3435 @cindex cross references
3436 This command may be used to tell @command{ld} to issue an error about any
3437 references among certain output sections.
3438
3439 In certain types of programs, particularly on embedded systems when
3440 using overlays, when one section is loaded into memory, another section
3441 will not be.  Any direct references between the two sections would be
3442 errors.  For example, it would be an error if code in one section called
3443 a function defined in the other section.
3444
3445 The @code{NOCROSSREFS} command takes a list of output section names.  If
3446 @command{ld} detects any cross references between the sections, it reports
3447 an error and returns a non-zero exit status.  Note that the
3448 @code{NOCROSSREFS} command uses output section names, not input section
3449 names.
3450
3451 @ifclear SingleFormat
3452 @item OUTPUT_ARCH(@var{bfdarch})
3453 @kindex OUTPUT_ARCH(@var{bfdarch})
3454 @cindex machine architecture
3455 @cindex architecture
3456 Specify a particular output machine architecture.  The argument is one
3457 of the names used by the BFD library (@pxref{BFD}).  You can see the
3458 architecture of an object file by using the @code{objdump} program with
3459 the @samp{-f} option.
3460 @end ifclear
3461
3462 @item LD_FEATURE(@var{string})
3463 @kindex LD_FEATURE(@var{string})
3464 This command may be used to modify @command{ld} behavior.  If
3465 @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers
3466 in a script are simply treated as numbers everywhere.
3467 @xref{Expression Section}.
3468 @end table
3469
3470 @node Assignments
3471 @section Assigning Values to Symbols
3472 @cindex assignment in scripts
3473 @cindex symbol definition, scripts
3474 @cindex variables, defining
3475 You may assign a value to a symbol in a linker script.  This will define
3476 the symbol and place it into the symbol table with a global scope.
3477
3478 @menu
3479 * Simple Assignments::          Simple Assignments
3480 * HIDDEN::                      HIDDEN
3481 * PROVIDE::                     PROVIDE
3482 * PROVIDE_HIDDEN::              PROVIDE_HIDDEN
3483 * Source Code Reference::       How to use a linker script defined symbol in source code
3484 @end menu
3485
3486 @node Simple Assignments
3487 @subsection Simple Assignments
3488
3489 You may assign to a symbol using any of the C assignment operators:
3490
3491 @table @code
3492 @item @var{symbol} = @var{expression} ;
3493 @itemx @var{symbol} += @var{expression} ;
3494 @itemx @var{symbol} -= @var{expression} ;
3495 @itemx @var{symbol} *= @var{expression} ;
3496 @itemx @var{symbol} /= @var{expression} ;
3497 @itemx @var{symbol} <<= @var{expression} ;
3498 @itemx @var{symbol} >>= @var{expression} ;
3499 @itemx @var{symbol} &= @var{expression} ;
3500 @itemx @var{symbol} |= @var{expression} ;
3501 @end table
3502
3503 The first case will define @var{symbol} to the value of
3504 @var{expression}.  In the other cases, @var{symbol} must already be
3505 defined, and the value will be adjusted accordingly.
3506
3507 The special symbol name @samp{.} indicates the location counter.  You
3508 may only use this within a @code{SECTIONS} command.  @xref{Location Counter}.
3509
3510 The semicolon after @var{expression} is required.
3511
3512 Expressions are defined below; see @ref{Expressions}.
3513
3514 You may write symbol assignments as commands in their own right, or as
3515 statements within a @code{SECTIONS} command, or as part of an output
3516 section description in a @code{SECTIONS} command.
3517
3518 The section of the symbol will be set from the section of the
3519 expression; for more information, see @ref{Expression Section}.
3520
3521 Here is an example showing the three different places that symbol
3522 assignments may be used:
3523
3524 @smallexample
3525 floating_point = 0;
3526 SECTIONS
3527 @{
3528   .text :
3529     @{
3530       *(.text)
3531       _etext = .;
3532     @}
3533   _bdata = (. + 3) & ~ 3;
3534   .data : @{ *(.data) @}
3535 @}
3536 @end smallexample
3537 @noindent
3538 In this example, the symbol @samp{floating_point} will be defined as
3539 zero.  The symbol @samp{_etext} will be defined as the address following
3540 the last @samp{.text} input section.  The symbol @samp{_bdata} will be
3541 defined as the address following the @samp{.text} output section aligned
3542 upward to a 4 byte boundary.
3543
3544 @node HIDDEN
3545 @subsection HIDDEN
3546 @cindex HIDDEN
3547 For ELF targeted ports, define a symbol that will be hidden and won't be
3548 exported.  The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}.
3549
3550 Here is the example from @ref{Simple Assignments}, rewritten to use
3551 @code{HIDDEN}:
3552
3553 @smallexample
3554 HIDDEN(floating_point = 0);
3555 SECTIONS
3556 @{
3557   .text :
3558     @{
3559       *(.text)
3560       HIDDEN(_etext = .);
3561     @}
3562   HIDDEN(_bdata = (. + 3) & ~ 3);
3563   .data : @{ *(.data) @}
3564 @}
3565 @end smallexample
3566 @noindent
3567 In this case none of the three symbols will be visible outside this module.
3568
3569 @node PROVIDE
3570 @subsection PROVIDE
3571 @cindex PROVIDE
3572 In some cases, it is desirable for a linker script to define a symbol
3573 only if it is referenced and is not defined by any object included in
3574 the link.  For example, traditional linkers defined the symbol
3575 @samp{etext}.  However, ANSI C requires that the user be able to use
3576 @samp{etext} as a function name without encountering an error.  The
3577 @code{PROVIDE} keyword may be used to define a symbol, such as
3578 @samp{etext}, only if it is referenced but not defined.  The syntax is
3579 @code{PROVIDE(@var{symbol} = @var{expression})}.
3580
3581 Here is an example of using @code{PROVIDE} to define @samp{etext}:
3582 @smallexample
3583 SECTIONS
3584 @{
3585   .text :
3586     @{
3587       *(.text)
3588       _etext = .;
3589       PROVIDE(etext = .);
3590     @}
3591 @}
3592 @end smallexample
3593
3594 In this example, if the program defines @samp{_etext} (with a leading
3595 underscore), the linker will give a multiple definition error.  If, on
3596 the other hand, the program defines @samp{etext} (with no leading
3597 underscore), the linker will silently use the definition in the program.
3598 If the program references @samp{etext} but does not define it, the
3599 linker will use the definition in the linker script.
3600
3601 @node PROVIDE_HIDDEN
3602 @subsection PROVIDE_HIDDEN
3603 @cindex PROVIDE_HIDDEN
3604 Similar to @code{PROVIDE}.  For ELF targeted ports, the symbol will be
3605 hidden and won't be exported.
3606
3607 @node Source Code Reference
3608 @subsection Source Code Reference
3609
3610 Accessing a linker script defined variable from source code is not
3611 intuitive.  In particular a linker script symbol is not equivalent to
3612 a variable declaration in a high level language, it is instead a
3613 symbol that does not have a value.
3614
3615 Before going further, it is important to note that compilers often
3616 transform names in the source code into different names when they are
3617 stored in the symbol table.  For example, Fortran compilers commonly
3618 prepend or append an underscore, and C++ performs extensive @samp{name
3619 mangling}.  Therefore there might be a discrepancy between the name
3620 of a variable as it is used in source code and the name of the same
3621 variable as it is defined in a linker script.  For example in C a
3622 linker script variable might be referred to as:
3623
3624 @smallexample
3625   extern int foo;
3626 @end smallexample
3627
3628 But in the linker script it might be defined as:
3629
3630 @smallexample
3631   _foo = 1000;
3632 @end smallexample
3633
3634 In the remaining examples however it is assumed that no name
3635 transformation has taken place.
3636
3637 When a symbol is declared in a high level language such as C, two
3638 things happen.  The first is that the compiler reserves enough space
3639 in the program's memory to hold the @emph{value} of the symbol.  The
3640 second is that the compiler creates an entry in the program's symbol
3641 table which holds the symbol's @emph{address}.  ie the symbol table
3642 contains the address of the block of memory holding the symbol's
3643 value.  So for example the following C declaration, at file scope:
3644
3645 @smallexample
3646   int foo = 1000;
3647 @end smallexample
3648
3649 creates an entry called @samp{foo} in the symbol table.  This entry
3650 holds the address of an @samp{int} sized block of memory where the
3651 number 1000 is initially stored.
3652
3653 When a program references a symbol the compiler generates code that
3654 first accesses the symbol table to find the address of the symbol's
3655 memory block and then code to read the value from that memory block.
3656 So:
3657
3658 @smallexample
3659   foo = 1;
3660 @end smallexample
3661
3662 looks up the symbol @samp{foo} in the symbol table, gets the address
3663 associated with this symbol and then writes the value 1 into that
3664 address.  Whereas:
3665
3666 @smallexample
3667   int * a = & foo;
3668 @end smallexample
3669
3670 looks up the symbol @samp{foo} in the symbol table, gets its address
3671 and then copies this address into the block of memory associated with
3672 the variable @samp{a}.
3673
3674 Linker scripts symbol declarations, by contrast, create an entry in
3675 the symbol table but do not assign any memory to them.  Thus they are
3676 an address without a value.  So for example the linker script definition:
3677
3678 @smallexample
3679   foo = 1000;
3680 @end smallexample
3681
3682 creates an entry in the symbol table called @samp{foo} which holds
3683 the address of memory location 1000, but nothing special is stored at
3684 address 1000.  This means that you cannot access the @emph{value} of a
3685 linker script defined symbol - it has no value - all you can do is
3686 access the @emph{address} of a linker script defined symbol.
3687
3688 Hence when you are using a linker script defined symbol in source code
3689 you should always take the address of the symbol, and never attempt to
3690 use its value.  For example suppose you want to copy the contents of a
3691 section of memory called .ROM into a section called .FLASH and the
3692 linker script contains these declarations:
3693
3694 @smallexample
3695 @group
3696   start_of_ROM   = .ROM;
3697   end_of_ROM     = .ROM + sizeof (.ROM) - 1;
3698   start_of_FLASH = .FLASH;
3699 @end group
3700 @end smallexample
3701
3702 Then the C source code to perform the copy would be:
3703
3704 @smallexample
3705 @group
3706   extern char start_of_ROM, end_of_ROM, start_of_FLASH;
3707
3708   memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
3709 @end group
3710 @end smallexample
3711
3712 Note the use of the @samp{&} operators.  These are correct.
3713
3714 @node SECTIONS
3715 @section SECTIONS Command
3716 @kindex SECTIONS
3717 The @code{SECTIONS} command tells the linker how to map input sections
3718 into output sections, and how to place the output sections in memory.
3719
3720 The format of the @code{SECTIONS} command is:
3721 @smallexample
3722 SECTIONS
3723 @{
3724   @var{sections-command}
3725   @var{sections-command}
3726   @dots{}
3727 @}
3728 @end smallexample
3729
3730 Each @var{sections-command} may of be one of the following:
3731
3732 @itemize @bullet
3733 @item
3734 an @code{ENTRY} command (@pxref{Entry Point,,Entry command})
3735 @item
3736 a symbol assignment (@pxref{Assignments})
3737 @item
3738 an output section description
3739 @item
3740 an overlay description
3741 @end itemize
3742
3743 The @code{ENTRY} command and symbol assignments are permitted inside the
3744 @code{SECTIONS} command for convenience in using the location counter in
3745 those commands.  This can also make the linker script easier to
3746 understand because you can use those commands at meaningful points in
3747 the layout of the output file.
3748
3749 Output section descriptions and overlay descriptions are described
3750 below.
3751
3752 If you do not use a @code{SECTIONS} command in your linker script, the
3753 linker will place each input section into an identically named output
3754 section in the order that the sections are first encountered in the
3755 input files.  If all input sections are present in the first file, for
3756 example, the order of sections in the output file will match the order
3757 in the first input file.  The first section will be at address zero.
3758
3759 @menu
3760 * Output Section Description::  Output section description
3761 * Output Section Name::         Output section name
3762 * Output Section Address::      Output section address
3763 * Input Section::               Input section description
3764 * Output Section Data::         Output section data
3765 * Output Section Keywords::     Output section keywords
3766 * Output Section Discarding::   Output section discarding
3767 * Output Section Attributes::   Output section attributes
3768 * Overlay Description::         Overlay description
3769 @end menu
3770
3771 @node Output Section Description
3772 @subsection Output Section Description
3773 The full description of an output section looks like this:
3774 @smallexample
3775 @group
3776 @var{section} [@var{address}] [(@var{type})] :
3777   [AT(@var{lma})]
3778   [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT]
3779   [SUBALIGN(@var{subsection_align})]
3780   [@var{constraint}]
3781   @{
3782     @var{output-section-command}
3783     @var{output-section-command}
3784     @dots{}
3785   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
3786 @end group
3787 @end smallexample
3788
3789 Most output sections do not use most of the optional section attributes.
3790
3791 The whitespace around @var{section} is required, so that the section
3792 name is unambiguous.  The colon and the curly braces are also required.
3793 The line breaks and other white space are optional.
3794
3795 Each @var{output-section-command} may be one of the following:
3796
3797 @itemize @bullet
3798 @item
3799 a symbol assignment (@pxref{Assignments})
3800 @item
3801 an input section description (@pxref{Input Section})
3802 @item
3803 data values to include directly (@pxref{Output Section Data})
3804 @item
3805 a special output section keyword (@pxref{Output Section Keywords})
3806 @end itemize
3807
3808 @node Output Section Name
3809 @subsection Output Section Name
3810 @cindex name, section
3811 @cindex section name
3812 The name of the output section is @var{section}.  @var{section} must
3813 meet the constraints of your output format.  In formats which only
3814 support a limited number of sections, such as @code{a.out}, the name
3815 must be one of the names supported by the format (@code{a.out}, for
3816 example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the
3817 output format supports any number of sections, but with numbers and not
3818 names (as is the case for Oasys), the name should be supplied as a
3819 quoted numeric string.  A section name may consist of any sequence of
3820 characters, but a name which contains any unusual characters such as
3821 commas must be quoted.
3822
3823 The output section name @samp{/DISCARD/} is special; @ref{Output Section
3824 Discarding}.
3825
3826 @node Output Section Address
3827 @subsection Output Section Address
3828 @cindex address, section
3829 @cindex section address
3830 The @var{address} is an expression for the VMA (the virtual memory
3831 address) of the output section.  This address is optional, but if it
3832 is provided then the output address will be set exactly as specified.
3833
3834 If the output address is not specified then one will be chosen for the
3835 section, based on the heuristic below.  This address will be adjusted
3836 to fit the alignment requirement of the output section.  The
3837 alignment requirement is the strictest alignment of any input section
3838 contained within the output section.
3839
3840 The output section address heuristic is as follows:
3841
3842 @itemize @bullet
3843 @item
3844 If an output memory @var{region} is set for the section then it
3845 is added to this region and its address will be the next free address
3846 in that region.
3847
3848 @item
3849 If the MEMORY command has been used to create a list of memory
3850 regions then the first region which has attributes compatible with the
3851 section is selected to contain it.  The section's output address will
3852 be the next free address in that region; @ref{MEMORY}.
3853
3854 @item
3855 If no memory regions were specified, or none match the section then
3856 the output address will be based on the current value of the location
3857 counter.
3858 @end itemize
3859
3860 @noindent
3861 For example:
3862
3863 @smallexample
3864 .text . : @{ *(.text) @}
3865 @end smallexample
3866
3867 @noindent
3868 and
3869
3870 @smallexample
3871 .text : @{ *(.text) @}
3872 @end smallexample
3873
3874 @noindent
3875 are subtly different.  The first will set the address of the
3876 @samp{.text} output section to the current value of the location
3877 counter.  The second will set it to the current value of the location
3878 counter aligned to the strictest alignment of any of the @samp{.text}
3879 input sections.
3880
3881 The @var{address} may be an arbitrary expression; @ref{Expressions}.
3882 For example, if you want to align the section on a 0x10 byte boundary,
3883 so that the lowest four bits of the section address are zero, you could
3884 do something like this:
3885 @smallexample
3886 .text ALIGN(0x10) : @{ *(.text) @}
3887 @end smallexample
3888 @noindent
3889 This works because @code{ALIGN} returns the current location counter
3890 aligned upward to the specified value.
3891
3892 Specifying @var{address} for a section will change the value of the
3893 location counter, provided that the section is non-empty.  (Empty
3894 sections are ignored).
3895
3896 @node Input Section
3897 @subsection Input Section Description
3898 @cindex input sections
3899 @cindex mapping input sections to output sections
3900 The most common output section command is an input section description.
3901
3902 The input section description is the most basic linker script operation.
3903 You use output sections to tell the linker how to lay out your program
3904 in memory.  You use input section descriptions to tell the linker how to
3905 map the input files into your memory layout.
3906
3907 @menu
3908 * Input Section Basics::        Input section basics
3909 * Input Section Wildcards::     Input section wildcard patterns
3910 * Input Section Common::        Input section for common symbols
3911 * Input Section Keep::          Input section and garbage collection
3912 * Input Section Example::       Input section example
3913 @end menu
3914
3915 @node Input Section Basics
3916 @subsubsection Input Section Basics
3917 @cindex input section basics
3918 An input section description consists of a file name optionally followed
3919 by a list of section names in parentheses.
3920
3921 The file name and the section name may be wildcard patterns, which we
3922 describe further below (@pxref{Input Section Wildcards}).
3923
3924 The most common input section description is to include all input
3925 sections with a particular name in the output section.  For example, to
3926 include all input @samp{.text} sections, you would write:
3927 @smallexample
3928 *(.text)
3929 @end smallexample
3930 @noindent
3931 Here the @samp{*} is a wildcard which matches any file name.  To exclude a list
3932 of files from matching the file name wildcard, EXCLUDE_FILE may be used to
3933 match all files except the ones specified in the EXCLUDE_FILE list.  For
3934 example:
3935 @smallexample
3936 *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)
3937 @end smallexample
3938 will cause all .ctors sections from all files except @file{crtend.o} and
3939 @file{otherfile.o} to be included.
3940
3941 There are two ways to include more than one section:
3942 @smallexample
3943 *(.text .rdata)
3944 *(.text) *(.rdata)
3945 @end smallexample
3946 @noindent
3947 The difference between these is the order in which the @samp{.text} and
3948 @samp{.rdata} input sections will appear in the output section.  In the
3949 first example, they will be intermingled, appearing in the same order as
3950 they are found in the linker input.  In the second example, all
3951 @samp{.text} input sections will appear first, followed by all
3952 @samp{.rdata} input sections.
3953
3954 You can specify a file name to include sections from a particular file.
3955 You would do this if one or more of your files contain special data that
3956 needs to be at a particular location in memory.  For example:
3957 @smallexample
3958 data.o(.data)
3959 @end smallexample
3960
3961 To refine the sections that are included based on the section flags
3962 of an input section, INPUT_SECTION_FLAGS may be used.
3963
3964 Here is a simple example for using Section header flags for ELF sections:
3965
3966 @smallexample
3967 @group
3968 SECTIONS @{
3969   .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @}
3970   .text2 :  @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @}
3971 @}
3972 @end group
3973 @end smallexample
3974
3975 In this example, the output section @samp{.text} will be comprised of any
3976 input section matching the name *(.text) whose section header flags
3977 @code{SHF_MERGE} and @code{SHF_STRINGS} are set.  The output section
3978 @samp{.text2} will be comprised of any input section matching the name *(.text)
3979 whose section header flag @code{SHF_WRITE} is clear.
3980
3981 You can also specify files within archives by writing a pattern
3982 matching the archive, a colon, then the pattern matching the file,
3983 with no whitespace around the colon.
3984
3985 @table @samp
3986 @item archive:file
3987 matches file within archive
3988 @item archive:
3989 matches the whole archive
3990 @item :file
3991 matches file but not one in an archive
3992 @end table
3993
3994 Either one or both of @samp{archive} and @samp{file} can contain shell
3995 wildcards.  On DOS based file systems, the linker will assume that a
3996 single letter followed by a colon is a drive specifier, so
3997 @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o}
3998 within an archive called @samp{c}.  @samp{archive:file} filespecs may
3999 also be used within an @code{EXCLUDE_FILE} list, but may not appear in
4000 other linker script contexts.  For instance, you cannot extract a file
4001 from an archive by using @samp{archive:file} in an @code{INPUT}
4002 command.
4003
4004 If you use a file name without a list of sections, then all sections in
4005 the input file will be included in the output section.  This is not
4006 commonly done, but it may by useful on occasion.  For example:
4007 @smallexample
4008 data.o
4009 @end smallexample
4010
4011 When you use a file name which is not an @samp{archive:file} specifier
4012 and does not contain any wild card
4013 characters, the linker will first see if you also specified the file
4014 name on the linker command line or in an @code{INPUT} command.  If you
4015 did not, the linker will attempt to open the file as an input file, as
4016 though it appeared on the command line.  Note that this differs from an
4017 @code{INPUT} command, because the linker will not search for the file in
4018 the archive search path.
4019
4020 @node Input Section Wildcards
4021 @subsubsection Input Section Wildcard Patterns
4022 @cindex input section wildcards
4023 @cindex wildcard file name patterns
4024 @cindex file name wildcard patterns
4025 @cindex section name wildcard patterns
4026 In an input section description, either the file name or the section
4027 name or both may be wildcard patterns.
4028
4029 The file name of @samp{*} seen in many examples is a simple wildcard
4030 pattern for the file name.
4031
4032 The wildcard patterns are like those used by the Unix shell.
4033
4034 @table @samp
4035 @item *
4036 matches any number of characters
4037 @item ?
4038 matches any single character
4039 @item [@var{chars}]
4040 matches a single instance of any of the @var{chars}; the @samp{-}
4041 character may be used to specify a range of characters, as in
4042 @samp{[a-z]} to match any lower case letter
4043 @item \
4044 quotes the following character
4045 @end table
4046
4047 When a file name is matched with a wildcard, the wildcard characters
4048 will not match a @samp{/} character (used to separate directory names on
4049 Unix).  A pattern consisting of a single @samp{*} character is an
4050 exception; it will always match any file name, whether it contains a
4051 @samp{/} or not.  In a section name, the wildcard characters will match
4052 a @samp{/} character.
4053
4054 File name wildcard patterns only match files which are explicitly
4055 specified on the command line or in an @code{INPUT} command.  The linker
4056 does not search directories to expand wildcards.
4057
4058 If a file name matches more than one wildcard pattern, or if a file name
4059 appears explicitly and is also matched by a wildcard pattern, the linker
4060 will use the first match in the linker script.  For example, this
4061 sequence of input section descriptions is probably in error, because the
4062 @file{data.o} rule will not be used:
4063 @smallexample
4064 .data : @{ *(.data) @}
4065 .data1 : @{ data.o(.data) @}
4066 @end smallexample
4067
4068 @cindex SORT_BY_NAME
4069 Normally, the linker will place files and sections matched by wildcards
4070 in the order in which they are seen during the link.  You can change
4071 this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard
4072 pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}).  When the
4073 @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections
4074 into ascending order by name before placing them in the output file.
4075
4076 @cindex SORT_BY_ALIGNMENT
4077 @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The
4078 difference is @code{SORT_BY_ALIGNMENT} will sort sections into
4079 descending order by alignment before placing them in the output file.
4080 Larger alignments are placed before smaller alignments in order to
4081 reduce the amount of padding necessary.
4082
4083 @cindex SORT_BY_INIT_PRIORITY
4084 @code{SORT_BY_INIT_PRIORITY} is very similar to @code{SORT_BY_NAME}. The
4085 difference is @code{SORT_BY_INIT_PRIORITY} will sort sections into
4086 ascending order by numerical value of the GCC init_priority attribute
4087 encoded in the section name before placing them in the output file.
4088
4089 @cindex SORT
4090 @code{SORT} is an alias for @code{SORT_BY_NAME}.
4091
4092 When there are nested section sorting commands in linker script, there
4093 can be at most 1 level of nesting for section sorting commands.
4094
4095 @enumerate
4096 @item
4097 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4098 It will sort the input sections by name first, then by alignment if two
4099 sections have the same name.
4100 @item
4101 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4102 It will sort the input sections by alignment first, then by name if two
4103 sections have the same alignment.
4104 @item
4105 @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is
4106 treated the same as @code{SORT_BY_NAME} (wildcard section pattern).
4107 @item
4108 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern))
4109 is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern).
4110 @item
4111 All other nested section sorting commands are invalid.
4112 @end enumerate
4113
4114 When both command line section sorting option and linker script
4115 section sorting command are used, section sorting command always
4116 takes precedence over the command line option.
4117
4118 If the section sorting command in linker script isn't nested, the
4119 command line option will make the section sorting command to be
4120 treated as nested sorting command.
4121
4122 @enumerate
4123 @item
4124 @code{SORT_BY_NAME} (wildcard section pattern ) with
4125 @option{--sort-sections alignment} is equivalent to
4126 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4127 @item
4128 @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with
4129 @option{--sort-section name} is equivalent to
4130 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4131 @end enumerate
4132
4133 If the section sorting command in linker script is nested, the
4134 command line option will be ignored.
4135
4136 @cindex SORT_NONE
4137 @code{SORT_NONE} disables section sorting by ignoring the command line
4138 section sorting option.
4139
4140 If you ever get confused about where input sections are going, use the
4141 @samp{-M} linker option to generate a map file.  The map file shows
4142 precisely how input sections are mapped to output sections.
4143
4144 This example shows how wildcard patterns might be used to partition
4145 files.  This linker script directs the linker to place all @samp{.text}
4146 sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}.
4147 The linker will place the @samp{.data} section from all files beginning
4148 with an upper case character in @samp{.DATA}; for all other files, the
4149 linker will place the @samp{.data} section in @samp{.data}.
4150 @smallexample
4151 @group
4152 SECTIONS @{
4153   .text : @{ *(.text) @}
4154   .DATA : @{ [A-Z]*(.data) @}
4155   .data : @{ *(.data) @}
4156   .bss : @{ *(.bss) @}
4157 @}
4158 @end group
4159 @end smallexample
4160
4161 @node Input Section Common
4162 @subsubsection Input Section for Common Symbols
4163 @cindex common symbol placement
4164 @cindex uninitialized data placement
4165 A special notation is needed for common symbols, because in many object
4166 file formats common symbols do not have a particular input section.  The
4167 linker treats common symbols as though they are in an input section
4168 named @samp{COMMON}.
4169
4170 You may use file names with the @samp{COMMON} section just as with any
4171 other input sections.  You can use this to place common symbols from a
4172 particular input file in one section while common symbols from other
4173 input files are placed in another section.
4174
4175 In most cases, common symbols in input files will be placed in the
4176 @samp{.bss} section in the output file.  For example:
4177 @smallexample
4178 .bss @{ *(.bss) *(COMMON) @}
4179 @end smallexample
4180
4181 @cindex scommon section
4182 @cindex small common symbols
4183 Some object file formats have more than one type of common symbol.  For
4184 example, the MIPS ELF object file format distinguishes standard common
4185 symbols and small common symbols.  In this case, the linker will use a
4186 different special section name for other types of common symbols.  In
4187 the case of MIPS ELF, the linker uses @samp{COMMON} for standard common
4188 symbols and @samp{.scommon} for small common symbols.  This permits you
4189 to map the different types of common symbols into memory at different
4190 locations.
4191
4192 @cindex [COMMON]
4193 You will sometimes see @samp{[COMMON]} in old linker scripts.  This
4194 notation is now considered obsolete.  It is equivalent to
4195 @samp{*(COMMON)}.
4196
4197 @node Input Section Keep
4198 @subsubsection Input Section and Garbage Collection
4199 @cindex KEEP
4200 @cindex garbage collection
4201 When link-time garbage collection is in use (@samp{--gc-sections}),
4202 it is often useful to mark sections that should not be eliminated.
4203 This is accomplished by surrounding an input section's wildcard entry
4204 with @code{KEEP()}, as in @code{KEEP(*(.init))} or
4205 @code{KEEP(SORT_BY_NAME(*)(.ctors))}.
4206
4207 @node Input Section Example
4208 @subsubsection Input Section Example
4209 The following example is a complete linker script.  It tells the linker
4210 to read all of the sections from file @file{all.o} and place them at the
4211 start of output section @samp{outputa} which starts at location
4212 @samp{0x10000}.  All of section @samp{.input1} from file @file{foo.o}
4213 follows immediately, in the same output section.  All of section
4214 @samp{.input2} from @file{foo.o} goes into output section
4215 @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}.
4216 All of the remaining @samp{.input1} and @samp{.input2} sections from any
4217 files are written to output section @samp{outputc}.
4218
4219 @smallexample
4220 @group
4221 SECTIONS @{
4222   outputa 0x10000 :
4223     @{
4224     all.o
4225     foo.o (.input1)
4226     @}
4227 @end group
4228 @group
4229   outputb :
4230     @{
4231     foo.o (.input2)
4232     foo1.o (.input1)
4233     @}
4234 @end group
4235 @group
4236   outputc :
4237     @{
4238     *(.input1)
4239     *(.input2)
4240     @}
4241 @}
4242 @end group
4243 @end smallexample
4244
4245 @node Output Section Data
4246 @subsection Output Section Data
4247 @cindex data
4248 @cindex section data
4249 @cindex output section data
4250 @kindex BYTE(@var{expression})
4251 @kindex SHORT(@var{expression})
4252 @kindex LONG(@var{expression})
4253 @kindex QUAD(@var{expression})
4254 @kindex SQUAD(@var{expression})
4255 You can include explicit bytes of data in an output section by using
4256 @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as
4257 an output section command.  Each keyword is followed by an expression in
4258 parentheses providing the value to store (@pxref{Expressions}).  The
4259 value of the expression is stored at the current value of the location
4260 counter.