4 @include configdoc.texi
5 @c (configdoc.texi is generated by the Makefile)
12 * Ld:: The GNU linker.
18 This file documents the GNU linker LD.
20 Copyright (C) 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
22 Permission is granted to make and distribute verbatim copies of
23 this manual provided the copyright notice and this permission notice
24 are preserved on all copies.
26 Permission is granted to copy and distribute modified versions of this
27 manual under the conditions for verbatim copying, provided also that
28 the entire resulting derived work is distributed under the terms of a
29 permission notice identical to this one.
31 Permission is granted to copy and distribute translations of this manual
32 into another language, under the above conditions for modified versions.
35 Permission is granted to process this file through Tex and print the
36 results, provided the printed document carries copying permission
37 notice identical to this one except for the removal of this paragraph
38 (this paragraph not being relevant to the printed manual).
44 @setchapternewpage odd
45 @settitle Using LD, the GNU linker
48 @subtitle The GNU linker
50 @subtitle @code{ld} version 2
51 @subtitle January 1994
52 @author Steve Chamberlain and Roland Pesch
53 @author Cygnus Support
58 \hfill Cygnus Support\par
59 \hfill steve\@cygnus.com, pesch\@cygnus.com\par
60 \hfill {\it Using LD, the GNU linker}\par
61 \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par
62 \hfill and Roland Pesch (pesch\@cygnus.com)\par
64 \global\parindent=0pt % Steve likes it this way.
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
70 Permission is granted to make and distribute verbatim copies of
71 this manual provided the copyright notice and this permission notice
72 are preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided also that
76 the entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
83 @c FIXME: Talk about importance of *order* of args, cmds to linker!
88 This file documents the GNU linker ld.
92 * Invocation:: Invocation
93 * Commands:: Command Language
95 * Machine Dependent:: Machine Dependent Features
99 * H8/300:: ld and the H8/300
102 * i960:: ld and the Intel 960 family
105 @ifclear SingleFormat
108 @c Following blank line required for remaining bug in makeinfo conds/menus
110 * MRI:: MRI Compatible Script Files
119 @cindex what is this?
120 @code{ld} combines a number of object and archive files, relocates
121 their data and ties up symbol references. Usually the last step in
122 compiling a program is to run @code{ld}.
124 @code{ld} accepts Linker Command Language files written in
125 a superset of AT&T's Link Editor Command Language syntax,
126 to provide explicit and total control over the linking process.
128 @ifclear SingleFormat
129 This version of @code{ld} uses the general purpose BFD libraries
130 to operate on object files. This allows @code{ld} to read, combine, and
131 write object files in many different formats---for example, COFF or
132 @code{a.out}. Different formats may be linked together to produce any
133 available kind of object file. @xref{BFD}, for more information.
136 Aside from its flexibility, the GNU linker is more helpful than other
137 linkers in providing diagnostic information. Many linkers abandon
138 execution immediately upon encountering an error; whenever possible,
139 @code{ld} continues executing, allowing you to identify other errors
140 (or, in some cases, to get an output file in spite of the error).
145 The GNU linker @code{ld} is meant to cover a broad range of situations,
146 and to be as compatible as possible with other linkers. As a result,
147 you have many choices to control its behavior.
151 * Options:: Command Line Options
152 * Environment:: Environment Variables
156 @section Command Line Options
161 Here is a summary of the options you can use on the @code{ld} command
164 @c FIXME! -relax only avail h8/300, i960. Conditionals screwed in examples.
166 ld [ -o @var{output} ] @var{objfile}@dots{}
167 [ -A@var{architecture} ] [ -b @var{input-format} ] [ -Bstatic ]
168 [ -c @var{MRI-commandfile} ] [ -d | -dc | -dp ]
169 [ -defsym @var{symbol}=@var{expression} ]
170 [ -e @var{entry} ] [ -F ] [ -F @var{format} ]
171 [ -format @var{input-format} ] [ -g ] [ -G @var{size} ] [ -help ]
172 [ -i ] [ -l@var{archive} ] [ -L@var{searchdir} ] [ -M ]
173 [ -Map @var{mapfile} ] [ -m @var{emulation} ] [ -N | -n ]
174 [ -noinhibit-exec ] [ -oformat @var{output-format} ]
175 [ -R @var{filename} ] [ -relax ] [ -retain-symbols-file @var{filename} ]
176 [ -r | -Ur ] [ -S ] [ -s ] [ -sort-common ] [ -stats ]
177 [ -T @var{commandfile} ]
178 [ -Ttext @var{org} ] [ -Tdata @var{org} ]
179 [ -Tbss @var{org} ] [ -t ] [ -u @var{symbol}] [-V] [-v] [ -version ]
180 [ -warn-common ] [ -y @var{symbol} ] [ -X ] [-x ]
183 This plethora of command-line options may seem intimidating, but in
184 actual practice few of them are used in any particular context.
185 @cindex standard Unix system
186 For instance, a frequent use of @code{ld} is to link standard Unix
187 object files on a standard, supported Unix system. On such a system, to
188 link a file @code{hello.o}:
191 ld -o @var{output} /lib/crt0.o hello.o -lc
194 This tells @code{ld} to produce a file called @var{output} as the
195 result of linking the file @code{/lib/crt0.o} with @code{hello.o} and
196 the library @code{libc.a}, which will come from the standard search
197 directories. (See the discussion of the @samp{-l} option below.)
199 The command-line options to @code{ld} may be specified in any order, and
200 may be repeated at will. Repeating most options with a
201 different argument will either have no further effect, or override prior
202 occurrences (those further to the left on the command line) of that
205 @ifclear SingleFormat
206 The exceptions---which may meaningfully be used more than once---are
207 @samp{-A}, @samp{-b} (or its synonym @samp{-format}), @samp{-defsym},
208 @samp{-L}, @samp{-l}, @samp{-R}, and @samp{-u}.
211 The exceptions---which may meaningfully be used more than once---are
212 @samp{-A}, @samp{-defsym}, @samp{-L}, @samp{-l}, @samp{-R}, and @samp{-u}.
216 The list of object files to be linked together, shown as @var{objfile}@dots{},
217 may follow, precede, or be mixed in with command-line options, except that
218 an @var{objfile} argument may not be placed between an option and
221 Usually the linker is invoked with at least one object file, but you can
222 specify other forms of binary input files using @samp{-l}, @samp{-R},
223 and the script command language. If @emph{no} binary input files at all
224 are specified, the linker does not produce any output, and issues the
225 message @samp{No input files}.
227 For options whose names are a single letter,
228 option arguments must either follow the option letter without intervening
229 whitespace, or be given as separate arguments immediately following the
230 option that requires them.
232 For options whose names are multiple letters, either one dash or two can
233 precede the option name; for example, @samp{--oformat} and
234 @samp{-oformat} are equivalent. Arguments to multiple-letter options
235 must either be separated from the option name by an equals sign, or be
236 given as separate arguments immediately following the option that
237 requires them. For example, @samp{--oformat srec} and
238 @samp{--oformat=srec} are equivalent. Unique abbreviations of the names
239 of multiple-letter options are accepted.
243 @cindex architectures
245 @item -A@var{architecture}
246 In the current release of @code{ld}, this option is useful only for the
247 Intel 960 family of architectures. In that @code{ld} configuration, the
248 @var{architecture} argument identifies the particular architecture in
249 the 960 family, enabling some safeguards and modifying the
250 archive-library search path. @xref{i960,,@code{ld} and the Intel 960
251 family}, for details.
253 Future releases of @code{ld} may support similar functionality for
254 other architecture families.
257 @ifclear SingleFormat
258 @cindex binary input format
259 @kindex -b @var{format}
261 @item -b @var{input-format}
263 @code{ld} may be configured to support more than one kind of object
264 file. If your @code{ld} is configured this way, you can use the
265 @samp{-b} option to specify the binary format for input object files
266 that follow this option on the command line. Even when @code{ld} is
267 configured to support alternative object formats, you don't usually need
268 to specify this, as @code{ld} should be configured to expect as a
269 default input format the most usual format on each machine.
270 @var{input-format} is a text string, the name of a particular format
271 supported by the BFD libraries. (You can list the available binary
272 formats with @samp{objdump -i}.) @w{@samp{-format @var{input-format}}}
273 has the same effect, as does the script command @code{TARGET}.
276 You may want to use this option if you are linking files with an unusual
277 binary format. You can also use @samp{-b} to switch formats explicitly (when
278 linking object files of different formats), by including
279 @samp{-b @var{input-format}} before each group of object files in a
282 The default format is taken from the environment variable
287 You can also define the input
288 format from a script, using the command @code{TARGET}; see @ref{Option
294 Ignored. This option is accepted for command-line compatibility with
297 @kindex -c @var{MRI-cmdfile}
298 @cindex compatibility, MRI
299 @item -c @var{MRI-commandfile}
300 For compatibility with linkers produced by MRI, @code{ld} accepts script
301 files written in an alternate, restricted command language, described in
302 @ref{MRI,,MRI Compatible Script Files}. Introduce MRI script files with
303 the option @samp{-c}; use the @samp{-T} option to run linker
304 scripts written in the general-purpose @code{ld} scripting language.
305 If @var{MRI-cmdfile} does not exist, @code{ld} looks for it in the directories
306 specified by any @samp{-L} options.
308 @cindex common allocation
315 These three options are equivalent; multiple forms are supported for
316 compatibility with other linkers. They
317 assign space to common symbols even if a relocatable output file is
318 specified (with @samp{-r}). The script command
319 @code{FORCE_COMMON_ALLOCATION} has the same effect. @xref{Option
322 @cindex symbols, from command line
323 @kindex -defsym @var{symbol}=@var{exp}
324 @item -defsym @var{symbol}=@var{expression}
325 Create a global symbol in the output file, containing the absolute
326 address given by @var{expression}. You may use this option as many
327 times as necessary to define multiple symbols in the command line. A
328 limited form of arithmetic is supported for the @var{expression} in this
329 context: you may give a hexadecimal constant or the name of an existing
330 symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
331 constants or symbols. If you need more elaborate expressions, consider
332 using the linker command language from a script (@pxref{Assignment, ,
333 Assignment: Symbol Definitions}). @emph{Note:} there should be no
334 white space between @var{symbol}, the equals sign (``@key{=}''), and
337 @cindex entry point, from command line
338 @kindex -e @var{entry}
340 Use @var{entry} as the explicit symbol for beginning execution of your
341 program, rather than the default entry point. @xref{Entry Point}, for a
342 discussion of defaults and other ways of specifying the
345 @ifclear SingleFormat
348 @itemx -F@var{format}
349 Ignored. Some older linkers used this option throughout a compilation
350 toolchain for specifying object-file format for both input and output
351 object files. The mechanisms @code{ld} uses for this purpose (the
352 @samp{-b} or @samp{-format} options for input files, @samp{-oformat}
353 option or the @code{TARGET} command in linker scripts for output files,
354 the @code{GNUTARGET} environment variable) are more flexible, but
355 @code{ld} accepts the @samp{-F} option for compatibility with scripts
356 written to call the old linker.
359 @item -format @var{input-format}
360 Synonym for @samp{-b @var{input-format}}.
365 Ignored. Provided for compatibility with other tools.
370 @itemx -G @var{value}
371 Set the maximum size of objects to be optimized using the GP register to
372 @var{size} under MIPS ECOFF. Ignored for other object file formats.
378 Print a summary of the command-line options on the standard output and exit.
381 @cindex incremental link
383 Perform an incremental link (same as option @samp{-r}).
385 @cindex archive files, from cmd line
386 @kindex -l@var{archive}
388 Add archive file @var{archive} to the list of files to link. This
389 option may be used any number of times. @code{ld} will search its
390 path-list for occurrences of @code{lib@var{ar}.a} for every @var{archive}
393 @cindex search directory, from cmd line
395 @item -L@var{searchdir}
396 @itemx -L @var{searchdir}
397 Add path @var{searchdir} to the list of paths that @code{ld} will search
398 for archive libraries and @code{ld} control scripts. You may use this
399 option any number of times.
402 The default set of paths searched (without being specified with
403 @samp{-L}) depends on which emulation mode @code{ld} is using, and in
404 some cases also on how it was configured. @xref{Environment}.
407 The paths can also be specified in a link script with the
408 @code{SEARCH_DIR} command.
413 Print (to the standard output) a link map---diagnostic information
414 about where symbols are mapped by @code{ld}, and information on global
415 common storage allocation.
419 @item -Map @var{mapfile}
420 Print to the file @var{mapfile} a link map---diagnostic information
421 about where symbols are mapped by @code{ld}, and information on global
422 common storage allocation.
425 @kindex -m @var{emulation}
426 @item -m@var{emulation}
427 @itemx -m @var{emulation}
428 Emulate the @var{emulation} linker. You can list the available
429 emulations with the @samp{-V} option. The
430 default depends on how your @code{ld} was configured.
433 @cindex read/write from cmd line
436 Set the text and data sections to be readable and writable. Also, do
437 not page-align the data segment. If the output format supports Unix
438 style magic numbers, mark the output as @code{OMAGIC}.
441 @cindex read-only text
444 Set the text segment to be read only, and mark the output as
445 @code{NMAGIC} if possible.
447 @item -noinhibit-exec
448 @cindex output file after errors
449 @kindex -noinhibit-exec
450 Retain the executable output file whenever it is still usable.
451 Normally, the linker will not produce an output file if it encounters
452 errors during the link process; it exits without writing an output file
453 when it issues any error whatsoever.
455 @item -o @var{output}
456 @kindex -o @var{output}
457 @cindex naming the output file
458 Use @var{output} as the name for the program produced by @code{ld}; if this
459 option is not specified, the name @file{a.out} is used by default. The
460 script command @code{OUTPUT} can also specify the output file name.
462 @ifclear SingleFormat
464 @item -oformat @var{output-format}
465 @code{ld} may be configured to support more than one kind of object
466 file. If your @code{ld} is configured this way, you can use the
467 @samp{-oformat} option to specify the binary format for the output
468 object file. Even when @code{ld} is configured to support alternative
469 object formats, you don't usually need to specify this, as @code{ld}
470 should be configured to produce as a default output format the most
471 usual format on each machine. @var{output-format} is a text string, the
472 name of a particular format supported by the BFD libraries. (You can
473 list the available binary formats with @samp{objdump -i}.) The script
474 command @code{OUTPUT_FORMAT} can also specify the output format, but
475 this option overrides it. @xref{BFD}.
478 @item -R @var{filename}
479 @kindex -R @var{file}
480 @cindex symbol-only input
481 Read symbol names and their addresses from @var{filename}, but do not
482 relocate it or include it in the output. This allows your output file
483 to refer symbolically to absolute locations of memory defined in other
487 @cindex synthesizing linker
488 @cindex relaxing addressing modes
490 An option with machine dependent effects.
492 Currently this option is only supported on the H8/300 and the Intel 960.
495 @xref{H8/300,,@code{ld} and the H8/300}.
498 @xref{i960,, @code{ld} and the Intel 960 family}.
501 On some platforms, the @samp{-relax} option performs global optimizations that
502 become possible when the linker resolves addressing in the program, such
503 as relaxing address modes and synthesizing new instructions in the
507 On platforms where this is not supported, @samp{-relax} is accepted, but
511 @item -retain-symbols-file @var{filename}
512 @cindex retaining specified symbols
513 @cindex stripping all but some symbols
514 @cindex symbols, retaining selectively
515 Retain @emph{only} the symbols listed in the file @var{filename},
516 discarding all others. @var{filename} is simply a flat file, with one
517 symbol name per line. This option is especially useful in environments
521 where a large global symbol table is accumulated gradually, to conserve
524 @samp{-retain-symbols-file} does @emph{not} discard undefined symbols,
525 or symbols needed for relocations.
527 You may only specify @samp{-retain-symbols-file} once in the command
528 line. It overrides @samp{-s} and @samp{-S}.
531 @cindex relocatable output
534 Generate relocatable output---i.e., generate an output file that can in
535 turn serve as input to @code{ld}. This is often called @dfn{partial
536 linking}. As a side effect, in environments that support standard Unix
537 magic numbers, this option also sets the output file's magic number to
540 If this option is not specified, an absolute file is produced. When
541 linking C++ programs, this option @emph{will not} resolve references to
542 constructors; to do that, use @samp{-Ur}.
544 This option does the same thing as @samp{-i}.
547 @cindex strip debugger symbols
549 Omit debugger symbol information (but not all symbols) from the output file.
552 @cindex strip all symbols
554 Omit all symbol information from the output file.
557 Normally, when @code{ld} places the global common symbols in the
558 appropriate output sections, it sorts them by size. First come all the
559 one byte symbols, then all the two bytes, then all the four bytes, and
560 then everything else. This is to prevent gaps between symbols due to
561 alignment constraints. This option disables that sorting.
564 Compute and display statistics about the operation of the linker,
565 such as execution time and memory usage.
567 @item -Tbss @var{org}
568 @kindex -Tbss @var{org}
569 @itemx -Tdata @var{org}
570 @kindex -Tdata @var{org}
571 @itemx -Ttext @var{org}
572 @kindex -Ttext @var{org}
573 @cindex segment origins, cmd line
574 Use @var{org} as the starting address for---respectively---the
575 @code{bss}, @code{data}, or the @code{text} segment of the output file.
576 @var{org} must be a single hexadecimal integer;
577 for compatibility with other linkers, you may omit the leading
578 @samp{0x} usually associated with hexadecimal values.
580 @item -T @var{commandfile}
581 @itemx -T@var{commandfile}
582 @kindex -T @var{script}
584 Read link commands from the file @var{commandfile}. These commands
585 replace @code{ld}'s default link script (rather than adding
586 to it), so @var{commandfile} must specify everything necessary to describe
587 the target format. @xref{Commands}. If @var{commandfile} does not
588 exist, @code{ld} looks for it in the directories specified by any
589 preceding @samp{-L} options. Multiple @samp{-T} options accumulate.
593 @cindex input files, displaying
595 Print the names of the input files as @code{ld} processes them.
597 @item -u @var{symbol}
598 @kindex -u @var{symbol}
599 @cindex undefined symbol
600 Force @var{symbol} to be entered in the output file as an undefined symbol.
601 Doing this may, for example, trigger linking of additional modules from
602 standard libraries. @samp{-u} may be repeated with different option
603 arguments to enter additional undefined symbols.
604 @c Nice idea, but no such command: This option is equivalent
605 @c to the @code{EXTERN} linker command.
610 For anything other than C++ programs, this option is equivalent to
611 @samp{-r}: it generates relocatable output---i.e., an output file that can in
612 turn serve as input to @code{ld}. When linking C++ programs, @samp{-Ur}
613 @emph{does} resolve references to constructors, unlike @samp{-r}.
614 It does not work to use @samp{-Ur} on files that were themselves linked
615 with @samp{-Ur}; once the constructor table has been built, it cannot
616 be added to. Use @samp{-Ur} only for the last partial link, and
617 @samp{-r} for the others.
622 Display the version number for @code{ld} and list the linker emulations
623 supported. Display which input files can and cannot be opened.
628 Display the version number for @code{ld}.
632 Display the version number for @code{ld} and exit.
636 @cindex warnings, on combining symbols
637 @cindex combining symbols, warnings on
638 Warn when a common symbol is combined with another common symbol or with
639 a symbol definition. Unix linkers allow this somewhat sloppy practice,
640 but linkers on some other operating systems do not. This option allows
641 you to find potential problems from combining global symbols.
642 Unfortunately, some C libraries use this practice, so you may get some
643 warnings about symbols in the libraries as well as in your programs.
645 There are three kinds of global symbols, illustrated here by C examples:
649 A definition, which goes in the initialized data section of the output
653 An undefined reference, which does not allocate space.
654 There must be either a definition or a common symbol for the
658 A common symbol. If there are only (one or more) common symbols for a
659 variable, it goes in the uninitialized data area of the output file.
660 The linker merges multiple common symbols for the same variable into a
661 single symbol. If they are of different sizes, it picks the largest
662 size. The linker turns a common symbol into a declaration, if there is
663 a definition of the same variable.
666 The @samp{-warn-common} option can produce five kinds of warnings. Each
667 warning consists of a pair of lines: the first describes the symbol just
668 encountered, and the second describes the previous symbol encountered
669 with the same name. One or both of the two symbols will be a common
674 Turning a common symbol into a reference, because there is already a
675 definition for the symbol.
677 @var{file}(@var{section}): warning: common of `@var{symbol}'
678 overridden by definition
679 @var{file}(@var{section}): warning: defined here
683 Turning a common symbol into a reference, because a later definition for
684 the symbol is encountered. This is the same as the previous case,
685 except that the symbols are encountered in a different order.
687 @var{file}(@var{section}): warning: definition of `@var{symbol}'
689 @var{file}(@var{section}): warning: common is here
693 Merging a common symbol with a previous same-sized common symbol.
695 @var{file}(@var{section}): warning: multiple common
697 @var{file}(@var{section}): warning: previous common is here
701 Merging a common symbol with a previous larger common symbol.
703 @var{file}(@var{section}): warning: common of `@var{symbol}'
704 overridden by larger common
705 @var{file}(@var{section}): warning: larger common is here
709 Merging a common symbol with a previous smaller common symbol. This is
710 the same as the previous case, except that the symbols are
711 encountered in a different order.
713 @var{file}(@var{section}): warning: common of `@var{symbol}'
714 overriding smaller common
715 @var{file}(@var{section}): warning: smaller common is here
720 @cindex local symbols, deleting
721 @cindex L, deleting symbols beginning
723 If @samp{-s} or @samp{-S} is also specified, delete only local symbols
724 beginning with @samp{L}.
727 @cindex deleting local symbols
729 If @samp{-s} or @samp{-S} is also specified, delete all local symbols,
730 not just those beginning with @samp{L}.
732 @item -y @var{symbol}
733 @kindex -y @var{symbol}
734 @cindex symbol tracing
735 Print the name of each linked file in which @var{symbol} appears. This
736 option may be given any number of times. On many systems it is necessary
737 to prepend an underscore.
739 This option is useful when you have an undefined symbol in your link but
740 don't know where the reference is coming from.
745 @section Environment Variables
747 You can change the behavior of @code{ld} with the environment
748 variable @code{GNUTARGET}.
751 @cindex default input format
752 @code{GNUTARGET} determines the input-file object format if you don't
753 use @samp{-b} (or its synonym @samp{-format}). Its value should be one
754 of the BFD names for an input format (@pxref{BFD}). If there is no
755 @code{GNUTARGET} in the environment, @code{ld} uses the natural format
756 of the target. If @code{GNUTARGET} is set to @code{default} then BFD attempts to discover the
757 input format by examining binary input files; this method often
758 succeeds, but there are potential ambiguities, since there is no method
759 of ensuring that the magic number used to specify object-file formats is
760 unique. However, the configuration procedure for BFD on each system
761 places the conventional format for that system first in the search-list,
762 so ambiguities are resolved in favor of convention.
766 @chapter Command Language
768 @cindex command files
769 The command language provides explicit control over the link process,
770 allowing complete specification of the mapping between the linker's
771 input files and its output. It controls:
780 addresses of sections
782 placement of common blocks
785 You may supply a command file (also known as a link script) to the
786 linker either explicitly through the @samp{-T} option, or implicitly as
787 an ordinary file. If the linker opens a file which it cannot recognize
788 as a supported object or archive format, it reports an error.
791 * Scripts:: Linker Scripts
792 * Expressions:: Expressions
793 * MEMORY:: MEMORY Command
794 * SECTIONS:: SECTIONS Command
795 * Entry Point:: The Entry Point
796 * Option Commands:: Option Commands
800 @section Linker Scripts
801 The @code{ld} command language is a collection of statements; some are
802 simple keywords setting a particular option, some are used to select and
803 group input files or name output files; and two statement
804 types have a fundamental and pervasive impact on the linking process.
806 @cindex fundamental script commands
807 @cindex commands, fundamental
808 @cindex output file layout
809 @cindex layout of output file
810 The most fundamental command of the @code{ld} command language is the
811 @code{SECTIONS} command (@pxref{SECTIONS}). Every meaningful command
812 script must have a @code{SECTIONS} command: it specifies a
813 ``picture'' of the output file's layout, in varying degrees of detail.
814 No other command is required in all cases.
816 The @code{MEMORY} command complements @code{SECTIONS} by describing the
817 available memory in the target architecture. This command is optional;
818 if you don't use a @code{MEMORY} command, @code{ld} assumes sufficient
819 memory is available in a contiguous block for all output.
823 You may include comments in linker scripts just as in C: delimited
824 by @samp{/*} and @samp{*/}. As in C, comments are syntactically
825 equivalent to whitespace.
829 @cindex expression syntax
831 Many useful commands involve arithmetic expressions. The syntax for
832 expressions in the command language is identical to that of C
833 expressions, with the following features:
836 All expressions evaluated as integers and
837 are of ``long'' or ``unsigned long'' type.
839 All constants are integers.
841 All of the C arithmetic operators are provided.
843 You may reference, define, and create global variables.
845 You may call special purpose built-in functions.
849 * Integers:: Integers
850 * Symbols:: Symbol Names
851 * Location Counter:: The Location Counter
852 * Operators:: Operators
853 * Evaluation:: Evaluation
854 * Assignment:: Assignment: Defining Symbols
855 * Arithmetic Functions:: Built-In Functions
860 @cindex integer notation
861 @cindex octal integers
862 An octal integer is @samp{0} followed by zero or more of the octal
863 digits (@samp{01234567}).
868 @cindex decimal integers
869 A decimal integer starts with a non-zero digit followed by zero or
870 more digits (@samp{0123456789}).
875 @cindex hexadecimal integers
877 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
878 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
883 @cindex negative integers
884 To write a negative integer, use
885 the prefix operator @samp{-}; @pxref{Operators}.
890 @cindex scaled integers
891 @cindex K and M integer suffixes
892 @cindex M and K integer suffixes
893 @cindex suffixes for integers
894 @cindex integer suffixes
895 Additionally the suffixes @code{K} and @code{M} may be used to scale a
899 @c END TEXI2ROFF-KILL
900 @code{1024} or @code{1024*1024}
904 ${\rm 1024}$ or ${\rm 1024}^2$
906 @c END TEXI2ROFF-KILL
907 respectively. For example, the following all refer to the same quantity:
916 @subsection Symbol Names
919 @cindex quoted symbol names
921 Unless quoted, symbol names start with a letter, underscore, or point
922 and may include any letters, underscores, digits, points,
923 and hyphens. Unquoted symbol names must not conflict with any
924 keywords. You can specify a symbol which contains odd characters or has
925 the same name as a keyword, by surrounding the symbol name in double quotes:
928 "with a space" = "also with a space" + 10;
931 Since symbols can contain many non-alphabetic characters, it is safest
932 to delimit symbols with spaces. For example, @samp{A-B} is one symbol,
933 whereas @samp{A - B} is an expression involving subtraction.
935 @node Location Counter
936 @subsection The Location Counter
939 @cindex location counter
940 @cindex current output location
941 The special linker variable @dfn{dot} @samp{.} always contains the
942 current output location counter. Since the @code{.} always refers to
943 a location in an output section, it must always appear in an
944 expression within a @code{SECTIONS} command. The @code{.} symbol
945 may appear anywhere that an ordinary symbol is allowed in an
946 expression, but its assignments have a side effect. Assigning a value
947 to the @code{.} symbol will cause the location counter to be moved.
949 This may be used to create holes in the output section. The location
950 counter may never be moved backwards.
965 In the previous example, @code{file1} is located at the beginning of the
966 output section, then there is a 1000 byte gap. Then @code{file2}
967 appears, also with a 1000 byte gap following before @code{file3} is
968 loaded. The notation @samp{= 0x1234} specifies what data to write in
969 the gaps (@pxref{Section Options}).
977 @subsection Operators
978 @cindex Operators for arithmetic
979 @cindex arithmetic operators
980 @cindex precedence in expressions
981 The linker recognizes the standard C set of arithmetic operators, with
982 the standard bindings and precedence levels:
985 @c END TEXI2ROFF-KILL
987 precedence associativity Operators Notes
993 5 left == != > < <= >=
999 11 right &= += -= *= /= (2)
1003 (1) Prefix operators
1004 (2) @xref{Assignment}
1008 \vskip \baselineskip
1009 %"lispnarrowing" is the extra indent used generally for @example
1010 \hskip\lispnarrowing\vbox{\offinterlineskip
1013 {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr
1014 height2pt&\omit&&\omit&&\omit&\cr
1015 &Precedence&& Associativity &&{\rm Operators}&\cr
1016 height2pt&\omit&&\omit&&\omit&\cr
1018 height2pt&\omit&&\omit&&\omit&\cr
1020 % '176 is tilde, '~' in tt font
1021 &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr
1022 &2&&left&&* / \%&\cr
1025 &5&&left&&== != > < <= >=&\cr
1028 &8&&left&&{\&\&}&\cr
1031 &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr
1033 height2pt&\omit&&\omit&&\omit&\cr}
1038 @obeylines@parskip=0pt@parindent=0pt
1039 @dag@quad Prefix operators.
1040 @ddag@quad @xref{Assignment}.
1043 @c END TEXI2ROFF-KILL
1046 @subsection Evaluation
1048 @cindex lazy evaluation
1049 @cindex expression evaluation order
1050 The linker uses ``lazy evaluation'' for expressions; it only calculates
1051 an expression when absolutely necessary. The linker needs the value of
1052 the start address, and the lengths of memory regions, in order to do any
1053 linking at all; these values are computed as soon as possible when the
1054 linker reads in the command file. However, other values (such as symbol
1055 values) are not known or needed until after storage allocation. Such
1056 values are evaluated later, when other information (such as the sizes of
1057 output sections) is available for use in the symbol assignment
1061 @subsection Assignment: Defining Symbols
1062 @cindex assignment in scripts
1063 @cindex symbol definition, scripts
1064 @cindex variables, defining
1065 You may create global symbols, and assign values (addresses) to global
1066 symbols, using any of the C assignment operators:
1069 @item @var{symbol} = @var{expression} ;
1070 @itemx @var{symbol} &= @var{expression} ;
1071 @itemx @var{symbol} += @var{expression} ;
1072 @itemx @var{symbol} -= @var{expression} ;
1073 @itemx @var{symbol} *= @var{expression} ;
1074 @itemx @var{symbol} /= @var{expression} ;
1077 Two things distinguish assignment from other operators in @code{ld}
1081 Assignment may only be used at the root of an expression;
1082 @samp{a=b+3;} is allowed, but @samp{a+b=3;} is an error.
1087 You must place a trailing semicolon (``@key{;}'') at the end of an
1088 assignment statement.
1091 Assignment statements may appear:
1094 as commands in their own right in an @code{ld} script; or
1096 as independent statements within a @code{SECTIONS} command; or
1098 as part of the contents of a section definition in a
1099 @code{SECTIONS} command.
1102 The first two cases are equivalent in effect---both define a symbol with
1103 an absolute address. The last case defines a symbol whose address is
1104 relative to a particular section (@pxref{SECTIONS}).
1106 @cindex absolute and relocatable symbols
1107 @cindex relocatable and absolute symbols
1108 @cindex symbols, relocatable and absolute
1109 When a linker expression is evaluated and assigned to a variable, it is
1110 given either an absolute or a relocatable type. An absolute expression
1111 type is one in which the symbol contains the value that it will have in
1112 the output file; a relocatable expression type is one in which the
1113 value is expressed as a fixed offset from the base of a section.
1115 The type of the expression is controlled by its position in the script
1116 file. A symbol assigned within a section definition is created relative
1117 to the base of the section; a symbol assigned in any other place is
1118 created as an absolute symbol. Since a symbol created within a
1119 section definition is relative to the base of the section, it
1120 will remain relocatable if relocatable output is requested. A symbol
1121 may be created with an absolute value even when assigned to within a
1122 section definition by using the absolute assignment function
1123 @code{ABSOLUTE}. For example, to create an absolute symbol whose address
1124 is the last byte of an output section named @code{.data}:
1130 _edata = ABSOLUTE(.) ;
1135 The linker tries to put off the evaluation of an assignment until all
1136 the terms in the source expression are known (@pxref{Evaluation}). For
1137 instance, the sizes of sections cannot be known until after allocation,
1138 so assignments dependent upon these are not performed until after
1139 allocation. Some expressions, such as those depending upon the location
1140 counter @dfn{dot}, @samp{.} must be evaluated during allocation. If the
1141 result of an expression is required, but the value is not available,
1142 then an error results. For example, a script like the following
1145 text 9+this_isnt_constant :
1150 @kindex Non constant expression
1152 will cause the error message ``@code{Non constant expression for initial
1155 @node Arithmetic Functions
1156 @subsection Arithmetic Functions
1157 @cindex functions in expression language
1158 The command language includes a number of built-in
1159 functions for use in link script expressions.
1161 @item ABSOLUTE(@var{exp})
1162 @kindex ABSOLUTE(@var{exp})
1163 @cindex expression, absolute
1164 Return the absolute (non-relocatable, as opposed to non-negative) value
1165 of the expression @var{exp}. Primarily useful to assign an absolute
1166 value to a symbol within a section definition, where symbol values are
1167 normally section-relative.
1169 @item ADDR(@var{section})
1170 @kindex ADDR(@var{section})
1171 @cindex section address
1172 Return the absolute address of the named @var{section}. Your script must
1173 previously have defined the location of that section. In the following
1174 example, @code{symbol_1} and @code{symbol_2} are assigned identical
1180 start_of_output_1 = ABSOLUTE(.);
1185 symbol_1 = ADDR(.output1);
1186 symbol_2 = start_of_output_1;
1191 @item ALIGN(@var{exp})
1192 @kindex ALIGN(@var{exp})
1193 @cindex rounding up location counter
1194 Return the result of the current location counter (@code{.}) aligned to
1195 the next @var{exp} boundary. @var{exp} must be an expression whose
1196 value is a power of two. This is equivalent to
1198 (. + @var{exp} - 1) & ~(@var{exp} - 1)
1201 @code{ALIGN} doesn't change the value of the location counter---it just
1202 does arithmetic on it. As an example, to align the output @code{.data}
1203 section to the next @code{0x2000} byte boundary after the preceding
1204 section and to set a variable within the section to the next
1205 @code{0x8000} boundary after the input sections:
1208 .data ALIGN(0x2000): @{
1210 variable = ALIGN(0x8000);
1215 The first use of @code{ALIGN} in this example specifies the location of
1216 a section because it is used as the optional @var{start} attribute of a
1217 section definition (@pxref{Section Options}). The second use simply
1218 defines the value of a variable.
1220 The built-in @code{NEXT} is closely related to @code{ALIGN}.
1222 @item DEFINED(@var{symbol})
1223 @kindex DEFINED(@var{symbol})
1224 @cindex symbol defaults
1225 Return 1 if @var{symbol} is in the linker global symbol table and is
1226 defined, otherwise return 0. You can use this function to provide default
1227 values for symbols. For example, the following command-file fragment shows how
1228 to set a global symbol @code{begin} to the first location in the
1229 @code{.text} section---but if a symbol called @code{begin} already
1230 existed, its value is preserved:
1235 begin = DEFINED(begin) ? begin : . ;
1241 @item NEXT(@var{exp})
1242 @kindex NEXT(@var{exp})
1243 @cindex unallocated address, next
1244 Return the next unallocated address that is a multiple of @var{exp}.
1245 This function is closely related to @code{ALIGN(@var{exp})}; unless you
1246 use the @code{MEMORY} command to define discontinuous memory for the
1247 output file, the two functions are equivalent.
1249 @item SIZEOF(@var{section})
1250 @kindex SIZEOF(@var{section})
1251 @cindex section size
1252 Return the size in bytes of the named @var{section}, if that section has
1253 been allocated. In the following example, @code{symbol_1} and
1254 @code{symbol_2} are assigned identical values:
1255 @c What does it return if the section hasn't been allocated? 0?
1263 symbol_1 = .end - .start ;
1264 symbol_2 = SIZEOF(.output);
1269 @item SIZEOF_HEADERS
1270 @kindex SIZEOF_HEADERS
1272 @itemx sizeof_headers
1273 @kindex sizeof_headers
1274 Return the size in bytes of the output file's headers. You can use this number
1275 as the start address of the first section, if you choose, to facilitate
1281 @section Memory Layout
1283 @cindex regions of memory
1284 @cindex discontinuous memory
1285 @cindex allocating memory
1286 The linker's default configuration permits allocation of all available memory.
1287 You can override this configuration by using the @code{MEMORY} command. The
1288 @code{MEMORY} command describes the location and size of blocks of
1289 memory in the target. By using it carefully, you can describe which
1290 memory regions may be used by the linker, and which memory regions it
1291 must avoid. The linker does not shuffle sections to fit into the
1292 available regions, but does move the requested sections into the correct
1293 regions and issue errors when the regions become too full.
1295 A command file may contain at most one use of the @code{MEMORY}
1296 command; however, you can define as many blocks of memory within it as
1297 you wish. The syntax is:
1302 @var{name} (@var{attr}) : ORIGIN = @var{origin}, LENGTH = @var{len}
1307 @cindex naming memory regions
1309 is a name used internally by the linker to refer to the region. Any
1310 symbol name may be used. The region names are stored in a separate
1311 name space, and will not conflict with symbols, file names or section
1312 names. Use distinct names to specify multiple regions.
1314 @cindex memory region attributes
1316 is an optional list of attributes, permitted for compatibility with the
1317 AT&T linker but not used by @code{ld} beyond checking that the
1318 attribute list is valid. Valid attribute lists must be made up of the
1319 characters ``@code{LIRWX}''. If you omit the attribute list, you may
1320 omit the parentheses around it as well.
1326 is the start address of the region in physical memory. It is
1327 an expression that must evaluate to a constant before
1328 memory allocation is performed. The keyword @code{ORIGIN} may be
1329 abbreviated to @code{org} or @code{o} (but not, for example, @samp{ORG}).
1335 is the size in bytes of the region (an expression).
1336 The keyword @code{LENGTH} may be abbreviated to @code{len} or @code{l}.
1339 For example, to specify that memory has two regions available for
1340 allocation---one starting at 0 for 256 kilobytes, and the other
1341 starting at @code{0x40000000} for four megabytes:
1346 rom : ORIGIN = 0, LENGTH = 256K
1347 ram : org = 0x40000000, l = 4M
1351 Once you have defined a region of memory named @var{mem}, you can direct
1352 specific output sections there by using a command ending in
1353 @samp{>@var{mem}} within the @code{SECTIONS} command (@pxref{Section
1354 Options}). If the combined output sections directed to a region are too
1355 big for the region, the linker will issue an error message.
1358 @section Specifying Output Sections
1361 The @code{SECTIONS} command controls exactly where input sections are
1362 placed into output sections, their order in the output file, and to
1363 which output sections they are allocated.
1365 You may use at most one @code{SECTIONS} command in a script file,
1366 but you can have as many statements within it as you wish. Statements
1367 within the @code{SECTIONS} command can do one of three things:
1371 define the entry point;
1374 assign a value to a symbol;
1377 describe the placement of a named output section, and which input
1378 sections go into it.
1381 You can also use the first two operations---defining the entry point and
1382 defining symbols---outside the @code{SECTIONS} command: @pxref{Entry
1383 Point}, and @pxref{Assignment}. They are permitted here as well for
1384 your convenience in reading the script, so that symbols and the entry
1385 point can be defined at meaningful points in your output-file layout.
1387 If you do not use a @code{SECTIONS} command, the linker places each input
1388 section into an identically named output section in the order that the
1389 sections are first encountered in the input files. If all input sections
1390 are present in the first file, for example, the order of sections in the
1391 output file will match the order in the first input file.
1394 * Section Definition:: Section Definitions
1395 * Section Placement:: Section Placement
1396 * Section Data Expressions:: Section Data Expressions
1397 * Section Options:: Optional Section Attributes
1400 @node Section Definition
1401 @subsection Section Definitions
1402 @cindex section definition
1403 The most frequently used statement in the @code{SECTIONS} command is
1404 the @dfn{section definition}, which specifies the
1405 properties of an output section: its location, alignment, contents,
1406 fill pattern, and target memory region. Most of
1407 these specifications are optional; the simplest form of a section
1416 @cindex naming output sections
1418 @var{secname} is the name of the output section, and @var{contents} a
1419 specification of what goes there---for example, a list of input files or
1420 sections of input files (@pxref{Section Placement}). As you might
1421 assume, the whitespace shown is optional. You do need the colon
1422 @samp{:} and the braces @samp{@{@}}, however.
1424 @var{secname} must meet the constraints of your output format. In
1425 formats which only support a limited number of sections, such as
1426 @code{a.out}, the name must be one of the names supported by the format
1427 (@code{a.out}, for example, allows only @code{.text}, @code{.data} or
1428 @code{.bss}). If the output format supports any number of sections, but
1429 with numbers and not names (as is the case for Oasys), the name should be
1430 supplied as a quoted numeric string. A section name may consist of any
1431 sequence of characters, but any name which does not conform to the standard
1432 @code{ld} symbol name syntax must be quoted.
1433 @xref{Symbols, , Symbol Names}.
1435 @node Section Placement
1436 @subsection Section Placement
1438 @cindex contents of a section
1439 In a section definition, you can specify the contents of an output
1440 section by listing particular input files, by listing particular
1441 input-file sections, or by a combination of the two. You can also place
1442 arbitrary data in the section, and define symbols relative to the
1443 beginning of the section.
1445 The @var{contents} of a section definition may include any of the
1446 following kinds of statement. You can include as many of these as you
1447 like in a single section definition, separated from one another by
1451 @kindex @var{filename}
1452 @cindex input files, section defn
1453 @cindex files, including in output sections
1454 @item @var{filename}
1455 You may simply name a particular input file to be placed in the current
1456 output section; @emph{all} sections from that file are placed in the
1457 current section definition. If the file name has already been mentioned
1458 in another section definition, with an explicit section name list, then
1459 only those sections which have not yet been allocated are used.
1461 To specify a list of particular files by name:
1463 .data : @{ afile.o bfile.o cfile.o @}
1466 The example also illustrates that multiple statements can be included in
1467 the contents of a section definition, since each file name is a separate
1470 @kindex @var{filename}(@var{section})
1471 @cindex files and sections, section defn
1472 @item @var{filename}( @var{section} )
1473 @itemx @var{filename}( @var{section}, @var{section}, @dots{} )
1474 @itemx @var{filename}( @var{section} @var{section} @dots{} )
1475 You can name one or more sections from your input files, for
1476 insertion in the current output section. If you wish to specify a list
1477 of input-file sections inside the parentheses, you may separate the
1478 section names by either commas or whitespace.
1480 @cindex input sections to output section
1481 @kindex *(@var{section})
1482 @item * (@var{section})
1483 @itemx * (@var{section}, @var{section}, @dots{})
1484 @itemx * (@var{section} @var{section} @dots{})
1485 Instead of explicitly naming particular input files in a link control
1486 script, you can refer to @emph{all} files from the @code{ld} command
1487 line: use @samp{*} instead of a particular file name before the
1488 parenthesized input-file section list.
1490 If you have already explicitly included some files by name, @samp{*}
1491 refers to all @emph{remaining} files---those whose places in the output
1492 file have not yet been defined.
1494 For example, to copy sections @code{1} through @code{4} from an Oasys file
1495 into the @code{.text} section of an @code{a.out} file, and sections @code{13}
1496 and @code{14} into the @code{.data} section:
1509 @cindex @code{[@var{section}@dots{}]}, not supported
1510 @samp{[ @var{section} @dots{} ]} used to be accepted as an alternate way
1511 to specify named sections from all unallocated input files. Because
1512 some operating systems (VMS) allow brackets in file names, that notation
1513 is no longer supported.
1515 @cindex uninitialized data
1516 @cindex commons in output
1518 @item @var{filename}@code{( COMMON )}
1520 Specify where in your output file to place uninitialized data
1521 with this notation. @code{*(COMMON)} by itself refers to all
1522 uninitialized data from all input files (so far as it is not yet
1523 allocated); @var{filename}@code{(COMMON)} refers to uninitialized data
1524 from a particular file. Both are special cases of the general
1525 mechanisms for specifying where to place input-file sections:
1526 @code{ld} permits you to refer to uninitialized data as if it
1527 were in an input-file section named @code{COMMON}, regardless of the
1528 input file's format.
1531 For example, the following command script arranges the output file into
1532 three consecutive sections, named @code{.text}, @code{.data}, and
1533 @code{.bss}, taking the input for each from the correspondingly named
1534 sections of all the input files:
1538 .text : @{ *(.text) @}
1539 .data : @{ *(.data) @}
1540 .bss : @{ *(.bss) *(COMMON) @}
1544 The following example reads all of the sections from file @code{all.o}
1545 and places them at the start of output section @code{outputa} which
1546 starts at location @code{0x10000}. All of section @code{.input1} from
1547 file @code{foo.o} follows immediately, in the same output section. All
1548 of section @code{.input2} from @code{foo.o} goes into output section
1549 @code{outputb}, followed by section @code{.input1} from @code{foo1.o}.
1550 All of the remaining @code{.input1} and @code{.input2} sections from any
1551 files are written to output section @code{outputc}.
1573 @node Section Data Expressions
1574 @subsection Section Data Expressions
1576 @cindex expressions in a section
1577 The foregoing statements arrange, in your output file, data originating
1578 from your input files. You can also place data directly in an output
1579 section from the link command script. Most of these additional
1580 statements involve expressions; @pxref{Expressions}. Although these
1581 statements are shown separately here for ease of presentation, no such
1582 segregation is needed within a section definition in the @code{SECTIONS}
1583 command; you can intermix them freely with any of the statements we've
1587 @cindex input filename symbols
1588 @cindex filename symbols
1589 @kindex CREATE_OBJECT_SYMBOLS
1590 @item CREATE_OBJECT_SYMBOLS
1591 Create a symbol for each input file
1592 in the current section, set to the address of the first byte of
1593 data written from that input file. For instance, with @code{a.out}
1594 files it is conventional to have a symbol for each input file. You can
1595 accomplish this by defining the output @code{.text} section as follows:
1600 CREATE_OBJECT_SYMBOLS
1602 _etext = ALIGN(0x2000);
1608 If @code{sample.ld} is a file containing this script, and @code{a.o},
1609 @code{b.o}, @code{c.o}, and @code{d.o} are four input files with
1610 contents like the following---
1620 @samp{ld -M -T sample.ld a.o b.o c.o d.o} would create a map like this,
1621 containing symbols matching the object file names:
1623 00000000 A __DYNAMIC
1626 00002020 T _afunction
1629 00002038 T _bfunction
1632 00002050 T _cfunction
1635 00002068 T _dfunction
1645 @kindex @var{symbol} = @var{expression} ;
1646 @kindex @var{symbol} @var{f}= @var{expression} ;
1647 @item @var{symbol} = @var{expression} ;
1648 @itemx @var{symbol} @var{f}= @var{expression} ;
1649 @var{symbol} is any symbol name (@pxref{Symbols}). ``@var{f}=''
1650 refers to any of the operators @code{&= += -= *= /=} which combine
1651 arithmetic and assignment.
1653 @cindex assignment, in section defn
1654 When you assign a value to a symbol within a particular section
1655 definition, the value is relative to the beginning of the section
1656 (@pxref{Assignment}). If you write
1662 .data : @{ @dots{} rel = 14 ; @dots{} @}
1663 abs2 = 14 + ADDR(.data);
1668 @c FIXME: Try above example!
1670 @code{abs} and @code{rel} do not have the same value; @code{rel} has the
1671 same value as @code{abs2}.
1673 @kindex BYTE(@var{expression})
1674 @kindex SHORT(@var{expression})
1675 @kindex LONG(@var{expression})
1676 @kindex QUAD(@var{expression})
1677 @cindex direct output
1678 @item BYTE(@var{expression})
1679 @itemx SHORT(@var{expression})
1680 @itemx LONG(@var{expression})
1681 @itemx QUAD(@var{expression})
1682 By including one of these four statements in a section definition, you
1683 can explicitly place one, two, four, or eight bytes (respectively) at
1684 the current address of that section. @code{QUAD} is only supported when
1685 using a 64 bit host or target.
1687 @ifclear SingleFormat
1688 Multiple-byte quantities are represented in whatever byte order is
1689 appropriate for the output file format (@pxref{BFD}).
1692 @item FILL(@var{expression})
1693 @kindex FILL(@var{expression})
1694 @cindex holes, filling
1695 @cindex unspecified memory
1696 Specify the ``fill pattern'' for the current section. Any otherwise
1697 unspecified regions of memory within the section (for example, regions
1698 you skip over by assigning a new value to the location counter @samp{.})
1699 are filled with the two least significant bytes from the
1700 @var{expression} argument. A @code{FILL} statement covers memory
1701 locations @emph{after} the point it occurs in the section definition; by
1702 including more than one @code{FILL} statement, you can have different
1703 fill patterns in different parts of an output section.
1706 @node Section Options
1707 @subsection Optional Section Attributes
1708 @cindex section defn, full syntax
1709 Here is the full syntax of a section definition, including all the
1715 @var{secname} @var{start} BLOCK(@var{align}) (NOLOAD) : AT ( @var{ldadr} )
1716 @{ @var{contents} @} =@var{fill} >@var{region}
1721 @var{secname} and @var{contents} are required. @xref{Section
1722 Definition}, and @pxref{Section Placement} for details on
1723 @var{contents}. The remaining elements---@var{start},
1724 @code{BLOCK(@var{align)}}, @code{(NOLOAD)}, @code{AT ( @var{ldadr} )},
1725 @code{=@var{fill}}, and @code{>@var{region}}---are all optional.
1728 @cindex start address, section
1729 @cindex section start
1730 @cindex section address
1732 You can force the output section to be loaded at a specified address by
1733 specifying @var{start} immediately following the section name.
1734 @var{start} can be represented as any expression. The following
1735 example generates section @var{output} at location
1741 output 0x40000000: @{
1748 @kindex BLOCK(@var{align})
1749 @cindex section alignment
1750 @cindex aligning sections
1751 @item BLOCK(@var{align})
1752 You can include @code{BLOCK()} specification to advance
1753 the location counter @code{.} prior to the beginning of the section, so
1754 that the section will begin at the specified alignment. @var{align} is
1758 @cindex prevent unnecessary loading
1759 @cindex loading, preventing
1761 Use @samp{(NOLOAD)} to prevent a section from being loaded into memory
1762 each time it is accessed. For example, in the script sample below, the
1763 @code{ROM} segment is addressed at memory location @samp{0} and does not
1764 need to be loaded into each object file:
1768 ROM 0 (NOLOAD) : @{ @dots{} @}
1773 @kindex AT ( @var{ldadr} )
1774 @cindex specify load address
1775 @cindex load address, specifying
1776 @item AT ( @var{ldadr} )
1777 The expression @var{ldadr} that follows the @code{AT} keyword specifies
1778 the load address of the section. The default (if you do not use the
1779 @code{AT} keyword) is to make the load address the same as the
1780 relocation address. This feature is designed to make it easy to build a
1781 ROM image. For example, this @code{SECTIONS} definition creates two
1782 output sections: one called @samp{.text}, which starts at @code{0x1000},
1783 and one called @samp{.mdata}, which is loaded at the end of the
1784 @samp{.text} section even though its relocation address is
1785 @code{0x2000}. The symbol @code{_data} is defined with the value
1791 .text 0x1000 : @{ *(.text) _etext = . ; @}
1793 AT ( ADDR(.text) + SIZEOF ( .text ) )
1794 @{ _data = . ; *(.data); _edata = . ; @}
1796 @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@}
1800 The run-time initialization code (for C programs, usually @code{crt0})
1801 for use with a ROM generated this way has to include something like
1802 the following, to copy the initialized data from the ROM image to its runtime
1809 /* ROM has data at end of text; copy it. */
1810 while (dst < _edata) @{
1815 for (dst = _bstart; dst< _bend; dst++)
1820 @cindex section fill pattern
1821 @cindex fill pattern, entire section
1823 Including @code{=@var{fill}} in a section definition specifies the
1824 initial fill value for that section. You may use any expression to
1825 specify @var{fill}. Any unallocated holes in the current output section
1826 when written to the output file will be filled with the two least
1827 significant bytes of the value, repeated as necessary. You can also
1828 change the fill value with a @code{FILL} statement in the @var{contents}
1829 of a section definition.
1831 @kindex >@var{region}
1832 @cindex section, assigning to memory region
1833 @cindex memory regions and sections
1835 Assign this section to a previously defined region of memory.
1841 @section The Entry Point
1842 @kindex ENTRY(@var{symbol})
1843 @cindex start of execution
1844 @cindex first instruction
1845 The linker command language includes a command specifically for
1846 defining the first executable instruction in an output file (its
1847 @dfn{entry point}). Its argument is a symbol name:
1852 Like symbol assignments, the @code{ENTRY} command may be placed either
1853 as an independent command in the command file, or among the section
1854 definitions within the @code{SECTIONS} command---whatever makes the most
1855 sense for your layout.
1857 @cindex entry point, defaults
1858 @code{ENTRY} is only one of several ways of choosing the entry point.
1859 You may indicate it in any of the following ways (shown in descending
1860 order of priority: methods higher in the list override methods lower down).
1863 the @samp{-e} @var{entry} command-line option;
1865 the @code{ENTRY(@var{symbol})} command in a linker control script;
1867 the value of the symbol @code{start}, if present;
1869 the value of the symbol @code{_main}, if present;
1871 the address of the first byte of the @code{.text} section, if present;
1873 The address @code{0}.
1876 For example, you can use these rules to generate an entry point with an
1877 assignment statement: if no symbol @code{start} is defined within your
1878 input files, you can simply define it, assigning it an appropriate
1886 The example shows an absolute address, but you can use any expression.
1887 For example, if your input object files use some other symbol-name
1888 convention for the entry point, you can just assign the value of
1889 whatever symbol contains the start address to @code{start}:
1892 start = other_symbol ;
1895 @node Option Commands
1896 @section Option Commands
1897 The command language includes a number of other commands that you can
1898 use for specialized purposes. They are similar in purpose to
1899 command-line options.
1902 @kindex CONSTRUCTORS
1903 @cindex C++ constructors, arranging in link
1904 @cindex constructors, arranging in link
1906 This command ties up C++ style constructor and destructor records. The
1907 details of the constructor representation vary from one object format to
1908 another, but usually lists of constructors and destructors appear as
1909 special sections. The @code{CONSTRUCTORS} command specifies where the
1910 linker is to place the data from these sections, relative to the rest of
1911 the linked output. Constructor data is marked by the symbol
1912 @w{@code{__CTOR_LIST__}} at the start, and @w{@code{__CTOR_LIST_END}} at
1913 the end; destructor data is bracketed similarly, between
1914 @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_LIST_END}}. (The compiler
1915 must arrange to actually run this code; GNU C++ calls constructors from
1916 a subroutine @code{__main}, which it inserts automatically into the
1917 startup code for @code{main}, and destructors from @code{_exit}.)
1924 These keywords were used in some older linkers to request a particular
1925 math subroutine library. @code{ld} doesn't use the keywords, assuming
1926 instead that any necessary subroutines are in libraries specified using
1927 the general mechanisms for linking to archives; but to permit the use of
1928 scripts that were written for the older linkers, the keywords
1929 @code{FLOAT} and @code{NOFLOAT} are accepted and ignored.
1931 @kindex FORCE_COMMON_ALLOCATION
1932 @cindex common allocation
1933 @item FORCE_COMMON_ALLOCATION
1934 This command has the same effect as the @samp{-d} command-line option:
1935 to make @code{ld} assign space to common symbols even if a relocatable
1936 output file is specified (@samp{-r}).
1938 @kindex INPUT ( @var{files} )
1939 @cindex binary input files
1940 @item INPUT ( @var{file}, @var{file}, @dots{} )
1941 @itemx INPUT ( @var{file} @var{file} @dots{} )
1942 Use this command to include binary input files in the link, without
1943 including them in a particular section definition.
1944 Specify the full name for each @var{file}, including @samp{.a} if
1947 @code{ld} searches for each @var{file} through the archive-library
1948 search path, just as for files you specify on the command line.
1949 See the description of @samp{-L} in @ref{Options,,Command Line
1953 @item MAP ( @var{name} )
1954 @kindex MAP ( @var{name} )
1955 @c MAP(...) appears to look for an F in the arg, ignoring all other
1956 @c chars; if it finds one, it sets "map_option_f" to true. But nothing
1957 @c checks map_option_f. Apparently a stub for the future...
1960 @item OUTPUT ( @var{filename} )
1961 @kindex OUTPUT ( @var{filename} )
1962 @cindex naming the output file
1963 Use this command to name the link output file @var{filename}. The
1964 effect of @code{OUTPUT(@var{filename})} is identical to the effect of
1965 @w{@samp{-o @var{filename}}}, which overrides it. You can use this
1966 command to supply a default output-file name other than @code{a.out}.
1968 @ifclear SingleFormat
1969 @item OUTPUT_ARCH ( @var{bfdname} )
1970 @kindex OUTPUT_ARCH ( @var{bfdname} )
1971 @cindex machine architecture, output
1972 Specify a particular output machine architecture, with one of the names
1973 used by the BFD back-end routines (@pxref{BFD}). This command is often
1974 unnecessary; the architecture is most often set implicitly by either the
1975 system BFD configuration or as a side effect of the @code{OUTPUT_FORMAT}
1978 @item OUTPUT_FORMAT ( @var{bfdname} )
1979 @kindex OUTPUT_FORMAT ( @var{bfdname} )
1980 @cindex format, output file
1981 When @code{ld} is configured to support multiple object code formats,
1982 you can use this command to specify a particular output format.
1983 @var{bfdname} is one of the names used by the BFD back-end routines
1984 (@pxref{BFD}). The effect is identical to the effect of the
1985 @samp{-oformat} command-line option. This selection affects only
1986 the output file; the related command @code{TARGET} affects primarily
1990 @item SEARCH_DIR ( @var{path} )
1991 @kindex SEARCH_DIR ( @var{path} )
1992 @cindex path for libraries
1993 @cindex search path, libraries
1994 Add @var{path} to the list of paths where @code{ld} looks for
1995 archive libraries. @code{SEARCH_DIR(@var{path})} has the same
1996 effect as @samp{-L@var{path}} on the command line.
1998 @item STARTUP ( @var{filename} )
1999 @kindex STARTUP ( @var{filename} )
2000 @cindex first input file
2001 Ensure that @var{filename} is the first input file used in the link
2004 @ifclear SingleFormat
2005 @item TARGET ( @var{format} )
2006 @cindex input file format
2007 @kindex TARGET ( @var{format} )
2008 When @code{ld} is configured to support multiple object code formats,
2009 you can use this command to change the input-file object code format
2010 (like the command-line option @samp{-b} or its synonym @samp{-format}).
2011 The argument @var{format} is one of the strings used by BFD to name
2012 binary formats. If @code{TARGET} is specified but @code{OUTPUT_FORMAT}
2013 is not, the last @code{TARGET} argument is also used as the default
2014 format for the @code{ld} output file. @xref{BFD}.
2017 If you don't use the @code{TARGET} command, @code{ld} uses the value of
2018 the environment variable @code{GNUTARGET}, if available, to select the
2019 output file format. If that variable is also absent, @code{ld} uses
2020 the default format configured for your machine in the BFD libraries.
2025 @node Machine Dependent
2026 @chapter Machine Dependent Features
2028 @cindex machine dependencies
2029 @code{ld} has additional features on some platforms; the following
2030 sections describe them. Machines where @code{ld} has no additional
2031 functionality are not listed.
2034 * H8/300:: @code{ld} and the H8/300
2035 * i960:: @code{ld} and the Intel 960 family
2039 @c FIXME! This could use @raisesections/@lowersections, but there seems to be a conflict
2040 @c between those and node-defaulting.
2046 @section @code{ld} and the H8/300
2048 @cindex H8/300 support
2049 For the H8/300, @code{ld} can perform these global optimizations when
2050 you specify the @samp{-relax} command-line option.
2053 @item relaxing address modes
2054 @cindex relaxing on H8/300
2055 @code{ld} finds all @code{jsr} and @code{jmp} instructions whose
2056 targets are within eight bits, and turns them into eight-bit
2057 program-counter relative @code{bsr} and @code{bra} instructions,
2060 @item synthesizing instructions
2061 @cindex synthesizing on H8/300
2062 @c FIXME: specifically mov.b, or any mov instructions really?
2063 @code{ld} finds all @code{mov.b} instructions which use the
2064 sixteen-bit absolute address form, but refer to the top
2065 page of memory, and changes them to use the eight-bit address form.
2066 (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into
2067 @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the
2068 top page of memory).
2080 @section @code{ld} and the Intel 960 family
2082 @cindex i960 support
2084 You can use the @samp{-A@var{architecture}} command line option to
2085 specify one of the two-letter names identifying members of the 960
2086 family; the option specifies the desired output target, and warns of any
2087 incompatible instructions in the input files. It also modifies the
2088 linker's search strategy for archive libraries, to support the use of
2089 libraries specific to each particular architecture, by including in the
2090 search loop names suffixed with the string identifying the architecture.
2092 For example, if your @code{ld} command line included @w{@samp{-ACA}} as
2093 well as @w{@samp{-ltry}}, the linker would look (in its built-in search
2094 paths, and in any paths you specify with @samp{-L}) for a library with
2105 The first two possibilities would be considered in any event; the last
2106 two are due to the use of @w{@samp{-ACA}}.
2108 You can meaningfully use @samp{-A} more than once on a command line, since
2109 the 960 architecture family allows combination of target architectures; each
2110 use will add another pair of name variants to search for when @w{@samp{-l}}
2111 specifies a library.
2113 @cindex @code{-relax} on i960
2114 @cindex relaxing on i960
2115 @code{ld} supports the @samp{-relax} option for the i960 family. If you
2116 specify @samp{-relax}, @code{ld} finds all @code{balx} and @code{calx}
2117 instructions whose targets are within 24 bits, and turns them into
2118 24-bit program-counter relative @code{bal} and @code{cal}
2119 instructions, respectively. @code{ld} also turns @code{cal}
2120 instructions into @code{bal} instructions when it determines that the
2121 target subroutine is a leaf routine (that is, the target subroutine does
2122 not itself call any subroutines).
2129 @ifclear SingleFormat
2134 @cindex object file management
2135 @cindex object formats available
2137 The linker accesses object and archive files using the BFD libraries.
2138 These libraries allow the linker to use the same routines to operate on
2139 object files whatever the object file format. A different object file
2140 format can be supported simply by creating a new BFD back end and adding
2141 it to the library. To conserve runtime memory, however, the linker and
2142 associated tools are usually configured to support only a subset of the
2143 object file formats available. You can use @code{objdump -i}
2144 (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to
2145 list all the formats available for your configuration.
2147 @cindex BFD requirements
2148 @cindex requirements for BFD
2149 As with most implementations, BFD is a compromise between
2150 several conflicting requirements. The major factor influencing
2151 BFD design was efficiency: any time used converting between
2152 formats is time which would not have been spent had BFD not
2153 been involved. This is partly offset by abstraction payback; since
2154 BFD simplifies applications and back ends, more time and care
2155 may be spent optimizing algorithms for a greater speed.
2157 One minor artifact of the BFD solution which you should bear in
2158 mind is the potential for information loss. There are two places where
2159 useful information can be lost using the BFD mechanism: during
2160 conversion and during output. @xref{BFD information loss}.
2163 * BFD outline:: How it works: an outline of BFD
2167 @section How it works: an outline of BFD
2168 @cindex opening object files
2169 @include bfdsumm.texi
2173 @appendix MRI Compatible Script Files
2174 @cindex MRI compatibility
2175 To aid users making the transition to @sc{gnu} @code{ld} from the MRI
2176 linker, @code{ld} can use MRI compatible linker scripts as an
2177 alternative to the more general-purpose linker scripting language
2178 described in @ref{Commands,,Command Language}. MRI compatible linker
2179 scripts have a much simpler command set than the scripting language
2180 otherwise used with @code{ld}. @sc{gnu} @code{ld} supports the most
2181 commonly used MRI linker commands; these commands are described here.
2183 In general, MRI scripts aren't of much use with the @code{a.out} object
2184 file format, since it only has three sections and MRI scripts lack some
2185 features to make use of them.
2187 You can specify a file containing an MRI-compatible script using the
2188 @samp{-c} command-line option.
2190 Each command in an MRI-compatible script occupies its own line; each
2191 command line starts with the keyword that identifies the command (though
2192 blank lines are also allowed for punctuation). If a line of an
2193 MRI-compatible script begins with an unrecognized keyword, @code{ld}
2194 issues a warning message, but continues processing the script.
2196 Lines beginning with @samp{*} are comments.
2198 You can write these commands using all upper-case letters, or all
2199 lower case; for example, @samp{chip} is the same as @samp{CHIP}.
2200 The following list shows only the upper-case form of each command.
2203 @cindex @code{ABSOLUTE} (MRI)
2204 @item ABSOLUTE @var{secname}
2205 @item ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname}
2206 Normally, @code{ld} includes in the output file all sections from all
2207 the input files. However, in an MRI-compatible script, you can use the
2208 @code{ABSOLUTE} command to restrict the sections that will be present in
2209 your output program. If the @code{ABSOLUTE} command is used at all in a
2210 script, then only the sections named explicitly in @code{ABSOLUTE}
2211 commands will appear in the linker output. You can still use other
2212 input sections (whatever you select on the command line, or using
2213 @code{LOAD}) to resolve addresses in the output file.
2215 @cindex @code{ALIAS} (MRI)
2216 @item ALIAS @var{out-secname}, @var{in-secname}
2217 Use this command to place the data from input section @var{in-secname}
2218 in a section called @var{out-secname} in the linker output file.
2220 @var{in-secname} may be an integer.
2222 @cindex @code{BASE} (MRI)
2223 @item BASE @var{expression}
2224 Use the value of @var{expression} as the lowest address (other than
2225 absolute addresses) in the output file.
2227 @cindex @code{CHIP} (MRI)
2228 @item CHIP @var{expression}
2229 @itemx CHIP @var{expression}, @var{expression}
2230 This command does nothing; it is accepted only for compatibility.
2232 @cindex @code{END} (MRI)
2234 This command does nothing whatever; it's only accepted for compatibility.
2236 @cindex @code{FORMAT} (MRI)
2237 @item FORMAT @var{output-format}
2238 Similar to the @code{OUTPUT_FORMAT} command in the more general linker
2239 language, but restricted to one of these output formats:
2243 S-records, if @var{output-format} is @samp{S}
2246 IEEE, if @var{output-format} is @samp{IEEE}
2249 COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is
2253 @cindex @code{LIST} (MRI)
2254 @item LIST @var{anything}@dots{}
2255 Print (to the standard output file) a link map, as produced by the
2256 @code{ld} command-line option @samp{-M}.
2258 The keyword @code{LIST} may be followed by anything on the
2259 same line, with no change in its effect.
2261 @cindex @code{LOAD} (MRI)
2262 @item LOAD @var{filename}
2263 @item LOAD @var{filename}, @var{filename}, @dots{} @var{filename}
2264 Include one or more object file @var{filename} in the link; this has the
2265 same effect as specifying @var{filename} directly on the @code{ld}
2268 @cindex @code{NAME} (MRI)
2269 @item NAME @var{output-name}
2270 @var{output-name} is the name for the program produced by @code{ld}; the
2271 MRI-compatible command @code{NAME} is equivalent to the command-line
2272 option @samp{-o} or the general script language command @code{OUTPUT}.
2274 @cindex @code{ORDER} (MRI)
2275 @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname}
2276 @itemx ORDER @var{secname} @var{secname} @var{secname}
2277 Normally, @code{ld} orders the sections in its output file in the
2278 order in which they first appear in the input files. In an MRI-compatible
2279 script, you can override this ordering with the @code{ORDER} command. The
2280 sections you list with @code{ORDER} will appear first in your output
2281 file, in the order specified.
2283 @cindex @code{PUBLIC} (MRI)
2284 @item PUBLIC @var{name}=@var{expression}
2285 @itemx PUBLIC @var{name},@var{expression}
2286 @itemx PUBLIC @var{name} @var{expression}
2287 Supply a value (@var{expression}) for external symbol
2288 @var{name} used in the linker input files.
2290 @cindex @code{SECT} (MRI)
2291 @item SECT @var{secname}, @var{expression}
2292 @itemx SECT @var{secname}=@var{expression}
2293 @itemx SECT @var{secname} @var{expression}
2294 You can use any of these three forms of the @code{SECT} command to
2295 specify the start address (@var{expression}) for section @var{secname}.
2296 If you have more than one @code{SECT} statement for the same
2297 @var{secname}, only the @emph{first} sets the start address.
2307 % I think something like @colophon should be in texinfo. In the
2309 \long\def\colophon{\hbox to0pt{}\vfill
2310 \centerline{The body of this manual is set in}
2311 \centerline{\fontname\tenrm,}
2312 \centerline{with headings in {\bf\fontname\tenbf}}
2313 \centerline{and examples in {\tt\fontname\tentt}.}
2314 \centerline{{\it\fontname\tenit\/} and}
2315 \centerline{{\sl\fontname\tensl\/}}
2316 \centerline{are used for emphasis.}\vfill}