* elf32-h8300 (h8_relax_section): Add new relaxation of mov
[platform/upstream/binutils.git] / ld / ld.texinfo
1 \input texinfo
2 @setfilename ld.info
3 @c Copyright 1991-2013 Free Software Foundation, Inc.
4 @syncodeindex ky cp
5 @c man begin INCLUDE
6 @include configdoc.texi
7 @c (configdoc.texi is generated by the Makefile)
8 @include bfdver.texi
9 @c man end
10
11 @c @smallbook
12
13 @macro gcctabopt{body}
14 @code{\body\}
15 @end macro
16
17 @c man begin NAME
18 @ifset man
19 @c Configure for the generation of man pages
20 @set UsesEnvVars
21 @set GENERIC
22 @set ARM
23 @set C6X
24 @set H8300
25 @set HPPA
26 @set I960
27 @set M68HC11
28 @set M68K
29 @set MMIX
30 @set MSP430
31 @set POWERPC
32 @set POWERPC64
33 @set Renesas
34 @set SPU
35 @set TICOFF
36 @set WIN32
37 @set XTENSA
38 @end ifset
39 @c man end
40
41 @ifnottex
42 @dircategory Software development
43 @direntry
44 * Ld: (ld).                       The GNU linker.
45 @end direntry
46 @end ifnottex
47
48 @copying
49 This file documents the @sc{gnu} linker LD
50 @ifset VERSION_PACKAGE
51 @value{VERSION_PACKAGE}
52 @end ifset
53 version @value{VERSION}.
54
55 Copyright @copyright{} 1991-2013 Free Software Foundation, Inc.
56
57 Permission is granted to copy, distribute and/or modify this document
58 under the terms of the GNU Free Documentation License, Version 1.3
59 or any later version published by the Free Software Foundation;
60 with no Invariant Sections, with no Front-Cover Texts, and with no
61 Back-Cover Texts.  A copy of the license is included in the
62 section entitled ``GNU Free Documentation License''.
63 @end copying
64 @iftex
65 @finalout
66 @setchapternewpage odd
67 @settitle The GNU linker
68 @titlepage
69 @title The GNU linker
70 @sp 1
71 @subtitle @code{ld}
72 @ifset VERSION_PACKAGE
73 @subtitle @value{VERSION_PACKAGE}
74 @end ifset
75 @subtitle Version @value{VERSION}
76 @author Steve Chamberlain
77 @author Ian Lance Taylor
78 @page
79
80 @tex
81 {\parskip=0pt
82 \hfill Red Hat Inc\par
83 \hfill nickc\@credhat.com, doc\@redhat.com\par
84 \hfill {\it The GNU linker}\par
85 \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par
86 }
87 \global\parindent=0pt % Steve likes it this way.
88 @end tex
89
90 @vskip 0pt plus 1filll
91 @c man begin COPYRIGHT
92 Copyright @copyright{} 1991-2013 Free Software Foundation, Inc.
93
94 Permission is granted to copy, distribute and/or modify this document
95 under the terms of the GNU Free Documentation License, Version 1.3
96 or any later version published by the Free Software Foundation;
97 with no Invariant Sections, with no Front-Cover Texts, and with no
98 Back-Cover Texts.  A copy of the license is included in the
99 section entitled ``GNU Free Documentation License''.
100 @c man end
101
102 @end titlepage
103 @end iftex
104 @contents
105 @c FIXME: Talk about importance of *order* of args, cmds to linker!
106
107 @ifnottex
108 @node Top
109 @top LD
110 This file documents the @sc{gnu} linker ld
111 @ifset VERSION_PACKAGE
112 @value{VERSION_PACKAGE}
113 @end ifset
114 version @value{VERSION}.
115
116 This document is distributed under the terms of the GNU Free
117 Documentation License version 1.3.  A copy of the license is included
118 in the section entitled ``GNU Free Documentation License''.
119
120 @menu
121 * Overview::                    Overview
122 * Invocation::                  Invocation
123 * Scripts::                     Linker Scripts
124 @ifset GENERIC
125 * Machine Dependent::           Machine Dependent Features
126 @end ifset
127 @ifclear GENERIC
128 @ifset H8300
129 * H8/300::                      ld and the H8/300
130 @end ifset
131 @ifset Renesas
132 * Renesas::                     ld and other Renesas micros
133 @end ifset
134 @ifset I960
135 * i960::                        ld and the Intel 960 family
136 @end ifset
137 @ifset ARM
138 * ARM::                         ld and the ARM family
139 @end ifset
140 @ifset M68HC11
141 * M68HC11/68HC12::              ld and the Motorola 68HC11 and 68HC12 families
142 @end ifset
143 @ifset HPPA
144 * HPPA ELF32::                  ld and HPPA 32-bit ELF
145 @end ifset
146 @ifset M68K
147 * M68K::                        ld and Motorola 68K family
148 @end ifset
149 @ifset POWERPC
150 * PowerPC ELF32::               ld and PowerPC 32-bit ELF Support
151 @end ifset
152 @ifset POWERPC64
153 * PowerPC64 ELF64::             ld and PowerPC64 64-bit ELF Support
154 @end ifset
155 @ifset SPU
156 * SPU ELF::                     ld and SPU ELF Support
157 @end ifset
158 @ifset TICOFF
159 * TI COFF::                     ld and the TI COFF
160 @end ifset
161 @ifset WIN32
162 * Win32::                       ld and WIN32 (cygwin/mingw)
163 @end ifset
164 @ifset XTENSA
165 * Xtensa::                      ld and Xtensa Processors
166 @end ifset
167 @end ifclear
168 @ifclear SingleFormat
169 * BFD::                         BFD
170 @end ifclear
171 @c Following blank line required for remaining bug in makeinfo conds/menus
172
173 * Reporting Bugs::              Reporting Bugs
174 * MRI::                         MRI Compatible Script Files
175 * GNU Free Documentation License::  GNU Free Documentation License
176 * LD Index::                       LD Index
177 @end menu
178 @end ifnottex
179
180 @node Overview
181 @chapter Overview
182
183 @cindex @sc{gnu} linker
184 @cindex what is this?
185
186 @ifset man
187 @c man begin SYNOPSIS
188 ld [@b{options}] @var{objfile} @dots{}
189 @c man end
190
191 @c man begin SEEALSO
192 ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and
193 the Info entries for @file{binutils} and
194 @file{ld}.
195 @c man end
196 @end ifset
197
198 @c man begin DESCRIPTION
199
200 @command{ld} combines a number of object and archive files, relocates
201 their data and ties up symbol references. Usually the last step in
202 compiling a program is to run @command{ld}.
203
204 @command{ld} accepts Linker Command Language files written in
205 a superset of AT&T's Link Editor Command Language syntax,
206 to provide explicit and total control over the linking process.
207
208 @ifset man
209 @c For the man only
210 This man page does not describe the command language; see the
211 @command{ld} entry in @code{info} for full details on the command
212 language and on other aspects of the GNU linker.
213 @end ifset
214
215 @ifclear SingleFormat
216 This version of @command{ld} uses the general purpose BFD libraries
217 to operate on object files. This allows @command{ld} to read, combine, and
218 write object files in many different formats---for example, COFF or
219 @code{a.out}.  Different formats may be linked together to produce any
220 available kind of object file.  @xref{BFD}, for more information.
221 @end ifclear
222
223 Aside from its flexibility, the @sc{gnu} linker is more helpful than other
224 linkers in providing diagnostic information.  Many linkers abandon
225 execution immediately upon encountering an error; whenever possible,
226 @command{ld} continues executing, allowing you to identify other errors
227 (or, in some cases, to get an output file in spite of the error).
228
229 @c man end
230
231 @node Invocation
232 @chapter Invocation
233
234 @c man begin DESCRIPTION
235
236 The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations,
237 and to be as compatible as possible with other linkers.  As a result,
238 you have many choices to control its behavior.
239
240 @c man end
241
242 @ifset UsesEnvVars
243 @menu
244 * Options::                     Command Line Options
245 * Environment::                 Environment Variables
246 @end menu
247
248 @node Options
249 @section Command Line Options
250 @end ifset
251
252 @cindex command line
253 @cindex options
254
255 @c man begin OPTIONS
256
257 The linker supports a plethora of command-line options, but in actual
258 practice few of them are used in any particular context.
259 @cindex standard Unix system
260 For instance, a frequent use of @command{ld} is to link standard Unix
261 object files on a standard, supported Unix system.  On such a system, to
262 link a file @code{hello.o}:
263
264 @smallexample
265 ld -o @var{output} /lib/crt0.o hello.o -lc
266 @end smallexample
267
268 This tells @command{ld} to produce a file called @var{output} as the
269 result of linking the file @code{/lib/crt0.o} with @code{hello.o} and
270 the library @code{libc.a}, which will come from the standard search
271 directories.  (See the discussion of the @samp{-l} option below.)
272
273 Some of the command-line options to @command{ld} may be specified at any
274 point in the command line.  However, options which refer to files, such
275 as @samp{-l} or @samp{-T}, cause the file to be read at the point at
276 which the option appears in the command line, relative to the object
277 files and other file options.  Repeating non-file options with a
278 different argument will either have no further effect, or override prior
279 occurrences (those further to the left on the command line) of that
280 option.  Options which may be meaningfully specified more than once are
281 noted in the descriptions below.
282
283 @cindex object files
284 Non-option arguments are object files or archives which are to be linked
285 together.  They may follow, precede, or be mixed in with command-line
286 options, except that an object file argument may not be placed between
287 an option and its argument.
288
289 Usually the linker is invoked with at least one object file, but you can
290 specify other forms of binary input files using @samp{-l}, @samp{-R},
291 and the script command language.  If @emph{no} binary input files at all
292 are specified, the linker does not produce any output, and issues the
293 message @samp{No input files}.
294
295 If the linker cannot recognize the format of an object file, it will
296 assume that it is a linker script.  A script specified in this way
297 augments the main linker script used for the link (either the default
298 linker script or the one specified by using @samp{-T}).  This feature
299 permits the linker to link against a file which appears to be an object
300 or an archive, but actually merely defines some symbol values, or uses
301 @code{INPUT} or @code{GROUP} to load other objects.  Specifying a
302 script in this way merely augments the main linker script, with the
303 extra commands placed after the main script; use the @samp{-T} option
304 to replace the default linker script entirely, but note the effect of
305 the @code{INSERT} command.  @xref{Scripts}.
306
307 For options whose names are a single letter,
308 option arguments must either follow the option letter without intervening
309 whitespace, or be given as separate arguments immediately following the
310 option that requires them.
311
312 For options whose names are multiple letters, either one dash or two can
313 precede the option name; for example, @samp{-trace-symbol} and
314 @samp{--trace-symbol} are equivalent.  Note---there is one exception to
315 this rule.  Multiple letter options that start with a lower case 'o' can
316 only be preceded by two dashes.  This is to reduce confusion with the
317 @samp{-o} option.  So for example @samp{-omagic} sets the output file
318 name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the
319 output.
320
321 Arguments to multiple-letter options must either be separated from the
322 option name by an equals sign, or be given as separate arguments
323 immediately following the option that requires them.  For example,
324 @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent.
325 Unique abbreviations of the names of multiple-letter options are
326 accepted.
327
328 Note---if the linker is being invoked indirectly, via a compiler driver
329 (e.g. @samp{gcc}) then all the linker command line options should be
330 prefixed by @samp{-Wl,} (or whatever is appropriate for the particular
331 compiler driver) like this:
332
333 @smallexample
334   gcc -Wl,--start-group foo.o bar.o -Wl,--end-group
335 @end smallexample
336
337 This is important, because otherwise the compiler driver program may
338 silently drop the linker options, resulting in a bad link.  Confusion
339 may also arise when passing options that require values through a
340 driver, as the use of a space between option and argument acts as
341 a separator, and causes the driver to pass only the option to the linker
342 and the argument to the compiler.  In this case, it is simplest to use
343 the joined forms of both single- and multiple-letter options, such as:
344
345 @smallexample
346   gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map
347 @end smallexample
348
349 Here is a table of the generic command line switches accepted by the GNU
350 linker:
351
352 @table @gcctabopt
353 @include at-file.texi
354
355 @kindex -a @var{keyword}
356 @item -a @var{keyword}
357 This option is supported for HP/UX compatibility.  The @var{keyword}
358 argument must be one of the strings @samp{archive}, @samp{shared}, or
359 @samp{default}.  @samp{-aarchive} is functionally equivalent to
360 @samp{-Bstatic}, and the other two keywords are functionally equivalent
361 to @samp{-Bdynamic}.  This option may be used any number of times.
362
363 @kindex --audit @var{AUDITLIB}
364 @item --audit @var{AUDITLIB}
365 Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section.
366 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
367 specified in the library.  If specified multiple times @code{DT_AUDIT}
368 will contain a colon separated list of audit interfaces to use. If the linker
369 finds an object with an audit entry while searching for shared libraries,
370 it will add a corresponding @code{DT_DEPAUDIT} entry in the output file.
371 This option is only meaningful on ELF platforms supporting the rtld-audit
372 interface.
373
374 @ifset I960
375 @cindex architectures
376 @kindex -A @var{arch}
377 @item -A @var{architecture}
378 @kindex --architecture=@var{arch}
379 @itemx --architecture=@var{architecture}
380 In the current release of @command{ld}, this option is useful only for the
381 Intel 960 family of architectures.  In that @command{ld} configuration, the
382 @var{architecture} argument identifies the particular architecture in
383 the 960 family, enabling some safeguards and modifying the
384 archive-library search path.  @xref{i960,,@command{ld} and the Intel 960
385 family}, for details.
386
387 Future releases of @command{ld} may support similar functionality for
388 other architecture families.
389 @end ifset
390
391 @ifclear SingleFormat
392 @cindex binary input format
393 @kindex -b @var{format}
394 @kindex --format=@var{format}
395 @cindex input format
396 @cindex input format
397 @item -b @var{input-format}
398 @itemx --format=@var{input-format}
399 @command{ld} may be configured to support more than one kind of object
400 file.  If your @command{ld} is configured this way, you can use the
401 @samp{-b} option to specify the binary format for input object files
402 that follow this option on the command line.  Even when @command{ld} is
403 configured to support alternative object formats, you don't usually need
404 to specify this, as @command{ld} should be configured to expect as a
405 default input format the most usual format on each machine.
406 @var{input-format} is a text string, the name of a particular format
407 supported by the BFD libraries.  (You can list the available binary
408 formats with @samp{objdump -i}.)
409 @xref{BFD}.
410
411 You may want to use this option if you are linking files with an unusual
412 binary format.  You can also use @samp{-b} to switch formats explicitly (when
413 linking object files of different formats), by including
414 @samp{-b @var{input-format}} before each group of object files in a
415 particular format.
416
417 The default format is taken from the environment variable
418 @code{GNUTARGET}.
419 @ifset UsesEnvVars
420 @xref{Environment}.
421 @end ifset
422 You can also define the input format from a script, using the command
423 @code{TARGET};
424 @ifclear man
425 see @ref{Format Commands}.
426 @end ifclear
427 @end ifclear
428
429 @kindex -c @var{MRI-cmdfile}
430 @kindex --mri-script=@var{MRI-cmdfile}
431 @cindex compatibility, MRI
432 @item -c @var{MRI-commandfile}
433 @itemx --mri-script=@var{MRI-commandfile}
434 For compatibility with linkers produced by MRI, @command{ld} accepts script
435 files written in an alternate, restricted command language, described in
436 @ifclear man
437 @ref{MRI,,MRI Compatible Script Files}.
438 @end ifclear
439 @ifset man
440 the MRI Compatible Script Files section of GNU ld documentation.
441 @end ifset
442 Introduce MRI script files with
443 the option @samp{-c}; use the @samp{-T} option to run linker
444 scripts written in the general-purpose @command{ld} scripting language.
445 If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories
446 specified by any @samp{-L} options.
447
448 @cindex common allocation
449 @kindex -d
450 @kindex -dc
451 @kindex -dp
452 @item -d
453 @itemx -dc
454 @itemx -dp
455 These three options are equivalent; multiple forms are supported for
456 compatibility with other linkers.  They assign space to common symbols
457 even if a relocatable output file is specified (with @samp{-r}).  The
458 script command @code{FORCE_COMMON_ALLOCATION} has the same effect.
459 @xref{Miscellaneous Commands}.
460
461 @kindex --depaudit @var{AUDITLIB}
462 @kindex -P @var{AUDITLIB}
463 @item --depaudit @var{AUDITLIB}
464 @itemx -P @var{AUDITLIB}
465 Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section.
466 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
467 specified in the library.  If specified multiple times @code{DT_DEPAUDIT}
468 will contain a colon separated list of audit interfaces to use.  This
469 option is only meaningful on ELF platforms supporting the rtld-audit interface.
470 The -P option is provided for Solaris compatibility.
471
472 @cindex entry point, from command line
473 @kindex -e @var{entry}
474 @kindex --entry=@var{entry}
475 @item -e @var{entry}
476 @itemx --entry=@var{entry}
477 Use @var{entry} as the explicit symbol for beginning execution of your
478 program, rather than the default entry point.  If there is no symbol
479 named @var{entry}, the linker will try to parse @var{entry} as a number,
480 and use that as the entry address (the number will be interpreted in
481 base 10; you may use a leading @samp{0x} for base 16, or a leading
482 @samp{0} for base 8).  @xref{Entry Point}, for a discussion of defaults
483 and other ways of specifying the entry point.
484
485 @kindex --exclude-libs
486 @item --exclude-libs @var{lib},@var{lib},...
487 Specifies a list of archive libraries from which symbols should not be automatically
488 exported.  The library names may be delimited by commas or colons.  Specifying
489 @code{--exclude-libs ALL} excludes symbols in all archive libraries from
490 automatic export.  This option is available only for the i386 PE targeted
491 port of the linker and for ELF targeted ports.  For i386 PE, symbols
492 explicitly listed in a .def file are still exported, regardless of this
493 option.  For ELF targeted ports, symbols affected by this option will
494 be treated as hidden.
495
496 @kindex --exclude-modules-for-implib
497 @item --exclude-modules-for-implib @var{module},@var{module},...
498 Specifies a list of object files or archive members, from which symbols
499 should not be automatically exported, but which should be copied wholesale
500 into the import library being generated during the link.  The module names
501 may be delimited by commas or colons, and must match exactly the filenames
502 used by @command{ld} to open the files; for archive members, this is simply
503 the member name, but for object files the name listed must include and
504 match precisely any path used to specify the input file on the linker's
505 command-line.  This option is available only for the i386 PE targeted port
506 of the linker.  Symbols explicitly listed in a .def file are still exported,
507 regardless of this option.
508
509 @cindex dynamic symbol table
510 @kindex -E
511 @kindex --export-dynamic
512 @kindex --no-export-dynamic
513 @item -E
514 @itemx --export-dynamic
515 @itemx --no-export-dynamic
516 When creating a dynamically linked executable, using the @option{-E}
517 option or the @option{--export-dynamic} option causes the linker to add
518 all symbols to the dynamic symbol table.  The dynamic symbol table is the
519 set of symbols which are visible from dynamic objects at run time.
520
521 If you do not use either of these options (or use the
522 @option{--no-export-dynamic} option to restore the default behavior), the
523 dynamic symbol table will normally contain only those symbols which are
524 referenced by some dynamic object mentioned in the link.
525
526 If you use @code{dlopen} to load a dynamic object which needs to refer
527 back to the symbols defined by the program, rather than some other
528 dynamic object, then you will probably need to use this option when
529 linking the program itself.
530
531 You can also use the dynamic list to control what symbols should
532 be added to the dynamic symbol table if the output format supports it.
533 See the description of @samp{--dynamic-list}.
534
535 Note that this option is specific to ELF targeted ports.  PE targets
536 support a similar function to export all symbols from a DLL or EXE; see
537 the description of @samp{--export-all-symbols} below.
538
539 @ifclear SingleFormat
540 @cindex big-endian objects
541 @cindex endianness
542 @kindex -EB
543 @item -EB
544 Link big-endian objects.  This affects the default output format.
545
546 @cindex little-endian objects
547 @kindex -EL
548 @item -EL
549 Link little-endian objects.  This affects the default output format.
550 @end ifclear
551
552 @kindex -f @var{name}
553 @kindex --auxiliary=@var{name}
554 @item -f @var{name}
555 @itemx --auxiliary=@var{name}
556 When creating an ELF shared object, set the internal DT_AUXILIARY field
557 to the specified name.  This tells the dynamic linker that the symbol
558 table of the shared object should be used as an auxiliary filter on the
559 symbol table of the shared object @var{name}.
560
561 If you later link a program against this filter object, then, when you
562 run the program, the dynamic linker will see the DT_AUXILIARY field.  If
563 the dynamic linker resolves any symbols from the filter object, it will
564 first check whether there is a definition in the shared object
565 @var{name}.  If there is one, it will be used instead of the definition
566 in the filter object.  The shared object @var{name} need not exist.
567 Thus the shared object @var{name} may be used to provide an alternative
568 implementation of certain functions, perhaps for debugging or for
569 machine specific performance.
570
571 This option may be specified more than once.  The DT_AUXILIARY entries
572 will be created in the order in which they appear on the command line.
573
574 @kindex -F @var{name}
575 @kindex --filter=@var{name}
576 @item -F @var{name}
577 @itemx --filter=@var{name}
578 When creating an ELF shared object, set the internal DT_FILTER field to
579 the specified name.  This tells the dynamic linker that the symbol table
580 of the shared object which is being created should be used as a filter
581 on the symbol table of the shared object @var{name}.
582
583 If you later link a program against this filter object, then, when you
584 run the program, the dynamic linker will see the DT_FILTER field.  The
585 dynamic linker will resolve symbols according to the symbol table of the
586 filter object as usual, but it will actually link to the definitions
587 found in the shared object @var{name}.  Thus the filter object can be
588 used to select a subset of the symbols provided by the object
589 @var{name}.
590
591 Some older linkers used the @option{-F} option throughout a compilation
592 toolchain for specifying object-file format for both input and output
593 object files.
594 @ifclear SingleFormat
595 The @sc{gnu} linker uses other mechanisms for this purpose: the
596 @option{-b}, @option{--format}, @option{--oformat} options, the
597 @code{TARGET} command in linker scripts, and the @code{GNUTARGET}
598 environment variable.
599 @end ifclear
600 The @sc{gnu} linker will ignore the @option{-F} option when not
601 creating an ELF shared object.
602
603 @cindex finalization function
604 @kindex -fini=@var{name}
605 @item -fini=@var{name}
606 When creating an ELF executable or shared object, call NAME when the
607 executable or shared object is unloaded, by setting DT_FINI to the
608 address of the function.  By default, the linker uses @code{_fini} as
609 the function to call.
610
611 @kindex -g
612 @item -g
613 Ignored.  Provided for compatibility with other tools.
614
615 @kindex -G @var{value}
616 @kindex --gpsize=@var{value}
617 @cindex object size
618 @item -G @var{value}
619 @itemx --gpsize=@var{value}
620 Set the maximum size of objects to be optimized using the GP register to
621 @var{size}.  This is only meaningful for object file formats such as
622 MIPS ECOFF which supports putting large and small objects into different
623 sections.  This is ignored for other object file formats.
624
625 @cindex runtime library name
626 @kindex -h @var{name}
627 @kindex -soname=@var{name}
628 @item -h @var{name}
629 @itemx -soname=@var{name}
630 When creating an ELF shared object, set the internal DT_SONAME field to
631 the specified name.  When an executable is linked with a shared object
632 which has a DT_SONAME field, then when the executable is run the dynamic
633 linker will attempt to load the shared object specified by the DT_SONAME
634 field rather than the using the file name given to the linker.
635
636 @kindex -i
637 @cindex incremental link
638 @item -i
639 Perform an incremental link (same as option @samp{-r}).
640
641 @cindex initialization function
642 @kindex -init=@var{name}
643 @item -init=@var{name}
644 When creating an ELF executable or shared object, call NAME when the
645 executable or shared object is loaded, by setting DT_INIT to the address
646 of the function.  By default, the linker uses @code{_init} as the
647 function to call.
648
649 @cindex archive files, from cmd line
650 @kindex -l @var{namespec}
651 @kindex --library=@var{namespec}
652 @item -l @var{namespec}
653 @itemx --library=@var{namespec}
654 Add the archive or object file specified by @var{namespec} to the
655 list of files to link.  This option may be used any number of times.
656 If @var{namespec} is of the form @file{:@var{filename}}, @command{ld}
657 will search the library path for a file called @var{filename}, otherwise it
658 will search the library path for a file called @file{lib@var{namespec}.a}.
659
660 On systems which support shared libraries, @command{ld} may also search for
661 files other than @file{lib@var{namespec}.a}.  Specifically, on ELF
662 and SunOS systems, @command{ld} will search a directory for a library
663 called @file{lib@var{namespec}.so} before searching for one called
664 @file{lib@var{namespec}.a}.  (By convention, a @code{.so} extension
665 indicates a shared library.)  Note that this behavior does not apply
666 to @file{:@var{filename}}, which always specifies a file called
667 @var{filename}.
668
669 The linker will search an archive only once, at the location where it is
670 specified on the command line.  If the archive defines a symbol which
671 was undefined in some object which appeared before the archive on the
672 command line, the linker will include the appropriate file(s) from the
673 archive.  However, an undefined symbol in an object appearing later on
674 the command line will not cause the linker to search the archive again.
675
676 See the @option{-(} option for a way to force the linker to search
677 archives multiple times.
678
679 You may list the same archive multiple times on the command line.
680
681 @ifset GENERIC
682 This type of archive searching is standard for Unix linkers.  However,
683 if you are using @command{ld} on AIX, note that it is different from the
684 behaviour of the AIX linker.
685 @end ifset
686
687 @cindex search directory, from cmd line
688 @kindex -L @var{dir}
689 @kindex --library-path=@var{dir}
690 @item -L @var{searchdir}
691 @itemx --library-path=@var{searchdir}
692 Add path @var{searchdir} to the list of paths that @command{ld} will search
693 for archive libraries and @command{ld} control scripts.  You may use this
694 option any number of times.  The directories are searched in the order
695 in which they are specified on the command line.  Directories specified
696 on the command line are searched before the default directories.  All
697 @option{-L} options apply to all @option{-l} options, regardless of the
698 order in which the options appear.  @option{-L} options do not affect
699 how @command{ld} searches for a linker script unless @option{-T}
700 option is specified.
701
702 If @var{searchdir} begins with @code{=}, then the @code{=} will be replaced
703 by the @dfn{sysroot prefix}, a path specified when the linker is configured.
704
705 @ifset UsesEnvVars
706 The default set of paths searched (without being specified with
707 @samp{-L}) depends on which emulation mode @command{ld} is using, and in
708 some cases also on how it was configured.  @xref{Environment}.
709 @end ifset
710
711 The paths can also be specified in a link script with the
712 @code{SEARCH_DIR} command.  Directories specified this way are searched
713 at the point in which the linker script appears in the command line.
714
715 @cindex emulation
716 @kindex -m @var{emulation}
717 @item -m @var{emulation}
718 Emulate the @var{emulation} linker.  You can list the available
719 emulations with the @samp{--verbose} or @samp{-V} options.
720
721 If the @samp{-m} option is not used, the emulation is taken from the
722 @code{LDEMULATION} environment variable, if that is defined.
723
724 Otherwise, the default emulation depends upon how the linker was
725 configured.
726
727 @cindex link map
728 @kindex -M
729 @kindex --print-map
730 @item -M
731 @itemx --print-map
732 Print a link map to the standard output.  A link map provides
733 information about the link, including the following:
734
735 @itemize @bullet
736 @item
737 Where object files are mapped into memory.
738 @item
739 How common symbols are allocated.
740 @item
741 All archive members included in the link, with a mention of the symbol
742 which caused the archive member to be brought in.
743 @item
744 The values assigned to symbols.
745
746 Note - symbols whose values are computed by an expression which
747 involves a reference to a previous value of the same symbol may not
748 have correct result displayed in the link map.  This is because the
749 linker discards intermediate results and only retains the final value
750 of an expression.  Under such circumstances the linker will display
751 the final value enclosed by square brackets.  Thus for example a
752 linker script containing:
753
754 @smallexample
755    foo = 1
756    foo = foo * 4
757    foo = foo + 8
758 @end smallexample
759
760 will produce the following output in the link map if the @option{-M}
761 option is used:
762
763 @smallexample
764    0x00000001                foo = 0x1
765    [0x0000000c]                foo = (foo * 0x4)
766    [0x0000000c]                foo = (foo + 0x8)
767 @end smallexample
768
769 See @ref{Expressions} for more information about expressions in linker
770 scripts.
771 @end itemize
772
773 @kindex -n
774 @cindex read-only text
775 @cindex NMAGIC
776 @kindex --nmagic
777 @item -n
778 @itemx --nmagic
779 Turn off page alignment of sections, and disable linking against shared
780 libraries.  If the output format supports Unix style magic numbers,
781 mark the output as @code{NMAGIC}.
782
783 @kindex -N
784 @kindex --omagic
785 @cindex read/write from cmd line
786 @cindex OMAGIC
787 @item -N
788 @itemx --omagic
789 Set the text and data sections to be readable and writable.  Also, do
790 not page-align the data segment, and disable linking against shared
791 libraries.  If the output format supports Unix style magic numbers,
792 mark the output as @code{OMAGIC}. Note: Although a writable text section
793 is allowed for PE-COFF targets, it does not conform to the format
794 specification published by Microsoft.
795
796 @kindex --no-omagic
797 @cindex OMAGIC
798 @item --no-omagic
799 This option negates most of the effects of the @option{-N} option.  It
800 sets the text section to be read-only, and forces the data segment to
801 be page-aligned.  Note - this option does not enable linking against
802 shared libraries.  Use @option{-Bdynamic} for this.
803
804 @kindex -o @var{output}
805 @kindex --output=@var{output}
806 @cindex naming the output file
807 @item -o @var{output}
808 @itemx --output=@var{output}
809 Use @var{output} as the name for the program produced by @command{ld}; if this
810 option is not specified, the name @file{a.out} is used by default.  The
811 script command @code{OUTPUT} can also specify the output file name.
812
813 @kindex -O @var{level}
814 @cindex generating optimized output
815 @item -O @var{level}
816 If @var{level} is a numeric values greater than zero @command{ld} optimizes
817 the output.  This might take significantly longer and therefore probably
818 should only be enabled for the final binary.  At the moment this
819 option only affects ELF shared library generation.  Future releases of
820 the linker may make more use of this option.  Also currently there is
821 no difference in the linker's behaviour for different non-zero values
822 of this option.  Again this may change with future releases.
823
824 @kindex -q
825 @kindex --emit-relocs
826 @cindex retain relocations in final executable
827 @item -q
828 @itemx --emit-relocs
829 Leave relocation sections and contents in fully linked executables.
830 Post link analysis and optimization tools may need this information in
831 order to perform correct modifications of executables.  This results
832 in larger executables.
833
834 This option is currently only supported on ELF platforms.
835
836 @kindex --force-dynamic
837 @cindex forcing the creation of dynamic sections
838 @item --force-dynamic
839 Force the output file to have dynamic sections.  This option is specific
840 to VxWorks targets.
841
842 @cindex partial link
843 @cindex relocatable output
844 @kindex -r
845 @kindex --relocatable
846 @item -r
847 @itemx --relocatable
848 Generate relocatable output---i.e., generate an output file that can in
849 turn serve as input to @command{ld}.  This is often called @dfn{partial
850 linking}.  As a side effect, in environments that support standard Unix
851 magic numbers, this option also sets the output file's magic number to
852 @code{OMAGIC}.
853 @c ; see @option{-N}.
854 If this option is not specified, an absolute file is produced.  When
855 linking C++ programs, this option @emph{will not} resolve references to
856 constructors; to do that, use @samp{-Ur}.
857
858 When an input file does not have the same format as the output file,
859 partial linking is only supported if that input file does not contain any
860 relocations.  Different output formats can have further restrictions; for
861 example some @code{a.out}-based formats do not support partial linking
862 with input files in other formats at all.
863
864 This option does the same thing as @samp{-i}.
865
866 @kindex -R @var{file}
867 @kindex --just-symbols=@var{file}
868 @cindex symbol-only input
869 @item -R @var{filename}
870 @itemx --just-symbols=@var{filename}
871 Read symbol names and their addresses from @var{filename}, but do not
872 relocate it or include it in the output.  This allows your output file
873 to refer symbolically to absolute locations of memory defined in other
874 programs.  You may use this option more than once.
875
876 For compatibility with other ELF linkers, if the @option{-R} option is
877 followed by a directory name, rather than a file name, it is treated as
878 the @option{-rpath} option.
879
880 @kindex -s
881 @kindex --strip-all
882 @cindex strip all symbols
883 @item -s
884 @itemx --strip-all
885 Omit all symbol information from the output file.
886
887 @kindex -S
888 @kindex --strip-debug
889 @cindex strip debugger symbols
890 @item -S
891 @itemx --strip-debug
892 Omit debugger symbol information (but not all symbols) from the output file.
893
894 @kindex -t
895 @kindex --trace
896 @cindex input files, displaying
897 @item -t
898 @itemx --trace
899 Print the names of the input files as @command{ld} processes them.
900
901 @kindex -T @var{script}
902 @kindex --script=@var{script}
903 @cindex script files
904 @item -T @var{scriptfile}
905 @itemx --script=@var{scriptfile}
906 Use @var{scriptfile} as the linker script.  This script replaces
907 @command{ld}'s default linker script (rather than adding to it), so
908 @var{commandfile} must specify everything necessary to describe the
909 output file.  @xref{Scripts}.  If @var{scriptfile} does not exist in
910 the current directory, @code{ld} looks for it in the directories
911 specified by any preceding @samp{-L} options.  Multiple @samp{-T}
912 options accumulate.
913
914 @kindex -dT @var{script}
915 @kindex --default-script=@var{script}
916 @cindex script files
917 @item -dT @var{scriptfile}
918 @itemx --default-script=@var{scriptfile}
919 Use @var{scriptfile} as the default linker script.  @xref{Scripts}.
920
921 This option is similar to the @option{--script} option except that
922 processing of the script is delayed until after the rest of the
923 command line has been processed.  This allows options placed after the
924 @option{--default-script} option on the command line to affect the
925 behaviour of the linker script, which can be important when the linker
926 command line cannot be directly controlled by the user.  (eg because
927 the command line is being constructed by another tool, such as
928 @samp{gcc}).
929
930 @kindex -u @var{symbol}
931 @kindex --undefined=@var{symbol}
932 @cindex undefined symbol
933 @item -u @var{symbol}
934 @itemx --undefined=@var{symbol}
935 Force @var{symbol} to be entered in the output file as an undefined
936 symbol.  Doing this may, for example, trigger linking of additional
937 modules from standard libraries.  @samp{-u} may be repeated with
938 different option arguments to enter additional undefined symbols.  This
939 option is equivalent to the @code{EXTERN} linker script command.
940
941 @kindex -Ur
942 @cindex constructors
943 @item -Ur
944 For anything other than C++ programs, this option is equivalent to
945 @samp{-r}: it generates relocatable output---i.e., an output file that can in
946 turn serve as input to @command{ld}.  When linking C++ programs, @samp{-Ur}
947 @emph{does} resolve references to constructors, unlike @samp{-r}.
948 It does not work to use @samp{-Ur} on files that were themselves linked
949 with @samp{-Ur}; once the constructor table has been built, it cannot
950 be added to.  Use @samp{-Ur} only for the last partial link, and
951 @samp{-r} for the others.
952
953 @kindex --unique[=@var{SECTION}]
954 @item --unique[=@var{SECTION}]
955 Creates a separate output section for every input section matching
956 @var{SECTION}, or if the optional wildcard @var{SECTION} argument is
957 missing, for every orphan input section.  An orphan section is one not
958 specifically mentioned in a linker script.  You may use this option
959 multiple times on the command line;  It prevents the normal merging of
960 input sections with the same name, overriding output section assignments
961 in a linker script.
962
963 @kindex -v
964 @kindex -V
965 @kindex --version
966 @cindex version
967 @item -v
968 @itemx --version
969 @itemx -V
970 Display the version number for @command{ld}.  The @option{-V} option also
971 lists the supported emulations.
972
973 @kindex -x
974 @kindex --discard-all
975 @cindex deleting local symbols
976 @item -x
977 @itemx --discard-all
978 Delete all local symbols.
979
980 @kindex -X
981 @kindex --discard-locals
982 @cindex local symbols, deleting
983 @item -X
984 @itemx --discard-locals
985 Delete all temporary local symbols.  (These symbols start with
986 system-specific local label prefixes, typically @samp{.L} for ELF systems
987 or @samp{L} for traditional a.out systems.)
988
989 @kindex -y @var{symbol}
990 @kindex --trace-symbol=@var{symbol}
991 @cindex symbol tracing
992 @item -y @var{symbol}
993 @itemx --trace-symbol=@var{symbol}
994 Print the name of each linked file in which @var{symbol} appears.  This
995 option may be given any number of times.  On many systems it is necessary
996 to prepend an underscore.
997
998 This option is useful when you have an undefined symbol in your link but
999 don't know where the reference is coming from.
1000
1001 @kindex -Y @var{path}
1002 @item -Y @var{path}
1003 Add @var{path} to the default library search path.  This option exists
1004 for Solaris compatibility.
1005
1006 @kindex -z @var{keyword}
1007 @item -z @var{keyword}
1008 The recognized keywords are:
1009 @table @samp
1010
1011 @item combreloc
1012 Combines multiple reloc sections and sorts them to make dynamic symbol
1013 lookup caching possible.
1014
1015 @item defs
1016 Disallows undefined symbols in object files.  Undefined symbols in
1017 shared libraries are still allowed.
1018
1019 @item execstack
1020 Marks the object as requiring executable stack.
1021
1022 @item global
1023 This option is only meaningful when building a shared object.  It makes
1024 the symbols defined by this shared object available for symbol resolution
1025 of subsequently loaded libraries.
1026
1027 @item initfirst
1028 This option is only meaningful when building a shared object.
1029 It marks the object so that its runtime initialization will occur
1030 before the runtime initialization of any other objects brought into
1031 the process at the same time.  Similarly the runtime finalization of
1032 the object will occur after the runtime finalization of any other
1033 objects.
1034
1035 @item interpose
1036 Marks the object that its symbol table interposes before all symbols
1037 but the primary executable.
1038
1039 @item lazy
1040 When generating an executable or shared library, mark it to tell the
1041 dynamic linker to defer function call resolution to the point when
1042 the function is called (lazy binding), rather than at load time.
1043 Lazy binding is the default.
1044
1045 @item loadfltr
1046 Marks  the object that its filters be processed immediately at
1047 runtime.
1048
1049 @item muldefs
1050 Allows multiple definitions.
1051
1052 @item nocombreloc
1053 Disables multiple reloc sections combining.
1054
1055 @item nocopyreloc
1056 Disables production of copy relocs.
1057
1058 @item nodefaultlib
1059 Marks the object that the search for dependencies of this object will
1060 ignore any default library search paths.
1061
1062 @item nodelete
1063 Marks the object shouldn't be unloaded at runtime.
1064
1065 @item nodlopen
1066 Marks the object not available to @code{dlopen}.
1067
1068 @item nodump
1069 Marks the object can not be dumped by @code{dldump}.
1070
1071 @item noexecstack
1072 Marks the object as not requiring executable stack.
1073
1074 @item norelro
1075 Don't create an ELF @code{PT_GNU_RELRO} segment header in the object.
1076
1077 @item now
1078 When generating an executable or shared library, mark it to tell the
1079 dynamic linker to resolve all symbols when the program is started, or
1080 when the shared library is linked to using dlopen, instead of
1081 deferring function call resolution to the point when the function is
1082 first called.
1083
1084 @item origin
1085 Marks the object may contain $ORIGIN.
1086
1087 @item relro
1088 Create an ELF @code{PT_GNU_RELRO} segment header in the object.
1089
1090 @item max-page-size=@var{value}
1091 Set the emulation maximum page size to @var{value}.
1092
1093 @item common-page-size=@var{value}
1094 Set the emulation common page size to @var{value}.
1095
1096 @item stack-size=@var{value}
1097 Specify a stack size for in an ELF @code{PT_GNU_STACK} segment.
1098 Specifying zero will override any default non-zero sized
1099 @code{PT_GNU_STACK} segment creation.
1100
1101 @end table
1102
1103 Other keywords are ignored for Solaris compatibility.
1104
1105 @kindex -(
1106 @cindex groups of archives
1107 @item -( @var{archives} -)
1108 @itemx --start-group @var{archives} --end-group
1109 The @var{archives} should be a list of archive files.  They may be
1110 either explicit file names, or @samp{-l} options.
1111
1112 The specified archives are searched repeatedly until no new undefined
1113 references are created.  Normally, an archive is searched only once in
1114 the order that it is specified on the command line.  If a symbol in that
1115 archive is needed to resolve an undefined symbol referred to by an
1116 object in an archive that appears later on the command line, the linker
1117 would not be able to resolve that reference.  By grouping the archives,
1118 they all be searched repeatedly until all possible references are
1119 resolved.
1120
1121 Using this option has a significant performance cost.  It is best to use
1122 it only when there are unavoidable circular references between two or
1123 more archives.
1124
1125 @kindex --accept-unknown-input-arch
1126 @kindex --no-accept-unknown-input-arch
1127 @item --accept-unknown-input-arch
1128 @itemx --no-accept-unknown-input-arch
1129 Tells the linker to accept input files whose architecture cannot be
1130 recognised.  The assumption is that the user knows what they are doing
1131 and deliberately wants to link in these unknown input files.  This was
1132 the default behaviour of the linker, before release 2.14.  The default
1133 behaviour from release 2.14 onwards is to reject such input files, and
1134 so the @samp{--accept-unknown-input-arch} option has been added to
1135 restore the old behaviour.
1136
1137 @kindex --as-needed
1138 @kindex --no-as-needed
1139 @item --as-needed
1140 @itemx --no-as-needed
1141 This option affects ELF DT_NEEDED tags for dynamic libraries mentioned
1142 on the command line after the @option{--as-needed} option.  Normally
1143 the linker will add a DT_NEEDED tag for each dynamic library mentioned
1144 on the command line, regardless of whether the library is actually
1145 needed or not.  @option{--as-needed} causes a DT_NEEDED tag to only be
1146 emitted for a library that @emph{at that point in the link} satisfies a
1147 non-weak undefined symbol reference from a regular object file or, if
1148 the library is not found in the DT_NEEDED lists of other libraries, a
1149 non-weak undefined symbol reference from another dynamic library.
1150 Object files or libraries appearing on the command line @emph{after}
1151 the library in question do not affect whether the library is seen as
1152 needed.  This is similar to the rules for extraction of object files
1153 from archives.  @option{--no-as-needed} restores the default behaviour.
1154
1155 @kindex --add-needed
1156 @kindex --no-add-needed
1157 @item --add-needed
1158 @itemx --no-add-needed
1159 These two options have been deprecated because of the similarity of
1160 their names to the @option{--as-needed} and @option{--no-as-needed}
1161 options.  They have been replaced by @option{--copy-dt-needed-entries}
1162 and @option{--no-copy-dt-needed-entries}.
1163
1164 @kindex -assert @var{keyword}
1165 @item -assert @var{keyword}
1166 This option is ignored for SunOS compatibility.
1167
1168 @kindex -Bdynamic
1169 @kindex -dy
1170 @kindex -call_shared
1171 @item -Bdynamic
1172 @itemx -dy
1173 @itemx -call_shared
1174 Link against dynamic libraries.  This is only meaningful on platforms
1175 for which shared libraries are supported.  This option is normally the
1176 default on such platforms.  The different variants of this option are
1177 for compatibility with various systems.  You may use this option
1178 multiple times on the command line: it affects library searching for
1179 @option{-l} options which follow it.
1180
1181 @kindex -Bgroup
1182 @item -Bgroup
1183 Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic
1184 section.  This causes the runtime linker to handle lookups in this
1185 object and its dependencies to be performed only inside the group.
1186 @option{--unresolved-symbols=report-all} is implied.  This option is
1187 only meaningful on ELF platforms which support shared libraries.
1188
1189 @kindex -Bstatic
1190 @kindex -dn
1191 @kindex -non_shared
1192 @kindex -static
1193 @item -Bstatic
1194 @itemx -dn
1195 @itemx -non_shared
1196 @itemx -static
1197 Do not link against shared libraries.  This is only meaningful on
1198 platforms for which shared libraries are supported.  The different
1199 variants of this option are for compatibility with various systems.  You
1200 may use this option multiple times on the command line: it affects
1201 library searching for @option{-l} options which follow it.  This
1202 option also implies @option{--unresolved-symbols=report-all}.  This
1203 option can be used with @option{-shared}.  Doing so means that a
1204 shared library is being created but that all of the library's external
1205 references must be resolved by pulling in entries from static
1206 libraries.
1207
1208 @kindex -Bsymbolic
1209 @item -Bsymbolic
1210 When creating a shared library, bind references to global symbols to the
1211 definition within the shared library, if any.  Normally, it is possible
1212 for a program linked against a shared library to override the definition
1213 within the shared library.  This option is only meaningful on ELF
1214 platforms which support shared libraries.
1215
1216 @kindex -Bsymbolic-functions
1217 @item -Bsymbolic-functions
1218 When creating a shared library, bind references to global function
1219 symbols to the definition within the shared library, if any.
1220 This option is only meaningful on ELF platforms which support shared
1221 libraries.
1222
1223 @kindex --dynamic-list=@var{dynamic-list-file}
1224 @item --dynamic-list=@var{dynamic-list-file}
1225 Specify the name of a dynamic list file to the linker.  This is
1226 typically used when creating shared libraries to specify a list of
1227 global symbols whose references shouldn't be bound to the definition
1228 within the shared library, or creating dynamically linked executables
1229 to specify a list of symbols which should be added to the symbol table
1230 in the executable.  This option is only meaningful on ELF platforms
1231 which support shared libraries.
1232
1233 The format of the dynamic list is the same as the version node without
1234 scope and node name.  See @ref{VERSION} for more information.
1235
1236 @kindex --dynamic-list-data
1237 @item --dynamic-list-data
1238 Include all global data symbols to the dynamic list.
1239
1240 @kindex --dynamic-list-cpp-new
1241 @item --dynamic-list-cpp-new
1242 Provide the builtin dynamic list for C++ operator new and delete.  It
1243 is mainly useful for building shared libstdc++.
1244
1245 @kindex --dynamic-list-cpp-typeinfo
1246 @item --dynamic-list-cpp-typeinfo
1247 Provide the builtin dynamic list for C++ runtime type identification.
1248
1249 @kindex --check-sections
1250 @kindex --no-check-sections
1251 @item --check-sections
1252 @itemx --no-check-sections
1253 Asks the linker @emph{not} to check section addresses after they have
1254 been assigned to see if there are any overlaps.  Normally the linker will
1255 perform this check, and if it finds any overlaps it will produce
1256 suitable error messages.  The linker does know about, and does make
1257 allowances for sections in overlays.  The default behaviour can be
1258 restored by using the command line switch @option{--check-sections}.
1259 Section overlap is not usually checked for relocatable links.  You can
1260 force checking in that case by using the @option{--check-sections}
1261 option.
1262
1263 @kindex --copy-dt-needed-entries
1264 @kindex --no-copy-dt-needed-entries
1265 @item --copy-dt-needed-entries
1266 @itemx --no-copy-dt-needed-entries
1267 This option affects the treatment of dynamic libraries referred to
1268 by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the
1269 command line.  Normally the linker won't add a DT_NEEDED tag to the
1270 output binary for each library mentioned in a DT_NEEDED tag in an
1271 input dynamic library.  With @option{--copy-dt-needed-entries}
1272 specified on the command line however any dynamic libraries that
1273 follow it will have their DT_NEEDED entries added.  The default
1274 behaviour can be restored with @option{--no-copy-dt-needed-entries}.
1275
1276 This option also has an effect on the resolution of symbols in dynamic
1277 libraries.  With @option{--copy-dt-needed-entries} dynamic libraries
1278 mentioned on the command line will be recursively searched, following
1279 their DT_NEEDED tags to other libraries, in order to resolve symbols
1280 required by the output binary.  With the default setting however
1281 the searching of dynamic libraries that follow it will stop with the
1282 dynamic library itself.  No DT_NEEDED links will be traversed to resolve
1283 symbols.
1284
1285 @cindex cross reference table
1286 @kindex --cref
1287 @item --cref
1288 Output a cross reference table.  If a linker map file is being
1289 generated, the cross reference table is printed to the map file.
1290 Otherwise, it is printed on the standard output.
1291
1292 The format of the table is intentionally simple, so that it may be
1293 easily processed by a script if necessary.  The symbols are printed out,
1294 sorted by name.  For each symbol, a list of file names is given.  If the
1295 symbol is defined, the first file listed is the location of the
1296 definition.  The remaining files contain references to the symbol.
1297
1298 @cindex common allocation
1299 @kindex --no-define-common
1300 @item --no-define-common
1301 This option inhibits the assignment of addresses to common symbols.
1302 The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect.
1303 @xref{Miscellaneous Commands}.
1304
1305 The @samp{--no-define-common} option allows decoupling
1306 the decision to assign addresses to Common symbols from the choice
1307 of the output file type; otherwise a non-Relocatable output type
1308 forces assigning addresses to Common symbols.
1309 Using @samp{--no-define-common} allows Common symbols that are referenced
1310 from a shared library to be assigned addresses only in the main program.
1311 This eliminates the unused duplicate space in the shared library,
1312 and also prevents any possible confusion over resolving to the wrong
1313 duplicate when there are many dynamic modules with specialized search
1314 paths for runtime symbol resolution.
1315
1316 @cindex symbols, from command line
1317 @kindex --defsym=@var{symbol}=@var{exp}
1318 @item --defsym=@var{symbol}=@var{expression}
1319 Create a global symbol in the output file, containing the absolute
1320 address given by @var{expression}.  You may use this option as many
1321 times as necessary to define multiple symbols in the command line.  A
1322 limited form of arithmetic is supported for the @var{expression} in this
1323 context: you may give a hexadecimal constant or the name of an existing
1324 symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
1325 constants or symbols.  If you need more elaborate expressions, consider
1326 using the linker command language from a script (@pxref{Assignments,,
1327 Assignment: Symbol Definitions}).  @emph{Note:} there should be no white
1328 space between @var{symbol}, the equals sign (``@key{=}''), and
1329 @var{expression}.
1330
1331 @cindex demangling, from command line
1332 @kindex --demangle[=@var{style}]
1333 @kindex --no-demangle
1334 @item --demangle[=@var{style}]
1335 @itemx --no-demangle
1336 These options control whether to demangle symbol names in error messages
1337 and other output.  When the linker is told to demangle, it tries to
1338 present symbol names in a readable fashion: it strips leading
1339 underscores if they are used by the object file format, and converts C++
1340 mangled symbol names into user readable names.  Different compilers have
1341 different mangling styles.  The optional demangling style argument can be used
1342 to choose an appropriate demangling style for your compiler.  The linker will
1343 demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE}
1344 is set.  These options may be used to override the default.
1345
1346 @cindex dynamic linker, from command line
1347 @kindex -I@var{file}
1348 @kindex --dynamic-linker=@var{file}
1349 @item -I@var{file}
1350 @itemx --dynamic-linker=@var{file}
1351 Set the name of the dynamic linker.  This is only meaningful when
1352 generating dynamically linked ELF executables.  The default dynamic
1353 linker is normally correct; don't use this unless you know what you are
1354 doing.
1355
1356 @kindex --fatal-warnings
1357 @kindex --no-fatal-warnings
1358 @item --fatal-warnings
1359 @itemx --no-fatal-warnings
1360 Treat all warnings as errors.  The default behaviour can be restored
1361 with the option @option{--no-fatal-warnings}.
1362
1363 @kindex --force-exe-suffix
1364 @item  --force-exe-suffix
1365 Make sure that an output file has a .exe suffix.
1366
1367 If a successfully built fully linked output file does not have a
1368 @code{.exe} or @code{.dll} suffix, this option forces the linker to copy
1369 the output file to one of the same name with a @code{.exe} suffix. This
1370 option is useful when using unmodified Unix makefiles on a Microsoft
1371 Windows host, since some versions of Windows won't run an image unless
1372 it ends in a @code{.exe} suffix.
1373
1374 @kindex --gc-sections
1375 @kindex --no-gc-sections
1376 @cindex garbage collection
1377 @item --gc-sections
1378 @itemx --no-gc-sections
1379 Enable garbage collection of unused input sections.  It is ignored on
1380 targets that do not support this option.  The default behaviour (of not
1381 performing this garbage collection) can be restored by specifying
1382 @samp{--no-gc-sections} on the command line.
1383
1384 @samp{--gc-sections} decides which input sections are used by
1385 examining symbols and relocations.  The section containing the entry
1386 symbol and all sections containing symbols undefined on the
1387 command-line will be kept, as will sections containing symbols
1388 referenced by dynamic objects.  Note that when building shared
1389 libraries, the linker must assume that any visible symbol is
1390 referenced.  Once this initial set of sections has been determined,
1391 the linker recursively marks as used any section referenced by their
1392 relocations.  See @samp{--entry} and @samp{--undefined}.
1393
1394 This option can be set when doing a partial link (enabled with option
1395 @samp{-r}).  In this case the root of symbols kept must be explicitly
1396 specified either by an @samp{--entry} or @samp{--undefined} option or by
1397 a @code{ENTRY} command in the linker script.
1398
1399 @kindex --print-gc-sections
1400 @kindex --no-print-gc-sections
1401 @cindex garbage collection
1402 @item --print-gc-sections
1403 @itemx --no-print-gc-sections
1404 List all sections removed by garbage collection.  The listing is
1405 printed on stderr.  This option is only effective if garbage
1406 collection has been enabled via the @samp{--gc-sections}) option.  The
1407 default behaviour (of not listing the sections that are removed) can
1408 be restored by specifying @samp{--no-print-gc-sections} on the command
1409 line.
1410
1411 @kindex --print-output-format
1412 @cindex output format
1413 @item --print-output-format
1414 Print the name of the default output format (perhaps influenced by
1415 other command-line options).  This is the string that would appear
1416 in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}).
1417
1418 @cindex help
1419 @cindex usage
1420 @kindex --help
1421 @item --help
1422 Print a summary of the command-line options on the standard output and exit.
1423
1424 @kindex --target-help
1425 @item --target-help
1426 Print a summary of all target specific options on the standard output and exit.
1427
1428 @kindex -Map=@var{mapfile}
1429 @item -Map=@var{mapfile}
1430 Print a link map to the file @var{mapfile}.  See the description of the
1431 @option{-M} option, above.
1432
1433 @cindex memory usage
1434 @kindex --no-keep-memory
1435 @item --no-keep-memory
1436 @command{ld} normally optimizes for speed over memory usage by caching the
1437 symbol tables of input files in memory.  This option tells @command{ld} to
1438 instead optimize for memory usage, by rereading the symbol tables as
1439 necessary.  This may be required if @command{ld} runs out of memory space
1440 while linking a large executable.
1441
1442 @kindex --no-undefined
1443 @kindex -z defs
1444 @item --no-undefined
1445 @itemx -z defs
1446 Report unresolved symbol references from regular object files.  This
1447 is done even if the linker is creating a non-symbolic shared library.
1448 The switch @option{--[no-]allow-shlib-undefined} controls the
1449 behaviour for reporting unresolved references found in shared
1450 libraries being linked in.
1451
1452 @kindex --allow-multiple-definition
1453 @kindex -z muldefs
1454 @item --allow-multiple-definition
1455 @itemx -z muldefs
1456 Normally when a symbol is defined multiple times, the linker will
1457 report a fatal error. These options allow multiple definitions and the
1458 first definition will be used.
1459
1460 @kindex --allow-shlib-undefined
1461 @kindex --no-allow-shlib-undefined
1462 @item --allow-shlib-undefined
1463 @itemx --no-allow-shlib-undefined
1464 Allows or disallows undefined symbols in shared libraries.
1465 This switch is similar to @option{--no-undefined} except that it
1466 determines the behaviour when the undefined symbols are in a
1467 shared library rather than a regular object file.  It does not affect
1468 how undefined symbols in regular object files are handled.
1469
1470 The default behaviour is to report errors for any undefined symbols
1471 referenced in shared libraries if the linker is being used to create
1472 an executable, but to allow them if the linker is being used to create
1473 a shared library.
1474
1475 The reasons for allowing undefined symbol references in shared
1476 libraries specified at link time are that:
1477
1478 @itemize @bullet
1479 @item
1480 A shared library specified at link time may not be the same as the one
1481 that is available at load time, so the symbol might actually be
1482 resolvable at load time.
1483 @item
1484 There are some operating systems, eg BeOS and HPPA, where undefined
1485 symbols in shared libraries are normal.
1486
1487 The BeOS kernel for example patches shared libraries at load time to
1488 select whichever function is most appropriate for the current
1489 architecture.  This is used, for example, to dynamically select an
1490 appropriate memset function.
1491 @end itemize
1492
1493 @kindex --no-undefined-version
1494 @item --no-undefined-version
1495 Normally when a symbol has an undefined version, the linker will ignore
1496 it. This option disallows symbols with undefined version and a fatal error
1497 will be issued instead.
1498
1499 @kindex --default-symver
1500 @item --default-symver
1501 Create and use a default symbol version (the soname) for unversioned
1502 exported symbols.
1503
1504 @kindex --default-imported-symver
1505 @item --default-imported-symver
1506 Create and use a default symbol version (the soname) for unversioned
1507 imported symbols.
1508
1509 @kindex --no-warn-mismatch
1510 @item --no-warn-mismatch
1511 Normally @command{ld} will give an error if you try to link together input
1512 files that are mismatched for some reason, perhaps because they have
1513 been compiled for different processors or for different endiannesses.
1514 This option tells @command{ld} that it should silently permit such possible
1515 errors.  This option should only be used with care, in cases when you
1516 have taken some special action that ensures that the linker errors are
1517 inappropriate.
1518
1519 @kindex --no-warn-search-mismatch
1520 @item --no-warn-search-mismatch
1521 Normally @command{ld} will give a warning if it finds an incompatible
1522 library during a library search.  This option silences the warning.
1523
1524 @kindex --no-whole-archive
1525 @item --no-whole-archive
1526 Turn off the effect of the @option{--whole-archive} option for subsequent
1527 archive files.
1528
1529 @cindex output file after errors
1530 @kindex --noinhibit-exec
1531 @item --noinhibit-exec
1532 Retain the executable output file whenever it is still usable.
1533 Normally, the linker will not produce an output file if it encounters
1534 errors during the link process; it exits without writing an output file
1535 when it issues any error whatsoever.
1536
1537 @kindex -nostdlib
1538 @item -nostdlib
1539 Only search library directories explicitly specified on the
1540 command line.  Library directories specified in linker scripts
1541 (including linker scripts specified on the command line) are ignored.
1542
1543 @ifclear SingleFormat
1544 @kindex --oformat=@var{output-format}
1545 @item --oformat=@var{output-format}
1546 @command{ld} may be configured to support more than one kind of object
1547 file.  If your @command{ld} is configured this way, you can use the
1548 @samp{--oformat} option to specify the binary format for the output
1549 object file.  Even when @command{ld} is configured to support alternative
1550 object formats, you don't usually need to specify this, as @command{ld}
1551 should be configured to produce as a default output format the most
1552 usual format on each machine.  @var{output-format} is a text string, the
1553 name of a particular format supported by the BFD libraries.  (You can
1554 list the available binary formats with @samp{objdump -i}.)  The script
1555 command @code{OUTPUT_FORMAT} can also specify the output format, but
1556 this option overrides it.  @xref{BFD}.
1557 @end ifclear
1558
1559 @kindex -pie
1560 @kindex --pic-executable
1561 @item -pie
1562 @itemx --pic-executable
1563 @cindex position independent executables
1564 Create a position independent executable.  This is currently only supported on
1565 ELF platforms.  Position independent executables are similar to shared
1566 libraries in that they are relocated by the dynamic linker to the virtual
1567 address the OS chooses for them (which can vary between invocations).  Like
1568 normal dynamically linked executables they can be executed and symbols
1569 defined in the executable cannot be overridden by shared libraries.
1570
1571 @kindex -qmagic
1572 @item -qmagic
1573 This option is ignored for Linux compatibility.
1574
1575 @kindex -Qy
1576 @item -Qy
1577 This option is ignored for SVR4 compatibility.
1578
1579 @kindex --relax
1580 @cindex synthesizing linker
1581 @cindex relaxing addressing modes
1582 @cindex --no-relax
1583 @item --relax
1584 @itemx --no-relax
1585 An option with machine dependent effects.
1586 @ifset GENERIC
1587 This option is only supported on a few targets.
1588 @end ifset
1589 @ifset H8300
1590 @xref{H8/300,,@command{ld} and the H8/300}.
1591 @end ifset
1592 @ifset I960
1593 @xref{i960,, @command{ld} and the Intel 960 family}.
1594 @end ifset
1595 @ifset XTENSA
1596 @xref{Xtensa,, @command{ld} and Xtensa Processors}.
1597 @end ifset
1598 @ifset M68HC11
1599 @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}.
1600 @end ifset
1601 @ifset POWERPC
1602 @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}.
1603 @end ifset
1604
1605 On some platforms the @samp{--relax} option performs target specific,
1606 global optimizations that become possible when the linker resolves
1607 addressing in the program, such as relaxing address modes,
1608 synthesizing new instructions, selecting shorter version of current
1609 instructions, and combining constant values.
1610
1611 On some platforms these link time global optimizations may make symbolic
1612 debugging of the resulting executable impossible.
1613 @ifset GENERIC
1614 This is known to be the case for the Matsushita MN10200 and MN10300
1615 family of processors.
1616 @end ifset
1617
1618 @ifset GENERIC
1619 On platforms where this is not supported, @samp{--relax} is accepted,
1620 but ignored.
1621 @end ifset
1622
1623 On platforms where @samp{--relax} is accepted the option
1624 @samp{--no-relax} can be used to disable the feature.
1625
1626 @cindex retaining specified symbols
1627 @cindex stripping all but some symbols
1628 @cindex symbols, retaining selectively
1629 @kindex --retain-symbols-file=@var{filename}
1630 @item --retain-symbols-file=@var{filename}
1631 Retain @emph{only} the symbols listed in the file @var{filename},
1632 discarding all others.  @var{filename} is simply a flat file, with one
1633 symbol name per line.  This option is especially useful in environments
1634 @ifset GENERIC
1635 (such as VxWorks)
1636 @end ifset
1637 where a large global symbol table is accumulated gradually, to conserve
1638 run-time memory.
1639
1640 @samp{--retain-symbols-file} does @emph{not} discard undefined symbols,
1641 or symbols needed for relocations.
1642
1643 You may only specify @samp{--retain-symbols-file} once in the command
1644 line.  It overrides @samp{-s} and @samp{-S}.
1645
1646 @ifset GENERIC
1647 @item -rpath=@var{dir}
1648 @cindex runtime library search path
1649 @kindex -rpath=@var{dir}
1650 Add a directory to the runtime library search path.  This is used when
1651 linking an ELF executable with shared objects.  All @option{-rpath}
1652 arguments are concatenated and passed to the runtime linker, which uses
1653 them to locate shared objects at runtime.  The @option{-rpath} option is
1654 also used when locating shared objects which are needed by shared
1655 objects explicitly included in the link; see the description of the
1656 @option{-rpath-link} option.  If @option{-rpath} is not used when linking an
1657 ELF executable, the contents of the environment variable
1658 @code{LD_RUN_PATH} will be used if it is defined.
1659
1660 The @option{-rpath} option may also be used on SunOS.  By default, on
1661 SunOS, the linker will form a runtime search patch out of all the
1662 @option{-L} options it is given.  If a @option{-rpath} option is used, the
1663 runtime search path will be formed exclusively using the @option{-rpath}
1664 options, ignoring the @option{-L} options.  This can be useful when using
1665 gcc, which adds many @option{-L} options which may be on NFS mounted
1666 file systems.
1667
1668 For compatibility with other ELF linkers, if the @option{-R} option is
1669 followed by a directory name, rather than a file name, it is treated as
1670 the @option{-rpath} option.
1671 @end ifset
1672
1673 @ifset GENERIC
1674 @cindex link-time runtime library search path
1675 @kindex -rpath-link=@var{dir}
1676 @item -rpath-link=@var{dir}
1677 When using ELF or SunOS, one shared library may require another.  This
1678 happens when an @code{ld -shared} link includes a shared library as one
1679 of the input files.
1680
1681 When the linker encounters such a dependency when doing a non-shared,
1682 non-relocatable link, it will automatically try to locate the required
1683 shared library and include it in the link, if it is not included
1684 explicitly.  In such a case, the @option{-rpath-link} option
1685 specifies the first set of directories to search.  The
1686 @option{-rpath-link} option may specify a sequence of directory names
1687 either by specifying a list of names separated by colons, or by
1688 appearing multiple times.
1689
1690 This option should be used with caution as it overrides the search path
1691 that may have been hard compiled into a shared library. In such a case it
1692 is possible to use unintentionally a different search path than the
1693 runtime linker would do.
1694
1695 The linker uses the following search paths to locate required shared
1696 libraries:
1697 @enumerate
1698 @item
1699 Any directories specified by @option{-rpath-link} options.
1700 @item
1701 Any directories specified by @option{-rpath} options.  The difference
1702 between @option{-rpath} and @option{-rpath-link} is that directories
1703 specified by @option{-rpath} options are included in the executable and
1704 used at runtime, whereas the @option{-rpath-link} option is only effective
1705 at link time. Searching @option{-rpath} in this way is only supported
1706 by native linkers and cross linkers which have been configured with
1707 the @option{--with-sysroot} option.
1708 @item
1709 On an ELF system, for native linkers, if the @option{-rpath} and
1710 @option{-rpath-link} options were not used, search the contents of the
1711 environment variable @code{LD_RUN_PATH}.
1712 @item
1713 On SunOS, if the @option{-rpath} option was not used, search any
1714 directories specified using @option{-L} options.
1715 @item
1716 For a native linker, search the contents of the environment
1717 variable @code{LD_LIBRARY_PATH}.
1718 @item
1719 For a native ELF linker, the directories in @code{DT_RUNPATH} or
1720 @code{DT_RPATH} of a shared library are searched for shared
1721 libraries needed by it. The @code{DT_RPATH} entries are ignored if
1722 @code{DT_RUNPATH} entries exist.
1723 @item
1724 The default directories, normally @file{/lib} and @file{/usr/lib}.
1725 @item
1726 For a native linker on an ELF system, if the file @file{/etc/ld.so.conf}
1727 exists, the list of directories found in that file.
1728 @end enumerate
1729
1730 If the required shared library is not found, the linker will issue a
1731 warning and continue with the link.
1732 @end ifset
1733
1734 @kindex -shared
1735 @kindex -Bshareable
1736 @item -shared
1737 @itemx -Bshareable
1738 @cindex shared libraries
1739 Create a shared library.  This is currently only supported on ELF, XCOFF
1740 and SunOS platforms.  On SunOS, the linker will automatically create a
1741 shared library if the @option{-e} option is not used and there are
1742 undefined symbols in the link.
1743
1744 @kindex --sort-common
1745 @item --sort-common
1746 @itemx --sort-common=ascending
1747 @itemx --sort-common=descending
1748 This option tells @command{ld} to sort the common symbols by alignment in
1749 ascending or descending order when it places them in the appropriate output
1750 sections.  The symbol alignments considered are sixteen-byte or larger,
1751 eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps
1752 between symbols due to alignment constraints.  If no sorting order is
1753 specified, then descending order is assumed.
1754
1755 @kindex --sort-section=name
1756 @item --sort-section=name
1757 This option will apply @code{SORT_BY_NAME} to all wildcard section
1758 patterns in the linker script.
1759
1760 @kindex --sort-section=alignment
1761 @item --sort-section=alignment
1762 This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section
1763 patterns in the linker script.
1764
1765 @kindex --split-by-file
1766 @item --split-by-file[=@var{size}]
1767 Similar to @option{--split-by-reloc} but creates a new output section for
1768 each input file when @var{size} is reached.  @var{size} defaults to a
1769 size of 1 if not given.
1770
1771 @kindex --split-by-reloc
1772 @item --split-by-reloc[=@var{count}]
1773 Tries to creates extra sections in the output file so that no single
1774 output section in the file contains more than @var{count} relocations.
1775 This is useful when generating huge relocatable files for downloading into
1776 certain real time kernels with the COFF object file format; since COFF
1777 cannot represent more than 65535 relocations in a single section.  Note
1778 that this will fail to work with object file formats which do not
1779 support arbitrary sections.  The linker will not split up individual
1780 input sections for redistribution, so if a single input section contains
1781 more than @var{count} relocations one output section will contain that
1782 many relocations.  @var{count} defaults to a value of 32768.
1783
1784 @kindex --stats
1785 @item --stats
1786 Compute and display statistics about the operation of the linker, such
1787 as execution time and memory usage.
1788
1789 @kindex --sysroot=@var{directory}
1790 @item --sysroot=@var{directory}
1791 Use @var{directory} as the location of the sysroot, overriding the
1792 configure-time default.  This option is only supported by linkers
1793 that were configured using @option{--with-sysroot}.
1794
1795 @kindex --traditional-format
1796 @cindex traditional format
1797 @item --traditional-format
1798 For some targets, the output of @command{ld} is different in some ways from
1799 the output of some existing linker.  This switch requests @command{ld} to
1800 use the traditional format instead.
1801
1802 @cindex dbx
1803 For example, on SunOS, @command{ld} combines duplicate entries in the
1804 symbol string table.  This can reduce the size of an output file with
1805 full debugging information by over 30 percent.  Unfortunately, the SunOS
1806 @code{dbx} program can not read the resulting program (@code{gdb} has no
1807 trouble).  The @samp{--traditional-format} switch tells @command{ld} to not
1808 combine duplicate entries.
1809
1810 @kindex --section-start=@var{sectionname}=@var{org}
1811 @item --section-start=@var{sectionname}=@var{org}
1812 Locate a section in the output file at the absolute
1813 address given by @var{org}.  You may use this option as many
1814 times as necessary to locate multiple sections in the command
1815 line.
1816 @var{org} must be a single hexadecimal integer;
1817 for compatibility with other linkers, you may omit the leading
1818 @samp{0x} usually associated with hexadecimal values.  @emph{Note:} there
1819 should be no white space between @var{sectionname}, the equals
1820 sign (``@key{=}''), and @var{org}.
1821
1822 @kindex -Tbss=@var{org}
1823 @kindex -Tdata=@var{org}
1824 @kindex -Ttext=@var{org}
1825 @cindex segment origins, cmd line
1826 @item -Tbss=@var{org}
1827 @itemx -Tdata=@var{org}
1828 @itemx -Ttext=@var{org}
1829 Same as @option{--section-start}, with @code{.bss}, @code{.data} or
1830 @code{.text} as the @var{sectionname}.
1831
1832 @kindex -Ttext-segment=@var{org}
1833 @item -Ttext-segment=@var{org}
1834 @cindex text segment origin, cmd line
1835 When creating an ELF executable or shared object, it will set the address
1836 of the first byte of the text segment.
1837
1838 @kindex -Trodata-segment=@var{org}
1839 @item -Trodata-segment=@var{org}
1840 @cindex rodata segment origin, cmd line
1841 When creating an ELF executable or shared object for a target where
1842 the read-only data is in its own segment separate from the executable
1843 text, it will set the address of the first byte of the read-only data segment.
1844
1845 @kindex -Tldata-segment=@var{org}
1846 @item -Tldata-segment=@var{org}
1847 @cindex ldata segment origin, cmd line
1848 When creating an ELF executable or shared object for x86-64 medium memory
1849 model, it will set the address of the first byte of the ldata segment.
1850
1851 @kindex --unresolved-symbols
1852 @item --unresolved-symbols=@var{method}
1853 Determine how to handle unresolved symbols.  There are four possible
1854 values for @samp{method}:
1855
1856 @table @samp
1857 @item ignore-all
1858 Do not report any unresolved symbols.
1859
1860 @item report-all
1861 Report all unresolved symbols.  This is the default.
1862
1863 @item ignore-in-object-files
1864 Report unresolved symbols that are contained in shared libraries, but
1865 ignore them if they come from regular object files.
1866
1867 @item ignore-in-shared-libs
1868 Report unresolved symbols that come from regular object files, but
1869 ignore them if they come from shared libraries.  This can be useful
1870 when creating a dynamic binary and it is known that all the shared
1871 libraries that it should be referencing are included on the linker's
1872 command line.
1873 @end table
1874
1875 The behaviour for shared libraries on their own can also be controlled
1876 by the @option{--[no-]allow-shlib-undefined} option.
1877
1878 Normally the linker will generate an error message for each reported
1879 unresolved symbol but the option @option{--warn-unresolved-symbols}
1880 can change this to a warning.
1881
1882 @kindex --verbose[=@var{NUMBER}]
1883 @cindex verbose[=@var{NUMBER}]
1884 @item --dll-verbose
1885 @itemx --verbose[=@var{NUMBER}]
1886 Display the version number for @command{ld} and list the linker emulations
1887 supported.  Display which input files can and cannot be opened.  Display
1888 the linker script being used by the linker. If the optional @var{NUMBER}
1889 argument > 1, plugin symbol status will also be displayed.
1890
1891 @kindex --version-script=@var{version-scriptfile}
1892 @cindex version script, symbol versions
1893 @item --version-script=@var{version-scriptfile}
1894 Specify the name of a version script to the linker.  This is typically
1895 used when creating shared libraries to specify additional information
1896 about the version hierarchy for the library being created.  This option
1897 is only fully supported on ELF platforms which support shared libraries;
1898 see @ref{VERSION}.  It is partially supported on PE platforms, which can
1899 use version scripts to filter symbol visibility in auto-export mode: any
1900 symbols marked @samp{local} in the version script will not be exported.
1901 @xref{WIN32}.
1902
1903 @kindex --warn-common
1904 @cindex warnings, on combining symbols
1905 @cindex combining symbols, warnings on
1906 @item --warn-common
1907 Warn when a common symbol is combined with another common symbol or with
1908 a symbol definition.  Unix linkers allow this somewhat sloppy practice,
1909 but linkers on some other operating systems do not.  This option allows
1910 you to find potential problems from combining global symbols.
1911 Unfortunately, some C libraries use this practice, so you may get some
1912 warnings about symbols in the libraries as well as in your programs.
1913
1914 There are three kinds of global symbols, illustrated here by C examples:
1915
1916 @table @samp
1917 @item int i = 1;
1918 A definition, which goes in the initialized data section of the output
1919 file.
1920
1921 @item extern int i;
1922 An undefined reference, which does not allocate space.
1923 There must be either a definition or a common symbol for the
1924 variable somewhere.
1925
1926 @item int i;
1927 A common symbol.  If there are only (one or more) common symbols for a
1928 variable, it goes in the uninitialized data area of the output file.
1929 The linker merges multiple common symbols for the same variable into a
1930 single symbol.  If they are of different sizes, it picks the largest
1931 size.  The linker turns a common symbol into a declaration, if there is
1932 a definition of the same variable.
1933 @end table
1934
1935 The @samp{--warn-common} option can produce five kinds of warnings.
1936 Each warning consists of a pair of lines: the first describes the symbol
1937 just encountered, and the second describes the previous symbol
1938 encountered with the same name.  One or both of the two symbols will be
1939 a common symbol.
1940
1941 @enumerate
1942 @item
1943 Turning a common symbol into a reference, because there is already a
1944 definition for the symbol.
1945 @smallexample
1946 @var{file}(@var{section}): warning: common of `@var{symbol}'
1947    overridden by definition
1948 @var{file}(@var{section}): warning: defined here
1949 @end smallexample
1950
1951 @item
1952 Turning a common symbol into a reference, because a later definition for
1953 the symbol is encountered.  This is the same as the previous case,
1954 except that the symbols are encountered in a different order.
1955 @smallexample
1956 @var{file}(@var{section}): warning: definition of `@var{symbol}'
1957    overriding common
1958 @var{file}(@var{section}): warning: common is here
1959 @end smallexample
1960
1961 @item
1962 Merging a common symbol with a previous same-sized common symbol.
1963 @smallexample
1964 @var{file}(@var{section}): warning: multiple common
1965    of `@var{symbol}'
1966 @var{file}(@var{section}): warning: previous common is here
1967 @end smallexample
1968
1969 @item
1970 Merging a common symbol with a previous larger common symbol.
1971 @smallexample
1972 @var{file}(@var{section}): warning: common of `@var{symbol}'
1973    overridden by larger common
1974 @var{file}(@var{section}): warning: larger common is here
1975 @end smallexample
1976
1977 @item
1978 Merging a common symbol with a previous smaller common symbol.  This is
1979 the same as the previous case, except that the symbols are
1980 encountered in a different order.
1981 @smallexample
1982 @var{file}(@var{section}): warning: common of `@var{symbol}'
1983    overriding smaller common
1984 @var{file}(@var{section}): warning: smaller common is here
1985 @end smallexample
1986 @end enumerate
1987
1988 @kindex --warn-constructors
1989 @item --warn-constructors
1990 Warn if any global constructors are used.  This is only useful for a few
1991 object file formats.  For formats like COFF or ELF, the linker can not
1992 detect the use of global constructors.
1993
1994 @kindex --warn-multiple-gp
1995 @item --warn-multiple-gp
1996 Warn if multiple global pointer values are required in the output file.
1997 This is only meaningful for certain processors, such as the Alpha.
1998 Specifically, some processors put large-valued constants in a special
1999 section.  A special register (the global pointer) points into the middle
2000 of this section, so that constants can be loaded efficiently via a
2001 base-register relative addressing mode.  Since the offset in
2002 base-register relative mode is fixed and relatively small (e.g., 16
2003 bits), this limits the maximum size of the constant pool.  Thus, in
2004 large programs, it is often necessary to use multiple global pointer
2005 values in order to be able to address all possible constants.  This
2006 option causes a warning to be issued whenever this case occurs.
2007
2008 @kindex --warn-once
2009 @cindex warnings, on undefined symbols
2010 @cindex undefined symbols, warnings on
2011 @item --warn-once
2012 Only warn once for each undefined symbol, rather than once per module
2013 which refers to it.
2014
2015 @kindex --warn-section-align
2016 @cindex warnings, on section alignment
2017 @cindex section alignment, warnings on
2018 @item --warn-section-align
2019 Warn if the address of an output section is changed because of
2020 alignment.  Typically, the alignment will be set by an input section.
2021 The address will only be changed if it not explicitly specified; that
2022 is, if the @code{SECTIONS} command does not specify a start address for
2023 the section (@pxref{SECTIONS}).
2024
2025 @kindex --warn-shared-textrel
2026 @item --warn-shared-textrel
2027 Warn if the linker adds a DT_TEXTREL to a shared object.
2028
2029 @kindex --warn-alternate-em
2030 @item --warn-alternate-em
2031 Warn if an object has alternate ELF machine code.
2032
2033 @kindex --warn-unresolved-symbols
2034 @item --warn-unresolved-symbols
2035 If the linker is going to report an unresolved symbol (see the option
2036 @option{--unresolved-symbols}) it will normally generate an error.
2037 This option makes it generate a warning instead.
2038
2039 @kindex --error-unresolved-symbols
2040 @item --error-unresolved-symbols
2041 This restores the linker's default behaviour of generating errors when
2042 it is reporting unresolved symbols.
2043
2044 @kindex --whole-archive
2045 @cindex including an entire archive
2046 @item --whole-archive
2047 For each archive mentioned on the command line after the
2048 @option{--whole-archive} option, include every object file in the archive
2049 in the link, rather than searching the archive for the required object
2050 files.  This is normally used to turn an archive file into a shared
2051 library, forcing every object to be included in the resulting shared
2052 library.  This option may be used more than once.
2053
2054 Two notes when using this option from gcc: First, gcc doesn't know
2055 about this option, so you have to use @option{-Wl,-whole-archive}.
2056 Second, don't forget to use @option{-Wl,-no-whole-archive} after your
2057 list of archives, because gcc will add its own list of archives to
2058 your link and you may not want this flag to affect those as well.
2059
2060 @kindex --wrap=@var{symbol}
2061 @item --wrap=@var{symbol}
2062 Use a wrapper function for @var{symbol}.  Any undefined reference to
2063 @var{symbol} will be resolved to @code{__wrap_@var{symbol}}.  Any
2064 undefined reference to @code{__real_@var{symbol}} will be resolved to
2065 @var{symbol}.
2066
2067 This can be used to provide a wrapper for a system function.  The
2068 wrapper function should be called @code{__wrap_@var{symbol}}.  If it
2069 wishes to call the system function, it should call
2070 @code{__real_@var{symbol}}.
2071
2072 Here is a trivial example:
2073
2074 @smallexample
2075 void *
2076 __wrap_malloc (size_t c)
2077 @{
2078   printf ("malloc called with %zu\n", c);
2079   return __real_malloc (c);
2080 @}
2081 @end smallexample
2082
2083 If you link other code with this file using @option{--wrap malloc}, then
2084 all calls to @code{malloc} will call the function @code{__wrap_malloc}
2085 instead.  The call to @code{__real_malloc} in @code{__wrap_malloc} will
2086 call the real @code{malloc} function.
2087
2088 You may wish to provide a @code{__real_malloc} function as well, so that
2089 links without the @option{--wrap} option will succeed.  If you do this,
2090 you should not put the definition of @code{__real_malloc} in the same
2091 file as @code{__wrap_malloc}; if you do, the assembler may resolve the
2092 call before the linker has a chance to wrap it to @code{malloc}.
2093
2094 @kindex --eh-frame-hdr
2095 @item --eh-frame-hdr
2096 Request creation of @code{.eh_frame_hdr} section and ELF
2097 @code{PT_GNU_EH_FRAME} segment header.
2098
2099 @kindex --ld-generated-unwind-info
2100 @item --no-ld-generated-unwind-info
2101 Request creation of @code{.eh_frame} unwind info for linker
2102 generated code sections like PLT.  This option is on by default
2103 if linker generated unwind info is supported.
2104
2105 @kindex --enable-new-dtags
2106 @kindex --disable-new-dtags
2107 @item --enable-new-dtags
2108 @itemx --disable-new-dtags
2109 This linker can create the new dynamic tags in ELF. But the older ELF
2110 systems may not understand them. If you specify
2111 @option{--enable-new-dtags}, the new dynamic tags will be created as needed
2112 and older dynamic tags will be omitted.
2113 If you specify @option{--disable-new-dtags}, no new dynamic tags will be
2114 created. By default, the new dynamic tags are not created. Note that
2115 those options are only available for ELF systems.
2116
2117 @kindex --hash-size=@var{number}
2118 @item --hash-size=@var{number}
2119 Set the default size of the linker's hash tables to a prime number
2120 close to @var{number}.  Increasing this value can reduce the length of
2121 time it takes the linker to perform its tasks, at the expense of
2122 increasing the linker's memory requirements.  Similarly reducing this
2123 value can reduce the memory requirements at the expense of speed.
2124
2125 @kindex --hash-style=@var{style}
2126 @item --hash-style=@var{style}
2127 Set the type of linker's hash table(s).  @var{style} can be either
2128 @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for
2129 new style GNU @code{.gnu.hash} section or @code{both} for both
2130 the classic ELF @code{.hash} and new style GNU @code{.gnu.hash}
2131 hash tables.  The default is @code{sysv}.
2132
2133 @kindex --reduce-memory-overheads
2134 @item --reduce-memory-overheads
2135 This option reduces memory requirements at ld runtime, at the expense of
2136 linking speed.  This was introduced to select the old O(n^2) algorithm
2137 for link map file generation, rather than the new O(n) algorithm which uses
2138 about 40% more memory for symbol storage.
2139
2140 Another effect of the switch is to set the default hash table size to
2141 1021, which again saves memory at the cost of lengthening the linker's
2142 run time.  This is not done however if the @option{--hash-size} switch
2143 has been used.
2144
2145 The @option{--reduce-memory-overheads} switch may be also be used to
2146 enable other tradeoffs in future versions of the linker.
2147
2148 @kindex --build-id
2149 @kindex --build-id=@var{style}
2150 @item --build-id
2151 @itemx --build-id=@var{style}
2152 Request creation of @code{.note.gnu.build-id} ELF note section.
2153 The contents of the note are unique bits identifying this linked
2154 file.  @var{style} can be @code{uuid} to use 128 random bits,
2155 @code{sha1} to use a 160-bit @sc{SHA1} hash on the normative
2156 parts of the output contents, @code{md5} to use a 128-bit
2157 @sc{MD5} hash on the normative parts of the output contents, or
2158 @code{0x@var{hexstring}} to use a chosen bit string specified as
2159 an even number of hexadecimal digits (@code{-} and @code{:}
2160 characters between digit pairs are ignored).  If @var{style} is
2161 omitted, @code{sha1} is used.
2162
2163 The @code{md5} and @code{sha1} styles produces an identifier
2164 that is always the same in an identical output file, but will be
2165 unique among all nonidentical output files.  It is not intended
2166 to be compared as a checksum for the file's contents.  A linked
2167 file may be changed later by other tools, but the build ID bit
2168 string identifying the original linked file does not change.
2169
2170 Passing @code{none} for @var{style} disables the setting from any
2171 @code{--build-id} options earlier on the command line.
2172 @end table
2173
2174 @c man end
2175
2176 @subsection Options Specific to i386 PE Targets
2177
2178 @c man begin OPTIONS
2179
2180 The i386 PE linker supports the @option{-shared} option, which causes
2181 the output to be a dynamically linked library (DLL) instead of a
2182 normal executable.  You should name the output @code{*.dll} when you
2183 use this option.  In addition, the linker fully supports the standard
2184 @code{*.def} files, which may be specified on the linker command line
2185 like an object file (in fact, it should precede archives it exports
2186 symbols from, to ensure that they get linked in, just like a normal
2187 object file).
2188
2189 In addition to the options common to all targets, the i386 PE linker
2190 support additional command line options that are specific to the i386
2191 PE target.  Options that take values may be separated from their
2192 values by either a space or an equals sign.
2193
2194 @table @gcctabopt
2195
2196 @kindex --add-stdcall-alias
2197 @item --add-stdcall-alias
2198 If given, symbols with a stdcall suffix (@@@var{nn}) will be exported
2199 as-is and also with the suffix stripped.
2200 [This option is specific to the i386 PE targeted port of the linker]
2201
2202 @kindex --base-file
2203 @item --base-file @var{file}
2204 Use @var{file} as the name of a file in which to save the base
2205 addresses of all the relocations needed for generating DLLs with
2206 @file{dlltool}.
2207 [This is an i386 PE specific option]
2208
2209 @kindex --dll
2210 @item --dll
2211 Create a DLL instead of a regular executable.  You may also use
2212 @option{-shared} or specify a @code{LIBRARY} in a given @code{.def}
2213 file.
2214 [This option is specific to the i386 PE targeted port of the linker]
2215
2216 @kindex --enable-long-section-names
2217 @kindex --disable-long-section-names
2218 @item --enable-long-section-names
2219 @itemx --disable-long-section-names
2220 The PE variants of the Coff object format add an extension that permits
2221 the use of section names longer than eight characters, the normal limit
2222 for Coff.  By default, these names are only allowed in object files, as
2223 fully-linked executable images do not carry the Coff string table required
2224 to support the longer names.  As a GNU extension, it is possible to
2225 allow their use in executable images as well, or to (probably pointlessly!)
2226 disallow it in object files, by using these two options.  Executable images
2227 generated with these long section names are slightly non-standard, carrying
2228 as they do a string table, and may generate confusing output when examined
2229 with non-GNU PE-aware tools, such as file viewers and dumpers.  However,
2230 GDB relies on the use of PE long section names to find Dwarf-2 debug
2231 information sections in an executable image at runtime, and so if neither
2232 option is specified on the command-line, @command{ld} will enable long
2233 section names, overriding the default and technically correct behaviour,
2234 when it finds the presence of debug information while linking an executable
2235 image and not stripping symbols.
2236 [This option is valid for all PE targeted ports of the linker]
2237
2238 @kindex --enable-stdcall-fixup
2239 @kindex --disable-stdcall-fixup
2240 @item --enable-stdcall-fixup
2241 @itemx --disable-stdcall-fixup
2242 If the link finds a symbol that it cannot resolve, it will attempt to
2243 do ``fuzzy linking'' by looking for another defined symbol that differs
2244 only in the format of the symbol name (cdecl vs stdcall) and will
2245 resolve that symbol by linking to the match.  For example, the
2246 undefined symbol @code{_foo} might be linked to the function
2247 @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked
2248 to the function @code{_bar}.  When the linker does this, it prints a
2249 warning, since it normally should have failed to link, but sometimes
2250 import libraries generated from third-party dlls may need this feature
2251 to be usable.  If you specify @option{--enable-stdcall-fixup}, this
2252 feature is fully enabled and warnings are not printed.  If you specify
2253 @option{--disable-stdcall-fixup}, this feature is disabled and such
2254 mismatches are considered to be errors.
2255 [This option is specific to the i386 PE targeted port of the linker]
2256
2257 @kindex --leading-underscore
2258 @kindex --no-leading-underscore
2259 @item --leading-underscore
2260 @itemx --no-leading-underscore
2261 For most targets default symbol-prefix is an underscore and is defined
2262 in target's description. By this option it is possible to
2263 disable/enable the default underscore symbol-prefix.
2264
2265 @cindex DLLs, creating
2266 @kindex --export-all-symbols
2267 @item --export-all-symbols
2268 If given, all global symbols in the objects used to build a DLL will
2269 be exported by the DLL.  Note that this is the default if there
2270 otherwise wouldn't be any exported symbols.  When symbols are
2271 explicitly exported via DEF files or implicitly exported via function
2272 attributes, the default is to not export anything else unless this
2273 option is given.  Note that the symbols @code{DllMain@@12},
2274 @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and
2275 @code{impure_ptr} will not be automatically
2276 exported.  Also, symbols imported from other DLLs will not be
2277 re-exported, nor will symbols specifying the DLL's internal layout
2278 such as those beginning with @code{_head_} or ending with
2279 @code{_iname}.  In addition, no symbols from @code{libgcc},
2280 @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported.
2281 Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will
2282 not be exported, to help with C++ DLLs.  Finally, there is an
2283 extensive list of cygwin-private symbols that are not exported
2284 (obviously, this applies on when building DLLs for cygwin targets).
2285 These cygwin-excludes are: @code{_cygwin_dll_entry@@12},
2286 @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12},
2287 @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll},
2288 @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2},
2289 @code{cygwin_premain3}, and @code{environ}.
2290 [This option is specific to the i386 PE targeted port of the linker]
2291
2292 @kindex --exclude-symbols
2293 @item --exclude-symbols @var{symbol},@var{symbol},...
2294 Specifies a list of symbols which should not be automatically
2295 exported.  The symbol names may be delimited by commas or colons.
2296 [This option is specific to the i386 PE targeted port of the linker]
2297
2298 @kindex --exclude-all-symbols
2299 @item --exclude-all-symbols
2300 Specifies no symbols should be automatically exported.
2301 [This option is specific to the i386 PE targeted port of the linker]
2302
2303 @kindex --file-alignment
2304 @item --file-alignment
2305 Specify the file alignment.  Sections in the file will always begin at
2306 file offsets which are multiples of this number.  This defaults to
2307 512.
2308 [This option is specific to the i386 PE targeted port of the linker]
2309
2310 @cindex heap size
2311 @kindex --heap
2312 @item --heap @var{reserve}
2313 @itemx --heap @var{reserve},@var{commit}
2314 Specify the number of bytes of memory to reserve (and optionally commit)
2315 to be used as heap for this program.  The default is 1Mb reserved, 4K
2316 committed.
2317 [This option is specific to the i386 PE targeted port of the linker]
2318
2319 @cindex image base
2320 @kindex --image-base
2321 @item --image-base @var{value}
2322 Use @var{value} as the base address of your program or dll.  This is
2323 the lowest memory location that will be used when your program or dll
2324 is loaded.  To reduce the need to relocate and improve performance of
2325 your dlls, each should have a unique base address and not overlap any
2326 other dlls.  The default is 0x400000 for executables, and 0x10000000
2327 for dlls.
2328 [This option is specific to the i386 PE targeted port of the linker]
2329
2330 @kindex --kill-at
2331 @item --kill-at
2332 If given, the stdcall suffixes (@@@var{nn}) will be stripped from
2333 symbols before they are exported.
2334 [This option is specific to the i386 PE targeted port of the linker]
2335
2336 @kindex --large-address-aware
2337 @item --large-address-aware
2338 If given, the appropriate bit in the ``Characteristics'' field of the COFF
2339 header is set to indicate that this executable supports virtual addresses
2340 greater than 2 gigabytes.  This should be used in conjunction with the /3GB
2341 or /USERVA=@var{value} megabytes switch in the ``[operating systems]''
2342 section of the BOOT.INI.  Otherwise, this bit has no effect.
2343 [This option is specific to PE targeted ports of the linker]
2344
2345 @kindex --major-image-version
2346 @item --major-image-version @var{value}
2347 Sets the major number of the ``image version''.  Defaults to 1.
2348 [This option is specific to the i386 PE targeted port of the linker]
2349
2350 @kindex --major-os-version
2351 @item --major-os-version @var{value}
2352 Sets the major number of the ``os version''.  Defaults to 4.
2353 [This option is specific to the i386 PE targeted port of the linker]
2354
2355 @kindex --major-subsystem-version
2356 @item --major-subsystem-version @var{value}
2357 Sets the major number of the ``subsystem version''.  Defaults to 4.
2358 [This option is specific to the i386 PE targeted port of the linker]
2359
2360 @kindex --minor-image-version
2361 @item --minor-image-version @var{value}
2362 Sets the minor number of the ``image version''.  Defaults to 0.
2363 [This option is specific to the i386 PE targeted port of the linker]
2364
2365 @kindex --minor-os-version
2366 @item --minor-os-version @var{value}
2367 Sets the minor number of the ``os version''.  Defaults to 0.
2368 [This option is specific to the i386 PE targeted port of the linker]
2369
2370 @kindex --minor-subsystem-version
2371 @item --minor-subsystem-version @var{value}
2372 Sets the minor number of the ``subsystem version''.  Defaults to 0.
2373 [This option is specific to the i386 PE targeted port of the linker]
2374
2375 @cindex DEF files, creating
2376 @cindex DLLs, creating
2377 @kindex --output-def
2378 @item --output-def @var{file}
2379 The linker will create the file @var{file} which will contain a DEF
2380 file corresponding to the DLL the linker is generating.  This DEF file
2381 (which should be called @code{*.def}) may be used to create an import
2382 library with @code{dlltool} or may be used as a reference to
2383 automatically or implicitly exported symbols.
2384 [This option is specific to the i386 PE targeted port of the linker]
2385
2386 @cindex DLLs, creating
2387 @kindex --out-implib
2388 @item --out-implib @var{file}
2389 The linker will create the file @var{file} which will contain an
2390 import lib corresponding to the DLL the linker is generating. This
2391 import lib (which should be called @code{*.dll.a} or @code{*.a}
2392 may be used to link clients against the generated DLL; this behaviour
2393 makes it possible to skip a separate @code{dlltool} import library
2394 creation step.
2395 [This option is specific to the i386 PE targeted port of the linker]
2396
2397 @kindex --enable-auto-image-base
2398 @item --enable-auto-image-base
2399 Automatically choose the image base for DLLs, unless one is specified
2400 using the @code{--image-base} argument.  By using a hash generated
2401 from the dllname to create unique image bases for each DLL, in-memory
2402 collisions and relocations which can delay program execution are
2403 avoided.
2404 [This option is specific to the i386 PE targeted port of the linker]
2405
2406 @kindex --disable-auto-image-base
2407 @item --disable-auto-image-base
2408 Do not automatically generate a unique image base.  If there is no
2409 user-specified image base (@code{--image-base}) then use the platform
2410 default.
2411 [This option is specific to the i386 PE targeted port of the linker]
2412
2413 @cindex DLLs, linking to
2414 @kindex --dll-search-prefix
2415 @item --dll-search-prefix @var{string}
2416 When linking dynamically to a dll without an import library,
2417 search for @code{<string><basename>.dll} in preference to
2418 @code{lib<basename>.dll}. This behaviour allows easy distinction
2419 between DLLs built for the various "subplatforms": native, cygwin,
2420 uwin, pw, etc.  For instance, cygwin DLLs typically use
2421 @code{--dll-search-prefix=cyg}.
2422 [This option is specific to the i386 PE targeted port of the linker]
2423
2424 @kindex --enable-auto-import
2425 @item --enable-auto-import
2426 Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for
2427 DATA imports from DLLs, and create the necessary thunking symbols when
2428 building the import libraries with those DATA exports. Note: Use of the
2429 'auto-import' extension will cause the text section of the image file
2430 to be made writable. This does not conform to the PE-COFF format
2431 specification published by Microsoft.
2432
2433 Note - use of the 'auto-import' extension will also cause read only
2434 data which would normally be placed into the .rdata section to be
2435 placed into the .data section instead.  This is in order to work
2436 around a problem with consts that is described here:
2437 http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
2438
2439 Using 'auto-import' generally will 'just work' -- but sometimes you may
2440 see this message:
2441
2442 "variable '<var>' can't be auto-imported. Please read the
2443 documentation for ld's @code{--enable-auto-import} for details."
2444
2445 This message occurs when some (sub)expression accesses an address
2446 ultimately given by the sum of two constants (Win32 import tables only
2447 allow one).  Instances where this may occur include accesses to member
2448 fields of struct variables imported from a DLL, as well as using a
2449 constant index into an array variable imported from a DLL.  Any
2450 multiword variable (arrays, structs, long long, etc) may trigger
2451 this error condition.  However, regardless of the exact data type
2452 of the offending exported variable, ld will always detect it, issue
2453 the warning, and exit.
2454
2455 There are several ways to address this difficulty, regardless of the
2456 data type of the exported variable:
2457
2458 One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task
2459 of adjusting references in your client code for runtime environment, so
2460 this method works only when runtime environment supports this feature.
2461
2462 A second solution is to force one of the 'constants' to be a variable --
2463 that is, unknown and un-optimizable at compile time.  For arrays,
2464 there are two possibilities: a) make the indexee (the array's address)
2465 a variable, or b) make the 'constant' index a variable.  Thus:
2466
2467 @example
2468 extern type extern_array[];
2469 extern_array[1] -->
2470    @{ volatile type *t=extern_array; t[1] @}
2471 @end example
2472
2473 or
2474
2475 @example
2476 extern type extern_array[];
2477 extern_array[1] -->
2478    @{ volatile int t=1; extern_array[t] @}
2479 @end example
2480
2481 For structs (and most other multiword data types) the only option
2482 is to make the struct itself (or the long long, or the ...) variable:
2483
2484 @example
2485 extern struct s extern_struct;
2486 extern_struct.field -->
2487    @{ volatile struct s *t=&extern_struct; t->field @}
2488 @end example
2489
2490 or
2491
2492 @example
2493 extern long long extern_ll;
2494 extern_ll -->
2495   @{ volatile long long * local_ll=&extern_ll; *local_ll @}
2496 @end example
2497
2498 A third method of dealing with this difficulty is to abandon
2499 'auto-import' for the offending symbol and mark it with
2500 @code{__declspec(dllimport)}.  However, in practice that
2501 requires using compile-time #defines to indicate whether you are
2502 building a DLL, building client code that will link to the DLL, or
2503 merely building/linking to a static library.   In making the choice
2504 between the various methods of resolving the 'direct address with
2505 constant offset' problem, you should consider typical real-world usage:
2506
2507 Original:
2508 @example
2509 --foo.h
2510 extern int arr[];
2511 --foo.c
2512 #include "foo.h"
2513 void main(int argc, char **argv)@{
2514   printf("%d\n",arr[1]);
2515 @}
2516 @end example
2517
2518 Solution 1:
2519 @example
2520 --foo.h
2521 extern int arr[];
2522 --foo.c
2523 #include "foo.h"
2524 void main(int argc, char **argv)@{
2525   /* This workaround is for win32 and cygwin; do not "optimize" */
2526   volatile int *parr = arr;
2527   printf("%d\n",parr[1]);
2528 @}
2529 @end example
2530
2531 Solution 2:
2532 @example
2533 --foo.h
2534 /* Note: auto-export is assumed (no __declspec(dllexport)) */
2535 #if (defined(_WIN32) || defined(__CYGWIN__)) && \
2536   !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2537 #define FOO_IMPORT __declspec(dllimport)
2538 #else
2539 #define FOO_IMPORT
2540 #endif
2541 extern FOO_IMPORT int arr[];
2542 --foo.c
2543 #include "foo.h"
2544 void main(int argc, char **argv)@{
2545   printf("%d\n",arr[1]);
2546 @}
2547 @end example
2548
2549 A fourth way to avoid this problem is to re-code your
2550 library to use a functional interface rather than a data interface
2551 for the offending variables (e.g. set_foo() and get_foo() accessor
2552 functions).
2553 [This option is specific to the i386 PE targeted port of the linker]
2554
2555 @kindex --disable-auto-import
2556 @item --disable-auto-import
2557 Do not attempt to do sophisticated linking of @code{_symbol} to
2558 @code{__imp__symbol} for DATA imports from DLLs.
2559 [This option is specific to the i386 PE targeted port of the linker]
2560
2561 @kindex --enable-runtime-pseudo-reloc
2562 @item --enable-runtime-pseudo-reloc
2563 If your code contains expressions described in --enable-auto-import section,
2564 that is, DATA imports from DLL with non-zero offset, this switch will create
2565 a vector of 'runtime pseudo relocations' which can be used by runtime
2566 environment to adjust references to such data in your client code.
2567 [This option is specific to the i386 PE targeted port of the linker]
2568
2569 @kindex --disable-runtime-pseudo-reloc
2570 @item --disable-runtime-pseudo-reloc
2571 Do not create pseudo relocations for non-zero offset DATA imports from
2572 DLLs.  This is the default.
2573 [This option is specific to the i386 PE targeted port of the linker]
2574
2575 @kindex --enable-extra-pe-debug
2576 @item --enable-extra-pe-debug
2577 Show additional debug info related to auto-import symbol thunking.
2578 [This option is specific to the i386 PE targeted port of the linker]
2579
2580 @kindex --section-alignment
2581 @item --section-alignment
2582 Sets the section alignment.  Sections in memory will always begin at
2583 addresses which are a multiple of this number.  Defaults to 0x1000.
2584 [This option is specific to the i386 PE targeted port of the linker]
2585
2586 @cindex stack size
2587 @kindex --stack
2588 @item --stack @var{reserve}
2589 @itemx --stack @var{reserve},@var{commit}
2590 Specify the number of bytes of memory to reserve (and optionally commit)
2591 to be used as stack for this program.  The default is 2Mb reserved, 4K
2592 committed.
2593 [This option is specific to the i386 PE targeted port of the linker]
2594
2595 @kindex --subsystem
2596 @item --subsystem @var{which}
2597 @itemx --subsystem @var{which}:@var{major}
2598 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2599 Specifies the subsystem under which your program will execute.  The
2600 legal values for @var{which} are @code{native}, @code{windows},
2601 @code{console}, @code{posix}, and @code{xbox}.  You may optionally set
2602 the subsystem version also.  Numeric values are also accepted for
2603 @var{which}.
2604 [This option is specific to the i386 PE targeted port of the linker]
2605
2606 The following options set flags in the @code{DllCharacteristics} field
2607 of the PE file header:
2608 [These options are specific to PE targeted ports of the linker]
2609
2610 @kindex --dynamicbase
2611 @item --dynamicbase
2612 The image base address may be relocated using address space layout
2613 randomization (ASLR).  This feature was introduced with MS Windows
2614 Vista for i386 PE targets.
2615
2616 @kindex --forceinteg
2617 @item --forceinteg
2618 Code integrity checks are enforced.
2619
2620 @kindex --nxcompat
2621 @item --nxcompat
2622 The image is compatible with the Data Execution Prevention.
2623 This feature was introduced with MS Windows XP SP2 for i386 PE targets.
2624
2625 @kindex --no-isolation
2626 @item --no-isolation
2627 Although the image understands isolation, do not isolate the image.
2628
2629 @kindex --no-seh
2630 @item --no-seh
2631 The image does not use SEH. No SE handler may be called from
2632 this image.
2633
2634 @kindex --no-bind
2635 @item --no-bind
2636 Do not bind this image.
2637
2638 @kindex --wdmdriver
2639 @item --wdmdriver
2640 The driver uses the MS Windows Driver Model.
2641
2642 @kindex --tsaware
2643 @item --tsaware
2644 The image is Terminal Server aware.
2645
2646 @end table
2647
2648 @c man end
2649
2650 @ifset C6X
2651 @subsection Options specific to C6X uClinux targets
2652
2653 @c man begin OPTIONS
2654
2655 The C6X uClinux target uses a binary format called DSBT to support shared
2656 libraries.  Each shared library in the system needs to have a unique index;
2657 all executables use an index of 0.
2658
2659 @table @gcctabopt
2660
2661 @kindex --dsbt-size
2662 @item --dsbt-size @var{size}
2663 This option sets the number of entires in the DSBT of the current executable
2664 or shared library to @var{size}.  The default is to create a table with 64
2665 entries.
2666
2667 @kindex --dsbt-index
2668 @item --dsbt-index @var{index}
2669 This option sets the DSBT index of the current executable or shared library
2670 to @var{index}.  The default is 0, which is appropriate for generating
2671 executables.  If a shared library is generated with a DSBT index of 0, the
2672 @code{R_C6000_DSBT_INDEX} relocs are copied into the output file.
2673
2674 @kindex --no-merge-exidx-entries
2675 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent
2676 exidx entries in frame unwind info.
2677
2678 @end table
2679
2680 @c man end
2681 @end ifset
2682
2683 @ifset M68HC11
2684 @subsection Options specific to Motorola 68HC11 and 68HC12 targets
2685
2686 @c man begin OPTIONS
2687
2688 The 68HC11 and 68HC12 linkers support specific options to control the
2689 memory bank switching mapping and trampoline code generation.
2690
2691 @table @gcctabopt
2692
2693 @kindex --no-trampoline
2694 @item --no-trampoline
2695 This option disables the generation of trampoline. By default a trampoline
2696 is generated for each far function which is called using a @code{jsr}
2697 instruction (this happens when a pointer to a far function is taken).
2698
2699 @kindex --bank-window
2700 @item --bank-window @var{name}
2701 This option indicates to the linker the name of the memory region in
2702 the @samp{MEMORY} specification that describes the memory bank window.
2703 The definition of such region is then used by the linker to compute
2704 paging and addresses within the memory window.
2705
2706 @end table
2707
2708 @c man end
2709 @end ifset
2710
2711 @ifset M68K
2712 @subsection Options specific to Motorola 68K target
2713
2714 @c man begin OPTIONS
2715
2716 The following options are supported to control handling of GOT generation
2717 when linking for 68K targets.
2718
2719 @table @gcctabopt
2720
2721 @kindex --got
2722 @item --got=@var{type}
2723 This option tells the linker which GOT generation scheme to use.
2724 @var{type} should be one of @samp{single}, @samp{negative},
2725 @samp{multigot} or @samp{target}.  For more information refer to the
2726 Info entry for @file{ld}.
2727
2728 @end table
2729
2730 @c man end
2731 @end ifset
2732
2733 @ifset UsesEnvVars
2734 @node Environment
2735 @section Environment Variables
2736
2737 @c man begin ENVIRONMENT
2738
2739 You can change the behaviour of @command{ld} with the environment variables
2740 @ifclear SingleFormat
2741 @code{GNUTARGET},
2742 @end ifclear
2743 @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
2744
2745 @ifclear SingleFormat
2746 @kindex GNUTARGET
2747 @cindex default input format
2748 @code{GNUTARGET} determines the input-file object format if you don't
2749 use @samp{-b} (or its synonym @samp{--format}).  Its value should be one
2750 of the BFD names for an input format (@pxref{BFD}).  If there is no
2751 @code{GNUTARGET} in the environment, @command{ld} uses the natural format
2752 of the target. If @code{GNUTARGET} is set to @code{default} then BFD
2753 attempts to discover the input format by examining binary input files;
2754 this method often succeeds, but there are potential ambiguities, since
2755 there is no method of ensuring that the magic number used to specify
2756 object-file formats is unique.  However, the configuration procedure for
2757 BFD on each system places the conventional format for that system first
2758 in the search-list, so ambiguities are resolved in favor of convention.
2759 @end ifclear
2760
2761 @kindex LDEMULATION
2762 @cindex default emulation
2763 @cindex emulation, default
2764 @code{LDEMULATION} determines the default emulation if you don't use the
2765 @samp{-m} option.  The emulation can affect various aspects of linker
2766 behaviour, particularly the default linker script.  You can list the
2767 available emulations with the @samp{--verbose} or @samp{-V} options.  If
2768 the @samp{-m} option is not used, and the @code{LDEMULATION} environment
2769 variable is not defined, the default emulation depends upon how the
2770 linker was configured.
2771
2772 @kindex COLLECT_NO_DEMANGLE
2773 @cindex demangling, default
2774 Normally, the linker will default to demangling symbols.  However, if
2775 @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will
2776 default to not demangling symbols.  This environment variable is used in
2777 a similar fashion by the @code{gcc} linker wrapper program.  The default
2778 may be overridden by the @samp{--demangle} and @samp{--no-demangle}
2779 options.
2780
2781 @c man end
2782 @end ifset
2783
2784 @node Scripts
2785 @chapter Linker Scripts
2786
2787 @cindex scripts
2788 @cindex linker scripts
2789 @cindex command files
2790 Every link is controlled by a @dfn{linker script}.  This script is
2791 written in the linker command language.
2792
2793 The main purpose of the linker script is to describe how the sections in
2794 the input files should be mapped into the output file, and to control
2795 the memory layout of the output file.  Most linker scripts do nothing
2796 more than this.  However, when necessary, the linker script can also
2797 direct the linker to perform many other operations, using the commands
2798 described below.
2799
2800 The linker always uses a linker script.  If you do not supply one
2801 yourself, the linker will use a default script that is compiled into the
2802 linker executable.  You can use the @samp{--verbose} command line option
2803 to display the default linker script.  Certain command line options,
2804 such as @samp{-r} or @samp{-N}, will affect the default linker script.
2805
2806 You may supply your own linker script by using the @samp{-T} command
2807 line option.  When you do this, your linker script will replace the
2808 default linker script.
2809
2810 You may also use linker scripts implicitly by naming them as input files
2811 to the linker, as though they were files to be linked.  @xref{Implicit
2812 Linker Scripts}.
2813
2814 @menu
2815 * Basic Script Concepts::       Basic Linker Script Concepts
2816 * Script Format::               Linker Script Format
2817 * Simple Example::              Simple Linker Script Example
2818 * Simple Commands::             Simple Linker Script Commands
2819 * Assignments::                 Assigning Values to Symbols
2820 * SECTIONS::                    SECTIONS Command
2821 * MEMORY::                      MEMORY Command
2822 * PHDRS::                       PHDRS Command
2823 * VERSION::                     VERSION Command
2824 * Expressions::                 Expressions in Linker Scripts
2825 * Implicit Linker Scripts::     Implicit Linker Scripts
2826 @end menu
2827
2828 @node Basic Script Concepts
2829 @section Basic Linker Script Concepts
2830 @cindex linker script concepts
2831 We need to define some basic concepts and vocabulary in order to
2832 describe the linker script language.
2833
2834 The linker combines input files into a single output file.  The output
2835 file and each input file are in a special data format known as an
2836 @dfn{object file format}.  Each file is called an @dfn{object file}.
2837 The output file is often called an @dfn{executable}, but for our
2838 purposes we will also call it an object file.  Each object file has,
2839 among other things, a list of @dfn{sections}.  We sometimes refer to a
2840 section in an input file as an @dfn{input section}; similarly, a section
2841 in the output file is an @dfn{output section}.
2842
2843 Each section in an object file has a name and a size.  Most sections
2844 also have an associated block of data, known as the @dfn{section
2845 contents}.  A section may be marked as @dfn{loadable}, which means that
2846 the contents should be loaded into memory when the output file is run.
2847 A section with no contents may be @dfn{allocatable}, which means that an
2848 area in memory should be set aside, but nothing in particular should be
2849 loaded there (in some cases this memory must be zeroed out).  A section
2850 which is neither loadable nor allocatable typically contains some sort
2851 of debugging information.
2852
2853 Every loadable or allocatable output section has two addresses.  The
2854 first is the @dfn{VMA}, or virtual memory address.  This is the address
2855 the section will have when the output file is run.  The second is the
2856 @dfn{LMA}, or load memory address.  This is the address at which the
2857 section will be loaded.  In most cases the two addresses will be the
2858 same.  An example of when they might be different is when a data section
2859 is loaded into ROM, and then copied into RAM when the program starts up
2860 (this technique is often used to initialize global variables in a ROM
2861 based system).  In this case the ROM address would be the LMA, and the
2862 RAM address would be the VMA.
2863
2864 You can see the sections in an object file by using the @code{objdump}
2865 program with the @samp{-h} option.
2866
2867 Every object file also has a list of @dfn{symbols}, known as the
2868 @dfn{symbol table}.  A symbol may be defined or undefined.  Each symbol
2869 has a name, and each defined symbol has an address, among other
2870 information.  If you compile a C or C++ program into an object file, you
2871 will get a defined symbol for every defined function and global or
2872 static variable.  Every undefined function or global variable which is
2873 referenced in the input file will become an undefined symbol.
2874
2875 You can see the symbols in an object file by using the @code{nm}
2876 program, or by using the @code{objdump} program with the @samp{-t}
2877 option.
2878
2879 @node Script Format
2880 @section Linker Script Format
2881 @cindex linker script format
2882 Linker scripts are text files.
2883
2884 You write a linker script as a series of commands.  Each command is
2885 either a keyword, possibly followed by arguments, or an assignment to a
2886 symbol.  You may separate commands using semicolons.  Whitespace is
2887 generally ignored.
2888
2889 Strings such as file or format names can normally be entered directly.
2890 If the file name contains a character such as a comma which would
2891 otherwise serve to separate file names, you may put the file name in
2892 double quotes.  There is no way to use a double quote character in a
2893 file name.
2894
2895 You may include comments in linker scripts just as in C, delimited by
2896 @samp{/*} and @samp{*/}.  As in C, comments are syntactically equivalent
2897 to whitespace.
2898
2899 @node Simple Example
2900 @section Simple Linker Script Example
2901 @cindex linker script example
2902 @cindex example of linker script
2903 Many linker scripts are fairly simple.
2904
2905 The simplest possible linker script has just one command:
2906 @samp{SECTIONS}.  You use the @samp{SECTIONS} command to describe the
2907 memory layout of the output file.
2908
2909 The @samp{SECTIONS} command is a powerful command.  Here we will
2910 describe a simple use of it.  Let's assume your program consists only of
2911 code, initialized data, and uninitialized data.  These will be in the
2912 @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively.
2913 Let's assume further that these are the only sections which appear in
2914 your input files.
2915
2916 For this example, let's say that the code should be loaded at address
2917 0x10000, and that the data should start at address 0x8000000.  Here is a
2918 linker script which will do that:
2919 @smallexample
2920 SECTIONS
2921 @{
2922   . = 0x10000;
2923   .text : @{ *(.text) @}
2924   . = 0x8000000;
2925   .data : @{ *(.data) @}
2926   .bss : @{ *(.bss) @}
2927 @}
2928 @end smallexample
2929
2930 You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS},
2931 followed by a series of symbol assignments and output section
2932 descriptions enclosed in curly braces.
2933
2934 The first line inside the @samp{SECTIONS} command of the above example
2935 sets the value of the special symbol @samp{.}, which is the location
2936 counter.  If you do not specify the address of an output section in some
2937 other way (other ways are described later), the address is set from the
2938 current value of the location counter.  The location counter is then
2939 incremented by the size of the output section.  At the start of the
2940 @samp{SECTIONS} command, the location counter has the value @samp{0}.
2941
2942 The second line defines an output section, @samp{.text}.  The colon is
2943 required syntax which may be ignored for now.  Within the curly braces
2944 after the output section name, you list the names of the input sections
2945 which should be placed into this output section.  The @samp{*} is a
2946 wildcard which matches any file name.  The expression @samp{*(.text)}
2947 means all @samp{.text} input sections in all input files.
2948
2949 Since the location counter is @samp{0x10000} when the output section
2950 @samp{.text} is defined, the linker will set the address of the
2951 @samp{.text} section in the output file to be @samp{0x10000}.
2952
2953 The remaining lines define the @samp{.data} and @samp{.bss} sections in
2954 the output file.  The linker will place the @samp{.data} output section
2955 at address @samp{0x8000000}.  After the linker places the @samp{.data}
2956 output section, the value of the location counter will be
2957 @samp{0x8000000} plus the size of the @samp{.data} output section.  The
2958 effect is that the linker will place the @samp{.bss} output section
2959 immediately after the @samp{.data} output section in memory.
2960
2961 The linker will ensure that each output section has the required
2962 alignment, by increasing the location counter if necessary.  In this
2963 example, the specified addresses for the @samp{.text} and @samp{.data}
2964 sections will probably satisfy any alignment constraints, but the linker
2965 may have to create a small gap between the @samp{.data} and @samp{.bss}
2966 sections.
2967
2968 That's it!  That's a simple and complete linker script.
2969
2970 @node Simple Commands
2971 @section Simple Linker Script Commands
2972 @cindex linker script simple commands
2973 In this section we describe the simple linker script commands.
2974
2975 @menu
2976 * Entry Point::                 Setting the entry point
2977 * File Commands::               Commands dealing with files
2978 @ifclear SingleFormat
2979 * Format Commands::             Commands dealing with object file formats
2980 @end ifclear
2981
2982 * REGION_ALIAS::                Assign alias names to memory regions
2983 * Miscellaneous Commands::      Other linker script commands
2984 @end menu
2985
2986 @node Entry Point
2987 @subsection Setting the Entry Point
2988 @kindex ENTRY(@var{symbol})
2989 @cindex start of execution
2990 @cindex first instruction
2991 @cindex entry point
2992 The first instruction to execute in a program is called the @dfn{entry
2993 point}.  You can use the @code{ENTRY} linker script command to set the
2994 entry point.  The argument is a symbol name:
2995 @smallexample
2996 ENTRY(@var{symbol})
2997 @end smallexample
2998
2999 There are several ways to set the entry point.  The linker will set the
3000 entry point by trying each of the following methods in order, and
3001 stopping when one of them succeeds:
3002 @itemize @bullet
3003 @item
3004 the @samp{-e} @var{entry} command-line option;
3005 @item
3006 the @code{ENTRY(@var{symbol})} command in a linker script;
3007 @item
3008 the value of a target specific symbol, if it is defined;  For many
3009 targets this is @code{start}, but PE and BeOS based systems for example
3010 check a list of possible entry symbols, matching the first one found.
3011 @item
3012 the address of the first byte of the @samp{.text} section, if present;
3013 @item
3014 The address @code{0}.
3015 @end itemize
3016
3017 @node File Commands
3018 @subsection Commands Dealing with Files
3019 @cindex linker script file commands
3020 Several linker script commands deal with files.
3021
3022 @table @code
3023 @item INCLUDE @var{filename}
3024 @kindex INCLUDE @var{filename}
3025 @cindex including a linker script
3026 Include the linker script @var{filename} at this point.  The file will
3027 be searched for in the current directory, and in any directory specified
3028 with the @option{-L} option.  You can nest calls to @code{INCLUDE} up to
3029 10 levels deep.
3030
3031 You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or
3032 @code{SECTIONS} commands, or in output section descriptions.
3033
3034 @item INPUT(@var{file}, @var{file}, @dots{})
3035 @itemx INPUT(@var{file} @var{file} @dots{})
3036 @kindex INPUT(@var{files})
3037 @cindex input files in linker scripts
3038 @cindex input object files in linker scripts
3039 @cindex linker script input object files
3040 The @code{INPUT} command directs the linker to include the named files
3041 in the link, as though they were named on the command line.
3042
3043 For example, if you always want to include @file{subr.o} any time you do
3044 a link, but you can't be bothered to put it on every link command line,
3045 then you can put @samp{INPUT (subr.o)} in your linker script.
3046
3047 In fact, if you like, you can list all of your input files in the linker
3048 script, and then invoke the linker with nothing but a @samp{-T} option.
3049
3050 In case a @dfn{sysroot prefix} is configured, and the filename starts
3051 with the @samp{/} character, and the script being processed was
3052 located inside the @dfn{sysroot prefix}, the filename will be looked
3053 for in the @dfn{sysroot prefix}.  Otherwise, the linker will try to
3054 open the file in the current directory.  If it is not found, the
3055 linker will search through the archive library search path.  See the
3056 description of @samp{-L} in @ref{Options,,Command Line Options}.
3057
3058 If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the
3059 name to @code{lib@var{file}.a}, as with the command line argument
3060 @samp{-l}.
3061
3062 When you use the @code{INPUT} command in an implicit linker script, the
3063 files will be included in the link at the point at which the linker
3064 script file is included.  This can affect archive searching.
3065
3066 @item GROUP(@var{file}, @var{file}, @dots{})
3067 @itemx GROUP(@var{file} @var{file} @dots{})
3068 @kindex GROUP(@var{files})
3069 @cindex grouping input files
3070 The @code{GROUP} command is like @code{INPUT}, except that the named
3071 files should all be archives, and they are searched repeatedly until no
3072 new undefined references are created.  See the description of @samp{-(}
3073 in @ref{Options,,Command Line Options}.
3074
3075 @item AS_NEEDED(@var{file}, @var{file}, @dots{})
3076 @itemx AS_NEEDED(@var{file} @var{file} @dots{})
3077 @kindex AS_NEEDED(@var{files})
3078 This construct can appear only inside of the @code{INPUT} or @code{GROUP}
3079 commands, among other filenames.  The files listed will be handled
3080 as if they appear directly in the @code{INPUT} or @code{GROUP} commands,
3081 with the exception of ELF shared libraries, that will be added only
3082 when they are actually needed.  This construct essentially enables
3083 @option{--as-needed} option for all the files listed inside of it
3084 and restores previous @option{--as-needed} resp. @option{--no-as-needed}
3085 setting afterwards.
3086
3087 @item OUTPUT(@var{filename})
3088 @kindex OUTPUT(@var{filename})
3089 @cindex output file name in linker script
3090 The @code{OUTPUT} command names the output file.  Using
3091 @code{OUTPUT(@var{filename})} in the linker script is exactly like using
3092 @samp{-o @var{filename}} on the command line (@pxref{Options,,Command
3093 Line Options}).  If both are used, the command line option takes
3094 precedence.
3095
3096 You can use the @code{OUTPUT} command to define a default name for the
3097 output file other than the usual default of @file{a.out}.
3098
3099 @item SEARCH_DIR(@var{path})
3100 @kindex SEARCH_DIR(@var{path})
3101 @cindex library search path in linker script
3102 @cindex archive search path in linker script
3103 @cindex search path in linker script
3104 The @code{SEARCH_DIR} command adds @var{path} to the list of paths where
3105 @command{ld} looks for archive libraries.  Using
3106 @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}}
3107 on the command line (@pxref{Options,,Command Line Options}).  If both
3108 are used, then the linker will search both paths.  Paths specified using
3109 the command line option are searched first.
3110
3111 @item STARTUP(@var{filename})
3112 @kindex STARTUP(@var{filename})
3113 @cindex first input file
3114 The @code{STARTUP} command is just like the @code{INPUT} command, except
3115 that @var{filename} will become the first input file to be linked, as
3116 though it were specified first on the command line.  This may be useful
3117 when using a system in which the entry point is always the start of the
3118 first file.
3119 @end table
3120
3121 @ifclear SingleFormat
3122 @node Format Commands
3123 @subsection Commands Dealing with Object File Formats
3124 A couple of linker script commands deal with object file formats.
3125
3126 @table @code
3127 @item OUTPUT_FORMAT(@var{bfdname})
3128 @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little})
3129 @kindex OUTPUT_FORMAT(@var{bfdname})
3130 @cindex output file format in linker script
3131 The @code{OUTPUT_FORMAT} command names the BFD format to use for the
3132 output file (@pxref{BFD}).  Using @code{OUTPUT_FORMAT(@var{bfdname})} is
3133 exactly like using @samp{--oformat @var{bfdname}} on the command line
3134 (@pxref{Options,,Command Line Options}).  If both are used, the command
3135 line option takes precedence.
3136
3137 You can use @code{OUTPUT_FORMAT} with three arguments to use different
3138 formats based on the @samp{-EB} and @samp{-EL} command line options.
3139 This permits the linker script to set the output format based on the
3140 desired endianness.
3141
3142 If neither @samp{-EB} nor @samp{-EL} are used, then the output format
3143 will be the first argument, @var{default}.  If @samp{-EB} is used, the
3144 output format will be the second argument, @var{big}.  If @samp{-EL} is
3145 used, the output format will be the third argument, @var{little}.
3146
3147 For example, the default linker script for the MIPS ELF target uses this
3148 command:
3149 @smallexample
3150 OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
3151 @end smallexample
3152 This says that the default format for the output file is
3153 @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line
3154 option, the output file will be created in the @samp{elf32-littlemips}
3155 format.
3156
3157 @item TARGET(@var{bfdname})
3158 @kindex TARGET(@var{bfdname})
3159 @cindex input file format in linker script
3160 The @code{TARGET} command names the BFD format to use when reading input
3161 files.  It affects subsequent @code{INPUT} and @code{GROUP} commands.
3162 This command is like using @samp{-b @var{bfdname}} on the command line
3163 (@pxref{Options,,Command Line Options}).  If the @code{TARGET} command
3164 is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET}
3165 command is also used to set the format for the output file.  @xref{BFD}.
3166 @end table
3167 @end ifclear
3168
3169 @node REGION_ALIAS
3170 @subsection Assign alias names to memory regions
3171 @kindex REGION_ALIAS(@var{alias}, @var{region})
3172 @cindex region alias
3173 @cindex region names
3174
3175 Alias names can be added to existing memory regions created with the
3176 @ref{MEMORY} command.  Each name corresponds to at most one memory region.
3177
3178 @smallexample
3179 REGION_ALIAS(@var{alias}, @var{region})
3180 @end smallexample
3181
3182 The @code{REGION_ALIAS} function creates an alias name @var{alias} for the
3183 memory region @var{region}.  This allows a flexible mapping of output sections
3184 to memory regions.  An example follows.
3185
3186 Suppose we have an application for embedded systems which come with various
3187 memory storage devices.  All have a general purpose, volatile memory @code{RAM}
3188 that allows code execution or data storage.  Some may have a read-only,
3189 non-volatile memory @code{ROM} that allows code execution and read-only data
3190 access.  The last variant is a read-only, non-volatile memory @code{ROM2} with
3191 read-only data access and no code execution capability.  We have four output
3192 sections:
3193
3194 @itemize @bullet
3195 @item
3196 @code{.text} program code;
3197 @item
3198 @code{.rodata} read-only data;
3199 @item
3200 @code{.data} read-write initialized data;
3201 @item
3202 @code{.bss} read-write zero initialized data.
3203 @end itemize
3204
3205 The goal is to provide a linker command file that contains a system independent
3206 part defining the output sections and a system dependent part mapping the
3207 output sections to the memory regions available on the system.  Our embedded
3208 systems come with three different memory setups @code{A}, @code{B} and
3209 @code{C}:
3210 @multitable @columnfractions .25 .25 .25 .25
3211 @item Section @tab Variant A @tab Variant B @tab Variant C
3212 @item .text @tab RAM @tab ROM @tab ROM
3213 @item .rodata @tab RAM @tab ROM @tab ROM2
3214 @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2
3215 @item .bss @tab RAM @tab RAM @tab RAM
3216 @end multitable
3217 The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is
3218 loaded into region @code{ROM} or @code{ROM2} respectively.  Please note that
3219 the load address of the @code{.data} section starts in all three variants at
3220 the end of the @code{.rodata} section.
3221
3222 The base linker script that deals with the output sections follows.  It
3223 includes the system dependent @code{linkcmds.memory} file that describes the
3224 memory layout:
3225 @smallexample
3226 INCLUDE linkcmds.memory
3227
3228 SECTIONS
3229   @{
3230     .text :
3231       @{
3232         *(.text)
3233       @} > REGION_TEXT
3234     .rodata :
3235       @{
3236         *(.rodata)
3237         rodata_end = .;
3238       @} > REGION_RODATA
3239     .data : AT (rodata_end)
3240       @{
3241         data_start = .;
3242         *(.data)
3243       @} > REGION_DATA
3244     data_size = SIZEOF(.data);
3245     data_load_start = LOADADDR(.data);
3246     .bss :
3247       @{
3248         *(.bss)
3249       @} > REGION_BSS
3250   @}
3251 @end smallexample
3252
3253 Now we need three different @code{linkcmds.memory} files to define memory
3254 regions and alias names.  The content of @code{linkcmds.memory} for the three
3255 variants @code{A}, @code{B} and @code{C}:
3256 @table @code
3257 @item A
3258 Here everything goes into the @code{RAM}.
3259 @smallexample
3260 MEMORY
3261   @{
3262     RAM : ORIGIN = 0, LENGTH = 4M
3263   @}
3264
3265 REGION_ALIAS("REGION_TEXT", RAM);
3266 REGION_ALIAS("REGION_RODATA", RAM);
3267 REGION_ALIAS("REGION_DATA", RAM);
3268 REGION_ALIAS("REGION_BSS", RAM);
3269 @end smallexample
3270 @item B
3271 Program code and read-only data go into the @code{ROM}.  Read-write data goes
3272 into the @code{RAM}.  An image of the initialized data is loaded into the
3273 @code{ROM} and will be copied during system start into the @code{RAM}.
3274 @smallexample
3275 MEMORY
3276   @{
3277     ROM : ORIGIN = 0, LENGTH = 3M
3278     RAM : ORIGIN = 0x10000000, LENGTH = 1M
3279   @}
3280
3281 REGION_ALIAS("REGION_TEXT", ROM);
3282 REGION_ALIAS("REGION_RODATA", ROM);
3283 REGION_ALIAS("REGION_DATA", RAM);
3284 REGION_ALIAS("REGION_BSS", RAM);
3285 @end smallexample
3286 @item C
3287 Program code goes into the @code{ROM}.  Read-only data goes into the
3288 @code{ROM2}.  Read-write data goes into the @code{RAM}.  An image of the
3289 initialized data is loaded into the @code{ROM2} and will be copied during
3290 system start into the @code{RAM}.
3291 @smallexample
3292 MEMORY
3293   @{
3294     ROM : ORIGIN = 0, LENGTH = 2M
3295     ROM2 : ORIGIN = 0x10000000, LENGTH = 1M
3296     RAM : ORIGIN = 0x20000000, LENGTH = 1M
3297   @}
3298
3299 REGION_ALIAS("REGION_TEXT", ROM);
3300 REGION_ALIAS("REGION_RODATA", ROM2);
3301 REGION_ALIAS("REGION_DATA", RAM);
3302 REGION_ALIAS("REGION_BSS", RAM);
3303 @end smallexample
3304 @end table
3305
3306 It is possible to write a common system initialization routine to copy the
3307 @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if
3308 necessary:
3309 @smallexample
3310 #include <string.h>
3311
3312 extern char data_start [];
3313 extern char data_size [];
3314 extern char data_load_start [];
3315
3316 void copy_data(void)
3317 @{
3318   if (data_start != data_load_start)
3319     @{
3320       memcpy(data_start, data_load_start, (size_t) data_size);
3321     @}
3322 @}
3323 @end smallexample
3324
3325 @node Miscellaneous Commands
3326 @subsection Other Linker Script Commands
3327 There are a few other linker scripts commands.
3328
3329 @table @code
3330 @item ASSERT(@var{exp}, @var{message})
3331 @kindex ASSERT
3332 @cindex assertion in linker script
3333 Ensure that @var{exp} is non-zero.  If it is zero, then exit the linker
3334 with an error code, and print @var{message}.
3335
3336 @item EXTERN(@var{symbol} @var{symbol} @dots{})
3337 @kindex EXTERN
3338 @cindex undefined symbol in linker script
3339 Force @var{symbol} to be entered in the output file as an undefined
3340 symbol.  Doing this may, for example, trigger linking of additional
3341 modules from standard libraries.  You may list several @var{symbol}s for
3342 each @code{EXTERN}, and you may use @code{EXTERN} multiple times.  This
3343 command has the same effect as the @samp{-u} command-line option.
3344
3345 @item FORCE_COMMON_ALLOCATION
3346 @kindex FORCE_COMMON_ALLOCATION
3347 @cindex common allocation in linker script
3348 This command has the same effect as the @samp{-d} command-line option:
3349 to make @command{ld} assign space to common symbols even if a relocatable
3350 output file is specified (@samp{-r}).
3351
3352 @item INHIBIT_COMMON_ALLOCATION
3353 @kindex INHIBIT_COMMON_ALLOCATION
3354 @cindex common allocation in linker script
3355 This command has the same effect as the @samp{--no-define-common}
3356 command-line option: to make @code{ld} omit the assignment of addresses
3357 to common symbols even for a non-relocatable output file.
3358
3359 @item INSERT [ AFTER | BEFORE ] @var{output_section}
3360 @kindex INSERT
3361 @cindex insert user script into default script
3362 This command is typically used in a script specified by @samp{-T} to
3363 augment the default @code{SECTIONS} with, for example, overlays.  It
3364 inserts all prior linker script statements after (or before)
3365 @var{output_section}, and also causes @samp{-T} to not override the
3366 default linker script.  The exact insertion point is as for orphan
3367 sections.  @xref{Location Counter}.  The insertion happens after the
3368 linker has mapped input sections to output sections.  Prior to the
3369 insertion, since @samp{-T} scripts are parsed before the default
3370 linker script, statements in the @samp{-T} script occur before the
3371 default linker script statements in the internal linker representation
3372 of the script.  In particular, input section assignments will be made
3373 to @samp{-T} output sections before those in the default script.  Here
3374 is an example of how a @samp{-T} script using @code{INSERT} might look:
3375
3376 @smallexample
3377 SECTIONS
3378 @{
3379   OVERLAY :
3380   @{
3381     .ov1 @{ ov1*(.text) @}
3382     .ov2 @{ ov2*(.text) @}
3383   @}
3384 @}
3385 INSERT AFTER .text;
3386 @end smallexample
3387
3388 @item NOCROSSREFS(@var{section} @var{section} @dots{})
3389 @kindex NOCROSSREFS(@var{sections})
3390 @cindex cross references
3391 This command may be used to tell @command{ld} to issue an error about any
3392 references among certain output sections.
3393
3394 In certain types of programs, particularly on embedded systems when
3395 using overlays, when one section is loaded into memory, another section
3396 will not be.  Any direct references between the two sections would be
3397 errors.  For example, it would be an error if code in one section called
3398 a function defined in the other section.
3399
3400 The @code{NOCROSSREFS} command takes a list of output section names.  If
3401 @command{ld} detects any cross references between the sections, it reports
3402 an error and returns a non-zero exit status.  Note that the
3403 @code{NOCROSSREFS} command uses output section names, not input section
3404 names.
3405
3406 @ifclear SingleFormat
3407 @item OUTPUT_ARCH(@var{bfdarch})
3408 @kindex OUTPUT_ARCH(@var{bfdarch})
3409 @cindex machine architecture
3410 @cindex architecture
3411 Specify a particular output machine architecture.  The argument is one
3412 of the names used by the BFD library (@pxref{BFD}).  You can see the
3413 architecture of an object file by using the @code{objdump} program with
3414 the @samp{-f} option.
3415 @end ifclear
3416
3417 @item LD_FEATURE(@var{string})
3418 @kindex LD_FEATURE(@var{string})
3419 This command may be used to modify @command{ld} behavior.  If
3420 @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers
3421 in a script are simply treated as numbers everywhere.
3422 @xref{Expression Section}.
3423 @end table
3424
3425 @node Assignments
3426 @section Assigning Values to Symbols
3427 @cindex assignment in scripts
3428 @cindex symbol definition, scripts
3429 @cindex variables, defining
3430 You may assign a value to a symbol in a linker script.  This will define
3431 the symbol and place it into the symbol table with a global scope.
3432
3433 @menu
3434 * Simple Assignments::          Simple Assignments
3435 * HIDDEN::                      HIDDEN
3436 * PROVIDE::                     PROVIDE
3437 * PROVIDE_HIDDEN::              PROVIDE_HIDDEN
3438 * Source Code Reference::       How to use a linker script defined symbol in source code
3439 @end menu
3440
3441 @node Simple Assignments
3442 @subsection Simple Assignments
3443
3444 You may assign to a symbol using any of the C assignment operators:
3445
3446 @table @code
3447 @item @var{symbol} = @var{expression} ;
3448 @itemx @var{symbol} += @var{expression} ;
3449 @itemx @var{symbol} -= @var{expression} ;
3450 @itemx @var{symbol} *= @var{expression} ;
3451 @itemx @var{symbol} /= @var{expression} ;
3452 @itemx @var{symbol} <<= @var{expression} ;
3453 @itemx @var{symbol} >>= @var{expression} ;
3454 @itemx @var{symbol} &= @var{expression} ;
3455 @itemx @var{symbol} |= @var{expression} ;
3456 @end table
3457
3458 The first case will define @var{symbol} to the value of
3459 @var{expression}.  In the other cases, @var{symbol} must already be
3460 defined, and the value will be adjusted accordingly.
3461
3462 The special symbol name @samp{.} indicates the location counter.  You
3463 may only use this within a @code{SECTIONS} command.  @xref{Location Counter}.
3464
3465 The semicolon after @var{expression} is required.
3466
3467 Expressions are defined below; see @ref{Expressions}.
3468
3469 You may write symbol assignments as commands in their own right, or as
3470 statements within a @code{SECTIONS} command, or as part of an output
3471 section description in a @code{SECTIONS} command.
3472
3473 The section of the symbol will be set from the section of the
3474 expression; for more information, see @ref{Expression Section}.
3475
3476 Here is an example showing the three different places that symbol
3477 assignments may be used:
3478
3479 @smallexample
3480 floating_point = 0;
3481 SECTIONS
3482 @{
3483   .text :
3484     @{
3485       *(.text)
3486       _etext = .;
3487     @}
3488   _bdata = (. + 3) & ~ 3;
3489   .data : @{ *(.data) @}
3490 @}
3491 @end smallexample
3492 @noindent
3493 In this example, the symbol @samp{floating_point} will be defined as
3494 zero.  The symbol @samp{_etext} will be defined as the address following
3495 the last @samp{.text} input section.  The symbol @samp{_bdata} will be
3496 defined as the address following the @samp{.text} output section aligned
3497 upward to a 4 byte boundary.
3498
3499 @node HIDDEN
3500 @subsection HIDDEN
3501 @cindex HIDDEN
3502 For ELF targeted ports, define a symbol that will be hidden and won't be
3503 exported.  The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}.
3504
3505 Here is the example from @ref{Simple Assignments}, rewritten to use
3506 @code{HIDDEN}:
3507
3508 @smallexample
3509 HIDDEN(floating_point = 0);
3510 SECTIONS
3511 @{
3512   .text :
3513     @{
3514       *(.text)
3515       HIDDEN(_etext = .);
3516     @}
3517   HIDDEN(_bdata = (. + 3) & ~ 3);
3518   .data : @{ *(.data) @}
3519 @}
3520 @end smallexample
3521 @noindent
3522 In this case none of the three symbols will be visible outside this module.
3523
3524 @node PROVIDE
3525 @subsection PROVIDE
3526 @cindex PROVIDE
3527 In some cases, it is desirable for a linker script to define a symbol
3528 only if it is referenced and is not defined by any object included in
3529 the link.  For example, traditional linkers defined the symbol
3530 @samp{etext}.  However, ANSI C requires that the user be able to use
3531 @samp{etext} as a function name without encountering an error.  The
3532 @code{PROVIDE} keyword may be used to define a symbol, such as
3533 @samp{etext}, only if it is referenced but not defined.  The syntax is
3534 @code{PROVIDE(@var{symbol} = @var{expression})}.
3535
3536 Here is an example of using @code{PROVIDE} to define @samp{etext}:
3537 @smallexample
3538 SECTIONS
3539 @{
3540   .text :
3541     @{
3542       *(.text)
3543       _etext = .;
3544       PROVIDE(etext = .);
3545     @}
3546 @}
3547 @end smallexample
3548
3549 In this example, if the program defines @samp{_etext} (with a leading
3550 underscore), the linker will give a multiple definition error.  If, on
3551 the other hand, the program defines @samp{etext} (with no leading
3552 underscore), the linker will silently use the definition in the program.
3553 If the program references @samp{etext} but does not define it, the
3554 linker will use the definition in the linker script.
3555
3556 @node PROVIDE_HIDDEN
3557 @subsection PROVIDE_HIDDEN
3558 @cindex PROVIDE_HIDDEN
3559 Similar to @code{PROVIDE}.  For ELF targeted ports, the symbol will be
3560 hidden and won't be exported.
3561
3562 @node Source Code Reference
3563 @subsection Source Code Reference
3564
3565 Accessing a linker script defined variable from source code is not
3566 intuitive.  In particular a linker script symbol is not equivalent to
3567 a variable declaration in a high level language, it is instead a
3568 symbol that does not have a value.
3569
3570 Before going further, it is important to note that compilers often
3571 transform names in the source code into different names when they are
3572 stored in the symbol table.  For example, Fortran compilers commonly
3573 prepend or append an underscore, and C++ performs extensive @samp{name
3574 mangling}.  Therefore there might be a discrepancy between the name
3575 of a variable as it is used in source code and the name of the same
3576 variable as it is defined in a linker script.  For example in C a
3577 linker script variable might be referred to as:
3578
3579 @smallexample
3580   extern int foo;
3581 @end smallexample
3582
3583 But in the linker script it might be defined as:
3584
3585 @smallexample
3586   _foo = 1000;
3587 @end smallexample
3588
3589 In the remaining examples however it is assumed that no name
3590 transformation has taken place.
3591
3592 When a symbol is declared in a high level language such as C, two
3593 things happen.  The first is that the compiler reserves enough space
3594 in the program's memory to hold the @emph{value} of the symbol.  The
3595 second is that the compiler creates an entry in the program's symbol
3596 table which holds the symbol's @emph{address}.  ie the symbol table
3597 contains the address of the block of memory holding the symbol's
3598 value.  So for example the following C declaration, at file scope:
3599
3600 @smallexample
3601   int foo = 1000;
3602 @end smallexample
3603
3604 creates a entry called @samp{foo} in the symbol table.  This entry
3605 holds the address of an @samp{int} sized block of memory where the
3606 number 1000 is initially stored.
3607
3608 When a program references a symbol the compiler generates code that
3609 first accesses the symbol table to find the address of the symbol's
3610 memory block and then code to read the value from that memory block.
3611 So:
3612
3613 @smallexample
3614   foo = 1;
3615 @end smallexample
3616
3617 looks up the symbol @samp{foo} in the symbol table, gets the address
3618 associated with this symbol and then writes the value 1 into that
3619 address.  Whereas:
3620
3621 @smallexample
3622   int * a = & foo;
3623 @end smallexample
3624
3625 looks up the symbol @samp{foo} in the symbol table, gets it address
3626 and then copies this address into the block of memory associated with
3627 the variable @samp{a}.
3628
3629 Linker scripts symbol declarations, by contrast, create an entry in
3630 the symbol table but do not assign any memory to them.  Thus they are
3631 an address without a value.  So for example the linker script definition:
3632
3633 @smallexample
3634   foo = 1000;
3635 @end smallexample
3636
3637 creates an entry in the symbol table called @samp{foo} which holds
3638 the address of memory location 1000, but nothing special is stored at
3639 address 1000.  This means that you cannot access the @emph{value} of a
3640 linker script defined symbol - it has no value - all you can do is
3641 access the @emph{address} of a linker script defined symbol.
3642
3643 Hence when you are using a linker script defined symbol in source code
3644 you should always take the address of the symbol, and never attempt to
3645 use its value.  For example suppose you want to copy the contents of a
3646 section of memory called .ROM into a section called .FLASH and the
3647 linker script contains these declarations:
3648
3649 @smallexample
3650 @group
3651   start_of_ROM   = .ROM;
3652   end_of_ROM     = .ROM + sizeof (.ROM) - 1;
3653   start_of_FLASH = .FLASH;
3654 @end group
3655 @end smallexample
3656
3657 Then the C source code to perform the copy would be:
3658
3659 @smallexample
3660 @group
3661   extern char start_of_ROM, end_of_ROM, start_of_FLASH;
3662
3663   memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
3664 @end group
3665 @end smallexample
3666
3667 Note the use of the @samp{&} operators.  These are correct.
3668
3669 @node SECTIONS
3670 @section SECTIONS Command
3671 @kindex SECTIONS
3672 The @code{SECTIONS} command tells the linker how to map input sections
3673 into output sections, and how to place the output sections in memory.
3674
3675 The format of the @code{SECTIONS} command is:
3676 @smallexample
3677 SECTIONS
3678 @{
3679   @var{sections-command}
3680   @var{sections-command}
3681   @dots{}
3682 @}
3683 @end smallexample
3684
3685 Each @var{sections-command} may of be one of the following:
3686
3687 @itemize @bullet
3688 @item
3689 an @code{ENTRY} command (@pxref{Entry Point,,Entry command})
3690 @item
3691 a symbol assignment (@pxref{Assignments})
3692 @item
3693 an output section description
3694 @item
3695 an overlay description
3696 @end itemize
3697
3698 The @code{ENTRY} command and symbol assignments are permitted inside the
3699 @code{SECTIONS} command for convenience in using the location counter in
3700 those commands.  This can also make the linker script easier to
3701 understand because you can use those commands at meaningful points in
3702 the layout of the output file.
3703
3704 Output section descriptions and overlay descriptions are described
3705 below.
3706
3707 If you do not use a @code{SECTIONS} command in your linker script, the
3708 linker will place each input section into an identically named output
3709 section in the order that the sections are first encountered in the
3710 input files.  If all input sections are present in the first file, for
3711 example, the order of sections in the output file will match the order
3712 in the first input file.  The first section will be at address zero.
3713
3714 @menu
3715 * Output Section Description::  Output section description
3716 * Output Section Name::         Output section name
3717 * Output Section Address::      Output section address
3718 * Input Section::               Input section description
3719 * Output Section Data::         Output section data
3720 * Output Section Keywords::     Output section keywords
3721 * Output Section Discarding::   Output section discarding
3722 * Output Section Attributes::   Output section attributes
3723 * Overlay Description::         Overlay description
3724 @end menu
3725
3726 @node Output Section Description
3727 @subsection Output Section Description
3728 The full description of an output section looks like this:
3729 @smallexample
3730 @group
3731 @var{section} [@var{address}] [(@var{type})] :
3732   [AT(@var{lma})]
3733   [ALIGN(@var{section_align})]
3734   [SUBALIGN(@var{subsection_align})]
3735   [@var{constraint}]
3736   @{
3737     @var{output-section-command}
3738     @var{output-section-command}
3739     @dots{}
3740   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
3741 @end group
3742 @end smallexample
3743
3744 Most output sections do not use most of the optional section attributes.
3745
3746 The whitespace around @var{section} is required, so that the section
3747 name is unambiguous.  The colon and the curly braces are also required.
3748 The line breaks and other white space are optional.
3749
3750 Each @var{output-section-command} may be one of the following:
3751
3752 @itemize @bullet
3753 @item
3754 a symbol assignment (@pxref{Assignments})
3755 @item
3756 an input section description (@pxref{Input Section})
3757 @item
3758 data values to include directly (@pxref{Output Section Data})
3759 @item
3760 a special output section keyword (@pxref{Output Section Keywords})
3761 @end itemize
3762
3763 @node Output Section Name
3764 @subsection Output Section Name
3765 @cindex name, section
3766 @cindex section name
3767 The name of the output section is @var{section}.  @var{section} must
3768 meet the constraints of your output format.  In formats which only
3769 support a limited number of sections, such as @code{a.out}, the name
3770 must be one of the names supported by the format (@code{a.out}, for
3771 example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the
3772 output format supports any number of sections, but with numbers and not
3773 names (as is the case for Oasys), the name should be supplied as a
3774 quoted numeric string.  A section name may consist of any sequence of
3775 characters, but a name which contains any unusual characters such as
3776 commas must be quoted.
3777
3778 The output section name @samp{/DISCARD/} is special; @ref{Output Section
3779 Discarding}.
3780
3781 @node Output Section Address
3782 @subsection Output Section Address
3783 @cindex address, section
3784 @cindex section address
3785 The @var{address} is an expression for the VMA (the virtual memory
3786 address) of the output section.  This address is optional, but if it
3787 is provided then the output address will be set exactly as specified.
3788
3789 If the output address is not specified then one will be chosen for the
3790 section, based on the heuristic below.  This address will be adjusted
3791 to fit the alignment requirement of the output section.  The
3792 alignment requirement is the strictest alignment of any input section
3793 contained within the output section.
3794
3795 The output section address heuristic is as follows:
3796
3797 @itemize @bullet
3798 @item
3799 If an output memory @var{region} is set for the section then it
3800 is added to this region and its address will be the next free address
3801 in that region.
3802
3803 @item
3804 If the MEMORY command has been used to create a list of memory
3805 regions then the first region which has attributes compatible with the
3806 section is selected to contain it.  The section's output address will
3807 be the next free address in that region; @ref{MEMORY}.
3808
3809 @item
3810 If no memory regions were specified, or none match the section then
3811 the output address will be based on the current value of the location
3812 counter.
3813 @end itemize
3814
3815 @noindent
3816 For example:
3817
3818 @smallexample
3819 .text . : @{ *(.text) @}
3820 @end smallexample
3821
3822 @noindent
3823 and
3824
3825 @smallexample
3826 .text : @{ *(.text) @}
3827 @end smallexample
3828
3829 @noindent
3830 are subtly different.  The first will set the address of the
3831 @samp{.text} output section to the current value of the location
3832 counter.  The second will set it to the current value of the location
3833 counter aligned to the strictest alignment of any of the @samp{.text}
3834 input sections.
3835
3836 The @var{address} may be an arbitrary expression; @ref{Expressions}.
3837 For example, if you want to align the section on a 0x10 byte boundary,
3838 so that the lowest four bits of the section address are zero, you could
3839 do something like this:
3840 @smallexample
3841 .text ALIGN(0x10) : @{ *(.text) @}
3842 @end smallexample
3843 @noindent
3844 This works because @code{ALIGN} returns the current location counter
3845 aligned upward to the specified value.
3846
3847 Specifying @var{address} for a section will change the value of the
3848 location counter, provided that the section is non-empty.  (Empty
3849 sections are ignored).
3850
3851 @node Input Section
3852 @subsection Input Section Description
3853 @cindex input sections
3854 @cindex mapping input sections to output sections
3855 The most common output section command is an input section description.
3856
3857 The input section description is the most basic linker script operation.
3858 You use output sections to tell the linker how to lay out your program
3859 in memory.  You use input section descriptions to tell the linker how to
3860 map the input files into your memory layout.
3861
3862 @menu
3863 * Input Section Basics::        Input section basics
3864 * Input Section Wildcards::     Input section wildcard patterns
3865 * Input Section Common::        Input section for common symbols
3866 * Input Section Keep::          Input section and garbage collection
3867 * Input Section Example::       Input section example
3868 @end menu
3869
3870 @node Input Section Basics
3871 @subsubsection Input Section Basics
3872 @cindex input section basics
3873 An input section description consists of a file name optionally followed
3874 by a list of section names in parentheses.
3875
3876 The file name and the section name may be wildcard patterns, which we
3877 describe further below (@pxref{Input Section Wildcards}).
3878
3879 The most common input section description is to include all input
3880 sections with a particular name in the output section.  For example, to
3881 include all input @samp{.text} sections, you would write:
3882 @smallexample
3883 *(.text)
3884 @end smallexample
3885 @noindent
3886 Here the @samp{*} is a wildcard which matches any file name.  To exclude a list
3887 of files from matching the file name wildcard, EXCLUDE_FILE may be used to
3888 match all files except the ones specified in the EXCLUDE_FILE list.  For
3889 example:
3890 @smallexample
3891 *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)
3892 @end smallexample
3893 will cause all .ctors sections from all files except @file{crtend.o} and
3894 @file{otherfile.o} to be included.
3895
3896 There are two ways to include more than one section:
3897 @smallexample
3898 *(.text .rdata)
3899 *(.text) *(.rdata)
3900 @end smallexample
3901 @noindent
3902 The difference between these is the order in which the @samp{.text} and
3903 @samp{.rdata} input sections will appear in the output section.  In the
3904 first example, they will be intermingled, appearing in the same order as
3905 they are found in the linker input.  In the second example, all
3906 @samp{.text} input sections will appear first, followed by all
3907 @samp{.rdata} input sections.
3908
3909 You can specify a file name to include sections from a particular file.
3910 You would do this if one or more of your files contain special data that
3911 needs to be at a particular location in memory.  For example:
3912 @smallexample
3913 data.o(.data)
3914 @end smallexample
3915
3916 To refine the sections that are included based on the section flags
3917 of an input section, INPUT_SECTION_FLAGS may be used.
3918
3919 Here is a simple example for using Section header flags for ELF sections:
3920
3921 @smallexample
3922 @group
3923 SECTIONS @{
3924   .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @}
3925   .text2 :  @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @}
3926 @}
3927 @end group
3928 @end smallexample
3929
3930 In this example, the output section @samp{.text} will be comprised of any
3931 input section matching the name *(.text) whose section header flags
3932 @code{SHF_MERGE} and @code{SHF_STRINGS} are set.  The output section
3933 @samp{.text2} will be comprised of any input section matching the name *(.text)
3934 whose section header flag @code{SHF_WRITE} is clear.
3935
3936 You can also specify files within archives by writing a pattern
3937 matching the archive, a colon, then the pattern matching the file,
3938 with no whitespace around the colon.
3939
3940 @table @samp
3941 @item archive:file
3942 matches file within archive
3943 @item archive:
3944 matches the whole archive
3945 @item :file
3946 matches file but not one in an archive
3947 @end table
3948
3949 Either one or both of @samp{archive} and @samp{file} can contain shell
3950 wildcards.  On DOS based file systems, the linker will assume that a
3951 single letter followed by a colon is a drive specifier, so
3952 @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o}
3953 within an archive called @samp{c}.  @samp{archive:file} filespecs may
3954 also be used within an @code{EXCLUDE_FILE} list, but may not appear in
3955 other linker script contexts.  For instance, you cannot extract a file
3956 from an archive by using @samp{archive:file} in an @code{INPUT}
3957 command.
3958
3959 If you use a file name without a list of sections, then all sections in
3960 the input file will be included in the output section.  This is not
3961 commonly done, but it may by useful on occasion.  For example:
3962 @smallexample
3963 data.o
3964 @end smallexample
3965
3966 When you use a file name which is not an @samp{archive:file} specifier
3967 and does not contain any wild card
3968 characters, the linker will first see if you also specified the file
3969 name on the linker command line or in an @code{INPUT} command.  If you
3970 did not, the linker will attempt to open the file as an input file, as
3971 though it appeared on the command line.  Note that this differs from an
3972 @code{INPUT} command, because the linker will not search for the file in
3973 the archive search path.
3974
3975 @node Input Section Wildcards
3976 @subsubsection Input Section Wildcard Patterns
3977 @cindex input section wildcards
3978 @cindex wildcard file name patterns
3979 @cindex file name wildcard patterns
3980 @cindex section name wildcard patterns
3981 In an input section description, either the file name or the section
3982 name or both may be wildcard patterns.
3983
3984 The file name of @samp{*} seen in many examples is a simple wildcard
3985 pattern for the file name.
3986
3987 The wildcard patterns are like those used by the Unix shell.
3988
3989 @table @samp
3990 @item *
3991 matches any number of characters
3992 @item ?
3993 matches any single character
3994 @item [@var{chars}]
3995 matches a single instance of any of the @var{chars}; the @samp{-}
3996 character may be used to specify a range of characters, as in
3997 @samp{[a-z]} to match any lower case letter
3998 @item \
3999 quotes the following character
4000 @end table
4001
4002 When a file name is matched with a wildcard, the wildcard characters
4003 will not match a @samp{/} character (used to separate directory names on
4004 Unix).  A pattern consisting of a single @samp{*} character is an
4005 exception; it will always match any file name, whether it contains a
4006 @samp{/} or not.  In a section name, the wildcard characters will match
4007 a @samp{/} character.
4008
4009 File name wildcard patterns only match files which are explicitly
4010 specified on the command line or in an @code{INPUT} command.  The linker
4011 does not search directories to expand wildcards.
4012
4013 If a file name matches more than one wildcard pattern, or if a file name
4014 appears explicitly and is also matched by a wildcard pattern, the linker
4015 will use the first match in the linker script.  For example, this
4016 sequence of input section descriptions is probably in error, because the
4017 @file{data.o} rule will not be used:
4018 @smallexample
4019 .data : @{ *(.data) @}
4020 .data1 : @{ data.o(.data) @}
4021 @end smallexample
4022
4023 @cindex SORT_BY_NAME
4024 Normally, the linker will place files and sections matched by wildcards
4025 in the order in which they are seen during the link.  You can change
4026 this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard
4027 pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}).  When the
4028 @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections
4029 into ascending order by name before placing them in the output file.
4030
4031 @cindex SORT_BY_ALIGNMENT
4032 @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The
4033 difference is @code{SORT_BY_ALIGNMENT} will sort sections into
4034 ascending order by alignment before placing them in the output file.
4035
4036 @cindex SORT_BY_INIT_PRIORITY
4037 @code{SORT_BY_INIT_PRIORITY} is very similar to @code{SORT_BY_NAME}. The
4038 difference is @code{SORT_BY_INIT_PRIORITY} will sort sections into
4039 ascending order by numerical value of the GCC init_priority attribute
4040 encoded in the section name before placing them in the output file.
4041
4042 @cindex SORT
4043 @code{SORT} is an alias for @code{SORT_BY_NAME}.
4044
4045 When there are nested section sorting commands in linker script, there
4046 can be at most 1 level of nesting for section sorting commands.
4047
4048 @enumerate
4049 @item
4050 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4051 It will sort the input sections by name first, then by alignment if 2
4052 sections have the same name.
4053 @item
4054 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4055 It will sort the input sections by alignment first, then by name if 2
4056 sections have the same alignment.
4057 @item
4058 @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is
4059 treated the same as @code{SORT_BY_NAME} (wildcard section pattern).
4060 @item
4061 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern))
4062 is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern).
4063 @item
4064 All other nested section sorting commands are invalid.
4065 @end enumerate
4066
4067 When both command line section sorting option and linker script
4068 section sorting command are used, section sorting command always
4069 takes precedence over the command line option.
4070
4071 If the section sorting command in linker script isn't nested, the
4072 command line option will make the section sorting command to be
4073 treated as nested sorting command.
4074
4075 @enumerate
4076 @item
4077 @code{SORT_BY_NAME} (wildcard section pattern ) with
4078 @option{--sort-sections alignment} is equivalent to
4079 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4080 @item
4081 @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with
4082 @option{--sort-section name} is equivalent to
4083 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4084 @end enumerate
4085
4086 If the section sorting command in linker script is nested, the
4087 command line option will be ignored.
4088
4089 @cindex SORT_NONE
4090 @code{SORT_NONE} disables section sorting by ignoring the command line
4091 section sorting option.
4092
4093 If you ever get confused about where input sections are going, use the
4094 @samp{-M} linker option to generate a map file.  The map file shows
4095 precisely how input sections are mapped to output sections.
4096
4097 This example shows how wildcard patterns might be used to partition
4098 files.  This linker script directs the linker to place all @samp{.text}
4099 sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}.
4100 The linker will place the @samp{.data} section from all files beginning
4101 with an upper case character in @samp{.DATA}; for all other files, the
4102 linker will place the @samp{.data} section in @samp{.data}.
4103 @smallexample
4104 @group
4105 SECTIONS @{
4106   .text : @{ *(.text) @}
4107   .DATA : @{ [A-Z]*(.data) @}
4108   .data : @{ *(.data) @}
4109   .bss : @{ *(.bss) @}
4110 @}
4111 @end group
4112 @end smallexample
4113
4114 @node Input Section Common
4115 @subsubsection Input Section for Common Symbols
4116 @cindex common symbol placement
4117 @cindex uninitialized data placement
4118 A special notation is needed for common symbols, because in many object
4119 file formats common symbols do not have a particular input section.  The
4120 linker treats common symbols as though they are in an input section
4121 named @samp{COMMON}.
4122
4123 You may use file names with the @samp{COMMON} section just as with any
4124 other input sections.  You can use this to place common symbols from a
4125 particular input file in one section while common symbols from other
4126 input files are placed in another section.
4127
4128 In most cases, common symbols in input files will be placed in the
4129 @samp{.bss} section in the output file.  For example:
4130 @smallexample
4131 .bss @{ *(.bss) *(COMMON) @}
4132 @end smallexample
4133
4134 @cindex scommon section
4135 @cindex small common symbols
4136 Some object file formats have more than one type of common symbol.  For
4137 example, the MIPS ELF object file format distinguishes standard common
4138 symbols and small common symbols.  In this case, the linker will use a
4139 different special section name for other types of common symbols.  In
4140 the case of MIPS ELF, the linker uses @samp{COMMON} for standard common
4141 symbols and @samp{.scommon} for small common symbols.  This permits you
4142 to map the different types of common symbols into memory at different
4143 locations.
4144
4145 @cindex [COMMON]
4146 You will sometimes see @samp{[COMMON]} in old linker scripts.  This
4147 notation is now considered obsolete.  It is equivalent to
4148 @samp{*(COMMON)}.
4149
4150 @node Input Section Keep
4151 @subsubsection Input Section and Garbage Collection
4152 @cindex KEEP
4153 @cindex garbage collection
4154 When link-time garbage collection is in use (@samp{--gc-sections}),
4155 it is often useful to mark sections that should not be eliminated.
4156 This is accomplished by surrounding an input section's wildcard entry
4157 with @code{KEEP()}, as in @code{KEEP(*(.init))} or
4158 @code{KEEP(SORT_BY_NAME(*)(.ctors))}.
4159
4160 @node Input Section Example
4161 @subsubsection Input Section Example
4162 The following example is a complete linker script.  It tells the linker
4163 to read all of the sections from file @file{all.o} and place them at the
4164 start of output section @samp{outputa} which starts at location
4165 @samp{0x10000}.  All of section @samp{.input1} from file @file{foo.o}
4166 follows immediately, in the same output section.  All of section
4167 @samp{.input2} from @file{foo.o} goes into output section
4168 @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}.
4169 All of the remaining @samp{.input1} and @samp{.input2} sections from any
4170 files are written to output section @samp{outputc}.
4171
4172 @smallexample
4173 @group
4174 SECTIONS @{
4175   outputa 0x10000 :
4176     @{
4177     all.o
4178     foo.o (.input1)
4179     @}
4180 @end group
4181 @group
4182   outputb :
4183     @{
4184     foo.o (.input2)
4185     foo1.o (.input1)
4186     @}
4187 @end group
4188 @group
4189   outputc :
4190     @{
4191     *(.input1)
4192     *(.input2)
4193     @}
4194 @}
4195 @end group
4196 @end smallexample
4197
4198 @node Output Section Data
4199 @subsection Output Section Data
4200 @cindex data
4201 @cindex section data
4202 @cindex output section data
4203 @kindex BYTE(@var{expression})
4204 @kindex SHORT(@var{expression})
4205 @kindex LONG(@var{expression})
4206 @kindex QUAD(@var{expression})
4207 @kindex SQUAD(@var{expression})
4208 You can include explicit bytes of data in an output section by using
4209 @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as
4210 an output section command.  Each keyword is followed by an expression in
4211 parentheses providing the value to store (@pxref{Expressions}).  The
4212 value of the expression is stored at the current value of the location
4213 counter.
4214
4215 The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands
4216 store one, two, four, and eight bytes (respectively).  After storing the
4217 bytes, the location counter is incremented by the number of bytes
4218 stored.
4219
4220 For example, this will store the byte 1 followed by the four byte value
4221 of the symbol @samp{addr}:
4222 @smallexample
4223 BYTE(1)
4224 LONG(addr)
4225 @end smallexample
4226
4227 When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the
4228 same; they both store an 8 byte, or 64 bit, value.  When both host and
4229 target are 32 bits, an expression is computed as 32 bits.  In this case
4230 @code{QUAD} stores a 32 bit value zero extended to 64 bits, and
4231 @code{SQUAD} stores a 32 bit value sign extended to 64 bits.
4232
4233 If the object file format of the output file has an explicit endianness,
4234 which is the normal case, the value will be stored in that endianness.
4235 When the object file format does not have an explicit endianness, as is
4236 true of, for example, S-records, the value will be stored in the
4237 endianness of the first input object file.
4238
4239 Note---these commands only work inside a section description and not
4240 between them, so the following will produce an error from the linker:
4241 @smallexample
4242 SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
4243 @end smallexample
4244 whereas this will work:
4245 @smallexample
4246 SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@
4247 @end smallexample
4248
4249 @kindex FILL(@var{expression})
4250 @cindex holes, filling
4251 @cindex unspecified memory
4252 You may use the @code{FILL} command to set the fill pattern for the
4253 current section.  It is followed by an expression in parentheses.  Any
4254 otherwise unspecified regions of memory within the section (for example,
4255 gaps left due to the required alignment of input sections) are filled
4256 with the value of the expression, repeated as
4257 necessary.  A @code{FILL} statement covers memory locations after the
4258 point at which it occurs in the section definition; by including more
4259 than one @code{FILL} statement, you can have different fill patterns in
4260 different parts of an output section.
4261
4262 This example shows how to fill unspecified regions of memory with the
4263 value @samp{0x90}:
4264 @smallexample
4265 FILL(0x90909090)
4266 @end smallexample
4267
4268 The @code{FILL} command is similar to the @samp{=@var{fillexp}} output
4269 section attribute, but it only affects the
4270 part of the section following the @code{FILL} command, rather than the
4271 entire section.  If both are used, the @code{FILL} command takes
4272 precedence.  @xref{Output Section Fill}, for details on the fill
4273 expression.
4274
4275 @node Output Section Keywords
4276 @subsection Output Section Keywords
4277 There are a couple of keywords which can appear as output section
4278 commands.
4279
4280 @table @code
4281 @kindex CREATE_OBJECT_SYMBOLS
4282 @cindex input filename symbols
4283 @cindex filename symbols
4284 @item CREATE_OBJECT_SYMBOLS
4285 The command tells the linker to create a symbol for each input file.
4286 The name of each symbol will be the name of the corresponding input
4287 file.  The section of each symbol will be the output section in which
4288 the @code{CREATE_OBJECT_SYMBOLS} command appears.
4289
4290 This is conventional for the a.out object file format.  It is not
4291 normally used for any other object file format.
4292
4293 @kindex CONSTRUCTORS
4294 @cindex C++ constructors, arranging in link
4295 @cindex constructors, arranging in link
4296 @item CONSTRUCTORS
4297 When linking using the a.out object file format, the linker uses an
4298 unusual set construct to support C++ global constructors and
4299 destructors.  When linking object file formats which do not support
4300 arbitrary sections, such as ECOFF and XCOFF, the linker will
4301 automatically recognize C++ global constructors and destructors by name.
4302 For these object file formats, the @code{CONSTRUCTORS} command tells the
4303 linker to place constructor information in the output section where the
4304 @code{CONSTRUCTORS} command appears.  The @code{CONSTRUCTORS} command is
4305 ignored for other object file formats.
4306
4307 The symbol @w{@code{__CTOR_LIST__}} marks the start of the global
4308 constructors, and the symbol @w{@code{__CTOR_END__}} marks the end.
4309 Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark
4310 the start and end of the global destructors.  The
4311 first word in the list is the number of entries, followed by the address
4312 of each constructor or destructor, followed by a zero word.  The
4313 compiler must arrange to actually run the code.  For these object file
4314 formats @sc{gnu} C++ normally calls constructors from a subroutine
4315 @code{__main}; a call to @code{__main} is automatically inserted into
4316 the startup code for @code{main}.  @sc{gnu} C++ normally runs
4317 destructors either by using @code{atexit}, or directly from the function
4318 @code{exit}.
4319
4320 For object file formats such as @code{COFF} or @code{ELF} which support
4321 arbitrary section names, @sc{gnu} C++ will normally arrange to put the
4322 addresses of global constructors and destructors into the @code{.ctors}
4323 and @code{.dtors} sections.  Placing the following sequence into your
4324 linker script will build the sort of table which the @sc{gnu} C++
4325 runtime code expects to see.
4326
4327 @smallexample
4328       __CTOR_LIST__ = .;
4329       LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2)
4330       *(.ctors)
4331       LONG(0)
4332       __CTOR_END__ = .;
4333       __DTOR_LIST__ = .;
4334       LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2)
4335       *(.dtors)
4336       LONG(0)
4337       __DTOR_END__ = .;
4338 @end smallexample
4339
4340 If you are using the @sc{gnu} C++ support for initialization priority,
4341 which provides some control over the order in which global constructors
4342 are run, you must sort the constructors at link time to ensure that they
4343 are executed in the correct order.  When using the @code{CONSTRUCTORS}
4344 command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead.  When using the
4345 @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and
4346 @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and
4347 @samp{*(.dtors)}.
4348
4349 Normally the compiler and linker will handle these issues automatically,
4350 and you will not need to concern yourself with them.  However, you may
4351 need to consider this if you are using C++ and writing your own linker
4352 scripts.
4353
4354 @end table
4355
4356 @node Output Section Discarding
4357 @subsection Output Section Discarding
4358 @cindex discarding sections
4359 @cindex sections, discarding
4360 @cindex removing sections
4361 The linker will not create output sections with no contents.  This is
4362 for convenience when referring to input sections that may or may not
4363 be present in any of the input files.  For example:
4364 @smallexample
4365 .foo : @{ *(.foo) @}
4366 @end smallexample
4367 @noindent
4368 will only create a @samp{.foo} section in the output file if there is a
4369 @samp{.foo} section in at least one input file, and if the input
4370 sections are not all empty.  Other link script directives that allocate
4371 space in an output section will also create the output section.
4372
4373 The linker will ignore address assignments (@pxref{Output Section Address})
4374 on discarded output sections, except when the linker script defines
4375 symbols in the output section.  In that case the linker will obey
4376 the address assignments, possibly advancing dot even though the
4377 section is discarded.
4378
4379 @cindex /DISCARD/
4380 The special output section name @samp{/DISCARD/} may be used to discard
4381 input sections.  Any input sections which are assigned to an output
4382 section named @samp{/DISCARD/} are not included in the output file.
4383
4384 @node Output Section Attributes
4385 @subsection Output Section Attributes
4386 @cindex output section attributes
4387 We showed above that the full description of an output section looked
4388 like this:
4389
4390 @smallexample
4391 @group
4392 @var{section} [@var{address}] [(@var{type})] :
4393   [AT(@var{lma})]
4394   [ALIGN(@var{section_align})]
4395   [SUBALIGN(@var{subsection_align})]
4396   [@var{constraint}]
4397   @{
4398     @var{output-section-command}
4399     @var{output-section-command}
4400     @dots{}
4401   @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
4402 @end group
4403 @end smallexample
4404
4405 We've already described @var{section}, @var{address}, and
4406 @var{output-section-command}.  In this section we will describe the
4407 remaining section attributes.
4408
4409 @menu
4410 * Output Section Type::         Output section type
4411 * Output Section LMA::          Output section LMA
4412 * Forced Output Alignment::     Forced Output Alignment
4413 * Forced Input Alignment::      Forced Input Alignment
4414 * Output Section Constraint::   Output section constraint
4415 * Output Section Region::       Output section region
4416 * Output Section Phdr::         Output section phdr
4417 * Output Section Fill::         Output section fill
4418 @end menu
4419
4420 @node Output Section Type
4421 @subsubsection Output Section Type
4422 Each output section may have a type.  The type is a keyword in
4423 parentheses.  The following types are defined:
4424
4425 @table @code
4426 @item NOLOAD
4427 The section should be marked as not loadable, so that it will not be
4428 loaded into memory when the program is run.
4429 @item DSECT
4430 @itemx COPY
4431 @itemx INFO
4432 @itemx OVERLAY
4433 These type names are supported for backward compatibility, and are
4434 rarely used.  They all have the same effect: the section should be
4435 marked as not allocatable, so that no memory is allocated for the
4436 section when the program is run.
4437 @end table
4438
4439 @kindex NOLOAD
4440 @cindex prevent unnecessary loading
4441 @cindex loading, preventing
4442 The linker normally sets the attributes of an output section based on
4443 the input sections which map into it.  You can override this by using
4444 the section type.  For example, in the script sample below, the
4445 @samp{ROM} section is addressed at memory location @samp{0} and does not
4446 need to be loaded when the program is run.
4447 @smallexample
4448 @group
4449 SECTIONS @{
4450   ROM 0 (NOLOAD) : @{ @dots{} @}
4451   @dots{}
4452 @}
4453 @end group
4454 @end smallexample
4455
4456 @node Output Section LMA
4457 @subsubsection Output Section LMA
4458 @kindex AT>@var{lma_region}
4459 @kindex AT(@var{lma})
4460 @cindex load address
4461 @cindex section load address
4462 Every section has a virtual address (VMA) and a load address (LMA); see
4463 @ref{Basic Script Concepts}.  The virtual address is specified by the
4464 @pxref{Output Section Address} described earlier.  The load address is
4465 specified by the @code{AT} or @code{AT>} keywords.  Specifying a load
4466 address is optional.
4467
4468 The @code{AT} keyword takes an expression as an argument.  This
4469 specifies the exact load address of the section.  The @code{AT>} keyword
4470 takes the name of a memory region as an argument.  @xref{MEMORY}.  The
4471 load address of the section is set to the next free address in the
4472 region, aligned to the section's alignment requirements.
4473
4474 If neither @code{AT} nor @code{AT>} is specified for an allocatable
4475 section, the linker will use the following heuristic to determine the
4476 load address:
4477
4478 @itemize @bullet
4479 @item
4480 If the section has a specific VMA address, then this is used as
4481 the LMA address as well.
4482
4483 @item
4484 If the section is not allocatable then its LMA is set to its VMA.
4485
4486 @item
4487 Otherwise if a memory region can be found that is compatible
4488 with the current section, and this region contains at least one
4489 section, then the LMA is set so the difference between the
4490 VMA and LMA is the same as the difference between the VMA and LMA of
4491 the last section in the located region.
4492
4493 @item
4494 If no memory regions have been declared then a default region
4495 that covers the entire address space is used in the previous step.
4496
4497 @item
4498 If no suitable region could be found, or there was no previous
4499 section then the LMA is set equal to the VMA.
4500 @end itemize
4501
4502 @cindex ROM initialized data
4503 @cindex initialized data in ROM
4504 This feature is designed to make it easy to build a ROM image.  For
4505 example, the following linker script creates three output sections: one
4506 called @samp{.text}, which starts at @code{0x1000}, one called
4507 @samp{.mdata}, which is loaded at the end of the @samp{.text} section
4508 even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold
4509 uninitialized data at address @code{0x3000}.  The symbol @code{_data} is
4510 defined with the value @code{0x2000}, which shows that the location
4511 counter holds the VMA value, not the LMA value.
4512
4513 @smallexample
4514 @group
4515 SECTIONS
4516   @{
4517   .text 0x1000 : @{ *(.text) _etext = . ; @}
4518   .mdata 0x2000 :
4519     AT ( ADDR (.text) + SIZEOF (.text) )
4520     @{ _data = . ; *(.data); _edata = . ;  @}
4521   .bss 0x3000 :
4522     @{ _bstart = . ;  *(.bss) *(COMMON) ; _bend = . ;@}
4523 @}
4524 @end group
4525 @end smallexample
4526
4527 The run-time initialization code for use with a program generated with
4528 this linker script would include something like the following, to copy
4529 the initialized data from the ROM image to its runtime address.  Notice
4530 how this code takes advantage of the symbols defined by the linker
4531 script.
4532
4533 @smallexample
4534 @group
4535 extern char _etext, _data, _edata, _bstart, _bend;
4536 char *src = &_etext;
4537 char *dst = &_data;
4538
4539 /* ROM has data at end of text; copy it.  */
4540 while (dst < &_edata)
4541   *dst++ = *src++;
4542
4543 /* Zero bss.  */
4544 for (dst = &_bstart; dst< &_bend; dst++)
4545   *dst = 0;
4546 @end group
4547 @end smallexample
4548
4549 @node Forced Output Alignment
4550 @subsubsection Forced Output Alignment
4551 @kindex ALIGN(@var{section_align})
4552 @cindex forcing output section alignment
4553 @cindex output section alignment
4554 You can increase an output section's alignment by using ALIGN.
4555
4556 @node Forced Input Alignment
4557 @subsubsection Forced Input Alignment
4558 @kindex SUBALIGN(@var{subsection_align})
4559 @cindex forcing input section alignment
4560 @cindex input section alignment
4561 You can force input section alignment within an output section by using
4562 SUBALIGN.  The value specified overrides any alignment given by input
4563 sections, whether larger or smaller.
4564
4565 @node Output Section Constraint
4566 @subsubsection Output Section Constraint
4567 @kindex ONLY_IF_RO
4568 @kindex ONLY_IF_RW
4569 @cindex constraints on output sections
4570 You can specify that an output section should only be created if all
4571 of its input sections are read-only or all of its input sections are
4572 read-write by using the keyword @code{ONLY_IF_RO} and
4573 @code{ONLY_IF_RW} respectively.
4574
4575 @node Output Section Region
4576 @subsubsection Output Section Region
4577 @kindex >@var{region}
4578 @cindex section, assigning to memory region
4579 @cindex memory regions and sections
4580 You can assign a section to a previously defined region of memory by
4581 using @samp{>@var{region}}.  @xref{MEMORY}.
4582
4583 Here is a simple example:
4584 @smallexample
4585 @group
4586 MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @}
4587 SECTIONS @{ ROM : @{ *(.text) @} >rom @}
4588 @end group
4589 @end smallexample
4590
4591 @node Output Section Phdr
4592 @subsubsection Output Section Phdr
4593 @kindex :@var{phdr}
4594 @cindex section, assigning to program header
4595 @cindex program headers and sections
4596 You can assign a section to a previously defined program segment by
4597 using @samp{:@var{phdr}}.  @xref{PHDRS}.  If a section is assigned to
4598 one or more segments, then all subsequent allocated sections will be
4599 assigned to those segments as well, unless they use an explicitly
4600 @code{:@var{phdr}} modifier.  You can use @code{:NONE} to tell the
4601 linker to not put the section in any segment at all.
4602
4603 Here is a simple example:
4604 @smallexample
4605 @group
4606 PHDRS @{ text PT_LOAD ; @}
4607 SECTIONS @{ .text : @{ *(.text) @} :text @}
4608 @end group
4609 @end smallexample
4610
4611 @node Output Section Fill
4612 @subsubsection Output Section Fill
4613 @kindex =@var{fillexp}
4614 @cindex section fill pattern
4615 @cindex fill pattern, entire section
4616 You can set the fill pattern for an entire section by using
4617 @samp{=@var{fillexp}}.  @var{fillexp} is an expression
4618 (@pxref{Expressions}).  Any otherwise unspecified regions of memory
4619 within the output section (for example, gaps left due to the required
4620 alignment of input sections) will be filled with the value, repeated as
4621 necessary.  If the fill expression is a simple hex number, ie. a string
4622 of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then
4623 an arbitrarily long sequence of hex digits can be used to specify the
4624 fill pattern;  Leading zeros become part of the pattern too.  For all
4625 other cases, including extra parentheses or a unary @code{+}, the fill
4626 pattern is the four least significant bytes of the value of the
4627 expression.  In all cases, the number is big-endian.
4628
4629 You can also change the fill value with a @code{FILL} command in the
4630 output section commands; (@pxref{Output Section Data}).
4631
4632 Here is a simple example:
4633 @smallexample
4634 @group
4635 SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @}
4636 @end group
4637 @end smallexample
4638
4639 @node Overlay Description
4640 @subsection Overlay Description
4641 @kindex OVERLAY
4642 @cindex overlays
4643 An overlay description provides an easy way to describe sections which
4644 are to be loaded as part of a single memory image but are to be run at
4645 the same memory address.  At run time, some sort of overlay manager will
4646 copy the overlaid sections in and out of the runtime memory address as
4647 required, perhaps by simply manipulating addressing bits.  This approach
4648 can be useful, for example, when a certain region of memory is faster
4649 than another.
4650
4651 Overlays are described using the @code{OVERLAY} command.  The
4652 @code{OVERLAY} command is used within a @code{SECTIONS} command, like an
4653 output section description.  The full syntax of the @code{OVERLAY}
4654 command is as follows:
4655 @smallexample
4656 @group
4657 OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )]
4658   @{
4659     @var{secname1}
4660       @{
4661         @var{output-section-command}
4662         @var{output-section-command}
4663         @dots{}
4664       @} [:@var{phdr}@dots{}] [=@var{fill}]
4665     @var{secname2}
4666       @{
4667         @var{output-section-command}
4668         @var{output-section-command}
4669         @dots{}
4670       @} [:@var{phdr}@dots{}] [=@var{fill}]
4671     @dots{}
4672   @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}]
4673 @end group
4674 @end smallexample
4675
4676 Everything is optional except @code{OVERLAY} (a keyword), and each
4677 section must have a name (@var{secname1} and @var{secname2} above).  The
4678 section definitions within the @code{OVERLAY} construct are identical to
4679 those within the general @code{SECTIONS} construct (@pxref{SECTIONS}),
4680 except that no addresses and no memory regions may be defined for
4681 sections within an @code{OVERLAY}.
4682
4683 The sections are all defined with the same starting address.  The load
4684 addresses of the sections are arranged such that they are consecutive in
4685 memory starting at the load address used for the @code{OVERLAY} as a
4686 whole (as with normal section definitions, the load address is optional,
4687 and defaults to the start address; the start address is also optional,
4688 and defaults to the current value of the location counter).
4689
4690 If the @code{NOCROSSREFS} keyword is used, and there are any
4691 references among the sections, the linker will report an error.  Since
4692 the sections all run at the same address, it normally does not make
4693 sense for one section to refer directly to another.
4694 @xref{Miscellaneous Commands, NOCROSSREFS}.
4695
4696 For each section within the @code{OVERLAY}, the linker automatically
4697 provides two symbols.  The symbol @code{__load_start_@var{secname}} is
4698 defined as the starting load address of the section.  The symbol
4699 @code{__load_stop_@var{secname}} is defined as the final load address of
4700 the section.  Any characters within @var{secname} which are not legal
4701 within C identifiers are removed.  C (or assembler) code may use these
4702 symbols to move the overlaid sections around as necessary.
4703
4704 At the end of the overlay, the value of the location counter is set to
4705 the start address of the overlay plus the size of the largest section.
4706
4707 Here is an example.  Remember that this would appear inside a
4708 @code{SECTIONS} construct.
4709 @smallexample
4710 @group
4711   OVERLAY 0x1000 : AT (0x4000)
4712    @{
4713      .text0 @{ o1/*.o(.text) @}
4714      .text1 @{ o2/*.o(.text) @}
4715    @}
4716 @end group
4717 @end smallexample
4718 @noindent
4719 This will define both @samp{.text0} and @samp{.text1} to start at
4720 address 0x1000.  @samp{.text0} will be loaded at address 0x4000, and
4721 @samp{.text1} will be loaded immediately after @samp{.text0}.  The
4722 following symbols will be defined if referenced: @code{__load_start_text0},
4723 @code{__load_stop_text0}, @code{__load_start_text1},
4724 @code{__load_stop_text1}.
4725
4726 C code to copy overlay @code{.text1} into the overlay area might look
4727 like the following.
4728
4729 @smallexample
4730 @group
4731   extern char __load_start_text1, __load_stop_text1;
4732   memcpy ((char *) 0x1000, &__load_start_text1,
4733           &__load_stop_text1 - &__load_start_text1);
4734 @end group
4735 @end smallexample
4736
4737 Note that the @code{OVERLAY} command is just syntactic sugar, since
4738 everything it does can be done using the more basic commands.  The above
4739 example could have been written identically as follows.
4740
4741 @smallexample
4742 @group
4743   .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @}
4744   PROVIDE (__load_start_text0 = LOADADDR (.text0));
4745   PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0));
4746   .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @}
4747   PROVIDE (__load_start_text1 = LOADADDR (.text1));
4748   PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1));
4749   . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1));
4750 @end group
4751 @end smallexample
4752
4753 @node MEMORY
4754 @section MEMORY Command
4755 @kindex MEMORY
4756 @cindex memory regions
4757 @cindex regions of memory
4758 @cindex allocating memory
4759 @cindex discontinuous memory
4760 The linker's default configuration permits allocation of all available
4761 memory.  You can override this by using the @code{MEMORY} command.
4762
4763 The @code{MEMORY} command describes the location and size of blocks of
4764 memory in the target.  You can use it to describe which memory regions
4765 may be used by the linker, and which memory regions it must avoid.  You
4766 can then assign sections to particular memory regions.  The linker will
4767 set section addresses based on the memory regions, and will warn about
4768 regions that become too full.  The linker will not shuffle sections
4769 around to fit into the available regions.
4770
4771 A linker script may contain at most one use of the @code{MEMORY}
4772 command.  However, you can define as many blocks of memory within it as
4773 you wish.  The syntax is:
4774 @smallexample
4775 @group
4776 MEMORY
4777   @{
4778     @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len}
4779     @dots{}
4780   @}
4781 @end group
4782 @end smallexample
4783
4784 The @var{name} is a name used in the linker script to refer to the
4785 region.  The region name has no meaning outside of the linker script.
4786 Region names are stored in a separate name space, and will not conflict
4787 with symbol names, file names, or section names.  Each memory region
4788 must have a distinct name within the @code{MEMORY} command.  However you can
4789 add later alias names to existing memory regions with the @ref{REGION_ALIAS}
4790 command.
4791
4792 @cindex memory region attributes
4793 The @var{attr} string is an optional list of attributes that specify
4794 whether to use a particular memory region for an input section which is
4795 not explicitly mapped in the linker script.  As described in
4796 @ref{SECTIONS}, if you do not specify an output section for some input
4797 section, the linker will create an output section with the same name as
4798 the input section.  If you define region attributes, the linker will use
4799 them to select the memory region for the output section that it creates.
4800
4801 The @var{attr} string must consist only of the following characters:
4802 @table @samp
4803 @item R
4804 Read-only section
4805 @item W
4806 Read/write section
4807 @item X
4808 Executable section
4809 @item A
4810 Allocatable section
4811 @item I
4812 Initialized section
4813 @item L
4814 Same as @samp{I}
4815 @item !
4816 Invert the sense of any of the attributes that follow
4817 @end table
4818
4819 If a unmapped section matches any of the listed attributes other than
4820 @samp{!}, it will be placed in the memory region.  The @samp{!}
4821 attribute reverses this test, so that an unmapped section will be placed
4822 in the memory region only if it does not match any of the listed
4823 attributes.
4824
4825 @kindex ORIGIN =
4826 @kindex o =
4827 @kindex org =
4828 The @var{origin} is an numerical expression for the start address of
4829 the memory region.  The expression must evaluate to a constant and it
4830 cannot involve any symbols.  The keyword @code{ORIGIN} may be
4831 abbreviated to @code{org} or @code{o} (but not, for example,
4832 @code{ORG}).
4833
4834 @kindex LENGTH =
4835 @kindex len =
4836 @kindex l =
4837 The @var{len} is an expression for the size in bytes of the memory
4838 region.  As with the @var{origin} expression, the expression must
4839 be numerical only and must evaluate to a constant.  The keyword
4840 @code{LENGTH} may be abbreviated to @code{len} or @code{l}.
4841
4842 In the following example, we specify that there are two memory regions
4843 available for allocation: one starting at @samp{0} for 256 kilobytes,
4844 and the other starting at @samp{0x40000000} for four megabytes.  The
4845 linker will place into the @samp{rom} memory region every section which
4846 is not explicitly mapped into a memory region, and is either read-only
4847 or executable.  The linker will place other sections which are not
4848 explicitly mapped into a memory region into the @samp{ram} memory
4849 region.
4850
4851 @smallexample
4852 @group
4853 MEMORY
4854   @{
4855     rom (rx)  : ORIGIN = 0, LENGTH = 256K
4856     ram (!rx) : org = 0x40000000, l = 4M
4857   @}
4858 @end group
4859 @end smallexample
4860
4861 Once you define a memory region, you can direct the linker to place
4862 specific output sections into that memory region by using the
4863 @samp{>@var{region}} output section attribute.  For example, if you have
4864 a memory region named @samp{mem}, you would use @samp{>mem} in the
4865 output section definition.  @xref{Output Section Region}.  If no address
4866 was specified for the output section, the linker will set the address to
4867 the next available address within the memory region.  If the combined
4868 output sections directed to a memory region are too large for the
4869 region, the linker will issue an error message.
4870
4871 It is possible to access the origin and length of a memory in an
4872 expression via the @code{ORIGIN(@var{memory})} and
4873 @code{LENGTH(@var{memory})} functions:
4874
4875 @smallexample
4876 @group
4877   _fstack = ORIGIN(ram) + LENGTH(ram) - 4;
4878 @end group
4879 @end smallexample
4880
4881 @node PHDRS
4882 @section PHDRS Command
4883 @kindex PHDRS
4884 @cindex program headers
4885 @cindex ELF program headers
4886 @cindex program segments
4887 @cindex segments, ELF
4888 The ELF object file format uses @dfn{program headers}, also knows as
4889 @dfn{segments}.  The program headers describe how the program should be
4890 loaded into memory.  You can print them out by using the @code{objdump}
4891 program with the @samp{-p} option.
4892
4893 When you run an ELF program on a native ELF system, the system loader
4894 reads the program headers in order to figure out how to load the
4895 program.  This will only work if the program headers are set correctly.
4896 This manual does not describe the details of how the system loader
4897 interprets program headers; for more information, see the ELF ABI.
4898
4899 The linker will create reasonable program headers by default.  However,
4900 in some cases, you may need to specify the program headers more
4901 precisely.  You may use the @code{PHDRS} command for this purpose.  When
4902 the linker sees the @code{PHDRS} command in the linker script, it will
4903 not create any program headers other than the ones specified.
4904
4905 The linker only pays attention to the @code{PHDRS} command when
4906 generating an ELF output file.  In other cases, the linker will simply
4907 ignore @code{PHDRS}.
4908
4909 This is the syntax of the @code{PHDRS} command.  The words @code{PHDRS},
4910 @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords.
4911
4912 @smallexample
4913 @group
4914 PHDRS
4915 @{
4916   @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ]
4917         [ FLAGS ( @var{flags} ) ] ;
4918 @}
4919 @end group
4920 @end smallexample
4921
4922 The @var{name} is used only for reference in the @code{SECTIONS} command
4923 of the linker script.  It is not put into the output file.  Program
4924 header names are stored in a separate name space, and will not conflict
4925 with symbol names, file names, or section names.  Each program header
4926 must have a distinct name.  The headers are processed in order and it
4927 is usual for them to map to sections in ascending load address order.
4928
4929 Certain program header types describe segments of memory which the
4930 system loader will load from the file.  In the linker script, you
4931 specify the contents of these segments by placing allocatable output
4932 sections in the segments.  You use the @samp{:@var{phdr}} output section
4933 attribute to place a section in a particular segment.  @xref{Output
4934 Section Phdr}.
4935
4936 It is normal to put certain sections in more than one segment.  This
4937 merely implies that one segment of memory contains another.  You may
4938 repeat @samp{:@var{phdr}}, using it once for each segment which should
4939 contain the section.
4940
4941 If you place a section in one or more segments using @samp{:@var{phdr}},
4942 then the linker will place all subsequent allocatable sections which do
4943 not specify @samp{:@var{phdr}} in the same segments.  This is for
4944 convenience, since generally a whole set of contiguous sections will be
4945 placed in a single segment.  You can use @code{:NONE} to override the
4946 default segment and tell the linker to not put the section in any
4947 segment at all.
4948
4949 @kindex FILEHDR
4950 @kindex PHDRS
4951 You may use the @code{FILEHDR} and @code{PHDRS} keywords after
4952 the program header type to further describe the contents of the segment.
4953 The @code{FILEHDR} keyword means that the segment should include the ELF
4954 file header.  The @code{PHDRS} keyword means that the segment should
4955 include the ELF program headers themselves.  If applied to a loadable
4956 segment (@code{PT_LOAD}), all prior loadable segments must have one of
4957 these keywords.
4958
4959 The @var{type} may be one of the following.  The numbers indicate the
4960 value of the keyword.
4961
4962 @table @asis
4963 @item @code{PT_NULL} (0)
4964 Indicates an unused program header.
4965
4966 @item @code{PT_LOAD} (1)
4967 Indicates that this program header describes a segment to be loaded from
4968 the file.
4969
4970 @item @code{PT_DYNAMIC} (2)
4971 Indicates a segment where dynamic linking information can be found.
4972
4973 @item @code{PT_INTERP} (3)
4974 Indicates a segment where the name of the program interpreter may be
4975 found.
4976
4977 @item @code{PT_NOTE} (4)
4978 Indicates a segment holding note information.
4979
4980 @item @code{PT_SHLIB} (5)
4981 A reserved program header type, defined but not specified by the ELF
4982 ABI.
4983
4984 @item @code{PT_PHDR} (6)
4985 Indicates a segment where the program headers may be found.
4986
4987 @item @var{expression}
4988 An expression giving the numeric type of the program header.  This may
4989 be used for types not defined above.
4990 @end table
4991
4992 You can specify that a segment should be loaded at a particular address
4993 in memory by using an @code{AT} expression.  This is identical to the
4994 @code{AT} command used as an output section attribute (@pxref{Output
4995 Section LMA}).  The @code{AT} command for a program header overrides the
4996 output section attribute.
4997
4998 The linker will normally set the segment flags based on the sections
4999 which comprise the segment.  You may use the @code{FLAGS} keyword to
5000 explicitly specify the segment flags.  The value of @var{flags} must be
5001 an integer.  It is used to set the @code{p_flags} field of the program
5002 header.
5003
5004 Here is an example of @code{PHDRS}.  This shows a typical set of program
5005 headers used on a native ELF system.
5006
5007 @example
5008 @group
5009 PHDRS
5010 @{
5011   headers PT_PHDR PHDRS ;
5012   interp PT_INTERP ;
5013   text PT_LOAD FILEHDR PHDRS ;
5014   data PT_LOAD ;
5015   dynamic PT_DYNAMIC ;
5016 @}
5017
5018 SECTIONS
5019 @{
5020   . = SIZEOF_HEADERS;
5021   .interp : @{ *(.interp) @} :text :interp
5022   .text : @{ *(.text) @} :text
5023   .rodata : @{ *(.rodata) @} /* defaults to :text */
5024   @dots{}
5025   . = . + 0x1000; /* move to a new page in memory */
5026   .data : @{ *(.data) @} :data
5027   .dynamic : @{ *(.dynamic) @} :data :dynamic
5028   @dots{}
5029 @}
5030 @end group
5031 @end example
5032
5033 @node VERSION
5034 @section VERSION Command
5035 @kindex VERSION @{script text@}
5036 @cindex symbol versions
5037 @cindex version script
5038 @cindex versions of symbols
5039 The linker supports symbol versions when using ELF.  Symbol versions are
5040 only useful when using shared libraries.  The dynamic linker can use
5041 symbol versions to select a specific version of a function when it runs
5042 a program that may have been linked against an earlier version of the
5043 shared library.
5044
5045 You can include a version script directly in the main linker script, or
5046 you can supply the version script as an implicit linker script.  You can
5047 also use the @samp{--version-script} linker option.
5048
5049 The syntax of the @code{VERSION} command is simply
5050 @smallexample
5051 VERSION @{ version-script-commands @}
5052 @end smallexample
5053
5054 The format of the version script commands is identical to that used by
5055 Sun's linker in Solaris 2.5.  The version script defines a tree of
5056 version nodes.  You specify the node names and interdependencies in the
5057 version script.  You can specify which symbols are bound to which
5058 version nodes, and you can reduce a specified set of symbols to local
5059 scope so that they are not globally visible outside of the shared
5060 library.
5061
5062 The easiest way to demonstrate the version script language is with a few
5063 examples.
5064
5065 @smallexample
5066 VERS_1.1 @{
5067          global:
5068                  foo1;
5069          local:
5070                  old*;
5071                  original*;
5072                  new*;
5073 @};
5074
5075 VERS_1.2 @{
5076                  foo2;
5077 @} VERS_1.1;
5078
5079 VERS_2.0 @{
5080                  bar1; bar2;
5081          extern "C++" @{
5082                  ns::*;
5083                  "f(int, double)";
5084          @};
5085 @} VERS_1.2;
5086 @end smallexample
5087
5088 This example version script defines three version nodes.  The first
5089 version node defined is @samp{VERS_1.1}; it has no other dependencies.
5090 The script binds the symbol @samp{foo1} to @samp{VERS_1.1}.  It reduces
5091 a number of symbols to local scope so that they are not visible outside
5092 of the shared library; this is done using wildcard patterns, so that any
5093 symbol whose name begins with @samp{old}, @samp{original}, or @samp{new}
5094 is matched.  The wildcard patterns available are the same as those used
5095 in the shell when matching filenames (also known as ``globbing'').
5096 However, if you specify the symbol name inside double quotes, then the
5097 name is treated as literal, rather than as a glob pattern.
5098
5099 Next, the version script defines node @samp{VERS_1.2}.  This node
5100 depends upon @samp{VERS_1.1}.  The script binds the symbol @samp{foo2}
5101 to the version node @samp{VERS_1.2}.
5102
5103 Finally, the version script defines node @samp{VERS_2.0}.  This node
5104 depends upon @samp{VERS_1.2}.  The scripts binds the symbols @samp{bar1}
5105 and @samp{bar2} are bound to the version node @samp{VERS_2.0}.
5106
5107 When the linker finds a symbol defined in a library which is not
5108 specifically bound to a version node, it will effectively bind it to an
5109 unspecified base version of the library.  You can bind all otherwise
5110 unspecified symbols to a given version node by using @samp{global: *;}
5111 somewhere in the version script.  Note that it's slightly crazy to use
5112 wildcards in a global spec except on the last version node.  Global
5113 wildcards elsewhere run the risk of accidentally adding symbols to the
5114 set exported for an old version.  That's wrong since older versions
5115 ought to have a fixed set of symbols.
5116
5117 The names of the version nodes have no specific meaning other than what
5118 they might suggest to the person reading them.  The @samp{2.0} version
5119 could just as well have appeared in between @samp{1.1} and @samp{1.2}.
5120 However, this would be a confusing way to write a version script.
5121
5122 Node name can be omitted, provided it is the only version node
5123 in the version script.  Such version script doesn't assign any versions to
5124 symbols, only selects which symbols will be globally visible out and which
5125 won't.
5126
5127 @smallexample
5128 @{ global: foo; bar; local: *; @};
5129 @end smallexample
5130
5131 When you link an application against a shared library that has versioned
5132 symbols, the application itself knows which version of each symbol it
5133 requires, and it also knows which version nodes it needs from each
5134 shared library it is linked against.  Thus at runtime, the dynamic
5135 loader can make a quick check to make sure that the libraries you have
5136 linked against do in fact supply all of the version nodes that the
5137 application will need to resolve all of the dynamic symbols.  In this
5138 way it is possible for the dynamic linker to know with certainty that
5139 all external symbols that it needs will be resolvable without having to
5140 search for each symbol reference.
5141
5142 The symbol versioning is in effect a much more sophisticated way of
5143 doing minor version checking that SunOS does.  The fundamental problem
5144 that is being addressed here is that typically references to external
5145 functions are bound on an as-needed basis, and are not all bound when
5146 the application starts up.  If a shared library is out of date, a
5147 required interface may be missing; when the application tries to use
5148 that interface, it may suddenly and unexpectedly fail.  With symbol
5149 versioning, the user will get a warning when they start their program if
5150 the libraries being used with the application are too old.
5151
5152 There are several GNU extensions to Sun's versioning approach.  The
5153 first of these is the ability to bind a symbol to a version node in the
5154 source file where the symbol is defined instead of in the versioning
5155 script.  This was done mainly to reduce the burden on the library
5156 maintainer.  You can do this by putting something like:
5157 @smallexample
5158 __asm__(".symver original_foo,foo@@VERS_1.1");
5159 @end smallexample
5160 @noindent
5161 in the C source file.  This renames the function @samp{original_foo} to
5162 be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}.
5163 The @samp{local:} directive can be used to prevent the symbol
5164 @samp{original_foo} from being exported. A @samp{.symver} directive
5165 takes precedence over a version script.
5166
5167 The second GNU extension is to allow multiple versions of the same
5168 function to appear in a given shared library.  In this way you can make
5169 an incompatible change to an interface without increasing the major
5170 version number of the shared library, while still allowing applications
5171 linked against the old interface to continue to function.
5172
5173 To do this, you must use multiple @samp{.symver} directives in the
5174 source file.  Here is an example:
5175
5176 @smallexample
5177 __asm__(".symver original_foo,foo@@");
5178 __asm__(".symver old_foo,foo@@VERS_1.1");
5179 __asm__(".symver old_foo1,foo@@VERS_1.2");
5180 __asm__(".symver new_foo,foo@@@@VERS_2.0");
5181 @end smallexample
5182
5183 In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the
5184 unspecified base version of the symbol.  The source file that contains this
5185 example would define 4 C functions: @samp{original_foo}, @samp{old_foo},
5186 @samp{old_foo1}, and @samp{new_foo}.
5187
5188 When you have multiple definitions of a given symbol, there needs to be
5189 some way to specify a default version to which external references to
5190 this symbol will be bound.  You can do this with the
5191 @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive.  You can only
5192 declare one version of a symbol as the default in this manner; otherwise
5193 you would effectively have multiple definitions of the same symbol.
5194
5195 If you wish to bind a reference to a specific version of the symbol
5196 within the shared library, you can use the aliases of convenience
5197 (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to
5198 specifically bind to an external version of the function in question.
5199
5200 You can also specify the language in the version script:
5201
5202 @smallexample
5203 VERSION extern "lang" @{ version-script-commands @}
5204 @end smallexample
5205
5206 The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}.
5207 The linker will iterate over the list of symbols at the link time and
5208 demangle them according to @samp{lang} before matching them to the
5209 patterns specified in @samp{version-script-commands}.  The default
5210 @samp{lang} is @samp{C}.
5211
5212 Demangled names may contains spaces and other special characters.  As
5213 described above, you can use a glob pattern to match demangled names,
5214 or you can use a double-quoted string to match the string exactly.  In
5215 the latter case, be aware that minor differences (such as differing
5216 whitespace) between the version script and the demangler output will
5217 cause a mismatch.  As the exact string generated by the demangler
5218 might change in the future, even if the mangled name does not, you
5219 should check that all of your version directives are behaving as you
5220 expect when you upgrade.
5221
5222 @node Expressions
5223 @section Expressions in Linker Scripts
5224 @cindex expressions
5225 @cindex arithmetic
5226 The syntax for expressions in the linker script language is identical to
5227 that of C expressions.  All expressions are evaluated as integers.  All
5228 expressions are evaluated in the same size, which is 32 bits if both the
5229 host and target are 32 bits, and is otherwise 64 bits.
5230
5231 You can use and set symbol values in expressions.
5232
5233 The linker defines several special purpose builtin functions for use in
5234 expressions.
5235
5236 @menu
5237 * Constants::                   Constants
5238 * Symbolic Constants::          Symbolic constants
5239 * Symbols::                     Symbol Names
5240 * Orphan Sections::             Orphan Sections
5241 * Location Counter::            The Location Counter
5242 * Operators::                   Operators
5243 * Evaluation::                  Evaluation
5244 * Expression Section::          The Section of an Expression
5245 * Builtin Functions::           Builtin Functions
5246 @end menu
5247
5248 @node Constants
5249 @subsection Constants
5250 @cindex integer notation
5251 @cindex constants in linker scripts
5252 All constants are integers.
5253
5254 As in C, the linker considers an integer beginning with @samp{0} to be
5255 octal, and an integer beginning with @samp{0x} or @samp{0X} to be
5256 hexadecimal.  Alternatively the linker accepts suffixes of @samp{h} or
5257 @samp{H} for hexadecimal, @samp{o} or @samp{O} for octal, @samp{b} or
5258 @samp{B} for binary and @samp{d} or @samp{D} for decimal.  Any integer
5259 value without a prefix or a suffix is considered to be decimal.
5260
5261 @cindex scaled integers
5262 @cindex K and M integer suffixes
5263 @cindex M and K integer suffixes
5264 @cindex suffixes for integers
5265 @cindex integer suffixes
5266 In addition, you can use the suffixes @code{K} and @code{M} to scale a
5267 constant by
5268 @c TEXI2ROFF-KILL
5269 @ifnottex
5270 @c END TEXI2ROFF-KILL
5271 @code{1024} or @code{1024*1024}
5272 @c TEXI2ROFF-KILL
5273 @end ifnottex
5274 @tex
5275 ${\rm 1024}$ or ${\rm 1024}^2$
5276 @end tex
5277 @c END TEXI2ROFF-KILL
5278 respectively.  For example, the following
5279 all refer to the same quantity:
5280
5281 @smallexample
5282 _fourk_1 = 4K;
5283 _fourk_2 = 4096;
5284 _fourk_3 = 0x1000;
5285 _fourk_4 = 10000o;
5286 @end smallexample
5287
5288 Note - the @code{K} and @code{M} suffixes cannot be used in
5289 conjunction with the base suffixes mentioned above.
5290
5291 @node Symbolic Constants
5292 @subsection Symbolic Constants
5293 @cindex symbolic constants
5294 @kindex CONSTANT
5295 It is possible to refer to target specific constants via the use of
5296 the @code{CONSTANT(@var{name})} operator, where @var{name} is one of:
5297
5298 @table @code
5299 @item MAXPAGESIZE
5300 @kindex MAXPAGESIZE
5301 The target's maximum page size.
5302
5303 @item COMMONPAGESIZE
5304 @kindex COMMONPAGESIZE
5305 The target's default page size.
5306 @end table
5307
5308 So for example:
5309
5310 @smallexample
5311   .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @}
5312 @end smallexample
5313
5314 will create a text section aligned to the largest page boundary
5315 supported by the target.
5316
5317 @node Symbols
5318 @subsection Symbol Names
5319 @cindex symbol names
5320 @cindex names
5321 @cindex quoted symbol names
5322 @kindex "
5323 Unless quoted, symbol names start with a letter, underscore, or period
5324 and may include letters, digits, underscores, periods, and hyphens.
5325 Unquoted symbol names must not conflict with any keywords.  You can
5326 specify a symbol which contains odd characters or has the same name as a
5327 keyword by surrounding the symbol name in double quotes:
5328 @smallexample
5329 "SECTION" = 9;
5330 "with a space" = "also with a space" + 10;
5331 @end smallexample
5332
5333 Since symbols can contain many non-alphabetic characters, it is safest
5334 to delimit symbols with spaces.  For example, @samp{A-B} is one symbol,
5335 whereas @samp{A - B} is an expression involving subtraction.
5336
5337 @node Orphan Sections
5338 @subsection Orphan Sections
5339 @cindex orphan
5340 Orphan sections are sections present in the input files which
5341 are not explicitly placed into the output file by the linker
5342 script.  The linker will still copy these sections into the
5343 output file, but it has to guess as to where they should be
5344 placed.  The linker uses a simple heuristic to do this.  It
5345 attempts to place orphan sections after non-orphan sections of the
5346 same attribute, such as code vs data, loadable vs non-loadable, etc.
5347 If there is not enough room to do this then it places
5348 at the end of the file.
5349
5350 For ELF targets, the attribute of the section includes section type as
5351 well as section flag.
5352
5353 If an orphaned section's name is representable as a C identifier then
5354 the linker will automatically @pxref{PROVIDE} two symbols:
5355 __start_SECNAME and __stop_SECNAME, where SECNAME is the name of the
5356 section.  These indicate the start address and end address of the
5357 orphaned section respectively.  Note: most section names are not
5358 representable as C identifiers because they contain a @samp{.}
5359 character.
5360
5361 @node Location Counter
5362 @subsection The Location Counter
5363 @kindex .
5364 @cindex dot
5365 @cindex location counter
5366 @cindex current output location
5367 The special linker variable @dfn{dot} @samp{.} always contains the
5368 current output location counter.  Since the @code{.} always refers to a
5369 location in an output section, it may only appear in an expression
5370 within a @code{SECTIONS} command.  The @code{.} symbol may appear
5371 anywhere that an ordinary symbol is allowed in an expression.
5372
5373 @cindex holes
5374 Assigning a value to @code{.} will cause the location counter to be
5375 moved.  This may be used to create holes in the output section.  The
5376 location counter may not be moved backwards inside an output section,
5377 and may not be moved backwards outside of an output section if so
5378 doing creates areas with overlapping LMAs.
5379
5380 @smallexample
5381 SECTIONS
5382 @{
5383   output :
5384     @{
5385       file1(.text)
5386       . = . + 1000;
5387       file2(.text)
5388       . += 1000;
5389       file3(.text)
5390     @} = 0x12345678;
5391 @}
5392 @end smallexample
5393 @noindent
5394 In the previous example, the @samp{.text} section from @file{file1} is
5395 located at the beginning of the output section @samp{output}.  It is
5396 followed by a 1000 byte gap.  Then the @samp{.text} section from
5397 @file{file2} appears, also with a 1000 byte gap following before the
5398 @samp{.text} section from @file{file3}.  The notation @samp{= 0x12345678}
5399 specifies what data to write in the gaps (@pxref{Output Section Fill}).
5400
5401 @cindex dot inside sections
5402 Note: @code{.} actually refers to the byte offset from the start of the
5403 current containing object.  Normally this is the @code{SECTIONS}
5404 statement, whose start address is 0, hence @code{.} can be used as an
5405 absolute address.  If @code{.} is used inside a section description
5406 however, it refers to the byte offset from the start of that section,
5407 not an absolute address.  Thus in a script like this:
5408
5409 @smallexample
5410 SECTIONS
5411 @{
5412     . = 0x100
5413     .text: @{
5414       *(.text)
5415       . = 0x200
5416     @}
5417     . = 0x500
5418     .data: @{
5419       *(.data)
5420       . += 0x600
5421     @}
5422 @}
5423 @end smallexample
5424
5425 The @samp{.text} section will be assigned a starting address of 0x100
5426 and a size of exactly 0x200 bytes, even if there is not enough data in
5427 the @samp{.text} input sections to fill this area.  (If there is too
5428 much data, an error will be produced because this would be an attempt to
5429 move @code{.} backwards).  The @samp{.data} section will start at 0x500
5430 and it will have an extra 0x600 bytes worth of space after the end of
5431 the values from the @samp{.data} input sections and before the end of
5432 the @samp{.data} output section itself.
5433
5434 @cindex dot outside sections
5435 Setting symbols to the value of the location counter outside of an
5436 output section statement can result in unexpected values if the linker
5437 needs to place orphan sections.  For example, given the following:
5438
5439 @smallexample
5440 SECTIONS
5441 @{
5442     start_of_text = . ;
5443     .text: @{ *(.text) @}
5444     end_of_text = . ;
5445
5446     start_of_data = . ;
5447     .data: @{ *(.data) @}
5448     end_of_data = . ;
5449 @}
5450 @end smallexample
5451
5452 If the linker needs to place some input section, e.g. @code{.rodata},
5453 not mentioned in the script, it might choose to place that section
5454 between @code{.text} and @code{.data}.  You might think the linker
5455 should place @code{.rodata} on the blank line in the above script, but
5456 blank lines are of no particular significance to the linker.  As well,
5457 the linker doesn't associate the above symbol names with their
5458 sections.  Instead, it assumes that all assignments or other
5459 statements belong to the previous output section, except for the
5460 special case of an assignment to @code{.}.  I.e., the linker will
5461 place the orphan @code{.rodata} section as if the script was written
5462 as follows:
5463
5464 @smallexample
5465 SECTIONS
5466 @{
5467     start_of_text = . ;
5468     .text: @{ *(.text) @}
5469     end_of_text = . ;
5470
5471     start_of_data = . ;
5472     .rodata: @{ *(.rodata) @}
5473     .data: @{ *(.data) @}
5474     end_of_data = . ;
5475 @}
5476 @end smallexample
5477
5478 This may or may not be the script author's intention for the value of
5479 @code{start_of_data}.  One way to influence the orphan section
5480 placement is to assign the location counter to itself, as the linker
5481 assumes that an assignment to @code{.} is setting the start address of
5482 a following output section and thus should be grouped with that
5483 section.  So you could write:
5484
5485 @smallexample
5486 SECTIONS
5487 @{
5488     start_of_text = . ;
5489     .text: @{ *(.text) @}
5490     end_of_text = . ;
5491
5492     . = . ;
5493     start_of_data = . ;
5494     .data: @{ *(.data) @}
5495     end_of_data = . ;
5496 @}
5497 @end smallexample
5498
5499 Now, the orphan @code{.rodata} section will be placed between
5500 @code{end_of_text} and @code{start_of_data}.
5501
5502 @need 2000
5503 @node Operators
5504 @subsection Operators
5505 @cindex operators for arithmetic
5506 @cindex arithmetic operators
5507 @cindex precedence in expressions
5508 The linker recognizes the standard C set of arithmetic operators, with
5509 the standard bindings and precedence levels:
5510 @c TEXI2ROFF-KILL
5511 @ifnottex
5512 @c END TEXI2ROFF-KILL
5513 @smallexample
5514 precedence      associativity   Operators                Notes
5515 (highest)
5516 1               left            !  -  ~                  (1)
5517 2               left            *  /  %
5518 3               left            +  -
5519 4               left            >>  <<
5520 5               left            ==  !=  >  <  <=  >=
5521 6               left            &
5522 7               left            |
5523 8               left            &&
5524 9               left            ||
5525 10              right           ? :
5526 11              right           &=  +=  -=  *=  /=       (2)
5527 (lowest)
5528 @end smallexample
5529 Notes:
5530 (1) Prefix operators
5531 (2) @xref{Assignments}.
5532 @c TEXI2ROFF-KILL
5533 @end ifnottex
5534 @tex
5535 \vskip \baselineskip
5536 %"lispnarrowing" is the extra indent used generally for smallexample
5537 \hskip\lispnarrowing\vbox{\offinterlineskip
5538 \hrule
5539 \halign
5540 {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr
5541 height2pt&\omit&&\omit&&\omit&\cr
5542 &Precedence&&  Associativity  &&{\rm Operators}&\cr
5543 height2pt&\omit&&\omit&&\omit&\cr
5544 \noalign{\hrule}
5545 height2pt&\omit&&\omit&&\omit&\cr
5546 &highest&&&&&\cr
5547 % '176 is tilde, '~' in tt font
5548 &1&&left&&\qquad-          \char'176\      !\qquad\dag&\cr
5549 &2&&left&&*          /        \%&\cr
5550 &3&&left&&+          -&\cr
5551 &4&&left&&>>         <<&\cr
5552 &5&&left&&==         !=       >      <      <=      >=&\cr
5553 &6&&left&&\&&\cr
5554 &7&&left&&|&\cr
5555 &8&&left&&{\&\&}&\cr
5556 &9&&left&&||&\cr
5557 &10&&right&&?        :&\cr
5558 &11&&right&&\qquad\&=      +=       -=     *=     /=\qquad\ddag&\cr
5559 &lowest&&&&&\cr
5560 height2pt&\omit&&\omit&&\omit&\cr}
5561 \hrule}
5562 @end tex
5563 @iftex
5564 {
5565 @obeylines@parskip=0pt@parindent=0pt
5566 @dag@quad Prefix operators.
5567 @ddag@quad @xref{Assignments}.
5568 }
5569 @end iftex
5570 @c END TEXI2ROFF-KILL
5571
5572 @node Evaluation
5573 @subsection Evaluation
5574 @cindex lazy evaluation
5575 @cindex expression evaluation order
5576 The linker evaluates expressions lazily.  It only computes the value of
5577 an expression when absolutely necessary.
5578
5579 The linker needs some information, such as the value of the start
5580 address of the first section, and the origins and lengths of memory
5581 regions, in order to do any linking at all.  These values are computed
5582 as soon as possible when the linker reads in the linker script.
5583
5584 However, other values (such as symbol values) are not known or needed
5585 until after storage allocation.  Such values are evaluated later, when
5586 other information (such as the sizes of output sections) is available
5587 for use in the symbol assignment expression.
5588
5589 The sizes of sections cannot be known until after allocation, so
5590 assignments dependent upon these are not performed until after
5591 allocation.
5592
5593 Some expressions, such as those depending upon the location counter
5594 @samp{.}, must be evaluated during section allocation.
5595
5596 If the result of an expression is required, but the value is not
5597 available, then an error results.  For example, a script like the
5598 following
5599 @smallexample
5600 @group
5601 SECTIONS
5602   @{
5603     .text 9+this_isnt_constant :
5604       @{ *(.text) @}
5605   @}
5606 @end group
5607 @end smallexample
5608 @noindent
5609 will cause the error message @samp{non constant expression for initial
5610 address}.
5611
5612 @node Expression Section
5613 @subsection The Section of an Expression
5614 @cindex expression sections
5615 @cindex absolute expressions
5616 @cindex relative expressions
5617 @cindex absolute and relocatable symbols
5618 @cindex relocatable and absolute symbols
5619 @cindex symbols, relocatable and absolute
5620 Addresses and symbols may be section relative, or absolute.  A section
5621 relative symbol is relocatable.  If you request relocatable output
5622 using the @samp{-r} option, a further link operation may change the
5623 value of a section relative symbol.  On the other hand, an absolute
5624 symbol will retain the same value throughout any further link
5625 operations.
5626
5627 Some terms in linker expressions are addresses.  This is true of
5628 section relative symbols and for builtin functions that return an
5629 address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and
5630 @code{SEGMENT_START}.  Other terms are simply numbers, or are builtin
5631 functions that return a non-address value, such as @code{LENGTH}.
5632 One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")}
5633 (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated
5634 differently depending on their location, for compatibility with older
5635 versions of @code{ld}.  Expressions appearing outside an output
5636 section definition treat all numbers as absolute addresses.
5637 Expressions appearing inside an output section definition treat
5638 absolute symbols as numbers.  If @code{LD_FEATURE ("SANE_EXPR")} is
5639 given, then absolute symbols and numbers are simply treated as numbers
5640 everywhere.
5641
5642 In the following simple example,
5643
5644 @smallexample
5645 @group
5646 SECTIONS
5647   @{
5648     . = 0x100;
5649     __executable_start = 0x100;
5650     .data :
5651     @{
5652       . = 0x10;
5653       __data_start = 0x10;
5654       *(.data)
5655     @}
5656     @dots{}
5657   @}
5658 @end group
5659 @end smallexample
5660
5661 both @code{.} and @code{__executable_start} are set to the absolute
5662 address 0x100 in the first two assignments, then both @code{.} and
5663 @code{__data_start} are set to 0x10 relative to the @code{.data}
5664 section in the second two assignments.
5665
5666 For expressions involving numbers, relative addresses and absolute
5667 addresses, ld follows these rules to evaluate terms:
5668
5669 @itemize @bullet
5670 @item
5671 Unary operations on an absolute address or number, and binary
5672 operations on two absolute addresses or two numbers, or between one
5673 absolute address and a number, apply the operator to the value(s).
5674 @item
5675 Unary operations on a relative address, and binary operations on two
5676 relative addresses in the same section or between one relative address
5677 and a number, apply the operator to the offset part of the address(es).
5678 @item
5679 Other binary operations, that is, between two relative addresses not
5680 in the same section, or between a relative address and an absolute
5681 address, first convert any non-absolute term to an absolute address
5682 before applying the operator.
5683 @end itemize
5684
5685 The result section of each sub-expression is as follows:
5686
5687 @itemize @bullet
5688 @item
5689 An operation involving only numbers results in a number.
5690 @item
5691 The result of comparisons, @samp{&&} and @samp{||} is also a number.
5692 @item
5693 The result of other binary arithmetic and logical operations on two
5694 relative addresses in the same section or two absolute addresses
5695 (after above conversions) is also a number.
5696 @item
5697 The result of other operations on relative addresses or one
5698 relative address and a number, is a relative address in the same
5699 section as the relative operand(s).
5700 @item
5701 The result of other operations on absolute addresses (after above
5702 conversions) is an absolute address.
5703 @end itemize
5704
5705 You can use the builtin function @code{ABSOLUTE} to force an expression
5706 to be absolute when it would otherwise be relative.  For example, to
5707 create an absolute symbol set to the address of the end of the output
5708 section @samp{.data}:
5709 @smallexample
5710 SECTIONS
5711   @{
5712     .data : @{ *(.data) _edata = ABSOLUTE(.); @}
5713   @}
5714 @end smallexample
5715 @noindent
5716 If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the
5717 @samp{.data} section.
5718
5719 Using @code{LOADADDR} also forces an expression absolute, since this
5720 particular builtin function returns an absolute address.
5721
5722 @node Builtin Functions
5723 @subsection Builtin Functions
5724 @cindex functions in expressions
5725 The linker script language includes a number of builtin functions for
5726 use in linker script expressions.
5727
5728 @table @code
5729 @item ABSOLUTE(@var{exp})
5730 @kindex ABSOLUTE(@var{exp})
5731 @cindex expression, absolute
5732 Return the absolute (non-relocatable, as opposed to non-negative) value
5733 of the expression @var{exp}.  Primarily useful to assign an absolute
5734 value to a symbol within a section definition, where symbol values are
5735 normally section relative.  @xref{Expression Section}.
5736
5737 @item ADDR(@var{section})
5738 @kindex ADDR(@var{section})
5739 @cindex section address in expression
5740 Return the address (VMA) of the named @var{section}.  Your
5741 script must previously have defined the location of that section.  In
5742 the following example, @code{start_of_output_1}, @code{symbol_1} and
5743 @code{symbol_2} are assigned equivalent values, except that
5744 @code{symbol_1} will be relative to the @code{.output1} section while
5745 the other two will be absolute:
5746 @smallexample
5747 @group
5748 SECTIONS @{ @dots{}
5749   .output1 :
5750     @{
5751     start_of_output_1 = ABSOLUTE(.);
5752     @dots{}
5753     @}
5754   .output :
5755     @{
5756     symbol_1 = ADDR(.output1);
5757     symbol_2 = start_of_output_1;
5758     @}
5759 @dots{} @}
5760 @end group
5761 @end smallexample
5762
5763 @item ALIGN(@var{align})
5764 @itemx ALIGN(@var{exp},@var{align})
5765 @kindex ALIGN(@var{align})
5766 @kindex ALIGN(@var{exp},@var{align})
5767 @cindex round up location counter
5768 @cindex align location counter
5769 @cindex round up expression
5770 @cindex align expression
5771 Return the location counter (@code{.}) or arbitrary expression aligned
5772 to the next @var{align} boundary.  The single operand @code{ALIGN}
5773 doesn't change the value of the location counter---it just does
5774 arithmetic on it.  The two operand @code{ALIGN} allows an arbitrary
5775 expression to be aligned upwards (@code{ALIGN(@var{align})} is
5776 equivalent to @code{ALIGN(., @var{align})}).
5777
5778 Here is an example which aligns the output @code{.data} section to the
5779 next @code{0x2000} byte boundary after the preceding section and sets a
5780 variable within the section to the next @code{0x8000} boundary after the
5781 input sections:
5782 @smallexample
5783 @group
5784 SECTIONS @{ @dots{}
5785   .data ALIGN(0x2000): @{
5786     *(.data)
5787     variable = ALIGN(0x8000);
5788   @}
5789 @dots{} @}
5790 @end group
5791 @end smallexample
5792 @noindent
5793 The first use of @code{ALIGN} in this example specifies the location of
5794 a section because it is used as the optional @var{address} attribute of
5795 a section definition (@pxref{Output Section Address}).  The second use
5796 of @code{ALIGN} is used to defines the value of a symbol.
5797
5798 The builtin function @code{NEXT} is closely related to @code{ALIGN}.
5799
5800 @item ALIGNOF(@var{section})
5801 @kindex ALIGNOF(@var{section})
5802 @cindex section alignment
5803 Return the alignment in bytes of the named @var{section}, if that section has
5804 been allocated.  If the section has not been allocated when this is
5805 evaluated, the linker will report an error. In the following example,
5806 the alignment of the @code{.output} section is stored as the first
5807 value in that section.
5808 @smallexample
5809 @group
5810 SECTIONS@{ @dots{}
5811   .output @{
5812     LONG (ALIGNOF (.output))
5813     @dots{}
5814     @}
5815 @dots{} @}
5816 @end group
5817 @end smallexample
5818
5819 @item BLOCK(@var{exp})
5820 @kindex BLOCK(@var{exp})
5821 This is a synonym for @code{ALIGN}, for compatibility with older linker
5822 scripts.  It is most often seen when setting the address of an output
5823 section.
5824
5825 @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
5826 @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
5827 This is equivalent to either
5828 @smallexample
5829 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1)))
5830 @end smallexample
5831 or
5832 @smallexample
5833 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - @var{commonpagesize})))
5834 @end smallexample
5835 @noindent
5836 depending on whether the latter uses fewer @var{commonpagesize} sized pages
5837 for the data segment (area between the result of this expression and
5838 @code{DATA_SEGMENT_END}) than the former or not.
5839 If the latter form is used, it means @var{commonpagesize} bytes of runtime
5840 memory will be saved at the expense of up to @var{commonpagesize} wasted
5841 bytes in the on-disk file.
5842
5843 This expression can only be used directly in @code{SECTIONS} commands, not in
5844 any output section descriptions and only once in the linker script.
5845 @var{commonpagesize} should be less or equal to @var{maxpagesize} and should
5846 be the system page size the object wants to be optimized for (while still
5847 working on system page sizes up to @var{maxpagesize}).
5848
5849 @noindent
5850 Example:
5851 @smallexample
5852   . = DATA_SEGMENT_ALIGN(0x10000, 0x2000);
5853 @end smallexample
5854
5855 @item DATA_SEGMENT_END(@var{exp})
5856 @kindex DATA_SEGMENT_END(@var{exp})
5857 This defines the end of data segment for @code{DATA_SEGMENT_ALIGN}
5858 evaluation purposes.
5859
5860 @smallexample
5861   . = DATA_SEGMENT_END(.);
5862 @end smallexample
5863
5864 @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
5865 @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
5866 This defines the end of the @code{PT_GNU_RELRO} segment when
5867 @samp{-z relro} option is used.  Second argument is returned.
5868 When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END}
5869 does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that
5870 @var{exp} + @var{offset} is aligned to the most commonly used page
5871 boundary for particular target.  If present in the linker script,
5872 it must always come in between @code{DATA_SEGMENT_ALIGN} and
5873 @code{DATA_SEGMENT_END}.
5874
5875 @smallexample
5876   . = DATA_SEGMENT_RELRO_END(24, .);
5877 @end smallexample
5878
5879 @item DEFINED(@var{symbol})
5880 @kindex DEFINED(@var{symbol})
5881 @cindex symbol defaults
5882 Return 1 if @var{symbol} is in the linker global symbol table and is
5883 defined before the statement using DEFINED in the script, otherwise
5884 return 0.  You can use this function to provide
5885 default values for symbols.  For example, the following script fragment
5886 shows how to set a global symbol @samp{begin} to the first location in
5887 the @samp{.text} section---but if a symbol called @samp{begin} already
5888 existed, its value is preserved:
5889
5890 @smallexample
5891 @group
5892 SECTIONS @{ @dots{}
5893   .text : @{
5894     begin = DEFINED(begin) ? begin : . ;
5895     @dots{}
5896   @}
5897   @dots{}
5898 @}
5899 @end group
5900 @end smallexample
5901
5902 @item LENGTH(@var{memory})
5903 @kindex LENGTH(@var{memory})
5904 Return the length of the memory region named @var{memory}.
5905
5906 @item LOADADDR(@var{section})
5907 @kindex LOADADDR(@var{section})
5908 @cindex section load address in expression
5909 Return the absolute LMA of the named @var{section}.  (@pxref{Output
5910 Section LMA}).
5911
5912 @kindex MAX
5913 @item MAX(@var{exp1}, @var{exp2})
5914 Returns the maximum of @var{exp1} and @var{exp2}.
5915
5916 @kindex MIN
5917 @item MIN(@var{exp1}, @var{exp2})
5918 Returns the minimum of @var{exp1} and @var{exp2}.
5919
5920 @item NEXT(@var{exp})
5921 @kindex NEXT(@var{exp})
5922 @cindex unallocated address, next
5923 Return the next unallocated address that is a multiple of @var{exp}.
5924 This function is closely related to @code{ALIGN(@var{exp})}; unless you
5925 use the @code{MEMORY} command to define discontinuous memory for the
5926 output file, the two functions are equivalent.
5927
5928 @item ORIGIN(@var{memory})
5929 @kindex ORIGIN(@var{memory})
5930 Return the origin of the memory region named @var{memory}.
5931
5932 @item SEGMENT_START(@var{segment}, @var{default})
5933 @kindex SEGMENT_START(@var{segment}, @var{default})
5934 Return the base address of the named @var{segment}.  If an explicit
5935 value has been given for this segment (with a command-line @samp{-T}
5936 option) that value will be returned; otherwise the value will be
5937 @var{default}.  At present, the @samp{-T} command-line option can only
5938 be used to set the base address for the ``text'', ``data'', and
5939 ``bss'' sections, but you can use @code{SEGMENT_START} with any segment
5940 name.
5941
5942 @item SIZEOF(@var{section})
5943 @kindex SIZEOF(@var{section})
5944 @cindex section size
5945 Return the size in bytes of the named @var{section}, if that section has
5946 been allocated.  If the section has not been allocated when this is
5947 evaluated, the linker will report an error.  In the following example,
5948 @code{symbol_1} and @code{symbol_2} are assigned identical values:
5949 @smallexample
5950 @group
5951 SECTIONS@{ @dots{}
5952   .output @{
5953     .start = . ;
5954     @dots{}
5955     .end = . ;
5956     @}
5957   symbol_1 = .end - .start ;
5958   symbol_2 = SIZEOF(.output);
5959 @dots{} @}
5960 @end group
5961 @end smallexample
5962
5963 @item SIZEOF_HEADERS
5964 @itemx sizeof_headers
5965 @kindex SIZEOF_HEADERS
5966 @cindex header size
5967 Return the size in bytes of the output file's headers.  This is
5968 information which appears at the start of the output file.  You can use
5969 this number when setting the start address of the first section, if you
5970 choose, to facilitate paging.
5971
5972 @cindex not enough room for program headers
5973 @cindex program headers, not enough room
5974 When producing an ELF output file, if the linker script uses the
5975 @code{SIZEOF_HEADERS} builtin function, the linker must compute the
5976 number of program headers before it has determined all the section
5977 addresses and sizes.  If the linker later discovers that it needs
5978 additional program headers, it will report an error @samp{not enough
5979 room for program headers}.  To avoid this error, you must avoid using
5980 the @code{SIZEOF_HEADERS} function, or you must rework your linker
5981 script to avoid forcing the linker to use additional program headers, or
5982 you must define the program headers yourself using the @code{PHDRS}
5983 command (@pxref{PHDRS}).
5984 @end table
5985
5986 @node Implicit Linker Scripts
5987 @section Implicit Linker Scripts
5988 @cindex implicit linker scripts
5989 If you specify a linker input file which the linker can not recognize as
5990 an object file or an archive file, it will try to read the file as a
5991 linker script.  If the file can not be parsed as a linker script, the
5992 linker will report an error.
5993
5994 An implicit linker script will not replace the default linker script.
5995
5996 Typically an implicit linker script would contain only symbol
5997 assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION}
5998 commands.
5999
6000 Any input files read because of an implicit linker script will be read
6001 at the position in the command line where the implicit linker script was
6002 read.  This can affect archive searching.
6003
6004 @ifset GENERIC
6005 @node Machine Dependent
6006 @chapter Machine Dependent Features
6007
6008 @cindex machine dependencies
6009 @command{ld} has additional features on some platforms; the following
6010 sections describe them.  Machines where @command{ld} has no additional
6011 functionality are not listed.
6012
6013 @menu
6014 @ifset H8300
6015 * H8/300::                      @command{ld} and the H8/300
6016 @end ifset
6017 @ifset I960
6018 * i960::                        @command{ld} and the Intel 960 family
6019 @end ifset
6020 @ifset M68HC11
6021 * M68HC11/68HC12::              @code{ld} and the Motorola 68HC11 and 68HC12 families
6022 @end ifset
6023 @ifset ARM
6024 * ARM::                         @command{ld} and the ARM family
6025 @end ifset
6026 @ifset HPPA
6027 * HPPA ELF32::                  @command{ld} and HPPA 32-bit ELF
6028 @end ifset
6029 @ifset M68K
6030 * M68K::                        @command{ld} and the Motorola 68K family
6031 @end ifset
6032 @ifset MMIX
6033 * MMIX::                        @command{ld} and MMIX
6034 @end ifset
6035 @ifset MSP430
6036 * MSP430::                      @command{ld} and MSP430
6037 @end ifset
6038 @ifset POWERPC
6039 * PowerPC ELF32::               @command{ld} and PowerPC 32-bit ELF Support
6040 @end ifset
6041 @ifset POWERPC64
6042 * PowerPC64 ELF64::             @command{ld} and PowerPC64 64-bit ELF Support
6043 @end ifset
6044 @ifset SPU
6045 * SPU ELF::                     @command{ld} and SPU ELF Support
6046 @end ifset
6047 @ifset TICOFF
6048 * TI COFF::                     @command{ld} and TI COFF
6049 @end ifset
6050 @ifset WIN32
6051 * WIN32::                       @command{ld} and WIN32 (cygwin/mingw)
6052 @end ifset
6053 @ifset XTENSA
6054 * Xtensa::                      @command{ld} and Xtensa Processors
6055 @end ifset
6056 @end menu
6057 @end ifset
6058
6059 @ifset H8300
6060 @ifclear GENERIC
6061 @raisesections
6062 @end ifclear
6063
6064 @node H8/300
6065 @section @command{ld} and the H8/300
6066
6067 @cindex H8/300 support
6068 For the H8/300, @command{ld} can perform these global optimizations when
6069 you specify the @samp{--relax} command-line option.
6070
6071 @table @emph
6072 @cindex relaxing on H8/300
6073 @item relaxing address modes
6074 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6075 targets are within eight bits, and turns them into eight-bit
6076 program-counter relative @code{bsr} and @code{bra} instructions,
6077 respectively.
6078
6079 @cindex synthesizing on H8/300
6080 @item synthesizing instructions
6081 @c FIXME: specifically mov.b, or any mov instructions really? -> mov.b only, at least on H8, H8H, H8S
6082 @command{ld} finds all @code{mov.b} instructions which use the
6083 sixteen-bit absolute address form, but refer to the top
6084 page of memory, and changes them to use the eight-bit address form.
6085 (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into
6086 @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the
6087 top page of memory).
6088
6089 @command{ld} finds all @code{mov} instructions which use the register
6090 indirect with 32-bit displacement addressing mode, but use a small
6091 displacement inside 16-bit displacement range, and changes them to use
6092 the 16-bit displacement form.  (That is: the linker turns @samp{mov.b
6093 @code{@@}@var{d}:32,ERx} into @samp{mov.b @code{@@}@var{d}:16,ERx}
6094 whenever the displacement @var{d} is in the 16 bit signed integer
6095 range. Only implemented in ELF-format ld).
6096
6097 @item bit manipulation instructions
6098 @command{ld} finds all bit manipulation instructions like @code{band, bclr,
6099 biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor}
6100 which use 32 bit and 16 bit absolute address form, but refer to the top
6101 page of memory, and changes them to use the 8 bit address form.
6102 (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into
6103 @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in
6104 the top page of memory).
6105
6106 @item system control instructions
6107 @command{ld} finds all @code{ldc.w, stc.w} instructions which use the
6108 32 bit absolute address form, but refer to the top page of memory, and
6109 changes them to use 16 bit address form.
6110 (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into
6111 @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in
6112 the top page of memory).
6113 @end table
6114
6115 @ifclear GENERIC
6116 @lowersections
6117 @end ifclear
6118 @end ifset
6119
6120 @ifclear GENERIC
6121 @ifset Renesas
6122 @c This stuff is pointless to say unless you're especially concerned
6123 @c with Renesas chips; don't enable it for generic case, please.
6124 @node Renesas
6125 @chapter @command{ld} and Other Renesas Chips
6126
6127 @command{ld} also supports the Renesas (formerly Hitachi) H8/300H,
6128 H8/500, and SH chips.  No special features, commands, or command-line
6129 options are required for these chips.
6130 @end ifset
6131 @end ifclear
6132
6133 @ifset I960
6134 @ifclear GENERIC
6135 @raisesections
6136 @end ifclear
6137
6138 @node i960
6139 @section @command{ld} and the Intel 960 Family
6140
6141 @cindex i960 support
6142
6143 You can use the @samp{-A@var{architecture}} command line option to
6144 specify one of the two-letter names identifying members of the 960
6145 family; the option specifies the desired output target, and warns of any
6146 incompatible instructions in the input files.  It also modifies the
6147 linker's search strategy for archive libraries, to support the use of
6148 libraries specific to each particular architecture, by including in the
6149 search loop names suffixed with the string identifying the architecture.
6150
6151 For example, if your @command{ld} command line included @w{@samp{-ACA}} as
6152 well as @w{@samp{-ltry}}, the linker would look (in its built-in search
6153 paths, and in any paths you specify with @samp{-L}) for a library with
6154 the names
6155
6156 @smallexample
6157 @group
6158 try
6159 libtry.a
6160 tryca
6161 libtryca.a
6162 @end group
6163 @end smallexample
6164
6165 @noindent
6166 The first two possibilities would be considered in any event; the last
6167 two are due to the use of @w{@samp{-ACA}}.
6168
6169 You can meaningfully use @samp{-A} more than once on a command line, since
6170 the 960 architecture family allows combination of target architectures; each
6171 use will add another pair of name variants to search for when @w{@samp{-l}}
6172 specifies a library.
6173
6174 @cindex @option{--relax} on i960
6175 @cindex relaxing on i960
6176 @command{ld} supports the @samp{--relax} option for the i960 family.  If
6177 you specify @samp{--relax}, @command{ld} finds all @code{balx} and
6178 @code{calx} instructions whose targets are within 24 bits, and turns
6179 them into 24-bit program-counter relative @code{bal} and @code{cal}
6180 instructions, respectively.  @command{ld} also turns @code{cal}
6181 instructions into @code{bal} instructions when it determines that the
6182 target subroutine is a leaf routine (that is, the target subroutine does
6183 not itself call any subroutines).
6184
6185 @cindex Cortex-A8 erratum workaround
6186 @kindex --fix-cortex-a8
6187 @kindex --no-fix-cortex-a8
6188 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}.
6189
6190 The erratum only affects Thumb-2 code.  Please contact ARM for further details.
6191
6192 @kindex --merge-exidx-entries
6193 @kindex --no-merge-exidx-entries
6194 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo.
6195
6196 @ifclear GENERIC
6197 @lowersections
6198 @end ifclear
6199 @end ifset
6200
6201 @ifset ARM
6202 @ifclear GENERIC
6203 @raisesections
6204 @end ifclear
6205
6206 @ifset M68HC11
6207 @ifclear GENERIC
6208 @raisesections
6209 @end ifclear
6210
6211 @node M68HC11/68HC12
6212 @section @command{ld} and the Motorola 68HC11 and 68HC12 families
6213
6214 @cindex M68HC11 and 68HC12 support
6215
6216 @subsection Linker Relaxation
6217
6218 For the Motorola 68HC11, @command{ld} can perform these global
6219 optimizations when you specify the @samp{--relax} command-line option.
6220
6221 @table @emph
6222 @cindex relaxing on M68HC11
6223 @item relaxing address modes
6224 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6225 targets are within eight bits, and turns them into eight-bit
6226 program-counter relative @code{bsr} and @code{bra} instructions,
6227 respectively.
6228
6229 @command{ld} also looks at all 16-bit extended addressing modes and
6230 transforms them in a direct addressing mode when the address is in
6231 page 0 (between 0 and 0x0ff).
6232
6233 @item relaxing gcc instruction group
6234 When @command{gcc} is called with @option{-mrelax}, it can emit group
6235 of instructions that the linker can optimize to use a 68HC11 direct
6236 addressing mode. These instructions consists of @code{bclr} or
6237 @code{bset} instructions.
6238
6239 @end table
6240
6241 @subsection Trampoline Generation
6242
6243 @cindex trampoline generation on M68HC11
6244 @cindex trampoline generation on M68HC12
6245 For 68HC11 and 68HC12, @command{ld} can generate trampoline code to
6246 call a far function using a normal @code{jsr} instruction. The linker
6247 will also change the relocation to some far function to use the
6248 trampoline address instead of the function address. This is typically the
6249 case when a pointer to a function is taken. The pointer will in fact
6250 point to the function trampoline.
6251
6252 @ifclear GENERIC
6253 @lowersections
6254 @end ifclear
6255 @end ifset
6256
6257 @node ARM
6258 @section @command{ld} and the ARM family
6259
6260 @cindex ARM interworking support
6261 @kindex --support-old-code
6262 For the ARM, @command{ld} will generate code stubs to allow functions calls
6263 between ARM and Thumb code.  These stubs only work with code that has
6264 been compiled and assembled with the @samp{-mthumb-interwork} command
6265 line option.  If it is necessary to link with old ARM object files or
6266 libraries, which have not been compiled with the -mthumb-interwork
6267 option then the @samp{--support-old-code} command line switch should be
6268 given to the linker.  This will make it generate larger stub functions
6269 which will work with non-interworking aware ARM code.  Note, however,
6270 the linker does not support generating stubs for function calls to
6271 non-interworking aware Thumb code.
6272
6273 @cindex thumb entry point
6274 @cindex entry point, thumb
6275 @kindex --thumb-entry=@var{entry}
6276 The @samp{--thumb-entry} switch is a duplicate of the generic
6277 @samp{--entry} switch, in that it sets the program's starting address.
6278 But it also sets the bottom bit of the address, so that it can be
6279 branched to using a BX instruction, and the program will start
6280 executing in Thumb mode straight away.
6281
6282 @cindex PE import table prefixing
6283 @kindex --use-nul-prefixed-import-tables
6284 The @samp{--use-nul-prefixed-import-tables} switch is specifying, that
6285 the import tables idata4 and idata5 have to be generated with a zero
6286 element prefix for import libraries. This is the old style to generate
6287 import tables. By default this option is turned off.
6288
6289 @cindex BE8
6290 @kindex --be8
6291 The @samp{--be8} switch instructs @command{ld} to generate BE8 format
6292 executables.  This option is only valid when linking big-endian objects.
6293 The resulting image will contain big-endian data and little-endian code.
6294
6295 @cindex TARGET1
6296 @kindex --target1-rel
6297 @kindex --target1-abs
6298 The @samp{R_ARM_TARGET1} relocation is typically used for entries in the
6299 @samp{.init_array} section.  It is interpreted as either @samp{R_ARM_REL32}
6300 or @samp{R_ARM_ABS32}, depending on the target.  The @samp{--target1-rel}
6301 and @samp{--target1-abs} switches override the default.
6302
6303 @cindex TARGET2
6304 @kindex --target2=@var{type}
6305 The @samp{--target2=type} switch overrides the default definition of the
6306 @samp{R_ARM_TARGET2} relocation.  Valid values for @samp{type}, their
6307 meanings, and target defaults are as follows:
6308 @table @samp
6309 @item rel
6310 @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi)
6311 @item abs
6312 @samp{R_ARM_ABS32} (arm*-*-symbianelf)
6313 @item got-rel
6314 @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd)
6315 @end table
6316
6317 @cindex FIX_V4BX
6318 @kindex --fix-v4bx
6319 The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF
6320 specification) enables objects compiled for the ARMv4 architecture to be
6321 interworking-safe when linked with other objects compiled for ARMv4t, but
6322 also allows pure ARMv4 binaries to be built from the same ARMv4 objects.
6323
6324 In the latter case, the switch @option{--fix-v4bx} must be passed to the
6325 linker, which causes v4t @code{BX rM} instructions to be rewritten as
6326 @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction.
6327
6328 In the former case, the switch should not be used, and @samp{R_ARM_V4BX}
6329 relocations are ignored.
6330
6331 @cindex FIX_V4BX_INTERWORKING
6332 @kindex --fix-v4bx-interworking
6333 Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX}
6334 relocations with a branch to the following veneer:
6335
6336 @smallexample
6337 TST rM, #1
6338 MOVEQ PC, rM
6339 BX Rn
6340 @end smallexample
6341
6342 This allows generation of libraries/applications that work on ARMv4 cores
6343 and are still interworking safe.  Note that the above veneer clobbers the
6344 condition flags, so may cause incorrect program behavior in rare cases.
6345
6346 @cindex USE_BLX
6347 @kindex --use-blx
6348 The @samp{--use-blx} switch enables the linker to use ARM/Thumb
6349 BLX instructions (available on ARMv5t and above) in various
6350 situations. Currently it is used to perform calls via the PLT from Thumb
6351 code using BLX rather than using BX and a mode-switching stub before
6352 each PLT entry. This should lead to such calls executing slightly faster.
6353
6354 This option is enabled implicitly for SymbianOS, so there is no need to
6355 specify it if you are using that target.
6356
6357 @cindex VFP11_DENORM_FIX
6358 @kindex --vfp11-denorm-fix
6359 The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a
6360 bug in certain VFP11 coprocessor hardware, which sometimes allows
6361 instructions with denorm operands (which must be handled by support code)
6362 to have those operands overwritten by subsequent instructions before
6363 the support code can read the intended values.
6364
6365 The bug may be avoided in scalar mode if you allow at least one
6366 intervening instruction between a VFP11 instruction which uses a register
6367 and another instruction which writes to the same register, or at least two
6368 intervening instructions if vector mode is in use. The bug only affects
6369 full-compliance floating-point mode: you do not need this workaround if
6370 you are using "runfast" mode. Please contact ARM for further details.
6371
6372 If you know you are using buggy VFP11 hardware, you can
6373 enable this workaround by specifying the linker option
6374 @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar
6375 mode only, or @samp{--vfp-denorm-fix=vector} if you are using
6376 vector mode (the latter also works for scalar code). The default is
6377 @samp{--vfp-denorm-fix=none}.
6378
6379 If the workaround is enabled, instructions are scanned for
6380 potentially-troublesome sequences, and a veneer is created for each
6381 such sequence which may trigger the erratum. The veneer consists of the
6382 first instruction of the sequence and a branch back to the subsequent
6383 instruction. The original instruction is then replaced with a branch to
6384 the veneer. The extra cycles required to call and return from the veneer
6385 are sufficient to avoid the erratum in both the scalar and vector cases.
6386
6387 @cindex ARM1176 erratum workaround
6388 @kindex --fix-arm1176
6389 @kindex --no-fix-arm1176
6390 The @samp{--fix-arm1176} switch enables a link-time workaround for an erratum
6391 in certain ARM1176 processors.  The workaround is enabled by default if you
6392 are targeting ARM v6 (excluding ARM v6T2) or earlier.  It can be disabled
6393 unconditionally by specifying @samp{--no-fix-arm1176}.
6394
6395 Further information is available in the ``ARM1176JZ-S and ARM1176JZF-S
6396 Programmer Advice Notice'' available on the ARM documentation website at:
6397 http://infocenter.arm.com/.
6398
6399 @cindex NO_ENUM_SIZE_WARNING
6400 @kindex --no-enum-size-warning
6401 The @option{--no-enum-size-warning} switch prevents the linker from
6402 warning when linking object files that specify incompatible EABI
6403 enumeration size attributes.  For example, with this switch enabled,
6404 linking of an object file using 32-bit enumeration values with another
6405 using enumeration values fitted into the smallest possible space will
6406 not be diagnosed.
6407
6408 @cindex NO_WCHAR_SIZE_WARNING
6409 @kindex --no-wchar-size-warning
6410 The @option{--no-wchar-size-warning} switch prevents the linker from
6411 warning when linking object files that specify incompatible EABI
6412 @code{wchar_t} size attributes.  For example, with this switch enabled,
6413 linking of an object file using 32-bit @code{wchar_t} values with another
6414 using 16-bit @code{wchar_t} values will not be diagnosed.
6415
6416 @cindex PIC_VENEER
6417 @kindex --pic-veneer
6418 The @samp{--pic-veneer} switch makes the linker use PIC sequences for
6419 ARM/Thumb interworking veneers, even if the rest of the binary
6420 is not PIC.  This avoids problems on uClinux targets where
6421 @samp{--emit-relocs} is used to generate relocatable binaries.
6422
6423 @cindex STUB_GROUP_SIZE
6424 @kindex --stub-group-size=@var{N}
6425 The linker will automatically generate and insert small sequences of
6426 code into a linked ARM ELF executable whenever an attempt is made to
6427 perform a function call to a symbol that is too far away.  The
6428 placement of these sequences of instructions - called stubs - is
6429 controlled by the command line option @option{--stub-group-size=N}.
6430 The placement is important because a poor choice can create a need for
6431 duplicate stubs, increasing the code size.  The linker will try to
6432 group stubs together in order to reduce interruptions to the flow of
6433 code, but it needs guidance as to how big these groups should be and
6434 where they should be placed.
6435
6436 The value of @samp{N}, the parameter to the
6437 @option{--stub-group-size=} option controls where the stub groups are
6438 placed.  If it is negative then all stubs are placed after the first
6439 branch that needs them.  If it is positive then the stubs can be
6440 placed either before or after the branches that need them.  If the
6441 value of @samp{N} is 1 (either +1 or -1) then the linker will choose
6442 exactly where to place groups of stubs, using its built in heuristics.
6443 A value of @samp{N} greater than 1 (or smaller than -1) tells the
6444 linker that a single group of stubs can service at most @samp{N} bytes
6445 from the input sections.
6446
6447 The default, if @option{--stub-group-size=} is not specified, is
6448 @samp{N = +1}.
6449
6450 Farcalls stubs insertion is fully supported for the ARM-EABI target
6451 only, because it relies on object files properties not present
6452 otherwise.
6453
6454 @ifclear GENERIC
6455 @lowersections
6456 @end ifclear
6457 @end ifset
6458
6459 @ifset HPPA
6460 @ifclear GENERIC
6461 @raisesections
6462 @end ifclear
6463
6464 @node HPPA ELF32
6465 @section @command{ld} and HPPA 32-bit ELF Support
6466 @cindex HPPA multiple sub-space stubs
6467 @kindex --multi-subspace
6468 When generating a shared library, @command{ld} will by default generate
6469 import stubs suitable for use with a single sub-space application.
6470 The @samp{--multi-subspace} switch causes @command{ld} to generate export
6471 stubs, and different (larger) import stubs suitable for use with
6472 multiple sub-spaces.
6473
6474 @cindex HPPA stub grouping
6475 @kindex --stub-group-size=@var{N}
6476 Long branch stubs and import/export stubs are placed by @command{ld} in
6477 stub sections located between groups of input sections.
6478 @samp{--stub-group-size} specifies the maximum size of a group of input
6479 sections handled by one stub section.  Since branch offsets are signed,
6480 a stub section may serve two groups of input sections, one group before
6481 the stub section, and one group after it.  However, when using
6482 conditional branches that require stubs, it may be better (for branch
6483 prediction) that stub sections only serve one group of input sections.
6484 A negative value for @samp{N} chooses this scheme, ensuring that
6485 branches to stubs always use a negative offset.  Two special values of
6486 @samp{N} are recognized, @samp{1} and @samp{-1}.  These both instruct
6487 @command{ld} to automatically size input section groups for the branch types
6488 detected, with the same behaviour regarding stub placement as other
6489 positive or negative values of @samp{N} respectively.
6490
6491 Note that @samp{--stub-group-size} does not split input sections.  A
6492 single input section larger than the group size specified will of course
6493 create a larger group (of one section).  If input sections are too
6494 large, it may not be possible for a branch to reach its stub.
6495
6496 @ifclear GENERIC
6497 @lowersections
6498 @end ifclear
6499 @end ifset
6500
6501 @ifset M68K
6502 @ifclear GENERIC
6503 @raisesections
6504 @end ifclear
6505
6506 @node M68K
6507 @section @command{ld} and the Motorola 68K family
6508
6509 @cindex Motorola 68K GOT generation
6510 @kindex --got=@var{type}
6511 The @samp{--got=@var{type}} option lets you choose the GOT generation scheme.
6512 The choices are @samp{single}, @samp{negative}, @samp{multigot} and
6513 @samp{target}.  When @samp{target} is selected the linker chooses
6514 the default GOT generation scheme for the current target.
6515 @samp{single} tells the linker to generate a single GOT with
6516 entries only at non-negative offsets.
6517 @samp{negative} instructs the linker to generate a single GOT with
6518 entries at both negative and positive offsets.  Not all environments
6519 support such GOTs.
6520 @samp{multigot} allows the linker to generate several GOTs in the
6521 output file.  All GOT references from a single input object
6522 file access the same GOT, but references from different input object
6523 files might access different GOTs.  Not all environments support such GOTs.
6524
6525 @ifclear GENERIC
6526 @lowersections
6527 @end ifclear
6528 @end ifset
6529
6530 @ifset MMIX
6531 @ifclear GENERIC
6532 @raisesections
6533 @end ifclear
6534
6535 @node MMIX
6536 @section @code{ld} and MMIX
6537 For MMIX, there is a choice of generating @code{ELF} object files or
6538 @code{mmo} object files when linking.  The simulator @code{mmix}
6539 understands the @code{mmo} format.  The binutils @code{objcopy} utility
6540 can translate between the two formats.
6541
6542 There is one special section, the @samp{.MMIX.reg_contents} section.
6543 Contents in this section is assumed to correspond to that of global
6544 registers, and symbols referring to it are translated to special symbols,
6545 equal to registers.  In a final link, the start address of the
6546 @samp{.MMIX.reg_contents} section corresponds to the first allocated
6547 global register multiplied by 8.  Register @code{$255} is not included in
6548 this section; it is always set to the program entry, which is at the
6549 symbol @code{Main} for @code{mmo} files.
6550
6551 Global symbols with the prefix @code{__.MMIX.start.}, for example
6552 @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special.
6553 The default linker script uses these to set the default start address
6554 of a section.
6555
6556 Initial and trailing multiples of zero-valued 32-bit words in a section,
6557 are left out from an mmo file.
6558
6559 @ifclear GENERIC
6560 @lowersections
6561 @end ifclear
6562 @end ifset
6563
6564 @ifset MSP430
6565 @ifclear GENERIC
6566 @raisesections
6567 @end ifclear
6568
6569 @node  MSP430
6570 @section @code{ld} and MSP430
6571 For the MSP430 it is possible to select the MPU architecture.  The flag @samp{-m [mpu type]}
6572 will select an appropriate linker script for selected MPU type.  (To get a list of known MPUs
6573 just pass @samp{-m help} option to the linker).
6574
6575 @cindex MSP430 extra sections
6576 The linker will recognize some extra sections which are MSP430 specific:
6577
6578 @table @code
6579 @item @samp{.vectors}
6580 Defines a portion of ROM where interrupt vectors located.
6581
6582 @item @samp{.bootloader}
6583 Defines the bootloader portion of the ROM (if applicable).  Any code
6584 in this section will be uploaded to the MPU.
6585
6586 @item @samp{.infomem}
6587 Defines an information memory section (if applicable).  Any code in
6588 this section will be uploaded to the MPU.
6589
6590 @item @samp{.infomemnobits}
6591 This is the same as the @samp{.infomem} section except that any code
6592 in this section will not be uploaded to the MPU.
6593
6594 @item @samp{.noinit}
6595 Denotes a portion of RAM located above @samp{.bss} section.
6596
6597 The last two sections are used by gcc.
6598 @end table
6599
6600 @ifclear GENERIC
6601 @lowersections
6602 @end ifclear
6603 @end ifset
6604
6605 @ifset POWERPC
6606 @ifclear GENERIC
6607 @raisesections
6608 @end ifclear
6609
6610 @node PowerPC ELF32
6611 @section @command{ld} and PowerPC 32-bit ELF Support
6612 @cindex PowerPC long branches
6613 @kindex --relax on PowerPC
6614 Branches on PowerPC processors are limited to a signed 26-bit
6615 displacement, which may result in @command{ld} giving
6616 @samp{relocation truncated to fit} errors with very large programs.
6617 @samp{--relax} enables the generation of trampolines that can access
6618 the entire 32-bit address space.  These trampolines are inserted at
6619 section boundaries, so may not themselves be reachable if an input
6620 section exceeds 33M in size.  You may combine @samp{-r} and
6621 @samp{--relax} to add trampolines in a partial link.  In that case
6622 both branches to undefined symbols and inter-section branches are also
6623 considered potentially out of range, and trampolines inserted.
6624
6625 @cindex PowerPC ELF32 options
6626 @table @option
6627 @cindex PowerPC PLT
6628 @kindex --bss-plt
6629 @item --bss-plt
6630 Current PowerPC GCC accepts a @samp{-msecure-plt} option that
6631 generates code capable of using a newer PLT and GOT layout that has
6632 the security advantage of no executable section ever needing to be
6633 writable and no writable section ever being executable.  PowerPC
6634 @command{ld} will generate this layout, including stubs to access the
6635 PLT, if all input files (including startup and static libraries) were
6636 compiled with @samp{-msecure-plt}.  @samp{--bss-plt} forces the old
6637 BSS PLT (and GOT layout) which can give slightly better performance.
6638
6639 @kindex --secure-plt
6640 @item --secure-plt
6641 @command{ld} will use the new PLT and GOT layout if it is linking new
6642 @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically
6643 when linking non-PIC code.  This option requests the new PLT and GOT
6644 layout.  A warning will be given if some object file requires the old
6645 style BSS PLT.
6646
6647 @cindex PowerPC GOT
6648 @kindex --sdata-got
6649 @item --sdata-got
6650 The new secure PLT and GOT are placed differently relative to other
6651 sections compared to older BSS PLT and GOT placement.  The location of
6652 @code{.plt} must change because the new secure PLT is an initialized
6653 section while the old PLT is uninitialized.  The reason for the
6654 @code{.got} change is more subtle:  The new placement allows
6655 @code{.got} to be read-only in applications linked with
6656 @samp{-z relro -z now}.  However, this placement means that
6657 @code{.sdata} cannot always be used in shared libraries, because the
6658 PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT
6659 pointer.  @samp{--sdata-got} forces the old GOT placement.  PowerPC
6660 GCC doesn't use @code{.sdata} in shared libraries, so this option is
6661 really only useful for other compilers that may do so.
6662
6663 @cindex PowerPC stub symbols
6664 @kindex --emit-stub-syms
6665 @item --emit-stub-syms
6666 This option causes @command{ld} to label linker stubs with a local
6667 symbol that encodes the stub type and destination.
6668
6669 @cindex PowerPC TLS optimization
6670 @kindex --no-tls-optimize
6671 @item --no-tls-optimize
6672 PowerPC @command{ld} normally performs some optimization of code
6673 sequences used to access Thread-Local Storage.  Use this option to
6674 disable the optimization.
6675 @end table
6676
6677 @ifclear GENERIC
6678 @lowersections
6679 @end ifclear
6680 @end ifset
6681
6682 @ifset POWERPC64
6683 @ifclear GENERIC
6684 @raisesections
6685 @end ifclear
6686
6687 @node PowerPC64 ELF64
6688 @section @command{ld} and PowerPC64 64-bit ELF Support
6689
6690 @cindex PowerPC64 ELF64 options
6691 @table @option
6692 @cindex PowerPC64 stub grouping
6693 @kindex --stub-group-size
6694 @item --stub-group-size
6695 Long branch stubs, PLT call stubs  and TOC adjusting stubs are placed
6696 by @command{ld} in stub sections located between groups of input sections.
6697 @samp{--stub-group-size} specifies the maximum size of a group of input
6698 sections handled by one stub section.  Since branch offsets are signed,
6699 a stub section may serve two groups of input sections, one group before
6700 the stub section, and one group after it.  However, when using
6701 conditional branches that require stubs, it may be better (for branch
6702 prediction) that stub sections only serve one group of input sections.
6703 A negative value for @samp{N} chooses this scheme, ensuring that
6704 branches to stubs always use a negative offset.  Two special values of
6705 @samp{N} are recognized, @samp{1} and @samp{-1}.  These both instruct
6706 @command{ld} to automatically size input section groups for the branch types
6707 detected, with the same behaviour regarding stub placement as other
6708 positive or negative values of @samp{N} respectively.
6709
6710 Note that @samp{--stub-group-size} does not split input sections.  A
6711 single input section larger than the group size specified will of course
6712 create a larger group (of one section).  If input sections are too
6713 large, it may not be possible for a branch to reach its stub.
6714
6715 @cindex PowerPC64 stub symbols
6716 @kindex --emit-stub-syms
6717 @item --emit-stub-syms
6718 This option causes @command{ld} to label linker stubs with a local
6719 symbol that encodes the stub type and destination.
6720
6721 @cindex PowerPC64 dot symbols
6722 @kindex --dotsyms
6723 @kindex --no-dotsyms
6724 @item --dotsyms, --no-dotsyms
6725 These two options control how @command{ld} interprets version patterns
6726 in a version script.  Older PowerPC64 compilers emitted both a
6727 function descriptor symbol with the same name as the function, and a
6728 code entry symbol with the name prefixed by a dot (@samp{.}).  To
6729 properly version a function @samp{foo}, the version script thus needs
6730 to control both @samp{foo} and @samp{.foo}.  The option
6731 @samp{--dotsyms}, on by default, automatically adds the required
6732 dot-prefixed patterns.  Use @samp{--no-dotsyms} to disable this
6733 feature.
6734
6735 @cindex PowerPC64 TLS optimization
6736 @kindex --no-tls-optimize
6737 @item --no-tls-optimize
6738 PowerPC64 @command{ld} normally performs some optimization of code
6739 sequences used to access Thread-Local Storage.  Use this option to
6740 disable the optimization.
6741
6742 @cindex PowerPC64 OPD optimization
6743 @kindex --no-opd-optimize
6744 @item --no-opd-optimize
6745 PowerPC64 @command{ld} normally removes @code{.opd} section entries
6746 corresponding to deleted link-once functions, or functions removed by
6747 the action of @samp{--gc-sections} or linker script @code{/DISCARD/}.
6748 Use this option to disable @code{.opd} optimization.
6749
6750 @cindex PowerPC64 OPD spacing
6751 @kindex --non-overlapping-opd
6752 @item --non-overlapping-opd
6753 Some PowerPC64 compilers have an option to generate compressed
6754 @code{.opd} entries spaced 16 bytes apart, overlapping the third word,
6755 the static chain pointer (unused in C) with the first word of the next
6756 entry.  This option expands such entries to the full 24 bytes.
6757
6758 @cindex PowerPC64 TOC optimization
6759 @kindex --no-toc-optimize
6760 @item --no-toc-optimize
6761 PowerPC64 @command{ld} normally removes unused @code{.toc} section
6762 entries.  Such entries are detected by examining relocations that
6763 reference the TOC in code sections.  A reloc in a deleted code section
6764 marks a TOC word as unneeded, while a reloc in a kept code section
6765 marks a TOC word as needed.  Since the TOC may reference itself, TOC
6766 relocs are also examined.  TOC words marked as both needed and
6767 unneeded will of course be kept.  TOC words without any referencing
6768 reloc are assumed to be part of a multi-word entry, and are kept or
6769 discarded as per the nearest marked preceding word.  This works
6770 reliably for compiler generated code, but may be incorrect if assembly
6771 code is used to insert TOC entries.  Use this option to disable the
6772 optimization.
6773
6774 @cindex PowerPC64 multi-TOC
6775 @kindex --no-multi-toc
6776 @item --no-multi-toc
6777 If given any toc option besides @code{-mcmodel=medium} or
6778 @code{-mcmodel=large}, PowerPC64 GCC generates code for a TOC model
6779 where TOC
6780 entries are accessed with a 16-bit offset from r2.  This limits the
6781 total TOC size to 64K.  PowerPC64 @command{ld} extends this limit by
6782 grouping code sections such that each group uses less than 64K for its
6783 TOC entries, then inserts r2 adjusting stubs between inter-group
6784 calls.  @command{ld} does not split apart input sections, so cannot
6785 help if a single input file has a @code{.toc} section that exceeds
6786 64K, most likely from linking multiple files with @command{ld -r}.
6787 Use this option to turn off this feature.
6788
6789 @cindex PowerPC64 TOC sorting
6790 @kindex --no-toc-sort
6791 @item --no-toc-sort
6792 By default, @command{ld} sorts TOC sections so that those whose file
6793 happens to have a section called @code{.init} or @code{.fini} are
6794 placed first, followed by TOC sections referenced by code generated
6795 with PowerPC64 gcc's @code{-mcmodel=small}, and lastly TOC sections
6796 referenced only by code generated with PowerPC64 gcc's
6797 @code{-mcmodel=medium} or @code{-mcmodel=large} options.  Doing this
6798 results in better TOC grouping for multi-TOC.  Use this option to turn
6799 off this feature.
6800
6801 @cindex PowerPC64 PLT stub alignment
6802 @kindex --plt-align
6803 @kindex --no-plt-align
6804 @item --plt-align
6805 @itemx --no-plt-align
6806 Use these options to control whether individual PLT call stubs are
6807 aligned to a 32-byte boundary, or to the specified power of two
6808 boundary when using @code{--plt-align=}.  By default PLT call stubs
6809 are packed tightly.
6810
6811 @cindex PowerPC64 PLT call stub static chain
6812 @kindex --plt-static-chain
6813 @kindex --no-plt-static-chain
6814 @item --plt-static-chain
6815 @itemx --no-plt-static-chain
6816 Use these options to control whether PLT call stubs load the static
6817 chain pointer (r11).  @code{ld} defaults to not loading the static
6818 chain since there is never any need to do so on a PLT call.
6819
6820 @cindex PowerPC64 PLT call stub thread safety
6821 @kindex --plt-thread-safe
6822 @kindex --no-plt-thread-safe
6823 @item --plt-thread-safe
6824 @itemx --no-thread-safe
6825 With power7's weakly ordered memory model, it is possible when using
6826 lazy binding for ld.so to update a plt entry in one thread and have
6827 another thread see the individual plt entry words update in the wrong
6828 order, despite ld.so carefully writing in the correct order and using
6829 memory write barriers.  To avoid this we need some sort of read
6830 barrier in the call stub, or use LD_BIND_NOW=1.  By default, @code{ld}
6831 looks for calls to commonly used functions that create threads, and if
6832 seen, adds the necessary barriers.  Use these options to change the
6833 default behaviour.
6834 @end table
6835
6836 @ifclear GENERIC
6837 @lowersections
6838 @end ifclear
6839 @end ifset
6840
6841 @ifset SPU
6842 @ifclear GENERIC
6843 @raisesections
6844 @end ifclear
6845
6846 @node SPU ELF
6847 @section @command{ld} and SPU ELF Support
6848
6849 @cindex SPU ELF options
6850 @table @option
6851
6852 @cindex SPU plugins
6853 @kindex --plugin
6854 @item --plugin
6855 This option marks an executable as a PIC plugin module.
6856
6857 @cindex SPU overlays
6858 @kindex --no-overlays
6859 @item --no-overlays
6860 Normally, @command{ld} recognizes calls to functions within overlay
6861 regions, and redirects such calls to an overlay manager via a stub.
6862 @command{ld} also provides a built-in overlay manager.  This option
6863 turns off all this special overlay handling.
6864
6865 @cindex SPU overlay stub symbols
6866 @kindex --emit-stub-syms
6867 @item --emit-stub-syms
6868 This option causes @command{ld} to label overlay stubs with a local
6869 symbol that encodes the stub type and destination.
6870
6871 @cindex SPU extra overlay stubs
6872 @kindex --extra-overlay-stubs
6873 @item --extra-overlay-stubs
6874 This option causes @command{ld} to add overlay call stubs on all
6875 function calls out of overlay regions.  Normally stubs are not added
6876 on calls to non-overlay regions.
6877
6878 @cindex SPU local store size
6879 @kindex --local-store=lo:hi
6880 @item --local-store=lo:hi
6881 @command{ld} usually checks that a final executable for SPU fits in
6882 the address range 0 to 256k.  This option may be used to change the
6883 range.  Disable the check entirely with @option{--local-store=0:0}.
6884
6885 @cindex SPU
6886 @kindex --stack-analysis
6887 @item --stack-analysis
6888 SPU local store space is limited.  Over-allocation of stack space
6889 unnecessarily limits space available for code and data, while
6890 under-allocation results in runtime failures.  If given this option,
6891 @command{ld} will provide an estimate of maximum stack usage.
6892 @command{ld} does this by examining symbols in code sections to
6893 determine the extents of functions, and looking at function prologues
6894 for stack adjusting instructions.  A call-graph is created by looking
6895 for relocations on branch instructions.  The graph is then searched
6896 for the maximum stack usage path.  Note that this analysis does not
6897 find calls made via function pointers, and does not handle recursion
6898 and other cycles in the call graph.  Stack usage may be
6899 under-estimated if your code makes such calls.  Also, stack usage for
6900 dynamic allocation, e.g. alloca, will not be detected.  If a link map
6901 is requested, detailed information about each function's stack usage
6902 and calls will be given.
6903
6904 @cindex SPU
6905 @kindex --emit-stack-syms
6906 @item --emit-stack-syms
6907 This option, if given along with @option{--stack-analysis} will result
6908 in @command{ld} emitting stack sizing symbols for each function.
6909 These take the form @code{__stack_<function_name>} for global
6910 functions, and @code{__stack_<number>_<function_name>} for static
6911 functions.  @code{<number>} is the section id in hex.  The value of
6912 such symbols is the stack requirement for the corresponding function.
6913 The symbol size will be zero, type @code{STT_NOTYPE}, binding
6914 @code{STB_LOCAL}, and section @code{SHN_ABS}.
6915 @end table
6916
6917 @ifclear GENERIC
6918 @lowersections
6919 @end ifclear
6920 @end ifset
6921
6922 @ifset TICOFF
6923 @ifclear GENERIC
6924 @raisesections
6925 @end ifclear
6926
6927 @node TI COFF
6928 @section @command{ld}'s Support for Various TI COFF Versions
6929 @cindex TI COFF versions
6930 @kindex --format=@var{version}
6931 The @samp{--format} switch allows selection of one of the various
6932 TI COFF versions.  The latest of this writing is 2; versions 0 and 1 are
6933 also supported.  The TI COFF versions also vary in header byte-order
6934 format; @command{ld} will read any version or byte order, but the output
6935 header format depends on the default specified by the specific target.
6936
6937 @ifclear GENERIC
6938 @lowersections
6939 @end ifclear
6940 @end ifset
6941
6942 @ifset WIN32
6943 @ifclear GENERIC
6944 @raisesections
6945 @end ifclear
6946
6947 @node WIN32
6948 @section @command{ld} and WIN32 (cygwin/mingw)
6949
6950 This section describes some of the win32 specific @command{ld} issues.
6951 See @ref{Options,,Command Line Options} for detailed description of the
6952 command line options mentioned here.
6953
6954 @table @emph
6955 @cindex import libraries
6956 @item import libraries
6957 The standard Windows linker creates and uses so-called import
6958 libraries, which contains information for linking to dll's.  They are
6959 regular static archives and are handled as any other static
6960 archive.  The cygwin and mingw ports of @command{ld} have specific
6961 support for creating such libraries provided with the
6962 @samp{--out-implib} command line option.
6963
6964 @item   exporting DLL symbols
6965 @cindex exporting DLL symbols
6966 The cygwin/mingw @command{ld} has several ways to export symbols for dll's.
6967
6968 @table @emph
6969 @item   using auto-export functionality
6970 @cindex using auto-export functionality
6971 By default @command{ld} exports symbols with the auto-export functionality,
6972 which is controlled by the following command line options:
6973
6974 @itemize
6975 @item --export-all-symbols   [This is the default]
6976 @item --exclude-symbols
6977 @item --exclude-libs
6978 @item --exclude-modules-for-implib
6979 @item --version-script
6980 @end itemize
6981
6982 When auto-export is in operation, @command{ld} will export all the non-local
6983 (global and common) symbols it finds in a DLL, with the exception of a few
6984 symbols known to belong to the system's runtime and libraries.  As it will
6985 often not be desirable to export all of a DLL's symbols, which may include
6986 private functions that are not part of any public interface, the command-line
6987 options listed above may be used to filter symbols out from the list for
6988 exporting.  The @samp{--output-def} option can be used in order to see the
6989 final list of exported symbols with all exclusions taken into effect.
6990
6991 If @samp{--export-all-symbols} is not given explicitly on the
6992 command line, then the default auto-export behavior will be @emph{disabled}
6993 if either of the following are true:
6994
6995 @itemize
6996 @item A DEF file is used.
6997 @item Any symbol in any object file was marked with the __declspec(dllexport) attribute.
6998 @end itemize
6999
7000 @item   using a DEF file
7001 @cindex using a DEF file
7002 Another way of exporting symbols is using a DEF file.  A DEF file is
7003 an ASCII file containing definitions of symbols which should be
7004 exported when a dll is created.  Usually it is named @samp{<dll
7005 name>.def} and is added as any other object file to the linker's
7006 command line.  The file's name must end in @samp{.def} or @samp{.DEF}.
7007
7008 @example
7009 gcc -o <output> <objectfiles> <dll name>.def
7010 @end example
7011
7012 Using a DEF file turns off the normal auto-export behavior, unless the
7013 @samp{--export-all-symbols} option is also used.
7014
7015 Here is an example of a DEF file for a shared library called @samp{xyz.dll}:
7016
7017 @example
7018 LIBRARY "xyz.dll" BASE=0x20000000
7019
7020 EXPORTS
7021 foo
7022 bar
7023 _bar = bar
7024 another_foo = abc.dll.afoo
7025 var1 DATA
7026 doo = foo == foo2
7027 eoo DATA == var1
7028 @end example
7029
7030 This example defines a DLL with a non-default base address and seven
7031 symbols in the export table. The third exported symbol @code{_bar} is an
7032 alias for the second. The fourth symbol, @code{another_foo} is resolved
7033 by "forwarding" to another module and treating it as an alias for
7034 @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol
7035 @code{var1} is declared to be a data object. The @samp{doo} symbol in
7036 export library is an alias of @samp{foo}, which gets the string name
7037 in export table @samp{foo2}. The @samp{eoo} symbol is an data export
7038 symbol, which gets in export table the name @samp{var1}.
7039
7040 The optional @code{LIBRARY <name>} command indicates the @emph{internal}
7041 name of the output DLL. If @samp{<name>} does not include a suffix,
7042 the default library suffix, @samp{.DLL} is appended.
7043
7044 When the .DEF file is used to build an application, rather than a
7045 library, the @code{NAME <name>} command should be used instead of
7046 @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default
7047 executable suffix, @samp{.EXE} is appended.
7048
7049 With either @code{LIBRARY <name>} or @code{NAME <name>} the optional
7050 specification @code{BASE = <number>} may be used to specify a
7051 non-default base address for the image.
7052
7053 If neither @code{LIBRARY <name>} nor  @code{NAME <name>} is specified,
7054 or they specify an empty string, the internal name is the same as the
7055 filename specified on the command line.
7056
7057 The complete specification of an export symbol is:
7058
7059 @example
7060 EXPORTS
7061   ( (  ( <name1> [ = <name2> ] )
7062      | ( <name1> = <module-name> . <external-name>))
7063   [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) *
7064 @end example
7065
7066 Declares @samp{<name1>} as an exported symbol from the DLL, or declares
7067 @samp{<name1>} as an exported alias for @samp{<name2>}; or declares
7068 @samp{<name1>} as a "forward" alias for the symbol
7069 @samp{<external-name>} in the DLL @samp{<module-name>}.
7070 Optionally, the symbol may be exported by the specified ordinal
7071 @samp{<integer>} alias. The optional @samp{<name3>} is the to be used
7072 string in import/export table for the symbol.
7073
7074 The optional keywords that follow the declaration indicate:
7075
7076 @code{NONAME}: Do not put the symbol name in the DLL's export table.  It
7077 will still be exported by its ordinal alias (either the value specified
7078 by the .def specification or, otherwise, the value assigned by the
7079 linker). The symbol name, however, does remain visible in the import
7080 library (if any), unless @code{PRIVATE} is also specified.
7081
7082 @code{DATA}: The symbol is a variable or object, rather than a function.
7083 The import lib will export only an indirect reference to @code{foo} as
7084 the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as
7085 @code{*_imp__foo}).
7086
7087 @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as
7088 well as @code{_imp__foo} into the import library. Both refer to the
7089 read-only import address table's pointer to the variable, not to the
7090 variable itself. This can be dangerous. If the user code fails to add
7091 the @code{dllimport} attribute and also fails to explicitly add the
7092 extra indirection that the use of the attribute enforces, the
7093 application will behave unexpectedly.
7094
7095 @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put
7096 it into the static import library used to resolve imports at link time. The
7097 symbol can still be imported using the @code{LoadLibrary/GetProcAddress}
7098 API at runtime or by by using the GNU ld extension of linking directly to
7099 the DLL without an import library.
7100
7101 See ld/deffilep.y in the binutils sources for the full specification of
7102 other DEF file statements
7103
7104 @cindex creating a DEF file
7105 While linking a shared dll, @command{ld} is able to create a DEF file
7106 with the @samp{--output-def <file>} command line option.
7107
7108 @item   Using decorations
7109 @cindex Using decorations
7110 Another way of marking symbols for export is to modify the source code
7111 itself, so that when building the DLL each symbol to be exported is
7112 declared as:
7113
7114 @example
7115 __declspec(dllexport) int a_variable
7116 __declspec(dllexport) void a_function(int with_args)
7117 @end example
7118
7119 All such symbols will be exported from the DLL.  If, however,
7120 any of the object files in the DLL contain symbols decorated in
7121 this way, then the normal auto-export behavior is disabled, unless
7122 the @samp{--export-all-symbols} option is also used.
7123
7124 Note that object files that wish to access these symbols must @emph{not}
7125 decorate them with dllexport.  Instead, they should use dllimport,
7126 instead:
7127
7128 @example
7129 __declspec(dllimport) int a_variable
7130 __declspec(dllimport) void a_function(int with_args)
7131 @end example
7132
7133 This complicates the structure of library header files, because
7134 when included by the library itself the header must declare the
7135 variables and functions as dllexport, but when included by client
7136 code the header must declare them as dllimport.  There are a number
7137 of idioms that are typically used to do this; often client code can
7138 omit the __declspec() declaration completely.  See
7139 @samp{--enable-auto-import} and @samp{automatic data imports} for more
7140 information.
7141 @end table
7142
7143 @cindex automatic data imports
7144 @item automatic data imports
7145 The standard Windows dll format supports data imports from dlls only
7146 by adding special decorations (dllimport/dllexport), which let the
7147 compiler produce specific assembler instructions to deal with this
7148 issue.  This increases the effort necessary to port existing Un*x
7149 code to these platforms, especially for large
7150 c++ libraries and applications.  The auto-import feature, which was
7151 initially provided by Paul Sokolovsky, allows one to omit the
7152 decorations to achieve a behavior that conforms to that on POSIX/Un*x
7153 platforms. This feature is enabled with the @samp{--enable-auto-import}
7154 command-line option, although it is enabled by default on cygwin/mingw.
7155 The @samp{--enable-auto-import} option itself now serves mainly to
7156 suppress any warnings that are ordinarily emitted when linked objects
7157 trigger the feature's use.
7158
7159 auto-import of variables does not always work flawlessly without
7160 additional assistance.  Sometimes, you will see this message
7161
7162 "variable '<var>' can't be auto-imported. Please read the
7163 documentation for ld's @code{--enable-auto-import} for details."
7164
7165 The @samp{--enable-auto-import} documentation explains why this error
7166 occurs, and several methods that can be used to overcome this difficulty.
7167 One of these methods is the @emph{runtime pseudo-relocs} feature, described
7168 below.
7169
7170 @cindex runtime pseudo-relocation
7171 For complex variables imported from DLLs (such as structs or classes),
7172 object files typically contain a base address for the variable and an
7173 offset (@emph{addend}) within the variable--to specify a particular
7174 field or public member, for instance.  Unfortunately, the runtime loader used
7175 in win32 environments is incapable of fixing these references at runtime
7176 without the additional information supplied by dllimport/dllexport decorations.
7177 The standard auto-import feature described above is unable to resolve these
7178 references.
7179
7180 The @samp{--enable-runtime-pseudo-relocs} switch allows these references to
7181 be resolved without error, while leaving the task of adjusting the references
7182 themselves (with their non-zero addends) to specialized code provided by the
7183 runtime environment.  Recent versions of the cygwin and mingw environments and
7184 compilers provide this runtime support; older versions do not.  However, the
7185 support is only necessary on the developer's platform; the compiled result will
7186 run without error on an older system.
7187
7188 @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly
7189 enabled as needed.
7190
7191 @cindex direct linking to a dll
7192 @item direct linking to a dll
7193 The cygwin/mingw ports of @command{ld} support the direct linking,
7194 including data symbols, to a dll without the usage of any import
7195 libraries.  This is much faster and uses much less memory than does the
7196 traditional import library method, especially when linking large
7197 libraries or applications.  When @command{ld} creates an import lib, each
7198 function or variable exported from the dll is stored in its own bfd, even
7199 though a single bfd could contain many exports.  The overhead involved in
7200 storing, loading, and processing so many bfd's is quite large, and explains the
7201 tremendous time, memory, and storage needed to link against particularly
7202 large or complex libraries when using import libs.
7203
7204 Linking directly to a dll uses no extra command-line switches other than
7205 @samp{-L} and @samp{-l}, because @command{ld} already searches for a number
7206 of names to match each library.  All that is needed from the developer's
7207 perspective is an understanding of this search, in order to force ld to
7208 select the dll instead of an import library.
7209
7210
7211 For instance, when ld is called with the argument @samp{-lxxx} it will attempt
7212 to find, in the first directory of its search path,
7213
7214 @example
7215 libxxx.dll.a
7216 xxx.dll.a
7217 libxxx.a
7218 xxx.lib
7219 cygxxx.dll (*)
7220 libxxx.dll
7221 xxx.dll
7222 @end example
7223
7224 before moving on to the next directory in the search path.
7225
7226 (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll},
7227 where @samp{<prefix>} is set by the @command{ld} option
7228 @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec
7229 file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for
7230 @samp{cygxxx.dll}.
7231
7232 Other win32-based unix environments, such as mingw or pw32, may use other
7233 @samp{<prefix>}es, although at present only cygwin makes use of this feature.  It
7234 was originally intended to help avoid name conflicts among dll's built for the
7235 various win32/un*x environments, so that (for example) two versions of a zlib dll
7236 could coexist on the same machine.
7237
7238 The generic cygwin/mingw path layout uses a @samp{bin} directory for
7239 applications and dll's and a @samp{lib} directory for the import
7240 libraries (using cygwin nomenclature):
7241
7242 @example
7243 bin/
7244         cygxxx.dll
7245 lib/
7246         libxxx.dll.a   (in case of dll's)
7247         libxxx.a       (in case of static archive)
7248 @end example
7249
7250 Linking directly to a dll without using the import library can be
7251 done two ways:
7252
7253 1. Use the dll directly by adding the @samp{bin} path to the link line
7254 @example
7255 gcc -Wl,-verbose  -o a.exe -L../bin/ -lxxx
7256 @end example
7257
7258 However, as the dll's often have version numbers appended to their names
7259 (@samp{cygncurses-5.dll}) this will often fail, unless one specifies
7260 @samp{-L../bin -lncurses-5} to include the version.  Import libs are generally
7261 not versioned, and do not have this difficulty.
7262
7263 2. Create a symbolic link from the dll to a file in the @samp{lib}
7264 directory according to the above mentioned search pattern.  This
7265 should be used to avoid unwanted changes in the tools needed for
7266 making the app/dll.
7267
7268 @example
7269 ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a]
7270 @end example
7271
7272 Then you can link without any make environment changes.
7273
7274 @example
7275 gcc -Wl,-verbose  -o a.exe -L../lib/ -lxxx
7276 @end example
7277
7278 This technique also avoids the version number problems, because the following is
7279 perfectly legal
7280
7281 @example
7282 bin/
7283         cygxxx-5.dll
7284 lib/
7285         libxxx.dll.a -> ../bin/cygxxx-5.dll
7286 @end example
7287
7288 Linking directly to a dll without using an import lib will work
7289 even when auto-import features are exercised, and even when
7290 @samp{--enable-runtime-pseudo-relocs} is used.
7291
7292 Given the improvements in speed and memory usage, one might justifiably
7293 wonder why import libraries are used at all.  There are three reasons:
7294
7295 1. Until recently, the link-directly-to-dll functionality did @emph{not}
7296 work with auto-imported data.
7297
7298 2. Sometimes it is necessary to include pure static objects within the
7299 import library (which otherwise contains only bfd's for indirection
7300 symbols that point to the exports of a dll).  Again, the import lib
7301 for the cygwin kernel makes use of this ability, and it is not
7302 possible to do this without an import lib.
7303
7304 3. Symbol aliases can only be resolved using an import lib.  This is
7305 critical when linking against OS-supplied dll's (eg, the win32 API)
7306 in which symbols are usually exported as undecorated aliases of their
7307 stdcall-decorated assembly names.
7308
7309 So, import libs are not going away.  But the ability to replace
7310 true import libs with a simple symbolic link to (or a copy of)
7311 a dll, in many cases, is a useful addition to the suite of tools
7312 binutils makes available to the win32 developer.  Given the
7313 massive improvements in memory requirements during linking, storage
7314 requirements, and linking speed, we expect that many developers
7315 will soon begin to use this feature whenever possible.
7316
7317 @item symbol aliasing
7318 @table @emph
7319 @item adding additional names
7320 Sometimes, it is useful to export symbols with additional names.
7321 A symbol @samp{foo} will be exported as @samp{foo}, but it can also be
7322 exported as @samp{_foo} by using special directives in the DEF file
7323 when creating the dll.  This will affect also the optional created
7324 import library.  Consider the following DEF file:
7325
7326 @example
7327 LIBRARY "xyz.dll" BASE=0x61000000
7328
7329 EXPORTS
7330 foo
7331 _foo = foo
7332 @end example
7333
7334 The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}.
7335
7336 Another method for creating a symbol alias is to create it in the
7337 source code using the "weak" attribute:
7338
7339 @example
7340 void foo () @{ /* Do something.  */; @}
7341 void _foo () __attribute__ ((weak, alias ("foo")));
7342 @end example
7343
7344 See the gcc manual for more information about attributes and weak
7345 symbols.
7346
7347 @item renaming symbols
7348 Sometimes it is useful to rename exports.  For instance, the cygwin
7349 kernel does this regularly.  A symbol @samp{_foo} can be exported as
7350 @samp{foo} but not as @samp{_foo} by using special directives in the
7351 DEF file. (This will also affect the import library, if it is
7352 created).  In the following example:
7353
7354 @example
7355 LIBRARY "xyz.dll" BASE=0x61000000
7356
7357 EXPORTS
7358 _foo = foo
7359 @end example
7360
7361 The line @samp{_foo = foo} maps the exported symbol @samp{foo} to
7362 @samp{_foo}.
7363 @end table
7364
7365 Note: using a DEF file disables the default auto-export behavior,
7366 unless the @samp{--export-all-symbols} command line option is used.
7367 If, however, you are trying to rename symbols, then you should list
7368 @emph{all} desired exports in the DEF file, including the symbols
7369 that are not being renamed, and do @emph{not} use the
7370 @samp{--export-all-symbols} option.  If you list only the
7371 renamed symbols in the DEF file, and use @samp{--export-all-symbols}
7372 to handle the other symbols, then the both the new names @emph{and}
7373 the original names for the renamed symbols will be exported.
7374 In effect, you'd be aliasing those symbols, not renaming them,
7375 which is probably not what you wanted.
7376
7377 @cindex weak externals
7378 @item weak externals
7379 The Windows object format, PE, specifies a form of weak symbols called
7380 weak externals.  When a weak symbol is linked and the symbol is not
7381 defined, the weak symbol becomes an alias for some other symbol.  There
7382 are three variants of weak externals:
7383 @itemize
7384 @item Definition is searched for in objects and libraries, historically
7385 called lazy externals.
7386 @item Definition is searched for only in other objects, not in libraries.
7387 This form is not presently implemented.
7388 @item No search; the symbol is an alias.  This form is not presently
7389 implemented.
7390 @end itemize
7391 As a GNU extension, weak symbols that do not specify an alternate symbol
7392 are supported.  If the symbol is undefined when linking, the symbol
7393 uses a default value.
7394
7395 @cindex aligned common symbols
7396 @item aligned common symbols
7397 As a GNU extension to the PE file format, it is possible to specify the
7398 desired alignment for a common symbol.  This information is conveyed from
7399 the assembler or compiler to the linker by means of GNU-specific commands
7400 carried in the object file's @samp{.drectve} section, which are recognized
7401 by @command{ld} and respected when laying out the common symbols.  Native
7402 tools will be able to process object files employing this GNU extension,
7403 but will fail to respect the alignment instructions, and may issue noisy
7404 warnings about unknown linker directives.
7405 @end table
7406
7407 @ifclear GENERIC
7408 @lowersections
7409 @end ifclear
7410 @end ifset
7411
7412 @ifset XTENSA
7413 @ifclear GENERIC
7414 @raisesections
7415 @end ifclear
7416
7417 @node Xtensa
7418 @section @code{ld} and Xtensa Processors
7419
7420 @cindex Xtensa processors
7421 The default @command{ld} behavior for Xtensa processors is to interpret
7422 @code{SECTIONS} commands so that lists of explicitly named sections in a
7423 specification with a wildcard file will be interleaved when necessary to
7424 keep literal pools within the range of PC-relative load offsets.  For
7425 example, with the command:
7426
7427 @smallexample
7428 SECTIONS
7429 @{
7430   .text : @{
7431     *(.literal .text)
7432   @}
7433 @}
7434 @end smallexample
7435
7436 @noindent
7437 @command{ld} may interleave some of the @code{.literal}
7438 and @code{.text} sections from different object files to ensure that the
7439 literal pools are within the range of PC-relative load offsets.  A valid
7440 interleaving might place the @code{.literal} sections from an initial
7441 group of files followed by the @code{.text} sections of that group of
7442 files.  Then, the @code{.literal} sections from the rest of the files
7443 and the @code{.text} sections from the rest of the files would follow.
7444
7445 @cindex @option{--relax} on Xtensa
7446 @cindex relaxing on Xtensa
7447 Relaxation is enabled by default for the Xtensa version of @command{ld} and
7448 provides two important link-time optimizations.  The first optimization
7449 is to combine identical literal values to reduce code size.  A redundant
7450 literal will be removed and all the @code{L32R} instructions that use it
7451 will be changed to reference an identical literal, as long as the
7452 location of the replacement literal is within the offset range of all
7453 the @code{L32R} instructions.  The second optimization is to remove
7454 unnecessary overhead from assembler-generated ``longcall'' sequences of
7455 @code{L32R}/@code{CALLX@var{n}} when the target functions are within
7456 range of direct @code{CALL@var{n}} instructions.
7457
7458 For each of these cases where an indirect call sequence can be optimized
7459 to a direct call, the linker will change the @code{CALLX@var{n}}
7460 instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R}
7461 instruction, and remove the literal referenced by the @code{L32R}
7462 instruction if it is not used for anything else.  Removing the
7463 @code{L32R} instruction always reduces code size but can potentially
7464 hurt performance by changing the alignment of subsequent branch targets.
7465 By default, the linker will always preserve alignments, either by
7466 switching some instructions between 24-bit encodings and the equivalent
7467 density instructions or by inserting a no-op in place of the @code{L32R}
7468 instruction that was removed.  If code size is more important than
7469 performance, the @option{--size-opt} option can be used to prevent the
7470 linker from widening density instructions or inserting no-ops, except in
7471 a few cases where no-ops are required for correctness.
7472
7473 The following Xtensa-specific command-line options can be used to
7474 control the linker:
7475
7476 @cindex Xtensa options
7477 @table @option
7478 @item --size-opt
7479 When optimizing indirect calls to direct calls, optimize for code size
7480 more than performance.  With this option, the linker will not insert
7481 no-ops or widen density instructions to preserve branch target
7482 alignment.  There may still be some cases where no-ops are required to
7483 preserve the correctness of the code.
7484 @end table
7485
7486 @ifclear GENERIC
7487 @lowersections
7488 @end ifclear
7489 @end ifset
7490
7491 @ifclear SingleFormat
7492 @node BFD
7493 @chapter BFD
7494
7495 @cindex back end
7496 @cindex object file management
7497 @cindex object formats available
7498 @kindex objdump -i
7499 The linker accesses object and archive files using the BFD libraries.
7500 These libraries allow the linker to use the same routines to operate on
7501 object files whatever the object file format.  A different object file
7502 format can be supported simply by creating a new BFD back end and adding
7503 it to the library.  To conserve runtime memory, however, the linker and
7504 associated tools are usually configured to support only a subset of the
7505 object file formats available.  You can use @code{objdump -i}
7506 (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to
7507 list all the formats available for your configuration.
7508
7509 @cindex BFD requirements
7510 @cindex requirements for BFD
7511 As with most implementations, BFD is a compromise between
7512 several conflicting requirements. The major factor influencing
7513 BFD design was efficiency: any time used converting between
7514 formats is time which would not have been spent had BFD not
7515 been involved. This is partly offset by abstraction payback; since
7516 BFD simplifies applications and back ends, more time and care
7517 may be spent optimizing algorithms for a greater speed.
7518
7519 One minor artifact of the BFD solution which you should bear in
7520 mind is the potential for information loss.  There are two places where
7521 useful information can be lost using the BFD mechanism: during
7522 conversion and during output. @xref{BFD information loss}.
7523
7524 @menu
7525 * BFD outline::                 How it works: an outline of BFD
7526 @end menu
7527
7528 @node BFD outline
7529 @section How It Works: An Outline of BFD
7530 @cindex opening object files
7531 @include bfdsumm.texi
7532 @end ifclear
7533
7534 @node Reporting Bugs
7535 @chapter Reporting Bugs
7536 @cindex bugs in @command{ld}
7537 @cindex reporting bugs in @command{ld}
7538
7539 Your bug reports play an essential role in making @command{ld} reliable.
7540
7541 Reporting a bug may help you by bringing a solution to your problem, or
7542 it may not.  But in any case the principal function of a bug report is
7543 to help the entire community by making the next version of @command{ld}
7544 work better.  Bug reports are your contribution to the maintenance of
7545 @command{ld}.
7546
7547 In order for a bug report to serve its purpose, you must include the
7548 information that enables us to fix the bug.
7549
7550 @menu
7551 * Bug Criteria::                Have you found a bug?
7552 * Bug Reporting::               How to report bugs
7553 @end menu
7554
7555 @node Bug Criteria
7556 @section Have You Found a Bug?
7557 @cindex bug criteria
7558
7559 If you are not sure whether you have found a bug, here are some guidelines:
7560
7561 @itemize @bullet
7562 @cindex fatal signal
7563 @cindex linker crash
7564 @cindex crash of linker
7565 @item
7566 If the linker gets a fatal signal, for any input whatever, that is a
7567 @command{ld} bug.  Reliable linkers never crash.
7568
7569 @cindex error on valid input
7570 @item
7571 If @command{ld} produces an error message for valid input, that is a bug.
7572
7573 @cindex invalid input
7574 @item
7575 If @command{ld} does not produce an error message for invalid input, that
7576 may be a bug.  In the general case, the linker can not verify that
7577 object files are correct.
7578
7579 @item
7580 If you are an experienced user of linkers, your suggestions for
7581 improvement of @command{ld} are welcome in any case.
7582 @end itemize
7583
7584 @node Bug Reporting
7585 @section How to Report Bugs
7586 @cindex bug reports
7587 @cindex @command{ld} bugs, reporting
7588
7589 A number of companies and individuals offer support for @sc{gnu}
7590 products.  If you obtained @command{ld} from a support organization, we
7591 recommend you contact that organization first.
7592
7593 You can find contact information for many support companies and
7594 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
7595 distribution.
7596
7597 @ifset BUGURL
7598 Otherwise, send bug reports for @command{ld} to
7599 @value{BUGURL}.
7600 @end ifset
7601
7602 The fundamental principle of reporting bugs usefully is this:
7603 @strong{report all the facts}.  If you are not sure whether to state a
7604 fact or leave it out, state it!
7605
7606 Often people omit facts because they think they know what causes the
7607 problem and assume that some details do not matter.  Thus, you might
7608 assume that the name of a symbol you use in an example does not
7609 matter.  Well, probably it does not, but one cannot be sure.  Perhaps
7610 the bug is a stray memory reference which happens to fetch from the
7611 location where that name is stored in memory; perhaps, if the name
7612 were different, the contents of that location would fool the linker
7613 into doing the right thing despite the bug.  Play it safe and give a
7614 specific, complete example.  That is the easiest thing for you to do,
7615 and the most helpful.
7616
7617 Keep in mind that the purpose of a bug report is to enable us to fix
7618 the bug if it is new to us.  Therefore, always write your bug reports
7619 on the assumption that the bug has not been reported previously.
7620
7621 Sometimes people give a few sketchy facts and ask, ``Does this ring a
7622 bell?''  This cannot help us fix a bug, so it is basically useless.  We
7623 respond by asking for enough details to enable us to investigate.
7624 You might as well expedite matters by sending them to begin with.
7625
7626 To enable us to fix the bug, you should include all these things:
7627
7628 @itemize @bullet
7629 @item
7630 The version of @command{ld}.  @command{ld} announces it if you start it with
7631 the @samp{--version} argument.
7632
7633 Without this, we will not know whether there is any point in looking for
7634 the bug in the current version of @command{ld}.
7635
7636 @item
7637 Any patches you may have applied to the @command{ld} source, including any
7638 patches made to the @code{BFD} library.
7639
7640 @item
7641 The type of machine you are using, and the operating system name and
7642 version number.
7643
7644 @item
7645 What compiler (and its version) was used to compile @command{ld}---e.g.
7646 ``@code{gcc-2.7}''.
7647
7648 @item
7649 The command arguments you gave the linker to link your example and
7650 observe the bug.  To guarantee you will not omit something important,
7651 list them all.  A copy of the Makefile (or the output from make) is
7652 sufficient.
7653
7654 If we were to try to guess the arguments, we would probably guess wrong
7655 and then we might not encounter the bug.
7656
7657 @item
7658 A complete input file, or set of input files, that will reproduce the
7659 bug.  It is generally most helpful to send the actual object files
7660 provided that they are reasonably small.  Say no more than 10K.  For
7661 bigger files you can either make them available by FTP or HTTP or else
7662 state that you are willing to send the object file(s) to whomever
7663 requests them.  (Note - your email will be going to a mailing list, so
7664 we do not want to clog it up with large attachments).  But small
7665 attachments are best.
7666
7667 If the source files were assembled using @code{gas} or compiled using
7668 @code{gcc}, then it may be OK to send the source files rather than the
7669 object files.  In this case, be sure to say exactly what version of
7670 @code{gas} or @code{gcc} was used to produce the object files.  Also say
7671 how @code{gas} or @code{gcc} were configured.
7672
7673 @item
7674 A description of what behavior you observe that you believe is
7675 incorrect.  For example, ``It gets a fatal signal.''
7676
7677 Of course, if the bug is that @command{ld} gets a fatal signal, then we
7678 will certainly notice it.  But if the bug is incorrect output, we might
7679 not notice unless it is glaringly wrong.  You might as well not give us
7680 a chance to make a mistake.
7681
7682 Even if the problem you experience is a fatal signal, you should still
7683 say so explicitly.  Suppose something strange is going on, such as, your
7684 copy of @command{ld} is out of sync, or you have encountered a bug in the
7685 C library on your system.  (This has happened!)  Your copy might crash
7686 and ours would not.  If you told us to expect a crash, then when ours
7687 fails to crash, we would know that the bug was not happening for us.  If
7688 you had not told us to expect a crash, then we would not be able to draw
7689 any conclusion from our observations.
7690
7691 @item
7692 If you wish to suggest changes to the @command{ld} source, send us context
7693 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or
7694 @samp{-p} option.  Always send diffs from the old file to the new file.
7695 If you even discuss something in the @command{ld} source, refer to it by
7696 context, not by line number.
7697
7698 The line numbers in our development sources will not match those in your
7699 sources.  Your line numbers would convey no useful information to us.
7700 @end itemize
7701
7702 Here are some things that are not necessary:
7703
7704 @itemize @bullet
7705 @item
7706 A description of the envelope of the bug.
7707
7708 Often people who encounter a bug spend a lot of time investigating
7709 which changes to the input file will make the bug go away and which
7710 changes will not affect it.
7711
7712 This is often time consuming and not very useful, because the way we
7713 will find the bug is by running a single example under the debugger
7714 with breakpoints, not by pure deduction from a series of examples.
7715 We recommend that you save your time for something else.
7716
7717 Of course, if you can find a simpler example to report @emph{instead}
7718 of the original one, that is a convenience for us.  Errors in the
7719 output will be easier to spot, running under the debugger will take
7720 less time, and so on.
7721
7722 However, simplification is not vital; if you do not want to do this,
7723 report the bug anyway and send us the entire test case you used.
7724
7725 @item
7726 A patch for the bug.
7727
7728 A patch for the bug does help us if it is a good one.  But do not omit
7729 the necessary information, such as the test case, on the assumption that
7730 a patch is all we need.  We might see problems with your patch and decide
7731 to fix the problem another way, or we might not understand it at all.
7732
7733 Sometimes with a program as complicated as @command{ld} it is very hard to
7734 construct an example that will make the program follow a certain path
7735 through the code.  If you do not send us the example, we will not be
7736 able to construct one, so we will not be able to verify that the bug is
7737 fixed.
7738
7739 And if we cannot understand what bug you are trying to fix, or why your
7740 patch should be an improvement, we will not install it.  A test case will
7741 help us to understand.
7742
7743 @item
7744 A guess about what the bug is or what it depends on.
7745
7746 Such guesses are usually wrong.  Even we cannot guess right about such
7747 things without first using the debugger to find the facts.
7748 @end itemize
7749
7750 @node MRI
7751 @appendix MRI Compatible Script Files
7752 @cindex MRI compatibility
7753 To aid users making the transition to @sc{gnu} @command{ld} from the MRI
7754 linker, @command{ld} can use MRI compatible linker scripts as an
7755 alternative to the more general-purpose linker scripting language
7756 described in @ref{Scripts}.  MRI compatible linker scripts have a much
7757 simpler command set than the scripting language otherwise used with
7758 @command{ld}.  @sc{gnu} @command{ld} supports the most commonly used MRI
7759 linker commands; these commands are described here.
7760
7761 In general, MRI scripts aren't of much use with the @code{a.out} object
7762 file format, since it only has three sections and MRI scripts lack some
7763 features to make use of them.
7764
7765 You can specify a file containing an MRI-compatible script using the
7766 @samp{-c} command-line option.
7767
7768 Each command in an MRI-compatible script occupies its own line; each
7769 command line starts with the keyword that identifies the command (though
7770 blank lines are also allowed for punctuation).  If a line of an
7771 MRI-compatible script begins with an unrecognized keyword, @command{ld}
7772 issues a warning message, but continues processing the script.
7773
7774 Lines beginning with @samp{*} are comments.
7775
7776 You can write these commands using all upper-case letters, or all
7777 lower case; for example, @samp{chip} is the same as @samp{CHIP}.
7778 The following list shows only the upper-case form of each command.
7779
7780 @table @code
7781 @cindex @code{ABSOLUTE} (MRI)
7782 @item ABSOLUTE @var{secname}
7783 @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname}
7784 Normally, @command{ld} includes in the output file all sections from all
7785 the input files.  However, in an MRI-compatible script, you can use the
7786 @code{ABSOLUTE} command to restrict the sections that will be present in
7787 your output program.  If the @code{ABSOLUTE} command is used at all in a
7788 script, then only the sections named explicitly in @code{ABSOLUTE}
7789 commands will appear in the linker output.  You can still use other
7790 input sections (whatever you select on the command line, or using
7791 @code{LOAD}) to resolve addresses in the output file.
7792
7793 @cindex @code{ALIAS} (MRI)
7794 @item ALIAS @var{out-secname}, @var{in-secname}
7795 Use this command to place the data from input section @var{in-secname}
7796 in a section called @var{out-secname} in the linker output file.
7797
7798 @var{in-secname} may be an integer.
7799
7800 @cindex @code{ALIGN} (MRI)
7801 @item ALIGN @var{secname} = @var{expression}
7802 Align the section called @var{secname} to @var{expression}.  The
7803 @var{expression} should be a power of two.
7804
7805 @cindex @code{BASE} (MRI)
7806 @item BASE @var{expression}
7807 Use the value of @var{expression} as the lowest address (other than
7808 absolute addresses) in the output file.
7809
7810 @cindex @code{CHIP} (MRI)
7811 @item CHIP @var{expression}
7812 @itemx CHIP @var{expression}, @var{expression}
7813 This command does nothing; it is accepted only for compatibility.
7814
7815 @cindex @code{END} (MRI)
7816 @item END
7817 This command does nothing whatever; it's only accepted for compatibility.
7818
7819 @cindex @code{FORMAT} (MRI)
7820 @item FORMAT @var{output-format}
7821 Similar to the @code{OUTPUT_FORMAT} command in the more general linker
7822 language, but restricted to one of these output formats:
7823
7824 @enumerate
7825 @item
7826 S-records, if @var{output-format} is @samp{S}
7827
7828 @item
7829 IEEE, if @var{output-format} is @samp{IEEE}
7830
7831 @item
7832 COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is
7833 @samp{COFF}
7834 @end enumerate
7835
7836 @cindex @code{LIST} (MRI)
7837 @item LIST @var{anything}@dots{}
7838 Print (to the standard output file) a link map, as produced by the
7839 @command{ld} command-line option @samp{-M}.
7840
7841 The keyword @code{LIST} may be followed by anything on the
7842 same line, with no change in its effect.
7843
7844 @cindex @code{LOAD} (MRI)
7845 @item LOAD @var{filename}
7846 @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename}
7847 Include one or more object file @var{filename} in the link; this has the
7848 same effect as specifying @var{filename} directly on the @command{ld}
7849 command line.
7850
7851 @cindex @code{NAME} (MRI)
7852 @item NAME @var{output-name}
7853 @var{output-name} is the name for the program produced by @command{ld}; the
7854 MRI-compatible command @code{NAME} is equivalent to the command-line
7855 option @samp{-o} or the general script language command @code{OUTPUT}.
7856
7857 @cindex @code{ORDER} (MRI)
7858 @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname}
7859 @itemx ORDER @var{secname} @var{secname} @var{secname}
7860 Normally, @command{ld} orders the sections in its output file in the
7861 order in which they first appear in the input files.  In an MRI-compatible
7862 script, you can override this ordering with the @code{ORDER} command.  The
7863 sections you list with @code{ORDER} will appear first in your output
7864 file, in the order specified.
7865
7866 @cindex @code{PUBLIC} (MRI)
7867 @item PUBLIC @var{name}=@var{expression}
7868 @itemx PUBLIC @var{name},@var{expression}
7869 @itemx PUBLIC @var{name} @var{expression}
7870 Supply a value (@var{expression}) for external symbol
7871 @var{name} used in the linker input files.
7872
7873 @cindex @code{SECT} (MRI)
7874 @item SECT @var{secname}, @var{expression}
7875 @itemx SECT @var{secname}=@var{expression}
7876 @itemx SECT @var{secname} @var{expression}
7877 You can use any of these three forms of the @code{SECT} command to
7878 specify the start address (@var{expression}) for section @var{secname}.
7879 If you have more than one @code{SECT} statement for the same
7880 @var{secname}, only the @emph{first} sets the start address.
7881 @end table
7882
7883 @node GNU Free Documentation License
7884 @appendix GNU Free Documentation License
7885 @include fdl.texi
7886
7887 @node LD Index
7888 @unnumbered LD Index
7889
7890 @printindex cp
7891
7892 @tex
7893 % I think something like @@colophon should be in texinfo.  In the
7894 % meantime:
7895 \long\def\colophon{\hbox to0pt{}\vfill
7896 \centerline{The body of this manual is set in}
7897 \centerline{\fontname\tenrm,}
7898 \centerline{with headings in {\bf\fontname\tenbf}}
7899 \centerline{and examples in {\tt\fontname\tentt}.}
7900 \centerline{{\it\fontname\tenit\/} and}
7901 \centerline{{\sl\fontname\tensl\/}}
7902 \centerline{are used for emphasis.}\vfill}
7903 \page\colophon
7904 % Blame: doc@@cygnus.com, 28mar91.
7905 @end tex
7906
7907 @bye