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