Merge branch 'vendor/GCC44'
[dragonfly.git] / contrib / binutils-2.21 / ld / ld.texinfo
1 \input texinfo
2 @setfilename ld.info
3 @c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 @c 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 @c Free Software Foundation, Inc.
6 @syncodeindex ky cp
7 @c man begin INCLUDE
8 @include configdoc.texi
9 @c (configdoc.texi is generated by the Makefile)
10 @include bfdver.texi
11 @c man end
12
13 @c @smallbook
14
15 @macro gcctabopt{body}
16 @code{\body\}
17 @end macro
18
19 @c man begin NAME
20 @ifset man
21 @c Configure for the generation of man pages
22 @set UsesEnvVars
23 @set GENERIC
24 @set ARM
25 @set H8300
26 @set HPPA
27 @set I960
28 @set M68HC11
29 @set M68K
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, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
57 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
58
59 Permission is granted to copy, distribute and/or modify this document
60 under the terms of the GNU Free Documentation License, Version 1.3
61 or any later version published by the Free Software Foundation;
62 with no Invariant Sections, with no Front-Cover Texts, and with no
63 Back-Cover Texts.  A copy of the license is included in the
64 section entitled ``GNU Free Documentation License''.
65 @end copying
66 @iftex
67 @finalout
68 @setchapternewpage odd
69 @settitle The GNU linker
70 @titlepage
71 @title The GNU linker
72 @sp 1
73 @subtitle @code{ld}
74 @ifset VERSION_PACKAGE
75 @subtitle @value{VERSION_PACKAGE}
76 @end ifset
77 @subtitle Version @value{VERSION}
78 @author Steve Chamberlain
79 @author Ian Lance Taylor
80 @page
81
82 @tex
83 {\parskip=0pt
84 \hfill Red Hat Inc\par
85 \hfill nickc\@credhat.com, doc\@redhat.com\par
86 \hfill {\it The GNU linker}\par
87 \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par
88 }
89 \global\parindent=0pt % Steve likes it this way.
90 @end tex
91
92 @vskip 0pt plus 1filll
93 @c man begin COPYRIGHT
94 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
95 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free
96 Software Foundation, Inc.
97
98 Permission is granted to copy, distribute and/or modify this document
99 under the terms of the GNU Free Documentation License, Version 1.3
100 or any later version published by the Free Software Foundation;
101 with no Invariant Sections, with no Front-Cover Texts, and with no
102 Back-Cover Texts.  A copy of the license is included in the
103 section entitled ``GNU Free Documentation License''.
104 @c man end
105
106 @end titlepage
107 @end iftex
108 @contents
109 @c FIXME: Talk about importance of *order* of args, cmds to linker!
110
111 @ifnottex
112 @node Top
113 @top LD
114 This file documents the @sc{gnu} linker ld
115 @ifset VERSION_PACKAGE
116 @value{VERSION_PACKAGE}
117 @end ifset
118 version @value{VERSION}.
119
120 This document is distributed under the terms of the GNU Free
121 Documentation License version 1.3.  A copy of the license is included
122 in the section entitled ``GNU Free Documentation License''.
123
124 @menu
125 * Overview::                    Overview
126 * Invocation::                  Invocation
127 * Scripts::                     Linker Scripts
128 @ifset GENERIC
129 * Machine Dependent::           Machine Dependent Features
130 @end ifset
131 @ifclear GENERIC
132 @ifset H8300
133 * H8/300::                      ld and the H8/300
134 @end ifset
135 @ifset Renesas
136 * Renesas::                     ld and other Renesas micros
137 @end ifset
138 @ifset I960
139 * i960::                        ld and the Intel 960 family
140 @end ifset
141 @ifset ARM
142 * ARM::                         ld and the ARM family
143 @end ifset
144 @ifset HPPA
145 * HPPA ELF32::                  ld and HPPA 32-bit ELF
146 @end ifset
147 @ifset M68HC11
148 * M68HC11/68HC12::              ld and the Motorola 68HC11 and 68HC12 families
149 @end ifset
150 @ifset M68K
151 * M68K::                        ld and Motorola 68K 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 ECOFF which supports 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 initfirst
1027 This option is only meaningful when building a shared object.
1028 It marks the object so that its runtime initialization will occur
1029 before the runtime initialization of any other objects brought into
1030 the process at the same time.  Similarly the runtime finalization of
1031 the object will occur after the runtime finalization of any other
1032 objects.
1033
1034 @item interpose
1035 Marks the object that its symbol table interposes before all symbols
1036 but the primary executable.
1037
1038 @item lazy
1039 When generating an executable or shared library, mark it to tell the
1040 dynamic linker to defer function call resolution to the point when
1041 the function is called (lazy binding), rather than at load time.
1042 Lazy binding is the default.
1043
1044 @item loadfltr
1045 Marks  the object that its filters be processed immediately at
1046 runtime.
1047
1048 @item muldefs
1049 Allows multiple definitions.
1050
1051 @item nocombreloc
1052 Disables multiple reloc sections combining.
1053
1054 @item nocopyreloc
1055 Disables production of copy relocs.
1056
1057 @item nodefaultlib
1058 Marks the object that the search for dependencies of this object will
1059 ignore any default library search paths.
1060
1061 @item nodelete
1062 Marks the object shouldn't be unloaded at runtime.
1063
1064 @item nodlopen
1065 Marks the object not available to @code{dlopen}.
1066
1067 @item nodump
1068 Marks the object can not be dumped by @code{dldump}.
1069
1070 @item noexecstack
1071 Marks the object as not requiring executable stack.
1072
1073 @item norelro
1074 Don't create an ELF @code{PT_GNU_RELRO} segment header in the object.
1075
1076 @item now
1077 When generating an executable or shared library, mark it to tell the
1078 dynamic linker to resolve all symbols when the program is started, or
1079 when the shared library is linked to using dlopen, instead of
1080 deferring function call resolution to the point when the function is
1081 first called.
1082
1083 @item origin
1084 Marks the object may contain $ORIGIN.
1085
1086 @item relro
1087 Create an ELF @code{PT_GNU_RELRO} segment header in the object.
1088
1089 @item max-page-size=@var{value}
1090 Set the emulation maximum page size to @var{value}.
1091
1092 @item common-page-size=@var{value}
1093 Set the emulation common page size to @var{value}.
1094
1095 @end table
1096
1097 Other keywords are ignored for Solaris compatibility.
1098
1099 @kindex -(
1100 @cindex groups of archives
1101 @item -( @var{archives} -)
1102 @itemx --start-group @var{archives} --end-group
1103 The @var{archives} should be a list of archive files.  They may be
1104 either explicit file names, or @samp{-l} options.
1105
1106 The specified archives are searched repeatedly until no new undefined
1107 references are created.  Normally, an archive is searched only once in
1108 the order that it is specified on the command line.  If a symbol in that
1109 archive is needed to resolve an undefined symbol referred to by an
1110 object in an archive that appears later on the command line, the linker
1111 would not be able to resolve that reference.  By grouping the archives,
1112 they all be searched repeatedly until all possible references are
1113 resolved.
1114
1115 Using this option has a significant performance cost.  It is best to use
1116 it only when there are unavoidable circular references between two or
1117 more archives.
1118
1119 @kindex --accept-unknown-input-arch
1120 @kindex --no-accept-unknown-input-arch
1121 @item --accept-unknown-input-arch
1122 @itemx --no-accept-unknown-input-arch
1123 Tells the linker to accept input files whose architecture cannot be
1124 recognised.  The assumption is that the user knows what they are doing
1125 and deliberately wants to link in these unknown input files.  This was
1126 the default behaviour of the linker, before release 2.14.  The default
1127 behaviour from release 2.14 onwards is to reject such input files, and
1128 so the @samp{--accept-unknown-input-arch} option has been added to
1129 restore the old behaviour.
1130
1131 @kindex --as-needed
1132 @kindex --no-as-needed
1133 @item --as-needed
1134 @itemx --no-as-needed
1135 This option affects ELF DT_NEEDED tags for dynamic libraries mentioned
1136 on the command line after the @option{--as-needed} option.  Normally
1137 the linker will add a DT_NEEDED tag for each dynamic library mentioned
1138 on the command line, regardless of whether the library is actually
1139 needed or not.  @option{--as-needed} causes a DT_NEEDED tag to only be
1140 emitted for a library that satisfies an undefined symbol reference
1141 from a regular object file or, if the library is not found in the
1142 DT_NEEDED lists of other libraries linked up to that point, an
1143 undefined symbol reference from another dynamic library.
1144 @option{--no-as-needed} restores the default behaviour.
1145
1146 @kindex --add-needed
1147 @kindex --no-add-needed
1148 @item --add-needed
1149 @itemx --no-add-needed
1150 These two options have been deprecated because of the similarity of
1151 their names to the @option{--as-needed} and @option{--no-as-needed}
1152 options.  They have been replaced by @option{--copy-dt-needed-entries}
1153 and @option{--no-copy-dt-needed-entries}.
1154
1155 @kindex -assert @var{keyword}
1156 @item -assert @var{keyword}
1157 This option is ignored for SunOS compatibility.
1158
1159 @kindex -Bdynamic
1160 @kindex -dy
1161 @kindex -call_shared
1162 @item -Bdynamic
1163 @itemx -dy
1164 @itemx -call_shared
1165 Link against dynamic libraries.  This is only meaningful on platforms
1166 for which shared libraries are supported.  This option is normally the
1167 default on such platforms.  The different variants of this option are
1168 for compatibility with various systems.  You may use this option
1169 multiple times on the command line: it affects library searching for
1170 @option{-l} options which follow it.
1171
1172 @kindex -Bgroup
1173 @item -Bgroup
1174 Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic
1175 section.  This causes the runtime linker to handle lookups in this
1176 object and its dependencies to be performed only inside the group.
1177 @option{--unresolved-symbols=report-all} is implied.  This option is
1178 only meaningful on ELF platforms which support shared libraries.
1179
1180 @kindex -Bstatic
1181 @kindex -dn
1182 @kindex -non_shared
1183 @kindex -static
1184 @item -Bstatic
1185 @itemx -dn
1186 @itemx -non_shared
1187 @itemx -static
1188 Do not link against shared libraries.  This is only meaningful on
1189 platforms for which shared libraries are supported.  The different
1190 variants of this option are for compatibility with various systems.  You
1191 may use this option multiple times on the command line: it affects
1192 library searching for @option{-l} options which follow it.  This
1193 option also implies @option{--unresolved-symbols=report-all}.  This
1194 option can be used with @option{-shared}.  Doing so means that a
1195 shared library is being created but that all of the library's external
1196 references must be resolved by pulling in entries from static
1197 libraries.
1198
1199 @kindex -Bsymbolic
1200 @item -Bsymbolic
1201 When creating a shared library, bind references to global symbols to the
1202 definition within the shared library, if any.  Normally, it is possible
1203 for a program linked against a shared library to override the definition
1204 within the shared library.  This option is only meaningful on ELF
1205 platforms which support shared libraries.
1206
1207 @kindex -Bsymbolic-functions
1208 @item -Bsymbolic-functions
1209 When creating a shared library, bind references to global function
1210 symbols to the definition within the shared library, if any.
1211 This option is only meaningful on ELF platforms which support shared
1212 libraries.
1213
1214 @kindex --dynamic-list=@var{dynamic-list-file}
1215 @item --dynamic-list=@var{dynamic-list-file}
1216 Specify the name of a dynamic list file to the linker.  This is
1217 typically used when creating shared libraries to specify a list of
1218 global symbols whose references shouldn't be bound to the definition
1219 within the shared library, or creating dynamically linked executables
1220 to specify a list of symbols which should be added to the symbol table
1221 in the executable.  This option is only meaningful on ELF platforms
1222 which support shared libraries.
1223
1224 The format of the dynamic list is the same as the version node without
1225 scope and node name.  See @ref{VERSION} for more information.
1226
1227 @kindex --dynamic-list-data
1228 @item --dynamic-list-data
1229 Include all global data symbols to the dynamic list.
1230
1231 @kindex --dynamic-list-cpp-new
1232 @item --dynamic-list-cpp-new
1233 Provide the builtin dynamic list for C++ operator new and delete.  It
1234 is mainly useful for building shared libstdc++.
1235
1236 @kindex --dynamic-list-cpp-typeinfo
1237 @item --dynamic-list-cpp-typeinfo
1238 Provide the builtin dynamic list for C++ runtime type identification.
1239
1240 @kindex --check-sections
1241 @kindex --no-check-sections
1242 @item --check-sections
1243 @itemx --no-check-sections
1244 Asks the linker @emph{not} to check section addresses after they have
1245 been assigned to see if there are any overlaps.  Normally the linker will
1246 perform this check, and if it finds any overlaps it will produce
1247 suitable error messages.  The linker does know about, and does make
1248 allowances for sections in overlays.  The default behaviour can be
1249 restored by using the command line switch @option{--check-sections}.
1250 Section overlap is not usually checked for relocatable links.  You can
1251 force checking in that case by using the @option{--check-sections}
1252 option.
1253
1254 @kindex --copy-dt-needed-entries
1255 @kindex --no-copy-dt-needed-entries
1256 @item --copy-dt-needed-entries
1257 @itemx --no-copy-dt-needed-entries
1258 This option affects the treatment of dynamic libraries referred to 
1259 by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the
1260 command line.  Normally the linker will add a DT_NEEDED tag to the
1261 output binary for each library mentioned in a DT_NEEDED tag in an
1262 input dynamic library.  With @option{--no-copy-dt-needed-entries}
1263 specified on the command line however any dynamic libraries that
1264 follow it will have their DT_NEEDED entries ignored.  The default
1265 behaviour can be restored with @option{--copy-dt-needed-entries}.
1266
1267 This option also has an effect on the resolution of symbols in dynamic
1268 libraries.  With the default setting dynamic libraries mentioned on
1269 the command line will be recursively searched, following their
1270 DT_NEEDED tags to other libraries, in order to resolve symbols
1271 required by the output binary.  With
1272 @option{--no-copy-dt-needed-entries} specified however the searching
1273 of dynamic libraries that follow it will stop with the dynamic
1274 library itself.  No DT_NEEDED links will be traversed to resolve
1275 symbols.
1276
1277 @cindex cross reference table
1278 @kindex --cref
1279 @item --cref
1280 Output a cross reference table.  If a linker map file is being
1281 generated, the cross reference table is printed to the map file.
1282 Otherwise, it is printed on the standard output.
1283
1284 The format of the table is intentionally simple, so that it may be
1285 easily processed by a script if necessary.  The symbols are printed out,
1286 sorted by name.  For each symbol, a list of file names is given.  If the
1287 symbol is defined, the first file listed is the location of the
1288 definition.  The remaining files contain references to the symbol.
1289
1290 @cindex common allocation
1291 @kindex --no-define-common
1292 @item --no-define-common
1293 This option inhibits the assignment of addresses to common symbols.
1294 The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect.
1295 @xref{Miscellaneous Commands}.
1296
1297 The @samp{--no-define-common} option allows decoupling
1298 the decision to assign addresses to Common symbols from the choice
1299 of the output file type; otherwise a non-Relocatable output type
1300 forces assigning addresses to Common symbols.
1301 Using @samp{--no-define-common} allows Common symbols that are referenced
1302 from a shared library to be assigned addresses only in the main program.
1303 This eliminates the unused duplicate space in the shared library,
1304 and also prevents any possible confusion over resolving to the wrong
1305 duplicate when there are many dynamic modules with specialized search
1306 paths for runtime symbol resolution.
1307
1308 @cindex symbols, from command line
1309 @kindex --defsym=@var{symbol}=@var{exp}
1310 @item --defsym=@var{symbol}=@var{expression}
1311 Create a global symbol in the output file, containing the absolute
1312 address given by @var{expression}.  You may use this option as many
1313 times as necessary to define multiple symbols in the command line.  A
1314 limited form of arithmetic is supported for the @var{expression} in this
1315 context: you may give a hexadecimal constant or the name of an existing
1316 symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
1317 constants or symbols.  If you need more elaborate expressions, consider
1318 using the linker command language from a script (@pxref{Assignments,,
1319 Assignment: Symbol Definitions}).  @emph{Note:} there should be no white
1320 space between @var{symbol}, the equals sign (``@key{=}''), and
1321 @var{expression}.
1322
1323 @cindex demangling, from command line
1324 @kindex --demangle[=@var{style}]
1325 @kindex --no-demangle
1326 @item --demangle[=@var{style}]
1327 @itemx --no-demangle
1328 These options control whether to demangle symbol names in error messages
1329 and other output.  When the linker is told to demangle, it tries to
1330 present symbol names in a readable fashion: it strips leading
1331 underscores if they are used by the object file format, and converts C++
1332 mangled symbol names into user readable names.  Different compilers have
1333 different mangling styles.  The optional demangling style argument can be used
1334 to choose an appropriate demangling style for your compiler.  The linker will
1335 demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE}
1336 is set.  These options may be used to override the default.
1337
1338 @cindex dynamic linker, from command line
1339 @kindex -I@var{file}
1340 @kindex --dynamic-linker=@var{file}
1341 @item -I@var{file}
1342 @itemx --dynamic-linker=@var{file}
1343 Set the name of the dynamic linker.  This is only meaningful when
1344 generating dynamically linked ELF executables.  The default dynamic
1345 linker is normally correct; don't use this unless you know what you are
1346 doing.
1347
1348 @kindex --fatal-warnings
1349 @kindex --no-fatal-warnings
1350 @item --fatal-warnings
1351 @itemx --no-fatal-warnings
1352 Treat all warnings as errors.  The default behaviour can be restored
1353 with the option @option{--no-fatal-warnings}.
1354
1355 @kindex --force-exe-suffix
1356 @item  --force-exe-suffix
1357 Make sure that an output file has a .exe suffix.
1358
1359 If a successfully built fully linked output file does not have a
1360 @code{.exe} or @code{.dll} suffix, this option forces the linker to copy
1361 the output file to one of the same name with a @code{.exe} suffix. This
1362 option is useful when using unmodified Unix makefiles on a Microsoft
1363 Windows host, since some versions of Windows won't run an image unless
1364 it ends in a @code{.exe} suffix.
1365
1366 @kindex --gc-sections
1367 @kindex --no-gc-sections
1368 @cindex garbage collection
1369 @item --gc-sections
1370 @itemx --no-gc-sections
1371 Enable garbage collection of unused input sections.  It is ignored on
1372 targets that do not support this option.  The default behaviour (of not
1373 performing this garbage collection) can be restored by specifying
1374 @samp{--no-gc-sections} on the command line.
1375
1376 @samp{--gc-sections} decides which input sections are used by
1377 examining symbols and relocations.  The section containing the entry
1378 symbol and all sections containing symbols undefined on the
1379 command-line will be kept, as will sections containing symbols
1380 referenced by dynamic objects.  Note that when building shared
1381 libraries, the linker must assume that any visible symbol is
1382 referenced.  Once this initial set of sections has been determined,
1383 the linker recursively marks as used any section referenced by their
1384 relocations.  See @samp{--entry} and @samp{--undefined}.
1385
1386 This option can be set when doing a partial link (enabled with option
1387 @samp{-r}).  In this case the root of symbols kept must be explicitly 
1388 specified either by an @samp{--entry} or @samp{--undefined} option or by
1389 a @code{ENTRY} command in the linker script.
1390
1391 @kindex --print-gc-sections
1392 @kindex --no-print-gc-sections
1393 @cindex garbage collection
1394 @item --print-gc-sections
1395 @itemx --no-print-gc-sections
1396 List all sections removed by garbage collection.  The listing is
1397 printed on stderr.  This option is only effective if garbage
1398 collection has been enabled via the @samp{--gc-sections}) option.  The
1399 default behaviour (of not listing the sections that are removed) can
1400 be restored by specifying @samp{--no-print-gc-sections} on the command
1401 line.
1402
1403 @cindex help
1404 @cindex usage
1405 @kindex --help
1406 @item --help
1407 Print a summary of the command-line options on the standard output and exit.
1408
1409 @kindex --target-help
1410 @item --target-help
1411 Print a summary of all target specific options on the standard output and exit.
1412
1413 @kindex -Map=@var{mapfile}
1414 @item -Map=@var{mapfile}
1415 Print a link map to the file @var{mapfile}.  See the description of the
1416 @option{-M} option, above.
1417
1418 @cindex memory usage
1419 @kindex --no-keep-memory
1420 @item --no-keep-memory
1421 @command{ld} normally optimizes for speed over memory usage by caching the
1422 symbol tables of input files in memory.  This option tells @command{ld} to
1423 instead optimize for memory usage, by rereading the symbol tables as
1424 necessary.  This may be required if @command{ld} runs out of memory space
1425 while linking a large executable.
1426
1427 @kindex --no-undefined
1428 @kindex -z defs
1429 @item --no-undefined
1430 @itemx -z defs
1431 Report unresolved symbol references from regular object files.  This
1432 is done even if the linker is creating a non-symbolic shared library.
1433 The switch @option{--[no-]allow-shlib-undefined} controls the
1434 behaviour for reporting unresolved references found in shared
1435 libraries being linked in.
1436
1437 @kindex --allow-multiple-definition
1438 @kindex -z muldefs
1439 @item --allow-multiple-definition
1440 @itemx -z muldefs
1441 Normally when a symbol is defined multiple times, the linker will
1442 report a fatal error. These options allow multiple definitions and the
1443 first definition will be used.
1444
1445 @kindex --allow-shlib-undefined
1446 @kindex --no-allow-shlib-undefined
1447 @item --allow-shlib-undefined
1448 @itemx --no-allow-shlib-undefined
1449 Allows or disallows undefined symbols in shared libraries.
1450 This switch is similar to @option{--no-undefined} except that it
1451 determines the behaviour when the undefined symbols are in a
1452 shared library rather than a regular object file.  It does not affect
1453 how undefined symbols in regular object files are handled.
1454
1455 The default behaviour is to report errors for any undefined symbols
1456 referenced in shared libraries if the linker is being used to create
1457 an executable, but to allow them if the linker is being used to create
1458 a shared library.
1459
1460 The reasons for allowing undefined symbol references in shared
1461 libraries specified at link time are that:
1462
1463 @itemize @bullet
1464 @item
1465 A shared library specified at link time may not be the same as the one
1466 that is available at load time, so the symbol might actually be
1467 resolvable at load time.
1468 @item
1469 There are some operating systems, eg BeOS and HPPA, where undefined
1470 symbols in shared libraries are normal.
1471
1472 The BeOS kernel for example patches shared libraries at load time to
1473 select whichever function is most appropriate for the current
1474 architecture.  This is used, for example, to dynamically select an
1475 appropriate memset function.
1476 @end itemize
1477
1478 @kindex --no-undefined-version
1479 @item --no-undefined-version
1480 Normally when a symbol has an undefined version, the linker will ignore
1481 it. This option disallows symbols with undefined version and a fatal error
1482 will be issued instead.
1483
1484 @kindex --default-symver
1485 @item --default-symver
1486 Create and use a default symbol version (the soname) for unversioned
1487 exported symbols.
1488
1489 @kindex --default-imported-symver
1490 @item --default-imported-symver
1491 Create and use a default symbol version (the soname) for unversioned
1492 imported symbols.
1493
1494 @kindex --no-warn-mismatch
1495 @item --no-warn-mismatch
1496 Normally @command{ld} will give an error if you try to link together input
1497 files that are mismatched for some reason, perhaps because they have
1498 been compiled for different processors or for different endiannesses.
1499 This option tells @command{ld} that it should silently permit such possible
1500 errors.  This option should only be used with care, in cases when you
1501 have taken some special action that ensures that the linker errors are
1502 inappropriate.
1503
1504 @kindex --no-warn-search-mismatch
1505 @item --no-warn-search-mismatch
1506 Normally @command{ld} will give a warning if it finds an incompatible
1507 library during a library search.  This option silences the warning.
1508
1509 @kindex --no-whole-archive
1510 @item --no-whole-archive
1511 Turn off the effect of the @option{--whole-archive} option for subsequent
1512 archive files.
1513
1514 @cindex output file after errors
1515 @kindex --noinhibit-exec
1516 @item --noinhibit-exec
1517 Retain the executable output file whenever it is still usable.
1518 Normally, the linker will not produce an output file if it encounters
1519 errors during the link process; it exits without writing an output file
1520 when it issues any error whatsoever.
1521
1522 @kindex -nostdlib
1523 @item -nostdlib
1524 Only search library directories explicitly specified on the
1525 command line.  Library directories specified in linker scripts
1526 (including linker scripts specified on the command line) are ignored.
1527
1528 @ifclear SingleFormat
1529 @kindex --oformat=@var{output-format}
1530 @item --oformat=@var{output-format}
1531 @command{ld} may be configured to support more than one kind of object
1532 file.  If your @command{ld} is configured this way, you can use the
1533 @samp{--oformat} option to specify the binary format for the output
1534 object file.  Even when @command{ld} is configured to support alternative
1535 object formats, you don't usually need to specify this, as @command{ld}
1536 should be configured to produce as a default output format the most
1537 usual format on each machine.  @var{output-format} is a text string, the
1538 name of a particular format supported by the BFD libraries.  (You can
1539 list the available binary formats with @samp{objdump -i}.)  The script
1540 command @code{OUTPUT_FORMAT} can also specify the output format, but
1541 this option overrides it.  @xref{BFD}.
1542 @end ifclear
1543
1544 @kindex -pie
1545 @kindex --pic-executable
1546 @item -pie
1547 @itemx --pic-executable
1548 @cindex position independent executables
1549 Create a position independent executable.  This is currently only supported on
1550 ELF platforms.  Position independent executables are similar to shared
1551 libraries in that they are relocated by the dynamic linker to the virtual
1552 address the OS chooses for them (which can vary between invocations).  Like
1553 normal dynamically linked executables they can be executed and symbols
1554 defined in the executable cannot be overridden by shared libraries.
1555
1556 @kindex -qmagic
1557 @item -qmagic
1558 This option is ignored for Linux compatibility.
1559
1560 @kindex -Qy
1561 @item -Qy
1562 This option is ignored for SVR4 compatibility.
1563
1564 @kindex --relax
1565 @cindex synthesizing linker
1566 @cindex relaxing addressing modes
1567 @cindex --no-relax
1568 @item --relax
1569 @itemx --no-relax
1570 An option with machine dependent effects.
1571 @ifset GENERIC
1572 This option is only supported on a few targets.
1573 @end ifset
1574 @ifset H8300
1575 @xref{H8/300,,@command{ld} and the H8/300}.
1576 @end ifset
1577 @ifset I960
1578 @xref{i960,, @command{ld} and the Intel 960 family}.
1579 @end ifset
1580 @ifset XTENSA
1581 @xref{Xtensa,, @command{ld} and Xtensa Processors}.
1582 @end ifset
1583 @ifset M68HC11
1584 @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}.
1585 @end ifset
1586 @ifset POWERPC
1587 @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}.
1588 @end ifset
1589
1590 On some platforms the @samp{--relax} option performs target specific,
1591 global optimizations that become possible when the linker resolves
1592 addressing in the program, such as relaxing address modes,
1593 synthesizing new instructions, selecting shorter version of current
1594 instructions, and combinig constant values.
1595
1596 On some platforms these link time global optimizations may make symbolic
1597 debugging of the resulting executable impossible.
1598 @ifset GENERIC
1599 This is known to be the case for the Matsushita MN10200 and MN10300
1600 family of processors.
1601 @end ifset
1602
1603 @ifset GENERIC
1604 On platforms where this is not supported, @samp{--relax} is accepted,
1605 but ignored.
1606 @end ifset
1607
1608 On platforms where @samp{--relax} is accepted the option
1609 @samp{--no-relax} can be used to disable the feature.
1610
1611 @cindex retaining specified symbols
1612 @cindex stripping all but some symbols
1613 @cindex symbols, retaining selectively
1614 @kindex --retain-symbols-file=@var{filename}
1615 @item --retain-symbols-file=@var{filename}
1616 Retain @emph{only} the symbols listed in the file @var{filename},
1617 discarding all others.  @var{filename} is simply a flat file, with one
1618 symbol name per line.  This option is especially useful in environments
1619 @ifset GENERIC
1620 (such as VxWorks)
1621 @end ifset
1622 where a large global symbol table is accumulated gradually, to conserve
1623 run-time memory.
1624
1625 @samp{--retain-symbols-file} does @emph{not} discard undefined symbols,
1626 or symbols needed for relocations.
1627
1628 You may only specify @samp{--retain-symbols-file} once in the command
1629 line.  It overrides @samp{-s} and @samp{-S}.
1630
1631 @ifset GENERIC
1632 @item -rpath=@var{dir}
1633 @cindex runtime library search path
1634 @kindex -rpath=@var{dir}
1635 Add a directory to the runtime library search path.  This is used when
1636 linking an ELF executable with shared objects.  All @option{-rpath}
1637 arguments are concatenated and passed to the runtime linker, which uses
1638 them to locate shared objects at runtime.  The @option{-rpath} option is
1639 also used when locating shared objects which are needed by shared
1640 objects explicitly included in the link; see the description of the
1641 @option{-rpath-link} option.  If @option{-rpath} is not used when linking an
1642 ELF executable, the contents of the environment variable
1643 @code{LD_RUN_PATH} will be used if it is defined.
1644
1645 The @option{-rpath} option may also be used on SunOS.  By default, on
1646 SunOS, the linker will form a runtime search patch out of all the
1647 @option{-L} options it is given.  If a @option{-rpath} option is used, the
1648 runtime search path will be formed exclusively using the @option{-rpath}
1649 options, ignoring the @option{-L} options.  This can be useful when using
1650 gcc, which adds many @option{-L} options which may be on NFS mounted
1651 file systems.
1652
1653 For compatibility with other ELF linkers, if the @option{-R} option is
1654 followed by a directory name, rather than a file name, it is treated as
1655 the @option{-rpath} option.
1656 @end ifset
1657
1658 @ifset GENERIC
1659 @cindex link-time runtime library search path
1660 @kindex -rpath-link=@var{dir}
1661 @item -rpath-link=@var{dir}
1662 When using ELF or SunOS, one shared library may require another.  This
1663 happens when an @code{ld -shared} link includes a shared library as one
1664 of the input files.
1665
1666 When the linker encounters such a dependency when doing a non-shared,
1667 non-relocatable link, it will automatically try to locate the required
1668 shared library and include it in the link, if it is not included
1669 explicitly.  In such a case, the @option{-rpath-link} option
1670 specifies the first set of directories to search.  The
1671 @option{-rpath-link} option may specify a sequence of directory names
1672 either by specifying a list of names separated by colons, or by
1673 appearing multiple times.
1674
1675 This option should be used with caution as it overrides the search path
1676 that may have been hard compiled into a shared library. In such a case it
1677 is possible to use unintentionally a different search path than the
1678 runtime linker would do.
1679
1680 The linker uses the following search paths to locate required shared
1681 libraries:
1682 @enumerate
1683 @item
1684 Any directories specified by @option{-rpath-link} options.
1685 @item
1686 Any directories specified by @option{-rpath} options.  The difference
1687 between @option{-rpath} and @option{-rpath-link} is that directories
1688 specified by @option{-rpath} options are included in the executable and
1689 used at runtime, whereas the @option{-rpath-link} option is only effective
1690 at link time. Searching @option{-rpath} in this way is only supported
1691 by native linkers and cross linkers which have been configured with
1692 the @option{--with-sysroot} option.
1693 @item
1694 On an ELF system, for native linkers, if the @option{-rpath} and
1695 @option{-rpath-link} options were not used, search the contents of the
1696 environment variable @code{LD_RUN_PATH}.
1697 @item
1698 On SunOS, if the @option{-rpath} option was not used, search any
1699 directories specified using @option{-L} options.
1700 @item
1701 For a native linker, the search the contents of the environment
1702 variable @code{LD_LIBRARY_PATH}.
1703 @item
1704 For a native ELF linker, the directories in @code{DT_RUNPATH} or
1705 @code{DT_RPATH} of a shared library are searched for shared
1706 libraries needed by it. The @code{DT_RPATH} entries are ignored if
1707 @code{DT_RUNPATH} entries exist.
1708 @item
1709 The default directories, normally @file{/lib} and @file{/usr/lib}.
1710 @item
1711 For a native linker on an ELF system, if the file @file{/etc/ld.so.conf}
1712 exists, the list of directories found in that file.
1713 @end enumerate
1714
1715 If the required shared library is not found, the linker will issue a
1716 warning and continue with the link.
1717 @end ifset
1718
1719 @kindex -shared
1720 @kindex -Bshareable
1721 @item -shared
1722 @itemx -Bshareable
1723 @cindex shared libraries
1724 Create a shared library.  This is currently only supported on ELF, XCOFF
1725 and SunOS platforms.  On SunOS, the linker will automatically create a
1726 shared library if the @option{-e} option is not used and there are
1727 undefined symbols in the link.
1728
1729 @kindex --sort-common
1730 @item --sort-common
1731 @itemx --sort-common=ascending
1732 @itemx --sort-common=descending
1733 This option tells @command{ld} to sort the common symbols by alignment in
1734 ascending or descending order when it places them in the appropriate output
1735 sections.  The symbol alignments considered are sixteen-byte or larger,
1736 eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps
1737 between symbols due to alignment constraints.  If no sorting order is
1738 specified, then descending order is assumed.
1739
1740 @kindex --sort-section=name
1741 @item --sort-section=name
1742 This option will apply @code{SORT_BY_NAME} to all wildcard section
1743 patterns in the linker script.
1744
1745 @kindex --sort-section=alignment
1746 @item --sort-section=alignment
1747 This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section
1748 patterns in the linker script.
1749
1750 @kindex --split-by-file
1751 @item --split-by-file[=@var{size}]
1752 Similar to @option{--split-by-reloc} but creates a new output section for
1753 each input file when @var{size} is reached.  @var{size} defaults to a
1754 size of 1 if not given.
1755
1756 @kindex --split-by-reloc
1757 @item --split-by-reloc[=@var{count}]
1758 Tries to creates extra sections in the output file so that no single
1759 output section in the file contains more than @var{count} relocations.
1760 This is useful when generating huge relocatable files for downloading into
1761 certain real time kernels with the COFF object file format; since COFF
1762 cannot represent more than 65535 relocations in a single section.  Note
1763 that this will fail to work with object file formats which do not
1764 support arbitrary sections.  The linker will not split up individual
1765 input sections for redistribution, so if a single input section contains
1766 more than @var{count} relocations one output section will contain that
1767 many relocations.  @var{count} defaults to a value of 32768.
1768
1769 @kindex --stats
1770 @item --stats
1771 Compute and display statistics about the operation of the linker, such
1772 as execution time and memory usage.
1773
1774 @kindex --sysroot=@var{directory}
1775 @item --sysroot=@var{directory}
1776 Use @var{directory} as the location of the sysroot, overriding the
1777 configure-time default.  This option is only supported by linkers
1778 that were configured using @option{--with-sysroot}.
1779
1780 @kindex --traditional-format
1781 @cindex traditional format
1782 @item --traditional-format
1783 For some targets, the output of @command{ld} is different in some ways from
1784 the output of some existing linker.  This switch requests @command{ld} to
1785 use the traditional format instead.
1786
1787 @cindex dbx
1788 For example, on SunOS, @command{ld} combines duplicate entries in the
1789 symbol string table.  This can reduce the size of an output file with
1790 full debugging information by over 30 percent.  Unfortunately, the SunOS
1791 @code{dbx} program can not read the resulting program (@code{gdb} has no
1792 trouble).  The @samp{--traditional-format} switch tells @command{ld} to not
1793 combine duplicate entries.
1794
1795 @kindex --section-start=@var{sectionname}=@var{org}
1796 @item --section-start=@var{sectionname}=@var{org}
1797 Locate a section in the output file at the absolute
1798 address given by @var{org}.  You may use this option as many
1799 times as necessary to locate multiple sections in the command
1800 line.
1801 @var{org} must be a single hexadecimal integer;
1802 for compatibility with other linkers, you may omit the leading
1803 @samp{0x} usually associated with hexadecimal values.  @emph{Note:} there
1804 should be no white space between @var{sectionname}, the equals
1805 sign (``@key{=}''), and @var{org}.
1806
1807 @kindex -Tbss=@var{org}
1808 @kindex -Tdata=@var{org}
1809 @kindex -Ttext=@var{org}
1810 @cindex segment origins, cmd line
1811 @item -Tbss=@var{org}
1812 @itemx -Tdata=@var{org}
1813 @itemx -Ttext=@var{org}
1814 Same as @option{--section-start}, with @code{.bss}, @code{.data} or
1815 @code{.text} as the @var{sectionname}.
1816
1817 @kindex -Ttext-segment=@var{org}
1818 @item -Ttext-segment=@var{org}
1819 @cindex text segment origin, cmd line
1820 When creating an ELF executable or shared object, it will set the address
1821 of the first byte of the text segment.
1822
1823 @kindex --unresolved-symbols
1824 @item --unresolved-symbols=@var{method}
1825 Determine how to handle unresolved symbols.  There are four possible
1826 values for @samp{method}:
1827
1828 @table @samp
1829 @item ignore-all
1830 Do not report any unresolved symbols.
1831
1832 @item report-all
1833 Report all unresolved symbols.  This is the default.
1834
1835 @item ignore-in-object-files
1836 Report unresolved symbols that are contained in shared libraries, but
1837 ignore them if they come from regular object files.
1838
1839 @item ignore-in-shared-libs
1840 Report unresolved symbols that come from regular object files, but
1841 ignore them if they come from shared libraries.  This can be useful
1842 when creating a dynamic binary and it is known that all the shared
1843 libraries that it should be referencing are included on the linker's
1844 command line.
1845 @end table
1846
1847 The behaviour for shared libraries on their own can also be controlled
1848 by the @option{--[no-]allow-shlib-undefined} option.
1849
1850 Normally the linker will generate an error message for each reported
1851 unresolved symbol but the option @option{--warn-unresolved-symbols}
1852 can change this to a warning.
1853
1854 @kindex --verbose[=@var{NUMBER}]
1855 @cindex verbose[=@var{NUMBER}]
1856 @item --dll-verbose
1857 @itemx --verbose[=@var{NUMBER}]
1858 Display the version number for @command{ld} and list the linker emulations
1859 supported.  Display which input files can and cannot be opened.  Display
1860 the linker script being used by the linker. If the optional @var{NUMBER}
1861 argument > 1, plugin symbol status will also be displayed.
1862
1863 @kindex --version-script=@var{version-scriptfile}
1864 @cindex version script, symbol versions
1865 @item --version-script=@var{version-scriptfile}
1866 Specify the name of a version script to the linker.  This is typically
1867 used when creating shared libraries to specify additional information
1868 about the version hierarchy for the library being created.  This option
1869 is only fully supported on ELF platforms which support shared libraries;
1870 see @ref{VERSION}.  It is partially supported on PE platforms, which can
1871 use version scripts to filter symbol visibility in auto-export mode: any
1872 symbols marked @samp{local} in the version script will not be exported.
1873 @xref{WIN32}.
1874
1875 @kindex --warn-common
1876 @cindex warnings, on combining symbols
1877 @cindex combining symbols, warnings on
1878 @item --warn-common
1879 Warn when a common symbol is combined with another common symbol or with
1880 a symbol definition.  Unix linkers allow this somewhat sloppy practise,
1881 but linkers on some other operating systems do not.  This option allows
1882 you to find potential problems from combining global symbols.
1883 Unfortunately, some C libraries use this practise, so you may get some
1884 warnings about symbols in the libraries as well as in your programs.
1885
1886 There are three kinds of global symbols, illustrated here by C examples:
1887
1888 @table @samp
1889 @item int i = 1;
1890 A definition, which goes in the initialized data section of the output
1891 file.
1892
1893 @item extern int i;
1894 An undefined reference, which does not allocate space.
1895 There must be either a definition or a common symbol for the
1896 variable somewhere.
1897
1898 @item int i;
1899 A common symbol.  If there are only (one or more) common symbols for a
1900 variable, it goes in the uninitialized data area of the output file.
1901 The linker merges multiple common symbols for the same variable into a
1902 single symbol.  If they are of different sizes, it picks the largest
1903 size.  The linker turns a common symbol into a declaration, if there is
1904 a definition of the same variable.
1905 @end table
1906
1907 The @samp{--warn-common} option can produce five kinds of warnings.
1908 Each warning consists of a pair of lines: the first describes the symbol
1909 just encountered, and the second describes the previous symbol
1910 encountered with the same name.  One or both of the two symbols will be
1911 a common symbol.
1912
1913 @enumerate
1914 @item
1915 Turning a common symbol into a reference, because there is already a
1916 definition for the symbol.
1917 @smallexample
1918 @var{file}(@var{section}): warning: common of `@var{symbol}'
1919    overridden by definition
1920 @var{file}(@var{section}): warning: defined here
1921 @end smallexample
1922
1923 @item
1924 Turning a common symbol into a reference, because a later definition for
1925 the symbol is encountered.  This is the same as the previous case,
1926 except that the symbols are encountered in a different order.
1927 @smallexample
1928 @var{file}(@var{section}): warning: definition of `@var{symbol}'
1929    overriding common
1930 @var{file}(@var{section}): warning: common is here
1931 @end smallexample
1932
1933 @item
1934 Merging a common symbol with a previous same-sized common symbol.
1935 @smallexample
1936 @var{file}(@var{section}): warning: multiple common
1937    of `@var{symbol}'
1938 @var{file}(@var{section}): warning: previous common is here
1939 @end smallexample
1940
1941 @item
1942 Merging a common symbol with a previous larger common symbol.
1943 @smallexample
1944 @var{file}(@var{section}): warning: common of `@var{symbol}'
1945    overridden by larger common
1946 @var{file}(@var{section}): warning: larger common is here
1947 @end smallexample
1948
1949 @item
1950 Merging a common symbol with a previous smaller common symbol.  This is
1951 the same as the previous case, except that the symbols are
1952 encountered in a different order.
1953 @smallexample
1954 @var{file}(@var{section}): warning: common of `@var{symbol}'
1955    overriding smaller common
1956 @var{file}(@var{section}): warning: smaller common is here
1957 @end smallexample
1958 @end enumerate
1959
1960 @kindex --warn-constructors
1961 @item --warn-constructors
1962 Warn if any global constructors are used.  This is only useful for a few
1963 object file formats.  For formats like COFF or ELF, the linker can not
1964 detect the use of global constructors.
1965
1966 @kindex --warn-multiple-gp
1967 @item --warn-multiple-gp
1968 Warn if multiple global pointer values are required in the output file.
1969 This is only meaningful for certain processors, such as the Alpha.
1970 Specifically, some processors put large-valued constants in a special
1971 section.  A special register (the global pointer) points into the middle
1972 of this section, so that constants can be loaded efficiently via a
1973 base-register relative addressing mode.  Since the offset in
1974 base-register relative mode is fixed and relatively small (e.g., 16
1975 bits), this limits the maximum size of the constant pool.  Thus, in
1976 large programs, it is often necessary to use multiple global pointer
1977 values in order to be able to address all possible constants.  This
1978 option causes a warning to be issued whenever this case occurs.
1979
1980 @kindex --warn-once
1981 @cindex warnings, on undefined symbols
1982 @cindex undefined symbols, warnings on
1983 @item --warn-once
1984 Only warn once for each undefined symbol, rather than once per module
1985 which refers to it.
1986
1987 @kindex --warn-section-align
1988 @cindex warnings, on section alignment
1989 @cindex section alignment, warnings on
1990 @item --warn-section-align
1991 Warn if the address of an output section is changed because of
1992 alignment.  Typically, the alignment will be set by an input section.
1993 The address will only be changed if it not explicitly specified; that
1994 is, if the @code{SECTIONS} command does not specify a start address for
1995 the section (@pxref{SECTIONS}).
1996
1997 @kindex --warn-shared-textrel
1998 @item --warn-shared-textrel
1999 Warn if the linker adds a DT_TEXTREL to a shared object.
2000
2001 @kindex --warn-alternate-em
2002 @item --warn-alternate-em
2003 Warn if an object has alternate ELF machine code.
2004
2005 @kindex --warn-unresolved-symbols
2006 @item --warn-unresolved-symbols
2007 If the linker is going to report an unresolved symbol (see the option
2008 @option{--unresolved-symbols}) it will normally generate an error.
2009 This option makes it generate a warning instead.
2010
2011 @kindex --error-unresolved-symbols
2012 @item --error-unresolved-symbols
2013 This restores the linker's default behaviour of generating errors when
2014 it is reporting unresolved symbols.
2015
2016 @kindex --whole-archive
2017 @cindex including an entire archive
2018 @item --whole-archive
2019 For each archive mentioned on the command line after the
2020 @option{--whole-archive} option, include every object file in the archive
2021 in the link, rather than searching the archive for the required object
2022 files.  This is normally used to turn an archive file into a shared
2023 library, forcing every object to be included in the resulting shared
2024 library.  This option may be used more than once.
2025
2026 Two notes when using this option from gcc: First, gcc doesn't know
2027 about this option, so you have to use @option{-Wl,-whole-archive}.
2028 Second, don't forget to use @option{-Wl,-no-whole-archive} after your
2029 list of archives, because gcc will add its own list of archives to
2030 your link and you may not want this flag to affect those as well.
2031
2032 @kindex --wrap=@var{symbol}
2033 @item --wrap=@var{symbol}
2034 Use a wrapper function for @var{symbol}.  Any undefined reference to
2035 @var{symbol} will be resolved to @code{__wrap_@var{symbol}}.  Any
2036 undefined reference to @code{__real_@var{symbol}} will be resolved to
2037 @var{symbol}.
2038
2039 This can be used to provide a wrapper for a system function.  The
2040 wrapper function should be called @code{__wrap_@var{symbol}}.  If it
2041 wishes to call the system function, it should call
2042 @code{__real_@var{symbol}}.
2043
2044 Here is a trivial example:
2045
2046 @smallexample
2047 void *
2048 __wrap_malloc (size_t c)
2049 @{
2050   printf ("malloc called with %zu\n", c);
2051   return __real_malloc (c);
2052 @}
2053 @end smallexample
2054
2055 If you link other code with this file using @option{--wrap malloc}, then
2056 all calls to @code{malloc} will call the function @code{__wrap_malloc}
2057 instead.  The call to @code{__real_malloc} in @code{__wrap_malloc} will
2058 call the real @code{malloc} function.
2059
2060 You may wish to provide a @code{__real_malloc} function as well, so that
2061 links without the @option{--wrap} option will succeed.  If you do this,
2062 you should not put the definition of @code{__real_malloc} in the same
2063 file as @code{__wrap_malloc}; if you do, the assembler may resolve the
2064 call before the linker has a chance to wrap it to @code{malloc}.
2065
2066 @kindex --eh-frame-hdr
2067 @item --eh-frame-hdr
2068 Request creation of @code{.eh_frame_hdr} section and ELF
2069 @code{PT_GNU_EH_FRAME} segment header.
2070
2071 @kindex --enable-new-dtags
2072 @kindex --disable-new-dtags
2073 @item --enable-new-dtags
2074 @itemx --disable-new-dtags
2075 This linker can create the new dynamic tags in ELF. But the older ELF
2076 systems may not understand them. If you specify
2077 @option{--enable-new-dtags}, the dynamic tags will be created as needed.
2078 If you specify @option{--disable-new-dtags}, no new dynamic tags will be
2079 created. By default, the new dynamic tags are not created. Note that
2080 those options are only available for ELF systems.
2081
2082 @kindex --hash-size=@var{number}
2083 @item --hash-size=@var{number}
2084 Set the default size of the linker's hash tables to a prime number
2085 close to @var{number}.  Increasing this value can reduce the length of
2086 time it takes the linker to perform its tasks, at the expense of
2087 increasing the linker's memory requirements.  Similarly reducing this
2088 value can reduce the memory requirements at the expense of speed.
2089
2090 @kindex --hash-style=@var{style}
2091 @item --hash-style=@var{style}
2092 Set the type of linker's hash table(s).  @var{style} can be either
2093 @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for
2094 new style GNU @code{.gnu.hash} section or @code{both} for both
2095 the classic ELF @code{.hash} and new style GNU @code{.gnu.hash}
2096 hash tables.  The default is @code{sysv}.
2097
2098 @kindex --reduce-memory-overheads
2099 @item --reduce-memory-overheads
2100 This option reduces memory requirements at ld runtime, at the expense of
2101 linking speed.  This was introduced to select the old O(n^2) algorithm
2102 for link map file generation, rather than the new O(n) algorithm which uses
2103 about 40% more memory for symbol storage.
2104
2105 Another effect of the switch is to set the default hash table size to
2106 1021, which again saves memory at the cost of lengthening the linker's
2107 run time.  This is not done however if the @option{--hash-size} switch
2108 has been used.
2109
2110 The @option{--reduce-memory-overheads} switch may be also be used to
2111 enable other tradeoffs in future versions of the linker.
2112
2113 @kindex --build-id
2114 @kindex --build-id=@var{style}
2115 @item --build-id
2116 @itemx --build-id=@var{style}
2117 Request creation of @code{.note.gnu.build-id} ELF note section.
2118 The contents of the note are unique bits identifying this linked
2119 file.  @var{style} can be @code{uuid} to use 128 random bits,
2120 @code{sha1} to use a 160-bit @sc{SHA1} hash on the normative
2121 parts of the output contents, @code{md5} to use a 128-bit
2122 @sc{MD5} hash on the normative parts of the output contents, or
2123 @code{0x@var{hexstring}} to use a chosen bit string specified as
2124 an even number of hexadecimal digits (@code{-} and @code{:}
2125 characters between digit pairs are ignored).  If @var{style} is
2126 omitted, @code{sha1} is used.
2127
2128 The @code{md5} and @code{sha1} styles produces an identifier
2129 that is always the same in an identical output file, but will be
2130 unique among all nonidentical output files.  It is not intended
2131 to be compared as a checksum for the file's contents.  A linked
2132 file may be changed later by other tools, but the build ID bit
2133 string identifying the original linked file does not change.
2134
2135 Passing @code{none} for @var{style} disables the setting from any
2136 @code{--build-id} options earlier on the command line.
2137 @end table
2138
2139 @c man end
2140
2141 @subsection Options Specific to i386 PE Targets
2142
2143 @c man begin OPTIONS
2144
2145 The i386 PE linker supports the @option{-shared} option, which causes
2146 the output to be a dynamically linked library (DLL) instead of a
2147 normal executable.  You should name the output @code{*.dll} when you
2148 use this option.  In addition, the linker fully supports the standard
2149 @code{*.def} files, which may be specified on the linker command line
2150 like an object file (in fact, it should precede archives it exports
2151 symbols from, to ensure that they get linked in, just like a normal
2152 object file).
2153
2154 In addition to the options common to all targets, the i386 PE linker
2155 support additional command line options that are specific to the i386
2156 PE target.  Options that take values may be separated from their
2157 values by either a space or an equals sign.
2158
2159 @table @gcctabopt
2160
2161 @kindex --add-stdcall-alias
2162 @item --add-stdcall-alias
2163 If given, symbols with a stdcall suffix (@@@var{nn}) will be exported
2164 as-is and also with the suffix stripped.
2165 [This option is specific to the i386 PE targeted port of the linker]
2166
2167 @kindex --base-file
2168 @item --base-file @var{file}
2169 Use @var{file} as the name of a file in which to save the base
2170 addresses of all the relocations needed for generating DLLs with
2171 @file{dlltool}.
2172 [This is an i386 PE specific option]
2173
2174 @kindex --dll
2175 @item --dll
2176 Create a DLL instead of a regular executable.  You may also use
2177 @option{-shared} or specify a @code{LIBRARY} in a given @code{.def}
2178 file.
2179 [This option is specific to the i386 PE targeted port of the linker]
2180
2181 @kindex --enable-long-section-names
2182 @kindex --disable-long-section-names
2183 @item --enable-long-section-names
2184 @itemx --disable-long-section-names
2185 The PE variants of the Coff object format add an extension that permits
2186 the use of section names longer than eight characters, the normal limit
2187 for Coff.  By default, these names are only allowed in object files, as
2188 fully-linked executable images do not carry the Coff string table required
2189 to support the longer names.  As a GNU extension, it is possible to
2190 allow their use in executable images as well, or to (probably pointlessly!)
2191 disallow it in object files, by using these two options.  Executable images
2192 generated with these long section names are slightly non-standard, carrying
2193 as they do a string table, and may generate confusing output when examined
2194 with non-GNU PE-aware tools, such as file viewers and dumpers.  However, 
2195 GDB relies on the use of PE long section names to find Dwarf-2 debug 
2196 information sections in an executable image at runtime, and so if neither
2197 option is specified on the command-line, @command{ld} will enable long
2198 section names, overriding the default and technically correct behaviour,
2199 when it finds the presence of debug information while linking an executable
2200 image and not stripping symbols.
2201 [This option is valid for all PE targeted ports of the linker]
2202
2203 @kindex --enable-stdcall-fixup
2204 @kindex --disable-stdcall-fixup
2205 @item --enable-stdcall-fixup
2206 @itemx --disable-stdcall-fixup
2207 If the link finds a symbol that it cannot resolve, it will attempt to
2208 do ``fuzzy linking'' by looking for another defined symbol that differs
2209 only in the format of the symbol name (cdecl vs stdcall) and will
2210 resolve that symbol by linking to the match.  For example, the
2211 undefined symbol @code{_foo} might be linked to the function
2212 @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked
2213 to the function @code{_bar}.  When the linker does this, it prints a
2214 warning, since it normally should have failed to link, but sometimes
2215 import libraries generated from third-party dlls may need this feature
2216 to be usable.  If you specify @option{--enable-stdcall-fixup}, this
2217 feature is fully enabled and warnings are not printed.  If you specify
2218 @option{--disable-stdcall-fixup}, this feature is disabled and such
2219 mismatches are considered to be errors.
2220 [This option is specific to the i386 PE targeted port of the linker]
2221
2222 @kindex --leading-underscore
2223 @kindex --no-leading-underscore
2224 @item --leading-underscore
2225 @itemx --no-leading-underscore
2226 For most targets default symbol-prefix is an underscore and is defined
2227 in target's description. By this option it is possible to
2228 disable/enable the default underscore symbol-prefix.
2229
2230 @cindex DLLs, creating
2231 @kindex --export-all-symbols
2232 @item --export-all-symbols
2233 If given, all global symbols in the objects used to build a DLL will
2234 be exported by the DLL.  Note that this is the default if there
2235 otherwise wouldn't be any exported symbols.  When symbols are
2236 explicitly exported via DEF files or implicitly exported via function
2237 attributes, the default is to not export anything else unless this
2238 option is given.  Note that the symbols @code{DllMain@@12},
2239 @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and
2240 @code{impure_ptr} will not be automatically
2241 exported.  Also, symbols imported from other DLLs will not be
2242 re-exported, nor will symbols specifying the DLL's internal layout
2243 such as those beginning with @code{_head_} or ending with
2244 @code{_iname}.  In addition, no symbols from @code{libgcc},
2245 @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported.
2246 Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will
2247 not be exported, to help with C++ DLLs.  Finally, there is an
2248 extensive list of cygwin-private symbols that are not exported
2249 (obviously, this applies on when building DLLs for cygwin targets).
2250 These cygwin-excludes are: @code{_cygwin_dll_entry@@12},
2251 @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12},
2252 @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll},
2253 @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2},
2254 @code{cygwin_premain3}, and @code{environ}.
2255 [This option is specific to the i386 PE targeted port of the linker]
2256
2257 @kindex --exclude-symbols
2258 @item --exclude-symbols @var{symbol},@var{symbol},...
2259 Specifies a list of symbols which should not be automatically
2260 exported.  The symbol names may be delimited by commas or colons.
2261 [This option is specific to the i386 PE targeted port of the linker]
2262
2263 @kindex --exclude-all-symbols
2264 @item --exclude-all-symbols
2265 Specifies no symbols should be automatically exported.
2266 [This option is specific to the i386 PE targeted port of the linker]
2267
2268 @kindex --file-alignment
2269 @item --file-alignment
2270 Specify the file alignment.  Sections in the file will always begin at
2271 file offsets which are multiples of this number.  This defaults to
2272 512.
2273 [This option is specific to the i386 PE targeted port of the linker]
2274
2275 @cindex heap size
2276 @kindex --heap
2277 @item --heap @var{reserve}
2278 @itemx --heap @var{reserve},@var{commit}
2279 Specify the number of bytes of memory to reserve (and optionally commit)
2280 to be used as heap for this program.  The default is 1Mb reserved, 4K
2281 committed.
2282 [This option is specific to the i386 PE targeted port of the linker]
2283
2284 @cindex image base
2285 @kindex --image-base
2286 @item --image-base @var{value}
2287 Use @var{value} as the base address of your program or dll.  This is
2288 the lowest memory location that will be used when your program or dll
2289 is loaded.  To reduce the need to relocate and improve performance of
2290 your dlls, each should have a unique base address and not overlap any
2291 other dlls.  The default is 0x400000 for executables, and 0x10000000
2292 for dlls.
2293 [This option is specific to the i386 PE targeted port of the linker]
2294
2295 @kindex --kill-at
2296 @item --kill-at
2297 If given, the stdcall suffixes (@@@var{nn}) will be stripped from
2298 symbols before they are exported.
2299 [This option is specific to the i386 PE targeted port of the linker]
2300
2301 @kindex --large-address-aware
2302 @item --large-address-aware
2303 If given, the appropriate bit in the ``Characteristics'' field of the COFF
2304 header is set to indicate that this executable supports virtual addresses
2305 greater than 2 gigabytes.  This should be used in conjunction with the /3GB
2306 or /USERVA=@var{value} megabytes switch in the ``[operating systems]''
2307 section of the BOOT.INI.  Otherwise, this bit has no effect.
2308 [This option is specific to PE targeted ports of the linker]
2309
2310 @kindex --major-image-version
2311 @item --major-image-version @var{value}
2312 Sets the major number of the ``image version''.  Defaults to 1.
2313 [This option is specific to the i386 PE targeted port of the linker]
2314
2315 @kindex --major-os-version
2316 @item --major-os-version @var{value}
2317 Sets the major number of the ``os version''.  Defaults to 4.
2318 [This option is specific to the i386 PE targeted port of the linker]
2319
2320 @kindex --major-subsystem-version
2321 @item --major-subsystem-version @var{value}
2322 Sets the major number of the ``subsystem version''.  Defaults to 4.
2323 [This option is specific to the i386 PE targeted port of the linker]
2324
2325 @kindex --minor-image-version
2326 @item --minor-image-version @var{value}
2327 Sets the minor number of the ``image version''.  Defaults to 0.
2328 [This option is specific to the i386 PE targeted port of the linker]
2329
2330 @kindex --minor-os-version
2331 @item --minor-os-version @var{value}
2332 Sets the minor number of the ``os version''.  Defaults to 0.
2333 [This option is specific to the i386 PE targeted port of the linker]
2334
2335 @kindex --minor-subsystem-version
2336 @item --minor-subsystem-version @var{value}
2337 Sets the minor number of the ``subsystem version''.  Defaults to 0.
2338 [This option is specific to the i386 PE targeted port of the linker]
2339
2340 @cindex DEF files, creating
2341 @cindex DLLs, creating
2342 @kindex --output-def
2343 @item --output-def @var{file}
2344 The linker will create the file @var{file} which will contain a DEF
2345 file corresponding to the DLL the linker is generating.  This DEF file
2346 (which should be called @code{*.def}) may be used to create an import
2347 library with @code{dlltool} or may be used as a reference to
2348 automatically or implicitly exported symbols.
2349 [This option is specific to the i386 PE targeted port of the linker]
2350
2351 @cindex DLLs, creating
2352 @kindex --out-implib
2353 @item --out-implib @var{file}
2354 The linker will create the file @var{file} which will contain an
2355 import lib corresponding to the DLL the linker is generating. This
2356 import lib (which should be called @code{*.dll.a} or @code{*.a}
2357 may be used to link clients against the generated DLL; this behaviour
2358 makes it possible to skip a separate @code{dlltool} import library
2359 creation step.
2360 [This option is specific to the i386 PE targeted port of the linker]
2361
2362 @kindex --enable-auto-image-base
2363 @item --enable-auto-image-base
2364 Automatically choose the image base for DLLs, unless one is specified
2365 using the @code{--image-base} argument.  By using a hash generated
2366 from the dllname to create unique image bases for each DLL, in-memory
2367 collisions and relocations which can delay program execution are
2368 avoided.
2369 [This option is specific to the i386 PE targeted port of the linker]
2370
2371 @kindex --disable-auto-image-base
2372 @item --disable-auto-image-base
2373 Do not automatically generate a unique image base.  If there is no
2374 user-specified image base (@code{--image-base}) then use the platform
2375 default.
2376 [This option is specific to the i386 PE targeted port of the linker]
2377
2378 @cindex DLLs, linking to
2379 @kindex --dll-search-prefix
2380 @item --dll-search-prefix @var{string}
2381 When linking dynamically to a dll without an import library,
2382 search for @code{<string><basename>.dll} in preference to
2383 @code{lib<basename>.dll}. This behaviour allows easy distinction
2384 between DLLs built for the various "subplatforms": native, cygwin,
2385 uwin, pw, etc.  For instance, cygwin DLLs typically use
2386 @code{--dll-search-prefix=cyg}.
2387 [This option is specific to the i386 PE targeted port of the linker]
2388
2389 @kindex --enable-auto-import
2390 @item --enable-auto-import
2391 Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for
2392 DATA imports from DLLs, and create the necessary thunking symbols when
2393 building the import libraries with those DATA exports. Note: Use of the
2394 'auto-import' extension will cause the text section of the image file
2395 to be made writable. This does not conform to the PE-COFF format
2396 specification published by Microsoft.
2397
2398 Note - use of the 'auto-import' extension will also cause read only
2399 data which would normally be placed into the .rdata section to be
2400 placed into the .data section instead.  This is in order to work
2401 around a problem with consts that is described here:
2402 http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
2403
2404 Using 'auto-import' generally will 'just work' -- but sometimes you may
2405 see this message:
2406
2407 "variable '<var>' can't be auto-imported. Please read the
2408 documentation for ld's @code{--enable-auto-import} for details."
2409
2410 This message occurs when some (sub)expression accesses an address
2411 ultimately given by the sum of two constants (Win32 import tables only
2412 allow one).  Instances where this may occur include accesses to member
2413 fields of struct variables imported from a DLL, as well as using a
2414 constant index into an array variable imported from a DLL.  Any
2415 multiword variable (arrays, structs, long long, etc) may trigger
2416 this error condition.  However, regardless of the exact data type
2417 of the offending exported variable, ld will always detect it, issue
2418 the warning, and exit.
2419
2420 There are several ways to address this difficulty, regardless of the
2421 data type of the exported variable:
2422
2423 One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task
2424 of adjusting references in your client code for runtime environment, so
2425 this method works only when runtime environment supports this feature.
2426
2427 A second solution is to force one of the 'constants' to be a variable --
2428 that is, unknown and un-optimizable at compile time.  For arrays,
2429 there are two possibilities: a) make the indexee (the array's address)
2430 a variable, or b) make the 'constant' index a variable.  Thus:
2431
2432 @example
2433 extern type extern_array[];
2434 extern_array[1] -->
2435    @{ volatile type *t=extern_array; t[1] @}
2436 @end example
2437
2438 or
2439
2440 @example
2441 extern type extern_array[];
2442 extern_array[1] -->
2443    @{ volatile int t=1; extern_array[t] @}
2444 @end example
2445
2446 For structs (and most other multiword data types) the only option
2447 is to make the struct itself (or the long long, or the ...) variable:
2448
2449 @example
2450 extern struct s extern_struct;
2451 extern_struct.field -->
2452    @{ volatile struct s *t=&extern_struct; t->field @}
2453 @end example
2454
2455 or
2456
2457 @example
2458 extern long long extern_ll;
2459 extern_ll -->
2460   @{ volatile long long * local_ll=&extern_ll; *local_ll @}
2461 @end example
2462
2463 A third method of dealing with this difficulty is to abandon
2464 'auto-import' for the offending symbol and mark it with
2465 @code{__declspec(dllimport)}.  However, in practise that
2466 requires using compile-time #defines to indicate whether you are
2467 building a DLL, building client code that will link to the DLL, or
2468 merely building/linking to a static library.   In making the choice
2469 between the various methods of resolving the 'direct address with
2470 constant offset' problem, you should consider typical real-world usage:
2471
2472 Original:
2473 @example
2474 --foo.h
2475 extern int arr[];
2476 --foo.c
2477 #include "foo.h"
2478 void main(int argc, char **argv)@{
2479   printf("%d\n",arr[1]);
2480 @}
2481 @end example
2482
2483 Solution 1:
2484 @example
2485 --foo.h
2486 extern int arr[];
2487 --foo.c
2488 #include "foo.h"
2489 void main(int argc, char **argv)@{
2490   /* This workaround is for win32 and cygwin; do not "optimize" */
2491   volatile int *parr = arr;
2492   printf("%d\n",parr[1]);
2493 @}
2494 @end example
2495
2496 Solution 2:
2497 @example
2498 --foo.h
2499 /* Note: auto-export is assumed (no __declspec(dllexport)) */
2500 #if (defined(_WIN32) || defined(__CYGWIN__)) && \
2501   !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2502 #define FOO_IMPORT __declspec(dllimport)
2503 #else
2504 #define FOO_IMPORT
2505 #endif
2506 extern FOO_IMPORT int arr[];
2507 --foo.c
2508 #include "foo.h"
2509 void main(int argc, char **argv)@{
2510   printf("%d\n",arr[1]);
2511 @}
2512 @end example
2513
2514 A fourth way to avoid this problem is to re-code your
2515 library to use a functional interface rather than a data interface
2516 for the offending variables (e.g. set_foo() and get_foo() accessor
2517 functions).
2518 [This option is specific to the i386 PE targeted port of the linker]
2519
2520 @kindex --disable-auto-import
2521 @item --disable-auto-import
2522 Do not attempt to do sophisticated linking of @code{_symbol} to
2523 @code{__imp__symbol} for DATA imports from DLLs.
2524 [This option is specific to the i386 PE targeted port of the linker]
2525
2526 @kindex --enable-runtime-pseudo-reloc
2527 @item --enable-runtime-pseudo-reloc
2528 If your code contains expressions described in --enable-auto-import section,
2529 that is, DATA imports from DLL with non-zero offset, this switch will create
2530 a vector of 'runtime pseudo relocations' which can be used by runtime
2531 environment to adjust references to such data in your client code.
2532 [This option is specific to the i386 PE targeted port of the linker]
2533
2534 @kindex --disable-runtime-pseudo-reloc
2535 @item --disable-runtime-pseudo-reloc
2536 Do not create pseudo relocations for non-zero offset DATA imports from
2537 DLLs.  This is the default.
2538 [This option is specific to the i386 PE targeted port of the linker]
2539
2540 @kindex --enable-extra-pe-debug
2541 @item --enable-extra-pe-debug
2542 Show additional debug info related to auto-import symbol thunking.
2543 [This option is specific to the i386 PE targeted port of the linker]
2544
2545 @kindex --section-alignment
2546 @item --section-alignment
2547 Sets the section alignment.  Sections in memory will always begin at
2548 addresses which are a multiple of this number.  Defaults to 0x1000.
2549 [This option is specific to the i386 PE targeted port of the linker]
2550
2551 @cindex stack size
2552 @kindex --stack
2553 @item --stack @var{reserve}
2554 @itemx --stack @var{reserve},@var{commit}
2555 Specify the number of bytes of memory to reserve (and optionally commit)
2556 to be used as stack for this program.  The default is 2Mb reserved, 4K
2557 committed.
2558 [This option is specific to the i386 PE targeted port of the linker]
2559
2560 @kindex --subsystem
2561 @item --subsystem @var{which}
2562 @itemx --subsystem @var{which}:@var{major}
2563 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2564 Specifies the subsystem under which your program will execute.  The
2565 legal values for @var{which} are @code{native}, @code{windows},
2566 @code{console}, @code{posix}, and @code{xbox}.  You may optionally set
2567 the subsystem version also.  Numeric values are also accepted for
2568 @var{which}.
2569 [This option is specific to the i386 PE targeted port of the linker]
2570
2571 The following options set flags in the @code{DllCharacteristics} field
2572 of the PE file header:
2573 [These options are specific to PE targeted ports of the linker]
2574
2575 @kindex --dynamicbase
2576 @item --dynamicbase
2577 The image base address may be relocated using address space layout
2578 randomization (ASLR).  This feature was introduced with MS Windows
2579 Vista for i386 PE targets.
2580
2581 @kindex --forceinteg
2582 @item --forceinteg
2583 Code integrity checks are enforced.
2584
2585 @kindex --nxcompat
2586 @item --nxcompat
2587 The image is compatible with the Data Execution Prevention.
2588 This feature was introduced with MS Windows XP SP2 for i386 PE targets.
2589
2590 @kindex --no-isolation
2591 @item --no-isolation
2592 Although the image understands isolation, do not isolate the image.
2593
2594 @kindex --no-seh
2595 @item --no-seh
2596 The image does not use SEH. No SE handler may be called from
2597 this image.
2598
2599 @kindex --no-bind
2600 @item --no-bind
2601 Do not bind this image.
2602
2603 @kindex --wdmdriver
2604 @item --wdmdriver
2605 The driver uses the MS Windows Driver Model.
2606  
2607 @kindex --tsaware
2608 @item --tsaware
2609 The image is Terminal Server aware.
2610
2611 @end table
2612
2613 @c man end
2614
2615 @ifset M68HC11
2616 @subsection Options specific to Motorola 68HC11 and 68HC12 targets
2617
2618 @c man begin OPTIONS
2619
2620 The 68HC11 and 68HC12 linkers support specific options to control the
2621 memory bank switching mapping and trampoline code generation.
2622
2623 @table @gcctabopt
2624
2625 @kindex --no-trampoline
2626 @item --no-trampoline
2627 This option disables the generation of trampoline. By default a trampoline
2628 is generated for each far function which is called using a @code{jsr}
2629 instruction (this happens when a pointer to a far function is taken).
2630
2631 @kindex --bank-window
2632 @item --bank-window @var{name}
2633 This option indicates to the linker the name of the memory region in
2634 the @samp{MEMORY} specification that describes the memory bank window.
2635 The definition of such region is then used by the linker to compute
2636 paging and addresses within the memory window.
2637
2638 @end table
2639
2640 @c man end
2641 @end ifset
2642
2643 @ifset M68K
2644 @subsection Options specific to Motorola 68K target
2645
2646 @c man begin OPTIONS
2647
2648 The following options are supported to control handling of GOT generation
2649 when linking for 68K targets.
2650
2651 @table @gcctabopt
2652
2653 @kindex --got
2654 @item --got=@var{type}
2655 This option tells the linker which GOT generation scheme to use.
2656 @var{type} should be one of @samp{single}, @samp{negative},
2657 @samp{multigot} or @samp{target}.  For more information refer to the
2658 Info entry for @file{ld}.
2659
2660 @end table
2661
2662 @c man end
2663 @end ifset
2664
2665 @ifset UsesEnvVars
2666 @node Environment
2667 @section Environment Variables
2668
2669 @c man begin ENVIRONMENT
2670
2671 You can change the behaviour of @command{ld} with the environment variables
2672 @ifclear SingleFormat
2673 @code{GNUTARGET},
2674 @end ifclear
2675 @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
2676
2677 @ifclear SingleFormat
2678 @kindex GNUTARGET
2679 @cindex default input format
2680 @code{GNUTARGET} determines the input-file object format if you don't
2681 use @samp{-b} (or its synonym @samp{--format}).  Its value should be one
2682 of the BFD names for an input format (@pxref{BFD}).  If there is no
2683 @code{GNUTARGET} in the environment, @command{ld} uses the natural format
2684 of the target. If @code{GNUTARGET} is set to @code{default} then BFD
2685 attempts to discover the input format by examining binary input files;
2686 this method often succeeds, but there are potential ambiguities, since
2687 there is no method of ensuring that the magic number used to specify
2688 object-file formats is unique.  However, the configuration procedure for
2689 BFD on each system places the conventional format for that system first
2690 in the search-list, so ambiguities are resolved in favor of convention.
2691 @end ifclear
2692
2693 @kindex LDEMULATION
2694 @cindex default emulation
2695 @cindex emulation, default
2696 @code{LDEMULATION} determines the default emulation if you don't use the
2697 @samp{-m} option.  The emulation can affect various aspects of linker
2698 behaviour, particularly the default linker script.  You can list the
2699 available emulations with the @samp{--verbose} or @samp{-V} options.  If
2700 the @samp{-m} option is not used, and the @code{LDEMULATION} environment
2701 variable is not defined, the default emulation depends upon how the
2702 linker was configured.
2703
2704 @kindex COLLECT_NO_DEMANGLE
2705 @cindex demangling, default
2706 Normally, the linker will default to demangling symbols.  However, if
2707 @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will
2708 default to not demangling symbols.  This environment variable is used in
2709 a similar fashion by the @code{gcc} linker wrapper program.  The default
2710 may be overridden by the @samp{--demangle} and @samp{--no-demangle}
2711 options.
2712
2713 @c man end
2714 @end ifset
2715
2716 @node Scripts
2717 @chapter Linker Scripts
2718
2719 @cindex scripts
2720 @cindex linker scripts
2721 @cindex command files
2722 Every link is controlled by a @dfn{linker script}.  This script is
2723 written in the linker command language.
2724
2725 The main purpose of the linker script is to describe how the sections in
2726 the input files should be mapped into the output file, and to control
2727 the memory layout of the output file.  Most linker scripts do nothing
2728 more than this.  However, when necessary, the linker script can also
2729 direct the linker to perform many other operations, using the commands
2730 described below.
2731
2732 The linker always uses a linker script.  If you do not supply one
2733 yourself, the linker will use a default script that is compiled into the
2734 linker executable.  You can use the @samp{--verbose} command line option
2735 to display the default linker script.  Certain command line options,
2736 such as @samp{-r} or @samp{-N}, will affect the default linker script.
2737
2738 You may supply your own linker script by using the @samp{-T} command
2739 line option.  When you do this, your linker script will replace the
2740 default linker script.
2741
2742 You may also use linker scripts implicitly by naming them as input files
2743 to the linker, as though they were files to be linked.  @xref{Implicit
2744 Linker Scripts}.
2745
2746 @menu
2747 * Basic Script Concepts::       Basic Linker Script Concepts
2748 * Script Format::               Linker Script Format
2749 * Simple Example::              Simple Linker Script Example
2750 * Simple Commands::             Simple Linker Script Commands
2751 * Assignments::                 Assigning Values to Symbols
2752 * SECTIONS::                    SECTIONS Command
2753 * MEMORY::                      MEMORY Command
2754 * PHDRS::                       PHDRS Command
2755 * VERSION::                     VERSION Command
2756 * Expressions::                 Expressions in Linker Scripts
2757 * Implicit Linker Scripts::     Implicit Linker Scripts
2758 @end menu
2759
2760 @node Basic Script Concepts
2761 @section Basic Linker Script Concepts
2762 @cindex linker script concepts
2763 We need to define some basic concepts and vocabulary in order to
2764 describe the linker script language.
2765
2766 The linker combines input files into a single output file.  The output
2767 file and each input file are in a special data format known as an
2768 @dfn{object file format}.  Each file is called an @dfn{object file}.
2769 The output file is often called an @dfn{executable}, but for our
2770 purposes we will also call it an object file.  Each object file has,
2771 among other things, a list of @dfn{sections}.  We sometimes refer to a
2772 section in an input file as an @dfn{input section}; similarly, a section
2773 in the output file is an @dfn{output section}.
2774
2775 Each section in an object file has a name and a size.  Most sections
2776 also have an associated block of data, known as the @dfn{section
2777 contents}.  A section may be marked as @dfn{loadable}, which mean that
2778 the contents should be loaded into memory when the output file is run.
2779 A section with no contents may be @dfn{allocatable}, which means that an
2780 area in memory should be set aside, but nothing in particular should be
2781 loaded there (in some cases this memory must be zeroed out).  A section
2782 which is neither loadable nor allocatable typically contains some sort
2783 of debugging information.
2784
2785 Every loadable or allocatable output section has two addresses.  The
2786 first is the @dfn{VMA}, or virtual memory address.  This is the address
2787 the section will have when the output file is run.  The second is the
2788 @dfn{LMA}, or load memory address.  This is the address at which the
2789 section will be loaded.  In most cases the two addresses will be the
2790 same.  An example of when they might be different is when a data section
2791 is loaded into ROM, and then copied into RAM when the program starts up
2792 (this technique is often used to initialize global variables in a ROM
2793 based system).  In this case the ROM address would be the LMA, and the
2794 RAM address would be the VMA.
2795
2796 You can see the sections in an object file by using the @code{objdump}
2797 program with the @samp{-h} option.
2798
2799 Every object file also has a list of @dfn{symbols}, known as the
2800 @dfn{symbol table}.  A symbol may be defined or undefined.  Each symbol
2801 has a name, and each defined symbol has an address, among other
2802 information.  If you compile a C or C++ program into an object file, you
2803 will get a defined symbol for every defined function and global or
2804 static variable.  Every undefined function or global variable which is
2805 referenced in the input file will become an undefined symbol.
2806
2807 You can see the symbols in an object file by using the @code{nm}
2808 program, or by using the @code{objdump} program with the @samp{-t}
2809 option.
2810
2811 @node Script Format
2812 @section Linker Script Format
2813 @cindex linker script format
2814 Linker scripts are text files.
2815
2816 You write a linker script as a series of commands.  Each command is
2817 either a keyword, possibly followed by arguments, or an assignment to a
2818 symbol.  You may separate commands using semicolons.  Whitespace is
2819 generally ignored.
2820
2821 Strings such as file or format names can normally be entered directly.
2822 If the file name contains a character such as a comma which would
2823 otherwise serve to separate file names, you may put the file name in
2824 double quotes.  There is no way to use a double quote character in a
2825 file name.
2826
2827 You may include comments in linker scripts just as in C, delimited by
2828 @samp{/*} and @samp{*/}.  As in C, comments are syntactically equivalent
2829 to whitespace.
2830
2831 @node Simple Example
2832 @section Simple Linker Script Example
2833 @cindex linker script example
2834 @cindex example of linker script
2835 Many linker scripts are fairly simple.
2836
2837 The simplest possible linker script has just one command:
2838 @samp{SECTIONS}.  You use the @samp{SECTIONS} command to describe the
2839 memory layout of the output file.
2840
2841 The @samp{SECTIONS} command is a powerful command.  Here we will
2842 describe a simple use of it.  Let's assume your program consists only of
2843 code, initialized data, and uninitialized data.  These will be in the
2844 @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively.
2845 Let's assume further that these are the only sections which appear in
2846 your input files.
2847
2848 For this example, let's say that the code should be loaded at address
2849 0x10000, and that the data should start at address 0x8000000.  Here is a
2850 linker script which will do that:
2851 @smallexample
2852 SECTIONS
2853 @{
2854   . = 0x10000;
2855   .text : @{ *(.text) @}
2856   . = 0x8000000;
2857   .data : @{ *(.data) @}
2858   .bss : @{ *(.bss) @}
2859 @}
2860 @end smallexample
2861
2862 You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS},
2863 followed by a series of symbol assignments and output section
2864 descriptions enclosed in curly braces.
2865
2866 The first line inside the @samp{SECTIONS} command of the above example
2867 sets the value of the special symbol @samp{.}, which is the location
2868 counter.  If you do not specify the address of an output section in some
2869 other way (other ways are described later), the address is set from the
2870 current value of the location counter.  The location counter is then
2871 incremented by the size of the output section.  At the start of the
2872 @samp{SECTIONS} command, the location counter has the value @samp{0}.
2873
2874 The second line defines an output section, @samp{.text}.  The colon is
2875 required syntax which may be ignored for now.  Within the curly braces
2876 after the output section name, you list the names of the input sections
2877 which should be placed into this output section.  The @samp{*} is a
2878 wildcard which matches any file name.  The expression @samp{*(.text)}
2879 means all @samp{.text} input sections in all input files.
2880
2881 Since the location counter is @samp{0x10000} when the output section
2882 @samp{.text} is defined, the linker will set the address of the
2883 @samp{.text} section in the output file to be @samp{0x10000}.
2884
2885 The remaining lines define the @samp{.data} and @samp{.bss} sections in
2886 the output file.  The linker will place the @samp{.data} output section
2887 at address @samp{0x8000000}.  After the linker places the @samp{.data}
2888 output section, the value of the location counter will be
2889 @samp{0x8000000} plus the size of the @samp{.data} output section.  The
2890 effect is that the linker will place the @samp{.bss} output section
2891 immediately after the @samp{.data} output section in memory.
2892
2893 The linker will ensure that each output section has the required
2894 alignment, by increasing the location counter if necessary.  In this
2895 example, the specified addresses for the @samp{.text} and @samp{.data}
2896 sections will probably satisfy any alignment constraints, but the linker
2897 may have to create a small gap between the @samp{.data} and @samp{.bss}
2898 sections.
2899
2900 That's it!  That's a simple and complete linker script.
2901
2902 @node Simple Commands
2903 @section Simple Linker Script Commands
2904 @cindex linker script simple commands
2905 In this section we describe the simple linker script commands.
2906
2907 @menu
2908 * Entry Point::                 Setting the entry point
2909 * File Commands::               Commands dealing with files
2910 @ifclear SingleFormat
2911 * Format Commands::             Commands dealing with object file formats
2912 @end ifclear
2913
2914 * REGION_ALIAS::                Assign alias names to memory regions
2915 * Miscellaneous Commands::      Other linker script commands
2916 @end menu
2917
2918 @node Entry Point
2919 @subsection Setting the Entry Point
2920 @kindex ENTRY(@var{symbol})
2921 @cindex start of execution
2922 @cindex first instruction
2923 @cindex entry point
2924 The first instruction to execute in a program is called the @dfn{entry
2925 point}.  You can use the @code{ENTRY} linker script command to set the
2926 entry point.  The argument is a symbol name:
2927 @smallexample
2928 ENTRY(@var{symbol})
2929 @end smallexample
2930
2931 There are several ways to set the entry point.  The linker will set the
2932 entry point by trying each of the following methods in order, and
2933 stopping when one of them succeeds:
2934 @itemize @bullet
2935 @item
2936 the @samp{-e} @var{entry} command-line option;
2937 @item
2938 the @code{ENTRY(@var{symbol})} command in a linker script;
2939 @item
2940 the value of a target specific symbol, if it is defined;  For many
2941 targets this is @code{start}, but PE and BeOS based systems for example
2942 check a list of possible entry symbols, matching the first one found.
2943 @item
2944 the address of the first byte of the @samp{.text} section, if present;
2945 @item
2946 The address @code{0}.
2947 @end itemize
2948
2949 @node File Commands
2950 @subsection Commands Dealing with Files
2951 @cindex linker script file commands
2952 Several linker script commands deal with files.
2953
2954 @table @code
2955 @item INCLUDE @var{filename}
2956 @kindex INCLUDE @var{filename}
2957 @cindex including a linker script
2958 Include the linker script @var{filename} at this point.  The file will
2959 be searched for in the current directory, and in any directory specified
2960 with the @option{-L} option.  You can nest calls to @code{INCLUDE} up to
2961 10 levels deep.
2962
2963 You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or
2964 @code{SECTIONS} commands, or in output section descriptions.
2965
2966 @item INPUT(@var{file}, @var{file}, @dots{})
2967 @itemx INPUT(@var{file} @var{file} @dots{})
2968 @kindex INPUT(@var{files})
2969 @cindex input files in linker scripts
2970 @cindex input object files in linker scripts
2971 @cindex linker script input object files
2972 The @code{INPUT} command directs the linker to include the named files
2973 in the link, as though they were named on the command line.
2974
2975 For example, if you always want to include @file{subr.o} any time you do
2976 a link, but you can't be bothered to put it on every link command line,
2977 then you can put @samp{INPUT (subr.o)} in your linker script.
2978
2979 In fact, if you like, you can list all of your input files in the linker
2980 script, and then invoke the linker with nothing but a @samp{-T} option.
2981
2982 In case a @dfn{sysroot prefix} is configured, and the filename starts
2983 with the @samp{/} character, and the script being processed was
2984 located inside the @dfn{sysroot prefix}, the filename will be looked
2985 for in the @dfn{sysroot prefix}.  Otherwise, the linker will try to
2986 open the file in the current directory.  If it is not found, the
2987 linker will search through the archive library search path.  See the
2988 description of @samp{-L} in @ref{Options,,Command Line Options}.
2989
2990 If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the
2991 name to @code{lib@var{file}.a}, as with the command line argument
2992 @samp{-l}.
2993
2994 When you use the @code{INPUT} command in an implicit linker script, the
2995 files will be included in the link at the point at which the linker
2996 script file is included.  This can affect archive searching.
2997
2998 @item GROUP(@var{file}, @var{file}, @dots{})
2999 @itemx GROUP(@var{file} @var{file} @dots{})
3000 @kindex GROUP(@var{files})
3001 @cindex grouping input files
3002 The @code{GROUP} command is like @code{INPUT}, except that the named
3003 files should all be archives, and they are searched repeatedly until no
3004 new undefined references are created.  See the description of @samp{-(}
3005 in @ref{Options,,Command Line Options}.
3006
3007 @item AS_NEEDED(@var{file}, @var{file}, @dots{})
3008 @itemx AS_NEEDED(@var{file} @var{file} @dots{})
3009 @kindex AS_NEEDED(@var{files})
3010 This construct can appear only inside of the @code{INPUT} or @code{GROUP}
3011 commands, among other filenames.  The files listed will be handled
3012 as if they appear directly in the @code{INPUT} or @code{GROUP} commands,
3013 with the exception of ELF shared libraries, that will be added only
3014 when they are actually needed.  This construct essentially enables
3015 @option{--as-needed} option for all the files listed inside of it
3016 and restores previous @option{--as-needed} resp. @option{--no-as-needed}
3017 setting afterwards.
3018
3019 @item OUTPUT(@var{filename})
3020 @kindex OUTPUT(@var{filename})
3021 @cindex output file name in linker script
3022 The @code{OUTPUT} command names the output file.  Using
3023 @code{OUTPUT(@var{filename})} in the linker script is exactly like using
3024 @samp{-o @var{filename}} on the command line (@pxref{Options,,Command
3025 Line Options}).  If both are used, the command line option takes
3026 precedence.
3027
3028 You can use the @code{OUTPUT} command to define a default name for the
3029 output file other than the usual default of @file{a.out}.
3030
3031 @item SEARCH_DIR(@var{path})
3032 @kindex SEARCH_DIR(@var{path})
3033 @cindex library search path in linker script
3034 @cindex archive search path in linker script
3035 @cindex search path in linker script
3036 The @code{SEARCH_DIR} command adds @var{path} to the list of paths where
3037 @command{ld} looks for archive libraries.  Using
3038 @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}}
3039 on the command line (@pxref{Options,,Command Line Options}).  If both
3040 are used, then the linker will search both paths.  Paths specified using
3041 the command line option are searched first.
3042
3043 @item STARTUP(@var{filename})
3044 @kindex STARTUP(@var{filename})
3045 @cindex first input file
3046 The @code{STARTUP} command is just like the @code{INPUT} command, except
3047 that @var{filename} will become the first input file to be linked, as
3048 though it were specified first on the command line.  This may be useful
3049 when using a system in which the entry point is always the start of the
3050 first file.
3051 @end table
3052
3053 @ifclear SingleFormat
3054 @node Format Commands
3055 @subsection Commands Dealing with Object File Formats
3056 A couple of linker script commands deal with object file formats.
3057
3058 @table @code
3059 @item OUTPUT_FORMAT(@var{bfdname})
3060 @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little})
3061 @kindex OUTPUT_FORMAT(@var{bfdname})
3062 @cindex output file format in linker script
3063 The @code{OUTPUT_FORMAT} command names the BFD format to use for the
3064 output file (@pxref{BFD}).  Using @code{OUTPUT_FORMAT(@var{bfdname})} is
3065 exactly like using @samp{--oformat @var{bfdname}} on the command line
3066 (@pxref{Options,,Command Line Options}).  If both are used, the command
3067 line option takes precedence.
3068
3069 You can use @code{OUTPUT_FORMAT} with three arguments to use different
3070 formats based on the @samp{-EB} and @samp{-EL} command line options.
3071 This permits the linker script to set the output format based on the
3072 desired endianness.
3073
3074 If neither @samp{-EB} nor @samp{-EL} are used, then the output format
3075 will be the first argument, @var{default}.  If @samp{-EB} is used, the
3076 output format will be the second argument, @var{big}.  If @samp{-EL} is
3077 used, the output format will be the third argument, @var{little}.
3078
3079 For example, the default linker script for the MIPS ELF target uses this
3080 command:
3081 @smallexample
3082 OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
3083 @end smallexample
3084 This says that the default format for the output file is
3085 @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line
3086 option, the output file will be created in the @samp{elf32-littlemips}
3087 format.
3088
3089 @item TARGET(@var{bfdname})
3090 @kindex TARGET(@var{bfdname})
3091 @cindex input file format in linker script
3092 The @code{TARGET} command names the BFD format to use when reading input
3093 files.  It affects subsequent @code{INPUT} and @code{GROUP} commands.
3094 This command is like using @samp{-b @var{bfdname}} on the command line
3095 (@pxref{Options,,Command Line Options}).  If the @code{TARGET} command
3096 is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET}
3097 command is also used to set the format for the output file.  @xref{BFD}.
3098 @end table
3099 @end ifclear
3100
3101 @node REGION_ALIAS
3102 @subsection Assign alias names to memory regions
3103 @kindex REGION_ALIAS(@var{alias}, @var{region})
3104 @cindex region alias
3105 @cindex region names
3106
3107 Alias names can be added to existing memory regions created with the
3108 @ref{MEMORY} command.  Each name corresponds to at most one memory region.
3109
3110 @smallexample
3111 REGION_ALIAS(@var{alias}, @var{region})
3112 @end smallexample
3113
3114 The @code{REGION_ALIAS} function creates an alias name @var{alias} for the
3115 memory region @var{region}.  This allows a flexible mapping of output sections
3116 to memory regions.  An example follows.
3117
3118 Suppose we have an application for embedded systems which come with various
3119 memory storage devices.  All have a general purpose, volatile memory @code{RAM}
3120 that allows code execution or data storage.  Some may have a read-only,
3121 non-volatile memory @code{ROM} that allows code execution and read-only data
3122 access.  The last variant is a read-only, non-volatile memory @code{ROM2} with
3123 read-only data access and no code execution capability.  We have four output
3124 sections:
3125
3126 @itemize @bullet
3127 @item
3128 @code{.text} program code;
3129 @item
3130 @code{.rodata} read-only data;
3131 @item
3132 @code{.data} read-write initialized data;
3133 @item
3134 @code{.bss} read-write zero initialized data.
3135 @end itemize
3136
3137 The goal is to provide a linker command file that contains a system independent
3138 part defining the output sections and a system dependent part mapping the
3139 output sections to the memory regions available on the system.  Our embedded
3140 systems come with three different memory setups @code{A}, @code{B} and
3141 @code{C}:
3142 @multitable @columnfractions .25 .25 .25 .25
3143 @item Section @tab Variant A @tab Variant B @tab Variant C
3144 @item .text @tab RAM @tab ROM @tab ROM 
3145 @item .rodata @tab RAM @tab ROM @tab ROM2
3146 @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2
3147 @item .bss @tab RAM @tab RAM @tab RAM
3148 @end multitable
3149 The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is
3150 loaded into region @code{ROM} or @code{ROM2} respectively.  Please note that
3151 the load address of the @code{.data} section starts in all three variants at
3152 the end of the @code{.rodata} section.
3153
3154 The base linker script that deals with the output sections follows.  It
3155 includes the system dependent @code{linkcmds.memory} file that describes the
3156 memory layout:
3157 @smallexample
3158 INCLUDE linkcmds.memory
3159
3160 SECTIONS
3161   @{
3162     .text :
3163       @{
3164         *(.text)
3165       @} > REGION_TEXT
3166     .rodata :
3167       @{
3168         *(.rodata)
3169         rodata_end = .;
3170       @} > REGION_RODATA
3171     .data : AT (rodata_end)
3172       @{
3173         data_start = .;
3174         *(.data)
3175       @} > REGION_DATA
3176     data_size = SIZEOF(.data);
3177     data_load_start = LOADADDR(.data);
3178     .bss :
3179       @{
3180         *(.bss)
3181       @} > REGION_BSS
3182   @}
3183 @end smallexample
3184
3185 Now we need three different @code{linkcmds.memory} files to define memory
3186 regions and alias names.  The content of @code{linkcmds.memory} for the three
3187 variants @code{A}, @code{B} and @code{C}:
3188 @table @code
3189 @item A
3190 Here everything goes into the @code{RAM}.
3191 @smallexample
3192 MEMORY
3193   @{
3194     RAM : ORIGIN = 0, LENGTH = 4M
3195   @}
3196
3197 REGION_ALIAS("REGION_TEXT", RAM);
3198 REGION_ALIAS("REGION_RODATA", RAM);
3199 REGION_ALIAS("REGION_DATA", RAM);
3200 REGION_ALIAS("REGION_BSS", RAM);
3201 @end smallexample
3202 @item B
3203 Program code and read-only data go into the @code{ROM}.  Read-write data goes
3204 into the @code{RAM}.  An image of the initialized data is loaded into the
3205 @code{ROM} and will be copied during system start into the @code{RAM}.
3206 @smallexample
3207 MEMORY
3208   @{
3209     ROM : ORIGIN = 0, LENGTH = 3M
3210     RAM : ORIGIN = 0x10000000, LENGTH = 1M
3211   @}
3212
3213 REGION_ALIAS("REGION_TEXT", ROM);
3214 REGION_ALIAS("REGION_RODATA", ROM);
3215 REGION_ALIAS("REGION_DATA", RAM);
3216 REGION_ALIAS("REGION_BSS", RAM);
3217 @end smallexample
3218 @item C
3219 Program code goes into the @code{ROM}.  Read-only data goes into the
3220 @code{ROM2}.  Read-write data goes into the @code{RAM}.  An image of the
3221 initialized data is loaded into the @code{ROM2} and will be copied during
3222 system start into the @code{RAM}.
3223 @smallexample
3224 MEMORY
3225   @{
3226     ROM : ORIGIN = 0, LENGTH = 2M
3227     ROM2 : ORIGIN = 0x10000000, LENGTH = 1M
3228     RAM : ORIGIN = 0x20000000, LENGTH = 1M
3229   @}
3230
3231 REGION_ALIAS("REGION_TEXT", ROM);
3232 REGION_ALIAS("REGION_RODATA", ROM2);
3233 REGION_ALIAS("REGION_DATA", RAM);
3234 REGION_ALIAS("REGION_BSS", RAM);
3235 @end smallexample
3236 @end table
3237
3238 It is possible to write a common system initialization routine to copy the
3239 @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if
3240 necessary:
3241 @smallexample
3242 #include <string.h>
3243
3244 extern char data_start [];
3245 extern char data_size [];
3246 extern char data_load_start [];
3247
3248 void copy_data(void)
3249 @{
3250   if (data_start != data_load_start)
3251     @{
3252       memcpy(data_start, data_load_start, (size_t) data_size);
3253     @}
3254 @}
3255 @end smallexample
3256
3257 @node Miscellaneous Commands
3258 @subsection Other Linker Script Commands
3259 There are a few other linker scripts commands.
3260
3261 @table @code
3262 @item ASSERT(@var{exp}, @var{message})
3263 @kindex ASSERT
3264 @cindex assertion in linker script
3265 Ensure that @var{exp} is non-zero.  If it is zero, then exit the linker
3266 with an error code, and print @var{message}.
3267
3268 @item EXTERN(@var{symbol} @var{symbol} @dots{})
3269 @kindex EXTERN
3270 @cindex undefined symbol in linker script
3271 Force @var{symbol} to be entered in the output file as an undefined
3272 symbol.  Doing this may, for example, trigger linking of additional
3273 modules from standard libraries.  You may list several @var{symbol}s for
3274 each @code{EXTERN}, and you may use @code{EXTERN} multiple times.  This
3275 command has the same effect as the @samp{-u} command-line option.
3276
3277 @item FORCE_COMMON_ALLOCATION
3278 @kindex FORCE_COMMON_ALLOCATION
3279 @cindex common allocation in linker script
3280 This command has the same effect as the @samp{-d} command-line option:
3281 to make @command{ld} assign space to common symbols even if a relocatable
3282 output file is specified (@samp{-r}).
3283
3284 @item INHIBIT_COMMON_ALLOCATION
3285 @kindex INHIBIT_COMMON_ALLOCATION
3286 @cindex common allocation in linker script
3287 This command has the same effect as the @samp{--no-define-common}
3288 command-line option: to make @code{ld} omit the assignment of addresses
3289 to common symbols even for a non-relocatable output file.
3290
3291 @item INSERT [ AFTER | BEFORE ] @var{output_section}
3292 @kindex INSERT
3293 @cindex insert user script into default script
3294 This command is typically used in a script specified by @samp{-T} to
3295 augment the default @code{SECTIONS} with, for example, overlays.  It
3296 inserts all prior linker script statements after (or before)
3297 @var{output_section}, and also causes @samp{-T} to not override the
3298 default linker script.  The exact insertion point is as for orphan
3299 sections.  @xref{Location Counter}.  The insertion happens after the
3300 linker has mapped input sections to output sections.  Prior to the
3301 insertion, since @samp{-T} scripts are parsed before the default
3302 linker script, statements in the @samp{-T} script occur before the
3303 default linker script statements in the internal linker representation
3304 of the script.  In particular, input section assignments will be made
3305 to @samp{-T} output sections before those in the default script.  Here
3306 is an example of how a @samp{-T} script using @code{INSERT} might look:
3307
3308 @smallexample
3309 SECTIONS
3310 @{
3311   OVERLAY :
3312   @{
3313     .ov1 @{ ov1*(.text) @}
3314     .ov2 @{ ov2*(.text) @}
3315   @}
3316 @}
3317 INSERT AFTER .text;
3318 @end smallexample
3319
3320 @item NOCROSSREFS(@var{section} @var{section} @dots{})
3321 @kindex NOCROSSREFS(@var{sections})
3322 @cindex cross references
3323 This command may be used to tell @command{ld} to issue an error about any
3324 references among certain output sections.
3325
3326 In certain types of programs, particularly on embedded systems when
3327 using overlays, when one section is loaded into memory, another section
3328 will not be.  Any direct references between the two sections would be
3329 errors.  For example, it would be an error if code in one section called
3330 a function defined in the other section.
3331
3332 The @code{NOCROSSREFS} command takes a list of output section names.  If
3333 @command{ld} detects any cross references between the sections, it reports
3334 an error and returns a non-zero exit status.  Note that the
3335 @code{NOCROSSREFS} command uses output section names, not input section
3336 names.
3337
3338 @ifclear SingleFormat
3339 @item OUTPUT_ARCH(@var{bfdarch})
3340 @kindex OUTPUT_ARCH(@var{bfdarch})
3341 @cindex machine architecture
3342 @cindex architecture
3343 Specify a particular output machine architecture.  The argument is one
3344 of the names used by the BFD library (@pxref{BFD}).  You can see the
3345 architecture of an object file by using the @code{objdump} program with
3346 the @samp{-f} option.
3347 @end ifclear
3348
3349 @item LD_FEATURE(@var{string})
3350 @kindex LD_FEATURE(@var{string})
3351 This command may be used to modify @command{ld} behavior.  If
3352 @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers
3353 in a script are simply treated as numbers everywhere.
3354 @xref{Expression Section}.
3355 @end table
3356
3357 @node Assignments
3358 @section Assigning Values to Symbols
3359 @cindex assignment in scripts
3360 @cindex symbol definition, scripts
3361 @cindex variables, defining
3362 You may assign a value to a symbol in a linker script.  This will define
3363 the symbol and place it into the symbol table with a global scope.
3364
3365 @menu
3366 * Simple Assignments::          Simple Assignments
3367 * PROVIDE::                     PROVIDE
3368 * PROVIDE_HIDDEN::              PROVIDE_HIDDEN
3369 * Source Code Reference::       How to use a linker script defined symbol in source code
3370 @end menu
3371
3372 @node Simple Assignments
3373 @subsection Simple Assignments
3374
3375 You may assign to a symbol using any of the C assignment operators:
3376
3377 @table @code
3378 @item @var{symbol} = @var{expression} ;
3379 @itemx @var{symbol} += @var{expression} ;
3380 @itemx @var{symbol} -= @var{expression} ;
3381 @itemx @var{symbol} *= @var{expression} ;
3382 @itemx @var{symbol} /= @var{expression} ;
3383 @itemx @var{symbol} <<= @var{expression} ;
3384 @itemx @var{symbol} >>= @var{expression} ;
3385 @itemx @var{symbol} &= @var{expression} ;
3386 @itemx @var{symbol} |= @var{expression} ;
3387 @end table
3388
3389 The first case will define @var{symbol} to the value of
3390 @var{expression}.  In the other cases, @var{symbol} must already be
3391 defined, and the value will be adjusted accordingly.
3392
3393 The special symbol name @samp{.} indicates the location counter.  You
3394 may only use this within a @code{SECTIONS} command.  @xref{Location Counter}.
3395
3396 The semicolon after @var{expression} is required.
3397
3398 Expressions are defined below; see @ref{Expressions}.
3399
3400 You may write symbol assignments as commands in their own right, or as
3401 statements within a @code{SECTIONS} command, or as part of an output
3402 section description in a @code{SECTIONS} command.
3403
3404 The section of the symbol will be set from the section of the
3405 expression; for more information, see @ref{Expression Section}.
3406
3407 Here is an example showing the three different places that symbol
3408 assignments may be used:
3409
3410 @smallexample
3411 floating_point = 0;
3412 SECTIONS
3413 @{
3414   .text :
3415     @{
3416       *(.text)
3417       _etext = .;
3418     @}
3419   _bdata = (. + 3) & ~ 3;
3420   .data : @{ *(.data) @}
3421 @}
3422 @end smallexample
3423 @noindent
3424 In this example, the symbol @samp{floating_point} will be defined as
3425 zero.  The symbol @samp{_etext} will be defined as the address following
3426 the last @samp{.text} input section.  The symbol @samp{_bdata} will be
3427 defined as the address following the @samp{.text} output section aligned
3428 upward to a 4 byte boundary.
3429
3430 @node PROVIDE
3431 @subsection PROVIDE
3432 @cindex PROVIDE
3433 In some cases, it is desirable for a linker script to define a symbol
3434 only if it is referenced and is not defined by any object included in
3435 the link.  For example, traditional linkers defined the symbol
3436 @samp{etext}.  However, ANSI C requires that the user be able to use
3437 @samp{etext} as a function name without encountering an error.  The
3438 @code{PROVIDE} keyword may be used to define a symbol, such as
3439 @samp{etext}, only if it is referenced but not defined.  The syntax is
3440 @code{PROVIDE(@var{symbol} = @var{expression})}.
3441
3442 Here is an example of using @code{PROVIDE} to define @samp{etext}:
3443 @smallexample
3444 SECTIONS
3445 @{
3446   .text :
3447     @{
3448       *(.text)
3449       _etext = .;
3450       PROVIDE(etext = .);
3451     @}
3452 @}
3453 @end smallexample
3454
3455 In this example, if the program defines @samp{_etext} (with a leading
3456 underscore), the linker will give a multiple definition error.  If, on
3457 the other hand, the program defines @samp{etext} (with no leading
3458 underscore), the linker will silently use the definition in the program.
3459 If the program references @samp{etext} but does not define it, the
3460 linker will use the definition in the linker script.
3461
3462 @node PROVIDE_HIDDEN
3463 @subsection PROVIDE_HIDDEN
3464 @cindex PROVIDE_HIDDEN
3465 Similar to @code{PROVIDE}.  For ELF targeted ports, the symbol will be
3466 hidden and won't be exported.
3467
3468 @node Source Code Reference
3469 @subsection Source Code Reference
3470
3471 Accessing a linker script defined variable from source code is not
3472 intuitive.  In particular a linker script symbol is not equivalent to
3473 a variable declaration in a high level language, it is instead a
3474 symbol that does not have a value.
3475
3476 Before going further, it is important to note that compilers often
3477 transform names in the source code into different names when they are
3478 stored in the symbol table.  For example, Fortran compilers commonly
3479 prepend or append an underscore, and C++ performs extensive @samp{name
3480 mangling}.  Therefore there might be a discrepancy between the name
3481 of a variable as it is used in source code and the name of the same
3482 variable as it is defined in a linker script.  For example in C a
3483 linker script variable might be referred to as:
3484
3485 @smallexample
3486   extern int foo;
3487 @end smallexample
3488
3489 But in the linker script it might be defined as:
3490
3491 @smallexample
3492   _foo = 1000;
3493 @end smallexample
3494
3495 In the remaining examples however it is assumed that no name
3496 transformation has taken place.
3497
3498 When a symbol is declared in a high level language such as C, two
3499 things happen.  The first is that the compiler reserves enough space
3500 in the program's memory to hold the @emph{value} of the symbol.  The
3501 second is that the compiler creates an entry in the program's symbol
3502 table which holds the symbol's @emph{address}.  ie the symbol table
3503 contains the address of the block of memory holding the symbol's
3504 value.  So for example the following C declaration, at file scope:
3505
3506 @smallexample
3507   int foo = 1000;
3508 @end smallexample
3509
3510 creates a entry called @samp{foo} in the symbol table.  This entry
3511 holds the address of an @samp{int} sized block of memory where the
3512 number 1000 is initially stored.
3513
3514 When a program references a symbol the compiler generates code that
3515 first accesses the symbol table to find the address of the symbol's
3516 memory block and then code to read the value from that memory block.
3517 So:
3518
3519 @smallexample
3520   foo = 1;
3521 @end smallexample
3522
3523 looks up the symbol @samp{foo} in the symbol table, gets the address
3524 associated with this symbol and then writes the value 1 into that
3525 address.  Whereas:
3526
3527 @smallexample
3528   int * a = & foo;
3529 @end smallexample
3530
3531 looks up the symbol @samp{foo} in the symbol table, gets it address
3532 and then copies this address into the block of memory associated with
3533 the variable @samp{a}.
3534
3535 Linker scripts symbol declarations, by contrast, create an entry in
3536 the symbol table but do not assign any memory to them.  Thus they are
3537 an address without a value.  So for example the linker script definition:
3538
3539 @smallexample
3540   foo = 1000;
3541 @end smallexample
3542
3543 creates an entry in the symbol table called @samp{foo} which holds
3544 the address of memory location 1000, but nothing special is stored at
3545 address 1000.  This means that you cannot access the @emph{value} of a
3546 linker script defined symbol - it has no value - all you can do is
3547 access the @emph{address} of a linker script defined symbol.
3548
3549 Hence when you are using a linker script defined symbol in source code
3550 you should always take the address of the symbol, and never attempt to
3551 use its value.  For example suppose you want to copy the contents of a
3552 section of memory called .ROM into a section called .FLASH and the
3553 linker script contains these declarations:
3554
3555 @smallexample
3556 @group
3557   start_of_ROM   = .ROM;
3558   end_of_ROM     = .ROM + sizeof (.ROM) - 1;
3559   start_of_FLASH = .FLASH;
3560 @end group
3561 @end smallexample
3562
3563 Then the C source code to perform the copy would be:
3564
3565 @smallexample
3566 @group
3567   extern char start_of_ROM, end_of_ROM, start_of_FLASH;
3568
3569   memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
3570 @end group
3571 @end smallexample
3572
3573 Note the use of the @samp{&} operators.  These are correct.
3574
3575 @node SECTIONS
3576 @section SECTIONS Command
3577 @kindex SECTIONS
3578 The @code{SECTIONS} command tells the linker how to map input sections
3579 into output sections, and how to place the output sections in memory.
3580
3581 The format of the @code{SECTIONS} command is:
3582 @smallexample
3583 SECTIONS
3584 @{
3585   @var{sections-command}
3586   @var{sections-command}
3587   @dots{}
3588 @}
3589 @end smallexample
3590
3591 Each @var{sections-command} may of be one of the following:
3592
3593 @itemize @bullet
3594 @item
3595 an @code{ENTRY} command (@pxref{Entry Point,,Entry command})
3596 @item
3597 a symbol assignment (@pxref{Assignments})
3598 @item
3599 an output section description
3600 @item
3601 an overlay description
3602 @end itemize
3603
3604 The @code{ENTRY} command and symbol assignments are permitted inside the
3605 @code{SECTIONS} command for convenience in using the location counter in
3606 those commands.  This can also make the linker script easier to
3607 understand because you can use those commands at meaningful points in
3608 the layout of the output file.
3609
3610 Output section descriptions and overlay descriptions are described
3611 below.
3612
3613 If you do not use a @code{SECTIONS} command in your linker script, the
3614 linker will place each input section into an identically named output
3615 section in the order that the sections are first encountered in the
3616 input files.  If all input sections are present in the first file, for
3617 example, the order of sections in the output file will match the order
3618 in the first input file.  The first section will be at address zero.
3619
3620 @menu
3621 * Output Section Description::  Output section description
3622 * Output Section Name::         Output section name
3623 * Output Section Address::      Output section address
3624 * Input Section::               Input section description
3625 * Output Section Data::         Output section data
3626 * Output Section Keywords::     Output section keywords
3627 * Output Section Discarding::   Output section discarding
3628 * Output Section Attributes::   Output section attributes
3629 * Overlay Description::         Overlay description
3630 @end menu
3631
3632 @node Output Section Description
3633 @subsection Output Section Description
3634 The full description of an output section looks like this:
3635 @smallexample
3636 @group
3637 @var{section} [@var{address}] [(@var{type})] :
3638   [AT(@var{lma})]
3639   [ALIGN(@var{section_align})]
3640   [SUBALIGN(@var{subsection_align})]
3641   [@var{constraint}]
3642   @{
3643     @var{output-section-command}
3644     @var{output-section-command}
3645     @dots{}
3646   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
3647 @end group
3648 @end smallexample
3649
3650 Most output sections do not use most of the optional section attributes.
3651
3652 The whitespace around @var{section} is required, so that the section
3653 name is unambiguous.  The colon and the curly braces are also required.
3654 The line breaks and other white space are optional.
3655
3656 Each @var{output-section-command} may be one of the following:
3657
3658 @itemize @bullet
3659 @item
3660 a symbol assignment (@pxref{Assignments})
3661 @item
3662 an input section description (@pxref{Input Section})
3663 @item
3664 data values to include directly (@pxref{Output Section Data})
3665 @item
3666 a special output section keyword (@pxref{Output Section Keywords})
3667 @end itemize
3668
3669 @node Output Section Name
3670 @subsection Output Section Name
3671 @cindex name, section
3672 @cindex section name
3673 The name of the output section is @var{section}.  @var{section} must
3674 meet the constraints of your output format.  In formats which only
3675 support a limited number of sections, such as @code{a.out}, the name
3676 must be one of the names supported by the format (@code{a.out}, for
3677 example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the
3678 output format supports any number of sections, but with numbers and not
3679 names (as is the case for Oasys), the name should be supplied as a
3680 quoted numeric string.  A section name may consist of any sequence of
3681 characters, but a name which contains any unusual characters such as
3682 commas must be quoted.
3683
3684 The output section name @samp{/DISCARD/} is special; @ref{Output Section
3685 Discarding}.
3686
3687 @node Output Section Address
3688 @subsection Output Section Address
3689 @cindex address, section
3690 @cindex section address
3691 The @var{address} is an expression for the VMA (the virtual memory
3692 address) of the output section.  This address is optional, but if it
3693 is provided then the output address will be set exactly as specified.
3694
3695 If the output address is not specified then one will be chosen for the
3696 section, based on the heuristic below.  This address will be adjusted
3697 to fit the alignment requirement of the output section.  The
3698 alignment requirement is the strictest alignment of any input section
3699 contained within the output section.
3700
3701 The output section address heuristic is as follows:
3702
3703 @itemize @bullet
3704 @item
3705 If an output memory @var{region} is set for the section then it
3706 is added to this region and its address will be the next free address
3707 in that region.
3708
3709 @item
3710 If the MEMORY command has been used to create a list of memory
3711 regions then the first region which has attributes compatible with the
3712 section is selected to contain it.  The section's output address will
3713 be the next free address in that region; @ref{MEMORY}.
3714
3715 @item
3716 If no memory regions were specified, or none match the section then
3717 the output address will be based on the current value of the location
3718 counter.
3719 @end itemize
3720
3721 @noindent
3722 For example:
3723
3724 @smallexample
3725 .text . : @{ *(.text) @}
3726 @end smallexample
3727
3728 @noindent
3729 and
3730
3731 @smallexample
3732 .text : @{ *(.text) @}
3733 @end smallexample
3734
3735 @noindent
3736 are subtly different.  The first will set the address of the
3737 @samp{.text} output section to the current value of the location
3738 counter.  The second will set it to the current value of the location
3739 counter aligned to the strictest alignment of any of the @samp{.text}
3740 input sections.
3741
3742 The @var{address} may be an arbitrary expression; @ref{Expressions}.
3743 For example, if you want to align the section on a 0x10 byte boundary,
3744 so that the lowest four bits of the section address are zero, you could
3745 do something like this:
3746 @smallexample
3747 .text ALIGN(0x10) : @{ *(.text) @}
3748 @end smallexample
3749 @noindent
3750 This works because @code{ALIGN} returns the current location counter
3751 aligned upward to the specified value.
3752
3753 Specifying @var{address} for a section will change the value of the
3754 location counter, provided that the section is non-empty.  (Empty
3755 sections are ignored).
3756
3757 @node Input Section
3758 @subsection Input Section Description
3759 @cindex input sections
3760 @cindex mapping input sections to output sections
3761 The most common output section command is an input section description.
3762
3763 The input section description is the most basic linker script operation.
3764 You use output sections to tell the linker how to lay out your program
3765 in memory.  You use input section descriptions to tell the linker how to
3766 map the input files into your memory layout.
3767
3768 @menu
3769 * Input Section Basics::        Input section basics
3770 * Input Section Wildcards::     Input section wildcard patterns
3771 * Input Section Common::        Input section for common symbols
3772 * Input Section Keep::          Input section and garbage collection
3773 * Input Section Example::       Input section example
3774 @end menu
3775
3776 @node Input Section Basics
3777 @subsubsection Input Section Basics
3778 @cindex input section basics
3779 An input section description consists of a file name optionally followed
3780 by a list of section names in parentheses.
3781
3782 The file name and the section name may be wildcard patterns, which we
3783 describe further below (@pxref{Input Section Wildcards}).
3784
3785 The most common input section description is to include all input
3786 sections with a particular name in the output section.  For example, to
3787 include all input @samp{.text} sections, you would write:
3788 @smallexample
3789 *(.text)
3790 @end smallexample
3791 @noindent
3792 Here the @samp{*} is a wildcard which matches any file name.  To exclude a list
3793 of files from matching the file name wildcard, EXCLUDE_FILE may be used to
3794 match all files except the ones specified in the EXCLUDE_FILE list.  For
3795 example:
3796 @smallexample
3797 *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)
3798 @end smallexample
3799 will cause all .ctors sections from all files except @file{crtend.o} and
3800 @file{otherfile.o} to be included.
3801
3802 There are two ways to include more than one section:
3803 @smallexample
3804 *(.text .rdata)
3805 *(.text) *(.rdata)
3806 @end smallexample
3807 @noindent
3808 The difference between these is the order in which the @samp{.text} and
3809 @samp{.rdata} input sections will appear in the output section.  In the
3810 first example, they will be intermingled, appearing in the same order as
3811 they are found in the linker input.  In the second example, all
3812 @samp{.text} input sections will appear first, followed by all
3813 @samp{.rdata} input sections.
3814
3815 You can specify a file name to include sections from a particular file.
3816 You would do this if one or more of your files contain special data that
3817 needs to be at a particular location in memory.  For example:
3818 @smallexample
3819 data.o(.data)
3820 @end smallexample
3821
3822 You can also specify files within archives by writing a pattern
3823 matching the archive, a colon, then the pattern matching the file,
3824 with no whitespace around the colon.
3825
3826 @table @samp
3827 @item archive:file
3828 matches file within archive
3829 @item archive:
3830 matches the whole archive
3831 @item :file
3832 matches file but not one in an archive
3833 @end table
3834
3835 Either one or both of @samp{archive} and @samp{file} can contain shell
3836 wildcards.  On DOS based file systems, the linker will assume that a
3837 single letter followed by a colon is a drive specifier, so
3838 @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o}
3839 within an archive called @samp{c}.  @samp{archive:file} filespecs may
3840 also be used within an @code{EXCLUDE_FILE} list, but may not appear in
3841 other linker script contexts.  For instance, you cannot extract a file
3842 from an archive by using @samp{archive:file} in an @code{INPUT}
3843 command.
3844
3845 If you use a file name without a list of sections, then all sections in
3846 the input file will be included in the output section.  This is not
3847 commonly done, but it may by useful on occasion.  For example:
3848 @smallexample
3849 data.o
3850 @end smallexample
3851
3852 When you use a file name which is not an @samp{archive:file} specifier
3853 and does not contain any wild card
3854 characters, the linker will first see if you also specified the file
3855 name on the linker command line or in an @code{INPUT} command.  If you
3856 did not, the linker will attempt to open the file as an input file, as
3857 though it appeared on the command line.  Note that this differs from an
3858 @code{INPUT} command, because the linker will not search for the file in
3859 the archive search path.
3860
3861 @node Input Section Wildcards
3862 @subsubsection Input Section Wildcard Patterns
3863 @cindex input section wildcards
3864 @cindex wildcard file name patterns
3865 @cindex file name wildcard patterns
3866 @cindex section name wildcard patterns
3867 In an input section description, either the file name or the section
3868 name or both may be wildcard patterns.
3869
3870 The file name of @samp{*} seen in many examples is a simple wildcard
3871 pattern for the file name.
3872
3873 The wildcard patterns are like those used by the Unix shell.
3874
3875 @table @samp
3876 @item *
3877 matches any number of characters
3878 @item ?
3879 matches any single character
3880 @item [@var{chars}]
3881 matches a single instance of any of the @var{chars}; the @samp{-}
3882 character may be used to specify a range of characters, as in
3883 @samp{[a-z]} to match any lower case letter
3884 @item \
3885 quotes the following character
3886 @end table
3887
3888 When a file name is matched with a wildcard, the wildcard characters
3889 will not match a @samp{/} character (used to separate directory names on
3890 Unix).  A pattern consisting of a single @samp{*} character is an
3891 exception; it will always match any file name, whether it contains a
3892 @samp{/} or not.  In a section name, the wildcard characters will match
3893 a @samp{/} character.
3894
3895 File name wildcard patterns only match files which are explicitly
3896 specified on the command line or in an @code{INPUT} command.  The linker
3897 does not search directories to expand wildcards.
3898
3899 If a file name matches more than one wildcard pattern, or if a file name
3900 appears explicitly and is also matched by a wildcard pattern, the linker
3901 will use the first match in the linker script.  For example, this
3902 sequence of input section descriptions is probably in error, because the
3903 @file{data.o} rule will not be used:
3904 @smallexample
3905 .data : @{ *(.data) @}
3906 .data1 : @{ data.o(.data) @}
3907 @end smallexample
3908
3909 @cindex SORT_BY_NAME
3910 Normally, the linker will place files and sections matched by wildcards
3911 in the order in which they are seen during the link.  You can change
3912 this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard
3913 pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}).  When the
3914 @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections
3915 into ascending order by name before placing them in the output file.
3916
3917 @cindex SORT_BY_ALIGNMENT
3918 @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The
3919 difference is @code{SORT_BY_ALIGNMENT} will sort sections into
3920 ascending order by alignment before placing them in the output file.
3921
3922 @cindex SORT
3923 @code{SORT} is an alias for @code{SORT_BY_NAME}.
3924
3925 When there are nested section sorting commands in linker script, there
3926 can be at most 1 level of nesting for section sorting commands.
3927
3928 @enumerate
3929 @item
3930 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
3931 It will sort the input sections by name first, then by alignment if 2
3932 sections have the same name.
3933 @item
3934 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
3935 It will sort the input sections by alignment first, then by name if 2
3936 sections have the same alignment.
3937 @item
3938 @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is
3939 treated the same as @code{SORT_BY_NAME} (wildcard section pattern).
3940 @item
3941 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern))
3942 is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern).
3943 @item
3944 All other nested section sorting commands are invalid.
3945 @end enumerate
3946
3947 When both command line section sorting option and linker script
3948 section sorting command are used, section sorting command always
3949 takes precedence over the command line option.
3950
3951 If the section sorting command in linker script isn't nested, the
3952 command line option will make the section sorting command to be
3953 treated as nested sorting command.
3954
3955 @enumerate
3956 @item
3957 @code{SORT_BY_NAME} (wildcard section pattern ) with
3958 @option{--sort-sections alignment} is equivalent to
3959 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
3960 @item
3961 @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with
3962 @option{--sort-section name} is equivalent to
3963 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
3964 @end enumerate
3965
3966 If the section sorting command in linker script is nested, the
3967 command line option will be ignored.
3968
3969 If you ever get confused about where input sections are going, use the
3970 @samp{-M} linker option to generate a map file.  The map file shows
3971 precisely how input sections are mapped to output sections.
3972
3973 This example shows how wildcard patterns might be used to partition
3974 files.  This linker script directs the linker to place all @samp{.text}
3975 sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}.
3976 The linker will place the @samp{.data} section from all files beginning
3977 with an upper case character in @samp{.DATA}; for all other files, the
3978 linker will place the @samp{.data} section in @samp{.data}.
3979 @smallexample
3980 @group
3981 SECTIONS @{
3982   .text : @{ *(.text) @}
3983   .DATA : @{ [A-Z]*(.data) @}
3984   .data : @{ *(.data) @}
3985   .bss : @{ *(.bss) @}
3986 @}
3987 @end group
3988 @end smallexample
3989
3990 @node Input Section Common
3991 @subsubsection Input Section for Common Symbols
3992 @cindex common symbol placement
3993 @cindex uninitialized data placement
3994 A special notation is needed for common symbols, because in many object
3995 file formats common symbols do not have a particular input section.  The
3996 linker treats common symbols as though they are in an input section
3997 named @samp{COMMON}.
3998
3999 You may use file names with the @samp{COMMON} section just as with any
4000 other input sections.  You can use this to place common symbols from a
4001 particular input file in one section while common symbols from other
4002 input files are placed in another section.
4003
4004 In most cases, common symbols in input files will be placed in the
4005 @samp{.bss} section in the output file.  For example:
4006 @smallexample
4007 .bss @{ *(.bss) *(COMMON) @}
4008 @end smallexample
4009
4010 @cindex scommon section
4011 @cindex small common symbols
4012 Some object file formats have more than one type of common symbol.  For
4013 example, the MIPS ELF object file format distinguishes standard common
4014 symbols and small common symbols.  In this case, the linker will use a
4015 different special section name for other types of common symbols.  In
4016 the case of MIPS ELF, the linker uses @samp{COMMON} for standard common
4017 symbols and @samp{.scommon} for small common symbols.  This permits you
4018 to map the different types of common symbols into memory at different
4019 locations.
4020
4021 @cindex [COMMON]
4022 You will sometimes see @samp{[COMMON]} in old linker scripts.  This
4023 notation is now considered obsolete.  It is equivalent to
4024 @samp{*(COMMON)}.
4025
4026 @node Input Section Keep
4027 @subsubsection Input Section and Garbage Collection
4028 @cindex KEEP
4029 @cindex garbage collection
4030 When link-time garbage collection is in use (@samp{--gc-sections}),
4031 it is often useful to mark sections that should not be eliminated.
4032 This is accomplished by surrounding an input section's wildcard entry
4033 with @code{KEEP()}, as in @code{KEEP(*(.init))} or
4034 @code{KEEP(SORT_BY_NAME(*)(.ctors))}.
4035
4036 @node Input Section Example
4037 @subsubsection Input Section Example
4038 The following example is a complete linker script.  It tells the linker
4039 to read all of the sections from file @file{all.o} and place them at the
4040 start of output section @samp{outputa} which starts at location
4041 @samp{0x10000}.  All of section @samp{.input1} from file @file{foo.o}
4042 follows immediately, in the same output section.  All of section
4043 @samp{.input2} from @file{foo.o} goes into output section
4044 @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}.
4045 All of the remaining @samp{.input1} and @samp{.input2} sections from any
4046 files are written to output section @samp{outputc}.
4047
4048 @smallexample
4049 @group
4050 SECTIONS @{
4051   outputa 0x10000 :
4052     @{
4053     all.o
4054     foo.o (.input1)
4055     @}
4056 @end group
4057 @group
4058   outputb :
4059     @{
4060     foo.o (.input2)
4061     foo1.o (.input1)
4062     @}
4063 @end group
4064 @group
4065   outputc :
4066     @{
4067     *(.input1)
4068     *(.input2)
4069     @}
4070 @}
4071 @end group
4072 @end smallexample
4073
4074 @node Output Section Data
4075 @subsection Output Section Data
4076 @cindex data
4077 @cindex section data
4078 @cindex output section data
4079 @kindex BYTE(@var{expression})
4080 @kindex SHORT(@var{expression})
4081 @kindex LONG(@var{expression})
4082 @kindex QUAD(@var{expression})
4083 @kindex SQUAD(@var{expression})
4084 You can include explicit bytes of data in an output section by using
4085 @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as
4086 an output section command.  Each keyword is followed by an expression in
4087 parentheses providing the value to store (@pxref{Expressions}).  The
4088 value of the expression is stored at the current value of the location
4089 counter.
4090
4091 The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands
4092 store one, two, four, and eight bytes (respectively).  After storing the
4093 bytes, the location counter is incremented by the number of bytes
4094 stored.
4095
4096 For example, this will store the byte 1 followed by the four byte value
4097 of the symbol @samp{addr}:
4098 @smallexample
4099 BYTE(1)
4100 LONG(addr)
4101 @end smallexample
4102
4103 When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the
4104 same; they both store an 8 byte, or 64 bit, value.  When both host and
4105 target are 32 bits, an expression is computed as 32 bits.  In this case
4106 @code{QUAD} stores a 32 bit value zero extended to 64 bits, and
4107 @code{SQUAD} stores a 32 bit value sign extended to 64 bits.
4108
4109 If the object file format of the output file has an explicit endianness,
4110 which is the normal case, the value will be stored in that endianness.
4111 When the object file format does not have an explicit endianness, as is
4112 true of, for example, S-records, the value will be stored in the
4113 endianness of the first input object file.
4114
4115 Note---these commands only work inside a section description and not
4116 between them, so the following will produce an error from the linker:
4117 @smallexample
4118 SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
4119 @end smallexample
4120 whereas this will work:
4121 @smallexample
4122 SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@
4123 @end smallexample
4124
4125 @kindex FILL(@var{expression})
4126 @cindex holes, filling
4127 @cindex unspecified memory
4128 You may use the @code{FILL} command to set the fill pattern for the
4129 current section.  It is followed by an expression in parentheses.  Any
4130 otherwise unspecified regions of memory within the section (for example,
4131 gaps left due to the required alignment of input sections) are filled
4132 with the value of the expression, repeated as
4133 necessary.  A @code{FILL} statement covers memory locations after the
4134 point at which it occurs in the section definition; by including more
4135 than one @code{FILL} statement, you can have different fill patterns in
4136 different parts of an output section.
4137
4138 This example shows how to fill unspecified regions of memory with the
4139 value @samp{0x90}:
4140 @smallexample
4141 FILL(0x90909090)
4142 @end smallexample
4143
4144 The @code{FILL} command is similar to the @samp{=@var{fillexp}} output
4145 section attribute, but it only affects the
4146 part of the section following the @code{FILL} command, rather than the
4147 entire section.  If both are used, the @code{FILL} command takes
4148 precedence.  @xref{Output Section Fill}, for details on the fill
4149 expression.
4150
4151 @node Output Section Keywords
4152 @subsection Output Section Keywords
4153 There are a couple of keywords which can appear as output section
4154 commands.
4155
4156 @table @code
4157 @kindex CREATE_OBJECT_SYMBOLS
4158 @cindex input filename symbols
4159 @cindex filename symbols
4160 @item CREATE_OBJECT_SYMBOLS
4161 The command tells the linker to create a symbol for each input file.
4162 The name of each symbol will be the name of the corresponding input
4163 file.  The section of each symbol will be the output section in which
4164 the @code{CREATE_OBJECT_SYMBOLS} command appears.
4165
4166 This is conventional for the a.out object file format.  It is not
4167 normally used for any other object file format.
4168
4169 @kindex CONSTRUCTORS
4170 @cindex C++ constructors, arranging in link
4171 @cindex constructors, arranging in link
4172 @item CONSTRUCTORS
4173 When linking using the a.out object file format, the linker uses an
4174 unusual set construct to support C++ global constructors and
4175 destructors.  When linking object file formats which do not support
4176 arbitrary sections, such as ECOFF and XCOFF, the linker will
4177 automatically recognize C++ global constructors and destructors by name.
4178 For these object file formats, the @code{CONSTRUCTORS} command tells the
4179 linker to place constructor information in the output section where the
4180 @code{CONSTRUCTORS} command appears.  The @code{CONSTRUCTORS} command is
4181 ignored for other object file formats.
4182
4183 The symbol @w{@code{__CTOR_LIST__}} marks the start of the global
4184 constructors, and the symbol @w{@code{__CTOR_END__}} marks the end.
4185 Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark
4186 the start and end of the global destructors.  The
4187 first word in the list is the number of entries, followed by the address
4188 of each constructor or destructor, followed by a zero word.  The
4189 compiler must arrange to actually run the code.  For these object file
4190 formats @sc{gnu} C++ normally calls constructors from a subroutine
4191 @code{__main}; a call to @code{__main} is automatically inserted into
4192 the startup code for @code{main}.  @sc{gnu} C++ normally runs
4193 destructors either by using @code{atexit}, or directly from the function
4194 @code{exit}.
4195
4196 For object file formats such as @code{COFF} or @code{ELF} which support
4197 arbitrary section names, @sc{gnu} C++ will normally arrange to put the
4198 addresses of global constructors and destructors into the @code{.ctors}
4199 and @code{.dtors} sections.  Placing the following sequence into your
4200 linker script will build the sort of table which the @sc{gnu} C++
4201 runtime code expects to see.
4202
4203 @smallexample
4204       __CTOR_LIST__ = .;
4205       LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2)
4206       *(.ctors)
4207       LONG(0)
4208       __CTOR_END__ = .;
4209       __DTOR_LIST__ = .;
4210       LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2)
4211       *(.dtors)
4212       LONG(0)
4213       __DTOR_END__ = .;
4214 @end smallexample
4215
4216 If you are using the @sc{gnu} C++ support for initialization priority,
4217 which provides some control over the order in which global constructors
4218 are run, you must sort the constructors at link time to ensure that they
4219 are executed in the correct order.  When using the @code{CONSTRUCTORS}
4220 command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead.  When using the
4221 @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and
4222 @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and
4223 @samp{*(.dtors)}.
4224
4225 Normally the compiler and linker will handle these issues automatically,
4226 and you will not need to concern yourself with them.  However, you may
4227 need to consider this if you are using C++ and writing your own linker
4228 scripts.
4229
4230 @end table
4231
4232 @node Output Section Discarding
4233 @subsection Output Section Discarding
4234 @cindex discarding sections
4235 @cindex sections, discarding
4236 @cindex removing sections
4237 The linker will not create output sections with no contents.  This is
4238 for convenience when referring to input sections that may or may not
4239 be present in any of the input files.  For example:
4240 @smallexample
4241 .foo : @{ *(.foo) @}
4242 @end smallexample
4243 @noindent
4244 will only create a @samp{.foo} section in the output file if there is a
4245 @samp{.foo} section in at least one input file, and if the input
4246 sections are not all empty.  Other link script directives that allocate
4247 space in an output section will also create the output section.
4248
4249 The linker will ignore address assignments (@pxref{Output Section Address})
4250 on discarded output sections, except when the linker script defines
4251 symbols in the output section.  In that case the linker will obey
4252 the address assignments, possibly advancing dot even though the
4253 section is discarded.
4254
4255 @cindex /DISCARD/
4256 The special output section name @samp{/DISCARD/} may be used to discard
4257 input sections.  Any input sections which are assigned to an output
4258 section named @samp{/DISCARD/} are not included in the output file.
4259
4260 @node Output Section Attributes
4261 @subsection Output Section Attributes
4262 @cindex output section attributes
4263 We showed above that the full description of an output section looked
4264 like this:
4265
4266 @smallexample
4267 @group
4268 @var{section} [@var{address}] [(@var{type})] :
4269   [AT(@var{lma})]
4270   [ALIGN(@var{section_align})]
4271   [SUBALIGN(@var{subsection_align})]
4272   [@var{constraint}]
4273   @{
4274     @var{output-section-command}
4275     @var{output-section-command}
4276     @dots{}
4277   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
4278 @end group
4279 @end smallexample
4280
4281 We've already described @var{section}, @var{address}, and
4282 @var{output-section-command}.  In this section we will describe the
4283 remaining section attributes.
4284
4285 @menu
4286 * Output Section Type::         Output section type
4287 * Output Section LMA::          Output section LMA
4288 * Forced Output Alignment::     Forced Output Alignment
4289 * Forced Input Alignment::      Forced Input Alignment
4290 * Output Section Constraint::   Output section constraint
4291 * Output Section Region::       Output section region
4292 * Output Section Phdr::         Output section phdr
4293 * Output Section Fill::         Output section fill
4294 @end menu
4295
4296 @node Output Section Type
4297 @subsubsection Output Section Type
4298 Each output section may have a type.  The type is a keyword in
4299 parentheses.  The following types are defined:
4300
4301 @table @code
4302 @item NOLOAD
4303 The section should be marked as not loadable, so that it will not be
4304 loaded into memory when the program is run.
4305 @item DSECT
4306 @itemx COPY
4307 @itemx INFO
4308 @itemx OVERLAY
4309 These type names are supported for backward compatibility, and are
4310 rarely used.  They all have the same effect: the section should be
4311 marked as not allocatable, so that no memory is allocated for the
4312 section when the program is run.
4313 @end table
4314
4315 @kindex NOLOAD
4316 @cindex prevent unnecessary loading
4317 @cindex loading, preventing
4318 The linker normally sets the attributes of an output section based on
4319 the input sections which map into it.  You can override this by using
4320 the section type.  For example, in the script sample below, the
4321 @samp{ROM} section is addressed at memory location @samp{0} and does not
4322 need to be loaded when the program is run.
4323 @smallexample
4324 @group
4325 SECTIONS @{
4326   ROM 0 (NOLOAD) : @{ @dots{} @}
4327   @dots{}
4328 @}
4329 @end group
4330 @end smallexample
4331
4332 @node Output Section LMA
4333 @subsubsection Output Section LMA
4334 @kindex AT>@var{lma_region}
4335 @kindex AT(@var{lma})
4336 @cindex load address
4337 @cindex section load address
4338 Every section has a virtual address (VMA) and a load address (LMA); see
4339 @ref{Basic Script Concepts}.  The virtual address is specified by the
4340 @pxref{Output Section Address} described earlier.  The load address is
4341 specified by the @code{AT} or @code{AT>} keywords.  Specifying a load
4342 address is optional.
4343
4344 The @code{AT} keyword takes an expression as an argument.  This
4345 specifies the exact load address of the section.  The @code{AT>} keyword
4346 takes the name of a memory region as an argument.  @xref{MEMORY}.  The
4347 load address of the section is set to the next free address in the
4348 region, aligned to the section's alignment requirements.
4349
4350 If neither @code{AT} nor @code{AT>} is specified for an allocatable
4351 section, the linker will use the following heuristic to determine the
4352 load address:
4353
4354 @itemize @bullet
4355 @item
4356 If the section has a specific VMA address, then this is used as
4357 the LMA address as well.
4358
4359 @item
4360 If the section is not allocatable then its LMA is set to its VMA.
4361
4362 @item
4363 Otherwise if a memory region can be found that is compatible
4364 with the current section, and this region contains at least one
4365 section, then the LMA is set so the difference between the
4366 VMA and LMA is the same as the difference between the VMA and LMA of
4367 the last section in the located region.
4368
4369 @item
4370 If no memory regions have been declared then a default region
4371 that covers the entire address space is used in the previous step.
4372
4373 @item
4374 If no suitable region could be found, or there was no previous
4375 section then the LMA is set equal to the VMA.
4376 @end itemize
4377
4378 @cindex ROM initialized data
4379 @cindex initialized data in ROM
4380 This feature is designed to make it easy to build a ROM image.  For
4381 example, the following linker script creates three output sections: one
4382 called @samp{.text}, which starts at @code{0x1000}, one called
4383 @samp{.mdata}, which is loaded at the end of the @samp{.text} section
4384 even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold
4385 uninitialized data at address @code{0x3000}.  The symbol @code{_data} is
4386 defined with the value @code{0x2000}, which shows that the location
4387 counter holds the VMA value, not the LMA value.
4388
4389 @smallexample
4390 @group
4391 SECTIONS
4392   @{
4393   .text 0x1000 : @{ *(.text) _etext = . ; @}
4394   .mdata 0x2000 :
4395     AT ( ADDR (.text) + SIZEOF (.text) )
4396     @{ _data = . ; *(.data); _edata = . ;  @}
4397   .bss 0x3000 :
4398     @{ _bstart = . ;  *(.bss) *(COMMON) ; _bend = . ;@}
4399 @}
4400 @end group
4401 @end smallexample
4402
4403 The run-time initialization code for use with a program generated with
4404 this linker script would include something like the following, to copy
4405 the initialized data from the ROM image to its runtime address.  Notice
4406 how this code takes advantage of the symbols defined by the linker
4407 script.
4408
4409 @smallexample
4410 @group
4411 extern char _etext, _data, _edata, _bstart, _bend;
4412 char *src = &_etext;
4413 char *dst = &_data;
4414
4415 /* ROM has&n