3 @c Copyright (C) 1991-2015 Free Software Foundation, Inc.
6 @include configdoc.texi
7 @c (configdoc.texi is generated by the Makefile)
13 @macro gcctabopt{body}
19 @c Configure for the generation of man pages
45 @dircategory Software development
47 * Ld: (ld). The GNU linker.
52 This file documents the @sc{gnu} linker LD
53 @ifset VERSION_PACKAGE
54 @value{VERSION_PACKAGE}
56 version @value{VERSION}.
58 Copyright @copyright{} 1991-2015 Free Software Foundation, Inc.
60 Permission is granted to copy, distribute and/or modify this document
61 under the terms of the GNU Free Documentation License, Version 1.3
62 or any later version published by the Free Software Foundation;
63 with no Invariant Sections, with no Front-Cover Texts, and with no
64 Back-Cover Texts. A copy of the license is included in the
65 section entitled ``GNU Free Documentation License''.
69 @setchapternewpage odd
70 @settitle The GNU linker
75 @ifset VERSION_PACKAGE
76 @subtitle @value{VERSION_PACKAGE}
78 @subtitle Version @value{VERSION}
79 @author Steve Chamberlain
80 @author Ian Lance Taylor
85 \hfill Red Hat Inc\par
86 \hfill nickc\@credhat.com, doc\@redhat.com\par
87 \hfill {\it The GNU linker}\par
88 \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par
90 \global\parindent=0pt % Steve likes it this way.
93 @vskip 0pt plus 1filll
94 @c man begin COPYRIGHT
95 Copyright @copyright{} 1991-2015 Free Software Foundation, Inc.
97 Permission is granted to copy, distribute and/or modify this document
98 under the terms of the GNU Free Documentation License, Version 1.3
99 or any later version published by the Free Software Foundation;
100 with no Invariant Sections, with no Front-Cover Texts, and with no
101 Back-Cover Texts. A copy of the license is included in the
102 section entitled ``GNU Free Documentation License''.
108 @c FIXME: Talk about importance of *order* of args, cmds to linker!
113 This file documents the @sc{gnu} linker ld
114 @ifset VERSION_PACKAGE
115 @value{VERSION_PACKAGE}
117 version @value{VERSION}.
119 This document is distributed under the terms of the GNU Free
120 Documentation License version 1.3. A copy of the license is included
121 in the section entitled ``GNU Free Documentation License''.
124 * Overview:: Overview
125 * Invocation:: Invocation
126 * Scripts:: Linker Scripts
128 * Machine Dependent:: Machine Dependent Features
132 * H8/300:: ld and the H8/300
135 * Renesas:: ld and other Renesas micros
138 * i960:: ld and the Intel 960 family
141 * ARM:: ld and the ARM family
144 * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families
147 * HPPA ELF32:: ld and HPPA 32-bit ELF
150 * M68K:: ld and Motorola 68K family
153 * MIPS:: ld and MIPS family
156 * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support
159 * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support
162 * SPU ELF:: ld and SPU ELF Support
165 * TI COFF:: ld and the TI COFF
168 * Win32:: ld and WIN32 (cygwin/mingw)
171 * Xtensa:: ld and Xtensa Processors
174 @ifclear SingleFormat
177 @c Following blank line required for remaining bug in makeinfo conds/menus
179 * Reporting Bugs:: Reporting Bugs
180 * MRI:: MRI Compatible Script Files
181 * GNU Free Documentation License:: GNU Free Documentation License
182 * LD Index:: LD Index
189 @cindex @sc{gnu} linker
190 @cindex what is this?
193 @c man begin SYNOPSIS
194 ld [@b{options}] @var{objfile} @dots{}
198 ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and
199 the Info entries for @file{binutils} and
204 @c man begin DESCRIPTION
206 @command{ld} combines a number of object and archive files, relocates
207 their data and ties up symbol references. Usually the last step in
208 compiling a program is to run @command{ld}.
210 @command{ld} accepts Linker Command Language files written in
211 a superset of AT&T's Link Editor Command Language syntax,
212 to provide explicit and total control over the linking process.
216 This man page does not describe the command language; see the
217 @command{ld} entry in @code{info} for full details on the command
218 language and on other aspects of the GNU linker.
221 @ifclear SingleFormat
222 This version of @command{ld} uses the general purpose BFD libraries
223 to operate on object files. This allows @command{ld} to read, combine, and
224 write object files in many different formats---for example, COFF or
225 @code{a.out}. Different formats may be linked together to produce any
226 available kind of object file. @xref{BFD}, for more information.
229 Aside from its flexibility, the @sc{gnu} linker is more helpful than other
230 linkers in providing diagnostic information. Many linkers abandon
231 execution immediately upon encountering an error; whenever possible,
232 @command{ld} continues executing, allowing you to identify other errors
233 (or, in some cases, to get an output file in spite of the error).
240 @c man begin DESCRIPTION
242 The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations,
243 and to be as compatible as possible with other linkers. As a result,
244 you have many choices to control its behavior.
250 * Options:: Command Line Options
251 * Environment:: Environment Variables
255 @section Command Line Options
263 The linker supports a plethora of command-line options, but in actual
264 practice few of them are used in any particular context.
265 @cindex standard Unix system
266 For instance, a frequent use of @command{ld} is to link standard Unix
267 object files on a standard, supported Unix system. On such a system, to
268 link a file @code{hello.o}:
271 ld -o @var{output} /lib/crt0.o hello.o -lc
274 This tells @command{ld} to produce a file called @var{output} as the
275 result of linking the file @code{/lib/crt0.o} with @code{hello.o} and
276 the library @code{libc.a}, which will come from the standard search
277 directories. (See the discussion of the @samp{-l} option below.)
279 Some of the command-line options to @command{ld} may be specified at any
280 point in the command line. However, options which refer to files, such
281 as @samp{-l} or @samp{-T}, cause the file to be read at the point at
282 which the option appears in the command line, relative to the object
283 files and other file options. Repeating non-file options with a
284 different argument will either have no further effect, or override prior
285 occurrences (those further to the left on the command line) of that
286 option. Options which may be meaningfully specified more than once are
287 noted in the descriptions below.
290 Non-option arguments are object files or archives which are to be linked
291 together. They may follow, precede, or be mixed in with command-line
292 options, except that an object file argument may not be placed between
293 an option and its argument.
295 Usually the linker is invoked with at least one object file, but you can
296 specify other forms of binary input files using @samp{-l}, @samp{-R},
297 and the script command language. If @emph{no} binary input files at all
298 are specified, the linker does not produce any output, and issues the
299 message @samp{No input files}.
301 If the linker cannot recognize the format of an object file, it will
302 assume that it is a linker script. A script specified in this way
303 augments the main linker script used for the link (either the default
304 linker script or the one specified by using @samp{-T}). This feature
305 permits the linker to link against a file which appears to be an object
306 or an archive, but actually merely defines some symbol values, or uses
307 @code{INPUT} or @code{GROUP} to load other objects. Specifying a
308 script in this way merely augments the main linker script, with the
309 extra commands placed after the main script; use the @samp{-T} option
310 to replace the default linker script entirely, but note the effect of
311 the @code{INSERT} command. @xref{Scripts}.
313 For options whose names are a single letter,
314 option arguments must either follow the option letter without intervening
315 whitespace, or be given as separate arguments immediately following the
316 option that requires them.
318 For options whose names are multiple letters, either one dash or two can
319 precede the option name; for example, @samp{-trace-symbol} and
320 @samp{--trace-symbol} are equivalent. Note---there is one exception to
321 this rule. Multiple letter options that start with a lower case 'o' can
322 only be preceded by two dashes. This is to reduce confusion with the
323 @samp{-o} option. So for example @samp{-omagic} sets the output file
324 name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the
327 Arguments to multiple-letter options must either be separated from the
328 option name by an equals sign, or be given as separate arguments
329 immediately following the option that requires them. For example,
330 @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent.
331 Unique abbreviations of the names of multiple-letter options are
334 Note---if the linker is being invoked indirectly, via a compiler driver
335 (e.g. @samp{gcc}) then all the linker command line options should be
336 prefixed by @samp{-Wl,} (or whatever is appropriate for the particular
337 compiler driver) like this:
340 gcc -Wl,--start-group foo.o bar.o -Wl,--end-group
343 This is important, because otherwise the compiler driver program may
344 silently drop the linker options, resulting in a bad link. Confusion
345 may also arise when passing options that require values through a
346 driver, as the use of a space between option and argument acts as
347 a separator, and causes the driver to pass only the option to the linker
348 and the argument to the compiler. In this case, it is simplest to use
349 the joined forms of both single- and multiple-letter options, such as:
352 gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map
355 Here is a table of the generic command line switches accepted by the GNU
359 @include at-file.texi
361 @kindex -a @var{keyword}
362 @item -a @var{keyword}
363 This option is supported for HP/UX compatibility. The @var{keyword}
364 argument must be one of the strings @samp{archive}, @samp{shared}, or
365 @samp{default}. @samp{-aarchive} is functionally equivalent to
366 @samp{-Bstatic}, and the other two keywords are functionally equivalent
367 to @samp{-Bdynamic}. This option may be used any number of times.
369 @kindex --audit @var{AUDITLIB}
370 @item --audit @var{AUDITLIB}
371 Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section.
372 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
373 specified in the library. If specified multiple times @code{DT_AUDIT}
374 will contain a colon separated list of audit interfaces to use. If the linker
375 finds an object with an audit entry while searching for shared libraries,
376 it will add a corresponding @code{DT_DEPAUDIT} entry in the output file.
377 This option is only meaningful on ELF platforms supporting the rtld-audit
381 @cindex architectures
382 @kindex -A @var{arch}
383 @item -A @var{architecture}
384 @kindex --architecture=@var{arch}
385 @itemx --architecture=@var{architecture}
386 In the current release of @command{ld}, this option is useful only for the
387 Intel 960 family of architectures. In that @command{ld} configuration, the
388 @var{architecture} argument identifies the particular architecture in
389 the 960 family, enabling some safeguards and modifying the
390 archive-library search path. @xref{i960,,@command{ld} and the Intel 960
391 family}, for details.
393 Future releases of @command{ld} may support similar functionality for
394 other architecture families.
397 @ifclear SingleFormat
398 @cindex binary input format
399 @kindex -b @var{format}
400 @kindex --format=@var{format}
403 @item -b @var{input-format}
404 @itemx --format=@var{input-format}
405 @command{ld} may be configured to support more than one kind of object
406 file. If your @command{ld} is configured this way, you can use the
407 @samp{-b} option to specify the binary format for input object files
408 that follow this option on the command line. Even when @command{ld} is
409 configured to support alternative object formats, you don't usually need
410 to specify this, as @command{ld} should be configured to expect as a
411 default input format the most usual format on each machine.
412 @var{input-format} is a text string, the name of a particular format
413 supported by the BFD libraries. (You can list the available binary
414 formats with @samp{objdump -i}.)
417 You may want to use this option if you are linking files with an unusual
418 binary format. You can also use @samp{-b} to switch formats explicitly (when
419 linking object files of different formats), by including
420 @samp{-b @var{input-format}} before each group of object files in a
423 The default format is taken from the environment variable
428 You can also define the input format from a script, using the command
431 see @ref{Format Commands}.
435 @kindex -c @var{MRI-cmdfile}
436 @kindex --mri-script=@var{MRI-cmdfile}
437 @cindex compatibility, MRI
438 @item -c @var{MRI-commandfile}
439 @itemx --mri-script=@var{MRI-commandfile}
440 For compatibility with linkers produced by MRI, @command{ld} accepts script
441 files written in an alternate, restricted command language, described in
443 @ref{MRI,,MRI Compatible Script Files}.
446 the MRI Compatible Script Files section of GNU ld documentation.
448 Introduce MRI script files with
449 the option @samp{-c}; use the @samp{-T} option to run linker
450 scripts written in the general-purpose @command{ld} scripting language.
451 If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories
452 specified by any @samp{-L} options.
454 @cindex common allocation
461 These three options are equivalent; multiple forms are supported for
462 compatibility with other linkers. They assign space to common symbols
463 even if a relocatable output file is specified (with @samp{-r}). The
464 script command @code{FORCE_COMMON_ALLOCATION} has the same effect.
465 @xref{Miscellaneous Commands}.
467 @kindex --depaudit @var{AUDITLIB}
468 @kindex -P @var{AUDITLIB}
469 @item --depaudit @var{AUDITLIB}
470 @itemx -P @var{AUDITLIB}
471 Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section.
472 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
473 specified in the library. If specified multiple times @code{DT_DEPAUDIT}
474 will contain a colon separated list of audit interfaces to use. This
475 option is only meaningful on ELF platforms supporting the rtld-audit interface.
476 The -P option is provided for Solaris compatibility.
478 @cindex entry point, from command line
479 @kindex -e @var{entry}
480 @kindex --entry=@var{entry}
482 @itemx --entry=@var{entry}
483 Use @var{entry} as the explicit symbol for beginning execution of your
484 program, rather than the default entry point. If there is no symbol
485 named @var{entry}, the linker will try to parse @var{entry} as a number,
486 and use that as the entry address (the number will be interpreted in
487 base 10; you may use a leading @samp{0x} for base 16, or a leading
488 @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults
489 and other ways of specifying the entry point.
491 @kindex --exclude-libs
492 @item --exclude-libs @var{lib},@var{lib},...
493 Specifies a list of archive libraries from which symbols should not be automatically
494 exported. The library names may be delimited by commas or colons. Specifying
495 @code{--exclude-libs ALL} excludes symbols in all archive libraries from
496 automatic export. This option is available only for the i386 PE targeted
497 port of the linker and for ELF targeted ports. For i386 PE, symbols
498 explicitly listed in a .def file are still exported, regardless of this
499 option. For ELF targeted ports, symbols affected by this option will
500 be treated as hidden.
502 @kindex --exclude-modules-for-implib
503 @item --exclude-modules-for-implib @var{module},@var{module},...
504 Specifies a list of object files or archive members, from which symbols
505 should not be automatically exported, but which should be copied wholesale
506 into the import library being generated during the link. The module names
507 may be delimited by commas or colons, and must match exactly the filenames
508 used by @command{ld} to open the files; for archive members, this is simply
509 the member name, but for object files the name listed must include and
510 match precisely any path used to specify the input file on the linker's
511 command-line. This option is available only for the i386 PE targeted port
512 of the linker. Symbols explicitly listed in a .def file are still exported,
513 regardless of this option.
515 @cindex dynamic symbol table
517 @kindex --export-dynamic
518 @kindex --no-export-dynamic
520 @itemx --export-dynamic
521 @itemx --no-export-dynamic
522 When creating a dynamically linked executable, using the @option{-E}
523 option or the @option{--export-dynamic} option causes the linker to add
524 all symbols to the dynamic symbol table. The dynamic symbol table is the
525 set of symbols which are visible from dynamic objects at run time.
527 If you do not use either of these options (or use the
528 @option{--no-export-dynamic} option to restore the default behavior), the
529 dynamic symbol table will normally contain only those symbols which are
530 referenced by some dynamic object mentioned in the link.
532 If you use @code{dlopen} to load a dynamic object which needs to refer
533 back to the symbols defined by the program, rather than some other
534 dynamic object, then you will probably need to use this option when
535 linking the program itself.
537 You can also use the dynamic list to control what symbols should
538 be added to the dynamic symbol table if the output format supports it.
539 See the description of @samp{--dynamic-list}.
541 Note that this option is specific to ELF targeted ports. PE targets
542 support a similar function to export all symbols from a DLL or EXE; see
543 the description of @samp{--export-all-symbols} below.
545 @ifclear SingleFormat
546 @cindex big-endian objects
550 Link big-endian objects. This affects the default output format.
552 @cindex little-endian objects
555 Link little-endian objects. This affects the default output format.
558 @kindex -f @var{name}
559 @kindex --auxiliary=@var{name}
561 @itemx --auxiliary=@var{name}
562 When creating an ELF shared object, set the internal DT_AUXILIARY field
563 to the specified name. This tells the dynamic linker that the symbol
564 table of the shared object should be used as an auxiliary filter on the
565 symbol table of the shared object @var{name}.
567 If you later link a program against this filter object, then, when you
568 run the program, the dynamic linker will see the DT_AUXILIARY field. If
569 the dynamic linker resolves any symbols from the filter object, it will
570 first check whether there is a definition in the shared object
571 @var{name}. If there is one, it will be used instead of the definition
572 in the filter object. The shared object @var{name} need not exist.
573 Thus the shared object @var{name} may be used to provide an alternative
574 implementation of certain functions, perhaps for debugging or for
575 machine specific performance.
577 This option may be specified more than once. The DT_AUXILIARY entries
578 will be created in the order in which they appear on the command line.
580 @kindex -F @var{name}
581 @kindex --filter=@var{name}
583 @itemx --filter=@var{name}
584 When creating an ELF shared object, set the internal DT_FILTER field to
585 the specified name. This tells the dynamic linker that the symbol table
586 of the shared object which is being created should be used as a filter
587 on the symbol table of the shared object @var{name}.
589 If you later link a program against this filter object, then, when you
590 run the program, the dynamic linker will see the DT_FILTER field. The
591 dynamic linker will resolve symbols according to the symbol table of the
592 filter object as usual, but it will actually link to the definitions
593 found in the shared object @var{name}. Thus the filter object can be
594 used to select a subset of the symbols provided by the object
597 Some older linkers used the @option{-F} option throughout a compilation
598 toolchain for specifying object-file format for both input and output
600 @ifclear SingleFormat
601 The @sc{gnu} linker uses other mechanisms for this purpose: the
602 @option{-b}, @option{--format}, @option{--oformat} options, the
603 @code{TARGET} command in linker scripts, and the @code{GNUTARGET}
604 environment variable.
606 The @sc{gnu} linker will ignore the @option{-F} option when not
607 creating an ELF shared object.
609 @cindex finalization function
610 @kindex -fini=@var{name}
611 @item -fini=@var{name}
612 When creating an ELF executable or shared object, call NAME when the
613 executable or shared object is unloaded, by setting DT_FINI to the
614 address of the function. By default, the linker uses @code{_fini} as
615 the function to call.
619 Ignored. Provided for compatibility with other tools.
621 @kindex -G @var{value}
622 @kindex --gpsize=@var{value}
625 @itemx --gpsize=@var{value}
626 Set the maximum size of objects to be optimized using the GP register to
627 @var{size}. This is only meaningful for object file formats such as
628 MIPS ELF that support putting large and small objects into different
629 sections. This is ignored for other object file formats.
631 @cindex runtime library name
632 @kindex -h @var{name}
633 @kindex -soname=@var{name}
635 @itemx -soname=@var{name}
636 When creating an ELF shared object, set the internal DT_SONAME field to
637 the specified name. When an executable is linked with a shared object
638 which has a DT_SONAME field, then when the executable is run the dynamic
639 linker will attempt to load the shared object specified by the DT_SONAME
640 field rather than the using the file name given to the linker.
643 @cindex incremental link
645 Perform an incremental link (same as option @samp{-r}).
647 @cindex initialization function
648 @kindex -init=@var{name}
649 @item -init=@var{name}
650 When creating an ELF executable or shared object, call NAME when the
651 executable or shared object is loaded, by setting DT_INIT to the address
652 of the function. By default, the linker uses @code{_init} as the
655 @cindex archive files, from cmd line
656 @kindex -l @var{namespec}
657 @kindex --library=@var{namespec}
658 @item -l @var{namespec}
659 @itemx --library=@var{namespec}
660 Add the archive or object file specified by @var{namespec} to the
661 list of files to link. This option may be used any number of times.
662 If @var{namespec} is of the form @file{:@var{filename}}, @command{ld}
663 will search the library path for a file called @var{filename}, otherwise it
664 will search the library path for a file called @file{lib@var{namespec}.a}.
666 On systems which support shared libraries, @command{ld} may also search for
667 files other than @file{lib@var{namespec}.a}. Specifically, on ELF
668 and SunOS systems, @command{ld} will search a directory for a library
669 called @file{lib@var{namespec}.so} before searching for one called
670 @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension
671 indicates a shared library.) Note that this behavior does not apply
672 to @file{:@var{filename}}, which always specifies a file called
675 The linker will search an archive only once, at the location where it is
676 specified on the command line. If the archive defines a symbol which
677 was undefined in some object which appeared before the archive on the
678 command line, the linker will include the appropriate file(s) from the
679 archive. However, an undefined symbol in an object appearing later on
680 the command line will not cause the linker to search the archive again.
682 See the @option{-(} option for a way to force the linker to search
683 archives multiple times.
685 You may list the same archive multiple times on the command line.
688 This type of archive searching is standard for Unix linkers. However,
689 if you are using @command{ld} on AIX, note that it is different from the
690 behaviour of the AIX linker.
693 @cindex search directory, from cmd line
695 @kindex --library-path=@var{dir}
696 @item -L @var{searchdir}
697 @itemx --library-path=@var{searchdir}
698 Add path @var{searchdir} to the list of paths that @command{ld} will search
699 for archive libraries and @command{ld} control scripts. You may use this
700 option any number of times. The directories are searched in the order
701 in which they are specified on the command line. Directories specified
702 on the command line are searched before the default directories. All
703 @option{-L} options apply to all @option{-l} options, regardless of the
704 order in which the options appear. @option{-L} options do not affect
705 how @command{ld} searches for a linker script unless @option{-T}
708 If @var{searchdir} begins with @code{=}, then the @code{=} will be replaced
709 by the @dfn{sysroot prefix}, controlled by the @samp{--sysroot} option, or
710 specified when the linker is configured.
713 The default set of paths searched (without being specified with
714 @samp{-L}) depends on which emulation mode @command{ld} is using, and in
715 some cases also on how it was configured. @xref{Environment}.
718 The paths can also be specified in a link script with the
719 @code{SEARCH_DIR} command. Directories specified this way are searched
720 at the point in which the linker script appears in the command line.
723 @kindex -m @var{emulation}
724 @item -m @var{emulation}
725 Emulate the @var{emulation} linker. You can list the available
726 emulations with the @samp{--verbose} or @samp{-V} options.
728 If the @samp{-m} option is not used, the emulation is taken from the
729 @code{LDEMULATION} environment variable, if that is defined.
731 Otherwise, the default emulation depends upon how the linker was
739 Print a link map to the standard output. A link map provides
740 information about the link, including the following:
744 Where object files are mapped into memory.
746 How common symbols are allocated.
748 All archive members included in the link, with a mention of the symbol
749 which caused the archive member to be brought in.
751 The values assigned to symbols.
753 Note - symbols whose values are computed by an expression which
754 involves a reference to a previous value of the same symbol may not
755 have correct result displayed in the link map. This is because the
756 linker discards intermediate results and only retains the final value
757 of an expression. Under such circumstances the linker will display
758 the final value enclosed by square brackets. Thus for example a
759 linker script containing:
767 will produce the following output in the link map if the @option{-M}
772 [0x0000000c] foo = (foo * 0x4)
773 [0x0000000c] foo = (foo + 0x8)
776 See @ref{Expressions} for more information about expressions in linker
781 @cindex read-only text
786 Turn off page alignment of sections, and disable linking against shared
787 libraries. If the output format supports Unix style magic numbers,
788 mark the output as @code{NMAGIC}.
792 @cindex read/write from cmd line
796 Set the text and data sections to be readable and writable. Also, do
797 not page-align the data segment, and disable linking against shared
798 libraries. If the output format supports Unix style magic numbers,
799 mark the output as @code{OMAGIC}. Note: Although a writable text section
800 is allowed for PE-COFF targets, it does not conform to the format
801 specification published by Microsoft.
806 This option negates most of the effects of the @option{-N} option. It
807 sets the text section to be read-only, and forces the data segment to
808 be page-aligned. Note - this option does not enable linking against
809 shared libraries. Use @option{-Bdynamic} for this.
811 @kindex -o @var{output}
812 @kindex --output=@var{output}
813 @cindex naming the output file
814 @item -o @var{output}
815 @itemx --output=@var{output}
816 Use @var{output} as the name for the program produced by @command{ld}; if this
817 option is not specified, the name @file{a.out} is used by default. The
818 script command @code{OUTPUT} can also specify the output file name.
820 @kindex -O @var{level}
821 @cindex generating optimized output
823 If @var{level} is a numeric values greater than zero @command{ld} optimizes
824 the output. This might take significantly longer and therefore probably
825 should only be enabled for the final binary. At the moment this
826 option only affects ELF shared library generation. Future releases of
827 the linker may make more use of this option. Also currently there is
828 no difference in the linker's behaviour for different non-zero values
829 of this option. Again this may change with future releases.
832 @cindex push state governing input file handling
834 The @option{--push-state} allows to preserve the current state of the
835 flags which govern the input file handling so that they can all be
836 restored with one corresponding @option{--pop-state} option.
838 The option which are covered are: @option{-Bdynamic}, @option{-Bstatic},
839 @option{-dn}, @option{-dy}, @option{-call_shared}, @option{-non_shared},
840 @option{-static}, @option{-N}, @option{-n}, @option{--whole-archive},
841 @option{--no-whole-archive}, @option{-r}, @option{-Ur},
842 @option{--copy-dt-needed-entries}, @option{--no-copy-dt-needed-entries},
843 @option{--as-needed}, @option{--no-as-needed}, and @option{-a}.
845 One target for this option are specifications for @file{pkg-config}. When
846 used with the @option{--libs} option all possibly needed libraries are
847 listed and then possibly linked with all the time. It is better to return
848 something as follows:
851 -Wl,--push-state,--as-needed -libone -libtwo -Wl,--pop-state
855 @cindex pop state governing input file handling
856 Undoes the effect of --push-state, restores the previous values of the
857 flags governing input file handling.
860 @kindex --emit-relocs
861 @cindex retain relocations in final executable
864 Leave relocation sections and contents in fully linked executables.
865 Post link analysis and optimization tools may need this information in
866 order to perform correct modifications of executables. This results
867 in larger executables.
869 This option is currently only supported on ELF platforms.
871 @kindex --force-dynamic
872 @cindex forcing the creation of dynamic sections
873 @item --force-dynamic
874 Force the output file to have dynamic sections. This option is specific
878 @cindex relocatable output
880 @kindex --relocatable
883 Generate relocatable output---i.e., generate an output file that can in
884 turn serve as input to @command{ld}. This is often called @dfn{partial
885 linking}. As a side effect, in environments that support standard Unix
886 magic numbers, this option also sets the output file's magic number to
888 @c ; see @option{-N}.
889 If this option is not specified, an absolute file is produced. When
890 linking C++ programs, this option @emph{will not} resolve references to
891 constructors; to do that, use @samp{-Ur}.
893 When an input file does not have the same format as the output file,
894 partial linking is only supported if that input file does not contain any
895 relocations. Different output formats can have further restrictions; for
896 example some @code{a.out}-based formats do not support partial linking
897 with input files in other formats at all.
899 This option does the same thing as @samp{-i}.
901 @kindex -R @var{file}
902 @kindex --just-symbols=@var{file}
903 @cindex symbol-only input
904 @item -R @var{filename}
905 @itemx --just-symbols=@var{filename}
906 Read symbol names and their addresses from @var{filename}, but do not
907 relocate it or include it in the output. This allows your output file
908 to refer symbolically to absolute locations of memory defined in other
909 programs. You may use this option more than once.
911 For compatibility with other ELF linkers, if the @option{-R} option is
912 followed by a directory name, rather than a file name, it is treated as
913 the @option{-rpath} option.
917 @cindex strip all symbols
920 Omit all symbol information from the output file.
923 @kindex --strip-debug
924 @cindex strip debugger symbols
927 Omit debugger symbol information (but not all symbols) from the output file.
931 @cindex input files, displaying
934 Print the names of the input files as @command{ld} processes them.
936 @kindex -T @var{script}
937 @kindex --script=@var{script}
939 @item -T @var{scriptfile}
940 @itemx --script=@var{scriptfile}
941 Use @var{scriptfile} as the linker script. This script replaces
942 @command{ld}'s default linker script (rather than adding to it), so
943 @var{commandfile} must specify everything necessary to describe the
944 output file. @xref{Scripts}. If @var{scriptfile} does not exist in
945 the current directory, @code{ld} looks for it in the directories
946 specified by any preceding @samp{-L} options. Multiple @samp{-T}
949 @kindex -dT @var{script}
950 @kindex --default-script=@var{script}
952 @item -dT @var{scriptfile}
953 @itemx --default-script=@var{scriptfile}
954 Use @var{scriptfile} as the default linker script. @xref{Scripts}.
956 This option is similar to the @option{--script} option except that
957 processing of the script is delayed until after the rest of the
958 command line has been processed. This allows options placed after the
959 @option{--default-script} option on the command line to affect the
960 behaviour of the linker script, which can be important when the linker
961 command line cannot be directly controlled by the user. (eg because
962 the command line is being constructed by another tool, such as
965 @kindex -u @var{symbol}
966 @kindex --undefined=@var{symbol}
967 @cindex undefined symbol
968 @item -u @var{symbol}
969 @itemx --undefined=@var{symbol}
970 Force @var{symbol} to be entered in the output file as an undefined
971 symbol. Doing this may, for example, trigger linking of additional
972 modules from standard libraries. @samp{-u} may be repeated with
973 different option arguments to enter additional undefined symbols. This
974 option is equivalent to the @code{EXTERN} linker script command.
979 For anything other than C++ programs, this option is equivalent to
980 @samp{-r}: it generates relocatable output---i.e., an output file that can in
981 turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur}
982 @emph{does} resolve references to constructors, unlike @samp{-r}.
983 It does not work to use @samp{-Ur} on files that were themselves linked
984 with @samp{-Ur}; once the constructor table has been built, it cannot
985 be added to. Use @samp{-Ur} only for the last partial link, and
986 @samp{-r} for the others.
988 @kindex --unique[=@var{SECTION}]
989 @item --unique[=@var{SECTION}]
990 Creates a separate output section for every input section matching
991 @var{SECTION}, or if the optional wildcard @var{SECTION} argument is
992 missing, for every orphan input section. An orphan section is one not
993 specifically mentioned in a linker script. You may use this option
994 multiple times on the command line; It prevents the normal merging of
995 input sections with the same name, overriding output section assignments
1005 Display the version number for @command{ld}. The @option{-V} option also
1006 lists the supported emulations.
1009 @kindex --discard-all
1010 @cindex deleting local symbols
1012 @itemx --discard-all
1013 Delete all local symbols.
1016 @kindex --discard-locals
1017 @cindex local symbols, deleting
1019 @itemx --discard-locals
1020 Delete all temporary local symbols. (These symbols start with
1021 system-specific local label prefixes, typically @samp{.L} for ELF systems
1022 or @samp{L} for traditional a.out systems.)
1024 @kindex -y @var{symbol}
1025 @kindex --trace-symbol=@var{symbol}
1026 @cindex symbol tracing
1027 @item -y @var{symbol}
1028 @itemx --trace-symbol=@var{symbol}
1029 Print the name of each linked file in which @var{symbol} appears. This
1030 option may be given any number of times. On many systems it is necessary
1031 to prepend an underscore.
1033 This option is useful when you have an undefined symbol in your link but
1034 don't know where the reference is coming from.
1036 @kindex -Y @var{path}
1038 Add @var{path} to the default library search path. This option exists
1039 for Solaris compatibility.
1041 @kindex -z @var{keyword}
1042 @item -z @var{keyword}
1043 The recognized keywords are:
1047 Combines multiple reloc sections and sorts them to make dynamic symbol
1048 lookup caching possible.
1051 Disallows undefined symbols in object files. Undefined symbols in
1052 shared libraries are still allowed.
1055 Marks the object as requiring executable stack.
1058 This option is only meaningful when building a shared object. It makes
1059 the symbols defined by this shared object available for symbol resolution
1060 of subsequently loaded libraries.
1063 This option is only meaningful when building a shared object.
1064 It marks the object so that its runtime initialization will occur
1065 before the runtime initialization of any other objects brought into
1066 the process at the same time. Similarly the runtime finalization of
1067 the object will occur after the runtime finalization of any other
1071 Marks the object that its symbol table interposes before all symbols
1072 but the primary executable.
1075 When generating an executable or shared library, mark it to tell the
1076 dynamic linker to defer function call resolution to the point when
1077 the function is called (lazy binding), rather than at load time.
1078 Lazy binding is the default.
1081 Marks the object that its filters be processed immediately at
1085 Allows multiple definitions.
1088 Disables multiple reloc sections combining.
1091 Disable linker generated .dynbss variables used in place of variables
1092 defined in shared libraries. May result in dynamic text relocations.
1095 Marks the object that the search for dependencies of this object will
1096 ignore any default library search paths.
1099 Marks the object shouldn't be unloaded at runtime.
1102 Marks the object not available to @code{dlopen}.
1105 Marks the object can not be dumped by @code{dldump}.
1108 Marks the object as not requiring executable stack.
1111 Treat DT_TEXTREL in shared object as error.
1114 Don't treat DT_TEXTREL in shared object as error.
1117 Don't treat DT_TEXTREL in shared object as error.
1120 Don't create an ELF @code{PT_GNU_RELRO} segment header in the object.
1123 When generating an executable or shared library, mark it to tell the
1124 dynamic linker to resolve all symbols when the program is started, or
1125 when the shared library is linked to using dlopen, instead of
1126 deferring function call resolution to the point when the function is
1130 Marks the object may contain $ORIGIN.
1133 Create an ELF @code{PT_GNU_RELRO} segment header in the object.
1135 @item max-page-size=@var{value}
1136 Set the emulation maximum page size to @var{value}.
1138 @item common-page-size=@var{value}
1139 Set the emulation common page size to @var{value}.
1141 @item stack-size=@var{value}
1142 Specify a stack size for in an ELF @code{PT_GNU_STACK} segment.
1143 Specifying zero will override any default non-zero sized
1144 @code{PT_GNU_STACK} segment creation.
1147 Always generate BND prefix in PLT entries. Supported for Linux/x86_64.
1149 @item noextern-protected-data
1150 Don't treat protected data symbol as external when building shared
1151 library. This option overrides linker backend default. It can be used
1152 to workaround incorrect relocations against protected data symbols
1153 generated by compiler. Updates on protected data symbols by another
1154 module aren't visibile to the resulting shared library. Supported for
1159 Other keywords are ignored for Solaris compatibility.
1162 @cindex groups of archives
1163 @item -( @var{archives} -)
1164 @itemx --start-group @var{archives} --end-group
1165 The @var{archives} should be a list of archive files. They may be
1166 either explicit file names, or @samp{-l} options.
1168 The specified archives are searched repeatedly until no new undefined
1169 references are created. Normally, an archive is searched only once in
1170 the order that it is specified on the command line. If a symbol in that
1171 archive is needed to resolve an undefined symbol referred to by an
1172 object in an archive that appears later on the command line, the linker
1173 would not be able to resolve that reference. By grouping the archives,
1174 they all be searched repeatedly until all possible references are
1177 Using this option has a significant performance cost. It is best to use
1178 it only when there are unavoidable circular references between two or
1181 @kindex --accept-unknown-input-arch
1182 @kindex --no-accept-unknown-input-arch
1183 @item --accept-unknown-input-arch
1184 @itemx --no-accept-unknown-input-arch
1185 Tells the linker to accept input files whose architecture cannot be
1186 recognised. The assumption is that the user knows what they are doing
1187 and deliberately wants to link in these unknown input files. This was
1188 the default behaviour of the linker, before release 2.14. The default
1189 behaviour from release 2.14 onwards is to reject such input files, and
1190 so the @samp{--accept-unknown-input-arch} option has been added to
1191 restore the old behaviour.
1194 @kindex --no-as-needed
1196 @itemx --no-as-needed
1197 This option affects ELF DT_NEEDED tags for dynamic libraries mentioned
1198 on the command line after the @option{--as-needed} option. Normally
1199 the linker will add a DT_NEEDED tag for each dynamic library mentioned
1200 on the command line, regardless of whether the library is actually
1201 needed or not. @option{--as-needed} causes a DT_NEEDED tag to only be
1202 emitted for a library that @emph{at that point in the link} satisfies a
1203 non-weak undefined symbol reference from a regular object file or, if
1204 the library is not found in the DT_NEEDED lists of other needed libraries, a
1205 non-weak undefined symbol reference from another needed dynamic library.
1206 Object files or libraries appearing on the command line @emph{after}
1207 the library in question do not affect whether the library is seen as
1208 needed. This is similar to the rules for extraction of object files
1209 from archives. @option{--no-as-needed} restores the default behaviour.
1211 @kindex --add-needed
1212 @kindex --no-add-needed
1214 @itemx --no-add-needed
1215 These two options have been deprecated because of the similarity of
1216 their names to the @option{--as-needed} and @option{--no-as-needed}
1217 options. They have been replaced by @option{--copy-dt-needed-entries}
1218 and @option{--no-copy-dt-needed-entries}.
1220 @kindex -assert @var{keyword}
1221 @item -assert @var{keyword}
1222 This option is ignored for SunOS compatibility.
1226 @kindex -call_shared
1230 Link against dynamic libraries. This is only meaningful on platforms
1231 for which shared libraries are supported. This option is normally the
1232 default on such platforms. The different variants of this option are
1233 for compatibility with various systems. You may use this option
1234 multiple times on the command line: it affects library searching for
1235 @option{-l} options which follow it.
1239 Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic
1240 section. This causes the runtime linker to handle lookups in this
1241 object and its dependencies to be performed only inside the group.
1242 @option{--unresolved-symbols=report-all} is implied. This option is
1243 only meaningful on ELF platforms which support shared libraries.
1253 Do not link against shared libraries. This is only meaningful on
1254 platforms for which shared libraries are supported. The different
1255 variants of this option are for compatibility with various systems. You
1256 may use this option multiple times on the command line: it affects
1257 library searching for @option{-l} options which follow it. This
1258 option also implies @option{--unresolved-symbols=report-all}. This
1259 option can be used with @option{-shared}. Doing so means that a
1260 shared library is being created but that all of the library's external
1261 references must be resolved by pulling in entries from static
1266 When creating a shared library, bind references to global symbols to the
1267 definition within the shared library, if any. Normally, it is possible
1268 for a program linked against a shared library to override the definition
1269 within the shared library. This option is only meaningful on ELF
1270 platforms which support shared libraries.
1272 @kindex -Bsymbolic-functions
1273 @item -Bsymbolic-functions
1274 When creating a shared library, bind references to global function
1275 symbols to the definition within the shared library, if any.
1276 This option is only meaningful on ELF platforms which support shared
1279 @kindex --dynamic-list=@var{dynamic-list-file}
1280 @item --dynamic-list=@var{dynamic-list-file}
1281 Specify the name of a dynamic list file to the linker. This is
1282 typically used when creating shared libraries to specify a list of
1283 global symbols whose references shouldn't be bound to the definition
1284 within the shared library, or creating dynamically linked executables
1285 to specify a list of symbols which should be added to the symbol table
1286 in the executable. This option is only meaningful on ELF platforms
1287 which support shared libraries.
1289 The format of the dynamic list is the same as the version node without
1290 scope and node name. See @ref{VERSION} for more information.
1292 @kindex --dynamic-list-data
1293 @item --dynamic-list-data
1294 Include all global data symbols to the dynamic list.
1296 @kindex --dynamic-list-cpp-new
1297 @item --dynamic-list-cpp-new
1298 Provide the builtin dynamic list for C++ operator new and delete. It
1299 is mainly useful for building shared libstdc++.
1301 @kindex --dynamic-list-cpp-typeinfo
1302 @item --dynamic-list-cpp-typeinfo
1303 Provide the builtin dynamic list for C++ runtime type identification.
1305 @kindex --check-sections
1306 @kindex --no-check-sections
1307 @item --check-sections
1308 @itemx --no-check-sections
1309 Asks the linker @emph{not} to check section addresses after they have
1310 been assigned to see if there are any overlaps. Normally the linker will
1311 perform this check, and if it finds any overlaps it will produce
1312 suitable error messages. The linker does know about, and does make
1313 allowances for sections in overlays. The default behaviour can be
1314 restored by using the command line switch @option{--check-sections}.
1315 Section overlap is not usually checked for relocatable links. You can
1316 force checking in that case by using the @option{--check-sections}
1319 @kindex --copy-dt-needed-entries
1320 @kindex --no-copy-dt-needed-entries
1321 @item --copy-dt-needed-entries
1322 @itemx --no-copy-dt-needed-entries
1323 This option affects the treatment of dynamic libraries referred to
1324 by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the
1325 command line. Normally the linker won't add a DT_NEEDED tag to the
1326 output binary for each library mentioned in a DT_NEEDED tag in an
1327 input dynamic library. With @option{--copy-dt-needed-entries}
1328 specified on the command line however any dynamic libraries that
1329 follow it will have their DT_NEEDED entries added. The default
1330 behaviour can be restored with @option{--no-copy-dt-needed-entries}.
1332 This option also has an effect on the resolution of symbols in dynamic
1333 libraries. With @option{--copy-dt-needed-entries} dynamic libraries
1334 mentioned on the command line will be recursively searched, following
1335 their DT_NEEDED tags to other libraries, in order to resolve symbols
1336 required by the output binary. With the default setting however
1337 the searching of dynamic libraries that follow it will stop with the
1338 dynamic library itself. No DT_NEEDED links will be traversed to resolve
1341 @cindex cross reference table
1344 Output a cross reference table. If a linker map file is being
1345 generated, the cross reference table is printed to the map file.
1346 Otherwise, it is printed on the standard output.
1348 The format of the table is intentionally simple, so that it may be
1349 easily processed by a script if necessary. The symbols are printed out,
1350 sorted by name. For each symbol, a list of file names is given. If the
1351 symbol is defined, the first file listed is the location of the
1352 definition. If the symbol is defined as a common value then any files
1353 where this happens appear next. Finally any files that reference the
1356 @cindex common allocation
1357 @kindex --no-define-common
1358 @item --no-define-common
1359 This option inhibits the assignment of addresses to common symbols.
1360 The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect.
1361 @xref{Miscellaneous Commands}.
1363 The @samp{--no-define-common} option allows decoupling
1364 the decision to assign addresses to Common symbols from the choice
1365 of the output file type; otherwise a non-Relocatable output type
1366 forces assigning addresses to Common symbols.
1367 Using @samp{--no-define-common} allows Common symbols that are referenced
1368 from a shared library to be assigned addresses only in the main program.
1369 This eliminates the unused duplicate space in the shared library,
1370 and also prevents any possible confusion over resolving to the wrong
1371 duplicate when there are many dynamic modules with specialized search
1372 paths for runtime symbol resolution.
1374 @cindex symbols, from command line
1375 @kindex --defsym=@var{symbol}=@var{exp}
1376 @item --defsym=@var{symbol}=@var{expression}
1377 Create a global symbol in the output file, containing the absolute
1378 address given by @var{expression}. You may use this option as many
1379 times as necessary to define multiple symbols in the command line. A
1380 limited form of arithmetic is supported for the @var{expression} in this
1381 context: you may give a hexadecimal constant or the name of an existing
1382 symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
1383 constants or symbols. If you need more elaborate expressions, consider
1384 using the linker command language from a script (@pxref{Assignments}).
1385 @emph{Note:} there should be no white space between @var{symbol}, the
1386 equals sign (``@key{=}''), and @var{expression}.
1388 @cindex demangling, from command line
1389 @kindex --demangle[=@var{style}]
1390 @kindex --no-demangle
1391 @item --demangle[=@var{style}]
1392 @itemx --no-demangle
1393 These options control whether to demangle symbol names in error messages
1394 and other output. When the linker is told to demangle, it tries to
1395 present symbol names in a readable fashion: it strips leading
1396 underscores if they are used by the object file format, and converts C++
1397 mangled symbol names into user readable names. Different compilers have
1398 different mangling styles. The optional demangling style argument can be used
1399 to choose an appropriate demangling style for your compiler. The linker will
1400 demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE}
1401 is set. These options may be used to override the default.
1403 @cindex dynamic linker, from command line
1404 @kindex -I@var{file}
1405 @kindex --dynamic-linker=@var{file}
1407 @itemx --dynamic-linker=@var{file}
1408 Set the name of the dynamic linker. This is only meaningful when
1409 generating dynamically linked ELF executables. The default dynamic
1410 linker is normally correct; don't use this unless you know what you are
1413 @kindex --fatal-warnings
1414 @kindex --no-fatal-warnings
1415 @item --fatal-warnings
1416 @itemx --no-fatal-warnings
1417 Treat all warnings as errors. The default behaviour can be restored
1418 with the option @option{--no-fatal-warnings}.
1420 @kindex --force-exe-suffix
1421 @item --force-exe-suffix
1422 Make sure that an output file has a .exe suffix.
1424 If a successfully built fully linked output file does not have a
1425 @code{.exe} or @code{.dll} suffix, this option forces the linker to copy
1426 the output file to one of the same name with a @code{.exe} suffix. This
1427 option is useful when using unmodified Unix makefiles on a Microsoft
1428 Windows host, since some versions of Windows won't run an image unless
1429 it ends in a @code{.exe} suffix.
1431 @kindex --gc-sections
1432 @kindex --no-gc-sections
1433 @cindex garbage collection
1435 @itemx --no-gc-sections
1436 Enable garbage collection of unused input sections. It is ignored on
1437 targets that do not support this option. The default behaviour (of not
1438 performing this garbage collection) can be restored by specifying
1439 @samp{--no-gc-sections} on the command line. Note that garbage
1440 collection for COFF and PE format targets is supported, but the
1441 implementation is currently considered to be experimental.
1443 @samp{--gc-sections} decides which input sections are used by
1444 examining symbols and relocations. The section containing the entry
1445 symbol and all sections containing symbols undefined on the
1446 command-line will be kept, as will sections containing symbols
1447 referenced by dynamic objects. Note that when building shared
1448 libraries, the linker must assume that any visible symbol is
1449 referenced. Once this initial set of sections has been determined,
1450 the linker recursively marks as used any section referenced by their
1451 relocations. See @samp{--entry} and @samp{--undefined}.
1453 This option can be set when doing a partial link (enabled with option
1454 @samp{-r}). In this case the root of symbols kept must be explicitly
1455 specified either by an @samp{--entry} or @samp{--undefined} option or by
1456 a @code{ENTRY} command in the linker script.
1458 @kindex --print-gc-sections
1459 @kindex --no-print-gc-sections
1460 @cindex garbage collection
1461 @item --print-gc-sections
1462 @itemx --no-print-gc-sections
1463 List all sections removed by garbage collection. The listing is
1464 printed on stderr. This option is only effective if garbage
1465 collection has been enabled via the @samp{--gc-sections}) option. The
1466 default behaviour (of not listing the sections that are removed) can
1467 be restored by specifying @samp{--no-print-gc-sections} on the command
1470 @kindex --print-output-format
1471 @cindex output format
1472 @item --print-output-format
1473 Print the name of the default output format (perhaps influenced by
1474 other command-line options). This is the string that would appear
1475 in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}).
1477 @kindex --print-memory-usage
1478 @cindex memory usage
1479 @item --print-memory-usage
1480 Print used size, total size and used size of memory regions created with
1481 the @ref{MEMORY} command. This is useful on embedded targets to have a
1482 quick view of amount of free memory. The format of the output has one
1483 headline and one line per region. It is both human readable and easily
1484 parsable by tools. Here is an example of an output:
1487 Memory region Used Size Region Size %age Used
1488 ROM: 256 KB 1 MB 25.00%
1489 RAM: 32 B 2 GB 0.00%
1496 Print a summary of the command-line options on the standard output and exit.
1498 @kindex --target-help
1500 Print a summary of all target specific options on the standard output and exit.
1502 @kindex -Map=@var{mapfile}
1503 @item -Map=@var{mapfile}
1504 Print a link map to the file @var{mapfile}. See the description of the
1505 @option{-M} option, above.
1507 @cindex memory usage
1508 @kindex --no-keep-memory
1509 @item --no-keep-memory
1510 @command{ld} normally optimizes for speed over memory usage by caching the
1511 symbol tables of input files in memory. This option tells @command{ld} to
1512 instead optimize for memory usage, by rereading the symbol tables as
1513 necessary. This may be required if @command{ld} runs out of memory space
1514 while linking a large executable.
1516 @kindex --no-undefined
1518 @item --no-undefined
1520 Report unresolved symbol references from regular object files. This
1521 is done even if the linker is creating a non-symbolic shared library.
1522 The switch @option{--[no-]allow-shlib-undefined} controls the
1523 behaviour for reporting unresolved references found in shared
1524 libraries being linked in.
1526 @kindex --allow-multiple-definition
1528 @item --allow-multiple-definition
1530 Normally when a symbol is defined multiple times, the linker will
1531 report a fatal error. These options allow multiple definitions and the
1532 first definition will be used.
1534 @kindex --allow-shlib-undefined
1535 @kindex --no-allow-shlib-undefined
1536 @item --allow-shlib-undefined
1537 @itemx --no-allow-shlib-undefined
1538 Allows or disallows undefined symbols in shared libraries.
1539 This switch is similar to @option{--no-undefined} except that it
1540 determines the behaviour when the undefined symbols are in a
1541 shared library rather than a regular object file. It does not affect
1542 how undefined symbols in regular object files are handled.
1544 The default behaviour is to report errors for any undefined symbols
1545 referenced in shared libraries if the linker is being used to create
1546 an executable, but to allow them if the linker is being used to create
1549 The reasons for allowing undefined symbol references in shared
1550 libraries specified at link time are that:
1554 A shared library specified at link time may not be the same as the one
1555 that is available at load time, so the symbol might actually be
1556 resolvable at load time.
1558 There are some operating systems, eg BeOS and HPPA, where undefined
1559 symbols in shared libraries are normal.
1561 The BeOS kernel for example patches shared libraries at load time to
1562 select whichever function is most appropriate for the current
1563 architecture. This is used, for example, to dynamically select an
1564 appropriate memset function.
1567 @kindex --no-undefined-version
1568 @item --no-undefined-version
1569 Normally when a symbol has an undefined version, the linker will ignore
1570 it. This option disallows symbols with undefined version and a fatal error
1571 will be issued instead.
1573 @kindex --default-symver
1574 @item --default-symver
1575 Create and use a default symbol version (the soname) for unversioned
1578 @kindex --default-imported-symver
1579 @item --default-imported-symver
1580 Create and use a default symbol version (the soname) for unversioned
1583 @kindex --no-warn-mismatch
1584 @item --no-warn-mismatch
1585 Normally @command{ld} will give an error if you try to link together input
1586 files that are mismatched for some reason, perhaps because they have
1587 been compiled for different processors or for different endiannesses.
1588 This option tells @command{ld} that it should silently permit such possible
1589 errors. This option should only be used with care, in cases when you
1590 have taken some special action that ensures that the linker errors are
1593 @kindex --no-warn-search-mismatch
1594 @item --no-warn-search-mismatch
1595 Normally @command{ld} will give a warning if it finds an incompatible
1596 library during a library search. This option silences the warning.
1598 @kindex --no-whole-archive
1599 @item --no-whole-archive
1600 Turn off the effect of the @option{--whole-archive} option for subsequent
1603 @cindex output file after errors
1604 @kindex --noinhibit-exec
1605 @item --noinhibit-exec
1606 Retain the executable output file whenever it is still usable.
1607 Normally, the linker will not produce an output file if it encounters
1608 errors during the link process; it exits without writing an output file
1609 when it issues any error whatsoever.
1613 Only search library directories explicitly specified on the
1614 command line. Library directories specified in linker scripts
1615 (including linker scripts specified on the command line) are ignored.
1617 @ifclear SingleFormat
1618 @kindex --oformat=@var{output-format}
1619 @item --oformat=@var{output-format}
1620 @command{ld} may be configured to support more than one kind of object
1621 file. If your @command{ld} is configured this way, you can use the
1622 @samp{--oformat} option to specify the binary format for the output
1623 object file. Even when @command{ld} is configured to support alternative
1624 object formats, you don't usually need to specify this, as @command{ld}
1625 should be configured to produce as a default output format the most
1626 usual format on each machine. @var{output-format} is a text string, the
1627 name of a particular format supported by the BFD libraries. (You can
1628 list the available binary formats with @samp{objdump -i}.) The script
1629 command @code{OUTPUT_FORMAT} can also specify the output format, but
1630 this option overrides it. @xref{BFD}.
1634 @kindex --pic-executable
1636 @itemx --pic-executable
1637 @cindex position independent executables
1638 Create a position independent executable. This is currently only supported on
1639 ELF platforms. Position independent executables are similar to shared
1640 libraries in that they are relocated by the dynamic linker to the virtual
1641 address the OS chooses for them (which can vary between invocations). Like
1642 normal dynamically linked executables they can be executed and symbols
1643 defined in the executable cannot be overridden by shared libraries.
1647 This option is ignored for Linux compatibility.
1651 This option is ignored for SVR4 compatibility.
1654 @cindex synthesizing linker
1655 @cindex relaxing addressing modes
1659 An option with machine dependent effects.
1661 This option is only supported on a few targets.
1664 @xref{H8/300,,@command{ld} and the H8/300}.
1667 @xref{i960,, @command{ld} and the Intel 960 family}.
1670 @xref{Xtensa,, @command{ld} and Xtensa Processors}.
1673 @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}.
1676 @xref{Nios II,,@command{ld} and the Altera Nios II}.
1679 @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}.
1682 On some platforms the @samp{--relax} option performs target specific,
1683 global optimizations that become possible when the linker resolves
1684 addressing in the program, such as relaxing address modes,
1685 synthesizing new instructions, selecting shorter version of current
1686 instructions, and combining constant values.
1688 On some platforms these link time global optimizations may make symbolic
1689 debugging of the resulting executable impossible.
1691 This is known to be the case for the Matsushita MN10200 and MN10300
1692 family of processors.
1696 On platforms where this is not supported, @samp{--relax} is accepted,
1700 On platforms where @samp{--relax} is accepted the option
1701 @samp{--no-relax} can be used to disable the feature.
1703 @cindex retaining specified symbols
1704 @cindex stripping all but some symbols
1705 @cindex symbols, retaining selectively
1706 @kindex --retain-symbols-file=@var{filename}
1707 @item --retain-symbols-file=@var{filename}
1708 Retain @emph{only} the symbols listed in the file @var{filename},
1709 discarding all others. @var{filename} is simply a flat file, with one
1710 symbol name per line. This option is especially useful in environments
1714 where a large global symbol table is accumulated gradually, to conserve
1717 @samp{--retain-symbols-file} does @emph{not} discard undefined symbols,
1718 or symbols needed for relocations.
1720 You may only specify @samp{--retain-symbols-file} once in the command
1721 line. It overrides @samp{-s} and @samp{-S}.
1724 @item -rpath=@var{dir}
1725 @cindex runtime library search path
1726 @kindex -rpath=@var{dir}
1727 Add a directory to the runtime library search path. This is used when
1728 linking an ELF executable with shared objects. All @option{-rpath}
1729 arguments are concatenated and passed to the runtime linker, which uses
1730 them to locate shared objects at runtime. The @option{-rpath} option is
1731 also used when locating shared objects which are needed by shared
1732 objects explicitly included in the link; see the description of the
1733 @option{-rpath-link} option. If @option{-rpath} is not used when linking an
1734 ELF executable, the contents of the environment variable
1735 @code{LD_RUN_PATH} will be used if it is defined.
1737 The @option{-rpath} option may also be used on SunOS. By default, on
1738 SunOS, the linker will form a runtime search patch out of all the
1739 @option{-L} options it is given. If a @option{-rpath} option is used, the
1740 runtime search path will be formed exclusively using the @option{-rpath}
1741 options, ignoring the @option{-L} options. This can be useful when using
1742 gcc, which adds many @option{-L} options which may be on NFS mounted
1745 For compatibility with other ELF linkers, if the @option{-R} option is
1746 followed by a directory name, rather than a file name, it is treated as
1747 the @option{-rpath} option.
1751 @cindex link-time runtime library search path
1752 @kindex -rpath-link=@var{dir}
1753 @item -rpath-link=@var{dir}
1754 When using ELF or SunOS, one shared library may require another. This
1755 happens when an @code{ld -shared} link includes a shared library as one
1758 When the linker encounters such a dependency when doing a non-shared,
1759 non-relocatable link, it will automatically try to locate the required
1760 shared library and include it in the link, if it is not included
1761 explicitly. In such a case, the @option{-rpath-link} option
1762 specifies the first set of directories to search. The
1763 @option{-rpath-link} option may specify a sequence of directory names
1764 either by specifying a list of names separated by colons, or by
1765 appearing multiple times.
1767 This option should be used with caution as it overrides the search path
1768 that may have been hard compiled into a shared library. In such a case it
1769 is possible to use unintentionally a different search path than the
1770 runtime linker would do.
1772 The linker uses the following search paths to locate required shared
1776 Any directories specified by @option{-rpath-link} options.
1778 Any directories specified by @option{-rpath} options. The difference
1779 between @option{-rpath} and @option{-rpath-link} is that directories
1780 specified by @option{-rpath} options are included in the executable and
1781 used at runtime, whereas the @option{-rpath-link} option is only effective
1782 at link time. Searching @option{-rpath} in this way is only supported
1783 by native linkers and cross linkers which have been configured with
1784 the @option{--with-sysroot} option.
1786 On an ELF system, for native linkers, if the @option{-rpath} and
1787 @option{-rpath-link} options were not used, search the contents of the
1788 environment variable @code{LD_RUN_PATH}.
1790 On SunOS, if the @option{-rpath} option was not used, search any
1791 directories specified using @option{-L} options.
1793 For a native linker, search the contents of the environment
1794 variable @code{LD_LIBRARY_PATH}.
1796 For a native ELF linker, the directories in @code{DT_RUNPATH} or
1797 @code{DT_RPATH} of a shared library are searched for shared
1798 libraries needed by it. The @code{DT_RPATH} entries are ignored if
1799 @code{DT_RUNPATH} entries exist.
1801 The default directories, normally @file{/lib} and @file{/usr/lib}.
1803 For a native linker on an ELF system, if the file @file{/etc/ld.so.conf}
1804 exists, the list of directories found in that file.
1807 If the required shared library is not found, the linker will issue a
1808 warning and continue with the link.
1815 @cindex shared libraries
1816 Create a shared library. This is currently only supported on ELF, XCOFF
1817 and SunOS platforms. On SunOS, the linker will automatically create a
1818 shared library if the @option{-e} option is not used and there are
1819 undefined symbols in the link.
1821 @kindex --sort-common
1823 @itemx --sort-common=ascending
1824 @itemx --sort-common=descending
1825 This option tells @command{ld} to sort the common symbols by alignment in
1826 ascending or descending order when it places them in the appropriate output
1827 sections. The symbol alignments considered are sixteen-byte or larger,
1828 eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps
1829 between symbols due to alignment constraints. If no sorting order is
1830 specified, then descending order is assumed.
1832 @kindex --sort-section=name
1833 @item --sort-section=name
1834 This option will apply @code{SORT_BY_NAME} to all wildcard section
1835 patterns in the linker script.
1837 @kindex --sort-section=alignment
1838 @item --sort-section=alignment
1839 This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section
1840 patterns in the linker script.
1842 @kindex --split-by-file
1843 @item --split-by-file[=@var{size}]
1844 Similar to @option{--split-by-reloc} but creates a new output section for
1845 each input file when @var{size} is reached. @var{size} defaults to a
1846 size of 1 if not given.
1848 @kindex --split-by-reloc
1849 @item --split-by-reloc[=@var{count}]
1850 Tries to creates extra sections in the output file so that no single
1851 output section in the file contains more than @var{count} relocations.
1852 This is useful when generating huge relocatable files for downloading into
1853 certain real time kernels with the COFF object file format; since COFF
1854 cannot represent more than 65535 relocations in a single section. Note
1855 that this will fail to work with object file formats which do not
1856 support arbitrary sections. The linker will not split up individual
1857 input sections for redistribution, so if a single input section contains
1858 more than @var{count} relocations one output section will contain that
1859 many relocations. @var{count} defaults to a value of 32768.
1863 Compute and display statistics about the operation of the linker, such
1864 as execution time and memory usage.
1866 @kindex --sysroot=@var{directory}
1867 @item --sysroot=@var{directory}
1868 Use @var{directory} as the location of the sysroot, overriding the
1869 configure-time default. This option is only supported by linkers
1870 that were configured using @option{--with-sysroot}.
1872 @kindex --traditional-format
1873 @cindex traditional format
1874 @item --traditional-format
1875 For some targets, the output of @command{ld} is different in some ways from
1876 the output of some existing linker. This switch requests @command{ld} to
1877 use the traditional format instead.
1880 For example, on SunOS, @command{ld} combines duplicate entries in the
1881 symbol string table. This can reduce the size of an output file with
1882 full debugging information by over 30 percent. Unfortunately, the SunOS
1883 @code{dbx} program can not read the resulting program (@code{gdb} has no
1884 trouble). The @samp{--traditional-format} switch tells @command{ld} to not
1885 combine duplicate entries.
1887 @kindex --section-start=@var{sectionname}=@var{org}
1888 @item --section-start=@var{sectionname}=@var{org}
1889 Locate a section in the output file at the absolute
1890 address given by @var{org}. You may use this option as many
1891 times as necessary to locate multiple sections in the command
1893 @var{org} must be a single hexadecimal integer;
1894 for compatibility with other linkers, you may omit the leading
1895 @samp{0x} usually associated with hexadecimal values. @emph{Note:} there
1896 should be no white space between @var{sectionname}, the equals
1897 sign (``@key{=}''), and @var{org}.
1899 @kindex -Tbss=@var{org}
1900 @kindex -Tdata=@var{org}
1901 @kindex -Ttext=@var{org}
1902 @cindex segment origins, cmd line
1903 @item -Tbss=@var{org}
1904 @itemx -Tdata=@var{org}
1905 @itemx -Ttext=@var{org}
1906 Same as @option{--section-start}, with @code{.bss}, @code{.data} or
1907 @code{.text} as the @var{sectionname}.
1909 @kindex -Ttext-segment=@var{org}
1910 @item -Ttext-segment=@var{org}
1911 @cindex text segment origin, cmd line
1912 When creating an ELF executable, it will set the address of the first
1913 byte of the text segment.
1915 @kindex -Trodata-segment=@var{org}
1916 @item -Trodata-segment=@var{org}
1917 @cindex rodata segment origin, cmd line
1918 When creating an ELF executable or shared object for a target where
1919 the read-only data is in its own segment separate from the executable
1920 text, it will set the address of the first byte of the read-only data segment.
1922 @kindex -Tldata-segment=@var{org}
1923 @item -Tldata-segment=@var{org}
1924 @cindex ldata segment origin, cmd line
1925 When creating an ELF executable or shared object for x86-64 medium memory
1926 model, it will set the address of the first byte of the ldata segment.
1928 @kindex --unresolved-symbols
1929 @item --unresolved-symbols=@var{method}
1930 Determine how to handle unresolved symbols. There are four possible
1931 values for @samp{method}:
1935 Do not report any unresolved symbols.
1938 Report all unresolved symbols. This is the default.
1940 @item ignore-in-object-files
1941 Report unresolved symbols that are contained in shared libraries, but
1942 ignore them if they come from regular object files.
1944 @item ignore-in-shared-libs
1945 Report unresolved symbols that come from regular object files, but
1946 ignore them if they come from shared libraries. This can be useful
1947 when creating a dynamic binary and it is known that all the shared
1948 libraries that it should be referencing are included on the linker's
1952 The behaviour for shared libraries on their own can also be controlled
1953 by the @option{--[no-]allow-shlib-undefined} option.
1955 Normally the linker will generate an error message for each reported
1956 unresolved symbol but the option @option{--warn-unresolved-symbols}
1957 can change this to a warning.
1959 @kindex --verbose[=@var{NUMBER}]
1960 @cindex verbose[=@var{NUMBER}]
1962 @itemx --verbose[=@var{NUMBER}]
1963 Display the version number for @command{ld} and list the linker emulations
1964 supported. Display which input files can and cannot be opened. Display
1965 the linker script being used by the linker. If the optional @var{NUMBER}
1966 argument > 1, plugin symbol status will also be displayed.
1968 @kindex --version-script=@var{version-scriptfile}
1969 @cindex version script, symbol versions
1970 @item --version-script=@var{version-scriptfile}
1971 Specify the name of a version script to the linker. This is typically
1972 used when creating shared libraries to specify additional information
1973 about the version hierarchy for the library being created. This option
1974 is only fully supported on ELF platforms which support shared libraries;
1975 see @ref{VERSION}. It is partially supported on PE platforms, which can
1976 use version scripts to filter symbol visibility in auto-export mode: any
1977 symbols marked @samp{local} in the version script will not be exported.
1980 @kindex --warn-common
1981 @cindex warnings, on combining symbols
1982 @cindex combining symbols, warnings on
1984 Warn when a common symbol is combined with another common symbol or with
1985 a symbol definition. Unix linkers allow this somewhat sloppy practice,
1986 but linkers on some other operating systems do not. This option allows
1987 you to find potential problems from combining global symbols.
1988 Unfortunately, some C libraries use this practice, so you may get some
1989 warnings about symbols in the libraries as well as in your programs.
1991 There are three kinds of global symbols, illustrated here by C examples:
1995 A definition, which goes in the initialized data section of the output
1999 An undefined reference, which does not allocate space.
2000 There must be either a definition or a common symbol for the
2004 A common symbol. If there are only (one or more) common symbols for a
2005 variable, it goes in the uninitialized data area of the output file.
2006 The linker merges multiple common symbols for the same variable into a
2007 single symbol. If they are of different sizes, it picks the largest
2008 size. The linker turns a common symbol into a declaration, if there is
2009 a definition of the same variable.
2012 The @samp{--warn-common} option can produce five kinds of warnings.
2013 Each warning consists of a pair of lines: the first describes the symbol
2014 just encountered, and the second describes the previous symbol
2015 encountered with the same name. One or both of the two symbols will be
2020 Turning a common symbol into a reference, because there is already a
2021 definition for the symbol.
2023 @var{file}(@var{section}): warning: common of `@var{symbol}'
2024 overridden by definition
2025 @var{file}(@var{section}): warning: defined here
2029 Turning a common symbol into a reference, because a later definition for
2030 the symbol is encountered. This is the same as the previous case,
2031 except that the symbols are encountered in a different order.
2033 @var{file}(@var{section}): warning: definition of `@var{symbol}'
2035 @var{file}(@var{section}): warning: common is here
2039 Merging a common symbol with a previous same-sized common symbol.
2041 @var{file}(@var{section}): warning: multiple common
2043 @var{file}(@var{section}): warning: previous common is here
2047 Merging a common symbol with a previous larger common symbol.
2049 @var{file}(@var{section}): warning: common of `@var{symbol}'
2050 overridden by larger common
2051 @var{file}(@var{section}): warning: larger common is here
2055 Merging a common symbol with a previous smaller common symbol. This is
2056 the same as the previous case, except that the symbols are
2057 encountered in a different order.
2059 @var{file}(@var{section}): warning: common of `@var{symbol}'
2060 overriding smaller common
2061 @var{file}(@var{section}): warning: smaller common is here
2065 @kindex --warn-constructors
2066 @item --warn-constructors
2067 Warn if any global constructors are used. This is only useful for a few
2068 object file formats. For formats like COFF or ELF, the linker can not
2069 detect the use of global constructors.
2071 @kindex --warn-multiple-gp
2072 @item --warn-multiple-gp
2073 Warn if multiple global pointer values are required in the output file.
2074 This is only meaningful for certain processors, such as the Alpha.
2075 Specifically, some processors put large-valued constants in a special
2076 section. A special register (the global pointer) points into the middle
2077 of this section, so that constants can be loaded efficiently via a
2078 base-register relative addressing mode. Since the offset in
2079 base-register relative mode is fixed and relatively small (e.g., 16
2080 bits), this limits the maximum size of the constant pool. Thus, in
2081 large programs, it is often necessary to use multiple global pointer
2082 values in order to be able to address all possible constants. This
2083 option causes a warning to be issued whenever this case occurs.
2086 @cindex warnings, on undefined symbols
2087 @cindex undefined symbols, warnings on
2089 Only warn once for each undefined symbol, rather than once per module
2092 @kindex --warn-orphan
2093 @kindex --no-warn-orphan
2094 @cindex warnings, on orphan sections
2095 @cindex orphan sections, warnings on
2097 The @option{--warn-orphan} option tells the linker to generate a
2098 warning message whenever it has to place an orphan section into the
2099 output file. @xref{Orphan Sections}. The @option{--no-warn-orphan}
2100 option restores the default behaviour of just silently placing these
2103 @kindex --warn-section-align
2104 @cindex warnings, on section alignment
2105 @cindex section alignment, warnings on
2106 @item --warn-section-align
2107 Warn if the address of an output section is changed because of
2108 alignment. Typically, the alignment will be set by an input section.
2109 The address will only be changed if it not explicitly specified; that
2110 is, if the @code{SECTIONS} command does not specify a start address for
2111 the section (@pxref{SECTIONS}).
2113 @kindex --warn-shared-textrel
2114 @item --warn-shared-textrel
2115 Warn if the linker adds a DT_TEXTREL to a shared object.
2117 @kindex --warn-alternate-em
2118 @item --warn-alternate-em
2119 Warn if an object has alternate ELF machine code.
2121 @kindex --warn-unresolved-symbols
2122 @item --warn-unresolved-symbols
2123 If the linker is going to report an unresolved symbol (see the option
2124 @option{--unresolved-symbols}) it will normally generate an error.
2125 This option makes it generate a warning instead.
2127 @kindex --error-unresolved-symbols
2128 @item --error-unresolved-symbols
2129 This restores the linker's default behaviour of generating errors when
2130 it is reporting unresolved symbols.
2132 @kindex --whole-archive
2133 @cindex including an entire archive
2134 @item --whole-archive
2135 For each archive mentioned on the command line after the
2136 @option{--whole-archive} option, include every object file in the archive
2137 in the link, rather than searching the archive for the required object
2138 files. This is normally used to turn an archive file into a shared
2139 library, forcing every object to be included in the resulting shared
2140 library. This option may be used more than once.
2142 Two notes when using this option from gcc: First, gcc doesn't know
2143 about this option, so you have to use @option{-Wl,-whole-archive}.
2144 Second, don't forget to use @option{-Wl,-no-whole-archive} after your
2145 list of archives, because gcc will add its own list of archives to
2146 your link and you may not want this flag to affect those as well.
2148 @kindex --wrap=@var{symbol}
2149 @item --wrap=@var{symbol}
2150 Use a wrapper function for @var{symbol}. Any undefined reference to
2151 @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any
2152 undefined reference to @code{__real_@var{symbol}} will be resolved to
2155 This can be used to provide a wrapper for a system function. The
2156 wrapper function should be called @code{__wrap_@var{symbol}}. If it
2157 wishes to call the system function, it should call
2158 @code{__real_@var{symbol}}.
2160 Here is a trivial example:
2164 __wrap_malloc (size_t c)
2166 printf ("malloc called with %zu\n", c);
2167 return __real_malloc (c);
2171 If you link other code with this file using @option{--wrap malloc}, then
2172 all calls to @code{malloc} will call the function @code{__wrap_malloc}
2173 instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will
2174 call the real @code{malloc} function.
2176 You may wish to provide a @code{__real_malloc} function as well, so that
2177 links without the @option{--wrap} option will succeed. If you do this,
2178 you should not put the definition of @code{__real_malloc} in the same
2179 file as @code{__wrap_malloc}; if you do, the assembler may resolve the
2180 call before the linker has a chance to wrap it to @code{malloc}.
2182 @kindex --eh-frame-hdr
2183 @item --eh-frame-hdr
2184 Request creation of @code{.eh_frame_hdr} section and ELF
2185 @code{PT_GNU_EH_FRAME} segment header.
2187 @kindex --ld-generated-unwind-info
2188 @item --no-ld-generated-unwind-info
2189 Request creation of @code{.eh_frame} unwind info for linker
2190 generated code sections like PLT. This option is on by default
2191 if linker generated unwind info is supported.
2193 @kindex --enable-new-dtags
2194 @kindex --disable-new-dtags
2195 @item --enable-new-dtags
2196 @itemx --disable-new-dtags
2197 This linker can create the new dynamic tags in ELF. But the older ELF
2198 systems may not understand them. If you specify
2199 @option{--enable-new-dtags}, the new dynamic tags will be created as needed
2200 and older dynamic tags will be omitted.
2201 If you specify @option{--disable-new-dtags}, no new dynamic tags will be
2202 created. By default, the new dynamic tags are not created. Note that
2203 those options are only available for ELF systems.
2205 @kindex --hash-size=@var{number}
2206 @item --hash-size=@var{number}
2207 Set the default size of the linker's hash tables to a prime number
2208 close to @var{number}. Increasing this value can reduce the length of
2209 time it takes the linker to perform its tasks, at the expense of
2210 increasing the linker's memory requirements. Similarly reducing this
2211 value can reduce the memory requirements at the expense of speed.
2213 @kindex --hash-style=@var{style}
2214 @item --hash-style=@var{style}
2215 Set the type of linker's hash table(s). @var{style} can be either
2216 @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for
2217 new style GNU @code{.gnu.hash} section or @code{both} for both
2218 the classic ELF @code{.hash} and new style GNU @code{.gnu.hash}
2219 hash tables. The default is @code{sysv}.
2221 @kindex --compress-debug-sections=none
2222 @kindex --compress-debug-sections=zlib
2223 @kindex --compress-debug-sections=zlib-gnu
2224 @kindex --compress-debug-sections=zlib-gabi
2225 @item --compress-debug-sections=none
2226 @itemx --compress-debug-sections=zlib
2227 @itemx --compress-debug-sections=zlib-gnu
2228 @itemx --compress-debug-sections=zlib-gabi
2229 On ELF platforms , these options control how DWARF debug sections are
2230 compressed using zlib. @option{--compress-debug-sections=none} doesn't
2231 compress DWARF debug sections. @option{--compress-debug-sections=zlib}
2232 and @option{--compress-debug-sections=zlib-gnu} compress DWARF debug
2233 sections and rename debug section names to begin with @samp{.zdebug}
2234 instead of @samp{.debug}. @option{--compress-debug-sections=zlib-gabi}
2235 compresses DWARF debug sections with SHF_COMPRESSED from the ELF ABI.
2237 @kindex --reduce-memory-overheads
2238 @item --reduce-memory-overheads
2239 This option reduces memory requirements at ld runtime, at the expense of
2240 linking speed. This was introduced to select the old O(n^2) algorithm
2241 for link map file generation, rather than the new O(n) algorithm which uses
2242 about 40% more memory for symbol storage.
2244 Another effect of the switch is to set the default hash table size to
2245 1021, which again saves memory at the cost of lengthening the linker's
2246 run time. This is not done however if the @option{--hash-size} switch
2249 The @option{--reduce-memory-overheads} switch may be also be used to
2250 enable other tradeoffs in future versions of the linker.
2253 @kindex --build-id=@var{style}
2255 @itemx --build-id=@var{style}
2256 Request the creation of a @code{.note.gnu.build-id} ELF note section
2257 or a @code{.build-id} COFF section. The contents of the note are
2258 unique bits identifying this linked file. @var{style} can be
2259 @code{uuid} to use 128 random bits, @code{sha1} to use a 160-bit
2260 @sc{SHA1} hash on the normative parts of the output contents,
2261 @code{md5} to use a 128-bit @sc{MD5} hash on the normative parts of
2262 the output contents, or @code{0x@var{hexstring}} to use a chosen bit
2263 string specified as an even number of hexadecimal digits (@code{-} and
2264 @code{:} characters between digit pairs are ignored). If @var{style}
2265 is omitted, @code{sha1} is used.
2267 The @code{md5} and @code{sha1} styles produces an identifier
2268 that is always the same in an identical output file, but will be
2269 unique among all nonidentical output files. It is not intended
2270 to be compared as a checksum for the file's contents. A linked
2271 file may be changed later by other tools, but the build ID bit
2272 string identifying the original linked file does not change.
2274 Passing @code{none} for @var{style} disables the setting from any
2275 @code{--build-id} options earlier on the command line.
2280 @subsection Options Specific to i386 PE Targets
2282 @c man begin OPTIONS
2284 The i386 PE linker supports the @option{-shared} option, which causes
2285 the output to be a dynamically linked library (DLL) instead of a
2286 normal executable. You should name the output @code{*.dll} when you
2287 use this option. In addition, the linker fully supports the standard
2288 @code{*.def} files, which may be specified on the linker command line
2289 like an object file (in fact, it should precede archives it exports
2290 symbols from, to ensure that they get linked in, just like a normal
2293 In addition to the options common to all targets, the i386 PE linker
2294 support additional command line options that are specific to the i386
2295 PE target. Options that take values may be separated from their
2296 values by either a space or an equals sign.
2300 @kindex --add-stdcall-alias
2301 @item --add-stdcall-alias
2302 If given, symbols with a stdcall suffix (@@@var{nn}) will be exported
2303 as-is and also with the suffix stripped.
2304 [This option is specific to the i386 PE targeted port of the linker]
2307 @item --base-file @var{file}
2308 Use @var{file} as the name of a file in which to save the base
2309 addresses of all the relocations needed for generating DLLs with
2311 [This is an i386 PE specific option]
2315 Create a DLL instead of a regular executable. You may also use
2316 @option{-shared} or specify a @code{LIBRARY} in a given @code{.def}
2318 [This option is specific to the i386 PE targeted port of the linker]
2320 @kindex --enable-long-section-names
2321 @kindex --disable-long-section-names
2322 @item --enable-long-section-names
2323 @itemx --disable-long-section-names
2324 The PE variants of the Coff object format add an extension that permits
2325 the use of section names longer than eight characters, the normal limit
2326 for Coff. By default, these names are only allowed in object files, as
2327 fully-linked executable images do not carry the Coff string table required
2328 to support the longer names. As a GNU extension, it is possible to
2329 allow their use in executable images as well, or to (probably pointlessly!)
2330 disallow it in object files, by using these two options. Executable images
2331 generated with these long section names are slightly non-standard, carrying
2332 as they do a string table, and may generate confusing output when examined
2333 with non-GNU PE-aware tools, such as file viewers and dumpers. However,
2334 GDB relies on the use of PE long section names to find Dwarf-2 debug
2335 information sections in an executable image at runtime, and so if neither
2336 option is specified on the command-line, @command{ld} will enable long
2337 section names, overriding the default and technically correct behaviour,
2338 when it finds the presence of debug information while linking an executable
2339 image and not stripping symbols.
2340 [This option is valid for all PE targeted ports of the linker]
2342 @kindex --enable-stdcall-fixup
2343 @kindex --disable-stdcall-fixup
2344 @item --enable-stdcall-fixup
2345 @itemx --disable-stdcall-fixup
2346 If the link finds a symbol that it cannot resolve, it will attempt to
2347 do ``fuzzy linking'' by looking for another defined symbol that differs
2348 only in the format of the symbol name (cdecl vs stdcall) and will
2349 resolve that symbol by linking to the match. For example, the
2350 undefined symbol @code{_foo} might be linked to the function
2351 @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked
2352 to the function @code{_bar}. When the linker does this, it prints a
2353 warning, since it normally should have failed to link, but sometimes
2354 import libraries generated from third-party dlls may need this feature
2355 to be usable. If you specify @option{--enable-stdcall-fixup}, this
2356 feature is fully enabled and warnings are not printed. If you specify
2357 @option{--disable-stdcall-fixup}, this feature is disabled and such
2358 mismatches are considered to be errors.
2359 [This option is specific to the i386 PE targeted port of the linker]
2361 @kindex --leading-underscore
2362 @kindex --no-leading-underscore
2363 @item --leading-underscore
2364 @itemx --no-leading-underscore
2365 For most targets default symbol-prefix is an underscore and is defined
2366 in target's description. By this option it is possible to
2367 disable/enable the default underscore symbol-prefix.
2369 @cindex DLLs, creating
2370 @kindex --export-all-symbols
2371 @item --export-all-symbols
2372 If given, all global symbols in the objects used to build a DLL will
2373 be exported by the DLL. Note that this is the default if there
2374 otherwise wouldn't be any exported symbols. When symbols are
2375 explicitly exported via DEF files or implicitly exported via function
2376 attributes, the default is to not export anything else unless this
2377 option is given. Note that the symbols @code{DllMain@@12},
2378 @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and
2379 @code{impure_ptr} will not be automatically
2380 exported. Also, symbols imported from other DLLs will not be
2381 re-exported, nor will symbols specifying the DLL's internal layout
2382 such as those beginning with @code{_head_} or ending with
2383 @code{_iname}. In addition, no symbols from @code{libgcc},
2384 @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported.
2385 Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will
2386 not be exported, to help with C++ DLLs. Finally, there is an
2387 extensive list of cygwin-private symbols that are not exported
2388 (obviously, this applies on when building DLLs for cygwin targets).
2389 These cygwin-excludes are: @code{_cygwin_dll_entry@@12},
2390 @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12},
2391 @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll},
2392 @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2},
2393 @code{cygwin_premain3}, and @code{environ}.
2394 [This option is specific to the i386 PE targeted port of the linker]
2396 @kindex --exclude-symbols
2397 @item --exclude-symbols @var{symbol},@var{symbol},...
2398 Specifies a list of symbols which should not be automatically
2399 exported. The symbol names may be delimited by commas or colons.
2400 [This option is specific to the i386 PE targeted port of the linker]
2402 @kindex --exclude-all-symbols
2403 @item --exclude-all-symbols
2404 Specifies no symbols should be automatically exported.
2405 [This option is specific to the i386 PE targeted port of the linker]
2407 @kindex --file-alignment
2408 @item --file-alignment
2409 Specify the file alignment. Sections in the file will always begin at
2410 file offsets which are multiples of this number. This defaults to
2412 [This option is specific to the i386 PE targeted port of the linker]
2416 @item --heap @var{reserve}
2417 @itemx --heap @var{reserve},@var{commit}
2418 Specify the number of bytes of memory to reserve (and optionally commit)
2419 to be used as heap for this program. The default is 1MB reserved, 4K
2421 [This option is specific to the i386 PE targeted port of the linker]
2424 @kindex --image-base
2425 @item --image-base @var{value}
2426 Use @var{value} as the base address of your program or dll. This is
2427 the lowest memory location that will be used when your program or dll
2428 is loaded. To reduce the need to relocate and improve performance of
2429 your dlls, each should have a unique base address and not overlap any
2430 other dlls. The default is 0x400000 for executables, and 0x10000000
2432 [This option is specific to the i386 PE targeted port of the linker]
2436 If given, the stdcall suffixes (@@@var{nn}) will be stripped from
2437 symbols before they are exported.
2438 [This option is specific to the i386 PE targeted port of the linker]
2440 @kindex --large-address-aware
2441 @item --large-address-aware
2442 If given, the appropriate bit in the ``Characteristics'' field of the COFF
2443 header is set to indicate that this executable supports virtual addresses
2444 greater than 2 gigabytes. This should be used in conjunction with the /3GB
2445 or /USERVA=@var{value} megabytes switch in the ``[operating systems]''
2446 section of the BOOT.INI. Otherwise, this bit has no effect.
2447 [This option is specific to PE targeted ports of the linker]
2449 @kindex --disable-large-address-aware
2450 @item --disable-large-address-aware
2451 Reverts the effect of a previous @samp{--large-address-aware} option.
2452 This is useful if @samp{--large-address-aware} is always set by the compiler
2453 driver (e.g. Cygwin gcc) and the executable does not support virtual
2454 addresses greater than 2 gigabytes.
2455 [This option is specific to PE targeted ports of the linker]
2457 @kindex --major-image-version
2458 @item --major-image-version @var{value}
2459 Sets the major number of the ``image version''. Defaults to 1.
2460 [This option is specific to the i386 PE targeted port of the linker]
2462 @kindex --major-os-version
2463 @item --major-os-version @var{value}
2464 Sets the major number of the ``os version''. Defaults to 4.
2465 [This option is specific to the i386 PE targeted port of the linker]
2467 @kindex --major-subsystem-version
2468 @item --major-subsystem-version @var{value}
2469 Sets the major number of the ``subsystem version''. Defaults to 4.
2470 [This option is specific to the i386 PE targeted port of the linker]
2472 @kindex --minor-image-version
2473 @item --minor-image-version @var{value}
2474 Sets the minor number of the ``image version''. Defaults to 0.
2475 [This option is specific to the i386 PE targeted port of the linker]
2477 @kindex --minor-os-version
2478 @item --minor-os-version @var{value}
2479 Sets the minor number of the ``os version''. Defaults to 0.
2480 [This option is specific to the i386 PE targeted port of the linker]
2482 @kindex --minor-subsystem-version
2483 @item --minor-subsystem-version @var{value}
2484 Sets the minor number of the ``subsystem version''. Defaults to 0.
2485 [This option is specific to the i386 PE targeted port of the linker]
2487 @cindex DEF files, creating
2488 @cindex DLLs, creating
2489 @kindex --output-def
2490 @item --output-def @var{file}
2491 The linker will create the file @var{file} which will contain a DEF
2492 file corresponding to the DLL the linker is generating. This DEF file
2493 (which should be called @code{*.def}) may be used to create an import
2494 library with @code{dlltool} or may be used as a reference to
2495 automatically or implicitly exported symbols.
2496 [This option is specific to the i386 PE targeted port of the linker]
2498 @cindex DLLs, creating
2499 @kindex --out-implib
2500 @item --out-implib @var{file}
2501 The linker will create the file @var{file} which will contain an
2502 import lib corresponding to the DLL the linker is generating. This
2503 import lib (which should be called @code{*.dll.a} or @code{*.a}
2504 may be used to link clients against the generated DLL; this behaviour
2505 makes it possible to skip a separate @code{dlltool} import library
2507 [This option is specific to the i386 PE targeted port of the linker]
2509 @kindex --enable-auto-image-base
2510 @item --enable-auto-image-base
2511 @itemx --enable-auto-image-base=@var{value}
2512 Automatically choose the image base for DLLs, optionally starting with base
2513 @var{value}, unless one is specified using the @code{--image-base} argument.
2514 By using a hash generated from the dllname to create unique image bases
2515 for each DLL, in-memory collisions and relocations which can delay program
2516 execution are avoided.
2517 [This option is specific to the i386 PE targeted port of the linker]
2519 @kindex --disable-auto-image-base
2520 @item --disable-auto-image-base
2521 Do not automatically generate a unique image base. If there is no
2522 user-specified image base (@code{--image-base}) then use the platform
2524 [This option is specific to the i386 PE targeted port of the linker]
2526 @cindex DLLs, linking to
2527 @kindex --dll-search-prefix
2528 @item --dll-search-prefix @var{string}
2529 When linking dynamically to a dll without an import library,
2530 search for @code{<string><basename>.dll} in preference to
2531 @code{lib<basename>.dll}. This behaviour allows easy distinction
2532 between DLLs built for the various "subplatforms": native, cygwin,
2533 uwin, pw, etc. For instance, cygwin DLLs typically use
2534 @code{--dll-search-prefix=cyg}.
2535 [This option is specific to the i386 PE targeted port of the linker]
2537 @kindex --enable-auto-import
2538 @item --enable-auto-import
2539 Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for
2540 DATA imports from DLLs, and create the necessary thunking symbols when
2541 building the import libraries with those DATA exports. Note: Use of the
2542 'auto-import' extension will cause the text section of the image file
2543 to be made writable. This does not conform to the PE-COFF format
2544 specification published by Microsoft.
2546 Note - use of the 'auto-import' extension will also cause read only
2547 data which would normally be placed into the .rdata section to be
2548 placed into the .data section instead. This is in order to work
2549 around a problem with consts that is described here:
2550 http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
2552 Using 'auto-import' generally will 'just work' -- but sometimes you may
2555 "variable '<var>' can't be auto-imported. Please read the
2556 documentation for ld's @code{--enable-auto-import} for details."
2558 This message occurs when some (sub)expression accesses an address
2559 ultimately given by the sum of two constants (Win32 import tables only
2560 allow one). Instances where this may occur include accesses to member
2561 fields of struct variables imported from a DLL, as well as using a
2562 constant index into an array variable imported from a DLL. Any
2563 multiword variable (arrays, structs, long long, etc) may trigger
2564 this error condition. However, regardless of the exact data type
2565 of the offending exported variable, ld will always detect it, issue
2566 the warning, and exit.
2568 There are several ways to address this difficulty, regardless of the
2569 data type of the exported variable:
2571 One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task
2572 of adjusting references in your client code for runtime environment, so
2573 this method works only when runtime environment supports this feature.
2575 A second solution is to force one of the 'constants' to be a variable --
2576 that is, unknown and un-optimizable at compile time. For arrays,
2577 there are two possibilities: a) make the indexee (the array's address)
2578 a variable, or b) make the 'constant' index a variable. Thus:
2581 extern type extern_array[];
2583 @{ volatile type *t=extern_array; t[1] @}
2589 extern type extern_array[];
2591 @{ volatile int t=1; extern_array[t] @}
2594 For structs (and most other multiword data types) the only option
2595 is to make the struct itself (or the long long, or the ...) variable:
2598 extern struct s extern_struct;
2599 extern_struct.field -->
2600 @{ volatile struct s *t=&extern_struct; t->field @}
2606 extern long long extern_ll;
2608 @{ volatile long long * local_ll=&extern_ll; *local_ll @}
2611 A third method of dealing with this difficulty is to abandon
2612 'auto-import' for the offending symbol and mark it with
2613 @code{__declspec(dllimport)}. However, in practice that
2614 requires using compile-time #defines to indicate whether you are
2615 building a DLL, building client code that will link to the DLL, or
2616 merely building/linking to a static library. In making the choice
2617 between the various methods of resolving the 'direct address with
2618 constant offset' problem, you should consider typical real-world usage:
2626 void main(int argc, char **argv)@{
2627 printf("%d\n",arr[1]);
2637 void main(int argc, char **argv)@{
2638 /* This workaround is for win32 and cygwin; do not "optimize" */
2639 volatile int *parr = arr;
2640 printf("%d\n",parr[1]);
2647 /* Note: auto-export is assumed (no __declspec(dllexport)) */
2648 #if (defined(_WIN32) || defined(__CYGWIN__)) && \
2649 !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2650 #define FOO_IMPORT __declspec(dllimport)
2654 extern FOO_IMPORT int arr[];
2657 void main(int argc, char **argv)@{
2658 printf("%d\n",arr[1]);
2662 A fourth way to avoid this problem is to re-code your
2663 library to use a functional interface rather than a data interface
2664 for the offending variables (e.g. set_foo() and get_foo() accessor
2666 [This option is specific to the i386 PE targeted port of the linker]
2668 @kindex --disable-auto-import
2669 @item --disable-auto-import
2670 Do not attempt to do sophisticated linking of @code{_symbol} to
2671 @code{__imp__symbol} for DATA imports from DLLs.
2672 [This option is specific to the i386 PE targeted port of the linker]
2674 @kindex --enable-runtime-pseudo-reloc
2675 @item --enable-runtime-pseudo-reloc
2676 If your code contains expressions described in --enable-auto-import section,
2677 that is, DATA imports from DLL with non-zero offset, this switch will create
2678 a vector of 'runtime pseudo relocations' which can be used by runtime
2679 environment to adjust references to such data in your client code.
2680 [This option is specific to the i386 PE targeted port of the linker]
2682 @kindex --disable-runtime-pseudo-reloc
2683 @item --disable-runtime-pseudo-reloc
2684 Do not create pseudo relocations for non-zero offset DATA imports from
2686 [This option is specific to the i386 PE targeted port of the linker]
2688 @kindex --enable-extra-pe-debug
2689 @item --enable-extra-pe-debug
2690 Show additional debug info related to auto-import symbol thunking.
2691 [This option is specific to the i386 PE targeted port of the linker]
2693 @kindex --section-alignment
2694 @item --section-alignment
2695 Sets the section alignment. Sections in memory will always begin at
2696 addresses which are a multiple of this number. Defaults to 0x1000.
2697 [This option is specific to the i386 PE targeted port of the linker]
2701 @item --stack @var{reserve}
2702 @itemx --stack @var{reserve},@var{commit}
2703 Specify the number of bytes of memory to reserve (and optionally commit)
2704 to be used as stack for this program. The default is 2MB reserved, 4K
2706 [This option is specific to the i386 PE targeted port of the linker]
2709 @item --subsystem @var{which}
2710 @itemx --subsystem @var{which}:@var{major}
2711 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2712 Specifies the subsystem under which your program will execute. The
2713 legal values for @var{which} are @code{native}, @code{windows},
2714 @code{console}, @code{posix}, and @code{xbox}. You may optionally set
2715 the subsystem version also. Numeric values are also accepted for
2717 [This option is specific to the i386 PE targeted port of the linker]
2719 The following options set flags in the @code{DllCharacteristics} field
2720 of the PE file header:
2721 [These options are specific to PE targeted ports of the linker]
2723 @kindex --high-entropy-va
2724 @item --high-entropy-va
2725 Image is compatible with 64-bit address space layout randomization
2728 @kindex --dynamicbase
2730 The image base address may be relocated using address space layout
2731 randomization (ASLR). This feature was introduced with MS Windows
2732 Vista for i386 PE targets.
2734 @kindex --forceinteg
2736 Code integrity checks are enforced.
2740 The image is compatible with the Data Execution Prevention.
2741 This feature was introduced with MS Windows XP SP2 for i386 PE targets.
2743 @kindex --no-isolation
2744 @item --no-isolation
2745 Although the image understands isolation, do not isolate the image.
2749 The image does not use SEH. No SE handler may be called from
2754 Do not bind this image.
2758 The driver uses the MS Windows Driver Model.
2762 The image is Terminal Server aware.
2764 @kindex --insert-timestamp
2765 @item --insert-timestamp
2766 @itemx --no-insert-timestamp
2767 Insert a real timestamp into the image. This is the default behaviour
2768 as it matches legacy code and it means that the image will work with
2769 other, proprietary tools. The problem with this default is that it
2770 will result in slightly different images being produced each tiem the
2771 same sources are linked. The option @option{--no-insert-timestamp}
2772 can be used to insert a zero value for the timestamp, this ensuring
2773 that binaries produced from indentical sources will compare
2780 @subsection Options specific to C6X uClinux targets
2782 @c man begin OPTIONS
2784 The C6X uClinux target uses a binary format called DSBT to support shared
2785 libraries. Each shared library in the system needs to have a unique index;
2786 all executables use an index of 0.
2791 @item --dsbt-size @var{size}
2792 This option sets the number of entires in the DSBT of the current executable
2793 or shared library to @var{size}. The default is to create a table with 64
2796 @kindex --dsbt-index
2797 @item --dsbt-index @var{index}
2798 This option sets the DSBT index of the current executable or shared library
2799 to @var{index}. The default is 0, which is appropriate for generating
2800 executables. If a shared library is generated with a DSBT index of 0, the
2801 @code{R_C6000_DSBT_INDEX} relocs are copied into the output file.
2803 @kindex --no-merge-exidx-entries
2804 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent
2805 exidx entries in frame unwind info.
2813 @subsection Options specific to Motorola 68HC11 and 68HC12 targets
2815 @c man begin OPTIONS
2817 The 68HC11 and 68HC12 linkers support specific options to control the
2818 memory bank switching mapping and trampoline code generation.
2822 @kindex --no-trampoline
2823 @item --no-trampoline
2824 This option disables the generation of trampoline. By default a trampoline
2825 is generated for each far function which is called using a @code{jsr}
2826 instruction (this happens when a pointer to a far function is taken).
2828 @kindex --bank-window
2829 @item --bank-window @var{name}
2830 This option indicates to the linker the name of the memory region in
2831 the @samp{MEMORY} specification that describes the memory bank window.
2832 The definition of such region is then used by the linker to compute
2833 paging and addresses within the memory window.
2841 @subsection Options specific to Motorola 68K target
2843 @c man begin OPTIONS
2845 The following options are supported to control handling of GOT generation
2846 when linking for 68K targets.
2851 @item --got=@var{type}
2852 This option tells the linker which GOT generation scheme to use.
2853 @var{type} should be one of @samp{single}, @samp{negative},
2854 @samp{multigot} or @samp{target}. For more information refer to the
2855 Info entry for @file{ld}.
2863 @subsection Options specific to MIPS targets
2865 @c man begin OPTIONS
2867 The following options are supported to control microMIPS instruction
2868 generation when linking for MIPS targets.
2876 These options control the choice of microMIPS instructions used in code
2877 generated by the linker, such as that in the PLT or lazy binding stubs,
2878 or in relaxation. If @samp{--insn32} is used, then the linker only uses
2879 32-bit instruction encodings. By default or if @samp{--no-insn32} is
2880 used, all instruction encodings are used, including 16-bit ones where
2890 @section Environment Variables
2892 @c man begin ENVIRONMENT
2894 You can change the behaviour of @command{ld} with the environment variables
2895 @ifclear SingleFormat
2898 @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
2900 @ifclear SingleFormat
2902 @cindex default input format
2903 @code{GNUTARGET} determines the input-file object format if you don't
2904 use @samp{-b} (or its synonym @samp{--format}). Its value should be one
2905 of the BFD names for an input format (@pxref{BFD}). If there is no
2906 @code{GNUTARGET} in the environment, @command{ld} uses the natural format
2907 of the target. If @code{GNUTARGET} is set to @code{default} then BFD
2908 attempts to discover the input format by examining binary input files;
2909 this method often succeeds, but there are potential ambiguities, since
2910 there is no method of ensuring that the magic number used to specify
2911 object-file formats is unique. However, the configuration procedure for
2912 BFD on each system places the conventional format for that system first
2913 in the search-list, so ambiguities are resolved in favor of convention.
2917 @cindex default emulation
2918 @cindex emulation, default
2919 @code{LDEMULATION} determines the default emulation if you don't use the
2920 @samp{-m} option. The emulation can affect various aspects of linker
2921 behaviour, particularly the default linker script. You can list the
2922 available emulations with the @samp{--verbose} or @samp{-V} options. If
2923 the @samp{-m} option is not used, and the @code{LDEMULATION} environment
2924 variable is not defined, the default emulation depends upon how the
2925 linker was configured.
2927 @kindex COLLECT_NO_DEMANGLE
2928 @cindex demangling, default
2929 Normally, the linker will default to demangling symbols. However, if
2930 @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will
2931 default to not demangling symbols. This environment variable is used in
2932 a similar fashion by the @code{gcc} linker wrapper program. The default
2933 may be overridden by the @samp{--demangle} and @samp{--no-demangle}
2940 @chapter Linker Scripts
2943 @cindex linker scripts
2944 @cindex command files
2945 Every link is controlled by a @dfn{linker script}. This script is
2946 written in the linker command language.
2948 The main purpose of the linker script is to describe how the sections in
2949 the input files should be mapped into the output file, and to control
2950 the memory layout of the output file. Most linker scripts do nothing
2951 more than this. However, when necessary, the linker script can also
2952 direct the linker to perform many other operations, using the commands
2955 The linker always uses a linker script. If you do not supply one
2956 yourself, the linker will use a default script that is compiled into the
2957 linker executable. You can use the @samp{--verbose} command line option
2958 to display the default linker script. Certain command line options,
2959 such as @samp{-r} or @samp{-N}, will affect the default linker script.
2961 You may supply your own linker script by using the @samp{-T} command
2962 line option. When you do this, your linker script will replace the
2963 default linker script.
2965 You may also use linker scripts implicitly by naming them as input files
2966 to the linker, as though they were files to be linked. @xref{Implicit
2970 * Basic Script Concepts:: Basic Linker Script Concepts
2971 * Script Format:: Linker Script Format
2972 * Simple Example:: Simple Linker Script Example
2973 * Simple Commands:: Simple Linker Script Commands
2974 * Assignments:: Assigning Values to Symbols
2975 * SECTIONS:: SECTIONS Command
2976 * MEMORY:: MEMORY Command
2977 * PHDRS:: PHDRS Command
2978 * VERSION:: VERSION Command
2979 * Expressions:: Expressions in Linker Scripts
2980 * Implicit Linker Scripts:: Implicit Linker Scripts
2983 @node Basic Script Concepts
2984 @section Basic Linker Script Concepts
2985 @cindex linker script concepts
2986 We need to define some basic concepts and vocabulary in order to
2987 describe the linker script language.
2989 The linker combines input files into a single output file. The output
2990 file and each input file are in a special data format known as an
2991 @dfn{object file format}. Each file is called an @dfn{object file}.
2992 The output file is often called an @dfn{executable}, but for our
2993 purposes we will also call it an object file. Each object file has,
2994 among other things, a list of @dfn{sections}. We sometimes refer to a
2995 section in an input file as an @dfn{input section}; similarly, a section
2996 in the output file is an @dfn{output section}.
2998 Each section in an object file has a name and a size. Most sections
2999 also have an associated block of data, known as the @dfn{section
3000 contents}. A section may be marked as @dfn{loadable}, which means that
3001 the contents should be loaded into memory when the output file is run.
3002 A section with no contents may be @dfn{allocatable}, which means that an
3003 area in memory should be set aside, but nothing in particular should be
3004 loaded there (in some cases this memory must be zeroed out). A section
3005 which is neither loadable nor allocatable typically contains some sort
3006 of debugging information.
3008 Every loadable or allocatable output section has two addresses. The
3009 first is the @dfn{VMA}, or virtual memory address. This is the address
3010 the section will have when the output file is run. The second is the
3011 @dfn{LMA}, or load memory address. This is the address at which the
3012 section will be loaded. In most cases the two addresses will be the
3013 same. An example of when they might be different is when a data section
3014 is loaded into ROM, and then copied into RAM when the program starts up
3015 (this technique is often used to initialize global variables in a ROM
3016 based system). In this case the ROM address would be the LMA, and the
3017 RAM address would be the VMA.
3019 You can see the sections in an object file by using the @code{objdump}
3020 program with the @samp{-h} option.
3022 Every object file also has a list of @dfn{symbols}, known as the
3023 @dfn{symbol table}. A symbol may be defined or undefined. Each symbol
3024 has a name, and each defined symbol has an address, among other
3025 information. If you compile a C or C++ program into an object file, you
3026 will get a defined symbol for every defined function and global or
3027 static variable. Every undefined function or global variable which is
3028 referenced in the input file will become an undefined symbol.
3030 You can see the symbols in an object file by using the @code{nm}
3031 program, or by using the @code{objdump} program with the @samp{-t}
3035 @section Linker Script Format
3036 @cindex linker script format
3037 Linker scripts are text files.
3039 You write a linker script as a series of commands. Each command is
3040 either a keyword, possibly followed by arguments, or an assignment to a
3041 symbol. You may separate commands using semicolons. Whitespace is
3044 Strings such as file or format names can normally be entered directly.
3045 If the file name contains a character such as a comma which would
3046 otherwise serve to separate file names, you may put the file name in
3047 double quotes. There is no way to use a double quote character in a
3050 You may include comments in linker scripts just as in C, delimited by
3051 @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent
3054 @node Simple Example
3055 @section Simple Linker Script Example
3056 @cindex linker script example
3057 @cindex example of linker script
3058 Many linker scripts are fairly simple.
3060 The simplest possible linker script has just one command:
3061 @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the
3062 memory layout of the output file.
3064 The @samp{SECTIONS} command is a powerful command. Here we will
3065 describe a simple use of it. Let's assume your program consists only of
3066 code, initialized data, and uninitialized data. These will be in the
3067 @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively.
3068 Let's assume further that these are the only sections which appear in
3071 For this example, let's say that the code should be loaded at address
3072 0x10000, and that the data should start at address 0x8000000. Here is a
3073 linker script which will do that:
3078 .text : @{ *(.text) @}
3080 .data : @{ *(.data) @}
3081 .bss : @{ *(.bss) @}
3085 You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS},
3086 followed by a series of symbol assignments and output section
3087 descriptions enclosed in curly braces.
3089 The first line inside the @samp{SECTIONS} command of the above example
3090 sets the value of the special symbol @samp{.}, which is the location
3091 counter. If you do not specify the address of an output section in some
3092 other way (other ways are described later), the address is set from the
3093 current value of the location counter. The location counter is then
3094 incremented by the size of the output section. At the start of the
3095 @samp{SECTIONS} command, the location counter has the value @samp{0}.
3097 The second line defines an output section, @samp{.text}. The colon is
3098 required syntax which may be ignored for now. Within the curly braces
3099 after the output section name, you list the names of the input sections
3100 which should be placed into this output section. The @samp{*} is a
3101 wildcard which matches any file name. The expression @samp{*(.text)}
3102 means all @samp{.text} input sections in all input files.
3104 Since the location counter is @samp{0x10000} when the output section
3105 @samp{.text} is defined, the linker will set the address of the
3106 @samp{.text} section in the output file to be @samp{0x10000}.
3108 The remaining lines define the @samp{.data} and @samp{.bss} sections in
3109 the output file. The linker will place the @samp{.data} output section
3110 at address @samp{0x8000000}. After the linker places the @samp{.data}
3111 output section, the value of the location counter will be
3112 @samp{0x8000000} plus the size of the @samp{.data} output section. The
3113 effect is that the linker will place the @samp{.bss} output section
3114 immediately after the @samp{.data} output section in memory.
3116 The linker will ensure that each output section has the required
3117 alignment, by increasing the location counter if necessary. In this
3118 example, the specified addresses for the @samp{.text} and @samp{.data}
3119 sections will probably satisfy any alignment constraints, but the linker
3120 may have to create a small gap between the @samp{.data} and @samp{.bss}
3123 That's it! That's a simple and complete linker script.
3125 @node Simple Commands
3126 @section Simple Linker Script Commands
3127 @cindex linker script simple commands
3128 In this section we describe the simple linker script commands.
3131 * Entry Point:: Setting the entry point
3132 * File Commands:: Commands dealing with files
3133 @ifclear SingleFormat
3134 * Format Commands:: Commands dealing with object file formats
3137 * REGION_ALIAS:: Assign alias names to memory regions
3138 * Miscellaneous Commands:: Other linker script commands
3142 @subsection Setting the Entry Point
3143 @kindex ENTRY(@var{symbol})
3144 @cindex start of execution
3145 @cindex first instruction
3147 The first instruction to execute in a program is called the @dfn{entry
3148 point}. You can use the @code{ENTRY} linker script command to set the
3149 entry point. The argument is a symbol name:
3154 There are several ways to set the entry point. The linker will set the
3155 entry point by trying each of the following methods in order, and
3156 stopping when one of them succeeds:
3159 the @samp{-e} @var{entry} command-line option;
3161 the @code{ENTRY(@var{symbol})} command in a linker script;
3163 the value of a target specific symbol, if it is defined; For many
3164 targets this is @code{start}, but PE and BeOS based systems for example
3165 check a list of possible entry symbols, matching the first one found.
3167 the address of the first byte of the @samp{.text} section, if present;
3169 The address @code{0}.
3173 @subsection Commands Dealing with Files
3174 @cindex linker script file commands
3175 Several linker script commands deal with files.
3178 @item INCLUDE @var{filename}
3179 @kindex INCLUDE @var{filename}
3180 @cindex including a linker script
3181 Include the linker script @var{filename} at this point. The file will
3182 be searched for in the current directory, and in any directory specified
3183 with the @option{-L} option. You can nest calls to @code{INCLUDE} up to
3186 You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or
3187 @code{SECTIONS} commands, or in output section descriptions.
3189 @item INPUT(@var{file}, @var{file}, @dots{})
3190 @itemx INPUT(@var{file} @var{file} @dots{})
3191 @kindex INPUT(@var{files})
3192 @cindex input files in linker scripts
3193 @cindex input object files in linker scripts
3194 @cindex linker script input object files
3195 The @code{INPUT} command directs the linker to include the named files
3196 in the link, as though they were named on the command line.
3198 For example, if you always want to include @file{subr.o} any time you do
3199 a link, but you can't be bothered to put it on every link command line,
3200 then you can put @samp{INPUT (subr.o)} in your linker script.
3202 In fact, if you like, you can list all of your input files in the linker
3203 script, and then invoke the linker with nothing but a @samp{-T} option.
3205 In case a @dfn{sysroot prefix} is configured, and the filename starts
3206 with the @samp{/} character, and the script being processed was
3207 located inside the @dfn{sysroot prefix}, the filename will be looked
3208 for in the @dfn{sysroot prefix}. Otherwise, the linker will try to
3209 open the file in the current directory. If it is not found, the
3210 linker will search through the archive library search path.
3211 The @dfn{sysroot prefix} can also be forced by specifying @code{=}
3212 as the first character in the filename path. See also the
3213 description of @samp{-L} in @ref{Options,,Command Line Options}.
3215 If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the
3216 name to @code{lib@var{file}.a}, as with the command line argument
3219 When you use the @code{INPUT} command in an implicit linker script, the
3220 files will be included in the link at the point at which the linker
3221 script file is included. This can affect archive searching.
3223 @item GROUP(@var{file}, @var{file}, @dots{})
3224 @itemx GROUP(@var{file} @var{file} @dots{})
3225 @kindex GROUP(@var{files})
3226 @cindex grouping input files
3227 The @code{GROUP} command is like @code{INPUT}, except that the named
3228 files should all be archives, and they are searched repeatedly until no
3229 new undefined references are created. See the description of @samp{-(}
3230 in @ref{Options,,Command Line Options}.
3232 @item AS_NEEDED(@var{file}, @var{file}, @dots{})
3233 @itemx AS_NEEDED(@var{file} @var{file} @dots{})
3234 @kindex AS_NEEDED(@var{files})
3235 This construct can appear only inside of the @code{INPUT} or @code{GROUP}
3236 commands, among other filenames. The files listed will be handled
3237 as if they appear directly in the @code{INPUT} or @code{GROUP} commands,
3238 with the exception of ELF shared libraries, that will be added only
3239 when they are actually needed. This construct essentially enables
3240 @option{--as-needed} option for all the files listed inside of it
3241 and restores previous @option{--as-needed} resp. @option{--no-as-needed}
3244 @item OUTPUT(@var{filename})
3245 @kindex OUTPUT(@var{filename})
3246 @cindex output file name in linker script
3247 The @code{OUTPUT} command names the output file. Using
3248 @code{OUTPUT(@var{filename})} in the linker script is exactly like using
3249 @samp{-o @var{filename}} on the command line (@pxref{Options,,Command
3250 Line Options}). If both are used, the command line option takes
3253 You can use the @code{OUTPUT} command to define a default name for the
3254 output file other than the usual default of @file{a.out}.
3256 @item SEARCH_DIR(@var{path})
3257 @kindex SEARCH_DIR(@var{path})
3258 @cindex library search path in linker script
3259 @cindex archive search path in linker script
3260 @cindex search path in linker script
3261 The @code{SEARCH_DIR} command adds @var{path} to the list of paths where
3262 @command{ld} looks for archive libraries. Using
3263 @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}}
3264 on the command line (@pxref{Options,,Command Line Options}). If both
3265 are used, then the linker will search both paths. Paths specified using
3266 the command line option are searched first.
3268 @item STARTUP(@var{filename})
3269 @kindex STARTUP(@var{filename})
3270 @cindex first input file
3271 The @code{STARTUP} command is just like the @code{INPUT} command, except
3272 that @var{filename} will become the first input file to be linked, as
3273 though it were specified first on the command line. This may be useful
3274 when using a system in which the entry point is always the start of the
3278 @ifclear SingleFormat
3279 @node Format Commands
3280 @subsection Commands Dealing with Object File Formats
3281 A couple of linker script commands deal with object file formats.
3284 @item OUTPUT_FORMAT(@var{bfdname})
3285 @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little})
3286 @kindex OUTPUT_FORMAT(@var{bfdname})
3287 @cindex output file format in linker script
3288 The @code{OUTPUT_FORMAT} command names the BFD format to use for the
3289 output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is
3290 exactly like using @samp{--oformat @var{bfdname}} on the command line
3291 (@pxref{Options,,Command Line Options}). If both are used, the command
3292 line option takes precedence.
3294 You can use @code{OUTPUT_FORMAT} with three arguments to use different
3295 formats based on the @samp{-EB} and @samp{-EL} command line options.
3296 This permits the linker script to set the output format based on the
3299 If neither @samp{-EB} nor @samp{-EL} are used, then the output format
3300 will be the first argument, @var{default}. If @samp{-EB} is used, the
3301 output format will be the second argument, @var{big}. If @samp{-EL} is
3302 used, the output format will be the third argument, @var{little}.
3304 For example, the default linker script for the MIPS ELF target uses this
3307 OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
3309 This says that the default format for the output file is
3310 @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line
3311 option, the output file will be created in the @samp{elf32-littlemips}
3314 @item TARGET(@var{bfdname})
3315 @kindex TARGET(@var{bfdname})
3316 @cindex input file format in linker script
3317 The @code{TARGET} command names the BFD format to use when reading input
3318 files. It affects subsequent @code{INPUT} and @code{GROUP} commands.
3319 This command is like using @samp{-b @var{bfdname}} on the command line
3320 (@pxref{Options,,Command Line Options}). If the @code{TARGET} command
3321 is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET}
3322 command is also used to set the format for the output file. @xref{BFD}.
3327 @subsection Assign alias names to memory regions
3328 @kindex REGION_ALIAS(@var{alias}, @var{region})
3329 @cindex region alias
3330 @cindex region names
3332 Alias names can be added to existing memory regions created with the
3333 @ref{MEMORY} command. Each name corresponds to at most one memory region.
3336 REGION_ALIAS(@var{alias}, @var{region})
3339 The @code{REGION_ALIAS} function creates an alias name @var{alias} for the
3340 memory region @var{region}. This allows a flexible mapping of output sections
3341 to memory regions. An example follows.
3343 Suppose we have an application for embedded systems which come with various
3344 memory storage devices. All have a general purpose, volatile memory @code{RAM}
3345 that allows code execution or data storage. Some may have a read-only,
3346 non-volatile memory @code{ROM} that allows code execution and read-only data
3347 access. The last variant is a read-only, non-volatile memory @code{ROM2} with
3348 read-only data access and no code execution capability. We have four output
3353 @code{.text} program code;
3355 @code{.rodata} read-only data;
3357 @code{.data} read-write initialized data;
3359 @code{.bss} read-write zero initialized data.
3362 The goal is to provide a linker command file that contains a system independent
3363 part defining the output sections and a system dependent part mapping the
3364 output sections to the memory regions available on the system. Our embedded
3365 systems come with three different memory setups @code{A}, @code{B} and
3367 @multitable @columnfractions .25 .25 .25 .25
3368 @item Section @tab Variant A @tab Variant B @tab Variant C
3369 @item .text @tab RAM @tab ROM @tab ROM
3370 @item .rodata @tab RAM @tab ROM @tab ROM2
3371 @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2
3372 @item .bss @tab RAM @tab RAM @tab RAM
3374 The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is
3375 loaded into region @code{ROM} or @code{ROM2} respectively. Please note that
3376 the load address of the @code{.data} section starts in all three variants at
3377 the end of the @code{.rodata} section.
3379 The base linker script that deals with the output sections follows. It
3380 includes the system dependent @code{linkcmds.memory} file that describes the
3383 INCLUDE linkcmds.memory
3396 .data : AT (rodata_end)
3401 data_size = SIZEOF(.data);
3402 data_load_start = LOADADDR(.data);
3410 Now we need three different @code{linkcmds.memory} files to define memory
3411 regions and alias names. The content of @code{linkcmds.memory} for the three
3412 variants @code{A}, @code{B} and @code{C}:
3415 Here everything goes into the @code{RAM}.
3419 RAM : ORIGIN = 0, LENGTH = 4M
3422 REGION_ALIAS("REGION_TEXT", RAM);
3423 REGION_ALIAS("REGION_RODATA", RAM);
3424 REGION_ALIAS("REGION_DATA", RAM);
3425 REGION_ALIAS("REGION_BSS", RAM);
3428 Program code and read-only data go into the @code{ROM}. Read-write data goes
3429 into the @code{RAM}. An image of the initialized data is loaded into the
3430 @code{ROM} and will be copied during system start into the @code{RAM}.
3434 ROM : ORIGIN = 0, LENGTH = 3M
3435 RAM : ORIGIN = 0x10000000, LENGTH = 1M
3438 REGION_ALIAS("REGION_TEXT", ROM);
3439 REGION_ALIAS("REGION_RODATA", ROM);
3440 REGION_ALIAS("REGION_DATA", RAM);
3441 REGION_ALIAS("REGION_BSS", RAM);
3444 Program code goes into the @code{ROM}. Read-only data goes into the
3445 @code{ROM2}. Read-write data goes into the @code{RAM}. An image of the
3446 initialized data is loaded into the @code{ROM2} and will be copied during
3447 system start into the @code{RAM}.
3451 ROM : ORIGIN = 0, LENGTH = 2M
3452 ROM2 : ORIGIN = 0x10000000, LENGTH = 1M
3453 RAM : ORIGIN = 0x20000000, LENGTH = 1M
3456 REGION_ALIAS("REGION_TEXT", ROM);
3457 REGION_ALIAS("REGION_RODATA", ROM2);
3458 REGION_ALIAS("REGION_DATA", RAM);
3459 REGION_ALIAS("REGION_BSS", RAM);
3463 It is possible to write a common system initialization routine to copy the
3464 @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if
3469 extern char data_start [];
3470 extern char data_size [];
3471 extern char data_load_start [];
3473 void copy_data(void)
3475 if (data_start != data_load_start)
3477 memcpy(data_start, data_load_start, (size_t) data_size);
3482 @node Miscellaneous Commands
3483 @subsection Other Linker Script Commands
3484 There are a few other linker scripts commands.
3487 @item ASSERT(@var{exp}, @var{message})
3489 @cindex assertion in linker script
3490 Ensure that @var{exp} is non-zero. If it is zero, then exit the linker
3491 with an error code, and print @var{message}.
3493 Note that assertions are checked before the final stages of linking
3494 take place. This means that expressions involving symbols PROVIDEd
3495 inside section definitions will fail if the user has not set values
3496 for those symbols. The only exception to this rule is PROVIDEd
3497 symbols that just reference dot. Thus an assertion like this:
3502 PROVIDE (__stack = .);
3503 PROVIDE (__stack_size = 0x100);
3504 ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack");
3508 will fail if @code{__stack_size} is not defined elsewhere. Symbols
3509 PROVIDEd outside of section definitions are evaluated earlier, so they
3510 can be used inside ASSERTions. Thus:
3513 PROVIDE (__stack_size = 0x100);
3516 PROVIDE (__stack = .);
3517 ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack");
3523 @item EXTERN(@var{symbol} @var{symbol} @dots{})
3525 @cindex undefined symbol in linker script
3526 Force @var{symbol} to be entered in the output file as an undefined
3527 symbol. Doing this may, for example, trigger linking of additional
3528 modules from standard libraries. You may list several @var{symbol}s for
3529 each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This
3530 command has the same effect as the @samp{-u} command-line option.
3532 @item FORCE_COMMON_ALLOCATION
3533 @kindex FORCE_COMMON_ALLOCATION
3534 @cindex common allocation in linker script
3535 This command has the same effect as the @samp{-d} command-line option:
3536 to make @command{ld} assign space to common symbols even if a relocatable
3537 output file is specified (@samp{-r}).
3539 @item INHIBIT_COMMON_ALLOCATION
3540 @kindex INHIBIT_COMMON_ALLOCATION
3541 @cindex common allocation in linker script
3542 This command has the same effect as the @samp{--no-define-common}
3543 command-line option: to make @code{ld} omit the assignment of addresses
3544 to common symbols even for a non-relocatable output file.
3546 @item INSERT [ AFTER | BEFORE ] @var{output_section}
3548 @cindex insert user script into default script
3549 This command is typically used in a script specified by @samp{-T} to
3550 augment the default @code{SECTIONS} with, for example, overlays. It
3551 inserts all prior linker script statements after (or before)
3552 @var{output_section}, and also causes @samp{-T} to not override the
3553 default linker script. The exact insertion point is as for orphan
3554 sections. @xref{Location Counter}. The insertion happens after the
3555 linker has mapped input sections to output sections. Prior to the
3556 insertion, since @samp{-T} scripts are parsed before the default
3557 linker script, statements in the @samp{-T} script occur before the
3558 default linker script statements in the internal linker representation
3559 of the script. In particular, input section assignments will be made
3560 to @samp{-T} output sections before those in the default script. Here
3561 is an example of how a @samp{-T} script using @code{INSERT} might look:
3568 .ov1 @{ ov1*(.text) @}
3569 .ov2 @{ ov2*(.text) @}
3575 @item NOCROSSREFS(@var{section} @var{section} @dots{})
3576 @kindex NOCROSSREFS(@var{sections})
3577 @cindex cross references
3578 This command may be used to tell @command{ld} to issue an error about any
3579 references among certain output sections.
3581 In certain types of programs, particularly on embedded systems when
3582 using overlays, when one section is loaded into memory, another section
3583 will not be. Any direct references between the two sections would be
3584 errors. For example, it would be an error if code in one section called
3585 a function defined in the other section.
3587 The @code{NOCROSSREFS} command takes a list of output section names. If
3588 @command{ld} detects any cross references between the sections, it reports
3589 an error and returns a non-zero exit status. Note that the
3590 @code{NOCROSSREFS} command uses output section names, not input section
3593 @ifclear SingleFormat
3594 @item OUTPUT_ARCH(@var{bfdarch})
3595 @kindex OUTPUT_ARCH(@var{bfdarch})
3596 @cindex machine architecture
3597 @cindex architecture
3598 Specify a particular output machine architecture. The argument is one
3599 of the names used by the BFD library (@pxref{BFD}). You can see the
3600 architecture of an object file by using the @code{objdump} program with
3601 the @samp{-f} option.
3604 @item LD_FEATURE(@var{string})
3605 @kindex LD_FEATURE(@var{string})
3606 This command may be used to modify @command{ld} behavior. If
3607 @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers
3608 in a script are simply treated as numbers everywhere.
3609 @xref{Expression Section}.
3613 @section Assigning Values to Symbols
3614 @cindex assignment in scripts
3615 @cindex symbol definition, scripts
3616 @cindex variables, defining
3617 You may assign a value to a symbol in a linker script. This will define
3618 the symbol and place it into the symbol table with a global scope.
3621 * Simple Assignments:: Simple Assignments
3624 * PROVIDE_HIDDEN:: PROVIDE_HIDDEN
3625 * Source Code Reference:: How to use a linker script defined symbol in source code
3628 @node Simple Assignments
3629 @subsection Simple Assignments
3631 You may assign to a symbol using any of the C assignment operators:
3634 @item @var{symbol} = @var{expression} ;
3635 @itemx @var{symbol} += @var{expression} ;
3636 @itemx @var{symbol} -= @var{expression} ;
3637 @itemx @var{symbol} *= @var{expression} ;
3638 @itemx @var{symbol} /= @var{expression} ;
3639 @itemx @var{symbol} <<= @var{expression} ;
3640 @itemx @var{symbol} >>= @var{expression} ;
3641 @itemx @var{symbol} &= @var{expression} ;
3642 @itemx @var{symbol} |= @var{expression} ;
3645 The first case will define @var{symbol} to the value of
3646 @var{expression}. In the other cases, @var{symbol} must already be
3647 defined, and the value will be adjusted accordingly.
3649 The special symbol name @samp{.} indicates the location counter. You
3650 may only use this within a @code{SECTIONS} command. @xref{Location Counter}.
3652 The semicolon after @var{expression} is required.
3654 Expressions are defined below; see @ref{Expressions}.
3656 You may write symbol assignments as commands in their own right, or as
3657 statements within a @code{SECTIONS} command, or as part of an output
3658 section description in a @code{SECTIONS} command.
3660 The section of the symbol will be set from the section of the
3661 expression; for more information, see @ref{Expression Section}.
3663 Here is an example showing the three different places that symbol
3664 assignments may be used:
3675 _bdata = (. + 3) & ~ 3;
3676 .data : @{ *(.data) @}
3680 In this example, the symbol @samp{floating_point} will be defined as
3681 zero. The symbol @samp{_etext} will be defined as the address following
3682 the last @samp{.text} input section. The symbol @samp{_bdata} will be
3683 defined as the address following the @samp{.text} output section aligned
3684 upward to a 4 byte boundary.
3689 For ELF targeted ports, define a symbol that will be hidden and won't be
3690 exported. The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}.
3692 Here is the example from @ref{Simple Assignments}, rewritten to use
3696 HIDDEN(floating_point = 0);
3704 HIDDEN(_bdata = (. + 3) & ~ 3);
3705 .data : @{ *(.data) @}
3709 In this case none of the three symbols will be visible outside this module.
3714 In some cases, it is desirable for a linker script to define a symbol
3715 only if it is referenced and is not defined by any object included in
3716 the link. For example, traditional linkers defined the symbol
3717 @samp{etext}. However, ANSI C requires that the user be able to use
3718 @samp{etext} as a function name without encountering an error. The
3719 @code{PROVIDE} keyword may be used to define a symbol, such as
3720 @samp{etext}, only if it is referenced but not defined. The syntax is
3721 @code{PROVIDE(@var{symbol} = @var{expression})}.
3723 Here is an example of using @code{PROVIDE} to define @samp{etext}:
3736 In this example, if the program defines @samp{_etext} (with a leading
3737 underscore), the linker will give a multiple definition error. If, on
3738 the other hand, the program defines @samp{etext} (with no leading
3739 underscore), the linker will silently use the definition in the program.
3740 If the program references @samp{etext} but does not define it, the
3741 linker will use the definition in the linker script.
3743 @node PROVIDE_HIDDEN
3744 @subsection PROVIDE_HIDDEN
3745 @cindex PROVIDE_HIDDEN
3746 Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be
3747 hidden and won't be exported.
3749 @node Source Code Reference
3750 @subsection Source Code Reference
3752 Accessing a linker script defined variable from source code is not
3753 intuitive. In particular a linker script symbol is not equivalent to
3754 a variable declaration in a high level language, it is instead a
3755 symbol that does not have a value.
3757 Before going further, it is important to note that compilers often
3758 transform names in the source code into different names when they are
3759 stored in the symbol table. For example, Fortran compilers commonly
3760 prepend or append an underscore, and C++ performs extensive @samp{name
3761 mangling}. Therefore there might be a discrepancy between the name
3762 of a variable as it is used in source code and the name of the same
3763 variable as it is defined in a linker script. For example in C a
3764 linker script variable might be referred to as:
3770 But in the linker script it might be defined as:
3776 In the remaining examples however it is assumed that no name
3777 transformation has taken place.
3779 When a symbol is declared in a high level language such as C, two
3780 things happen. The first is that the compiler reserves enough space
3781 in the program's memory to hold the @emph{value} of the symbol. The
3782 second is that the compiler creates an entry in the program's symbol
3783 table which holds the symbol's @emph{address}. ie the symbol table
3784 contains the address of the block of memory holding the symbol's
3785 value. So for example the following C declaration, at file scope:
3791 creates an entry called @samp{foo} in the symbol table. This entry
3792 holds the address of an @samp{int} sized block of memory where the
3793 number 1000 is initially stored.
3795 When a program references a symbol the compiler generates code that
3796 first accesses the symbol table to find the address of the symbol's
3797 memory block and then code to read the value from that memory block.
3804 looks up the symbol @samp{foo} in the symbol table, gets the address
3805 associated with this symbol and then writes the value 1 into that
3812 looks up the symbol @samp{foo} in the symbol table, gets its address
3813 and then copies this address into the block of memory associated with
3814 the variable @samp{a}.
3816 Linker scripts symbol declarations, by contrast, create an entry in
3817 the symbol table but do not assign any memory to them. Thus they are
3818 an address without a value. So for example the linker script definition:
3824 creates an entry in the symbol table called @samp{foo} which holds
3825 the address of memory location 1000, but nothing special is stored at
3826 address 1000. This means that you cannot access the @emph{value} of a
3827 linker script defined symbol - it has no value - all you can do is
3828 access the @emph{address} of a linker script defined symbol.
3830 Hence when you are using a linker script defined symbol in source code
3831 you should always take the address of the symbol, and never attempt to
3832 use its value. For example suppose you want to copy the contents of a
3833 section of memory called .ROM into a section called .FLASH and the
3834 linker script contains these declarations:
3838 start_of_ROM = .ROM;
3839 end_of_ROM = .ROM + sizeof (.ROM) - 1;
3840 start_of_FLASH = .FLASH;
3844 Then the C source code to perform the copy would be:
3848 extern char start_of_ROM, end_of_ROM, start_of_FLASH;
3850 memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
3854 Note the use of the @samp{&} operators. These are correct.
3857 @section SECTIONS Command
3859 The @code{SECTIONS} command tells the linker how to map input sections
3860 into output sections, and how to place the output sections in memory.
3862 The format of the @code{SECTIONS} command is:
3866 @var{sections-command}
3867 @var{sections-command}
3872 Each @var{sections-command} may of be one of the following:
3876 an @code{ENTRY} command (@pxref{Entry Point,,Entry command})
3878 a symbol assignment (@pxref{Assignments})
3880 an output section description
3882 an overlay description
3885 The @code{ENTRY} command and symbol assignments are permitted inside the
3886 @code{SECTIONS} command for convenience in using the location counter in
3887 those commands. This can also make the linker script easier to
3888 understand because you can use those commands at meaningful points in
3889 the layout of the output file.
3891 Output section descriptions and overlay descriptions are described
3894 If you do not use a @code{SECTIONS} command in your linker script, the
3895 linker will place each input section into an identically named output
3896 section in the order that the sections are first encountered in the
3897 input files. If all input sections are present in the first file, for
3898 example, the order of sections in the output file will match the order
3899 in the first input file. The first section will be at address zero.
3902 * Output Section Description:: Output section description
3903 * Output Section Name:: Output section name
3904 * Output Section Address:: Output section address
3905 * Input Section:: Input section description
3906 * Output Section Data:: Output section data
3907 * Output Section Keywords:: Output section keywords
3908 * Output Section Discarding:: Output section discarding
3909 * Output Section Attributes:: Output section attributes
3910 * Overlay Description:: Overlay description
3913 @node Output Section Description
3914 @subsection Output Section Description
3915 The full description of an output section looks like this:
3918 @var{section} [@var{address}] [(@var{type})] :
3920 [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT]
3921 [SUBALIGN(@var{subsection_align})]
3924 @var{output-section-command}
3925 @var{output-section-command}
3927 @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] [,]
3931 Most output sections do not use most of the optional section attributes.
3933 The whitespace around @var{section} is required, so that the section
3934 name is unambiguous. The colon and the curly braces are also required.
3935 The comma at the end may be required if a @var{fillexp} is used and
3936 the next @var{sections-command} looks like a continuation of the expression.
3937 The line breaks and other white space are optional.
3939 Each @var{output-section-command} may be one of the following:
3943 a symbol assignment (@pxref{Assignments})
3945 an input section description (@pxref{Input Section})
3947 data values to include directly (@pxref{Output Section Data})
3949 a special output section keyword (@pxref{Output Section Keywords})
3952 @node Output Section Name
3953 @subsection Output Section Name
3954 @cindex name, section
3955 @cindex section name
3956 The name of the output section is @var{section}. @var{section} must
3957 meet the constraints of your output format. In formats which only
3958 support a limited number of sections, such as @code{a.out}, the name
3959 must be one of the names supported by the format (@code{a.out}, for
3960 example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the
3961 output format supports any number of sections, but with numbers and not
3962 names (as is the case for Oasys), the name should be supplied as a
3963 quoted numeric string. A section name may consist of any sequence of
3964 characters, but a name which contains any unusual characters such as
3965 commas must be quoted.
3967 The output section name @samp{/DISCARD/} is special; @ref{Output Section
3970 @node Output Section Address
3971 @subsection Output Section Address
3972 @cindex address, section
3973 @cindex section address
3974 The @var{address} is an expression for the VMA (the virtual memory
3975 address) of the output section. This address is optional, but if it
3976 is provided then the output address will be set exactly as specified.
3978 If the output address is not specified then one will be chosen for the
3979 section, based on the heuristic below. This address will be adjusted
3980 to fit the alignment requirement of the output section. The
3981 alignment requirement is the strictest alignment of any input section
3982 contained within the output section.
3984 The output section address heuristic is as follows:
3988 If an output memory @var{region} is set for the section then it
3989 is added to this region and its address will be the next free address
3993 If the MEMORY command has been used to create a list of memory
3994 regions then the first region which has attributes compatible with the
3995 section is selected to contain it. The section's output address will
3996 be the next free address in that region; @ref{MEMORY}.
3999 If no memory regions were specified, or none match the section then
4000 the output address will be based on the current value of the location
4008 .text . : @{ *(.text) @}
4015 .text : @{ *(.text) @}
4019 are subtly different. The first will set the address of the
4020 @samp{.text} output section to the current value of the location
4021 counter. The second will set it to the current value of the location
4022 counter aligned to the strictest alignment of any of the @samp{.text}
4025 The @var{address} may be an arbitrary expression; @ref{Expressions}.
4026 For example, if you want to align the section on a 0x10 byte boundary,
4027 so that the lowest four bits of the section address are zero, you could
4028 do something like this:
4030 .text ALIGN(0x10) : @{ *(.text) @}
4033 This works because @code{ALIGN} returns the current location counter
4034 aligned upward to the specified value.
4036 Specifying @var{address} for a section will change the value of the
4037 location counter, provided that the section is non-empty. (Empty
4038 sections are ignored).
4041 @subsection Input Section Description
4042 @cindex input sections
4043 @cindex mapping input sections to output sections
4044 The most common output section command is an input section description.
4046 The input section description is the most basic linker script operation.
4047 You use output sections to tell the linker how to lay out your program
4048 in memory. You use input section descriptions to tell the linker how to
4049 map the input files into your memory layout.
4052 * Input Section Basics:: Input section basics
4053 * Input Section Wildcards:: Input section wildcard patterns
4054 * Input Section Common:: Input section for common symbols
4055 * Input Section Keep:: Input section and garbage collection
4056 * Input Section Example:: Input section example
4059 @node Input Section Basics
4060 @subsubsection Input Section Basics
4061 @cindex input section basics
4062 An input section description consists of a file name optionally followed
4063 by a list of section names in parentheses.
4065 The file name and the section name may be wildcard patterns, which we
4066 describe further below (@pxref{Input Section Wildcards}).
4068 The most common input section description is to include all input
4069 sections with a particular name in the output section. For example, to
4070 include all input @samp{.text} sections, you would write:
4075 Here the @samp{*} is a wildcard which matches any file name. To exclude a list
4076 of files from matching the file name wildcard, EXCLUDE_FILE may be used to
4077 match all files except the ones specified in the EXCLUDE_FILE list. For
4080 *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)
4082 will cause all .ctors sections from all files except @file{crtend.o} and
4083 @file{otherfile.o} to be included.
4085 There are two ways to include more than one section:
4091 The difference between these is the order in which the @samp{.text} and
4092 @samp{.rdata} input sections will appear in the output section. In the
4093 first example, they will be intermingled, appearing in the same order as
4094 they are found in the linker input. In the second example, all
4095 @samp{.text} input sections will appear first, followed by all
4096 @samp{.rdata} input sections.
4098 You can specify a file name to include sections from a particular file.
4099 You would do this if one or more of your files contain special data that
4100 needs to be at a particular location in memory. For example:
4105 To refine the sections that are included based on the section flags
4106 of an input section, INPUT_SECTION_FLAGS may be used.
4108 Here is a simple example for using Section header flags for ELF sections:
4113 .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @}
4114 .text2 : @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @}
4119 In this example, the output section @samp{.text} will be comprised of any
4120 input section matching the name *(.text) whose section header flags
4121 @code{SHF_MERGE} and @code{SHF_STRINGS} are set. The output section
4122 @samp{.text2} will be comprised of any input section matching the name *(.text)
4123 whose section header flag @code{SHF_WRITE} is clear.
4125 You can also specify files within archives by writing a pattern
4126 matching the archive, a colon, then the pattern matching the file,
4127 with no whitespace around the colon.
4131 matches file within archive
4133 matches the whole archive
4135 matches file but not one in an archive
4138 Either one or both of @samp{archive} and @samp{file} can contain shell
4139 wildcards. On DOS based file systems, the linker will assume that a
4140 single letter followed by a colon is a drive specifier, so
4141 @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o}
4142 within an archive called @samp{c}. @samp{archive:file} filespecs may
4143 also be used within an @code{EXCLUDE_FILE} list, but may not appear in
4144 other linker script contexts. For instance, you cannot extract a file
4145 from an archive by using @samp{archive:file} in an @code{INPUT}
4148 If you use a file name without a list of sections, then all sections in
4149 the input file will be included in the output section. This is not
4150 commonly done, but it may by useful on occasion. For example:
4155 When you use a file name which is not an @samp{archive:file} specifier
4156 and does not contain any wild card
4157 characters, the linker will first see if you also specified the file
4158 name on the linker command line or in an @code{INPUT} command. If you
4159 did not, the linker will attempt to open the file as an input file, as
4160 though it appeared on the command line. Note that this differs from an
4161 @code{INPUT} command, because the linker will not search for the file in
4162 the archive search path.
4164 @node Input Section Wildcards
4165 @subsubsection Input Section Wildcard Patterns
4166 @cindex input section wildcards
4167 @cindex wildcard file name patterns
4168 @cindex file name wildcard patterns
4169 @cindex section name wildcard patterns
4170 In an input section description, either the file name or the section
4171 name or both may be wildcard patterns.
4173 The file name of @samp{*} seen in many examples is a simple wildcard
4174 pattern for the file name.
4176 The wildcard patterns are like those used by the Unix shell.
4180 matches any number of characters
4182 matches any single character
4184 matches a single instance of any of the @var{chars}; the @samp{-}
4185 character may be used to specify a range of characters, as in
4186 @samp{[a-z]} to match any lower case letter
4188 quotes the following character
4191 When a file name is matched with a wildcard, the wildcard characters
4192 will not match a @samp{/} character (used to separate directory names on
4193 Unix). A pattern consisting of a single @samp{*} character is an
4194 exception; it will always match any file name, whether it contains a
4195 @samp{/} or not. In a section name, the wildcard characters will match
4196 a @samp{/} character.
4198 File name wildcard patterns only match files which are explicitly
4199 specified on the command line or in an @code{INPUT} command. The linker
4200 does not search directories to expand wildcards.
4202 If a file name matches more than one wildcard pattern, or if a file name
4203 appears explicitly and is also matched by a wildcard pattern, the linker
4204 will use the first match in the linker script. For example, this
4205 sequence of input section descriptions is probably in error, because the
4206 @file{data.o} rule will not be used:
4208 .data : @{ *(.data) @}
4209 .data1 : @{ data.o(.data) @}
4212 @cindex SORT_BY_NAME
4213 Normally, the linker will place files and sections matched by wildcards
4214 in the order in which they are seen during the link. You can change
4215 this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard
4216 pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the
4217 @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections
4218 into ascending order by name before placing them in the output file.
4220 @cindex SORT_BY_ALIGNMENT
4221 @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The
4222 difference is @code{SORT_BY_ALIGNMENT} will sort sections into
4223 descending order by alignment before placing them in the output file.
4224 Larger alignments are placed before smaller alignments in order to
4225 reduce the amount of padding necessary.
4227 @cindex SORT_BY_INIT_PRIORITY
4228 @code{SORT_BY_INIT_PRIORITY} is very similar to @code{SORT_BY_NAME}. The
4229 difference is @code{SORT_BY_INIT_PRIORITY} will sort sections into
4230 ascending order by numerical value of the GCC init_priority attribute
4231 encoded in the section name before placing them in the output file.
4234 @code{SORT} is an alias for @code{SORT_BY_NAME}.
4236 When there are nested section sorting commands in linker script, there
4237 can be at most 1 level of nesting for section sorting commands.
4241 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4242 It will sort the input sections by name first, then by alignment if two
4243 sections have the same name.
4245 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4246 It will sort the input sections by alignment first, then by name if two
4247 sections have the same alignment.
4249 @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is
4250 treated the same as @code{SORT_BY_NAME} (wildcard section pattern).
4252 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern))
4253 is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern).
4255 All other nested section sorting commands are invalid.
4258 When both command line section sorting option and linker script
4259 section sorting command are used, section sorting command always
4260 takes precedence over the command line option.
4262 If the section sorting command in linker script isn't nested, the
4263 command line option will make the section sorting command to be
4264 treated as nested sorting command.
4268 @code{SORT_BY_NAME} (wildcard section pattern ) with
4269 @option{--sort-sections alignment} is equivalent to
4270 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4272 @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with
4273 @option{--sort-section name} is equivalent to
4274 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4277 If the section sorting command in linker script is nested, the
4278 command line option will be ignored.
4281 @code{SORT_NONE} disables section sorting by ignoring the command line
4282 section sorting option.
4284 If you ever get confused about where input sections are going, use the
4285 @samp{-M} linker option to generate a map file. The map file shows
4286 precisely how input sections are mapped to output sections.
4288 This example shows how wildcard patterns might be used to partition
4289 files. This linker script directs the linker to place all @samp{.text}
4290 sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}.
4291 The linker will place the @samp{.data} section from all files beginning
4292 with an upper case character in @samp{.DATA}; for all other files, the
4293 linker will place the @samp{.data} section in @samp{.data}.
4297 .text : @{ *(.text) @}
4298 .DATA : @{ [A-Z]*(.data) @}
4299 .data : @{ *(.data) @}
4300 .bss : @{ *(.bss) @}
4305 @node Input Section Common
4306 @subsubsection Input Section for Common Symbols
4307 @cindex common symbol placement
4308 @cindex uninitialized data placement
4309 A special notation is needed for common symbols, because in many object
4310 file formats common symbols do not have a particular input section. The
4311 linker treats common symbols as though they are in an input section
4312 named @samp{COMMON}.
4314 You may use file names with the @samp{COMMON} section just as with any
4315 other input sections. You can use this to place common symbols from a
4316 particular input file in one section while common symbols from other
4317 input files are placed in another section.
4319 In most cases, common symbols in input files will be placed in the
4320 @samp{.bss} section in the output file. For example:
4322 .bss @{ *(.bss) *(COMMON) @}
4325 @cindex scommon section
4326 @cindex small common symbols
4327 Some object file formats have more than one type of common symbol. For
4328 example, the MIPS ELF object file format distinguishes standard common
4329 symbols and small common symbols. In this case, the linker will use a
4330 different special section name for other types of common symbols. In
4331 the case of MIPS ELF, the linker uses @samp{COMMON} for standard common
4332 symbols and @samp{.scommon} for small common symbols. This permits you
4333 to map the different types of common symbols into memory at different
4337 You will sometimes see @samp{[COMMON]} in old linker scripts. This
4338 notation is now considered obsolete. It is equivalent to
4341 @node Input Section Keep
4342 @subsubsection Input Section and Garbage Collection
4344 @cindex garbage collection
4345 When link-time garbage collection is in use (@samp{--gc-sections}),
4346 it is often useful to mark sections that should not be eliminated.
4347 This is accomplished by surrounding an input section's wildcard entry
4348 with @code{KEEP()}, as in @code{KEEP(*(.init))} or
4349 @code{KEEP(SORT_BY_NAME(*)(.ctors))}.
4351 @node Input Section Example
4352 @subsubsection Input Section Example
4353 The following example is a complete linker script. It tells the linker
4354 to read all of the sections from file @file{all.o} and place them at the
4355 start of output section @samp{outputa} which starts at location
4356 @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o}
4357 follows immediately, in the same output section. All of section
4358 @samp{.input2} from @file{foo.o} goes into output section
4359 @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}.
4360 All of the remaining @samp{.input1} and @samp{.input2} sections from any
4361 files are written to output section @samp{outputc}.
4389 @node Output Section Data
4390 @subsection Output Section Data
4392 @cindex section data
4393 @cindex output section data
4394 @kindex BYTE(@var{expression})
4395 @kindex SHORT(@var{expression})
4396 @kindex LONG(@var{expression})
4397 @kindex QUAD(@var{expression})
4398 @kindex SQUAD(@var{expression})
4399 You can include explicit bytes of data in an output section by using
4400 @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as
4401 an output section command. Each keyword is followed by an expression in
4402 parentheses providing the value to store (@pxref{Expressions}). The
4403 value of the expression is stored at the current value of the location
4406 The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands
4407 store one, two, four, and eight bytes (respectively). After storing the
4408 bytes, the location counter is incremented by the number of bytes
4411 For example, this will store the byte 1 followed by the four byte value
4412 of the symbol @samp{addr}:
4418 When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the
4419 same; they both store an 8 byte, or 64 bit, value. When both host and
4420 target are 32 bits, an expression is computed as 32 bits. In this case
4421 @code{QUAD} stores a 32 bit value zero extended to 64 bits, and
4422 @code{SQUAD} stores a 32 bit value sign extended to 64 bits.
4424 If the object file format of the output file has an explicit endianness,
4425 which is the normal case, the value will be stored in that endianness.
4426 When the object file format does not have an explicit endianness, as is
4427 true of, for example, S-records, the value will be stored in the
4428 endianness of the first input object file.
4430 Note---these commands only work inside a section description and not
4431 between them, so the following will produce an error from the linker:
4433 SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
4435 whereas this will work:
4437 SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@
4440 @kindex FILL(@var{expression})
4441 @cindex holes, filling
4442 @cindex unspecified memory
4443 You may use the @code{FILL} command to set the fill pattern for the
4444 current section. It is followed by an expression in parentheses. Any
4445 otherwise unspecified regions of memory within the section (for example,
4446 gaps left due to the required alignment of input sections) are filled
4447 with the value of the expression, repeated as
4448 necessary. A @code{FILL} statement covers memory locations after the
4449 point at which it occurs in the section definition; by including more
4450 than one @code{FILL} statement, you can have different fill patterns in
4451 different parts of an output section.
4453 This example shows how to fill unspecified regions of memory with the
4459 The @code{FILL} command is similar to the @samp{=@var{fillexp}} output
4460 section attribute, but it only affects the
4461 part of the section following the @code{FILL} command, rather than the
4462 entire section. If both are used, the @code{FILL} command takes
4463 precedence. @xref{Output Section Fill}, for details on the fill
4466 @node Output Section Keywords
4467 @subsection Output Section Keywords
4468 There are a couple of keywords which can appear as output section
4472 @kindex CREATE_OBJECT_SYMBOLS
4473 @cindex input filename symbols
4474 @cindex filename symbols
4475 @item CREATE_OBJECT_SYMBOLS
4476 The command tells the linker to create a symbol for each input file.
4477 The name of each symbol will be the name of the corresponding input
4478 file. The section of each symbol will be the output section in which
4479 the @code{CREATE_OBJECT_SYMBOLS} command appears.
4481 This is conventional for the a.out object file format. It is not
4482 normally used for any other object file format.
4484 @kindex CONSTRUCTORS
4485 @cindex C++ constructors, arranging in link
4486 @cindex constructors, arranging in link
4488 When linking using the a.out object file format, the linker uses an
4489 unusual set construct to support C++ global constructors and
4490 destructors. When linking object file formats which do not support
4491 arbitrary sections, such as ECOFF and XCOFF, the linker will
4492 automatically recognize C++ global constructors and destructors by name.
4493 For these object file formats, the @code{CONSTRUCTORS} command tells the
4494 linker to place constructor information in the output section where the
4495 @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is
4496 ignored for other object file formats.
4498 The symbol @w{@code{__CTOR_LIST__}} marks the start of the global
4499 constructors, and the symbol @w{@code{__CTOR_END__}} marks the end.
4500 Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark
4501 the start and end of the global destructors. The
4502 first word in the list is the number of entries, followed by the address
4503 of each constructor or destructor, followed by a zero word. The
4504 compiler must arrange to actually run the code. For these object file
4505 formats @sc{gnu} C++ normally calls constructors from a subroutine
4506 @code{__main}; a call to @code{__main} is automatically inserted into
4507 the startup code for @code{main}. @sc{gnu} C++ normally runs
4508 destructors either by using @code{atexit}, or directly from the function
4511 For object file formats such as @code{COFF} or @code{ELF} which support
4512 arbitrary section names, @sc{gnu} C++ will normally arrange to put the
4513 addresses of global constructors and destructors into the @code{.ctors}
4514 and @code{.dtors} sections. Placing the following sequence into your
4515 linker script will build the sort of table which the @sc{gnu} C++
4516 runtime code expects to see.
4520 LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2)
4525 LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2)
4531 If you are using the @sc{gnu} C++ support for initialization priority,
4532 which provides some control over the order in which global constructors
4533 are run, you must sort the constructors at link time to ensure that they
4534 are executed in the correct order. When using the @code{CONSTRUCTORS}
4535 command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the
4536 @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and
4537 @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and
4540 Normally the compiler and linker will handle these issues automatically,
4541 and you will not need to concern yourself with them. However, you may
4542 need to consider this if you are using C++ and writing your own linker
4547 @node Output Section Discarding
4548 @subsection Output Section Discarding
4549 @cindex discarding sections
4550 @cindex sections, discarding
4551 @cindex removing sections
4552 The linker will not normally create output sections with no contents.
4553 This is for convenience when referring to input sections that may or
4554 may not be present in any of the input files. For example:
4556 .foo : @{ *(.foo) @}
4559 will only create a @samp{.foo} section in the output file if there is a
4560 @samp{.foo} section in at least one input file, and if the input
4561 sections are not all empty. Other link script directives that allocate
4562 space in an output section will also create the output section. So
4563 too will assignments to dot even if the assignment does not create
4564 space, except for @samp{. = 0}, @samp{. = . + 0}, @samp{. = sym},
4565 @samp{. = . + sym} and @samp{. = ALIGN (. != 0, expr, 1)} when
4566 @samp{sym} is an absolute symbol of value 0 defined in the script.
4567 This allows you to force output of an empty section with @samp{. = .}.
4569 The linker will ignore address assignments (@pxref{Output Section Address})
4570 on discarded output sections, except when the linker script defines
4571 symbols in the output section. In that case the linker will obey
4572 the address assignments, possibly advancing dot even though the
4573 section is discarded.
4576 The special output section name @samp{/DISCARD/} may be used to discard
4577 input sections. Any input sections which are assigned to an output
4578 section named @samp{/DISCARD/} are not included in the output file.
4580 @node Output Section Attributes
4581 @subsection Output Section Attributes
4582 @cindex output section attributes
4583 We showed above that the full description of an output section looked
4588 @var{section} [@var{address}] [(@var{type})] :
4590 [ALIGN(@var{section_align})]
4591 [SUBALIGN(@var{subsection_align})]
4594 @var{output-section-command}
4595 @var{output-section-command}
4597 @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
4601 We've already described @var{section}, @var{address}, and
4602 @var{output-section-command}. In this section we will describe the
4603 remaining section attributes.
4606 * Output Section Type:: Output section type
4607 * Output Section LMA:: Output section LMA
4608 * Forced Output Alignment:: Forced Output Alignment
4609 * Forced Input Alignment:: Forced Input Alignment
4610 * Output Section Constraint:: Output section constraint
4611 * Output Section Region:: Output section region
4612 * Output Section Phdr:: Output section phdr
4613 * Output Section Fill:: Output section fill
4616 @node Output Section Type
4617 @subsubsection Output Section Type
4618 Each output section may have a type. The type is a keyword in
4619 parentheses. The following types are defined:
4623 The section should be marked as not loadable, so that it will not be
4624 loaded into memory when the program is run.
4629 These type names are supported for backward compatibility, and are
4630 rarely used. They all have the same effect: the section should be
4631 marked as not allocatable, so that no memory is allocated for the
4632 section when the program is run.
4636 @cindex prevent unnecessary loading
4637 @cindex loading, preventing
4638 The linker normally sets the attributes of an output section based on
4639 the input sections which map into it. You can override this by using
4640 the section type. For example, in the script sample below, the
4641 @samp{ROM} section is addressed at memory location @samp{0} and does not
4642 need to be loaded when the program is run.
4646 ROM 0 (NOLOAD) : @{ @dots{} @}
4652 @node Output Section LMA
4653 @subsubsection Output Section LMA
4654 @kindex AT>@var{lma_region}
4655 @kindex AT(@var{lma})
4656 @cindex load address
4657 @cindex section load address
4658 Every section has a virtual address (VMA) and a load address (LMA); see
4659 @ref{Basic Script Concepts}. The virtual address is specified by the
4660 @pxref{Output Section Address} described earlier. The load address is
4661 specified by the @code{AT} or @code{AT>} keywords. Specifying a load
4662 address is optional.
4664 The @code{AT} keyword takes an expression as an argument. This
4665 specifies the exact load address of the section. The @code{AT>} keyword
4666 takes the name of a memory region as an argument. @xref{MEMORY}. The
4667 load address of the section is set to the next free address in the
4668 region, aligned to the section's alignment requirements.
4670 If neither @code{AT} nor @code{AT>} is specified for an allocatable
4671 section, the linker will use the following heuristic to determine the
4676 If the section has a specific VMA address, then this is used as
4677 the LMA address as well.
4680 If the section is not allocatable then its LMA is set to its VMA.
4683 Otherwise if a memory region can be found that is compatible
4684 with the current section, and this region contains at least one
4685 section, then the LMA is set so the difference between the
4686 VMA and LMA is the same as the difference between the VMA and LMA of
4687 the last section in the located region.
4690 If no memory regions have been declared then a default region
4691 that covers the entire address space is used in the previous step.
4694 If no suitable region could be found, or there was no previous
4695 section then the LMA is set equal to the VMA.
4698 @cindex ROM initialized data
4699 @cindex initialized data in ROM
4700 This feature is designed to make it easy to build a ROM image. For
4701 example, the following linker script creates three output sections: one
4702 called @samp{.text}, which starts at @code{0x1000}, one called
4703 @samp{.mdata}, which is loaded at the end of the @samp{.text} section
4704 even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold
4705 uninitialized data at address @code{0x3000}. The symbol @code{_data} is
4706 defined with the value @code{0x2000}, which shows that the location
4707 counter holds the VMA value, not the LMA value.
4713 .text 0x1000 : @{ *(.text) _etext = . ; @}
4715 AT ( ADDR (.text) + SIZEOF (.text) )
4716 @{ _data = . ; *(.data); _edata = . ; @}
4718 @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@}
4723 The run-time initialization code for use with a program generated with
4724 this linker script would include something like the following, to copy
4725 the initialized data from the ROM image to its runtime address. Notice
4726 how this code takes advantage of the symbols defined by the linker
4731 extern char _etext, _data, _edata, _bstart, _bend;
4732 char *src = &_etext;
4735 /* ROM has data at end of text; copy it. */
4736 while (dst < &_edata)
4740 for (dst = &_bstart; dst< &_bend; dst++)
4745 @node Forced Output Alignment
4746 @subsubsection Forced Output Alignment
4747 @kindex ALIGN(@var{section_align})
4748 @cindex forcing output section alignment
4749 @cindex output section alignment
4750 You can increase an output section's alignment by using ALIGN. As an
4751 alternative you can enforce that the difference between the VMA and LMA remains
4752 intact throughout this output section with the ALIGN_WITH_INPUT attribute.
4754 @node Forced Input Alignment
4755 @subsubsection Forced Input Alignment
4756 @kindex SUBALIGN(@var{subsection_align})
4757 @cindex forcing input section alignment
4758 @cindex input section alignment
4759 You can force input section alignment within an output section by using
4760 SUBALIGN. The value specified overrides any alignment given by input
4761 sections, whether larger or smaller.
4763 @node Output Section Constraint
4764 @subsubsection Output Section Constraint
4767 @cindex constraints on output sections
4768 You can specify that an output section should only be created if all
4769 of its input sections are read-only or all of its input sections are
4770 read-write by using the keyword @code{ONLY_IF_RO} and
4771 @code{ONLY_IF_RW} respectively.
4773 @node Output Section Region
4774 @subsubsection Output Section Region
4775 @kindex >@var{region}
4776 @cindex section, assigning to memory region
4777 @cindex memory regions and sections
4778 You can assign a section to a previously defined region of memory by
4779 using @samp{>@var{region}}. @xref{MEMORY}.
4781 Here is a simple example:
4784 MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @}
4785 SECTIONS @{ ROM : @{ *(.text) @} >rom @}
4789 @node Output Section Phdr
4790 @subsubsection Output Section Phdr
4792 @cindex section, assigning to program header
4793 @cindex program headers and sections
4794 You can assign a section to a previously defined program segment by
4795 using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to
4796 one or more segments, then all subsequent allocated sections will be
4797 assigned to those segments as well, unless they use an explicitly
4798 @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the
4799 linker to not put the section in any segment at all.
4801 Here is a simple example:
4804 PHDRS @{ text PT_LOAD ; @}
4805 SECTIONS @{ .text : @{ *(.text) @} :text @}
4809 @node Output Section Fill
4810 @subsubsection Output Section Fill
4811 @kindex =@var{fillexp}
4812 @cindex section fill pattern
4813 @cindex fill pattern, entire section
4814 You can set the fill pattern for an entire section by using
4815 @samp{=@var{fillexp}}. @var{fillexp} is an expression
4816 (@pxref{Expressions}). Any otherwise unspecified regions of memory
4817 within the output section (for example, gaps left due to the required
4818 alignment of input sections) will be filled with the value, repeated as
4819 necessary. If the fill expression is a simple hex number, ie. a string
4820 of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then
4821 an arbitrarily long sequence of hex digits can be used to specify the
4822 fill pattern; Leading zeros become part of the pattern too. For all
4823 other cases, including extra parentheses or a unary @code{+}, the fill
4824 pattern is the four least significant bytes of the value of the
4825 expression. In all cases, the number is big-endian.
4827 You can also change the fill value with a @code{FILL} command in the
4828 output section commands; (@pxref{Output Section Data}).
4830 Here is a simple example:
4833 SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @}
4837 @node Overlay Description
4838 @subsection Overlay Description
4841 An overlay description provides an easy way to describe sections which
4842 are to be loaded as part of a single memory image but are to be run at
4843 the same memory address. At run time, some sort of overlay manager will
4844 copy the overlaid sections in and out of the runtime memory address as
4845 required, perhaps by simply manipulating addressing bits. This approach
4846 can be useful, for example, when a certain region of memory is faster
4849 Overlays are described using the @code{OVERLAY} command. The
4850 @code{OVERLAY} command is used within a @code{SECTIONS} command, like an
4851 output section description. The full syntax of the @code{OVERLAY}
4852 command is as follows:
4855 OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )]
4859 @var{output-section-command}
4860 @var{output-section-command}
4862 @} [:@var{phdr}@dots{}] [=@var{fill}]
4865 @var{output-section-command}
4866 @var{output-section-command}
4868 @} [:@var{phdr}@dots{}] [=@var{fill}]
4870 @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] [,]
4874 Everything is optional except @code{OVERLAY} (a keyword), and each
4875 section must have a name (@var{secname1} and @var{secname2} above). The
4876 section definitions within the @code{OVERLAY} construct are identical to
4877 those within the general @code{SECTIONS} construct (@pxref{SECTIONS}),
4878 except that no addresses and no memory regions may be defined for
4879 sections within an @code{OVERLAY}.
4881 The comma at the end may be required if a @var{fill} is used and
4882 the next @var{sections-command} looks like a continuation of the expression.
4884 The sections are all defined with the same starting address. The load
4885 addresses of the sections are arranged such that they are consecutive in
4886 memory starting at the load address used for the @code{OVERLAY} as a
4887 whole (as with normal section definitions, the load address is optional,
4888 and defaults to the start address; the start address is also optional,
4889 and defaults to the current value of the location counter).
4891 If the @code{NOCROSSREFS} keyword is used, and there are any
4892 references among the sections, the linker will report an error. Since
4893 the sections all run at the same address, it normally does not make
4894 sense for one section to refer directly to another.
4895 @xref{Miscellaneous Commands, NOCROSSREFS}.
4897 For each section within the @code{OVERLAY}, the linker automatically
4898 provides two symbols. The symbol @code{__load_start_@var{secname}} is
4899 defined as the starting load address of the section. The symbol
4900 @code{__load_stop_@var{secname}} is defined as the final load address of
4901 the section. Any characters within @var{secname} which are not legal
4902 within C identifiers are removed. C (or assembler) code may use these
4903 symbols to move the overlaid sections around as necessary.
4905 At the end of the overlay, the value of the location counter is set to
4906 the start address of the overlay plus the size of the largest section.
4908 Here is an example. Remember that this would appear inside a
4909 @code{SECTIONS} construct.
4912 OVERLAY 0x1000 : AT (0x4000)
4914 .text0 @{ o1/*.o(.text) @}
4915 .text1 @{ o2/*.o(.text) @}
4920 This will define both @samp{.text0} and @samp{.text1} to start at
4921 address 0x1000. @samp{.text0} will be loaded at address 0x4000, and
4922 @samp{.text1} will be loaded immediately after @samp{.text0}. The
4923 following symbols will be defined if referenced: @code{__load_start_text0},
4924 @code{__load_stop_text0}, @code{__load_start_text1},
4925 @code{__load_stop_text1}.
4927 C code to copy overlay @code{.text1} into the overlay area might look
4932 extern char __load_start_text1, __load_stop_text1;
4933 memcpy ((char *) 0x1000, &__load_start_text1,
4934 &__load_stop_text1 - &__load_start_text1);
4938 Note that the @code{OVERLAY} command is just syntactic sugar, since
4939 everything it does can be done using the more basic commands. The above
4940 example could have been written identically as follows.
4944 .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @}
4945 PROVIDE (__load_start_text0 = LOADADDR (.text0));
4946 PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0));
4947 .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @}
4948 PROVIDE (__load_start_text1 = LOADADDR (.text1));
4949 PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1));
4950 . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1));
4955 @section MEMORY Command
4957 @cindex memory regions
4958 @cindex regions of memory
4959 @cindex allocating memory
4960 @cindex discontinuous memory
4961 The linker's default configuration permits allocation of all available
4962 memory. You can override this by using the @code{MEMORY} command.
4964 The @code{MEMORY} command describes the location and size of blocks of
4965 memory in the target. You can use it to describe which memory regions
4966 may be used by the linker, and which memory regions it must avoid. You
4967 can then assign sections to particular memory regions. The linker will
4968 set section addresses based on the memory regions, and will warn about
4969 regions that become too full. The linker will not shuffle sections
4970 around to fit into the available regions.
4972 A linker script may contain at most one use of the @code{MEMORY}
4973 command. However, you can define as many blocks of memory within it as
4974 you wish. The syntax is:
4979 @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len}
4985 The @var{name} is a name used in the linker script to refer to the
4986 region. The region name has no meaning outside of the linker script.
4987 Region names are stored in a separate name space, and will not conflict
4988 with symbol names, file names, or section names. Each memory region
4989 must have a distinct name within the @code{MEMORY} command. However you can
4990 add later alias names to existing memory regions with the @ref{REGION_ALIAS}
4993 @cindex memory region attributes
4994 The @var{attr} string is an optional list of attributes that specify
4995 whether to use a particular memory region for an input section which is
4996 not explicitly mapped in the linker script. As described in
4997 @ref{SECTIONS}, if you do not specify an output section for some input
4998 section, the linker will create an output section with the same name as
4999 the input section. If you define region attributes, the linker will use
5000 them to select the memory region for the output section that it creates.
5002 The @var{attr} string must consist only of the following characters:
5017 Invert the sense of any of the attributes that follow
5020 If a unmapped section matches any of the listed attributes other than
5021 @samp{!}, it will be placed in the memory region. The @samp{!}
5022 attribute reverses this test, so that an unmapped section will be placed
5023 in the memory region only if it does not match any of the listed
5029 The @var{origin} is an numerical expression for the start address of
5030 the memory region. The expression must evaluate to a constant and it
5031 cannot involve any symbols. The keyword @code{ORIGIN} may be
5032 abbreviated to @code{org} or @code{o} (but not, for example,
5038 The @var{len} is an expression for the size in bytes of the memory
5039 region. As with the @var{origin} expression, the expression must
5040 be numerical only and must evaluate to a constant. The keyword
5041 @code{LENGTH} may be abbreviated to @code{len} or @code{l}.
5043 In the following example, we specify that there are two memory regions
5044 available for allocation: one starting at @samp{0} for 256 kilobytes,
5045 and the other starting at @samp{0x40000000} for four megabytes. The
5046 linker will place into the @samp{rom} memory region every section which
5047 is not explicitly mapped into a memory region, and is either read-only
5048 or executable. The linker will place other sections which are not
5049 explicitly mapped into a memory region into the @samp{ram} memory
5056 rom (rx) : ORIGIN = 0, LENGTH = 256K
5057 ram (!rx) : org = 0x40000000, l = 4M
5062 Once you define a memory region, you can direct the linker to place
5063 specific output sections into that memory region by using the
5064 @samp{>@var{region}} output section attribute. For example, if you have
5065 a memory region named @samp{mem}, you would use @samp{>mem} in the
5066 output section definition. @xref{Output Section Region}. If no address
5067 was specified for the output section, the linker will set the address to
5068 the next available address within the memory region. If the combined
5069 output sections directed to a memory region are too large for the
5070 region, the linker will issue an error message.
5072 It is possible to access the origin and length of a memory in an
5073 expression via the @code{ORIGIN(@var{memory})} and
5074 @code{LENGTH(@var{memory})} functions:
5078 _fstack = ORIGIN(ram) + LENGTH(ram) - 4;
5083 @section PHDRS Command
5085 @cindex program headers
5086 @cindex ELF program headers
5087 @cindex program segments
5088 @cindex segments, ELF
5089 The ELF object file format uses @dfn{program headers}, also knows as
5090 @dfn{segments}. The program headers describe how the program should be
5091 loaded into memory. You can print them out by using the @code{objdump}
5092 program with the @samp{-p} option.
5094 When you run an ELF program on a native ELF system, the system loader
5095 reads the program headers in order to figure out how to load the
5096 program. This will only work if the program headers are set correctly.
5097 This manual does not describe the details of how the system loader
5098 interprets program headers; for more information, see the ELF ABI.
5100 The linker will create reasonable program headers by default. However,
5101 in some cases, you may need to specify the program headers more
5102 precisely. You may use the @code{PHDRS} command for this purpose. When
5103 the linker sees the @code{PHDRS} command in the linker script, it will
5104 not create any program headers other than the ones specified.
5106 The linker only pays attention to the @code{PHDRS} command when
5107 generating an ELF output file. In other cases, the linker will simply
5108 ignore @code{PHDRS}.
5110 This is the syntax of the @code{PHDRS} command. The words @code{PHDRS},
5111 @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords.
5117 @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ]
5118 [ FLAGS ( @var{flags} ) ] ;
5123 The @var{name} is used only for reference in the @code{SECTIONS} command
5124 of the linker script. It is not put into the output file. Program
5125 header names are stored in a separate name space, and will not conflict
5126 with symbol names, file names, or section names. Each program header
5127 must have a distinct name. The headers are processed in order and it
5128 is usual for them to map to sections in ascending load address order.
5130 Certain program header types describe segments of memory which the
5131 system loader will load from the file. In the linker script, you
5132 specify the contents of these segments by placing allocatable output
5133 sections in the segments. You use the @samp{:@var{phdr}} output section
5134 attribute to place a section in a particular segment. @xref{Output
5137 It is normal to put certain sections in more than one segment. This
5138 merely implies that one segment of memory contains another. You may
5139 repeat @samp{:@var{phdr}}, using it once for each segment which should
5140 contain the section.
5142 If you place a section in one or more segments using @samp{:@var{phdr}},
5143 then the linker will place all subsequent allocatable sections which do
5144 not specify @samp{:@var{phdr}} in the same segments. This is for
5145 convenience, since generally a whole set of contiguous sections will be
5146 placed in a single segment. You can use @code{:NONE} to override the
5147 default segment and tell the linker to not put the section in any
5152 You may use the @code{FILEHDR} and @code{PHDRS} keywords after
5153 the program header type to further describe the contents of the segment.
5154 The @code{FILEHDR} keyword means that the segment should include the ELF
5155 file header. The @code{PHDRS} keyword means that the segment should
5156 include the ELF program headers themselves. If applied to a loadable
5157 segment (@code{PT_LOAD}), all prior loadable segments must have one of
5160 The @var{type} may be one of the following. The numbers indicate the
5161 value of the keyword.
5164 @item @code{PT_NULL} (0)
5165 Indicates an unused program header.
5167 @item @code{PT_LOAD} (1)
5168 Indicates that this program header describes a segment to be loaded from
5171 @item @code{PT_DYNAMIC} (2)
5172 Indicates a segment where dynamic linking information can be found.
5174 @item @code{PT_INTERP} (3)
5175 Indicates a segment where the name of the program interpreter may be
5178 @item @code{PT_NOTE} (4)
5179 Indicates a segment holding note information.
5181 @item @code{PT_SHLIB} (5)
5182 A reserved program header type, defined but not specified by the ELF
5185 @item @code{PT_PHDR} (6)
5186 Indicates a segment where the program headers may be found.
5188 @item @var{expression}
5189 An expression giving the numeric type of the program header. This may
5190 be used for types not defined above.
5193 You can specify that a segment should be loaded at a particular address
5194 in memory by using an @code{AT} expression. This is identical to the
5195 @code{AT} command used as an output section attribute (@pxref{Output
5196 Section LMA}). The @code{AT} command for a program header overrides the
5197 output section attribute.
5199 The linker will normally set the segment flags based on the sections
5200 which comprise the segment. You may use the @code{FLAGS} keyword to
5201 explicitly specify the segment flags. The value of @var{flags} must be
5202 an integer. It is used to set the @code{p_flags} field of the program
5205 Here is an example of @code{PHDRS}. This shows a typical set of program
5206 headers used on a native ELF system.
5212 headers PT_PHDR PHDRS ;
5214 text PT_LOAD FILEHDR PHDRS ;
5216 dynamic PT_DYNAMIC ;
5222 .interp : @{ *(.interp) @} :text :interp
5223 .text : @{ *(.text) @} :text
5224 .rodata : @{ *(.rodata) @} /* defaults to :text */
5226 . = . + 0x1000; /* move to a new page in memory */
5227 .data : @{ *(.data) @} :data
5228 .dynamic : @{ *(.dynamic) @} :data :dynamic
5235 @section VERSION Command
5236 @kindex VERSION @{script text@}
5237 @cindex symbol versions
5238 @cindex version script
5239 @cindex versions of symbols
5240 The linker supports symbol versions when using ELF. Symbol versions are
5241 only useful when using shared libraries. The dynamic linker can use
5242 symbol versions to select a specific version of a function when it runs
5243 a program that may have been linked against an earlier version of the
5246 You can include a version script directly in the main linker script, or
5247 you can supply the version script as an implicit linker script. You can
5248 also use the @samp{--version-script} linker option.
5250 The syntax of the @code{VERSION} command is simply
5252 VERSION @{ version-script-commands @}
5255 The format of the version script commands is identical to that used by
5256 Sun's linker in Solaris 2.5. The version script defines a tree of
5257 version nodes. You specify the node names and interdependencies in the
5258 version script. You can specify which symbols are bound to which
5259 version nodes, and you can reduce a specified set of symbols to local
5260 scope so that they are not globally visible outside of the shared
5263 The easiest way to demonstrate the version script language is with a few
5289 This example version script defines three version nodes. The first
5290 version node defined is @samp{VERS_1.1}; it has no other dependencies.
5291 The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces
5292 a number of symbols to local scope so that they are not visible outside
5293 of the shared library; this is done using wildcard patterns, so that any
5294 symbol whose name begins with @samp{old}, @samp{original}, or @samp{new}
5295 is matched. The wildcard patterns available are the same as those used
5296 in the shell when matching filenames (also known as ``globbing'').
5297 However, if you specify the symbol name inside double quotes, then the
5298 name is treated as literal, rather than as a glob pattern.
5300 Next, the version script defines node @samp{VERS_1.2}. This node
5301 depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2}
5302 to the version node @samp{VERS_1.2}.
5304 Finally, the version script defines node @samp{VERS_2.0}. This node
5305 depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1}
5306 and @samp{bar2} are bound to the version node @samp{VERS_2.0}.
5308 When the linker finds a symbol defined in a library which is not
5309 specifically bound to a version node, it will effectively bind it to an
5310 unspecified base version of the library. You can bind all otherwise
5311 unspecified symbols to a given version node by using @samp{global: *;}
5312 somewhere in the version script. Note that it's slightly crazy to use
5313 wildcards in a global spec except on the last version node. Global
5314 wildcards elsewhere run the risk of accidentally adding symbols to the
5315 set exported for an old version. That's wrong since older versions
5316 ought to have a fixed set of symbols.
5318 The names of the version nodes have no specific meaning other than what
5319 they might suggest to the person reading them. The @samp{2.0} version
5320 could just as well have appeared in between @samp{1.1} and @samp{1.2}.
5321 However, this would be a confusing way to write a version script.
5323 Node name can be omitted, provided it is the only version node
5324 in the version script. Such version script doesn't assign any versions to
5325 symbols, only selects which symbols will be globally visible out and which
5329 @{ global: foo; bar; local: *; @};
5332 When you link an application against a shared library that has versioned
5333 symbols, the application itself knows which version of each symbol it
5334 requires, and it also knows which version nodes it needs from each
5335 shared library it is linked against. Thus at runtime, the dynamic
5336 loader can make a quick check to make sure that the libraries you have
5337 linked against do in fact supply all of the version nodes that the
5338 application will need to resolve all of the dynamic symbols. In this
5339 way it is possible for the dynamic linker to know with certainty that
5340 all external symbols that it needs will be resolvable without having to
5341 search for each symbol reference.
5343 The symbol versioning is in effect a much more sophisticated way of
5344 doing minor version checking that SunOS does. The fundamental problem
5345 that is being addressed here is that typically references to external
5346 functions are bound on an as-needed basis, and are not all bound when
5347 the application starts up. If a shared library is out of date, a
5348 required interface may be missing; when the application tries to use
5349 that interface, it may suddenly and unexpectedly fail. With symbol
5350 versioning, the user will get a warning when they start their program if
5351 the libraries being used with the application are too old.
5353 There are several GNU extensions to Sun's versioning approach. The
5354 first of these is the ability to bind a symbol to a version node in the
5355 source file where the symbol is defined instead of in the versioning
5356 script. This was done mainly to reduce the burden on the library
5357 maintainer. You can do this by putting something like:
5359 __asm__(".symver original_foo,foo@@VERS_1.1");
5362 in the C source file. This renames the function @samp{original_foo} to
5363 be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}.
5364 The @samp{local:} directive can be used to prevent the symbol
5365 @samp{original_foo} from being exported. A @samp{.symver} directive
5366 takes precedence over a version script.
5368 The second GNU extension is to allow multiple versions of the same
5369 function to appear in a given shared library. In this way you can make
5370 an incompatible change to an interface without increasing the major
5371 version number of the shared library, while still allowing applications
5372 linked against the old interface to continue to function.
5374 To do this, you must use multiple @samp{.symver} directives in the
5375 source file. Here is an example:
5378 __asm__(".symver original_foo,foo@@");
5379 __asm__(".symver old_foo,foo@@VERS_1.1");
5380 __asm__(".symver old_foo1,foo@@VERS_1.2");
5381 __asm__(".symver new_foo,foo@@@@VERS_2.0");
5384 In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the
5385 unspecified base version of the symbol. The source file that contains this
5386 example would define 4 C functions: @samp{original_foo}, @samp{old_foo},
5387 @samp{old_foo1}, and @samp{new_foo}.
5389 When you have multiple definitions of a given symbol, there needs to be
5390 some way to specify a default version to which external references to
5391 this symbol will be bound. You can do this with the
5392 @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only
5393 declare one version of a symbol as the default in this manner; otherwise
5394 you would effectively have multiple definitions of the same symbol.
5396 If you wish to bind a reference to a specific version of the symbol
5397 within the shared library, you can use the aliases of convenience
5398 (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to
5399 specifically bind to an external version of the function in question.
5401 You can also specify the language in the version script:
5404 VERSION extern "lang" @{ version-script-commands @}
5407 The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}.
5408 The linker will iterate over the list of symbols at the link time and
5409 demangle them according to @samp{lang} before matching them to the
5410 patterns specified in @samp{version-script-commands}. The default
5411 @samp{lang} is @samp{C}.
5413 Demangled names may contains spaces and other special characters. As
5414 described above, you can use a glob pattern to match demangled names,
5415 or you can use a double-quoted string to match the string exactly. In
5416 the latter case, be aware that minor differences (such as differing
5417 whitespace) between the version script and the demangler output will
5418 cause a mismatch. As the exact string generated by the demangler
5419 might change in the future, even if the mangled name does not, you
5420 should check that all of your version directives are behaving as you
5421 expect when you upgrade.
5424 @section Expressions in Linker Scripts
5427 The syntax for expressions in the linker script language is identical to
5428 that of C expressions. All expressions are evaluated as integers. All
5429 expressions are evaluated in the same size, which is 32 bits if both the
5430 host and target are 32 bits, and is otherwise 64 bits.
5432 You can use and set symbol values in expressions.
5434 The linker defines several special purpose builtin functions for use in
5438 * Constants:: Constants
5439 * Symbolic Constants:: Symbolic constants
5440 * Symbols:: Symbol Names
5441 * Orphan Sections:: Orphan Sections
5442 * Location Counter:: The Location Counter
5443 * Operators:: Operators
5444 * Evaluation:: Evaluation
5445 * Expression Section:: The Section of an Expression
5446 * Builtin Functions:: Builtin Functions
5450 @subsection Constants
5451 @cindex integer notation
5452 @cindex constants in linker scripts
5453 All constants are integers.
5455 As in C, the linker considers an integer beginning with @samp{0} to be
5456 octal, and an integer beginning with @samp{0x} or @samp{0X} to be
5457 hexadecimal. Alternatively the linker accepts suffixes of @samp{h} or
5458 @samp{H} for hexadecimal, @samp{o} or @samp{O} for octal, @samp{b} or
5459 @samp{B} for binary and @samp{d} or @samp{D} for decimal. Any integer
5460 value without a prefix or a suffix is considered to be decimal.
5462 @cindex scaled integers
5463 @cindex K and M integer suffixes
5464 @cindex M and K integer suffixes
5465 @cindex suffixes for integers
5466 @cindex integer suffixes
5467 In addition, you can use the suffixes @code{K} and @code{M} to scale a
5471 @c END TEXI2ROFF-KILL
5472 @code{1024} or @code{1024*1024}
5476 ${\rm 1024}$ or ${\rm 1024}^2$
5478 @c END TEXI2ROFF-KILL
5479 respectively. For example, the following
5480 all refer to the same quantity:
5489 Note - the @code{K} and @code{M} suffixes cannot be used in
5490 conjunction with the base suffixes mentioned above.
5492 @node Symbolic Constants
5493 @subsection Symbolic Constants
5494 @cindex symbolic constants
5496 It is possible to refer to target specific constants via the use of
5497 the @code{CONSTANT(@var{name})} operator, where @var{name} is one of:
5502 The target's maximum page size.
5504 @item COMMONPAGESIZE
5505 @kindex COMMONPAGESIZE
5506 The target's default page size.
5512 .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @}
5515 will create a text section aligned to the largest page boundary
5516 supported by the target.
5519 @subsection Symbol Names
5520 @cindex symbol names
5522 @cindex quoted symbol names
5524 Unless quoted, symbol names start with a letter, underscore, or period
5525 and may include letters, digits, underscores, periods, and hyphens.
5526 Unquoted symbol names must not conflict with any keywords. You can
5527 specify a symbol which contains odd characters or has the same name as a
5528 keyword by surrounding the symbol name in double quotes:
5531 "with a space" = "also with a space" + 10;
5534 Since symbols can contain many non-alphabetic characters, it is safest
5535 to delimit symbols with spaces. For example, @samp{A-B} is one symbol,
5536 whereas @samp{A - B} is an expression involving subtraction.
5538 @node Orphan Sections
5539 @subsection Orphan Sections
5541 Orphan sections are sections present in the input files which
5542 are not explicitly placed into the output file by the linker
5543 script. The linker will still copy these sections into the
5544 output file, but it has to guess as to where they should be
5545 placed. The linker uses a simple heuristic to do this. It
5546 attempts to place orphan sections after non-orphan sections of the
5547 same attribute, such as code vs data, loadable vs non-loadable, etc.
5548 If there is not enough room to do this then it places
5549 at the end of the file.
5551 For ELF targets, the attribute of the section includes section type as
5552 well as section flag.
5554 If an orphaned section's name is representable as a C identifier then
5555 the linker will automatically @pxref{PROVIDE} two symbols:
5556 __start_SECNAME and __stop_SECNAME, where SECNAME is the name of the
5557 section. These indicate the start address and end address of the
5558 orphaned section respectively. Note: most section names are not
5559 representable as C identifiers because they contain a @samp{.}
5562 @node Location Counter
5563 @subsection The Location Counter
5566 @cindex location counter
5567 @cindex current output location
5568 The special linker variable @dfn{dot} @samp{.} always contains the
5569 current output location counter. Since the @code{.} always refers to a
5570 location in an output section, it may only appear in an expression
5571 within a @code{SECTIONS} command. The @code{.} symbol may appear
5572 anywhere that an ordinary symbol is allowed in an expression.
5575 Assigning a value to @code{.} will cause the location counter to be
5576 moved. This may be used to create holes in the output section. The
5577 location counter may not be moved backwards inside an output section,
5578 and may not be moved backwards outside of an output section if so
5579 doing creates areas with overlapping LMAs.
5595 In the previous example, the @samp{.text} section from @file{file1} is
5596 located at the beginning of the output section @samp{output}. It is
5597 followed by a 1000 byte gap. Then the @samp{.text} section from
5598 @file{file2} appears, also with a 1000 byte gap following before the
5599 @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678}
5600 specifies what data to write in the gaps (@pxref{Output Section Fill}).
5602 @cindex dot inside sections
5603 Note: @code{.} actually refers to the byte offset from the start of the
5604 current containing object. Normally this is the @code{SECTIONS}
5605 statement, whose start address is 0, hence @code{.} can be used as an
5606 absolute address. If @code{.} is used inside a section description
5607 however, it refers to the byte offset from the start of that section,
5608 not an absolute address. Thus in a script like this:
5626 The @samp{.text} section will be assigned a starting address of 0x100
5627 and a size of exactly 0x200 bytes, even if there is not enough data in
5628 the @samp{.text} input sections to fill this area. (If there is too
5629 much data, an error will be produced because this would be an attempt to
5630 move @code{.} backwards). The @samp{.data} section will start at 0x500
5631 and it will have an extra 0x600 bytes worth of space after the end of
5632 the values from the @samp{.data} input sections and before the end of
5633 the @samp{.data} output section itself.
5635 @cindex dot outside sections
5636 Setting symbols to the value of the location counter outside of an
5637 output section statement can result in unexpected values if the linker
5638 needs to place orphan sections. For example, given the following:
5644 .text: @{ *(.text) @}
5648 .data: @{ *(.data) @}
5653 If the linker needs to place some input section, e.g. @code{.rodata},
5654 not mentioned in the script, it might choose to place that section
5655 between @code{.text} and @code{.data}. You might think the linker
5656 should place @code{.rodata} on the blank line in the above script, but
5657 blank lines are of no particular significance to the linker. As well,
5658 the linker doesn't associate the above symbol names with their
5659 sections. Instead, it assumes that all assignments or other
5660 statements belong to the previous output section, except for the
5661 special case of an assignment to @code{.}. I.e., the linker will
5662 place the orphan @code{.rodata} section as if the script was written
5669 .text: @{ *(.text) @}
5673 .rodata: @{ *(.rodata) @}
5674 .data: @{ *(.data) @}
5679 This may or may not be the script author's intention for the value of
5680 @code{start_of_data}. One way to influence the orphan section
5681 placement is to assign the location counter to itself, as the linker
5682 assumes that an assignment to @code{.} is setting the start address of
5683 a following output section and thus should be grouped with that
5684 section. So you could write:
5690 .text: @{ *(.text) @}
5695 .data: @{ *(.data) @}
5700 Now, the orphan @code{.rodata} section will be placed between
5701 @code{end_of_text} and @code{start_of_data}.
5705 @subsection Operators
5706 @cindex operators for arithmetic
5707 @cindex arithmetic operators
5708 @cindex precedence in expressions
5709 The linker recognizes the standard C set of arithmetic operators, with
5710 the standard bindings and precedence levels:
5713 @c END TEXI2ROFF-KILL
5715 precedence associativity Operators Notes
5721 5 left == != > < <= >=
5727 11 right &= += -= *= /= (2)
5731 (1) Prefix operators
5732 (2) @xref{Assignments}.
5736 \vskip \baselineskip
5737 %"lispnarrowing" is the extra indent used generally for smallexample
5738 \hskip\lispnarrowing\vbox{\offinterlineskip
5741 {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr
5742 height2pt&\omit&&\omit&&\omit&\cr
5743 &Precedence&& Associativity &&{\rm Operators}&\cr
5744 height2pt&\omit&&\omit&&\omit&\cr
5746 height2pt&\omit&&\omit&&\omit&\cr
5748 % '176 is tilde, '~' in tt font
5749 &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr
5750 &2&&left&&* / \%&\cr
5753 &5&&left&&== != > < <= >=&\cr
5756 &8&&left&&{\&\&}&\cr
5759 &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr
5761 height2pt&\omit&&\omit&&\omit&\cr}
5766 @obeylines@parskip=0pt@parindent=0pt
5767 @dag@quad Prefix operators.
5768 @ddag@quad @xref{Assignments}.
5771 @c END TEXI2ROFF-KILL
5774 @subsection Evaluation
5775 @cindex lazy evaluation
5776 @cindex expression evaluation order
5777 The linker evaluates expressions lazily. It only computes the value of
5778 an expression when absolutely necessary.
5780 The linker needs some information, such as the value of the start
5781 address of the first section, and the origins and lengths of memory
5782 regions, in order to do any linking at all. These values are computed
5783 as soon as possible when the linker reads in the linker script.
5785 However, other values (such as symbol values) are not known or needed
5786 until after storage allocation. Such values are evaluated later, when
5787 other information (such as the sizes of output sections) is available
5788 for use in the symbol assignment expression.
5790 The sizes of sections cannot be known until after allocation, so
5791 assignments dependent upon these are not performed until after
5794 Some expressions, such as those depending upon the location counter
5795 @samp{.}, must be evaluated during section allocation.
5797 If the result of an expression is required, but the value is not
5798 available, then an error results. For example, a script like the
5804 .text 9+this_isnt_constant :
5810 will cause the error message @samp{non constant expression for initial
5813 @node Expression Section
5814 @subsection The Section of an Expression
5815 @cindex expression sections
5816 @cindex absolute expressions
5817 @cindex relative expressions
5818 @cindex absolute and relocatable symbols
5819 @cindex relocatable and absolute symbols
5820 @cindex symbols, relocatable and absolute
5821 Addresses and symbols may be section relative, or absolute. A section
5822 relative symbol is relocatable. If you request relocatable output
5823 using the @samp{-r} option, a further link operation may change the
5824 value of a section relative symbol. On the other hand, an absolute
5825 symbol will retain the same value throughout any further link
5828 Some terms in linker expressions are addresses. This is true of
5829 section relative symbols and for builtin functions that return an
5830 address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and
5831 @code{SEGMENT_START}. Other terms are simply numbers, or are builtin
5832 functions that return a non-address value, such as @code{LENGTH}.
5833 One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")}
5834 (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated
5835 differently depending on their location, for compatibility with older
5836 versions of @code{ld}. Expressions appearing outside an output
5837 section definition treat all numbers as absolute addresses.
5838 Expressions appearing inside an output section definition treat
5839 absolute symbols as numbers. If @code{LD_FEATURE ("SANE_EXPR")} is
5840 given, then absolute symbols and numbers are simply treated as numbers
5843 In the following simple example,
5850 __executable_start = 0x100;
5854 __data_start = 0x10;
5862 both @code{.} and @code{__executable_start} are set to the absolute
5863 address 0x100 in the first two assignments, then both @code{.} and
5864 @code{__data_start} are set to 0x10 relative to the @code{.data}
5865 section in the second two assignments.
5867 For expressions involving numbers, relative addresses and absolute
5868 addresses, ld follows these rules to evaluate terms:
5872 Unary operations on an absolute address or number, and binary
5873 operations on two absolute addresses or two numbers, or between one
5874 absolute address and a number, apply the operator to the value(s).
5876 Unary operations on a relative address, and binary operations on two
5877 relative addresses in the same section or between one relative address
5878 and a number, apply the operator to the offset part of the address(es).
5880 Other binary operations, that is, between two relative addresses not
5881 in the same section, or between a relative address and an absolute
5882 address, first convert any non-absolute term to an absolute address
5883 before applying the operator.
5886 The result section of each sub-expression is as follows:
5890 An operation involving only numbers results in a number.
5892 The result of comparisons, @samp{&&} and @samp{||} is also a number.
5894 The result of other binary arithmetic and logical operations on two
5895 relative addresses in the same section or two absolute addresses
5896 (after above conversions) is also a number.
5898 The result of other operations on relative addresses or one
5899 relative address and a number, is a relative address in the same
5900 section as the relative operand(s).
5902 The result of other operations on absolute addresses (after above
5903 conversions) is an absolute address.
5906 You can use the builtin function @code{ABSOLUTE} to force an expression
5907 to be absolute when it would otherwise be relative. For example, to
5908 create an absolute symbol set to the address of the end of the output
5909 section @samp{.data}:
5913 .data : @{ *(.data) _edata = ABSOLUTE(.); @}
5917 If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the
5918 @samp{.data} section.
5920 Using @code{LOADADDR} also forces an expression absolute, since this
5921 particular builtin function returns an absolute address.
5923 @node Builtin Functions
5924 @subsection Builtin Functions
5925 @cindex functions in expressions
5926 The linker script language includes a number of builtin functions for
5927 use in linker script expressions.
5930 @item ABSOLUTE(@var{exp})
5931 @kindex ABSOLUTE(@var{exp})
5932 @cindex expression, absolute
5933 Return the absolute (non-relocatable, as opposed to non-negative) value
5934 of the expression @var{exp}. Primarily useful to assign an absolute
5935 value to a symbol within a section definition, where symbol values are
5936 normally section relative. @xref{Expression Section}.
5938 @item ADDR(@var{section})
5939 @kindex ADDR(@var{section})
5940 @cindex section address in expression
5941 Return the address (VMA) of the named @var{section}. Your
5942 script must previously have defined the location of that section. In
5943 the following example, @code{start_of_output_1}, @code{symbol_1} and
5944 @code{symbol_2} are assigned equivalent values, except that
5945 @code{symbol_1} will be relative to the @code{.output1} section while
5946 the other two will be absolute:
5952 start_of_output_1 = ABSOLUTE(.);
5957 symbol_1 = ADDR(.output1);
5958 symbol_2 = start_of_output_1;
5964 @item ALIGN(@var{align})
5965 @itemx ALIGN(@var{exp},@var{align})
5966 @kindex ALIGN(@var{align})
5967 @kindex ALIGN(@var{exp},@var{align})
5968 @cindex round up location counter
5969 @cindex align location counter
5970 @cindex round up expression
5971 @cindex align expression
5972 Return the location counter (@code{.}) or arbitrary expression aligned
5973 to the next @var{align} boundary. The single operand @code{ALIGN}
5974 doesn't change the value of the location counter---it just does
5975 arithmetic on it. The two operand @code{ALIGN} allows an arbitrary
5976 expression to be aligned upwards (@code{ALIGN(@var{align})} is
5977 equivalent to @code{ALIGN(., @var{align})}).
5979 Here is an example which aligns the output @code{.data} section to the
5980 next @code{0x2000} byte boundary after the preceding section and sets a
5981 variable within the section to the next @code{0x8000} boundary after the
5986 .data ALIGN(0x2000): @{
5988 variable = ALIGN(0x8000);
5994 The first use of @code{ALIGN} in this example specifies the location of
5995 a section because it is used as the optional @var{address} attribute of
5996 a section definition (@pxref{Output Section Address}). The second use
5997 of @code{ALIGN} is used to defines the value of a symbol.
5999 The builtin function @code{NEXT} is closely related to @code{ALIGN}.
6001 @item ALIGNOF(@var{section})
6002 @kindex ALIGNOF(@var{section})
6003 @cindex section alignment
6004 Return the alignment in bytes of the named @var{section}, if that section has
6005 been allocated. If the section has not been allocated when this is
6006 evaluated, the linker will report an error. In the following example,
6007 the alignment of the @code{.output} section is stored as the first
6008 value in that section.
6013 LONG (ALIGNOF (.output))
6020 @item BLOCK(@var{exp})
6021 @kindex BLOCK(@var{exp})
6022 This is a synonym for @code{ALIGN}, for compatibility with older linker
6023 scripts. It is most often seen when setting the address of an output
6026 @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
6027 @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
6028 This is equivalent to either
6030 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1)))
6034 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - @var{commonpagesize})))
6037 depending on whether the latter uses fewer @var{commonpagesize} sized pages
6038 for the data segment (area between the result of this expression and
6039 @code{DATA_SEGMENT_END}) than the former or not.
6040 If the latter form is used, it means @var{commonpagesize} bytes of runtime
6041 memory will be saved at the expense of up to @var{commonpagesize} wasted
6042 bytes in the on-disk file.
6044 This expression can only be used directly in @code{SECTIONS} commands, not in
6045 any output section descriptions and only once in the linker script.
6046 @var{commonpagesize} should be less or equal to @var{maxpagesize} and should
6047 be the system page size the object wants to be optimized for (while still
6048 working on system page sizes up to @var{maxpagesize}).
6053 . = DATA_SEGMENT_ALIGN(0x10000, 0x2000);
6056 @item DATA_SEGMENT_END(@var{exp})
6057 @kindex DATA_SEGMENT_END(@var{exp})
6058 This defines the end of data segment for @code{DATA_SEGMENT_ALIGN}
6059 evaluation purposes.
6062 . = DATA_SEGMENT_END(.);
6065 @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
6066 @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
6067 This defines the end of the @code{PT_GNU_RELRO} segment when
6068 @samp{-z relro} option is used.
6069 When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END}
6070 does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that
6071 @var{exp} + @var{offset} is aligned to the most commonly used page
6072 boundary for particular target. If present in the linker script,
6073 it must always come in between @code{DATA_SEGMENT_ALIGN} and
6074 @code{DATA_SEGMENT_END}. Evaluates to the second argument plus any
6075 padding needed at the end of the @code{PT_GNU_RELRO} segment due to
6079 . = DATA_SEGMENT_RELRO_END(24, .);
6082 @item DEFINED(@var{symbol})
6083 @kindex DEFINED(@var{symbol})
6084 @cindex symbol defaults
6085 Return 1 if @var{symbol} is in the linker global symbol table and is
6086 defined before the statement using DEFINED in the script, otherwise
6087 return 0. You can use this function to provide
6088 default values for symbols. For example, the following script fragment
6089 shows how to set a global symbol @samp{begin} to the first location in
6090 the @samp{.text} section---but if a symbol called @samp{begin} already
6091 existed, its value is preserved:
6097 begin = DEFINED(begin) ? begin : . ;
6105 @item LENGTH(@var{memory})
6106 @kindex LENGTH(@var{memory})
6107 Return the length of the memory region named @var{memory}.
6109 @item LOADADDR(@var{section})
6110 @kindex LOADADDR(@var{section})
6111 @cindex section load address in expression
6112 Return the absolute LMA of the named @var{section}. (@pxref{Output
6115 @item LOG2CEIL(@var{exp})
6116 @kindex LOG2CEIL(@var{exp})
6117 Return the binary logarithm of @var{exp} rounded towards infinity.
6118 @code{LOG2CEIL(0)} returns 0.
6121 @item MAX(@var{exp1}, @var{exp2})
6122 Returns the maximum of @var{exp1} and @var{exp2}.
6125 @item MIN(@var{exp1}, @var{exp2})
6126 Returns the minimum of @var{exp1} and @var{exp2}.
6128 @item NEXT(@var{exp})
6129 @kindex NEXT(@var{exp})
6130 @cindex unallocated address, next
6131 Return the next unallocated address that is a multiple of @var{exp}.
6132 This function is closely related to @code{ALIGN(@var{exp})}; unless you
6133 use the @code{MEMORY} command to define discontinuous memory for the
6134 output file, the two functions are equivalent.
6136 @item ORIGIN(@var{memory})
6137 @kindex ORIGIN(@var{memory})
6138 Return the origin of the memory region named @var{memory}.
6140 @item SEGMENT_START(@var{segment}, @var{default})
6141 @kindex SEGMENT_START(@var{segment}, @var{default})
6142 Return the base address of the named @var{segment}. If an explicit
6143 value has already been given for this segment (with a command-line
6144 @samp{-T} option) then that value will be returned otherwise the value
6145 will be @var{default}. At present, the @samp{-T} command-line option
6146 can only be used to set the base address for the ``text'', ``data'', and
6147 ``bss'' sections, but you can use @code{SEGMENT_START} with any segment
6150 @item SIZEOF(@var{section})
6151 @kindex SIZEOF(@var{section})
6152 @cindex section size
6153 Return the size in bytes of the named @var{section}, if that section has
6154 been allocated. If the section has not been allocated when this is
6155 evaluated, the linker will report an error. In the following example,
6156 @code{symbol_1} and @code{symbol_2} are assigned identical values:
6165 symbol_1 = .end - .start ;
6166 symbol_2 = SIZEOF(.output);
6171 @item SIZEOF_HEADERS
6172 @itemx sizeof_headers
6173 @kindex SIZEOF_HEADERS
6175 Return the size in bytes of the output file's headers. This is
6176 information which appears at the start of the output file. You can use
6177 this number when setting the start address of the first section, if you
6178 choose, to facilitate paging.
6180 @cindex not enough room for program headers
6181 @cindex program headers, not enough room
6182 When producing an ELF output file, if the linker script uses the
6183 @code{SIZEOF_HEADERS} builtin function, the linker must compute the
6184 number of program headers before it has determined all the section
6185 addresses and sizes. If the linker later discovers that it needs
6186 additional program headers, it will report an error @samp{not enough
6187 room for program headers}. To avoid this error, you must avoid using
6188 the @code{SIZEOF_HEADERS} function, or you must rework your linker
6189 script to avoid forcing the linker to use additional program headers, or
6190 you must define the program headers yourself using the @code{PHDRS}
6191 command (@pxref{PHDRS}).
6194 @node Implicit Linker Scripts
6195 @section Implicit Linker Scripts
6196 @cindex implicit linker scripts
6197 If you specify a linker input file which the linker can not recognize as
6198 an object file or an archive file, it will try to read the file as a
6199 linker script. If the file can not be parsed as a linker script, the
6200 linker will report an error.
6202 An implicit linker script will not replace the default linker script.
6204 Typically an implicit linker script would contain only symbol
6205 assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION}
6208 Any input files read because of an implicit linker script will be read
6209 at the position in the command line where the implicit linker script was
6210 read. This can affect archive searching.
6213 @node Machine Dependent
6214 @chapter Machine Dependent Features
6216 @cindex machine dependencies
6217 @command{ld} has additional features on some platforms; the following
6218 sections describe them. Machines where @command{ld} has no additional
6219 functionality are not listed.
6223 * H8/300:: @command{ld} and the H8/300
6226 * i960:: @command{ld} and the Intel 960 family
6229 * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families
6232 * ARM:: @command{ld} and the ARM family
6235 * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF
6238 * M68K:: @command{ld} and the Motorola 68K family
6241 * MIPS:: @command{ld} and the MIPS family
6244 * MMIX:: @command{ld} and MMIX
6247 * MSP430:: @command{ld} and MSP430
6250 * NDS32:: @command{ld} and NDS32
6253 * Nios II:: @command{ld} and the Altera Nios II
6256 * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support
6259 * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support
6262 * SPU ELF:: @command{ld} and SPU ELF Support
6265 * TI COFF:: @command{ld} and TI COFF
6268 * WIN32:: @command{ld} and WIN32 (cygwin/mingw)
6271 * Xtensa:: @command{ld} and Xtensa Processors
6282 @section @command{ld} and the H8/300
6284 @cindex H8/300 support
6285 For the H8/300, @command{ld} can perform these global optimizations when
6286 you specify the @samp{--relax} command-line option.
6289 @cindex relaxing on H8/300
6290 @item relaxing address modes
6291 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6292 targets are within eight bits, and turns them into eight-bit
6293 program-counter relative @code{bsr} and @code{bra} instructions,
6296 @cindex synthesizing on H8/300
6297 @item synthesizing instructions
6298 @c FIXME: specifically mov.b, or any mov instructions really? -> mov.b only, at least on H8, H8H, H8S
6299 @command{ld} finds all @code{mov.b} instructions which use the
6300 sixteen-bit absolute address form, but refer to the top
6301 page of memory, and changes them to use the eight-bit address form.
6302 (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into
6303 @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the
6304 top page of memory).
6306 @command{ld} finds all @code{mov} instructions which use the register
6307 indirect with 32-bit displacement addressing mode, but use a small
6308 displacement inside 16-bit displacement range, and changes them to use
6309 the 16-bit displacement form. (That is: the linker turns @samp{mov.b
6310 @code{@@}@var{d}:32,ERx} into @samp{mov.b @code{@@}@var{d}:16,ERx}
6311 whenever the displacement @var{d} is in the 16 bit signed integer
6312 range. Only implemented in ELF-format ld).
6314 @item bit manipulation instructions
6315 @command{ld} finds all bit manipulation instructions like @code{band, bclr,
6316 biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor}
6317 which use 32 bit and 16 bit absolute address form, but refer to the top
6318 page of memory, and changes them to use the 8 bit address form.
6319 (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into
6320 @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in
6321 the top page of memory).
6323 @item system control instructions
6324 @command{ld} finds all @code{ldc.w, stc.w} instructions which use the
6325 32 bit absolute address form, but refer to the top page of memory, and
6326 changes them to use 16 bit address form.
6327 (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into
6328 @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in
6329 the top page of memory).
6339 @c This stuff is pointless to say unless you're especially concerned
6340 @c with Renesas chips; don't enable it for generic case, please.
6342 @chapter @command{ld} and Other Renesas Chips
6344 @command{ld} also supports the Renesas (formerly Hitachi) H8/300H,
6345 H8/500, and SH chips. No special features, commands, or command-line
6346 options are required for these chips.
6356 @section @command{ld} and the Intel 960 Family
6358 @cindex i960 support
6360 You can use the @samp{-A@var{architecture}} command line option to
6361 specify one of the two-letter names identifying members of the 960
6362 family; the option specifies the desired output target, and warns of any
6363 incompatible instructions in the input files. It also modifies the
6364 linker's search strategy for archive libraries, to support the use of
6365 libraries specific to each particular architecture, by including in the
6366 search loop names suffixed with the string identifying the architecture.
6368 For example, if your @command{ld} command line included @w{@samp{-ACA}} as
6369 well as @w{@samp{-ltry}}, the linker would look (in its built-in search
6370 paths, and in any paths you specify with @samp{-L}) for a library with
6383 The first two possibilities would be considered in any event; the last
6384 two are due to the use of @w{@samp{-ACA}}.
6386 You can meaningfully use @samp{-A} more than once on a command line, since
6387 the 960 architecture family allows combination of target architectures; each
6388 use will add another pair of name variants to search for when @w{@samp{-l}}
6389 specifies a library.
6391 @cindex @option{--relax} on i960
6392 @cindex relaxing on i960
6393 @command{ld} supports the @samp{--relax} option for the i960 family. If
6394 you specify @samp{--relax}, @command{ld} finds all @code{balx} and
6395 @code{calx} instructions whose targets are within 24 bits, and turns
6396 them into 24-bit program-counter relative @code{bal} and @code{cal}
6397 instructions, respectively. @command{ld} also turns @code{cal}
6398 instructions into @code{bal} instructions when it determines that the
6399 target subroutine is a leaf routine (that is, the target subroutine does
6400 not itself call any subroutines).
6417 @node M68HC11/68HC12
6418 @section @command{ld} and the Motorola 68HC11 and 68HC12 families
6420 @cindex M68HC11 and 68HC12 support
6422 @subsection Linker Relaxation
6424 For the Motorola 68HC11, @command{ld} can perform these global
6425 optimizations when you specify the @samp{--relax} command-line option.
6428 @cindex relaxing on M68HC11
6429 @item relaxing address modes
6430 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6431 targets are within eight bits, and turns them into eight-bit
6432 program-counter relative @code{bsr} and @code{bra} instructions,
6435 @command{ld} also looks at all 16-bit extended addressing modes and
6436 transforms them in a direct addressing mode when the address is in
6437 page 0 (between 0 and 0x0ff).
6439 @item relaxing gcc instruction group
6440 When @command{gcc} is called with @option{-mrelax}, it can emit group
6441 of instructions that the linker can optimize to use a 68HC11 direct
6442 addressing mode. These instructions consists of @code{bclr} or
6443 @code{bset} instructions.
6447 @subsection Trampoline Generation
6449 @cindex trampoline generation on M68HC11
6450 @cindex trampoline generation on M68HC12
6451 For 68HC11 and 68HC12, @command{ld} can generate trampoline code to
6452 call a far function using a normal @code{jsr} instruction. The linker
6453 will also change the relocation to some far function to use the
6454 trampoline address instead of the function address. This is typically the
6455 case when a pointer to a function is taken. The pointer will in fact
6456 point to the function trampoline.
6464 @section @command{ld} and the ARM family
6466 @cindex ARM interworking support
6467 @kindex --support-old-code
6468 For the ARM, @command{ld} will generate code stubs to allow functions calls
6469 between ARM and Thumb code. These stubs only work with code that has
6470 been compiled and assembled with the @samp{-mthumb-interwork} command
6471 line option. If it is necessary to link with old ARM object files or
6472 libraries, which have not been compiled with the -mthumb-interwork
6473 option then the @samp{--support-old-code} command line switch should be
6474 given to the linker. This will make it generate larger stub functions
6475 which will work with non-interworking aware ARM code. Note, however,
6476 the linker does not support generating stubs for function calls to
6477 non-interworking aware Thumb code.
6479 @cindex thumb entry point
6480 @cindex entry point, thumb
6481 @kindex --thumb-entry=@var{entry}
6482 The @samp{--thumb-entry} switch is a duplicate of the generic
6483 @samp{--entry} switch, in that it sets the program's starting address.
6484 But it also sets the bottom bit of the address, so that it can be
6485 branched to using a BX instruction, and the program will start
6486 executing in Thumb mode straight away.
6488 @cindex PE import table prefixing
6489 @kindex --use-nul-prefixed-import-tables
6490 The @samp{--use-nul-prefixed-import-tables} switch is specifying, that
6491 the import tables idata4 and idata5 have to be generated with a zero
6492 element prefix for import libraries. This is the old style to generate
6493 import tables. By default this option is turned off.
6497 The @samp{--be8} switch instructs @command{ld} to generate BE8 format
6498 executables. This option is only valid when linking big-endian
6499 objects - ie ones which have been assembled with the @option{-EB}
6500 option. The resulting image will contain big-endian data and
6504 @kindex --target1-rel
6505 @kindex --target1-abs
6506 The @samp{R_ARM_TARGET1} relocation is typically used for entries in the
6507 @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32}
6508 or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel}
6509 and @samp{--target1-abs} switches override the default.
6512 @kindex --target2=@var{type}
6513 The @samp{--target2=type} switch overrides the default definition of the
6514 @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their
6515 meanings, and target defaults are as follows:
6518 @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi)
6520 @samp{R_ARM_ABS32} (arm*-*-symbianelf)
6522 @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd)
6527 The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF
6528 specification) enables objects compiled for the ARMv4 architecture to be
6529 interworking-safe when linked with other objects compiled for ARMv4t, but
6530 also allows pure ARMv4 binaries to be built from the same ARMv4 objects.
6532 In the latter case, the switch @option{--fix-v4bx} must be passed to the
6533 linker, which causes v4t @code{BX rM} instructions to be rewritten as
6534 @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction.
6536 In the former case, the switch should not be used, and @samp{R_ARM_V4BX}
6537 relocations are ignored.
6539 @cindex FIX_V4BX_INTERWORKING
6540 @kindex --fix-v4bx-interworking
6541 Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX}
6542 relocations with a branch to the following veneer:
6550 This allows generation of libraries/applications that work on ARMv4 cores
6551 and are still interworking safe. Note that the above veneer clobbers the
6552 condition flags, so may cause incorrect program behavior in rare cases.
6556 The @samp{--use-blx} switch enables the linker to use ARM/Thumb
6557 BLX instructions (available on ARMv5t and above) in various
6558 situations. Currently it is used to perform calls via the PLT from Thumb
6559 code using BLX rather than using BX and a mode-switching stub before
6560 each PLT entry. This should lead to such calls executing slightly faster.
6562 This option is enabled implicitly for SymbianOS, so there is no need to
6563 specify it if you are using that target.
6565 @cindex VFP11_DENORM_FIX
6566 @kindex --vfp11-denorm-fix
6567 The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a
6568 bug in certain VFP11 coprocessor hardware, which sometimes allows
6569 instructions with denorm operands (which must be handled by support code)
6570 to have those operands overwritten by subsequent instructions before
6571 the support code can read the intended values.
6573 The bug may be avoided in scalar mode if you allow at least one
6574 intervening instruction between a VFP11 instruction which uses a register
6575 and another instruction which writes to the same register, or at least two
6576 intervening instructions if vector mode is in use. The bug only affects
6577 full-compliance floating-point mode: you do not need this workaround if
6578 you are using "runfast" mode. Please contact ARM for further details.
6580 If you know you are using buggy VFP11 hardware, you can
6581 enable this workaround by specifying the linker option
6582 @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar
6583 mode only, or @samp{--vfp-denorm-fix=vector} if you are using
6584 vector mode (the latter also works for scalar code). The default is
6585 @samp{--vfp-denorm-fix=none}.
6587 If the workaround is enabled, instructions are scanned for
6588 potentially-troublesome sequences, and a veneer is created for each
6589 such sequence which may trigger the erratum. The veneer consists of the
6590 first instruction of the sequence and a branch back to the subsequent
6591 instruction. The original instruction is then replaced with a branch to
6592 the veneer. The extra cycles required to call and return from the veneer
6593 are sufficient to avoid the erratum in both the scalar and vector cases.
6595 @cindex ARM1176 erratum workaround
6596 @kindex --fix-arm1176
6597 @kindex --no-fix-arm1176
6598 The @samp{--fix-arm1176} switch enables a link-time workaround for an erratum
6599 in certain ARM1176 processors. The workaround is enabled by default if you
6600 are targeting ARM v6 (excluding ARM v6T2) or earlier. It can be disabled
6601 unconditionally by specifying @samp{--no-fix-arm1176}.
6603 Further information is available in the ``ARM1176JZ-S and ARM1176JZF-S
6604 Programmer Advice Notice'' available on the ARM documentation website at:
6605 http://infocenter.arm.com/.
6607 @cindex NO_ENUM_SIZE_WARNING
6608 @kindex --no-enum-size-warning
6609 The @option{--no-enum-size-warning} switch prevents the linker from
6610 warning when linking object files that specify incompatible EABI
6611 enumeration size attributes. For example, with this switch enabled,
6612 linking of an object file using 32-bit enumeration values with another
6613 using enumeration values fitted into the smallest possible space will
6616 @cindex NO_WCHAR_SIZE_WARNING
6617 @kindex --no-wchar-size-warning
6618 The @option{--no-wchar-size-warning} switch prevents the linker from
6619 warning when linking object files that specify incompatible EABI
6620 @code{wchar_t} size attributes. For example, with this switch enabled,
6621 linking of an object file using 32-bit @code{wchar_t} values with another
6622 using 16-bit @code{wchar_t} values will not be diagnosed.
6625 @kindex --pic-veneer
6626 The @samp{--pic-veneer} switch makes the linker use PIC sequences for
6627 ARM/Thumb interworking veneers, even if the rest of the binary
6628 is not PIC. This avoids problems on uClinux targets where
6629 @samp{--emit-relocs} is used to generate relocatable binaries.
6631 @cindex STUB_GROUP_SIZE
6632 @kindex --stub-group-size=@var{N}
6633 The linker will automatically generate and insert small sequences of
6634 code into a linked ARM ELF executable whenever an attempt is made to
6635 perform a function call to a symbol that is too far away. The
6636 placement of these sequences of instructions - called stubs - is
6637 controlled by the command line option @option{--stub-group-size=N}.
6638 The placement is important because a poor choice can create a need for
6639 duplicate stubs, increasing the code size. The linker will try to
6640 group stubs together in order to reduce interruptions to the flow of
6641 code, but it needs guidance as to how big these groups should be and
6642 where they should be placed.
6644 The value of @samp{N}, the parameter to the
6645 @option{--stub-group-size=} option controls where the stub groups are
6646 placed. If it is negative then all stubs are placed after the first
6647 branch that needs them. If it is positive then the stubs can be
6648 placed either before or after the branches that need them. If the
6649 value of @samp{N} is 1 (either +1 or -1) then the linker will choose
6650 exactly where to place groups of stubs, using its built in heuristics.
6651 A value of @samp{N} greater than 1 (or smaller than -1) tells the
6652 linker that a single group of stubs can service at most @samp{N} bytes
6653 from the input sections.
6655 The default, if @option{--stub-group-size=} is not specified, is
6658 Farcalls stubs insertion is fully supported for the ARM-EABI target
6659 only, because it relies on object files properties not present
6662 @cindex Cortex-A8 erratum workaround
6663 @kindex --fix-cortex-a8
6664 @kindex --no-fix-cortex-a8
6665 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}.
6667 The erratum only affects Thumb-2 code. Please contact ARM for further details.
6669 @cindex Cortex-A53 erratum 835769 workaround
6670 @kindex --fix-cortex-a53-835769
6671 @kindex --no-fix-cortex-a53-835769
6672 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}.
6674 Please contact ARM for further details.
6676 @kindex --merge-exidx-entries
6677 @kindex --no-merge-exidx-entries
6678 @cindex Merging exidx entries
6679 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo.
6682 @cindex 32-bit PLT entries
6683 The @samp{--long-plt} option enables the use of 16 byte PLT entries
6684 which support up to 4Gb of code. The default is to use 12 byte PLT
6685 entries which only support 512Mb of code.
6698 @section @command{ld} and HPPA 32-bit ELF Support
6699 @cindex HPPA multiple sub-space stubs
6700 @kindex --multi-subspace
6701 When generating a shared library, @command{ld} will by default generate
6702 import stubs suitable for use with a single sub-space application.
6703 The @samp{--multi-subspace} switch causes @command{ld} to generate export
6704 stubs, and different (larger) import stubs suitable for use with
6705 multiple sub-spaces.
6707 @cindex HPPA stub grouping
6708 @kindex --stub-group-size=@var{N}
6709 Long branch stubs and import/export stubs are placed by @command{ld} in
6710 stub sections located between groups of input sections.
6711 @samp{--stub-group-size} specifies the maximum size of a group of input
6712 sections handled by one stub section. Since branch offsets are signed,
6713 a stub section may serve two groups of input sections, one group before
6714 the stub section, and one group after it. However, when using
6715 conditional branches that require stubs, it may be better (for branch
6716 prediction) that stub sections only serve one group of input sections.
6717 A negative value for @samp{N} chooses this scheme, ensuring that
6718 branches to stubs always use a negative offset. Two special values of
6719 @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct
6720 @command{ld} to automatically size input section groups for the branch types
6721 detected, with the same behaviour regarding stub placement as other
6722 positive or negative values of @samp{N} respectively.
6724 Note that @samp{--stub-group-size} does not split input sections. A
6725 single input section larger than the group size specified will of course
6726 create a larger group (of one section). If input sections are too
6727 large, it may not be possible for a branch to reach its stub.
6740 @section @command{ld} and the Motorola 68K family
6742 @cindex Motorola 68K GOT generation
6743 @kindex --got=@var{type}
6744 The @samp{--got=@var{type}} option lets you choose the GOT generation scheme.
6745 The choices are @samp{single}, @samp{negative}, @samp{multigot} and
6746 @samp{target}. When @samp{target} is selected the linker chooses
6747 the default GOT generation scheme for the current target.
6748 @samp{single} tells the linker to generate a single GOT with
6749 entries only at non-negative offsets.
6750 @samp{negative} instructs the linker to generate a single GOT with
6751 entries at both negative and positive offsets. Not all environments
6753 @samp{multigot} allows the linker to generate several GOTs in the
6754 output file. All GOT references from a single input object
6755 file access the same GOT, but references from different input object
6756 files might access different GOTs. Not all environments support such GOTs.
6769 @section @command{ld} and the MIPS family
6771 @cindex MIPS microMIPS instruction choice selection
6774 The @samp{--insn32} and @samp{--no-insn32} options control the choice of
6775 microMIPS instructions used in code generated by the linker, such as that
6776 in the PLT or lazy binding stubs, or in relaxation. If @samp{--insn32} is
6777 used, then the linker only uses 32-bit instruction encodings. By default
6778 or if @samp{--no-insn32} is used, all instruction encodings are used,
6779 including 16-bit ones where possible.
6792 @section @code{ld} and MMIX
6793 For MMIX, there is a choice of generating @code{ELF} object files or
6794 @code{mmo} object files when linking. The simulator @code{mmix}
6795 understands the @code{mmo} format. The binutils @code{objcopy} utility
6796 can translate between the two formats.
6798 There is one special section, the @samp{.MMIX.reg_contents} section.
6799 Contents in this section is assumed to correspond to that of global
6800 registers, and symbols referring to it are translated to special symbols,
6801 equal to registers. In a final link, the start address of the
6802 @samp{.MMIX.reg_contents} section corresponds to the first allocated
6803 global register multiplied by 8. Register @code{$255} is not included in
6804 this section; it is always set to the program entry, which is at the
6805 symbol @code{Main} for @code{mmo} files.
6807 Global symbols with the prefix @code{__.MMIX.start.}, for example
6808 @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special.
6809 The default linker script uses these to set the default start address
6812 Initial and trailing multiples of zero-valued 32-bit words in a section,
6813 are left out from an mmo file.
6826 @section @code{ld} and MSP430
6827 For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]}
6828 will select an appropriate linker script for selected MPU type. (To get a list of known MPUs
6829 just pass @samp{-m help} option to the linker).
6831 @cindex MSP430 extra sections
6832 The linker will recognize some extra sections which are MSP430 specific:
6835 @item @samp{.vectors}
6836 Defines a portion of ROM where interrupt vectors located.
6838 @item @samp{.bootloader}
6839 Defines the bootloader portion of the ROM (if applicable). Any code
6840 in this section will be uploaded to the MPU.
6842 @item @samp{.infomem}
6843 Defines an information memory section (if applicable). Any code in
6844 this section will be uploaded to the MPU.
6846 @item @samp{.infomemnobits}
6847 This is the same as the @samp{.infomem} section except that any code
6848 in this section will not be uploaded to the MPU.
6850 @item @samp{.noinit}
6851 Denotes a portion of RAM located above @samp{.bss} section.
6853 The last two sections are used by gcc.
6867 @section @code{ld} and NDS32
6868 @kindex relaxing on NDS32
6869 For NDS32, there are some options to select relaxation behavior. The linker
6870 relaxes objects according to these options.
6873 @item @samp{--m[no-]fp-as-gp}
6874 Disable/enable fp-as-gp relaxation.
6876 @item @samp{--mexport-symbols=FILE}
6877 Exporting symbols and their address into FILE as linker script.
6879 @item @samp{--m[no-]ex9}
6880 Disable/enable link-time EX9 relaxation.
6882 @item @samp{--mexport-ex9=FILE}
6883 Export the EX9 table after linking.
6885 @item @samp{--mimport-ex9=FILE}
6886 Import the Ex9 table for EX9 relaxation.
6888 @item @samp{--mupdate-ex9}
6889 Update the existing EX9 table.
6891 @item @samp{--mex9-limit=NUM}
6892 Maximum number of entries in the ex9 table.
6894 @item @samp{--mex9-loop-aware}
6895 Avoid generating the EX9 instruction inside the loop.
6897 @item @samp{--m[no-]ifc}
6898 Disable/enable the link-time IFC optimization.
6900 @item @samp{--mifc-loop-aware}
6901 Avoid generating the IFC instruction inside the loop.
6915 @section @command{ld} and the Altera Nios II
6916 @cindex Nios II call relaxation
6917 @kindex --relax on Nios II
6919 Call and immediate jump instructions on Nios II processors are limited to
6920 transferring control to addresses in the same 256MB memory segment,
6921 which may result in @command{ld} giving
6922 @samp{relocation truncated to fit} errors with very large programs.
6923 The command-line option @option{--relax} enables the generation of
6924 trampolines that can access the entire 32-bit address space for calls
6925 outside the normal @code{call} and @code{jmpi} address range. These
6926 trampolines are inserted at section boundaries, so may not themselves
6927 be reachable if an input section and its associated call trampolines are
6930 The @option{--relax} option is enabled by default unless @option{-r}
6931 is also specified. You can disable trampoline generation by using the
6932 @option{--no-relax} linker option. You can also disable this optimization
6933 locally by using the @samp{set .noat} directive in assembly-language
6934 source files, as the linker-inserted trampolines use the @code{at}
6935 register as a temporary.
6937 Note that the linker @option{--relax} option is independent of assembler
6938 relaxation options, and that using the GNU assembler's @option{-relax-all}
6939 option interferes with the linker's more selective call instruction relaxation.
6952 @section @command{ld} and PowerPC 32-bit ELF Support
6953 @cindex PowerPC long branches
6954 @kindex --relax on PowerPC
6955 Branches on PowerPC processors are limited to a signed 26-bit
6956 displacement, which may result in @command{ld} giving
6957 @samp{relocation truncated to fit} errors with very large programs.
6958 @samp{--relax} enables the generation of trampolines that can access
6959 the entire 32-bit address space. These trampolines are inserted at
6960 section boundaries, so may not themselves be reachable if an input
6961 section exceeds 33M in size. You may combine @samp{-r} and
6962 @samp{--relax} to add trampolines in a partial link. In that case
6963 both branches to undefined symbols and inter-section branches are also
6964 considered potentially out of range, and trampolines inserted.
6966 @cindex PowerPC ELF32 options
6971 Current PowerPC GCC accepts a @samp{-msecure-plt} option that
6972 generates code capable of using a newer PLT and GOT layout that has
6973 the security advantage of no executable section ever needing to be
6974 writable and no writable section ever being executable. PowerPC
6975 @command{ld} will generate this layout, including stubs to access the
6976 PLT, if all input files (including startup and static libraries) were
6977 compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old
6978 BSS PLT (and GOT layout) which can give slightly better performance.
6980 @kindex --secure-plt
6982 @command{ld} will use the new PLT and GOT layout if it is linking new
6983 @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically
6984 when linking non-PIC code. This option requests the new PLT and GOT
6985 layout. A warning will be given if some object file requires the old
6991 The new secure PLT and GOT are placed differently relative to other
6992 sections compared to older BSS PLT and GOT placement. The location of
6993 @code{.plt} must change because the new secure PLT is an initialized
6994 section while the old PLT is uninitialized. The reason for the
6995 @code{.got} change is more subtle: The new placement allows
6996 @code{.got} to be read-only in applications linked with
6997 @samp{-z relro -z now}. However, this placement means that
6998 @code{.sdata} cannot always be used in shared libraries, because the
6999 PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT
7000 pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC
7001 GCC doesn't use @code{.sdata} in shared libraries, so this option is
7002 really only useful for other compilers that may do so.
7004 @cindex PowerPC stub symbols
7005 @kindex --emit-stub-syms
7006 @item --emit-stub-syms
7007 This option causes @command{ld} to label linker stubs with a local
7008 symbol that encodes the stub type and destination.
7010 @cindex PowerPC TLS optimization
7011 @kindex --no-tls-optimize
7012 @item --no-tls-optimize
7013 PowerPC @command{ld} normally performs some optimization of code
7014 sequences used to access Thread-Local Storage. Use this option to
7015 disable the optimization.
7028 @node PowerPC64 ELF64
7029 @section @command{ld} and PowerPC64 64-bit ELF Support
7031 @cindex PowerPC64 ELF64 options
7033 @cindex PowerPC64 stub grouping
7034 @kindex --stub-group-size
7035 @item --stub-group-size
7036 Long branch stubs, PLT call stubs and TOC adjusting stubs are placed
7037 by @command{ld} in stub sections located between groups of input sections.
7038 @samp{--stub-group-size} specifies the maximum size of a group of input
7039 sections handled by one stub section. Since branch offsets are signed,
7040 a stub section may serve two groups of input sections, one group before
7041 the stub section, and one group after it. However, when using
7042 conditional branches that require stubs, it may be better (for branch
7043 prediction) that stub sections only serve one group of input sections.
7044 A negative value for @samp{N} chooses this scheme, ensuring that
7045 branches to stubs always use a negative offset. Two special values of
7046 @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct
7047 @command{ld} to automatically size input section groups for the branch types
7048 detected, with the same behaviour regarding stub placement as other
7049 positive or negative values of @samp{N} respectively.
7051 Note that @samp{--stub-group-size} does not split input sections. A
7052 single input section larger than the group size specified will of course
7053 create a larger group (of one section). If input sections are too
7054 large, it may not be possible for a branch to reach its stub.
7056 @cindex PowerPC64 stub symbols
7057 @kindex --emit-stub-syms
7058 @item --emit-stub-syms
7059 This option causes @command{ld} to label linker stubs with a local
7060 symbol that encodes the stub type and destination.
7062 @cindex PowerPC64 dot symbols
7064 @kindex --no-dotsyms
7065 @item --dotsyms, --no-dotsyms
7066 These two options control how @command{ld} interprets version patterns
7067 in a version script. Older PowerPC64 compilers emitted both a
7068 function descriptor symbol with the same name as the function, and a
7069 code entry symbol with the name prefixed by a dot (@samp{.}). To
7070 properly version a function @samp{foo}, the version script thus needs
7071 to control both @samp{foo} and @samp{.foo}. The option
7072 @samp{--dotsyms}, on by default, automatically adds the required
7073 dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this
7076 @cindex PowerPC64 TLS optimization
7077 @kindex --no-tls-optimize
7078 @item --no-tls-optimize
7079 PowerPC64 @command{ld} normally performs some optimization of code
7080 sequences used to access Thread-Local Storage. Use this option to
7081 disable the optimization.
7083 @cindex PowerPC64 OPD optimization
7084 @kindex --no-opd-optimize
7085 @item --no-opd-optimize
7086 PowerPC64 @command{ld} normally removes @code{.opd} section entries
7087 corresponding to deleted link-once functions, or functions removed by
7088 the action of @samp{--gc-sections} or linker script @code{/DISCARD/}.
7089 Use this option to disable @code{.opd} optimization.
7091 @cindex PowerPC64 OPD spacing
7092 @kindex --non-overlapping-opd
7093 @item --non-overlapping-opd
7094 Some PowerPC64 compilers have an option to generate compressed
7095 @code{.opd} entries spaced 16 bytes apart, overlapping the third word,
7096 the static chain pointer (unused in C) with the first word of the next
7097 entry. This option expands such entries to the full 24 bytes.
7099 @cindex PowerPC64 TOC optimization
7100 @kindex --no-toc-optimize
7101 @item --no-toc-optimize
7102 PowerPC64 @command{ld} normally removes unused @code{.toc} section
7103 entries. Such entries are detected by examining relocations that
7104 reference the TOC in code sections. A reloc in a deleted code section
7105 marks a TOC word as unneeded, while a reloc in a kept code section
7106 marks a TOC word as needed. Since the TOC may reference itself, TOC
7107 relocs are also examined. TOC words marked as both needed and
7108 unneeded will of course be kept. TOC words without any referencing
7109 reloc are assumed to be part of a multi-word entry, and are kept or
7110 discarded as per the nearest marked preceding word. This works
7111 reliably for compiler generated code, but may be incorrect if assembly
7112 code is used to insert TOC entries. Use this option to disable the
7115 @cindex PowerPC64 multi-TOC
7116 @kindex --no-multi-toc
7117 @item --no-multi-toc
7118 If given any toc option besides @code{-mcmodel=medium} or
7119 @code{-mcmodel=large}, PowerPC64 GCC generates code for a TOC model
7121 entries are accessed with a 16-bit offset from r2. This limits the
7122 total TOC size to 64K. PowerPC64 @command{ld} extends this limit by
7123 grouping code sections such that each group uses less than 64K for its
7124 TOC entries, then inserts r2 adjusting stubs between inter-group
7125 calls. @command{ld} does not split apart input sections, so cannot
7126 help if a single input file has a @code{.toc} section that exceeds
7127 64K, most likely from linking multiple files with @command{ld -r}.
7128 Use this option to turn off this feature.
7130 @cindex PowerPC64 TOC sorting
7131 @kindex --no-toc-sort
7133 By default, @command{ld} sorts TOC sections so that those whose file
7134 happens to have a section called @code{.init} or @code{.fini} are
7135 placed first, followed by TOC sections referenced by code generated
7136 with PowerPC64 gcc's @code{-mcmodel=small}, and lastly TOC sections
7137 referenced only by code generated with PowerPC64 gcc's
7138 @code{-mcmodel=medium} or @code{-mcmodel=large} options. Doing this
7139 results in better TOC grouping for multi-TOC. Use this option to turn
7142 @cindex PowerPC64 PLT stub alignment
7144 @kindex --no-plt-align
7146 @itemx --no-plt-align
7147 Use these options to control whether individual PLT call stubs are
7148 padded so that they don't cross a 32-byte boundary, or to the
7149 specified power of two boundary when using @code{--plt-align=}. Note
7150 that this isn't alignment in the usual sense. By default PLT call
7151 stubs are packed tightly.
7153 @cindex PowerPC64 PLT call stub static chain
7154 @kindex --plt-static-chain
7155 @kindex --no-plt-static-chain
7156 @item --plt-static-chain
7157 @itemx --no-plt-static-chain
7158 Use these options to control whether PLT call stubs load the static
7159 chain pointer (r11). @code{ld} defaults to not loading the static
7160 chain since there is never any need to do so on a PLT call.
7162 @cindex PowerPC64 PLT call stub thread safety
7163 @kindex --plt-thread-safe
7164 @kindex --no-plt-thread-safe
7165 @item --plt-thread-safe
7166 @itemx --no-thread-safe
7167 With power7's weakly ordered memory model, it is possible when using
7168 lazy binding for ld.so to update a plt entry in one thread and have
7169 another thread see the individual plt entry words update in the wrong
7170 order, despite ld.so carefully writing in the correct order and using
7171 memory write barriers. To avoid this we need some sort of read
7172 barrier in the call stub, or use LD_BIND_NOW=1. By default, @code{ld}
7173 looks for calls to commonly used functions that create threads, and if
7174 seen, adds the necessary barriers. Use these options to change the
7189 @section @command{ld} and SPU ELF Support
7191 @cindex SPU ELF options
7197 This option marks an executable as a PIC plugin module.
7199 @cindex SPU overlays
7200 @kindex --no-overlays
7202 Normally, @command{ld} recognizes calls to functions within overlay
7203 regions, and redirects such calls to an overlay manager via a stub.
7204 @command{ld} also provides a built-in overlay manager. This option
7205 turns off all this special overlay handling.
7207 @cindex SPU overlay stub symbols
7208 @kindex --emit-stub-syms
7209 @item --emit-stub-syms
7210 This option causes @command{ld} to label overlay stubs with a local
7211 symbol that encodes the stub type and destination.
7213 @cindex SPU extra overlay stubs
7214 @kindex --extra-overlay-stubs
7215 @item --extra-overlay-stubs
7216 This option causes @command{ld} to add overlay call stubs on all
7217 function calls out of overlay regions. Normally stubs are not added
7218 on calls to non-overlay regions.
7220 @cindex SPU local store size
7221 @kindex --local-store=lo:hi
7222 @item --local-store=lo:hi
7223 @command{ld} usually checks that a final executable for SPU fits in
7224 the address range 0 to 256k. This option may be used to change the
7225 range. Disable the check entirely with @option{--local-store=0:0}.
7228 @kindex --stack-analysis
7229 @item --stack-analysis
7230 SPU local store space is limited. Over-allocation of stack space
7231 unnecessarily limits space available for code and data, while
7232 under-allocation results in runtime failures. If given this option,
7233 @command{ld} will provide an estimate of maximum stack usage.
7234 @command{ld} does this by examining symbols in code sections to
7235 determine the extents of functions, and looking at function prologues
7236 for stack adjusting instructions. A call-graph is created by looking
7237 for relocations on branch instructions. The graph is then searched
7238 for the maximum stack usage path. Note that this analysis does not
7239 find calls made via function pointers, and does not handle recursion
7240 and other cycles in the call graph. Stack usage may be
7241 under-estimated if your code makes such calls. Also, stack usage for
7242 dynamic allocation, e.g. alloca, will not be detected. If a link map
7243 is requested, detailed information about each function's stack usage
7244 and calls will be given.
7247 @kindex --emit-stack-syms
7248 @item --emit-stack-syms
7249 This option, if given along with @option{--stack-analysis} will result
7250 in @command{ld} emitting stack sizing symbols for each function.
7251 These take the form @code{__stack_<function_name>} for global
7252 functions, and @code{__stack_<number>_<function_name>} for static
7253 functions. @code{<number>} is the section id in hex. The value of
7254 such symbols is the stack requirement for the corresponding function.
7255 The symbol size will be zero, type @code{STT_NOTYPE}, binding
7256 @code{STB_LOCAL}, and section @code{SHN_ABS}.
7270 @section @command{ld}'s Support for Various TI COFF Versions
7271 @cindex TI COFF versions
7272 @kindex --format=@var{version}
7273 The @samp{--format} switch allows selection of one of the various
7274 TI COFF versions. The latest of this writing is 2; versions 0 and 1 are
7275 also supported. The TI COFF versions also vary in header byte-order
7276 format; @command{ld} will read any version or byte order, but the output
7277 header format depends on the default specified by the specific target.
7290 @section @command{ld} and WIN32 (cygwin/mingw)
7292 This section describes some of the win32 specific @command{ld} issues.
7293 See @ref{Options,,Command Line Options} for detailed description of the
7294 command line options mentioned here.
7297 @cindex import libraries
7298 @item import libraries
7299 The standard Windows linker creates and uses so-called import
7300 libraries, which contains information for linking to dll's. They are
7301 regular static archives and are handled as any other static
7302 archive. The cygwin and mingw ports of @command{ld} have specific
7303 support for creating such libraries provided with the
7304 @samp{--out-implib} command line option.
7306 @item exporting DLL symbols
7307 @cindex exporting DLL symbols
7308 The cygwin/mingw @command{ld} has several ways to export symbols for dll's.
7311 @item using auto-export functionality
7312 @cindex using auto-export functionality
7313 By default @command{ld} exports symbols with the auto-export functionality,
7314 which is controlled by the following command line options:
7317 @item --export-all-symbols [This is the default]
7318 @item --exclude-symbols
7319 @item --exclude-libs
7320 @item --exclude-modules-for-implib
7321 @item --version-script
7324 When auto-export is in operation, @command{ld} will export all the non-local
7325 (global and common) symbols it finds in a DLL, with the exception of a few
7326 symbols known to belong to the system's runtime and libraries. As it will
7327 often not be desirable to export all of a DLL's symbols, which may include
7328 private functions that are not part of any public interface, the command-line
7329 options listed above may be used to filter symbols out from the list for
7330 exporting. The @samp{--output-def} option can be used in order to see the
7331 final list of exported symbols with all exclusions taken into effect.
7333 If @samp{--export-all-symbols} is not given explicitly on the
7334 command line, then the default auto-export behavior will be @emph{disabled}
7335 if either of the following are true:
7338 @item A DEF file is used.
7339 @item Any symbol in any object file was marked with the __declspec(dllexport) attribute.
7342 @item using a DEF file
7343 @cindex using a DEF file
7344 Another way of exporting symbols is using a DEF file. A DEF file is
7345 an ASCII file containing definitions of symbols which should be
7346 exported when a dll is created. Usually it is named @samp{<dll
7347 name>.def} and is added as any other object file to the linker's
7348 command line. The file's name must end in @samp{.def} or @samp{.DEF}.
7351 gcc -o <output> <objectfiles> <dll name>.def
7354 Using a DEF file turns off the normal auto-export behavior, unless the
7355 @samp{--export-all-symbols} option is also used.
7357 Here is an example of a DEF file for a shared library called @samp{xyz.dll}:
7360 LIBRARY "xyz.dll" BASE=0x20000000
7366 another_foo = abc.dll.afoo
7372 This example defines a DLL with a non-default base address and seven
7373 symbols in the export table. The third exported symbol @code{_bar} is an
7374 alias for the second. The fourth symbol, @code{another_foo} is resolved
7375 by "forwarding" to another module and treating it as an alias for
7376 @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol
7377 @code{var1} is declared to be a data object. The @samp{doo} symbol in
7378 export library is an alias of @samp{foo}, which gets the string name
7379 in export table @samp{foo2}. The @samp{eoo} symbol is an data export
7380 symbol, which gets in export table the name @samp{var1}.
7382 The optional @code{LIBRARY <name>} command indicates the @emph{internal}
7383 name of the output DLL. If @samp{<name>} does not include a suffix,
7384 the default library suffix, @samp{.DLL} is appended.
7386 When the .DEF file is used to build an application, rather than a
7387 library, the @code{NAME <name>} command should be used instead of
7388 @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default
7389 executable suffix, @samp{.EXE} is appended.
7391 With either @code{LIBRARY <name>} or @code{NAME <name>} the optional
7392 specification @code{BASE = <number>} may be used to specify a
7393 non-default base address for the image.
7395 If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified,
7396 or they specify an empty string, the internal name is the same as the
7397 filename specified on the command line.
7399 The complete specification of an export symbol is:
7403 ( ( ( <name1> [ = <name2> ] )
7404 | ( <name1> = <module-name> . <external-name>))
7405 [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) *
7408 Declares @samp{<name1>} as an exported symbol from the DLL, or declares
7409 @samp{<name1>} as an exported alias for @samp{<name2>}; or declares
7410 @samp{<name1>} as a "forward" alias for the symbol
7411 @samp{<external-name>} in the DLL @samp{<module-name>}.
7412 Optionally, the symbol may be exported by the specified ordinal
7413 @samp{<integer>} alias. The optional @samp{<name3>} is the to be used
7414 string in import/export table for the symbol.
7416 The optional keywords that follow the declaration indicate:
7418 @code{NONAME}: Do not put the symbol name in the DLL's export table. It
7419 will still be exported by its ordinal alias (either the value specified
7420 by the .def specification or, otherwise, the value assigned by the
7421 linker). The symbol name, however, does remain visible in the import
7422 library (if any), unless @code{PRIVATE} is also specified.
7424 @code{DATA}: The symbol is a variable or object, rather than a function.
7425 The import lib will export only an indirect reference to @code{foo} as
7426 the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as
7429 @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as
7430 well as @code{_imp__foo} into the import library. Both refer to the
7431 read-only import address table's pointer to the variable, not to the
7432 variable itself. This can be dangerous. If the user code fails to add
7433 the @code{dllimport} attribute and also fails to explicitly add the
7434 extra indirection that the use of the attribute enforces, the
7435 application will behave unexpectedly.
7437 @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put
7438 it into the static import library used to resolve imports at link time. The
7439 symbol can still be imported using the @code{LoadLibrary/GetProcAddress}
7440 API at runtime or by by using the GNU ld extension of linking directly to
7441 the DLL without an import library.
7443 See ld/deffilep.y in the binutils sources for the full specification of
7444 other DEF file statements
7446 @cindex creating a DEF file
7447 While linking a shared dll, @command{ld} is able to create a DEF file
7448 with the @samp{--output-def <file>} command line option.
7450 @item Using decorations
7451 @cindex Using decorations
7452 Another way of marking symbols for export is to modify the source code
7453 itself, so that when building the DLL each symbol to be exported is
7457 __declspec(dllexport) int a_variable
7458 __declspec(dllexport) void a_function(int with_args)
7461 All such symbols will be exported from the DLL. If, however,
7462 any of the object files in the DLL contain symbols decorated in
7463 this way, then the normal auto-export behavior is disabled, unless
7464 the @samp{--export-all-symbols} option is also used.
7466 Note that object files that wish to access these symbols must @emph{not}
7467 decorate them with dllexport. Instead, they should use dllimport,
7471 __declspec(dllimport) int a_variable
7472 __declspec(dllimport) void a_function(int with_args)
7475 This complicates the structure of library header files, because
7476 when included by the library itself the header must declare the
7477 variables and functions as dllexport, but when included by client
7478 code the header must declare them as dllimport. There are a number
7479 of idioms that are typically used to do this; often client code can
7480 omit the __declspec() declaration completely. See
7481 @samp{--enable-auto-import} and @samp{automatic data imports} for more
7485 @cindex automatic data imports
7486 @item automatic data imports
7487 The standard Windows dll format supports data imports from dlls only
7488 by adding special decorations (dllimport/dllexport), which let the
7489 compiler produce specific assembler instructions to deal with this
7490 issue. This increases the effort necessary to port existing Un*x
7491 code to these platforms, especially for large
7492 c++ libraries and applications. The auto-import feature, which was
7493 initially provided by Paul Sokolovsky, allows one to omit the
7494 decorations to achieve a behavior that conforms to that on POSIX/Un*x
7495 platforms. This feature is enabled with the @samp{--enable-auto-import}
7496 command-line option, although it is enabled by default on cygwin/mingw.
7497 The @samp{--enable-auto-import} option itself now serves mainly to
7498 suppress any warnings that are ordinarily emitted when linked objects
7499 trigger the feature's use.
7501 auto-import of variables does not always work flawlessly without
7502 additional assistance. Sometimes, you will see this message
7504 "variable '<var>' can't be auto-imported. Please read the
7505 documentation for ld's @code{--enable-auto-import} for details."
7507 The @samp{--enable-auto-import} documentation explains why this error
7508 occurs, and several methods that can be used to overcome this difficulty.
7509 One of these methods is the @emph{runtime pseudo-relocs} feature, described
7512 @cindex runtime pseudo-relocation
7513 For complex variables imported from DLLs (such as structs or classes),
7514 object files typically contain a base address for the variable and an
7515 offset (@emph{addend}) within the variable--to specify a particular
7516 field or public member, for instance. Unfortunately, the runtime loader used
7517 in win32 environments is incapable of fixing these references at runtime
7518 without the additional information supplied by dllimport/dllexport decorations.
7519 The standard auto-import feature described above is unable to resolve these
7522 The @samp{--enable-runtime-pseudo-relocs} switch allows these references to
7523 be resolved without error, while leaving the task of adjusting the references
7524 themselves (with their non-zero addends) to specialized code provided by the
7525 runtime environment. Recent versions of the cygwin and mingw environments and
7526 compilers provide this runtime support; older versions do not. However, the
7527 support is only necessary on the developer's platform; the compiled result will
7528 run without error on an older system.
7530 @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly
7533 @cindex direct linking to a dll
7534 @item direct linking to a dll
7535 The cygwin/mingw ports of @command{ld} support the direct linking,
7536 including data symbols, to a dll without the usage of any import
7537 libraries. This is much faster and uses much less memory than does the
7538 traditional import library method, especially when linking large
7539 libraries or applications. When @command{ld} creates an import lib, each
7540 function or variable exported from the dll is stored in its own bfd, even
7541 though a single bfd could contain many exports. The overhead involved in
7542 storing, loading, and processing so many bfd's is quite large, and explains the
7543 tremendous time, memory, and storage needed to link against particularly
7544 large or complex libraries when using import libs.
7546 Linking directly to a dll uses no extra command-line switches other than
7547 @samp{-L} and @samp{-l}, because @command{ld} already searches for a number
7548 of names to match each library. All that is needed from the developer's
7549 perspective is an understanding of this search, in order to force ld to
7550 select the dll instead of an import library.
7553 For instance, when ld is called with the argument @samp{-lxxx} it will attempt
7554 to find, in the first directory of its search path,
7566 before moving on to the next directory in the search path.
7568 (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll},
7569 where @samp{<prefix>} is set by the @command{ld} option
7570 @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec
7571 file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for
7574 Other win32-based unix environments, such as mingw or pw32, may use other
7575 @samp{<prefix>}es, although at present only cygwin makes use of this feature. It
7576 was originally intended to help avoid name conflicts among dll's built for the
7577 various win32/un*x environments, so that (for example) two versions of a zlib dll
7578 could coexist on the same machine.
7580 The generic cygwin/mingw path layout uses a @samp{bin} directory for
7581 applications and dll's and a @samp{lib} directory for the import
7582 libraries (using cygwin nomenclature):
7588 libxxx.dll.a (in case of dll's)
7589 libxxx.a (in case of static archive)
7592 Linking directly to a dll without using the import library can be
7595 1. Use the dll directly by adding the @samp{bin} path to the link line
7597 gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx
7600 However, as the dll's often have version numbers appended to their names
7601 (@samp{cygncurses-5.dll}) this will often fail, unless one specifies
7602 @samp{-L../bin -lncurses-5} to include the version. Import libs are generally
7603 not versioned, and do not have this difficulty.
7605 2. Create a symbolic link from the dll to a file in the @samp{lib}
7606 directory according to the above mentioned search pattern. This
7607 should be used to avoid unwanted changes in the tools needed for
7611 ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a]
7614 Then you can link without any make environment changes.
7617 gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx
7620 This technique also avoids the version number problems, because the following is
7627 libxxx.dll.a -> ../bin/cygxxx-5.dll
7630 Linking directly to a dll without using an import lib will work
7631 even when auto-import features are exercised, and even when
7632 @samp{--enable-runtime-pseudo-relocs} is used.
7634 Given the improvements in speed and memory usage, one might justifiably
7635 wonder why import libraries are used at all. There are three reasons:
7637 1. Until recently, the link-directly-to-dll functionality did @emph{not}
7638 work with auto-imported data.
7640 2. Sometimes it is necessary to include pure static objects within the
7641 import library (which otherwise contains only bfd's for indirection
7642 symbols that point to the exports of a dll). Again, the import lib
7643 for the cygwin kernel makes use of this ability, and it is not
7644 possible to do this without an import lib.
7646 3. Symbol aliases can only be resolved using an import lib. This is
7647 critical when linking against OS-supplied dll's (eg, the win32 API)
7648 in which symbols are usually exported as undecorated aliases of their
7649 stdcall-decorated assembly names.
7651 So, import libs are not going away. But the ability to replace
7652 true import libs with a simple symbolic link to (or a copy of)
7653 a dll, in many cases, is a useful addition to the suite of tools
7654 binutils makes available to the win32 developer. Given the
7655 massive improvements in memory requirements during linking, storage
7656 requirements, and linking speed, we expect that many developers
7657 will soon begin to use this feature whenever possible.
7659 @item symbol aliasing
7661 @item adding additional names
7662 Sometimes, it is useful to export symbols with additional names.
7663 A symbol @samp{foo} will be exported as @samp{foo}, but it can also be
7664 exported as @samp{_foo} by using special directives in the DEF file
7665 when creating the dll. This will affect also the optional created
7666 import library. Consider the following DEF file:
7669 LIBRARY "xyz.dll" BASE=0x61000000
7676 The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}.
7678 Another method for creating a symbol alias is to create it in the
7679 source code using the "weak" attribute:
7682 void foo () @{ /* Do something. */; @}
7683 void _foo () __attribute__ ((weak, alias ("foo")));
7686 See the gcc manual for more information about attributes and weak
7689 @item renaming symbols
7690 Sometimes it is useful to rename exports. For instance, the cygwin
7691 kernel does this regularly. A symbol @samp{_foo} can be exported as
7692 @samp{foo} but not as @samp{_foo} by using special directives in the
7693 DEF file. (This will also affect the import library, if it is
7694 created). In the following example:
7697 LIBRARY "xyz.dll" BASE=0x61000000
7703 The line @samp{_foo = foo} maps the exported symbol @samp{foo} to
7707 Note: using a DEF file disables the default auto-export behavior,
7708 unless the @samp{--export-all-symbols} command line option is used.
7709 If, however, you are trying to rename symbols, then you should list
7710 @emph{all} desired exports in the DEF file, including the symbols
7711 that are not being renamed, and do @emph{not} use the
7712 @samp{--export-all-symbols} option. If you list only the
7713 renamed symbols in the DEF file, and use @samp{--export-all-symbols}
7714 to handle the other symbols, then the both the new names @emph{and}
7715 the original names for the renamed symbols will be exported.
7716 In effect, you'd be aliasing those symbols, not renaming them,
7717 which is probably not what you wanted.
7719 @cindex weak externals
7720 @item weak externals
7721 The Windows object format, PE, specifies a form of weak symbols called
7722 weak externals. When a weak symbol is linked and the symbol is not
7723 defined, the weak symbol becomes an alias for some other symbol. There
7724 are three variants of weak externals:
7726 @item Definition is searched for in objects and libraries, historically
7727 called lazy externals.
7728 @item Definition is searched for only in other objects, not in libraries.
7729 This form is not presently implemented.
7730 @item No search; the symbol is an alias. This form is not presently
7733 As a GNU extension, weak symbols that do not specify an alternate symbol
7734 are supported. If the symbol is undefined when linking, the symbol
7735 uses a default value.
7737 @cindex aligned common symbols
7738 @item aligned common symbols
7739 As a GNU extension to the PE file format, it is possible to specify the
7740 desired alignment for a common symbol. This information is conveyed from
7741 the assembler or compiler to the linker by means of GNU-specific commands
7742 carried in the object file's @samp{.drectve} section, which are recognized
7743 by @command{ld} and respected when laying out the common symbols. Native
7744 tools will be able to process object files employing this GNU extension,
7745 but will fail to respect the alignment instructions, and may issue noisy
7746 warnings about unknown linker directives.
7761 @section @code{ld} and Xtensa Processors
7763 @cindex Xtensa processors
7764 The default @command{ld} behavior for Xtensa processors is to interpret
7765 @code{SECTIONS} commands so that lists of explicitly named sections in a
7766 specification with a wildcard file will be interleaved when necessary to
7767 keep literal pools within the range of PC-relative load offsets. For
7768 example, with the command:
7780 @command{ld} may interleave some of the @code{.literal}
7781 and @code{.text} sections from different object files to ensure that the
7782 literal pools are within the range of PC-relative load offsets. A valid
7783 interleaving might place the @code{.literal} sections from an initial
7784 group of files followed by the @code{.text} sections of that group of
7785 files. Then, the @code{.literal} sections from the rest of the files
7786 and the @code{.text} sections from the rest of the files would follow.
7788 @cindex @option{--relax} on Xtensa
7789 @cindex relaxing on Xtensa
7790 Relaxation is enabled by default for the Xtensa version of @command{ld} and
7791 provides two important link-time optimizations. The first optimization
7792 is to combine identical literal values to reduce code size. A redundant
7793 literal will be removed and all the @code{L32R} instructions that use it
7794 will be changed to reference an identical literal, as long as the
7795 location of the replacement literal is within the offset range of all
7796 the @code{L32R} instructions. The second optimization is to remove
7797 unnecessary overhead from assembler-generated ``longcall'' sequences of
7798 @code{L32R}/@code{CALLX@var{n}} when the target functions are within
7799 range of direct @code{CALL@var{n}} instructions.
7801 For each of these cases where an indirect call sequence can be optimized
7802 to a direct call, the linker will change the @code{CALLX@var{n}}
7803 instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R}
7804 instruction, and remove the literal referenced by the @code{L32R}
7805 instruction if it is not used for anything else. Removing the
7806 @code{L32R} instruction always reduces code size but can potentially
7807 hurt performance by changing the alignment of subsequent branch targets.
7808 By default, the linker will always preserve alignments, either by
7809 switching some instructions between 24-bit encodings and the equivalent
7810 density instructions or by inserting a no-op in place of the @code{L32R}
7811 instruction that was removed. If code size is more important than
7812 performance, the @option{--size-opt} option can be used to prevent the
7813 linker from widening density instructions or inserting no-ops, except in
7814 a few cases where no-ops are required for correctness.
7816 The following Xtensa-specific command-line options can be used to
7819 @cindex Xtensa options
7822 When optimizing indirect calls to direct calls, optimize for code size
7823 more than performance. With this option, the linker will not insert
7824 no-ops or widen density instructions to preserve branch target
7825 alignment. There may still be some cases where no-ops are required to
7826 preserve the correctness of the code.
7834 @ifclear SingleFormat
7839 @cindex object file management
7840 @cindex object formats available
7842 The linker accesses object and archive files using the BFD libraries.
7843 These libraries allow the linker to use the same routines to operate on
7844 object files whatever the object file format. A different object file
7845 format can be supported simply by creating a new BFD back end and adding
7846 it to the library. To conserve runtime memory, however, the linker and
7847 associated tools are usually configured to support only a subset of the
7848 object file formats available. You can use @code{objdump -i}
7849 (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to
7850 list all the formats available for your configuration.
7852 @cindex BFD requirements
7853 @cindex requirements for BFD
7854 As with most implementations, BFD is a compromise between
7855 several conflicting requirements. The major factor influencing
7856 BFD design was efficiency: any time used converting between
7857 formats is time which would not have been spent had BFD not
7858 been involved. This is partly offset by abstraction payback; since
7859 BFD simplifies applications and back ends, more time and care
7860 may be spent optimizing algorithms for a greater speed.
7862 One minor artifact of the BFD solution which you should bear in
7863 mind is the potential for information loss. There are two places where
7864 useful information can be lost using the BFD mechanism: during
7865 conversion and during output. @xref{BFD information loss}.
7868 * BFD outline:: How it works: an outline of BFD
7872 @section How It Works: An Outline of BFD
7873 @cindex opening object files
7874 @include bfdsumm.texi
7877 @node Reporting Bugs
7878 @chapter Reporting Bugs
7879 @cindex bugs in @command{ld}
7880 @cindex reporting bugs in @command{ld}
7882 Your bug reports play an essential role in making @command{ld} reliable.
7884 Reporting a bug may help you by bringing a solution to your problem, or
7885 it may not. But in any case the principal function of a bug report is
7886 to help the entire community by making the next version of @command{ld}
7887 work better. Bug reports are your contribution to the maintenance of
7890 In order for a bug report to serve its purpose, you must include the
7891 information that enables us to fix the bug.
7894 * Bug Criteria:: Have you found a bug?
7895 * Bug Reporting:: How to report bugs
7899 @section Have You Found a Bug?
7900 @cindex bug criteria
7902 If you are not sure whether you have found a bug, here are some guidelines:
7905 @cindex fatal signal
7906 @cindex linker crash
7907 @cindex crash of linker
7909 If the linker gets a fatal signal, for any input whatever, that is a
7910 @command{ld} bug. Reliable linkers never crash.
7912 @cindex error on valid input
7914 If @command{ld} produces an error message for valid input, that is a bug.
7916 @cindex invalid input
7918 If @command{ld} does not produce an error message for invalid input, that
7919 may be a bug. In the general case, the linker can not verify that
7920 object files are correct.
7923 If you are an experienced user of linkers, your suggestions for
7924 improvement of @command{ld} are welcome in any case.
7928 @section How to Report Bugs
7930 @cindex @command{ld} bugs, reporting
7932 A number of companies and individuals offer support for @sc{gnu}
7933 products. If you obtained @command{ld} from a support organization, we
7934 recommend you contact that organization first.
7936 You can find contact information for many support companies and
7937 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
7941 Otherwise, send bug reports for @command{ld} to
7945 The fundamental principle of reporting bugs usefully is this:
7946 @strong{report all the facts}. If you are not sure whether to state a
7947 fact or leave it out, state it!
7949 Often people omit facts because they think they know what causes the
7950 problem and assume that some details do not matter. Thus, you might
7951 assume that the name of a symbol you use in an example does not
7952 matter. Well, probably it does not, but one cannot be sure. Perhaps
7953 the bug is a stray memory reference which happens to fetch from the
7954 location where that name is stored in memory; perhaps, if the name
7955 were different, the contents of that location would fool the linker
7956 into doing the right thing despite the bug. Play it safe and give a
7957 specific, complete example. That is the easiest thing for you to do,
7958 and the most helpful.
7960 Keep in mind that the purpose of a bug report is to enable us to fix
7961 the bug if it is new to us. Therefore, always write your bug reports
7962 on the assumption that the bug has not been reported previously.
7964 Sometimes people give a few sketchy facts and ask, ``Does this ring a
7965 bell?'' This cannot help us fix a bug, so it is basically useless. We
7966 respond by asking for enough details to enable us to investigate.
7967 You might as well expedite matters by sending them to begin with.
7969 To enable us to fix the bug, you should include all these things:
7973 The version of @command{ld}. @command{ld} announces it if you start it with
7974 the @samp{--version} argument.
7976 Without this, we will not know whether there is any point in looking for
7977 the bug in the current version of @command{ld}.
7980 Any patches you may have applied to the @command{ld} source, including any
7981 patches made to the @code{BFD} library.
7984 The type of machine you are using, and the operating system name and
7988 What compiler (and its version) was used to compile @command{ld}---e.g.
7992 The command arguments you gave the linker to link your example and
7993 observe the bug. To guarantee you will not omit something important,
7994 list them all. A copy of the Makefile (or the output from make) is
7997 If we were to try to guess the arguments, we would probably guess wrong
7998 and then we might not encounter the bug.
8001 A complete input file, or set of input files, that will reproduce the
8002 bug. It is generally most helpful to send the actual object files
8003 provided that they are reasonably small. Say no more than 10K. For
8004 bigger files you can either make them available by FTP or HTTP or else
8005 state that you are willing to send the object file(s) to whomever
8006 requests them. (Note - your email will be going to a mailing list, so
8007 we do not want to clog it up with large attachments). But small
8008 attachments are best.
8010 If the source files were assembled using @code{gas} or compiled using
8011 @code{gcc}, then it may be OK to send the source files rather than the
8012 object files. In this case, be sure to say exactly what version of
8013 @code{gas} or @code{gcc} was used to produce the object files. Also say
8014 how @code{gas} or @code{gcc} were configured.
8017 A description of what behavior you observe that you believe is
8018 incorrect. For example, ``It gets a fatal signal.''
8020 Of course, if the bug is that @command{ld} gets a fatal signal, then we
8021 will certainly notice it. But if the bug is incorrect output, we might
8022 not notice unless it is glaringly wrong. You might as well not give us
8023 a chance to make a mistake.
8025 Even if the problem you experience is a fatal signal, you should still
8026 say so explicitly. Suppose something strange is going on, such as, your
8027 copy of @command{ld} is out of sync, or you have encountered a bug in the
8028 C library on your system. (This has happened!) Your copy might crash
8029 and ours would not. If you told us to expect a crash, then when ours
8030 fails to crash, we would know that the bug was not happening for us. If
8031 you had not told us to expect a crash, then we would not be able to draw
8032 any conclusion from our observations.
8035 If you wish to suggest changes to the @command{ld} source, send us context
8036 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or
8037 @samp{-p} option. Always send diffs from the old file to the new file.
8038 If you even discuss something in the @command{ld} source, refer to it by
8039 context, not by line number.
8041 The line numbers in our development sources will not match those in your
8042 sources. Your line numbers would convey no useful information to us.
8045 Here are some things that are not necessary:
8049 A description of the envelope of the bug.
8051 Often people who encounter a bug spend a lot of time investigating
8052 which changes to the input file will make the bug go away and which
8053 changes will not affect it.
8055 This is often time consuming and not very useful, because the way we
8056 will find the bug is by running a single example under the debugger
8057 with breakpoints, not by pure deduction from a series of examples.
8058 We recommend that you save your time for something else.
8060 Of course, if you can find a simpler example to report @emph{instead}
8061 of the original one, that is a convenience for us. Errors in the
8062 output will be easier to spot, running under the debugger will take
8063 less time, and so on.
8065 However, simplification is not vital; if you do not want to do this,
8066 report the bug anyway and send us the entire test case you used.
8069 A patch for the bug.
8071 A patch for the bug does help us if it is a good one. But do not omit
8072 the necessary information, such as the test case, on the assumption that
8073 a patch is all we need. We might see problems with your patch and decide
8074 to fix the problem another way, or we might not understand it at all.
8076 Sometimes with a program as complicated as @command{ld} it is very hard to
8077 construct an example that will make the program follow a certain path
8078 through the code. If you do not send us the example, we will not be
8079 able to construct one, so we will not be able to verify that the bug is
8082 And if we cannot understand what bug you are trying to fix, or why your
8083 patch should be an improvement, we will not install it. A test case will
8084 help us to understand.
8087 A guess about what the bug is or what it depends on.
8089 Such guesses are usually wrong. Even we cannot guess right about such
8090 things without first using the debugger to find the facts.
8094 @appendix MRI Compatible Script Files
8095 @cindex MRI compatibility
8096 To aid users making the transition to @sc{gnu} @command{ld} from the MRI
8097 linker, @command{ld} can use MRI compatible linker scripts as an
8098 alternative to the more general-purpose linker scripting language
8099 described in @ref{Scripts}. MRI compatible linker scripts have a much
8100 simpler command set than the scripting language otherwise used with
8101 @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI
8102 linker commands; these commands are described here.
8104 In general, MRI scripts aren't of much use with the @code{a.out} object
8105 file format, since it only has three sections and MRI scripts lack some
8106 features to make use of them.
8108 You can specify a file containing an MRI-compatible script using the
8109 @samp{-c} command-line option.
8111 Each command in an MRI-compatible script occupies its own line; each
8112 command line starts with the keyword that identifies the command (though
8113 blank lines are also allowed for punctuation). If a line of an
8114 MRI-compatible script begins with an unrecognized keyword, @command{ld}
8115 issues a warning message, but continues processing the script.
8117 Lines beginning with @samp{*} are comments.
8119 You can write these commands using all upper-case letters, or all
8120 lower case; for example, @samp{chip} is the same as @samp{CHIP}.
8121 The following list shows only the upper-case form of each command.
8124 @cindex @code{ABSOLUTE} (MRI)
8125 @item ABSOLUTE @var{secname}
8126 @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname}
8127 Normally, @command{ld} includes in the output file all sections from all
8128 the input files. However, in an MRI-compatible script, you can use the
8129 @code{ABSOLUTE} command to restrict the sections that will be present in
8130 your output program. If the @code{ABSOLUTE} command is used at all in a
8131 script, then only the sections named explicitly in @code{ABSOLUTE}
8132 commands will appear in the linker output. You can still use other
8133 input sections (whatever you select on the command line, or using
8134 @code{LOAD}) to resolve addresses in the output file.
8136 @cindex @code{ALIAS} (MRI)
8137 @item ALIAS @var{out-secname}, @var{in-secname}
8138 Use this command to place the data from input section @var{in-secname}
8139 in a section called @var{out-secname} in the linker output file.
8141 @var{in-secname} may be an integer.
8143 @cindex @code{ALIGN} (MRI)
8144 @item ALIGN @var{secname} = @var{expression}
8145 Align the section called @var{secname} to @var{expression}. The
8146 @var{expression} should be a power of two.
8148 @cindex @code{BASE} (MRI)
8149 @item BASE @var{expression}
8150 Use the value of @var{expression} as the lowest address (other than
8151 absolute addresses) in the output file.
8153 @cindex @code{CHIP} (MRI)
8154 @item CHIP @var{expression}
8155 @itemx CHIP @var{expression}, @var{expression}
8156 This command does nothing; it is accepted only for compatibility.
8158 @cindex @code{END} (MRI)
8160 This command does nothing whatever; it's only accepted for compatibility.
8162 @cindex @code{FORMAT} (MRI)
8163 @item FORMAT @var{output-format}
8164 Similar to the @code{OUTPUT_FORMAT} command in the more general linker
8165 language, but restricted to one of these output formats:
8169 S-records, if @var{output-format} is @samp{S}
8172 IEEE, if @var{output-format} is @samp{IEEE}
8175 COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is
8179 @cindex @code{LIST} (MRI)
8180 @item LIST @var{anything}@dots{}
8181 Print (to the standard output file) a link map, as produced by the
8182 @command{ld} command-line option @samp{-M}.
8184 The keyword @code{LIST} may be followed by anything on the
8185 same line, with no change in its effect.
8187 @cindex @code{LOAD} (MRI)
8188 @item LOAD @var{filename}
8189 @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename}
8190 Include one or more object file @var{filename} in the link; this has the
8191 same effect as specifying @var{filename} directly on the @command{ld}
8194 @cindex @code{NAME} (MRI)
8195 @item NAME @var{output-name}
8196 @var{output-name} is the name for the program produced by @command{ld}; the
8197 MRI-compatible command @code{NAME} is equivalent to the command-line
8198 option @samp{-o} or the general script language command @code{OUTPUT}.
8200 @cindex @code{ORDER} (MRI)
8201 @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname}
8202 @itemx ORDER @var{secname} @var{secname} @var{secname}
8203 Normally, @command{ld} orders the sections in its output file in the
8204 order in which they first appear in the input files. In an MRI-compatible
8205 script, you can override this ordering with the @code{ORDER} command. The
8206 sections you list with @code{ORDER} will appear first in your output
8207 file, in the order specified.
8209 @cindex @code{PUBLIC} (MRI)
8210 @item PUBLIC @var{name}=@var{expression}
8211 @itemx PUBLIC @var{name},@var{expression}
8212 @itemx PUBLIC @var{name} @var{expression}
8213 Supply a value (@var{expression}) for external symbol
8214 @var{name} used in the linker input files.
8216 @cindex @code{SECT} (MRI)
8217 @item SECT @var{secname}, @var{expression}
8218 @itemx SECT @var{secname}=@var{expression}
8219 @itemx SECT @var{secname} @var{expression}
8220 You can use any of these three forms of the @code{SECT} command to
8221 specify the start address (@var{expression}) for section @var{secname}.
8222 If you have more than one @code{SECT} statement for the same
8223 @var{secname}, only the @emph{first} sets the start address.
8226 @node GNU Free Documentation License
8227 @appendix GNU Free Documentation License
8231 @unnumbered LD Index
8236 % I think something like @@colophon should be in texinfo. In the
8238 \long\def\colophon{\hbox to0pt{}\vfill
8239 \centerline{The body of this manual is set in}
8240 \centerline{\fontname\tenrm,}
8241 \centerline{with headings in {\bf\fontname\tenbf}}
8242 \centerline{and examples in {\tt\fontname\tentt}.}
8243 \centerline{{\it\fontname\tenit\/} and}
8244 \centerline{{\sl\fontname\tensl\/}}
8245 \centerline{are used for emphasis.}\vfill}
8247 % Blame: doc@@cygnus.com, 28mar91.