3 @c Copyright (C) 1991-2020 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
46 @dircategory Software development
48 * Ld: (ld). The GNU linker.
53 This file documents the @sc{gnu} linker LD
54 @ifset VERSION_PACKAGE
55 @value{VERSION_PACKAGE}
57 version @value{VERSION}.
59 Copyright @copyright{} 1991-2020 Free Software Foundation, Inc.
61 Permission is granted to copy, distribute and/or modify this document
62 under the terms of the GNU Free Documentation License, Version 1.3
63 or any later version published by the Free Software Foundation;
64 with no Invariant Sections, with no Front-Cover Texts, and with no
65 Back-Cover Texts. A copy of the license is included in the
66 section entitled ``GNU Free Documentation License''.
70 @setchapternewpage odd
71 @settitle The GNU linker
76 @ifset VERSION_PACKAGE
77 @subtitle @value{VERSION_PACKAGE}
79 @subtitle Version @value{VERSION}
80 @author Steve Chamberlain
81 @author Ian Lance Taylor
86 \hfill Red Hat Inc\par
87 \hfill nickc\@credhat.com, doc\@redhat.com\par
88 \hfill {\it The GNU linker}\par
89 \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par
91 \global\parindent=0pt % Steve likes it this way.
94 @vskip 0pt plus 1filll
95 @c man begin COPYRIGHT
96 Copyright @copyright{} 1991-2020 Free Software Foundation, Inc.
98 Permission is granted to copy, distribute and/or modify this document
99 under the terms of the GNU Free Documentation License, Version 1.3
100 or any later version published by the Free Software Foundation;
101 with no Invariant Sections, with no Front-Cover Texts, and with no
102 Back-Cover Texts. A copy of the license is included in the
103 section entitled ``GNU Free Documentation License''.
109 @c FIXME: Talk about importance of *order* of args, cmds to linker!
114 This file documents the @sc{gnu} linker ld
115 @ifset VERSION_PACKAGE
116 @value{VERSION_PACKAGE}
118 version @value{VERSION}.
120 This document is distributed under the terms of the GNU Free
121 Documentation License version 1.3. A copy of the license is included
122 in the section entitled ``GNU Free Documentation License''.
125 * Overview:: Overview
126 * Invocation:: Invocation
127 * Scripts:: Linker Scripts
129 * Machine Dependent:: Machine Dependent Features
133 * H8/300:: ld and the H8/300
136 * Renesas:: ld and other Renesas micros
139 * ARM:: ld and the ARM family
142 * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families
145 * HPPA ELF32:: ld and HPPA 32-bit ELF
148 * M68K:: ld and Motorola 68K family
151 * MIPS:: ld and MIPS family
154 * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support
157 * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support
160 * S/390 ELF:: ld and S/390 ELF Support
163 * SPU ELF:: ld and SPU ELF Support
166 * TI COFF:: ld and the TI COFF
169 * Win32:: ld and WIN32 (cygwin/mingw)
172 * Xtensa:: ld and Xtensa Processors
175 @ifclear SingleFormat
178 @c Following blank line required for remaining bug in makeinfo conds/menus
180 * Reporting Bugs:: Reporting Bugs
181 * MRI:: MRI Compatible Script Files
182 * GNU Free Documentation License:: GNU Free Documentation License
183 * LD Index:: LD Index
190 @cindex @sc{gnu} linker
191 @cindex what is this?
194 @c man begin SYNOPSIS
195 ld [@b{options}] @var{objfile} @dots{}
199 ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and
200 the Info entries for @file{binutils} and
205 @c man begin DESCRIPTION
207 @command{ld} combines a number of object and archive files, relocates
208 their data and ties up symbol references. Usually the last step in
209 compiling a program is to run @command{ld}.
211 @command{ld} accepts Linker Command Language files written in
212 a superset of AT&T's Link Editor Command Language syntax,
213 to provide explicit and total control over the linking process.
217 This man page does not describe the command language; see the
218 @command{ld} entry in @code{info} for full details on the command
219 language and on other aspects of the GNU linker.
222 @ifclear SingleFormat
223 This version of @command{ld} uses the general purpose BFD libraries
224 to operate on object files. This allows @command{ld} to read, combine, and
225 write object files in many different formats---for example, COFF or
226 @code{a.out}. Different formats may be linked together to produce any
227 available kind of object file. @xref{BFD}, for more information.
230 Aside from its flexibility, the @sc{gnu} linker is more helpful than other
231 linkers in providing diagnostic information. Many linkers abandon
232 execution immediately upon encountering an error; whenever possible,
233 @command{ld} continues executing, allowing you to identify other errors
234 (or, in some cases, to get an output file in spite of the error).
241 @c man begin DESCRIPTION
243 The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations,
244 and to be as compatible as possible with other linkers. As a result,
245 you have many choices to control its behavior.
251 * Options:: Command-line Options
252 * Environment:: Environment Variables
256 @section Command-line Options
264 The linker supports a plethora of command-line options, but in actual
265 practice few of them are used in any particular context.
266 @cindex standard Unix system
267 For instance, a frequent use of @command{ld} is to link standard Unix
268 object files on a standard, supported Unix system. On such a system, to
269 link a file @code{hello.o}:
272 ld -o @var{output} /lib/crt0.o hello.o -lc
275 This tells @command{ld} to produce a file called @var{output} as the
276 result of linking the file @code{/lib/crt0.o} with @code{hello.o} and
277 the library @code{libc.a}, which will come from the standard search
278 directories. (See the discussion of the @samp{-l} option below.)
280 Some of the command-line options to @command{ld} may be specified at any
281 point in the command line. However, options which refer to files, such
282 as @samp{-l} or @samp{-T}, cause the file to be read at the point at
283 which the option appears in the command line, relative to the object
284 files and other file options. Repeating non-file options with a
285 different argument will either have no further effect, or override prior
286 occurrences (those further to the left on the command line) of that
287 option. Options which may be meaningfully specified more than once are
288 noted in the descriptions below.
291 Non-option arguments are object files or archives which are to be linked
292 together. They may follow, precede, or be mixed in with command-line
293 options, except that an object file argument may not be placed between
294 an option and its argument.
296 Usually the linker is invoked with at least one object file, but you can
297 specify other forms of binary input files using @samp{-l}, @samp{-R},
298 and the script command language. If @emph{no} binary input files at all
299 are specified, the linker does not produce any output, and issues the
300 message @samp{No input files}.
302 If the linker cannot recognize the format of an object file, it will
303 assume that it is a linker script. A script specified in this way
304 augments the main linker script used for the link (either the default
305 linker script or the one specified by using @samp{-T}). This feature
306 permits the linker to link against a file which appears to be an object
307 or an archive, but actually merely defines some symbol values, or uses
308 @code{INPUT} or @code{GROUP} to load other objects. Specifying a
309 script in this way merely augments the main linker script, with the
310 extra commands placed after the main script; use the @samp{-T} option
311 to replace the default linker script entirely, but note the effect of
312 the @code{INSERT} command. @xref{Scripts}.
314 For options whose names are a single letter,
315 option arguments must either follow the option letter without intervening
316 whitespace, or be given as separate arguments immediately following the
317 option that requires them.
319 For options whose names are multiple letters, either one dash or two can
320 precede the option name; for example, @samp{-trace-symbol} and
321 @samp{--trace-symbol} are equivalent. Note---there is one exception to
322 this rule. Multiple letter options that start with a lower case 'o' can
323 only be preceded by two dashes. This is to reduce confusion with the
324 @samp{-o} option. So for example @samp{-omagic} sets the output file
325 name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the
328 Arguments to multiple-letter options must either be separated from the
329 option name by an equals sign, or be given as separate arguments
330 immediately following the option that requires them. For example,
331 @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent.
332 Unique abbreviations of the names of multiple-letter options are
335 Note---if the linker is being invoked indirectly, via a compiler driver
336 (e.g. @samp{gcc}) then all the linker command-line options should be
337 prefixed by @samp{-Wl,} (or whatever is appropriate for the particular
338 compiler driver) like this:
341 gcc -Wl,--start-group foo.o bar.o -Wl,--end-group
344 This is important, because otherwise the compiler driver program may
345 silently drop the linker options, resulting in a bad link. Confusion
346 may also arise when passing options that require values through a
347 driver, as the use of a space between option and argument acts as
348 a separator, and causes the driver to pass only the option to the linker
349 and the argument to the compiler. In this case, it is simplest to use
350 the joined forms of both single- and multiple-letter options, such as:
353 gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map
356 Here is a table of the generic command-line switches accepted by the GNU
360 @include at-file.texi
362 @kindex -a @var{keyword}
363 @item -a @var{keyword}
364 This option is supported for HP/UX compatibility. The @var{keyword}
365 argument must be one of the strings @samp{archive}, @samp{shared}, or
366 @samp{default}. @samp{-aarchive} is functionally equivalent to
367 @samp{-Bstatic}, and the other two keywords are functionally equivalent
368 to @samp{-Bdynamic}. This option may be used any number of times.
370 @kindex --audit @var{AUDITLIB}
371 @item --audit @var{AUDITLIB}
372 Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section.
373 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
374 specified in the library. If specified multiple times @code{DT_AUDIT}
375 will contain a colon separated list of audit interfaces to use. If the linker
376 finds an object with an audit entry while searching for shared libraries,
377 it will add a corresponding @code{DT_DEPAUDIT} entry in the output file.
378 This option is only meaningful on ELF platforms supporting the rtld-audit
381 @ifclear SingleFormat
382 @cindex binary input format
383 @kindex -b @var{format}
384 @kindex --format=@var{format}
387 @item -b @var{input-format}
388 @itemx --format=@var{input-format}
389 @command{ld} may be configured to support more than one kind of object
390 file. If your @command{ld} is configured this way, you can use the
391 @samp{-b} option to specify the binary format for input object files
392 that follow this option on the command line. Even when @command{ld} is
393 configured to support alternative object formats, you don't usually need
394 to specify this, as @command{ld} should be configured to expect as a
395 default input format the most usual format on each machine.
396 @var{input-format} is a text string, the name of a particular format
397 supported by the BFD libraries. (You can list the available binary
398 formats with @samp{objdump -i}.)
401 You may want to use this option if you are linking files with an unusual
402 binary format. You can also use @samp{-b} to switch formats explicitly (when
403 linking object files of different formats), by including
404 @samp{-b @var{input-format}} before each group of object files in a
407 The default format is taken from the environment variable
412 You can also define the input format from a script, using the command
415 see @ref{Format Commands}.
419 @kindex -c @var{MRI-cmdfile}
420 @kindex --mri-script=@var{MRI-cmdfile}
421 @cindex compatibility, MRI
422 @item -c @var{MRI-commandfile}
423 @itemx --mri-script=@var{MRI-commandfile}
424 For compatibility with linkers produced by MRI, @command{ld} accepts script
425 files written in an alternate, restricted command language, described in
427 @ref{MRI,,MRI Compatible Script Files}.
430 the MRI Compatible Script Files section of GNU ld documentation.
432 Introduce MRI script files with
433 the option @samp{-c}; use the @samp{-T} option to run linker
434 scripts written in the general-purpose @command{ld} scripting language.
435 If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories
436 specified by any @samp{-L} options.
438 @cindex common allocation
445 These three options are equivalent; multiple forms are supported for
446 compatibility with other linkers. They assign space to common symbols
447 even if a relocatable output file is specified (with @samp{-r}). The
448 script command @code{FORCE_COMMON_ALLOCATION} has the same effect.
449 @xref{Miscellaneous Commands}.
451 @kindex --depaudit @var{AUDITLIB}
452 @kindex -P @var{AUDITLIB}
453 @item --depaudit @var{AUDITLIB}
454 @itemx -P @var{AUDITLIB}
455 Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section.
456 @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME
457 specified in the library. If specified multiple times @code{DT_DEPAUDIT}
458 will contain a colon separated list of audit interfaces to use. This
459 option is only meaningful on ELF platforms supporting the rtld-audit interface.
460 The -P option is provided for Solaris compatibility.
462 @cindex entry point, from command line
463 @kindex -e @var{entry}
464 @kindex --entry=@var{entry}
466 @itemx --entry=@var{entry}
467 Use @var{entry} as the explicit symbol for beginning execution of your
468 program, rather than the default entry point. If there is no symbol
469 named @var{entry}, the linker will try to parse @var{entry} as a number,
470 and use that as the entry address (the number will be interpreted in
471 base 10; you may use a leading @samp{0x} for base 16, or a leading
472 @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults
473 and other ways of specifying the entry point.
475 @kindex --exclude-libs
476 @item --exclude-libs @var{lib},@var{lib},...
477 Specifies a list of archive libraries from which symbols should not be automatically
478 exported. The library names may be delimited by commas or colons. Specifying
479 @code{--exclude-libs ALL} excludes symbols in all archive libraries from
480 automatic export. This option is available only for the i386 PE targeted
481 port of the linker and for ELF targeted ports. For i386 PE, symbols
482 explicitly listed in a .def file are still exported, regardless of this
483 option. For ELF targeted ports, symbols affected by this option will
484 be treated as hidden.
486 @kindex --exclude-modules-for-implib
487 @item --exclude-modules-for-implib @var{module},@var{module},...
488 Specifies a list of object files or archive members, from which symbols
489 should not be automatically exported, but which should be copied wholesale
490 into the import library being generated during the link. The module names
491 may be delimited by commas or colons, and must match exactly the filenames
492 used by @command{ld} to open the files; for archive members, this is simply
493 the member name, but for object files the name listed must include and
494 match precisely any path used to specify the input file on the linker's
495 command-line. This option is available only for the i386 PE targeted port
496 of the linker. Symbols explicitly listed in a .def file are still exported,
497 regardless of this option.
499 @cindex dynamic symbol table
501 @kindex --export-dynamic
502 @kindex --no-export-dynamic
504 @itemx --export-dynamic
505 @itemx --no-export-dynamic
506 When creating a dynamically linked executable, using the @option{-E}
507 option or the @option{--export-dynamic} option causes the linker to add
508 all symbols to the dynamic symbol table. The dynamic symbol table is the
509 set of symbols which are visible from dynamic objects at run time.
511 If you do not use either of these options (or use the
512 @option{--no-export-dynamic} option to restore the default behavior), the
513 dynamic symbol table will normally contain only those symbols which are
514 referenced by some dynamic object mentioned in the link.
516 If you use @code{dlopen} to load a dynamic object which needs to refer
517 back to the symbols defined by the program, rather than some other
518 dynamic object, then you will probably need to use this option when
519 linking the program itself.
521 You can also use the dynamic list to control what symbols should
522 be added to the dynamic symbol table if the output format supports it.
523 See the description of @samp{--dynamic-list}.
525 Note that this option is specific to ELF targeted ports. PE targets
526 support a similar function to export all symbols from a DLL or EXE; see
527 the description of @samp{--export-all-symbols} below.
529 @ifclear SingleFormat
530 @cindex big-endian objects
534 Link big-endian objects. This affects the default output format.
536 @cindex little-endian objects
539 Link little-endian objects. This affects the default output format.
542 @kindex -f @var{name}
543 @kindex --auxiliary=@var{name}
545 @itemx --auxiliary=@var{name}
546 When creating an ELF shared object, set the internal DT_AUXILIARY field
547 to the specified name. This tells the dynamic linker that the symbol
548 table of the shared object should be used as an auxiliary filter on the
549 symbol table of the shared object @var{name}.
551 If you later link a program against this filter object, then, when you
552 run the program, the dynamic linker will see the DT_AUXILIARY field. If
553 the dynamic linker resolves any symbols from the filter object, it will
554 first check whether there is a definition in the shared object
555 @var{name}. If there is one, it will be used instead of the definition
556 in the filter object. The shared object @var{name} need not exist.
557 Thus the shared object @var{name} may be used to provide an alternative
558 implementation of certain functions, perhaps for debugging or for
559 machine-specific performance.
561 This option may be specified more than once. The DT_AUXILIARY entries
562 will be created in the order in which they appear on the command line.
564 @kindex -F @var{name}
565 @kindex --filter=@var{name}
567 @itemx --filter=@var{name}
568 When creating an ELF shared object, set the internal DT_FILTER field to
569 the specified name. This tells the dynamic linker that the symbol table
570 of the shared object which is being created should be used as a filter
571 on the symbol table of the shared object @var{name}.
573 If you later link a program against this filter object, then, when you
574 run the program, the dynamic linker will see the DT_FILTER field. The
575 dynamic linker will resolve symbols according to the symbol table of the
576 filter object as usual, but it will actually link to the definitions
577 found in the shared object @var{name}. Thus the filter object can be
578 used to select a subset of the symbols provided by the object
581 Some older linkers used the @option{-F} option throughout a compilation
582 toolchain for specifying object-file format for both input and output
584 @ifclear SingleFormat
585 The @sc{gnu} linker uses other mechanisms for this purpose: the
586 @option{-b}, @option{--format}, @option{--oformat} options, the
587 @code{TARGET} command in linker scripts, and the @code{GNUTARGET}
588 environment variable.
590 The @sc{gnu} linker will ignore the @option{-F} option when not
591 creating an ELF shared object.
593 @cindex finalization function
594 @kindex -fini=@var{name}
595 @item -fini=@var{name}
596 When creating an ELF executable or shared object, call NAME when the
597 executable or shared object is unloaded, by setting DT_FINI to the
598 address of the function. By default, the linker uses @code{_fini} as
599 the function to call.
603 Ignored. Provided for compatibility with other tools.
605 @kindex -G @var{value}
606 @kindex --gpsize=@var{value}
609 @itemx --gpsize=@var{value}
610 Set the maximum size of objects to be optimized using the GP register to
611 @var{size}. This is only meaningful for object file formats such as
612 MIPS ELF that support putting large and small objects into different
613 sections. This is ignored for other object file formats.
615 @cindex runtime library name
616 @kindex -h @var{name}
617 @kindex -soname=@var{name}
619 @itemx -soname=@var{name}
620 When creating an ELF shared object, set the internal DT_SONAME field to
621 the specified name. When an executable is linked with a shared object
622 which has a DT_SONAME field, then when the executable is run the dynamic
623 linker will attempt to load the shared object specified by the DT_SONAME
624 field rather than the using the file name given to the linker.
627 @cindex incremental link
629 Perform an incremental link (same as option @samp{-r}).
631 @cindex initialization function
632 @kindex -init=@var{name}
633 @item -init=@var{name}
634 When creating an ELF executable or shared object, call NAME when the
635 executable or shared object is loaded, by setting DT_INIT to the address
636 of the function. By default, the linker uses @code{_init} as the
639 @cindex archive files, from cmd line
640 @kindex -l @var{namespec}
641 @kindex --library=@var{namespec}
642 @item -l @var{namespec}
643 @itemx --library=@var{namespec}
644 Add the archive or object file specified by @var{namespec} to the
645 list of files to link. This option may be used any number of times.
646 If @var{namespec} is of the form @file{:@var{filename}}, @command{ld}
647 will search the library path for a file called @var{filename}, otherwise it
648 will search the library path for a file called @file{lib@var{namespec}.a}.
650 On systems which support shared libraries, @command{ld} may also search for
651 files other than @file{lib@var{namespec}.a}. Specifically, on ELF
652 and SunOS systems, @command{ld} will search a directory for a library
653 called @file{lib@var{namespec}.so} before searching for one called
654 @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension
655 indicates a shared library.) Note that this behavior does not apply
656 to @file{:@var{filename}}, which always specifies a file called
659 The linker will search an archive only once, at the location where it is
660 specified on the command line. If the archive defines a symbol which
661 was undefined in some object which appeared before the archive on the
662 command line, the linker will include the appropriate file(s) from the
663 archive. However, an undefined symbol in an object appearing later on
664 the command line will not cause the linker to search the archive again.
666 See the @option{-(} option for a way to force the linker to search
667 archives multiple times.
669 You may list the same archive multiple times on the command line.
672 This type of archive searching is standard for Unix linkers. However,
673 if you are using @command{ld} on AIX, note that it is different from the
674 behaviour of the AIX linker.
677 @cindex search directory, from cmd line
679 @kindex --library-path=@var{dir}
680 @item -L @var{searchdir}
681 @itemx --library-path=@var{searchdir}
682 Add path @var{searchdir} to the list of paths that @command{ld} will search
683 for archive libraries and @command{ld} control scripts. You may use this
684 option any number of times. The directories are searched in the order
685 in which they are specified on the command line. Directories specified
686 on the command line are searched before the default directories. All
687 @option{-L} options apply to all @option{-l} options, regardless of the
688 order in which the options appear. @option{-L} options do not affect
689 how @command{ld} searches for a linker script unless @option{-T}
692 If @var{searchdir} begins with @code{=} or @code{$SYSROOT}, then this
693 prefix will be replaced by the @dfn{sysroot prefix}, controlled by the
694 @samp{--sysroot} option, or specified when the linker is configured.
697 The default set of paths searched (without being specified with
698 @samp{-L}) depends on which emulation mode @command{ld} is using, and in
699 some cases also on how it was configured. @xref{Environment}.
702 The paths can also be specified in a link script with the
703 @code{SEARCH_DIR} command. Directories specified this way are searched
704 at the point in which the linker script appears in the command line.
707 @kindex -m @var{emulation}
708 @item -m @var{emulation}
709 Emulate the @var{emulation} linker. You can list the available
710 emulations with the @samp{--verbose} or @samp{-V} options.
712 If the @samp{-m} option is not used, the emulation is taken from the
713 @code{LDEMULATION} environment variable, if that is defined.
715 Otherwise, the default emulation depends upon how the linker was
723 Print a link map to the standard output. A link map provides
724 information about the link, including the following:
728 Where object files are mapped into memory.
730 How common symbols are allocated.
732 All archive members included in the link, with a mention of the symbol
733 which caused the archive member to be brought in.
735 The values assigned to symbols.
737 Note - symbols whose values are computed by an expression which
738 involves a reference to a previous value of the same symbol may not
739 have correct result displayed in the link map. This is because the
740 linker discards intermediate results and only retains the final value
741 of an expression. Under such circumstances the linker will display
742 the final value enclosed by square brackets. Thus for example a
743 linker script containing:
751 will produce the following output in the link map if the @option{-M}
756 [0x0000000c] foo = (foo * 0x4)
757 [0x0000000c] foo = (foo + 0x8)
760 See @ref{Expressions} for more information about expressions in linker
764 How GNU properties are merged.
766 When the linker merges input .note.gnu.property sections into one output
767 .note.gnu.property section, some properties are removed or updated.
768 These actions are reported in the link map. For example:
771 Removed property 0xc0000002 to merge foo.o (0x1) and bar.o (not found)
774 This indicates that property 0xc0000002 is removed from output when
775 merging properties in @file{foo.o}, whose property 0xc0000002 value
776 is 0x1, and @file{bar.o}, which doesn't have property 0xc0000002.
779 Updated property 0xc0010001 (0x1) to merge foo.o (0x1) and bar.o (0x1)
782 This indicates that property 0xc0010001 value is updated to 0x1 in output
783 when merging properties in @file{foo.o}, whose 0xc0010001 property value
784 is 0x1, and @file{bar.o}, whose 0xc0010001 property value is 0x1.
787 @cindex link map discarded
788 @kindex --print-map-discarded
789 @kindex --no-print-map-discarded
790 @item --print-map-discarded
791 @itemx --no-print-map-discarded
792 Print (or do not print) the list of discarded and garbage collected sections
793 in the link map. Enabled by default.
796 @cindex read-only text
801 Turn off page alignment of sections, and disable linking against shared
802 libraries. If the output format supports Unix style magic numbers,
803 mark the output as @code{NMAGIC}.
807 @cindex read/write from cmd line
811 Set the text and data sections to be readable and writable. Also, do
812 not page-align the data segment, and disable linking against shared
813 libraries. If the output format supports Unix style magic numbers,
814 mark the output as @code{OMAGIC}. Note: Although a writable text section
815 is allowed for PE-COFF targets, it does not conform to the format
816 specification published by Microsoft.
821 This option negates most of the effects of the @option{-N} option. It
822 sets the text section to be read-only, and forces the data segment to
823 be page-aligned. Note - this option does not enable linking against
824 shared libraries. Use @option{-Bdynamic} for this.
826 @kindex -o @var{output}
827 @kindex --output=@var{output}
828 @cindex naming the output file
829 @item -o @var{output}
830 @itemx --output=@var{output}
831 Use @var{output} as the name for the program produced by @command{ld}; if this
832 option is not specified, the name @file{a.out} is used by default. The
833 script command @code{OUTPUT} can also specify the output file name.
835 @kindex -O @var{level}
836 @cindex generating optimized output
838 If @var{level} is a numeric values greater than zero @command{ld} optimizes
839 the output. This might take significantly longer and therefore probably
840 should only be enabled for the final binary. At the moment this
841 option only affects ELF shared library generation. Future releases of
842 the linker may make more use of this option. Also currently there is
843 no difference in the linker's behaviour for different non-zero values
844 of this option. Again this may change with future releases.
846 @kindex -plugin @var{name}
847 @item -plugin @var{name}
848 Involve a plugin in the linking process. The @var{name} parameter is
849 the absolute filename of the plugin. Usually this parameter is
850 automatically added by the complier, when using link time
851 optimization, but users can also add their own plugins if they so
854 Note that the location of the compiler originated plugins is different
855 from the place where the @command{ar}, @command{nm} and
856 @command{ranlib} programs search for their plugins. In order for
857 those commands to make use of a compiler based plugin it must first be
858 copied into the @file{$@{libdir@}/bfd-plugins} directory. All gcc
859 based linker plugins are backward compatible, so it is sufficient to
860 just copy in the newest one.
863 @cindex push state governing input file handling
865 The @option{--push-state} allows to preserve the current state of the
866 flags which govern the input file handling so that they can all be
867 restored with one corresponding @option{--pop-state} option.
869 The option which are covered are: @option{-Bdynamic}, @option{-Bstatic},
870 @option{-dn}, @option{-dy}, @option{-call_shared}, @option{-non_shared},
871 @option{-static}, @option{-N}, @option{-n}, @option{--whole-archive},
872 @option{--no-whole-archive}, @option{-r}, @option{-Ur},
873 @option{--copy-dt-needed-entries}, @option{--no-copy-dt-needed-entries},
874 @option{--as-needed}, @option{--no-as-needed}, and @option{-a}.
876 One target for this option are specifications for @file{pkg-config}. When
877 used with the @option{--libs} option all possibly needed libraries are
878 listed and then possibly linked with all the time. It is better to return
879 something as follows:
882 -Wl,--push-state,--as-needed -libone -libtwo -Wl,--pop-state
886 @cindex pop state governing input file handling
888 Undoes the effect of --push-state, restores the previous values of the
889 flags governing input file handling.
892 @kindex --emit-relocs
893 @cindex retain relocations in final executable
896 Leave relocation sections and contents in fully linked executables.
897 Post link analysis and optimization tools may need this information in
898 order to perform correct modifications of executables. This results
899 in larger executables.
901 This option is currently only supported on ELF platforms.
903 @kindex --force-dynamic
904 @cindex forcing the creation of dynamic sections
905 @item --force-dynamic
906 Force the output file to have dynamic sections. This option is specific
910 @cindex relocatable output
912 @kindex --relocatable
915 Generate relocatable output---i.e., generate an output file that can in
916 turn serve as input to @command{ld}. This is often called @dfn{partial
917 linking}. As a side effect, in environments that support standard Unix
918 magic numbers, this option also sets the output file's magic number to
920 @c ; see @option{-N}.
921 If this option is not specified, an absolute file is produced. When
922 linking C++ programs, this option @emph{will not} resolve references to
923 constructors; to do that, use @samp{-Ur}.
925 When an input file does not have the same format as the output file,
926 partial linking is only supported if that input file does not contain any
927 relocations. Different output formats can have further restrictions; for
928 example some @code{a.out}-based formats do not support partial linking
929 with input files in other formats at all.
931 This option does the same thing as @samp{-i}.
933 @kindex -R @var{file}
934 @kindex --just-symbols=@var{file}
935 @cindex symbol-only input
936 @item -R @var{filename}
937 @itemx --just-symbols=@var{filename}
938 Read symbol names and their addresses from @var{filename}, but do not
939 relocate it or include it in the output. This allows your output file
940 to refer symbolically to absolute locations of memory defined in other
941 programs. You may use this option more than once.
943 For compatibility with other ELF linkers, if the @option{-R} option is
944 followed by a directory name, rather than a file name, it is treated as
945 the @option{-rpath} option.
949 @cindex strip all symbols
952 Omit all symbol information from the output file.
955 @kindex --strip-debug
956 @cindex strip debugger symbols
959 Omit debugger symbol information (but not all symbols) from the output file.
961 @kindex --strip-discarded
962 @kindex --no-strip-discarded
963 @item --strip-discarded
964 @itemx --no-strip-discarded
965 Omit (or do not omit) global symbols defined in discarded sections.
970 @cindex input files, displaying
973 Print the names of the input files as @command{ld} processes them. If
974 @samp{-t} is given twice then members within archives are also printed.
975 @samp{-t} output is useful to generate a list of all the object files
976 and scripts involved in linking, for example, when packaging files for
979 @kindex -T @var{script}
980 @kindex --script=@var{script}
982 @item -T @var{scriptfile}
983 @itemx --script=@var{scriptfile}
984 Use @var{scriptfile} as the linker script. This script replaces
985 @command{ld}'s default linker script (rather than adding to it), so
986 @var{commandfile} must specify everything necessary to describe the
987 output file. @xref{Scripts}. If @var{scriptfile} does not exist in
988 the current directory, @code{ld} looks for it in the directories
989 specified by any preceding @samp{-L} options. Multiple @samp{-T}
992 @kindex -dT @var{script}
993 @kindex --default-script=@var{script}
995 @item -dT @var{scriptfile}
996 @itemx --default-script=@var{scriptfile}
997 Use @var{scriptfile} as the default linker script. @xref{Scripts}.
999 This option is similar to the @option{--script} option except that
1000 processing of the script is delayed until after the rest of the
1001 command line has been processed. This allows options placed after the
1002 @option{--default-script} option on the command line to affect the
1003 behaviour of the linker script, which can be important when the linker
1004 command line cannot be directly controlled by the user. (eg because
1005 the command line is being constructed by another tool, such as
1008 @kindex -u @var{symbol}
1009 @kindex --undefined=@var{symbol}
1010 @cindex undefined symbol
1011 @item -u @var{symbol}
1012 @itemx --undefined=@var{symbol}
1013 Force @var{symbol} to be entered in the output file as an undefined
1014 symbol. Doing this may, for example, trigger linking of additional
1015 modules from standard libraries. @samp{-u} may be repeated with
1016 different option arguments to enter additional undefined symbols. This
1017 option is equivalent to the @code{EXTERN} linker script command.
1019 If this option is being used to force additional modules to be pulled
1020 into the link, and if it is an error for the symbol to remain
1021 undefined, then the option @option{--require-defined} should be used
1024 @kindex --require-defined=@var{symbol}
1025 @cindex symbols, require defined
1026 @cindex defined symbol
1027 @item --require-defined=@var{symbol}
1028 Require that @var{symbol} is defined in the output file. This option
1029 is the same as option @option{--undefined} except that if @var{symbol}
1030 is not defined in the output file then the linker will issue an error
1031 and exit. The same effect can be achieved in a linker script by using
1032 @code{EXTERN}, @code{ASSERT} and @code{DEFINED} together. This option
1033 can be used multiple times to require additional symbols.
1036 @cindex constructors
1038 For anything other than C++ programs, this option is equivalent to
1039 @samp{-r}: it generates relocatable output---i.e., an output file that can in
1040 turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur}
1041 @emph{does} resolve references to constructors, unlike @samp{-r}.
1042 It does not work to use @samp{-Ur} on files that were themselves linked
1043 with @samp{-Ur}; once the constructor table has been built, it cannot
1044 be added to. Use @samp{-Ur} only for the last partial link, and
1045 @samp{-r} for the others.
1047 @kindex --orphan-handling=@var{MODE}
1048 @cindex orphan sections
1049 @cindex sections, orphan
1050 @item --orphan-handling=@var{MODE}
1051 Control how orphan sections are handled. An orphan section is one not
1052 specifically mentioned in a linker script. @xref{Orphan Sections}.
1054 @var{MODE} can have any of the following values:
1058 Orphan sections are placed into a suitable output section following
1059 the strategy described in @ref{Orphan Sections}. The option
1060 @samp{--unique} also affects how sections are placed.
1063 All orphan sections are discarded, by placing them in the
1064 @samp{/DISCARD/} section (@pxref{Output Section Discarding}).
1067 The linker will place the orphan section as for @code{place} and also
1071 The linker will exit with an error if any orphan section is found.
1074 The default if @samp{--orphan-handling} is not given is @code{place}.
1076 @kindex --unique[=@var{SECTION}]
1077 @item --unique[=@var{SECTION}]
1078 Creates a separate output section for every input section matching
1079 @var{SECTION}, or if the optional wildcard @var{SECTION} argument is
1080 missing, for every orphan input section. An orphan section is one not
1081 specifically mentioned in a linker script. You may use this option
1082 multiple times on the command line; It prevents the normal merging of
1083 input sections with the same name, overriding output section assignments
1093 Display the version number for @command{ld}. The @option{-V} option also
1094 lists the supported emulations.
1097 @kindex --discard-all
1098 @cindex deleting local symbols
1100 @itemx --discard-all
1101 Delete all local symbols.
1104 @kindex --discard-locals
1105 @cindex local symbols, deleting
1107 @itemx --discard-locals
1108 Delete all temporary local symbols. (These symbols start with
1109 system-specific local label prefixes, typically @samp{.L} for ELF systems
1110 or @samp{L} for traditional a.out systems.)
1112 @kindex -y @var{symbol}
1113 @kindex --trace-symbol=@var{symbol}
1114 @cindex symbol tracing
1115 @item -y @var{symbol}
1116 @itemx --trace-symbol=@var{symbol}
1117 Print the name of each linked file in which @var{symbol} appears. This
1118 option may be given any number of times. On many systems it is necessary
1119 to prepend an underscore.
1121 This option is useful when you have an undefined symbol in your link but
1122 don't know where the reference is coming from.
1124 @kindex -Y @var{path}
1126 Add @var{path} to the default library search path. This option exists
1127 for Solaris compatibility.
1129 @kindex -z @var{keyword}
1130 @item -z @var{keyword}
1131 The recognized keywords are:
1135 Always generate BND prefix in PLT entries. Supported for Linux/x86_64.
1137 @item call-nop=prefix-addr
1138 @itemx call-nop=suffix-nop
1139 @itemx call-nop=prefix-@var{byte}
1140 @itemx call-nop=suffix-@var{byte}
1141 Specify the 1-byte @code{NOP} padding when transforming indirect call
1142 to a locally defined function, foo, via its GOT slot.
1143 @option{call-nop=prefix-addr} generates @code{0x67 call foo}.
1144 @option{call-nop=suffix-nop} generates @code{call foo 0x90}.
1145 @option{call-nop=prefix-@var{byte}} generates @code{@var{byte} call foo}.
1146 @option{call-nop=suffix-@var{byte}} generates @code{call foo @var{byte}}.
1147 Supported for i386 and x86_64.
1149 @item cet-report=none
1150 @itemx cet-report=warning
1151 @itemx cet-report=error
1152 Specify how to report the missing GNU_PROPERTY_X86_FEATURE_1_IBT and
1153 GNU_PROPERTY_X86_FEATURE_1_SHSTK properties in input .note.gnu.property
1154 section. @option{cet-report=none}, which is the default, will make the
1155 linker not report missing properties in input files.
1156 @option{cet-report=warning} will make the linker issue a warning for
1157 missing properties in input files. @option{cet-report=error} will make
1158 the linker issue an error for missing properties in input files.
1159 Note that @option{ibt} will turn off the missing
1160 GNU_PROPERTY_X86_FEATURE_1_IBT property report and @option{shstk} will
1161 turn off the missing GNU_PROPERTY_X86_FEATURE_1_SHSTK property report.
1162 Supported for Linux/i386 and Linux/x86_64.
1166 Combine multiple dynamic relocation sections and sort to improve
1167 dynamic symbol lookup caching. Do not do this if @samp{nocombreloc}.
1171 Generate common symbols with STT_COMMON type during a relocatable
1172 link. Use STT_OBJECT type if @samp{nocommon}.
1174 @item common-page-size=@var{value}
1175 Set the page size most commonly used to @var{value}. Memory image
1176 layout will be optimized to minimize memory pages if the system is
1177 using pages of this size.
1180 Report unresolved symbol references from regular object files. This
1181 is done even if the linker is creating a non-symbolic shared library.
1182 This option is the inverse of @samp{-z undefs}.
1184 @item dynamic-undefined-weak
1185 @itemx nodynamic-undefined-weak
1186 Make undefined weak symbols dynamic when building a dynamic object,
1187 if they are referenced from a regular object file and not forced local
1188 by symbol visibility or versioning. Do not make them dynamic if
1189 @samp{nodynamic-undefined-weak}. If neither option is given, a target
1190 may default to either option being in force, or make some other
1191 selection of undefined weak symbols dynamic. Not all targets support
1195 Marks the object as requiring executable stack.
1198 This option is only meaningful when building a shared object. It makes
1199 the symbols defined by this shared object available for symbol resolution
1200 of subsequently loaded libraries.
1203 This option is only meaningful when building a dynamic executable.
1204 This option marks the executable as requiring global auditing by
1205 setting the @code{DF_1_GLOBAUDIT} bit in the @code{DT_FLAGS_1} dynamic
1206 tag. Global auditing requires that any auditing library defined via
1207 the @option{--depaudit} or @option{-P} command-line options be run for
1208 all dynamic objects loaded by the application.
1211 Generate Intel Indirect Branch Tracking (IBT) enabled PLT entries.
1212 Supported for Linux/i386 and Linux/x86_64.
1215 Generate GNU_PROPERTY_X86_FEATURE_1_IBT in .note.gnu.property section
1216 to indicate compatibility with IBT. This also implies @option{ibtplt}.
1217 Supported for Linux/i386 and Linux/x86_64.
1220 This option is only meaningful when building a shared object.
1221 It marks the object so that its runtime initialization will occur
1222 before the runtime initialization of any other objects brought into
1223 the process at the same time. Similarly the runtime finalization of
1224 the object will occur after the runtime finalization of any other
1228 Specify that the dynamic loader should modify its symbol search order
1229 so that symbols in this shared library interpose all other shared
1230 libraries not so marked.
1233 When generating an executable or shared library, mark it to tell the
1234 dynamic linker to defer function call resolution to the point when
1235 the function is called (lazy binding), rather than at load time.
1236 Lazy binding is the default.
1239 Specify that the object's filters be processed immediately at runtime.
1241 @item max-page-size=@var{value}
1242 Set the maximum memory page size supported to @var{value}.
1245 Allow multiple definitions.
1248 Disable linker generated .dynbss variables used in place of variables
1249 defined in shared libraries. May result in dynamic text relocations.
1252 Specify that the dynamic loader search for dependencies of this object
1253 should ignore any default library search paths.
1256 Specify that the object shouldn't be unloaded at runtime.
1259 Specify that the object is not available to @code{dlopen}.
1262 Specify that the object can not be dumped by @code{dldump}.
1265 Marks the object as not requiring executable stack.
1267 @item noextern-protected-data
1268 Don't treat protected data symbols as external when building a shared
1269 library. This option overrides the linker backend default. It can be
1270 used to work around incorrect relocations against protected data symbols
1271 generated by compiler. Updates on protected data symbols by another
1272 module aren't visible to the resulting shared library. Supported for
1275 @item noreloc-overflow
1276 Disable relocation overflow check. This can be used to disable
1277 relocation overflow check if there will be no dynamic relocation
1278 overflow at run-time. Supported for x86_64.
1281 When generating an executable or shared library, mark it to tell the
1282 dynamic linker to resolve all symbols when the program is started, or
1283 when the shared library is loaded by dlopen, instead of deferring
1284 function call resolution to the point when the function is first
1288 Specify that the object requires @samp{$ORIGIN} handling in paths.
1292 Create an ELF @code{PT_GNU_RELRO} segment header in the object. This
1293 specifies a memory segment that should be made read-only after
1294 relocation, if supported. Specifying @samp{common-page-size} smaller
1295 than the system page size will render this protection ineffective.
1296 Don't create an ELF @code{PT_GNU_RELRO} segment if @samp{norelro}.
1299 @itemx noseparate-code
1300 Create separate code @code{PT_LOAD} segment header in the object. This
1301 specifies a memory segment that should contain only instructions and must
1302 be in wholly disjoint pages from any other data. Don't create separate
1303 code @code{PT_LOAD} segment if @samp{noseparate-code} is used.
1306 Generate GNU_PROPERTY_X86_FEATURE_1_SHSTK in .note.gnu.property section
1307 to indicate compatibility with Intel Shadow Stack. Supported for
1308 Linux/i386 and Linux/x86_64.
1310 @item stack-size=@var{value}
1311 Specify a stack size for an ELF @code{PT_GNU_STACK} segment.
1312 Specifying zero will override any default non-zero sized
1313 @code{PT_GNU_STACK} segment creation.
1318 Report an error if DT_TEXTREL is set, i.e., if the binary has dynamic
1319 relocations in read-only sections. Don't report an error if
1320 @samp{notext} or @samp{textoff}.
1323 Do not report unresolved symbol references from regular object files,
1324 either when creating an executable, or when creating a shared library.
1325 This option is the inverse of @samp{-z defs}.
1329 Other keywords are ignored for Solaris compatibility.
1332 @cindex groups of archives
1333 @item -( @var{archives} -)
1334 @itemx --start-group @var{archives} --end-group
1335 The @var{archives} should be a list of archive files. They may be
1336 either explicit file names, or @samp{-l} options.
1338 The specified archives are searched repeatedly until no new undefined
1339 references are created. Normally, an archive is searched only once in
1340 the order that it is specified on the command line. If a symbol in that
1341 archive is needed to resolve an undefined symbol referred to by an
1342 object in an archive that appears later on the command line, the linker
1343 would not be able to resolve that reference. By grouping the archives,
1344 they will all be searched repeatedly until all possible references are
1347 Using this option has a significant performance cost. It is best to use
1348 it only when there are unavoidable circular references between two or
1351 @kindex --accept-unknown-input-arch
1352 @kindex --no-accept-unknown-input-arch
1353 @item --accept-unknown-input-arch
1354 @itemx --no-accept-unknown-input-arch
1355 Tells the linker to accept input files whose architecture cannot be
1356 recognised. The assumption is that the user knows what they are doing
1357 and deliberately wants to link in these unknown input files. This was
1358 the default behaviour of the linker, before release 2.14. The default
1359 behaviour from release 2.14 onwards is to reject such input files, and
1360 so the @samp{--accept-unknown-input-arch} option has been added to
1361 restore the old behaviour.
1364 @kindex --no-as-needed
1366 @itemx --no-as-needed
1367 This option affects ELF DT_NEEDED tags for dynamic libraries mentioned
1368 on the command line after the @option{--as-needed} option. Normally
1369 the linker will add a DT_NEEDED tag for each dynamic library mentioned
1370 on the command line, regardless of whether the library is actually
1371 needed or not. @option{--as-needed} causes a DT_NEEDED tag to only be
1372 emitted for a library that @emph{at that point in the link} satisfies a
1373 non-weak undefined symbol reference from a regular object file or, if
1374 the library is not found in the DT_NEEDED lists of other needed libraries, a
1375 non-weak undefined symbol reference from another needed dynamic library.
1376 Object files or libraries appearing on the command line @emph{after}
1377 the library in question do not affect whether the library is seen as
1378 needed. This is similar to the rules for extraction of object files
1379 from archives. @option{--no-as-needed} restores the default behaviour.
1381 @kindex --add-needed
1382 @kindex --no-add-needed
1384 @itemx --no-add-needed
1385 These two options have been deprecated because of the similarity of
1386 their names to the @option{--as-needed} and @option{--no-as-needed}
1387 options. They have been replaced by @option{--copy-dt-needed-entries}
1388 and @option{--no-copy-dt-needed-entries}.
1390 @kindex -assert @var{keyword}
1391 @item -assert @var{keyword}
1392 This option is ignored for SunOS compatibility.
1396 @kindex -call_shared
1400 Link against dynamic libraries. This is only meaningful on platforms
1401 for which shared libraries are supported. This option is normally the
1402 default on such platforms. The different variants of this option are
1403 for compatibility with various systems. You may use this option
1404 multiple times on the command line: it affects library searching for
1405 @option{-l} options which follow it.
1409 Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic
1410 section. This causes the runtime linker to handle lookups in this
1411 object and its dependencies to be performed only inside the group.
1412 @option{--unresolved-symbols=report-all} is implied. This option is
1413 only meaningful on ELF platforms which support shared libraries.
1423 Do not link against shared libraries. This is only meaningful on
1424 platforms for which shared libraries are supported. The different
1425 variants of this option are for compatibility with various systems. You
1426 may use this option multiple times on the command line: it affects
1427 library searching for @option{-l} options which follow it. This
1428 option also implies @option{--unresolved-symbols=report-all}. This
1429 option can be used with @option{-shared}. Doing so means that a
1430 shared library is being created but that all of the library's external
1431 references must be resolved by pulling in entries from static
1436 When creating a shared library, bind references to global symbols to the
1437 definition within the shared library, if any. Normally, it is possible
1438 for a program linked against a shared library to override the definition
1439 within the shared library. This option is only meaningful on ELF
1440 platforms which support shared libraries.
1442 @kindex -Bsymbolic-functions
1443 @item -Bsymbolic-functions
1444 When creating a shared library, bind references to global function
1445 symbols to the definition within the shared library, if any.
1446 This option is only meaningful on ELF platforms which support shared
1449 @kindex --dynamic-list=@var{dynamic-list-file}
1450 @item --dynamic-list=@var{dynamic-list-file}
1451 Specify the name of a dynamic list file to the linker. This is
1452 typically used when creating shared libraries to specify a list of
1453 global symbols whose references shouldn't be bound to the definition
1454 within the shared library, or creating dynamically linked executables
1455 to specify a list of symbols which should be added to the symbol table
1456 in the executable. This option is only meaningful on ELF platforms
1457 which support shared libraries.
1459 The format of the dynamic list is the same as the version node without
1460 scope and node name. See @ref{VERSION} for more information.
1462 @kindex --dynamic-list-data
1463 @item --dynamic-list-data
1464 Include all global data symbols to the dynamic list.
1466 @kindex --dynamic-list-cpp-new
1467 @item --dynamic-list-cpp-new
1468 Provide the builtin dynamic list for C++ operator new and delete. It
1469 is mainly useful for building shared libstdc++.
1471 @kindex --dynamic-list-cpp-typeinfo
1472 @item --dynamic-list-cpp-typeinfo
1473 Provide the builtin dynamic list for C++ runtime type identification.
1475 @kindex --check-sections
1476 @kindex --no-check-sections
1477 @item --check-sections
1478 @itemx --no-check-sections
1479 Asks the linker @emph{not} to check section addresses after they have
1480 been assigned to see if there are any overlaps. Normally the linker will
1481 perform this check, and if it finds any overlaps it will produce
1482 suitable error messages. The linker does know about, and does make
1483 allowances for sections in overlays. The default behaviour can be
1484 restored by using the command-line switch @option{--check-sections}.
1485 Section overlap is not usually checked for relocatable links. You can
1486 force checking in that case by using the @option{--check-sections}
1489 @kindex --copy-dt-needed-entries
1490 @kindex --no-copy-dt-needed-entries
1491 @item --copy-dt-needed-entries
1492 @itemx --no-copy-dt-needed-entries
1493 This option affects the treatment of dynamic libraries referred to
1494 by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the
1495 command line. Normally the linker won't add a DT_NEEDED tag to the
1496 output binary for each library mentioned in a DT_NEEDED tag in an
1497 input dynamic library. With @option{--copy-dt-needed-entries}
1498 specified on the command line however any dynamic libraries that
1499 follow it will have their DT_NEEDED entries added. The default
1500 behaviour can be restored with @option{--no-copy-dt-needed-entries}.
1502 This option also has an effect on the resolution of symbols in dynamic
1503 libraries. With @option{--copy-dt-needed-entries} dynamic libraries
1504 mentioned on the command line will be recursively searched, following
1505 their DT_NEEDED tags to other libraries, in order to resolve symbols
1506 required by the output binary. With the default setting however
1507 the searching of dynamic libraries that follow it will stop with the
1508 dynamic library itself. No DT_NEEDED links will be traversed to resolve
1511 @cindex cross reference table
1514 Output a cross reference table. If a linker map file is being
1515 generated, the cross reference table is printed to the map file.
1516 Otherwise, it is printed on the standard output.
1518 The format of the table is intentionally simple, so that it may be
1519 easily processed by a script if necessary. The symbols are printed out,
1520 sorted by name. For each symbol, a list of file names is given. If the
1521 symbol is defined, the first file listed is the location of the
1522 definition. If the symbol is defined as a common value then any files
1523 where this happens appear next. Finally any files that reference the
1526 @cindex common allocation
1527 @kindex --no-define-common
1528 @item --no-define-common
1529 This option inhibits the assignment of addresses to common symbols.
1530 The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect.
1531 @xref{Miscellaneous Commands}.
1533 The @samp{--no-define-common} option allows decoupling
1534 the decision to assign addresses to Common symbols from the choice
1535 of the output file type; otherwise a non-Relocatable output type
1536 forces assigning addresses to Common symbols.
1537 Using @samp{--no-define-common} allows Common symbols that are referenced
1538 from a shared library to be assigned addresses only in the main program.
1539 This eliminates the unused duplicate space in the shared library,
1540 and also prevents any possible confusion over resolving to the wrong
1541 duplicate when there are many dynamic modules with specialized search
1542 paths for runtime symbol resolution.
1544 @cindex group allocation in linker script
1545 @cindex section groups
1547 @kindex --force-group-allocation
1548 @item --force-group-allocation
1549 This option causes the linker to place section group members like
1550 normal input sections, and to delete the section groups. This is the
1551 default behaviour for a final link but this option can be used to
1552 change the behaviour of a relocatable link (@samp{-r}). The script
1553 command @code{FORCE_GROUP_ALLOCATION} has the same
1554 effect. @xref{Miscellaneous Commands}.
1556 @cindex symbols, from command line
1557 @kindex --defsym=@var{symbol}=@var{exp}
1558 @item --defsym=@var{symbol}=@var{expression}
1559 Create a global symbol in the output file, containing the absolute
1560 address given by @var{expression}. You may use this option as many
1561 times as necessary to define multiple symbols in the command line. A
1562 limited form of arithmetic is supported for the @var{expression} in this
1563 context: you may give a hexadecimal constant or the name of an existing
1564 symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
1565 constants or symbols. If you need more elaborate expressions, consider
1566 using the linker command language from a script (@pxref{Assignments}).
1567 @emph{Note:} there should be no white space between @var{symbol}, the
1568 equals sign (``@key{=}''), and @var{expression}.
1570 @cindex demangling, from command line
1571 @kindex --demangle[=@var{style}]
1572 @kindex --no-demangle
1573 @item --demangle[=@var{style}]
1574 @itemx --no-demangle
1575 These options control whether to demangle symbol names in error messages
1576 and other output. When the linker is told to demangle, it tries to
1577 present symbol names in a readable fashion: it strips leading
1578 underscores if they are used by the object file format, and converts C++
1579 mangled symbol names into user readable names. Different compilers have
1580 different mangling styles. The optional demangling style argument can be used
1581 to choose an appropriate demangling style for your compiler. The linker will
1582 demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE}
1583 is set. These options may be used to override the default.
1585 @cindex dynamic linker, from command line
1586 @kindex -I@var{file}
1587 @kindex --dynamic-linker=@var{file}
1589 @itemx --dynamic-linker=@var{file}
1590 Set the name of the dynamic linker. This is only meaningful when
1591 generating dynamically linked ELF executables. The default dynamic
1592 linker is normally correct; don't use this unless you know what you are
1595 @kindex --no-dynamic-linker
1596 @item --no-dynamic-linker
1597 When producing an executable file, omit the request for a dynamic
1598 linker to be used at load-time. This is only meaningful for ELF
1599 executables that contain dynamic relocations, and usually requires
1600 entry point code that is capable of processing these relocations.
1602 @kindex --embedded-relocs
1603 @item --embedded-relocs
1604 This option is similar to the @option{--emit-relocs} option except
1605 that the relocs are stored in a target-specific section. This option
1606 is only supported by the @samp{BFIN}, @samp{CR16} and @emph{M68K}
1609 @kindex --disable-multiple-abs-defs
1610 @item --disable-multiple-abs-defs
1611 Do not allow multiple definitions with symbols included
1612 in filename invoked by -R or --just-symbols
1614 @kindex --fatal-warnings
1615 @kindex --no-fatal-warnings
1616 @item --fatal-warnings
1617 @itemx --no-fatal-warnings
1618 Treat all warnings as errors. The default behaviour can be restored
1619 with the option @option{--no-fatal-warnings}.
1621 @kindex --force-exe-suffix
1622 @item --force-exe-suffix
1623 Make sure that an output file has a .exe suffix.
1625 If a successfully built fully linked output file does not have a
1626 @code{.exe} or @code{.dll} suffix, this option forces the linker to copy
1627 the output file to one of the same name with a @code{.exe} suffix. This
1628 option is useful when using unmodified Unix makefiles on a Microsoft
1629 Windows host, since some versions of Windows won't run an image unless
1630 it ends in a @code{.exe} suffix.
1632 @kindex --gc-sections
1633 @kindex --no-gc-sections
1634 @cindex garbage collection
1636 @itemx --no-gc-sections
1637 Enable garbage collection of unused input sections. It is ignored on
1638 targets that do not support this option. The default behaviour (of not
1639 performing this garbage collection) can be restored by specifying
1640 @samp{--no-gc-sections} on the command line. Note that garbage
1641 collection for COFF and PE format targets is supported, but the
1642 implementation is currently considered to be experimental.
1644 @samp{--gc-sections} decides which input sections are used by
1645 examining symbols and relocations. The section containing the entry
1646 symbol and all sections containing symbols undefined on the
1647 command-line will be kept, as will sections containing symbols
1648 referenced by dynamic objects. Note that when building shared
1649 libraries, the linker must assume that any visible symbol is
1650 referenced. Once this initial set of sections has been determined,
1651 the linker recursively marks as used any section referenced by their
1652 relocations. See @samp{--entry}, @samp{--undefined}, and
1653 @samp{--gc-keep-exported}.
1655 This option can be set when doing a partial link (enabled with option
1656 @samp{-r}). In this case the root of symbols kept must be explicitly
1657 specified either by one of the options @samp{--entry},
1658 @samp{--undefined}, or @samp{--gc-keep-exported} or by a @code{ENTRY}
1659 command in the linker script.
1661 @kindex --print-gc-sections
1662 @kindex --no-print-gc-sections
1663 @cindex garbage collection
1664 @item --print-gc-sections
1665 @itemx --no-print-gc-sections
1666 List all sections removed by garbage collection. The listing is
1667 printed on stderr. This option is only effective if garbage
1668 collection has been enabled via the @samp{--gc-sections}) option. The
1669 default behaviour (of not listing the sections that are removed) can
1670 be restored by specifying @samp{--no-print-gc-sections} on the command
1673 @kindex --gc-keep-exported
1674 @cindex garbage collection
1675 @item --gc-keep-exported
1676 When @samp{--gc-sections} is enabled, this option prevents garbage
1677 collection of unused input sections that contain global symbols having
1678 default or protected visibility. This option is intended to be used for
1679 executables where unreferenced sections would otherwise be garbage
1680 collected regardless of the external visibility of contained symbols.
1681 Note that this option has no effect when linking shared objects since
1682 it is already the default behaviour. This option is only supported for
1685 @kindex --print-output-format
1686 @cindex output format
1687 @item --print-output-format
1688 Print the name of the default output format (perhaps influenced by
1689 other command-line options). This is the string that would appear
1690 in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}).
1692 @kindex --print-memory-usage
1693 @cindex memory usage
1694 @item --print-memory-usage
1695 Print used size, total size and used size of memory regions created with
1696 the @ref{MEMORY} command. This is useful on embedded targets to have a
1697 quick view of amount of free memory. The format of the output has one
1698 headline and one line per region. It is both human readable and easily
1699 parsable by tools. Here is an example of an output:
1702 Memory region Used Size Region Size %age Used
1703 ROM: 256 KB 1 MB 25.00%
1704 RAM: 32 B 2 GB 0.00%
1711 Print a summary of the command-line options on the standard output and exit.
1713 @kindex --target-help
1715 Print a summary of all target-specific options on the standard output and exit.
1717 @kindex -Map=@var{mapfile}
1718 @item -Map=@var{mapfile}
1719 Print a link map to the file @var{mapfile}. See the description of the
1720 @option{-M} option, above.
1722 @cindex memory usage
1723 @kindex --no-keep-memory
1724 @item --no-keep-memory
1725 @command{ld} normally optimizes for speed over memory usage by caching the
1726 symbol tables of input files in memory. This option tells @command{ld} to
1727 instead optimize for memory usage, by rereading the symbol tables as
1728 necessary. This may be required if @command{ld} runs out of memory space
1729 while linking a large executable.
1731 @kindex --no-undefined
1734 @item --no-undefined
1736 Report unresolved symbol references from regular object files. This
1737 is done even if the linker is creating a non-symbolic shared library.
1738 The switch @option{--[no-]allow-shlib-undefined} controls the
1739 behaviour for reporting unresolved references found in shared
1740 libraries being linked in.
1742 The effects of this option can be reverted by using @code{-z undefs}.
1744 @kindex --allow-multiple-definition
1746 @item --allow-multiple-definition
1748 Normally when a symbol is defined multiple times, the linker will
1749 report a fatal error. These options allow multiple definitions and the
1750 first definition will be used.
1752 @kindex --allow-shlib-undefined
1753 @kindex --no-allow-shlib-undefined
1754 @item --allow-shlib-undefined
1755 @itemx --no-allow-shlib-undefined
1756 Allows or disallows undefined symbols in shared libraries.
1757 This switch is similar to @option{--no-undefined} except that it
1758 determines the behaviour when the undefined symbols are in a
1759 shared library rather than a regular object file. It does not affect
1760 how undefined symbols in regular object files are handled.
1762 The default behaviour is to report errors for any undefined symbols
1763 referenced in shared libraries if the linker is being used to create
1764 an executable, but to allow them if the linker is being used to create
1767 The reasons for allowing undefined symbol references in shared
1768 libraries specified at link time are that:
1772 A shared library specified at link time may not be the same as the one
1773 that is available at load time, so the symbol might actually be
1774 resolvable at load time.
1776 There are some operating systems, eg BeOS and HPPA, where undefined
1777 symbols in shared libraries are normal.
1779 The BeOS kernel for example patches shared libraries at load time to
1780 select whichever function is most appropriate for the current
1781 architecture. This is used, for example, to dynamically select an
1782 appropriate memset function.
1785 @kindex --no-undefined-version
1786 @item --no-undefined-version
1787 Normally when a symbol has an undefined version, the linker will ignore
1788 it. This option disallows symbols with undefined version and a fatal error
1789 will be issued instead.
1791 @kindex --default-symver
1792 @item --default-symver
1793 Create and use a default symbol version (the soname) for unversioned
1796 @kindex --default-imported-symver
1797 @item --default-imported-symver
1798 Create and use a default symbol version (the soname) for unversioned
1801 @kindex --no-warn-mismatch
1802 @item --no-warn-mismatch
1803 Normally @command{ld} will give an error if you try to link together input
1804 files that are mismatched for some reason, perhaps because they have
1805 been compiled for different processors or for different endiannesses.
1806 This option tells @command{ld} that it should silently permit such possible
1807 errors. This option should only be used with care, in cases when you
1808 have taken some special action that ensures that the linker errors are
1811 @kindex --no-warn-search-mismatch
1812 @item --no-warn-search-mismatch
1813 Normally @command{ld} will give a warning if it finds an incompatible
1814 library during a library search. This option silences the warning.
1816 @kindex --no-whole-archive
1817 @item --no-whole-archive
1818 Turn off the effect of the @option{--whole-archive} option for subsequent
1821 @cindex output file after errors
1822 @kindex --noinhibit-exec
1823 @item --noinhibit-exec
1824 Retain the executable output file whenever it is still usable.
1825 Normally, the linker will not produce an output file if it encounters
1826 errors during the link process; it exits without writing an output file
1827 when it issues any error whatsoever.
1831 Only search library directories explicitly specified on the
1832 command line. Library directories specified in linker scripts
1833 (including linker scripts specified on the command line) are ignored.
1835 @ifclear SingleFormat
1836 @kindex --oformat=@var{output-format}
1837 @item --oformat=@var{output-format}
1838 @command{ld} may be configured to support more than one kind of object
1839 file. If your @command{ld} is configured this way, you can use the
1840 @samp{--oformat} option to specify the binary format for the output
1841 object file. Even when @command{ld} is configured to support alternative
1842 object formats, you don't usually need to specify this, as @command{ld}
1843 should be configured to produce as a default output format the most
1844 usual format on each machine. @var{output-format} is a text string, the
1845 name of a particular format supported by the BFD libraries. (You can
1846 list the available binary formats with @samp{objdump -i}.) The script
1847 command @code{OUTPUT_FORMAT} can also specify the output format, but
1848 this option overrides it. @xref{BFD}.
1851 @kindex --out-implib
1852 @item --out-implib @var{file}
1853 Create an import library in @var{file} corresponding to the executable
1854 the linker is generating (eg. a DLL or ELF program). This import
1855 library (which should be called @code{*.dll.a} or @code{*.a} for DLLs)
1856 may be used to link clients against the generated executable; this
1857 behaviour makes it possible to skip a separate import library creation
1858 step (eg. @code{dlltool} for DLLs). This option is only available for
1859 the i386 PE and ELF targetted ports of the linker.
1862 @kindex --pic-executable
1864 @itemx --pic-executable
1865 @cindex position independent executables
1866 Create a position independent executable. This is currently only supported on
1867 ELF platforms. Position independent executables are similar to shared
1868 libraries in that they are relocated by the dynamic linker to the virtual
1869 address the OS chooses for them (which can vary between invocations). Like
1870 normal dynamically linked executables they can be executed and symbols
1871 defined in the executable cannot be overridden by shared libraries.
1875 This option is ignored for Linux compatibility.
1879 This option is ignored for SVR4 compatibility.
1882 @cindex synthesizing linker
1883 @cindex relaxing addressing modes
1887 An option with machine dependent effects.
1889 This option is only supported on a few targets.
1892 @xref{H8/300,,@command{ld} and the H8/300}.
1895 @xref{Xtensa,, @command{ld} and Xtensa Processors}.
1898 @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}.
1901 @xref{Nios II,,@command{ld} and the Altera Nios II}.
1904 @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}.
1907 On some platforms the @samp{--relax} option performs target-specific,
1908 global optimizations that become possible when the linker resolves
1909 addressing in the program, such as relaxing address modes,
1910 synthesizing new instructions, selecting shorter version of current
1911 instructions, and combining constant values.
1913 On some platforms these link time global optimizations may make symbolic
1914 debugging of the resulting executable impossible.
1916 This is known to be the case for the Matsushita MN10200 and MN10300
1917 family of processors.
1921 On platforms where this is not supported, @samp{--relax} is accepted,
1925 On platforms where @samp{--relax} is accepted the option
1926 @samp{--no-relax} can be used to disable the feature.
1928 @cindex retaining specified symbols
1929 @cindex stripping all but some symbols
1930 @cindex symbols, retaining selectively
1931 @kindex --retain-symbols-file=@var{filename}
1932 @item --retain-symbols-file=@var{filename}
1933 Retain @emph{only} the symbols listed in the file @var{filename},
1934 discarding all others. @var{filename} is simply a flat file, with one
1935 symbol name per line. This option is especially useful in environments
1939 where a large global symbol table is accumulated gradually, to conserve
1942 @samp{--retain-symbols-file} does @emph{not} discard undefined symbols,
1943 or symbols needed for relocations.
1945 You may only specify @samp{--retain-symbols-file} once in the command
1946 line. It overrides @samp{-s} and @samp{-S}.
1949 @item -rpath=@var{dir}
1950 @cindex runtime library search path
1951 @kindex -rpath=@var{dir}
1952 Add a directory to the runtime library search path. This is used when
1953 linking an ELF executable with shared objects. All @option{-rpath}
1954 arguments are concatenated and passed to the runtime linker, which uses
1955 them to locate shared objects at runtime.
1957 The @option{-rpath} option is also used when locating shared objects which
1958 are needed by shared objects explicitly included in the link; see the
1959 description of the @option{-rpath-link} option. Searching @option{-rpath}
1960 in this way is only supported by native linkers and cross linkers which
1961 have been configured with the @option{--with-sysroot} option.
1963 If @option{-rpath} is not used when linking an ELF executable, the
1964 contents of the environment variable @code{LD_RUN_PATH} will be used if it
1967 The @option{-rpath} option may also be used on SunOS. By default, on
1968 SunOS, the linker will form a runtime search path out of all the
1969 @option{-L} options it is given. If a @option{-rpath} option is used, the
1970 runtime search path will be formed exclusively using the @option{-rpath}
1971 options, ignoring the @option{-L} options. This can be useful when using
1972 gcc, which adds many @option{-L} options which may be on NFS mounted
1975 For compatibility with other ELF linkers, if the @option{-R} option is
1976 followed by a directory name, rather than a file name, it is treated as
1977 the @option{-rpath} option.
1981 @cindex link-time runtime library search path
1982 @kindex -rpath-link=@var{dir}
1983 @item -rpath-link=@var{dir}
1984 When using ELF or SunOS, one shared library may require another. This
1985 happens when an @code{ld -shared} link includes a shared library as one
1988 When the linker encounters such a dependency when doing a non-shared,
1989 non-relocatable link, it will automatically try to locate the required
1990 shared library and include it in the link, if it is not included
1991 explicitly. In such a case, the @option{-rpath-link} option
1992 specifies the first set of directories to search. The
1993 @option{-rpath-link} option may specify a sequence of directory names
1994 either by specifying a list of names separated by colons, or by
1995 appearing multiple times.
1997 The tokens @var{$ORIGIN} and @var{$LIB} can appear in these search
1998 directories. They will be replaced by the full path to the directory
1999 containing the program or shared object in the case of @var{$ORIGIN}
2000 and either @samp{lib} - for 32-bit binaries - or @samp{lib64} - for
2001 64-bit binaries - in the case of @var{$LIB}.
2003 The alternative form of these tokens - @var{$@{ORIGIN@}} and
2004 @var{$@{LIB@}} can also be used. The token @var{$PLATFORM} is not
2007 This option should be used with caution as it overrides the search path
2008 that may have been hard compiled into a shared library. In such a case it
2009 is possible to use unintentionally a different search path than the
2010 runtime linker would do.
2012 The linker uses the following search paths to locate required shared
2016 Any directories specified by @option{-rpath-link} options.
2018 Any directories specified by @option{-rpath} options. The difference
2019 between @option{-rpath} and @option{-rpath-link} is that directories
2020 specified by @option{-rpath} options are included in the executable and
2021 used at runtime, whereas the @option{-rpath-link} option is only effective
2022 at link time. Searching @option{-rpath} in this way is only supported
2023 by native linkers and cross linkers which have been configured with
2024 the @option{--with-sysroot} option.
2026 On an ELF system, for native linkers, if the @option{-rpath} and
2027 @option{-rpath-link} options were not used, search the contents of the
2028 environment variable @code{LD_RUN_PATH}.
2030 On SunOS, if the @option{-rpath} option was not used, search any
2031 directories specified using @option{-L} options.
2033 For a native linker, search the contents of the environment
2034 variable @code{LD_LIBRARY_PATH}.
2036 For a native ELF linker, the directories in @code{DT_RUNPATH} or
2037 @code{DT_RPATH} of a shared library are searched for shared
2038 libraries needed by it. The @code{DT_RPATH} entries are ignored if
2039 @code{DT_RUNPATH} entries exist.
2041 The default directories, normally @file{/lib} and @file{/usr/lib}.
2043 For a native linker on an ELF system, if the file @file{/etc/ld.so.conf}
2044 exists, the list of directories found in that file.
2047 If the required shared library is not found, the linker will issue a
2048 warning and continue with the link.
2055 @cindex shared libraries
2056 Create a shared library. This is currently only supported on ELF, XCOFF
2057 and SunOS platforms. On SunOS, the linker will automatically create a
2058 shared library if the @option{-e} option is not used and there are
2059 undefined symbols in the link.
2061 @kindex --sort-common
2063 @itemx --sort-common=ascending
2064 @itemx --sort-common=descending
2065 This option tells @command{ld} to sort the common symbols by alignment in
2066 ascending or descending order when it places them in the appropriate output
2067 sections. The symbol alignments considered are sixteen-byte or larger,
2068 eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps
2069 between symbols due to alignment constraints. If no sorting order is
2070 specified, then descending order is assumed.
2072 @kindex --sort-section=name
2073 @item --sort-section=name
2074 This option will apply @code{SORT_BY_NAME} to all wildcard section
2075 patterns in the linker script.
2077 @kindex --sort-section=alignment
2078 @item --sort-section=alignment
2079 This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section
2080 patterns in the linker script.
2082 @kindex --spare-dynamic-tags
2083 @item --spare-dynamic-tags=@var{count}
2084 This option specifies the number of empty slots to leave in the
2085 .dynamic section of ELF shared objects. Empty slots may be needed by
2086 post processing tools, such as the prelinker. The default is 5.
2088 @kindex --split-by-file
2089 @item --split-by-file[=@var{size}]
2090 Similar to @option{--split-by-reloc} but creates a new output section for
2091 each input file when @var{size} is reached. @var{size} defaults to a
2092 size of 1 if not given.
2094 @kindex --split-by-reloc
2095 @item --split-by-reloc[=@var{count}]
2096 Tries to creates extra sections in the output file so that no single
2097 output section in the file contains more than @var{count} relocations.
2098 This is useful when generating huge relocatable files for downloading into
2099 certain real time kernels with the COFF object file format; since COFF
2100 cannot represent more than 65535 relocations in a single section. Note
2101 that this will fail to work with object file formats which do not
2102 support arbitrary sections. The linker will not split up individual
2103 input sections for redistribution, so if a single input section contains
2104 more than @var{count} relocations one output section will contain that
2105 many relocations. @var{count} defaults to a value of 32768.
2109 Compute and display statistics about the operation of the linker, such
2110 as execution time and memory usage.
2112 @kindex --sysroot=@var{directory}
2113 @item --sysroot=@var{directory}
2114 Use @var{directory} as the location of the sysroot, overriding the
2115 configure-time default. This option is only supported by linkers
2116 that were configured using @option{--with-sysroot}.
2120 This is used by COFF/PE based targets to create a task-linked object
2121 file where all of the global symbols have been converted to statics.
2123 @kindex --traditional-format
2124 @cindex traditional format
2125 @item --traditional-format
2126 For some targets, the output of @command{ld} is different in some ways from
2127 the output of some existing linker. This switch requests @command{ld} to
2128 use the traditional format instead.
2131 For example, on SunOS, @command{ld} combines duplicate entries in the
2132 symbol string table. This can reduce the size of an output file with
2133 full debugging information by over 30 percent. Unfortunately, the SunOS
2134 @code{dbx} program can not read the resulting program (@code{gdb} has no
2135 trouble). The @samp{--traditional-format} switch tells @command{ld} to not
2136 combine duplicate entries.
2138 @kindex --section-start=@var{sectionname}=@var{org}
2139 @item --section-start=@var{sectionname}=@var{org}
2140 Locate a section in the output file at the absolute
2141 address given by @var{org}. You may use this option as many
2142 times as necessary to locate multiple sections in the command
2144 @var{org} must be a single hexadecimal integer;
2145 for compatibility with other linkers, you may omit the leading
2146 @samp{0x} usually associated with hexadecimal values. @emph{Note:} there
2147 should be no white space between @var{sectionname}, the equals
2148 sign (``@key{=}''), and @var{org}.
2150 @kindex -Tbss=@var{org}
2151 @kindex -Tdata=@var{org}
2152 @kindex -Ttext=@var{org}
2153 @cindex segment origins, cmd line
2154 @item -Tbss=@var{org}
2155 @itemx -Tdata=@var{org}
2156 @itemx -Ttext=@var{org}
2157 Same as @option{--section-start}, with @code{.bss}, @code{.data} or
2158 @code{.text} as the @var{sectionname}.
2160 @kindex -Ttext-segment=@var{org}
2161 @item -Ttext-segment=@var{org}
2162 @cindex text segment origin, cmd line
2163 When creating an ELF executable, it will set the address of the first
2164 byte of the text segment.
2166 @kindex -Trodata-segment=@var{org}
2167 @item -Trodata-segment=@var{org}
2168 @cindex rodata segment origin, cmd line
2169 When creating an ELF executable or shared object for a target where
2170 the read-only data is in its own segment separate from the executable
2171 text, it will set the address of the first byte of the read-only data segment.
2173 @kindex -Tldata-segment=@var{org}
2174 @item -Tldata-segment=@var{org}
2175 @cindex ldata segment origin, cmd line
2176 When creating an ELF executable or shared object for x86-64 medium memory
2177 model, it will set the address of the first byte of the ldata segment.
2179 @kindex --unresolved-symbols
2180 @item --unresolved-symbols=@var{method}
2181 Determine how to handle unresolved symbols. There are four possible
2182 values for @samp{method}:
2186 Do not report any unresolved symbols.
2189 Report all unresolved symbols. This is the default.
2191 @item ignore-in-object-files
2192 Report unresolved symbols that are contained in shared libraries, but
2193 ignore them if they come from regular object files.
2195 @item ignore-in-shared-libs
2196 Report unresolved symbols that come from regular object files, but
2197 ignore them if they come from shared libraries. This can be useful
2198 when creating a dynamic binary and it is known that all the shared
2199 libraries that it should be referencing are included on the linker's
2203 The behaviour for shared libraries on their own can also be controlled
2204 by the @option{--[no-]allow-shlib-undefined} option.
2206 Normally the linker will generate an error message for each reported
2207 unresolved symbol but the option @option{--warn-unresolved-symbols}
2208 can change this to a warning.
2210 @kindex --verbose[=@var{NUMBER}]
2211 @cindex verbose[=@var{NUMBER}]
2213 @itemx --verbose[=@var{NUMBER}]
2214 Display the version number for @command{ld} and list the linker emulations
2215 supported. Display which input files can and cannot be opened. Display
2216 the linker script being used by the linker. If the optional @var{NUMBER}
2217 argument > 1, plugin symbol status will also be displayed.
2219 @kindex --version-script=@var{version-scriptfile}
2220 @cindex version script, symbol versions
2221 @item --version-script=@var{version-scriptfile}
2222 Specify the name of a version script to the linker. This is typically
2223 used when creating shared libraries to specify additional information
2224 about the version hierarchy for the library being created. This option
2225 is only fully supported on ELF platforms which support shared libraries;
2226 see @ref{VERSION}. It is partially supported on PE platforms, which can
2227 use version scripts to filter symbol visibility in auto-export mode: any
2228 symbols marked @samp{local} in the version script will not be exported.
2231 @kindex --warn-common
2232 @cindex warnings, on combining symbols
2233 @cindex combining symbols, warnings on
2235 Warn when a common symbol is combined with another common symbol or with
2236 a symbol definition. Unix linkers allow this somewhat sloppy practice,
2237 but linkers on some other operating systems do not. This option allows
2238 you to find potential problems from combining global symbols.
2239 Unfortunately, some C libraries use this practice, so you may get some
2240 warnings about symbols in the libraries as well as in your programs.
2242 There are three kinds of global symbols, illustrated here by C examples:
2246 A definition, which goes in the initialized data section of the output
2250 An undefined reference, which does not allocate space.
2251 There must be either a definition or a common symbol for the
2255 A common symbol. If there are only (one or more) common symbols for a
2256 variable, it goes in the uninitialized data area of the output file.
2257 The linker merges multiple common symbols for the same variable into a
2258 single symbol. If they are of different sizes, it picks the largest
2259 size. The linker turns a common symbol into a declaration, if there is
2260 a definition of the same variable.
2263 The @samp{--warn-common} option can produce five kinds of warnings.
2264 Each warning consists of a pair of lines: the first describes the symbol
2265 just encountered, and the second describes the previous symbol
2266 encountered with the same name. One or both of the two symbols will be
2271 Turning a common symbol into a reference, because there is already a
2272 definition for the symbol.
2274 @var{file}(@var{section}): warning: common of `@var{symbol}'
2275 overridden by definition
2276 @var{file}(@var{section}): warning: defined here
2280 Turning a common symbol into a reference, because a later definition for
2281 the symbol is encountered. This is the same as the previous case,
2282 except that the symbols are encountered in a different order.
2284 @var{file}(@var{section}): warning: definition of `@var{symbol}'
2286 @var{file}(@var{section}): warning: common is here
2290 Merging a common symbol with a previous same-sized common symbol.
2292 @var{file}(@var{section}): warning: multiple common
2294 @var{file}(@var{section}): warning: previous common is here
2298 Merging a common symbol with a previous larger common symbol.
2300 @var{file}(@var{section}): warning: common of `@var{symbol}'
2301 overridden by larger common
2302 @var{file}(@var{section}): warning: larger common is here
2306 Merging a common symbol with a previous smaller common symbol. This is
2307 the same as the previous case, except that the symbols are
2308 encountered in a different order.
2310 @var{file}(@var{section}): warning: common of `@var{symbol}'
2311 overriding smaller common
2312 @var{file}(@var{section}): warning: smaller common is here
2316 @kindex --warn-constructors
2317 @item --warn-constructors
2318 Warn if any global constructors are used. This is only useful for a few
2319 object file formats. For formats like COFF or ELF, the linker can not
2320 detect the use of global constructors.
2322 @kindex --warn-multiple-gp
2323 @item --warn-multiple-gp
2324 Warn if multiple global pointer values are required in the output file.
2325 This is only meaningful for certain processors, such as the Alpha.
2326 Specifically, some processors put large-valued constants in a special
2327 section. A special register (the global pointer) points into the middle
2328 of this section, so that constants can be loaded efficiently via a
2329 base-register relative addressing mode. Since the offset in
2330 base-register relative mode is fixed and relatively small (e.g., 16
2331 bits), this limits the maximum size of the constant pool. Thus, in
2332 large programs, it is often necessary to use multiple global pointer
2333 values in order to be able to address all possible constants. This
2334 option causes a warning to be issued whenever this case occurs.
2337 @cindex warnings, on undefined symbols
2338 @cindex undefined symbols, warnings on
2340 Only warn once for each undefined symbol, rather than once per module
2343 @kindex --warn-section-align
2344 @cindex warnings, on section alignment
2345 @cindex section alignment, warnings on
2346 @item --warn-section-align
2347 Warn if the address of an output section is changed because of
2348 alignment. Typically, the alignment will be set by an input section.
2349 The address will only be changed if it not explicitly specified; that
2350 is, if the @code{SECTIONS} command does not specify a start address for
2351 the section (@pxref{SECTIONS}).
2353 @kindex --warn-shared-textrel
2354 @item --warn-shared-textrel
2355 Warn if the linker adds a DT_TEXTREL to a shared object.
2357 @kindex --warn-alternate-em
2358 @item --warn-alternate-em
2359 Warn if an object has alternate ELF machine code.
2361 @kindex --warn-unresolved-symbols
2362 @item --warn-unresolved-symbols
2363 If the linker is going to report an unresolved symbol (see the option
2364 @option{--unresolved-symbols}) it will normally generate an error.
2365 This option makes it generate a warning instead.
2367 @kindex --error-unresolved-symbols
2368 @item --error-unresolved-symbols
2369 This restores the linker's default behaviour of generating errors when
2370 it is reporting unresolved symbols.
2372 @kindex --whole-archive
2373 @cindex including an entire archive
2374 @item --whole-archive
2375 For each archive mentioned on the command line after the
2376 @option{--whole-archive} option, include every object file in the archive
2377 in the link, rather than searching the archive for the required object
2378 files. This is normally used to turn an archive file into a shared
2379 library, forcing every object to be included in the resulting shared
2380 library. This option may be used more than once.
2382 Two notes when using this option from gcc: First, gcc doesn't know
2383 about this option, so you have to use @option{-Wl,-whole-archive}.
2384 Second, don't forget to use @option{-Wl,-no-whole-archive} after your
2385 list of archives, because gcc will add its own list of archives to
2386 your link and you may not want this flag to affect those as well.
2388 @kindex --wrap=@var{symbol}
2389 @item --wrap=@var{symbol}
2390 Use a wrapper function for @var{symbol}. Any undefined reference to
2391 @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any
2392 undefined reference to @code{__real_@var{symbol}} will be resolved to
2395 This can be used to provide a wrapper for a system function. The
2396 wrapper function should be called @code{__wrap_@var{symbol}}. If it
2397 wishes to call the system function, it should call
2398 @code{__real_@var{symbol}}.
2400 Here is a trivial example:
2404 __wrap_malloc (size_t c)
2406 printf ("malloc called with %zu\n", c);
2407 return __real_malloc (c);
2411 If you link other code with this file using @option{--wrap malloc}, then
2412 all calls to @code{malloc} will call the function @code{__wrap_malloc}
2413 instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will
2414 call the real @code{malloc} function.
2416 You may wish to provide a @code{__real_malloc} function as well, so that
2417 links without the @option{--wrap} option will succeed. If you do this,
2418 you should not put the definition of @code{__real_malloc} in the same
2419 file as @code{__wrap_malloc}; if you do, the assembler may resolve the
2420 call before the linker has a chance to wrap it to @code{malloc}.
2422 Only undefined references are replaced by the linker. So, translation unit
2423 internal references to @var{symbol} are not resolved to
2424 @code{__wrap_@var{symbol}}. In the next example, the call to @code{f} in
2425 @code{g} is not resolved to @code{__wrap_f}.
2441 @kindex --eh-frame-hdr
2442 @kindex --no-eh-frame-hdr
2443 @item --eh-frame-hdr
2444 @itemx --no-eh-frame-hdr
2445 Request (@option{--eh-frame-hdr}) or suppress
2446 (@option{--no-eh-frame-hdr}) the creation of @code{.eh_frame_hdr}
2447 section and ELF @code{PT_GNU_EH_FRAME} segment header.
2449 @kindex --ld-generated-unwind-info
2450 @item --no-ld-generated-unwind-info
2451 Request creation of @code{.eh_frame} unwind info for linker
2452 generated code sections like PLT. This option is on by default
2453 if linker generated unwind info is supported.
2455 @kindex --enable-new-dtags
2456 @kindex --disable-new-dtags
2457 @item --enable-new-dtags
2458 @itemx --disable-new-dtags
2459 This linker can create the new dynamic tags in ELF. But the older ELF
2460 systems may not understand them. If you specify
2461 @option{--enable-new-dtags}, the new dynamic tags will be created as needed
2462 and older dynamic tags will be omitted.
2463 If you specify @option{--disable-new-dtags}, no new dynamic tags will be
2464 created. By default, the new dynamic tags are not created. Note that
2465 those options are only available for ELF systems.
2467 @kindex --hash-size=@var{number}
2468 @item --hash-size=@var{number}
2469 Set the default size of the linker's hash tables to a prime number
2470 close to @var{number}. Increasing this value can reduce the length of
2471 time it takes the linker to perform its tasks, at the expense of
2472 increasing the linker's memory requirements. Similarly reducing this
2473 value can reduce the memory requirements at the expense of speed.
2475 @kindex --hash-style=@var{style}
2476 @item --hash-style=@var{style}
2477 Set the type of linker's hash table(s). @var{style} can be either
2478 @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for
2479 new style GNU @code{.gnu.hash} section or @code{both} for both
2480 the classic ELF @code{.hash} and new style GNU @code{.gnu.hash}
2481 hash tables. The default depends upon how the linker was configured,
2482 but for most Linux based systems it will be @code{both}.
2484 @kindex --compress-debug-sections=none
2485 @kindex --compress-debug-sections=zlib
2486 @kindex --compress-debug-sections=zlib-gnu
2487 @kindex --compress-debug-sections=zlib-gabi
2488 @item --compress-debug-sections=none
2489 @itemx --compress-debug-sections=zlib
2490 @itemx --compress-debug-sections=zlib-gnu
2491 @itemx --compress-debug-sections=zlib-gabi
2492 On ELF platforms, these options control how DWARF debug sections are
2493 compressed using zlib.
2495 @option{--compress-debug-sections=none} doesn't compress DWARF debug
2496 sections. @option{--compress-debug-sections=zlib-gnu} compresses
2497 DWARF debug sections and renames them to begin with @samp{.zdebug}
2498 instead of @samp{.debug}. @option{--compress-debug-sections=zlib-gabi}
2499 also compresses DWARF debug sections, but rather than renaming them it
2500 sets the SHF_COMPRESSED flag in the sections' headers.
2502 The @option{--compress-debug-sections=zlib} option is an alias for
2503 @option{--compress-debug-sections=zlib-gabi}.
2505 Note that this option overrides any compression in input debug
2506 sections, so if a binary is linked with @option{--compress-debug-sections=none}
2507 for example, then any compressed debug sections in input files will be
2508 uncompressed before they are copied into the output binary.
2510 The default compression behaviour varies depending upon the target
2511 involved and the configure options used to build the toolchain. The
2512 default can be determined by examining the output from the linker's
2513 @option{--help} option.
2515 @kindex --reduce-memory-overheads
2516 @item --reduce-memory-overheads
2517 This option reduces memory requirements at ld runtime, at the expense of
2518 linking speed. This was introduced to select the old O(n^2) algorithm
2519 for link map file generation, rather than the new O(n) algorithm which uses
2520 about 40% more memory for symbol storage.
2522 Another effect of the switch is to set the default hash table size to
2523 1021, which again saves memory at the cost of lengthening the linker's
2524 run time. This is not done however if the @option{--hash-size} switch
2527 The @option{--reduce-memory-overheads} switch may be also be used to
2528 enable other tradeoffs in future versions of the linker.
2531 @kindex --build-id=@var{style}
2533 @itemx --build-id=@var{style}
2534 Request the creation of a @code{.note.gnu.build-id} ELF note section
2535 or a @code{.buildid} COFF section. The contents of the note are
2536 unique bits identifying this linked file. @var{style} can be
2537 @code{uuid} to use 128 random bits, @code{sha1} to use a 160-bit
2538 @sc{SHA1} hash on the normative parts of the output contents,
2539 @code{md5} to use a 128-bit @sc{MD5} hash on the normative parts of
2540 the output contents, or @code{0x@var{hexstring}} to use a chosen bit
2541 string specified as an even number of hexadecimal digits (@code{-} and
2542 @code{:} characters between digit pairs are ignored). If @var{style}
2543 is omitted, @code{sha1} is used.
2545 The @code{md5} and @code{sha1} styles produces an identifier
2546 that is always the same in an identical output file, but will be
2547 unique among all nonidentical output files. It is not intended
2548 to be compared as a checksum for the file's contents. A linked
2549 file may be changed later by other tools, but the build ID bit
2550 string identifying the original linked file does not change.
2552 Passing @code{none} for @var{style} disables the setting from any
2553 @code{--build-id} options earlier on the command line.
2558 @subsection Options Specific to i386 PE Targets
2560 @c man begin OPTIONS
2562 The i386 PE linker supports the @option{-shared} option, which causes
2563 the output to be a dynamically linked library (DLL) instead of a
2564 normal executable. You should name the output @code{*.dll} when you
2565 use this option. In addition, the linker fully supports the standard
2566 @code{*.def} files, which may be specified on the linker command line
2567 like an object file (in fact, it should precede archives it exports
2568 symbols from, to ensure that they get linked in, just like a normal
2571 In addition to the options common to all targets, the i386 PE linker
2572 support additional command-line options that are specific to the i386
2573 PE target. Options that take values may be separated from their
2574 values by either a space or an equals sign.
2578 @kindex --add-stdcall-alias
2579 @item --add-stdcall-alias
2580 If given, symbols with a stdcall suffix (@@@var{nn}) will be exported
2581 as-is and also with the suffix stripped.
2582 [This option is specific to the i386 PE targeted port of the linker]
2585 @item --base-file @var{file}
2586 Use @var{file} as the name of a file in which to save the base
2587 addresses of all the relocations needed for generating DLLs with
2589 [This is an i386 PE specific option]
2593 Create a DLL instead of a regular executable. You may also use
2594 @option{-shared} or specify a @code{LIBRARY} in a given @code{.def}
2596 [This option is specific to the i386 PE targeted port of the linker]
2598 @kindex --enable-long-section-names
2599 @kindex --disable-long-section-names
2600 @item --enable-long-section-names
2601 @itemx --disable-long-section-names
2602 The PE variants of the COFF object format add an extension that permits
2603 the use of section names longer than eight characters, the normal limit
2604 for COFF. By default, these names are only allowed in object files, as
2605 fully-linked executable images do not carry the COFF string table required
2606 to support the longer names. As a GNU extension, it is possible to
2607 allow their use in executable images as well, or to (probably pointlessly!)
2608 disallow it in object files, by using these two options. Executable images
2609 generated with these long section names are slightly non-standard, carrying
2610 as they do a string table, and may generate confusing output when examined
2611 with non-GNU PE-aware tools, such as file viewers and dumpers. However,
2612 GDB relies on the use of PE long section names to find Dwarf-2 debug
2613 information sections in an executable image at runtime, and so if neither
2614 option is specified on the command-line, @command{ld} will enable long
2615 section names, overriding the default and technically correct behaviour,
2616 when it finds the presence of debug information while linking an executable
2617 image and not stripping symbols.
2618 [This option is valid for all PE targeted ports of the linker]
2620 @kindex --enable-stdcall-fixup
2621 @kindex --disable-stdcall-fixup
2622 @item --enable-stdcall-fixup
2623 @itemx --disable-stdcall-fixup
2624 If the link finds a symbol that it cannot resolve, it will attempt to
2625 do ``fuzzy linking'' by looking for another defined symbol that differs
2626 only in the format of the symbol name (cdecl vs stdcall) and will
2627 resolve that symbol by linking to the match. For example, the
2628 undefined symbol @code{_foo} might be linked to the function
2629 @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked
2630 to the function @code{_bar}. When the linker does this, it prints a
2631 warning, since it normally should have failed to link, but sometimes
2632 import libraries generated from third-party dlls may need this feature
2633 to be usable. If you specify @option{--enable-stdcall-fixup}, this
2634 feature is fully enabled and warnings are not printed. If you specify
2635 @option{--disable-stdcall-fixup}, this feature is disabled and such
2636 mismatches are considered to be errors.
2637 [This option is specific to the i386 PE targeted port of the linker]
2639 @kindex --leading-underscore
2640 @kindex --no-leading-underscore
2641 @item --leading-underscore
2642 @itemx --no-leading-underscore
2643 For most targets default symbol-prefix is an underscore and is defined
2644 in target's description. By this option it is possible to
2645 disable/enable the default underscore symbol-prefix.
2647 @cindex DLLs, creating
2648 @kindex --export-all-symbols
2649 @item --export-all-symbols
2650 If given, all global symbols in the objects used to build a DLL will
2651 be exported by the DLL. Note that this is the default if there
2652 otherwise wouldn't be any exported symbols. When symbols are
2653 explicitly exported via DEF files or implicitly exported via function
2654 attributes, the default is to not export anything else unless this
2655 option is given. Note that the symbols @code{DllMain@@12},
2656 @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and
2657 @code{impure_ptr} will not be automatically
2658 exported. Also, symbols imported from other DLLs will not be
2659 re-exported, nor will symbols specifying the DLL's internal layout
2660 such as those beginning with @code{_head_} or ending with
2661 @code{_iname}. In addition, no symbols from @code{libgcc},
2662 @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported.
2663 Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will
2664 not be exported, to help with C++ DLLs. Finally, there is an
2665 extensive list of cygwin-private symbols that are not exported
2666 (obviously, this applies on when building DLLs for cygwin targets).
2667 These cygwin-excludes are: @code{_cygwin_dll_entry@@12},
2668 @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12},
2669 @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll},
2670 @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2},
2671 @code{cygwin_premain3}, and @code{environ}.
2672 [This option is specific to the i386 PE targeted port of the linker]
2674 @kindex --exclude-symbols
2675 @item --exclude-symbols @var{symbol},@var{symbol},...
2676 Specifies a list of symbols which should not be automatically
2677 exported. The symbol names may be delimited by commas or colons.
2678 [This option is specific to the i386 PE targeted port of the linker]
2680 @kindex --exclude-all-symbols
2681 @item --exclude-all-symbols
2682 Specifies no symbols should be automatically exported.
2683 [This option is specific to the i386 PE targeted port of the linker]
2685 @kindex --file-alignment
2686 @item --file-alignment
2687 Specify the file alignment. Sections in the file will always begin at
2688 file offsets which are multiples of this number. This defaults to
2690 [This option is specific to the i386 PE targeted port of the linker]
2694 @item --heap @var{reserve}
2695 @itemx --heap @var{reserve},@var{commit}
2696 Specify the number of bytes of memory to reserve (and optionally commit)
2697 to be used as heap for this program. The default is 1MB reserved, 4K
2699 [This option is specific to the i386 PE targeted port of the linker]
2702 @kindex --image-base
2703 @item --image-base @var{value}
2704 Use @var{value} as the base address of your program or dll. This is
2705 the lowest memory location that will be used when your program or dll
2706 is loaded. To reduce the need to relocate and improve performance of
2707 your dlls, each should have a unique base address and not overlap any
2708 other dlls. The default is 0x400000 for executables, and 0x10000000
2710 [This option is specific to the i386 PE targeted port of the linker]
2714 If given, the stdcall suffixes (@@@var{nn}) will be stripped from
2715 symbols before they are exported.
2716 [This option is specific to the i386 PE targeted port of the linker]
2718 @kindex --large-address-aware
2719 @item --large-address-aware
2720 If given, the appropriate bit in the ``Characteristics'' field of the COFF
2721 header is set to indicate that this executable supports virtual addresses
2722 greater than 2 gigabytes. This should be used in conjunction with the /3GB
2723 or /USERVA=@var{value} megabytes switch in the ``[operating systems]''
2724 section of the BOOT.INI. Otherwise, this bit has no effect.
2725 [This option is specific to PE targeted ports of the linker]
2727 @kindex --disable-large-address-aware
2728 @item --disable-large-address-aware
2729 Reverts the effect of a previous @samp{--large-address-aware} option.
2730 This is useful if @samp{--large-address-aware} is always set by the compiler
2731 driver (e.g. Cygwin gcc) and the executable does not support virtual
2732 addresses greater than 2 gigabytes.
2733 [This option is specific to PE targeted ports of the linker]
2735 @kindex --major-image-version
2736 @item --major-image-version @var{value}
2737 Sets the major number of the ``image version''. Defaults to 1.
2738 [This option is specific to the i386 PE targeted port of the linker]
2740 @kindex --major-os-version
2741 @item --major-os-version @var{value}
2742 Sets the major number of the ``os version''. Defaults to 4.
2743 [This option is specific to the i386 PE targeted port of the linker]
2745 @kindex --major-subsystem-version
2746 @item --major-subsystem-version @var{value}
2747 Sets the major number of the ``subsystem version''. Defaults to 4.
2748 [This option is specific to the i386 PE targeted port of the linker]
2750 @kindex --minor-image-version
2751 @item --minor-image-version @var{value}
2752 Sets the minor number of the ``image version''. Defaults to 0.
2753 [This option is specific to the i386 PE targeted port of the linker]
2755 @kindex --minor-os-version
2756 @item --minor-os-version @var{value}
2757 Sets the minor number of the ``os version''. Defaults to 0.
2758 [This option is specific to the i386 PE targeted port of the linker]
2760 @kindex --minor-subsystem-version
2761 @item --minor-subsystem-version @var{value}
2762 Sets the minor number of the ``subsystem version''. Defaults to 0.
2763 [This option is specific to the i386 PE targeted port of the linker]
2765 @cindex DEF files, creating
2766 @cindex DLLs, creating
2767 @kindex --output-def
2768 @item --output-def @var{file}
2769 The linker will create the file @var{file} which will contain a DEF
2770 file corresponding to the DLL the linker is generating. This DEF file
2771 (which should be called @code{*.def}) may be used to create an import
2772 library with @code{dlltool} or may be used as a reference to
2773 automatically or implicitly exported symbols.
2774 [This option is specific to the i386 PE targeted port of the linker]
2776 @cindex DLLs, creating
2777 @kindex --enable-auto-image-base
2778 @item --enable-auto-image-base
2779 @itemx --enable-auto-image-base=@var{value}
2780 Automatically choose the image base for DLLs, optionally starting with base
2781 @var{value}, unless one is specified using the @code{--image-base} argument.
2782 By using a hash generated from the dllname to create unique image bases
2783 for each DLL, in-memory collisions and relocations which can delay program
2784 execution are avoided.
2785 [This option is specific to the i386 PE targeted port of the linker]
2787 @kindex --disable-auto-image-base
2788 @item --disable-auto-image-base
2789 Do not automatically generate a unique image base. If there is no
2790 user-specified image base (@code{--image-base}) then use the platform
2792 [This option is specific to the i386 PE targeted port of the linker]
2794 @cindex DLLs, linking to
2795 @kindex --dll-search-prefix
2796 @item --dll-search-prefix @var{string}
2797 When linking dynamically to a dll without an import library,
2798 search for @code{<string><basename>.dll} in preference to
2799 @code{lib<basename>.dll}. This behaviour allows easy distinction
2800 between DLLs built for the various "subplatforms": native, cygwin,
2801 uwin, pw, etc. For instance, cygwin DLLs typically use
2802 @code{--dll-search-prefix=cyg}.
2803 [This option is specific to the i386 PE targeted port of the linker]
2805 @kindex --enable-auto-import
2806 @item --enable-auto-import
2807 Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for
2808 DATA imports from DLLs, thus making it possible to bypass the dllimport
2809 mechanism on the user side and to reference unmangled symbol names.
2810 [This option is specific to the i386 PE targeted port of the linker]
2812 The following remarks pertain to the original implementation of the
2813 feature and are obsolete nowadays for Cygwin and MinGW targets.
2815 Note: Use of the 'auto-import' extension will cause the text section
2816 of the image file to be made writable. This does not conform to the
2817 PE-COFF format specification published by Microsoft.
2819 Note - use of the 'auto-import' extension will also cause read only
2820 data which would normally be placed into the .rdata section to be
2821 placed into the .data section instead. This is in order to work
2822 around a problem with consts that is described here:
2823 http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html
2825 Using 'auto-import' generally will 'just work' -- but sometimes you may
2828 "variable '<var>' can't be auto-imported. Please read the
2829 documentation for ld's @code{--enable-auto-import} for details."
2831 This message occurs when some (sub)expression accesses an address
2832 ultimately given by the sum of two constants (Win32 import tables only
2833 allow one). Instances where this may occur include accesses to member
2834 fields of struct variables imported from a DLL, as well as using a
2835 constant index into an array variable imported from a DLL. Any
2836 multiword variable (arrays, structs, long long, etc) may trigger
2837 this error condition. However, regardless of the exact data type
2838 of the offending exported variable, ld will always detect it, issue
2839 the warning, and exit.
2841 There are several ways to address this difficulty, regardless of the
2842 data type of the exported variable:
2844 One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task
2845 of adjusting references in your client code for runtime environment, so
2846 this method works only when runtime environment supports this feature.
2848 A second solution is to force one of the 'constants' to be a variable --
2849 that is, unknown and un-optimizable at compile time. For arrays,
2850 there are two possibilities: a) make the indexee (the array's address)
2851 a variable, or b) make the 'constant' index a variable. Thus:
2854 extern type extern_array[];
2856 @{ volatile type *t=extern_array; t[1] @}
2862 extern type extern_array[];
2864 @{ volatile int t=1; extern_array[t] @}
2867 For structs (and most other multiword data types) the only option
2868 is to make the struct itself (or the long long, or the ...) variable:
2871 extern struct s extern_struct;
2872 extern_struct.field -->
2873 @{ volatile struct s *t=&extern_struct; t->field @}
2879 extern long long extern_ll;
2881 @{ volatile long long * local_ll=&extern_ll; *local_ll @}
2884 A third method of dealing with this difficulty is to abandon
2885 'auto-import' for the offending symbol and mark it with
2886 @code{__declspec(dllimport)}. However, in practice that
2887 requires using compile-time #defines to indicate whether you are
2888 building a DLL, building client code that will link to the DLL, or
2889 merely building/linking to a static library. In making the choice
2890 between the various methods of resolving the 'direct address with
2891 constant offset' problem, you should consider typical real-world usage:
2899 void main(int argc, char **argv)@{
2900 printf("%d\n",arr[1]);
2910 void main(int argc, char **argv)@{
2911 /* This workaround is for win32 and cygwin; do not "optimize" */
2912 volatile int *parr = arr;
2913 printf("%d\n",parr[1]);
2920 /* Note: auto-export is assumed (no __declspec(dllexport)) */
2921 #if (defined(_WIN32) || defined(__CYGWIN__)) && \
2922 !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2923 #define FOO_IMPORT __declspec(dllimport)
2927 extern FOO_IMPORT int arr[];
2930 void main(int argc, char **argv)@{
2931 printf("%d\n",arr[1]);
2935 A fourth way to avoid this problem is to re-code your
2936 library to use a functional interface rather than a data interface
2937 for the offending variables (e.g. set_foo() and get_foo() accessor
2940 @kindex --disable-auto-import
2941 @item --disable-auto-import
2942 Do not attempt to do sophisticated linking of @code{_symbol} to
2943 @code{__imp__symbol} for DATA imports from DLLs.
2944 [This option is specific to the i386 PE targeted port of the linker]
2946 @kindex --enable-runtime-pseudo-reloc
2947 @item --enable-runtime-pseudo-reloc
2948 If your code contains expressions described in --enable-auto-import section,
2949 that is, DATA imports from DLL with non-zero offset, this switch will create
2950 a vector of 'runtime pseudo relocations' which can be used by runtime
2951 environment to adjust references to such data in your client code.
2952 [This option is specific to the i386 PE targeted port of the linker]
2954 @kindex --disable-runtime-pseudo-reloc
2955 @item --disable-runtime-pseudo-reloc
2956 Do not create pseudo relocations for non-zero offset DATA imports from DLLs.
2957 [This option is specific to the i386 PE targeted port of the linker]
2959 @kindex --enable-extra-pe-debug
2960 @item --enable-extra-pe-debug
2961 Show additional debug info related to auto-import symbol thunking.
2962 [This option is specific to the i386 PE targeted port of the linker]
2964 @kindex --section-alignment
2965 @item --section-alignment
2966 Sets the section alignment. Sections in memory will always begin at
2967 addresses which are a multiple of this number. Defaults to 0x1000.
2968 [This option is specific to the i386 PE targeted port of the linker]
2972 @item --stack @var{reserve}
2973 @itemx --stack @var{reserve},@var{commit}
2974 Specify the number of bytes of memory to reserve (and optionally commit)
2975 to be used as stack for this program. The default is 2MB reserved, 4K
2977 [This option is specific to the i386 PE targeted port of the linker]
2980 @item --subsystem @var{which}
2981 @itemx --subsystem @var{which}:@var{major}
2982 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2983 Specifies the subsystem under which your program will execute. The
2984 legal values for @var{which} are @code{native}, @code{windows},
2985 @code{console}, @code{posix}, and @code{xbox}. You may optionally set
2986 the subsystem version also. Numeric values are also accepted for
2988 [This option is specific to the i386 PE targeted port of the linker]
2990 The following options set flags in the @code{DllCharacteristics} field
2991 of the PE file header:
2992 [These options are specific to PE targeted ports of the linker]
2994 @kindex --high-entropy-va
2995 @item --high-entropy-va
2996 Image is compatible with 64-bit address space layout randomization
2998 This option also implies @option{--dynamicbase} and
2999 @option{--enable-reloc-section}.
3001 @kindex --dynamicbase
3003 The image base address may be relocated using address space layout
3004 randomization (ASLR). This feature was introduced with MS Windows
3005 Vista for i386 PE targets.
3006 This option also implies @option{--enable-reloc-section}.
3008 @kindex --forceinteg
3010 Code integrity checks are enforced.
3014 The image is compatible with the Data Execution Prevention.
3015 This feature was introduced with MS Windows XP SP2 for i386 PE targets.
3017 @kindex --no-isolation
3018 @item --no-isolation
3019 Although the image understands isolation, do not isolate the image.
3023 The image does not use SEH. No SE handler may be called from
3028 Do not bind this image.
3032 The driver uses the MS Windows Driver Model.
3036 The image is Terminal Server aware.
3038 @kindex --insert-timestamp
3039 @item --insert-timestamp
3040 @itemx --no-insert-timestamp
3041 Insert a real timestamp into the image. This is the default behaviour
3042 as it matches legacy code and it means that the image will work with
3043 other, proprietary tools. The problem with this default is that it
3044 will result in slightly different images being produced each time the
3045 same sources are linked. The option @option{--no-insert-timestamp}
3046 can be used to insert a zero value for the timestamp, this ensuring
3047 that binaries produced from identical sources will compare
3050 @kindex --enable-reloc-section
3051 @item --enable-reloc-section
3052 Create the base relocation table, which is necessary if the image
3053 is loaded at a different image base than specified in the PE header.
3059 @subsection Options specific to C6X uClinux targets
3061 @c man begin OPTIONS
3063 The C6X uClinux target uses a binary format called DSBT to support shared
3064 libraries. Each shared library in the system needs to have a unique index;
3065 all executables use an index of 0.
3070 @item --dsbt-size @var{size}
3071 This option sets the number of entries in the DSBT of the current executable
3072 or shared library to @var{size}. The default is to create a table with 64
3075 @kindex --dsbt-index
3076 @item --dsbt-index @var{index}
3077 This option sets the DSBT index of the current executable or shared library
3078 to @var{index}. The default is 0, which is appropriate for generating
3079 executables. If a shared library is generated with a DSBT index of 0, the
3080 @code{R_C6000_DSBT_INDEX} relocs are copied into the output file.
3082 @kindex --no-merge-exidx-entries
3083 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent
3084 exidx entries in frame unwind info.
3092 @subsection Options specific to C-SKY targets
3094 @c man begin OPTIONS
3098 @kindex --branch-stub on C-SKY
3100 This option enables linker branch relaxation by inserting branch stub
3101 sections when needed to extend the range of branches. This option is
3102 usually not required since C-SKY supports branch and call instructions that
3103 can access the full memory range and branch relaxation is normally handled by
3104 the compiler or assembler.
3106 @kindex --stub-group-size on C-SKY
3107 @item --stub-group-size=@var{N}
3108 This option allows finer control of linker branch stub creation.
3109 It sets the maximum size of a group of input sections that can
3110 be handled by one stub section. A negative value of @var{N} locates
3111 stub sections after their branches, while a positive value allows stub
3112 sections to appear either before or after the branches. Values of
3113 @samp{1} or @samp{-1} indicate that the
3114 linker should choose suitable defaults.
3122 @subsection Options specific to Motorola 68HC11 and 68HC12 targets
3124 @c man begin OPTIONS
3126 The 68HC11 and 68HC12 linkers support specific options to control the
3127 memory bank switching mapping and trampoline code generation.
3131 @kindex --no-trampoline
3132 @item --no-trampoline
3133 This option disables the generation of trampoline. By default a trampoline
3134 is generated for each far function which is called using a @code{jsr}
3135 instruction (this happens when a pointer to a far function is taken).
3137 @kindex --bank-window
3138 @item --bank-window @var{name}
3139 This option indicates to the linker the name of the memory region in
3140 the @samp{MEMORY} specification that describes the memory bank window.
3141 The definition of such region is then used by the linker to compute
3142 paging and addresses within the memory window.
3150 @subsection Options specific to Motorola 68K target
3152 @c man begin OPTIONS
3154 The following options are supported to control handling of GOT generation
3155 when linking for 68K targets.
3160 @item --got=@var{type}
3161 This option tells the linker which GOT generation scheme to use.
3162 @var{type} should be one of @samp{single}, @samp{negative},
3163 @samp{multigot} or @samp{target}. For more information refer to the
3164 Info entry for @file{ld}.
3172 @subsection Options specific to MIPS targets
3174 @c man begin OPTIONS
3176 The following options are supported to control microMIPS instruction
3177 generation and branch relocation checks for ISA mode transitions when
3178 linking for MIPS targets.
3186 These options control the choice of microMIPS instructions used in code
3187 generated by the linker, such as that in the PLT or lazy binding stubs,
3188 or in relaxation. If @samp{--insn32} is used, then the linker only uses
3189 32-bit instruction encodings. By default or if @samp{--no-insn32} is
3190 used, all instruction encodings are used, including 16-bit ones where
3193 @kindex --ignore-branch-isa
3194 @item --ignore-branch-isa
3195 @kindex --no-ignore-branch-isa
3196 @itemx --no-ignore-branch-isa
3197 These options control branch relocation checks for invalid ISA mode
3198 transitions. If @samp{--ignore-branch-isa} is used, then the linker
3199 accepts any branch relocations and any ISA mode transition required
3200 is lost in relocation calculation, except for some cases of @code{BAL}
3201 instructions which meet relaxation conditions and are converted to
3202 equivalent @code{JALX} instructions as the associated relocation is
3203 calculated. By default or if @samp{--no-ignore-branch-isa} is used
3204 a check is made causing the loss of an ISA mode transition to produce
3207 @kindex --compact-branches
3208 @item --compact-branches
3209 @kindex --no-compact-branches
3210 @item --compact-branches
3211 These options control the generation of compact instructions by the linker
3212 in the PLT entries for MIPS R6.
3221 @section Environment Variables
3223 @c man begin ENVIRONMENT
3225 You can change the behaviour of @command{ld} with the environment variables
3226 @ifclear SingleFormat
3229 @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}.
3231 @ifclear SingleFormat
3233 @cindex default input format
3234 @code{GNUTARGET} determines the input-file object format if you don't
3235 use @samp{-b} (or its synonym @samp{--format}). Its value should be one
3236 of the BFD names for an input format (@pxref{BFD}). If there is no
3237 @code{GNUTARGET} in the environment, @command{ld} uses the natural format
3238 of the target. If @code{GNUTARGET} is set to @code{default} then BFD
3239 attempts to discover the input format by examining binary input files;
3240 this method often succeeds, but there are potential ambiguities, since
3241 there is no method of ensuring that the magic number used to specify
3242 object-file formats is unique. However, the configuration procedure for
3243 BFD on each system places the conventional format for that system first
3244 in the search-list, so ambiguities are resolved in favor of convention.
3248 @cindex default emulation
3249 @cindex emulation, default
3250 @code{LDEMULATION} determines the default emulation if you don't use the
3251 @samp{-m} option. The emulation can affect various aspects of linker
3252 behaviour, particularly the default linker script. You can list the
3253 available emulations with the @samp{--verbose} or @samp{-V} options. If
3254 the @samp{-m} option is not used, and the @code{LDEMULATION} environment
3255 variable is not defined, the default emulation depends upon how the
3256 linker was configured.
3258 @kindex COLLECT_NO_DEMANGLE
3259 @cindex demangling, default
3260 Normally, the linker will default to demangling symbols. However, if
3261 @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will
3262 default to not demangling symbols. This environment variable is used in
3263 a similar fashion by the @code{gcc} linker wrapper program. The default
3264 may be overridden by the @samp{--demangle} and @samp{--no-demangle}
3271 @chapter Linker Scripts
3274 @cindex linker scripts
3275 @cindex command files
3276 Every link is controlled by a @dfn{linker script}. This script is
3277 written in the linker command language.
3279 The main purpose of the linker script is to describe how the sections in
3280 the input files should be mapped into the output file, and to control
3281 the memory layout of the output file. Most linker scripts do nothing
3282 more than this. However, when necessary, the linker script can also
3283 direct the linker to perform many other operations, using the commands
3286 The linker always uses a linker script. If you do not supply one
3287 yourself, the linker will use a default script that is compiled into the
3288 linker executable. You can use the @samp{--verbose} command-line option
3289 to display the default linker script. Certain command-line options,
3290 such as @samp{-r} or @samp{-N}, will affect the default linker script.
3292 You may supply your own linker script by using the @samp{-T} command
3293 line option. When you do this, your linker script will replace the
3294 default linker script.
3296 You may also use linker scripts implicitly by naming them as input files
3297 to the linker, as though they were files to be linked. @xref{Implicit
3301 * Basic Script Concepts:: Basic Linker Script Concepts
3302 * Script Format:: Linker Script Format
3303 * Simple Example:: Simple Linker Script Example
3304 * Simple Commands:: Simple Linker Script Commands
3305 * Assignments:: Assigning Values to Symbols
3306 * SECTIONS:: SECTIONS Command
3307 * MEMORY:: MEMORY Command
3308 * PHDRS:: PHDRS Command
3309 * VERSION:: VERSION Command
3310 * Expressions:: Expressions in Linker Scripts
3311 * Implicit Linker Scripts:: Implicit Linker Scripts
3314 @node Basic Script Concepts
3315 @section Basic Linker Script Concepts
3316 @cindex linker script concepts
3317 We need to define some basic concepts and vocabulary in order to
3318 describe the linker script language.
3320 The linker combines input files into a single output file. The output
3321 file and each input file are in a special data format known as an
3322 @dfn{object file format}. Each file is called an @dfn{object file}.
3323 The output file is often called an @dfn{executable}, but for our
3324 purposes we will also call it an object file. Each object file has,
3325 among other things, a list of @dfn{sections}. We sometimes refer to a
3326 section in an input file as an @dfn{input section}; similarly, a section
3327 in the output file is an @dfn{output section}.
3329 Each section in an object file has a name and a size. Most sections
3330 also have an associated block of data, known as the @dfn{section
3331 contents}. A section may be marked as @dfn{loadable}, which means that
3332 the contents should be loaded into memory when the output file is run.
3333 A section with no contents may be @dfn{allocatable}, which means that an
3334 area in memory should be set aside, but nothing in particular should be
3335 loaded there (in some cases this memory must be zeroed out). A section
3336 which is neither loadable nor allocatable typically contains some sort
3337 of debugging information.
3339 Every loadable or allocatable output section has two addresses. The
3340 first is the @dfn{VMA}, or virtual memory address. This is the address
3341 the section will have when the output file is run. The second is the
3342 @dfn{LMA}, or load memory address. This is the address at which the
3343 section will be loaded. In most cases the two addresses will be the
3344 same. An example of when they might be different is when a data section
3345 is loaded into ROM, and then copied into RAM when the program starts up
3346 (this technique is often used to initialize global variables in a ROM
3347 based system). In this case the ROM address would be the LMA, and the
3348 RAM address would be the VMA.
3350 You can see the sections in an object file by using the @code{objdump}
3351 program with the @samp{-h} option.
3353 Every object file also has a list of @dfn{symbols}, known as the
3354 @dfn{symbol table}. A symbol may be defined or undefined. Each symbol
3355 has a name, and each defined symbol has an address, among other
3356 information. If you compile a C or C++ program into an object file, you
3357 will get a defined symbol for every defined function and global or
3358 static variable. Every undefined function or global variable which is
3359 referenced in the input file will become an undefined symbol.
3361 You can see the symbols in an object file by using the @code{nm}
3362 program, or by using the @code{objdump} program with the @samp{-t}
3366 @section Linker Script Format
3367 @cindex linker script format
3368 Linker scripts are text files.
3370 You write a linker script as a series of commands. Each command is
3371 either a keyword, possibly followed by arguments, or an assignment to a
3372 symbol. You may separate commands using semicolons. Whitespace is
3375 Strings such as file or format names can normally be entered directly.
3376 If the file name contains a character such as a comma which would
3377 otherwise serve to separate file names, you may put the file name in
3378 double quotes. There is no way to use a double quote character in a
3381 You may include comments in linker scripts just as in C, delimited by
3382 @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent
3385 @node Simple Example
3386 @section Simple Linker Script Example
3387 @cindex linker script example
3388 @cindex example of linker script
3389 Many linker scripts are fairly simple.
3391 The simplest possible linker script has just one command:
3392 @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the
3393 memory layout of the output file.
3395 The @samp{SECTIONS} command is a powerful command. Here we will
3396 describe a simple use of it. Let's assume your program consists only of
3397 code, initialized data, and uninitialized data. These will be in the
3398 @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively.
3399 Let's assume further that these are the only sections which appear in
3402 For this example, let's say that the code should be loaded at address
3403 0x10000, and that the data should start at address 0x8000000. Here is a
3404 linker script which will do that:
3409 .text : @{ *(.text) @}
3411 .data : @{ *(.data) @}
3412 .bss : @{ *(.bss) @}
3416 You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS},
3417 followed by a series of symbol assignments and output section
3418 descriptions enclosed in curly braces.
3420 The first line inside the @samp{SECTIONS} command of the above example
3421 sets the value of the special symbol @samp{.}, which is the location
3422 counter. If you do not specify the address of an output section in some
3423 other way (other ways are described later), the address is set from the
3424 current value of the location counter. The location counter is then
3425 incremented by the size of the output section. At the start of the
3426 @samp{SECTIONS} command, the location counter has the value @samp{0}.
3428 The second line defines an output section, @samp{.text}. The colon is
3429 required syntax which may be ignored for now. Within the curly braces
3430 after the output section name, you list the names of the input sections
3431 which should be placed into this output section. The @samp{*} is a
3432 wildcard which matches any file name. The expression @samp{*(.text)}
3433 means all @samp{.text} input sections in all input files.
3435 Since the location counter is @samp{0x10000} when the output section
3436 @samp{.text} is defined, the linker will set the address of the
3437 @samp{.text} section in the output file to be @samp{0x10000}.
3439 The remaining lines define the @samp{.data} and @samp{.bss} sections in
3440 the output file. The linker will place the @samp{.data} output section
3441 at address @samp{0x8000000}. After the linker places the @samp{.data}
3442 output section, the value of the location counter will be
3443 @samp{0x8000000} plus the size of the @samp{.data} output section. The
3444 effect is that the linker will place the @samp{.bss} output section
3445 immediately after the @samp{.data} output section in memory.
3447 The linker will ensure that each output section has the required
3448 alignment, by increasing the location counter if necessary. In this
3449 example, the specified addresses for the @samp{.text} and @samp{.data}
3450 sections will probably satisfy any alignment constraints, but the linker
3451 may have to create a small gap between the @samp{.data} and @samp{.bss}
3454 That's it! That's a simple and complete linker script.
3456 @node Simple Commands
3457 @section Simple Linker Script Commands
3458 @cindex linker script simple commands
3459 In this section we describe the simple linker script commands.
3462 * Entry Point:: Setting the entry point
3463 * File Commands:: Commands dealing with files
3464 @ifclear SingleFormat
3465 * Format Commands:: Commands dealing with object file formats
3468 * REGION_ALIAS:: Assign alias names to memory regions
3469 * Miscellaneous Commands:: Other linker script commands
3473 @subsection Setting the Entry Point
3474 @kindex ENTRY(@var{symbol})
3475 @cindex start of execution
3476 @cindex first instruction
3478 The first instruction to execute in a program is called the @dfn{entry
3479 point}. You can use the @code{ENTRY} linker script command to set the
3480 entry point. The argument is a symbol name:
3485 There are several ways to set the entry point. The linker will set the
3486 entry point by trying each of the following methods in order, and
3487 stopping when one of them succeeds:
3490 the @samp{-e} @var{entry} command-line option;
3492 the @code{ENTRY(@var{symbol})} command in a linker script;
3494 the value of a target-specific symbol, if it is defined; For many
3495 targets this is @code{start}, but PE- and BeOS-based systems for example
3496 check a list of possible entry symbols, matching the first one found.
3498 the address of the first byte of the @samp{.text} section, if present;
3500 The address @code{0}.
3504 @subsection Commands Dealing with Files
3505 @cindex linker script file commands
3506 Several linker script commands deal with files.
3509 @item INCLUDE @var{filename}
3510 @kindex INCLUDE @var{filename}
3511 @cindex including a linker script
3512 Include the linker script @var{filename} at this point. The file will
3513 be searched for in the current directory, and in any directory specified
3514 with the @option{-L} option. You can nest calls to @code{INCLUDE} up to
3517 You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or
3518 @code{SECTIONS} commands, or in output section descriptions.
3520 @item INPUT(@var{file}, @var{file}, @dots{})
3521 @itemx INPUT(@var{file} @var{file} @dots{})
3522 @kindex INPUT(@var{files})
3523 @cindex input files in linker scripts
3524 @cindex input object files in linker scripts
3525 @cindex linker script input object files
3526 The @code{INPUT} command directs the linker to include the named files
3527 in the link, as though they were named on the command line.
3529 For example, if you always want to include @file{subr.o} any time you do
3530 a link, but you can't be bothered to put it on every link command line,
3531 then you can put @samp{INPUT (subr.o)} in your linker script.
3533 In fact, if you like, you can list all of your input files in the linker
3534 script, and then invoke the linker with nothing but a @samp{-T} option.
3536 In case a @dfn{sysroot prefix} is configured, and the filename starts
3537 with the @samp{/} character, and the script being processed was
3538 located inside the @dfn{sysroot prefix}, the filename will be looked
3539 for in the @dfn{sysroot prefix}. Otherwise, the linker will try to
3540 open the file in the current directory. If it is not found, the
3541 linker will search through the archive library search path.
3542 The @dfn{sysroot prefix} can also be forced by specifying @code{=}
3543 as the first character in the filename path, or prefixing the filename
3544 path with @code{$SYSROOT}. See also the description of @samp{-L} in
3545 @ref{Options,,Command-line Options}.
3547 If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the
3548 name to @code{lib@var{file}.a}, as with the command-line argument
3551 When you use the @code{INPUT} command in an implicit linker script, the
3552 files will be included in the link at the point at which the linker
3553 script file is included. This can affect archive searching.
3555 @item GROUP(@var{file}, @var{file}, @dots{})
3556 @itemx GROUP(@var{file} @var{file} @dots{})
3557 @kindex GROUP(@var{files})
3558 @cindex grouping input files
3559 The @code{GROUP} command is like @code{INPUT}, except that the named
3560 files should all be archives, and they are searched repeatedly until no
3561 new undefined references are created. See the description of @samp{-(}
3562 in @ref{Options,,Command-line Options}.
3564 @item AS_NEEDED(@var{file}, @var{file}, @dots{})
3565 @itemx AS_NEEDED(@var{file} @var{file} @dots{})
3566 @kindex AS_NEEDED(@var{files})
3567 This construct can appear only inside of the @code{INPUT} or @code{GROUP}
3568 commands, among other filenames. The files listed will be handled
3569 as if they appear directly in the @code{INPUT} or @code{GROUP} commands,
3570 with the exception of ELF shared libraries, that will be added only
3571 when they are actually needed. This construct essentially enables
3572 @option{--as-needed} option for all the files listed inside of it
3573 and restores previous @option{--as-needed} resp. @option{--no-as-needed}
3576 @item OUTPUT(@var{filename})
3577 @kindex OUTPUT(@var{filename})
3578 @cindex output file name in linker script
3579 The @code{OUTPUT} command names the output file. Using
3580 @code{OUTPUT(@var{filename})} in the linker script is exactly like using
3581 @samp{-o @var{filename}} on the command line (@pxref{Options,,Command
3582 Line Options}). If both are used, the command-line option takes
3585 You can use the @code{OUTPUT} command to define a default name for the
3586 output file other than the usual default of @file{a.out}.
3588 @item SEARCH_DIR(@var{path})
3589 @kindex SEARCH_DIR(@var{path})
3590 @cindex library search path in linker script
3591 @cindex archive search path in linker script
3592 @cindex search path in linker script
3593 The @code{SEARCH_DIR} command adds @var{path} to the list of paths where
3594 @command{ld} looks for archive libraries. Using
3595 @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}}
3596 on the command line (@pxref{Options,,Command-line Options}). If both
3597 are used, then the linker will search both paths. Paths specified using
3598 the command-line option are searched first.
3600 @item STARTUP(@var{filename})
3601 @kindex STARTUP(@var{filename})
3602 @cindex first input file
3603 The @code{STARTUP} command is just like the @code{INPUT} command, except
3604 that @var{filename} will become the first input file to be linked, as
3605 though it were specified first on the command line. This may be useful
3606 when using a system in which the entry point is always the start of the
3610 @ifclear SingleFormat
3611 @node Format Commands
3612 @subsection Commands Dealing with Object File Formats
3613 A couple of linker script commands deal with object file formats.
3616 @item OUTPUT_FORMAT(@var{bfdname})
3617 @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little})
3618 @kindex OUTPUT_FORMAT(@var{bfdname})
3619 @cindex output file format in linker script
3620 The @code{OUTPUT_FORMAT} command names the BFD format to use for the
3621 output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is
3622 exactly like using @samp{--oformat @var{bfdname}} on the command line
3623 (@pxref{Options,,Command-line Options}). If both are used, the command
3624 line option takes precedence.
3626 You can use @code{OUTPUT_FORMAT} with three arguments to use different
3627 formats based on the @samp{-EB} and @samp{-EL} command-line options.
3628 This permits the linker script to set the output format based on the
3631 If neither @samp{-EB} nor @samp{-EL} are used, then the output format
3632 will be the first argument, @var{default}. If @samp{-EB} is used, the
3633 output format will be the second argument, @var{big}. If @samp{-EL} is
3634 used, the output format will be the third argument, @var{little}.
3636 For example, the default linker script for the MIPS ELF target uses this
3639 OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips)
3641 This says that the default format for the output file is
3642 @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command-line
3643 option, the output file will be created in the @samp{elf32-littlemips}
3646 @item TARGET(@var{bfdname})
3647 @kindex TARGET(@var{bfdname})
3648 @cindex input file format in linker script
3649 The @code{TARGET} command names the BFD format to use when reading input
3650 files. It affects subsequent @code{INPUT} and @code{GROUP} commands.
3651 This command is like using @samp{-b @var{bfdname}} on the command line
3652 (@pxref{Options,,Command-line Options}). If the @code{TARGET} command
3653 is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET}
3654 command is also used to set the format for the output file. @xref{BFD}.
3659 @subsection Assign alias names to memory regions
3660 @kindex REGION_ALIAS(@var{alias}, @var{region})
3661 @cindex region alias
3662 @cindex region names
3664 Alias names can be added to existing memory regions created with the
3665 @ref{MEMORY} command. Each name corresponds to at most one memory region.
3668 REGION_ALIAS(@var{alias}, @var{region})
3671 The @code{REGION_ALIAS} function creates an alias name @var{alias} for the
3672 memory region @var{region}. This allows a flexible mapping of output sections
3673 to memory regions. An example follows.
3675 Suppose we have an application for embedded systems which come with various
3676 memory storage devices. All have a general purpose, volatile memory @code{RAM}
3677 that allows code execution or data storage. Some may have a read-only,
3678 non-volatile memory @code{ROM} that allows code execution and read-only data
3679 access. The last variant is a read-only, non-volatile memory @code{ROM2} with
3680 read-only data access and no code execution capability. We have four output
3685 @code{.text} program code;
3687 @code{.rodata} read-only data;
3689 @code{.data} read-write initialized data;
3691 @code{.bss} read-write zero initialized data.
3694 The goal is to provide a linker command file that contains a system independent
3695 part defining the output sections and a system dependent part mapping the
3696 output sections to the memory regions available on the system. Our embedded
3697 systems come with three different memory setups @code{A}, @code{B} and
3699 @multitable @columnfractions .25 .25 .25 .25
3700 @item Section @tab Variant A @tab Variant B @tab Variant C
3701 @item .text @tab RAM @tab ROM @tab ROM
3702 @item .rodata @tab RAM @tab ROM @tab ROM2
3703 @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2
3704 @item .bss @tab RAM @tab RAM @tab RAM
3706 The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is
3707 loaded into region @code{ROM} or @code{ROM2} respectively. Please note that
3708 the load address of the @code{.data} section starts in all three variants at
3709 the end of the @code{.rodata} section.
3711 The base linker script that deals with the output sections follows. It
3712 includes the system dependent @code{linkcmds.memory} file that describes the
3715 INCLUDE linkcmds.memory
3728 .data : AT (rodata_end)
3733 data_size = SIZEOF(.data);
3734 data_load_start = LOADADDR(.data);
3742 Now we need three different @code{linkcmds.memory} files to define memory
3743 regions and alias names. The content of @code{linkcmds.memory} for the three
3744 variants @code{A}, @code{B} and @code{C}:
3747 Here everything goes into the @code{RAM}.
3751 RAM : ORIGIN = 0, LENGTH = 4M
3754 REGION_ALIAS("REGION_TEXT", RAM);
3755 REGION_ALIAS("REGION_RODATA", RAM);
3756 REGION_ALIAS("REGION_DATA", RAM);
3757 REGION_ALIAS("REGION_BSS", RAM);
3760 Program code and read-only data go into the @code{ROM}. Read-write data goes
3761 into the @code{RAM}. An image of the initialized data is loaded into the
3762 @code{ROM} and will be copied during system start into the @code{RAM}.
3766 ROM : ORIGIN = 0, LENGTH = 3M
3767 RAM : ORIGIN = 0x10000000, LENGTH = 1M
3770 REGION_ALIAS("REGION_TEXT", ROM);
3771 REGION_ALIAS("REGION_RODATA", ROM);
3772 REGION_ALIAS("REGION_DATA", RAM);
3773 REGION_ALIAS("REGION_BSS", RAM);
3776 Program code goes into the @code{ROM}. Read-only data goes into the
3777 @code{ROM2}. Read-write data goes into the @code{RAM}. An image of the
3778 initialized data is loaded into the @code{ROM2} and will be copied during
3779 system start into the @code{RAM}.
3783 ROM : ORIGIN = 0, LENGTH = 2M
3784 ROM2 : ORIGIN = 0x10000000, LENGTH = 1M
3785 RAM : ORIGIN = 0x20000000, LENGTH = 1M
3788 REGION_ALIAS("REGION_TEXT", ROM);
3789 REGION_ALIAS("REGION_RODATA", ROM2);
3790 REGION_ALIAS("REGION_DATA", RAM);
3791 REGION_ALIAS("REGION_BSS", RAM);
3795 It is possible to write a common system initialization routine to copy the
3796 @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if
3801 extern char data_start [];
3802 extern char data_size [];
3803 extern char data_load_start [];
3805 void copy_data(void)
3807 if (data_start != data_load_start)
3809 memcpy(data_start, data_load_start, (size_t) data_size);
3814 @node Miscellaneous Commands
3815 @subsection Other Linker Script Commands
3816 There are a few other linker scripts commands.
3819 @item ASSERT(@var{exp}, @var{message})
3821 @cindex assertion in linker script
3822 Ensure that @var{exp} is non-zero. If it is zero, then exit the linker
3823 with an error code, and print @var{message}.
3825 Note that assertions are checked before the final stages of linking
3826 take place. This means that expressions involving symbols PROVIDEd
3827 inside section definitions will fail if the user has not set values
3828 for those symbols. The only exception to this rule is PROVIDEd
3829 symbols that just reference dot. Thus an assertion like this:
3834 PROVIDE (__stack = .);
3835 PROVIDE (__stack_size = 0x100);
3836 ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack");
3840 will fail if @code{__stack_size} is not defined elsewhere. Symbols
3841 PROVIDEd outside of section definitions are evaluated earlier, so they
3842 can be used inside ASSERTions. Thus:
3845 PROVIDE (__stack_size = 0x100);
3848 PROVIDE (__stack = .);
3849 ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack");
3855 @item EXTERN(@var{symbol} @var{symbol} @dots{})
3857 @cindex undefined symbol in linker script
3858 Force @var{symbol} to be entered in the output file as an undefined
3859 symbol. Doing this may, for example, trigger linking of additional
3860 modules from standard libraries. You may list several @var{symbol}s for
3861 each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This
3862 command has the same effect as the @samp{-u} command-line option.
3864 @item FORCE_COMMON_ALLOCATION
3865 @kindex FORCE_COMMON_ALLOCATION
3866 @cindex common allocation in linker script
3867 This command has the same effect as the @samp{-d} command-line option:
3868 to make @command{ld} assign space to common symbols even if a relocatable
3869 output file is specified (@samp{-r}).
3871 @item INHIBIT_COMMON_ALLOCATION
3872 @kindex INHIBIT_COMMON_ALLOCATION
3873 @cindex common allocation in linker script
3874 This command has the same effect as the @samp{--no-define-common}
3875 command-line option: to make @code{ld} omit the assignment of addresses
3876 to common symbols even for a non-relocatable output file.
3878 @item FORCE_GROUP_ALLOCATION
3879 @kindex FORCE_GROUP_ALLOCATION
3880 @cindex group allocation in linker script
3881 @cindex section groups
3883 This command has the same effect as the
3884 @samp{--force-group-allocation} command-line option: to make
3885 @command{ld} place section group members like normal input sections,
3886 and to delete the section groups even if a relocatable output file is
3887 specified (@samp{-r}).
3889 @item INSERT [ AFTER | BEFORE ] @var{output_section}
3891 @cindex insert user script into default script
3892 This command is typically used in a script specified by @samp{-T} to
3893 augment the default @code{SECTIONS} with, for example, overlays. It
3894 inserts all prior linker script statements after (or before)
3895 @var{output_section}, and also causes @samp{-T} to not override the
3896 default linker script. The exact insertion point is as for orphan
3897 sections. @xref{Location Counter}. The insertion happens after the
3898 linker has mapped input sections to output sections. Prior to the
3899 insertion, since @samp{-T} scripts are parsed before the default
3900 linker script, statements in the @samp{-T} script occur before the
3901 default linker script statements in the internal linker representation
3902 of the script. In particular, input section assignments will be made
3903 to @samp{-T} output sections before those in the default script. Here
3904 is an example of how a @samp{-T} script using @code{INSERT} might look:
3911 .ov1 @{ ov1*(.text) @}
3912 .ov2 @{ ov2*(.text) @}
3918 @item NOCROSSREFS(@var{section} @var{section} @dots{})
3919 @kindex NOCROSSREFS(@var{sections})
3920 @cindex cross references
3921 This command may be used to tell @command{ld} to issue an error about any
3922 references among certain output sections.
3924 In certain types of programs, particularly on embedded systems when
3925 using overlays, when one section is loaded into memory, another section
3926 will not be. Any direct references between the two sections would be
3927 errors. For example, it would be an error if code in one section called
3928 a function defined in the other section.
3930 The @code{NOCROSSREFS} command takes a list of output section names. If
3931 @command{ld} detects any cross references between the sections, it reports
3932 an error and returns a non-zero exit status. Note that the
3933 @code{NOCROSSREFS} command uses output section names, not input section
3936 @item NOCROSSREFS_TO(@var{tosection} @var{fromsection} @dots{})
3937 @kindex NOCROSSREFS_TO(@var{tosection} @var{fromsections})
3938 @cindex cross references
3939 This command may be used to tell @command{ld} to issue an error about any
3940 references to one section from a list of other sections.
3942 The @code{NOCROSSREFS} command is useful when ensuring that two or more
3943 output sections are entirely independent but there are situations where
3944 a one-way dependency is needed. For example, in a multi-core application
3945 there may be shared code that can be called from each core but for safety
3946 must never call back.
3948 The @code{NOCROSSREFS_TO} command takes a list of output section names.
3949 The first section can not be referenced from any of the other sections.
3950 If @command{ld} detects any references to the first section from any of
3951 the other sections, it reports an error and returns a non-zero exit
3952 status. Note that the @code{NOCROSSREFS_TO} command uses output section
3953 names, not input section names.
3955 @ifclear SingleFormat
3956 @item OUTPUT_ARCH(@var{bfdarch})
3957 @kindex OUTPUT_ARCH(@var{bfdarch})
3958 @cindex machine architecture
3959 @cindex architecture
3960 Specify a particular output machine architecture. The argument is one
3961 of the names used by the BFD library (@pxref{BFD}). You can see the
3962 architecture of an object file by using the @code{objdump} program with
3963 the @samp{-f} option.
3966 @item LD_FEATURE(@var{string})
3967 @kindex LD_FEATURE(@var{string})
3968 This command may be used to modify @command{ld} behavior. If
3969 @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers
3970 in a script are simply treated as numbers everywhere.
3971 @xref{Expression Section}.
3975 @section Assigning Values to Symbols
3976 @cindex assignment in scripts
3977 @cindex symbol definition, scripts
3978 @cindex variables, defining
3979 You may assign a value to a symbol in a linker script. This will define
3980 the symbol and place it into the symbol table with a global scope.
3983 * Simple Assignments:: Simple Assignments
3986 * PROVIDE_HIDDEN:: PROVIDE_HIDDEN
3987 * Source Code Reference:: How to use a linker script defined symbol in source code
3990 @node Simple Assignments
3991 @subsection Simple Assignments
3993 You may assign to a symbol using any of the C assignment operators:
3996 @item @var{symbol} = @var{expression} ;
3997 @itemx @var{symbol} += @var{expression} ;
3998 @itemx @var{symbol} -= @var{expression} ;
3999 @itemx @var{symbol} *= @var{expression} ;
4000 @itemx @var{symbol} /= @var{expression} ;
4001 @itemx @var{symbol} <<= @var{expression} ;
4002 @itemx @var{symbol} >>= @var{expression} ;
4003 @itemx @var{symbol} &= @var{expression} ;
4004 @itemx @var{symbol} |= @var{expression} ;
4007 The first case will define @var{symbol} to the value of
4008 @var{expression}. In the other cases, @var{symbol} must already be
4009 defined, and the value will be adjusted accordingly.
4011 The special symbol name @samp{.} indicates the location counter. You
4012 may only use this within a @code{SECTIONS} command. @xref{Location Counter}.
4014 The semicolon after @var{expression} is required.
4016 Expressions are defined below; see @ref{Expressions}.
4018 You may write symbol assignments as commands in their own right, or as
4019 statements within a @code{SECTIONS} command, or as part of an output
4020 section description in a @code{SECTIONS} command.
4022 The section of the symbol will be set from the section of the
4023 expression; for more information, see @ref{Expression Section}.
4025 Here is an example showing the three different places that symbol
4026 assignments may be used:
4037 _bdata = (. + 3) & ~ 3;
4038 .data : @{ *(.data) @}
4042 In this example, the symbol @samp{floating_point} will be defined as
4043 zero. The symbol @samp{_etext} will be defined as the address following
4044 the last @samp{.text} input section. The symbol @samp{_bdata} will be
4045 defined as the address following the @samp{.text} output section aligned
4046 upward to a 4 byte boundary.
4051 For ELF targeted ports, define a symbol that will be hidden and won't be
4052 exported. The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}.
4054 Here is the example from @ref{Simple Assignments}, rewritten to use
4058 HIDDEN(floating_point = 0);
4066 HIDDEN(_bdata = (. + 3) & ~ 3);
4067 .data : @{ *(.data) @}
4071 In this case none of the three symbols will be visible outside this module.
4076 In some cases, it is desirable for a linker script to define a symbol
4077 only if it is referenced and is not defined by any object included in
4078 the link. For example, traditional linkers defined the symbol
4079 @samp{etext}. However, ANSI C requires that the user be able to use
4080 @samp{etext} as a function name without encountering an error. The
4081 @code{PROVIDE} keyword may be used to define a symbol, such as
4082 @samp{etext}, only if it is referenced but not defined. The syntax is
4083 @code{PROVIDE(@var{symbol} = @var{expression})}.
4085 Here is an example of using @code{PROVIDE} to define @samp{etext}:
4098 In this example, if the program defines @samp{_etext} (with a leading
4099 underscore), the linker will give a multiple definition error. If, on
4100 the other hand, the program defines @samp{etext} (with no leading
4101 underscore), the linker will silently use the definition in the program.
4102 If the program references @samp{etext} but does not define it, the
4103 linker will use the definition in the linker script.
4105 Note - the @code{PROVIDE} directive considers a common symbol to be
4106 defined, even though such a symbol could be combined with the symbol
4107 that the @code{PROVIDE} would create. This is particularly important
4108 when considering constructor and destructor list symbols such as
4109 @samp{__CTOR_LIST__} as these are often defined as common symbols.
4111 @node PROVIDE_HIDDEN
4112 @subsection PROVIDE_HIDDEN
4113 @cindex PROVIDE_HIDDEN
4114 Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be
4115 hidden and won't be exported.
4117 @node Source Code Reference
4118 @subsection Source Code Reference
4120 Accessing a linker script defined variable from source code is not
4121 intuitive. In particular a linker script symbol is not equivalent to
4122 a variable declaration in a high level language, it is instead a
4123 symbol that does not have a value.
4125 Before going further, it is important to note that compilers often
4126 transform names in the source code into different names when they are
4127 stored in the symbol table. For example, Fortran compilers commonly
4128 prepend or append an underscore, and C++ performs extensive @samp{name
4129 mangling}. Therefore there might be a discrepancy between the name
4130 of a variable as it is used in source code and the name of the same
4131 variable as it is defined in a linker script. For example in C a
4132 linker script variable might be referred to as:
4138 But in the linker script it might be defined as:
4144 In the remaining examples however it is assumed that no name
4145 transformation has taken place.
4147 When a symbol is declared in a high level language such as C, two
4148 things happen. The first is that the compiler reserves enough space
4149 in the program's memory to hold the @emph{value} of the symbol. The
4150 second is that the compiler creates an entry in the program's symbol
4151 table which holds the symbol's @emph{address}. ie the symbol table
4152 contains the address of the block of memory holding the symbol's
4153 value. So for example the following C declaration, at file scope:
4159 creates an entry called @samp{foo} in the symbol table. This entry
4160 holds the address of an @samp{int} sized block of memory where the
4161 number 1000 is initially stored.
4163 When a program references a symbol the compiler generates code that
4164 first accesses the symbol table to find the address of the symbol's
4165 memory block and then code to read the value from that memory block.
4172 looks up the symbol @samp{foo} in the symbol table, gets the address
4173 associated with this symbol and then writes the value 1 into that
4180 looks up the symbol @samp{foo} in the symbol table, gets its address
4181 and then copies this address into the block of memory associated with
4182 the variable @samp{a}.
4184 Linker scripts symbol declarations, by contrast, create an entry in
4185 the symbol table but do not assign any memory to them. Thus they are
4186 an address without a value. So for example the linker script definition:
4192 creates an entry in the symbol table called @samp{foo} which holds
4193 the address of memory location 1000, but nothing special is stored at
4194 address 1000. This means that you cannot access the @emph{value} of a
4195 linker script defined symbol - it has no value - all you can do is
4196 access the @emph{address} of a linker script defined symbol.
4198 Hence when you are using a linker script defined symbol in source code
4199 you should always take the address of the symbol, and never attempt to
4200 use its value. For example suppose you want to copy the contents of a
4201 section of memory called .ROM into a section called .FLASH and the
4202 linker script contains these declarations:
4206 start_of_ROM = .ROM;
4207 end_of_ROM = .ROM + sizeof (.ROM);
4208 start_of_FLASH = .FLASH;
4212 Then the C source code to perform the copy would be:
4216 extern char start_of_ROM, end_of_ROM, start_of_FLASH;
4218 memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM);
4222 Note the use of the @samp{&} operators. These are correct.
4223 Alternatively the symbols can be treated as the names of vectors or
4224 arrays and then the code will again work as expected:
4228 extern char start_of_ROM[], end_of_ROM[], start_of_FLASH[];
4230 memcpy (start_of_FLASH, start_of_ROM, end_of_ROM - start_of_ROM);
4234 Note how using this method does not require the use of @samp{&}
4238 @section SECTIONS Command
4240 The @code{SECTIONS} command tells the linker how to map input sections
4241 into output sections, and how to place the output sections in memory.
4243 The format of the @code{SECTIONS} command is:
4247 @var{sections-command}
4248 @var{sections-command}
4253 Each @var{sections-command} may of be one of the following:
4257 an @code{ENTRY} command (@pxref{Entry Point,,Entry command})
4259 a symbol assignment (@pxref{Assignments})
4261 an output section description
4263 an overlay description
4266 The @code{ENTRY} command and symbol assignments are permitted inside the
4267 @code{SECTIONS} command for convenience in using the location counter in
4268 those commands. This can also make the linker script easier to
4269 understand because you can use those commands at meaningful points in
4270 the layout of the output file.
4272 Output section descriptions and overlay descriptions are described
4275 If you do not use a @code{SECTIONS} command in your linker script, the
4276 linker will place each input section into an identically named output
4277 section in the order that the sections are first encountered in the
4278 input files. If all input sections are present in the first file, for
4279 example, the order of sections in the output file will match the order
4280 in the first input file. The first section will be at address zero.
4283 * Output Section Description:: Output section description
4284 * Output Section Name:: Output section name
4285 * Output Section Address:: Output section address
4286 * Input Section:: Input section description
4287 * Output Section Data:: Output section data
4288 * Output Section Keywords:: Output section keywords
4289 * Output Section Discarding:: Output section discarding
4290 * Output Section Attributes:: Output section attributes
4291 * Overlay Description:: Overlay description
4294 @node Output Section Description
4295 @subsection Output Section Description
4296 The full description of an output section looks like this:
4299 @var{section} [@var{address}] [(@var{type})] :
4301 [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT]
4302 [SUBALIGN(@var{subsection_align})]
4305 @var{output-section-command}
4306 @var{output-section-command}
4308 @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] [,]
4312 Most output sections do not use most of the optional section attributes.
4314 The whitespace around @var{section} is required, so that the section
4315 name is unambiguous. The colon and the curly braces are also required.
4316 The comma at the end may be required if a @var{fillexp} is used and
4317 the next @var{sections-command} looks like a continuation of the expression.
4318 The line breaks and other white space are optional.
4320 Each @var{output-section-command} may be one of the following:
4324 a symbol assignment (@pxref{Assignments})
4326 an input section description (@pxref{Input Section})
4328 data values to include directly (@pxref{Output Section Data})
4330 a special output section keyword (@pxref{Output Section Keywords})
4333 @node Output Section Name
4334 @subsection Output Section Name
4335 @cindex name, section
4336 @cindex section name
4337 The name of the output section is @var{section}. @var{section} must
4338 meet the constraints of your output format. In formats which only
4339 support a limited number of sections, such as @code{a.out}, the name
4340 must be one of the names supported by the format (@code{a.out}, for
4341 example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the
4342 output format supports any number of sections, but with numbers and not
4343 names (as is the case for Oasys), the name should be supplied as a
4344 quoted numeric string. A section name may consist of any sequence of
4345 characters, but a name which contains any unusual characters such as
4346 commas must be quoted.
4348 The output section name @samp{/DISCARD/} is special; @ref{Output Section
4351 @node Output Section Address
4352 @subsection Output Section Address
4353 @cindex address, section
4354 @cindex section address
4355 The @var{address} is an expression for the VMA (the virtual memory
4356 address) of the output section. This address is optional, but if it
4357 is provided then the output address will be set exactly as specified.
4359 If the output address is not specified then one will be chosen for the
4360 section, based on the heuristic below. This address will be adjusted
4361 to fit the alignment requirement of the output section. The
4362 alignment requirement is the strictest alignment of any input section
4363 contained within the output section.
4365 The output section address heuristic is as follows:
4369 If an output memory @var{region} is set for the section then it
4370 is added to this region and its address will be the next free address
4374 If the MEMORY command has been used to create a list of memory
4375 regions then the first region which has attributes compatible with the
4376 section is selected to contain it. The section's output address will
4377 be the next free address in that region; @ref{MEMORY}.
4380 If no memory regions were specified, or none match the section then
4381 the output address will be based on the current value of the location
4389 .text . : @{ *(.text) @}
4396 .text : @{ *(.text) @}
4400 are subtly different. The first will set the address of the
4401 @samp{.text} output section to the current value of the location
4402 counter. The second will set it to the current value of the location
4403 counter aligned to the strictest alignment of any of the @samp{.text}
4406 The @var{address} may be an arbitrary expression; @ref{Expressions}.
4407 For example, if you want to align the section on a 0x10 byte boundary,
4408 so that the lowest four bits of the section address are zero, you could
4409 do something like this:
4411 .text ALIGN(0x10) : @{ *(.text) @}
4414 This works because @code{ALIGN} returns the current location counter
4415 aligned upward to the specified value.
4417 Specifying @var{address} for a section will change the value of the
4418 location counter, provided that the section is non-empty. (Empty
4419 sections are ignored).
4422 @subsection Input Section Description
4423 @cindex input sections
4424 @cindex mapping input sections to output sections
4425 The most common output section command is an input section description.
4427 The input section description is the most basic linker script operation.
4428 You use output sections to tell the linker how to lay out your program
4429 in memory. You use input section descriptions to tell the linker how to
4430 map the input files into your memory layout.
4433 * Input Section Basics:: Input section basics
4434 * Input Section Wildcards:: Input section wildcard patterns
4435 * Input Section Common:: Input section for common symbols
4436 * Input Section Keep:: Input section and garbage collection
4437 * Input Section Example:: Input section example
4440 @node Input Section Basics
4441 @subsubsection Input Section Basics
4442 @cindex input section basics
4443 An input section description consists of a file name optionally followed
4444 by a list of section names in parentheses.
4446 The file name and the section name may be wildcard patterns, which we
4447 describe further below (@pxref{Input Section Wildcards}).
4449 The most common input section description is to include all input
4450 sections with a particular name in the output section. For example, to
4451 include all input @samp{.text} sections, you would write:
4456 Here the @samp{*} is a wildcard which matches any file name. To exclude a list
4457 @cindex EXCLUDE_FILE
4458 of files from matching the file name wildcard, EXCLUDE_FILE may be used to
4459 match all files except the ones specified in the EXCLUDE_FILE list. For
4462 EXCLUDE_FILE (*crtend.o *otherfile.o) *(.ctors)
4465 will cause all .ctors sections from all files except @file{crtend.o}
4466 and @file{otherfile.o} to be included. The EXCLUDE_FILE can also be
4467 placed inside the section list, for example:
4469 *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)
4472 The result of this is identically to the previous example. Supporting
4473 two syntaxes for EXCLUDE_FILE is useful if the section list contains
4474 more than one section, as described below.
4476 There are two ways to include more than one section:
4482 The difference between these is the order in which the @samp{.text} and
4483 @samp{.rdata} input sections will appear in the output section. In the
4484 first example, they will be intermingled, appearing in the same order as
4485 they are found in the linker input. In the second example, all
4486 @samp{.text} input sections will appear first, followed by all
4487 @samp{.rdata} input sections.
4489 When using EXCLUDE_FILE with more than one section, if the exclusion
4490 is within the section list then the exclusion only applies to the
4491 immediately following section, for example:
4493 *(EXCLUDE_FILE (*somefile.o) .text .rdata)
4496 will cause all @samp{.text} sections from all files except
4497 @file{somefile.o} to be included, while all @samp{.rdata} sections
4498 from all files, including @file{somefile.o}, will be included. To
4499 exclude the @samp{.rdata} sections from @file{somefile.o} the example
4500 could be modified to:
4502 *(EXCLUDE_FILE (*somefile.o) .text EXCLUDE_FILE (*somefile.o) .rdata)
4505 Alternatively, placing the EXCLUDE_FILE outside of the section list,
4506 before the input file selection, will cause the exclusion to apply for
4507 all sections. Thus the previous example can be rewritten as:
4509 EXCLUDE_FILE (*somefile.o) *(.text .rdata)
4512 You can specify a file name to include sections from a particular file.
4513 You would do this if one or more of your files contain special data that
4514 needs to be at a particular location in memory. For example:
4519 To refine the sections that are included based on the section flags
4520 of an input section, INPUT_SECTION_FLAGS may be used.
4522 Here is a simple example for using Section header flags for ELF sections:
4527 .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @}
4528 .text2 : @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @}
4533 In this example, the output section @samp{.text} will be comprised of any
4534 input section matching the name *(.text) whose section header flags
4535 @code{SHF_MERGE} and @code{SHF_STRINGS} are set. The output section
4536 @samp{.text2} will be comprised of any input section matching the name *(.text)
4537 whose section header flag @code{SHF_WRITE} is clear.
4539 You can also specify files within archives by writing a pattern
4540 matching the archive, a colon, then the pattern matching the file,
4541 with no whitespace around the colon.
4545 matches file within archive
4547 matches the whole archive
4549 matches file but not one in an archive
4552 Either one or both of @samp{archive} and @samp{file} can contain shell
4553 wildcards. On DOS based file systems, the linker will assume that a
4554 single letter followed by a colon is a drive specifier, so
4555 @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o}
4556 within an archive called @samp{c}. @samp{archive:file} filespecs may
4557 also be used within an @code{EXCLUDE_FILE} list, but may not appear in
4558 other linker script contexts. For instance, you cannot extract a file
4559 from an archive by using @samp{archive:file} in an @code{INPUT}
4562 If you use a file name without a list of sections, then all sections in
4563 the input file will be included in the output section. This is not
4564 commonly done, but it may by useful on occasion. For example:
4569 When you use a file name which is not an @samp{archive:file} specifier
4570 and does not contain any wild card
4571 characters, the linker will first see if you also specified the file
4572 name on the linker command line or in an @code{INPUT} command. If you
4573 did not, the linker will attempt to open the file as an input file, as
4574 though it appeared on the command line. Note that this differs from an
4575 @code{INPUT} command, because the linker will not search for the file in
4576 the archive search path.
4578 @node Input Section Wildcards
4579 @subsubsection Input Section Wildcard Patterns
4580 @cindex input section wildcards
4581 @cindex wildcard file name patterns
4582 @cindex file name wildcard patterns
4583 @cindex section name wildcard patterns
4584 In an input section description, either the file name or the section
4585 name or both may be wildcard patterns.
4587 The file name of @samp{*} seen in many examples is a simple wildcard
4588 pattern for the file name.
4590 The wildcard patterns are like those used by the Unix shell.
4594 matches any number of characters
4596 matches any single character
4598 matches a single instance of any of the @var{chars}; the @samp{-}
4599 character may be used to specify a range of characters, as in
4600 @samp{[a-z]} to match any lower case letter
4602 quotes the following character
4605 When a file name is matched with a wildcard, the wildcard characters
4606 will not match a @samp{/} character (used to separate directory names on
4607 Unix). A pattern consisting of a single @samp{*} character is an
4608 exception; it will always match any file name, whether it contains a
4609 @samp{/} or not. In a section name, the wildcard characters will match
4610 a @samp{/} character.
4612 File name wildcard patterns only match files which are explicitly
4613 specified on the command line or in an @code{INPUT} command. The linker
4614 does not search directories to expand wildcards.
4616 If a file name matches more than one wildcard pattern, or if a file name
4617 appears explicitly and is also matched by a wildcard pattern, the linker
4618 will use the first match in the linker script. For example, this
4619 sequence of input section descriptions is probably in error, because the
4620 @file{data.o} rule will not be used:
4622 .data : @{ *(.data) @}
4623 .data1 : @{ data.o(.data) @}
4626 @cindex SORT_BY_NAME
4627 Normally, the linker will place files and sections matched by wildcards
4628 in the order in which they are seen during the link. You can change
4629 this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard
4630 pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the
4631 @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections
4632 into ascending order by name before placing them in the output file.
4634 @cindex SORT_BY_ALIGNMENT
4635 @code{SORT_BY_ALIGNMENT} is similar to @code{SORT_BY_NAME}.
4636 @code{SORT_BY_ALIGNMENT} will sort sections into descending order of
4637 alignment before placing them in the output file. Placing larger
4638 alignments before smaller alignments can reduce the amount of padding
4641 @cindex SORT_BY_INIT_PRIORITY
4642 @code{SORT_BY_INIT_PRIORITY} is also similar to @code{SORT_BY_NAME}.
4643 @code{SORT_BY_INIT_PRIORITY} will sort sections into ascending
4644 numerical order of the GCC init_priority attribute encoded in the
4645 section name before placing them in the output file. In
4646 @code{.init_array.NNNNN} and @code{.fini_array.NNNNN}, @code{NNNNN} is
4647 the init_priority. In @code{.ctors.NNNNN} and @code{.dtors.NNNNN},
4648 @code{NNNNN} is 65535 minus the init_priority.
4651 @code{SORT} is an alias for @code{SORT_BY_NAME}.
4653 When there are nested section sorting commands in linker script, there
4654 can be at most 1 level of nesting for section sorting commands.
4658 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4659 It will sort the input sections by name first, then by alignment if two
4660 sections have the same name.
4662 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4663 It will sort the input sections by alignment first, then by name if two
4664 sections have the same alignment.
4666 @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is
4667 treated the same as @code{SORT_BY_NAME} (wildcard section pattern).
4669 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern))
4670 is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern).
4672 All other nested section sorting commands are invalid.
4675 When both command-line section sorting option and linker script
4676 section sorting command are used, section sorting command always
4677 takes precedence over the command-line option.
4679 If the section sorting command in linker script isn't nested, the
4680 command-line option will make the section sorting command to be
4681 treated as nested sorting command.
4685 @code{SORT_BY_NAME} (wildcard section pattern ) with
4686 @option{--sort-sections alignment} is equivalent to
4687 @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)).
4689 @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with
4690 @option{--sort-section name} is equivalent to
4691 @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)).
4694 If the section sorting command in linker script is nested, the
4695 command-line option will be ignored.
4698 @code{SORT_NONE} disables section sorting by ignoring the command-line
4699 section sorting option.
4701 If you ever get confused about where input sections are going, use the
4702 @samp{-M} linker option to generate a map file. The map file shows
4703 precisely how input sections are mapped to output sections.
4705 This example shows how wildcard patterns might be used to partition
4706 files. This linker script directs the linker to place all @samp{.text}
4707 sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}.
4708 The linker will place the @samp{.data} section from all files beginning
4709 with an upper case character in @samp{.DATA}; for all other files, the
4710 linker will place the @samp{.data} section in @samp{.data}.
4714 .text : @{ *(.text) @}
4715 .DATA : @{ [A-Z]*(.data) @}
4716 .data : @{ *(.data) @}
4717 .bss : @{ *(.bss) @}
4722 @node Input Section Common
4723 @subsubsection Input Section for Common Symbols
4724 @cindex common symbol placement
4725 @cindex uninitialized data placement
4726 A special notation is needed for common symbols, because in many object
4727 file formats common symbols do not have a particular input section. The
4728 linker treats common symbols as though they are in an input section
4729 named @samp{COMMON}.
4731 You may use file names with the @samp{COMMON} section just as with any
4732 other input sections. You can use this to place common symbols from a
4733 particular input file in one section while common symbols from other
4734 input files are placed in another section.
4736 In most cases, common symbols in input files will be placed in the
4737 @samp{.bss} section in the output file. For example:
4739 .bss @{ *(.bss) *(COMMON) @}
4742 @cindex scommon section
4743 @cindex small common symbols
4744 Some object file formats have more than one type of common symbol. For
4745 example, the MIPS ELF object file format distinguishes standard common
4746 symbols and small common symbols. In this case, the linker will use a
4747 different special section name for other types of common symbols. In
4748 the case of MIPS ELF, the linker uses @samp{COMMON} for standard common
4749 symbols and @samp{.scommon} for small common symbols. This permits you
4750 to map the different types of common symbols into memory at different
4754 You will sometimes see @samp{[COMMON]} in old linker scripts. This
4755 notation is now considered obsolete. It is equivalent to
4758 @node Input Section Keep
4759 @subsubsection Input Section and Garbage Collection
4761 @cindex garbage collection
4762 When link-time garbage collection is in use (@samp{--gc-sections}),
4763 it is often useful to mark sections that should not be eliminated.
4764 This is accomplished by surrounding an input section's wildcard entry
4765 with @code{KEEP()}, as in @code{KEEP(*(.init))} or
4766 @code{KEEP(SORT_BY_NAME(*)(.ctors))}.
4768 @node Input Section Example
4769 @subsubsection Input Section Example
4770 The following example is a complete linker script. It tells the linker
4771 to read all of the sections from file @file{all.o} and place them at the
4772 start of output section @samp{outputa} which starts at location
4773 @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o}
4774 follows immediately, in the same output section. All of section
4775 @samp{.input2} from @file{foo.o} goes into output section
4776 @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}.
4777 All of the remaining @samp{.input1} and @samp{.input2} sections from any
4778 files are written to output section @samp{outputc}.
4806 If an output section's name is the same as the input section's name
4807 and is representable as a C identifier, then the linker will
4808 automatically @pxref{PROVIDE} two symbols: __start_SECNAME and
4809 __stop_SECNAME, where SECNAME is the name of the section. These
4810 indicate the start address and end address of the output section
4811 respectively. Note: most section names are not representable as
4812 C identifiers because they contain a @samp{.} character.
4814 @node Output Section Data
4815 @subsection Output Section Data
4817 @cindex section data
4818 @cindex output section data
4819 @kindex BYTE(@var{expression})
4820 @kindex SHORT(@var{expression})
4821 @kindex LONG(@var{expression})
4822 @kindex QUAD(@var{expression})
4823 @kindex SQUAD(@var{expression})
4824 You can include explicit bytes of data in an output section by using
4825 @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as
4826 an output section command. Each keyword is followed by an expression in
4827 parentheses providing the value to store (@pxref{Expressions}). The
4828 value of the expression is stored at the current value of the location
4831 The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands
4832 store one, two, four, and eight bytes (respectively). After storing the
4833 bytes, the location counter is incremented by the number of bytes
4836 For example, this will store the byte 1 followed by the four byte value
4837 of the symbol @samp{addr}:
4843 When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the
4844 same; they both store an 8 byte, or 64 bit, value. When both host and
4845 target are 32 bits, an expression is computed as 32 bits. In this case
4846 @code{QUAD} stores a 32 bit value zero extended to 64 bits, and
4847 @code{SQUAD} stores a 32 bit value sign extended to 64 bits.
4849 If the object file format of the output file has an explicit endianness,
4850 which is the normal case, the value will be stored in that endianness.
4851 When the object file format does not have an explicit endianness, as is
4852 true of, for example, S-records, the value will be stored in the
4853 endianness of the first input object file.
4855 Note---these commands only work inside a section description and not
4856 between them, so the following will produce an error from the linker:
4858 SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@
4860 whereas this will work:
4862 SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@
4865 @kindex FILL(@var{expression})
4866 @cindex holes, filling
4867 @cindex unspecified memory
4868 You may use the @code{FILL} command to set the fill pattern for the
4869 current section. It is followed by an expression in parentheses. Any
4870 otherwise unspecified regions of memory within the section (for example,
4871 gaps left due to the required alignment of input sections) are filled
4872 with the value of the expression, repeated as
4873 necessary. A @code{FILL} statement covers memory locations after the
4874 point at which it occurs in the section definition; by including more
4875 than one @code{FILL} statement, you can have different fill patterns in
4876 different parts of an output section.
4878 This example shows how to fill unspecified regions of memory with the
4884 The @code{FILL} command is similar to the @samp{=@var{fillexp}} output
4885 section attribute, but it only affects the
4886 part of the section following the @code{FILL} command, rather than the
4887 entire section. If both are used, the @code{FILL} command takes
4888 precedence. @xref{Output Section Fill}, for details on the fill
4891 @node Output Section Keywords
4892 @subsection Output Section Keywords
4893 There are a couple of keywords which can appear as output section
4897 @kindex CREATE_OBJECT_SYMBOLS
4898 @cindex input filename symbols
4899 @cindex filename symbols
4900 @item CREATE_OBJECT_SYMBOLS
4901 The command tells the linker to create a symbol for each input file.
4902 The name of each symbol will be the name of the corresponding input
4903 file. The section of each symbol will be the output section in which
4904 the @code{CREATE_OBJECT_SYMBOLS} command appears.
4906 This is conventional for the a.out object file format. It is not
4907 normally used for any other object file format.
4909 @kindex CONSTRUCTORS
4910 @cindex C++ constructors, arranging in link
4911 @cindex constructors, arranging in link
4913 When linking using the a.out object file format, the linker uses an
4914 unusual set construct to support C++ global constructors and
4915 destructors. When linking object file formats which do not support
4916 arbitrary sections, such as ECOFF and XCOFF, the linker will
4917 automatically recognize C++ global constructors and destructors by name.
4918 For these object file formats, the @code{CONSTRUCTORS} command tells the
4919 linker to place constructor information in the output section where the
4920 @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is
4921 ignored for other object file formats.
4923 The symbol @w{@code{__CTOR_LIST__}} marks the start of the global
4924 constructors, and the symbol @w{@code{__CTOR_END__}} marks the end.
4925 Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark
4926 the start and end of the global destructors. The
4927 first word in the list is the number of entries, followed by the address
4928 of each constructor or destructor, followed by a zero word. The
4929 compiler must arrange to actually run the code. For these object file
4930 formats @sc{gnu} C++ normally calls constructors from a subroutine
4931 @code{__main}; a call to @code{__main} is automatically inserted into
4932 the startup code for @code{main}. @sc{gnu} C++ normally runs
4933 destructors either by using @code{atexit}, or directly from the function
4936 For object file formats such as @code{COFF} or @code{ELF} which support
4937 arbitrary section names, @sc{gnu} C++ will normally arrange to put the
4938 addresses of global constructors and destructors into the @code{.ctors}
4939 and @code{.dtors} sections. Placing the following sequence into your
4940 linker script will build the sort of table which the @sc{gnu} C++
4941 runtime code expects to see.
4945 LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2)
4950 LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2)
4956 If you are using the @sc{gnu} C++ support for initialization priority,
4957 which provides some control over the order in which global constructors
4958 are run, you must sort the constructors at link time to ensure that they
4959 are executed in the correct order. When using the @code{CONSTRUCTORS}
4960 command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the
4961 @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and
4962 @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and
4965 Normally the compiler and linker will handle these issues automatically,
4966 and you will not need to concern yourself with them. However, you may
4967 need to consider this if you are using C++ and writing your own linker
4972 @node Output Section Discarding
4973 @subsection Output Section Discarding
4974 @cindex discarding sections
4975 @cindex sections, discarding
4976 @cindex removing sections
4977 The linker will not normally create output sections with no contents.
4978 This is for convenience when referring to input sections that may or
4979 may not be present in any of the input files. For example:
4981 .foo : @{ *(.foo) @}
4984 will only create a @samp{.foo} section in the output file if there is a
4985 @samp{.foo} section in at least one input file, and if the input
4986 sections are not all empty. Other link script directives that allocate
4987 space in an output section will also create the output section. So
4988 too will assignments to dot even if the assignment does not create
4989 space, except for @samp{. = 0}, @samp{. = . + 0}, @samp{. = sym},
4990 @samp{. = . + sym} and @samp{. = ALIGN (. != 0, expr, 1)} when
4991 @samp{sym} is an absolute symbol of value 0 defined in the script.
4992 This allows you to force output of an empty section with @samp{. = .}.
4994 The linker will ignore address assignments (@pxref{Output Section Address})
4995 on discarded output sections, except when the linker script defines
4996 symbols in the output section. In that case the linker will obey
4997 the address assignments, possibly advancing dot even though the
4998 section is discarded.
5001 The special output section name @samp{/DISCARD/} may be used to discard
5002 input sections. Any input sections which are assigned to an output
5003 section named @samp{/DISCARD/} are not included in the output file.
5005 Note, sections that match the @samp{/DISCARD/} output section will be
5006 discarded even if they are in an ELF section group which has other
5007 members which are not being discarded. This is deliberate.
5008 Discarding takes precedence over grouping.
5010 @node Output Section Attributes
5011 @subsection Output Section Attributes
5012 @cindex output section attributes
5013 We showed above that the full description of an output section looked
5018 @var{section} [@var{address}] [(@var{type})] :
5020 [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT]
5021 [SUBALIGN(@var{subsection_align})]
5024 @var{output-section-command}
5025 @var{output-section-command}
5027 @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}]
5031 We've already described @var{section}, @var{address}, and
5032 @var{output-section-command}. In this section we will describe the
5033 remaining section attributes.
5036 * Output Section Type:: Output section type
5037 * Output Section LMA:: Output section LMA
5038 * Forced Output Alignment:: Forced Output Alignment
5039 * Forced Input Alignment:: Forced Input Alignment
5040 * Output Section Constraint:: Output section constraint
5041 * Output Section Region:: Output section region
5042 * Output Section Phdr:: Output section phdr
5043 * Output Section Fill:: Output section fill
5046 @node Output Section Type
5047 @subsubsection Output Section Type
5048 Each output section may have a type. The type is a keyword in
5049 parentheses. The following types are defined:
5053 The section should be marked as not loadable, so that it will not be
5054 loaded into memory when the program is run.
5059 These type names are supported for backward compatibility, and are
5060 rarely used. They all have the same effect: the section should be
5061 marked as not allocatable, so that no memory is allocated for the
5062 section when the program is run.
5066 @cindex prevent unnecessary loading
5067 @cindex loading, preventing
5068 The linker normally sets the attributes of an output section based on
5069 the input sections which map into it. You can override this by using
5070 the section type. For example, in the script sample below, the
5071 @samp{ROM} section is addressed at memory location @samp{0} and does not
5072 need to be loaded when the program is run.
5076 ROM 0 (NOLOAD) : @{ @dots{} @}
5082 @node Output Section LMA
5083 @subsubsection Output Section LMA
5084 @kindex AT>@var{lma_region}
5085 @kindex AT(@var{lma})
5086 @cindex load address
5087 @cindex section load address
5088 Every section has a virtual address (VMA) and a load address (LMA); see
5089 @ref{Basic Script Concepts}. The virtual address is specified by the
5090 @pxref{Output Section Address} described earlier. The load address is
5091 specified by the @code{AT} or @code{AT>} keywords. Specifying a load
5092 address is optional.
5094 The @code{AT} keyword takes an expression as an argument. This
5095 specifies the exact load address of the section. The @code{AT>} keyword
5096 takes the name of a memory region as an argument. @xref{MEMORY}. The
5097 load address of the section is set to the next free address in the
5098 region, aligned to the section's alignment requirements.
5100 If neither @code{AT} nor @code{AT>} is specified for an allocatable
5101 section, the linker will use the following heuristic to determine the
5106 If the section has a specific VMA address, then this is used as
5107 the LMA address as well.
5110 If the section is not allocatable then its LMA is set to its VMA.
5113 Otherwise if a memory region can be found that is compatible
5114 with the current section, and this region contains at least one
5115 section, then the LMA is set so the difference between the
5116 VMA and LMA is the same as the difference between the VMA and LMA of
5117 the last section in the located region.
5120 If no memory regions have been declared then a default region
5121 that covers the entire address space is used in the previous step.
5124 If no suitable region could be found, or there was no previous
5125 section then the LMA is set equal to the VMA.
5128 @cindex ROM initialized data
5129 @cindex initialized data in ROM
5130 This feature is designed to make it easy to build a ROM image. For
5131 example, the following linker script creates three output sections: one
5132 called @samp{.text}, which starts at @code{0x1000}, one called
5133 @samp{.mdata}, which is loaded at the end of the @samp{.text} section
5134 even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold
5135 uninitialized data at address @code{0x3000}. The symbol @code{_data} is
5136 defined with the value @code{0x2000}, which shows that the location
5137 counter holds the VMA value, not the LMA value.
5143 .text 0x1000 : @{ *(.text) _etext = . ; @}
5145 AT ( ADDR (.text) + SIZEOF (.text) )
5146 @{ _data = . ; *(.data); _edata = . ; @}
5148 @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@}
5153 The run-time initialization code for use with a program generated with
5154 this linker script would include something like the following, to copy
5155 the initialized data from the ROM image to its runtime address. Notice
5156 how this code takes advantage of the symbols defined by the linker
5161 extern char _etext, _data, _edata, _bstart, _bend;
5162 char *src = &_etext;
5165 /* ROM has data at end of text; copy it. */
5166 while (dst < &_edata)
5170 for (dst = &_bstart; dst< &_bend; dst++)
5175 @node Forced Output Alignment
5176 @subsubsection Forced Output Alignment
5177 @kindex ALIGN(@var{section_align})
5178 @cindex forcing output section alignment
5179 @cindex output section alignment
5180 You can increase an output section's alignment by using ALIGN. As an
5181 alternative you can enforce that the difference between the VMA and LMA remains
5182 intact throughout this output section with the ALIGN_WITH_INPUT attribute.
5184 @node Forced Input Alignment
5185 @subsubsection Forced Input Alignment
5186 @kindex SUBALIGN(@var{subsection_align})
5187 @cindex forcing input section alignment
5188 @cindex input section alignment
5189 You can force input section alignment within an output section by using
5190 SUBALIGN. The value specified overrides any alignment given by input
5191 sections, whether larger or smaller.
5193 @node Output Section Constraint
5194 @subsubsection Output Section Constraint
5197 @cindex constraints on output sections
5198 You can specify that an output section should only be created if all
5199 of its input sections are read-only or all of its input sections are
5200 read-write by using the keyword @code{ONLY_IF_RO} and
5201 @code{ONLY_IF_RW} respectively.
5203 @node Output Section Region
5204 @subsubsection Output Section Region
5205 @kindex >@var{region}
5206 @cindex section, assigning to memory region
5207 @cindex memory regions and sections
5208 You can assign a section to a previously defined region of memory by
5209 using @samp{>@var{region}}. @xref{MEMORY}.
5211 Here is a simple example:
5214 MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @}
5215 SECTIONS @{ ROM : @{ *(.text) @} >rom @}
5219 @node Output Section Phdr
5220 @subsubsection Output Section Phdr
5222 @cindex section, assigning to program header
5223 @cindex program headers and sections
5224 You can assign a section to a previously defined program segment by
5225 using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to
5226 one or more segments, then all subsequent allocated sections will be
5227 assigned to those segments as well, unless they use an explicitly
5228 @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the
5229 linker to not put the section in any segment at all.
5231 Here is a simple example:
5234 PHDRS @{ text PT_LOAD ; @}
5235 SECTIONS @{ .text : @{ *(.text) @} :text @}
5239 @node Output Section Fill
5240 @subsubsection Output Section Fill
5241 @kindex =@var{fillexp}
5242 @cindex section fill pattern
5243 @cindex fill pattern, entire section
5244 You can set the fill pattern for an entire section by using
5245 @samp{=@var{fillexp}}. @var{fillexp} is an expression
5246 (@pxref{Expressions}). Any otherwise unspecified regions of memory
5247 within the output section (for example, gaps left due to the required
5248 alignment of input sections) will be filled with the value, repeated as
5249 necessary. If the fill expression is a simple hex number, ie. a string
5250 of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then
5251 an arbitrarily long sequence of hex digits can be used to specify the
5252 fill pattern; Leading zeros become part of the pattern too. For all
5253 other cases, including extra parentheses or a unary @code{+}, the fill
5254 pattern is the four least significant bytes of the value of the
5255 expression. In all cases, the number is big-endian.
5257 You can also change the fill value with a @code{FILL} command in the
5258 output section commands; (@pxref{Output Section Data}).
5260 Here is a simple example:
5263 SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @}
5267 @node Overlay Description
5268 @subsection Overlay Description
5271 An overlay description provides an easy way to describe sections which
5272 are to be loaded as part of a single memory image but are to be run at
5273 the same memory address. At run time, some sort of overlay manager will
5274 copy the overlaid sections in and out of the runtime memory address as
5275 required, perhaps by simply manipulating addressing bits. This approach
5276 can be useful, for example, when a certain region of memory is faster
5279 Overlays are described using the @code{OVERLAY} command. The
5280 @code{OVERLAY} command is used within a @code{SECTIONS} command, like an
5281 output section description. The full syntax of the @code{OVERLAY}
5282 command is as follows:
5285 OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )]
5289 @var{output-section-command}
5290 @var{output-section-command}
5292 @} [:@var{phdr}@dots{}] [=@var{fill}]
5295 @var{output-section-command}
5296 @var{output-section-command}
5298 @} [:@var{phdr}@dots{}] [=@var{fill}]
5300 @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] [,]
5304 Everything is optional except @code{OVERLAY} (a keyword), and each
5305 section must have a name (@var{secname1} and @var{secname2} above). The
5306 section definitions within the @code{OVERLAY} construct are identical to
5307 those within the general @code{SECTIONS} construct (@pxref{SECTIONS}),
5308 except that no addresses and no memory regions may be defined for
5309 sections within an @code{OVERLAY}.
5311 The comma at the end may be required if a @var{fill} is used and
5312 the next @var{sections-command} looks like a continuation of the expression.
5314 The sections are all defined with the same starting address. The load
5315 addresses of the sections are arranged such that they are consecutive in
5316 memory starting at the load address used for the @code{OVERLAY} as a
5317 whole (as with normal section definitions, the load address is optional,
5318 and defaults to the start address; the start address is also optional,
5319 and defaults to the current value of the location counter).
5321 If the @code{NOCROSSREFS} keyword is used, and there are any
5322 references among the sections, the linker will report an error. Since
5323 the sections all run at the same address, it normally does not make
5324 sense for one section to refer directly to another.
5325 @xref{Miscellaneous Commands, NOCROSSREFS}.
5327 For each section within the @code{OVERLAY}, the linker automatically
5328 provides two symbols. The symbol @code{__load_start_@var{secname}} is
5329 defined as the starting load address of the section. The symbol
5330 @code{__load_stop_@var{secname}} is defined as the final load address of
5331 the section. Any characters within @var{secname} which are not legal
5332 within C identifiers are removed. C (or assembler) code may use these
5333 symbols to move the overlaid sections around as necessary.
5335 At the end of the overlay, the value of the location counter is set to
5336 the start address of the overlay plus the size of the largest section.
5338 Here is an example. Remember that this would appear inside a
5339 @code{SECTIONS} construct.
5342 OVERLAY 0x1000 : AT (0x4000)
5344 .text0 @{ o1/*.o(.text) @}
5345 .text1 @{ o2/*.o(.text) @}
5350 This will define both @samp{.text0} and @samp{.text1} to start at
5351 address 0x1000. @samp{.text0} will be loaded at address 0x4000, and
5352 @samp{.text1} will be loaded immediately after @samp{.text0}. The
5353 following symbols will be defined if referenced: @code{__load_start_text0},
5354 @code{__load_stop_text0}, @code{__load_start_text1},
5355 @code{__load_stop_text1}.
5357 C code to copy overlay @code{.text1} into the overlay area might look
5362 extern char __load_start_text1, __load_stop_text1;
5363 memcpy ((char *) 0x1000, &__load_start_text1,
5364 &__load_stop_text1 - &__load_start_text1);
5368 Note that the @code{OVERLAY} command is just syntactic sugar, since
5369 everything it does can be done using the more basic commands. The above
5370 example could have been written identically as follows.
5374 .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @}
5375 PROVIDE (__load_start_text0 = LOADADDR (.text0));
5376 PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0));
5377 .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @}
5378 PROVIDE (__load_start_text1 = LOADADDR (.text1));
5379 PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1));
5380 . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1));
5385 @section MEMORY Command
5387 @cindex memory regions
5388 @cindex regions of memory
5389 @cindex allocating memory
5390 @cindex discontinuous memory
5391 The linker's default configuration permits allocation of all available
5392 memory. You can override this by using the @code{MEMORY} command.
5394 The @code{MEMORY} command describes the location and size of blocks of
5395 memory in the target. You can use it to describe which memory regions
5396 may be used by the linker, and which memory regions it must avoid. You
5397 can then assign sections to particular memory regions. The linker will
5398 set section addresses based on the memory regions, and will warn about
5399 regions that become too full. The linker will not shuffle sections
5400 around to fit into the available regions.
5402 A linker script may contain many uses of the @code{MEMORY} command,
5403 however, all memory blocks defined are treated as if they were
5404 specified inside a single @code{MEMORY} command. The syntax for
5410 @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len}
5416 The @var{name} is a name used in the linker script to refer to the
5417 region. The region name has no meaning outside of the linker script.
5418 Region names are stored in a separate name space, and will not conflict
5419 with symbol names, file names, or section names. Each memory region
5420 must have a distinct name within the @code{MEMORY} command. However you can
5421 add later alias names to existing memory regions with the @ref{REGION_ALIAS}
5424 @cindex memory region attributes
5425 The @var{attr} string is an optional list of attributes that specify
5426 whether to use a particular memory region for an input section which is
5427 not explicitly mapped in the linker script. As described in
5428 @ref{SECTIONS}, if you do not specify an output section for some input
5429 section, the linker will create an output section with the same name as
5430 the input section. If you define region attributes, the linker will use
5431 them to select the memory region for the output section that it creates.
5433 The @var{attr} string must consist only of the following characters:
5448 Invert the sense of any of the attributes that follow
5451 If an unmapped section matches any of the listed attributes other than
5452 @samp{!}, it will be placed in the memory region. The @samp{!}
5453 attribute reverses the test for the characters that follow, so that an
5454 unmapped section will be placed in the memory region only if it does
5455 not match any of the attributes listed afterwards. Thus an attribute
5456 string of @samp{RW!X} will match any unmapped section that has either
5457 or both of the @samp{R} and @samp{W} attributes, but only as long as
5458 the section does not also have the @samp{X} attribute.
5463 The @var{origin} is an numerical expression for the start address of
5464 the memory region. The expression must evaluate to a constant and it
5465 cannot involve any symbols. The keyword @code{ORIGIN} may be
5466 abbreviated to @code{org} or @code{o} (but not, for example,
5472 The @var{len} is an expression for the size in bytes of the memory
5473 region. As with the @var{origin} expression, the expression must
5474 be numerical only and must evaluate to a constant. The keyword
5475 @code{LENGTH} may be abbreviated to @code{len} or @code{l}.
5477 In the following example, we specify that there are two memory regions
5478 available for allocation: one starting at @samp{0} for 256 kilobytes,
5479 and the other starting at @samp{0x40000000} for four megabytes. The
5480 linker will place into the @samp{rom} memory region every section which
5481 is not explicitly mapped into a memory region, and is either read-only
5482 or executable. The linker will place other sections which are not
5483 explicitly mapped into a memory region into the @samp{ram} memory
5490 rom (rx) : ORIGIN = 0, LENGTH = 256K
5491 ram (!rx) : org = 0x40000000, l = 4M
5496 Once you define a memory region, you can direct the linker to place
5497 specific output sections into that memory region by using the
5498 @samp{>@var{region}} output section attribute. For example, if you have
5499 a memory region named @samp{mem}, you would use @samp{>mem} in the
5500 output section definition. @xref{Output Section Region}. If no address
5501 was specified for the output section, the linker will set the address to
5502 the next available address within the memory region. If the combined
5503 output sections directed to a memory region are too large for the
5504 region, the linker will issue an error message.
5506 It is possible to access the origin and length of a memory in an
5507 expression via the @code{ORIGIN(@var{memory})} and
5508 @code{LENGTH(@var{memory})} functions:
5512 _fstack = ORIGIN(ram) + LENGTH(ram) - 4;
5517 @section PHDRS Command
5519 @cindex program headers
5520 @cindex ELF program headers
5521 @cindex program segments
5522 @cindex segments, ELF
5523 The ELF object file format uses @dfn{program headers}, also knows as
5524 @dfn{segments}. The program headers describe how the program should be
5525 loaded into memory. You can print them out by using the @code{objdump}
5526 program with the @samp{-p} option.
5528 When you run an ELF program on a native ELF system, the system loader
5529 reads the program headers in order to figure out how to load the
5530 program. This will only work if the program headers are set correctly.
5531 This manual does not describe the details of how the system loader
5532 interprets program headers; for more information, see the ELF ABI.
5534 The linker will create reasonable program headers by default. However,
5535 in some cases, you may need to specify the program headers more
5536 precisely. You may use the @code{PHDRS} command for this purpose. When
5537 the linker sees the @code{PHDRS} command in the linker script, it will
5538 not create any program headers other than the ones specified.
5540 The linker only pays attention to the @code{PHDRS} command when
5541 generating an ELF output file. In other cases, the linker will simply
5542 ignore @code{PHDRS}.
5544 This is the syntax of the @code{PHDRS} command. The words @code{PHDRS},
5545 @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords.
5551 @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ]
5552 [ FLAGS ( @var{flags} ) ] ;
5557 The @var{name} is used only for reference in the @code{SECTIONS} command
5558 of the linker script. It is not put into the output file. Program
5559 header names are stored in a separate name space, and will not conflict
5560 with symbol names, file names, or section names. Each program header
5561 must have a distinct name. The headers are processed in order and it
5562 is usual for them to map to sections in ascending load address order.
5564 Certain program header types describe segments of memory which the
5565 system loader will load from the file. In the linker script, you
5566 specify the contents of these segments by placing allocatable output
5567 sections in the segments. You use the @samp{:@var{phdr}} output section
5568 attribute to place a section in a particular segment. @xref{Output
5571 It is normal to put certain sections in more than one segment. This
5572 merely implies that one segment of memory contains another. You may
5573 repeat @samp{:@var{phdr}}, using it once for each segment which should
5574 contain the section.
5576 If you place a section in one or more segments using @samp{:@var{phdr}},
5577 then the linker will place all subsequent allocatable sections which do
5578 not specify @samp{:@var{phdr}} in the same segments. This is for
5579 convenience, since generally a whole set of contiguous sections will be
5580 placed in a single segment. You can use @code{:NONE} to override the
5581 default segment and tell the linker to not put the section in any
5586 You may use the @code{FILEHDR} and @code{PHDRS} keywords after
5587 the program header type to further describe the contents of the segment.
5588 The @code{FILEHDR} keyword means that the segment should include the ELF
5589 file header. The @code{PHDRS} keyword means that the segment should
5590 include the ELF program headers themselves. If applied to a loadable
5591 segment (@code{PT_LOAD}), all prior loadable segments must have one of
5594 The @var{type} may be one of the following. The numbers indicate the
5595 value of the keyword.
5598 @item @code{PT_NULL} (0)
5599 Indicates an unused program header.
5601 @item @code{PT_LOAD} (1)
5602 Indicates that this program header describes a segment to be loaded from
5605 @item @code{PT_DYNAMIC} (2)
5606 Indicates a segment where dynamic linking information can be found.
5608 @item @code{PT_INTERP} (3)
5609 Indicates a segment where the name of the program interpreter may be
5612 @item @code{PT_NOTE} (4)
5613 Indicates a segment holding note information.
5615 @item @code{PT_SHLIB} (5)
5616 A reserved program header type, defined but not specified by the ELF
5619 @item @code{PT_PHDR} (6)
5620 Indicates a segment where the program headers may be found.
5622 @item @code{PT_TLS} (7)
5623 Indicates a segment containing thread local storage.
5625 @item @var{expression}
5626 An expression giving the numeric type of the program header. This may
5627 be used for types not defined above.
5630 You can specify that a segment should be loaded at a particular address
5631 in memory by using an @code{AT} expression. This is identical to the
5632 @code{AT} command used as an output section attribute (@pxref{Output
5633 Section LMA}). The @code{AT} command for a program header overrides the
5634 output section attribute.
5636 The linker will normally set the segment flags based on the sections
5637 which comprise the segment. You may use the @code{FLAGS} keyword to
5638 explicitly specify the segment flags. The value of @var{flags} must be
5639 an integer. It is used to set the @code{p_flags} field of the program
5642 Here is an example of @code{PHDRS}. This shows a typical set of program
5643 headers used on a native ELF system.
5649 headers PT_PHDR PHDRS ;
5651 text PT_LOAD FILEHDR PHDRS ;
5653 dynamic PT_DYNAMIC ;
5659 .interp : @{ *(.interp) @} :text :interp
5660 .text : @{ *(.text) @} :text
5661 .rodata : @{ *(.rodata) @} /* defaults to :text */
5663 . = . + 0x1000; /* move to a new page in memory */
5664 .data : @{ *(.data) @} :data
5665 .dynamic : @{ *(.dynamic) @} :data :dynamic
5672 @section VERSION Command
5673 @kindex VERSION @{script text@}
5674 @cindex symbol versions
5675 @cindex version script
5676 @cindex versions of symbols
5677 The linker supports symbol versions when using ELF. Symbol versions are
5678 only useful when using shared libraries. The dynamic linker can use
5679 symbol versions to select a specific version of a function when it runs
5680 a program that may have been linked against an earlier version of the
5683 You can include a version script directly in the main linker script, or
5684 you can supply the version script as an implicit linker script. You can
5685 also use the @samp{--version-script} linker option.
5687 The syntax of the @code{VERSION} command is simply
5689 VERSION @{ version-script-commands @}
5692 The format of the version script commands is identical to that used by
5693 Sun's linker in Solaris 2.5. The version script defines a tree of
5694 version nodes. You specify the node names and interdependencies in the
5695 version script. You can specify which symbols are bound to which
5696 version nodes, and you can reduce a specified set of symbols to local
5697 scope so that they are not globally visible outside of the shared
5700 The easiest way to demonstrate the version script language is with a few
5726 This example version script defines three version nodes. The first
5727 version node defined is @samp{VERS_1.1}; it has no other dependencies.
5728 The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces
5729 a number of symbols to local scope so that they are not visible outside
5730 of the shared library; this is done using wildcard patterns, so that any
5731 symbol whose name begins with @samp{old}, @samp{original}, or @samp{new}
5732 is matched. The wildcard patterns available are the same as those used
5733 in the shell when matching filenames (also known as ``globbing'').
5734 However, if you specify the symbol name inside double quotes, then the
5735 name is treated as literal, rather than as a glob pattern.
5737 Next, the version script defines node @samp{VERS_1.2}. This node
5738 depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2}
5739 to the version node @samp{VERS_1.2}.
5741 Finally, the version script defines node @samp{VERS_2.0}. This node
5742 depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1}
5743 and @samp{bar2} are bound to the version node @samp{VERS_2.0}.
5745 When the linker finds a symbol defined in a library which is not
5746 specifically bound to a version node, it will effectively bind it to an
5747 unspecified base version of the library. You can bind all otherwise
5748 unspecified symbols to a given version node by using @samp{global: *;}
5749 somewhere in the version script. Note that it's slightly crazy to use
5750 wildcards in a global spec except on the last version node. Global
5751 wildcards elsewhere run the risk of accidentally adding symbols to the
5752 set exported for an old version. That's wrong since older versions
5753 ought to have a fixed set of symbols.
5755 The names of the version nodes have no specific meaning other than what
5756 they might suggest to the person reading them. The @samp{2.0} version
5757 could just as well have appeared in between @samp{1.1} and @samp{1.2}.
5758 However, this would be a confusing way to write a version script.
5760 Node name can be omitted, provided it is the only version node
5761 in the version script. Such version script doesn't assign any versions to
5762 symbols, only selects which symbols will be globally visible out and which
5766 @{ global: foo; bar; local: *; @};
5769 When you link an application against a shared library that has versioned
5770 symbols, the application itself knows which version of each symbol it
5771 requires, and it also knows which version nodes it needs from each
5772 shared library it is linked against. Thus at runtime, the dynamic
5773 loader can make a quick check to make sure that the libraries you have
5774 linked against do in fact supply all of the version nodes that the
5775 application will need to resolve all of the dynamic symbols. In this
5776 way it is possible for the dynamic linker to know with certainty that
5777 all external symbols that it needs will be resolvable without having to
5778 search for each symbol reference.
5780 The symbol versioning is in effect a much more sophisticated way of
5781 doing minor version checking that SunOS does. The fundamental problem
5782 that is being addressed here is that typically references to external
5783 functions are bound on an as-needed basis, and are not all bound when
5784 the application starts up. If a shared library is out of date, a
5785 required interface may be missing; when the application tries to use
5786 that interface, it may suddenly and unexpectedly fail. With symbol
5787 versioning, the user will get a warning when they start their program if
5788 the libraries being used with the application are too old.
5790 There are several GNU extensions to Sun's versioning approach. The
5791 first of these is the ability to bind a symbol to a version node in the
5792 source file where the symbol is defined instead of in the versioning
5793 script. This was done mainly to reduce the burden on the library
5794 maintainer. You can do this by putting something like:
5796 __asm__(".symver original_foo,foo@@VERS_1.1");
5799 in the C source file. This renames the function @samp{original_foo} to
5800 be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}.
5801 The @samp{local:} directive can be used to prevent the symbol
5802 @samp{original_foo} from being exported. A @samp{.symver} directive
5803 takes precedence over a version script.
5805 The second GNU extension is to allow multiple versions of the same
5806 function to appear in a given shared library. In this way you can make
5807 an incompatible change to an interface without increasing the major
5808 version number of the shared library, while still allowing applications
5809 linked against the old interface to continue to function.
5811 To do this, you must use multiple @samp{.symver} directives in the
5812 source file. Here is an example:
5815 __asm__(".symver original_foo,foo@@");
5816 __asm__(".symver old_foo,foo@@VERS_1.1");
5817 __asm__(".symver old_foo1,foo@@VERS_1.2");
5818 __asm__(".symver new_foo,foo@@@@VERS_2.0");
5821 In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the
5822 unspecified base version of the symbol. The source file that contains this
5823 example would define 4 C functions: @samp{original_foo}, @samp{old_foo},
5824 @samp{old_foo1}, and @samp{new_foo}.
5826 When you have multiple definitions of a given symbol, there needs to be
5827 some way to specify a default version to which external references to
5828 this symbol will be bound. You can do this with the
5829 @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only
5830 declare one version of a symbol as the default in this manner; otherwise
5831 you would effectively have multiple definitions of the same symbol.
5833 If you wish to bind a reference to a specific version of the symbol
5834 within the shared library, you can use the aliases of convenience
5835 (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to
5836 specifically bind to an external version of the function in question.
5838 You can also specify the language in the version script:
5841 VERSION extern "lang" @{ version-script-commands @}
5844 The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}.
5845 The linker will iterate over the list of symbols at the link time and
5846 demangle them according to @samp{lang} before matching them to the
5847 patterns specified in @samp{version-script-commands}. The default
5848 @samp{lang} is @samp{C}.
5850 Demangled names may contains spaces and other special characters. As
5851 described above, you can use a glob pattern to match demangled names,
5852 or you can use a double-quoted string to match the string exactly. In
5853 the latter case, be aware that minor differences (such as differing
5854 whitespace) between the version script and the demangler output will
5855 cause a mismatch. As the exact string generated by the demangler
5856 might change in the future, even if the mangled name does not, you
5857 should check that all of your version directives are behaving as you
5858 expect when you upgrade.
5861 @section Expressions in Linker Scripts
5864 The syntax for expressions in the linker script language is identical to
5865 that of C expressions. All expressions are evaluated as integers. All
5866 expressions are evaluated in the same size, which is 32 bits if both the
5867 host and target are 32 bits, and is otherwise 64 bits.
5869 You can use and set symbol values in expressions.
5871 The linker defines several special purpose builtin functions for use in
5875 * Constants:: Constants
5876 * Symbolic Constants:: Symbolic constants
5877 * Symbols:: Symbol Names
5878 * Orphan Sections:: Orphan Sections
5879 * Location Counter:: The Location Counter
5880 * Operators:: Operators
5881 * Evaluation:: Evaluation
5882 * Expression Section:: The Section of an Expression
5883 * Builtin Functions:: Builtin Functions
5887 @subsection Constants
5888 @cindex integer notation
5889 @cindex constants in linker scripts
5890 All constants are integers.
5892 As in C, the linker considers an integer beginning with @samp{0} to be
5893 octal, and an integer beginning with @samp{0x} or @samp{0X} to be
5894 hexadecimal. Alternatively the linker accepts suffixes of @samp{h} or
5895 @samp{H} for hexadecimal, @samp{o} or @samp{O} for octal, @samp{b} or
5896 @samp{B} for binary and @samp{d} or @samp{D} for decimal. Any integer
5897 value without a prefix or a suffix is considered to be decimal.
5899 @cindex scaled integers
5900 @cindex K and M integer suffixes
5901 @cindex M and K integer suffixes
5902 @cindex suffixes for integers
5903 @cindex integer suffixes
5904 In addition, you can use the suffixes @code{K} and @code{M} to scale a
5908 @c END TEXI2ROFF-KILL
5909 @code{1024} or @code{1024*1024}
5913 ${\rm 1024}$ or ${\rm 1024}^2$
5915 @c END TEXI2ROFF-KILL
5916 respectively. For example, the following
5917 all refer to the same quantity:
5926 Note - the @code{K} and @code{M} suffixes cannot be used in
5927 conjunction with the base suffixes mentioned above.
5929 @node Symbolic Constants
5930 @subsection Symbolic Constants
5931 @cindex symbolic constants
5933 It is possible to refer to target-specific constants via the use of
5934 the @code{CONSTANT(@var{name})} operator, where @var{name} is one of:
5939 The target's maximum page size.
5941 @item COMMONPAGESIZE
5942 @kindex COMMONPAGESIZE
5943 The target's default page size.
5949 .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @}
5952 will create a text section aligned to the largest page boundary
5953 supported by the target.
5956 @subsection Symbol Names
5957 @cindex symbol names
5959 @cindex quoted symbol names
5961 Unless quoted, symbol names start with a letter, underscore, or period
5962 and may include letters, digits, underscores, periods, and hyphens.
5963 Unquoted symbol names must not conflict with any keywords. You can
5964 specify a symbol which contains odd characters or has the same name as a
5965 keyword by surrounding the symbol name in double quotes:
5968 "with a space" = "also with a space" + 10;
5971 Since symbols can contain many non-alphabetic characters, it is safest
5972 to delimit symbols with spaces. For example, @samp{A-B} is one symbol,
5973 whereas @samp{A - B} is an expression involving subtraction.
5975 @node Orphan Sections
5976 @subsection Orphan Sections
5978 Orphan sections are sections present in the input files which
5979 are not explicitly placed into the output file by the linker
5980 script. The linker will still copy these sections into the
5981 output file by either finding, or creating a suitable output section
5982 in which to place the orphaned input section.
5984 If the name of an orphaned input section exactly matches the name of
5985 an existing output section, then the orphaned input section will be
5986 placed at the end of that output section.
5988 If there is no output section with a matching name then new output
5989 sections will be created. Each new output section will have the same
5990 name as the orphan section placed within it. If there are multiple
5991 orphan sections with the same name, these will all be combined into
5992 one new output section.
5994 If new output sections are created to hold orphaned input sections,
5995 then the linker must decide where to place these new output sections
5996 in relation to existing output sections. On most modern targets, the
5997 linker attempts to place orphan sections after sections of the same
5998 attribute, such as code vs data, loadable vs non-loadable, etc. If no
5999 sections with matching attributes are found, or your target lacks this
6000 support, the orphan section is placed at the end of the file.
6002 The command-line options @samp{--orphan-handling} and @samp{--unique}
6003 (@pxref{Options,,Command-line Options}) can be used to control which
6004 output sections an orphan is placed in.
6006 @node Location Counter
6007 @subsection The Location Counter
6010 @cindex location counter
6011 @cindex current output location
6012 The special linker variable @dfn{dot} @samp{.} always contains the
6013 current output location counter. Since the @code{.} always refers to a
6014 location in an output section, it may only appear in an expression
6015 within a @code{SECTIONS} command. The @code{.} symbol may appear
6016 anywhere that an ordinary symbol is allowed in an expression.
6019 Assigning a value to @code{.} will cause the location counter to be
6020 moved. This may be used to create holes in the output section. The
6021 location counter may not be moved backwards inside an output section,
6022 and may not be moved backwards outside of an output section if so
6023 doing creates areas with overlapping LMAs.
6039 In the previous example, the @samp{.text} section from @file{file1} is
6040 located at the beginning of the output section @samp{output}. It is
6041 followed by a 1000 byte gap. Then the @samp{.text} section from
6042 @file{file2} appears, also with a 1000 byte gap following before the
6043 @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678}
6044 specifies what data to write in the gaps (@pxref{Output Section Fill}).
6046 @cindex dot inside sections
6047 Note: @code{.} actually refers to the byte offset from the start of the
6048 current containing object. Normally this is the @code{SECTIONS}
6049 statement, whose start address is 0, hence @code{.} can be used as an
6050 absolute address. If @code{.} is used inside a section description
6051 however, it refers to the byte offset from the start of that section,
6052 not an absolute address. Thus in a script like this:
6070 The @samp{.text} section will be assigned a starting address of 0x100
6071 and a size of exactly 0x200 bytes, even if there is not enough data in
6072 the @samp{.text} input sections to fill this area. (If there is too
6073 much data, an error will be produced because this would be an attempt to
6074 move @code{.} backwards). The @samp{.data} section will start at 0x500
6075 and it will have an extra 0x600 bytes worth of space after the end of
6076 the values from the @samp{.data} input sections and before the end of
6077 the @samp{.data} output section itself.
6079 @cindex dot outside sections
6080 Setting symbols to the value of the location counter outside of an
6081 output section statement can result in unexpected values if the linker
6082 needs to place orphan sections. For example, given the following:
6088 .text: @{ *(.text) @}
6092 .data: @{ *(.data) @}
6097 If the linker needs to place some input section, e.g. @code{.rodata},
6098 not mentioned in the script, it might choose to place that section
6099 between @code{.text} and @code{.data}. You might think the linker
6100 should place @code{.rodata} on the blank line in the above script, but
6101 blank lines are of no particular significance to the linker. As well,
6102 the linker doesn't associate the above symbol names with their
6103 sections. Instead, it assumes that all assignments or other
6104 statements belong to the previous output section, except for the
6105 special case of an assignment to @code{.}. I.e., the linker will
6106 place the orphan @code{.rodata} section as if the script was written
6113 .text: @{ *(.text) @}
6117 .rodata: @{ *(.rodata) @}
6118 .data: @{ *(.data) @}
6123 This may or may not be the script author's intention for the value of
6124 @code{start_of_data}. One way to influence the orphan section
6125 placement is to assign the location counter to itself, as the linker
6126 assumes that an assignment to @code{.} is setting the start address of
6127 a following output section and thus should be grouped with that
6128 section. So you could write:
6134 .text: @{ *(.text) @}
6139 .data: @{ *(.data) @}
6144 Now, the orphan @code{.rodata} section will be placed between
6145 @code{end_of_text} and @code{start_of_data}.
6149 @subsection Operators
6150 @cindex operators for arithmetic
6151 @cindex arithmetic operators
6152 @cindex precedence in expressions
6153 The linker recognizes the standard C set of arithmetic operators, with
6154 the standard bindings and precedence levels:
6157 @c END TEXI2ROFF-KILL
6159 precedence associativity Operators Notes
6165 5 left == != > < <= >=
6171 11 right &= += -= *= /= (2)
6175 (1) Prefix operators
6176 (2) @xref{Assignments}.
6180 \vskip \baselineskip
6181 %"lispnarrowing" is the extra indent used generally for smallexample
6182 \hskip\lispnarrowing\vbox{\offinterlineskip
6185 {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr
6186 height2pt&\omit&&\omit&&\omit&\cr
6187 &Precedence&& Associativity &&{\rm Operators}&\cr
6188 height2pt&\omit&&\omit&&\omit&\cr
6190 height2pt&\omit&&\omit&&\omit&\cr
6192 % '176 is tilde, '~' in tt font
6193 &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr
6194 &2&&left&&* / \%&\cr
6197 &5&&left&&== != > < <= >=&\cr
6200 &8&&left&&{\&\&}&\cr
6203 &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr
6205 height2pt&\omit&&\omit&&\omit&\cr}
6210 @obeylines@parskip=0pt@parindent=0pt
6211 @dag@quad Prefix operators.
6212 @ddag@quad @xref{Assignments}.
6215 @c END TEXI2ROFF-KILL
6218 @subsection Evaluation
6219 @cindex lazy evaluation
6220 @cindex expression evaluation order
6221 The linker evaluates expressions lazily. It only computes the value of
6222 an expression when absolutely necessary.
6224 The linker needs some information, such as the value of the start
6225 address of the first section, and the origins and lengths of memory
6226 regions, in order to do any linking at all. These values are computed
6227 as soon as possible when the linker reads in the linker script.
6229 However, other values (such as symbol values) are not known or needed
6230 until after storage allocation. Such values are evaluated later, when
6231 other information (such as the sizes of output sections) is available
6232 for use in the symbol assignment expression.
6234 The sizes of sections cannot be known until after allocation, so
6235 assignments dependent upon these are not performed until after
6238 Some expressions, such as those depending upon the location counter
6239 @samp{.}, must be evaluated during section allocation.
6241 If the result of an expression is required, but the value is not
6242 available, then an error results. For example, a script like the
6248 .text 9+this_isnt_constant :
6254 will cause the error message @samp{non constant expression for initial
6257 @node Expression Section
6258 @subsection The Section of an Expression
6259 @cindex expression sections
6260 @cindex absolute expressions
6261 @cindex relative expressions
6262 @cindex absolute and relocatable symbols
6263 @cindex relocatable and absolute symbols
6264 @cindex symbols, relocatable and absolute
6265 Addresses and symbols may be section relative, or absolute. A section
6266 relative symbol is relocatable. If you request relocatable output
6267 using the @samp{-r} option, a further link operation may change the
6268 value of a section relative symbol. On the other hand, an absolute
6269 symbol will retain the same value throughout any further link
6272 Some terms in linker expressions are addresses. This is true of
6273 section relative symbols and for builtin functions that return an
6274 address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and
6275 @code{SEGMENT_START}. Other terms are simply numbers, or are builtin
6276 functions that return a non-address value, such as @code{LENGTH}.
6277 One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")}
6278 (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated
6279 differently depending on their location, for compatibility with older
6280 versions of @code{ld}. Expressions appearing outside an output
6281 section definition treat all numbers as absolute addresses.
6282 Expressions appearing inside an output section definition treat
6283 absolute symbols as numbers. If @code{LD_FEATURE ("SANE_EXPR")} is
6284 given, then absolute symbols and numbers are simply treated as numbers
6287 In the following simple example,
6294 __executable_start = 0x100;
6298 __data_start = 0x10;
6306 both @code{.} and @code{__executable_start} are set to the absolute
6307 address 0x100 in the first two assignments, then both @code{.} and
6308 @code{__data_start} are set to 0x10 relative to the @code{.data}
6309 section in the second two assignments.
6311 For expressions involving numbers, relative addresses and absolute
6312 addresses, ld follows these rules to evaluate terms:
6316 Unary operations on an absolute address or number, and binary
6317 operations on two absolute addresses or two numbers, or between one
6318 absolute address and a number, apply the operator to the value(s).
6320 Unary operations on a relative address, and binary operations on two
6321 relative addresses in the same section or between one relative address
6322 and a number, apply the operator to the offset part of the address(es).
6324 Other binary operations, that is, between two relative addresses not
6325 in the same section, or between a relative address and an absolute
6326 address, first convert any non-absolute term to an absolute address
6327 before applying the operator.
6330 The result section of each sub-expression is as follows:
6334 An operation involving only numbers results in a number.
6336 The result of comparisons, @samp{&&} and @samp{||} is also a number.
6338 The result of other binary arithmetic and logical operations on two
6339 relative addresses in the same section or two absolute addresses
6340 (after above conversions) is also a number when
6341 @code{LD_FEATURE ("SANE_EXPR")} or inside an output section definition
6342 but an absolute address otherwise.
6344 The result of other operations on relative addresses or one
6345 relative address and a number, is a relative address in the same
6346 section as the relative operand(s).
6348 The result of other operations on absolute addresses (after above
6349 conversions) is an absolute address.
6352 You can use the builtin function @code{ABSOLUTE} to force an expression
6353 to be absolute when it would otherwise be relative. For example, to
6354 create an absolute symbol set to the address of the end of the output
6355 section @samp{.data}:
6359 .data : @{ *(.data) _edata = ABSOLUTE(.); @}
6363 If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the
6364 @samp{.data} section.
6366 Using @code{LOADADDR} also forces an expression absolute, since this
6367 particular builtin function returns an absolute address.
6369 @node Builtin Functions
6370 @subsection Builtin Functions
6371 @cindex functions in expressions
6372 The linker script language includes a number of builtin functions for
6373 use in linker script expressions.
6376 @item ABSOLUTE(@var{exp})
6377 @kindex ABSOLUTE(@var{exp})
6378 @cindex expression, absolute
6379 Return the absolute (non-relocatable, as opposed to non-negative) value
6380 of the expression @var{exp}. Primarily useful to assign an absolute
6381 value to a symbol within a section definition, where symbol values are
6382 normally section relative. @xref{Expression Section}.
6384 @item ADDR(@var{section})
6385 @kindex ADDR(@var{section})
6386 @cindex section address in expression
6387 Return the address (VMA) of the named @var{section}. Your
6388 script must previously have defined the location of that section. In
6389 the following example, @code{start_of_output_1}, @code{symbol_1} and
6390 @code{symbol_2} are assigned equivalent values, except that
6391 @code{symbol_1} will be relative to the @code{.output1} section while
6392 the other two will be absolute:
6398 start_of_output_1 = ABSOLUTE(.);
6403 symbol_1 = ADDR(.output1);
6404 symbol_2 = start_of_output_1;
6410 @item ALIGN(@var{align})
6411 @itemx ALIGN(@var{exp},@var{align})
6412 @kindex ALIGN(@var{align})
6413 @kindex ALIGN(@var{exp},@var{align})
6414 @cindex round up location counter
6415 @cindex align location counter
6416 @cindex round up expression
6417 @cindex align expression
6418 Return the location counter (@code{.}) or arbitrary expression aligned
6419 to the next @var{align} boundary. The single operand @code{ALIGN}
6420 doesn't change the value of the location counter---it just does
6421 arithmetic on it. The two operand @code{ALIGN} allows an arbitrary
6422 expression to be aligned upwards (@code{ALIGN(@var{align})} is
6423 equivalent to @code{ALIGN(ABSOLUTE(.), @var{align})}).
6425 Here is an example which aligns the output @code{.data} section to the
6426 next @code{0x2000} byte boundary after the preceding section and sets a
6427 variable within the section to the next @code{0x8000} boundary after the
6432 .data ALIGN(0x2000): @{
6434 variable = ALIGN(0x8000);
6440 The first use of @code{ALIGN} in this example specifies the location of
6441 a section because it is used as the optional @var{address} attribute of
6442 a section definition (@pxref{Output Section Address}). The second use
6443 of @code{ALIGN} is used to defines the value of a symbol.
6445 The builtin function @code{NEXT} is closely related to @code{ALIGN}.
6447 @item ALIGNOF(@var{section})
6448 @kindex ALIGNOF(@var{section})
6449 @cindex section alignment
6450 Return the alignment in bytes of the named @var{section}, if that section has
6451 been allocated. If the section has not been allocated when this is
6452 evaluated, the linker will report an error. In the following example,
6453 the alignment of the @code{.output} section is stored as the first
6454 value in that section.
6459 LONG (ALIGNOF (.output))
6466 @item BLOCK(@var{exp})
6467 @kindex BLOCK(@var{exp})
6468 This is a synonym for @code{ALIGN}, for compatibility with older linker
6469 scripts. It is most often seen when setting the address of an output
6472 @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
6473 @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize})
6474 This is equivalent to either
6476 (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1)))
6480 (ALIGN(@var{maxpagesize})
6481 + ((. + @var{commonpagesize} - 1) & (@var{maxpagesize} - @var{commonpagesize})))
6484 depending on whether the latter uses fewer @var{commonpagesize} sized pages
6485 for the data segment (area between the result of this expression and
6486 @code{DATA_SEGMENT_END}) than the former or not.
6487 If the latter form is used, it means @var{commonpagesize} bytes of runtime
6488 memory will be saved at the expense of up to @var{commonpagesize} wasted
6489 bytes in the on-disk file.
6491 This expression can only be used directly in @code{SECTIONS} commands, not in
6492 any output section descriptions and only once in the linker script.
6493 @var{commonpagesize} should be less or equal to @var{maxpagesize} and should
6494 be the system page size the object wants to be optimized for while still
6495 running on system page sizes up to @var{maxpagesize}. Note however
6496 that @samp{-z relro} protection will not be effective if the system
6497 page size is larger than @var{commonpagesize}.
6502 . = DATA_SEGMENT_ALIGN(0x10000, 0x2000);
6505 @item DATA_SEGMENT_END(@var{exp})
6506 @kindex DATA_SEGMENT_END(@var{exp})
6507 This defines the end of data segment for @code{DATA_SEGMENT_ALIGN}
6508 evaluation purposes.
6511 . = DATA_SEGMENT_END(.);
6514 @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
6515 @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp})
6516 This defines the end of the @code{PT_GNU_RELRO} segment when
6517 @samp{-z relro} option is used.
6518 When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END}
6519 does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that
6520 @var{exp} + @var{offset} is aligned to the @var{commonpagesize}
6521 argument given to @code{DATA_SEGMENT_ALIGN}. If present in the linker
6522 script, it must be placed between @code{DATA_SEGMENT_ALIGN} and
6523 @code{DATA_SEGMENT_END}. Evaluates to the second argument plus any
6524 padding needed at the end of the @code{PT_GNU_RELRO} segment due to
6528 . = DATA_SEGMENT_RELRO_END(24, .);
6531 @item DEFINED(@var{symbol})
6532 @kindex DEFINED(@var{symbol})
6533 @cindex symbol defaults
6534 Return 1 if @var{symbol} is in the linker global symbol table and is
6535 defined before the statement using DEFINED in the script, otherwise
6536 return 0. You can use this function to provide
6537 default values for symbols. For example, the following script fragment
6538 shows how to set a global symbol @samp{begin} to the first location in
6539 the @samp{.text} section---but if a symbol called @samp{begin} already
6540 existed, its value is preserved:
6546 begin = DEFINED(begin) ? begin : . ;
6554 @item LENGTH(@var{memory})
6555 @kindex LENGTH(@var{memory})
6556 Return the length of the memory region named @var{memory}.
6558 @item LOADADDR(@var{section})
6559 @kindex LOADADDR(@var{section})
6560 @cindex section load address in expression
6561 Return the absolute LMA of the named @var{section}. (@pxref{Output
6564 @item LOG2CEIL(@var{exp})
6565 @kindex LOG2CEIL(@var{exp})
6566 Return the binary logarithm of @var{exp} rounded towards infinity.
6567 @code{LOG2CEIL(0)} returns 0.
6570 @item MAX(@var{exp1}, @var{exp2})
6571 Returns the maximum of @var{exp1} and @var{exp2}.
6574 @item MIN(@var{exp1}, @var{exp2})
6575 Returns the minimum of @var{exp1} and @var{exp2}.
6577 @item NEXT(@var{exp})
6578 @kindex NEXT(@var{exp})
6579 @cindex unallocated address, next
6580 Return the next unallocated address that is a multiple of @var{exp}.
6581 This function is closely related to @code{ALIGN(@var{exp})}; unless you
6582 use the @code{MEMORY} command to define discontinuous memory for the
6583 output file, the two functions are equivalent.
6585 @item ORIGIN(@var{memory})
6586 @kindex ORIGIN(@var{memory})
6587 Return the origin of the memory region named @var{memory}.
6589 @item SEGMENT_START(@var{segment}, @var{default})
6590 @kindex SEGMENT_START(@var{segment}, @var{default})
6591 Return the base address of the named @var{segment}. If an explicit
6592 value has already been given for this segment (with a command-line
6593 @samp{-T} option) then that value will be returned otherwise the value
6594 will be @var{default}. At present, the @samp{-T} command-line option
6595 can only be used to set the base address for the ``text'', ``data'', and
6596 ``bss'' sections, but you can use @code{SEGMENT_START} with any segment
6599 @item SIZEOF(@var{section})
6600 @kindex SIZEOF(@var{section})
6601 @cindex section size
6602 Return the size in bytes of the named @var{section}, if that section has
6603 been allocated. If the section has not been allocated when this is
6604 evaluated, the linker will report an error. In the following example,
6605 @code{symbol_1} and @code{symbol_2} are assigned identical values:
6614 symbol_1 = .end - .start ;
6615 symbol_2 = SIZEOF(.output);
6620 @item SIZEOF_HEADERS
6621 @itemx sizeof_headers
6622 @kindex SIZEOF_HEADERS
6624 Return the size in bytes of the output file's headers. This is
6625 information which appears at the start of the output file. You can use
6626 this number when setting the start address of the first section, if you
6627 choose, to facilitate paging.
6629 @cindex not enough room for program headers
6630 @cindex program headers, not enough room
6631 When producing an ELF output file, if the linker script uses the
6632 @code{SIZEOF_HEADERS} builtin function, the linker must compute the
6633 number of program headers before it has determined all the section
6634 addresses and sizes. If the linker later discovers that it needs
6635 additional program headers, it will report an error @samp{not enough
6636 room for program headers}. To avoid this error, you must avoid using
6637 the @code{SIZEOF_HEADERS} function, or you must rework your linker
6638 script to avoid forcing the linker to use additional program headers, or
6639 you must define the program headers yourself using the @code{PHDRS}
6640 command (@pxref{PHDRS}).
6643 @node Implicit Linker Scripts
6644 @section Implicit Linker Scripts
6645 @cindex implicit linker scripts
6646 If you specify a linker input file which the linker can not recognize as
6647 an object file or an archive file, it will try to read the file as a
6648 linker script. If the file can not be parsed as a linker script, the
6649 linker will report an error.
6651 An implicit linker script will not replace the default linker script.
6653 Typically an implicit linker script would contain only symbol
6654 assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION}
6657 Any input files read because of an implicit linker script will be read
6658 at the position in the command line where the implicit linker script was
6659 read. This can affect archive searching.
6662 @node Machine Dependent
6663 @chapter Machine Dependent Features
6665 @cindex machine dependencies
6666 @command{ld} has additional features on some platforms; the following
6667 sections describe them. Machines where @command{ld} has no additional
6668 functionality are not listed.
6672 * H8/300:: @command{ld} and the H8/300
6675 * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families
6678 * ARM:: @command{ld} and the ARM family
6681 * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF
6684 * M68K:: @command{ld} and the Motorola 68K family
6687 * MIPS:: @command{ld} and the MIPS family
6690 * MMIX:: @command{ld} and MMIX
6693 * MSP430:: @command{ld} and MSP430
6696 * NDS32:: @command{ld} and NDS32
6699 * Nios II:: @command{ld} and the Altera Nios II
6702 * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support
6705 * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support
6708 * S/390 ELF:: @command{ld} and S/390 ELF Support
6711 * SPU ELF:: @command{ld} and SPU ELF Support
6714 * TI COFF:: @command{ld} and TI COFF
6717 * WIN32:: @command{ld} and WIN32 (cygwin/mingw)
6720 * Xtensa:: @command{ld} and Xtensa Processors
6731 @section @command{ld} and the H8/300
6733 @cindex H8/300 support
6734 For the H8/300, @command{ld} can perform these global optimizations when
6735 you specify the @samp{--relax} command-line option.
6738 @cindex relaxing on H8/300
6739 @item relaxing address modes
6740 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6741 targets are within eight bits, and turns them into eight-bit
6742 program-counter relative @code{bsr} and @code{bra} instructions,
6745 @cindex synthesizing on H8/300
6746 @item synthesizing instructions
6747 @c FIXME: specifically mov.b, or any mov instructions really? -> mov.b only, at least on H8, H8H, H8S
6748 @command{ld} finds all @code{mov.b} instructions which use the
6749 sixteen-bit absolute address form, but refer to the top
6750 page of memory, and changes them to use the eight-bit address form.
6751 (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into
6752 @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the
6753 top page of memory).
6755 @command{ld} finds all @code{mov} instructions which use the register
6756 indirect with 32-bit displacement addressing mode, but use a small
6757 displacement inside 16-bit displacement range, and changes them to use
6758 the 16-bit displacement form. (That is: the linker turns @samp{mov.b
6759 @code{@@}@var{d}:32,ERx} into @samp{mov.b @code{@@}@var{d}:16,ERx}
6760 whenever the displacement @var{d} is in the 16 bit signed integer
6761 range. Only implemented in ELF-format ld).
6763 @item bit manipulation instructions
6764 @command{ld} finds all bit manipulation instructions like @code{band, bclr,
6765 biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor}
6766 which use 32 bit and 16 bit absolute address form, but refer to the top
6767 page of memory, and changes them to use the 8 bit address form.
6768 (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into
6769 @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in
6770 the top page of memory).
6772 @item system control instructions
6773 @command{ld} finds all @code{ldc.w, stc.w} instructions which use the
6774 32 bit absolute address form, but refer to the top page of memory, and
6775 changes them to use 16 bit address form.
6776 (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into
6777 @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in
6778 the top page of memory).
6788 @c This stuff is pointless to say unless you're especially concerned
6789 @c with Renesas chips; don't enable it for generic case, please.
6791 @chapter @command{ld} and Other Renesas Chips
6793 @command{ld} also supports the Renesas (formerly Hitachi) H8/300H,
6794 H8/500, and SH chips. No special features, commands, or command-line
6795 options are required for these chips.
6809 @node M68HC11/68HC12
6810 @section @command{ld} and the Motorola 68HC11 and 68HC12 families
6812 @cindex M68HC11 and 68HC12 support
6814 @subsection Linker Relaxation
6816 For the Motorola 68HC11, @command{ld} can perform these global
6817 optimizations when you specify the @samp{--relax} command-line option.
6820 @cindex relaxing on M68HC11
6821 @item relaxing address modes
6822 @command{ld} finds all @code{jsr} and @code{jmp} instructions whose
6823 targets are within eight bits, and turns them into eight-bit
6824 program-counter relative @code{bsr} and @code{bra} instructions,
6827 @command{ld} also looks at all 16-bit extended addressing modes and
6828 transforms them in a direct addressing mode when the address is in
6829 page 0 (between 0 and 0x0ff).
6831 @item relaxing gcc instruction group
6832 When @command{gcc} is called with @option{-mrelax}, it can emit group
6833 of instructions that the linker can optimize to use a 68HC11 direct
6834 addressing mode. These instructions consists of @code{bclr} or
6835 @code{bset} instructions.
6839 @subsection Trampoline Generation
6841 @cindex trampoline generation on M68HC11
6842 @cindex trampoline generation on M68HC12
6843 For 68HC11 and 68HC12, @command{ld} can generate trampoline code to
6844 call a far function using a normal @code{jsr} instruction. The linker
6845 will also change the relocation to some far function to use the
6846 trampoline address instead of the function address. This is typically the
6847 case when a pointer to a function is taken. The pointer will in fact
6848 point to the function trampoline.
6856 @section @command{ld} and the ARM family
6858 @cindex ARM interworking support
6859 @kindex --support-old-code
6860 For the ARM, @command{ld} will generate code stubs to allow functions calls
6861 between ARM and Thumb code. These stubs only work with code that has
6862 been compiled and assembled with the @samp{-mthumb-interwork} command
6863 line option. If it is necessary to link with old ARM object files or
6864 libraries, which have not been compiled with the -mthumb-interwork
6865 option then the @samp{--support-old-code} command-line switch should be
6866 given to the linker. This will make it generate larger stub functions
6867 which will work with non-interworking aware ARM code. Note, however,
6868 the linker does not support generating stubs for function calls to
6869 non-interworking aware Thumb code.
6871 @cindex thumb entry point
6872 @cindex entry point, thumb
6873 @kindex --thumb-entry=@var{entry}
6874 The @samp{--thumb-entry} switch is a duplicate of the generic
6875 @samp{--entry} switch, in that it sets the program's starting address.
6876 But it also sets the bottom bit of the address, so that it can be
6877 branched to using a BX instruction, and the program will start
6878 executing in Thumb mode straight away.
6880 @cindex PE import table prefixing
6881 @kindex --use-nul-prefixed-import-tables
6882 The @samp{--use-nul-prefixed-import-tables} switch is specifying, that
6883 the import tables idata4 and idata5 have to be generated with a zero
6884 element prefix for import libraries. This is the old style to generate
6885 import tables. By default this option is turned off.
6889 The @samp{--be8} switch instructs @command{ld} to generate BE8 format
6890 executables. This option is only valid when linking big-endian
6891 objects - ie ones which have been assembled with the @option{-EB}
6892 option. The resulting image will contain big-endian data and
6896 @kindex --target1-rel
6897 @kindex --target1-abs
6898 The @samp{R_ARM_TARGET1} relocation is typically used for entries in the
6899 @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32}
6900 or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel}
6901 and @samp{--target1-abs} switches override the default.
6904 @kindex --target2=@var{type}
6905 The @samp{--target2=type} switch overrides the default definition of the
6906 @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their
6907 meanings, and target defaults are as follows:
6910 @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi)
6912 @samp{R_ARM_ABS32} (arm*-*-symbianelf)
6914 @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd)
6919 The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF
6920 specification) enables objects compiled for the ARMv4 architecture to be
6921 interworking-safe when linked with other objects compiled for ARMv4t, but
6922 also allows pure ARMv4 binaries to be built from the same ARMv4 objects.
6924 In the latter case, the switch @option{--fix-v4bx} must be passed to the
6925 linker, which causes v4t @code{BX rM} instructions to be rewritten as
6926 @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction.
6928 In the former case, the switch should not be used, and @samp{R_ARM_V4BX}
6929 relocations are ignored.
6931 @cindex FIX_V4BX_INTERWORKING
6932 @kindex --fix-v4bx-interworking
6933 Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX}
6934 relocations with a branch to the following veneer:
6942 This allows generation of libraries/applications that work on ARMv4 cores
6943 and are still interworking safe. Note that the above veneer clobbers the
6944 condition flags, so may cause incorrect program behavior in rare cases.
6948 The @samp{--use-blx} switch enables the linker to use ARM/Thumb
6949 BLX instructions (available on ARMv5t and above) in various
6950 situations. Currently it is used to perform calls via the PLT from Thumb
6951 code using BLX rather than using BX and a mode-switching stub before
6952 each PLT entry. This should lead to such calls executing slightly faster.
6954 This option is enabled implicitly for SymbianOS, so there is no need to
6955 specify it if you are using that target.
6957 @cindex VFP11_DENORM_FIX
6958 @kindex --vfp11-denorm-fix
6959 The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a
6960 bug in certain VFP11 coprocessor hardware, which sometimes allows
6961 instructions with denorm operands (which must be handled by support code)
6962 to have those operands overwritten by subsequent instructions before
6963 the support code can read the intended values.
6965 The bug may be avoided in scalar mode if you allow at least one
6966 intervening instruction between a VFP11 instruction which uses a register
6967 and another instruction which writes to the same register, or at least two
6968 intervening instructions if vector mode is in use. The bug only affects
6969 full-compliance floating-point mode: you do not need this workaround if
6970 you are using "runfast" mode. Please contact ARM for further details.
6972 If you know you are using buggy VFP11 hardware, you can
6973 enable this workaround by specifying the linker option
6974 @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar
6975 mode only, or @samp{--vfp-denorm-fix=vector} if you are using
6976 vector mode (the latter also works for scalar code). The default is
6977 @samp{--vfp-denorm-fix=none}.
6979 If the workaround is enabled, instructions are scanned for
6980 potentially-troublesome sequences, and a veneer is created for each
6981 such sequence which may trigger the erratum. The veneer consists of the
6982 first instruction of the sequence and a branch back to the subsequent
6983 instruction. The original instruction is then replaced with a branch to
6984 the veneer. The extra cycles required to call and return from the veneer
6985 are sufficient to avoid the erratum in both the scalar and vector cases.
6987 @cindex ARM1176 erratum workaround
6988 @kindex --fix-arm1176
6989 @kindex --no-fix-arm1176
6990 The @samp{--fix-arm1176} switch enables a link-time workaround for an erratum
6991 in certain ARM1176 processors. The workaround is enabled by default if you
6992 are targeting ARM v6 (excluding ARM v6T2) or earlier. It can be disabled
6993 unconditionally by specifying @samp{--no-fix-arm1176}.
6995 Further information is available in the ``ARM1176JZ-S and ARM1176JZF-S
6996 Programmer Advice Notice'' available on the ARM documentation website at:
6997 http://infocenter.arm.com/.
6999 @cindex STM32L4xx erratum workaround
7000 @kindex --fix-stm32l4xx-629360
7002 The @samp{--fix-stm32l4xx-629360} switch enables a link-time
7003 workaround for a bug in the bus matrix / memory controller for some of
7004 the STM32 Cortex-M4 based products (STM32L4xx). When accessing
7005 off-chip memory via the affected bus for bus reads of 9 words or more,
7006 the bus can generate corrupt data and/or abort. These are only
7007 core-initiated accesses (not DMA), and might affect any access:
7008 integer loads such as LDM, POP and floating-point loads such as VLDM,
7009 VPOP. Stores are not affected.
7011 The bug can be avoided by splitting memory accesses into the
7012 necessary chunks to keep bus reads below 8 words.
7014 The workaround is not enabled by default, this is equivalent to use
7015 @samp{--fix-stm32l4xx-629360=none}. If you know you are using buggy
7016 STM32L4xx hardware, you can enable the workaround by specifying the
7017 linker option @samp{--fix-stm32l4xx-629360}, or the equivalent
7018 @samp{--fix-stm32l4xx-629360=default}.
7020 If the workaround is enabled, instructions are scanned for
7021 potentially-troublesome sequences, and a veneer is created for each
7022 such sequence which may trigger the erratum. The veneer consists in a
7023 replacement sequence emulating the behaviour of the original one and a
7024 branch back to the subsequent instruction. The original instruction is
7025 then replaced with a branch to the veneer.
7027 The workaround does not always preserve the memory access order for
7028 the LDMDB instruction, when the instruction loads the PC.
7030 The workaround is not able to handle problematic instructions when
7031 they are in the middle of an IT block, since a branch is not allowed
7032 there. In that case, the linker reports a warning and no replacement
7035 The workaround is not able to replace problematic instructions with a
7036 PC-relative branch instruction if the @samp{.text} section is too
7037 large. In that case, when the branch that replaces the original code
7038 cannot be encoded, the linker reports a warning and no replacement
7041 @cindex NO_ENUM_SIZE_WARNING
7042 @kindex --no-enum-size-warning
7043 The @option{--no-enum-size-warning} switch prevents the linker from
7044 warning when linking object files that specify incompatible EABI
7045 enumeration size attributes. For example, with this switch enabled,
7046 linking of an object file using 32-bit enumeration values with another
7047 using enumeration values fitted into the smallest possible space will
7050 @cindex NO_WCHAR_SIZE_WARNING
7051 @kindex --no-wchar-size-warning
7052 The @option{--no-wchar-size-warning} switch prevents the linker from
7053 warning when linking object files that specify incompatible EABI
7054 @code{wchar_t} size attributes. For example, with this switch enabled,
7055 linking of an object file using 32-bit @code{wchar_t} values with another
7056 using 16-bit @code{wchar_t} values will not be diagnosed.
7059 @kindex --pic-veneer
7060 The @samp{--pic-veneer} switch makes the linker use PIC sequences for
7061 ARM/Thumb interworking veneers, even if the rest of the binary
7062 is not PIC. This avoids problems on uClinux targets where
7063 @samp{--emit-relocs} is used to generate relocatable binaries.
7065 @cindex STUB_GROUP_SIZE
7066 @kindex --stub-group-size=@var{N}
7067 The linker will automatically generate and insert small sequences of
7068 code into a linked ARM ELF executable whenever an attempt is made to
7069 perform a function call to a symbol that is too far away. The
7070 placement of these sequences of instructions - called stubs - is
7071 controlled by the command-line option @option{--stub-group-size=N}.
7072 The placement is important because a poor choice can create a need for
7073 duplicate stubs, increasing the code size. The linker will try to
7074 group stubs together in order to reduce interruptions to the flow of
7075 code, but it needs guidance as to how big these groups should be and
7076 where they should be placed.
7078 The value of @samp{N}, the parameter to the
7079 @option{--stub-group-size=} option controls where the stub groups are
7080 placed. If it is negative then all stubs are placed after the first
7081 branch that needs them. If it is positive then the stubs can be
7082 placed either before or after the branches that need them. If the
7083 value of @samp{N} is 1 (either +1 or -1) then the linker will choose
7084 exactly where to place groups of stubs, using its built in heuristics.
7085 A value of @samp{N} greater than 1 (or smaller than -1) tells the
7086 linker that a single group of stubs can service at most @samp{N} bytes
7087 from the input sections.
7089 The default, if @option{--stub-group-size=} is not specified, is
7092 Farcalls stubs insertion is fully supported for the ARM-EABI target
7093 only, because it relies on object files properties not present
7096 @cindex Cortex-A8 erratum workaround
7097 @kindex --fix-cortex-a8
7098 @kindex --no-fix-cortex-a8
7099 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}.
7101 The erratum only affects Thumb-2 code. Please contact ARM for further details.
7103 @cindex Cortex-A53 erratum 835769 workaround
7104 @kindex --fix-cortex-a53-835769
7105 @kindex --no-fix-cortex-a53-835769
7106 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}.
7108 Please contact ARM for further details.
7110 @kindex --merge-exidx-entries
7111 @kindex --no-merge-exidx-entries
7112 @cindex Merging exidx entries
7113 The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo.
7116 @cindex 32-bit PLT entries
7117 The @samp{--long-plt} option enables the use of 16 byte PLT entries
7118 which support up to 4Gb of code. The default is to use 12 byte PLT
7119 entries which only support 512Mb of code.
7121 @kindex --no-apply-dynamic-relocs
7122 @cindex AArch64 rela addend
7123 The @samp{--no-apply-dynamic-relocs} option makes AArch64 linker do not apply
7124 link-time values for dynamic relocations.
7126 @cindex Placement of SG veneers
7127 All SG veneers are placed in the special output section @code{.gnu.sgstubs}.
7128 Its start address must be set, either with the command-line option
7129 @samp{--section-start} or in a linker script, to indicate where to place these
7132 @kindex --cmse-implib
7133 @cindex Secure gateway import library
7134 The @samp{--cmse-implib} option requests that the import libraries
7135 specified by the @samp{--out-implib} and @samp{--in-implib} options are
7136 secure gateway import libraries, suitable for linking a non-secure
7137 executable against secure code as per ARMv8-M Security Extensions.
7139 @kindex --in-implib=@var{file}
7140 @cindex Input import library
7141 The @samp{--in-implib=file} specifies an input import library whose symbols
7142 must keep the same address in the executable being produced. A warning is
7143 given if no @samp{--out-implib} is given but new symbols have been introduced
7144 in the executable that should be listed in its import library. Otherwise, if
7145 @samp{--out-implib} is specified, the symbols are added to the output import
7146 library. A warning is also given if some symbols present in the input import
7147 library have disappeared from the executable. This option is only effective
7148 for Secure Gateway import libraries, ie. when @samp{--cmse-implib} is
7162 @section @command{ld} and HPPA 32-bit ELF Support
7163 @cindex HPPA multiple sub-space stubs
7164 @kindex --multi-subspace
7165 When generating a shared library, @command{ld} will by default generate
7166 import stubs suitable for use with a single sub-space application.
7167 The @samp{--multi-subspace} switch causes @command{ld} to generate export
7168 stubs, and different (larger) import stubs suitable for use with
7169 multiple sub-spaces.
7171 @cindex HPPA stub grouping
7172 @kindex --stub-group-size=@var{N}
7173 Long branch stubs and import/export stubs are placed by @command{ld} in
7174 stub sections located between groups of input sections.
7175 @samp{--stub-group-size} specifies the maximum size of a group of input
7176 sections handled by one stub section. Since branch offsets are signed,
7177 a stub section may serve two groups of input sections, one group before
7178 the stub section, and one group after it. However, when using
7179 conditional branches that require stubs, it may be better (for branch
7180 prediction) that stub sections only serve one group of input sections.
7181 A negative value for @samp{N} chooses this scheme, ensuring that
7182 branches to stubs always use a negative offset. Two special values of
7183 @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct
7184 @command{ld} to automatically size input section groups for the branch types
7185 detected, with the same behaviour regarding stub placement as other
7186 positive or negative values of @samp{N} respectively.
7188 Note that @samp{--stub-group-size} does not split input sections. A
7189 single input section larger than the group size specified will of course
7190 create a larger group (of one section). If input sections are too
7191 large, it may not be possible for a branch to reach its stub.
7204 @section @command{ld} and the Motorola 68K family
7206 @cindex Motorola 68K GOT generation
7207 @kindex --got=@var{type}
7208 The @samp{--got=@var{type}} option lets you choose the GOT generation scheme.
7209 The choices are @samp{single}, @samp{negative}, @samp{multigot} and
7210 @samp{target}. When @samp{target} is selected the linker chooses
7211 the default GOT generation scheme for the current target.
7212 @samp{single} tells the linker to generate a single GOT with
7213 entries only at non-negative offsets.
7214 @samp{negative} instructs the linker to generate a single GOT with
7215 entries at both negative and positive offsets. Not all environments
7217 @samp{multigot} allows the linker to generate several GOTs in the
7218 output file. All GOT references from a single input object
7219 file access the same GOT, but references from different input object
7220 files might access different GOTs. Not all environments support such GOTs.
7233 @section @command{ld} and the MIPS family
7235 @cindex MIPS microMIPS instruction choice selection
7238 The @samp{--insn32} and @samp{--no-insn32} options control the choice of
7239 microMIPS instructions used in code generated by the linker, such as that
7240 in the PLT or lazy binding stubs, or in relaxation. If @samp{--insn32} is
7241 used, then the linker only uses 32-bit instruction encodings. By default
7242 or if @samp{--no-insn32} is used, all instruction encodings are used,
7243 including 16-bit ones where possible.
7245 @cindex MIPS branch relocation check control
7246 @kindex --ignore-branch-isa
7247 @kindex --no-ignore-branch-isa
7248 The @samp{--ignore-branch-isa} and @samp{--no-ignore-branch-isa} options
7249 control branch relocation checks for invalid ISA mode transitions. If
7250 @samp{--ignore-branch-isa} is used, then the linker accepts any branch
7251 relocations and any ISA mode transition required is lost in relocation
7252 calculation, except for some cases of @code{BAL} instructions which meet
7253 relaxation conditions and are converted to equivalent @code{JALX}
7254 instructions as the associated relocation is calculated. By default
7255 or if @samp{--no-ignore-branch-isa} is used a check is made causing
7256 the loss of an ISA mode transition to produce an error.
7269 @section @code{ld} and MMIX
7270 For MMIX, there is a choice of generating @code{ELF} object files or
7271 @code{mmo} object files when linking. The simulator @code{mmix}
7272 understands the @code{mmo} format. The binutils @code{objcopy} utility
7273 can translate between the two formats.
7275 There is one special section, the @samp{.MMIX.reg_contents} section.
7276 Contents in this section is assumed to correspond to that of global
7277 registers, and symbols referring to it are translated to special symbols,
7278 equal to registers. In a final link, the start address of the
7279 @samp{.MMIX.reg_contents} section corresponds to the first allocated
7280 global register multiplied by 8. Register @code{$255} is not included in
7281 this section; it is always set to the program entry, which is at the
7282 symbol @code{Main} for @code{mmo} files.
7284 Global symbols with the prefix @code{__.MMIX.start.}, for example
7285 @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special.
7286 The default linker script uses these to set the default start address
7289 Initial and trailing multiples of zero-valued 32-bit words in a section,
7290 are left out from an mmo file.
7303 @section @code{ld} and MSP430
7304 For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]}
7305 will select an appropriate linker script for selected MPU type. (To get a list of known MPUs
7306 just pass @samp{-m help} option to the linker).
7308 @cindex MSP430 extra sections
7309 The linker will recognize some extra sections which are MSP430 specific:
7312 @item @samp{.vectors}
7313 Defines a portion of ROM where interrupt vectors located.
7315 @item @samp{.bootloader}
7316 Defines the bootloader portion of the ROM (if applicable). Any code
7317 in this section will be uploaded to the MPU.
7319 @item @samp{.infomem}
7320 Defines an information memory section (if applicable). Any code in
7321 this section will be uploaded to the MPU.
7323 @item @samp{.infomemnobits}
7324 This is the same as the @samp{.infomem} section except that any code
7325 in this section will not be uploaded to the MPU.
7327 @item @samp{.noinit}
7328 Denotes a portion of RAM located above @samp{.bss} section.
7330 The last two sections are used by gcc.
7334 @cindex MSP430 Options
7335 @kindex --code-region
7336 @item --code-region=[either,lower,upper,none]
7337 This will transform .text* sections to [either,lower,upper].text* sections. The
7338 argument passed to GCC for -mcode-region is propagated to the linker
7341 @kindex --data-region
7342 @item --data-region=[either,lower,upper,none]
7343 This will transform .data*, .bss* and .rodata* sections to
7344 [either,lower,upper].[data,bss,rodata]* sections. The argument passed to GCC
7345 for -mdata-region is propagated to the linker using this option.
7347 @kindex --disable-sec-transformation
7348 @item --disable-sec-transformation
7349 Prevent the transformation of sections as specified by the @code{--code-region}
7350 and @code{--data-region} options.
7351 This is useful if you are compiling and linking using a single call to the GCC
7352 wrapper, and want to compile the source files using -m[code,data]-region but
7353 not transform the sections for prebuilt libraries and objects.
7367 @section @code{ld} and NDS32
7368 @kindex relaxing on NDS32
7369 For NDS32, there are some options to select relaxation behavior. The linker
7370 relaxes objects according to these options.
7373 @item @samp{--m[no-]fp-as-gp}
7374 Disable/enable fp-as-gp relaxation.
7376 @item @samp{--mexport-symbols=FILE}
7377 Exporting symbols and their address into FILE as linker script.
7379 @item @samp{--m[no-]ex9}
7380 Disable/enable link-time EX9 relaxation.
7382 @item @samp{--mexport-ex9=FILE}
7383 Export the EX9 table after linking.
7385 @item @samp{--mimport-ex9=FILE}
7386 Import the Ex9 table for EX9 relaxation.
7388 @item @samp{--mupdate-ex9}
7389 Update the existing EX9 table.
7391 @item @samp{--mex9-limit=NUM}
7392 Maximum number of entries in the ex9 table.
7394 @item @samp{--mex9-loop-aware}
7395 Avoid generating the EX9 instruction inside the loop.
7397 @item @samp{--m[no-]ifc}
7398 Disable/enable the link-time IFC optimization.
7400 @item @samp{--mifc-loop-aware}
7401 Avoid generating the IFC instruction inside the loop.
7415 @section @command{ld} and the Altera Nios II
7416 @cindex Nios II call relaxation
7417 @kindex --relax on Nios II
7419 Call and immediate jump instructions on Nios II processors are limited to
7420 transferring control to addresses in the same 256MB memory segment,
7421 which may result in @command{ld} giving
7422 @samp{relocation truncated to fit} errors with very large programs.
7423 The command-line option @option{--relax} enables the generation of
7424 trampolines that can access the entire 32-bit address space for calls
7425 outside the normal @code{call} and @code{jmpi} address range. These
7426 trampolines are inserted at section boundaries, so may not themselves
7427 be reachable if an input section and its associated call trampolines are
7430 The @option{--relax} option is enabled by default unless @option{-r}
7431 is also specified. You can disable trampoline generation by using the
7432 @option{--no-relax} linker option. You can also disable this optimization
7433 locally by using the @samp{set .noat} directive in assembly-language
7434 source files, as the linker-inserted trampolines use the @code{at}
7435 register as a temporary.
7437 Note that the linker @option{--relax} option is independent of assembler
7438 relaxation options, and that using the GNU assembler's @option{-relax-all}
7439 option interferes with the linker's more selective call instruction relaxation.
7452 @section @command{ld} and PowerPC 32-bit ELF Support
7453 @cindex PowerPC long branches
7454 @kindex --relax on PowerPC
7455 Branches on PowerPC processors are limited to a signed 26-bit
7456 displacement, which may result in @command{ld} giving
7457 @samp{relocation truncated to fit} errors with very large programs.
7458 @samp{--relax} enables the generation of trampolines that can access
7459 the entire 32-bit address space. These trampolines are inserted at
7460 section boundaries, so may not themselves be reachable if an input
7461 section exceeds 33M in size. You may combine @samp{-r} and
7462 @samp{--relax} to add trampolines in a partial link. In that case
7463 both branches to undefined symbols and inter-section branches are also
7464 considered potentially out of range, and trampolines inserted.
7466 @cindex PowerPC ELF32 options
7471 Current PowerPC GCC accepts a @samp{-msecure-plt} option that
7472 generates code capable of using a newer PLT and GOT layout that has
7473 the security advantage of no executable section ever needing to be
7474 writable and no writable section ever being executable. PowerPC
7475 @command{ld} will generate this layout, including stubs to access the
7476 PLT, if all input files (including startup and static libraries) were
7477 compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old
7478 BSS PLT (and GOT layout) which can give slightly better performance.
7480 @kindex --secure-plt
7482 @command{ld} will use the new PLT and GOT layout if it is linking new
7483 @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically
7484 when linking non-PIC code. This option requests the new PLT and GOT
7485 layout. A warning will be given if some object file requires the old
7491 The new secure PLT and GOT are placed differently relative to other
7492 sections compared to older BSS PLT and GOT placement. The location of
7493 @code{.plt} must change because the new secure PLT is an initialized
7494 section while the old PLT is uninitialized. The reason for the
7495 @code{.got} change is more subtle: The new placement allows
7496 @code{.got} to be read-only in applications linked with
7497 @samp{-z relro -z now}. However, this placement means that
7498 @code{.sdata} cannot always be used in shared libraries, because the
7499 PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT
7500 pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC
7501 GCC doesn't use @code{.sdata} in shared libraries, so this option is
7502 really only useful for other compilers that may do so.
7504 @cindex PowerPC stub symbols
7505 @kindex --emit-stub-syms
7506 @item --emit-stub-syms
7507 This option causes @command{ld} to label linker stubs with a local
7508 symbol that encodes the stub type and destination.
7510 @cindex PowerPC TLS optimization
7511 @kindex --no-tls-optimize
7512 @item --no-tls-optimize
7513 PowerPC @command{ld} normally performs some optimization of code
7514 sequences used to access Thread-Local Storage. Use this option to
7515 disable the optimization.
7528 @node PowerPC64 ELF64
7529 @section @command{ld} and PowerPC64 64-bit ELF Support
7531 @cindex PowerPC64 ELF64 options
7533 @cindex PowerPC64 stub grouping
7534 @kindex --stub-group-size
7535 @item --stub-group-size
7536 Long branch stubs, PLT call stubs and TOC adjusting stubs are placed
7537 by @command{ld} in stub sections located between groups of input sections.
7538 @samp{--stub-group-size} specifies the maximum size of a group of input
7539 sections handled by one stub section. Since branch offsets are signed,
7540 a stub section may serve two groups of input sections, one group before
7541 the stub section, and one group after it. However, when using
7542 conditional branches that require stubs, it may be better (for branch
7543 prediction) that stub sections only serve one group of input sections.
7544 A negative value for @samp{N} chooses this scheme, ensuring that
7545 branches to stubs always use a negative offset. Two special values of
7546 @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct
7547 @command{ld} to automatically size input section groups for the branch types
7548 detected, with the same behaviour regarding stub placement as other
7549 positive or negative values of @samp{N} respectively.
7551 Note that @samp{--stub-group-size} does not split input sections. A
7552 single input section larger than the group size specified will of course
7553 create a larger group (of one section). If input sections are too
7554 large, it may not be possible for a branch to reach its stub.
7556 @cindex PowerPC64 stub symbols
7557 @kindex --emit-stub-syms
7558 @item --emit-stub-syms
7559 This option causes @command{ld} to label linker stubs with a local
7560 symbol that encodes the stub type and destination.
7562 @cindex PowerPC64 dot symbols
7564 @kindex --no-dotsyms
7567 These two options control how @command{ld} interprets version patterns
7568 in a version script. Older PowerPC64 compilers emitted both a
7569 function descriptor symbol with the same name as the function, and a
7570 code entry symbol with the name prefixed by a dot (@samp{.}). To
7571 properly version a function @samp{foo}, the version script thus needs
7572 to control both @samp{foo} and @samp{.foo}. The option
7573 @samp{--dotsyms}, on by default, automatically adds the required
7574 dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this
7577 @cindex PowerPC64 register save/restore functions
7578 @kindex --save-restore-funcs
7579 @kindex --no-save-restore-funcs
7580 @item --save-restore-funcs
7581 @itemx --no-save-restore-funcs
7582 These two options control whether PowerPC64 @command{ld} automatically
7583 provides out-of-line register save and restore functions used by
7584 @samp{-Os} code. The default is to provide any such referenced
7585 function for a normal final link, and to not do so for a relocatable
7588 @cindex PowerPC64 TLS optimization
7589 @kindex --no-tls-optimize
7590 @item --no-tls-optimize
7591 PowerPC64 @command{ld} normally performs some optimization of code
7592 sequences used to access Thread-Local Storage. Use this option to
7593 disable the optimization.
7595 @cindex PowerPC64 __tls_get_addr optimization
7596 @kindex --tls-get-addr-optimize
7597 @kindex --no-tls-get-addr-optimize
7598 @kindex --tls-get-addr-regsave
7599 @kindex --no-tls-get-addr-regsave
7600 @item --tls-get-addr-optimize
7601 @itemx --no-tls-get-addr-optimize
7602 These options control how PowerPC64 @command{ld} uses a special
7603 stub to call __tls_get_addr. PowerPC64 glibc 2.22 and later support
7604 an optimization that allows the second and subsequent calls to
7605 @code{__tls_get_addr} for a given symbol to be resolved by the special
7606 stub without calling in to glibc. By default the linker enables
7607 generation of the stub when glibc advertises the availability of
7609 Using @option{--tls-get-addr-optimize} with an older glibc won't do
7610 much besides slow down your applications, but may be useful if linking
7611 an application against an older glibc with the expectation that it
7612 will normally be used on systems having a newer glibc.
7613 @option{--tls-get-addr-regsave} forces generation of a stub that saves
7614 and restores volatile registers around the call into glibc. Normally,
7615 this is done when the linker detects a call to __tls_get_addr_desc.
7616 Such calls then go via the register saving stub to __tls_get_addr_opt.
7617 @option {--no-tls-get-addr-regsave} disables generation of the
7620 @cindex PowerPC64 OPD optimization
7621 @kindex --no-opd-optimize
7622 @item --no-opd-optimize
7623 PowerPC64 @command{ld} normally removes @code{.opd} section entries
7624 corresponding to deleted link-once functions, or functions removed by
7625 the action of @samp{--gc-sections} or linker script @code{/DISCARD/}.
7626 Use this option to disable @code{.opd} optimization.
7628 @cindex PowerPC64 OPD spacing
7629 @kindex --non-overlapping-opd
7630 @item --non-overlapping-opd
7631 Some PowerPC64 compilers have an option to generate compressed
7632 @code{.opd} entries spaced 16 bytes apart, overlapping the third word,
7633 the static chain pointer (unused in C) with the first word of the next
7634 entry. This option expands such entries to the full 24 bytes.
7636 @cindex PowerPC64 TOC optimization
7637 @kindex --no-toc-optimize
7638 @item --no-toc-optimize
7639 PowerPC64 @command{ld} normally removes unused @code{.toc} section
7640 entries. Such entries are detected by examining relocations that
7641 reference the TOC in code sections. A reloc in a deleted code section
7642 marks a TOC word as unneeded, while a reloc in a kept code section
7643 marks a TOC word as needed. Since the TOC may reference itself, TOC
7644 relocs are also examined. TOC words marked as both needed and
7645 unneeded will of course be kept. TOC words without any referencing
7646 reloc are assumed to be part of a multi-word entry, and are kept or
7647 discarded as per the nearest marked preceding word. This works
7648 reliably for compiler generated code, but may be incorrect if assembly
7649 code is used to insert TOC entries. Use this option to disable the
7652 @cindex PowerPC64 multi-TOC
7653 @kindex --no-multi-toc
7654 @item --no-multi-toc
7655 If given any toc option besides @code{-mcmodel=medium} or
7656 @code{-mcmodel=large}, PowerPC64 GCC generates code for a TOC model
7658 entries are accessed with a 16-bit offset from r2. This limits the
7659 total TOC size to 64K. PowerPC64 @command{ld} extends this limit by
7660 grouping code sections such that each group uses less than 64K for its
7661 TOC entries, then inserts r2 adjusting stubs between inter-group
7662 calls. @command{ld} does not split apart input sections, so cannot
7663 help if a single input file has a @code{.toc} section that exceeds
7664 64K, most likely from linking multiple files with @command{ld -r}.
7665 Use this option to turn off this feature.
7667 @cindex PowerPC64 TOC sorting
7668 @kindex --no-toc-sort
7670 By default, @command{ld} sorts TOC sections so that those whose file
7671 happens to have a section called @code{.init} or @code{.fini} are
7672 placed first, followed by TOC sections referenced by code generated
7673 with PowerPC64 gcc's @code{-mcmodel=small}, and lastly TOC sections
7674 referenced only by code generated with PowerPC64 gcc's
7675 @code{-mcmodel=medium} or @code{-mcmodel=large} options. Doing this
7676 results in better TOC grouping for multi-TOC. Use this option to turn
7679 @cindex PowerPC64 PLT stub alignment
7681 @kindex --no-plt-align
7683 @itemx --no-plt-align
7684 Use these options to control whether individual PLT call stubs are
7685 aligned to a 32-byte boundary, or to the specified power of two
7686 boundary when using @code{--plt-align=}. A negative value may be
7687 specified to pad PLT call stubs so that they do not cross the
7688 specified power of two boundary (or the minimum number of boundaries
7689 if a PLT stub is so large that it must cross a boundary). By default
7690 PLT call stubs are aligned to 32-byte boundaries.
7692 @cindex PowerPC64 PLT call stub static chain
7693 @kindex --plt-static-chain
7694 @kindex --no-plt-static-chain
7695 @item --plt-static-chain
7696 @itemx --no-plt-static-chain
7697 Use these options to control whether PLT call stubs load the static
7698 chain pointer (r11). @code{ld} defaults to not loading the static
7699 chain since there is never any need to do so on a PLT call.
7701 @cindex PowerPC64 PLT call stub thread safety
7702 @kindex --plt-thread-safe
7703 @kindex --no-plt-thread-safe
7704 @item --plt-thread-safe
7705 @itemx --no-plt-thread-safe
7706 With power7's weakly ordered memory model, it is possible when using
7707 lazy binding for ld.so to update a plt entry in one thread and have
7708 another thread see the individual plt entry words update in the wrong
7709 order, despite ld.so carefully writing in the correct order and using
7710 memory write barriers. To avoid this we need some sort of read
7711 barrier in the call stub, or use LD_BIND_NOW=1. By default, @code{ld}
7712 looks for calls to commonly used functions that create threads, and if
7713 seen, adds the necessary barriers. Use these options to change the
7716 @cindex PowerPC64 ELFv2 PLT localentry optimization
7717 @kindex --plt-localentry
7718 @kindex --no-plt-localentry
7719 @item --plt-localentry
7720 @itemx --no-localentry
7721 ELFv2 functions with localentry:0 are those with a single entry point,
7722 ie. global entry == local entry, and that have no requirement on r2
7723 (the TOC/GOT pointer) or r12, and guarantee r2 is unchanged on return.
7724 Such an external function can be called via the PLT without saving r2
7725 or restoring it on return, avoiding a common load-hit-store for small
7726 functions. The optimization is attractive, with up to 40% reduction
7727 in execution time for a small function, but can result in symbol
7728 interposition failures. Also, minor changes in a shared library,
7729 including system libraries, can cause a function that was localentry:0
7730 to become localentry:8. This will result in a dynamic loader
7731 complaint and failure to run. The option is experimental, use with
7732 care. @option{--no-plt-localentry} is the default.
7746 @section @command{ld} and S/390 ELF Support
7748 @cindex S/390 ELF options
7752 @kindex --s390-pgste
7754 This option marks the result file with a @code{PT_S390_PGSTE}
7755 segment. The Linux kernel is supposed to allocate 4k page tables for
7756 binaries marked that way.
7770 @section @command{ld} and SPU ELF Support
7772 @cindex SPU ELF options
7778 This option marks an executable as a PIC plugin module.
7780 @cindex SPU overlays
7781 @kindex --no-overlays
7783 Normally, @command{ld} recognizes calls to functions within overlay
7784 regions, and redirects such calls to an overlay manager via a stub.
7785 @command{ld} also provides a built-in overlay manager. This option
7786 turns off all this special overlay handling.
7788 @cindex SPU overlay stub symbols
7789 @kindex --emit-stub-syms
7790 @item --emit-stub-syms
7791 This option causes @command{ld} to label overlay stubs with a local
7792 symbol that encodes the stub type and destination.
7794 @cindex SPU extra overlay stubs
7795 @kindex --extra-overlay-stubs
7796 @item --extra-overlay-stubs
7797 This option causes @command{ld} to add overlay call stubs on all
7798 function calls out of overlay regions. Normally stubs are not added
7799 on calls to non-overlay regions.
7801 @cindex SPU local store size
7802 @kindex --local-store=lo:hi
7803 @item --local-store=lo:hi
7804 @command{ld} usually checks that a final executable for SPU fits in
7805 the address range 0 to 256k. This option may be used to change the
7806 range. Disable the check entirely with @option{--local-store=0:0}.
7809 @kindex --stack-analysis
7810 @item --stack-analysis
7811 SPU local store space is limited. Over-allocation of stack space
7812 unnecessarily limits space available for code and data, while
7813 under-allocation results in runtime failures. If given this option,
7814 @command{ld} will provide an estimate of maximum stack usage.
7815 @command{ld} does this by examining symbols in code sections to
7816 determine the extents of functions, and looking at function prologues
7817 for stack adjusting instructions. A call-graph is created by looking
7818 for relocations on branch instructions. The graph is then searched
7819 for the maximum stack usage path. Note that this analysis does not
7820 find calls made via function pointers, and does not handle recursion
7821 and other cycles in the call graph. Stack usage may be
7822 under-estimated if your code makes such calls. Also, stack usage for
7823 dynamic allocation, e.g. alloca, will not be detected. If a link map
7824 is requested, detailed information about each function's stack usage
7825 and calls will be given.
7828 @kindex --emit-stack-syms
7829 @item --emit-stack-syms
7830 This option, if given along with @option{--stack-analysis} will result
7831 in @command{ld} emitting stack sizing symbols for each function.
7832 These take the form @code{__stack_<function_name>} for global
7833 functions, and @code{__stack_<number>_<function_name>} for static
7834 functions. @code{<number>} is the section id in hex. The value of
7835 such symbols is the stack requirement for the corresponding function.
7836 The symbol size will be zero, type @code{STT_NOTYPE}, binding
7837 @code{STB_LOCAL}, and section @code{SHN_ABS}.
7851 @section @command{ld}'s Support for Various TI COFF Versions
7852 @cindex TI COFF versions
7853 @kindex --format=@var{version}
7854 The @samp{--format} switch allows selection of one of the various
7855 TI COFF versions. The latest of this writing is 2; versions 0 and 1 are
7856 also supported. The TI COFF versions also vary in header byte-order
7857 format; @command{ld} will read any version or byte order, but the output
7858 header format depends on the default specified by the specific target.
7871 @section @command{ld} and WIN32 (cygwin/mingw)
7873 This section describes some of the win32 specific @command{ld} issues.
7874 See @ref{Options,,Command-line Options} for detailed description of the
7875 command-line options mentioned here.
7878 @cindex import libraries
7879 @item import libraries
7880 The standard Windows linker creates and uses so-called import
7881 libraries, which contains information for linking to dll's. They are
7882 regular static archives and are handled as any other static
7883 archive. The cygwin and mingw ports of @command{ld} have specific
7884 support for creating such libraries provided with the
7885 @samp{--out-implib} command-line option.
7887 @item exporting DLL symbols
7888 @cindex exporting DLL symbols
7889 The cygwin/mingw @command{ld} has several ways to export symbols for dll's.
7892 @item using auto-export functionality
7893 @cindex using auto-export functionality
7894 By default @command{ld} exports symbols with the auto-export functionality,
7895 which is controlled by the following command-line options:
7898 @item --export-all-symbols [This is the default]
7899 @item --exclude-symbols
7900 @item --exclude-libs
7901 @item --exclude-modules-for-implib
7902 @item --version-script
7905 When auto-export is in operation, @command{ld} will export all the non-local
7906 (global and common) symbols it finds in a DLL, with the exception of a few
7907 symbols known to belong to the system's runtime and libraries. As it will
7908 often not be desirable to export all of a DLL's symbols, which may include
7909 private functions that are not part of any public interface, the command-line
7910 options listed above may be used to filter symbols out from the list for
7911 exporting. The @samp{--output-def} option can be used in order to see the
7912 final list of exported symbols with all exclusions taken into effect.
7914 If @samp{--export-all-symbols} is not given explicitly on the
7915 command line, then the default auto-export behavior will be @emph{disabled}
7916 if either of the following are true:
7919 @item A DEF file is used.
7920 @item Any symbol in any object file was marked with the __declspec(dllexport) attribute.
7923 @item using a DEF file
7924 @cindex using a DEF file
7925 Another way of exporting symbols is using a DEF file. A DEF file is
7926 an ASCII file containing definitions of symbols which should be
7927 exported when a dll is created. Usually it is named @samp{<dll
7928 name>.def} and is added as any other object file to the linker's
7929 command line. The file's name must end in @samp{.def} or @samp{.DEF}.
7932 gcc -o <output> <objectfiles> <dll name>.def
7935 Using a DEF file turns off the normal auto-export behavior, unless the
7936 @samp{--export-all-symbols} option is also used.
7938 Here is an example of a DEF file for a shared library called @samp{xyz.dll}:
7941 LIBRARY "xyz.dll" BASE=0x20000000
7947 another_foo = abc.dll.afoo
7953 This example defines a DLL with a non-default base address and seven
7954 symbols in the export table. The third exported symbol @code{_bar} is an
7955 alias for the second. The fourth symbol, @code{another_foo} is resolved
7956 by "forwarding" to another module and treating it as an alias for
7957 @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol
7958 @code{var1} is declared to be a data object. The @samp{doo} symbol in
7959 export library is an alias of @samp{foo}, which gets the string name
7960 in export table @samp{foo2}. The @samp{eoo} symbol is an data export
7961 symbol, which gets in export table the name @samp{var1}.
7963 The optional @code{LIBRARY <name>} command indicates the @emph{internal}
7964 name of the output DLL. If @samp{<name>} does not include a suffix,
7965 the default library suffix, @samp{.DLL} is appended.
7967 When the .DEF file is used to build an application, rather than a
7968 library, the @code{NAME <name>} command should be used instead of
7969 @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default
7970 executable suffix, @samp{.EXE} is appended.
7972 With either @code{LIBRARY <name>} or @code{NAME <name>} the optional
7973 specification @code{BASE = <number>} may be used to specify a
7974 non-default base address for the image.
7976 If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified,
7977 or they specify an empty string, the internal name is the same as the
7978 filename specified on the command line.
7980 The complete specification of an export symbol is:
7984 ( ( ( <name1> [ = <name2> ] )
7985 | ( <name1> = <module-name> . <external-name>))
7986 [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) *
7989 Declares @samp{<name1>} as an exported symbol from the DLL, or declares
7990 @samp{<name1>} as an exported alias for @samp{<name2>}; or declares
7991 @samp{<name1>} as a "forward" alias for the symbol
7992 @samp{<external-name>} in the DLL @samp{<module-name>}.
7993 Optionally, the symbol may be exported by the specified ordinal
7994 @samp{<integer>} alias. The optional @samp{<name3>} is the to be used
7995 string in import/export table for the symbol.
7997 The optional keywords that follow the declaration indicate:
7999 @code{NONAME}: Do not put the symbol name in the DLL's export table. It
8000 will still be exported by its ordinal alias (either the value specified
8001 by the .def specification or, otherwise, the value assigned by the
8002 linker). The symbol name, however, does remain visible in the import
8003 library (if any), unless @code{PRIVATE} is also specified.
8005 @code{DATA}: The symbol is a variable or object, rather than a function.
8006 The import lib will export only an indirect reference to @code{foo} as
8007 the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as
8010 @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as
8011 well as @code{_imp__foo} into the import library. Both refer to the
8012 read-only import address table's pointer to the variable, not to the
8013 variable itself. This can be dangerous. If the user code fails to add
8014 the @code{dllimport} attribute and also fails to explicitly add the
8015 extra indirection that the use of the attribute enforces, the
8016 application will behave unexpectedly.
8018 @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put
8019 it into the static import library used to resolve imports at link time. The
8020 symbol can still be imported using the @code{LoadLibrary/GetProcAddress}
8021 API at runtime or by using the GNU ld extension of linking directly to
8022 the DLL without an import library.
8024 See ld/deffilep.y in the binutils sources for the full specification of
8025 other DEF file statements
8027 @cindex creating a DEF file
8028 While linking a shared dll, @command{ld} is able to create a DEF file
8029 with the @samp{--output-def <file>} command-line option.
8031 @item Using decorations
8032 @cindex Using decorations
8033 Another way of marking symbols for export is to modify the source code
8034 itself, so that when building the DLL each symbol to be exported is
8038 __declspec(dllexport) int a_variable
8039 __declspec(dllexport) void a_function(int with_args)
8042 All such symbols will be exported from the DLL. If, however,
8043 any of the object files in the DLL contain symbols decorated in
8044 this way, then the normal auto-export behavior is disabled, unless
8045 the @samp{--export-all-symbols} option is also used.
8047 Note that object files that wish to access these symbols must @emph{not}
8048 decorate them with dllexport. Instead, they should use dllimport,
8052 __declspec(dllimport) int a_variable
8053 __declspec(dllimport) void a_function(int with_args)
8056 This complicates the structure of library header files, because
8057 when included by the library itself the header must declare the
8058 variables and functions as dllexport, but when included by client
8059 code the header must declare them as dllimport. There are a number
8060 of idioms that are typically used to do this; often client code can
8061 omit the __declspec() declaration completely. See
8062 @samp{--enable-auto-import} and @samp{automatic data imports} for more
8066 @cindex automatic data imports
8067 @item automatic data imports
8068 The standard Windows dll format supports data imports from dlls only
8069 by adding special decorations (dllimport/dllexport), which let the
8070 compiler produce specific assembler instructions to deal with this
8071 issue. This increases the effort necessary to port existing Un*x
8072 code to these platforms, especially for large
8073 c++ libraries and applications. The auto-import feature, which was
8074 initially provided by Paul Sokolovsky, allows one to omit the
8075 decorations to achieve a behavior that conforms to that on POSIX/Un*x
8076 platforms. This feature is enabled with the @samp{--enable-auto-import}
8077 command-line option, although it is enabled by default on cygwin/mingw.
8078 The @samp{--enable-auto-import} option itself now serves mainly to
8079 suppress any warnings that are ordinarily emitted when linked objects
8080 trigger the feature's use.
8082 auto-import of variables does not always work flawlessly without
8083 additional assistance. Sometimes, you will see this message
8085 "variable '<var>' can't be auto-imported. Please read the
8086 documentation for ld's @code{--enable-auto-import} for details."
8088 The @samp{--enable-auto-import} documentation explains why this error
8089 occurs, and several methods that can be used to overcome this difficulty.
8090 One of these methods is the @emph{runtime pseudo-relocs} feature, described
8093 @cindex runtime pseudo-relocation
8094 For complex variables imported from DLLs (such as structs or classes),
8095 object files typically contain a base address for the variable and an
8096 offset (@emph{addend}) within the variable--to specify a particular
8097 field or public member, for instance. Unfortunately, the runtime loader used
8098 in win32 environments is incapable of fixing these references at runtime
8099 without the additional information supplied by dllimport/dllexport decorations.
8100 The standard auto-import feature described above is unable to resolve these
8103 The @samp{--enable-runtime-pseudo-relocs} switch allows these references to
8104 be resolved without error, while leaving the task of adjusting the references
8105 themselves (with their non-zero addends) to specialized code provided by the
8106 runtime environment. Recent versions of the cygwin and mingw environments and
8107 compilers provide this runtime support; older versions do not. However, the
8108 support is only necessary on the developer's platform; the compiled result will
8109 run without error on an older system.
8111 @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly
8114 @cindex direct linking to a dll
8115 @item direct linking to a dll
8116 The cygwin/mingw ports of @command{ld} support the direct linking,
8117 including data symbols, to a dll without the usage of any import
8118 libraries. This is much faster and uses much less memory than does the
8119 traditional import library method, especially when linking large
8120 libraries or applications. When @command{ld} creates an import lib, each
8121 function or variable exported from the dll is stored in its own bfd, even
8122 though a single bfd could contain many exports. The overhead involved in
8123 storing, loading, and processing so many bfd's is quite large, and explains the
8124 tremendous time, memory, and storage needed to link against particularly
8125 large or complex libraries when using import libs.
8127 Linking directly to a dll uses no extra command-line switches other than
8128 @samp{-L} and @samp{-l}, because @command{ld} already searches for a number
8129 of names to match each library. All that is needed from the developer's
8130 perspective is an understanding of this search, in order to force ld to
8131 select the dll instead of an import library.
8134 For instance, when ld is called with the argument @samp{-lxxx} it will attempt
8135 to find, in the first directory of its search path,
8148 before moving on to the next directory in the search path.
8150 (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll},
8151 where @samp{<prefix>} is set by the @command{ld} option
8152 @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec
8153 file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for
8156 Other win32-based unix environments, such as mingw or pw32, may use other
8157 @samp{<prefix>}es, although at present only cygwin makes use of this feature. It
8158 was originally intended to help avoid name conflicts among dll's built for the
8159 various win32/un*x environments, so that (for example) two versions of a zlib dll
8160 could coexist on the same machine.
8162 The generic cygwin/mingw path layout uses a @samp{bin} directory for
8163 applications and dll's and a @samp{lib} directory for the import
8164 libraries (using cygwin nomenclature):
8170 libxxx.dll.a (in case of dll's)
8171 libxxx.a (in case of static archive)
8174 Linking directly to a dll without using the import library can be
8177 1. Use the dll directly by adding the @samp{bin} path to the link line
8179 gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx
8182 However, as the dll's often have version numbers appended to their names
8183 (@samp{cygncurses-5.dll}) this will often fail, unless one specifies
8184 @samp{-L../bin -lncurses-5} to include the version. Import libs are generally
8185 not versioned, and do not have this difficulty.
8187 2. Create a symbolic link from the dll to a file in the @samp{lib}
8188 directory according to the above mentioned search pattern. This
8189 should be used to avoid unwanted changes in the tools needed for
8193 ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a]
8196 Then you can link without any make environment changes.
8199 gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx
8202 This technique also avoids the version number problems, because the following is
8209 libxxx.dll.a -> ../bin/cygxxx-5.dll
8212 Linking directly to a dll without using an import lib will work
8213 even when auto-import features are exercised, and even when
8214 @samp{--enable-runtime-pseudo-relocs} is used.
8216 Given the improvements in speed and memory usage, one might justifiably
8217 wonder why import libraries are used at all. There are three reasons:
8219 1. Until recently, the link-directly-to-dll functionality did @emph{not}
8220 work with auto-imported data.
8222 2. Sometimes it is necessary to include pure static objects within the
8223 import library (which otherwise contains only bfd's for indirection
8224 symbols that point to the exports of a dll). Again, the import lib
8225 for the cygwin kernel makes use of this ability, and it is not
8226 possible to do this without an import lib.
8228 3. Symbol aliases can only be resolved using an import lib. This is
8229 critical when linking against OS-supplied dll's (eg, the win32 API)
8230 in which symbols are usually exported as undecorated aliases of their
8231 stdcall-decorated assembly names.
8233 So, import libs are not going away. But the ability to replace
8234 true import libs with a simple symbolic link to (or a copy of)
8235 a dll, in many cases, is a useful addition to the suite of tools
8236 binutils makes available to the win32 developer. Given the
8237 massive improvements in memory requirements during linking, storage
8238 requirements, and linking speed, we expect that many developers
8239 will soon begin to use this feature whenever possible.
8241 @item symbol aliasing
8243 @item adding additional names
8244 Sometimes, it is useful to export symbols with additional names.
8245 A symbol @samp{foo} will be exported as @samp{foo}, but it can also be
8246 exported as @samp{_foo} by using special directives in the DEF file
8247 when creating the dll. This will affect also the optional created
8248 import library. Consider the following DEF file:
8251 LIBRARY "xyz.dll" BASE=0x61000000
8258 The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}.
8260 Another method for creating a symbol alias is to create it in the
8261 source code using the "weak" attribute:
8264 void foo () @{ /* Do something. */; @}
8265 void _foo () __attribute__ ((weak, alias ("foo")));
8268 See the gcc manual for more information about attributes and weak
8271 @item renaming symbols
8272 Sometimes it is useful to rename exports. For instance, the cygwin
8273 kernel does this regularly. A symbol @samp{_foo} can be exported as
8274 @samp{foo} but not as @samp{_foo} by using special directives in the
8275 DEF file. (This will also affect the import library, if it is
8276 created). In the following example:
8279 LIBRARY "xyz.dll" BASE=0x61000000
8285 The line @samp{_foo = foo} maps the exported symbol @samp{foo} to
8289 Note: using a DEF file disables the default auto-export behavior,
8290 unless the @samp{--export-all-symbols} command-line option is used.
8291 If, however, you are trying to rename symbols, then you should list
8292 @emph{all} desired exports in the DEF file, including the symbols
8293 that are not being renamed, and do @emph{not} use the
8294 @samp{--export-all-symbols} option. If you list only the
8295 renamed symbols in the DEF file, and use @samp{--export-all-symbols}
8296 to handle the other symbols, then the both the new names @emph{and}
8297 the original names for the renamed symbols will be exported.
8298 In effect, you'd be aliasing those symbols, not renaming them,
8299 which is probably not what you wanted.
8301 @cindex weak externals
8302 @item weak externals
8303 The Windows object format, PE, specifies a form of weak symbols called
8304 weak externals. When a weak symbol is linked and the symbol is not
8305 defined, the weak symbol becomes an alias for some other symbol. There
8306 are three variants of weak externals:
8308 @item Definition is searched for in objects and libraries, historically
8309 called lazy externals.
8310 @item Definition is searched for only in other objects, not in libraries.
8311 This form is not presently implemented.
8312 @item No search; the symbol is an alias. This form is not presently
8315 As a GNU extension, weak symbols that do not specify an alternate symbol
8316 are supported. If the symbol is undefined when linking, the symbol
8317 uses a default value.
8319 @cindex aligned common symbols
8320 @item aligned common symbols
8321 As a GNU extension to the PE file format, it is possible to specify the
8322 desired alignment for a common symbol. This information is conveyed from
8323 the assembler or compiler to the linker by means of GNU-specific commands
8324 carried in the object file's @samp{.drectve} section, which are recognized
8325 by @command{ld} and respected when laying out the common symbols. Native
8326 tools will be able to process object files employing this GNU extension,
8327 but will fail to respect the alignment instructions, and may issue noisy
8328 warnings about unknown linker directives.
8343 @section @code{ld} and Xtensa Processors
8345 @cindex Xtensa processors
8346 The default @command{ld} behavior for Xtensa processors is to interpret
8347 @code{SECTIONS} commands so that lists of explicitly named sections in a
8348 specification with a wildcard file will be interleaved when necessary to
8349 keep literal pools within the range of PC-relative load offsets. For
8350 example, with the command:
8362 @command{ld} may interleave some of the @code{.literal}
8363 and @code{.text} sections from different object files to ensure that the
8364 literal pools are within the range of PC-relative load offsets. A valid
8365 interleaving might place the @code{.literal} sections from an initial
8366 group of files followed by the @code{.text} sections of that group of
8367 files. Then, the @code{.literal} sections from the rest of the files
8368 and the @code{.text} sections from the rest of the files would follow.
8370 @cindex @option{--relax} on Xtensa
8371 @cindex relaxing on Xtensa
8372 Relaxation is enabled by default for the Xtensa version of @command{ld} and
8373 provides two important link-time optimizations. The first optimization
8374 is to combine identical literal values to reduce code size. A redundant
8375 literal will be removed and all the @code{L32R} instructions that use it
8376 will be changed to reference an identical literal, as long as the
8377 location of the replacement literal is within the offset range of all
8378 the @code{L32R} instructions. The second optimization is to remove
8379 unnecessary overhead from assembler-generated ``longcall'' sequences of
8380 @code{L32R}/@code{CALLX@var{n}} when the target functions are within
8381 range of direct @code{CALL@var{n}} instructions.
8383 For each of these cases where an indirect call sequence can be optimized
8384 to a direct call, the linker will change the @code{CALLX@var{n}}
8385 instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R}
8386 instruction, and remove the literal referenced by the @code{L32R}
8387 instruction if it is not used for anything else. Removing the
8388 @code{L32R} instruction always reduces code size but can potentially
8389 hurt performance by changing the alignment of subsequent branch targets.
8390 By default, the linker will always preserve alignments, either by
8391 switching some instructions between 24-bit encodings and the equivalent
8392 density instructions or by inserting a no-op in place of the @code{L32R}
8393 instruction that was removed. If code size is more important than
8394 performance, the @option{--size-opt} option can be used to prevent the
8395 linker from widening density instructions or inserting no-ops, except in
8396 a few cases where no-ops are required for correctness.
8398 The following Xtensa-specific command-line options can be used to
8401 @cindex Xtensa options
8404 When optimizing indirect calls to direct calls, optimize for code size
8405 more than performance. With this option, the linker will not insert
8406 no-ops or widen density instructions to preserve branch target
8407 alignment. There may still be some cases where no-ops are required to
8408 preserve the correctness of the code.
8416 @ifclear SingleFormat
8421 @cindex object file management
8422 @cindex object formats available
8424 The linker accesses object and archive files using the BFD libraries.
8425 These libraries allow the linker to use the same routines to operate on
8426 object files whatever the object file format. A different object file
8427 format can be supported simply by creating a new BFD back end and adding
8428 it to the library. To conserve runtime memory, however, the linker and
8429 associated tools are usually configured to support only a subset of the
8430 object file formats available. You can use @code{objdump -i}
8431 (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to
8432 list all the formats available for your configuration.
8434 @cindex BFD requirements
8435 @cindex requirements for BFD
8436 As with most implementations, BFD is a compromise between
8437 several conflicting requirements. The major factor influencing
8438 BFD design was efficiency: any time used converting between
8439 formats is time which would not have been spent had BFD not
8440 been involved. This is partly offset by abstraction payback; since
8441 BFD simplifies applications and back ends, more time and care
8442 may be spent optimizing algorithms for a greater speed.
8444 One minor artifact of the BFD solution which you should bear in
8445 mind is the potential for information loss. There are two places where
8446 useful information can be lost using the BFD mechanism: during
8447 conversion and during output. @xref{BFD information loss}.
8450 * BFD outline:: How it works: an outline of BFD
8454 @section How It Works: An Outline of BFD
8455 @cindex opening object files
8456 @include bfdsumm.texi
8459 @node Reporting Bugs
8460 @chapter Reporting Bugs
8461 @cindex bugs in @command{ld}
8462 @cindex reporting bugs in @command{ld}
8464 Your bug reports play an essential role in making @command{ld} reliable.
8466 Reporting a bug may help you by bringing a solution to your problem, or
8467 it may not. But in any case the principal function of a bug report is
8468 to help the entire community by making the next version of @command{ld}
8469 work better. Bug reports are your contribution to the maintenance of
8472 In order for a bug report to serve its purpose, you must include the
8473 information that enables us to fix the bug.
8476 * Bug Criteria:: Have you found a bug?
8477 * Bug Reporting:: How to report bugs
8481 @section Have You Found a Bug?
8482 @cindex bug criteria
8484 If you are not sure whether you have found a bug, here are some guidelines:
8487 @cindex fatal signal
8488 @cindex linker crash
8489 @cindex crash of linker
8491 If the linker gets a fatal signal, for any input whatever, that is a
8492 @command{ld} bug. Reliable linkers never crash.
8494 @cindex error on valid input
8496 If @command{ld} produces an error message for valid input, that is a bug.
8498 @cindex invalid input
8500 If @command{ld} does not produce an error message for invalid input, that
8501 may be a bug. In the general case, the linker can not verify that
8502 object files are correct.
8505 If you are an experienced user of linkers, your suggestions for
8506 improvement of @command{ld} are welcome in any case.
8510 @section How to Report Bugs
8512 @cindex @command{ld} bugs, reporting
8514 A number of companies and individuals offer support for @sc{gnu}
8515 products. If you obtained @command{ld} from a support organization, we
8516 recommend you contact that organization first.
8518 You can find contact information for many support companies and
8519 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
8523 Otherwise, send bug reports for @command{ld} to
8527 The fundamental principle of reporting bugs usefully is this:
8528 @strong{report all the facts}. If you are not sure whether to state a
8529 fact or leave it out, state it!
8531 Often people omit facts because they think they know what causes the
8532 problem and assume that some details do not matter. Thus, you might
8533 assume that the name of a symbol you use in an example does not
8534 matter. Well, probably it does not, but one cannot be sure. Perhaps
8535 the bug is a stray memory reference which happens to fetch from the
8536 location where that name is stored in memory; perhaps, if the name
8537 were different, the contents of that location would fool the linker
8538 into doing the right thing despite the bug. Play it safe and give a
8539 specific, complete example. That is the easiest thing for you to do,
8540 and the most helpful.
8542 Keep in mind that the purpose of a bug report is to enable us to fix
8543 the bug if it is new to us. Therefore, always write your bug reports
8544 on the assumption that the bug has not been reported previously.
8546 Sometimes people give a few sketchy facts and ask, ``Does this ring a
8547 bell?'' This cannot help us fix a bug, so it is basically useless. We
8548 respond by asking for enough details to enable us to investigate.
8549 You might as well expedite matters by sending them to begin with.
8551 To enable us to fix the bug, you should include all these things:
8555 The version of @command{ld}. @command{ld} announces it if you start it with
8556 the @samp{--version} argument.
8558 Without this, we will not know whether there is any point in looking for
8559 the bug in the current version of @command{ld}.
8562 Any patches you may have applied to the @command{ld} source, including any
8563 patches made to the @code{BFD} library.
8566 The type of machine you are using, and the operating system name and
8570 What compiler (and its version) was used to compile @command{ld}---e.g.
8574 The command arguments you gave the linker to link your example and
8575 observe the bug. To guarantee you will not omit something important,
8576 list them all. A copy of the Makefile (or the output from make) is
8579 If we were to try to guess the arguments, we would probably guess wrong
8580 and then we might not encounter the bug.
8583 A complete input file, or set of input files, that will reproduce the
8584 bug. It is generally most helpful to send the actual object files
8585 provided that they are reasonably small. Say no more than 10K. For
8586 bigger files you can either make them available by FTP or HTTP or else
8587 state that you are willing to send the object file(s) to whomever
8588 requests them. (Note - your email will be going to a mailing list, so
8589 we do not want to clog it up with large attachments). But small
8590 attachments are best.
8592 If the source files were assembled using @code{gas} or compiled using
8593 @code{gcc}, then it may be OK to send the source files rather than the
8594 object files. In this case, be sure to say exactly what version of
8595 @code{gas} or @code{gcc} was used to produce the object files. Also say
8596 how @code{gas} or @code{gcc} were configured.
8599 A description of what behavior you observe that you believe is
8600 incorrect. For example, ``It gets a fatal signal.''
8602 Of course, if the bug is that @command{ld} gets a fatal signal, then we
8603 will certainly notice it. But if the bug is incorrect output, we might
8604 not notice unless it is glaringly wrong. You might as well not give us
8605 a chance to make a mistake.
8607 Even if the problem you experience is a fatal signal, you should still
8608 say so explicitly. Suppose something strange is going on, such as, your
8609 copy of @command{ld} is out of sync, or you have encountered a bug in the
8610 C library on your system. (This has happened!) Your copy might crash
8611 and ours would not. If you told us to expect a crash, then when ours
8612 fails to crash, we would know that the bug was not happening for us. If
8613 you had not told us to expect a crash, then we would not be able to draw
8614 any conclusion from our observations.
8617 If you wish to suggest changes to the @command{ld} source, send us context
8618 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or
8619 @samp{-p} option. Always send diffs from the old file to the new file.
8620 If you even discuss something in the @command{ld} source, refer to it by
8621 context, not by line number.
8623 The line numbers in our development sources will not match those in your
8624 sources. Your line numbers would convey no useful information to us.
8627 Here are some things that are not necessary:
8631 A description of the envelope of the bug.
8633 Often people who encounter a bug spend a lot of time investigating
8634 which changes to the input file will make the bug go away and which
8635 changes will not affect it.
8637 This is often time consuming and not very useful, because the way we
8638 will find the bug is by running a single example under the debugger
8639 with breakpoints, not by pure deduction from a series of examples.
8640 We recommend that you save your time for something else.
8642 Of course, if you can find a simpler example to report @emph{instead}
8643 of the original one, that is a convenience for us. Errors in the
8644 output will be easier to spot, running under the debugger will take
8645 less time, and so on.
8647 However, simplification is not vital; if you do not want to do this,
8648 report the bug anyway and send us the entire test case you used.
8651 A patch for the bug.
8653 A patch for the bug does help us if it is a good one. But do not omit
8654 the necessary information, such as the test case, on the assumption that
8655 a patch is all we need. We might see problems with your patch and decide
8656 to fix the problem another way, or we might not understand it at all.
8658 Sometimes with a program as complicated as @command{ld} it is very hard to
8659 construct an example that will make the program follow a certain path
8660 through the code. If you do not send us the example, we will not be
8661 able to construct one, so we will not be able to verify that the bug is
8664 And if we cannot understand what bug you are trying to fix, or why your
8665 patch should be an improvement, we will not install it. A test case will
8666 help us to understand.
8669 A guess about what the bug is or what it depends on.
8671 Such guesses are usually wrong. Even we cannot guess right about such
8672 things without first using the debugger to find the facts.
8676 @appendix MRI Compatible Script Files
8677 @cindex MRI compatibility
8678 To aid users making the transition to @sc{gnu} @command{ld} from the MRI
8679 linker, @command{ld} can use MRI compatible linker scripts as an
8680 alternative to the more general-purpose linker scripting language
8681 described in @ref{Scripts}. MRI compatible linker scripts have a much
8682 simpler command set than the scripting language otherwise used with
8683 @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI
8684 linker commands; these commands are described here.
8686 In general, MRI scripts aren't of much use with the @code{a.out} object
8687 file format, since it only has three sections and MRI scripts lack some
8688 features to make use of them.
8690 You can specify a file containing an MRI-compatible script using the
8691 @samp{-c} command-line option.
8693 Each command in an MRI-compatible script occupies its own line; each
8694 command line starts with the keyword that identifies the command (though
8695 blank lines are also allowed for punctuation). If a line of an
8696 MRI-compatible script begins with an unrecognized keyword, @command{ld}
8697 issues a warning message, but continues processing the script.
8699 Lines beginning with @samp{*} are comments.
8701 You can write these commands using all upper-case letters, or all
8702 lower case; for example, @samp{chip} is the same as @samp{CHIP}.
8703 The following list shows only the upper-case form of each command.
8706 @cindex @code{ABSOLUTE} (MRI)
8707 @item ABSOLUTE @var{secname}
8708 @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname}
8709 Normally, @command{ld} includes in the output file all sections from all
8710 the input files. However, in an MRI-compatible script, you can use the
8711 @code{ABSOLUTE} command to restrict the sections that will be present in
8712 your output program. If the @code{ABSOLUTE} command is used at all in a
8713 script, then only the sections named explicitly in @code{ABSOLUTE}
8714 commands will appear in the linker output. You can still use other
8715 input sections (whatever you select on the command line, or using
8716 @code{LOAD}) to resolve addresses in the output file.
8718 @cindex @code{ALIAS} (MRI)
8719 @item ALIAS @var{out-secname}, @var{in-secname}
8720 Use this command to place the data from input section @var{in-secname}
8721 in a section called @var{out-secname} in the linker output file.
8723 @var{in-secname} may be an integer.
8725 @cindex @code{ALIGN} (MRI)
8726 @item ALIGN @var{secname} = @var{expression}
8727 Align the section called @var{secname} to @var{expression}. The
8728 @var{expression} should be a power of two.
8730 @cindex @code{BASE} (MRI)
8731 @item BASE @var{expression}
8732 Use the value of @var{expression} as the lowest address (other than
8733 absolute addresses) in the output file.
8735 @cindex @code{CHIP} (MRI)
8736 @item CHIP @var{expression}
8737 @itemx CHIP @var{expression}, @var{expression}
8738 This command does nothing; it is accepted only for compatibility.
8740 @cindex @code{END} (MRI)
8742 This command does nothing whatever; it's only accepted for compatibility.
8744 @cindex @code{FORMAT} (MRI)
8745 @item FORMAT @var{output-format}
8746 Similar to the @code{OUTPUT_FORMAT} command in the more general linker
8747 language, but restricted to S-records, if @var{output-format} is @samp{S}
8749 @cindex @code{LIST} (MRI)
8750 @item LIST @var{anything}@dots{}
8751 Print (to the standard output file) a link map, as produced by the
8752 @command{ld} command-line option @samp{-M}.
8754 The keyword @code{LIST} may be followed by anything on the
8755 same line, with no change in its effect.
8757 @cindex @code{LOAD} (MRI)
8758 @item LOAD @var{filename}
8759 @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename}
8760 Include one or more object file @var{filename} in the link; this has the
8761 same effect as specifying @var{filename} directly on the @command{ld}
8764 @cindex @code{NAME} (MRI)
8765 @item NAME @var{output-name}
8766 @var{output-name} is the name for the program produced by @command{ld}; the
8767 MRI-compatible command @code{NAME} is equivalent to the command-line
8768 option @samp{-o} or the general script language command @code{OUTPUT}.
8770 @cindex @code{ORDER} (MRI)
8771 @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname}
8772 @itemx ORDER @var{secname} @var{secname} @var{secname}
8773 Normally, @command{ld} orders the sections in its output file in the
8774 order in which they first appear in the input files. In an MRI-compatible
8775 script, you can override this ordering with the @code{ORDER} command. The
8776 sections you list with @code{ORDER} will appear first in your output
8777 file, in the order specified.
8779 @cindex @code{PUBLIC} (MRI)
8780 @item PUBLIC @var{name}=@var{expression}
8781 @itemx PUBLIC @var{name},@var{expression}
8782 @itemx PUBLIC @var{name} @var{expression}
8783 Supply a value (@var{expression}) for external symbol
8784 @var{name} used in the linker input files.
8786 @cindex @code{SECT} (MRI)
8787 @item SECT @var{secname}, @var{expression}
8788 @itemx SECT @var{secname}=@var{expression}
8789 @itemx SECT @var{secname} @var{expression}
8790 You can use any of these three forms of the @code{SECT} command to
8791 specify the start address (@var{expression}) for section @var{secname}.
8792 If you have more than one @code{SECT} statement for the same
8793 @var{secname}, only the @emph{first} sets the start address.
8796 @node GNU Free Documentation License
8797 @appendix GNU Free Documentation License
8801 @unnumbered LD Index
8806 % I think something like @@colophon should be in texinfo. In the
8808 \long\def\colophon{\hbox to0pt{}\vfill
8809 \centerline{The body of this manual is set in}
8810 \centerline{\fontname\tenrm,}
8811 \centerline{with headings in {\bf\fontname\tenbf}}
8812 \centerline{and examples in {\tt\fontname\tentt}.}
8813 \centerline{{\it\fontname\tenit\/} and}
8814 \centerline{{\sl\fontname\tensl\/}}
8815 \centerline{are used for emphasis.}\vfill}
8817 % Blame: doc@@cygnus.com, 28mar91.