Add a testcase for PR ld/12356.
[binutils.git] / ld / ld.texinfo
blob4ea720fe0497289dfd8d27c05ae4071de408fdfc
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, 2010, 2011
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
13 @c @smallbook
15 @macro gcctabopt{body}
16 @code{\body\}
17 @end macro
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
42 @ifnottex
43 @dircategory Software development
44 @direntry
45 * Ld: (ld).                       The GNU linker.
46 @end direntry
47 @end ifnottex
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}.
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.
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
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
89 \global\parindent=0pt % Steve likes it this way.
90 @end tex
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.
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
106 @end titlepage
107 @end iftex
108 @contents
109 @c FIXME: Talk about importance of *order* of args, cmds to linker!
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}.
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''.
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
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
184 @node Overview
185 @chapter Overview
187 @cindex @sc{gnu} linker
188 @cindex what is this?
190 @ifset man
191 @c man begin SYNOPSIS
192 ld [@b{options}] @var{objfile} @dots{}
193 @c man end
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
202 @c man begin DESCRIPTION
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}.
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.
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
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
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).
233 @c man end
235 @node Invocation
236 @chapter Invocation
238 @c man begin DESCRIPTION
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.
244 @c man end
246 @ifset UsesEnvVars
247 @menu
248 * Options::                     Command Line Options
249 * Environment::                 Environment Variables
250 @end menu
252 @node Options
253 @section Command Line Options
254 @end ifset
256 @cindex command line
257 @cindex options
259 @c man begin OPTIONS
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}:
268 @smallexample
269 ld -o @var{output} /lib/crt0.o hello.o -lc
270 @end smallexample
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.)
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.
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.
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}.
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}.
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.
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.
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.
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:
337 @smallexample
338   gcc -Wl,--start-group foo.o bar.o -Wl,--end-group
339 @end smallexample
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:
349 @smallexample
350   gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map
351 @end smallexample
353 Here is a table of the generic command line switches accepted by the GNU
354 linker:
356 @table @gcctabopt
357 @include at-file.texi
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.
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.  
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.
391 Future releases of @command{ld} may support similar functionality for
392 other architecture families.
393 @end ifset
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}.
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.
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
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.
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}.
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.  
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.
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.
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.
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.
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.
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.
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}.
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.
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.
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
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}.
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.
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.
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}.
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}.
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.
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.
615 @kindex -g
616 @item -g
617 Ignored.  Provided for compatibility with other tools.
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.
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.
640 @kindex -i
641 @cindex incremental link
642 @item -i
643 Perform an incremental link (same as option @samp{-r}).
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.
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}.
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}.
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.
680 See the @option{-(} option for a way to force the linker to search
681 archives multiple times.
683 You may list the same archive multiple times on the command line.
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
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.
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.
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
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.
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.
725 If the @samp{-m} option is not used, the emulation is taken from the
726 @code{LDEMULATION} environment variable, if that is defined.
728 Otherwise, the default emulation depends upon how the linker was
729 configured.
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:
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.
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:
758 @smallexample
759    foo = 1
760    foo = foo * 4
761    foo = foo + 8
762 @end smallexample
764 will produce the following output in the link map if the @option{-M}
765 option is used:
767 @smallexample
768    0x00000001                foo = 0x1
769    [0x0000000c]                foo = (foo * 0x4)
770    [0x0000000c]                foo = (foo + 0x8)
771 @end smallexample
773 See @ref{Expressions} for more information about expressions in linker
774 scripts.
775 @end itemize
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}.
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.
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.
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.
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.
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.
838 This option is currently only supported on ELF platforms.
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.
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}.
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.
868 This option does the same thing as @samp{-i}.
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.
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.
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.
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.
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.
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.
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}.
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}).
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.
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.
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.
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.
977 @kindex -x
978 @kindex --discard-all
979 @cindex deleting local symbols
980 @item -x
981 @itemx --discard-all
982 Delete all local symbols.
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.)
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.
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.
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.
1010 @kindex -z @var{keyword}
1011 @item -z @var{keyword}
1012 The recognized keywords are:
1013 @table @samp
1015 @item combreloc
1016 Combines multiple reloc sections and sorts them to make dynamic symbol
1017 lookup caching possible.
1019 @item defs
1020 Disallows undefined symbols in object files.  Undefined symbols in
1021 shared libraries are still allowed.
1023 @item execstack
1024 Marks the object as requiring executable stack.
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.
1034 @item interpose
1035 Marks the object that its symbol table interposes before all symbols
1036 but the primary executable.
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.
1044 @item loadfltr
1045 Marks  the object that its filters be processed immediately at
1046 runtime.
1048 @item muldefs
1049 Allows multiple definitions.
1051 @item nocombreloc
1052 Disables multiple reloc sections combining.
1054 @item nocopyreloc
1055 Disables production of copy relocs.
1057 @item nodefaultlib
1058 Marks the object that the search for dependencies of this object will
1059 ignore any default library search paths.
1061 @item nodelete
1062 Marks the object shouldn't be unloaded at runtime.
1064 @item nodlopen
1065 Marks the object not available to @code{dlopen}.
1067 @item nodump
1068 Marks the object can not be dumped by @code{dldump}.
1070 @item noexecstack
1071 Marks the object as not requiring executable stack.
1073 @item norelro
1074 Don't create an ELF @code{PT_GNU_RELRO} segment header in the object.
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.
1083 @item origin
1084 Marks the object may contain $ORIGIN.
1086 @item relro
1087 Create an ELF @code{PT_GNU_RELRO} segment header in the object.
1089 @item max-page-size=@var{value}
1090 Set the emulation maximum page size to @var{value}.
1092 @item common-page-size=@var{value}
1093 Set the emulation common page size to @var{value}.
1095 @end table
1097 Other keywords are ignored for Solaris compatibility.
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.
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.
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.
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.
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.
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}.
1155 @kindex -assert @var{keyword}
1156 @item -assert @var{keyword}
1157 This option is ignored for SunOS compatibility.
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.
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.
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.
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.
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.
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.
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.
1227 @kindex --dynamic-list-data
1228 @item --dynamic-list-data
1229 Include all global data symbols to the dynamic list.
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++.
1236 @kindex --dynamic-list-cpp-typeinfo
1237 @item --dynamic-list-cpp-typeinfo
1238 Provide the builtin dynamic list for C++ runtime type identification.
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.
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}.
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.
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.
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.
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}.
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.
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}.
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.
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.
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}.
1355 @kindex --force-exe-suffix
1356 @item  --force-exe-suffix
1357 Make sure that an output file has a .exe suffix.
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.
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.
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}.
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.
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.
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.
1409 @kindex --target-help
1410 @item --target-help
1411 Print a summary of all target specific options on the standard output and exit.
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.
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.
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.
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.
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.
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.
1460 The reasons for allowing undefined symbol references in shared
1461 libraries specified at link time are that:
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.
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
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.
1484 @kindex --default-symver
1485 @item --default-symver
1486 Create and use a default symbol version (the soname) for unversioned
1487 exported symbols.
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.
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.
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.
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.
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.
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.
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
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.
1556 @kindex -qmagic
1557 @item -qmagic
1558 This option is ignored for Linux compatibility.
1560 @kindex -Qy
1561 @item -Qy
1562 This option is ignored for SVR4 compatibility.
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
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.
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
1603 @ifset GENERIC
1604 On platforms where this is not supported, @samp{--relax} is accepted,
1605 but ignored.
1606 @end ifset
1608 On platforms where @samp{--relax} is accepted the option
1609 @samp{--no-relax} can be used to disable the feature.
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.
1625 @samp{--retain-symbols-file} does @emph{not} discard undefined symbols,
1626 or symbols needed for relocations.
1628 You may only specify @samp{--retain-symbols-file} once in the command
1629 line.  It overrides @samp{-s} and @samp{-S}.
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.
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.
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
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.
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.
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.
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
1715 If the required shared library is not found, the linker will issue a
1716 warning and continue with the link.
1717 @end ifset
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.
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.
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.
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.
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.
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.
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.
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}.
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.
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.
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}.
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}.
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.
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}:
1828 @table @samp
1829 @item ignore-all
1830 Do not report any unresolved symbols.
1832 @item report-all
1833 Report all unresolved symbols.  This is the default.
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.
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
1847 The behaviour for shared libraries on their own can also be controlled
1848 by the @option{--[no-]allow-shlib-undefined} option.
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.
1854 @kindex --verbose
1855 @cindex verbose
1856 @item --dll-verbose
1857 @itemx --verbose
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.
1862 @kindex --version-script=@var{version-scriptfile}
1863 @cindex version script, symbol versions
1864 @item --version-script=@var{version-scriptfile}
1865 Specify the name of a version script to the linker.  This is typically
1866 used when creating shared libraries to specify additional information
1867 about the version hierarchy for the library being created.  This option
1868 is only fully supported on ELF platforms which support shared libraries;
1869 see @ref{VERSION}.  It is partially supported on PE platforms, which can
1870 use version scripts to filter symbol visibility in auto-export mode: any
1871 symbols marked @samp{local} in the version script will not be exported.
1872 @xref{WIN32}.
1874 @kindex --warn-common
1875 @cindex warnings, on combining symbols
1876 @cindex combining symbols, warnings on
1877 @item --warn-common
1878 Warn when a common symbol is combined with another common symbol or with
1879 a symbol definition.  Unix linkers allow this somewhat sloppy practise,
1880 but linkers on some other operating systems do not.  This option allows
1881 you to find potential problems from combining global symbols.
1882 Unfortunately, some C libraries use this practise, so you may get some
1883 warnings about symbols in the libraries as well as in your programs.
1885 There are three kinds of global symbols, illustrated here by C examples:
1887 @table @samp
1888 @item int i = 1;
1889 A definition, which goes in the initialized data section of the output
1890 file.
1892 @item extern int i;
1893 An undefined reference, which does not allocate space.
1894 There must be either a definition or a common symbol for the
1895 variable somewhere.
1897 @item int i;
1898 A common symbol.  If there are only (one or more) common symbols for a
1899 variable, it goes in the uninitialized data area of the output file.
1900 The linker merges multiple common symbols for the same variable into a
1901 single symbol.  If they are of different sizes, it picks the largest
1902 size.  The linker turns a common symbol into a declaration, if there is
1903 a definition of the same variable.
1904 @end table
1906 The @samp{--warn-common} option can produce five kinds of warnings.
1907 Each warning consists of a pair of lines: the first describes the symbol
1908 just encountered, and the second describes the previous symbol
1909 encountered with the same name.  One or both of the two symbols will be
1910 a common symbol.
1912 @enumerate
1913 @item
1914 Turning a common symbol into a reference, because there is already a
1915 definition for the symbol.
1916 @smallexample
1917 @var{file}(@var{section}): warning: common of `@var{symbol}'
1918    overridden by definition
1919 @var{file}(@var{section}): warning: defined here
1920 @end smallexample
1922 @item
1923 Turning a common symbol into a reference, because a later definition for
1924 the symbol is encountered.  This is the same as the previous case,
1925 except that the symbols are encountered in a different order.
1926 @smallexample
1927 @var{file}(@var{section}): warning: definition of `@var{symbol}'
1928    overriding common
1929 @var{file}(@var{section}): warning: common is here
1930 @end smallexample
1932 @item
1933 Merging a common symbol with a previous same-sized common symbol.
1934 @smallexample
1935 @var{file}(@var{section}): warning: multiple common
1936    of `@var{symbol}'
1937 @var{file}(@var{section}): warning: previous common is here
1938 @end smallexample
1940 @item
1941 Merging a common symbol with a previous larger common symbol.
1942 @smallexample
1943 @var{file}(@var{section}): warning: common of `@var{symbol}'
1944    overridden by larger common
1945 @var{file}(@var{section}): warning: larger common is here
1946 @end smallexample
1948 @item
1949 Merging a common symbol with a previous smaller common symbol.  This is
1950 the same as the previous case, except that the symbols are
1951 encountered in a different order.
1952 @smallexample
1953 @var{file}(@var{section}): warning: common of `@var{symbol}'
1954    overriding smaller common
1955 @var{file}(@var{section}): warning: smaller common is here
1956 @end smallexample
1957 @end enumerate
1959 @kindex --warn-constructors
1960 @item --warn-constructors
1961 Warn if any global constructors are used.  This is only useful for a few
1962 object file formats.  For formats like COFF or ELF, the linker can not
1963 detect the use of global constructors.
1965 @kindex --warn-multiple-gp
1966 @item --warn-multiple-gp
1967 Warn if multiple global pointer values are required in the output file.
1968 This is only meaningful for certain processors, such as the Alpha.
1969 Specifically, some processors put large-valued constants in a special
1970 section.  A special register (the global pointer) points into the middle
1971 of this section, so that constants can be loaded efficiently via a
1972 base-register relative addressing mode.  Since the offset in
1973 base-register relative mode is fixed and relatively small (e.g., 16
1974 bits), this limits the maximum size of the constant pool.  Thus, in
1975 large programs, it is often necessary to use multiple global pointer
1976 values in order to be able to address all possible constants.  This
1977 option causes a warning to be issued whenever this case occurs.
1979 @kindex --warn-once
1980 @cindex warnings, on undefined symbols
1981 @cindex undefined symbols, warnings on
1982 @item --warn-once
1983 Only warn once for each undefined symbol, rather than once per module
1984 which refers to it.
1986 @kindex --warn-section-align
1987 @cindex warnings, on section alignment
1988 @cindex section alignment, warnings on
1989 @item --warn-section-align
1990 Warn if the address of an output section is changed because of
1991 alignment.  Typically, the alignment will be set by an input section.
1992 The address will only be changed if it not explicitly specified; that
1993 is, if the @code{SECTIONS} command does not specify a start address for
1994 the section (@pxref{SECTIONS}).
1996 @kindex --warn-shared-textrel
1997 @item --warn-shared-textrel
1998 Warn if the linker adds a DT_TEXTREL to a shared object.
2000 @kindex --warn-alternate-em
2001 @item --warn-alternate-em
2002 Warn if an object has alternate ELF machine code.
2004 @kindex --warn-unresolved-symbols
2005 @item --warn-unresolved-symbols
2006 If the linker is going to report an unresolved symbol (see the option
2007 @option{--unresolved-symbols}) it will normally generate an error.
2008 This option makes it generate a warning instead.
2010 @kindex --error-unresolved-symbols
2011 @item --error-unresolved-symbols
2012 This restores the linker's default behaviour of generating errors when
2013 it is reporting unresolved symbols.
2015 @kindex --whole-archive
2016 @cindex including an entire archive
2017 @item --whole-archive
2018 For each archive mentioned on the command line after the
2019 @option{--whole-archive} option, include every object file in the archive
2020 in the link, rather than searching the archive for the required object
2021 files.  This is normally used to turn an archive file into a shared
2022 library, forcing every object to be included in the resulting shared
2023 library.  This option may be used more than once.
2025 Two notes when using this option from gcc: First, gcc doesn't know
2026 about this option, so you have to use @option{-Wl,-whole-archive}.
2027 Second, don't forget to use @option{-Wl,-no-whole-archive} after your
2028 list of archives, because gcc will add its own list of archives to
2029 your link and you may not want this flag to affect those as well.
2031 @kindex --wrap=@var{symbol}
2032 @item --wrap=@var{symbol}
2033 Use a wrapper function for @var{symbol}.  Any undefined reference to
2034 @var{symbol} will be resolved to @code{__wrap_@var{symbol}}.  Any
2035 undefined reference to @code{__real_@var{symbol}} will be resolved to
2036 @var{symbol}.
2038 This can be used to provide a wrapper for a system function.  The
2039 wrapper function should be called @code{__wrap_@var{symbol}}.  If it
2040 wishes to call the system function, it should call
2041 @code{__real_@var{symbol}}.
2043 Here is a trivial example:
2045 @smallexample
2046 void *
2047 __wrap_malloc (size_t c)
2049   printf ("malloc called with %zu\n", c);
2050   return __real_malloc (c);
2052 @end smallexample
2054 If you link other code with this file using @option{--wrap malloc}, then
2055 all calls to @code{malloc} will call the function @code{__wrap_malloc}
2056 instead.  The call to @code{__real_malloc} in @code{__wrap_malloc} will
2057 call the real @code{malloc} function.
2059 You may wish to provide a @code{__real_malloc} function as well, so that
2060 links without the @option{--wrap} option will succeed.  If you do this,
2061 you should not put the definition of @code{__real_malloc} in the same
2062 file as @code{__wrap_malloc}; if you do, the assembler may resolve the
2063 call before the linker has a chance to wrap it to @code{malloc}.
2065 @kindex --eh-frame-hdr
2066 @item --eh-frame-hdr
2067 Request creation of @code{.eh_frame_hdr} section and ELF
2068 @code{PT_GNU_EH_FRAME} segment header.
2070 @kindex --enable-new-dtags
2071 @kindex --disable-new-dtags
2072 @item --enable-new-dtags
2073 @itemx --disable-new-dtags
2074 This linker can create the new dynamic tags in ELF. But the older ELF
2075 systems may not understand them. If you specify
2076 @option{--enable-new-dtags}, the dynamic tags will be created as needed.
2077 If you specify @option{--disable-new-dtags}, no new dynamic tags will be
2078 created. By default, the new dynamic tags are not created. Note that
2079 those options are only available for ELF systems.
2081 @kindex --hash-size=@var{number}
2082 @item --hash-size=@var{number}
2083 Set the default size of the linker's hash tables to a prime number
2084 close to @var{number}.  Increasing this value can reduce the length of
2085 time it takes the linker to perform its tasks, at the expense of
2086 increasing the linker's memory requirements.  Similarly reducing this
2087 value can reduce the memory requirements at the expense of speed.
2089 @kindex --hash-style=@var{style}
2090 @item --hash-style=@var{style}
2091 Set the type of linker's hash table(s).  @var{style} can be either
2092 @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for
2093 new style GNU @code{.gnu.hash} section or @code{both} for both
2094 the classic ELF @code{.hash} and new style GNU @code{.gnu.hash}
2095 hash tables.  The default is @code{sysv}.
2097 @kindex --reduce-memory-overheads
2098 @item --reduce-memory-overheads
2099 This option reduces memory requirements at ld runtime, at the expense of
2100 linking speed.  This was introduced to select the old O(n^2) algorithm
2101 for link map file generation, rather than the new O(n) algorithm which uses
2102 about 40% more memory for symbol storage.
2104 Another effect of the switch is to set the default hash table size to
2105 1021, which again saves memory at the cost of lengthening the linker's
2106 run time.  This is not done however if the @option{--hash-size} switch
2107 has been used.
2109 The @option{--reduce-memory-overheads} switch may be also be used to
2110 enable other tradeoffs in future versions of the linker.
2112 @kindex --build-id
2113 @kindex --build-id=@var{style}
2114 @item --build-id
2115 @itemx --build-id=@var{style}
2116 Request creation of @code{.note.gnu.build-id} ELF note section.
2117 The contents of the note are unique bits identifying this linked
2118 file.  @var{style} can be @code{uuid} to use 128 random bits,
2119 @code{sha1} to use a 160-bit @sc{SHA1} hash on the normative
2120 parts of the output contents, @code{md5} to use a 128-bit
2121 @sc{MD5} hash on the normative parts of the output contents, or
2122 @code{0x@var{hexstring}} to use a chosen bit string specified as
2123 an even number of hexadecimal digits (@code{-} and @code{:}
2124 characters between digit pairs are ignored).  If @var{style} is
2125 omitted, @code{sha1} is used.
2127 The @code{md5} and @code{sha1} styles produces an identifier
2128 that is always the same in an identical output file, but will be
2129 unique among all nonidentical output files.  It is not intended
2130 to be compared as a checksum for the file's contents.  A linked
2131 file may be changed later by other tools, but the build ID bit
2132 string identifying the original linked file does not change.
2134 Passing @code{none} for @var{style} disables the setting from any
2135 @code{--build-id} options earlier on the command line.
2136 @end table
2138 @c man end
2140 @subsection Options Specific to i386 PE Targets
2142 @c man begin OPTIONS
2144 The i386 PE linker supports the @option{-shared} option, which causes
2145 the output to be a dynamically linked library (DLL) instead of a
2146 normal executable.  You should name the output @code{*.dll} when you
2147 use this option.  In addition, the linker fully supports the standard
2148 @code{*.def} files, which may be specified on the linker command line
2149 like an object file (in fact, it should precede archives it exports
2150 symbols from, to ensure that they get linked in, just like a normal
2151 object file).
2153 In addition to the options common to all targets, the i386 PE linker
2154 support additional command line options that are specific to the i386
2155 PE target.  Options that take values may be separated from their
2156 values by either a space or an equals sign.
2158 @table @gcctabopt
2160 @kindex --add-stdcall-alias
2161 @item --add-stdcall-alias
2162 If given, symbols with a stdcall suffix (@@@var{nn}) will be exported
2163 as-is and also with the suffix stripped.
2164 [This option is specific to the i386 PE targeted port of the linker]
2166 @kindex --base-file
2167 @item --base-file @var{file}
2168 Use @var{file} as the name of a file in which to save the base
2169 addresses of all the relocations needed for generating DLLs with
2170 @file{dlltool}.
2171 [This is an i386 PE specific option]
2173 @kindex --dll
2174 @item --dll
2175 Create a DLL instead of a regular executable.  You may also use
2176 @option{-shared} or specify a @code{LIBRARY} in a given @code{.def}
2177 file.
2178 [This option is specific to the i386 PE targeted port of the linker]
2180 @kindex --enable-long-section-names
2181 @kindex --disable-long-section-names
2182 @item --enable-long-section-names
2183 @itemx --disable-long-section-names
2184 The PE variants of the Coff object format add an extension that permits
2185 the use of section names longer than eight characters, the normal limit
2186 for Coff.  By default, these names are only allowed in object files, as
2187 fully-linked executable images do not carry the Coff string table required
2188 to support the longer names.  As a GNU extension, it is possible to
2189 allow their use in executable images as well, or to (probably pointlessly!)
2190 disallow it in object files, by using these two options.  Executable images
2191 generated with these long section names are slightly non-standard, carrying
2192 as they do a string table, and may generate confusing output when examined
2193 with non-GNU PE-aware tools, such as file viewers and dumpers.  However, 
2194 GDB relies on the use of PE long section names to find Dwarf-2 debug 
2195 information sections in an executable image at runtime, and so if neither
2196 option is specified on the command-line, @command{ld} will enable long
2197 section names, overriding the default and technically correct behaviour,
2198 when it finds the presence of debug information while linking an executable
2199 image and not stripping symbols.
2200 [This option is valid for all PE targeted ports of the linker]
2202 @kindex --enable-stdcall-fixup
2203 @kindex --disable-stdcall-fixup
2204 @item --enable-stdcall-fixup
2205 @itemx --disable-stdcall-fixup
2206 If the link finds a symbol that it cannot resolve, it will attempt to
2207 do ``fuzzy linking'' by looking for another defined symbol that differs
2208 only in the format of the symbol name (cdecl vs stdcall) and will
2209 resolve that symbol by linking to the match.  For example, the
2210 undefined symbol @code{_foo} might be linked to the function
2211 @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked
2212 to the function @code{_bar}.  When the linker does this, it prints a
2213 warning, since it normally should have failed to link, but sometimes
2214 import libraries generated from third-party dlls may need this feature
2215 to be usable.  If you specify @option{--enable-stdcall-fixup}, this
2216 feature is fully enabled and warnings are not printed.  If you specify
2217 @option{--disable-stdcall-fixup}, this feature is disabled and such
2218 mismatches are considered to be errors.
2219 [This option is specific to the i386 PE targeted port of the linker]
2221 @kindex --leading-underscore
2222 @kindex --no-leading-underscore
2223 @item --leading-underscore
2224 @itemx --no-leading-underscore
2225 For most targets default symbol-prefix is an underscore and is defined
2226 in target's description. By this option it is possible to
2227 disable/enable the default underscore symbol-prefix.
2229 @cindex DLLs, creating
2230 @kindex --export-all-symbols
2231 @item --export-all-symbols
2232 If given, all global symbols in the objects used to build a DLL will
2233 be exported by the DLL.  Note that this is the default if there
2234 otherwise wouldn't be any exported symbols.  When symbols are
2235 explicitly exported via DEF files or implicitly exported via function
2236 attributes, the default is to not export anything else unless this
2237 option is given.  Note that the symbols @code{DllMain@@12},
2238 @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and
2239 @code{impure_ptr} will not be automatically
2240 exported.  Also, symbols imported from other DLLs will not be
2241 re-exported, nor will symbols specifying the DLL's internal layout
2242 such as those beginning with @code{_head_} or ending with
2243 @code{_iname}.  In addition, no symbols from @code{libgcc},
2244 @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported.
2245 Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will
2246 not be exported, to help with C++ DLLs.  Finally, there is an
2247 extensive list of cygwin-private symbols that are not exported
2248 (obviously, this applies on when building DLLs for cygwin targets).
2249 These cygwin-excludes are: @code{_cygwin_dll_entry@@12},
2250 @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12},
2251 @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll},
2252 @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2},
2253 @code{cygwin_premain3}, and @code{environ}.
2254 [This option is specific to the i386 PE targeted port of the linker]
2256 @kindex --exclude-symbols
2257 @item --exclude-symbols @var{symbol},@var{symbol},...
2258 Specifies a list of symbols which should not be automatically
2259 exported.  The symbol names may be delimited by commas or colons.
2260 [This option is specific to the i386 PE targeted port of the linker]
2262 @kindex --exclude-all-symbols
2263 @item --exclude-all-symbols
2264 Specifies no symbols should be automatically exported.
2265 [This option is specific to the i386 PE targeted port of the linker]
2267 @kindex --file-alignment
2268 @item --file-alignment
2269 Specify the file alignment.  Sections in the file will always begin at
2270 file offsets which are multiples of this number.  This defaults to
2271 512.
2272 [This option is specific to the i386 PE targeted port of the linker]
2274 @cindex heap size
2275 @kindex --heap
2276 @item --heap @var{reserve}
2277 @itemx --heap @var{reserve},@var{commit}
2278 Specify the number of bytes of memory to reserve (and optionally commit)
2279 to be used as heap for this program.  The default is 1Mb reserved, 4K
2280 committed.
2281 [This option is specific to the i386 PE targeted port of the linker]
2283 @cindex image base
2284 @kindex --image-base
2285 @item --image-base @var{value}
2286 Use @var{value} as the base address of your program or dll.  This is
2287 the lowest memory location that will be used when your program or dll
2288 is loaded.  To reduce the need to relocate and improve performance of
2289 your dlls, each should have a unique base address and not overlap any
2290 other dlls.  The default is 0x400000 for executables, and 0x10000000
2291 for dlls.
2292 [This option is specific to the i386 PE targeted port of the linker]
2294 @kindex --kill-at
2295 @item --kill-at
2296 If given, the stdcall suffixes (@@@var{nn}) will be stripped from
2297 symbols before they are exported.
2298 [This option is specific to the i386 PE targeted port of the linker]
2300 @kindex --large-address-aware
2301 @item --large-address-aware
2302 If given, the appropriate bit in the ``Characteristics'' field of the COFF
2303 header is set to indicate that this executable supports virtual addresses
2304 greater than 2 gigabytes.  This should be used in conjunction with the /3GB
2305 or /USERVA=@var{value} megabytes switch in the ``[operating systems]''
2306 section of the BOOT.INI.  Otherwise, this bit has no effect.
2307 [This option is specific to PE targeted ports of the linker]
2309 @kindex --major-image-version
2310 @item --major-image-version @var{value}
2311 Sets the major number of the ``image version''.  Defaults to 1.
2312 [This option is specific to the i386 PE targeted port of the linker]
2314 @kindex --major-os-version
2315 @item --major-os-version @var{value}
2316 Sets the major number of the ``os version''.  Defaults to 4.
2317 [This option is specific to the i386 PE targeted port of the linker]
2319 @kindex --major-subsystem-version
2320 @item --major-subsystem-version @var{value}
2321 Sets the major number of the ``subsystem version''.  Defaults to 4.
2322 [This option is specific to the i386 PE targeted port of the linker]
2324 @kindex --minor-image-version
2325 @item --minor-image-version @var{value}
2326 Sets the minor number of the ``image version''.  Defaults to 0.
2327 [This option is specific to the i386 PE targeted port of the linker]
2329 @kindex --minor-os-version
2330 @item --minor-os-version @var{value}
2331 Sets the minor number of the ``os version''.  Defaults to 0.
2332 [This option is specific to the i386 PE targeted port of the linker]
2334 @kindex --minor-subsystem-version
2335 @item --minor-subsystem-version @var{value}
2336 Sets the minor number of the ``subsystem version''.  Defaults to 0.
2337 [This option is specific to the i386 PE targeted port of the linker]
2339 @cindex DEF files, creating
2340 @cindex DLLs, creating
2341 @kindex --output-def
2342 @item --output-def @var{file}
2343 The linker will create the file @var{file} which will contain a DEF
2344 file corresponding to the DLL the linker is generating.  This DEF file
2345 (which should be called @code{*.def}) may be used to create an import
2346 library with @code{dlltool} or may be used as a reference to
2347 automatically or implicitly exported symbols.
2348 [This option is specific to the i386 PE targeted port of the linker]
2350 @cindex DLLs, creating
2351 @kindex --out-implib
2352 @item --out-implib @var{file}
2353 The linker will create the file @var{file} which will contain an
2354 import lib corresponding to the DLL the linker is generating. This
2355 import lib (which should be called @code{*.dll.a} or @code{*.a}
2356 may be used to link clients against the generated DLL; this behaviour
2357 makes it possible to skip a separate @code{dlltool} import library
2358 creation step.
2359 [This option is specific to the i386 PE targeted port of the linker]
2361 @kindex --enable-auto-image-base
2362 @item --enable-auto-image-base
2363 Automatically choose the image base for DLLs, unless one is specified
2364 using the @code{--image-base} argument.  By using a hash generated
2365 from the dllname to create unique image bases for each DLL, in-memory
2366 collisions and relocations which can delay program execution are
2367 avoided.
2368 [This option is specific to the i386 PE targeted port of the linker]
2370 @kindex --disable-auto-image-base
2371 @item --disable-auto-image-base
2372 Do not automatically generate a unique image base.  If there is no
2373 user-specified image base (@code{--image-base}) then use the platform
2374 default.
2375 [This option is specific to the i386 PE targeted port of the linker]
2377 @cindex DLLs, linking to
2378 @kindex --dll-search-prefix
2379 @item --dll-search-prefix @var{string}
2380 When linking dynamically to a dll without an import library,
2381 search for @code{<string><basename>.dll} in preference to
2382 @code{lib<basename>.dll}. This behaviour allows easy distinction
2383 between DLLs built for the various "subplatforms": native, cygwin,
2384 uwin, pw, etc.  For instance, cygwin DLLs typically use
2385 @code{--dll-search-prefix=cyg}.
2386 [This option is specific to the i386 PE targeted port of the linker]
2388 @kindex --enable-auto-import
2389 @item --enable-auto-import
2390 Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for
2391 DATA imports from DLLs, and create the necessary thunking symbols when
2392 building the import libraries with those DATA exports. Note: Use of the
2393 'auto-import' extension will cause the text section of the image file
2394 to be made writable. This does not conform to the PE-COFF format
2395 specification published by Microsoft.
2397 Note - use of the 'auto-import' extension will also cause read only
2398 data which would normally be placed into the .rdata section to be
2399 placed into the .data section instead.  This is in order to work
2400 around a problem with consts that is described here:
2401 http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
2403 Using 'auto-import' generally will 'just work' -- but sometimes you may
2404 see this message:
2406 "variable '<var>' can't be auto-imported. Please read the
2407 documentation for ld's @code{--enable-auto-import} for details."
2409 This message occurs when some (sub)expression accesses an address
2410 ultimately given by the sum of two constants (Win32 import tables only
2411 allow one).  Instances where this may occur include accesses to member
2412 fields of struct variables imported from a DLL, as well as using a
2413 constant index into an array variable imported from a DLL.  Any
2414 multiword variable (arrays, structs, long long, etc) may trigger
2415 this error condition.  However, regardless of the exact data type
2416 of the offending exported variable, ld will always detect it, issue
2417 the warning, and exit.
2419 There are several ways to address this difficulty, regardless of the
2420 data type of the exported variable:
2422 One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task
2423 of adjusting references in your client code for runtime environment, so
2424 this method works only when runtime environment supports this feature.
2426 A second solution is to force one of the 'constants' to be a variable --
2427 that is, unknown and un-optimizable at compile time.  For arrays,
2428 there are two possibilities: a) make the indexee (the array's address)
2429 a variable, or b) make the 'constant' index a variable.  Thus:
2431 @example
2432 extern type extern_array[];
2433 extern_array[1] -->
2434    @{ volatile type *t=extern_array; t[1] @}
2435 @end example
2439 @example
2440 extern type extern_array[];
2441 extern_array[1] -->
2442    @{ volatile int t=1; extern_array[t] @}
2443 @end example
2445 For structs (and most other multiword data types) the only option
2446 is to make the struct itself (or the long long, or the ...) variable:
2448 @example
2449 extern struct s extern_struct;
2450 extern_struct.field -->
2451    @{ volatile struct s *t=&extern_struct; t->field @}
2452 @end example
2456 @example
2457 extern long long extern_ll;
2458 extern_ll -->
2459   @{ volatile long long * local_ll=&extern_ll; *local_ll @}
2460 @end example
2462 A third method of dealing with this difficulty is to abandon
2463 'auto-import' for the offending symbol and mark it with
2464 @code{__declspec(dllimport)}.  However, in practise that
2465 requires using compile-time #defines to indicate whether you are
2466 building a DLL, building client code that will link to the DLL, or
2467 merely building/linking to a static library.   In making the choice
2468 between the various methods of resolving the 'direct address with
2469 constant offset' problem, you should consider typical real-world usage:
2471 Original:
2472 @example
2473 --foo.h
2474 extern int arr[];
2475 --foo.c
2476 #include "foo.h"
2477 void main(int argc, char **argv)@{
2478   printf("%d\n",arr[1]);
2480 @end example
2482 Solution 1:
2483 @example
2484 --foo.h
2485 extern int arr[];
2486 --foo.c
2487 #include "foo.h"
2488 void main(int argc, char **argv)@{
2489   /* This workaround is for win32 and cygwin; do not "optimize" */
2490   volatile int *parr = arr;
2491   printf("%d\n",parr[1]);
2493 @end example
2495 Solution 2:
2496 @example
2497 --foo.h
2498 /* Note: auto-export is assumed (no __declspec(dllexport)) */
2499 #if (defined(_WIN32) || defined(__CYGWIN__)) && \
2500   !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2501 #define FOO_IMPORT __declspec(dllimport)
2502 #else
2503 #define FOO_IMPORT
2504 #endif
2505 extern FOO_IMPORT int arr[];
2506 --foo.c
2507 #include "foo.h"
2508 void main(int argc, char **argv)@{
2509   printf("%d\n",arr[1]);
2511 @end example
2513 A fourth way to avoid this problem is to re-code your
2514 library to use a functional interface rather than a data interface
2515 for the offending variables (e.g. set_foo() and get_foo() accessor
2516 functions).
2517 [This option is specific to the i386 PE targeted port of the linker]
2519 @kindex --disable-auto-import
2520 @item --disable-auto-import
2521 Do not attempt to do sophisticated linking of @code{_symbol} to
2522 @code{__imp__symbol} for DATA imports from DLLs.
2523 [This option is specific to the i386 PE targeted port of the linker]
2525 @kindex --enable-runtime-pseudo-reloc
2526 @item --enable-runtime-pseudo-reloc
2527 If your code contains expressions described in --enable-auto-import section,
2528 that is, DATA imports from DLL with non-zero offset, this switch will create
2529 a vector of 'runtime pseudo relocations' which can be used by runtime
2530 environment to adjust references to such data in your client code.
2531 [This option is specific to the i386 PE targeted port of the linker]
2533 @kindex --disable-runtime-pseudo-reloc
2534 @item --disable-runtime-pseudo-reloc
2535 Do not create pseudo relocations for non-zero offset DATA imports from
2536 DLLs.  This is the default.
2537 [This option is specific to the i386 PE targeted port of the linker]
2539 @kindex --enable-extra-pe-debug
2540 @item --enable-extra-pe-debug
2541 Show additional debug info related to auto-import symbol thunking.
2542 [This option is specific to the i386 PE targeted port of the linker]
2544 @kindex --section-alignment
2545 @item --section-alignment
2546 Sets the section alignment.  Sections in memory will always begin at
2547 addresses which are a multiple of this number.  Defaults to 0x1000.
2548 [This option is specific to the i386 PE targeted port of the linker]
2550 @cindex stack size
2551 @kindex --stack
2552 @item --stack @var{reserve}
2553 @itemx --stack @var{reserve},@var{commit}
2554 Specify the number of bytes of memory to reserve (and optionally commit)
2555 to be used as stack for this program.  The default is 2Mb reserved, 4K
2556 committed.
2557 [This option is specific to the i386 PE targeted port of the linker]
2559 @kindex --subsystem
2560 @item --subsystem @var{which}
2561 @itemx --subsystem @var{which}:@var{major}
2562 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2563 Specifies the subsystem under which your program will execute.  The
2564 legal values for @var{which} are @code{native}, @code{windows},
2565 @code{console}, @code{posix}, and @code{xbox}.  You may optionally set
2566 the subsystem version also.  Numeric values are also accepted for
2567 @var{which}.
2568 [This option is specific to the i386 PE targeted port of the linker]
2570 The following options set flags in the @code{DllCharacteristics} field
2571 of the PE file header:
2572 [These options are specific to PE targeted ports of the linker]
2574 @kindex --dynamicbase
2575 @item --dynamicbase
2576 The image base address may be relocated using address space layout
2577 randomization (ASLR).  This feature was introduced with MS Windows
2578 Vista for i386 PE targets.
2580 @kindex --forceinteg
2581 @item --forceinteg
2582 Code integrity checks are enforced.
2584 @kindex --nxcompat
2585 @item --nxcompat
2586 The image is compatible with the Data Execution Prevention.
2587 This feature was introduced with MS Windows XP SP2 for i386 PE targets.
2589 @kindex --no-isolation
2590 @item --no-isolation
2591 Although the image understands isolation, do not isolate the image.
2593 @kindex --no-seh
2594 @item --no-seh
2595 The image does not use SEH. No SE handler may be called from
2596 this image.
2598 @kindex --no-bind
2599 @item --no-bind
2600 Do not bind this image.
2602 @kindex --wdmdriver
2603 @item --wdmdriver
2604 The driver uses the MS Windows Driver Model.
2606 @kindex --tsaware
2607 @item --tsaware
2608 The image is Terminal Server aware.
2610 @end table
2612 @c man end
2614 @ifset M68HC11
2615 @subsection Options specific to Motorola 68HC11 and 68HC12 targets
2617 @c man begin OPTIONS
2619 The 68HC11 and 68HC12 linkers support specific options to control the
2620 memory bank switching mapping and trampoline code generation.
2622 @table @gcctabopt
2624 @kindex --no-trampoline
2625 @item --no-trampoline
2626 This option disables the generation of trampoline. By default a trampoline
2627 is generated for each far function which is called using a @code{jsr}
2628 instruction (this happens when a pointer to a far function is taken).
2630 @kindex --bank-window
2631 @item --bank-window @var{name}
2632 This option indicates to the linker the name of the memory region in
2633 the @samp{MEMORY} specification that describes the memory bank window.
2634 The definition of such region is then used by the linker to compute
2635 paging and addresses within the memory window.
2637 @end table
2639 @c man end
2640 @end ifset
2642 @ifset M68K
2643 @subsection Options specific to Motorola 68K target
2645 @c man begin OPTIONS
2647 The following options are supported to control handling of GOT generation
2648 when linking for 68K targets.
2650 @table @gcctabopt
2652 @kindex --got
2653 @item --got=@var{type}
2654 This option tells the linker which GOT generation scheme to use.
2655 @var{type} should be one of @samp{single}, @samp{negative},
2656 @samp{multigot} or @samp{target}.  For more information refer to the
2657 Info entry for @file{ld}.
2659 @end table
2661 @c man end
2662 @end ifset
2664 @ifset UsesEnvVars
2665 @node Environment
2666 @section Environment Variables
2668 @c man begin ENVIRONMENT
2670 You can change the behaviour of @command{ld} with the environment variables
2671 @ifclear SingleFormat
2672 @code{GNUTARGET},
2673 @end ifclear
2674 @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
2676 @ifclear SingleFormat
2677 @kindex GNUTARGET
2678 @cindex default input format
2679 @code{GNUTARGET} determines the input-file object format if you don't
2680 use @samp{-b} (or its synonym @samp{--format}).  Its value should be one
2681 of the BFD names for an input format (@pxref{BFD}).  If there is no
2682 @code{GNUTARGET} in the environment, @command{ld} uses the natural format
2683 of the target. If @code{GNUTARGET} is set to @code{default} then BFD
2684 attempts to discover the input format by examining binary input files;
2685 this method often succeeds, but there are potential ambiguities, since
2686 there is no method of ensuring that the magic number used to specify
2687 object-file formats is unique.  However, the configuration procedure for
2688 BFD on each system places the conventional format for that system first
2689 in the search-list, so ambiguities are resolved in favor of convention.
2690 @end ifclear
2692 @kindex LDEMULATION
2693 @cindex default emulation
2694 @cindex emulation, default
2695 @code{LDEMULATION} determines the default emulation if you don't use the
2696 @samp{-m} option.  The emulation can affect various aspects of linker
2697 behaviour, particularly the default linker script.  You can list the
2698 available emulations with the @samp{--verbose} or @samp{-V} options.  If
2699 the @samp{-m} option is not used, and the @code{LDEMULATION} environment
2700 variable is not defined, the default emulation depends upon how the
2701 linker was configured.
2703 @kindex COLLECT_NO_DEMANGLE
2704 @cindex demangling, default
2705 Normally, the linker will default to demangling symbols.  However, if
2706 @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will
2707 default to not demangling symbols.  This environment variable is used in
2708 a similar fashion by the @code{gcc} linker wrapper program.  The default
2709 may be overridden by the @samp{--demangle} and @samp{--no-demangle}
2710 options.
2712 @c man end
2713 @end ifset
2715 @node Scripts
2716 @chapter Linker Scripts
2718 @cindex scripts
2719 @cindex linker scripts
2720 @cindex command files
2721 Every link is controlled by a @dfn{linker script}.  This script is
2722 written in the linker command language.
2724 The main purpose of the linker script is to describe how the sections in
2725 the input files should be mapped into the output file, and to control
2726 the memory layout of the output file.  Most linker scripts do nothing
2727 more than this.  However, when necessary, the linker script can also
2728 direct the linker to perform many other operations, using the commands
2729 described below.
2731 The linker always uses a linker script.  If you do not supply one
2732 yourself, the linker will use a default script that is compiled into the
2733 linker executable.  You can use the @samp{--verbose} command line option
2734 to display the default linker script.  Certain command line options,
2735 such as @samp{-r} or @samp{-N}, will affect the default linker script.
2737 You may supply your own linker script by using the @samp{-T} command
2738 line option.  When you do this, your linker script will replace the
2739 default linker script.
2741 You may also use linker scripts implicitly by naming them as input files
2742 to the linker, as though they were files to be linked.  @xref{Implicit
2743 Linker Scripts}.
2745 @menu
2746 * Basic Script Concepts::       Basic Linker Script Concepts
2747 * Script Format::               Linker Script Format
2748 * Simple Example::              Simple Linker Script Example
2749 * Simple Commands::             Simple Linker Script Commands
2750 * Assignments::                 Assigning Values to Symbols
2751 * SECTIONS::                    SECTIONS Command
2752 * MEMORY::                      MEMORY Command
2753 * PHDRS::                       PHDRS Command
2754 * VERSION::                     VERSION Command
2755 * Expressions::                 Expressions in Linker Scripts
2756 * Implicit Linker Scripts::     Implicit Linker Scripts
2757 @end menu
2759 @node Basic Script Concepts
2760 @section Basic Linker Script Concepts
2761 @cindex linker script concepts
2762 We need to define some basic concepts and vocabulary in order to
2763 describe the linker script language.
2765 The linker combines input files into a single output file.  The output
2766 file and each input file are in a special data format known as an
2767 @dfn{object file format}.  Each file is called an @dfn{object file}.
2768 The output file is often called an @dfn{executable}, but for our
2769 purposes we will also call it an object file.  Each object file has,
2770 among other things, a list of @dfn{sections}.  We sometimes refer to a
2771 section in an input file as an @dfn{input section}; similarly, a section
2772 in the output file is an @dfn{output section}.
2774 Each section in an object file has a name and a size.  Most sections
2775 also have an associated block of data, known as the @dfn{section
2776 contents}.  A section may be marked as @dfn{loadable}, which mean that
2777 the contents should be loaded into memory when the output file is run.
2778 A section with no contents may be @dfn{allocatable}, which means that an
2779 area in memory should be set aside, but nothing in particular should be
2780 loaded there (in some cases this memory must be zeroed out).  A section
2781 which is neither loadable nor allocatable typically contains some sort
2782 of debugging information.
2784 Every loadable or allocatable output section has two addresses.  The
2785 first is the @dfn{VMA}, or virtual memory address.  This is the address
2786 the section will have when the output file is run.  The second is the
2787 @dfn{LMA}, or load memory address.  This is the address at which the
2788 section will be loaded.  In most cases the two addresses will be the
2789 same.  An example of when they might be different is when a data section
2790 is loaded into ROM, and then copied into RAM when the program starts up
2791 (this technique is often used to initialize global variables in a ROM
2792 based system).  In this case the ROM address would be the LMA, and the
2793 RAM address would be the VMA.
2795 You can see the sections in an object file by using the @code{objdump}
2796 program with the @samp{-h} option.
2798 Every object file also has a list of @dfn{symbols}, known as the
2799 @dfn{symbol table}.  A symbol may be defined or undefined.  Each symbol
2800 has a name, and each defined symbol has an address, among other
2801 information.  If you compile a C or C++ program into an object file, you
2802 will get a defined symbol for every defined function and global or
2803 static variable.  Every undefined function or global variable which is
2804 referenced in the input file will become an undefined symbol.
2806 You can see the symbols in an object file by using the @code{nm}
2807 program, or by using the @code{objdump} program with the @samp{-t}
2808 option.
2810 @node Script Format
2811 @section Linker Script Format
2812 @cindex linker script format
2813 Linker scripts are text files.
2815 You write a linker script as a series of commands.  Each command is
2816 either a keyword, possibly followed by arguments, or an assignment to a
2817 symbol.  You may separate commands using semicolons.  Whitespace is
2818 generally ignored.
2820 Strings such as file or format names can normally be entered directly.
2821 If the file name contains a character such as a comma which would
2822 otherwise serve to separate file names, you may put the file name in
2823 double quotes.  There is no way to use a double quote character in a
2824 file name.
2826 You may include comments in linker scripts just as in C, delimited by
2827 @samp{/*} and @samp{*/}.  As in C, comments are syntactically equivalent
2828 to whitespace.
2830 @node Simple Example
2831 @section Simple Linker Script Example
2832 @cindex linker script example
2833 @cindex example of linker script
2834 Many linker scripts are fairly simple.
2836 The simplest possible linker script has just one command:
2837 @samp{SECTIONS}.  You use the @samp{SECTIONS} command to describe the
2838 memory layout of the output file.
2840 The @samp{SECTIONS} command is a powerful command.  Here we will
2841 describe a simple use of it.  Let's assume your program consists only of
2842 code, initialized data, and uninitialized data.  These will be in the
2843 @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively.
2844 Let's assume further that these are the only sections which appear in
2845 your input files.
2847 For this example, let's say that the code should be loaded at address
2848 0x10000, and that the data should start at address 0x8000000.  Here is a
2849 linker script which will do that:
2850 @smallexample
2851 SECTIONS
2853   . = 0x10000;
2854   .text : @{ *(.text) @}
2855   . = 0x8000000;
2856   .data : @{ *(.data) @}
2857   .bss : @{ *(.bss) @}
2859 @end smallexample
2861 You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS},
2862 followed by a series of symbol assignments and output section
2863 descriptions enclosed in curly braces.
2865 The first line inside the @samp{SECTIONS} command of the above example
2866 sets the value of the special symbol @samp{.}, which is the location
2867 counter.  If you do not specify the address of an output section in some
2868 other way (other ways are described later), the address is set from the
2869 current value of the location counter.  The location counter is then
2870 incremented by the size of the output section.  At the start of the
2871 @samp{SECTIONS} command, the location counter has the value @samp{0}.
2873 The second line defines an output section, @samp{.text}.  The colon is
2874 required syntax which may be ignored for now.  Within the curly braces
2875 after the output section name, you list the names of the input sections
2876 which should be placed into this output section.  The @samp{*} is a
2877 wildcard which matches any file name.  The expression @samp{*(.text)}
2878 means all @samp{.text} input sections in all input files.
2880 Since the location counter is @samp{0x10000} when the output section
2881 @samp{.text} is defined, the linker will set the address of the
2882 @samp{.text} section in the output file to be @samp{0x10000}.
2884 The remaining lines define the @samp{.data} and @samp{.bss} sections in
2885 the output file.  The linker will place the @samp{.data} output section
2886 at address @samp{0x8000000}.  After the linker places the @samp{.data}
2887 output section, the value of the location counter will be
2888 @samp{0x8000000} plus the size of the @samp{.data} output section.  The
2889 effect is that the linker will place the @samp{.bss} output section
2890 immediately after the @samp{.data} output section in memory.
2892 The linker will ensure that each output section has the required
2893 alignment, by increasing the location counter if necessary.  In this
2894 example, the specified addresses for the @samp{.text} and @samp{.data}
2895 sections will probably satisfy any alignment constraints, but the linker
2896 may have to create a small gap between the @samp{.data} and @samp{.bss}
2897 sections.
2899 That's it!  That's a simple and complete linker script.
2901 @node Simple Commands
2902 @section Simple Linker Script Commands
2903 @cindex linker script simple commands
2904 In this section we describe the simple linker script commands.
2906 @menu
2907 * Entry Point::                 Setting the entry point
2908 * File Commands::               Commands dealing with files
2909 @ifclear SingleFormat
2910 * Format Commands::             Commands dealing with object file formats
2911 @end ifclear
2913 * REGION_ALIAS::                Assign alias names to memory regions
2914 * Miscellaneous Commands::      Other linker script commands
2915 @end menu
2917 @node Entry Point
2918 @subsection Setting the Entry Point
2919 @kindex ENTRY(@var{symbol})
2920 @cindex start of execution
2921 @cindex first instruction
2922 @cindex entry point
2923 The first instruction to execute in a program is called the @dfn{entry
2924 point}.  You can use the @code{ENTRY} linker script command to set the
2925 entry point.  The argument is a symbol name:
2926 @smallexample
2927 ENTRY(@var{symbol})
2928 @end smallexample
2930 There are several ways to set the entry point.  The linker will set the
2931 entry point by trying each of the following methods in order, and
2932 stopping when one of them succeeds:
2933 @itemize @bullet
2934 @item
2935 the @samp{-e} @var{entry} command-line option;
2936 @item
2937 the @code{ENTRY(@var{symbol})} command in a linker script;
2938 @item
2939 the value of a target specific symbol, if it is defined;  For many
2940 targets this is @code{start}, but PE and BeOS based systems for example
2941 check a list of possible entry symbols, matching the first one found.
2942 @item
2943 the address of the first byte of the @samp{.text} section, if present;
2944 @item
2945 The address @code{0}.
2946 @end itemize
2948 @node File Commands
2949 @subsection Commands Dealing with Files
2950 @cindex linker script file commands
2951 Several linker script commands deal with files.
2953 @table @code
2954 @item INCLUDE @var{filename}
2955 @kindex INCLUDE @var{filename}
2956 @cindex including a linker script
2957 Include the linker script @var{filename} at this point.  The file will
2958 be searched for in the current directory, and in any directory specified
2959 with the @option{-L} option.  You can nest calls to @code{INCLUDE} up to
2960 10 levels deep.
2962 You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or
2963 @code{SECTIONS} commands, or in output section descriptions.
2965 @item INPUT(@var{file}, @var{file}, @dots{})
2966 @itemx INPUT(@var{file} @var{file} @dots{})
2967 @kindex INPUT(@var{files})
2968 @cindex input files in linker scripts
2969 @cindex input object files in linker scripts
2970 @cindex linker script input object files
2971 The @code{INPUT} command directs the linker to include the named files
2972 in the link, as though they were named on the command line.
2974 For example, if you always want to include @file{subr.o} any time you do
2975 a link, but you can't be bothered to put it on every link command line,
2976 then you can put @samp{INPUT (subr.o)} in your linker script.
2978 In fact, if you like, you can list all of your input files in the linker
2979 script, and then invoke the linker with nothing but a @samp{-T} option.
2981 In case a @dfn{sysroot prefix} is configured, and the filename starts
2982 with the @samp{/} character, and the script being processed was
2983 located inside the @dfn{sysroot prefix}, the filename will be looked
2984 for in the @dfn{sysroot prefix}.  Otherwise, the linker will try to
2985 open the file in the current directory.  If it is not found, the
2986 linker will search through the archive library search path.  See the
2987 description of @samp{-L} in @ref{Options,,Command Line Options}.
2989 If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the
2990 name to @code{lib@var{file}.a}, as with the command line argument
2991 @samp{-l}.
2993 When you use the @code{INPUT} command in an implicit linker script, the
2994 files will be included in the link at the point at which the linker
2995 script file is included.  This can affect archive searching.
2997 @item GROUP(@var{file}, @var{file}, @dots{})
2998 @itemx GROUP(@var{file} @var{file} @dots{})
2999 @kindex GROUP(@var{files})
3000 @cindex grouping input files
3001 The @code{GROUP} command is like @code{INPUT}, except that the named
3002 files should all be archives, and they are searched repeatedly until no
3003 new undefined references are created.  See the description of @samp{-(}
3004 in @ref{Options,,Command Line Options}.
3006 @item AS_NEEDED(@var{file}, @var{file}, @dots{})
3007 @itemx AS_NEEDED(@var{file} @var{file} @dots{})
3008 @kindex AS_NEEDED(@var{files})
3009 This construct can appear only inside of the @code{INPUT} or @code{GROUP}
3010 commands, among other filenames.  The files listed will be handled
3011 as if they appear directly in the @code{INPUT} or @code{GROUP} commands,
3012 with the exception of ELF shared libraries, that will be added only
3013 when they are actually needed.  This construct essentially enables
3014 @option{--as-needed} option for all the files listed inside of it
3015 and restores previous @option{--as-needed} resp. @option{--no-as-needed}
3016 setting afterwards.
3018 @item OUTPUT(@var{filename})
3019 @kindex OUTPUT(@var{filename})
3020 @cindex output file name in linker script
3021 The @code{OUTPUT} command names the output file.  Using
3022 @code{OUTPUT(@var{filename})} in the linker script is exactly like using
3023 @samp{-o @var{filename}} on the command line (@pxref{Options,,Command
3024 Line Options}).  If both are used, the command line option takes
3025 precedence.
3027 You can use the @code{OUTPUT} command to define a default name for the
3028 output file other than the usual default of @file{a.out}.
3030 @item SEARCH_DIR(@var{path})
3031 @kindex SEARCH_DIR(@var{path})
3032 @cindex library search path in linker script
3033 @cindex archive search path in linker script
3034 @cindex search path in linker script
3035 The @code{SEARCH_DIR} command adds @var{path} to the list of paths where
3036 @command{ld} looks for archive libraries.  Using
3037 @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}}
3038 on the command line (@pxref{Options,,Command Line Options}).  If both
3039 are used, then the linker will search both paths.  Paths specified using
3040 the command line option are searched first.
3042 @item STARTUP(@var{filename})
3043 @kindex STARTUP(@var{filename})
3044 @cindex first input file
3045 The @code{STARTUP} command is just like the @code{INPUT} command, except
3046 that @var{filename} will become the first input file to be linked, as
3047 though it were specified first on the command line.  This may be useful
3048 when using a system in which the entry point is always the start of the
3049 first file.
3050 @end table
3052 @ifclear SingleFormat
3053 @node Format Commands
3054 @subsection Commands Dealing with Object File Formats
3055 A couple of linker script commands deal with object file formats.
3057 @table @code
3058 @item OUTPUT_FORMAT(@var{bfdname})
3059 @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little})
3060 @kindex OUTPUT_FORMAT(@var{bfdname})
3061 @cindex output file format in linker script
3062 The @code{OUTPUT_FORMAT} command names the BFD format to use for the
3063 output file (@pxref{BFD}).  Using @code{OUTPUT_FORMAT(@var{bfdname})} is
3064 exactly like using @samp{--oformat @var{bfdname}} on the command line
3065 (@pxref{Options,,Command Line Options}).  If both are used, the command
3066 line option takes precedence.
3068 You can use @code{OUTPUT_FORMAT} with three arguments to use different
3069 formats based on the @samp{-EB} and @samp{-EL} command line options.
3070 This permits the linker script to set the output format based on the
3071 desired endianness.
3073 If neither @samp{-EB} nor @samp{-EL} are used, then the output format
3074 will be the first argument, @var{default}.  If @samp{-EB} is used, the
3075 output format will be the second argument, @var{big}.  If @samp{-EL} is
3076 used, the output format will be the third argument, @var{little}.
3078 For example, the default linker script for the MIPS ELF target uses this
3079 command:
3080 @smallexample
3081 OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
3082 @end smallexample
3083 This says that the default format for the output file is
3084 @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line
3085 option, the output file will be created in the @samp{elf32-littlemips}
3086 format.
3088 @item TARGET(@var{bfdname})
3089 @kindex TARGET(@var{bfdname})
3090 @cindex input file format in linker script
3091 The @code{TARGET} command names the BFD format to use when reading input
3092 files.  It affects subsequent @code{INPUT} and @code{GROUP} commands.
3093 This command is like using @samp{-b @var{bfdname}} on the command line
3094 (@pxref{Options,,Command Line Options}).  If the @code{TARGET} command
3095 is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET}
3096 command is also used to set the format for the output file.  @xref{BFD}.
3097 @end table
3098 @end ifclear
3100 @node REGION_ALIAS
3101 @subsection Assign alias names to memory regions
3102 @kindex REGION_ALIAS(@var{alias}, @var{region})
3103 @cindex region alias
3104 @cindex region names
3106 Alias names can be added to existing memory regions created with the
3107 @ref{MEMORY} command.  Each name corresponds to at most one memory region.
3109 @smallexample
3110 REGION_ALIAS(@var{alias}, @var{region})
3111 @end smallexample
3113 The @code{REGION_ALIAS} function creates an alias name @var{alias} for the
3114 memory region @var{region}.  This allows a flexible mapping of output sections
3115 to memory regions.  An example follows.
3117 Suppose we have an application for embedded systems which come with various
3118 memory storage devices.  All have a general purpose, volatile memory @code{RAM}
3119 that allows code execution or data storage.  Some may have a read-only,
3120 non-volatile memory @code{ROM} that allows code execution and read-only data
3121 access.  The last variant is a read-only, non-volatile memory @code{ROM2} with
3122 read-only data access and no code execution capability.  We have four output
3123 sections:
3125 @itemize @bullet
3126 @item
3127 @code{.text} program code;
3128 @item
3129 @code{.rodata} read-only data;
3130 @item
3131 @code{.data} read-write initialized data;
3132 @item
3133 @code{.bss} read-write zero initialized data.
3134 @end itemize
3136 The goal is to provide a linker command file that contains a system independent
3137 part defining the output sections and a system dependent part mapping the
3138 output sections to the memory regions available on the system.  Our embedded
3139 systems come with three different memory setups @code{A}, @code{B} and
3140 @code{C}:
3141 @multitable @columnfractions .25 .25 .25 .25
3142 @item Section @tab Variant A @tab Variant B @tab Variant C
3143 @item .text @tab RAM @tab ROM @tab ROM 
3144 @item .rodata @tab RAM @tab ROM @tab ROM2
3145 @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2
3146 @item .bss @tab RAM @tab RAM @tab RAM
3147 @end multitable
3148 The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is
3149 loaded into region @code{ROM} or @code{ROM2} respectively.  Please note that
3150 the load address of the @code{.data} section starts in all three variants at
3151 the end of the @code{.rodata} section.
3153 The base linker script that deals with the output sections follows.  It
3154 includes the system dependent @code{linkcmds.memory} file that describes the
3155 memory layout:
3156 @smallexample
3157 INCLUDE linkcmds.memory
3159 SECTIONS
3160   @{
3161     .text :
3162       @{
3163         *(.text)
3164       @} > REGION_TEXT
3165     .rodata :
3166       @{
3167         *(.rodata)
3168         rodata_end = .;
3169       @} > REGION_RODATA
3170     .data : AT (rodata_end)
3171       @{
3172         data_start = .;
3173         *(.data)
3174       @} > REGION_DATA
3175     data_size = SIZEOF(.data);
3176     data_load_start = LOADADDR(.data);
3177     .bss :
3178       @{
3179         *(.bss)
3180       @} > REGION_BSS
3181   @}
3182 @end smallexample
3184 Now we need three different @code{linkcmds.memory} files to define memory
3185 regions and alias names.  The content of @code{linkcmds.memory} for the three
3186 variants @code{A}, @code{B} and @code{C}:
3187 @table @code
3188 @item A
3189 Here everything goes into the @code{RAM}.
3190 @smallexample
3191 MEMORY
3192   @{
3193     RAM : ORIGIN = 0, LENGTH = 4M
3194   @}
3196 REGION_ALIAS("REGION_TEXT", RAM);
3197 REGION_ALIAS("REGION_RODATA", RAM);
3198 REGION_ALIAS("REGION_DATA", RAM);
3199 REGION_ALIAS("REGION_BSS", RAM);
3200 @end smallexample
3201 @item B
3202 Program code and read-only data go into the @code{ROM}.  Read-write data goes
3203 into the @code{RAM}.  An image of the initialized data is loaded into the
3204 @code{ROM} and will be copied during system start into the @code{RAM}.
3205 @smallexample
3206 MEMORY
3207   @{
3208     ROM : ORIGIN = 0, LENGTH = 3M
3209     RAM : ORIGIN = 0x10000000, LENGTH = 1M
3210   @}
3212 REGION_ALIAS("REGION_TEXT", ROM);
3213 REGION_ALIAS("REGION_RODATA", ROM);
3214 REGION_ALIAS("REGION_DATA", RAM);
3215 REGION_ALIAS("REGION_BSS", RAM);
3216 @end smallexample
3217 @item C
3218 Program code goes into the @code{ROM}.  Read-only data goes into the
3219 @code{ROM2}.  Read-write data goes into the @code{RAM}.  An image of the
3220 initialized data is loaded into the @code{ROM2} and will be copied during
3221 system start into the @code{RAM}.
3222 @smallexample
3223 MEMORY
3224   @{
3225     ROM : ORIGIN = 0, LENGTH = 2M
3226     ROM2 : ORIGIN = 0x10000000, LENGTH = 1M
3227     RAM : ORIGIN = 0x20000000, LENGTH = 1M
3228   @}
3230 REGION_ALIAS("REGION_TEXT", ROM);
3231 REGION_ALIAS("REGION_RODATA", ROM2);
3232 REGION_ALIAS("REGION_DATA", RAM);
3233 REGION_ALIAS("REGION_BSS", RAM);
3234 @end smallexample
3235 @end table
3237 It is possible to write a common system initialization routine to copy the
3238 @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if
3239 necessary:
3240 @smallexample
3241 #include <string.h>
3243 extern char data_start [];
3244 extern char data_size [];
3245 extern char data_load_start [];
3247 void copy_data(void)
3249   if (data_start != data_load_start)
3250     @{
3251       memcpy(data_start, data_load_start, (size_t) data_size);
3252     @}
3254 @end smallexample
3256 @node Miscellaneous Commands
3257 @subsection Other Linker Script Commands
3258 There are a few other linker scripts commands.
3260 @table @code
3261 @item ASSERT(@var{exp}, @var{message})
3262 @kindex ASSERT
3263 @cindex assertion in linker script
3264 Ensure that @var{exp} is non-zero.  If it is zero, then exit the linker
3265 with an error code, and print @var{message}.
3267 @item EXTERN(@var{symbol} @var{symbol} @dots{})
3268 @kindex EXTERN
3269 @cindex undefined symbol in linker script
3270 Force @var{symbol} to be entered in the output file as an undefined
3271 symbol.  Doing this may, for example, trigger linking of additional
3272 modules from standard libraries.  You may list several @var{symbol}s for
3273 each @code{EXTERN}, and you may use @code{EXTERN} multiple times.  This
3274 command has the same effect as the @samp{-u} command-line option.
3276 @item FORCE_COMMON_ALLOCATION
3277 @kindex FORCE_COMMON_ALLOCATION
3278 @cindex common allocation in linker script
3279 This command has the same effect as the @samp{-d} command-line option:
3280 to make @command{ld} assign space to common symbols even if a relocatable
3281 output file is specified (@samp{-r}).
3283 @item INHIBIT_COMMON_ALLOCATION
3284 @kindex INHIBIT_COMMON_ALLOCATION
3285 @cindex common allocation in linker script
3286 This command has the same effect as the @samp{--no-define-common}
3287 command-line option: to make @code{ld} omit the assignment of addresses
3288 to common symbols even for a non-relocatable output file.
3290 @item INSERT [ AFTER | BEFORE ] @var{output_section}
3291 @kindex INSERT
3292 @cindex insert user script into default script
3293 This command is typically used in a script specified by @samp{-T} to
3294 augment the default @code{SECTIONS} with, for example, overlays.  It
3295 inserts all prior linker script statements after (or before)
3296 @var{output_section}, and also causes @samp{-T} to not override the
3297 default linker script.  The exact insertion point is as for orphan
3298 sections.  @xref{Location Counter}.  The insertion happens after the
3299 linker has mapped input sections to output sections.  Prior to the
3300 insertion, since @samp{-T} scripts are parsed before the default
3301 linker script, statements in the @samp{-T} script occur before the
3302 default linker script statements in the internal linker representation
3303 of the script.  In particular, input section assignments will be made
3304 to @samp{-T} output sections before those in the default script.  Here
3305 is an example of how a @samp{-T} script using @code{INSERT} might look:
3307 @smallexample
3308 SECTIONS
3310   OVERLAY :
3311   @{
3312     .ov1 @{ ov1*(.text) @}
3313     .ov2 @{ ov2*(.text) @}
3314   @}
3316 INSERT AFTER .text;
3317 @end smallexample
3319 @item NOCROSSREFS(@var{section} @var{section} @dots{})
3320 @kindex NOCROSSREFS(@var{sections})
3321 @cindex cross references
3322 This command may be used to tell @command{ld} to issue an error about any
3323 references among certain output sections.
3325 In certain types of programs, particularly on embedded systems when
3326 using overlays, when one section is loaded into memory, another section
3327 will not be.  Any direct references between the two sections would be
3328 errors.  For example, it would be an error if code in one section called
3329 a function defined in the other section.
3331 The @code{NOCROSSREFS} command takes a list of output section names.  If
3332 @command{ld} detects any cross references between the sections, it reports
3333 an error and returns a non-zero exit status.  Note that the
3334 @code{NOCROSSREFS} command uses output section names, not input section
3335 names.
3337 @ifclear SingleFormat
3338 @item OUTPUT_ARCH(@var{bfdarch})
3339 @kindex OUTPUT_ARCH(@var{bfdarch})
3340 @cindex machine architecture
3341 @cindex architecture
3342 Specify a particular output machine architecture.  The argument is one
3343 of the names used by the BFD library (@pxref{BFD}).  You can see the
3344 architecture of an object file by using the @code{objdump} program with
3345 the @samp{-f} option.
3346 @end ifclear
3348 @item LD_FEATURE(@var{string})
3349 @kindex LD_FEATURE(@var{string})
3350 This command may be used to modify @command{ld} behavior.  If
3351 @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers
3352 in a script are simply treated as numbers everywhere.
3353 @xref{Expression Section}.
3354 @end table
3356 @node Assignments
3357 @section Assigning Values to Symbols
3358 @cindex assignment in scripts
3359 @cindex symbol definition, scripts
3360 @cindex variables, defining
3361 You may assign a value to a symbol in a linker script.  This will define
3362 the symbol and place it into the symbol table with a global scope.
3364 @menu
3365 * Simple Assignments::          Simple Assignments
3366 * PROVIDE::                     PROVIDE
3367 * PROVIDE_HIDDEN::              PROVIDE_HIDDEN
3368 * Source Code Reference::       How to use a linker script defined symbol in source code
3369 @end menu
3371 @node Simple Assignments
3372 @subsection Simple Assignments
3374 You may assign to a symbol using any of the C assignment operators:
3376 @table @code
3377 @item @var{symbol} = @var{expression} ;
3378 @itemx @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 @end table
3388 The first case will define @var{symbol} to the value of
3389 @var{expression}.  In the other cases, @var{symbol} must already be
3390 defined, and the value will be adjusted accordingly.
3392 The special symbol name @samp{.} indicates the location counter.  You
3393 may only use this within a @code{SECTIONS} command.  @xref{Location Counter}.
3395 The semicolon after @var{expression} is required.
3397 Expressions are defined below; see @ref{Expressions}.
3399 You may write symbol assignments as commands in their own right, or as
3400 statements within a @code{SECTIONS} command, or as part of an output
3401 section description in a @code{SECTIONS} command.
3403 The section of the symbol will be set from the section of the
3404 expression; for more information, see @ref{Expression Section}.
3406 Here is an example showing the three different places that symbol
3407 assignments may be used:
3409 @smallexample
3410 floating_point = 0;
3411 SECTIONS
3413   .text :
3414     @{
3415       *(.text)
3416       _etext = .;
3417     @}
3418   _bdata = (. + 3) & ~ 3;
3419   .data : @{ *(.data) @}
3421 @end smallexample
3422 @noindent
3423 In this example, the symbol @samp{floating_point} will be defined as
3424 zero.  The symbol @samp{_etext} will be defined as the address following
3425 the last @samp{.text} input section.  The symbol @samp{_bdata} will be
3426 defined as the address following the @samp{.text} output section aligned
3427 upward to a 4 byte boundary.
3429 @node PROVIDE
3430 @subsection PROVIDE
3431 @cindex PROVIDE
3432 In some cases, it is desirable for a linker script to define a symbol
3433 only if it is referenced and is not defined by any object included in
3434 the link.  For example, traditional linkers defined the symbol
3435 @samp{etext}.  However, ANSI C requires that the user be able to use
3436 @samp{etext} as a function name without encountering an error.  The
3437 @code{PROVIDE} keyword may be used to define a symbol, such as
3438 @samp{etext}, only if it is referenced but not defined.  The syntax is
3439 @code{PROVIDE(@var{symbol} = @var{expression})}.
3441 Here is an example of using @code{PROVIDE} to define @samp{etext}:
3442 @smallexample
3443 SECTIONS
3445   .text :
3446     @{
3447       *(.text)
3448       _etext = .;
3449       PROVIDE(etext = .);
3450     @}
3452 @end smallexample
3454 In this example, if the program defines @samp{_etext} (with a leading
3455 underscore), the linker will give a multiple definition error.  If, on
3456 the other hand, the program defines @samp{etext} (with no leading
3457 underscore), the linker will silently use the definition in the program.
3458 If the program references @samp{etext} but does not define it, the
3459 linker will use the definition in the linker script.
3461 @node PROVIDE_HIDDEN
3462 @subsection PROVIDE_HIDDEN
3463 @cindex PROVIDE_HIDDEN
3464 Similar to @code{PROVIDE}.  For ELF targeted ports, the symbol will be
3465 hidden and won't be exported.
3467 @node Source Code Reference
3468 @subsection Source Code Reference
3470 Accessing a linker script defined variable from source code is not
3471 intuitive.  In particular a linker script symbol is not equivalent to
3472 a variable declaration in a high level language, it is instead a
3473 symbol that does not have a value.
3475 Before going further, it is important to note that compilers often
3476 transform names in the source code into different names when they are
3477 stored in the symbol table.  For example, Fortran compilers commonly
3478 prepend or append an underscore, and C++ performs extensive @samp{name
3479 mangling}.  Therefore there might be a discrepancy between the name
3480 of a variable as it is used in source code and the name of the same
3481 variable as it is defined in a linker script.  For example in C a
3482 linker script variable might be referred to as:
3484 @smallexample
3485   extern int foo;
3486 @end smallexample
3488 But in the linker script it might be defined as:
3490 @smallexample
3491   _foo = 1000;
3492 @end smallexample
3494 In the remaining examples however it is assumed that no name
3495 transformation has taken place.
3497 When a symbol is declared in a high level language such as C, two
3498 things happen.  The first is that the compiler reserves enough space
3499 in the program's memory to hold the @emph{value} of the symbol.  The
3500 second is that the compiler creates an entry in the program's symbol
3501 table which holds the symbol's @emph{address}.  ie the symbol table
3502 contains the address of the block of memory holding the symbol's
3503 value.  So for example the following C declaration, at file scope:
3505 @smallexample
3506   int foo = 1000;
3507 @end smallexample
3509 creates a entry called @samp{foo} in the symbol table.  This entry
3510 holds the address of an @samp{int} sized block of memory where the
3511 number 1000 is initially stored.
3513 When a program references a symbol the compiler generates code that
3514 first accesses the symbol table to find the address of the symbol's
3515 memory block and then code to read the value from that memory block.
3518 @smallexample
3519   foo = 1;
3520 @end smallexample
3522 looks up the symbol @samp{foo} in the symbol table, gets the address
3523 associated with this symbol and then writes the value 1 into that
3524 address.  Whereas:
3526 @smallexample
3527   int * a = & foo;
3528 @end smallexample
3530 looks up the symbol @samp{foo} in the symbol table, gets it address
3531 and then copies this address into the block of memory associated with
3532 the variable @samp{a}.
3534 Linker scripts symbol declarations, by contrast, create an entry in
3535 the symbol table but do not assign any memory to them.  Thus they are
3536 an address without a value.  So for example the linker script definition:
3538 @smallexample
3539   foo = 1000;
3540 @end smallexample
3542 creates an entry in the symbol table called @samp{foo} which holds
3543 the address of memory location 1000, but nothing special is stored at
3544 address 1000.  This means that you cannot access the @emph{value} of a
3545 linker script defined symbol - it has no value - all you can do is
3546 access the @emph{address} of a linker script defined symbol.
3548 Hence when you are using a linker script defined symbol in source code
3549 you should always take the address of the symbol, and never attempt to
3550 use its value.  For example suppose you want to copy the contents of a
3551 section of memory called .ROM into a section called .FLASH and the
3552 linker script contains these declarations:
3554 @smallexample
3555 @group
3556   start_of_ROM   = .ROM;
3557   end_of_ROM     = .ROM + sizeof (.ROM) - 1;
3558   start_of_FLASH = .FLASH;
3559 @end group
3560 @end smallexample
3562 Then the C source code to perform the copy would be:
3564 @smallexample
3565 @group
3566   extern char start_of_ROM, end_of_ROM, start_of_FLASH;
3568   memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
3569 @end group
3570 @end smallexample
3572 Note the use of the @samp{&} operators.  These are correct.
3574 @node SECTIONS
3575 @section SECTIONS Command
3576 @kindex SECTIONS
3577 The @code{SECTIONS} command tells the linker how to map input sections
3578 into output sections, and how to place the output sections in memory.
3580 The format of the @code{SECTIONS} command is:
3581 @smallexample
3582 SECTIONS
3584   @var{sections-command}
3585   @var{sections-command}
3586   @dots{}
3588 @end smallexample
3590 Each @var{sections-command} may of be one of the following:
3592 @itemize @bullet
3593 @item
3594 an @code{ENTRY} command (@pxref{Entry Point,,Entry command})
3595 @item
3596 a symbol assignment (@pxref{Assignments})
3597 @item
3598 an output section description
3599 @item
3600 an overlay description
3601 @end itemize
3603 The @code{ENTRY} command and symbol assignments are permitted inside the
3604 @code{SECTIONS} command for convenience in using the location counter in
3605 those commands.  This can also make the linker script easier to
3606 understand because you can use those commands at meaningful points in
3607 the layout of the output file.
3609 Output section descriptions and overlay descriptions are described
3610 below.
3612 If you do not use a @code{SECTIONS} command in your linker script, the
3613 linker will place each input section into an identically named output
3614 section in the order that the sections are first encountered in the
3615 input files.  If all input sections are present in the first file, for
3616 example, the order of sections in the output file will match the order
3617 in the first input file.  The first section will be at address zero.
3619 @menu
3620 * Output Section Description::  Output section description
3621 * Output Section Name::         Output section name
3622 * Output Section Address::      Output section address
3623 * Input Section::               Input section description
3624 * Output Section Data::         Output section data
3625 * Output Section Keywords::     Output section keywords
3626 * Output Section Discarding::   Output section discarding
3627 * Output Section Attributes::   Output section attributes
3628 * Overlay Description::         Overlay description
3629 @end menu
3631 @node Output Section Description
3632 @subsection Output Section Description
3633 The full description of an output section looks like this:
3634 @smallexample
3635 @group
3636 @var{section} [@var{address}] [(@var{type})] :
3637   [AT(@var{lma})]
3638   [ALIGN(@var{section_align})]
3639   [SUBALIGN(@var{subsection_align})]
3640   [@var{constraint}]
3641   @{
3642     @var{output-section-command}
3643     @var{output-section-command}
3644     @dots{}
3645   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
3646 @end group
3647 @end smallexample
3649 Most output sections do not use most of the optional section attributes.
3651 The whitespace around @var{section} is required, so that the section
3652 name is unambiguous.  The colon and the curly braces are also required.
3653 The line breaks and other white space are optional.
3655 Each @var{output-section-command} may be one of the following:
3657 @itemize @bullet
3658 @item
3659 a symbol assignment (@pxref{Assignments})
3660 @item
3661 an input section description (@pxref{Input Section})
3662 @item
3663 data values to include directly (@pxref{Output Section Data})
3664 @item
3665 a special output section keyword (@pxref{Output Section Keywords})
3666 @end itemize
3668 @node Output Section Name
3669 @subsection Output Section Name
3670 @cindex name, section
3671 @cindex section name
3672 The name of the output section is @var{section}.  @var{section} must
3673 meet the constraints of your output format.  In formats which only
3674 support a limited number of sections, such as @code{a.out}, the name
3675 must be one of the names supported by the format (@code{a.out}, for
3676 example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the
3677 output format supports any number of sections, but with numbers and not
3678 names (as is the case for Oasys), the name should be supplied as a
3679 quoted numeric string.  A section name may consist of any sequence of
3680 characters, but a name which contains any unusual characters such as
3681 commas must be quoted.
3683 The output section name @samp{/DISCARD/} is special; @ref{Output Section
3684 Discarding}.
3686 @node Output Section Address
3687 @subsection Output Section Address
3688 @cindex address, section
3689 @cindex section address
3690 The @var{address} is an expression for the VMA (the virtual memory
3691 address) of the output section.  This address is optional, but if it
3692 is provided then the output address will be set exactly as specified.
3694 If the output address is not specified then one will be chosen for the
3695 section, based on the heuristic below.  This address will be adjusted
3696 to fit the alignment requirement of the output section.  The
3697 alignment requirement is the strictest alignment of any input section
3698 contained within the output section.
3700 The output section address heuristic is as follows:
3702 @itemize @bullet
3703 @item
3704 If an output memory @var{region} is set for the section then it
3705 is added to this region and its address will be the next free address
3706 in that region.
3708 @item
3709 If the MEMORY command has been used to create a list of memory
3710 regions then the first region which has attributes compatible with the
3711 section is selected to contain it.  The section's output address will
3712 be the next free address in that region; @ref{MEMORY}.
3714 @item
3715 If no memory regions were specified, or none match the section then
3716 the output address will be based on the current value of the location
3717 counter.
3718 @end itemize
3720 @noindent
3721 For example:
3723 @smallexample
3724 .text . : @{ *(.text) @}
3725 @end smallexample
3727 @noindent
3730 @smallexample
3731 .text : @{ *(.text) @}
3732 @end smallexample
3734 @noindent
3735 are subtly different.  The first will set the address of the
3736 @samp{.text} output section to the current value of the location
3737 counter.  The second will set it to the current value of the location
3738 counter aligned to the strictest alignment of any of the @samp{.text}
3739 input sections.
3741 The @var{address} may be an arbitrary expression; @ref{Expressions}.
3742 For example, if you want to align the section on a 0x10 byte boundary,
3743 so that the lowest four bits of the section address are zero, you could
3744 do something like this:
3745 @smallexample
3746 .text ALIGN(0x10) : @{ *(.text) @}
3747 @end smallexample
3748 @noindent
3749 This works because @code{ALIGN} returns the current location counter
3750 aligned upward to the specified value.
3752 Specifying @var{address} for a section will change the value of the
3753 location counter, provided that the section is non-empty.  (Empty
3754 sections are ignored).
3756 @node Input Section
3757 @subsection Input Section Description
3758 @cindex input sections
3759 @cindex mapping input sections to output sections
3760 The most common output section command is an input section description.
3762 The input section description is the most basic linker script operation.
3763 You use output sections to tell the linker how to lay out your program
3764 in memory.  You use input section descriptions to tell the linker how to
3765 map the input files into your memory layout.
3767 @menu
3768 * Input Section Basics::        Input section basics
3769 * Input Section Wildcards::     Input section wildcard patterns
3770 * Input Section Common::        Input section for common symbols
3771 * Input Section Keep::          Input section and garbage collection
3772 * Input Section Example::       Input section example
3773 @end menu
3775 @node Input Section Basics
3776 @subsubsection Input Section Basics
3777 @cindex input section basics
3778 An input section description consists of a file name optionally followed
3779 by a list of section names in parentheses.
3781 The file name and the section name may be wildcard patterns, which we
3782 describe further below (@pxref{Input Section Wildcards}).
3784 The most common input section description is to include all input
3785 sections with a particular name in the output section.  For example, to
3786 include all input @samp{.text} sections, you would write:
3787 @smallexample
3788 *(.text)
3789 @end smallexample
3790 @noindent
3791 Here the @samp{*} is a wildcard which matches any file name.  To exclude a list
3792 of files from matching the file name wildcard, EXCLUDE_FILE may be used to
3793 match all files except the ones specified in the EXCLUDE_FILE list.  For
3794 example:
3795 @smallexample
3796 *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)
3797 @end smallexample
3798 will cause all .ctors sections from all files except @file{crtend.o} and
3799 @file{otherfile.o} to be included.
3801 There are two ways to include more than one section:
3802 @smallexample
3803 *(.text .rdata)
3804 *(.text) *(.rdata)
3805 @end smallexample
3806 @noindent
3807 The difference between these is the order in which the @samp{.text} and
3808 @samp{.rdata} input sections will appear in the output section.  In the
3809 first example, they will be intermingled, appearing in the same order as
3810 they are found in the linker input.  In the second example, all
3811 @samp{.text} input sections will appear first, followed by all
3812 @samp{.rdata} input sections.
3814 You can specify a file name to include sections from a particular file.
3815 You would do this if one or more of your files contain special data that
3816 needs to be at a particular location in memory.  For example:
3817 @smallexample
3818 data.o(.data)
3819 @end smallexample
3821 You can also specify files within archives by writing a pattern
3822 matching the archive, a colon, then the pattern matching the file,
3823 with no whitespace around the colon.
3825 @table @samp
3826 @item archive:file
3827 matches file within archive
3828 @item archive:
3829 matches the whole archive
3830 @item :file
3831 matches file but not one in an archive
3832 @end table
3834 Either one or both of @samp{archive} and @samp{file} can contain shell
3835 wildcards.  On DOS based file systems, the linker will assume that a
3836 single letter followed by a colon is a drive specifier, so
3837 @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o}
3838 within an archive called @samp{c}.  @samp{archive:file} filespecs may
3839 also be used within an @code{EXCLUDE_FILE} list, but may not appear in
3840 other linker script contexts.  For instance, you cannot extract a file
3841 from an archive by using @samp{archive:file} in an @code{INPUT}
3842 command.
3844 If you use a file name without a list of sections, then all sections in
3845 the input file will be included in the output section.  This is not
3846 commonly done, but it may by useful on occasion.  For example:
3847 @smallexample
3848 data.o
3849 @end smallexample
3851 When you use a file name which is not an @samp{archive:file} specifier
3852 and does not contain any wild card
3853 characters, the linker will first see if you also specified the file
3854 name on the linker command line or in an @code{INPUT} command.  If you
3855 did not, the linker will attempt to open the file as an input file, as
3856 though it appeared on the command line.  Note that this differs from an
3857 @code{INPUT} command, because the linker will not search for the file in
3858 the archive search path.
3860 @node Input Section Wildcards
3861 @subsubsection Input Section Wildcard Patterns
3862 @cindex input section wildcards
3863 @cindex wildcard file name patterns
3864 @cindex file name wildcard patterns
3865 @cindex section name wildcard patterns
3866 In an input section description, either the file name or the section
3867 name or both may be wildcard patterns.
3869 The file name of @samp{*} seen in many examples is a simple wildcard
3870 pattern for the file name.
3872 The wildcard patterns are like those used by the Unix shell.
3874 @table @samp
3875 @item *
3876 matches any number of characters
3877 @item ?
3878 matches any single character
3879 @item [@var{chars}]
3880 matches a single instance of any of the @var{chars}; the @samp{-}
3881 character may be used to specify a range of characters, as in
3882 @samp{[a-z]} to match any lower case letter
3883 @item \
3884 quotes the following character
3885 @end table
3887 When a file name is matched with a wildcard, the wildcard characters
3888 will not match a @samp{/} character (used to separate directory names on
3889 Unix).  A pattern consisting of a single @samp{*} character is an
3890 exception; it will always match any file name, whether it contains a
3891 @samp{/} or not.  In a section name, the wildcard characters will match
3892 a @samp{/} character.
3894 File name wildcard patterns only match files which are explicitly
3895 specified on the command line or in an @code{INPUT} command.  The linker
3896 does not search directories to expand wildcards.
3898 If a file name matches more than one wildcard pattern, or if a file name
3899 appears explicitly and is also matched by a wildcard pattern, the linker
3900 will use the first match in the linker script.  For example, this
3901 sequence of input section descriptions is probably in error, because the
3902 @file{data.o} rule will not be used:
3903 @smallexample
3904 .data : @{ *(.data) @}
3905 .data1 : @{ data.o(.data) @}
3906 @end smallexample
3908 @cindex SORT_BY_NAME
3909 Normally, the linker will place files and sections matched by wildcards
3910 in the order in which they are seen during the link.  You can change
3911 this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard
3912 pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}).  When the
3913 @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections
3914 into ascending order by name before placing them in the output file.
3916 @cindex SORT_BY_ALIGNMENT
3917 @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The
3918 difference is @code{SORT_BY_ALIGNMENT} will sort sections into
3919 ascending order by alignment before placing them in the output file.
3921 @cindex SORT_BY_INIT_PRIORITY
3922 @code{SORT_BY_INIT_PRIORITY} is very similar to @code{SORT_BY_NAME}. The
3923 difference is @code{SORT_BY_INIT_PRIORITY} will sort sections into
3924 ascending order by numerical value of the GCC init_priority attribute
3925 encoded in the section name before placing them in the output file.
3927 @cindex SORT
3928 @code{SORT} is an alias for @code{SORT_BY_NAME}.
3930 When there are nested section sorting commands in linker script, there
3931 can be at most 1 level of nesting for section sorting commands.
3933 @enumerate
3934 @item
3935 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
3936 It will sort the input sections by name first, then by alignment if 2
3937 sections have the same name.
3938 @item
3939 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
3940 It will sort the input sections by alignment first, then by name if 2
3941 sections have the same alignment.
3942 @item
3943 @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is
3944 treated the same as @code{SORT_BY_NAME} (wildcard section pattern).
3945 @item
3946 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern))
3947 is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern).
3948 @item
3949 All other nested section sorting commands are invalid.
3950 @end enumerate
3952 When both command line section sorting option and linker script
3953 section sorting command are used, section sorting command always
3954 takes precedence over the command line option.
3956 If the section sorting command in linker script isn't nested, the
3957 command line option will make the section sorting command to be
3958 treated as nested sorting command.
3960 @enumerate
3961 @item
3962 @code{SORT_BY_NAME} (wildcard section pattern ) with
3963 @option{--sort-sections alignment} is equivalent to
3964 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
3965 @item
3966 @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with
3967 @option{--sort-section name} is equivalent to
3968 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
3969 @end enumerate
3971 If the section sorting command in linker script is nested, the
3972 command line option will be ignored.
3974 If you ever get confused about where input sections are going, use the
3975 @samp{-M} linker option to generate a map file.  The map file shows
3976 precisely how input sections are mapped to output sections.
3978 This example shows how wildcard patterns might be used to partition
3979 files.  This linker script directs the linker to place all @samp{.text}
3980 sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}.
3981 The linker will place the @samp{.data} section from all files beginning
3982 with an upper case character in @samp{.DATA}; for all other files, the
3983 linker will place the @samp{.data} section in @samp{.data}.
3984 @smallexample
3985 @group
3986 SECTIONS @{
3987   .text : @{ *(.text) @}
3988   .DATA : @{ [A-Z]*(.data) @}
3989   .data : @{ *(.data) @}
3990   .bss : @{ *(.bss) @}
3992 @end group
3993 @end smallexample
3995 @node Input Section Common
3996 @subsubsection Input Section for Common Symbols
3997 @cindex common symbol placement
3998 @cindex uninitialized data placement
3999 A special notation is needed for common symbols, because in many object
4000 file formats common symbols do not have a particular input section.  The
4001 linker treats common symbols as though they are in an input section
4002 named @samp{COMMON}.
4004 You may use file names with the @samp{COMMON} section just as with any
4005 other input sections.  You can use this to place common symbols from a
4006 particular input file in one section while common symbols from other
4007 input files are placed in another section.
4009 In most cases, common symbols in input files will be placed in the
4010 @samp{.bss} section in the output file.  For example:
4011 @smallexample
4012 .bss @{ *(.bss) *(COMMON) @}
4013 @end smallexample
4015 @cindex scommon section
4016 @cindex small common symbols
4017 Some object file formats have more than one type of common symbol.  For
4018 example, the MIPS ELF object file format distinguishes standard common
4019 symbols and small common symbols.  In this case, the linker will use a
4020 different special section name for other types of common symbols.  In
4021 the case of MIPS ELF, the linker uses @samp{COMMON} for standard common
4022 symbols and @samp{.scommon} for small common symbols.  This permits you
4023 to map the different types of common symbols into memory at different
4024 locations.
4026 @cindex [COMMON]
4027 You will sometimes see @samp{[COMMON]} in old linker scripts.  This
4028 notation is now considered obsolete.  It is equivalent to
4029 @samp{*(COMMON)}.
4031 @node Input Section Keep
4032 @subsubsection Input Section and Garbage Collection
4033 @cindex KEEP
4034 @cindex garbage collection
4035 When link-time garbage collection is in use (@samp{--gc-sections}),
4036 it is often useful to mark sections that should not be eliminated.
4037 This is accomplished by surrounding an input section's wildcard entry
4038 with @code{KEEP()}, as in @code{KEEP(*(.init))} or
4039 @code{KEEP(SORT_BY_NAME(*)(.ctors))}.
4041 @node Input Section Example
4042 @subsubsection Input Section Example
4043 The following example is a complete linker script.  It tells the linker
4044 to read all of the sections from file @file{all.o} and place them at the
4045 start of output section @samp{outputa} which starts at location
4046 @samp{0x10000}.  All of section @samp{.input1} from file @file{foo.o}
4047 follows immediately, in the same output section.  All of section
4048 @samp{.input2} from @file{foo.o} goes into output section
4049 @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}.
4050 All of the remaining @samp{.input1} and @samp{.input2} sections from any
4051 files are written to output section @samp{outputc}.
4053 @smallexample
4054 @group
4055 SECTIONS @{
4056   outputa 0x10000 :
4057     @{
4058     all.o
4059     foo.o (.input1)
4060     @}
4061 @end group
4062 @group
4063   outputb :
4064     @{
4065     foo.o (.input2)
4066     foo1.o (.input1)
4067     @}
4068 @end group
4069 @group
4070   outputc :
4071     @{
4072     *(.input1)
4073     *(.input2)
4074     @}
4076 @end group
4077 @end smallexample
4079 @node Output Section Data
4080 @subsection Output Section Data
4081 @cindex data
4082 @cindex section data
4083 @cindex output section data
4084 @kindex BYTE(@var{expression})
4085 @kindex SHORT(@var{expression})
4086 @kindex LONG(@var{expression})
4087 @kindex QUAD(@var{expression})
4088 @kindex SQUAD(@var{expression})
4089 You can include explicit bytes of data in an output section by using
4090 @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as
4091 an output section command.  Each keyword is followed by an expression in
4092 parentheses providing the value to store (@pxref{Expressions}).  The
4093 value of the expression is stored at the current value of the location
4094 counter.
4096 The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands
4097 store one, two, four, and eight bytes (respectively).  After storing the
4098 bytes, the location counter is incremented by the number of bytes
4099 stored.
4101 For example, this will store the byte 1 followed by the four byte value
4102 of the symbol @samp{addr}:
4103 @smallexample
4104 BYTE(1)
4105 LONG(addr)
4106 @end smallexample
4108 When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the
4109 same; they both store an 8 byte, or 64 bit, value.  When both host and
4110 target are 32 bits, an expression is computed as 32 bits.  In this case
4111 @code{QUAD} stores a 32 bit value zero extended to 64 bits, and
4112 @code{SQUAD} stores a 32 bit value sign extended to 64 bits.
4114 If the object file format of the output file has an explicit endianness,
4115 which is the normal case, the value will be stored in that endianness.
4116 When the object file format does not have an explicit endianness, as is
4117 true of, for example, S-records, the value will be stored in the
4118 endianness of the first input object file.
4120 Note---these commands only work inside a section description and not
4121 between them, so the following will produce an error from the linker:
4122 @smallexample
4123 SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
4124 @end smallexample
4125 whereas this will work:
4126 @smallexample
4127 SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@
4128 @end smallexample
4130 @kindex FILL(@var{expression})
4131 @cindex holes, filling
4132 @cindex unspecified memory
4133 You may use the @code{FILL} command to set the fill pattern for the
4134 current section.  It is followed by an expression in parentheses.  Any
4135 otherwise unspecified regions of memory within the section (for example,
4136 gaps left due to the required alignment of input sections) are filled
4137 with the value of the expression, repeated as
4138 necessary.  A @code{FILL} statement covers memory locations after the
4139 point at which it occurs in the section definition; by including more
4140 than one @code{FILL} statement, you can have different fill patterns in
4141 different parts of an output section.
4143 This example shows how to fill unspecified regions of memory with the
4144 value @samp{0x90}:
4145 @smallexample
4146 FILL(0x90909090)
4147 @end smallexample
4149 The @code{FILL} command is similar to the @samp{=@var{fillexp}} output
4150 section attribute, but it only affects the
4151 part of the section following the @code{FILL} command, rather than the
4152 entire section.  If both are used, the @code{FILL} command takes
4153 precedence.  @xref{Output Section Fill}, for details on the fill
4154 expression.
4156 @node Output Section Keywords
4157 @subsection Output Section Keywords
4158 There are a couple of keywords which can appear as output section
4159 commands.
4161 @table @code
4162 @kindex CREATE_OBJECT_SYMBOLS
4163 @cindex input filename symbols
4164 @cindex filename symbols
4165 @item CREATE_OBJECT_SYMBOLS
4166 The command tells the linker to create a symbol for each input file.
4167 The name of each symbol will be the name of the corresponding input
4168 file.  The section of each symbol will be the output section in which
4169 the @code{CREATE_OBJECT_SYMBOLS} command appears.
4171 This is conventional for the a.out object file format.  It is not
4172 normally used for any other object file format.
4174 @kindex CONSTRUCTORS
4175 @cindex C++ constructors, arranging in link
4176 @cindex constructors, arranging in link
4177 @item CONSTRUCTORS
4178 When linking using the a.out object file format, the linker uses an
4179 unusual set construct to support C++ global constructors and
4180 destructors.  When linking object file formats which do not support
4181 arbitrary sections, such as ECOFF and XCOFF, the linker will
4182 automatically recognize C++ global constructors and destructors by name.
4183 For these object file formats, the @code{CONSTRUCTORS} command tells the
4184 linker to place constructor information in the output section where the
4185 @code{CONSTRUCTORS} command appears.  The @code{CONSTRUCTORS} command is
4186 ignored for other object file formats.
4188 The symbol @w{@code{__CTOR_LIST__}} marks the start of the global
4189 constructors, and the symbol @w{@code{__CTOR_END__}} marks the end.
4190 Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark
4191 the start and end of the global destructors.  The
4192 first word in the list is the number of entries, followed by the address
4193 of each constructor or destructor, followed by a zero word.  The
4194 compiler must arrange to actually run the code.  For these object file
4195 formats @sc{gnu} C++ normally calls constructors from a subroutine
4196 @code{__main}; a call to @code{__main} is automatically inserted into
4197 the startup code for @code{main}.  @sc{gnu} C++ normally runs
4198 destructors either by using @code{atexit}, or directly from the function
4199 @code{exit}.
4201 For object file formats such as @code{COFF} or @code{ELF} which support
4202 arbitrary section names, @sc{gnu} C++ will normally arrange to put the
4203 addresses of global constructors and destructors into the @code{.ctors}
4204 and @code{.dtors} sections.  Placing the following sequence into your
4205 linker script will build the sort of table which the @sc{gnu} C++
4206 runtime code expects to see.
4208 @smallexample
4209       __CTOR_LIST__ = .;
4210       LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2)
4211       *(.ctors)
4212       LONG(0)
4213       __CTOR_END__ = .;
4214       __DTOR_LIST__ = .;
4215       LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2)
4216       *(.dtors)
4217       LONG(0)
4218       __DTOR_END__ = .;
4219 @end smallexample
4221 If you are using the @sc{gnu} C++ support for initialization priority,
4222 which provides some control over the order in which global constructors
4223 are run, you must sort the constructors at link time to ensure that they
4224 are executed in the correct order.  When using the @code{CONSTRUCTORS}
4225 command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead.  When using the
4226 @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and
4227 @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and
4228 @samp{*(.dtors)}.
4230 Normally the compiler and linker will handle these issues automatically,
4231 and you will not need to concern yourself with them.  However, you may
4232 need to consider this if you are using C++ and writing your own linker
4233 scripts.
4235 @end table
4237 @node Output Section Discarding
4238 @subsection Output Section Discarding
4239 @cindex discarding sections
4240 @cindex sections, discarding
4241 @cindex removing sections
4242 The linker will not create output sections with no contents.  This is
4243 for convenience when referring to input sections that may or may not
4244 be present in any of the input files.  For example:
4245 @smallexample
4246 .foo : @{ *(.foo) @}
4247 @end smallexample
4248 @noindent
4249 will only create a @samp{.foo} section in the output file if there is a
4250 @samp{.foo} section in at least one input file, and if the input
4251 sections are not all empty.  Other link script directives that allocate
4252 space in an output section will also create the output section.
4254 The linker will ignore address assignments (@pxref{Output Section Address})
4255 on discarded output sections, except when the linker script defines
4256 symbols in the output section.  In that case the linker will obey
4257 the address assignments, possibly advancing dot even though the
4258 section is discarded.
4260 @cindex /DISCARD/
4261 The special output section name @samp{/DISCARD/} may be used to discard
4262 input sections.  Any input sections which are assigned to an output
4263 section named @samp{/DISCARD/} are not included in the output file.
4265 @node Output Section Attributes
4266 @subsection Output Section Attributes
4267 @cindex output section attributes
4268 We showed above that the full description of an output section looked
4269 like this:
4271 @smallexample
4272 @group
4273 @var{section} [@var{address}] [(@var{type})] :
4274   [AT(@var{lma})]
4275   [ALIGN(@var{section_align})]
4276   [SUBALIGN(@var{subsection_align})]
4277   [@var{constraint}]
4278   @{
4279     @var{output-section-command}
4280     @var{output-section-command}
4281     @dots{}
4282   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
4283 @end group
4284 @end smallexample
4286 We've already described @var{section}, @var{address}, and
4287 @var{output-section-command}.  In this section we will describe the
4288 remaining section attributes.
4290 @menu
4291 * Output Section Type::         Output section type
4292 * Output Section LMA::          Output section LMA
4293 * Forced Output Alignment::     Forced Output Alignment
4294 * Forced Input Alignment::      Forced Input Alignment
4295 * Output Section Constraint::   Output section constraint
4296 * Output Section Region::       Output section region
4297 * Output Section Phdr::         Output section phdr
4298 * Output Section Fill::         Output section fill
4299 @end menu
4301 @node Output Section Type
4302 @subsubsection Output Section Type
4303 Each output section may have a type.  The type is a keyword in
4304 parentheses.  The following types are defined:
4306 @table @code
4307 @item NOLOAD
4308 The section should be marked as not loadable, so that it will not be
4309 loaded into memory when the program is run.
4310 @item DSECT
4311 @itemx COPY
4312 @itemx INFO
4313 @itemx OVERLAY
4314 These type names are supported for backward compatibility, and are
4315 rarely used.  They all have the same effect: the section should be
4316 marked as not allocatable, so that no memory is allocated for the
4317 section when the program is run.
4318 @end table
4320 @kindex NOLOAD
4321 @cindex prevent unnecessary loading
4322 @cindex loading, preventing
4323 The linker normally sets the attributes of an output section based on
4324 the input sections which map into it.  You can override this by using
4325 the section type.  For example, in the script sample below, the
4326 @samp{ROM} section is addressed at memory location @samp{0} and does not
4327 need to be loaded when the program is run.
4328 @smallexample
4329 @group
4330 SECTIONS @{
4331   ROM 0 (NOLOAD) : @{ @dots{} @}
4332   @dots{}
4334 @end group
4335 @end smallexample
4337 @node Output Section LMA
4338 @subsubsection Output Section LMA
4339 @kindex AT>@var{lma_region}
4340 @kindex AT(@var{lma})
4341 @cindex load address
4342 @cindex section load address
4343 Every section has a virtual address (VMA) and a load address (LMA); see
4344 @ref{Basic Script Concepts}.  The virtual address is specified by the
4345 @pxref{Output Section Address} described earlier.  The load address is
4346 specified by the @code{AT} or @code{AT>} keywords.  Specifying a load
4347 address is optional.
4349 The @code{AT} keyword takes an expression as an argument.  This
4350 specifies the exact load address of the section.  The @code{AT>} keyword
4351 takes the name of a memory region as an argument.  @xref{MEMORY}.  The
4352 load address of the section is set to the next free address in the
4353 region, aligned to the section's alignment requirements.
4355 If neither @code{AT} nor @code{AT>} is specified for an allocatable
4356 section, the linker will use the following heuristic to determine the
4357 load address:
4359 @itemize @bullet
4360 @item
4361 If the section has a specific VMA address, then this is used as
4362 the LMA address as well.
4364 @item
4365 If the section is not allocatable then its LMA is set to its VMA.
4367 @item
4368 Otherwise if a memory region can be found that is compatible
4369 with the current section, and this region contains at least one
4370 section, then the LMA is set so the difference between the
4371 VMA and LMA is the same as the difference between the VMA and LMA of
4372 the last section in the located region.
4374 @item
4375 If no memory regions have been declared then a default region
4376 that covers the entire address space is used in the previous step.
4378 @item
4379 If no suitable region could be found, or there was no previous
4380 section then the LMA is set equal to the VMA.
4381 @end itemize
4383 @cindex ROM initialized data
4384 @cindex initialized data in ROM
4385 This feature is designed to make it easy to build a ROM image.  For
4386 example, the following linker script creates three output sections: one
4387 called @samp{.text}, which starts at @code{0x1000}, one called
4388 @samp{.mdata}, which is loaded at the end of the @samp{.text} section
4389 even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold
4390 uninitialized data at address @code{0x3000}.  The symbol @code{_data} is
4391 defined with the value @code{0x2000}, which shows that the location
4392 counter holds the VMA value, not the LMA value.
4394 @smallexample
4395 @group
4396 SECTIONS
4397   @{
4398   .text 0x1000 : @{ *(.text) _etext = . ; @}
4399   .mdata 0x2000 :
4400     AT ( ADDR (.text) + SIZEOF (.text) )
4401     @{ _data = . ; *(.data); _edata = . ;  @}
4402   .bss 0x3000 :
4403     @{ _bstart = . ;  *(.bss) *(COMMON) ; _bend = . ;@}
4405 @end group
4406 @end smallexample
4408 The run-time initialization code for use with a program generated with
4409 this linker script would include something like the following, to copy
4410 the initialized data from the ROM image to its runtime address.  Notice
4411 how this code takes advantage of the symbols defined by the linker
4412 script.
4414 @smallexample
4415 @group
4416 extern char _etext, _data, _edata, _bstart, _bend;
4417 char *src = &_etext;
4418 char *dst = &_data;
4420 /* ROM has data at end of text; copy it.  */
4421 while (dst < &_edata)
4422   *dst++ = *src++;
4424 /* Zero bss.  */
4425 for (dst = &_bstart; dst< &_bend; dst++)
4426   *dst = 0;
4427 @end group
4428 @end smallexample
4430 @node Forced Output Alignment
4431 @subsubsection Forced Output Alignment
4432 @kindex ALIGN(@var{section_align})
4433 @cindex forcing output section alignment
4434 @cindex output section alignment
4435 You can increase an output section's alignment by using ALIGN.
4437 @node Forced Input Alignment
4438 @subsubsection Forced Input Alignment
4439 @kindex SUBALIGN(@var{subsection_align})
4440 @cindex forcing input section alignment
4441 @cindex input section alignment
4442 You can force input section alignment within an output section by using
4443 SUBALIGN.  The value specified overrides any alignment given by input
4444 sections, whether larger or smaller.
4446 @node Output Section Constraint
4447 @subsubsection Output Section Constraint
4448 @kindex ONLY_IF_RO
4449 @kindex ONLY_IF_RW
4450 @cindex constraints on output sections
4451 You can specify that an output section should only be created if all
4452 of its input sections are read-only or all of its input sections are
4453 read-write by using the keyword @code{ONLY_IF_RO} and
4454 @code{ONLY_IF_RW} respectively.
4456 @node Output Section Region
4457 @subsubsection Output Section Region
4458 @kindex >@var{region}
4459 @cindex section, assigning to memory region
4460 @cindex memory regions and sections
4461 You can assign a section to a previously defined region of memory by
4462 using @samp{>@var{region}}.  @xref{MEMORY}.
4464 Here is a simple example:
4465 @smallexample
4466 @group
4467 MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @}
4468 SECTIONS @{ ROM : @{ *(.text) @} >rom @}
4469 @end group
4470 @end smallexample
4472 @node Output Section Phdr
4473 @subsubsection Output Section Phdr
4474 @kindex :@var{phdr}
4475 @cindex section, assigning to program header
4476 @cindex program headers and sections
4477 You can assign a section to a previously defined program segment by
4478 using @samp{:@var{phdr}}.  @xref{PHDRS}.  If a section is assigned to
4479 one or more segments, then all subsequent allocated sections will be
4480 assigned to those segments as well, unless they use an explicitly
4481 @code{:@var{phdr}} modifier.  You can use @code{:NONE} to tell the
4482 linker to not put the section in any segment at all.
4484 Here is a simple example:
4485 @smallexample
4486 @group
4487 PHDRS @{ text PT_LOAD ; @}
4488 SECTIONS @{ .text : @{ *(.text) @} :text @}
4489 @end group
4490 @end smallexample
4492 @node Output Section Fill
4493 @subsubsection Output Section Fill
4494 @kindex =@var{fillexp}
4495 @cindex section fill pattern
4496 @cindex fill pattern, entire section
4497 You can set the fill pattern for an entire section by using
4498 @samp{=@var{fillexp}}.  @var{fillexp} is an expression
4499 (@pxref{Expressions}).  Any otherwise unspecified regions of memory
4500 within the output section (for example, gaps left due to the required
4501 alignment of input sections) will be filled with the value, repeated as
4502 necessary.  If the fill expression is a simple hex number, ie. a string
4503 of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then
4504 an arbitrarily long sequence of hex digits can be used to specify the
4505 fill pattern;  Leading zeros become part of the pattern too.  For all
4506 other cases, including extra parentheses or a unary @code{+}, the fill
4507 pattern is the four least significant bytes of the value of the
4508 expression.  In all cases, the number is big-endian.
4510 You can also change the fill value with a @code{FILL} command in the
4511 output section commands; (@pxref{Output Section Data}).
4513 Here is a simple example:
4514 @smallexample
4515 @group
4516 SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @}
4517 @end group
4518 @end smallexample
4520 @node Overlay Description
4521 @subsection Overlay Description
4522 @kindex OVERLAY
4523 @cindex overlays
4524 An overlay description provides an easy way to describe sections which
4525 are to be loaded as part of a single memory image but are to be run at
4526 the same memory address.  At run time, some sort of overlay manager will
4527 copy the overlaid sections in and out of the runtime memory address as
4528 required, perhaps by simply manipulating addressing bits.  This approach
4529 can be useful, for example, when a certain region of memory is faster
4530 than another.
4532 Overlays are described using the @code{OVERLAY} command.  The
4533 @code{OVERLAY} command is used within a @code{SECTIONS} command, like an
4534 output section description.  The full syntax of the @code{OVERLAY}
4535 command is as follows:
4536 @smallexample
4537 @group
4538 OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )]
4539   @{
4540     @var{secname1}
4541       @{
4542         @var{output-section-command}
4543         @var{output-section-command}
4544         @dots{}
4545       @} [:@var{phdr}@dots{}] [=@var{fill}]
4546     @var{secname2}
4547       @{
4548         @var{output-section-command}
4549         @var{output-section-command}
4550         @dots{}
4551       @} [:@var{phdr}@dots{}] [=@var{fill}]
4552     @dots{}
4553   @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}]
4554 @end group
4555 @end smallexample
4557 Everything is optional except @code{OVERLAY} (a keyword), and each
4558 section must have a name (@var{secname1} and @var{secname2} above).  The
4559 section definitions within the @code{OVERLAY} construct are identical to
4560 those within the general @code{SECTIONS} contruct (@pxref{SECTIONS}),
4561 except that no addresses and no memory regions may be defined for
4562 sections within an @code{OVERLAY}.
4564 The sections are all defined with the same starting address.  The load
4565 addresses of the sections are arranged such that they are consecutive in
4566 memory starting at the load address used for the @code{OVERLAY} as a
4567 whole (as with normal section definitions, the load address is optional,
4568 and defaults to the start address; the start address is also optional,
4569 and defaults to the current value of the location counter).
4571 If the @code{NOCROSSREFS} keyword is used, and there any references
4572 among the sections, the linker will report an error.  Since the sections
4573 all run at the same address, it normally does not make sense for one
4574 section to refer directly to another.  @xref{Miscellaneous Commands,
4575 NOCROSSREFS}.
4577 For each section within the @code{OVERLAY}, the linker automatically
4578 provides two symbols.  The symbol @code{__load_start_@var{secname}} is
4579 defined as the starting load address of the section.  The symbol
4580 @code{__load_stop_@var{secname}} is defined as the final load address of
4581 the section.  Any characters within @var{secname} which are not legal
4582 within C identifiers are removed.  C (or assembler) code may use these
4583 symbols to move the overlaid sections around as necessary.
4585 At the end of the overlay, the value of the location counter is set to
4586 the start address of the overlay plus the size of the largest section.
4588 Here is an example.  Remember that this would appear inside a
4589 @code{SECTIONS} construct.
4590 @smallexample
4591 @group
4592   OVERLAY 0x1000 : AT (0x4000)
4593    @{
4594      .text0 @{ o1/*.o(.text) @}
4595      .text1 @{ o2/*.o(.text) @}
4596    @}
4597 @end group
4598 @end smallexample
4599 @noindent
4600 This will define both @samp{.text0} and @samp{.text1} to start at
4601 address 0x1000.  @samp{.text0} will be loaded at address 0x4000, and
4602 @samp{.text1} will be loaded immediately after @samp{.text0}.  The
4603 following symbols will be defined if referenced: @code{__load_start_text0},
4604 @code{__load_stop_text0}, @code{__load_start_text1},
4605 @code{__load_stop_text1}.
4607 C code to copy overlay @code{.text1} into the overlay area might look
4608 like the following.
4610 @smallexample
4611 @group
4612   extern char __load_start_text1, __load_stop_text1;
4613   memcpy ((char *) 0x1000, &__load_start_text1,
4614           &__load_stop_text1 - &__load_start_text1);
4615 @end group
4616 @end smallexample
4618 Note that the @code{OVERLAY} command is just syntactic sugar, since
4619 everything it does can be done using the more basic commands.  The above
4620 example could have been written identically as follows.
4622 @smallexample
4623 @group
4624   .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @}
4625   PROVIDE (__load_start_text0 = LOADADDR (.text0));
4626   PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0));
4627   .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @}
4628   PROVIDE (__load_start_text1 = LOADADDR (.text1));
4629   PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1));
4630   . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1));
4631 @end group
4632 @end smallexample
4634 @node MEMORY
4635 @section MEMORY Command
4636 @kindex MEMORY
4637 @cindex memory regions
4638 @cindex regions of memory
4639 @cindex allocating memory
4640 @cindex discontinuous memory
4641 The linker's default configuration permits allocation of all available
4642 memory.  You can override this by using the @code{MEMORY} command.
4644 The @code{MEMORY} command describes the location and size of blocks of
4645 memory in the target.  You can use it to describe which memory regions
4646 may be used by the linker, and which memory regions it must avoid.  You
4647 can then assign sections to particular memory regions.  The linker will
4648 set section addresses based on the memory regions, and will warn about
4649 regions that become too full.  The linker will not shuffle sections
4650 around to fit into the available regions.
4652 A linker script may contain at most one use of the @code{MEMORY}
4653 command.  However, you can define as many blocks of memory within it as
4654 you wish.  The syntax is:
4655 @smallexample
4656 @group
4657 MEMORY
4658   @{
4659     @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len}
4660     @dots{}
4661   @}
4662 @end group
4663 @end smallexample
4665 The @var{name} is a name used in the linker script to refer to the
4666 region.  The region name has no meaning outside of the linker script.
4667 Region names are stored in a separate name space, and will not conflict
4668 with symbol names, file names, or section names.  Each memory region
4669 must have a distinct name within the @code{MEMORY} command.  However you can
4670 add later alias names to existing memory regions with the @ref{REGION_ALIAS}
4671 command.  
4673 @cindex memory region attributes
4674 The @var{attr} string is an optional list of attributes that specify
4675 whether to use a particular memory region for an input section which is
4676 not explicitly mapped in the linker script.  As described in
4677 @ref{SECTIONS}, if you do not specify an output section for some input
4678 section, the linker will create an output section with the same name as
4679 the input section.  If you define region attributes, the linker will use
4680 them to select the memory region for the output section that it creates.
4682 The @var{attr} string must consist only of the following characters:
4683 @table @samp
4684 @item R
4685 Read-only section
4686 @item W
4687 Read/write section
4688 @item X
4689 Executable section
4690 @item A
4691 Allocatable section
4692 @item I
4693 Initialized section
4694 @item L
4695 Same as @samp{I}
4696 @item !
4697 Invert the sense of any of the attributes that follow
4698 @end table
4700 If a unmapped section matches any of the listed attributes other than
4701 @samp{!}, it will be placed in the memory region.  The @samp{!}
4702 attribute reverses this test, so that an unmapped section will be placed
4703 in the memory region only if it does not match any of the listed
4704 attributes.
4706 @kindex ORIGIN =
4707 @kindex o =
4708 @kindex org =
4709 The @var{origin} is an numerical expression for the start address of
4710 the memory region.  The expression must evaluate to a constant and it
4711 cannot involve any symbols.  The keyword @code{ORIGIN} may be
4712 abbreviated to @code{org} or @code{o} (but not, for example,
4713 @code{ORG}).
4715 @kindex LENGTH =
4716 @kindex len =
4717 @kindex l =
4718 The @var{len} is an expression for the size in bytes of the memory
4719 region.  As with the @var{origin} expression, the expression must
4720 be numerical only and must evaluate to a constant.  The keyword
4721 @code{LENGTH} may be abbreviated to @code{len} or @code{l}.
4723 In the following example, we specify that there are two memory regions
4724 available for allocation: one starting at @samp{0} for 256 kilobytes,
4725 and the other starting at @samp{0x40000000} for four megabytes.  The
4726 linker will place into the @samp{rom} memory region every section which
4727 is not explicitly mapped into a memory region, and is either read-only
4728 or executable.  The linker will place other sections which are not
4729 explicitly mapped into a memory region into the @samp{ram} memory
4730 region.
4732 @smallexample
4733 @group
4734 MEMORY
4735   @{
4736     rom (rx)  : ORIGIN = 0, LENGTH = 256K
4737     ram (!rx) : org = 0x40000000, l = 4M
4738   @}
4739 @end group
4740 @end smallexample
4742 Once you define a memory region, you can direct the linker to place
4743 specific output sections into that memory region by using the
4744 @samp{>@var{region}} output section attribute.  For example, if you have
4745 a memory region named @samp{mem}, you would use @samp{>mem} in the
4746 output section definition.  @xref{Output Section Region}.  If no address
4747 was specified for the output section, the linker will set the address to
4748 the next available address within the memory region.  If the combined
4749 output sections directed to a memory region are too large for the
4750 region, the linker will issue an error message.
4752 It is possible to access the origin and length of a memory in an
4753 expression via the @code{ORIGIN(@var{memory})} and
4754 @code{LENGTH(@var{memory})} functions:
4756 @smallexample
4757 @group
4758   _fstack = ORIGIN(ram) + LENGTH(ram) - 4;
4759 @end group
4760 @end smallexample
4762 @node PHDRS
4763 @section PHDRS Command
4764 @kindex PHDRS
4765 @cindex program headers
4766 @cindex ELF program headers
4767 @cindex program segments
4768 @cindex segments, ELF
4769 The ELF object file format uses @dfn{program headers}, also knows as
4770 @dfn{segments}.  The program headers describe how the program should be
4771 loaded into memory.  You can print them out by using the @code{objdump}
4772 program with the @samp{-p} option.
4774 When you run an ELF program on a native ELF system, the system loader
4775 reads the program headers in order to figure out how to load the
4776 program.  This will only work if the program headers are set correctly.
4777 This manual does not describe the details of how the system loader
4778 interprets program headers; for more information, see the ELF ABI.
4780 The linker will create reasonable program headers by default.  However,
4781 in some cases, you may need to specify the program headers more
4782 precisely.  You may use the @code{PHDRS} command for this purpose.  When
4783 the linker sees the @code{PHDRS} command in the linker script, it will
4784 not create any program headers other than the ones specified.
4786 The linker only pays attention to the @code{PHDRS} command when
4787 generating an ELF output file.  In other cases, the linker will simply
4788 ignore @code{PHDRS}.
4790 This is the syntax of the @code{PHDRS} command.  The words @code{PHDRS},
4791 @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords.
4793 @smallexample
4794 @group
4795 PHDRS
4797   @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ]
4798         [ FLAGS ( @var{flags} ) ] ;
4800 @end group
4801 @end smallexample
4803 The @var{name} is used only for reference in the @code{SECTIONS} command
4804 of the linker script.  It is not put into the output file.  Program
4805 header names are stored in a separate name space, and will not conflict
4806 with symbol names, file names, or section names.  Each program header
4807 must have a distinct name.  The headers are processed in order and it
4808 is usual for them to map to sections in ascending load address order.
4810 Certain program header types describe segments of memory which the
4811 system loader will load from the file.  In the linker script, you
4812 specify the contents of these segments by placing allocatable output
4813 sections in the segments.  You use the @samp{:@var{phdr}} output section
4814 attribute to place a section in a particular segment.  @xref{Output
4815 Section Phdr}.
4817 It is normal to put certain sections in more than one segment.  This
4818 merely implies that one segment of memory contains another.  You may
4819 repeat @samp{:@var{phdr}}, using it once for each segment which should
4820 contain the section.
4822 If you place a section in one or more segments using @samp{:@var{phdr}},
4823 then the linker will place all subsequent allocatable sections which do
4824 not specify @samp{:@var{phdr}} in the same segments.  This is for
4825 convenience, since generally a whole set of contiguous sections will be
4826 placed in a single segment.  You can use @code{:NONE} to override the
4827 default segment and tell the linker to not put the section in any
4828 segment at all.
4830 @kindex FILEHDR
4831 @kindex PHDRS
4832 You may use the @code{FILEHDR} and @code{PHDRS} keywords after
4833 the program header type to further describe the contents of the segment.
4834 The @code{FILEHDR} keyword means that the segment should include the ELF
4835 file header.  The @code{PHDRS} keyword means that the segment should
4836 include the ELF program headers themselves.  If applied to a loadable
4837 segment (@code{PT_LOAD}), all prior loadable segments must have one of
4838 these keywords.
4840 The @var{type} may be one of the following.  The numbers indicate the
4841 value of the keyword.
4843 @table @asis
4844 @item @code{PT_NULL} (0)
4845 Indicates an unused program header.
4847 @item @code{PT_LOAD} (1)
4848 Indicates that this program header describes a segment to be loaded from
4849 the file.
4851 @item @code{PT_DYNAMIC} (2)
4852 Indicates a segment where dynamic linking information can be found.
4854 @item @code{PT_INTERP} (3)
4855 Indicates a segment where the name of the program interpreter may be
4856 found.
4858 @item @code{PT_NOTE} (4)
4859 Indicates a segment holding note information.
4861 @item @code{PT_SHLIB} (5)
4862 A reserved program header type, defined but not specified by the ELF
4863 ABI.
4865 @item @code{PT_PHDR} (6)
4866 Indicates a segment where the program headers may be found.
4868 @item @var{expression}
4869 An expression giving the numeric type of the program header.  This may
4870 be used for types not defined above.
4871 @end table
4873 You can specify that a segment should be loaded at a particular address
4874 in memory by using an @code{AT} expression.  This is identical to the
4875 @code{AT} command used as an output section attribute (@pxref{Output
4876 Section LMA}).  The @code{AT} command for a program header overrides the
4877 output section attribute.
4879 The linker will normally set the segment flags based on the sections
4880 which comprise the segment.  You may use the @code{FLAGS} keyword to
4881 explicitly specify the segment flags.  The value of @var{flags} must be
4882 an integer.  It is used to set the @code{p_flags} field of the program
4883 header.
4885 Here is an example of @code{PHDRS}.  This shows a typical set of program
4886 headers used on a native ELF system.
4888 @example
4889 @group
4890 PHDRS
4892   headers PT_PHDR PHDRS ;
4893   interp PT_INTERP ;
4894   text PT_LOAD FILEHDR PHDRS ;
4895   data PT_LOAD ;
4896   dynamic PT_DYNAMIC ;
4899 SECTIONS
4901   . = SIZEOF_HEADERS;
4902   .interp : @{ *(.interp) @} :text :interp
4903   .text : @{ *(.text) @} :text
4904   .rodata : @{ *(.rodata) @} /* defaults to :text */
4905   @dots{}
4906   . = . + 0x1000; /* move to a new page in memory */
4907   .data : @{ *(.data) @} :data
4908   .dynamic : @{ *(.dynamic) @} :data :dynamic
4909   @dots{}
4911 @end group
4912 @end example
4914 @node VERSION
4915 @section VERSION Command
4916 @kindex VERSION @{script text@}
4917 @cindex symbol versions
4918 @cindex version script
4919 @cindex versions of symbols
4920 The linker supports symbol versions when using ELF.  Symbol versions are
4921 only useful when using shared libraries.  The dynamic linker can use
4922 symbol versions to select a specific version of a function when it runs
4923 a program that may have been linked against an earlier version of the
4924 shared library.
4926 You can include a version script directly in the main linker script, or
4927 you can supply the version script as an implicit linker script.  You can
4928 also use the @samp{--version-script} linker option.
4930 The syntax of the @code{VERSION} command is simply
4931 @smallexample
4932 VERSION @{ version-script-commands @}
4933 @end smallexample
4935 The format of the version script commands is identical to that used by
4936 Sun's linker in Solaris 2.5.  The version script defines a tree of
4937 version nodes.  You specify the node names and interdependencies in the
4938 version script.  You can specify which symbols are bound to which
4939 version nodes, and you can reduce a specified set of symbols to local
4940 scope so that they are not globally visible outside of the shared
4941 library.
4943 The easiest way to demonstrate the version script language is with a few
4944 examples.
4946 @smallexample
4947 VERS_1.1 @{
4948          global:
4949                  foo1;
4950          local:
4951                  old*;
4952                  original*;
4953                  new*;
4956 VERS_1.2 @{
4957                  foo2;
4958 @} VERS_1.1;
4960 VERS_2.0 @{
4961                  bar1; bar2;
4962          extern "C++" @{
4963                  ns::*;
4964                  "f(int, double)";
4965          @};
4966 @} VERS_1.2;
4967 @end smallexample
4969 This example version script defines three version nodes.  The first
4970 version node defined is @samp{VERS_1.1}; it has no other dependencies.
4971 The script binds the symbol @samp{foo1} to @samp{VERS_1.1}.  It reduces
4972 a number of symbols to local scope so that they are not visible outside
4973 of the shared library; this is done using wildcard patterns, so that any
4974 symbol whose name begins with @samp{old}, @samp{original}, or @samp{new}
4975 is matched.  The wildcard patterns available are the same as those used
4976 in the shell when matching filenames (also known as ``globbing'').
4977 However, if you specify the symbol name inside double quotes, then the
4978 name is treated as literal, rather than as a glob pattern.
4980 Next, the version script defines node @samp{VERS_1.2}.  This node
4981 depends upon @samp{VERS_1.1}.  The script binds the symbol @samp{foo2}
4982 to the version node @samp{VERS_1.2}.
4984 Finally, the version script defines node @samp{VERS_2.0}.  This node
4985 depends upon @samp{VERS_1.2}.  The scripts binds the symbols @samp{bar1}
4986 and @samp{bar2} are bound to the version node @samp{VERS_2.0}.
4988 When the linker finds a symbol defined in a library which is not
4989 specifically bound to a version node, it will effectively bind it to an
4990 unspecified base version of the library.  You can bind all otherwise
4991 unspecified symbols to a given version node by using @samp{global: *;}
4992 somewhere in the version script.  Note that it's slightly crazy to use
4993 wildcards in a global spec except on the last version node.  Global
4994 wildcards elsewhere run the risk of accidentally adding symbols to the
4995 set exported for an old version.  That's wrong since older versions
4996 ought to have a fixed set of symbols.
4998 The names of the version nodes have no specific meaning other than what
4999 they might suggest to the person reading them.  The @samp{2.0} version
5000 could just as well have appeared in between @samp{1.1} and @samp{1.2}.
5001 However, this would be a confusing way to write a version script.
5003 Node name can be omitted, provided it is the only version node
5004 in the version script.  Such version script doesn't assign any versions to
5005 symbols, only selects which symbols will be globally visible out and which
5006 won't.
5008 @smallexample
5009 @{ global: foo; bar; local: *; @};
5010 @end smallexample
5012 When you link an application against a shared library that has versioned
5013 symbols, the application itself knows which version of each symbol it
5014 requires, and it also knows which version nodes it needs from each
5015 shared library it is linked against.  Thus at runtime, the dynamic
5016 loader can make a quick check to make sure that the libraries you have
5017 linked against do in fact supply all of the version nodes that the
5018 application will need to resolve all of the dynamic symbols.  In this
5019 way it is possible for the dynamic linker to know with certainty that
5020 all external symbols that it needs will be resolvable without having to
5021 search for each symbol reference.
5023 The symbol versioning is in effect a much more sophisticated way of
5024 doing minor version checking that SunOS does.  The fundamental problem
5025 that is being addressed here is that typically references to external
5026 functions are bound on an as-needed basis, and are not all bound when
5027 the application starts up.  If a shared library is out of date, a
5028 required interface may be missing; when the application tries to use
5029 that interface, it may suddenly and unexpectedly fail.  With symbol
5030 versioning, the user will get a warning when they start their program if
5031 the libraries being used with the application are too old.
5033 There are several GNU extensions to Sun's versioning approach.  The
5034 first of these is the ability to bind a symbol to a version node in the
5035 source file where the symbol is defined instead of in the versioning
5036 script.  This was done mainly to reduce the burden on the library
5037 maintainer.  You can do this by putting something like:
5038 @smallexample
5039 __asm__(".symver original_foo,foo@@VERS_1.1");
5040 @end smallexample
5041 @noindent
5042 in the C source file.  This renames the function @samp{original_foo} to
5043 be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}.
5044 The @samp{local:} directive can be used to prevent the symbol
5045 @samp{original_foo} from being exported. A @samp{.symver} directive
5046 takes precedence over a version script.
5048 The second GNU extension is to allow multiple versions of the same
5049 function to appear in a given shared library.  In this way you can make
5050 an incompatible change to an interface without increasing the major
5051 version number of the shared library, while still allowing applications
5052 linked against the old interface to continue to function.
5054 To do this, you must use multiple @samp{.symver} directives in the
5055 source file.  Here is an example:
5057 @smallexample
5058 __asm__(".symver original_foo,foo@@");
5059 __asm__(".symver old_foo,foo@@VERS_1.1");
5060 __asm__(".symver old_foo1,foo@@VERS_1.2");
5061 __asm__(".symver new_foo,foo@@@@VERS_2.0");
5062 @end smallexample
5064 In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the
5065 unspecified base version of the symbol.  The source file that contains this
5066 example would define 4 C functions: @samp{original_foo}, @samp{old_foo},
5067 @samp{old_foo1}, and @samp{new_foo}.
5069 When you have multiple definitions of a given symbol, there needs to be
5070 some way to specify a default version to which external references to
5071 this symbol will be bound.  You can do this with the
5072 @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive.  You can only
5073 declare one version of a symbol as the default in this manner; otherwise
5074 you would effectively have multiple definitions of the same symbol.
5076 If you wish to bind a reference to a specific version of the symbol
5077 within the shared library, you can use the aliases of convenience
5078 (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to
5079 specifically bind to an external version of the function in question.
5081 You can also specify the language in the version script:
5083 @smallexample
5084 VERSION extern "lang" @{ version-script-commands @}
5085 @end smallexample
5087 The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}.
5088 The linker will iterate over the list of symbols at the link time and
5089 demangle them according to @samp{lang} before matching them to the
5090 patterns specified in @samp{version-script-commands}.  The default
5091 @samp{lang} is @samp{C}.
5093 Demangled names may contains spaces and other special characters.  As
5094 described above, you can use a glob pattern to match demangled names,
5095 or you can use a double-quoted string to match the string exactly.  In
5096 the latter case, be aware that minor differences (such as differing
5097 whitespace) between the version script and the demangler output will
5098 cause a mismatch.  As the exact string generated by the demangler
5099 might change in the future, even if the mangled name does not, you
5100 should check that all of your version directives are behaving as you
5101 expect when you upgrade.
5103 @node Expressions
5104 @section Expressions in Linker Scripts
5105 @cindex expressions
5106 @cindex arithmetic
5107 The syntax for expressions in the linker script language is identical to
5108 that of C expressions.  All expressions are evaluated as integers.  All
5109 expressions are evaluated in the same size, which is 32 bits if both the
5110 host and target are 32 bits, and is otherwise 64 bits.
5112 You can use and set symbol values in expressions.
5114 The linker defines several special purpose builtin functions for use in
5115 expressions.
5117 @menu
5118 * Constants::                   Constants
5119 * Symbolic Constants::          Symbolic constants
5120 * Symbols::                     Symbol Names
5121 * Orphan Sections::             Orphan Sections
5122 * Location Counter::            The Location Counter
5123 * Operators::                   Operators
5124 * Evaluation::                  Evaluation
5125 * Expression Section::          The Section of an Expression
5126 * Builtin Functions::           Builtin Functions
5127 @end menu
5129 @node Constants
5130 @subsection Constants
5131 @cindex integer notation
5132 @cindex constants in linker scripts
5133 All constants are integers.
5135 As in C, the linker considers an integer beginning with @samp{0} to be
5136 octal, and an integer beginning with @samp{0x} or @samp{0X} to be
5137 hexadecimal.  Alternatively the linker accepts suffixes of @samp{h} or
5138 @samp{H} for hexadeciaml, @samp{o} or @samp{O} for octal, @samp{b} or
5139 @samp{B} for binary and @samp{d} or @samp{D} for decimal.  Any integer
5140 value without a prefix or a suffix is considered to be decimal.
5142 @cindex scaled integers
5143 @cindex K and M integer suffixes
5144 @cindex M and K integer suffixes
5145 @cindex suffixes for integers
5146 @cindex integer suffixes
5147 In addition, you can use the suffixes @code{K} and @code{M} to scale a
5148 constant by
5149 @c TEXI2ROFF-KILL
5150 @ifnottex
5151 @c END TEXI2ROFF-KILL
5152 @code{1024} or @code{1024*1024}
5153 @c TEXI2ROFF-KILL
5154 @end ifnottex
5155 @tex
5156 ${\rm 1024}$ or ${\rm 1024}^2$
5157 @end tex
5158 @c END TEXI2ROFF-KILL
5159 respectively.  For example, the following
5160 all refer to the same quantity:
5162 @smallexample
5163 _fourk_1 = 4K;
5164 _fourk_2 = 4096;
5165 _fourk_3 = 0x1000;
5166 _fourk_4 = 10000o;
5167 @end smallexample
5169 Note - the @code{K} and @code{M} suffixes cannot be used in
5170 conjunction with the base suffixes mentioned above.
5172 @node Symbolic Constants
5173 @subsection Symbolic Constants
5174 @cindex symbolic constants
5175 @kindex CONSTANT
5176 It is possible to refer to target specific constants via the use of
5177 the @code{CONSTANT(@var{name})} operator, where @var{name} is one of:
5179 @table @code
5180 @item MAXPAGESIZE
5181 @kindex MAXPAGESIZE
5182 The target's maximum page size.
5184 @item COMMONPAGESIZE
5185 @kindex COMMONPAGESIZE
5186 The target's default page size.
5187 @end table
5189 So for example:
5191 @smallexample
5192   .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @} 
5193 @end smallexample
5195 will create a text section aligned to the largest page boundary
5196 supported by the target.
5198 @node Symbols
5199 @subsection Symbol Names
5200 @cindex symbol names
5201 @cindex names
5202 @cindex quoted symbol names
5203 @kindex "
5204 Unless quoted, symbol names start with a letter, underscore, or period
5205 and may include letters, digits, underscores, periods, and hyphens.
5206 Unquoted symbol names must not conflict with any keywords.  You can
5207 specify a symbol which contains odd characters or has the same name as a
5208 keyword by surrounding the symbol name in double quotes:
5209 @smallexample
5210 "SECTION" = 9;
5211 "with a space" = "also with a space" + 10;
5212 @end smallexample
5214 Since symbols can contain many non-alphabetic characters, it is safest
5215 to delimit symbols with spaces.  For example, @samp{A-B} is one symbol,
5216 whereas @samp{A - B} is an expression involving subtraction.
5218 @node Orphan Sections
5219 @subsection Orphan Sections
5220 @cindex orphan
5221 Orphan sections are sections present in the input files which
5222 are not explicitly placed into the output file by the linker
5223 script.  The linker will still copy these sections into the
5224 output file, but it has to guess as to where they should be
5225 placed.  The linker uses a simple heuristic to do this.  It
5226 attempts to place orphan sections after non-orphan sections of the
5227 same attribute, such as code vs data, loadable vs non-loadable, etc.
5228 If there is not enough room to do this then it places
5229 at the end of the file.
5231 For ELF targets, the attribute of the section includes section type as
5232 well as section flag.
5234 If an orphaned section's name is representable as a C identifier then
5235 the linker will automatically @pxref{PROVIDE} two symbols:
5236 __start_SECNAME and __end_SECNAME, where SECNAME is the name of the
5237 section.  These indicate the start address and end address of the
5238 orphaned section respectively.  Note: most section names are not
5239 representable as C identifiers because they contain a @samp{.}
5240 character.
5242 @node Location Counter
5243 @subsection The Location Counter
5244 @kindex .
5245 @cindex dot
5246 @cindex location counter
5247 @cindex current output location
5248 The special linker variable @dfn{dot} @samp{.} always contains the
5249 current output location counter.  Since the @code{.} always refers to a
5250 location in an output section, it may only appear in an expression
5251 within a @code{SECTIONS} command.  The @code{.} symbol may appear
5252 anywhere that an ordinary symbol is allowed in an expression.
5254 @cindex holes
5255 Assigning a value to @code{.} will cause the location counter to be
5256 moved.  This may be used to create holes in the output section.  The
5257 location counter may not be moved backwards inside an output section,
5258 and may not be moved backwards outside of an output section if so
5259 doing creates areas with overlapping LMAs.
5261 @smallexample
5262 SECTIONS
5264   output :
5265     @{
5266       file1(.text)
5267       . = . + 1000;
5268       file2(.text)
5269       . += 1000;
5270       file3(.text)
5271     @} = 0x12345678;
5273 @end smallexample
5274 @noindent
5275 In the previous example, the @samp{.text} section from @file{file1} is
5276 located at the beginning of the output section @samp{output}.  It is
5277 followed by a 1000 byte gap.  Then the @samp{.text} section from
5278 @file{file2} appears, also with a 1000 byte gap following before the
5279 @samp{.text} section from @file{file3}.  The notation @samp{= 0x12345678}
5280 specifies what data to write in the gaps (@pxref{Output Section Fill}).
5282 @cindex dot inside sections
5283 Note: @code{.} actually refers to the byte offset from the start of the
5284 current containing object.  Normally this is the @code{SECTIONS}
5285 statement, whose start address is 0, hence @code{.} can be used as an
5286 absolute address.  If @code{.} is used inside a section description
5287 however, it refers to the byte offset from the start of that section,
5288 not an absolute address.  Thus in a script like this:
5290 @smallexample
5291 SECTIONS
5293     . = 0x100
5294     .text: @{
5295       *(.text)
5296       . = 0x200
5297     @}
5298     . = 0x500
5299     .data: @{
5300       *(.data)
5301       . += 0x600
5302     @}
5304 @end smallexample
5306 The @samp{.text} section will be assigned a starting address of 0x100
5307 and a size of exactly 0x200 bytes, even if there is not enough data in
5308 the @samp{.text} input sections to fill this area.  (If there is too
5309 much data, an error will be produced because this would be an attempt to
5310 move @code{.} backwards).  The @samp{.data} section will start at 0x500
5311 and it will have an extra 0x600 bytes worth of space after the end of
5312 the values from the @samp{.data} input sections and before the end of
5313 the @samp{.data} output section itself.
5315 @cindex dot outside sections
5316 Setting symbols to the value of the location counter outside of an
5317 output section statement can result in unexpected values if the linker
5318 needs to place orphan sections.  For example, given the following:
5320 @smallexample
5321 SECTIONS
5323     start_of_text = . ;
5324     .text: @{ *(.text) @}
5325     end_of_text = . ;
5327     start_of_data = . ;
5328     .data: @{ *(.data) @}
5329     end_of_data = . ;
5331 @end smallexample
5333 If the linker needs to place some input section, e.g. @code{.rodata},
5334 not mentioned in the script, it might choose to place that section
5335 between @code{.text} and @code{.data}.  You might think the linker
5336 should place @code{.rodata} on the blank line in the above script, but
5337 blank lines are of no particular significance to the linker.  As well,
5338 the linker doesn't associate the above symbol names with their
5339 sections.  Instead, it assumes that all assignments or other
5340 statements belong to the previous output section, except for the
5341 special case of an assignment to @code{.}.  I.e., the linker will
5342 place the orphan @code{.rodata} section as if the script was written
5343 as follows:
5345 @smallexample
5346 SECTIONS
5348     start_of_text = . ;
5349     .text: @{ *(.text) @}
5350     end_of_text = . ;
5352     start_of_data = . ;
5353     .rodata: @{ *(.rodata) @}
5354     .data: @{ *(.data) @}
5355     end_of_data = . ;
5357 @end smallexample
5359 This may or may not be the script author's intention for the value of
5360 @code{start_of_data}.  One way to influence the orphan section
5361 placement is to assign the location counter to itself, as the linker
5362 assumes that an assignment to @code{.} is setting the start address of
5363 a following output section and thus should be grouped with that
5364 section.  So you could write:
5366 @smallexample
5367 SECTIONS
5369     start_of_text = . ;
5370     .text: @{ *(.text) @}
5371     end_of_text = . ;
5373     . = . ;
5374     start_of_data = . ;
5375     .data: @{ *(.data) @}
5376     end_of_data = . ;
5378 @end smallexample
5380 Now, the orphan @code{.rodata} section will be placed between
5381 @code{end_of_text} and @code{start_of_data}.
5383 @need 2000
5384 @node Operators
5385 @subsection Operators
5386 @cindex operators for arithmetic
5387 @cindex arithmetic operators
5388 @cindex precedence in expressions
5389 The linker recognizes the standard C set of arithmetic operators, with
5390 the standard bindings and precedence levels:
5391 @c TEXI2ROFF-KILL
5392 @ifnottex
5393 @c END TEXI2ROFF-KILL
5394 @smallexample
5395 precedence      associativity   Operators                Notes
5396 (highest)
5397 1               left            !  -  ~                  (1)
5398 2               left            *  /  %
5399 3               left            +  -
5400 4               left            >>  <<
5401 5               left            ==  !=  >  <  <=  >=
5402 6               left            &
5403 7               left            |
5404 8               left            &&
5405 9               left            ||
5406 10              right           ? :
5407 11              right           &=  +=  -=  *=  /=       (2)
5408 (lowest)
5409 @end smallexample
5410 Notes:
5411 (1) Prefix operators
5412 (2) @xref{Assignments}.
5413 @c TEXI2ROFF-KILL
5414 @end ifnottex
5415 @tex
5416 \vskip \baselineskip
5417 %"lispnarrowing" is the extra indent used generally for smallexample
5418 \hskip\lispnarrowing\vbox{\offinterlineskip
5419 \hrule
5420 \halign
5421 {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr
5422 height2pt&\omit&&\omit&&\omit&\cr
5423 &Precedence&&  Associativity  &&{\rm Operators}&\cr
5424 height2pt&\omit&&\omit&&\omit&\cr
5425 \noalign{\hrule}
5426 height2pt&\omit&&\omit&&\omit&\cr
5427 &highest&&&&&\cr
5428 % '176 is tilde, '~' in tt font
5429 &1&&left&&\qquad-          \char'176\      !\qquad\dag&\cr
5430 &2&&left&&*          /        \%&\cr
5431 &3&&left&&+          -&\cr
5432 &4&&left&&>>         <<&\cr
5433 &5&&left&&==         !=       >      <      <=      >=&\cr
5434 &6&&left&&\&&\cr
5435 &7&&left&&|&\cr
5436 &8&&left&&{\&\&}&\cr
5437 &9&&left&&||&\cr
5438 &10&&right&&?        :&\cr
5439 &11&&right&&\qquad\&=      +=       -=     *=     /=\qquad\ddag&\cr
5440 &lowest&&&&&\cr
5441 height2pt&\omit&&\omit&&\omit&\cr}
5442 \hrule}
5443 @end tex
5444 @iftex
5446 @obeylines@parskip=0pt@parindent=0pt
5447 @dag@quad Prefix operators.
5448 @ddag@quad @xref{Assignments}.
5450 @end iftex
5451 @c END TEXI2ROFF-KILL
5453 @node Evaluation
5454 @subsection Evaluation
5455 @cindex lazy evaluation
5456 @cindex expression evaluation order
5457 The linker evaluates expressions lazily.  It only computes the value of
5458 an expression when absolutely necessary.
5460 The linker needs some information, such as the value of the start
5461 address of the first section, and the origins and lengths of memory
5462 regions, in order to do any linking at all.  These values are computed
5463 as soon as possible when the linker reads in the linker script.
5465 However, other values (such as symbol values) are not known or needed
5466 until after storage allocation.  Such values are evaluated later, when
5467 other information (such as the sizes of output sections) is available
5468 for use in the symbol assignment expression.
5470 The sizes of sections cannot be known until after allocation, so
5471 assignments dependent upon these are not performed until after
5472 allocation.
5474 Some expressions, such as those depending upon the location counter
5475 @samp{.}, must be evaluated during section allocation.
5477 If the result of an expression is required, but the value is not
5478 available, then an error results.  For example, a script like the
5479 following
5480 @smallexample
5481 @group
5482 SECTIONS
5483   @{
5484     .text 9+this_isnt_constant :
5485       @{ *(.text) @}
5486   @}
5487 @end group
5488 @end smallexample
5489 @noindent
5490 will cause the error message @samp{non constant expression for initial
5491 address}.
5493 @node Expression Section
5494 @subsection The Section of an Expression
5495 @cindex expression sections
5496 @cindex absolute expressions
5497 @cindex relative expressions
5498 @cindex absolute and relocatable symbols
5499 @cindex relocatable and absolute symbols
5500 @cindex symbols, relocatable and absolute
5501 Addresses and symbols may be section relative, or absolute.  A section
5502 relative symbol is relocatable.  If you request relocatable output
5503 using the @samp{-r} option, a further link operation may change the
5504 value of a section relative symbol.  On the other hand, an absolute
5505 symbol will retain the same value throughout any further link
5506 operations.
5508 Some terms in linker expressions are addresses.  This is true of
5509 section relative symbols and for builtin functions that return an
5510 address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and
5511 @code{SEGMENT_START}.  Other terms are simply numbers, or are builtin
5512 functions that return a non-address value, such as @code{LENGTH}.
5513 One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")}
5514 (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated
5515 differently depending on their location, for compatibility with older
5516 versions of @code{ld}.  Expressions appearing outside an output
5517 section definition treat all numbers as absolute addresses.
5518 Expressions appearing inside an output section definition treat
5519 absolute symbols as numbers.  If @code{LD_FEATURE ("SANE_EXPR")} is
5520 given, then absolute symbols and numbers are simply treated as numbers
5521 everywhere.
5523 In the following simple example,
5525 @smallexample
5526 @group
5527 SECTIONS
5528   @{
5529     . = 0x100;
5530     __executable_start = 0x100;
5531     .data :
5532     @{
5533       . = 0x10;
5534       __data_start = 0x10;
5535       *(.data)
5536     @}
5537     @dots{}
5538   @}
5539 @end group
5540 @end smallexample
5542 both @code{.} and @code{__executable_start} are set to the absolute
5543 address 0x100 in the first two assignments, then both @code{.} and
5544 @code{__data_start} are set to 0x10 relative to the @code{.data}
5545 section in the second two assignments.
5547 For expressions involving numbers, relative addresses and absolute
5548 addresses, ld follows these rules to evaluate terms:
5550 @itemize @bullet
5551 @item
5552 Unary operations on a relative address, and binary operations on two
5553 relative addresses in the same section or between one relative address
5554 and a number, apply the operator to the offset part of the address(es).
5555 @item
5556 Unary operations on an absolute address, and binary operations on one
5557 or more absolute addresses or on two relative addresses not in the
5558 same section, first convert any non-absolute term to an absolute
5559 address before applying the operator.
5560 @end itemize
5562 The result section of each sub-expression is as follows:
5564 @itemize @bullet
5565 @item
5566 An operation involving only numbers results in a number.
5567 @item
5568 The result of comparisons, @samp{&&} and @samp{||} is also a number.
5569 @item
5570 The result of other operations on relative addresses (after above
5571 conversions) is a relative address in the same section as the operand(s).
5572 @item
5573 The result of other operations on absolute addresses (after above
5574 conversions) is an absolute address.
5575 @end itemize
5577 You can use the builtin function @code{ABSOLUTE} to force an expression
5578 to be absolute when it would otherwise be relative.  For example, to
5579 create an absolute symbol set to the address of the end of the output
5580 section @samp{.data}:
5581 @smallexample
5582 SECTIONS
5583   @{
5584     .data : @{ *(.data) _edata = ABSOLUTE(.); @}
5585   @}
5586 @end smallexample
5587 @noindent
5588 If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the
5589 @samp{.data} section.
5591 Using @code{LOADADDR} also forces an expression absolute, since this
5592 particular builtin function returns an absolute address.
5594 @node Builtin Functions
5595 @subsection Builtin Functions
5596 @cindex functions in expressions
5597 The linker script language includes a number of builtin functions for
5598 use in linker script expressions.
5600 @table @code
5601 @item ABSOLUTE(@var{exp})
5602 @kindex ABSOLUTE(@var{exp})
5603 @cindex expression, absolute
5604 Return the absolute (non-relocatable, as opposed to non-negative) value
5605 of the expression @var{exp}.  Primarily useful to assign an absolute
5606 value to a symbol within a section definition, where symbol values are
5607 normally section relative.  @xref{Expression Section}.
5609 @item ADDR(@var{section})
5610 @kindex ADDR(@var{section})
5611 @cindex section address in expression
5612 Return the address (VMA) of the named @var{section}.  Your
5613 script must previously have defined the location of that section.  In
5614 the following example, @code{start_of_output_1}, @code{symbol_1} and
5615 @code{symbol_2} are assigned equivalent values, except that
5616 @code{symbol_1} will be relative to the @code{.output1} section while
5617 the other two will be absolute:
5618 @smallexample
5619 @group
5620 SECTIONS @{ @dots{}
5621   .output1 :
5622     @{
5623     start_of_output_1 = ABSOLUTE(.);
5624     @dots{}
5625     @}
5626   .output :
5627     @{
5628     symbol_1 = ADDR(.output1);
5629     symbol_2 = start_of_output_1;
5630     @}
5631 @dots{} @}
5632 @end group
5633 @end smallexample
5635 @item ALIGN(@var{align})
5636 @itemx ALIGN(@var{exp},@var{align})
5637 @kindex ALIGN(@var{align})
5638 @kindex ALIGN(@var{exp},@var{align})
5639 @cindex round up location counter
5640 @cindex align location counter
5641 @cindex round up expression
5642 @cindex align expression
5643 Return the location counter (@code{.}) or arbitrary expression aligned
5644 to the next @var{align} boundary.  The single operand @code{ALIGN}
5645 doesn't change the value of the location counter---it just does
5646 arithmetic on it.  The two operand @code{ALIGN} allows an arbitrary
5647 expression to be aligned upwards (@code{ALIGN(@var{align})} is
5648 equivalent to @code{ALIGN(., @var{align})}).
5650 Here is an example which aligns the output @code{.data} section to the
5651 next @code{0x2000} byte boundary after the preceding section and sets a
5652 variable within the section to the next @code{0x8000} boundary after the
5653 input sections:
5654 @smallexample
5655 @group
5656 SECTIONS @{ @dots{}
5657   .data ALIGN(0x2000): @{
5658     *(.data)
5659     variable = ALIGN(0x8000);
5660   @}
5661 @dots{} @}
5662 @end group
5663 @end smallexample
5664 @noindent
5665 The first use of @code{ALIGN} in this example specifies the location of
5666 a section because it is used as the optional @var{address} attribute of
5667 a section definition (@pxref{Output Section Address}).  The second use
5668 of @code{ALIGN} is used to defines the value of a symbol.
5670 The builtin function @code{NEXT} is closely related to @code{ALIGN}.
5672 @item ALIGNOF(@var{section})
5673 @kindex ALIGNOF(@var{section})
5674 @cindex section alignment
5675 Return the alignment in bytes of the named @var{section}, if that section has
5676 been allocated.  If the section has not been allocated when this is
5677 evaluated, the linker will report an error. In the following example,
5678 the alignment of the @code{.output} section is stored as the first
5679 value in that section.
5680 @smallexample
5681 @group
5682 SECTIONS@{ @dots{}
5683   .output @{
5684     LONG (ALIGNOF (.output))
5685     @dots{}
5686     @}
5687 @dots{} @}
5688 @end group
5689 @end smallexample
5691 @item BLOCK(@var{exp})
5692 @kindex BLOCK(@var{exp})
5693 This is a synonym for @code{ALIGN}, for compatibility with older linker
5694 scripts.  It is most often seen when setting the address of an output
5695 section.
5697 @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
5698 @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
5699 This is equivalent to either
5700 @smallexample
5701 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1)))
5702 @end smallexample
5704 @smallexample
5705 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - @var{commonpagesize})))
5706 @end smallexample
5707 @noindent
5708 depending on whether the latter uses fewer @var{commonpagesize} sized pages
5709 for the data segment (area between the result of this expression and
5710 @code{DATA_SEGMENT_END}) than the former or not.
5711 If the latter form is used, it means @var{commonpagesize} bytes of runtime
5712 memory will be saved at the expense of up to @var{commonpagesize} wasted
5713 bytes in the on-disk file.
5715 This expression can only be used directly in @code{SECTIONS} commands, not in
5716 any output section descriptions and only once in the linker script.
5717 @var{commonpagesize} should be less or equal to @var{maxpagesize} and should
5718 be the system page size the object wants to be optimized for (while still
5719 working on system page sizes up to @var{maxpagesize}).
5721 @noindent
5722 Example:
5723 @smallexample
5724   . = DATA_SEGMENT_ALIGN(0x10000, 0x2000);
5725 @end smallexample
5727 @item DATA_SEGMENT_END(@var{exp})
5728 @kindex DATA_SEGMENT_END(@var{exp})
5729 This defines the end of data segment for @code{DATA_SEGMENT_ALIGN}
5730 evaluation purposes.
5732 @smallexample
5733   . = DATA_SEGMENT_END(.);
5734 @end smallexample
5736 @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
5737 @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
5738 This defines the end of the @code{PT_GNU_RELRO} segment when
5739 @samp{-z relro} option is used.  Second argument is returned.
5740 When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END}
5741 does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that
5742 @var{exp} + @var{offset} is aligned to the most commonly used page
5743 boundary for particular target.  If present in the linker script,
5744 it must always come in between @code{DATA_SEGMENT_ALIGN} and
5745 @code{DATA_SEGMENT_END}.
5747 @smallexample
5748   . = DATA_SEGMENT_RELRO_END(24, .);
5749 @end smallexample
5751 @item DEFINED(@var{symbol})
5752 @kindex DEFINED(@var{symbol})
5753 @cindex symbol defaults
5754 Return 1 if @var{symbol} is in the linker global symbol table and is
5755 defined before the statement using DEFINED in the script, otherwise
5756 return 0.  You can use this function to provide
5757 default values for symbols.  For example, the following script fragment
5758 shows how to set a global symbol @samp{begin} to the first location in
5759 the @samp{.text} section---but if a symbol called @samp{begin} already
5760 existed, its value is preserved:
5762 @smallexample
5763 @group
5764 SECTIONS @{ @dots{}
5765   .text : @{
5766     begin = DEFINED(begin) ? begin : . ;
5767     @dots{}
5768   @}
5769   @dots{}
5771 @end group
5772 @end smallexample
5774 @item LENGTH(@var{memory})
5775 @kindex LENGTH(@var{memory})
5776 Return the length of the memory region named @var{memory}.
5778 @item LOADADDR(@var{section})
5779 @kindex LOADADDR(@var{section})
5780 @cindex section load address in expression
5781 Return the absolute LMA of the named @var{section}.  (@pxref{Output
5782 Section LMA}).
5784 @kindex MAX
5785 @item MAX(@var{exp1}, @var{exp2})
5786 Returns the maximum of @var{exp1} and @var{exp2}.
5788 @kindex MIN
5789 @item MIN(@var{exp1}, @var{exp2})
5790 Returns the minimum of @var{exp1} and @var{exp2}.
5792 @item NEXT(@var{exp})
5793 @kindex NEXT(@var{exp})
5794 @cindex unallocated address, next
5795 Return the next unallocated address that is a multiple of @var{exp}.
5796 This function is closely related to @code{ALIGN(@var{exp})}; unless you
5797 use the @code{MEMORY} command to define discontinuous memory for the
5798 output file, the two functions are equivalent.
5800 @item ORIGIN(@var{memory})
5801 @kindex ORIGIN(@var{memory})
5802 Return the origin of the memory region named @var{memory}.
5804 @item SEGMENT_START(@var{segment}, @var{default})
5805 @kindex SEGMENT_START(@var{segment}, @var{default})
5806 Return the base address of the named @var{segment}.  If an explicit
5807 value has been given for this segment (with a command-line @samp{-T}
5808 option) that value will be returned; otherwise the value will be
5809 @var{default}.  At present, the @samp{-T} command-line option can only
5810 be used to set the base address for the ``text'', ``data'', and
5811 ``bss'' sections, but you can use @code{SEGMENT_START} with any segment
5812 name.
5814 @item SIZEOF(@var{section})
5815 @kindex SIZEOF(@var{section})
5816 @cindex section size
5817 Return the size in bytes of the named @var{section}, if that section has
5818 been allocated.  If the section has not been allocated when this is
5819 evaluated, the linker will report an error.  In the following example,
5820 @code{symbol_1} and @code{symbol_2} are assigned identical values:
5821 @smallexample
5822 @group
5823 SECTIONS@{ @dots{}
5824   .output @{
5825     .start = . ;
5826     @dots{}
5827     .end = . ;
5828     @}
5829   symbol_1 = .end - .start ;
5830   symbol_2 = SIZEOF(.output);
5831 @dots{} @}
5832 @end group
5833 @end smallexample
5835 @item SIZEOF_HEADERS
5836 @itemx sizeof_headers
5837 @kindex SIZEOF_HEADERS
5838 @cindex header size
5839 Return the size in bytes of the output file's headers.  This is
5840 information which appears at the start of the output file.  You can use
5841 this number when setting the start address of the first section, if you
5842 choose, to facilitate paging.
5844 @cindex not enough room for program headers
5845 @cindex program headers, not enough room
5846 When producing an ELF output file, if the linker script uses the
5847 @code{SIZEOF_HEADERS} builtin function, the linker must compute the
5848 number of program headers before it has determined all the section
5849 addresses and sizes.  If the linker later discovers that it needs
5850 additional program headers, it will report an error @samp{not enough
5851 room for program headers}.  To avoid this error, you must avoid using
5852 the @code{SIZEOF_HEADERS} function, or you must rework your linker
5853 script to avoid forcing the linker to use additional program headers, or
5854 you must define the program headers yourself using the @code{PHDRS}
5855 command (@pxref{PHDRS}).
5856 @end table
5858 @node Implicit Linker Scripts
5859 @section Implicit Linker Scripts
5860 @cindex implicit linker scripts
5861 If you specify a linker input file which the linker can not recognize as
5862 an object file or an archive file, it will try to read the file as a
5863 linker script.  If the file can not be parsed as a linker script, the
5864 linker will report an error.
5866 An implicit linker script will not replace the default linker script.
5868 Typically an implicit linker script would contain only symbol
5869 assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION}
5870 commands.
5872 Any input files read because of an implicit linker script will be read
5873 at the position in the command line where the implicit linker script was
5874 read.  This can affect archive searching.
5876 @ifset GENERIC
5877 @node Machine Dependent
5878 @chapter Machine Dependent Features
5880 @cindex machine dependencies
5881 @command{ld} has additional features on some platforms; the following
5882 sections describe them.  Machines where @command{ld} has no additional
5883 functionality are not listed.
5885 @menu
5886 @ifset H8300
5887 * H8/300::                      @command{ld} and the H8/300
5888 @end ifset
5889 @ifset I960
5890 * i960::                        @command{ld} and the Intel 960 family
5891 @end ifset
5892 @ifset ARM
5893 * ARM::                         @command{ld} and the ARM family
5894 @end ifset
5895 @ifset HPPA
5896 * HPPA ELF32::                  @command{ld} and HPPA 32-bit ELF
5897 @end ifset
5898 @ifset M68K
5899 * M68K::                        @command{ld} and the Motorola 68K family
5900 @end ifset
5901 @ifset MMIX
5902 * MMIX::                        @command{ld} and MMIX
5903 @end ifset
5904 @ifset MSP430
5905 * MSP430::                      @command{ld} and MSP430
5906 @end ifset
5907 @ifset M68HC11
5908 * M68HC11/68HC12::              @code{ld} and the Motorola 68HC11 and 68HC12 families
5909 @end ifset
5910 @ifset POWERPC
5911 * PowerPC ELF32::               @command{ld} and PowerPC 32-bit ELF Support
5912 @end ifset
5913 @ifset POWERPC64
5914 * PowerPC64 ELF64::             @command{ld} and PowerPC64 64-bit ELF Support
5915 @end ifset
5916 @ifset SPU
5917 * SPU ELF::                     @command{ld} and SPU ELF Support
5918 @end ifset
5919 @ifset TICOFF
5920 * TI COFF::                     @command{ld} and TI COFF
5921 @end ifset
5922 @ifset WIN32
5923 * WIN32::                       @command{ld} and WIN32 (cygwin/mingw)
5924 @end ifset
5925 @ifset XTENSA
5926 * Xtensa::                      @command{ld} and Xtensa Processors
5927 @end ifset
5928 @end menu
5929 @end ifset
5931 @ifset H8300
5932 @ifclear GENERIC
5933 @raisesections
5934 @end ifclear
5936 @node H8/300
5937 @section @command{ld} and the H8/300
5939 @cindex H8/300 support
5940 For the H8/300, @command{ld} can perform these global optimizations when
5941 you specify the @samp{--relax} command-line option.
5943 @table @emph
5944 @cindex relaxing on H8/300
5945 @item relaxing address modes
5946 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
5947 targets are within eight bits, and turns them into eight-bit
5948 program-counter relative @code{bsr} and @code{bra} instructions,
5949 respectively.
5951 @cindex synthesizing on H8/300
5952 @item synthesizing instructions
5953 @c FIXME: specifically mov.b, or any mov instructions really?
5954 @command{ld} finds all @code{mov.b} instructions which use the
5955 sixteen-bit absolute address form, but refer to the top
5956 page of memory, and changes them to use the eight-bit address form.
5957 (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into
5958 @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the
5959 top page of memory).
5961 @item bit manipulation instructions
5962 @command{ld} finds all bit manipulation instructions like @code{band, bclr,
5963 biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor}
5964 which use 32 bit and 16 bit absolute address form, but refer to the top
5965 page of memory, and changes them to use the 8 bit address form.
5966 (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into
5967 @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in
5968 the top page of memory).
5970 @item system control instructions
5971 @command{ld} finds all @code{ldc.w, stc.w} instructions which use the
5972 32 bit absolute address form, but refer to the top page of memory, and
5973 changes them to use 16 bit address form.
5974 (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into
5975 @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in
5976 the top page of memory).
5977 @end table
5979 @ifclear GENERIC
5980 @lowersections
5981 @end ifclear
5982 @end ifset
5984 @ifclear GENERIC
5985 @ifset Renesas
5986 @c This stuff is pointless to say unless you're especially concerned
5987 @c with Renesas chips; don't enable it for generic case, please.
5988 @node Renesas
5989 @chapter @command{ld} and Other Renesas Chips
5991 @command{ld} also supports the Renesas (formerly Hitachi) H8/300H,
5992 H8/500, and SH chips.  No special features, commands, or command-line
5993 options are required for these chips.
5994 @end ifset
5995 @end ifclear
5997 @ifset I960
5998 @ifclear GENERIC
5999 @raisesections
6000 @end ifclear
6002 @node i960
6003 @section @command{ld} and the Intel 960 Family
6005 @cindex i960 support
6007 You can use the @samp{-A@var{architecture}} command line option to
6008 specify one of the two-letter names identifying members of the 960
6009 family; the option specifies the desired output target, and warns of any
6010 incompatible instructions in the input files.  It also modifies the
6011 linker's search strategy for archive libraries, to support the use of
6012 libraries specific to each particular architecture, by including in the
6013 search loop names suffixed with the string identifying the architecture.
6015 For example, if your @command{ld} command line included @w{@samp{-ACA}} as
6016 well as @w{@samp{-ltry}}, the linker would look (in its built-in search
6017 paths, and in any paths you specify with @samp{-L}) for a library with
6018 the names
6020 @smallexample
6021 @group
6023 libtry.a
6024 tryca
6025 libtryca.a
6026 @end group
6027 @end smallexample
6029 @noindent
6030 The first two possibilities would be considered in any event; the last
6031 two are due to the use of @w{@samp{-ACA}}.
6033 You can meaningfully use @samp{-A} more than once on a command line, since
6034 the 960 architecture family allows combination of target architectures; each
6035 use will add another pair of name variants to search for when @w{@samp{-l}}
6036 specifies a library.
6038 @cindex @option{--relax} on i960
6039 @cindex relaxing on i960
6040 @command{ld} supports the @samp{--relax} option for the i960 family.  If
6041 you specify @samp{--relax}, @command{ld} finds all @code{balx} and
6042 @code{calx} instructions whose targets are within 24 bits, and turns
6043 them into 24-bit program-counter relative @code{bal} and @code{cal}
6044 instructions, respectively.  @command{ld} also turns @code{cal}
6045 instructions into @code{bal} instructions when it determines that the
6046 target subroutine is a leaf routine (that is, the target subroutine does
6047 not itself call any subroutines).
6049 @cindex Cortex-A8 erratum workaround
6050 @kindex --fix-cortex-a8
6051 @kindex --no-fix-cortex-a8
6052 The @samp{--fix-cortex-a8} switch enables a link-time workaround for an erratum in certain Cortex-A8 processors.  The workaround is enabled by default if you are targeting the ARM v7-A architecture profile.  It can be enabled otherwise by specifying @samp{--fix-cortex-a8}, or disabled unconditionally by specifying @samp{--no-fix-cortex-a8}.
6054 The erratum only affects Thumb-2 code.  Please contact ARM for further details.
6056 @kindex --merge-exidx-entries
6057 @kindex --no-merge-exidx-entries
6058 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo.
6060 @ifclear GENERIC
6061 @lowersections
6062 @end ifclear
6063 @end ifset
6065 @ifset ARM
6066 @ifclear GENERIC
6067 @raisesections
6068 @end ifclear
6070 @ifset M68HC11
6071 @ifclear GENERIC
6072 @raisesections
6073 @end ifclear
6075 @node M68HC11/68HC12
6076 @section @command{ld} and the Motorola 68HC11 and 68HC12 families
6078 @cindex M68HC11 and 68HC12 support
6080 @subsection Linker Relaxation
6082 For the Motorola 68HC11, @command{ld} can perform these global
6083 optimizations when you specify the @samp{--relax} command-line option.
6085 @table @emph
6086 @cindex relaxing on M68HC11
6087 @item relaxing address modes
6088 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6089 targets are within eight bits, and turns them into eight-bit
6090 program-counter relative @code{bsr} and @code{bra} instructions,
6091 respectively.
6093 @command{ld} also looks at all 16-bit extended addressing modes and
6094 transforms them in a direct addressing mode when the address is in
6095 page 0 (between 0 and 0x0ff).
6097 @item relaxing gcc instruction group
6098 When @command{gcc} is called with @option{-mrelax}, it can emit group
6099 of instructions that the linker can optimize to use a 68HC11 direct
6100 addressing mode. These instructions consists of @code{bclr} or
6101 @code{bset} instructions.
6103 @end table
6105 @subsection Trampoline Generation
6107 @cindex trampoline generation on M68HC11
6108 @cindex trampoline generation on M68HC12
6109 For 68HC11 and 68HC12, @command{ld} can generate trampoline code to
6110 call a far function using a normal @code{jsr} instruction. The linker
6111 will also change the relocation to some far function to use the
6112 trampoline address instead of the function address. This is typically the
6113 case when a pointer to a function is taken. The pointer will in fact
6114 point to the function trampoline.
6116 @ifclear GENERIC
6117 @lowersections
6118 @end ifclear
6119 @end ifset
6121 @node ARM
6122 @section @command{ld} and the ARM family
6124 @cindex ARM interworking support
6125 @kindex --support-old-code
6126 For the ARM, @command{ld} will generate code stubs to allow functions calls
6127 between ARM and Thumb code.  These stubs only work with code that has
6128 been compiled and assembled with the @samp{-mthumb-interwork} command
6129 line option.  If it is necessary to link with old ARM object files or
6130 libraries, which have not been compiled with the -mthumb-interwork
6131 option then the @samp{--support-old-code} command line switch should be
6132 given to the linker.  This will make it generate larger stub functions
6133 which will work with non-interworking aware ARM code.  Note, however,
6134 the linker does not support generating stubs for function calls to
6135 non-interworking aware Thumb code.
6137 @cindex thumb entry point
6138 @cindex entry point, thumb
6139 @kindex --thumb-entry=@var{entry}
6140 The @samp{--thumb-entry} switch is a duplicate of the generic
6141 @samp{--entry} switch, in that it sets the program's starting address.
6142 But it also sets the bottom bit of the address, so that it can be
6143 branched to using a BX instruction, and the program will start
6144 executing in Thumb mode straight away.
6146 @cindex PE import table prefixing
6147 @kindex --use-nul-prefixed-import-tables
6148 The @samp{--use-nul-prefixed-import-tables} switch is specifying, that
6149 the import tables idata4 and idata5 have to be generated with a zero
6150 elememt prefix for import libraries. This is the old style to generate
6151 import tables. By default this option is turned off.
6153 @cindex BE8
6154 @kindex --be8
6155 The @samp{--be8} switch instructs @command{ld} to generate BE8 format
6156 executables.  This option is only valid when linking big-endian objects.
6157 The resulting image will contain big-endian data and little-endian code.
6159 @cindex TARGET1
6160 @kindex --target1-rel
6161 @kindex --target1-abs
6162 The @samp{R_ARM_TARGET1} relocation is typically used for entries in the
6163 @samp{.init_array} section.  It is interpreted as either @samp{R_ARM_REL32}
6164 or @samp{R_ARM_ABS32}, depending on the target.  The @samp{--target1-rel}
6165 and @samp{--target1-abs} switches override the default.
6167 @cindex TARGET2
6168 @kindex --target2=@var{type}
6169 The @samp{--target2=type} switch overrides the default definition of the
6170 @samp{R_ARM_TARGET2} relocation.  Valid values for @samp{type}, their
6171 meanings, and target defaults are as follows:
6172 @table @samp
6173 @item rel
6174 @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi)
6175 @item abs
6176 @samp{R_ARM_ABS32} (arm*-*-symbianelf)
6177 @item got-rel
6178 @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd)
6179 @end table
6181 @cindex FIX_V4BX
6182 @kindex --fix-v4bx
6183 The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF
6184 specification) enables objects compiled for the ARMv4 architecture to be
6185 interworking-safe when linked with other objects compiled for ARMv4t, but
6186 also allows pure ARMv4 binaries to be built from the same ARMv4 objects.
6188 In the latter case, the switch @option{--fix-v4bx} must be passed to the
6189 linker, which causes v4t @code{BX rM} instructions to be rewritten as
6190 @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction.
6192 In the former case, the switch should not be used, and @samp{R_ARM_V4BX}
6193 relocations are ignored.
6195 @cindex FIX_V4BX_INTERWORKING
6196 @kindex --fix-v4bx-interworking
6197 Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX}
6198 relocations with a branch to the following veneer:
6200 @smallexample
6201 TST rM, #1
6202 MOVEQ PC, rM
6203 BX Rn
6204 @end smallexample
6206 This allows generation of libraries/applications that work on ARMv4 cores
6207 and are still interworking safe.  Note that the above veneer clobbers the
6208 condition flags, so may cause incorrect progrm behavior in rare cases.
6210 @cindex USE_BLX
6211 @kindex --use-blx
6212 The @samp{--use-blx} switch enables the linker to use ARM/Thumb
6213 BLX instructions (available on ARMv5t and above) in various
6214 situations. Currently it is used to perform calls via the PLT from Thumb
6215 code using BLX rather than using BX and a mode-switching stub before
6216 each PLT entry. This should lead to such calls executing slightly faster.
6218 This option is enabled implicitly for SymbianOS, so there is no need to
6219 specify it if you are using that target.
6221 @cindex VFP11_DENORM_FIX
6222 @kindex --vfp11-denorm-fix
6223 The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a
6224 bug in certain VFP11 coprocessor hardware, which sometimes allows
6225 instructions with denorm operands (which must be handled by support code)
6226 to have those operands overwritten by subsequent instructions before
6227 the support code can read the intended values.
6229 The bug may be avoided in scalar mode if you allow at least one
6230 intervening instruction between a VFP11 instruction which uses a register
6231 and another instruction which writes to the same register, or at least two
6232 intervening instructions if vector mode is in use. The bug only affects
6233 full-compliance floating-point mode: you do not need this workaround if
6234 you are using "runfast" mode. Please contact ARM for further details.
6236 If you know you are using buggy VFP11 hardware, you can
6237 enable this workaround by specifying the linker option
6238 @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar
6239 mode only, or @samp{--vfp-denorm-fix=vector} if you are using
6240 vector mode (the latter also works for scalar code). The default is
6241 @samp{--vfp-denorm-fix=none}.
6243 If the workaround is enabled, instructions are scanned for
6244 potentially-troublesome sequences, and a veneer is created for each
6245 such sequence which may trigger the erratum. The veneer consists of the
6246 first instruction of the sequence and a branch back to the subsequent
6247 instruction. The original instruction is then replaced with a branch to
6248 the veneer. The extra cycles required to call and return from the veneer
6249 are sufficient to avoid the erratum in both the scalar and vector cases.
6251 @cindex NO_ENUM_SIZE_WARNING
6252 @kindex --no-enum-size-warning
6253 The @option{--no-enum-size-warning} switch prevents the linker from
6254 warning when linking object files that specify incompatible EABI
6255 enumeration size attributes.  For example, with this switch enabled,
6256 linking of an object file using 32-bit enumeration values with another
6257 using enumeration values fitted into the smallest possible space will
6258 not be diagnosed.
6260 @cindex NO_WCHAR_SIZE_WARNING
6261 @kindex --no-wchar-size-warning
6262 The @option{--no-wchar-size-warning} switch prevents the linker from
6263 warning when linking object files that specify incompatible EABI
6264 @code{wchar_t} size attributes.  For example, with this switch enabled,
6265 linking of an object file using 32-bit @code{wchar_t} values with another
6266 using 16-bit @code{wchar_t} values will not be diagnosed.
6268 @cindex PIC_VENEER
6269 @kindex --pic-veneer
6270 The @samp{--pic-veneer} switch makes the linker use PIC sequences for
6271 ARM/Thumb interworking veneers, even if the rest of the binary
6272 is not PIC.  This avoids problems on uClinux targets where
6273 @samp{--emit-relocs} is used to generate relocatable binaries.
6275 @cindex STUB_GROUP_SIZE
6276 @kindex --stub-group-size=@var{N}
6277 The linker will automatically generate and insert small sequences of
6278 code into a linked ARM ELF executable whenever an attempt is made to
6279 perform a function call to a symbol that is too far away.  The
6280 placement of these sequences of instructions - called stubs - is
6281 controlled by the command line option @option{--stub-group-size=N}.
6282 The placement is important because a poor choice can create a need for
6283 duplicate stubs, increasing the code sizw.  The linker will try to
6284 group stubs together in order to reduce interruptions to the flow of
6285 code, but it needs guidance as to how big these groups should be and
6286 where they should be placed.
6288 The value of @samp{N}, the parameter to the
6289 @option{--stub-group-size=} option controls where the stub groups are
6290 placed.  If it is negative then all stubs are placed after the first
6291 branch that needs them.  If it is positive then the stubs can be
6292 placed either before or after the branches that need them.  If the
6293 value of @samp{N} is 1 (either +1 or -1) then the linker will choose
6294 exactly where to place groups of stubs, using its built in heuristics.
6295 A value of @samp{N} greater than 1 (or smaller than -1) tells the
6296 linker that a single group of stubs can service at most @samp{N} bytes
6297 from the input sections.
6299 The default, if @option{--stub-group-size=} is not specified, is
6300 @samp{N = +1}.
6302 Farcalls stubs insertion is fully supported for the ARM-EABI target
6303 only, because it relies on object files properties not present
6304 otherwise.
6306 @ifclear GENERIC
6307 @lowersections
6308 @end ifclear
6309 @end ifset
6311 @ifset HPPA
6312 @ifclear GENERIC
6313 @raisesections
6314 @end ifclear
6316 @node HPPA ELF32
6317 @section @command{ld} and HPPA 32-bit ELF Support
6318 @cindex HPPA multiple sub-space stubs
6319 @kindex --multi-subspace
6320 When generating a shared library, @command{ld} will by default generate
6321 import stubs suitable for use with a single sub-space application.
6322 The @samp{--multi-subspace} switch causes @command{ld} to generate export
6323 stubs, and different (larger) import stubs suitable for use with
6324 multiple sub-spaces.
6326 @cindex HPPA stub grouping
6327 @kindex --stub-group-size=@var{N}
6328 Long branch stubs and import/export stubs are placed by @command{ld} in
6329 stub sections located between groups of input sections.
6330 @samp{--stub-group-size} specifies the maximum size of a group of input
6331 sections handled by one stub section.  Since branch offsets are signed,
6332 a stub section may serve two groups of input sections, one group before
6333 the stub section, and one group after it.  However, when using
6334 conditional branches that require stubs, it may be better (for branch
6335 prediction) that stub sections only serve one group of input sections.
6336 A negative value for @samp{N} chooses this scheme, ensuring that
6337 branches to stubs always use a negative offset.  Two special values of
6338 @samp{N} are recognized, @samp{1} and @samp{-1}.  These both instruct
6339 @command{ld} to automatically size input section groups for the branch types
6340 detected, with the same behaviour regarding stub placement as other
6341 positive or negative values of @samp{N} respectively.
6343 Note that @samp{--stub-group-size} does not split input sections.  A
6344 single input section larger than the group size specified will of course
6345 create a larger group (of one section).  If input sections are too
6346 large, it may not be possible for a branch to reach its stub.
6348 @ifclear GENERIC
6349 @lowersections
6350 @end ifclear
6351 @end ifset
6353 @ifset M68K
6354 @ifclear GENERIC
6355 @raisesections
6356 @end ifclear
6358 @node M68K
6359 @section @command{ld} and the Motorola 68K family
6361 @cindex Motorola 68K GOT generation
6362 @kindex --got=@var{type}
6363 The @samp{--got=@var{type}} option lets you choose the GOT generation scheme.
6364 The choices are @samp{single}, @samp{negative}, @samp{multigot} and
6365 @samp{target}.  When @samp{target} is selected the linker chooses
6366 the default GOT generation scheme for the current target.
6367 @samp{single} tells the linker to generate a single GOT with
6368 entries only at non-negative offsets.
6369 @samp{negative} instructs the linker to generate a single GOT with
6370 entries at both negative and positive offsets.  Not all environments
6371 support such GOTs.
6372 @samp{multigot} allows the linker to generate several GOTs in the
6373 output file.  All GOT references from a single input object
6374 file access the same GOT, but references from different input object
6375 files might access different GOTs.  Not all environments support such GOTs.
6377 @ifclear GENERIC
6378 @lowersections
6379 @end ifclear
6380 @end ifset
6382 @ifset MMIX
6383 @ifclear GENERIC
6384 @raisesections
6385 @end ifclear
6387 @node MMIX
6388 @section @code{ld} and MMIX
6389 For MMIX, there is a choice of generating @code{ELF} object files or
6390 @code{mmo} object files when linking.  The simulator @code{mmix}
6391 understands the @code{mmo} format.  The binutils @code{objcopy} utility
6392 can translate between the two formats.
6394 There is one special section, the @samp{.MMIX.reg_contents} section.
6395 Contents in this section is assumed to correspond to that of global
6396 registers, and symbols referring to it are translated to special symbols,
6397 equal to registers.  In a final link, the start address of the
6398 @samp{.MMIX.reg_contents} section corresponds to the first allocated
6399 global register multiplied by 8.  Register @code{$255} is not included in
6400 this section; it is always set to the program entry, which is at the
6401 symbol @code{Main} for @code{mmo} files.
6403 Global symbols with the prefix @code{__.MMIX.start.}, for example
6404 @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special.
6405 The default linker script uses these to set the default start address
6406 of a section.
6408 Initial and trailing multiples of zero-valued 32-bit words in a section,
6409 are left out from an mmo file.
6411 @ifclear GENERIC
6412 @lowersections
6413 @end ifclear
6414 @end ifset
6416 @ifset MSP430
6417 @ifclear GENERIC
6418 @raisesections
6419 @end ifclear
6421 @node  MSP430
6422 @section @code{ld} and MSP430
6423 For the MSP430 it is possible to select the MPU architecture.  The flag @samp{-m [mpu type]}
6424 will select an appropriate linker script for selected MPU type.  (To get a list of known MPUs
6425 just pass @samp{-m help} option to the linker).
6427 @cindex MSP430 extra sections
6428 The linker will recognize some extra sections which are MSP430 specific:
6430 @table @code
6431 @item @samp{.vectors}
6432 Defines a portion of ROM where interrupt vectors located.
6434 @item @samp{.bootloader}
6435 Defines the bootloader portion of the ROM (if applicable).  Any code
6436 in this section will be uploaded to the MPU.
6438 @item @samp{.infomem}
6439 Defines an information memory section (if applicable).  Any code in
6440 this section will be uploaded to the MPU.
6442 @item @samp{.infomemnobits}
6443 This is the same as the @samp{.infomem} section except that any code
6444 in this section will not be uploaded to the MPU.
6446 @item @samp{.noinit}
6447 Denotes a portion of RAM located above @samp{.bss} section.
6449 The last two sections are used by gcc.
6450 @end table
6452 @ifclear GENERIC
6453 @lowersections
6454 @end ifclear
6455 @end ifset
6457 @ifset POWERPC
6458 @ifclear GENERIC
6459 @raisesections
6460 @end ifclear
6462 @node PowerPC ELF32
6463 @section @command{ld} and PowerPC 32-bit ELF Support
6464 @cindex PowerPC long branches
6465 @kindex --relax on PowerPC
6466 Branches on PowerPC processors are limited to a signed 26-bit
6467 displacement, which may result in @command{ld} giving
6468 @samp{relocation truncated to fit} errors with very large programs.
6469 @samp{--relax} enables the generation of trampolines that can access
6470 the entire 32-bit address space.  These trampolines are inserted at
6471 section boundaries, so may not themselves be reachable if an input
6472 section exceeds 33M in size.  You may combine @samp{-r} and
6473 @samp{--relax} to add trampolines in a partial link.  In that case
6474 both branches to undefined symbols and inter-section branches are also
6475 considered potentially out of range, and trampolines inserted.
6477 @cindex PowerPC ELF32 options
6478 @table @option
6479 @cindex PowerPC PLT
6480 @kindex --bss-plt
6481 @item --bss-plt
6482 Current PowerPC GCC accepts a @samp{-msecure-plt} option that
6483 generates code capable of using a newer PLT and GOT layout that has
6484 the security advantage of no executable section ever needing to be
6485 writable and no writable section ever being executable.  PowerPC
6486 @command{ld} will generate this layout, including stubs to access the
6487 PLT, if all input files (including startup and static libraries) were
6488 compiled with @samp{-msecure-plt}.  @samp{--bss-plt} forces the old
6489 BSS PLT (and GOT layout) which can give slightly better performance.
6491 @kindex --secure-plt
6492 @item --secure-plt
6493 @command{ld} will use the new PLT and GOT layout if it is linking new
6494 @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically
6495 when linking non-PIC code.  This option requests the new PLT and GOT
6496 layout.  A warning will be given if some object file requires the old
6497 style BSS PLT.
6499 @cindex PowerPC GOT
6500 @kindex --sdata-got
6501 @item --sdata-got
6502 The new secure PLT and GOT are placed differently relative to other
6503 sections compared to older BSS PLT and GOT placement.  The location of
6504 @code{.plt} must change because the new secure PLT is an initialized
6505 section while the old PLT is uninitialized.  The reason for the
6506 @code{.got} change is more subtle:  The new placement allows
6507 @code{.got} to be read-only in applications linked with
6508 @samp{-z relro -z now}.  However, this placement means that
6509 @code{.sdata} cannot always be used in shared libraries, because the
6510 PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT
6511 pointer.  @samp{--sdata-got} forces the old GOT placement.  PowerPC
6512 GCC doesn't use @code{.sdata} in shared libraries, so this option is
6513 really only useful for other compilers that may do so.
6515 @cindex PowerPC stub symbols
6516 @kindex --emit-stub-syms
6517 @item --emit-stub-syms
6518 This option causes @command{ld} to label linker stubs with a local
6519 symbol that encodes the stub type and destination.
6521 @cindex PowerPC TLS optimization
6522 @kindex --no-tls-optimize
6523 @item --no-tls-optimize
6524 PowerPC @command{ld} normally performs some optimization of code
6525 sequences used to access Thread-Local Storage.  Use this option to
6526 disable the optimization.
6527 @end table
6529 @ifclear GENERIC
6530 @lowersections
6531 @end ifclear
6532 @end ifset
6534 @ifset POWERPC64
6535 @ifclear GENERIC
6536 @raisesections
6537 @end ifclear
6539 @node PowerPC64 ELF64
6540 @section @command{ld} and PowerPC64 64-bit ELF Support
6542 @cindex PowerPC64 ELF64 options
6543 @table @option
6544 @cindex PowerPC64 stub grouping
6545 @kindex --stub-group-size
6546 @item --stub-group-size
6547 Long branch stubs, PLT call stubs  and TOC adjusting stubs are placed
6548 by @command{ld} in stub sections located between groups of input sections.
6549 @samp{--stub-group-size} specifies the maximum size of a group of input
6550 sections handled by one stub section.  Since branch offsets are signed,
6551 a stub section may serve two groups of input sections, one group before
6552 the stub section, and one group after it.  However, when using
6553 conditional branches that require stubs, it may be better (for branch
6554 prediction) that stub sections only serve one group of input sections.
6555 A negative value for @samp{N} chooses this scheme, ensuring that
6556 branches to stubs always use a negative offset.  Two special values of
6557 @samp{N} are recognized, @samp{1} and @samp{-1}.  These both instruct
6558 @command{ld} to automatically size input section groups for the branch types
6559 detected, with the same behaviour regarding stub placement as other
6560 positive or negative values of @samp{N} respectively.
6562 Note that @samp{--stub-group-size} does not split input sections.  A
6563 single input section larger than the group size specified will of course
6564 create a larger group (of one section).  If input sections are too
6565 large, it may not be possible for a branch to reach its stub.
6567 @cindex PowerPC64 stub symbols
6568 @kindex --emit-stub-syms
6569 @item --emit-stub-syms
6570 This option causes @command{ld} to label linker stubs with a local
6571 symbol that encodes the stub type and destination.
6573 @cindex PowerPC64 dot symbols
6574 @kindex --dotsyms
6575 @kindex --no-dotsyms
6576 @item --dotsyms, --no-dotsyms
6577 These two options control how @command{ld} interprets version patterns
6578 in a version script.  Older PowerPC64 compilers emitted both a
6579 function descriptor symbol with the same name as the function, and a
6580 code entry symbol with the name prefixed by a dot (@samp{.}).  To
6581 properly version a function @samp{foo}, the version script thus needs
6582 to control both @samp{foo} and @samp{.foo}.  The option
6583 @samp{--dotsyms}, on by default, automatically adds the required
6584 dot-prefixed patterns.  Use @samp{--no-dotsyms} to disable this
6585 feature.
6587 @cindex PowerPC64 TLS optimization
6588 @kindex --no-tls-optimize
6589 @item --no-tls-optimize
6590 PowerPC64 @command{ld} normally performs some optimization of code
6591 sequences used to access Thread-Local Storage.  Use this option to
6592 disable the optimization.
6594 @cindex PowerPC64 OPD optimization
6595 @kindex --no-opd-optimize
6596 @item --no-opd-optimize
6597 PowerPC64 @command{ld} normally removes @code{.opd} section entries
6598 corresponding to deleted link-once functions, or functions removed by
6599 the action of @samp{--gc-sections} or linker script @code{/DISCARD/}.
6600 Use this option to disable @code{.opd} optimization.
6602 @cindex PowerPC64 OPD spacing
6603 @kindex --non-overlapping-opd
6604 @item --non-overlapping-opd
6605 Some PowerPC64 compilers have an option to generate compressed
6606 @code{.opd} entries spaced 16 bytes apart, overlapping the third word,
6607 the static chain pointer (unused in C) with the first word of the next
6608 entry.  This option expands such entries to the full 24 bytes.
6610 @cindex PowerPC64 TOC optimization
6611 @kindex --no-toc-optimize
6612 @item --no-toc-optimize
6613 PowerPC64 @command{ld} normally removes unused @code{.toc} section
6614 entries.  Such entries are detected by examining relocations that
6615 reference the TOC in code sections.  A reloc in a deleted code section
6616 marks a TOC word as unneeded, while a reloc in a kept code section
6617 marks a TOC word as needed.  Since the TOC may reference itself, TOC
6618 relocs are also examined.  TOC words marked as both needed and
6619 unneeded will of course be kept.  TOC words without any referencing
6620 reloc are assumed to be part of a multi-word entry, and are kept or
6621 discarded as per the nearest marked preceding word.  This works
6622 reliably for compiler generated code, but may be incorrect if assembly
6623 code is used to insert TOC entries.  Use this option to disable the
6624 optimization.
6626 @cindex PowerPC64 multi-TOC
6627 @kindex --no-multi-toc
6628 @item --no-multi-toc
6629 By default, PowerPC64 GCC generates code for a TOC model where TOC
6630 entries are accessed with a 16-bit offset from r2.  This limits the
6631 total TOC size to 64K.  PowerPC64 @command{ld} extends this limit by
6632 grouping code sections such that each group uses less than 64K for its
6633 TOC entries, then inserts r2 adjusting stubs between inter-group
6634 calls.  @command{ld} does not split apart input sections, so cannot
6635 help if a single input file has a @code{.toc} section that exceeds
6636 64K, most likely from linking multiple files with @command{ld -r}.
6637 Use this option to turn off this feature.
6638 @end table
6640 @ifclear GENERIC
6641 @lowersections
6642 @end ifclear
6643 @end ifset
6645 @ifset SPU
6646 @ifclear GENERIC
6647 @raisesections
6648 @end ifclear
6650 @node SPU ELF
6651 @section @command{ld} and SPU ELF Support
6653 @cindex SPU ELF options
6654 @table @option
6656 @cindex SPU plugins
6657 @kindex --plugin
6658 @item --plugin
6659 This option marks an executable as a PIC plugin module.
6661 @cindex SPU overlays
6662 @kindex --no-overlays
6663 @item --no-overlays
6664 Normally, @command{ld} recognizes calls to functions within overlay
6665 regions, and redirects such calls to an overlay manager via a stub.
6666 @command{ld} also provides a built-in overlay manager.  This option
6667 turns off all this special overlay handling.
6669 @cindex SPU overlay stub symbols
6670 @kindex --emit-stub-syms
6671 @item --emit-stub-syms
6672 This option causes @command{ld} to label overlay stubs with a local
6673 symbol that encodes the stub type and destination.
6675 @cindex SPU extra overlay stubs
6676 @kindex --extra-overlay-stubs
6677 @item --extra-overlay-stubs
6678 This option causes @command{ld} to add overlay call stubs on all
6679 function calls out of overlay regions.  Normally stubs are not added
6680 on calls to non-overlay regions.
6682 @cindex SPU local store size
6683 @kindex --local-store=lo:hi
6684 @item --local-store=lo:hi
6685 @command{ld} usually checks that a final executable for SPU fits in
6686 the address range 0 to 256k.  This option may be used to change the
6687 range.  Disable the check entirely with @option{--local-store=0:0}.
6689 @cindex SPU
6690 @kindex --stack-analysis
6691 @item --stack-analysis
6692 SPU local store space is limited.  Over-allocation of stack space
6693 unnecessarily limits space available for code and data, while
6694 under-allocation results in runtime failures.  If given this option,
6695 @command{ld} will provide an estimate of maximum stack usage.
6696 @command{ld} does this by examining symbols in code sections to
6697 determine the extents of functions, and looking at function prologues
6698 for stack adjusting instructions.  A call-graph is created by looking
6699 for relocations on branch instructions.  The graph is then searched
6700 for the maximum stack usage path.  Note that this analysis does not
6701 find calls made via function pointers, and does not handle recursion
6702 and other cycles in the call graph.  Stack usage may be
6703 under-estimated if your code makes such calls.  Also, stack usage for
6704 dynamic allocation, e.g. alloca, will not be detected.  If a link map
6705 is requested, detailed information about each function's stack usage
6706 and calls will be given.
6708 @cindex SPU
6709 @kindex --emit-stack-syms
6710 @item --emit-stack-syms
6711 This option, if given along with @option{--stack-analysis} will result
6712 in @command{ld} emitting stack sizing symbols for each function.
6713 These take the form @code{__stack_<function_name>} for global
6714 functions, and @code{__stack_<number>_<function_name>} for static
6715 functions.  @code{<number>} is the section id in hex.  The value of
6716 such symbols is the stack requirement for the corresponding function.
6717 The symbol size will be zero, type @code{STT_NOTYPE}, binding
6718 @code{STB_LOCAL}, and section @code{SHN_ABS}.
6719 @end table
6721 @ifclear GENERIC
6722 @lowersections
6723 @end ifclear
6724 @end ifset
6726 @ifset TICOFF
6727 @ifclear GENERIC
6728 @raisesections
6729 @end ifclear
6731 @node TI COFF
6732 @section @command{ld}'s Support for Various TI COFF Versions
6733 @cindex TI COFF versions
6734 @kindex --format=@var{version}
6735 The @samp{--format} switch allows selection of one of the various
6736 TI COFF versions.  The latest of this writing is 2; versions 0 and 1 are
6737 also supported.  The TI COFF versions also vary in header byte-order
6738 format; @command{ld} will read any version or byte order, but the output
6739 header format depends on the default specified by the specific target.
6741 @ifclear GENERIC
6742 @lowersections
6743 @end ifclear
6744 @end ifset
6746 @ifset WIN32
6747 @ifclear GENERIC
6748 @raisesections
6749 @end ifclear
6751 @node WIN32
6752 @section @command{ld} and WIN32 (cygwin/mingw)
6754 This section describes some of the win32 specific @command{ld} issues.
6755 See @ref{Options,,Command Line Options} for detailed description of the
6756 command line options mentioned here.
6758 @table @emph
6759 @cindex import libraries
6760 @item import libraries
6761 The standard Windows linker creates and uses so-called import
6762 libraries, which contains information for linking to dll's.  They are
6763 regular static archives and are handled as any other static
6764 archive.  The cygwin and mingw ports of @command{ld} have specific
6765 support for creating such libraries provided with the
6766 @samp{--out-implib} command line option.
6768 @item   exporting DLL symbols
6769 @cindex exporting DLL symbols
6770 The cygwin/mingw @command{ld} has several ways to export symbols for dll's.
6772 @table @emph
6773 @item   using auto-export functionality
6774 @cindex using auto-export functionality
6775 By default @command{ld} exports symbols with the auto-export functionality,
6776 which is controlled by the following command line options:
6778 @itemize
6779 @item --export-all-symbols   [This is the default]
6780 @item --exclude-symbols
6781 @item --exclude-libs
6782 @item --exclude-modules-for-implib
6783 @item --version-script
6784 @end itemize
6786 When auto-export is in operation, @command{ld} will export all the non-local
6787 (global and common) symbols it finds in a DLL, with the exception of a few
6788 symbols known to belong to the system's runtime and libraries.  As it will
6789 often not be desirable to export all of a DLL's symbols, which may include
6790 private functions that are not part of any public interface, the command-line
6791 options listed above may be used to filter symbols out from the list for 
6792 exporting.  The @samp{--output-def} option can be used in order to see the
6793 final list of exported symbols with all exclusions taken into effect.
6795 If @samp{--export-all-symbols} is not given explicitly on the
6796 command line, then the default auto-export behavior will be @emph{disabled}
6797 if either of the following are true:
6799 @itemize
6800 @item A DEF file is used.
6801 @item Any symbol in any object file was marked with the __declspec(dllexport) attribute.
6802 @end itemize
6804 @item   using a DEF file
6805 @cindex using a DEF file
6806 Another way of exporting symbols is using a DEF file.  A DEF file is
6807 an ASCII file containing definitions of symbols which should be
6808 exported when a dll is created.  Usually it is named @samp{<dll
6809 name>.def} and is added as any other object file to the linker's
6810 command line.  The file's name must end in @samp{.def} or @samp{.DEF}.
6812 @example
6813 gcc -o <output> <objectfiles> <dll name>.def
6814 @end example
6816 Using a DEF file turns off the normal auto-export behavior, unless the
6817 @samp{--export-all-symbols} option is also used.
6819 Here is an example of a DEF file for a shared library called @samp{xyz.dll}:
6821 @example
6822 LIBRARY "xyz.dll" BASE=0x20000000
6824 EXPORTS
6827 _bar = bar
6828 another_foo = abc.dll.afoo
6829 var1 DATA
6830 doo = foo == foo2
6831 eoo DATA == var1
6832 @end example
6834 This example defines a DLL with a non-default base address and seven
6835 symbols in the export table. The third exported symbol @code{_bar} is an
6836 alias for the second. The fourth symbol, @code{another_foo} is resolved
6837 by "forwarding" to another module and treating it as an alias for
6838 @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol
6839 @code{var1} is declared to be a data object. The @samp{doo} symbol in
6840 export library is an alias of @samp{foo}, which gets the string name
6841 in export table @samp{foo2}. The @samp{eoo} symbol is an data export
6842 symbol, which gets in export table the name @samp{var1}.
6844 The optional @code{LIBRARY <name>} command indicates the @emph{internal}
6845 name of the output DLL. If @samp{<name>} does not include a suffix,
6846 the default library suffix, @samp{.DLL} is appended.
6848 When the .DEF file is used to build an application, rather than a
6849 library, the @code{NAME <name>} command should be used instead of
6850 @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default
6851 executable suffix, @samp{.EXE} is appended.
6853 With either @code{LIBRARY <name>} or @code{NAME <name>} the optional
6854 specification @code{BASE = <number>} may be used to specify a
6855 non-default base address for the image.
6857 If neither @code{LIBRARY <name>} nor  @code{NAME <name>} is specified,
6858 or they specify an empty string, the internal name is the same as the
6859 filename specified on the command line.
6861 The complete specification of an export symbol is:
6863 @example
6864 EXPORTS
6865   ( (  ( <name1> [ = <name2> ] )
6866      | ( <name1> = <module-name> . <external-name>))
6867   [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) *
6868 @end example
6870 Declares @samp{<name1>} as an exported symbol from the DLL, or declares
6871 @samp{<name1>} as an exported alias for @samp{<name2>}; or declares
6872 @samp{<name1>} as a "forward" alias for the symbol
6873 @samp{<external-name>} in the DLL @samp{<module-name>}.
6874 Optionally, the symbol may be exported by the specified ordinal
6875 @samp{<integer>} alias. The optional @samp{<name3>} is the to be used
6876 string in import/export table for the symbol.
6878 The optional keywords that follow the declaration indicate:
6880 @code{NONAME}: Do not put the symbol name in the DLL's export table.  It
6881 will still be exported by its ordinal alias (either the value specified
6882 by the .def specification or, otherwise, the value assigned by the
6883 linker). The symbol name, however, does remain visible in the import
6884 library (if any), unless @code{PRIVATE} is also specified.
6886 @code{DATA}: The symbol is a variable or object, rather than a function.
6887 The import lib will export only an indirect reference to @code{foo} as
6888 the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as
6889 @code{*_imp__foo}).
6891 @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as
6892 well as @code{_imp__foo} into the import library. Both refer to the
6893 read-only import address table's pointer to the variable, not to the
6894 variable itself. This can be dangerous. If the user code fails to add
6895 the @code{dllimport} attribute and also fails to explicitly add the
6896 extra indirection that the use of the attribute enforces, the
6897 application will behave unexpectedly.
6899 @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put
6900 it into the static import library used to resolve imports at link time. The
6901 symbol can still be imported using the @code{LoadLibrary/GetProcAddress}
6902 API at runtime or by by using the GNU ld extension of linking directly to
6903 the DLL without an import library.
6905 See ld/deffilep.y in the binutils sources for the full specification of
6906 other DEF file statements
6908 @cindex creating a DEF file
6909 While linking a shared dll, @command{ld} is able to create a DEF file
6910 with the @samp{--output-def <file>} command line option.
6912 @item   Using decorations
6913 @cindex Using decorations
6914 Another way of marking symbols for export is to modify the source code
6915 itself, so that when building the DLL each symbol to be exported is
6916 declared as:
6918 @example
6919 __declspec(dllexport) int a_variable
6920 __declspec(dllexport) void a_function(int with_args)
6921 @end example
6923 All such symbols will be exported from the DLL.  If, however,
6924 any of the object files in the DLL contain symbols decorated in
6925 this way, then the normal auto-export behavior is disabled, unless
6926 the @samp{--export-all-symbols} option is also used.
6928 Note that object files that wish to access these symbols must @emph{not}
6929 decorate them with dllexport.  Instead, they should use dllimport,
6930 instead:
6932 @example
6933 __declspec(dllimport) int a_variable
6934 __declspec(dllimport) void a_function(int with_args)
6935 @end example
6937 This complicates the structure of library header files, because
6938 when included by the library itself the header must declare the
6939 variables and functions as dllexport, but when included by client
6940 code the header must declare them as dllimport.  There are a number
6941 of idioms that are typically used to do this; often client code can
6942 omit the __declspec() declaration completely.  See
6943 @samp{--enable-auto-import} and @samp{automatic data imports} for more
6944 information.
6945 @end table
6947 @cindex automatic data imports
6948 @item automatic data imports
6949 The standard Windows dll format supports data imports from dlls only
6950 by adding special decorations (dllimport/dllexport), which let the
6951 compiler produce specific assembler instructions to deal with this
6952 issue.  This increases the effort necessary to port existing Un*x
6953 code to these platforms, especially for large
6954 c++ libraries and applications.  The auto-import feature, which was
6955 initially provided by Paul Sokolovsky, allows one to omit the
6956 decorations to achieve a behavior that conforms to that on POSIX/Un*x
6957 platforms. This feature is enabled with the @samp{--enable-auto-import}
6958 command-line option, although it is enabled by default on cygwin/mingw.
6959 The @samp{--enable-auto-import} option itself now serves mainly to
6960 suppress any warnings that are ordinarily emitted when linked objects
6961 trigger the feature's use.
6963 auto-import of variables does not always work flawlessly without
6964 additional assistance.  Sometimes, you will see this message
6966 "variable '<var>' can't be auto-imported. Please read the
6967 documentation for ld's @code{--enable-auto-import} for details."
6969 The @samp{--enable-auto-import} documentation explains why this error
6970 occurs, and several methods that can be used to overcome this difficulty.
6971 One of these methods is the @emph{runtime pseudo-relocs} feature, described
6972 below.
6974 @cindex runtime pseudo-relocation
6975 For complex variables imported from DLLs (such as structs or classes),
6976 object files typically contain a base address for the variable and an
6977 offset (@emph{addend}) within the variable--to specify a particular
6978 field or public member, for instance.  Unfortunately, the runtime loader used
6979 in win32 environments is incapable of fixing these references at runtime
6980 without the additional information supplied by dllimport/dllexport decorations.
6981 The standard auto-import feature described above is unable to resolve these
6982 references.
6984 The @samp{--enable-runtime-pseudo-relocs} switch allows these references to
6985 be resolved without error, while leaving the task of adjusting the references
6986 themselves (with their non-zero addends) to specialized code provided by the
6987 runtime environment.  Recent versions of the cygwin and mingw environments and
6988 compilers provide this runtime support; older versions do not.  However, the
6989 support is only necessary on the developer's platform; the compiled result will
6990 run without error on an older system.
6992 @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly
6993 enabled as needed.
6995 @cindex direct linking to a dll
6996 @item direct linking to a dll
6997 The cygwin/mingw ports of @command{ld} support the direct linking,
6998 including data symbols, to a dll without the usage of any import
6999 libraries.  This is much faster and uses much less memory than does the
7000 traditional import library method, especially when linking large
7001 libraries or applications.  When @command{ld} creates an import lib, each
7002 function or variable exported from the dll is stored in its own bfd, even
7003 though a single bfd could contain many exports.  The overhead involved in
7004 storing, loading, and processing so many bfd's is quite large, and explains the
7005 tremendous time, memory, and storage needed to link against particularly
7006 large or complex libraries when using import libs.
7008 Linking directly to a dll uses no extra command-line switches other than
7009 @samp{-L} and @samp{-l}, because @command{ld} already searches for a number
7010 of names to match each library.  All that is needed from the developer's
7011 perspective is an understanding of this search, in order to force ld to
7012 select the dll instead of an import library.
7015 For instance, when ld is called with the argument @samp{-lxxx} it will attempt
7016 to find, in the first directory of its search path,
7018 @example
7019 libxxx.dll.a
7020 xxx.dll.a
7021 libxxx.a
7022 xxx.lib
7023 cygxxx.dll (*)
7024 libxxx.dll
7025 xxx.dll
7026 @end example
7028 before moving on to the next directory in the search path.
7030 (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll},
7031 where @samp{<prefix>} is set by the @command{ld} option
7032 @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec
7033 file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for
7034 @samp{cygxxx.dll}.
7036 Other win32-based unix environments, such as mingw or pw32, may use other
7037 @samp{<prefix>}es, although at present only cygwin makes use of this feature.  It
7038 was originally intended to help avoid name conflicts among dll's built for the
7039 various win32/un*x environments, so that (for example) two versions of a zlib dll
7040 could coexist on the same machine.
7042 The generic cygwin/mingw path layout uses a @samp{bin} directory for
7043 applications and dll's and a @samp{lib} directory for the import
7044 libraries (using cygwin nomenclature):
7046 @example
7047 bin/
7048         cygxxx.dll
7049 lib/
7050         libxxx.dll.a   (in case of dll's)
7051         libxxx.a       (in case of static archive)
7052 @end example
7054 Linking directly to a dll without using the import library can be
7055 done two ways:
7057 1. Use the dll directly by adding the @samp{bin} path to the link line
7058 @example
7059 gcc -Wl,-verbose  -o a.exe -L../bin/ -lxxx
7060 @end example
7062 However, as the dll's often have version numbers appended to their names
7063 (@samp{cygncurses-5.dll}) this will often fail, unless one specifies
7064 @samp{-L../bin -lncurses-5} to include the version.  Import libs are generally
7065 not versioned, and do not have this difficulty.
7067 2. Create a symbolic link from the dll to a file in the @samp{lib}
7068 directory according to the above mentioned search pattern.  This
7069 should be used to avoid unwanted changes in the tools needed for
7070 making the app/dll.
7072 @example
7073 ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a]
7074 @end example
7076 Then you can link without any make environment changes.
7078 @example
7079 gcc -Wl,-verbose  -o a.exe -L../lib/ -lxxx
7080 @end example
7082 This technique also avoids the version number problems, because the following is
7083 perfectly legal
7085 @example
7086 bin/
7087         cygxxx-5.dll
7088 lib/
7089         libxxx.dll.a -> ../bin/cygxxx-5.dll
7090 @end example
7092 Linking directly to a dll without using an import lib will work
7093 even when auto-import features are exercised, and even when
7094 @samp{--enable-runtime-pseudo-relocs} is used.
7096 Given the improvements in speed and memory usage, one might justifiably
7097 wonder why import libraries are used at all.  There are three reasons:
7099 1. Until recently, the link-directly-to-dll functionality did @emph{not}
7100 work with auto-imported data.
7102 2. Sometimes it is necessary to include pure static objects within the
7103 import library (which otherwise contains only bfd's for indirection
7104 symbols that point to the exports of a dll).  Again, the import lib
7105 for the cygwin kernel makes use of this ability, and it is not
7106 possible to do this without an import lib.
7108 3. Symbol aliases can only be resolved using an import lib.  This is
7109 critical when linking against OS-supplied dll's (eg, the win32 API)
7110 in which symbols are usually exported as undecorated aliases of their
7111 stdcall-decorated assembly names.
7113 So, import libs are not going away.  But the ability to replace
7114 true import libs with a simple symbolic link to (or a copy of)
7115 a dll, in many cases, is a useful addition to the suite of tools
7116 binutils makes available to the win32 developer.  Given the
7117 massive improvements in memory requirements during linking, storage
7118 requirements, and linking speed, we expect that many developers
7119 will soon begin to use this feature whenever possible.
7121 @item symbol aliasing
7122 @table @emph
7123 @item adding additional names
7124 Sometimes, it is useful to export symbols with additional names.
7125 A symbol @samp{foo} will be exported as @samp{foo}, but it can also be
7126 exported as @samp{_foo} by using special directives in the DEF file
7127 when creating the dll.  This will affect also the optional created
7128 import library.  Consider the following DEF file:
7130 @example
7131 LIBRARY "xyz.dll" BASE=0x61000000
7133 EXPORTS
7135 _foo = foo
7136 @end example
7138 The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}.
7140 Another method for creating a symbol alias is to create it in the
7141 source code using the "weak" attribute:
7143 @example
7144 void foo () @{ /* Do something.  */; @}
7145 void _foo () __attribute__ ((weak, alias ("foo")));
7146 @end example
7148 See the gcc manual for more information about attributes and weak
7149 symbols.
7151 @item renaming symbols
7152 Sometimes it is useful to rename exports.  For instance, the cygwin
7153 kernel does this regularly.  A symbol @samp{_foo} can be exported as
7154 @samp{foo} but not as @samp{_foo} by using special directives in the
7155 DEF file. (This will also affect the import library, if it is
7156 created).  In the following example:
7158 @example
7159 LIBRARY "xyz.dll" BASE=0x61000000
7161 EXPORTS
7162 _foo = foo
7163 @end example
7165 The line @samp{_foo = foo} maps the exported symbol @samp{foo} to
7166 @samp{_foo}.
7167 @end table
7169 Note: using a DEF file disables the default auto-export behavior,
7170 unless the @samp{--export-all-symbols} command line option is used.
7171 If, however, you are trying to rename symbols, then you should list
7172 @emph{all} desired exports in the DEF file, including the symbols
7173 that are not being renamed, and do @emph{not} use the
7174 @samp{--export-all-symbols} option.  If you list only the
7175 renamed symbols in the DEF file, and use @samp{--export-all-symbols}
7176 to handle the other symbols, then the both the new names @emph{and}
7177 the original names for the renamed symbols will be exported.
7178 In effect, you'd be aliasing those symbols, not renaming them,
7179 which is probably not what you wanted.
7181 @cindex weak externals
7182 @item weak externals
7183 The Windows object format, PE, specifies a form of weak symbols called
7184 weak externals.  When a weak symbol is linked and the symbol is not
7185 defined, the weak symbol becomes an alias for some other symbol.  There
7186 are three variants of weak externals:
7187 @itemize
7188 @item Definition is searched for in objects and libraries, historically
7189 called lazy externals.
7190 @item Definition is searched for only in other objects, not in libraries.
7191 This form is not presently implemented.
7192 @item No search; the symbol is an alias.  This form is not presently
7193 implemented.
7194 @end itemize
7195 As a GNU extension, weak symbols that do not specify an alternate symbol
7196 are supported.  If the symbol is undefined when linking, the symbol
7197 uses a default value.
7199 @cindex aligned common symbols
7200 @item aligned common symbols
7201 As a GNU extension to the PE file format, it is possible to specify the
7202 desired alignment for a common symbol.  This information is conveyed from
7203 the assembler or compiler to the linker by means of GNU-specific commands
7204 carried in the object file's @samp{.drectve} section, which are recognized
7205 by @command{ld} and respected when laying out the common symbols.  Native
7206 tools will be able to process object files employing this GNU extension,
7207 but will fail to respect the alignment instructions, and may issue noisy
7208 warnings about unknown linker directives.
7209 @end table
7211 @ifclear GENERIC
7212 @lowersections
7213 @end ifclear
7214 @end ifset
7216 @ifset XTENSA
7217 @ifclear GENERIC
7218 @raisesections
7219 @end ifclear
7221 @node Xtensa
7222 @section @code{ld} and Xtensa Processors
7224 @cindex Xtensa processors
7225 The default @command{ld} behavior for Xtensa processors is to interpret
7226 @code{SECTIONS} commands so that lists of explicitly named sections in a
7227 specification with a wildcard file will be interleaved when necessary to
7228 keep literal pools within the range of PC-relative load offsets.  For
7229 example, with the command:
7231 @smallexample
7232 SECTIONS
7234   .text : @{
7235     *(.literal .text)
7236   @}
7238 @end smallexample
7240 @noindent
7241 @command{ld} may interleave some of the @code{.literal}
7242 and @code{.text} sections from different object files to ensure that the
7243 literal pools are within the range of PC-relative load offsets.  A valid
7244 interleaving might place the @code{.literal} sections from an initial
7245 group of files followed by the @code{.text} sections of that group of
7246 files.  Then, the @code{.literal} sections from the rest of the files
7247 and the @code{.text} sections from the rest of the files would follow.
7249 @cindex @option{--relax} on Xtensa
7250 @cindex relaxing on Xtensa
7251 Relaxation is enabled by default for the Xtensa version of @command{ld} and
7252 provides two important link-time optimizations.  The first optimization
7253 is to combine identical literal values to reduce code size.  A redundant
7254 literal will be removed and all the @code{L32R} instructions that use it
7255 will be changed to reference an identical literal, as long as the
7256 location of the replacement literal is within the offset range of all
7257 the @code{L32R} instructions.  The second optimization is to remove
7258 unnecessary overhead from assembler-generated ``longcall'' sequences of
7259 @code{L32R}/@code{CALLX@var{n}} when the target functions are within
7260 range of direct @code{CALL@var{n}} instructions.
7262 For each of these cases where an indirect call sequence can be optimized
7263 to a direct call, the linker will change the @code{CALLX@var{n}}
7264 instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R}
7265 instruction, and remove the literal referenced by the @code{L32R}
7266 instruction if it is not used for anything else.  Removing the
7267 @code{L32R} instruction always reduces code size but can potentially
7268 hurt performance by changing the alignment of subsequent branch targets.
7269 By default, the linker will always preserve alignments, either by
7270 switching some instructions between 24-bit encodings and the equivalent
7271 density instructions or by inserting a no-op in place of the @code{L32R}
7272 instruction that was removed.  If code size is more important than
7273 performance, the @option{--size-opt} option can be used to prevent the
7274 linker from widening density instructions or inserting no-ops, except in
7275 a few cases where no-ops are required for correctness.
7277 The following Xtensa-specific command-line options can be used to
7278 control the linker:
7280 @cindex Xtensa options
7281 @table @option
7282 @item --size-opt
7283 When optimizing indirect calls to direct calls, optimize for code size
7284 more than performance.  With this option, the linker will not insert
7285 no-ops or widen density instructions to preserve branch target
7286 alignment.  There may still be some cases where no-ops are required to
7287 preserve the correctness of the code.
7288 @end table
7290 @ifclear GENERIC
7291 @lowersections
7292 @end ifclear
7293 @end ifset
7295 @ifclear SingleFormat
7296 @node BFD
7297 @chapter BFD
7299 @cindex back end
7300 @cindex object file management
7301 @cindex object formats available
7302 @kindex objdump -i
7303 The linker accesses object and archive files using the BFD libraries.
7304 These libraries allow the linker to use the same routines to operate on
7305 object files whatever the object file format.  A different object file
7306 format can be supported simply by creating a new BFD back end and adding
7307 it to the library.  To conserve runtime memory, however, the linker and
7308 associated tools are usually configured to support only a subset of the
7309 object file formats available.  You can use @code{objdump -i}
7310 (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to
7311 list all the formats available for your configuration.
7313 @cindex BFD requirements
7314 @cindex requirements for BFD
7315 As with most implementations, BFD is a compromise between
7316 several conflicting requirements. The major factor influencing
7317 BFD design was efficiency: any time used converting between
7318 formats is time which would not have been spent had BFD not
7319 been involved. This is partly offset by abstraction payback; since
7320 BFD simplifies applications and back ends, more time and care
7321 may be spent optimizing algorithms for a greater speed.
7323 One minor artifact of the BFD solution which you should bear in
7324 mind is the potential for information loss.  There are two places where
7325 useful information can be lost using the BFD mechanism: during
7326 conversion and during output. @xref{BFD information loss}.
7328 @menu
7329 * BFD outline::                 How it works: an outline of BFD
7330 @end menu
7332 @node BFD outline
7333 @section How It Works: An Outline of BFD
7334 @cindex opening object files
7335 @include bfdsumm.texi
7336 @end ifclear
7338 @node Reporting Bugs
7339 @chapter Reporting Bugs
7340 @cindex bugs in @command{ld}
7341 @cindex reporting bugs in @command{ld}
7343 Your bug reports play an essential role in making @command{ld} reliable.
7345 Reporting a bug may help you by bringing a solution to your problem, or
7346 it may not.  But in any case the principal function of a bug report is
7347 to help the entire community by making the next version of @command{ld}
7348 work better.  Bug reports are your contribution to the maintenance of
7349 @command{ld}.
7351 In order for a bug report to serve its purpose, you must include the
7352 information that enables us to fix the bug.
7354 @menu
7355 * Bug Criteria::                Have you found a bug?
7356 * Bug Reporting::               How to report bugs
7357 @end menu
7359 @node Bug Criteria
7360 @section Have You Found a Bug?
7361 @cindex bug criteria
7363 If you are not sure whether you have found a bug, here are some guidelines:
7365 @itemize @bullet
7366 @cindex fatal signal
7367 @cindex linker crash
7368 @cindex crash of linker
7369 @item
7370 If the linker gets a fatal signal, for any input whatever, that is a
7371 @command{ld} bug.  Reliable linkers never crash.
7373 @cindex error on valid input
7374 @item
7375 If @command{ld} produces an error message for valid input, that is a bug.
7377 @cindex invalid input
7378 @item
7379 If @command{ld} does not produce an error message for invalid input, that
7380 may be a bug.  In the general case, the linker can not verify that
7381 object files are correct.
7383 @item
7384 If you are an experienced user of linkers, your suggestions for
7385 improvement of @command{ld} are welcome in any case.
7386 @end itemize
7388 @node Bug Reporting
7389 @section How to Report Bugs
7390 @cindex bug reports
7391 @cindex @command{ld} bugs, reporting
7393 A number of companies and individuals offer support for @sc{gnu}
7394 products.  If you obtained @command{ld} from a support organization, we
7395 recommend you contact that organization first.
7397 You can find contact information for many support companies and
7398 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
7399 distribution.
7401 @ifset BUGURL
7402 Otherwise, send bug reports for @command{ld} to
7403 @value{BUGURL}.
7404 @end ifset
7406 The fundamental principle of reporting bugs usefully is this:
7407 @strong{report all the facts}.  If you are not sure whether to state a
7408 fact or leave it out, state it!
7410 Often people omit facts because they think they know what causes the
7411 problem and assume that some details do not matter.  Thus, you might
7412 assume that the name of a symbol you use in an example does not
7413 matter.  Well, probably it does not, but one cannot be sure.  Perhaps
7414 the bug is a stray memory reference which happens to fetch from the
7415 location where that name is stored in memory; perhaps, if the name
7416 were different, the contents of that location would fool the linker
7417 into doing the right thing despite the bug.  Play it safe and give a
7418 specific, complete example.  That is the easiest thing for you to do,
7419 and the most helpful.
7421 Keep in mind that the purpose of a bug report is to enable us to fix
7422 the bug if it is new to us.  Therefore, always write your bug reports
7423 on the assumption that the bug has not been reported previously.
7425 Sometimes people give a few sketchy facts and ask, ``Does this ring a
7426 bell?''  This cannot help us fix a bug, so it is basically useless.  We
7427 respond by asking for enough details to enable us to investigate.
7428 You might as well expedite matters by sending them to begin with.
7430 To enable us to fix the bug, you should include all these things:
7432 @itemize @bullet
7433 @item
7434 The version of @command{ld}.  @command{ld} announces it if you start it with
7435 the @samp{--version} argument.
7437 Without this, we will not know whether there is any point in looking for
7438 the bug in the current version of @command{ld}.
7440 @item
7441 Any patches you may have applied to the @command{ld} source, including any
7442 patches made to the @code{BFD} library.
7444 @item
7445 The type of machine you are using, and the operating system name and
7446 version number.
7448 @item
7449 What compiler (and its version) was used to compile @command{ld}---e.g.
7450 ``@code{gcc-2.7}''.
7452 @item
7453 The command arguments you gave the linker to link your example and
7454 observe the bug.  To guarantee you will not omit something important,
7455 list them all.  A copy of the Makefile (or the output from make) is
7456 sufficient.
7458 If we were to try to guess the arguments, we would probably guess wrong
7459 and then we might not encounter the bug.
7461 @item
7462 A complete input file, or set of input files, that will reproduce the
7463 bug.  It is generally most helpful to send the actual object files
7464 provided that they are reasonably small.  Say no more than 10K.  For
7465 bigger files you can either make them available by FTP or HTTP or else
7466 state that you are willing to send the object file(s) to whomever
7467 requests them.  (Note - your email will be going to a mailing list, so
7468 we do not want to clog it up with large attachments).  But small
7469 attachments are best.
7471 If the source files were assembled using @code{gas} or compiled using
7472 @code{gcc}, then it may be OK to send the source files rather than the
7473 object files.  In this case, be sure to say exactly what version of
7474 @code{gas} or @code{gcc} was used to produce the object files.  Also say
7475 how @code{gas} or @code{gcc} were configured.
7477 @item
7478 A description of what behavior you observe that you believe is
7479 incorrect.  For example, ``It gets a fatal signal.''
7481 Of course, if the bug is that @command{ld} gets a fatal signal, then we
7482 will certainly notice it.  But if the bug is incorrect output, we might
7483 not notice unless it is glaringly wrong.  You might as well not give us
7484 a chance to make a mistake.
7486 Even if the problem you experience is a fatal signal, you should still
7487 say so explicitly.  Suppose something strange is going on, such as, your
7488 copy of @command{ld} is out of sync, or you have encountered a bug in the
7489 C library on your system.  (This has happened!)  Your copy might crash
7490 and ours would not.  If you told us to expect a crash, then when ours
7491 fails to crash, we would know that the bug was not happening for us.  If
7492 you had not told us to expect a crash, then we would not be able to draw
7493 any conclusion from our observations.
7495 @item
7496 If you wish to suggest changes to the @command{ld} source, send us context
7497 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or
7498 @samp{-p} option.  Always send diffs from the old file to the new file.
7499 If you even discuss something in the @command{ld} source, refer to it by
7500 context, not by line number.
7502 The line numbers in our development sources will not match those in your
7503 sources.  Your line numbers would convey no useful information to us.
7504 @end itemize
7506 Here are some things that are not necessary:
7508 @itemize @bullet
7509 @item
7510 A description of the envelope of the bug.
7512 Often people who encounter a bug spend a lot of time investigating
7513 which changes to the input file will make the bug go away and which
7514 changes will not affect it.
7516 This is often time consuming and not very useful, because the way we
7517 will find the bug is by running a single example under the debugger
7518 with breakpoints, not by pure deduction from a series of examples.
7519 We recommend that you save your time for something else.
7521 Of course, if you can find a simpler example to report @emph{instead}
7522 of the original one, that is a convenience for us.  Errors in the
7523 output will be easier to spot, running under the debugger will take
7524 less time, and so on.
7526 However, simplification is not vital; if you do not want to do this,
7527 report the bug anyway and send us the entire test case you used.
7529 @item
7530 A patch for the bug.
7532 A patch for the bug does help us if it is a good one.  But do not omit
7533 the necessary information, such as the test case, on the assumption that
7534 a patch is all we need.  We might see problems with your patch and decide
7535 to fix the problem another way, or we might not understand it at all.
7537 Sometimes with a program as complicated as @command{ld} it is very hard to
7538 construct an example that will make the program follow a certain path
7539 through the code.  If you do not send us the example, we will not be
7540 able to construct one, so we will not be able to verify that the bug is
7541 fixed.
7543 And if we cannot understand what bug you are trying to fix, or why your
7544 patch should be an improvement, we will not install it.  A test case will
7545 help us to understand.
7547 @item
7548 A guess about what the bug is or what it depends on.
7550 Such guesses are usually wrong.  Even we cannot guess right about such
7551 things without first using the debugger to find the facts.
7552 @end itemize
7554 @node MRI
7555 @appendix MRI Compatible Script Files
7556 @cindex MRI compatibility
7557 To aid users making the transition to @sc{gnu} @command{ld} from the MRI
7558 linker, @command{ld} can use MRI compatible linker scripts as an
7559 alternative to the more general-purpose linker scripting language
7560 described in @ref{Scripts}.  MRI compatible linker scripts have a much
7561 simpler command set than the scripting language otherwise used with
7562 @command{ld}.  @sc{gnu} @command{ld} supports the most commonly used MRI
7563 linker commands; these commands are described here.
7565 In general, MRI scripts aren't of much use with the @code{a.out} object
7566 file format, since it only has three sections and MRI scripts lack some
7567 features to make use of them.
7569 You can specify a file containing an MRI-compatible script using the
7570 @samp{-c} command-line option.
7572 Each command in an MRI-compatible script occupies its own line; each
7573 command line starts with the keyword that identifies the command (though
7574 blank lines are also allowed for punctuation).  If a line of an
7575 MRI-compatible script begins with an unrecognized keyword, @command{ld}
7576 issues a warning message, but continues processing the script.
7578 Lines beginning with @samp{*} are comments.
7580 You can write these commands using all upper-case letters, or all
7581 lower case; for example, @samp{chip} is the same as @samp{CHIP}.
7582 The following list shows only the upper-case form of each command.
7584 @table @code
7585 @cindex @code{ABSOLUTE} (MRI)
7586 @item ABSOLUTE @var{secname}
7587 @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname}
7588 Normally, @command{ld} includes in the output file all sections from all
7589 the input files.  However, in an MRI-compatible script, you can use the
7590 @code{ABSOLUTE} command to restrict the sections that will be present in
7591 your output program.  If the @code{ABSOLUTE} command is used at all in a
7592 script, then only the sections named explicitly in @code{ABSOLUTE}
7593 commands will appear in the linker output.  You can still use other
7594 input sections (whatever you select on the command line, or using
7595 @code{LOAD}) to resolve addresses in the output file.
7597 @cindex @code{ALIAS} (MRI)
7598 @item ALIAS @var{out-secname}, @var{in-secname}
7599 Use this command to place the data from input section @var{in-secname}
7600 in a section called @var{out-secname} in the linker output file.
7602 @var{in-secname} may be an integer.
7604 @cindex @code{ALIGN} (MRI)
7605 @item ALIGN @var{secname} = @var{expression}
7606 Align the section called @var{secname} to @var{expression}.  The
7607 @var{expression} should be a power of two.
7609 @cindex @code{BASE} (MRI)
7610 @item BASE @var{expression}
7611 Use the value of @var{expression} as the lowest address (other than
7612 absolute addresses) in the output file.
7614 @cindex @code{CHIP} (MRI)
7615 @item CHIP @var{expression}
7616 @itemx CHIP @var{expression}, @var{expression}
7617 This command does nothing; it is accepted only for compatibility.
7619 @cindex @code{END} (MRI)
7620 @item END
7621 This command does nothing whatever; it's only accepted for compatibility.
7623 @cindex @code{FORMAT} (MRI)
7624 @item FORMAT @var{output-format}
7625 Similar to the @code{OUTPUT_FORMAT} command in the more general linker
7626 language, but restricted to one of these output formats:
7628 @enumerate
7629 @item
7630 S-records, if @var{output-format} is @samp{S}
7632 @item
7633 IEEE, if @var{output-format} is @samp{IEEE}
7635 @item
7636 COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is
7637 @samp{COFF}
7638 @end enumerate
7640 @cindex @code{LIST} (MRI)
7641 @item LIST @var{anything}@dots{}
7642 Print (to the standard output file) a link map, as produced by the
7643 @command{ld} command-line option @samp{-M}.
7645 The keyword @code{LIST} may be followed by anything on the
7646 same line, with no change in its effect.
7648 @cindex @code{LOAD} (MRI)
7649 @item LOAD @var{filename}
7650 @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename}
7651 Include one or more object file @var{filename} in the link; this has the
7652 same effect as specifying @var{filename} directly on the @command{ld}
7653 command line.
7655 @cindex @code{NAME} (MRI)
7656 @item NAME @var{output-name}
7657 @var{output-name} is the name for the program produced by @command{ld}; the
7658 MRI-compatible command @code{NAME} is equivalent to the command-line
7659 option @samp{-o} or the general script language command @code{OUTPUT}.
7661 @cindex @code{ORDER} (MRI)
7662 @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname}
7663 @itemx ORDER @var{secname} @var{secname} @var{secname}
7664 Normally, @command{ld} orders the sections in its output file in the
7665 order in which they first appear in the input files.  In an MRI-compatible
7666 script, you can override this ordering with the @code{ORDER} command.  The
7667 sections you list with @code{ORDER} will appear first in your output
7668 file, in the order specified.
7670 @cindex @code{PUBLIC} (MRI)
7671 @item PUBLIC @var{name}=@var{expression}
7672 @itemx PUBLIC @var{name},@var{expression}
7673 @itemx PUBLIC @var{name} @var{expression}
7674 Supply a value (@var{expression}) for external symbol
7675 @var{name} used in the linker input files.
7677 @cindex @code{SECT} (MRI)
7678 @item SECT @var{secname}, @var{expression}
7679 @itemx SECT @var{secname}=@var{expression}
7680 @itemx SECT @var{secname} @var{expression}
7681 You can use any of these three forms of the @code{SECT} command to
7682 specify the start address (@var{expression}) for section @var{secname}.
7683 If you have more than one @code{SECT} statement for the same
7684 @var{secname}, only the @emph{first} sets the start address.
7685 @end table
7687 @node GNU Free Documentation License
7688 @appendix GNU Free Documentation License
7689 @include fdl.texi
7691 @node LD Index
7692 @unnumbered LD Index
7694 @printindex cp
7696 @tex
7697 % I think something like @colophon should be in texinfo.  In the
7698 % meantime:
7699 \long\def\colophon{\hbox to0pt{}\vfill
7700 \centerline{The body of this manual is set in}
7701 \centerline{\fontname\tenrm,}
7702 \centerline{with headings in {\bf\fontname\tenbf}}
7703 \centerline{and examples in {\tt\fontname\tentt}.}
7704 \centerline{{\it\fontname\tenit\/} and}
7705 \centerline{{\sl\fontname\tensl\/}}
7706 \centerline{are used for emphasis.}\vfill}
7707 \page\colophon
7708 % Blame: doc@cygnus.com, 28mar91.
7709 @end tex
7711 @bye