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, |
ad22bfe8 | 4 | @c 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
252b5132 | 5 | @syncodeindex ky cp |
dff70155 | 6 | @c man begin INCLUDE |
252b5132 RH |
7 | @include configdoc.texi |
8 | @c (configdoc.texi is generated by the Makefile) | |
c428fa83 | 9 | @include bfdver.texi |
dff70155 | 10 | @c man end |
252b5132 RH |
11 | |
12 | @c @smallbook | |
13 | ||
ff5dcc92 SC |
14 | @macro gcctabopt{body} |
15 | @code{\body\} | |
16 | @end macro | |
17 | ||
0285c67d NC |
18 | @c man begin NAME |
19 | @ifset man | |
20 | @c Configure for the generation of man pages | |
21 | @set UsesEnvVars | |
22 | @set GENERIC | |
0285c67d | 23 | @set ARM |
49fa1e15 | 24 | @set H8300 |
0285c67d | 25 | @set HPPA |
0285c67d | 26 | @set I960 |
0285c67d | 27 | @set M68HC11 |
3c3bdf30 | 28 | @set MMIX |
2469cfa2 | 29 | @set MSP430 |
2a60a7a8 AM |
30 | @set POWERPC |
31 | @set POWERPC64 | |
49fa1e15 AM |
32 | @set Renesas |
33 | @set SPU | |
34 | @set TICOFF | |
2ca22b03 | 35 | @set WIN32 |
e0001a05 | 36 | @set XTENSA |
0285c67d NC |
37 | @end ifset |
38 | @c man end | |
39 | ||
252b5132 RH |
40 | @ifinfo |
41 | @format | |
42 | START-INFO-DIR-ENTRY | |
43 | * Ld: (ld). The GNU linker. | |
44 | END-INFO-DIR-ENTRY | |
45 | @end format | |
46 | @end ifinfo | |
47 | ||
0e9517a9 | 48 | @copying |
e49e529d JM |
49 | This file documents the @sc{gnu} linker LD |
50 | @ifset VERSION_PACKAGE | |
51 | @value{VERSION_PACKAGE} | |
52 | @end ifset | |
53 | version @value{VERSION}. | |
252b5132 | 54 | |
0e9517a9 | 55 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, |
ad22bfe8 | 56 | 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
252b5132 | 57 | |
cf055d54 NC |
58 | Permission is granted to copy, distribute and/or modify this document |
59 | under the terms of the GNU Free Documentation License, Version 1.1 | |
60 | or any later version published by the Free Software Foundation; | |
61 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
62 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 63 | section entitled ``GNU Free Documentation License''. |
0e9517a9 | 64 | @end copying |
252b5132 RH |
65 | @iftex |
66 | @finalout | |
67 | @setchapternewpage odd | |
71ba23f6 | 68 | @settitle The GNU linker |
252b5132 | 69 | @titlepage |
71ba23f6 | 70 | @title The GNU linker |
252b5132 | 71 | @sp 1 |
e49e529d JM |
72 | @subtitle @code{ld} |
73 | @ifset VERSION_PACKAGE | |
74 | @subtitle @value{VERSION_PACKAGE} | |
75 | @end ifset | |
252b5132 RH |
76 | @subtitle Version @value{VERSION} |
77 | @author Steve Chamberlain | |
78 | @author Ian Lance Taylor | |
252b5132 RH |
79 | @page |
80 | ||
81 | @tex | |
82 | {\parskip=0pt | |
704c465c NC |
83 | \hfill Red Hat Inc\par |
84 | \hfill nickc\@credhat.com, doc\@redhat.com\par | |
71ba23f6 | 85 | \hfill {\it The GNU linker}\par |
252b5132 RH |
86 | \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par |
87 | } | |
88 | \global\parindent=0pt % Steve likes it this way. | |
89 | @end tex | |
90 | ||
91 | @vskip 0pt plus 1filll | |
0285c67d | 92 | @c man begin COPYRIGHT |
9c8ebd6a | 93 | Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, |
ad22bfe8 | 94 | 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
252b5132 | 95 | |
0285c67d NC |
96 | Permission is granted to copy, distribute and/or modify this document |
97 | under the terms of the GNU Free Documentation License, Version 1.1 | |
98 | or any later version published by the Free Software Foundation; | |
99 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
100 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 101 | section entitled ``GNU Free Documentation License''. |
0285c67d | 102 | @c man end |
252b5132 | 103 | |
252b5132 RH |
104 | @end titlepage |
105 | @end iftex | |
4ecceb71 | 106 | @contents |
252b5132 RH |
107 | @c FIXME: Talk about importance of *order* of args, cmds to linker! |
108 | ||
84ec0e6d | 109 | @ifnottex |
252b5132 | 110 | @node Top |
71ba23f6 | 111 | @top LD |
e49e529d JM |
112 | This file documents the @sc{gnu} linker ld |
113 | @ifset VERSION_PACKAGE | |
114 | @value{VERSION_PACKAGE} | |
115 | @end ifset | |
116 | version @value{VERSION}. | |
252b5132 | 117 | |
cf055d54 NC |
118 | This document is distributed under the terms of the GNU Free |
119 | Documentation License. A copy of the license is included in the | |
36f63dca | 120 | section entitled ``GNU Free Documentation License''. |
cf055d54 | 121 | |
252b5132 RH |
122 | @menu |
123 | * Overview:: Overview | |
124 | * Invocation:: Invocation | |
125 | * Scripts:: Linker Scripts | |
126 | @ifset GENERIC | |
127 | * Machine Dependent:: Machine Dependent Features | |
128 | @end ifset | |
129 | @ifclear GENERIC | |
130 | @ifset H8300 | |
131 | * H8/300:: ld and the H8/300 | |
132 | @end ifset | |
c2dcd04e NC |
133 | @ifset Renesas |
134 | * Renesas:: ld and other Renesas micros | |
252b5132 RH |
135 | @end ifset |
136 | @ifset I960 | |
137 | * i960:: ld and the Intel 960 family | |
138 | @end ifset | |
36f63dca NC |
139 | @ifset ARM |
140 | * ARM:: ld and the ARM family | |
141 | @end ifset | |
142 | @ifset HPPA | |
143 | * HPPA ELF32:: ld and HPPA 32-bit ELF | |
144 | @end ifset | |
93fd0973 SC |
145 | @ifset M68HC11 |
146 | * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families | |
147 | @end ifset | |
2a60a7a8 AM |
148 | @ifset POWERPC |
149 | * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support | |
150 | @end ifset | |
151 | @ifset POWERPC64 | |
152 | * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support | |
153 | @end ifset | |
49fa1e15 AM |
154 | @ifset SPU |
155 | * SPU ELF:: ld and SPU ELF Support | |
156 | @end ifset | |
74459f0e TW |
157 | @ifset TICOFF |
158 | * TI COFF:: ld and the TI COFF | |
159 | @end ifset | |
2ca22b03 NC |
160 | @ifset WIN32 |
161 | * Win32:: ld and WIN32 (cygwin/mingw) | |
162 | @end ifset | |
e0001a05 NC |
163 | @ifset XTENSA |
164 | * Xtensa:: ld and Xtensa Processors | |
165 | @end ifset | |
252b5132 RH |
166 | @end ifclear |
167 | @ifclear SingleFormat | |
168 | * BFD:: BFD | |
169 | @end ifclear | |
170 | @c Following blank line required for remaining bug in makeinfo conds/menus | |
171 | ||
172 | * Reporting Bugs:: Reporting Bugs | |
173 | * MRI:: MRI Compatible Script Files | |
704c465c | 174 | * GNU Free Documentation License:: GNU Free Documentation License |
370b66a1 | 175 | * LD Index:: LD Index |
252b5132 | 176 | @end menu |
84ec0e6d | 177 | @end ifnottex |
252b5132 RH |
178 | |
179 | @node Overview | |
180 | @chapter Overview | |
181 | ||
182 | @cindex @sc{gnu} linker | |
183 | @cindex what is this? | |
0285c67d | 184 | |
0879a67a | 185 | @ifset man |
0285c67d | 186 | @c man begin SYNOPSIS |
ff5dcc92 | 187 | ld [@b{options}] @var{objfile} @dots{} |
0285c67d NC |
188 | @c man end |
189 | ||
190 | @c man begin SEEALSO | |
191 | ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and | |
192 | the Info entries for @file{binutils} and | |
193 | @file{ld}. | |
194 | @c man end | |
195 | @end ifset | |
196 | ||
197 | @c man begin DESCRIPTION | |
198 | ||
ff5dcc92 | 199 | @command{ld} combines a number of object and archive files, relocates |
252b5132 | 200 | their data and ties up symbol references. Usually the last step in |
ff5dcc92 | 201 | compiling a program is to run @command{ld}. |
252b5132 | 202 | |
ff5dcc92 | 203 | @command{ld} accepts Linker Command Language files written in |
252b5132 RH |
204 | a superset of AT&T's Link Editor Command Language syntax, |
205 | to provide explicit and total control over the linking process. | |
206 | ||
0285c67d NC |
207 | @ifset man |
208 | @c For the man only | |
ece2d90e | 209 | This man page does not describe the command language; see the |
71ba23f6 NC |
210 | @command{ld} entry in @code{info} for full details on the command |
211 | language and on other aspects of the GNU linker. | |
0285c67d NC |
212 | @end ifset |
213 | ||
252b5132 | 214 | @ifclear SingleFormat |
ff5dcc92 SC |
215 | This version of @command{ld} uses the general purpose BFD libraries |
216 | to operate on object files. This allows @command{ld} to read, combine, and | |
252b5132 RH |
217 | write object files in many different formats---for example, COFF or |
218 | @code{a.out}. Different formats may be linked together to produce any | |
219 | available kind of object file. @xref{BFD}, for more information. | |
220 | @end ifclear | |
221 | ||
222 | Aside from its flexibility, the @sc{gnu} linker is more helpful than other | |
223 | linkers in providing diagnostic information. Many linkers abandon | |
224 | execution immediately upon encountering an error; whenever possible, | |
ff5dcc92 | 225 | @command{ld} continues executing, allowing you to identify other errors |
252b5132 RH |
226 | (or, in some cases, to get an output file in spite of the error). |
227 | ||
0285c67d NC |
228 | @c man end |
229 | ||
252b5132 RH |
230 | @node Invocation |
231 | @chapter Invocation | |
232 | ||
0285c67d NC |
233 | @c man begin DESCRIPTION |
234 | ||
ff5dcc92 | 235 | The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations, |
252b5132 RH |
236 | and to be as compatible as possible with other linkers. As a result, |
237 | you have many choices to control its behavior. | |
238 | ||
0285c67d NC |
239 | @c man end |
240 | ||
252b5132 RH |
241 | @ifset UsesEnvVars |
242 | @menu | |
243 | * Options:: Command Line Options | |
244 | * Environment:: Environment Variables | |
245 | @end menu | |
246 | ||
247 | @node Options | |
248 | @section Command Line Options | |
249 | @end ifset | |
250 | ||
251 | @cindex command line | |
252 | @cindex options | |
0285c67d NC |
253 | |
254 | @c man begin OPTIONS | |
255 | ||
252b5132 RH |
256 | The linker supports a plethora of command-line options, but in actual |
257 | practice few of them are used in any particular context. | |
258 | @cindex standard Unix system | |
ff5dcc92 | 259 | For instance, a frequent use of @command{ld} is to link standard Unix |
252b5132 RH |
260 | object files on a standard, supported Unix system. On such a system, to |
261 | link a file @code{hello.o}: | |
262 | ||
263 | @smallexample | |
264 | ld -o @var{output} /lib/crt0.o hello.o -lc | |
265 | @end smallexample | |
266 | ||
ff5dcc92 | 267 | This tells @command{ld} to produce a file called @var{output} as the |
252b5132 RH |
268 | result of linking the file @code{/lib/crt0.o} with @code{hello.o} and |
269 | the library @code{libc.a}, which will come from the standard search | |
270 | directories. (See the discussion of the @samp{-l} option below.) | |
271 | ||
ff5dcc92 | 272 | Some of the command-line options to @command{ld} may be specified at any |
511ab9e9 ILT |
273 | point in the command line. However, options which refer to files, such |
274 | as @samp{-l} or @samp{-T}, cause the file to be read at the point at | |
275 | which the option appears in the command line, relative to the object | |
276 | files and other file options. Repeating non-file options with a | |
277 | different argument will either have no further effect, or override prior | |
252b5132 RH |
278 | occurrences (those further to the left on the command line) of that |
279 | option. Options which may be meaningfully specified more than once are | |
280 | noted in the descriptions below. | |
281 | ||
282 | @cindex object files | |
511ab9e9 ILT |
283 | Non-option arguments are object files or archives which are to be linked |
284 | together. They may follow, precede, or be mixed in with command-line | |
285 | options, except that an object file argument may not be placed between | |
286 | an option and its argument. | |
252b5132 RH |
287 | |
288 | Usually the linker is invoked with at least one object file, but you can | |
289 | specify other forms of binary input files using @samp{-l}, @samp{-R}, | |
290 | and the script command language. If @emph{no} binary input files at all | |
291 | are specified, the linker does not produce any output, and issues the | |
292 | message @samp{No input files}. | |
293 | ||
36f63dca | 294 | If the linker cannot recognize the format of an object file, it will |
252b5132 RH |
295 | assume that it is a linker script. A script specified in this way |
296 | augments the main linker script used for the link (either the default | |
297 | linker script or the one specified by using @samp{-T}). This feature | |
298 | permits the linker to link against a file which appears to be an object | |
299 | or an archive, but actually merely defines some symbol values, or uses | |
300 | @code{INPUT} or @code{GROUP} to load other objects. Note that | |
114283d8 NC |
301 | specifying a script in this way merely augments the main linker script; |
302 | use the @samp{-T} option to replace the default linker script entirely. | |
252b5132 RH |
303 | @xref{Scripts}. |
304 | ||
305 | For options whose names are a single letter, | |
306 | option arguments must either follow the option letter without intervening | |
307 | whitespace, or be given as separate arguments immediately following the | |
308 | option that requires them. | |
309 | ||
310 | For options whose names are multiple letters, either one dash or two can | |
e4897a32 | 311 | precede the option name; for example, @samp{-trace-symbol} and |
36f63dca | 312 | @samp{--trace-symbol} are equivalent. Note---there is one exception to |
e4897a32 | 313 | this rule. Multiple letter options that start with a lower case 'o' can |
ba1be17e | 314 | only be preceded by two dashes. This is to reduce confusion with the |
e4897a32 NC |
315 | @samp{-o} option. So for example @samp{-omagic} sets the output file |
316 | name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the | |
317 | output. | |
318 | ||
319 | Arguments to multiple-letter options must either be separated from the | |
320 | option name by an equals sign, or be given as separate arguments | |
321 | immediately following the option that requires them. For example, | |
322 | @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent. | |
323 | Unique abbreviations of the names of multiple-letter options are | |
324 | accepted. | |
252b5132 | 325 | |
36f63dca NC |
326 | Note---if the linker is being invoked indirectly, via a compiler driver |
327 | (e.g. @samp{gcc}) then all the linker command line options should be | |
fa19fce0 NC |
328 | prefixed by @samp{-Wl,} (or whatever is appropriate for the particular |
329 | compiler driver) like this: | |
4e53152f NC |
330 | |
331 | @smallexample | |
332 | gcc -Wl,--startgroup foo.o bar.o -Wl,--endgroup | |
333 | @end smallexample | |
334 | ||
335 | This is important, because otherwise the compiler driver program may | |
336 | silently drop the linker options, resulting in a bad link. | |
337 | ||
338 | Here is a table of the generic command line switches accepted by the GNU | |
339 | linker: | |
340 | ||
ff5dcc92 | 341 | @table @gcctabopt |
38fc1cb1 | 342 | @include at-file.texi |
dff70155 | 343 | |
252b5132 RH |
344 | @kindex -a@var{keyword} |
345 | @item -a@var{keyword} | |
346 | This option is supported for HP/UX compatibility. The @var{keyword} | |
347 | argument must be one of the strings @samp{archive}, @samp{shared}, or | |
348 | @samp{default}. @samp{-aarchive} is functionally equivalent to | |
349 | @samp{-Bstatic}, and the other two keywords are functionally equivalent | |
350 | to @samp{-Bdynamic}. This option may be used any number of times. | |
351 | ||
352 | @ifset I960 | |
353 | @cindex architectures | |
354 | @kindex -A@var{arch} | |
355 | @item -A@var{architecture} | |
356 | @kindex --architecture=@var{arch} | |
357 | @itemx --architecture=@var{architecture} | |
ff5dcc92 SC |
358 | In the current release of @command{ld}, this option is useful only for the |
359 | Intel 960 family of architectures. In that @command{ld} configuration, the | |
252b5132 RH |
360 | @var{architecture} argument identifies the particular architecture in |
361 | the 960 family, enabling some safeguards and modifying the | |
ff5dcc92 | 362 | archive-library search path. @xref{i960,,@command{ld} and the Intel 960 |
252b5132 RH |
363 | family}, for details. |
364 | ||
ff5dcc92 | 365 | Future releases of @command{ld} may support similar functionality for |
252b5132 RH |
366 | other architecture families. |
367 | @end ifset | |
368 | ||
369 | @ifclear SingleFormat | |
370 | @cindex binary input format | |
371 | @kindex -b @var{format} | |
372 | @kindex --format=@var{format} | |
373 | @cindex input format | |
374 | @cindex input format | |
375 | @item -b @var{input-format} | |
376 | @itemx --format=@var{input-format} | |
ff5dcc92 SC |
377 | @command{ld} may be configured to support more than one kind of object |
378 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 379 | @samp{-b} option to specify the binary format for input object files |
ff5dcc92 | 380 | that follow this option on the command line. Even when @command{ld} is |
252b5132 | 381 | configured to support alternative object formats, you don't usually need |
ff5dcc92 | 382 | to specify this, as @command{ld} should be configured to expect as a |
252b5132 RH |
383 | default input format the most usual format on each machine. |
384 | @var{input-format} is a text string, the name of a particular format | |
385 | supported by the BFD libraries. (You can list the available binary | |
386 | formats with @samp{objdump -i}.) | |
387 | @xref{BFD}. | |
388 | ||
389 | You may want to use this option if you are linking files with an unusual | |
390 | binary format. You can also use @samp{-b} to switch formats explicitly (when | |
391 | linking object files of different formats), by including | |
392 | @samp{-b @var{input-format}} before each group of object files in a | |
a1ab1d2a | 393 | particular format. |
252b5132 RH |
394 | |
395 | The default format is taken from the environment variable | |
396 | @code{GNUTARGET}. | |
397 | @ifset UsesEnvVars | |
398 | @xref{Environment}. | |
399 | @end ifset | |
400 | You can also define the input format from a script, using the command | |
0285c67d NC |
401 | @code{TARGET}; |
402 | @ifclear man | |
403 | see @ref{Format Commands}. | |
404 | @end ifclear | |
252b5132 RH |
405 | @end ifclear |
406 | ||
407 | @kindex -c @var{MRI-cmdfile} | |
408 | @kindex --mri-script=@var{MRI-cmdfile} | |
409 | @cindex compatibility, MRI | |
410 | @item -c @var{MRI-commandfile} | |
411 | @itemx --mri-script=@var{MRI-commandfile} | |
ff5dcc92 | 412 | For compatibility with linkers produced by MRI, @command{ld} accepts script |
252b5132 | 413 | files written in an alternate, restricted command language, described in |
0285c67d NC |
414 | @ifclear man |
415 | @ref{MRI,,MRI Compatible Script Files}. | |
416 | @end ifclear | |
417 | @ifset man | |
418 | the MRI Compatible Script Files section of GNU ld documentation. | |
419 | @end ifset | |
420 | Introduce MRI script files with | |
252b5132 | 421 | the option @samp{-c}; use the @samp{-T} option to run linker |
ff5dcc92 SC |
422 | scripts written in the general-purpose @command{ld} scripting language. |
423 | If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories | |
252b5132 RH |
424 | specified by any @samp{-L} options. |
425 | ||
426 | @cindex common allocation | |
427 | @kindex -d | |
428 | @kindex -dc | |
429 | @kindex -dp | |
a1ab1d2a | 430 | @item -d |
252b5132 RH |
431 | @itemx -dc |
432 | @itemx -dp | |
433 | These three options are equivalent; multiple forms are supported for | |
434 | compatibility with other linkers. They assign space to common symbols | |
435 | even if a relocatable output file is specified (with @samp{-r}). The | |
436 | script command @code{FORCE_COMMON_ALLOCATION} has the same effect. | |
437 | @xref{Miscellaneous Commands}. | |
438 | ||
439 | @cindex entry point, from command line | |
440 | @kindex -e @var{entry} | |
441 | @kindex --entry=@var{entry} | |
a1ab1d2a | 442 | @item -e @var{entry} |
252b5132 RH |
443 | @itemx --entry=@var{entry} |
444 | Use @var{entry} as the explicit symbol for beginning execution of your | |
445 | program, rather than the default entry point. If there is no symbol | |
446 | named @var{entry}, the linker will try to parse @var{entry} as a number, | |
447 | and use that as the entry address (the number will be interpreted in | |
448 | base 10; you may use a leading @samp{0x} for base 16, or a leading | |
449 | @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults | |
450 | and other ways of specifying the entry point. | |
451 | ||
b58f81ae DJ |
452 | @kindex --exclude-libs |
453 | @item --exclude-libs @var{lib},@var{lib},... | |
454 | Specifies a list of archive libraries from which symbols should not be automatically | |
455 | exported. The library names may be delimited by commas or colons. Specifying | |
456 | @code{--exclude-libs ALL} excludes symbols in all archive libraries from | |
457 | automatic export. This option is available only for the i386 PE targeted | |
458 | port of the linker and for ELF targeted ports. For i386 PE, symbols | |
459 | explicitly listed in a .def file are still exported, regardless of this | |
460 | option. For ELF targeted ports, symbols affected by this option will | |
461 | be treated as hidden. | |
462 | ||
252b5132 RH |
463 | @cindex dynamic symbol table |
464 | @kindex -E | |
465 | @kindex --export-dynamic | |
466 | @item -E | |
467 | @itemx --export-dynamic | |
468 | When creating a dynamically linked executable, add all symbols to the | |
469 | dynamic symbol table. The dynamic symbol table is the set of symbols | |
470 | which are visible from dynamic objects at run time. | |
471 | ||
472 | If you do not use this option, the dynamic symbol table will normally | |
473 | contain only those symbols which are referenced by some dynamic object | |
474 | mentioned in the link. | |
475 | ||
476 | If you use @code{dlopen} to load a dynamic object which needs to refer | |
477 | back to the symbols defined by the program, rather than some other | |
478 | dynamic object, then you will probably need to use this option when | |
479 | linking the program itself. | |
480 | ||
55255dae | 481 | You can also use the dynamic list to control what symbols should |
cb840a31 | 482 | be added to the dynamic symbol table if the output format supports it. |
55255dae | 483 | See the description of @samp{--dynamic-list}. |
cb840a31 | 484 | |
36f63dca | 485 | @ifclear SingleFormat |
252b5132 RH |
486 | @cindex big-endian objects |
487 | @cindex endianness | |
488 | @kindex -EB | |
489 | @item -EB | |
490 | Link big-endian objects. This affects the default output format. | |
491 | ||
492 | @cindex little-endian objects | |
493 | @kindex -EL | |
494 | @item -EL | |
495 | Link little-endian objects. This affects the default output format. | |
36f63dca | 496 | @end ifclear |
252b5132 RH |
497 | |
498 | @kindex -f | |
499 | @kindex --auxiliary | |
500 | @item -f | |
501 | @itemx --auxiliary @var{name} | |
502 | When creating an ELF shared object, set the internal DT_AUXILIARY field | |
503 | to the specified name. This tells the dynamic linker that the symbol | |
504 | table of the shared object should be used as an auxiliary filter on the | |
505 | symbol table of the shared object @var{name}. | |
506 | ||
507 | If you later link a program against this filter object, then, when you | |
508 | run the program, the dynamic linker will see the DT_AUXILIARY field. If | |
509 | the dynamic linker resolves any symbols from the filter object, it will | |
510 | first check whether there is a definition in the shared object | |
511 | @var{name}. If there is one, it will be used instead of the definition | |
512 | in the filter object. The shared object @var{name} need not exist. | |
513 | Thus the shared object @var{name} may be used to provide an alternative | |
514 | implementation of certain functions, perhaps for debugging or for | |
515 | machine specific performance. | |
516 | ||
517 | This option may be specified more than once. The DT_AUXILIARY entries | |
518 | will be created in the order in which they appear on the command line. | |
519 | ||
520 | @kindex -F | |
521 | @kindex --filter | |
522 | @item -F @var{name} | |
523 | @itemx --filter @var{name} | |
524 | When creating an ELF shared object, set the internal DT_FILTER field to | |
525 | the specified name. This tells the dynamic linker that the symbol table | |
526 | of the shared object which is being created should be used as a filter | |
527 | on the symbol table of the shared object @var{name}. | |
528 | ||
529 | If you later link a program against this filter object, then, when you | |
530 | run the program, the dynamic linker will see the DT_FILTER field. The | |
531 | dynamic linker will resolve symbols according to the symbol table of the | |
532 | filter object as usual, but it will actually link to the definitions | |
533 | found in the shared object @var{name}. Thus the filter object can be | |
534 | used to select a subset of the symbols provided by the object | |
535 | @var{name}. | |
536 | ||
ff5dcc92 | 537 | Some older linkers used the @option{-F} option throughout a compilation |
252b5132 | 538 | toolchain for specifying object-file format for both input and output |
36f63dca NC |
539 | object files. |
540 | @ifclear SingleFormat | |
541 | The @sc{gnu} linker uses other mechanisms for this purpose: the | |
ece2d90e | 542 | @option{-b}, @option{--format}, @option{--oformat} options, the |
252b5132 | 543 | @code{TARGET} command in linker scripts, and the @code{GNUTARGET} |
36f63dca NC |
544 | environment variable. |
545 | @end ifclear | |
546 | The @sc{gnu} linker will ignore the @option{-F} option when not | |
547 | creating an ELF shared object. | |
252b5132 | 548 | |
3dbf70a2 MM |
549 | @cindex finalization function |
550 | @kindex -fini | |
551 | @item -fini @var{name} | |
552 | When creating an ELF executable or shared object, call NAME when the | |
553 | executable or shared object is unloaded, by setting DT_FINI to the | |
554 | address of the function. By default, the linker uses @code{_fini} as | |
555 | the function to call. | |
556 | ||
252b5132 RH |
557 | @kindex -g |
558 | @item -g | |
559 | Ignored. Provided for compatibility with other tools. | |
560 | ||
561 | @kindex -G | |
562 | @kindex --gpsize | |
563 | @cindex object size | |
564 | @item -G@var{value} | |
565 | @itemx --gpsize=@var{value} | |
566 | Set the maximum size of objects to be optimized using the GP register to | |
567 | @var{size}. This is only meaningful for object file formats such as | |
568 | MIPS ECOFF which supports putting large and small objects into different | |
569 | sections. This is ignored for other object file formats. | |
570 | ||
571 | @cindex runtime library name | |
572 | @kindex -h@var{name} | |
573 | @kindex -soname=@var{name} | |
574 | @item -h@var{name} | |
575 | @itemx -soname=@var{name} | |
576 | When creating an ELF shared object, set the internal DT_SONAME field to | |
577 | the specified name. When an executable is linked with a shared object | |
578 | which has a DT_SONAME field, then when the executable is run the dynamic | |
579 | linker will attempt to load the shared object specified by the DT_SONAME | |
580 | field rather than the using the file name given to the linker. | |
581 | ||
582 | @kindex -i | |
583 | @cindex incremental link | |
584 | @item -i | |
585 | Perform an incremental link (same as option @samp{-r}). | |
586 | ||
3dbf70a2 MM |
587 | @cindex initialization function |
588 | @kindex -init | |
589 | @item -init @var{name} | |
590 | When creating an ELF executable or shared object, call NAME when the | |
591 | executable or shared object is loaded, by setting DT_INIT to the address | |
592 | of the function. By default, the linker uses @code{_init} as the | |
593 | function to call. | |
594 | ||
252b5132 | 595 | @cindex archive files, from cmd line |
bcb674cf RS |
596 | @kindex -l@var{namespec} |
597 | @kindex --library=@var{namespec} | |
598 | @item -l@var{namespec} | |
599 | @itemx --library=@var{namespec} | |
600 | Add the archive or object file specified by @var{namespec} to the | |
601 | list of files to link. This option may be used any number of times. | |
602 | If @var{namespec} is of the form @file{:@var{filename}}, @command{ld} | |
603 | will search the library path for a file called @var{filename}, otherise it | |
604 | will search the library path for a file called @file{lib@var{namespec}.a}. | |
252b5132 | 605 | |
ff5dcc92 | 606 | On systems which support shared libraries, @command{ld} may also search for |
bcb674cf RS |
607 | files other than @file{lib@var{namespec}.a}. Specifically, on ELF |
608 | and SunOS systems, @command{ld} will search a directory for a library | |
609 | called @file{lib@var{namespec}.so} before searching for one called | |
610 | @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension | |
611 | indicates a shared library.) Note that this behavior does not apply | |
612 | to @file{:@var{filename}}, which always specifies a file called | |
613 | @var{filename}. | |
252b5132 RH |
614 | |
615 | The linker will search an archive only once, at the location where it is | |
616 | specified on the command line. If the archive defines a symbol which | |
617 | was undefined in some object which appeared before the archive on the | |
618 | command line, the linker will include the appropriate file(s) from the | |
619 | archive. However, an undefined symbol in an object appearing later on | |
620 | the command line will not cause the linker to search the archive again. | |
621 | ||
ff5dcc92 | 622 | See the @option{-(} option for a way to force the linker to search |
252b5132 RH |
623 | archives multiple times. |
624 | ||
625 | You may list the same archive multiple times on the command line. | |
626 | ||
627 | @ifset GENERIC | |
628 | This type of archive searching is standard for Unix linkers. However, | |
ff5dcc92 | 629 | if you are using @command{ld} on AIX, note that it is different from the |
252b5132 RH |
630 | behaviour of the AIX linker. |
631 | @end ifset | |
632 | ||
633 | @cindex search directory, from cmd line | |
634 | @kindex -L@var{dir} | |
635 | @kindex --library-path=@var{dir} | |
a1ab1d2a | 636 | @item -L@var{searchdir} |
252b5132 | 637 | @itemx --library-path=@var{searchdir} |
ff5dcc92 SC |
638 | Add path @var{searchdir} to the list of paths that @command{ld} will search |
639 | for archive libraries and @command{ld} control scripts. You may use this | |
252b5132 RH |
640 | option any number of times. The directories are searched in the order |
641 | in which they are specified on the command line. Directories specified | |
642 | on the command line are searched before the default directories. All | |
ff5dcc92 | 643 | @option{-L} options apply to all @option{-l} options, regardless of the |
252b5132 RH |
644 | order in which the options appear. |
645 | ||
9c8ebd6a DJ |
646 | If @var{searchdir} begins with @code{=}, then the @code{=} will be replaced |
647 | by the @dfn{sysroot prefix}, a path specified when the linker is configured. | |
648 | ||
252b5132 RH |
649 | @ifset UsesEnvVars |
650 | The default set of paths searched (without being specified with | |
ff5dcc92 | 651 | @samp{-L}) depends on which emulation mode @command{ld} is using, and in |
252b5132 RH |
652 | some cases also on how it was configured. @xref{Environment}. |
653 | @end ifset | |
654 | ||
655 | The paths can also be specified in a link script with the | |
656 | @code{SEARCH_DIR} command. Directories specified this way are searched | |
657 | at the point in which the linker script appears in the command line. | |
658 | ||
659 | @cindex emulation | |
660 | @kindex -m @var{emulation} | |
661 | @item -m@var{emulation} | |
662 | Emulate the @var{emulation} linker. You can list the available | |
663 | emulations with the @samp{--verbose} or @samp{-V} options. | |
664 | ||
665 | If the @samp{-m} option is not used, the emulation is taken from the | |
666 | @code{LDEMULATION} environment variable, if that is defined. | |
667 | ||
668 | Otherwise, the default emulation depends upon how the linker was | |
669 | configured. | |
670 | ||
671 | @cindex link map | |
672 | @kindex -M | |
673 | @kindex --print-map | |
674 | @item -M | |
675 | @itemx --print-map | |
676 | Print a link map to the standard output. A link map provides | |
677 | information about the link, including the following: | |
678 | ||
679 | @itemize @bullet | |
680 | @item | |
3b83e13a | 681 | Where object files are mapped into memory. |
252b5132 RH |
682 | @item |
683 | How common symbols are allocated. | |
684 | @item | |
685 | All archive members included in the link, with a mention of the symbol | |
686 | which caused the archive member to be brought in. | |
3b83e13a NC |
687 | @item |
688 | The values assigned to symbols. | |
689 | ||
690 | Note - symbols whose values are computed by an expression which | |
691 | involves a reference to a previous value of the same symbol may not | |
692 | have correct result displayed in the link map. This is because the | |
693 | linker discards intermediate results and only retains the final value | |
694 | of an expression. Under such circumstances the linker will display | |
695 | the final value enclosed by square brackets. Thus for example a | |
696 | linker script containing: | |
697 | ||
698 | @smallexample | |
699 | foo = 1 | |
700 | foo = foo * 4 | |
701 | foo = foo + 8 | |
702 | @end smallexample | |
703 | ||
704 | will produce the following output in the link map if the @option{-M} | |
705 | option is used: | |
706 | ||
707 | @smallexample | |
708 | 0x00000001 foo = 0x1 | |
709 | [0x0000000c] foo = (foo * 0x4) | |
710 | [0x0000000c] foo = (foo + 0x8) | |
711 | @end smallexample | |
712 | ||
713 | See @ref{Expressions} for more information about expressions in linker | |
714 | scripts. | |
252b5132 RH |
715 | @end itemize |
716 | ||
717 | @kindex -n | |
718 | @cindex read-only text | |
719 | @cindex NMAGIC | |
720 | @kindex --nmagic | |
721 | @item -n | |
722 | @itemx --nmagic | |
fa19fce0 | 723 | Turn off page alignment of sections, and mark the output as |
a1ab1d2a | 724 | @code{NMAGIC} if possible. |
252b5132 RH |
725 | |
726 | @kindex -N | |
727 | @kindex --omagic | |
728 | @cindex read/write from cmd line | |
729 | @cindex OMAGIC | |
a1ab1d2a | 730 | @item -N |
252b5132 RH |
731 | @itemx --omagic |
732 | Set the text and data sections to be readable and writable. Also, do | |
63fd3b82 NC |
733 | not page-align the data segment, and disable linking against shared |
734 | libraries. If the output format supports Unix style magic numbers, | |
4d8907ac DS |
735 | mark the output as @code{OMAGIC}. Note: Although a writable text section |
736 | is allowed for PE-COFF targets, it does not conform to the format | |
737 | specification published by Microsoft. | |
63fd3b82 NC |
738 | |
739 | @kindex --no-omagic | |
740 | @cindex OMAGIC | |
741 | @item --no-omagic | |
742 | This option negates most of the effects of the @option{-N} option. It | |
743 | sets the text section to be read-only, and forces the data segment to | |
744 | be page-aligned. Note - this option does not enable linking against | |
745 | shared libraries. Use @option{-Bdynamic} for this. | |
252b5132 RH |
746 | |
747 | @kindex -o @var{output} | |
748 | @kindex --output=@var{output} | |
749 | @cindex naming the output file | |
750 | @item -o @var{output} | |
751 | @itemx --output=@var{output} | |
ff5dcc92 | 752 | Use @var{output} as the name for the program produced by @command{ld}; if this |
252b5132 RH |
753 | option is not specified, the name @file{a.out} is used by default. The |
754 | script command @code{OUTPUT} can also specify the output file name. | |
755 | ||
756 | @kindex -O @var{level} | |
757 | @cindex generating optimized output | |
758 | @item -O @var{level} | |
ff5dcc92 | 759 | If @var{level} is a numeric values greater than zero @command{ld} optimizes |
252b5132 | 760 | the output. This might take significantly longer and therefore probably |
98c503ac NC |
761 | should only be enabled for the final binary. At the moment this |
762 | option only affects ELF shared library generation. Future releases of | |
763 | the linker may make more use of this option. Also currently there is | |
764 | no difference in the linker's behaviour for different non-zero values | |
765 | of this option. Again this may change with future releases. | |
252b5132 | 766 | |
a712da20 NC |
767 | @kindex -q |
768 | @kindex --emit-relocs | |
769 | @cindex retain relocations in final executable | |
770 | @item -q | |
771 | @itemx --emit-relocs | |
ba1be17e | 772 | Leave relocation sections and contents in fully linked executables. |
a712da20 NC |
773 | Post link analysis and optimization tools may need this information in |
774 | order to perform correct modifications of executables. This results | |
775 | in larger executables. | |
776 | ||
dbab7a7b NC |
777 | This option is currently only supported on ELF platforms. |
778 | ||
4f471f39 RS |
779 | @kindex --force-dynamic |
780 | @cindex forcing the creation of dynamic sections | |
781 | @item --force-dynamic | |
782 | Force the output file to have dynamic sections. This option is specific | |
783 | to VxWorks targets. | |
784 | ||
252b5132 RH |
785 | @cindex partial link |
786 | @cindex relocatable output | |
787 | @kindex -r | |
1049f94e | 788 | @kindex --relocatable |
252b5132 | 789 | @item -r |
1049f94e | 790 | @itemx --relocatable |
252b5132 | 791 | Generate relocatable output---i.e., generate an output file that can in |
ff5dcc92 | 792 | turn serve as input to @command{ld}. This is often called @dfn{partial |
252b5132 RH |
793 | linking}. As a side effect, in environments that support standard Unix |
794 | magic numbers, this option also sets the output file's magic number to | |
795 | @code{OMAGIC}. | |
ff5dcc92 | 796 | @c ; see @option{-N}. |
252b5132 RH |
797 | If this option is not specified, an absolute file is produced. When |
798 | linking C++ programs, this option @emph{will not} resolve references to | |
799 | constructors; to do that, use @samp{-Ur}. | |
800 | ||
62bf86b4 HPN |
801 | When an input file does not have the same format as the output file, |
802 | partial linking is only supported if that input file does not contain any | |
803 | relocations. Different output formats can have further restrictions; for | |
804 | example some @code{a.out}-based formats do not support partial linking | |
805 | with input files in other formats at all. | |
806 | ||
252b5132 RH |
807 | This option does the same thing as @samp{-i}. |
808 | ||
809 | @kindex -R @var{file} | |
810 | @kindex --just-symbols=@var{file} | |
811 | @cindex symbol-only input | |
812 | @item -R @var{filename} | |
813 | @itemx --just-symbols=@var{filename} | |
814 | Read symbol names and their addresses from @var{filename}, but do not | |
815 | relocate it or include it in the output. This allows your output file | |
816 | to refer symbolically to absolute locations of memory defined in other | |
817 | programs. You may use this option more than once. | |
818 | ||
ff5dcc92 | 819 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 820 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 821 | the @option{-rpath} option. |
252b5132 RH |
822 | |
823 | @kindex -s | |
824 | @kindex --strip-all | |
825 | @cindex strip all symbols | |
a1ab1d2a | 826 | @item -s |
252b5132 RH |
827 | @itemx --strip-all |
828 | Omit all symbol information from the output file. | |
829 | ||
830 | @kindex -S | |
831 | @kindex --strip-debug | |
832 | @cindex strip debugger symbols | |
a1ab1d2a | 833 | @item -S |
252b5132 RH |
834 | @itemx --strip-debug |
835 | Omit debugger symbol information (but not all symbols) from the output file. | |
836 | ||
837 | @kindex -t | |
838 | @kindex --trace | |
839 | @cindex input files, displaying | |
a1ab1d2a | 840 | @item -t |
252b5132 | 841 | @itemx --trace |
ff5dcc92 | 842 | Print the names of the input files as @command{ld} processes them. |
252b5132 RH |
843 | |
844 | @kindex -T @var{script} | |
845 | @kindex --script=@var{script} | |
846 | @cindex script files | |
847 | @item -T @var{scriptfile} | |
848 | @itemx --script=@var{scriptfile} | |
849 | Use @var{scriptfile} as the linker script. This script replaces | |
ff5dcc92 | 850 | @command{ld}'s default linker script (rather than adding to it), so |
252b5132 | 851 | @var{commandfile} must specify everything necessary to describe the |
114283d8 NC |
852 | output file. @xref{Scripts}. If @var{scriptfile} does not exist in |
853 | the current directory, @code{ld} looks for it in the directories | |
854 | specified by any preceding @samp{-L} options. Multiple @samp{-T} | |
855 | options accumulate. | |
252b5132 | 856 | |
14be8564 L |
857 | @kindex -dT @var{script} |
858 | @kindex --default-script=@var{script} | |
859 | @cindex script files | |
860 | @item -dT @var{scriptfile} | |
861 | @itemx --default-script=@var{scriptfile} | |
862 | Use @var{scriptfile} as the default linker script. @xref{Scripts}. | |
863 | ||
864 | This option is similar to the @option{--script} option except that | |
865 | processing of the script is delayed until after the rest of the | |
866 | command line has been processed. This allows options placed after the | |
867 | @option{--default-script} option on the command line to affect the | |
868 | behaviour of the linker script, which can be important when the linker | |
869 | command line cannot be directly controlled by the user. (eg because | |
870 | the command line is being constructed by another tool, such as | |
871 | @samp{gcc}). | |
872 | ||
252b5132 RH |
873 | @kindex -u @var{symbol} |
874 | @kindex --undefined=@var{symbol} | |
875 | @cindex undefined symbol | |
876 | @item -u @var{symbol} | |
877 | @itemx --undefined=@var{symbol} | |
878 | Force @var{symbol} to be entered in the output file as an undefined | |
879 | symbol. Doing this may, for example, trigger linking of additional | |
880 | modules from standard libraries. @samp{-u} may be repeated with | |
881 | different option arguments to enter additional undefined symbols. This | |
882 | option is equivalent to the @code{EXTERN} linker script command. | |
883 | ||
884 | @kindex -Ur | |
885 | @cindex constructors | |
a1ab1d2a | 886 | @item -Ur |
252b5132 RH |
887 | For anything other than C++ programs, this option is equivalent to |
888 | @samp{-r}: it generates relocatable output---i.e., an output file that can in | |
ff5dcc92 | 889 | turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur} |
252b5132 RH |
890 | @emph{does} resolve references to constructors, unlike @samp{-r}. |
891 | It does not work to use @samp{-Ur} on files that were themselves linked | |
892 | with @samp{-Ur}; once the constructor table has been built, it cannot | |
893 | be added to. Use @samp{-Ur} only for the last partial link, and | |
894 | @samp{-r} for the others. | |
895 | ||
577a0623 AM |
896 | @kindex --unique[=@var{SECTION}] |
897 | @item --unique[=@var{SECTION}] | |
898 | Creates a separate output section for every input section matching | |
899 | @var{SECTION}, or if the optional wildcard @var{SECTION} argument is | |
900 | missing, for every orphan input section. An orphan section is one not | |
901 | specifically mentioned in a linker script. You may use this option | |
902 | multiple times on the command line; It prevents the normal merging of | |
903 | input sections with the same name, overriding output section assignments | |
904 | in a linker script. | |
a854a4a7 | 905 | |
252b5132 RH |
906 | @kindex -v |
907 | @kindex -V | |
908 | @kindex --version | |
909 | @cindex version | |
910 | @item -v | |
911 | @itemx --version | |
912 | @itemx -V | |
ff5dcc92 | 913 | Display the version number for @command{ld}. The @option{-V} option also |
252b5132 RH |
914 | lists the supported emulations. |
915 | ||
916 | @kindex -x | |
917 | @kindex --discard-all | |
918 | @cindex deleting local symbols | |
919 | @item -x | |
920 | @itemx --discard-all | |
921 | Delete all local symbols. | |
922 | ||
923 | @kindex -X | |
924 | @kindex --discard-locals | |
925 | @cindex local symbols, deleting | |
a1ab1d2a | 926 | @item -X |
252b5132 | 927 | @itemx --discard-locals |
3c68c38f BW |
928 | Delete all temporary local symbols. (These symbols start with |
929 | system-specific local label prefixes, typically @samp{.L} for ELF systems | |
930 | or @samp{L} for traditional a.out systems.) | |
252b5132 RH |
931 | |
932 | @kindex -y @var{symbol} | |
933 | @kindex --trace-symbol=@var{symbol} | |
934 | @cindex symbol tracing | |
935 | @item -y @var{symbol} | |
936 | @itemx --trace-symbol=@var{symbol} | |
937 | Print the name of each linked file in which @var{symbol} appears. This | |
938 | option may be given any number of times. On many systems it is necessary | |
939 | to prepend an underscore. | |
940 | ||
941 | This option is useful when you have an undefined symbol in your link but | |
942 | don't know where the reference is coming from. | |
943 | ||
944 | @kindex -Y @var{path} | |
945 | @item -Y @var{path} | |
946 | Add @var{path} to the default library search path. This option exists | |
947 | for Solaris compatibility. | |
948 | ||
949 | @kindex -z @var{keyword} | |
950 | @item -z @var{keyword} | |
cd6d6c15 NC |
951 | The recognized keywords are: |
952 | @table @samp | |
953 | ||
954 | @item combreloc | |
955 | Combines multiple reloc sections and sorts them to make dynamic symbol | |
956 | lookup caching possible. | |
957 | ||
958 | @item defs | |
560e09e9 | 959 | Disallows undefined symbols in object files. Undefined symbols in |
07f3b6ad | 960 | shared libraries are still allowed. |
cd6d6c15 | 961 | |
6aa29e7b JJ |
962 | @item execstack |
963 | Marks the object as requiring executable stack. | |
964 | ||
cd6d6c15 NC |
965 | @item initfirst |
966 | This option is only meaningful when building a shared object. | |
967 | It marks the object so that its runtime initialization will occur | |
968 | before the runtime initialization of any other objects brought into | |
969 | the process at the same time. Similarly the runtime finalization of | |
970 | the object will occur after the runtime finalization of any other | |
971 | objects. | |
972 | ||
973 | @item interpose | |
974 | Marks the object that its symbol table interposes before all symbols | |
975 | but the primary executable. | |
976 | ||
5fa222e4 AM |
977 | @item lazy |
978 | When generating an executable or shared library, mark it to tell the | |
979 | dynamic linker to defer function call resolution to the point when | |
980 | the function is called (lazy binding), rather than at load time. | |
981 | Lazy binding is the default. | |
982 | ||
cd6d6c15 NC |
983 | @item loadfltr |
984 | Marks the object that its filters be processed immediately at | |
985 | runtime. | |
986 | ||
987 | @item muldefs | |
988 | Allows multiple definitions. | |
989 | ||
990 | @item nocombreloc | |
991 | Disables multiple reloc sections combining. | |
992 | ||
993 | @item nocopyreloc | |
994 | Disables production of copy relocs. | |
995 | ||
996 | @item nodefaultlib | |
997 | Marks the object that the search for dependencies of this object will | |
998 | ignore any default library search paths. | |
999 | ||
1000 | @item nodelete | |
1001 | Marks the object shouldn't be unloaded at runtime. | |
1002 | ||
1003 | @item nodlopen | |
1004 | Marks the object not available to @code{dlopen}. | |
1005 | ||
1006 | @item nodump | |
1007 | Marks the object can not be dumped by @code{dldump}. | |
1008 | ||
6aa29e7b JJ |
1009 | @item noexecstack |
1010 | Marks the object as not requiring executable stack. | |
1011 | ||
1012 | @item norelro | |
1013 | Don't create an ELF @code{PT_GNU_RELRO} segment header in the object. | |
1014 | ||
cd6d6c15 NC |
1015 | @item now |
1016 | When generating an executable or shared library, mark it to tell the | |
1017 | dynamic linker to resolve all symbols when the program is started, or | |
1018 | when the shared library is linked to using dlopen, instead of | |
1019 | deferring function call resolution to the point when the function is | |
1020 | first called. | |
1021 | ||
1022 | @item origin | |
1023 | Marks the object may contain $ORIGIN. | |
1024 | ||
6aa29e7b JJ |
1025 | @item relro |
1026 | Create an ELF @code{PT_GNU_RELRO} segment header in the object. | |
1027 | ||
24718e3b L |
1028 | @item max-page-size=@var{value} |
1029 | Set the emulation maximum page size to @var{value}. | |
1030 | ||
1031 | @item common-page-size=@var{value} | |
1032 | Set the emulation common page size to @var{value}. | |
1033 | ||
cd6d6c15 NC |
1034 | @end table |
1035 | ||
ece2d90e | 1036 | Other keywords are ignored for Solaris compatibility. |
252b5132 RH |
1037 | |
1038 | @kindex -( | |
1039 | @cindex groups of archives | |
1040 | @item -( @var{archives} -) | |
1041 | @itemx --start-group @var{archives} --end-group | |
1042 | The @var{archives} should be a list of archive files. They may be | |
1043 | either explicit file names, or @samp{-l} options. | |
1044 | ||
1045 | The specified archives are searched repeatedly until no new undefined | |
1046 | references are created. Normally, an archive is searched only once in | |
1047 | the order that it is specified on the command line. If a symbol in that | |
1048 | archive is needed to resolve an undefined symbol referred to by an | |
1049 | object in an archive that appears later on the command line, the linker | |
1050 | would not be able to resolve that reference. By grouping the archives, | |
1051 | they all be searched repeatedly until all possible references are | |
1052 | resolved. | |
1053 | ||
1054 | Using this option has a significant performance cost. It is best to use | |
1055 | it only when there are unavoidable circular references between two or | |
1056 | more archives. | |
1057 | ||
69da35b5 NC |
1058 | @kindex --accept-unknown-input-arch |
1059 | @kindex --no-accept-unknown-input-arch | |
1060 | @item --accept-unknown-input-arch | |
1061 | @itemx --no-accept-unknown-input-arch | |
1062 | Tells the linker to accept input files whose architecture cannot be | |
2ca22b03 | 1063 | recognised. The assumption is that the user knows what they are doing |
69da35b5 NC |
1064 | and deliberately wants to link in these unknown input files. This was |
1065 | the default behaviour of the linker, before release 2.14. The default | |
1066 | behaviour from release 2.14 onwards is to reject such input files, and | |
1067 | so the @samp{--accept-unknown-input-arch} option has been added to | |
1068 | restore the old behaviour. | |
2ca22b03 | 1069 | |
4a43e768 AM |
1070 | @kindex --as-needed |
1071 | @kindex --no-as-needed | |
1072 | @item --as-needed | |
1073 | @itemx --no-as-needed | |
1074 | This option affects ELF DT_NEEDED tags for dynamic libraries mentioned | |
1075 | on the command line after the @option{--as-needed} option. Normally, | |
1076 | the linker will add a DT_NEEDED tag for each dynamic library mentioned | |
1077 | on the command line, regardless of whether the library is actually | |
77cfaee6 AM |
1078 | needed. @option{--as-needed} causes DT_NEEDED tags to only be emitted |
1079 | for libraries that satisfy some symbol reference from regular objects | |
1080 | which is undefined at the point that the library was linked. | |
4a43e768 AM |
1081 | @option{--no-as-needed} restores the default behaviour. |
1082 | ||
e56f61be L |
1083 | @kindex --add-needed |
1084 | @kindex --no-add-needed | |
1085 | @item --add-needed | |
1086 | @itemx --no-add-needed | |
1087 | This option affects the treatment of dynamic libraries from ELF | |
1088 | DT_NEEDED tags in dynamic libraries mentioned on the command line after | |
1089 | the @option{--no-add-needed} option. Normally, the linker will add | |
1090 | a DT_NEEDED tag for each dynamic library from DT_NEEDED tags. | |
1091 | @option{--no-add-needed} causes DT_NEEDED tags will never be emitted | |
1092 | for those libraries from DT_NEEDED tags. @option{--add-needed} restores | |
1093 | the default behaviour. | |
1094 | ||
252b5132 RH |
1095 | @kindex -assert @var{keyword} |
1096 | @item -assert @var{keyword} | |
1097 | This option is ignored for SunOS compatibility. | |
1098 | ||
1099 | @kindex -Bdynamic | |
1100 | @kindex -dy | |
1101 | @kindex -call_shared | |
1102 | @item -Bdynamic | |
1103 | @itemx -dy | |
1104 | @itemx -call_shared | |
1105 | Link against dynamic libraries. This is only meaningful on platforms | |
1106 | for which shared libraries are supported. This option is normally the | |
1107 | default on such platforms. The different variants of this option are | |
1108 | for compatibility with various systems. You may use this option | |
1109 | multiple times on the command line: it affects library searching for | |
da8bce14 | 1110 | @option{-l} options which follow it. |
252b5132 | 1111 | |
a1ab1d2a UD |
1112 | @kindex -Bgroup |
1113 | @item -Bgroup | |
1114 | Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic | |
1115 | section. This causes the runtime linker to handle lookups in this | |
1116 | object and its dependencies to be performed only inside the group. | |
560e09e9 NC |
1117 | @option{--unresolved-symbols=report-all} is implied. This option is |
1118 | only meaningful on ELF platforms which support shared libraries. | |
a1ab1d2a | 1119 | |
252b5132 RH |
1120 | @kindex -Bstatic |
1121 | @kindex -dn | |
1122 | @kindex -non_shared | |
1123 | @kindex -static | |
a1ab1d2a | 1124 | @item -Bstatic |
252b5132 RH |
1125 | @itemx -dn |
1126 | @itemx -non_shared | |
1127 | @itemx -static | |
1128 | Do not link against shared libraries. This is only meaningful on | |
1129 | platforms for which shared libraries are supported. The different | |
1130 | variants of this option are for compatibility with various systems. You | |
1131 | may use this option multiple times on the command line: it affects | |
560e09e9 | 1132 | library searching for @option{-l} options which follow it. This |
e9156f74 NC |
1133 | option also implies @option{--unresolved-symbols=report-all}. This |
1134 | option can be used with @option{-shared}. Doing so means that a | |
1135 | shared library is being created but that all of the library's external | |
1136 | references must be resolved by pulling in entries from static | |
ece2d90e | 1137 | libraries. |
252b5132 RH |
1138 | |
1139 | @kindex -Bsymbolic | |
1140 | @item -Bsymbolic | |
1141 | When creating a shared library, bind references to global symbols to the | |
1142 | definition within the shared library, if any. Normally, it is possible | |
1143 | for a program linked against a shared library to override the definition | |
1144 | within the shared library. This option is only meaningful on ELF | |
1145 | platforms which support shared libraries. | |
1146 | ||
40b36307 L |
1147 | @kindex -Bsymbolic-functions |
1148 | @item -Bsymbolic-functions | |
1149 | When creating a shared library, bind references to global function | |
c0065db7 | 1150 | symbols to the definition within the shared library, if any. |
40b36307 L |
1151 | This option is only meaningful on ELF platforms which support shared |
1152 | libraries. | |
1153 | ||
55255dae L |
1154 | @kindex --dynamic-list=@var{dynamic-list-file} |
1155 | @item --dynamic-list=@var{dynamic-list-file} | |
1156 | Specify the name of a dynamic list file to the linker. This is | |
1157 | typically used when creating shared libraries to specify a list of | |
1158 | global symbols whose references shouldn't be bound to the definition | |
1159 | within the shared library, or creating dynamically linked executables | |
1160 | to specify a list of symbols which should be added to the symbol table | |
1161 | in the executable. This option is only meaningful on ELF platforms | |
1162 | which support shared libraries. | |
1163 | ||
1164 | The format of the dynamic list is the same as the version node without | |
1165 | scope and node name. See @ref{VERSION} for more information. | |
1166 | ||
40b36307 L |
1167 | @kindex --dynamic-list-data |
1168 | @item --dynamic-list-data | |
1169 | Include all global data symbols to the dynamic list. | |
1170 | ||
1171 | @kindex --dynamic-list-cpp-new | |
1172 | @item --dynamic-list-cpp-new | |
1173 | Provide the builtin dynamic list for C++ operator new and delete. It | |
1174 | is mainly useful for building shared libstdc++. | |
1175 | ||
0b8a70d9 L |
1176 | @kindex --dynamic-list-cpp-typeinfo |
1177 | @item --dynamic-list-cpp-typeinfo | |
1178 | Provide the builtin dynamic list for C++ runtime type identification. | |
1179 | ||
252b5132 RH |
1180 | @kindex --check-sections |
1181 | @kindex --no-check-sections | |
1182 | @item --check-sections | |
308b1ffd | 1183 | @itemx --no-check-sections |
252b5132 | 1184 | Asks the linker @emph{not} to check section addresses after they have |
7d816a17 | 1185 | been assigned to see if there are any overlaps. Normally the linker will |
252b5132 RH |
1186 | perform this check, and if it finds any overlaps it will produce |
1187 | suitable error messages. The linker does know about, and does make | |
1188 | allowances for sections in overlays. The default behaviour can be | |
560e09e9 | 1189 | restored by using the command line switch @option{--check-sections}. |
252b5132 RH |
1190 | |
1191 | @cindex cross reference table | |
1192 | @kindex --cref | |
1193 | @item --cref | |
1194 | Output a cross reference table. If a linker map file is being | |
1195 | generated, the cross reference table is printed to the map file. | |
1196 | Otherwise, it is printed on the standard output. | |
1197 | ||
1198 | The format of the table is intentionally simple, so that it may be | |
1199 | easily processed by a script if necessary. The symbols are printed out, | |
1200 | sorted by name. For each symbol, a list of file names is given. If the | |
1201 | symbol is defined, the first file listed is the location of the | |
1202 | definition. The remaining files contain references to the symbol. | |
1203 | ||
4818e05f AM |
1204 | @cindex common allocation |
1205 | @kindex --no-define-common | |
1206 | @item --no-define-common | |
1207 | This option inhibits the assignment of addresses to common symbols. | |
1208 | The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect. | |
1209 | @xref{Miscellaneous Commands}. | |
1210 | ||
1211 | The @samp{--no-define-common} option allows decoupling | |
1212 | the decision to assign addresses to Common symbols from the choice | |
1213 | of the output file type; otherwise a non-Relocatable output type | |
1214 | forces assigning addresses to Common symbols. | |
1215 | Using @samp{--no-define-common} allows Common symbols that are referenced | |
1216 | from a shared library to be assigned addresses only in the main program. | |
1217 | This eliminates the unused duplicate space in the shared library, | |
1218 | and also prevents any possible confusion over resolving to the wrong | |
1219 | duplicate when there are many dynamic modules with specialized search | |
1220 | paths for runtime symbol resolution. | |
1221 | ||
252b5132 RH |
1222 | @cindex symbols, from command line |
1223 | @kindex --defsym @var{symbol}=@var{exp} | |
1224 | @item --defsym @var{symbol}=@var{expression} | |
1225 | Create a global symbol in the output file, containing the absolute | |
1226 | address given by @var{expression}. You may use this option as many | |
1227 | times as necessary to define multiple symbols in the command line. A | |
1228 | limited form of arithmetic is supported for the @var{expression} in this | |
1229 | context: you may give a hexadecimal constant or the name of an existing | |
1230 | symbol, or use @code{+} and @code{-} to add or subtract hexadecimal | |
1231 | constants or symbols. If you need more elaborate expressions, consider | |
1232 | using the linker command language from a script (@pxref{Assignments,, | |
1233 | Assignment: Symbol Definitions}). @emph{Note:} there should be no white | |
1234 | space between @var{symbol}, the equals sign (``@key{=}''), and | |
1235 | @var{expression}. | |
1236 | ||
1237 | @cindex demangling, from command line | |
28c309a2 | 1238 | @kindex --demangle[=@var{style}] |
252b5132 | 1239 | @kindex --no-demangle |
28c309a2 | 1240 | @item --demangle[=@var{style}] |
252b5132 RH |
1241 | @itemx --no-demangle |
1242 | These options control whether to demangle symbol names in error messages | |
1243 | and other output. When the linker is told to demangle, it tries to | |
1244 | present symbol names in a readable fashion: it strips leading | |
1245 | underscores if they are used by the object file format, and converts C++ | |
a1ab1d2a UD |
1246 | mangled symbol names into user readable names. Different compilers have |
1247 | different mangling styles. The optional demangling style argument can be used | |
1248 | to choose an appropriate demangling style for your compiler. The linker will | |
28c309a2 NC |
1249 | demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE} |
1250 | is set. These options may be used to override the default. | |
252b5132 RH |
1251 | |
1252 | @cindex dynamic linker, from command line | |
506eee22 | 1253 | @kindex -I@var{file} |
252b5132 RH |
1254 | @kindex --dynamic-linker @var{file} |
1255 | @item --dynamic-linker @var{file} | |
1256 | Set the name of the dynamic linker. This is only meaningful when | |
1257 | generating dynamically linked ELF executables. The default dynamic | |
1258 | linker is normally correct; don't use this unless you know what you are | |
1259 | doing. | |
1260 | ||
7ce691ae C |
1261 | |
1262 | @kindex --fatal-warnings | |
1263 | @item --fatal-warnings | |
1264 | Treat all warnings as errors. | |
1265 | ||
252b5132 RH |
1266 | @kindex --force-exe-suffix |
1267 | @item --force-exe-suffix | |
1268 | Make sure that an output file has a .exe suffix. | |
1269 | ||
1270 | If a successfully built fully linked output file does not have a | |
1271 | @code{.exe} or @code{.dll} suffix, this option forces the linker to copy | |
1272 | the output file to one of the same name with a @code{.exe} suffix. This | |
1273 | option is useful when using unmodified Unix makefiles on a Microsoft | |
1274 | Windows host, since some versions of Windows won't run an image unless | |
1275 | it ends in a @code{.exe} suffix. | |
1276 | ||
1277 | @kindex --gc-sections | |
1278 | @kindex --no-gc-sections | |
1279 | @cindex garbage collection | |
c17d87de NC |
1280 | @item --gc-sections |
1281 | @itemx --no-gc-sections | |
252b5132 RH |
1282 | Enable garbage collection of unused input sections. It is ignored on |
1283 | targets that do not support this option. This option is not compatible | |
b3549761 NC |
1284 | with @samp{-r} or @samp{--emit-relocs}. The default behaviour (of not |
1285 | performing this garbage collection) can be restored by specifying | |
1286 | @samp{--no-gc-sections} on the command line. | |
252b5132 | 1287 | |
c17d87de NC |
1288 | @kindex --print-gc-sections |
1289 | @kindex --no-print-gc-sections | |
1290 | @cindex garbage collection | |
1291 | @item --print-gc-sections | |
1292 | @itemx --no-print-gc-sections | |
1293 | List all sections removed by garbage collection. The listing is | |
1294 | printed on stderr. This option is only effective if garbage | |
1295 | collection has been enabled via the @samp{--gc-sections}) option. The | |
1296 | default behaviour (of not listing the sections that are removed) can | |
1297 | be restored by specifying @samp{--no-print-gc-sections} on the command | |
1298 | line. | |
1299 | ||
252b5132 RH |
1300 | @cindex help |
1301 | @cindex usage | |
1302 | @kindex --help | |
1303 | @item --help | |
1304 | Print a summary of the command-line options on the standard output and exit. | |
1305 | ||
ea20a7da CC |
1306 | @kindex --target-help |
1307 | @item --target-help | |
1308 | Print a summary of all target specific options on the standard output and exit. | |
1309 | ||
252b5132 RH |
1310 | @kindex -Map |
1311 | @item -Map @var{mapfile} | |
1312 | Print a link map to the file @var{mapfile}. See the description of the | |
560e09e9 | 1313 | @option{-M} option, above. |
252b5132 RH |
1314 | |
1315 | @cindex memory usage | |
1316 | @kindex --no-keep-memory | |
1317 | @item --no-keep-memory | |
ff5dcc92 SC |
1318 | @command{ld} normally optimizes for speed over memory usage by caching the |
1319 | symbol tables of input files in memory. This option tells @command{ld} to | |
252b5132 | 1320 | instead optimize for memory usage, by rereading the symbol tables as |
ff5dcc92 | 1321 | necessary. This may be required if @command{ld} runs out of memory space |
252b5132 RH |
1322 | while linking a large executable. |
1323 | ||
1324 | @kindex --no-undefined | |
a1ab1d2a | 1325 | @kindex -z defs |
252b5132 | 1326 | @item --no-undefined |
a1ab1d2a | 1327 | @itemx -z defs |
560e09e9 NC |
1328 | Report unresolved symbol references from regular object files. This |
1329 | is done even if the linker is creating a non-symbolic shared library. | |
1330 | The switch @option{--[no-]allow-shlib-undefined} controls the | |
1331 | behaviour for reporting unresolved references found in shared | |
ece2d90e | 1332 | libraries being linked in. |
252b5132 | 1333 | |
aa713662 L |
1334 | @kindex --allow-multiple-definition |
1335 | @kindex -z muldefs | |
1336 | @item --allow-multiple-definition | |
1337 | @itemx -z muldefs | |
1338 | Normally when a symbol is defined multiple times, the linker will | |
1339 | report a fatal error. These options allow multiple definitions and the | |
1340 | first definition will be used. | |
1341 | ||
b79e8c78 | 1342 | @kindex --allow-shlib-undefined |
ae9a127f | 1343 | @kindex --no-allow-shlib-undefined |
b79e8c78 | 1344 | @item --allow-shlib-undefined |
ae9a127f | 1345 | @itemx --no-allow-shlib-undefined |
560e09e9 NC |
1346 | Allows (the default) or disallows undefined symbols in shared libraries. |
1347 | This switch is similar to @option{--no-undefined} except that it | |
1348 | determines the behaviour when the undefined symbols are in a | |
1349 | shared library rather than a regular object file. It does not affect | |
1350 | how undefined symbols in regular object files are handled. | |
1351 | ||
1352 | The reason that @option{--allow-shlib-undefined} is the default is that | |
1353 | the shared library being specified at link time may not be the same as | |
1354 | the one that is available at load time, so the symbols might actually be | |
ae9a127f | 1355 | resolvable at load time. Plus there are some systems, (eg BeOS) where |
560e09e9 | 1356 | undefined symbols in shared libraries is normal. (The kernel patches |
ece2d90e | 1357 | them at load time to select which function is most appropriate |
560e09e9 NC |
1358 | for the current architecture. This is used for example to dynamically |
1359 | select an appropriate memset function). Apparently it is also normal | |
1360 | for HPPA shared libraries to have undefined symbols. | |
b79e8c78 | 1361 | |
31941635 L |
1362 | @kindex --no-undefined-version |
1363 | @item --no-undefined-version | |
1364 | Normally when a symbol has an undefined version, the linker will ignore | |
1365 | it. This option disallows symbols with undefined version and a fatal error | |
1366 | will be issued instead. | |
1367 | ||
3e3b46e5 PB |
1368 | @kindex --default-symver |
1369 | @item --default-symver | |
1370 | Create and use a default symbol version (the soname) for unversioned | |
fc0e6df6 PB |
1371 | exported symbols. |
1372 | ||
1373 | @kindex --default-imported-symver | |
1374 | @item --default-imported-symver | |
1375 | Create and use a default symbol version (the soname) for unversioned | |
1376 | imported symbols. | |
3e3b46e5 | 1377 | |
252b5132 RH |
1378 | @kindex --no-warn-mismatch |
1379 | @item --no-warn-mismatch | |
ff5dcc92 | 1380 | Normally @command{ld} will give an error if you try to link together input |
252b5132 RH |
1381 | files that are mismatched for some reason, perhaps because they have |
1382 | been compiled for different processors or for different endiannesses. | |
ff5dcc92 | 1383 | This option tells @command{ld} that it should silently permit such possible |
252b5132 RH |
1384 | errors. This option should only be used with care, in cases when you |
1385 | have taken some special action that ensures that the linker errors are | |
1386 | inappropriate. | |
1387 | ||
fe7929ce AM |
1388 | @kindex --no-warn-search-mismatch |
1389 | @item --no-warn-search-mismatch | |
1390 | Normally @command{ld} will give a warning if it finds an incompatible | |
1391 | library during a library search. This option silences the warning. | |
1392 | ||
252b5132 RH |
1393 | @kindex --no-whole-archive |
1394 | @item --no-whole-archive | |
ff5dcc92 | 1395 | Turn off the effect of the @option{--whole-archive} option for subsequent |
252b5132 RH |
1396 | archive files. |
1397 | ||
1398 | @cindex output file after errors | |
1399 | @kindex --noinhibit-exec | |
1400 | @item --noinhibit-exec | |
1401 | Retain the executable output file whenever it is still usable. | |
1402 | Normally, the linker will not produce an output file if it encounters | |
1403 | errors during the link process; it exits without writing an output file | |
1404 | when it issues any error whatsoever. | |
1405 | ||
0a9c1c8e CD |
1406 | @kindex -nostdlib |
1407 | @item -nostdlib | |
1408 | Only search library directories explicitly specified on the | |
1409 | command line. Library directories specified in linker scripts | |
1410 | (including linker scripts specified on the command line) are ignored. | |
1411 | ||
252b5132 RH |
1412 | @ifclear SingleFormat |
1413 | @kindex --oformat | |
1414 | @item --oformat @var{output-format} | |
ff5dcc92 SC |
1415 | @command{ld} may be configured to support more than one kind of object |
1416 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 1417 | @samp{--oformat} option to specify the binary format for the output |
ff5dcc92 SC |
1418 | object file. Even when @command{ld} is configured to support alternative |
1419 | object formats, you don't usually need to specify this, as @command{ld} | |
252b5132 RH |
1420 | should be configured to produce as a default output format the most |
1421 | usual format on each machine. @var{output-format} is a text string, the | |
1422 | name of a particular format supported by the BFD libraries. (You can | |
1423 | list the available binary formats with @samp{objdump -i}.) The script | |
1424 | command @code{OUTPUT_FORMAT} can also specify the output format, but | |
1425 | this option overrides it. @xref{BFD}. | |
1426 | @end ifclear | |
1427 | ||
36af4a4e JJ |
1428 | @kindex -pie |
1429 | @kindex --pic-executable | |
1430 | @item -pie | |
1431 | @itemx --pic-executable | |
1432 | @cindex position independent executables | |
1433 | Create a position independent executable. This is currently only supported on | |
1434 | ELF platforms. Position independent executables are similar to shared | |
1435 | libraries in that they are relocated by the dynamic linker to the virtual | |
7e7d5768 | 1436 | address the OS chooses for them (which can vary between invocations). Like |
36af4a4e JJ |
1437 | normal dynamically linked executables they can be executed and symbols |
1438 | defined in the executable cannot be overridden by shared libraries. | |
1439 | ||
252b5132 RH |
1440 | @kindex -qmagic |
1441 | @item -qmagic | |
1442 | This option is ignored for Linux compatibility. | |
1443 | ||
1444 | @kindex -Qy | |
1445 | @item -Qy | |
1446 | This option is ignored for SVR4 compatibility. | |
1447 | ||
1448 | @kindex --relax | |
1449 | @cindex synthesizing linker | |
1450 | @cindex relaxing addressing modes | |
1451 | @item --relax | |
a1ab1d2a | 1452 | An option with machine dependent effects. |
252b5132 RH |
1453 | @ifset GENERIC |
1454 | This option is only supported on a few targets. | |
1455 | @end ifset | |
1456 | @ifset H8300 | |
ff5dcc92 | 1457 | @xref{H8/300,,@command{ld} and the H8/300}. |
252b5132 RH |
1458 | @end ifset |
1459 | @ifset I960 | |
ff5dcc92 | 1460 | @xref{i960,, @command{ld} and the Intel 960 family}. |
252b5132 | 1461 | @end ifset |
e0001a05 NC |
1462 | @ifset XTENSA |
1463 | @xref{Xtensa,, @command{ld} and Xtensa Processors}. | |
1464 | @end ifset | |
93fd0973 SC |
1465 | @ifset M68HC11 |
1466 | @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}. | |
1467 | @end ifset | |
2a60a7a8 AM |
1468 | @ifset POWERPC |
1469 | @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}. | |
1470 | @end ifset | |
252b5132 RH |
1471 | |
1472 | On some platforms, the @samp{--relax} option performs global | |
1473 | optimizations that become possible when the linker resolves addressing | |
1474 | in the program, such as relaxing address modes and synthesizing new | |
1475 | instructions in the output object file. | |
1476 | ||
1477 | On some platforms these link time global optimizations may make symbolic | |
1478 | debugging of the resulting executable impossible. | |
1479 | @ifset GENERIC | |
1480 | This is known to be | |
1481 | the case for the Matsushita MN10200 and MN10300 family of processors. | |
1482 | @end ifset | |
1483 | ||
1484 | @ifset GENERIC | |
1485 | On platforms where this is not supported, @samp{--relax} is accepted, | |
1486 | but ignored. | |
1487 | @end ifset | |
1488 | ||
1489 | @cindex retaining specified symbols | |
1490 | @cindex stripping all but some symbols | |
1491 | @cindex symbols, retaining selectively | |
1492 | @item --retain-symbols-file @var{filename} | |
1493 | Retain @emph{only} the symbols listed in the file @var{filename}, | |
1494 | discarding all others. @var{filename} is simply a flat file, with one | |
1495 | symbol name per line. This option is especially useful in environments | |
1496 | @ifset GENERIC | |
1497 | (such as VxWorks) | |
1498 | @end ifset | |
1499 | where a large global symbol table is accumulated gradually, to conserve | |
1500 | run-time memory. | |
1501 | ||
1502 | @samp{--retain-symbols-file} does @emph{not} discard undefined symbols, | |
1503 | or symbols needed for relocations. | |
1504 | ||
1505 | You may only specify @samp{--retain-symbols-file} once in the command | |
1506 | line. It overrides @samp{-s} and @samp{-S}. | |
1507 | ||
1508 | @ifset GENERIC | |
1509 | @item -rpath @var{dir} | |
1510 | @cindex runtime library search path | |
1511 | @kindex -rpath | |
1512 | Add a directory to the runtime library search path. This is used when | |
ff5dcc92 | 1513 | linking an ELF executable with shared objects. All @option{-rpath} |
252b5132 | 1514 | arguments are concatenated and passed to the runtime linker, which uses |
ff5dcc92 | 1515 | them to locate shared objects at runtime. The @option{-rpath} option is |
252b5132 RH |
1516 | also used when locating shared objects which are needed by shared |
1517 | objects explicitly included in the link; see the description of the | |
ff5dcc92 | 1518 | @option{-rpath-link} option. If @option{-rpath} is not used when linking an |
252b5132 RH |
1519 | ELF executable, the contents of the environment variable |
1520 | @code{LD_RUN_PATH} will be used if it is defined. | |
1521 | ||
ff5dcc92 | 1522 | The @option{-rpath} option may also be used on SunOS. By default, on |
252b5132 | 1523 | SunOS, the linker will form a runtime search patch out of all the |
ff5dcc92 SC |
1524 | @option{-L} options it is given. If a @option{-rpath} option is used, the |
1525 | runtime search path will be formed exclusively using the @option{-rpath} | |
1526 | options, ignoring the @option{-L} options. This can be useful when using | |
1527 | gcc, which adds many @option{-L} options which may be on NFS mounted | |
b45619c0 | 1528 | file systems. |
252b5132 | 1529 | |
ff5dcc92 | 1530 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 1531 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 1532 | the @option{-rpath} option. |
252b5132 RH |
1533 | @end ifset |
1534 | ||
1535 | @ifset GENERIC | |
1536 | @cindex link-time runtime library search path | |
1537 | @kindex -rpath-link | |
1538 | @item -rpath-link @var{DIR} | |
1539 | When using ELF or SunOS, one shared library may require another. This | |
1540 | happens when an @code{ld -shared} link includes a shared library as one | |
1541 | of the input files. | |
1542 | ||
1543 | When the linker encounters such a dependency when doing a non-shared, | |
1544 | non-relocatable link, it will automatically try to locate the required | |
1545 | shared library and include it in the link, if it is not included | |
ff5dcc92 | 1546 | explicitly. In such a case, the @option{-rpath-link} option |
252b5132 | 1547 | specifies the first set of directories to search. The |
ff5dcc92 | 1548 | @option{-rpath-link} option may specify a sequence of directory names |
252b5132 RH |
1549 | either by specifying a list of names separated by colons, or by |
1550 | appearing multiple times. | |
1551 | ||
28c309a2 NC |
1552 | This option should be used with caution as it overrides the search path |
1553 | that may have been hard compiled into a shared library. In such a case it | |
1554 | is possible to use unintentionally a different search path than the | |
1555 | runtime linker would do. | |
1556 | ||
252b5132 | 1557 | The linker uses the following search paths to locate required shared |
ece2d90e | 1558 | libraries: |
252b5132 RH |
1559 | @enumerate |
1560 | @item | |
ff5dcc92 | 1561 | Any directories specified by @option{-rpath-link} options. |
252b5132 | 1562 | @item |
ff5dcc92 SC |
1563 | Any directories specified by @option{-rpath} options. The difference |
1564 | between @option{-rpath} and @option{-rpath-link} is that directories | |
1565 | specified by @option{-rpath} options are included in the executable and | |
1566 | used at runtime, whereas the @option{-rpath-link} option is only effective | |
ece2d90e NC |
1567 | at link time. Searching @option{-rpath} in this way is only supported |
1568 | by native linkers and cross linkers which have been configured with | |
1569 | the @option{--with-sysroot} option. | |
252b5132 | 1570 | @item |
ff5dcc92 | 1571 | On an ELF system, if the @option{-rpath} and @code{rpath-link} options |
252b5132 | 1572 | were not used, search the contents of the environment variable |
dcb0bd0e | 1573 | @code{LD_RUN_PATH}. It is for the native linker only. |
252b5132 | 1574 | @item |
ff5dcc92 SC |
1575 | On SunOS, if the @option{-rpath} option was not used, search any |
1576 | directories specified using @option{-L} options. | |
252b5132 RH |
1577 | @item |
1578 | For a native linker, the contents of the environment variable | |
1579 | @code{LD_LIBRARY_PATH}. | |
1580 | @item | |
ec4eb78a L |
1581 | For a native ELF linker, the directories in @code{DT_RUNPATH} or |
1582 | @code{DT_RPATH} of a shared library are searched for shared | |
1583 | libraries needed by it. The @code{DT_RPATH} entries are ignored if | |
1584 | @code{DT_RUNPATH} entries exist. | |
1585 | @item | |
252b5132 RH |
1586 | The default directories, normally @file{/lib} and @file{/usr/lib}. |
1587 | @item | |
1588 | For a native linker on an ELF system, if the file @file{/etc/ld.so.conf} | |
1589 | exists, the list of directories found in that file. | |
1590 | @end enumerate | |
1591 | ||
1592 | If the required shared library is not found, the linker will issue a | |
1593 | warning and continue with the link. | |
1594 | @end ifset | |
1595 | ||
1596 | @kindex -shared | |
1597 | @kindex -Bshareable | |
1598 | @item -shared | |
1599 | @itemx -Bshareable | |
1600 | @cindex shared libraries | |
1601 | Create a shared library. This is currently only supported on ELF, XCOFF | |
1602 | and SunOS platforms. On SunOS, the linker will automatically create a | |
ff5dcc92 | 1603 | shared library if the @option{-e} option is not used and there are |
252b5132 RH |
1604 | undefined symbols in the link. |
1605 | ||
1606 | @item --sort-common | |
1607 | @kindex --sort-common | |
ff5dcc92 | 1608 | This option tells @command{ld} to sort the common symbols by size when it |
252b5132 | 1609 | places them in the appropriate output sections. First come all the one |
563e308f | 1610 | byte symbols, then all the two byte, then all the four byte, and then |
252b5132 RH |
1611 | everything else. This is to prevent gaps between symbols due to |
1612 | alignment constraints. | |
1613 | ||
bcaa7b3e L |
1614 | @kindex --sort-section name |
1615 | @item --sort-section name | |
1616 | This option will apply @code{SORT_BY_NAME} to all wildcard section | |
1617 | patterns in the linker script. | |
1618 | ||
1619 | @kindex --sort-section alignment | |
1620 | @item --sort-section alignment | |
1621 | This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section | |
1622 | patterns in the linker script. | |
1623 | ||
252b5132 | 1624 | @kindex --split-by-file |
a854a4a7 | 1625 | @item --split-by-file [@var{size}] |
ff5dcc92 | 1626 | Similar to @option{--split-by-reloc} but creates a new output section for |
a854a4a7 AM |
1627 | each input file when @var{size} is reached. @var{size} defaults to a |
1628 | size of 1 if not given. | |
252b5132 RH |
1629 | |
1630 | @kindex --split-by-reloc | |
a854a4a7 AM |
1631 | @item --split-by-reloc [@var{count}] |
1632 | Tries to creates extra sections in the output file so that no single | |
252b5132 | 1633 | output section in the file contains more than @var{count} relocations. |
a854a4a7 | 1634 | This is useful when generating huge relocatable files for downloading into |
252b5132 RH |
1635 | certain real time kernels with the COFF object file format; since COFF |
1636 | cannot represent more than 65535 relocations in a single section. Note | |
1637 | that this will fail to work with object file formats which do not | |
1638 | support arbitrary sections. The linker will not split up individual | |
1639 | input sections for redistribution, so if a single input section contains | |
1640 | more than @var{count} relocations one output section will contain that | |
a854a4a7 | 1641 | many relocations. @var{count} defaults to a value of 32768. |
252b5132 RH |
1642 | |
1643 | @kindex --stats | |
1644 | @item --stats | |
1645 | Compute and display statistics about the operation of the linker, such | |
1646 | as execution time and memory usage. | |
1647 | ||
e2243057 RS |
1648 | @kindex --sysroot |
1649 | @item --sysroot=@var{directory} | |
1650 | Use @var{directory} as the location of the sysroot, overriding the | |
1651 | configure-time default. This option is only supported by linkers | |
1652 | that were configured using @option{--with-sysroot}. | |
1653 | ||
252b5132 RH |
1654 | @kindex --traditional-format |
1655 | @cindex traditional format | |
1656 | @item --traditional-format | |
ff5dcc92 SC |
1657 | For some targets, the output of @command{ld} is different in some ways from |
1658 | the output of some existing linker. This switch requests @command{ld} to | |
252b5132 RH |
1659 | use the traditional format instead. |
1660 | ||
1661 | @cindex dbx | |
ff5dcc92 | 1662 | For example, on SunOS, @command{ld} combines duplicate entries in the |
252b5132 RH |
1663 | symbol string table. This can reduce the size of an output file with |
1664 | full debugging information by over 30 percent. Unfortunately, the SunOS | |
1665 | @code{dbx} program can not read the resulting program (@code{gdb} has no | |
ff5dcc92 | 1666 | trouble). The @samp{--traditional-format} switch tells @command{ld} to not |
252b5132 RH |
1667 | combine duplicate entries. |
1668 | ||
176355da NC |
1669 | @kindex --section-start @var{sectionname}=@var{org} |
1670 | @item --section-start @var{sectionname}=@var{org} | |
1671 | Locate a section in the output file at the absolute | |
1672 | address given by @var{org}. You may use this option as many | |
1673 | times as necessary to locate multiple sections in the command | |
1674 | line. | |
1675 | @var{org} must be a single hexadecimal integer; | |
1676 | for compatibility with other linkers, you may omit the leading | |
1677 | @samp{0x} usually associated with hexadecimal values. @emph{Note:} there | |
1678 | should be no white space between @var{sectionname}, the equals | |
1679 | sign (``@key{=}''), and @var{org}. | |
1680 | ||
252b5132 RH |
1681 | @kindex -Tbss @var{org} |
1682 | @kindex -Tdata @var{org} | |
1683 | @kindex -Ttext @var{org} | |
1684 | @cindex segment origins, cmd line | |
1685 | @item -Tbss @var{org} | |
1686 | @itemx -Tdata @var{org} | |
1687 | @itemx -Ttext @var{org} | |
a6e02871 AO |
1688 | Same as --section-start, with @code{.bss}, @code{.data} or |
1689 | @code{.text} as the @var{sectionname}. | |
252b5132 | 1690 | |
560e09e9 NC |
1691 | @kindex --unresolved-symbols |
1692 | @item --unresolved-symbols=@var{method} | |
1693 | Determine how to handle unresolved symbols. There are four possible | |
1694 | values for @samp{method}: | |
1695 | ||
1696 | @table @samp | |
1697 | @item ignore-all | |
da8bce14 | 1698 | Do not report any unresolved symbols. |
560e09e9 NC |
1699 | |
1700 | @item report-all | |
da8bce14 | 1701 | Report all unresolved symbols. This is the default. |
560e09e9 NC |
1702 | |
1703 | @item ignore-in-object-files | |
1704 | Report unresolved symbols that are contained in shared libraries, but | |
1705 | ignore them if they come from regular object files. | |
1706 | ||
1707 | @item ignore-in-shared-libs | |
1708 | Report unresolved symbols that come from regular object files, but | |
1709 | ignore them if they come from shared libraries. This can be useful | |
1710 | when creating a dynamic binary and it is known that all the shared | |
1711 | libraries that it should be referencing are included on the linker's | |
1712 | command line. | |
1713 | @end table | |
1714 | ||
1715 | The behaviour for shared libraries on their own can also be controlled | |
1716 | by the @option{--[no-]allow-shlib-undefined} option. | |
1717 | ||
1718 | Normally the linker will generate an error message for each reported | |
1719 | unresolved symbol but the option @option{--warn-unresolved-symbols} | |
1720 | can change this to a warning. | |
1721 | ||
252b5132 RH |
1722 | @kindex --verbose |
1723 | @cindex verbose | |
1724 | @item --dll-verbose | |
308b1ffd | 1725 | @itemx --verbose |
ff5dcc92 | 1726 | Display the version number for @command{ld} and list the linker emulations |
252b5132 | 1727 | supported. Display which input files can and cannot be opened. Display |
b9a8de1e | 1728 | the linker script being used by the linker. |
252b5132 RH |
1729 | |
1730 | @kindex --version-script=@var{version-scriptfile} | |
1731 | @cindex version script, symbol versions | |
1732 | @itemx --version-script=@var{version-scriptfile} | |
1733 | Specify the name of a version script to the linker. This is typically | |
1734 | used when creating shared libraries to specify additional information | |
36f63dca | 1735 | about the version hierarchy for the library being created. This option |
252b5132 RH |
1736 | is only meaningful on ELF platforms which support shared libraries. |
1737 | @xref{VERSION}. | |
1738 | ||
7ce691ae | 1739 | @kindex --warn-common |
252b5132 RH |
1740 | @cindex warnings, on combining symbols |
1741 | @cindex combining symbols, warnings on | |
1742 | @item --warn-common | |
1743 | Warn when a common symbol is combined with another common symbol or with | |
560e09e9 | 1744 | a symbol definition. Unix linkers allow this somewhat sloppy practise, |
252b5132 RH |
1745 | but linkers on some other operating systems do not. This option allows |
1746 | you to find potential problems from combining global symbols. | |
560e09e9 | 1747 | Unfortunately, some C libraries use this practise, so you may get some |
252b5132 RH |
1748 | warnings about symbols in the libraries as well as in your programs. |
1749 | ||
1750 | There are three kinds of global symbols, illustrated here by C examples: | |
1751 | ||
1752 | @table @samp | |
1753 | @item int i = 1; | |
1754 | A definition, which goes in the initialized data section of the output | |
1755 | file. | |
1756 | ||
1757 | @item extern int i; | |
1758 | An undefined reference, which does not allocate space. | |
1759 | There must be either a definition or a common symbol for the | |
1760 | variable somewhere. | |
1761 | ||
1762 | @item int i; | |
1763 | A common symbol. If there are only (one or more) common symbols for a | |
1764 | variable, it goes in the uninitialized data area of the output file. | |
1765 | The linker merges multiple common symbols for the same variable into a | |
1766 | single symbol. If they are of different sizes, it picks the largest | |
1767 | size. The linker turns a common symbol into a declaration, if there is | |
1768 | a definition of the same variable. | |
1769 | @end table | |
1770 | ||
1771 | The @samp{--warn-common} option can produce five kinds of warnings. | |
1772 | Each warning consists of a pair of lines: the first describes the symbol | |
1773 | just encountered, and the second describes the previous symbol | |
1774 | encountered with the same name. One or both of the two symbols will be | |
1775 | a common symbol. | |
1776 | ||
1777 | @enumerate | |
1778 | @item | |
1779 | Turning a common symbol into a reference, because there is already a | |
1780 | definition for the symbol. | |
1781 | @smallexample | |
1782 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1783 | overridden by definition | |
1784 | @var{file}(@var{section}): warning: defined here | |
1785 | @end smallexample | |
1786 | ||
1787 | @item | |
1788 | Turning a common symbol into a reference, because a later definition for | |
1789 | the symbol is encountered. This is the same as the previous case, | |
1790 | except that the symbols are encountered in a different order. | |
1791 | @smallexample | |
1792 | @var{file}(@var{section}): warning: definition of `@var{symbol}' | |
1793 | overriding common | |
1794 | @var{file}(@var{section}): warning: common is here | |
1795 | @end smallexample | |
1796 | ||
1797 | @item | |
1798 | Merging a common symbol with a previous same-sized common symbol. | |
1799 | @smallexample | |
1800 | @var{file}(@var{section}): warning: multiple common | |
1801 | of `@var{symbol}' | |
1802 | @var{file}(@var{section}): warning: previous common is here | |
1803 | @end smallexample | |
1804 | ||
1805 | @item | |
1806 | Merging a common symbol with a previous larger common symbol. | |
1807 | @smallexample | |
1808 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1809 | overridden by larger common | |
1810 | @var{file}(@var{section}): warning: larger common is here | |
1811 | @end smallexample | |
1812 | ||
1813 | @item | |
1814 | Merging a common symbol with a previous smaller common symbol. This is | |
1815 | the same as the previous case, except that the symbols are | |
1816 | encountered in a different order. | |
1817 | @smallexample | |
1818 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1819 | overriding smaller common | |
1820 | @var{file}(@var{section}): warning: smaller common is here | |
1821 | @end smallexample | |
1822 | @end enumerate | |
1823 | ||
1824 | @kindex --warn-constructors | |
1825 | @item --warn-constructors | |
1826 | Warn if any global constructors are used. This is only useful for a few | |
1827 | object file formats. For formats like COFF or ELF, the linker can not | |
1828 | detect the use of global constructors. | |
1829 | ||
1830 | @kindex --warn-multiple-gp | |
1831 | @item --warn-multiple-gp | |
1832 | Warn if multiple global pointer values are required in the output file. | |
1833 | This is only meaningful for certain processors, such as the Alpha. | |
1834 | Specifically, some processors put large-valued constants in a special | |
1835 | section. A special register (the global pointer) points into the middle | |
1836 | of this section, so that constants can be loaded efficiently via a | |
1837 | base-register relative addressing mode. Since the offset in | |
1838 | base-register relative mode is fixed and relatively small (e.g., 16 | |
1839 | bits), this limits the maximum size of the constant pool. Thus, in | |
1840 | large programs, it is often necessary to use multiple global pointer | |
1841 | values in order to be able to address all possible constants. This | |
1842 | option causes a warning to be issued whenever this case occurs. | |
1843 | ||
1844 | @kindex --warn-once | |
1845 | @cindex warnings, on undefined symbols | |
1846 | @cindex undefined symbols, warnings on | |
1847 | @item --warn-once | |
1848 | Only warn once for each undefined symbol, rather than once per module | |
1849 | which refers to it. | |
1850 | ||
1851 | @kindex --warn-section-align | |
1852 | @cindex warnings, on section alignment | |
1853 | @cindex section alignment, warnings on | |
1854 | @item --warn-section-align | |
1855 | Warn if the address of an output section is changed because of | |
1856 | alignment. Typically, the alignment will be set by an input section. | |
1857 | The address will only be changed if it not explicitly specified; that | |
1858 | is, if the @code{SECTIONS} command does not specify a start address for | |
1859 | the section (@pxref{SECTIONS}). | |
1860 | ||
8fdd7217 NC |
1861 | @kindex --warn-shared-textrel |
1862 | @item --warn-shared-textrel | |
ece2d90e | 1863 | Warn if the linker adds a DT_TEXTREL to a shared object. |
8fdd7217 | 1864 | |
560e09e9 NC |
1865 | @kindex --warn-unresolved-symbols |
1866 | @item --warn-unresolved-symbols | |
1867 | If the linker is going to report an unresolved symbol (see the option | |
1868 | @option{--unresolved-symbols}) it will normally generate an error. | |
1869 | This option makes it generate a warning instead. | |
1870 | ||
1871 | @kindex --error-unresolved-symbols | |
1872 | @item --error-unresolved-symbols | |
1873 | This restores the linker's default behaviour of generating errors when | |
1874 | it is reporting unresolved symbols. | |
1875 | ||
252b5132 RH |
1876 | @kindex --whole-archive |
1877 | @cindex including an entire archive | |
1878 | @item --whole-archive | |
1879 | For each archive mentioned on the command line after the | |
ff5dcc92 | 1880 | @option{--whole-archive} option, include every object file in the archive |
252b5132 RH |
1881 | in the link, rather than searching the archive for the required object |
1882 | files. This is normally used to turn an archive file into a shared | |
1883 | library, forcing every object to be included in the resulting shared | |
1884 | library. This option may be used more than once. | |
1885 | ||
7ec229ce | 1886 | Two notes when using this option from gcc: First, gcc doesn't know |
ff5dcc92 SC |
1887 | about this option, so you have to use @option{-Wl,-whole-archive}. |
1888 | Second, don't forget to use @option{-Wl,-no-whole-archive} after your | |
7ec229ce DD |
1889 | list of archives, because gcc will add its own list of archives to |
1890 | your link and you may not want this flag to affect those as well. | |
1891 | ||
252b5132 RH |
1892 | @kindex --wrap |
1893 | @item --wrap @var{symbol} | |
1894 | Use a wrapper function for @var{symbol}. Any undefined reference to | |
1895 | @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any | |
1896 | undefined reference to @code{__real_@var{symbol}} will be resolved to | |
1897 | @var{symbol}. | |
1898 | ||
1899 | This can be used to provide a wrapper for a system function. The | |
1900 | wrapper function should be called @code{__wrap_@var{symbol}}. If it | |
1901 | wishes to call the system function, it should call | |
1902 | @code{__real_@var{symbol}}. | |
1903 | ||
1904 | Here is a trivial example: | |
1905 | ||
1906 | @smallexample | |
1907 | void * | |
cc2f008e | 1908 | __wrap_malloc (size_t c) |
252b5132 | 1909 | @{ |
cc2f008e | 1910 | printf ("malloc called with %zu\n", c); |
252b5132 RH |
1911 | return __real_malloc (c); |
1912 | @} | |
1913 | @end smallexample | |
1914 | ||
ff5dcc92 | 1915 | If you link other code with this file using @option{--wrap malloc}, then |
252b5132 RH |
1916 | all calls to @code{malloc} will call the function @code{__wrap_malloc} |
1917 | instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will | |
1918 | call the real @code{malloc} function. | |
1919 | ||
1920 | You may wish to provide a @code{__real_malloc} function as well, so that | |
ff5dcc92 | 1921 | links without the @option{--wrap} option will succeed. If you do this, |
252b5132 RH |
1922 | you should not put the definition of @code{__real_malloc} in the same |
1923 | file as @code{__wrap_malloc}; if you do, the assembler may resolve the | |
1924 | call before the linker has a chance to wrap it to @code{malloc}. | |
1925 | ||
6aa29e7b JJ |
1926 | @kindex --eh-frame-hdr |
1927 | @item --eh-frame-hdr | |
1928 | Request creation of @code{.eh_frame_hdr} section and ELF | |
1929 | @code{PT_GNU_EH_FRAME} segment header. | |
1930 | ||
6c1439be L |
1931 | @kindex --enable-new-dtags |
1932 | @kindex --disable-new-dtags | |
1933 | @item --enable-new-dtags | |
1934 | @itemx --disable-new-dtags | |
1935 | This linker can create the new dynamic tags in ELF. But the older ELF | |
1936 | systems may not understand them. If you specify | |
ff5dcc92 SC |
1937 | @option{--enable-new-dtags}, the dynamic tags will be created as needed. |
1938 | If you specify @option{--disable-new-dtags}, no new dynamic tags will be | |
6c1439be L |
1939 | created. By default, the new dynamic tags are not created. Note that |
1940 | those options are only available for ELF systems. | |
1941 | ||
2d643429 | 1942 | @kindex --hash-size=@var{number} |
e185dd51 | 1943 | @item --hash-size=@var{number} |
2d643429 NC |
1944 | Set the default size of the linker's hash tables to a prime number |
1945 | close to @var{number}. Increasing this value can reduce the length of | |
1946 | time it takes the linker to perform its tasks, at the expense of | |
1947 | increasing the linker's memory requirements. Similarly reducing this | |
1948 | value can reduce the memory requirements at the expense of speed. | |
1949 | ||
fdc90cb4 JJ |
1950 | @kindex --hash-style=@var{style} |
1951 | @item --hash-style=@var{style} | |
1952 | Set the type of linker's hash table(s). @var{style} can be either | |
1953 | @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for | |
1954 | new style GNU @code{.gnu.hash} section or @code{both} for both | |
1955 | the classic ELF @code{.hash} and new style GNU @code{.gnu.hash} | |
1956 | hash tables. The default is @code{sysv}. | |
1957 | ||
35835446 JR |
1958 | @kindex --reduce-memory-overheads |
1959 | @item --reduce-memory-overheads | |
1960 | This option reduces memory requirements at ld runtime, at the expense of | |
f2a8f148 | 1961 | linking speed. This was introduced to select the old O(n^2) algorithm |
35835446 | 1962 | for link map file generation, rather than the new O(n) algorithm which uses |
2d643429 NC |
1963 | about 40% more memory for symbol storage. |
1964 | ||
4f9c04f7 | 1965 | Another effect of the switch is to set the default hash table size to |
2d643429 | 1966 | 1021, which again saves memory at the cost of lengthening the linker's |
a85785bc | 1967 | run time. This is not done however if the @option{--hash-size} switch |
2d643429 NC |
1968 | has been used. |
1969 | ||
1970 | The @option{--reduce-memory-overheads} switch may be also be used to | |
1971 | enable other tradeoffs in future versions of the linker. | |
35835446 | 1972 | |
c0065db7 RM |
1973 | @kindex --build-id |
1974 | @kindex --build-id=@var{style} | |
1975 | @item --build-id | |
1976 | @itemx --build-id=@var{style} | |
1977 | Request creation of @code{.note.gnu.build-id} ELF note section. | |
1978 | The contents of the note are unique bits identifying this linked | |
1979 | file. @var{style} can be @code{uuid} to use 128 random bits, | |
24382dca RM |
1980 | @code{sha1} to use a 160-bit @sc{SHA1} hash on the normative |
1981 | parts of the output contents, @code{md5} to use a 128-bit | |
1982 | @sc{MD5} hash on the normative parts of the output contents, or | |
1983 | @code{0x@var{hexstring}} to use a chosen bit string specified as | |
1984 | an even number of hexadecimal digits (@code{-} and @code{:} | |
1985 | characters between digit pairs are ignored). If @var{style} is | |
1986 | omitted, @code{sha1} is used. | |
1987 | ||
1988 | The @code{md5} and @code{sha1} styles produces an identifier | |
1989 | that is always the same in an identical output file, but will be | |
1990 | unique among all nonidentical output files. It is not intended | |
1991 | to be compared as a checksum for the file's contents. A linked | |
1992 | file may be changed later by other tools, but the build ID bit | |
1993 | string identifying the original linked file does not change. | |
c0065db7 RM |
1994 | |
1995 | Passing @code{none} for @var{style} disables the setting from any | |
1996 | @code{--build-id} options earlier on the command line. | |
252b5132 RH |
1997 | @end table |
1998 | ||
0285c67d NC |
1999 | @c man end |
2000 | ||
36f63dca | 2001 | @subsection Options Specific to i386 PE Targets |
252b5132 | 2002 | |
0285c67d NC |
2003 | @c man begin OPTIONS |
2004 | ||
ff5dcc92 | 2005 | The i386 PE linker supports the @option{-shared} option, which causes |
252b5132 RH |
2006 | the output to be a dynamically linked library (DLL) instead of a |
2007 | normal executable. You should name the output @code{*.dll} when you | |
2008 | use this option. In addition, the linker fully supports the standard | |
2009 | @code{*.def} files, which may be specified on the linker command line | |
2010 | like an object file (in fact, it should precede archives it exports | |
2011 | symbols from, to ensure that they get linked in, just like a normal | |
2012 | object file). | |
2013 | ||
2014 | In addition to the options common to all targets, the i386 PE linker | |
2015 | support additional command line options that are specific to the i386 | |
2016 | PE target. Options that take values may be separated from their | |
2017 | values by either a space or an equals sign. | |
2018 | ||
ff5dcc92 | 2019 | @table @gcctabopt |
252b5132 RH |
2020 | |
2021 | @kindex --add-stdcall-alias | |
2022 | @item --add-stdcall-alias | |
2023 | If given, symbols with a stdcall suffix (@@@var{nn}) will be exported | |
2024 | as-is and also with the suffix stripped. | |
bb10df36 | 2025 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2026 | |
2027 | @kindex --base-file | |
2028 | @item --base-file @var{file} | |
2029 | Use @var{file} as the name of a file in which to save the base | |
2030 | addresses of all the relocations needed for generating DLLs with | |
2031 | @file{dlltool}. | |
bb10df36 | 2032 | [This is an i386 PE specific option] |
252b5132 RH |
2033 | |
2034 | @kindex --dll | |
2035 | @item --dll | |
2036 | Create a DLL instead of a regular executable. You may also use | |
ff5dcc92 | 2037 | @option{-shared} or specify a @code{LIBRARY} in a given @code{.def} |
252b5132 | 2038 | file. |
bb10df36 | 2039 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2040 | |
2041 | @kindex --enable-stdcall-fixup | |
2042 | @kindex --disable-stdcall-fixup | |
2043 | @item --enable-stdcall-fixup | |
2044 | @itemx --disable-stdcall-fixup | |
2045 | If the link finds a symbol that it cannot resolve, it will attempt to | |
36f63dca | 2046 | do ``fuzzy linking'' by looking for another defined symbol that differs |
252b5132 RH |
2047 | only in the format of the symbol name (cdecl vs stdcall) and will |
2048 | resolve that symbol by linking to the match. For example, the | |
2049 | undefined symbol @code{_foo} might be linked to the function | |
2050 | @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked | |
2051 | to the function @code{_bar}. When the linker does this, it prints a | |
2052 | warning, since it normally should have failed to link, but sometimes | |
2053 | import libraries generated from third-party dlls may need this feature | |
ff5dcc92 | 2054 | to be usable. If you specify @option{--enable-stdcall-fixup}, this |
252b5132 | 2055 | feature is fully enabled and warnings are not printed. If you specify |
ff5dcc92 | 2056 | @option{--disable-stdcall-fixup}, this feature is disabled and such |
252b5132 | 2057 | mismatches are considered to be errors. |
bb10df36 | 2058 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2059 | |
2060 | @cindex DLLs, creating | |
2061 | @kindex --export-all-symbols | |
2062 | @item --export-all-symbols | |
2063 | If given, all global symbols in the objects used to build a DLL will | |
2064 | be exported by the DLL. Note that this is the default if there | |
2065 | otherwise wouldn't be any exported symbols. When symbols are | |
2066 | explicitly exported via DEF files or implicitly exported via function | |
2067 | attributes, the default is to not export anything else unless this | |
2068 | option is given. Note that the symbols @code{DllMain@@12}, | |
ece2d90e | 2069 | @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and |
b044cda1 | 2070 | @code{impure_ptr} will not be automatically |
ece2d90e NC |
2071 | exported. Also, symbols imported from other DLLs will not be |
2072 | re-exported, nor will symbols specifying the DLL's internal layout | |
2073 | such as those beginning with @code{_head_} or ending with | |
2074 | @code{_iname}. In addition, no symbols from @code{libgcc}, | |
b044cda1 CW |
2075 | @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported. |
2076 | Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will | |
2077 | not be exported, to help with C++ DLLs. Finally, there is an | |
ece2d90e | 2078 | extensive list of cygwin-private symbols that are not exported |
b044cda1 | 2079 | (obviously, this applies on when building DLLs for cygwin targets). |
ece2d90e | 2080 | These cygwin-excludes are: @code{_cygwin_dll_entry@@12}, |
b044cda1 | 2081 | @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12}, |
ece2d90e | 2082 | @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll}, |
b044cda1 | 2083 | @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2}, |
ece2d90e | 2084 | @code{cygwin_premain3}, and @code{environ}. |
bb10df36 | 2085 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2086 | |
2087 | @kindex --exclude-symbols | |
1d0a3c9c | 2088 | @item --exclude-symbols @var{symbol},@var{symbol},... |
252b5132 RH |
2089 | Specifies a list of symbols which should not be automatically |
2090 | exported. The symbol names may be delimited by commas or colons. | |
bb10df36 | 2091 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2092 | |
2093 | @kindex --file-alignment | |
2094 | @item --file-alignment | |
2095 | Specify the file alignment. Sections in the file will always begin at | |
2096 | file offsets which are multiples of this number. This defaults to | |
2097 | 512. | |
bb10df36 | 2098 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2099 | |
2100 | @cindex heap size | |
2101 | @kindex --heap | |
2102 | @item --heap @var{reserve} | |
2103 | @itemx --heap @var{reserve},@var{commit} | |
a00b50c5 DS |
2104 | Specify the number of bytes of memory to reserve (and optionally commit) |
2105 | to be used as heap for this program. The default is 1Mb reserved, 4K | |
252b5132 | 2106 | committed. |
bb10df36 | 2107 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2108 | |
2109 | @cindex image base | |
2110 | @kindex --image-base | |
2111 | @item --image-base @var{value} | |
2112 | Use @var{value} as the base address of your program or dll. This is | |
2113 | the lowest memory location that will be used when your program or dll | |
2114 | is loaded. To reduce the need to relocate and improve performance of | |
2115 | your dlls, each should have a unique base address and not overlap any | |
2116 | other dlls. The default is 0x400000 for executables, and 0x10000000 | |
2117 | for dlls. | |
bb10df36 | 2118 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2119 | |
2120 | @kindex --kill-at | |
2121 | @item --kill-at | |
2122 | If given, the stdcall suffixes (@@@var{nn}) will be stripped from | |
2123 | symbols before they are exported. | |
bb10df36 | 2124 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2125 | |
26d2d8a2 BF |
2126 | @kindex --large-address-aware |
2127 | @item --large-address-aware | |
b45619c0 | 2128 | If given, the appropriate bit in the ``Characteristics'' field of the COFF |
26d2d8a2 | 2129 | header is set to indicate that this executable supports virtual addresses |
b45619c0 | 2130 | greater than 2 gigabytes. This should be used in conjunction with the /3GB |
26d2d8a2 BF |
2131 | or /USERVA=@var{value} megabytes switch in the ``[operating systems]'' |
2132 | section of the BOOT.INI. Otherwise, this bit has no effect. | |
2133 | [This option is specific to PE targeted ports of the linker] | |
2134 | ||
252b5132 RH |
2135 | @kindex --major-image-version |
2136 | @item --major-image-version @var{value} | |
36f63dca | 2137 | Sets the major number of the ``image version''. Defaults to 1. |
bb10df36 | 2138 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2139 | |
2140 | @kindex --major-os-version | |
2141 | @item --major-os-version @var{value} | |
36f63dca | 2142 | Sets the major number of the ``os version''. Defaults to 4. |
bb10df36 | 2143 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2144 | |
2145 | @kindex --major-subsystem-version | |
2146 | @item --major-subsystem-version @var{value} | |
36f63dca | 2147 | Sets the major number of the ``subsystem version''. Defaults to 4. |
bb10df36 | 2148 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2149 | |
2150 | @kindex --minor-image-version | |
2151 | @item --minor-image-version @var{value} | |
36f63dca | 2152 | Sets the minor number of the ``image version''. Defaults to 0. |
bb10df36 | 2153 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2154 | |
2155 | @kindex --minor-os-version | |
2156 | @item --minor-os-version @var{value} | |
36f63dca | 2157 | Sets the minor number of the ``os version''. Defaults to 0. |
bb10df36 | 2158 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2159 | |
2160 | @kindex --minor-subsystem-version | |
2161 | @item --minor-subsystem-version @var{value} | |
36f63dca | 2162 | Sets the minor number of the ``subsystem version''. Defaults to 0. |
bb10df36 | 2163 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2164 | |
2165 | @cindex DEF files, creating | |
2166 | @cindex DLLs, creating | |
2167 | @kindex --output-def | |
2168 | @item --output-def @var{file} | |
2169 | The linker will create the file @var{file} which will contain a DEF | |
2170 | file corresponding to the DLL the linker is generating. This DEF file | |
2171 | (which should be called @code{*.def}) may be used to create an import | |
2172 | library with @code{dlltool} or may be used as a reference to | |
2173 | automatically or implicitly exported symbols. | |
bb10df36 | 2174 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2175 | |
b044cda1 CW |
2176 | @cindex DLLs, creating |
2177 | @kindex --out-implib | |
2178 | @item --out-implib @var{file} | |
2179 | The linker will create the file @var{file} which will contain an | |
2180 | import lib corresponding to the DLL the linker is generating. This | |
2181 | import lib (which should be called @code{*.dll.a} or @code{*.a} | |
560e09e9 | 2182 | may be used to link clients against the generated DLL; this behaviour |
b044cda1 CW |
2183 | makes it possible to skip a separate @code{dlltool} import library |
2184 | creation step. | |
bb10df36 | 2185 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2186 | |
2187 | @kindex --enable-auto-image-base | |
2188 | @item --enable-auto-image-base | |
2189 | Automatically choose the image base for DLLs, unless one is specified | |
2190 | using the @code{--image-base} argument. By using a hash generated | |
2191 | from the dllname to create unique image bases for each DLL, in-memory | |
2192 | collisions and relocations which can delay program execution are | |
2193 | avoided. | |
bb10df36 | 2194 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2195 | |
2196 | @kindex --disable-auto-image-base | |
2197 | @item --disable-auto-image-base | |
2198 | Do not automatically generate a unique image base. If there is no | |
2199 | user-specified image base (@code{--image-base}) then use the platform | |
2200 | default. | |
bb10df36 | 2201 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2202 | |
2203 | @cindex DLLs, linking to | |
2204 | @kindex --dll-search-prefix | |
2205 | @item --dll-search-prefix @var{string} | |
489d0400 | 2206 | When linking dynamically to a dll without an import library, |
ece2d90e | 2207 | search for @code{<string><basename>.dll} in preference to |
560e09e9 | 2208 | @code{lib<basename>.dll}. This behaviour allows easy distinction |
b044cda1 CW |
2209 | between DLLs built for the various "subplatforms": native, cygwin, |
2210 | uwin, pw, etc. For instance, cygwin DLLs typically use | |
ece2d90e | 2211 | @code{--dll-search-prefix=cyg}. |
bb10df36 | 2212 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2213 | |
2214 | @kindex --enable-auto-import | |
2215 | @item --enable-auto-import | |
ece2d90e NC |
2216 | Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for |
2217 | DATA imports from DLLs, and create the necessary thunking symbols when | |
4d8907ac DS |
2218 | building the import libraries with those DATA exports. Note: Use of the |
2219 | 'auto-import' extension will cause the text section of the image file | |
2220 | to be made writable. This does not conform to the PE-COFF format | |
2221 | specification published by Microsoft. | |
2222 | ||
2223 | Using 'auto-import' generally will 'just work' -- but sometimes you may | |
2224 | see this message: | |
0d888aac | 2225 | |
ece2d90e | 2226 | "variable '<var>' can't be auto-imported. Please read the |
0d888aac CW |
2227 | documentation for ld's @code{--enable-auto-import} for details." |
2228 | ||
ece2d90e NC |
2229 | This message occurs when some (sub)expression accesses an address |
2230 | ultimately given by the sum of two constants (Win32 import tables only | |
c0065db7 RM |
2231 | allow one). Instances where this may occur include accesses to member |
2232 | fields of struct variables imported from a DLL, as well as using a | |
2233 | constant index into an array variable imported from a DLL. Any | |
2f8d8971 NC |
2234 | multiword variable (arrays, structs, long long, etc) may trigger |
2235 | this error condition. However, regardless of the exact data type | |
2236 | of the offending exported variable, ld will always detect it, issue | |
2237 | the warning, and exit. | |
2238 | ||
2239 | There are several ways to address this difficulty, regardless of the | |
2240 | data type of the exported variable: | |
0d888aac | 2241 | |
2fa9fc65 NC |
2242 | One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task |
2243 | of adjusting references in your client code for runtime environment, so | |
560e09e9 | 2244 | this method works only when runtime environment supports this feature. |
2fa9fc65 | 2245 | |
c0065db7 RM |
2246 | A second solution is to force one of the 'constants' to be a variable -- |
2247 | that is, unknown and un-optimizable at compile time. For arrays, | |
2248 | there are two possibilities: a) make the indexee (the array's address) | |
0d888aac CW |
2249 | a variable, or b) make the 'constant' index a variable. Thus: |
2250 | ||
2251 | @example | |
2252 | extern type extern_array[]; | |
c0065db7 | 2253 | extern_array[1] --> |
0d888aac CW |
2254 | @{ volatile type *t=extern_array; t[1] @} |
2255 | @end example | |
2256 | ||
2257 | or | |
2258 | ||
2259 | @example | |
2260 | extern type extern_array[]; | |
c0065db7 | 2261 | extern_array[1] --> |
0d888aac CW |
2262 | @{ volatile int t=1; extern_array[t] @} |
2263 | @end example | |
2264 | ||
c0065db7 | 2265 | For structs (and most other multiword data types) the only option |
2f8d8971 | 2266 | is to make the struct itself (or the long long, or the ...) variable: |
0d888aac CW |
2267 | |
2268 | @example | |
2269 | extern struct s extern_struct; | |
c0065db7 | 2270 | extern_struct.field --> |
0d888aac CW |
2271 | @{ volatile struct s *t=&extern_struct; t->field @} |
2272 | @end example | |
2273 | ||
c406afaf NC |
2274 | or |
2275 | ||
2276 | @example | |
2277 | extern long long extern_ll; | |
2278 | extern_ll --> | |
2279 | @{ volatile long long * local_ll=&extern_ll; *local_ll @} | |
2280 | @end example | |
2281 | ||
2fa9fc65 | 2282 | A third method of dealing with this difficulty is to abandon |
c0065db7 | 2283 | 'auto-import' for the offending symbol and mark it with |
560e09e9 | 2284 | @code{__declspec(dllimport)}. However, in practise that |
0d888aac | 2285 | requires using compile-time #defines to indicate whether you are |
c0065db7 RM |
2286 | building a DLL, building client code that will link to the DLL, or |
2287 | merely building/linking to a static library. In making the choice | |
2288 | between the various methods of resolving the 'direct address with | |
0d888aac CW |
2289 | constant offset' problem, you should consider typical real-world usage: |
2290 | ||
2291 | Original: | |
2292 | @example | |
2293 | --foo.h | |
2294 | extern int arr[]; | |
2295 | --foo.c | |
2296 | #include "foo.h" | |
2297 | void main(int argc, char **argv)@{ | |
2298 | printf("%d\n",arr[1]); | |
2299 | @} | |
2300 | @end example | |
2301 | ||
2302 | Solution 1: | |
2303 | @example | |
2304 | --foo.h | |
2305 | extern int arr[]; | |
2306 | --foo.c | |
2307 | #include "foo.h" | |
2308 | void main(int argc, char **argv)@{ | |
2309 | /* This workaround is for win32 and cygwin; do not "optimize" */ | |
2310 | volatile int *parr = arr; | |
2311 | printf("%d\n",parr[1]); | |
2312 | @} | |
2313 | @end example | |
2314 | ||
2315 | Solution 2: | |
2316 | @example | |
2317 | --foo.h | |
2318 | /* Note: auto-export is assumed (no __declspec(dllexport)) */ | |
2319 | #if (defined(_WIN32) || defined(__CYGWIN__)) && \ | |
2320 | !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC)) | |
2321 | #define FOO_IMPORT __declspec(dllimport) | |
2322 | #else | |
2323 | #define FOO_IMPORT | |
2324 | #endif | |
2325 | extern FOO_IMPORT int arr[]; | |
2326 | --foo.c | |
2327 | #include "foo.h" | |
2328 | void main(int argc, char **argv)@{ | |
2329 | printf("%d\n",arr[1]); | |
2330 | @} | |
2331 | @end example | |
2332 | ||
c0065db7 | 2333 | A fourth way to avoid this problem is to re-code your |
0d888aac CW |
2334 | library to use a functional interface rather than a data interface |
2335 | for the offending variables (e.g. set_foo() and get_foo() accessor | |
2336 | functions). | |
bb10df36 | 2337 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2338 | |
2339 | @kindex --disable-auto-import | |
2340 | @item --disable-auto-import | |
c0065db7 | 2341 | Do not attempt to do sophisticated linking of @code{_symbol} to |
b044cda1 | 2342 | @code{__imp__symbol} for DATA imports from DLLs. |
bb10df36 | 2343 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2344 | |
2fa9fc65 NC |
2345 | @kindex --enable-runtime-pseudo-reloc |
2346 | @item --enable-runtime-pseudo-reloc | |
2347 | If your code contains expressions described in --enable-auto-import section, | |
2348 | that is, DATA imports from DLL with non-zero offset, this switch will create | |
2349 | a vector of 'runtime pseudo relocations' which can be used by runtime | |
c0065db7 | 2350 | environment to adjust references to such data in your client code. |
bb10df36 | 2351 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 NC |
2352 | |
2353 | @kindex --disable-runtime-pseudo-reloc | |
2354 | @item --disable-runtime-pseudo-reloc | |
2355 | Do not create pseudo relocations for non-zero offset DATA imports from | |
2356 | DLLs. This is the default. | |
bb10df36 | 2357 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 | 2358 | |
b044cda1 CW |
2359 | @kindex --enable-extra-pe-debug |
2360 | @item --enable-extra-pe-debug | |
2361 | Show additional debug info related to auto-import symbol thunking. | |
bb10df36 | 2362 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2363 | |
252b5132 RH |
2364 | @kindex --section-alignment |
2365 | @item --section-alignment | |
2366 | Sets the section alignment. Sections in memory will always begin at | |
2367 | addresses which are a multiple of this number. Defaults to 0x1000. | |
bb10df36 | 2368 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2369 | |
2370 | @cindex stack size | |
2371 | @kindex --stack | |
2372 | @item --stack @var{reserve} | |
2373 | @itemx --stack @var{reserve},@var{commit} | |
a00b50c5 DS |
2374 | Specify the number of bytes of memory to reserve (and optionally commit) |
2375 | to be used as stack for this program. The default is 2Mb reserved, 4K | |
252b5132 | 2376 | committed. |
bb10df36 | 2377 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2378 | |
2379 | @kindex --subsystem | |
2380 | @item --subsystem @var{which} | |
2381 | @itemx --subsystem @var{which}:@var{major} | |
2382 | @itemx --subsystem @var{which}:@var{major}.@var{minor} | |
2383 | Specifies the subsystem under which your program will execute. The | |
2384 | legal values for @var{which} are @code{native}, @code{windows}, | |
33f362e1 NC |
2385 | @code{console}, @code{posix}, and @code{xbox}. You may optionally set |
2386 | the subsystem version also. Numeric values are also accepted for | |
2387 | @var{which}. | |
bb10df36 | 2388 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2389 | |
2390 | @end table | |
2391 | ||
0285c67d NC |
2392 | @c man end |
2393 | ||
93fd0973 SC |
2394 | @ifset M68HC11 |
2395 | @subsection Options specific to Motorola 68HC11 and 68HC12 targets | |
2396 | ||
2397 | @c man begin OPTIONS | |
2398 | ||
2399 | The 68HC11 and 68HC12 linkers support specific options to control the | |
2400 | memory bank switching mapping and trampoline code generation. | |
2401 | ||
2402 | @table @gcctabopt | |
2403 | ||
2404 | @kindex --no-trampoline | |
2405 | @item --no-trampoline | |
2406 | This option disables the generation of trampoline. By default a trampoline | |
2407 | is generated for each far function which is called using a @code{jsr} | |
2408 | instruction (this happens when a pointer to a far function is taken). | |
2409 | ||
2410 | @kindex --bank-window | |
2411 | @item --bank-window @var{name} | |
2412 | This option indicates to the linker the name of the memory region in | |
2413 | the @samp{MEMORY} specification that describes the memory bank window. | |
2414 | The definition of such region is then used by the linker to compute | |
2415 | paging and addresses within the memory window. | |
2416 | ||
2417 | @end table | |
2418 | ||
2419 | @c man end | |
2420 | @end ifset | |
2421 | ||
252b5132 RH |
2422 | @ifset UsesEnvVars |
2423 | @node Environment | |
2424 | @section Environment Variables | |
2425 | ||
0285c67d NC |
2426 | @c man begin ENVIRONMENT |
2427 | ||
560e09e9 | 2428 | You can change the behaviour of @command{ld} with the environment variables |
36f63dca NC |
2429 | @ifclear SingleFormat |
2430 | @code{GNUTARGET}, | |
2431 | @end ifclear | |
2432 | @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}. | |
252b5132 | 2433 | |
36f63dca | 2434 | @ifclear SingleFormat |
252b5132 RH |
2435 | @kindex GNUTARGET |
2436 | @cindex default input format | |
2437 | @code{GNUTARGET} determines the input-file object format if you don't | |
2438 | use @samp{-b} (or its synonym @samp{--format}). Its value should be one | |
2439 | of the BFD names for an input format (@pxref{BFD}). If there is no | |
ff5dcc92 | 2440 | @code{GNUTARGET} in the environment, @command{ld} uses the natural format |
252b5132 RH |
2441 | of the target. If @code{GNUTARGET} is set to @code{default} then BFD |
2442 | attempts to discover the input format by examining binary input files; | |
2443 | this method often succeeds, but there are potential ambiguities, since | |
2444 | there is no method of ensuring that the magic number used to specify | |
2445 | object-file formats is unique. However, the configuration procedure for | |
2446 | BFD on each system places the conventional format for that system first | |
2447 | in the search-list, so ambiguities are resolved in favor of convention. | |
36f63dca | 2448 | @end ifclear |
252b5132 RH |
2449 | |
2450 | @kindex LDEMULATION | |
2451 | @cindex default emulation | |
2452 | @cindex emulation, default | |
2453 | @code{LDEMULATION} determines the default emulation if you don't use the | |
2454 | @samp{-m} option. The emulation can affect various aspects of linker | |
2455 | behaviour, particularly the default linker script. You can list the | |
2456 | available emulations with the @samp{--verbose} or @samp{-V} options. If | |
2457 | the @samp{-m} option is not used, and the @code{LDEMULATION} environment | |
2458 | variable is not defined, the default emulation depends upon how the | |
2459 | linker was configured. | |
252b5132 RH |
2460 | |
2461 | @kindex COLLECT_NO_DEMANGLE | |
2462 | @cindex demangling, default | |
2463 | Normally, the linker will default to demangling symbols. However, if | |
2464 | @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will | |
2465 | default to not demangling symbols. This environment variable is used in | |
2466 | a similar fashion by the @code{gcc} linker wrapper program. The default | |
2467 | may be overridden by the @samp{--demangle} and @samp{--no-demangle} | |
2468 | options. | |
2469 | ||
0285c67d NC |
2470 | @c man end |
2471 | @end ifset | |
2472 | ||
252b5132 RH |
2473 | @node Scripts |
2474 | @chapter Linker Scripts | |
2475 | ||
2476 | @cindex scripts | |
2477 | @cindex linker scripts | |
2478 | @cindex command files | |
2479 | Every link is controlled by a @dfn{linker script}. This script is | |
2480 | written in the linker command language. | |
2481 | ||
2482 | The main purpose of the linker script is to describe how the sections in | |
2483 | the input files should be mapped into the output file, and to control | |
2484 | the memory layout of the output file. Most linker scripts do nothing | |
2485 | more than this. However, when necessary, the linker script can also | |
2486 | direct the linker to perform many other operations, using the commands | |
2487 | described below. | |
2488 | ||
2489 | The linker always uses a linker script. If you do not supply one | |
2490 | yourself, the linker will use a default script that is compiled into the | |
2491 | linker executable. You can use the @samp{--verbose} command line option | |
2492 | to display the default linker script. Certain command line options, | |
2493 | such as @samp{-r} or @samp{-N}, will affect the default linker script. | |
2494 | ||
2495 | You may supply your own linker script by using the @samp{-T} command | |
2496 | line option. When you do this, your linker script will replace the | |
2497 | default linker script. | |
2498 | ||
2499 | You may also use linker scripts implicitly by naming them as input files | |
2500 | to the linker, as though they were files to be linked. @xref{Implicit | |
2501 | Linker Scripts}. | |
2502 | ||
2503 | @menu | |
2504 | * Basic Script Concepts:: Basic Linker Script Concepts | |
2505 | * Script Format:: Linker Script Format | |
2506 | * Simple Example:: Simple Linker Script Example | |
2507 | * Simple Commands:: Simple Linker Script Commands | |
2508 | * Assignments:: Assigning Values to Symbols | |
2509 | * SECTIONS:: SECTIONS Command | |
2510 | * MEMORY:: MEMORY Command | |
2511 | * PHDRS:: PHDRS Command | |
2512 | * VERSION:: VERSION Command | |
2513 | * Expressions:: Expressions in Linker Scripts | |
2514 | * Implicit Linker Scripts:: Implicit Linker Scripts | |
2515 | @end menu | |
2516 | ||
2517 | @node Basic Script Concepts | |
2518 | @section Basic Linker Script Concepts | |
2519 | @cindex linker script concepts | |
2520 | We need to define some basic concepts and vocabulary in order to | |
2521 | describe the linker script language. | |
2522 | ||
2523 | The linker combines input files into a single output file. The output | |
2524 | file and each input file are in a special data format known as an | |
2525 | @dfn{object file format}. Each file is called an @dfn{object file}. | |
2526 | The output file is often called an @dfn{executable}, but for our | |
2527 | purposes we will also call it an object file. Each object file has, | |
2528 | among other things, a list of @dfn{sections}. We sometimes refer to a | |
2529 | section in an input file as an @dfn{input section}; similarly, a section | |
2530 | in the output file is an @dfn{output section}. | |
2531 | ||
2532 | Each section in an object file has a name and a size. Most sections | |
2533 | also have an associated block of data, known as the @dfn{section | |
2534 | contents}. A section may be marked as @dfn{loadable}, which mean that | |
2535 | the contents should be loaded into memory when the output file is run. | |
2536 | A section with no contents may be @dfn{allocatable}, which means that an | |
2537 | area in memory should be set aside, but nothing in particular should be | |
2538 | loaded there (in some cases this memory must be zeroed out). A section | |
2539 | which is neither loadable nor allocatable typically contains some sort | |
2540 | of debugging information. | |
2541 | ||
2542 | Every loadable or allocatable output section has two addresses. The | |
2543 | first is the @dfn{VMA}, or virtual memory address. This is the address | |
2544 | the section will have when the output file is run. The second is the | |
2545 | @dfn{LMA}, or load memory address. This is the address at which the | |
2546 | section will be loaded. In most cases the two addresses will be the | |
2547 | same. An example of when they might be different is when a data section | |
2548 | is loaded into ROM, and then copied into RAM when the program starts up | |
2549 | (this technique is often used to initialize global variables in a ROM | |
2550 | based system). In this case the ROM address would be the LMA, and the | |
2551 | RAM address would be the VMA. | |
2552 | ||
2553 | You can see the sections in an object file by using the @code{objdump} | |
2554 | program with the @samp{-h} option. | |
2555 | ||
2556 | Every object file also has a list of @dfn{symbols}, known as the | |
2557 | @dfn{symbol table}. A symbol may be defined or undefined. Each symbol | |
2558 | has a name, and each defined symbol has an address, among other | |
2559 | information. If you compile a C or C++ program into an object file, you | |
2560 | will get a defined symbol for every defined function and global or | |
2561 | static variable. Every undefined function or global variable which is | |
2562 | referenced in the input file will become an undefined symbol. | |
2563 | ||
2564 | You can see the symbols in an object file by using the @code{nm} | |
2565 | program, or by using the @code{objdump} program with the @samp{-t} | |
2566 | option. | |
2567 | ||
2568 | @node Script Format | |
2569 | @section Linker Script Format | |
2570 | @cindex linker script format | |
2571 | Linker scripts are text files. | |
2572 | ||
2573 | You write a linker script as a series of commands. Each command is | |
2574 | either a keyword, possibly followed by arguments, or an assignment to a | |
2575 | symbol. You may separate commands using semicolons. Whitespace is | |
2576 | generally ignored. | |
2577 | ||
2578 | Strings such as file or format names can normally be entered directly. | |
2579 | If the file name contains a character such as a comma which would | |
2580 | otherwise serve to separate file names, you may put the file name in | |
2581 | double quotes. There is no way to use a double quote character in a | |
2582 | file name. | |
2583 | ||
2584 | You may include comments in linker scripts just as in C, delimited by | |
2585 | @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent | |
2586 | to whitespace. | |
2587 | ||
2588 | @node Simple Example | |
2589 | @section Simple Linker Script Example | |
2590 | @cindex linker script example | |
2591 | @cindex example of linker script | |
2592 | Many linker scripts are fairly simple. | |
2593 | ||
2594 | The simplest possible linker script has just one command: | |
2595 | @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the | |
2596 | memory layout of the output file. | |
2597 | ||
2598 | The @samp{SECTIONS} command is a powerful command. Here we will | |
2599 | describe a simple use of it. Let's assume your program consists only of | |
2600 | code, initialized data, and uninitialized data. These will be in the | |
2601 | @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively. | |
2602 | Let's assume further that these are the only sections which appear in | |
2603 | your input files. | |
2604 | ||
2605 | For this example, let's say that the code should be loaded at address | |
2606 | 0x10000, and that the data should start at address 0x8000000. Here is a | |
2607 | linker script which will do that: | |
2608 | @smallexample | |
2609 | SECTIONS | |
2610 | @{ | |
2611 | . = 0x10000; | |
2612 | .text : @{ *(.text) @} | |
2613 | . = 0x8000000; | |
2614 | .data : @{ *(.data) @} | |
2615 | .bss : @{ *(.bss) @} | |
2616 | @} | |
2617 | @end smallexample | |
2618 | ||
2619 | You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS}, | |
2620 | followed by a series of symbol assignments and output section | |
2621 | descriptions enclosed in curly braces. | |
2622 | ||
252b5132 RH |
2623 | The first line inside the @samp{SECTIONS} command of the above example |
2624 | sets the value of the special symbol @samp{.}, which is the location | |
2625 | counter. If you do not specify the address of an output section in some | |
2626 | other way (other ways are described later), the address is set from the | |
2627 | current value of the location counter. The location counter is then | |
2628 | incremented by the size of the output section. At the start of the | |
2629 | @samp{SECTIONS} command, the location counter has the value @samp{0}. | |
2630 | ||
2631 | The second line defines an output section, @samp{.text}. The colon is | |
2632 | required syntax which may be ignored for now. Within the curly braces | |
2633 | after the output section name, you list the names of the input sections | |
2634 | which should be placed into this output section. The @samp{*} is a | |
2635 | wildcard which matches any file name. The expression @samp{*(.text)} | |
2636 | means all @samp{.text} input sections in all input files. | |
2637 | ||
2638 | Since the location counter is @samp{0x10000} when the output section | |
2639 | @samp{.text} is defined, the linker will set the address of the | |
2640 | @samp{.text} section in the output file to be @samp{0x10000}. | |
2641 | ||
2642 | The remaining lines define the @samp{.data} and @samp{.bss} sections in | |
2643 | the output file. The linker will place the @samp{.data} output section | |
2644 | at address @samp{0x8000000}. After the linker places the @samp{.data} | |
2645 | output section, the value of the location counter will be | |
2646 | @samp{0x8000000} plus the size of the @samp{.data} output section. The | |
2647 | effect is that the linker will place the @samp{.bss} output section | |
58434bc1 | 2648 | immediately after the @samp{.data} output section in memory. |
252b5132 RH |
2649 | |
2650 | The linker will ensure that each output section has the required | |
2651 | alignment, by increasing the location counter if necessary. In this | |
2652 | example, the specified addresses for the @samp{.text} and @samp{.data} | |
2653 | sections will probably satisfy any alignment constraints, but the linker | |
2654 | may have to create a small gap between the @samp{.data} and @samp{.bss} | |
2655 | sections. | |
2656 | ||
2657 | That's it! That's a simple and complete linker script. | |
2658 | ||
2659 | @node Simple Commands | |
2660 | @section Simple Linker Script Commands | |
2661 | @cindex linker script simple commands | |
2662 | In this section we describe the simple linker script commands. | |
2663 | ||
2664 | @menu | |
2665 | * Entry Point:: Setting the entry point | |
2666 | * File Commands:: Commands dealing with files | |
2667 | @ifclear SingleFormat | |
2668 | * Format Commands:: Commands dealing with object file formats | |
2669 | @end ifclear | |
2670 | ||
2671 | * Miscellaneous Commands:: Other linker script commands | |
2672 | @end menu | |
2673 | ||
2674 | @node Entry Point | |
36f63dca | 2675 | @subsection Setting the Entry Point |
252b5132 RH |
2676 | @kindex ENTRY(@var{symbol}) |
2677 | @cindex start of execution | |
2678 | @cindex first instruction | |
2679 | @cindex entry point | |
2680 | The first instruction to execute in a program is called the @dfn{entry | |
2681 | point}. You can use the @code{ENTRY} linker script command to set the | |
2682 | entry point. The argument is a symbol name: | |
2683 | @smallexample | |
2684 | ENTRY(@var{symbol}) | |
2685 | @end smallexample | |
2686 | ||
2687 | There are several ways to set the entry point. The linker will set the | |
2688 | entry point by trying each of the following methods in order, and | |
2689 | stopping when one of them succeeds: | |
2690 | @itemize @bullet | |
a1ab1d2a | 2691 | @item |
252b5132 | 2692 | the @samp{-e} @var{entry} command-line option; |
a1ab1d2a | 2693 | @item |
252b5132 | 2694 | the @code{ENTRY(@var{symbol})} command in a linker script; |
a1ab1d2a | 2695 | @item |
252b5132 | 2696 | the value of the symbol @code{start}, if defined; |
a1ab1d2a | 2697 | @item |
252b5132 | 2698 | the address of the first byte of the @samp{.text} section, if present; |
a1ab1d2a | 2699 | @item |
252b5132 RH |
2700 | The address @code{0}. |
2701 | @end itemize | |
2702 | ||
2703 | @node File Commands | |
36f63dca | 2704 | @subsection Commands Dealing with Files |
252b5132 RH |
2705 | @cindex linker script file commands |
2706 | Several linker script commands deal with files. | |
2707 | ||
2708 | @table @code | |
2709 | @item INCLUDE @var{filename} | |
2710 | @kindex INCLUDE @var{filename} | |
2711 | @cindex including a linker script | |
2712 | Include the linker script @var{filename} at this point. The file will | |
2713 | be searched for in the current directory, and in any directory specified | |
ff5dcc92 | 2714 | with the @option{-L} option. You can nest calls to @code{INCLUDE} up to |
252b5132 RH |
2715 | 10 levels deep. |
2716 | ||
2717 | @item INPUT(@var{file}, @var{file}, @dots{}) | |
2718 | @itemx INPUT(@var{file} @var{file} @dots{}) | |
2719 | @kindex INPUT(@var{files}) | |
2720 | @cindex input files in linker scripts | |
2721 | @cindex input object files in linker scripts | |
2722 | @cindex linker script input object files | |
2723 | The @code{INPUT} command directs the linker to include the named files | |
2724 | in the link, as though they were named on the command line. | |
2725 | ||
2726 | For example, if you always want to include @file{subr.o} any time you do | |
2727 | a link, but you can't be bothered to put it on every link command line, | |
2728 | then you can put @samp{INPUT (subr.o)} in your linker script. | |
2729 | ||
2730 | In fact, if you like, you can list all of your input files in the linker | |
2731 | script, and then invoke the linker with nothing but a @samp{-T} option. | |
2732 | ||
e3f2db7f AO |
2733 | In case a @dfn{sysroot prefix} is configured, and the filename starts |
2734 | with the @samp{/} character, and the script being processed was | |
2735 | located inside the @dfn{sysroot prefix}, the filename will be looked | |
2736 | for in the @dfn{sysroot prefix}. Otherwise, the linker will try to | |
2737 | open the file in the current directory. If it is not found, the | |
2738 | linker will search through the archive library search path. See the | |
2739 | description of @samp{-L} in @ref{Options,,Command Line Options}. | |
252b5132 | 2740 | |
ff5dcc92 | 2741 | If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the |
252b5132 RH |
2742 | name to @code{lib@var{file}.a}, as with the command line argument |
2743 | @samp{-l}. | |
2744 | ||
2745 | When you use the @code{INPUT} command in an implicit linker script, the | |
2746 | files will be included in the link at the point at which the linker | |
2747 | script file is included. This can affect archive searching. | |
2748 | ||
2749 | @item GROUP(@var{file}, @var{file}, @dots{}) | |
2750 | @itemx GROUP(@var{file} @var{file} @dots{}) | |
2751 | @kindex GROUP(@var{files}) | |
2752 | @cindex grouping input files | |
2753 | The @code{GROUP} command is like @code{INPUT}, except that the named | |
2754 | files should all be archives, and they are searched repeatedly until no | |
2755 | new undefined references are created. See the description of @samp{-(} | |
2756 | in @ref{Options,,Command Line Options}. | |
2757 | ||
b717d30e JJ |
2758 | @item AS_NEEDED(@var{file}, @var{file}, @dots{}) |
2759 | @itemx AS_NEEDED(@var{file} @var{file} @dots{}) | |
2760 | @kindex AS_NEEDED(@var{files}) | |
2761 | This construct can appear only inside of the @code{INPUT} or @code{GROUP} | |
2762 | commands, among other filenames. The files listed will be handled | |
2763 | as if they appear directly in the @code{INPUT} or @code{GROUP} commands, | |
2764 | with the exception of ELF shared libraries, that will be added only | |
2765 | when they are actually needed. This construct essentially enables | |
2766 | @option{--as-needed} option for all the files listed inside of it | |
2767 | and restores previous @option{--as-needed} resp. @option{--no-as-needed} | |
2768 | setting afterwards. | |
2769 | ||
252b5132 RH |
2770 | @item OUTPUT(@var{filename}) |
2771 | @kindex OUTPUT(@var{filename}) | |
b45619c0 | 2772 | @cindex output file name in linker script |
252b5132 RH |
2773 | The @code{OUTPUT} command names the output file. Using |
2774 | @code{OUTPUT(@var{filename})} in the linker script is exactly like using | |
2775 | @samp{-o @var{filename}} on the command line (@pxref{Options,,Command | |
2776 | Line Options}). If both are used, the command line option takes | |
2777 | precedence. | |
2778 | ||
2779 | You can use the @code{OUTPUT} command to define a default name for the | |
2780 | output file other than the usual default of @file{a.out}. | |
2781 | ||
2782 | @item SEARCH_DIR(@var{path}) | |
2783 | @kindex SEARCH_DIR(@var{path}) | |
2784 | @cindex library search path in linker script | |
2785 | @cindex archive search path in linker script | |
2786 | @cindex search path in linker script | |
2787 | The @code{SEARCH_DIR} command adds @var{path} to the list of paths where | |
ff5dcc92 | 2788 | @command{ld} looks for archive libraries. Using |
252b5132 RH |
2789 | @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}} |
2790 | on the command line (@pxref{Options,,Command Line Options}). If both | |
2791 | are used, then the linker will search both paths. Paths specified using | |
2792 | the command line option are searched first. | |
2793 | ||
2794 | @item STARTUP(@var{filename}) | |
2795 | @kindex STARTUP(@var{filename}) | |
2796 | @cindex first input file | |
2797 | The @code{STARTUP} command is just like the @code{INPUT} command, except | |
2798 | that @var{filename} will become the first input file to be linked, as | |
2799 | though it were specified first on the command line. This may be useful | |
2800 | when using a system in which the entry point is always the start of the | |
2801 | first file. | |
2802 | @end table | |
2803 | ||
2804 | @ifclear SingleFormat | |
2805 | @node Format Commands | |
36f63dca | 2806 | @subsection Commands Dealing with Object File Formats |
252b5132 RH |
2807 | A couple of linker script commands deal with object file formats. |
2808 | ||
2809 | @table @code | |
2810 | @item OUTPUT_FORMAT(@var{bfdname}) | |
2811 | @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little}) | |
2812 | @kindex OUTPUT_FORMAT(@var{bfdname}) | |
2813 | @cindex output file format in linker script | |
2814 | The @code{OUTPUT_FORMAT} command names the BFD format to use for the | |
2815 | output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is | |
024531e2 | 2816 | exactly like using @samp{--oformat @var{bfdname}} on the command line |
252b5132 RH |
2817 | (@pxref{Options,,Command Line Options}). If both are used, the command |
2818 | line option takes precedence. | |
2819 | ||
2820 | You can use @code{OUTPUT_FORMAT} with three arguments to use different | |
2821 | formats based on the @samp{-EB} and @samp{-EL} command line options. | |
2822 | This permits the linker script to set the output format based on the | |
2823 | desired endianness. | |
2824 | ||
2825 | If neither @samp{-EB} nor @samp{-EL} are used, then the output format | |
2826 | will be the first argument, @var{default}. If @samp{-EB} is used, the | |
2827 | output format will be the second argument, @var{big}. If @samp{-EL} is | |
2828 | used, the output format will be the third argument, @var{little}. | |
2829 | ||
2830 | For example, the default linker script for the MIPS ELF target uses this | |
2831 | command: | |
2832 | @smallexample | |
2833 | OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips) | |
2834 | @end smallexample | |
2835 | This says that the default format for the output file is | |
2836 | @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line | |
2837 | option, the output file will be created in the @samp{elf32-littlemips} | |
2838 | format. | |
2839 | ||
2840 | @item TARGET(@var{bfdname}) | |
2841 | @kindex TARGET(@var{bfdname}) | |
2842 | @cindex input file format in linker script | |
2843 | The @code{TARGET} command names the BFD format to use when reading input | |
2844 | files. It affects subsequent @code{INPUT} and @code{GROUP} commands. | |
2845 | This command is like using @samp{-b @var{bfdname}} on the command line | |
2846 | (@pxref{Options,,Command Line Options}). If the @code{TARGET} command | |
2847 | is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET} | |
2848 | command is also used to set the format for the output file. @xref{BFD}. | |
2849 | @end table | |
2850 | @end ifclear | |
2851 | ||
2852 | @node Miscellaneous Commands | |
36f63dca | 2853 | @subsection Other Linker Script Commands |
252b5132 RH |
2854 | There are a few other linker scripts commands. |
2855 | ||
2856 | @table @code | |
2857 | @item ASSERT(@var{exp}, @var{message}) | |
2858 | @kindex ASSERT | |
2859 | @cindex assertion in linker script | |
2860 | Ensure that @var{exp} is non-zero. If it is zero, then exit the linker | |
2861 | with an error code, and print @var{message}. | |
2862 | ||
2863 | @item EXTERN(@var{symbol} @var{symbol} @dots{}) | |
2864 | @kindex EXTERN | |
2865 | @cindex undefined symbol in linker script | |
2866 | Force @var{symbol} to be entered in the output file as an undefined | |
2867 | symbol. Doing this may, for example, trigger linking of additional | |
2868 | modules from standard libraries. You may list several @var{symbol}s for | |
2869 | each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This | |
2870 | command has the same effect as the @samp{-u} command-line option. | |
2871 | ||
2872 | @item FORCE_COMMON_ALLOCATION | |
2873 | @kindex FORCE_COMMON_ALLOCATION | |
2874 | @cindex common allocation in linker script | |
2875 | This command has the same effect as the @samp{-d} command-line option: | |
ff5dcc92 | 2876 | to make @command{ld} assign space to common symbols even if a relocatable |
252b5132 RH |
2877 | output file is specified (@samp{-r}). |
2878 | ||
4818e05f AM |
2879 | @item INHIBIT_COMMON_ALLOCATION |
2880 | @kindex INHIBIT_COMMON_ALLOCATION | |
2881 | @cindex common allocation in linker script | |
2882 | This command has the same effect as the @samp{--no-define-common} | |
2883 | command-line option: to make @code{ld} omit the assignment of addresses | |
2884 | to common symbols even for a non-relocatable output file. | |
2885 | ||
252b5132 RH |
2886 | @item NOCROSSREFS(@var{section} @var{section} @dots{}) |
2887 | @kindex NOCROSSREFS(@var{sections}) | |
2888 | @cindex cross references | |
ff5dcc92 | 2889 | This command may be used to tell @command{ld} to issue an error about any |
252b5132 RH |
2890 | references among certain output sections. |
2891 | ||
2892 | In certain types of programs, particularly on embedded systems when | |
2893 | using overlays, when one section is loaded into memory, another section | |
2894 | will not be. Any direct references between the two sections would be | |
2895 | errors. For example, it would be an error if code in one section called | |
2896 | a function defined in the other section. | |
2897 | ||
2898 | The @code{NOCROSSREFS} command takes a list of output section names. If | |
ff5dcc92 | 2899 | @command{ld} detects any cross references between the sections, it reports |
252b5132 RH |
2900 | an error and returns a non-zero exit status. Note that the |
2901 | @code{NOCROSSREFS} command uses output section names, not input section | |
2902 | names. | |
2903 | ||
2904 | @ifclear SingleFormat | |
2905 | @item OUTPUT_ARCH(@var{bfdarch}) | |
2906 | @kindex OUTPUT_ARCH(@var{bfdarch}) | |
2907 | @cindex machine architecture | |
2908 | @cindex architecture | |
2909 | Specify a particular output machine architecture. The argument is one | |
2910 | of the names used by the BFD library (@pxref{BFD}). You can see the | |
2911 | architecture of an object file by using the @code{objdump} program with | |
2912 | the @samp{-f} option. | |
2913 | @end ifclear | |
2914 | @end table | |
2915 | ||
2916 | @node Assignments | |
2917 | @section Assigning Values to Symbols | |
2918 | @cindex assignment in scripts | |
2919 | @cindex symbol definition, scripts | |
2920 | @cindex variables, defining | |
2921 | You may assign a value to a symbol in a linker script. This will define | |
73ae6183 | 2922 | the symbol and place it into the symbol table with a global scope. |
252b5132 RH |
2923 | |
2924 | @menu | |
2925 | * Simple Assignments:: Simple Assignments | |
2926 | * PROVIDE:: PROVIDE | |
7af8e998 | 2927 | * PROVIDE_HIDDEN:: PROVIDE_HIDDEN |
73ae6183 | 2928 | * Source Code Reference:: How to use a linker script defined symbol in source code |
252b5132 RH |
2929 | @end menu |
2930 | ||
2931 | @node Simple Assignments | |
2932 | @subsection Simple Assignments | |
2933 | ||
2934 | You may assign to a symbol using any of the C assignment operators: | |
2935 | ||
2936 | @table @code | |
2937 | @item @var{symbol} = @var{expression} ; | |
2938 | @itemx @var{symbol} += @var{expression} ; | |
2939 | @itemx @var{symbol} -= @var{expression} ; | |
2940 | @itemx @var{symbol} *= @var{expression} ; | |
2941 | @itemx @var{symbol} /= @var{expression} ; | |
2942 | @itemx @var{symbol} <<= @var{expression} ; | |
2943 | @itemx @var{symbol} >>= @var{expression} ; | |
2944 | @itemx @var{symbol} &= @var{expression} ; | |
2945 | @itemx @var{symbol} |= @var{expression} ; | |
2946 | @end table | |
2947 | ||
2948 | The first case will define @var{symbol} to the value of | |
2949 | @var{expression}. In the other cases, @var{symbol} must already be | |
2950 | defined, and the value will be adjusted accordingly. | |
2951 | ||
2952 | The special symbol name @samp{.} indicates the location counter. You | |
b5666f2f | 2953 | may only use this within a @code{SECTIONS} command. @xref{Location Counter}. |
252b5132 RH |
2954 | |
2955 | The semicolon after @var{expression} is required. | |
2956 | ||
2957 | Expressions are defined below; see @ref{Expressions}. | |
2958 | ||
2959 | You may write symbol assignments as commands in their own right, or as | |
2960 | statements within a @code{SECTIONS} command, or as part of an output | |
2961 | section description in a @code{SECTIONS} command. | |
2962 | ||
2963 | The section of the symbol will be set from the section of the | |
2964 | expression; for more information, see @ref{Expression Section}. | |
2965 | ||
2966 | Here is an example showing the three different places that symbol | |
2967 | assignments may be used: | |
2968 | ||
2969 | @smallexample | |
2970 | floating_point = 0; | |
2971 | SECTIONS | |
2972 | @{ | |
2973 | .text : | |
2974 | @{ | |
2975 | *(.text) | |
2976 | _etext = .; | |
2977 | @} | |
156e34dd | 2978 | _bdata = (. + 3) & ~ 3; |
252b5132 RH |
2979 | .data : @{ *(.data) @} |
2980 | @} | |
2981 | @end smallexample | |
2982 | @noindent | |
2983 | In this example, the symbol @samp{floating_point} will be defined as | |
2984 | zero. The symbol @samp{_etext} will be defined as the address following | |
2985 | the last @samp{.text} input section. The symbol @samp{_bdata} will be | |
2986 | defined as the address following the @samp{.text} output section aligned | |
2987 | upward to a 4 byte boundary. | |
2988 | ||
2989 | @node PROVIDE | |
2990 | @subsection PROVIDE | |
2991 | @cindex PROVIDE | |
2992 | In some cases, it is desirable for a linker script to define a symbol | |
2993 | only if it is referenced and is not defined by any object included in | |
2994 | the link. For example, traditional linkers defined the symbol | |
2995 | @samp{etext}. However, ANSI C requires that the user be able to use | |
2996 | @samp{etext} as a function name without encountering an error. The | |
2997 | @code{PROVIDE} keyword may be used to define a symbol, such as | |
2998 | @samp{etext}, only if it is referenced but not defined. The syntax is | |
2999 | @code{PROVIDE(@var{symbol} = @var{expression})}. | |
3000 | ||
3001 | Here is an example of using @code{PROVIDE} to define @samp{etext}: | |
3002 | @smallexample | |
3003 | SECTIONS | |
3004 | @{ | |
3005 | .text : | |
3006 | @{ | |
3007 | *(.text) | |
3008 | _etext = .; | |
3009 | PROVIDE(etext = .); | |
3010 | @} | |
3011 | @} | |
3012 | @end smallexample | |
3013 | ||
3014 | In this example, if the program defines @samp{_etext} (with a leading | |
3015 | underscore), the linker will give a multiple definition error. If, on | |
3016 | the other hand, the program defines @samp{etext} (with no leading | |
3017 | underscore), the linker will silently use the definition in the program. | |
3018 | If the program references @samp{etext} but does not define it, the | |
3019 | linker will use the definition in the linker script. | |
3020 | ||
7af8e998 L |
3021 | @node PROVIDE_HIDDEN |
3022 | @subsection PROVIDE_HIDDEN | |
3023 | @cindex PROVIDE_HIDDEN | |
3024 | Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be | |
3025 | hidden and won't be exported. | |
3026 | ||
73ae6183 NC |
3027 | @node Source Code Reference |
3028 | @subsection Source Code Reference | |
3029 | ||
3030 | Accessing a linker script defined variable from source code is not | |
3031 | intuitive. In particular a linker script symbol is not equivalent to | |
3032 | a variable declaration in a high level language, it is instead a | |
3033 | symbol that does not have a value. | |
3034 | ||
3035 | Before going further, it is important to note that compilers often | |
3036 | transform names in the source code into different names when they are | |
3037 | stored in the symbol table. For example, Fortran compilers commonly | |
3038 | prepend or append an underscore, and C++ performs extensive @samp{name | |
3039 | mangling}. Therefore there might be a discrepancy between the name | |
3040 | of a variable as it is used in source code and the name of the same | |
3041 | variable as it is defined in a linker script. For example in C a | |
3042 | linker script variable might be referred to as: | |
3043 | ||
3044 | @smallexample | |
3045 | extern int foo; | |
3046 | @end smallexample | |
3047 | ||
3048 | But in the linker script it might be defined as: | |
3049 | ||
3050 | @smallexample | |
3051 | _foo = 1000; | |
3052 | @end smallexample | |
3053 | ||
3054 | In the remaining examples however it is assumed that no name | |
3055 | transformation has taken place. | |
3056 | ||
3057 | When a symbol is declared in a high level language such as C, two | |
3058 | things happen. The first is that the compiler reserves enough space | |
3059 | in the program's memory to hold the @emph{value} of the symbol. The | |
3060 | second is that the compiler creates an entry in the program's symbol | |
3061 | table which holds the symbol's @emph{address}. ie the symbol table | |
3062 | contains the address of the block of memory holding the symbol's | |
3063 | value. So for example the following C declaration, at file scope: | |
3064 | ||
3065 | @smallexample | |
3066 | int foo = 1000; | |
3067 | @end smallexample | |
3068 | ||
3069 | creates a entry called @samp{foo} in the symbol table. This entry | |
3070 | holds the address of an @samp{int} sized block of memory where the | |
3071 | number 1000 is initially stored. | |
3072 | ||
3073 | When a program references a symbol the compiler generates code that | |
3074 | first accesses the symbol table to find the address of the symbol's | |
3075 | memory block and then code to read the value from that memory block. | |
3076 | So: | |
3077 | ||
3078 | @smallexample | |
3079 | foo = 1; | |
3080 | @end smallexample | |
3081 | ||
3082 | looks up the symbol @samp{foo} in the symbol table, gets the address | |
3083 | associated with this symbol and then writes the value 1 into that | |
3084 | address. Whereas: | |
3085 | ||
3086 | @smallexample | |
3087 | int * a = & foo; | |
3088 | @end smallexample | |
3089 | ||
3090 | looks up the symbol @samp{foo} in the symbol table, gets it address | |
3091 | and then copies this address into the block of memory associated with | |
3092 | the variable @samp{a}. | |
3093 | ||
3094 | Linker scripts symbol declarations, by contrast, create an entry in | |
3095 | the symbol table but do not assign any memory to them. Thus they are | |
3096 | an address without a value. So for example the linker script definition: | |
3097 | ||
3098 | @smallexample | |
3099 | foo = 1000; | |
3100 | @end smallexample | |
3101 | ||
3102 | creates an entry in the symbol table called @samp{foo} which holds | |
3103 | the address of memory location 1000, but nothing special is stored at | |
3104 | address 1000. This means that you cannot access the @emph{value} of a | |
3105 | linker script defined symbol - it has no value - all you can do is | |
3106 | access the @emph{address} of a linker script defined symbol. | |
3107 | ||
3108 | Hence when you are using a linker script defined symbol in source code | |
3109 | you should always take the address of the symbol, and never attempt to | |
3110 | use its value. For example suppose you want to copy the contents of a | |
3111 | section of memory called .ROM into a section called .FLASH and the | |
3112 | linker script contains these declarations: | |
3113 | ||
3114 | @smallexample | |
3115 | @group | |
3116 | start_of_ROM = .ROM; | |
3117 | end_of_ROM = .ROM + sizeof (.ROM) - 1; | |
3118 | start_of_FLASH = .FLASH; | |
3119 | @end group | |
3120 | @end smallexample | |
3121 | ||
3122 | Then the C source code to perform the copy would be: | |
3123 | ||
3124 | @smallexample | |
3125 | @group | |
3126 | extern char start_of_ROM, end_of_ROM, start_of_FLASH; | |
c0065db7 | 3127 | |
73ae6183 NC |
3128 | memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM); |
3129 | @end group | |
3130 | @end smallexample | |
3131 | ||
3132 | Note the use of the @samp{&} operators. These are correct. | |
3133 | ||
252b5132 | 3134 | @node SECTIONS |
36f63dca | 3135 | @section SECTIONS Command |
252b5132 RH |
3136 | @kindex SECTIONS |
3137 | The @code{SECTIONS} command tells the linker how to map input sections | |
3138 | into output sections, and how to place the output sections in memory. | |
3139 | ||
3140 | The format of the @code{SECTIONS} command is: | |
3141 | @smallexample | |
3142 | SECTIONS | |
3143 | @{ | |
3144 | @var{sections-command} | |
3145 | @var{sections-command} | |
3146 | @dots{} | |
3147 | @} | |
3148 | @end smallexample | |
3149 | ||
3150 | Each @var{sections-command} may of be one of the following: | |
3151 | ||
3152 | @itemize @bullet | |
3153 | @item | |
3154 | an @code{ENTRY} command (@pxref{Entry Point,,Entry command}) | |
3155 | @item | |
3156 | a symbol assignment (@pxref{Assignments}) | |
3157 | @item | |
3158 | an output section description | |
3159 | @item | |
3160 | an overlay description | |
3161 | @end itemize | |
3162 | ||
3163 | The @code{ENTRY} command and symbol assignments are permitted inside the | |
3164 | @code{SECTIONS} command for convenience in using the location counter in | |
3165 | those commands. This can also make the linker script easier to | |
3166 | understand because you can use those commands at meaningful points in | |
3167 | the layout of the output file. | |
3168 | ||
3169 | Output section descriptions and overlay descriptions are described | |
3170 | below. | |
3171 | ||
3172 | If you do not use a @code{SECTIONS} command in your linker script, the | |
3173 | linker will place each input section into an identically named output | |
3174 | section in the order that the sections are first encountered in the | |
3175 | input files. If all input sections are present in the first file, for | |
3176 | example, the order of sections in the output file will match the order | |
3177 | in the first input file. The first section will be at address zero. | |
3178 | ||
3179 | @menu | |
3180 | * Output Section Description:: Output section description | |
3181 | * Output Section Name:: Output section name | |
3182 | * Output Section Address:: Output section address | |
3183 | * Input Section:: Input section description | |
3184 | * Output Section Data:: Output section data | |
3185 | * Output Section Keywords:: Output section keywords | |
3186 | * Output Section Discarding:: Output section discarding | |
3187 | * Output Section Attributes:: Output section attributes | |
3188 | * Overlay Description:: Overlay description | |
3189 | @end menu | |
3190 | ||
3191 | @node Output Section Description | |
36f63dca | 3192 | @subsection Output Section Description |
252b5132 RH |
3193 | The full description of an output section looks like this: |
3194 | @smallexample | |
a1ab1d2a | 3195 | @group |
7e7d5768 | 3196 | @var{section} [@var{address}] [(@var{type})] : |
bbf115d3 | 3197 | [AT(@var{lma})] [ALIGN(@var{section_align})] [SUBALIGN(@var{subsection_align})] |
252b5132 RH |
3198 | @{ |
3199 | @var{output-section-command} | |
3200 | @var{output-section-command} | |
3201 | @dots{} | |
562d3460 | 3202 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
3203 | @end group |
3204 | @end smallexample | |
3205 | ||
3206 | Most output sections do not use most of the optional section attributes. | |
3207 | ||
3208 | The whitespace around @var{section} is required, so that the section | |
3209 | name is unambiguous. The colon and the curly braces are also required. | |
3210 | The line breaks and other white space are optional. | |
3211 | ||
3212 | Each @var{output-section-command} may be one of the following: | |
3213 | ||
3214 | @itemize @bullet | |
3215 | @item | |
3216 | a symbol assignment (@pxref{Assignments}) | |
3217 | @item | |
3218 | an input section description (@pxref{Input Section}) | |
3219 | @item | |
3220 | data values to include directly (@pxref{Output Section Data}) | |
3221 | @item | |
3222 | a special output section keyword (@pxref{Output Section Keywords}) | |
3223 | @end itemize | |
3224 | ||
3225 | @node Output Section Name | |
36f63dca | 3226 | @subsection Output Section Name |
252b5132 RH |
3227 | @cindex name, section |
3228 | @cindex section name | |
3229 | The name of the output section is @var{section}. @var{section} must | |
3230 | meet the constraints of your output format. In formats which only | |
3231 | support a limited number of sections, such as @code{a.out}, the name | |
3232 | must be one of the names supported by the format (@code{a.out}, for | |
3233 | example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the | |
3234 | output format supports any number of sections, but with numbers and not | |
3235 | names (as is the case for Oasys), the name should be supplied as a | |
3236 | quoted numeric string. A section name may consist of any sequence of | |
3237 | characters, but a name which contains any unusual characters such as | |
3238 | commas must be quoted. | |
3239 | ||
3240 | The output section name @samp{/DISCARD/} is special; @ref{Output Section | |
3241 | Discarding}. | |
3242 | ||
3243 | @node Output Section Address | |
2a16d82a | 3244 | @subsection Output Section Address |
252b5132 RH |
3245 | @cindex address, section |
3246 | @cindex section address | |
3247 | The @var{address} is an expression for the VMA (the virtual memory | |
3248 | address) of the output section. If you do not provide @var{address}, | |
3249 | the linker will set it based on @var{region} if present, or otherwise | |
3250 | based on the current value of the location counter. | |
3251 | ||
3252 | If you provide @var{address}, the address of the output section will be | |
3253 | set to precisely that. If you provide neither @var{address} nor | |
3254 | @var{region}, then the address of the output section will be set to the | |
3255 | current value of the location counter aligned to the alignment | |
3256 | requirements of the output section. The alignment requirement of the | |
3257 | output section is the strictest alignment of any input section contained | |
3258 | within the output section. | |
3259 | ||
3260 | For example, | |
3261 | @smallexample | |
3262 | .text . : @{ *(.text) @} | |
3263 | @end smallexample | |
3264 | @noindent | |
3265 | and | |
3266 | @smallexample | |
3267 | .text : @{ *(.text) @} | |
3268 | @end smallexample | |
3269 | @noindent | |
3270 | are subtly different. The first will set the address of the | |
3271 | @samp{.text} output section to the current value of the location | |
3272 | counter. The second will set it to the current value of the location | |
3273 | counter aligned to the strictest alignment of a @samp{.text} input | |
3274 | section. | |
3275 | ||
3276 | The @var{address} may be an arbitrary expression; @ref{Expressions}. | |
3277 | For example, if you want to align the section on a 0x10 byte boundary, | |
3278 | so that the lowest four bits of the section address are zero, you could | |
3279 | do something like this: | |
3280 | @smallexample | |
3281 | .text ALIGN(0x10) : @{ *(.text) @} | |
3282 | @end smallexample | |
3283 | @noindent | |
3284 | This works because @code{ALIGN} returns the current location counter | |
3285 | aligned upward to the specified value. | |
3286 | ||
3287 | Specifying @var{address} for a section will change the value of the | |
3288 | location counter. | |
3289 | ||
3290 | @node Input Section | |
36f63dca | 3291 | @subsection Input Section Description |
252b5132 RH |
3292 | @cindex input sections |
3293 | @cindex mapping input sections to output sections | |
3294 | The most common output section command is an input section description. | |
3295 | ||
3296 | The input section description is the most basic linker script operation. | |
3297 | You use output sections to tell the linker how to lay out your program | |
3298 | in memory. You use input section descriptions to tell the linker how to | |
3299 | map the input files into your memory layout. | |
3300 | ||
3301 | @menu | |
3302 | * Input Section Basics:: Input section basics | |
3303 | * Input Section Wildcards:: Input section wildcard patterns | |
3304 | * Input Section Common:: Input section for common symbols | |
3305 | * Input Section Keep:: Input section and garbage collection | |
3306 | * Input Section Example:: Input section example | |
3307 | @end menu | |
3308 | ||
3309 | @node Input Section Basics | |
36f63dca | 3310 | @subsubsection Input Section Basics |
252b5132 RH |
3311 | @cindex input section basics |
3312 | An input section description consists of a file name optionally followed | |
3313 | by a list of section names in parentheses. | |
3314 | ||
3315 | The file name and the section name may be wildcard patterns, which we | |
3316 | describe further below (@pxref{Input Section Wildcards}). | |
3317 | ||
3318 | The most common input section description is to include all input | |
3319 | sections with a particular name in the output section. For example, to | |
3320 | include all input @samp{.text} sections, you would write: | |
3321 | @smallexample | |
3322 | *(.text) | |
3323 | @end smallexample | |
3324 | @noindent | |
18625d54 CM |
3325 | Here the @samp{*} is a wildcard which matches any file name. To exclude a list |
3326 | of files from matching the file name wildcard, EXCLUDE_FILE may be used to | |
3327 | match all files except the ones specified in the EXCLUDE_FILE list. For | |
3328 | example: | |
252b5132 | 3329 | @smallexample |
765b7cbe | 3330 | (*(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors)) |
252b5132 | 3331 | @end smallexample |
765b7cbe JB |
3332 | will cause all .ctors sections from all files except @file{crtend.o} and |
3333 | @file{otherfile.o} to be included. | |
252b5132 RH |
3334 | |
3335 | There are two ways to include more than one section: | |
3336 | @smallexample | |
3337 | *(.text .rdata) | |
3338 | *(.text) *(.rdata) | |
3339 | @end smallexample | |
3340 | @noindent | |
3341 | The difference between these is the order in which the @samp{.text} and | |
3342 | @samp{.rdata} input sections will appear in the output section. In the | |
b6bf44ba AM |
3343 | first example, they will be intermingled, appearing in the same order as |
3344 | they are found in the linker input. In the second example, all | |
252b5132 RH |
3345 | @samp{.text} input sections will appear first, followed by all |
3346 | @samp{.rdata} input sections. | |
3347 | ||
3348 | You can specify a file name to include sections from a particular file. | |
3349 | You would do this if one or more of your files contain special data that | |
3350 | needs to be at a particular location in memory. For example: | |
3351 | @smallexample | |
3352 | data.o(.data) | |
3353 | @end smallexample | |
3354 | ||
3355 | If you use a file name without a list of sections, then all sections in | |
3356 | the input file will be included in the output section. This is not | |
3357 | commonly done, but it may by useful on occasion. For example: | |
3358 | @smallexample | |
3359 | data.o | |
3360 | @end smallexample | |
3361 | ||
3362 | When you use a file name which does not contain any wild card | |
3363 | characters, the linker will first see if you also specified the file | |
3364 | name on the linker command line or in an @code{INPUT} command. If you | |
3365 | did not, the linker will attempt to open the file as an input file, as | |
3366 | though it appeared on the command line. Note that this differs from an | |
3367 | @code{INPUT} command, because the linker will not search for the file in | |
3368 | the archive search path. | |
3369 | ||
3370 | @node Input Section Wildcards | |
36f63dca | 3371 | @subsubsection Input Section Wildcard Patterns |
252b5132 RH |
3372 | @cindex input section wildcards |
3373 | @cindex wildcard file name patterns | |
3374 | @cindex file name wildcard patterns | |
3375 | @cindex section name wildcard patterns | |
3376 | In an input section description, either the file name or the section | |
3377 | name or both may be wildcard patterns. | |
3378 | ||
3379 | The file name of @samp{*} seen in many examples is a simple wildcard | |
3380 | pattern for the file name. | |
3381 | ||
3382 | The wildcard patterns are like those used by the Unix shell. | |
3383 | ||
3384 | @table @samp | |
3385 | @item * | |
3386 | matches any number of characters | |
3387 | @item ? | |
3388 | matches any single character | |
3389 | @item [@var{chars}] | |
3390 | matches a single instance of any of the @var{chars}; the @samp{-} | |
3391 | character may be used to specify a range of characters, as in | |
3392 | @samp{[a-z]} to match any lower case letter | |
3393 | @item \ | |
3394 | quotes the following character | |
3395 | @end table | |
3396 | ||
3397 | When a file name is matched with a wildcard, the wildcard characters | |
3398 | will not match a @samp{/} character (used to separate directory names on | |
3399 | Unix). A pattern consisting of a single @samp{*} character is an | |
3400 | exception; it will always match any file name, whether it contains a | |
3401 | @samp{/} or not. In a section name, the wildcard characters will match | |
3402 | a @samp{/} character. | |
3403 | ||
3404 | File name wildcard patterns only match files which are explicitly | |
3405 | specified on the command line or in an @code{INPUT} command. The linker | |
3406 | does not search directories to expand wildcards. | |
3407 | ||
3408 | If a file name matches more than one wildcard pattern, or if a file name | |
3409 | appears explicitly and is also matched by a wildcard pattern, the linker | |
3410 | will use the first match in the linker script. For example, this | |
3411 | sequence of input section descriptions is probably in error, because the | |
3412 | @file{data.o} rule will not be used: | |
3413 | @smallexample | |
3414 | .data : @{ *(.data) @} | |
3415 | .data1 : @{ data.o(.data) @} | |
3416 | @end smallexample | |
3417 | ||
bcaa7b3e | 3418 | @cindex SORT_BY_NAME |
252b5132 RH |
3419 | Normally, the linker will place files and sections matched by wildcards |
3420 | in the order in which they are seen during the link. You can change | |
bcaa7b3e L |
3421 | this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard |
3422 | pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the | |
3423 | @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections | |
252b5132 RH |
3424 | into ascending order by name before placing them in the output file. |
3425 | ||
bcaa7b3e L |
3426 | @cindex SORT_BY_ALIGNMENT |
3427 | @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The | |
3428 | difference is @code{SORT_BY_ALIGNMENT} will sort sections into | |
3429 | ascending order by alignment before placing them in the output file. | |
3430 | ||
3431 | @cindex SORT | |
3432 | @code{SORT} is an alias for @code{SORT_BY_NAME}. | |
3433 | ||
3434 | When there are nested section sorting commands in linker script, there | |
3435 | can be at most 1 level of nesting for section sorting commands. | |
3436 | ||
3437 | @enumerate | |
3438 | @item | |
3439 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
3440 | It will sort the input sections by name first, then by alignment if 2 | |
3441 | sections have the same name. | |
3442 | @item | |
3443 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
3444 | It will sort the input sections by alignment first, then by name if 2 | |
3445 | sections have the same alignment. | |
3446 | @item | |
c0065db7 | 3447 | @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is |
bcaa7b3e L |
3448 | treated the same as @code{SORT_BY_NAME} (wildcard section pattern). |
3449 | @item | |
3450 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)) | |
3451 | is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern). | |
3452 | @item | |
3453 | All other nested section sorting commands are invalid. | |
3454 | @end enumerate | |
3455 | ||
3456 | When both command line section sorting option and linker script | |
3457 | section sorting command are used, section sorting command always | |
3458 | takes precedence over the command line option. | |
3459 | ||
3460 | If the section sorting command in linker script isn't nested, the | |
3461 | command line option will make the section sorting command to be | |
3462 | treated as nested sorting command. | |
3463 | ||
3464 | @enumerate | |
3465 | @item | |
3466 | @code{SORT_BY_NAME} (wildcard section pattern ) with | |
3467 | @option{--sort-sections alignment} is equivalent to | |
3468 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
3469 | @item | |
3470 | @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with | |
3471 | @option{--sort-section name} is equivalent to | |
3472 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
3473 | @end enumerate | |
3474 | ||
3475 | If the section sorting command in linker script is nested, the | |
3476 | command line option will be ignored. | |
3477 | ||
252b5132 RH |
3478 | If you ever get confused about where input sections are going, use the |
3479 | @samp{-M} linker option to generate a map file. The map file shows | |
3480 | precisely how input sections are mapped to output sections. | |
3481 | ||
3482 | This example shows how wildcard patterns might be used to partition | |
3483 | files. This linker script directs the linker to place all @samp{.text} | |
3484 | sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}. | |
3485 | The linker will place the @samp{.data} section from all files beginning | |
3486 | with an upper case character in @samp{.DATA}; for all other files, the | |
3487 | linker will place the @samp{.data} section in @samp{.data}. | |
3488 | @smallexample | |
3489 | @group | |
3490 | SECTIONS @{ | |
3491 | .text : @{ *(.text) @} | |
3492 | .DATA : @{ [A-Z]*(.data) @} | |
3493 | .data : @{ *(.data) @} | |
3494 | .bss : @{ *(.bss) @} | |
3495 | @} | |
3496 | @end group | |
3497 | @end smallexample | |
3498 | ||
3499 | @node Input Section Common | |
36f63dca | 3500 | @subsubsection Input Section for Common Symbols |
252b5132 RH |
3501 | @cindex common symbol placement |
3502 | @cindex uninitialized data placement | |
3503 | A special notation is needed for common symbols, because in many object | |
3504 | file formats common symbols do not have a particular input section. The | |
3505 | linker treats common symbols as though they are in an input section | |
3506 | named @samp{COMMON}. | |
3507 | ||
3508 | You may use file names with the @samp{COMMON} section just as with any | |
3509 | other input sections. You can use this to place common symbols from a | |
3510 | particular input file in one section while common symbols from other | |
3511 | input files are placed in another section. | |
3512 | ||
3513 | In most cases, common symbols in input files will be placed in the | |
3514 | @samp{.bss} section in the output file. For example: | |
3515 | @smallexample | |
3516 | .bss @{ *(.bss) *(COMMON) @} | |
3517 | @end smallexample | |
3518 | ||
3519 | @cindex scommon section | |
3520 | @cindex small common symbols | |
3521 | Some object file formats have more than one type of common symbol. For | |
3522 | example, the MIPS ELF object file format distinguishes standard common | |
3523 | symbols and small common symbols. In this case, the linker will use a | |
3524 | different special section name for other types of common symbols. In | |
3525 | the case of MIPS ELF, the linker uses @samp{COMMON} for standard common | |
3526 | symbols and @samp{.scommon} for small common symbols. This permits you | |
3527 | to map the different types of common symbols into memory at different | |
3528 | locations. | |
3529 | ||
3530 | @cindex [COMMON] | |
3531 | You will sometimes see @samp{[COMMON]} in old linker scripts. This | |
3532 | notation is now considered obsolete. It is equivalent to | |
3533 | @samp{*(COMMON)}. | |
3534 | ||
3535 | @node Input Section Keep | |
36f63dca | 3536 | @subsubsection Input Section and Garbage Collection |
252b5132 RH |
3537 | @cindex KEEP |
3538 | @cindex garbage collection | |
3539 | When link-time garbage collection is in use (@samp{--gc-sections}), | |
a1ab1d2a | 3540 | it is often useful to mark sections that should not be eliminated. |
252b5132 RH |
3541 | This is accomplished by surrounding an input section's wildcard entry |
3542 | with @code{KEEP()}, as in @code{KEEP(*(.init))} or | |
bcaa7b3e | 3543 | @code{KEEP(SORT_BY_NAME(*)(.ctors))}. |
252b5132 RH |
3544 | |
3545 | @node Input Section Example | |
36f63dca | 3546 | @subsubsection Input Section Example |
252b5132 RH |
3547 | The following example is a complete linker script. It tells the linker |
3548 | to read all of the sections from file @file{all.o} and place them at the | |
3549 | start of output section @samp{outputa} which starts at location | |
3550 | @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o} | |
3551 | follows immediately, in the same output section. All of section | |
3552 | @samp{.input2} from @file{foo.o} goes into output section | |
3553 | @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}. | |
3554 | All of the remaining @samp{.input1} and @samp{.input2} sections from any | |
3555 | files are written to output section @samp{outputc}. | |
3556 | ||
3557 | @smallexample | |
3558 | @group | |
3559 | SECTIONS @{ | |
3560 | outputa 0x10000 : | |
3561 | @{ | |
3562 | all.o | |
3563 | foo.o (.input1) | |
3564 | @} | |
36f63dca NC |
3565 | @end group |
3566 | @group | |
252b5132 RH |
3567 | outputb : |
3568 | @{ | |
3569 | foo.o (.input2) | |
3570 | foo1.o (.input1) | |
3571 | @} | |
36f63dca NC |
3572 | @end group |
3573 | @group | |
252b5132 RH |
3574 | outputc : |
3575 | @{ | |
3576 | *(.input1) | |
3577 | *(.input2) | |
3578 | @} | |
3579 | @} | |
3580 | @end group | |
a1ab1d2a | 3581 | @end smallexample |
252b5132 RH |
3582 | |
3583 | @node Output Section Data | |
36f63dca | 3584 | @subsection Output Section Data |
252b5132 RH |
3585 | @cindex data |
3586 | @cindex section data | |
3587 | @cindex output section data | |
3588 | @kindex BYTE(@var{expression}) | |
3589 | @kindex SHORT(@var{expression}) | |
3590 | @kindex LONG(@var{expression}) | |
3591 | @kindex QUAD(@var{expression}) | |
3592 | @kindex SQUAD(@var{expression}) | |
3593 | You can include explicit bytes of data in an output section by using | |
3594 | @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as | |
3595 | an output section command. Each keyword is followed by an expression in | |
3596 | parentheses providing the value to store (@pxref{Expressions}). The | |
3597 | value of the expression is stored at the current value of the location | |
3598 | counter. | |
3599 | ||
3600 | The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands | |
3601 | store one, two, four, and eight bytes (respectively). After storing the | |
3602 | bytes, the location counter is incremented by the number of bytes | |
3603 | stored. | |
3604 | ||
3605 | For example, this will store the byte 1 followed by the four byte value | |
3606 | of the symbol @samp{addr}: | |
3607 | @smallexample | |
3608 | BYTE(1) | |
3609 | LONG(addr) | |
3610 | @end smallexample | |
3611 | ||
3612 | When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the | |
3613 | same; they both store an 8 byte, or 64 bit, value. When both host and | |
3614 | target are 32 bits, an expression is computed as 32 bits. In this case | |
3615 | @code{QUAD} stores a 32 bit value zero extended to 64 bits, and | |
3616 | @code{SQUAD} stores a 32 bit value sign extended to 64 bits. | |
3617 | ||
3618 | If the object file format of the output file has an explicit endianness, | |
3619 | which is the normal case, the value will be stored in that endianness. | |
3620 | When the object file format does not have an explicit endianness, as is | |
3621 | true of, for example, S-records, the value will be stored in the | |
3622 | endianness of the first input object file. | |
3623 | ||
36f63dca | 3624 | Note---these commands only work inside a section description and not |
2b5fc1f5 NC |
3625 | between them, so the following will produce an error from the linker: |
3626 | @smallexample | |
3627 | SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@ | |
3628 | @end smallexample | |
3629 | whereas this will work: | |
3630 | @smallexample | |
3631 | SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@ | |
3632 | @end smallexample | |
3633 | ||
252b5132 RH |
3634 | @kindex FILL(@var{expression}) |
3635 | @cindex holes, filling | |
3636 | @cindex unspecified memory | |
3637 | You may use the @code{FILL} command to set the fill pattern for the | |
3638 | current section. It is followed by an expression in parentheses. Any | |
3639 | otherwise unspecified regions of memory within the section (for example, | |
3640 | gaps left due to the required alignment of input sections) are filled | |
a139d329 | 3641 | with the value of the expression, repeated as |
252b5132 RH |
3642 | necessary. A @code{FILL} statement covers memory locations after the |
3643 | point at which it occurs in the section definition; by including more | |
3644 | than one @code{FILL} statement, you can have different fill patterns in | |
3645 | different parts of an output section. | |
3646 | ||
3647 | This example shows how to fill unspecified regions of memory with the | |
563e308f | 3648 | value @samp{0x90}: |
252b5132 | 3649 | @smallexample |
563e308f | 3650 | FILL(0x90909090) |
252b5132 RH |
3651 | @end smallexample |
3652 | ||
3653 | The @code{FILL} command is similar to the @samp{=@var{fillexp}} output | |
9673c93c | 3654 | section attribute, but it only affects the |
252b5132 RH |
3655 | part of the section following the @code{FILL} command, rather than the |
3656 | entire section. If both are used, the @code{FILL} command takes | |
9673c93c | 3657 | precedence. @xref{Output Section Fill}, for details on the fill |
a139d329 | 3658 | expression. |
252b5132 RH |
3659 | |
3660 | @node Output Section Keywords | |
36f63dca | 3661 | @subsection Output Section Keywords |
252b5132 RH |
3662 | There are a couple of keywords which can appear as output section |
3663 | commands. | |
3664 | ||
3665 | @table @code | |
3666 | @kindex CREATE_OBJECT_SYMBOLS | |
3667 | @cindex input filename symbols | |
3668 | @cindex filename symbols | |
3669 | @item CREATE_OBJECT_SYMBOLS | |
3670 | The command tells the linker to create a symbol for each input file. | |
3671 | The name of each symbol will be the name of the corresponding input | |
3672 | file. The section of each symbol will be the output section in which | |
3673 | the @code{CREATE_OBJECT_SYMBOLS} command appears. | |
3674 | ||
3675 | This is conventional for the a.out object file format. It is not | |
3676 | normally used for any other object file format. | |
3677 | ||
3678 | @kindex CONSTRUCTORS | |
3679 | @cindex C++ constructors, arranging in link | |
3680 | @cindex constructors, arranging in link | |
3681 | @item CONSTRUCTORS | |
3682 | When linking using the a.out object file format, the linker uses an | |
3683 | unusual set construct to support C++ global constructors and | |
3684 | destructors. When linking object file formats which do not support | |
3685 | arbitrary sections, such as ECOFF and XCOFF, the linker will | |
3686 | automatically recognize C++ global constructors and destructors by name. | |
3687 | For these object file formats, the @code{CONSTRUCTORS} command tells the | |
3688 | linker to place constructor information in the output section where the | |
3689 | @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is | |
3690 | ignored for other object file formats. | |
3691 | ||
3692 | The symbol @w{@code{__CTOR_LIST__}} marks the start of the global | |
7e69709c AM |
3693 | constructors, and the symbol @w{@code{__CTOR_END__}} marks the end. |
3694 | Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark | |
3695 | the start and end of the global destructors. The | |
252b5132 RH |
3696 | first word in the list is the number of entries, followed by the address |
3697 | of each constructor or destructor, followed by a zero word. The | |
3698 | compiler must arrange to actually run the code. For these object file | |
3699 | formats @sc{gnu} C++ normally calls constructors from a subroutine | |
3700 | @code{__main}; a call to @code{__main} is automatically inserted into | |
3701 | the startup code for @code{main}. @sc{gnu} C++ normally runs | |
3702 | destructors either by using @code{atexit}, or directly from the function | |
3703 | @code{exit}. | |
3704 | ||
3705 | For object file formats such as @code{COFF} or @code{ELF} which support | |
3706 | arbitrary section names, @sc{gnu} C++ will normally arrange to put the | |
3707 | addresses of global constructors and destructors into the @code{.ctors} | |
3708 | and @code{.dtors} sections. Placing the following sequence into your | |
3709 | linker script will build the sort of table which the @sc{gnu} C++ | |
3710 | runtime code expects to see. | |
3711 | ||
3712 | @smallexample | |
3713 | __CTOR_LIST__ = .; | |
3714 | LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2) | |
3715 | *(.ctors) | |
3716 | LONG(0) | |
3717 | __CTOR_END__ = .; | |
3718 | __DTOR_LIST__ = .; | |
3719 | LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2) | |
3720 | *(.dtors) | |
3721 | LONG(0) | |
3722 | __DTOR_END__ = .; | |
3723 | @end smallexample | |
3724 | ||
3725 | If you are using the @sc{gnu} C++ support for initialization priority, | |
3726 | which provides some control over the order in which global constructors | |
3727 | are run, you must sort the constructors at link time to ensure that they | |
3728 | are executed in the correct order. When using the @code{CONSTRUCTORS} | |
bcaa7b3e L |
3729 | command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the |
3730 | @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and | |
3731 | @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and | |
252b5132 RH |
3732 | @samp{*(.dtors)}. |
3733 | ||
3734 | Normally the compiler and linker will handle these issues automatically, | |
3735 | and you will not need to concern yourself with them. However, you may | |
3736 | need to consider this if you are using C++ and writing your own linker | |
3737 | scripts. | |
3738 | ||
3739 | @end table | |
3740 | ||
3741 | @node Output Section Discarding | |
36f63dca | 3742 | @subsection Output Section Discarding |
252b5132 RH |
3743 | @cindex discarding sections |
3744 | @cindex sections, discarding | |
3745 | @cindex removing sections | |
74541ad4 AM |
3746 | The linker will not create output sections with no contents. This is |
3747 | for convenience when referring to input sections that may or may not | |
3748 | be present in any of the input files. For example: | |
252b5132 | 3749 | @smallexample |
49c13adb | 3750 | .foo : @{ *(.foo) @} |
252b5132 RH |
3751 | @end smallexample |
3752 | @noindent | |
3753 | will only create a @samp{.foo} section in the output file if there is a | |
74541ad4 AM |
3754 | @samp{.foo} section in at least one input file, and if the input |
3755 | sections are not all empty. Other link script directives that allocate | |
3756 | space in an output section will also create the output section. | |
3757 | ||
a0976ea4 | 3758 | The linker will ignore address assignments (@pxref{Output Section Address}) |
74541ad4 AM |
3759 | on discarded output sections, except when the linker script defines |
3760 | symbols in the output section. In that case the linker will obey | |
a0976ea4 AM |
3761 | the address assignments, possibly advancing dot even though the |
3762 | section is discarded. | |
252b5132 RH |
3763 | |
3764 | @cindex /DISCARD/ | |
3765 | The special output section name @samp{/DISCARD/} may be used to discard | |
3766 | input sections. Any input sections which are assigned to an output | |
3767 | section named @samp{/DISCARD/} are not included in the output file. | |
3768 | ||
3769 | @node Output Section Attributes | |
36f63dca | 3770 | @subsection Output Section Attributes |
252b5132 RH |
3771 | @cindex output section attributes |
3772 | We showed above that the full description of an output section looked | |
3773 | like this: | |
3774 | @smallexample | |
a1ab1d2a | 3775 | @group |
7e7d5768 | 3776 | @var{section} [@var{address}] [(@var{type})] : |
bbf115d3 | 3777 | [AT(@var{lma})] [ALIGN(@var{section_align})] [SUBALIGN(@var{subsection_align})] |
252b5132 RH |
3778 | @{ |
3779 | @var{output-section-command} | |
3780 | @var{output-section-command} | |
3781 | @dots{} | |
562d3460 | 3782 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
3783 | @end group |
3784 | @end smallexample | |
3785 | We've already described @var{section}, @var{address}, and | |
3786 | @var{output-section-command}. In this section we will describe the | |
3787 | remaining section attributes. | |
3788 | ||
a1ab1d2a | 3789 | @menu |
252b5132 RH |
3790 | * Output Section Type:: Output section type |
3791 | * Output Section LMA:: Output section LMA | |
bbf115d3 | 3792 | * Forced Output Alignment:: Forced Output Alignment |
7e7d5768 | 3793 | * Forced Input Alignment:: Forced Input Alignment |
252b5132 RH |
3794 | * Output Section Region:: Output section region |
3795 | * Output Section Phdr:: Output section phdr | |
3796 | * Output Section Fill:: Output section fill | |
3797 | @end menu | |
3798 | ||
3799 | @node Output Section Type | |
36f63dca | 3800 | @subsubsection Output Section Type |
252b5132 RH |
3801 | Each output section may have a type. The type is a keyword in |
3802 | parentheses. The following types are defined: | |
3803 | ||
3804 | @table @code | |
3805 | @item NOLOAD | |
3806 | The section should be marked as not loadable, so that it will not be | |
3807 | loaded into memory when the program is run. | |
3808 | @item DSECT | |
3809 | @itemx COPY | |
3810 | @itemx INFO | |
3811 | @itemx OVERLAY | |
3812 | These type names are supported for backward compatibility, and are | |
3813 | rarely used. They all have the same effect: the section should be | |
3814 | marked as not allocatable, so that no memory is allocated for the | |
3815 | section when the program is run. | |
3816 | @end table | |
3817 | ||
3818 | @kindex NOLOAD | |
3819 | @cindex prevent unnecessary loading | |
3820 | @cindex loading, preventing | |
3821 | The linker normally sets the attributes of an output section based on | |
3822 | the input sections which map into it. You can override this by using | |
3823 | the section type. For example, in the script sample below, the | |
3824 | @samp{ROM} section is addressed at memory location @samp{0} and does not | |
3825 | need to be loaded when the program is run. The contents of the | |
3826 | @samp{ROM} section will appear in the linker output file as usual. | |
3827 | @smallexample | |
3828 | @group | |
3829 | SECTIONS @{ | |
3830 | ROM 0 (NOLOAD) : @{ @dots{} @} | |
3831 | @dots{} | |
3832 | @} | |
3833 | @end group | |
3834 | @end smallexample | |
3835 | ||
3836 | @node Output Section LMA | |
36f63dca | 3837 | @subsubsection Output Section LMA |
562d3460 | 3838 | @kindex AT>@var{lma_region} |
252b5132 RH |
3839 | @kindex AT(@var{lma}) |
3840 | @cindex load address | |
3841 | @cindex section load address | |
3842 | Every section has a virtual address (VMA) and a load address (LMA); see | |
3843 | @ref{Basic Script Concepts}. The address expression which may appear in | |
3844 | an output section description sets the VMA (@pxref{Output Section | |
3845 | Address}). | |
3846 | ||
dc0b6aa0 AM |
3847 | The expression @var{lma} that follows the @code{AT} keyword specifies |
3848 | the load address of the section. | |
6bdafbeb NC |
3849 | |
3850 | Alternatively, with @samp{AT>@var{lma_region}} expression, you may | |
3851 | specify a memory region for the section's load address. @xref{MEMORY}. | |
3852 | Note that if the section has not had a VMA assigned to it then the | |
3853 | linker will use the @var{lma_region} as the VMA region as well. | |
dc0b6aa0 AM |
3854 | |
3855 | If neither @code{AT} nor @code{AT>} is specified for an allocatable | |
3856 | section, the linker will set the LMA such that the difference between | |
3857 | VMA and LMA for the section is the same as the preceding output | |
3858 | section in the same region. If there is no preceding output section | |
3859 | or the section is not allocatable, the linker will set the LMA equal | |
3860 | to the VMA. | |
6bdafbeb | 3861 | @xref{Output Section Region}. |
252b5132 RH |
3862 | |
3863 | @cindex ROM initialized data | |
3864 | @cindex initialized data in ROM | |
3865 | This feature is designed to make it easy to build a ROM image. For | |
3866 | example, the following linker script creates three output sections: one | |
3867 | called @samp{.text}, which starts at @code{0x1000}, one called | |
3868 | @samp{.mdata}, which is loaded at the end of the @samp{.text} section | |
3869 | even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold | |
3870 | uninitialized data at address @code{0x3000}. The symbol @code{_data} is | |
3871 | defined with the value @code{0x2000}, which shows that the location | |
3872 | counter holds the VMA value, not the LMA value. | |
3873 | ||
3874 | @smallexample | |
3875 | @group | |
3876 | SECTIONS | |
3877 | @{ | |
3878 | .text 0x1000 : @{ *(.text) _etext = . ; @} | |
a1ab1d2a | 3879 | .mdata 0x2000 : |
252b5132 RH |
3880 | AT ( ADDR (.text) + SIZEOF (.text) ) |
3881 | @{ _data = . ; *(.data); _edata = . ; @} | |
3882 | .bss 0x3000 : | |
3883 | @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@} | |
3884 | @} | |
3885 | @end group | |
3886 | @end smallexample | |
3887 | ||
3888 | The run-time initialization code for use with a program generated with | |
3889 | this linker script would include something like the following, to copy | |
3890 | the initialized data from the ROM image to its runtime address. Notice | |
3891 | how this code takes advantage of the symbols defined by the linker | |
3892 | script. | |
3893 | ||
3894 | @smallexample | |
3895 | @group | |
3896 | extern char _etext, _data, _edata, _bstart, _bend; | |
3897 | char *src = &_etext; | |
3898 | char *dst = &_data; | |
3899 | ||
3900 | /* ROM has data at end of text; copy it. */ | |
3901 | while (dst < &_edata) @{ | |
3902 | *dst++ = *src++; | |
3903 | @} | |
3904 | ||
3905 | /* Zero bss */ | |
3906 | for (dst = &_bstart; dst< &_bend; dst++) | |
3907 | *dst = 0; | |
3908 | @end group | |
3909 | @end smallexample | |
3910 | ||
bbf115d3 L |
3911 | @node Forced Output Alignment |
3912 | @subsubsection Forced Output Alignment | |
3913 | @kindex ALIGN(@var{section_align}) | |
3914 | @cindex forcing output section alignment | |
3915 | @cindex output section alignment | |
7270c5ed | 3916 | You can increase an output section's alignment by using ALIGN. |
bbf115d3 | 3917 | |
7e7d5768 AM |
3918 | @node Forced Input Alignment |
3919 | @subsubsection Forced Input Alignment | |
3920 | @kindex SUBALIGN(@var{subsection_align}) | |
3921 | @cindex forcing input section alignment | |
3922 | @cindex input section alignment | |
3923 | You can force input section alignment within an output section by using | |
3924 | SUBALIGN. The value specified overrides any alignment given by input | |
3925 | sections, whether larger or smaller. | |
3926 | ||
252b5132 | 3927 | @node Output Section Region |
36f63dca | 3928 | @subsubsection Output Section Region |
252b5132 RH |
3929 | @kindex >@var{region} |
3930 | @cindex section, assigning to memory region | |
3931 | @cindex memory regions and sections | |
3932 | You can assign a section to a previously defined region of memory by | |
3933 | using @samp{>@var{region}}. @xref{MEMORY}. | |
3934 | ||
3935 | Here is a simple example: | |
3936 | @smallexample | |
3937 | @group | |
3938 | MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @} | |
3939 | SECTIONS @{ ROM : @{ *(.text) @} >rom @} | |
3940 | @end group | |
3941 | @end smallexample | |
3942 | ||
3943 | @node Output Section Phdr | |
36f63dca | 3944 | @subsubsection Output Section Phdr |
252b5132 RH |
3945 | @kindex :@var{phdr} |
3946 | @cindex section, assigning to program header | |
3947 | @cindex program headers and sections | |
3948 | You can assign a section to a previously defined program segment by | |
3949 | using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to | |
3950 | one or more segments, then all subsequent allocated sections will be | |
3951 | assigned to those segments as well, unless they use an explicitly | |
3952 | @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the | |
3953 | linker to not put the section in any segment at all. | |
3954 | ||
3955 | Here is a simple example: | |
3956 | @smallexample | |
3957 | @group | |
3958 | PHDRS @{ text PT_LOAD ; @} | |
3959 | SECTIONS @{ .text : @{ *(.text) @} :text @} | |
3960 | @end group | |
3961 | @end smallexample | |
3962 | ||
3963 | @node Output Section Fill | |
36f63dca | 3964 | @subsubsection Output Section Fill |
252b5132 RH |
3965 | @kindex =@var{fillexp} |
3966 | @cindex section fill pattern | |
3967 | @cindex fill pattern, entire section | |
3968 | You can set the fill pattern for an entire section by using | |
3969 | @samp{=@var{fillexp}}. @var{fillexp} is an expression | |
3970 | (@pxref{Expressions}). Any otherwise unspecified regions of memory | |
3971 | within the output section (for example, gaps left due to the required | |
a139d329 AM |
3972 | alignment of input sections) will be filled with the value, repeated as |
3973 | necessary. If the fill expression is a simple hex number, ie. a string | |
9673c93c | 3974 | of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then |
a139d329 AM |
3975 | an arbitrarily long sequence of hex digits can be used to specify the |
3976 | fill pattern; Leading zeros become part of the pattern too. For all | |
9673c93c | 3977 | other cases, including extra parentheses or a unary @code{+}, the fill |
a139d329 AM |
3978 | pattern is the four least significant bytes of the value of the |
3979 | expression. In all cases, the number is big-endian. | |
252b5132 RH |
3980 | |
3981 | You can also change the fill value with a @code{FILL} command in the | |
9673c93c | 3982 | output section commands; (@pxref{Output Section Data}). |
252b5132 RH |
3983 | |
3984 | Here is a simple example: | |
3985 | @smallexample | |
3986 | @group | |
563e308f | 3987 | SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @} |
252b5132 RH |
3988 | @end group |
3989 | @end smallexample | |
3990 | ||
3991 | @node Overlay Description | |
36f63dca | 3992 | @subsection Overlay Description |
252b5132 RH |
3993 | @kindex OVERLAY |
3994 | @cindex overlays | |
3995 | An overlay description provides an easy way to describe sections which | |
3996 | are to be loaded as part of a single memory image but are to be run at | |
3997 | the same memory address. At run time, some sort of overlay manager will | |
3998 | copy the overlaid sections in and out of the runtime memory address as | |
3999 | required, perhaps by simply manipulating addressing bits. This approach | |
4000 | can be useful, for example, when a certain region of memory is faster | |
4001 | than another. | |
4002 | ||
4003 | Overlays are described using the @code{OVERLAY} command. The | |
4004 | @code{OVERLAY} command is used within a @code{SECTIONS} command, like an | |
4005 | output section description. The full syntax of the @code{OVERLAY} | |
4006 | command is as follows: | |
4007 | @smallexample | |
4008 | @group | |
4009 | OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )] | |
4010 | @{ | |
4011 | @var{secname1} | |
4012 | @{ | |
4013 | @var{output-section-command} | |
4014 | @var{output-section-command} | |
4015 | @dots{} | |
4016 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
4017 | @var{secname2} | |
4018 | @{ | |
4019 | @var{output-section-command} | |
4020 | @var{output-section-command} | |
4021 | @dots{} | |
4022 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
4023 | @dots{} | |
4024 | @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] | |
4025 | @end group | |
4026 | @end smallexample | |
4027 | ||
4028 | Everything is optional except @code{OVERLAY} (a keyword), and each | |
4029 | section must have a name (@var{secname1} and @var{secname2} above). The | |
4030 | section definitions within the @code{OVERLAY} construct are identical to | |
4031 | those within the general @code{SECTIONS} contruct (@pxref{SECTIONS}), | |
4032 | except that no addresses and no memory regions may be defined for | |
4033 | sections within an @code{OVERLAY}. | |
4034 | ||
4035 | The sections are all defined with the same starting address. The load | |
4036 | addresses of the sections are arranged such that they are consecutive in | |
4037 | memory starting at the load address used for the @code{OVERLAY} as a | |
4038 | whole (as with normal section definitions, the load address is optional, | |
4039 | and defaults to the start address; the start address is also optional, | |
4040 | and defaults to the current value of the location counter). | |
4041 | ||
4042 | If the @code{NOCROSSREFS} keyword is used, and there any references | |
4043 | among the sections, the linker will report an error. Since the sections | |
4044 | all run at the same address, it normally does not make sense for one | |
4045 | section to refer directly to another. @xref{Miscellaneous Commands, | |
4046 | NOCROSSREFS}. | |
4047 | ||
4048 | For each section within the @code{OVERLAY}, the linker automatically | |
34711ca3 | 4049 | provides two symbols. The symbol @code{__load_start_@var{secname}} is |
252b5132 RH |
4050 | defined as the starting load address of the section. The symbol |
4051 | @code{__load_stop_@var{secname}} is defined as the final load address of | |
4052 | the section. Any characters within @var{secname} which are not legal | |
4053 | within C identifiers are removed. C (or assembler) code may use these | |
4054 | symbols to move the overlaid sections around as necessary. | |
4055 | ||
4056 | At the end of the overlay, the value of the location counter is set to | |
4057 | the start address of the overlay plus the size of the largest section. | |
4058 | ||
4059 | Here is an example. Remember that this would appear inside a | |
4060 | @code{SECTIONS} construct. | |
4061 | @smallexample | |
4062 | @group | |
4063 | OVERLAY 0x1000 : AT (0x4000) | |
4064 | @{ | |
4065 | .text0 @{ o1/*.o(.text) @} | |
4066 | .text1 @{ o2/*.o(.text) @} | |
4067 | @} | |
4068 | @end group | |
4069 | @end smallexample | |
4070 | @noindent | |
4071 | This will define both @samp{.text0} and @samp{.text1} to start at | |
4072 | address 0x1000. @samp{.text0} will be loaded at address 0x4000, and | |
4073 | @samp{.text1} will be loaded immediately after @samp{.text0}. The | |
34711ca3 | 4074 | following symbols will be defined if referenced: @code{__load_start_text0}, |
252b5132 RH |
4075 | @code{__load_stop_text0}, @code{__load_start_text1}, |
4076 | @code{__load_stop_text1}. | |
4077 | ||
4078 | C code to copy overlay @code{.text1} into the overlay area might look | |
4079 | like the following. | |
4080 | ||
4081 | @smallexample | |
4082 | @group | |
4083 | extern char __load_start_text1, __load_stop_text1; | |
4084 | memcpy ((char *) 0x1000, &__load_start_text1, | |
4085 | &__load_stop_text1 - &__load_start_text1); | |
4086 | @end group | |
4087 | @end smallexample | |
4088 | ||
4089 | Note that the @code{OVERLAY} command is just syntactic sugar, since | |
4090 | everything it does can be done using the more basic commands. The above | |
4091 | example could have been written identically as follows. | |
4092 | ||
4093 | @smallexample | |
4094 | @group | |
4095 | .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @} | |
34711ca3 AM |
4096 | PROVIDE (__load_start_text0 = LOADADDR (.text0)); |
4097 | PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0)); | |
252b5132 | 4098 | .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @} |
34711ca3 AM |
4099 | PROVIDE (__load_start_text1 = LOADADDR (.text1)); |
4100 | PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1)); | |
252b5132 RH |
4101 | . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1)); |
4102 | @end group | |
4103 | @end smallexample | |
4104 | ||
4105 | @node MEMORY | |
36f63dca | 4106 | @section MEMORY Command |
252b5132 RH |
4107 | @kindex MEMORY |
4108 | @cindex memory regions | |
4109 | @cindex regions of memory | |
4110 | @cindex allocating memory | |
4111 | @cindex discontinuous memory | |
4112 | The linker's default configuration permits allocation of all available | |
4113 | memory. You can override this by using the @code{MEMORY} command. | |
4114 | ||
4115 | The @code{MEMORY} command describes the location and size of blocks of | |
4116 | memory in the target. You can use it to describe which memory regions | |
4117 | may be used by the linker, and which memory regions it must avoid. You | |
4118 | can then assign sections to particular memory regions. The linker will | |
4119 | set section addresses based on the memory regions, and will warn about | |
4120 | regions that become too full. The linker will not shuffle sections | |
4121 | around to fit into the available regions. | |
4122 | ||
4123 | A linker script may contain at most one use of the @code{MEMORY} | |
4124 | command. However, you can define as many blocks of memory within it as | |
4125 | you wish. The syntax is: | |
4126 | @smallexample | |
4127 | @group | |
a1ab1d2a | 4128 | MEMORY |
252b5132 RH |
4129 | @{ |
4130 | @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len} | |
4131 | @dots{} | |
4132 | @} | |
4133 | @end group | |
4134 | @end smallexample | |
4135 | ||
4136 | The @var{name} is a name used in the linker script to refer to the | |
4137 | region. The region name has no meaning outside of the linker script. | |
4138 | Region names are stored in a separate name space, and will not conflict | |
4139 | with symbol names, file names, or section names. Each memory region | |
4140 | must have a distinct name. | |
4141 | ||
4142 | @cindex memory region attributes | |
4143 | The @var{attr} string is an optional list of attributes that specify | |
4144 | whether to use a particular memory region for an input section which is | |
4145 | not explicitly mapped in the linker script. As described in | |
4146 | @ref{SECTIONS}, if you do not specify an output section for some input | |
4147 | section, the linker will create an output section with the same name as | |
4148 | the input section. If you define region attributes, the linker will use | |
4149 | them to select the memory region for the output section that it creates. | |
4150 | ||
4151 | The @var{attr} string must consist only of the following characters: | |
4152 | @table @samp | |
4153 | @item R | |
4154 | Read-only section | |
4155 | @item W | |
4156 | Read/write section | |
4157 | @item X | |
4158 | Executable section | |
4159 | @item A | |
4160 | Allocatable section | |
4161 | @item I | |
4162 | Initialized section | |
4163 | @item L | |
4164 | Same as @samp{I} | |
4165 | @item ! | |
4166 | Invert the sense of any of the preceding attributes | |
4167 | @end table | |
4168 | ||
4169 | If a unmapped section matches any of the listed attributes other than | |
4170 | @samp{!}, it will be placed in the memory region. The @samp{!} | |
4171 | attribute reverses this test, so that an unmapped section will be placed | |
4172 | in the memory region only if it does not match any of the listed | |
4173 | attributes. | |
4174 | ||
4175 | @kindex ORIGIN = | |
4176 | @kindex o = | |
4177 | @kindex org = | |
9cd6d51a NC |
4178 | The @var{origin} is an numerical expression for the start address of |
4179 | the memory region. The expression must evaluate to a constant and it | |
4180 | cannot involve any symbols. The keyword @code{ORIGIN} may be | |
4181 | abbreviated to @code{org} or @code{o} (but not, for example, | |
4182 | @code{ORG}). | |
252b5132 RH |
4183 | |
4184 | @kindex LENGTH = | |
4185 | @kindex len = | |
4186 | @kindex l = | |
4187 | The @var{len} is an expression for the size in bytes of the memory | |
4188 | region. As with the @var{origin} expression, the expression must | |
9cd6d51a NC |
4189 | be numerical only and must evaluate to a constant. The keyword |
4190 | @code{LENGTH} may be abbreviated to @code{len} or @code{l}. | |
252b5132 RH |
4191 | |
4192 | In the following example, we specify that there are two memory regions | |
4193 | available for allocation: one starting at @samp{0} for 256 kilobytes, | |
4194 | and the other starting at @samp{0x40000000} for four megabytes. The | |
4195 | linker will place into the @samp{rom} memory region every section which | |
4196 | is not explicitly mapped into a memory region, and is either read-only | |
4197 | or executable. The linker will place other sections which are not | |
4198 | explicitly mapped into a memory region into the @samp{ram} memory | |
4199 | region. | |
4200 | ||
4201 | @smallexample | |
4202 | @group | |
a1ab1d2a | 4203 | MEMORY |
252b5132 RH |
4204 | @{ |
4205 | rom (rx) : ORIGIN = 0, LENGTH = 256K | |
4206 | ram (!rx) : org = 0x40000000, l = 4M | |
4207 | @} | |
4208 | @end group | |
4209 | @end smallexample | |
4210 | ||
4211 | Once you define a memory region, you can direct the linker to place | |
4212 | specific output sections into that memory region by using the | |
4213 | @samp{>@var{region}} output section attribute. For example, if you have | |
4214 | a memory region named @samp{mem}, you would use @samp{>mem} in the | |
4215 | output section definition. @xref{Output Section Region}. If no address | |
4216 | was specified for the output section, the linker will set the address to | |
4217 | the next available address within the memory region. If the combined | |
4218 | output sections directed to a memory region are too large for the | |
4219 | region, the linker will issue an error message. | |
4220 | ||
3ec57632 | 4221 | It is possible to access the origin and length of a memory in an |
c0065db7 | 4222 | expression via the @code{ORIGIN(@var{memory})} and |
3ec57632 NC |
4223 | @code{LENGTH(@var{memory})} functions: |
4224 | ||
4225 | @smallexample | |
4226 | @group | |
c0065db7 | 4227 | _fstack = ORIGIN(ram) + LENGTH(ram) - 4; |
3ec57632 NC |
4228 | @end group |
4229 | @end smallexample | |
4230 | ||
252b5132 RH |
4231 | @node PHDRS |
4232 | @section PHDRS Command | |
4233 | @kindex PHDRS | |
4234 | @cindex program headers | |
4235 | @cindex ELF program headers | |
4236 | @cindex program segments | |
4237 | @cindex segments, ELF | |
4238 | The ELF object file format uses @dfn{program headers}, also knows as | |
4239 | @dfn{segments}. The program headers describe how the program should be | |
4240 | loaded into memory. You can print them out by using the @code{objdump} | |
4241 | program with the @samp{-p} option. | |
4242 | ||
4243 | When you run an ELF program on a native ELF system, the system loader | |
4244 | reads the program headers in order to figure out how to load the | |
4245 | program. This will only work if the program headers are set correctly. | |
4246 | This manual does not describe the details of how the system loader | |
4247 | interprets program headers; for more information, see the ELF ABI. | |
4248 | ||
4249 | The linker will create reasonable program headers by default. However, | |
4250 | in some cases, you may need to specify the program headers more | |
4251 | precisely. You may use the @code{PHDRS} command for this purpose. When | |
4252 | the linker sees the @code{PHDRS} command in the linker script, it will | |
4253 | not create any program headers other than the ones specified. | |
4254 | ||
4255 | The linker only pays attention to the @code{PHDRS} command when | |
4256 | generating an ELF output file. In other cases, the linker will simply | |
4257 | ignore @code{PHDRS}. | |
4258 | ||
4259 | This is the syntax of the @code{PHDRS} command. The words @code{PHDRS}, | |
4260 | @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords. | |
4261 | ||
4262 | @smallexample | |
4263 | @group | |
4264 | PHDRS | |
4265 | @{ | |
4266 | @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ] | |
4267 | [ FLAGS ( @var{flags} ) ] ; | |
4268 | @} | |
4269 | @end group | |
4270 | @end smallexample | |
4271 | ||
4272 | The @var{name} is used only for reference in the @code{SECTIONS} command | |
4273 | of the linker script. It is not put into the output file. Program | |
4274 | header names are stored in a separate name space, and will not conflict | |
4275 | with symbol names, file names, or section names. Each program header | |
4276 | must have a distinct name. | |
4277 | ||
4278 | Certain program header types describe segments of memory which the | |
4279 | system loader will load from the file. In the linker script, you | |
4280 | specify the contents of these segments by placing allocatable output | |
4281 | sections in the segments. You use the @samp{:@var{phdr}} output section | |
4282 | attribute to place a section in a particular segment. @xref{Output | |
4283 | Section Phdr}. | |
4284 | ||
4285 | It is normal to put certain sections in more than one segment. This | |
4286 | merely implies that one segment of memory contains another. You may | |
4287 | repeat @samp{:@var{phdr}}, using it once for each segment which should | |
4288 | contain the section. | |
4289 | ||
4290 | If you place a section in one or more segments using @samp{:@var{phdr}}, | |
4291 | then the linker will place all subsequent allocatable sections which do | |
4292 | not specify @samp{:@var{phdr}} in the same segments. This is for | |
4293 | convenience, since generally a whole set of contiguous sections will be | |
4294 | placed in a single segment. You can use @code{:NONE} to override the | |
4295 | default segment and tell the linker to not put the section in any | |
4296 | segment at all. | |
4297 | ||
4298 | @kindex FILEHDR | |
4299 | @kindex PHDRS | |
4300 | You may use the @code{FILEHDR} and @code{PHDRS} keywords appear after | |
4301 | the program header type to further describe the contents of the segment. | |
4302 | The @code{FILEHDR} keyword means that the segment should include the ELF | |
4303 | file header. The @code{PHDRS} keyword means that the segment should | |
4304 | include the ELF program headers themselves. | |
4305 | ||
4306 | The @var{type} may be one of the following. The numbers indicate the | |
4307 | value of the keyword. | |
4308 | ||
4309 | @table @asis | |
4310 | @item @code{PT_NULL} (0) | |
4311 | Indicates an unused program header. | |
4312 | ||
4313 | @item @code{PT_LOAD} (1) | |
4314 | Indicates that this program header describes a segment to be loaded from | |
4315 | the file. | |
4316 | ||
4317 | @item @code{PT_DYNAMIC} (2) | |
4318 | Indicates a segment where dynamic linking information can be found. | |
4319 | ||
4320 | @item @code{PT_INTERP} (3) | |
4321 | Indicates a segment where the name of the program interpreter may be | |
4322 | found. | |
4323 | ||
4324 | @item @code{PT_NOTE} (4) | |
4325 | Indicates a segment holding note information. | |
4326 | ||
4327 | @item @code{PT_SHLIB} (5) | |
4328 | A reserved program header type, defined but not specified by the ELF | |
4329 | ABI. | |
4330 | ||
4331 | @item @code{PT_PHDR} (6) | |
4332 | Indicates a segment where the program headers may be found. | |
4333 | ||
4334 | @item @var{expression} | |
4335 | An expression giving the numeric type of the program header. This may | |
4336 | be used for types not defined above. | |
4337 | @end table | |
4338 | ||
4339 | You can specify that a segment should be loaded at a particular address | |
4340 | in memory by using an @code{AT} expression. This is identical to the | |
4341 | @code{AT} command used as an output section attribute (@pxref{Output | |
4342 | Section LMA}). The @code{AT} command for a program header overrides the | |
4343 | output section attribute. | |
4344 | ||
4345 | The linker will normally set the segment flags based on the sections | |
4346 | which comprise the segment. You may use the @code{FLAGS} keyword to | |
4347 | explicitly specify the segment flags. The value of @var{flags} must be | |
4348 | an integer. It is used to set the @code{p_flags} field of the program | |
4349 | header. | |
4350 | ||
4351 | Here is an example of @code{PHDRS}. This shows a typical set of program | |
4352 | headers used on a native ELF system. | |
4353 | ||
4354 | @example | |
4355 | @group | |
4356 | PHDRS | |
4357 | @{ | |
4358 | headers PT_PHDR PHDRS ; | |
4359 | interp PT_INTERP ; | |
4360 | text PT_LOAD FILEHDR PHDRS ; | |
4361 | data PT_LOAD ; | |
4362 | dynamic PT_DYNAMIC ; | |
4363 | @} | |
4364 | ||
4365 | SECTIONS | |
4366 | @{ | |
4367 | . = SIZEOF_HEADERS; | |
4368 | .interp : @{ *(.interp) @} :text :interp | |
4369 | .text : @{ *(.text) @} :text | |
4370 | .rodata : @{ *(.rodata) @} /* defaults to :text */ | |
4371 | @dots{} | |
4372 | . = . + 0x1000; /* move to a new page in memory */ | |
4373 | .data : @{ *(.data) @} :data | |
4374 | .dynamic : @{ *(.dynamic) @} :data :dynamic | |
4375 | @dots{} | |
4376 | @} | |
4377 | @end group | |
4378 | @end example | |
4379 | ||
4380 | @node VERSION | |
4381 | @section VERSION Command | |
4382 | @kindex VERSION @{script text@} | |
4383 | @cindex symbol versions | |
4384 | @cindex version script | |
4385 | @cindex versions of symbols | |
4386 | The linker supports symbol versions when using ELF. Symbol versions are | |
4387 | only useful when using shared libraries. The dynamic linker can use | |
4388 | symbol versions to select a specific version of a function when it runs | |
4389 | a program that may have been linked against an earlier version of the | |
4390 | shared library. | |
4391 | ||
4392 | You can include a version script directly in the main linker script, or | |
4393 | you can supply the version script as an implicit linker script. You can | |
4394 | also use the @samp{--version-script} linker option. | |
4395 | ||
4396 | The syntax of the @code{VERSION} command is simply | |
4397 | @smallexample | |
4398 | VERSION @{ version-script-commands @} | |
4399 | @end smallexample | |
4400 | ||
4401 | The format of the version script commands is identical to that used by | |
4402 | Sun's linker in Solaris 2.5. The version script defines a tree of | |
4403 | version nodes. You specify the node names and interdependencies in the | |
4404 | version script. You can specify which symbols are bound to which | |
4405 | version nodes, and you can reduce a specified set of symbols to local | |
4406 | scope so that they are not globally visible outside of the shared | |
4407 | library. | |
4408 | ||
4409 | The easiest way to demonstrate the version script language is with a few | |
4410 | examples. | |
4411 | ||
4412 | @smallexample | |
4413 | VERS_1.1 @{ | |
4414 | global: | |
4415 | foo1; | |
4416 | local: | |
a1ab1d2a UD |
4417 | old*; |
4418 | original*; | |
4419 | new*; | |
252b5132 RH |
4420 | @}; |
4421 | ||
4422 | VERS_1.2 @{ | |
4423 | foo2; | |
4424 | @} VERS_1.1; | |
4425 | ||
4426 | VERS_2.0 @{ | |
4427 | bar1; bar2; | |
c0065db7 | 4428 | extern "C++" @{ |
86043bbb MM |
4429 | ns::*; |
4430 | "int f(int, double)"; | |
c0065db7 | 4431 | @} |
252b5132 RH |
4432 | @} VERS_1.2; |
4433 | @end smallexample | |
4434 | ||
4435 | This example version script defines three version nodes. The first | |
4436 | version node defined is @samp{VERS_1.1}; it has no other dependencies. | |
4437 | The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces | |
4438 | a number of symbols to local scope so that they are not visible outside | |
313e35ee AM |
4439 | of the shared library; this is done using wildcard patterns, so that any |
4440 | symbol whose name begins with @samp{old}, @samp{original}, or @samp{new} | |
4441 | is matched. The wildcard patterns available are the same as those used | |
4442 | in the shell when matching filenames (also known as ``globbing''). | |
86043bbb MM |
4443 | However, if you specify the symbol name inside double quotes, then the |
4444 | name is treated as literal, rather than as a glob pattern. | |
252b5132 RH |
4445 | |
4446 | Next, the version script defines node @samp{VERS_1.2}. This node | |
4447 | depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2} | |
4448 | to the version node @samp{VERS_1.2}. | |
4449 | ||
4450 | Finally, the version script defines node @samp{VERS_2.0}. This node | |
4451 | depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1} | |
4452 | and @samp{bar2} are bound to the version node @samp{VERS_2.0}. | |
4453 | ||
4454 | When the linker finds a symbol defined in a library which is not | |
4455 | specifically bound to a version node, it will effectively bind it to an | |
4456 | unspecified base version of the library. You can bind all otherwise | |
a981ed6f | 4457 | unspecified symbols to a given version node by using @samp{global: *;} |
252b5132 RH |
4458 | somewhere in the version script. |
4459 | ||
4460 | The names of the version nodes have no specific meaning other than what | |
4461 | they might suggest to the person reading them. The @samp{2.0} version | |
4462 | could just as well have appeared in between @samp{1.1} and @samp{1.2}. | |
4463 | However, this would be a confusing way to write a version script. | |
4464 | ||
0f6bf451 | 4465 | Node name can be omitted, provided it is the only version node |
6b9b879a JJ |
4466 | in the version script. Such version script doesn't assign any versions to |
4467 | symbols, only selects which symbols will be globally visible out and which | |
4468 | won't. | |
4469 | ||
4470 | @smallexample | |
7c9c73be | 4471 | @{ global: foo; bar; local: *; @}; |
9d201f2f | 4472 | @end smallexample |
6b9b879a | 4473 | |
252b5132 RH |
4474 | When you link an application against a shared library that has versioned |
4475 | symbols, the application itself knows which version of each symbol it | |
4476 | requires, and it also knows which version nodes it needs from each | |
4477 | shared library it is linked against. Thus at runtime, the dynamic | |
4478 | loader can make a quick check to make sure that the libraries you have | |
4479 | linked against do in fact supply all of the version nodes that the | |
4480 | application will need to resolve all of the dynamic symbols. In this | |
4481 | way it is possible for the dynamic linker to know with certainty that | |
4482 | all external symbols that it needs will be resolvable without having to | |
4483 | search for each symbol reference. | |
4484 | ||
4485 | The symbol versioning is in effect a much more sophisticated way of | |
4486 | doing minor version checking that SunOS does. The fundamental problem | |
4487 | that is being addressed here is that typically references to external | |
4488 | functions are bound on an as-needed basis, and are not all bound when | |
4489 | the application starts up. If a shared library is out of date, a | |
4490 | required interface may be missing; when the application tries to use | |
4491 | that interface, it may suddenly and unexpectedly fail. With symbol | |
4492 | versioning, the user will get a warning when they start their program if | |
4493 | the libraries being used with the application are too old. | |
4494 | ||
4495 | There are several GNU extensions to Sun's versioning approach. The | |
4496 | first of these is the ability to bind a symbol to a version node in the | |
4497 | source file where the symbol is defined instead of in the versioning | |
4498 | script. This was done mainly to reduce the burden on the library | |
4499 | maintainer. You can do this by putting something like: | |
4500 | @smallexample | |
4501 | __asm__(".symver original_foo,foo@@VERS_1.1"); | |
4502 | @end smallexample | |
4503 | @noindent | |
4504 | in the C source file. This renames the function @samp{original_foo} to | |
4505 | be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}. | |
4506 | The @samp{local:} directive can be used to prevent the symbol | |
96a94295 L |
4507 | @samp{original_foo} from being exported. A @samp{.symver} directive |
4508 | takes precedence over a version script. | |
252b5132 RH |
4509 | |
4510 | The second GNU extension is to allow multiple versions of the same | |
4511 | function to appear in a given shared library. In this way you can make | |
4512 | an incompatible change to an interface without increasing the major | |
4513 | version number of the shared library, while still allowing applications | |
4514 | linked against the old interface to continue to function. | |
4515 | ||
4516 | To do this, you must use multiple @samp{.symver} directives in the | |
4517 | source file. Here is an example: | |
4518 | ||
4519 | @smallexample | |
4520 | __asm__(".symver original_foo,foo@@"); | |
4521 | __asm__(".symver old_foo,foo@@VERS_1.1"); | |
4522 | __asm__(".symver old_foo1,foo@@VERS_1.2"); | |
4523 | __asm__(".symver new_foo,foo@@@@VERS_2.0"); | |
4524 | @end smallexample | |
4525 | ||
4526 | In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the | |
4527 | unspecified base version of the symbol. The source file that contains this | |
4528 | example would define 4 C functions: @samp{original_foo}, @samp{old_foo}, | |
4529 | @samp{old_foo1}, and @samp{new_foo}. | |
4530 | ||
4531 | When you have multiple definitions of a given symbol, there needs to be | |
4532 | some way to specify a default version to which external references to | |
4533 | this symbol will be bound. You can do this with the | |
4534 | @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only | |
4535 | declare one version of a symbol as the default in this manner; otherwise | |
4536 | you would effectively have multiple definitions of the same symbol. | |
4537 | ||
4538 | If you wish to bind a reference to a specific version of the symbol | |
4539 | within the shared library, you can use the aliases of convenience | |
36f63dca | 4540 | (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to |
252b5132 RH |
4541 | specifically bind to an external version of the function in question. |
4542 | ||
cb840a31 L |
4543 | You can also specify the language in the version script: |
4544 | ||
4545 | @smallexample | |
4546 | VERSION extern "lang" @{ version-script-commands @} | |
4547 | @end smallexample | |
4548 | ||
c0065db7 | 4549 | The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}. |
cb840a31 L |
4550 | The linker will iterate over the list of symbols at the link time and |
4551 | demangle them according to @samp{lang} before matching them to the | |
4552 | patterns specified in @samp{version-script-commands}. | |
4553 | ||
86043bbb MM |
4554 | Demangled names may contains spaces and other special characters. As |
4555 | described above, you can use a glob pattern to match demangled names, | |
4556 | or you can use a double-quoted string to match the string exactly. In | |
4557 | the latter case, be aware that minor differences (such as differing | |
4558 | whitespace) between the version script and the demangler output will | |
4559 | cause a mismatch. As the exact string generated by the demangler | |
4560 | might change in the future, even if the mangled name does not, you | |
4561 | should check that all of your version directives are behaving as you | |
4562 | expect when you upgrade. | |
4563 | ||
252b5132 RH |
4564 | @node Expressions |
4565 | @section Expressions in Linker Scripts | |
4566 | @cindex expressions | |
4567 | @cindex arithmetic | |
4568 | The syntax for expressions in the linker script language is identical to | |
4569 | that of C expressions. All expressions are evaluated as integers. All | |
4570 | expressions are evaluated in the same size, which is 32 bits if both the | |
4571 | host and target are 32 bits, and is otherwise 64 bits. | |
4572 | ||
4573 | You can use and set symbol values in expressions. | |
4574 | ||
4575 | The linker defines several special purpose builtin functions for use in | |
4576 | expressions. | |
4577 | ||
4578 | @menu | |
4579 | * Constants:: Constants | |
4580 | * Symbols:: Symbol Names | |
ecca9871 | 4581 | * Orphan Sections:: Orphan Sections |
252b5132 RH |
4582 | * Location Counter:: The Location Counter |
4583 | * Operators:: Operators | |
4584 | * Evaluation:: Evaluation | |
4585 | * Expression Section:: The Section of an Expression | |
4586 | * Builtin Functions:: Builtin Functions | |
4587 | @end menu | |
4588 | ||
4589 | @node Constants | |
4590 | @subsection Constants | |
4591 | @cindex integer notation | |
4592 | @cindex constants in linker scripts | |
4593 | All constants are integers. | |
4594 | ||
4595 | As in C, the linker considers an integer beginning with @samp{0} to be | |
4596 | octal, and an integer beginning with @samp{0x} or @samp{0X} to be | |
4597 | hexadecimal. The linker considers other integers to be decimal. | |
4598 | ||
4599 | @cindex scaled integers | |
4600 | @cindex K and M integer suffixes | |
4601 | @cindex M and K integer suffixes | |
4602 | @cindex suffixes for integers | |
4603 | @cindex integer suffixes | |
4604 | In addition, you can use the suffixes @code{K} and @code{M} to scale a | |
4605 | constant by | |
4606 | @c TEXI2ROFF-KILL | |
36f63dca | 4607 | @ifnottex |
252b5132 RH |
4608 | @c END TEXI2ROFF-KILL |
4609 | @code{1024} or @code{1024*1024} | |
4610 | @c TEXI2ROFF-KILL | |
36f63dca | 4611 | @end ifnottex |
252b5132 RH |
4612 | @tex |
4613 | ${\rm 1024}$ or ${\rm 1024}^2$ | |
4614 | @end tex | |
4615 | @c END TEXI2ROFF-KILL | |
4616 | respectively. For example, the following all refer to the same quantity: | |
4617 | @smallexample | |
36f63dca NC |
4618 | _fourk_1 = 4K; |
4619 | _fourk_2 = 4096; | |
4620 | _fourk_3 = 0x1000; | |
252b5132 RH |
4621 | @end smallexample |
4622 | ||
4623 | @node Symbols | |
4624 | @subsection Symbol Names | |
4625 | @cindex symbol names | |
4626 | @cindex names | |
4627 | @cindex quoted symbol names | |
4628 | @kindex " | |
4629 | Unless quoted, symbol names start with a letter, underscore, or period | |
4630 | and may include letters, digits, underscores, periods, and hyphens. | |
4631 | Unquoted symbol names must not conflict with any keywords. You can | |
4632 | specify a symbol which contains odd characters or has the same name as a | |
4633 | keyword by surrounding the symbol name in double quotes: | |
4634 | @smallexample | |
36f63dca NC |
4635 | "SECTION" = 9; |
4636 | "with a space" = "also with a space" + 10; | |
252b5132 RH |
4637 | @end smallexample |
4638 | ||
4639 | Since symbols can contain many non-alphabetic characters, it is safest | |
4640 | to delimit symbols with spaces. For example, @samp{A-B} is one symbol, | |
4641 | whereas @samp{A - B} is an expression involving subtraction. | |
4642 | ||
ecca9871 L |
4643 | @node Orphan Sections |
4644 | @subsection Orphan Sections | |
4645 | @cindex orphan | |
4646 | Orphan sections are sections present in the input files which | |
4647 | are not explicitly placed into the output file by the linker | |
4648 | script. The linker will still copy these sections into the | |
4649 | output file, but it has to guess as to where they should be | |
4650 | placed. The linker uses a simple heuristic to do this. It | |
4651 | attempts to place orphan sections after non-orphan sections of the | |
4652 | same attribute, such as code vs data, loadable vs non-loadable, etc. | |
4653 | If there is not enough room to do this then it places | |
4654 | at the end of the file. | |
4655 | ||
4656 | For ELF targets, the attribute of the section includes section type as | |
4657 | well as section flag. | |
4658 | ||
252b5132 RH |
4659 | @node Location Counter |
4660 | @subsection The Location Counter | |
4661 | @kindex . | |
4662 | @cindex dot | |
4663 | @cindex location counter | |
4664 | @cindex current output location | |
4665 | The special linker variable @dfn{dot} @samp{.} always contains the | |
4666 | current output location counter. Since the @code{.} always refers to a | |
4667 | location in an output section, it may only appear in an expression | |
4668 | within a @code{SECTIONS} command. The @code{.} symbol may appear | |
4669 | anywhere that an ordinary symbol is allowed in an expression. | |
4670 | ||
4671 | @cindex holes | |
4672 | Assigning a value to @code{.} will cause the location counter to be | |
4673 | moved. This may be used to create holes in the output section. The | |
dc0b6aa0 AM |
4674 | location counter may not be moved backwards inside an output section, |
4675 | and may not be moved backwards outside of an output section if so | |
4676 | doing creates areas with overlapping LMAs. | |
252b5132 RH |
4677 | |
4678 | @smallexample | |
4679 | SECTIONS | |
4680 | @{ | |
4681 | output : | |
4682 | @{ | |
4683 | file1(.text) | |
4684 | . = . + 1000; | |
4685 | file2(.text) | |
4686 | . += 1000; | |
4687 | file3(.text) | |
563e308f | 4688 | @} = 0x12345678; |
252b5132 RH |
4689 | @} |
4690 | @end smallexample | |
4691 | @noindent | |
4692 | In the previous example, the @samp{.text} section from @file{file1} is | |
4693 | located at the beginning of the output section @samp{output}. It is | |
4694 | followed by a 1000 byte gap. Then the @samp{.text} section from | |
4695 | @file{file2} appears, also with a 1000 byte gap following before the | |
563e308f | 4696 | @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678} |
252b5132 RH |
4697 | specifies what data to write in the gaps (@pxref{Output Section Fill}). |
4698 | ||
5c6bbab8 NC |
4699 | @cindex dot inside sections |
4700 | Note: @code{.} actually refers to the byte offset from the start of the | |
4701 | current containing object. Normally this is the @code{SECTIONS} | |
69da35b5 | 4702 | statement, whose start address is 0, hence @code{.} can be used as an |
5c6bbab8 NC |
4703 | absolute address. If @code{.} is used inside a section description |
4704 | however, it refers to the byte offset from the start of that section, | |
4705 | not an absolute address. Thus in a script like this: | |
4706 | ||
4707 | @smallexample | |
4708 | SECTIONS | |
4709 | @{ | |
4710 | . = 0x100 | |
4711 | .text: @{ | |
4712 | *(.text) | |
4713 | . = 0x200 | |
4714 | @} | |
4715 | . = 0x500 | |
4716 | .data: @{ | |
4717 | *(.data) | |
4718 | . += 0x600 | |
4719 | @} | |
4720 | @} | |
4721 | @end smallexample | |
4722 | ||
4723 | The @samp{.text} section will be assigned a starting address of 0x100 | |
4724 | and a size of exactly 0x200 bytes, even if there is not enough data in | |
4725 | the @samp{.text} input sections to fill this area. (If there is too | |
4726 | much data, an error will be produced because this would be an attempt to | |
4727 | move @code{.} backwards). The @samp{.data} section will start at 0x500 | |
4728 | and it will have an extra 0x600 bytes worth of space after the end of | |
4729 | the values from the @samp{.data} input sections and before the end of | |
4730 | the @samp{.data} output section itself. | |
4731 | ||
b5666f2f AM |
4732 | @cindex dot outside sections |
4733 | Setting symbols to the value of the location counter outside of an | |
4734 | output section statement can result in unexpected values if the linker | |
4735 | needs to place orphan sections. For example, given the following: | |
4736 | ||
4737 | @smallexample | |
4738 | SECTIONS | |
4739 | @{ | |
4740 | start_of_text = . ; | |
4741 | .text: @{ *(.text) @} | |
4742 | end_of_text = . ; | |
4743 | ||
4744 | start_of_data = . ; | |
4745 | .data: @{ *(.data) @} | |
4746 | end_of_data = . ; | |
4747 | @} | |
4748 | @end smallexample | |
4749 | ||
4750 | If the linker needs to place some input section, e.g. @code{.rodata}, | |
4751 | not mentioned in the script, it might choose to place that section | |
4752 | between @code{.text} and @code{.data}. You might think the linker | |
4753 | should place @code{.rodata} on the blank line in the above script, but | |
4754 | blank lines are of no particular significance to the linker. As well, | |
4755 | the linker doesn't associate the above symbol names with their | |
4756 | sections. Instead, it assumes that all assignments or other | |
4757 | statements belong to the previous output section, except for the | |
4758 | special case of an assignment to @code{.}. I.e., the linker will | |
4759 | place the orphan @code{.rodata} section as if the script was written | |
4760 | as follows: | |
4761 | ||
4762 | @smallexample | |
4763 | SECTIONS | |
4764 | @{ | |
4765 | start_of_text = . ; | |
4766 | .text: @{ *(.text) @} | |
4767 | end_of_text = . ; | |
4768 | ||
4769 | start_of_data = . ; | |
4770 | .rodata: @{ *(.rodata) @} | |
4771 | .data: @{ *(.data) @} | |
4772 | end_of_data = . ; | |
4773 | @} | |
4774 | @end smallexample | |
4775 | ||
4776 | This may or may not be the script author's intention for the value of | |
4777 | @code{start_of_data}. One way to influence the orphan section | |
4778 | placement is to assign the location counter to itself, as the linker | |
4779 | assumes that an assignment to @code{.} is setting the start address of | |
4780 | a following output section and thus should be grouped with that | |
4781 | section. So you could write: | |
4782 | ||
4783 | @smallexample | |
4784 | SECTIONS | |
4785 | @{ | |
4786 | start_of_text = . ; | |
4787 | .text: @{ *(.text) @} | |
4788 | end_of_text = . ; | |
4789 | ||
4790 | . = . ; | |
4791 | start_of_data = . ; | |
4792 | .data: @{ *(.data) @} | |
4793 | end_of_data = . ; | |
4794 | @} | |
4795 | @end smallexample | |
4796 | ||
4797 | Now, the orphan @code{.rodata} section will be placed between | |
4798 | @code{end_of_text} and @code{start_of_data}. | |
4799 | ||
252b5132 RH |
4800 | @need 2000 |
4801 | @node Operators | |
4802 | @subsection Operators | |
4803 | @cindex operators for arithmetic | |
4804 | @cindex arithmetic operators | |
4805 | @cindex precedence in expressions | |
4806 | The linker recognizes the standard C set of arithmetic operators, with | |
4807 | the standard bindings and precedence levels: | |
4808 | @c TEXI2ROFF-KILL | |
36f63dca | 4809 | @ifnottex |
252b5132 RH |
4810 | @c END TEXI2ROFF-KILL |
4811 | @smallexample | |
4812 | precedence associativity Operators Notes | |
4813 | (highest) | |
4814 | 1 left ! - ~ (1) | |
4815 | 2 left * / % | |
4816 | 3 left + - | |
4817 | 4 left >> << | |
4818 | 5 left == != > < <= >= | |
4819 | 6 left & | |
4820 | 7 left | | |
4821 | 8 left && | |
4822 | 9 left || | |
4823 | 10 right ? : | |
4824 | 11 right &= += -= *= /= (2) | |
4825 | (lowest) | |
4826 | @end smallexample | |
4827 | Notes: | |
a1ab1d2a | 4828 | (1) Prefix operators |
252b5132 RH |
4829 | (2) @xref{Assignments}. |
4830 | @c TEXI2ROFF-KILL | |
36f63dca | 4831 | @end ifnottex |
252b5132 RH |
4832 | @tex |
4833 | \vskip \baselineskip | |
4834 | %"lispnarrowing" is the extra indent used generally for smallexample | |
4835 | \hskip\lispnarrowing\vbox{\offinterlineskip | |
4836 | \hrule | |
4837 | \halign | |
4838 | {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr | |
4839 | height2pt&\omit&&\omit&&\omit&\cr | |
4840 | &Precedence&& Associativity &&{\rm Operators}&\cr | |
4841 | height2pt&\omit&&\omit&&\omit&\cr | |
4842 | \noalign{\hrule} | |
4843 | height2pt&\omit&&\omit&&\omit&\cr | |
4844 | &highest&&&&&\cr | |
4845 | % '176 is tilde, '~' in tt font | |
a1ab1d2a | 4846 | &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr |
252b5132 RH |
4847 | &2&&left&&* / \%&\cr |
4848 | &3&&left&&+ -&\cr | |
4849 | &4&&left&&>> <<&\cr | |
4850 | &5&&left&&== != > < <= >=&\cr | |
4851 | &6&&left&&\&&\cr | |
4852 | &7&&left&&|&\cr | |
4853 | &8&&left&&{\&\&}&\cr | |
4854 | &9&&left&&||&\cr | |
4855 | &10&&right&&? :&\cr | |
4856 | &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr | |
4857 | &lowest&&&&&\cr | |
4858 | height2pt&\omit&&\omit&&\omit&\cr} | |
4859 | \hrule} | |
4860 | @end tex | |
4861 | @iftex | |
4862 | { | |
4863 | @obeylines@parskip=0pt@parindent=0pt | |
4864 | @dag@quad Prefix operators. | |
4865 | @ddag@quad @xref{Assignments}. | |
4866 | } | |
4867 | @end iftex | |
4868 | @c END TEXI2ROFF-KILL | |
4869 | ||
4870 | @node Evaluation | |
4871 | @subsection Evaluation | |
4872 | @cindex lazy evaluation | |
4873 | @cindex expression evaluation order | |
4874 | The linker evaluates expressions lazily. It only computes the value of | |
4875 | an expression when absolutely necessary. | |
4876 | ||
4877 | The linker needs some information, such as the value of the start | |
4878 | address of the first section, and the origins and lengths of memory | |
4879 | regions, in order to do any linking at all. These values are computed | |
4880 | as soon as possible when the linker reads in the linker script. | |
4881 | ||
4882 | However, other values (such as symbol values) are not known or needed | |
4883 | until after storage allocation. Such values are evaluated later, when | |
4884 | other information (such as the sizes of output sections) is available | |
4885 | for use in the symbol assignment expression. | |
4886 | ||
4887 | The sizes of sections cannot be known until after allocation, so | |
4888 | assignments dependent upon these are not performed until after | |
4889 | allocation. | |
4890 | ||
4891 | Some expressions, such as those depending upon the location counter | |
4892 | @samp{.}, must be evaluated during section allocation. | |
4893 | ||
4894 | If the result of an expression is required, but the value is not | |
4895 | available, then an error results. For example, a script like the | |
4896 | following | |
4897 | @smallexample | |
4898 | @group | |
4899 | SECTIONS | |
4900 | @{ | |
a1ab1d2a | 4901 | .text 9+this_isnt_constant : |
252b5132 RH |
4902 | @{ *(.text) @} |
4903 | @} | |
4904 | @end group | |
4905 | @end smallexample | |
4906 | @noindent | |
4907 | will cause the error message @samp{non constant expression for initial | |
4908 | address}. | |
4909 | ||
4910 | @node Expression Section | |
4911 | @subsection The Section of an Expression | |
4912 | @cindex expression sections | |
4913 | @cindex absolute expressions | |
4914 | @cindex relative expressions | |
4915 | @cindex absolute and relocatable symbols | |
4916 | @cindex relocatable and absolute symbols | |
4917 | @cindex symbols, relocatable and absolute | |
4918 | When the linker evaluates an expression, the result is either absolute | |
4919 | or relative to some section. A relative expression is expressed as a | |
4920 | fixed offset from the base of a section. | |
4921 | ||
4922 | The position of the expression within the linker script determines | |
4923 | whether it is absolute or relative. An expression which appears within | |
4924 | an output section definition is relative to the base of the output | |
4925 | section. An expression which appears elsewhere will be absolute. | |
4926 | ||
4927 | A symbol set to a relative expression will be relocatable if you request | |
4928 | relocatable output using the @samp{-r} option. That means that a | |
4929 | further link operation may change the value of the symbol. The symbol's | |
4930 | section will be the section of the relative expression. | |
4931 | ||
4932 | A symbol set to an absolute expression will retain the same value | |
4933 | through any further link operation. The symbol will be absolute, and | |
4934 | will not have any particular associated section. | |
4935 | ||
4936 | You can use the builtin function @code{ABSOLUTE} to force an expression | |
4937 | to be absolute when it would otherwise be relative. For example, to | |
4938 | create an absolute symbol set to the address of the end of the output | |
4939 | section @samp{.data}: | |
4940 | @smallexample | |
4941 | SECTIONS | |
4942 | @{ | |
4943 | .data : @{ *(.data) _edata = ABSOLUTE(.); @} | |
4944 | @} | |
4945 | @end smallexample | |
4946 | @noindent | |
4947 | If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the | |
4948 | @samp{.data} section. | |
4949 | ||
4950 | @node Builtin Functions | |
4951 | @subsection Builtin Functions | |
4952 | @cindex functions in expressions | |
4953 | The linker script language includes a number of builtin functions for | |
4954 | use in linker script expressions. | |
4955 | ||
4956 | @table @code | |
4957 | @item ABSOLUTE(@var{exp}) | |
4958 | @kindex ABSOLUTE(@var{exp}) | |
4959 | @cindex expression, absolute | |
4960 | Return the absolute (non-relocatable, as opposed to non-negative) value | |
4961 | of the expression @var{exp}. Primarily useful to assign an absolute | |
4962 | value to a symbol within a section definition, where symbol values are | |
4963 | normally section relative. @xref{Expression Section}. | |
4964 | ||
4965 | @item ADDR(@var{section}) | |
4966 | @kindex ADDR(@var{section}) | |
4967 | @cindex section address in expression | |
4968 | Return the absolute address (the VMA) of the named @var{section}. Your | |
4969 | script must previously have defined the location of that section. In | |
4970 | the following example, @code{symbol_1} and @code{symbol_2} are assigned | |
4971 | identical values: | |
4972 | @smallexample | |
4973 | @group | |
4974 | SECTIONS @{ @dots{} | |
4975 | .output1 : | |
a1ab1d2a | 4976 | @{ |
252b5132 RH |
4977 | start_of_output_1 = ABSOLUTE(.); |
4978 | @dots{} | |
4979 | @} | |
4980 | .output : | |
4981 | @{ | |
4982 | symbol_1 = ADDR(.output1); | |
4983 | symbol_2 = start_of_output_1; | |
4984 | @} | |
4985 | @dots{} @} | |
4986 | @end group | |
4987 | @end smallexample | |
4988 | ||
876f4090 NS |
4989 | @item ALIGN(@var{align}) |
4990 | @itemx ALIGN(@var{exp},@var{align}) | |
4991 | @kindex ALIGN(@var{align}) | |
4992 | @kindex ALIGN(@var{exp},@var{align}) | |
252b5132 RH |
4993 | @cindex round up location counter |
4994 | @cindex align location counter | |
876f4090 NS |
4995 | @cindex round up expression |
4996 | @cindex align expression | |
4997 | Return the location counter (@code{.}) or arbitrary expression aligned | |
4998 | to the next @var{align} boundary. The single operand @code{ALIGN} | |
4999 | doesn't change the value of the location counter---it just does | |
5000 | arithmetic on it. The two operand @code{ALIGN} allows an arbitrary | |
5001 | expression to be aligned upwards (@code{ALIGN(@var{align})} is | |
5002 | equivalent to @code{ALIGN(., @var{align})}). | |
5003 | ||
5004 | Here is an example which aligns the output @code{.data} section to the | |
5005 | next @code{0x2000} byte boundary after the preceding section and sets a | |
5006 | variable within the section to the next @code{0x8000} boundary after the | |
5007 | input sections: | |
252b5132 RH |
5008 | @smallexample |
5009 | @group | |
5010 | SECTIONS @{ @dots{} | |
5011 | .data ALIGN(0x2000): @{ | |
5012 | *(.data) | |
5013 | variable = ALIGN(0x8000); | |
5014 | @} | |
5015 | @dots{} @} | |
5016 | @end group | |
5017 | @end smallexample | |
5018 | @noindent | |
5019 | The first use of @code{ALIGN} in this example specifies the location of | |
5020 | a section because it is used as the optional @var{address} attribute of | |
5021 | a section definition (@pxref{Output Section Address}). The second use | |
5022 | of @code{ALIGN} is used to defines the value of a symbol. | |
5023 | ||
5024 | The builtin function @code{NEXT} is closely related to @code{ALIGN}. | |
5025 | ||
362c1d1a NS |
5026 | @item ALIGNOF(@var{section}) |
5027 | @kindex ALIGNOF(@var{section}) | |
5028 | @cindex section alignment | |
5029 | Return the alignment in bytes of the named @var{section}, if that section has | |
5030 | been allocated. If the section has not been allocated when this is | |
5031 | evaluated, the linker will report an error. In the following example, | |
5032 | the alignment of the @code{.output} section is stored as the first | |
5033 | value in that section. | |
5034 | @smallexample | |
5035 | @group | |
5036 | SECTIONS@{ @dots{} | |
5037 | .output @{ | |
5038 | LONG (ALIGNOF (.output)) | |
5039 | @dots{} | |
5040 | @} | |
5041 | @dots{} @} | |
5042 | @end group | |
5043 | @end smallexample | |
5044 | ||
252b5132 RH |
5045 | @item BLOCK(@var{exp}) |
5046 | @kindex BLOCK(@var{exp}) | |
5047 | This is a synonym for @code{ALIGN}, for compatibility with older linker | |
5048 | scripts. It is most often seen when setting the address of an output | |
5049 | section. | |
5050 | ||
2d20f7bf JJ |
5051 | @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) |
5052 | @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) | |
5053 | This is equivalent to either | |
5054 | @smallexample | |
5055 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1))) | |
5056 | @end smallexample | |
5057 | or | |
5058 | @smallexample | |
5059 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - @var{commonpagesize}))) | |
5060 | @end smallexample | |
5061 | @noindent | |
5062 | depending on whether the latter uses fewer @var{commonpagesize} sized pages | |
5063 | for the data segment (area between the result of this expression and | |
5064 | @code{DATA_SEGMENT_END}) than the former or not. | |
5065 | If the latter form is used, it means @var{commonpagesize} bytes of runtime | |
5066 | memory will be saved at the expense of up to @var{commonpagesize} wasted | |
5067 | bytes in the on-disk file. | |
5068 | ||
5069 | This expression can only be used directly in @code{SECTIONS} commands, not in | |
5070 | any output section descriptions and only once in the linker script. | |
5071 | @var{commonpagesize} should be less or equal to @var{maxpagesize} and should | |
5072 | be the system page size the object wants to be optimized for (while still | |
5073 | working on system page sizes up to @var{maxpagesize}). | |
5074 | ||
5075 | @noindent | |
5076 | Example: | |
5077 | @smallexample | |
5078 | . = DATA_SEGMENT_ALIGN(0x10000, 0x2000); | |
5079 | @end smallexample | |
5080 | ||
5081 | @item DATA_SEGMENT_END(@var{exp}) | |
5082 | @kindex DATA_SEGMENT_END(@var{exp}) | |
5083 | This defines the end of data segment for @code{DATA_SEGMENT_ALIGN} | |
5084 | evaluation purposes. | |
5085 | ||
5086 | @smallexample | |
5087 | . = DATA_SEGMENT_END(.); | |
5088 | @end smallexample | |
5089 | ||
a4f5ad88 JJ |
5090 | @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) |
5091 | @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) | |
5092 | This defines the end of the @code{PT_GNU_RELRO} segment when | |
5093 | @samp{-z relro} option is used. Second argument is returned. | |
5094 | When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END} | |
5095 | does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that | |
5096 | @var{exp} + @var{offset} is aligned to the most commonly used page | |
5097 | boundary for particular target. If present in the linker script, | |
5098 | it must always come in between @code{DATA_SEGMENT_ALIGN} and | |
5099 | @code{DATA_SEGMENT_END}. | |
5100 | ||
5101 | @smallexample | |
5102 | . = DATA_SEGMENT_RELRO_END(24, .); | |
5103 | @end smallexample | |
5104 | ||
252b5132 RH |
5105 | @item DEFINED(@var{symbol}) |
5106 | @kindex DEFINED(@var{symbol}) | |
5107 | @cindex symbol defaults | |
5108 | Return 1 if @var{symbol} is in the linker global symbol table and is | |
420e579c HPN |
5109 | defined before the statement using DEFINED in the script, otherwise |
5110 | return 0. You can use this function to provide | |
252b5132 RH |
5111 | default values for symbols. For example, the following script fragment |
5112 | shows how to set a global symbol @samp{begin} to the first location in | |
5113 | the @samp{.text} section---but if a symbol called @samp{begin} already | |
5114 | existed, its value is preserved: | |
5115 | ||
5116 | @smallexample | |
5117 | @group | |
5118 | SECTIONS @{ @dots{} | |
5119 | .text : @{ | |
5120 | begin = DEFINED(begin) ? begin : . ; | |
5121 | @dots{} | |
5122 | @} | |
5123 | @dots{} | |
5124 | @} | |
5125 | @end group | |
5126 | @end smallexample | |
5127 | ||
3ec57632 NC |
5128 | @item LENGTH(@var{memory}) |
5129 | @kindex LENGTH(@var{memory}) | |
5130 | Return the length of the memory region named @var{memory}. | |
5131 | ||
252b5132 RH |
5132 | @item LOADADDR(@var{section}) |
5133 | @kindex LOADADDR(@var{section}) | |
5134 | @cindex section load address in expression | |
5135 | Return the absolute LMA of the named @var{section}. This is normally | |
5136 | the same as @code{ADDR}, but it may be different if the @code{AT} | |
5137 | attribute is used in the output section definition (@pxref{Output | |
5138 | Section LMA}). | |
5139 | ||
5140 | @kindex MAX | |
5141 | @item MAX(@var{exp1}, @var{exp2}) | |
5142 | Returns the maximum of @var{exp1} and @var{exp2}. | |
5143 | ||
5144 | @kindex MIN | |
5145 | @item MIN(@var{exp1}, @var{exp2}) | |
5146 | Returns the minimum of @var{exp1} and @var{exp2}. | |
5147 | ||
5148 | @item NEXT(@var{exp}) | |
5149 | @kindex NEXT(@var{exp}) | |
5150 | @cindex unallocated address, next | |
5151 | Return the next unallocated address that is a multiple of @var{exp}. | |
5152 | This function is closely related to @code{ALIGN(@var{exp})}; unless you | |
5153 | use the @code{MEMORY} command to define discontinuous memory for the | |
5154 | output file, the two functions are equivalent. | |
5155 | ||
3ec57632 NC |
5156 | @item ORIGIN(@var{memory}) |
5157 | @kindex ORIGIN(@var{memory}) | |
5158 | Return the origin of the memory region named @var{memory}. | |
5159 | ||
ba916c8a MM |
5160 | @item SEGMENT_START(@var{segment}, @var{default}) |
5161 | @kindex SEGMENT_START(@var{segment}, @var{default}) | |
5162 | Return the base address of the named @var{segment}. If an explicit | |
5163 | value has been given for this segment (with a command-line @samp{-T} | |
5164 | option) that value will be returned; otherwise the value will be | |
5165 | @var{default}. At present, the @samp{-T} command-line option can only | |
5166 | be used to set the base address for the ``text'', ``data'', and | |
5167 | ``bss'' sections, but you use @code{SEGMENT_START} with any segment | |
5168 | name. | |
5169 | ||
252b5132 RH |
5170 | @item SIZEOF(@var{section}) |
5171 | @kindex SIZEOF(@var{section}) | |
5172 | @cindex section size | |
5173 | Return the size in bytes of the named @var{section}, if that section has | |
5174 | been allocated. If the section has not been allocated when this is | |
5175 | evaluated, the linker will report an error. In the following example, | |
5176 | @code{symbol_1} and @code{symbol_2} are assigned identical values: | |
5177 | @smallexample | |
5178 | @group | |
5179 | SECTIONS@{ @dots{} | |
5180 | .output @{ | |
5181 | .start = . ; | |
5182 | @dots{} | |
5183 | .end = . ; | |
5184 | @} | |
5185 | symbol_1 = .end - .start ; | |
5186 | symbol_2 = SIZEOF(.output); | |
5187 | @dots{} @} | |
5188 | @end group | |
5189 | @end smallexample | |
5190 | ||
5191 | @item SIZEOF_HEADERS | |
5192 | @itemx sizeof_headers | |
5193 | @kindex SIZEOF_HEADERS | |
5194 | @cindex header size | |
5195 | Return the size in bytes of the output file's headers. This is | |
5196 | information which appears at the start of the output file. You can use | |
5197 | this number when setting the start address of the first section, if you | |
5198 | choose, to facilitate paging. | |
5199 | ||
5200 | @cindex not enough room for program headers | |
5201 | @cindex program headers, not enough room | |
5202 | When producing an ELF output file, if the linker script uses the | |
5203 | @code{SIZEOF_HEADERS} builtin function, the linker must compute the | |
5204 | number of program headers before it has determined all the section | |
5205 | addresses and sizes. If the linker later discovers that it needs | |
5206 | additional program headers, it will report an error @samp{not enough | |
5207 | room for program headers}. To avoid this error, you must avoid using | |
5208 | the @code{SIZEOF_HEADERS} function, or you must rework your linker | |
5209 | script to avoid forcing the linker to use additional program headers, or | |
5210 | you must define the program headers yourself using the @code{PHDRS} | |
5211 | command (@pxref{PHDRS}). | |
5212 | @end table | |
5213 | ||
5214 | @node Implicit Linker Scripts | |
5215 | @section Implicit Linker Scripts | |
5216 | @cindex implicit linker scripts | |
5217 | If you specify a linker input file which the linker can not recognize as | |
5218 | an object file or an archive file, it will try to read the file as a | |
5219 | linker script. If the file can not be parsed as a linker script, the | |
5220 | linker will report an error. | |
5221 | ||
5222 | An implicit linker script will not replace the default linker script. | |
5223 | ||
5224 | Typically an implicit linker script would contain only symbol | |
5225 | assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION} | |
5226 | commands. | |
5227 | ||
5228 | Any input files read because of an implicit linker script will be read | |
5229 | at the position in the command line where the implicit linker script was | |
5230 | read. This can affect archive searching. | |
5231 | ||
5232 | @ifset GENERIC | |
5233 | @node Machine Dependent | |
5234 | @chapter Machine Dependent Features | |
5235 | ||
5236 | @cindex machine dependencies | |
ff5dcc92 SC |
5237 | @command{ld} has additional features on some platforms; the following |
5238 | sections describe them. Machines where @command{ld} has no additional | |
252b5132 RH |
5239 | functionality are not listed. |
5240 | ||
5241 | @menu | |
36f63dca NC |
5242 | @ifset H8300 |
5243 | * H8/300:: @command{ld} and the H8/300 | |
5244 | @end ifset | |
5245 | @ifset I960 | |
5246 | * i960:: @command{ld} and the Intel 960 family | |
5247 | @end ifset | |
5248 | @ifset ARM | |
5249 | * ARM:: @command{ld} and the ARM family | |
5250 | @end ifset | |
5251 | @ifset HPPA | |
5252 | * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF | |
5253 | @end ifset | |
3c3bdf30 | 5254 | @ifset MMIX |
36f63dca | 5255 | * MMIX:: @command{ld} and MMIX |
3c3bdf30 | 5256 | @end ifset |
2469cfa2 | 5257 | @ifset MSP430 |
36f63dca | 5258 | * MSP430:: @command{ld} and MSP430 |
2469cfa2 | 5259 | @end ifset |
93fd0973 SC |
5260 | @ifset M68HC11 |
5261 | * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families | |
5262 | @end ifset | |
2a60a7a8 AM |
5263 | @ifset POWERPC |
5264 | * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support | |
5265 | @end ifset | |
5266 | @ifset POWERPC64 | |
5267 | * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support | |
5268 | @end ifset | |
49fa1e15 AM |
5269 | @ifset SPU |
5270 | * SPU ELF:: @command{ld} and SPU ELF Support | |
5271 | @end ifset | |
74459f0e | 5272 | @ifset TICOFF |
ff5dcc92 | 5273 | * TI COFF:: @command{ld} and TI COFF |
74459f0e | 5274 | @end ifset |
2ca22b03 NC |
5275 | @ifset WIN32 |
5276 | * WIN32:: @command{ld} and WIN32 (cygwin/mingw) | |
5277 | @end ifset | |
e0001a05 NC |
5278 | @ifset XTENSA |
5279 | * Xtensa:: @command{ld} and Xtensa Processors | |
5280 | @end ifset | |
252b5132 RH |
5281 | @end menu |
5282 | @end ifset | |
5283 | ||
252b5132 RH |
5284 | @ifset H8300 |
5285 | @ifclear GENERIC | |
5286 | @raisesections | |
5287 | @end ifclear | |
5288 | ||
5289 | @node H8/300 | |
ff5dcc92 | 5290 | @section @command{ld} and the H8/300 |
252b5132 RH |
5291 | |
5292 | @cindex H8/300 support | |
ff5dcc92 | 5293 | For the H8/300, @command{ld} can perform these global optimizations when |
252b5132 RH |
5294 | you specify the @samp{--relax} command-line option. |
5295 | ||
5296 | @table @emph | |
5297 | @cindex relaxing on H8/300 | |
5298 | @item relaxing address modes | |
ff5dcc92 | 5299 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose |
252b5132 RH |
5300 | targets are within eight bits, and turns them into eight-bit |
5301 | program-counter relative @code{bsr} and @code{bra} instructions, | |
5302 | respectively. | |
5303 | ||
5304 | @cindex synthesizing on H8/300 | |
5305 | @item synthesizing instructions | |
5306 | @c FIXME: specifically mov.b, or any mov instructions really? | |
ff5dcc92 | 5307 | @command{ld} finds all @code{mov.b} instructions which use the |
252b5132 RH |
5308 | sixteen-bit absolute address form, but refer to the top |
5309 | page of memory, and changes them to use the eight-bit address form. | |
5310 | (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into | |
5311 | @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the | |
5312 | top page of memory). | |
1502569c NC |
5313 | |
5314 | @item bit manipulation instructions | |
c0065db7 | 5315 | @command{ld} finds all bit manipulation instructions like @code{band, bclr, |
1502569c | 5316 | biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor} |
c0065db7 | 5317 | which use 32 bit and 16 bit absolute address form, but refer to the top |
1502569c NC |
5318 | page of memory, and changes them to use the 8 bit address form. |
5319 | (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into | |
c0065db7 | 5320 | @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in |
1502569c NC |
5321 | the top page of memory). |
5322 | ||
5323 | @item system control instructions | |
c0065db7 RM |
5324 | @command{ld} finds all @code{ldc.w, stc.w} instructions which use the |
5325 | 32 bit absolute address form, but refer to the top page of memory, and | |
1502569c NC |
5326 | changes them to use 16 bit address form. |
5327 | (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into | |
c0065db7 | 5328 | @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in |
1502569c | 5329 | the top page of memory). |
252b5132 RH |
5330 | @end table |
5331 | ||
5332 | @ifclear GENERIC | |
5333 | @lowersections | |
5334 | @end ifclear | |
5335 | @end ifset | |
5336 | ||
36f63dca | 5337 | @ifclear GENERIC |
c2dcd04e | 5338 | @ifset Renesas |
36f63dca | 5339 | @c This stuff is pointless to say unless you're especially concerned |
c2dcd04e NC |
5340 | @c with Renesas chips; don't enable it for generic case, please. |
5341 | @node Renesas | |
5342 | @chapter @command{ld} and Other Renesas Chips | |
36f63dca | 5343 | |
c2dcd04e NC |
5344 | @command{ld} also supports the Renesas (formerly Hitachi) H8/300H, |
5345 | H8/500, and SH chips. No special features, commands, or command-line | |
5346 | options are required for these chips. | |
36f63dca NC |
5347 | @end ifset |
5348 | @end ifclear | |
5349 | ||
5350 | @ifset I960 | |
5351 | @ifclear GENERIC | |
5352 | @raisesections | |
5353 | @end ifclear | |
5354 | ||
5355 | @node i960 | |
5356 | @section @command{ld} and the Intel 960 Family | |
5357 | ||
5358 | @cindex i960 support | |
5359 | ||
5360 | You can use the @samp{-A@var{architecture}} command line option to | |
5361 | specify one of the two-letter names identifying members of the 960 | |
5362 | family; the option specifies the desired output target, and warns of any | |
5363 | incompatible instructions in the input files. It also modifies the | |
5364 | linker's search strategy for archive libraries, to support the use of | |
5365 | libraries specific to each particular architecture, by including in the | |
5366 | search loop names suffixed with the string identifying the architecture. | |
5367 | ||
5368 | For example, if your @command{ld} command line included @w{@samp{-ACA}} as | |
5369 | well as @w{@samp{-ltry}}, the linker would look (in its built-in search | |
5370 | paths, and in any paths you specify with @samp{-L}) for a library with | |
5371 | the names | |
5372 | ||
5373 | @smallexample | |
5374 | @group | |
5375 | try | |
5376 | libtry.a | |
5377 | tryca | |
5378 | libtryca.a | |
5379 | @end group | |
5380 | @end smallexample | |
5381 | ||
5382 | @noindent | |
5383 | The first two possibilities would be considered in any event; the last | |
5384 | two are due to the use of @w{@samp{-ACA}}. | |
5385 | ||
5386 | You can meaningfully use @samp{-A} more than once on a command line, since | |
5387 | the 960 architecture family allows combination of target architectures; each | |
5388 | use will add another pair of name variants to search for when @w{@samp{-l}} | |
5389 | specifies a library. | |
5390 | ||
5391 | @cindex @option{--relax} on i960 | |
5392 | @cindex relaxing on i960 | |
5393 | @command{ld} supports the @samp{--relax} option for the i960 family. If | |
5394 | you specify @samp{--relax}, @command{ld} finds all @code{balx} and | |
5395 | @code{calx} instructions whose targets are within 24 bits, and turns | |
5396 | them into 24-bit program-counter relative @code{bal} and @code{cal} | |
5397 | instructions, respectively. @command{ld} also turns @code{cal} | |
5398 | instructions into @code{bal} instructions when it determines that the | |
5399 | target subroutine is a leaf routine (that is, the target subroutine does | |
5400 | not itself call any subroutines). | |
5401 | ||
5402 | @ifclear GENERIC | |
5403 | @lowersections | |
5404 | @end ifclear | |
5405 | @end ifset | |
5406 | ||
5407 | @ifset ARM | |
5408 | @ifclear GENERIC | |
5409 | @raisesections | |
5410 | @end ifclear | |
5411 | ||
93fd0973 SC |
5412 | @ifset M68HC11 |
5413 | @ifclear GENERIC | |
5414 | @raisesections | |
5415 | @end ifclear | |
5416 | ||
5417 | @node M68HC11/68HC12 | |
5418 | @section @command{ld} and the Motorola 68HC11 and 68HC12 families | |
5419 | ||
5420 | @cindex M68HC11 and 68HC12 support | |
5421 | ||
5422 | @subsection Linker Relaxation | |
5423 | ||
5424 | For the Motorola 68HC11, @command{ld} can perform these global | |
5425 | optimizations when you specify the @samp{--relax} command-line option. | |
5426 | ||
5427 | @table @emph | |
5428 | @cindex relaxing on M68HC11 | |
5429 | @item relaxing address modes | |
5430 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose | |
5431 | targets are within eight bits, and turns them into eight-bit | |
5432 | program-counter relative @code{bsr} and @code{bra} instructions, | |
5433 | respectively. | |
5434 | ||
5435 | @command{ld} also looks at all 16-bit extended addressing modes and | |
5436 | transforms them in a direct addressing mode when the address is in | |
5437 | page 0 (between 0 and 0x0ff). | |
5438 | ||
5439 | @item relaxing gcc instruction group | |
5440 | When @command{gcc} is called with @option{-mrelax}, it can emit group | |
5441 | of instructions that the linker can optimize to use a 68HC11 direct | |
5442 | addressing mode. These instructions consists of @code{bclr} or | |
5443 | @code{bset} instructions. | |
5444 | ||
5445 | @end table | |
5446 | ||
5447 | @subsection Trampoline Generation | |
5448 | ||
5449 | @cindex trampoline generation on M68HC11 | |
5450 | @cindex trampoline generation on M68HC12 | |
5451 | For 68HC11 and 68HC12, @command{ld} can generate trampoline code to | |
5452 | call a far function using a normal @code{jsr} instruction. The linker | |
c0065db7 | 5453 | will also change the relocation to some far function to use the |
93fd0973 SC |
5454 | trampoline address instead of the function address. This is typically the |
5455 | case when a pointer to a function is taken. The pointer will in fact | |
5456 | point to the function trampoline. | |
5457 | ||
27e55c4d PB |
5458 | @cindex PIC_VENEER |
5459 | @kindex --pic-veneer | |
5460 | The @samp{--pic-veneer} switch makes the linker use PIC sequences for | |
5461 | ARM/Thumb interworking veneers, even if the rest of the binary | |
5462 | is not PIC. This avoids problems on uClinux targets where | |
5463 | @samp{--emit-relocs} is used to generate relocatable binaries. | |
5464 | ||
93fd0973 SC |
5465 | @ifclear GENERIC |
5466 | @lowersections | |
5467 | @end ifclear | |
5468 | @end ifset | |
5469 | ||
36f63dca | 5470 | @node ARM |
3674e28a | 5471 | @section @command{ld} and the ARM family |
36f63dca NC |
5472 | |
5473 | @cindex ARM interworking support | |
5474 | @kindex --support-old-code | |
5475 | For the ARM, @command{ld} will generate code stubs to allow functions calls | |
b45619c0 | 5476 | between ARM and Thumb code. These stubs only work with code that has |
36f63dca NC |
5477 | been compiled and assembled with the @samp{-mthumb-interwork} command |
5478 | line option. If it is necessary to link with old ARM object files or | |
5479 | libraries, which have not been compiled with the -mthumb-interwork | |
5480 | option then the @samp{--support-old-code} command line switch should be | |
5481 | given to the linker. This will make it generate larger stub functions | |
5482 | which will work with non-interworking aware ARM code. Note, however, | |
5483 | the linker does not support generating stubs for function calls to | |
5484 | non-interworking aware Thumb code. | |
5485 | ||
5486 | @cindex thumb entry point | |
5487 | @cindex entry point, thumb | |
5488 | @kindex --thumb-entry=@var{entry} | |
5489 | The @samp{--thumb-entry} switch is a duplicate of the generic | |
5490 | @samp{--entry} switch, in that it sets the program's starting address. | |
5491 | But it also sets the bottom bit of the address, so that it can be | |
5492 | branched to using a BX instruction, and the program will start | |
5493 | executing in Thumb mode straight away. | |
5494 | ||
e489d0ae PB |
5495 | @cindex BE8 |
5496 | @kindex --be8 | |
5497 | The @samp{--be8} switch instructs @command{ld} to generate BE8 format | |
5498 | executables. This option is only valid when linking big-endian objects. | |
5499 | The resulting image will contain big-endian data and little-endian code. | |
5500 | ||
3674e28a PB |
5501 | @cindex TARGET1 |
5502 | @kindex --target1-rel | |
5503 | @kindex --target1-abs | |
5504 | The @samp{R_ARM_TARGET1} relocation is typically used for entries in the | |
5505 | @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32} | |
5506 | or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel} | |
5507 | and @samp{--target1-abs} switches override the default. | |
5508 | ||
5509 | @cindex TARGET2 | |
5510 | @kindex --target2=@var{type} | |
5511 | The @samp{--target2=type} switch overrides the default definition of the | |
5512 | @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their | |
5513 | meanings, and target defaults are as follows: | |
5514 | @table @samp | |
5515 | @item rel | |
eeac373a PB |
5516 | @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi) |
5517 | @item abs | |
5518 | @samp{R_ARM_ABS32} (arm*-*-symbianelf) | |
3674e28a PB |
5519 | @item got-rel |
5520 | @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd) | |
5521 | @end table | |
5522 | ||
319850b4 JB |
5523 | @cindex FIX_V4BX |
5524 | @kindex --fix-v4bx | |
5525 | The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF | |
5526 | specification) enables objects compiled for the ARMv4 architecture to be | |
5527 | interworking-safe when linked with other objects compiled for ARMv4t, but | |
5528 | also allows pure ARMv4 binaries to be built from the same ARMv4 objects. | |
5529 | ||
5530 | In the latter case, the switch @option{--fix-v4bx} must be passed to the | |
5531 | linker, which causes v4t @code{BX rM} instructions to be rewritten as | |
5532 | @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction. | |
5533 | ||
5534 | In the former case, the switch should not be used, and @samp{R_ARM_V4BX} | |
5535 | relocations are ignored. | |
5536 | ||
33bfe774 JB |
5537 | @cindex USE_BLX |
5538 | @kindex --use-blx | |
5539 | The @samp{--use-blx} switch enables the linker to use ARM/Thumb | |
5540 | BLX instructions (available on ARMv5t and above) in various | |
5541 | situations. Currently it is used to perform calls via the PLT from Thumb | |
5542 | code using BLX rather than using BX and a mode-switching stub before | |
5543 | each PLT entry. This should lead to such calls executing slightly faster. | |
5544 | ||
5545 | This option is enabled implicitly for SymbianOS, so there is no need to | |
5546 | specify it if you are using that target. | |
5547 | ||
c6dd86c6 JB |
5548 | @cindex VFP11_DENORM_FIX |
5549 | @kindex --vfp11-denorm-fix | |
5550 | The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a | |
5551 | bug in certain VFP11 coprocessor hardware, which sometimes allows | |
5552 | instructions with denorm operands (which must be handled by support code) | |
5553 | to have those operands overwritten by subsequent instructions before | |
5554 | the support code can read the intended values. | |
5555 | ||
5556 | The bug may be avoided in scalar mode if you allow at least one | |
5557 | intervening instruction between a VFP11 instruction which uses a register | |
5558 | and another instruction which writes to the same register, or at least two | |
5559 | intervening instructions if vector mode is in use. The bug only affects | |
5560 | full-compliance floating-point mode: you do not need this workaround if | |
5561 | you are using "runfast" mode. Please contact ARM for further details. | |
5562 | ||
5563 | If you know you are using buggy VFP11 hardware, you can | |
5564 | enable this workaround by specifying the linker option | |
5565 | @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar | |
5566 | mode only, or @samp{--vfp-denorm-fix=vector} if you are using | |
5567 | vector mode (the latter also works for scalar code). The default is | |
5568 | @samp{--vfp-denorm-fix=none}. | |
5569 | ||
5570 | If the workaround is enabled, instructions are scanned for | |
5571 | potentially-troublesome sequences, and a veneer is created for each | |
5572 | such sequence which may trigger the erratum. The veneer consists of the | |
5573 | first instruction of the sequence and a branch back to the subsequent | |
5574 | instruction. The original instruction is then replaced with a branch to | |
5575 | the veneer. The extra cycles required to call and return from the veneer | |
5576 | are sufficient to avoid the erratum in both the scalar and vector cases. | |
5577 | ||
bf21ed78 MS |
5578 | @cindex NO_ENUM_SIZE_WARNING |
5579 | @kindex --no-enum-size-warning | |
5580 | The @samp{--no-enum-size-warning} switch prevents the linker from | |
5581 | warning when linking object files that specify incompatible EABI | |
5582 | enumeration size attributes. For example, with this switch enabled, | |
5583 | linking of an object file using 32-bit enumeration values with another | |
5584 | using enumeration values fitted into the smallest possible space will | |
5585 | not be diagnosed. | |
5586 | ||
36f63dca NC |
5587 | @ifclear GENERIC |
5588 | @lowersections | |
5589 | @end ifclear | |
5590 | @end ifset | |
5591 | ||
5592 | @ifset HPPA | |
5593 | @ifclear GENERIC | |
5594 | @raisesections | |
5595 | @end ifclear | |
5596 | ||
5597 | @node HPPA ELF32 | |
5598 | @section @command{ld} and HPPA 32-bit ELF Support | |
5599 | @cindex HPPA multiple sub-space stubs | |
5600 | @kindex --multi-subspace | |
5601 | When generating a shared library, @command{ld} will by default generate | |
5602 | import stubs suitable for use with a single sub-space application. | |
5603 | The @samp{--multi-subspace} switch causes @command{ld} to generate export | |
5604 | stubs, and different (larger) import stubs suitable for use with | |
5605 | multiple sub-spaces. | |
5606 | ||
5607 | @cindex HPPA stub grouping | |
5608 | @kindex --stub-group-size=@var{N} | |
5609 | Long branch stubs and import/export stubs are placed by @command{ld} in | |
5610 | stub sections located between groups of input sections. | |
5611 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
5612 | sections handled by one stub section. Since branch offsets are signed, | |
5613 | a stub section may serve two groups of input sections, one group before | |
5614 | the stub section, and one group after it. However, when using | |
5615 | conditional branches that require stubs, it may be better (for branch | |
5616 | prediction) that stub sections only serve one group of input sections. | |
5617 | A negative value for @samp{N} chooses this scheme, ensuring that | |
5618 | branches to stubs always use a negative offset. Two special values of | |
5619 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
5620 | @command{ld} to automatically size input section groups for the branch types | |
5621 | detected, with the same behaviour regarding stub placement as other | |
5622 | positive or negative values of @samp{N} respectively. | |
5623 | ||
5624 | Note that @samp{--stub-group-size} does not split input sections. A | |
5625 | single input section larger than the group size specified will of course | |
5626 | create a larger group (of one section). If input sections are too | |
5627 | large, it may not be possible for a branch to reach its stub. | |
5628 | ||
5629 | @ifclear GENERIC | |
5630 | @lowersections | |
5631 | @end ifclear | |
5632 | @end ifset | |
5633 | ||
5634 | @ifset MMIX | |
5635 | @ifclear GENERIC | |
5636 | @raisesections | |
5637 | @end ifclear | |
5638 | ||
5639 | @node MMIX | |
5640 | @section @code{ld} and MMIX | |
5641 | For MMIX, there is a choice of generating @code{ELF} object files or | |
5642 | @code{mmo} object files when linking. The simulator @code{mmix} | |
5643 | understands the @code{mmo} format. The binutils @code{objcopy} utility | |
5644 | can translate between the two formats. | |
5645 | ||
5646 | There is one special section, the @samp{.MMIX.reg_contents} section. | |
5647 | Contents in this section is assumed to correspond to that of global | |
5648 | registers, and symbols referring to it are translated to special symbols, | |
5649 | equal to registers. In a final link, the start address of the | |
5650 | @samp{.MMIX.reg_contents} section corresponds to the first allocated | |
5651 | global register multiplied by 8. Register @code{$255} is not included in | |
5652 | this section; it is always set to the program entry, which is at the | |
5653 | symbol @code{Main} for @code{mmo} files. | |
5654 | ||
5655 | Symbols with the prefix @code{__.MMIX.start.}, for example | |
5656 | @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special; | |
5657 | there must be only one each, even if they are local. The default linker | |
5658 | script uses these to set the default start address of a section. | |
5659 | ||
5660 | Initial and trailing multiples of zero-valued 32-bit words in a section, | |
5661 | are left out from an mmo file. | |
5662 | ||
5663 | @ifclear GENERIC | |
5664 | @lowersections | |
5665 | @end ifclear | |
5666 | @end ifset | |
5667 | ||
5668 | @ifset MSP430 | |
5669 | @ifclear GENERIC | |
5670 | @raisesections | |
5671 | @end ifclear | |
5672 | ||
5673 | @node MSP430 | |
5674 | @section @code{ld} and MSP430 | |
5675 | For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]} | |
5676 | will select an appropriate linker script for selected MPU type. (To get a list of known MPUs | |
5677 | just pass @samp{-m help} option to the linker). | |
5678 | ||
5679 | @cindex MSP430 extra sections | |
5680 | The linker will recognize some extra sections which are MSP430 specific: | |
5681 | ||
5682 | @table @code | |
5683 | @item @samp{.vectors} | |
5684 | Defines a portion of ROM where interrupt vectors located. | |
5685 | ||
5686 | @item @samp{.bootloader} | |
5687 | Defines the bootloader portion of the ROM (if applicable). Any code | |
5688 | in this section will be uploaded to the MPU. | |
5689 | ||
5690 | @item @samp{.infomem} | |
5691 | Defines an information memory section (if applicable). Any code in | |
5692 | this section will be uploaded to the MPU. | |
5693 | ||
c0065db7 | 5694 | @item @samp{.infomemnobits} |
36f63dca NC |
5695 | This is the same as the @samp{.infomem} section except that any code |
5696 | in this section will not be uploaded to the MPU. | |
5697 | ||
5698 | @item @samp{.noinit} | |
5699 | Denotes a portion of RAM located above @samp{.bss} section. | |
5700 | ||
c0065db7 | 5701 | The last two sections are used by gcc. |
36f63dca NC |
5702 | @end table |
5703 | ||
5704 | @ifclear GENERIC | |
5705 | @lowersections | |
5706 | @end ifclear | |
5707 | @end ifset | |
5708 | ||
2a60a7a8 AM |
5709 | @ifset POWERPC |
5710 | @ifclear GENERIC | |
5711 | @raisesections | |
5712 | @end ifclear | |
5713 | ||
5714 | @node PowerPC ELF32 | |
5715 | @section @command{ld} and PowerPC 32-bit ELF Support | |
5716 | @cindex PowerPC long branches | |
5717 | @kindex --relax on PowerPC | |
5718 | Branches on PowerPC processors are limited to a signed 26-bit | |
5719 | displacement, which may result in @command{ld} giving | |
5720 | @samp{relocation truncated to fit} errors with very large programs. | |
5721 | @samp{--relax} enables the generation of trampolines that can access | |
5722 | the entire 32-bit address space. These trampolines are inserted at | |
5723 | section boundaries, so may not themselves be reachable if an input | |
5724 | section exceeds 33M in size. | |
5725 | ||
5726 | @cindex PowerPC ELF32 options | |
5727 | @table @option | |
5728 | @cindex PowerPC PLT | |
5729 | @kindex --bss-plt | |
5730 | @item --bss-plt | |
5731 | Current PowerPC GCC accepts a @samp{-msecure-plt} option that | |
5732 | generates code capable of using a newer PLT and GOT layout that has | |
5733 | the security advantage of no executable section ever needing to be | |
5734 | writable and no writable section ever being executable. PowerPC | |
5735 | @command{ld} will generate this layout, including stubs to access the | |
5736 | PLT, if all input files (including startup and static libraries) were | |
5737 | compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old | |
5738 | BSS PLT (and GOT layout) which can give slightly better performance. | |
5739 | ||
016687f8 AM |
5740 | @kindex --secure-plt |
5741 | @item --secure-plt | |
5742 | @command{ld} will use the new PLT and GOT layout if it is linking new | |
5743 | @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically | |
5744 | when linking non-PIC code. This option requests the new PLT and GOT | |
5745 | layout. A warning will be given if some object file requires the old | |
5746 | style BSS PLT. | |
5747 | ||
2a60a7a8 AM |
5748 | @cindex PowerPC GOT |
5749 | @kindex --sdata-got | |
5750 | @item --sdata-got | |
5751 | The new secure PLT and GOT are placed differently relative to other | |
5752 | sections compared to older BSS PLT and GOT placement. The location of | |
5753 | @code{.plt} must change because the new secure PLT is an initialized | |
5754 | section while the old PLT is uninitialized. The reason for the | |
5755 | @code{.got} change is more subtle: The new placement allows | |
5756 | @code{.got} to be read-only in applications linked with | |
5757 | @samp{-z relro -z now}. However, this placement means that | |
5758 | @code{.sdata} cannot always be used in shared libraries, because the | |
5759 | PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT | |
5760 | pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC | |
5761 | GCC doesn't use @code{.sdata} in shared libraries, so this option is | |
5762 | really only useful for other compilers that may do so. | |
5763 | ||
5764 | @cindex PowerPC stub symbols | |
5765 | @kindex --emit-stub-syms | |
5766 | @item --emit-stub-syms | |
5767 | This option causes @command{ld} to label linker stubs with a local | |
5768 | symbol that encodes the stub type and destination. | |
5769 | ||
5770 | @cindex PowerPC TLS optimization | |
5771 | @kindex --no-tls-optimize | |
5772 | @item --no-tls-optimize | |
5773 | PowerPC @command{ld} normally performs some optimization of code | |
5774 | sequences used to access Thread-Local Storage. Use this option to | |
5775 | disable the optimization. | |
5776 | @end table | |
5777 | ||
5778 | @ifclear GENERIC | |
5779 | @lowersections | |
5780 | @end ifclear | |
5781 | @end ifset | |
5782 | ||
5783 | @ifset POWERPC64 | |
5784 | @ifclear GENERIC | |
5785 | @raisesections | |
5786 | @end ifclear | |
5787 | ||
5788 | @node PowerPC64 ELF64 | |
5789 | @section @command{ld} and PowerPC64 64-bit ELF Support | |
5790 | ||
5791 | @cindex PowerPC64 ELF64 options | |
5792 | @table @option | |
5793 | @cindex PowerPC64 stub grouping | |
5794 | @kindex --stub-group-size | |
5795 | @item --stub-group-size | |
5796 | Long branch stubs, PLT call stubs and TOC adjusting stubs are placed | |
5797 | by @command{ld} in stub sections located between groups of input sections. | |
5798 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
5799 | sections handled by one stub section. Since branch offsets are signed, | |
5800 | a stub section may serve two groups of input sections, one group before | |
5801 | the stub section, and one group after it. However, when using | |
5802 | conditional branches that require stubs, it may be better (for branch | |
5803 | prediction) that stub sections only serve one group of input sections. | |
5804 | A negative value for @samp{N} chooses this scheme, ensuring that | |
5805 | branches to stubs always use a negative offset. Two special values of | |
5806 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
5807 | @command{ld} to automatically size input section groups for the branch types | |
5808 | detected, with the same behaviour regarding stub placement as other | |
5809 | positive or negative values of @samp{N} respectively. | |
5810 | ||
5811 | Note that @samp{--stub-group-size} does not split input sections. A | |
5812 | single input section larger than the group size specified will of course | |
5813 | create a larger group (of one section). If input sections are too | |
5814 | large, it may not be possible for a branch to reach its stub. | |
5815 | ||
5816 | @cindex PowerPC64 stub symbols | |
5817 | @kindex --emit-stub-syms | |
5818 | @item --emit-stub-syms | |
5819 | This option causes @command{ld} to label linker stubs with a local | |
5820 | symbol that encodes the stub type and destination. | |
5821 | ||
5822 | @cindex PowerPC64 dot symbols | |
5823 | @kindex --dotsyms | |
5824 | @kindex --no-dotsyms | |
5825 | @item --dotsyms, --no-dotsyms | |
5826 | These two options control how @command{ld} interprets version patterns | |
5827 | in a version script. Older PowerPC64 compilers emitted both a | |
5828 | function descriptor symbol with the same name as the function, and a | |
5829 | code entry symbol with the name prefixed by a dot (@samp{.}). To | |
5830 | properly version a function @samp{foo}, the version script thus needs | |
5831 | to control both @samp{foo} and @samp{.foo}. The option | |
5832 | @samp{--dotsyms}, on by default, automatically adds the required | |
5833 | dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this | |
5834 | feature. | |
5835 | ||
5836 | @cindex PowerPC64 TLS optimization | |
5837 | @kindex --no-tls-optimize | |
5838 | @item --no-tls-optimize | |
5839 | PowerPC64 @command{ld} normally performs some optimization of code | |
5840 | sequences used to access Thread-Local Storage. Use this option to | |
5841 | disable the optimization. | |
5842 | ||
5843 | @cindex PowerPC64 OPD optimization | |
5844 | @kindex --no-opd-optimize | |
5845 | @item --no-opd-optimize | |
5846 | PowerPC64 @command{ld} normally removes @code{.opd} section entries | |
5847 | corresponding to deleted link-once functions, or functions removed by | |
5848 | the action of @samp{--gc-sections} or linker scrip @code{/DISCARD/}. | |
5849 | Use this option to disable @code{.opd} optimization. | |
5850 | ||
5851 | @cindex PowerPC64 OPD spacing | |
5852 | @kindex --non-overlapping-opd | |
5853 | @item --non-overlapping-opd | |
5854 | Some PowerPC64 compilers have an option to generate compressed | |
5855 | @code{.opd} entries spaced 16 bytes apart, overlapping the third word, | |
5856 | the static chain pointer (unused in C) with the first word of the next | |
5857 | entry. This option expands such entries to the full 24 bytes. | |
5858 | ||
5859 | @cindex PowerPC64 TOC optimization | |
5860 | @kindex --no-toc-optimize | |
5861 | @item --no-toc-optimize | |
5862 | PowerPC64 @command{ld} normally removes unused @code{.toc} section | |
5863 | entries. Such entries are detected by examining relocations that | |
5864 | reference the TOC in code sections. A reloc in a deleted code section | |
5865 | marks a TOC word as unneeded, while a reloc in a kept code section | |
5866 | marks a TOC word as needed. Since the TOC may reference itself, TOC | |
5867 | relocs are also examined. TOC words marked as both needed and | |
5868 | unneeded will of course be kept. TOC words without any referencing | |
5869 | reloc are assumed to be part of a multi-word entry, and are kept or | |
5870 | discarded as per the nearest marked preceding word. This works | |
5871 | reliably for compiler generated code, but may be incorrect if assembly | |
5872 | code is used to insert TOC entries. Use this option to disable the | |
5873 | optimization. | |
5874 | ||
5875 | @cindex PowerPC64 multi-TOC | |
5876 | @kindex --no-multi-toc | |
5877 | @item --no-multi-toc | |
5878 | By default, PowerPC64 GCC generates code for a TOC model where TOC | |
5879 | entries are accessed with a 16-bit offset from r2. This limits the | |
5880 | total TOC size to 64K. PowerPC64 @command{ld} extends this limit by | |
5881 | grouping code sections such that each group uses less than 64K for its | |
5882 | TOC entries, then inserts r2 adjusting stubs between inter-group | |
5883 | calls. @command{ld} does not split apart input sections, so cannot | |
5884 | help if a single input file has a @code{.toc} section that exceeds | |
5885 | 64K, most likely from linking multiple files with @command{ld -r}. | |
5886 | Use this option to turn off this feature. | |
5887 | @end table | |
5888 | ||
5889 | @ifclear GENERIC | |
5890 | @lowersections | |
5891 | @end ifclear | |
5892 | @end ifset | |
5893 | ||
49fa1e15 AM |
5894 | @ifset SPU |
5895 | @ifclear GENERIC | |
5896 | @raisesections | |
5897 | @end ifclear | |
5898 | ||
5899 | @node SPU ELF | |
5900 | @section @command{ld} and SPU ELF Support | |
5901 | ||
5902 | @cindex SPU ELF options | |
5903 | @table @option | |
5904 | ||
5905 | @cindex SPU plugins | |
5906 | @kindex --plugin | |
5907 | @item --plugin | |
5908 | This option marks an executable as a PIC plugin module. | |
5909 | ||
5910 | @cindex SPU overlays | |
5911 | @kindex --no-overlays | |
5912 | @item --no-overlays | |
5913 | Normally, @command{ld} recognizes calls to functions within overlay | |
5914 | regions, and redirects such calls to an overlay manager via a stub. | |
5915 | @command{ld} also provides a built-in overlay manager. This option | |
5916 | turns off all this special overlay handling. | |
5917 | ||
5918 | @cindex SPU overlay stub symbols | |
5919 | @kindex --emit-stub-syms | |
5920 | @item --emit-stub-syms | |
5921 | This option causes @command{ld} to label overlay stubs with a local | |
5922 | symbol that encodes the stub type and destination. | |
5923 | ||
5924 | @cindex SPU extra overlay stubs | |
5925 | @kindex --extra-overlay-stubs | |
5926 | @item --extra-overlay-stubs | |
5927 | This option causes @command{ld} to add overlay call stubs on all | |
5928 | function calls out of overlay regions. Normally stubs are not added | |
5929 | on calls to non-overlay regions. | |
5930 | ||
5931 | @cindex SPU local store size | |
5932 | @kindex --local-store=lo:hi | |
5933 | @item --local-store=lo:hi | |
5934 | @command{ld} usually checks that a final executable for SPU fits in | |
5935 | the address range 0 to 256k. This option may be used to change the | |
5936 | range. Disable the check entirely with @option{--local-store=0:0}. | |
5937 | ||
c0065db7 | 5938 | @cindex SPU |
49fa1e15 AM |
5939 | @kindex --stack-analysis |
5940 | @item --stack-analysis | |
5941 | SPU local store space is limited. Over-allocation of stack space | |
5942 | unnecessarily limits space available for code and data, while | |
5943 | under-allocation results in runtime failures. If given this option, | |
5944 | @command{ld} will provide an estimate of maximum stack usage. | |
5945 | @command{ld} does this by examining symbols in code sections to | |
5946 | determine the extents of functions, and looking at function prologues | |
5947 | for stack adjusting instructions. A call-graph is created by looking | |
5948 | for relocations on branch instructions. The graph is then searched | |
5949 | for the maximum stack usage path. Note that this analysis does not | |
5950 | find calls made via function pointers, and does not handle recursion | |
5951 | and other cycles in the call graph. Stack usage may be | |
5952 | under-estimated if your code makes such calls. Also, stack usage for | |
5953 | dynamic allocation, e.g. alloca, will not be detected. If a link map | |
5954 | is requested, detailed information about each function's stack usage | |
5955 | and calls will be given. | |
5956 | ||
c0065db7 | 5957 | @cindex SPU |
49fa1e15 AM |
5958 | @kindex --emit-stack-syms |
5959 | @item --emit-stack-syms | |
5960 | This option, if given along with @option{--stack-analysis} will result | |
5961 | in @command{ld} emitting stack sizing symbols for each function. | |
5962 | These take the form @code{__stack_<function_name>} for global | |
5963 | functions, and @code{__stack_<number>_<function_name>} for static | |
5964 | functions. @code{<number>} is the section id in hex. The value of | |
5965 | such symbols is the stack requirement for the corresponding function. | |
5966 | The symbol size will be zero, type @code{STT_NOTYPE}, binding | |
c0065db7 | 5967 | @code{STB_LOCAL}, and section @code{SHN_ABS}. |
49fa1e15 AM |
5968 | @end table |
5969 | ||
5970 | @ifclear GENERIC | |
5971 | @lowersections | |
5972 | @end ifclear | |
5973 | @end ifset | |
5974 | ||
36f63dca NC |
5975 | @ifset TICOFF |
5976 | @ifclear GENERIC | |
5977 | @raisesections | |
5978 | @end ifclear | |
5979 | ||
5980 | @node TI COFF | |
5981 | @section @command{ld}'s Support for Various TI COFF Versions | |
5982 | @cindex TI COFF versions | |
5983 | @kindex --format=@var{version} | |
5984 | The @samp{--format} switch allows selection of one of the various | |
5985 | TI COFF versions. The latest of this writing is 2; versions 0 and 1 are | |
5986 | also supported. The TI COFF versions also vary in header byte-order | |
5987 | format; @command{ld} will read any version or byte order, but the output | |
5988 | header format depends on the default specified by the specific target. | |
5989 | ||
5990 | @ifclear GENERIC | |
5991 | @lowersections | |
5992 | @end ifclear | |
5993 | @end ifset | |
5994 | ||
2ca22b03 NC |
5995 | @ifset WIN32 |
5996 | @ifclear GENERIC | |
5997 | @raisesections | |
5998 | @end ifclear | |
5999 | ||
6000 | @node WIN32 | |
6001 | @section @command{ld} and WIN32 (cygwin/mingw) | |
6002 | ||
c0065db7 | 6003 | This section describes some of the win32 specific @command{ld} issues. |
b45619c0 | 6004 | See @ref{Options,,Command Line Options} for detailed description of the |
dc8465bf | 6005 | command line options mentioned here. |
2ca22b03 NC |
6006 | |
6007 | @table @emph | |
c0065db7 RM |
6008 | @cindex import libraries |
6009 | @item import libraries | |
69da35b5 | 6010 | The standard Windows linker creates and uses so-called import |
2ca22b03 | 6011 | libraries, which contains information for linking to dll's. They are |
69da35b5 NC |
6012 | regular static archives and are handled as any other static |
6013 | archive. The cygwin and mingw ports of @command{ld} have specific | |
2ca22b03 NC |
6014 | support for creating such libraries provided with the |
6015 | @samp{--out-implib} command line option. | |
6016 | ||
c0065db7 RM |
6017 | @item exporting DLL symbols |
6018 | @cindex exporting DLL symbols | |
dc8465bf NC |
6019 | The cygwin/mingw @command{ld} has several ways to export symbols for dll's. |
6020 | ||
6021 | @table @emph | |
6022 | @item using auto-export functionality | |
6023 | @cindex using auto-export functionality | |
6024 | By default @command{ld} exports symbols with the auto-export functionality, | |
6025 | which is controlled by the following command line options: | |
6026 | ||
0a5d968e NC |
6027 | @itemize |
6028 | @item --export-all-symbols [This is the default] | |
6029 | @item --exclude-symbols | |
6030 | @item --exclude-libs | |
6031 | @end itemize | |
6032 | ||
c0065db7 | 6033 | If, however, @samp{--export-all-symbols} is not given explicitly on the |
0a5d968e NC |
6034 | command line, then the default auto-export behavior will be @emph{disabled} |
6035 | if either of the following are true: | |
6036 | ||
6037 | @itemize | |
6038 | @item A DEF file is used. | |
6039 | @item Any symbol in any object file was marked with the __declspec(dllexport) attribute. | |
6040 | @end itemize | |
dc8465bf | 6041 | |
c0065db7 RM |
6042 | @item using a DEF file |
6043 | @cindex using a DEF file | |
dc8465bf NC |
6044 | Another way of exporting symbols is using a DEF file. A DEF file is |
6045 | an ASCII file containing definitions of symbols which should be | |
6046 | exported when a dll is created. Usually it is named @samp{<dll | |
6047 | name>.def} and is added as any other object file to the linker's | |
0a5d968e | 6048 | command line. The file's name must end in @samp{.def} or @samp{.DEF}. |
dc8465bf NC |
6049 | |
6050 | @example | |
6051 | gcc -o <output> <objectfiles> <dll name>.def | |
6052 | @end example | |
6053 | ||
0a5d968e NC |
6054 | Using a DEF file turns off the normal auto-export behavior, unless the |
6055 | @samp{--export-all-symbols} option is also used. | |
6056 | ||
dc8465bf NC |
6057 | Here is an example of a DEF file for a shared library called @samp{xyz.dll}: |
6058 | ||
6059 | @example | |
4b5bd4e7 | 6060 | LIBRARY "xyz.dll" BASE=0x20000000 |
dc8465bf NC |
6061 | |
6062 | EXPORTS | |
6063 | foo | |
6064 | bar | |
6065 | _bar = bar | |
4b5bd4e7 DS |
6066 | another_foo = abc.dll.afoo |
6067 | var1 DATA | |
c0065db7 | 6068 | @end example |
dc8465bf | 6069 | |
4b5bd4e7 DS |
6070 | This example defines a DLL with a non-default base address and five |
6071 | symbols in the export table. The third exported symbol @code{_bar} is an | |
6072 | alias for the second. The fourth symbol, @code{another_foo} is resolved | |
6073 | by "forwarding" to another module and treating it as an alias for | |
6074 | @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol | |
6075 | @code{var1} is declared to be a data object. | |
6076 | ||
6b31ad16 DS |
6077 | The optional @code{LIBRARY <name>} command indicates the @emph{internal} |
6078 | name of the output DLL. If @samp{<name>} does not include a suffix, | |
6079 | the default library suffix, @samp{.DLL} is appended. | |
6080 | ||
b45619c0 NC |
6081 | When the .DEF file is used to build an application, rather than a |
6082 | library, the @code{NAME <name>} command should be used instead of | |
6b31ad16 | 6083 | @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default |
c0065db7 | 6084 | executable suffix, @samp{.EXE} is appended. |
6b31ad16 DS |
6085 | |
6086 | With either @code{LIBRARY <name>} or @code{NAME <name>} the optional | |
6087 | specification @code{BASE = <number>} may be used to specify a | |
c0065db7 | 6088 | non-default base address for the image. |
6b31ad16 DS |
6089 | |
6090 | If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified, | |
a2877985 DS |
6091 | or they specify an empty string, the internal name is the same as the |
6092 | filename specified on the command line. | |
6b31ad16 | 6093 | |
4b5bd4e7 DS |
6094 | The complete specification of an export symbol is: |
6095 | ||
6096 | @example | |
6097 | EXPORTS | |
6098 | ( ( ( <name1> [ = <name2> ] ) | |
6099 | | ( <name1> = <module-name> . <external-name>)) | |
6100 | [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] ) * | |
c0065db7 | 6101 | @end example |
4b5bd4e7 DS |
6102 | |
6103 | Declares @samp{<name1>} as an exported symbol from the DLL, or declares | |
6104 | @samp{<name1>} as an exported alias for @samp{<name2>}; or declares | |
6105 | @samp{<name1>} as a "forward" alias for the symbol | |
6106 | @samp{<external-name>} in the DLL @samp{<module-name>}. | |
6107 | Optionally, the symbol may be exported by the specified ordinal | |
6108 | @samp{<integer>} alias. | |
6109 | ||
6110 | The optional keywords that follow the declaration indicate: | |
6111 | ||
6112 | @code{NONAME}: Do not put the symbol name in the DLL's export table. It | |
6113 | will still be exported by its ordinal alias (either the value specified | |
6114 | by the .def specification or, otherwise, the value assigned by the | |
6115 | linker). The symbol name, however, does remain visible in the import | |
6116 | library (if any), unless @code{PRIVATE} is also specified. | |
6117 | ||
6118 | @code{DATA}: The symbol is a variable or object, rather than a function. | |
6119 | The import lib will export only an indirect reference to @code{foo} as | |
6120 | the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as | |
6121 | @code{*_imp__foo}). | |
6122 | ||
6123 | @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as | |
6124 | well as @code{_imp__foo} into the import library. Both refer to the | |
6125 | read-only import address table's pointer to the variable, not to the | |
6126 | variable itself. This can be dangerous. If the user code fails to add | |
6127 | the @code{dllimport} attribute and also fails to explicitly add the | |
6128 | extra indirection that the use of the attribute enforces, the | |
6129 | application will behave unexpectedly. | |
6130 | ||
6131 | @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put | |
6132 | it into the static import library used to resolve imports at link time. The | |
6133 | symbol can still be imported using the @code{LoadLibrary/GetProcAddress} | |
6134 | API at runtime or by by using the GNU ld extension of linking directly to | |
6135 | the DLL without an import library. | |
c0065db7 | 6136 | |
4b5bd4e7 DS |
6137 | See ld/deffilep.y in the binutils sources for the full specification of |
6138 | other DEF file statements | |
dc8465bf NC |
6139 | |
6140 | @cindex creating a DEF file | |
6141 | While linking a shared dll, @command{ld} is able to create a DEF file | |
6142 | with the @samp{--output-def <file>} command line option. | |
0a5d968e NC |
6143 | |
6144 | @item Using decorations | |
6145 | @cindex Using decorations | |
6146 | Another way of marking symbols for export is to modify the source code | |
6147 | itself, so that when building the DLL each symbol to be exported is | |
6148 | declared as: | |
6149 | ||
6150 | @example | |
6151 | __declspec(dllexport) int a_variable | |
6152 | __declspec(dllexport) void a_function(int with_args) | |
6153 | @end example | |
6154 | ||
6155 | All such symbols will be exported from the DLL. If, however, | |
6156 | any of the object files in the DLL contain symbols decorated in | |
6157 | this way, then the normal auto-export behavior is disabled, unless | |
6158 | the @samp{--export-all-symbols} option is also used. | |
6159 | ||
6160 | Note that object files that wish to access these symbols must @emph{not} | |
c0065db7 | 6161 | decorate them with dllexport. Instead, they should use dllimport, |
0a5d968e NC |
6162 | instead: |
6163 | ||
6164 | @example | |
6165 | __declspec(dllimport) int a_variable | |
6166 | __declspec(dllimport) void a_function(int with_args) | |
6167 | @end example | |
6168 | ||
c0065db7 RM |
6169 | This complicates the structure of library header files, because |
6170 | when included by the library itself the header must declare the | |
0a5d968e NC |
6171 | variables and functions as dllexport, but when included by client |
6172 | code the header must declare them as dllimport. There are a number | |
c0065db7 | 6173 | of idioms that are typically used to do this; often client code can |
0a5d968e NC |
6174 | omit the __declspec() declaration completely. See |
6175 | @samp{--enable-auto-import} and @samp{automatic data imports} for more | |
b45619c0 | 6176 | information. |
c0065db7 | 6177 | @end table |
dc8465bf | 6178 | |
2ca22b03 NC |
6179 | @cindex automatic data imports |
6180 | @item automatic data imports | |
6181 | The standard Windows dll format supports data imports from dlls only | |
69da35b5 | 6182 | by adding special decorations (dllimport/dllexport), which let the |
2ca22b03 | 6183 | compiler produce specific assembler instructions to deal with this |
c0065db7 | 6184 | issue. This increases the effort necessary to port existing Un*x |
69da35b5 | 6185 | code to these platforms, especially for large |
2ca22b03 | 6186 | c++ libraries and applications. The auto-import feature, which was |
c0065db7 | 6187 | initially provided by Paul Sokolovsky, allows one to omit the |
b45619c0 | 6188 | decorations to achieve a behavior that conforms to that on POSIX/Un*x |
c0065db7 | 6189 | platforms. This feature is enabled with the @samp{--enable-auto-import} |
69da35b5 NC |
6190 | command-line option, although it is enabled by default on cygwin/mingw. |
6191 | The @samp{--enable-auto-import} option itself now serves mainly to | |
6192 | suppress any warnings that are ordinarily emitted when linked objects | |
6193 | trigger the feature's use. | |
6194 | ||
c0065db7 | 6195 | auto-import of variables does not always work flawlessly without |
69da35b5 NC |
6196 | additional assistance. Sometimes, you will see this message |
6197 | ||
c0065db7 | 6198 | "variable '<var>' can't be auto-imported. Please read the |
69da35b5 NC |
6199 | documentation for ld's @code{--enable-auto-import} for details." |
6200 | ||
c0065db7 RM |
6201 | The @samp{--enable-auto-import} documentation explains why this error |
6202 | occurs, and several methods that can be used to overcome this difficulty. | |
6203 | One of these methods is the @emph{runtime pseudo-relocs} feature, described | |
69da35b5 NC |
6204 | below. |
6205 | ||
6206 | @cindex runtime pseudo-relocation | |
c0065db7 RM |
6207 | For complex variables imported from DLLs (such as structs or classes), |
6208 | object files typically contain a base address for the variable and an | |
6209 | offset (@emph{addend}) within the variable--to specify a particular | |
6210 | field or public member, for instance. Unfortunately, the runtime loader used | |
6211 | in win32 environments is incapable of fixing these references at runtime | |
69da35b5 | 6212 | without the additional information supplied by dllimport/dllexport decorations. |
c0065db7 | 6213 | The standard auto-import feature described above is unable to resolve these |
69da35b5 NC |
6214 | references. |
6215 | ||
c0065db7 RM |
6216 | The @samp{--enable-runtime-pseudo-relocs} switch allows these references to |
6217 | be resolved without error, while leaving the task of adjusting the references | |
6218 | themselves (with their non-zero addends) to specialized code provided by the | |
6219 | runtime environment. Recent versions of the cygwin and mingw environments and | |
6220 | compilers provide this runtime support; older versions do not. However, the | |
6221 | support is only necessary on the developer's platform; the compiled result will | |
69da35b5 NC |
6222 | run without error on an older system. |
6223 | ||
c0065db7 RM |
6224 | @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly |
6225 | enabled as needed. | |
2ca22b03 NC |
6226 | |
6227 | @cindex direct linking to a dll | |
6228 | @item direct linking to a dll | |
6229 | The cygwin/mingw ports of @command{ld} support the direct linking, | |
6230 | including data symbols, to a dll without the usage of any import | |
69da35b5 | 6231 | libraries. This is much faster and uses much less memory than does the |
b45619c0 | 6232 | traditional import library method, especially when linking large |
c0065db7 RM |
6233 | libraries or applications. When @command{ld} creates an import lib, each |
6234 | function or variable exported from the dll is stored in its own bfd, even | |
6235 | though a single bfd could contain many exports. The overhead involved in | |
69da35b5 | 6236 | storing, loading, and processing so many bfd's is quite large, and explains the |
c0065db7 | 6237 | tremendous time, memory, and storage needed to link against particularly |
69da35b5 NC |
6238 | large or complex libraries when using import libs. |
6239 | ||
c0065db7 | 6240 | Linking directly to a dll uses no extra command-line switches other than |
69da35b5 | 6241 | @samp{-L} and @samp{-l}, because @command{ld} already searches for a number |
c0065db7 | 6242 | of names to match each library. All that is needed from the developer's |
69da35b5 NC |
6243 | perspective is an understanding of this search, in order to force ld to |
6244 | select the dll instead of an import library. | |
6245 | ||
2ca22b03 | 6246 | |
69da35b5 NC |
6247 | For instance, when ld is called with the argument @samp{-lxxx} it will attempt |
6248 | to find, in the first directory of its search path, | |
2ca22b03 NC |
6249 | |
6250 | @example | |
45e948fe NC |
6251 | libxxx.dll.a |
6252 | xxx.dll.a | |
6253 | libxxx.a | |
6254 | xxx.lib | |
69da35b5 | 6255 | cygxxx.dll (*) |
45e948fe NC |
6256 | libxxx.dll |
6257 | xxx.dll | |
2ca22b03 NC |
6258 | @end example |
6259 | ||
69da35b5 NC |
6260 | before moving on to the next directory in the search path. |
6261 | ||
c0065db7 RM |
6262 | (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll}, |
6263 | where @samp{<prefix>} is set by the @command{ld} option | |
6264 | @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec | |
6265 | file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for | |
69da35b5 NC |
6266 | @samp{cygxxx.dll}. |
6267 | ||
c0065db7 RM |
6268 | Other win32-based unix environments, such as mingw or pw32, may use other |
6269 | @samp{<prefix>}es, although at present only cygwin makes use of this feature. It | |
69da35b5 NC |
6270 | was originally intended to help avoid name conflicts among dll's built for the |
6271 | various win32/un*x environments, so that (for example) two versions of a zlib dll | |
6272 | could coexist on the same machine. | |
6273 | ||
2ca22b03 NC |
6274 | The generic cygwin/mingw path layout uses a @samp{bin} directory for |
6275 | applications and dll's and a @samp{lib} directory for the import | |
69da35b5 | 6276 | libraries (using cygwin nomenclature): |
2ca22b03 NC |
6277 | |
6278 | @example | |
6279 | bin/ | |
6280 | cygxxx.dll | |
6281 | lib/ | |
6282 | libxxx.dll.a (in case of dll's) | |
c0065db7 | 6283 | libxxx.a (in case of static archive) |
2ca22b03 NC |
6284 | @end example |
6285 | ||
c0065db7 RM |
6286 | Linking directly to a dll without using the import library can be |
6287 | done two ways: | |
2ca22b03 NC |
6288 | |
6289 | 1. Use the dll directly by adding the @samp{bin} path to the link line | |
6290 | @example | |
6291 | gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx | |
c0065db7 | 6292 | @end example |
2ca22b03 | 6293 | |
69da35b5 NC |
6294 | However, as the dll's often have version numbers appended to their names |
6295 | (@samp{cygncurses-5.dll}) this will often fail, unless one specifies | |
6296 | @samp{-L../bin -lncurses-5} to include the version. Import libs are generally | |
6297 | not versioned, and do not have this difficulty. | |
6298 | ||
2ca22b03 NC |
6299 | 2. Create a symbolic link from the dll to a file in the @samp{lib} |
6300 | directory according to the above mentioned search pattern. This | |
6301 | should be used to avoid unwanted changes in the tools needed for | |
6302 | making the app/dll. | |
6303 | ||
6304 | @example | |
6305 | ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a] | |
c0065db7 | 6306 | @end example |
2ca22b03 NC |
6307 | |
6308 | Then you can link without any make environment changes. | |
6309 | ||
6310 | @example | |
6311 | gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx | |
c0065db7 | 6312 | @end example |
69da35b5 NC |
6313 | |
6314 | This technique also avoids the version number problems, because the following is | |
6315 | perfectly legal | |
6316 | ||
6317 | @example | |
6318 | bin/ | |
6319 | cygxxx-5.dll | |
6320 | lib/ | |
c0065db7 | 6321 | libxxx.dll.a -> ../bin/cygxxx-5.dll |
69da35b5 NC |
6322 | @end example |
6323 | ||
dc8465bf | 6324 | Linking directly to a dll without using an import lib will work |
69da35b5 NC |
6325 | even when auto-import features are exercised, and even when |
6326 | @samp{--enable-runtime-pseudo-relocs} is used. | |
6327 | ||
6328 | Given the improvements in speed and memory usage, one might justifiably | |
45e948fe | 6329 | wonder why import libraries are used at all. There are three reasons: |
69da35b5 NC |
6330 | |
6331 | 1. Until recently, the link-directly-to-dll functionality did @emph{not} | |
6332 | work with auto-imported data. | |
6333 | ||
dc8465bf NC |
6334 | 2. Sometimes it is necessary to include pure static objects within the |
6335 | import library (which otherwise contains only bfd's for indirection | |
6336 | symbols that point to the exports of a dll). Again, the import lib | |
6337 | for the cygwin kernel makes use of this ability, and it is not | |
6338 | possible to do this without an import lib. | |
69da35b5 | 6339 | |
45e948fe NC |
6340 | 3. Symbol aliases can only be resolved using an import lib. This is |
6341 | critical when linking against OS-supplied dll's (eg, the win32 API) | |
6342 | in which symbols are usually exported as undecorated aliases of their | |
6343 | stdcall-decorated assembly names. | |
6344 | ||
69da35b5 | 6345 | So, import libs are not going away. But the ability to replace |
c0065db7 RM |
6346 | true import libs with a simple symbolic link to (or a copy of) |
6347 | a dll, in many cases, is a useful addition to the suite of tools | |
6348 | binutils makes available to the win32 developer. Given the | |
69da35b5 NC |
6349 | massive improvements in memory requirements during linking, storage |
6350 | requirements, and linking speed, we expect that many developers | |
6351 | will soon begin to use this feature whenever possible. | |
dc8465bf | 6352 | |
c0065db7 | 6353 | @item symbol aliasing |
dc8465bf | 6354 | @table @emph |
c0065db7 RM |
6355 | @item adding additional names |
6356 | Sometimes, it is useful to export symbols with additional names. | |
dc8465bf NC |
6357 | A symbol @samp{foo} will be exported as @samp{foo}, but it can also be |
6358 | exported as @samp{_foo} by using special directives in the DEF file | |
6359 | when creating the dll. This will affect also the optional created | |
c0065db7 | 6360 | import library. Consider the following DEF file: |
dc8465bf | 6361 | |
c0065db7 | 6362 | @example |
dc8465bf NC |
6363 | LIBRARY "xyz.dll" BASE=0x61000000 |
6364 | ||
6365 | EXPORTS | |
c0065db7 | 6366 | foo |
dc8465bf | 6367 | _foo = foo |
c0065db7 | 6368 | @end example |
dc8465bf NC |
6369 | |
6370 | The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}. | |
6371 | ||
6372 | Another method for creating a symbol alias is to create it in the | |
6373 | source code using the "weak" attribute: | |
6374 | ||
c0065db7 RM |
6375 | @example |
6376 | void foo () @{ /* Do something. */; @} | |
dc8465bf | 6377 | void _foo () __attribute__ ((weak, alias ("foo"))); |
c0065db7 | 6378 | @end example |
dc8465bf NC |
6379 | |
6380 | See the gcc manual for more information about attributes and weak | |
6381 | symbols. | |
6382 | ||
6383 | @item renaming symbols | |
6384 | Sometimes it is useful to rename exports. For instance, the cygwin | |
c0065db7 | 6385 | kernel does this regularly. A symbol @samp{_foo} can be exported as |
dc8465bf NC |
6386 | @samp{foo} but not as @samp{_foo} by using special directives in the |
6387 | DEF file. (This will also affect the import library, if it is | |
c0065db7 | 6388 | created). In the following example: |
dc8465bf | 6389 | |
c0065db7 | 6390 | @example |
dc8465bf NC |
6391 | LIBRARY "xyz.dll" BASE=0x61000000 |
6392 | ||
6393 | EXPORTS | |
6394 | _foo = foo | |
c0065db7 | 6395 | @end example |
dc8465bf NC |
6396 | |
6397 | The line @samp{_foo = foo} maps the exported symbol @samp{foo} to | |
6398 | @samp{_foo}. | |
c0065db7 | 6399 | @end table |
dc8465bf | 6400 | |
0a5d968e | 6401 | Note: using a DEF file disables the default auto-export behavior, |
c0065db7 | 6402 | unless the @samp{--export-all-symbols} command line option is used. |
0a5d968e | 6403 | If, however, you are trying to rename symbols, then you should list |
c0065db7 RM |
6404 | @emph{all} desired exports in the DEF file, including the symbols |
6405 | that are not being renamed, and do @emph{not} use the | |
6406 | @samp{--export-all-symbols} option. If you list only the | |
6407 | renamed symbols in the DEF file, and use @samp{--export-all-symbols} | |
6408 | to handle the other symbols, then the both the new names @emph{and} | |
6409 | the original names for the renamed symbols will be exported. | |
6410 | In effect, you'd be aliasing those symbols, not renaming them, | |
0a5d968e | 6411 | which is probably not what you wanted. |
c87db184 CF |
6412 | |
6413 | @cindex weak externals | |
6414 | @item weak externals | |
6415 | The Windows object format, PE, specifies a form of weak symbols called | |
6416 | weak externals. When a weak symbol is linked and the symbol is not | |
6417 | defined, the weak symbol becomes an alias for some other symbol. There | |
6418 | are three variants of weak externals: | |
6419 | @itemize | |
6420 | @item Definition is searched for in objects and libraries, historically | |
6421 | called lazy externals. | |
6422 | @item Definition is searched for only in other objects, not in libraries. | |
6423 | This form is not presently implemented. | |
6424 | @item No search; the symbol is an alias. This form is not presently | |
6425 | implemented. | |
6426 | @end itemize | |
6427 | As a GNU extension, weak symbols that do not specify an alternate symbol | |
6428 | are supported. If the symbol is undefined when linking, the symbol | |
6429 | uses a default value. | |
2ca22b03 NC |
6430 | @end table |
6431 | ||
6432 | @ifclear GENERIC | |
6433 | @lowersections | |
6434 | @end ifclear | |
6435 | @end ifset | |
6436 | ||
e0001a05 NC |
6437 | @ifset XTENSA |
6438 | @ifclear GENERIC | |
6439 | @raisesections | |
6440 | @end ifclear | |
6441 | ||
6442 | @node Xtensa | |
6443 | @section @code{ld} and Xtensa Processors | |
6444 | ||
6445 | @cindex Xtensa processors | |
6446 | The default @command{ld} behavior for Xtensa processors is to interpret | |
6447 | @code{SECTIONS} commands so that lists of explicitly named sections in a | |
6448 | specification with a wildcard file will be interleaved when necessary to | |
6449 | keep literal pools within the range of PC-relative load offsets. For | |
6450 | example, with the command: | |
6451 | ||
6452 | @smallexample | |
6453 | SECTIONS | |
6454 | @{ | |
6455 | .text : @{ | |
6456 | *(.literal .text) | |
6457 | @} | |
6458 | @} | |
6459 | @end smallexample | |
6460 | ||
6461 | @noindent | |
6462 | @command{ld} may interleave some of the @code{.literal} | |
6463 | and @code{.text} sections from different object files to ensure that the | |
6464 | literal pools are within the range of PC-relative load offsets. A valid | |
6465 | interleaving might place the @code{.literal} sections from an initial | |
6466 | group of files followed by the @code{.text} sections of that group of | |
6467 | files. Then, the @code{.literal} sections from the rest of the files | |
6468 | and the @code{.text} sections from the rest of the files would follow. | |
e0001a05 | 6469 | |
43cd72b9 | 6470 | @cindex @option{--relax} on Xtensa |
e0001a05 | 6471 | @cindex relaxing on Xtensa |
43cd72b9 BW |
6472 | Relaxation is enabled by default for the Xtensa version of @command{ld} and |
6473 | provides two important link-time optimizations. The first optimization | |
6474 | is to combine identical literal values to reduce code size. A redundant | |
6475 | literal will be removed and all the @code{L32R} instructions that use it | |
6476 | will be changed to reference an identical literal, as long as the | |
6477 | location of the replacement literal is within the offset range of all | |
6478 | the @code{L32R} instructions. The second optimization is to remove | |
6479 | unnecessary overhead from assembler-generated ``longcall'' sequences of | |
6480 | @code{L32R}/@code{CALLX@var{n}} when the target functions are within | |
6481 | range of direct @code{CALL@var{n}} instructions. | |
6482 | ||
6483 | For each of these cases where an indirect call sequence can be optimized | |
6484 | to a direct call, the linker will change the @code{CALLX@var{n}} | |
6485 | instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R} | |
6486 | instruction, and remove the literal referenced by the @code{L32R} | |
6487 | instruction if it is not used for anything else. Removing the | |
6488 | @code{L32R} instruction always reduces code size but can potentially | |
6489 | hurt performance by changing the alignment of subsequent branch targets. | |
6490 | By default, the linker will always preserve alignments, either by | |
6491 | switching some instructions between 24-bit encodings and the equivalent | |
6492 | density instructions or by inserting a no-op in place of the @code{L32R} | |
6493 | instruction that was removed. If code size is more important than | |
6494 | performance, the @option{--size-opt} option can be used to prevent the | |
6495 | linker from widening density instructions or inserting no-ops, except in | |
6496 | a few cases where no-ops are required for correctness. | |
6497 | ||
6498 | The following Xtensa-specific command-line options can be used to | |
6499 | control the linker: | |
6500 | ||
6501 | @cindex Xtensa options | |
6502 | @table @option | |
e0001a05 | 6503 | @kindex --no-relax |
43cd72b9 BW |
6504 | @item --no-relax |
6505 | Since the Xtensa version of @code{ld} enables the @option{--relax} option | |
6506 | by default, the @option{--no-relax} option is provided to disable | |
6507 | relaxation. | |
6508 | ||
6509 | @item --size-opt | |
6510 | When optimizing indirect calls to direct calls, optimize for code size | |
6511 | more than performance. With this option, the linker will not insert | |
6512 | no-ops or widen density instructions to preserve branch target | |
6513 | alignment. There may still be some cases where no-ops are required to | |
6514 | preserve the correctness of the code. | |
6515 | @end table | |
e0001a05 NC |
6516 | |
6517 | @ifclear GENERIC | |
6518 | @lowersections | |
6519 | @end ifclear | |
6520 | @end ifset | |
6521 | ||
252b5132 RH |
6522 | @ifclear SingleFormat |
6523 | @node BFD | |
6524 | @chapter BFD | |
6525 | ||
6526 | @cindex back end | |
6527 | @cindex object file management | |
6528 | @cindex object formats available | |
6529 | @kindex objdump -i | |
6530 | The linker accesses object and archive files using the BFD libraries. | |
6531 | These libraries allow the linker to use the same routines to operate on | |
6532 | object files whatever the object file format. A different object file | |
6533 | format can be supported simply by creating a new BFD back end and adding | |
6534 | it to the library. To conserve runtime memory, however, the linker and | |
6535 | associated tools are usually configured to support only a subset of the | |
6536 | object file formats available. You can use @code{objdump -i} | |
6537 | (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to | |
6538 | list all the formats available for your configuration. | |
6539 | ||
6540 | @cindex BFD requirements | |
6541 | @cindex requirements for BFD | |
6542 | As with most implementations, BFD is a compromise between | |
6543 | several conflicting requirements. The major factor influencing | |
6544 | BFD design was efficiency: any time used converting between | |
6545 | formats is time which would not have been spent had BFD not | |
6546 | been involved. This is partly offset by abstraction payback; since | |
6547 | BFD simplifies applications and back ends, more time and care | |
6548 | may be spent optimizing algorithms for a greater speed. | |
6549 | ||
6550 | One minor artifact of the BFD solution which you should bear in | |
6551 | mind is the potential for information loss. There are two places where | |
6552 | useful information can be lost using the BFD mechanism: during | |
6553 | conversion and during output. @xref{BFD information loss}. | |
6554 | ||
6555 | @menu | |
6556 | * BFD outline:: How it works: an outline of BFD | |
6557 | @end menu | |
6558 | ||
6559 | @node BFD outline | |
36f63dca | 6560 | @section How It Works: An Outline of BFD |
252b5132 RH |
6561 | @cindex opening object files |
6562 | @include bfdsumm.texi | |
6563 | @end ifclear | |
6564 | ||
6565 | @node Reporting Bugs | |
6566 | @chapter Reporting Bugs | |
ff5dcc92 SC |
6567 | @cindex bugs in @command{ld} |
6568 | @cindex reporting bugs in @command{ld} | |
252b5132 | 6569 | |
ff5dcc92 | 6570 | Your bug reports play an essential role in making @command{ld} reliable. |
252b5132 RH |
6571 | |
6572 | Reporting a bug may help you by bringing a solution to your problem, or | |
6573 | it may not. But in any case the principal function of a bug report is | |
ff5dcc92 | 6574 | to help the entire community by making the next version of @command{ld} |
252b5132 | 6575 | work better. Bug reports are your contribution to the maintenance of |
ff5dcc92 | 6576 | @command{ld}. |
252b5132 RH |
6577 | |
6578 | In order for a bug report to serve its purpose, you must include the | |
6579 | information that enables us to fix the bug. | |
6580 | ||
6581 | @menu | |
6582 | * Bug Criteria:: Have you found a bug? | |
6583 | * Bug Reporting:: How to report bugs | |
6584 | @end menu | |
6585 | ||
6586 | @node Bug Criteria | |
36f63dca | 6587 | @section Have You Found a Bug? |
252b5132 RH |
6588 | @cindex bug criteria |
6589 | ||
6590 | If you are not sure whether you have found a bug, here are some guidelines: | |
6591 | ||
6592 | @itemize @bullet | |
6593 | @cindex fatal signal | |
6594 | @cindex linker crash | |
6595 | @cindex crash of linker | |
6596 | @item | |
6597 | If the linker gets a fatal signal, for any input whatever, that is a | |
ff5dcc92 | 6598 | @command{ld} bug. Reliable linkers never crash. |
252b5132 RH |
6599 | |
6600 | @cindex error on valid input | |
6601 | @item | |
ff5dcc92 | 6602 | If @command{ld} produces an error message for valid input, that is a bug. |
252b5132 RH |
6603 | |
6604 | @cindex invalid input | |
6605 | @item | |
ff5dcc92 | 6606 | If @command{ld} does not produce an error message for invalid input, that |
252b5132 RH |
6607 | may be a bug. In the general case, the linker can not verify that |
6608 | object files are correct. | |
6609 | ||
6610 | @item | |
6611 | If you are an experienced user of linkers, your suggestions for | |
ff5dcc92 | 6612 | improvement of @command{ld} are welcome in any case. |
252b5132 RH |
6613 | @end itemize |
6614 | ||
6615 | @node Bug Reporting | |
36f63dca | 6616 | @section How to Report Bugs |
252b5132 | 6617 | @cindex bug reports |
ff5dcc92 | 6618 | @cindex @command{ld} bugs, reporting |
252b5132 RH |
6619 | |
6620 | A number of companies and individuals offer support for @sc{gnu} | |
ff5dcc92 | 6621 | products. If you obtained @command{ld} from a support organization, we |
252b5132 RH |
6622 | recommend you contact that organization first. |
6623 | ||
6624 | You can find contact information for many support companies and | |
6625 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
6626 | distribution. | |
6627 | ||
ad22bfe8 | 6628 | @ifset BUGURL |
ff5dcc92 | 6629 | Otherwise, send bug reports for @command{ld} to |
ad22bfe8 JM |
6630 | @value{BUGURL}. |
6631 | @end ifset | |
252b5132 RH |
6632 | |
6633 | The fundamental principle of reporting bugs usefully is this: | |
6634 | @strong{report all the facts}. If you are not sure whether to state a | |
6635 | fact or leave it out, state it! | |
6636 | ||
6637 | Often people omit facts because they think they know what causes the | |
6638 | problem and assume that some details do not matter. Thus, you might | |
b553b183 NC |
6639 | assume that the name of a symbol you use in an example does not |
6640 | matter. Well, probably it does not, but one cannot be sure. Perhaps | |
6641 | the bug is a stray memory reference which happens to fetch from the | |
6642 | location where that name is stored in memory; perhaps, if the name | |
6643 | were different, the contents of that location would fool the linker | |
6644 | into doing the right thing despite the bug. Play it safe and give a | |
6645 | specific, complete example. That is the easiest thing for you to do, | |
c0065db7 | 6646 | and the most helpful. |
b553b183 NC |
6647 | |
6648 | Keep in mind that the purpose of a bug report is to enable us to fix | |
6649 | the bug if it is new to us. Therefore, always write your bug reports | |
6650 | on the assumption that the bug has not been reported previously. | |
252b5132 RH |
6651 | |
6652 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
36f63dca NC |
6653 | bell?'' This cannot help us fix a bug, so it is basically useless. We |
6654 | respond by asking for enough details to enable us to investigate. | |
6655 | You might as well expedite matters by sending them to begin with. | |
252b5132 RH |
6656 | |
6657 | To enable us to fix the bug, you should include all these things: | |
6658 | ||
6659 | @itemize @bullet | |
6660 | @item | |
ff5dcc92 | 6661 | The version of @command{ld}. @command{ld} announces it if you start it with |
252b5132 RH |
6662 | the @samp{--version} argument. |
6663 | ||
6664 | Without this, we will not know whether there is any point in looking for | |
ff5dcc92 | 6665 | the bug in the current version of @command{ld}. |
252b5132 RH |
6666 | |
6667 | @item | |
ff5dcc92 | 6668 | Any patches you may have applied to the @command{ld} source, including any |
252b5132 RH |
6669 | patches made to the @code{BFD} library. |
6670 | ||
6671 | @item | |
6672 | The type of machine you are using, and the operating system name and | |
6673 | version number. | |
6674 | ||
6675 | @item | |
ff5dcc92 | 6676 | What compiler (and its version) was used to compile @command{ld}---e.g. |
252b5132 RH |
6677 | ``@code{gcc-2.7}''. |
6678 | ||
6679 | @item | |
6680 | The command arguments you gave the linker to link your example and | |
6681 | observe the bug. To guarantee you will not omit something important, | |
6682 | list them all. A copy of the Makefile (or the output from make) is | |
6683 | sufficient. | |
6684 | ||
6685 | If we were to try to guess the arguments, we would probably guess wrong | |
6686 | and then we might not encounter the bug. | |
6687 | ||
6688 | @item | |
6689 | A complete input file, or set of input files, that will reproduce the | |
b553b183 NC |
6690 | bug. It is generally most helpful to send the actual object files |
6691 | provided that they are reasonably small. Say no more than 10K. For | |
6692 | bigger files you can either make them available by FTP or HTTP or else | |
6693 | state that you are willing to send the object file(s) to whomever | |
6694 | requests them. (Note - your email will be going to a mailing list, so | |
6695 | we do not want to clog it up with large attachments). But small | |
6696 | attachments are best. | |
252b5132 RH |
6697 | |
6698 | If the source files were assembled using @code{gas} or compiled using | |
6699 | @code{gcc}, then it may be OK to send the source files rather than the | |
6700 | object files. In this case, be sure to say exactly what version of | |
6701 | @code{gas} or @code{gcc} was used to produce the object files. Also say | |
6702 | how @code{gas} or @code{gcc} were configured. | |
6703 | ||
6704 | @item | |
6705 | A description of what behavior you observe that you believe is | |
6706 | incorrect. For example, ``It gets a fatal signal.'' | |
6707 | ||
ff5dcc92 | 6708 | Of course, if the bug is that @command{ld} gets a fatal signal, then we |
252b5132 RH |
6709 | will certainly notice it. But if the bug is incorrect output, we might |
6710 | not notice unless it is glaringly wrong. You might as well not give us | |
6711 | a chance to make a mistake. | |
6712 | ||
6713 | Even if the problem you experience is a fatal signal, you should still | |
6714 | say so explicitly. Suppose something strange is going on, such as, your | |
b45619c0 | 6715 | copy of @command{ld} is out of sync, or you have encountered a bug in the |
252b5132 RH |
6716 | C library on your system. (This has happened!) Your copy might crash |
6717 | and ours would not. If you told us to expect a crash, then when ours | |
6718 | fails to crash, we would know that the bug was not happening for us. If | |
6719 | you had not told us to expect a crash, then we would not be able to draw | |
6720 | any conclusion from our observations. | |
6721 | ||
6722 | @item | |
ff5dcc92 | 6723 | If you wish to suggest changes to the @command{ld} source, send us context |
252b5132 RH |
6724 | diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or |
6725 | @samp{-p} option. Always send diffs from the old file to the new file. | |
ff5dcc92 | 6726 | If you even discuss something in the @command{ld} source, refer to it by |
252b5132 RH |
6727 | context, not by line number. |
6728 | ||
6729 | The line numbers in our development sources will not match those in your | |
6730 | sources. Your line numbers would convey no useful information to us. | |
6731 | @end itemize | |
6732 | ||
6733 | Here are some things that are not necessary: | |
6734 | ||
6735 | @itemize @bullet | |
6736 | @item | |
6737 | A description of the envelope of the bug. | |
6738 | ||
6739 | Often people who encounter a bug spend a lot of time investigating | |
6740 | which changes to the input file will make the bug go away and which | |
6741 | changes will not affect it. | |
6742 | ||
6743 | This is often time consuming and not very useful, because the way we | |
6744 | will find the bug is by running a single example under the debugger | |
6745 | with breakpoints, not by pure deduction from a series of examples. | |
6746 | We recommend that you save your time for something else. | |
6747 | ||
6748 | Of course, if you can find a simpler example to report @emph{instead} | |
6749 | of the original one, that is a convenience for us. Errors in the | |
6750 | output will be easier to spot, running under the debugger will take | |
6751 | less time, and so on. | |
6752 | ||
6753 | However, simplification is not vital; if you do not want to do this, | |
6754 | report the bug anyway and send us the entire test case you used. | |
6755 | ||
6756 | @item | |
6757 | A patch for the bug. | |
6758 | ||
6759 | A patch for the bug does help us if it is a good one. But do not omit | |
6760 | the necessary information, such as the test case, on the assumption that | |
6761 | a patch is all we need. We might see problems with your patch and decide | |
6762 | to fix the problem another way, or we might not understand it at all. | |
6763 | ||
ff5dcc92 | 6764 | Sometimes with a program as complicated as @command{ld} it is very hard to |
252b5132 RH |
6765 | construct an example that will make the program follow a certain path |
6766 | through the code. If you do not send us the example, we will not be | |
6767 | able to construct one, so we will not be able to verify that the bug is | |
6768 | fixed. | |
6769 | ||
6770 | And if we cannot understand what bug you are trying to fix, or why your | |
6771 | patch should be an improvement, we will not install it. A test case will | |
6772 | help us to understand. | |
6773 | ||
6774 | @item | |
6775 | A guess about what the bug is or what it depends on. | |
6776 | ||
6777 | Such guesses are usually wrong. Even we cannot guess right about such | |
6778 | things without first using the debugger to find the facts. | |
6779 | @end itemize | |
6780 | ||
6781 | @node MRI | |
6782 | @appendix MRI Compatible Script Files | |
6783 | @cindex MRI compatibility | |
ff5dcc92 SC |
6784 | To aid users making the transition to @sc{gnu} @command{ld} from the MRI |
6785 | linker, @command{ld} can use MRI compatible linker scripts as an | |
252b5132 RH |
6786 | alternative to the more general-purpose linker scripting language |
6787 | described in @ref{Scripts}. MRI compatible linker scripts have a much | |
6788 | simpler command set than the scripting language otherwise used with | |
ff5dcc92 | 6789 | @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI |
252b5132 RH |
6790 | linker commands; these commands are described here. |
6791 | ||
6792 | In general, MRI scripts aren't of much use with the @code{a.out} object | |
6793 | file format, since it only has three sections and MRI scripts lack some | |
6794 | features to make use of them. | |
6795 | ||
6796 | You can specify a file containing an MRI-compatible script using the | |
6797 | @samp{-c} command-line option. | |
6798 | ||
6799 | Each command in an MRI-compatible script occupies its own line; each | |
6800 | command line starts with the keyword that identifies the command (though | |
6801 | blank lines are also allowed for punctuation). If a line of an | |
ff5dcc92 | 6802 | MRI-compatible script begins with an unrecognized keyword, @command{ld} |
252b5132 RH |
6803 | issues a warning message, but continues processing the script. |
6804 | ||
6805 | Lines beginning with @samp{*} are comments. | |
6806 | ||
6807 | You can write these commands using all upper-case letters, or all | |
6808 | lower case; for example, @samp{chip} is the same as @samp{CHIP}. | |
6809 | The following list shows only the upper-case form of each command. | |
6810 | ||
6811 | @table @code | |
6812 | @cindex @code{ABSOLUTE} (MRI) | |
6813 | @item ABSOLUTE @var{secname} | |
6814 | @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname} | |
ff5dcc92 | 6815 | Normally, @command{ld} includes in the output file all sections from all |
252b5132 RH |
6816 | the input files. However, in an MRI-compatible script, you can use the |
6817 | @code{ABSOLUTE} command to restrict the sections that will be present in | |
6818 | your output program. If the @code{ABSOLUTE} command is used at all in a | |
6819 | script, then only the sections named explicitly in @code{ABSOLUTE} | |
6820 | commands will appear in the linker output. You can still use other | |
6821 | input sections (whatever you select on the command line, or using | |
6822 | @code{LOAD}) to resolve addresses in the output file. | |
6823 | ||
6824 | @cindex @code{ALIAS} (MRI) | |
6825 | @item ALIAS @var{out-secname}, @var{in-secname} | |
6826 | Use this command to place the data from input section @var{in-secname} | |
6827 | in a section called @var{out-secname} in the linker output file. | |
6828 | ||
6829 | @var{in-secname} may be an integer. | |
6830 | ||
6831 | @cindex @code{ALIGN} (MRI) | |
6832 | @item ALIGN @var{secname} = @var{expression} | |
6833 | Align the section called @var{secname} to @var{expression}. The | |
6834 | @var{expression} should be a power of two. | |
6835 | ||
6836 | @cindex @code{BASE} (MRI) | |
6837 | @item BASE @var{expression} | |
6838 | Use the value of @var{expression} as the lowest address (other than | |
6839 | absolute addresses) in the output file. | |
6840 | ||
6841 | @cindex @code{CHIP} (MRI) | |
6842 | @item CHIP @var{expression} | |
6843 | @itemx CHIP @var{expression}, @var{expression} | |
6844 | This command does nothing; it is accepted only for compatibility. | |
6845 | ||
6846 | @cindex @code{END} (MRI) | |
6847 | @item END | |
6848 | This command does nothing whatever; it's only accepted for compatibility. | |
6849 | ||
6850 | @cindex @code{FORMAT} (MRI) | |
6851 | @item FORMAT @var{output-format} | |
6852 | Similar to the @code{OUTPUT_FORMAT} command in the more general linker | |
a1ab1d2a | 6853 | language, but restricted to one of these output formats: |
252b5132 RH |
6854 | |
6855 | @enumerate | |
a1ab1d2a | 6856 | @item |
252b5132 RH |
6857 | S-records, if @var{output-format} is @samp{S} |
6858 | ||
6859 | @item | |
6860 | IEEE, if @var{output-format} is @samp{IEEE} | |
6861 | ||
6862 | @item | |
6863 | COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is | |
6864 | @samp{COFF} | |
6865 | @end enumerate | |
6866 | ||
6867 | @cindex @code{LIST} (MRI) | |
6868 | @item LIST @var{anything}@dots{} | |
6869 | Print (to the standard output file) a link map, as produced by the | |
ff5dcc92 | 6870 | @command{ld} command-line option @samp{-M}. |
252b5132 RH |
6871 | |
6872 | The keyword @code{LIST} may be followed by anything on the | |
6873 | same line, with no change in its effect. | |
6874 | ||
6875 | @cindex @code{LOAD} (MRI) | |
6876 | @item LOAD @var{filename} | |
6877 | @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename} | |
6878 | Include one or more object file @var{filename} in the link; this has the | |
ff5dcc92 | 6879 | same effect as specifying @var{filename} directly on the @command{ld} |
252b5132 RH |
6880 | command line. |
6881 | ||
6882 | @cindex @code{NAME} (MRI) | |
6883 | @item NAME @var{output-name} | |
ff5dcc92 | 6884 | @var{output-name} is the name for the program produced by @command{ld}; the |
252b5132 RH |
6885 | MRI-compatible command @code{NAME} is equivalent to the command-line |
6886 | option @samp{-o} or the general script language command @code{OUTPUT}. | |
6887 | ||
6888 | @cindex @code{ORDER} (MRI) | |
6889 | @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname} | |
6890 | @itemx ORDER @var{secname} @var{secname} @var{secname} | |
ff5dcc92 | 6891 | Normally, @command{ld} orders the sections in its output file in the |
252b5132 RH |
6892 | order in which they first appear in the input files. In an MRI-compatible |
6893 | script, you can override this ordering with the @code{ORDER} command. The | |
6894 | sections you list with @code{ORDER} will appear first in your output | |
6895 | file, in the order specified. | |
6896 | ||
6897 | @cindex @code{PUBLIC} (MRI) | |
6898 | @item PUBLIC @var{name}=@var{expression} | |
6899 | @itemx PUBLIC @var{name},@var{expression} | |
6900 | @itemx PUBLIC @var{name} @var{expression} | |
6901 | Supply a value (@var{expression}) for external symbol | |
6902 | @var{name} used in the linker input files. | |
6903 | ||
6904 | @cindex @code{SECT} (MRI) | |
6905 | @item SECT @var{secname}, @var{expression} | |
6906 | @itemx SECT @var{secname}=@var{expression} | |
6907 | @itemx SECT @var{secname} @var{expression} | |
6908 | You can use any of these three forms of the @code{SECT} command to | |
6909 | specify the start address (@var{expression}) for section @var{secname}. | |
6910 | If you have more than one @code{SECT} statement for the same | |
6911 | @var{secname}, only the @emph{first} sets the start address. | |
6912 | @end table | |
6913 | ||
36f63dca | 6914 | @include fdl.texi |
704c465c | 6915 | |
370b66a1 CD |
6916 | @node LD Index |
6917 | @unnumbered LD Index | |
252b5132 RH |
6918 | |
6919 | @printindex cp | |
6920 | ||
6921 | @tex | |
6922 | % I think something like @colophon should be in texinfo. In the | |
6923 | % meantime: | |
6924 | \long\def\colophon{\hbox to0pt{}\vfill | |
6925 | \centerline{The body of this manual is set in} | |
6926 | \centerline{\fontname\tenrm,} | |
6927 | \centerline{with headings in {\bf\fontname\tenbf}} | |
6928 | \centerline{and examples in {\tt\fontname\tentt}.} | |
6929 | \centerline{{\it\fontname\tenit\/} and} | |
6930 | \centerline{{\sl\fontname\tensl\/}} | |
6931 | \centerline{are used for emphasis.}\vfill} | |
6932 | \page\colophon | |
6933 | % Blame: doc@cygnus.com, 28mar91. | |
6934 | @end tex | |
6935 | ||
252b5132 | 6936 | @bye |