Commit | Line | Data |
---|---|---|
252b5132 RH |
1 | \input texinfo |
2 | @setfilename ld.info | |
a2b64bed | 3 | @c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, |
313e35ee | 4 | @c 2001, 2002 Free Software Foundation, Inc. |
252b5132 RH |
5 | @syncodeindex ky cp |
6 | @include configdoc.texi | |
7 | @c (configdoc.texi is generated by the Makefile) | |
8 | @include ldver.texi | |
9 | ||
10 | @c @smallbook | |
11 | ||
ff5dcc92 SC |
12 | @macro gcctabopt{body} |
13 | @code{\body\} | |
14 | @end macro | |
15 | ||
0285c67d NC |
16 | @c man begin NAME |
17 | @ifset man | |
18 | @c Configure for the generation of man pages | |
19 | @set UsesEnvVars | |
20 | @set GENERIC | |
21 | @set A29K | |
22 | @set ARC | |
23 | @set ARM | |
24 | @set D10V | |
25 | @set D30V | |
26 | @set H8/300 | |
27 | @set H8/500 | |
28 | @set HPPA | |
29 | @set I370 | |
30 | @set I80386 | |
31 | @set I860 | |
32 | @set I960 | |
33 | @set M32R | |
34 | @set M68HC11 | |
35 | @set M680X0 | |
36 | @set MCORE | |
37 | @set MIPS | |
3c3bdf30 | 38 | @set MMIX |
0285c67d NC |
39 | @set PDP11 |
40 | @set PJ | |
41 | @set SH | |
42 | @set SPARC | |
43 | @set C54X | |
44 | @set V850 | |
45 | @set VAX | |
46 | @end ifset | |
47 | @c man end | |
48 | ||
252b5132 RH |
49 | @ifinfo |
50 | @format | |
51 | START-INFO-DIR-ENTRY | |
52 | * Ld: (ld). The GNU linker. | |
53 | END-INFO-DIR-ENTRY | |
54 | @end format | |
55 | @end ifinfo | |
56 | ||
57 | @ifinfo | |
58 | This file documents the @sc{gnu} linker LD version @value{VERSION}. | |
59 | ||
62bf86b4 | 60 | Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, |
313e35ee | 61 | 2001, 2002 Free Software Foundation, Inc. |
252b5132 | 62 | |
252b5132 | 63 | @ignore |
cf055d54 NC |
64 | |
65 | Permission is granted to copy, distribute and/or modify this document | |
66 | under the terms of the GNU Free Documentation License, Version 1.1 | |
67 | or any later version published by the Free Software Foundation; | |
68 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
69 | Back-Cover Texts. A copy of the license is included in the | |
70 | section entitled "GNU Free Documentation License". | |
71 | ||
252b5132 RH |
72 | Permission is granted to process this file through Tex and print the |
73 | results, provided the printed document carries copying permission | |
74 | notice identical to this one except for the removal of this paragraph | |
75 | (this paragraph not being relevant to the printed manual). | |
76 | ||
77 | @end ignore | |
78 | @end ifinfo | |
79 | @iftex | |
80 | @finalout | |
81 | @setchapternewpage odd | |
82 | @settitle Using LD, the GNU linker | |
83 | @titlepage | |
84 | @title Using ld | |
85 | @subtitle The GNU linker | |
86 | @sp 1 | |
87 | @subtitle @code{ld} version 2 | |
88 | @subtitle Version @value{VERSION} | |
89 | @author Steve Chamberlain | |
90 | @author Ian Lance Taylor | |
252b5132 RH |
91 | @page |
92 | ||
93 | @tex | |
94 | {\parskip=0pt | |
704c465c NC |
95 | \hfill Red Hat Inc\par |
96 | \hfill nickc\@credhat.com, doc\@redhat.com\par | |
252b5132 RH |
97 | \hfill {\it Using LD, the GNU linker}\par |
98 | \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par | |
99 | } | |
100 | \global\parindent=0pt % Steve likes it this way. | |
101 | @end tex | |
102 | ||
103 | @vskip 0pt plus 1filll | |
0285c67d | 104 | @c man begin COPYRIGHT |
114283d8 | 105 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. |
252b5132 | 106 | |
0285c67d NC |
107 | Permission is granted to copy, distribute and/or modify this document |
108 | under the terms of the GNU Free Documentation License, Version 1.1 | |
109 | or any later version published by the Free Software Foundation; | |
110 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
111 | Back-Cover Texts. A copy of the license is included in the | |
112 | section entitled "GNU Free Documentation License". | |
113 | @c man end | |
252b5132 | 114 | |
252b5132 RH |
115 | @end titlepage |
116 | @end iftex | |
117 | @c FIXME: Talk about importance of *order* of args, cmds to linker! | |
118 | ||
84ec0e6d | 119 | @ifnottex |
252b5132 RH |
120 | @node Top |
121 | @top Using ld | |
122 | This file documents the @sc{gnu} linker ld version @value{VERSION}. | |
123 | ||
cf055d54 NC |
124 | This document is distributed under the terms of the GNU Free |
125 | Documentation License. A copy of the license is included in the | |
126 | section entitled "GNU Free Documentation License". | |
127 | ||
252b5132 RH |
128 | @menu |
129 | * Overview:: Overview | |
130 | * Invocation:: Invocation | |
131 | * Scripts:: Linker Scripts | |
132 | @ifset GENERIC | |
133 | * Machine Dependent:: Machine Dependent Features | |
134 | @end ifset | |
135 | @ifclear GENERIC | |
136 | @ifset H8300 | |
137 | * H8/300:: ld and the H8/300 | |
138 | @end ifset | |
139 | @ifset Hitachi | |
140 | * Hitachi:: ld and other Hitachi micros | |
141 | @end ifset | |
142 | @ifset I960 | |
143 | * i960:: ld and the Intel 960 family | |
144 | @end ifset | |
74459f0e TW |
145 | @ifset TICOFF |
146 | * TI COFF:: ld and the TI COFF | |
147 | @end ifset | |
252b5132 RH |
148 | @end ifclear |
149 | @ifclear SingleFormat | |
150 | * BFD:: BFD | |
151 | @end ifclear | |
152 | @c Following blank line required for remaining bug in makeinfo conds/menus | |
153 | ||
154 | * Reporting Bugs:: Reporting Bugs | |
155 | * MRI:: MRI Compatible Script Files | |
704c465c | 156 | * GNU Free Documentation License:: GNU Free Documentation License |
252b5132 RH |
157 | * Index:: Index |
158 | @end menu | |
84ec0e6d | 159 | @end ifnottex |
252b5132 RH |
160 | |
161 | @node Overview | |
162 | @chapter Overview | |
163 | ||
164 | @cindex @sc{gnu} linker | |
165 | @cindex what is this? | |
0285c67d | 166 | |
0879a67a | 167 | @ifset man |
0285c67d | 168 | @c man begin SYNOPSIS |
ff5dcc92 | 169 | ld [@b{options}] @var{objfile} @dots{} |
0285c67d NC |
170 | @c man end |
171 | ||
172 | @c man begin SEEALSO | |
173 | ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and | |
174 | the Info entries for @file{binutils} and | |
175 | @file{ld}. | |
176 | @c man end | |
177 | @end ifset | |
178 | ||
179 | @c man begin DESCRIPTION | |
180 | ||
ff5dcc92 | 181 | @command{ld} combines a number of object and archive files, relocates |
252b5132 | 182 | their data and ties up symbol references. Usually the last step in |
ff5dcc92 | 183 | compiling a program is to run @command{ld}. |
252b5132 | 184 | |
ff5dcc92 | 185 | @command{ld} accepts Linker Command Language files written in |
252b5132 RH |
186 | a superset of AT&T's Link Editor Command Language syntax, |
187 | to provide explicit and total control over the linking process. | |
188 | ||
0285c67d NC |
189 | @ifset man |
190 | @c For the man only | |
191 | This man page does not describe the command language; see the | |
ff5dcc92 | 192 | @command{ld} entry in @code{info}, or the manual |
0285c67d NC |
193 | ld: the GNU linker, for full details on the command language and |
194 | on other aspects of the GNU linker. | |
195 | @end ifset | |
196 | ||
252b5132 | 197 | @ifclear SingleFormat |
ff5dcc92 SC |
198 | This version of @command{ld} uses the general purpose BFD libraries |
199 | to operate on object files. This allows @command{ld} to read, combine, and | |
252b5132 RH |
200 | write object files in many different formats---for example, COFF or |
201 | @code{a.out}. Different formats may be linked together to produce any | |
202 | available kind of object file. @xref{BFD}, for more information. | |
203 | @end ifclear | |
204 | ||
205 | Aside from its flexibility, the @sc{gnu} linker is more helpful than other | |
206 | linkers in providing diagnostic information. Many linkers abandon | |
207 | execution immediately upon encountering an error; whenever possible, | |
ff5dcc92 | 208 | @command{ld} continues executing, allowing you to identify other errors |
252b5132 RH |
209 | (or, in some cases, to get an output file in spite of the error). |
210 | ||
0285c67d NC |
211 | @c man end |
212 | ||
252b5132 RH |
213 | @node Invocation |
214 | @chapter Invocation | |
215 | ||
0285c67d NC |
216 | @c man begin DESCRIPTION |
217 | ||
ff5dcc92 | 218 | The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations, |
252b5132 RH |
219 | and to be as compatible as possible with other linkers. As a result, |
220 | you have many choices to control its behavior. | |
221 | ||
0285c67d NC |
222 | @c man end |
223 | ||
252b5132 RH |
224 | @ifset UsesEnvVars |
225 | @menu | |
226 | * Options:: Command Line Options | |
227 | * Environment:: Environment Variables | |
228 | @end menu | |
229 | ||
230 | @node Options | |
231 | @section Command Line Options | |
232 | @end ifset | |
233 | ||
234 | @cindex command line | |
235 | @cindex options | |
0285c67d NC |
236 | |
237 | @c man begin OPTIONS | |
238 | ||
252b5132 RH |
239 | The linker supports a plethora of command-line options, but in actual |
240 | practice few of them are used in any particular context. | |
241 | @cindex standard Unix system | |
ff5dcc92 | 242 | For instance, a frequent use of @command{ld} is to link standard Unix |
252b5132 RH |
243 | object files on a standard, supported Unix system. On such a system, to |
244 | link a file @code{hello.o}: | |
245 | ||
246 | @smallexample | |
247 | ld -o @var{output} /lib/crt0.o hello.o -lc | |
248 | @end smallexample | |
249 | ||
ff5dcc92 | 250 | This tells @command{ld} to produce a file called @var{output} as the |
252b5132 RH |
251 | result of linking the file @code{/lib/crt0.o} with @code{hello.o} and |
252 | the library @code{libc.a}, which will come from the standard search | |
253 | directories. (See the discussion of the @samp{-l} option below.) | |
254 | ||
ff5dcc92 | 255 | Some of the command-line options to @command{ld} may be specified at any |
511ab9e9 ILT |
256 | point in the command line. However, options which refer to files, such |
257 | as @samp{-l} or @samp{-T}, cause the file to be read at the point at | |
258 | which the option appears in the command line, relative to the object | |
259 | files and other file options. Repeating non-file options with a | |
260 | different argument will either have no further effect, or override prior | |
252b5132 RH |
261 | occurrences (those further to the left on the command line) of that |
262 | option. Options which may be meaningfully specified more than once are | |
263 | noted in the descriptions below. | |
264 | ||
265 | @cindex object files | |
511ab9e9 ILT |
266 | Non-option arguments are object files or archives which are to be linked |
267 | together. They may follow, precede, or be mixed in with command-line | |
268 | options, except that an object file argument may not be placed between | |
269 | an option and its argument. | |
252b5132 RH |
270 | |
271 | Usually the linker is invoked with at least one object file, but you can | |
272 | specify other forms of binary input files using @samp{-l}, @samp{-R}, | |
273 | and the script command language. If @emph{no} binary input files at all | |
274 | are specified, the linker does not produce any output, and issues the | |
275 | message @samp{No input files}. | |
276 | ||
277 | If the linker can not recognize the format of an object file, it will | |
278 | assume that it is a linker script. A script specified in this way | |
279 | augments the main linker script used for the link (either the default | |
280 | linker script or the one specified by using @samp{-T}). This feature | |
281 | permits the linker to link against a file which appears to be an object | |
282 | or an archive, but actually merely defines some symbol values, or uses | |
283 | @code{INPUT} or @code{GROUP} to load other objects. Note that | |
114283d8 NC |
284 | specifying a script in this way merely augments the main linker script; |
285 | use the @samp{-T} option to replace the default linker script entirely. | |
252b5132 RH |
286 | @xref{Scripts}. |
287 | ||
288 | For options whose names are a single letter, | |
289 | option arguments must either follow the option letter without intervening | |
290 | whitespace, or be given as separate arguments immediately following the | |
291 | option that requires them. | |
292 | ||
293 | For options whose names are multiple letters, either one dash or two can | |
e4897a32 NC |
294 | precede the option name; for example, @samp{-trace-symbol} and |
295 | @samp{--trace-symbol} are equivalent. Note - there is one exception to | |
296 | this rule. Multiple letter options that start with a lower case 'o' can | |
297 | only be preceeded by two dashes. This is to reduce confusion with the | |
298 | @samp{-o} option. So for example @samp{-omagic} sets the output file | |
299 | name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the | |
300 | output. | |
301 | ||
302 | Arguments to multiple-letter options must either be separated from the | |
303 | option name by an equals sign, or be given as separate arguments | |
304 | immediately following the option that requires them. For example, | |
305 | @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent. | |
306 | Unique abbreviations of the names of multiple-letter options are | |
307 | accepted. | |
252b5132 | 308 | |
4e53152f NC |
309 | Note - if the linker is being invoked indirectly, via a compiler driver |
310 | (eg @samp{gcc}) then all the linker command line options should be | |
fa19fce0 NC |
311 | prefixed by @samp{-Wl,} (or whatever is appropriate for the particular |
312 | compiler driver) like this: | |
4e53152f NC |
313 | |
314 | @smallexample | |
315 | gcc -Wl,--startgroup foo.o bar.o -Wl,--endgroup | |
316 | @end smallexample | |
317 | ||
318 | This is important, because otherwise the compiler driver program may | |
319 | silently drop the linker options, resulting in a bad link. | |
320 | ||
321 | Here is a table of the generic command line switches accepted by the GNU | |
322 | linker: | |
323 | ||
ff5dcc92 | 324 | @table @gcctabopt |
252b5132 RH |
325 | @kindex -a@var{keyword} |
326 | @item -a@var{keyword} | |
327 | This option is supported for HP/UX compatibility. The @var{keyword} | |
328 | argument must be one of the strings @samp{archive}, @samp{shared}, or | |
329 | @samp{default}. @samp{-aarchive} is functionally equivalent to | |
330 | @samp{-Bstatic}, and the other two keywords are functionally equivalent | |
331 | to @samp{-Bdynamic}. This option may be used any number of times. | |
332 | ||
333 | @ifset I960 | |
334 | @cindex architectures | |
335 | @kindex -A@var{arch} | |
336 | @item -A@var{architecture} | |
337 | @kindex --architecture=@var{arch} | |
338 | @itemx --architecture=@var{architecture} | |
ff5dcc92 SC |
339 | In the current release of @command{ld}, this option is useful only for the |
340 | Intel 960 family of architectures. In that @command{ld} configuration, the | |
252b5132 RH |
341 | @var{architecture} argument identifies the particular architecture in |
342 | the 960 family, enabling some safeguards and modifying the | |
ff5dcc92 | 343 | archive-library search path. @xref{i960,,@command{ld} and the Intel 960 |
252b5132 RH |
344 | family}, for details. |
345 | ||
ff5dcc92 | 346 | Future releases of @command{ld} may support similar functionality for |
252b5132 RH |
347 | other architecture families. |
348 | @end ifset | |
349 | ||
350 | @ifclear SingleFormat | |
351 | @cindex binary input format | |
352 | @kindex -b @var{format} | |
353 | @kindex --format=@var{format} | |
354 | @cindex input format | |
355 | @cindex input format | |
356 | @item -b @var{input-format} | |
357 | @itemx --format=@var{input-format} | |
ff5dcc92 SC |
358 | @command{ld} may be configured to support more than one kind of object |
359 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 360 | @samp{-b} option to specify the binary format for input object files |
ff5dcc92 | 361 | that follow this option on the command line. Even when @command{ld} is |
252b5132 | 362 | configured to support alternative object formats, you don't usually need |
ff5dcc92 | 363 | to specify this, as @command{ld} should be configured to expect as a |
252b5132 RH |
364 | default input format the most usual format on each machine. |
365 | @var{input-format} is a text string, the name of a particular format | |
366 | supported by the BFD libraries. (You can list the available binary | |
367 | formats with @samp{objdump -i}.) | |
368 | @xref{BFD}. | |
369 | ||
370 | You may want to use this option if you are linking files with an unusual | |
371 | binary format. You can also use @samp{-b} to switch formats explicitly (when | |
372 | linking object files of different formats), by including | |
373 | @samp{-b @var{input-format}} before each group of object files in a | |
a1ab1d2a | 374 | particular format. |
252b5132 RH |
375 | |
376 | The default format is taken from the environment variable | |
377 | @code{GNUTARGET}. | |
378 | @ifset UsesEnvVars | |
379 | @xref{Environment}. | |
380 | @end ifset | |
381 | You can also define the input format from a script, using the command | |
0285c67d NC |
382 | @code{TARGET}; |
383 | @ifclear man | |
384 | see @ref{Format Commands}. | |
385 | @end ifclear | |
252b5132 RH |
386 | @end ifclear |
387 | ||
388 | @kindex -c @var{MRI-cmdfile} | |
389 | @kindex --mri-script=@var{MRI-cmdfile} | |
390 | @cindex compatibility, MRI | |
391 | @item -c @var{MRI-commandfile} | |
392 | @itemx --mri-script=@var{MRI-commandfile} | |
ff5dcc92 | 393 | For compatibility with linkers produced by MRI, @command{ld} accepts script |
252b5132 | 394 | files written in an alternate, restricted command language, described in |
0285c67d NC |
395 | @ifclear man |
396 | @ref{MRI,,MRI Compatible Script Files}. | |
397 | @end ifclear | |
398 | @ifset man | |
399 | the MRI Compatible Script Files section of GNU ld documentation. | |
400 | @end ifset | |
401 | Introduce MRI script files with | |
252b5132 | 402 | the option @samp{-c}; use the @samp{-T} option to run linker |
ff5dcc92 SC |
403 | scripts written in the general-purpose @command{ld} scripting language. |
404 | If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories | |
252b5132 RH |
405 | specified by any @samp{-L} options. |
406 | ||
407 | @cindex common allocation | |
408 | @kindex -d | |
409 | @kindex -dc | |
410 | @kindex -dp | |
a1ab1d2a | 411 | @item -d |
252b5132 RH |
412 | @itemx -dc |
413 | @itemx -dp | |
414 | These three options are equivalent; multiple forms are supported for | |
415 | compatibility with other linkers. They assign space to common symbols | |
416 | even if a relocatable output file is specified (with @samp{-r}). The | |
417 | script command @code{FORCE_COMMON_ALLOCATION} has the same effect. | |
418 | @xref{Miscellaneous Commands}. | |
419 | ||
420 | @cindex entry point, from command line | |
421 | @kindex -e @var{entry} | |
422 | @kindex --entry=@var{entry} | |
a1ab1d2a | 423 | @item -e @var{entry} |
252b5132 RH |
424 | @itemx --entry=@var{entry} |
425 | Use @var{entry} as the explicit symbol for beginning execution of your | |
426 | program, rather than the default entry point. If there is no symbol | |
427 | named @var{entry}, the linker will try to parse @var{entry} as a number, | |
428 | and use that as the entry address (the number will be interpreted in | |
429 | base 10; you may use a leading @samp{0x} for base 16, or a leading | |
430 | @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults | |
431 | and other ways of specifying the entry point. | |
432 | ||
433 | @cindex dynamic symbol table | |
434 | @kindex -E | |
435 | @kindex --export-dynamic | |
436 | @item -E | |
437 | @itemx --export-dynamic | |
438 | When creating a dynamically linked executable, add all symbols to the | |
439 | dynamic symbol table. The dynamic symbol table is the set of symbols | |
440 | which are visible from dynamic objects at run time. | |
441 | ||
442 | If you do not use this option, the dynamic symbol table will normally | |
443 | contain only those symbols which are referenced by some dynamic object | |
444 | mentioned in the link. | |
445 | ||
446 | If you use @code{dlopen} to load a dynamic object which needs to refer | |
447 | back to the symbols defined by the program, rather than some other | |
448 | dynamic object, then you will probably need to use this option when | |
449 | linking the program itself. | |
450 | ||
cb840a31 L |
451 | You can also use the version script to control what symbols should |
452 | be added to the dynamic symbol table if the output format supports it. | |
453 | See the description of @samp{--version-script} in @ref{VERSION}. | |
454 | ||
252b5132 RH |
455 | @cindex big-endian objects |
456 | @cindex endianness | |
457 | @kindex -EB | |
458 | @item -EB | |
459 | Link big-endian objects. This affects the default output format. | |
460 | ||
461 | @cindex little-endian objects | |
462 | @kindex -EL | |
463 | @item -EL | |
464 | Link little-endian objects. This affects the default output format. | |
465 | ||
466 | @kindex -f | |
467 | @kindex --auxiliary | |
468 | @item -f | |
469 | @itemx --auxiliary @var{name} | |
470 | When creating an ELF shared object, set the internal DT_AUXILIARY field | |
471 | to the specified name. This tells the dynamic linker that the symbol | |
472 | table of the shared object should be used as an auxiliary filter on the | |
473 | symbol table of the shared object @var{name}. | |
474 | ||
475 | If you later link a program against this filter object, then, when you | |
476 | run the program, the dynamic linker will see the DT_AUXILIARY field. If | |
477 | the dynamic linker resolves any symbols from the filter object, it will | |
478 | first check whether there is a definition in the shared object | |
479 | @var{name}. If there is one, it will be used instead of the definition | |
480 | in the filter object. The shared object @var{name} need not exist. | |
481 | Thus the shared object @var{name} may be used to provide an alternative | |
482 | implementation of certain functions, perhaps for debugging or for | |
483 | machine specific performance. | |
484 | ||
485 | This option may be specified more than once. The DT_AUXILIARY entries | |
486 | will be created in the order in which they appear on the command line. | |
487 | ||
488 | @kindex -F | |
489 | @kindex --filter | |
490 | @item -F @var{name} | |
491 | @itemx --filter @var{name} | |
492 | When creating an ELF shared object, set the internal DT_FILTER field to | |
493 | the specified name. This tells the dynamic linker that the symbol table | |
494 | of the shared object which is being created should be used as a filter | |
495 | on the symbol table of the shared object @var{name}. | |
496 | ||
497 | If you later link a program against this filter object, then, when you | |
498 | run the program, the dynamic linker will see the DT_FILTER field. The | |
499 | dynamic linker will resolve symbols according to the symbol table of the | |
500 | filter object as usual, but it will actually link to the definitions | |
501 | found in the shared object @var{name}. Thus the filter object can be | |
502 | used to select a subset of the symbols provided by the object | |
503 | @var{name}. | |
504 | ||
ff5dcc92 | 505 | Some older linkers used the @option{-F} option throughout a compilation |
252b5132 RH |
506 | toolchain for specifying object-file format for both input and output |
507 | object files. The @sc{gnu} linker uses other mechanisms for this | |
ff5dcc92 | 508 | purpose: the @option{-b}, @option{--format}, @option{--oformat} options, the |
252b5132 | 509 | @code{TARGET} command in linker scripts, and the @code{GNUTARGET} |
ff5dcc92 | 510 | environment variable. The @sc{gnu} linker will ignore the @option{-F} |
252b5132 RH |
511 | option when not creating an ELF shared object. |
512 | ||
3dbf70a2 MM |
513 | @cindex finalization function |
514 | @kindex -fini | |
515 | @item -fini @var{name} | |
516 | When creating an ELF executable or shared object, call NAME when the | |
517 | executable or shared object is unloaded, by setting DT_FINI to the | |
518 | address of the function. By default, the linker uses @code{_fini} as | |
519 | the function to call. | |
520 | ||
252b5132 RH |
521 | @kindex -g |
522 | @item -g | |
523 | Ignored. Provided for compatibility with other tools. | |
524 | ||
525 | @kindex -G | |
526 | @kindex --gpsize | |
527 | @cindex object size | |
528 | @item -G@var{value} | |
529 | @itemx --gpsize=@var{value} | |
530 | Set the maximum size of objects to be optimized using the GP register to | |
531 | @var{size}. This is only meaningful for object file formats such as | |
532 | MIPS ECOFF which supports putting large and small objects into different | |
533 | sections. This is ignored for other object file formats. | |
534 | ||
535 | @cindex runtime library name | |
536 | @kindex -h@var{name} | |
537 | @kindex -soname=@var{name} | |
538 | @item -h@var{name} | |
539 | @itemx -soname=@var{name} | |
540 | When creating an ELF shared object, set the internal DT_SONAME field to | |
541 | the specified name. When an executable is linked with a shared object | |
542 | which has a DT_SONAME field, then when the executable is run the dynamic | |
543 | linker will attempt to load the shared object specified by the DT_SONAME | |
544 | field rather than the using the file name given to the linker. | |
545 | ||
546 | @kindex -i | |
547 | @cindex incremental link | |
548 | @item -i | |
549 | Perform an incremental link (same as option @samp{-r}). | |
550 | ||
3dbf70a2 MM |
551 | @cindex initialization function |
552 | @kindex -init | |
553 | @item -init @var{name} | |
554 | When creating an ELF executable or shared object, call NAME when the | |
555 | executable or shared object is loaded, by setting DT_INIT to the address | |
556 | of the function. By default, the linker uses @code{_init} as the | |
557 | function to call. | |
558 | ||
252b5132 RH |
559 | @cindex archive files, from cmd line |
560 | @kindex -l@var{archive} | |
561 | @kindex --library=@var{archive} | |
562 | @item -l@var{archive} | |
563 | @itemx --library=@var{archive} | |
564 | Add archive file @var{archive} to the list of files to link. This | |
ff5dcc92 | 565 | option may be used any number of times. @command{ld} will search its |
252b5132 RH |
566 | path-list for occurrences of @code{lib@var{archive}.a} for every |
567 | @var{archive} specified. | |
568 | ||
ff5dcc92 | 569 | On systems which support shared libraries, @command{ld} may also search for |
252b5132 | 570 | libraries with extensions other than @code{.a}. Specifically, on ELF |
ff5dcc92 | 571 | and SunOS systems, @command{ld} will search a directory for a library with |
252b5132 RH |
572 | an extension of @code{.so} before searching for one with an extension of |
573 | @code{.a}. By convention, a @code{.so} extension indicates a shared | |
574 | library. | |
575 | ||
576 | The linker will search an archive only once, at the location where it is | |
577 | specified on the command line. If the archive defines a symbol which | |
578 | was undefined in some object which appeared before the archive on the | |
579 | command line, the linker will include the appropriate file(s) from the | |
580 | archive. However, an undefined symbol in an object appearing later on | |
581 | the command line will not cause the linker to search the archive again. | |
582 | ||
ff5dcc92 | 583 | See the @option{-(} option for a way to force the linker to search |
252b5132 RH |
584 | archives multiple times. |
585 | ||
586 | You may list the same archive multiple times on the command line. | |
587 | ||
588 | @ifset GENERIC | |
589 | This type of archive searching is standard for Unix linkers. However, | |
ff5dcc92 | 590 | if you are using @command{ld} on AIX, note that it is different from the |
252b5132 RH |
591 | behaviour of the AIX linker. |
592 | @end ifset | |
593 | ||
594 | @cindex search directory, from cmd line | |
595 | @kindex -L@var{dir} | |
596 | @kindex --library-path=@var{dir} | |
a1ab1d2a | 597 | @item -L@var{searchdir} |
252b5132 | 598 | @itemx --library-path=@var{searchdir} |
ff5dcc92 SC |
599 | Add path @var{searchdir} to the list of paths that @command{ld} will search |
600 | for archive libraries and @command{ld} control scripts. You may use this | |
252b5132 RH |
601 | option any number of times. The directories are searched in the order |
602 | in which they are specified on the command line. Directories specified | |
603 | on the command line are searched before the default directories. All | |
ff5dcc92 | 604 | @option{-L} options apply to all @option{-l} options, regardless of the |
252b5132 RH |
605 | order in which the options appear. |
606 | ||
607 | @ifset UsesEnvVars | |
608 | The default set of paths searched (without being specified with | |
ff5dcc92 | 609 | @samp{-L}) depends on which emulation mode @command{ld} is using, and in |
252b5132 RH |
610 | some cases also on how it was configured. @xref{Environment}. |
611 | @end ifset | |
612 | ||
613 | The paths can also be specified in a link script with the | |
614 | @code{SEARCH_DIR} command. Directories specified this way are searched | |
615 | at the point in which the linker script appears in the command line. | |
616 | ||
617 | @cindex emulation | |
618 | @kindex -m @var{emulation} | |
619 | @item -m@var{emulation} | |
620 | Emulate the @var{emulation} linker. You can list the available | |
621 | emulations with the @samp{--verbose} or @samp{-V} options. | |
622 | ||
623 | If the @samp{-m} option is not used, the emulation is taken from the | |
624 | @code{LDEMULATION} environment variable, if that is defined. | |
625 | ||
626 | Otherwise, the default emulation depends upon how the linker was | |
627 | configured. | |
628 | ||
629 | @cindex link map | |
630 | @kindex -M | |
631 | @kindex --print-map | |
632 | @item -M | |
633 | @itemx --print-map | |
634 | Print a link map to the standard output. A link map provides | |
635 | information about the link, including the following: | |
636 | ||
637 | @itemize @bullet | |
638 | @item | |
639 | Where object files and symbols are mapped into memory. | |
640 | @item | |
641 | How common symbols are allocated. | |
642 | @item | |
643 | All archive members included in the link, with a mention of the symbol | |
644 | which caused the archive member to be brought in. | |
645 | @end itemize | |
646 | ||
647 | @kindex -n | |
648 | @cindex read-only text | |
649 | @cindex NMAGIC | |
650 | @kindex --nmagic | |
651 | @item -n | |
652 | @itemx --nmagic | |
fa19fce0 | 653 | Turn off page alignment of sections, and mark the output as |
a1ab1d2a | 654 | @code{NMAGIC} if possible. |
252b5132 RH |
655 | |
656 | @kindex -N | |
657 | @kindex --omagic | |
658 | @cindex read/write from cmd line | |
659 | @cindex OMAGIC | |
a1ab1d2a | 660 | @item -N |
252b5132 RH |
661 | @itemx --omagic |
662 | Set the text and data sections to be readable and writable. Also, do | |
63fd3b82 NC |
663 | not page-align the data segment, and disable linking against shared |
664 | libraries. If the output format supports Unix style magic numbers, | |
665 | mark the output as @code{OMAGIC}. | |
666 | ||
667 | @kindex --no-omagic | |
668 | @cindex OMAGIC | |
669 | @item --no-omagic | |
670 | This option negates most of the effects of the @option{-N} option. It | |
671 | sets the text section to be read-only, and forces the data segment to | |
672 | be page-aligned. Note - this option does not enable linking against | |
673 | shared libraries. Use @option{-Bdynamic} for this. | |
252b5132 RH |
674 | |
675 | @kindex -o @var{output} | |
676 | @kindex --output=@var{output} | |
677 | @cindex naming the output file | |
678 | @item -o @var{output} | |
679 | @itemx --output=@var{output} | |
ff5dcc92 | 680 | Use @var{output} as the name for the program produced by @command{ld}; if this |
252b5132 RH |
681 | option is not specified, the name @file{a.out} is used by default. The |
682 | script command @code{OUTPUT} can also specify the output file name. | |
683 | ||
684 | @kindex -O @var{level} | |
685 | @cindex generating optimized output | |
686 | @item -O @var{level} | |
ff5dcc92 | 687 | If @var{level} is a numeric values greater than zero @command{ld} optimizes |
252b5132 RH |
688 | the output. This might take significantly longer and therefore probably |
689 | should only be enabled for the final binary. | |
690 | ||
a712da20 NC |
691 | @kindex -q |
692 | @kindex --emit-relocs | |
693 | @cindex retain relocations in final executable | |
694 | @item -q | |
695 | @itemx --emit-relocs | |
696 | Leave relocation sections and contents in fully linked exececutables. | |
697 | Post link analysis and optimization tools may need this information in | |
698 | order to perform correct modifications of executables. This results | |
699 | in larger executables. | |
700 | ||
dbab7a7b NC |
701 | This option is currently only supported on ELF platforms. |
702 | ||
252b5132 RH |
703 | @cindex partial link |
704 | @cindex relocatable output | |
705 | @kindex -r | |
706 | @kindex --relocateable | |
707 | @item -r | |
708 | @itemx --relocateable | |
709 | Generate relocatable output---i.e., generate an output file that can in | |
ff5dcc92 | 710 | turn serve as input to @command{ld}. This is often called @dfn{partial |
252b5132 RH |
711 | linking}. As a side effect, in environments that support standard Unix |
712 | magic numbers, this option also sets the output file's magic number to | |
713 | @code{OMAGIC}. | |
ff5dcc92 | 714 | @c ; see @option{-N}. |
252b5132 RH |
715 | If this option is not specified, an absolute file is produced. When |
716 | linking C++ programs, this option @emph{will not} resolve references to | |
717 | constructors; to do that, use @samp{-Ur}. | |
718 | ||
62bf86b4 HPN |
719 | When an input file does not have the same format as the output file, |
720 | partial linking is only supported if that input file does not contain any | |
721 | relocations. Different output formats can have further restrictions; for | |
722 | example some @code{a.out}-based formats do not support partial linking | |
723 | with input files in other formats at all. | |
724 | ||
252b5132 RH |
725 | This option does the same thing as @samp{-i}. |
726 | ||
727 | @kindex -R @var{file} | |
728 | @kindex --just-symbols=@var{file} | |
729 | @cindex symbol-only input | |
730 | @item -R @var{filename} | |
731 | @itemx --just-symbols=@var{filename} | |
732 | Read symbol names and their addresses from @var{filename}, but do not | |
733 | relocate it or include it in the output. This allows your output file | |
734 | to refer symbolically to absolute locations of memory defined in other | |
735 | programs. You may use this option more than once. | |
736 | ||
ff5dcc92 | 737 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 738 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 739 | the @option{-rpath} option. |
252b5132 RH |
740 | |
741 | @kindex -s | |
742 | @kindex --strip-all | |
743 | @cindex strip all symbols | |
a1ab1d2a | 744 | @item -s |
252b5132 RH |
745 | @itemx --strip-all |
746 | Omit all symbol information from the output file. | |
747 | ||
748 | @kindex -S | |
749 | @kindex --strip-debug | |
750 | @cindex strip debugger symbols | |
a1ab1d2a | 751 | @item -S |
252b5132 RH |
752 | @itemx --strip-debug |
753 | Omit debugger symbol information (but not all symbols) from the output file. | |
754 | ||
755 | @kindex -t | |
756 | @kindex --trace | |
757 | @cindex input files, displaying | |
a1ab1d2a | 758 | @item -t |
252b5132 | 759 | @itemx --trace |
ff5dcc92 | 760 | Print the names of the input files as @command{ld} processes them. |
252b5132 RH |
761 | |
762 | @kindex -T @var{script} | |
763 | @kindex --script=@var{script} | |
764 | @cindex script files | |
765 | @item -T @var{scriptfile} | |
766 | @itemx --script=@var{scriptfile} | |
767 | Use @var{scriptfile} as the linker script. This script replaces | |
ff5dcc92 | 768 | @command{ld}'s default linker script (rather than adding to it), so |
252b5132 | 769 | @var{commandfile} must specify everything necessary to describe the |
114283d8 NC |
770 | output file. @xref{Scripts}. If @var{scriptfile} does not exist in |
771 | the current directory, @code{ld} looks for it in the directories | |
772 | specified by any preceding @samp{-L} options. Multiple @samp{-T} | |
773 | options accumulate. | |
252b5132 RH |
774 | |
775 | @kindex -u @var{symbol} | |
776 | @kindex --undefined=@var{symbol} | |
777 | @cindex undefined symbol | |
778 | @item -u @var{symbol} | |
779 | @itemx --undefined=@var{symbol} | |
780 | Force @var{symbol} to be entered in the output file as an undefined | |
781 | symbol. Doing this may, for example, trigger linking of additional | |
782 | modules from standard libraries. @samp{-u} may be repeated with | |
783 | different option arguments to enter additional undefined symbols. This | |
784 | option is equivalent to the @code{EXTERN} linker script command. | |
785 | ||
786 | @kindex -Ur | |
787 | @cindex constructors | |
a1ab1d2a | 788 | @item -Ur |
252b5132 RH |
789 | For anything other than C++ programs, this option is equivalent to |
790 | @samp{-r}: it generates relocatable output---i.e., an output file that can in | |
ff5dcc92 | 791 | turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur} |
252b5132 RH |
792 | @emph{does} resolve references to constructors, unlike @samp{-r}. |
793 | It does not work to use @samp{-Ur} on files that were themselves linked | |
794 | with @samp{-Ur}; once the constructor table has been built, it cannot | |
795 | be added to. Use @samp{-Ur} only for the last partial link, and | |
796 | @samp{-r} for the others. | |
797 | ||
577a0623 AM |
798 | @kindex --unique[=@var{SECTION}] |
799 | @item --unique[=@var{SECTION}] | |
800 | Creates a separate output section for every input section matching | |
801 | @var{SECTION}, or if the optional wildcard @var{SECTION} argument is | |
802 | missing, for every orphan input section. An orphan section is one not | |
803 | specifically mentioned in a linker script. You may use this option | |
804 | multiple times on the command line; It prevents the normal merging of | |
805 | input sections with the same name, overriding output section assignments | |
806 | in a linker script. | |
a854a4a7 | 807 | |
252b5132 RH |
808 | @kindex -v |
809 | @kindex -V | |
810 | @kindex --version | |
811 | @cindex version | |
812 | @item -v | |
813 | @itemx --version | |
814 | @itemx -V | |
ff5dcc92 | 815 | Display the version number for @command{ld}. The @option{-V} option also |
252b5132 RH |
816 | lists the supported emulations. |
817 | ||
818 | @kindex -x | |
819 | @kindex --discard-all | |
820 | @cindex deleting local symbols | |
821 | @item -x | |
822 | @itemx --discard-all | |
823 | Delete all local symbols. | |
824 | ||
825 | @kindex -X | |
826 | @kindex --discard-locals | |
827 | @cindex local symbols, deleting | |
828 | @cindex L, deleting symbols beginning | |
a1ab1d2a | 829 | @item -X |
252b5132 RH |
830 | @itemx --discard-locals |
831 | Delete all temporary local symbols. For most targets, this is all local | |
832 | symbols whose names begin with @samp{L}. | |
833 | ||
834 | @kindex -y @var{symbol} | |
835 | @kindex --trace-symbol=@var{symbol} | |
836 | @cindex symbol tracing | |
837 | @item -y @var{symbol} | |
838 | @itemx --trace-symbol=@var{symbol} | |
839 | Print the name of each linked file in which @var{symbol} appears. This | |
840 | option may be given any number of times. On many systems it is necessary | |
841 | to prepend an underscore. | |
842 | ||
843 | This option is useful when you have an undefined symbol in your link but | |
844 | don't know where the reference is coming from. | |
845 | ||
846 | @kindex -Y @var{path} | |
847 | @item -Y @var{path} | |
848 | Add @var{path} to the default library search path. This option exists | |
849 | for Solaris compatibility. | |
850 | ||
851 | @kindex -z @var{keyword} | |
852 | @item -z @var{keyword} | |
e0ee487b L |
853 | The recognized keywords are @code{initfirst}, @code{interpose}, |
854 | @code{loadfltr}, @code{nodefaultlib}, @code{nodelete}, @code{nodlopen}, | |
8bd621d8 AM |
855 | @code{nodump}, @code{now}, @code{origin}, @code{combreloc}, @code{nocombreloc} |
856 | and @code{nocopyreloc}. | |
857 | The other keywords are | |
e0ee487b L |
858 | ignored for Solaris compatibility. @code{initfirst} marks the object |
859 | to be initialized first at runtime before any other objects. | |
860 | @code{interpose} marks the object that its symbol table interposes | |
861 | before all symbols but the primary executable. @code{loadfltr} marks | |
862 | the object that its filtees be processed immediately at runtime. | |
863 | @code{nodefaultlib} marks the object that the search for dependencies | |
864 | of this object will ignore any default library search paths. | |
865 | @code{nodelete} marks the object shouldn't be unloaded at runtime. | |
866 | @code{nodlopen} marks the object not available to @code{dlopen}. | |
867 | @code{nodump} marks the object can not be dumped by @code{dldump}. | |
868 | @code{now} marks the object with the non-lazy runtime binding. | |
869 | @code{origin} marks the object may contain $ORIGIN. | |
a1ab1d2a | 870 | @code{defs} disallows undefined symbols. |
aa713662 | 871 | @code{muldefs} allows multiple definitions. |
db6751f2 JJ |
872 | @code{combreloc} combines multiple reloc sections and sorts them |
873 | to make dynamic symbol lookup caching possible. | |
874 | @code{nocombreloc} disables multiple reloc sections combining. | |
8bd621d8 | 875 | @code{nocopyreloc} disables production of copy relocs. |
252b5132 RH |
876 | |
877 | @kindex -( | |
878 | @cindex groups of archives | |
879 | @item -( @var{archives} -) | |
880 | @itemx --start-group @var{archives} --end-group | |
881 | The @var{archives} should be a list of archive files. They may be | |
882 | either explicit file names, or @samp{-l} options. | |
883 | ||
884 | The specified archives are searched repeatedly until no new undefined | |
885 | references are created. Normally, an archive is searched only once in | |
886 | the order that it is specified on the command line. If a symbol in that | |
887 | archive is needed to resolve an undefined symbol referred to by an | |
888 | object in an archive that appears later on the command line, the linker | |
889 | would not be able to resolve that reference. By grouping the archives, | |
890 | they all be searched repeatedly until all possible references are | |
891 | resolved. | |
892 | ||
893 | Using this option has a significant performance cost. It is best to use | |
894 | it only when there are unavoidable circular references between two or | |
895 | more archives. | |
896 | ||
897 | @kindex -assert @var{keyword} | |
898 | @item -assert @var{keyword} | |
899 | This option is ignored for SunOS compatibility. | |
900 | ||
901 | @kindex -Bdynamic | |
902 | @kindex -dy | |
903 | @kindex -call_shared | |
904 | @item -Bdynamic | |
905 | @itemx -dy | |
906 | @itemx -call_shared | |
907 | Link against dynamic libraries. This is only meaningful on platforms | |
908 | for which shared libraries are supported. This option is normally the | |
909 | default on such platforms. The different variants of this option are | |
910 | for compatibility with various systems. You may use this option | |
911 | multiple times on the command line: it affects library searching for | |
ff5dcc92 | 912 | @option{-l} options which follow it. |
252b5132 | 913 | |
a1ab1d2a UD |
914 | @kindex -Bgroup |
915 | @item -Bgroup | |
916 | Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic | |
917 | section. This causes the runtime linker to handle lookups in this | |
918 | object and its dependencies to be performed only inside the group. | |
ff5dcc92 | 919 | @option{--no-undefined} is implied. This option is only meaningful on ELF |
a1ab1d2a UD |
920 | platforms which support shared libraries. |
921 | ||
252b5132 RH |
922 | @kindex -Bstatic |
923 | @kindex -dn | |
924 | @kindex -non_shared | |
925 | @kindex -static | |
a1ab1d2a | 926 | @item -Bstatic |
252b5132 RH |
927 | @itemx -dn |
928 | @itemx -non_shared | |
929 | @itemx -static | |
930 | Do not link against shared libraries. This is only meaningful on | |
931 | platforms for which shared libraries are supported. The different | |
932 | variants of this option are for compatibility with various systems. You | |
933 | may use this option multiple times on the command line: it affects | |
ff5dcc92 | 934 | library searching for @option{-l} options which follow it. |
252b5132 RH |
935 | |
936 | @kindex -Bsymbolic | |
937 | @item -Bsymbolic | |
938 | When creating a shared library, bind references to global symbols to the | |
939 | definition within the shared library, if any. Normally, it is possible | |
940 | for a program linked against a shared library to override the definition | |
941 | within the shared library. This option is only meaningful on ELF | |
942 | platforms which support shared libraries. | |
943 | ||
944 | @kindex --check-sections | |
945 | @kindex --no-check-sections | |
946 | @item --check-sections | |
308b1ffd | 947 | @itemx --no-check-sections |
252b5132 RH |
948 | Asks the linker @emph{not} to check section addresses after they have |
949 | been assigned to see if there any overlaps. Normally the linker will | |
950 | perform this check, and if it finds any overlaps it will produce | |
951 | suitable error messages. The linker does know about, and does make | |
952 | allowances for sections in overlays. The default behaviour can be | |
953 | restored by using the command line switch @samp{--check-sections}. | |
954 | ||
955 | @cindex cross reference table | |
956 | @kindex --cref | |
957 | @item --cref | |
958 | Output a cross reference table. If a linker map file is being | |
959 | generated, the cross reference table is printed to the map file. | |
960 | Otherwise, it is printed on the standard output. | |
961 | ||
962 | The format of the table is intentionally simple, so that it may be | |
963 | easily processed by a script if necessary. The symbols are printed out, | |
964 | sorted by name. For each symbol, a list of file names is given. If the | |
965 | symbol is defined, the first file listed is the location of the | |
966 | definition. The remaining files contain references to the symbol. | |
967 | ||
4818e05f AM |
968 | @cindex common allocation |
969 | @kindex --no-define-common | |
970 | @item --no-define-common | |
971 | This option inhibits the assignment of addresses to common symbols. | |
972 | The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect. | |
973 | @xref{Miscellaneous Commands}. | |
974 | ||
975 | The @samp{--no-define-common} option allows decoupling | |
976 | the decision to assign addresses to Common symbols from the choice | |
977 | of the output file type; otherwise a non-Relocatable output type | |
978 | forces assigning addresses to Common symbols. | |
979 | Using @samp{--no-define-common} allows Common symbols that are referenced | |
980 | from a shared library to be assigned addresses only in the main program. | |
981 | This eliminates the unused duplicate space in the shared library, | |
982 | and also prevents any possible confusion over resolving to the wrong | |
983 | duplicate when there are many dynamic modules with specialized search | |
984 | paths for runtime symbol resolution. | |
985 | ||
252b5132 RH |
986 | @cindex symbols, from command line |
987 | @kindex --defsym @var{symbol}=@var{exp} | |
988 | @item --defsym @var{symbol}=@var{expression} | |
989 | Create a global symbol in the output file, containing the absolute | |
990 | address given by @var{expression}. You may use this option as many | |
991 | times as necessary to define multiple symbols in the command line. A | |
992 | limited form of arithmetic is supported for the @var{expression} in this | |
993 | context: you may give a hexadecimal constant or the name of an existing | |
994 | symbol, or use @code{+} and @code{-} to add or subtract hexadecimal | |
995 | constants or symbols. If you need more elaborate expressions, consider | |
996 | using the linker command language from a script (@pxref{Assignments,, | |
997 | Assignment: Symbol Definitions}). @emph{Note:} there should be no white | |
998 | space between @var{symbol}, the equals sign (``@key{=}''), and | |
999 | @var{expression}. | |
1000 | ||
1001 | @cindex demangling, from command line | |
28c309a2 | 1002 | @kindex --demangle[=@var{style}] |
252b5132 | 1003 | @kindex --no-demangle |
28c309a2 | 1004 | @item --demangle[=@var{style}] |
252b5132 RH |
1005 | @itemx --no-demangle |
1006 | These options control whether to demangle symbol names in error messages | |
1007 | and other output. When the linker is told to demangle, it tries to | |
1008 | present symbol names in a readable fashion: it strips leading | |
1009 | underscores if they are used by the object file format, and converts C++ | |
a1ab1d2a UD |
1010 | mangled symbol names into user readable names. Different compilers have |
1011 | different mangling styles. The optional demangling style argument can be used | |
1012 | to choose an appropriate demangling style for your compiler. The linker will | |
28c309a2 NC |
1013 | demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE} |
1014 | is set. These options may be used to override the default. | |
252b5132 RH |
1015 | |
1016 | @cindex dynamic linker, from command line | |
506eee22 | 1017 | @kindex -I@var{file} |
252b5132 RH |
1018 | @kindex --dynamic-linker @var{file} |
1019 | @item --dynamic-linker @var{file} | |
1020 | Set the name of the dynamic linker. This is only meaningful when | |
1021 | generating dynamically linked ELF executables. The default dynamic | |
1022 | linker is normally correct; don't use this unless you know what you are | |
1023 | doing. | |
1024 | ||
1025 | @cindex MIPS embedded PIC code | |
1026 | @kindex --embedded-relocs | |
1027 | @item --embedded-relocs | |
1028 | This option is only meaningful when linking MIPS embedded PIC code, | |
1029 | generated by the -membedded-pic option to the @sc{gnu} compiler and | |
1030 | assembler. It causes the linker to create a table which may be used at | |
1031 | runtime to relocate any data which was statically initialized to pointer | |
1032 | values. See the code in testsuite/ld-empic for details. | |
1033 | ||
7ce691ae C |
1034 | |
1035 | @kindex --fatal-warnings | |
1036 | @item --fatal-warnings | |
1037 | Treat all warnings as errors. | |
1038 | ||
252b5132 RH |
1039 | @kindex --force-exe-suffix |
1040 | @item --force-exe-suffix | |
1041 | Make sure that an output file has a .exe suffix. | |
1042 | ||
1043 | If a successfully built fully linked output file does not have a | |
1044 | @code{.exe} or @code{.dll} suffix, this option forces the linker to copy | |
1045 | the output file to one of the same name with a @code{.exe} suffix. This | |
1046 | option is useful when using unmodified Unix makefiles on a Microsoft | |
1047 | Windows host, since some versions of Windows won't run an image unless | |
1048 | it ends in a @code{.exe} suffix. | |
1049 | ||
1050 | @kindex --gc-sections | |
1051 | @kindex --no-gc-sections | |
1052 | @cindex garbage collection | |
1053 | @item --no-gc-sections | |
1054 | @itemx --gc-sections | |
1055 | Enable garbage collection of unused input sections. It is ignored on | |
1056 | targets that do not support this option. This option is not compatible | |
1057 | with @samp{-r}, nor should it be used with dynamic linking. The default | |
1058 | behaviour (of not performing this garbage collection) can be restored by | |
1059 | specifying @samp{--no-gc-sections} on the command line. | |
1060 | ||
1061 | @cindex help | |
1062 | @cindex usage | |
1063 | @kindex --help | |
1064 | @item --help | |
1065 | Print a summary of the command-line options on the standard output and exit. | |
1066 | ||
ea20a7da CC |
1067 | @kindex --target-help |
1068 | @item --target-help | |
1069 | Print a summary of all target specific options on the standard output and exit. | |
1070 | ||
252b5132 RH |
1071 | @kindex -Map |
1072 | @item -Map @var{mapfile} | |
1073 | Print a link map to the file @var{mapfile}. See the description of the | |
1074 | @samp{-M} option, above. | |
1075 | ||
1076 | @cindex memory usage | |
1077 | @kindex --no-keep-memory | |
1078 | @item --no-keep-memory | |
ff5dcc92 SC |
1079 | @command{ld} normally optimizes for speed over memory usage by caching the |
1080 | symbol tables of input files in memory. This option tells @command{ld} to | |
252b5132 | 1081 | instead optimize for memory usage, by rereading the symbol tables as |
ff5dcc92 | 1082 | necessary. This may be required if @command{ld} runs out of memory space |
252b5132 RH |
1083 | while linking a large executable. |
1084 | ||
1085 | @kindex --no-undefined | |
a1ab1d2a | 1086 | @kindex -z defs |
252b5132 | 1087 | @item --no-undefined |
a1ab1d2a | 1088 | @itemx -z defs |
252b5132 | 1089 | Normally when creating a non-symbolic shared library, undefined symbols |
a1ab1d2a | 1090 | are allowed and left to be resolved by the runtime loader. These options |
252b5132 RH |
1091 | disallows such undefined symbols. |
1092 | ||
aa713662 L |
1093 | @kindex --allow-multiple-definition |
1094 | @kindex -z muldefs | |
1095 | @item --allow-multiple-definition | |
1096 | @itemx -z muldefs | |
1097 | Normally when a symbol is defined multiple times, the linker will | |
1098 | report a fatal error. These options allow multiple definitions and the | |
1099 | first definition will be used. | |
1100 | ||
b79e8c78 NC |
1101 | @kindex --allow-shlib-undefined |
1102 | @item --allow-shlib-undefined | |
1103 | Allow undefined symbols in shared objects even when --no-undefined is | |
1104 | set. The net result will be that undefined symbols in regular objects | |
1105 | will still trigger an error, but undefined symbols in shared objects | |
1106 | will be ignored. The implementation of no_undefined makes the | |
1107 | assumption that the runtime linker will choke on undefined symbols. | |
1108 | However there is at least one system (BeOS) where undefined symbols in | |
1109 | shared libraries is normal since the kernel patches them at load time to | |
1110 | select which function is most appropriate for the current architecture. | |
1111 | I.E. dynamically select an appropriate memset function. Apparently it | |
1112 | is also normal for HPPA shared libraries to have undefined symbols. | |
1113 | ||
31941635 L |
1114 | @kindex --no-undefined-version |
1115 | @item --no-undefined-version | |
1116 | Normally when a symbol has an undefined version, the linker will ignore | |
1117 | it. This option disallows symbols with undefined version and a fatal error | |
1118 | will be issued instead. | |
1119 | ||
252b5132 RH |
1120 | @kindex --no-warn-mismatch |
1121 | @item --no-warn-mismatch | |
ff5dcc92 | 1122 | Normally @command{ld} will give an error if you try to link together input |
252b5132 RH |
1123 | files that are mismatched for some reason, perhaps because they have |
1124 | been compiled for different processors or for different endiannesses. | |
ff5dcc92 | 1125 | This option tells @command{ld} that it should silently permit such possible |
252b5132 RH |
1126 | errors. This option should only be used with care, in cases when you |
1127 | have taken some special action that ensures that the linker errors are | |
1128 | inappropriate. | |
1129 | ||
1130 | @kindex --no-whole-archive | |
1131 | @item --no-whole-archive | |
ff5dcc92 | 1132 | Turn off the effect of the @option{--whole-archive} option for subsequent |
252b5132 RH |
1133 | archive files. |
1134 | ||
1135 | @cindex output file after errors | |
1136 | @kindex --noinhibit-exec | |
1137 | @item --noinhibit-exec | |
1138 | Retain the executable output file whenever it is still usable. | |
1139 | Normally, the linker will not produce an output file if it encounters | |
1140 | errors during the link process; it exits without writing an output file | |
1141 | when it issues any error whatsoever. | |
1142 | ||
0a9c1c8e CD |
1143 | @kindex -nostdlib |
1144 | @item -nostdlib | |
1145 | Only search library directories explicitly specified on the | |
1146 | command line. Library directories specified in linker scripts | |
1147 | (including linker scripts specified on the command line) are ignored. | |
1148 | ||
252b5132 RH |
1149 | @ifclear SingleFormat |
1150 | @kindex --oformat | |
1151 | @item --oformat @var{output-format} | |
ff5dcc92 SC |
1152 | @command{ld} may be configured to support more than one kind of object |
1153 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 1154 | @samp{--oformat} option to specify the binary format for the output |
ff5dcc92 SC |
1155 | object file. Even when @command{ld} is configured to support alternative |
1156 | object formats, you don't usually need to specify this, as @command{ld} | |
252b5132 RH |
1157 | should be configured to produce as a default output format the most |
1158 | usual format on each machine. @var{output-format} is a text string, the | |
1159 | name of a particular format supported by the BFD libraries. (You can | |
1160 | list the available binary formats with @samp{objdump -i}.) The script | |
1161 | command @code{OUTPUT_FORMAT} can also specify the output format, but | |
1162 | this option overrides it. @xref{BFD}. | |
1163 | @end ifclear | |
1164 | ||
1165 | @kindex -qmagic | |
1166 | @item -qmagic | |
1167 | This option is ignored for Linux compatibility. | |
1168 | ||
1169 | @kindex -Qy | |
1170 | @item -Qy | |
1171 | This option is ignored for SVR4 compatibility. | |
1172 | ||
1173 | @kindex --relax | |
1174 | @cindex synthesizing linker | |
1175 | @cindex relaxing addressing modes | |
1176 | @item --relax | |
a1ab1d2a | 1177 | An option with machine dependent effects. |
252b5132 RH |
1178 | @ifset GENERIC |
1179 | This option is only supported on a few targets. | |
1180 | @end ifset | |
1181 | @ifset H8300 | |
ff5dcc92 | 1182 | @xref{H8/300,,@command{ld} and the H8/300}. |
252b5132 RH |
1183 | @end ifset |
1184 | @ifset I960 | |
ff5dcc92 | 1185 | @xref{i960,, @command{ld} and the Intel 960 family}. |
252b5132 RH |
1186 | @end ifset |
1187 | ||
1188 | ||
1189 | On some platforms, the @samp{--relax} option performs global | |
1190 | optimizations that become possible when the linker resolves addressing | |
1191 | in the program, such as relaxing address modes and synthesizing new | |
1192 | instructions in the output object file. | |
1193 | ||
1194 | On some platforms these link time global optimizations may make symbolic | |
1195 | debugging of the resulting executable impossible. | |
1196 | @ifset GENERIC | |
1197 | This is known to be | |
1198 | the case for the Matsushita MN10200 and MN10300 family of processors. | |
1199 | @end ifset | |
1200 | ||
1201 | @ifset GENERIC | |
1202 | On platforms where this is not supported, @samp{--relax} is accepted, | |
1203 | but ignored. | |
1204 | @end ifset | |
1205 | ||
1206 | @cindex retaining specified symbols | |
1207 | @cindex stripping all but some symbols | |
1208 | @cindex symbols, retaining selectively | |
1209 | @item --retain-symbols-file @var{filename} | |
1210 | Retain @emph{only} the symbols listed in the file @var{filename}, | |
1211 | discarding all others. @var{filename} is simply a flat file, with one | |
1212 | symbol name per line. This option is especially useful in environments | |
1213 | @ifset GENERIC | |
1214 | (such as VxWorks) | |
1215 | @end ifset | |
1216 | where a large global symbol table is accumulated gradually, to conserve | |
1217 | run-time memory. | |
1218 | ||
1219 | @samp{--retain-symbols-file} does @emph{not} discard undefined symbols, | |
1220 | or symbols needed for relocations. | |
1221 | ||
1222 | You may only specify @samp{--retain-symbols-file} once in the command | |
1223 | line. It overrides @samp{-s} and @samp{-S}. | |
1224 | ||
1225 | @ifset GENERIC | |
1226 | @item -rpath @var{dir} | |
1227 | @cindex runtime library search path | |
1228 | @kindex -rpath | |
1229 | Add a directory to the runtime library search path. This is used when | |
ff5dcc92 | 1230 | linking an ELF executable with shared objects. All @option{-rpath} |
252b5132 | 1231 | arguments are concatenated and passed to the runtime linker, which uses |
ff5dcc92 | 1232 | them to locate shared objects at runtime. The @option{-rpath} option is |
252b5132 RH |
1233 | also used when locating shared objects which are needed by shared |
1234 | objects explicitly included in the link; see the description of the | |
ff5dcc92 | 1235 | @option{-rpath-link} option. If @option{-rpath} is not used when linking an |
252b5132 RH |
1236 | ELF executable, the contents of the environment variable |
1237 | @code{LD_RUN_PATH} will be used if it is defined. | |
1238 | ||
ff5dcc92 | 1239 | The @option{-rpath} option may also be used on SunOS. By default, on |
252b5132 | 1240 | SunOS, the linker will form a runtime search patch out of all the |
ff5dcc92 SC |
1241 | @option{-L} options it is given. If a @option{-rpath} option is used, the |
1242 | runtime search path will be formed exclusively using the @option{-rpath} | |
1243 | options, ignoring the @option{-L} options. This can be useful when using | |
1244 | gcc, which adds many @option{-L} options which may be on NFS mounted | |
252b5132 RH |
1245 | filesystems. |
1246 | ||
ff5dcc92 | 1247 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 1248 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 1249 | the @option{-rpath} option. |
252b5132 RH |
1250 | @end ifset |
1251 | ||
1252 | @ifset GENERIC | |
1253 | @cindex link-time runtime library search path | |
1254 | @kindex -rpath-link | |
1255 | @item -rpath-link @var{DIR} | |
1256 | When using ELF or SunOS, one shared library may require another. This | |
1257 | happens when an @code{ld -shared} link includes a shared library as one | |
1258 | of the input files. | |
1259 | ||
1260 | When the linker encounters such a dependency when doing a non-shared, | |
1261 | non-relocatable link, it will automatically try to locate the required | |
1262 | shared library and include it in the link, if it is not included | |
ff5dcc92 | 1263 | explicitly. In such a case, the @option{-rpath-link} option |
252b5132 | 1264 | specifies the first set of directories to search. The |
ff5dcc92 | 1265 | @option{-rpath-link} option may specify a sequence of directory names |
252b5132 RH |
1266 | either by specifying a list of names separated by colons, or by |
1267 | appearing multiple times. | |
1268 | ||
28c309a2 NC |
1269 | This option should be used with caution as it overrides the search path |
1270 | that may have been hard compiled into a shared library. In such a case it | |
1271 | is possible to use unintentionally a different search path than the | |
1272 | runtime linker would do. | |
1273 | ||
252b5132 RH |
1274 | The linker uses the following search paths to locate required shared |
1275 | libraries. | |
1276 | @enumerate | |
1277 | @item | |
ff5dcc92 | 1278 | Any directories specified by @option{-rpath-link} options. |
252b5132 | 1279 | @item |
ff5dcc92 SC |
1280 | Any directories specified by @option{-rpath} options. The difference |
1281 | between @option{-rpath} and @option{-rpath-link} is that directories | |
1282 | specified by @option{-rpath} options are included in the executable and | |
1283 | used at runtime, whereas the @option{-rpath-link} option is only effective | |
dcb0bd0e | 1284 | at link time. It is for the native linker only. |
252b5132 | 1285 | @item |
ff5dcc92 | 1286 | On an ELF system, if the @option{-rpath} and @code{rpath-link} options |
252b5132 | 1287 | were not used, search the contents of the environment variable |
dcb0bd0e | 1288 | @code{LD_RUN_PATH}. It is for the native linker only. |
252b5132 | 1289 | @item |
ff5dcc92 SC |
1290 | On SunOS, if the @option{-rpath} option was not used, search any |
1291 | directories specified using @option{-L} options. | |
252b5132 RH |
1292 | @item |
1293 | For a native linker, the contents of the environment variable | |
1294 | @code{LD_LIBRARY_PATH}. | |
1295 | @item | |
ec4eb78a L |
1296 | For a native ELF linker, the directories in @code{DT_RUNPATH} or |
1297 | @code{DT_RPATH} of a shared library are searched for shared | |
1298 | libraries needed by it. The @code{DT_RPATH} entries are ignored if | |
1299 | @code{DT_RUNPATH} entries exist. | |
1300 | @item | |
252b5132 RH |
1301 | The default directories, normally @file{/lib} and @file{/usr/lib}. |
1302 | @item | |
1303 | For a native linker on an ELF system, if the file @file{/etc/ld.so.conf} | |
1304 | exists, the list of directories found in that file. | |
1305 | @end enumerate | |
1306 | ||
1307 | If the required shared library is not found, the linker will issue a | |
1308 | warning and continue with the link. | |
1309 | @end ifset | |
1310 | ||
1311 | @kindex -shared | |
1312 | @kindex -Bshareable | |
1313 | @item -shared | |
1314 | @itemx -Bshareable | |
1315 | @cindex shared libraries | |
1316 | Create a shared library. This is currently only supported on ELF, XCOFF | |
1317 | and SunOS platforms. On SunOS, the linker will automatically create a | |
ff5dcc92 | 1318 | shared library if the @option{-e} option is not used and there are |
252b5132 RH |
1319 | undefined symbols in the link. |
1320 | ||
1321 | @item --sort-common | |
1322 | @kindex --sort-common | |
ff5dcc92 | 1323 | This option tells @command{ld} to sort the common symbols by size when it |
252b5132 | 1324 | places them in the appropriate output sections. First come all the one |
563e308f | 1325 | byte symbols, then all the two byte, then all the four byte, and then |
252b5132 RH |
1326 | everything else. This is to prevent gaps between symbols due to |
1327 | alignment constraints. | |
1328 | ||
1329 | @kindex --split-by-file | |
a854a4a7 | 1330 | @item --split-by-file [@var{size}] |
ff5dcc92 | 1331 | Similar to @option{--split-by-reloc} but creates a new output section for |
a854a4a7 AM |
1332 | each input file when @var{size} is reached. @var{size} defaults to a |
1333 | size of 1 if not given. | |
252b5132 RH |
1334 | |
1335 | @kindex --split-by-reloc | |
a854a4a7 AM |
1336 | @item --split-by-reloc [@var{count}] |
1337 | Tries to creates extra sections in the output file so that no single | |
252b5132 | 1338 | output section in the file contains more than @var{count} relocations. |
a854a4a7 | 1339 | This is useful when generating huge relocatable files for downloading into |
252b5132 RH |
1340 | certain real time kernels with the COFF object file format; since COFF |
1341 | cannot represent more than 65535 relocations in a single section. Note | |
1342 | that this will fail to work with object file formats which do not | |
1343 | support arbitrary sections. The linker will not split up individual | |
1344 | input sections for redistribution, so if a single input section contains | |
1345 | more than @var{count} relocations one output section will contain that | |
a854a4a7 | 1346 | many relocations. @var{count} defaults to a value of 32768. |
252b5132 RH |
1347 | |
1348 | @kindex --stats | |
1349 | @item --stats | |
1350 | Compute and display statistics about the operation of the linker, such | |
1351 | as execution time and memory usage. | |
1352 | ||
1353 | @kindex --traditional-format | |
1354 | @cindex traditional format | |
1355 | @item --traditional-format | |
ff5dcc92 SC |
1356 | For some targets, the output of @command{ld} is different in some ways from |
1357 | the output of some existing linker. This switch requests @command{ld} to | |
252b5132 RH |
1358 | use the traditional format instead. |
1359 | ||
1360 | @cindex dbx | |
ff5dcc92 | 1361 | For example, on SunOS, @command{ld} combines duplicate entries in the |
252b5132 RH |
1362 | symbol string table. This can reduce the size of an output file with |
1363 | full debugging information by over 30 percent. Unfortunately, the SunOS | |
1364 | @code{dbx} program can not read the resulting program (@code{gdb} has no | |
ff5dcc92 | 1365 | trouble). The @samp{--traditional-format} switch tells @command{ld} to not |
252b5132 RH |
1366 | combine duplicate entries. |
1367 | ||
176355da NC |
1368 | @kindex --section-start @var{sectionname}=@var{org} |
1369 | @item --section-start @var{sectionname}=@var{org} | |
1370 | Locate a section in the output file at the absolute | |
1371 | address given by @var{org}. You may use this option as many | |
1372 | times as necessary to locate multiple sections in the command | |
1373 | line. | |
1374 | @var{org} must be a single hexadecimal integer; | |
1375 | for compatibility with other linkers, you may omit the leading | |
1376 | @samp{0x} usually associated with hexadecimal values. @emph{Note:} there | |
1377 | should be no white space between @var{sectionname}, the equals | |
1378 | sign (``@key{=}''), and @var{org}. | |
1379 | ||
252b5132 RH |
1380 | @kindex -Tbss @var{org} |
1381 | @kindex -Tdata @var{org} | |
1382 | @kindex -Ttext @var{org} | |
1383 | @cindex segment origins, cmd line | |
1384 | @item -Tbss @var{org} | |
1385 | @itemx -Tdata @var{org} | |
1386 | @itemx -Ttext @var{org} | |
1387 | Use @var{org} as the starting address for---respectively---the | |
1388 | @code{bss}, @code{data}, or the @code{text} segment of the output file. | |
1389 | @var{org} must be a single hexadecimal integer; | |
1390 | for compatibility with other linkers, you may omit the leading | |
1391 | @samp{0x} usually associated with hexadecimal values. | |
1392 | ||
1393 | @kindex --verbose | |
1394 | @cindex verbose | |
1395 | @item --dll-verbose | |
308b1ffd | 1396 | @itemx --verbose |
ff5dcc92 | 1397 | Display the version number for @command{ld} and list the linker emulations |
252b5132 | 1398 | supported. Display which input files can and cannot be opened. Display |
b9a8de1e | 1399 | the linker script being used by the linker. |
252b5132 RH |
1400 | |
1401 | @kindex --version-script=@var{version-scriptfile} | |
1402 | @cindex version script, symbol versions | |
1403 | @itemx --version-script=@var{version-scriptfile} | |
1404 | Specify the name of a version script to the linker. This is typically | |
1405 | used when creating shared libraries to specify additional information | |
1406 | about the version heirarchy for the library being created. This option | |
1407 | is only meaningful on ELF platforms which support shared libraries. | |
1408 | @xref{VERSION}. | |
1409 | ||
7ce691ae | 1410 | @kindex --warn-common |
252b5132 RH |
1411 | @cindex warnings, on combining symbols |
1412 | @cindex combining symbols, warnings on | |
1413 | @item --warn-common | |
1414 | Warn when a common symbol is combined with another common symbol or with | |
1415 | a symbol definition. Unix linkers allow this somewhat sloppy practice, | |
1416 | but linkers on some other operating systems do not. This option allows | |
1417 | you to find potential problems from combining global symbols. | |
1418 | Unfortunately, some C libraries use this practice, so you may get some | |
1419 | warnings about symbols in the libraries as well as in your programs. | |
1420 | ||
1421 | There are three kinds of global symbols, illustrated here by C examples: | |
1422 | ||
1423 | @table @samp | |
1424 | @item int i = 1; | |
1425 | A definition, which goes in the initialized data section of the output | |
1426 | file. | |
1427 | ||
1428 | @item extern int i; | |
1429 | An undefined reference, which does not allocate space. | |
1430 | There must be either a definition or a common symbol for the | |
1431 | variable somewhere. | |
1432 | ||
1433 | @item int i; | |
1434 | A common symbol. If there are only (one or more) common symbols for a | |
1435 | variable, it goes in the uninitialized data area of the output file. | |
1436 | The linker merges multiple common symbols for the same variable into a | |
1437 | single symbol. If they are of different sizes, it picks the largest | |
1438 | size. The linker turns a common symbol into a declaration, if there is | |
1439 | a definition of the same variable. | |
1440 | @end table | |
1441 | ||
1442 | The @samp{--warn-common} option can produce five kinds of warnings. | |
1443 | Each warning consists of a pair of lines: the first describes the symbol | |
1444 | just encountered, and the second describes the previous symbol | |
1445 | encountered with the same name. One or both of the two symbols will be | |
1446 | a common symbol. | |
1447 | ||
1448 | @enumerate | |
1449 | @item | |
1450 | Turning a common symbol into a reference, because there is already a | |
1451 | definition for the symbol. | |
1452 | @smallexample | |
1453 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1454 | overridden by definition | |
1455 | @var{file}(@var{section}): warning: defined here | |
1456 | @end smallexample | |
1457 | ||
1458 | @item | |
1459 | Turning a common symbol into a reference, because a later definition for | |
1460 | the symbol is encountered. This is the same as the previous case, | |
1461 | except that the symbols are encountered in a different order. | |
1462 | @smallexample | |
1463 | @var{file}(@var{section}): warning: definition of `@var{symbol}' | |
1464 | overriding common | |
1465 | @var{file}(@var{section}): warning: common is here | |
1466 | @end smallexample | |
1467 | ||
1468 | @item | |
1469 | Merging a common symbol with a previous same-sized common symbol. | |
1470 | @smallexample | |
1471 | @var{file}(@var{section}): warning: multiple common | |
1472 | of `@var{symbol}' | |
1473 | @var{file}(@var{section}): warning: previous common is here | |
1474 | @end smallexample | |
1475 | ||
1476 | @item | |
1477 | Merging a common symbol with a previous larger common symbol. | |
1478 | @smallexample | |
1479 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1480 | overridden by larger common | |
1481 | @var{file}(@var{section}): warning: larger common is here | |
1482 | @end smallexample | |
1483 | ||
1484 | @item | |
1485 | Merging a common symbol with a previous smaller common symbol. This is | |
1486 | the same as the previous case, except that the symbols are | |
1487 | encountered in a different order. | |
1488 | @smallexample | |
1489 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1490 | overriding smaller common | |
1491 | @var{file}(@var{section}): warning: smaller common is here | |
1492 | @end smallexample | |
1493 | @end enumerate | |
1494 | ||
1495 | @kindex --warn-constructors | |
1496 | @item --warn-constructors | |
1497 | Warn if any global constructors are used. This is only useful for a few | |
1498 | object file formats. For formats like COFF or ELF, the linker can not | |
1499 | detect the use of global constructors. | |
1500 | ||
1501 | @kindex --warn-multiple-gp | |
1502 | @item --warn-multiple-gp | |
1503 | Warn if multiple global pointer values are required in the output file. | |
1504 | This is only meaningful for certain processors, such as the Alpha. | |
1505 | Specifically, some processors put large-valued constants in a special | |
1506 | section. A special register (the global pointer) points into the middle | |
1507 | of this section, so that constants can be loaded efficiently via a | |
1508 | base-register relative addressing mode. Since the offset in | |
1509 | base-register relative mode is fixed and relatively small (e.g., 16 | |
1510 | bits), this limits the maximum size of the constant pool. Thus, in | |
1511 | large programs, it is often necessary to use multiple global pointer | |
1512 | values in order to be able to address all possible constants. This | |
1513 | option causes a warning to be issued whenever this case occurs. | |
1514 | ||
1515 | @kindex --warn-once | |
1516 | @cindex warnings, on undefined symbols | |
1517 | @cindex undefined symbols, warnings on | |
1518 | @item --warn-once | |
1519 | Only warn once for each undefined symbol, rather than once per module | |
1520 | which refers to it. | |
1521 | ||
1522 | @kindex --warn-section-align | |
1523 | @cindex warnings, on section alignment | |
1524 | @cindex section alignment, warnings on | |
1525 | @item --warn-section-align | |
1526 | Warn if the address of an output section is changed because of | |
1527 | alignment. Typically, the alignment will be set by an input section. | |
1528 | The address will only be changed if it not explicitly specified; that | |
1529 | is, if the @code{SECTIONS} command does not specify a start address for | |
1530 | the section (@pxref{SECTIONS}). | |
1531 | ||
1532 | @kindex --whole-archive | |
1533 | @cindex including an entire archive | |
1534 | @item --whole-archive | |
1535 | For each archive mentioned on the command line after the | |
ff5dcc92 | 1536 | @option{--whole-archive} option, include every object file in the archive |
252b5132 RH |
1537 | in the link, rather than searching the archive for the required object |
1538 | files. This is normally used to turn an archive file into a shared | |
1539 | library, forcing every object to be included in the resulting shared | |
1540 | library. This option may be used more than once. | |
1541 | ||
7ec229ce | 1542 | Two notes when using this option from gcc: First, gcc doesn't know |
ff5dcc92 SC |
1543 | about this option, so you have to use @option{-Wl,-whole-archive}. |
1544 | Second, don't forget to use @option{-Wl,-no-whole-archive} after your | |
7ec229ce DD |
1545 | list of archives, because gcc will add its own list of archives to |
1546 | your link and you may not want this flag to affect those as well. | |
1547 | ||
252b5132 RH |
1548 | @kindex --wrap |
1549 | @item --wrap @var{symbol} | |
1550 | Use a wrapper function for @var{symbol}. Any undefined reference to | |
1551 | @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any | |
1552 | undefined reference to @code{__real_@var{symbol}} will be resolved to | |
1553 | @var{symbol}. | |
1554 | ||
1555 | This can be used to provide a wrapper for a system function. The | |
1556 | wrapper function should be called @code{__wrap_@var{symbol}}. If it | |
1557 | wishes to call the system function, it should call | |
1558 | @code{__real_@var{symbol}}. | |
1559 | ||
1560 | Here is a trivial example: | |
1561 | ||
1562 | @smallexample | |
1563 | void * | |
1564 | __wrap_malloc (int c) | |
1565 | @{ | |
1566 | printf ("malloc called with %ld\n", c); | |
1567 | return __real_malloc (c); | |
1568 | @} | |
1569 | @end smallexample | |
1570 | ||
ff5dcc92 | 1571 | If you link other code with this file using @option{--wrap malloc}, then |
252b5132 RH |
1572 | all calls to @code{malloc} will call the function @code{__wrap_malloc} |
1573 | instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will | |
1574 | call the real @code{malloc} function. | |
1575 | ||
1576 | You may wish to provide a @code{__real_malloc} function as well, so that | |
ff5dcc92 | 1577 | links without the @option{--wrap} option will succeed. If you do this, |
252b5132 RH |
1578 | you should not put the definition of @code{__real_malloc} in the same |
1579 | file as @code{__wrap_malloc}; if you do, the assembler may resolve the | |
1580 | call before the linker has a chance to wrap it to @code{malloc}. | |
1581 | ||
6c1439be L |
1582 | @kindex --enable-new-dtags |
1583 | @kindex --disable-new-dtags | |
1584 | @item --enable-new-dtags | |
1585 | @itemx --disable-new-dtags | |
1586 | This linker can create the new dynamic tags in ELF. But the older ELF | |
1587 | systems may not understand them. If you specify | |
ff5dcc92 SC |
1588 | @option{--enable-new-dtags}, the dynamic tags will be created as needed. |
1589 | If you specify @option{--disable-new-dtags}, no new dynamic tags will be | |
6c1439be L |
1590 | created. By default, the new dynamic tags are not created. Note that |
1591 | those options are only available for ELF systems. | |
1592 | ||
252b5132 RH |
1593 | @end table |
1594 | ||
0285c67d NC |
1595 | @c man end |
1596 | ||
252b5132 RH |
1597 | @subsection Options specific to i386 PE targets |
1598 | ||
0285c67d NC |
1599 | @c man begin OPTIONS |
1600 | ||
ff5dcc92 | 1601 | The i386 PE linker supports the @option{-shared} option, which causes |
252b5132 RH |
1602 | the output to be a dynamically linked library (DLL) instead of a |
1603 | normal executable. You should name the output @code{*.dll} when you | |
1604 | use this option. In addition, the linker fully supports the standard | |
1605 | @code{*.def} files, which may be specified on the linker command line | |
1606 | like an object file (in fact, it should precede archives it exports | |
1607 | symbols from, to ensure that they get linked in, just like a normal | |
1608 | object file). | |
1609 | ||
1610 | In addition to the options common to all targets, the i386 PE linker | |
1611 | support additional command line options that are specific to the i386 | |
1612 | PE target. Options that take values may be separated from their | |
1613 | values by either a space or an equals sign. | |
1614 | ||
ff5dcc92 | 1615 | @table @gcctabopt |
252b5132 RH |
1616 | |
1617 | @kindex --add-stdcall-alias | |
1618 | @item --add-stdcall-alias | |
1619 | If given, symbols with a stdcall suffix (@@@var{nn}) will be exported | |
1620 | as-is and also with the suffix stripped. | |
1621 | ||
1622 | @kindex --base-file | |
1623 | @item --base-file @var{file} | |
1624 | Use @var{file} as the name of a file in which to save the base | |
1625 | addresses of all the relocations needed for generating DLLs with | |
1626 | @file{dlltool}. | |
1627 | ||
1628 | @kindex --dll | |
1629 | @item --dll | |
1630 | Create a DLL instead of a regular executable. You may also use | |
ff5dcc92 | 1631 | @option{-shared} or specify a @code{LIBRARY} in a given @code{.def} |
252b5132 RH |
1632 | file. |
1633 | ||
1634 | @kindex --enable-stdcall-fixup | |
1635 | @kindex --disable-stdcall-fixup | |
1636 | @item --enable-stdcall-fixup | |
1637 | @itemx --disable-stdcall-fixup | |
1638 | If the link finds a symbol that it cannot resolve, it will attempt to | |
1639 | do "fuzzy linking" by looking for another defined symbol that differs | |
1640 | only in the format of the symbol name (cdecl vs stdcall) and will | |
1641 | resolve that symbol by linking to the match. For example, the | |
1642 | undefined symbol @code{_foo} might be linked to the function | |
1643 | @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked | |
1644 | to the function @code{_bar}. When the linker does this, it prints a | |
1645 | warning, since it normally should have failed to link, but sometimes | |
1646 | import libraries generated from third-party dlls may need this feature | |
ff5dcc92 | 1647 | to be usable. If you specify @option{--enable-stdcall-fixup}, this |
252b5132 | 1648 | feature is fully enabled and warnings are not printed. If you specify |
ff5dcc92 | 1649 | @option{--disable-stdcall-fixup}, this feature is disabled and such |
252b5132 RH |
1650 | mismatches are considered to be errors. |
1651 | ||
1652 | @cindex DLLs, creating | |
1653 | @kindex --export-all-symbols | |
1654 | @item --export-all-symbols | |
1655 | If given, all global symbols in the objects used to build a DLL will | |
1656 | be exported by the DLL. Note that this is the default if there | |
1657 | otherwise wouldn't be any exported symbols. When symbols are | |
1658 | explicitly exported via DEF files or implicitly exported via function | |
1659 | attributes, the default is to not export anything else unless this | |
1660 | option is given. Note that the symbols @code{DllMain@@12}, | |
b044cda1 CW |
1661 | @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and |
1662 | @code{impure_ptr} will not be automatically | |
1663 | exported. Also, symbols imported from other DLLs will not be | |
1664 | re-exported, nor will symbols specifying the DLL's internal layout | |
1665 | such as those beginning with @code{_head_} or ending with | |
1666 | @code{_iname}. In addition, no symbols from @code{libgcc}, | |
1667 | @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported. | |
1668 | Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will | |
1669 | not be exported, to help with C++ DLLs. Finally, there is an | |
1670 | extensive list of cygwin-private symbols that are not exported | |
1671 | (obviously, this applies on when building DLLs for cygwin targets). | |
1672 | These cygwin-excludes are: @code{_cygwin_dll_entry@@12}, | |
1673 | @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12}, | |
1674 | @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll}, | |
1675 | @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2}, | |
1676 | @code{cygwin_premain3}, and @code{environ}. | |
252b5132 RH |
1677 | |
1678 | @kindex --exclude-symbols | |
1d0a3c9c | 1679 | @item --exclude-symbols @var{symbol},@var{symbol},... |
252b5132 RH |
1680 | Specifies a list of symbols which should not be automatically |
1681 | exported. The symbol names may be delimited by commas or colons. | |
1682 | ||
70b0be79 CF |
1683 | @kindex --exclude-libs |
1684 | @item --exclude-libs @var{lib},@var{lib},... | |
1685 | Specifies a list of archive libraries from which symbols should not be automatically | |
1686 | exported. The library names may be delimited by commas or colons. Specifying | |
1687 | @code{--exclude-libs ALL} excludes symbols in all archive libraries from | |
1688 | automatic export. Symbols explicitly listed in a .def file are still exported, | |
1689 | regardless of this option. | |
1690 | ||
252b5132 RH |
1691 | @kindex --file-alignment |
1692 | @item --file-alignment | |
1693 | Specify the file alignment. Sections in the file will always begin at | |
1694 | file offsets which are multiples of this number. This defaults to | |
1695 | 512. | |
1696 | ||
1697 | @cindex heap size | |
1698 | @kindex --heap | |
1699 | @item --heap @var{reserve} | |
1700 | @itemx --heap @var{reserve},@var{commit} | |
1701 | Specify the amount of memory to reserve (and optionally commit) to be | |
1702 | used as heap for this program. The default is 1Mb reserved, 4K | |
1703 | committed. | |
1704 | ||
1705 | @cindex image base | |
1706 | @kindex --image-base | |
1707 | @item --image-base @var{value} | |
1708 | Use @var{value} as the base address of your program or dll. This is | |
1709 | the lowest memory location that will be used when your program or dll | |
1710 | is loaded. To reduce the need to relocate and improve performance of | |
1711 | your dlls, each should have a unique base address and not overlap any | |
1712 | other dlls. The default is 0x400000 for executables, and 0x10000000 | |
1713 | for dlls. | |
1714 | ||
1715 | @kindex --kill-at | |
1716 | @item --kill-at | |
1717 | If given, the stdcall suffixes (@@@var{nn}) will be stripped from | |
1718 | symbols before they are exported. | |
1719 | ||
1720 | @kindex --major-image-version | |
1721 | @item --major-image-version @var{value} | |
1722 | Sets the major number of the "image version". Defaults to 1. | |
1723 | ||
1724 | @kindex --major-os-version | |
1725 | @item --major-os-version @var{value} | |
1726 | Sets the major number of the "os version". Defaults to 4. | |
1727 | ||
1728 | @kindex --major-subsystem-version | |
1729 | @item --major-subsystem-version @var{value} | |
1730 | Sets the major number of the "subsystem version". Defaults to 4. | |
1731 | ||
1732 | @kindex --minor-image-version | |
1733 | @item --minor-image-version @var{value} | |
1734 | Sets the minor number of the "image version". Defaults to 0. | |
1735 | ||
1736 | @kindex --minor-os-version | |
1737 | @item --minor-os-version @var{value} | |
1738 | Sets the minor number of the "os version". Defaults to 0. | |
1739 | ||
1740 | @kindex --minor-subsystem-version | |
1741 | @item --minor-subsystem-version @var{value} | |
1742 | Sets the minor number of the "subsystem version". Defaults to 0. | |
1743 | ||
1744 | @cindex DEF files, creating | |
1745 | @cindex DLLs, creating | |
1746 | @kindex --output-def | |
1747 | @item --output-def @var{file} | |
1748 | The linker will create the file @var{file} which will contain a DEF | |
1749 | file corresponding to the DLL the linker is generating. This DEF file | |
1750 | (which should be called @code{*.def}) may be used to create an import | |
1751 | library with @code{dlltool} or may be used as a reference to | |
1752 | automatically or implicitly exported symbols. | |
1753 | ||
b044cda1 CW |
1754 | @cindex DLLs, creating |
1755 | @kindex --out-implib | |
1756 | @item --out-implib @var{file} | |
1757 | The linker will create the file @var{file} which will contain an | |
1758 | import lib corresponding to the DLL the linker is generating. This | |
1759 | import lib (which should be called @code{*.dll.a} or @code{*.a} | |
1760 | may be used to link clients against the generated DLL; this behavior | |
1761 | makes it possible to skip a separate @code{dlltool} import library | |
1762 | creation step. | |
1763 | ||
1764 | @kindex --enable-auto-image-base | |
1765 | @item --enable-auto-image-base | |
1766 | Automatically choose the image base for DLLs, unless one is specified | |
1767 | using the @code{--image-base} argument. By using a hash generated | |
1768 | from the dllname to create unique image bases for each DLL, in-memory | |
1769 | collisions and relocations which can delay program execution are | |
1770 | avoided. | |
1771 | ||
1772 | @kindex --disable-auto-image-base | |
1773 | @item --disable-auto-image-base | |
1774 | Do not automatically generate a unique image base. If there is no | |
1775 | user-specified image base (@code{--image-base}) then use the platform | |
1776 | default. | |
1777 | ||
1778 | @cindex DLLs, linking to | |
1779 | @kindex --dll-search-prefix | |
1780 | @item --dll-search-prefix @var{string} | |
1781 | When linking dynamically to a dll without an import library, i | |
1782 | search for @code{<string><basename>.dll} in preference to | |
1783 | @code{lib<basename>.dll}. This behavior allows easy distinction | |
1784 | between DLLs built for the various "subplatforms": native, cygwin, | |
1785 | uwin, pw, etc. For instance, cygwin DLLs typically use | |
1786 | @code{--dll-search-prefix=cyg}. | |
1787 | ||
1788 | @kindex --enable-auto-import | |
1789 | @item --enable-auto-import | |
0d888aac | 1790 | Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for |
b044cda1 | 1791 | DATA imports from DLLs, and create the necessary thunking symbols when |
0d888aac CW |
1792 | building the DLLs with those DATA exports. This generally will 'just |
1793 | work' -- but sometimes you may see this message: | |
1794 | ||
1795 | "variable '<var>' can't be auto-imported. Please read the | |
1796 | documentation for ld's @code{--enable-auto-import} for details." | |
1797 | ||
1798 | This message occurs when some (sub)expression accesses an address | |
1799 | ultimately given by the sum of two constants (Win32 import tables only | |
1800 | allow one). Instances where this may occur include accesses to member | |
1801 | fields of struct variables imported from a DLL, as well as using a | |
2f8d8971 NC |
1802 | constant index into an array variable imported from a DLL. Any |
1803 | multiword variable (arrays, structs, long long, etc) may trigger | |
1804 | this error condition. However, regardless of the exact data type | |
1805 | of the offending exported variable, ld will always detect it, issue | |
1806 | the warning, and exit. | |
1807 | ||
1808 | There are several ways to address this difficulty, regardless of the | |
1809 | data type of the exported variable: | |
0d888aac CW |
1810 | |
1811 | One solution is to force one of the 'constants' to be a variable -- | |
1812 | that is, unknown and un-optimizable at compile time. For arrays, | |
1813 | there are two possibilities: a) make the indexee (the array's address) | |
1814 | a variable, or b) make the 'constant' index a variable. Thus: | |
1815 | ||
1816 | @example | |
1817 | extern type extern_array[]; | |
1818 | extern_array[1] --> | |
1819 | @{ volatile type *t=extern_array; t[1] @} | |
1820 | @end example | |
1821 | ||
1822 | or | |
1823 | ||
1824 | @example | |
1825 | extern type extern_array[]; | |
1826 | extern_array[1] --> | |
1827 | @{ volatile int t=1; extern_array[t] @} | |
1828 | @end example | |
1829 | ||
2f8d8971 NC |
1830 | For structs (and most other multiword data types) the only option |
1831 | is to make the struct itself (or the long long, or the ...) variable: | |
0d888aac CW |
1832 | |
1833 | @example | |
1834 | extern struct s extern_struct; | |
1835 | extern_struct.field --> | |
1836 | @{ volatile struct s *t=&extern_struct; t->field @} | |
1837 | @end example | |
1838 | ||
c406afaf NC |
1839 | or |
1840 | ||
1841 | @example | |
1842 | extern long long extern_ll; | |
1843 | extern_ll --> | |
1844 | @{ volatile long long * local_ll=&extern_ll; *local_ll @} | |
1845 | @end example | |
1846 | ||
0d888aac CW |
1847 | A second method of dealing with this difficulty is to abandon |
1848 | 'auto-import' for the offending symbol and mark it with | |
1849 | @code{__declspec(dllimport)}. However, in practice that | |
1850 | requires using compile-time #defines to indicate whether you are | |
1851 | building a DLL, building client code that will link to the DLL, or | |
1852 | merely building/linking to a static library. In making the choice | |
1853 | between the various methods of resolving the 'direct address with | |
1854 | constant offset' problem, you should consider typical real-world usage: | |
1855 | ||
1856 | Original: | |
1857 | @example | |
1858 | --foo.h | |
1859 | extern int arr[]; | |
1860 | --foo.c | |
1861 | #include "foo.h" | |
1862 | void main(int argc, char **argv)@{ | |
1863 | printf("%d\n",arr[1]); | |
1864 | @} | |
1865 | @end example | |
1866 | ||
1867 | Solution 1: | |
1868 | @example | |
1869 | --foo.h | |
1870 | extern int arr[]; | |
1871 | --foo.c | |
1872 | #include "foo.h" | |
1873 | void main(int argc, char **argv)@{ | |
1874 | /* This workaround is for win32 and cygwin; do not "optimize" */ | |
1875 | volatile int *parr = arr; | |
1876 | printf("%d\n",parr[1]); | |
1877 | @} | |
1878 | @end example | |
1879 | ||
1880 | Solution 2: | |
1881 | @example | |
1882 | --foo.h | |
1883 | /* Note: auto-export is assumed (no __declspec(dllexport)) */ | |
1884 | #if (defined(_WIN32) || defined(__CYGWIN__)) && \ | |
1885 | !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC)) | |
1886 | #define FOO_IMPORT __declspec(dllimport) | |
1887 | #else | |
1888 | #define FOO_IMPORT | |
1889 | #endif | |
1890 | extern FOO_IMPORT int arr[]; | |
1891 | --foo.c | |
1892 | #include "foo.h" | |
1893 | void main(int argc, char **argv)@{ | |
1894 | printf("%d\n",arr[1]); | |
1895 | @} | |
1896 | @end example | |
1897 | ||
1898 | A third way to avoid this problem is to re-code your | |
1899 | library to use a functional interface rather than a data interface | |
1900 | for the offending variables (e.g. set_foo() and get_foo() accessor | |
1901 | functions). | |
b044cda1 CW |
1902 | |
1903 | @kindex --disable-auto-import | |
1904 | @item --disable-auto-import | |
1905 | Do not attempt to do sophisticalted linking of @code{_symbol} to | |
1906 | @code{__imp__symbol} for DATA imports from DLLs. | |
1907 | ||
1908 | @kindex --enable-extra-pe-debug | |
1909 | @item --enable-extra-pe-debug | |
1910 | Show additional debug info related to auto-import symbol thunking. | |
1911 | ||
252b5132 RH |
1912 | @kindex --section-alignment |
1913 | @item --section-alignment | |
1914 | Sets the section alignment. Sections in memory will always begin at | |
1915 | addresses which are a multiple of this number. Defaults to 0x1000. | |
1916 | ||
1917 | @cindex stack size | |
1918 | @kindex --stack | |
1919 | @item --stack @var{reserve} | |
1920 | @itemx --stack @var{reserve},@var{commit} | |
1921 | Specify the amount of memory to reserve (and optionally commit) to be | |
559e4713 | 1922 | used as stack for this program. The default is 2Mb reserved, 4K |
252b5132 RH |
1923 | committed. |
1924 | ||
1925 | @kindex --subsystem | |
1926 | @item --subsystem @var{which} | |
1927 | @itemx --subsystem @var{which}:@var{major} | |
1928 | @itemx --subsystem @var{which}:@var{major}.@var{minor} | |
1929 | Specifies the subsystem under which your program will execute. The | |
1930 | legal values for @var{which} are @code{native}, @code{windows}, | |
1931 | @code{console}, and @code{posix}. You may optionally set the | |
1932 | subsystem version also. | |
1933 | ||
1934 | @end table | |
1935 | ||
0285c67d NC |
1936 | @c man end |
1937 | ||
252b5132 RH |
1938 | @ifset UsesEnvVars |
1939 | @node Environment | |
1940 | @section Environment Variables | |
1941 | ||
0285c67d NC |
1942 | @c man begin ENVIRONMENT |
1943 | ||
ff5dcc92 | 1944 | You can change the behavior of @command{ld} with the environment variables |
252b5132 RH |
1945 | @code{GNUTARGET}, @code{LDEMULATION}, and @code{COLLECT_NO_DEMANGLE}. |
1946 | ||
1947 | @kindex GNUTARGET | |
1948 | @cindex default input format | |
1949 | @code{GNUTARGET} determines the input-file object format if you don't | |
1950 | use @samp{-b} (or its synonym @samp{--format}). Its value should be one | |
1951 | of the BFD names for an input format (@pxref{BFD}). If there is no | |
ff5dcc92 | 1952 | @code{GNUTARGET} in the environment, @command{ld} uses the natural format |
252b5132 RH |
1953 | of the target. If @code{GNUTARGET} is set to @code{default} then BFD |
1954 | attempts to discover the input format by examining binary input files; | |
1955 | this method often succeeds, but there are potential ambiguities, since | |
1956 | there is no method of ensuring that the magic number used to specify | |
1957 | object-file formats is unique. However, the configuration procedure for | |
1958 | BFD on each system places the conventional format for that system first | |
1959 | in the search-list, so ambiguities are resolved in favor of convention. | |
1960 | ||
1961 | @kindex LDEMULATION | |
1962 | @cindex default emulation | |
1963 | @cindex emulation, default | |
1964 | @code{LDEMULATION} determines the default emulation if you don't use the | |
1965 | @samp{-m} option. The emulation can affect various aspects of linker | |
1966 | behaviour, particularly the default linker script. You can list the | |
1967 | available emulations with the @samp{--verbose} or @samp{-V} options. If | |
1968 | the @samp{-m} option is not used, and the @code{LDEMULATION} environment | |
1969 | variable is not defined, the default emulation depends upon how the | |
1970 | linker was configured. | |
252b5132 RH |
1971 | |
1972 | @kindex COLLECT_NO_DEMANGLE | |
1973 | @cindex demangling, default | |
1974 | Normally, the linker will default to demangling symbols. However, if | |
1975 | @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will | |
1976 | default to not demangling symbols. This environment variable is used in | |
1977 | a similar fashion by the @code{gcc} linker wrapper program. The default | |
1978 | may be overridden by the @samp{--demangle} and @samp{--no-demangle} | |
1979 | options. | |
1980 | ||
0285c67d NC |
1981 | @c man end |
1982 | @end ifset | |
1983 | ||
252b5132 RH |
1984 | @node Scripts |
1985 | @chapter Linker Scripts | |
1986 | ||
1987 | @cindex scripts | |
1988 | @cindex linker scripts | |
1989 | @cindex command files | |
1990 | Every link is controlled by a @dfn{linker script}. This script is | |
1991 | written in the linker command language. | |
1992 | ||
1993 | The main purpose of the linker script is to describe how the sections in | |
1994 | the input files should be mapped into the output file, and to control | |
1995 | the memory layout of the output file. Most linker scripts do nothing | |
1996 | more than this. However, when necessary, the linker script can also | |
1997 | direct the linker to perform many other operations, using the commands | |
1998 | described below. | |
1999 | ||
2000 | The linker always uses a linker script. If you do not supply one | |
2001 | yourself, the linker will use a default script that is compiled into the | |
2002 | linker executable. You can use the @samp{--verbose} command line option | |
2003 | to display the default linker script. Certain command line options, | |
2004 | such as @samp{-r} or @samp{-N}, will affect the default linker script. | |
2005 | ||
2006 | You may supply your own linker script by using the @samp{-T} command | |
2007 | line option. When you do this, your linker script will replace the | |
2008 | default linker script. | |
2009 | ||
2010 | You may also use linker scripts implicitly by naming them as input files | |
2011 | to the linker, as though they were files to be linked. @xref{Implicit | |
2012 | Linker Scripts}. | |
2013 | ||
2014 | @menu | |
2015 | * Basic Script Concepts:: Basic Linker Script Concepts | |
2016 | * Script Format:: Linker Script Format | |
2017 | * Simple Example:: Simple Linker Script Example | |
2018 | * Simple Commands:: Simple Linker Script Commands | |
2019 | * Assignments:: Assigning Values to Symbols | |
2020 | * SECTIONS:: SECTIONS Command | |
2021 | * MEMORY:: MEMORY Command | |
2022 | * PHDRS:: PHDRS Command | |
2023 | * VERSION:: VERSION Command | |
2024 | * Expressions:: Expressions in Linker Scripts | |
2025 | * Implicit Linker Scripts:: Implicit Linker Scripts | |
2026 | @end menu | |
2027 | ||
2028 | @node Basic Script Concepts | |
2029 | @section Basic Linker Script Concepts | |
2030 | @cindex linker script concepts | |
2031 | We need to define some basic concepts and vocabulary in order to | |
2032 | describe the linker script language. | |
2033 | ||
2034 | The linker combines input files into a single output file. The output | |
2035 | file and each input file are in a special data format known as an | |
2036 | @dfn{object file format}. Each file is called an @dfn{object file}. | |
2037 | The output file is often called an @dfn{executable}, but for our | |
2038 | purposes we will also call it an object file. Each object file has, | |
2039 | among other things, a list of @dfn{sections}. We sometimes refer to a | |
2040 | section in an input file as an @dfn{input section}; similarly, a section | |
2041 | in the output file is an @dfn{output section}. | |
2042 | ||
2043 | Each section in an object file has a name and a size. Most sections | |
2044 | also have an associated block of data, known as the @dfn{section | |
2045 | contents}. A section may be marked as @dfn{loadable}, which mean that | |
2046 | the contents should be loaded into memory when the output file is run. | |
2047 | A section with no contents may be @dfn{allocatable}, which means that an | |
2048 | area in memory should be set aside, but nothing in particular should be | |
2049 | loaded there (in some cases this memory must be zeroed out). A section | |
2050 | which is neither loadable nor allocatable typically contains some sort | |
2051 | of debugging information. | |
2052 | ||
2053 | Every loadable or allocatable output section has two addresses. The | |
2054 | first is the @dfn{VMA}, or virtual memory address. This is the address | |
2055 | the section will have when the output file is run. The second is the | |
2056 | @dfn{LMA}, or load memory address. This is the address at which the | |
2057 | section will be loaded. In most cases the two addresses will be the | |
2058 | same. An example of when they might be different is when a data section | |
2059 | is loaded into ROM, and then copied into RAM when the program starts up | |
2060 | (this technique is often used to initialize global variables in a ROM | |
2061 | based system). In this case the ROM address would be the LMA, and the | |
2062 | RAM address would be the VMA. | |
2063 | ||
2064 | You can see the sections in an object file by using the @code{objdump} | |
2065 | program with the @samp{-h} option. | |
2066 | ||
2067 | Every object file also has a list of @dfn{symbols}, known as the | |
2068 | @dfn{symbol table}. A symbol may be defined or undefined. Each symbol | |
2069 | has a name, and each defined symbol has an address, among other | |
2070 | information. If you compile a C or C++ program into an object file, you | |
2071 | will get a defined symbol for every defined function and global or | |
2072 | static variable. Every undefined function or global variable which is | |
2073 | referenced in the input file will become an undefined symbol. | |
2074 | ||
2075 | You can see the symbols in an object file by using the @code{nm} | |
2076 | program, or by using the @code{objdump} program with the @samp{-t} | |
2077 | option. | |
2078 | ||
2079 | @node Script Format | |
2080 | @section Linker Script Format | |
2081 | @cindex linker script format | |
2082 | Linker scripts are text files. | |
2083 | ||
2084 | You write a linker script as a series of commands. Each command is | |
2085 | either a keyword, possibly followed by arguments, or an assignment to a | |
2086 | symbol. You may separate commands using semicolons. Whitespace is | |
2087 | generally ignored. | |
2088 | ||
2089 | Strings such as file or format names can normally be entered directly. | |
2090 | If the file name contains a character such as a comma which would | |
2091 | otherwise serve to separate file names, you may put the file name in | |
2092 | double quotes. There is no way to use a double quote character in a | |
2093 | file name. | |
2094 | ||
2095 | You may include comments in linker scripts just as in C, delimited by | |
2096 | @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent | |
2097 | to whitespace. | |
2098 | ||
2099 | @node Simple Example | |
2100 | @section Simple Linker Script Example | |
2101 | @cindex linker script example | |
2102 | @cindex example of linker script | |
2103 | Many linker scripts are fairly simple. | |
2104 | ||
2105 | The simplest possible linker script has just one command: | |
2106 | @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the | |
2107 | memory layout of the output file. | |
2108 | ||
2109 | The @samp{SECTIONS} command is a powerful command. Here we will | |
2110 | describe a simple use of it. Let's assume your program consists only of | |
2111 | code, initialized data, and uninitialized data. These will be in the | |
2112 | @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively. | |
2113 | Let's assume further that these are the only sections which appear in | |
2114 | your input files. | |
2115 | ||
2116 | For this example, let's say that the code should be loaded at address | |
2117 | 0x10000, and that the data should start at address 0x8000000. Here is a | |
2118 | linker script which will do that: | |
2119 | @smallexample | |
2120 | SECTIONS | |
2121 | @{ | |
2122 | . = 0x10000; | |
2123 | .text : @{ *(.text) @} | |
2124 | . = 0x8000000; | |
2125 | .data : @{ *(.data) @} | |
2126 | .bss : @{ *(.bss) @} | |
2127 | @} | |
2128 | @end smallexample | |
2129 | ||
2130 | You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS}, | |
2131 | followed by a series of symbol assignments and output section | |
2132 | descriptions enclosed in curly braces. | |
2133 | ||
252b5132 RH |
2134 | The first line inside the @samp{SECTIONS} command of the above example |
2135 | sets the value of the special symbol @samp{.}, which is the location | |
2136 | counter. If you do not specify the address of an output section in some | |
2137 | other way (other ways are described later), the address is set from the | |
2138 | current value of the location counter. The location counter is then | |
2139 | incremented by the size of the output section. At the start of the | |
2140 | @samp{SECTIONS} command, the location counter has the value @samp{0}. | |
2141 | ||
2142 | The second line defines an output section, @samp{.text}. The colon is | |
2143 | required syntax which may be ignored for now. Within the curly braces | |
2144 | after the output section name, you list the names of the input sections | |
2145 | which should be placed into this output section. The @samp{*} is a | |
2146 | wildcard which matches any file name. The expression @samp{*(.text)} | |
2147 | means all @samp{.text} input sections in all input files. | |
2148 | ||
2149 | Since the location counter is @samp{0x10000} when the output section | |
2150 | @samp{.text} is defined, the linker will set the address of the | |
2151 | @samp{.text} section in the output file to be @samp{0x10000}. | |
2152 | ||
2153 | The remaining lines define the @samp{.data} and @samp{.bss} sections in | |
2154 | the output file. The linker will place the @samp{.data} output section | |
2155 | at address @samp{0x8000000}. After the linker places the @samp{.data} | |
2156 | output section, the value of the location counter will be | |
2157 | @samp{0x8000000} plus the size of the @samp{.data} output section. The | |
2158 | effect is that the linker will place the @samp{.bss} output section | |
2159 | immediately after the @samp{.data} output section in memory | |
2160 | ||
2161 | The linker will ensure that each output section has the required | |
2162 | alignment, by increasing the location counter if necessary. In this | |
2163 | example, the specified addresses for the @samp{.text} and @samp{.data} | |
2164 | sections will probably satisfy any alignment constraints, but the linker | |
2165 | may have to create a small gap between the @samp{.data} and @samp{.bss} | |
2166 | sections. | |
2167 | ||
2168 | That's it! That's a simple and complete linker script. | |
2169 | ||
2170 | @node Simple Commands | |
2171 | @section Simple Linker Script Commands | |
2172 | @cindex linker script simple commands | |
2173 | In this section we describe the simple linker script commands. | |
2174 | ||
2175 | @menu | |
2176 | * Entry Point:: Setting the entry point | |
2177 | * File Commands:: Commands dealing with files | |
2178 | @ifclear SingleFormat | |
2179 | * Format Commands:: Commands dealing with object file formats | |
2180 | @end ifclear | |
2181 | ||
2182 | * Miscellaneous Commands:: Other linker script commands | |
2183 | @end menu | |
2184 | ||
2185 | @node Entry Point | |
2186 | @subsection Setting the entry point | |
2187 | @kindex ENTRY(@var{symbol}) | |
2188 | @cindex start of execution | |
2189 | @cindex first instruction | |
2190 | @cindex entry point | |
2191 | The first instruction to execute in a program is called the @dfn{entry | |
2192 | point}. You can use the @code{ENTRY} linker script command to set the | |
2193 | entry point. The argument is a symbol name: | |
2194 | @smallexample | |
2195 | ENTRY(@var{symbol}) | |
2196 | @end smallexample | |
2197 | ||
2198 | There are several ways to set the entry point. The linker will set the | |
2199 | entry point by trying each of the following methods in order, and | |
2200 | stopping when one of them succeeds: | |
2201 | @itemize @bullet | |
a1ab1d2a | 2202 | @item |
252b5132 | 2203 | the @samp{-e} @var{entry} command-line option; |
a1ab1d2a | 2204 | @item |
252b5132 | 2205 | the @code{ENTRY(@var{symbol})} command in a linker script; |
a1ab1d2a | 2206 | @item |
252b5132 | 2207 | the value of the symbol @code{start}, if defined; |
a1ab1d2a | 2208 | @item |
252b5132 | 2209 | the address of the first byte of the @samp{.text} section, if present; |
a1ab1d2a | 2210 | @item |
252b5132 RH |
2211 | The address @code{0}. |
2212 | @end itemize | |
2213 | ||
2214 | @node File Commands | |
2215 | @subsection Commands dealing with files | |
2216 | @cindex linker script file commands | |
2217 | Several linker script commands deal with files. | |
2218 | ||
2219 | @table @code | |
2220 | @item INCLUDE @var{filename} | |
2221 | @kindex INCLUDE @var{filename} | |
2222 | @cindex including a linker script | |
2223 | Include the linker script @var{filename} at this point. The file will | |
2224 | be searched for in the current directory, and in any directory specified | |
ff5dcc92 | 2225 | with the @option{-L} option. You can nest calls to @code{INCLUDE} up to |
252b5132 RH |
2226 | 10 levels deep. |
2227 | ||
2228 | @item INPUT(@var{file}, @var{file}, @dots{}) | |
2229 | @itemx INPUT(@var{file} @var{file} @dots{}) | |
2230 | @kindex INPUT(@var{files}) | |
2231 | @cindex input files in linker scripts | |
2232 | @cindex input object files in linker scripts | |
2233 | @cindex linker script input object files | |
2234 | The @code{INPUT} command directs the linker to include the named files | |
2235 | in the link, as though they were named on the command line. | |
2236 | ||
2237 | For example, if you always want to include @file{subr.o} any time you do | |
2238 | a link, but you can't be bothered to put it on every link command line, | |
2239 | then you can put @samp{INPUT (subr.o)} in your linker script. | |
2240 | ||
2241 | In fact, if you like, you can list all of your input files in the linker | |
2242 | script, and then invoke the linker with nothing but a @samp{-T} option. | |
2243 | ||
2244 | The linker will first try to open the file in the current directory. If | |
2245 | it is not found, the linker will search through the archive library | |
2246 | search path. See the description of @samp{-L} in @ref{Options,,Command | |
2247 | Line Options}. | |
2248 | ||
ff5dcc92 | 2249 | If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the |
252b5132 RH |
2250 | name to @code{lib@var{file}.a}, as with the command line argument |
2251 | @samp{-l}. | |
2252 | ||
2253 | When you use the @code{INPUT} command in an implicit linker script, the | |
2254 | files will be included in the link at the point at which the linker | |
2255 | script file is included. This can affect archive searching. | |
2256 | ||
2257 | @item GROUP(@var{file}, @var{file}, @dots{}) | |
2258 | @itemx GROUP(@var{file} @var{file} @dots{}) | |
2259 | @kindex GROUP(@var{files}) | |
2260 | @cindex grouping input files | |
2261 | The @code{GROUP} command is like @code{INPUT}, except that the named | |
2262 | files should all be archives, and they are searched repeatedly until no | |
2263 | new undefined references are created. See the description of @samp{-(} | |
2264 | in @ref{Options,,Command Line Options}. | |
2265 | ||
2266 | @item OUTPUT(@var{filename}) | |
2267 | @kindex OUTPUT(@var{filename}) | |
2268 | @cindex output file name in linker scripot | |
2269 | The @code{OUTPUT} command names the output file. Using | |
2270 | @code{OUTPUT(@var{filename})} in the linker script is exactly like using | |
2271 | @samp{-o @var{filename}} on the command line (@pxref{Options,,Command | |
2272 | Line Options}). If both are used, the command line option takes | |
2273 | precedence. | |
2274 | ||
2275 | You can use the @code{OUTPUT} command to define a default name for the | |
2276 | output file other than the usual default of @file{a.out}. | |
2277 | ||
2278 | @item SEARCH_DIR(@var{path}) | |
2279 | @kindex SEARCH_DIR(@var{path}) | |
2280 | @cindex library search path in linker script | |
2281 | @cindex archive search path in linker script | |
2282 | @cindex search path in linker script | |
2283 | The @code{SEARCH_DIR} command adds @var{path} to the list of paths where | |
ff5dcc92 | 2284 | @command{ld} looks for archive libraries. Using |
252b5132 RH |
2285 | @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}} |
2286 | on the command line (@pxref{Options,,Command Line Options}). If both | |
2287 | are used, then the linker will search both paths. Paths specified using | |
2288 | the command line option are searched first. | |
2289 | ||
2290 | @item STARTUP(@var{filename}) | |
2291 | @kindex STARTUP(@var{filename}) | |
2292 | @cindex first input file | |
2293 | The @code{STARTUP} command is just like the @code{INPUT} command, except | |
2294 | that @var{filename} will become the first input file to be linked, as | |
2295 | though it were specified first on the command line. This may be useful | |
2296 | when using a system in which the entry point is always the start of the | |
2297 | first file. | |
2298 | @end table | |
2299 | ||
2300 | @ifclear SingleFormat | |
2301 | @node Format Commands | |
2302 | @subsection Commands dealing with object file formats | |
2303 | A couple of linker script commands deal with object file formats. | |
2304 | ||
2305 | @table @code | |
2306 | @item OUTPUT_FORMAT(@var{bfdname}) | |
2307 | @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little}) | |
2308 | @kindex OUTPUT_FORMAT(@var{bfdname}) | |
2309 | @cindex output file format in linker script | |
2310 | The @code{OUTPUT_FORMAT} command names the BFD format to use for the | |
2311 | output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is | |
024531e2 | 2312 | exactly like using @samp{--oformat @var{bfdname}} on the command line |
252b5132 RH |
2313 | (@pxref{Options,,Command Line Options}). If both are used, the command |
2314 | line option takes precedence. | |
2315 | ||
2316 | You can use @code{OUTPUT_FORMAT} with three arguments to use different | |
2317 | formats based on the @samp{-EB} and @samp{-EL} command line options. | |
2318 | This permits the linker script to set the output format based on the | |
2319 | desired endianness. | |
2320 | ||
2321 | If neither @samp{-EB} nor @samp{-EL} are used, then the output format | |
2322 | will be the first argument, @var{default}. If @samp{-EB} is used, the | |
2323 | output format will be the second argument, @var{big}. If @samp{-EL} is | |
2324 | used, the output format will be the third argument, @var{little}. | |
2325 | ||
2326 | For example, the default linker script for the MIPS ELF target uses this | |
2327 | command: | |
2328 | @smallexample | |
2329 | OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips) | |
2330 | @end smallexample | |
2331 | This says that the default format for the output file is | |
2332 | @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line | |
2333 | option, the output file will be created in the @samp{elf32-littlemips} | |
2334 | format. | |
2335 | ||
2336 | @item TARGET(@var{bfdname}) | |
2337 | @kindex TARGET(@var{bfdname}) | |
2338 | @cindex input file format in linker script | |
2339 | The @code{TARGET} command names the BFD format to use when reading input | |
2340 | files. It affects subsequent @code{INPUT} and @code{GROUP} commands. | |
2341 | This command is like using @samp{-b @var{bfdname}} on the command line | |
2342 | (@pxref{Options,,Command Line Options}). If the @code{TARGET} command | |
2343 | is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET} | |
2344 | command is also used to set the format for the output file. @xref{BFD}. | |
2345 | @end table | |
2346 | @end ifclear | |
2347 | ||
2348 | @node Miscellaneous Commands | |
2349 | @subsection Other linker script commands | |
2350 | There are a few other linker scripts commands. | |
2351 | ||
2352 | @table @code | |
2353 | @item ASSERT(@var{exp}, @var{message}) | |
2354 | @kindex ASSERT | |
2355 | @cindex assertion in linker script | |
2356 | Ensure that @var{exp} is non-zero. If it is zero, then exit the linker | |
2357 | with an error code, and print @var{message}. | |
2358 | ||
2359 | @item EXTERN(@var{symbol} @var{symbol} @dots{}) | |
2360 | @kindex EXTERN | |
2361 | @cindex undefined symbol in linker script | |
2362 | Force @var{symbol} to be entered in the output file as an undefined | |
2363 | symbol. Doing this may, for example, trigger linking of additional | |
2364 | modules from standard libraries. You may list several @var{symbol}s for | |
2365 | each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This | |
2366 | command has the same effect as the @samp{-u} command-line option. | |
2367 | ||
2368 | @item FORCE_COMMON_ALLOCATION | |
2369 | @kindex FORCE_COMMON_ALLOCATION | |
2370 | @cindex common allocation in linker script | |
2371 | This command has the same effect as the @samp{-d} command-line option: | |
ff5dcc92 | 2372 | to make @command{ld} assign space to common symbols even if a relocatable |
252b5132 RH |
2373 | output file is specified (@samp{-r}). |
2374 | ||
4818e05f AM |
2375 | @item INHIBIT_COMMON_ALLOCATION |
2376 | @kindex INHIBIT_COMMON_ALLOCATION | |
2377 | @cindex common allocation in linker script | |
2378 | This command has the same effect as the @samp{--no-define-common} | |
2379 | command-line option: to make @code{ld} omit the assignment of addresses | |
2380 | to common symbols even for a non-relocatable output file. | |
2381 | ||
252b5132 RH |
2382 | @item NOCROSSREFS(@var{section} @var{section} @dots{}) |
2383 | @kindex NOCROSSREFS(@var{sections}) | |
2384 | @cindex cross references | |
ff5dcc92 | 2385 | This command may be used to tell @command{ld} to issue an error about any |
252b5132 RH |
2386 | references among certain output sections. |
2387 | ||
2388 | In certain types of programs, particularly on embedded systems when | |
2389 | using overlays, when one section is loaded into memory, another section | |
2390 | will not be. Any direct references between the two sections would be | |
2391 | errors. For example, it would be an error if code in one section called | |
2392 | a function defined in the other section. | |
2393 | ||
2394 | The @code{NOCROSSREFS} command takes a list of output section names. If | |
ff5dcc92 | 2395 | @command{ld} detects any cross references between the sections, it reports |
252b5132 RH |
2396 | an error and returns a non-zero exit status. Note that the |
2397 | @code{NOCROSSREFS} command uses output section names, not input section | |
2398 | names. | |
2399 | ||
2400 | @ifclear SingleFormat | |
2401 | @item OUTPUT_ARCH(@var{bfdarch}) | |
2402 | @kindex OUTPUT_ARCH(@var{bfdarch}) | |
2403 | @cindex machine architecture | |
2404 | @cindex architecture | |
2405 | Specify a particular output machine architecture. The argument is one | |
2406 | of the names used by the BFD library (@pxref{BFD}). You can see the | |
2407 | architecture of an object file by using the @code{objdump} program with | |
2408 | the @samp{-f} option. | |
2409 | @end ifclear | |
2410 | @end table | |
2411 | ||
2412 | @node Assignments | |
2413 | @section Assigning Values to Symbols | |
2414 | @cindex assignment in scripts | |
2415 | @cindex symbol definition, scripts | |
2416 | @cindex variables, defining | |
2417 | You may assign a value to a symbol in a linker script. This will define | |
2418 | the symbol as a global symbol. | |
2419 | ||
2420 | @menu | |
2421 | * Simple Assignments:: Simple Assignments | |
2422 | * PROVIDE:: PROVIDE | |
2423 | @end menu | |
2424 | ||
2425 | @node Simple Assignments | |
2426 | @subsection Simple Assignments | |
2427 | ||
2428 | You may assign to a symbol using any of the C assignment operators: | |
2429 | ||
2430 | @table @code | |
2431 | @item @var{symbol} = @var{expression} ; | |
2432 | @itemx @var{symbol} += @var{expression} ; | |
2433 | @itemx @var{symbol} -= @var{expression} ; | |
2434 | @itemx @var{symbol} *= @var{expression} ; | |
2435 | @itemx @var{symbol} /= @var{expression} ; | |
2436 | @itemx @var{symbol} <<= @var{expression} ; | |
2437 | @itemx @var{symbol} >>= @var{expression} ; | |
2438 | @itemx @var{symbol} &= @var{expression} ; | |
2439 | @itemx @var{symbol} |= @var{expression} ; | |
2440 | @end table | |
2441 | ||
2442 | The first case will define @var{symbol} to the value of | |
2443 | @var{expression}. In the other cases, @var{symbol} must already be | |
2444 | defined, and the value will be adjusted accordingly. | |
2445 | ||
2446 | The special symbol name @samp{.} indicates the location counter. You | |
2447 | may only use this within a @code{SECTIONS} command. | |
2448 | ||
2449 | The semicolon after @var{expression} is required. | |
2450 | ||
2451 | Expressions are defined below; see @ref{Expressions}. | |
2452 | ||
2453 | You may write symbol assignments as commands in their own right, or as | |
2454 | statements within a @code{SECTIONS} command, or as part of an output | |
2455 | section description in a @code{SECTIONS} command. | |
2456 | ||
2457 | The section of the symbol will be set from the section of the | |
2458 | expression; for more information, see @ref{Expression Section}. | |
2459 | ||
2460 | Here is an example showing the three different places that symbol | |
2461 | assignments may be used: | |
2462 | ||
2463 | @smallexample | |
2464 | floating_point = 0; | |
2465 | SECTIONS | |
2466 | @{ | |
2467 | .text : | |
2468 | @{ | |
2469 | *(.text) | |
2470 | _etext = .; | |
2471 | @} | |
156e34dd | 2472 | _bdata = (. + 3) & ~ 3; |
252b5132 RH |
2473 | .data : @{ *(.data) @} |
2474 | @} | |
2475 | @end smallexample | |
2476 | @noindent | |
2477 | In this example, the symbol @samp{floating_point} will be defined as | |
2478 | zero. The symbol @samp{_etext} will be defined as the address following | |
2479 | the last @samp{.text} input section. The symbol @samp{_bdata} will be | |
2480 | defined as the address following the @samp{.text} output section aligned | |
2481 | upward to a 4 byte boundary. | |
2482 | ||
2483 | @node PROVIDE | |
2484 | @subsection PROVIDE | |
2485 | @cindex PROVIDE | |
2486 | In some cases, it is desirable for a linker script to define a symbol | |
2487 | only if it is referenced and is not defined by any object included in | |
2488 | the link. For example, traditional linkers defined the symbol | |
2489 | @samp{etext}. However, ANSI C requires that the user be able to use | |
2490 | @samp{etext} as a function name without encountering an error. The | |
2491 | @code{PROVIDE} keyword may be used to define a symbol, such as | |
2492 | @samp{etext}, only if it is referenced but not defined. The syntax is | |
2493 | @code{PROVIDE(@var{symbol} = @var{expression})}. | |
2494 | ||
2495 | Here is an example of using @code{PROVIDE} to define @samp{etext}: | |
2496 | @smallexample | |
2497 | SECTIONS | |
2498 | @{ | |
2499 | .text : | |
2500 | @{ | |
2501 | *(.text) | |
2502 | _etext = .; | |
2503 | PROVIDE(etext = .); | |
2504 | @} | |
2505 | @} | |
2506 | @end smallexample | |
2507 | ||
2508 | In this example, if the program defines @samp{_etext} (with a leading | |
2509 | underscore), the linker will give a multiple definition error. If, on | |
2510 | the other hand, the program defines @samp{etext} (with no leading | |
2511 | underscore), the linker will silently use the definition in the program. | |
2512 | If the program references @samp{etext} but does not define it, the | |
2513 | linker will use the definition in the linker script. | |
2514 | ||
2515 | @node SECTIONS | |
2516 | @section SECTIONS command | |
2517 | @kindex SECTIONS | |
2518 | The @code{SECTIONS} command tells the linker how to map input sections | |
2519 | into output sections, and how to place the output sections in memory. | |
2520 | ||
2521 | The format of the @code{SECTIONS} command is: | |
2522 | @smallexample | |
2523 | SECTIONS | |
2524 | @{ | |
2525 | @var{sections-command} | |
2526 | @var{sections-command} | |
2527 | @dots{} | |
2528 | @} | |
2529 | @end smallexample | |
2530 | ||
2531 | Each @var{sections-command} may of be one of the following: | |
2532 | ||
2533 | @itemize @bullet | |
2534 | @item | |
2535 | an @code{ENTRY} command (@pxref{Entry Point,,Entry command}) | |
2536 | @item | |
2537 | a symbol assignment (@pxref{Assignments}) | |
2538 | @item | |
2539 | an output section description | |
2540 | @item | |
2541 | an overlay description | |
2542 | @end itemize | |
2543 | ||
2544 | The @code{ENTRY} command and symbol assignments are permitted inside the | |
2545 | @code{SECTIONS} command for convenience in using the location counter in | |
2546 | those commands. This can also make the linker script easier to | |
2547 | understand because you can use those commands at meaningful points in | |
2548 | the layout of the output file. | |
2549 | ||
2550 | Output section descriptions and overlay descriptions are described | |
2551 | below. | |
2552 | ||
2553 | If you do not use a @code{SECTIONS} command in your linker script, the | |
2554 | linker will place each input section into an identically named output | |
2555 | section in the order that the sections are first encountered in the | |
2556 | input files. If all input sections are present in the first file, for | |
2557 | example, the order of sections in the output file will match the order | |
2558 | in the first input file. The first section will be at address zero. | |
2559 | ||
2560 | @menu | |
2561 | * Output Section Description:: Output section description | |
2562 | * Output Section Name:: Output section name | |
2563 | * Output Section Address:: Output section address | |
2564 | * Input Section:: Input section description | |
2565 | * Output Section Data:: Output section data | |
2566 | * Output Section Keywords:: Output section keywords | |
2567 | * Output Section Discarding:: Output section discarding | |
2568 | * Output Section Attributes:: Output section attributes | |
2569 | * Overlay Description:: Overlay description | |
2570 | @end menu | |
2571 | ||
2572 | @node Output Section Description | |
2573 | @subsection Output section description | |
2574 | The full description of an output section looks like this: | |
2575 | @smallexample | |
a1ab1d2a | 2576 | @group |
252b5132 RH |
2577 | @var{section} [@var{address}] [(@var{type})] : [AT(@var{lma})] |
2578 | @{ | |
2579 | @var{output-section-command} | |
2580 | @var{output-section-command} | |
2581 | @dots{} | |
562d3460 | 2582 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
2583 | @end group |
2584 | @end smallexample | |
2585 | ||
2586 | Most output sections do not use most of the optional section attributes. | |
2587 | ||
2588 | The whitespace around @var{section} is required, so that the section | |
2589 | name is unambiguous. The colon and the curly braces are also required. | |
2590 | The line breaks and other white space are optional. | |
2591 | ||
2592 | Each @var{output-section-command} may be one of the following: | |
2593 | ||
2594 | @itemize @bullet | |
2595 | @item | |
2596 | a symbol assignment (@pxref{Assignments}) | |
2597 | @item | |
2598 | an input section description (@pxref{Input Section}) | |
2599 | @item | |
2600 | data values to include directly (@pxref{Output Section Data}) | |
2601 | @item | |
2602 | a special output section keyword (@pxref{Output Section Keywords}) | |
2603 | @end itemize | |
2604 | ||
2605 | @node Output Section Name | |
2606 | @subsection Output section name | |
2607 | @cindex name, section | |
2608 | @cindex section name | |
2609 | The name of the output section is @var{section}. @var{section} must | |
2610 | meet the constraints of your output format. In formats which only | |
2611 | support a limited number of sections, such as @code{a.out}, the name | |
2612 | must be one of the names supported by the format (@code{a.out}, for | |
2613 | example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the | |
2614 | output format supports any number of sections, but with numbers and not | |
2615 | names (as is the case for Oasys), the name should be supplied as a | |
2616 | quoted numeric string. A section name may consist of any sequence of | |
2617 | characters, but a name which contains any unusual characters such as | |
2618 | commas must be quoted. | |
2619 | ||
2620 | The output section name @samp{/DISCARD/} is special; @ref{Output Section | |
2621 | Discarding}. | |
2622 | ||
2623 | @node Output Section Address | |
2624 | @subsection Output section address | |
2625 | @cindex address, section | |
2626 | @cindex section address | |
2627 | The @var{address} is an expression for the VMA (the virtual memory | |
2628 | address) of the output section. If you do not provide @var{address}, | |
2629 | the linker will set it based on @var{region} if present, or otherwise | |
2630 | based on the current value of the location counter. | |
2631 | ||
2632 | If you provide @var{address}, the address of the output section will be | |
2633 | set to precisely that. If you provide neither @var{address} nor | |
2634 | @var{region}, then the address of the output section will be set to the | |
2635 | current value of the location counter aligned to the alignment | |
2636 | requirements of the output section. The alignment requirement of the | |
2637 | output section is the strictest alignment of any input section contained | |
2638 | within the output section. | |
2639 | ||
2640 | For example, | |
2641 | @smallexample | |
2642 | .text . : @{ *(.text) @} | |
2643 | @end smallexample | |
2644 | @noindent | |
2645 | and | |
2646 | @smallexample | |
2647 | .text : @{ *(.text) @} | |
2648 | @end smallexample | |
2649 | @noindent | |
2650 | are subtly different. The first will set the address of the | |
2651 | @samp{.text} output section to the current value of the location | |
2652 | counter. The second will set it to the current value of the location | |
2653 | counter aligned to the strictest alignment of a @samp{.text} input | |
2654 | section. | |
2655 | ||
2656 | The @var{address} may be an arbitrary expression; @ref{Expressions}. | |
2657 | For example, if you want to align the section on a 0x10 byte boundary, | |
2658 | so that the lowest four bits of the section address are zero, you could | |
2659 | do something like this: | |
2660 | @smallexample | |
2661 | .text ALIGN(0x10) : @{ *(.text) @} | |
2662 | @end smallexample | |
2663 | @noindent | |
2664 | This works because @code{ALIGN} returns the current location counter | |
2665 | aligned upward to the specified value. | |
2666 | ||
2667 | Specifying @var{address} for a section will change the value of the | |
2668 | location counter. | |
2669 | ||
2670 | @node Input Section | |
2671 | @subsection Input section description | |
2672 | @cindex input sections | |
2673 | @cindex mapping input sections to output sections | |
2674 | The most common output section command is an input section description. | |
2675 | ||
2676 | The input section description is the most basic linker script operation. | |
2677 | You use output sections to tell the linker how to lay out your program | |
2678 | in memory. You use input section descriptions to tell the linker how to | |
2679 | map the input files into your memory layout. | |
2680 | ||
2681 | @menu | |
2682 | * Input Section Basics:: Input section basics | |
2683 | * Input Section Wildcards:: Input section wildcard patterns | |
2684 | * Input Section Common:: Input section for common symbols | |
2685 | * Input Section Keep:: Input section and garbage collection | |
2686 | * Input Section Example:: Input section example | |
2687 | @end menu | |
2688 | ||
2689 | @node Input Section Basics | |
2690 | @subsubsection Input section basics | |
2691 | @cindex input section basics | |
2692 | An input section description consists of a file name optionally followed | |
2693 | by a list of section names in parentheses. | |
2694 | ||
2695 | The file name and the section name may be wildcard patterns, which we | |
2696 | describe further below (@pxref{Input Section Wildcards}). | |
2697 | ||
2698 | The most common input section description is to include all input | |
2699 | sections with a particular name in the output section. For example, to | |
2700 | include all input @samp{.text} sections, you would write: | |
2701 | @smallexample | |
2702 | *(.text) | |
2703 | @end smallexample | |
2704 | @noindent | |
18625d54 CM |
2705 | Here the @samp{*} is a wildcard which matches any file name. To exclude a list |
2706 | of files from matching the file name wildcard, EXCLUDE_FILE may be used to | |
2707 | match all files except the ones specified in the EXCLUDE_FILE list. For | |
2708 | example: | |
252b5132 | 2709 | @smallexample |
765b7cbe | 2710 | (*(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)) |
252b5132 | 2711 | @end smallexample |
765b7cbe JB |
2712 | will cause all .ctors sections from all files except @file{crtend.o} and |
2713 | @file{otherfile.o} to be included. | |
252b5132 RH |
2714 | |
2715 | There are two ways to include more than one section: | |
2716 | @smallexample | |
2717 | *(.text .rdata) | |
2718 | *(.text) *(.rdata) | |
2719 | @end smallexample | |
2720 | @noindent | |
2721 | The difference between these is the order in which the @samp{.text} and | |
2722 | @samp{.rdata} input sections will appear in the output section. In the | |
b6bf44ba AM |
2723 | first example, they will be intermingled, appearing in the same order as |
2724 | they are found in the linker input. In the second example, all | |
252b5132 RH |
2725 | @samp{.text} input sections will appear first, followed by all |
2726 | @samp{.rdata} input sections. | |
2727 | ||
2728 | You can specify a file name to include sections from a particular file. | |
2729 | You would do this if one or more of your files contain special data that | |
2730 | needs to be at a particular location in memory. For example: | |
2731 | @smallexample | |
2732 | data.o(.data) | |
2733 | @end smallexample | |
2734 | ||
2735 | If you use a file name without a list of sections, then all sections in | |
2736 | the input file will be included in the output section. This is not | |
2737 | commonly done, but it may by useful on occasion. For example: | |
2738 | @smallexample | |
2739 | data.o | |
2740 | @end smallexample | |
2741 | ||
2742 | When you use a file name which does not contain any wild card | |
2743 | characters, the linker will first see if you also specified the file | |
2744 | name on the linker command line or in an @code{INPUT} command. If you | |
2745 | did not, the linker will attempt to open the file as an input file, as | |
2746 | though it appeared on the command line. Note that this differs from an | |
2747 | @code{INPUT} command, because the linker will not search for the file in | |
2748 | the archive search path. | |
2749 | ||
2750 | @node Input Section Wildcards | |
2751 | @subsubsection Input section wildcard patterns | |
2752 | @cindex input section wildcards | |
2753 | @cindex wildcard file name patterns | |
2754 | @cindex file name wildcard patterns | |
2755 | @cindex section name wildcard patterns | |
2756 | In an input section description, either the file name or the section | |
2757 | name or both may be wildcard patterns. | |
2758 | ||
2759 | The file name of @samp{*} seen in many examples is a simple wildcard | |
2760 | pattern for the file name. | |
2761 | ||
2762 | The wildcard patterns are like those used by the Unix shell. | |
2763 | ||
2764 | @table @samp | |
2765 | @item * | |
2766 | matches any number of characters | |
2767 | @item ? | |
2768 | matches any single character | |
2769 | @item [@var{chars}] | |
2770 | matches a single instance of any of the @var{chars}; the @samp{-} | |
2771 | character may be used to specify a range of characters, as in | |
2772 | @samp{[a-z]} to match any lower case letter | |
2773 | @item \ | |
2774 | quotes the following character | |
2775 | @end table | |
2776 | ||
2777 | When a file name is matched with a wildcard, the wildcard characters | |
2778 | will not match a @samp{/} character (used to separate directory names on | |
2779 | Unix). A pattern consisting of a single @samp{*} character is an | |
2780 | exception; it will always match any file name, whether it contains a | |
2781 | @samp{/} or not. In a section name, the wildcard characters will match | |
2782 | a @samp{/} character. | |
2783 | ||
2784 | File name wildcard patterns only match files which are explicitly | |
2785 | specified on the command line or in an @code{INPUT} command. The linker | |
2786 | does not search directories to expand wildcards. | |
2787 | ||
2788 | If a file name matches more than one wildcard pattern, or if a file name | |
2789 | appears explicitly and is also matched by a wildcard pattern, the linker | |
2790 | will use the first match in the linker script. For example, this | |
2791 | sequence of input section descriptions is probably in error, because the | |
2792 | @file{data.o} rule will not be used: | |
2793 | @smallexample | |
2794 | .data : @{ *(.data) @} | |
2795 | .data1 : @{ data.o(.data) @} | |
2796 | @end smallexample | |
2797 | ||
2798 | @cindex SORT | |
2799 | Normally, the linker will place files and sections matched by wildcards | |
2800 | in the order in which they are seen during the link. You can change | |
2801 | this by using the @code{SORT} keyword, which appears before a wildcard | |
2802 | pattern in parentheses (e.g., @code{SORT(.text*)}). When the | |
2803 | @code{SORT} keyword is used, the linker will sort the files or sections | |
2804 | into ascending order by name before placing them in the output file. | |
2805 | ||
2806 | If you ever get confused about where input sections are going, use the | |
2807 | @samp{-M} linker option to generate a map file. The map file shows | |
2808 | precisely how input sections are mapped to output sections. | |
2809 | ||
2810 | This example shows how wildcard patterns might be used to partition | |
2811 | files. This linker script directs the linker to place all @samp{.text} | |
2812 | sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}. | |
2813 | The linker will place the @samp{.data} section from all files beginning | |
2814 | with an upper case character in @samp{.DATA}; for all other files, the | |
2815 | linker will place the @samp{.data} section in @samp{.data}. | |
2816 | @smallexample | |
2817 | @group | |
2818 | SECTIONS @{ | |
2819 | .text : @{ *(.text) @} | |
2820 | .DATA : @{ [A-Z]*(.data) @} | |
2821 | .data : @{ *(.data) @} | |
2822 | .bss : @{ *(.bss) @} | |
2823 | @} | |
2824 | @end group | |
2825 | @end smallexample | |
2826 | ||
2827 | @node Input Section Common | |
2828 | @subsubsection Input section for common symbols | |
2829 | @cindex common symbol placement | |
2830 | @cindex uninitialized data placement | |
2831 | A special notation is needed for common symbols, because in many object | |
2832 | file formats common symbols do not have a particular input section. The | |
2833 | linker treats common symbols as though they are in an input section | |
2834 | named @samp{COMMON}. | |
2835 | ||
2836 | You may use file names with the @samp{COMMON} section just as with any | |
2837 | other input sections. You can use this to place common symbols from a | |
2838 | particular input file in one section while common symbols from other | |
2839 | input files are placed in another section. | |
2840 | ||
2841 | In most cases, common symbols in input files will be placed in the | |
2842 | @samp{.bss} section in the output file. For example: | |
2843 | @smallexample | |
2844 | .bss @{ *(.bss) *(COMMON) @} | |
2845 | @end smallexample | |
2846 | ||
2847 | @cindex scommon section | |
2848 | @cindex small common symbols | |
2849 | Some object file formats have more than one type of common symbol. For | |
2850 | example, the MIPS ELF object file format distinguishes standard common | |
2851 | symbols and small common symbols. In this case, the linker will use a | |
2852 | different special section name for other types of common symbols. In | |
2853 | the case of MIPS ELF, the linker uses @samp{COMMON} for standard common | |
2854 | symbols and @samp{.scommon} for small common symbols. This permits you | |
2855 | to map the different types of common symbols into memory at different | |
2856 | locations. | |
2857 | ||
2858 | @cindex [COMMON] | |
2859 | You will sometimes see @samp{[COMMON]} in old linker scripts. This | |
2860 | notation is now considered obsolete. It is equivalent to | |
2861 | @samp{*(COMMON)}. | |
2862 | ||
2863 | @node Input Section Keep | |
2864 | @subsubsection Input section and garbage collection | |
2865 | @cindex KEEP | |
2866 | @cindex garbage collection | |
2867 | When link-time garbage collection is in use (@samp{--gc-sections}), | |
a1ab1d2a | 2868 | it is often useful to mark sections that should not be eliminated. |
252b5132 RH |
2869 | This is accomplished by surrounding an input section's wildcard entry |
2870 | with @code{KEEP()}, as in @code{KEEP(*(.init))} or | |
2871 | @code{KEEP(SORT(*)(.ctors))}. | |
2872 | ||
2873 | @node Input Section Example | |
2874 | @subsubsection Input section example | |
2875 | The following example is a complete linker script. It tells the linker | |
2876 | to read all of the sections from file @file{all.o} and place them at the | |
2877 | start of output section @samp{outputa} which starts at location | |
2878 | @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o} | |
2879 | follows immediately, in the same output section. All of section | |
2880 | @samp{.input2} from @file{foo.o} goes into output section | |
2881 | @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}. | |
2882 | All of the remaining @samp{.input1} and @samp{.input2} sections from any | |
2883 | files are written to output section @samp{outputc}. | |
2884 | ||
2885 | @smallexample | |
2886 | @group | |
2887 | SECTIONS @{ | |
2888 | outputa 0x10000 : | |
2889 | @{ | |
2890 | all.o | |
2891 | foo.o (.input1) | |
2892 | @} | |
2893 | outputb : | |
2894 | @{ | |
2895 | foo.o (.input2) | |
2896 | foo1.o (.input1) | |
2897 | @} | |
2898 | outputc : | |
2899 | @{ | |
2900 | *(.input1) | |
2901 | *(.input2) | |
2902 | @} | |
2903 | @} | |
2904 | @end group | |
a1ab1d2a | 2905 | @end smallexample |
252b5132 RH |
2906 | |
2907 | @node Output Section Data | |
2908 | @subsection Output section data | |
2909 | @cindex data | |
2910 | @cindex section data | |
2911 | @cindex output section data | |
2912 | @kindex BYTE(@var{expression}) | |
2913 | @kindex SHORT(@var{expression}) | |
2914 | @kindex LONG(@var{expression}) | |
2915 | @kindex QUAD(@var{expression}) | |
2916 | @kindex SQUAD(@var{expression}) | |
2917 | You can include explicit bytes of data in an output section by using | |
2918 | @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as | |
2919 | an output section command. Each keyword is followed by an expression in | |
2920 | parentheses providing the value to store (@pxref{Expressions}). The | |
2921 | value of the expression is stored at the current value of the location | |
2922 | counter. | |
2923 | ||
2924 | The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands | |
2925 | store one, two, four, and eight bytes (respectively). After storing the | |
2926 | bytes, the location counter is incremented by the number of bytes | |
2927 | stored. | |
2928 | ||
2929 | For example, this will store the byte 1 followed by the four byte value | |
2930 | of the symbol @samp{addr}: | |
2931 | @smallexample | |
2932 | BYTE(1) | |
2933 | LONG(addr) | |
2934 | @end smallexample | |
2935 | ||
2936 | When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the | |
2937 | same; they both store an 8 byte, or 64 bit, value. When both host and | |
2938 | target are 32 bits, an expression is computed as 32 bits. In this case | |
2939 | @code{QUAD} stores a 32 bit value zero extended to 64 bits, and | |
2940 | @code{SQUAD} stores a 32 bit value sign extended to 64 bits. | |
2941 | ||
2942 | If the object file format of the output file has an explicit endianness, | |
2943 | which is the normal case, the value will be stored in that endianness. | |
2944 | When the object file format does not have an explicit endianness, as is | |
2945 | true of, for example, S-records, the value will be stored in the | |
2946 | endianness of the first input object file. | |
2947 | ||
2b5fc1f5 NC |
2948 | Note - these commands only work inside a section description and not |
2949 | between them, so the following will produce an error from the linker: | |
2950 | @smallexample | |
2951 | SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@ | |
2952 | @end smallexample | |
2953 | whereas this will work: | |
2954 | @smallexample | |
2955 | SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@ | |
2956 | @end smallexample | |
2957 | ||
252b5132 RH |
2958 | @kindex FILL(@var{expression}) |
2959 | @cindex holes, filling | |
2960 | @cindex unspecified memory | |
2961 | You may use the @code{FILL} command to set the fill pattern for the | |
2962 | current section. It is followed by an expression in parentheses. Any | |
2963 | otherwise unspecified regions of memory within the section (for example, | |
2964 | gaps left due to the required alignment of input sections) are filled | |
a139d329 | 2965 | with the value of the expression, repeated as |
252b5132 RH |
2966 | necessary. A @code{FILL} statement covers memory locations after the |
2967 | point at which it occurs in the section definition; by including more | |
2968 | than one @code{FILL} statement, you can have different fill patterns in | |
2969 | different parts of an output section. | |
2970 | ||
2971 | This example shows how to fill unspecified regions of memory with the | |
563e308f | 2972 | value @samp{0x90}: |
252b5132 | 2973 | @smallexample |
563e308f | 2974 | FILL(0x90909090) |
252b5132 RH |
2975 | @end smallexample |
2976 | ||
2977 | The @code{FILL} command is similar to the @samp{=@var{fillexp}} output | |
9673c93c | 2978 | section attribute, but it only affects the |
252b5132 RH |
2979 | part of the section following the @code{FILL} command, rather than the |
2980 | entire section. If both are used, the @code{FILL} command takes | |
9673c93c | 2981 | precedence. @xref{Output Section Fill}, for details on the fill |
a139d329 | 2982 | expression. |
252b5132 RH |
2983 | |
2984 | @node Output Section Keywords | |
2985 | @subsection Output section keywords | |
2986 | There are a couple of keywords which can appear as output section | |
2987 | commands. | |
2988 | ||
2989 | @table @code | |
2990 | @kindex CREATE_OBJECT_SYMBOLS | |
2991 | @cindex input filename symbols | |
2992 | @cindex filename symbols | |
2993 | @item CREATE_OBJECT_SYMBOLS | |
2994 | The command tells the linker to create a symbol for each input file. | |
2995 | The name of each symbol will be the name of the corresponding input | |
2996 | file. The section of each symbol will be the output section in which | |
2997 | the @code{CREATE_OBJECT_SYMBOLS} command appears. | |
2998 | ||
2999 | This is conventional for the a.out object file format. It is not | |
3000 | normally used for any other object file format. | |
3001 | ||
3002 | @kindex CONSTRUCTORS | |
3003 | @cindex C++ constructors, arranging in link | |
3004 | @cindex constructors, arranging in link | |
3005 | @item CONSTRUCTORS | |
3006 | When linking using the a.out object file format, the linker uses an | |
3007 | unusual set construct to support C++ global constructors and | |
3008 | destructors. When linking object file formats which do not support | |
3009 | arbitrary sections, such as ECOFF and XCOFF, the linker will | |
3010 | automatically recognize C++ global constructors and destructors by name. | |
3011 | For these object file formats, the @code{CONSTRUCTORS} command tells the | |
3012 | linker to place constructor information in the output section where the | |
3013 | @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is | |
3014 | ignored for other object file formats. | |
3015 | ||
3016 | The symbol @w{@code{__CTOR_LIST__}} marks the start of the global | |
3017 | constructors, and the symbol @w{@code{__DTOR_LIST}} marks the end. The | |
3018 | first word in the list is the number of entries, followed by the address | |
3019 | of each constructor or destructor, followed by a zero word. The | |
3020 | compiler must arrange to actually run the code. For these object file | |
3021 | formats @sc{gnu} C++ normally calls constructors from a subroutine | |
3022 | @code{__main}; a call to @code{__main} is automatically inserted into | |
3023 | the startup code for @code{main}. @sc{gnu} C++ normally runs | |
3024 | destructors either by using @code{atexit}, or directly from the function | |
3025 | @code{exit}. | |
3026 | ||
3027 | For object file formats such as @code{COFF} or @code{ELF} which support | |
3028 | arbitrary section names, @sc{gnu} C++ will normally arrange to put the | |
3029 | addresses of global constructors and destructors into the @code{.ctors} | |
3030 | and @code{.dtors} sections. Placing the following sequence into your | |
3031 | linker script will build the sort of table which the @sc{gnu} C++ | |
3032 | runtime code expects to see. | |
3033 | ||
3034 | @smallexample | |
3035 | __CTOR_LIST__ = .; | |
3036 | LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2) | |
3037 | *(.ctors) | |
3038 | LONG(0) | |
3039 | __CTOR_END__ = .; | |
3040 | __DTOR_LIST__ = .; | |
3041 | LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2) | |
3042 | *(.dtors) | |
3043 | LONG(0) | |
3044 | __DTOR_END__ = .; | |
3045 | @end smallexample | |
3046 | ||
3047 | If you are using the @sc{gnu} C++ support for initialization priority, | |
3048 | which provides some control over the order in which global constructors | |
3049 | are run, you must sort the constructors at link time to ensure that they | |
3050 | are executed in the correct order. When using the @code{CONSTRUCTORS} | |
3051 | command, use @samp{SORT(CONSTRUCTORS)} instead. When using the | |
3052 | @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT(.ctors))} and | |
3053 | @samp{*(SORT(.dtors))} instead of just @samp{*(.ctors)} and | |
3054 | @samp{*(.dtors)}. | |
3055 | ||
3056 | Normally the compiler and linker will handle these issues automatically, | |
3057 | and you will not need to concern yourself with them. However, you may | |
3058 | need to consider this if you are using C++ and writing your own linker | |
3059 | scripts. | |
3060 | ||
3061 | @end table | |
3062 | ||
3063 | @node Output Section Discarding | |
3064 | @subsection Output section discarding | |
3065 | @cindex discarding sections | |
3066 | @cindex sections, discarding | |
3067 | @cindex removing sections | |
3068 | The linker will not create output section which do not have any | |
3069 | contents. This is for convenience when referring to input sections that | |
3070 | may or may not be present in any of the input files. For example: | |
3071 | @smallexample | |
3072 | .foo @{ *(.foo) @} | |
3073 | @end smallexample | |
3074 | @noindent | |
3075 | will only create a @samp{.foo} section in the output file if there is a | |
3076 | @samp{.foo} section in at least one input file. | |
3077 | ||
3078 | If you use anything other than an input section description as an output | |
3079 | section command, such as a symbol assignment, then the output section | |
3080 | will always be created, even if there are no matching input sections. | |
3081 | ||
3082 | @cindex /DISCARD/ | |
3083 | The special output section name @samp{/DISCARD/} may be used to discard | |
3084 | input sections. Any input sections which are assigned to an output | |
3085 | section named @samp{/DISCARD/} are not included in the output file. | |
3086 | ||
3087 | @node Output Section Attributes | |
3088 | @subsection Output section attributes | |
3089 | @cindex output section attributes | |
3090 | We showed above that the full description of an output section looked | |
3091 | like this: | |
3092 | @smallexample | |
a1ab1d2a | 3093 | @group |
252b5132 RH |
3094 | @var{section} [@var{address}] [(@var{type})] : [AT(@var{lma})] |
3095 | @{ | |
3096 | @var{output-section-command} | |
3097 | @var{output-section-command} | |
3098 | @dots{} | |
562d3460 | 3099 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
3100 | @end group |
3101 | @end smallexample | |
3102 | We've already described @var{section}, @var{address}, and | |
3103 | @var{output-section-command}. In this section we will describe the | |
3104 | remaining section attributes. | |
3105 | ||
a1ab1d2a | 3106 | @menu |
252b5132 RH |
3107 | * Output Section Type:: Output section type |
3108 | * Output Section LMA:: Output section LMA | |
3109 | * Output Section Region:: Output section region | |
3110 | * Output Section Phdr:: Output section phdr | |
3111 | * Output Section Fill:: Output section fill | |
3112 | @end menu | |
3113 | ||
3114 | @node Output Section Type | |
3115 | @subsubsection Output section type | |
3116 | Each output section may have a type. The type is a keyword in | |
3117 | parentheses. The following types are defined: | |
3118 | ||
3119 | @table @code | |
3120 | @item NOLOAD | |
3121 | The section should be marked as not loadable, so that it will not be | |
3122 | loaded into memory when the program is run. | |
3123 | @item DSECT | |
3124 | @itemx COPY | |
3125 | @itemx INFO | |
3126 | @itemx OVERLAY | |
3127 | These type names are supported for backward compatibility, and are | |
3128 | rarely used. They all have the same effect: the section should be | |
3129 | marked as not allocatable, so that no memory is allocated for the | |
3130 | section when the program is run. | |
3131 | @end table | |
3132 | ||
3133 | @kindex NOLOAD | |
3134 | @cindex prevent unnecessary loading | |
3135 | @cindex loading, preventing | |
3136 | The linker normally sets the attributes of an output section based on | |
3137 | the input sections which map into it. You can override this by using | |
3138 | the section type. For example, in the script sample below, the | |
3139 | @samp{ROM} section is addressed at memory location @samp{0} and does not | |
3140 | need to be loaded when the program is run. The contents of the | |
3141 | @samp{ROM} section will appear in the linker output file as usual. | |
3142 | @smallexample | |
3143 | @group | |
3144 | SECTIONS @{ | |
3145 | ROM 0 (NOLOAD) : @{ @dots{} @} | |
3146 | @dots{} | |
3147 | @} | |
3148 | @end group | |
3149 | @end smallexample | |
3150 | ||
3151 | @node Output Section LMA | |
3152 | @subsubsection Output section LMA | |
562d3460 | 3153 | @kindex AT>@var{lma_region} |
252b5132 RH |
3154 | @kindex AT(@var{lma}) |
3155 | @cindex load address | |
3156 | @cindex section load address | |
3157 | Every section has a virtual address (VMA) and a load address (LMA); see | |
3158 | @ref{Basic Script Concepts}. The address expression which may appear in | |
3159 | an output section description sets the VMA (@pxref{Output Section | |
3160 | Address}). | |
3161 | ||
3162 | The linker will normally set the LMA equal to the VMA. You can change | |
3163 | that by using the @code{AT} keyword. The expression @var{lma} that | |
562d3460 TW |
3164 | follows the @code{AT} keyword specifies the load address of the |
3165 | section. Alternatively, with @samp{AT>@var{lma_region}} expression, | |
3166 | you may specify a memory region for the section's load address. @xref{MEMORY}. | |
252b5132 RH |
3167 | |
3168 | @cindex ROM initialized data | |
3169 | @cindex initialized data in ROM | |
3170 | This feature is designed to make it easy to build a ROM image. For | |
3171 | example, the following linker script creates three output sections: one | |
3172 | called @samp{.text}, which starts at @code{0x1000}, one called | |
3173 | @samp{.mdata}, which is loaded at the end of the @samp{.text} section | |
3174 | even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold | |
3175 | uninitialized data at address @code{0x3000}. The symbol @code{_data} is | |
3176 | defined with the value @code{0x2000}, which shows that the location | |
3177 | counter holds the VMA value, not the LMA value. | |
3178 | ||
3179 | @smallexample | |
3180 | @group | |
3181 | SECTIONS | |
3182 | @{ | |
3183 | .text 0x1000 : @{ *(.text) _etext = . ; @} | |
a1ab1d2a | 3184 | .mdata 0x2000 : |
252b5132 RH |
3185 | AT ( ADDR (.text) + SIZEOF (.text) ) |
3186 | @{ _data = . ; *(.data); _edata = . ; @} | |
3187 | .bss 0x3000 : | |
3188 | @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@} | |
3189 | @} | |
3190 | @end group | |
3191 | @end smallexample | |
3192 | ||
3193 | The run-time initialization code for use with a program generated with | |
3194 | this linker script would include something like the following, to copy | |
3195 | the initialized data from the ROM image to its runtime address. Notice | |
3196 | how this code takes advantage of the symbols defined by the linker | |
3197 | script. | |
3198 | ||
3199 | @smallexample | |
3200 | @group | |
3201 | extern char _etext, _data, _edata, _bstart, _bend; | |
3202 | char *src = &_etext; | |
3203 | char *dst = &_data; | |
3204 | ||
3205 | /* ROM has data at end of text; copy it. */ | |
3206 | while (dst < &_edata) @{ | |
3207 | *dst++ = *src++; | |
3208 | @} | |
3209 | ||
3210 | /* Zero bss */ | |
3211 | for (dst = &_bstart; dst< &_bend; dst++) | |
3212 | *dst = 0; | |
3213 | @end group | |
3214 | @end smallexample | |
3215 | ||
3216 | @node Output Section Region | |
3217 | @subsubsection Output section region | |
3218 | @kindex >@var{region} | |
3219 | @cindex section, assigning to memory region | |
3220 | @cindex memory regions and sections | |
3221 | You can assign a section to a previously defined region of memory by | |
3222 | using @samp{>@var{region}}. @xref{MEMORY}. | |
3223 | ||
3224 | Here is a simple example: | |
3225 | @smallexample | |
3226 | @group | |
3227 | MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @} | |
3228 | SECTIONS @{ ROM : @{ *(.text) @} >rom @} | |
3229 | @end group | |
3230 | @end smallexample | |
3231 | ||
3232 | @node Output Section Phdr | |
3233 | @subsubsection Output section phdr | |
3234 | @kindex :@var{phdr} | |
3235 | @cindex section, assigning to program header | |
3236 | @cindex program headers and sections | |
3237 | You can assign a section to a previously defined program segment by | |
3238 | using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to | |
3239 | one or more segments, then all subsequent allocated sections will be | |
3240 | assigned to those segments as well, unless they use an explicitly | |
3241 | @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the | |
3242 | linker to not put the section in any segment at all. | |
3243 | ||
3244 | Here is a simple example: | |
3245 | @smallexample | |
3246 | @group | |
3247 | PHDRS @{ text PT_LOAD ; @} | |
3248 | SECTIONS @{ .text : @{ *(.text) @} :text @} | |
3249 | @end group | |
3250 | @end smallexample | |
3251 | ||
3252 | @node Output Section Fill | |
3253 | @subsubsection Output section fill | |
3254 | @kindex =@var{fillexp} | |
3255 | @cindex section fill pattern | |
3256 | @cindex fill pattern, entire section | |
3257 | You can set the fill pattern for an entire section by using | |
3258 | @samp{=@var{fillexp}}. @var{fillexp} is an expression | |
3259 | (@pxref{Expressions}). Any otherwise unspecified regions of memory | |
3260 | within the output section (for example, gaps left due to the required | |
a139d329 AM |
3261 | alignment of input sections) will be filled with the value, repeated as |
3262 | necessary. If the fill expression is a simple hex number, ie. a string | |
9673c93c | 3263 | of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then |
a139d329 AM |
3264 | an arbitrarily long sequence of hex digits can be used to specify the |
3265 | fill pattern; Leading zeros become part of the pattern too. For all | |
9673c93c | 3266 | other cases, including extra parentheses or a unary @code{+}, the fill |
a139d329 AM |
3267 | pattern is the four least significant bytes of the value of the |
3268 | expression. In all cases, the number is big-endian. | |
252b5132 RH |
3269 | |
3270 | You can also change the fill value with a @code{FILL} command in the | |
9673c93c | 3271 | output section commands; (@pxref{Output Section Data}). |
252b5132 RH |
3272 | |
3273 | Here is a simple example: | |
3274 | @smallexample | |
3275 | @group | |
563e308f | 3276 | SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @} |
252b5132 RH |
3277 | @end group |
3278 | @end smallexample | |
3279 | ||
3280 | @node Overlay Description | |
3281 | @subsection Overlay description | |
3282 | @kindex OVERLAY | |
3283 | @cindex overlays | |
3284 | An overlay description provides an easy way to describe sections which | |
3285 | are to be loaded as part of a single memory image but are to be run at | |
3286 | the same memory address. At run time, some sort of overlay manager will | |
3287 | copy the overlaid sections in and out of the runtime memory address as | |
3288 | required, perhaps by simply manipulating addressing bits. This approach | |
3289 | can be useful, for example, when a certain region of memory is faster | |
3290 | than another. | |
3291 | ||
3292 | Overlays are described using the @code{OVERLAY} command. The | |
3293 | @code{OVERLAY} command is used within a @code{SECTIONS} command, like an | |
3294 | output section description. The full syntax of the @code{OVERLAY} | |
3295 | command is as follows: | |
3296 | @smallexample | |
3297 | @group | |
3298 | OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )] | |
3299 | @{ | |
3300 | @var{secname1} | |
3301 | @{ | |
3302 | @var{output-section-command} | |
3303 | @var{output-section-command} | |
3304 | @dots{} | |
3305 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
3306 | @var{secname2} | |
3307 | @{ | |
3308 | @var{output-section-command} | |
3309 | @var{output-section-command} | |
3310 | @dots{} | |
3311 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
3312 | @dots{} | |
3313 | @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] | |
3314 | @end group | |
3315 | @end smallexample | |
3316 | ||
3317 | Everything is optional except @code{OVERLAY} (a keyword), and each | |
3318 | section must have a name (@var{secname1} and @var{secname2} above). The | |
3319 | section definitions within the @code{OVERLAY} construct are identical to | |
3320 | those within the general @code{SECTIONS} contruct (@pxref{SECTIONS}), | |
3321 | except that no addresses and no memory regions may be defined for | |
3322 | sections within an @code{OVERLAY}. | |
3323 | ||
3324 | The sections are all defined with the same starting address. The load | |
3325 | addresses of the sections are arranged such that they are consecutive in | |
3326 | memory starting at the load address used for the @code{OVERLAY} as a | |
3327 | whole (as with normal section definitions, the load address is optional, | |
3328 | and defaults to the start address; the start address is also optional, | |
3329 | and defaults to the current value of the location counter). | |
3330 | ||
3331 | If the @code{NOCROSSREFS} keyword is used, and there any references | |
3332 | among the sections, the linker will report an error. Since the sections | |
3333 | all run at the same address, it normally does not make sense for one | |
3334 | section to refer directly to another. @xref{Miscellaneous Commands, | |
3335 | NOCROSSREFS}. | |
3336 | ||
3337 | For each section within the @code{OVERLAY}, the linker automatically | |
3338 | defines two symbols. The symbol @code{__load_start_@var{secname}} is | |
3339 | defined as the starting load address of the section. The symbol | |
3340 | @code{__load_stop_@var{secname}} is defined as the final load address of | |
3341 | the section. Any characters within @var{secname} which are not legal | |
3342 | within C identifiers are removed. C (or assembler) code may use these | |
3343 | symbols to move the overlaid sections around as necessary. | |
3344 | ||
3345 | At the end of the overlay, the value of the location counter is set to | |
3346 | the start address of the overlay plus the size of the largest section. | |
3347 | ||
3348 | Here is an example. Remember that this would appear inside a | |
3349 | @code{SECTIONS} construct. | |
3350 | @smallexample | |
3351 | @group | |
3352 | OVERLAY 0x1000 : AT (0x4000) | |
3353 | @{ | |
3354 | .text0 @{ o1/*.o(.text) @} | |
3355 | .text1 @{ o2/*.o(.text) @} | |
3356 | @} | |
3357 | @end group | |
3358 | @end smallexample | |
3359 | @noindent | |
3360 | This will define both @samp{.text0} and @samp{.text1} to start at | |
3361 | address 0x1000. @samp{.text0} will be loaded at address 0x4000, and | |
3362 | @samp{.text1} will be loaded immediately after @samp{.text0}. The | |
3363 | following symbols will be defined: @code{__load_start_text0}, | |
3364 | @code{__load_stop_text0}, @code{__load_start_text1}, | |
3365 | @code{__load_stop_text1}. | |
3366 | ||
3367 | C code to copy overlay @code{.text1} into the overlay area might look | |
3368 | like the following. | |
3369 | ||
3370 | @smallexample | |
3371 | @group | |
3372 | extern char __load_start_text1, __load_stop_text1; | |
3373 | memcpy ((char *) 0x1000, &__load_start_text1, | |
3374 | &__load_stop_text1 - &__load_start_text1); | |
3375 | @end group | |
3376 | @end smallexample | |
3377 | ||
3378 | Note that the @code{OVERLAY} command is just syntactic sugar, since | |
3379 | everything it does can be done using the more basic commands. The above | |
3380 | example could have been written identically as follows. | |
3381 | ||
3382 | @smallexample | |
3383 | @group | |
3384 | .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @} | |
3385 | __load_start_text0 = LOADADDR (.text0); | |
3386 | __load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0); | |
3387 | .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @} | |
3388 | __load_start_text1 = LOADADDR (.text1); | |
3389 | __load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1); | |
3390 | . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1)); | |
3391 | @end group | |
3392 | @end smallexample | |
3393 | ||
3394 | @node MEMORY | |
3395 | @section MEMORY command | |
3396 | @kindex MEMORY | |
3397 | @cindex memory regions | |
3398 | @cindex regions of memory | |
3399 | @cindex allocating memory | |
3400 | @cindex discontinuous memory | |
3401 | The linker's default configuration permits allocation of all available | |
3402 | memory. You can override this by using the @code{MEMORY} command. | |
3403 | ||
3404 | The @code{MEMORY} command describes the location and size of blocks of | |
3405 | memory in the target. You can use it to describe which memory regions | |
3406 | may be used by the linker, and which memory regions it must avoid. You | |
3407 | can then assign sections to particular memory regions. The linker will | |
3408 | set section addresses based on the memory regions, and will warn about | |
3409 | regions that become too full. The linker will not shuffle sections | |
3410 | around to fit into the available regions. | |
3411 | ||
3412 | A linker script may contain at most one use of the @code{MEMORY} | |
3413 | command. However, you can define as many blocks of memory within it as | |
3414 | you wish. The syntax is: | |
3415 | @smallexample | |
3416 | @group | |
a1ab1d2a | 3417 | MEMORY |
252b5132 RH |
3418 | @{ |
3419 | @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len} | |
3420 | @dots{} | |
3421 | @} | |
3422 | @end group | |
3423 | @end smallexample | |
3424 | ||
3425 | The @var{name} is a name used in the linker script to refer to the | |
3426 | region. The region name has no meaning outside of the linker script. | |
3427 | Region names are stored in a separate name space, and will not conflict | |
3428 | with symbol names, file names, or section names. Each memory region | |
3429 | must have a distinct name. | |
3430 | ||
3431 | @cindex memory region attributes | |
3432 | The @var{attr} string is an optional list of attributes that specify | |
3433 | whether to use a particular memory region for an input section which is | |
3434 | not explicitly mapped in the linker script. As described in | |
3435 | @ref{SECTIONS}, if you do not specify an output section for some input | |
3436 | section, the linker will create an output section with the same name as | |
3437 | the input section. If you define region attributes, the linker will use | |
3438 | them to select the memory region for the output section that it creates. | |
3439 | ||
3440 | The @var{attr} string must consist only of the following characters: | |
3441 | @table @samp | |
3442 | @item R | |
3443 | Read-only section | |
3444 | @item W | |
3445 | Read/write section | |
3446 | @item X | |
3447 | Executable section | |
3448 | @item A | |
3449 | Allocatable section | |
3450 | @item I | |
3451 | Initialized section | |
3452 | @item L | |
3453 | Same as @samp{I} | |
3454 | @item ! | |
3455 | Invert the sense of any of the preceding attributes | |
3456 | @end table | |
3457 | ||
3458 | If a unmapped section matches any of the listed attributes other than | |
3459 | @samp{!}, it will be placed in the memory region. The @samp{!} | |
3460 | attribute reverses this test, so that an unmapped section will be placed | |
3461 | in the memory region only if it does not match any of the listed | |
3462 | attributes. | |
3463 | ||
3464 | @kindex ORIGIN = | |
3465 | @kindex o = | |
3466 | @kindex org = | |
3467 | The @var{origin} is an expression for the start address of the memory | |
3468 | region. The expression must evaluate to a constant before memory | |
3469 | allocation is performed, which means that you may not use any section | |
3470 | relative symbols. The keyword @code{ORIGIN} may be abbreviated to | |
3471 | @code{org} or @code{o} (but not, for example, @code{ORG}). | |
3472 | ||
3473 | @kindex LENGTH = | |
3474 | @kindex len = | |
3475 | @kindex l = | |
3476 | The @var{len} is an expression for the size in bytes of the memory | |
3477 | region. As with the @var{origin} expression, the expression must | |
3478 | evaluate to a constant before memory allocation is performed. The | |
3479 | keyword @code{LENGTH} may be abbreviated to @code{len} or @code{l}. | |
3480 | ||
3481 | In the following example, we specify that there are two memory regions | |
3482 | available for allocation: one starting at @samp{0} for 256 kilobytes, | |
3483 | and the other starting at @samp{0x40000000} for four megabytes. The | |
3484 | linker will place into the @samp{rom} memory region every section which | |
3485 | is not explicitly mapped into a memory region, and is either read-only | |
3486 | or executable. The linker will place other sections which are not | |
3487 | explicitly mapped into a memory region into the @samp{ram} memory | |
3488 | region. | |
3489 | ||
3490 | @smallexample | |
3491 | @group | |
a1ab1d2a | 3492 | MEMORY |
252b5132 RH |
3493 | @{ |
3494 | rom (rx) : ORIGIN = 0, LENGTH = 256K | |
3495 | ram (!rx) : org = 0x40000000, l = 4M | |
3496 | @} | |
3497 | @end group | |
3498 | @end smallexample | |
3499 | ||
3500 | Once you define a memory region, you can direct the linker to place | |
3501 | specific output sections into that memory region by using the | |
3502 | @samp{>@var{region}} output section attribute. For example, if you have | |
3503 | a memory region named @samp{mem}, you would use @samp{>mem} in the | |
3504 | output section definition. @xref{Output Section Region}. If no address | |
3505 | was specified for the output section, the linker will set the address to | |
3506 | the next available address within the memory region. If the combined | |
3507 | output sections directed to a memory region are too large for the | |
3508 | region, the linker will issue an error message. | |
3509 | ||
3510 | @node PHDRS | |
3511 | @section PHDRS Command | |
3512 | @kindex PHDRS | |
3513 | @cindex program headers | |
3514 | @cindex ELF program headers | |
3515 | @cindex program segments | |
3516 | @cindex segments, ELF | |
3517 | The ELF object file format uses @dfn{program headers}, also knows as | |
3518 | @dfn{segments}. The program headers describe how the program should be | |
3519 | loaded into memory. You can print them out by using the @code{objdump} | |
3520 | program with the @samp{-p} option. | |
3521 | ||
3522 | When you run an ELF program on a native ELF system, the system loader | |
3523 | reads the program headers in order to figure out how to load the | |
3524 | program. This will only work if the program headers are set correctly. | |
3525 | This manual does not describe the details of how the system loader | |
3526 | interprets program headers; for more information, see the ELF ABI. | |
3527 | ||
3528 | The linker will create reasonable program headers by default. However, | |
3529 | in some cases, you may need to specify the program headers more | |
3530 | precisely. You may use the @code{PHDRS} command for this purpose. When | |
3531 | the linker sees the @code{PHDRS} command in the linker script, it will | |
3532 | not create any program headers other than the ones specified. | |
3533 | ||
3534 | The linker only pays attention to the @code{PHDRS} command when | |
3535 | generating an ELF output file. In other cases, the linker will simply | |
3536 | ignore @code{PHDRS}. | |
3537 | ||
3538 | This is the syntax of the @code{PHDRS} command. The words @code{PHDRS}, | |
3539 | @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords. | |
3540 | ||
3541 | @smallexample | |
3542 | @group | |
3543 | PHDRS | |
3544 | @{ | |
3545 | @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ] | |
3546 | [ FLAGS ( @var{flags} ) ] ; | |
3547 | @} | |
3548 | @end group | |
3549 | @end smallexample | |
3550 | ||
3551 | The @var{name} is used only for reference in the @code{SECTIONS} command | |
3552 | of the linker script. It is not put into the output file. Program | |
3553 | header names are stored in a separate name space, and will not conflict | |
3554 | with symbol names, file names, or section names. Each program header | |
3555 | must have a distinct name. | |
3556 | ||
3557 | Certain program header types describe segments of memory which the | |
3558 | system loader will load from the file. In the linker script, you | |
3559 | specify the contents of these segments by placing allocatable output | |
3560 | sections in the segments. You use the @samp{:@var{phdr}} output section | |
3561 | attribute to place a section in a particular segment. @xref{Output | |
3562 | Section Phdr}. | |
3563 | ||
3564 | It is normal to put certain sections in more than one segment. This | |
3565 | merely implies that one segment of memory contains another. You may | |
3566 | repeat @samp{:@var{phdr}}, using it once for each segment which should | |
3567 | contain the section. | |
3568 | ||
3569 | If you place a section in one or more segments using @samp{:@var{phdr}}, | |
3570 | then the linker will place all subsequent allocatable sections which do | |
3571 | not specify @samp{:@var{phdr}} in the same segments. This is for | |
3572 | convenience, since generally a whole set of contiguous sections will be | |
3573 | placed in a single segment. You can use @code{:NONE} to override the | |
3574 | default segment and tell the linker to not put the section in any | |
3575 | segment at all. | |
3576 | ||
3577 | @kindex FILEHDR | |
3578 | @kindex PHDRS | |
3579 | You may use the @code{FILEHDR} and @code{PHDRS} keywords appear after | |
3580 | the program header type to further describe the contents of the segment. | |
3581 | The @code{FILEHDR} keyword means that the segment should include the ELF | |
3582 | file header. The @code{PHDRS} keyword means that the segment should | |
3583 | include the ELF program headers themselves. | |
3584 | ||
3585 | The @var{type} may be one of the following. The numbers indicate the | |
3586 | value of the keyword. | |
3587 | ||
3588 | @table @asis | |
3589 | @item @code{PT_NULL} (0) | |
3590 | Indicates an unused program header. | |
3591 | ||
3592 | @item @code{PT_LOAD} (1) | |
3593 | Indicates that this program header describes a segment to be loaded from | |
3594 | the file. | |
3595 | ||
3596 | @item @code{PT_DYNAMIC} (2) | |
3597 | Indicates a segment where dynamic linking information can be found. | |
3598 | ||
3599 | @item @code{PT_INTERP} (3) | |
3600 | Indicates a segment where the name of the program interpreter may be | |
3601 | found. | |
3602 | ||
3603 | @item @code{PT_NOTE} (4) | |
3604 | Indicates a segment holding note information. | |
3605 | ||
3606 | @item @code{PT_SHLIB} (5) | |
3607 | A reserved program header type, defined but not specified by the ELF | |
3608 | ABI. | |
3609 | ||
3610 | @item @code{PT_PHDR} (6) | |
3611 | Indicates a segment where the program headers may be found. | |
3612 | ||
3613 | @item @var{expression} | |
3614 | An expression giving the numeric type of the program header. This may | |
3615 | be used for types not defined above. | |
3616 | @end table | |
3617 | ||
3618 | You can specify that a segment should be loaded at a particular address | |
3619 | in memory by using an @code{AT} expression. This is identical to the | |
3620 | @code{AT} command used as an output section attribute (@pxref{Output | |
3621 | Section LMA}). The @code{AT} command for a program header overrides the | |
3622 | output section attribute. | |
3623 | ||
3624 | The linker will normally set the segment flags based on the sections | |
3625 | which comprise the segment. You may use the @code{FLAGS} keyword to | |
3626 | explicitly specify the segment flags. The value of @var{flags} must be | |
3627 | an integer. It is used to set the @code{p_flags} field of the program | |
3628 | header. | |
3629 | ||
3630 | Here is an example of @code{PHDRS}. This shows a typical set of program | |
3631 | headers used on a native ELF system. | |
3632 | ||
3633 | @example | |
3634 | @group | |
3635 | PHDRS | |
3636 | @{ | |
3637 | headers PT_PHDR PHDRS ; | |
3638 | interp PT_INTERP ; | |
3639 | text PT_LOAD FILEHDR PHDRS ; | |
3640 | data PT_LOAD ; | |
3641 | dynamic PT_DYNAMIC ; | |
3642 | @} | |
3643 | ||
3644 | SECTIONS | |
3645 | @{ | |
3646 | . = SIZEOF_HEADERS; | |
3647 | .interp : @{ *(.interp) @} :text :interp | |
3648 | .text : @{ *(.text) @} :text | |
3649 | .rodata : @{ *(.rodata) @} /* defaults to :text */ | |
3650 | @dots{} | |
3651 | . = . + 0x1000; /* move to a new page in memory */ | |
3652 | .data : @{ *(.data) @} :data | |
3653 | .dynamic : @{ *(.dynamic) @} :data :dynamic | |
3654 | @dots{} | |
3655 | @} | |
3656 | @end group | |
3657 | @end example | |
3658 | ||
3659 | @node VERSION | |
3660 | @section VERSION Command | |
3661 | @kindex VERSION @{script text@} | |
3662 | @cindex symbol versions | |
3663 | @cindex version script | |
3664 | @cindex versions of symbols | |
3665 | The linker supports symbol versions when using ELF. Symbol versions are | |
3666 | only useful when using shared libraries. The dynamic linker can use | |
3667 | symbol versions to select a specific version of a function when it runs | |
3668 | a program that may have been linked against an earlier version of the | |
3669 | shared library. | |
3670 | ||
3671 | You can include a version script directly in the main linker script, or | |
3672 | you can supply the version script as an implicit linker script. You can | |
3673 | also use the @samp{--version-script} linker option. | |
3674 | ||
3675 | The syntax of the @code{VERSION} command is simply | |
3676 | @smallexample | |
3677 | VERSION @{ version-script-commands @} | |
3678 | @end smallexample | |
3679 | ||
3680 | The format of the version script commands is identical to that used by | |
3681 | Sun's linker in Solaris 2.5. The version script defines a tree of | |
3682 | version nodes. You specify the node names and interdependencies in the | |
3683 | version script. You can specify which symbols are bound to which | |
3684 | version nodes, and you can reduce a specified set of symbols to local | |
3685 | scope so that they are not globally visible outside of the shared | |
3686 | library. | |
3687 | ||
3688 | The easiest way to demonstrate the version script language is with a few | |
3689 | examples. | |
3690 | ||
3691 | @smallexample | |
3692 | VERS_1.1 @{ | |
3693 | global: | |
3694 | foo1; | |
3695 | local: | |
a1ab1d2a UD |
3696 | old*; |
3697 | original*; | |
3698 | new*; | |
252b5132 RH |
3699 | @}; |
3700 | ||
3701 | VERS_1.2 @{ | |
3702 | foo2; | |
3703 | @} VERS_1.1; | |
3704 | ||
3705 | VERS_2.0 @{ | |
3706 | bar1; bar2; | |
3707 | @} VERS_1.2; | |
3708 | @end smallexample | |
3709 | ||
3710 | This example version script defines three version nodes. The first | |
3711 | version node defined is @samp{VERS_1.1}; it has no other dependencies. | |
3712 | The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces | |
3713 | a number of symbols to local scope so that they are not visible outside | |
313e35ee AM |
3714 | of the shared library; this is done using wildcard patterns, so that any |
3715 | symbol whose name begins with @samp{old}, @samp{original}, or @samp{new} | |
3716 | is matched. The wildcard patterns available are the same as those used | |
3717 | in the shell when matching filenames (also known as ``globbing''). | |
252b5132 RH |
3718 | |
3719 | Next, the version script defines node @samp{VERS_1.2}. This node | |
3720 | depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2} | |
3721 | to the version node @samp{VERS_1.2}. | |
3722 | ||
3723 | Finally, the version script defines node @samp{VERS_2.0}. This node | |
3724 | depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1} | |
3725 | and @samp{bar2} are bound to the version node @samp{VERS_2.0}. | |
3726 | ||
3727 | When the linker finds a symbol defined in a library which is not | |
3728 | specifically bound to a version node, it will effectively bind it to an | |
3729 | unspecified base version of the library. You can bind all otherwise | |
3730 | unspecified symbols to a given version node by using @samp{global: *} | |
3731 | somewhere in the version script. | |
3732 | ||
3733 | The names of the version nodes have no specific meaning other than what | |
3734 | they might suggest to the person reading them. The @samp{2.0} version | |
3735 | could just as well have appeared in between @samp{1.1} and @samp{1.2}. | |
3736 | However, this would be a confusing way to write a version script. | |
3737 | ||
6b9b879a JJ |
3738 | Node name can be omited, provided it is the only version node |
3739 | in the version script. Such version script doesn't assign any versions to | |
3740 | symbols, only selects which symbols will be globally visible out and which | |
3741 | won't. | |
3742 | ||
3743 | @smallexample | |
3744 | @{ global: foo; bar; local: *; @} | |
9d201f2f | 3745 | @end smallexample |
6b9b879a | 3746 | |
252b5132 RH |
3747 | When you link an application against a shared library that has versioned |
3748 | symbols, the application itself knows which version of each symbol it | |
3749 | requires, and it also knows which version nodes it needs from each | |
3750 | shared library it is linked against. Thus at runtime, the dynamic | |
3751 | loader can make a quick check to make sure that the libraries you have | |
3752 | linked against do in fact supply all of the version nodes that the | |
3753 | application will need to resolve all of the dynamic symbols. In this | |
3754 | way it is possible for the dynamic linker to know with certainty that | |
3755 | all external symbols that it needs will be resolvable without having to | |
3756 | search for each symbol reference. | |
3757 | ||
3758 | The symbol versioning is in effect a much more sophisticated way of | |
3759 | doing minor version checking that SunOS does. The fundamental problem | |
3760 | that is being addressed here is that typically references to external | |
3761 | functions are bound on an as-needed basis, and are not all bound when | |
3762 | the application starts up. If a shared library is out of date, a | |
3763 | required interface may be missing; when the application tries to use | |
3764 | that interface, it may suddenly and unexpectedly fail. With symbol | |
3765 | versioning, the user will get a warning when they start their program if | |
3766 | the libraries being used with the application are too old. | |
3767 | ||
3768 | There are several GNU extensions to Sun's versioning approach. The | |
3769 | first of these is the ability to bind a symbol to a version node in the | |
3770 | source file where the symbol is defined instead of in the versioning | |
3771 | script. This was done mainly to reduce the burden on the library | |
3772 | maintainer. You can do this by putting something like: | |
3773 | @smallexample | |
3774 | __asm__(".symver original_foo,foo@@VERS_1.1"); | |
3775 | @end smallexample | |
3776 | @noindent | |
3777 | in the C source file. This renames the function @samp{original_foo} to | |
3778 | be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}. | |
3779 | The @samp{local:} directive can be used to prevent the symbol | |
96a94295 L |
3780 | @samp{original_foo} from being exported. A @samp{.symver} directive |
3781 | takes precedence over a version script. | |
252b5132 RH |
3782 | |
3783 | The second GNU extension is to allow multiple versions of the same | |
3784 | function to appear in a given shared library. In this way you can make | |
3785 | an incompatible change to an interface without increasing the major | |
3786 | version number of the shared library, while still allowing applications | |
3787 | linked against the old interface to continue to function. | |
3788 | ||
3789 | To do this, you must use multiple @samp{.symver} directives in the | |
3790 | source file. Here is an example: | |
3791 | ||
3792 | @smallexample | |
3793 | __asm__(".symver original_foo,foo@@"); | |
3794 | __asm__(".symver old_foo,foo@@VERS_1.1"); | |
3795 | __asm__(".symver old_foo1,foo@@VERS_1.2"); | |
3796 | __asm__(".symver new_foo,foo@@@@VERS_2.0"); | |
3797 | @end smallexample | |
3798 | ||
3799 | In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the | |
3800 | unspecified base version of the symbol. The source file that contains this | |
3801 | example would define 4 C functions: @samp{original_foo}, @samp{old_foo}, | |
3802 | @samp{old_foo1}, and @samp{new_foo}. | |
3803 | ||
3804 | When you have multiple definitions of a given symbol, there needs to be | |
3805 | some way to specify a default version to which external references to | |
3806 | this symbol will be bound. You can do this with the | |
3807 | @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only | |
3808 | declare one version of a symbol as the default in this manner; otherwise | |
3809 | you would effectively have multiple definitions of the same symbol. | |
3810 | ||
3811 | If you wish to bind a reference to a specific version of the symbol | |
3812 | within the shared library, you can use the aliases of convenience | |
3813 | (i.e. @samp{old_foo}), or you can use the @samp{.symver} directive to | |
3814 | specifically bind to an external version of the function in question. | |
3815 | ||
cb840a31 L |
3816 | You can also specify the language in the version script: |
3817 | ||
3818 | @smallexample | |
3819 | VERSION extern "lang" @{ version-script-commands @} | |
3820 | @end smallexample | |
3821 | ||
3822 | The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}. | |
3823 | The linker will iterate over the list of symbols at the link time and | |
3824 | demangle them according to @samp{lang} before matching them to the | |
3825 | patterns specified in @samp{version-script-commands}. | |
3826 | ||
252b5132 RH |
3827 | @node Expressions |
3828 | @section Expressions in Linker Scripts | |
3829 | @cindex expressions | |
3830 | @cindex arithmetic | |
3831 | The syntax for expressions in the linker script language is identical to | |
3832 | that of C expressions. All expressions are evaluated as integers. All | |
3833 | expressions are evaluated in the same size, which is 32 bits if both the | |
3834 | host and target are 32 bits, and is otherwise 64 bits. | |
3835 | ||
3836 | You can use and set symbol values in expressions. | |
3837 | ||
3838 | The linker defines several special purpose builtin functions for use in | |
3839 | expressions. | |
3840 | ||
3841 | @menu | |
3842 | * Constants:: Constants | |
3843 | * Symbols:: Symbol Names | |
3844 | * Location Counter:: The Location Counter | |
3845 | * Operators:: Operators | |
3846 | * Evaluation:: Evaluation | |
3847 | * Expression Section:: The Section of an Expression | |
3848 | * Builtin Functions:: Builtin Functions | |
3849 | @end menu | |
3850 | ||
3851 | @node Constants | |
3852 | @subsection Constants | |
3853 | @cindex integer notation | |
3854 | @cindex constants in linker scripts | |
3855 | All constants are integers. | |
3856 | ||
3857 | As in C, the linker considers an integer beginning with @samp{0} to be | |
3858 | octal, and an integer beginning with @samp{0x} or @samp{0X} to be | |
3859 | hexadecimal. The linker considers other integers to be decimal. | |
3860 | ||
3861 | @cindex scaled integers | |
3862 | @cindex K and M integer suffixes | |
3863 | @cindex M and K integer suffixes | |
3864 | @cindex suffixes for integers | |
3865 | @cindex integer suffixes | |
3866 | In addition, you can use the suffixes @code{K} and @code{M} to scale a | |
3867 | constant by | |
3868 | @c TEXI2ROFF-KILL | |
3869 | @ifinfo | |
3870 | @c END TEXI2ROFF-KILL | |
3871 | @code{1024} or @code{1024*1024} | |
3872 | @c TEXI2ROFF-KILL | |
3873 | @end ifinfo | |
3874 | @tex | |
3875 | ${\rm 1024}$ or ${\rm 1024}^2$ | |
3876 | @end tex | |
3877 | @c END TEXI2ROFF-KILL | |
3878 | respectively. For example, the following all refer to the same quantity: | |
3879 | @smallexample | |
3880 | _fourk_1 = 4K; | |
3881 | _fourk_2 = 4096; | |
3882 | _fourk_3 = 0x1000; | |
3883 | @end smallexample | |
3884 | ||
3885 | @node Symbols | |
3886 | @subsection Symbol Names | |
3887 | @cindex symbol names | |
3888 | @cindex names | |
3889 | @cindex quoted symbol names | |
3890 | @kindex " | |
3891 | Unless quoted, symbol names start with a letter, underscore, or period | |
3892 | and may include letters, digits, underscores, periods, and hyphens. | |
3893 | Unquoted symbol names must not conflict with any keywords. You can | |
3894 | specify a symbol which contains odd characters or has the same name as a | |
3895 | keyword by surrounding the symbol name in double quotes: | |
3896 | @smallexample | |
3897 | "SECTION" = 9; | |
3898 | "with a space" = "also with a space" + 10; | |
3899 | @end smallexample | |
3900 | ||
3901 | Since symbols can contain many non-alphabetic characters, it is safest | |
3902 | to delimit symbols with spaces. For example, @samp{A-B} is one symbol, | |
3903 | whereas @samp{A - B} is an expression involving subtraction. | |
3904 | ||
3905 | @node Location Counter | |
3906 | @subsection The Location Counter | |
3907 | @kindex . | |
3908 | @cindex dot | |
3909 | @cindex location counter | |
3910 | @cindex current output location | |
3911 | The special linker variable @dfn{dot} @samp{.} always contains the | |
3912 | current output location counter. Since the @code{.} always refers to a | |
3913 | location in an output section, it may only appear in an expression | |
3914 | within a @code{SECTIONS} command. The @code{.} symbol may appear | |
3915 | anywhere that an ordinary symbol is allowed in an expression. | |
3916 | ||
3917 | @cindex holes | |
3918 | Assigning a value to @code{.} will cause the location counter to be | |
3919 | moved. This may be used to create holes in the output section. The | |
3920 | location counter may never be moved backwards. | |
3921 | ||
3922 | @smallexample | |
3923 | SECTIONS | |
3924 | @{ | |
3925 | output : | |
3926 | @{ | |
3927 | file1(.text) | |
3928 | . = . + 1000; | |
3929 | file2(.text) | |
3930 | . += 1000; | |
3931 | file3(.text) | |
563e308f | 3932 | @} = 0x12345678; |
252b5132 RH |
3933 | @} |
3934 | @end smallexample | |
3935 | @noindent | |
3936 | In the previous example, the @samp{.text} section from @file{file1} is | |
3937 | located at the beginning of the output section @samp{output}. It is | |
3938 | followed by a 1000 byte gap. Then the @samp{.text} section from | |
3939 | @file{file2} appears, also with a 1000 byte gap following before the | |
563e308f | 3940 | @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678} |
252b5132 RH |
3941 | specifies what data to write in the gaps (@pxref{Output Section Fill}). |
3942 | ||
5c6bbab8 NC |
3943 | @cindex dot inside sections |
3944 | Note: @code{.} actually refers to the byte offset from the start of the | |
3945 | current containing object. Normally this is the @code{SECTIONS} | |
3946 | statement, whoes start address is 0, hence @code{.} can be used as an | |
3947 | absolute address. If @code{.} is used inside a section description | |
3948 | however, it refers to the byte offset from the start of that section, | |
3949 | not an absolute address. Thus in a script like this: | |
3950 | ||
3951 | @smallexample | |
3952 | SECTIONS | |
3953 | @{ | |
3954 | . = 0x100 | |
3955 | .text: @{ | |
3956 | *(.text) | |
3957 | . = 0x200 | |
3958 | @} | |
3959 | . = 0x500 | |
3960 | .data: @{ | |
3961 | *(.data) | |
3962 | . += 0x600 | |
3963 | @} | |
3964 | @} | |
3965 | @end smallexample | |
3966 | ||
3967 | The @samp{.text} section will be assigned a starting address of 0x100 | |
3968 | and a size of exactly 0x200 bytes, even if there is not enough data in | |
3969 | the @samp{.text} input sections to fill this area. (If there is too | |
3970 | much data, an error will be produced because this would be an attempt to | |
3971 | move @code{.} backwards). The @samp{.data} section will start at 0x500 | |
3972 | and it will have an extra 0x600 bytes worth of space after the end of | |
3973 | the values from the @samp{.data} input sections and before the end of | |
3974 | the @samp{.data} output section itself. | |
3975 | ||
252b5132 RH |
3976 | @need 2000 |
3977 | @node Operators | |
3978 | @subsection Operators | |
3979 | @cindex operators for arithmetic | |
3980 | @cindex arithmetic operators | |
3981 | @cindex precedence in expressions | |
3982 | The linker recognizes the standard C set of arithmetic operators, with | |
3983 | the standard bindings and precedence levels: | |
3984 | @c TEXI2ROFF-KILL | |
3985 | @ifinfo | |
3986 | @c END TEXI2ROFF-KILL | |
3987 | @smallexample | |
3988 | precedence associativity Operators Notes | |
3989 | (highest) | |
3990 | 1 left ! - ~ (1) | |
3991 | 2 left * / % | |
3992 | 3 left + - | |
3993 | 4 left >> << | |
3994 | 5 left == != > < <= >= | |
3995 | 6 left & | |
3996 | 7 left | | |
3997 | 8 left && | |
3998 | 9 left || | |
3999 | 10 right ? : | |
4000 | 11 right &= += -= *= /= (2) | |
4001 | (lowest) | |
4002 | @end smallexample | |
4003 | Notes: | |
a1ab1d2a | 4004 | (1) Prefix operators |
252b5132 RH |
4005 | (2) @xref{Assignments}. |
4006 | @c TEXI2ROFF-KILL | |
4007 | @end ifinfo | |
4008 | @tex | |
4009 | \vskip \baselineskip | |
4010 | %"lispnarrowing" is the extra indent used generally for smallexample | |
4011 | \hskip\lispnarrowing\vbox{\offinterlineskip | |
4012 | \hrule | |
4013 | \halign | |
4014 | {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr | |
4015 | height2pt&\omit&&\omit&&\omit&\cr | |
4016 | &Precedence&& Associativity &&{\rm Operators}&\cr | |
4017 | height2pt&\omit&&\omit&&\omit&\cr | |
4018 | \noalign{\hrule} | |
4019 | height2pt&\omit&&\omit&&\omit&\cr | |
4020 | &highest&&&&&\cr | |
4021 | % '176 is tilde, '~' in tt font | |
a1ab1d2a | 4022 | &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr |
252b5132 RH |
4023 | &2&&left&&* / \%&\cr |
4024 | &3&&left&&+ -&\cr | |
4025 | &4&&left&&>> <<&\cr | |
4026 | &5&&left&&== != > < <= >=&\cr | |
4027 | &6&&left&&\&&\cr | |
4028 | &7&&left&&|&\cr | |
4029 | &8&&left&&{\&\&}&\cr | |
4030 | &9&&left&&||&\cr | |
4031 | &10&&right&&? :&\cr | |
4032 | &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr | |
4033 | &lowest&&&&&\cr | |
4034 | height2pt&\omit&&\omit&&\omit&\cr} | |
4035 | \hrule} | |
4036 | @end tex | |
4037 | @iftex | |
4038 | { | |
4039 | @obeylines@parskip=0pt@parindent=0pt | |
4040 | @dag@quad Prefix operators. | |
4041 | @ddag@quad @xref{Assignments}. | |
4042 | } | |
4043 | @end iftex | |
4044 | @c END TEXI2ROFF-KILL | |
4045 | ||
4046 | @node Evaluation | |
4047 | @subsection Evaluation | |
4048 | @cindex lazy evaluation | |
4049 | @cindex expression evaluation order | |
4050 | The linker evaluates expressions lazily. It only computes the value of | |
4051 | an expression when absolutely necessary. | |
4052 | ||
4053 | The linker needs some information, such as the value of the start | |
4054 | address of the first section, and the origins and lengths of memory | |
4055 | regions, in order to do any linking at all. These values are computed | |
4056 | as soon as possible when the linker reads in the linker script. | |
4057 | ||
4058 | However, other values (such as symbol values) are not known or needed | |
4059 | until after storage allocation. Such values are evaluated later, when | |
4060 | other information (such as the sizes of output sections) is available | |
4061 | for use in the symbol assignment expression. | |
4062 | ||
4063 | The sizes of sections cannot be known until after allocation, so | |
4064 | assignments dependent upon these are not performed until after | |
4065 | allocation. | |
4066 | ||
4067 | Some expressions, such as those depending upon the location counter | |
4068 | @samp{.}, must be evaluated during section allocation. | |
4069 | ||
4070 | If the result of an expression is required, but the value is not | |
4071 | available, then an error results. For example, a script like the | |
4072 | following | |
4073 | @smallexample | |
4074 | @group | |
4075 | SECTIONS | |
4076 | @{ | |
a1ab1d2a | 4077 | .text 9+this_isnt_constant : |
252b5132 RH |
4078 | @{ *(.text) @} |
4079 | @} | |
4080 | @end group | |
4081 | @end smallexample | |
4082 | @noindent | |
4083 | will cause the error message @samp{non constant expression for initial | |
4084 | address}. | |
4085 | ||
4086 | @node Expression Section | |
4087 | @subsection The Section of an Expression | |
4088 | @cindex expression sections | |
4089 | @cindex absolute expressions | |
4090 | @cindex relative expressions | |
4091 | @cindex absolute and relocatable symbols | |
4092 | @cindex relocatable and absolute symbols | |
4093 | @cindex symbols, relocatable and absolute | |
4094 | When the linker evaluates an expression, the result is either absolute | |
4095 | or relative to some section. A relative expression is expressed as a | |
4096 | fixed offset from the base of a section. | |
4097 | ||
4098 | The position of the expression within the linker script determines | |
4099 | whether it is absolute or relative. An expression which appears within | |
4100 | an output section definition is relative to the base of the output | |
4101 | section. An expression which appears elsewhere will be absolute. | |
4102 | ||
4103 | A symbol set to a relative expression will be relocatable if you request | |
4104 | relocatable output using the @samp{-r} option. That means that a | |
4105 | further link operation may change the value of the symbol. The symbol's | |
4106 | section will be the section of the relative expression. | |
4107 | ||
4108 | A symbol set to an absolute expression will retain the same value | |
4109 | through any further link operation. The symbol will be absolute, and | |
4110 | will not have any particular associated section. | |
4111 | ||
4112 | You can use the builtin function @code{ABSOLUTE} to force an expression | |
4113 | to be absolute when it would otherwise be relative. For example, to | |
4114 | create an absolute symbol set to the address of the end of the output | |
4115 | section @samp{.data}: | |
4116 | @smallexample | |
4117 | SECTIONS | |
4118 | @{ | |
4119 | .data : @{ *(.data) _edata = ABSOLUTE(.); @} | |
4120 | @} | |
4121 | @end smallexample | |
4122 | @noindent | |
4123 | If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the | |
4124 | @samp{.data} section. | |
4125 | ||
4126 | @node Builtin Functions | |
4127 | @subsection Builtin Functions | |
4128 | @cindex functions in expressions | |
4129 | The linker script language includes a number of builtin functions for | |
4130 | use in linker script expressions. | |
4131 | ||
4132 | @table @code | |
4133 | @item ABSOLUTE(@var{exp}) | |
4134 | @kindex ABSOLUTE(@var{exp}) | |
4135 | @cindex expression, absolute | |
4136 | Return the absolute (non-relocatable, as opposed to non-negative) value | |
4137 | of the expression @var{exp}. Primarily useful to assign an absolute | |
4138 | value to a symbol within a section definition, where symbol values are | |
4139 | normally section relative. @xref{Expression Section}. | |
4140 | ||
4141 | @item ADDR(@var{section}) | |
4142 | @kindex ADDR(@var{section}) | |
4143 | @cindex section address in expression | |
4144 | Return the absolute address (the VMA) of the named @var{section}. Your | |
4145 | script must previously have defined the location of that section. In | |
4146 | the following example, @code{symbol_1} and @code{symbol_2} are assigned | |
4147 | identical values: | |
4148 | @smallexample | |
4149 | @group | |
4150 | SECTIONS @{ @dots{} | |
4151 | .output1 : | |
a1ab1d2a | 4152 | @{ |
252b5132 RH |
4153 | start_of_output_1 = ABSOLUTE(.); |
4154 | @dots{} | |
4155 | @} | |
4156 | .output : | |
4157 | @{ | |
4158 | symbol_1 = ADDR(.output1); | |
4159 | symbol_2 = start_of_output_1; | |
4160 | @} | |
4161 | @dots{} @} | |
4162 | @end group | |
4163 | @end smallexample | |
4164 | ||
4165 | @item ALIGN(@var{exp}) | |
4166 | @kindex ALIGN(@var{exp}) | |
4167 | @cindex round up location counter | |
4168 | @cindex align location counter | |
4169 | Return the location counter (@code{.}) aligned to the next @var{exp} | |
3c6706bb | 4170 | boundary. |
252b5132 RH |
4171 | @code{ALIGN} doesn't change the value of the location counter---it just |
4172 | does arithmetic on it. Here is an example which aligns the output | |
4173 | @code{.data} section to the next @code{0x2000} byte boundary after the | |
4174 | preceding section and sets a variable within the section to the next | |
4175 | @code{0x8000} boundary after the input sections: | |
4176 | @smallexample | |
4177 | @group | |
4178 | SECTIONS @{ @dots{} | |
4179 | .data ALIGN(0x2000): @{ | |
4180 | *(.data) | |
4181 | variable = ALIGN(0x8000); | |
4182 | @} | |
4183 | @dots{} @} | |
4184 | @end group | |
4185 | @end smallexample | |
4186 | @noindent | |
4187 | The first use of @code{ALIGN} in this example specifies the location of | |
4188 | a section because it is used as the optional @var{address} attribute of | |
4189 | a section definition (@pxref{Output Section Address}). The second use | |
4190 | of @code{ALIGN} is used to defines the value of a symbol. | |
4191 | ||
4192 | The builtin function @code{NEXT} is closely related to @code{ALIGN}. | |
4193 | ||
4194 | @item BLOCK(@var{exp}) | |
4195 | @kindex BLOCK(@var{exp}) | |
4196 | This is a synonym for @code{ALIGN}, for compatibility with older linker | |
4197 | scripts. It is most often seen when setting the address of an output | |
4198 | section. | |
4199 | ||
2d20f7bf JJ |
4200 | @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) |
4201 | @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) | |
4202 | This is equivalent to either | |
4203 | @smallexample | |
4204 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1))) | |
4205 | @end smallexample | |
4206 | or | |
4207 | @smallexample | |
4208 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - @var{commonpagesize}))) | |
4209 | @end smallexample | |
4210 | @noindent | |
4211 | depending on whether the latter uses fewer @var{commonpagesize} sized pages | |
4212 | for the data segment (area between the result of this expression and | |
4213 | @code{DATA_SEGMENT_END}) than the former or not. | |
4214 | If the latter form is used, it means @var{commonpagesize} bytes of runtime | |
4215 | memory will be saved at the expense of up to @var{commonpagesize} wasted | |
4216 | bytes in the on-disk file. | |
4217 | ||
4218 | This expression can only be used directly in @code{SECTIONS} commands, not in | |
4219 | any output section descriptions and only once in the linker script. | |
4220 | @var{commonpagesize} should be less or equal to @var{maxpagesize} and should | |
4221 | be the system page size the object wants to be optimized for (while still | |
4222 | working on system page sizes up to @var{maxpagesize}). | |
4223 | ||
4224 | @noindent | |
4225 | Example: | |
4226 | @smallexample | |
4227 | . = DATA_SEGMENT_ALIGN(0x10000, 0x2000); | |
4228 | @end smallexample | |
4229 | ||
4230 | @item DATA_SEGMENT_END(@var{exp}) | |
4231 | @kindex DATA_SEGMENT_END(@var{exp}) | |
4232 | This defines the end of data segment for @code{DATA_SEGMENT_ALIGN} | |
4233 | evaluation purposes. | |
4234 | ||
4235 | @smallexample | |
4236 | . = DATA_SEGMENT_END(.); | |
4237 | @end smallexample | |
4238 | ||
252b5132 RH |
4239 | @item DEFINED(@var{symbol}) |
4240 | @kindex DEFINED(@var{symbol}) | |
4241 | @cindex symbol defaults | |
4242 | Return 1 if @var{symbol} is in the linker global symbol table and is | |
4243 | defined, otherwise return 0. You can use this function to provide | |
4244 | default values for symbols. For example, the following script fragment | |
4245 | shows how to set a global symbol @samp{begin} to the first location in | |
4246 | the @samp{.text} section---but if a symbol called @samp{begin} already | |
4247 | existed, its value is preserved: | |
4248 | ||
4249 | @smallexample | |
4250 | @group | |
4251 | SECTIONS @{ @dots{} | |
4252 | .text : @{ | |
4253 | begin = DEFINED(begin) ? begin : . ; | |
4254 | @dots{} | |
4255 | @} | |
4256 | @dots{} | |
4257 | @} | |
4258 | @end group | |
4259 | @end smallexample | |
4260 | ||
4261 | @item LOADADDR(@var{section}) | |
4262 | @kindex LOADADDR(@var{section}) | |
4263 | @cindex section load address in expression | |
4264 | Return the absolute LMA of the named @var{section}. This is normally | |
4265 | the same as @code{ADDR}, but it may be different if the @code{AT} | |
4266 | attribute is used in the output section definition (@pxref{Output | |
4267 | Section LMA}). | |
4268 | ||
4269 | @kindex MAX | |
4270 | @item MAX(@var{exp1}, @var{exp2}) | |
4271 | Returns the maximum of @var{exp1} and @var{exp2}. | |
4272 | ||
4273 | @kindex MIN | |
4274 | @item MIN(@var{exp1}, @var{exp2}) | |
4275 | Returns the minimum of @var{exp1} and @var{exp2}. | |
4276 | ||
4277 | @item NEXT(@var{exp}) | |
4278 | @kindex NEXT(@var{exp}) | |
4279 | @cindex unallocated address, next | |
4280 | Return the next unallocated address that is a multiple of @var{exp}. | |
4281 | This function is closely related to @code{ALIGN(@var{exp})}; unless you | |
4282 | use the @code{MEMORY} command to define discontinuous memory for the | |
4283 | output file, the two functions are equivalent. | |
4284 | ||
4285 | @item SIZEOF(@var{section}) | |
4286 | @kindex SIZEOF(@var{section}) | |
4287 | @cindex section size | |
4288 | Return the size in bytes of the named @var{section}, if that section has | |
4289 | been allocated. If the section has not been allocated when this is | |
4290 | evaluated, the linker will report an error. In the following example, | |
4291 | @code{symbol_1} and @code{symbol_2} are assigned identical values: | |
4292 | @smallexample | |
4293 | @group | |
4294 | SECTIONS@{ @dots{} | |
4295 | .output @{ | |
4296 | .start = . ; | |
4297 | @dots{} | |
4298 | .end = . ; | |
4299 | @} | |
4300 | symbol_1 = .end - .start ; | |
4301 | symbol_2 = SIZEOF(.output); | |
4302 | @dots{} @} | |
4303 | @end group | |
4304 | @end smallexample | |
4305 | ||
4306 | @item SIZEOF_HEADERS | |
4307 | @itemx sizeof_headers | |
4308 | @kindex SIZEOF_HEADERS | |
4309 | @cindex header size | |
4310 | Return the size in bytes of the output file's headers. This is | |
4311 | information which appears at the start of the output file. You can use | |
4312 | this number when setting the start address of the first section, if you | |
4313 | choose, to facilitate paging. | |
4314 | ||
4315 | @cindex not enough room for program headers | |
4316 | @cindex program headers, not enough room | |
4317 | When producing an ELF output file, if the linker script uses the | |
4318 | @code{SIZEOF_HEADERS} builtin function, the linker must compute the | |
4319 | number of program headers before it has determined all the section | |
4320 | addresses and sizes. If the linker later discovers that it needs | |
4321 | additional program headers, it will report an error @samp{not enough | |
4322 | room for program headers}. To avoid this error, you must avoid using | |
4323 | the @code{SIZEOF_HEADERS} function, or you must rework your linker | |
4324 | script to avoid forcing the linker to use additional program headers, or | |
4325 | you must define the program headers yourself using the @code{PHDRS} | |
4326 | command (@pxref{PHDRS}). | |
4327 | @end table | |
4328 | ||
4329 | @node Implicit Linker Scripts | |
4330 | @section Implicit Linker Scripts | |
4331 | @cindex implicit linker scripts | |
4332 | If you specify a linker input file which the linker can not recognize as | |
4333 | an object file or an archive file, it will try to read the file as a | |
4334 | linker script. If the file can not be parsed as a linker script, the | |
4335 | linker will report an error. | |
4336 | ||
4337 | An implicit linker script will not replace the default linker script. | |
4338 | ||
4339 | Typically an implicit linker script would contain only symbol | |
4340 | assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION} | |
4341 | commands. | |
4342 | ||
4343 | Any input files read because of an implicit linker script will be read | |
4344 | at the position in the command line where the implicit linker script was | |
4345 | read. This can affect archive searching. | |
4346 | ||
4347 | @ifset GENERIC | |
4348 | @node Machine Dependent | |
4349 | @chapter Machine Dependent Features | |
4350 | ||
4351 | @cindex machine dependencies | |
ff5dcc92 SC |
4352 | @command{ld} has additional features on some platforms; the following |
4353 | sections describe them. Machines where @command{ld} has no additional | |
252b5132 RH |
4354 | functionality are not listed. |
4355 | ||
4356 | @menu | |
4357 | * H8/300:: @code{ld} and the H8/300 | |
4358 | * i960:: @code{ld} and the Intel 960 family | |
4359 | * ARM:: @code{ld} and the ARM family | |
47d89dba | 4360 | * HPPA ELF32:: @code{ld} and HPPA 32-bit ELF |
3c3bdf30 NC |
4361 | @ifset MMIX |
4362 | * MMIX:: @code{ld} and MMIX | |
4363 | @end ifset | |
74459f0e | 4364 | @ifset TICOFF |
ff5dcc92 | 4365 | * TI COFF:: @command{ld} and TI COFF |
74459f0e | 4366 | @end ifset |
252b5132 RH |
4367 | @end menu |
4368 | @end ifset | |
4369 | ||
4370 | @c FIXME! This could use @raisesections/@lowersections, but there seems to be a conflict | |
4371 | @c between those and node-defaulting. | |
4372 | @ifset H8300 | |
4373 | @ifclear GENERIC | |
4374 | @raisesections | |
4375 | @end ifclear | |
4376 | ||
4377 | @node H8/300 | |
ff5dcc92 | 4378 | @section @command{ld} and the H8/300 |
252b5132 RH |
4379 | |
4380 | @cindex H8/300 support | |
ff5dcc92 | 4381 | For the H8/300, @command{ld} can perform these global optimizations when |
252b5132 RH |
4382 | you specify the @samp{--relax} command-line option. |
4383 | ||
4384 | @table @emph | |
4385 | @cindex relaxing on H8/300 | |
4386 | @item relaxing address modes | |
ff5dcc92 | 4387 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose |
252b5132 RH |
4388 | targets are within eight bits, and turns them into eight-bit |
4389 | program-counter relative @code{bsr} and @code{bra} instructions, | |
4390 | respectively. | |
4391 | ||
4392 | @cindex synthesizing on H8/300 | |
4393 | @item synthesizing instructions | |
4394 | @c FIXME: specifically mov.b, or any mov instructions really? | |
ff5dcc92 | 4395 | @command{ld} finds all @code{mov.b} instructions which use the |
252b5132 RH |
4396 | sixteen-bit absolute address form, but refer to the top |
4397 | page of memory, and changes them to use the eight-bit address form. | |
4398 | (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into | |
4399 | @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the | |
4400 | top page of memory). | |
4401 | @end table | |
4402 | ||
4403 | @ifclear GENERIC | |
4404 | @lowersections | |
4405 | @end ifclear | |
4406 | @end ifset | |
4407 | ||
4408 | @ifclear GENERIC | |
4409 | @ifset Hitachi | |
4410 | @c This stuff is pointless to say unless you're especially concerned | |
4411 | @c with Hitachi chips; don't enable it for generic case, please. | |
4412 | @node Hitachi | |
ff5dcc92 | 4413 | @chapter @command{ld} and other Hitachi chips |
252b5132 | 4414 | |
ff5dcc92 | 4415 | @command{ld} also supports the H8/300H, the H8/500, and the Hitachi SH. No |
252b5132 RH |
4416 | special features, commands, or command-line options are required for |
4417 | these chips. | |
4418 | @end ifset | |
4419 | @end ifclear | |
4420 | ||
4421 | @ifset I960 | |
4422 | @ifclear GENERIC | |
4423 | @raisesections | |
4424 | @end ifclear | |
4425 | ||
4426 | @node i960 | |
ff5dcc92 | 4427 | @section @command{ld} and the Intel 960 family |
252b5132 RH |
4428 | |
4429 | @cindex i960 support | |
4430 | ||
4431 | You can use the @samp{-A@var{architecture}} command line option to | |
4432 | specify one of the two-letter names identifying members of the 960 | |
4433 | family; the option specifies the desired output target, and warns of any | |
4434 | incompatible instructions in the input files. It also modifies the | |
4435 | linker's search strategy for archive libraries, to support the use of | |
4436 | libraries specific to each particular architecture, by including in the | |
4437 | search loop names suffixed with the string identifying the architecture. | |
4438 | ||
ff5dcc92 | 4439 | For example, if your @command{ld} command line included @w{@samp{-ACA}} as |
252b5132 RH |
4440 | well as @w{@samp{-ltry}}, the linker would look (in its built-in search |
4441 | paths, and in any paths you specify with @samp{-L}) for a library with | |
4442 | the names | |
4443 | ||
4444 | @smallexample | |
4445 | @group | |
4446 | try | |
4447 | libtry.a | |
4448 | tryca | |
4449 | libtryca.a | |
4450 | @end group | |
4451 | @end smallexample | |
4452 | ||
4453 | @noindent | |
4454 | The first two possibilities would be considered in any event; the last | |
4455 | two are due to the use of @w{@samp{-ACA}}. | |
4456 | ||
4457 | You can meaningfully use @samp{-A} more than once on a command line, since | |
4458 | the 960 architecture family allows combination of target architectures; each | |
4459 | use will add another pair of name variants to search for when @w{@samp{-l}} | |
4460 | specifies a library. | |
4461 | ||
ff5dcc92 | 4462 | @cindex @option{--relax} on i960 |
252b5132 | 4463 | @cindex relaxing on i960 |
ff5dcc92 SC |
4464 | @command{ld} supports the @samp{--relax} option for the i960 family. If |
4465 | you specify @samp{--relax}, @command{ld} finds all @code{balx} and | |
252b5132 RH |
4466 | @code{calx} instructions whose targets are within 24 bits, and turns |
4467 | them into 24-bit program-counter relative @code{bal} and @code{cal} | |
ff5dcc92 | 4468 | instructions, respectively. @command{ld} also turns @code{cal} |
252b5132 RH |
4469 | instructions into @code{bal} instructions when it determines that the |
4470 | target subroutine is a leaf routine (that is, the target subroutine does | |
4471 | not itself call any subroutines). | |
4472 | ||
4473 | @ifclear GENERIC | |
4474 | @lowersections | |
4475 | @end ifclear | |
4476 | @end ifset | |
4477 | ||
4478 | @ifclear GENERIC | |
4479 | @raisesections | |
4480 | @end ifclear | |
4481 | ||
4482 | @node ARM | |
ff5dcc92 | 4483 | @section @command{ld}'s support for interworking between ARM and Thumb code |
252b5132 RH |
4484 | |
4485 | @cindex ARM interworking support | |
6f798e5c | 4486 | @kindex --support-old-code |
ff5dcc92 | 4487 | For the ARM, @command{ld} will generate code stubs to allow functions calls |
252b5132 RH |
4488 | betweem ARM and Thumb code. These stubs only work with code that has |
4489 | been compiled and assembled with the @samp{-mthumb-interwork} command | |
4490 | line option. If it is necessary to link with old ARM object files or | |
4491 | libraries, which have not been compiled with the -mthumb-interwork | |
4492 | option then the @samp{--support-old-code} command line switch should be | |
4493 | given to the linker. This will make it generate larger stub functions | |
4494 | which will work with non-interworking aware ARM code. Note, however, | |
4495 | the linker does not support generating stubs for function calls to | |
4496 | non-interworking aware Thumb code. | |
4497 | ||
6f798e5c NC |
4498 | @cindex thumb entry point |
4499 | @cindex entry point, thumb | |
4500 | @kindex --thumb-entry=@var{entry} | |
4501 | The @samp{--thumb-entry} switch is a duplicate of the generic | |
a1ab1d2a | 4502 | @samp{--entry} switch, in that it sets the program's starting address. |
6f798e5c NC |
4503 | But it also sets the bottom bit of the address, so that it can be |
4504 | branched to using a BX instruction, and the program will start | |
4505 | executing in Thumb mode straight away. | |
4506 | ||
47d89dba | 4507 | @node HPPA ELF32 |
ff5dcc92 | 4508 | @section @command{ld} and HPPA 32-bit ELF support |
47d89dba AM |
4509 | @cindex HPPA multiple sub-space stubs |
4510 | @kindex --multi-subspace | |
ff5dcc92 | 4511 | When generating a shared library, @command{ld} will by default generate |
47d89dba | 4512 | import stubs suitable for use with a single sub-space application. |
ff5dcc92 | 4513 | The @samp{--multi-subspace} switch causes @command{ld} to generate export |
47d89dba AM |
4514 | stubs, and different (larger) import stubs suitable for use with |
4515 | multiple sub-spaces. | |
4516 | ||
4517 | @cindex HPPA stub grouping | |
4518 | @kindex --stub-group-size=@var{N} | |
ff5dcc92 | 4519 | Long branch stubs and import/export stubs are placed by @command{ld} in |
47d89dba AM |
4520 | stub sections located between groups of input sections. |
4521 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
4522 | sections handled by one stub section. Since branch offsets are signed, | |
4523 | a stub section may serve two groups of input sections, one group before | |
4524 | the stub section, and one group after it. However, when using | |
4525 | conditional branches that require stubs, it may be better (for branch | |
4526 | prediction) that stub sections only serve one group of input sections. | |
4527 | A negative value for @samp{N} chooses this scheme, ensuring that | |
4528 | branches to stubs always use a negative offset. Two special values of | |
4529 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
ff5dcc92 | 4530 | @command{ld} to automatically size input section groups for the branch types |
47d89dba AM |
4531 | detected, with the same behaviour regarding stub placement as other |
4532 | positive or negative values of @samp{N} respectively. | |
4533 | ||
4534 | Note that @samp{--stub-group-size} does not split input sections. A | |
4535 | single input section larger than the group size specified will of course | |
4536 | create a larger group (of one section). If input sections are too | |
4537 | large, it may not be possible for a branch to reach its stub. | |
4538 | ||
3c3bdf30 NC |
4539 | @ifset MMIX |
4540 | @node MMIX | |
4541 | @section @code{ld} and MMIX | |
4542 | For MMIX, there is choice of generating @code{ELF} object files or | |
4543 | @code{mmo} object files when linking. The simulator @code{mmix} | |
4544 | understands the @code{mmo} format. The binutils @code{objcopy} utility | |
4545 | can translate between the two formats. | |
4546 | ||
4547 | There is one special section, the @samp{.MMIX.reg_contents} section. | |
4548 | Contents in this section is assumed to correspond to that of global | |
4549 | registers, and symbols referring to it are translated to special symbols, | |
4550 | equal to registers. In a final link, the start address of the | |
4551 | @samp{.MMIX.reg_contents} section corresponds to the first allocated | |
4552 | global register multiplied by 8. Register @code{$255} is not included in | |
4553 | this section; it is always set to the program entry, which is at the | |
4554 | symbol @code{Main} for @code{mmo} files. | |
4555 | ||
4556 | Symbols with the prefix @code{__.MMIX.start.}, for example | |
4557 | @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special; | |
4558 | there must be only one each, even if they are local. The default linker | |
4559 | script uses these to set the default start address of a section. | |
4560 | ||
4561 | Initial and trailing multiples of zero-valued 32-bit words in a section, | |
4562 | are left out from an mmo file. | |
4563 | @end ifset | |
4564 | ||
74459f0e TW |
4565 | @ifset TICOFF |
4566 | @node TI COFF | |
ff5dcc92 | 4567 | @section @command{ld}'s support for various TI COFF versions |
74459f0e TW |
4568 | @cindex TI COFF versions |
4569 | @kindex --format=@var{version} | |
4570 | The @samp{--format} switch allows selection of one of the various | |
4571 | TI COFF versions. The latest of this writing is 2; versions 0 and 1 are | |
4572 | also supported. The TI COFF versions also vary in header byte-order | |
ff5dcc92 | 4573 | format; @command{ld} will read any version or byte order, but the output |
74459f0e TW |
4574 | header format depends on the default specified by the specific target. |
4575 | @end ifset | |
4576 | ||
252b5132 RH |
4577 | @ifclear GENERIC |
4578 | @lowersections | |
4579 | @end ifclear | |
4580 | ||
4581 | @ifclear SingleFormat | |
4582 | @node BFD | |
4583 | @chapter BFD | |
4584 | ||
4585 | @cindex back end | |
4586 | @cindex object file management | |
4587 | @cindex object formats available | |
4588 | @kindex objdump -i | |
4589 | The linker accesses object and archive files using the BFD libraries. | |
4590 | These libraries allow the linker to use the same routines to operate on | |
4591 | object files whatever the object file format. A different object file | |
4592 | format can be supported simply by creating a new BFD back end and adding | |
4593 | it to the library. To conserve runtime memory, however, the linker and | |
4594 | associated tools are usually configured to support only a subset of the | |
4595 | object file formats available. You can use @code{objdump -i} | |
4596 | (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to | |
4597 | list all the formats available for your configuration. | |
4598 | ||
4599 | @cindex BFD requirements | |
4600 | @cindex requirements for BFD | |
4601 | As with most implementations, BFD is a compromise between | |
4602 | several conflicting requirements. The major factor influencing | |
4603 | BFD design was efficiency: any time used converting between | |
4604 | formats is time which would not have been spent had BFD not | |
4605 | been involved. This is partly offset by abstraction payback; since | |
4606 | BFD simplifies applications and back ends, more time and care | |
4607 | may be spent optimizing algorithms for a greater speed. | |
4608 | ||
4609 | One minor artifact of the BFD solution which you should bear in | |
4610 | mind is the potential for information loss. There are two places where | |
4611 | useful information can be lost using the BFD mechanism: during | |
4612 | conversion and during output. @xref{BFD information loss}. | |
4613 | ||
4614 | @menu | |
4615 | * BFD outline:: How it works: an outline of BFD | |
4616 | @end menu | |
4617 | ||
4618 | @node BFD outline | |
4619 | @section How it works: an outline of BFD | |
4620 | @cindex opening object files | |
4621 | @include bfdsumm.texi | |
4622 | @end ifclear | |
4623 | ||
4624 | @node Reporting Bugs | |
4625 | @chapter Reporting Bugs | |
ff5dcc92 SC |
4626 | @cindex bugs in @command{ld} |
4627 | @cindex reporting bugs in @command{ld} | |
252b5132 | 4628 | |
ff5dcc92 | 4629 | Your bug reports play an essential role in making @command{ld} reliable. |
252b5132 RH |
4630 | |
4631 | Reporting a bug may help you by bringing a solution to your problem, or | |
4632 | it may not. But in any case the principal function of a bug report is | |
ff5dcc92 | 4633 | to help the entire community by making the next version of @command{ld} |
252b5132 | 4634 | work better. Bug reports are your contribution to the maintenance of |
ff5dcc92 | 4635 | @command{ld}. |
252b5132 RH |
4636 | |
4637 | In order for a bug report to serve its purpose, you must include the | |
4638 | information that enables us to fix the bug. | |
4639 | ||
4640 | @menu | |
4641 | * Bug Criteria:: Have you found a bug? | |
4642 | * Bug Reporting:: How to report bugs | |
4643 | @end menu | |
4644 | ||
4645 | @node Bug Criteria | |
4646 | @section Have you found a bug? | |
4647 | @cindex bug criteria | |
4648 | ||
4649 | If you are not sure whether you have found a bug, here are some guidelines: | |
4650 | ||
4651 | @itemize @bullet | |
4652 | @cindex fatal signal | |
4653 | @cindex linker crash | |
4654 | @cindex crash of linker | |
4655 | @item | |
4656 | If the linker gets a fatal signal, for any input whatever, that is a | |
ff5dcc92 | 4657 | @command{ld} bug. Reliable linkers never crash. |
252b5132 RH |
4658 | |
4659 | @cindex error on valid input | |
4660 | @item | |
ff5dcc92 | 4661 | If @command{ld} produces an error message for valid input, that is a bug. |
252b5132 RH |
4662 | |
4663 | @cindex invalid input | |
4664 | @item | |
ff5dcc92 | 4665 | If @command{ld} does not produce an error message for invalid input, that |
252b5132 RH |
4666 | may be a bug. In the general case, the linker can not verify that |
4667 | object files are correct. | |
4668 | ||
4669 | @item | |
4670 | If you are an experienced user of linkers, your suggestions for | |
ff5dcc92 | 4671 | improvement of @command{ld} are welcome in any case. |
252b5132 RH |
4672 | @end itemize |
4673 | ||
4674 | @node Bug Reporting | |
4675 | @section How to report bugs | |
4676 | @cindex bug reports | |
ff5dcc92 | 4677 | @cindex @command{ld} bugs, reporting |
252b5132 RH |
4678 | |
4679 | A number of companies and individuals offer support for @sc{gnu} | |
ff5dcc92 | 4680 | products. If you obtained @command{ld} from a support organization, we |
252b5132 RH |
4681 | recommend you contact that organization first. |
4682 | ||
4683 | You can find contact information for many support companies and | |
4684 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
4685 | distribution. | |
4686 | ||
ff5dcc92 | 4687 | Otherwise, send bug reports for @command{ld} to |
d7ed7ca6 | 4688 | @samp{bug-binutils@@gnu.org}. |
252b5132 RH |
4689 | |
4690 | The fundamental principle of reporting bugs usefully is this: | |
4691 | @strong{report all the facts}. If you are not sure whether to state a | |
4692 | fact or leave it out, state it! | |
4693 | ||
4694 | Often people omit facts because they think they know what causes the | |
4695 | problem and assume that some details do not matter. Thus, you might | |
b553b183 NC |
4696 | assume that the name of a symbol you use in an example does not |
4697 | matter. Well, probably it does not, but one cannot be sure. Perhaps | |
4698 | the bug is a stray memory reference which happens to fetch from the | |
4699 | location where that name is stored in memory; perhaps, if the name | |
4700 | were different, the contents of that location would fool the linker | |
4701 | into doing the right thing despite the bug. Play it safe and give a | |
4702 | specific, complete example. That is the easiest thing for you to do, | |
4703 | and the most helpful. | |
4704 | ||
4705 | Keep in mind that the purpose of a bug report is to enable us to fix | |
4706 | the bug if it is new to us. Therefore, always write your bug reports | |
4707 | on the assumption that the bug has not been reported previously. | |
252b5132 RH |
4708 | |
4709 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
4710 | bell?'' Those bug reports are useless, and we urge everyone to | |
4711 | @emph{refuse to respond to them} except to chide the sender to report | |
4712 | bugs properly. | |
4713 | ||
4714 | To enable us to fix the bug, you should include all these things: | |
4715 | ||
4716 | @itemize @bullet | |
4717 | @item | |
ff5dcc92 | 4718 | The version of @command{ld}. @command{ld} announces it if you start it with |
252b5132 RH |
4719 | the @samp{--version} argument. |
4720 | ||
4721 | Without this, we will not know whether there is any point in looking for | |
ff5dcc92 | 4722 | the bug in the current version of @command{ld}. |
252b5132 RH |
4723 | |
4724 | @item | |
ff5dcc92 | 4725 | Any patches you may have applied to the @command{ld} source, including any |
252b5132 RH |
4726 | patches made to the @code{BFD} library. |
4727 | ||
4728 | @item | |
4729 | The type of machine you are using, and the operating system name and | |
4730 | version number. | |
4731 | ||
4732 | @item | |
ff5dcc92 | 4733 | What compiler (and its version) was used to compile @command{ld}---e.g. |
252b5132 RH |
4734 | ``@code{gcc-2.7}''. |
4735 | ||
4736 | @item | |
4737 | The command arguments you gave the linker to link your example and | |
4738 | observe the bug. To guarantee you will not omit something important, | |
4739 | list them all. A copy of the Makefile (or the output from make) is | |
4740 | sufficient. | |
4741 | ||
4742 | If we were to try to guess the arguments, we would probably guess wrong | |
4743 | and then we might not encounter the bug. | |
4744 | ||
4745 | @item | |
4746 | A complete input file, or set of input files, that will reproduce the | |
b553b183 NC |
4747 | bug. It is generally most helpful to send the actual object files |
4748 | provided that they are reasonably small. Say no more than 10K. For | |
4749 | bigger files you can either make them available by FTP or HTTP or else | |
4750 | state that you are willing to send the object file(s) to whomever | |
4751 | requests them. (Note - your email will be going to a mailing list, so | |
4752 | we do not want to clog it up with large attachments). But small | |
4753 | attachments are best. | |
252b5132 RH |
4754 | |
4755 | If the source files were assembled using @code{gas} or compiled using | |
4756 | @code{gcc}, then it may be OK to send the source files rather than the | |
4757 | object files. In this case, be sure to say exactly what version of | |
4758 | @code{gas} or @code{gcc} was used to produce the object files. Also say | |
4759 | how @code{gas} or @code{gcc} were configured. | |
4760 | ||
4761 | @item | |
4762 | A description of what behavior you observe that you believe is | |
4763 | incorrect. For example, ``It gets a fatal signal.'' | |
4764 | ||
ff5dcc92 | 4765 | Of course, if the bug is that @command{ld} gets a fatal signal, then we |
252b5132 RH |
4766 | will certainly notice it. But if the bug is incorrect output, we might |
4767 | not notice unless it is glaringly wrong. You might as well not give us | |
4768 | a chance to make a mistake. | |
4769 | ||
4770 | Even if the problem you experience is a fatal signal, you should still | |
4771 | say so explicitly. Suppose something strange is going on, such as, your | |
ff5dcc92 | 4772 | copy of @command{ld} is out of synch, or you have encountered a bug in the |
252b5132 RH |
4773 | C library on your system. (This has happened!) Your copy might crash |
4774 | and ours would not. If you told us to expect a crash, then when ours | |
4775 | fails to crash, we would know that the bug was not happening for us. If | |
4776 | you had not told us to expect a crash, then we would not be able to draw | |
4777 | any conclusion from our observations. | |
4778 | ||
4779 | @item | |
ff5dcc92 | 4780 | If you wish to suggest changes to the @command{ld} source, send us context |
252b5132 RH |
4781 | diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or |
4782 | @samp{-p} option. Always send diffs from the old file to the new file. | |
ff5dcc92 | 4783 | If you even discuss something in the @command{ld} source, refer to it by |
252b5132 RH |
4784 | context, not by line number. |
4785 | ||
4786 | The line numbers in our development sources will not match those in your | |
4787 | sources. Your line numbers would convey no useful information to us. | |
4788 | @end itemize | |
4789 | ||
4790 | Here are some things that are not necessary: | |
4791 | ||
4792 | @itemize @bullet | |
4793 | @item | |
4794 | A description of the envelope of the bug. | |
4795 | ||
4796 | Often people who encounter a bug spend a lot of time investigating | |
4797 | which changes to the input file will make the bug go away and which | |
4798 | changes will not affect it. | |
4799 | ||
4800 | This is often time consuming and not very useful, because the way we | |
4801 | will find the bug is by running a single example under the debugger | |
4802 | with breakpoints, not by pure deduction from a series of examples. | |
4803 | We recommend that you save your time for something else. | |
4804 | ||
4805 | Of course, if you can find a simpler example to report @emph{instead} | |
4806 | of the original one, that is a convenience for us. Errors in the | |
4807 | output will be easier to spot, running under the debugger will take | |
4808 | less time, and so on. | |
4809 | ||
4810 | However, simplification is not vital; if you do not want to do this, | |
4811 | report the bug anyway and send us the entire test case you used. | |
4812 | ||
4813 | @item | |
4814 | A patch for the bug. | |
4815 | ||
4816 | A patch for the bug does help us if it is a good one. But do not omit | |
4817 | the necessary information, such as the test case, on the assumption that | |
4818 | a patch is all we need. We might see problems with your patch and decide | |
4819 | to fix the problem another way, or we might not understand it at all. | |
4820 | ||
ff5dcc92 | 4821 | Sometimes with a program as complicated as @command{ld} it is very hard to |
252b5132 RH |
4822 | construct an example that will make the program follow a certain path |
4823 | through the code. If you do not send us the example, we will not be | |
4824 | able to construct one, so we will not be able to verify that the bug is | |
4825 | fixed. | |
4826 | ||
4827 | And if we cannot understand what bug you are trying to fix, or why your | |
4828 | patch should be an improvement, we will not install it. A test case will | |
4829 | help us to understand. | |
4830 | ||
4831 | @item | |
4832 | A guess about what the bug is or what it depends on. | |
4833 | ||
4834 | Such guesses are usually wrong. Even we cannot guess right about such | |
4835 | things without first using the debugger to find the facts. | |
4836 | @end itemize | |
4837 | ||
4838 | @node MRI | |
4839 | @appendix MRI Compatible Script Files | |
4840 | @cindex MRI compatibility | |
ff5dcc92 SC |
4841 | To aid users making the transition to @sc{gnu} @command{ld} from the MRI |
4842 | linker, @command{ld} can use MRI compatible linker scripts as an | |
252b5132 RH |
4843 | alternative to the more general-purpose linker scripting language |
4844 | described in @ref{Scripts}. MRI compatible linker scripts have a much | |
4845 | simpler command set than the scripting language otherwise used with | |
ff5dcc92 | 4846 | @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI |
252b5132 RH |
4847 | linker commands; these commands are described here. |
4848 | ||
4849 | In general, MRI scripts aren't of much use with the @code{a.out} object | |
4850 | file format, since it only has three sections and MRI scripts lack some | |
4851 | features to make use of them. | |
4852 | ||
4853 | You can specify a file containing an MRI-compatible script using the | |
4854 | @samp{-c} command-line option. | |
4855 | ||
4856 | Each command in an MRI-compatible script occupies its own line; each | |
4857 | command line starts with the keyword that identifies the command (though | |
4858 | blank lines are also allowed for punctuation). If a line of an | |
ff5dcc92 | 4859 | MRI-compatible script begins with an unrecognized keyword, @command{ld} |
252b5132 RH |
4860 | issues a warning message, but continues processing the script. |
4861 | ||
4862 | Lines beginning with @samp{*} are comments. | |
4863 | ||
4864 | You can write these commands using all upper-case letters, or all | |
4865 | lower case; for example, @samp{chip} is the same as @samp{CHIP}. | |
4866 | The following list shows only the upper-case form of each command. | |
4867 | ||
4868 | @table @code | |
4869 | @cindex @code{ABSOLUTE} (MRI) | |
4870 | @item ABSOLUTE @var{secname} | |
4871 | @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname} | |
ff5dcc92 | 4872 | Normally, @command{ld} includes in the output file all sections from all |
252b5132 RH |
4873 | the input files. However, in an MRI-compatible script, you can use the |
4874 | @code{ABSOLUTE} command to restrict the sections that will be present in | |
4875 | your output program. If the @code{ABSOLUTE} command is used at all in a | |
4876 | script, then only the sections named explicitly in @code{ABSOLUTE} | |
4877 | commands will appear in the linker output. You can still use other | |
4878 | input sections (whatever you select on the command line, or using | |
4879 | @code{LOAD}) to resolve addresses in the output file. | |
4880 | ||
4881 | @cindex @code{ALIAS} (MRI) | |
4882 | @item ALIAS @var{out-secname}, @var{in-secname} | |
4883 | Use this command to place the data from input section @var{in-secname} | |
4884 | in a section called @var{out-secname} in the linker output file. | |
4885 | ||
4886 | @var{in-secname} may be an integer. | |
4887 | ||
4888 | @cindex @code{ALIGN} (MRI) | |
4889 | @item ALIGN @var{secname} = @var{expression} | |
4890 | Align the section called @var{secname} to @var{expression}. The | |
4891 | @var{expression} should be a power of two. | |
4892 | ||
4893 | @cindex @code{BASE} (MRI) | |
4894 | @item BASE @var{expression} | |
4895 | Use the value of @var{expression} as the lowest address (other than | |
4896 | absolute addresses) in the output file. | |
4897 | ||
4898 | @cindex @code{CHIP} (MRI) | |
4899 | @item CHIP @var{expression} | |
4900 | @itemx CHIP @var{expression}, @var{expression} | |
4901 | This command does nothing; it is accepted only for compatibility. | |
4902 | ||
4903 | @cindex @code{END} (MRI) | |
4904 | @item END | |
4905 | This command does nothing whatever; it's only accepted for compatibility. | |
4906 | ||
4907 | @cindex @code{FORMAT} (MRI) | |
4908 | @item FORMAT @var{output-format} | |
4909 | Similar to the @code{OUTPUT_FORMAT} command in the more general linker | |
a1ab1d2a | 4910 | language, but restricted to one of these output formats: |
252b5132 RH |
4911 | |
4912 | @enumerate | |
a1ab1d2a | 4913 | @item |
252b5132 RH |
4914 | S-records, if @var{output-format} is @samp{S} |
4915 | ||
4916 | @item | |
4917 | IEEE, if @var{output-format} is @samp{IEEE} | |
4918 | ||
4919 | @item | |
4920 | COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is | |
4921 | @samp{COFF} | |
4922 | @end enumerate | |
4923 | ||
4924 | @cindex @code{LIST} (MRI) | |
4925 | @item LIST @var{anything}@dots{} | |
4926 | Print (to the standard output file) a link map, as produced by the | |
ff5dcc92 | 4927 | @command{ld} command-line option @samp{-M}. |
252b5132 RH |
4928 | |
4929 | The keyword @code{LIST} may be followed by anything on the | |
4930 | same line, with no change in its effect. | |
4931 | ||
4932 | @cindex @code{LOAD} (MRI) | |
4933 | @item LOAD @var{filename} | |
4934 | @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename} | |
4935 | Include one or more object file @var{filename} in the link; this has the | |
ff5dcc92 | 4936 | same effect as specifying @var{filename} directly on the @command{ld} |
252b5132 RH |
4937 | command line. |
4938 | ||
4939 | @cindex @code{NAME} (MRI) | |
4940 | @item NAME @var{output-name} | |
ff5dcc92 | 4941 | @var{output-name} is the name for the program produced by @command{ld}; the |
252b5132 RH |
4942 | MRI-compatible command @code{NAME} is equivalent to the command-line |
4943 | option @samp{-o} or the general script language command @code{OUTPUT}. | |
4944 | ||
4945 | @cindex @code{ORDER} (MRI) | |
4946 | @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname} | |
4947 | @itemx ORDER @var{secname} @var{secname} @var{secname} | |
ff5dcc92 | 4948 | Normally, @command{ld} orders the sections in its output file in the |
252b5132 RH |
4949 | order in which they first appear in the input files. In an MRI-compatible |
4950 | script, you can override this ordering with the @code{ORDER} command. The | |
4951 | sections you list with @code{ORDER} will appear first in your output | |
4952 | file, in the order specified. | |
4953 | ||
4954 | @cindex @code{PUBLIC} (MRI) | |
4955 | @item PUBLIC @var{name}=@var{expression} | |
4956 | @itemx PUBLIC @var{name},@var{expression} | |
4957 | @itemx PUBLIC @var{name} @var{expression} | |
4958 | Supply a value (@var{expression}) for external symbol | |
4959 | @var{name} used in the linker input files. | |
4960 | ||
4961 | @cindex @code{SECT} (MRI) | |
4962 | @item SECT @var{secname}, @var{expression} | |
4963 | @itemx SECT @var{secname}=@var{expression} | |
4964 | @itemx SECT @var{secname} @var{expression} | |
4965 | You can use any of these three forms of the @code{SECT} command to | |
4966 | specify the start address (@var{expression}) for section @var{secname}. | |
4967 | If you have more than one @code{SECT} statement for the same | |
4968 | @var{secname}, only the @emph{first} sets the start address. | |
4969 | @end table | |
4970 | ||
704c465c NC |
4971 | @node GNU Free Documentation License |
4972 | @appendix GNU Free Documentation License | |
4973 | @cindex GNU Free Documentation License | |
4974 | ||
4975 | GNU Free Documentation License | |
a1ab1d2a | 4976 | |
704c465c NC |
4977 | Version 1.1, March 2000 |
4978 | ||
4979 | Copyright (C) 2000 Free Software Foundation, Inc. | |
4980 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
a1ab1d2a | 4981 | |
704c465c NC |
4982 | Everyone is permitted to copy and distribute verbatim copies |
4983 | of this license document, but changing it is not allowed. | |
4984 | ||
4985 | ||
4986 | 0. PREAMBLE | |
4987 | ||
4988 | The purpose of this License is to make a manual, textbook, or other | |
4989 | written document "free" in the sense of freedom: to assure everyone | |
4990 | the effective freedom to copy and redistribute it, with or without | |
4991 | modifying it, either commercially or noncommercially. Secondarily, | |
4992 | this License preserves for the author and publisher a way to get | |
4993 | credit for their work, while not being considered responsible for | |
4994 | modifications made by others. | |
4995 | ||
4996 | This License is a kind of "copyleft", which means that derivative | |
4997 | works of the document must themselves be free in the same sense. It | |
4998 | complements the GNU General Public License, which is a copyleft | |
4999 | license designed for free software. | |
5000 | ||
5001 | We have designed this License in order to use it for manuals for free | |
5002 | software, because free software needs free documentation: a free | |
5003 | program should come with manuals providing the same freedoms that the | |
5004 | software does. But this License is not limited to software manuals; | |
5005 | it can be used for any textual work, regardless of subject matter or | |
5006 | whether it is published as a printed book. We recommend this License | |
5007 | principally for works whose purpose is instruction or reference. | |
5008 | ||
5009 | ||
5010 | 1. APPLICABILITY AND DEFINITIONS | |
5011 | ||
5012 | This License applies to any manual or other work that contains a | |
5013 | notice placed by the copyright holder saying it can be distributed | |
5014 | under the terms of this License. The "Document", below, refers to any | |
5015 | such manual or work. Any member of the public is a licensee, and is | |
5016 | addressed as "you". | |
5017 | ||
5018 | A "Modified Version" of the Document means any work containing the | |
5019 | Document or a portion of it, either copied verbatim, or with | |
5020 | modifications and/or translated into another language. | |
5021 | ||
5022 | A "Secondary Section" is a named appendix or a front-matter section of | |
5023 | the Document that deals exclusively with the relationship of the | |
5024 | publishers or authors of the Document to the Document's overall subject | |
5025 | (or to related matters) and contains nothing that could fall directly | |
5026 | within that overall subject. (For example, if the Document is in part a | |
5027 | textbook of mathematics, a Secondary Section may not explain any | |
5028 | mathematics.) The relationship could be a matter of historical | |
5029 | connection with the subject or with related matters, or of legal, | |
5030 | commercial, philosophical, ethical or political position regarding | |
5031 | them. | |
5032 | ||
5033 | The "Invariant Sections" are certain Secondary Sections whose titles | |
5034 | are designated, as being those of Invariant Sections, in the notice | |
5035 | that says that the Document is released under this License. | |
5036 | ||
5037 | The "Cover Texts" are certain short passages of text that are listed, | |
5038 | as Front-Cover Texts or Back-Cover Texts, in the notice that says that | |
5039 | the Document is released under this License. | |
5040 | ||
5041 | A "Transparent" copy of the Document means a machine-readable copy, | |
5042 | represented in a format whose specification is available to the | |
5043 | general public, whose contents can be viewed and edited directly and | |
5044 | straightforwardly with generic text editors or (for images composed of | |
5045 | pixels) generic paint programs or (for drawings) some widely available | |
5046 | drawing editor, and that is suitable for input to text formatters or | |
5047 | for automatic translation to a variety of formats suitable for input | |
5048 | to text formatters. A copy made in an otherwise Transparent file | |
5049 | format whose markup has been designed to thwart or discourage | |
5050 | subsequent modification by readers is not Transparent. A copy that is | |
5051 | not "Transparent" is called "Opaque". | |
5052 | ||
5053 | Examples of suitable formats for Transparent copies include plain | |
5054 | ASCII without markup, Texinfo input format, LaTeX input format, SGML | |
5055 | or XML using a publicly available DTD, and standard-conforming simple | |
5056 | HTML designed for human modification. Opaque formats include | |
5057 | PostScript, PDF, proprietary formats that can be read and edited only | |
5058 | by proprietary word processors, SGML or XML for which the DTD and/or | |
5059 | processing tools are not generally available, and the | |
5060 | machine-generated HTML produced by some word processors for output | |
5061 | purposes only. | |
5062 | ||
5063 | The "Title Page" means, for a printed book, the title page itself, | |
5064 | plus such following pages as are needed to hold, legibly, the material | |
5065 | this License requires to appear in the title page. For works in | |
5066 | formats which do not have any title page as such, "Title Page" means | |
5067 | the text near the most prominent appearance of the work's title, | |
5068 | preceding the beginning of the body of the text. | |
5069 | ||
5070 | ||
5071 | 2. VERBATIM COPYING | |
5072 | ||
5073 | You may copy and distribute the Document in any medium, either | |
5074 | commercially or noncommercially, provided that this License, the | |
5075 | copyright notices, and the license notice saying this License applies | |
5076 | to the Document are reproduced in all copies, and that you add no other | |
5077 | conditions whatsoever to those of this License. You may not use | |
5078 | technical measures to obstruct or control the reading or further | |
5079 | copying of the copies you make or distribute. However, you may accept | |
5080 | compensation in exchange for copies. If you distribute a large enough | |
5081 | number of copies you must also follow the conditions in section 3. | |
5082 | ||
5083 | You may also lend copies, under the same conditions stated above, and | |
5084 | you may publicly display copies. | |
5085 | ||
5086 | ||
5087 | 3. COPYING IN QUANTITY | |
5088 | ||
5089 | If you publish printed copies of the Document numbering more than 100, | |
5090 | and the Document's license notice requires Cover Texts, you must enclose | |
5091 | the copies in covers that carry, clearly and legibly, all these Cover | |
5092 | Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on | |
5093 | the back cover. Both covers must also clearly and legibly identify | |
5094 | you as the publisher of these copies. The front cover must present | |
5095 | the full title with all words of the title equally prominent and | |
5096 | visible. You may add other material on the covers in addition. | |
5097 | Copying with changes limited to the covers, as long as they preserve | |
5098 | the title of the Document and satisfy these conditions, can be treated | |
5099 | as verbatim copying in other respects. | |
5100 | ||
5101 | If the required texts for either cover are too voluminous to fit | |
5102 | legibly, you should put the first ones listed (as many as fit | |
5103 | reasonably) on the actual cover, and continue the rest onto adjacent | |
5104 | pages. | |
5105 | ||
5106 | If you publish or distribute Opaque copies of the Document numbering | |
5107 | more than 100, you must either include a machine-readable Transparent | |
5108 | copy along with each Opaque copy, or state in or with each Opaque copy | |
5109 | a publicly-accessible computer-network location containing a complete | |
5110 | Transparent copy of the Document, free of added material, which the | |
5111 | general network-using public has access to download anonymously at no | |
5112 | charge using public-standard network protocols. If you use the latter | |
5113 | option, you must take reasonably prudent steps, when you begin | |
5114 | distribution of Opaque copies in quantity, to ensure that this | |
5115 | Transparent copy will remain thus accessible at the stated location | |
5116 | until at least one year after the last time you distribute an Opaque | |
5117 | copy (directly or through your agents or retailers) of that edition to | |
5118 | the public. | |
5119 | ||
5120 | It is requested, but not required, that you contact the authors of the | |
5121 | Document well before redistributing any large number of copies, to give | |
5122 | them a chance to provide you with an updated version of the Document. | |
5123 | ||
5124 | ||
5125 | 4. MODIFICATIONS | |
5126 | ||
5127 | You may copy and distribute a Modified Version of the Document under | |
5128 | the conditions of sections 2 and 3 above, provided that you release | |
5129 | the Modified Version under precisely this License, with the Modified | |
5130 | Version filling the role of the Document, thus licensing distribution | |
5131 | and modification of the Modified Version to whoever possesses a copy | |
5132 | of it. In addition, you must do these things in the Modified Version: | |
5133 | ||
5134 | A. Use in the Title Page (and on the covers, if any) a title distinct | |
5135 | from that of the Document, and from those of previous versions | |
5136 | (which should, if there were any, be listed in the History section | |
5137 | of the Document). You may use the same title as a previous version | |
5138 | if the original publisher of that version gives permission. | |
5139 | B. List on the Title Page, as authors, one or more persons or entities | |
5140 | responsible for authorship of the modifications in the Modified | |
5141 | Version, together with at least five of the principal authors of the | |
5142 | Document (all of its principal authors, if it has less than five). | |
5143 | C. State on the Title page the name of the publisher of the | |
5144 | Modified Version, as the publisher. | |
5145 | D. Preserve all the copyright notices of the Document. | |
5146 | E. Add an appropriate copyright notice for your modifications | |
5147 | adjacent to the other copyright notices. | |
5148 | F. Include, immediately after the copyright notices, a license notice | |
5149 | giving the public permission to use the Modified Version under the | |
5150 | terms of this License, in the form shown in the Addendum below. | |
5151 | G. Preserve in that license notice the full lists of Invariant Sections | |
5152 | and required Cover Texts given in the Document's license notice. | |
5153 | H. Include an unaltered copy of this License. | |
5154 | I. Preserve the section entitled "History", and its title, and add to | |
5155 | it an item stating at least the title, year, new authors, and | |
5156 | publisher of the Modified Version as given on the Title Page. If | |
5157 | there is no section entitled "History" in the Document, create one | |
5158 | stating the title, year, authors, and publisher of the Document as | |
5159 | given on its Title Page, then add an item describing the Modified | |
5160 | Version as stated in the previous sentence. | |
5161 | J. Preserve the network location, if any, given in the Document for | |
5162 | public access to a Transparent copy of the Document, and likewise | |
5163 | the network locations given in the Document for previous versions | |
5164 | it was based on. These may be placed in the "History" section. | |
5165 | You may omit a network location for a work that was published at | |
5166 | least four years before the Document itself, or if the original | |
5167 | publisher of the version it refers to gives permission. | |
5168 | K. In any section entitled "Acknowledgements" or "Dedications", | |
5169 | preserve the section's title, and preserve in the section all the | |
5170 | substance and tone of each of the contributor acknowledgements | |
5171 | and/or dedications given therein. | |
5172 | L. Preserve all the Invariant Sections of the Document, | |
5173 | unaltered in their text and in their titles. Section numbers | |
5174 | or the equivalent are not considered part of the section titles. | |
5175 | M. Delete any section entitled "Endorsements". Such a section | |
5176 | may not be included in the Modified Version. | |
5177 | N. Do not retitle any existing section as "Endorsements" | |
5178 | or to conflict in title with any Invariant Section. | |
5179 | ||
5180 | If the Modified Version includes new front-matter sections or | |
5181 | appendices that qualify as Secondary Sections and contain no material | |
5182 | copied from the Document, you may at your option designate some or all | |
5183 | of these sections as invariant. To do this, add their titles to the | |
5184 | list of Invariant Sections in the Modified Version's license notice. | |
5185 | These titles must be distinct from any other section titles. | |
5186 | ||
5187 | You may add a section entitled "Endorsements", provided it contains | |
5188 | nothing but endorsements of your Modified Version by various | |
5189 | parties--for example, statements of peer review or that the text has | |
5190 | been approved by an organization as the authoritative definition of a | |
5191 | standard. | |
5192 | ||
5193 | You may add a passage of up to five words as a Front-Cover Text, and a | |
5194 | passage of up to 25 words as a Back-Cover Text, to the end of the list | |
5195 | of Cover Texts in the Modified Version. Only one passage of | |
5196 | Front-Cover Text and one of Back-Cover Text may be added by (or | |
5197 | through arrangements made by) any one entity. If the Document already | |
5198 | includes a cover text for the same cover, previously added by you or | |
5199 | by arrangement made by the same entity you are acting on behalf of, | |
5200 | you may not add another; but you may replace the old one, on explicit | |
5201 | permission from the previous publisher that added the old one. | |
5202 | ||
5203 | The author(s) and publisher(s) of the Document do not by this License | |
5204 | give permission to use their names for publicity for or to assert or | |
5205 | imply endorsement of any Modified Version. | |
5206 | ||
5207 | ||
5208 | 5. COMBINING DOCUMENTS | |
5209 | ||
5210 | You may combine the Document with other documents released under this | |
5211 | License, under the terms defined in section 4 above for modified | |
5212 | versions, provided that you include in the combination all of the | |
5213 | Invariant Sections of all of the original documents, unmodified, and | |
5214 | list them all as Invariant Sections of your combined work in its | |
5215 | license notice. | |
5216 | ||
5217 | The combined work need only contain one copy of this License, and | |
5218 | multiple identical Invariant Sections may be replaced with a single | |
5219 | copy. If there are multiple Invariant Sections with the same name but | |
5220 | different contents, make the title of each such section unique by | |
5221 | adding at the end of it, in parentheses, the name of the original | |
5222 | author or publisher of that section if known, or else a unique number. | |
5223 | Make the same adjustment to the section titles in the list of | |
5224 | Invariant Sections in the license notice of the combined work. | |
5225 | ||
5226 | In the combination, you must combine any sections entitled "History" | |
5227 | in the various original documents, forming one section entitled | |
5228 | "History"; likewise combine any sections entitled "Acknowledgements", | |
5229 | and any sections entitled "Dedications". You must delete all sections | |
5230 | entitled "Endorsements." | |
5231 | ||
5232 | ||
5233 | 6. COLLECTIONS OF DOCUMENTS | |
5234 | ||
5235 | You may make a collection consisting of the Document and other documents | |
5236 | released under this License, and replace the individual copies of this | |
5237 | License in the various documents with a single copy that is included in | |
5238 | the collection, provided that you follow the rules of this License for | |
5239 | verbatim copying of each of the documents in all other respects. | |
5240 | ||
5241 | You may extract a single document from such a collection, and distribute | |
5242 | it individually under this License, provided you insert a copy of this | |
5243 | License into the extracted document, and follow this License in all | |
5244 | other respects regarding verbatim copying of that document. | |
5245 | ||
5246 | ||
5247 | 7. AGGREGATION WITH INDEPENDENT WORKS | |
5248 | ||
5249 | A compilation of the Document or its derivatives with other separate | |
5250 | and independent documents or works, in or on a volume of a storage or | |
5251 | distribution medium, does not as a whole count as a Modified Version | |
5252 | of the Document, provided no compilation copyright is claimed for the | |
5253 | compilation. Such a compilation is called an "aggregate", and this | |
5254 | License does not apply to the other self-contained works thus compiled | |
5255 | with the Document, on account of their being thus compiled, if they | |
5256 | are not themselves derivative works of the Document. | |
5257 | ||
5258 | If the Cover Text requirement of section 3 is applicable to these | |
5259 | copies of the Document, then if the Document is less than one quarter | |
5260 | of the entire aggregate, the Document's Cover Texts may be placed on | |
5261 | covers that surround only the Document within the aggregate. | |
5262 | Otherwise they must appear on covers around the whole aggregate. | |
5263 | ||
5264 | ||
5265 | 8. TRANSLATION | |
5266 | ||
5267 | Translation is considered a kind of modification, so you may | |
5268 | distribute translations of the Document under the terms of section 4. | |
5269 | Replacing Invariant Sections with translations requires special | |
5270 | permission from their copyright holders, but you may include | |
5271 | translations of some or all Invariant Sections in addition to the | |
5272 | original versions of these Invariant Sections. You may include a | |
5273 | translation of this License provided that you also include the | |
5274 | original English version of this License. In case of a disagreement | |
5275 | between the translation and the original English version of this | |
5276 | License, the original English version will prevail. | |
5277 | ||
5278 | ||
5279 | 9. TERMINATION | |
5280 | ||
5281 | You may not copy, modify, sublicense, or distribute the Document except | |
5282 | as expressly provided for under this License. Any other attempt to | |
5283 | copy, modify, sublicense or distribute the Document is void, and will | |
5284 | automatically terminate your rights under this License. However, | |
5285 | parties who have received copies, or rights, from you under this | |
5286 | License will not have their licenses terminated so long as such | |
5287 | parties remain in full compliance. | |
5288 | ||
5289 | ||
5290 | 10. FUTURE REVISIONS OF THIS LICENSE | |
5291 | ||
5292 | The Free Software Foundation may publish new, revised versions | |
5293 | of the GNU Free Documentation License from time to time. Such new | |
5294 | versions will be similar in spirit to the present version, but may | |
5295 | differ in detail to address new problems or concerns. See | |
5296 | http://www.gnu.org/copyleft/. | |
5297 | ||
5298 | Each version of the License is given a distinguishing version number. | |
5299 | If the Document specifies that a particular numbered version of this | |
5300 | License "or any later version" applies to it, you have the option of | |
5301 | following the terms and conditions either of that specified version or | |
5302 | of any later version that has been published (not as a draft) by the | |
5303 | Free Software Foundation. If the Document does not specify a version | |
5304 | number of this License, you may choose any version ever published (not | |
5305 | as a draft) by the Free Software Foundation. | |
5306 | ||
5307 | ||
5308 | ADDENDUM: How to use this License for your documents | |
5309 | ||
5310 | To use this License in a document you have written, include a copy of | |
5311 | the License in the document and put the following copyright and | |
5312 | license notices just after the title page: | |
5313 | ||
5314 | @smallexample | |
5315 | Copyright (c) YEAR YOUR NAME. | |
5316 | Permission is granted to copy, distribute and/or modify this document | |
5317 | under the terms of the GNU Free Documentation License, Version 1.1 | |
5318 | or any later version published by the Free Software Foundation; | |
5319 | with the Invariant Sections being LIST THEIR TITLES, with the | |
5320 | Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. | |
5321 | A copy of the license is included in the section entitled "GNU | |
5322 | Free Documentation License". | |
5323 | @end smallexample | |
5324 | ||
5325 | If you have no Invariant Sections, write "with no Invariant Sections" | |
5326 | instead of saying which ones are invariant. If you have no | |
5327 | Front-Cover Texts, write "no Front-Cover Texts" instead of | |
5328 | "Front-Cover Texts being LIST"; likewise for Back-Cover Texts. | |
5329 | ||
5330 | If your document contains nontrivial examples of program code, we | |
5331 | recommend releasing these examples in parallel under your choice of | |
5332 | free software license, such as the GNU General Public License, | |
5333 | to permit their use in free software. | |
5334 | ||
252b5132 RH |
5335 | @node Index |
5336 | @unnumbered Index | |
5337 | ||
5338 | @printindex cp | |
5339 | ||
5340 | @tex | |
5341 | % I think something like @colophon should be in texinfo. In the | |
5342 | % meantime: | |
5343 | \long\def\colophon{\hbox to0pt{}\vfill | |
5344 | \centerline{The body of this manual is set in} | |
5345 | \centerline{\fontname\tenrm,} | |
5346 | \centerline{with headings in {\bf\fontname\tenbf}} | |
5347 | \centerline{and examples in {\tt\fontname\tentt}.} | |
5348 | \centerline{{\it\fontname\tenit\/} and} | |
5349 | \centerline{{\sl\fontname\tensl\/}} | |
5350 | \centerline{are used for emphasis.}\vfill} | |
5351 | \page\colophon | |
5352 | % Blame: doc@cygnus.com, 28mar91. | |
5353 | @end tex | |
5354 | ||
5355 | ||
5356 | @contents | |
5357 | @bye |