Commit | Line | Data |
---|---|---|
252b5132 RH |
1 | \input texinfo |
2 | @setfilename ld.info | |
6f2750fe | 3 | @c Copyright (C) 1991-2016 Free Software Foundation, Inc. |
252b5132 | 4 | @syncodeindex ky cp |
dff70155 | 5 | @c man begin INCLUDE |
252b5132 RH |
6 | @include configdoc.texi |
7 | @c (configdoc.texi is generated by the Makefile) | |
c428fa83 | 8 | @include bfdver.texi |
dff70155 | 9 | @c man end |
252b5132 RH |
10 | |
11 | @c @smallbook | |
12 | ||
ff5dcc92 SC |
13 | @macro gcctabopt{body} |
14 | @code{\body\} | |
15 | @end macro | |
16 | ||
0285c67d NC |
17 | @c man begin NAME |
18 | @ifset man | |
19 | @c Configure for the generation of man pages | |
20 | @set UsesEnvVars | |
21 | @set GENERIC | |
0285c67d | 22 | @set ARM |
ac145307 | 23 | @set C6X |
49fa1e15 | 24 | @set H8300 |
0285c67d | 25 | @set HPPA |
0285c67d | 26 | @set I960 |
0285c67d | 27 | @set M68HC11 |
7fb9f789 | 28 | @set M68K |
833794fc | 29 | @set MIPS |
3c3bdf30 | 30 | @set MMIX |
2469cfa2 | 31 | @set MSP430 |
35c08157 | 32 | @set NDS32 |
78058a5e | 33 | @set NIOSII |
2a60a7a8 AM |
34 | @set POWERPC |
35 | @set POWERPC64 | |
49fa1e15 AM |
36 | @set Renesas |
37 | @set SPU | |
38 | @set TICOFF | |
2ca22b03 | 39 | @set WIN32 |
e0001a05 | 40 | @set XTENSA |
0285c67d NC |
41 | @end ifset |
42 | @c man end | |
43 | ||
9160ea82 AM |
44 | @ifnottex |
45 | @dircategory Software development | |
46 | @direntry | |
252b5132 | 47 | * Ld: (ld). The GNU linker. |
9160ea82 AM |
48 | @end direntry |
49 | @end ifnottex | |
252b5132 | 50 | |
0e9517a9 | 51 | @copying |
e49e529d JM |
52 | This file documents the @sc{gnu} linker LD |
53 | @ifset VERSION_PACKAGE | |
54 | @value{VERSION_PACKAGE} | |
55 | @end ifset | |
56 | version @value{VERSION}. | |
252b5132 | 57 | |
6f2750fe | 58 | Copyright @copyright{} 1991-2016 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 |
6f2750fe | 95 | Copyright @copyright{} 1991-2016 Free Software Foundation, Inc. |
252b5132 | 96 | |
0285c67d | 97 | Permission is granted to copy, distribute and/or modify this document |
793c5807 | 98 | under the terms of the GNU Free Documentation License, Version 1.3 |
0285c67d NC |
99 | or any later version published by the Free Software Foundation; |
100 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
101 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 102 | section entitled ``GNU Free Documentation License''. |
0285c67d | 103 | @c man end |
252b5132 | 104 | |
252b5132 RH |
105 | @end titlepage |
106 | @end iftex | |
4ecceb71 | 107 | @contents |
252b5132 RH |
108 | @c FIXME: Talk about importance of *order* of args, cmds to linker! |
109 | ||
84ec0e6d | 110 | @ifnottex |
252b5132 | 111 | @node Top |
71ba23f6 | 112 | @top LD |
e49e529d JM |
113 | This file documents the @sc{gnu} linker ld |
114 | @ifset VERSION_PACKAGE | |
115 | @value{VERSION_PACKAGE} | |
116 | @end ifset | |
117 | version @value{VERSION}. | |
252b5132 | 118 | |
cf055d54 | 119 | This document is distributed under the terms of the GNU Free |
793c5807 NC |
120 | Documentation License version 1.3. A copy of the license is included |
121 | in the section entitled ``GNU Free Documentation License''. | |
cf055d54 | 122 | |
252b5132 RH |
123 | @menu |
124 | * Overview:: Overview | |
125 | * Invocation:: Invocation | |
126 | * Scripts:: Linker Scripts | |
127 | @ifset GENERIC | |
128 | * Machine Dependent:: Machine Dependent Features | |
129 | @end ifset | |
130 | @ifclear GENERIC | |
131 | @ifset H8300 | |
132 | * H8/300:: ld and the H8/300 | |
133 | @end ifset | |
c2dcd04e NC |
134 | @ifset Renesas |
135 | * Renesas:: ld and other Renesas micros | |
252b5132 RH |
136 | @end ifset |
137 | @ifset I960 | |
138 | * i960:: ld and the Intel 960 family | |
139 | @end ifset | |
36f63dca NC |
140 | @ifset ARM |
141 | * ARM:: ld and the ARM family | |
142 | @end ifset | |
93fd0973 SC |
143 | @ifset M68HC11 |
144 | * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families | |
145 | @end ifset | |
7ca01ed9 NC |
146 | @ifset HPPA |
147 | * HPPA ELF32:: ld and HPPA 32-bit ELF | |
148 | @end ifset | |
7fb9f789 NC |
149 | @ifset M68K |
150 | * M68K:: ld and Motorola 68K family | |
151 | @end ifset | |
833794fc MR |
152 | @ifset MIPS |
153 | * MIPS:: ld and MIPS family | |
154 | @end ifset | |
2a60a7a8 AM |
155 | @ifset POWERPC |
156 | * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support | |
157 | @end ifset | |
158 | @ifset POWERPC64 | |
159 | * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support | |
160 | @end ifset | |
49fa1e15 AM |
161 | @ifset SPU |
162 | * SPU ELF:: ld and SPU ELF Support | |
163 | @end ifset | |
74459f0e TW |
164 | @ifset TICOFF |
165 | * TI COFF:: ld and the TI COFF | |
166 | @end ifset | |
2ca22b03 NC |
167 | @ifset WIN32 |
168 | * Win32:: ld and WIN32 (cygwin/mingw) | |
169 | @end ifset | |
e0001a05 NC |
170 | @ifset XTENSA |
171 | * Xtensa:: ld and Xtensa Processors | |
172 | @end ifset | |
252b5132 RH |
173 | @end ifclear |
174 | @ifclear SingleFormat | |
175 | * BFD:: BFD | |
176 | @end ifclear | |
177 | @c Following blank line required for remaining bug in makeinfo conds/menus | |
178 | ||
179 | * Reporting Bugs:: Reporting Bugs | |
180 | * MRI:: MRI Compatible Script Files | |
704c465c | 181 | * GNU Free Documentation License:: GNU Free Documentation License |
370b66a1 | 182 | * LD Index:: LD Index |
252b5132 | 183 | @end menu |
84ec0e6d | 184 | @end ifnottex |
252b5132 RH |
185 | |
186 | @node Overview | |
187 | @chapter Overview | |
188 | ||
189 | @cindex @sc{gnu} linker | |
190 | @cindex what is this? | |
0285c67d | 191 | |
0879a67a | 192 | @ifset man |
0285c67d | 193 | @c man begin SYNOPSIS |
ff5dcc92 | 194 | ld [@b{options}] @var{objfile} @dots{} |
0285c67d NC |
195 | @c man end |
196 | ||
197 | @c man begin SEEALSO | |
198 | ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and | |
199 | the Info entries for @file{binutils} and | |
200 | @file{ld}. | |
201 | @c man end | |
202 | @end ifset | |
203 | ||
204 | @c man begin DESCRIPTION | |
205 | ||
ff5dcc92 | 206 | @command{ld} combines a number of object and archive files, relocates |
252b5132 | 207 | their data and ties up symbol references. Usually the last step in |
ff5dcc92 | 208 | compiling a program is to run @command{ld}. |
252b5132 | 209 | |
ff5dcc92 | 210 | @command{ld} accepts Linker Command Language files written in |
252b5132 RH |
211 | a superset of AT&T's Link Editor Command Language syntax, |
212 | to provide explicit and total control over the linking process. | |
213 | ||
0285c67d NC |
214 | @ifset man |
215 | @c For the man only | |
ece2d90e | 216 | This man page does not describe the command language; see the |
71ba23f6 NC |
217 | @command{ld} entry in @code{info} for full details on the command |
218 | language and on other aspects of the GNU linker. | |
0285c67d NC |
219 | @end ifset |
220 | ||
252b5132 | 221 | @ifclear SingleFormat |
ff5dcc92 SC |
222 | This version of @command{ld} uses the general purpose BFD libraries |
223 | to operate on object files. This allows @command{ld} to read, combine, and | |
252b5132 RH |
224 | write object files in many different formats---for example, COFF or |
225 | @code{a.out}. Different formats may be linked together to produce any | |
226 | available kind of object file. @xref{BFD}, for more information. | |
227 | @end ifclear | |
228 | ||
229 | Aside from its flexibility, the @sc{gnu} linker is more helpful than other | |
230 | linkers in providing diagnostic information. Many linkers abandon | |
231 | execution immediately upon encountering an error; whenever possible, | |
ff5dcc92 | 232 | @command{ld} continues executing, allowing you to identify other errors |
252b5132 RH |
233 | (or, in some cases, to get an output file in spite of the error). |
234 | ||
0285c67d NC |
235 | @c man end |
236 | ||
252b5132 RH |
237 | @node Invocation |
238 | @chapter Invocation | |
239 | ||
0285c67d NC |
240 | @c man begin DESCRIPTION |
241 | ||
ff5dcc92 | 242 | The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations, |
252b5132 RH |
243 | and to be as compatible as possible with other linkers. As a result, |
244 | you have many choices to control its behavior. | |
245 | ||
0285c67d NC |
246 | @c man end |
247 | ||
252b5132 RH |
248 | @ifset UsesEnvVars |
249 | @menu | |
250 | * Options:: Command Line Options | |
251 | * Environment:: Environment Variables | |
252 | @end menu | |
253 | ||
254 | @node Options | |
255 | @section Command Line Options | |
256 | @end ifset | |
257 | ||
258 | @cindex command line | |
259 | @cindex options | |
0285c67d NC |
260 | |
261 | @c man begin OPTIONS | |
262 | ||
252b5132 RH |
263 | The linker supports a plethora of command-line options, but in actual |
264 | practice few of them are used in any particular context. | |
265 | @cindex standard Unix system | |
ff5dcc92 | 266 | For instance, a frequent use of @command{ld} is to link standard Unix |
252b5132 RH |
267 | object files on a standard, supported Unix system. On such a system, to |
268 | link a file @code{hello.o}: | |
269 | ||
270 | @smallexample | |
271 | ld -o @var{output} /lib/crt0.o hello.o -lc | |
272 | @end smallexample | |
273 | ||
ff5dcc92 | 274 | This tells @command{ld} to produce a file called @var{output} as the |
252b5132 RH |
275 | result of linking the file @code{/lib/crt0.o} with @code{hello.o} and |
276 | the library @code{libc.a}, which will come from the standard search | |
277 | directories. (See the discussion of the @samp{-l} option below.) | |
278 | ||
ff5dcc92 | 279 | Some of the command-line options to @command{ld} may be specified at any |
511ab9e9 ILT |
280 | point in the command line. However, options which refer to files, such |
281 | as @samp{-l} or @samp{-T}, cause the file to be read at the point at | |
282 | which the option appears in the command line, relative to the object | |
283 | files and other file options. Repeating non-file options with a | |
284 | different argument will either have no further effect, or override prior | |
252b5132 RH |
285 | occurrences (those further to the left on the command line) of that |
286 | option. Options which may be meaningfully specified more than once are | |
287 | noted in the descriptions below. | |
288 | ||
289 | @cindex object files | |
511ab9e9 ILT |
290 | Non-option arguments are object files or archives which are to be linked |
291 | together. They may follow, precede, or be mixed in with command-line | |
292 | options, except that an object file argument may not be placed between | |
293 | an option and its argument. | |
252b5132 RH |
294 | |
295 | Usually the linker is invoked with at least one object file, but you can | |
296 | specify other forms of binary input files using @samp{-l}, @samp{-R}, | |
297 | and the script command language. If @emph{no} binary input files at all | |
298 | are specified, the linker does not produce any output, and issues the | |
299 | message @samp{No input files}. | |
300 | ||
36f63dca | 301 | If the linker cannot recognize the format of an object file, it will |
252b5132 RH |
302 | assume that it is a linker script. A script specified in this way |
303 | augments the main linker script used for the link (either the default | |
304 | linker script or the one specified by using @samp{-T}). This feature | |
305 | permits the linker to link against a file which appears to be an object | |
306 | or an archive, but actually merely defines some symbol values, or uses | |
53d25da6 AM |
307 | @code{INPUT} or @code{GROUP} to load other objects. Specifying a |
308 | script in this way merely augments the main linker script, with the | |
309 | extra commands placed after the main script; use the @samp{-T} option | |
310 | to replace the default linker script entirely, but note the effect of | |
311 | the @code{INSERT} command. @xref{Scripts}. | |
252b5132 RH |
312 | |
313 | For options whose names are a single letter, | |
314 | option arguments must either follow the option letter without intervening | |
315 | whitespace, or be given as separate arguments immediately following the | |
316 | option that requires them. | |
317 | ||
318 | For options whose names are multiple letters, either one dash or two can | |
e4897a32 | 319 | precede the option name; for example, @samp{-trace-symbol} and |
36f63dca | 320 | @samp{--trace-symbol} are equivalent. Note---there is one exception to |
e4897a32 | 321 | this rule. Multiple letter options that start with a lower case 'o' can |
ba1be17e | 322 | only be preceded by two dashes. This is to reduce confusion with the |
e4897a32 NC |
323 | @samp{-o} option. So for example @samp{-omagic} sets the output file |
324 | name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the | |
325 | output. | |
326 | ||
327 | Arguments to multiple-letter options must either be separated from the | |
328 | option name by an equals sign, or be given as separate arguments | |
329 | immediately following the option that requires them. For example, | |
330 | @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent. | |
331 | Unique abbreviations of the names of multiple-letter options are | |
332 | accepted. | |
252b5132 | 333 | |
36f63dca NC |
334 | Note---if the linker is being invoked indirectly, via a compiler driver |
335 | (e.g. @samp{gcc}) then all the linker command line options should be | |
fa19fce0 NC |
336 | prefixed by @samp{-Wl,} (or whatever is appropriate for the particular |
337 | compiler driver) like this: | |
4e53152f NC |
338 | |
339 | @smallexample | |
2509a395 | 340 | gcc -Wl,--start-group foo.o bar.o -Wl,--end-group |
4e53152f NC |
341 | @end smallexample |
342 | ||
343 | This is important, because otherwise the compiler driver program may | |
2509a395 SL |
344 | silently drop the linker options, resulting in a bad link. Confusion |
345 | may also arise when passing options that require values through a | |
346 | driver, as the use of a space between option and argument acts as | |
347 | a separator, and causes the driver to pass only the option to the linker | |
348 | and the argument to the compiler. In this case, it is simplest to use | |
349 | the joined forms of both single- and multiple-letter options, such as: | |
350 | ||
351 | @smallexample | |
352 | gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map | |
353 | @end smallexample | |
4e53152f NC |
354 | |
355 | Here is a table of the generic command line switches accepted by the GNU | |
356 | linker: | |
357 | ||
ff5dcc92 | 358 | @table @gcctabopt |
38fc1cb1 | 359 | @include at-file.texi |
dff70155 | 360 | |
2509a395 SL |
361 | @kindex -a @var{keyword} |
362 | @item -a @var{keyword} | |
252b5132 RH |
363 | This option is supported for HP/UX compatibility. The @var{keyword} |
364 | argument must be one of the strings @samp{archive}, @samp{shared}, or | |
365 | @samp{default}. @samp{-aarchive} is functionally equivalent to | |
366 | @samp{-Bstatic}, and the other two keywords are functionally equivalent | |
367 | to @samp{-Bdynamic}. This option may be used any number of times. | |
368 | ||
7ee314fa AM |
369 | @kindex --audit @var{AUDITLIB} |
370 | @item --audit @var{AUDITLIB} | |
371 | Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section. | |
372 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
373 | specified in the library. If specified multiple times @code{DT_AUDIT} | |
374 | will contain a colon separated list of audit interfaces to use. If the linker | |
375 | finds an object with an audit entry while searching for shared libraries, | |
9d5777a3 | 376 | it will add a corresponding @code{DT_DEPAUDIT} entry in the output file. |
7ee314fa | 377 | This option is only meaningful on ELF platforms supporting the rtld-audit |
9d5777a3 | 378 | interface. |
7ee314fa | 379 | |
252b5132 RH |
380 | @ifset I960 |
381 | @cindex architectures | |
2509a395 SL |
382 | @kindex -A @var{arch} |
383 | @item -A @var{architecture} | |
252b5132 RH |
384 | @kindex --architecture=@var{arch} |
385 | @itemx --architecture=@var{architecture} | |
ff5dcc92 SC |
386 | In the current release of @command{ld}, this option is useful only for the |
387 | Intel 960 family of architectures. In that @command{ld} configuration, the | |
252b5132 RH |
388 | @var{architecture} argument identifies the particular architecture in |
389 | the 960 family, enabling some safeguards and modifying the | |
ff5dcc92 | 390 | archive-library search path. @xref{i960,,@command{ld} and the Intel 960 |
252b5132 RH |
391 | family}, for details. |
392 | ||
ff5dcc92 | 393 | Future releases of @command{ld} may support similar functionality for |
252b5132 RH |
394 | other architecture families. |
395 | @end ifset | |
396 | ||
397 | @ifclear SingleFormat | |
398 | @cindex binary input format | |
399 | @kindex -b @var{format} | |
400 | @kindex --format=@var{format} | |
401 | @cindex input format | |
402 | @cindex input format | |
403 | @item -b @var{input-format} | |
404 | @itemx --format=@var{input-format} | |
ff5dcc92 SC |
405 | @command{ld} may be configured to support more than one kind of object |
406 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 407 | @samp{-b} option to specify the binary format for input object files |
ff5dcc92 | 408 | that follow this option on the command line. Even when @command{ld} is |
252b5132 | 409 | configured to support alternative object formats, you don't usually need |
ff5dcc92 | 410 | to specify this, as @command{ld} should be configured to expect as a |
252b5132 RH |
411 | default input format the most usual format on each machine. |
412 | @var{input-format} is a text string, the name of a particular format | |
413 | supported by the BFD libraries. (You can list the available binary | |
414 | formats with @samp{objdump -i}.) | |
415 | @xref{BFD}. | |
416 | ||
417 | You may want to use this option if you are linking files with an unusual | |
418 | binary format. You can also use @samp{-b} to switch formats explicitly (when | |
419 | linking object files of different formats), by including | |
420 | @samp{-b @var{input-format}} before each group of object files in a | |
a1ab1d2a | 421 | particular format. |
252b5132 RH |
422 | |
423 | The default format is taken from the environment variable | |
424 | @code{GNUTARGET}. | |
425 | @ifset UsesEnvVars | |
426 | @xref{Environment}. | |
427 | @end ifset | |
428 | You can also define the input format from a script, using the command | |
0285c67d NC |
429 | @code{TARGET}; |
430 | @ifclear man | |
431 | see @ref{Format Commands}. | |
432 | @end ifclear | |
252b5132 RH |
433 | @end ifclear |
434 | ||
435 | @kindex -c @var{MRI-cmdfile} | |
436 | @kindex --mri-script=@var{MRI-cmdfile} | |
437 | @cindex compatibility, MRI | |
438 | @item -c @var{MRI-commandfile} | |
439 | @itemx --mri-script=@var{MRI-commandfile} | |
ff5dcc92 | 440 | For compatibility with linkers produced by MRI, @command{ld} accepts script |
252b5132 | 441 | files written in an alternate, restricted command language, described in |
0285c67d NC |
442 | @ifclear man |
443 | @ref{MRI,,MRI Compatible Script Files}. | |
444 | @end ifclear | |
445 | @ifset man | |
446 | the MRI Compatible Script Files section of GNU ld documentation. | |
447 | @end ifset | |
448 | Introduce MRI script files with | |
252b5132 | 449 | the option @samp{-c}; use the @samp{-T} option to run linker |
ff5dcc92 SC |
450 | scripts written in the general-purpose @command{ld} scripting language. |
451 | If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories | |
252b5132 RH |
452 | specified by any @samp{-L} options. |
453 | ||
454 | @cindex common allocation | |
455 | @kindex -d | |
456 | @kindex -dc | |
457 | @kindex -dp | |
a1ab1d2a | 458 | @item -d |
252b5132 RH |
459 | @itemx -dc |
460 | @itemx -dp | |
461 | These three options are equivalent; multiple forms are supported for | |
462 | compatibility with other linkers. They assign space to common symbols | |
463 | even if a relocatable output file is specified (with @samp{-r}). The | |
464 | script command @code{FORCE_COMMON_ALLOCATION} has the same effect. | |
465 | @xref{Miscellaneous Commands}. | |
466 | ||
7ee314fa AM |
467 | @kindex --depaudit @var{AUDITLIB} |
468 | @kindex -P @var{AUDITLIB} | |
469 | @item --depaudit @var{AUDITLIB} | |
470 | @itemx -P @var{AUDITLIB} | |
471 | Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section. | |
472 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
473 | specified in the library. If specified multiple times @code{DT_DEPAUDIT} | |
474 | will contain a colon separated list of audit interfaces to use. This | |
475 | option is only meaningful on ELF platforms supporting the rtld-audit interface. | |
9d5777a3 | 476 | The -P option is provided for Solaris compatibility. |
7ee314fa | 477 | |
252b5132 RH |
478 | @cindex entry point, from command line |
479 | @kindex -e @var{entry} | |
480 | @kindex --entry=@var{entry} | |
a1ab1d2a | 481 | @item -e @var{entry} |
252b5132 RH |
482 | @itemx --entry=@var{entry} |
483 | Use @var{entry} as the explicit symbol for beginning execution of your | |
484 | program, rather than the default entry point. If there is no symbol | |
485 | named @var{entry}, the linker will try to parse @var{entry} as a number, | |
486 | and use that as the entry address (the number will be interpreted in | |
487 | base 10; you may use a leading @samp{0x} for base 16, or a leading | |
488 | @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults | |
489 | and other ways of specifying the entry point. | |
490 | ||
b58f81ae DJ |
491 | @kindex --exclude-libs |
492 | @item --exclude-libs @var{lib},@var{lib},... | |
493 | Specifies a list of archive libraries from which symbols should not be automatically | |
e1c37eb5 | 494 | exported. The library names may be delimited by commas or colons. Specifying |
b58f81ae DJ |
495 | @code{--exclude-libs ALL} excludes symbols in all archive libraries from |
496 | automatic export. This option is available only for the i386 PE targeted | |
497 | port of the linker and for ELF targeted ports. For i386 PE, symbols | |
498 | explicitly listed in a .def file are still exported, regardless of this | |
499 | option. For ELF targeted ports, symbols affected by this option will | |
500 | be treated as hidden. | |
501 | ||
e1c37eb5 DK |
502 | @kindex --exclude-modules-for-implib |
503 | @item --exclude-modules-for-implib @var{module},@var{module},... | |
504 | Specifies a list of object files or archive members, from which symbols | |
505 | should not be automatically exported, but which should be copied wholesale | |
506 | into the import library being generated during the link. The module names | |
507 | may be delimited by commas or colons, and must match exactly the filenames | |
508 | used by @command{ld} to open the files; for archive members, this is simply | |
509 | the member name, but for object files the name listed must include and | |
510 | match precisely any path used to specify the input file on the linker's | |
511 | command-line. This option is available only for the i386 PE targeted port | |
512 | of the linker. Symbols explicitly listed in a .def file are still exported, | |
513 | regardless of this option. | |
514 | ||
252b5132 RH |
515 | @cindex dynamic symbol table |
516 | @kindex -E | |
517 | @kindex --export-dynamic | |
267e2722 | 518 | @kindex --no-export-dynamic |
252b5132 RH |
519 | @item -E |
520 | @itemx --export-dynamic | |
267e2722 CD |
521 | @itemx --no-export-dynamic |
522 | When creating a dynamically linked executable, using the @option{-E} | |
523 | option or the @option{--export-dynamic} option causes the linker to add | |
524 | all symbols to the dynamic symbol table. The dynamic symbol table is the | |
525 | set of symbols which are visible from dynamic objects at run time. | |
526 | ||
527 | If you do not use either of these options (or use the | |
528 | @option{--no-export-dynamic} option to restore the default behavior), the | |
529 | dynamic symbol table will normally contain only those symbols which are | |
530 | referenced by some dynamic object mentioned in the link. | |
252b5132 RH |
531 | |
532 | If you use @code{dlopen} to load a dynamic object which needs to refer | |
533 | back to the symbols defined by the program, rather than some other | |
534 | dynamic object, then you will probably need to use this option when | |
535 | linking the program itself. | |
536 | ||
55255dae | 537 | You can also use the dynamic list to control what symbols should |
cb840a31 | 538 | be added to the dynamic symbol table if the output format supports it. |
55255dae | 539 | See the description of @samp{--dynamic-list}. |
cb840a31 | 540 | |
8b747e1a DK |
541 | Note that this option is specific to ELF targeted ports. PE targets |
542 | support a similar function to export all symbols from a DLL or EXE; see | |
543 | the description of @samp{--export-all-symbols} below. | |
544 | ||
36f63dca | 545 | @ifclear SingleFormat |
252b5132 RH |
546 | @cindex big-endian objects |
547 | @cindex endianness | |
548 | @kindex -EB | |
549 | @item -EB | |
550 | Link big-endian objects. This affects the default output format. | |
551 | ||
552 | @cindex little-endian objects | |
553 | @kindex -EL | |
554 | @item -EL | |
555 | Link little-endian objects. This affects the default output format. | |
36f63dca | 556 | @end ifclear |
252b5132 | 557 | |
2509a395 SL |
558 | @kindex -f @var{name} |
559 | @kindex --auxiliary=@var{name} | |
560 | @item -f @var{name} | |
561 | @itemx --auxiliary=@var{name} | |
252b5132 RH |
562 | When creating an ELF shared object, set the internal DT_AUXILIARY field |
563 | to the specified name. This tells the dynamic linker that the symbol | |
564 | table of the shared object should be used as an auxiliary filter on the | |
565 | symbol table of the shared object @var{name}. | |
566 | ||
567 | If you later link a program against this filter object, then, when you | |
568 | run the program, the dynamic linker will see the DT_AUXILIARY field. If | |
569 | the dynamic linker resolves any symbols from the filter object, it will | |
570 | first check whether there is a definition in the shared object | |
571 | @var{name}. If there is one, it will be used instead of the definition | |
572 | in the filter object. The shared object @var{name} need not exist. | |
573 | Thus the shared object @var{name} may be used to provide an alternative | |
574 | implementation of certain functions, perhaps for debugging or for | |
575 | machine specific performance. | |
576 | ||
577 | This option may be specified more than once. The DT_AUXILIARY entries | |
578 | will be created in the order in which they appear on the command line. | |
579 | ||
2509a395 SL |
580 | @kindex -F @var{name} |
581 | @kindex --filter=@var{name} | |
252b5132 | 582 | @item -F @var{name} |
2509a395 | 583 | @itemx --filter=@var{name} |
252b5132 RH |
584 | When creating an ELF shared object, set the internal DT_FILTER field to |
585 | the specified name. This tells the dynamic linker that the symbol table | |
586 | of the shared object which is being created should be used as a filter | |
587 | on the symbol table of the shared object @var{name}. | |
588 | ||
589 | If you later link a program against this filter object, then, when you | |
590 | run the program, the dynamic linker will see the DT_FILTER field. The | |
591 | dynamic linker will resolve symbols according to the symbol table of the | |
592 | filter object as usual, but it will actually link to the definitions | |
593 | found in the shared object @var{name}. Thus the filter object can be | |
594 | used to select a subset of the symbols provided by the object | |
595 | @var{name}. | |
596 | ||
ff5dcc92 | 597 | Some older linkers used the @option{-F} option throughout a compilation |
252b5132 | 598 | toolchain for specifying object-file format for both input and output |
36f63dca NC |
599 | object files. |
600 | @ifclear SingleFormat | |
601 | The @sc{gnu} linker uses other mechanisms for this purpose: the | |
ece2d90e | 602 | @option{-b}, @option{--format}, @option{--oformat} options, the |
252b5132 | 603 | @code{TARGET} command in linker scripts, and the @code{GNUTARGET} |
36f63dca NC |
604 | environment variable. |
605 | @end ifclear | |
606 | The @sc{gnu} linker will ignore the @option{-F} option when not | |
607 | creating an ELF shared object. | |
252b5132 | 608 | |
3dbf70a2 | 609 | @cindex finalization function |
2509a395 SL |
610 | @kindex -fini=@var{name} |
611 | @item -fini=@var{name} | |
3dbf70a2 MM |
612 | When creating an ELF executable or shared object, call NAME when the |
613 | executable or shared object is unloaded, by setting DT_FINI to the | |
614 | address of the function. By default, the linker uses @code{_fini} as | |
615 | the function to call. | |
616 | ||
252b5132 RH |
617 | @kindex -g |
618 | @item -g | |
619 | Ignored. Provided for compatibility with other tools. | |
620 | ||
2509a395 SL |
621 | @kindex -G @var{value} |
622 | @kindex --gpsize=@var{value} | |
252b5132 | 623 | @cindex object size |
2509a395 | 624 | @item -G @var{value} |
252b5132 RH |
625 | @itemx --gpsize=@var{value} |
626 | Set the maximum size of objects to be optimized using the GP register to | |
627 | @var{size}. This is only meaningful for object file formats such as | |
e8044f35 | 628 | MIPS ELF that support putting large and small objects into different |
252b5132 RH |
629 | sections. This is ignored for other object file formats. |
630 | ||
631 | @cindex runtime library name | |
2509a395 | 632 | @kindex -h @var{name} |
252b5132 | 633 | @kindex -soname=@var{name} |
2509a395 | 634 | @item -h @var{name} |
252b5132 RH |
635 | @itemx -soname=@var{name} |
636 | When creating an ELF shared object, set the internal DT_SONAME field to | |
637 | the specified name. When an executable is linked with a shared object | |
638 | which has a DT_SONAME field, then when the executable is run the dynamic | |
639 | linker will attempt to load the shared object specified by the DT_SONAME | |
640 | field rather than the using the file name given to the linker. | |
641 | ||
642 | @kindex -i | |
643 | @cindex incremental link | |
644 | @item -i | |
645 | Perform an incremental link (same as option @samp{-r}). | |
646 | ||
3dbf70a2 | 647 | @cindex initialization function |
2509a395 SL |
648 | @kindex -init=@var{name} |
649 | @item -init=@var{name} | |
3dbf70a2 MM |
650 | When creating an ELF executable or shared object, call NAME when the |
651 | executable or shared object is loaded, by setting DT_INIT to the address | |
652 | of the function. By default, the linker uses @code{_init} as the | |
653 | function to call. | |
654 | ||
252b5132 | 655 | @cindex archive files, from cmd line |
2509a395 | 656 | @kindex -l @var{namespec} |
bcb674cf | 657 | @kindex --library=@var{namespec} |
2509a395 | 658 | @item -l @var{namespec} |
bcb674cf RS |
659 | @itemx --library=@var{namespec} |
660 | Add the archive or object file specified by @var{namespec} to the | |
661 | list of files to link. This option may be used any number of times. | |
662 | If @var{namespec} is of the form @file{:@var{filename}}, @command{ld} | |
07d8eb55 | 663 | will search the library path for a file called @var{filename}, otherwise it |
bcb674cf | 664 | will search the library path for a file called @file{lib@var{namespec}.a}. |
252b5132 | 665 | |
ff5dcc92 | 666 | On systems which support shared libraries, @command{ld} may also search for |
bcb674cf RS |
667 | files other than @file{lib@var{namespec}.a}. Specifically, on ELF |
668 | and SunOS systems, @command{ld} will search a directory for a library | |
669 | called @file{lib@var{namespec}.so} before searching for one called | |
670 | @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension | |
671 | indicates a shared library.) Note that this behavior does not apply | |
672 | to @file{:@var{filename}}, which always specifies a file called | |
673 | @var{filename}. | |
252b5132 RH |
674 | |
675 | The linker will search an archive only once, at the location where it is | |
676 | specified on the command line. If the archive defines a symbol which | |
677 | was undefined in some object which appeared before the archive on the | |
678 | command line, the linker will include the appropriate file(s) from the | |
679 | archive. However, an undefined symbol in an object appearing later on | |
680 | the command line will not cause the linker to search the archive again. | |
681 | ||
ff5dcc92 | 682 | See the @option{-(} option for a way to force the linker to search |
252b5132 RH |
683 | archives multiple times. |
684 | ||
685 | You may list the same archive multiple times on the command line. | |
686 | ||
687 | @ifset GENERIC | |
688 | This type of archive searching is standard for Unix linkers. However, | |
ff5dcc92 | 689 | if you are using @command{ld} on AIX, note that it is different from the |
252b5132 RH |
690 | behaviour of the AIX linker. |
691 | @end ifset | |
692 | ||
693 | @cindex search directory, from cmd line | |
2509a395 | 694 | @kindex -L @var{dir} |
252b5132 | 695 | @kindex --library-path=@var{dir} |
2509a395 | 696 | @item -L @var{searchdir} |
252b5132 | 697 | @itemx --library-path=@var{searchdir} |
ff5dcc92 SC |
698 | Add path @var{searchdir} to the list of paths that @command{ld} will search |
699 | for archive libraries and @command{ld} control scripts. You may use this | |
252b5132 RH |
700 | option any number of times. The directories are searched in the order |
701 | in which they are specified on the command line. Directories specified | |
702 | on the command line are searched before the default directories. All | |
ff5dcc92 | 703 | @option{-L} options apply to all @option{-l} options, regardless of the |
7d24f02c KH |
704 | order in which the options appear. @option{-L} options do not affect |
705 | how @command{ld} searches for a linker script unless @option{-T} | |
706 | option is specified. | |
252b5132 | 707 | |
9c8ebd6a | 708 | If @var{searchdir} begins with @code{=}, then the @code{=} will be replaced |
b3b9c41d HPN |
709 | by the @dfn{sysroot prefix}, controlled by the @samp{--sysroot} option, or |
710 | specified when the linker is configured. | |
9c8ebd6a | 711 | |
252b5132 RH |
712 | @ifset UsesEnvVars |
713 | The default set of paths searched (without being specified with | |
ff5dcc92 | 714 | @samp{-L}) depends on which emulation mode @command{ld} is using, and in |
252b5132 RH |
715 | some cases also on how it was configured. @xref{Environment}. |
716 | @end ifset | |
717 | ||
718 | The paths can also be specified in a link script with the | |
719 | @code{SEARCH_DIR} command. Directories specified this way are searched | |
720 | at the point in which the linker script appears in the command line. | |
721 | ||
722 | @cindex emulation | |
723 | @kindex -m @var{emulation} | |
2509a395 | 724 | @item -m @var{emulation} |
252b5132 RH |
725 | Emulate the @var{emulation} linker. You can list the available |
726 | emulations with the @samp{--verbose} or @samp{-V} options. | |
727 | ||
728 | If the @samp{-m} option is not used, the emulation is taken from the | |
729 | @code{LDEMULATION} environment variable, if that is defined. | |
730 | ||
731 | Otherwise, the default emulation depends upon how the linker was | |
732 | configured. | |
733 | ||
734 | @cindex link map | |
735 | @kindex -M | |
736 | @kindex --print-map | |
737 | @item -M | |
738 | @itemx --print-map | |
739 | Print a link map to the standard output. A link map provides | |
740 | information about the link, including the following: | |
741 | ||
742 | @itemize @bullet | |
743 | @item | |
3b83e13a | 744 | Where object files are mapped into memory. |
252b5132 RH |
745 | @item |
746 | How common symbols are allocated. | |
747 | @item | |
748 | All archive members included in the link, with a mention of the symbol | |
749 | which caused the archive member to be brought in. | |
3b83e13a NC |
750 | @item |
751 | The values assigned to symbols. | |
752 | ||
753 | Note - symbols whose values are computed by an expression which | |
754 | involves a reference to a previous value of the same symbol may not | |
755 | have correct result displayed in the link map. This is because the | |
756 | linker discards intermediate results and only retains the final value | |
757 | of an expression. Under such circumstances the linker will display | |
758 | the final value enclosed by square brackets. Thus for example a | |
759 | linker script containing: | |
760 | ||
761 | @smallexample | |
762 | foo = 1 | |
763 | foo = foo * 4 | |
764 | foo = foo + 8 | |
765 | @end smallexample | |
766 | ||
767 | will produce the following output in the link map if the @option{-M} | |
768 | option is used: | |
769 | ||
770 | @smallexample | |
771 | 0x00000001 foo = 0x1 | |
772 | [0x0000000c] foo = (foo * 0x4) | |
773 | [0x0000000c] foo = (foo + 0x8) | |
774 | @end smallexample | |
775 | ||
776 | See @ref{Expressions} for more information about expressions in linker | |
777 | scripts. | |
252b5132 RH |
778 | @end itemize |
779 | ||
780 | @kindex -n | |
781 | @cindex read-only text | |
782 | @cindex NMAGIC | |
783 | @kindex --nmagic | |
784 | @item -n | |
785 | @itemx --nmagic | |
90f5d9d9 JZ |
786 | Turn off page alignment of sections, and disable linking against shared |
787 | libraries. If the output format supports Unix style magic numbers, | |
788 | mark the output as @code{NMAGIC}. | |
252b5132 RH |
789 | |
790 | @kindex -N | |
791 | @kindex --omagic | |
792 | @cindex read/write from cmd line | |
793 | @cindex OMAGIC | |
a1ab1d2a | 794 | @item -N |
252b5132 RH |
795 | @itemx --omagic |
796 | Set the text and data sections to be readable and writable. Also, do | |
63fd3b82 NC |
797 | not page-align the data segment, and disable linking against shared |
798 | libraries. If the output format supports Unix style magic numbers, | |
4d8907ac DS |
799 | mark the output as @code{OMAGIC}. Note: Although a writable text section |
800 | is allowed for PE-COFF targets, it does not conform to the format | |
801 | specification published by Microsoft. | |
63fd3b82 NC |
802 | |
803 | @kindex --no-omagic | |
804 | @cindex OMAGIC | |
805 | @item --no-omagic | |
806 | This option negates most of the effects of the @option{-N} option. It | |
807 | sets the text section to be read-only, and forces the data segment to | |
808 | be page-aligned. Note - this option does not enable linking against | |
809 | shared libraries. Use @option{-Bdynamic} for this. | |
252b5132 RH |
810 | |
811 | @kindex -o @var{output} | |
812 | @kindex --output=@var{output} | |
813 | @cindex naming the output file | |
814 | @item -o @var{output} | |
815 | @itemx --output=@var{output} | |
ff5dcc92 | 816 | Use @var{output} as the name for the program produced by @command{ld}; if this |
252b5132 RH |
817 | option is not specified, the name @file{a.out} is used by default. The |
818 | script command @code{OUTPUT} can also specify the output file name. | |
819 | ||
820 | @kindex -O @var{level} | |
821 | @cindex generating optimized output | |
822 | @item -O @var{level} | |
ff5dcc92 | 823 | If @var{level} is a numeric values greater than zero @command{ld} optimizes |
252b5132 | 824 | the output. This might take significantly longer and therefore probably |
98c503ac NC |
825 | should only be enabled for the final binary. At the moment this |
826 | option only affects ELF shared library generation. Future releases of | |
827 | the linker may make more use of this option. Also currently there is | |
828 | no difference in the linker's behaviour for different non-zero values | |
829 | of this option. Again this may change with future releases. | |
252b5132 | 830 | |
26278bb8 UD |
831 | @kindex --push-state |
832 | @cindex push state governing input file handling | |
833 | @item --push-state | |
834 | The @option{--push-state} allows to preserve the current state of the | |
835 | flags which govern the input file handling so that they can all be | |
836 | restored with one corresponding @option{--pop-state} option. | |
837 | ||
838 | The option which are covered are: @option{-Bdynamic}, @option{-Bstatic}, | |
839 | @option{-dn}, @option{-dy}, @option{-call_shared}, @option{-non_shared}, | |
840 | @option{-static}, @option{-N}, @option{-n}, @option{--whole-archive}, | |
841 | @option{--no-whole-archive}, @option{-r}, @option{-Ur}, | |
842 | @option{--copy-dt-needed-entries}, @option{--no-copy-dt-needed-entries}, | |
843 | @option{--as-needed}, @option{--no-as-needed}, and @option{-a}. | |
844 | ||
845 | One target for this option are specifications for @file{pkg-config}. When | |
846 | used with the @option{--libs} option all possibly needed libraries are | |
847 | listed and then possibly linked with all the time. It is better to return | |
848 | something as follows: | |
849 | ||
850 | @smallexample | |
851 | -Wl,--push-state,--as-needed -libone -libtwo -Wl,--pop-state | |
852 | @end smallexample | |
853 | ||
854 | @kindex --pop-state | |
855 | @cindex pop state governing input file handling | |
856 | Undoes the effect of --push-state, restores the previous values of the | |
857 | flags governing input file handling. | |
858 | ||
a712da20 NC |
859 | @kindex -q |
860 | @kindex --emit-relocs | |
861 | @cindex retain relocations in final executable | |
862 | @item -q | |
863 | @itemx --emit-relocs | |
ba1be17e | 864 | Leave relocation sections and contents in fully linked executables. |
a712da20 NC |
865 | Post link analysis and optimization tools may need this information in |
866 | order to perform correct modifications of executables. This results | |
867 | in larger executables. | |
868 | ||
dbab7a7b NC |
869 | This option is currently only supported on ELF platforms. |
870 | ||
4f471f39 RS |
871 | @kindex --force-dynamic |
872 | @cindex forcing the creation of dynamic sections | |
873 | @item --force-dynamic | |
874 | Force the output file to have dynamic sections. This option is specific | |
875 | to VxWorks targets. | |
876 | ||
252b5132 RH |
877 | @cindex partial link |
878 | @cindex relocatable output | |
879 | @kindex -r | |
1049f94e | 880 | @kindex --relocatable |
252b5132 | 881 | @item -r |
1049f94e | 882 | @itemx --relocatable |
252b5132 | 883 | Generate relocatable output---i.e., generate an output file that can in |
ff5dcc92 | 884 | turn serve as input to @command{ld}. This is often called @dfn{partial |
252b5132 RH |
885 | linking}. As a side effect, in environments that support standard Unix |
886 | magic numbers, this option also sets the output file's magic number to | |
887 | @code{OMAGIC}. | |
ff5dcc92 | 888 | @c ; see @option{-N}. |
252b5132 RH |
889 | If this option is not specified, an absolute file is produced. When |
890 | linking C++ programs, this option @emph{will not} resolve references to | |
891 | constructors; to do that, use @samp{-Ur}. | |
892 | ||
62bf86b4 HPN |
893 | When an input file does not have the same format as the output file, |
894 | partial linking is only supported if that input file does not contain any | |
895 | relocations. Different output formats can have further restrictions; for | |
896 | example some @code{a.out}-based formats do not support partial linking | |
897 | with input files in other formats at all. | |
898 | ||
252b5132 RH |
899 | This option does the same thing as @samp{-i}. |
900 | ||
901 | @kindex -R @var{file} | |
902 | @kindex --just-symbols=@var{file} | |
903 | @cindex symbol-only input | |
904 | @item -R @var{filename} | |
905 | @itemx --just-symbols=@var{filename} | |
906 | Read symbol names and their addresses from @var{filename}, but do not | |
907 | relocate it or include it in the output. This allows your output file | |
908 | to refer symbolically to absolute locations of memory defined in other | |
909 | programs. You may use this option more than once. | |
910 | ||
ff5dcc92 | 911 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 912 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 913 | the @option{-rpath} option. |
252b5132 RH |
914 | |
915 | @kindex -s | |
916 | @kindex --strip-all | |
917 | @cindex strip all symbols | |
a1ab1d2a | 918 | @item -s |
252b5132 RH |
919 | @itemx --strip-all |
920 | Omit all symbol information from the output file. | |
921 | ||
922 | @kindex -S | |
923 | @kindex --strip-debug | |
924 | @cindex strip debugger symbols | |
a1ab1d2a | 925 | @item -S |
252b5132 RH |
926 | @itemx --strip-debug |
927 | Omit debugger symbol information (but not all symbols) from the output file. | |
928 | ||
929 | @kindex -t | |
930 | @kindex --trace | |
931 | @cindex input files, displaying | |
a1ab1d2a | 932 | @item -t |
252b5132 | 933 | @itemx --trace |
ff5dcc92 | 934 | Print the names of the input files as @command{ld} processes them. |
252b5132 RH |
935 | |
936 | @kindex -T @var{script} | |
937 | @kindex --script=@var{script} | |
938 | @cindex script files | |
939 | @item -T @var{scriptfile} | |
940 | @itemx --script=@var{scriptfile} | |
941 | Use @var{scriptfile} as the linker script. This script replaces | |
ff5dcc92 | 942 | @command{ld}'s default linker script (rather than adding to it), so |
252b5132 | 943 | @var{commandfile} must specify everything necessary to describe the |
114283d8 NC |
944 | output file. @xref{Scripts}. If @var{scriptfile} does not exist in |
945 | the current directory, @code{ld} looks for it in the directories | |
946 | specified by any preceding @samp{-L} options. Multiple @samp{-T} | |
947 | options accumulate. | |
252b5132 | 948 | |
14be8564 L |
949 | @kindex -dT @var{script} |
950 | @kindex --default-script=@var{script} | |
951 | @cindex script files | |
952 | @item -dT @var{scriptfile} | |
953 | @itemx --default-script=@var{scriptfile} | |
954 | Use @var{scriptfile} as the default linker script. @xref{Scripts}. | |
955 | ||
956 | This option is similar to the @option{--script} option except that | |
957 | processing of the script is delayed until after the rest of the | |
958 | command line has been processed. This allows options placed after the | |
959 | @option{--default-script} option on the command line to affect the | |
960 | behaviour of the linker script, which can be important when the linker | |
961 | command line cannot be directly controlled by the user. (eg because | |
962 | the command line is being constructed by another tool, such as | |
963 | @samp{gcc}). | |
964 | ||
252b5132 RH |
965 | @kindex -u @var{symbol} |
966 | @kindex --undefined=@var{symbol} | |
967 | @cindex undefined symbol | |
968 | @item -u @var{symbol} | |
969 | @itemx --undefined=@var{symbol} | |
970 | Force @var{symbol} to be entered in the output file as an undefined | |
971 | symbol. Doing this may, for example, trigger linking of additional | |
972 | modules from standard libraries. @samp{-u} may be repeated with | |
973 | different option arguments to enter additional undefined symbols. This | |
974 | option is equivalent to the @code{EXTERN} linker script command. | |
975 | ||
0a618243 AB |
976 | If this option is being used to force additional modules to be pulled |
977 | into the link, and if it is an error for the symbol to remain | |
978 | undefined, then the option @option{--require-defined} should be used | |
979 | instead. | |
980 | ||
981 | @kindex --require-defined=@var{symbol} | |
982 | @cindex symbols, require defined | |
983 | @cindex defined symbol | |
984 | @item --require-defined=@var{symbol} | |
985 | Require that @var{symbol} is defined in the output file. This option | |
986 | is the same as option @option{--undefined} except that if @var{symbol} | |
987 | is not defined in the output file then the linker will issue an error | |
988 | and exit. The same effect can be achieved in a linker script by using | |
989 | @code{EXTERN}, @code{ASSERT} and @code{DEFINED} together. This option | |
990 | can be used multiple times to require additional symbols. | |
991 | ||
252b5132 RH |
992 | @kindex -Ur |
993 | @cindex constructors | |
a1ab1d2a | 994 | @item -Ur |
252b5132 RH |
995 | For anything other than C++ programs, this option is equivalent to |
996 | @samp{-r}: it generates relocatable output---i.e., an output file that can in | |
ff5dcc92 | 997 | turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur} |
252b5132 RH |
998 | @emph{does} resolve references to constructors, unlike @samp{-r}. |
999 | It does not work to use @samp{-Ur} on files that were themselves linked | |
1000 | with @samp{-Ur}; once the constructor table has been built, it cannot | |
1001 | be added to. Use @samp{-Ur} only for the last partial link, and | |
1002 | @samp{-r} for the others. | |
1003 | ||
c005eb9e AB |
1004 | @kindex --orphan-handling=@var{MODE} |
1005 | @cindex orphan sections | |
1006 | @cindex sections, orphan | |
1007 | @item --orphan-handling=@var{MODE} | |
1008 | Control how orphan sections are handled. An orphan section is one not | |
1009 | specifically mentioned in a linker script. @xref{Orphan Sections}. | |
1010 | ||
1011 | @var{MODE} can have any of the following values: | |
1012 | ||
1013 | @table @code | |
1014 | @item place | |
1015 | Orphan sections are placed into a suitable output section following | |
1016 | the strategy described in @ref{Orphan Sections}. The option | |
1017 | @samp{--unique} also effects how sections are placed. | |
1018 | ||
1019 | @item discard | |
1020 | All orphan sections are discarded, by placing them in the | |
1021 | @samp{/DISCARD/} section (@pxref{Output Section Discarding}). | |
1022 | ||
1023 | @item warn | |
1024 | The linker will place the orphan section as for @code{place} and also | |
1025 | issue a warning. | |
1026 | ||
1027 | @item error | |
1028 | The linker will exit with an error if any orphan section is found. | |
1029 | @end table | |
1030 | ||
1031 | The default if @samp{--orphan-handling} is not given is @code{place}. | |
1032 | ||
577a0623 AM |
1033 | @kindex --unique[=@var{SECTION}] |
1034 | @item --unique[=@var{SECTION}] | |
1035 | Creates a separate output section for every input section matching | |
1036 | @var{SECTION}, or if the optional wildcard @var{SECTION} argument is | |
1037 | missing, for every orphan input section. An orphan section is one not | |
1038 | specifically mentioned in a linker script. You may use this option | |
1039 | multiple times on the command line; It prevents the normal merging of | |
1040 | input sections with the same name, overriding output section assignments | |
1041 | in a linker script. | |
a854a4a7 | 1042 | |
252b5132 RH |
1043 | @kindex -v |
1044 | @kindex -V | |
1045 | @kindex --version | |
1046 | @cindex version | |
1047 | @item -v | |
1048 | @itemx --version | |
1049 | @itemx -V | |
ff5dcc92 | 1050 | Display the version number for @command{ld}. The @option{-V} option also |
252b5132 RH |
1051 | lists the supported emulations. |
1052 | ||
1053 | @kindex -x | |
1054 | @kindex --discard-all | |
1055 | @cindex deleting local symbols | |
1056 | @item -x | |
1057 | @itemx --discard-all | |
1058 | Delete all local symbols. | |
1059 | ||
1060 | @kindex -X | |
1061 | @kindex --discard-locals | |
1062 | @cindex local symbols, deleting | |
a1ab1d2a | 1063 | @item -X |
252b5132 | 1064 | @itemx --discard-locals |
3c68c38f BW |
1065 | Delete all temporary local symbols. (These symbols start with |
1066 | system-specific local label prefixes, typically @samp{.L} for ELF systems | |
1067 | or @samp{L} for traditional a.out systems.) | |
252b5132 RH |
1068 | |
1069 | @kindex -y @var{symbol} | |
1070 | @kindex --trace-symbol=@var{symbol} | |
1071 | @cindex symbol tracing | |
1072 | @item -y @var{symbol} | |
1073 | @itemx --trace-symbol=@var{symbol} | |
1074 | Print the name of each linked file in which @var{symbol} appears. This | |
1075 | option may be given any number of times. On many systems it is necessary | |
1076 | to prepend an underscore. | |
1077 | ||
1078 | This option is useful when you have an undefined symbol in your link but | |
1079 | don't know where the reference is coming from. | |
1080 | ||
1081 | @kindex -Y @var{path} | |
1082 | @item -Y @var{path} | |
1083 | Add @var{path} to the default library search path. This option exists | |
1084 | for Solaris compatibility. | |
1085 | ||
1086 | @kindex -z @var{keyword} | |
1087 | @item -z @var{keyword} | |
cd6d6c15 NC |
1088 | The recognized keywords are: |
1089 | @table @samp | |
1090 | ||
1091 | @item combreloc | |
1092 | Combines multiple reloc sections and sorts them to make dynamic symbol | |
1093 | lookup caching possible. | |
1094 | ||
1095 | @item defs | |
560e09e9 | 1096 | Disallows undefined symbols in object files. Undefined symbols in |
07f3b6ad | 1097 | shared libraries are still allowed. |
cd6d6c15 | 1098 | |
6aa29e7b JJ |
1099 | @item execstack |
1100 | Marks the object as requiring executable stack. | |
1101 | ||
b039ef04 L |
1102 | @item global |
1103 | This option is only meaningful when building a shared object. It makes | |
1104 | the symbols defined by this shared object available for symbol resolution | |
1105 | of subsequently loaded libraries. | |
1106 | ||
cd6d6c15 NC |
1107 | @item initfirst |
1108 | This option is only meaningful when building a shared object. | |
1109 | It marks the object so that its runtime initialization will occur | |
1110 | before the runtime initialization of any other objects brought into | |
1111 | the process at the same time. Similarly the runtime finalization of | |
1112 | the object will occur after the runtime finalization of any other | |
1113 | objects. | |
1114 | ||
1115 | @item interpose | |
1116 | Marks the object that its symbol table interposes before all symbols | |
1117 | but the primary executable. | |
1118 | ||
5fa222e4 AM |
1119 | @item lazy |
1120 | When generating an executable or shared library, mark it to tell the | |
1121 | dynamic linker to defer function call resolution to the point when | |
1122 | the function is called (lazy binding), rather than at load time. | |
1123 | Lazy binding is the default. | |
1124 | ||
cd6d6c15 NC |
1125 | @item loadfltr |
1126 | Marks the object that its filters be processed immediately at | |
1127 | runtime. | |
1128 | ||
1129 | @item muldefs | |
1130 | Allows multiple definitions. | |
1131 | ||
1132 | @item nocombreloc | |
1133 | Disables multiple reloc sections combining. | |
1134 | ||
1135 | @item nocopyreloc | |
daf220f0 AM |
1136 | Disable linker generated .dynbss variables used in place of variables |
1137 | defined in shared libraries. May result in dynamic text relocations. | |
cd6d6c15 NC |
1138 | |
1139 | @item nodefaultlib | |
1140 | Marks the object that the search for dependencies of this object will | |
1141 | ignore any default library search paths. | |
1142 | ||
1143 | @item nodelete | |
1144 | Marks the object shouldn't be unloaded at runtime. | |
1145 | ||
1146 | @item nodlopen | |
1147 | Marks the object not available to @code{dlopen}. | |
1148 | ||
1149 | @item nodump | |
1150 | Marks the object can not be dumped by @code{dldump}. | |
1151 | ||
6aa29e7b JJ |
1152 | @item noexecstack |
1153 | Marks the object as not requiring executable stack. | |
1154 | ||
8dfef1bd L |
1155 | @item text |
1156 | Treat DT_TEXTREL in shared object as error. | |
1157 | ||
1158 | @item notext | |
1159 | Don't treat DT_TEXTREL in shared object as error. | |
1160 | ||
1161 | @item textoff | |
1162 | Don't treat DT_TEXTREL in shared object as error. | |
1163 | ||
6aa29e7b JJ |
1164 | @item norelro |
1165 | Don't create an ELF @code{PT_GNU_RELRO} segment header in the object. | |
1166 | ||
cd6d6c15 NC |
1167 | @item now |
1168 | When generating an executable or shared library, mark it to tell the | |
1169 | dynamic linker to resolve all symbols when the program is started, or | |
1170 | when the shared library is linked to using dlopen, instead of | |
1171 | deferring function call resolution to the point when the function is | |
1172 | first called. | |
1173 | ||
1174 | @item origin | |
1175 | Marks the object may contain $ORIGIN. | |
1176 | ||
6aa29e7b JJ |
1177 | @item relro |
1178 | Create an ELF @code{PT_GNU_RELRO} segment header in the object. | |
1179 | ||
24718e3b L |
1180 | @item max-page-size=@var{value} |
1181 | Set the emulation maximum page size to @var{value}. | |
1182 | ||
1183 | @item common-page-size=@var{value} | |
1184 | Set the emulation common page size to @var{value}. | |
1185 | ||
04c3a755 NS |
1186 | @item stack-size=@var{value} |
1187 | Specify a stack size for in an ELF @code{PT_GNU_STACK} segment. | |
1188 | Specifying zero will override any default non-zero sized | |
1189 | @code{PT_GNU_STACK} segment creation. | |
1190 | ||
d258b828 IZ |
1191 | @item bndplt |
1192 | Always generate BND prefix in PLT entries. Supported for Linux/x86_64. | |
1193 | ||
889c2a67 L |
1194 | @item noextern-protected-data |
1195 | Don't treat protected data symbol as external when building shared | |
1196 | library. This option overrides linker backend default. It can be used | |
1197 | to workaround incorrect relocations against protected data symbols | |
1198 | generated by compiler. Updates on protected data symbols by another | |
4dba69b9 | 1199 | module aren't visible to the resulting shared library. Supported for |
889c2a67 L |
1200 | i386 and x86-64. |
1201 | ||
caa65211 L |
1202 | @item call-nop=prefix-addr |
1203 | @itemx call-nop=prefix-nop | |
1204 | @itemx call-nop=suffix-nop | |
1205 | @itemx call-nop=prefix-@var{byte} | |
1206 | @itemx call-nop=suffix-@var{byte} | |
1207 | Specify the 1-byte @code{NOP} padding when transforming indirect call | |
1208 | to a locally defined function, foo, via its GOT slot. | |
1209 | @option{call-nop=prefix-addr} generates @code{0x67 call foo}. | |
1210 | @option{call-nop=prefix-nop} generates @code{0x90 call foo}. | |
1211 | @option{call-nop=suffix-nop} generates @code{call foo 0x90}. | |
1212 | @option{call-nop=prefix-@var{byte}} generates @code{@var{byte} call foo}. | |
1213 | @option{call-nop=suffix-@var{byte}} generates @code{call foo @var{byte}}. | |
1214 | Supported for i386 and x86_64. | |
1215 | ||
cd6d6c15 NC |
1216 | @end table |
1217 | ||
ece2d90e | 1218 | Other keywords are ignored for Solaris compatibility. |
252b5132 RH |
1219 | |
1220 | @kindex -( | |
1221 | @cindex groups of archives | |
1222 | @item -( @var{archives} -) | |
1223 | @itemx --start-group @var{archives} --end-group | |
1224 | The @var{archives} should be a list of archive files. They may be | |
1225 | either explicit file names, or @samp{-l} options. | |
1226 | ||
1227 | The specified archives are searched repeatedly until no new undefined | |
1228 | references are created. Normally, an archive is searched only once in | |
1229 | the order that it is specified on the command line. If a symbol in that | |
1230 | archive is needed to resolve an undefined symbol referred to by an | |
1231 | object in an archive that appears later on the command line, the linker | |
1232 | would not be able to resolve that reference. By grouping the archives, | |
1233 | they all be searched repeatedly until all possible references are | |
1234 | resolved. | |
1235 | ||
1236 | Using this option has a significant performance cost. It is best to use | |
1237 | it only when there are unavoidable circular references between two or | |
1238 | more archives. | |
1239 | ||
69da35b5 NC |
1240 | @kindex --accept-unknown-input-arch |
1241 | @kindex --no-accept-unknown-input-arch | |
1242 | @item --accept-unknown-input-arch | |
1243 | @itemx --no-accept-unknown-input-arch | |
1244 | Tells the linker to accept input files whose architecture cannot be | |
2ca22b03 | 1245 | recognised. The assumption is that the user knows what they are doing |
69da35b5 NC |
1246 | and deliberately wants to link in these unknown input files. This was |
1247 | the default behaviour of the linker, before release 2.14. The default | |
1248 | behaviour from release 2.14 onwards is to reject such input files, and | |
1249 | so the @samp{--accept-unknown-input-arch} option has been added to | |
1250 | restore the old behaviour. | |
2ca22b03 | 1251 | |
4a43e768 AM |
1252 | @kindex --as-needed |
1253 | @kindex --no-as-needed | |
1254 | @item --as-needed | |
1255 | @itemx --no-as-needed | |
1256 | This option affects ELF DT_NEEDED tags for dynamic libraries mentioned | |
ddbb8a31 | 1257 | on the command line after the @option{--as-needed} option. Normally |
4a43e768 AM |
1258 | the linker will add a DT_NEEDED tag for each dynamic library mentioned |
1259 | on the command line, regardless of whether the library is actually | |
ddbb8a31 | 1260 | needed or not. @option{--as-needed} causes a DT_NEEDED tag to only be |
ffa9430d AM |
1261 | emitted for a library that @emph{at that point in the link} satisfies a |
1262 | non-weak undefined symbol reference from a regular object file or, if | |
1240be6b AM |
1263 | the library is not found in the DT_NEEDED lists of other needed libraries, a |
1264 | non-weak undefined symbol reference from another needed dynamic library. | |
ffa9430d AM |
1265 | Object files or libraries appearing on the command line @emph{after} |
1266 | the library in question do not affect whether the library is seen as | |
1267 | needed. This is similar to the rules for extraction of object files | |
1268 | from archives. @option{--no-as-needed} restores the default behaviour. | |
4a43e768 | 1269 | |
e56f61be L |
1270 | @kindex --add-needed |
1271 | @kindex --no-add-needed | |
1272 | @item --add-needed | |
1273 | @itemx --no-add-needed | |
ddbb8a31 NC |
1274 | These two options have been deprecated because of the similarity of |
1275 | their names to the @option{--as-needed} and @option{--no-as-needed} | |
1276 | options. They have been replaced by @option{--copy-dt-needed-entries} | |
1277 | and @option{--no-copy-dt-needed-entries}. | |
e56f61be | 1278 | |
252b5132 RH |
1279 | @kindex -assert @var{keyword} |
1280 | @item -assert @var{keyword} | |
1281 | This option is ignored for SunOS compatibility. | |
1282 | ||
1283 | @kindex -Bdynamic | |
1284 | @kindex -dy | |
1285 | @kindex -call_shared | |
1286 | @item -Bdynamic | |
1287 | @itemx -dy | |
1288 | @itemx -call_shared | |
1289 | Link against dynamic libraries. This is only meaningful on platforms | |
1290 | for which shared libraries are supported. This option is normally the | |
1291 | default on such platforms. The different variants of this option are | |
1292 | for compatibility with various systems. You may use this option | |
1293 | multiple times on the command line: it affects library searching for | |
da8bce14 | 1294 | @option{-l} options which follow it. |
252b5132 | 1295 | |
a1ab1d2a UD |
1296 | @kindex -Bgroup |
1297 | @item -Bgroup | |
1298 | Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic | |
1299 | section. This causes the runtime linker to handle lookups in this | |
1300 | object and its dependencies to be performed only inside the group. | |
560e09e9 NC |
1301 | @option{--unresolved-symbols=report-all} is implied. This option is |
1302 | only meaningful on ELF platforms which support shared libraries. | |
a1ab1d2a | 1303 | |
252b5132 RH |
1304 | @kindex -Bstatic |
1305 | @kindex -dn | |
1306 | @kindex -non_shared | |
1307 | @kindex -static | |
a1ab1d2a | 1308 | @item -Bstatic |
252b5132 RH |
1309 | @itemx -dn |
1310 | @itemx -non_shared | |
1311 | @itemx -static | |
1312 | Do not link against shared libraries. This is only meaningful on | |
1313 | platforms for which shared libraries are supported. The different | |
1314 | variants of this option are for compatibility with various systems. You | |
1315 | may use this option multiple times on the command line: it affects | |
560e09e9 | 1316 | library searching for @option{-l} options which follow it. This |
e9156f74 NC |
1317 | option also implies @option{--unresolved-symbols=report-all}. This |
1318 | option can be used with @option{-shared}. Doing so means that a | |
1319 | shared library is being created but that all of the library's external | |
1320 | references must be resolved by pulling in entries from static | |
ece2d90e | 1321 | libraries. |
252b5132 RH |
1322 | |
1323 | @kindex -Bsymbolic | |
1324 | @item -Bsymbolic | |
1325 | When creating a shared library, bind references to global symbols to the | |
1326 | definition within the shared library, if any. Normally, it is possible | |
1327 | for a program linked against a shared library to override the definition | |
1328 | within the shared library. This option is only meaningful on ELF | |
1329 | platforms which support shared libraries. | |
1330 | ||
40b36307 L |
1331 | @kindex -Bsymbolic-functions |
1332 | @item -Bsymbolic-functions | |
1333 | When creating a shared library, bind references to global function | |
c0065db7 | 1334 | symbols to the definition within the shared library, if any. |
40b36307 L |
1335 | This option is only meaningful on ELF platforms which support shared |
1336 | libraries. | |
1337 | ||
55255dae L |
1338 | @kindex --dynamic-list=@var{dynamic-list-file} |
1339 | @item --dynamic-list=@var{dynamic-list-file} | |
1340 | Specify the name of a dynamic list file to the linker. This is | |
1341 | typically used when creating shared libraries to specify a list of | |
1342 | global symbols whose references shouldn't be bound to the definition | |
1343 | within the shared library, or creating dynamically linked executables | |
1344 | to specify a list of symbols which should be added to the symbol table | |
1345 | in the executable. This option is only meaningful on ELF platforms | |
1346 | which support shared libraries. | |
1347 | ||
1348 | The format of the dynamic list is the same as the version node without | |
1349 | scope and node name. See @ref{VERSION} for more information. | |
1350 | ||
40b36307 L |
1351 | @kindex --dynamic-list-data |
1352 | @item --dynamic-list-data | |
1353 | Include all global data symbols to the dynamic list. | |
1354 | ||
1355 | @kindex --dynamic-list-cpp-new | |
1356 | @item --dynamic-list-cpp-new | |
1357 | Provide the builtin dynamic list for C++ operator new and delete. It | |
1358 | is mainly useful for building shared libstdc++. | |
1359 | ||
0b8a70d9 L |
1360 | @kindex --dynamic-list-cpp-typeinfo |
1361 | @item --dynamic-list-cpp-typeinfo | |
1362 | Provide the builtin dynamic list for C++ runtime type identification. | |
1363 | ||
252b5132 RH |
1364 | @kindex --check-sections |
1365 | @kindex --no-check-sections | |
1366 | @item --check-sections | |
308b1ffd | 1367 | @itemx --no-check-sections |
252b5132 | 1368 | Asks the linker @emph{not} to check section addresses after they have |
7d816a17 | 1369 | been assigned to see if there are any overlaps. Normally the linker will |
252b5132 RH |
1370 | perform this check, and if it finds any overlaps it will produce |
1371 | suitable error messages. The linker does know about, and does make | |
1372 | allowances for sections in overlays. The default behaviour can be | |
560e09e9 | 1373 | restored by using the command line switch @option{--check-sections}. |
02b0b1aa NS |
1374 | Section overlap is not usually checked for relocatable links. You can |
1375 | force checking in that case by using the @option{--check-sections} | |
1376 | option. | |
252b5132 | 1377 | |
ddbb8a31 NC |
1378 | @kindex --copy-dt-needed-entries |
1379 | @kindex --no-copy-dt-needed-entries | |
1380 | @item --copy-dt-needed-entries | |
1381 | @itemx --no-copy-dt-needed-entries | |
9d5777a3 | 1382 | This option affects the treatment of dynamic libraries referred to |
ddbb8a31 | 1383 | by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the |
08efffb8 | 1384 | command line. Normally the linker won't add a DT_NEEDED tag to the |
ddbb8a31 | 1385 | output binary for each library mentioned in a DT_NEEDED tag in an |
08efffb8 | 1386 | input dynamic library. With @option{--copy-dt-needed-entries} |
ddbb8a31 | 1387 | specified on the command line however any dynamic libraries that |
08efffb8 MM |
1388 | follow it will have their DT_NEEDED entries added. The default |
1389 | behaviour can be restored with @option{--no-copy-dt-needed-entries}. | |
ddbb8a31 NC |
1390 | |
1391 | This option also has an effect on the resolution of symbols in dynamic | |
08efffb8 MM |
1392 | libraries. With @option{--copy-dt-needed-entries} dynamic libraries |
1393 | mentioned on the command line will be recursively searched, following | |
1394 | their DT_NEEDED tags to other libraries, in order to resolve symbols | |
1395 | required by the output binary. With the default setting however | |
1396 | the searching of dynamic libraries that follow it will stop with the | |
1397 | dynamic library itself. No DT_NEEDED links will be traversed to resolve | |
ddbb8a31 NC |
1398 | symbols. |
1399 | ||
252b5132 RH |
1400 | @cindex cross reference table |
1401 | @kindex --cref | |
1402 | @item --cref | |
1403 | Output a cross reference table. If a linker map file is being | |
1404 | generated, the cross reference table is printed to the map file. | |
1405 | Otherwise, it is printed on the standard output. | |
1406 | ||
1407 | The format of the table is intentionally simple, so that it may be | |
1408 | easily processed by a script if necessary. The symbols are printed out, | |
1409 | sorted by name. For each symbol, a list of file names is given. If the | |
1410 | symbol is defined, the first file listed is the location of the | |
049c1c8e NC |
1411 | definition. If the symbol is defined as a common value then any files |
1412 | where this happens appear next. Finally any files that reference the | |
1413 | symbol are listed. | |
252b5132 | 1414 | |
4818e05f AM |
1415 | @cindex common allocation |
1416 | @kindex --no-define-common | |
1417 | @item --no-define-common | |
1418 | This option inhibits the assignment of addresses to common symbols. | |
1419 | The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect. | |
1420 | @xref{Miscellaneous Commands}. | |
1421 | ||
1422 | The @samp{--no-define-common} option allows decoupling | |
1423 | the decision to assign addresses to Common symbols from the choice | |
1424 | of the output file type; otherwise a non-Relocatable output type | |
1425 | forces assigning addresses to Common symbols. | |
1426 | Using @samp{--no-define-common} allows Common symbols that are referenced | |
1427 | from a shared library to be assigned addresses only in the main program. | |
1428 | This eliminates the unused duplicate space in the shared library, | |
1429 | and also prevents any possible confusion over resolving to the wrong | |
1430 | duplicate when there are many dynamic modules with specialized search | |
1431 | paths for runtime symbol resolution. | |
1432 | ||
252b5132 | 1433 | @cindex symbols, from command line |
2509a395 SL |
1434 | @kindex --defsym=@var{symbol}=@var{exp} |
1435 | @item --defsym=@var{symbol}=@var{expression} | |
252b5132 RH |
1436 | Create a global symbol in the output file, containing the absolute |
1437 | address given by @var{expression}. You may use this option as many | |
1438 | times as necessary to define multiple symbols in the command line. A | |
1439 | limited form of arithmetic is supported for the @var{expression} in this | |
1440 | context: you may give a hexadecimal constant or the name of an existing | |
1441 | symbol, or use @code{+} and @code{-} to add or subtract hexadecimal | |
1442 | constants or symbols. If you need more elaborate expressions, consider | |
66bc8739 AM |
1443 | using the linker command language from a script (@pxref{Assignments}). |
1444 | @emph{Note:} there should be no white space between @var{symbol}, the | |
1445 | equals sign (``@key{=}''), and @var{expression}. | |
252b5132 RH |
1446 | |
1447 | @cindex demangling, from command line | |
28c309a2 | 1448 | @kindex --demangle[=@var{style}] |
252b5132 | 1449 | @kindex --no-demangle |
28c309a2 | 1450 | @item --demangle[=@var{style}] |
252b5132 RH |
1451 | @itemx --no-demangle |
1452 | These options control whether to demangle symbol names in error messages | |
1453 | and other output. When the linker is told to demangle, it tries to | |
1454 | present symbol names in a readable fashion: it strips leading | |
1455 | underscores if they are used by the object file format, and converts C++ | |
a1ab1d2a UD |
1456 | mangled symbol names into user readable names. Different compilers have |
1457 | different mangling styles. The optional demangling style argument can be used | |
1458 | to choose an appropriate demangling style for your compiler. The linker will | |
28c309a2 NC |
1459 | demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE} |
1460 | is set. These options may be used to override the default. | |
252b5132 RH |
1461 | |
1462 | @cindex dynamic linker, from command line | |
506eee22 | 1463 | @kindex -I@var{file} |
2509a395 SL |
1464 | @kindex --dynamic-linker=@var{file} |
1465 | @item -I@var{file} | |
1466 | @itemx --dynamic-linker=@var{file} | |
252b5132 RH |
1467 | Set the name of the dynamic linker. This is only meaningful when |
1468 | generating dynamically linked ELF executables. The default dynamic | |
1469 | linker is normally correct; don't use this unless you know what you are | |
1470 | doing. | |
1471 | ||
9b8b325a RF |
1472 | @kindex --no-dynamic-linker |
1473 | @item --no-dynamic-linker | |
1474 | When producing an executable file, omit the request for a dynamic | |
1475 | linker to be used at load-time. This is only meaningful for ELF | |
1476 | executables that contain dynamic relocations, and usually requires | |
1477 | entry point code that is capable of processing these relocations. | |
1478 | ||
7ce691ae | 1479 | @kindex --fatal-warnings |
0fe58ccd | 1480 | @kindex --no-fatal-warnings |
7ce691ae | 1481 | @item --fatal-warnings |
0fe58ccd NC |
1482 | @itemx --no-fatal-warnings |
1483 | Treat all warnings as errors. The default behaviour can be restored | |
1484 | with the option @option{--no-fatal-warnings}. | |
7ce691ae | 1485 | |
252b5132 RH |
1486 | @kindex --force-exe-suffix |
1487 | @item --force-exe-suffix | |
1488 | Make sure that an output file has a .exe suffix. | |
1489 | ||
1490 | If a successfully built fully linked output file does not have a | |
1491 | @code{.exe} or @code{.dll} suffix, this option forces the linker to copy | |
1492 | the output file to one of the same name with a @code{.exe} suffix. This | |
1493 | option is useful when using unmodified Unix makefiles on a Microsoft | |
1494 | Windows host, since some versions of Windows won't run an image unless | |
1495 | it ends in a @code{.exe} suffix. | |
1496 | ||
1497 | @kindex --gc-sections | |
1498 | @kindex --no-gc-sections | |
1499 | @cindex garbage collection | |
c17d87de NC |
1500 | @item --gc-sections |
1501 | @itemx --no-gc-sections | |
252b5132 | 1502 | Enable garbage collection of unused input sections. It is ignored on |
ac69cbc6 | 1503 | targets that do not support this option. The default behaviour (of not |
b3549761 | 1504 | performing this garbage collection) can be restored by specifying |
0f088b2a KT |
1505 | @samp{--no-gc-sections} on the command line. Note that garbage |
1506 | collection for COFF and PE format targets is supported, but the | |
1507 | implementation is currently considered to be experimental. | |
252b5132 | 1508 | |
d5465ba2 AM |
1509 | @samp{--gc-sections} decides which input sections are used by |
1510 | examining symbols and relocations. The section containing the entry | |
1511 | symbol and all sections containing symbols undefined on the | |
1512 | command-line will be kept, as will sections containing symbols | |
1513 | referenced by dynamic objects. Note that when building shared | |
1514 | libraries, the linker must assume that any visible symbol is | |
1515 | referenced. Once this initial set of sections has been determined, | |
1516 | the linker recursively marks as used any section referenced by their | |
1517 | relocations. See @samp{--entry} and @samp{--undefined}. | |
1518 | ||
ac69cbc6 | 1519 | This option can be set when doing a partial link (enabled with option |
9d5777a3 | 1520 | @samp{-r}). In this case the root of symbols kept must be explicitly |
ac69cbc6 TG |
1521 | specified either by an @samp{--entry} or @samp{--undefined} option or by |
1522 | a @code{ENTRY} command in the linker script. | |
1523 | ||
c17d87de NC |
1524 | @kindex --print-gc-sections |
1525 | @kindex --no-print-gc-sections | |
1526 | @cindex garbage collection | |
1527 | @item --print-gc-sections | |
1528 | @itemx --no-print-gc-sections | |
1529 | List all sections removed by garbage collection. The listing is | |
1530 | printed on stderr. This option is only effective if garbage | |
1531 | collection has been enabled via the @samp{--gc-sections}) option. The | |
1532 | default behaviour (of not listing the sections that are removed) can | |
1533 | be restored by specifying @samp{--no-print-gc-sections} on the command | |
1534 | line. | |
1535 | ||
30824704 RM |
1536 | @kindex --print-output-format |
1537 | @cindex output format | |
1538 | @item --print-output-format | |
1539 | Print the name of the default output format (perhaps influenced by | |
1540 | other command-line options). This is the string that would appear | |
1541 | in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}). | |
1542 | ||
3604cb1f TG |
1543 | @kindex --print-memory-usage |
1544 | @cindex memory usage | |
1545 | @item --print-memory-usage | |
1546 | Print used size, total size and used size of memory regions created with | |
1547 | the @ref{MEMORY} command. This is useful on embedded targets to have a | |
1548 | quick view of amount of free memory. The format of the output has one | |
1549 | headline and one line per region. It is both human readable and easily | |
1550 | parsable by tools. Here is an example of an output: | |
1551 | ||
1552 | @smallexample | |
1553 | Memory region Used Size Region Size %age Used | |
1554 | ROM: 256 KB 1 MB 25.00% | |
1555 | RAM: 32 B 2 GB 0.00% | |
1556 | @end smallexample | |
1557 | ||
252b5132 RH |
1558 | @cindex help |
1559 | @cindex usage | |
1560 | @kindex --help | |
1561 | @item --help | |
1562 | Print a summary of the command-line options on the standard output and exit. | |
1563 | ||
ea20a7da CC |
1564 | @kindex --target-help |
1565 | @item --target-help | |
1566 | Print a summary of all target specific options on the standard output and exit. | |
1567 | ||
2509a395 SL |
1568 | @kindex -Map=@var{mapfile} |
1569 | @item -Map=@var{mapfile} | |
252b5132 | 1570 | Print a link map to the file @var{mapfile}. See the description of the |
560e09e9 | 1571 | @option{-M} option, above. |
252b5132 RH |
1572 | |
1573 | @cindex memory usage | |
1574 | @kindex --no-keep-memory | |
1575 | @item --no-keep-memory | |
ff5dcc92 SC |
1576 | @command{ld} normally optimizes for speed over memory usage by caching the |
1577 | symbol tables of input files in memory. This option tells @command{ld} to | |
252b5132 | 1578 | instead optimize for memory usage, by rereading the symbol tables as |
ff5dcc92 | 1579 | necessary. This may be required if @command{ld} runs out of memory space |
252b5132 RH |
1580 | while linking a large executable. |
1581 | ||
1582 | @kindex --no-undefined | |
a1ab1d2a | 1583 | @kindex -z defs |
252b5132 | 1584 | @item --no-undefined |
a1ab1d2a | 1585 | @itemx -z defs |
560e09e9 NC |
1586 | Report unresolved symbol references from regular object files. This |
1587 | is done even if the linker is creating a non-symbolic shared library. | |
1588 | The switch @option{--[no-]allow-shlib-undefined} controls the | |
1589 | behaviour for reporting unresolved references found in shared | |
ece2d90e | 1590 | libraries being linked in. |
252b5132 | 1591 | |
aa713662 L |
1592 | @kindex --allow-multiple-definition |
1593 | @kindex -z muldefs | |
1594 | @item --allow-multiple-definition | |
1595 | @itemx -z muldefs | |
1596 | Normally when a symbol is defined multiple times, the linker will | |
1597 | report a fatal error. These options allow multiple definitions and the | |
1598 | first definition will be used. | |
1599 | ||
b79e8c78 | 1600 | @kindex --allow-shlib-undefined |
ae9a127f | 1601 | @kindex --no-allow-shlib-undefined |
b79e8c78 | 1602 | @item --allow-shlib-undefined |
ae9a127f | 1603 | @itemx --no-allow-shlib-undefined |
903249d7 | 1604 | Allows or disallows undefined symbols in shared libraries. |
560e09e9 NC |
1605 | This switch is similar to @option{--no-undefined} except that it |
1606 | determines the behaviour when the undefined symbols are in a | |
1607 | shared library rather than a regular object file. It does not affect | |
1608 | how undefined symbols in regular object files are handled. | |
1609 | ||
903249d7 NC |
1610 | The default behaviour is to report errors for any undefined symbols |
1611 | referenced in shared libraries if the linker is being used to create | |
1612 | an executable, but to allow them if the linker is being used to create | |
1613 | a shared library. | |
1614 | ||
1615 | The reasons for allowing undefined symbol references in shared | |
1616 | libraries specified at link time are that: | |
1617 | ||
1618 | @itemize @bullet | |
1619 | @item | |
1620 | A shared library specified at link time may not be the same as the one | |
1621 | that is available at load time, so the symbol might actually be | |
1622 | resolvable at load time. | |
1623 | @item | |
1624 | There are some operating systems, eg BeOS and HPPA, where undefined | |
1625 | symbols in shared libraries are normal. | |
1626 | ||
1627 | The BeOS kernel for example patches shared libraries at load time to | |
1628 | select whichever function is most appropriate for the current | |
1629 | architecture. This is used, for example, to dynamically select an | |
1630 | appropriate memset function. | |
1631 | @end itemize | |
b79e8c78 | 1632 | |
31941635 L |
1633 | @kindex --no-undefined-version |
1634 | @item --no-undefined-version | |
1635 | Normally when a symbol has an undefined version, the linker will ignore | |
1636 | it. This option disallows symbols with undefined version and a fatal error | |
1637 | will be issued instead. | |
1638 | ||
3e3b46e5 PB |
1639 | @kindex --default-symver |
1640 | @item --default-symver | |
1641 | Create and use a default symbol version (the soname) for unversioned | |
fc0e6df6 PB |
1642 | exported symbols. |
1643 | ||
1644 | @kindex --default-imported-symver | |
1645 | @item --default-imported-symver | |
1646 | Create and use a default symbol version (the soname) for unversioned | |
1647 | imported symbols. | |
3e3b46e5 | 1648 | |
252b5132 RH |
1649 | @kindex --no-warn-mismatch |
1650 | @item --no-warn-mismatch | |
ff5dcc92 | 1651 | Normally @command{ld} will give an error if you try to link together input |
252b5132 RH |
1652 | files that are mismatched for some reason, perhaps because they have |
1653 | been compiled for different processors or for different endiannesses. | |
ff5dcc92 | 1654 | This option tells @command{ld} that it should silently permit such possible |
252b5132 RH |
1655 | errors. This option should only be used with care, in cases when you |
1656 | have taken some special action that ensures that the linker errors are | |
1657 | inappropriate. | |
1658 | ||
fe7929ce AM |
1659 | @kindex --no-warn-search-mismatch |
1660 | @item --no-warn-search-mismatch | |
1661 | Normally @command{ld} will give a warning if it finds an incompatible | |
1662 | library during a library search. This option silences the warning. | |
1663 | ||
252b5132 RH |
1664 | @kindex --no-whole-archive |
1665 | @item --no-whole-archive | |
ff5dcc92 | 1666 | Turn off the effect of the @option{--whole-archive} option for subsequent |
252b5132 RH |
1667 | archive files. |
1668 | ||
1669 | @cindex output file after errors | |
1670 | @kindex --noinhibit-exec | |
1671 | @item --noinhibit-exec | |
1672 | Retain the executable output file whenever it is still usable. | |
1673 | Normally, the linker will not produce an output file if it encounters | |
1674 | errors during the link process; it exits without writing an output file | |
1675 | when it issues any error whatsoever. | |
1676 | ||
0a9c1c8e CD |
1677 | @kindex -nostdlib |
1678 | @item -nostdlib | |
1679 | Only search library directories explicitly specified on the | |
1680 | command line. Library directories specified in linker scripts | |
1681 | (including linker scripts specified on the command line) are ignored. | |
1682 | ||
252b5132 | 1683 | @ifclear SingleFormat |
2509a395 SL |
1684 | @kindex --oformat=@var{output-format} |
1685 | @item --oformat=@var{output-format} | |
ff5dcc92 SC |
1686 | @command{ld} may be configured to support more than one kind of object |
1687 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 1688 | @samp{--oformat} option to specify the binary format for the output |
ff5dcc92 SC |
1689 | object file. Even when @command{ld} is configured to support alternative |
1690 | object formats, you don't usually need to specify this, as @command{ld} | |
252b5132 RH |
1691 | should be configured to produce as a default output format the most |
1692 | usual format on each machine. @var{output-format} is a text string, the | |
1693 | name of a particular format supported by the BFD libraries. (You can | |
1694 | list the available binary formats with @samp{objdump -i}.) The script | |
1695 | command @code{OUTPUT_FORMAT} can also specify the output format, but | |
1696 | this option overrides it. @xref{BFD}. | |
1697 | @end ifclear | |
1698 | ||
36af4a4e JJ |
1699 | @kindex -pie |
1700 | @kindex --pic-executable | |
1701 | @item -pie | |
1702 | @itemx --pic-executable | |
1703 | @cindex position independent executables | |
1704 | Create a position independent executable. This is currently only supported on | |
1705 | ELF platforms. Position independent executables are similar to shared | |
1706 | libraries in that they are relocated by the dynamic linker to the virtual | |
7e7d5768 | 1707 | address the OS chooses for them (which can vary between invocations). Like |
36af4a4e JJ |
1708 | normal dynamically linked executables they can be executed and symbols |
1709 | defined in the executable cannot be overridden by shared libraries. | |
1710 | ||
252b5132 RH |
1711 | @kindex -qmagic |
1712 | @item -qmagic | |
1713 | This option is ignored for Linux compatibility. | |
1714 | ||
1715 | @kindex -Qy | |
1716 | @item -Qy | |
1717 | This option is ignored for SVR4 compatibility. | |
1718 | ||
1719 | @kindex --relax | |
1720 | @cindex synthesizing linker | |
1721 | @cindex relaxing addressing modes | |
28d5f677 | 1722 | @cindex --no-relax |
252b5132 | 1723 | @item --relax |
28d5f677 | 1724 | @itemx --no-relax |
a1ab1d2a | 1725 | An option with machine dependent effects. |
252b5132 RH |
1726 | @ifset GENERIC |
1727 | This option is only supported on a few targets. | |
1728 | @end ifset | |
1729 | @ifset H8300 | |
ff5dcc92 | 1730 | @xref{H8/300,,@command{ld} and the H8/300}. |
252b5132 RH |
1731 | @end ifset |
1732 | @ifset I960 | |
ff5dcc92 | 1733 | @xref{i960,, @command{ld} and the Intel 960 family}. |
252b5132 | 1734 | @end ifset |
e0001a05 NC |
1735 | @ifset XTENSA |
1736 | @xref{Xtensa,, @command{ld} and Xtensa Processors}. | |
1737 | @end ifset | |
93fd0973 SC |
1738 | @ifset M68HC11 |
1739 | @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}. | |
1740 | @end ifset | |
78058a5e SL |
1741 | @ifset NIOSII |
1742 | @xref{Nios II,,@command{ld} and the Altera Nios II}. | |
1743 | @end ifset | |
2a60a7a8 AM |
1744 | @ifset POWERPC |
1745 | @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}. | |
1746 | @end ifset | |
252b5132 | 1747 | |
28d5f677 NC |
1748 | On some platforms the @samp{--relax} option performs target specific, |
1749 | global optimizations that become possible when the linker resolves | |
1750 | addressing in the program, such as relaxing address modes, | |
1751 | synthesizing new instructions, selecting shorter version of current | |
11e7fd74 | 1752 | instructions, and combining constant values. |
252b5132 RH |
1753 | |
1754 | On some platforms these link time global optimizations may make symbolic | |
1755 | debugging of the resulting executable impossible. | |
1756 | @ifset GENERIC | |
28d5f677 NC |
1757 | This is known to be the case for the Matsushita MN10200 and MN10300 |
1758 | family of processors. | |
252b5132 RH |
1759 | @end ifset |
1760 | ||
1761 | @ifset GENERIC | |
1762 | On platforms where this is not supported, @samp{--relax} is accepted, | |
1763 | but ignored. | |
1764 | @end ifset | |
1765 | ||
28d5f677 NC |
1766 | On platforms where @samp{--relax} is accepted the option |
1767 | @samp{--no-relax} can be used to disable the feature. | |
1768 | ||
252b5132 RH |
1769 | @cindex retaining specified symbols |
1770 | @cindex stripping all but some symbols | |
1771 | @cindex symbols, retaining selectively | |
2509a395 SL |
1772 | @kindex --retain-symbols-file=@var{filename} |
1773 | @item --retain-symbols-file=@var{filename} | |
252b5132 RH |
1774 | Retain @emph{only} the symbols listed in the file @var{filename}, |
1775 | discarding all others. @var{filename} is simply a flat file, with one | |
1776 | symbol name per line. This option is especially useful in environments | |
1777 | @ifset GENERIC | |
1778 | (such as VxWorks) | |
1779 | @end ifset | |
1780 | where a large global symbol table is accumulated gradually, to conserve | |
1781 | run-time memory. | |
1782 | ||
1783 | @samp{--retain-symbols-file} does @emph{not} discard undefined symbols, | |
1784 | or symbols needed for relocations. | |
1785 | ||
1786 | You may only specify @samp{--retain-symbols-file} once in the command | |
1787 | line. It overrides @samp{-s} and @samp{-S}. | |
1788 | ||
1789 | @ifset GENERIC | |
2509a395 | 1790 | @item -rpath=@var{dir} |
252b5132 | 1791 | @cindex runtime library search path |
2509a395 | 1792 | @kindex -rpath=@var{dir} |
252b5132 | 1793 | Add a directory to the runtime library search path. This is used when |
ff5dcc92 | 1794 | linking an ELF executable with shared objects. All @option{-rpath} |
252b5132 | 1795 | arguments are concatenated and passed to the runtime linker, which uses |
ff5dcc92 | 1796 | them to locate shared objects at runtime. The @option{-rpath} option is |
252b5132 RH |
1797 | also used when locating shared objects which are needed by shared |
1798 | objects explicitly included in the link; see the description of the | |
ff5dcc92 | 1799 | @option{-rpath-link} option. If @option{-rpath} is not used when linking an |
252b5132 RH |
1800 | ELF executable, the contents of the environment variable |
1801 | @code{LD_RUN_PATH} will be used if it is defined. | |
1802 | ||
ff5dcc92 | 1803 | The @option{-rpath} option may also be used on SunOS. By default, on |
d8506323 | 1804 | SunOS, the linker will form a runtime search path out of all the |
ff5dcc92 SC |
1805 | @option{-L} options it is given. If a @option{-rpath} option is used, the |
1806 | runtime search path will be formed exclusively using the @option{-rpath} | |
1807 | options, ignoring the @option{-L} options. This can be useful when using | |
1808 | gcc, which adds many @option{-L} options which may be on NFS mounted | |
b45619c0 | 1809 | file systems. |
252b5132 | 1810 | |
ff5dcc92 | 1811 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 1812 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 1813 | the @option{-rpath} option. |
252b5132 RH |
1814 | @end ifset |
1815 | ||
1816 | @ifset GENERIC | |
1817 | @cindex link-time runtime library search path | |
2509a395 SL |
1818 | @kindex -rpath-link=@var{dir} |
1819 | @item -rpath-link=@var{dir} | |
252b5132 RH |
1820 | When using ELF or SunOS, one shared library may require another. This |
1821 | happens when an @code{ld -shared} link includes a shared library as one | |
1822 | of the input files. | |
1823 | ||
1824 | When the linker encounters such a dependency when doing a non-shared, | |
1825 | non-relocatable link, it will automatically try to locate the required | |
1826 | shared library and include it in the link, if it is not included | |
ff5dcc92 | 1827 | explicitly. In such a case, the @option{-rpath-link} option |
252b5132 | 1828 | specifies the first set of directories to search. The |
ff5dcc92 | 1829 | @option{-rpath-link} option may specify a sequence of directory names |
252b5132 RH |
1830 | either by specifying a list of names separated by colons, or by |
1831 | appearing multiple times. | |
1832 | ||
28c309a2 NC |
1833 | This option should be used with caution as it overrides the search path |
1834 | that may have been hard compiled into a shared library. In such a case it | |
1835 | is possible to use unintentionally a different search path than the | |
1836 | runtime linker would do. | |
1837 | ||
252b5132 | 1838 | The linker uses the following search paths to locate required shared |
ece2d90e | 1839 | libraries: |
252b5132 RH |
1840 | @enumerate |
1841 | @item | |
ff5dcc92 | 1842 | Any directories specified by @option{-rpath-link} options. |
252b5132 | 1843 | @item |
ff5dcc92 SC |
1844 | Any directories specified by @option{-rpath} options. The difference |
1845 | between @option{-rpath} and @option{-rpath-link} is that directories | |
1846 | specified by @option{-rpath} options are included in the executable and | |
1847 | used at runtime, whereas the @option{-rpath-link} option is only effective | |
ece2d90e NC |
1848 | at link time. Searching @option{-rpath} in this way is only supported |
1849 | by native linkers and cross linkers which have been configured with | |
1850 | the @option{--with-sysroot} option. | |
252b5132 | 1851 | @item |
e2a83dd0 NC |
1852 | On an ELF system, for native linkers, if the @option{-rpath} and |
1853 | @option{-rpath-link} options were not used, search the contents of the | |
1854 | environment variable @code{LD_RUN_PATH}. | |
252b5132 | 1855 | @item |
ff5dcc92 SC |
1856 | On SunOS, if the @option{-rpath} option was not used, search any |
1857 | directories specified using @option{-L} options. | |
252b5132 | 1858 | @item |
a1b8d843 | 1859 | For a native linker, search the contents of the environment |
e2a83dd0 | 1860 | variable @code{LD_LIBRARY_PATH}. |
252b5132 | 1861 | @item |
ec4eb78a L |
1862 | For a native ELF linker, the directories in @code{DT_RUNPATH} or |
1863 | @code{DT_RPATH} of a shared library are searched for shared | |
1864 | libraries needed by it. The @code{DT_RPATH} entries are ignored if | |
1865 | @code{DT_RUNPATH} entries exist. | |
1866 | @item | |
252b5132 RH |
1867 | The default directories, normally @file{/lib} and @file{/usr/lib}. |
1868 | @item | |
1869 | For a native linker on an ELF system, if the file @file{/etc/ld.so.conf} | |
1870 | exists, the list of directories found in that file. | |
1871 | @end enumerate | |
1872 | ||
1873 | If the required shared library is not found, the linker will issue a | |
1874 | warning and continue with the link. | |
1875 | @end ifset | |
1876 | ||
1877 | @kindex -shared | |
1878 | @kindex -Bshareable | |
1879 | @item -shared | |
1880 | @itemx -Bshareable | |
1881 | @cindex shared libraries | |
1882 | Create a shared library. This is currently only supported on ELF, XCOFF | |
1883 | and SunOS platforms. On SunOS, the linker will automatically create a | |
ff5dcc92 | 1884 | shared library if the @option{-e} option is not used and there are |
252b5132 RH |
1885 | undefined symbols in the link. |
1886 | ||
252b5132 | 1887 | @kindex --sort-common |
2509a395 SL |
1888 | @item --sort-common |
1889 | @itemx --sort-common=ascending | |
1890 | @itemx --sort-common=descending | |
de7dd2bd NC |
1891 | This option tells @command{ld} to sort the common symbols by alignment in |
1892 | ascending or descending order when it places them in the appropriate output | |
1893 | sections. The symbol alignments considered are sixteen-byte or larger, | |
1894 | eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps | |
1895 | between symbols due to alignment constraints. If no sorting order is | |
1896 | specified, then descending order is assumed. | |
252b5132 | 1897 | |
2509a395 SL |
1898 | @kindex --sort-section=name |
1899 | @item --sort-section=name | |
bcaa7b3e L |
1900 | This option will apply @code{SORT_BY_NAME} to all wildcard section |
1901 | patterns in the linker script. | |
1902 | ||
2509a395 SL |
1903 | @kindex --sort-section=alignment |
1904 | @item --sort-section=alignment | |
bcaa7b3e L |
1905 | This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section |
1906 | patterns in the linker script. | |
1907 | ||
252b5132 | 1908 | @kindex --split-by-file |
2509a395 | 1909 | @item --split-by-file[=@var{size}] |
ff5dcc92 | 1910 | Similar to @option{--split-by-reloc} but creates a new output section for |
a854a4a7 AM |
1911 | each input file when @var{size} is reached. @var{size} defaults to a |
1912 | size of 1 if not given. | |
252b5132 RH |
1913 | |
1914 | @kindex --split-by-reloc | |
2509a395 | 1915 | @item --split-by-reloc[=@var{count}] |
a854a4a7 | 1916 | Tries to creates extra sections in the output file so that no single |
252b5132 | 1917 | output section in the file contains more than @var{count} relocations. |
a854a4a7 | 1918 | This is useful when generating huge relocatable files for downloading into |
252b5132 RH |
1919 | certain real time kernels with the COFF object file format; since COFF |
1920 | cannot represent more than 65535 relocations in a single section. Note | |
1921 | that this will fail to work with object file formats which do not | |
1922 | support arbitrary sections. The linker will not split up individual | |
1923 | input sections for redistribution, so if a single input section contains | |
1924 | more than @var{count} relocations one output section will contain that | |
a854a4a7 | 1925 | many relocations. @var{count} defaults to a value of 32768. |
252b5132 RH |
1926 | |
1927 | @kindex --stats | |
1928 | @item --stats | |
1929 | Compute and display statistics about the operation of the linker, such | |
1930 | as execution time and memory usage. | |
1931 | ||
2509a395 | 1932 | @kindex --sysroot=@var{directory} |
e2243057 RS |
1933 | @item --sysroot=@var{directory} |
1934 | Use @var{directory} as the location of the sysroot, overriding the | |
1935 | configure-time default. This option is only supported by linkers | |
1936 | that were configured using @option{--with-sysroot}. | |
1937 | ||
252b5132 RH |
1938 | @kindex --traditional-format |
1939 | @cindex traditional format | |
1940 | @item --traditional-format | |
ff5dcc92 SC |
1941 | For some targets, the output of @command{ld} is different in some ways from |
1942 | the output of some existing linker. This switch requests @command{ld} to | |
252b5132 RH |
1943 | use the traditional format instead. |
1944 | ||
1945 | @cindex dbx | |
ff5dcc92 | 1946 | For example, on SunOS, @command{ld} combines duplicate entries in the |
252b5132 RH |
1947 | symbol string table. This can reduce the size of an output file with |
1948 | full debugging information by over 30 percent. Unfortunately, the SunOS | |
1949 | @code{dbx} program can not read the resulting program (@code{gdb} has no | |
ff5dcc92 | 1950 | trouble). The @samp{--traditional-format} switch tells @command{ld} to not |
252b5132 RH |
1951 | combine duplicate entries. |
1952 | ||
2509a395 SL |
1953 | @kindex --section-start=@var{sectionname}=@var{org} |
1954 | @item --section-start=@var{sectionname}=@var{org} | |
176355da NC |
1955 | Locate a section in the output file at the absolute |
1956 | address given by @var{org}. You may use this option as many | |
1957 | times as necessary to locate multiple sections in the command | |
1958 | line. | |
1959 | @var{org} must be a single hexadecimal integer; | |
1960 | for compatibility with other linkers, you may omit the leading | |
1961 | @samp{0x} usually associated with hexadecimal values. @emph{Note:} there | |
1962 | should be no white space between @var{sectionname}, the equals | |
1963 | sign (``@key{=}''), and @var{org}. | |
1964 | ||
2509a395 SL |
1965 | @kindex -Tbss=@var{org} |
1966 | @kindex -Tdata=@var{org} | |
1967 | @kindex -Ttext=@var{org} | |
252b5132 | 1968 | @cindex segment origins, cmd line |
2509a395 SL |
1969 | @item -Tbss=@var{org} |
1970 | @itemx -Tdata=@var{org} | |
1971 | @itemx -Ttext=@var{org} | |
1972 | Same as @option{--section-start}, with @code{.bss}, @code{.data} or | |
a6e02871 | 1973 | @code{.text} as the @var{sectionname}. |
252b5132 | 1974 | |
2509a395 SL |
1975 | @kindex -Ttext-segment=@var{org} |
1976 | @item -Ttext-segment=@var{org} | |
258795f5 | 1977 | @cindex text segment origin, cmd line |
2b8c06a3 L |
1978 | When creating an ELF executable, it will set the address of the first |
1979 | byte of the text segment. | |
258795f5 | 1980 | |
9d5777a3 RM |
1981 | @kindex -Trodata-segment=@var{org} |
1982 | @item -Trodata-segment=@var{org} | |
1983 | @cindex rodata segment origin, cmd line | |
1984 | When creating an ELF executable or shared object for a target where | |
1985 | the read-only data is in its own segment separate from the executable | |
1986 | text, it will set the address of the first byte of the read-only data segment. | |
1987 | ||
0d705e9f AM |
1988 | @kindex -Tldata-segment=@var{org} |
1989 | @item -Tldata-segment=@var{org} | |
1990 | @cindex ldata segment origin, cmd line | |
1991 | When creating an ELF executable or shared object for x86-64 medium memory | |
1992 | model, it will set the address of the first byte of the ldata segment. | |
1993 | ||
560e09e9 NC |
1994 | @kindex --unresolved-symbols |
1995 | @item --unresolved-symbols=@var{method} | |
1996 | Determine how to handle unresolved symbols. There are four possible | |
1997 | values for @samp{method}: | |
1998 | ||
1999 | @table @samp | |
2000 | @item ignore-all | |
da8bce14 | 2001 | Do not report any unresolved symbols. |
560e09e9 NC |
2002 | |
2003 | @item report-all | |
da8bce14 | 2004 | Report all unresolved symbols. This is the default. |
560e09e9 NC |
2005 | |
2006 | @item ignore-in-object-files | |
2007 | Report unresolved symbols that are contained in shared libraries, but | |
2008 | ignore them if they come from regular object files. | |
2009 | ||
2010 | @item ignore-in-shared-libs | |
2011 | Report unresolved symbols that come from regular object files, but | |
2012 | ignore them if they come from shared libraries. This can be useful | |
2013 | when creating a dynamic binary and it is known that all the shared | |
2014 | libraries that it should be referencing are included on the linker's | |
2015 | command line. | |
2016 | @end table | |
2017 | ||
2018 | The behaviour for shared libraries on their own can also be controlled | |
2019 | by the @option{--[no-]allow-shlib-undefined} option. | |
2020 | ||
2021 | Normally the linker will generate an error message for each reported | |
2022 | unresolved symbol but the option @option{--warn-unresolved-symbols} | |
2023 | can change this to a warning. | |
2024 | ||
1715a13c L |
2025 | @kindex --verbose[=@var{NUMBER}] |
2026 | @cindex verbose[=@var{NUMBER}] | |
252b5132 | 2027 | @item --dll-verbose |
1715a13c | 2028 | @itemx --verbose[=@var{NUMBER}] |
ff5dcc92 | 2029 | Display the version number for @command{ld} and list the linker emulations |
252b5132 | 2030 | supported. Display which input files can and cannot be opened. Display |
1715a13c L |
2031 | the linker script being used by the linker. If the optional @var{NUMBER} |
2032 | argument > 1, plugin symbol status will also be displayed. | |
252b5132 RH |
2033 | |
2034 | @kindex --version-script=@var{version-scriptfile} | |
2035 | @cindex version script, symbol versions | |
2509a395 | 2036 | @item --version-script=@var{version-scriptfile} |
252b5132 RH |
2037 | Specify the name of a version script to the linker. This is typically |
2038 | used when creating shared libraries to specify additional information | |
36f63dca | 2039 | about the version hierarchy for the library being created. This option |
09e2aba4 DK |
2040 | is only fully supported on ELF platforms which support shared libraries; |
2041 | see @ref{VERSION}. It is partially supported on PE platforms, which can | |
2042 | use version scripts to filter symbol visibility in auto-export mode: any | |
2043 | symbols marked @samp{local} in the version script will not be exported. | |
2044 | @xref{WIN32}. | |
252b5132 | 2045 | |
7ce691ae | 2046 | @kindex --warn-common |
252b5132 RH |
2047 | @cindex warnings, on combining symbols |
2048 | @cindex combining symbols, warnings on | |
2049 | @item --warn-common | |
2050 | Warn when a common symbol is combined with another common symbol or with | |
11e7fd74 | 2051 | a symbol definition. Unix linkers allow this somewhat sloppy practice, |
252b5132 RH |
2052 | but linkers on some other operating systems do not. This option allows |
2053 | you to find potential problems from combining global symbols. | |
11e7fd74 | 2054 | Unfortunately, some C libraries use this practice, so you may get some |
252b5132 RH |
2055 | warnings about symbols in the libraries as well as in your programs. |
2056 | ||
2057 | There are three kinds of global symbols, illustrated here by C examples: | |
2058 | ||
2059 | @table @samp | |
2060 | @item int i = 1; | |
2061 | A definition, which goes in the initialized data section of the output | |
2062 | file. | |
2063 | ||
2064 | @item extern int i; | |
2065 | An undefined reference, which does not allocate space. | |
2066 | There must be either a definition or a common symbol for the | |
2067 | variable somewhere. | |
2068 | ||
2069 | @item int i; | |
2070 | A common symbol. If there are only (one or more) common symbols for a | |
2071 | variable, it goes in the uninitialized data area of the output file. | |
2072 | The linker merges multiple common symbols for the same variable into a | |
2073 | single symbol. If they are of different sizes, it picks the largest | |
2074 | size. The linker turns a common symbol into a declaration, if there is | |
2075 | a definition of the same variable. | |
2076 | @end table | |
2077 | ||
2078 | The @samp{--warn-common} option can produce five kinds of warnings. | |
2079 | Each warning consists of a pair of lines: the first describes the symbol | |
2080 | just encountered, and the second describes the previous symbol | |
2081 | encountered with the same name. One or both of the two symbols will be | |
2082 | a common symbol. | |
2083 | ||
2084 | @enumerate | |
2085 | @item | |
2086 | Turning a common symbol into a reference, because there is already a | |
2087 | definition for the symbol. | |
2088 | @smallexample | |
2089 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2090 | overridden by definition | |
2091 | @var{file}(@var{section}): warning: defined here | |
2092 | @end smallexample | |
2093 | ||
2094 | @item | |
2095 | Turning a common symbol into a reference, because a later definition for | |
2096 | the symbol is encountered. This is the same as the previous case, | |
2097 | except that the symbols are encountered in a different order. | |
2098 | @smallexample | |
2099 | @var{file}(@var{section}): warning: definition of `@var{symbol}' | |
2100 | overriding common | |
2101 | @var{file}(@var{section}): warning: common is here | |
2102 | @end smallexample | |
2103 | ||
2104 | @item | |
2105 | Merging a common symbol with a previous same-sized common symbol. | |
2106 | @smallexample | |
2107 | @var{file}(@var{section}): warning: multiple common | |
2108 | of `@var{symbol}' | |
2109 | @var{file}(@var{section}): warning: previous common is here | |
2110 | @end smallexample | |
2111 | ||
2112 | @item | |
2113 | Merging a common symbol with a previous larger common symbol. | |
2114 | @smallexample | |
2115 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2116 | overridden by larger common | |
2117 | @var{file}(@var{section}): warning: larger common is here | |
2118 | @end smallexample | |
2119 | ||
2120 | @item | |
2121 | Merging a common symbol with a previous smaller common symbol. This is | |
2122 | the same as the previous case, except that the symbols are | |
2123 | encountered in a different order. | |
2124 | @smallexample | |
2125 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2126 | overriding smaller common | |
2127 | @var{file}(@var{section}): warning: smaller common is here | |
2128 | @end smallexample | |
2129 | @end enumerate | |
2130 | ||
2131 | @kindex --warn-constructors | |
2132 | @item --warn-constructors | |
2133 | Warn if any global constructors are used. This is only useful for a few | |
2134 | object file formats. For formats like COFF or ELF, the linker can not | |
2135 | detect the use of global constructors. | |
2136 | ||
2137 | @kindex --warn-multiple-gp | |
2138 | @item --warn-multiple-gp | |
2139 | Warn if multiple global pointer values are required in the output file. | |
2140 | This is only meaningful for certain processors, such as the Alpha. | |
2141 | Specifically, some processors put large-valued constants in a special | |
2142 | section. A special register (the global pointer) points into the middle | |
2143 | of this section, so that constants can be loaded efficiently via a | |
2144 | base-register relative addressing mode. Since the offset in | |
2145 | base-register relative mode is fixed and relatively small (e.g., 16 | |
2146 | bits), this limits the maximum size of the constant pool. Thus, in | |
2147 | large programs, it is often necessary to use multiple global pointer | |
2148 | values in order to be able to address all possible constants. This | |
2149 | option causes a warning to be issued whenever this case occurs. | |
2150 | ||
2151 | @kindex --warn-once | |
2152 | @cindex warnings, on undefined symbols | |
2153 | @cindex undefined symbols, warnings on | |
2154 | @item --warn-once | |
2155 | Only warn once for each undefined symbol, rather than once per module | |
2156 | which refers to it. | |
2157 | ||
2158 | @kindex --warn-section-align | |
2159 | @cindex warnings, on section alignment | |
2160 | @cindex section alignment, warnings on | |
2161 | @item --warn-section-align | |
2162 | Warn if the address of an output section is changed because of | |
2163 | alignment. Typically, the alignment will be set by an input section. | |
2164 | The address will only be changed if it not explicitly specified; that | |
2165 | is, if the @code{SECTIONS} command does not specify a start address for | |
2166 | the section (@pxref{SECTIONS}). | |
2167 | ||
8fdd7217 NC |
2168 | @kindex --warn-shared-textrel |
2169 | @item --warn-shared-textrel | |
ece2d90e | 2170 | Warn if the linker adds a DT_TEXTREL to a shared object. |
8fdd7217 | 2171 | |
a0c402a5 L |
2172 | @kindex --warn-alternate-em |
2173 | @item --warn-alternate-em | |
2174 | Warn if an object has alternate ELF machine code. | |
2175 | ||
560e09e9 NC |
2176 | @kindex --warn-unresolved-symbols |
2177 | @item --warn-unresolved-symbols | |
2178 | If the linker is going to report an unresolved symbol (see the option | |
2179 | @option{--unresolved-symbols}) it will normally generate an error. | |
2180 | This option makes it generate a warning instead. | |
2181 | ||
2182 | @kindex --error-unresolved-symbols | |
2183 | @item --error-unresolved-symbols | |
2184 | This restores the linker's default behaviour of generating errors when | |
2185 | it is reporting unresolved symbols. | |
2186 | ||
252b5132 RH |
2187 | @kindex --whole-archive |
2188 | @cindex including an entire archive | |
2189 | @item --whole-archive | |
2190 | For each archive mentioned on the command line after the | |
ff5dcc92 | 2191 | @option{--whole-archive} option, include every object file in the archive |
252b5132 RH |
2192 | in the link, rather than searching the archive for the required object |
2193 | files. This is normally used to turn an archive file into a shared | |
2194 | library, forcing every object to be included in the resulting shared | |
2195 | library. This option may be used more than once. | |
2196 | ||
7ec229ce | 2197 | Two notes when using this option from gcc: First, gcc doesn't know |
ff5dcc92 SC |
2198 | about this option, so you have to use @option{-Wl,-whole-archive}. |
2199 | Second, don't forget to use @option{-Wl,-no-whole-archive} after your | |
7ec229ce DD |
2200 | list of archives, because gcc will add its own list of archives to |
2201 | your link and you may not want this flag to affect those as well. | |
2202 | ||
2509a395 SL |
2203 | @kindex --wrap=@var{symbol} |
2204 | @item --wrap=@var{symbol} | |
252b5132 RH |
2205 | Use a wrapper function for @var{symbol}. Any undefined reference to |
2206 | @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any | |
2207 | undefined reference to @code{__real_@var{symbol}} will be resolved to | |
2208 | @var{symbol}. | |
2209 | ||
2210 | This can be used to provide a wrapper for a system function. The | |
2211 | wrapper function should be called @code{__wrap_@var{symbol}}. If it | |
2212 | wishes to call the system function, it should call | |
2213 | @code{__real_@var{symbol}}. | |
2214 | ||
2215 | Here is a trivial example: | |
2216 | ||
2217 | @smallexample | |
2218 | void * | |
cc2f008e | 2219 | __wrap_malloc (size_t c) |
252b5132 | 2220 | @{ |
cc2f008e | 2221 | printf ("malloc called with %zu\n", c); |
252b5132 RH |
2222 | return __real_malloc (c); |
2223 | @} | |
2224 | @end smallexample | |
2225 | ||
ff5dcc92 | 2226 | If you link other code with this file using @option{--wrap malloc}, then |
252b5132 RH |
2227 | all calls to @code{malloc} will call the function @code{__wrap_malloc} |
2228 | instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will | |
2229 | call the real @code{malloc} function. | |
2230 | ||
2231 | You may wish to provide a @code{__real_malloc} function as well, so that | |
ff5dcc92 | 2232 | links without the @option{--wrap} option will succeed. If you do this, |
252b5132 RH |
2233 | you should not put the definition of @code{__real_malloc} in the same |
2234 | file as @code{__wrap_malloc}; if you do, the assembler may resolve the | |
2235 | call before the linker has a chance to wrap it to @code{malloc}. | |
2236 | ||
6aa29e7b JJ |
2237 | @kindex --eh-frame-hdr |
2238 | @item --eh-frame-hdr | |
2239 | Request creation of @code{.eh_frame_hdr} section and ELF | |
2240 | @code{PT_GNU_EH_FRAME} segment header. | |
2241 | ||
e41b3a13 JJ |
2242 | @kindex --ld-generated-unwind-info |
2243 | @item --no-ld-generated-unwind-info | |
2244 | Request creation of @code{.eh_frame} unwind info for linker | |
2245 | generated code sections like PLT. This option is on by default | |
2246 | if linker generated unwind info is supported. | |
2247 | ||
6c1439be L |
2248 | @kindex --enable-new-dtags |
2249 | @kindex --disable-new-dtags | |
2250 | @item --enable-new-dtags | |
2251 | @itemx --disable-new-dtags | |
2252 | This linker can create the new dynamic tags in ELF. But the older ELF | |
2253 | systems may not understand them. If you specify | |
b1b00fcc MF |
2254 | @option{--enable-new-dtags}, the new dynamic tags will be created as needed |
2255 | and older dynamic tags will be omitted. | |
ff5dcc92 | 2256 | If you specify @option{--disable-new-dtags}, no new dynamic tags will be |
6c1439be L |
2257 | created. By default, the new dynamic tags are not created. Note that |
2258 | those options are only available for ELF systems. | |
2259 | ||
2d643429 | 2260 | @kindex --hash-size=@var{number} |
e185dd51 | 2261 | @item --hash-size=@var{number} |
2d643429 NC |
2262 | Set the default size of the linker's hash tables to a prime number |
2263 | close to @var{number}. Increasing this value can reduce the length of | |
2264 | time it takes the linker to perform its tasks, at the expense of | |
2265 | increasing the linker's memory requirements. Similarly reducing this | |
2266 | value can reduce the memory requirements at the expense of speed. | |
2267 | ||
fdc90cb4 JJ |
2268 | @kindex --hash-style=@var{style} |
2269 | @item --hash-style=@var{style} | |
2270 | Set the type of linker's hash table(s). @var{style} can be either | |
2271 | @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for | |
2272 | new style GNU @code{.gnu.hash} section or @code{both} for both | |
2273 | the classic ELF @code{.hash} and new style GNU @code{.gnu.hash} | |
2274 | hash tables. The default is @code{sysv}. | |
2275 | ||
0ce398f1 L |
2276 | @kindex --compress-debug-sections=none |
2277 | @kindex --compress-debug-sections=zlib | |
2278 | @kindex --compress-debug-sections=zlib-gnu | |
2279 | @kindex --compress-debug-sections=zlib-gabi | |
2280 | @item --compress-debug-sections=none | |
2281 | @itemx --compress-debug-sections=zlib | |
2282 | @itemx --compress-debug-sections=zlib-gnu | |
2283 | @itemx --compress-debug-sections=zlib-gabi | |
2284 | On ELF platforms , these options control how DWARF debug sections are | |
2285 | compressed using zlib. @option{--compress-debug-sections=none} doesn't | |
19a7fe52 L |
2286 | compress DWARF debug sections. |
2287 | @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug | |
0ce398f1 | 2288 | sections and rename debug section names to begin with @samp{.zdebug} |
19a7fe52 L |
2289 | instead of @samp{.debug}. @option{--compress-debug-sections=zlib} |
2290 | and @option{--compress-debug-sections=zlib-gabi} | |
2291 | compress DWARF debug sections with SHF_COMPRESSED from the ELF ABI. | |
6c3bc0f8 NC |
2292 | The default behaviour varies depending upon the target involved and |
2293 | the configure options used to build the toolchain. The default can be | |
2294 | determined by examing the output from the linker's @option{--help} option. | |
0ce398f1 | 2295 | |
35835446 JR |
2296 | @kindex --reduce-memory-overheads |
2297 | @item --reduce-memory-overheads | |
2298 | This option reduces memory requirements at ld runtime, at the expense of | |
f2a8f148 | 2299 | linking speed. This was introduced to select the old O(n^2) algorithm |
35835446 | 2300 | for link map file generation, rather than the new O(n) algorithm which uses |
2d643429 NC |
2301 | about 40% more memory for symbol storage. |
2302 | ||
4f9c04f7 | 2303 | Another effect of the switch is to set the default hash table size to |
2d643429 | 2304 | 1021, which again saves memory at the cost of lengthening the linker's |
a85785bc | 2305 | run time. This is not done however if the @option{--hash-size} switch |
2d643429 NC |
2306 | has been used. |
2307 | ||
2308 | The @option{--reduce-memory-overheads} switch may be also be used to | |
2309 | enable other tradeoffs in future versions of the linker. | |
35835446 | 2310 | |
c0065db7 RM |
2311 | @kindex --build-id |
2312 | @kindex --build-id=@var{style} | |
2313 | @item --build-id | |
2314 | @itemx --build-id=@var{style} | |
61e2488c | 2315 | Request the creation of a @code{.note.gnu.build-id} ELF note section |
6033bf41 | 2316 | or a @code{.buildid} COFF section. The contents of the note are |
61e2488c JT |
2317 | unique bits identifying this linked file. @var{style} can be |
2318 | @code{uuid} to use 128 random bits, @code{sha1} to use a 160-bit | |
2319 | @sc{SHA1} hash on the normative parts of the output contents, | |
2320 | @code{md5} to use a 128-bit @sc{MD5} hash on the normative parts of | |
2321 | the output contents, or @code{0x@var{hexstring}} to use a chosen bit | |
2322 | string specified as an even number of hexadecimal digits (@code{-} and | |
2323 | @code{:} characters between digit pairs are ignored). If @var{style} | |
2324 | is omitted, @code{sha1} is used. | |
24382dca RM |
2325 | |
2326 | The @code{md5} and @code{sha1} styles produces an identifier | |
2327 | that is always the same in an identical output file, but will be | |
2328 | unique among all nonidentical output files. It is not intended | |
2329 | to be compared as a checksum for the file's contents. A linked | |
2330 | file may be changed later by other tools, but the build ID bit | |
2331 | string identifying the original linked file does not change. | |
c0065db7 RM |
2332 | |
2333 | Passing @code{none} for @var{style} disables the setting from any | |
2334 | @code{--build-id} options earlier on the command line. | |
252b5132 RH |
2335 | @end table |
2336 | ||
0285c67d NC |
2337 | @c man end |
2338 | ||
36f63dca | 2339 | @subsection Options Specific to i386 PE Targets |
252b5132 | 2340 | |
0285c67d NC |
2341 | @c man begin OPTIONS |
2342 | ||
ff5dcc92 | 2343 | The i386 PE linker supports the @option{-shared} option, which causes |
252b5132 RH |
2344 | the output to be a dynamically linked library (DLL) instead of a |
2345 | normal executable. You should name the output @code{*.dll} when you | |
2346 | use this option. In addition, the linker fully supports the standard | |
2347 | @code{*.def} files, which may be specified on the linker command line | |
2348 | like an object file (in fact, it should precede archives it exports | |
2349 | symbols from, to ensure that they get linked in, just like a normal | |
2350 | object file). | |
2351 | ||
2352 | In addition to the options common to all targets, the i386 PE linker | |
2353 | support additional command line options that are specific to the i386 | |
2354 | PE target. Options that take values may be separated from their | |
2355 | values by either a space or an equals sign. | |
2356 | ||
ff5dcc92 | 2357 | @table @gcctabopt |
252b5132 RH |
2358 | |
2359 | @kindex --add-stdcall-alias | |
2360 | @item --add-stdcall-alias | |
2361 | If given, symbols with a stdcall suffix (@@@var{nn}) will be exported | |
2362 | as-is and also with the suffix stripped. | |
bb10df36 | 2363 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2364 | |
2365 | @kindex --base-file | |
2366 | @item --base-file @var{file} | |
2367 | Use @var{file} as the name of a file in which to save the base | |
2368 | addresses of all the relocations needed for generating DLLs with | |
2369 | @file{dlltool}. | |
bb10df36 | 2370 | [This is an i386 PE specific option] |
252b5132 RH |
2371 | |
2372 | @kindex --dll | |
2373 | @item --dll | |
2374 | Create a DLL instead of a regular executable. You may also use | |
ff5dcc92 | 2375 | @option{-shared} or specify a @code{LIBRARY} in a given @code{.def} |
252b5132 | 2376 | file. |
bb10df36 | 2377 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2378 | |
88183869 DK |
2379 | @kindex --enable-long-section-names |
2380 | @kindex --disable-long-section-names | |
2381 | @item --enable-long-section-names | |
2382 | @itemx --disable-long-section-names | |
56e6cf80 | 2383 | The PE variants of the COFF object format add an extension that permits |
88183869 | 2384 | the use of section names longer than eight characters, the normal limit |
56e6cf80 NC |
2385 | for COFF. By default, these names are only allowed in object files, as |
2386 | fully-linked executable images do not carry the COFF string table required | |
88183869 DK |
2387 | to support the longer names. As a GNU extension, it is possible to |
2388 | allow their use in executable images as well, or to (probably pointlessly!) | |
2389 | disallow it in object files, by using these two options. Executable images | |
2390 | generated with these long section names are slightly non-standard, carrying | |
2391 | as they do a string table, and may generate confusing output when examined | |
9d5777a3 RM |
2392 | with non-GNU PE-aware tools, such as file viewers and dumpers. However, |
2393 | GDB relies on the use of PE long section names to find Dwarf-2 debug | |
3efd345c DK |
2394 | information sections in an executable image at runtime, and so if neither |
2395 | option is specified on the command-line, @command{ld} will enable long | |
2396 | section names, overriding the default and technically correct behaviour, | |
2397 | when it finds the presence of debug information while linking an executable | |
2398 | image and not stripping symbols. | |
88183869 DK |
2399 | [This option is valid for all PE targeted ports of the linker] |
2400 | ||
252b5132 RH |
2401 | @kindex --enable-stdcall-fixup |
2402 | @kindex --disable-stdcall-fixup | |
2403 | @item --enable-stdcall-fixup | |
2404 | @itemx --disable-stdcall-fixup | |
2405 | If the link finds a symbol that it cannot resolve, it will attempt to | |
36f63dca | 2406 | do ``fuzzy linking'' by looking for another defined symbol that differs |
252b5132 RH |
2407 | only in the format of the symbol name (cdecl vs stdcall) and will |
2408 | resolve that symbol by linking to the match. For example, the | |
2409 | undefined symbol @code{_foo} might be linked to the function | |
2410 | @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked | |
2411 | to the function @code{_bar}. When the linker does this, it prints a | |
2412 | warning, since it normally should have failed to link, but sometimes | |
2413 | import libraries generated from third-party dlls may need this feature | |
ff5dcc92 | 2414 | to be usable. If you specify @option{--enable-stdcall-fixup}, this |
252b5132 | 2415 | feature is fully enabled and warnings are not printed. If you specify |
ff5dcc92 | 2416 | @option{--disable-stdcall-fixup}, this feature is disabled and such |
252b5132 | 2417 | mismatches are considered to be errors. |
bb10df36 | 2418 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2419 | |
522f09cd KT |
2420 | @kindex --leading-underscore |
2421 | @kindex --no-leading-underscore | |
2422 | @item --leading-underscore | |
2423 | @itemx --no-leading-underscore | |
2424 | For most targets default symbol-prefix is an underscore and is defined | |
2425 | in target's description. By this option it is possible to | |
2426 | disable/enable the default underscore symbol-prefix. | |
2427 | ||
252b5132 RH |
2428 | @cindex DLLs, creating |
2429 | @kindex --export-all-symbols | |
2430 | @item --export-all-symbols | |
2431 | If given, all global symbols in the objects used to build a DLL will | |
2432 | be exported by the DLL. Note that this is the default if there | |
2433 | otherwise wouldn't be any exported symbols. When symbols are | |
2434 | explicitly exported via DEF files or implicitly exported via function | |
2435 | attributes, the default is to not export anything else unless this | |
2436 | option is given. Note that the symbols @code{DllMain@@12}, | |
ece2d90e | 2437 | @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and |
b044cda1 | 2438 | @code{impure_ptr} will not be automatically |
ece2d90e NC |
2439 | exported. Also, symbols imported from other DLLs will not be |
2440 | re-exported, nor will symbols specifying the DLL's internal layout | |
2441 | such as those beginning with @code{_head_} or ending with | |
2442 | @code{_iname}. In addition, no symbols from @code{libgcc}, | |
b044cda1 CW |
2443 | @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported. |
2444 | Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will | |
2445 | not be exported, to help with C++ DLLs. Finally, there is an | |
ece2d90e | 2446 | extensive list of cygwin-private symbols that are not exported |
b044cda1 | 2447 | (obviously, this applies on when building DLLs for cygwin targets). |
ece2d90e | 2448 | These cygwin-excludes are: @code{_cygwin_dll_entry@@12}, |
b044cda1 | 2449 | @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12}, |
ece2d90e | 2450 | @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll}, |
b044cda1 | 2451 | @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2}, |
ece2d90e | 2452 | @code{cygwin_premain3}, and @code{environ}. |
bb10df36 | 2453 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2454 | |
2455 | @kindex --exclude-symbols | |
1d0a3c9c | 2456 | @item --exclude-symbols @var{symbol},@var{symbol},... |
252b5132 RH |
2457 | Specifies a list of symbols which should not be automatically |
2458 | exported. The symbol names may be delimited by commas or colons. | |
bb10df36 | 2459 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2460 | |
2927aaca NC |
2461 | @kindex --exclude-all-symbols |
2462 | @item --exclude-all-symbols | |
2463 | Specifies no symbols should be automatically exported. | |
2464 | [This option is specific to the i386 PE targeted port of the linker] | |
2465 | ||
252b5132 RH |
2466 | @kindex --file-alignment |
2467 | @item --file-alignment | |
2468 | Specify the file alignment. Sections in the file will always begin at | |
2469 | file offsets which are multiples of this number. This defaults to | |
2470 | 512. | |
bb10df36 | 2471 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2472 | |
2473 | @cindex heap size | |
2474 | @kindex --heap | |
2475 | @item --heap @var{reserve} | |
2476 | @itemx --heap @var{reserve},@var{commit} | |
a00b50c5 | 2477 | Specify the number of bytes of memory to reserve (and optionally commit) |
fe6d7d6a | 2478 | to be used as heap for this program. The default is 1MB reserved, 4K |
252b5132 | 2479 | committed. |
bb10df36 | 2480 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2481 | |
2482 | @cindex image base | |
2483 | @kindex --image-base | |
2484 | @item --image-base @var{value} | |
2485 | Use @var{value} as the base address of your program or dll. This is | |
2486 | the lowest memory location that will be used when your program or dll | |
2487 | is loaded. To reduce the need to relocate and improve performance of | |
2488 | your dlls, each should have a unique base address and not overlap any | |
2489 | other dlls. The default is 0x400000 for executables, and 0x10000000 | |
2490 | for dlls. | |
bb10df36 | 2491 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2492 | |
2493 | @kindex --kill-at | |
2494 | @item --kill-at | |
2495 | If given, the stdcall suffixes (@@@var{nn}) will be stripped from | |
2496 | symbols before they are exported. | |
bb10df36 | 2497 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2498 | |
26d2d8a2 BF |
2499 | @kindex --large-address-aware |
2500 | @item --large-address-aware | |
b45619c0 | 2501 | If given, the appropriate bit in the ``Characteristics'' field of the COFF |
26d2d8a2 | 2502 | header is set to indicate that this executable supports virtual addresses |
b45619c0 | 2503 | greater than 2 gigabytes. This should be used in conjunction with the /3GB |
26d2d8a2 BF |
2504 | or /USERVA=@var{value} megabytes switch in the ``[operating systems]'' |
2505 | section of the BOOT.INI. Otherwise, this bit has no effect. | |
2506 | [This option is specific to PE targeted ports of the linker] | |
2507 | ||
f69a2f97 NC |
2508 | @kindex --disable-large-address-aware |
2509 | @item --disable-large-address-aware | |
2510 | Reverts the effect of a previous @samp{--large-address-aware} option. | |
2511 | This is useful if @samp{--large-address-aware} is always set by the compiler | |
2512 | driver (e.g. Cygwin gcc) and the executable does not support virtual | |
2513 | addresses greater than 2 gigabytes. | |
2514 | [This option is specific to PE targeted ports of the linker] | |
2515 | ||
252b5132 RH |
2516 | @kindex --major-image-version |
2517 | @item --major-image-version @var{value} | |
36f63dca | 2518 | Sets the major number of the ``image version''. Defaults to 1. |
bb10df36 | 2519 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2520 | |
2521 | @kindex --major-os-version | |
2522 | @item --major-os-version @var{value} | |
36f63dca | 2523 | Sets the major number of the ``os version''. Defaults to 4. |
bb10df36 | 2524 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2525 | |
2526 | @kindex --major-subsystem-version | |
2527 | @item --major-subsystem-version @var{value} | |
36f63dca | 2528 | Sets the major number of the ``subsystem version''. Defaults to 4. |
bb10df36 | 2529 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2530 | |
2531 | @kindex --minor-image-version | |
2532 | @item --minor-image-version @var{value} | |
36f63dca | 2533 | Sets the minor number of the ``image version''. Defaults to 0. |
bb10df36 | 2534 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2535 | |
2536 | @kindex --minor-os-version | |
2537 | @item --minor-os-version @var{value} | |
36f63dca | 2538 | Sets the minor number of the ``os version''. Defaults to 0. |
bb10df36 | 2539 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2540 | |
2541 | @kindex --minor-subsystem-version | |
2542 | @item --minor-subsystem-version @var{value} | |
36f63dca | 2543 | Sets the minor number of the ``subsystem version''. Defaults to 0. |
bb10df36 | 2544 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2545 | |
2546 | @cindex DEF files, creating | |
2547 | @cindex DLLs, creating | |
2548 | @kindex --output-def | |
2549 | @item --output-def @var{file} | |
2550 | The linker will create the file @var{file} which will contain a DEF | |
2551 | file corresponding to the DLL the linker is generating. This DEF file | |
2552 | (which should be called @code{*.def}) may be used to create an import | |
2553 | library with @code{dlltool} or may be used as a reference to | |
2554 | automatically or implicitly exported symbols. | |
bb10df36 | 2555 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2556 | |
b044cda1 CW |
2557 | @cindex DLLs, creating |
2558 | @kindex --out-implib | |
2559 | @item --out-implib @var{file} | |
2560 | The linker will create the file @var{file} which will contain an | |
2561 | import lib corresponding to the DLL the linker is generating. This | |
2562 | import lib (which should be called @code{*.dll.a} or @code{*.a} | |
560e09e9 | 2563 | may be used to link clients against the generated DLL; this behaviour |
b044cda1 CW |
2564 | makes it possible to skip a separate @code{dlltool} import library |
2565 | creation step. | |
bb10df36 | 2566 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2567 | |
2568 | @kindex --enable-auto-image-base | |
2569 | @item --enable-auto-image-base | |
d0e6d77b CF |
2570 | @itemx --enable-auto-image-base=@var{value} |
2571 | Automatically choose the image base for DLLs, optionally starting with base | |
2572 | @var{value}, unless one is specified using the @code{--image-base} argument. | |
2573 | By using a hash generated from the dllname to create unique image bases | |
2574 | for each DLL, in-memory collisions and relocations which can delay program | |
2575 | execution are avoided. | |
bb10df36 | 2576 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2577 | |
2578 | @kindex --disable-auto-image-base | |
2579 | @item --disable-auto-image-base | |
2580 | Do not automatically generate a unique image base. If there is no | |
2581 | user-specified image base (@code{--image-base}) then use the platform | |
2582 | default. | |
bb10df36 | 2583 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2584 | |
2585 | @cindex DLLs, linking to | |
2586 | @kindex --dll-search-prefix | |
2587 | @item --dll-search-prefix @var{string} | |
489d0400 | 2588 | When linking dynamically to a dll without an import library, |
ece2d90e | 2589 | search for @code{<string><basename>.dll} in preference to |
560e09e9 | 2590 | @code{lib<basename>.dll}. This behaviour allows easy distinction |
b044cda1 CW |
2591 | between DLLs built for the various "subplatforms": native, cygwin, |
2592 | uwin, pw, etc. For instance, cygwin DLLs typically use | |
ece2d90e | 2593 | @code{--dll-search-prefix=cyg}. |
bb10df36 | 2594 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2595 | |
2596 | @kindex --enable-auto-import | |
2597 | @item --enable-auto-import | |
ece2d90e NC |
2598 | Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for |
2599 | DATA imports from DLLs, and create the necessary thunking symbols when | |
4d8907ac DS |
2600 | building the import libraries with those DATA exports. Note: Use of the |
2601 | 'auto-import' extension will cause the text section of the image file | |
2602 | to be made writable. This does not conform to the PE-COFF format | |
2603 | specification published by Microsoft. | |
2604 | ||
e2a83dd0 NC |
2605 | Note - use of the 'auto-import' extension will also cause read only |
2606 | data which would normally be placed into the .rdata section to be | |
2607 | placed into the .data section instead. This is in order to work | |
2608 | around a problem with consts that is described here: | |
2609 | http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html | |
2610 | ||
4d8907ac DS |
2611 | Using 'auto-import' generally will 'just work' -- but sometimes you may |
2612 | see this message: | |
0d888aac | 2613 | |
ece2d90e | 2614 | "variable '<var>' can't be auto-imported. Please read the |
0d888aac CW |
2615 | documentation for ld's @code{--enable-auto-import} for details." |
2616 | ||
ece2d90e NC |
2617 | This message occurs when some (sub)expression accesses an address |
2618 | ultimately given by the sum of two constants (Win32 import tables only | |
c0065db7 RM |
2619 | allow one). Instances where this may occur include accesses to member |
2620 | fields of struct variables imported from a DLL, as well as using a | |
2621 | constant index into an array variable imported from a DLL. Any | |
2f8d8971 NC |
2622 | multiword variable (arrays, structs, long long, etc) may trigger |
2623 | this error condition. However, regardless of the exact data type | |
2624 | of the offending exported variable, ld will always detect it, issue | |
2625 | the warning, and exit. | |
2626 | ||
2627 | There are several ways to address this difficulty, regardless of the | |
2628 | data type of the exported variable: | |
0d888aac | 2629 | |
2fa9fc65 NC |
2630 | One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task |
2631 | of adjusting references in your client code for runtime environment, so | |
560e09e9 | 2632 | this method works only when runtime environment supports this feature. |
2fa9fc65 | 2633 | |
c0065db7 RM |
2634 | A second solution is to force one of the 'constants' to be a variable -- |
2635 | that is, unknown and un-optimizable at compile time. For arrays, | |
2636 | there are two possibilities: a) make the indexee (the array's address) | |
0d888aac CW |
2637 | a variable, or b) make the 'constant' index a variable. Thus: |
2638 | ||
2639 | @example | |
2640 | extern type extern_array[]; | |
c0065db7 | 2641 | extern_array[1] --> |
0d888aac CW |
2642 | @{ volatile type *t=extern_array; t[1] @} |
2643 | @end example | |
2644 | ||
2645 | or | |
2646 | ||
2647 | @example | |
2648 | extern type extern_array[]; | |
c0065db7 | 2649 | extern_array[1] --> |
0d888aac CW |
2650 | @{ volatile int t=1; extern_array[t] @} |
2651 | @end example | |
2652 | ||
c0065db7 | 2653 | For structs (and most other multiword data types) the only option |
2f8d8971 | 2654 | is to make the struct itself (or the long long, or the ...) variable: |
0d888aac CW |
2655 | |
2656 | @example | |
2657 | extern struct s extern_struct; | |
c0065db7 | 2658 | extern_struct.field --> |
0d888aac CW |
2659 | @{ volatile struct s *t=&extern_struct; t->field @} |
2660 | @end example | |
2661 | ||
c406afaf NC |
2662 | or |
2663 | ||
2664 | @example | |
2665 | extern long long extern_ll; | |
2666 | extern_ll --> | |
2667 | @{ volatile long long * local_ll=&extern_ll; *local_ll @} | |
2668 | @end example | |
2669 | ||
2fa9fc65 | 2670 | A third method of dealing with this difficulty is to abandon |
c0065db7 | 2671 | 'auto-import' for the offending symbol and mark it with |
11e7fd74 | 2672 | @code{__declspec(dllimport)}. However, in practice that |
0d888aac | 2673 | requires using compile-time #defines to indicate whether you are |
c0065db7 RM |
2674 | building a DLL, building client code that will link to the DLL, or |
2675 | merely building/linking to a static library. In making the choice | |
2676 | between the various methods of resolving the 'direct address with | |
0d888aac CW |
2677 | constant offset' problem, you should consider typical real-world usage: |
2678 | ||
2679 | Original: | |
2680 | @example | |
2681 | --foo.h | |
2682 | extern int arr[]; | |
2683 | --foo.c | |
2684 | #include "foo.h" | |
2685 | void main(int argc, char **argv)@{ | |
2686 | printf("%d\n",arr[1]); | |
2687 | @} | |
2688 | @end example | |
2689 | ||
2690 | Solution 1: | |
2691 | @example | |
2692 | --foo.h | |
2693 | extern int arr[]; | |
2694 | --foo.c | |
2695 | #include "foo.h" | |
2696 | void main(int argc, char **argv)@{ | |
2697 | /* This workaround is for win32 and cygwin; do not "optimize" */ | |
2698 | volatile int *parr = arr; | |
2699 | printf("%d\n",parr[1]); | |
2700 | @} | |
2701 | @end example | |
2702 | ||
2703 | Solution 2: | |
2704 | @example | |
2705 | --foo.h | |
2706 | /* Note: auto-export is assumed (no __declspec(dllexport)) */ | |
2707 | #if (defined(_WIN32) || defined(__CYGWIN__)) && \ | |
2708 | !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC)) | |
2709 | #define FOO_IMPORT __declspec(dllimport) | |
2710 | #else | |
2711 | #define FOO_IMPORT | |
2712 | #endif | |
2713 | extern FOO_IMPORT int arr[]; | |
2714 | --foo.c | |
2715 | #include "foo.h" | |
2716 | void main(int argc, char **argv)@{ | |
2717 | printf("%d\n",arr[1]); | |
2718 | @} | |
2719 | @end example | |
2720 | ||
c0065db7 | 2721 | A fourth way to avoid this problem is to re-code your |
0d888aac CW |
2722 | library to use a functional interface rather than a data interface |
2723 | for the offending variables (e.g. set_foo() and get_foo() accessor | |
2724 | functions). | |
bb10df36 | 2725 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2726 | |
2727 | @kindex --disable-auto-import | |
2728 | @item --disable-auto-import | |
c0065db7 | 2729 | Do not attempt to do sophisticated linking of @code{_symbol} to |
b044cda1 | 2730 | @code{__imp__symbol} for DATA imports from DLLs. |
bb10df36 | 2731 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2732 | |
2fa9fc65 NC |
2733 | @kindex --enable-runtime-pseudo-reloc |
2734 | @item --enable-runtime-pseudo-reloc | |
2735 | If your code contains expressions described in --enable-auto-import section, | |
2736 | that is, DATA imports from DLL with non-zero offset, this switch will create | |
2737 | a vector of 'runtime pseudo relocations' which can be used by runtime | |
c0065db7 | 2738 | environment to adjust references to such data in your client code. |
bb10df36 | 2739 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 NC |
2740 | |
2741 | @kindex --disable-runtime-pseudo-reloc | |
2742 | @item --disable-runtime-pseudo-reloc | |
2743 | Do not create pseudo relocations for non-zero offset DATA imports from | |
676ee43b | 2744 | DLLs. |
bb10df36 | 2745 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 | 2746 | |
b044cda1 CW |
2747 | @kindex --enable-extra-pe-debug |
2748 | @item --enable-extra-pe-debug | |
2749 | Show additional debug info related to auto-import symbol thunking. | |
bb10df36 | 2750 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2751 | |
252b5132 RH |
2752 | @kindex --section-alignment |
2753 | @item --section-alignment | |
2754 | Sets the section alignment. Sections in memory will always begin at | |
2755 | addresses which are a multiple of this number. Defaults to 0x1000. | |
bb10df36 | 2756 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2757 | |
2758 | @cindex stack size | |
2759 | @kindex --stack | |
2760 | @item --stack @var{reserve} | |
2761 | @itemx --stack @var{reserve},@var{commit} | |
a00b50c5 | 2762 | Specify the number of bytes of memory to reserve (and optionally commit) |
fe6d7d6a | 2763 | to be used as stack for this program. The default is 2MB reserved, 4K |
252b5132 | 2764 | committed. |
bb10df36 | 2765 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2766 | |
2767 | @kindex --subsystem | |
2768 | @item --subsystem @var{which} | |
2769 | @itemx --subsystem @var{which}:@var{major} | |
2770 | @itemx --subsystem @var{which}:@var{major}.@var{minor} | |
2771 | Specifies the subsystem under which your program will execute. The | |
2772 | legal values for @var{which} are @code{native}, @code{windows}, | |
33f362e1 NC |
2773 | @code{console}, @code{posix}, and @code{xbox}. You may optionally set |
2774 | the subsystem version also. Numeric values are also accepted for | |
2775 | @var{which}. | |
bb10df36 | 2776 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2777 | |
2f563b51 DK |
2778 | The following options set flags in the @code{DllCharacteristics} field |
2779 | of the PE file header: | |
2780 | [These options are specific to PE targeted ports of the linker] | |
2781 | ||
2d5c3743 NC |
2782 | @kindex --high-entropy-va |
2783 | @item --high-entropy-va | |
2784 | Image is compatible with 64-bit address space layout randomization | |
2785 | (ASLR). | |
2786 | ||
2f563b51 DK |
2787 | @kindex --dynamicbase |
2788 | @item --dynamicbase | |
2789 | The image base address may be relocated using address space layout | |
2790 | randomization (ASLR). This feature was introduced with MS Windows | |
2791 | Vista for i386 PE targets. | |
2792 | ||
2793 | @kindex --forceinteg | |
2794 | @item --forceinteg | |
2795 | Code integrity checks are enforced. | |
2796 | ||
2797 | @kindex --nxcompat | |
2798 | @item --nxcompat | |
2799 | The image is compatible with the Data Execution Prevention. | |
2800 | This feature was introduced with MS Windows XP SP2 for i386 PE targets. | |
2801 | ||
2802 | @kindex --no-isolation | |
2803 | @item --no-isolation | |
2804 | Although the image understands isolation, do not isolate the image. | |
2805 | ||
2806 | @kindex --no-seh | |
2807 | @item --no-seh | |
2808 | The image does not use SEH. No SE handler may be called from | |
2809 | this image. | |
2810 | ||
2811 | @kindex --no-bind | |
2812 | @item --no-bind | |
2813 | Do not bind this image. | |
2814 | ||
2815 | @kindex --wdmdriver | |
2816 | @item --wdmdriver | |
2817 | The driver uses the MS Windows Driver Model. | |
9d5777a3 | 2818 | |
2f563b51 DK |
2819 | @kindex --tsaware |
2820 | @item --tsaware | |
2821 | The image is Terminal Server aware. | |
2822 | ||
0cb112f7 CF |
2823 | @kindex --insert-timestamp |
2824 | @item --insert-timestamp | |
eeb14e5a LZ |
2825 | @itemx --no-insert-timestamp |
2826 | Insert a real timestamp into the image. This is the default behaviour | |
2827 | as it matches legacy code and it means that the image will work with | |
2828 | other, proprietary tools. The problem with this default is that it | |
56e6cf80 | 2829 | will result in slightly different images being produced each time the |
eeb14e5a LZ |
2830 | same sources are linked. The option @option{--no-insert-timestamp} |
2831 | can be used to insert a zero value for the timestamp, this ensuring | |
56e6cf80 | 2832 | that binaries produced from identical sources will compare |
eeb14e5a | 2833 | identically. |
252b5132 RH |
2834 | @end table |
2835 | ||
0285c67d NC |
2836 | @c man end |
2837 | ||
ac145307 BS |
2838 | @ifset C6X |
2839 | @subsection Options specific to C6X uClinux targets | |
2840 | ||
2841 | @c man begin OPTIONS | |
2842 | ||
2843 | The C6X uClinux target uses a binary format called DSBT to support shared | |
2844 | libraries. Each shared library in the system needs to have a unique index; | |
2845 | all executables use an index of 0. | |
2846 | ||
2847 | @table @gcctabopt | |
2848 | ||
2849 | @kindex --dsbt-size | |
2850 | @item --dsbt-size @var{size} | |
56e6cf80 | 2851 | This option sets the number of entries in the DSBT of the current executable |
ac145307 BS |
2852 | or shared library to @var{size}. The default is to create a table with 64 |
2853 | entries. | |
2854 | ||
2855 | @kindex --dsbt-index | |
2856 | @item --dsbt-index @var{index} | |
2857 | This option sets the DSBT index of the current executable or shared library | |
2858 | to @var{index}. The default is 0, which is appropriate for generating | |
2859 | executables. If a shared library is generated with a DSBT index of 0, the | |
2860 | @code{R_C6000_DSBT_INDEX} relocs are copied into the output file. | |
2861 | ||
fbd9ad90 PB |
2862 | @kindex --no-merge-exidx-entries |
2863 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent | |
2864 | exidx entries in frame unwind info. | |
2865 | ||
ac145307 BS |
2866 | @end table |
2867 | ||
2868 | @c man end | |
2869 | @end ifset | |
2870 | ||
93fd0973 SC |
2871 | @ifset M68HC11 |
2872 | @subsection Options specific to Motorola 68HC11 and 68HC12 targets | |
2873 | ||
2874 | @c man begin OPTIONS | |
2875 | ||
2876 | The 68HC11 and 68HC12 linkers support specific options to control the | |
2877 | memory bank switching mapping and trampoline code generation. | |
2878 | ||
2879 | @table @gcctabopt | |
2880 | ||
2881 | @kindex --no-trampoline | |
2882 | @item --no-trampoline | |
2883 | This option disables the generation of trampoline. By default a trampoline | |
2884 | is generated for each far function which is called using a @code{jsr} | |
2885 | instruction (this happens when a pointer to a far function is taken). | |
2886 | ||
2887 | @kindex --bank-window | |
2888 | @item --bank-window @var{name} | |
2889 | This option indicates to the linker the name of the memory region in | |
2890 | the @samp{MEMORY} specification that describes the memory bank window. | |
2891 | The definition of such region is then used by the linker to compute | |
2892 | paging and addresses within the memory window. | |
2893 | ||
2894 | @end table | |
2895 | ||
2896 | @c man end | |
2897 | @end ifset | |
2898 | ||
7fb9f789 NC |
2899 | @ifset M68K |
2900 | @subsection Options specific to Motorola 68K target | |
2901 | ||
2902 | @c man begin OPTIONS | |
2903 | ||
2904 | The following options are supported to control handling of GOT generation | |
2905 | when linking for 68K targets. | |
2906 | ||
2907 | @table @gcctabopt | |
2908 | ||
2909 | @kindex --got | |
2910 | @item --got=@var{type} | |
2911 | This option tells the linker which GOT generation scheme to use. | |
2912 | @var{type} should be one of @samp{single}, @samp{negative}, | |
2913 | @samp{multigot} or @samp{target}. For more information refer to the | |
2914 | Info entry for @file{ld}. | |
2915 | ||
2916 | @end table | |
2917 | ||
2918 | @c man end | |
2919 | @end ifset | |
2920 | ||
833794fc MR |
2921 | @ifset MIPS |
2922 | @subsection Options specific to MIPS targets | |
2923 | ||
2924 | @c man begin OPTIONS | |
2925 | ||
2926 | The following options are supported to control microMIPS instruction | |
2927 | generation when linking for MIPS targets. | |
2928 | ||
2929 | @table @gcctabopt | |
2930 | ||
2931 | @kindex --insn32 | |
2932 | @item --insn32 | |
2933 | @kindex --no-insn32 | |
2934 | @itemx --no-insn32 | |
2935 | These options control the choice of microMIPS instructions used in code | |
2936 | generated by the linker, such as that in the PLT or lazy binding stubs, | |
2937 | or in relaxation. If @samp{--insn32} is used, then the linker only uses | |
2938 | 32-bit instruction encodings. By default or if @samp{--no-insn32} is | |
2939 | used, all instruction encodings are used, including 16-bit ones where | |
2940 | possible. | |
2941 | ||
2942 | @end table | |
2943 | ||
2944 | @c man end | |
2945 | @end ifset | |
2946 | ||
252b5132 RH |
2947 | @ifset UsesEnvVars |
2948 | @node Environment | |
2949 | @section Environment Variables | |
2950 | ||
0285c67d NC |
2951 | @c man begin ENVIRONMENT |
2952 | ||
560e09e9 | 2953 | You can change the behaviour of @command{ld} with the environment variables |
36f63dca NC |
2954 | @ifclear SingleFormat |
2955 | @code{GNUTARGET}, | |
2956 | @end ifclear | |
2957 | @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}. | |
252b5132 | 2958 | |
36f63dca | 2959 | @ifclear SingleFormat |
252b5132 RH |
2960 | @kindex GNUTARGET |
2961 | @cindex default input format | |
2962 | @code{GNUTARGET} determines the input-file object format if you don't | |
2963 | use @samp{-b} (or its synonym @samp{--format}). Its value should be one | |
2964 | of the BFD names for an input format (@pxref{BFD}). If there is no | |
ff5dcc92 | 2965 | @code{GNUTARGET} in the environment, @command{ld} uses the natural format |
252b5132 RH |
2966 | of the target. If @code{GNUTARGET} is set to @code{default} then BFD |
2967 | attempts to discover the input format by examining binary input files; | |
2968 | this method often succeeds, but there are potential ambiguities, since | |
2969 | there is no method of ensuring that the magic number used to specify | |
2970 | object-file formats is unique. However, the configuration procedure for | |
2971 | BFD on each system places the conventional format for that system first | |
2972 | in the search-list, so ambiguities are resolved in favor of convention. | |
36f63dca | 2973 | @end ifclear |
252b5132 RH |
2974 | |
2975 | @kindex LDEMULATION | |
2976 | @cindex default emulation | |
2977 | @cindex emulation, default | |
2978 | @code{LDEMULATION} determines the default emulation if you don't use the | |
2979 | @samp{-m} option. The emulation can affect various aspects of linker | |
2980 | behaviour, particularly the default linker script. You can list the | |
2981 | available emulations with the @samp{--verbose} or @samp{-V} options. If | |
2982 | the @samp{-m} option is not used, and the @code{LDEMULATION} environment | |
2983 | variable is not defined, the default emulation depends upon how the | |
2984 | linker was configured. | |
252b5132 RH |
2985 | |
2986 | @kindex COLLECT_NO_DEMANGLE | |
2987 | @cindex demangling, default | |
2988 | Normally, the linker will default to demangling symbols. However, if | |
2989 | @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will | |
2990 | default to not demangling symbols. This environment variable is used in | |
2991 | a similar fashion by the @code{gcc} linker wrapper program. The default | |
2992 | may be overridden by the @samp{--demangle} and @samp{--no-demangle} | |
2993 | options. | |
2994 | ||
0285c67d NC |
2995 | @c man end |
2996 | @end ifset | |
2997 | ||
252b5132 RH |
2998 | @node Scripts |
2999 | @chapter Linker Scripts | |
3000 | ||
3001 | @cindex scripts | |
3002 | @cindex linker scripts | |
3003 | @cindex command files | |
3004 | Every link is controlled by a @dfn{linker script}. This script is | |
3005 | written in the linker command language. | |
3006 | ||
3007 | The main purpose of the linker script is to describe how the sections in | |
3008 | the input files should be mapped into the output file, and to control | |
3009 | the memory layout of the output file. Most linker scripts do nothing | |
3010 | more than this. However, when necessary, the linker script can also | |
3011 | direct the linker to perform many other operations, using the commands | |
3012 | described below. | |
3013 | ||
3014 | The linker always uses a linker script. If you do not supply one | |
3015 | yourself, the linker will use a default script that is compiled into the | |
3016 | linker executable. You can use the @samp{--verbose} command line option | |
3017 | to display the default linker script. Certain command line options, | |
3018 | such as @samp{-r} or @samp{-N}, will affect the default linker script. | |
3019 | ||
3020 | You may supply your own linker script by using the @samp{-T} command | |
3021 | line option. When you do this, your linker script will replace the | |
3022 | default linker script. | |
3023 | ||
3024 | You may also use linker scripts implicitly by naming them as input files | |
3025 | to the linker, as though they were files to be linked. @xref{Implicit | |
3026 | Linker Scripts}. | |
3027 | ||
3028 | @menu | |
3029 | * Basic Script Concepts:: Basic Linker Script Concepts | |
3030 | * Script Format:: Linker Script Format | |
3031 | * Simple Example:: Simple Linker Script Example | |
3032 | * Simple Commands:: Simple Linker Script Commands | |
3033 | * Assignments:: Assigning Values to Symbols | |
3034 | * SECTIONS:: SECTIONS Command | |
3035 | * MEMORY:: MEMORY Command | |
3036 | * PHDRS:: PHDRS Command | |
3037 | * VERSION:: VERSION Command | |
3038 | * Expressions:: Expressions in Linker Scripts | |
3039 | * Implicit Linker Scripts:: Implicit Linker Scripts | |
3040 | @end menu | |
3041 | ||
3042 | @node Basic Script Concepts | |
3043 | @section Basic Linker Script Concepts | |
3044 | @cindex linker script concepts | |
3045 | We need to define some basic concepts and vocabulary in order to | |
3046 | describe the linker script language. | |
3047 | ||
3048 | The linker combines input files into a single output file. The output | |
3049 | file and each input file are in a special data format known as an | |
3050 | @dfn{object file format}. Each file is called an @dfn{object file}. | |
3051 | The output file is often called an @dfn{executable}, but for our | |
3052 | purposes we will also call it an object file. Each object file has, | |
3053 | among other things, a list of @dfn{sections}. We sometimes refer to a | |
3054 | section in an input file as an @dfn{input section}; similarly, a section | |
3055 | in the output file is an @dfn{output section}. | |
3056 | ||
3057 | Each section in an object file has a name and a size. Most sections | |
3058 | also have an associated block of data, known as the @dfn{section | |
56dd11f0 | 3059 | contents}. A section may be marked as @dfn{loadable}, which means that |
252b5132 RH |
3060 | the contents should be loaded into memory when the output file is run. |
3061 | A section with no contents may be @dfn{allocatable}, which means that an | |
3062 | area in memory should be set aside, but nothing in particular should be | |
3063 | loaded there (in some cases this memory must be zeroed out). A section | |
3064 | which is neither loadable nor allocatable typically contains some sort | |
3065 | of debugging information. | |
3066 | ||
3067 | Every loadable or allocatable output section has two addresses. The | |
3068 | first is the @dfn{VMA}, or virtual memory address. This is the address | |
3069 | the section will have when the output file is run. The second is the | |
3070 | @dfn{LMA}, or load memory address. This is the address at which the | |
3071 | section will be loaded. In most cases the two addresses will be the | |
3072 | same. An example of when they might be different is when a data section | |
3073 | is loaded into ROM, and then copied into RAM when the program starts up | |
3074 | (this technique is often used to initialize global variables in a ROM | |
3075 | based system). In this case the ROM address would be the LMA, and the | |
3076 | RAM address would be the VMA. | |
3077 | ||
3078 | You can see the sections in an object file by using the @code{objdump} | |
3079 | program with the @samp{-h} option. | |
3080 | ||
3081 | Every object file also has a list of @dfn{symbols}, known as the | |
3082 | @dfn{symbol table}. A symbol may be defined or undefined. Each symbol | |
3083 | has a name, and each defined symbol has an address, among other | |
3084 | information. If you compile a C or C++ program into an object file, you | |
3085 | will get a defined symbol for every defined function and global or | |
3086 | static variable. Every undefined function or global variable which is | |
3087 | referenced in the input file will become an undefined symbol. | |
3088 | ||
3089 | You can see the symbols in an object file by using the @code{nm} | |
3090 | program, or by using the @code{objdump} program with the @samp{-t} | |
3091 | option. | |
3092 | ||
3093 | @node Script Format | |
3094 | @section Linker Script Format | |
3095 | @cindex linker script format | |
3096 | Linker scripts are text files. | |
3097 | ||
3098 | You write a linker script as a series of commands. Each command is | |
3099 | either a keyword, possibly followed by arguments, or an assignment to a | |
3100 | symbol. You may separate commands using semicolons. Whitespace is | |
3101 | generally ignored. | |
3102 | ||
3103 | Strings such as file or format names can normally be entered directly. | |
3104 | If the file name contains a character such as a comma which would | |
3105 | otherwise serve to separate file names, you may put the file name in | |
3106 | double quotes. There is no way to use a double quote character in a | |
3107 | file name. | |
3108 | ||
3109 | You may include comments in linker scripts just as in C, delimited by | |
3110 | @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent | |
3111 | to whitespace. | |
3112 | ||
3113 | @node Simple Example | |
3114 | @section Simple Linker Script Example | |
3115 | @cindex linker script example | |
3116 | @cindex example of linker script | |
3117 | Many linker scripts are fairly simple. | |
3118 | ||
3119 | The simplest possible linker script has just one command: | |
3120 | @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the | |
3121 | memory layout of the output file. | |
3122 | ||
3123 | The @samp{SECTIONS} command is a powerful command. Here we will | |
3124 | describe a simple use of it. Let's assume your program consists only of | |
3125 | code, initialized data, and uninitialized data. These will be in the | |
3126 | @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively. | |
3127 | Let's assume further that these are the only sections which appear in | |
3128 | your input files. | |
3129 | ||
3130 | For this example, let's say that the code should be loaded at address | |
3131 | 0x10000, and that the data should start at address 0x8000000. Here is a | |
3132 | linker script which will do that: | |
3133 | @smallexample | |
3134 | SECTIONS | |
3135 | @{ | |
3136 | . = 0x10000; | |
3137 | .text : @{ *(.text) @} | |
3138 | . = 0x8000000; | |
3139 | .data : @{ *(.data) @} | |
3140 | .bss : @{ *(.bss) @} | |
3141 | @} | |
3142 | @end smallexample | |
3143 | ||
3144 | You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS}, | |
3145 | followed by a series of symbol assignments and output section | |
3146 | descriptions enclosed in curly braces. | |
3147 | ||
252b5132 RH |
3148 | The first line inside the @samp{SECTIONS} command of the above example |
3149 | sets the value of the special symbol @samp{.}, which is the location | |
3150 | counter. If you do not specify the address of an output section in some | |
3151 | other way (other ways are described later), the address is set from the | |
3152 | current value of the location counter. The location counter is then | |
3153 | incremented by the size of the output section. At the start of the | |
3154 | @samp{SECTIONS} command, the location counter has the value @samp{0}. | |
3155 | ||
3156 | The second line defines an output section, @samp{.text}. The colon is | |
3157 | required syntax which may be ignored for now. Within the curly braces | |
3158 | after the output section name, you list the names of the input sections | |
3159 | which should be placed into this output section. The @samp{*} is a | |
3160 | wildcard which matches any file name. The expression @samp{*(.text)} | |
3161 | means all @samp{.text} input sections in all input files. | |
3162 | ||
3163 | Since the location counter is @samp{0x10000} when the output section | |
3164 | @samp{.text} is defined, the linker will set the address of the | |
3165 | @samp{.text} section in the output file to be @samp{0x10000}. | |
3166 | ||
3167 | The remaining lines define the @samp{.data} and @samp{.bss} sections in | |
3168 | the output file. The linker will place the @samp{.data} output section | |
3169 | at address @samp{0x8000000}. After the linker places the @samp{.data} | |
3170 | output section, the value of the location counter will be | |
3171 | @samp{0x8000000} plus the size of the @samp{.data} output section. The | |
3172 | effect is that the linker will place the @samp{.bss} output section | |
58434bc1 | 3173 | immediately after the @samp{.data} output section in memory. |
252b5132 RH |
3174 | |
3175 | The linker will ensure that each output section has the required | |
3176 | alignment, by increasing the location counter if necessary. In this | |
3177 | example, the specified addresses for the @samp{.text} and @samp{.data} | |
3178 | sections will probably satisfy any alignment constraints, but the linker | |
3179 | may have to create a small gap between the @samp{.data} and @samp{.bss} | |
3180 | sections. | |
3181 | ||
3182 | That's it! That's a simple and complete linker script. | |
3183 | ||
3184 | @node Simple Commands | |
3185 | @section Simple Linker Script Commands | |
3186 | @cindex linker script simple commands | |
3187 | In this section we describe the simple linker script commands. | |
3188 | ||
3189 | @menu | |
3190 | * Entry Point:: Setting the entry point | |
3191 | * File Commands:: Commands dealing with files | |
3192 | @ifclear SingleFormat | |
3193 | * Format Commands:: Commands dealing with object file formats | |
3194 | @end ifclear | |
3195 | ||
4a93e180 | 3196 | * REGION_ALIAS:: Assign alias names to memory regions |
252b5132 RH |
3197 | * Miscellaneous Commands:: Other linker script commands |
3198 | @end menu | |
3199 | ||
3200 | @node Entry Point | |
36f63dca | 3201 | @subsection Setting the Entry Point |
252b5132 RH |
3202 | @kindex ENTRY(@var{symbol}) |
3203 | @cindex start of execution | |
3204 | @cindex first instruction | |
3205 | @cindex entry point | |
3206 | The first instruction to execute in a program is called the @dfn{entry | |
3207 | point}. You can use the @code{ENTRY} linker script command to set the | |
3208 | entry point. The argument is a symbol name: | |
3209 | @smallexample | |
3210 | ENTRY(@var{symbol}) | |
3211 | @end smallexample | |
3212 | ||
3213 | There are several ways to set the entry point. The linker will set the | |
3214 | entry point by trying each of the following methods in order, and | |
3215 | stopping when one of them succeeds: | |
3216 | @itemize @bullet | |
a1ab1d2a | 3217 | @item |
252b5132 | 3218 | the @samp{-e} @var{entry} command-line option; |
a1ab1d2a | 3219 | @item |
252b5132 | 3220 | the @code{ENTRY(@var{symbol})} command in a linker script; |
a1ab1d2a | 3221 | @item |
3ab904c4 NC |
3222 | the value of a target specific symbol, if it is defined; For many |
3223 | targets this is @code{start}, but PE and BeOS based systems for example | |
3224 | check a list of possible entry symbols, matching the first one found. | |
a1ab1d2a | 3225 | @item |
252b5132 | 3226 | the address of the first byte of the @samp{.text} section, if present; |
a1ab1d2a | 3227 | @item |
252b5132 RH |
3228 | The address @code{0}. |
3229 | @end itemize | |
3230 | ||
3231 | @node File Commands | |
36f63dca | 3232 | @subsection Commands Dealing with Files |
252b5132 RH |
3233 | @cindex linker script file commands |
3234 | Several linker script commands deal with files. | |
3235 | ||
3236 | @table @code | |
3237 | @item INCLUDE @var{filename} | |
3238 | @kindex INCLUDE @var{filename} | |
3239 | @cindex including a linker script | |
3240 | Include the linker script @var{filename} at this point. The file will | |
3241 | be searched for in the current directory, and in any directory specified | |
ff5dcc92 | 3242 | with the @option{-L} option. You can nest calls to @code{INCLUDE} up to |
252b5132 RH |
3243 | 10 levels deep. |
3244 | ||
4006703d NS |
3245 | You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or |
3246 | @code{SECTIONS} commands, or in output section descriptions. | |
3247 | ||
252b5132 RH |
3248 | @item INPUT(@var{file}, @var{file}, @dots{}) |
3249 | @itemx INPUT(@var{file} @var{file} @dots{}) | |
3250 | @kindex INPUT(@var{files}) | |
3251 | @cindex input files in linker scripts | |
3252 | @cindex input object files in linker scripts | |
3253 | @cindex linker script input object files | |
3254 | The @code{INPUT} command directs the linker to include the named files | |
3255 | in the link, as though they were named on the command line. | |
3256 | ||
3257 | For example, if you always want to include @file{subr.o} any time you do | |
3258 | a link, but you can't be bothered to put it on every link command line, | |
3259 | then you can put @samp{INPUT (subr.o)} in your linker script. | |
3260 | ||
3261 | In fact, if you like, you can list all of your input files in the linker | |
3262 | script, and then invoke the linker with nothing but a @samp{-T} option. | |
3263 | ||
e3f2db7f AO |
3264 | In case a @dfn{sysroot prefix} is configured, and the filename starts |
3265 | with the @samp{/} character, and the script being processed was | |
3266 | located inside the @dfn{sysroot prefix}, the filename will be looked | |
3267 | for in the @dfn{sysroot prefix}. Otherwise, the linker will try to | |
3268 | open the file in the current directory. If it is not found, the | |
cad60a33 HPN |
3269 | linker will search through the archive library search path. |
3270 | The @dfn{sysroot prefix} can also be forced by specifying @code{=} | |
3271 | as the first character in the filename path. See also the | |
e3f2db7f | 3272 | description of @samp{-L} in @ref{Options,,Command Line Options}. |
252b5132 | 3273 | |
ff5dcc92 | 3274 | If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the |
252b5132 RH |
3275 | name to @code{lib@var{file}.a}, as with the command line argument |
3276 | @samp{-l}. | |
3277 | ||
3278 | When you use the @code{INPUT} command in an implicit linker script, the | |
3279 | files will be included in the link at the point at which the linker | |
3280 | script file is included. This can affect archive searching. | |
3281 | ||
3282 | @item GROUP(@var{file}, @var{file}, @dots{}) | |
3283 | @itemx GROUP(@var{file} @var{file} @dots{}) | |
3284 | @kindex GROUP(@var{files}) | |
3285 | @cindex grouping input files | |
3286 | The @code{GROUP} command is like @code{INPUT}, except that the named | |
3287 | files should all be archives, and they are searched repeatedly until no | |
3288 | new undefined references are created. See the description of @samp{-(} | |
3289 | in @ref{Options,,Command Line Options}. | |
3290 | ||
b717d30e JJ |
3291 | @item AS_NEEDED(@var{file}, @var{file}, @dots{}) |
3292 | @itemx AS_NEEDED(@var{file} @var{file} @dots{}) | |
3293 | @kindex AS_NEEDED(@var{files}) | |
3294 | This construct can appear only inside of the @code{INPUT} or @code{GROUP} | |
3295 | commands, among other filenames. The files listed will be handled | |
3296 | as if they appear directly in the @code{INPUT} or @code{GROUP} commands, | |
3297 | with the exception of ELF shared libraries, that will be added only | |
3298 | when they are actually needed. This construct essentially enables | |
3299 | @option{--as-needed} option for all the files listed inside of it | |
3300 | and restores previous @option{--as-needed} resp. @option{--no-as-needed} | |
3301 | setting afterwards. | |
3302 | ||
252b5132 RH |
3303 | @item OUTPUT(@var{filename}) |
3304 | @kindex OUTPUT(@var{filename}) | |
b45619c0 | 3305 | @cindex output file name in linker script |
252b5132 RH |
3306 | The @code{OUTPUT} command names the output file. Using |
3307 | @code{OUTPUT(@var{filename})} in the linker script is exactly like using | |
3308 | @samp{-o @var{filename}} on the command line (@pxref{Options,,Command | |
3309 | Line Options}). If both are used, the command line option takes | |
3310 | precedence. | |
3311 | ||
3312 | You can use the @code{OUTPUT} command to define a default name for the | |
3313 | output file other than the usual default of @file{a.out}. | |
3314 | ||
3315 | @item SEARCH_DIR(@var{path}) | |
3316 | @kindex SEARCH_DIR(@var{path}) | |
3317 | @cindex library search path in linker script | |
3318 | @cindex archive search path in linker script | |
3319 | @cindex search path in linker script | |
3320 | The @code{SEARCH_DIR} command adds @var{path} to the list of paths where | |
ff5dcc92 | 3321 | @command{ld} looks for archive libraries. Using |
252b5132 RH |
3322 | @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}} |
3323 | on the command line (@pxref{Options,,Command Line Options}). If both | |
3324 | are used, then the linker will search both paths. Paths specified using | |
3325 | the command line option are searched first. | |
3326 | ||
3327 | @item STARTUP(@var{filename}) | |
3328 | @kindex STARTUP(@var{filename}) | |
3329 | @cindex first input file | |
3330 | The @code{STARTUP} command is just like the @code{INPUT} command, except | |
3331 | that @var{filename} will become the first input file to be linked, as | |
3332 | though it were specified first on the command line. This may be useful | |
3333 | when using a system in which the entry point is always the start of the | |
3334 | first file. | |
3335 | @end table | |
3336 | ||
3337 | @ifclear SingleFormat | |
3338 | @node Format Commands | |
36f63dca | 3339 | @subsection Commands Dealing with Object File Formats |
252b5132 RH |
3340 | A couple of linker script commands deal with object file formats. |
3341 | ||
3342 | @table @code | |
3343 | @item OUTPUT_FORMAT(@var{bfdname}) | |
3344 | @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little}) | |
3345 | @kindex OUTPUT_FORMAT(@var{bfdname}) | |
3346 | @cindex output file format in linker script | |
3347 | The @code{OUTPUT_FORMAT} command names the BFD format to use for the | |
3348 | output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is | |
024531e2 | 3349 | exactly like using @samp{--oformat @var{bfdname}} on the command line |
252b5132 RH |
3350 | (@pxref{Options,,Command Line Options}). If both are used, the command |
3351 | line option takes precedence. | |
3352 | ||
3353 | You can use @code{OUTPUT_FORMAT} with three arguments to use different | |
3354 | formats based on the @samp{-EB} and @samp{-EL} command line options. | |
3355 | This permits the linker script to set the output format based on the | |
3356 | desired endianness. | |
3357 | ||
3358 | If neither @samp{-EB} nor @samp{-EL} are used, then the output format | |
3359 | will be the first argument, @var{default}. If @samp{-EB} is used, the | |
3360 | output format will be the second argument, @var{big}. If @samp{-EL} is | |
3361 | used, the output format will be the third argument, @var{little}. | |
3362 | ||
3363 | For example, the default linker script for the MIPS ELF target uses this | |
3364 | command: | |
3365 | @smallexample | |
3366 | OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips) | |
3367 | @end smallexample | |
3368 | This says that the default format for the output file is | |
3369 | @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line | |
3370 | option, the output file will be created in the @samp{elf32-littlemips} | |
3371 | format. | |
3372 | ||
3373 | @item TARGET(@var{bfdname}) | |
3374 | @kindex TARGET(@var{bfdname}) | |
3375 | @cindex input file format in linker script | |
3376 | The @code{TARGET} command names the BFD format to use when reading input | |
3377 | files. It affects subsequent @code{INPUT} and @code{GROUP} commands. | |
3378 | This command is like using @samp{-b @var{bfdname}} on the command line | |
3379 | (@pxref{Options,,Command Line Options}). If the @code{TARGET} command | |
3380 | is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET} | |
3381 | command is also used to set the format for the output file. @xref{BFD}. | |
3382 | @end table | |
3383 | @end ifclear | |
3384 | ||
4a93e180 NC |
3385 | @node REGION_ALIAS |
3386 | @subsection Assign alias names to memory regions | |
3387 | @kindex REGION_ALIAS(@var{alias}, @var{region}) | |
3388 | @cindex region alias | |
3389 | @cindex region names | |
3390 | ||
3391 | Alias names can be added to existing memory regions created with the | |
3392 | @ref{MEMORY} command. Each name corresponds to at most one memory region. | |
3393 | ||
3394 | @smallexample | |
3395 | REGION_ALIAS(@var{alias}, @var{region}) | |
3396 | @end smallexample | |
3397 | ||
3398 | The @code{REGION_ALIAS} function creates an alias name @var{alias} for the | |
3399 | memory region @var{region}. This allows a flexible mapping of output sections | |
3400 | to memory regions. An example follows. | |
3401 | ||
3402 | Suppose we have an application for embedded systems which come with various | |
3403 | memory storage devices. All have a general purpose, volatile memory @code{RAM} | |
3404 | that allows code execution or data storage. Some may have a read-only, | |
3405 | non-volatile memory @code{ROM} that allows code execution and read-only data | |
3406 | access. The last variant is a read-only, non-volatile memory @code{ROM2} with | |
3407 | read-only data access and no code execution capability. We have four output | |
3408 | sections: | |
3409 | ||
3410 | @itemize @bullet | |
3411 | @item | |
3412 | @code{.text} program code; | |
3413 | @item | |
3414 | @code{.rodata} read-only data; | |
3415 | @item | |
3416 | @code{.data} read-write initialized data; | |
3417 | @item | |
3418 | @code{.bss} read-write zero initialized data. | |
3419 | @end itemize | |
3420 | ||
3421 | The goal is to provide a linker command file that contains a system independent | |
3422 | part defining the output sections and a system dependent part mapping the | |
3423 | output sections to the memory regions available on the system. Our embedded | |
3424 | systems come with three different memory setups @code{A}, @code{B} and | |
3425 | @code{C}: | |
3426 | @multitable @columnfractions .25 .25 .25 .25 | |
3427 | @item Section @tab Variant A @tab Variant B @tab Variant C | |
9d5777a3 | 3428 | @item .text @tab RAM @tab ROM @tab ROM |
4a93e180 NC |
3429 | @item .rodata @tab RAM @tab ROM @tab ROM2 |
3430 | @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2 | |
3431 | @item .bss @tab RAM @tab RAM @tab RAM | |
3432 | @end multitable | |
3433 | The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is | |
3434 | loaded into region @code{ROM} or @code{ROM2} respectively. Please note that | |
3435 | the load address of the @code{.data} section starts in all three variants at | |
3436 | the end of the @code{.rodata} section. | |
3437 | ||
3438 | The base linker script that deals with the output sections follows. It | |
3439 | includes the system dependent @code{linkcmds.memory} file that describes the | |
3440 | memory layout: | |
3441 | @smallexample | |
3442 | INCLUDE linkcmds.memory | |
3443 | ||
3444 | SECTIONS | |
3445 | @{ | |
3446 | .text : | |
3447 | @{ | |
3448 | *(.text) | |
3449 | @} > REGION_TEXT | |
3450 | .rodata : | |
3451 | @{ | |
3452 | *(.rodata) | |
3453 | rodata_end = .; | |
3454 | @} > REGION_RODATA | |
3455 | .data : AT (rodata_end) | |
3456 | @{ | |
3457 | data_start = .; | |
3458 | *(.data) | |
3459 | @} > REGION_DATA | |
3460 | data_size = SIZEOF(.data); | |
3461 | data_load_start = LOADADDR(.data); | |
3462 | .bss : | |
3463 | @{ | |
3464 | *(.bss) | |
3465 | @} > REGION_BSS | |
3466 | @} | |
3467 | @end smallexample | |
3468 | ||
3469 | Now we need three different @code{linkcmds.memory} files to define memory | |
3470 | regions and alias names. The content of @code{linkcmds.memory} for the three | |
3471 | variants @code{A}, @code{B} and @code{C}: | |
3472 | @table @code | |
3473 | @item A | |
3474 | Here everything goes into the @code{RAM}. | |
3475 | @smallexample | |
3476 | MEMORY | |
3477 | @{ | |
3478 | RAM : ORIGIN = 0, LENGTH = 4M | |
3479 | @} | |
3480 | ||
3481 | REGION_ALIAS("REGION_TEXT", RAM); | |
3482 | REGION_ALIAS("REGION_RODATA", RAM); | |
3483 | REGION_ALIAS("REGION_DATA", RAM); | |
3484 | REGION_ALIAS("REGION_BSS", RAM); | |
3485 | @end smallexample | |
3486 | @item B | |
3487 | Program code and read-only data go into the @code{ROM}. Read-write data goes | |
3488 | into the @code{RAM}. An image of the initialized data is loaded into the | |
3489 | @code{ROM} and will be copied during system start into the @code{RAM}. | |
3490 | @smallexample | |
3491 | MEMORY | |
3492 | @{ | |
3493 | ROM : ORIGIN = 0, LENGTH = 3M | |
3494 | RAM : ORIGIN = 0x10000000, LENGTH = 1M | |
3495 | @} | |
3496 | ||
3497 | REGION_ALIAS("REGION_TEXT", ROM); | |
3498 | REGION_ALIAS("REGION_RODATA", ROM); | |
3499 | REGION_ALIAS("REGION_DATA", RAM); | |
3500 | REGION_ALIAS("REGION_BSS", RAM); | |
3501 | @end smallexample | |
3502 | @item C | |
3503 | Program code goes into the @code{ROM}. Read-only data goes into the | |
3504 | @code{ROM2}. Read-write data goes into the @code{RAM}. An image of the | |
3505 | initialized data is loaded into the @code{ROM2} and will be copied during | |
3506 | system start into the @code{RAM}. | |
3507 | @smallexample | |
3508 | MEMORY | |
3509 | @{ | |
3510 | ROM : ORIGIN = 0, LENGTH = 2M | |
3511 | ROM2 : ORIGIN = 0x10000000, LENGTH = 1M | |
3512 | RAM : ORIGIN = 0x20000000, LENGTH = 1M | |
3513 | @} | |
3514 | ||
3515 | REGION_ALIAS("REGION_TEXT", ROM); | |
3516 | REGION_ALIAS("REGION_RODATA", ROM2); | |
3517 | REGION_ALIAS("REGION_DATA", RAM); | |
3518 | REGION_ALIAS("REGION_BSS", RAM); | |
3519 | @end smallexample | |
3520 | @end table | |
3521 | ||
3522 | It is possible to write a common system initialization routine to copy the | |
3523 | @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if | |
3524 | necessary: | |
3525 | @smallexample | |
3526 | #include <string.h> | |
3527 | ||
3528 | extern char data_start []; | |
3529 | extern char data_size []; | |
3530 | extern char data_load_start []; | |
3531 | ||
3532 | void copy_data(void) | |
3533 | @{ | |
3534 | if (data_start != data_load_start) | |
3535 | @{ | |
3536 | memcpy(data_start, data_load_start, (size_t) data_size); | |
3537 | @} | |
3538 | @} | |
3539 | @end smallexample | |
3540 | ||
252b5132 | 3541 | @node Miscellaneous Commands |
36f63dca | 3542 | @subsection Other Linker Script Commands |
252b5132 RH |
3543 | There are a few other linker scripts commands. |
3544 | ||
3545 | @table @code | |
3546 | @item ASSERT(@var{exp}, @var{message}) | |
3547 | @kindex ASSERT | |
3548 | @cindex assertion in linker script | |
3549 | Ensure that @var{exp} is non-zero. If it is zero, then exit the linker | |
3550 | with an error code, and print @var{message}. | |
3551 | ||
fd1c4238 NC |
3552 | Note that assertions are checked before the final stages of linking |
3553 | take place. This means that expressions involving symbols PROVIDEd | |
3554 | inside section definitions will fail if the user has not set values | |
3555 | for those symbols. The only exception to this rule is PROVIDEd | |
3556 | symbols that just reference dot. Thus an assertion like this: | |
3557 | ||
3558 | @smallexample | |
3559 | .stack : | |
3560 | @{ | |
3561 | PROVIDE (__stack = .); | |
3562 | PROVIDE (__stack_size = 0x100); | |
3563 | ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack"); | |
3564 | @} | |
3565 | @end smallexample | |
3566 | ||
3567 | will fail if @code{__stack_size} is not defined elsewhere. Symbols | |
3568 | PROVIDEd outside of section definitions are evaluated earlier, so they | |
3569 | can be used inside ASSERTions. Thus: | |
3570 | ||
3571 | @smallexample | |
3572 | PROVIDE (__stack_size = 0x100); | |
3573 | .stack : | |
3574 | @{ | |
3575 | PROVIDE (__stack = .); | |
3576 | ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack"); | |
3577 | @} | |
3578 | @end smallexample | |
3579 | ||
3580 | will work. | |
3581 | ||
252b5132 RH |
3582 | @item EXTERN(@var{symbol} @var{symbol} @dots{}) |
3583 | @kindex EXTERN | |
3584 | @cindex undefined symbol in linker script | |
3585 | Force @var{symbol} to be entered in the output file as an undefined | |
3586 | symbol. Doing this may, for example, trigger linking of additional | |
3587 | modules from standard libraries. You may list several @var{symbol}s for | |
3588 | each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This | |
3589 | command has the same effect as the @samp{-u} command-line option. | |
3590 | ||
3591 | @item FORCE_COMMON_ALLOCATION | |
3592 | @kindex FORCE_COMMON_ALLOCATION | |
3593 | @cindex common allocation in linker script | |
3594 | This command has the same effect as the @samp{-d} command-line option: | |
ff5dcc92 | 3595 | to make @command{ld} assign space to common symbols even if a relocatable |
252b5132 RH |
3596 | output file is specified (@samp{-r}). |
3597 | ||
4818e05f AM |
3598 | @item INHIBIT_COMMON_ALLOCATION |
3599 | @kindex INHIBIT_COMMON_ALLOCATION | |
3600 | @cindex common allocation in linker script | |
3601 | This command has the same effect as the @samp{--no-define-common} | |
3602 | command-line option: to make @code{ld} omit the assignment of addresses | |
3603 | to common symbols even for a non-relocatable output file. | |
3604 | ||
53d25da6 AM |
3605 | @item INSERT [ AFTER | BEFORE ] @var{output_section} |
3606 | @kindex INSERT | |
3607 | @cindex insert user script into default script | |
3608 | This command is typically used in a script specified by @samp{-T} to | |
3609 | augment the default @code{SECTIONS} with, for example, overlays. It | |
3610 | inserts all prior linker script statements after (or before) | |
3611 | @var{output_section}, and also causes @samp{-T} to not override the | |
3612 | default linker script. The exact insertion point is as for orphan | |
3613 | sections. @xref{Location Counter}. The insertion happens after the | |
3614 | linker has mapped input sections to output sections. Prior to the | |
3615 | insertion, since @samp{-T} scripts are parsed before the default | |
3616 | linker script, statements in the @samp{-T} script occur before the | |
3617 | default linker script statements in the internal linker representation | |
3618 | of the script. In particular, input section assignments will be made | |
3619 | to @samp{-T} output sections before those in the default script. Here | |
3620 | is an example of how a @samp{-T} script using @code{INSERT} might look: | |
3621 | ||
3622 | @smallexample | |
3623 | SECTIONS | |
3624 | @{ | |
3625 | OVERLAY : | |
3626 | @{ | |
3627 | .ov1 @{ ov1*(.text) @} | |
3628 | .ov2 @{ ov2*(.text) @} | |
3629 | @} | |
3630 | @} | |
3631 | INSERT AFTER .text; | |
3632 | @end smallexample | |
3633 | ||
252b5132 RH |
3634 | @item NOCROSSREFS(@var{section} @var{section} @dots{}) |
3635 | @kindex NOCROSSREFS(@var{sections}) | |
3636 | @cindex cross references | |
ff5dcc92 | 3637 | This command may be used to tell @command{ld} to issue an error about any |
252b5132 RH |
3638 | references among certain output sections. |
3639 | ||
3640 | In certain types of programs, particularly on embedded systems when | |
3641 | using overlays, when one section is loaded into memory, another section | |
3642 | will not be. Any direct references between the two sections would be | |
3643 | errors. For example, it would be an error if code in one section called | |
3644 | a function defined in the other section. | |
3645 | ||
3646 | The @code{NOCROSSREFS} command takes a list of output section names. If | |
ff5dcc92 | 3647 | @command{ld} detects any cross references between the sections, it reports |
252b5132 RH |
3648 | an error and returns a non-zero exit status. Note that the |
3649 | @code{NOCROSSREFS} command uses output section names, not input section | |
3650 | names. | |
3651 | ||
3652 | @ifclear SingleFormat | |
3653 | @item OUTPUT_ARCH(@var{bfdarch}) | |
3654 | @kindex OUTPUT_ARCH(@var{bfdarch}) | |
3655 | @cindex machine architecture | |
3656 | @cindex architecture | |
3657 | Specify a particular output machine architecture. The argument is one | |
3658 | of the names used by the BFD library (@pxref{BFD}). You can see the | |
3659 | architecture of an object file by using the @code{objdump} program with | |
3660 | the @samp{-f} option. | |
3661 | @end ifclear | |
01554a74 AM |
3662 | |
3663 | @item LD_FEATURE(@var{string}) | |
3664 | @kindex LD_FEATURE(@var{string}) | |
3665 | This command may be used to modify @command{ld} behavior. If | |
3666 | @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers | |
3667 | in a script are simply treated as numbers everywhere. | |
3668 | @xref{Expression Section}. | |
252b5132 RH |
3669 | @end table |
3670 | ||
3671 | @node Assignments | |
3672 | @section Assigning Values to Symbols | |
3673 | @cindex assignment in scripts | |
3674 | @cindex symbol definition, scripts | |
3675 | @cindex variables, defining | |
3676 | You may assign a value to a symbol in a linker script. This will define | |
73ae6183 | 3677 | the symbol and place it into the symbol table with a global scope. |
252b5132 RH |
3678 | |
3679 | @menu | |
3680 | * Simple Assignments:: Simple Assignments | |
eb8476a6 | 3681 | * HIDDEN:: HIDDEN |
252b5132 | 3682 | * PROVIDE:: PROVIDE |
7af8e998 | 3683 | * PROVIDE_HIDDEN:: PROVIDE_HIDDEN |
73ae6183 | 3684 | * Source Code Reference:: How to use a linker script defined symbol in source code |
252b5132 RH |
3685 | @end menu |
3686 | ||
3687 | @node Simple Assignments | |
3688 | @subsection Simple Assignments | |
3689 | ||
3690 | You may assign to a symbol using any of the C assignment operators: | |
3691 | ||
3692 | @table @code | |
3693 | @item @var{symbol} = @var{expression} ; | |
3694 | @itemx @var{symbol} += @var{expression} ; | |
3695 | @itemx @var{symbol} -= @var{expression} ; | |
3696 | @itemx @var{symbol} *= @var{expression} ; | |
3697 | @itemx @var{symbol} /= @var{expression} ; | |
3698 | @itemx @var{symbol} <<= @var{expression} ; | |
3699 | @itemx @var{symbol} >>= @var{expression} ; | |
3700 | @itemx @var{symbol} &= @var{expression} ; | |
3701 | @itemx @var{symbol} |= @var{expression} ; | |
3702 | @end table | |
3703 | ||
3704 | The first case will define @var{symbol} to the value of | |
3705 | @var{expression}. In the other cases, @var{symbol} must already be | |
3706 | defined, and the value will be adjusted accordingly. | |
3707 | ||
3708 | The special symbol name @samp{.} indicates the location counter. You | |
b5666f2f | 3709 | may only use this within a @code{SECTIONS} command. @xref{Location Counter}. |
252b5132 RH |
3710 | |
3711 | The semicolon after @var{expression} is required. | |
3712 | ||
3713 | Expressions are defined below; see @ref{Expressions}. | |
3714 | ||
3715 | You may write symbol assignments as commands in their own right, or as | |
3716 | statements within a @code{SECTIONS} command, or as part of an output | |
3717 | section description in a @code{SECTIONS} command. | |
3718 | ||
3719 | The section of the symbol will be set from the section of the | |
3720 | expression; for more information, see @ref{Expression Section}. | |
3721 | ||
3722 | Here is an example showing the three different places that symbol | |
3723 | assignments may be used: | |
3724 | ||
3725 | @smallexample | |
3726 | floating_point = 0; | |
3727 | SECTIONS | |
3728 | @{ | |
3729 | .text : | |
3730 | @{ | |
3731 | *(.text) | |
3732 | _etext = .; | |
3733 | @} | |
156e34dd | 3734 | _bdata = (. + 3) & ~ 3; |
252b5132 RH |
3735 | .data : @{ *(.data) @} |
3736 | @} | |
3737 | @end smallexample | |
3738 | @noindent | |
3739 | In this example, the symbol @samp{floating_point} will be defined as | |
3740 | zero. The symbol @samp{_etext} will be defined as the address following | |
3741 | the last @samp{.text} input section. The symbol @samp{_bdata} will be | |
3742 | defined as the address following the @samp{.text} output section aligned | |
3743 | upward to a 4 byte boundary. | |
3744 | ||
eb8476a6 MR |
3745 | @node HIDDEN |
3746 | @subsection HIDDEN | |
3747 | @cindex HIDDEN | |
3748 | For ELF targeted ports, define a symbol that will be hidden and won't be | |
3749 | exported. The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}. | |
3750 | ||
3751 | Here is the example from @ref{Simple Assignments}, rewritten to use | |
3752 | @code{HIDDEN}: | |
3753 | ||
3754 | @smallexample | |
3755 | HIDDEN(floating_point = 0); | |
3756 | SECTIONS | |
3757 | @{ | |
3758 | .text : | |
3759 | @{ | |
3760 | *(.text) | |
3761 | HIDDEN(_etext = .); | |
3762 | @} | |
3763 | HIDDEN(_bdata = (. + 3) & ~ 3); | |
3764 | .data : @{ *(.data) @} | |
3765 | @} | |
3766 | @end smallexample | |
3767 | @noindent | |
3768 | In this case none of the three symbols will be visible outside this module. | |
3769 | ||
252b5132 RH |
3770 | @node PROVIDE |
3771 | @subsection PROVIDE | |
3772 | @cindex PROVIDE | |
3773 | In some cases, it is desirable for a linker script to define a symbol | |
3774 | only if it is referenced and is not defined by any object included in | |
3775 | the link. For example, traditional linkers defined the symbol | |
3776 | @samp{etext}. However, ANSI C requires that the user be able to use | |
3777 | @samp{etext} as a function name without encountering an error. The | |
3778 | @code{PROVIDE} keyword may be used to define a symbol, such as | |
3779 | @samp{etext}, only if it is referenced but not defined. The syntax is | |
3780 | @code{PROVIDE(@var{symbol} = @var{expression})}. | |
3781 | ||
3782 | Here is an example of using @code{PROVIDE} to define @samp{etext}: | |
3783 | @smallexample | |
3784 | SECTIONS | |
3785 | @{ | |
3786 | .text : | |
3787 | @{ | |
3788 | *(.text) | |
3789 | _etext = .; | |
3790 | PROVIDE(etext = .); | |
3791 | @} | |
3792 | @} | |
3793 | @end smallexample | |
3794 | ||
3795 | In this example, if the program defines @samp{_etext} (with a leading | |
3796 | underscore), the linker will give a multiple definition error. If, on | |
3797 | the other hand, the program defines @samp{etext} (with no leading | |
3798 | underscore), the linker will silently use the definition in the program. | |
3799 | If the program references @samp{etext} but does not define it, the | |
3800 | linker will use the definition in the linker script. | |
3801 | ||
7af8e998 L |
3802 | @node PROVIDE_HIDDEN |
3803 | @subsection PROVIDE_HIDDEN | |
3804 | @cindex PROVIDE_HIDDEN | |
3805 | Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be | |
3806 | hidden and won't be exported. | |
3807 | ||
73ae6183 NC |
3808 | @node Source Code Reference |
3809 | @subsection Source Code Reference | |
3810 | ||
3811 | Accessing a linker script defined variable from source code is not | |
3812 | intuitive. In particular a linker script symbol is not equivalent to | |
3813 | a variable declaration in a high level language, it is instead a | |
3814 | symbol that does not have a value. | |
3815 | ||
3816 | Before going further, it is important to note that compilers often | |
3817 | transform names in the source code into different names when they are | |
3818 | stored in the symbol table. For example, Fortran compilers commonly | |
3819 | prepend or append an underscore, and C++ performs extensive @samp{name | |
3820 | mangling}. Therefore there might be a discrepancy between the name | |
3821 | of a variable as it is used in source code and the name of the same | |
3822 | variable as it is defined in a linker script. For example in C a | |
3823 | linker script variable might be referred to as: | |
3824 | ||
3825 | @smallexample | |
3826 | extern int foo; | |
3827 | @end smallexample | |
3828 | ||
3829 | But in the linker script it might be defined as: | |
3830 | ||
3831 | @smallexample | |
3832 | _foo = 1000; | |
3833 | @end smallexample | |
3834 | ||
3835 | In the remaining examples however it is assumed that no name | |
3836 | transformation has taken place. | |
3837 | ||
3838 | When a symbol is declared in a high level language such as C, two | |
3839 | things happen. The first is that the compiler reserves enough space | |
3840 | in the program's memory to hold the @emph{value} of the symbol. The | |
3841 | second is that the compiler creates an entry in the program's symbol | |
3842 | table which holds the symbol's @emph{address}. ie the symbol table | |
3843 | contains the address of the block of memory holding the symbol's | |
3844 | value. So for example the following C declaration, at file scope: | |
3845 | ||
3846 | @smallexample | |
3847 | int foo = 1000; | |
3848 | @end smallexample | |
3849 | ||
10bf6894 | 3850 | creates an entry called @samp{foo} in the symbol table. This entry |
73ae6183 NC |
3851 | holds the address of an @samp{int} sized block of memory where the |
3852 | number 1000 is initially stored. | |
3853 | ||
3854 | When a program references a symbol the compiler generates code that | |
3855 | first accesses the symbol table to find the address of the symbol's | |
3856 | memory block and then code to read the value from that memory block. | |
3857 | So: | |
3858 | ||
3859 | @smallexample | |
3860 | foo = 1; | |
3861 | @end smallexample | |
3862 | ||
3863 | looks up the symbol @samp{foo} in the symbol table, gets the address | |
3864 | associated with this symbol and then writes the value 1 into that | |
3865 | address. Whereas: | |
3866 | ||
3867 | @smallexample | |
3868 | int * a = & foo; | |
3869 | @end smallexample | |
3870 | ||
10bf6894 | 3871 | looks up the symbol @samp{foo} in the symbol table, gets its address |
73ae6183 NC |
3872 | and then copies this address into the block of memory associated with |
3873 | the variable @samp{a}. | |
3874 | ||
3875 | Linker scripts symbol declarations, by contrast, create an entry in | |
3876 | the symbol table but do not assign any memory to them. Thus they are | |
3877 | an address without a value. So for example the linker script definition: | |
3878 | ||
3879 | @smallexample | |
3880 | foo = 1000; | |
3881 | @end smallexample | |
3882 | ||
3883 | creates an entry in the symbol table called @samp{foo} which holds | |
3884 | the address of memory location 1000, but nothing special is stored at | |
3885 | address 1000. This means that you cannot access the @emph{value} of a | |
3886 | linker script defined symbol - it has no value - all you can do is | |
3887 | access the @emph{address} of a linker script defined symbol. | |
3888 | ||
3889 | Hence when you are using a linker script defined symbol in source code | |
3890 | you should always take the address of the symbol, and never attempt to | |
3891 | use its value. For example suppose you want to copy the contents of a | |
3892 | section of memory called .ROM into a section called .FLASH and the | |
3893 | linker script contains these declarations: | |
3894 | ||
3895 | @smallexample | |
3896 | @group | |
3897 | start_of_ROM = .ROM; | |
a5e406b5 | 3898 | end_of_ROM = .ROM + sizeof (.ROM); |
73ae6183 NC |
3899 | start_of_FLASH = .FLASH; |
3900 | @end group | |
3901 | @end smallexample | |
3902 | ||
3903 | Then the C source code to perform the copy would be: | |
3904 | ||
3905 | @smallexample | |
3906 | @group | |
3907 | extern char start_of_ROM, end_of_ROM, start_of_FLASH; | |
c0065db7 | 3908 | |
73ae6183 NC |
3909 | memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM); |
3910 | @end group | |
3911 | @end smallexample | |
3912 | ||
3913 | Note the use of the @samp{&} operators. These are correct. | |
5707d2ad NC |
3914 | Alternatively the symbols can be treated as the names of vectors or |
3915 | arrays and then the code will again work as expected: | |
3916 | ||
3917 | @smallexample | |
3918 | @group | |
3919 | extern char start_of_ROM[], end_of_ROM[], start_of_FLASH[]; | |
3920 | ||
3921 | memcpy (start_of_FLASH, start_of_ROM, end_of_ROM - start_of_ROM); | |
3922 | @end group | |
3923 | @end smallexample | |
3924 | ||
3925 | Note how using this method does not require the use of @samp{&} | |
3926 | operators. | |
73ae6183 | 3927 | |
252b5132 | 3928 | @node SECTIONS |
36f63dca | 3929 | @section SECTIONS Command |
252b5132 RH |
3930 | @kindex SECTIONS |
3931 | The @code{SECTIONS} command tells the linker how to map input sections | |
3932 | into output sections, and how to place the output sections in memory. | |
3933 | ||
3934 | The format of the @code{SECTIONS} command is: | |
3935 | @smallexample | |
3936 | SECTIONS | |
3937 | @{ | |
3938 | @var{sections-command} | |
3939 | @var{sections-command} | |
3940 | @dots{} | |
3941 | @} | |
3942 | @end smallexample | |
3943 | ||
3944 | Each @var{sections-command} may of be one of the following: | |
3945 | ||
3946 | @itemize @bullet | |
3947 | @item | |
3948 | an @code{ENTRY} command (@pxref{Entry Point,,Entry command}) | |
3949 | @item | |
3950 | a symbol assignment (@pxref{Assignments}) | |
3951 | @item | |
3952 | an output section description | |
3953 | @item | |
3954 | an overlay description | |
3955 | @end itemize | |
3956 | ||
3957 | The @code{ENTRY} command and symbol assignments are permitted inside the | |
3958 | @code{SECTIONS} command for convenience in using the location counter in | |
3959 | those commands. This can also make the linker script easier to | |
3960 | understand because you can use those commands at meaningful points in | |
3961 | the layout of the output file. | |
3962 | ||
3963 | Output section descriptions and overlay descriptions are described | |
3964 | below. | |
3965 | ||
3966 | If you do not use a @code{SECTIONS} command in your linker script, the | |
3967 | linker will place each input section into an identically named output | |
3968 | section in the order that the sections are first encountered in the | |
3969 | input files. If all input sections are present in the first file, for | |
3970 | example, the order of sections in the output file will match the order | |
3971 | in the first input file. The first section will be at address zero. | |
3972 | ||
3973 | @menu | |
3974 | * Output Section Description:: Output section description | |
3975 | * Output Section Name:: Output section name | |
3976 | * Output Section Address:: Output section address | |
3977 | * Input Section:: Input section description | |
3978 | * Output Section Data:: Output section data | |
3979 | * Output Section Keywords:: Output section keywords | |
3980 | * Output Section Discarding:: Output section discarding | |
3981 | * Output Section Attributes:: Output section attributes | |
3982 | * Overlay Description:: Overlay description | |
3983 | @end menu | |
3984 | ||
3985 | @node Output Section Description | |
36f63dca | 3986 | @subsection Output Section Description |
252b5132 RH |
3987 | The full description of an output section looks like this: |
3988 | @smallexample | |
a1ab1d2a | 3989 | @group |
7e7d5768 | 3990 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 | 3991 | [AT(@var{lma})] |
1eec346e | 3992 | [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT] |
0c71d759 NC |
3993 | [SUBALIGN(@var{subsection_align})] |
3994 | [@var{constraint}] | |
252b5132 RH |
3995 | @{ |
3996 | @var{output-section-command} | |
3997 | @var{output-section-command} | |
3998 | @dots{} | |
abc9061b | 3999 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] [,] |
252b5132 RH |
4000 | @end group |
4001 | @end smallexample | |
4002 | ||
4003 | Most output sections do not use most of the optional section attributes. | |
4004 | ||
4005 | The whitespace around @var{section} is required, so that the section | |
4006 | name is unambiguous. The colon and the curly braces are also required. | |
abc9061b CC |
4007 | The comma at the end may be required if a @var{fillexp} is used and |
4008 | the next @var{sections-command} looks like a continuation of the expression. | |
252b5132 RH |
4009 | The line breaks and other white space are optional. |
4010 | ||
4011 | Each @var{output-section-command} may be one of the following: | |
4012 | ||
4013 | @itemize @bullet | |
4014 | @item | |
4015 | a symbol assignment (@pxref{Assignments}) | |
4016 | @item | |
4017 | an input section description (@pxref{Input Section}) | |
4018 | @item | |
4019 | data values to include directly (@pxref{Output Section Data}) | |
4020 | @item | |
4021 | a special output section keyword (@pxref{Output Section Keywords}) | |
4022 | @end itemize | |
4023 | ||
4024 | @node Output Section Name | |
36f63dca | 4025 | @subsection Output Section Name |
252b5132 RH |
4026 | @cindex name, section |
4027 | @cindex section name | |
4028 | The name of the output section is @var{section}. @var{section} must | |
4029 | meet the constraints of your output format. In formats which only | |
4030 | support a limited number of sections, such as @code{a.out}, the name | |
4031 | must be one of the names supported by the format (@code{a.out}, for | |
4032 | example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the | |
4033 | output format supports any number of sections, but with numbers and not | |
4034 | names (as is the case for Oasys), the name should be supplied as a | |
4035 | quoted numeric string. A section name may consist of any sequence of | |
4036 | characters, but a name which contains any unusual characters such as | |
4037 | commas must be quoted. | |
4038 | ||
4039 | The output section name @samp{/DISCARD/} is special; @ref{Output Section | |
4040 | Discarding}. | |
4041 | ||
4042 | @node Output Section Address | |
2a16d82a | 4043 | @subsection Output Section Address |
252b5132 RH |
4044 | @cindex address, section |
4045 | @cindex section address | |
4046 | The @var{address} is an expression for the VMA (the virtual memory | |
ea5cae92 NC |
4047 | address) of the output section. This address is optional, but if it |
4048 | is provided then the output address will be set exactly as specified. | |
4049 | ||
4050 | If the output address is not specified then one will be chosen for the | |
4051 | section, based on the heuristic below. This address will be adjusted | |
4052 | to fit the alignment requirement of the output section. The | |
4053 | alignment requirement is the strictest alignment of any input section | |
4054 | contained within the output section. | |
4055 | ||
4056 | The output section address heuristic is as follows: | |
4057 | ||
4058 | @itemize @bullet | |
4059 | @item | |
4060 | If an output memory @var{region} is set for the section then it | |
4061 | is added to this region and its address will be the next free address | |
4062 | in that region. | |
4063 | ||
4064 | @item | |
4065 | If the MEMORY command has been used to create a list of memory | |
4066 | regions then the first region which has attributes compatible with the | |
4067 | section is selected to contain it. The section's output address will | |
4068 | be the next free address in that region; @ref{MEMORY}. | |
4069 | ||
4070 | @item | |
4071 | If no memory regions were specified, or none match the section then | |
4072 | the output address will be based on the current value of the location | |
4073 | counter. | |
4074 | @end itemize | |
4075 | ||
4076 | @noindent | |
4077 | For example: | |
4078 | ||
252b5132 RH |
4079 | @smallexample |
4080 | .text . : @{ *(.text) @} | |
4081 | @end smallexample | |
ea5cae92 | 4082 | |
252b5132 RH |
4083 | @noindent |
4084 | and | |
ea5cae92 | 4085 | |
252b5132 RH |
4086 | @smallexample |
4087 | .text : @{ *(.text) @} | |
4088 | @end smallexample | |
ea5cae92 | 4089 | |
252b5132 RH |
4090 | @noindent |
4091 | are subtly different. The first will set the address of the | |
4092 | @samp{.text} output section to the current value of the location | |
4093 | counter. The second will set it to the current value of the location | |
ea5cae92 NC |
4094 | counter aligned to the strictest alignment of any of the @samp{.text} |
4095 | input sections. | |
252b5132 RH |
4096 | |
4097 | The @var{address} may be an arbitrary expression; @ref{Expressions}. | |
4098 | For example, if you want to align the section on a 0x10 byte boundary, | |
4099 | so that the lowest four bits of the section address are zero, you could | |
4100 | do something like this: | |
4101 | @smallexample | |
4102 | .text ALIGN(0x10) : @{ *(.text) @} | |
4103 | @end smallexample | |
4104 | @noindent | |
4105 | This works because @code{ALIGN} returns the current location counter | |
4106 | aligned upward to the specified value. | |
4107 | ||
4108 | Specifying @var{address} for a section will change the value of the | |
6ce340f1 NC |
4109 | location counter, provided that the section is non-empty. (Empty |
4110 | sections are ignored). | |
252b5132 RH |
4111 | |
4112 | @node Input Section | |
36f63dca | 4113 | @subsection Input Section Description |
252b5132 RH |
4114 | @cindex input sections |
4115 | @cindex mapping input sections to output sections | |
4116 | The most common output section command is an input section description. | |
4117 | ||
4118 | The input section description is the most basic linker script operation. | |
4119 | You use output sections to tell the linker how to lay out your program | |
4120 | in memory. You use input section descriptions to tell the linker how to | |
4121 | map the input files into your memory layout. | |
4122 | ||
4123 | @menu | |
4124 | * Input Section Basics:: Input section basics | |
4125 | * Input Section Wildcards:: Input section wildcard patterns | |
4126 | * Input Section Common:: Input section for common symbols | |
4127 | * Input Section Keep:: Input section and garbage collection | |
4128 | * Input Section Example:: Input section example | |
4129 | @end menu | |
4130 | ||
4131 | @node Input Section Basics | |
36f63dca | 4132 | @subsubsection Input Section Basics |
252b5132 RH |
4133 | @cindex input section basics |
4134 | An input section description consists of a file name optionally followed | |
4135 | by a list of section names in parentheses. | |
4136 | ||
4137 | The file name and the section name may be wildcard patterns, which we | |
4138 | describe further below (@pxref{Input Section Wildcards}). | |
4139 | ||
4140 | The most common input section description is to include all input | |
4141 | sections with a particular name in the output section. For example, to | |
4142 | include all input @samp{.text} sections, you would write: | |
4143 | @smallexample | |
4144 | *(.text) | |
4145 | @end smallexample | |
4146 | @noindent | |
18625d54 CM |
4147 | Here the @samp{*} is a wildcard which matches any file name. To exclude a list |
4148 | of files from matching the file name wildcard, EXCLUDE_FILE may be used to | |
4149 | match all files except the ones specified in the EXCLUDE_FILE list. For | |
4150 | example: | |
252b5132 | 4151 | @smallexample |
b4346c09 | 4152 | *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors) |
252b5132 | 4153 | @end smallexample |
765b7cbe JB |
4154 | will cause all .ctors sections from all files except @file{crtend.o} and |
4155 | @file{otherfile.o} to be included. | |
252b5132 RH |
4156 | |
4157 | There are two ways to include more than one section: | |
4158 | @smallexample | |
4159 | *(.text .rdata) | |
4160 | *(.text) *(.rdata) | |
4161 | @end smallexample | |
4162 | @noindent | |
4163 | The difference between these is the order in which the @samp{.text} and | |
4164 | @samp{.rdata} input sections will appear in the output section. In the | |
b6bf44ba AM |
4165 | first example, they will be intermingled, appearing in the same order as |
4166 | they are found in the linker input. In the second example, all | |
252b5132 RH |
4167 | @samp{.text} input sections will appear first, followed by all |
4168 | @samp{.rdata} input sections. | |
4169 | ||
4170 | You can specify a file name to include sections from a particular file. | |
4171 | You would do this if one or more of your files contain special data that | |
4172 | needs to be at a particular location in memory. For example: | |
4173 | @smallexample | |
4174 | data.o(.data) | |
4175 | @end smallexample | |
4176 | ||
ae17ab41 CM |
4177 | To refine the sections that are included based on the section flags |
4178 | of an input section, INPUT_SECTION_FLAGS may be used. | |
4179 | ||
4180 | Here is a simple example for using Section header flags for ELF sections: | |
4181 | ||
4182 | @smallexample | |
4183 | @group | |
4184 | SECTIONS @{ | |
4185 | .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @} | |
4186 | .text2 : @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @} | |
4187 | @} | |
4188 | @end group | |
4189 | @end smallexample | |
4190 | ||
4191 | In this example, the output section @samp{.text} will be comprised of any | |
4192 | input section matching the name *(.text) whose section header flags | |
4193 | @code{SHF_MERGE} and @code{SHF_STRINGS} are set. The output section | |
4194 | @samp{.text2} will be comprised of any input section matching the name *(.text) | |
4195 | whose section header flag @code{SHF_WRITE} is clear. | |
4196 | ||
967928e9 AM |
4197 | You can also specify files within archives by writing a pattern |
4198 | matching the archive, a colon, then the pattern matching the file, | |
4199 | with no whitespace around the colon. | |
4200 | ||
4201 | @table @samp | |
4202 | @item archive:file | |
4203 | matches file within archive | |
4204 | @item archive: | |
4205 | matches the whole archive | |
4206 | @item :file | |
4207 | matches file but not one in an archive | |
4208 | @end table | |
4209 | ||
4210 | Either one or both of @samp{archive} and @samp{file} can contain shell | |
4211 | wildcards. On DOS based file systems, the linker will assume that a | |
4212 | single letter followed by a colon is a drive specifier, so | |
4213 | @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o} | |
4214 | within an archive called @samp{c}. @samp{archive:file} filespecs may | |
4215 | also be used within an @code{EXCLUDE_FILE} list, but may not appear in | |
4216 | other linker script contexts. For instance, you cannot extract a file | |
4217 | from an archive by using @samp{archive:file} in an @code{INPUT} | |
4218 | command. | |
4219 | ||
252b5132 RH |
4220 | If you use a file name without a list of sections, then all sections in |
4221 | the input file will be included in the output section. This is not | |
4222 | commonly done, but it may by useful on occasion. For example: | |
4223 | @smallexample | |
4224 | data.o | |
4225 | @end smallexample | |
4226 | ||
967928e9 AM |
4227 | When you use a file name which is not an @samp{archive:file} specifier |
4228 | and does not contain any wild card | |
252b5132 RH |
4229 | characters, the linker will first see if you also specified the file |
4230 | name on the linker command line or in an @code{INPUT} command. If you | |
4231 | did not, the linker will attempt to open the file as an input file, as | |
4232 | though it appeared on the command line. Note that this differs from an | |
4233 | @code{INPUT} command, because the linker will not search for the file in | |
4234 | the archive search path. | |
4235 | ||
4236 | @node Input Section Wildcards | |
36f63dca | 4237 | @subsubsection Input Section Wildcard Patterns |
252b5132 RH |
4238 | @cindex input section wildcards |
4239 | @cindex wildcard file name patterns | |
4240 | @cindex file name wildcard patterns | |
4241 | @cindex section name wildcard patterns | |
4242 | In an input section description, either the file name or the section | |
4243 | name or both may be wildcard patterns. | |
4244 | ||
4245 | The file name of @samp{*} seen in many examples is a simple wildcard | |
4246 | pattern for the file name. | |
4247 | ||
4248 | The wildcard patterns are like those used by the Unix shell. | |
4249 | ||
4250 | @table @samp | |
4251 | @item * | |
4252 | matches any number of characters | |
4253 | @item ? | |
4254 | matches any single character | |
4255 | @item [@var{chars}] | |
4256 | matches a single instance of any of the @var{chars}; the @samp{-} | |
4257 | character may be used to specify a range of characters, as in | |
4258 | @samp{[a-z]} to match any lower case letter | |
4259 | @item \ | |
4260 | quotes the following character | |
4261 | @end table | |
4262 | ||
4263 | When a file name is matched with a wildcard, the wildcard characters | |
4264 | will not match a @samp{/} character (used to separate directory names on | |
4265 | Unix). A pattern consisting of a single @samp{*} character is an | |
4266 | exception; it will always match any file name, whether it contains a | |
4267 | @samp{/} or not. In a section name, the wildcard characters will match | |
4268 | a @samp{/} character. | |
4269 | ||
4270 | File name wildcard patterns only match files which are explicitly | |
4271 | specified on the command line or in an @code{INPUT} command. The linker | |
4272 | does not search directories to expand wildcards. | |
4273 | ||
4274 | If a file name matches more than one wildcard pattern, or if a file name | |
4275 | appears explicitly and is also matched by a wildcard pattern, the linker | |
4276 | will use the first match in the linker script. For example, this | |
4277 | sequence of input section descriptions is probably in error, because the | |
4278 | @file{data.o} rule will not be used: | |
4279 | @smallexample | |
4280 | .data : @{ *(.data) @} | |
4281 | .data1 : @{ data.o(.data) @} | |
4282 | @end smallexample | |
4283 | ||
bcaa7b3e | 4284 | @cindex SORT_BY_NAME |
252b5132 RH |
4285 | Normally, the linker will place files and sections matched by wildcards |
4286 | in the order in which they are seen during the link. You can change | |
bcaa7b3e L |
4287 | this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard |
4288 | pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the | |
4289 | @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections | |
252b5132 RH |
4290 | into ascending order by name before placing them in the output file. |
4291 | ||
bcaa7b3e L |
4292 | @cindex SORT_BY_ALIGNMENT |
4293 | @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The | |
4294 | difference is @code{SORT_BY_ALIGNMENT} will sort sections into | |
1ae5c3ae | 4295 | descending order by alignment before placing them in the output file. |
ee83b8a6 NC |
4296 | Larger alignments are placed before smaller alignments in order to |
4297 | reduce the amount of padding necessary. | |
bcaa7b3e | 4298 | |
02ecc8e9 L |
4299 | @cindex SORT_BY_INIT_PRIORITY |
4300 | @code{SORT_BY_INIT_PRIORITY} is very similar to @code{SORT_BY_NAME}. The | |
4301 | difference is @code{SORT_BY_INIT_PRIORITY} will sort sections into | |
4302 | ascending order by numerical value of the GCC init_priority attribute | |
4303 | encoded in the section name before placing them in the output file. | |
4304 | ||
bcaa7b3e L |
4305 | @cindex SORT |
4306 | @code{SORT} is an alias for @code{SORT_BY_NAME}. | |
4307 | ||
4308 | When there are nested section sorting commands in linker script, there | |
4309 | can be at most 1 level of nesting for section sorting commands. | |
4310 | ||
4311 | @enumerate | |
4312 | @item | |
4313 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
1ae5c3ae | 4314 | It will sort the input sections by name first, then by alignment if two |
bcaa7b3e L |
4315 | sections have the same name. |
4316 | @item | |
4317 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
1ae5c3ae | 4318 | It will sort the input sections by alignment first, then by name if two |
bcaa7b3e L |
4319 | sections have the same alignment. |
4320 | @item | |
c0065db7 | 4321 | @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is |
bcaa7b3e L |
4322 | treated the same as @code{SORT_BY_NAME} (wildcard section pattern). |
4323 | @item | |
4324 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)) | |
4325 | is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern). | |
4326 | @item | |
4327 | All other nested section sorting commands are invalid. | |
4328 | @end enumerate | |
4329 | ||
4330 | When both command line section sorting option and linker script | |
4331 | section sorting command are used, section sorting command always | |
4332 | takes precedence over the command line option. | |
4333 | ||
4334 | If the section sorting command in linker script isn't nested, the | |
4335 | command line option will make the section sorting command to be | |
4336 | treated as nested sorting command. | |
4337 | ||
4338 | @enumerate | |
4339 | @item | |
4340 | @code{SORT_BY_NAME} (wildcard section pattern ) with | |
4341 | @option{--sort-sections alignment} is equivalent to | |
4342 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
4343 | @item | |
4344 | @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with | |
4345 | @option{--sort-section name} is equivalent to | |
4346 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
4347 | @end enumerate | |
4348 | ||
4349 | If the section sorting command in linker script is nested, the | |
4350 | command line option will be ignored. | |
4351 | ||
eda680f8 L |
4352 | @cindex SORT_NONE |
4353 | @code{SORT_NONE} disables section sorting by ignoring the command line | |
4354 | section sorting option. | |
4355 | ||
252b5132 RH |
4356 | If you ever get confused about where input sections are going, use the |
4357 | @samp{-M} linker option to generate a map file. The map file shows | |
4358 | precisely how input sections are mapped to output sections. | |
4359 | ||
4360 | This example shows how wildcard patterns might be used to partition | |
4361 | files. This linker script directs the linker to place all @samp{.text} | |
4362 | sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}. | |
4363 | The linker will place the @samp{.data} section from all files beginning | |
4364 | with an upper case character in @samp{.DATA}; for all other files, the | |
4365 | linker will place the @samp{.data} section in @samp{.data}. | |
4366 | @smallexample | |
4367 | @group | |
4368 | SECTIONS @{ | |
4369 | .text : @{ *(.text) @} | |
4370 | .DATA : @{ [A-Z]*(.data) @} | |
4371 | .data : @{ *(.data) @} | |
4372 | .bss : @{ *(.bss) @} | |
4373 | @} | |
4374 | @end group | |
4375 | @end smallexample | |
4376 | ||
4377 | @node Input Section Common | |
36f63dca | 4378 | @subsubsection Input Section for Common Symbols |
252b5132 RH |
4379 | @cindex common symbol placement |
4380 | @cindex uninitialized data placement | |
4381 | A special notation is needed for common symbols, because in many object | |
4382 | file formats common symbols do not have a particular input section. The | |
4383 | linker treats common symbols as though they are in an input section | |
4384 | named @samp{COMMON}. | |
4385 | ||
4386 | You may use file names with the @samp{COMMON} section just as with any | |
4387 | other input sections. You can use this to place common symbols from a | |
4388 | particular input file in one section while common symbols from other | |
4389 | input files are placed in another section. | |
4390 | ||
4391 | In most cases, common symbols in input files will be placed in the | |
4392 | @samp{.bss} section in the output file. For example: | |
4393 | @smallexample | |
4394 | .bss @{ *(.bss) *(COMMON) @} | |
4395 | @end smallexample | |
4396 | ||
4397 | @cindex scommon section | |
4398 | @cindex small common symbols | |
4399 | Some object file formats have more than one type of common symbol. For | |
4400 | example, the MIPS ELF object file format distinguishes standard common | |
4401 | symbols and small common symbols. In this case, the linker will use a | |
4402 | different special section name for other types of common symbols. In | |
4403 | the case of MIPS ELF, the linker uses @samp{COMMON} for standard common | |
4404 | symbols and @samp{.scommon} for small common symbols. This permits you | |
4405 | to map the different types of common symbols into memory at different | |
4406 | locations. | |
4407 | ||
4408 | @cindex [COMMON] | |
4409 | You will sometimes see @samp{[COMMON]} in old linker scripts. This | |
4410 | notation is now considered obsolete. It is equivalent to | |
4411 | @samp{*(COMMON)}. | |
4412 | ||
4413 | @node Input Section Keep | |
36f63dca | 4414 | @subsubsection Input Section and Garbage Collection |
252b5132 RH |
4415 | @cindex KEEP |
4416 | @cindex garbage collection | |
4417 | When link-time garbage collection is in use (@samp{--gc-sections}), | |
a1ab1d2a | 4418 | it is often useful to mark sections that should not be eliminated. |
252b5132 RH |
4419 | This is accomplished by surrounding an input section's wildcard entry |
4420 | with @code{KEEP()}, as in @code{KEEP(*(.init))} or | |
bcaa7b3e | 4421 | @code{KEEP(SORT_BY_NAME(*)(.ctors))}. |
252b5132 RH |
4422 | |
4423 | @node Input Section Example | |
36f63dca | 4424 | @subsubsection Input Section Example |
252b5132 RH |
4425 | The following example is a complete linker script. It tells the linker |
4426 | to read all of the sections from file @file{all.o} and place them at the | |
4427 | start of output section @samp{outputa} which starts at location | |
4428 | @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o} | |
4429 | follows immediately, in the same output section. All of section | |
4430 | @samp{.input2} from @file{foo.o} goes into output section | |
4431 | @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}. | |
4432 | All of the remaining @samp{.input1} and @samp{.input2} sections from any | |
4433 | files are written to output section @samp{outputc}. | |
4434 | ||
4435 | @smallexample | |
4436 | @group | |
4437 | SECTIONS @{ | |
4438 | outputa 0x10000 : | |
4439 | @{ | |
4440 | all.o | |
4441 | foo.o (.input1) | |
4442 | @} | |
36f63dca NC |
4443 | @end group |
4444 | @group | |
252b5132 RH |
4445 | outputb : |
4446 | @{ | |
4447 | foo.o (.input2) | |
4448 | foo1.o (.input1) | |
4449 | @} | |
36f63dca NC |
4450 | @end group |
4451 | @group | |
252b5132 RH |
4452 | outputc : |
4453 | @{ | |
4454 | *(.input1) | |
4455 | *(.input2) | |
4456 | @} | |
4457 | @} | |
4458 | @end group | |
a1ab1d2a | 4459 | @end smallexample |
252b5132 RH |
4460 | |
4461 | @node Output Section Data | |
36f63dca | 4462 | @subsection Output Section Data |
252b5132 RH |
4463 | @cindex data |
4464 | @cindex section data | |
4465 | @cindex output section data | |
4466 | @kindex BYTE(@var{expression}) | |
4467 | @kindex SHORT(@var{expression}) | |
4468 | @kindex LONG(@var{expression}) | |
4469 | @kindex QUAD(@var{expression}) | |
4470 | @kindex SQUAD(@var{expression}) | |
4471 | You can include explicit bytes of data in an output section by using | |
4472 | @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as | |
4473 | an output section command. Each keyword is followed by an expression in | |
4474 | parentheses providing the value to store (@pxref{Expressions}). The | |
4475 | value of the expression is stored at the current value of the location | |
4476 | counter. | |
4477 | ||
4478 | The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands | |
4479 | store one, two, four, and eight bytes (respectively). After storing the | |
4480 | bytes, the location counter is incremented by the number of bytes | |
4481 | stored. | |
4482 | ||
4483 | For example, this will store the byte 1 followed by the four byte value | |
4484 | of the symbol @samp{addr}: | |
4485 | @smallexample | |
4486 | BYTE(1) | |
4487 | LONG(addr) | |
4488 | @end smallexample | |
4489 | ||
4490 | When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the | |
4491 | same; they both store an 8 byte, or 64 bit, value. When both host and | |
4492 | target are 32 bits, an expression is computed as 32 bits. In this case | |
4493 | @code{QUAD} stores a 32 bit value zero extended to 64 bits, and | |
4494 | @code{SQUAD} stores a 32 bit value sign extended to 64 bits. | |
4495 | ||
4496 | If the object file format of the output file has an explicit endianness, | |
4497 | which is the normal case, the value will be stored in that endianness. | |
4498 | When the object file format does not have an explicit endianness, as is | |
4499 | true of, for example, S-records, the value will be stored in the | |
4500 | endianness of the first input object file. | |
4501 | ||
36f63dca | 4502 | Note---these commands only work inside a section description and not |
2b5fc1f5 NC |
4503 | between them, so the following will produce an error from the linker: |
4504 | @smallexample | |
4505 | SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@ | |
4506 | @end smallexample | |
4507 | whereas this will work: | |
4508 | @smallexample | |
4509 | SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@ | |
4510 | @end smallexample | |
4511 | ||
252b5132 RH |
4512 | @kindex FILL(@var{expression}) |
4513 | @cindex holes, filling | |
4514 | @cindex unspecified memory | |
4515 | You may use the @code{FILL} command to set the fill pattern for the | |
4516 | current section. It is followed by an expression in parentheses. Any | |
4517 | otherwise unspecified regions of memory within the section (for example, | |
4518 | gaps left due to the required alignment of input sections) are filled | |
a139d329 | 4519 | with the value of the expression, repeated as |
252b5132 RH |
4520 | necessary. A @code{FILL} statement covers memory locations after the |
4521 | point at which it occurs in the section definition; by including more | |
4522 | than one @code{FILL} statement, you can have different fill patterns in | |
4523 | different parts of an output section. | |
4524 | ||
4525 | This example shows how to fill unspecified regions of memory with the | |
563e308f | 4526 | value @samp{0x90}: |
252b5132 | 4527 | @smallexample |
563e308f | 4528 | FILL(0x90909090) |
252b5132 RH |
4529 | @end smallexample |
4530 | ||
4531 | The @code{FILL} command is similar to the @samp{=@var{fillexp}} output | |
9673c93c | 4532 | section attribute, but it only affects the |
252b5132 RH |
4533 | part of the section following the @code{FILL} command, rather than the |
4534 | entire section. If both are used, the @code{FILL} command takes | |
9673c93c | 4535 | precedence. @xref{Output Section Fill}, for details on the fill |
a139d329 | 4536 | expression. |
252b5132 RH |
4537 | |
4538 | @node Output Section Keywords | |
36f63dca | 4539 | @subsection Output Section Keywords |
252b5132 RH |
4540 | There are a couple of keywords which can appear as output section |
4541 | commands. | |
4542 | ||
4543 | @table @code | |
4544 | @kindex CREATE_OBJECT_SYMBOLS | |
4545 | @cindex input filename symbols | |
4546 | @cindex filename symbols | |
4547 | @item CREATE_OBJECT_SYMBOLS | |
4548 | The command tells the linker to create a symbol for each input file. | |
4549 | The name of each symbol will be the name of the corresponding input | |
4550 | file. The section of each symbol will be the output section in which | |
4551 | the @code{CREATE_OBJECT_SYMBOLS} command appears. | |
4552 | ||
4553 | This is conventional for the a.out object file format. It is not | |
4554 | normally used for any other object file format. | |
4555 | ||
4556 | @kindex CONSTRUCTORS | |
4557 | @cindex C++ constructors, arranging in link | |
4558 | @cindex constructors, arranging in link | |
4559 | @item CONSTRUCTORS | |
4560 | When linking using the a.out object file format, the linker uses an | |
4561 | unusual set construct to support C++ global constructors and | |
4562 | destructors. When linking object file formats which do not support | |
4563 | arbitrary sections, such as ECOFF and XCOFF, the linker will | |
4564 | automatically recognize C++ global constructors and destructors by name. | |
4565 | For these object file formats, the @code{CONSTRUCTORS} command tells the | |
4566 | linker to place constructor information in the output section where the | |
4567 | @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is | |
4568 | ignored for other object file formats. | |
4569 | ||
4570 | The symbol @w{@code{__CTOR_LIST__}} marks the start of the global | |
7e69709c AM |
4571 | constructors, and the symbol @w{@code{__CTOR_END__}} marks the end. |
4572 | Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark | |
4573 | the start and end of the global destructors. The | |
252b5132 RH |
4574 | first word in the list is the number of entries, followed by the address |
4575 | of each constructor or destructor, followed by a zero word. The | |
4576 | compiler must arrange to actually run the code. For these object file | |
4577 | formats @sc{gnu} C++ normally calls constructors from a subroutine | |
4578 | @code{__main}; a call to @code{__main} is automatically inserted into | |
4579 | the startup code for @code{main}. @sc{gnu} C++ normally runs | |
4580 | destructors either by using @code{atexit}, or directly from the function | |
4581 | @code{exit}. | |
4582 | ||
4583 | For object file formats such as @code{COFF} or @code{ELF} which support | |
4584 | arbitrary section names, @sc{gnu} C++ will normally arrange to put the | |
4585 | addresses of global constructors and destructors into the @code{.ctors} | |
4586 | and @code{.dtors} sections. Placing the following sequence into your | |
4587 | linker script will build the sort of table which the @sc{gnu} C++ | |
4588 | runtime code expects to see. | |
4589 | ||
4590 | @smallexample | |
4591 | __CTOR_LIST__ = .; | |
4592 | LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2) | |
4593 | *(.ctors) | |
4594 | LONG(0) | |
4595 | __CTOR_END__ = .; | |
4596 | __DTOR_LIST__ = .; | |
4597 | LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2) | |
4598 | *(.dtors) | |
4599 | LONG(0) | |
4600 | __DTOR_END__ = .; | |
4601 | @end smallexample | |
4602 | ||
4603 | If you are using the @sc{gnu} C++ support for initialization priority, | |
4604 | which provides some control over the order in which global constructors | |
4605 | are run, you must sort the constructors at link time to ensure that they | |
4606 | are executed in the correct order. When using the @code{CONSTRUCTORS} | |
bcaa7b3e L |
4607 | command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the |
4608 | @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and | |
4609 | @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and | |
252b5132 RH |
4610 | @samp{*(.dtors)}. |
4611 | ||
4612 | Normally the compiler and linker will handle these issues automatically, | |
4613 | and you will not need to concern yourself with them. However, you may | |
4614 | need to consider this if you are using C++ and writing your own linker | |
4615 | scripts. | |
4616 | ||
4617 | @end table | |
4618 | ||
4619 | @node Output Section Discarding | |
36f63dca | 4620 | @subsection Output Section Discarding |
252b5132 RH |
4621 | @cindex discarding sections |
4622 | @cindex sections, discarding | |
4623 | @cindex removing sections | |
2edab91c AM |
4624 | The linker will not normally create output sections with no contents. |
4625 | This is for convenience when referring to input sections that may or | |
4626 | may not be present in any of the input files. For example: | |
252b5132 | 4627 | @smallexample |
49c13adb | 4628 | .foo : @{ *(.foo) @} |
252b5132 RH |
4629 | @end smallexample |
4630 | @noindent | |
4631 | will only create a @samp{.foo} section in the output file if there is a | |
74541ad4 AM |
4632 | @samp{.foo} section in at least one input file, and if the input |
4633 | sections are not all empty. Other link script directives that allocate | |
2edab91c AM |
4634 | space in an output section will also create the output section. So |
4635 | too will assignments to dot even if the assignment does not create | |
4636 | space, except for @samp{. = 0}, @samp{. = . + 0}, @samp{. = sym}, | |
4637 | @samp{. = . + sym} and @samp{. = ALIGN (. != 0, expr, 1)} when | |
4638 | @samp{sym} is an absolute symbol of value 0 defined in the script. | |
4639 | This allows you to force output of an empty section with @samp{. = .}. | |
74541ad4 | 4640 | |
a0976ea4 | 4641 | The linker will ignore address assignments (@pxref{Output Section Address}) |
74541ad4 AM |
4642 | on discarded output sections, except when the linker script defines |
4643 | symbols in the output section. In that case the linker will obey | |
a0976ea4 AM |
4644 | the address assignments, possibly advancing dot even though the |
4645 | section is discarded. | |
252b5132 RH |
4646 | |
4647 | @cindex /DISCARD/ | |
4648 | The special output section name @samp{/DISCARD/} may be used to discard | |
4649 | input sections. Any input sections which are assigned to an output | |
4650 | section named @samp{/DISCARD/} are not included in the output file. | |
4651 | ||
4652 | @node Output Section Attributes | |
36f63dca | 4653 | @subsection Output Section Attributes |
252b5132 RH |
4654 | @cindex output section attributes |
4655 | We showed above that the full description of an output section looked | |
4656 | like this: | |
0c71d759 | 4657 | |
252b5132 | 4658 | @smallexample |
a1ab1d2a | 4659 | @group |
7e7d5768 | 4660 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 NC |
4661 | [AT(@var{lma})] |
4662 | [ALIGN(@var{section_align})] | |
4663 | [SUBALIGN(@var{subsection_align})] | |
4664 | [@var{constraint}] | |
252b5132 RH |
4665 | @{ |
4666 | @var{output-section-command} | |
4667 | @var{output-section-command} | |
4668 | @dots{} | |
562d3460 | 4669 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
4670 | @end group |
4671 | @end smallexample | |
0c71d759 | 4672 | |
252b5132 RH |
4673 | We've already described @var{section}, @var{address}, and |
4674 | @var{output-section-command}. In this section we will describe the | |
4675 | remaining section attributes. | |
4676 | ||
a1ab1d2a | 4677 | @menu |
252b5132 RH |
4678 | * Output Section Type:: Output section type |
4679 | * Output Section LMA:: Output section LMA | |
bbf115d3 | 4680 | * Forced Output Alignment:: Forced Output Alignment |
7e7d5768 | 4681 | * Forced Input Alignment:: Forced Input Alignment |
0c71d759 | 4682 | * Output Section Constraint:: Output section constraint |
252b5132 RH |
4683 | * Output Section Region:: Output section region |
4684 | * Output Section Phdr:: Output section phdr | |
4685 | * Output Section Fill:: Output section fill | |
4686 | @end menu | |
4687 | ||
4688 | @node Output Section Type | |
36f63dca | 4689 | @subsubsection Output Section Type |
252b5132 RH |
4690 | Each output section may have a type. The type is a keyword in |
4691 | parentheses. The following types are defined: | |
4692 | ||
4693 | @table @code | |
4694 | @item NOLOAD | |
4695 | The section should be marked as not loadable, so that it will not be | |
4696 | loaded into memory when the program is run. | |
4697 | @item DSECT | |
4698 | @itemx COPY | |
4699 | @itemx INFO | |
4700 | @itemx OVERLAY | |
4701 | These type names are supported for backward compatibility, and are | |
4702 | rarely used. They all have the same effect: the section should be | |
4703 | marked as not allocatable, so that no memory is allocated for the | |
4704 | section when the program is run. | |
4705 | @end table | |
4706 | ||
4707 | @kindex NOLOAD | |
4708 | @cindex prevent unnecessary loading | |
4709 | @cindex loading, preventing | |
4710 | The linker normally sets the attributes of an output section based on | |
4711 | the input sections which map into it. You can override this by using | |
4712 | the section type. For example, in the script sample below, the | |
4713 | @samp{ROM} section is addressed at memory location @samp{0} and does not | |
2e76e85a | 4714 | need to be loaded when the program is run. |
252b5132 RH |
4715 | @smallexample |
4716 | @group | |
4717 | SECTIONS @{ | |
4718 | ROM 0 (NOLOAD) : @{ @dots{} @} | |
4719 | @dots{} | |
4720 | @} | |
4721 | @end group | |
4722 | @end smallexample | |
4723 | ||
4724 | @node Output Section LMA | |
36f63dca | 4725 | @subsubsection Output Section LMA |
562d3460 | 4726 | @kindex AT>@var{lma_region} |
252b5132 RH |
4727 | @kindex AT(@var{lma}) |
4728 | @cindex load address | |
4729 | @cindex section load address | |
4730 | Every section has a virtual address (VMA) and a load address (LMA); see | |
ea5cae92 NC |
4731 | @ref{Basic Script Concepts}. The virtual address is specified by the |
4732 | @pxref{Output Section Address} described earlier. The load address is | |
4733 | specified by the @code{AT} or @code{AT>} keywords. Specifying a load | |
4734 | address is optional. | |
6bdafbeb | 4735 | |
ea5cae92 NC |
4736 | The @code{AT} keyword takes an expression as an argument. This |
4737 | specifies the exact load address of the section. The @code{AT>} keyword | |
4738 | takes the name of a memory region as an argument. @xref{MEMORY}. The | |
4739 | load address of the section is set to the next free address in the | |
4740 | region, aligned to the section's alignment requirements. | |
dc0b6aa0 AM |
4741 | |
4742 | If neither @code{AT} nor @code{AT>} is specified for an allocatable | |
ea5cae92 NC |
4743 | section, the linker will use the following heuristic to determine the |
4744 | load address: | |
4745 | ||
4746 | @itemize @bullet | |
4747 | @item | |
4748 | If the section has a specific VMA address, then this is used as | |
4749 | the LMA address as well. | |
4750 | ||
4751 | @item | |
4752 | If the section is not allocatable then its LMA is set to its VMA. | |
4753 | ||
4754 | @item | |
4755 | Otherwise if a memory region can be found that is compatible | |
4756 | with the current section, and this region contains at least one | |
4757 | section, then the LMA is set so the difference between the | |
4758 | VMA and LMA is the same as the difference between the VMA and LMA of | |
4759 | the last section in the located region. | |
4760 | ||
4761 | @item | |
4762 | If no memory regions have been declared then a default region | |
4763 | that covers the entire address space is used in the previous step. | |
4764 | ||
4765 | @item | |
4766 | If no suitable region could be found, or there was no previous | |
4767 | section then the LMA is set equal to the VMA. | |
4768 | @end itemize | |
252b5132 RH |
4769 | |
4770 | @cindex ROM initialized data | |
4771 | @cindex initialized data in ROM | |
4772 | This feature is designed to make it easy to build a ROM image. For | |
4773 | example, the following linker script creates three output sections: one | |
4774 | called @samp{.text}, which starts at @code{0x1000}, one called | |
4775 | @samp{.mdata}, which is loaded at the end of the @samp{.text} section | |
4776 | even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold | |
4777 | uninitialized data at address @code{0x3000}. The symbol @code{_data} is | |
4778 | defined with the value @code{0x2000}, which shows that the location | |
4779 | counter holds the VMA value, not the LMA value. | |
4780 | ||
4781 | @smallexample | |
4782 | @group | |
4783 | SECTIONS | |
4784 | @{ | |
4785 | .text 0x1000 : @{ *(.text) _etext = . ; @} | |
a1ab1d2a | 4786 | .mdata 0x2000 : |
252b5132 RH |
4787 | AT ( ADDR (.text) + SIZEOF (.text) ) |
4788 | @{ _data = . ; *(.data); _edata = . ; @} | |
4789 | .bss 0x3000 : | |
4790 | @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@} | |
4791 | @} | |
4792 | @end group | |
4793 | @end smallexample | |
4794 | ||
4795 | The run-time initialization code for use with a program generated with | |
4796 | this linker script would include something like the following, to copy | |
4797 | the initialized data from the ROM image to its runtime address. Notice | |
4798 | how this code takes advantage of the symbols defined by the linker | |
4799 | script. | |
4800 | ||
4801 | @smallexample | |
4802 | @group | |
4803 | extern char _etext, _data, _edata, _bstart, _bend; | |
4804 | char *src = &_etext; | |
4805 | char *dst = &_data; | |
4806 | ||
ea5cae92 NC |
4807 | /* ROM has data at end of text; copy it. */ |
4808 | while (dst < &_edata) | |
252b5132 | 4809 | *dst++ = *src++; |
252b5132 | 4810 | |
ea5cae92 | 4811 | /* Zero bss. */ |
252b5132 RH |
4812 | for (dst = &_bstart; dst< &_bend; dst++) |
4813 | *dst = 0; | |
4814 | @end group | |
4815 | @end smallexample | |
4816 | ||
bbf115d3 L |
4817 | @node Forced Output Alignment |
4818 | @subsubsection Forced Output Alignment | |
4819 | @kindex ALIGN(@var{section_align}) | |
4820 | @cindex forcing output section alignment | |
4821 | @cindex output section alignment | |
1eec346e | 4822 | You can increase an output section's alignment by using ALIGN. As an |
13075d04 SH |
4823 | alternative you can enforce that the difference between the VMA and LMA remains |
4824 | intact throughout this output section with the ALIGN_WITH_INPUT attribute. | |
bbf115d3 | 4825 | |
7e7d5768 AM |
4826 | @node Forced Input Alignment |
4827 | @subsubsection Forced Input Alignment | |
4828 | @kindex SUBALIGN(@var{subsection_align}) | |
4829 | @cindex forcing input section alignment | |
4830 | @cindex input section alignment | |
4831 | You can force input section alignment within an output section by using | |
4832 | SUBALIGN. The value specified overrides any alignment given by input | |
4833 | sections, whether larger or smaller. | |
4834 | ||
0c71d759 NC |
4835 | @node Output Section Constraint |
4836 | @subsubsection Output Section Constraint | |
4837 | @kindex ONLY_IF_RO | |
4838 | @kindex ONLY_IF_RW | |
4839 | @cindex constraints on output sections | |
4840 | You can specify that an output section should only be created if all | |
4841 | of its input sections are read-only or all of its input sections are | |
4842 | read-write by using the keyword @code{ONLY_IF_RO} and | |
4843 | @code{ONLY_IF_RW} respectively. | |
4844 | ||
252b5132 | 4845 | @node Output Section Region |
36f63dca | 4846 | @subsubsection Output Section Region |
252b5132 RH |
4847 | @kindex >@var{region} |
4848 | @cindex section, assigning to memory region | |
4849 | @cindex memory regions and sections | |
4850 | You can assign a section to a previously defined region of memory by | |
4851 | using @samp{>@var{region}}. @xref{MEMORY}. | |
4852 | ||
4853 | Here is a simple example: | |
4854 | @smallexample | |
4855 | @group | |
4856 | MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @} | |
4857 | SECTIONS @{ ROM : @{ *(.text) @} >rom @} | |
4858 | @end group | |
4859 | @end smallexample | |
4860 | ||
4861 | @node Output Section Phdr | |
36f63dca | 4862 | @subsubsection Output Section Phdr |
252b5132 RH |
4863 | @kindex :@var{phdr} |
4864 | @cindex section, assigning to program header | |
4865 | @cindex program headers and sections | |
4866 | You can assign a section to a previously defined program segment by | |
4867 | using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to | |
4868 | one or more segments, then all subsequent allocated sections will be | |
4869 | assigned to those segments as well, unless they use an explicitly | |
4870 | @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the | |
4871 | linker to not put the section in any segment at all. | |
4872 | ||
4873 | Here is a simple example: | |
4874 | @smallexample | |
4875 | @group | |
4876 | PHDRS @{ text PT_LOAD ; @} | |
4877 | SECTIONS @{ .text : @{ *(.text) @} :text @} | |
4878 | @end group | |
4879 | @end smallexample | |
4880 | ||
4881 | @node Output Section Fill | |
36f63dca | 4882 | @subsubsection Output Section Fill |
252b5132 RH |
4883 | @kindex =@var{fillexp} |
4884 | @cindex section fill pattern | |
4885 | @cindex fill pattern, entire section | |
4886 | You can set the fill pattern for an entire section by using | |
4887 | @samp{=@var{fillexp}}. @var{fillexp} is an expression | |
4888 | (@pxref{Expressions}). Any otherwise unspecified regions of memory | |
4889 | within the output section (for example, gaps left due to the required | |
a139d329 AM |
4890 | alignment of input sections) will be filled with the value, repeated as |
4891 | necessary. If the fill expression is a simple hex number, ie. a string | |
9673c93c | 4892 | of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then |
a139d329 AM |
4893 | an arbitrarily long sequence of hex digits can be used to specify the |
4894 | fill pattern; Leading zeros become part of the pattern too. For all | |
9673c93c | 4895 | other cases, including extra parentheses or a unary @code{+}, the fill |
a139d329 AM |
4896 | pattern is the four least significant bytes of the value of the |
4897 | expression. In all cases, the number is big-endian. | |
252b5132 RH |
4898 | |
4899 | You can also change the fill value with a @code{FILL} command in the | |
9673c93c | 4900 | output section commands; (@pxref{Output Section Data}). |
252b5132 RH |
4901 | |
4902 | Here is a simple example: | |
4903 | @smallexample | |
4904 | @group | |
563e308f | 4905 | SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @} |
252b5132 RH |
4906 | @end group |
4907 | @end smallexample | |
4908 | ||
4909 | @node Overlay Description | |
36f63dca | 4910 | @subsection Overlay Description |
252b5132 RH |
4911 | @kindex OVERLAY |
4912 | @cindex overlays | |
4913 | An overlay description provides an easy way to describe sections which | |
4914 | are to be loaded as part of a single memory image but are to be run at | |
4915 | the same memory address. At run time, some sort of overlay manager will | |
4916 | copy the overlaid sections in and out of the runtime memory address as | |
4917 | required, perhaps by simply manipulating addressing bits. This approach | |
4918 | can be useful, for example, when a certain region of memory is faster | |
4919 | than another. | |
4920 | ||
4921 | Overlays are described using the @code{OVERLAY} command. The | |
4922 | @code{OVERLAY} command is used within a @code{SECTIONS} command, like an | |
4923 | output section description. The full syntax of the @code{OVERLAY} | |
4924 | command is as follows: | |
4925 | @smallexample | |
4926 | @group | |
4927 | OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )] | |
4928 | @{ | |
4929 | @var{secname1} | |
4930 | @{ | |
4931 | @var{output-section-command} | |
4932 | @var{output-section-command} | |
4933 | @dots{} | |
4934 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
4935 | @var{secname2} | |
4936 | @{ | |
4937 | @var{output-section-command} | |
4938 | @var{output-section-command} | |
4939 | @dots{} | |
4940 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
4941 | @dots{} | |
abc9061b | 4942 | @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] [,] |
252b5132 RH |
4943 | @end group |
4944 | @end smallexample | |
4945 | ||
4946 | Everything is optional except @code{OVERLAY} (a keyword), and each | |
4947 | section must have a name (@var{secname1} and @var{secname2} above). The | |
4948 | section definitions within the @code{OVERLAY} construct are identical to | |
11e7fd74 | 4949 | those within the general @code{SECTIONS} construct (@pxref{SECTIONS}), |
252b5132 RH |
4950 | except that no addresses and no memory regions may be defined for |
4951 | sections within an @code{OVERLAY}. | |
4952 | ||
abc9061b CC |
4953 | The comma at the end may be required if a @var{fill} is used and |
4954 | the next @var{sections-command} looks like a continuation of the expression. | |
4955 | ||
252b5132 RH |
4956 | The sections are all defined with the same starting address. The load |
4957 | addresses of the sections are arranged such that they are consecutive in | |
4958 | memory starting at the load address used for the @code{OVERLAY} as a | |
4959 | whole (as with normal section definitions, the load address is optional, | |
4960 | and defaults to the start address; the start address is also optional, | |
4961 | and defaults to the current value of the location counter). | |
4962 | ||
56dd11f0 NC |
4963 | If the @code{NOCROSSREFS} keyword is used, and there are any |
4964 | references among the sections, the linker will report an error. Since | |
4965 | the sections all run at the same address, it normally does not make | |
4966 | sense for one section to refer directly to another. | |
4967 | @xref{Miscellaneous Commands, NOCROSSREFS}. | |
252b5132 RH |
4968 | |
4969 | For each section within the @code{OVERLAY}, the linker automatically | |
34711ca3 | 4970 | provides two symbols. The symbol @code{__load_start_@var{secname}} is |
252b5132 RH |
4971 | defined as the starting load address of the section. The symbol |
4972 | @code{__load_stop_@var{secname}} is defined as the final load address of | |
4973 | the section. Any characters within @var{secname} which are not legal | |
4974 | within C identifiers are removed. C (or assembler) code may use these | |
4975 | symbols to move the overlaid sections around as necessary. | |
4976 | ||
4977 | At the end of the overlay, the value of the location counter is set to | |
4978 | the start address of the overlay plus the size of the largest section. | |
4979 | ||
4980 | Here is an example. Remember that this would appear inside a | |
4981 | @code{SECTIONS} construct. | |
4982 | @smallexample | |
4983 | @group | |
4984 | OVERLAY 0x1000 : AT (0x4000) | |
4985 | @{ | |
4986 | .text0 @{ o1/*.o(.text) @} | |
4987 | .text1 @{ o2/*.o(.text) @} | |
4988 | @} | |
4989 | @end group | |
4990 | @end smallexample | |
4991 | @noindent | |
4992 | This will define both @samp{.text0} and @samp{.text1} to start at | |
4993 | address 0x1000. @samp{.text0} will be loaded at address 0x4000, and | |
4994 | @samp{.text1} will be loaded immediately after @samp{.text0}. The | |
34711ca3 | 4995 | following symbols will be defined if referenced: @code{__load_start_text0}, |
252b5132 RH |
4996 | @code{__load_stop_text0}, @code{__load_start_text1}, |
4997 | @code{__load_stop_text1}. | |
4998 | ||
4999 | C code to copy overlay @code{.text1} into the overlay area might look | |
5000 | like the following. | |
5001 | ||
5002 | @smallexample | |
5003 | @group | |
5004 | extern char __load_start_text1, __load_stop_text1; | |
5005 | memcpy ((char *) 0x1000, &__load_start_text1, | |
5006 | &__load_stop_text1 - &__load_start_text1); | |
5007 | @end group | |
5008 | @end smallexample | |
5009 | ||
5010 | Note that the @code{OVERLAY} command is just syntactic sugar, since | |
5011 | everything it does can be done using the more basic commands. The above | |
5012 | example could have been written identically as follows. | |
5013 | ||
5014 | @smallexample | |
5015 | @group | |
5016 | .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @} | |
34711ca3 AM |
5017 | PROVIDE (__load_start_text0 = LOADADDR (.text0)); |
5018 | PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0)); | |
252b5132 | 5019 | .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @} |
34711ca3 AM |
5020 | PROVIDE (__load_start_text1 = LOADADDR (.text1)); |
5021 | PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1)); | |
252b5132 RH |
5022 | . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1)); |
5023 | @end group | |
5024 | @end smallexample | |
5025 | ||
5026 | @node MEMORY | |
36f63dca | 5027 | @section MEMORY Command |
252b5132 RH |
5028 | @kindex MEMORY |
5029 | @cindex memory regions | |
5030 | @cindex regions of memory | |
5031 | @cindex allocating memory | |
5032 | @cindex discontinuous memory | |
5033 | The linker's default configuration permits allocation of all available | |
5034 | memory. You can override this by using the @code{MEMORY} command. | |
5035 | ||
5036 | The @code{MEMORY} command describes the location and size of blocks of | |
5037 | memory in the target. You can use it to describe which memory regions | |
5038 | may be used by the linker, and which memory regions it must avoid. You | |
5039 | can then assign sections to particular memory regions. The linker will | |
5040 | set section addresses based on the memory regions, and will warn about | |
5041 | regions that become too full. The linker will not shuffle sections | |
5042 | around to fit into the available regions. | |
5043 | ||
127fcdff AB |
5044 | A linker script may contain many uses of the @code{MEMORY} command, |
5045 | however, all memory blocks defined are treated as if they were | |
5046 | specified inside a single @code{MEMORY} command. The syntax for | |
5047 | @code{MEMORY} is: | |
252b5132 RH |
5048 | @smallexample |
5049 | @group | |
a1ab1d2a | 5050 | MEMORY |
252b5132 RH |
5051 | @{ |
5052 | @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len} | |
5053 | @dots{} | |
5054 | @} | |
5055 | @end group | |
5056 | @end smallexample | |
5057 | ||
5058 | The @var{name} is a name used in the linker script to refer to the | |
5059 | region. The region name has no meaning outside of the linker script. | |
5060 | Region names are stored in a separate name space, and will not conflict | |
5061 | with symbol names, file names, or section names. Each memory region | |
4a93e180 NC |
5062 | must have a distinct name within the @code{MEMORY} command. However you can |
5063 | add later alias names to existing memory regions with the @ref{REGION_ALIAS} | |
9d5777a3 | 5064 | command. |
252b5132 RH |
5065 | |
5066 | @cindex memory region attributes | |
5067 | The @var{attr} string is an optional list of attributes that specify | |
5068 | whether to use a particular memory region for an input section which is | |
5069 | not explicitly mapped in the linker script. As described in | |
5070 | @ref{SECTIONS}, if you do not specify an output section for some input | |
5071 | section, the linker will create an output section with the same name as | |
5072 | the input section. If you define region attributes, the linker will use | |
5073 | them to select the memory region for the output section that it creates. | |
5074 | ||
5075 | The @var{attr} string must consist only of the following characters: | |
5076 | @table @samp | |
5077 | @item R | |
5078 | Read-only section | |
5079 | @item W | |
5080 | Read/write section | |
5081 | @item X | |
5082 | Executable section | |
5083 | @item A | |
5084 | Allocatable section | |
5085 | @item I | |
5086 | Initialized section | |
5087 | @item L | |
5088 | Same as @samp{I} | |
5089 | @item ! | |
c09e9a8c | 5090 | Invert the sense of any of the attributes that follow |
252b5132 RH |
5091 | @end table |
5092 | ||
5093 | If a unmapped section matches any of the listed attributes other than | |
5094 | @samp{!}, it will be placed in the memory region. The @samp{!} | |
5095 | attribute reverses this test, so that an unmapped section will be placed | |
5096 | in the memory region only if it does not match any of the listed | |
5097 | attributes. | |
5098 | ||
5099 | @kindex ORIGIN = | |
5100 | @kindex o = | |
5101 | @kindex org = | |
9cd6d51a NC |
5102 | The @var{origin} is an numerical expression for the start address of |
5103 | the memory region. The expression must evaluate to a constant and it | |
5104 | cannot involve any symbols. The keyword @code{ORIGIN} may be | |
5105 | abbreviated to @code{org} or @code{o} (but not, for example, | |
5106 | @code{ORG}). | |
252b5132 RH |
5107 | |
5108 | @kindex LENGTH = | |
5109 | @kindex len = | |
5110 | @kindex l = | |
5111 | The @var{len} is an expression for the size in bytes of the memory | |
5112 | region. As with the @var{origin} expression, the expression must | |
9cd6d51a NC |
5113 | be numerical only and must evaluate to a constant. The keyword |
5114 | @code{LENGTH} may be abbreviated to @code{len} or @code{l}. | |
252b5132 RH |
5115 | |
5116 | In the following example, we specify that there are two memory regions | |
5117 | available for allocation: one starting at @samp{0} for 256 kilobytes, | |
5118 | and the other starting at @samp{0x40000000} for four megabytes. The | |
5119 | linker will place into the @samp{rom} memory region every section which | |
5120 | is not explicitly mapped into a memory region, and is either read-only | |
5121 | or executable. The linker will place other sections which are not | |
5122 | explicitly mapped into a memory region into the @samp{ram} memory | |
5123 | region. | |
5124 | ||
5125 | @smallexample | |
5126 | @group | |
a1ab1d2a | 5127 | MEMORY |
252b5132 RH |
5128 | @{ |
5129 | rom (rx) : ORIGIN = 0, LENGTH = 256K | |
5130 | ram (!rx) : org = 0x40000000, l = 4M | |
5131 | @} | |
5132 | @end group | |
5133 | @end smallexample | |
5134 | ||
5135 | Once you define a memory region, you can direct the linker to place | |
5136 | specific output sections into that memory region by using the | |
5137 | @samp{>@var{region}} output section attribute. For example, if you have | |
5138 | a memory region named @samp{mem}, you would use @samp{>mem} in the | |
5139 | output section definition. @xref{Output Section Region}. If no address | |
5140 | was specified for the output section, the linker will set the address to | |
5141 | the next available address within the memory region. If the combined | |
5142 | output sections directed to a memory region are too large for the | |
5143 | region, the linker will issue an error message. | |
5144 | ||
3ec57632 | 5145 | It is possible to access the origin and length of a memory in an |
c0065db7 | 5146 | expression via the @code{ORIGIN(@var{memory})} and |
3ec57632 NC |
5147 | @code{LENGTH(@var{memory})} functions: |
5148 | ||
5149 | @smallexample | |
5150 | @group | |
c0065db7 | 5151 | _fstack = ORIGIN(ram) + LENGTH(ram) - 4; |
3ec57632 NC |
5152 | @end group |
5153 | @end smallexample | |
5154 | ||
252b5132 RH |
5155 | @node PHDRS |
5156 | @section PHDRS Command | |
5157 | @kindex PHDRS | |
5158 | @cindex program headers | |
5159 | @cindex ELF program headers | |
5160 | @cindex program segments | |
5161 | @cindex segments, ELF | |
5162 | The ELF object file format uses @dfn{program headers}, also knows as | |
5163 | @dfn{segments}. The program headers describe how the program should be | |
5164 | loaded into memory. You can print them out by using the @code{objdump} | |
5165 | program with the @samp{-p} option. | |
5166 | ||
5167 | When you run an ELF program on a native ELF system, the system loader | |
5168 | reads the program headers in order to figure out how to load the | |
5169 | program. This will only work if the program headers are set correctly. | |
5170 | This manual does not describe the details of how the system loader | |
5171 | interprets program headers; for more information, see the ELF ABI. | |
5172 | ||
5173 | The linker will create reasonable program headers by default. However, | |
5174 | in some cases, you may need to specify the program headers more | |
5175 | precisely. You may use the @code{PHDRS} command for this purpose. When | |
5176 | the linker sees the @code{PHDRS} command in the linker script, it will | |
5177 | not create any program headers other than the ones specified. | |
5178 | ||
5179 | The linker only pays attention to the @code{PHDRS} command when | |
5180 | generating an ELF output file. In other cases, the linker will simply | |
5181 | ignore @code{PHDRS}. | |
5182 | ||
5183 | This is the syntax of the @code{PHDRS} command. The words @code{PHDRS}, | |
5184 | @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords. | |
5185 | ||
5186 | @smallexample | |
5187 | @group | |
5188 | PHDRS | |
5189 | @{ | |
5190 | @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ] | |
5191 | [ FLAGS ( @var{flags} ) ] ; | |
5192 | @} | |
5193 | @end group | |
5194 | @end smallexample | |
5195 | ||
5196 | The @var{name} is used only for reference in the @code{SECTIONS} command | |
5197 | of the linker script. It is not put into the output file. Program | |
5198 | header names are stored in a separate name space, and will not conflict | |
5199 | with symbol names, file names, or section names. Each program header | |
5c1a3f0f NS |
5200 | must have a distinct name. The headers are processed in order and it |
5201 | is usual for them to map to sections in ascending load address order. | |
252b5132 RH |
5202 | |
5203 | Certain program header types describe segments of memory which the | |
5204 | system loader will load from the file. In the linker script, you | |
5205 | specify the contents of these segments by placing allocatable output | |
5206 | sections in the segments. You use the @samp{:@var{phdr}} output section | |
5207 | attribute to place a section in a particular segment. @xref{Output | |
5208 | Section Phdr}. | |
5209 | ||
5210 | It is normal to put certain sections in more than one segment. This | |
5211 | merely implies that one segment of memory contains another. You may | |
5212 | repeat @samp{:@var{phdr}}, using it once for each segment which should | |
5213 | contain the section. | |
5214 | ||
5215 | If you place a section in one or more segments using @samp{:@var{phdr}}, | |
5216 | then the linker will place all subsequent allocatable sections which do | |
5217 | not specify @samp{:@var{phdr}} in the same segments. This is for | |
5218 | convenience, since generally a whole set of contiguous sections will be | |
5219 | placed in a single segment. You can use @code{:NONE} to override the | |
5220 | default segment and tell the linker to not put the section in any | |
5221 | segment at all. | |
5222 | ||
5223 | @kindex FILEHDR | |
5224 | @kindex PHDRS | |
5c1a3f0f | 5225 | You may use the @code{FILEHDR} and @code{PHDRS} keywords after |
252b5132 RH |
5226 | the program header type to further describe the contents of the segment. |
5227 | The @code{FILEHDR} keyword means that the segment should include the ELF | |
5228 | file header. The @code{PHDRS} keyword means that the segment should | |
5c1a3f0f | 5229 | include the ELF program headers themselves. If applied to a loadable |
4100cea3 AM |
5230 | segment (@code{PT_LOAD}), all prior loadable segments must have one of |
5231 | these keywords. | |
252b5132 RH |
5232 | |
5233 | The @var{type} may be one of the following. The numbers indicate the | |
5234 | value of the keyword. | |
5235 | ||
5236 | @table @asis | |
5237 | @item @code{PT_NULL} (0) | |
5238 | Indicates an unused program header. | |
5239 | ||
5240 | @item @code{PT_LOAD} (1) | |
5241 | Indicates that this program header describes a segment to be loaded from | |
5242 | the file. | |
5243 | ||
5244 | @item @code{PT_DYNAMIC} (2) | |
5245 | Indicates a segment where dynamic linking information can be found. | |
5246 | ||
5247 | @item @code{PT_INTERP} (3) | |
5248 | Indicates a segment where the name of the program interpreter may be | |
5249 | found. | |
5250 | ||
5251 | @item @code{PT_NOTE} (4) | |
5252 | Indicates a segment holding note information. | |
5253 | ||
5254 | @item @code{PT_SHLIB} (5) | |
5255 | A reserved program header type, defined but not specified by the ELF | |
5256 | ABI. | |
5257 | ||
5258 | @item @code{PT_PHDR} (6) | |
5259 | Indicates a segment where the program headers may be found. | |
5260 | ||
5261 | @item @var{expression} | |
5262 | An expression giving the numeric type of the program header. This may | |
5263 | be used for types not defined above. | |
5264 | @end table | |
5265 | ||
5266 | You can specify that a segment should be loaded at a particular address | |
5267 | in memory by using an @code{AT} expression. This is identical to the | |
5268 | @code{AT} command used as an output section attribute (@pxref{Output | |
5269 | Section LMA}). The @code{AT} command for a program header overrides the | |
5270 | output section attribute. | |
5271 | ||
5272 | The linker will normally set the segment flags based on the sections | |
5273 | which comprise the segment. You may use the @code{FLAGS} keyword to | |
5274 | explicitly specify the segment flags. The value of @var{flags} must be | |
5275 | an integer. It is used to set the @code{p_flags} field of the program | |
5276 | header. | |
5277 | ||
5278 | Here is an example of @code{PHDRS}. This shows a typical set of program | |
5279 | headers used on a native ELF system. | |
5280 | ||
5281 | @example | |
5282 | @group | |
5283 | PHDRS | |
5284 | @{ | |
5285 | headers PT_PHDR PHDRS ; | |
5286 | interp PT_INTERP ; | |
5287 | text PT_LOAD FILEHDR PHDRS ; | |
5288 | data PT_LOAD ; | |
5289 | dynamic PT_DYNAMIC ; | |
5290 | @} | |
5291 | ||
5292 | SECTIONS | |
5293 | @{ | |
5294 | . = SIZEOF_HEADERS; | |
5295 | .interp : @{ *(.interp) @} :text :interp | |
5296 | .text : @{ *(.text) @} :text | |
5297 | .rodata : @{ *(.rodata) @} /* defaults to :text */ | |
5298 | @dots{} | |
5299 | . = . + 0x1000; /* move to a new page in memory */ | |
5300 | .data : @{ *(.data) @} :data | |
5301 | .dynamic : @{ *(.dynamic) @} :data :dynamic | |
5302 | @dots{} | |
5303 | @} | |
5304 | @end group | |
5305 | @end example | |
5306 | ||
5307 | @node VERSION | |
5308 | @section VERSION Command | |
5309 | @kindex VERSION @{script text@} | |
5310 | @cindex symbol versions | |
5311 | @cindex version script | |
5312 | @cindex versions of symbols | |
5313 | The linker supports symbol versions when using ELF. Symbol versions are | |
5314 | only useful when using shared libraries. The dynamic linker can use | |
5315 | symbol versions to select a specific version of a function when it runs | |
5316 | a program that may have been linked against an earlier version of the | |
5317 | shared library. | |
5318 | ||
5319 | You can include a version script directly in the main linker script, or | |
5320 | you can supply the version script as an implicit linker script. You can | |
5321 | also use the @samp{--version-script} linker option. | |
5322 | ||
5323 | The syntax of the @code{VERSION} command is simply | |
5324 | @smallexample | |
5325 | VERSION @{ version-script-commands @} | |
5326 | @end smallexample | |
5327 | ||
5328 | The format of the version script commands is identical to that used by | |
5329 | Sun's linker in Solaris 2.5. The version script defines a tree of | |
5330 | version nodes. You specify the node names and interdependencies in the | |
5331 | version script. You can specify which symbols are bound to which | |
5332 | version nodes, and you can reduce a specified set of symbols to local | |
5333 | scope so that they are not globally visible outside of the shared | |
5334 | library. | |
5335 | ||
5336 | The easiest way to demonstrate the version script language is with a few | |
5337 | examples. | |
5338 | ||
5339 | @smallexample | |
5340 | VERS_1.1 @{ | |
5341 | global: | |
5342 | foo1; | |
5343 | local: | |
a1ab1d2a UD |
5344 | old*; |
5345 | original*; | |
5346 | new*; | |
252b5132 RH |
5347 | @}; |
5348 | ||
5349 | VERS_1.2 @{ | |
5350 | foo2; | |
5351 | @} VERS_1.1; | |
5352 | ||
5353 | VERS_2.0 @{ | |
5354 | bar1; bar2; | |
c0065db7 | 5355 | extern "C++" @{ |
86043bbb | 5356 | ns::*; |
bb1515f2 MF |
5357 | "f(int, double)"; |
5358 | @}; | |
252b5132 RH |
5359 | @} VERS_1.2; |
5360 | @end smallexample | |
5361 | ||
5362 | This example version script defines three version nodes. The first | |
5363 | version node defined is @samp{VERS_1.1}; it has no other dependencies. | |
5364 | The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces | |
5365 | a number of symbols to local scope so that they are not visible outside | |
313e35ee AM |
5366 | of the shared library; this is done using wildcard patterns, so that any |
5367 | symbol whose name begins with @samp{old}, @samp{original}, or @samp{new} | |
5368 | is matched. The wildcard patterns available are the same as those used | |
5369 | in the shell when matching filenames (also known as ``globbing''). | |
86043bbb MM |
5370 | However, if you specify the symbol name inside double quotes, then the |
5371 | name is treated as literal, rather than as a glob pattern. | |
252b5132 RH |
5372 | |
5373 | Next, the version script defines node @samp{VERS_1.2}. This node | |
5374 | depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2} | |
5375 | to the version node @samp{VERS_1.2}. | |
5376 | ||
5377 | Finally, the version script defines node @samp{VERS_2.0}. This node | |
5378 | depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1} | |
5379 | and @samp{bar2} are bound to the version node @samp{VERS_2.0}. | |
5380 | ||
5381 | When the linker finds a symbol defined in a library which is not | |
5382 | specifically bound to a version node, it will effectively bind it to an | |
5383 | unspecified base version of the library. You can bind all otherwise | |
a981ed6f | 5384 | unspecified symbols to a given version node by using @samp{global: *;} |
ae5a3597 AM |
5385 | somewhere in the version script. Note that it's slightly crazy to use |
5386 | wildcards in a global spec except on the last version node. Global | |
5387 | wildcards elsewhere run the risk of accidentally adding symbols to the | |
5388 | set exported for an old version. That's wrong since older versions | |
5389 | ought to have a fixed set of symbols. | |
252b5132 RH |
5390 | |
5391 | The names of the version nodes have no specific meaning other than what | |
5392 | they might suggest to the person reading them. The @samp{2.0} version | |
5393 | could just as well have appeared in between @samp{1.1} and @samp{1.2}. | |
5394 | However, this would be a confusing way to write a version script. | |
5395 | ||
0f6bf451 | 5396 | Node name can be omitted, provided it is the only version node |
6b9b879a JJ |
5397 | in the version script. Such version script doesn't assign any versions to |
5398 | symbols, only selects which symbols will be globally visible out and which | |
5399 | won't. | |
5400 | ||
5401 | @smallexample | |
7c9c73be | 5402 | @{ global: foo; bar; local: *; @}; |
9d201f2f | 5403 | @end smallexample |
6b9b879a | 5404 | |
252b5132 RH |
5405 | When you link an application against a shared library that has versioned |
5406 | symbols, the application itself knows which version of each symbol it | |
5407 | requires, and it also knows which version nodes it needs from each | |
5408 | shared library it is linked against. Thus at runtime, the dynamic | |
5409 | loader can make a quick check to make sure that the libraries you have | |
5410 | linked against do in fact supply all of the version nodes that the | |
5411 | application will need to resolve all of the dynamic symbols. In this | |
5412 | way it is possible for the dynamic linker to know with certainty that | |
5413 | all external symbols that it needs will be resolvable without having to | |
5414 | search for each symbol reference. | |
5415 | ||
5416 | The symbol versioning is in effect a much more sophisticated way of | |
5417 | doing minor version checking that SunOS does. The fundamental problem | |
5418 | that is being addressed here is that typically references to external | |
5419 | functions are bound on an as-needed basis, and are not all bound when | |
5420 | the application starts up. If a shared library is out of date, a | |
5421 | required interface may be missing; when the application tries to use | |
5422 | that interface, it may suddenly and unexpectedly fail. With symbol | |
5423 | versioning, the user will get a warning when they start their program if | |
5424 | the libraries being used with the application are too old. | |
5425 | ||
5426 | There are several GNU extensions to Sun's versioning approach. The | |
5427 | first of these is the ability to bind a symbol to a version node in the | |
5428 | source file where the symbol is defined instead of in the versioning | |
5429 | script. This was done mainly to reduce the burden on the library | |
5430 | maintainer. You can do this by putting something like: | |
5431 | @smallexample | |
5432 | __asm__(".symver original_foo,foo@@VERS_1.1"); | |
5433 | @end smallexample | |
5434 | @noindent | |
5435 | in the C source file. This renames the function @samp{original_foo} to | |
5436 | be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}. | |
5437 | The @samp{local:} directive can be used to prevent the symbol | |
96a94295 L |
5438 | @samp{original_foo} from being exported. A @samp{.symver} directive |
5439 | takes precedence over a version script. | |
252b5132 RH |
5440 | |
5441 | The second GNU extension is to allow multiple versions of the same | |
5442 | function to appear in a given shared library. In this way you can make | |
5443 | an incompatible change to an interface without increasing the major | |
5444 | version number of the shared library, while still allowing applications | |
5445 | linked against the old interface to continue to function. | |
5446 | ||
5447 | To do this, you must use multiple @samp{.symver} directives in the | |
5448 | source file. Here is an example: | |
5449 | ||
5450 | @smallexample | |
5451 | __asm__(".symver original_foo,foo@@"); | |
5452 | __asm__(".symver old_foo,foo@@VERS_1.1"); | |
5453 | __asm__(".symver old_foo1,foo@@VERS_1.2"); | |
5454 | __asm__(".symver new_foo,foo@@@@VERS_2.0"); | |
5455 | @end smallexample | |
5456 | ||
5457 | In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the | |
5458 | unspecified base version of the symbol. The source file that contains this | |
5459 | example would define 4 C functions: @samp{original_foo}, @samp{old_foo}, | |
5460 | @samp{old_foo1}, and @samp{new_foo}. | |
5461 | ||
5462 | When you have multiple definitions of a given symbol, there needs to be | |
5463 | some way to specify a default version to which external references to | |
5464 | this symbol will be bound. You can do this with the | |
5465 | @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only | |
5466 | declare one version of a symbol as the default in this manner; otherwise | |
5467 | you would effectively have multiple definitions of the same symbol. | |
5468 | ||
5469 | If you wish to bind a reference to a specific version of the symbol | |
5470 | within the shared library, you can use the aliases of convenience | |
36f63dca | 5471 | (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to |
252b5132 RH |
5472 | specifically bind to an external version of the function in question. |
5473 | ||
cb840a31 L |
5474 | You can also specify the language in the version script: |
5475 | ||
5476 | @smallexample | |
5477 | VERSION extern "lang" @{ version-script-commands @} | |
5478 | @end smallexample | |
5479 | ||
c0065db7 | 5480 | The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}. |
cb840a31 L |
5481 | The linker will iterate over the list of symbols at the link time and |
5482 | demangle them according to @samp{lang} before matching them to the | |
bb1515f2 MF |
5483 | patterns specified in @samp{version-script-commands}. The default |
5484 | @samp{lang} is @samp{C}. | |
cb840a31 | 5485 | |
86043bbb MM |
5486 | Demangled names may contains spaces and other special characters. As |
5487 | described above, you can use a glob pattern to match demangled names, | |
5488 | or you can use a double-quoted string to match the string exactly. In | |
5489 | the latter case, be aware that minor differences (such as differing | |
5490 | whitespace) between the version script and the demangler output will | |
5491 | cause a mismatch. As the exact string generated by the demangler | |
5492 | might change in the future, even if the mangled name does not, you | |
5493 | should check that all of your version directives are behaving as you | |
5494 | expect when you upgrade. | |
5495 | ||
252b5132 RH |
5496 | @node Expressions |
5497 | @section Expressions in Linker Scripts | |
5498 | @cindex expressions | |
5499 | @cindex arithmetic | |
5500 | The syntax for expressions in the linker script language is identical to | |
5501 | that of C expressions. All expressions are evaluated as integers. All | |
5502 | expressions are evaluated in the same size, which is 32 bits if both the | |
5503 | host and target are 32 bits, and is otherwise 64 bits. | |
5504 | ||
5505 | You can use and set symbol values in expressions. | |
5506 | ||
5507 | The linker defines several special purpose builtin functions for use in | |
5508 | expressions. | |
5509 | ||
5510 | @menu | |
5511 | * Constants:: Constants | |
0c71d759 | 5512 | * Symbolic Constants:: Symbolic constants |
252b5132 | 5513 | * Symbols:: Symbol Names |
ecca9871 | 5514 | * Orphan Sections:: Orphan Sections |
252b5132 RH |
5515 | * Location Counter:: The Location Counter |
5516 | * Operators:: Operators | |
5517 | * Evaluation:: Evaluation | |
5518 | * Expression Section:: The Section of an Expression | |
5519 | * Builtin Functions:: Builtin Functions | |
5520 | @end menu | |
5521 | ||
5522 | @node Constants | |
5523 | @subsection Constants | |
5524 | @cindex integer notation | |
5525 | @cindex constants in linker scripts | |
5526 | All constants are integers. | |
5527 | ||
5528 | As in C, the linker considers an integer beginning with @samp{0} to be | |
5529 | octal, and an integer beginning with @samp{0x} or @samp{0X} to be | |
8a308ae8 | 5530 | hexadecimal. Alternatively the linker accepts suffixes of @samp{h} or |
11e7fd74 | 5531 | @samp{H} for hexadecimal, @samp{o} or @samp{O} for octal, @samp{b} or |
8a308ae8 NC |
5532 | @samp{B} for binary and @samp{d} or @samp{D} for decimal. Any integer |
5533 | value without a prefix or a suffix is considered to be decimal. | |
252b5132 RH |
5534 | |
5535 | @cindex scaled integers | |
5536 | @cindex K and M integer suffixes | |
5537 | @cindex M and K integer suffixes | |
5538 | @cindex suffixes for integers | |
5539 | @cindex integer suffixes | |
5540 | In addition, you can use the suffixes @code{K} and @code{M} to scale a | |
5541 | constant by | |
5542 | @c TEXI2ROFF-KILL | |
36f63dca | 5543 | @ifnottex |
252b5132 RH |
5544 | @c END TEXI2ROFF-KILL |
5545 | @code{1024} or @code{1024*1024} | |
5546 | @c TEXI2ROFF-KILL | |
36f63dca | 5547 | @end ifnottex |
252b5132 RH |
5548 | @tex |
5549 | ${\rm 1024}$ or ${\rm 1024}^2$ | |
5550 | @end tex | |
5551 | @c END TEXI2ROFF-KILL | |
8a308ae8 NC |
5552 | respectively. For example, the following |
5553 | all refer to the same quantity: | |
5554 | ||
252b5132 | 5555 | @smallexample |
36f63dca NC |
5556 | _fourk_1 = 4K; |
5557 | _fourk_2 = 4096; | |
5558 | _fourk_3 = 0x1000; | |
8a308ae8 | 5559 | _fourk_4 = 10000o; |
252b5132 RH |
5560 | @end smallexample |
5561 | ||
8a308ae8 NC |
5562 | Note - the @code{K} and @code{M} suffixes cannot be used in |
5563 | conjunction with the base suffixes mentioned above. | |
5564 | ||
0c71d759 NC |
5565 | @node Symbolic Constants |
5566 | @subsection Symbolic Constants | |
5567 | @cindex symbolic constants | |
5568 | @kindex CONSTANT | |
5569 | It is possible to refer to target specific constants via the use of | |
5570 | the @code{CONSTANT(@var{name})} operator, where @var{name} is one of: | |
5571 | ||
5572 | @table @code | |
5573 | @item MAXPAGESIZE | |
5574 | @kindex MAXPAGESIZE | |
5575 | The target's maximum page size. | |
5576 | ||
5577 | @item COMMONPAGESIZE | |
5578 | @kindex COMMONPAGESIZE | |
5579 | The target's default page size. | |
5580 | @end table | |
5581 | ||
5582 | So for example: | |
5583 | ||
5584 | @smallexample | |
9d5777a3 | 5585 | .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @} |
0c71d759 NC |
5586 | @end smallexample |
5587 | ||
5588 | will create a text section aligned to the largest page boundary | |
5589 | supported by the target. | |
5590 | ||
252b5132 RH |
5591 | @node Symbols |
5592 | @subsection Symbol Names | |
5593 | @cindex symbol names | |
5594 | @cindex names | |
5595 | @cindex quoted symbol names | |
5596 | @kindex " | |
5597 | Unless quoted, symbol names start with a letter, underscore, or period | |
5598 | and may include letters, digits, underscores, periods, and hyphens. | |
5599 | Unquoted symbol names must not conflict with any keywords. You can | |
5600 | specify a symbol which contains odd characters or has the same name as a | |
5601 | keyword by surrounding the symbol name in double quotes: | |
5602 | @smallexample | |
36f63dca NC |
5603 | "SECTION" = 9; |
5604 | "with a space" = "also with a space" + 10; | |
252b5132 RH |
5605 | @end smallexample |
5606 | ||
5607 | Since symbols can contain many non-alphabetic characters, it is safest | |
5608 | to delimit symbols with spaces. For example, @samp{A-B} is one symbol, | |
5609 | whereas @samp{A - B} is an expression involving subtraction. | |
5610 | ||
ecca9871 L |
5611 | @node Orphan Sections |
5612 | @subsection Orphan Sections | |
5613 | @cindex orphan | |
5614 | Orphan sections are sections present in the input files which | |
5615 | are not explicitly placed into the output file by the linker | |
5616 | script. The linker will still copy these sections into the | |
5617 | output file, but it has to guess as to where they should be | |
5618 | placed. The linker uses a simple heuristic to do this. It | |
5619 | attempts to place orphan sections after non-orphan sections of the | |
5620 | same attribute, such as code vs data, loadable vs non-loadable, etc. | |
5621 | If there is not enough room to do this then it places | |
5622 | at the end of the file. | |
5623 | ||
5624 | For ELF targets, the attribute of the section includes section type as | |
5625 | well as section flag. | |
5626 | ||
c005eb9e AB |
5627 | The command line options @samp{--orphan-handling} and @samp{--unique} |
5628 | (@pxref{Options,,Command Line Options}) can be used to control which | |
5629 | output sections an orphan is placed in. | |
5630 | ||
41911f68 | 5631 | If an orphaned section's name is representable as a C identifier then |
a61ca861 | 5632 | the linker will automatically @pxref{PROVIDE} two symbols: |
9aec8434 | 5633 | __start_SECNAME and __stop_SECNAME, where SECNAME is the name of the |
41911f68 NC |
5634 | section. These indicate the start address and end address of the |
5635 | orphaned section respectively. Note: most section names are not | |
5636 | representable as C identifiers because they contain a @samp{.} | |
5637 | character. | |
5638 | ||
252b5132 RH |
5639 | @node Location Counter |
5640 | @subsection The Location Counter | |
5641 | @kindex . | |
5642 | @cindex dot | |
5643 | @cindex location counter | |
5644 | @cindex current output location | |
5645 | The special linker variable @dfn{dot} @samp{.} always contains the | |
5646 | current output location counter. Since the @code{.} always refers to a | |
5647 | location in an output section, it may only appear in an expression | |
5648 | within a @code{SECTIONS} command. The @code{.} symbol may appear | |
5649 | anywhere that an ordinary symbol is allowed in an expression. | |
5650 | ||
5651 | @cindex holes | |
5652 | Assigning a value to @code{.} will cause the location counter to be | |
5653 | moved. This may be used to create holes in the output section. The | |
dc0b6aa0 AM |
5654 | location counter may not be moved backwards inside an output section, |
5655 | and may not be moved backwards outside of an output section if so | |
5656 | doing creates areas with overlapping LMAs. | |
252b5132 RH |
5657 | |
5658 | @smallexample | |
5659 | SECTIONS | |
5660 | @{ | |
5661 | output : | |
5662 | @{ | |
5663 | file1(.text) | |
5664 | . = . + 1000; | |
5665 | file2(.text) | |
5666 | . += 1000; | |
5667 | file3(.text) | |
563e308f | 5668 | @} = 0x12345678; |
252b5132 RH |
5669 | @} |
5670 | @end smallexample | |
5671 | @noindent | |
5672 | In the previous example, the @samp{.text} section from @file{file1} is | |
5673 | located at the beginning of the output section @samp{output}. It is | |
5674 | followed by a 1000 byte gap. Then the @samp{.text} section from | |
5675 | @file{file2} appears, also with a 1000 byte gap following before the | |
563e308f | 5676 | @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678} |
252b5132 RH |
5677 | specifies what data to write in the gaps (@pxref{Output Section Fill}). |
5678 | ||
5c6bbab8 NC |
5679 | @cindex dot inside sections |
5680 | Note: @code{.} actually refers to the byte offset from the start of the | |
5681 | current containing object. Normally this is the @code{SECTIONS} | |
69da35b5 | 5682 | statement, whose start address is 0, hence @code{.} can be used as an |
5c6bbab8 NC |
5683 | absolute address. If @code{.} is used inside a section description |
5684 | however, it refers to the byte offset from the start of that section, | |
5685 | not an absolute address. Thus in a script like this: | |
5686 | ||
5687 | @smallexample | |
5688 | SECTIONS | |
5689 | @{ | |
5690 | . = 0x100 | |
5691 | .text: @{ | |
5692 | *(.text) | |
5693 | . = 0x200 | |
5694 | @} | |
5695 | . = 0x500 | |
5696 | .data: @{ | |
5697 | *(.data) | |
5698 | . += 0x600 | |
5699 | @} | |
5700 | @} | |
5701 | @end smallexample | |
5702 | ||
5703 | The @samp{.text} section will be assigned a starting address of 0x100 | |
5704 | and a size of exactly 0x200 bytes, even if there is not enough data in | |
5705 | the @samp{.text} input sections to fill this area. (If there is too | |
5706 | much data, an error will be produced because this would be an attempt to | |
5707 | move @code{.} backwards). The @samp{.data} section will start at 0x500 | |
5708 | and it will have an extra 0x600 bytes worth of space after the end of | |
5709 | the values from the @samp{.data} input sections and before the end of | |
5710 | the @samp{.data} output section itself. | |
5711 | ||
b5666f2f AM |
5712 | @cindex dot outside sections |
5713 | Setting symbols to the value of the location counter outside of an | |
5714 | output section statement can result in unexpected values if the linker | |
5715 | needs to place orphan sections. For example, given the following: | |
5716 | ||
5717 | @smallexample | |
5718 | SECTIONS | |
5719 | @{ | |
5720 | start_of_text = . ; | |
5721 | .text: @{ *(.text) @} | |
5722 | end_of_text = . ; | |
5723 | ||
5724 | start_of_data = . ; | |
5725 | .data: @{ *(.data) @} | |
5726 | end_of_data = . ; | |
5727 | @} | |
5728 | @end smallexample | |
5729 | ||
5730 | If the linker needs to place some input section, e.g. @code{.rodata}, | |
5731 | not mentioned in the script, it might choose to place that section | |
5732 | between @code{.text} and @code{.data}. You might think the linker | |
5733 | should place @code{.rodata} on the blank line in the above script, but | |
5734 | blank lines are of no particular significance to the linker. As well, | |
5735 | the linker doesn't associate the above symbol names with their | |
5736 | sections. Instead, it assumes that all assignments or other | |
5737 | statements belong to the previous output section, except for the | |
5738 | special case of an assignment to @code{.}. I.e., the linker will | |
5739 | place the orphan @code{.rodata} section as if the script was written | |
5740 | as follows: | |
5741 | ||
5742 | @smallexample | |
5743 | SECTIONS | |
5744 | @{ | |
5745 | start_of_text = . ; | |
5746 | .text: @{ *(.text) @} | |
5747 | end_of_text = . ; | |
5748 | ||
5749 | start_of_data = . ; | |
5750 | .rodata: @{ *(.rodata) @} | |
5751 | .data: @{ *(.data) @} | |
5752 | end_of_data = . ; | |
5753 | @} | |
5754 | @end smallexample | |
5755 | ||
5756 | This may or may not be the script author's intention for the value of | |
5757 | @code{start_of_data}. One way to influence the orphan section | |
5758 | placement is to assign the location counter to itself, as the linker | |
5759 | assumes that an assignment to @code{.} is setting the start address of | |
5760 | a following output section and thus should be grouped with that | |
5761 | section. So you could write: | |
5762 | ||
5763 | @smallexample | |
5764 | SECTIONS | |
5765 | @{ | |
5766 | start_of_text = . ; | |
5767 | .text: @{ *(.text) @} | |
5768 | end_of_text = . ; | |
5769 | ||
5770 | . = . ; | |
5771 | start_of_data = . ; | |
5772 | .data: @{ *(.data) @} | |
5773 | end_of_data = . ; | |
5774 | @} | |
5775 | @end smallexample | |
5776 | ||
5777 | Now, the orphan @code{.rodata} section will be placed between | |
5778 | @code{end_of_text} and @code{start_of_data}. | |
5779 | ||
252b5132 RH |
5780 | @need 2000 |
5781 | @node Operators | |
5782 | @subsection Operators | |
5783 | @cindex operators for arithmetic | |
5784 | @cindex arithmetic operators | |
5785 | @cindex precedence in expressions | |
5786 | The linker recognizes the standard C set of arithmetic operators, with | |
5787 | the standard bindings and precedence levels: | |
5788 | @c TEXI2ROFF-KILL | |
36f63dca | 5789 | @ifnottex |
252b5132 RH |
5790 | @c END TEXI2ROFF-KILL |
5791 | @smallexample | |
5792 | precedence associativity Operators Notes | |
5793 | (highest) | |
5794 | 1 left ! - ~ (1) | |
5795 | 2 left * / % | |
5796 | 3 left + - | |
5797 | 4 left >> << | |
5798 | 5 left == != > < <= >= | |
5799 | 6 left & | |
5800 | 7 left | | |
5801 | 8 left && | |
5802 | 9 left || | |
5803 | 10 right ? : | |
5804 | 11 right &= += -= *= /= (2) | |
5805 | (lowest) | |
5806 | @end smallexample | |
5807 | Notes: | |
a1ab1d2a | 5808 | (1) Prefix operators |
252b5132 RH |
5809 | (2) @xref{Assignments}. |
5810 | @c TEXI2ROFF-KILL | |
36f63dca | 5811 | @end ifnottex |
252b5132 RH |
5812 | @tex |
5813 | \vskip \baselineskip | |
5814 | %"lispnarrowing" is the extra indent used generally for smallexample | |
5815 | \hskip\lispnarrowing\vbox{\offinterlineskip | |
5816 | \hrule | |
5817 | \halign | |
5818 | {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr | |
5819 | height2pt&\omit&&\omit&&\omit&\cr | |
5820 | &Precedence&& Associativity &&{\rm Operators}&\cr | |
5821 | height2pt&\omit&&\omit&&\omit&\cr | |
5822 | \noalign{\hrule} | |
5823 | height2pt&\omit&&\omit&&\omit&\cr | |
5824 | &highest&&&&&\cr | |
5825 | % '176 is tilde, '~' in tt font | |
a1ab1d2a | 5826 | &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr |
252b5132 RH |
5827 | &2&&left&&* / \%&\cr |
5828 | &3&&left&&+ -&\cr | |
5829 | &4&&left&&>> <<&\cr | |
5830 | &5&&left&&== != > < <= >=&\cr | |
5831 | &6&&left&&\&&\cr | |
5832 | &7&&left&&|&\cr | |
5833 | &8&&left&&{\&\&}&\cr | |
5834 | &9&&left&&||&\cr | |
5835 | &10&&right&&? :&\cr | |
5836 | &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr | |
5837 | &lowest&&&&&\cr | |
5838 | height2pt&\omit&&\omit&&\omit&\cr} | |
5839 | \hrule} | |
5840 | @end tex | |
5841 | @iftex | |
5842 | { | |
5843 | @obeylines@parskip=0pt@parindent=0pt | |
5844 | @dag@quad Prefix operators. | |
5845 | @ddag@quad @xref{Assignments}. | |
5846 | } | |
5847 | @end iftex | |
5848 | @c END TEXI2ROFF-KILL | |
5849 | ||
5850 | @node Evaluation | |
5851 | @subsection Evaluation | |
5852 | @cindex lazy evaluation | |
5853 | @cindex expression evaluation order | |
5854 | The linker evaluates expressions lazily. It only computes the value of | |
5855 | an expression when absolutely necessary. | |
5856 | ||
5857 | The linker needs some information, such as the value of the start | |
5858 | address of the first section, and the origins and lengths of memory | |
5859 | regions, in order to do any linking at all. These values are computed | |
5860 | as soon as possible when the linker reads in the linker script. | |
5861 | ||
5862 | However, other values (such as symbol values) are not known or needed | |
5863 | until after storage allocation. Such values are evaluated later, when | |
5864 | other information (such as the sizes of output sections) is available | |
5865 | for use in the symbol assignment expression. | |
5866 | ||
5867 | The sizes of sections cannot be known until after allocation, so | |
5868 | assignments dependent upon these are not performed until after | |
5869 | allocation. | |
5870 | ||
5871 | Some expressions, such as those depending upon the location counter | |
5872 | @samp{.}, must be evaluated during section allocation. | |
5873 | ||
5874 | If the result of an expression is required, but the value is not | |
5875 | available, then an error results. For example, a script like the | |
5876 | following | |
5877 | @smallexample | |
5878 | @group | |
5879 | SECTIONS | |
5880 | @{ | |
a1ab1d2a | 5881 | .text 9+this_isnt_constant : |
252b5132 RH |
5882 | @{ *(.text) @} |
5883 | @} | |
5884 | @end group | |
5885 | @end smallexample | |
5886 | @noindent | |
5887 | will cause the error message @samp{non constant expression for initial | |
5888 | address}. | |
5889 | ||
5890 | @node Expression Section | |
5891 | @subsection The Section of an Expression | |
5892 | @cindex expression sections | |
5893 | @cindex absolute expressions | |
5894 | @cindex relative expressions | |
5895 | @cindex absolute and relocatable symbols | |
5896 | @cindex relocatable and absolute symbols | |
5897 | @cindex symbols, relocatable and absolute | |
7542af2a AM |
5898 | Addresses and symbols may be section relative, or absolute. A section |
5899 | relative symbol is relocatable. If you request relocatable output | |
5900 | using the @samp{-r} option, a further link operation may change the | |
5901 | value of a section relative symbol. On the other hand, an absolute | |
5902 | symbol will retain the same value throughout any further link | |
5903 | operations. | |
5904 | ||
abf4be64 AM |
5905 | Some terms in linker expressions are addresses. This is true of |
5906 | section relative symbols and for builtin functions that return an | |
5907 | address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and | |
5908 | @code{SEGMENT_START}. Other terms are simply numbers, or are builtin | |
5909 | functions that return a non-address value, such as @code{LENGTH}. | |
01554a74 AM |
5910 | One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")} |
5911 | (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated | |
5c3049d2 AM |
5912 | differently depending on their location, for compatibility with older |
5913 | versions of @code{ld}. Expressions appearing outside an output | |
5914 | section definition treat all numbers as absolute addresses. | |
5915 | Expressions appearing inside an output section definition treat | |
01554a74 AM |
5916 | absolute symbols as numbers. If @code{LD_FEATURE ("SANE_EXPR")} is |
5917 | given, then absolute symbols and numbers are simply treated as numbers | |
5918 | everywhere. | |
5c3049d2 AM |
5919 | |
5920 | In the following simple example, | |
252b5132 | 5921 | |
7542af2a AM |
5922 | @smallexample |
5923 | @group | |
5924 | SECTIONS | |
5925 | @{ | |
5926 | . = 0x100; | |
5927 | __executable_start = 0x100; | |
5928 | .data : | |
5929 | @{ | |
5930 | . = 0x10; | |
5931 | __data_start = 0x10; | |
5932 | *(.data) | |
5933 | @} | |
5934 | @dots{} | |
5935 | @} | |
5936 | @end group | |
5937 | @end smallexample | |
252b5132 | 5938 | |
7542af2a AM |
5939 | both @code{.} and @code{__executable_start} are set to the absolute |
5940 | address 0x100 in the first two assignments, then both @code{.} and | |
5941 | @code{__data_start} are set to 0x10 relative to the @code{.data} | |
5942 | section in the second two assignments. | |
252b5132 | 5943 | |
5c3049d2 AM |
5944 | For expressions involving numbers, relative addresses and absolute |
5945 | addresses, ld follows these rules to evaluate terms: | |
7542af2a AM |
5946 | |
5947 | @itemize @bullet | |
5948 | @item | |
c05f749e AM |
5949 | Unary operations on an absolute address or number, and binary |
5950 | operations on two absolute addresses or two numbers, or between one | |
5951 | absolute address and a number, apply the operator to the value(s). | |
5952 | @item | |
7542af2a AM |
5953 | Unary operations on a relative address, and binary operations on two |
5954 | relative addresses in the same section or between one relative address | |
5955 | and a number, apply the operator to the offset part of the address(es). | |
5956 | @item | |
c05f749e AM |
5957 | Other binary operations, that is, between two relative addresses not |
5958 | in the same section, or between a relative address and an absolute | |
5959 | address, first convert any non-absolute term to an absolute address | |
5960 | before applying the operator. | |
7542af2a AM |
5961 | @end itemize |
5962 | ||
5963 | The result section of each sub-expression is as follows: | |
5964 | ||
5965 | @itemize @bullet | |
5966 | @item | |
5967 | An operation involving only numbers results in a number. | |
5968 | @item | |
5969 | The result of comparisons, @samp{&&} and @samp{||} is also a number. | |
5970 | @item | |
9bc8bb33 | 5971 | The result of other binary arithmetic and logical operations on two |
11e7fd74 | 5972 | relative addresses in the same section or two absolute addresses |
9bc8bb33 AM |
5973 | (after above conversions) is also a number. |
5974 | @item | |
5975 | The result of other operations on relative addresses or one | |
5976 | relative address and a number, is a relative address in the same | |
5977 | section as the relative operand(s). | |
7542af2a AM |
5978 | @item |
5979 | The result of other operations on absolute addresses (after above | |
5980 | conversions) is an absolute address. | |
5981 | @end itemize | |
252b5132 RH |
5982 | |
5983 | You can use the builtin function @code{ABSOLUTE} to force an expression | |
5984 | to be absolute when it would otherwise be relative. For example, to | |
5985 | create an absolute symbol set to the address of the end of the output | |
5986 | section @samp{.data}: | |
5987 | @smallexample | |
5988 | SECTIONS | |
5989 | @{ | |
5990 | .data : @{ *(.data) _edata = ABSOLUTE(.); @} | |
5991 | @} | |
5992 | @end smallexample | |
5993 | @noindent | |
5994 | If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the | |
5995 | @samp{.data} section. | |
5996 | ||
7542af2a AM |
5997 | Using @code{LOADADDR} also forces an expression absolute, since this |
5998 | particular builtin function returns an absolute address. | |
5999 | ||
252b5132 RH |
6000 | @node Builtin Functions |
6001 | @subsection Builtin Functions | |
6002 | @cindex functions in expressions | |
6003 | The linker script language includes a number of builtin functions for | |
6004 | use in linker script expressions. | |
6005 | ||
6006 | @table @code | |
6007 | @item ABSOLUTE(@var{exp}) | |
6008 | @kindex ABSOLUTE(@var{exp}) | |
6009 | @cindex expression, absolute | |
6010 | Return the absolute (non-relocatable, as opposed to non-negative) value | |
6011 | of the expression @var{exp}. Primarily useful to assign an absolute | |
6012 | value to a symbol within a section definition, where symbol values are | |
6013 | normally section relative. @xref{Expression Section}. | |
6014 | ||
6015 | @item ADDR(@var{section}) | |
6016 | @kindex ADDR(@var{section}) | |
6017 | @cindex section address in expression | |
7542af2a | 6018 | Return the address (VMA) of the named @var{section}. Your |
252b5132 | 6019 | script must previously have defined the location of that section. In |
7542af2a AM |
6020 | the following example, @code{start_of_output_1}, @code{symbol_1} and |
6021 | @code{symbol_2} are assigned equivalent values, except that | |
6022 | @code{symbol_1} will be relative to the @code{.output1} section while | |
6023 | the other two will be absolute: | |
252b5132 RH |
6024 | @smallexample |
6025 | @group | |
6026 | SECTIONS @{ @dots{} | |
6027 | .output1 : | |
a1ab1d2a | 6028 | @{ |
252b5132 RH |
6029 | start_of_output_1 = ABSOLUTE(.); |
6030 | @dots{} | |
6031 | @} | |
6032 | .output : | |
6033 | @{ | |
6034 | symbol_1 = ADDR(.output1); | |
6035 | symbol_2 = start_of_output_1; | |
6036 | @} | |
6037 | @dots{} @} | |
6038 | @end group | |
6039 | @end smallexample | |
6040 | ||
876f4090 NS |
6041 | @item ALIGN(@var{align}) |
6042 | @itemx ALIGN(@var{exp},@var{align}) | |
6043 | @kindex ALIGN(@var{align}) | |
6044 | @kindex ALIGN(@var{exp},@var{align}) | |
252b5132 RH |
6045 | @cindex round up location counter |
6046 | @cindex align location counter | |
876f4090 NS |
6047 | @cindex round up expression |
6048 | @cindex align expression | |
6049 | Return the location counter (@code{.}) or arbitrary expression aligned | |
6050 | to the next @var{align} boundary. The single operand @code{ALIGN} | |
6051 | doesn't change the value of the location counter---it just does | |
6052 | arithmetic on it. The two operand @code{ALIGN} allows an arbitrary | |
6053 | expression to be aligned upwards (@code{ALIGN(@var{align})} is | |
e0a3af22 | 6054 | equivalent to @code{ALIGN(ABSOLUTE(.), @var{align})}). |
876f4090 NS |
6055 | |
6056 | Here is an example which aligns the output @code{.data} section to the | |
6057 | next @code{0x2000} byte boundary after the preceding section and sets a | |
6058 | variable within the section to the next @code{0x8000} boundary after the | |
6059 | input sections: | |
252b5132 RH |
6060 | @smallexample |
6061 | @group | |
6062 | SECTIONS @{ @dots{} | |
6063 | .data ALIGN(0x2000): @{ | |
6064 | *(.data) | |
6065 | variable = ALIGN(0x8000); | |
6066 | @} | |
6067 | @dots{} @} | |
6068 | @end group | |
6069 | @end smallexample | |
6070 | @noindent | |
6071 | The first use of @code{ALIGN} in this example specifies the location of | |
6072 | a section because it is used as the optional @var{address} attribute of | |
6073 | a section definition (@pxref{Output Section Address}). The second use | |
6074 | of @code{ALIGN} is used to defines the value of a symbol. | |
6075 | ||
6076 | The builtin function @code{NEXT} is closely related to @code{ALIGN}. | |
6077 | ||
362c1d1a NS |
6078 | @item ALIGNOF(@var{section}) |
6079 | @kindex ALIGNOF(@var{section}) | |
6080 | @cindex section alignment | |
6081 | Return the alignment in bytes of the named @var{section}, if that section has | |
6082 | been allocated. If the section has not been allocated when this is | |
6083 | evaluated, the linker will report an error. In the following example, | |
6084 | the alignment of the @code{.output} section is stored as the first | |
6085 | value in that section. | |
6086 | @smallexample | |
6087 | @group | |
6088 | SECTIONS@{ @dots{} | |
6089 | .output @{ | |
6090 | LONG (ALIGNOF (.output)) | |
6091 | @dots{} | |
6092 | @} | |
6093 | @dots{} @} | |
6094 | @end group | |
6095 | @end smallexample | |
6096 | ||
252b5132 RH |
6097 | @item BLOCK(@var{exp}) |
6098 | @kindex BLOCK(@var{exp}) | |
6099 | This is a synonym for @code{ALIGN}, for compatibility with older linker | |
6100 | scripts. It is most often seen when setting the address of an output | |
6101 | section. | |
6102 | ||
2d20f7bf JJ |
6103 | @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) |
6104 | @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) | |
6105 | This is equivalent to either | |
6106 | @smallexample | |
6107 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1))) | |
6108 | @end smallexample | |
6109 | or | |
6110 | @smallexample | |
fe6052e1 AM |
6111 | (ALIGN(@var{maxpagesize}) |
6112 | + ((. + @var{commonpagesize} - 1) & (@var{maxpagesize} - @var{commonpagesize}))) | |
2d20f7bf JJ |
6113 | @end smallexample |
6114 | @noindent | |
6115 | depending on whether the latter uses fewer @var{commonpagesize} sized pages | |
6116 | for the data segment (area between the result of this expression and | |
6117 | @code{DATA_SEGMENT_END}) than the former or not. | |
6118 | If the latter form is used, it means @var{commonpagesize} bytes of runtime | |
6119 | memory will be saved at the expense of up to @var{commonpagesize} wasted | |
6120 | bytes in the on-disk file. | |
6121 | ||
6122 | This expression can only be used directly in @code{SECTIONS} commands, not in | |
6123 | any output section descriptions and only once in the linker script. | |
6124 | @var{commonpagesize} should be less or equal to @var{maxpagesize} and should | |
6125 | be the system page size the object wants to be optimized for (while still | |
6126 | working on system page sizes up to @var{maxpagesize}). | |
6127 | ||
6128 | @noindent | |
6129 | Example: | |
6130 | @smallexample | |
6131 | . = DATA_SEGMENT_ALIGN(0x10000, 0x2000); | |
6132 | @end smallexample | |
6133 | ||
6134 | @item DATA_SEGMENT_END(@var{exp}) | |
6135 | @kindex DATA_SEGMENT_END(@var{exp}) | |
6136 | This defines the end of data segment for @code{DATA_SEGMENT_ALIGN} | |
6137 | evaluation purposes. | |
6138 | ||
6139 | @smallexample | |
6140 | . = DATA_SEGMENT_END(.); | |
6141 | @end smallexample | |
6142 | ||
a4f5ad88 JJ |
6143 | @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) |
6144 | @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) | |
6145 | This defines the end of the @code{PT_GNU_RELRO} segment when | |
eec2f3ed | 6146 | @samp{-z relro} option is used. |
a4f5ad88 JJ |
6147 | When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END} |
6148 | does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that | |
6149 | @var{exp} + @var{offset} is aligned to the most commonly used page | |
6150 | boundary for particular target. If present in the linker script, | |
6151 | it must always come in between @code{DATA_SEGMENT_ALIGN} and | |
eec2f3ed AM |
6152 | @code{DATA_SEGMENT_END}. Evaluates to the second argument plus any |
6153 | padding needed at the end of the @code{PT_GNU_RELRO} segment due to | |
6154 | section alignment. | |
a4f5ad88 JJ |
6155 | |
6156 | @smallexample | |
6157 | . = DATA_SEGMENT_RELRO_END(24, .); | |
6158 | @end smallexample | |
6159 | ||
252b5132 RH |
6160 | @item DEFINED(@var{symbol}) |
6161 | @kindex DEFINED(@var{symbol}) | |
6162 | @cindex symbol defaults | |
6163 | Return 1 if @var{symbol} is in the linker global symbol table and is | |
420e579c HPN |
6164 | defined before the statement using DEFINED in the script, otherwise |
6165 | return 0. You can use this function to provide | |
252b5132 RH |
6166 | default values for symbols. For example, the following script fragment |
6167 | shows how to set a global symbol @samp{begin} to the first location in | |
6168 | the @samp{.text} section---but if a symbol called @samp{begin} already | |
6169 | existed, its value is preserved: | |
6170 | ||
6171 | @smallexample | |
6172 | @group | |
6173 | SECTIONS @{ @dots{} | |
6174 | .text : @{ | |
6175 | begin = DEFINED(begin) ? begin : . ; | |
6176 | @dots{} | |
6177 | @} | |
6178 | @dots{} | |
6179 | @} | |
6180 | @end group | |
6181 | @end smallexample | |
6182 | ||
3ec57632 NC |
6183 | @item LENGTH(@var{memory}) |
6184 | @kindex LENGTH(@var{memory}) | |
6185 | Return the length of the memory region named @var{memory}. | |
6186 | ||
252b5132 RH |
6187 | @item LOADADDR(@var{section}) |
6188 | @kindex LOADADDR(@var{section}) | |
6189 | @cindex section load address in expression | |
7542af2a | 6190 | Return the absolute LMA of the named @var{section}. (@pxref{Output |
252b5132 RH |
6191 | Section LMA}). |
6192 | ||
2e53f7d6 NC |
6193 | @item LOG2CEIL(@var{exp}) |
6194 | @kindex LOG2CEIL(@var{exp}) | |
6195 | Return the binary logarithm of @var{exp} rounded towards infinity. | |
6196 | @code{LOG2CEIL(0)} returns 0. | |
6197 | ||
252b5132 RH |
6198 | @kindex MAX |
6199 | @item MAX(@var{exp1}, @var{exp2}) | |
6200 | Returns the maximum of @var{exp1} and @var{exp2}. | |
6201 | ||
6202 | @kindex MIN | |
6203 | @item MIN(@var{exp1}, @var{exp2}) | |
6204 | Returns the minimum of @var{exp1} and @var{exp2}. | |
6205 | ||
6206 | @item NEXT(@var{exp}) | |
6207 | @kindex NEXT(@var{exp}) | |
6208 | @cindex unallocated address, next | |
6209 | Return the next unallocated address that is a multiple of @var{exp}. | |
6210 | This function is closely related to @code{ALIGN(@var{exp})}; unless you | |
6211 | use the @code{MEMORY} command to define discontinuous memory for the | |
6212 | output file, the two functions are equivalent. | |
6213 | ||
3ec57632 NC |
6214 | @item ORIGIN(@var{memory}) |
6215 | @kindex ORIGIN(@var{memory}) | |
6216 | Return the origin of the memory region named @var{memory}. | |
6217 | ||
ba916c8a MM |
6218 | @item SEGMENT_START(@var{segment}, @var{default}) |
6219 | @kindex SEGMENT_START(@var{segment}, @var{default}) | |
6220 | Return the base address of the named @var{segment}. If an explicit | |
c5da8c7d NC |
6221 | value has already been given for this segment (with a command-line |
6222 | @samp{-T} option) then that value will be returned otherwise the value | |
6223 | will be @var{default}. At present, the @samp{-T} command-line option | |
6224 | can only be used to set the base address for the ``text'', ``data'', and | |
7542af2a | 6225 | ``bss'' sections, but you can use @code{SEGMENT_START} with any segment |
ba916c8a MM |
6226 | name. |
6227 | ||
252b5132 RH |
6228 | @item SIZEOF(@var{section}) |
6229 | @kindex SIZEOF(@var{section}) | |
6230 | @cindex section size | |
6231 | Return the size in bytes of the named @var{section}, if that section has | |
6232 | been allocated. If the section has not been allocated when this is | |
6233 | evaluated, the linker will report an error. In the following example, | |
6234 | @code{symbol_1} and @code{symbol_2} are assigned identical values: | |
6235 | @smallexample | |
6236 | @group | |
6237 | SECTIONS@{ @dots{} | |
6238 | .output @{ | |
6239 | .start = . ; | |
6240 | @dots{} | |
6241 | .end = . ; | |
6242 | @} | |
6243 | symbol_1 = .end - .start ; | |
6244 | symbol_2 = SIZEOF(.output); | |
6245 | @dots{} @} | |
6246 | @end group | |
6247 | @end smallexample | |
6248 | ||
6249 | @item SIZEOF_HEADERS | |
6250 | @itemx sizeof_headers | |
6251 | @kindex SIZEOF_HEADERS | |
6252 | @cindex header size | |
6253 | Return the size in bytes of the output file's headers. This is | |
6254 | information which appears at the start of the output file. You can use | |
6255 | this number when setting the start address of the first section, if you | |
6256 | choose, to facilitate paging. | |
6257 | ||
6258 | @cindex not enough room for program headers | |
6259 | @cindex program headers, not enough room | |
6260 | When producing an ELF output file, if the linker script uses the | |
6261 | @code{SIZEOF_HEADERS} builtin function, the linker must compute the | |
6262 | number of program headers before it has determined all the section | |
6263 | addresses and sizes. If the linker later discovers that it needs | |
6264 | additional program headers, it will report an error @samp{not enough | |
6265 | room for program headers}. To avoid this error, you must avoid using | |
6266 | the @code{SIZEOF_HEADERS} function, or you must rework your linker | |
6267 | script to avoid forcing the linker to use additional program headers, or | |
6268 | you must define the program headers yourself using the @code{PHDRS} | |
6269 | command (@pxref{PHDRS}). | |
6270 | @end table | |
6271 | ||
6272 | @node Implicit Linker Scripts | |
6273 | @section Implicit Linker Scripts | |
6274 | @cindex implicit linker scripts | |
6275 | If you specify a linker input file which the linker can not recognize as | |
6276 | an object file or an archive file, it will try to read the file as a | |
6277 | linker script. If the file can not be parsed as a linker script, the | |
6278 | linker will report an error. | |
6279 | ||
6280 | An implicit linker script will not replace the default linker script. | |
6281 | ||
6282 | Typically an implicit linker script would contain only symbol | |
6283 | assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION} | |
6284 | commands. | |
6285 | ||
6286 | Any input files read because of an implicit linker script will be read | |
6287 | at the position in the command line where the implicit linker script was | |
6288 | read. This can affect archive searching. | |
6289 | ||
6290 | @ifset GENERIC | |
6291 | @node Machine Dependent | |
6292 | @chapter Machine Dependent Features | |
6293 | ||
6294 | @cindex machine dependencies | |
ff5dcc92 SC |
6295 | @command{ld} has additional features on some platforms; the following |
6296 | sections describe them. Machines where @command{ld} has no additional | |
252b5132 RH |
6297 | functionality are not listed. |
6298 | ||
6299 | @menu | |
36f63dca NC |
6300 | @ifset H8300 |
6301 | * H8/300:: @command{ld} and the H8/300 | |
6302 | @end ifset | |
6303 | @ifset I960 | |
6304 | * i960:: @command{ld} and the Intel 960 family | |
6305 | @end ifset | |
7ca01ed9 NC |
6306 | @ifset M68HC11 |
6307 | * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families | |
6308 | @end ifset | |
36f63dca NC |
6309 | @ifset ARM |
6310 | * ARM:: @command{ld} and the ARM family | |
6311 | @end ifset | |
6312 | @ifset HPPA | |
6313 | * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF | |
6314 | @end ifset | |
7fb9f789 NC |
6315 | @ifset M68K |
6316 | * M68K:: @command{ld} and the Motorola 68K family | |
6317 | @end ifset | |
833794fc MR |
6318 | @ifset MIPS |
6319 | * MIPS:: @command{ld} and the MIPS family | |
6320 | @end ifset | |
3c3bdf30 | 6321 | @ifset MMIX |
36f63dca | 6322 | * MMIX:: @command{ld} and MMIX |
3c3bdf30 | 6323 | @end ifset |
2469cfa2 | 6324 | @ifset MSP430 |
36f63dca | 6325 | * MSP430:: @command{ld} and MSP430 |
2469cfa2 | 6326 | @end ifset |
35c08157 KLC |
6327 | @ifset NDS32 |
6328 | * NDS32:: @command{ld} and NDS32 | |
6329 | @end ifset | |
78058a5e SL |
6330 | @ifset NIOSII |
6331 | * Nios II:: @command{ld} and the Altera Nios II | |
6332 | @end ifset | |
2a60a7a8 AM |
6333 | @ifset POWERPC |
6334 | * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support | |
6335 | @end ifset | |
6336 | @ifset POWERPC64 | |
6337 | * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support | |
6338 | @end ifset | |
49fa1e15 AM |
6339 | @ifset SPU |
6340 | * SPU ELF:: @command{ld} and SPU ELF Support | |
6341 | @end ifset | |
74459f0e | 6342 | @ifset TICOFF |
ff5dcc92 | 6343 | * TI COFF:: @command{ld} and TI COFF |
74459f0e | 6344 | @end ifset |
2ca22b03 NC |
6345 | @ifset WIN32 |
6346 | * WIN32:: @command{ld} and WIN32 (cygwin/mingw) | |
6347 | @end ifset | |
e0001a05 NC |
6348 | @ifset XTENSA |
6349 | * Xtensa:: @command{ld} and Xtensa Processors | |
6350 | @end ifset | |
252b5132 RH |
6351 | @end menu |
6352 | @end ifset | |
6353 | ||
252b5132 RH |
6354 | @ifset H8300 |
6355 | @ifclear GENERIC | |
6356 | @raisesections | |
6357 | @end ifclear | |
6358 | ||
6359 | @node H8/300 | |
ff5dcc92 | 6360 | @section @command{ld} and the H8/300 |
252b5132 RH |
6361 | |
6362 | @cindex H8/300 support | |
ff5dcc92 | 6363 | For the H8/300, @command{ld} can perform these global optimizations when |
252b5132 RH |
6364 | you specify the @samp{--relax} command-line option. |
6365 | ||
6366 | @table @emph | |
6367 | @cindex relaxing on H8/300 | |
6368 | @item relaxing address modes | |
ff5dcc92 | 6369 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose |
252b5132 RH |
6370 | targets are within eight bits, and turns them into eight-bit |
6371 | program-counter relative @code{bsr} and @code{bra} instructions, | |
6372 | respectively. | |
6373 | ||
6374 | @cindex synthesizing on H8/300 | |
6375 | @item synthesizing instructions | |
81f5558e | 6376 | @c FIXME: specifically mov.b, or any mov instructions really? -> mov.b only, at least on H8, H8H, H8S |
ff5dcc92 | 6377 | @command{ld} finds all @code{mov.b} instructions which use the |
252b5132 RH |
6378 | sixteen-bit absolute address form, but refer to the top |
6379 | page of memory, and changes them to use the eight-bit address form. | |
6380 | (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into | |
6381 | @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the | |
6382 | top page of memory). | |
1502569c | 6383 | |
81f5558e NC |
6384 | @command{ld} finds all @code{mov} instructions which use the register |
6385 | indirect with 32-bit displacement addressing mode, but use a small | |
6386 | displacement inside 16-bit displacement range, and changes them to use | |
6387 | the 16-bit displacement form. (That is: the linker turns @samp{mov.b | |
6388 | @code{@@}@var{d}:32,ERx} into @samp{mov.b @code{@@}@var{d}:16,ERx} | |
6389 | whenever the displacement @var{d} is in the 16 bit signed integer | |
6390 | range. Only implemented in ELF-format ld). | |
6391 | ||
1502569c | 6392 | @item bit manipulation instructions |
c0065db7 | 6393 | @command{ld} finds all bit manipulation instructions like @code{band, bclr, |
1502569c | 6394 | biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor} |
c0065db7 | 6395 | which use 32 bit and 16 bit absolute address form, but refer to the top |
1502569c NC |
6396 | page of memory, and changes them to use the 8 bit address form. |
6397 | (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into | |
c0065db7 | 6398 | @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in |
1502569c NC |
6399 | the top page of memory). |
6400 | ||
6401 | @item system control instructions | |
c0065db7 RM |
6402 | @command{ld} finds all @code{ldc.w, stc.w} instructions which use the |
6403 | 32 bit absolute address form, but refer to the top page of memory, and | |
1502569c NC |
6404 | changes them to use 16 bit address form. |
6405 | (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into | |
c0065db7 | 6406 | @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in |
1502569c | 6407 | the top page of memory). |
252b5132 RH |
6408 | @end table |
6409 | ||
6410 | @ifclear GENERIC | |
6411 | @lowersections | |
6412 | @end ifclear | |
6413 | @end ifset | |
6414 | ||
36f63dca | 6415 | @ifclear GENERIC |
c2dcd04e | 6416 | @ifset Renesas |
36f63dca | 6417 | @c This stuff is pointless to say unless you're especially concerned |
c2dcd04e NC |
6418 | @c with Renesas chips; don't enable it for generic case, please. |
6419 | @node Renesas | |
6420 | @chapter @command{ld} and Other Renesas Chips | |
36f63dca | 6421 | |
c2dcd04e NC |
6422 | @command{ld} also supports the Renesas (formerly Hitachi) H8/300H, |
6423 | H8/500, and SH chips. No special features, commands, or command-line | |
6424 | options are required for these chips. | |
36f63dca NC |
6425 | @end ifset |
6426 | @end ifclear | |
6427 | ||
6428 | @ifset I960 | |
6429 | @ifclear GENERIC | |
6430 | @raisesections | |
6431 | @end ifclear | |
6432 | ||
6433 | @node i960 | |
6434 | @section @command{ld} and the Intel 960 Family | |
6435 | ||
6436 | @cindex i960 support | |
6437 | ||
6438 | You can use the @samp{-A@var{architecture}} command line option to | |
6439 | specify one of the two-letter names identifying members of the 960 | |
6440 | family; the option specifies the desired output target, and warns of any | |
6441 | incompatible instructions in the input files. It also modifies the | |
6442 | linker's search strategy for archive libraries, to support the use of | |
6443 | libraries specific to each particular architecture, by including in the | |
6444 | search loop names suffixed with the string identifying the architecture. | |
6445 | ||
6446 | For example, if your @command{ld} command line included @w{@samp{-ACA}} as | |
6447 | well as @w{@samp{-ltry}}, the linker would look (in its built-in search | |
6448 | paths, and in any paths you specify with @samp{-L}) for a library with | |
6449 | the names | |
6450 | ||
6451 | @smallexample | |
6452 | @group | |
6453 | try | |
6454 | libtry.a | |
6455 | tryca | |
6456 | libtryca.a | |
6457 | @end group | |
6458 | @end smallexample | |
6459 | ||
6460 | @noindent | |
6461 | The first two possibilities would be considered in any event; the last | |
6462 | two are due to the use of @w{@samp{-ACA}}. | |
6463 | ||
6464 | You can meaningfully use @samp{-A} more than once on a command line, since | |
6465 | the 960 architecture family allows combination of target architectures; each | |
6466 | use will add another pair of name variants to search for when @w{@samp{-l}} | |
6467 | specifies a library. | |
6468 | ||
6469 | @cindex @option{--relax} on i960 | |
6470 | @cindex relaxing on i960 | |
6471 | @command{ld} supports the @samp{--relax} option for the i960 family. If | |
6472 | you specify @samp{--relax}, @command{ld} finds all @code{balx} and | |
6473 | @code{calx} instructions whose targets are within 24 bits, and turns | |
6474 | them into 24-bit program-counter relative @code{bal} and @code{cal} | |
6475 | instructions, respectively. @command{ld} also turns @code{cal} | |
6476 | instructions into @code{bal} instructions when it determines that the | |
6477 | target subroutine is a leaf routine (that is, the target subroutine does | |
6478 | not itself call any subroutines). | |
6479 | ||
6480 | @ifclear GENERIC | |
6481 | @lowersections | |
6482 | @end ifclear | |
6483 | @end ifset | |
6484 | ||
6485 | @ifset ARM | |
6486 | @ifclear GENERIC | |
6487 | @raisesections | |
6488 | @end ifclear | |
6489 | ||
93fd0973 SC |
6490 | @ifset M68HC11 |
6491 | @ifclear GENERIC | |
6492 | @raisesections | |
6493 | @end ifclear | |
6494 | ||
6495 | @node M68HC11/68HC12 | |
6496 | @section @command{ld} and the Motorola 68HC11 and 68HC12 families | |
6497 | ||
6498 | @cindex M68HC11 and 68HC12 support | |
6499 | ||
6500 | @subsection Linker Relaxation | |
6501 | ||
6502 | For the Motorola 68HC11, @command{ld} can perform these global | |
6503 | optimizations when you specify the @samp{--relax} command-line option. | |
6504 | ||
6505 | @table @emph | |
6506 | @cindex relaxing on M68HC11 | |
6507 | @item relaxing address modes | |
6508 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose | |
6509 | targets are within eight bits, and turns them into eight-bit | |
6510 | program-counter relative @code{bsr} and @code{bra} instructions, | |
6511 | respectively. | |
6512 | ||
6513 | @command{ld} also looks at all 16-bit extended addressing modes and | |
6514 | transforms them in a direct addressing mode when the address is in | |
6515 | page 0 (between 0 and 0x0ff). | |
6516 | ||
6517 | @item relaxing gcc instruction group | |
6518 | When @command{gcc} is called with @option{-mrelax}, it can emit group | |
6519 | of instructions that the linker can optimize to use a 68HC11 direct | |
6520 | addressing mode. These instructions consists of @code{bclr} or | |
6521 | @code{bset} instructions. | |
6522 | ||
6523 | @end table | |
6524 | ||
6525 | @subsection Trampoline Generation | |
6526 | ||
6527 | @cindex trampoline generation on M68HC11 | |
6528 | @cindex trampoline generation on M68HC12 | |
6529 | For 68HC11 and 68HC12, @command{ld} can generate trampoline code to | |
6530 | call a far function using a normal @code{jsr} instruction. The linker | |
c0065db7 | 6531 | will also change the relocation to some far function to use the |
93fd0973 SC |
6532 | trampoline address instead of the function address. This is typically the |
6533 | case when a pointer to a function is taken. The pointer will in fact | |
6534 | point to the function trampoline. | |
6535 | ||
6536 | @ifclear GENERIC | |
6537 | @lowersections | |
6538 | @end ifclear | |
6539 | @end ifset | |
6540 | ||
36f63dca | 6541 | @node ARM |
3674e28a | 6542 | @section @command{ld} and the ARM family |
36f63dca NC |
6543 | |
6544 | @cindex ARM interworking support | |
6545 | @kindex --support-old-code | |
6546 | For the ARM, @command{ld} will generate code stubs to allow functions calls | |
b45619c0 | 6547 | between ARM and Thumb code. These stubs only work with code that has |
36f63dca NC |
6548 | been compiled and assembled with the @samp{-mthumb-interwork} command |
6549 | line option. If it is necessary to link with old ARM object files or | |
6550 | libraries, which have not been compiled with the -mthumb-interwork | |
6551 | option then the @samp{--support-old-code} command line switch should be | |
6552 | given to the linker. This will make it generate larger stub functions | |
6553 | which will work with non-interworking aware ARM code. Note, however, | |
6554 | the linker does not support generating stubs for function calls to | |
6555 | non-interworking aware Thumb code. | |
6556 | ||
6557 | @cindex thumb entry point | |
6558 | @cindex entry point, thumb | |
6559 | @kindex --thumb-entry=@var{entry} | |
6560 | The @samp{--thumb-entry} switch is a duplicate of the generic | |
6561 | @samp{--entry} switch, in that it sets the program's starting address. | |
6562 | But it also sets the bottom bit of the address, so that it can be | |
6563 | branched to using a BX instruction, and the program will start | |
6564 | executing in Thumb mode straight away. | |
6565 | ||
ce11ba6c KT |
6566 | @cindex PE import table prefixing |
6567 | @kindex --use-nul-prefixed-import-tables | |
6568 | The @samp{--use-nul-prefixed-import-tables} switch is specifying, that | |
6569 | the import tables idata4 and idata5 have to be generated with a zero | |
11e7fd74 | 6570 | element prefix for import libraries. This is the old style to generate |
ce11ba6c KT |
6571 | import tables. By default this option is turned off. |
6572 | ||
e489d0ae PB |
6573 | @cindex BE8 |
6574 | @kindex --be8 | |
6575 | The @samp{--be8} switch instructs @command{ld} to generate BE8 format | |
080bb7bb NC |
6576 | executables. This option is only valid when linking big-endian |
6577 | objects - ie ones which have been assembled with the @option{-EB} | |
6578 | option. The resulting image will contain big-endian data and | |
6579 | little-endian code. | |
e489d0ae | 6580 | |
3674e28a PB |
6581 | @cindex TARGET1 |
6582 | @kindex --target1-rel | |
6583 | @kindex --target1-abs | |
6584 | The @samp{R_ARM_TARGET1} relocation is typically used for entries in the | |
6585 | @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32} | |
6586 | or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel} | |
6587 | and @samp{--target1-abs} switches override the default. | |
6588 | ||
6589 | @cindex TARGET2 | |
6590 | @kindex --target2=@var{type} | |
6591 | The @samp{--target2=type} switch overrides the default definition of the | |
6592 | @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their | |
6593 | meanings, and target defaults are as follows: | |
6594 | @table @samp | |
6595 | @item rel | |
eeac373a PB |
6596 | @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi) |
6597 | @item abs | |
6598 | @samp{R_ARM_ABS32} (arm*-*-symbianelf) | |
3674e28a PB |
6599 | @item got-rel |
6600 | @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd) | |
6601 | @end table | |
6602 | ||
319850b4 JB |
6603 | @cindex FIX_V4BX |
6604 | @kindex --fix-v4bx | |
6605 | The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF | |
6606 | specification) enables objects compiled for the ARMv4 architecture to be | |
6607 | interworking-safe when linked with other objects compiled for ARMv4t, but | |
6608 | also allows pure ARMv4 binaries to be built from the same ARMv4 objects. | |
6609 | ||
6610 | In the latter case, the switch @option{--fix-v4bx} must be passed to the | |
6611 | linker, which causes v4t @code{BX rM} instructions to be rewritten as | |
6612 | @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction. | |
6613 | ||
6614 | In the former case, the switch should not be used, and @samp{R_ARM_V4BX} | |
6615 | relocations are ignored. | |
6616 | ||
845b51d6 PB |
6617 | @cindex FIX_V4BX_INTERWORKING |
6618 | @kindex --fix-v4bx-interworking | |
6619 | Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX} | |
6620 | relocations with a branch to the following veneer: | |
6621 | ||
6622 | @smallexample | |
6623 | TST rM, #1 | |
6624 | MOVEQ PC, rM | |
6625 | BX Rn | |
6626 | @end smallexample | |
6627 | ||
6628 | This allows generation of libraries/applications that work on ARMv4 cores | |
6629 | and are still interworking safe. Note that the above veneer clobbers the | |
11e7fd74 | 6630 | condition flags, so may cause incorrect program behavior in rare cases. |
845b51d6 | 6631 | |
33bfe774 JB |
6632 | @cindex USE_BLX |
6633 | @kindex --use-blx | |
6634 | The @samp{--use-blx} switch enables the linker to use ARM/Thumb | |
6635 | BLX instructions (available on ARMv5t and above) in various | |
6636 | situations. Currently it is used to perform calls via the PLT from Thumb | |
6637 | code using BLX rather than using BX and a mode-switching stub before | |
6638 | each PLT entry. This should lead to such calls executing slightly faster. | |
6639 | ||
6640 | This option is enabled implicitly for SymbianOS, so there is no need to | |
6641 | specify it if you are using that target. | |
6642 | ||
c6dd86c6 JB |
6643 | @cindex VFP11_DENORM_FIX |
6644 | @kindex --vfp11-denorm-fix | |
6645 | The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a | |
6646 | bug in certain VFP11 coprocessor hardware, which sometimes allows | |
6647 | instructions with denorm operands (which must be handled by support code) | |
6648 | to have those operands overwritten by subsequent instructions before | |
6649 | the support code can read the intended values. | |
6650 | ||
6651 | The bug may be avoided in scalar mode if you allow at least one | |
6652 | intervening instruction between a VFP11 instruction which uses a register | |
6653 | and another instruction which writes to the same register, or at least two | |
6654 | intervening instructions if vector mode is in use. The bug only affects | |
6655 | full-compliance floating-point mode: you do not need this workaround if | |
6656 | you are using "runfast" mode. Please contact ARM for further details. | |
6657 | ||
6658 | If you know you are using buggy VFP11 hardware, you can | |
6659 | enable this workaround by specifying the linker option | |
6660 | @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar | |
6661 | mode only, or @samp{--vfp-denorm-fix=vector} if you are using | |
6662 | vector mode (the latter also works for scalar code). The default is | |
6663 | @samp{--vfp-denorm-fix=none}. | |
6664 | ||
6665 | If the workaround is enabled, instructions are scanned for | |
6666 | potentially-troublesome sequences, and a veneer is created for each | |
6667 | such sequence which may trigger the erratum. The veneer consists of the | |
6668 | first instruction of the sequence and a branch back to the subsequent | |
6669 | instruction. The original instruction is then replaced with a branch to | |
6670 | the veneer. The extra cycles required to call and return from the veneer | |
6671 | are sufficient to avoid the erratum in both the scalar and vector cases. | |
6672 | ||
2de70689 MGD |
6673 | @cindex ARM1176 erratum workaround |
6674 | @kindex --fix-arm1176 | |
6675 | @kindex --no-fix-arm1176 | |
9d5777a3 RM |
6676 | The @samp{--fix-arm1176} switch enables a link-time workaround for an erratum |
6677 | in certain ARM1176 processors. The workaround is enabled by default if you | |
6678 | are targeting ARM v6 (excluding ARM v6T2) or earlier. It can be disabled | |
2de70689 MGD |
6679 | unconditionally by specifying @samp{--no-fix-arm1176}. |
6680 | ||
9d5777a3 | 6681 | Further information is available in the ``ARM1176JZ-S and ARM1176JZF-S |
11e7fd74 | 6682 | Programmer Advice Notice'' available on the ARM documentation website at: |
2de70689 MGD |
6683 | http://infocenter.arm.com/. |
6684 | ||
a504d23a LA |
6685 | @cindex STM32L4xx erratum workaround |
6686 | @kindex --fix-stm32l4xx-629360 | |
6687 | ||
6688 | The @samp{--fix-stm32l4xx-629360} switch enables a link-time | |
6689 | workaround for a bug in the bus matrix / memory controller for some of | |
6690 | the STM32 Cortex-M4 based products (STM32L4xx). When accessing | |
6691 | off-chip memory via the affected bus for bus reads of 9 words or more, | |
6692 | the bus can generate corrupt data and/or abort. These are only | |
6693 | core-initiated accesses (not DMA), and might affect any access: | |
6694 | integer loads such as LDM, POP and floating-point loads such as VLDM, | |
6695 | VPOP. Stores are not affected. | |
6696 | ||
6697 | The bug can be avoided by splitting memory accesses into the | |
6698 | necessary chunks to keep bus reads below 8 words. | |
6699 | ||
6700 | The workaround is not enabled by default, this is equivalent to use | |
6701 | @samp{--fix-stm32l4xx-629360=none}. If you know you are using buggy | |
6702 | STM32L4xx hardware, you can enable the workaround by specifying the | |
6703 | linker option @samp{--fix-stm32l4xx-629360}, or the equivalent | |
6704 | @samp{--fix-stm32l4xx-629360=default}. | |
6705 | ||
6706 | If the workaround is enabled, instructions are scanned for | |
6707 | potentially-troublesome sequences, and a veneer is created for each | |
6708 | such sequence which may trigger the erratum. The veneer consists in a | |
6709 | replacement sequence emulating the behaviour of the original one and a | |
6710 | branch back to the subsequent instruction. The original instruction is | |
6711 | then replaced with a branch to the veneer. | |
6712 | ||
6713 | The workaround does not always preserve the memory access order for | |
6714 | the LDMDB instruction, when the instruction loads the PC. | |
6715 | ||
6716 | The workaround is not able to handle problematic instructions when | |
6717 | they are in the middle of an IT block, since a branch is not allowed | |
6718 | there. In that case, the linker reports a warning and no replacement | |
6719 | occurs. | |
6720 | ||
6721 | The workaround is not able to replace problematic instructions with a | |
6722 | PC-relative branch instruction if the @samp{.text} section is too | |
6723 | large. In that case, when the branch that replaces the original code | |
6724 | cannot be encoded, the linker reports a warning and no replacement | |
6725 | occurs. | |
6726 | ||
bf21ed78 MS |
6727 | @cindex NO_ENUM_SIZE_WARNING |
6728 | @kindex --no-enum-size-warning | |
726150b7 | 6729 | The @option{--no-enum-size-warning} switch prevents the linker from |
bf21ed78 MS |
6730 | warning when linking object files that specify incompatible EABI |
6731 | enumeration size attributes. For example, with this switch enabled, | |
6732 | linking of an object file using 32-bit enumeration values with another | |
6733 | using enumeration values fitted into the smallest possible space will | |
6734 | not be diagnosed. | |
a9dc9481 JM |
6735 | |
6736 | @cindex NO_WCHAR_SIZE_WARNING | |
6737 | @kindex --no-wchar-size-warning | |
6738 | The @option{--no-wchar-size-warning} switch prevents the linker from | |
6739 | warning when linking object files that specify incompatible EABI | |
6740 | @code{wchar_t} size attributes. For example, with this switch enabled, | |
6741 | linking of an object file using 32-bit @code{wchar_t} values with another | |
6742 | using 16-bit @code{wchar_t} values will not be diagnosed. | |
bf21ed78 | 6743 | |
726150b7 NC |
6744 | @cindex PIC_VENEER |
6745 | @kindex --pic-veneer | |
6746 | The @samp{--pic-veneer} switch makes the linker use PIC sequences for | |
6747 | ARM/Thumb interworking veneers, even if the rest of the binary | |
6748 | is not PIC. This avoids problems on uClinux targets where | |
6749 | @samp{--emit-relocs} is used to generate relocatable binaries. | |
6750 | ||
6751 | @cindex STUB_GROUP_SIZE | |
6752 | @kindex --stub-group-size=@var{N} | |
6753 | The linker will automatically generate and insert small sequences of | |
6754 | code into a linked ARM ELF executable whenever an attempt is made to | |
6755 | perform a function call to a symbol that is too far away. The | |
6756 | placement of these sequences of instructions - called stubs - is | |
6757 | controlled by the command line option @option{--stub-group-size=N}. | |
6758 | The placement is important because a poor choice can create a need for | |
11e7fd74 | 6759 | duplicate stubs, increasing the code size. The linker will try to |
726150b7 NC |
6760 | group stubs together in order to reduce interruptions to the flow of |
6761 | code, but it needs guidance as to how big these groups should be and | |
6762 | where they should be placed. | |
6763 | ||
6764 | The value of @samp{N}, the parameter to the | |
6765 | @option{--stub-group-size=} option controls where the stub groups are | |
07d72278 | 6766 | placed. If it is negative then all stubs are placed after the first |
726150b7 NC |
6767 | branch that needs them. If it is positive then the stubs can be |
6768 | placed either before or after the branches that need them. If the | |
6769 | value of @samp{N} is 1 (either +1 or -1) then the linker will choose | |
6770 | exactly where to place groups of stubs, using its built in heuristics. | |
6771 | A value of @samp{N} greater than 1 (or smaller than -1) tells the | |
6772 | linker that a single group of stubs can service at most @samp{N} bytes | |
6773 | from the input sections. | |
6774 | ||
6775 | The default, if @option{--stub-group-size=} is not specified, is | |
6776 | @samp{N = +1}. | |
6777 | ||
1a51c1a4 NC |
6778 | Farcalls stubs insertion is fully supported for the ARM-EABI target |
6779 | only, because it relies on object files properties not present | |
6780 | otherwise. | |
6781 | ||
1db37fe6 YG |
6782 | @cindex Cortex-A8 erratum workaround |
6783 | @kindex --fix-cortex-a8 | |
6784 | @kindex --no-fix-cortex-a8 | |
6785 | 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}. | |
6786 | ||
6787 | The erratum only affects Thumb-2 code. Please contact ARM for further details. | |
6788 | ||
68fcca92 JW |
6789 | @cindex Cortex-A53 erratum 835769 workaround |
6790 | @kindex --fix-cortex-a53-835769 | |
6791 | @kindex --no-fix-cortex-a53-835769 | |
6792 | The @samp{--fix-cortex-a53-835769} switch enables a link-time workaround for erratum 835769 present on certain early revisions of Cortex-A53 processors. The workaround is disabled by default. It can be enabled by specifying @samp{--fix-cortex-a53-835769}, or disabled unconditionally by specifying @samp{--no-fix-cortex-a53-835769}. | |
6793 | ||
6794 | Please contact ARM for further details. | |
6795 | ||
1db37fe6 YG |
6796 | @kindex --merge-exidx-entries |
6797 | @kindex --no-merge-exidx-entries | |
6798 | @cindex Merging exidx entries | |
6799 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo. | |
6800 | ||
6801 | @kindex --long-plt | |
6802 | @cindex 32-bit PLT entries | |
6803 | The @samp{--long-plt} option enables the use of 16 byte PLT entries | |
6804 | which support up to 4Gb of code. The default is to use 12 byte PLT | |
6805 | entries which only support 512Mb of code. | |
6806 | ||
36f63dca NC |
6807 | @ifclear GENERIC |
6808 | @lowersections | |
6809 | @end ifclear | |
6810 | @end ifset | |
6811 | ||
6812 | @ifset HPPA | |
6813 | @ifclear GENERIC | |
6814 | @raisesections | |
6815 | @end ifclear | |
6816 | ||
6817 | @node HPPA ELF32 | |
6818 | @section @command{ld} and HPPA 32-bit ELF Support | |
6819 | @cindex HPPA multiple sub-space stubs | |
6820 | @kindex --multi-subspace | |
6821 | When generating a shared library, @command{ld} will by default generate | |
6822 | import stubs suitable for use with a single sub-space application. | |
6823 | The @samp{--multi-subspace} switch causes @command{ld} to generate export | |
6824 | stubs, and different (larger) import stubs suitable for use with | |
6825 | multiple sub-spaces. | |
6826 | ||
6827 | @cindex HPPA stub grouping | |
6828 | @kindex --stub-group-size=@var{N} | |
6829 | Long branch stubs and import/export stubs are placed by @command{ld} in | |
6830 | stub sections located between groups of input sections. | |
6831 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
6832 | sections handled by one stub section. Since branch offsets are signed, | |
6833 | a stub section may serve two groups of input sections, one group before | |
6834 | the stub section, and one group after it. However, when using | |
6835 | conditional branches that require stubs, it may be better (for branch | |
6836 | prediction) that stub sections only serve one group of input sections. | |
6837 | A negative value for @samp{N} chooses this scheme, ensuring that | |
6838 | branches to stubs always use a negative offset. Two special values of | |
6839 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
6840 | @command{ld} to automatically size input section groups for the branch types | |
6841 | detected, with the same behaviour regarding stub placement as other | |
6842 | positive or negative values of @samp{N} respectively. | |
6843 | ||
6844 | Note that @samp{--stub-group-size} does not split input sections. A | |
6845 | single input section larger than the group size specified will of course | |
6846 | create a larger group (of one section). If input sections are too | |
6847 | large, it may not be possible for a branch to reach its stub. | |
6848 | ||
6849 | @ifclear GENERIC | |
6850 | @lowersections | |
6851 | @end ifclear | |
6852 | @end ifset | |
6853 | ||
7fb9f789 NC |
6854 | @ifset M68K |
6855 | @ifclear GENERIC | |
6856 | @raisesections | |
6857 | @end ifclear | |
6858 | ||
6859 | @node M68K | |
6860 | @section @command{ld} and the Motorola 68K family | |
6861 | ||
6862 | @cindex Motorola 68K GOT generation | |
6863 | @kindex --got=@var{type} | |
6864 | The @samp{--got=@var{type}} option lets you choose the GOT generation scheme. | |
6865 | The choices are @samp{single}, @samp{negative}, @samp{multigot} and | |
6866 | @samp{target}. When @samp{target} is selected the linker chooses | |
6867 | the default GOT generation scheme for the current target. | |
6868 | @samp{single} tells the linker to generate a single GOT with | |
6869 | entries only at non-negative offsets. | |
6870 | @samp{negative} instructs the linker to generate a single GOT with | |
6871 | entries at both negative and positive offsets. Not all environments | |
6872 | support such GOTs. | |
6873 | @samp{multigot} allows the linker to generate several GOTs in the | |
6874 | output file. All GOT references from a single input object | |
6875 | file access the same GOT, but references from different input object | |
6876 | files might access different GOTs. Not all environments support such GOTs. | |
6877 | ||
6878 | @ifclear GENERIC | |
6879 | @lowersections | |
6880 | @end ifclear | |
6881 | @end ifset | |
6882 | ||
833794fc MR |
6883 | @ifset MIPS |
6884 | @ifclear GENERIC | |
6885 | @raisesections | |
6886 | @end ifclear | |
6887 | ||
6888 | @node MIPS | |
6889 | @section @command{ld} and the MIPS family | |
6890 | ||
6891 | @cindex MIPS microMIPS instruction choice selection | |
6892 | @kindex --insn32 | |
6893 | @kindex --no-insn32 | |
6894 | The @samp{--insn32} and @samp{--no-insn32} options control the choice of | |
6895 | microMIPS instructions used in code generated by the linker, such as that | |
6896 | in the PLT or lazy binding stubs, or in relaxation. If @samp{--insn32} is | |
6897 | used, then the linker only uses 32-bit instruction encodings. By default | |
6898 | or if @samp{--no-insn32} is used, all instruction encodings are used, | |
6899 | including 16-bit ones where possible. | |
6900 | ||
6901 | @ifclear GENERIC | |
6902 | @lowersections | |
6903 | @end ifclear | |
6904 | @end ifset | |
6905 | ||
36f63dca NC |
6906 | @ifset MMIX |
6907 | @ifclear GENERIC | |
6908 | @raisesections | |
6909 | @end ifclear | |
6910 | ||
6911 | @node MMIX | |
6912 | @section @code{ld} and MMIX | |
6913 | For MMIX, there is a choice of generating @code{ELF} object files or | |
6914 | @code{mmo} object files when linking. The simulator @code{mmix} | |
6915 | understands the @code{mmo} format. The binutils @code{objcopy} utility | |
6916 | can translate between the two formats. | |
6917 | ||
6918 | There is one special section, the @samp{.MMIX.reg_contents} section. | |
6919 | Contents in this section is assumed to correspond to that of global | |
6920 | registers, and symbols referring to it are translated to special symbols, | |
6921 | equal to registers. In a final link, the start address of the | |
6922 | @samp{.MMIX.reg_contents} section corresponds to the first allocated | |
6923 | global register multiplied by 8. Register @code{$255} is not included in | |
6924 | this section; it is always set to the program entry, which is at the | |
6925 | symbol @code{Main} for @code{mmo} files. | |
6926 | ||
7a2de473 HPN |
6927 | Global symbols with the prefix @code{__.MMIX.start.}, for example |
6928 | @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special. | |
6929 | The default linker script uses these to set the default start address | |
6930 | of a section. | |
36f63dca NC |
6931 | |
6932 | Initial and trailing multiples of zero-valued 32-bit words in a section, | |
6933 | are left out from an mmo file. | |
6934 | ||
6935 | @ifclear GENERIC | |
6936 | @lowersections | |
6937 | @end ifclear | |
6938 | @end ifset | |
6939 | ||
6940 | @ifset MSP430 | |
6941 | @ifclear GENERIC | |
6942 | @raisesections | |
6943 | @end ifclear | |
6944 | ||
6945 | @node MSP430 | |
6946 | @section @code{ld} and MSP430 | |
6947 | For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]} | |
6948 | will select an appropriate linker script for selected MPU type. (To get a list of known MPUs | |
6949 | just pass @samp{-m help} option to the linker). | |
6950 | ||
6951 | @cindex MSP430 extra sections | |
6952 | The linker will recognize some extra sections which are MSP430 specific: | |
6953 | ||
6954 | @table @code | |
6955 | @item @samp{.vectors} | |
6956 | Defines a portion of ROM where interrupt vectors located. | |
6957 | ||
6958 | @item @samp{.bootloader} | |
6959 | Defines the bootloader portion of the ROM (if applicable). Any code | |
6960 | in this section will be uploaded to the MPU. | |
6961 | ||
6962 | @item @samp{.infomem} | |
6963 | Defines an information memory section (if applicable). Any code in | |
6964 | this section will be uploaded to the MPU. | |
6965 | ||
c0065db7 | 6966 | @item @samp{.infomemnobits} |
36f63dca NC |
6967 | This is the same as the @samp{.infomem} section except that any code |
6968 | in this section will not be uploaded to the MPU. | |
6969 | ||
6970 | @item @samp{.noinit} | |
6971 | Denotes a portion of RAM located above @samp{.bss} section. | |
6972 | ||
c0065db7 | 6973 | The last two sections are used by gcc. |
36f63dca NC |
6974 | @end table |
6975 | ||
6976 | @ifclear GENERIC | |
6977 | @lowersections | |
6978 | @end ifclear | |
6979 | @end ifset | |
6980 | ||
35c08157 KLC |
6981 | @ifset NDS32 |
6982 | @ifclear GENERIC | |
6983 | @raisesections | |
6984 | @end ifclear | |
6985 | ||
6986 | @node NDS32 | |
6987 | @section @code{ld} and NDS32 | |
6988 | @kindex relaxing on NDS32 | |
6989 | For NDS32, there are some options to select relaxation behavior. The linker | |
6990 | relaxes objects according to these options. | |
6991 | ||
6992 | @table @code | |
6993 | @item @samp{--m[no-]fp-as-gp} | |
6994 | Disable/enable fp-as-gp relaxation. | |
6995 | ||
6996 | @item @samp{--mexport-symbols=FILE} | |
6997 | Exporting symbols and their address into FILE as linker script. | |
6998 | ||
6999 | @item @samp{--m[no-]ex9} | |
7000 | Disable/enable link-time EX9 relaxation. | |
7001 | ||
7002 | @item @samp{--mexport-ex9=FILE} | |
7003 | Export the EX9 table after linking. | |
7004 | ||
7005 | @item @samp{--mimport-ex9=FILE} | |
7006 | Import the Ex9 table for EX9 relaxation. | |
7007 | ||
7008 | @item @samp{--mupdate-ex9} | |
7009 | Update the existing EX9 table. | |
7010 | ||
7011 | @item @samp{--mex9-limit=NUM} | |
7012 | Maximum number of entries in the ex9 table. | |
7013 | ||
7014 | @item @samp{--mex9-loop-aware} | |
7015 | Avoid generating the EX9 instruction inside the loop. | |
7016 | ||
7017 | @item @samp{--m[no-]ifc} | |
7018 | Disable/enable the link-time IFC optimization. | |
7019 | ||
7020 | @item @samp{--mifc-loop-aware} | |
7021 | Avoid generating the IFC instruction inside the loop. | |
7022 | @end table | |
7023 | ||
7024 | @ifclear GENERIC | |
7025 | @lowersections | |
7026 | @end ifclear | |
7027 | @end ifset | |
7028 | ||
78058a5e SL |
7029 | @ifset NIOSII |
7030 | @ifclear GENERIC | |
7031 | @raisesections | |
7032 | @end ifclear | |
7033 | ||
7034 | @node Nios II | |
7035 | @section @command{ld} and the Altera Nios II | |
7036 | @cindex Nios II call relaxation | |
7037 | @kindex --relax on Nios II | |
7038 | ||
7039 | Call and immediate jump instructions on Nios II processors are limited to | |
7040 | transferring control to addresses in the same 256MB memory segment, | |
7041 | which may result in @command{ld} giving | |
7042 | @samp{relocation truncated to fit} errors with very large programs. | |
7043 | The command-line option @option{--relax} enables the generation of | |
7044 | trampolines that can access the entire 32-bit address space for calls | |
7045 | outside the normal @code{call} and @code{jmpi} address range. These | |
7046 | trampolines are inserted at section boundaries, so may not themselves | |
7047 | be reachable if an input section and its associated call trampolines are | |
7048 | larger than 256MB. | |
7049 | ||
7050 | The @option{--relax} option is enabled by default unless @option{-r} | |
7051 | is also specified. You can disable trampoline generation by using the | |
7052 | @option{--no-relax} linker option. You can also disable this optimization | |
7053 | locally by using the @samp{set .noat} directive in assembly-language | |
7054 | source files, as the linker-inserted trampolines use the @code{at} | |
7055 | register as a temporary. | |
7056 | ||
7057 | Note that the linker @option{--relax} option is independent of assembler | |
7058 | relaxation options, and that using the GNU assembler's @option{-relax-all} | |
7059 | option interferes with the linker's more selective call instruction relaxation. | |
7060 | ||
7061 | @ifclear GENERIC | |
7062 | @lowersections | |
7063 | @end ifclear | |
7064 | @end ifset | |
7065 | ||
2a60a7a8 AM |
7066 | @ifset POWERPC |
7067 | @ifclear GENERIC | |
7068 | @raisesections | |
7069 | @end ifclear | |
7070 | ||
7071 | @node PowerPC ELF32 | |
7072 | @section @command{ld} and PowerPC 32-bit ELF Support | |
7073 | @cindex PowerPC long branches | |
7074 | @kindex --relax on PowerPC | |
7075 | Branches on PowerPC processors are limited to a signed 26-bit | |
7076 | displacement, which may result in @command{ld} giving | |
7077 | @samp{relocation truncated to fit} errors with very large programs. | |
7078 | @samp{--relax} enables the generation of trampolines that can access | |
7079 | the entire 32-bit address space. These trampolines are inserted at | |
7080 | section boundaries, so may not themselves be reachable if an input | |
c8a1f254 NS |
7081 | section exceeds 33M in size. You may combine @samp{-r} and |
7082 | @samp{--relax} to add trampolines in a partial link. In that case | |
7083 | both branches to undefined symbols and inter-section branches are also | |
7084 | considered potentially out of range, and trampolines inserted. | |
2a60a7a8 AM |
7085 | |
7086 | @cindex PowerPC ELF32 options | |
7087 | @table @option | |
7088 | @cindex PowerPC PLT | |
7089 | @kindex --bss-plt | |
7090 | @item --bss-plt | |
7091 | Current PowerPC GCC accepts a @samp{-msecure-plt} option that | |
7092 | generates code capable of using a newer PLT and GOT layout that has | |
7093 | the security advantage of no executable section ever needing to be | |
7094 | writable and no writable section ever being executable. PowerPC | |
7095 | @command{ld} will generate this layout, including stubs to access the | |
7096 | PLT, if all input files (including startup and static libraries) were | |
7097 | compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old | |
7098 | BSS PLT (and GOT layout) which can give slightly better performance. | |
7099 | ||
016687f8 AM |
7100 | @kindex --secure-plt |
7101 | @item --secure-plt | |
7102 | @command{ld} will use the new PLT and GOT layout if it is linking new | |
7103 | @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically | |
7104 | when linking non-PIC code. This option requests the new PLT and GOT | |
7105 | layout. A warning will be given if some object file requires the old | |
7106 | style BSS PLT. | |
7107 | ||
2a60a7a8 AM |
7108 | @cindex PowerPC GOT |
7109 | @kindex --sdata-got | |
7110 | @item --sdata-got | |
7111 | The new secure PLT and GOT are placed differently relative to other | |
7112 | sections compared to older BSS PLT and GOT placement. The location of | |
7113 | @code{.plt} must change because the new secure PLT is an initialized | |
7114 | section while the old PLT is uninitialized. The reason for the | |
7115 | @code{.got} change is more subtle: The new placement allows | |
7116 | @code{.got} to be read-only in applications linked with | |
7117 | @samp{-z relro -z now}. However, this placement means that | |
7118 | @code{.sdata} cannot always be used in shared libraries, because the | |
7119 | PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT | |
7120 | pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC | |
7121 | GCC doesn't use @code{.sdata} in shared libraries, so this option is | |
7122 | really only useful for other compilers that may do so. | |
7123 | ||
7124 | @cindex PowerPC stub symbols | |
7125 | @kindex --emit-stub-syms | |
7126 | @item --emit-stub-syms | |
7127 | This option causes @command{ld} to label linker stubs with a local | |
7128 | symbol that encodes the stub type and destination. | |
7129 | ||
7130 | @cindex PowerPC TLS optimization | |
7131 | @kindex --no-tls-optimize | |
7132 | @item --no-tls-optimize | |
7133 | PowerPC @command{ld} normally performs some optimization of code | |
7134 | sequences used to access Thread-Local Storage. Use this option to | |
7135 | disable the optimization. | |
7136 | @end table | |
7137 | ||
7138 | @ifclear GENERIC | |
7139 | @lowersections | |
7140 | @end ifclear | |
7141 | @end ifset | |
7142 | ||
7143 | @ifset POWERPC64 | |
7144 | @ifclear GENERIC | |
7145 | @raisesections | |
7146 | @end ifclear | |
7147 | ||
7148 | @node PowerPC64 ELF64 | |
7149 | @section @command{ld} and PowerPC64 64-bit ELF Support | |
7150 | ||
7151 | @cindex PowerPC64 ELF64 options | |
7152 | @table @option | |
7153 | @cindex PowerPC64 stub grouping | |
7154 | @kindex --stub-group-size | |
7155 | @item --stub-group-size | |
7156 | Long branch stubs, PLT call stubs and TOC adjusting stubs are placed | |
7157 | by @command{ld} in stub sections located between groups of input sections. | |
7158 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
7159 | sections handled by one stub section. Since branch offsets are signed, | |
7160 | a stub section may serve two groups of input sections, one group before | |
7161 | the stub section, and one group after it. However, when using | |
7162 | conditional branches that require stubs, it may be better (for branch | |
7163 | prediction) that stub sections only serve one group of input sections. | |
7164 | A negative value for @samp{N} chooses this scheme, ensuring that | |
7165 | branches to stubs always use a negative offset. Two special values of | |
7166 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
7167 | @command{ld} to automatically size input section groups for the branch types | |
7168 | detected, with the same behaviour regarding stub placement as other | |
7169 | positive or negative values of @samp{N} respectively. | |
7170 | ||
7171 | Note that @samp{--stub-group-size} does not split input sections. A | |
7172 | single input section larger than the group size specified will of course | |
7173 | create a larger group (of one section). If input sections are too | |
7174 | large, it may not be possible for a branch to reach its stub. | |
7175 | ||
7176 | @cindex PowerPC64 stub symbols | |
7177 | @kindex --emit-stub-syms | |
7178 | @item --emit-stub-syms | |
7179 | This option causes @command{ld} to label linker stubs with a local | |
7180 | symbol that encodes the stub type and destination. | |
7181 | ||
7182 | @cindex PowerPC64 dot symbols | |
7183 | @kindex --dotsyms | |
7184 | @kindex --no-dotsyms | |
95421fb9 AM |
7185 | @item --dotsyms |
7186 | @itemx --no-dotsyms | |
2a60a7a8 AM |
7187 | These two options control how @command{ld} interprets version patterns |
7188 | in a version script. Older PowerPC64 compilers emitted both a | |
7189 | function descriptor symbol with the same name as the function, and a | |
7190 | code entry symbol with the name prefixed by a dot (@samp{.}). To | |
7191 | properly version a function @samp{foo}, the version script thus needs | |
7192 | to control both @samp{foo} and @samp{.foo}. The option | |
7193 | @samp{--dotsyms}, on by default, automatically adds the required | |
7194 | dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this | |
7195 | feature. | |
7196 | ||
7ae4ea7d AM |
7197 | @cindex PowerPC64 register save/restore functions |
7198 | @kindex --save-restore-funcs | |
7199 | @kindex --no-save-restore-funcs | |
95421fb9 AM |
7200 | @item --save-restore-funcs |
7201 | @itemx --no-save-restore-funcs | |
7ae4ea7d AM |
7202 | These two options control whether PowerPC64 @command{ld} automatically |
7203 | provides out-of-line register save and restore functions used by | |
7204 | @samp{-Os} code. The default is to provide any such referenced | |
7205 | function for a normal final link, and to not do so for a relocatable | |
7206 | link. | |
7207 | ||
2a60a7a8 AM |
7208 | @cindex PowerPC64 TLS optimization |
7209 | @kindex --no-tls-optimize | |
7210 | @item --no-tls-optimize | |
7211 | PowerPC64 @command{ld} normally performs some optimization of code | |
7212 | sequences used to access Thread-Local Storage. Use this option to | |
7213 | disable the optimization. | |
7214 | ||
7c9cf415 AM |
7215 | @cindex PowerPC64 __tls_get_addr optimization |
7216 | @kindex --tls-get-addr-optimize | |
7217 | @kindex --no-tls-get-addr-optimize | |
95421fb9 AM |
7218 | @item --tls-get-addr-optimize |
7219 | @itemx --no-tls-get-addr-optimize | |
7c9cf415 AM |
7220 | These options control whether PowerPC64 @command{ld} uses a special |
7221 | stub to call __tls_get_addr. PowerPC64 glibc 2.22 and later support | |
7222 | an optimization that allows the second and subsequent calls to | |
7223 | @code{__tls_get_addr} for a given symbol to be resolved by the special | |
7224 | stub without calling in to glibc. By default the linker enables this | |
7225 | option when glibc advertises the availability of __tls_get_addr_opt. | |
7226 | Forcing this option on when using an older glibc won't do much besides | |
7227 | slow down your applications, but may be useful if linking an | |
7228 | application against an older glibc with the expectation that it will | |
7229 | normally be used on systems having a newer glibc. | |
7230 | ||
2a60a7a8 AM |
7231 | @cindex PowerPC64 OPD optimization |
7232 | @kindex --no-opd-optimize | |
7233 | @item --no-opd-optimize | |
7234 | PowerPC64 @command{ld} normally removes @code{.opd} section entries | |
7235 | corresponding to deleted link-once functions, or functions removed by | |
e7fc76dd | 7236 | the action of @samp{--gc-sections} or linker script @code{/DISCARD/}. |
2a60a7a8 AM |
7237 | Use this option to disable @code{.opd} optimization. |
7238 | ||
7239 | @cindex PowerPC64 OPD spacing | |
7240 | @kindex --non-overlapping-opd | |
7241 | @item --non-overlapping-opd | |
7242 | Some PowerPC64 compilers have an option to generate compressed | |
7243 | @code{.opd} entries spaced 16 bytes apart, overlapping the third word, | |
7244 | the static chain pointer (unused in C) with the first word of the next | |
7245 | entry. This option expands such entries to the full 24 bytes. | |
7246 | ||
7247 | @cindex PowerPC64 TOC optimization | |
7248 | @kindex --no-toc-optimize | |
7249 | @item --no-toc-optimize | |
7250 | PowerPC64 @command{ld} normally removes unused @code{.toc} section | |
7251 | entries. Such entries are detected by examining relocations that | |
7252 | reference the TOC in code sections. A reloc in a deleted code section | |
7253 | marks a TOC word as unneeded, while a reloc in a kept code section | |
7254 | marks a TOC word as needed. Since the TOC may reference itself, TOC | |
7255 | relocs are also examined. TOC words marked as both needed and | |
7256 | unneeded will of course be kept. TOC words without any referencing | |
7257 | reloc are assumed to be part of a multi-word entry, and are kept or | |
7258 | discarded as per the nearest marked preceding word. This works | |
7259 | reliably for compiler generated code, but may be incorrect if assembly | |
7260 | code is used to insert TOC entries. Use this option to disable the | |
7261 | optimization. | |
7262 | ||
7263 | @cindex PowerPC64 multi-TOC | |
7264 | @kindex --no-multi-toc | |
7265 | @item --no-multi-toc | |
794e51c0 AM |
7266 | If given any toc option besides @code{-mcmodel=medium} or |
7267 | @code{-mcmodel=large}, PowerPC64 GCC generates code for a TOC model | |
7268 | where TOC | |
2a60a7a8 AM |
7269 | entries are accessed with a 16-bit offset from r2. This limits the |
7270 | total TOC size to 64K. PowerPC64 @command{ld} extends this limit by | |
7271 | grouping code sections such that each group uses less than 64K for its | |
7272 | TOC entries, then inserts r2 adjusting stubs between inter-group | |
7273 | calls. @command{ld} does not split apart input sections, so cannot | |
7274 | help if a single input file has a @code{.toc} section that exceeds | |
7275 | 64K, most likely from linking multiple files with @command{ld -r}. | |
7276 | Use this option to turn off this feature. | |
794e51c0 AM |
7277 | |
7278 | @cindex PowerPC64 TOC sorting | |
7279 | @kindex --no-toc-sort | |
7280 | @item --no-toc-sort | |
7281 | By default, @command{ld} sorts TOC sections so that those whose file | |
7282 | happens to have a section called @code{.init} or @code{.fini} are | |
7283 | placed first, followed by TOC sections referenced by code generated | |
7284 | with PowerPC64 gcc's @code{-mcmodel=small}, and lastly TOC sections | |
7285 | referenced only by code generated with PowerPC64 gcc's | |
7286 | @code{-mcmodel=medium} or @code{-mcmodel=large} options. Doing this | |
7287 | results in better TOC grouping for multi-TOC. Use this option to turn | |
7288 | off this feature. | |
7289 | ||
7290 | @cindex PowerPC64 PLT stub alignment | |
7291 | @kindex --plt-align | |
7292 | @kindex --no-plt-align | |
7293 | @item --plt-align | |
7294 | @itemx --no-plt-align | |
7295 | Use these options to control whether individual PLT call stubs are | |
e05fa0ba AM |
7296 | padded so that they don't cross a 32-byte boundary, or to the |
7297 | specified power of two boundary when using @code{--plt-align=}. Note | |
7298 | that this isn't alignment in the usual sense. By default PLT call | |
7299 | stubs are packed tightly. | |
794e51c0 AM |
7300 | |
7301 | @cindex PowerPC64 PLT call stub static chain | |
7302 | @kindex --plt-static-chain | |
7303 | @kindex --no-plt-static-chain | |
7304 | @item --plt-static-chain | |
7305 | @itemx --no-plt-static-chain | |
7306 | Use these options to control whether PLT call stubs load the static | |
7307 | chain pointer (r11). @code{ld} defaults to not loading the static | |
7308 | chain since there is never any need to do so on a PLT call. | |
7309 | ||
7310 | @cindex PowerPC64 PLT call stub thread safety | |
7311 | @kindex --plt-thread-safe | |
7312 | @kindex --no-plt-thread-safe | |
7313 | @item --plt-thread-safe | |
7314 | @itemx --no-thread-safe | |
7315 | With power7's weakly ordered memory model, it is possible when using | |
7316 | lazy binding for ld.so to update a plt entry in one thread and have | |
7317 | another thread see the individual plt entry words update in the wrong | |
7318 | order, despite ld.so carefully writing in the correct order and using | |
7319 | memory write barriers. To avoid this we need some sort of read | |
7320 | barrier in the call stub, or use LD_BIND_NOW=1. By default, @code{ld} | |
7321 | looks for calls to commonly used functions that create threads, and if | |
7322 | seen, adds the necessary barriers. Use these options to change the | |
7323 | default behaviour. | |
2a60a7a8 AM |
7324 | @end table |
7325 | ||
7326 | @ifclear GENERIC | |
7327 | @lowersections | |
7328 | @end ifclear | |
7329 | @end ifset | |
7330 | ||
49fa1e15 AM |
7331 | @ifset SPU |
7332 | @ifclear GENERIC | |
7333 | @raisesections | |
7334 | @end ifclear | |
7335 | ||
7336 | @node SPU ELF | |
7337 | @section @command{ld} and SPU ELF Support | |
7338 | ||
7339 | @cindex SPU ELF options | |
7340 | @table @option | |
7341 | ||
7342 | @cindex SPU plugins | |
7343 | @kindex --plugin | |
7344 | @item --plugin | |
7345 | This option marks an executable as a PIC plugin module. | |
7346 | ||
7347 | @cindex SPU overlays | |
7348 | @kindex --no-overlays | |
7349 | @item --no-overlays | |
7350 | Normally, @command{ld} recognizes calls to functions within overlay | |
7351 | regions, and redirects such calls to an overlay manager via a stub. | |
7352 | @command{ld} also provides a built-in overlay manager. This option | |
7353 | turns off all this special overlay handling. | |
7354 | ||
7355 | @cindex SPU overlay stub symbols | |
7356 | @kindex --emit-stub-syms | |
7357 | @item --emit-stub-syms | |
7358 | This option causes @command{ld} to label overlay stubs with a local | |
7359 | symbol that encodes the stub type and destination. | |
7360 | ||
7361 | @cindex SPU extra overlay stubs | |
7362 | @kindex --extra-overlay-stubs | |
7363 | @item --extra-overlay-stubs | |
7364 | This option causes @command{ld} to add overlay call stubs on all | |
7365 | function calls out of overlay regions. Normally stubs are not added | |
7366 | on calls to non-overlay regions. | |
7367 | ||
7368 | @cindex SPU local store size | |
7369 | @kindex --local-store=lo:hi | |
7370 | @item --local-store=lo:hi | |
7371 | @command{ld} usually checks that a final executable for SPU fits in | |
7372 | the address range 0 to 256k. This option may be used to change the | |
7373 | range. Disable the check entirely with @option{--local-store=0:0}. | |
7374 | ||
c0065db7 | 7375 | @cindex SPU |
49fa1e15 AM |
7376 | @kindex --stack-analysis |
7377 | @item --stack-analysis | |
7378 | SPU local store space is limited. Over-allocation of stack space | |
7379 | unnecessarily limits space available for code and data, while | |
7380 | under-allocation results in runtime failures. If given this option, | |
7381 | @command{ld} will provide an estimate of maximum stack usage. | |
7382 | @command{ld} does this by examining symbols in code sections to | |
7383 | determine the extents of functions, and looking at function prologues | |
7384 | for stack adjusting instructions. A call-graph is created by looking | |
7385 | for relocations on branch instructions. The graph is then searched | |
7386 | for the maximum stack usage path. Note that this analysis does not | |
7387 | find calls made via function pointers, and does not handle recursion | |
7388 | and other cycles in the call graph. Stack usage may be | |
7389 | under-estimated if your code makes such calls. Also, stack usage for | |
7390 | dynamic allocation, e.g. alloca, will not be detected. If a link map | |
7391 | is requested, detailed information about each function's stack usage | |
7392 | and calls will be given. | |
7393 | ||
c0065db7 | 7394 | @cindex SPU |
49fa1e15 AM |
7395 | @kindex --emit-stack-syms |
7396 | @item --emit-stack-syms | |
7397 | This option, if given along with @option{--stack-analysis} will result | |
7398 | in @command{ld} emitting stack sizing symbols for each function. | |
7399 | These take the form @code{__stack_<function_name>} for global | |
7400 | functions, and @code{__stack_<number>_<function_name>} for static | |
7401 | functions. @code{<number>} is the section id in hex. The value of | |
7402 | such symbols is the stack requirement for the corresponding function. | |
7403 | The symbol size will be zero, type @code{STT_NOTYPE}, binding | |
c0065db7 | 7404 | @code{STB_LOCAL}, and section @code{SHN_ABS}. |
49fa1e15 AM |
7405 | @end table |
7406 | ||
7407 | @ifclear GENERIC | |
7408 | @lowersections | |
7409 | @end ifclear | |
7410 | @end ifset | |
7411 | ||
36f63dca NC |
7412 | @ifset TICOFF |
7413 | @ifclear GENERIC | |
7414 | @raisesections | |
7415 | @end ifclear | |
7416 | ||
7417 | @node TI COFF | |
7418 | @section @command{ld}'s Support for Various TI COFF Versions | |
7419 | @cindex TI COFF versions | |
7420 | @kindex --format=@var{version} | |
7421 | The @samp{--format} switch allows selection of one of the various | |
7422 | TI COFF versions. The latest of this writing is 2; versions 0 and 1 are | |
7423 | also supported. The TI COFF versions also vary in header byte-order | |
7424 | format; @command{ld} will read any version or byte order, but the output | |
7425 | header format depends on the default specified by the specific target. | |
7426 | ||
7427 | @ifclear GENERIC | |
7428 | @lowersections | |
7429 | @end ifclear | |
7430 | @end ifset | |
7431 | ||
2ca22b03 NC |
7432 | @ifset WIN32 |
7433 | @ifclear GENERIC | |
7434 | @raisesections | |
7435 | @end ifclear | |
7436 | ||
7437 | @node WIN32 | |
7438 | @section @command{ld} and WIN32 (cygwin/mingw) | |
7439 | ||
c0065db7 | 7440 | This section describes some of the win32 specific @command{ld} issues. |
b45619c0 | 7441 | See @ref{Options,,Command Line Options} for detailed description of the |
dc8465bf | 7442 | command line options mentioned here. |
2ca22b03 NC |
7443 | |
7444 | @table @emph | |
c0065db7 RM |
7445 | @cindex import libraries |
7446 | @item import libraries | |
69da35b5 | 7447 | The standard Windows linker creates and uses so-called import |
2ca22b03 | 7448 | libraries, which contains information for linking to dll's. They are |
69da35b5 NC |
7449 | regular static archives and are handled as any other static |
7450 | archive. The cygwin and mingw ports of @command{ld} have specific | |
2ca22b03 NC |
7451 | support for creating such libraries provided with the |
7452 | @samp{--out-implib} command line option. | |
7453 | ||
c0065db7 RM |
7454 | @item exporting DLL symbols |
7455 | @cindex exporting DLL symbols | |
dc8465bf NC |
7456 | The cygwin/mingw @command{ld} has several ways to export symbols for dll's. |
7457 | ||
7458 | @table @emph | |
7459 | @item using auto-export functionality | |
7460 | @cindex using auto-export functionality | |
7461 | By default @command{ld} exports symbols with the auto-export functionality, | |
7462 | which is controlled by the following command line options: | |
7463 | ||
0a5d968e NC |
7464 | @itemize |
7465 | @item --export-all-symbols [This is the default] | |
7466 | @item --exclude-symbols | |
7467 | @item --exclude-libs | |
e1c37eb5 | 7468 | @item --exclude-modules-for-implib |
09e2aba4 | 7469 | @item --version-script |
0a5d968e NC |
7470 | @end itemize |
7471 | ||
09e2aba4 DK |
7472 | When auto-export is in operation, @command{ld} will export all the non-local |
7473 | (global and common) symbols it finds in a DLL, with the exception of a few | |
7474 | symbols known to belong to the system's runtime and libraries. As it will | |
7475 | often not be desirable to export all of a DLL's symbols, which may include | |
7476 | private functions that are not part of any public interface, the command-line | |
9d5777a3 | 7477 | options listed above may be used to filter symbols out from the list for |
09e2aba4 DK |
7478 | exporting. The @samp{--output-def} option can be used in order to see the |
7479 | final list of exported symbols with all exclusions taken into effect. | |
7480 | ||
7481 | If @samp{--export-all-symbols} is not given explicitly on the | |
0a5d968e NC |
7482 | command line, then the default auto-export behavior will be @emph{disabled} |
7483 | if either of the following are true: | |
7484 | ||
7485 | @itemize | |
7486 | @item A DEF file is used. | |
7487 | @item Any symbol in any object file was marked with the __declspec(dllexport) attribute. | |
7488 | @end itemize | |
dc8465bf | 7489 | |
c0065db7 RM |
7490 | @item using a DEF file |
7491 | @cindex using a DEF file | |
dc8465bf NC |
7492 | Another way of exporting symbols is using a DEF file. A DEF file is |
7493 | an ASCII file containing definitions of symbols which should be | |
7494 | exported when a dll is created. Usually it is named @samp{<dll | |
7495 | name>.def} and is added as any other object file to the linker's | |
0a5d968e | 7496 | command line. The file's name must end in @samp{.def} or @samp{.DEF}. |
dc8465bf NC |
7497 | |
7498 | @example | |
7499 | gcc -o <output> <objectfiles> <dll name>.def | |
7500 | @end example | |
7501 | ||
0a5d968e NC |
7502 | Using a DEF file turns off the normal auto-export behavior, unless the |
7503 | @samp{--export-all-symbols} option is also used. | |
7504 | ||
dc8465bf NC |
7505 | Here is an example of a DEF file for a shared library called @samp{xyz.dll}: |
7506 | ||
7507 | @example | |
4b5bd4e7 | 7508 | LIBRARY "xyz.dll" BASE=0x20000000 |
dc8465bf NC |
7509 | |
7510 | EXPORTS | |
7511 | foo | |
7512 | bar | |
7513 | _bar = bar | |
4b5bd4e7 DS |
7514 | another_foo = abc.dll.afoo |
7515 | var1 DATA | |
7fcab871 KT |
7516 | doo = foo == foo2 |
7517 | eoo DATA == var1 | |
c0065db7 | 7518 | @end example |
dc8465bf | 7519 | |
7fcab871 | 7520 | This example defines a DLL with a non-default base address and seven |
4b5bd4e7 DS |
7521 | symbols in the export table. The third exported symbol @code{_bar} is an |
7522 | alias for the second. The fourth symbol, @code{another_foo} is resolved | |
7523 | by "forwarding" to another module and treating it as an alias for | |
7524 | @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol | |
7fcab871 KT |
7525 | @code{var1} is declared to be a data object. The @samp{doo} symbol in |
7526 | export library is an alias of @samp{foo}, which gets the string name | |
7527 | in export table @samp{foo2}. The @samp{eoo} symbol is an data export | |
7528 | symbol, which gets in export table the name @samp{var1}. | |
4b5bd4e7 | 7529 | |
6b31ad16 DS |
7530 | The optional @code{LIBRARY <name>} command indicates the @emph{internal} |
7531 | name of the output DLL. If @samp{<name>} does not include a suffix, | |
7532 | the default library suffix, @samp{.DLL} is appended. | |
7533 | ||
b45619c0 NC |
7534 | When the .DEF file is used to build an application, rather than a |
7535 | library, the @code{NAME <name>} command should be used instead of | |
6b31ad16 | 7536 | @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default |
c0065db7 | 7537 | executable suffix, @samp{.EXE} is appended. |
6b31ad16 DS |
7538 | |
7539 | With either @code{LIBRARY <name>} or @code{NAME <name>} the optional | |
7540 | specification @code{BASE = <number>} may be used to specify a | |
c0065db7 | 7541 | non-default base address for the image. |
6b31ad16 DS |
7542 | |
7543 | If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified, | |
a2877985 DS |
7544 | or they specify an empty string, the internal name is the same as the |
7545 | filename specified on the command line. | |
6b31ad16 | 7546 | |
4b5bd4e7 DS |
7547 | The complete specification of an export symbol is: |
7548 | ||
7549 | @example | |
7550 | EXPORTS | |
7551 | ( ( ( <name1> [ = <name2> ] ) | |
7552 | | ( <name1> = <module-name> . <external-name>)) | |
7fcab871 | 7553 | [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) * |
c0065db7 | 7554 | @end example |
4b5bd4e7 DS |
7555 | |
7556 | Declares @samp{<name1>} as an exported symbol from the DLL, or declares | |
7557 | @samp{<name1>} as an exported alias for @samp{<name2>}; or declares | |
7558 | @samp{<name1>} as a "forward" alias for the symbol | |
7559 | @samp{<external-name>} in the DLL @samp{<module-name>}. | |
7560 | Optionally, the symbol may be exported by the specified ordinal | |
7fcab871 KT |
7561 | @samp{<integer>} alias. The optional @samp{<name3>} is the to be used |
7562 | string in import/export table for the symbol. | |
4b5bd4e7 DS |
7563 | |
7564 | The optional keywords that follow the declaration indicate: | |
7565 | ||
7566 | @code{NONAME}: Do not put the symbol name in the DLL's export table. It | |
7567 | will still be exported by its ordinal alias (either the value specified | |
7568 | by the .def specification or, otherwise, the value assigned by the | |
7569 | linker). The symbol name, however, does remain visible in the import | |
7570 | library (if any), unless @code{PRIVATE} is also specified. | |
7571 | ||
7572 | @code{DATA}: The symbol is a variable or object, rather than a function. | |
7573 | The import lib will export only an indirect reference to @code{foo} as | |
7574 | the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as | |
7575 | @code{*_imp__foo}). | |
7576 | ||
7577 | @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as | |
7578 | well as @code{_imp__foo} into the import library. Both refer to the | |
7579 | read-only import address table's pointer to the variable, not to the | |
7580 | variable itself. This can be dangerous. If the user code fails to add | |
7581 | the @code{dllimport} attribute and also fails to explicitly add the | |
7582 | extra indirection that the use of the attribute enforces, the | |
7583 | application will behave unexpectedly. | |
7584 | ||
7585 | @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put | |
7586 | it into the static import library used to resolve imports at link time. The | |
7587 | symbol can still be imported using the @code{LoadLibrary/GetProcAddress} | |
7588 | API at runtime or by by using the GNU ld extension of linking directly to | |
7589 | the DLL without an import library. | |
c0065db7 | 7590 | |
4b5bd4e7 DS |
7591 | See ld/deffilep.y in the binutils sources for the full specification of |
7592 | other DEF file statements | |
dc8465bf NC |
7593 | |
7594 | @cindex creating a DEF file | |
7595 | While linking a shared dll, @command{ld} is able to create a DEF file | |
7596 | with the @samp{--output-def <file>} command line option. | |
0a5d968e NC |
7597 | |
7598 | @item Using decorations | |
7599 | @cindex Using decorations | |
7600 | Another way of marking symbols for export is to modify the source code | |
7601 | itself, so that when building the DLL each symbol to be exported is | |
7602 | declared as: | |
7603 | ||
7604 | @example | |
7605 | __declspec(dllexport) int a_variable | |
7606 | __declspec(dllexport) void a_function(int with_args) | |
7607 | @end example | |
7608 | ||
7609 | All such symbols will be exported from the DLL. If, however, | |
7610 | any of the object files in the DLL contain symbols decorated in | |
7611 | this way, then the normal auto-export behavior is disabled, unless | |
7612 | the @samp{--export-all-symbols} option is also used. | |
7613 | ||
7614 | Note that object files that wish to access these symbols must @emph{not} | |
c0065db7 | 7615 | decorate them with dllexport. Instead, they should use dllimport, |
0a5d968e NC |
7616 | instead: |
7617 | ||
7618 | @example | |
7619 | __declspec(dllimport) int a_variable | |
7620 | __declspec(dllimport) void a_function(int with_args) | |
7621 | @end example | |
7622 | ||
c0065db7 RM |
7623 | This complicates the structure of library header files, because |
7624 | when included by the library itself the header must declare the | |
0a5d968e NC |
7625 | variables and functions as dllexport, but when included by client |
7626 | code the header must declare them as dllimport. There are a number | |
c0065db7 | 7627 | of idioms that are typically used to do this; often client code can |
0a5d968e NC |
7628 | omit the __declspec() declaration completely. See |
7629 | @samp{--enable-auto-import} and @samp{automatic data imports} for more | |
b45619c0 | 7630 | information. |
c0065db7 | 7631 | @end table |
dc8465bf | 7632 | |
2ca22b03 NC |
7633 | @cindex automatic data imports |
7634 | @item automatic data imports | |
7635 | The standard Windows dll format supports data imports from dlls only | |
69da35b5 | 7636 | by adding special decorations (dllimport/dllexport), which let the |
2ca22b03 | 7637 | compiler produce specific assembler instructions to deal with this |
c0065db7 | 7638 | issue. This increases the effort necessary to port existing Un*x |
69da35b5 | 7639 | code to these platforms, especially for large |
2ca22b03 | 7640 | c++ libraries and applications. The auto-import feature, which was |
c0065db7 | 7641 | initially provided by Paul Sokolovsky, allows one to omit the |
b45619c0 | 7642 | decorations to achieve a behavior that conforms to that on POSIX/Un*x |
c0065db7 | 7643 | platforms. This feature is enabled with the @samp{--enable-auto-import} |
69da35b5 NC |
7644 | command-line option, although it is enabled by default on cygwin/mingw. |
7645 | The @samp{--enable-auto-import} option itself now serves mainly to | |
7646 | suppress any warnings that are ordinarily emitted when linked objects | |
7647 | trigger the feature's use. | |
7648 | ||
c0065db7 | 7649 | auto-import of variables does not always work flawlessly without |
69da35b5 NC |
7650 | additional assistance. Sometimes, you will see this message |
7651 | ||
c0065db7 | 7652 | "variable '<var>' can't be auto-imported. Please read the |
69da35b5 NC |
7653 | documentation for ld's @code{--enable-auto-import} for details." |
7654 | ||
c0065db7 RM |
7655 | The @samp{--enable-auto-import} documentation explains why this error |
7656 | occurs, and several methods that can be used to overcome this difficulty. | |
7657 | One of these methods is the @emph{runtime pseudo-relocs} feature, described | |
69da35b5 NC |
7658 | below. |
7659 | ||
7660 | @cindex runtime pseudo-relocation | |
c0065db7 RM |
7661 | For complex variables imported from DLLs (such as structs or classes), |
7662 | object files typically contain a base address for the variable and an | |
7663 | offset (@emph{addend}) within the variable--to specify a particular | |
7664 | field or public member, for instance. Unfortunately, the runtime loader used | |
7665 | in win32 environments is incapable of fixing these references at runtime | |
69da35b5 | 7666 | without the additional information supplied by dllimport/dllexport decorations. |
c0065db7 | 7667 | The standard auto-import feature described above is unable to resolve these |
69da35b5 NC |
7668 | references. |
7669 | ||
c0065db7 RM |
7670 | The @samp{--enable-runtime-pseudo-relocs} switch allows these references to |
7671 | be resolved without error, while leaving the task of adjusting the references | |
7672 | themselves (with their non-zero addends) to specialized code provided by the | |
7673 | runtime environment. Recent versions of the cygwin and mingw environments and | |
7674 | compilers provide this runtime support; older versions do not. However, the | |
7675 | support is only necessary on the developer's platform; the compiled result will | |
69da35b5 NC |
7676 | run without error on an older system. |
7677 | ||
c0065db7 RM |
7678 | @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly |
7679 | enabled as needed. | |
2ca22b03 NC |
7680 | |
7681 | @cindex direct linking to a dll | |
7682 | @item direct linking to a dll | |
7683 | The cygwin/mingw ports of @command{ld} support the direct linking, | |
7684 | including data symbols, to a dll without the usage of any import | |
69da35b5 | 7685 | libraries. This is much faster and uses much less memory than does the |
b45619c0 | 7686 | traditional import library method, especially when linking large |
c0065db7 RM |
7687 | libraries or applications. When @command{ld} creates an import lib, each |
7688 | function or variable exported from the dll is stored in its own bfd, even | |
7689 | though a single bfd could contain many exports. The overhead involved in | |
69da35b5 | 7690 | storing, loading, and processing so many bfd's is quite large, and explains the |
c0065db7 | 7691 | tremendous time, memory, and storage needed to link against particularly |
69da35b5 NC |
7692 | large or complex libraries when using import libs. |
7693 | ||
c0065db7 | 7694 | Linking directly to a dll uses no extra command-line switches other than |
69da35b5 | 7695 | @samp{-L} and @samp{-l}, because @command{ld} already searches for a number |
c0065db7 | 7696 | of names to match each library. All that is needed from the developer's |
69da35b5 NC |
7697 | perspective is an understanding of this search, in order to force ld to |
7698 | select the dll instead of an import library. | |
7699 | ||
2ca22b03 | 7700 | |
69da35b5 NC |
7701 | For instance, when ld is called with the argument @samp{-lxxx} it will attempt |
7702 | to find, in the first directory of its search path, | |
2ca22b03 NC |
7703 | |
7704 | @example | |
45e948fe NC |
7705 | libxxx.dll.a |
7706 | xxx.dll.a | |
7707 | libxxx.a | |
7708 | xxx.lib | |
69da35b5 | 7709 | cygxxx.dll (*) |
45e948fe NC |
7710 | libxxx.dll |
7711 | xxx.dll | |
2ca22b03 NC |
7712 | @end example |
7713 | ||
69da35b5 NC |
7714 | before moving on to the next directory in the search path. |
7715 | ||
c0065db7 RM |
7716 | (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll}, |
7717 | where @samp{<prefix>} is set by the @command{ld} option | |
7718 | @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec | |
7719 | file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for | |
69da35b5 NC |
7720 | @samp{cygxxx.dll}. |
7721 | ||
c0065db7 RM |
7722 | Other win32-based unix environments, such as mingw or pw32, may use other |
7723 | @samp{<prefix>}es, although at present only cygwin makes use of this feature. It | |
69da35b5 NC |
7724 | was originally intended to help avoid name conflicts among dll's built for the |
7725 | various win32/un*x environments, so that (for example) two versions of a zlib dll | |
7726 | could coexist on the same machine. | |
7727 | ||
2ca22b03 NC |
7728 | The generic cygwin/mingw path layout uses a @samp{bin} directory for |
7729 | applications and dll's and a @samp{lib} directory for the import | |
69da35b5 | 7730 | libraries (using cygwin nomenclature): |
2ca22b03 NC |
7731 | |
7732 | @example | |
7733 | bin/ | |
7734 | cygxxx.dll | |
7735 | lib/ | |
7736 | libxxx.dll.a (in case of dll's) | |
c0065db7 | 7737 | libxxx.a (in case of static archive) |
2ca22b03 NC |
7738 | @end example |
7739 | ||
c0065db7 RM |
7740 | Linking directly to a dll without using the import library can be |
7741 | done two ways: | |
2ca22b03 NC |
7742 | |
7743 | 1. Use the dll directly by adding the @samp{bin} path to the link line | |
7744 | @example | |
7745 | gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx | |
c0065db7 | 7746 | @end example |
2ca22b03 | 7747 | |
69da35b5 NC |
7748 | However, as the dll's often have version numbers appended to their names |
7749 | (@samp{cygncurses-5.dll}) this will often fail, unless one specifies | |
7750 | @samp{-L../bin -lncurses-5} to include the version. Import libs are generally | |
7751 | not versioned, and do not have this difficulty. | |
7752 | ||
2ca22b03 NC |
7753 | 2. Create a symbolic link from the dll to a file in the @samp{lib} |
7754 | directory according to the above mentioned search pattern. This | |
7755 | should be used to avoid unwanted changes in the tools needed for | |
7756 | making the app/dll. | |
7757 | ||
7758 | @example | |
7759 | ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a] | |
c0065db7 | 7760 | @end example |
2ca22b03 NC |
7761 | |
7762 | Then you can link without any make environment changes. | |
7763 | ||
7764 | @example | |
7765 | gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx | |
c0065db7 | 7766 | @end example |
69da35b5 NC |
7767 | |
7768 | This technique also avoids the version number problems, because the following is | |
7769 | perfectly legal | |
7770 | ||
7771 | @example | |
7772 | bin/ | |
7773 | cygxxx-5.dll | |
7774 | lib/ | |
c0065db7 | 7775 | libxxx.dll.a -> ../bin/cygxxx-5.dll |
69da35b5 NC |
7776 | @end example |
7777 | ||
dc8465bf | 7778 | Linking directly to a dll without using an import lib will work |
69da35b5 NC |
7779 | even when auto-import features are exercised, and even when |
7780 | @samp{--enable-runtime-pseudo-relocs} is used. | |
7781 | ||
7782 | Given the improvements in speed and memory usage, one might justifiably | |
45e948fe | 7783 | wonder why import libraries are used at all. There are three reasons: |
69da35b5 NC |
7784 | |
7785 | 1. Until recently, the link-directly-to-dll functionality did @emph{not} | |
7786 | work with auto-imported data. | |
7787 | ||
dc8465bf NC |
7788 | 2. Sometimes it is necessary to include pure static objects within the |
7789 | import library (which otherwise contains only bfd's for indirection | |
7790 | symbols that point to the exports of a dll). Again, the import lib | |
7791 | for the cygwin kernel makes use of this ability, and it is not | |
7792 | possible to do this without an import lib. | |
69da35b5 | 7793 | |
45e948fe NC |
7794 | 3. Symbol aliases can only be resolved using an import lib. This is |
7795 | critical when linking against OS-supplied dll's (eg, the win32 API) | |
7796 | in which symbols are usually exported as undecorated aliases of their | |
7797 | stdcall-decorated assembly names. | |
7798 | ||
69da35b5 | 7799 | So, import libs are not going away. But the ability to replace |
c0065db7 RM |
7800 | true import libs with a simple symbolic link to (or a copy of) |
7801 | a dll, in many cases, is a useful addition to the suite of tools | |
7802 | binutils makes available to the win32 developer. Given the | |
69da35b5 NC |
7803 | massive improvements in memory requirements during linking, storage |
7804 | requirements, and linking speed, we expect that many developers | |
7805 | will soon begin to use this feature whenever possible. | |
dc8465bf | 7806 | |
c0065db7 | 7807 | @item symbol aliasing |
dc8465bf | 7808 | @table @emph |
c0065db7 RM |
7809 | @item adding additional names |
7810 | Sometimes, it is useful to export symbols with additional names. | |
dc8465bf NC |
7811 | A symbol @samp{foo} will be exported as @samp{foo}, but it can also be |
7812 | exported as @samp{_foo} by using special directives in the DEF file | |
7813 | when creating the dll. This will affect also the optional created | |
c0065db7 | 7814 | import library. Consider the following DEF file: |
dc8465bf | 7815 | |
c0065db7 | 7816 | @example |
dc8465bf NC |
7817 | LIBRARY "xyz.dll" BASE=0x61000000 |
7818 | ||
7819 | EXPORTS | |
c0065db7 | 7820 | foo |
dc8465bf | 7821 | _foo = foo |
c0065db7 | 7822 | @end example |
dc8465bf NC |
7823 | |
7824 | The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}. | |
7825 | ||
7826 | Another method for creating a symbol alias is to create it in the | |
7827 | source code using the "weak" attribute: | |
7828 | ||
c0065db7 RM |
7829 | @example |
7830 | void foo () @{ /* Do something. */; @} | |
dc8465bf | 7831 | void _foo () __attribute__ ((weak, alias ("foo"))); |
c0065db7 | 7832 | @end example |
dc8465bf NC |
7833 | |
7834 | See the gcc manual for more information about attributes and weak | |
7835 | symbols. | |
7836 | ||
7837 | @item renaming symbols | |
7838 | Sometimes it is useful to rename exports. For instance, the cygwin | |
c0065db7 | 7839 | kernel does this regularly. A symbol @samp{_foo} can be exported as |
dc8465bf NC |
7840 | @samp{foo} but not as @samp{_foo} by using special directives in the |
7841 | DEF file. (This will also affect the import library, if it is | |
c0065db7 | 7842 | created). In the following example: |
dc8465bf | 7843 | |
c0065db7 | 7844 | @example |
dc8465bf NC |
7845 | LIBRARY "xyz.dll" BASE=0x61000000 |
7846 | ||
7847 | EXPORTS | |
7848 | _foo = foo | |
c0065db7 | 7849 | @end example |
dc8465bf NC |
7850 | |
7851 | The line @samp{_foo = foo} maps the exported symbol @samp{foo} to | |
7852 | @samp{_foo}. | |
c0065db7 | 7853 | @end table |
dc8465bf | 7854 | |
0a5d968e | 7855 | Note: using a DEF file disables the default auto-export behavior, |
c0065db7 | 7856 | unless the @samp{--export-all-symbols} command line option is used. |
0a5d968e | 7857 | If, however, you are trying to rename symbols, then you should list |
c0065db7 RM |
7858 | @emph{all} desired exports in the DEF file, including the symbols |
7859 | that are not being renamed, and do @emph{not} use the | |
7860 | @samp{--export-all-symbols} option. If you list only the | |
7861 | renamed symbols in the DEF file, and use @samp{--export-all-symbols} | |
7862 | to handle the other symbols, then the both the new names @emph{and} | |
7863 | the original names for the renamed symbols will be exported. | |
7864 | In effect, you'd be aliasing those symbols, not renaming them, | |
0a5d968e | 7865 | which is probably not what you wanted. |
c87db184 CF |
7866 | |
7867 | @cindex weak externals | |
7868 | @item weak externals | |
7869 | The Windows object format, PE, specifies a form of weak symbols called | |
7870 | weak externals. When a weak symbol is linked and the symbol is not | |
7871 | defined, the weak symbol becomes an alias for some other symbol. There | |
7872 | are three variants of weak externals: | |
7873 | @itemize | |
7874 | @item Definition is searched for in objects and libraries, historically | |
7875 | called lazy externals. | |
7876 | @item Definition is searched for only in other objects, not in libraries. | |
7877 | This form is not presently implemented. | |
7878 | @item No search; the symbol is an alias. This form is not presently | |
7879 | implemented. | |
7880 | @end itemize | |
7881 | As a GNU extension, weak symbols that do not specify an alternate symbol | |
7882 | are supported. If the symbol is undefined when linking, the symbol | |
7883 | uses a default value. | |
c1711530 DK |
7884 | |
7885 | @cindex aligned common symbols | |
7886 | @item aligned common symbols | |
7887 | As a GNU extension to the PE file format, it is possible to specify the | |
7888 | desired alignment for a common symbol. This information is conveyed from | |
7889 | the assembler or compiler to the linker by means of GNU-specific commands | |
7890 | carried in the object file's @samp{.drectve} section, which are recognized | |
7891 | by @command{ld} and respected when laying out the common symbols. Native | |
7892 | tools will be able to process object files employing this GNU extension, | |
7893 | but will fail to respect the alignment instructions, and may issue noisy | |
7894 | warnings about unknown linker directives. | |
5063daf7 | 7895 | |
2ca22b03 NC |
7896 | @end table |
7897 | ||
7898 | @ifclear GENERIC | |
7899 | @lowersections | |
7900 | @end ifclear | |
7901 | @end ifset | |
7902 | ||
e0001a05 NC |
7903 | @ifset XTENSA |
7904 | @ifclear GENERIC | |
7905 | @raisesections | |
7906 | @end ifclear | |
7907 | ||
7908 | @node Xtensa | |
7909 | @section @code{ld} and Xtensa Processors | |
7910 | ||
7911 | @cindex Xtensa processors | |
7912 | The default @command{ld} behavior for Xtensa processors is to interpret | |
7913 | @code{SECTIONS} commands so that lists of explicitly named sections in a | |
7914 | specification with a wildcard file will be interleaved when necessary to | |
7915 | keep literal pools within the range of PC-relative load offsets. For | |
7916 | example, with the command: | |
7917 | ||
7918 | @smallexample | |
7919 | SECTIONS | |
7920 | @{ | |
7921 | .text : @{ | |
7922 | *(.literal .text) | |
7923 | @} | |
7924 | @} | |
7925 | @end smallexample | |
7926 | ||
7927 | @noindent | |
7928 | @command{ld} may interleave some of the @code{.literal} | |
7929 | and @code{.text} sections from different object files to ensure that the | |
7930 | literal pools are within the range of PC-relative load offsets. A valid | |
7931 | interleaving might place the @code{.literal} sections from an initial | |
7932 | group of files followed by the @code{.text} sections of that group of | |
7933 | files. Then, the @code{.literal} sections from the rest of the files | |
7934 | and the @code{.text} sections from the rest of the files would follow. | |
e0001a05 | 7935 | |
43cd72b9 | 7936 | @cindex @option{--relax} on Xtensa |
e0001a05 | 7937 | @cindex relaxing on Xtensa |
43cd72b9 BW |
7938 | Relaxation is enabled by default for the Xtensa version of @command{ld} and |
7939 | provides two important link-time optimizations. The first optimization | |
7940 | is to combine identical literal values to reduce code size. A redundant | |
7941 | literal will be removed and all the @code{L32R} instructions that use it | |
7942 | will be changed to reference an identical literal, as long as the | |
7943 | location of the replacement literal is within the offset range of all | |
7944 | the @code{L32R} instructions. The second optimization is to remove | |
7945 | unnecessary overhead from assembler-generated ``longcall'' sequences of | |
7946 | @code{L32R}/@code{CALLX@var{n}} when the target functions are within | |
7947 | range of direct @code{CALL@var{n}} instructions. | |
7948 | ||
7949 | For each of these cases where an indirect call sequence can be optimized | |
7950 | to a direct call, the linker will change the @code{CALLX@var{n}} | |
7951 | instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R} | |
7952 | instruction, and remove the literal referenced by the @code{L32R} | |
7953 | instruction if it is not used for anything else. Removing the | |
7954 | @code{L32R} instruction always reduces code size but can potentially | |
7955 | hurt performance by changing the alignment of subsequent branch targets. | |
7956 | By default, the linker will always preserve alignments, either by | |
7957 | switching some instructions between 24-bit encodings and the equivalent | |
7958 | density instructions or by inserting a no-op in place of the @code{L32R} | |
7959 | instruction that was removed. If code size is more important than | |
7960 | performance, the @option{--size-opt} option can be used to prevent the | |
7961 | linker from widening density instructions or inserting no-ops, except in | |
7962 | a few cases where no-ops are required for correctness. | |
7963 | ||
7964 | The following Xtensa-specific command-line options can be used to | |
7965 | control the linker: | |
7966 | ||
7967 | @cindex Xtensa options | |
7968 | @table @option | |
43cd72b9 BW |
7969 | @item --size-opt |
7970 | When optimizing indirect calls to direct calls, optimize for code size | |
7971 | more than performance. With this option, the linker will not insert | |
7972 | no-ops or widen density instructions to preserve branch target | |
7973 | alignment. There may still be some cases where no-ops are required to | |
7974 | preserve the correctness of the code. | |
7975 | @end table | |
e0001a05 NC |
7976 | |
7977 | @ifclear GENERIC | |
7978 | @lowersections | |
7979 | @end ifclear | |
7980 | @end ifset | |
7981 | ||
252b5132 RH |
7982 | @ifclear SingleFormat |
7983 | @node BFD | |
7984 | @chapter BFD | |
7985 | ||
7986 | @cindex back end | |
7987 | @cindex object file management | |
7988 | @cindex object formats available | |
7989 | @kindex objdump -i | |
7990 | The linker accesses object and archive files using the BFD libraries. | |
7991 | These libraries allow the linker to use the same routines to operate on | |
7992 | object files whatever the object file format. A different object file | |
7993 | format can be supported simply by creating a new BFD back end and adding | |
7994 | it to the library. To conserve runtime memory, however, the linker and | |
7995 | associated tools are usually configured to support only a subset of the | |
7996 | object file formats available. You can use @code{objdump -i} | |
7997 | (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to | |
7998 | list all the formats available for your configuration. | |
7999 | ||
8000 | @cindex BFD requirements | |
8001 | @cindex requirements for BFD | |
8002 | As with most implementations, BFD is a compromise between | |
8003 | several conflicting requirements. The major factor influencing | |
8004 | BFD design was efficiency: any time used converting between | |
8005 | formats is time which would not have been spent had BFD not | |
8006 | been involved. This is partly offset by abstraction payback; since | |
8007 | BFD simplifies applications and back ends, more time and care | |
8008 | may be spent optimizing algorithms for a greater speed. | |
8009 | ||
8010 | One minor artifact of the BFD solution which you should bear in | |
8011 | mind is the potential for information loss. There are two places where | |
8012 | useful information can be lost using the BFD mechanism: during | |
8013 | conversion and during output. @xref{BFD information loss}. | |
8014 | ||
8015 | @menu | |
8016 | * BFD outline:: How it works: an outline of BFD | |
8017 | @end menu | |
8018 | ||
8019 | @node BFD outline | |
36f63dca | 8020 | @section How It Works: An Outline of BFD |
252b5132 RH |
8021 | @cindex opening object files |
8022 | @include bfdsumm.texi | |
8023 | @end ifclear | |
8024 | ||
8025 | @node Reporting Bugs | |
8026 | @chapter Reporting Bugs | |
ff5dcc92 SC |
8027 | @cindex bugs in @command{ld} |
8028 | @cindex reporting bugs in @command{ld} | |
252b5132 | 8029 | |
ff5dcc92 | 8030 | Your bug reports play an essential role in making @command{ld} reliable. |
252b5132 RH |
8031 | |
8032 | Reporting a bug may help you by bringing a solution to your problem, or | |
8033 | it may not. But in any case the principal function of a bug report is | |
ff5dcc92 | 8034 | to help the entire community by making the next version of @command{ld} |
252b5132 | 8035 | work better. Bug reports are your contribution to the maintenance of |
ff5dcc92 | 8036 | @command{ld}. |
252b5132 RH |
8037 | |
8038 | In order for a bug report to serve its purpose, you must include the | |
8039 | information that enables us to fix the bug. | |
8040 | ||
8041 | @menu | |
8042 | * Bug Criteria:: Have you found a bug? | |
8043 | * Bug Reporting:: How to report bugs | |
8044 | @end menu | |
8045 | ||
8046 | @node Bug Criteria | |
36f63dca | 8047 | @section Have You Found a Bug? |
252b5132 RH |
8048 | @cindex bug criteria |
8049 | ||
8050 | If you are not sure whether you have found a bug, here are some guidelines: | |
8051 | ||
8052 | @itemize @bullet | |
8053 | @cindex fatal signal | |
8054 | @cindex linker crash | |
8055 | @cindex crash of linker | |
8056 | @item | |
8057 | If the linker gets a fatal signal, for any input whatever, that is a | |
ff5dcc92 | 8058 | @command{ld} bug. Reliable linkers never crash. |
252b5132 RH |
8059 | |
8060 | @cindex error on valid input | |
8061 | @item | |
ff5dcc92 | 8062 | If @command{ld} produces an error message for valid input, that is a bug. |
252b5132 RH |
8063 | |
8064 | @cindex invalid input | |
8065 | @item | |
ff5dcc92 | 8066 | If @command{ld} does not produce an error message for invalid input, that |
252b5132 RH |
8067 | may be a bug. In the general case, the linker can not verify that |
8068 | object files are correct. | |
8069 | ||
8070 | @item | |
8071 | If you are an experienced user of linkers, your suggestions for | |
ff5dcc92 | 8072 | improvement of @command{ld} are welcome in any case. |
252b5132 RH |
8073 | @end itemize |
8074 | ||
8075 | @node Bug Reporting | |
36f63dca | 8076 | @section How to Report Bugs |
252b5132 | 8077 | @cindex bug reports |
ff5dcc92 | 8078 | @cindex @command{ld} bugs, reporting |
252b5132 RH |
8079 | |
8080 | A number of companies and individuals offer support for @sc{gnu} | |
ff5dcc92 | 8081 | products. If you obtained @command{ld} from a support organization, we |
252b5132 RH |
8082 | recommend you contact that organization first. |
8083 | ||
8084 | You can find contact information for many support companies and | |
8085 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
8086 | distribution. | |
8087 | ||
ad22bfe8 | 8088 | @ifset BUGURL |
ff5dcc92 | 8089 | Otherwise, send bug reports for @command{ld} to |
ad22bfe8 JM |
8090 | @value{BUGURL}. |
8091 | @end ifset | |
252b5132 RH |
8092 | |
8093 | The fundamental principle of reporting bugs usefully is this: | |
8094 | @strong{report all the facts}. If you are not sure whether to state a | |
8095 | fact or leave it out, state it! | |
8096 | ||
8097 | Often people omit facts because they think they know what causes the | |
8098 | problem and assume that some details do not matter. Thus, you might | |
b553b183 NC |
8099 | assume that the name of a symbol you use in an example does not |
8100 | matter. Well, probably it does not, but one cannot be sure. Perhaps | |
8101 | the bug is a stray memory reference which happens to fetch from the | |
8102 | location where that name is stored in memory; perhaps, if the name | |
8103 | were different, the contents of that location would fool the linker | |
8104 | into doing the right thing despite the bug. Play it safe and give a | |
8105 | specific, complete example. That is the easiest thing for you to do, | |
c0065db7 | 8106 | and the most helpful. |
b553b183 NC |
8107 | |
8108 | Keep in mind that the purpose of a bug report is to enable us to fix | |
8109 | the bug if it is new to us. Therefore, always write your bug reports | |
8110 | on the assumption that the bug has not been reported previously. | |
252b5132 RH |
8111 | |
8112 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
36f63dca NC |
8113 | bell?'' This cannot help us fix a bug, so it is basically useless. We |
8114 | respond by asking for enough details to enable us to investigate. | |
8115 | You might as well expedite matters by sending them to begin with. | |
252b5132 RH |
8116 | |
8117 | To enable us to fix the bug, you should include all these things: | |
8118 | ||
8119 | @itemize @bullet | |
8120 | @item | |
ff5dcc92 | 8121 | The version of @command{ld}. @command{ld} announces it if you start it with |
252b5132 RH |
8122 | the @samp{--version} argument. |
8123 | ||
8124 | Without this, we will not know whether there is any point in looking for | |
ff5dcc92 | 8125 | the bug in the current version of @command{ld}. |
252b5132 RH |
8126 | |
8127 | @item | |
ff5dcc92 | 8128 | Any patches you may have applied to the @command{ld} source, including any |
252b5132 RH |
8129 | patches made to the @code{BFD} library. |
8130 | ||
8131 | @item | |
8132 | The type of machine you are using, and the operating system name and | |
8133 | version number. | |
8134 | ||
8135 | @item | |
ff5dcc92 | 8136 | What compiler (and its version) was used to compile @command{ld}---e.g. |
252b5132 RH |
8137 | ``@code{gcc-2.7}''. |
8138 | ||
8139 | @item | |
8140 | The command arguments you gave the linker to link your example and | |
8141 | observe the bug. To guarantee you will not omit something important, | |
8142 | list them all. A copy of the Makefile (or the output from make) is | |
8143 | sufficient. | |
8144 | ||
8145 | If we were to try to guess the arguments, we would probably guess wrong | |
8146 | and then we might not encounter the bug. | |
8147 | ||
8148 | @item | |
8149 | A complete input file, or set of input files, that will reproduce the | |
b553b183 NC |
8150 | bug. It is generally most helpful to send the actual object files |
8151 | provided that they are reasonably small. Say no more than 10K. For | |
8152 | bigger files you can either make them available by FTP or HTTP or else | |
8153 | state that you are willing to send the object file(s) to whomever | |
8154 | requests them. (Note - your email will be going to a mailing list, so | |
8155 | we do not want to clog it up with large attachments). But small | |
8156 | attachments are best. | |
252b5132 RH |
8157 | |
8158 | If the source files were assembled using @code{gas} or compiled using | |
8159 | @code{gcc}, then it may be OK to send the source files rather than the | |
8160 | object files. In this case, be sure to say exactly what version of | |
8161 | @code{gas} or @code{gcc} was used to produce the object files. Also say | |
8162 | how @code{gas} or @code{gcc} were configured. | |
8163 | ||
8164 | @item | |
8165 | A description of what behavior you observe that you believe is | |
8166 | incorrect. For example, ``It gets a fatal signal.'' | |
8167 | ||
ff5dcc92 | 8168 | Of course, if the bug is that @command{ld} gets a fatal signal, then we |
252b5132 RH |
8169 | will certainly notice it. But if the bug is incorrect output, we might |
8170 | not notice unless it is glaringly wrong. You might as well not give us | |
8171 | a chance to make a mistake. | |
8172 | ||
8173 | Even if the problem you experience is a fatal signal, you should still | |
8174 | say so explicitly. Suppose something strange is going on, such as, your | |
b45619c0 | 8175 | copy of @command{ld} is out of sync, or you have encountered a bug in the |
252b5132 RH |
8176 | C library on your system. (This has happened!) Your copy might crash |
8177 | and ours would not. If you told us to expect a crash, then when ours | |
8178 | fails to crash, we would know that the bug was not happening for us. If | |
8179 | you had not told us to expect a crash, then we would not be able to draw | |
8180 | any conclusion from our observations. | |
8181 | ||
8182 | @item | |
ff5dcc92 | 8183 | If you wish to suggest changes to the @command{ld} source, send us context |
252b5132 RH |
8184 | diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or |
8185 | @samp{-p} option. Always send diffs from the old file to the new file. | |
ff5dcc92 | 8186 | If you even discuss something in the @command{ld} source, refer to it by |
252b5132 RH |
8187 | context, not by line number. |
8188 | ||
8189 | The line numbers in our development sources will not match those in your | |
8190 | sources. Your line numbers would convey no useful information to us. | |
8191 | @end itemize | |
8192 | ||
8193 | Here are some things that are not necessary: | |
8194 | ||
8195 | @itemize @bullet | |
8196 | @item | |
8197 | A description of the envelope of the bug. | |
8198 | ||
8199 | Often people who encounter a bug spend a lot of time investigating | |
8200 | which changes to the input file will make the bug go away and which | |
8201 | changes will not affect it. | |
8202 | ||
8203 | This is often time consuming and not very useful, because the way we | |
8204 | will find the bug is by running a single example under the debugger | |
8205 | with breakpoints, not by pure deduction from a series of examples. | |
8206 | We recommend that you save your time for something else. | |
8207 | ||
8208 | Of course, if you can find a simpler example to report @emph{instead} | |
8209 | of the original one, that is a convenience for us. Errors in the | |
8210 | output will be easier to spot, running under the debugger will take | |
8211 | less time, and so on. | |
8212 | ||
8213 | However, simplification is not vital; if you do not want to do this, | |
8214 | report the bug anyway and send us the entire test case you used. | |
8215 | ||
8216 | @item | |
8217 | A patch for the bug. | |
8218 | ||
8219 | A patch for the bug does help us if it is a good one. But do not omit | |
8220 | the necessary information, such as the test case, on the assumption that | |
8221 | a patch is all we need. We might see problems with your patch and decide | |
8222 | to fix the problem another way, or we might not understand it at all. | |
8223 | ||
ff5dcc92 | 8224 | Sometimes with a program as complicated as @command{ld} it is very hard to |
252b5132 RH |
8225 | construct an example that will make the program follow a certain path |
8226 | through the code. If you do not send us the example, we will not be | |
8227 | able to construct one, so we will not be able to verify that the bug is | |
8228 | fixed. | |
8229 | ||
8230 | And if we cannot understand what bug you are trying to fix, or why your | |
8231 | patch should be an improvement, we will not install it. A test case will | |
8232 | help us to understand. | |
8233 | ||
8234 | @item | |
8235 | A guess about what the bug is or what it depends on. | |
8236 | ||
8237 | Such guesses are usually wrong. Even we cannot guess right about such | |
8238 | things without first using the debugger to find the facts. | |
8239 | @end itemize | |
8240 | ||
8241 | @node MRI | |
8242 | @appendix MRI Compatible Script Files | |
8243 | @cindex MRI compatibility | |
ff5dcc92 SC |
8244 | To aid users making the transition to @sc{gnu} @command{ld} from the MRI |
8245 | linker, @command{ld} can use MRI compatible linker scripts as an | |
252b5132 RH |
8246 | alternative to the more general-purpose linker scripting language |
8247 | described in @ref{Scripts}. MRI compatible linker scripts have a much | |
8248 | simpler command set than the scripting language otherwise used with | |
ff5dcc92 | 8249 | @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI |
252b5132 RH |
8250 | linker commands; these commands are described here. |
8251 | ||
8252 | In general, MRI scripts aren't of much use with the @code{a.out} object | |
8253 | file format, since it only has three sections and MRI scripts lack some | |
8254 | features to make use of them. | |
8255 | ||
8256 | You can specify a file containing an MRI-compatible script using the | |
8257 | @samp{-c} command-line option. | |
8258 | ||
8259 | Each command in an MRI-compatible script occupies its own line; each | |
8260 | command line starts with the keyword that identifies the command (though | |
8261 | blank lines are also allowed for punctuation). If a line of an | |
ff5dcc92 | 8262 | MRI-compatible script begins with an unrecognized keyword, @command{ld} |
252b5132 RH |
8263 | issues a warning message, but continues processing the script. |
8264 | ||
8265 | Lines beginning with @samp{*} are comments. | |
8266 | ||
8267 | You can write these commands using all upper-case letters, or all | |
8268 | lower case; for example, @samp{chip} is the same as @samp{CHIP}. | |
8269 | The following list shows only the upper-case form of each command. | |
8270 | ||
8271 | @table @code | |
8272 | @cindex @code{ABSOLUTE} (MRI) | |
8273 | @item ABSOLUTE @var{secname} | |
8274 | @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname} | |
ff5dcc92 | 8275 | Normally, @command{ld} includes in the output file all sections from all |
252b5132 RH |
8276 | the input files. However, in an MRI-compatible script, you can use the |
8277 | @code{ABSOLUTE} command to restrict the sections that will be present in | |
8278 | your output program. If the @code{ABSOLUTE} command is used at all in a | |
8279 | script, then only the sections named explicitly in @code{ABSOLUTE} | |
8280 | commands will appear in the linker output. You can still use other | |
8281 | input sections (whatever you select on the command line, or using | |
8282 | @code{LOAD}) to resolve addresses in the output file. | |
8283 | ||
8284 | @cindex @code{ALIAS} (MRI) | |
8285 | @item ALIAS @var{out-secname}, @var{in-secname} | |
8286 | Use this command to place the data from input section @var{in-secname} | |
8287 | in a section called @var{out-secname} in the linker output file. | |
8288 | ||
8289 | @var{in-secname} may be an integer. | |
8290 | ||
8291 | @cindex @code{ALIGN} (MRI) | |
8292 | @item ALIGN @var{secname} = @var{expression} | |
8293 | Align the section called @var{secname} to @var{expression}. The | |
8294 | @var{expression} should be a power of two. | |
8295 | ||
8296 | @cindex @code{BASE} (MRI) | |
8297 | @item BASE @var{expression} | |
8298 | Use the value of @var{expression} as the lowest address (other than | |
8299 | absolute addresses) in the output file. | |
8300 | ||
8301 | @cindex @code{CHIP} (MRI) | |
8302 | @item CHIP @var{expression} | |
8303 | @itemx CHIP @var{expression}, @var{expression} | |
8304 | This command does nothing; it is accepted only for compatibility. | |
8305 | ||
8306 | @cindex @code{END} (MRI) | |
8307 | @item END | |
8308 | This command does nothing whatever; it's only accepted for compatibility. | |
8309 | ||
8310 | @cindex @code{FORMAT} (MRI) | |
8311 | @item FORMAT @var{output-format} | |
8312 | Similar to the @code{OUTPUT_FORMAT} command in the more general linker | |
a1ab1d2a | 8313 | language, but restricted to one of these output formats: |
252b5132 RH |
8314 | |
8315 | @enumerate | |
a1ab1d2a | 8316 | @item |
252b5132 RH |
8317 | S-records, if @var{output-format} is @samp{S} |
8318 | ||
8319 | @item | |
8320 | IEEE, if @var{output-format} is @samp{IEEE} | |
8321 | ||
8322 | @item | |
8323 | COFF (the @samp{coff-m68k} variant in BFD), if @var{output-format} is | |
8324 | @samp{COFF} | |
8325 | @end enumerate | |
8326 | ||
8327 | @cindex @code{LIST} (MRI) | |
8328 | @item LIST @var{anything}@dots{} | |
8329 | Print (to the standard output file) a link map, as produced by the | |
ff5dcc92 | 8330 | @command{ld} command-line option @samp{-M}. |
252b5132 RH |
8331 | |
8332 | The keyword @code{LIST} may be followed by anything on the | |
8333 | same line, with no change in its effect. | |
8334 | ||
8335 | @cindex @code{LOAD} (MRI) | |
8336 | @item LOAD @var{filename} | |
8337 | @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename} | |
8338 | Include one or more object file @var{filename} in the link; this has the | |
ff5dcc92 | 8339 | same effect as specifying @var{filename} directly on the @command{ld} |
252b5132 RH |
8340 | command line. |
8341 | ||
8342 | @cindex @code{NAME} (MRI) | |
8343 | @item NAME @var{output-name} | |
ff5dcc92 | 8344 | @var{output-name} is the name for the program produced by @command{ld}; the |
252b5132 RH |
8345 | MRI-compatible command @code{NAME} is equivalent to the command-line |
8346 | option @samp{-o} or the general script language command @code{OUTPUT}. | |
8347 | ||
8348 | @cindex @code{ORDER} (MRI) | |
8349 | @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname} | |
8350 | @itemx ORDER @var{secname} @var{secname} @var{secname} | |
ff5dcc92 | 8351 | Normally, @command{ld} orders the sections in its output file in the |
252b5132 RH |
8352 | order in which they first appear in the input files. In an MRI-compatible |
8353 | script, you can override this ordering with the @code{ORDER} command. The | |
8354 | sections you list with @code{ORDER} will appear first in your output | |
8355 | file, in the order specified. | |
8356 | ||
8357 | @cindex @code{PUBLIC} (MRI) | |
8358 | @item PUBLIC @var{name}=@var{expression} | |
8359 | @itemx PUBLIC @var{name},@var{expression} | |
8360 | @itemx PUBLIC @var{name} @var{expression} | |
8361 | Supply a value (@var{expression}) for external symbol | |
8362 | @var{name} used in the linker input files. | |
8363 | ||
8364 | @cindex @code{SECT} (MRI) | |
8365 | @item SECT @var{secname}, @var{expression} | |
8366 | @itemx SECT @var{secname}=@var{expression} | |
8367 | @itemx SECT @var{secname} @var{expression} | |
8368 | You can use any of these three forms of the @code{SECT} command to | |
8369 | specify the start address (@var{expression}) for section @var{secname}. | |
8370 | If you have more than one @code{SECT} statement for the same | |
8371 | @var{secname}, only the @emph{first} sets the start address. | |
8372 | @end table | |
8373 | ||
793c5807 NC |
8374 | @node GNU Free Documentation License |
8375 | @appendix GNU Free Documentation License | |
36f63dca | 8376 | @include fdl.texi |
704c465c | 8377 | |
370b66a1 CD |
8378 | @node LD Index |
8379 | @unnumbered LD Index | |
252b5132 RH |
8380 | |
8381 | @printindex cp | |
8382 | ||
8383 | @tex | |
7ca01ed9 | 8384 | % I think something like @@colophon should be in texinfo. In the |
252b5132 RH |
8385 | % meantime: |
8386 | \long\def\colophon{\hbox to0pt{}\vfill | |
8387 | \centerline{The body of this manual is set in} | |
8388 | \centerline{\fontname\tenrm,} | |
8389 | \centerline{with headings in {\bf\fontname\tenbf}} | |
8390 | \centerline{and examples in {\tt\fontname\tentt}.} | |
8391 | \centerline{{\it\fontname\tenit\/} and} | |
8392 | \centerline{{\sl\fontname\tensl\/}} | |
8393 | \centerline{are used for emphasis.}\vfill} | |
8394 | \page\colophon | |
7ca01ed9 | 8395 | % Blame: doc@@cygnus.com, 28mar91. |
252b5132 RH |
8396 | @end tex |
8397 | ||
252b5132 | 8398 | @bye |