* gdb.t00/help.exp: Comment out "help set print" tests just like
[deliverable/binutils-gdb.git] / ld / ld.texinfo
CommitLineData
f22eee08 1\input texinfo
c8072296 2@setfilename ld.info
b4d4e8e3 3@syncodeindex ky cp
7f9ae73e 4@include configdoc.texi
8de26d62 5@c (configdoc.texi is generated by the Makefile)
ec40bbb8
DM
6
7@c @smallbook
1c48127e
RP
8
9@ifinfo
10@format
11START-INFO-DIR-ENTRY
8ddef552 12* Ld:: The GNU linker.
1c48127e
RP
13END-INFO-DIR-ENTRY
14@end format
15@end ifinfo
16
b4d4e8e3 17@ifinfo
246504a5 18This file documents the GNU linker LD.
b4d4e8e3 19
d76ae847 20Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc.
b4d4e8e3
RP
21
22Permission is granted to make and distribute verbatim copies of
23this manual provided the copyright notice and this permission notice
24are preserved on all copies.
25
d76ae847
RP
26Permission is granted to copy and distribute modified versions of this
27manual under the conditions for verbatim copying, provided also that
28the entire resulting derived work is distributed under the terms of a
29permission notice identical to this one.
30
31Permission is granted to copy and distribute translations of this manual
32into another language, under the above conditions for modified versions.
33
b4d4e8e3
RP
34@ignore
35Permission is granted to process this file through Tex and print the
36results, provided the printed document carries copying permission
37notice identical to this one except for the removal of this paragraph
38(this paragraph not being relevant to the printed manual).
39
40@end ignore
b4d4e8e3 41@end ifinfo
2c5c0674
RP
42@iftex
43@finalout
b4d4e8e3 44@setchapternewpage odd
246504a5 45@settitle Using LD, the GNU linker
f22eee08 46@titlepage
246504a5 47@title Using ld
c8072296 48@subtitle The GNU linker
f22eee08 49@sp 1
cb70c872 50@subtitle @code{ld} version 2
d76ae847 51@subtitle March 1993
c8072296
RP
52@author Steve Chamberlain and Roland Pesch
53@author Cygnus Support
b4d4e8e3
RP
54@page
55
56@tex
b4d4e8e3
RP
57{\parskip=0pt
58\hfill Cygnus Support\par
2c5c0674 59\hfill steve\@cygnus.com, pesch\@cygnus.com\par
ec40bbb8
DM
60\hfill {\it Using LD, the GNU linker}\par
61\hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com), March 1993.\par
b4d4e8e3
RP
62}
63\global\parindent=0pt % Steve likes it this way.
64@end tex
65
f22eee08 66@vskip 0pt plus 1filll
d76ae847 67Copyright @copyright{} 1991, 1992, 1993 Free Software Foundation, Inc.
f22eee08
RP
68
69Permission is granted to make and distribute verbatim copies of
70this manual provided the copyright notice and this permission notice
71are preserved on all copies.
72
73Permission is granted to copy and distribute modified versions of this
74manual under the conditions for verbatim copying, provided also that
75the entire resulting derived work is distributed under the terms of a
76permission notice identical to this one.
77
78Permission is granted to copy and distribute translations of this manual
79into another language, under the above conditions for modified versions.
f22eee08 80@end titlepage
2c5c0674 81@end iftex
b4d4e8e3 82@c FIXME: Talk about importance of *order* of args, cmds to linker!
f22eee08 83
f22eee08 84@ifinfo
ec40bbb8
DM
85@node Top
86@top Using ld
246504a5 87This file documents the GNU linker ld.
f22eee08 88
2c5c0674 89@menu
2d59b2c3
RP
90* Overview:: Overview
91* Invocation:: Invocation
92* Commands:: Command Language
ec40bbb8 93@ifset GENERIC
2d59b2c3 94* Machine Dependent:: Machine Dependent Features
ec40bbb8
DM
95@end ifset
96@ifclear GENERIC
97@ifset H8300
98* H8/300:: ld and the H8/300
99@end ifset
100@ifset I960
101* i960:: ld and the Intel 960 family
102@end ifset
103@end ifclear
104@ifclear SingleFormat
2d59b2c3 105* BFD:: BFD
ec40bbb8
DM
106@end ifclear
107@c Following blank line required for remaining bug in makeinfo conds/menus
108
2d59b2c3
RP
109* MRI:: MRI Compatible Script Files
110* Index:: Index
2c5c0674 111@end menu
ec40bbb8 112@end ifinfo
2c5c0674 113
ec40bbb8 114@node Overview
f22eee08
RP
115@chapter Overview
116
2c5c0674
RP
117@cindex GNU linker
118@cindex what is this?
246504a5 119@code{ld} combines a number of object and archive files, relocates
ec40bbb8
DM
120their data and ties up symbol references. Usually the last step in
121compiling a program is to run @code{ld}.
f22eee08 122
246504a5 123@code{ld} accepts Linker Command Language files written in
2c5c0674 124a superset of AT&T's Link Editor Command Language syntax,
b4d4e8e3 125to provide explicit and total control over the linking process.
f22eee08 126
ec40bbb8 127@ifclear SingleFormat
246504a5
RP
128This version of @code{ld} uses the general purpose BFD libraries
129to operate on object files. This allows @code{ld} to read, combine, and
b4d4e8e3
RP
130write object files in many different formats---for example, COFF or
131@code{a.out}. Different formats may be linked together to produce any
132available kind of object file. @xref{BFD} for a list of formats
133supported on various architectures.
ec40bbb8 134@end ifclear
f22eee08 135
2c5c0674
RP
136Aside from its flexibility, the GNU linker is more helpful than other
137linkers in providing diagnostic information. Many linkers abandon
138execution immediately upon encountering an error; whenever possible,
246504a5 139@code{ld} continues executing, allowing you to identify other errors
2c5c0674
RP
140(or, in some cases, to get an output file in spite of the error).
141
ec40bbb8 142@node Invocation
2c5c0674
RP
143@chapter Invocation
144
246504a5 145The GNU linker @code{ld} is meant to cover a broad range of situations,
2c5c0674 146and to be as compatible as possible with other linkers. As a result,
ec40bbb8 147you have many choices to control its behavior.
2c5c0674 148
ec40bbb8 149@ifset UsesEnvVars
2c5c0674 150@menu
2d59b2c3
RP
151* Options:: Command Line Options
152* Environment:: Environment Variables
2c5c0674 153@end menu
f22eee08 154
ec40bbb8 155@node Options
2c5c0674 156@section Command Line Options
ec40bbb8 157@end ifset
2c5c0674
RP
158
159@cindex command line
160@cindex options
ec40bbb8 161Here is a summary of the options you can use on the @code{ld} command
2c5c0674 162line:
f22eee08 163
ec40bbb8 164@c FIXME! -relax only avail h8/300, i960. Conditionals screwed in examples.
c8072296 165@smallexample
de87cdb4 166ld [ -o @var{output} ] @var{objfile}@dots{}
cb70c872
RP
167 [ -A@var{architecture} ] [ -b @var{input-format} ] [ -Bstatic ]
168 [ -c @var{MRI-commandfile} ] [ -d | -dc | -dp ]
d76ae847 169 [ -defsym @var{symbol}=@var{expression} ]
cb70c872 170 [ -e @var{entry} ] [ -F ] [ -F @var{format} ]
de87cdb4
DM
171 [ -format @var{input-format} ] [ -g ] [ -G @var{size} ] [ --help ] [ -i ]
172 [ -l@var{archive} ] [ -L@var{searchdir} ] [ -M ] [ -Map @var{mapfile} ]
d18a4527 173 [ -m @var{emulation} ] [ -N | -n ] [ -noinhibit-exec ]
346535cc 174 [ -oformat @var{output-format} ] [ -R @var{filename} ] [ -relax ]
7c8fab26 175 [ -retain-symbols-file @var{filename} ]
8594f568
SS
176 [ -r | -Ur ] [ -S ] [ -s ] [ -sort-common ] [ -stats ]
177 [ -T @var{commandfile} ]
867a1b8a
DM
178 [ -Ttext @var{org} ] [ -Tdata @var{org} ]
179 [ -Tbss @var{org} ] [ -t ] [ -u @var{symbol}] [-V] [-v] [ --version ]
1fb57a5d 180 [ -warn-common ] [ -y @var{symbol} ] [ -X ] [-x ]
c8072296 181@end smallexample
b4d4e8e3
RP
182
183This plethora of command-line options may seem intimidating, but in
184actual practice few of them are used in any particular context.
2c5c0674 185@cindex standard Unix system
246504a5 186For instance, a frequent use of @code{ld} is to link standard Unix
b4d4e8e3
RP
187object files on a standard, supported Unix system. On such a system, to
188link a file @code{hello.o}:
ec40bbb8 189
f22eee08 190@example
ec40bbb8 191ld -o @var{output} /lib/crt0.o hello.o -lc
f22eee08 192@end example
ec40bbb8 193
d76ae847 194This tells @code{ld} to produce a file called @var{output} as the
b4d4e8e3 195result of linking the file @code{/lib/crt0.o} with @code{hello.o} and
ec40bbb8
DM
196the library @code{libc.a}, which will come from the standard search
197directories. (See the discussion of the @samp{-l} option below.)
f22eee08 198
246504a5 199The command-line options to @code{ld} may be specified in any order, and
ec40bbb8 200may be repeated at will. Repeating most options with a
f22eee08 201different argument will either have no further effect, or override prior
ec40bbb8 202occurrences (those further to the left on the command line) of that
f22eee08
RP
203option.
204
ec40bbb8 205@ifclear SingleFormat
2c5c0674 206The exceptions---which may meaningfully be used more than once---are
ec40bbb8
DM
207@samp{-A}, @samp{-b} (or its synonym @samp{-format}), @samp{-defsym},
208@samp{-L}, @samp{-l}, @samp{-R}, and @samp{-u}.
209@end ifclear
210@ifset SingleFormat
211The exceptions---which may meaningfully be used more than once---are
212@samp{-A}, @samp{-defsym}, @samp{-L}, @samp{-l}, @samp{-R}, and @samp{-u}.
213@end ifset
f22eee08 214
2c5c0674 215@cindex object files
8ddef552 216The list of object files to be linked together, shown as @var{objfile}@dots{},
ec40bbb8
DM
217may follow, precede, or be mixed in with command-line options, except that
218an @var{objfile} argument may not be placed between an option and
b4d4e8e3 219its argument.
f22eee08 220
7f9ae73e
RP
221Usually the linker is invoked with at least one object file, but you can
222specify other forms of binary input files using @samp{-l}, @samp{-R},
223and the script command language. If @emph{no} binary input files at all
224are specified, the linker does not produce any output, and issues the
225message @samp{No input files}.
2c5c0674
RP
226
227Option arguments must either follow the option letter without intervening
f22eee08
RP
228whitespace, or be given as separate arguments immediately following the
229option that requires them.
230
231@table @code
ec40bbb8 232@ifset I960
2c5c0674
RP
233@cindex architectures
234@kindex -A@var{arch}
b4d4e8e3 235@item -A@var{architecture}
246504a5
RP
236In the current release of @code{ld}, this option is useful only for the
237Intel 960 family of architectures. In that @code{ld} configuration, the
1c48127e
RP
238@var{architecture} argument identifies the particular architecture in
239the 960 family, enabling some safeguards and modifying the
d76ae847
RP
240archive-library search path. @xref{i960,,@code{ld} and the Intel 960
241family}, for details.
b4d4e8e3 242
246504a5 243Future releases of @code{ld} may support similar functionality for
b4d4e8e3 244other architecture families.
ec40bbb8 245@end ifset
b4d4e8e3 246
ec40bbb8 247@ifclear SingleFormat
2c5c0674
RP
248@cindex binary input format
249@kindex -b @var{format}
250@cindex input format
251@item -b @var{input-format}
252@cindex input format
1fb57a5d
RP
253@code{ld} may be configured to support more than one kind of object
254file. If your @code{ld} is configured this way, you can use the
255@samp{-b} option to specify the binary format for input object files
256that follow this option on the command line. Even when @code{ld} is
257configured to support alternative object formats, you don't usually need
258to specify this, as @code{ld} should be configured to expect as a
259default input format the most usual format on each machine.
260@var{input-format} is a text string, the name of a particular format
261supported by the BFD libraries. (You can list the available binary
262formats with @samp{objdump -i}.) @w{@samp{-format @var{input-format}}}
263has the same effect, as does the script command @code{TARGET}.
264@xref{BFD}.
2c5c0674
RP
265
266You may want to use this option if you are linking files with an unusual
ec40bbb8 267binary format. You can also use @samp{-b} to switch formats explicitly (when
2c5c0674 268linking object files of different formats), by including
ec40bbb8 269@samp{-b @var{input-format}} before each group of object files in a
2c5c0674
RP
270particular format.
271
272The default format is taken from the environment variable
ec40bbb8
DM
273@code{GNUTARGET}.
274@ifset UsesEnvVars
275@xref{Environment}.
276@end ifset
277You can also define the input
867a1b8a 278format from a script, using the command @code{TARGET}; see @ref{Option
d76ae847 279Commands}.
ec40bbb8 280@end ifclear
2c5c0674
RP
281
282@kindex -Bstatic
f22eee08 283@item -Bstatic
ec40bbb8
DM
284Ignored. This option is accepted for command-line compatibility with
285the SunOS linker.
f22eee08 286
2d59b2c3
RP
287@kindex -c @var{MRI-cmdfile}
288@cindex compatibility, MRI
289@item -c @var{MRI-commandfile}
290For compatibility with linkers produced by MRI, @code{ld} accepts script
291files written in an alternate, restricted command language, described in
d76ae847 292@ref{MRI,,MRI Compatible Script Files}. Introduce MRI script files with
ec40bbb8 293the option @samp{-c}; use the @samp{-T} option to run linker
d76ae847 294scripts written in the general-purpose @code{ld} scripting language.
8ddef552
DM
295If @var{MRI-cmdfile} does not exist, @code{ld} looks for it in the directories
296specified by any @samp{-L} options.
b4d4e8e3 297
2c5c0674
RP
298@cindex common allocation
299@kindex -d
b4d4e8e3 300@item -d
2c5c0674 301@kindex -dc
b4d4e8e3 302@itemx -dc
2c5c0674 303@kindex -dp
b4d4e8e3
RP
304@itemx -dp
305These three options are equivalent; multiple forms are supported for
ec40bbb8 306compatibility with other linkers. They
2c5c0674 307assign space to common symbols even if a relocatable output file is
ec40bbb8 308specified (with @samp{-r}). The script command
867a1b8a 309@code{FORCE_COMMON_ALLOCATION} has the same effect. @xref{Option
d76ae847 310Commands}.
b4d4e8e3 311
2c5c0674 312@cindex symbols, from command line
d76ae847
RP
313@kindex -defsym @var{symbol}=@var{exp}
314@item -defsym @var{symbol}=@var{expression}
2c5c0674
RP
315Create a global symbol in the output file, containing the absolute
316address given by @var{expression}. You may use this option as many
317times as necessary to define multiple symbols in the command line. A
318limited form of arithmetic is supported for the @var{expression} in this
319context: you may give a hexadecimal constant or the name of an existing
320symbol, or use @code{+} and @code{-} to add or subtract hexadecimal
321constants or symbols. If you need more elaborate expressions, consider
d76ae847
RP
322using the linker command language from a script (@pxref{Assignment, ,
323Assignment: Symbol Definitions}). @emph{Note:} there should be no
324white space between @var{symbol}, the equals sign (``@key{=}''), and
325@var{expression}.
2c5c0674
RP
326
327@cindex entry point, from command line
328@kindex -e @var{entry}
f22eee08
RP
329@item -e @var{entry}
330Use @var{entry} as the explicit symbol for beginning execution of your
b4d4e8e3
RP
331program, rather than the default entry point. @xref{Entry Point}, for a
332discussion of defaults and other ways of specifying the
333entry point.
f22eee08 334
ec40bbb8 335@ifclear SingleFormat
2c5c0674 336@kindex -F
b4d4e8e3 337@item -F
2c5c0674 338@itemx -F@var{format}
ec40bbb8
DM
339Ignored. Some older linkers used this option throughout a compilation
340toolchain for specifying object-file format for both input and output
341object files. The mechanisms @code{ld} uses for this purpose (the
867a1b8a
DM
342@samp{-b} or @samp{-format} options for input files, @samp{-oformat}
343option or the @code{TARGET} command in linker scripts for output files,
344the @code{GNUTARGET} environment variable) are more flexible, but
345@code{ld} accepts the @samp{-F} option for compatibility with scripts
346written to call the old linker.
2c5c0674
RP
347
348@kindex -format
349@item -format @var{input-format}
ec40bbb8
DM
350Synonym for @samp{-b @var{input-format}}.
351@end ifclear
2c5c0674
RP
352
353@kindex -g
b4d4e8e3 354@item -g
ec40bbb8 355Ignored. Provided for compatibility with other tools.
b4d4e8e3 356
8ddef552
DM
357@kindex -G
358@cindex object size
359@item -G@var{value}
360@itemx -G @var{value}
361Set the maximum size of objects to be optimized using the GP register to
362@var{size} under MIPS ECOFF. Ignored for other object file formats.
363
de87cdb4
DM
364@item --help
365@kindex --help
366@cindex help
367@cindex usage
368Print a summary of the command-line options on the standard output and exit.
369This option and @samp{--version} begin with two dashes instead of one
370for compatibility with other GNU programs. The other options start with
371only one dash for compatibility with other linkers.
372
2c5c0674
RP
373@kindex -i
374@cindex incremental link
f22eee08 375@item -i
ec40bbb8 376Perform an incremental link (same as option @samp{-r}).
f22eee08 377
2c5c0674 378@cindex archive files, from cmd line
de87cdb4 379@kindex -l@var{archive}
b4d4e8e3 380@item -l@var{ar}
de87cdb4 381Add archive file @var{archive} to the list of files to link. This
f22eee08 382option may be used any number of times. @code{ld} will search its
de87cdb4 383path-list for occurrences of @code{lib@var{ar}.a} for every @var{archive}
f22eee08
RP
384specified.
385
2c5c0674
RP
386@cindex search directory, from cmd line
387@kindex -L@var{dir}
b4d4e8e3 388@item -L@var{searchdir}
836a5ee4 389@itemx -L @var{searchdir}
ec40bbb8 390Add path @var{searchdir} to the list of paths that @code{ld} will search
8ddef552
DM
391for archive libraries and @code{ld} control scripts. You may use this
392option any number of times.
f22eee08 393
ec40bbb8 394@ifset UsesEnvVars
2c5c0674 395The default set of paths searched (without being specified with
ec40bbb8
DM
396@samp{-L}) depends on which emulation mode @code{ld} is using, and in
397some cases also on how it was configured. @xref{Environment}.
398@end ifset
399
400The paths can also be specified in a link script with the
401@code{SEARCH_DIR} command.
f22eee08 402
2c5c0674
RP
403@cindex link map
404@kindex -M
f22eee08 405@item -M
ec40bbb8 406Print (to the standard output) a link map---diagnostic information
f22eee08
RP
407about where symbols are mapped by @code{ld}, and information on global
408common storage allocation.
409
d18a4527
DM
410@cindex link map
411@kindex -Map
412@item -Map @var{mapfile}
413Print to the file @var{mapfile} a link map---diagnostic information
414about where symbols are mapped by @code{ld}, and information on global
415common storage allocation.
416
8ddef552
DM
417@cindex emulation
418@kindex -m @var{emulation}
419@item -m@var{emulation}
420@itemx -m @var{emulation}
421Emulate the @var{emulation} linker. You can list the available
422emulations with the @samp{-V} option. The
1fb57a5d 423default depends on how your @code{ld} was configured.
8ddef552 424
2c5c0674
RP
425@kindex -N
426@cindex read/write from cmd line
427@kindex OMAGIC
f22eee08 428@item -N
ec40bbb8
DM
429Set the text and data sections to be readable and writable. Also, do
430not page-align the data segment. If the output format supports Unix
431style magic numbers, mark the output as @code{OMAGIC}.
f22eee08
RP
432
433@item -n
2c5c0674
RP
434@kindex -n
435@cindex read-only text
436@kindex NMAGIC
ec40bbb8
DM
437Set the text segment to be read only, and mark the output as
438@code{NMAGIC} if possible.
f22eee08 439
b4d4e8e3 440@item -noinhibit-exec
2c5c0674
RP
441@cindex output file after errors
442@kindex -noinhibit-exec
ec40bbb8 443Retain the executable output file whenever it is still usable.
b4d4e8e3 444Normally, the linker will not produce an output file if it encounters
ec40bbb8
DM
445errors during the link process; it exits without writing an output file
446when it issues any error whatsoever.
b4d4e8e3 447
f22eee08 448@item -o @var{output}
2c5c0674
RP
449@kindex -o @var{output}
450@cindex naming the output file
ec40bbb8
DM
451Use @var{output} as the name for the program produced by @code{ld}; if this
452option is not specified, the name @file{a.out} is used by default. The
2c5c0674 453script command @code{OUTPUT} can also specify the output file name.
f22eee08 454
7f9ae73e 455@ifclear SingleFormat
346535cc
DM
456@kindex -oformat
457@item -oformat @var{output-format}
1fb57a5d
RP
458@code{ld} may be configured to support more than one kind of object
459file. If your @code{ld} is configured this way, you can use the
460@samp{-oformat} option to specify the binary format for the output
461object file. Even when @code{ld} is configured to support alternative
462object formats, you don't usually need to specify this, as @code{ld}
463should be configured to produce as a default output format the most
464usual format on each machine. @var{output-format} is a text string, the
465name of a particular format supported by the BFD libraries. (You can
466list the available binary formats with @samp{objdump -i}.) The script
467command @code{OUTPUT_FORMAT} can also specify the output format, but
468this option overrides it. @xref{BFD}.
7f9ae73e 469@end ifclear
346535cc 470
b4d4e8e3 471@item -R @var{filename}
2c5c0674
RP
472@kindex -R @var{file}
473@cindex symbol-only input
867a1b8a
DM
474Read symbol names and their addresses from @var{filename}, but do not
475relocate it or include it in the output. This allows your output file
476to refer symbolically to absolute locations of memory defined in other
477programs.
ec40bbb8 478
1c48127e
RP
479@item -relax
480@kindex -relax
481@cindex synthesizing linker
482@cindex relaxing addressing modes
1fb57a5d
RP
483An option with machine dependent effects.
484@ifset GENERIC
485Currently this option is only supported on the H8/300 and the Intel 960.
486@end ifset
ec40bbb8
DM
487@ifset H8300
488@xref{H8/300,,@code{ld} and the H8/300}.
489@end ifset
1fb57a5d
RP
490@ifset I960
491@xref{i960,, @code{ld} and the Intel 960 family}.
492@end ifset
1c48127e 493
1fb57a5d 494On some platforms, the @samp{-relax} option performs global optimizations that
ec40bbb8 495become possible when the linker resolves addressing in the program, such
1c48127e
RP
496as relaxing address modes and synthesizing new instructions in the
497output object file.
498
1fb57a5d 499@ifset GENERIC
1c48127e 500On platforms where this is not supported, @samp{-relax} is accepted, but
ec40bbb8 501ignored.
1fb57a5d 502@end ifset
1c48127e 503
7c8fab26
RP
504@item -retain-symbols-file @var{filename}
505@cindex retaining specified symbols
506@cindex stripping all but some symbols
507@cindex symbols, retaining selectively
508Retain @emph{only} the symbols listed in the file @var{filename},
509discarding all others. @var{filename} is simply a flat file, with one
510symbol name per line. This option is especially useful in environments
511@ifset GENERIC
512(such as VxWorks)
513@end ifset
514where a large global symbol table is accumulated gradually, to conserve
515run-time memory.
516
517@samp{-retain-symbols-file} does @emph{not} discard undefined symbols,
518or symbols needed for relocations.
519
520You may only specify @samp{-retain-symbols-file} once in the command
521line. It overrides @samp{-s} and @samp{-S}.
522
f22eee08 523@item -r
b4d4e8e3 524@cindex partial link
2c5c0674
RP
525@cindex relocatable output
526@kindex -r
ec40bbb8 527Generate relocatable output---i.e., generate an output file that can in
246504a5 528turn serve as input to @code{ld}. This is often called @dfn{partial
2c5c0674
RP
529linking}. As a side effect, in environments that support standard Unix
530magic numbers, this option also sets the output file's magic number to
531@code{OMAGIC}.
532@c ; see @code{-N}.
533If this option is not specified, an absolute file is produced. When
534linking C++ programs, this option @emph{will not} resolve references to
ec40bbb8 535constructors; to do that, use @samp{-Ur}.
2c5c0674 536
867a1b8a 537This option does the same thing as @samp{-i}.
f22eee08
RP
538
539@item -S
2c5c0674
RP
540@kindex -S
541@cindex strip debugger symbols
ec40bbb8 542Omit debugger symbol information (but not all symbols) from the output file.
f22eee08
RP
543
544@item -s
2c5c0674
RP
545@kindex -s
546@cindex strip all symbols
ec40bbb8 547Omit all symbol information from the output file.
f22eee08 548
2a28d8b0
DM
549@item -sort-common
550Normally, when @code{ld} places the global common symbols in the
551appropriate output sections, it sorts them by size. First come all the
552one byte symbols, then all the two bytes, then all the four bytes, and
836a5ee4
DM
553then everything else. This is to prevent gaps between symbols due to
554alignment constraints. This option disables that sorting.
2a28d8b0 555
8594f568
SS
556@item -stats
557Compute and display statistics about the operation of the linker,
558such as execution time and memory usage.
559
867a1b8a
DM
560@item -Tbss @var{org}
561@kindex -Tbss @var{org}
562@itemx -Tdata @var{org}
563@kindex -Tdata @var{org}
564@itemx -Ttext @var{org}
565@kindex -Ttext @var{org}
2c5c0674
RP
566@cindex segment origins, cmd line
567Use @var{org} as the starting address for---respectively---the
b4d4e8e3 568@code{bss}, @code{data}, or the @code{text} segment of the output file.
ec40bbb8
DM
569@var{org} must be a single hexadecimal integer;
570for compatibility with other linkers, you may omit the leading
d76ae847 571@samp{0x} usually associated with hexadecimal values.
f22eee08 572
b4d4e8e3
RP
573@item -T @var{commandfile}
574@itemx -T@var{commandfile}
2c5c0674 575@kindex -T @var{script}
2d59b2c3 576@cindex script files
de87cdb4 577Read link commands from the file @var{commandfile}. These commands
8de26d62
DM
578replace @code{ld}'s default link script (rather than adding
579to it), so @var{commandfile} must specify everything necessary to describe
de87cdb4
DM
580the target format. @xref{Commands}. If @var{commandfile} does not
581exist, @code{ld} looks for it in the directories specified by any
582preceding @samp{-L} options. Multiple @samp{-T} options accumulate.
f22eee08
RP
583
584@item -t
2c5c0674
RP
585@kindex -t
586@cindex verbose
587@cindex input files, displaying
ec40bbb8 588Print the names of the input files as @code{ld} processes them.
f22eee08 589
de87cdb4
DM
590@item -u @var{symbol}
591@kindex -u @var{symbol}
2c5c0674 592@cindex undefined symbol
de87cdb4 593Force @var{symbol} to be entered in the output file as an undefined symbol.
ec40bbb8
DM
594Doing this may, for example, trigger linking of additional modules from
595standard libraries. @samp{-u} may be repeated with different option
2c5c0674
RP
596arguments to enter additional undefined symbols.
597@c Nice idea, but no such command: This option is equivalent
598@c to the @code{EXTERN} linker command.
f22eee08 599
b4d4e8e3 600@item -Ur
2c5c0674 601@kindex -Ur
b4d4e8e3
RP
602@cindex constructors
603For anything other than C++ programs, this option is equivalent to
ec40bbb8
DM
604@samp{-r}: it generates relocatable output---i.e., an output file that can in
605turn serve as input to @code{ld}. When linking C++ programs, @samp{-Ur}
1fb57a5d 606@emph{does} resolve references to constructors, unlike @samp{-r}.
3e27cc11 607It does not work to use @samp{-Ur} on files that were themselves linked
1fb57a5d 608with @samp{-Ur}; once the constructor table has been built, it cannot
3e27cc11
DM
609be added to. Use @samp{-Ur} only for the last partial link, and
610@samp{-r} for the others.
b4d4e8e3 611
8ddef552
DM
612@item -V
613@kindex -V
614@cindex version
1fb57a5d
RP
615Display the version number for @code{ld} and list the linker emulations
616supported. Display which input files can and cannot be opened.
8ddef552 617
b4d4e8e3 618@item -v
2c5c0674 619@kindex -v
b4d4e8e3 620@cindex version
246504a5 621Display the version number for @code{ld}.
de87cdb4
DM
622
623@item --version
624@kindex --version
625Display the version number for @code{ld} and exit.
b4d4e8e3 626
2a28d8b0 627@item -warn-common
7f9ae73e
RP
628@kindex -warn-comon
629@cindex warnings, on combining symbols
630@cindex combining symbols, warnings on
2a28d8b0
DM
631Warn when a common symbol is combined with another common symbol or with
632a symbol definition. Unix linkers allow this somewhat sloppy practice,
633but linkers on some other operating systems do not. This option allows
634you to find potential problems from combining global symbols.
1cd4cca9
DM
635Unfortunately, some C libraries use this practice, so you may get some
636warnings about symbols in the libraries as well as in your programs.
2a28d8b0
DM
637
638There are three kinds of global symbols, illustrated here by C examples:
639
640@table @samp
641@item int i = 1;
642A definition, which goes in the initialized data section of the output
643file.
644
645@item extern int i;
646An undefined reference, which does not allocate space.
647There must be either a definition or a common symbol for the
648variable somewhere.
649
650@item int i;
651A common symbol. If there are only (one or more) common symbols for a
652variable, it goes in the uninitialized data area of the output file.
653The linker merges multiple common symbols for the same variable into a
654single symbol. If they are of different sizes, it picks the largest
655size. The linker turns a common symbol into a declaration, if there is
656a definition of the same variable.
657@end table
658
659The @samp{-warn-common} option can produce five kinds of warnings. Each
660warning consists of a pair of lines: the first describes the symbol just
661encountered, and the second describes the previous symbol encountered
662with the same name. One or both of the two symbols will be a common
663symbol.
664
665@enumerate
666@item
667Turning a common symbol into a reference, because there is already a
668definition for the symbol.
669@smallexample
8920addc
RP
670@var{file}(@var{section}): warning: common of `@var{symbol}'
671 overridden by definition
2a28d8b0
DM
672@var{file}(@var{section}): warning: defined here
673@end smallexample
674
675@item
676Turning a common symbol into a reference, because a later definition for
677the symbol is encountered. This is the same as the previous case,
678except that the symbols are encountered in a different order.
679@smallexample
8920addc
RP
680@var{file}(@var{section}): warning: definition of `@var{symbol}'
681 overriding common
2a28d8b0
DM
682@var{file}(@var{section}): warning: common is here
683@end smallexample
684
685@item
686Merging a common symbol with a previous same-sized common symbol.
687@smallexample
8920addc
RP
688@var{file}(@var{section}): warning: multiple common
689 of `@var{symbol}'
2a28d8b0
DM
690@var{file}(@var{section}): warning: previous common is here
691@end smallexample
692
693@item
694Merging a common symbol with a previous larger common symbol.
695@smallexample
8920addc
RP
696@var{file}(@var{section}): warning: common of `@var{symbol}'
697 overridden by larger common
2a28d8b0
DM
698@var{file}(@var{section}): warning: larger common is here
699@end smallexample
700
701@item
702Merging a common symbol with a previous smaller common symbol. This is
703the same as the previous case, except that the symbols are
704encountered in a different order.
705@smallexample
8920addc
RP
706@var{file}(@var{section}): warning: common of `@var{symbol}'
707 overriding smaller common
2a28d8b0
DM
708@var{file}(@var{section}): warning: smaller common is here
709@end smallexample
710@end enumerate
711
f22eee08 712@item -X
2c5c0674
RP
713@kindex -X
714@cindex local symbols, deleting
715@cindex L, deleting symbols beginning
ec40bbb8 716If @samp{-s} or @samp{-S} is also specified, delete only local symbols
f22eee08
RP
717beginning with @samp{L}.
718
b4d4e8e3 719@item -x
2c5c0674
RP
720@kindex -x
721@cindex deleting local symbols
ec40bbb8 722If @samp{-s} or @samp{-S} is also specified, delete all local symbols,
b4d4e8e3
RP
723not just those beginning with @samp{L}.
724
1fb57a5d
RP
725@item -y @var{symbol}
726@kindex -y @var{symbol}
d76ae847 727@cindex symbol tracing
ec40bbb8 728Print the name of each linked file in which @var{symbol} appears. This
d76ae847
RP
729option may be given any number of times. On many systems it is necessary
730to prepend an underscore.
731
732This option is useful when you have an undefined symbol in your link but
733don't know where the reference is coming from.
f22eee08 734@end table
b4d4e8e3 735
ec40bbb8
DM
736@ifset UsesEnvVars
737@node Environment
2c5c0674
RP
738@section Environment Variables
739
d76ae847
RP
740You can change the behavior of @code{ld} with the environment
741variable @code{GNUTARGET}.
2c5c0674
RP
742
743@kindex GNUTARGET
744@cindex default input format
745@code{GNUTARGET} determines the input-file object format if you don't
ec40bbb8 746use @samp{-b} (or its synonym @samp{-format}). Its value should be one
2c5c0674 747of the BFD names for an input format (@pxref{BFD}). If there is no
246504a5 748@code{GNUTARGET} in the environment, @code{ld} uses the natural format
8920addc 749of the target. If @code{GNUTARGET} is set to @code{default} then BFD attempts to discover the
2c5c0674
RP
750input format by examining binary input files; this method often
751succeeds, but there are potential ambiguities, since there is no method
ec40bbb8 752of ensuring that the magic number used to specify object-file formats is
2c5c0674
RP
753unique. However, the configuration procedure for BFD on each system
754places the conventional format for that system first in the search-list,
755so ambiguities are resolved in favor of convention.
ec40bbb8 756@end ifset
2c5c0674 757
ec40bbb8 758@node Commands
2c5c0674 759@chapter Command Language
f22eee08 760
2c5c0674 761@cindex command files
ec40bbb8 762The command language provides explicit control over the link process,
b4d4e8e3 763allowing complete specification of the mapping between the linker's
ec40bbb8 764input files and its output. It controls:
b4d4e8e3 765@itemize @bullet
2c5c0674
RP
766@item
767input files
768@item
769file formats
770@item
867a1b8a 771output file layout
2c5c0674
RP
772@item
773addresses of sections
774@item
775placement of common blocks
b4d4e8e3 776@end itemize
f22eee08 777
2c5c0674 778You may supply a command file (also known as a link script) to the
ec40bbb8 779linker either explicitly through the @samp{-T} option, or implicitly as
2c5c0674 780an ordinary file. If the linker opens a file which it cannot recognize
867a1b8a 781as a supported object or archive format, it reports an error.
2c5c0674 782
2c5c0674 783@menu
2d59b2c3
RP
784* Scripts:: Linker Scripts
785* Expressions:: Expressions
786* MEMORY:: MEMORY Command
787* SECTIONS:: SECTIONS Command
788* Entry Point:: The Entry Point
867a1b8a 789* Option Commands:: Option Commands
2c5c0674
RP
790@end menu
791
ec40bbb8 792@node Scripts
b4d4e8e3 793@section Linker Scripts
246504a5 794The @code{ld} command language is a collection of statements; some are
ec40bbb8
DM
795simple keywords setting a particular option, some are used to select and
796group input files or name output files; and two statement
b4d4e8e3
RP
797types have a fundamental and pervasive impact on the linking process.
798
2c5c0674
RP
799@cindex fundamental script commands
800@cindex commands, fundamental
801@cindex output file layout
802@cindex layout of output file
246504a5 803The most fundamental command of the @code{ld} command language is the
b4d4e8e3
RP
804@code{SECTIONS} command (@pxref{SECTIONS}). Every meaningful command
805script must have a @code{SECTIONS} command: it specifies a
806``picture'' of the output file's layout, in varying degrees of detail.
807No other command is required in all cases.
808
809The @code{MEMORY} command complements @code{SECTIONS} by describing the
2c5c0674 810available memory in the target architecture. This command is optional;
246504a5 811if you don't use a @code{MEMORY} command, @code{ld} assumes sufficient
2c5c0674
RP
812memory is available in a contiguous block for all output.
813@xref{MEMORY}.
b4d4e8e3 814
2c5c0674
RP
815@cindex comments
816You may include comments in linker scripts just as in C: delimited
817by @samp{/*} and @samp{*/}. As in C, comments are syntactically
818equivalent to whitespace.
819
ec40bbb8 820@node Expressions
f22eee08 821@section Expressions
2c5c0674
RP
822@cindex expression syntax
823@cindex arithmetic
b4d4e8e3
RP
824Many useful commands involve arithmetic expressions. The syntax for
825expressions in the command language is identical to that of C
826expressions, with the following features:
827@itemize @bullet
2c5c0674
RP
828@item
829All expressions evaluated as integers and
f22eee08 830are of ``long'' or ``unsigned long'' type.
2c5c0674
RP
831@item
832All constants are integers.
833@item
834All of the C arithmetic operators are provided.
835@item
836You may reference, define, and create global variables.
837@item
838You may call special purpose built-in functions.
b4d4e8e3 839@end itemize
f22eee08 840
2c5c0674 841@menu
2d59b2c3
RP
842* Integers:: Integers
843* Symbols:: Symbol Names
844* Location Counter:: The Location Counter
845* Operators:: Operators
846* Evaluation:: Evaluation
847* Assignment:: Assignment: Defining Symbols
867a1b8a 848* Arithmetic Functions:: Built-In Functions
2c5c0674
RP
849@end menu
850
ec40bbb8 851@node Integers
f22eee08 852@subsection Integers
2c5c0674
RP
853@cindex integer notation
854@cindex octal integers
f22eee08
RP
855An octal integer is @samp{0} followed by zero or more of the octal
856digits (@samp{01234567}).
b4d4e8e3 857@example
2c5c0674 858_as_octal = 0157255;
b4d4e8e3 859@end example
f22eee08 860
2c5c0674 861@cindex decimal integers
f22eee08
RP
862A decimal integer starts with a non-zero digit followed by zero or
863more digits (@samp{0123456789}).
b4d4e8e3 864@example
2c5c0674 865_as_decimal = 57005;
b4d4e8e3 866@end example
f22eee08 867
2c5c0674
RP
868@cindex hexadecimal integers
869@kindex 0x
f22eee08
RP
870A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
871more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
b4d4e8e3
RP
872@example
873_as_hex = 0xdead;
874@end example
f22eee08 875
2c5c0674 876@cindex negative integers
ec40bbb8 877To write a negative integer, use
b4d4e8e3
RP
878the prefix operator @samp{-}; @pxref{Operators}.
879@example
b4d4e8e3
RP
880_as_neg = -57005;
881@end example
f22eee08 882
2c5c0674
RP
883@cindex scaled integers
884@cindex K and M integer suffixes
885@cindex M and K integer suffixes
886@cindex suffixes for integers
887@cindex integer suffixes
b4d4e8e3
RP
888Additionally the suffixes @code{K} and @code{M} may be used to scale a
889constant by
c8072296
RP
890@c TEXI2ROFF-KILL
891@ifinfo
892@c END TEXI2ROFF-KILL
893@code{1024} or @code{1024*1024}
894@c TEXI2ROFF-KILL
895@end ifinfo
f22eee08 896@tex
b4d4e8e3 897${\rm 1024}$ or ${\rm 1024}^2$
f22eee08 898@end tex
c8072296 899@c END TEXI2ROFF-KILL
ec40bbb8 900respectively. For example, the following all refer to the same quantity:
f22eee08
RP
901
902@example
2c5c0674
RP
903 _fourk_1 = 4K;
904 _fourk_2 = 4096;
905 _fourk_3 = 0x1000;
f22eee08 906@end example
b4d4e8e3 907
ec40bbb8 908@node Symbols
b4d4e8e3 909@subsection Symbol Names
2c5c0674
RP
910@cindex symbol names
911@cindex names
912@cindex quoted symbol names
913@kindex "
1fb57a5d
RP
914Unless quoted, symbol names start with a letter, underscore, or point
915and may include any letters, underscores, digits, points,
916and hyphens. Unquoted symbol names must not conflict with any
b4d4e8e3
RP
917keywords. You can specify a symbol which contains odd characters or has
918the same name as a keyword, by surrounding the symbol name in double quotes:
919@example
920 "SECTION" = 9;
921 "with a space" = "also with a space" + 10;
922@end example
923
1fb57a5d
RP
924Since symbols can contain many non-alphabetic characters, it is safest
925to delimit symbols with spaces. For example, @samp{A-B} is one symbol,
926whereas @samp{A - B} is an expression involving subtraction.
927
ec40bbb8 928@node Location Counter
b4d4e8e3 929@subsection The Location Counter
2c5c0674
RP
930@kindex .
931@cindex dot
932@cindex location counter
933@cindex current output location
b4d4e8e3
RP
934The special linker variable @dfn{dot} @samp{.} always contains the
935current output location counter. Since the @code{.} always refers to
936a location in an output section, it must always appear in an
937expression within a @code{SECTIONS} command. The @code{.} symbol
938may appear anywhere that an ordinary symbol is allowed in an
939expression, but its assignments have a side effect. Assigning a value
940to the @code{.} symbol will cause the location counter to be moved.
2c5c0674 941@cindex holes
b4d4e8e3
RP
942This may be used to create holes in the output section. The location
943counter may never be moved backwards.
944@example
2c5c0674
RP
945SECTIONS
946@{
947 output :
b4d4e8e3 948 @{
2c5c0674
RP
949 file1(.text)
950 . = . + 1000;
951 file2(.text)
952 . += 1000;
953 file3(.text)
954 @} = 0x1234;
955@}
b4d4e8e3 956@end example
2c5c0674
RP
957@noindent
958In the previous example, @code{file1} is located at the beginning of the
959output section, then there is a 1000 byte gap. Then @code{file2}
960appears, also with a 1000 byte gap following before @code{file3} is
961loaded. The notation @samp{= 0x1234} specifies what data to write in
962the gaps (@pxref{Section Options}).
b4d4e8e3 963
ec40bbb8 964@node Operators
f22eee08 965@subsection Operators
2c5c0674
RP
966@cindex Operators for arithmetic
967@cindex arithmetic operators
968@cindex precedence in expressions
b4d4e8e3 969The linker recognizes the standard C set of arithmetic operators, with
f22eee08 970the standard bindings and precedence levels:
c8072296 971@c TEXI2ROFF-KILL
b4d4e8e3 972@ifinfo
c8072296 973@c END TEXI2ROFF-KILL
f22eee08 974@example
c8072296 975precedence associativity Operators Notes
b4d4e8e3 976(highest)
c8072296
RP
9771 left ! - ~ (1)
9782 left * / %
9793 left + -
9804 left >> <<
9815 left == != > < <= >=
9826 left &
9837 left |
9848 left &&
9859 left ||
98610 right ? :
98711 right &= += -= *= /= (2)
b4d4e8e3 988(lowest)
f22eee08 989@end example
2c5c0674
RP
990Notes:
991(1) Prefix operators
992(2) @xref{Assignment}
c8072296 993@c TEXI2ROFF-KILL
b4d4e8e3 994@end ifinfo
f22eee08 995@tex
2c5c0674
RP
996\vskip \baselineskip
997%"lispnarrowing" is the extra indent used generally for @example
998\hskip\lispnarrowing\vbox{\offinterlineskip
f22eee08
RP
999\hrule
1000\halign
2c5c0674
RP
1001{\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr
1002height2pt&\omit&&\omit&&\omit&\cr
1003&Precedence&& Associativity &&{\rm Operators}&\cr
1004height2pt&\omit&&\omit&&\omit&\cr
f22eee08 1005\noalign{\hrule}
2c5c0674 1006height2pt&\omit&&\omit&&\omit&\cr
b4d4e8e3 1007&highest&&&&&\cr
2c5c0674
RP
1008% '176 is tilde, '~' in tt font
1009&1&&left&&\qquad- \char'176\ !\qquad\dag&\cr
1010&2&&left&&* / \%&\cr
1011&3&&left&&+ -&\cr
1012&4&&left&&>> <<&\cr
1013&5&&left&&== != > < <= >=&\cr
f22eee08 1014&6&&left&&\&&\cr
f22eee08 1015&7&&left&&|&\cr
f22eee08 1016&8&&left&&{\&\&}&\cr
f22eee08 1017&9&&left&&||&\cr
2c5c0674
RP
1018&10&&right&&? :&\cr
1019&11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr
b4d4e8e3 1020&lowest&&&&&\cr
2c5c0674 1021height2pt&\omit&&\omit&&\omit&\cr}
f22eee08
RP
1022\hrule}
1023@end tex
2c5c0674
RP
1024@iftex
1025{
1026@obeylines@parskip=0pt@parindent=0pt
1027@dag@quad Prefix operators.
1028@ddag@quad @xref{Assignment}.
1029}
1030@end iftex
c8072296 1031@c END TEXI2ROFF-KILL
f22eee08 1032
ec40bbb8 1033@node Evaluation
b4d4e8e3
RP
1034@subsection Evaluation
1035
2c5c0674
RP
1036@cindex lazy evaluation
1037@cindex expression evaluation order
b4d4e8e3
RP
1038The linker uses ``lazy evaluation'' for expressions; it only calculates
1039an expression when absolutely necessary. The linker needs the value of
1040the start address, and the lengths of memory regions, in order to do any
1041linking at all; these values are computed as soon as possible when the
1042linker reads in the command file. However, other values (such as symbol
1043values) are not known or needed until after storage allocation. Such
1044values are evaluated later, when other information (such as the sizes of
1045output sections) is available for use in the symbol assignment
1046expression.
1047
ec40bbb8 1048@node Assignment
b4d4e8e3 1049@subsection Assignment: Defining Symbols
2c5c0674
RP
1050@cindex assignment in scripts
1051@cindex symbol definition, scripts
1052@cindex variables, defining
b4d4e8e3
RP
1053You may create global symbols, and assign values (addresses) to global
1054symbols, using any of the C assignment operators:
1055
1056@table @code
1057@item @var{symbol} = @var{expression} ;
2c5c0674 1058@itemx @var{symbol} &= @var{expression} ;
b4d4e8e3
RP
1059@itemx @var{symbol} += @var{expression} ;
1060@itemx @var{symbol} -= @var{expression} ;
1061@itemx @var{symbol} *= @var{expression} ;
1062@itemx @var{symbol} /= @var{expression} ;
1063@end table
1064
246504a5 1065Two things distinguish assignment from other operators in @code{ld}
b4d4e8e3
RP
1066expressions.
1067@itemize @bullet
2c5c0674
RP
1068@item
1069Assignment may only be used at the root of an expression;
b4d4e8e3 1070@samp{a=b+3;} is allowed, but @samp{a+b=3;} is an error.
2c5c0674
RP
1071
1072@kindex ;
1073@cindex semicolon
1074@item
d76ae847
RP
1075You must place a trailing semicolon (``@key{;}'') at the end of an
1076assignment statement.
b4d4e8e3
RP
1077@end itemize
1078
1079Assignment statements may appear:
1080@itemize @bullet
2c5c0674 1081@item
246504a5 1082as commands in their own right in an @code{ld} script; or
2c5c0674
RP
1083@item
1084as independent statements within a @code{SECTIONS} command; or
1085@item
1086as part of the contents of a section definition in a
b4d4e8e3
RP
1087@code{SECTIONS} command.
1088@end itemize
1089
1090The first two cases are equivalent in effect---both define a symbol with
ec40bbb8 1091an absolute address. The last case defines a symbol whose address is
b4d4e8e3
RP
1092relative to a particular section (@pxref{SECTIONS}).
1093
2c5c0674
RP
1094@cindex absolute and relocatable symbols
1095@cindex relocatable and absolute symbols
1096@cindex symbols, relocatable and absolute
1097When a linker expression is evaluated and assigned to a variable, it is
1098given either an absolute or a relocatable type. An absolute expression
1099type is one in which the symbol contains the value that it will have in
867a1b8a 1100the output file; a relocatable expression type is one in which the
2c5c0674 1101value is expressed as a fixed offset from the base of a section.
b4d4e8e3
RP
1102
1103The type of the expression is controlled by its position in the script
2c5c0674
RP
1104file. A symbol assigned within a section definition is created relative
1105to the base of the section; a symbol assigned in any other place is
1106created as an absolute symbol. Since a symbol created within a
1107section definition is relative to the base of the section, it
1108will remain relocatable if relocatable output is requested. A symbol
1109may be created with an absolute value even when assigned to within a
1110section definition by using the absolute assignment function
1111@code{ABSOLUTE}. For example, to create an absolute symbol whose address
1112is the last byte of an output section named @code{.data}:
b4d4e8e3 1113@example
2c5c0674 1114SECTIONS@{ @dots{}
b4d4e8e3
RP
1115.data :
1116 @{
1117 *(.data)
1118 _edata = ABSOLUTE(.) ;
1119 @}
2c5c0674 1120@dots{} @}
b4d4e8e3
RP
1121@end example
1122
2c5c0674
RP
1123The linker tries to put off the evaluation of an assignment until all
1124the terms in the source expression are known (@pxref{Evaluation}). For
ec40bbb8 1125instance, the sizes of sections cannot be known until after allocation,
2c5c0674
RP
1126so assignments dependent upon these are not performed until after
1127allocation. Some expressions, such as those depending upon the location
1128counter @dfn{dot}, @samp{.} must be evaluated during allocation. If the
1129result of an expression is required, but the value is not available,
1130then an error results. For example, a script like the following
b4d4e8e3 1131@example
2c5c0674 1132SECTIONS @{ @dots{}
cb70c872 1133 text 9+this_isnt_constant :
b4d4e8e3
RP
1134 @{ @dots{}
1135 @}
2c5c0674 1136@dots{} @}
b4d4e8e3 1137@end example
2c5c0674
RP
1138@kindex Non constant expression
1139@noindent
1140will cause the error message ``@code{Non constant expression for initial
b4d4e8e3
RP
1141address}''.
1142
867a1b8a
DM
1143@node Arithmetic Functions
1144@subsection Arithmetic Functions
2c5c0674 1145@cindex functions in expression language
ec40bbb8 1146The command language includes a number of built-in
2c5c0674
RP
1147functions for use in link script expressions.
1148@table @code
1149@item ABSOLUTE(@var{exp})
1150@kindex ABSOLUTE(@var{exp})
1151@cindex expression, absolute
ec40bbb8
DM
1152Return the absolute (non-relocatable, as opposed to non-negative) value
1153of the expression @var{exp}. Primarily useful to assign an absolute
1154value to a symbol within a section definition, where symbol values are
1155normally section-relative.
2c5c0674
RP
1156
1157@item ADDR(@var{section})
1158@kindex ADDR(@var{section})
1159@cindex section address
ec40bbb8 1160Return the absolute address of the named @var{section}. Your script must
b4d4e8e3 1161previously have defined the location of that section. In the following
ec40bbb8 1162example, @code{symbol_1} and @code{symbol_2} are assigned identical
b4d4e8e3 1163values:
f22eee08 1164@example
2c5c0674 1165SECTIONS@{ @dots{}
cb70c872 1166 .output1 :
f22eee08 1167 @{
2c5c0674
RP
1168 start_of_output_1 = ABSOLUTE(.);
1169 @dots{}
f22eee08 1170 @}
cb70c872 1171 .output :
f22eee08
RP
1172 @{
1173 symbol_1 = ADDR(.output1);
1174 symbol_2 = start_of_output_1;
1175 @}
2c5c0674
RP
1176@dots{} @}
1177@end example
1178
1179@item ALIGN(@var{exp})
1180@kindex ALIGN(@var{exp})
1181@cindex rounding up location counter
ec40bbb8 1182Return the result of the current location counter (@code{.}) aligned to
2c5c0674
RP
1183the next @var{exp} boundary. @var{exp} must be an expression whose
1184value is a power of two. This is equivalent to
1185@example
cb70c872 1186(. + @var{exp} - 1) & ~(@var{exp} - 1)
2c5c0674
RP
1187@end example
1188
1189@code{ALIGN} doesn't change the value of the location counter---it just
1190does arithmetic on it. As an example, to align the output @code{.data}
1191section to the next @code{0x2000} byte boundary after the preceding
1192section and to set a variable within the section to the next
1193@code{0x8000} boundary after the input sections:
1194@example
1195SECTIONS@{ @dots{}
1196 .data ALIGN(0x2000): @{
1197 *(.data)
1198 variable = ALIGN(0x8000);
1199 @}
1200@dots{} @}
1201@end example
1202@noindent
1203The first use of @code{ALIGN} in this example specifies the location of
1204a section because it is used as the optional @var{start} attribute of a
1205section definition (@pxref{Section Options}). The second use simply
1206defines the value of a variable.
1207
1208The built-in @code{NEXT} is closely related to @code{ALIGN}.
1209
1210@item DEFINED(@var{symbol})
1211@kindex DEFINED(@var{symbol})
1212@cindex symbol defaults
ec40bbb8
DM
1213Return 1 if @var{symbol} is in the linker global symbol table and is
1214defined, otherwise return 0. You can use this function to provide default
1215values for symbols. For example, the following command-file fragment shows how
2c5c0674
RP
1216to set a global symbol @code{begin} to the first location in the
1217@code{.text} section---but if a symbol called @code{begin} already
1218existed, its value is preserved:
c8072296 1219@smallexample
2c5c0674 1220SECTIONS@{ @dots{}
cb70c872 1221 .text : @{
2c5c0674
RP
1222 begin = DEFINED(begin) ? begin : . ;
1223 @dots{}
1224 @}
1225@dots{} @}
c8072296 1226@end smallexample
f22eee08 1227
2c5c0674
RP
1228@item NEXT(@var{exp})
1229@kindex NEXT(@var{exp})
1230@cindex unallocated address, next
ec40bbb8
DM
1231Return the next unallocated address that is a multiple of @var{exp}.
1232This function is closely related to @code{ALIGN(@var{exp})}; unless you
2c5c0674 1233use the @code{MEMORY} command to define discontinuous memory for the
ec40bbb8 1234output file, the two functions are equivalent.
2c5c0674
RP
1235
1236@item SIZEOF(@var{section})
1237@kindex SIZEOF(@var{section})
1238@cindex section size
ec40bbb8
DM
1239Return the size in bytes of the named @var{section}, if that section has
1240been allocated. In the following example, @code{symbol_1} and
f22eee08 1241@code{symbol_2} are assigned identical values:
ec40bbb8 1242@c What does it return if the section hasn't been allocated? 0?
f22eee08 1243@example
2c5c0674 1244SECTIONS@{ @dots{}
f22eee08
RP
1245 .output @{
1246 .start = . ;
2c5c0674 1247 @dots{}
cb70c872 1248 .end = . ;
f22eee08 1249 @}
cb70c872 1250 symbol_1 = .end - .start ;
f22eee08 1251 symbol_2 = SIZEOF(.output);
2c5c0674 1252@dots{} @}
f22eee08 1253
f22eee08 1254@end example
b4d4e8e3 1255
2c5c0674
RP
1256@item SIZEOF_HEADERS
1257@kindex SIZEOF_HEADERS
1258@cindex header size
1259@itemx sizeof_headers
1260@kindex sizeof_headers
ec40bbb8 1261Return the size in bytes of the output file's headers. You can use this number
2c5c0674
RP
1262as the start address of the first section, if you choose, to facilitate
1263paging.
1264
1265@end table
1266
ec40bbb8 1267@node MEMORY
867a1b8a 1268@section Memory Layout
2c5c0674
RP
1269@kindex MEMORY
1270@cindex regions of memory
1271@cindex discontinuous memory
1272@cindex allocating memory
ec40bbb8
DM
1273The linker's default configuration permits allocation of all available memory.
1274You can override this configuration by using the @code{MEMORY} command. The
b4d4e8e3
RP
1275@code{MEMORY} command describes the location and size of blocks of
1276memory in the target. By using it carefully, you can describe which
1277memory regions may be used by the linker, and which memory regions it
1278must avoid. The linker does not shuffle sections to fit into the
1279available regions, but does move the requested sections into the correct
1280regions and issue errors when the regions become too full.
1281
867a1b8a 1282A command file may contain at most one use of the @code{MEMORY}
b4d4e8e3
RP
1283command; however, you can define as many blocks of memory within it as
1284you wish. The syntax is:
c8072296 1285
f22eee08 1286@example
b4d4e8e3
RP
1287MEMORY
1288 @{
cb70c872 1289 @var{name} (@var{attr}) : ORIGIN = @var{origin}, LENGTH = @var{len}
2c5c0674 1290 @dots{}
b4d4e8e3 1291 @}
f22eee08
RP
1292@end example
1293@table @code
1294@item @var{name}
2c5c0674 1295@cindex naming memory regions
f22eee08
RP
1296is a name used internally by the linker to refer to the region. Any
1297symbol name may be used. The region names are stored in a separate
ec40bbb8 1298name space, and will not conflict with symbols, file names or section
b4d4e8e3
RP
1299names. Use distinct names to specify multiple regions.
1300@item (@var{attr})
2c5c0674
RP
1301@cindex memory region attributes
1302is an optional list of attributes, permitted for compatibility with the
246504a5 1303AT&T linker but not used by @code{ld} beyond checking that the
2c5c0674
RP
1304attribute list is valid. Valid attribute lists must be made up of the
1305characters ``@code{LIRWX}''. If you omit the attribute list, you may
1306omit the parentheses around it as well.
f22eee08 1307@item @var{origin}
cb70c872
RP
1308@kindex ORIGIN =
1309@kindex o =
1310@kindex org =
ec40bbb8
DM
1311is the start address of the region in physical memory. It is
1312an expression that must evaluate to a constant before
f22eee08 1313memory allocation is performed. The keyword @code{ORIGIN} may be
867a1b8a 1314abbreviated to @code{org} or @code{o} (but not, for example, @samp{ORG}).
f22eee08 1315@item @var{len}
cb70c872
RP
1316@kindex LENGTH =
1317@kindex len =
1318@kindex l =
b4d4e8e3 1319is the size in bytes of the region (an expression).
2c5c0674 1320The keyword @code{LENGTH} may be abbreviated to @code{len} or @code{l}.
f22eee08
RP
1321@end table
1322
1323For example, to specify that memory has two regions available for
ec40bbb8 1324allocation---one starting at 0 for 256 kilobytes, and the other
2c5c0674 1325starting at @code{0x40000000} for four megabytes:
f22eee08
RP
1326
1327@example
b4d4e8e3
RP
1328MEMORY
1329 @{
cb70c872
RP
1330 rom : ORIGIN = 0, LENGTH = 256K
1331 ram : org = 0x40000000, l = 4M
b4d4e8e3 1332 @}
f22eee08
RP
1333@end example
1334
b4d4e8e3 1335Once you have defined a region of memory named @var{mem}, you can direct
2c5c0674
RP
1336specific output sections there by using a command ending in
1337@samp{>@var{mem}} within the @code{SECTIONS} command (@pxref{Section
1338Options}). If the combined output sections directed to a region are too
1339big for the region, the linker will issue an error message.
b4d4e8e3 1340
ec40bbb8 1341@node SECTIONS
867a1b8a 1342@section Specifying Output Sections
67c4333b 1343
2c5c0674 1344@kindex SECTIONS
b4d4e8e3 1345The @code{SECTIONS} command controls exactly where input sections are
867a1b8a
DM
1346placed into output sections, their order in the output file, and to
1347which output sections they are allocated.
b4d4e8e3 1348
867a1b8a 1349You may use at most one @code{SECTIONS} command in a script file,
b4d4e8e3
RP
1350but you can have as many statements within it as you wish. Statements
1351within the @code{SECTIONS} command can do one of three things:
67c4333b 1352
b4d4e8e3
RP
1353@itemize @bullet
1354@item
1355define the entry point;
67c4333b 1356
b4d4e8e3
RP
1357@item
1358assign a value to a symbol;
67c4333b 1359
b4d4e8e3 1360@item
867a1b8a
DM
1361describe the placement of a named output section, and which input
1362sections go into it.
b4d4e8e3
RP
1363@end itemize
1364
8920addc
RP
1365You can also use the first two operations---defining the entry point and
1366defining symbols---outside the @code{SECTIONS} command: @pxref{Entry
1367Point}, and @pxref{Assignment}. They are permitted here as well for
1368your convenience in reading the script, so that symbols and the entry
1369point can be defined at meaningful points in your output-file layout.
f22eee08 1370
67c4333b 1371If you do not use a @code{SECTIONS} command, the linker places each input
867a1b8a
DM
1372section into an identically named output section in the order that the
1373sections are first encountered in the input files. If all input sections
1374are present in the first file, for example, the order of sections in the
1375output file will match the order in the first input file.
b4d4e8e3 1376
2c5c0674 1377@menu
2d59b2c3 1378* Section Definition:: Section Definitions
867a1b8a
DM
1379* Section Placement:: Section Placement
1380* Section Data Expressions:: Section Data Expressions
2d59b2c3 1381* Section Options:: Optional Section Attributes
2c5c0674
RP
1382@end menu
1383
ec40bbb8 1384@node Section Definition
b4d4e8e3 1385@subsection Section Definitions
2c5c0674 1386@cindex section definition
b4d4e8e3 1387The most frequently used statement in the @code{SECTIONS} command is
867a1b8a 1388the @dfn{section definition}, which specifies the
b4d4e8e3 1389properties of an output section: its location, alignment, contents,
ec40bbb8 1390fill pattern, and target memory region. Most of
b4d4e8e3
RP
1391these specifications are optional; the simplest form of a section
1392definition is
1393@example
2c5c0674 1394SECTIONS @{ @dots{}
b4d4e8e3
RP
1395@var{secname} : @{
1396 @var{contents}
1397 @}
2c5c0674 1398@dots{} @}
b4d4e8e3 1399@end example
2c5c0674 1400@cindex naming output sections
b4d4e8e3
RP
1401@noindent
1402@var{secname} is the name of the output section, and @var{contents} a
ec40bbb8 1403specification of what goes there---for example, a list of input files or
867a1b8a
DM
1404sections of input files (@pxref{Section Placement}). As you might
1405assume, the whitespace shown is optional. You do need the colon
1406@samp{:} and the braces @samp{@{@}}, however.
b4d4e8e3
RP
1407
1408@var{secname} must meet the constraints of your output format. In
1409formats which only support a limited number of sections, such as
1410@code{a.out}, the name must be one of the names supported by the format
2c5c0674
RP
1411(@code{a.out}, for example, allows only @code{.text}, @code{.data} or
1412@code{.bss}). If the output format supports any number of sections, but
1413with numbers and not names (as is the case for Oasys), the name should be
1414supplied as a quoted numeric string. A section name may consist of any
867a1b8a 1415sequence of characters, but any name which does not conform to the standard
246504a5 1416@code{ld} symbol name syntax must be quoted.
ec40bbb8 1417@xref{Symbols, , Symbol Names}.
2c5c0674 1418
867a1b8a
DM
1419@node Section Placement
1420@subsection Section Placement
67c4333b 1421
2c5c0674 1422@cindex contents of a section
67c4333b
RP
1423In a section definition, you can specify the contents of an output
1424section by listing particular input files, by listing particular
1425input-file sections, or by a combination of the two. You can also place
1426arbitrary data in the section, and define symbols relative to the
1427beginning of the section.
b4d4e8e3
RP
1428
1429The @var{contents} of a section definition may include any of the
1430following kinds of statement. You can include as many of these as you
1431like in a single section definition, separated from one another by
1432whitespace.
f22eee08 1433
b4d4e8e3 1434@table @code
b4d4e8e3 1435@item @var{filename}
2c5c0674
RP
1436@kindex @var{filename}
1437@cindex input files, section defn
1438@cindex files, including in output sections
b4d4e8e3 1439You may simply name a particular input file to be placed in the current
2c5c0674 1440output section; @emph{all} sections from that file are placed in the
867a1b8a
DM
1441current section definition. If the file name has already been mentioned
1442in another section definition, with an explicit section name list, then
1443only those sections which have not yet been allocated are used.
1444
1445To specify a list of particular files by name:
f22eee08 1446@example
cb70c872 1447.data : @{ afile.o bfile.o cfile.o @}
f22eee08 1448@end example
2c5c0674
RP
1449@noindent
1450The example also illustrates that multiple statements can be included in
ec40bbb8 1451the contents of a section definition, since each file name is a separate
2c5c0674 1452statement.
f22eee08 1453
2c5c0674
RP
1454@item @var{filename}( @var{section} )
1455@itemx @var{filename}( @var{section}, @var{section}, @dots{} )
1456@itemx @var{filename}( @var{section} @var{section} @dots{} )
1457@kindex @var{filename}(@var{section})
1458@cindex files and sections, section defn
1459You can name one or more sections from your input files, for
1460insertion in the current output section. If you wish to specify a list
1461of input-file sections inside the parentheses, you may separate the
1462section names by either commas or whitespace.
1463
b4d4e8e3
RP
1464@item * (@var{section})
1465@itemx * (@var{section}, @var{section}, @dots{})
836a5ee4 1466@itemx * (@var{section} @var{section} @dots{})
2c5c0674
RP
1467@cindex input sections to output section
1468@kindex *(@var{section})
b4d4e8e3 1469Instead of explicitly naming particular input files in a link control
246504a5 1470script, you can refer to @emph{all} files from the @code{ld} command
ec40bbb8 1471line: use @samp{*} instead of a particular file name before the
b4d4e8e3
RP
1472parenthesized input-file section list.
1473
867a1b8a
DM
1474If you have already explicitly included some files by name, @samp{*}
1475refers to all @emph{remaining} files---those whose places in the output
1476file have not yet been defined.
1477
ec40bbb8 1478For example, to copy sections @code{1} through @code{4} from an Oasys file
b4d4e8e3
RP
1479into the @code{.text} section of an @code{a.out} file, and sections @code{13}
1480and @code{14} into the @code{.data} section:
1481@example
2c5c0674 1482SECTIONS @{
b4d4e8e3
RP
1483 .text :@{
1484 *("1" "2" "3" "4")
1485 @}
f22eee08 1486
b4d4e8e3
RP
1487 .data :@{
1488 *("13" "14")
f22eee08 1489 @}
b4d4e8e3 1490@}
f22eee08
RP
1491@end example
1492
836a5ee4
DM
1493@samp{[ @var{section} @dots{} ]} used to be accepted as an alternate way
1494to specify named sections from all unallocated input files. Because
1495some operating systems (VMS) allow brackets in file names, that notation
1496is no longer supported.
1497
b4d4e8e3 1498@item @var{filename}@code{( COMMON )}
836a5ee4
DM
1499@itemx *( COMMON )
1500@kindex *( COMMON )
2c5c0674
RP
1501@cindex uninitialized data
1502@cindex commons in output
b4d4e8e3 1503Specify where in your output file to place uninitialized data
d76ae847 1504with this notation. @code{*(COMMON)} by itself refers to all
b4d4e8e3
RP
1505uninitialized data from all input files (so far as it is not yet
1506allocated); @var{filename}@code{(COMMON)} refers to uninitialized data
1507from a particular file. Both are special cases of the general
1508mechanisms for specifying where to place input-file sections:
246504a5 1509@code{ld} permits you to refer to uninitialized data as if it
b4d4e8e3
RP
1510were in an input-file section named @code{COMMON}, regardless of the
1511input file's format.
1512@end table
1513
2c5c0674 1514For example, the following command script arranges the output file into
b4d4e8e3
RP
1515three consecutive sections, named @code{.text}, @code{.data}, and
1516@code{.bss}, taking the input for each from the correspondingly named
1517sections of all the input files:
f22eee08 1518@example
2c5c0674 1519SECTIONS @{
d76ae847
RP
1520 .text : @{ *(.text) @}
1521 .data : @{ *(.data) @}
1522 .bss : @{ *(.bss) *(COMMON) @}
2c5c0674 1523@}
f22eee08 1524@end example
b4d4e8e3
RP
1525
1526The following example reads all of the sections from file @code{all.o}
1527and places them at the start of output section @code{outputa} which
1528starts at location @code{0x10000}. All of section @code{.input1} from
1529file @code{foo.o} follows immediately, in the same output section. All
1530of section @code{.input2} from @code{foo.o} goes into output section
1531@code{outputb}, followed by section @code{.input1} from @code{foo1.o}.
1532All of the remaining @code{.input1} and @code{.input2} sections from any
1533files are written to output section @code{outputc}.
1534
1535@example
2c5c0674 1536SECTIONS @{
b4d4e8e3
RP
1537 outputa 0x10000 :
1538 @{
1539 all.o
1540 foo.o (.input1)
f22eee08 1541 @}
b4d4e8e3
RP
1542 outputb :
1543 @{
1544 foo.o (.input2)
1545 foo1.o (.input1)
f22eee08 1546 @}
b4d4e8e3
RP
1547 outputc :
1548 @{
1549 *(.input1)
1550 *(.input2)
f22eee08 1551 @}
2c5c0674 1552@}
b4d4e8e3
RP
1553@end example
1554
867a1b8a
DM
1555@node Section Data Expressions
1556@subsection Section Data Expressions
67c4333b 1557
867a1b8a 1558@cindex expressions in a section
67c4333b
RP
1559The foregoing statements arrange, in your output file, data originating
1560from your input files. You can also place data directly in an output
1561section from the link command script. Most of these additional
1562statements involve expressions; @pxref{Expressions}. Although these
1563statements are shown separately here for ease of presentation, no such
1564segregation is needed within a section definition in the @code{SECTIONS}
1565command; you can intermix them freely with any of the statements we've
1566just described.
f22eee08 1567
b4d4e8e3
RP
1568@table @code
1569@item CREATE_OBJECT_SYMBOLS
2c5c0674
RP
1570@kindex CREATE_OBJECT_SYMBOLS
1571@cindex input filename symbols
1572@cindex filename symbols
ec40bbb8
DM
1573Create a symbol for each input file
1574in the current section, set to the address of the first byte of
867a1b8a 1575data written from that input file. For instance, with @code{a.out}
b4d4e8e3
RP
1576files it is conventional to have a symbol for each input file. You can
1577accomplish this by defining the output @code{.text} section as follows:
1578@example
1579SECTIONS @{
1580 .text 0x2020 :
1581 @{
1582 CREATE_OBJECT_SYMBOLS
1583 *(.text)
1584 _etext = ALIGN(0x2000);
f22eee08 1585 @}
2c5c0674
RP
1586 @dots{}
1587@}
f22eee08 1588@end example
b4d4e8e3 1589
867a1b8a 1590If @code{sample.ld} is a file containing this script, and @code{a.o},
b4d4e8e3
RP
1591@code{b.o}, @code{c.o}, and @code{d.o} are four input files with
1592contents like the following---
f22eee08 1593@example
b4d4e8e3
RP
1594/* a.c */
1595
2c5c0674 1596afunction() @{ @}
b4d4e8e3
RP
1597int adata=1;
1598int abss;
1599@end example
f22eee08 1600
b4d4e8e3 1601@noindent
867a1b8a 1602@samp{ld -M -T sample.ld a.o b.o c.o d.o} would create a map like this,
b4d4e8e3
RP
1603containing symbols matching the object file names:
1604@example
f22eee08
RP
160500000000 A __DYNAMIC
160600004020 B _abss
160700004000 D _adata
160800002020 T _afunction
160900004024 B _bbss
161000004008 D _bdata
161100002038 T _bfunction
161200004028 B _cbss
161300004010 D _cdata
161400002050 T _cfunction
16150000402c B _dbss
161600004018 D _ddata
161700002068 T _dfunction
161800004020 D _edata
161900004030 B _end
162000004000 T _etext
162100002020 t a.o
162200002038 t b.o
162300002050 t c.o
162400002068 t d.o
f22eee08
RP
1625@end example
1626
b4d4e8e3 1627@item @var{symbol} = @var{expression} ;
2c5c0674 1628@kindex @var{symbol} = @var{expression} ;
b4d4e8e3 1629@itemx @var{symbol} @var{f}= @var{expression} ;
2c5c0674
RP
1630@kindex @var{symbol} @var{f}= @var{expression} ;
1631@var{symbol} is any symbol name (@pxref{Symbols}). ``@var{f}=''
1632refers to any of the operators @code{&= += -= *= /=} which combine
1633arithmetic and assignment.
1634
1635@cindex assignment, in section defn
1636When you assign a value to a symbol within a particular section
1637definition, the value is relative to the beginning of the section
1638(@pxref{Assignment}). If you write
b4d4e8e3 1639@example
2c5c0674 1640SECTIONS @{
b4d4e8e3 1641 abs = 14 ;
2c5c0674 1642 @dots{}
cb70c872 1643 .data : @{ @dots{} rel = 14 ; @dots{} @}
b4d4e8e3 1644 abs2 = 14 + ADDR(.data);
2c5c0674
RP
1645 @dots{}
1646@}
f22eee08 1647@end example
2c5c0674 1648@c FIXME: Try above example!
b4d4e8e3 1649@noindent
ec40bbb8 1650@code{abs} and @code{rel} do not have the same value; @code{rel} has the
b4d4e8e3
RP
1651same value as @code{abs2}.
1652
b4d4e8e3 1653@item BYTE(@var{expression})
2c5c0674 1654@kindex BYTE(@var{expression})
b4d4e8e3 1655@itemx SHORT(@var{expression})
2c5c0674 1656@kindex SHORT(@var{expression})
b4d4e8e3 1657@itemx LONG(@var{expression})
2c5c0674 1658@kindex LONG(@var{expression})
c477527c
ILT
1659@itemx QUAD(@var{expression})
1660@kindex QUAD(@var{expression})
2c5c0674 1661@cindex direct output
c477527c
ILT
1662By including one of these four statements in a section definition, you
1663can explicitly place one, two, four, or eight bytes (respectively) at
1664the current address of that section. @code{QUAD} is only supported when
1665using a 64 bit host or target.
ec40bbb8
DM
1666
1667@ifclear SingleFormat
1668Multiple-byte quantities are represented in whatever byte order is
1669appropriate for the output file format (@pxref{BFD}).
1670@end ifclear
b4d4e8e3
RP
1671
1672@item FILL(@var{expression})
2c5c0674
RP
1673@kindex FILL(@var{expression})
1674@cindex holes, filling
1675@cindex unspecified memory
867a1b8a 1676Specify the ``fill pattern'' for the current section. Any otherwise
b4d4e8e3
RP
1677unspecified regions of memory within the section (for example, regions
1678you skip over by assigning a new value to the location counter @samp{.})
1679are filled with the two least significant bytes from the
1680@var{expression} argument. A @code{FILL} statement covers memory
1681locations @emph{after} the point it occurs in the section definition; by
1682including more than one @code{FILL} statement, you can have different
1683fill patterns in different parts of an output section.
1684@end table
1685
ec40bbb8 1686@node Section Options
b4d4e8e3 1687@subsection Optional Section Attributes
2c5c0674 1688@cindex section defn, full syntax
b4d4e8e3
RP
1689Here is the full syntax of a section definition, including all the
1690optional portions:
1691
d76ae847 1692@smallexample
2c5c0674
RP
1693SECTIONS @{
1694@dots{}
67c4333b
RP
1695@var{secname} @var{start} BLOCK(@var{align}) (NOLOAD) : AT ( @var{ldadr} )
1696 @{ @var{contents} @} =@var{fill} >@var{region}
2c5c0674 1697@dots{}
b4d4e8e3 1698@}
d76ae847 1699@end smallexample
b4d4e8e3
RP
1700
1701@var{secname} and @var{contents} are required. @xref{Section
67c4333b
RP
1702Definition}, and @pxref{Section Placement} for details on
1703@var{contents}. The remaining elements---@var{start},
1704@code{BLOCK(@var{align)}}, @code{(NOLOAD)}, @code{AT ( @var{ldadr} )},
1705@code{=@var{fill}}, and @code{>@var{region}}---are all optional.
f22eee08 1706
b4d4e8e3
RP
1707@table @code
1708@item @var{start}
2c5c0674
RP
1709@cindex start address, section
1710@cindex section start
1711@cindex section address
b4d4e8e3
RP
1712You can force the output section to be loaded at a specified address by
1713specifying @var{start} immediately following the section name.
1714@var{start} can be represented as any expression. The following
1715example generates section @var{output} at location
1716@code{0x40000000}:
1717@example
1718SECTIONS @{
2c5c0674 1719 @dots{}
b4d4e8e3
RP
1720 output 0x40000000: @{
1721 @dots{}
1722 @}
2c5c0674 1723 @dots{}
b4d4e8e3 1724@}
f22eee08 1725@end example
f22eee08 1726
b4d4e8e3 1727@item BLOCK(@var{align})
2c5c0674
RP
1728@kindex BLOCK(@var{align})
1729@cindex section alignment
1730@cindex aligning sections
ec40bbb8 1731You can include @code{BLOCK()} specification to advance
2c5c0674
RP
1732the location counter @code{.} prior to the beginning of the section, so
1733that the section will begin at the specified alignment. @var{align} is
1734an expression.
f22eee08 1735
d76ae847
RP
1736@kindex NOLOAD
1737@cindex prevent unnecessary loading
67c4333b
RP
1738@cindex loading, preventing
1739@item (NOLOAD)
d76ae847
RP
1740Use @samp{(NOLOAD)} to prevent a section from being loaded into memory
1741each time it is accessed. For example, in the script sample below, the
1742@code{ROM} segment is addressed at memory location @samp{0} and does not
1743need to be loaded into each object file:
67c4333b 1744
d76ae847
RP
1745@example
1746SECTIONS @{
1747 ROM 0 (NOLOAD) : @{ @dots{} @}
1748 @dots{}
1749@}
1750@end example
1751
67c4333b
RP
1752@kindex AT ( @var{ldadr} )
1753@cindex specify load address
1754@cindex load address, specifying
1755@item AT ( @var{ldadr} )
1756The expression @var{ldadr} that follows the @code{AT} keyword specifies
1757the load address of the section. The default (if you do not use the
1758@code{AT} keyword) is to make the load address the same as the
1759relocation address. This feature is designed to make it easy to build a
1760ROM image. For example, this @code{SECTIONS} definition creates two
1761output sections: one called @samp{.text}, which starts at @code{0x1000},
1762and one called @samp{.mdata}, which is loaded at the end of the
1763@samp{.text} section even though its relocation address is
1764@code{0x2000}. The symbol @code{_data} is defined with the value
1765@code{0x2000}:
1766
1767@smallexample
1768SECTIONS
139c8857
RP
1769 @{
1770 .text 0x1000 : @{ *(.text) _etext = . ; @}
1771 .mdata 0x2000 :
1772 AT ( ADDR(.text) + SIZEOF ( .text ) )
1773 @{ _data = . ; *(.data); _edata = . ; @}
1774 .bss 0x3000 :
1775 @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@}
67c4333b
RP
1776@}
1777@end smallexample
1778
1779The run-time initialization code (for C programs, usually @code{crt0})
1780for use with a ROM generated this way has to include something like
1781the following, to copy the initialized data from the ROM image to its runtime
1782address:
1783
139c8857 1784@smallexample
67c4333b
RP
1785char *src = _etext;
1786char *dst = _data;
1787
139c8857 1788/* ROM has data at end of text; copy it. */
67c4333b 1789while (dst < _edata) @{
139c8857 1790 *dst++ = *src++;
67c4333b
RP
1791@}
1792
1793/* Zero bss */
1794for (dst = _bstart; dst< _bend; dst++)
139c8857
RP
1795 *dst = 0;
1796@end smallexample
67c4333b 1797
b4d4e8e3 1798@item =@var{fill}
2c5c0674
RP
1799@kindex =@var{fill}
1800@cindex section fill pattern
1801@cindex fill pattern, entire section
ec40bbb8 1802Including
b4d4e8e3 1803@code{=@var{fill}} in a section definition specifies the initial fill
ec40bbb8
DM
1804value for that section.
1805You may use any expression to specify @var{fill}.
1806Any unallocated holes in the current output
b4d4e8e3
RP
1807section when written to the output file will be filled with the two
1808least significant bytes of the value, repeated as necessary. You can
1809also change the fill value with a @code{FILL} statement in the
1810@var{contents} of a section definition.
f22eee08 1811
b4d4e8e3 1812@item >@var{region}
2c5c0674
RP
1813@kindex >@var{region}
1814@cindex section, assigning to memory region
1815@cindex memory regions and sections
1816Assign this section to a previously defined region of memory.
1817@xref{MEMORY}.
f22eee08 1818
f22eee08 1819@end table
b4d4e8e3 1820
ec40bbb8 1821@node Entry Point
b4d4e8e3 1822@section The Entry Point
2c5c0674
RP
1823@kindex ENTRY(@var{symbol})
1824@cindex start of execution
1825@cindex first instruction
b4d4e8e3
RP
1826The linker command language includes a command specifically for
1827defining the first executable instruction in an output file (its
1828@dfn{entry point}). Its argument is a symbol name:
f22eee08 1829@example
b4d4e8e3 1830ENTRY(@var{symbol})
f22eee08 1831@end example
b4d4e8e3
RP
1832
1833Like symbol assignments, the @code{ENTRY} command may be placed either
1834as an independent command in the command file, or among the section
1835definitions within the @code{SECTIONS} command---whatever makes the most
1836sense for your layout.
1837
2c5c0674 1838@cindex entry point, defaults
b4d4e8e3
RP
1839@code{ENTRY} is only one of several ways of choosing the entry point.
1840You may indicate it in any of the following ways (shown in descending
1841order of priority: methods higher in the list override methods lower down).
f22eee08
RP
1842@itemize @bullet
1843@item
ec40bbb8 1844the @samp{-e} @var{entry} command-line option;
f22eee08 1845@item
8de26d62 1846the @code{ENTRY(@var{symbol})} command in a linker control script;
f22eee08 1847@item
b4d4e8e3 1848the value of the symbol @code{start}, if present;
f22eee08 1849@item
b4d4e8e3 1850the value of the symbol @code{_main}, if present;
f22eee08 1851@item
b4d4e8e3 1852the address of the first byte of the @code{.text} section, if present;
f22eee08 1853@item
b4d4e8e3 1854The address @code{0}.
f22eee08 1855@end itemize
b4d4e8e3 1856
2c5c0674
RP
1857For example, you can use these rules to generate an entry point with an
1858assignment statement: if no symbol @code{start} is defined within your
1859input files, you can simply define it, assigning it an appropriate
1860value---
f22eee08 1861@example
b4d4e8e3 1862start = 0x2020;
f22eee08 1863@end example
b4d4e8e3
RP
1864
1865@noindent
1866The example shows an absolute address, but you can use any expression.
1867For example, if your input object files use some other symbol-name
1868convention for the entry point, you can just assign the value of
1869whatever symbol contains the start address to @code{start}:
f22eee08 1870@example
cb70c872 1871start = other_symbol ;
f22eee08 1872@end example
f22eee08 1873
867a1b8a
DM
1874@node Option Commands
1875@section Option Commands
b4d4e8e3
RP
1876The command language includes a number of other commands that you can
1877use for specialized purposes. They are similar in purpose to
1878command-line options.
1879
1880@table @code
1fb57a5d
RP
1881@kindex CONSTRUCTORS
1882@cindex C++ constructors, arranging in link
1883@cindex constructors, arranging in link
1884@item CONSTRUCTORS
1885This command ties up C++ style constructor and destructor records. The
1886details of the constructor representation vary from one object format to
1887another, but usually lists of constructors and destructors appear as
1888special sections. The @code{CONSTRUCTORS} command specifies where the
1889linker is to place the data from these sections, relative to the rest of
1890the linked output. Constructor data is marked by the symbol
1891@w{@code{__CTOR_LIST__}} at the start, and @w{@code{__CTOR_LIST_END}} at
1892the end; destructor data is bracketed similarly, between
1893@w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_LIST_END}}. (The compiler
1894must arrange to actually run this code; GNU C++ calls constructors from
1895a subroutine @code{__main}, which it inserts automatically into the
1896startup code for @code{main}, and destructors from @code{_exit}.)
1897
2c5c0674 1898@kindex FLOAT
2c5c0674 1899@kindex NOFLOAT
1fb57a5d
RP
1900@item FLOAT
1901@itemx NOFLOAT
2c5c0674 1902These keywords were used in some older linkers to request a particular
246504a5 1903math subroutine library. @code{ld} doesn't use the keywords, assuming
2c5c0674
RP
1904instead that any necessary subroutines are in libraries specified using
1905the general mechanisms for linking to archives; but to permit the use of
1906scripts that were written for the older linkers, the keywords
1907@code{FLOAT} and @code{NOFLOAT} are accepted and ignored.
1908
2c5c0674
RP
1909@kindex FORCE_COMMON_ALLOCATION
1910@cindex common allocation
1fb57a5d 1911@item FORCE_COMMON_ALLOCATION
ec40bbb8 1912This command has the same effect as the @samp{-d} command-line option:
2c5c0674 1913to make @code{ld} assign space to common symbols even if a relocatable
ec40bbb8 1914output file is specified (@samp{-r}).
b4d4e8e3 1915
2c5c0674 1916@kindex INPUT ( @var{files} )
2c5c0674 1917@cindex binary input files
1fb57a5d
RP
1918@item INPUT ( @var{file}, @var{file}, @dots{} )
1919@itemx INPUT ( @var{file} @var{file} @dots{} )
2c5c0674 1920Use this command to include binary input files in the link, without
7f9ae73e
RP
1921including them in a particular section definition.
1922Specify the full name for each @var{file}, including @samp{.a} if
1923required.
1924
1925@code{ld} searches for each @var{file} through the archive-library
1926search path, just as for files you specify on the command line.
1927See the description of @samp{-L} in @ref{Options,,Command Line
1928Options}.
b4d4e8e3 1929
2c5c0674 1930@ignore
b4d4e8e3 1931@item MAP ( @var{name} )
2c5c0674
RP
1932@kindex MAP ( @var{name} )
1933@c MAP(...) appears to look for an F in the arg, ignoring all other
1934@c chars; if it finds one, it sets "map_option_f" to true. But nothing
1935@c checks map_option_f. Apparently a stub for the future...
1936@end ignore
b4d4e8e3
RP
1937
1938@item OUTPUT ( @var{filename} )
2c5c0674
RP
1939@kindex OUTPUT ( @var{filename} )
1940@cindex naming the output file
d76ae847
RP
1941Use this command to name the link output file @var{filename}. The
1942effect of @code{OUTPUT(@var{filename})} is identical to the effect of
c477527c
ILT
1943@w{@samp{-o @var{filename}}}, which overrides it. You can use this
1944command to supply a default output-file name other than @code{a.out}.
2c5c0674 1945
ec40bbb8 1946@ifclear SingleFormat
2c5c0674
RP
1947@item OUTPUT_ARCH ( @var{bfdname} )
1948@kindex OUTPUT_ARCH ( @var{bfdname} )
1949@cindex machine architecture, output
1950Specify a particular output machine architecture, with one of the names
1951used by the BFD back-end routines (@pxref{BFD}). This command is often
1952unnecessary; the architecture is most often set implicitly by either the
1953system BFD configuration or as a side effect of the @code{OUTPUT_FORMAT}
ec40bbb8 1954command.
2c5c0674
RP
1955
1956@item OUTPUT_FORMAT ( @var{bfdname} )
1957@kindex OUTPUT_FORMAT ( @var{bfdname} )
1958@cindex format, output file
1fb57a5d
RP
1959When @code{ld} is configured to support multiple object code formats,
1960you can use this command to specify a particular output format.
1961@var{bfdname} is one of the names used by the BFD back-end routines
1962(@pxref{BFD}). The effect is identical to the effect of the
1963@samp{-oformat} command-line option. This selection affects only
2c5c0674 1964the output file; the related command @code{TARGET} affects primarily
ec40bbb8
DM
1965input files.
1966@end ifclear
2c5c0674
RP
1967
1968@item SEARCH_DIR ( @var{path} )
1969@kindex SEARCH_DIR ( @var{path} )
1970@cindex path for libraries
1971@cindex search path, libraries
246504a5 1972Add @var{path} to the list of paths where @code{ld} looks for
2c5c0674 1973archive libraries. @code{SEARCH_DIR(@var{path})} has the same
ec40bbb8 1974effect as @samp{-L@var{path}} on the command line.
2c5c0674
RP
1975
1976@item STARTUP ( @var{filename} )
1977@kindex STARTUP ( @var{filename} )
1978@cindex first input file
1979Ensure that @var{filename} is the first input file used in the link
1980process.
b4d4e8e3 1981
ec40bbb8 1982@ifclear SingleFormat
b4d4e8e3 1983@item TARGET ( @var{format} )
2c5c0674
RP
1984@cindex input file format
1985@kindex TARGET ( @var{format} )
1fb57a5d
RP
1986When @code{ld} is configured to support multiple object code formats,
1987you can use this command to change the input-file object code format
1988(like the command-line option @samp{-b} or its synonym @samp{-format}).
1989The argument @var{format} is one of the strings used by BFD to name
1990binary formats. If @code{TARGET} is specified but @code{OUTPUT_FORMAT}
1991is not, the last @code{TARGET} argument is also used as the default
1992format for the @code{ld} output file. @xref{BFD}.
2c5c0674
RP
1993
1994@kindex GNUTARGET
246504a5 1995If you don't use the @code{TARGET} command, @code{ld} uses the value of
2c5c0674 1996the environment variable @code{GNUTARGET}, if available, to select the
246504a5 1997output file format. If that variable is also absent, @code{ld} uses
2c5c0674 1998the default format configured for your machine in the BFD libraries.
ec40bbb8 1999@end ifclear
b4d4e8e3
RP
2000@end table
2001
ec40bbb8
DM
2002@ifset GENERIC
2003@node Machine Dependent
1c48127e
RP
2004@chapter Machine Dependent Features
2005
2006@cindex machine dependencies
246504a5
RP
2007@code{ld} has additional features on some platforms; the following
2008sections describe them. Machines where @code{ld} has no additional
1c48127e
RP
2009functionality are not listed.
2010
2011@menu
246504a5
RP
2012* H8/300:: @code{ld} and the H8/300
2013* i960:: @code{ld} and the Intel 960 family
1c48127e 2014@end menu
ec40bbb8
DM
2015@end ifset
2016
7f9ae73e 2017@c FIXME! This could use @raisesections/@lowersections, but there seems to be a conflict
ec40bbb8
DM
2018@c between those and node-defaulting.
2019@ifset H8300
2020@ifclear GENERIC
7f9ae73e 2021@raisesections
ec40bbb8
DM
2022@end ifclear
2023@node H8/300
246504a5 2024@section @code{ld} and the H8/300
1c48127e
RP
2025
2026@cindex H8/300 support
246504a5 2027For the H8/300, @code{ld} can perform these global optimizations when
1c48127e
RP
2028you specify the @samp{-relax} command-line option.
2029
2030@table @emph
2031@item relaxing address modes
d76ae847 2032@cindex relaxing on H8/300
246504a5 2033@code{ld} finds all @code{jsr} and @code{jmp} instructions whose
1c48127e
RP
2034targets are within eight bits, and turns them into eight-bit
2035program-counter relative @code{bsr} and @code{bra} instructions,
2036respectively.
2037
2038@item synthesizing instructions
d76ae847 2039@cindex synthesizing on H8/300
1c48127e 2040@c FIXME: specifically mov.b, or any mov instructions really?
246504a5 2041@code{ld} finds all @code{mov.b} instructions which use the
1c48127e
RP
2042sixteen-bit absolute address form, but refer to the top
2043page of memory, and changes them to use the eight-bit address form.
2044(That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into
2045@samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the
2046top page of memory).
2047@end table
ec40bbb8 2048@ifclear GENERIC
7f9ae73e 2049@lowersections
ec40bbb8
DM
2050@end ifclear
2051@end ifset
2052
2053@ifset I960
2054@ifclear GENERIC
7f9ae73e 2055@raisesections
ec40bbb8
DM
2056@end ifclear
2057@node i960
246504a5 2058@section @code{ld} and the Intel 960 family
1c48127e
RP
2059
2060@cindex i960 support
d76ae847 2061
1c48127e
RP
2062You can use the @samp{-A@var{architecture}} command line option to
2063specify one of the two-letter names identifying members of the 960
2064family; the option specifies the desired output target, and warns of any
2065incompatible instructions in the input files. It also modifies the
2066linker's search strategy for archive libraries, to support the use of
2067libraries specific to each particular architecture, by including in the
2068search loop names suffixed with the string identifying the architecture.
2069
246504a5 2070For example, if your @code{ld} command line included @w{@samp{-ACA}} as
1c48127e 2071well as @w{@samp{-ltry}}, the linker would look (in its built-in search
ec40bbb8 2072paths, and in any paths you specify with @samp{-L}) for a library with
1c48127e 2073the names
ec40bbb8 2074
1c48127e
RP
2075@example
2076try
2077libtry.a
2078tryca
2079libtryca.a
2080@end example
ec40bbb8 2081
1c48127e
RP
2082@noindent
2083The first two possibilities would be considered in any event; the last
2084two are due to the use of @w{@samp{-ACA}}.
2085
ec40bbb8 2086You can meaningfully use @samp{-A} more than once on a command line, since
1c48127e 2087the 960 architecture family allows combination of target architectures; each
ec40bbb8 2088use will add another pair of name variants to search for when @w{@samp{-l}}
1c48127e 2089specifies a library.
1fb57a5d
RP
2090
2091@cindex @code{-relax} on i960
2092@cindex relaxing on i960
2093@code{ld} supports the @samp{-relax} option for the i960 family. If you
2094specify @samp{-relax}, @code{ld} finds all @code{balx} and @code{calx}
2095instructions whose targets are within 24 bits, and turns them into
209624-bit program-counter relative @code{bal} and @code{cal}
2097instructions, respectively. @code{ld} also turns @code{cal}
2098instructions into @code{bal} instructions when it determines that the
2099target subroutine is a leaf routine (that is, the target subroutine does
2100not itself call any subroutines).
2101
ec40bbb8 2102@ifclear GENERIC
7f9ae73e 2103@lowersections
ec40bbb8
DM
2104@end ifclear
2105@end ifset
1c48127e 2106
ec40bbb8
DM
2107@ifclear SingleFormat
2108@node BFD
f22eee08
RP
2109@chapter BFD
2110
2c5c0674
RP
2111@cindex back end
2112@cindex object file management
2113The linker accesses object and archive files using the BFD libraries.
2114These libraries allow the linker to use the same routines to operate on
2115object files whatever the object file format. A different object file
2116format can be supported simply by creating a new BFD back end and adding
1c48127e
RP
2117it to the library. You can use @code{objdump -i}
2118(@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to
2119list all the formats available for each architecture under BFD. This
2120was the list of formats, and of architectures supported for each format,
2121as of the time this manual was prepared:
2c5c0674
RP
2122@cindex formats available
2123@cindex architectures available
2c5c0674 2124@example
1c48127e
RP
2125BFD header file version 0.18
2126a.out-i386
2127 (header big endian, data big endian)
2128 m68k:68020
2129 a29k
2130 sparc
2131 i386
2132a.out-sunos-big
2133 (header big endian, data big endian)
2134 m68k:68020
2135 a29k
2136 sparc
2137 i386
2138b.out.big
2139 (header big endian, data little endian)
2140 i960:core
2141b.out.little
2142 (header little endian, data little endian)
2143 i960:core
2144coff-a29k-big
2145 (header big endian, data big endian)
2146 a29k
2147coff-h8300
2148 (header big endian, data big endian)
2149 H8/300
2150coff-i386
2151 (header little endian, data little endian)
2152 i386
2153coff-Intel-big
2154 (header big endian, data little endian)
2155 i960:core
2156coff-Intel-little
2157 (header little endian, data little endian)
2158 i960:core
2159coff-m68k
2160 (header big endian, data big endian)
2161 m68k:68020
2162coff-m88kbcs
2163 (header big endian, data big endian)
2164 m88k:88100
2165ecoff-bigmips
2166 (header big endian, data big endian)
2167 mips
2168ecoff-littlemips
2169 (header little endian, data little endian)
2170 mips
2171elf-big
2172 (header big endian, data big endian)
2173 m68k:68020
2174 vax
2175 i960:core
2176 a29k
2177 sparc
2178 mips
2179 i386
2180 m88k:88100
2181 H8/300
2182 rs6000:6000
2183elf-little
2184 (header little endian, data little endian)
2185 m68k:68020
2186 vax
2187 i960:core
2188 a29k
2189 sparc
2190 mips
2191 i386
2192 m88k:88100
2193 H8/300
2194 rs6000:6000
2195ieee
2196 (header big endian, data big endian)
2197 m68k:68020
2198 vax
2199 i960:core
2200 a29k
2201 sparc
2202 mips
2203 i386
2204 m88k:88100
2205 H8/300
2206 rs6000:6000
2207srec
2208 (header big endian, data big endian)
2209 m68k:68020
2210 vax
2211 i960:core
2212 a29k
2213 sparc
2214 mips
2215 i386
2216 m88k:88100
2217 H8/300
2218 rs6000:6000
2c5c0674 2219@end example
f22eee08 2220
2c5c0674
RP
2221@cindex BFD requirements
2222@cindex requirements for BFD
2223As with most implementations, BFD is a compromise between
f22eee08 2224several conflicting requirements. The major factor influencing
2c5c0674
RP
2225BFD design was efficiency: any time used converting between
2226formats is time which would not have been spent had BFD not
f22eee08 2227been involved. This is partly offset by abstraction payback; since
2c5c0674 2228BFD simplifies applications and back ends, more time and care
f22eee08
RP
2229may be spent optimizing algorithms for a greater speed.
2230
2c5c0674
RP
2231One minor artifact of the BFD solution which you should bear in
2232mind is the potential for information loss. There are two places where
ec40bbb8 2233useful information can be lost using the BFD mechanism: during
2c5c0674
RP
2234conversion and during output. @xref{BFD information loss}.
2235
2236@menu
2d59b2c3 2237* BFD outline:: How it works: an outline of BFD
2c5c0674 2238@end menu
f22eee08 2239
ec40bbb8 2240@node BFD outline
b4d4e8e3 2241@section How it works: an outline of BFD
2c5c0674 2242@cindex opening object files
3e27cc11 2243@include bfdsumm.texi
ec40bbb8 2244@end ifclear
f22eee08 2245
ec40bbb8 2246@node MRI
2d59b2c3
RP
2247@appendix MRI Compatible Script Files
2248@cindex MRI compatibility
2249To aid users making the transition to @sc{gnu} @code{ld} from the MRI
2250linker, @code{ld} can use MRI compatible linker scripts as an
2251alternative to the more general-purpose linker scripting language
2252described in @ref{Commands,,Command Language}. MRI compatible linker
2253scripts have a much simpler command set than the scripting language
2254otherwise used with @code{ld}. @sc{gnu} @code{ld} supports the most
2255commonly used MRI linker commands; these commands are described here.
2256
867a1b8a
DM
2257In general, MRI scripts aren't of much use with the @code{a.out} object
2258file format, since it only has three sections and MRI scripts lack some
2259features to make use of them.
2260
2d59b2c3
RP
2261You can specify a file containing an MRI-compatible script using the
2262@samp{-c} command-line option.
2263
2264Each command in an MRI-compatible script occupies its own line; each
2265command line starts with the keyword that identifies the command (though
2266blank lines are also allowed for punctuation). If a line of an
2267MRI-compatible script begins with an unrecognized keyword, @code{ld}
2268issues a warning message, but continues processing the script.
2269
2270Lines beginning with @samp{*} are comments.
2271
2272You can write these commands using all upper-case letters, or all
2273lower case; for example, @samp{chip} is the same as @samp{CHIP}.
2274The following list shows only the upper-case form of each command.
2275
2276@table @code
2277@item ABSOLUTE @var{secname}
2278@item ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname}
2279@cindex @code{ABSOLUTE} (MRI)
2280Normally, @code{ld} includes in the output file all sections from all
2281the input files. However, in an MRI-compatible script, you can use the
2282@code{ABSOLUTE} command to restrict the sections that will be present in
2283your output program. If the @code{ABSOLUTE} command is used at all in a
2284script, then only the sections named explicitly in @code{ABSOLUTE}
2285commands will appear in the linker output. You can still use other
2286input sections (whatever you select on the command line, or using
7b015547 2287@code{LOAD}) to resolve addresses in the output file.
2d59b2c3
RP
2288
2289@item ALIAS @var{out-secname}, @var{in-secname}
2290@cindex @code{ALIAS} (MRI)
2291Use this command to place the data from input section @var{in-secname}
2292in a section called @var{out-secname} in the linker output file.
2293
2294@var{in-secname} may be an integer.
2295
2296@item BASE @var{expression}
2297@cindex @code{BASE} (MRI)
2298Use the value of @var{expression} as the lowest address (other than
2299absolute addresses) in the output file.
2300
2301@item CHIP @var{expression}
2302@itemx CHIP @var{expression}, @var{expression}
2303@cindex @code{CHIP} (MRI)
ec40bbb8 2304This command does nothing; it is accepted only for compatibility.
2d59b2c3
RP
2305
2306@item END
2307@cindex @code{END} (MRI)
2308This command does nothing whatever; it's only accepted for compatibility.
2309
2310@item FORMAT @var{output-format}
2311@cindex @code{FORMAT} (MRI)
2312Similar to the @code{OUTPUT_FORMAT} command in the more general linker
2313language, but restricted to one of these output formats:
2314@enumerate
2315@item
2316S-records, if @var{output-format} is @samp{S}
2317
2318@item
2319IEEE, if @var{output-format} is @samp{IEEE}
2320
2321@item
2322COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is
2323@samp{COFF}
2324@end enumerate
2325
8ddef552 2326@item LIST @var{anything}@dots{}
2d59b2c3
RP
2327@cindex @code{LIST} (MRI)
2328Print (to the standard output file) a link map, as produced by the
2329@code{ld} command-line option @samp{-M}.
2330
ec40bbb8
DM
2331The keyword @code{LIST} may be followed by anything on the
2332same line, with no change in its effect.
2d59b2c3
RP
2333
2334@item LOAD @var{filename}
2335@item LOAD @var{filename}, @var{filename}, @dots{} @var{filename}
2336@cindex @code{LOAD} (MRI)
2337Include one or more object file @var{filename} in the link; this has the
2338same effect as specifying @var{filename} directly on the @code{ld}
2339command line.
2340
2341@item NAME @var{output-name}
2342@cindex @code{NAME} (MRI)
2343@var{output-name} is the name for the program produced by @code{ld}; the
2344MRI-compatible command @code{NAME} is equivalent to the command-line
2345option @samp{-o} or the general script language command @code{OUTPUT}.
2346
2347@item ORDER @var{secname}, @var{secname}, @dots{} @var{secname}
2348@itemx ORDER @var{secname} @var{secname} @var{secname}
2349@cindex @code{ORDER} (MRI)
ec40bbb8
DM
2350Normally, @code{ld} orders the sections in its output file in the
2351order in which they first appear in the input files. In an MRI-compatible
2352script, you can override this ordering with the @code{ORDER} command. The
2d59b2c3
RP
2353sections you list with @code{ORDER} will appear first in your output
2354file, in the order specified.
2355
2356@item PUBLIC @var{name}=@var{expression}
2357@itemx PUBLIC @var{name},@var{expression}
2358@itemx PUBLIC @var{name} @var{expression}
2359@cindex @code{PUBLIC} (MRI)
ec40bbb8 2360Supply a value (@var{expression}) for external symbol
2d59b2c3
RP
2361@var{name} used in the linker input files.
2362
2363@item SECT @var{secname}, @var{expression}
2364@itemx SECT @var{secname}=@var{expression}
2365@itemx SECT @var{secname} @var{expression}
2366@cindex @code{SECT} (MRI)
2367You can use any of these three forms of the @code{SECT} command to
2368specify the start address (@var{expression}) for section @var{secname}.
2369If you have more than one @code{SECT} statement for the same
2370@var{secname}, only the @emph{first} sets the start address.
2371@end table
2372
2373
ec40bbb8 2374@node Index
2c5c0674
RP
2375@unnumbered Index
2376
2377@printindex cp
2378
2379@tex
2380% I think something like @colophon should be in texinfo. In the
2381% meantime:
2382\long\def\colophon{\hbox to0pt{}\vfill
2383\centerline{The body of this manual is set in}
2384\centerline{\fontname\tenrm,}
2385\centerline{with headings in {\bf\fontname\tenbf}}
2386\centerline{and examples in {\tt\fontname\tentt}.}
2387\centerline{{\it\fontname\tenit\/} and}
2388\centerline{{\sl\fontname\tensl\/}}
2389\centerline{are used for emphasis.}\vfill}
2390\page\colophon
2391% Blame: pesch@cygnus.com, 28mar91.
2392@end tex
2393
2394
b4d4e8e3 2395@contents
f22eee08
RP
2396@bye
2397
2398
This page took 0.227026 seconds and 4 git commands to generate.