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, |
8a308ae8 NC |
4 | @c 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 |
5 | @c Free Software Foundation, Inc. | |
252b5132 | 6 | @syncodeindex ky cp |
dff70155 | 7 | @c man begin INCLUDE |
252b5132 RH |
8 | @include configdoc.texi |
9 | @c (configdoc.texi is generated by the Makefile) | |
c428fa83 | 10 | @include bfdver.texi |
dff70155 | 11 | @c man end |
252b5132 RH |
12 | |
13 | @c @smallbook | |
14 | ||
ff5dcc92 SC |
15 | @macro gcctabopt{body} |
16 | @code{\body\} | |
17 | @end macro | |
18 | ||
0285c67d NC |
19 | @c man begin NAME |
20 | @ifset man | |
21 | @c Configure for the generation of man pages | |
22 | @set UsesEnvVars | |
23 | @set GENERIC | |
0285c67d | 24 | @set ARM |
49fa1e15 | 25 | @set H8300 |
0285c67d | 26 | @set HPPA |
0285c67d | 27 | @set I960 |
0285c67d | 28 | @set M68HC11 |
7fb9f789 | 29 | @set M68K |
3c3bdf30 | 30 | @set MMIX |
2469cfa2 | 31 | @set MSP430 |
2a60a7a8 AM |
32 | @set POWERPC |
33 | @set POWERPC64 | |
49fa1e15 AM |
34 | @set Renesas |
35 | @set SPU | |
36 | @set TICOFF | |
2ca22b03 | 37 | @set WIN32 |
e0001a05 | 38 | @set XTENSA |
0285c67d NC |
39 | @end ifset |
40 | @c man end | |
41 | ||
252b5132 RH |
42 | @ifinfo |
43 | @format | |
44 | START-INFO-DIR-ENTRY | |
45 | * Ld: (ld). The GNU linker. | |
46 | END-INFO-DIR-ENTRY | |
47 | @end format | |
48 | @end ifinfo | |
49 | ||
0e9517a9 | 50 | @copying |
e49e529d JM |
51 | This file documents the @sc{gnu} linker LD |
52 | @ifset VERSION_PACKAGE | |
53 | @value{VERSION_PACKAGE} | |
54 | @end ifset | |
55 | version @value{VERSION}. | |
252b5132 | 56 | |
9fbcbd81 | 57 | Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, |
8a308ae8 | 58 | 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
252b5132 | 59 | |
cf055d54 | 60 | Permission is granted to copy, distribute and/or modify this document |
793c5807 | 61 | under the terms of the GNU Free Documentation License, Version 1.3 |
cf055d54 NC |
62 | or any later version published by the Free Software Foundation; |
63 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
64 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 65 | section entitled ``GNU Free Documentation License''. |
0e9517a9 | 66 | @end copying |
252b5132 RH |
67 | @iftex |
68 | @finalout | |
69 | @setchapternewpage odd | |
71ba23f6 | 70 | @settitle The GNU linker |
252b5132 | 71 | @titlepage |
71ba23f6 | 72 | @title The GNU linker |
252b5132 | 73 | @sp 1 |
e49e529d JM |
74 | @subtitle @code{ld} |
75 | @ifset VERSION_PACKAGE | |
76 | @subtitle @value{VERSION_PACKAGE} | |
77 | @end ifset | |
252b5132 RH |
78 | @subtitle Version @value{VERSION} |
79 | @author Steve Chamberlain | |
80 | @author Ian Lance Taylor | |
252b5132 RH |
81 | @page |
82 | ||
83 | @tex | |
84 | {\parskip=0pt | |
704c465c NC |
85 | \hfill Red Hat Inc\par |
86 | \hfill nickc\@credhat.com, doc\@redhat.com\par | |
71ba23f6 | 87 | \hfill {\it The GNU linker}\par |
252b5132 RH |
88 | \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par |
89 | } | |
90 | \global\parindent=0pt % Steve likes it this way. | |
91 | @end tex | |
92 | ||
93 | @vskip 0pt plus 1filll | |
0285c67d | 94 | @c man begin COPYRIGHT |
9fbcbd81 NC |
95 | Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, |
96 | 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free | |
97 | Software Foundation, Inc. | |
252b5132 | 98 | |
0285c67d | 99 | Permission is granted to copy, distribute and/or modify this document |
793c5807 | 100 | under the terms of the GNU Free Documentation License, Version 1.3 |
0285c67d NC |
101 | or any later version published by the Free Software Foundation; |
102 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
103 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 104 | section entitled ``GNU Free Documentation License''. |
0285c67d | 105 | @c man end |
252b5132 | 106 | |
252b5132 RH |
107 | @end titlepage |
108 | @end iftex | |
4ecceb71 | 109 | @contents |
252b5132 RH |
110 | @c FIXME: Talk about importance of *order* of args, cmds to linker! |
111 | ||
84ec0e6d | 112 | @ifnottex |
252b5132 | 113 | @node Top |
71ba23f6 | 114 | @top LD |
e49e529d JM |
115 | This file documents the @sc{gnu} linker ld |
116 | @ifset VERSION_PACKAGE | |
117 | @value{VERSION_PACKAGE} | |
118 | @end ifset | |
119 | version @value{VERSION}. | |
252b5132 | 120 | |
cf055d54 | 121 | This document is distributed under the terms of the GNU Free |
793c5807 NC |
122 | Documentation License version 1.3. A copy of the license is included |
123 | in the section entitled ``GNU Free Documentation License''. | |
cf055d54 | 124 | |
252b5132 RH |
125 | @menu |
126 | * Overview:: Overview | |
127 | * Invocation:: Invocation | |
128 | * Scripts:: Linker Scripts | |
129 | @ifset GENERIC | |
130 | * Machine Dependent:: Machine Dependent Features | |
131 | @end ifset | |
132 | @ifclear GENERIC | |
133 | @ifset H8300 | |
134 | * H8/300:: ld and the H8/300 | |
135 | @end ifset | |
c2dcd04e NC |
136 | @ifset Renesas |
137 | * Renesas:: ld and other Renesas micros | |
252b5132 RH |
138 | @end ifset |
139 | @ifset I960 | |
140 | * i960:: ld and the Intel 960 family | |
141 | @end ifset | |
36f63dca NC |
142 | @ifset ARM |
143 | * ARM:: ld and the ARM family | |
144 | @end ifset | |
145 | @ifset HPPA | |
146 | * HPPA ELF32:: ld and HPPA 32-bit ELF | |
147 | @end ifset | |
93fd0973 SC |
148 | @ifset M68HC11 |
149 | * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families | |
150 | @end ifset | |
7fb9f789 NC |
151 | @ifset M68K |
152 | * M68K:: ld and Motorola 68K family | |
153 | @end ifset | |
2a60a7a8 AM |
154 | @ifset POWERPC |
155 | * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support | |
156 | @end ifset | |
157 | @ifset POWERPC64 | |
158 | * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support | |
159 | @end ifset | |
49fa1e15 AM |
160 | @ifset SPU |
161 | * SPU ELF:: ld and SPU ELF Support | |
162 | @end ifset | |
74459f0e TW |
163 | @ifset TICOFF |
164 | * TI COFF:: ld and the TI COFF | |
165 | @end ifset | |
2ca22b03 NC |
166 | @ifset WIN32 |
167 | * Win32:: ld and WIN32 (cygwin/mingw) | |
168 | @end ifset | |
e0001a05 NC |
169 | @ifset XTENSA |
170 | * Xtensa:: ld and Xtensa Processors | |
171 | @end ifset | |
252b5132 RH |
172 | @end ifclear |
173 | @ifclear SingleFormat | |
174 | * BFD:: BFD | |
175 | @end ifclear | |
176 | @c Following blank line required for remaining bug in makeinfo conds/menus | |
177 | ||
178 | * Reporting Bugs:: Reporting Bugs | |
179 | * MRI:: MRI Compatible Script Files | |
704c465c | 180 | * GNU Free Documentation License:: GNU Free Documentation License |
370b66a1 | 181 | * LD Index:: LD Index |
252b5132 | 182 | @end menu |
84ec0e6d | 183 | @end ifnottex |
252b5132 RH |
184 | |
185 | @node Overview | |
186 | @chapter Overview | |
187 | ||
188 | @cindex @sc{gnu} linker | |
189 | @cindex what is this? | |
0285c67d | 190 | |
0879a67a | 191 | @ifset man |
0285c67d | 192 | @c man begin SYNOPSIS |
ff5dcc92 | 193 | ld [@b{options}] @var{objfile} @dots{} |
0285c67d NC |
194 | @c man end |
195 | ||
196 | @c man begin SEEALSO | |
197 | ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and | |
198 | the Info entries for @file{binutils} and | |
199 | @file{ld}. | |
200 | @c man end | |
201 | @end ifset | |
202 | ||
203 | @c man begin DESCRIPTION | |
204 | ||
ff5dcc92 | 205 | @command{ld} combines a number of object and archive files, relocates |
252b5132 | 206 | their data and ties up symbol references. Usually the last step in |
ff5dcc92 | 207 | compiling a program is to run @command{ld}. |
252b5132 | 208 | |
ff5dcc92 | 209 | @command{ld} accepts Linker Command Language files written in |
252b5132 RH |
210 | a superset of AT&T's Link Editor Command Language syntax, |
211 | to provide explicit and total control over the linking process. | |
212 | ||
0285c67d NC |
213 | @ifset man |
214 | @c For the man only | |
ece2d90e | 215 | This man page does not describe the command language; see the |
71ba23f6 NC |
216 | @command{ld} entry in @code{info} for full details on the command |
217 | language and on other aspects of the GNU linker. | |
0285c67d NC |
218 | @end ifset |
219 | ||
252b5132 | 220 | @ifclear SingleFormat |
ff5dcc92 SC |
221 | This version of @command{ld} uses the general purpose BFD libraries |
222 | to operate on object files. This allows @command{ld} to read, combine, and | |
252b5132 RH |
223 | write object files in many different formats---for example, COFF or |
224 | @code{a.out}. Different formats may be linked together to produce any | |
225 | available kind of object file. @xref{BFD}, for more information. | |
226 | @end ifclear | |
227 | ||
228 | Aside from its flexibility, the @sc{gnu} linker is more helpful than other | |
229 | linkers in providing diagnostic information. Many linkers abandon | |
230 | execution immediately upon encountering an error; whenever possible, | |
ff5dcc92 | 231 | @command{ld} continues executing, allowing you to identify other errors |
252b5132 RH |
232 | (or, in some cases, to get an output file in spite of the error). |
233 | ||
0285c67d NC |
234 | @c man end |
235 | ||
252b5132 RH |
236 | @node Invocation |
237 | @chapter Invocation | |
238 | ||
0285c67d NC |
239 | @c man begin DESCRIPTION |
240 | ||
ff5dcc92 | 241 | The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations, |
252b5132 RH |
242 | and to be as compatible as possible with other linkers. As a result, |
243 | you have many choices to control its behavior. | |
244 | ||
0285c67d NC |
245 | @c man end |
246 | ||
252b5132 RH |
247 | @ifset UsesEnvVars |
248 | @menu | |
249 | * Options:: Command Line Options | |
250 | * Environment:: Environment Variables | |
251 | @end menu | |
252 | ||
253 | @node Options | |
254 | @section Command Line Options | |
255 | @end ifset | |
256 | ||
257 | @cindex command line | |
258 | @cindex options | |
0285c67d NC |
259 | |
260 | @c man begin OPTIONS | |
261 | ||
252b5132 RH |
262 | The linker supports a plethora of command-line options, but in actual |
263 | practice few of them are used in any particular context. | |
264 | @cindex standard Unix system | |
ff5dcc92 | 265 | For instance, a frequent use of @command{ld} is to link standard Unix |
252b5132 RH |
266 | object files on a standard, supported Unix system. On such a system, to |
267 | link a file @code{hello.o}: | |
268 | ||
269 | @smallexample | |
270 | ld -o @var{output} /lib/crt0.o hello.o -lc | |
271 | @end smallexample | |
272 | ||
ff5dcc92 | 273 | This tells @command{ld} to produce a file called @var{output} as the |
252b5132 RH |
274 | result of linking the file @code{/lib/crt0.o} with @code{hello.o} and |
275 | the library @code{libc.a}, which will come from the standard search | |
276 | directories. (See the discussion of the @samp{-l} option below.) | |
277 | ||
ff5dcc92 | 278 | Some of the command-line options to @command{ld} may be specified at any |
511ab9e9 ILT |
279 | point in the command line. However, options which refer to files, such |
280 | as @samp{-l} or @samp{-T}, cause the file to be read at the point at | |
281 | which the option appears in the command line, relative to the object | |
282 | files and other file options. Repeating non-file options with a | |
283 | different argument will either have no further effect, or override prior | |
252b5132 RH |
284 | occurrences (those further to the left on the command line) of that |
285 | option. Options which may be meaningfully specified more than once are | |
286 | noted in the descriptions below. | |
287 | ||
288 | @cindex object files | |
511ab9e9 ILT |
289 | Non-option arguments are object files or archives which are to be linked |
290 | together. They may follow, precede, or be mixed in with command-line | |
291 | options, except that an object file argument may not be placed between | |
292 | an option and its argument. | |
252b5132 RH |
293 | |
294 | Usually the linker is invoked with at least one object file, but you can | |
295 | specify other forms of binary input files using @samp{-l}, @samp{-R}, | |
296 | and the script command language. If @emph{no} binary input files at all | |
297 | are specified, the linker does not produce any output, and issues the | |
298 | message @samp{No input files}. | |
299 | ||
36f63dca | 300 | If the linker cannot recognize the format of an object file, it will |
252b5132 RH |
301 | assume that it is a linker script. A script specified in this way |
302 | augments the main linker script used for the link (either the default | |
303 | linker script or the one specified by using @samp{-T}). This feature | |
304 | permits the linker to link against a file which appears to be an object | |
305 | or an archive, but actually merely defines some symbol values, or uses | |
53d25da6 AM |
306 | @code{INPUT} or @code{GROUP} to load other objects. Specifying a |
307 | script in this way merely augments the main linker script, with the | |
308 | extra commands placed after the main script; use the @samp{-T} option | |
309 | to replace the default linker script entirely, but note the effect of | |
310 | the @code{INSERT} command. @xref{Scripts}. | |
252b5132 RH |
311 | |
312 | For options whose names are a single letter, | |
313 | option arguments must either follow the option letter without intervening | |
314 | whitespace, or be given as separate arguments immediately following the | |
315 | option that requires them. | |
316 | ||
317 | For options whose names are multiple letters, either one dash or two can | |
e4897a32 | 318 | precede the option name; for example, @samp{-trace-symbol} and |
36f63dca | 319 | @samp{--trace-symbol} are equivalent. Note---there is one exception to |
e4897a32 | 320 | this rule. Multiple letter options that start with a lower case 'o' can |
ba1be17e | 321 | only be preceded by two dashes. This is to reduce confusion with the |
e4897a32 NC |
322 | @samp{-o} option. So for example @samp{-omagic} sets the output file |
323 | name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the | |
324 | output. | |
325 | ||
326 | Arguments to multiple-letter options must either be separated from the | |
327 | option name by an equals sign, or be given as separate arguments | |
328 | immediately following the option that requires them. For example, | |
329 | @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent. | |
330 | Unique abbreviations of the names of multiple-letter options are | |
331 | accepted. | |
252b5132 | 332 | |
36f63dca NC |
333 | Note---if the linker is being invoked indirectly, via a compiler driver |
334 | (e.g. @samp{gcc}) then all the linker command line options should be | |
fa19fce0 NC |
335 | prefixed by @samp{-Wl,} (or whatever is appropriate for the particular |
336 | compiler driver) like this: | |
4e53152f NC |
337 | |
338 | @smallexample | |
2509a395 | 339 | gcc -Wl,--start-group foo.o bar.o -Wl,--end-group |
4e53152f NC |
340 | @end smallexample |
341 | ||
342 | This is important, because otherwise the compiler driver program may | |
2509a395 SL |
343 | silently drop the linker options, resulting in a bad link. Confusion |
344 | may also arise when passing options that require values through a | |
345 | driver, as the use of a space between option and argument acts as | |
346 | a separator, and causes the driver to pass only the option to the linker | |
347 | and the argument to the compiler. In this case, it is simplest to use | |
348 | the joined forms of both single- and multiple-letter options, such as: | |
349 | ||
350 | @smallexample | |
351 | gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map | |
352 | @end smallexample | |
4e53152f NC |
353 | |
354 | Here is a table of the generic command line switches accepted by the GNU | |
355 | linker: | |
356 | ||
ff5dcc92 | 357 | @table @gcctabopt |
38fc1cb1 | 358 | @include at-file.texi |
dff70155 | 359 | |
2509a395 SL |
360 | @kindex -a @var{keyword} |
361 | @item -a @var{keyword} | |
252b5132 RH |
362 | This option is supported for HP/UX compatibility. The @var{keyword} |
363 | argument must be one of the strings @samp{archive}, @samp{shared}, or | |
364 | @samp{default}. @samp{-aarchive} is functionally equivalent to | |
365 | @samp{-Bstatic}, and the other two keywords are functionally equivalent | |
366 | to @samp{-Bdynamic}. This option may be used any number of times. | |
367 | ||
7ee314fa AM |
368 | @kindex --audit @var{AUDITLIB} |
369 | @item --audit @var{AUDITLIB} | |
370 | Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section. | |
371 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
372 | specified in the library. If specified multiple times @code{DT_AUDIT} | |
373 | will contain a colon separated list of audit interfaces to use. If the linker | |
374 | finds an object with an audit entry while searching for shared libraries, | |
375 | it will add a corresponding @code{DT_DEPAUDIT} entry in the output file. | |
376 | This option is only meaningful on ELF platforms supporting the rtld-audit | |
377 | interface. | |
378 | ||
252b5132 RH |
379 | @ifset I960 |
380 | @cindex architectures | |
2509a395 SL |
381 | @kindex -A @var{arch} |
382 | @item -A @var{architecture} | |
252b5132 RH |
383 | @kindex --architecture=@var{arch} |
384 | @itemx --architecture=@var{architecture} | |
ff5dcc92 SC |
385 | In the current release of @command{ld}, this option is useful only for the |
386 | Intel 960 family of architectures. In that @command{ld} configuration, the | |
252b5132 RH |
387 | @var{architecture} argument identifies the particular architecture in |
388 | the 960 family, enabling some safeguards and modifying the | |
ff5dcc92 | 389 | archive-library search path. @xref{i960,,@command{ld} and the Intel 960 |
252b5132 RH |
390 | family}, for details. |
391 | ||
ff5dcc92 | 392 | Future releases of @command{ld} may support similar functionality for |
252b5132 RH |
393 | other architecture families. |
394 | @end ifset | |
395 | ||
396 | @ifclear SingleFormat | |
397 | @cindex binary input format | |
398 | @kindex -b @var{format} | |
399 | @kindex --format=@var{format} | |
400 | @cindex input format | |
401 | @cindex input format | |
402 | @item -b @var{input-format} | |
403 | @itemx --format=@var{input-format} | |
ff5dcc92 SC |
404 | @command{ld} may be configured to support more than one kind of object |
405 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 406 | @samp{-b} option to specify the binary format for input object files |
ff5dcc92 | 407 | that follow this option on the command line. Even when @command{ld} is |
252b5132 | 408 | configured to support alternative object formats, you don't usually need |
ff5dcc92 | 409 | to specify this, as @command{ld} should be configured to expect as a |
252b5132 RH |
410 | default input format the most usual format on each machine. |
411 | @var{input-format} is a text string, the name of a particular format | |
412 | supported by the BFD libraries. (You can list the available binary | |
413 | formats with @samp{objdump -i}.) | |
414 | @xref{BFD}. | |
415 | ||
416 | You may want to use this option if you are linking files with an unusual | |
417 | binary format. You can also use @samp{-b} to switch formats explicitly (when | |
418 | linking object files of different formats), by including | |
419 | @samp{-b @var{input-format}} before each group of object files in a | |
a1ab1d2a | 420 | particular format. |
252b5132 RH |
421 | |
422 | The default format is taken from the environment variable | |
423 | @code{GNUTARGET}. | |
424 | @ifset UsesEnvVars | |
425 | @xref{Environment}. | |
426 | @end ifset | |
427 | You can also define the input format from a script, using the command | |
0285c67d NC |
428 | @code{TARGET}; |
429 | @ifclear man | |
430 | see @ref{Format Commands}. | |
431 | @end ifclear | |
252b5132 RH |
432 | @end ifclear |
433 | ||
434 | @kindex -c @var{MRI-cmdfile} | |
435 | @kindex --mri-script=@var{MRI-cmdfile} | |
436 | @cindex compatibility, MRI | |
437 | @item -c @var{MRI-commandfile} | |
438 | @itemx --mri-script=@var{MRI-commandfile} | |
ff5dcc92 | 439 | For compatibility with linkers produced by MRI, @command{ld} accepts script |
252b5132 | 440 | files written in an alternate, restricted command language, described in |
0285c67d NC |
441 | @ifclear man |
442 | @ref{MRI,,MRI Compatible Script Files}. | |
443 | @end ifclear | |
444 | @ifset man | |
445 | the MRI Compatible Script Files section of GNU ld documentation. | |
446 | @end ifset | |
447 | Introduce MRI script files with | |
252b5132 | 448 | the option @samp{-c}; use the @samp{-T} option to run linker |
ff5dcc92 SC |
449 | scripts written in the general-purpose @command{ld} scripting language. |
450 | If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories | |
252b5132 RH |
451 | specified by any @samp{-L} options. |
452 | ||
453 | @cindex common allocation | |
454 | @kindex -d | |
455 | @kindex -dc | |
456 | @kindex -dp | |
a1ab1d2a | 457 | @item -d |
252b5132 RH |
458 | @itemx -dc |
459 | @itemx -dp | |
460 | These three options are equivalent; multiple forms are supported for | |
461 | compatibility with other linkers. They assign space to common symbols | |
462 | even if a relocatable output file is specified (with @samp{-r}). The | |
463 | script command @code{FORCE_COMMON_ALLOCATION} has the same effect. | |
464 | @xref{Miscellaneous Commands}. | |
465 | ||
7ee314fa AM |
466 | @kindex --depaudit @var{AUDITLIB} |
467 | @kindex -P @var{AUDITLIB} | |
468 | @item --depaudit @var{AUDITLIB} | |
469 | @itemx -P @var{AUDITLIB} | |
470 | Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section. | |
471 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
472 | specified in the library. If specified multiple times @code{DT_DEPAUDIT} | |
473 | will contain a colon separated list of audit interfaces to use. This | |
474 | option is only meaningful on ELF platforms supporting the rtld-audit interface. | |
475 | The -P option is provided for Solaris compatibility. | |
476 | ||
252b5132 RH |
477 | @cindex entry point, from command line |
478 | @kindex -e @var{entry} | |
479 | @kindex --entry=@var{entry} | |
a1ab1d2a | 480 | @item -e @var{entry} |
252b5132 RH |
481 | @itemx --entry=@var{entry} |
482 | Use @var{entry} as the explicit symbol for beginning execution of your | |
483 | program, rather than the default entry point. If there is no symbol | |
484 | named @var{entry}, the linker will try to parse @var{entry} as a number, | |
485 | and use that as the entry address (the number will be interpreted in | |
486 | base 10; you may use a leading @samp{0x} for base 16, or a leading | |
487 | @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults | |
488 | and other ways of specifying the entry point. | |
489 | ||
b58f81ae DJ |
490 | @kindex --exclude-libs |
491 | @item --exclude-libs @var{lib},@var{lib},... | |
492 | Specifies a list of archive libraries from which symbols should not be automatically | |
e1c37eb5 | 493 | exported. The library names may be delimited by commas or colons. Specifying |
b58f81ae DJ |
494 | @code{--exclude-libs ALL} excludes symbols in all archive libraries from |
495 | automatic export. This option is available only for the i386 PE targeted | |
496 | port of the linker and for ELF targeted ports. For i386 PE, symbols | |
497 | explicitly listed in a .def file are still exported, regardless of this | |
498 | option. For ELF targeted ports, symbols affected by this option will | |
499 | be treated as hidden. | |
500 | ||
e1c37eb5 DK |
501 | @kindex --exclude-modules-for-implib |
502 | @item --exclude-modules-for-implib @var{module},@var{module},... | |
503 | Specifies a list of object files or archive members, from which symbols | |
504 | should not be automatically exported, but which should be copied wholesale | |
505 | into the import library being generated during the link. The module names | |
506 | may be delimited by commas or colons, and must match exactly the filenames | |
507 | used by @command{ld} to open the files; for archive members, this is simply | |
508 | the member name, but for object files the name listed must include and | |
509 | match precisely any path used to specify the input file on the linker's | |
510 | command-line. This option is available only for the i386 PE targeted port | |
511 | of the linker. Symbols explicitly listed in a .def file are still exported, | |
512 | regardless of this option. | |
513 | ||
252b5132 RH |
514 | @cindex dynamic symbol table |
515 | @kindex -E | |
516 | @kindex --export-dynamic | |
267e2722 | 517 | @kindex --no-export-dynamic |
252b5132 RH |
518 | @item -E |
519 | @itemx --export-dynamic | |
267e2722 CD |
520 | @itemx --no-export-dynamic |
521 | When creating a dynamically linked executable, using the @option{-E} | |
522 | option or the @option{--export-dynamic} option causes the linker to add | |
523 | all symbols to the dynamic symbol table. The dynamic symbol table is the | |
524 | set of symbols which are visible from dynamic objects at run time. | |
525 | ||
526 | If you do not use either of these options (or use the | |
527 | @option{--no-export-dynamic} option to restore the default behavior), the | |
528 | dynamic symbol table will normally contain only those symbols which are | |
529 | referenced by some dynamic object mentioned in the link. | |
252b5132 RH |
530 | |
531 | If you use @code{dlopen} to load a dynamic object which needs to refer | |
532 | back to the symbols defined by the program, rather than some other | |
533 | dynamic object, then you will probably need to use this option when | |
534 | linking the program itself. | |
535 | ||
55255dae | 536 | You can also use the dynamic list to control what symbols should |
cb840a31 | 537 | be added to the dynamic symbol table if the output format supports it. |
55255dae | 538 | See the description of @samp{--dynamic-list}. |
cb840a31 | 539 | |
8b747e1a DK |
540 | Note that this option is specific to ELF targeted ports. PE targets |
541 | support a similar function to export all symbols from a DLL or EXE; see | |
542 | the description of @samp{--export-all-symbols} below. | |
543 | ||
36f63dca | 544 | @ifclear SingleFormat |
252b5132 RH |
545 | @cindex big-endian objects |
546 | @cindex endianness | |
547 | @kindex -EB | |
548 | @item -EB | |
549 | Link big-endian objects. This affects the default output format. | |
550 | ||
551 | @cindex little-endian objects | |
552 | @kindex -EL | |
553 | @item -EL | |
554 | Link little-endian objects. This affects the default output format. | |
36f63dca | 555 | @end ifclear |
252b5132 | 556 | |
2509a395 SL |
557 | @kindex -f @var{name} |
558 | @kindex --auxiliary=@var{name} | |
559 | @item -f @var{name} | |
560 | @itemx --auxiliary=@var{name} | |
252b5132 RH |
561 | When creating an ELF shared object, set the internal DT_AUXILIARY field |
562 | to the specified name. This tells the dynamic linker that the symbol | |
563 | table of the shared object should be used as an auxiliary filter on the | |
564 | symbol table of the shared object @var{name}. | |
565 | ||
566 | If you later link a program against this filter object, then, when you | |
567 | run the program, the dynamic linker will see the DT_AUXILIARY field. If | |
568 | the dynamic linker resolves any symbols from the filter object, it will | |
569 | first check whether there is a definition in the shared object | |
570 | @var{name}. If there is one, it will be used instead of the definition | |
571 | in the filter object. The shared object @var{name} need not exist. | |
572 | Thus the shared object @var{name} may be used to provide an alternative | |
573 | implementation of certain functions, perhaps for debugging or for | |
574 | machine specific performance. | |
575 | ||
576 | This option may be specified more than once. The DT_AUXILIARY entries | |
577 | will be created in the order in which they appear on the command line. | |
578 | ||
2509a395 SL |
579 | @kindex -F @var{name} |
580 | @kindex --filter=@var{name} | |
252b5132 | 581 | @item -F @var{name} |
2509a395 | 582 | @itemx --filter=@var{name} |
252b5132 RH |
583 | When creating an ELF shared object, set the internal DT_FILTER field to |
584 | the specified name. This tells the dynamic linker that the symbol table | |
585 | of the shared object which is being created should be used as a filter | |
586 | on the symbol table of the shared object @var{name}. | |
587 | ||
588 | If you later link a program against this filter object, then, when you | |
589 | run the program, the dynamic linker will see the DT_FILTER field. The | |
590 | dynamic linker will resolve symbols according to the symbol table of the | |
591 | filter object as usual, but it will actually link to the definitions | |
592 | found in the shared object @var{name}. Thus the filter object can be | |
593 | used to select a subset of the symbols provided by the object | |
594 | @var{name}. | |
595 | ||
ff5dcc92 | 596 | Some older linkers used the @option{-F} option throughout a compilation |
252b5132 | 597 | toolchain for specifying object-file format for both input and output |
36f63dca NC |
598 | object files. |
599 | @ifclear SingleFormat | |
600 | The @sc{gnu} linker uses other mechanisms for this purpose: the | |
ece2d90e | 601 | @option{-b}, @option{--format}, @option{--oformat} options, the |
252b5132 | 602 | @code{TARGET} command in linker scripts, and the @code{GNUTARGET} |
36f63dca NC |
603 | environment variable. |
604 | @end ifclear | |
605 | The @sc{gnu} linker will ignore the @option{-F} option when not | |
606 | creating an ELF shared object. | |
252b5132 | 607 | |
3dbf70a2 | 608 | @cindex finalization function |
2509a395 SL |
609 | @kindex -fini=@var{name} |
610 | @item -fini=@var{name} | |
3dbf70a2 MM |
611 | When creating an ELF executable or shared object, call NAME when the |
612 | executable or shared object is unloaded, by setting DT_FINI to the | |
613 | address of the function. By default, the linker uses @code{_fini} as | |
614 | the function to call. | |
615 | ||
252b5132 RH |
616 | @kindex -g |
617 | @item -g | |
618 | Ignored. Provided for compatibility with other tools. | |
619 | ||
2509a395 SL |
620 | @kindex -G @var{value} |
621 | @kindex --gpsize=@var{value} | |
252b5132 | 622 | @cindex object size |
2509a395 | 623 | @item -G @var{value} |
252b5132 RH |
624 | @itemx --gpsize=@var{value} |
625 | Set the maximum size of objects to be optimized using the GP register to | |
626 | @var{size}. This is only meaningful for object file formats such as | |
627 | MIPS ECOFF which supports putting large and small objects into different | |
628 | sections. This is ignored for other object file formats. | |
629 | ||
630 | @cindex runtime library name | |
2509a395 | 631 | @kindex -h @var{name} |
252b5132 | 632 | @kindex -soname=@var{name} |
2509a395 | 633 | @item -h @var{name} |
252b5132 RH |
634 | @itemx -soname=@var{name} |
635 | When creating an ELF shared object, set the internal DT_SONAME field to | |
636 | the specified name. When an executable is linked with a shared object | |
637 | which has a DT_SONAME field, then when the executable is run the dynamic | |
638 | linker will attempt to load the shared object specified by the DT_SONAME | |
639 | field rather than the using the file name given to the linker. | |
640 | ||
641 | @kindex -i | |
642 | @cindex incremental link | |
643 | @item -i | |
644 | Perform an incremental link (same as option @samp{-r}). | |
645 | ||
3dbf70a2 | 646 | @cindex initialization function |
2509a395 SL |
647 | @kindex -init=@var{name} |
648 | @item -init=@var{name} | |
3dbf70a2 MM |
649 | When creating an ELF executable or shared object, call NAME when the |
650 | executable or shared object is loaded, by setting DT_INIT to the address | |
651 | of the function. By default, the linker uses @code{_init} as the | |
652 | function to call. | |
653 | ||
252b5132 | 654 | @cindex archive files, from cmd line |
2509a395 | 655 | @kindex -l @var{namespec} |
bcb674cf | 656 | @kindex --library=@var{namespec} |
2509a395 | 657 | @item -l @var{namespec} |
bcb674cf RS |
658 | @itemx --library=@var{namespec} |
659 | Add the archive or object file specified by @var{namespec} to the | |
660 | list of files to link. This option may be used any number of times. | |
661 | If @var{namespec} is of the form @file{:@var{filename}}, @command{ld} | |
07d8eb55 | 662 | will search the library path for a file called @var{filename}, otherwise it |
bcb674cf | 663 | will search the library path for a file called @file{lib@var{namespec}.a}. |
252b5132 | 664 | |
ff5dcc92 | 665 | On systems which support shared libraries, @command{ld} may also search for |
bcb674cf RS |
666 | files other than @file{lib@var{namespec}.a}. Specifically, on ELF |
667 | and SunOS systems, @command{ld} will search a directory for a library | |
668 | called @file{lib@var{namespec}.so} before searching for one called | |
669 | @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension | |
670 | indicates a shared library.) Note that this behavior does not apply | |
671 | to @file{:@var{filename}}, which always specifies a file called | |
672 | @var{filename}. | |
252b5132 RH |
673 | |
674 | The linker will search an archive only once, at the location where it is | |
675 | specified on the command line. If the archive defines a symbol which | |
676 | was undefined in some object which appeared before the archive on the | |
677 | command line, the linker will include the appropriate file(s) from the | |
678 | archive. However, an undefined symbol in an object appearing later on | |
679 | the command line will not cause the linker to search the archive again. | |
680 | ||
ff5dcc92 | 681 | See the @option{-(} option for a way to force the linker to search |
252b5132 RH |
682 | archives multiple times. |
683 | ||
684 | You may list the same archive multiple times on the command line. | |
685 | ||
686 | @ifset GENERIC | |
687 | This type of archive searching is standard for Unix linkers. However, | |
ff5dcc92 | 688 | if you are using @command{ld} on AIX, note that it is different from the |
252b5132 RH |
689 | behaviour of the AIX linker. |
690 | @end ifset | |
691 | ||
692 | @cindex search directory, from cmd line | |
2509a395 | 693 | @kindex -L @var{dir} |
252b5132 | 694 | @kindex --library-path=@var{dir} |
2509a395 | 695 | @item -L @var{searchdir} |
252b5132 | 696 | @itemx --library-path=@var{searchdir} |
ff5dcc92 SC |
697 | Add path @var{searchdir} to the list of paths that @command{ld} will search |
698 | for archive libraries and @command{ld} control scripts. You may use this | |
252b5132 RH |
699 | option any number of times. The directories are searched in the order |
700 | in which they are specified on the command line. Directories specified | |
701 | on the command line are searched before the default directories. All | |
ff5dcc92 | 702 | @option{-L} options apply to all @option{-l} options, regardless of the |
7d24f02c KH |
703 | order in which the options appear. @option{-L} options do not affect |
704 | how @command{ld} searches for a linker script unless @option{-T} | |
705 | option is specified. | |
252b5132 | 706 | |
9c8ebd6a DJ |
707 | If @var{searchdir} begins with @code{=}, then the @code{=} will be replaced |
708 | by the @dfn{sysroot prefix}, a path specified when the linker is configured. | |
709 | ||
252b5132 RH |
710 | @ifset UsesEnvVars |
711 | The default set of paths searched (without being specified with | |
ff5dcc92 | 712 | @samp{-L}) depends on which emulation mode @command{ld} is using, and in |
252b5132 RH |
713 | some cases also on how it was configured. @xref{Environment}. |
714 | @end ifset | |
715 | ||
716 | The paths can also be specified in a link script with the | |
717 | @code{SEARCH_DIR} command. Directories specified this way are searched | |
718 | at the point in which the linker script appears in the command line. | |
719 | ||
720 | @cindex emulation | |
721 | @kindex -m @var{emulation} | |
2509a395 | 722 | @item -m @var{emulation} |
252b5132 RH |
723 | Emulate the @var{emulation} linker. You can list the available |
724 | emulations with the @samp{--verbose} or @samp{-V} options. | |
725 | ||
726 | If the @samp{-m} option is not used, the emulation is taken from the | |
727 | @code{LDEMULATION} environment variable, if that is defined. | |
728 | ||
729 | Otherwise, the default emulation depends upon how the linker was | |
730 | configured. | |
731 | ||
732 | @cindex link map | |
733 | @kindex -M | |
734 | @kindex --print-map | |
735 | @item -M | |
736 | @itemx --print-map | |
737 | Print a link map to the standard output. A link map provides | |
738 | information about the link, including the following: | |
739 | ||
740 | @itemize @bullet | |
741 | @item | |
3b83e13a | 742 | Where object files are mapped into memory. |
252b5132 RH |
743 | @item |
744 | How common symbols are allocated. | |
745 | @item | |
746 | All archive members included in the link, with a mention of the symbol | |
747 | which caused the archive member to be brought in. | |
3b83e13a NC |
748 | @item |
749 | The values assigned to symbols. | |
750 | ||
751 | Note - symbols whose values are computed by an expression which | |
752 | involves a reference to a previous value of the same symbol may not | |
753 | have correct result displayed in the link map. This is because the | |
754 | linker discards intermediate results and only retains the final value | |
755 | of an expression. Under such circumstances the linker will display | |
756 | the final value enclosed by square brackets. Thus for example a | |
757 | linker script containing: | |
758 | ||
759 | @smallexample | |
760 | foo = 1 | |
761 | foo = foo * 4 | |
762 | foo = foo + 8 | |
763 | @end smallexample | |
764 | ||
765 | will produce the following output in the link map if the @option{-M} | |
766 | option is used: | |
767 | ||
768 | @smallexample | |
769 | 0x00000001 foo = 0x1 | |
770 | [0x0000000c] foo = (foo * 0x4) | |
771 | [0x0000000c] foo = (foo + 0x8) | |
772 | @end smallexample | |
773 | ||
774 | See @ref{Expressions} for more information about expressions in linker | |
775 | scripts. | |
252b5132 RH |
776 | @end itemize |
777 | ||
778 | @kindex -n | |
779 | @cindex read-only text | |
780 | @cindex NMAGIC | |
781 | @kindex --nmagic | |
782 | @item -n | |
783 | @itemx --nmagic | |
90f5d9d9 JZ |
784 | Turn off page alignment of sections, and disable linking against shared |
785 | libraries. If the output format supports Unix style magic numbers, | |
786 | mark the output as @code{NMAGIC}. | |
252b5132 RH |
787 | |
788 | @kindex -N | |
789 | @kindex --omagic | |
790 | @cindex read/write from cmd line | |
791 | @cindex OMAGIC | |
a1ab1d2a | 792 | @item -N |
252b5132 RH |
793 | @itemx --omagic |
794 | Set the text and data sections to be readable and writable. Also, do | |
63fd3b82 NC |
795 | not page-align the data segment, and disable linking against shared |
796 | libraries. If the output format supports Unix style magic numbers, | |
4d8907ac DS |
797 | mark the output as @code{OMAGIC}. Note: Although a writable text section |
798 | is allowed for PE-COFF targets, it does not conform to the format | |
799 | specification published by Microsoft. | |
63fd3b82 NC |
800 | |
801 | @kindex --no-omagic | |
802 | @cindex OMAGIC | |
803 | @item --no-omagic | |
804 | This option negates most of the effects of the @option{-N} option. It | |
805 | sets the text section to be read-only, and forces the data segment to | |
806 | be page-aligned. Note - this option does not enable linking against | |
807 | shared libraries. Use @option{-Bdynamic} for this. | |
252b5132 RH |
808 | |
809 | @kindex -o @var{output} | |
810 | @kindex --output=@var{output} | |
811 | @cindex naming the output file | |
812 | @item -o @var{output} | |
813 | @itemx --output=@var{output} | |
ff5dcc92 | 814 | Use @var{output} as the name for the program produced by @command{ld}; if this |
252b5132 RH |
815 | option is not specified, the name @file{a.out} is used by default. The |
816 | script command @code{OUTPUT} can also specify the output file name. | |
817 | ||
818 | @kindex -O @var{level} | |
819 | @cindex generating optimized output | |
820 | @item -O @var{level} | |
ff5dcc92 | 821 | If @var{level} is a numeric values greater than zero @command{ld} optimizes |
252b5132 | 822 | the output. This might take significantly longer and therefore probably |
98c503ac NC |
823 | should only be enabled for the final binary. At the moment this |
824 | option only affects ELF shared library generation. Future releases of | |
825 | the linker may make more use of this option. Also currently there is | |
826 | no difference in the linker's behaviour for different non-zero values | |
827 | of this option. Again this may change with future releases. | |
252b5132 | 828 | |
a712da20 NC |
829 | @kindex -q |
830 | @kindex --emit-relocs | |
831 | @cindex retain relocations in final executable | |
832 | @item -q | |
833 | @itemx --emit-relocs | |
ba1be17e | 834 | Leave relocation sections and contents in fully linked executables. |
a712da20 NC |
835 | Post link analysis and optimization tools may need this information in |
836 | order to perform correct modifications of executables. This results | |
837 | in larger executables. | |
838 | ||
dbab7a7b NC |
839 | This option is currently only supported on ELF platforms. |
840 | ||
4f471f39 RS |
841 | @kindex --force-dynamic |
842 | @cindex forcing the creation of dynamic sections | |
843 | @item --force-dynamic | |
844 | Force the output file to have dynamic sections. This option is specific | |
845 | to VxWorks targets. | |
846 | ||
252b5132 RH |
847 | @cindex partial link |
848 | @cindex relocatable output | |
849 | @kindex -r | |
1049f94e | 850 | @kindex --relocatable |
252b5132 | 851 | @item -r |
1049f94e | 852 | @itemx --relocatable |
252b5132 | 853 | Generate relocatable output---i.e., generate an output file that can in |
ff5dcc92 | 854 | turn serve as input to @command{ld}. This is often called @dfn{partial |
252b5132 RH |
855 | linking}. As a side effect, in environments that support standard Unix |
856 | magic numbers, this option also sets the output file's magic number to | |
857 | @code{OMAGIC}. | |
ff5dcc92 | 858 | @c ; see @option{-N}. |
252b5132 RH |
859 | If this option is not specified, an absolute file is produced. When |
860 | linking C++ programs, this option @emph{will not} resolve references to | |
861 | constructors; to do that, use @samp{-Ur}. | |
862 | ||
62bf86b4 HPN |
863 | When an input file does not have the same format as the output file, |
864 | partial linking is only supported if that input file does not contain any | |
865 | relocations. Different output formats can have further restrictions; for | |
866 | example some @code{a.out}-based formats do not support partial linking | |
867 | with input files in other formats at all. | |
868 | ||
252b5132 RH |
869 | This option does the same thing as @samp{-i}. |
870 | ||
871 | @kindex -R @var{file} | |
872 | @kindex --just-symbols=@var{file} | |
873 | @cindex symbol-only input | |
874 | @item -R @var{filename} | |
875 | @itemx --just-symbols=@var{filename} | |
876 | Read symbol names and their addresses from @var{filename}, but do not | |
877 | relocate it or include it in the output. This allows your output file | |
878 | to refer symbolically to absolute locations of memory defined in other | |
879 | programs. You may use this option more than once. | |
880 | ||
ff5dcc92 | 881 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 882 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 883 | the @option{-rpath} option. |
252b5132 RH |
884 | |
885 | @kindex -s | |
886 | @kindex --strip-all | |
887 | @cindex strip all symbols | |
a1ab1d2a | 888 | @item -s |
252b5132 RH |
889 | @itemx --strip-all |
890 | Omit all symbol information from the output file. | |
891 | ||
892 | @kindex -S | |
893 | @kindex --strip-debug | |
894 | @cindex strip debugger symbols | |
a1ab1d2a | 895 | @item -S |
252b5132 RH |
896 | @itemx --strip-debug |
897 | Omit debugger symbol information (but not all symbols) from the output file. | |
898 | ||
899 | @kindex -t | |
900 | @kindex --trace | |
901 | @cindex input files, displaying | |
a1ab1d2a | 902 | @item -t |
252b5132 | 903 | @itemx --trace |
ff5dcc92 | 904 | Print the names of the input files as @command{ld} processes them. |
252b5132 RH |
905 | |
906 | @kindex -T @var{script} | |
907 | @kindex --script=@var{script} | |
908 | @cindex script files | |
909 | @item -T @var{scriptfile} | |
910 | @itemx --script=@var{scriptfile} | |
911 | Use @var{scriptfile} as the linker script. This script replaces | |
ff5dcc92 | 912 | @command{ld}'s default linker script (rather than adding to it), so |
252b5132 | 913 | @var{commandfile} must specify everything necessary to describe the |
114283d8 NC |
914 | output file. @xref{Scripts}. If @var{scriptfile} does not exist in |
915 | the current directory, @code{ld} looks for it in the directories | |
916 | specified by any preceding @samp{-L} options. Multiple @samp{-T} | |
917 | options accumulate. | |
252b5132 | 918 | |
14be8564 L |
919 | @kindex -dT @var{script} |
920 | @kindex --default-script=@var{script} | |
921 | @cindex script files | |
922 | @item -dT @var{scriptfile} | |
923 | @itemx --default-script=@var{scriptfile} | |
924 | Use @var{scriptfile} as the default linker script. @xref{Scripts}. | |
925 | ||
926 | This option is similar to the @option{--script} option except that | |
927 | processing of the script is delayed until after the rest of the | |
928 | command line has been processed. This allows options placed after the | |
929 | @option{--default-script} option on the command line to affect the | |
930 | behaviour of the linker script, which can be important when the linker | |
931 | command line cannot be directly controlled by the user. (eg because | |
932 | the command line is being constructed by another tool, such as | |
933 | @samp{gcc}). | |
934 | ||
252b5132 RH |
935 | @kindex -u @var{symbol} |
936 | @kindex --undefined=@var{symbol} | |
937 | @cindex undefined symbol | |
938 | @item -u @var{symbol} | |
939 | @itemx --undefined=@var{symbol} | |
940 | Force @var{symbol} to be entered in the output file as an undefined | |
941 | symbol. Doing this may, for example, trigger linking of additional | |
942 | modules from standard libraries. @samp{-u} may be repeated with | |
943 | different option arguments to enter additional undefined symbols. This | |
944 | option is equivalent to the @code{EXTERN} linker script command. | |
945 | ||
946 | @kindex -Ur | |
947 | @cindex constructors | |
a1ab1d2a | 948 | @item -Ur |
252b5132 RH |
949 | For anything other than C++ programs, this option is equivalent to |
950 | @samp{-r}: it generates relocatable output---i.e., an output file that can in | |
ff5dcc92 | 951 | turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur} |
252b5132 RH |
952 | @emph{does} resolve references to constructors, unlike @samp{-r}. |
953 | It does not work to use @samp{-Ur} on files that were themselves linked | |
954 | with @samp{-Ur}; once the constructor table has been built, it cannot | |
955 | be added to. Use @samp{-Ur} only for the last partial link, and | |
956 | @samp{-r} for the others. | |
957 | ||
577a0623 AM |
958 | @kindex --unique[=@var{SECTION}] |
959 | @item --unique[=@var{SECTION}] | |
960 | Creates a separate output section for every input section matching | |
961 | @var{SECTION}, or if the optional wildcard @var{SECTION} argument is | |
962 | missing, for every orphan input section. An orphan section is one not | |
963 | specifically mentioned in a linker script. You may use this option | |
964 | multiple times on the command line; It prevents the normal merging of | |
965 | input sections with the same name, overriding output section assignments | |
966 | in a linker script. | |
a854a4a7 | 967 | |
252b5132 RH |
968 | @kindex -v |
969 | @kindex -V | |
970 | @kindex --version | |
971 | @cindex version | |
972 | @item -v | |
973 | @itemx --version | |
974 | @itemx -V | |
ff5dcc92 | 975 | Display the version number for @command{ld}. The @option{-V} option also |
252b5132 RH |
976 | lists the supported emulations. |
977 | ||
978 | @kindex -x | |
979 | @kindex --discard-all | |
980 | @cindex deleting local symbols | |
981 | @item -x | |
982 | @itemx --discard-all | |
983 | Delete all local symbols. | |
984 | ||
985 | @kindex -X | |
986 | @kindex --discard-locals | |
987 | @cindex local symbols, deleting | |
a1ab1d2a | 988 | @item -X |
252b5132 | 989 | @itemx --discard-locals |
3c68c38f BW |
990 | Delete all temporary local symbols. (These symbols start with |
991 | system-specific local label prefixes, typically @samp{.L} for ELF systems | |
992 | or @samp{L} for traditional a.out systems.) | |
252b5132 RH |
993 | |
994 | @kindex -y @var{symbol} | |
995 | @kindex --trace-symbol=@var{symbol} | |
996 | @cindex symbol tracing | |
997 | @item -y @var{symbol} | |
998 | @itemx --trace-symbol=@var{symbol} | |
999 | Print the name of each linked file in which @var{symbol} appears. This | |
1000 | option may be given any number of times. On many systems it is necessary | |
1001 | to prepend an underscore. | |
1002 | ||
1003 | This option is useful when you have an undefined symbol in your link but | |
1004 | don't know where the reference is coming from. | |
1005 | ||
1006 | @kindex -Y @var{path} | |
1007 | @item -Y @var{path} | |
1008 | Add @var{path} to the default library search path. This option exists | |
1009 | for Solaris compatibility. | |
1010 | ||
1011 | @kindex -z @var{keyword} | |
1012 | @item -z @var{keyword} | |
cd6d6c15 NC |
1013 | The recognized keywords are: |
1014 | @table @samp | |
1015 | ||
1016 | @item combreloc | |
1017 | Combines multiple reloc sections and sorts them to make dynamic symbol | |
1018 | lookup caching possible. | |
1019 | ||
1020 | @item defs | |
560e09e9 | 1021 | Disallows undefined symbols in object files. Undefined symbols in |
07f3b6ad | 1022 | shared libraries are still allowed. |
cd6d6c15 | 1023 | |
6aa29e7b JJ |
1024 | @item execstack |
1025 | Marks the object as requiring executable stack. | |
1026 | ||
cd6d6c15 NC |
1027 | @item initfirst |
1028 | This option is only meaningful when building a shared object. | |
1029 | It marks the object so that its runtime initialization will occur | |
1030 | before the runtime initialization of any other objects brought into | |
1031 | the process at the same time. Similarly the runtime finalization of | |
1032 | the object will occur after the runtime finalization of any other | |
1033 | objects. | |
1034 | ||
1035 | @item interpose | |
1036 | Marks the object that its symbol table interposes before all symbols | |
1037 | but the primary executable. | |
1038 | ||
5fa222e4 AM |
1039 | @item lazy |
1040 | When generating an executable or shared library, mark it to tell the | |
1041 | dynamic linker to defer function call resolution to the point when | |
1042 | the function is called (lazy binding), rather than at load time. | |
1043 | Lazy binding is the default. | |
1044 | ||
cd6d6c15 NC |
1045 | @item loadfltr |
1046 | Marks the object that its filters be processed immediately at | |
1047 | runtime. | |
1048 | ||
1049 | @item muldefs | |
1050 | Allows multiple definitions. | |
1051 | ||
1052 | @item nocombreloc | |
1053 | Disables multiple reloc sections combining. | |
1054 | ||
1055 | @item nocopyreloc | |
1056 | Disables production of copy relocs. | |
1057 | ||
1058 | @item nodefaultlib | |
1059 | Marks the object that the search for dependencies of this object will | |
1060 | ignore any default library search paths. | |
1061 | ||
1062 | @item nodelete | |
1063 | Marks the object shouldn't be unloaded at runtime. | |
1064 | ||
1065 | @item nodlopen | |
1066 | Marks the object not available to @code{dlopen}. | |
1067 | ||
1068 | @item nodump | |
1069 | Marks the object can not be dumped by @code{dldump}. | |
1070 | ||
6aa29e7b JJ |
1071 | @item noexecstack |
1072 | Marks the object as not requiring executable stack. | |
1073 | ||
1074 | @item norelro | |
1075 | Don't create an ELF @code{PT_GNU_RELRO} segment header in the object. | |
1076 | ||
cd6d6c15 NC |
1077 | @item now |
1078 | When generating an executable or shared library, mark it to tell the | |
1079 | dynamic linker to resolve all symbols when the program is started, or | |
1080 | when the shared library is linked to using dlopen, instead of | |
1081 | deferring function call resolution to the point when the function is | |
1082 | first called. | |
1083 | ||
1084 | @item origin | |
1085 | Marks the object may contain $ORIGIN. | |
1086 | ||
6aa29e7b JJ |
1087 | @item relro |
1088 | Create an ELF @code{PT_GNU_RELRO} segment header in the object. | |
1089 | ||
24718e3b L |
1090 | @item max-page-size=@var{value} |
1091 | Set the emulation maximum page size to @var{value}. | |
1092 | ||
1093 | @item common-page-size=@var{value} | |
1094 | Set the emulation common page size to @var{value}. | |
1095 | ||
cd6d6c15 NC |
1096 | @end table |
1097 | ||
ece2d90e | 1098 | Other keywords are ignored for Solaris compatibility. |
252b5132 RH |
1099 | |
1100 | @kindex -( | |
1101 | @cindex groups of archives | |
1102 | @item -( @var{archives} -) | |
1103 | @itemx --start-group @var{archives} --end-group | |
1104 | The @var{archives} should be a list of archive files. They may be | |
1105 | either explicit file names, or @samp{-l} options. | |
1106 | ||
1107 | The specified archives are searched repeatedly until no new undefined | |
1108 | references are created. Normally, an archive is searched only once in | |
1109 | the order that it is specified on the command line. If a symbol in that | |
1110 | archive is needed to resolve an undefined symbol referred to by an | |
1111 | object in an archive that appears later on the command line, the linker | |
1112 | would not be able to resolve that reference. By grouping the archives, | |
1113 | they all be searched repeatedly until all possible references are | |
1114 | resolved. | |
1115 | ||
1116 | Using this option has a significant performance cost. It is best to use | |
1117 | it only when there are unavoidable circular references between two or | |
1118 | more archives. | |
1119 | ||
69da35b5 NC |
1120 | @kindex --accept-unknown-input-arch |
1121 | @kindex --no-accept-unknown-input-arch | |
1122 | @item --accept-unknown-input-arch | |
1123 | @itemx --no-accept-unknown-input-arch | |
1124 | Tells the linker to accept input files whose architecture cannot be | |
2ca22b03 | 1125 | recognised. The assumption is that the user knows what they are doing |
69da35b5 NC |
1126 | and deliberately wants to link in these unknown input files. This was |
1127 | the default behaviour of the linker, before release 2.14. The default | |
1128 | behaviour from release 2.14 onwards is to reject such input files, and | |
1129 | so the @samp{--accept-unknown-input-arch} option has been added to | |
1130 | restore the old behaviour. | |
2ca22b03 | 1131 | |
4a43e768 AM |
1132 | @kindex --as-needed |
1133 | @kindex --no-as-needed | |
1134 | @item --as-needed | |
1135 | @itemx --no-as-needed | |
1136 | This option affects ELF DT_NEEDED tags for dynamic libraries mentioned | |
ddbb8a31 | 1137 | on the command line after the @option{--as-needed} option. Normally |
4a43e768 AM |
1138 | the linker will add a DT_NEEDED tag for each dynamic library mentioned |
1139 | on the command line, regardless of whether the library is actually | |
ddbb8a31 NC |
1140 | needed or not. @option{--as-needed} causes a DT_NEEDED tag to only be |
1141 | emitted for a library that satisfies an undefined symbol reference | |
1142 | from a regular object file or, if the library is not found in the | |
1143 | DT_NEEDED lists of other libraries linked up to that point, an | |
1144 | undefined symbol reference from another dynamic library. | |
4a43e768 AM |
1145 | @option{--no-as-needed} restores the default behaviour. |
1146 | ||
e56f61be L |
1147 | @kindex --add-needed |
1148 | @kindex --no-add-needed | |
1149 | @item --add-needed | |
1150 | @itemx --no-add-needed | |
ddbb8a31 NC |
1151 | These two options have been deprecated because of the similarity of |
1152 | their names to the @option{--as-needed} and @option{--no-as-needed} | |
1153 | options. They have been replaced by @option{--copy-dt-needed-entries} | |
1154 | and @option{--no-copy-dt-needed-entries}. | |
e56f61be | 1155 | |
252b5132 RH |
1156 | @kindex -assert @var{keyword} |
1157 | @item -assert @var{keyword} | |
1158 | This option is ignored for SunOS compatibility. | |
1159 | ||
1160 | @kindex -Bdynamic | |
1161 | @kindex -dy | |
1162 | @kindex -call_shared | |
1163 | @item -Bdynamic | |
1164 | @itemx -dy | |
1165 | @itemx -call_shared | |
1166 | Link against dynamic libraries. This is only meaningful on platforms | |
1167 | for which shared libraries are supported. This option is normally the | |
1168 | default on such platforms. The different variants of this option are | |
1169 | for compatibility with various systems. You may use this option | |
1170 | multiple times on the command line: it affects library searching for | |
da8bce14 | 1171 | @option{-l} options which follow it. |
252b5132 | 1172 | |
a1ab1d2a UD |
1173 | @kindex -Bgroup |
1174 | @item -Bgroup | |
1175 | Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic | |
1176 | section. This causes the runtime linker to handle lookups in this | |
1177 | object and its dependencies to be performed only inside the group. | |
560e09e9 NC |
1178 | @option{--unresolved-symbols=report-all} is implied. This option is |
1179 | only meaningful on ELF platforms which support shared libraries. | |
a1ab1d2a | 1180 | |
252b5132 RH |
1181 | @kindex -Bstatic |
1182 | @kindex -dn | |
1183 | @kindex -non_shared | |
1184 | @kindex -static | |
a1ab1d2a | 1185 | @item -Bstatic |
252b5132 RH |
1186 | @itemx -dn |
1187 | @itemx -non_shared | |
1188 | @itemx -static | |
1189 | Do not link against shared libraries. This is only meaningful on | |
1190 | platforms for which shared libraries are supported. The different | |
1191 | variants of this option are for compatibility with various systems. You | |
1192 | may use this option multiple times on the command line: it affects | |
560e09e9 | 1193 | library searching for @option{-l} options which follow it. This |
e9156f74 NC |
1194 | option also implies @option{--unresolved-symbols=report-all}. This |
1195 | option can be used with @option{-shared}. Doing so means that a | |
1196 | shared library is being created but that all of the library's external | |
1197 | references must be resolved by pulling in entries from static | |
ece2d90e | 1198 | libraries. |
252b5132 RH |
1199 | |
1200 | @kindex -Bsymbolic | |
1201 | @item -Bsymbolic | |
1202 | When creating a shared library, bind references to global symbols to the | |
1203 | definition within the shared library, if any. Normally, it is possible | |
1204 | for a program linked against a shared library to override the definition | |
1205 | within the shared library. This option is only meaningful on ELF | |
1206 | platforms which support shared libraries. | |
1207 | ||
40b36307 L |
1208 | @kindex -Bsymbolic-functions |
1209 | @item -Bsymbolic-functions | |
1210 | When creating a shared library, bind references to global function | |
c0065db7 | 1211 | symbols to the definition within the shared library, if any. |
40b36307 L |
1212 | This option is only meaningful on ELF platforms which support shared |
1213 | libraries. | |
1214 | ||
55255dae L |
1215 | @kindex --dynamic-list=@var{dynamic-list-file} |
1216 | @item --dynamic-list=@var{dynamic-list-file} | |
1217 | Specify the name of a dynamic list file to the linker. This is | |
1218 | typically used when creating shared libraries to specify a list of | |
1219 | global symbols whose references shouldn't be bound to the definition | |
1220 | within the shared library, or creating dynamically linked executables | |
1221 | to specify a list of symbols which should be added to the symbol table | |
1222 | in the executable. This option is only meaningful on ELF platforms | |
1223 | which support shared libraries. | |
1224 | ||
1225 | The format of the dynamic list is the same as the version node without | |
1226 | scope and node name. See @ref{VERSION} for more information. | |
1227 | ||
40b36307 L |
1228 | @kindex --dynamic-list-data |
1229 | @item --dynamic-list-data | |
1230 | Include all global data symbols to the dynamic list. | |
1231 | ||
1232 | @kindex --dynamic-list-cpp-new | |
1233 | @item --dynamic-list-cpp-new | |
1234 | Provide the builtin dynamic list for C++ operator new and delete. It | |
1235 | is mainly useful for building shared libstdc++. | |
1236 | ||
0b8a70d9 L |
1237 | @kindex --dynamic-list-cpp-typeinfo |
1238 | @item --dynamic-list-cpp-typeinfo | |
1239 | Provide the builtin dynamic list for C++ runtime type identification. | |
1240 | ||
252b5132 RH |
1241 | @kindex --check-sections |
1242 | @kindex --no-check-sections | |
1243 | @item --check-sections | |
308b1ffd | 1244 | @itemx --no-check-sections |
252b5132 | 1245 | Asks the linker @emph{not} to check section addresses after they have |
7d816a17 | 1246 | been assigned to see if there are any overlaps. Normally the linker will |
252b5132 RH |
1247 | perform this check, and if it finds any overlaps it will produce |
1248 | suitable error messages. The linker does know about, and does make | |
1249 | allowances for sections in overlays. The default behaviour can be | |
560e09e9 | 1250 | restored by using the command line switch @option{--check-sections}. |
02b0b1aa NS |
1251 | Section overlap is not usually checked for relocatable links. You can |
1252 | force checking in that case by using the @option{--check-sections} | |
1253 | option. | |
252b5132 | 1254 | |
ddbb8a31 NC |
1255 | @kindex --copy-dt-needed-entries |
1256 | @kindex --no-copy-dt-needed-entries | |
1257 | @item --copy-dt-needed-entries | |
1258 | @itemx --no-copy-dt-needed-entries | |
1259 | This option affects the treatment of dynamic libraries referred to | |
1260 | by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the | |
1261 | command line. Normally the linker will add a DT_NEEDED tag to the | |
1262 | output binary for each library mentioned in a DT_NEEDED tag in an | |
1263 | input dynamic library. With @option{--no-copy-dt-needed-entries} | |
1264 | specified on the command line however any dynamic libraries that | |
1265 | follow it will have their DT_NEEDED entries ignored. The default | |
1266 | behaviour can be restored with @option{--copy-dt-needed-entries}. | |
1267 | ||
1268 | This option also has an effect on the resolution of symbols in dynamic | |
1269 | libraries. With the default setting dynamic libraries mentioned on | |
1270 | the command line will be recursively searched, following their | |
1271 | DT_NEEDED tags to other libraries, in order to resolve symbols | |
1272 | required by the output binary. With | |
1273 | @option{--no-copy-dt-needed-entries} specified however the searching | |
1274 | of dynamic libraries that follow it will stop with the dynamic | |
1275 | library itself. No DT_NEEDED links will be traversed to resolve | |
1276 | symbols. | |
1277 | ||
252b5132 RH |
1278 | @cindex cross reference table |
1279 | @kindex --cref | |
1280 | @item --cref | |
1281 | Output a cross reference table. If a linker map file is being | |
1282 | generated, the cross reference table is printed to the map file. | |
1283 | Otherwise, it is printed on the standard output. | |
1284 | ||
1285 | The format of the table is intentionally simple, so that it may be | |
1286 | easily processed by a script if necessary. The symbols are printed out, | |
1287 | sorted by name. For each symbol, a list of file names is given. If the | |
1288 | symbol is defined, the first file listed is the location of the | |
1289 | definition. The remaining files contain references to the symbol. | |
1290 | ||
4818e05f AM |
1291 | @cindex common allocation |
1292 | @kindex --no-define-common | |
1293 | @item --no-define-common | |
1294 | This option inhibits the assignment of addresses to common symbols. | |
1295 | The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect. | |
1296 | @xref{Miscellaneous Commands}. | |
1297 | ||
1298 | The @samp{--no-define-common} option allows decoupling | |
1299 | the decision to assign addresses to Common symbols from the choice | |
1300 | of the output file type; otherwise a non-Relocatable output type | |
1301 | forces assigning addresses to Common symbols. | |
1302 | Using @samp{--no-define-common} allows Common symbols that are referenced | |
1303 | from a shared library to be assigned addresses only in the main program. | |
1304 | This eliminates the unused duplicate space in the shared library, | |
1305 | and also prevents any possible confusion over resolving to the wrong | |
1306 | duplicate when there are many dynamic modules with specialized search | |
1307 | paths for runtime symbol resolution. | |
1308 | ||
252b5132 | 1309 | @cindex symbols, from command line |
2509a395 SL |
1310 | @kindex --defsym=@var{symbol}=@var{exp} |
1311 | @item --defsym=@var{symbol}=@var{expression} | |
252b5132 RH |
1312 | Create a global symbol in the output file, containing the absolute |
1313 | address given by @var{expression}. You may use this option as many | |
1314 | times as necessary to define multiple symbols in the command line. A | |
1315 | limited form of arithmetic is supported for the @var{expression} in this | |
1316 | context: you may give a hexadecimal constant or the name of an existing | |
1317 | symbol, or use @code{+} and @code{-} to add or subtract hexadecimal | |
1318 | constants or symbols. If you need more elaborate expressions, consider | |
1319 | using the linker command language from a script (@pxref{Assignments,, | |
1320 | Assignment: Symbol Definitions}). @emph{Note:} there should be no white | |
1321 | space between @var{symbol}, the equals sign (``@key{=}''), and | |
1322 | @var{expression}. | |
1323 | ||
1324 | @cindex demangling, from command line | |
28c309a2 | 1325 | @kindex --demangle[=@var{style}] |
252b5132 | 1326 | @kindex --no-demangle |
28c309a2 | 1327 | @item --demangle[=@var{style}] |
252b5132 RH |
1328 | @itemx --no-demangle |
1329 | These options control whether to demangle symbol names in error messages | |
1330 | and other output. When the linker is told to demangle, it tries to | |
1331 | present symbol names in a readable fashion: it strips leading | |
1332 | underscores if they are used by the object file format, and converts C++ | |
a1ab1d2a UD |
1333 | mangled symbol names into user readable names. Different compilers have |
1334 | different mangling styles. The optional demangling style argument can be used | |
1335 | to choose an appropriate demangling style for your compiler. The linker will | |
28c309a2 NC |
1336 | demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE} |
1337 | is set. These options may be used to override the default. | |
252b5132 RH |
1338 | |
1339 | @cindex dynamic linker, from command line | |
506eee22 | 1340 | @kindex -I@var{file} |
2509a395 SL |
1341 | @kindex --dynamic-linker=@var{file} |
1342 | @item -I@var{file} | |
1343 | @itemx --dynamic-linker=@var{file} | |
252b5132 RH |
1344 | Set the name of the dynamic linker. This is only meaningful when |
1345 | generating dynamically linked ELF executables. The default dynamic | |
1346 | linker is normally correct; don't use this unless you know what you are | |
1347 | doing. | |
1348 | ||
7ce691ae | 1349 | @kindex --fatal-warnings |
0fe58ccd | 1350 | @kindex --no-fatal-warnings |
7ce691ae | 1351 | @item --fatal-warnings |
0fe58ccd NC |
1352 | @itemx --no-fatal-warnings |
1353 | Treat all warnings as errors. The default behaviour can be restored | |
1354 | with the option @option{--no-fatal-warnings}. | |
7ce691ae | 1355 | |
252b5132 RH |
1356 | @kindex --force-exe-suffix |
1357 | @item --force-exe-suffix | |
1358 | Make sure that an output file has a .exe suffix. | |
1359 | ||
1360 | If a successfully built fully linked output file does not have a | |
1361 | @code{.exe} or @code{.dll} suffix, this option forces the linker to copy | |
1362 | the output file to one of the same name with a @code{.exe} suffix. This | |
1363 | option is useful when using unmodified Unix makefiles on a Microsoft | |
1364 | Windows host, since some versions of Windows won't run an image unless | |
1365 | it ends in a @code{.exe} suffix. | |
1366 | ||
1367 | @kindex --gc-sections | |
1368 | @kindex --no-gc-sections | |
1369 | @cindex garbage collection | |
c17d87de NC |
1370 | @item --gc-sections |
1371 | @itemx --no-gc-sections | |
252b5132 | 1372 | Enable garbage collection of unused input sections. It is ignored on |
ac69cbc6 | 1373 | targets that do not support this option. The default behaviour (of not |
b3549761 NC |
1374 | performing this garbage collection) can be restored by specifying |
1375 | @samp{--no-gc-sections} on the command line. | |
252b5132 | 1376 | |
d5465ba2 AM |
1377 | @samp{--gc-sections} decides which input sections are used by |
1378 | examining symbols and relocations. The section containing the entry | |
1379 | symbol and all sections containing symbols undefined on the | |
1380 | command-line will be kept, as will sections containing symbols | |
1381 | referenced by dynamic objects. Note that when building shared | |
1382 | libraries, the linker must assume that any visible symbol is | |
1383 | referenced. Once this initial set of sections has been determined, | |
1384 | the linker recursively marks as used any section referenced by their | |
1385 | relocations. See @samp{--entry} and @samp{--undefined}. | |
1386 | ||
ac69cbc6 | 1387 | This option can be set when doing a partial link (enabled with option |
fc073cb7 | 1388 | @samp{-r}). In this case the root of symbols kept must be explicitly |
ac69cbc6 TG |
1389 | specified either by an @samp{--entry} or @samp{--undefined} option or by |
1390 | a @code{ENTRY} command in the linker script. | |
1391 | ||
c17d87de NC |
1392 | @kindex --print-gc-sections |
1393 | @kindex --no-print-gc-sections | |
1394 | @cindex garbage collection | |
1395 | @item --print-gc-sections | |
1396 | @itemx --no-print-gc-sections | |
1397 | List all sections removed by garbage collection. The listing is | |
1398 | printed on stderr. This option is only effective if garbage | |
1399 | collection has been enabled via the @samp{--gc-sections}) option. The | |
1400 | default behaviour (of not listing the sections that are removed) can | |
1401 | be restored by specifying @samp{--no-print-gc-sections} on the command | |
1402 | line. | |
1403 | ||
252b5132 RH |
1404 | @cindex help |
1405 | @cindex usage | |
1406 | @kindex --help | |
1407 | @item --help | |
1408 | Print a summary of the command-line options on the standard output and exit. | |
1409 | ||
ea20a7da CC |
1410 | @kindex --target-help |
1411 | @item --target-help | |
1412 | Print a summary of all target specific options on the standard output and exit. | |
1413 | ||
2509a395 SL |
1414 | @kindex -Map=@var{mapfile} |
1415 | @item -Map=@var{mapfile} | |
252b5132 | 1416 | Print a link map to the file @var{mapfile}. See the description of the |
560e09e9 | 1417 | @option{-M} option, above. |
252b5132 RH |
1418 | |
1419 | @cindex memory usage | |
1420 | @kindex --no-keep-memory | |
1421 | @item --no-keep-memory | |
ff5dcc92 SC |
1422 | @command{ld} normally optimizes for speed over memory usage by caching the |
1423 | symbol tables of input files in memory. This option tells @command{ld} to | |
252b5132 | 1424 | instead optimize for memory usage, by rereading the symbol tables as |
ff5dcc92 | 1425 | necessary. This may be required if @command{ld} runs out of memory space |
252b5132 RH |
1426 | while linking a large executable. |
1427 | ||
1428 | @kindex --no-undefined | |
a1ab1d2a | 1429 | @kindex -z defs |
252b5132 | 1430 | @item --no-undefined |
a1ab1d2a | 1431 | @itemx -z defs |
560e09e9 NC |
1432 | Report unresolved symbol references from regular object files. This |
1433 | is done even if the linker is creating a non-symbolic shared library. | |
1434 | The switch @option{--[no-]allow-shlib-undefined} controls the | |
1435 | behaviour for reporting unresolved references found in shared | |
ece2d90e | 1436 | libraries being linked in. |
252b5132 | 1437 | |
aa713662 L |
1438 | @kindex --allow-multiple-definition |
1439 | @kindex -z muldefs | |
1440 | @item --allow-multiple-definition | |
1441 | @itemx -z muldefs | |
1442 | Normally when a symbol is defined multiple times, the linker will | |
1443 | report a fatal error. These options allow multiple definitions and the | |
1444 | first definition will be used. | |
1445 | ||
b79e8c78 | 1446 | @kindex --allow-shlib-undefined |
ae9a127f | 1447 | @kindex --no-allow-shlib-undefined |
b79e8c78 | 1448 | @item --allow-shlib-undefined |
ae9a127f | 1449 | @itemx --no-allow-shlib-undefined |
903249d7 | 1450 | Allows or disallows undefined symbols in shared libraries. |
560e09e9 NC |
1451 | This switch is similar to @option{--no-undefined} except that it |
1452 | determines the behaviour when the undefined symbols are in a | |
1453 | shared library rather than a regular object file. It does not affect | |
1454 | how undefined symbols in regular object files are handled. | |
1455 | ||
903249d7 NC |
1456 | The default behaviour is to report errors for any undefined symbols |
1457 | referenced in shared libraries if the linker is being used to create | |
1458 | an executable, but to allow them if the linker is being used to create | |
1459 | a shared library. | |
1460 | ||
1461 | The reasons for allowing undefined symbol references in shared | |
1462 | libraries specified at link time are that: | |
1463 | ||
1464 | @itemize @bullet | |
1465 | @item | |
1466 | A shared library specified at link time may not be the same as the one | |
1467 | that is available at load time, so the symbol might actually be | |
1468 | resolvable at load time. | |
1469 | @item | |
1470 | There are some operating systems, eg BeOS and HPPA, where undefined | |
1471 | symbols in shared libraries are normal. | |
1472 | ||
1473 | The BeOS kernel for example patches shared libraries at load time to | |
1474 | select whichever function is most appropriate for the current | |
1475 | architecture. This is used, for example, to dynamically select an | |
1476 | appropriate memset function. | |
1477 | @end itemize | |
b79e8c78 | 1478 | |
31941635 L |
1479 | @kindex --no-undefined-version |
1480 | @item --no-undefined-version | |
1481 | Normally when a symbol has an undefined version, the linker will ignore | |
1482 | it. This option disallows symbols with undefined version and a fatal error | |
1483 | will be issued instead. | |
1484 | ||
3e3b46e5 PB |
1485 | @kindex --default-symver |
1486 | @item --default-symver | |
1487 | Create and use a default symbol version (the soname) for unversioned | |
fc0e6df6 PB |
1488 | exported symbols. |
1489 | ||
1490 | @kindex --default-imported-symver | |
1491 | @item --default-imported-symver | |
1492 | Create and use a default symbol version (the soname) for unversioned | |
1493 | imported symbols. | |
3e3b46e5 | 1494 | |
252b5132 RH |
1495 | @kindex --no-warn-mismatch |
1496 | @item --no-warn-mismatch | |
ff5dcc92 | 1497 | Normally @command{ld} will give an error if you try to link together input |
252b5132 RH |
1498 | files that are mismatched for some reason, perhaps because they have |
1499 | been compiled for different processors or for different endiannesses. | |
ff5dcc92 | 1500 | This option tells @command{ld} that it should silently permit such possible |
252b5132 RH |
1501 | errors. This option should only be used with care, in cases when you |
1502 | have taken some special action that ensures that the linker errors are | |
1503 | inappropriate. | |
1504 | ||
fe7929ce AM |
1505 | @kindex --no-warn-search-mismatch |
1506 | @item --no-warn-search-mismatch | |
1507 | Normally @command{ld} will give a warning if it finds an incompatible | |
1508 | library during a library search. This option silences the warning. | |
1509 | ||
252b5132 RH |
1510 | @kindex --no-whole-archive |
1511 | @item --no-whole-archive | |
ff5dcc92 | 1512 | Turn off the effect of the @option{--whole-archive} option for subsequent |
252b5132 RH |
1513 | archive files. |
1514 | ||
1515 | @cindex output file after errors | |
1516 | @kindex --noinhibit-exec | |
1517 | @item --noinhibit-exec | |
1518 | Retain the executable output file whenever it is still usable. | |
1519 | Normally, the linker will not produce an output file if it encounters | |
1520 | errors during the link process; it exits without writing an output file | |
1521 | when it issues any error whatsoever. | |
1522 | ||
0a9c1c8e CD |
1523 | @kindex -nostdlib |
1524 | @item -nostdlib | |
1525 | Only search library directories explicitly specified on the | |
1526 | command line. Library directories specified in linker scripts | |
1527 | (including linker scripts specified on the command line) are ignored. | |
1528 | ||
252b5132 | 1529 | @ifclear SingleFormat |
2509a395 SL |
1530 | @kindex --oformat=@var{output-format} |
1531 | @item --oformat=@var{output-format} | |
ff5dcc92 SC |
1532 | @command{ld} may be configured to support more than one kind of object |
1533 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 1534 | @samp{--oformat} option to specify the binary format for the output |
ff5dcc92 SC |
1535 | object file. Even when @command{ld} is configured to support alternative |
1536 | object formats, you don't usually need to specify this, as @command{ld} | |
252b5132 RH |
1537 | should be configured to produce as a default output format the most |
1538 | usual format on each machine. @var{output-format} is a text string, the | |
1539 | name of a particular format supported by the BFD libraries. (You can | |
1540 | list the available binary formats with @samp{objdump -i}.) The script | |
1541 | command @code{OUTPUT_FORMAT} can also specify the output format, but | |
1542 | this option overrides it. @xref{BFD}. | |
1543 | @end ifclear | |
1544 | ||
36af4a4e JJ |
1545 | @kindex -pie |
1546 | @kindex --pic-executable | |
1547 | @item -pie | |
1548 | @itemx --pic-executable | |
1549 | @cindex position independent executables | |
1550 | Create a position independent executable. This is currently only supported on | |
1551 | ELF platforms. Position independent executables are similar to shared | |
1552 | libraries in that they are relocated by the dynamic linker to the virtual | |
7e7d5768 | 1553 | address the OS chooses for them (which can vary between invocations). Like |
36af4a4e JJ |
1554 | normal dynamically linked executables they can be executed and symbols |
1555 | defined in the executable cannot be overridden by shared libraries. | |
1556 | ||
252b5132 RH |
1557 | @kindex -qmagic |
1558 | @item -qmagic | |
1559 | This option is ignored for Linux compatibility. | |
1560 | ||
1561 | @kindex -Qy | |
1562 | @item -Qy | |
1563 | This option is ignored for SVR4 compatibility. | |
1564 | ||
1565 | @kindex --relax | |
1566 | @cindex synthesizing linker | |
1567 | @cindex relaxing addressing modes | |
28d5f677 | 1568 | @cindex --no-relax |
252b5132 | 1569 | @item --relax |
28d5f677 | 1570 | @itemx --no-relax |
a1ab1d2a | 1571 | An option with machine dependent effects. |
252b5132 RH |
1572 | @ifset GENERIC |
1573 | This option is only supported on a few targets. | |
1574 | @end ifset | |
1575 | @ifset H8300 | |
ff5dcc92 | 1576 | @xref{H8/300,,@command{ld} and the H8/300}. |
252b5132 RH |
1577 | @end ifset |
1578 | @ifset I960 | |
ff5dcc92 | 1579 | @xref{i960,, @command{ld} and the Intel 960 family}. |
252b5132 | 1580 | @end ifset |
e0001a05 NC |
1581 | @ifset XTENSA |
1582 | @xref{Xtensa,, @command{ld} and Xtensa Processors}. | |
1583 | @end ifset | |
93fd0973 SC |
1584 | @ifset M68HC11 |
1585 | @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}. | |
1586 | @end ifset | |
2a60a7a8 AM |
1587 | @ifset POWERPC |
1588 | @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}. | |
1589 | @end ifset | |
252b5132 | 1590 | |
28d5f677 NC |
1591 | On some platforms the @samp{--relax} option performs target specific, |
1592 | global optimizations that become possible when the linker resolves | |
1593 | addressing in the program, such as relaxing address modes, | |
1594 | synthesizing new instructions, selecting shorter version of current | |
1595 | instructions, and combinig constant values. | |
252b5132 RH |
1596 | |
1597 | On some platforms these link time global optimizations may make symbolic | |
1598 | debugging of the resulting executable impossible. | |
1599 | @ifset GENERIC | |
28d5f677 NC |
1600 | This is known to be the case for the Matsushita MN10200 and MN10300 |
1601 | family of processors. | |
252b5132 RH |
1602 | @end ifset |
1603 | ||
1604 | @ifset GENERIC | |
1605 | On platforms where this is not supported, @samp{--relax} is accepted, | |
1606 | but ignored. | |
1607 | @end ifset | |
1608 | ||
28d5f677 NC |
1609 | On platforms where @samp{--relax} is accepted the option |
1610 | @samp{--no-relax} can be used to disable the feature. | |
1611 | ||
252b5132 RH |
1612 | @cindex retaining specified symbols |
1613 | @cindex stripping all but some symbols | |
1614 | @cindex symbols, retaining selectively | |
2509a395 SL |
1615 | @kindex --retain-symbols-file=@var{filename} |
1616 | @item --retain-symbols-file=@var{filename} | |
252b5132 RH |
1617 | Retain @emph{only} the symbols listed in the file @var{filename}, |
1618 | discarding all others. @var{filename} is simply a flat file, with one | |
1619 | symbol name per line. This option is especially useful in environments | |
1620 | @ifset GENERIC | |
1621 | (such as VxWorks) | |
1622 | @end ifset | |
1623 | where a large global symbol table is accumulated gradually, to conserve | |
1624 | run-time memory. | |
1625 | ||
1626 | @samp{--retain-symbols-file} does @emph{not} discard undefined symbols, | |
1627 | or symbols needed for relocations. | |
1628 | ||
1629 | You may only specify @samp{--retain-symbols-file} once in the command | |
1630 | line. It overrides @samp{-s} and @samp{-S}. | |
1631 | ||
1632 | @ifset GENERIC | |
2509a395 | 1633 | @item -rpath=@var{dir} |
252b5132 | 1634 | @cindex runtime library search path |
2509a395 | 1635 | @kindex -rpath=@var{dir} |
252b5132 | 1636 | Add a directory to the runtime library search path. This is used when |
ff5dcc92 | 1637 | linking an ELF executable with shared objects. All @option{-rpath} |
252b5132 | 1638 | arguments are concatenated and passed to the runtime linker, which uses |
ff5dcc92 | 1639 | them to locate shared objects at runtime. The @option{-rpath} option is |
252b5132 RH |
1640 | also used when locating shared objects which are needed by shared |
1641 | objects explicitly included in the link; see the description of the | |
ff5dcc92 | 1642 | @option{-rpath-link} option. If @option{-rpath} is not used when linking an |
252b5132 RH |
1643 | ELF executable, the contents of the environment variable |
1644 | @code{LD_RUN_PATH} will be used if it is defined. | |
1645 | ||
ff5dcc92 | 1646 | The @option{-rpath} option may also be used on SunOS. By default, on |
252b5132 | 1647 | SunOS, the linker will form a runtime search patch out of all the |
ff5dcc92 SC |
1648 | @option{-L} options it is given. If a @option{-rpath} option is used, the |
1649 | runtime search path will be formed exclusively using the @option{-rpath} | |
1650 | options, ignoring the @option{-L} options. This can be useful when using | |
1651 | gcc, which adds many @option{-L} options which may be on NFS mounted | |
b45619c0 | 1652 | file systems. |
252b5132 | 1653 | |
ff5dcc92 | 1654 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 1655 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 1656 | the @option{-rpath} option. |
252b5132 RH |
1657 | @end ifset |
1658 | ||
1659 | @ifset GENERIC | |
1660 | @cindex link-time runtime library search path | |
2509a395 SL |
1661 | @kindex -rpath-link=@var{dir} |
1662 | @item -rpath-link=@var{dir} | |
252b5132 RH |
1663 | When using ELF or SunOS, one shared library may require another. This |
1664 | happens when an @code{ld -shared} link includes a shared library as one | |
1665 | of the input files. | |
1666 | ||
1667 | When the linker encounters such a dependency when doing a non-shared, | |
1668 | non-relocatable link, it will automatically try to locate the required | |
1669 | shared library and include it in the link, if it is not included | |
ff5dcc92 | 1670 | explicitly. In such a case, the @option{-rpath-link} option |
252b5132 | 1671 | specifies the first set of directories to search. The |
ff5dcc92 | 1672 | @option{-rpath-link} option may specify a sequence of directory names |
252b5132 RH |
1673 | either by specifying a list of names separated by colons, or by |
1674 | appearing multiple times. | |
1675 | ||
28c309a2 NC |
1676 | This option should be used with caution as it overrides the search path |
1677 | that may have been hard compiled into a shared library. In such a case it | |
1678 | is possible to use unintentionally a different search path than the | |
1679 | runtime linker would do. | |
1680 | ||
252b5132 | 1681 | The linker uses the following search paths to locate required shared |
ece2d90e | 1682 | libraries: |
252b5132 RH |
1683 | @enumerate |
1684 | @item | |
ff5dcc92 | 1685 | Any directories specified by @option{-rpath-link} options. |
252b5132 | 1686 | @item |
ff5dcc92 SC |
1687 | Any directories specified by @option{-rpath} options. The difference |
1688 | between @option{-rpath} and @option{-rpath-link} is that directories | |
1689 | specified by @option{-rpath} options are included in the executable and | |
1690 | used at runtime, whereas the @option{-rpath-link} option is only effective | |
ece2d90e NC |
1691 | at link time. Searching @option{-rpath} in this way is only supported |
1692 | by native linkers and cross linkers which have been configured with | |
1693 | the @option{--with-sysroot} option. | |
252b5132 | 1694 | @item |
e2a83dd0 NC |
1695 | On an ELF system, for native linkers, if the @option{-rpath} and |
1696 | @option{-rpath-link} options were not used, search the contents of the | |
1697 | environment variable @code{LD_RUN_PATH}. | |
252b5132 | 1698 | @item |
ff5dcc92 SC |
1699 | On SunOS, if the @option{-rpath} option was not used, search any |
1700 | directories specified using @option{-L} options. | |
252b5132 | 1701 | @item |
e2a83dd0 NC |
1702 | For a native linker, the search the contents of the environment |
1703 | variable @code{LD_LIBRARY_PATH}. | |
252b5132 | 1704 | @item |
ec4eb78a L |
1705 | For a native ELF linker, the directories in @code{DT_RUNPATH} or |
1706 | @code{DT_RPATH} of a shared library are searched for shared | |
1707 | libraries needed by it. The @code{DT_RPATH} entries are ignored if | |
1708 | @code{DT_RUNPATH} entries exist. | |
1709 | @item | |
252b5132 RH |
1710 | The default directories, normally @file{/lib} and @file{/usr/lib}. |
1711 | @item | |
1712 | For a native linker on an ELF system, if the file @file{/etc/ld.so.conf} | |
1713 | exists, the list of directories found in that file. | |
1714 | @end enumerate | |
1715 | ||
1716 | If the required shared library is not found, the linker will issue a | |
1717 | warning and continue with the link. | |
1718 | @end ifset | |
1719 | ||
1720 | @kindex -shared | |
1721 | @kindex -Bshareable | |
1722 | @item -shared | |
1723 | @itemx -Bshareable | |
1724 | @cindex shared libraries | |
1725 | Create a shared library. This is currently only supported on ELF, XCOFF | |
1726 | and SunOS platforms. On SunOS, the linker will automatically create a | |
ff5dcc92 | 1727 | shared library if the @option{-e} option is not used and there are |
252b5132 RH |
1728 | undefined symbols in the link. |
1729 | ||
252b5132 | 1730 | @kindex --sort-common |
2509a395 SL |
1731 | @item --sort-common |
1732 | @itemx --sort-common=ascending | |
1733 | @itemx --sort-common=descending | |
de7dd2bd NC |
1734 | This option tells @command{ld} to sort the common symbols by alignment in |
1735 | ascending or descending order when it places them in the appropriate output | |
1736 | sections. The symbol alignments considered are sixteen-byte or larger, | |
1737 | eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps | |
1738 | between symbols due to alignment constraints. If no sorting order is | |
1739 | specified, then descending order is assumed. | |
252b5132 | 1740 | |
2509a395 SL |
1741 | @kindex --sort-section=name |
1742 | @item --sort-section=name | |
bcaa7b3e L |
1743 | This option will apply @code{SORT_BY_NAME} to all wildcard section |
1744 | patterns in the linker script. | |
1745 | ||
2509a395 SL |
1746 | @kindex --sort-section=alignment |
1747 | @item --sort-section=alignment | |
bcaa7b3e L |
1748 | This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section |
1749 | patterns in the linker script. | |
1750 | ||
252b5132 | 1751 | @kindex --split-by-file |
2509a395 | 1752 | @item --split-by-file[=@var{size}] |
ff5dcc92 | 1753 | Similar to @option{--split-by-reloc} but creates a new output section for |
a854a4a7 AM |
1754 | each input file when @var{size} is reached. @var{size} defaults to a |
1755 | size of 1 if not given. | |
252b5132 RH |
1756 | |
1757 | @kindex --split-by-reloc | |
2509a395 | 1758 | @item --split-by-reloc[=@var{count}] |
a854a4a7 | 1759 | Tries to creates extra sections in the output file so that no single |
252b5132 | 1760 | output section in the file contains more than @var{count} relocations. |
a854a4a7 | 1761 | This is useful when generating huge relocatable files for downloading into |
252b5132 RH |
1762 | certain real time kernels with the COFF object file format; since COFF |
1763 | cannot represent more than 65535 relocations in a single section. Note | |
1764 | that this will fail to work with object file formats which do not | |
1765 | support arbitrary sections. The linker will not split up individual | |
1766 | input sections for redistribution, so if a single input section contains | |
1767 | more than @var{count} relocations one output section will contain that | |
a854a4a7 | 1768 | many relocations. @var{count} defaults to a value of 32768. |
252b5132 RH |
1769 | |
1770 | @kindex --stats | |
1771 | @item --stats | |
1772 | Compute and display statistics about the operation of the linker, such | |
1773 | as execution time and memory usage. | |
1774 | ||
2509a395 | 1775 | @kindex --sysroot=@var{directory} |
e2243057 RS |
1776 | @item --sysroot=@var{directory} |
1777 | Use @var{directory} as the location of the sysroot, overriding the | |
1778 | configure-time default. This option is only supported by linkers | |
1779 | that were configured using @option{--with-sysroot}. | |
1780 | ||
252b5132 RH |
1781 | @kindex --traditional-format |
1782 | @cindex traditional format | |
1783 | @item --traditional-format | |
ff5dcc92 SC |
1784 | For some targets, the output of @command{ld} is different in some ways from |
1785 | the output of some existing linker. This switch requests @command{ld} to | |
252b5132 RH |
1786 | use the traditional format instead. |
1787 | ||
1788 | @cindex dbx | |
ff5dcc92 | 1789 | For example, on SunOS, @command{ld} combines duplicate entries in the |
252b5132 RH |
1790 | symbol string table. This can reduce the size of an output file with |
1791 | full debugging information by over 30 percent. Unfortunately, the SunOS | |
1792 | @code{dbx} program can not read the resulting program (@code{gdb} has no | |
ff5dcc92 | 1793 | trouble). The @samp{--traditional-format} switch tells @command{ld} to not |
252b5132 RH |
1794 | combine duplicate entries. |
1795 | ||
2509a395 SL |
1796 | @kindex --section-start=@var{sectionname}=@var{org} |
1797 | @item --section-start=@var{sectionname}=@var{org} | |
176355da NC |
1798 | Locate a section in the output file at the absolute |
1799 | address given by @var{org}. You may use this option as many | |
1800 | times as necessary to locate multiple sections in the command | |
1801 | line. | |
1802 | @var{org} must be a single hexadecimal integer; | |
1803 | for compatibility with other linkers, you may omit the leading | |
1804 | @samp{0x} usually associated with hexadecimal values. @emph{Note:} there | |
1805 | should be no white space between @var{sectionname}, the equals | |
1806 | sign (``@key{=}''), and @var{org}. | |
1807 | ||
2509a395 SL |
1808 | @kindex -Tbss=@var{org} |
1809 | @kindex -Tdata=@var{org} | |
1810 | @kindex -Ttext=@var{org} | |
252b5132 | 1811 | @cindex segment origins, cmd line |
2509a395 SL |
1812 | @item -Tbss=@var{org} |
1813 | @itemx -Tdata=@var{org} | |
1814 | @itemx -Ttext=@var{org} | |
1815 | Same as @option{--section-start}, with @code{.bss}, @code{.data} or | |
a6e02871 | 1816 | @code{.text} as the @var{sectionname}. |
252b5132 | 1817 | |
2509a395 SL |
1818 | @kindex -Ttext-segment=@var{org} |
1819 | @item -Ttext-segment=@var{org} | |
258795f5 L |
1820 | @cindex text segment origin, cmd line |
1821 | When creating an ELF executable or shared object, it will set the address | |
1822 | of the first byte of the text segment. | |
1823 | ||
560e09e9 NC |
1824 | @kindex --unresolved-symbols |
1825 | @item --unresolved-symbols=@var{method} | |
1826 | Determine how to handle unresolved symbols. There are four possible | |
1827 | values for @samp{method}: | |
1828 | ||
1829 | @table @samp | |
1830 | @item ignore-all | |
da8bce14 | 1831 | Do not report any unresolved symbols. |
560e09e9 NC |
1832 | |
1833 | @item report-all | |
da8bce14 | 1834 | Report all unresolved symbols. This is the default. |
560e09e9 NC |
1835 | |
1836 | @item ignore-in-object-files | |
1837 | Report unresolved symbols that are contained in shared libraries, but | |
1838 | ignore them if they come from regular object files. | |
1839 | ||
1840 | @item ignore-in-shared-libs | |
1841 | Report unresolved symbols that come from regular object files, but | |
1842 | ignore them if they come from shared libraries. This can be useful | |
1843 | when creating a dynamic binary and it is known that all the shared | |
1844 | libraries that it should be referencing are included on the linker's | |
1845 | command line. | |
1846 | @end table | |
1847 | ||
1848 | The behaviour for shared libraries on their own can also be controlled | |
1849 | by the @option{--[no-]allow-shlib-undefined} option. | |
1850 | ||
1851 | Normally the linker will generate an error message for each reported | |
1852 | unresolved symbol but the option @option{--warn-unresolved-symbols} | |
1853 | can change this to a warning. | |
1854 | ||
252b5132 RH |
1855 | @kindex --verbose |
1856 | @cindex verbose | |
1857 | @item --dll-verbose | |
308b1ffd | 1858 | @itemx --verbose |
ff5dcc92 | 1859 | Display the version number for @command{ld} and list the linker emulations |
252b5132 | 1860 | supported. Display which input files can and cannot be opened. Display |
b9a8de1e | 1861 | the linker script being used by the linker. |
252b5132 RH |
1862 | |
1863 | @kindex --version-script=@var{version-scriptfile} | |
1864 | @cindex version script, symbol versions | |
2509a395 | 1865 | @item --version-script=@var{version-scriptfile} |
252b5132 RH |
1866 | Specify the name of a version script to the linker. This is typically |
1867 | used when creating shared libraries to specify additional information | |
36f63dca | 1868 | about the version hierarchy for the library being created. This option |
09e2aba4 DK |
1869 | is only fully supported on ELF platforms which support shared libraries; |
1870 | see @ref{VERSION}. It is partially supported on PE platforms, which can | |
1871 | use version scripts to filter symbol visibility in auto-export mode: any | |
1872 | symbols marked @samp{local} in the version script will not be exported. | |
1873 | @xref{WIN32}. | |
252b5132 | 1874 | |
7ce691ae | 1875 | @kindex --warn-common |
252b5132 RH |
1876 | @cindex warnings, on combining symbols |
1877 | @cindex combining symbols, warnings on | |
1878 | @item --warn-common | |
1879 | Warn when a common symbol is combined with another common symbol or with | |
560e09e9 | 1880 | a symbol definition. Unix linkers allow this somewhat sloppy practise, |
252b5132 RH |
1881 | but linkers on some other operating systems do not. This option allows |
1882 | you to find potential problems from combining global symbols. | |
560e09e9 | 1883 | Unfortunately, some C libraries use this practise, so you may get some |
252b5132 RH |
1884 | warnings about symbols in the libraries as well as in your programs. |
1885 | ||
1886 | There are three kinds of global symbols, illustrated here by C examples: | |
1887 | ||
1888 | @table @samp | |
1889 | @item int i = 1; | |
1890 | A definition, which goes in the initialized data section of the output | |
1891 | file. | |
1892 | ||
1893 | @item extern int i; | |
1894 | An undefined reference, which does not allocate space. | |
1895 | There must be either a definition or a common symbol for the | |
1896 | variable somewhere. | |
1897 | ||
1898 | @item int i; | |
1899 | A common symbol. If there are only (one or more) common symbols for a | |
1900 | variable, it goes in the uninitialized data area of the output file. | |
1901 | The linker merges multiple common symbols for the same variable into a | |
1902 | single symbol. If they are of different sizes, it picks the largest | |
1903 | size. The linker turns a common symbol into a declaration, if there is | |
1904 | a definition of the same variable. | |
1905 | @end table | |
1906 | ||
1907 | The @samp{--warn-common} option can produce five kinds of warnings. | |
1908 | Each warning consists of a pair of lines: the first describes the symbol | |
1909 | just encountered, and the second describes the previous symbol | |
1910 | encountered with the same name. One or both of the two symbols will be | |
1911 | a common symbol. | |
1912 | ||
1913 | @enumerate | |
1914 | @item | |
1915 | Turning a common symbol into a reference, because there is already a | |
1916 | definition for the symbol. | |
1917 | @smallexample | |
1918 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1919 | overridden by definition | |
1920 | @var{file}(@var{section}): warning: defined here | |
1921 | @end smallexample | |
1922 | ||
1923 | @item | |
1924 | Turning a common symbol into a reference, because a later definition for | |
1925 | the symbol is encountered. This is the same as the previous case, | |
1926 | except that the symbols are encountered in a different order. | |
1927 | @smallexample | |
1928 | @var{file}(@var{section}): warning: definition of `@var{symbol}' | |
1929 | overriding common | |
1930 | @var{file}(@var{section}): warning: common is here | |
1931 | @end smallexample | |
1932 | ||
1933 | @item | |
1934 | Merging a common symbol with a previous same-sized common symbol. | |
1935 | @smallexample | |
1936 | @var{file}(@var{section}): warning: multiple common | |
1937 | of `@var{symbol}' | |
1938 | @var{file}(@var{section}): warning: previous common is here | |
1939 | @end smallexample | |
1940 | ||
1941 | @item | |
1942 | Merging a common symbol with a previous larger common symbol. | |
1943 | @smallexample | |
1944 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1945 | overridden by larger common | |
1946 | @var{file}(@var{section}): warning: larger common is here | |
1947 | @end smallexample | |
1948 | ||
1949 | @item | |
1950 | Merging a common symbol with a previous smaller common symbol. This is | |
1951 | the same as the previous case, except that the symbols are | |
1952 | encountered in a different order. | |
1953 | @smallexample | |
1954 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
1955 | overriding smaller common | |
1956 | @var{file}(@var{section}): warning: smaller common is here | |
1957 | @end smallexample | |
1958 | @end enumerate | |
1959 | ||
1960 | @kindex --warn-constructors | |
1961 | @item --warn-constructors | |
1962 | Warn if any global constructors are used. This is only useful for a few | |
1963 | object file formats. For formats like COFF or ELF, the linker can not | |
1964 | detect the use of global constructors. | |
1965 | ||
1966 | @kindex --warn-multiple-gp | |
1967 | @item --warn-multiple-gp | |
1968 | Warn if multiple global pointer values are required in the output file. | |
1969 | This is only meaningful for certain processors, such as the Alpha. | |
1970 | Specifically, some processors put large-valued constants in a special | |
1971 | section. A special register (the global pointer) points into the middle | |
1972 | of this section, so that constants can be loaded efficiently via a | |
1973 | base-register relative addressing mode. Since the offset in | |
1974 | base-register relative mode is fixed and relatively small (e.g., 16 | |
1975 | bits), this limits the maximum size of the constant pool. Thus, in | |
1976 | large programs, it is often necessary to use multiple global pointer | |
1977 | values in order to be able to address all possible constants. This | |
1978 | option causes a warning to be issued whenever this case occurs. | |
1979 | ||
1980 | @kindex --warn-once | |
1981 | @cindex warnings, on undefined symbols | |
1982 | @cindex undefined symbols, warnings on | |
1983 | @item --warn-once | |
1984 | Only warn once for each undefined symbol, rather than once per module | |
1985 | which refers to it. | |
1986 | ||
1987 | @kindex --warn-section-align | |
1988 | @cindex warnings, on section alignment | |
1989 | @cindex section alignment, warnings on | |
1990 | @item --warn-section-align | |
1991 | Warn if the address of an output section is changed because of | |
1992 | alignment. Typically, the alignment will be set by an input section. | |
1993 | The address will only be changed if it not explicitly specified; that | |
1994 | is, if the @code{SECTIONS} command does not specify a start address for | |
1995 | the section (@pxref{SECTIONS}). | |
1996 | ||
8fdd7217 NC |
1997 | @kindex --warn-shared-textrel |
1998 | @item --warn-shared-textrel | |
ece2d90e | 1999 | Warn if the linker adds a DT_TEXTREL to a shared object. |
8fdd7217 | 2000 | |
a0c402a5 L |
2001 | @kindex --warn-alternate-em |
2002 | @item --warn-alternate-em | |
2003 | Warn if an object has alternate ELF machine code. | |
2004 | ||
560e09e9 NC |
2005 | @kindex --warn-unresolved-symbols |
2006 | @item --warn-unresolved-symbols | |
2007 | If the linker is going to report an unresolved symbol (see the option | |
2008 | @option{--unresolved-symbols}) it will normally generate an error. | |
2009 | This option makes it generate a warning instead. | |
2010 | ||
2011 | @kindex --error-unresolved-symbols | |
2012 | @item --error-unresolved-symbols | |
2013 | This restores the linker's default behaviour of generating errors when | |
2014 | it is reporting unresolved symbols. | |
2015 | ||
252b5132 RH |
2016 | @kindex --whole-archive |
2017 | @cindex including an entire archive | |
2018 | @item --whole-archive | |
2019 | For each archive mentioned on the command line after the | |
ff5dcc92 | 2020 | @option{--whole-archive} option, include every object file in the archive |
252b5132 RH |
2021 | in the link, rather than searching the archive for the required object |
2022 | files. This is normally used to turn an archive file into a shared | |
2023 | library, forcing every object to be included in the resulting shared | |
2024 | library. This option may be used more than once. | |
2025 | ||
7ec229ce | 2026 | Two notes when using this option from gcc: First, gcc doesn't know |
ff5dcc92 SC |
2027 | about this option, so you have to use @option{-Wl,-whole-archive}. |
2028 | Second, don't forget to use @option{-Wl,-no-whole-archive} after your | |
7ec229ce DD |
2029 | list of archives, because gcc will add its own list of archives to |
2030 | your link and you may not want this flag to affect those as well. | |
2031 | ||
2509a395 SL |
2032 | @kindex --wrap=@var{symbol} |
2033 | @item --wrap=@var{symbol} | |
252b5132 RH |
2034 | Use a wrapper function for @var{symbol}. Any undefined reference to |
2035 | @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any | |
2036 | undefined reference to @code{__real_@var{symbol}} will be resolved to | |
2037 | @var{symbol}. | |
2038 | ||
2039 | This can be used to provide a wrapper for a system function. The | |
2040 | wrapper function should be called @code{__wrap_@var{symbol}}. If it | |
2041 | wishes to call the system function, it should call | |
2042 | @code{__real_@var{symbol}}. | |
2043 | ||
2044 | Here is a trivial example: | |
2045 | ||
2046 | @smallexample | |
2047 | void * | |
cc2f008e | 2048 | __wrap_malloc (size_t c) |
252b5132 | 2049 | @{ |
cc2f008e | 2050 | printf ("malloc called with %zu\n", c); |
252b5132 RH |
2051 | return __real_malloc (c); |
2052 | @} | |
2053 | @end smallexample | |
2054 | ||
ff5dcc92 | 2055 | If you link other code with this file using @option{--wrap malloc}, then |
252b5132 RH |
2056 | all calls to @code{malloc} will call the function @code{__wrap_malloc} |
2057 | instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will | |
2058 | call the real @code{malloc} function. | |
2059 | ||
2060 | You may wish to provide a @code{__real_malloc} function as well, so that | |
ff5dcc92 | 2061 | links without the @option{--wrap} option will succeed. If you do this, |
252b5132 RH |
2062 | you should not put the definition of @code{__real_malloc} in the same |
2063 | file as @code{__wrap_malloc}; if you do, the assembler may resolve the | |
2064 | call before the linker has a chance to wrap it to @code{malloc}. | |
2065 | ||
6aa29e7b JJ |
2066 | @kindex --eh-frame-hdr |
2067 | @item --eh-frame-hdr | |
2068 | Request creation of @code{.eh_frame_hdr} section and ELF | |
2069 | @code{PT_GNU_EH_FRAME} segment header. | |
2070 | ||
6c1439be L |
2071 | @kindex --enable-new-dtags |
2072 | @kindex --disable-new-dtags | |
2073 | @item --enable-new-dtags | |
2074 | @itemx --disable-new-dtags | |
2075 | This linker can create the new dynamic tags in ELF. But the older ELF | |
2076 | systems may not understand them. If you specify | |
ff5dcc92 SC |
2077 | @option{--enable-new-dtags}, the dynamic tags will be created as needed. |
2078 | If you specify @option{--disable-new-dtags}, no new dynamic tags will be | |
6c1439be L |
2079 | created. By default, the new dynamic tags are not created. Note that |
2080 | those options are only available for ELF systems. | |
2081 | ||
2d643429 | 2082 | @kindex --hash-size=@var{number} |
e185dd51 | 2083 | @item --hash-size=@var{number} |
2d643429 NC |
2084 | Set the default size of the linker's hash tables to a prime number |
2085 | close to @var{number}. Increasing this value can reduce the length of | |
2086 | time it takes the linker to perform its tasks, at the expense of | |
2087 | increasing the linker's memory requirements. Similarly reducing this | |
2088 | value can reduce the memory requirements at the expense of speed. | |
2089 | ||
fdc90cb4 JJ |
2090 | @kindex --hash-style=@var{style} |
2091 | @item --hash-style=@var{style} | |
2092 | Set the type of linker's hash table(s). @var{style} can be either | |
2093 | @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for | |
2094 | new style GNU @code{.gnu.hash} section or @code{both} for both | |
2095 | the classic ELF @code{.hash} and new style GNU @code{.gnu.hash} | |
2096 | hash tables. The default is @code{sysv}. | |
2097 | ||
35835446 JR |
2098 | @kindex --reduce-memory-overheads |
2099 | @item --reduce-memory-overheads | |
2100 | This option reduces memory requirements at ld runtime, at the expense of | |
f2a8f148 | 2101 | linking speed. This was introduced to select the old O(n^2) algorithm |
35835446 | 2102 | for link map file generation, rather than the new O(n) algorithm which uses |
2d643429 NC |
2103 | about 40% more memory for symbol storage. |
2104 | ||
4f9c04f7 | 2105 | Another effect of the switch is to set the default hash table size to |
2d643429 | 2106 | 1021, which again saves memory at the cost of lengthening the linker's |
a85785bc | 2107 | run time. This is not done however if the @option{--hash-size} switch |
2d643429 NC |
2108 | has been used. |
2109 | ||
2110 | The @option{--reduce-memory-overheads} switch may be also be used to | |
2111 | enable other tradeoffs in future versions of the linker. | |
35835446 | 2112 | |
c0065db7 RM |
2113 | @kindex --build-id |
2114 | @kindex --build-id=@var{style} | |
2115 | @item --build-id | |
2116 | @itemx --build-id=@var{style} | |
2117 | Request creation of @code{.note.gnu.build-id} ELF note section. | |
2118 | The contents of the note are unique bits identifying this linked | |
2119 | file. @var{style} can be @code{uuid} to use 128 random bits, | |
24382dca RM |
2120 | @code{sha1} to use a 160-bit @sc{SHA1} hash on the normative |
2121 | parts of the output contents, @code{md5} to use a 128-bit | |
2122 | @sc{MD5} hash on the normative parts of the output contents, or | |
2123 | @code{0x@var{hexstring}} to use a chosen bit string specified as | |
2124 | an even number of hexadecimal digits (@code{-} and @code{:} | |
2125 | characters between digit pairs are ignored). If @var{style} is | |
2126 | omitted, @code{sha1} is used. | |
2127 | ||
2128 | The @code{md5} and @code{sha1} styles produces an identifier | |
2129 | that is always the same in an identical output file, but will be | |
2130 | unique among all nonidentical output files. It is not intended | |
2131 | to be compared as a checksum for the file's contents. A linked | |
2132 | file may be changed later by other tools, but the build ID bit | |
2133 | string identifying the original linked file does not change. | |
c0065db7 RM |
2134 | |
2135 | Passing @code{none} for @var{style} disables the setting from any | |
2136 | @code{--build-id} options earlier on the command line. | |
252b5132 RH |
2137 | @end table |
2138 | ||
0285c67d NC |
2139 | @c man end |
2140 | ||
36f63dca | 2141 | @subsection Options Specific to i386 PE Targets |
252b5132 | 2142 | |
0285c67d NC |
2143 | @c man begin OPTIONS |
2144 | ||
ff5dcc92 | 2145 | The i386 PE linker supports the @option{-shared} option, which causes |
252b5132 RH |
2146 | the output to be a dynamically linked library (DLL) instead of a |
2147 | normal executable. You should name the output @code{*.dll} when you | |
2148 | use this option. In addition, the linker fully supports the standard | |
2149 | @code{*.def} files, which may be specified on the linker command line | |
2150 | like an object file (in fact, it should precede archives it exports | |
2151 | symbols from, to ensure that they get linked in, just like a normal | |
2152 | object file). | |
2153 | ||
2154 | In addition to the options common to all targets, the i386 PE linker | |
2155 | support additional command line options that are specific to the i386 | |
2156 | PE target. Options that take values may be separated from their | |
2157 | values by either a space or an equals sign. | |
2158 | ||
ff5dcc92 | 2159 | @table @gcctabopt |
252b5132 RH |
2160 | |
2161 | @kindex --add-stdcall-alias | |
2162 | @item --add-stdcall-alias | |
2163 | If given, symbols with a stdcall suffix (@@@var{nn}) will be exported | |
2164 | as-is and also with the suffix stripped. | |
bb10df36 | 2165 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2166 | |
2167 | @kindex --base-file | |
2168 | @item --base-file @var{file} | |
2169 | Use @var{file} as the name of a file in which to save the base | |
2170 | addresses of all the relocations needed for generating DLLs with | |
2171 | @file{dlltool}. | |
bb10df36 | 2172 | [This is an i386 PE specific option] |
252b5132 RH |
2173 | |
2174 | @kindex --dll | |
2175 | @item --dll | |
2176 | Create a DLL instead of a regular executable. You may also use | |
ff5dcc92 | 2177 | @option{-shared} or specify a @code{LIBRARY} in a given @code{.def} |
252b5132 | 2178 | file. |
bb10df36 | 2179 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2180 | |
88183869 DK |
2181 | @kindex --enable-long-section-names |
2182 | @kindex --disable-long-section-names | |
2183 | @item --enable-long-section-names | |
2184 | @itemx --disable-long-section-names | |
2185 | The PE variants of the Coff object format add an extension that permits | |
2186 | the use of section names longer than eight characters, the normal limit | |
2187 | for Coff. By default, these names are only allowed in object files, as | |
2188 | fully-linked executable images do not carry the Coff string table required | |
2189 | to support the longer names. As a GNU extension, it is possible to | |
2190 | allow their use in executable images as well, or to (probably pointlessly!) | |
2191 | disallow it in object files, by using these two options. Executable images | |
2192 | generated with these long section names are slightly non-standard, carrying | |
2193 | as they do a string table, and may generate confusing output when examined | |
3efd345c DK |
2194 | with non-GNU PE-aware tools, such as file viewers and dumpers. However, |
2195 | GDB relies on the use of PE long section names to find Dwarf-2 debug | |
2196 | information sections in an executable image at runtime, and so if neither | |
2197 | option is specified on the command-line, @command{ld} will enable long | |
2198 | section names, overriding the default and technically correct behaviour, | |
2199 | when it finds the presence of debug information while linking an executable | |
2200 | image and not stripping symbols. | |
88183869 DK |
2201 | [This option is valid for all PE targeted ports of the linker] |
2202 | ||
252b5132 RH |
2203 | @kindex --enable-stdcall-fixup |
2204 | @kindex --disable-stdcall-fixup | |
2205 | @item --enable-stdcall-fixup | |
2206 | @itemx --disable-stdcall-fixup | |
2207 | If the link finds a symbol that it cannot resolve, it will attempt to | |
36f63dca | 2208 | do ``fuzzy linking'' by looking for another defined symbol that differs |
252b5132 RH |
2209 | only in the format of the symbol name (cdecl vs stdcall) and will |
2210 | resolve that symbol by linking to the match. For example, the | |
2211 | undefined symbol @code{_foo} might be linked to the function | |
2212 | @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked | |
2213 | to the function @code{_bar}. When the linker does this, it prints a | |
2214 | warning, since it normally should have failed to link, but sometimes | |
2215 | import libraries generated from third-party dlls may need this feature | |
ff5dcc92 | 2216 | to be usable. If you specify @option{--enable-stdcall-fixup}, this |
252b5132 | 2217 | feature is fully enabled and warnings are not printed. If you specify |
ff5dcc92 | 2218 | @option{--disable-stdcall-fixup}, this feature is disabled and such |
252b5132 | 2219 | mismatches are considered to be errors. |
bb10df36 | 2220 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2221 | |
522f09cd KT |
2222 | @kindex --leading-underscore |
2223 | @kindex --no-leading-underscore | |
2224 | @item --leading-underscore | |
2225 | @itemx --no-leading-underscore | |
2226 | For most targets default symbol-prefix is an underscore and is defined | |
2227 | in target's description. By this option it is possible to | |
2228 | disable/enable the default underscore symbol-prefix. | |
2229 | ||
252b5132 RH |
2230 | @cindex DLLs, creating |
2231 | @kindex --export-all-symbols | |
2232 | @item --export-all-symbols | |
2233 | If given, all global symbols in the objects used to build a DLL will | |
2234 | be exported by the DLL. Note that this is the default if there | |
2235 | otherwise wouldn't be any exported symbols. When symbols are | |
2236 | explicitly exported via DEF files or implicitly exported via function | |
2237 | attributes, the default is to not export anything else unless this | |
2238 | option is given. Note that the symbols @code{DllMain@@12}, | |
ece2d90e | 2239 | @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and |
b044cda1 | 2240 | @code{impure_ptr} will not be automatically |
ece2d90e NC |
2241 | exported. Also, symbols imported from other DLLs will not be |
2242 | re-exported, nor will symbols specifying the DLL's internal layout | |
2243 | such as those beginning with @code{_head_} or ending with | |
2244 | @code{_iname}. In addition, no symbols from @code{libgcc}, | |
b044cda1 CW |
2245 | @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported. |
2246 | Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will | |
2247 | not be exported, to help with C++ DLLs. Finally, there is an | |
ece2d90e | 2248 | extensive list of cygwin-private symbols that are not exported |
b044cda1 | 2249 | (obviously, this applies on when building DLLs for cygwin targets). |
ece2d90e | 2250 | These cygwin-excludes are: @code{_cygwin_dll_entry@@12}, |
b044cda1 | 2251 | @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12}, |
ece2d90e | 2252 | @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll}, |
b044cda1 | 2253 | @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2}, |
ece2d90e | 2254 | @code{cygwin_premain3}, and @code{environ}. |
bb10df36 | 2255 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2256 | |
2257 | @kindex --exclude-symbols | |
1d0a3c9c | 2258 | @item --exclude-symbols @var{symbol},@var{symbol},... |
252b5132 RH |
2259 | Specifies a list of symbols which should not be automatically |
2260 | exported. The symbol names may be delimited by commas or colons. | |
bb10df36 | 2261 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2262 | |
2927aaca NC |
2263 | @kindex --exclude-all-symbols |
2264 | @item --exclude-all-symbols | |
2265 | Specifies no symbols should be automatically exported. | |
2266 | [This option is specific to the i386 PE targeted port of the linker] | |
2267 | ||
252b5132 RH |
2268 | @kindex --file-alignment |
2269 | @item --file-alignment | |
2270 | Specify the file alignment. Sections in the file will always begin at | |
2271 | file offsets which are multiples of this number. This defaults to | |
2272 | 512. | |
bb10df36 | 2273 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2274 | |
2275 | @cindex heap size | |
2276 | @kindex --heap | |
2277 | @item --heap @var{reserve} | |
2278 | @itemx --heap @var{reserve},@var{commit} | |
a00b50c5 DS |
2279 | Specify the number of bytes of memory to reserve (and optionally commit) |
2280 | to be used as heap for this program. The default is 1Mb reserved, 4K | |
252b5132 | 2281 | committed. |
bb10df36 | 2282 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2283 | |
2284 | @cindex image base | |
2285 | @kindex --image-base | |
2286 | @item --image-base @var{value} | |
2287 | Use @var{value} as the base address of your program or dll. This is | |
2288 | the lowest memory location that will be used when your program or dll | |
2289 | is loaded. To reduce the need to relocate and improve performance of | |
2290 | your dlls, each should have a unique base address and not overlap any | |
2291 | other dlls. The default is 0x400000 for executables, and 0x10000000 | |
2292 | for dlls. | |
bb10df36 | 2293 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2294 | |
2295 | @kindex --kill-at | |
2296 | @item --kill-at | |
2297 | If given, the stdcall suffixes (@@@var{nn}) will be stripped from | |
2298 | symbols before they are exported. | |
bb10df36 | 2299 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2300 | |
26d2d8a2 BF |
2301 | @kindex --large-address-aware |
2302 | @item --large-address-aware | |
b45619c0 | 2303 | If given, the appropriate bit in the ``Characteristics'' field of the COFF |
26d2d8a2 | 2304 | header is set to indicate that this executable supports virtual addresses |
b45619c0 | 2305 | greater than 2 gigabytes. This should be used in conjunction with the /3GB |
26d2d8a2 BF |
2306 | or /USERVA=@var{value} megabytes switch in the ``[operating systems]'' |
2307 | section of the BOOT.INI. Otherwise, this bit has no effect. | |
2308 | [This option is specific to PE targeted ports of the linker] | |
2309 | ||
252b5132 RH |
2310 | @kindex --major-image-version |
2311 | @item --major-image-version @var{value} | |
36f63dca | 2312 | Sets the major number of the ``image version''. Defaults to 1. |
bb10df36 | 2313 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2314 | |
2315 | @kindex --major-os-version | |
2316 | @item --major-os-version @var{value} | |
36f63dca | 2317 | Sets the major number of the ``os version''. Defaults to 4. |
bb10df36 | 2318 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2319 | |
2320 | @kindex --major-subsystem-version | |
2321 | @item --major-subsystem-version @var{value} | |
36f63dca | 2322 | Sets the major number of the ``subsystem version''. Defaults to 4. |
bb10df36 | 2323 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2324 | |
2325 | @kindex --minor-image-version | |
2326 | @item --minor-image-version @var{value} | |
36f63dca | 2327 | Sets the minor number of the ``image version''. Defaults to 0. |
bb10df36 | 2328 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2329 | |
2330 | @kindex --minor-os-version | |
2331 | @item --minor-os-version @var{value} | |
36f63dca | 2332 | Sets the minor number of the ``os version''. Defaults to 0. |
bb10df36 | 2333 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2334 | |
2335 | @kindex --minor-subsystem-version | |
2336 | @item --minor-subsystem-version @var{value} | |
36f63dca | 2337 | Sets the minor number of the ``subsystem version''. Defaults to 0. |
bb10df36 | 2338 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2339 | |
2340 | @cindex DEF files, creating | |
2341 | @cindex DLLs, creating | |
2342 | @kindex --output-def | |
2343 | @item --output-def @var{file} | |
2344 | The linker will create the file @var{file} which will contain a DEF | |
2345 | file corresponding to the DLL the linker is generating. This DEF file | |
2346 | (which should be called @code{*.def}) may be used to create an import | |
2347 | library with @code{dlltool} or may be used as a reference to | |
2348 | automatically or implicitly exported symbols. | |
bb10df36 | 2349 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2350 | |
b044cda1 CW |
2351 | @cindex DLLs, creating |
2352 | @kindex --out-implib | |
2353 | @item --out-implib @var{file} | |
2354 | The linker will create the file @var{file} which will contain an | |
2355 | import lib corresponding to the DLL the linker is generating. This | |
2356 | import lib (which should be called @code{*.dll.a} or @code{*.a} | |
560e09e9 | 2357 | may be used to link clients against the generated DLL; this behaviour |
b044cda1 CW |
2358 | makes it possible to skip a separate @code{dlltool} import library |
2359 | creation step. | |
bb10df36 | 2360 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2361 | |
2362 | @kindex --enable-auto-image-base | |
2363 | @item --enable-auto-image-base | |
2364 | Automatically choose the image base for DLLs, unless one is specified | |
2365 | using the @code{--image-base} argument. By using a hash generated | |
2366 | from the dllname to create unique image bases for each DLL, in-memory | |
2367 | collisions and relocations which can delay program execution are | |
2368 | avoided. | |
bb10df36 | 2369 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2370 | |
2371 | @kindex --disable-auto-image-base | |
2372 | @item --disable-auto-image-base | |
2373 | Do not automatically generate a unique image base. If there is no | |
2374 | user-specified image base (@code{--image-base}) then use the platform | |
2375 | default. | |
bb10df36 | 2376 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2377 | |
2378 | @cindex DLLs, linking to | |
2379 | @kindex --dll-search-prefix | |
2380 | @item --dll-search-prefix @var{string} | |
489d0400 | 2381 | When linking dynamically to a dll without an import library, |
ece2d90e | 2382 | search for @code{<string><basename>.dll} in preference to |
560e09e9 | 2383 | @code{lib<basename>.dll}. This behaviour allows easy distinction |
b044cda1 CW |
2384 | between DLLs built for the various "subplatforms": native, cygwin, |
2385 | uwin, pw, etc. For instance, cygwin DLLs typically use | |
ece2d90e | 2386 | @code{--dll-search-prefix=cyg}. |
bb10df36 | 2387 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2388 | |
2389 | @kindex --enable-auto-import | |
2390 | @item --enable-auto-import | |
ece2d90e NC |
2391 | Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for |
2392 | DATA imports from DLLs, and create the necessary thunking symbols when | |
4d8907ac DS |
2393 | building the import libraries with those DATA exports. Note: Use of the |
2394 | 'auto-import' extension will cause the text section of the image file | |
2395 | to be made writable. This does not conform to the PE-COFF format | |
2396 | specification published by Microsoft. | |
2397 | ||
e2a83dd0 NC |
2398 | Note - use of the 'auto-import' extension will also cause read only |
2399 | data which would normally be placed into the .rdata section to be | |
2400 | placed into the .data section instead. This is in order to work | |
2401 | around a problem with consts that is described here: | |
2402 | http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html | |
2403 | ||
4d8907ac DS |
2404 | Using 'auto-import' generally will 'just work' -- but sometimes you may |
2405 | see this message: | |
0d888aac | 2406 | |
ece2d90e | 2407 | "variable '<var>' can't be auto-imported. Please read the |
0d888aac CW |
2408 | documentation for ld's @code{--enable-auto-import} for details." |
2409 | ||
ece2d90e NC |
2410 | This message occurs when some (sub)expression accesses an address |
2411 | ultimately given by the sum of two constants (Win32 import tables only | |
c0065db7 RM |
2412 | allow one). Instances where this may occur include accesses to member |
2413 | fields of struct variables imported from a DLL, as well as using a | |
2414 | constant index into an array variable imported from a DLL. Any | |
2f8d8971 NC |
2415 | multiword variable (arrays, structs, long long, etc) may trigger |
2416 | this error condition. However, regardless of the exact data type | |
2417 | of the offending exported variable, ld will always detect it, issue | |
2418 | the warning, and exit. | |
2419 | ||
2420 | There are several ways to address this difficulty, regardless of the | |
2421 | data type of the exported variable: | |
0d888aac | 2422 | |
2fa9fc65 NC |
2423 | One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task |
2424 | of adjusting references in your client code for runtime environment, so | |
560e09e9 | 2425 | this method works only when runtime environment supports this feature. |
2fa9fc65 | 2426 | |
c0065db7 RM |
2427 | A second solution is to force one of the 'constants' to be a variable -- |
2428 | that is, unknown and un-optimizable at compile time. For arrays, | |
2429 | there are two possibilities: a) make the indexee (the array's address) | |
0d888aac CW |
2430 | a variable, or b) make the 'constant' index a variable. Thus: |
2431 | ||
2432 | @example | |
2433 | extern type extern_array[]; | |
c0065db7 | 2434 | extern_array[1] --> |
0d888aac CW |
2435 | @{ volatile type *t=extern_array; t[1] @} |
2436 | @end example | |
2437 | ||
2438 | or | |
2439 | ||
2440 | @example | |
2441 | extern type extern_array[]; | |
c0065db7 | 2442 | extern_array[1] --> |
0d888aac CW |
2443 | @{ volatile int t=1; extern_array[t] @} |
2444 | @end example | |
2445 | ||
c0065db7 | 2446 | For structs (and most other multiword data types) the only option |
2f8d8971 | 2447 | is to make the struct itself (or the long long, or the ...) variable: |
0d888aac CW |
2448 | |
2449 | @example | |
2450 | extern struct s extern_struct; | |
c0065db7 | 2451 | extern_struct.field --> |
0d888aac CW |
2452 | @{ volatile struct s *t=&extern_struct; t->field @} |
2453 | @end example | |
2454 | ||
c406afaf NC |
2455 | or |
2456 | ||
2457 | @example | |
2458 | extern long long extern_ll; | |
2459 | extern_ll --> | |
2460 | @{ volatile long long * local_ll=&extern_ll; *local_ll @} | |
2461 | @end example | |
2462 | ||
2fa9fc65 | 2463 | A third method of dealing with this difficulty is to abandon |
c0065db7 | 2464 | 'auto-import' for the offending symbol and mark it with |
560e09e9 | 2465 | @code{__declspec(dllimport)}. However, in practise that |
0d888aac | 2466 | requires using compile-time #defines to indicate whether you are |
c0065db7 RM |
2467 | building a DLL, building client code that will link to the DLL, or |
2468 | merely building/linking to a static library. In making the choice | |
2469 | between the various methods of resolving the 'direct address with | |
0d888aac CW |
2470 | constant offset' problem, you should consider typical real-world usage: |
2471 | ||
2472 | Original: | |
2473 | @example | |
2474 | --foo.h | |
2475 | extern int arr[]; | |
2476 | --foo.c | |
2477 | #include "foo.h" | |
2478 | void main(int argc, char **argv)@{ | |
2479 | printf("%d\n",arr[1]); | |
2480 | @} | |
2481 | @end example | |
2482 | ||
2483 | Solution 1: | |
2484 | @example | |
2485 | --foo.h | |
2486 | extern int arr[]; | |
2487 | --foo.c | |
2488 | #include "foo.h" | |
2489 | void main(int argc, char **argv)@{ | |
2490 | /* This workaround is for win32 and cygwin; do not "optimize" */ | |
2491 | volatile int *parr = arr; | |
2492 | printf("%d\n",parr[1]); | |
2493 | @} | |
2494 | @end example | |
2495 | ||
2496 | Solution 2: | |
2497 | @example | |
2498 | --foo.h | |
2499 | /* Note: auto-export is assumed (no __declspec(dllexport)) */ | |
2500 | #if (defined(_WIN32) || defined(__CYGWIN__)) && \ | |
2501 | !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC)) | |
2502 | #define FOO_IMPORT __declspec(dllimport) | |
2503 | #else | |
2504 | #define FOO_IMPORT | |
2505 | #endif | |
2506 | extern FOO_IMPORT int arr[]; | |
2507 | --foo.c | |
2508 | #include "foo.h" | |
2509 | void main(int argc, char **argv)@{ | |
2510 | printf("%d\n",arr[1]); | |
2511 | @} | |
2512 | @end example | |
2513 | ||
c0065db7 | 2514 | A fourth way to avoid this problem is to re-code your |
0d888aac CW |
2515 | library to use a functional interface rather than a data interface |
2516 | for the offending variables (e.g. set_foo() and get_foo() accessor | |
2517 | functions). | |
bb10df36 | 2518 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2519 | |
2520 | @kindex --disable-auto-import | |
2521 | @item --disable-auto-import | |
c0065db7 | 2522 | Do not attempt to do sophisticated linking of @code{_symbol} to |
b044cda1 | 2523 | @code{__imp__symbol} for DATA imports from DLLs. |
bb10df36 | 2524 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2525 | |
2fa9fc65 NC |
2526 | @kindex --enable-runtime-pseudo-reloc |
2527 | @item --enable-runtime-pseudo-reloc | |
2528 | If your code contains expressions described in --enable-auto-import section, | |
2529 | that is, DATA imports from DLL with non-zero offset, this switch will create | |
2530 | a vector of 'runtime pseudo relocations' which can be used by runtime | |
c0065db7 | 2531 | environment to adjust references to such data in your client code. |
bb10df36 | 2532 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 NC |
2533 | |
2534 | @kindex --disable-runtime-pseudo-reloc | |
2535 | @item --disable-runtime-pseudo-reloc | |
2536 | Do not create pseudo relocations for non-zero offset DATA imports from | |
2537 | DLLs. This is the default. | |
bb10df36 | 2538 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 | 2539 | |
b044cda1 CW |
2540 | @kindex --enable-extra-pe-debug |
2541 | @item --enable-extra-pe-debug | |
2542 | Show additional debug info related to auto-import symbol thunking. | |
bb10df36 | 2543 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2544 | |
252b5132 RH |
2545 | @kindex --section-alignment |
2546 | @item --section-alignment | |
2547 | Sets the section alignment. Sections in memory will always begin at | |
2548 | addresses which are a multiple of this number. Defaults to 0x1000. | |
bb10df36 | 2549 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2550 | |
2551 | @cindex stack size | |
2552 | @kindex --stack | |
2553 | @item --stack @var{reserve} | |
2554 | @itemx --stack @var{reserve},@var{commit} | |
a00b50c5 DS |
2555 | Specify the number of bytes of memory to reserve (and optionally commit) |
2556 | to be used as stack for this program. The default is 2Mb reserved, 4K | |
252b5132 | 2557 | committed. |
bb10df36 | 2558 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2559 | |
2560 | @kindex --subsystem | |
2561 | @item --subsystem @var{which} | |
2562 | @itemx --subsystem @var{which}:@var{major} | |
2563 | @itemx --subsystem @var{which}:@var{major}.@var{minor} | |
2564 | Specifies the subsystem under which your program will execute. The | |
2565 | legal values for @var{which} are @code{native}, @code{windows}, | |
33f362e1 NC |
2566 | @code{console}, @code{posix}, and @code{xbox}. You may optionally set |
2567 | the subsystem version also. Numeric values are also accepted for | |
2568 | @var{which}. | |
bb10df36 | 2569 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2570 | |
2f563b51 DK |
2571 | The following options set flags in the @code{DllCharacteristics} field |
2572 | of the PE file header: | |
2573 | [These options are specific to PE targeted ports of the linker] | |
2574 | ||
2575 | @kindex --dynamicbase | |
2576 | @item --dynamicbase | |
2577 | The image base address may be relocated using address space layout | |
2578 | randomization (ASLR). This feature was introduced with MS Windows | |
2579 | Vista for i386 PE targets. | |
2580 | ||
2581 | @kindex --forceinteg | |
2582 | @item --forceinteg | |
2583 | Code integrity checks are enforced. | |
2584 | ||
2585 | @kindex --nxcompat | |
2586 | @item --nxcompat | |
2587 | The image is compatible with the Data Execution Prevention. | |
2588 | This feature was introduced with MS Windows XP SP2 for i386 PE targets. | |
2589 | ||
2590 | @kindex --no-isolation | |
2591 | @item --no-isolation | |
2592 | Although the image understands isolation, do not isolate the image. | |
2593 | ||
2594 | @kindex --no-seh | |
2595 | @item --no-seh | |
2596 | The image does not use SEH. No SE handler may be called from | |
2597 | this image. | |
2598 | ||
2599 | @kindex --no-bind | |
2600 | @item --no-bind | |
2601 | Do not bind this image. | |
2602 | ||
2603 | @kindex --wdmdriver | |
2604 | @item --wdmdriver | |
2605 | The driver uses the MS Windows Driver Model. | |
2606 | ||
2607 | @kindex --tsaware | |
2608 | @item --tsaware | |
2609 | The image is Terminal Server aware. | |
2610 | ||
252b5132 RH |
2611 | @end table |
2612 | ||
0285c67d NC |
2613 | @c man end |
2614 | ||
93fd0973 SC |
2615 | @ifset M68HC11 |
2616 | @subsection Options specific to Motorola 68HC11 and 68HC12 targets | |
2617 | ||
2618 | @c man begin OPTIONS | |
2619 | ||
2620 | The 68HC11 and 68HC12 linkers support specific options to control the | |
2621 | memory bank switching mapping and trampoline code generation. | |
2622 | ||
2623 | @table @gcctabopt | |
2624 | ||
2625 | @kindex --no-trampoline | |
2626 | @item --no-trampoline | |
2627 | This option disables the generation of trampoline. By default a trampoline | |
2628 | is generated for each far function which is called using a @code{jsr} | |
2629 | instruction (this happens when a pointer to a far function is taken). | |
2630 | ||
2631 | @kindex --bank-window | |
2632 | @item --bank-window @var{name} | |
2633 | This option indicates to the linker the name of the memory region in | |
2634 | the @samp{MEMORY} specification that describes the memory bank window. | |
2635 | The definition of such region is then used by the linker to compute | |
2636 | paging and addresses within the memory window. | |
2637 | ||
2638 | @end table | |
2639 | ||
2640 | @c man end | |
2641 | @end ifset | |
2642 | ||
7fb9f789 NC |
2643 | @ifset M68K |
2644 | @subsection Options specific to Motorola 68K target | |
2645 | ||
2646 | @c man begin OPTIONS | |
2647 | ||
2648 | The following options are supported to control handling of GOT generation | |
2649 | when linking for 68K targets. | |
2650 | ||
2651 | @table @gcctabopt | |
2652 | ||
2653 | @kindex --got | |
2654 | @item --got=@var{type} | |
2655 | This option tells the linker which GOT generation scheme to use. | |
2656 | @var{type} should be one of @samp{single}, @samp{negative}, | |
2657 | @samp{multigot} or @samp{target}. For more information refer to the | |
2658 | Info entry for @file{ld}. | |
2659 | ||
2660 | @end table | |
2661 | ||
2662 | @c man end | |
2663 | @end ifset | |
2664 | ||
252b5132 RH |
2665 | @ifset UsesEnvVars |
2666 | @node Environment | |
2667 | @section Environment Variables | |
2668 | ||
0285c67d NC |
2669 | @c man begin ENVIRONMENT |
2670 | ||
560e09e9 | 2671 | You can change the behaviour of @command{ld} with the environment variables |
36f63dca NC |
2672 | @ifclear SingleFormat |
2673 | @code{GNUTARGET}, | |
2674 | @end ifclear | |
2675 | @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}. | |
252b5132 | 2676 | |
36f63dca | 2677 | @ifclear SingleFormat |
252b5132 RH |
2678 | @kindex GNUTARGET |
2679 | @cindex default input format | |
2680 | @code{GNUTARGET} determines the input-file object format if you don't | |
2681 | use @samp{-b} (or its synonym @samp{--format}). Its value should be one | |
2682 | of the BFD names for an input format (@pxref{BFD}). If there is no | |
ff5dcc92 | 2683 | @code{GNUTARGET} in the environment, @command{ld} uses the natural format |
252b5132 RH |
2684 | of the target. If @code{GNUTARGET} is set to @code{default} then BFD |
2685 | attempts to discover the input format by examining binary input files; | |
2686 | this method often succeeds, but there are potential ambiguities, since | |
2687 | there is no method of ensuring that the magic number used to specify | |
2688 | object-file formats is unique. However, the configuration procedure for | |
2689 | BFD on each system places the conventional format for that system first | |
2690 | in the search-list, so ambiguities are resolved in favor of convention. | |
36f63dca | 2691 | @end ifclear |
252b5132 RH |
2692 | |
2693 | @kindex LDEMULATION | |
2694 | @cindex default emulation | |
2695 | @cindex emulation, default | |
2696 | @code{LDEMULATION} determines the default emulation if you don't use the | |
2697 | @samp{-m} option. The emulation can affect various aspects of linker | |
2698 | behaviour, particularly the default linker script. You can list the | |
2699 | available emulations with the @samp{--verbose} or @samp{-V} options. If | |
2700 | the @samp{-m} option is not used, and the @code{LDEMULATION} environment | |
2701 | variable is not defined, the default emulation depends upon how the | |
2702 | linker was configured. | |
252b5132 RH |
2703 | |
2704 | @kindex COLLECT_NO_DEMANGLE | |
2705 | @cindex demangling, default | |
2706 | Normally, the linker will default to demangling symbols. However, if | |
2707 | @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will | |
2708 | default to not demangling symbols. This environment variable is used in | |
2709 | a similar fashion by the @code{gcc} linker wrapper program. The default | |
2710 | may be overridden by the @samp{--demangle} and @samp{--no-demangle} | |
2711 | options. | |
2712 | ||
0285c67d NC |
2713 | @c man end |
2714 | @end ifset | |
2715 | ||
252b5132 RH |
2716 | @node Scripts |
2717 | @chapter Linker Scripts | |
2718 | ||
2719 | @cindex scripts | |
2720 | @cindex linker scripts | |
2721 | @cindex command files | |
2722 | Every link is controlled by a @dfn{linker script}. This script is | |
2723 | written in the linker command language. | |
2724 | ||
2725 | The main purpose of the linker script is to describe how the sections in | |
2726 | the input files should be mapped into the output file, and to control | |
2727 | the memory layout of the output file. Most linker scripts do nothing | |
2728 | more than this. However, when necessary, the linker script can also | |
2729 | direct the linker to perform many other operations, using the commands | |
2730 | described below. | |
2731 | ||
2732 | The linker always uses a linker script. If you do not supply one | |
2733 | yourself, the linker will use a default script that is compiled into the | |
2734 | linker executable. You can use the @samp{--verbose} command line option | |
2735 | to display the default linker script. Certain command line options, | |
2736 | such as @samp{-r} or @samp{-N}, will affect the default linker script. | |
2737 | ||
2738 | You may supply your own linker script by using the @samp{-T} command | |
2739 | line option. When you do this, your linker script will replace the | |
2740 | default linker script. | |
2741 | ||
2742 | You may also use linker scripts implicitly by naming them as input files | |
2743 | to the linker, as though they were files to be linked. @xref{Implicit | |
2744 | Linker Scripts}. | |
2745 | ||
2746 | @menu | |
2747 | * Basic Script Concepts:: Basic Linker Script Concepts | |
2748 | * Script Format:: Linker Script Format | |
2749 | * Simple Example:: Simple Linker Script Example | |
2750 | * Simple Commands:: Simple Linker Script Commands | |
2751 | * Assignments:: Assigning Values to Symbols | |
2752 | * SECTIONS:: SECTIONS Command | |
2753 | * MEMORY:: MEMORY Command | |
2754 | * PHDRS:: PHDRS Command | |
2755 | * VERSION:: VERSION Command | |
2756 | * Expressions:: Expressions in Linker Scripts | |
2757 | * Implicit Linker Scripts:: Implicit Linker Scripts | |
2758 | @end menu | |
2759 | ||
2760 | @node Basic Script Concepts | |
2761 | @section Basic Linker Script Concepts | |
2762 | @cindex linker script concepts | |
2763 | We need to define some basic concepts and vocabulary in order to | |
2764 | describe the linker script language. | |
2765 | ||
2766 | The linker combines input files into a single output file. The output | |
2767 | file and each input file are in a special data format known as an | |
2768 | @dfn{object file format}. Each file is called an @dfn{object file}. | |
2769 | The output file is often called an @dfn{executable}, but for our | |
2770 | purposes we will also call it an object file. Each object file has, | |
2771 | among other things, a list of @dfn{sections}. We sometimes refer to a | |
2772 | section in an input file as an @dfn{input section}; similarly, a section | |
2773 | in the output file is an @dfn{output section}. | |
2774 | ||
2775 | Each section in an object file has a name and a size. Most sections | |
2776 | also have an associated block of data, known as the @dfn{section | |
2777 | contents}. A section may be marked as @dfn{loadable}, which mean that | |
2778 | the contents should be loaded into memory when the output file is run. | |
2779 | A section with no contents may be @dfn{allocatable}, which means that an | |
2780 | area in memory should be set aside, but nothing in particular should be | |
2781 | loaded there (in some cases this memory must be zeroed out). A section | |
2782 | which is neither loadable nor allocatable typically contains some sort | |
2783 | of debugging information. | |
2784 | ||
2785 | Every loadable or allocatable output section has two addresses. The | |
2786 | first is the @dfn{VMA}, or virtual memory address. This is the address | |
2787 | the section will have when the output file is run. The second is the | |
2788 | @dfn{LMA}, or load memory address. This is the address at which the | |
2789 | section will be loaded. In most cases the two addresses will be the | |
2790 | same. An example of when they might be different is when a data section | |
2791 | is loaded into ROM, and then copied into RAM when the program starts up | |
2792 | (this technique is often used to initialize global variables in a ROM | |
2793 | based system). In this case the ROM address would be the LMA, and the | |
2794 | RAM address would be the VMA. | |
2795 | ||
2796 | You can see the sections in an object file by using the @code{objdump} | |
2797 | program with the @samp{-h} option. | |
2798 | ||
2799 | Every object file also has a list of @dfn{symbols}, known as the | |
2800 | @dfn{symbol table}. A symbol may be defined or undefined. Each symbol | |
2801 | has a name, and each defined symbol has an address, among other | |
2802 | information. If you compile a C or C++ program into an object file, you | |
2803 | will get a defined symbol for every defined function and global or | |
2804 | static variable. Every undefined function or global variable which is | |
2805 | referenced in the input file will become an undefined symbol. | |
2806 | ||
2807 | You can see the symbols in an object file by using the @code{nm} | |
2808 | program, or by using the @code{objdump} program with the @samp{-t} | |
2809 | option. | |
2810 | ||
2811 | @node Script Format | |
2812 | @section Linker Script Format | |
2813 | @cindex linker script format | |
2814 | Linker scripts are text files. | |
2815 | ||
2816 | You write a linker script as a series of commands. Each command is | |
2817 | either a keyword, possibly followed by arguments, or an assignment to a | |
2818 | symbol. You may separate commands using semicolons. Whitespace is | |
2819 | generally ignored. | |
2820 | ||
2821 | Strings such as file or format names can normally be entered directly. | |
2822 | If the file name contains a character such as a comma which would | |
2823 | otherwise serve to separate file names, you may put the file name in | |
2824 | double quotes. There is no way to use a double quote character in a | |
2825 | file name. | |
2826 | ||
2827 | You may include comments in linker scripts just as in C, delimited by | |
2828 | @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent | |
2829 | to whitespace. | |
2830 | ||
2831 | @node Simple Example | |
2832 | @section Simple Linker Script Example | |
2833 | @cindex linker script example | |
2834 | @cindex example of linker script | |
2835 | Many linker scripts are fairly simple. | |
2836 | ||
2837 | The simplest possible linker script has just one command: | |
2838 | @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the | |
2839 | memory layout of the output file. | |
2840 | ||
2841 | The @samp{SECTIONS} command is a powerful command. Here we will | |
2842 | describe a simple use of it. Let's assume your program consists only of | |
2843 | code, initialized data, and uninitialized data. These will be in the | |
2844 | @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively. | |
2845 | Let's assume further that these are the only sections which appear in | |
2846 | your input files. | |
2847 | ||
2848 | For this example, let's say that the code should be loaded at address | |
2849 | 0x10000, and that the data should start at address 0x8000000. Here is a | |
2850 | linker script which will do that: | |
2851 | @smallexample | |
2852 | SECTIONS | |
2853 | @{ | |
2854 | . = 0x10000; | |
2855 | .text : @{ *(.text) @} | |
2856 | . = 0x8000000; | |
2857 | .data : @{ *(.data) @} | |
2858 | .bss : @{ *(.bss) @} | |
2859 | @} | |
2860 | @end smallexample | |
2861 | ||
2862 | You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS}, | |
2863 | followed by a series of symbol assignments and output section | |
2864 | descriptions enclosed in curly braces. | |
2865 | ||
252b5132 RH |
2866 | The first line inside the @samp{SECTIONS} command of the above example |
2867 | sets the value of the special symbol @samp{.}, which is the location | |
2868 | counter. If you do not specify the address of an output section in some | |
2869 | other way (other ways are described later), the address is set from the | |
2870 | current value of the location counter. The location counter is then | |
2871 | incremented by the size of the output section. At the start of the | |
2872 | @samp{SECTIONS} command, the location counter has the value @samp{0}. | |
2873 | ||
2874 | The second line defines an output section, @samp{.text}. The colon is | |
2875 | required syntax which may be ignored for now. Within the curly braces | |
2876 | after the output section name, you list the names of the input sections | |
2877 | which should be placed into this output section. The @samp{*} is a | |
2878 | wildcard which matches any file name. The expression @samp{*(.text)} | |
2879 | means all @samp{.text} input sections in all input files. | |
2880 | ||
2881 | Since the location counter is @samp{0x10000} when the output section | |
2882 | @samp{.text} is defined, the linker will set the address of the | |
2883 | @samp{.text} section in the output file to be @samp{0x10000}. | |
2884 | ||
2885 | The remaining lines define the @samp{.data} and @samp{.bss} sections in | |
2886 | the output file. The linker will place the @samp{.data} output section | |
2887 | at address @samp{0x8000000}. After the linker places the @samp{.data} | |
2888 | output section, the value of the location counter will be | |
2889 | @samp{0x8000000} plus the size of the @samp{.data} output section. The | |
2890 | effect is that the linker will place the @samp{.bss} output section | |
58434bc1 | 2891 | immediately after the @samp{.data} output section in memory. |
252b5132 RH |
2892 | |
2893 | The linker will ensure that each output section has the required | |
2894 | alignment, by increasing the location counter if necessary. In this | |
2895 | example, the specified addresses for the @samp{.text} and @samp{.data} | |
2896 | sections will probably satisfy any alignment constraints, but the linker | |
2897 | may have to create a small gap between the @samp{.data} and @samp{.bss} | |
2898 | sections. | |
2899 | ||
2900 | That's it! That's a simple and complete linker script. | |
2901 | ||
2902 | @node Simple Commands | |
2903 | @section Simple Linker Script Commands | |
2904 | @cindex linker script simple commands | |
2905 | In this section we describe the simple linker script commands. | |
2906 | ||
2907 | @menu | |
2908 | * Entry Point:: Setting the entry point | |
2909 | * File Commands:: Commands dealing with files | |
2910 | @ifclear SingleFormat | |
2911 | * Format Commands:: Commands dealing with object file formats | |
2912 | @end ifclear | |
2913 | ||
4a93e180 | 2914 | * REGION_ALIAS:: Assign alias names to memory regions |
252b5132 RH |
2915 | * Miscellaneous Commands:: Other linker script commands |
2916 | @end menu | |
2917 | ||
2918 | @node Entry Point | |
36f63dca | 2919 | @subsection Setting the Entry Point |
252b5132 RH |
2920 | @kindex ENTRY(@var{symbol}) |
2921 | @cindex start of execution | |
2922 | @cindex first instruction | |
2923 | @cindex entry point | |
2924 | The first instruction to execute in a program is called the @dfn{entry | |
2925 | point}. You can use the @code{ENTRY} linker script command to set the | |
2926 | entry point. The argument is a symbol name: | |
2927 | @smallexample | |
2928 | ENTRY(@var{symbol}) | |
2929 | @end smallexample | |
2930 | ||
2931 | There are several ways to set the entry point. The linker will set the | |
2932 | entry point by trying each of the following methods in order, and | |
2933 | stopping when one of them succeeds: | |
2934 | @itemize @bullet | |
a1ab1d2a | 2935 | @item |
252b5132 | 2936 | the @samp{-e} @var{entry} command-line option; |
a1ab1d2a | 2937 | @item |
252b5132 | 2938 | the @code{ENTRY(@var{symbol})} command in a linker script; |
a1ab1d2a | 2939 | @item |
3ab904c4 NC |
2940 | the value of a target specific symbol, if it is defined; For many |
2941 | targets this is @code{start}, but PE and BeOS based systems for example | |
2942 | check a list of possible entry symbols, matching the first one found. | |
a1ab1d2a | 2943 | @item |
252b5132 | 2944 | the address of the first byte of the @samp{.text} section, if present; |
a1ab1d2a | 2945 | @item |
252b5132 RH |
2946 | The address @code{0}. |
2947 | @end itemize | |
2948 | ||
2949 | @node File Commands | |
36f63dca | 2950 | @subsection Commands Dealing with Files |
252b5132 RH |
2951 | @cindex linker script file commands |
2952 | Several linker script commands deal with files. | |
2953 | ||
2954 | @table @code | |
2955 | @item INCLUDE @var{filename} | |
2956 | @kindex INCLUDE @var{filename} | |
2957 | @cindex including a linker script | |
2958 | Include the linker script @var{filename} at this point. The file will | |
2959 | be searched for in the current directory, and in any directory specified | |
ff5dcc92 | 2960 | with the @option{-L} option. You can nest calls to @code{INCLUDE} up to |
252b5132 RH |
2961 | 10 levels deep. |
2962 | ||
4006703d NS |
2963 | You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or |
2964 | @code{SECTIONS} commands, or in output section descriptions. | |
2965 | ||
252b5132 RH |
2966 | @item INPUT(@var{file}, @var{file}, @dots{}) |
2967 | @itemx INPUT(@var{file} @var{file} @dots{}) | |
2968 | @kindex INPUT(@var{files}) | |
2969 | @cindex input files in linker scripts | |
2970 | @cindex input object files in linker scripts | |
2971 | @cindex linker script input object files | |
2972 | The @code{INPUT} command directs the linker to include the named files | |
2973 | in the link, as though they were named on the command line. | |
2974 | ||
2975 | For example, if you always want to include @file{subr.o} any time you do | |
2976 | a link, but you can't be bothered to put it on every link command line, | |
2977 | then you can put @samp{INPUT (subr.o)} in your linker script. | |
2978 | ||
2979 | In fact, if you like, you can list all of your input files in the linker | |
2980 | script, and then invoke the linker with nothing but a @samp{-T} option. | |
2981 | ||
e3f2db7f AO |
2982 | In case a @dfn{sysroot prefix} is configured, and the filename starts |
2983 | with the @samp{/} character, and the script being processed was | |
2984 | located inside the @dfn{sysroot prefix}, the filename will be looked | |
2985 | for in the @dfn{sysroot prefix}. Otherwise, the linker will try to | |
2986 | open the file in the current directory. If it is not found, the | |
2987 | linker will search through the archive library search path. See the | |
2988 | description of @samp{-L} in @ref{Options,,Command Line Options}. | |
252b5132 | 2989 | |
ff5dcc92 | 2990 | If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the |
252b5132 RH |
2991 | name to @code{lib@var{file}.a}, as with the command line argument |
2992 | @samp{-l}. | |
2993 | ||
2994 | When you use the @code{INPUT} command in an implicit linker script, the | |
2995 | files will be included in the link at the point at which the linker | |
2996 | script file is included. This can affect archive searching. | |
2997 | ||
2998 | @item GROUP(@var{file}, @var{file}, @dots{}) | |
2999 | @itemx GROUP(@var{file} @var{file} @dots{}) | |
3000 | @kindex GROUP(@var{files}) | |
3001 | @cindex grouping input files | |
3002 | The @code{GROUP} command is like @code{INPUT}, except that the named | |
3003 | files should all be archives, and they are searched repeatedly until no | |
3004 | new undefined references are created. See the description of @samp{-(} | |
3005 | in @ref{Options,,Command Line Options}. | |
3006 | ||
b717d30e JJ |
3007 | @item AS_NEEDED(@var{file}, @var{file}, @dots{}) |
3008 | @itemx AS_NEEDED(@var{file} @var{file} @dots{}) | |
3009 | @kindex AS_NEEDED(@var{files}) | |
3010 | This construct can appear only inside of the @code{INPUT} or @code{GROUP} | |
3011 | commands, among other filenames. The files listed will be handled | |
3012 | as if they appear directly in the @code{INPUT} or @code{GROUP} commands, | |
3013 | with the exception of ELF shared libraries, that will be added only | |
3014 | when they are actually needed. This construct essentially enables | |
3015 | @option{--as-needed} option for all the files listed inside of it | |
3016 | and restores previous @option{--as-needed} resp. @option{--no-as-needed} | |
3017 | setting afterwards. | |
3018 | ||
252b5132 RH |
3019 | @item OUTPUT(@var{filename}) |
3020 | @kindex OUTPUT(@var{filename}) | |
b45619c0 | 3021 | @cindex output file name in linker script |
252b5132 RH |
3022 | The @code{OUTPUT} command names the output file. Using |
3023 | @code{OUTPUT(@var{filename})} in the linker script is exactly like using | |
3024 | @samp{-o @var{filename}} on the command line (@pxref{Options,,Command | |
3025 | Line Options}). If both are used, the command line option takes | |
3026 | precedence. | |
3027 | ||
3028 | You can use the @code{OUTPUT} command to define a default name for the | |
3029 | output file other than the usual default of @file{a.out}. | |
3030 | ||
3031 | @item SEARCH_DIR(@var{path}) | |
3032 | @kindex SEARCH_DIR(@var{path}) | |
3033 | @cindex library search path in linker script | |
3034 | @cindex archive search path in linker script | |
3035 | @cindex search path in linker script | |
3036 | The @code{SEARCH_DIR} command adds @var{path} to the list of paths where | |
ff5dcc92 | 3037 | @command{ld} looks for archive libraries. Using |
252b5132 RH |
3038 | @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}} |
3039 | on the command line (@pxref{Options,,Command Line Options}). If both | |
3040 | are used, then the linker will search both paths. Paths specified using | |
3041 | the command line option are searched first. | |
3042 | ||
3043 | @item STARTUP(@var{filename}) | |
3044 | @kindex STARTUP(@var{filename}) | |
3045 | @cindex first input file | |
3046 | The @code{STARTUP} command is just like the @code{INPUT} command, except | |
3047 | that @var{filename} will become the first input file to be linked, as | |
3048 | though it were specified first on the command line. This may be useful | |
3049 | when using a system in which the entry point is always the start of the | |
3050 | first file. | |
3051 | @end table | |
3052 | ||
3053 | @ifclear SingleFormat | |
3054 | @node Format Commands | |
36f63dca | 3055 | @subsection Commands Dealing with Object File Formats |
252b5132 RH |
3056 | A couple of linker script commands deal with object file formats. |
3057 | ||
3058 | @table @code | |
3059 | @item OUTPUT_FORMAT(@var{bfdname}) | |
3060 | @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little}) | |
3061 | @kindex OUTPUT_FORMAT(@var{bfdname}) | |
3062 | @cindex output file format in linker script | |
3063 | The @code{OUTPUT_FORMAT} command names the BFD format to use for the | |
3064 | output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is | |
024531e2 | 3065 | exactly like using @samp{--oformat @var{bfdname}} on the command line |
252b5132 RH |
3066 | (@pxref{Options,,Command Line Options}). If both are used, the command |
3067 | line option takes precedence. | |
3068 | ||
3069 | You can use @code{OUTPUT_FORMAT} with three arguments to use different | |
3070 | formats based on the @samp{-EB} and @samp{-EL} command line options. | |
3071 | This permits the linker script to set the output format based on the | |
3072 | desired endianness. | |
3073 | ||
3074 | If neither @samp{-EB} nor @samp{-EL} are used, then the output format | |
3075 | will be the first argument, @var{default}. If @samp{-EB} is used, the | |
3076 | output format will be the second argument, @var{big}. If @samp{-EL} is | |
3077 | used, the output format will be the third argument, @var{little}. | |
3078 | ||
3079 | For example, the default linker script for the MIPS ELF target uses this | |
3080 | command: | |
3081 | @smallexample | |
3082 | OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips) | |
3083 | @end smallexample | |
3084 | This says that the default format for the output file is | |
3085 | @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line | |
3086 | option, the output file will be created in the @samp{elf32-littlemips} | |
3087 | format. | |
3088 | ||
3089 | @item TARGET(@var{bfdname}) | |
3090 | @kindex TARGET(@var{bfdname}) | |
3091 | @cindex input file format in linker script | |
3092 | The @code{TARGET} command names the BFD format to use when reading input | |
3093 | files. It affects subsequent @code{INPUT} and @code{GROUP} commands. | |
3094 | This command is like using @samp{-b @var{bfdname}} on the command line | |
3095 | (@pxref{Options,,Command Line Options}). If the @code{TARGET} command | |
3096 | is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET} | |
3097 | command is also used to set the format for the output file. @xref{BFD}. | |
3098 | @end table | |
3099 | @end ifclear | |
3100 | ||
4a93e180 NC |
3101 | @node REGION_ALIAS |
3102 | @subsection Assign alias names to memory regions | |
3103 | @kindex REGION_ALIAS(@var{alias}, @var{region}) | |
3104 | @cindex region alias | |
3105 | @cindex region names | |
3106 | ||
3107 | Alias names can be added to existing memory regions created with the | |
3108 | @ref{MEMORY} command. Each name corresponds to at most one memory region. | |
3109 | ||
3110 | @smallexample | |
3111 | REGION_ALIAS(@var{alias}, @var{region}) | |
3112 | @end smallexample | |
3113 | ||
3114 | The @code{REGION_ALIAS} function creates an alias name @var{alias} for the | |
3115 | memory region @var{region}. This allows a flexible mapping of output sections | |
3116 | to memory regions. An example follows. | |
3117 | ||
3118 | Suppose we have an application for embedded systems which come with various | |
3119 | memory storage devices. All have a general purpose, volatile memory @code{RAM} | |
3120 | that allows code execution or data storage. Some may have a read-only, | |
3121 | non-volatile memory @code{ROM} that allows code execution and read-only data | |
3122 | access. The last variant is a read-only, non-volatile memory @code{ROM2} with | |
3123 | read-only data access and no code execution capability. We have four output | |
3124 | sections: | |
3125 | ||
3126 | @itemize @bullet | |
3127 | @item | |
3128 | @code{.text} program code; | |
3129 | @item | |
3130 | @code{.rodata} read-only data; | |
3131 | @item | |
3132 | @code{.data} read-write initialized data; | |
3133 | @item | |
3134 | @code{.bss} read-write zero initialized data. | |
3135 | @end itemize | |
3136 | ||
3137 | The goal is to provide a linker command file that contains a system independent | |
3138 | part defining the output sections and a system dependent part mapping the | |
3139 | output sections to the memory regions available on the system. Our embedded | |
3140 | systems come with three different memory setups @code{A}, @code{B} and | |
3141 | @code{C}: | |
3142 | @multitable @columnfractions .25 .25 .25 .25 | |
3143 | @item Section @tab Variant A @tab Variant B @tab Variant C | |
3144 | @item .text @tab RAM @tab ROM @tab ROM | |
3145 | @item .rodata @tab RAM @tab ROM @tab ROM2 | |
3146 | @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2 | |
3147 | @item .bss @tab RAM @tab RAM @tab RAM | |
3148 | @end multitable | |
3149 | The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is | |
3150 | loaded into region @code{ROM} or @code{ROM2} respectively. Please note that | |
3151 | the load address of the @code{.data} section starts in all three variants at | |
3152 | the end of the @code{.rodata} section. | |
3153 | ||
3154 | The base linker script that deals with the output sections follows. It | |
3155 | includes the system dependent @code{linkcmds.memory} file that describes the | |
3156 | memory layout: | |
3157 | @smallexample | |
3158 | INCLUDE linkcmds.memory | |
3159 | ||
3160 | SECTIONS | |
3161 | @{ | |
3162 | .text : | |
3163 | @{ | |
3164 | *(.text) | |
3165 | @} > REGION_TEXT | |
3166 | .rodata : | |
3167 | @{ | |
3168 | *(.rodata) | |
3169 | rodata_end = .; | |
3170 | @} > REGION_RODATA | |
3171 | .data : AT (rodata_end) | |
3172 | @{ | |
3173 | data_start = .; | |
3174 | *(.data) | |
3175 | @} > REGION_DATA | |
3176 | data_size = SIZEOF(.data); | |
3177 | data_load_start = LOADADDR(.data); | |
3178 | .bss : | |
3179 | @{ | |
3180 | *(.bss) | |
3181 | @} > REGION_BSS | |
3182 | @} | |
3183 | @end smallexample | |
3184 | ||
3185 | Now we need three different @code{linkcmds.memory} files to define memory | |
3186 | regions and alias names. The content of @code{linkcmds.memory} for the three | |
3187 | variants @code{A}, @code{B} and @code{C}: | |
3188 | @table @code | |
3189 | @item A | |
3190 | Here everything goes into the @code{RAM}. | |
3191 | @smallexample | |
3192 | MEMORY | |
3193 | @{ | |
3194 | RAM : ORIGIN = 0, LENGTH = 4M | |
3195 | @} | |
3196 | ||
3197 | REGION_ALIAS("REGION_TEXT", RAM); | |
3198 | REGION_ALIAS("REGION_RODATA", RAM); | |
3199 | REGION_ALIAS("REGION_DATA", RAM); | |
3200 | REGION_ALIAS("REGION_BSS", RAM); | |
3201 | @end smallexample | |
3202 | @item B | |
3203 | Program code and read-only data go into the @code{ROM}. Read-write data goes | |
3204 | into the @code{RAM}. An image of the initialized data is loaded into the | |
3205 | @code{ROM} and will be copied during system start into the @code{RAM}. | |
3206 | @smallexample | |
3207 | MEMORY | |
3208 | @{ | |
3209 | ROM : ORIGIN = 0, LENGTH = 3M | |
3210 | RAM : ORIGIN = 0x10000000, LENGTH = 1M | |
3211 | @} | |
3212 | ||
3213 | REGION_ALIAS("REGION_TEXT", ROM); | |
3214 | REGION_ALIAS("REGION_RODATA", ROM); | |
3215 | REGION_ALIAS("REGION_DATA", RAM); | |
3216 | REGION_ALIAS("REGION_BSS", RAM); | |
3217 | @end smallexample | |
3218 | @item C | |
3219 | Program code goes into the @code{ROM}. Read-only data goes into the | |
3220 | @code{ROM2}. Read-write data goes into the @code{RAM}. An image of the | |
3221 | initialized data is loaded into the @code{ROM2} and will be copied during | |
3222 | system start into the @code{RAM}. | |
3223 | @smallexample | |
3224 | MEMORY | |
3225 | @{ | |
3226 | ROM : ORIGIN = 0, LENGTH = 2M | |
3227 | ROM2 : ORIGIN = 0x10000000, LENGTH = 1M | |
3228 | RAM : ORIGIN = 0x20000000, LENGTH = 1M | |
3229 | @} | |
3230 | ||
3231 | REGION_ALIAS("REGION_TEXT", ROM); | |
3232 | REGION_ALIAS("REGION_RODATA", ROM2); | |
3233 | REGION_ALIAS("REGION_DATA", RAM); | |
3234 | REGION_ALIAS("REGION_BSS", RAM); | |
3235 | @end smallexample | |
3236 | @end table | |
3237 | ||
3238 | It is possible to write a common system initialization routine to copy the | |
3239 | @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if | |
3240 | necessary: | |
3241 | @smallexample | |
3242 | #include <string.h> | |
3243 | ||
3244 | extern char data_start []; | |
3245 | extern char data_size []; | |
3246 | extern char data_load_start []; | |
3247 | ||
3248 | void copy_data(void) | |
3249 | @{ | |
3250 | if (data_start != data_load_start) | |
3251 | @{ | |
3252 | memcpy(data_start, data_load_start, (size_t) data_size); | |
3253 | @} | |
3254 | @} | |
3255 | @end smallexample | |
3256 | ||
252b5132 | 3257 | @node Miscellaneous Commands |
36f63dca | 3258 | @subsection Other Linker Script Commands |
252b5132 RH |
3259 | There are a few other linker scripts commands. |
3260 | ||
3261 | @table @code | |
3262 | @item ASSERT(@var{exp}, @var{message}) | |
3263 | @kindex ASSERT | |
3264 | @cindex assertion in linker script | |
3265 | Ensure that @var{exp} is non-zero. If it is zero, then exit the linker | |
3266 | with an error code, and print @var{message}. | |
3267 | ||
3268 | @item EXTERN(@var{symbol} @var{symbol} @dots{}) | |
3269 | @kindex EXTERN | |
3270 | @cindex undefined symbol in linker script | |
3271 | Force @var{symbol} to be entered in the output file as an undefined | |
3272 | symbol. Doing this may, for example, trigger linking of additional | |
3273 | modules from standard libraries. You may list several @var{symbol}s for | |
3274 | each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This | |
3275 | command has the same effect as the @samp{-u} command-line option. | |
3276 | ||
3277 | @item FORCE_COMMON_ALLOCATION | |
3278 | @kindex FORCE_COMMON_ALLOCATION | |
3279 | @cindex common allocation in linker script | |
3280 | This command has the same effect as the @samp{-d} command-line option: | |
ff5dcc92 | 3281 | to make @command{ld} assign space to common symbols even if a relocatable |
252b5132 RH |
3282 | output file is specified (@samp{-r}). |
3283 | ||
4818e05f AM |
3284 | @item INHIBIT_COMMON_ALLOCATION |
3285 | @kindex INHIBIT_COMMON_ALLOCATION | |
3286 | @cindex common allocation in linker script | |
3287 | This command has the same effect as the @samp{--no-define-common} | |
3288 | command-line option: to make @code{ld} omit the assignment of addresses | |
3289 | to common symbols even for a non-relocatable output file. | |
3290 | ||
53d25da6 AM |
3291 | @item INSERT [ AFTER | BEFORE ] @var{output_section} |
3292 | @kindex INSERT | |
3293 | @cindex insert user script into default script | |
3294 | This command is typically used in a script specified by @samp{-T} to | |
3295 | augment the default @code{SECTIONS} with, for example, overlays. It | |
3296 | inserts all prior linker script statements after (or before) | |
3297 | @var{output_section}, and also causes @samp{-T} to not override the | |
3298 | default linker script. The exact insertion point is as for orphan | |
3299 | sections. @xref{Location Counter}. The insertion happens after the | |
3300 | linker has mapped input sections to output sections. Prior to the | |
3301 | insertion, since @samp{-T} scripts are parsed before the default | |
3302 | linker script, statements in the @samp{-T} script occur before the | |
3303 | default linker script statements in the internal linker representation | |
3304 | of the script. In particular, input section assignments will be made | |
3305 | to @samp{-T} output sections before those in the default script. Here | |
3306 | is an example of how a @samp{-T} script using @code{INSERT} might look: | |
3307 | ||
3308 | @smallexample | |
3309 | SECTIONS | |
3310 | @{ | |
3311 | OVERLAY : | |
3312 | @{ | |
3313 | .ov1 @{ ov1*(.text) @} | |
3314 | .ov2 @{ ov2*(.text) @} | |
3315 | @} | |
3316 | @} | |
3317 | INSERT AFTER .text; | |
3318 | @end smallexample | |
3319 | ||
252b5132 RH |
3320 | @item NOCROSSREFS(@var{section} @var{section} @dots{}) |
3321 | @kindex NOCROSSREFS(@var{sections}) | |
3322 | @cindex cross references | |
ff5dcc92 | 3323 | This command may be used to tell @command{ld} to issue an error about any |
252b5132 RH |
3324 | references among certain output sections. |
3325 | ||
3326 | In certain types of programs, particularly on embedded systems when | |
3327 | using overlays, when one section is loaded into memory, another section | |
3328 | will not be. Any direct references between the two sections would be | |
3329 | errors. For example, it would be an error if code in one section called | |
3330 | a function defined in the other section. | |
3331 | ||
3332 | The @code{NOCROSSREFS} command takes a list of output section names. If | |
ff5dcc92 | 3333 | @command{ld} detects any cross references between the sections, it reports |
252b5132 RH |
3334 | an error and returns a non-zero exit status. Note that the |
3335 | @code{NOCROSSREFS} command uses output section names, not input section | |
3336 | names. | |
3337 | ||
3338 | @ifclear SingleFormat | |
3339 | @item OUTPUT_ARCH(@var{bfdarch}) | |
3340 | @kindex OUTPUT_ARCH(@var{bfdarch}) | |
3341 | @cindex machine architecture | |
3342 | @cindex architecture | |
3343 | Specify a particular output machine architecture. The argument is one | |
3344 | of the names used by the BFD library (@pxref{BFD}). You can see the | |
3345 | architecture of an object file by using the @code{objdump} program with | |
3346 | the @samp{-f} option. | |
3347 | @end ifclear | |
3348 | @end table | |
3349 | ||
3350 | @node Assignments | |
3351 | @section Assigning Values to Symbols | |
3352 | @cindex assignment in scripts | |
3353 | @cindex symbol definition, scripts | |
3354 | @cindex variables, defining | |
3355 | You may assign a value to a symbol in a linker script. This will define | |
73ae6183 | 3356 | the symbol and place it into the symbol table with a global scope. |
252b5132 RH |
3357 | |
3358 | @menu | |
3359 | * Simple Assignments:: Simple Assignments | |
3360 | * PROVIDE:: PROVIDE | |
7af8e998 | 3361 | * PROVIDE_HIDDEN:: PROVIDE_HIDDEN |
73ae6183 | 3362 | * Source Code Reference:: How to use a linker script defined symbol in source code |
252b5132 RH |
3363 | @end menu |
3364 | ||
3365 | @node Simple Assignments | |
3366 | @subsection Simple Assignments | |
3367 | ||
3368 | You may assign to a symbol using any of the C assignment operators: | |
3369 | ||
3370 | @table @code | |
3371 | @item @var{symbol} = @var{expression} ; | |
3372 | @itemx @var{symbol} += @var{expression} ; | |
3373 | @itemx @var{symbol} -= @var{expression} ; | |
3374 | @itemx @var{symbol} *= @var{expression} ; | |
3375 | @itemx @var{symbol} /= @var{expression} ; | |
3376 | @itemx @var{symbol} <<= @var{expression} ; | |
3377 | @itemx @var{symbol} >>= @var{expression} ; | |
3378 | @itemx @var{symbol} &= @var{expression} ; | |
3379 | @itemx @var{symbol} |= @var{expression} ; | |
3380 | @end table | |
3381 | ||
3382 | The first case will define @var{symbol} to the value of | |
3383 | @var{expression}. In the other cases, @var{symbol} must already be | |
3384 | defined, and the value will be adjusted accordingly. | |
3385 | ||
3386 | The special symbol name @samp{.} indicates the location counter. You | |
b5666f2f | 3387 | may only use this within a @code{SECTIONS} command. @xref{Location Counter}. |
252b5132 RH |
3388 | |
3389 | The semicolon after @var{expression} is required. | |
3390 | ||
3391 | Expressions are defined below; see @ref{Expressions}. | |
3392 | ||
3393 | You may write symbol assignments as commands in their own right, or as | |
3394 | statements within a @code{SECTIONS} command, or as part of an output | |
3395 | section description in a @code{SECTIONS} command. | |
3396 | ||
3397 | The section of the symbol will be set from the section of the | |
3398 | expression; for more information, see @ref{Expression Section}. | |
3399 | ||
3400 | Here is an example showing the three different places that symbol | |
3401 | assignments may be used: | |
3402 | ||
3403 | @smallexample | |
3404 | floating_point = 0; | |
3405 | SECTIONS | |
3406 | @{ | |
3407 | .text : | |
3408 | @{ | |
3409 | *(.text) | |
3410 | _etext = .; | |
3411 | @} | |
156e34dd | 3412 | _bdata = (. + 3) & ~ 3; |
252b5132 RH |
3413 | .data : @{ *(.data) @} |
3414 | @} | |
3415 | @end smallexample | |
3416 | @noindent | |
3417 | In this example, the symbol @samp{floating_point} will be defined as | |
3418 | zero. The symbol @samp{_etext} will be defined as the address following | |
3419 | the last @samp{.text} input section. The symbol @samp{_bdata} will be | |
3420 | defined as the address following the @samp{.text} output section aligned | |
3421 | upward to a 4 byte boundary. | |
3422 | ||
3423 | @node PROVIDE | |
3424 | @subsection PROVIDE | |
3425 | @cindex PROVIDE | |
3426 | In some cases, it is desirable for a linker script to define a symbol | |
3427 | only if it is referenced and is not defined by any object included in | |
3428 | the link. For example, traditional linkers defined the symbol | |
3429 | @samp{etext}. However, ANSI C requires that the user be able to use | |
3430 | @samp{etext} as a function name without encountering an error. The | |
3431 | @code{PROVIDE} keyword may be used to define a symbol, such as | |
3432 | @samp{etext}, only if it is referenced but not defined. The syntax is | |
3433 | @code{PROVIDE(@var{symbol} = @var{expression})}. | |
3434 | ||
3435 | Here is an example of using @code{PROVIDE} to define @samp{etext}: | |
3436 | @smallexample | |
3437 | SECTIONS | |
3438 | @{ | |
3439 | .text : | |
3440 | @{ | |
3441 | *(.text) | |
3442 | _etext = .; | |
3443 | PROVIDE(etext = .); | |
3444 | @} | |
3445 | @} | |
3446 | @end smallexample | |
3447 | ||
3448 | In this example, if the program defines @samp{_etext} (with a leading | |
3449 | underscore), the linker will give a multiple definition error. If, on | |
3450 | the other hand, the program defines @samp{etext} (with no leading | |
3451 | underscore), the linker will silently use the definition in the program. | |
3452 | If the program references @samp{etext} but does not define it, the | |
3453 | linker will use the definition in the linker script. | |
3454 | ||
7af8e998 L |
3455 | @node PROVIDE_HIDDEN |
3456 | @subsection PROVIDE_HIDDEN | |
3457 | @cindex PROVIDE_HIDDEN | |
3458 | Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be | |
3459 | hidden and won't be exported. | |
3460 | ||
73ae6183 NC |
3461 | @node Source Code Reference |
3462 | @subsection Source Code Reference | |
3463 | ||
3464 | Accessing a linker script defined variable from source code is not | |
3465 | intuitive. In particular a linker script symbol is not equivalent to | |
3466 | a variable declaration in a high level language, it is instead a | |
3467 | symbol that does not have a value. | |
3468 | ||
3469 | Before going further, it is important to note that compilers often | |
3470 | transform names in the source code into different names when they are | |
3471 | stored in the symbol table. For example, Fortran compilers commonly | |
3472 | prepend or append an underscore, and C++ performs extensive @samp{name | |
3473 | mangling}. Therefore there might be a discrepancy between the name | |
3474 | of a variable as it is used in source code and the name of the same | |
3475 | variable as it is defined in a linker script. For example in C a | |
3476 | linker script variable might be referred to as: | |
3477 | ||
3478 | @smallexample | |
3479 | extern int foo; | |
3480 | @end smallexample | |
3481 | ||
3482 | But in the linker script it might be defined as: | |
3483 | ||
3484 | @smallexample | |
3485 | _foo = 1000; | |
3486 | @end smallexample | |
3487 | ||
3488 | In the remaining examples however it is assumed that no name | |
3489 | transformation has taken place. | |
3490 | ||
3491 | When a symbol is declared in a high level language such as C, two | |
3492 | things happen. The first is that the compiler reserves enough space | |
3493 | in the program's memory to hold the @emph{value} of the symbol. The | |
3494 | second is that the compiler creates an entry in the program's symbol | |
3495 | table which holds the symbol's @emph{address}. ie the symbol table | |
3496 | contains the address of the block of memory holding the symbol's | |
3497 | value. So for example the following C declaration, at file scope: | |
3498 | ||
3499 | @smallexample | |
3500 | int foo = 1000; | |
3501 | @end smallexample | |
3502 | ||
3503 | creates a entry called @samp{foo} in the symbol table. This entry | |
3504 | holds the address of an @samp{int} sized block of memory where the | |
3505 | number 1000 is initially stored. | |
3506 | ||
3507 | When a program references a symbol the compiler generates code that | |
3508 | first accesses the symbol table to find the address of the symbol's | |
3509 | memory block and then code to read the value from that memory block. | |
3510 | So: | |
3511 | ||
3512 | @smallexample | |
3513 | foo = 1; | |
3514 | @end smallexample | |
3515 | ||
3516 | looks up the symbol @samp{foo} in the symbol table, gets the address | |
3517 | associated with this symbol and then writes the value 1 into that | |
3518 | address. Whereas: | |
3519 | ||
3520 | @smallexample | |
3521 | int * a = & foo; | |
3522 | @end smallexample | |
3523 | ||
3524 | looks up the symbol @samp{foo} in the symbol table, gets it address | |
3525 | and then copies this address into the block of memory associated with | |
3526 | the variable @samp{a}. | |
3527 | ||
3528 | Linker scripts symbol declarations, by contrast, create an entry in | |
3529 | the symbol table but do not assign any memory to them. Thus they are | |
3530 | an address without a value. So for example the linker script definition: | |
3531 | ||
3532 | @smallexample | |
3533 | foo = 1000; | |
3534 | @end smallexample | |
3535 | ||
3536 | creates an entry in the symbol table called @samp{foo} which holds | |
3537 | the address of memory location 1000, but nothing special is stored at | |
3538 | address 1000. This means that you cannot access the @emph{value} of a | |
3539 | linker script defined symbol - it has no value - all you can do is | |
3540 | access the @emph{address} of a linker script defined symbol. | |
3541 | ||
3542 | Hence when you are using a linker script defined symbol in source code | |
3543 | you should always take the address of the symbol, and never attempt to | |
3544 | use its value. For example suppose you want to copy the contents of a | |
3545 | section of memory called .ROM into a section called .FLASH and the | |
3546 | linker script contains these declarations: | |
3547 | ||
3548 | @smallexample | |
3549 | @group | |
3550 | start_of_ROM = .ROM; | |
3551 | end_of_ROM = .ROM + sizeof (.ROM) - 1; | |
3552 | start_of_FLASH = .FLASH; | |
3553 | @end group | |
3554 | @end smallexample | |
3555 | ||
3556 | Then the C source code to perform the copy would be: | |
3557 | ||
3558 | @smallexample | |
3559 | @group | |
3560 | extern char start_of_ROM, end_of_ROM, start_of_FLASH; | |
c0065db7 | 3561 | |
73ae6183 NC |
3562 | memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM); |
3563 | @end group | |
3564 | @end smallexample | |
3565 | ||
3566 | Note the use of the @samp{&} operators. These are correct. | |
3567 | ||
252b5132 | 3568 | @node SECTIONS |
36f63dca | 3569 | @section SECTIONS Command |
252b5132 RH |
3570 | @kindex SECTIONS |
3571 | The @code{SECTIONS} command tells the linker how to map input sections | |
3572 | into output sections, and how to place the output sections in memory. | |
3573 | ||
3574 | The format of the @code{SECTIONS} command is: | |
3575 | @smallexample | |
3576 | SECTIONS | |
3577 | @{ | |
3578 | @var{sections-command} | |
3579 | @var{sections-command} | |
3580 | @dots{} | |
3581 | @} | |
3582 | @end smallexample | |
3583 | ||
3584 | Each @var{sections-command} may of be one of the following: | |
3585 | ||
3586 | @itemize @bullet | |
3587 | @item | |
3588 | an @code{ENTRY} command (@pxref{Entry Point,,Entry command}) | |
3589 | @item | |
3590 | a symbol assignment (@pxref{Assignments}) | |
3591 | @item | |
3592 | an output section description | |
3593 | @item | |
3594 | an overlay description | |
3595 | @end itemize | |
3596 | ||
3597 | The @code{ENTRY} command and symbol assignments are permitted inside the | |
3598 | @code{SECTIONS} command for convenience in using the location counter in | |
3599 | those commands. This can also make the linker script easier to | |
3600 | understand because you can use those commands at meaningful points in | |
3601 | the layout of the output file. | |
3602 | ||
3603 | Output section descriptions and overlay descriptions are described | |
3604 | below. | |
3605 | ||
3606 | If you do not use a @code{SECTIONS} command in your linker script, the | |
3607 | linker will place each input section into an identically named output | |
3608 | section in the order that the sections are first encountered in the | |
3609 | input files. If all input sections are present in the first file, for | |
3610 | example, the order of sections in the output file will match the order | |
3611 | in the first input file. The first section will be at address zero. | |
3612 | ||
3613 | @menu | |
3614 | * Output Section Description:: Output section description | |
3615 | * Output Section Name:: Output section name | |
3616 | * Output Section Address:: Output section address | |
3617 | * Input Section:: Input section description | |
3618 | * Output Section Data:: Output section data | |
3619 | * Output Section Keywords:: Output section keywords | |
3620 | * Output Section Discarding:: Output section discarding | |
3621 | * Output Section Attributes:: Output section attributes | |
3622 | * Overlay Description:: Overlay description | |
3623 | @end menu | |
3624 | ||
3625 | @node Output Section Description | |
36f63dca | 3626 | @subsection Output Section Description |
252b5132 RH |
3627 | The full description of an output section looks like this: |
3628 | @smallexample | |
a1ab1d2a | 3629 | @group |
7e7d5768 | 3630 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 NC |
3631 | [AT(@var{lma})] |
3632 | [ALIGN(@var{section_align})] | |
3633 | [SUBALIGN(@var{subsection_align})] | |
3634 | [@var{constraint}] | |
252b5132 RH |
3635 | @{ |
3636 | @var{output-section-command} | |
3637 | @var{output-section-command} | |
3638 | @dots{} | |
562d3460 | 3639 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
3640 | @end group |
3641 | @end smallexample | |
3642 | ||
3643 | Most output sections do not use most of the optional section attributes. | |
3644 | ||
3645 | The whitespace around @var{section} is required, so that the section | |
3646 | name is unambiguous. The colon and the curly braces are also required. | |
3647 | The line breaks and other white space are optional. | |
3648 | ||
3649 | Each @var{output-section-command} may be one of the following: | |
3650 | ||
3651 | @itemize @bullet | |
3652 | @item | |
3653 | a symbol assignment (@pxref{Assignments}) | |
3654 | @item | |
3655 | an input section description (@pxref{Input Section}) | |
3656 | @item | |
3657 | data values to include directly (@pxref{Output Section Data}) | |
3658 | @item | |
3659 | a special output section keyword (@pxref{Output Section Keywords}) | |
3660 | @end itemize | |
3661 | ||
3662 | @node Output Section Name | |
36f63dca | 3663 | @subsection Output Section Name |
252b5132 RH |
3664 | @cindex name, section |
3665 | @cindex section name | |
3666 | The name of the output section is @var{section}. @var{section} must | |
3667 | meet the constraints of your output format. In formats which only | |
3668 | support a limited number of sections, such as @code{a.out}, the name | |
3669 | must be one of the names supported by the format (@code{a.out}, for | |
3670 | example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the | |
3671 | output format supports any number of sections, but with numbers and not | |
3672 | names (as is the case for Oasys), the name should be supplied as a | |
3673 | quoted numeric string. A section name may consist of any sequence of | |
3674 | characters, but a name which contains any unusual characters such as | |
3675 | commas must be quoted. | |
3676 | ||
3677 | The output section name @samp{/DISCARD/} is special; @ref{Output Section | |
3678 | Discarding}. | |
3679 | ||
3680 | @node Output Section Address | |
2a16d82a | 3681 | @subsection Output Section Address |
252b5132 RH |
3682 | @cindex address, section |
3683 | @cindex section address | |
3684 | The @var{address} is an expression for the VMA (the virtual memory | |
3685 | address) of the output section. If you do not provide @var{address}, | |
3686 | the linker will set it based on @var{region} if present, or otherwise | |
3687 | based on the current value of the location counter. | |
3688 | ||
3689 | If you provide @var{address}, the address of the output section will be | |
3690 | set to precisely that. If you provide neither @var{address} nor | |
3691 | @var{region}, then the address of the output section will be set to the | |
3692 | current value of the location counter aligned to the alignment | |
3693 | requirements of the output section. The alignment requirement of the | |
3694 | output section is the strictest alignment of any input section contained | |
3695 | within the output section. | |
3696 | ||
3697 | For example, | |
3698 | @smallexample | |
3699 | .text . : @{ *(.text) @} | |
3700 | @end smallexample | |
3701 | @noindent | |
3702 | and | |
3703 | @smallexample | |
3704 | .text : @{ *(.text) @} | |
3705 | @end smallexample | |
3706 | @noindent | |
3707 | are subtly different. The first will set the address of the | |
3708 | @samp{.text} output section to the current value of the location | |
3709 | counter. The second will set it to the current value of the location | |
3710 | counter aligned to the strictest alignment of a @samp{.text} input | |
3711 | section. | |
3712 | ||
3713 | The @var{address} may be an arbitrary expression; @ref{Expressions}. | |
3714 | For example, if you want to align the section on a 0x10 byte boundary, | |
3715 | so that the lowest four bits of the section address are zero, you could | |
3716 | do something like this: | |
3717 | @smallexample | |
3718 | .text ALIGN(0x10) : @{ *(.text) @} | |
3719 | @end smallexample | |
3720 | @noindent | |
3721 | This works because @code{ALIGN} returns the current location counter | |
3722 | aligned upward to the specified value. | |
3723 | ||
3724 | Specifying @var{address} for a section will change the value of the | |
6ce340f1 NC |
3725 | location counter, provided that the section is non-empty. (Empty |
3726 | sections are ignored). | |
252b5132 RH |
3727 | |
3728 | @node Input Section | |
36f63dca | 3729 | @subsection Input Section Description |
252b5132 RH |
3730 | @cindex input sections |
3731 | @cindex mapping input sections to output sections | |
3732 | The most common output section command is an input section description. | |
3733 | ||
3734 | The input section description is the most basic linker script operation. | |
3735 | You use output sections to tell the linker how to lay out your program | |
3736 | in memory. You use input section descriptions to tell the linker how to | |
3737 | map the input files into your memory layout. | |
3738 | ||
3739 | @menu | |
3740 | * Input Section Basics:: Input section basics | |
3741 | * Input Section Wildcards:: Input section wildcard patterns | |
3742 | * Input Section Common:: Input section for common symbols | |
3743 | * Input Section Keep:: Input section and garbage collection | |
3744 | * Input Section Example:: Input section example | |
3745 | @end menu | |
3746 | ||
3747 | @node Input Section Basics | |
36f63dca | 3748 | @subsubsection Input Section Basics |
252b5132 RH |
3749 | @cindex input section basics |
3750 | An input section description consists of a file name optionally followed | |
3751 | by a list of section names in parentheses. | |
3752 | ||
3753 | The file name and the section name may be wildcard patterns, which we | |
3754 | describe further below (@pxref{Input Section Wildcards}). | |
3755 | ||
3756 | The most common input section description is to include all input | |
3757 | sections with a particular name in the output section. For example, to | |
3758 | include all input @samp{.text} sections, you would write: | |
3759 | @smallexample | |
3760 | *(.text) | |
3761 | @end smallexample | |
3762 | @noindent | |
18625d54 CM |
3763 | Here the @samp{*} is a wildcard which matches any file name. To exclude a list |
3764 | of files from matching the file name wildcard, EXCLUDE_FILE may be used to | |
3765 | match all files except the ones specified in the EXCLUDE_FILE list. For | |
3766 | example: | |
252b5132 | 3767 | @smallexample |
b4346c09 | 3768 | *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors) |
252b5132 | 3769 | @end smallexample |
765b7cbe JB |
3770 | will cause all .ctors sections from all files except @file{crtend.o} and |
3771 | @file{otherfile.o} to be included. | |
252b5132 RH |
3772 | |
3773 | There are two ways to include more than one section: | |
3774 | @smallexample | |
3775 | *(.text .rdata) | |
3776 | *(.text) *(.rdata) | |
3777 | @end smallexample | |
3778 | @noindent | |
3779 | The difference between these is the order in which the @samp{.text} and | |
3780 | @samp{.rdata} input sections will appear in the output section. In the | |
b6bf44ba AM |
3781 | first example, they will be intermingled, appearing in the same order as |
3782 | they are found in the linker input. In the second example, all | |
252b5132 RH |
3783 | @samp{.text} input sections will appear first, followed by all |
3784 | @samp{.rdata} input sections. | |
3785 | ||
3786 | You can specify a file name to include sections from a particular file. | |
3787 | You would do this if one or more of your files contain special data that | |
3788 | needs to be at a particular location in memory. For example: | |
3789 | @smallexample | |
3790 | data.o(.data) | |
3791 | @end smallexample | |
3792 | ||
967928e9 AM |
3793 | You can also specify files within archives by writing a pattern |
3794 | matching the archive, a colon, then the pattern matching the file, | |
3795 | with no whitespace around the colon. | |
3796 | ||
3797 | @table @samp | |
3798 | @item archive:file | |
3799 | matches file within archive | |
3800 | @item archive: | |
3801 | matches the whole archive | |
3802 | @item :file | |
3803 | matches file but not one in an archive | |
3804 | @end table | |
3805 | ||
3806 | Either one or both of @samp{archive} and @samp{file} can contain shell | |
3807 | wildcards. On DOS based file systems, the linker will assume that a | |
3808 | single letter followed by a colon is a drive specifier, so | |
3809 | @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o} | |
3810 | within an archive called @samp{c}. @samp{archive:file} filespecs may | |
3811 | also be used within an @code{EXCLUDE_FILE} list, but may not appear in | |
3812 | other linker script contexts. For instance, you cannot extract a file | |
3813 | from an archive by using @samp{archive:file} in an @code{INPUT} | |
3814 | command. | |
3815 | ||
252b5132 RH |
3816 | If you use a file name without a list of sections, then all sections in |
3817 | the input file will be included in the output section. This is not | |
3818 | commonly done, but it may by useful on occasion. For example: | |
3819 | @smallexample | |
3820 | data.o | |
3821 | @end smallexample | |
3822 | ||
967928e9 AM |
3823 | When you use a file name which is not an @samp{archive:file} specifier |
3824 | and does not contain any wild card | |
252b5132 RH |
3825 | characters, the linker will first see if you also specified the file |
3826 | name on the linker command line or in an @code{INPUT} command. If you | |
3827 | did not, the linker will attempt to open the file as an input file, as | |
3828 | though it appeared on the command line. Note that this differs from an | |
3829 | @code{INPUT} command, because the linker will not search for the file in | |
3830 | the archive search path. | |
3831 | ||
3832 | @node Input Section Wildcards | |
36f63dca | 3833 | @subsubsection Input Section Wildcard Patterns |
252b5132 RH |
3834 | @cindex input section wildcards |
3835 | @cindex wildcard file name patterns | |
3836 | @cindex file name wildcard patterns | |
3837 | @cindex section name wildcard patterns | |
3838 | In an input section description, either the file name or the section | |
3839 | name or both may be wildcard patterns. | |
3840 | ||
3841 | The file name of @samp{*} seen in many examples is a simple wildcard | |
3842 | pattern for the file name. | |
3843 | ||
3844 | The wildcard patterns are like those used by the Unix shell. | |
3845 | ||
3846 | @table @samp | |
3847 | @item * | |
3848 | matches any number of characters | |
3849 | @item ? | |
3850 | matches any single character | |
3851 | @item [@var{chars}] | |
3852 | matches a single instance of any of the @var{chars}; the @samp{-} | |
3853 | character may be used to specify a range of characters, as in | |
3854 | @samp{[a-z]} to match any lower case letter | |
3855 | @item \ | |
3856 | quotes the following character | |
3857 | @end table | |
3858 | ||
3859 | When a file name is matched with a wildcard, the wildcard characters | |
3860 | will not match a @samp{/} character (used to separate directory names on | |
3861 | Unix). A pattern consisting of a single @samp{*} character is an | |
3862 | exception; it will always match any file name, whether it contains a | |
3863 | @samp{/} or not. In a section name, the wildcard characters will match | |
3864 | a @samp{/} character. | |
3865 | ||
3866 | File name wildcard patterns only match files which are explicitly | |
3867 | specified on the command line or in an @code{INPUT} command. The linker | |
3868 | does not search directories to expand wildcards. | |
3869 | ||
3870 | If a file name matches more than one wildcard pattern, or if a file name | |
3871 | appears explicitly and is also matched by a wildcard pattern, the linker | |
3872 | will use the first match in the linker script. For example, this | |
3873 | sequence of input section descriptions is probably in error, because the | |
3874 | @file{data.o} rule will not be used: | |
3875 | @smallexample | |
3876 | .data : @{ *(.data) @} | |
3877 | .data1 : @{ data.o(.data) @} | |
3878 | @end smallexample | |
3879 | ||
bcaa7b3e | 3880 | @cindex SORT_BY_NAME |
252b5132 RH |
3881 | Normally, the linker will place files and sections matched by wildcards |
3882 | in the order in which they are seen during the link. You can change | |
bcaa7b3e L |
3883 | this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard |
3884 | pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the | |
3885 | @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections | |
252b5132 RH |
3886 | into ascending order by name before placing them in the output file. |
3887 | ||
bcaa7b3e L |
3888 | @cindex SORT_BY_ALIGNMENT |
3889 | @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The | |
3890 | difference is @code{SORT_BY_ALIGNMENT} will sort sections into | |
3891 | ascending order by alignment before placing them in the output file. | |
3892 | ||
3893 | @cindex SORT | |
3894 | @code{SORT} is an alias for @code{SORT_BY_NAME}. | |
3895 | ||
3896 | When there are nested section sorting commands in linker script, there | |
3897 | can be at most 1 level of nesting for section sorting commands. | |
3898 | ||
3899 | @enumerate | |
3900 | @item | |
3901 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
3902 | It will sort the input sections by name first, then by alignment if 2 | |
3903 | sections have the same name. | |
3904 | @item | |
3905 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
3906 | It will sort the input sections by alignment first, then by name if 2 | |
3907 | sections have the same alignment. | |
3908 | @item | |
c0065db7 | 3909 | @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is |
bcaa7b3e L |
3910 | treated the same as @code{SORT_BY_NAME} (wildcard section pattern). |
3911 | @item | |
3912 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)) | |
3913 | is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern). | |
3914 | @item | |
3915 | All other nested section sorting commands are invalid. | |
3916 | @end enumerate | |
3917 | ||
3918 | When both command line section sorting option and linker script | |
3919 | section sorting command are used, section sorting command always | |
3920 | takes precedence over the command line option. | |
3921 | ||
3922 | If the section sorting command in linker script isn't nested, the | |
3923 | command line option will make the section sorting command to be | |
3924 | treated as nested sorting command. | |
3925 | ||
3926 | @enumerate | |
3927 | @item | |
3928 | @code{SORT_BY_NAME} (wildcard section pattern ) with | |
3929 | @option{--sort-sections alignment} is equivalent to | |
3930 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
3931 | @item | |
3932 | @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with | |
3933 | @option{--sort-section name} is equivalent to | |
3934 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
3935 | @end enumerate | |
3936 | ||
3937 | If the section sorting command in linker script is nested, the | |
3938 | command line option will be ignored. | |
3939 | ||
252b5132 RH |
3940 | If you ever get confused about where input sections are going, use the |
3941 | @samp{-M} linker option to generate a map file. The map file shows | |
3942 | precisely how input sections are mapped to output sections. | |
3943 | ||
3944 | This example shows how wildcard patterns might be used to partition | |
3945 | files. This linker script directs the linker to place all @samp{.text} | |
3946 | sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}. | |
3947 | The linker will place the @samp{.data} section from all files beginning | |
3948 | with an upper case character in @samp{.DATA}; for all other files, the | |
3949 | linker will place the @samp{.data} section in @samp{.data}. | |
3950 | @smallexample | |
3951 | @group | |
3952 | SECTIONS @{ | |
3953 | .text : @{ *(.text) @} | |
3954 | .DATA : @{ [A-Z]*(.data) @} | |
3955 | .data : @{ *(.data) @} | |
3956 | .bss : @{ *(.bss) @} | |
3957 | @} | |
3958 | @end group | |
3959 | @end smallexample | |
3960 | ||
3961 | @node Input Section Common | |
36f63dca | 3962 | @subsubsection Input Section for Common Symbols |
252b5132 RH |
3963 | @cindex common symbol placement |
3964 | @cindex uninitialized data placement | |
3965 | A special notation is needed for common symbols, because in many object | |
3966 | file formats common symbols do not have a particular input section. The | |
3967 | linker treats common symbols as though they are in an input section | |
3968 | named @samp{COMMON}. | |
3969 | ||
3970 | You may use file names with the @samp{COMMON} section just as with any | |
3971 | other input sections. You can use this to place common symbols from a | |
3972 | particular input file in one section while common symbols from other | |
3973 | input files are placed in another section. | |
3974 | ||
3975 | In most cases, common symbols in input files will be placed in the | |
3976 | @samp{.bss} section in the output file. For example: | |
3977 | @smallexample | |
3978 | .bss @{ *(.bss) *(COMMON) @} | |
3979 | @end smallexample | |
3980 | ||
3981 | @cindex scommon section | |
3982 | @cindex small common symbols | |
3983 | Some object file formats have more than one type of common symbol. For | |
3984 | example, the MIPS ELF object file format distinguishes standard common | |
3985 | symbols and small common symbols. In this case, the linker will use a | |
3986 | different special section name for other types of common symbols. In | |
3987 | the case of MIPS ELF, the linker uses @samp{COMMON} for standard common | |
3988 | symbols and @samp{.scommon} for small common symbols. This permits you | |
3989 | to map the different types of common symbols into memory at different | |
3990 | locations. | |
3991 | ||
3992 | @cindex [COMMON] | |
3993 | You will sometimes see @samp{[COMMON]} in old linker scripts. This | |
3994 | notation is now considered obsolete. It is equivalent to | |
3995 | @samp{*(COMMON)}. | |
3996 | ||
3997 | @node Input Section Keep | |
36f63dca | 3998 | @subsubsection Input Section and Garbage Collection |
252b5132 RH |
3999 | @cindex KEEP |
4000 | @cindex garbage collection | |
4001 | When link-time garbage collection is in use (@samp{--gc-sections}), | |
a1ab1d2a | 4002 | it is often useful to mark sections that should not be eliminated. |
252b5132 RH |
4003 | This is accomplished by surrounding an input section's wildcard entry |
4004 | with @code{KEEP()}, as in @code{KEEP(*(.init))} or | |
bcaa7b3e | 4005 | @code{KEEP(SORT_BY_NAME(*)(.ctors))}. |
252b5132 RH |
4006 | |
4007 | @node Input Section Example | |
36f63dca | 4008 | @subsubsection Input Section Example |
252b5132 RH |
4009 | The following example is a complete linker script. It tells the linker |
4010 | to read all of the sections from file @file{all.o} and place them at the | |
4011 | start of output section @samp{outputa} which starts at location | |
4012 | @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o} | |
4013 | follows immediately, in the same output section. All of section | |
4014 | @samp{.input2} from @file{foo.o} goes into output section | |
4015 | @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}. | |
4016 | All of the remaining @samp{.input1} and @samp{.input2} sections from any | |
4017 | files are written to output section @samp{outputc}. | |
4018 | ||
4019 | @smallexample | |
4020 | @group | |
4021 | SECTIONS @{ | |
4022 | outputa 0x10000 : | |
4023 | @{ | |
4024 | all.o | |
4025 | foo.o (.input1) | |
4026 | @} | |
36f63dca NC |
4027 | @end group |
4028 | @group | |
252b5132 RH |
4029 | outputb : |
4030 | @{ | |
4031 | foo.o (.input2) | |
4032 | foo1.o (.input1) | |
4033 | @} | |
36f63dca NC |
4034 | @end group |
4035 | @group | |
252b5132 RH |
4036 | outputc : |
4037 | @{ | |
4038 | *(.input1) | |
4039 | *(.input2) | |
4040 | @} | |
4041 | @} | |
4042 | @end group | |
a1ab1d2a | 4043 | @end smallexample |
252b5132 RH |
4044 | |
4045 | @node Output Section Data | |
36f63dca | 4046 | @subsection Output Section Data |
252b5132 RH |
4047 | @cindex data |
4048 | @cindex section data | |
4049 | @cindex output section data | |
4050 | @kindex BYTE(@var{expression}) | |
4051 | @kindex SHORT(@var{expression}) | |
4052 | @kindex LONG(@var{expression}) | |
4053 | @kindex QUAD(@var{expression}) | |
4054 | @kindex SQUAD(@var{expression}) | |
4055 | You can include explicit bytes of data in an output section by using | |
4056 | @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as | |
4057 | an output section command. Each keyword is followed by an expression in | |
4058 | parentheses providing the value to store (@pxref{Expressions}). The | |
4059 | value of the expression is stored at the current value of the location | |
4060 | counter. | |
4061 | ||
4062 | The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands | |
4063 | store one, two, four, and eight bytes (respectively). After storing the | |
4064 | bytes, the location counter is incremented by the number of bytes | |
4065 | stored. | |
4066 | ||
4067 | For example, this will store the byte 1 followed by the four byte value | |
4068 | of the symbol @samp{addr}: | |
4069 | @smallexample | |
4070 | BYTE(1) | |
4071 | LONG(addr) | |
4072 | @end smallexample | |
4073 | ||
4074 | When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the | |
4075 | same; they both store an 8 byte, or 64 bit, value. When both host and | |
4076 | target are 32 bits, an expression is computed as 32 bits. In this case | |
4077 | @code{QUAD} stores a 32 bit value zero extended to 64 bits, and | |
4078 | @code{SQUAD} stores a 32 bit value sign extended to 64 bits. | |
4079 | ||
4080 | If the object file format of the output file has an explicit endianness, | |
4081 | which is the normal case, the value will be stored in that endianness. | |
4082 | When the object file format does not have an explicit endianness, as is | |
4083 | true of, for example, S-records, the value will be stored in the | |
4084 | endianness of the first input object file. | |
4085 | ||
36f63dca | 4086 | Note---these commands only work inside a section description and not |
2b5fc1f5 NC |
4087 | between them, so the following will produce an error from the linker: |
4088 | @smallexample | |
4089 | SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@ | |
4090 | @end smallexample | |
4091 | whereas this will work: | |
4092 | @smallexample | |
4093 | SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@ | |
4094 | @end smallexample | |
4095 | ||
252b5132 RH |
4096 | @kindex FILL(@var{expression}) |
4097 | @cindex holes, filling | |
4098 | @cindex unspecified memory | |
4099 | You may use the @code{FILL} command to set the fill pattern for the | |
4100 | current section. It is followed by an expression in parentheses. Any | |
4101 | otherwise unspecified regions of memory within the section (for example, | |
4102 | gaps left due to the required alignment of input sections) are filled | |
a139d329 | 4103 | with the value of the expression, repeated as |
252b5132 RH |
4104 | necessary. A @code{FILL} statement covers memory locations after the |
4105 | point at which it occurs in the section definition; by including more | |
4106 | than one @code{FILL} statement, you can have different fill patterns in | |
4107 | different parts of an output section. | |
4108 | ||
4109 | This example shows how to fill unspecified regions of memory with the | |
563e308f | 4110 | value @samp{0x90}: |
252b5132 | 4111 | @smallexample |
563e308f | 4112 | FILL(0x90909090) |
252b5132 RH |
4113 | @end smallexample |
4114 | ||
4115 | The @code{FILL} command is similar to the @samp{=@var{fillexp}} output | |
9673c93c | 4116 | section attribute, but it only affects the |
252b5132 RH |
4117 | part of the section following the @code{FILL} command, rather than the |
4118 | entire section. If both are used, the @code{FILL} command takes | |
9673c93c | 4119 | precedence. @xref{Output Section Fill}, for details on the fill |
a139d329 | 4120 | expression. |
252b5132 RH |
4121 | |
4122 | @node Output Section Keywords | |
36f63dca | 4123 | @subsection Output Section Keywords |
252b5132 RH |
4124 | There are a couple of keywords which can appear as output section |
4125 | commands. | |
4126 | ||
4127 | @table @code | |
4128 | @kindex CREATE_OBJECT_SYMBOLS | |
4129 | @cindex input filename symbols | |
4130 | @cindex filename symbols | |
4131 | @item CREATE_OBJECT_SYMBOLS | |
4132 | The command tells the linker to create a symbol for each input file. | |
4133 | The name of each symbol will be the name of the corresponding input | |
4134 | file. The section of each symbol will be the output section in which | |
4135 | the @code{CREATE_OBJECT_SYMBOLS} command appears. | |
4136 | ||
4137 | This is conventional for the a.out object file format. It is not | |
4138 | normally used for any other object file format. | |
4139 | ||
4140 | @kindex CONSTRUCTORS | |
4141 | @cindex C++ constructors, arranging in link | |
4142 | @cindex constructors, arranging in link | |
4143 | @item CONSTRUCTORS | |
4144 | When linking using the a.out object file format, the linker uses an | |
4145 | unusual set construct to support C++ global constructors and | |
4146 | destructors. When linking object file formats which do not support | |
4147 | arbitrary sections, such as ECOFF and XCOFF, the linker will | |
4148 | automatically recognize C++ global constructors and destructors by name. | |
4149 | For these object file formats, the @code{CONSTRUCTORS} command tells the | |
4150 | linker to place constructor information in the output section where the | |
4151 | @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is | |
4152 | ignored for other object file formats. | |
4153 | ||
4154 | The symbol @w{@code{__CTOR_LIST__}} marks the start of the global | |
7e69709c AM |
4155 | constructors, and the symbol @w{@code{__CTOR_END__}} marks the end. |
4156 | Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark | |
4157 | the start and end of the global destructors. The | |
252b5132 RH |
4158 | first word in the list is the number of entries, followed by the address |
4159 | of each constructor or destructor, followed by a zero word. The | |
4160 | compiler must arrange to actually run the code. For these object file | |
4161 | formats @sc{gnu} C++ normally calls constructors from a subroutine | |
4162 | @code{__main}; a call to @code{__main} is automatically inserted into | |
4163 | the startup code for @code{main}. @sc{gnu} C++ normally runs | |
4164 | destructors either by using @code{atexit}, or directly from the function | |
4165 | @code{exit}. | |
4166 | ||
4167 | For object file formats such as @code{COFF} or @code{ELF} which support | |
4168 | arbitrary section names, @sc{gnu} C++ will normally arrange to put the | |
4169 | addresses of global constructors and destructors into the @code{.ctors} | |
4170 | and @code{.dtors} sections. Placing the following sequence into your | |
4171 | linker script will build the sort of table which the @sc{gnu} C++ | |
4172 | runtime code expects to see. | |
4173 | ||
4174 | @smallexample | |
4175 | __CTOR_LIST__ = .; | |
4176 | LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2) | |
4177 | *(.ctors) | |
4178 | LONG(0) | |
4179 | __CTOR_END__ = .; | |
4180 | __DTOR_LIST__ = .; | |
4181 | LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2) | |
4182 | *(.dtors) | |
4183 | LONG(0) | |
4184 | __DTOR_END__ = .; | |
4185 | @end smallexample | |
4186 | ||
4187 | If you are using the @sc{gnu} C++ support for initialization priority, | |
4188 | which provides some control over the order in which global constructors | |
4189 | are run, you must sort the constructors at link time to ensure that they | |
4190 | are executed in the correct order. When using the @code{CONSTRUCTORS} | |
bcaa7b3e L |
4191 | command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the |
4192 | @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and | |
4193 | @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and | |
252b5132 RH |
4194 | @samp{*(.dtors)}. |
4195 | ||
4196 | Normally the compiler and linker will handle these issues automatically, | |
4197 | and you will not need to concern yourself with them. However, you may | |
4198 | need to consider this if you are using C++ and writing your own linker | |
4199 | scripts. | |
4200 | ||
4201 | @end table | |
4202 | ||
4203 | @node Output Section Discarding | |
36f63dca | 4204 | @subsection Output Section Discarding |
252b5132 RH |
4205 | @cindex discarding sections |
4206 | @cindex sections, discarding | |
4207 | @cindex removing sections | |
74541ad4 AM |
4208 | The linker will not create output sections with no contents. This is |
4209 | for convenience when referring to input sections that may or may not | |
4210 | be present in any of the input files. For example: | |
252b5132 | 4211 | @smallexample |
49c13adb | 4212 | .foo : @{ *(.foo) @} |
252b5132 RH |
4213 | @end smallexample |
4214 | @noindent | |
4215 | will only create a @samp{.foo} section in the output file if there is a | |
74541ad4 AM |
4216 | @samp{.foo} section in at least one input file, and if the input |
4217 | sections are not all empty. Other link script directives that allocate | |
4218 | space in an output section will also create the output section. | |
4219 | ||
a0976ea4 | 4220 | The linker will ignore address assignments (@pxref{Output Section Address}) |
74541ad4 AM |
4221 | on discarded output sections, except when the linker script defines |
4222 | symbols in the output section. In that case the linker will obey | |
a0976ea4 AM |
4223 | the address assignments, possibly advancing dot even though the |
4224 | section is discarded. | |
252b5132 RH |
4225 | |
4226 | @cindex /DISCARD/ | |
4227 | The special output section name @samp{/DISCARD/} may be used to discard | |
4228 | input sections. Any input sections which are assigned to an output | |
4229 | section named @samp{/DISCARD/} are not included in the output file. | |
4230 | ||
4231 | @node Output Section Attributes | |
36f63dca | 4232 | @subsection Output Section Attributes |
252b5132 RH |
4233 | @cindex output section attributes |
4234 | We showed above that the full description of an output section looked | |
4235 | like this: | |
0c71d759 | 4236 | |
252b5132 | 4237 | @smallexample |
a1ab1d2a | 4238 | @group |
7e7d5768 | 4239 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 NC |
4240 | [AT(@var{lma})] |
4241 | [ALIGN(@var{section_align})] | |
4242 | [SUBALIGN(@var{subsection_align})] | |
4243 | [@var{constraint}] | |
252b5132 RH |
4244 | @{ |
4245 | @var{output-section-command} | |
4246 | @var{output-section-command} | |
4247 | @dots{} | |
562d3460 | 4248 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
4249 | @end group |
4250 | @end smallexample | |
0c71d759 | 4251 | |
252b5132 RH |
4252 | We've already described @var{section}, @var{address}, and |
4253 | @var{output-section-command}. In this section we will describe the | |
4254 | remaining section attributes. | |
4255 | ||
a1ab1d2a | 4256 | @menu |
252b5132 RH |
4257 | * Output Section Type:: Output section type |
4258 | * Output Section LMA:: Output section LMA | |
bbf115d3 | 4259 | * Forced Output Alignment:: Forced Output Alignment |
7e7d5768 | 4260 | * Forced Input Alignment:: Forced Input Alignment |
0c71d759 | 4261 | * Output Section Constraint:: Output section constraint |
252b5132 RH |
4262 | * Output Section Region:: Output section region |
4263 | * Output Section Phdr:: Output section phdr | |
4264 | * Output Section Fill:: Output section fill | |
4265 | @end menu | |
4266 | ||
4267 | @node Output Section Type | |
36f63dca | 4268 | @subsubsection Output Section Type |
252b5132 RH |
4269 | Each output section may have a type. The type is a keyword in |
4270 | parentheses. The following types are defined: | |
4271 | ||
4272 | @table @code | |
4273 | @item NOLOAD | |
4274 | The section should be marked as not loadable, so that it will not be | |
4275 | loaded into memory when the program is run. | |
4276 | @item DSECT | |
4277 | @itemx COPY | |
4278 | @itemx INFO | |
4279 | @itemx OVERLAY | |
4280 | These type names are supported for backward compatibility, and are | |
4281 | rarely used. They all have the same effect: the section should be | |
4282 | marked as not allocatable, so that no memory is allocated for the | |
4283 | section when the program is run. | |
4284 | @end table | |
4285 | ||
4286 | @kindex NOLOAD | |
4287 | @cindex prevent unnecessary loading | |
4288 | @cindex loading, preventing | |
4289 | The linker normally sets the attributes of an output section based on | |
4290 | the input sections which map into it. You can override this by using | |
4291 | the section type. For example, in the script sample below, the | |
4292 | @samp{ROM} section is addressed at memory location @samp{0} and does not | |
4293 | need to be loaded when the program is run. The contents of the | |
4294 | @samp{ROM} section will appear in the linker output file as usual. | |
4295 | @smallexample | |
4296 | @group | |
4297 | SECTIONS @{ | |
4298 | ROM 0 (NOLOAD) : @{ @dots{} @} | |
4299 | @dots{} | |
4300 | @} | |
4301 | @end group | |
4302 | @end smallexample | |
4303 | ||
4304 | @node Output Section LMA | |
36f63dca | 4305 | @subsubsection Output Section LMA |
562d3460 | 4306 | @kindex AT>@var{lma_region} |
252b5132 RH |
4307 | @kindex AT(@var{lma}) |
4308 | @cindex load address | |
4309 | @cindex section load address | |
4310 | Every section has a virtual address (VMA) and a load address (LMA); see | |
4311 | @ref{Basic Script Concepts}. The address expression which may appear in | |
4312 | an output section description sets the VMA (@pxref{Output Section | |
4313 | Address}). | |
4314 | ||
dc0b6aa0 AM |
4315 | The expression @var{lma} that follows the @code{AT} keyword specifies |
4316 | the load address of the section. | |
6bdafbeb NC |
4317 | |
4318 | Alternatively, with @samp{AT>@var{lma_region}} expression, you may | |
4319 | specify a memory region for the section's load address. @xref{MEMORY}. | |
4320 | Note that if the section has not had a VMA assigned to it then the | |
4321 | linker will use the @var{lma_region} as the VMA region as well. | |
dc0b6aa0 AM |
4322 | |
4323 | If neither @code{AT} nor @code{AT>} is specified for an allocatable | |
4324 | section, the linker will set the LMA such that the difference between | |
4325 | VMA and LMA for the section is the same as the preceding output | |
4326 | section in the same region. If there is no preceding output section | |
4327 | or the section is not allocatable, the linker will set the LMA equal | |
4328 | to the VMA. | |
6bdafbeb | 4329 | @xref{Output Section Region}. |
252b5132 RH |
4330 | |
4331 | @cindex ROM initialized data | |
4332 | @cindex initialized data in ROM | |
4333 | This feature is designed to make it easy to build a ROM image. For | |
4334 | example, the following linker script creates three output sections: one | |
4335 | called @samp{.text}, which starts at @code{0x1000}, one called | |
4336 | @samp{.mdata}, which is loaded at the end of the @samp{.text} section | |
4337 | even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold | |
4338 | uninitialized data at address @code{0x3000}. The symbol @code{_data} is | |
4339 | defined with the value @code{0x2000}, which shows that the location | |
4340 | counter holds the VMA value, not the LMA value. | |
4341 | ||
4342 | @smallexample | |
4343 | @group | |
4344 | SECTIONS | |
4345 | @{ | |
4346 | .text 0x1000 : @{ *(.text) _etext = . ; @} | |
a1ab1d2a | 4347 | .mdata 0x2000 : |
252b5132 RH |
4348 | AT ( ADDR (.text) + SIZEOF (.text) ) |
4349 | @{ _data = . ; *(.data); _edata = . ; @} | |
4350 | .bss 0x3000 : | |
4351 | @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@} | |
4352 | @} | |
4353 | @end group | |
4354 | @end smallexample | |
4355 | ||
4356 | The run-time initialization code for use with a program generated with | |
4357 | this linker script would include something like the following, to copy | |
4358 | the initialized data from the ROM image to its runtime address. Notice | |
4359 | how this code takes advantage of the symbols defined by the linker | |
4360 | script. | |
4361 | ||
4362 | @smallexample | |
4363 | @group | |
4364 | extern char _etext, _data, _edata, _bstart, _bend; | |
4365 | char *src = &_etext; | |
4366 | char *dst = &_data; | |
4367 | ||
4368 | /* ROM has data at end of text; copy it. */ | |
4369 | while (dst < &_edata) @{ | |
4370 | *dst++ = *src++; | |
4371 | @} | |
4372 | ||
4373 | /* Zero bss */ | |
4374 | for (dst = &_bstart; dst< &_bend; dst++) | |
4375 | *dst = 0; | |
4376 | @end group | |
4377 | @end smallexample | |
4378 | ||
bbf115d3 L |
4379 | @node Forced Output Alignment |
4380 | @subsubsection Forced Output Alignment | |
4381 | @kindex ALIGN(@var{section_align}) | |
4382 | @cindex forcing output section alignment | |
4383 | @cindex output section alignment | |
7270c5ed | 4384 | You can increase an output section's alignment by using ALIGN. |
bbf115d3 | 4385 | |
7e7d5768 AM |
4386 | @node Forced Input Alignment |
4387 | @subsubsection Forced Input Alignment | |
4388 | @kindex SUBALIGN(@var{subsection_align}) | |
4389 | @cindex forcing input section alignment | |
4390 | @cindex input section alignment | |
4391 | You can force input section alignment within an output section by using | |
4392 | SUBALIGN. The value specified overrides any alignment given by input | |
4393 | sections, whether larger or smaller. | |
4394 | ||
0c71d759 NC |
4395 | @node Output Section Constraint |
4396 | @subsubsection Output Section Constraint | |
4397 | @kindex ONLY_IF_RO | |
4398 | @kindex ONLY_IF_RW | |
4399 | @cindex constraints on output sections | |
4400 | You can specify that an output section should only be created if all | |
4401 | of its input sections are read-only or all of its input sections are | |
4402 | read-write by using the keyword @code{ONLY_IF_RO} and | |
4403 | @code{ONLY_IF_RW} respectively. | |
4404 | ||
252b5132 | 4405 | @node Output Section Region |
36f63dca | 4406 | @subsubsection Output Section Region |
252b5132 RH |
4407 | @kindex >@var{region} |
4408 | @cindex section, assigning to memory region | |
4409 | @cindex memory regions and sections | |
4410 | You can assign a section to a previously defined region of memory by | |
4411 | using @samp{>@var{region}}. @xref{MEMORY}. | |
4412 | ||
4413 | Here is a simple example: | |
4414 | @smallexample | |
4415 | @group | |
4416 | MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @} | |
4417 | SECTIONS @{ ROM : @{ *(.text) @} >rom @} | |
4418 | @end group | |
4419 | @end smallexample | |
4420 | ||
4421 | @node Output Section Phdr | |
36f63dca | 4422 | @subsubsection Output Section Phdr |
252b5132 RH |
4423 | @kindex :@var{phdr} |
4424 | @cindex section, assigning to program header | |
4425 | @cindex program headers and sections | |
4426 | You can assign a section to a previously defined program segment by | |
4427 | using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to | |
4428 | one or more segments, then all subsequent allocated sections will be | |
4429 | assigned to those segments as well, unless they use an explicitly | |
4430 | @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the | |
4431 | linker to not put the section in any segment at all. | |
4432 | ||
4433 | Here is a simple example: | |
4434 | @smallexample | |
4435 | @group | |
4436 | PHDRS @{ text PT_LOAD ; @} | |
4437 | SECTIONS @{ .text : @{ *(.text) @} :text @} | |
4438 | @end group | |
4439 | @end smallexample | |
4440 | ||
4441 | @node Output Section Fill | |
36f63dca | 4442 | @subsubsection Output Section Fill |
252b5132 RH |
4443 | @kindex =@var{fillexp} |
4444 | @cindex section fill pattern | |
4445 | @cindex fill pattern, entire section | |
4446 | You can set the fill pattern for an entire section by using | |
4447 | @samp{=@var{fillexp}}. @var{fillexp} is an expression | |
4448 | (@pxref{Expressions}). Any otherwise unspecified regions of memory | |
4449 | within the output section (for example, gaps left due to the required | |
a139d329 AM |
4450 | alignment of input sections) will be filled with the value, repeated as |
4451 | necessary. If the fill expression is a simple hex number, ie. a string | |
9673c93c | 4452 | of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then |
a139d329 AM |
4453 | an arbitrarily long sequence of hex digits can be used to specify the |
4454 | fill pattern; Leading zeros become part of the pattern too. For all | |
9673c93c | 4455 | other cases, including extra parentheses or a unary @code{+}, the fill |
a139d329 AM |
4456 | pattern is the four least significant bytes of the value of the |
4457 | expression. In all cases, the number is big-endian. | |
252b5132 RH |
4458 | |
4459 | You can also change the fill value with a @code{FILL} command in the | |
9673c93c | 4460 | output section commands; (@pxref{Output Section Data}). |
252b5132 RH |
4461 | |
4462 | Here is a simple example: | |
4463 | @smallexample | |
4464 | @group | |
563e308f | 4465 | SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @} |
252b5132 RH |
4466 | @end group |
4467 | @end smallexample | |
4468 | ||
4469 | @node Overlay Description | |
36f63dca | 4470 | @subsection Overlay Description |
252b5132 RH |
4471 | @kindex OVERLAY |
4472 | @cindex overlays | |
4473 | An overlay description provides an easy way to describe sections which | |
4474 | are to be loaded as part of a single memory image but are to be run at | |
4475 | the same memory address. At run time, some sort of overlay manager will | |
4476 | copy the overlaid sections in and out of the runtime memory address as | |
4477 | required, perhaps by simply manipulating addressing bits. This approach | |
4478 | can be useful, for example, when a certain region of memory is faster | |
4479 | than another. | |
4480 | ||
4481 | Overlays are described using the @code{OVERLAY} command. The | |
4482 | @code{OVERLAY} command is used within a @code{SECTIONS} command, like an | |
4483 | output section description. The full syntax of the @code{OVERLAY} | |
4484 | command is as follows: | |
4485 | @smallexample | |
4486 | @group | |
4487 | OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )] | |
4488 | @{ | |
4489 | @var{secname1} | |
4490 | @{ | |
4491 | @var{output-section-command} | |
4492 | @var{output-section-command} | |
4493 | @dots{} | |
4494 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
4495 | @var{secname2} | |
4496 | @{ | |
4497 | @var{output-section-command} | |
4498 | @var{output-section-command} | |
4499 | @dots{} | |
4500 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
4501 | @dots{} | |
4502 | @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] | |
4503 | @end group | |
4504 | @end smallexample | |
4505 | ||
4506 | Everything is optional except @code{OVERLAY} (a keyword), and each | |
4507 | section must have a name (@var{secname1} and @var{secname2} above). The | |
4508 | section definitions within the @code{OVERLAY} construct are identical to | |
4509 | those within the general @code{SECTIONS} contruct (@pxref{SECTIONS}), | |
4510 | except that no addresses and no memory regions may be defined for | |
4511 | sections within an @code{OVERLAY}. | |
4512 | ||
4513 | The sections are all defined with the same starting address. The load | |
4514 | addresses of the sections are arranged such that they are consecutive in | |
4515 | memory starting at the load address used for the @code{OVERLAY} as a | |
4516 | whole (as with normal section definitions, the load address is optional, | |
4517 | and defaults to the start address; the start address is also optional, | |
4518 | and defaults to the current value of the location counter). | |
4519 | ||
4520 | If the @code{NOCROSSREFS} keyword is used, and there any references | |
4521 | among the sections, the linker will report an error. Since the sections | |
4522 | all run at the same address, it normally does not make sense for one | |
4523 | section to refer directly to another. @xref{Miscellaneous Commands, | |
4524 | NOCROSSREFS}. | |
4525 | ||
4526 | For each section within the @code{OVERLAY}, the linker automatically | |
34711ca3 | 4527 | provides two symbols. The symbol @code{__load_start_@var{secname}} is |
252b5132 RH |
4528 | defined as the starting load address of the section. The symbol |
4529 | @code{__load_stop_@var{secname}} is defined as the final load address of | |
4530 | the section. Any characters within @var{secname} which are not legal | |
4531 | within C identifiers are removed. C (or assembler) code may use these | |
4532 | symbols to move the overlaid sections around as necessary. | |
4533 | ||
4534 | At the end of the overlay, the value of the location counter is set to | |
4535 | the start address of the overlay plus the size of the largest section. | |
4536 | ||
4537 | Here is an example. Remember that this would appear inside a | |
4538 | @code{SECTIONS} construct. | |
4539 | @smallexample | |
4540 | @group | |
4541 | OVERLAY 0x1000 : AT (0x4000) | |
4542 | @{ | |
4543 | .text0 @{ o1/*.o(.text) @} | |
4544 | .text1 @{ o2/*.o(.text) @} | |
4545 | @} | |
4546 | @end group | |
4547 | @end smallexample | |
4548 | @noindent | |
4549 | This will define both @samp{.text0} and @samp{.text1} to start at | |
4550 | address 0x1000. @samp{.text0} will be loaded at address 0x4000, and | |
4551 | @samp{.text1} will be loaded immediately after @samp{.text0}. The | |
34711ca3 | 4552 | following symbols will be defined if referenced: @code{__load_start_text0}, |
252b5132 RH |
4553 | @code{__load_stop_text0}, @code{__load_start_text1}, |
4554 | @code{__load_stop_text1}. | |
4555 | ||
4556 | C code to copy overlay @code{.text1} into the overlay area might look | |
4557 | like the following. | |
4558 | ||
4559 | @smallexample | |
4560 | @group | |
4561 | extern char __load_start_text1, __load_stop_text1; | |
4562 | memcpy ((char *) 0x1000, &__load_start_text1, | |
4563 | &__load_stop_text1 - &__load_start_text1); | |
4564 | @end group | |
4565 | @end smallexample | |
4566 | ||
4567 | Note that the @code{OVERLAY} command is just syntactic sugar, since | |
4568 | everything it does can be done using the more basic commands. The above | |
4569 | example could have been written identically as follows. | |
4570 | ||
4571 | @smallexample | |
4572 | @group | |
4573 | .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @} | |
34711ca3 AM |
4574 | PROVIDE (__load_start_text0 = LOADADDR (.text0)); |
4575 | PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0)); | |
252b5132 | 4576 | .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @} |
34711ca3 AM |
4577 | PROVIDE (__load_start_text1 = LOADADDR (.text1)); |
4578 | PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1)); | |
252b5132 RH |
4579 | . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1)); |
4580 | @end group | |
4581 | @end smallexample | |
4582 | ||
4583 | @node MEMORY | |
36f63dca | 4584 | @section MEMORY Command |
252b5132 RH |
4585 | @kindex MEMORY |
4586 | @cindex memory regions | |
4587 | @cindex regions of memory | |
4588 | @cindex allocating memory | |
4589 | @cindex discontinuous memory | |
4590 | The linker's default configuration permits allocation of all available | |
4591 | memory. You can override this by using the @code{MEMORY} command. | |
4592 | ||
4593 | The @code{MEMORY} command describes the location and size of blocks of | |
4594 | memory in the target. You can use it to describe which memory regions | |
4595 | may be used by the linker, and which memory regions it must avoid. You | |
4596 | can then assign sections to particular memory regions. The linker will | |
4597 | set section addresses based on the memory regions, and will warn about | |
4598 | regions that become too full. The linker will not shuffle sections | |
4599 | around to fit into the available regions. | |
4600 | ||
4601 | A linker script may contain at most one use of the @code{MEMORY} | |
4602 | command. However, you can define as many blocks of memory within it as | |
4603 | you wish. The syntax is: | |
4604 | @smallexample | |
4605 | @group | |
a1ab1d2a | 4606 | MEMORY |
252b5132 RH |
4607 | @{ |
4608 | @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len} | |
4609 | @dots{} | |
4610 | @} | |
4611 | @end group | |
4612 | @end smallexample | |
4613 | ||
4614 | The @var{name} is a name used in the linker script to refer to the | |
4615 | region. The region name has no meaning outside of the linker script. | |
4616 | Region names are stored in a separate name space, and will not conflict | |
4617 | with symbol names, file names, or section names. Each memory region | |
4a93e180 NC |
4618 | must have a distinct name within the @code{MEMORY} command. However you can |
4619 | add later alias names to existing memory regions with the @ref{REGION_ALIAS} | |
4620 | command. | |
252b5132 RH |
4621 | |
4622 | @cindex memory region attributes | |
4623 | The @var{attr} string is an optional list of attributes that specify | |
4624 | whether to use a particular memory region for an input section which is | |
4625 | not explicitly mapped in the linker script. As described in | |
4626 | @ref{SECTIONS}, if you do not specify an output section for some input | |
4627 | section, the linker will create an output section with the same name as | |
4628 | the input section. If you define region attributes, the linker will use | |
4629 | them to select the memory region for the output section that it creates. | |
4630 | ||
4631 | The @var{attr} string must consist only of the following characters: | |
4632 | @table @samp | |
4633 | @item R | |
4634 | Read-only section | |
4635 | @item W | |
4636 | Read/write section | |
4637 | @item X | |
4638 | Executable section | |
4639 | @item A | |
4640 | Allocatable section | |
4641 | @item I | |
4642 | Initialized section | |
4643 | @item L | |
4644 | Same as @samp{I} | |
4645 | @item ! | |
4646 | Invert the sense of any of the preceding attributes | |
4647 | @end table | |
4648 | ||
4649 | If a unmapped section matches any of the listed attributes other than | |
4650 | @samp{!}, it will be placed in the memory region. The @samp{!} | |
4651 | attribute reverses this test, so that an unmapped section will be placed | |
4652 | in the memory region only if it does not match any of the listed | |
4653 | attributes. | |
4654 | ||
4655 | @kindex ORIGIN = | |
4656 | @kindex o = | |
4657 | @kindex org = | |
9cd6d51a NC |
4658 | The @var{origin} is an numerical expression for the start address of |
4659 | the memory region. The expression must evaluate to a constant and it | |
4660 | cannot involve any symbols. The keyword @code{ORIGIN} may be | |
4661 | abbreviated to @code{org} or @code{o} (but not, for example, | |
4662 | @code{ORG}). | |
252b5132 RH |
4663 | |
4664 | @kindex LENGTH = | |
4665 | @kindex len = | |
4666 | @kindex l = | |
4667 | The @var{len} is an expression for the size in bytes of the memory | |
4668 | region. As with the @var{origin} expression, the expression must | |
9cd6d51a NC |
4669 | be numerical only and must evaluate to a constant. The keyword |
4670 | @code{LENGTH} may be abbreviated to @code{len} or @code{l}. | |
252b5132 RH |
4671 | |
4672 | In the following example, we specify that there are two memory regions | |
4673 | available for allocation: one starting at @samp{0} for 256 kilobytes, | |
4674 | and the other starting at @samp{0x40000000} for four megabytes. The | |
4675 | linker will place into the @samp{rom} memory region every section which | |
4676 | is not explicitly mapped into a memory region, and is either read-only | |
4677 | or executable. The linker will place other sections which are not | |
4678 | explicitly mapped into a memory region into the @samp{ram} memory | |
4679 | region. | |
4680 | ||
4681 | @smallexample | |
4682 | @group | |
a1ab1d2a | 4683 | MEMORY |
252b5132 RH |
4684 | @{ |
4685 | rom (rx) : ORIGIN = 0, LENGTH = 256K | |
4686 | ram (!rx) : org = 0x40000000, l = 4M | |
4687 | @} | |
4688 | @end group | |
4689 | @end smallexample | |
4690 | ||
4691 | Once you define a memory region, you can direct the linker to place | |
4692 | specific output sections into that memory region by using the | |
4693 | @samp{>@var{region}} output section attribute. For example, if you have | |
4694 | a memory region named @samp{mem}, you would use @samp{>mem} in the | |
4695 | output section definition. @xref{Output Section Region}. If no address | |
4696 | was specified for the output section, the linker will set the address to | |
4697 | the next available address within the memory region. If the combined | |
4698 | output sections directed to a memory region are too large for the | |
4699 | region, the linker will issue an error message. | |
4700 | ||
3ec57632 | 4701 | It is possible to access the origin and length of a memory in an |
c0065db7 | 4702 | expression via the @code{ORIGIN(@var{memory})} and |
3ec57632 NC |
4703 | @code{LENGTH(@var{memory})} functions: |
4704 | ||
4705 | @smallexample | |
4706 | @group | |
c0065db7 | 4707 | _fstack = ORIGIN(ram) + LENGTH(ram) - 4; |
3ec57632 NC |
4708 | @end group |
4709 | @end smallexample | |
4710 | ||
252b5132 RH |
4711 | @node PHDRS |
4712 | @section PHDRS Command | |
4713 | @kindex PHDRS | |
4714 | @cindex program headers | |
4715 | @cindex ELF program headers | |
4716 | @cindex program segments | |
4717 | @cindex segments, ELF | |
4718 | The ELF object file format uses @dfn{program headers}, also knows as | |
4719 | @dfn{segments}. The program headers describe how the program should be | |
4720 | loaded into memory. You can print them out by using the @code{objdump} | |
4721 | program with the @samp{-p} option. | |
4722 | ||
4723 | When you run an ELF program on a native ELF system, the system loader | |
4724 | reads the program headers in order to figure out how to load the | |
4725 | program. This will only work if the program headers are set correctly. | |
4726 | This manual does not describe the details of how the system loader | |
4727 | interprets program headers; for more information, see the ELF ABI. | |
4728 | ||
4729 | The linker will create reasonable program headers by default. However, | |
4730 | in some cases, you may need to specify the program headers more | |
4731 | precisely. You may use the @code{PHDRS} command for this purpose. When | |
4732 | the linker sees the @code{PHDRS} command in the linker script, it will | |
4733 | not create any program headers other than the ones specified. | |
4734 | ||
4735 | The linker only pays attention to the @code{PHDRS} command when | |
4736 | generating an ELF output file. In other cases, the linker will simply | |
4737 | ignore @code{PHDRS}. | |
4738 | ||
4739 | This is the syntax of the @code{PHDRS} command. The words @code{PHDRS}, | |
4740 | @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords. | |
4741 | ||
4742 | @smallexample | |
4743 | @group | |
4744 | PHDRS | |
4745 | @{ | |
4746 | @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ] | |
4747 | [ FLAGS ( @var{flags} ) ] ; | |
4748 | @} | |
4749 | @end group | |
4750 | @end smallexample | |
4751 | ||
4752 | The @var{name} is used only for reference in the @code{SECTIONS} command | |
4753 | of the linker script. It is not put into the output file. Program | |
4754 | header names are stored in a separate name space, and will not conflict | |
4755 | with symbol names, file names, or section names. Each program header | |
5c1a3f0f NS |
4756 | must have a distinct name. The headers are processed in order and it |
4757 | is usual for them to map to sections in ascending load address order. | |
252b5132 RH |
4758 | |
4759 | Certain program header types describe segments of memory which the | |
4760 | system loader will load from the file. In the linker script, you | |
4761 | specify the contents of these segments by placing allocatable output | |
4762 | sections in the segments. You use the @samp{:@var{phdr}} output section | |
4763 | attribute to place a section in a particular segment. @xref{Output | |
4764 | Section Phdr}. | |
4765 | ||
4766 | It is normal to put certain sections in more than one segment. This | |
4767 | merely implies that one segment of memory contains another. You may | |
4768 | repeat @samp{:@var{phdr}}, using it once for each segment which should | |
4769 | contain the section. | |
4770 | ||
4771 | If you place a section in one or more segments using @samp{:@var{phdr}}, | |
4772 | then the linker will place all subsequent allocatable sections which do | |
4773 | not specify @samp{:@var{phdr}} in the same segments. This is for | |
4774 | convenience, since generally a whole set of contiguous sections will be | |
4775 | placed in a single segment. You can use @code{:NONE} to override the | |
4776 | default segment and tell the linker to not put the section in any | |
4777 | segment at all. | |
4778 | ||
4779 | @kindex FILEHDR | |
4780 | @kindex PHDRS | |
5c1a3f0f | 4781 | You may use the @code{FILEHDR} and @code{PHDRS} keywords after |
252b5132 RH |
4782 | the program header type to further describe the contents of the segment. |
4783 | The @code{FILEHDR} keyword means that the segment should include the ELF | |
4784 | file header. The @code{PHDRS} keyword means that the segment should | |
5c1a3f0f | 4785 | include the ELF program headers themselves. If applied to a loadable |
4100cea3 AM |
4786 | segment (@code{PT_LOAD}), all prior loadable segments must have one of |
4787 | these keywords. | |
252b5132 RH |
4788 | |
4789 | The @var{type} may be one of the following. The numbers indicate the | |
4790 | value of the keyword. | |
4791 | ||
4792 | @table @asis | |
4793 | @item @code{PT_NULL} (0) | |
4794 | Indicates an unused program header. | |
4795 | ||
4796 | @item @code{PT_LOAD} (1) | |
4797 | Indicates that this program header describes a segment to be loaded from | |
4798 | the file. | |
4799 | ||
4800 | @item @code{PT_DYNAMIC} (2) | |
4801 | Indicates a segment where dynamic linking information can be found. | |
4802 | ||
4803 | @item @code{PT_INTERP} (3) | |
4804 | Indicates a segment where the name of the program interpreter may be | |
4805 | found. | |
4806 | ||
4807 | @item @code{PT_NOTE} (4) | |
4808 | Indicates a segment holding note information. | |
4809 | ||
4810 | @item @code{PT_SHLIB} (5) | |
4811 | A reserved program header type, defined but not specified by the ELF | |
4812 | ABI. | |
4813 | ||
4814 | @item @code{PT_PHDR} (6) | |
4815 | Indicates a segment where the program headers may be found. | |
4816 | ||
4817 | @item @var{expression} | |
4818 | An expression giving the numeric type of the program header. This may | |
4819 | be used for types not defined above. | |
4820 | @end table | |
4821 | ||
4822 | You can specify that a segment should be loaded at a particular address | |
4823 | in memory by using an @code{AT} expression. This is identical to the | |
4824 | @code{AT} command used as an output section attribute (@pxref{Output | |
4825 | Section LMA}). The @code{AT} command for a program header overrides the | |
4826 | output section attribute. | |
4827 | ||
4828 | The linker will normally set the segment flags based on the sections | |
4829 | which comprise the segment. You may use the @code{FLAGS} keyword to | |
4830 | explicitly specify the segment flags. The value of @var{flags} must be | |
4831 | an integer. It is used to set the @code{p_flags} field of the program | |
4832 | header. | |
4833 | ||
4834 | Here is an example of @code{PHDRS}. This shows a typical set of program | |
4835 | headers used on a native ELF system. | |
4836 | ||
4837 | @example | |
4838 | @group | |
4839 | PHDRS | |
4840 | @{ | |
4841 | headers PT_PHDR PHDRS ; | |
4842 | interp PT_INTERP ; | |
4843 | text PT_LOAD FILEHDR PHDRS ; | |
4844 | data PT_LOAD ; | |
4845 | dynamic PT_DYNAMIC ; | |
4846 | @} | |
4847 | ||
4848 | SECTIONS | |
4849 | @{ | |
4850 | . = SIZEOF_HEADERS; | |
4851 | .interp : @{ *(.interp) @} :text :interp | |
4852 | .text : @{ *(.text) @} :text | |
4853 | .rodata : @{ *(.rodata) @} /* defaults to :text */ | |
4854 | @dots{} | |
4855 | . = . + 0x1000; /* move to a new page in memory */ | |
4856 | .data : @{ *(.data) @} :data | |
4857 | .dynamic : @{ *(.dynamic) @} :data :dynamic | |
4858 | @dots{} | |
4859 | @} | |
4860 | @end group | |
4861 | @end example | |
4862 | ||
4863 | @node VERSION | |
4864 | @section VERSION Command | |
4865 | @kindex VERSION @{script text@} | |
4866 | @cindex symbol versions | |
4867 | @cindex version script | |
4868 | @cindex versions of symbols | |
4869 | The linker supports symbol versions when using ELF. Symbol versions are | |
4870 | only useful when using shared libraries. The dynamic linker can use | |
4871 | symbol versions to select a specific version of a function when it runs | |
4872 | a program that may have been linked against an earlier version of the | |
4873 | shared library. | |
4874 | ||
4875 | You can include a version script directly in the main linker script, or | |
4876 | you can supply the version script as an implicit linker script. You can | |
4877 | also use the @samp{--version-script} linker option. | |
4878 | ||
4879 | The syntax of the @code{VERSION} command is simply | |
4880 | @smallexample | |
4881 | VERSION @{ version-script-commands @} | |
4882 | @end smallexample | |
4883 | ||
4884 | The format of the version script commands is identical to that used by | |
4885 | Sun's linker in Solaris 2.5. The version script defines a tree of | |
4886 | version nodes. You specify the node names and interdependencies in the | |
4887 | version script. You can specify which symbols are bound to which | |
4888 | version nodes, and you can reduce a specified set of symbols to local | |
4889 | scope so that they are not globally visible outside of the shared | |
4890 | library. | |
4891 | ||
4892 | The easiest way to demonstrate the version script language is with a few | |
4893 | examples. | |
4894 | ||
4895 | @smallexample | |
4896 | VERS_1.1 @{ | |
4897 | global: | |
4898 | foo1; | |
4899 | local: | |
a1ab1d2a UD |
4900 | old*; |
4901 | original*; | |
4902 | new*; | |
252b5132 RH |
4903 | @}; |
4904 | ||
4905 | VERS_1.2 @{ | |
4906 | foo2; | |
4907 | @} VERS_1.1; | |
4908 | ||
4909 | VERS_2.0 @{ | |
4910 | bar1; bar2; | |
c0065db7 | 4911 | extern "C++" @{ |
86043bbb | 4912 | ns::*; |
bb1515f2 MF |
4913 | "f(int, double)"; |
4914 | @}; | |
252b5132 RH |
4915 | @} VERS_1.2; |
4916 | @end smallexample | |
4917 | ||
4918 | This example version script defines three version nodes. The first | |
4919 | version node defined is @samp{VERS_1.1}; it has no other dependencies. | |
4920 | The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces | |
4921 | a number of symbols to local scope so that they are not visible outside | |
313e35ee AM |
4922 | of the shared library; this is done using wildcard patterns, so that any |
4923 | symbol whose name begins with @samp{old}, @samp{original}, or @samp{new} | |
4924 | is matched. The wildcard patterns available are the same as those used | |
4925 | in the shell when matching filenames (also known as ``globbing''). | |
86043bbb MM |
4926 | However, if you specify the symbol name inside double quotes, then the |
4927 | name is treated as literal, rather than as a glob pattern. | |
252b5132 RH |
4928 | |
4929 | Next, the version script defines node @samp{VERS_1.2}. This node | |
4930 | depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2} | |
4931 | to the version node @samp{VERS_1.2}. | |
4932 | ||
4933 | Finally, the version script defines node @samp{VERS_2.0}. This node | |
4934 | depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1} | |
4935 | and @samp{bar2} are bound to the version node @samp{VERS_2.0}. | |
4936 | ||
4937 | When the linker finds a symbol defined in a library which is not | |
4938 | specifically bound to a version node, it will effectively bind it to an | |
4939 | unspecified base version of the library. You can bind all otherwise | |
a981ed6f | 4940 | unspecified symbols to a given version node by using @samp{global: *;} |
ae5a3597 AM |
4941 | somewhere in the version script. Note that it's slightly crazy to use |
4942 | wildcards in a global spec except on the last version node. Global | |
4943 | wildcards elsewhere run the risk of accidentally adding symbols to the | |
4944 | set exported for an old version. That's wrong since older versions | |
4945 | ought to have a fixed set of symbols. | |
252b5132 RH |
4946 | |
4947 | The names of the version nodes have no specific meaning other than what | |
4948 | they might suggest to the person reading them. The @samp{2.0} version | |
4949 | could just as well have appeared in between @samp{1.1} and @samp{1.2}. | |
4950 | However, this would be a confusing way to write a version script. | |
4951 | ||
0f6bf451 | 4952 | Node name can be omitted, provided it is the only version node |
6b9b879a JJ |
4953 | in the version script. Such version script doesn't assign any versions to |
4954 | symbols, only selects which symbols will be globally visible out and which | |
4955 | won't. | |
4956 | ||
4957 | @smallexample | |
7c9c73be | 4958 | @{ global: foo; bar; local: *; @}; |
9d201f2f | 4959 | @end smallexample |
6b9b879a | 4960 | |
252b5132 RH |
4961 | When you link an application against a shared library that has versioned |
4962 | symbols, the application itself knows which version of each symbol it | |
4963 | requires, and it also knows which version nodes it needs from each | |
4964 | shared library it is linked against. Thus at runtime, the dynamic | |
4965 | loader can make a quick check to make sure that the libraries you have | |
4966 | linked against do in fact supply all of the version nodes that the | |
4967 | application will need to resolve all of the dynamic symbols. In this | |
4968 | way it is possible for the dynamic linker to know with certainty that | |
4969 | all external symbols that it needs will be resolvable without having to | |
4970 | search for each symbol reference. | |
4971 | ||
4972 | The symbol versioning is in effect a much more sophisticated way of | |
4973 | doing minor version checking that SunOS does. The fundamental problem | |
4974 | that is being addressed here is that typically references to external | |
4975 | functions are bound on an as-needed basis, and are not all bound when | |
4976 | the application starts up. If a shared library is out of date, a | |
4977 | required interface may be missing; when the application tries to use | |
4978 | that interface, it may suddenly and unexpectedly fail. With symbol | |
4979 | versioning, the user will get a warning when they start their program if | |
4980 | the libraries being used with the application are too old. | |
4981 | ||
4982 | There are several GNU extensions to Sun's versioning approach. The | |
4983 | first of these is the ability to bind a symbol to a version node in the | |
4984 | source file where the symbol is defined instead of in the versioning | |
4985 | script. This was done mainly to reduce the burden on the library | |
4986 | maintainer. You can do this by putting something like: | |
4987 | @smallexample | |
4988 | __asm__(".symver original_foo,foo@@VERS_1.1"); | |
4989 | @end smallexample | |
4990 | @noindent | |
4991 | in the C source file. This renames the function @samp{original_foo} to | |
4992 | be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}. | |
4993 | The @samp{local:} directive can be used to prevent the symbol | |
96a94295 L |
4994 | @samp{original_foo} from being exported. A @samp{.symver} directive |
4995 | takes precedence over a version script. | |
252b5132 RH |
4996 | |
4997 | The second GNU extension is to allow multiple versions of the same | |
4998 | function to appear in a given shared library. In this way you can make | |
4999 | an incompatible change to an interface without increasing the major | |
5000 | version number of the shared library, while still allowing applications | |
5001 | linked against the old interface to continue to function. | |
5002 | ||
5003 | To do this, you must use multiple @samp{.symver} directives in the | |
5004 | source file. Here is an example: | |
5005 | ||
5006 | @smallexample | |
5007 | __asm__(".symver original_foo,foo@@"); | |
5008 | __asm__(".symver old_foo,foo@@VERS_1.1"); | |
5009 | __asm__(".symver old_foo1,foo@@VERS_1.2"); | |
5010 | __asm__(".symver new_foo,foo@@@@VERS_2.0"); | |
5011 | @end smallexample | |
5012 | ||
5013 | In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the | |
5014 | unspecified base version of the symbol. The source file that contains this | |
5015 | example would define 4 C functions: @samp{original_foo}, @samp{old_foo}, | |
5016 | @samp{old_foo1}, and @samp{new_foo}. | |
5017 | ||
5018 | When you have multiple definitions of a given symbol, there needs to be | |
5019 | some way to specify a default version to which external references to | |
5020 | this symbol will be bound. You can do this with the | |
5021 | @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only | |
5022 | declare one version of a symbol as the default in this manner; otherwise | |
5023 | you would effectively have multiple definitions of the same symbol. | |
5024 | ||
5025 | If you wish to bind a reference to a specific version of the symbol | |
5026 | within the shared library, you can use the aliases of convenience | |
36f63dca | 5027 | (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to |
252b5132 RH |
5028 | specifically bind to an external version of the function in question. |
5029 | ||
cb840a31 L |
5030 | You can also specify the language in the version script: |
5031 | ||
5032 | @smallexample | |
5033 | VERSION extern "lang" @{ version-script-commands @} | |
5034 | @end smallexample | |
5035 | ||
c0065db7 | 5036 | The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}. |
cb840a31 L |
5037 | The linker will iterate over the list of symbols at the link time and |
5038 | demangle them according to @samp{lang} before matching them to the | |
bb1515f2 MF |
5039 | patterns specified in @samp{version-script-commands}. The default |
5040 | @samp{lang} is @samp{C}. | |
cb840a31 | 5041 | |
86043bbb MM |
5042 | Demangled names may contains spaces and other special characters. As |
5043 | described above, you can use a glob pattern to match demangled names, | |
5044 | or you can use a double-quoted string to match the string exactly. In | |
5045 | the latter case, be aware that minor differences (such as differing | |
5046 | whitespace) between the version script and the demangler output will | |
5047 | cause a mismatch. As the exact string generated by the demangler | |
5048 | might change in the future, even if the mangled name does not, you | |
5049 | should check that all of your version directives are behaving as you | |
5050 | expect when you upgrade. | |
5051 | ||
252b5132 RH |
5052 | @node Expressions |
5053 | @section Expressions in Linker Scripts | |
5054 | @cindex expressions | |
5055 | @cindex arithmetic | |
5056 | The syntax for expressions in the linker script language is identical to | |
5057 | that of C expressions. All expressions are evaluated as integers. All | |
5058 | expressions are evaluated in the same size, which is 32 bits if both the | |
5059 | host and target are 32 bits, and is otherwise 64 bits. | |
5060 | ||
5061 | You can use and set symbol values in expressions. | |
5062 | ||
5063 | The linker defines several special purpose builtin functions for use in | |
5064 | expressions. | |
5065 | ||
5066 | @menu | |
5067 | * Constants:: Constants | |
0c71d759 | 5068 | * Symbolic Constants:: Symbolic constants |
252b5132 | 5069 | * Symbols:: Symbol Names |
ecca9871 | 5070 | * Orphan Sections:: Orphan Sections |
252b5132 RH |
5071 | * Location Counter:: The Location Counter |
5072 | * Operators:: Operators | |
5073 | * Evaluation:: Evaluation | |
5074 | * Expression Section:: The Section of an Expression | |
5075 | * Builtin Functions:: Builtin Functions | |
5076 | @end menu | |
5077 | ||
5078 | @node Constants | |
5079 | @subsection Constants | |
5080 | @cindex integer notation | |
5081 | @cindex constants in linker scripts | |
5082 | All constants are integers. | |
5083 | ||
5084 | As in C, the linker considers an integer beginning with @samp{0} to be | |
5085 | octal, and an integer beginning with @samp{0x} or @samp{0X} to be | |
8a308ae8 NC |
5086 | hexadecimal. Alternatively the linker accepts suffixes of @samp{h} or |
5087 | @samp{H} for hexadeciaml, @samp{o} or @samp{O} for octal, @samp{b} or | |
5088 | @samp{B} for binary and @samp{d} or @samp{D} for decimal. Any integer | |
5089 | value without a prefix or a suffix is considered to be decimal. | |
252b5132 RH |
5090 | |
5091 | @cindex scaled integers | |
5092 | @cindex K and M integer suffixes | |
5093 | @cindex M and K integer suffixes | |
5094 | @cindex suffixes for integers | |
5095 | @cindex integer suffixes | |
5096 | In addition, you can use the suffixes @code{K} and @code{M} to scale a | |
5097 | constant by | |
5098 | @c TEXI2ROFF-KILL | |
36f63dca | 5099 | @ifnottex |
252b5132 RH |
5100 | @c END TEXI2ROFF-KILL |
5101 | @code{1024} or @code{1024*1024} | |
5102 | @c TEXI2ROFF-KILL | |
36f63dca | 5103 | @end ifnottex |
252b5132 RH |
5104 | @tex |
5105 | ${\rm 1024}$ or ${\rm 1024}^2$ | |
5106 | @end tex | |
5107 | @c END TEXI2ROFF-KILL | |
8a308ae8 NC |
5108 | respectively. For example, the following |
5109 | all refer to the same quantity: | |
5110 | ||
252b5132 | 5111 | @smallexample |
36f63dca NC |
5112 | _fourk_1 = 4K; |
5113 | _fourk_2 = 4096; | |
5114 | _fourk_3 = 0x1000; | |
8a308ae8 | 5115 | _fourk_4 = 10000o; |
252b5132 RH |
5116 | @end smallexample |
5117 | ||
8a308ae8 NC |
5118 | Note - the @code{K} and @code{M} suffixes cannot be used in |
5119 | conjunction with the base suffixes mentioned above. | |
5120 | ||
0c71d759 NC |
5121 | @node Symbolic Constants |
5122 | @subsection Symbolic Constants | |
5123 | @cindex symbolic constants | |
5124 | @kindex CONSTANT | |
5125 | It is possible to refer to target specific constants via the use of | |
5126 | the @code{CONSTANT(@var{name})} operator, where @var{name} is one of: | |
5127 | ||
5128 | @table @code | |
5129 | @item MAXPAGESIZE | |
5130 | @kindex MAXPAGESIZE | |
5131 | The target's maximum page size. | |
5132 | ||
5133 | @item COMMONPAGESIZE | |
5134 | @kindex COMMONPAGESIZE | |
5135 | The target's default page size. | |
5136 | @end table | |
5137 | ||
5138 | So for example: | |
5139 | ||
5140 | @smallexample | |
5141 | .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @} | |
5142 | @end smallexample | |
5143 | ||
5144 | will create a text section aligned to the largest page boundary | |
5145 | supported by the target. | |
5146 | ||
252b5132 RH |
5147 | @node Symbols |
5148 | @subsection Symbol Names | |
5149 | @cindex symbol names | |
5150 | @cindex names | |
5151 | @cindex quoted symbol names | |
5152 | @kindex " | |
5153 | Unless quoted, symbol names start with a letter, underscore, or period | |
5154 | and may include letters, digits, underscores, periods, and hyphens. | |
5155 | Unquoted symbol names must not conflict with any keywords. You can | |
5156 | specify a symbol which contains odd characters or has the same name as a | |
5157 | keyword by surrounding the symbol name in double quotes: | |
5158 | @smallexample | |
36f63dca NC |
5159 | "SECTION" = 9; |
5160 | "with a space" = "also with a space" + 10; | |
252b5132 RH |
5161 | @end smallexample |
5162 | ||
5163 | Since symbols can contain many non-alphabetic characters, it is safest | |
5164 | to delimit symbols with spaces. For example, @samp{A-B} is one symbol, | |
5165 | whereas @samp{A - B} is an expression involving subtraction. | |
5166 | ||
ecca9871 L |
5167 | @node Orphan Sections |
5168 | @subsection Orphan Sections | |
5169 | @cindex orphan | |
5170 | Orphan sections are sections present in the input files which | |
5171 | are not explicitly placed into the output file by the linker | |
5172 | script. The linker will still copy these sections into the | |
5173 | output file, but it has to guess as to where they should be | |
5174 | placed. The linker uses a simple heuristic to do this. It | |
5175 | attempts to place orphan sections after non-orphan sections of the | |
5176 | same attribute, such as code vs data, loadable vs non-loadable, etc. | |
5177 | If there is not enough room to do this then it places | |
5178 | at the end of the file. | |
5179 | ||
5180 | For ELF targets, the attribute of the section includes section type as | |
5181 | well as section flag. | |
5182 | ||
41911f68 | 5183 | If an orphaned section's name is representable as a C identifier then |
a61ca861 | 5184 | the linker will automatically @pxref{PROVIDE} two symbols: |
41911f68 NC |
5185 | __start_SECNAME and __end_SECNAME, where SECNAME is the name of the |
5186 | section. These indicate the start address and end address of the | |
5187 | orphaned section respectively. Note: most section names are not | |
5188 | representable as C identifiers because they contain a @samp{.} | |
5189 | character. | |
5190 | ||
252b5132 RH |
5191 | @node Location Counter |
5192 | @subsection The Location Counter | |
5193 | @kindex . | |
5194 | @cindex dot | |
5195 | @cindex location counter | |
5196 | @cindex current output location | |
5197 | The special linker variable @dfn{dot} @samp{.} always contains the | |
5198 | current output location counter. Since the @code{.} always refers to a | |
5199 | location in an output section, it may only appear in an expression | |
5200 | within a @code{SECTIONS} command. The @code{.} symbol may appear | |
5201 | anywhere that an ordinary symbol is allowed in an expression. | |
5202 | ||
5203 | @cindex holes | |
5204 | Assigning a value to @code{.} will cause the location counter to be | |
5205 | moved. This may be used to create holes in the output section. The | |
dc0b6aa0 AM |
5206 | location counter may not be moved backwards inside an output section, |
5207 | and may not be moved backwards outside of an output section if so | |
5208 | doing creates areas with overlapping LMAs. | |
252b5132 RH |
5209 | |
5210 | @smallexample | |
5211 | SECTIONS | |
5212 | @{ | |
5213 | output : | |
5214 | @{ | |
5215 | file1(.text) | |
5216 | . = . + 1000; | |
5217 | file2(.text) | |
5218 | . += 1000; | |
5219 | file3(.text) | |
563e308f | 5220 | @} = 0x12345678; |
252b5132 RH |
5221 | @} |
5222 | @end smallexample | |
5223 | @noindent | |
5224 | In the previous example, the @samp{.text} section from @file{file1} is | |
5225 | located at the beginning of the output section @samp{output}. It is | |
5226 | followed by a 1000 byte gap. Then the @samp{.text} section from | |
5227 | @file{file2} appears, also with a 1000 byte gap following before the | |
563e308f | 5228 | @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678} |
252b5132 RH |
5229 | specifies what data to write in the gaps (@pxref{Output Section Fill}). |
5230 | ||
5c6bbab8 NC |
5231 | @cindex dot inside sections |
5232 | Note: @code{.} actually refers to the byte offset from the start of the | |
5233 | current containing object. Normally this is the @code{SECTIONS} | |
69da35b5 | 5234 | statement, whose start address is 0, hence @code{.} can be used as an |
5c6bbab8 NC |
5235 | absolute address. If @code{.} is used inside a section description |
5236 | however, it refers to the byte offset from the start of that section, | |
5237 | not an absolute address. Thus in a script like this: | |
5238 | ||
5239 | @smallexample | |
5240 | SECTIONS | |
5241 | @{ | |
5242 | . = 0x100 | |
5243 | .text: @{ | |
5244 | *(.text) | |
5245 | . = 0x200 | |
5246 | @} | |
5247 | . = 0x500 | |
5248 | .data: @{ | |
5249 | *(.data) | |
5250 | . += 0x600 | |
5251 | @} | |
5252 | @} | |
5253 | @end smallexample | |
5254 | ||
5255 | The @samp{.text} section will be assigned a starting address of 0x100 | |
5256 | and a size of exactly 0x200 bytes, even if there is not enough data in | |
5257 | the @samp{.text} input sections to fill this area. (If there is too | |
5258 | much data, an error will be produced because this would be an attempt to | |
5259 | move @code{.} backwards). The @samp{.data} section will start at 0x500 | |
5260 | and it will have an extra 0x600 bytes worth of space after the end of | |
5261 | the values from the @samp{.data} input sections and before the end of | |
5262 | the @samp{.data} output section itself. | |
5263 | ||
b5666f2f AM |
5264 | @cindex dot outside sections |
5265 | Setting symbols to the value of the location counter outside of an | |
5266 | output section statement can result in unexpected values if the linker | |
5267 | needs to place orphan sections. For example, given the following: | |
5268 | ||
5269 | @smallexample | |
5270 | SECTIONS | |
5271 | @{ | |
5272 | start_of_text = . ; | |
5273 | .text: @{ *(.text) @} | |
5274 | end_of_text = . ; | |
5275 | ||
5276 | start_of_data = . ; | |
5277 | .data: @{ *(.data) @} | |
5278 | end_of_data = . ; | |
5279 | @} | |
5280 | @end smallexample | |
5281 | ||
5282 | If the linker needs to place some input section, e.g. @code{.rodata}, | |
5283 | not mentioned in the script, it might choose to place that section | |
5284 | between @code{.text} and @code{.data}. You might think the linker | |
5285 | should place @code{.rodata} on the blank line in the above script, but | |
5286 | blank lines are of no particular significance to the linker. As well, | |
5287 | the linker doesn't associate the above symbol names with their | |
5288 | sections. Instead, it assumes that all assignments or other | |
5289 | statements belong to the previous output section, except for the | |
5290 | special case of an assignment to @code{.}. I.e., the linker will | |
5291 | place the orphan @code{.rodata} section as if the script was written | |
5292 | as follows: | |
5293 | ||
5294 | @smallexample | |
5295 | SECTIONS | |
5296 | @{ | |
5297 | start_of_text = . ; | |
5298 | .text: @{ *(.text) @} | |
5299 | end_of_text = . ; | |
5300 | ||
5301 | start_of_data = . ; | |
5302 | .rodata: @{ *(.rodata) @} | |
5303 | .data: @{ *(.data) @} | |
5304 | end_of_data = . ; | |
5305 | @} | |
5306 | @end smallexample | |
5307 | ||
5308 | This may or may not be the script author's intention for the value of | |
5309 | @code{start_of_data}. One way to influence the orphan section | |
5310 | placement is to assign the location counter to itself, as the linker | |
5311 | assumes that an assignment to @code{.} is setting the start address of | |
5312 | a following output section and thus should be grouped with that | |
5313 | section. So you could write: | |
5314 | ||
5315 | @smallexample | |
5316 | SECTIONS | |
5317 | @{ | |
5318 | start_of_text = . ; | |
5319 | .text: @{ *(.text) @} | |
5320 | end_of_text = . ; | |
5321 | ||
5322 | . = . ; | |
5323 | start_of_data = . ; | |
5324 | .data: @{ *(.data) @} | |
5325 | end_of_data = . ; | |
5326 | @} | |
5327 | @end smallexample | |
5328 | ||
5329 | Now, the orphan @code{.rodata} section will be placed between | |
5330 | @code{end_of_text} and @code{start_of_data}. | |
5331 | ||
252b5132 RH |
5332 | @need 2000 |
5333 | @node Operators | |
5334 | @subsection Operators | |
5335 | @cindex operators for arithmetic | |
5336 | @cindex arithmetic operators | |
5337 | @cindex precedence in expressions | |
5338 | The linker recognizes the standard C set of arithmetic operators, with | |
5339 | the standard bindings and precedence levels: | |
5340 | @c TEXI2ROFF-KILL | |
36f63dca | 5341 | @ifnottex |
252b5132 RH |
5342 | @c END TEXI2ROFF-KILL |
5343 | @smallexample | |
5344 | precedence associativity Operators Notes | |
5345 | (highest) | |
5346 | 1 left ! - ~ (1) | |
5347 | 2 left * / % | |
5348 | 3 left + - | |
5349 | 4 left >> << | |
5350 | 5 left == != > < <= >= | |
5351 | 6 left & | |
5352 | 7 left | | |
5353 | 8 left && | |
5354 | 9 left || | |
5355 | 10 right ? : | |
5356 | 11 right &= += -= *= /= (2) | |
5357 | (lowest) | |
5358 | @end smallexample | |
5359 | Notes: | |
a1ab1d2a | 5360 | (1) Prefix operators |
252b5132 RH |
5361 | (2) @xref{Assignments}. |
5362 | @c TEXI2ROFF-KILL | |
36f63dca | 5363 | @end ifnottex |
252b5132 RH |
5364 | @tex |
5365 | \vskip \baselineskip | |
5366 | %"lispnarrowing" is the extra indent used generally for smallexample | |
5367 | \hskip\lispnarrowing\vbox{\offinterlineskip | |
5368 | \hrule | |
5369 | \halign | |
5370 | {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr | |
5371 | height2pt&\omit&&\omit&&\omit&\cr | |
5372 | &Precedence&& Associativity &&{\rm Operators}&\cr | |
5373 | height2pt&\omit&&\omit&&\omit&\cr | |
5374 | \noalign{\hrule} | |
5375 | height2pt&\omit&&\omit&&\omit&\cr | |
5376 | &highest&&&&&\cr | |
5377 | % '176 is tilde, '~' in tt font | |
a1ab1d2a | 5378 | &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr |
252b5132 RH |
5379 | &2&&left&&* / \%&\cr |
5380 | &3&&left&&+ -&\cr | |
5381 | &4&&left&&>> <<&\cr | |
5382 | &5&&left&&== != > < <= >=&\cr | |
5383 | &6&&left&&\&&\cr | |
5384 | &7&&left&&|&\cr | |
5385 | &8&&left&&{\&\&}&\cr | |
5386 | &9&&left&&||&\cr | |
5387 | &10&&right&&? :&\cr | |
5388 | &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr | |
5389 | &lowest&&&&&\cr | |
5390 | height2pt&\omit&&\omit&&\omit&\cr} | |
5391 | \hrule} | |
5392 | @end tex | |
5393 | @iftex | |
5394 | { | |
5395 | @obeylines@parskip=0pt@parindent=0pt | |
5396 | @dag@quad Prefix operators. | |
5397 | @ddag@quad @xref{Assignments}. | |
5398 | } | |
5399 | @end iftex | |
5400 | @c END TEXI2ROFF-KILL | |
5401 | ||
5402 | @node Evaluation | |
5403 | @subsection Evaluation | |
5404 | @cindex lazy evaluation | |
5405 | @cindex expression evaluation order | |
5406 | The linker evaluates expressions lazily. It only computes the value of | |
5407 | an expression when absolutely necessary. | |
5408 | ||
5409 | The linker needs some information, such as the value of the start | |
5410 | address of the first section, and the origins and lengths of memory | |
5411 | regions, in order to do any linking at all. These values are computed | |
5412 | as soon as possible when the linker reads in the linker script. | |
5413 | ||
5414 | However, other values (such as symbol values) are not known or needed | |
5415 | until after storage allocation. Such values are evaluated later, when | |
5416 | other information (such as the sizes of output sections) is available | |
5417 | for use in the symbol assignment expression. | |
5418 | ||
5419 | The sizes of sections cannot be known until after allocation, so | |
5420 | assignments dependent upon these are not performed until after | |
5421 | allocation. | |
5422 | ||
5423 | Some expressions, such as those depending upon the location counter | |
5424 | @samp{.}, must be evaluated during section allocation. | |
5425 | ||
5426 | If the result of an expression is required, but the value is not | |
5427 | available, then an error results. For example, a script like the | |
5428 | following | |
5429 | @smallexample | |
5430 | @group | |
5431 | SECTIONS | |
5432 | @{ | |
a1ab1d2a | 5433 | .text 9+this_isnt_constant : |
252b5132 RH |
5434 | @{ *(.text) @} |
5435 | @} | |
5436 | @end group | |
5437 | @end smallexample | |
5438 | @noindent | |
5439 | will cause the error message @samp{non constant expression for initial | |
5440 | address}. | |
5441 | ||
5442 | @node Expression Section | |
5443 | @subsection The Section of an Expression | |
5444 | @cindex expression sections | |
5445 | @cindex absolute expressions | |
5446 | @cindex relative expressions | |
5447 | @cindex absolute and relocatable symbols | |
5448 | @cindex relocatable and absolute symbols | |
5449 | @cindex symbols, relocatable and absolute | |
5450 | When the linker evaluates an expression, the result is either absolute | |
5451 | or relative to some section. A relative expression is expressed as a | |
5452 | fixed offset from the base of a section. | |
5453 | ||
5454 | The position of the expression within the linker script determines | |
5455 | whether it is absolute or relative. An expression which appears within | |
5456 | an output section definition is relative to the base of the output | |
5457 | section. An expression which appears elsewhere will be absolute. | |
5458 | ||
5459 | A symbol set to a relative expression will be relocatable if you request | |
5460 | relocatable output using the @samp{-r} option. That means that a | |
5461 | further link operation may change the value of the symbol. The symbol's | |
5462 | section will be the section of the relative expression. | |
5463 | ||
5464 | A symbol set to an absolute expression will retain the same value | |
5465 | through any further link operation. The symbol will be absolute, and | |
5466 | will not have any particular associated section. | |
5467 | ||
5468 | You can use the builtin function @code{ABSOLUTE} to force an expression | |
5469 | to be absolute when it would otherwise be relative. For example, to | |
5470 | create an absolute symbol set to the address of the end of the output | |
5471 | section @samp{.data}: | |
5472 | @smallexample | |
5473 | SECTIONS | |
5474 | @{ | |
5475 | .data : @{ *(.data) _edata = ABSOLUTE(.); @} | |
5476 | @} | |
5477 | @end smallexample | |
5478 | @noindent | |
5479 | If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the | |
5480 | @samp{.data} section. | |
5481 | ||
5482 | @node Builtin Functions | |
5483 | @subsection Builtin Functions | |
5484 | @cindex functions in expressions | |
5485 | The linker script language includes a number of builtin functions for | |
5486 | use in linker script expressions. | |
5487 | ||
5488 | @table @code | |
5489 | @item ABSOLUTE(@var{exp}) | |
5490 | @kindex ABSOLUTE(@var{exp}) | |
5491 | @cindex expression, absolute | |
5492 | Return the absolute (non-relocatable, as opposed to non-negative) value | |
5493 | of the expression @var{exp}. Primarily useful to assign an absolute | |
5494 | value to a symbol within a section definition, where symbol values are | |
5495 | normally section relative. @xref{Expression Section}. | |
5496 | ||
5497 | @item ADDR(@var{section}) | |
5498 | @kindex ADDR(@var{section}) | |
5499 | @cindex section address in expression | |
5500 | Return the absolute address (the VMA) of the named @var{section}. Your | |
5501 | script must previously have defined the location of that section. In | |
5502 | the following example, @code{symbol_1} and @code{symbol_2} are assigned | |
5503 | identical values: | |
5504 | @smallexample | |
5505 | @group | |
5506 | SECTIONS @{ @dots{} | |
5507 | .output1 : | |
a1ab1d2a | 5508 | @{ |
252b5132 RH |
5509 | start_of_output_1 = ABSOLUTE(.); |
5510 | @dots{} | |
5511 | @} | |
5512 | .output : | |
5513 | @{ | |
5514 | symbol_1 = ADDR(.output1); | |
5515 | symbol_2 = start_of_output_1; | |
5516 | @} | |
5517 | @dots{} @} | |
5518 | @end group | |
5519 | @end smallexample | |
5520 | ||
876f4090 NS |
5521 | @item ALIGN(@var{align}) |
5522 | @itemx ALIGN(@var{exp},@var{align}) | |
5523 | @kindex ALIGN(@var{align}) | |
5524 | @kindex ALIGN(@var{exp},@var{align}) | |
252b5132 RH |
5525 | @cindex round up location counter |
5526 | @cindex align location counter | |
876f4090 NS |
5527 | @cindex round up expression |
5528 | @cindex align expression | |
5529 | Return the location counter (@code{.}) or arbitrary expression aligned | |
5530 | to the next @var{align} boundary. The single operand @code{ALIGN} | |
5531 | doesn't change the value of the location counter---it just does | |
5532 | arithmetic on it. The two operand @code{ALIGN} allows an arbitrary | |
5533 | expression to be aligned upwards (@code{ALIGN(@var{align})} is | |
5534 | equivalent to @code{ALIGN(., @var{align})}). | |
5535 | ||
5536 | Here is an example which aligns the output @code{.data} section to the | |
5537 | next @code{0x2000} byte boundary after the preceding section and sets a | |
5538 | variable within the section to the next @code{0x8000} boundary after the | |
5539 | input sections: | |
252b5132 RH |
5540 | @smallexample |
5541 | @group | |
5542 | SECTIONS @{ @dots{} | |
5543 | .data ALIGN(0x2000): @{ | |
5544 | *(.data) | |
5545 | variable = ALIGN(0x8000); | |
5546 | @} | |
5547 | @dots{} @} | |
5548 | @end group | |
5549 | @end smallexample | |
5550 | @noindent | |
5551 | The first use of @code{ALIGN} in this example specifies the location of | |
5552 | a section because it is used as the optional @var{address} attribute of | |
5553 | a section definition (@pxref{Output Section Address}). The second use | |
5554 | of @code{ALIGN} is used to defines the value of a symbol. | |
5555 | ||
5556 | The builtin function @code{NEXT} is closely related to @code{ALIGN}. | |
5557 | ||
362c1d1a NS |
5558 | @item ALIGNOF(@var{section}) |
5559 | @kindex ALIGNOF(@var{section}) | |
5560 | @cindex section alignment | |
5561 | Return the alignment in bytes of the named @var{section}, if that section has | |
5562 | been allocated. If the section has not been allocated when this is | |
5563 | evaluated, the linker will report an error. In the following example, | |
5564 | the alignment of the @code{.output} section is stored as the first | |
5565 | value in that section. | |
5566 | @smallexample | |
5567 | @group | |
5568 | SECTIONS@{ @dots{} | |
5569 | .output @{ | |
5570 | LONG (ALIGNOF (.output)) | |
5571 | @dots{} | |
5572 | @} | |
5573 | @dots{} @} | |
5574 | @end group | |
5575 | @end smallexample | |
5576 | ||
252b5132 RH |
5577 | @item BLOCK(@var{exp}) |
5578 | @kindex BLOCK(@var{exp}) | |
5579 | This is a synonym for @code{ALIGN}, for compatibility with older linker | |
5580 | scripts. It is most often seen when setting the address of an output | |
5581 | section. | |
5582 | ||
2d20f7bf JJ |
5583 | @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) |
5584 | @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) | |
5585 | This is equivalent to either | |
5586 | @smallexample | |
5587 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1))) | |
5588 | @end smallexample | |
5589 | or | |
5590 | @smallexample | |
5591 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - @var{commonpagesize}))) | |
5592 | @end smallexample | |
5593 | @noindent | |
5594 | depending on whether the latter uses fewer @var{commonpagesize} sized pages | |
5595 | for the data segment (area between the result of this expression and | |
5596 | @code{DATA_SEGMENT_END}) than the former or not. | |
5597 | If the latter form is used, it means @var{commonpagesize} bytes of runtime | |
5598 | memory will be saved at the expense of up to @var{commonpagesize} wasted | |
5599 | bytes in the on-disk file. | |
5600 | ||
5601 | This expression can only be used directly in @code{SECTIONS} commands, not in | |
5602 | any output section descriptions and only once in the linker script. | |
5603 | @var{commonpagesize} should be less or equal to @var{maxpagesize} and should | |
5604 | be the system page size the object wants to be optimized for (while still | |
5605 | working on system page sizes up to @var{maxpagesize}). | |
5606 | ||
5607 | @noindent | |
5608 | Example: | |
5609 | @smallexample | |
5610 | . = DATA_SEGMENT_ALIGN(0x10000, 0x2000); | |
5611 | @end smallexample | |
5612 | ||
5613 | @item DATA_SEGMENT_END(@var{exp}) | |
5614 | @kindex DATA_SEGMENT_END(@var{exp}) | |
5615 | This defines the end of data segment for @code{DATA_SEGMENT_ALIGN} | |
5616 | evaluation purposes. | |
5617 | ||
5618 | @smallexample | |
5619 | . = DATA_SEGMENT_END(.); | |
5620 | @end smallexample | |
5621 | ||
a4f5ad88 JJ |
5622 | @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) |
5623 | @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) | |
5624 | This defines the end of the @code{PT_GNU_RELRO} segment when | |
5625 | @samp{-z relro} option is used. Second argument is returned. | |
5626 | When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END} | |
5627 | does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that | |
5628 | @var{exp} + @var{offset} is aligned to the most commonly used page | |
5629 | boundary for particular target. If present in the linker script, | |
5630 | it must always come in between @code{DATA_SEGMENT_ALIGN} and | |
5631 | @code{DATA_SEGMENT_END}. | |
5632 | ||
5633 | @smallexample | |
5634 | . = DATA_SEGMENT_RELRO_END(24, .); | |
5635 | @end smallexample | |
5636 | ||
252b5132 RH |
5637 | @item DEFINED(@var{symbol}) |
5638 | @kindex DEFINED(@var{symbol}) | |
5639 | @cindex symbol defaults | |
5640 | Return 1 if @var{symbol} is in the linker global symbol table and is | |
420e579c HPN |
5641 | defined before the statement using DEFINED in the script, otherwise |
5642 | return 0. You can use this function to provide | |
252b5132 RH |
5643 | default values for symbols. For example, the following script fragment |
5644 | shows how to set a global symbol @samp{begin} to the first location in | |
5645 | the @samp{.text} section---but if a symbol called @samp{begin} already | |
5646 | existed, its value is preserved: | |
5647 | ||
5648 | @smallexample | |
5649 | @group | |
5650 | SECTIONS @{ @dots{} | |
5651 | .text : @{ | |
5652 | begin = DEFINED(begin) ? begin : . ; | |
5653 | @dots{} | |
5654 | @} | |
5655 | @dots{} | |
5656 | @} | |
5657 | @end group | |
5658 | @end smallexample | |
5659 | ||
3ec57632 NC |
5660 | @item LENGTH(@var{memory}) |
5661 | @kindex LENGTH(@var{memory}) | |
5662 | Return the length of the memory region named @var{memory}. | |
5663 | ||
252b5132 RH |
5664 | @item LOADADDR(@var{section}) |
5665 | @kindex LOADADDR(@var{section}) | |
5666 | @cindex section load address in expression | |
5667 | Return the absolute LMA of the named @var{section}. This is normally | |
5668 | the same as @code{ADDR}, but it may be different if the @code{AT} | |
5669 | attribute is used in the output section definition (@pxref{Output | |
5670 | Section LMA}). | |
5671 | ||
5672 | @kindex MAX | |
5673 | @item MAX(@var{exp1}, @var{exp2}) | |
5674 | Returns the maximum of @var{exp1} and @var{exp2}. | |
5675 | ||
5676 | @kindex MIN | |
5677 | @item MIN(@var{exp1}, @var{exp2}) | |
5678 | Returns the minimum of @var{exp1} and @var{exp2}. | |
5679 | ||
5680 | @item NEXT(@var{exp}) | |
5681 | @kindex NEXT(@var{exp}) | |
5682 | @cindex unallocated address, next | |
5683 | Return the next unallocated address that is a multiple of @var{exp}. | |
5684 | This function is closely related to @code{ALIGN(@var{exp})}; unless you | |
5685 | use the @code{MEMORY} command to define discontinuous memory for the | |
5686 | output file, the two functions are equivalent. | |
5687 | ||
3ec57632 NC |
5688 | @item ORIGIN(@var{memory}) |
5689 | @kindex ORIGIN(@var{memory}) | |
5690 | Return the origin of the memory region named @var{memory}. | |
5691 | ||
ba916c8a MM |
5692 | @item SEGMENT_START(@var{segment}, @var{default}) |
5693 | @kindex SEGMENT_START(@var{segment}, @var{default}) | |
5694 | Return the base address of the named @var{segment}. If an explicit | |
5695 | value has been given for this segment (with a command-line @samp{-T} | |
5696 | option) that value will be returned; otherwise the value will be | |
5697 | @var{default}. At present, the @samp{-T} command-line option can only | |
5698 | be used to set the base address for the ``text'', ``data'', and | |
5699 | ``bss'' sections, but you use @code{SEGMENT_START} with any segment | |
5700 | name. | |
5701 | ||
252b5132 RH |
5702 | @item SIZEOF(@var{section}) |
5703 | @kindex SIZEOF(@var{section}) | |
5704 | @cindex section size | |
5705 | Return the size in bytes of the named @var{section}, if that section has | |
5706 | been allocated. If the section has not been allocated when this is | |
5707 | evaluated, the linker will report an error. In the following example, | |
5708 | @code{symbol_1} and @code{symbol_2} are assigned identical values: | |
5709 | @smallexample | |
5710 | @group | |
5711 | SECTIONS@{ @dots{} | |
5712 | .output @{ | |
5713 | .start = . ; | |
5714 | @dots{} | |
5715 | .end = . ; | |
5716 | @} | |
5717 | symbol_1 = .end - .start ; | |
5718 | symbol_2 = SIZEOF(.output); | |
5719 | @dots{} @} | |
5720 | @end group | |
5721 | @end smallexample | |
5722 | ||
5723 | @item SIZEOF_HEADERS | |
5724 | @itemx sizeof_headers | |
5725 | @kindex SIZEOF_HEADERS | |
5726 | @cindex header size | |
5727 | Return the size in bytes of the output file's headers. This is | |
5728 | information which appears at the start of the output file. You can use | |
5729 | this number when setting the start address of the first section, if you | |
5730 | choose, to facilitate paging. | |
5731 | ||
5732 | @cindex not enough room for program headers | |
5733 | @cindex program headers, not enough room | |
5734 | When producing an ELF output file, if the linker script uses the | |
5735 | @code{SIZEOF_HEADERS} builtin function, the linker must compute the | |
5736 | number of program headers before it has determined all the section | |
5737 | addresses and sizes. If the linker later discovers that it needs | |
5738 | additional program headers, it will report an error @samp{not enough | |
5739 | room for program headers}. To avoid this error, you must avoid using | |
5740 | the @code{SIZEOF_HEADERS} function, or you must rework your linker | |
5741 | script to avoid forcing the linker to use additional program headers, or | |
5742 | you must define the program headers yourself using the @code{PHDRS} | |
5743 | command (@pxref{PHDRS}). | |
5744 | @end table | |
5745 | ||
5746 | @node Implicit Linker Scripts | |
5747 | @section Implicit Linker Scripts | |
5748 | @cindex implicit linker scripts | |
5749 | If you specify a linker input file which the linker can not recognize as | |
5750 | an object file or an archive file, it will try to read the file as a | |
5751 | linker script. If the file can not be parsed as a linker script, the | |
5752 | linker will report an error. | |
5753 | ||
5754 | An implicit linker script will not replace the default linker script. | |
5755 | ||
5756 | Typically an implicit linker script would contain only symbol | |
5757 | assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION} | |
5758 | commands. | |
5759 | ||
5760 | Any input files read because of an implicit linker script will be read | |
5761 | at the position in the command line where the implicit linker script was | |
5762 | read. This can affect archive searching. | |
5763 | ||
5764 | @ifset GENERIC | |
5765 | @node Machine Dependent | |
5766 | @chapter Machine Dependent Features | |
5767 | ||
5768 | @cindex machine dependencies | |
ff5dcc92 SC |
5769 | @command{ld} has additional features on some platforms; the following |
5770 | sections describe them. Machines where @command{ld} has no additional | |
252b5132 RH |
5771 | functionality are not listed. |
5772 | ||
5773 | @menu | |
36f63dca NC |
5774 | @ifset H8300 |
5775 | * H8/300:: @command{ld} and the H8/300 | |
5776 | @end ifset | |
5777 | @ifset I960 | |
5778 | * i960:: @command{ld} and the Intel 960 family | |
5779 | @end ifset | |
5780 | @ifset ARM | |
5781 | * ARM:: @command{ld} and the ARM family | |
5782 | @end ifset | |
5783 | @ifset HPPA | |
5784 | * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF | |
5785 | @end ifset | |
7fb9f789 NC |
5786 | @ifset M68K |
5787 | * M68K:: @command{ld} and the Motorola 68K family | |
5788 | @end ifset | |
3c3bdf30 | 5789 | @ifset MMIX |
36f63dca | 5790 | * MMIX:: @command{ld} and MMIX |
3c3bdf30 | 5791 | @end ifset |
2469cfa2 | 5792 | @ifset MSP430 |
36f63dca | 5793 | * MSP430:: @command{ld} and MSP430 |
2469cfa2 | 5794 | @end ifset |
93fd0973 SC |
5795 | @ifset M68HC11 |
5796 | * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families | |
5797 | @end ifset | |
2a60a7a8 AM |
5798 | @ifset POWERPC |
5799 | * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support | |
5800 | @end ifset | |
5801 | @ifset POWERPC64 | |
5802 | * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support | |
5803 | @end ifset | |
49fa1e15 AM |
5804 | @ifset SPU |
5805 | * SPU ELF:: @command{ld} and SPU ELF Support | |
5806 | @end ifset | |
74459f0e | 5807 | @ifset TICOFF |
ff5dcc92 | 5808 | * TI COFF:: @command{ld} and TI COFF |
74459f0e | 5809 | @end ifset |
2ca22b03 NC |
5810 | @ifset WIN32 |
5811 | * WIN32:: @command{ld} and WIN32 (cygwin/mingw) | |
5812 | @end ifset | |
e0001a05 NC |
5813 | @ifset XTENSA |
5814 | * Xtensa:: @command{ld} and Xtensa Processors | |
5815 | @end ifset | |
252b5132 RH |
5816 | @end menu |
5817 | @end ifset | |
5818 | ||
252b5132 RH |
5819 | @ifset H8300 |
5820 | @ifclear GENERIC | |
5821 | @raisesections | |
5822 | @end ifclear | |
5823 | ||
5824 | @node H8/300 | |
ff5dcc92 | 5825 | @section @command{ld} and the H8/300 |
252b5132 RH |
5826 | |
5827 | @cindex H8/300 support | |
ff5dcc92 | 5828 | For the H8/300, @command{ld} can perform these global optimizations when |
252b5132 RH |
5829 | you specify the @samp{--relax} command-line option. |
5830 | ||
5831 | @table @emph | |
5832 | @cindex relaxing on H8/300 | |
5833 | @item relaxing address modes | |
ff5dcc92 | 5834 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose |
252b5132 RH |
5835 | targets are within eight bits, and turns them into eight-bit |
5836 | program-counter relative @code{bsr} and @code{bra} instructions, | |
5837 | respectively. | |
5838 | ||
5839 | @cindex synthesizing on H8/300 | |
5840 | @item synthesizing instructions | |
5841 | @c FIXME: specifically mov.b, or any mov instructions really? | |
ff5dcc92 | 5842 | @command{ld} finds all @code{mov.b} instructions which use the |
252b5132 RH |
5843 | sixteen-bit absolute address form, but refer to the top |
5844 | page of memory, and changes them to use the eight-bit address form. | |
5845 | (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into | |
5846 | @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the | |
5847 | top page of memory). | |
1502569c NC |
5848 | |
5849 | @item bit manipulation instructions | |
c0065db7 | 5850 | @command{ld} finds all bit manipulation instructions like @code{band, bclr, |
1502569c | 5851 | biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor} |
c0065db7 | 5852 | which use 32 bit and 16 bit absolute address form, but refer to the top |
1502569c NC |
5853 | page of memory, and changes them to use the 8 bit address form. |
5854 | (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into | |
c0065db7 | 5855 | @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in |
1502569c NC |
5856 | the top page of memory). |
5857 | ||
5858 | @item system control instructions | |
c0065db7 RM |
5859 | @command{ld} finds all @code{ldc.w, stc.w} instructions which use the |
5860 | 32 bit absolute address form, but refer to the top page of memory, and | |
1502569c NC |
5861 | changes them to use 16 bit address form. |
5862 | (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into | |
c0065db7 | 5863 | @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in |
1502569c | 5864 | the top page of memory). |
252b5132 RH |
5865 | @end table |
5866 | ||
5867 | @ifclear GENERIC | |
5868 | @lowersections | |
5869 | @end ifclear | |
5870 | @end ifset | |
5871 | ||
36f63dca | 5872 | @ifclear GENERIC |
c2dcd04e | 5873 | @ifset Renesas |
36f63dca | 5874 | @c This stuff is pointless to say unless you're especially concerned |
c2dcd04e NC |
5875 | @c with Renesas chips; don't enable it for generic case, please. |
5876 | @node Renesas | |
5877 | @chapter @command{ld} and Other Renesas Chips | |
36f63dca | 5878 | |
c2dcd04e NC |
5879 | @command{ld} also supports the Renesas (formerly Hitachi) H8/300H, |
5880 | H8/500, and SH chips. No special features, commands, or command-line | |
5881 | options are required for these chips. | |
36f63dca NC |
5882 | @end ifset |
5883 | @end ifclear | |
5884 | ||
5885 | @ifset I960 | |
5886 | @ifclear GENERIC | |
5887 | @raisesections | |
5888 | @end ifclear | |
5889 | ||
5890 | @node i960 | |
5891 | @section @command{ld} and the Intel 960 Family | |
5892 | ||
5893 | @cindex i960 support | |
5894 | ||
5895 | You can use the @samp{-A@var{architecture}} command line option to | |
5896 | specify one of the two-letter names identifying members of the 960 | |
5897 | family; the option specifies the desired output target, and warns of any | |
5898 | incompatible instructions in the input files. It also modifies the | |
5899 | linker's search strategy for archive libraries, to support the use of | |
5900 | libraries specific to each particular architecture, by including in the | |
5901 | search loop names suffixed with the string identifying the architecture. | |
5902 | ||
5903 | For example, if your @command{ld} command line included @w{@samp{-ACA}} as | |
5904 | well as @w{@samp{-ltry}}, the linker would look (in its built-in search | |
5905 | paths, and in any paths you specify with @samp{-L}) for a library with | |
5906 | the names | |
5907 | ||
5908 | @smallexample | |
5909 | @group | |
5910 | try | |
5911 | libtry.a | |
5912 | tryca | |
5913 | libtryca.a | |
5914 | @end group | |
5915 | @end smallexample | |
5916 | ||
5917 | @noindent | |
5918 | The first two possibilities would be considered in any event; the last | |
5919 | two are due to the use of @w{@samp{-ACA}}. | |
5920 | ||
5921 | You can meaningfully use @samp{-A} more than once on a command line, since | |
5922 | the 960 architecture family allows combination of target architectures; each | |
5923 | use will add another pair of name variants to search for when @w{@samp{-l}} | |
5924 | specifies a library. | |
5925 | ||
5926 | @cindex @option{--relax} on i960 | |
5927 | @cindex relaxing on i960 | |
5928 | @command{ld} supports the @samp{--relax} option for the i960 family. If | |
5929 | you specify @samp{--relax}, @command{ld} finds all @code{balx} and | |
5930 | @code{calx} instructions whose targets are within 24 bits, and turns | |
5931 | them into 24-bit program-counter relative @code{bal} and @code{cal} | |
5932 | instructions, respectively. @command{ld} also turns @code{cal} | |
5933 | instructions into @code{bal} instructions when it determines that the | |
5934 | target subroutine is a leaf routine (that is, the target subroutine does | |
5935 | not itself call any subroutines). | |
5936 | ||
48229727 JB |
5937 | @cindex Cortex-A8 erratum workaround |
5938 | @kindex --fix-cortex-a8 | |
5939 | @kindex --no-fix-cortex-a8 | |
5940 | The @samp{--fix-cortex-a8} switch enables a link-time workaround for an erratum in certain Cortex-A8 processors. The workaround is enabled by default if you are targeting the ARM v7-A architecture profile. It can be enabled otherwise by specifying @samp{--fix-cortex-a8}, or disabled unconditionally by specifying @samp{--no-fix-cortex-a8}. | |
5941 | ||
5942 | The erratum only affects Thumb-2 code. Please contact ARM for further details. | |
5943 | ||
85fdf906 AH |
5944 | @kindex --merge-exidx-entries |
5945 | @kindex --no-merge-exidx-entries | |
5946 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo. | |
5947 | ||
36f63dca NC |
5948 | @ifclear GENERIC |
5949 | @lowersections | |
5950 | @end ifclear | |
5951 | @end ifset | |
5952 | ||
5953 | @ifset ARM | |
5954 | @ifclear GENERIC | |
5955 | @raisesections | |
5956 | @end ifclear | |
5957 | ||
93fd0973 SC |
5958 | @ifset M68HC11 |
5959 | @ifclear GENERIC | |
5960 | @raisesections | |
5961 | @end ifclear | |
5962 | ||
5963 | @node M68HC11/68HC12 | |
5964 | @section @command{ld} and the Motorola 68HC11 and 68HC12 families | |
5965 | ||
5966 | @cindex M68HC11 and 68HC12 support | |
5967 | ||
5968 | @subsection Linker Relaxation | |
5969 | ||
5970 | For the Motorola 68HC11, @command{ld} can perform these global | |
5971 | optimizations when you specify the @samp{--relax} command-line option. | |
5972 | ||
5973 | @table @emph | |
5974 | @cindex relaxing on M68HC11 | |
5975 | @item relaxing address modes | |
5976 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose | |
5977 | targets are within eight bits, and turns them into eight-bit | |
5978 | program-counter relative @code{bsr} and @code{bra} instructions, | |
5979 | respectively. | |
5980 | ||
5981 | @command{ld} also looks at all 16-bit extended addressing modes and | |
5982 | transforms them in a direct addressing mode when the address is in | |
5983 | page 0 (between 0 and 0x0ff). | |
5984 | ||
5985 | @item relaxing gcc instruction group | |
5986 | When @command{gcc} is called with @option{-mrelax}, it can emit group | |
5987 | of instructions that the linker can optimize to use a 68HC11 direct | |
5988 | addressing mode. These instructions consists of @code{bclr} or | |
5989 | @code{bset} instructions. | |
5990 | ||
5991 | @end table | |
5992 | ||
5993 | @subsection Trampoline Generation | |
5994 | ||
5995 | @cindex trampoline generation on M68HC11 | |
5996 | @cindex trampoline generation on M68HC12 | |
5997 | For 68HC11 and 68HC12, @command{ld} can generate trampoline code to | |
5998 | call a far function using a normal @code{jsr} instruction. The linker | |
c0065db7 | 5999 | will also change the relocation to some far function to use the |
93fd0973 SC |
6000 | trampoline address instead of the function address. This is typically the |
6001 | case when a pointer to a function is taken. The pointer will in fact | |
6002 | point to the function trampoline. | |
6003 | ||
6004 | @ifclear GENERIC | |
6005 | @lowersections | |
6006 | @end ifclear | |
6007 | @end ifset | |
6008 | ||
36f63dca | 6009 | @node ARM |
3674e28a | 6010 | @section @command{ld} and the ARM family |
36f63dca NC |
6011 | |
6012 | @cindex ARM interworking support | |
6013 | @kindex --support-old-code | |
6014 | For the ARM, @command{ld} will generate code stubs to allow functions calls | |
b45619c0 | 6015 | between ARM and Thumb code. These stubs only work with code that has |
36f63dca NC |
6016 | been compiled and assembled with the @samp{-mthumb-interwork} command |
6017 | line option. If it is necessary to link with old ARM object files or | |
6018 | libraries, which have not been compiled with the -mthumb-interwork | |
6019 | option then the @samp{--support-old-code} command line switch should be | |
6020 | given to the linker. This will make it generate larger stub functions | |
6021 | which will work with non-interworking aware ARM code. Note, however, | |
6022 | the linker does not support generating stubs for function calls to | |
6023 | non-interworking aware Thumb code. | |
6024 | ||
6025 | @cindex thumb entry point | |
6026 | @cindex entry point, thumb | |
6027 | @kindex --thumb-entry=@var{entry} | |
6028 | The @samp{--thumb-entry} switch is a duplicate of the generic | |
6029 | @samp{--entry} switch, in that it sets the program's starting address. | |
6030 | But it also sets the bottom bit of the address, so that it can be | |
6031 | branched to using a BX instruction, and the program will start | |
6032 | executing in Thumb mode straight away. | |
6033 | ||
ce11ba6c KT |
6034 | @cindex PE import table prefixing |
6035 | @kindex --use-nul-prefixed-import-tables | |
6036 | The @samp{--use-nul-prefixed-import-tables} switch is specifying, that | |
6037 | the import tables idata4 and idata5 have to be generated with a zero | |
6038 | elememt prefix for import libraries. This is the old style to generate | |
6039 | import tables. By default this option is turned off. | |
6040 | ||
e489d0ae PB |
6041 | @cindex BE8 |
6042 | @kindex --be8 | |
6043 | The @samp{--be8} switch instructs @command{ld} to generate BE8 format | |
6044 | executables. This option is only valid when linking big-endian objects. | |
6045 | The resulting image will contain big-endian data and little-endian code. | |
6046 | ||
3674e28a PB |
6047 | @cindex TARGET1 |
6048 | @kindex --target1-rel | |
6049 | @kindex --target1-abs | |
6050 | The @samp{R_ARM_TARGET1} relocation is typically used for entries in the | |
6051 | @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32} | |
6052 | or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel} | |
6053 | and @samp{--target1-abs} switches override the default. | |
6054 | ||
6055 | @cindex TARGET2 | |
6056 | @kindex --target2=@var{type} | |
6057 | The @samp{--target2=type} switch overrides the default definition of the | |
6058 | @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their | |
6059 | meanings, and target defaults are as follows: | |
6060 | @table @samp | |
6061 | @item rel | |
eeac373a PB |
6062 | @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi) |
6063 | @item abs | |
6064 | @samp{R_ARM_ABS32} (arm*-*-symbianelf) | |
3674e28a PB |
6065 | @item got-rel |
6066 | @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd) | |
6067 | @end table | |
6068 | ||
319850b4 JB |
6069 | @cindex FIX_V4BX |
6070 | @kindex --fix-v4bx | |
6071 | The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF | |
6072 | specification) enables objects compiled for the ARMv4 architecture to be | |
6073 | interworking-safe when linked with other objects compiled for ARMv4t, but | |
6074 | also allows pure ARMv4 binaries to be built from the same ARMv4 objects. | |
6075 | ||
6076 | In the latter case, the switch @option{--fix-v4bx} must be passed to the | |
6077 | linker, which causes v4t @code{BX rM} instructions to be rewritten as | |
6078 | @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction. | |
6079 | ||
6080 | In the former case, the switch should not be used, and @samp{R_ARM_V4BX} | |
6081 | relocations are ignored. | |
6082 | ||
845b51d6 PB |
6083 | @cindex FIX_V4BX_INTERWORKING |
6084 | @kindex --fix-v4bx-interworking | |
6085 | Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX} | |
6086 | relocations with a branch to the following veneer: | |
6087 | ||
6088 | @smallexample | |
6089 | TST rM, #1 | |
6090 | MOVEQ PC, rM | |
6091 | BX Rn | |
6092 | @end smallexample | |
6093 | ||
6094 | This allows generation of libraries/applications that work on ARMv4 cores | |
6095 | and are still interworking safe. Note that the above veneer clobbers the | |
6096 | condition flags, so may cause incorrect progrm behavior in rare cases. | |
6097 | ||
33bfe774 JB |
6098 | @cindex USE_BLX |
6099 | @kindex --use-blx | |
6100 | The @samp{--use-blx} switch enables the linker to use ARM/Thumb | |
6101 | BLX instructions (available on ARMv5t and above) in various | |
6102 | situations. Currently it is used to perform calls via the PLT from Thumb | |
6103 | code using BLX rather than using BX and a mode-switching stub before | |
6104 | each PLT entry. This should lead to such calls executing slightly faster. | |
6105 | ||
6106 | This option is enabled implicitly for SymbianOS, so there is no need to | |
6107 | specify it if you are using that target. | |
6108 | ||
c6dd86c6 JB |
6109 | @cindex VFP11_DENORM_FIX |
6110 | @kindex --vfp11-denorm-fix | |
6111 | The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a | |
6112 | bug in certain VFP11 coprocessor hardware, which sometimes allows | |
6113 | instructions with denorm operands (which must be handled by support code) | |
6114 | to have those operands overwritten by subsequent instructions before | |
6115 | the support code can read the intended values. | |
6116 | ||
6117 | The bug may be avoided in scalar mode if you allow at least one | |
6118 | intervening instruction between a VFP11 instruction which uses a register | |
6119 | and another instruction which writes to the same register, or at least two | |
6120 | intervening instructions if vector mode is in use. The bug only affects | |
6121 | full-compliance floating-point mode: you do not need this workaround if | |
6122 | you are using "runfast" mode. Please contact ARM for further details. | |
6123 | ||
6124 | If you know you are using buggy VFP11 hardware, you can | |
6125 | enable this workaround by specifying the linker option | |
6126 | @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar | |
6127 | mode only, or @samp{--vfp-denorm-fix=vector} if you are using | |
6128 | vector mode (the latter also works for scalar code). The default is | |
6129 | @samp{--vfp-denorm-fix=none}. | |
6130 | ||
6131 | If the workaround is enabled, instructions are scanned for | |
6132 | potentially-troublesome sequences, and a veneer is created for each | |
6133 | such sequence which may trigger the erratum. The veneer consists of the | |
6134 | first instruction of the sequence and a branch back to the subsequent | |
6135 | instruction. The original instruction is then replaced with a branch to | |
6136 | the veneer. The extra cycles required to call and return from the veneer | |
6137 | are sufficient to avoid the erratum in both the scalar and vector cases. | |
6138 | ||
bf21ed78 MS |
6139 | @cindex NO_ENUM_SIZE_WARNING |
6140 | @kindex --no-enum-size-warning | |
726150b7 | 6141 | The @option{--no-enum-size-warning} switch prevents the linker from |
bf21ed78 MS |
6142 | warning when linking object files that specify incompatible EABI |
6143 | enumeration size attributes. For example, with this switch enabled, | |
6144 | linking of an object file using 32-bit enumeration values with another | |
6145 | using enumeration values fitted into the smallest possible space will | |
6146 | not be diagnosed. | |
a9dc9481 JM |
6147 | |
6148 | @cindex NO_WCHAR_SIZE_WARNING | |
6149 | @kindex --no-wchar-size-warning | |
6150 | The @option{--no-wchar-size-warning} switch prevents the linker from | |
6151 | warning when linking object files that specify incompatible EABI | |
6152 | @code{wchar_t} size attributes. For example, with this switch enabled, | |
6153 | linking of an object file using 32-bit @code{wchar_t} values with another | |
6154 | using 16-bit @code{wchar_t} values will not be diagnosed. | |
bf21ed78 | 6155 | |
726150b7 NC |
6156 | @cindex PIC_VENEER |
6157 | @kindex --pic-veneer | |
6158 | The @samp{--pic-veneer} switch makes the linker use PIC sequences for | |
6159 | ARM/Thumb interworking veneers, even if the rest of the binary | |
6160 | is not PIC. This avoids problems on uClinux targets where | |
6161 | @samp{--emit-relocs} is used to generate relocatable binaries. | |
6162 | ||
6163 | @cindex STUB_GROUP_SIZE | |
6164 | @kindex --stub-group-size=@var{N} | |
6165 | The linker will automatically generate and insert small sequences of | |
6166 | code into a linked ARM ELF executable whenever an attempt is made to | |
6167 | perform a function call to a symbol that is too far away. The | |
6168 | placement of these sequences of instructions - called stubs - is | |
6169 | controlled by the command line option @option{--stub-group-size=N}. | |
6170 | The placement is important because a poor choice can create a need for | |
6171 | duplicate stubs, increasing the code sizw. The linker will try to | |
6172 | group stubs together in order to reduce interruptions to the flow of | |
6173 | code, but it needs guidance as to how big these groups should be and | |
6174 | where they should be placed. | |
6175 | ||
6176 | The value of @samp{N}, the parameter to the | |
6177 | @option{--stub-group-size=} option controls where the stub groups are | |
07d72278 | 6178 | placed. If it is negative then all stubs are placed after the first |
726150b7 NC |
6179 | branch that needs them. If it is positive then the stubs can be |
6180 | placed either before or after the branches that need them. If the | |
6181 | value of @samp{N} is 1 (either +1 or -1) then the linker will choose | |
6182 | exactly where to place groups of stubs, using its built in heuristics. | |
6183 | A value of @samp{N} greater than 1 (or smaller than -1) tells the | |
6184 | linker that a single group of stubs can service at most @samp{N} bytes | |
6185 | from the input sections. | |
6186 | ||
6187 | The default, if @option{--stub-group-size=} is not specified, is | |
6188 | @samp{N = +1}. | |
6189 | ||
1a51c1a4 NC |
6190 | Farcalls stubs insertion is fully supported for the ARM-EABI target |
6191 | only, because it relies on object files properties not present | |
6192 | otherwise. | |
6193 | ||
36f63dca NC |
6194 | @ifclear GENERIC |
6195 | @lowersections | |
6196 | @end ifclear | |
6197 | @end ifset | |
6198 | ||
6199 | @ifset HPPA | |
6200 | @ifclear GENERIC | |
6201 | @raisesections | |
6202 | @end ifclear | |
6203 | ||
6204 | @node HPPA ELF32 | |
6205 | @section @command{ld} and HPPA 32-bit ELF Support | |
6206 | @cindex HPPA multiple sub-space stubs | |
6207 | @kindex --multi-subspace | |
6208 | When generating a shared library, @command{ld} will by default generate | |
6209 | import stubs suitable for use with a single sub-space application. | |
6210 | The @samp{--multi-subspace} switch causes @command{ld} to generate export | |
6211 | stubs, and different (larger) import stubs suitable for use with | |
6212 | multiple sub-spaces. | |
6213 | ||
6214 | @cindex HPPA stub grouping | |
6215 | @kindex --stub-group-size=@var{N} | |
6216 | Long branch stubs and import/export stubs are placed by @command{ld} in | |
6217 | stub sections located between groups of input sections. | |
6218 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
6219 | sections handled by one stub section. Since branch offsets are signed, | |
6220 | a stub section may serve two groups of input sections, one group before | |
6221 | the stub section, and one group after it. However, when using | |
6222 | conditional branches that require stubs, it may be better (for branch | |
6223 | prediction) that stub sections only serve one group of input sections. | |
6224 | A negative value for @samp{N} chooses this scheme, ensuring that | |
6225 | branches to stubs always use a negative offset. Two special values of | |
6226 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
6227 | @command{ld} to automatically size input section groups for the branch types | |
6228 | detected, with the same behaviour regarding stub placement as other | |
6229 | positive or negative values of @samp{N} respectively. | |
6230 | ||
6231 | Note that @samp{--stub-group-size} does not split input sections. A | |
6232 | single input section larger than the group size specified will of course | |
6233 | create a larger group (of one section). If input sections are too | |
6234 | large, it may not be possible for a branch to reach its stub. | |
6235 | ||
6236 | @ifclear GENERIC | |
6237 | @lowersections | |
6238 | @end ifclear | |
6239 | @end ifset | |
6240 | ||
7fb9f789 NC |
6241 | @ifset M68K |
6242 | @ifclear GENERIC | |
6243 | @raisesections | |
6244 | @end ifclear | |
6245 | ||
6246 | @node M68K | |
6247 | @section @command{ld} and the Motorola 68K family | |
6248 | ||
6249 | @cindex Motorola 68K GOT generation | |
6250 | @kindex --got=@var{type} | |
6251 | The @samp{--got=@var{type}} option lets you choose the GOT generation scheme. | |
6252 | The choices are @samp{single}, @samp{negative}, @samp{multigot} and | |
6253 | @samp{target}. When @samp{target} is selected the linker chooses | |
6254 | the default GOT generation scheme for the current target. | |
6255 | @samp{single} tells the linker to generate a single GOT with | |
6256 | entries only at non-negative offsets. | |
6257 | @samp{negative} instructs the linker to generate a single GOT with | |
6258 | entries at both negative and positive offsets. Not all environments | |
6259 | support such GOTs. | |
6260 | @samp{multigot} allows the linker to generate several GOTs in the | |
6261 | output file. All GOT references from a single input object | |
6262 | file access the same GOT, but references from different input object | |
6263 | files might access different GOTs. Not all environments support such GOTs. | |
6264 | ||
6265 | @ifclear GENERIC | |
6266 | @lowersections | |
6267 | @end ifclear | |
6268 | @end ifset | |
6269 | ||
36f63dca NC |
6270 | @ifset MMIX |
6271 | @ifclear GENERIC | |
6272 | @raisesections | |
6273 | @end ifclear | |
6274 | ||
6275 | @node MMIX | |
6276 | @section @code{ld} and MMIX | |
6277 | For MMIX, there is a choice of generating @code{ELF} object files or | |
6278 | @code{mmo} object files when linking. The simulator @code{mmix} | |
6279 | understands the @code{mmo} format. The binutils @code{objcopy} utility | |
6280 | can translate between the two formats. | |
6281 | ||
6282 | There is one special section, the @samp{.MMIX.reg_contents} section. | |
6283 | Contents in this section is assumed to correspond to that of global | |
6284 | registers, and symbols referring to it are translated to special symbols, | |
6285 | equal to registers. In a final link, the start address of the | |
6286 | @samp{.MMIX.reg_contents} section corresponds to the first allocated | |
6287 | global register multiplied by 8. Register @code{$255} is not included in | |
6288 | this section; it is always set to the program entry, which is at the | |
6289 | symbol @code{Main} for @code{mmo} files. | |
6290 | ||
7a2de473 HPN |
6291 | Global symbols with the prefix @code{__.MMIX.start.}, for example |
6292 | @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special. | |
6293 | The default linker script uses these to set the default start address | |
6294 | of a section. | |
36f63dca NC |
6295 | |
6296 | Initial and trailing multiples of zero-valued 32-bit words in a section, | |
6297 | are left out from an mmo file. | |
6298 | ||
6299 | @ifclear GENERIC | |
6300 | @lowersections | |
6301 | @end ifclear | |
6302 | @end ifset | |
6303 | ||
6304 | @ifset MSP430 | |
6305 | @ifclear GENERIC | |
6306 | @raisesections | |
6307 | @end ifclear | |
6308 | ||
6309 | @node MSP430 | |
6310 | @section @code{ld} and MSP430 | |
6311 | For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]} | |
6312 | will select an appropriate linker script for selected MPU type. (To get a list of known MPUs | |
6313 | just pass @samp{-m help} option to the linker). | |
6314 | ||
6315 | @cindex MSP430 extra sections | |
6316 | The linker will recognize some extra sections which are MSP430 specific: | |
6317 | ||
6318 | @table @code | |
6319 | @item @samp{.vectors} | |
6320 | Defines a portion of ROM where interrupt vectors located. | |
6321 | ||
6322 | @item @samp{.bootloader} | |
6323 | Defines the bootloader portion of the ROM (if applicable). Any code | |
6324 | in this section will be uploaded to the MPU. | |
6325 | ||
6326 | @item @samp{.infomem} | |
6327 | Defines an information memory section (if applicable). Any code in | |
6328 | this section will be uploaded to the MPU. | |
6329 | ||
c0065db7 | 6330 | @item @samp{.infomemnobits} |
36f63dca NC |
6331 | This is the same as the @samp{.infomem} section except that any code |
6332 | in this section will not be uploaded to the MPU. | |
6333 | ||
6334 | @item @samp{.noinit} | |
6335 | Denotes a portion of RAM located above @samp{.bss} section. | |
6336 | ||
c0065db7 | 6337 | The last two sections are used by gcc. |
36f63dca NC |
6338 | @end table |
6339 | ||
6340 | @ifclear GENERIC | |
6341 | @lowersections | |
6342 | @end ifclear | |
6343 | @end ifset | |
6344 | ||
2a60a7a8 AM |
6345 | @ifset POWERPC |
6346 | @ifclear GENERIC | |
6347 | @raisesections | |
6348 | @end ifclear | |
6349 | ||
6350 | @node PowerPC ELF32 | |
6351 | @section @command{ld} and PowerPC 32-bit ELF Support | |
6352 | @cindex PowerPC long branches | |
6353 | @kindex --relax on PowerPC | |
6354 | Branches on PowerPC processors are limited to a signed 26-bit | |
6355 | displacement, which may result in @command{ld} giving | |
6356 | @samp{relocation truncated to fit} errors with very large programs. | |
6357 | @samp{--relax} enables the generation of trampolines that can access | |
6358 | the entire 32-bit address space. These trampolines are inserted at | |
6359 | section boundaries, so may not themselves be reachable if an input | |
c8a1f254 NS |
6360 | section exceeds 33M in size. You may combine @samp{-r} and |
6361 | @samp{--relax} to add trampolines in a partial link. In that case | |
6362 | both branches to undefined symbols and inter-section branches are also | |
6363 | considered potentially out of range, and trampolines inserted. | |
2a60a7a8 AM |
6364 | |
6365 | @cindex PowerPC ELF32 options | |
6366 | @table @option | |
6367 | @cindex PowerPC PLT | |
6368 | @kindex --bss-plt | |
6369 | @item --bss-plt | |
6370 | Current PowerPC GCC accepts a @samp{-msecure-plt} option that | |
6371 | generates code capable of using a newer PLT and GOT layout that has | |
6372 | the security advantage of no executable section ever needing to be | |
6373 | writable and no writable section ever being executable. PowerPC | |
6374 | @command{ld} will generate this layout, including stubs to access the | |
6375 | PLT, if all input files (including startup and static libraries) were | |
6376 | compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old | |
6377 | BSS PLT (and GOT layout) which can give slightly better performance. | |
6378 | ||
016687f8 AM |
6379 | @kindex --secure-plt |
6380 | @item --secure-plt | |
6381 | @command{ld} will use the new PLT and GOT layout if it is linking new | |
6382 | @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically | |
6383 | when linking non-PIC code. This option requests the new PLT and GOT | |
6384 | layout. A warning will be given if some object file requires the old | |
6385 | style BSS PLT. | |
6386 | ||
2a60a7a8 AM |
6387 | @cindex PowerPC GOT |
6388 | @kindex --sdata-got | |
6389 | @item --sdata-got | |
6390 | The new secure PLT and GOT are placed differently relative to other | |
6391 | sections compared to older BSS PLT and GOT placement. The location of | |
6392 | @code{.plt} must change because the new secure PLT is an initialized | |
6393 | section while the old PLT is uninitialized. The reason for the | |
6394 | @code{.got} change is more subtle: The new placement allows | |
6395 | @code{.got} to be read-only in applications linked with | |
6396 | @samp{-z relro -z now}. However, this placement means that | |
6397 | @code{.sdata} cannot always be used in shared libraries, because the | |
6398 | PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT | |
6399 | pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC | |
6400 | GCC doesn't use @code{.sdata} in shared libraries, so this option is | |
6401 | really only useful for other compilers that may do so. | |
6402 | ||
6403 | @cindex PowerPC stub symbols | |
6404 | @kindex --emit-stub-syms | |
6405 | @item --emit-stub-syms | |
6406 | This option causes @command{ld} to label linker stubs with a local | |
6407 | symbol that encodes the stub type and destination. | |
6408 | ||
6409 | @cindex PowerPC TLS optimization | |
6410 | @kindex --no-tls-optimize | |
6411 | @item --no-tls-optimize | |
6412 | PowerPC @command{ld} normally performs some optimization of code | |
6413 | sequences used to access Thread-Local Storage. Use this option to | |
6414 | disable the optimization. | |
6415 | @end table | |
6416 | ||
6417 | @ifclear GENERIC | |
6418 | @lowersections | |
6419 | @end ifclear | |
6420 | @end ifset | |
6421 | ||
6422 | @ifset POWERPC64 | |
6423 | @ifclear GENERIC | |
6424 | @raisesections | |
6425 | @end ifclear | |
6426 | ||
6427 | @node PowerPC64 ELF64 | |
6428 | @section @command{ld} and PowerPC64 64-bit ELF Support | |
6429 | ||
6430 | @cindex PowerPC64 ELF64 options | |
6431 | @table @option | |
6432 | @cindex PowerPC64 stub grouping | |
6433 | @kindex --stub-group-size | |
6434 | @item --stub-group-size | |
6435 | Long branch stubs, PLT call stubs and TOC adjusting stubs are placed | |
6436 | by @command{ld} in stub sections located between groups of input sections. | |
6437 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
6438 | sections handled by one stub section. Since branch offsets are signed, | |
6439 | a stub section may serve two groups of input sections, one group before | |
6440 | the stub section, and one group after it. However, when using | |
6441 | conditional branches that require stubs, it may be better (for branch | |
6442 | prediction) that stub sections only serve one group of input sections. | |
6443 | A negative value for @samp{N} chooses this scheme, ensuring that | |
6444 | branches to stubs always use a negative offset. Two special values of | |
6445 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
6446 | @command{ld} to automatically size input section groups for the branch types | |
6447 | detected, with the same behaviour regarding stub placement as other | |
6448 | positive or negative values of @samp{N} respectively. | |
6449 | ||
6450 | Note that @samp{--stub-group-size} does not split input sections. A | |
6451 | single input section larger than the group size specified will of course | |
6452 | create a larger group (of one section). If input sections are too | |
6453 | large, it may not be possible for a branch to reach its stub. | |
6454 | ||
6455 | @cindex PowerPC64 stub symbols | |
6456 | @kindex --emit-stub-syms | |
6457 | @item --emit-stub-syms | |
6458 | This option causes @command{ld} to label linker stubs with a local | |
6459 | symbol that encodes the stub type and destination. | |
6460 | ||
6461 | @cindex PowerPC64 dot symbols | |
6462 | @kindex --dotsyms | |
6463 | @kindex --no-dotsyms | |
6464 | @item --dotsyms, --no-dotsyms | |
6465 | These two options control how @command{ld} interprets version patterns | |
6466 | in a version script. Older PowerPC64 compilers emitted both a | |
6467 | function descriptor symbol with the same name as the function, and a | |
6468 | code entry symbol with the name prefixed by a dot (@samp{.}). To | |
6469 | properly version a function @samp{foo}, the version script thus needs | |
6470 | to control both @samp{foo} and @samp{.foo}. The option | |
6471 | @samp{--dotsyms}, on by default, automatically adds the required | |
6472 | dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this | |
6473 | feature. | |
6474 | ||
6475 | @cindex PowerPC64 TLS optimization | |
6476 | @kindex --no-tls-optimize | |
6477 | @item --no-tls-optimize | |
6478 | PowerPC64 @command{ld} normally performs some optimization of code | |
6479 | sequences used to access Thread-Local Storage. Use this option to | |
6480 | disable the optimization. | |
6481 | ||
6482 | @cindex PowerPC64 OPD optimization | |
6483 | @kindex --no-opd-optimize | |
6484 | @item --no-opd-optimize | |
6485 | PowerPC64 @command{ld} normally removes @code{.opd} section entries | |
6486 | corresponding to deleted link-once functions, or functions removed by | |
e7fc76dd | 6487 | the action of @samp{--gc-sections} or linker script @code{/DISCARD/}. |
2a60a7a8 AM |
6488 | Use this option to disable @code{.opd} optimization. |
6489 | ||
6490 | @cindex PowerPC64 OPD spacing | |
6491 | @kindex --non-overlapping-opd | |
6492 | @item --non-overlapping-opd | |
6493 | Some PowerPC64 compilers have an option to generate compressed | |
6494 | @code{.opd} entries spaced 16 bytes apart, overlapping the third word, | |
6495 | the static chain pointer (unused in C) with the first word of the next | |
6496 | entry. This option expands such entries to the full 24 bytes. | |
6497 | ||
6498 | @cindex PowerPC64 TOC optimization | |
6499 | @kindex --no-toc-optimize | |
6500 | @item --no-toc-optimize | |
6501 | PowerPC64 @command{ld} normally removes unused @code{.toc} section | |
6502 | entries. Such entries are detected by examining relocations that | |
6503 | reference the TOC in code sections. A reloc in a deleted code section | |
6504 | marks a TOC word as unneeded, while a reloc in a kept code section | |
6505 | marks a TOC word as needed. Since the TOC may reference itself, TOC | |
6506 | relocs are also examined. TOC words marked as both needed and | |
6507 | unneeded will of course be kept. TOC words without any referencing | |
6508 | reloc are assumed to be part of a multi-word entry, and are kept or | |
6509 | discarded as per the nearest marked preceding word. This works | |
6510 | reliably for compiler generated code, but may be incorrect if assembly | |
6511 | code is used to insert TOC entries. Use this option to disable the | |
6512 | optimization. | |
6513 | ||
6514 | @cindex PowerPC64 multi-TOC | |
6515 | @kindex --no-multi-toc | |
6516 | @item --no-multi-toc | |
6517 | By default, PowerPC64 GCC generates code for a TOC model where TOC | |
6518 | entries are accessed with a 16-bit offset from r2. This limits the | |
6519 | total TOC size to 64K. PowerPC64 @command{ld} extends this limit by | |
6520 | grouping code sections such that each group uses less than 64K for its | |
6521 | TOC entries, then inserts r2 adjusting stubs between inter-group | |
6522 | calls. @command{ld} does not split apart input sections, so cannot | |
6523 | help if a single input file has a @code{.toc} section that exceeds | |
6524 | 64K, most likely from linking multiple files with @command{ld -r}. | |
6525 | Use this option to turn off this feature. | |
6526 | @end table | |
6527 | ||
6528 | @ifclear GENERIC | |
6529 | @lowersections | |
6530 | @end ifclear | |
6531 | @end ifset | |
6532 | ||
49fa1e15 AM |
6533 | @ifset SPU |
6534 | @ifclear GENERIC | |
6535 | @raisesections | |
6536 | @end ifclear | |
6537 | ||
6538 | @node SPU ELF | |
6539 | @section @command{ld} and SPU ELF Support | |
6540 | ||
6541 | @cindex SPU ELF options | |
6542 | @table @option | |
6543 | ||
6544 | @cindex SPU plugins | |
6545 | @kindex --plugin | |
6546 | @item --plugin | |
6547 | This option marks an executable as a PIC plugin module. | |
6548 | ||
6549 | @cindex SPU overlays | |
6550 | @kindex --no-overlays | |
6551 | @item --no-overlays | |
6552 | Normally, @command{ld} recognizes calls to functions within overlay | |
6553 | regions, and redirects such calls to an overlay manager via a stub. | |
6554 | @command{ld} also provides a built-in overlay manager. This option | |
6555 | turns off all this special overlay handling. | |
6556 | ||
6557 | @cindex SPU overlay stub symbols | |
6558 | @kindex --emit-stub-syms | |
6559 | @item --emit-stub-syms | |
6560 | This option causes @command{ld} to label overlay stubs with a local | |
6561 | symbol that encodes the stub type and destination. | |
6562 | ||
6563 | @cindex SPU extra overlay stubs | |
6564 | @kindex --extra-overlay-stubs | |
6565 | @item --extra-overlay-stubs | |
6566 | This option causes @command{ld} to add overlay call stubs on all | |
6567 | function calls out of overlay regions. Normally stubs are not added | |
6568 | on calls to non-overlay regions. | |
6569 | ||
6570 | @cindex SPU local store size | |
6571 | @kindex --local-store=lo:hi | |
6572 | @item --local-store=lo:hi | |
6573 | @command{ld} usually checks that a final executable for SPU fits in | |
6574 | the address range 0 to 256k. This option may be used to change the | |
6575 | range. Disable the check entirely with @option{--local-store=0:0}. | |
6576 | ||
c0065db7 | 6577 | @cindex SPU |
49fa1e15 AM |
6578 | @kindex --stack-analysis |
6579 | @item --stack-analysis | |
6580 | SPU local store space is limited. Over-allocation of stack space | |
6581 | unnecessarily limits space available for code and data, while | |
6582 | under-allocation results in runtime failures. If given this option, | |
6583 | @command{ld} will provide an estimate of maximum stack usage. | |
6584 | @command{ld} does this by examining symbols in code sections to | |
6585 | determine the extents of functions, and looking at function prologues | |
6586 | for stack adjusting instructions. A call-graph is created by looking | |
6587 | for relocations on branch instructions. The graph is then searched | |
6588 | for the maximum stack usage path. Note that this analysis does not | |
6589 | find calls made via function pointers, and does not handle recursion | |
6590 | and other cycles in the call graph. Stack usage may be | |
6591 | under-estimated if your code makes such calls. Also, stack usage for | |
6592 | dynamic allocation, e.g. alloca, will not be detected. If a link map | |
6593 | is requested, detailed information about each function's stack usage | |
6594 | and calls will be given. | |
6595 | ||
c0065db7 | 6596 | @cindex SPU |
49fa1e15 AM |
6597 | @kindex --emit-stack-syms |
6598 | @item --emit-stack-syms | |
6599 | This option, if given along with @option{--stack-analysis} will result | |
6600 | in @command{ld} emitting stack sizing symbols for each function. | |
6601 | These take the form @code{__stack_<function_name>} for global | |
6602 | functions, and @code{__stack_<number>_<function_name>} for static | |
6603 | functions. @code{<number>} is the section id in hex. The value of | |
6604 | such symbols is the stack requirement for the corresponding function. | |
6605 | The symbol size will be zero, type @code{STT_NOTYPE}, binding | |
c0065db7 | 6606 | @code{STB_LOCAL}, and section @code{SHN_ABS}. |
49fa1e15 AM |
6607 | @end table |
6608 | ||
6609 | @ifclear GENERIC | |
6610 | @lowersections | |
6611 | @end ifclear | |
6612 | @end ifset | |
6613 | ||
36f63dca NC |
6614 | @ifset TICOFF |
6615 | @ifclear GENERIC | |
6616 | @raisesections | |
6617 | @end ifclear | |
6618 | ||
6619 | @node TI COFF | |
6620 | @section @command{ld}'s Support for Various TI COFF Versions | |
6621 | @cindex TI COFF versions | |
6622 | @kindex --format=@var{version} | |
6623 | The @samp{--format} switch allows selection of one of the various | |
6624 | TI COFF versions. The latest of this writing is 2; versions 0 and 1 are | |
6625 | also supported. The TI COFF versions also vary in header byte-order | |
6626 | format; @command{ld} will read any version or byte order, but the output | |
6627 | header format depends on the default specified by the specific target. | |
6628 | ||
6629 | @ifclear GENERIC | |
6630 | @lowersections | |
6631 | @end ifclear | |
6632 | @end ifset | |
6633 | ||
2ca22b03 NC |
6634 | @ifset WIN32 |
6635 | @ifclear GENERIC | |
6636 | @raisesections | |
6637 | @end ifclear | |
6638 | ||
6639 | @node WIN32 | |
6640 | @section @command{ld} and WIN32 (cygwin/mingw) | |
6641 | ||
c0065db7 | 6642 | This section describes some of the win32 specific @command{ld} issues. |
b45619c0 | 6643 | See @ref{Options,,Command Line Options} for detailed description of the |
dc8465bf | 6644 | command line options mentioned here. |
2ca22b03 NC |
6645 | |
6646 | @table @emph | |
c0065db7 RM |
6647 | @cindex import libraries |
6648 | @item import libraries | |
69da35b5 | 6649 | The standard Windows linker creates and uses so-called import |
2ca22b03 | 6650 | libraries, which contains information for linking to dll's. They are |
69da35b5 NC |
6651 | regular static archives and are handled as any other static |
6652 | archive. The cygwin and mingw ports of @command{ld} have specific | |
2ca22b03 NC |
6653 | support for creating such libraries provided with the |
6654 | @samp{--out-implib} command line option. | |
6655 | ||
c0065db7 RM |
6656 | @item exporting DLL symbols |
6657 | @cindex exporting DLL symbols | |
dc8465bf NC |
6658 | The cygwin/mingw @command{ld} has several ways to export symbols for dll's. |
6659 | ||
6660 | @table @emph | |
6661 | @item using auto-export functionality | |
6662 | @cindex using auto-export functionality | |
6663 | By default @command{ld} exports symbols with the auto-export functionality, | |
6664 | which is controlled by the following command line options: | |
6665 | ||
0a5d968e NC |
6666 | @itemize |
6667 | @item --export-all-symbols [This is the default] | |
6668 | @item --exclude-symbols | |
6669 | @item --exclude-libs | |
e1c37eb5 | 6670 | @item --exclude-modules-for-implib |
09e2aba4 | 6671 | @item --version-script |
0a5d968e NC |
6672 | @end itemize |
6673 | ||
09e2aba4 DK |
6674 | When auto-export is in operation, @command{ld} will export all the non-local |
6675 | (global and common) symbols it finds in a DLL, with the exception of a few | |
6676 | symbols known to belong to the system's runtime and libraries. As it will | |
6677 | often not be desirable to export all of a DLL's symbols, which may include | |
6678 | private functions that are not part of any public interface, the command-line | |
6679 | options listed above may be used to filter symbols out from the list for | |
6680 | exporting. The @samp{--output-def} option can be used in order to see the | |
6681 | final list of exported symbols with all exclusions taken into effect. | |
6682 | ||
6683 | If @samp{--export-all-symbols} is not given explicitly on the | |
0a5d968e NC |
6684 | command line, then the default auto-export behavior will be @emph{disabled} |
6685 | if either of the following are true: | |
6686 | ||
6687 | @itemize | |
6688 | @item A DEF file is used. | |
6689 | @item Any symbol in any object file was marked with the __declspec(dllexport) attribute. | |
6690 | @end itemize | |
dc8465bf | 6691 | |
c0065db7 RM |
6692 | @item using a DEF file |
6693 | @cindex using a DEF file | |
dc8465bf NC |
6694 | Another way of exporting symbols is using a DEF file. A DEF file is |
6695 | an ASCII file containing definitions of symbols which should be | |
6696 | exported when a dll is created. Usually it is named @samp{<dll | |
6697 | name>.def} and is added as any other object file to the linker's | |
0a5d968e | 6698 | command line. The file's name must end in @samp{.def} or @samp{.DEF}. |
dc8465bf NC |
6699 | |
6700 | @example | |
6701 | gcc -o <output> <objectfiles> <dll name>.def | |
6702 | @end example | |
6703 | ||
0a5d968e NC |
6704 | Using a DEF file turns off the normal auto-export behavior, unless the |
6705 | @samp{--export-all-symbols} option is also used. | |
6706 | ||
dc8465bf NC |
6707 | Here is an example of a DEF file for a shared library called @samp{xyz.dll}: |
6708 | ||
6709 | @example | |
4b5bd4e7 | 6710 | LIBRARY "xyz.dll" BASE=0x20000000 |
dc8465bf NC |
6711 | |
6712 | EXPORTS | |
6713 | foo | |
6714 | bar | |
6715 | _bar = bar | |
4b5bd4e7 DS |
6716 | another_foo = abc.dll.afoo |
6717 | var1 DATA | |
7fcab871 KT |
6718 | doo = foo == foo2 |
6719 | eoo DATA == var1 | |
c0065db7 | 6720 | @end example |
dc8465bf | 6721 | |
7fcab871 | 6722 | This example defines a DLL with a non-default base address and seven |
4b5bd4e7 DS |
6723 | symbols in the export table. The third exported symbol @code{_bar} is an |
6724 | alias for the second. The fourth symbol, @code{another_foo} is resolved | |
6725 | by "forwarding" to another module and treating it as an alias for | |
6726 | @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol | |
7fcab871 KT |
6727 | @code{var1} is declared to be a data object. The @samp{doo} symbol in |
6728 | export library is an alias of @samp{foo}, which gets the string name | |
6729 | in export table @samp{foo2}. The @samp{eoo} symbol is an data export | |
6730 | symbol, which gets in export table the name @samp{var1}. | |
4b5bd4e7 | 6731 | |
6b31ad16 DS |
6732 | The optional @code{LIBRARY <name>} command indicates the @emph{internal} |
6733 | name of the output DLL. If @samp{<name>} does not include a suffix, | |
6734 | the default library suffix, @samp{.DLL} is appended. | |
6735 | ||
b45619c0 NC |
6736 | When the .DEF file is used to build an application, rather than a |
6737 | library, the @code{NAME <name>} command should be used instead of | |
6b31ad16 | 6738 | @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default |
c0065db7 | 6739 | executable suffix, @samp{.EXE} is appended. |
6b31ad16 DS |
6740 | |
6741 | With either @code{LIBRARY <name>} or @code{NAME <name>} the optional | |
6742 | specification @code{BASE = <number>} may be used to specify a | |
c0065db7 | 6743 | non-default base address for the image. |
6b31ad16 DS |
6744 | |
6745 | If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified, | |
a2877985 DS |
6746 | or they specify an empty string, the internal name is the same as the |
6747 | filename specified on the command line. | |
6b31ad16 | 6748 | |
4b5bd4e7 DS |
6749 | The complete specification of an export symbol is: |
6750 | ||
6751 | @example | |
6752 | EXPORTS | |
6753 | ( ( ( <name1> [ = <name2> ] ) | |
6754 | | ( <name1> = <module-name> . <external-name>)) | |
7fcab871 | 6755 | [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) * |
c0065db7 | 6756 | @end example |
4b5bd4e7 DS |
6757 | |
6758 | Declares @samp{<name1>} as an exported symbol from the DLL, or declares | |
6759 | @samp{<name1>} as an exported alias for @samp{<name2>}; or declares | |
6760 | @samp{<name1>} as a "forward" alias for the symbol | |
6761 | @samp{<external-name>} in the DLL @samp{<module-name>}. | |
6762 | Optionally, the symbol may be exported by the specified ordinal | |
7fcab871 KT |
6763 | @samp{<integer>} alias. The optional @samp{<name3>} is the to be used |
6764 | string in import/export table for the symbol. | |
4b5bd4e7 DS |
6765 | |
6766 | The optional keywords that follow the declaration indicate: | |
6767 | ||
6768 | @code{NONAME}: Do not put the symbol name in the DLL's export table. It | |
6769 | will still be exported by its ordinal alias (either the value specified | |
6770 | by the .def specification or, otherwise, the value assigned by the | |
6771 | linker). The symbol name, however, does remain visible in the import | |
6772 | library (if any), unless @code{PRIVATE} is also specified. | |
6773 | ||
6774 | @code{DATA}: The symbol is a variable or object, rather than a function. | |
6775 | The import lib will export only an indirect reference to @code{foo} as | |
6776 | the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as | |
6777 | @code{*_imp__foo}). | |
6778 | ||
6779 | @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as | |
6780 | well as @code{_imp__foo} into the import library. Both refer to the | |
6781 | read-only import address table's pointer to the variable, not to the | |
6782 | variable itself. This can be dangerous. If the user code fails to add | |
6783 | the @code{dllimport} attribute and also fails to explicitly add the | |
6784 | extra indirection that the use of the attribute enforces, the | |
6785 | application will behave unexpectedly. | |
6786 | ||
6787 | @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put | |
6788 | it into the static import library used to resolve imports at link time. The | |
6789 | symbol can still be imported using the @code{LoadLibrary/GetProcAddress} | |
6790 | API at runtime or by by using the GNU ld extension of linking directly to | |
6791 | the DLL without an import library. | |
c0065db7 | 6792 | |
4b5bd4e7 DS |
6793 | See ld/deffilep.y in the binutils sources for the full specification of |
6794 | other DEF file statements | |
dc8465bf NC |
6795 | |
6796 | @cindex creating a DEF file | |
6797 | While linking a shared dll, @command{ld} is able to create a DEF file | |
6798 | with the @samp{--output-def <file>} command line option. | |
0a5d968e NC |
6799 | |
6800 | @item Using decorations | |
6801 | @cindex Using decorations | |
6802 | Another way of marking symbols for export is to modify the source code | |
6803 | itself, so that when building the DLL each symbol to be exported is | |
6804 | declared as: | |
6805 | ||
6806 | @example | |
6807 | __declspec(dllexport) int a_variable | |
6808 | __declspec(dllexport) void a_function(int with_args) | |
6809 | @end example | |
6810 | ||
6811 | All such symbols will be exported from the DLL. If, however, | |
6812 | any of the object files in the DLL contain symbols decorated in | |
6813 | this way, then the normal auto-export behavior is disabled, unless | |
6814 | the @samp{--export-all-symbols} option is also used. | |
6815 | ||
6816 | Note that object files that wish to access these symbols must @emph{not} | |
c0065db7 | 6817 | decorate them with dllexport. Instead, they should use dllimport, |
0a5d968e NC |
6818 | instead: |
6819 | ||
6820 | @example | |
6821 | __declspec(dllimport) int a_variable | |
6822 | __declspec(dllimport) void a_function(int with_args) | |
6823 | @end example | |
6824 | ||
c0065db7 RM |
6825 | This complicates the structure of library header files, because |
6826 | when included by the library itself the header must declare the | |
0a5d968e NC |
6827 | variables and functions as dllexport, but when included by client |
6828 | code the header must declare them as dllimport. There are a number | |
c0065db7 | 6829 | of idioms that are typically used to do this; often client code can |
0a5d968e NC |
6830 | omit the __declspec() declaration completely. See |
6831 | @samp{--enable-auto-import} and @samp{automatic data imports} for more | |
b45619c0 | 6832 | information. |
c0065db7 | 6833 | @end table |
dc8465bf | 6834 | |
2ca22b03 NC |
6835 | @cindex automatic data imports |
6836 | @item automatic data imports | |
6837 | The standard Windows dll format supports data imports from dlls only | |
69da35b5 | 6838 | by adding special decorations (dllimport/dllexport), which let the |
2ca22b03 | 6839 | compiler produce specific assembler instructions to deal with this |
c0065db7 | 6840 | issue. This increases the effort necessary to port existing Un*x |
69da35b5 | 6841 | code to these platforms, especially for large |
2ca22b03 | 6842 | c++ libraries and applications. The auto-import feature, which was |
c0065db7 | 6843 | initially provided by Paul Sokolovsky, allows one to omit the |
b45619c0 | 6844 | decorations to achieve a behavior that conforms to that on POSIX/Un*x |
c0065db7 | 6845 | platforms. This feature is enabled with the @samp{--enable-auto-import} |
69da35b5 NC |
6846 | command-line option, although it is enabled by default on cygwin/mingw. |
6847 | The @samp{--enable-auto-import} option itself now serves mainly to | |
6848 | suppress any warnings that are ordinarily emitted when linked objects | |
6849 | trigger the feature's use. | |
6850 | ||
c0065db7 | 6851 | auto-import of variables does not always work flawlessly without |
69da35b5 NC |
6852 | additional assistance. Sometimes, you will see this message |
6853 | ||
c0065db7 | 6854 | "variable '<var>' can't be auto-imported. Please read the |
69da35b5 NC |
6855 | documentation for ld's @code{--enable-auto-import} for details." |
6856 | ||
c0065db7 RM |
6857 | The @samp{--enable-auto-import} documentation explains why this error |
6858 | occurs, and several methods that can be used to overcome this difficulty. | |
6859 | One of these methods is the @emph{runtime pseudo-relocs} feature, described | |
69da35b5 NC |
6860 | below. |
6861 | ||
6862 | @cindex runtime pseudo-relocation | |
c0065db7 RM |
6863 | For complex variables imported from DLLs (such as structs or classes), |
6864 | object files typically contain a base address for the variable and an | |
6865 | offset (@emph{addend}) within the variable--to specify a particular | |
6866 | field or public member, for instance. Unfortunately, the runtime loader used | |
6867 | in win32 environments is incapable of fixing these references at runtime | |
69da35b5 | 6868 | without the additional information supplied by dllimport/dllexport decorations. |
c0065db7 | 6869 | The standard auto-import feature described above is unable to resolve these |
69da35b5 NC |
6870 | references. |
6871 | ||
c0065db7 RM |
6872 | The @samp{--enable-runtime-pseudo-relocs} switch allows these references to |
6873 | be resolved without error, while leaving the task of adjusting the references | |
6874 | themselves (with their non-zero addends) to specialized code provided by the | |
6875 | runtime environment. Recent versions of the cygwin and mingw environments and | |
6876 | compilers provide this runtime support; older versions do not. However, the | |
6877 | support is only necessary on the developer's platform; the compiled result will | |
69da35b5 NC |
6878 | run without error on an older system. |
6879 | ||
c0065db7 RM |
6880 | @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly |
6881 | enabled as needed. | |
2ca22b03 NC |
6882 | |
6883 | @cindex direct linking to a dll | |
6884 | @item direct linking to a dll | |
6885 | The cygwin/mingw ports of @command{ld} support the direct linking, | |
6886 | including data symbols, to a dll without the usage of any import | |
69da35b5 | 6887 | libraries. This is much faster and uses much less memory than does the |
b45619c0 | 6888 | traditional import library method, especially when linking large |
c0065db7 RM |
6889 | libraries or applications. When @command{ld} creates an import lib, each |
6890 | function or variable exported from the dll is stored in its own bfd, even | |
6891 | though a single bfd could contain many exports. The overhead involved in | |
69da35b5 | 6892 | storing, loading, and processing so many bfd's is quite large, and explains the |
c0065db7 | 6893 | tremendous time, memory, and storage needed to link against particularly |
69da35b5 NC |
6894 | large or complex libraries when using import libs. |
6895 | ||
c0065db7 | 6896 | Linking directly to a dll uses no extra command-line switches other than |
69da35b5 | 6897 | @samp{-L} and @samp{-l}, because @command{ld} already searches for a number |
c0065db7 | 6898 | of names to match each library. All that is needed from the developer's |
69da35b5 NC |
6899 | perspective is an understanding of this search, in order to force ld to |
6900 | select the dll instead of an import library. | |
6901 | ||
2ca22b03 | 6902 | |
69da35b5 NC |
6903 | For instance, when ld is called with the argument @samp{-lxxx} it will attempt |
6904 | to find, in the first directory of its search path, | |
2ca22b03 NC |
6905 | |
6906 | @example | |
45e948fe NC |
6907 | libxxx.dll.a |
6908 | xxx.dll.a | |
6909 | libxxx.a | |
6910 | xxx.lib | |
69da35b5 | 6911 | cygxxx.dll (*) |
45e948fe NC |
6912 | libxxx.dll |
6913 | xxx.dll | |
2ca22b03 NC |
6914 | @end example |
6915 | ||
69da35b5 NC |
6916 | before moving on to the next directory in the search path. |
6917 | ||
c0065db7 RM |
6918 | (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll}, |
6919 | where @samp{<prefix>} is set by the @command{ld} option | |
6920 | @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec | |
6921 | file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for | |
69da35b5 NC |
6922 | @samp{cygxxx.dll}. |
6923 | ||
c0065db7 RM |
6924 | Other win32-based unix environments, such as mingw or pw32, may use other |
6925 | @samp{<prefix>}es, although at present only cygwin makes use of this feature. It | |
69da35b5 NC |
6926 | was originally intended to help avoid name conflicts among dll's built for the |
6927 | various win32/un*x environments, so that (for example) two versions of a zlib dll | |
6928 | could coexist on the same machine. | |
6929 | ||
2ca22b03 NC |
6930 | The generic cygwin/mingw path layout uses a @samp{bin} directory for |
6931 | applications and dll's and a @samp{lib} directory for the import | |
69da35b5 | 6932 | libraries (using cygwin nomenclature): |
2ca22b03 NC |
6933 | |
6934 | @example | |
6935 | bin/ | |
6936 | cygxxx.dll | |
6937 | lib/ | |
6938 | libxxx.dll.a (in case of dll's) | |
c0065db7 | 6939 | libxxx.a (in case of static archive) |
2ca22b03 NC |
6940 | @end example |
6941 | ||
c0065db7 RM |
6942 | Linking directly to a dll without using the import library can be |
6943 | done two ways: | |
2ca22b03 NC |
6944 | |
6945 | 1. Use the dll directly by adding the @samp{bin} path to the link line | |
6946 | @example | |
6947 | gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx | |
c0065db7 | 6948 | @end example |
2ca22b03 | 6949 | |
69da35b5 NC |
6950 | However, as the dll's often have version numbers appended to their names |
6951 | (@samp{cygncurses-5.dll}) this will often fail, unless one specifies | |
6952 | @samp{-L../bin -lncurses-5} to include the version. Import libs are generally | |
6953 | not versioned, and do not have this difficulty. | |
6954 | ||
2ca22b03 NC |
6955 | 2. Create a symbolic link from the dll to a file in the @samp{lib} |
6956 | directory according to the above mentioned search pattern. This | |
6957 | should be used to avoid unwanted changes in the tools needed for | |
6958 | making the app/dll. | |
6959 | ||
6960 | @example | |
6961 | ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a] | |
c0065db7 | 6962 | @end example |
2ca22b03 NC |
6963 | |
6964 | Then you can link without any make environment changes. | |
6965 | ||
6966 | @example | |
6967 | gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx | |
c0065db7 | 6968 | @end example |
69da35b5 NC |
6969 | |
6970 | This technique also avoids the version number problems, because the following is | |
6971 | perfectly legal | |
6972 | ||
6973 | @example | |
6974 | bin/ | |
6975 | cygxxx-5.dll | |
6976 | lib/ | |
c0065db7 | 6977 | libxxx.dll.a -> ../bin/cygxxx-5.dll |
69da35b5 NC |
6978 | @end example |
6979 | ||
dc8465bf | 6980 | Linking directly to a dll without using an import lib will work |
69da35b5 NC |
6981 | even when auto-import features are exercised, and even when |
6982 | @samp{--enable-runtime-pseudo-relocs} is used. | |
6983 | ||
6984 | Given the improvements in speed and memory usage, one might justifiably | |
45e948fe | 6985 | wonder why import libraries are used at all. There are three reasons: |
69da35b5 NC |
6986 | |
6987 | 1. Until recently, the link-directly-to-dll functionality did @emph{not} | |
6988 | work with auto-imported data. | |
6989 | ||
dc8465bf NC |
6990 | 2. Sometimes it is necessary to include pure static objects within the |
6991 | import library (which otherwise contains only bfd's for indirection | |
6992 | symbols that point to the exports of a dll). Again, the import lib | |
6993 | for the cygwin kernel makes use of this ability, and it is not | |
6994 | possible to do this without an import lib. | |
69da35b5 | 6995 | |
45e948fe NC |
6996 | 3. Symbol aliases can only be resolved using an import lib. This is |
6997 | critical when linking against OS-supplied dll's (eg, the win32 API) | |
6998 | in which symbols are usually exported as undecorated aliases of their | |
6999 | stdcall-decorated assembly names. | |
7000 | ||
69da35b5 | 7001 | So, import libs are not going away. But the ability to replace |
c0065db7 RM |
7002 | true import libs with a simple symbolic link to (or a copy of) |
7003 | a dll, in many cases, is a useful addition to the suite of tools | |
7004 | binutils makes available to the win32 developer. Given the | |
69da35b5 NC |
7005 | massive improvements in memory requirements during linking, storage |
7006 | requirements, and linking speed, we expect that many developers | |
7007 | will soon begin to use this feature whenever possible. | |
dc8465bf | 7008 | |
c0065db7 | 7009 | @item symbol aliasing |
dc8465bf | 7010 | @table @emph |
c0065db7 RM |
7011 | @item adding additional names |
7012 | Sometimes, it is useful to export symbols with additional names. | |
dc8465bf NC |
7013 | A symbol @samp{foo} will be exported as @samp{foo}, but it can also be |
7014 | exported as @samp{_foo} by using special directives in the DEF file | |
7015 | when creating the dll. This will affect also the optional created | |
c0065db7 | 7016 | import library. Consider the following DEF file: |
dc8465bf | 7017 | |
c0065db7 | 7018 | @example |
dc8465bf NC |
7019 | LIBRARY "xyz.dll" BASE=0x61000000 |
7020 | ||
7021 | EXPORTS | |
c0065db7 | 7022 | foo |
dc8465bf | 7023 | _foo = foo |
c0065db7 | 7024 | @end example |
dc8465bf NC |
7025 | |
7026 | The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}. | |
7027 | ||
7028 | Another method for creating a symbol alias is to create it in the | |
7029 | source code using the "weak" attribute: | |
7030 | ||
c0065db7 RM |
7031 | @example |
7032 | void foo () @{ /* Do something. */; @} | |
dc8465bf | 7033 | void _foo () __attribute__ ((weak, alias ("foo"))); |
c0065db7 | 7034 | @end example |
dc8465bf NC |
7035 | |
7036 | See the gcc manual for more information about attributes and weak | |
7037 | symbols. | |
7038 | ||
7039 | @item renaming symbols | |
7040 | Sometimes it is useful to rename exports. For instance, the cygwin | |
c0065db7 | 7041 | kernel does this regularly. A symbol @samp{_foo} can be exported as |
dc8465bf NC |
7042 | @samp{foo} but not as @samp{_foo} by using special directives in the |
7043 | DEF file. (This will also affect the import library, if it is | |
c0065db7 | 7044 | created). In the following example: |
dc8465bf | 7045 | |
c0065db7 | 7046 | @example |
dc8465bf NC |
7047 | LIBRARY "xyz.dll" BASE=0x61000000 |
7048 | ||
7049 | EXPORTS | |
7050 | _foo = foo | |
c0065db7 | 7051 | @end example |
dc8465bf NC |
7052 | |
7053 | The line @samp{_foo = foo} maps the exported symbol @samp{foo} to | |
7054 | @samp{_foo}. | |
c0065db7 | 7055 | @end table |
dc8465bf | 7056 | |
0a5d968e | 7057 | Note: using a DEF file disables the default auto-export behavior, |
c0065db7 | 7058 | unless the @samp{--export-all-symbols} command line option is used. |
0a5d968e | 7059 | If, however, you are trying to rename symbols, then you should list |
c0065db7 RM |
7060 | @emph{all} desired exports in the DEF file, including the symbols |
7061 | that are not being renamed, and do @emph{not} use the | |
7062 | @samp{--export-all-symbols} option. If you list only the | |
7063 | renamed symbols in the DEF file, and use @samp{--export-all-symbols} | |
7064 | to handle the other symbols, then the both the new names @emph{and} | |
7065 | the original names for the renamed symbols will be exported. | |
7066 | In effect, you'd be aliasing those symbols, not renaming them, | |
0a5d968e | 7067 | which is probably not what you wanted. |
c87db184 CF |
7068 | |
7069 | @cindex weak externals | |
7070 | @item weak externals | |
7071 | The Windows object format, PE, specifies a form of weak symbols called | |
7072 | weak externals. When a weak symbol is linked and the symbol is not | |
7073 | defined, the weak symbol becomes an alias for some other symbol. There | |
7074 | are three variants of weak externals: | |
7075 | @itemize | |
7076 | @item Definition is searched for in objects and libraries, historically | |
7077 | called lazy externals. | |
7078 | @item Definition is searched for only in other objects, not in libraries. | |
7079 | This form is not presently implemented. | |
7080 | @item No search; the symbol is an alias. This form is not presently | |
7081 | implemented. | |
7082 | @end itemize | |
7083 | As a GNU extension, weak symbols that do not specify an alternate symbol | |
7084 | are supported. If the symbol is undefined when linking, the symbol | |
7085 | uses a default value. | |
c1711530 DK |
7086 | |
7087 | @cindex aligned common symbols | |
7088 | @item aligned common symbols | |
7089 | As a GNU extension to the PE file format, it is possible to specify the | |
7090 | desired alignment for a common symbol. This information is conveyed from | |
7091 | the assembler or compiler to the linker by means of GNU-specific commands | |
7092 | carried in the object file's @samp{.drectve} section, which are recognized | |
7093 | by @command{ld} and respected when laying out the common symbols. Native | |
7094 | tools will be able to process object files employing this GNU extension, | |
7095 | but will fail to respect the alignment instructions, and may issue noisy | |
7096 | warnings about unknown linker directives. | |
2ca22b03 NC |
7097 | @end table |
7098 | ||
7099 | @ifclear GENERIC | |
7100 | @lowersections | |
7101 | @end ifclear | |
7102 | @end ifset | |
7103 | ||
e0001a05 NC |
7104 | @ifset XTENSA |
7105 | @ifclear GENERIC | |
7106 | @raisesections | |
7107 | @end ifclear | |
7108 | ||
7109 | @node Xtensa | |
7110 | @section @code{ld} and Xtensa Processors | |
7111 | ||
7112 | @cindex Xtensa processors | |
7113 | The default @command{ld} behavior for Xtensa processors is to interpret | |
7114 | @code{SECTIONS} commands so that lists of explicitly named sections in a | |
7115 | specification with a wildcard file will be interleaved when necessary to | |
7116 | keep literal pools within the range of PC-relative load offsets. For | |
7117 | example, with the command: | |
7118 | ||
7119 | @smallexample | |
7120 | SECTIONS | |
7121 | @{ | |
7122 | .text : @{ | |
7123 | *(.literal .text) | |
7124 | @} | |
7125 | @} | |
7126 | @end smallexample | |
7127 | ||
7128 | @noindent | |
7129 | @command{ld} may interleave some of the @code{.literal} | |
7130 | and @code{.text} sections from different object files to ensure that the | |
7131 | literal pools are within the range of PC-relative load offsets. A valid | |
7132 | interleaving might place the @code{.literal} sections from an initial | |
7133 | group of files followed by the @code{.text} sections of that group of | |
7134 | files. Then, the @code{.literal} sections from the rest of the files | |
7135 | and the @code{.text} sections from the rest of the files would follow. | |
e0001a05 | 7136 | |
43cd72b9 | 7137 | @cindex @option{--relax} on Xtensa |
e0001a05 | 7138 | @cindex relaxing on Xtensa |
43cd72b9 BW |
7139 | Relaxation is enabled by default for the Xtensa version of @command{ld} and |
7140 | provides two important link-time optimizations. The first optimization | |
7141 | is to combine identical literal values to reduce code size. A redundant | |
7142 | literal will be removed and all the @code{L32R} instructions that use it | |
7143 | will be changed to reference an identical literal, as long as the | |
7144 | location of the replacement literal is within the offset range of all | |
7145 | the @code{L32R} instructions. The second optimization is to remove | |
7146 | unnecessary overhead from assembler-generated ``longcall'' sequences of | |
7147 | @code{L32R}/@code{CALLX@var{n}} when the target functions are within | |
7148 | range of direct @code{CALL@var{n}} instructions. | |
7149 | ||
7150 | For each of these cases where an indirect call sequence can be optimized | |
7151 | to a direct call, the linker will change the @code{CALLX@var{n}} | |
7152 | instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R} | |
7153 | instruction, and remove the literal referenced by the @code{L32R} | |
7154 | instruction if it is not used for anything else. Removing the | |
7155 | @code{L32R} instruction always reduces code size but can potentially | |
7156 | hurt performance by changing the alignment of subsequent branch targets. | |
7157 | By default, the linker will always preserve alignments, either by | |
7158 | switching some instructions between 24-bit encodings and the equivalent | |
7159 | density instructions or by inserting a no-op in place of the @code{L32R} | |
7160 | instruction that was removed. If code size is more important than | |
7161 | performance, the @option{--size-opt} option can be used to prevent the | |
7162 | linker from widening density instructions or inserting no-ops, except in | |
7163 | a few cases where no-ops are required for correctness. | |
7164 | ||
7165 | The following Xtensa-specific command-line options can be used to | |
7166 | control the linker: | |
7167 | ||
7168 | @cindex Xtensa options | |
7169 | @table @option | |
43cd72b9 BW |
7170 | @item --size-opt |
7171 | When optimizing indirect calls to direct calls, optimize for code size | |
7172 | more than performance. With this option, the linker will not insert | |
7173 | no-ops or widen density instructions to preserve branch target | |
7174 | alignment. There may still be some cases where no-ops are required to | |
7175 | preserve the correctness of the code. | |
7176 | @end table | |
e0001a05 NC |
7177 | |
7178 | @ifclear GENERIC | |
7179 | @lowersections | |
7180 | @end ifclear | |
7181 | @end ifset | |
7182 | ||
252b5132 RH |
7183 | @ifclear SingleFormat |
7184 | @node BFD | |
7185 | @chapter BFD | |
7186 | ||
7187 | @cindex back end | |
7188 | @cindex object file management | |
7189 | @cindex object formats available | |
7190 | @kindex objdump -i | |
7191 | The linker accesses object and archive files using the BFD libraries. | |
7192 | These libraries allow the linker to use the same routines to operate on | |
7193 | object files whatever the object file format. A different object file | |
7194 | format can be supported simply by creating a new BFD back end and adding | |
7195 | it to the library. To conserve runtime memory, however, the linker and | |
7196 | associated tools are usually configured to support only a subset of the | |
7197 | object file formats available. You can use @code{objdump -i} | |
7198 | (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to | |
7199 | list all the formats available for your configuration. | |
7200 | ||
7201 | @cindex BFD requirements | |
7202 | @cindex requirements for BFD | |
7203 | As with most implementations, BFD is a compromise between | |
7204 | several conflicting requirements. The major factor influencing | |
7205 | BFD design was efficiency: any time used converting between | |
7206 | formats is time which would not have been spent had BFD not | |
7207 | been involved. This is partly offset by abstraction payback; since | |
7208 | BFD simplifies applications and back ends, more time and care | |
7209 | may be spent optimizing algorithms for a greater speed. | |
7210 | ||
7211 | One minor artifact of the BFD solution which you should bear in | |
7212 | mind is the potential for information loss. There are two places where | |
7213 | useful information can be lost using the BFD mechanism: during | |
7214 | conversion and during output. @xref{BFD information loss}. | |
7215 | ||
7216 | @menu | |
7217 | * BFD outline:: How it works: an outline of BFD | |
7218 | @end menu | |
7219 | ||
7220 | @node BFD outline | |
36f63dca | 7221 | @section How It Works: An Outline of BFD |
252b5132 RH |
7222 | @cindex opening object files |
7223 | @include bfdsumm.texi | |
7224 | @end ifclear | |
7225 | ||
7226 | @node Reporting Bugs | |
7227 | @chapter Reporting Bugs | |
ff5dcc92 SC |
7228 | @cindex bugs in @command{ld} |
7229 | @cindex reporting bugs in @command{ld} | |
252b5132 | 7230 | |
ff5dcc92 | 7231 | Your bug reports play an essential role in making @command{ld} reliable. |
252b5132 RH |
7232 | |
7233 | Reporting a bug may help you by bringing a solution to your problem, or | |
7234 | it may not. But in any case the principal function of a bug report is | |
ff5dcc92 | 7235 | to help the entire community by making the next version of @command{ld} |
252b5132 | 7236 | work better. Bug reports are your contribution to the maintenance of |
ff5dcc92 | 7237 | @command{ld}. |
252b5132 RH |
7238 | |
7239 | In order for a bug report to serve its purpose, you must include the | |
7240 | information that enables us to fix the bug. | |
7241 | ||
7242 | @menu | |
7243 | * Bug Criteria:: Have you found a bug? | |
7244 | * Bug Reporting:: How to report bugs | |
7245 | @end menu | |
7246 | ||
7247 | @node Bug Criteria | |
36f63dca | 7248 | @section Have You Found a Bug? |
252b5132 RH |
7249 | @cindex bug criteria |
7250 | ||
7251 | If you are not sure whether you have found a bug, here are some guidelines: | |
7252 | ||
7253 | @itemize @bullet | |
7254 | @cindex fatal signal | |
7255 | @cindex linker crash | |
7256 | @cindex crash of linker | |
7257 | @item | |
7258 | If the linker gets a fatal signal, for any input whatever, that is a | |
ff5dcc92 | 7259 | @command{ld} bug. Reliable linkers never crash. |
252b5132 RH |
7260 | |
7261 | @cindex error on valid input | |
7262 | @item | |
ff5dcc92 | 7263 | If @command{ld} produces an error message for valid input, that is a bug. |
252b5132 RH |
7264 | |
7265 | @cindex invalid input | |
7266 | @item | |
ff5dcc92 | 7267 | If @command{ld} does not produce an error message for invalid input, that |
252b5132 RH |
7268 | may be a bug. In the general case, the linker can not verify that |
7269 | object files are correct. | |
7270 | ||
7271 | @item | |
7272 | If you are an experienced user of linkers, your suggestions for | |
ff5dcc92 | 7273 | improvement of @command{ld} are welcome in any case. |
252b5132 RH |
7274 | @end itemize |
7275 | ||
7276 | @node Bug Reporting | |
36f63dca | 7277 | @section How to Report Bugs |
252b5132 | 7278 | @cindex bug reports |
ff5dcc92 | 7279 | @cindex @command{ld} bugs, reporting |
252b5132 RH |
7280 | |
7281 | A number of companies and individuals offer support for @sc{gnu} | |
ff5dcc92 | 7282 | products. If you obtained @command{ld} from a support organization, we |
252b5132 RH |
7283 | recommend you contact that organization first. |
7284 | ||
7285 | You can find contact information for many support companies and | |
7286 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
7287 | distribution. | |
7288 | ||
ad22bfe8 | 7289 | @ifset BUGURL |
ff5dcc92 | 7290 | Otherwise, send bug reports for @command{ld} to |
ad22bfe8 JM |
7291 | @value{BUGURL}. |
7292 | @end ifset | |
252b5132 RH |
7293 | |
7294 | The fundamental principle of reporting bugs usefully is this: | |
7295 | @strong{report all the facts}. If you are not sure whether to state a | |
7296 | fact or leave it out, state it! | |
7297 | ||
7298 | Often people omit facts because they think they know what causes the | |
7299 | problem and assume that some details do not matter. Thus, you might | |
b553b183 NC |
7300 | assume that the name of a symbol you use in an example does not |
7301 | matter. Well, probably it does not, but one cannot be sure. Perhaps | |
7302 | the bug is a stray memory reference which happens to fetch from the | |
7303 | location where that name is stored in memory; perhaps, if the name | |
7304 | were different, the contents of that location would fool the linker | |
7305 | into doing the right thing despite the bug. Play it safe and give a | |
7306 | specific, complete example. That is the easiest thing for you to do, | |
c0065db7 | 7307 | and the most helpful. |
b553b183 NC |
7308 | |
7309 | Keep in mind that the purpose of a bug report is to enable us to fix | |
7310 | the bug if it is new to us. Therefore, always write your bug reports | |
7311 | on the assumption that the bug has not been reported previously. | |
252b5132 RH |
7312 | |
7313 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
36f63dca NC |
7314 | bell?'' This cannot help us fix a bug, so it is basically useless. We |
7315 | respond by asking for enough details to enable us to investigate. | |
7316 | You might as well expedite matters by sending them to begin with. | |
252b5132 RH |
7317 | |
7318 | To enable us to fix the bug, you should include all these things: | |
7319 | ||
7320 | @itemize @bullet | |
7321 | @item | |
ff5dcc92 | 7322 | The version of @command{ld}. @command{ld} announces it if you start it with |
252b5132 RH |
7323 | the @samp{--version} argument. |
7324 | ||
7325 | Without this, we will not know whether there is any point in looking for | |
ff5dcc92 | 7326 | the bug in the current version of @command{ld}. |
252b5132 RH |
7327 | |
7328 | @item | |
ff5dcc92 | 7329 | Any patches you may have applied to the @command{ld} source, including any |
252b5132 RH |
7330 | patches made to the @code{BFD} library. |
7331 | ||
7332 | @item | |
7333 | The type of machine you are using, and the operating system name and | |
7334 | version number. | |
7335 | ||
7336 | @item | |
ff5dcc92 | 7337 | What compiler (and its version) was used to compile @command{ld}---e.g. |
252b5132 RH |
7338 | ``@code{gcc-2.7}''. |
7339 | ||
7340 | @item | |
7341 | The command arguments you gave the linker to link your example and | |
7342 | observe the bug. To guarantee you will not omit something important, | |
7343 | list them all. A copy of the Makefile (or the output from make) is | |
7344 | sufficient. | |
7345 | ||
7346 | If we were to try to guess the arguments, we would probably guess wrong | |
7347 | and then we might not encounter the bug. | |
7348 | ||
7349 | @item | |
7350 | A complete input file, or set of input files, that will reproduce the | |
b553b183 NC |
7351 | bug. It is generally most helpful to send the actual object files |
7352 | provided that they are reasonably small. Say no more than 10K. For | |
7353 | bigger files you can either make them available by FTP or HTTP or else | |
7354 | state that you are willing to send the object file(s) to whomever | |
7355 | requests them. (Note - your email will be going to a mailing list, so | |
7356 | we do not want to clog it up with large attachments). But small | |
7357 | attachments are best. | |
252b5132 RH |
7358 | |
7359 | If the source files were assembled using @code{gas} or compiled using | |
7360 | @code{gcc}, then it may be OK to send the source files rather than the | |
7361 | object files. In this case, be sure to say exactly what version of | |
7362 | @code{gas} or @code{gcc} was used to produce the object files. Also say | |
7363 | how @code{gas} or @code{gcc} were configured. | |
7364 | ||
7365 | @item | |
7366 | A description of what behavior you observe that you believe is | |
7367 | incorrect. For example, ``It gets a fatal signal.'' | |
7368 | ||
ff5dcc92 | 7369 | Of course, if the bug is that @command{ld} gets a fatal signal, then we |
252b5132 RH |
7370 | will certainly notice it. But if the bug is incorrect output, we might |
7371 | not notice unless it is glaringly wrong. You might as well not give us | |
7372 | a chance to make a mistake. | |
7373 | ||
7374 | Even if the problem you experience is a fatal signal, you should still | |
7375 | say so explicitly. Suppose something strange is going on, such as, your | |
b45619c0 | 7376 | copy of @command{ld} is out of sync, or you have encountered a bug in the |
252b5132 RH |
7377 | C library on your system. (This has happened!) Your copy might crash |
7378 | and ours would not. If you told us to expect a crash, then when ours | |
7379 | fails to crash, we would know that the bug was not happening for us. If | |
7380 | you had not told us to expect a crash, then we would not be able to draw | |
7381 | any conclusion from our observations. | |
7382 | ||
7383 | @item | |
ff5dcc92 | 7384 | If you wish to suggest changes to the @command{ld} source, send us context |
252b5132 RH |
7385 | diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or |
7386 | @samp{-p} option. Always send diffs from the old file to the new file. | |
ff5dcc92 | 7387 | If you even discuss something in the @command{ld} source, refer to it by |
252b5132 RH |
7388 | context, not by line number. |
7389 | ||
7390 | The line numbers in our development sources will not match those in your | |
7391 | sources. Your line numbers would convey no useful information to us. | |
7392 | @end itemize | |
7393 | ||
7394 | Here are some things that are not necessary: | |
7395 | ||
7396 | @itemize @bullet | |
7397 | @item | |
7398 | A description of the envelope of the bug. | |
7399 | ||
7400 | Often people who encounter a bug spend a lot of time investigating | |
7401 | which changes to the input file will make the bug go away and which | |
7402 | changes will not affect it. | |
7403 | ||
7404 | This is often time consuming and not very useful, because the way we | |
7405 | will find the bug is by running a single example under the debugger | |
7406 | with breakpoints, not by pure deduction from a series of examples. | |
7407 | We recommend that you save your time for something else. | |
7408 | ||
7409 | Of course, if you can find a simpler example to report @emph{instead} | |
7410 | of the original one, that is a convenience for us. Errors in the | |
7411 | output will be easier to spot, running under the debugger will take | |
7412 | less time, and so on. | |
7413 | ||
7414 | However, simplification is not vital; if you do not want to do this, | |
7415 | report the bug anyway and send us the entire test case you used. | |
7416 | ||
7417 | @item | |
7418 | A patch for the bug. | |
7419 | ||
7420 | A patch for the bug does help us if it is a good one. But do not omit | |
7421 | the necessary information, such as the test case, on the assumption that | |
7422 | a patch is all we need. We might see problems with your patch and decide | |
7423 | to fix the problem another way, or we might not understand it at all. | |
7424 | ||
ff5dcc92 | 7425 | Sometimes with a program as complicated as @command{ld} it is very hard to |
252b5132 RH |
7426 | construct an example that will make the program follow a certain path |
7427 | through the code. If you do not send us the example, we will not be | |
7428 | able to construct one, so we will not be able to verify that the bug is | |
7429 | fixed. | |
7430 | ||
7431 | And if we cannot understand what bug you are trying to fix, or why your | |
7432 | patch should be an improvement, we will not install it. A test case will | |
7433 | help us to understand. | |
7434 | ||
7435 | @item | |
7436 | A guess about what the bug is or what it depends on. | |
7437 | ||
7438 | Such guesses are usually wrong. Even we cannot guess right about such | |
7439 | things without first using the debugger to find the facts. | |
7440 | @end itemize | |
7441 | ||
7442 | @node MRI | |
7443 | @appendix MRI Compatible Script Files | |
7444 | @cindex MRI compatibility | |
ff5dcc92 SC |
7445 | To aid users making the transition to @sc{gnu} @command{ld} from the MRI |
7446 | linker, @command{ld} can use MRI compatible linker scripts as an | |
252b5132 RH |
7447 | alternative to the more general-purpose linker scripting language |
7448 | described in @ref{Scripts}. MRI compatible linker scripts have a much | |
7449 | simpler command set than the scripting language otherwise used with | |
ff5dcc92 | 7450 | @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI |
252b5132 RH |
7451 | linker commands; these commands are described here. |
7452 | ||
7453 | In general, MRI scripts aren't of much use with the @code{a.out} object | |
7454 | file format, since it only has three sections and MRI scripts lack some | |
7455 | features to make use of them. | |
7456 | ||
7457 | You can specify a file containing an MRI-compatible script using the | |
7458 | @samp{-c} command-line option. | |
7459 | ||
7460 | Each command in an MRI-compatible script occupies its own line; each | |
7461 | command line starts with the keyword that identifies the command (though | |
7462 | blank lines are also allowed for punctuation). If a line of an | |
ff5dcc92 | 7463 | MRI-compatible script begins with an unrecognized keyword, @command{ld} |
252b5132 RH |
7464 | issues a warning message, but continues processing the script. |
7465 | ||
7466 | Lines beginning with @samp{*} are comments. | |
7467 | ||
7468 | You can write these commands using all upper-case letters, or all | |
7469 | lower case; for example, @samp{chip} is the same as @samp{CHIP}. | |
7470 | The following list shows only the upper-case form of each command. | |
7471 | ||
7472 | @table @code | |
7473 | @cindex @code{ABSOLUTE} (MRI) | |
7474 | @item ABSOLUTE @var{secname} | |
7475 | @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname} | |
ff5dcc92 | 7476 | Normally, @command{ld} includes in the output file all sections from all |
252b5132 RH |
7477 | the input files. However, in an MRI-compatible script, you can use the |
7478 | @code{ABSOLUTE} command to restrict the sections that will be present in | |
7479 | your output program. If the @code{ABSOLUTE} command is used at all in a | |
7480 | script, then only the sections named explicitly in @code{ABSOLUTE} | |
7481 | commands will appear in the linker output. You can still use other | |
7482 | input sections (whatever you select on the command line, or using | |
7483 | @code{LOAD}) to resolve addresses in the output file. | |
7484 | ||
7485 | @cindex @code{ALIAS} (MRI) | |
7486 | @item ALIAS @var{out-secname}, @var{in-secname} | |
7487 | Use this command to place the data from input section @var{in-secname} | |
7488 | in a section called @var{out-secname} in the linker output file. | |
7489 | ||
7490 | @var{in-secname} may be an integer. | |
7491 | ||
7492 | @cindex @code{ALIGN} (MRI) | |
7493 | @item ALIGN @var{secname} = @var{expression} | |
7494 | Align the section called @var{secname} to @var{expression}. The | |
7495 | @var{expression} should be a power of two. | |
7496 | ||
7497 | @cindex @code{BASE} (MRI) | |
7498 | @item BASE @var{expression} | |
7499 | Use the value of @var{expression} as the lowest address (other than | |
7500 | absolute addresses) in the output file. | |
7501 | ||
7502 | @cindex @code{CHIP} (MRI) | |
7503 | @item CHIP @var{expression} | |
7504 | @itemx CHIP @var{expression}, @var{expression} | |
7505 | This command does nothing; it is accepted only for compatibility. | |
7506 | ||
7507 | @cindex @code{END} (MRI) | |
7508 | @item END | |
7509 | This command does nothing whatever; it's only accepted for compatibility. | |
7510 | ||
7511 | @cindex @code{FORMAT} (MRI) | |
7512 | @item FORMAT @var{output-format} | |
7513 | Similar to the @code{OUTPUT_FORMAT} command in the more general linker | |
a1ab1d2a | 7514 | language, but restricted to one of these output formats: |
252b5132 RH |
7515 | |
7516 | @enumerate | |
a1ab1d2a | 7517 | @item |
252b5132 RH |
7518 | S-records, if @var{output-format} is @samp{S} |
7519 | ||
7520 | @item | |
7521 | IEEE, if @var{output-format} is @samp{IEEE} | |
7522 | ||
7523 | @item | |
7524 | COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is | |
7525 | @samp{COFF} | |
7526 | @end enumerate | |
7527 | ||
7528 | @cindex @code{LIST} (MRI) | |
7529 | @item LIST @var{anything}@dots{} | |
7530 | Print (to the standard output file) a link map, as produced by the | |
ff5dcc92 | 7531 | @command{ld} command-line option @samp{-M}. |
252b5132 RH |
7532 | |
7533 | The keyword @code{LIST} may be followed by anything on the | |
7534 | same line, with no change in its effect. | |
7535 | ||
7536 | @cindex @code{LOAD} (MRI) | |
7537 | @item LOAD @var{filename} | |
7538 | @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename} | |
7539 | Include one or more object file @var{filename} in the link; this has the | |
ff5dcc92 | 7540 | same effect as specifying @var{filename} directly on the @command{ld} |
252b5132 RH |
7541 | command line. |
7542 | ||
7543 | @cindex @code{NAME} (MRI) | |
7544 | @item NAME @var{output-name} | |
ff5dcc92 | 7545 | @var{output-name} is the name for the program produced by @command{ld}; the |
252b5132 RH |
7546 | MRI-compatible command @code{NAME} is equivalent to the command-line |
7547 | option @samp{-o} or the general script language command @code{OUTPUT}. | |
7548 | ||
7549 | @cindex @code{ORDER} (MRI) | |
7550 | @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname} | |
7551 | @itemx ORDER @var{secname} @var{secname} @var{secname} | |
ff5dcc92 | 7552 | Normally, @command{ld} orders the sections in its output file in the |
252b5132 RH |
7553 | order in which they first appear in the input files. In an MRI-compatible |
7554 | script, you can override this ordering with the @code{ORDER} command. The | |
7555 | sections you list with @code{ORDER} will appear first in your output | |
7556 | file, in the order specified. | |
7557 | ||
7558 | @cindex @code{PUBLIC} (MRI) | |
7559 | @item PUBLIC @var{name}=@var{expression} | |
7560 | @itemx PUBLIC @var{name},@var{expression} | |
7561 | @itemx PUBLIC @var{name} @var{expression} | |
7562 | Supply a value (@var{expression}) for external symbol | |
7563 | @var{name} used in the linker input files. | |
7564 | ||
7565 | @cindex @code{SECT} (MRI) | |
7566 | @item SECT @var{secname}, @var{expression} | |
7567 | @itemx SECT @var{secname}=@var{expression} | |
7568 | @itemx SECT @var{secname} @var{expression} | |
7569 | You can use any of these three forms of the @code{SECT} command to | |
7570 | specify the start address (@var{expression}) for section @var{secname}. | |
7571 | If you have more than one @code{SECT} statement for the same | |
7572 | @var{secname}, only the @emph{first} sets the start address. | |
7573 | @end table | |
7574 | ||
793c5807 NC |
7575 | @node GNU Free Documentation License |
7576 | @appendix GNU Free Documentation License | |
36f63dca | 7577 | @include fdl.texi |
704c465c | 7578 | |
370b66a1 CD |
7579 | @node LD Index |
7580 | @unnumbered LD Index | |
252b5132 RH |
7581 | |
7582 | @printindex cp | |
7583 | ||
7584 | @tex | |
7585 | % I think something like @colophon should be in texinfo. In the | |
7586 | % meantime: | |
7587 | \long\def\colophon{\hbox to0pt{}\vfill | |
7588 | \centerline{The body of this manual is set in} | |
7589 | \centerline{\fontname\tenrm,} | |
7590 | \centerline{with headings in {\bf\fontname\tenbf}} | |
7591 | \centerline{and examples in {\tt\fontname\tentt}.} | |
7592 | \centerline{{\it\fontname\tenit\/} and} | |
7593 | \centerline{{\sl\fontname\tensl\/}} | |
7594 | \centerline{are used for emphasis.}\vfill} | |
7595 | \page\colophon | |
7596 | % Blame: doc@cygnus.com, 28mar91. | |
7597 | @end tex | |
7598 | ||
252b5132 | 7599 | @bye |