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