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