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