Commit | Line | Data |
---|---|---|
252b5132 RH |
1 | \input texinfo |
2 | @setfilename ld.info | |
219d1afa | 3 | @c Copyright (C) 1991-2018 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 M68HC11 |
7fb9f789 | 27 | @set M68K |
833794fc | 28 | @set MIPS |
3c3bdf30 | 29 | @set MMIX |
2469cfa2 | 30 | @set MSP430 |
35c08157 | 31 | @set NDS32 |
78058a5e | 32 | @set NIOSII |
2a60a7a8 AM |
33 | @set POWERPC |
34 | @set POWERPC64 | |
49fa1e15 | 35 | @set Renesas |
b4cbbe8f | 36 | @set S/390 |
49fa1e15 AM |
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 | |
219d1afa | 58 | Copyright @copyright{} 1991-2018 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 |
219d1afa | 95 | Copyright @copyright{} 1991-2018 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 | 136 | @end ifset |
36f63dca NC |
137 | @ifset ARM |
138 | * ARM:: ld and the ARM family | |
139 | @end ifset | |
93fd0973 SC |
140 | @ifset M68HC11 |
141 | * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families | |
142 | @end ifset | |
7ca01ed9 NC |
143 | @ifset HPPA |
144 | * HPPA ELF32:: ld and HPPA 32-bit ELF | |
145 | @end ifset | |
7fb9f789 NC |
146 | @ifset M68K |
147 | * M68K:: ld and Motorola 68K family | |
148 | @end ifset | |
833794fc MR |
149 | @ifset MIPS |
150 | * MIPS:: ld and MIPS family | |
151 | @end ifset | |
2a60a7a8 AM |
152 | @ifset POWERPC |
153 | * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support | |
154 | @end ifset | |
155 | @ifset POWERPC64 | |
156 | * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support | |
157 | @end ifset | |
b4cbbe8f AK |
158 | @ifset S/390 |
159 | * S/390 ELF:: ld and S/390 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 | @ifclear SingleFormat |
381 | @cindex binary input format | |
382 | @kindex -b @var{format} | |
383 | @kindex --format=@var{format} | |
384 | @cindex input format | |
385 | @cindex input format | |
386 | @item -b @var{input-format} | |
387 | @itemx --format=@var{input-format} | |
ff5dcc92 SC |
388 | @command{ld} may be configured to support more than one kind of object |
389 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 390 | @samp{-b} option to specify the binary format for input object files |
ff5dcc92 | 391 | that follow this option on the command line. Even when @command{ld} is |
252b5132 | 392 | configured to support alternative object formats, you don't usually need |
ff5dcc92 | 393 | to specify this, as @command{ld} should be configured to expect as a |
252b5132 RH |
394 | default input format the most usual format on each machine. |
395 | @var{input-format} is a text string, the name of a particular format | |
396 | supported by the BFD libraries. (You can list the available binary | |
397 | formats with @samp{objdump -i}.) | |
398 | @xref{BFD}. | |
399 | ||
400 | You may want to use this option if you are linking files with an unusual | |
401 | binary format. You can also use @samp{-b} to switch formats explicitly (when | |
402 | linking object files of different formats), by including | |
403 | @samp{-b @var{input-format}} before each group of object files in a | |
a1ab1d2a | 404 | particular format. |
252b5132 RH |
405 | |
406 | The default format is taken from the environment variable | |
407 | @code{GNUTARGET}. | |
408 | @ifset UsesEnvVars | |
409 | @xref{Environment}. | |
410 | @end ifset | |
411 | You can also define the input format from a script, using the command | |
0285c67d NC |
412 | @code{TARGET}; |
413 | @ifclear man | |
414 | see @ref{Format Commands}. | |
415 | @end ifclear | |
252b5132 RH |
416 | @end ifclear |
417 | ||
418 | @kindex -c @var{MRI-cmdfile} | |
419 | @kindex --mri-script=@var{MRI-cmdfile} | |
420 | @cindex compatibility, MRI | |
421 | @item -c @var{MRI-commandfile} | |
422 | @itemx --mri-script=@var{MRI-commandfile} | |
ff5dcc92 | 423 | For compatibility with linkers produced by MRI, @command{ld} accepts script |
252b5132 | 424 | files written in an alternate, restricted command language, described in |
0285c67d NC |
425 | @ifclear man |
426 | @ref{MRI,,MRI Compatible Script Files}. | |
427 | @end ifclear | |
428 | @ifset man | |
429 | the MRI Compatible Script Files section of GNU ld documentation. | |
430 | @end ifset | |
431 | Introduce MRI script files with | |
252b5132 | 432 | the option @samp{-c}; use the @samp{-T} option to run linker |
ff5dcc92 SC |
433 | scripts written in the general-purpose @command{ld} scripting language. |
434 | If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories | |
252b5132 RH |
435 | specified by any @samp{-L} options. |
436 | ||
437 | @cindex common allocation | |
438 | @kindex -d | |
439 | @kindex -dc | |
440 | @kindex -dp | |
a1ab1d2a | 441 | @item -d |
252b5132 RH |
442 | @itemx -dc |
443 | @itemx -dp | |
444 | These three options are equivalent; multiple forms are supported for | |
445 | compatibility with other linkers. They assign space to common symbols | |
446 | even if a relocatable output file is specified (with @samp{-r}). The | |
447 | script command @code{FORCE_COMMON_ALLOCATION} has the same effect. | |
448 | @xref{Miscellaneous Commands}. | |
449 | ||
7ee314fa AM |
450 | @kindex --depaudit @var{AUDITLIB} |
451 | @kindex -P @var{AUDITLIB} | |
452 | @item --depaudit @var{AUDITLIB} | |
453 | @itemx -P @var{AUDITLIB} | |
454 | Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section. | |
455 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
456 | specified in the library. If specified multiple times @code{DT_DEPAUDIT} | |
457 | will contain a colon separated list of audit interfaces to use. This | |
458 | option is only meaningful on ELF platforms supporting the rtld-audit interface. | |
9d5777a3 | 459 | The -P option is provided for Solaris compatibility. |
7ee314fa | 460 | |
252b5132 RH |
461 | @cindex entry point, from command line |
462 | @kindex -e @var{entry} | |
463 | @kindex --entry=@var{entry} | |
a1ab1d2a | 464 | @item -e @var{entry} |
252b5132 RH |
465 | @itemx --entry=@var{entry} |
466 | Use @var{entry} as the explicit symbol for beginning execution of your | |
467 | program, rather than the default entry point. If there is no symbol | |
468 | named @var{entry}, the linker will try to parse @var{entry} as a number, | |
469 | and use that as the entry address (the number will be interpreted in | |
470 | base 10; you may use a leading @samp{0x} for base 16, or a leading | |
471 | @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults | |
472 | and other ways of specifying the entry point. | |
473 | ||
b58f81ae DJ |
474 | @kindex --exclude-libs |
475 | @item --exclude-libs @var{lib},@var{lib},... | |
476 | Specifies a list of archive libraries from which symbols should not be automatically | |
e1c37eb5 | 477 | exported. The library names may be delimited by commas or colons. Specifying |
b58f81ae DJ |
478 | @code{--exclude-libs ALL} excludes symbols in all archive libraries from |
479 | automatic export. This option is available only for the i386 PE targeted | |
480 | port of the linker and for ELF targeted ports. For i386 PE, symbols | |
481 | explicitly listed in a .def file are still exported, regardless of this | |
482 | option. For ELF targeted ports, symbols affected by this option will | |
483 | be treated as hidden. | |
484 | ||
e1c37eb5 DK |
485 | @kindex --exclude-modules-for-implib |
486 | @item --exclude-modules-for-implib @var{module},@var{module},... | |
487 | Specifies a list of object files or archive members, from which symbols | |
488 | should not be automatically exported, but which should be copied wholesale | |
489 | into the import library being generated during the link. The module names | |
490 | may be delimited by commas or colons, and must match exactly the filenames | |
491 | used by @command{ld} to open the files; for archive members, this is simply | |
492 | the member name, but for object files the name listed must include and | |
493 | match precisely any path used to specify the input file on the linker's | |
494 | command-line. This option is available only for the i386 PE targeted port | |
495 | of the linker. Symbols explicitly listed in a .def file are still exported, | |
496 | regardless of this option. | |
497 | ||
252b5132 RH |
498 | @cindex dynamic symbol table |
499 | @kindex -E | |
500 | @kindex --export-dynamic | |
267e2722 | 501 | @kindex --no-export-dynamic |
252b5132 RH |
502 | @item -E |
503 | @itemx --export-dynamic | |
267e2722 CD |
504 | @itemx --no-export-dynamic |
505 | When creating a dynamically linked executable, using the @option{-E} | |
506 | option or the @option{--export-dynamic} option causes the linker to add | |
507 | all symbols to the dynamic symbol table. The dynamic symbol table is the | |
508 | set of symbols which are visible from dynamic objects at run time. | |
509 | ||
510 | If you do not use either of these options (or use the | |
511 | @option{--no-export-dynamic} option to restore the default behavior), the | |
512 | dynamic symbol table will normally contain only those symbols which are | |
513 | referenced by some dynamic object mentioned in the link. | |
252b5132 RH |
514 | |
515 | If you use @code{dlopen} to load a dynamic object which needs to refer | |
516 | back to the symbols defined by the program, rather than some other | |
517 | dynamic object, then you will probably need to use this option when | |
518 | linking the program itself. | |
519 | ||
55255dae | 520 | You can also use the dynamic list to control what symbols should |
cb840a31 | 521 | be added to the dynamic symbol table if the output format supports it. |
55255dae | 522 | See the description of @samp{--dynamic-list}. |
cb840a31 | 523 | |
8b747e1a DK |
524 | Note that this option is specific to ELF targeted ports. PE targets |
525 | support a similar function to export all symbols from a DLL or EXE; see | |
526 | the description of @samp{--export-all-symbols} below. | |
527 | ||
36f63dca | 528 | @ifclear SingleFormat |
252b5132 RH |
529 | @cindex big-endian objects |
530 | @cindex endianness | |
531 | @kindex -EB | |
532 | @item -EB | |
533 | Link big-endian objects. This affects the default output format. | |
534 | ||
535 | @cindex little-endian objects | |
536 | @kindex -EL | |
537 | @item -EL | |
538 | Link little-endian objects. This affects the default output format. | |
36f63dca | 539 | @end ifclear |
252b5132 | 540 | |
2509a395 SL |
541 | @kindex -f @var{name} |
542 | @kindex --auxiliary=@var{name} | |
543 | @item -f @var{name} | |
544 | @itemx --auxiliary=@var{name} | |
252b5132 RH |
545 | When creating an ELF shared object, set the internal DT_AUXILIARY field |
546 | to the specified name. This tells the dynamic linker that the symbol | |
547 | table of the shared object should be used as an auxiliary filter on the | |
548 | symbol table of the shared object @var{name}. | |
549 | ||
550 | If you later link a program against this filter object, then, when you | |
551 | run the program, the dynamic linker will see the DT_AUXILIARY field. If | |
552 | the dynamic linker resolves any symbols from the filter object, it will | |
553 | first check whether there is a definition in the shared object | |
554 | @var{name}. If there is one, it will be used instead of the definition | |
555 | in the filter object. The shared object @var{name} need not exist. | |
556 | Thus the shared object @var{name} may be used to provide an alternative | |
557 | implementation of certain functions, perhaps for debugging or for | |
558 | machine specific performance. | |
559 | ||
560 | This option may be specified more than once. The DT_AUXILIARY entries | |
561 | will be created in the order in which they appear on the command line. | |
562 | ||
2509a395 SL |
563 | @kindex -F @var{name} |
564 | @kindex --filter=@var{name} | |
252b5132 | 565 | @item -F @var{name} |
2509a395 | 566 | @itemx --filter=@var{name} |
252b5132 RH |
567 | When creating an ELF shared object, set the internal DT_FILTER field to |
568 | the specified name. This tells the dynamic linker that the symbol table | |
569 | of the shared object which is being created should be used as a filter | |
570 | on the symbol table of the shared object @var{name}. | |
571 | ||
572 | If you later link a program against this filter object, then, when you | |
573 | run the program, the dynamic linker will see the DT_FILTER field. The | |
574 | dynamic linker will resolve symbols according to the symbol table of the | |
575 | filter object as usual, but it will actually link to the definitions | |
576 | found in the shared object @var{name}. Thus the filter object can be | |
577 | used to select a subset of the symbols provided by the object | |
578 | @var{name}. | |
579 | ||
ff5dcc92 | 580 | Some older linkers used the @option{-F} option throughout a compilation |
252b5132 | 581 | toolchain for specifying object-file format for both input and output |
36f63dca NC |
582 | object files. |
583 | @ifclear SingleFormat | |
584 | The @sc{gnu} linker uses other mechanisms for this purpose: the | |
ece2d90e | 585 | @option{-b}, @option{--format}, @option{--oformat} options, the |
252b5132 | 586 | @code{TARGET} command in linker scripts, and the @code{GNUTARGET} |
36f63dca NC |
587 | environment variable. |
588 | @end ifclear | |
589 | The @sc{gnu} linker will ignore the @option{-F} option when not | |
590 | creating an ELF shared object. | |
252b5132 | 591 | |
3dbf70a2 | 592 | @cindex finalization function |
2509a395 SL |
593 | @kindex -fini=@var{name} |
594 | @item -fini=@var{name} | |
3dbf70a2 MM |
595 | When creating an ELF executable or shared object, call NAME when the |
596 | executable or shared object is unloaded, by setting DT_FINI to the | |
597 | address of the function. By default, the linker uses @code{_fini} as | |
598 | the function to call. | |
599 | ||
252b5132 RH |
600 | @kindex -g |
601 | @item -g | |
602 | Ignored. Provided for compatibility with other tools. | |
603 | ||
2509a395 SL |
604 | @kindex -G @var{value} |
605 | @kindex --gpsize=@var{value} | |
252b5132 | 606 | @cindex object size |
2509a395 | 607 | @item -G @var{value} |
252b5132 RH |
608 | @itemx --gpsize=@var{value} |
609 | Set the maximum size of objects to be optimized using the GP register to | |
610 | @var{size}. This is only meaningful for object file formats such as | |
e8044f35 | 611 | MIPS ELF that support putting large and small objects into different |
252b5132 RH |
612 | sections. This is ignored for other object file formats. |
613 | ||
614 | @cindex runtime library name | |
2509a395 | 615 | @kindex -h @var{name} |
252b5132 | 616 | @kindex -soname=@var{name} |
2509a395 | 617 | @item -h @var{name} |
252b5132 RH |
618 | @itemx -soname=@var{name} |
619 | When creating an ELF shared object, set the internal DT_SONAME field to | |
620 | the specified name. When an executable is linked with a shared object | |
621 | which has a DT_SONAME field, then when the executable is run the dynamic | |
622 | linker will attempt to load the shared object specified by the DT_SONAME | |
623 | field rather than the using the file name given to the linker. | |
624 | ||
625 | @kindex -i | |
626 | @cindex incremental link | |
627 | @item -i | |
628 | Perform an incremental link (same as option @samp{-r}). | |
629 | ||
3dbf70a2 | 630 | @cindex initialization function |
2509a395 SL |
631 | @kindex -init=@var{name} |
632 | @item -init=@var{name} | |
3dbf70a2 MM |
633 | When creating an ELF executable or shared object, call NAME when the |
634 | executable or shared object is loaded, by setting DT_INIT to the address | |
635 | of the function. By default, the linker uses @code{_init} as the | |
636 | function to call. | |
637 | ||
252b5132 | 638 | @cindex archive files, from cmd line |
2509a395 | 639 | @kindex -l @var{namespec} |
bcb674cf | 640 | @kindex --library=@var{namespec} |
2509a395 | 641 | @item -l @var{namespec} |
bcb674cf RS |
642 | @itemx --library=@var{namespec} |
643 | Add the archive or object file specified by @var{namespec} to the | |
644 | list of files to link. This option may be used any number of times. | |
645 | If @var{namespec} is of the form @file{:@var{filename}}, @command{ld} | |
07d8eb55 | 646 | will search the library path for a file called @var{filename}, otherwise it |
bcb674cf | 647 | will search the library path for a file called @file{lib@var{namespec}.a}. |
252b5132 | 648 | |
ff5dcc92 | 649 | On systems which support shared libraries, @command{ld} may also search for |
bcb674cf RS |
650 | files other than @file{lib@var{namespec}.a}. Specifically, on ELF |
651 | and SunOS systems, @command{ld} will search a directory for a library | |
652 | called @file{lib@var{namespec}.so} before searching for one called | |
653 | @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension | |
654 | indicates a shared library.) Note that this behavior does not apply | |
655 | to @file{:@var{filename}}, which always specifies a file called | |
656 | @var{filename}. | |
252b5132 RH |
657 | |
658 | The linker will search an archive only once, at the location where it is | |
659 | specified on the command line. If the archive defines a symbol which | |
660 | was undefined in some object which appeared before the archive on the | |
661 | command line, the linker will include the appropriate file(s) from the | |
662 | archive. However, an undefined symbol in an object appearing later on | |
663 | the command line will not cause the linker to search the archive again. | |
664 | ||
ff5dcc92 | 665 | See the @option{-(} option for a way to force the linker to search |
252b5132 RH |
666 | archives multiple times. |
667 | ||
668 | You may list the same archive multiple times on the command line. | |
669 | ||
670 | @ifset GENERIC | |
671 | This type of archive searching is standard for Unix linkers. However, | |
ff5dcc92 | 672 | if you are using @command{ld} on AIX, note that it is different from the |
252b5132 RH |
673 | behaviour of the AIX linker. |
674 | @end ifset | |
675 | ||
676 | @cindex search directory, from cmd line | |
2509a395 | 677 | @kindex -L @var{dir} |
252b5132 | 678 | @kindex --library-path=@var{dir} |
2509a395 | 679 | @item -L @var{searchdir} |
252b5132 | 680 | @itemx --library-path=@var{searchdir} |
ff5dcc92 SC |
681 | Add path @var{searchdir} to the list of paths that @command{ld} will search |
682 | for archive libraries and @command{ld} control scripts. You may use this | |
252b5132 RH |
683 | option any number of times. The directories are searched in the order |
684 | in which they are specified on the command line. Directories specified | |
685 | on the command line are searched before the default directories. All | |
ff5dcc92 | 686 | @option{-L} options apply to all @option{-l} options, regardless of the |
7d24f02c KH |
687 | order in which the options appear. @option{-L} options do not affect |
688 | how @command{ld} searches for a linker script unless @option{-T} | |
689 | option is specified. | |
252b5132 | 690 | |
3aa2d05a NC |
691 | If @var{searchdir} begins with @code{=} or @code{$SYSROOT}, then this |
692 | prefix will be replaced by the @dfn{sysroot prefix}, controlled by the | |
693 | @samp{--sysroot} option, or specified when the linker is configured. | |
9c8ebd6a | 694 | |
252b5132 RH |
695 | @ifset UsesEnvVars |
696 | The default set of paths searched (without being specified with | |
ff5dcc92 | 697 | @samp{-L}) depends on which emulation mode @command{ld} is using, and in |
252b5132 RH |
698 | some cases also on how it was configured. @xref{Environment}. |
699 | @end ifset | |
700 | ||
701 | The paths can also be specified in a link script with the | |
702 | @code{SEARCH_DIR} command. Directories specified this way are searched | |
703 | at the point in which the linker script appears in the command line. | |
704 | ||
705 | @cindex emulation | |
706 | @kindex -m @var{emulation} | |
2509a395 | 707 | @item -m @var{emulation} |
252b5132 RH |
708 | Emulate the @var{emulation} linker. You can list the available |
709 | emulations with the @samp{--verbose} or @samp{-V} options. | |
710 | ||
711 | If the @samp{-m} option is not used, the emulation is taken from the | |
712 | @code{LDEMULATION} environment variable, if that is defined. | |
713 | ||
714 | Otherwise, the default emulation depends upon how the linker was | |
715 | configured. | |
716 | ||
717 | @cindex link map | |
718 | @kindex -M | |
719 | @kindex --print-map | |
720 | @item -M | |
721 | @itemx --print-map | |
722 | Print a link map to the standard output. A link map provides | |
723 | information about the link, including the following: | |
724 | ||
725 | @itemize @bullet | |
726 | @item | |
3b83e13a | 727 | Where object files are mapped into memory. |
252b5132 RH |
728 | @item |
729 | How common symbols are allocated. | |
730 | @item | |
731 | All archive members included in the link, with a mention of the symbol | |
732 | which caused the archive member to be brought in. | |
3b83e13a NC |
733 | @item |
734 | The values assigned to symbols. | |
735 | ||
736 | Note - symbols whose values are computed by an expression which | |
737 | involves a reference to a previous value of the same symbol may not | |
738 | have correct result displayed in the link map. This is because the | |
739 | linker discards intermediate results and only retains the final value | |
740 | of an expression. Under such circumstances the linker will display | |
741 | the final value enclosed by square brackets. Thus for example a | |
742 | linker script containing: | |
743 | ||
744 | @smallexample | |
745 | foo = 1 | |
746 | foo = foo * 4 | |
747 | foo = foo + 8 | |
748 | @end smallexample | |
749 | ||
750 | will produce the following output in the link map if the @option{-M} | |
751 | option is used: | |
752 | ||
753 | @smallexample | |
754 | 0x00000001 foo = 0x1 | |
755 | [0x0000000c] foo = (foo * 0x4) | |
756 | [0x0000000c] foo = (foo + 0x8) | |
757 | @end smallexample | |
758 | ||
759 | See @ref{Expressions} for more information about expressions in linker | |
760 | scripts. | |
252b5132 RH |
761 | @end itemize |
762 | ||
763 | @kindex -n | |
764 | @cindex read-only text | |
765 | @cindex NMAGIC | |
766 | @kindex --nmagic | |
767 | @item -n | |
768 | @itemx --nmagic | |
90f5d9d9 JZ |
769 | Turn off page alignment of sections, and disable linking against shared |
770 | libraries. If the output format supports Unix style magic numbers, | |
771 | mark the output as @code{NMAGIC}. | |
252b5132 RH |
772 | |
773 | @kindex -N | |
774 | @kindex --omagic | |
775 | @cindex read/write from cmd line | |
776 | @cindex OMAGIC | |
a1ab1d2a | 777 | @item -N |
252b5132 RH |
778 | @itemx --omagic |
779 | Set the text and data sections to be readable and writable. Also, do | |
63fd3b82 NC |
780 | not page-align the data segment, and disable linking against shared |
781 | libraries. If the output format supports Unix style magic numbers, | |
4d8907ac DS |
782 | mark the output as @code{OMAGIC}. Note: Although a writable text section |
783 | is allowed for PE-COFF targets, it does not conform to the format | |
784 | specification published by Microsoft. | |
63fd3b82 NC |
785 | |
786 | @kindex --no-omagic | |
787 | @cindex OMAGIC | |
788 | @item --no-omagic | |
789 | This option negates most of the effects of the @option{-N} option. It | |
790 | sets the text section to be read-only, and forces the data segment to | |
791 | be page-aligned. Note - this option does not enable linking against | |
792 | shared libraries. Use @option{-Bdynamic} for this. | |
252b5132 RH |
793 | |
794 | @kindex -o @var{output} | |
795 | @kindex --output=@var{output} | |
796 | @cindex naming the output file | |
797 | @item -o @var{output} | |
798 | @itemx --output=@var{output} | |
ff5dcc92 | 799 | Use @var{output} as the name for the program produced by @command{ld}; if this |
252b5132 RH |
800 | option is not specified, the name @file{a.out} is used by default. The |
801 | script command @code{OUTPUT} can also specify the output file name. | |
802 | ||
803 | @kindex -O @var{level} | |
804 | @cindex generating optimized output | |
805 | @item -O @var{level} | |
ff5dcc92 | 806 | If @var{level} is a numeric values greater than zero @command{ld} optimizes |
252b5132 | 807 | the output. This might take significantly longer and therefore probably |
98c503ac NC |
808 | should only be enabled for the final binary. At the moment this |
809 | option only affects ELF shared library generation. Future releases of | |
810 | the linker may make more use of this option. Also currently there is | |
811 | no difference in the linker's behaviour for different non-zero values | |
812 | of this option. Again this may change with future releases. | |
252b5132 | 813 | |
387dd777 DP |
814 | @kindex -plugin @var{name} |
815 | @item -plugin @var{name} | |
816 | Involve a plugin in the linking process. The @var{name} parameter is | |
817 | the absolute filename of the plugin. Usually this parameter is | |
818 | automatically added by the complier, when using link time | |
819 | optimization, but users can also add their own plugins if they so | |
820 | wish. | |
821 | ||
822 | Note that the location of the compiler originated plugins is different | |
823 | from the place where the @command{ar}, @command{nm} and | |
824 | @command{ranlib} programs search for their plugins. In order for | |
825 | those commands to make use of a compiler based plugin it must first be | |
826 | copied into the @file{$@{libdir@}/bfd-plugins} directory. All gcc | |
827 | based linker plugins are backward compatible, so it is sufficient to | |
6c19b93b | 828 | just copy in the newest one. |
387dd777 | 829 | |
26278bb8 UD |
830 | @kindex --push-state |
831 | @cindex push state governing input file handling | |
832 | @item --push-state | |
833 | The @option{--push-state} allows to preserve the current state of the | |
834 | flags which govern the input file handling so that they can all be | |
835 | restored with one corresponding @option{--pop-state} option. | |
836 | ||
837 | The option which are covered are: @option{-Bdynamic}, @option{-Bstatic}, | |
838 | @option{-dn}, @option{-dy}, @option{-call_shared}, @option{-non_shared}, | |
839 | @option{-static}, @option{-N}, @option{-n}, @option{--whole-archive}, | |
840 | @option{--no-whole-archive}, @option{-r}, @option{-Ur}, | |
841 | @option{--copy-dt-needed-entries}, @option{--no-copy-dt-needed-entries}, | |
842 | @option{--as-needed}, @option{--no-as-needed}, and @option{-a}. | |
843 | ||
844 | One target for this option are specifications for @file{pkg-config}. When | |
845 | used with the @option{--libs} option all possibly needed libraries are | |
846 | listed and then possibly linked with all the time. It is better to return | |
847 | something as follows: | |
848 | ||
849 | @smallexample | |
850 | -Wl,--push-state,--as-needed -libone -libtwo -Wl,--pop-state | |
851 | @end smallexample | |
852 | ||
853 | @kindex --pop-state | |
854 | @cindex pop state governing input file handling | |
67cecaba | 855 | @item --pop-state |
26278bb8 UD |
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 | ||
a70f34c0 NC |
929 | @kindex --strip-discarded |
930 | @kindex --no-strip-discarded | |
931 | @item --strip-discarded | |
932 | @itemx --no-strip-discarded | |
933 | Omit (or do not omit) global symbols defined in discarded sections. | |
934 | Enabled by default. | |
935 | ||
252b5132 RH |
936 | @kindex -t |
937 | @kindex --trace | |
938 | @cindex input files, displaying | |
a1ab1d2a | 939 | @item -t |
252b5132 | 940 | @itemx --trace |
ff5dcc92 | 941 | Print the names of the input files as @command{ld} processes them. |
252b5132 RH |
942 | |
943 | @kindex -T @var{script} | |
944 | @kindex --script=@var{script} | |
945 | @cindex script files | |
946 | @item -T @var{scriptfile} | |
947 | @itemx --script=@var{scriptfile} | |
948 | Use @var{scriptfile} as the linker script. This script replaces | |
ff5dcc92 | 949 | @command{ld}'s default linker script (rather than adding to it), so |
252b5132 | 950 | @var{commandfile} must specify everything necessary to describe the |
114283d8 NC |
951 | output file. @xref{Scripts}. If @var{scriptfile} does not exist in |
952 | the current directory, @code{ld} looks for it in the directories | |
953 | specified by any preceding @samp{-L} options. Multiple @samp{-T} | |
954 | options accumulate. | |
252b5132 | 955 | |
14be8564 L |
956 | @kindex -dT @var{script} |
957 | @kindex --default-script=@var{script} | |
958 | @cindex script files | |
959 | @item -dT @var{scriptfile} | |
960 | @itemx --default-script=@var{scriptfile} | |
961 | Use @var{scriptfile} as the default linker script. @xref{Scripts}. | |
962 | ||
963 | This option is similar to the @option{--script} option except that | |
964 | processing of the script is delayed until after the rest of the | |
965 | command line has been processed. This allows options placed after the | |
966 | @option{--default-script} option on the command line to affect the | |
967 | behaviour of the linker script, which can be important when the linker | |
968 | command line cannot be directly controlled by the user. (eg because | |
969 | the command line is being constructed by another tool, such as | |
970 | @samp{gcc}). | |
971 | ||
252b5132 RH |
972 | @kindex -u @var{symbol} |
973 | @kindex --undefined=@var{symbol} | |
974 | @cindex undefined symbol | |
975 | @item -u @var{symbol} | |
976 | @itemx --undefined=@var{symbol} | |
977 | Force @var{symbol} to be entered in the output file as an undefined | |
978 | symbol. Doing this may, for example, trigger linking of additional | |
979 | modules from standard libraries. @samp{-u} may be repeated with | |
980 | different option arguments to enter additional undefined symbols. This | |
981 | option is equivalent to the @code{EXTERN} linker script command. | |
982 | ||
0a618243 AB |
983 | If this option is being used to force additional modules to be pulled |
984 | into the link, and if it is an error for the symbol to remain | |
985 | undefined, then the option @option{--require-defined} should be used | |
986 | instead. | |
987 | ||
988 | @kindex --require-defined=@var{symbol} | |
989 | @cindex symbols, require defined | |
990 | @cindex defined symbol | |
991 | @item --require-defined=@var{symbol} | |
992 | Require that @var{symbol} is defined in the output file. This option | |
993 | is the same as option @option{--undefined} except that if @var{symbol} | |
994 | is not defined in the output file then the linker will issue an error | |
995 | and exit. The same effect can be achieved in a linker script by using | |
996 | @code{EXTERN}, @code{ASSERT} and @code{DEFINED} together. This option | |
997 | can be used multiple times to require additional symbols. | |
998 | ||
252b5132 RH |
999 | @kindex -Ur |
1000 | @cindex constructors | |
a1ab1d2a | 1001 | @item -Ur |
252b5132 RH |
1002 | For anything other than C++ programs, this option is equivalent to |
1003 | @samp{-r}: it generates relocatable output---i.e., an output file that can in | |
ff5dcc92 | 1004 | turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur} |
252b5132 RH |
1005 | @emph{does} resolve references to constructors, unlike @samp{-r}. |
1006 | It does not work to use @samp{-Ur} on files that were themselves linked | |
1007 | with @samp{-Ur}; once the constructor table has been built, it cannot | |
1008 | be added to. Use @samp{-Ur} only for the last partial link, and | |
1009 | @samp{-r} for the others. | |
1010 | ||
c005eb9e AB |
1011 | @kindex --orphan-handling=@var{MODE} |
1012 | @cindex orphan sections | |
1013 | @cindex sections, orphan | |
1014 | @item --orphan-handling=@var{MODE} | |
1015 | Control how orphan sections are handled. An orphan section is one not | |
1016 | specifically mentioned in a linker script. @xref{Orphan Sections}. | |
1017 | ||
1018 | @var{MODE} can have any of the following values: | |
1019 | ||
1020 | @table @code | |
1021 | @item place | |
1022 | Orphan sections are placed into a suitable output section following | |
1023 | the strategy described in @ref{Orphan Sections}. The option | |
d2732b69 | 1024 | @samp{--unique} also affects how sections are placed. |
c005eb9e AB |
1025 | |
1026 | @item discard | |
1027 | All orphan sections are discarded, by placing them in the | |
1028 | @samp{/DISCARD/} section (@pxref{Output Section Discarding}). | |
1029 | ||
1030 | @item warn | |
1031 | The linker will place the orphan section as for @code{place} and also | |
1032 | issue a warning. | |
1033 | ||
1034 | @item error | |
1035 | The linker will exit with an error if any orphan section is found. | |
1036 | @end table | |
1037 | ||
1038 | The default if @samp{--orphan-handling} is not given is @code{place}. | |
1039 | ||
577a0623 AM |
1040 | @kindex --unique[=@var{SECTION}] |
1041 | @item --unique[=@var{SECTION}] | |
1042 | Creates a separate output section for every input section matching | |
1043 | @var{SECTION}, or if the optional wildcard @var{SECTION} argument is | |
1044 | missing, for every orphan input section. An orphan section is one not | |
1045 | specifically mentioned in a linker script. You may use this option | |
1046 | multiple times on the command line; It prevents the normal merging of | |
1047 | input sections with the same name, overriding output section assignments | |
1048 | in a linker script. | |
a854a4a7 | 1049 | |
252b5132 RH |
1050 | @kindex -v |
1051 | @kindex -V | |
1052 | @kindex --version | |
1053 | @cindex version | |
1054 | @item -v | |
1055 | @itemx --version | |
1056 | @itemx -V | |
ff5dcc92 | 1057 | Display the version number for @command{ld}. The @option{-V} option also |
252b5132 RH |
1058 | lists the supported emulations. |
1059 | ||
1060 | @kindex -x | |
1061 | @kindex --discard-all | |
1062 | @cindex deleting local symbols | |
1063 | @item -x | |
1064 | @itemx --discard-all | |
1065 | Delete all local symbols. | |
1066 | ||
1067 | @kindex -X | |
1068 | @kindex --discard-locals | |
1069 | @cindex local symbols, deleting | |
a1ab1d2a | 1070 | @item -X |
252b5132 | 1071 | @itemx --discard-locals |
3c68c38f BW |
1072 | Delete all temporary local symbols. (These symbols start with |
1073 | system-specific local label prefixes, typically @samp{.L} for ELF systems | |
1074 | or @samp{L} for traditional a.out systems.) | |
252b5132 RH |
1075 | |
1076 | @kindex -y @var{symbol} | |
1077 | @kindex --trace-symbol=@var{symbol} | |
1078 | @cindex symbol tracing | |
1079 | @item -y @var{symbol} | |
1080 | @itemx --trace-symbol=@var{symbol} | |
1081 | Print the name of each linked file in which @var{symbol} appears. This | |
1082 | option may be given any number of times. On many systems it is necessary | |
1083 | to prepend an underscore. | |
1084 | ||
1085 | This option is useful when you have an undefined symbol in your link but | |
1086 | don't know where the reference is coming from. | |
1087 | ||
1088 | @kindex -Y @var{path} | |
1089 | @item -Y @var{path} | |
1090 | Add @var{path} to the default library search path. This option exists | |
1091 | for Solaris compatibility. | |
1092 | ||
1093 | @kindex -z @var{keyword} | |
1094 | @item -z @var{keyword} | |
cd6d6c15 NC |
1095 | The recognized keywords are: |
1096 | @table @samp | |
1097 | ||
e6e2dfbd AM |
1098 | @item bndplt |
1099 | Always generate BND prefix in PLT entries. Supported for Linux/x86_64. | |
1100 | ||
1101 | @item call-nop=prefix-addr | |
1102 | @itemx call-nop=suffix-nop | |
1103 | @itemx call-nop=prefix-@var{byte} | |
1104 | @itemx call-nop=suffix-@var{byte} | |
1105 | Specify the 1-byte @code{NOP} padding when transforming indirect call | |
1106 | to a locally defined function, foo, via its GOT slot. | |
1107 | @option{call-nop=prefix-addr} generates @code{0x67 call foo}. | |
1108 | @option{call-nop=suffix-nop} generates @code{call foo 0x90}. | |
1109 | @option{call-nop=prefix-@var{byte}} generates @code{@var{byte} call foo}. | |
1110 | @option{call-nop=suffix-@var{byte}} generates @code{call foo @var{byte}}. | |
1111 | Supported for i386 and x86_64. | |
1112 | ||
cd6d6c15 | 1113 | @item combreloc |
e6e2dfbd AM |
1114 | @itemx nocombreloc |
1115 | Combine multiple dynamic relocation sections and sort to improve | |
1116 | dynamic symbol lookup caching. Do not do this if @samp{nocombreloc}. | |
cd6d6c15 | 1117 | |
b8871f35 | 1118 | @item common |
e6e2dfbd AM |
1119 | @itemx nocommon |
1120 | Generate common symbols with STT_COMMON type during a relocatable | |
1121 | link. Use STT_OBJECT type if @samp{nocommon}. | |
1122 | ||
1123 | @item common-page-size=@var{value} | |
1124 | Set the page size most commonly used to @var{value}. Memory image | |
1125 | layout will be optimized to minimize memory pages if the system is | |
1126 | using pages of this size. | |
b8871f35 | 1127 | |
cd6d6c15 | 1128 | @item defs |
97a232d7 NC |
1129 | Report unresolved symbol references from regular object files. This |
1130 | is done even if the linker is creating a non-symbolic shared library. | |
1131 | This option is the inverse of @samp{-z undefs}. | |
cd6d6c15 | 1132 | |
e6e2dfbd AM |
1133 | @item dynamic-undefined-weak |
1134 | @itemx nodynamic-undefined-weak | |
1135 | Make undefined weak symbols dynamic when building a dynamic object, | |
1136 | if they are referenced from a regular object file and not forced local | |
1137 | by symbol visibility or versioning. Do not make them dynamic if | |
1138 | @samp{nodynamic-undefined-weak}. If neither option is given, a target | |
1139 | may default to either option being in force, or make some other | |
1140 | selection of undefined weak symbols dynamic. Not all targets support | |
1141 | these options. | |
1142 | ||
6aa29e7b JJ |
1143 | @item execstack |
1144 | Marks the object as requiring executable stack. | |
1145 | ||
b039ef04 L |
1146 | @item global |
1147 | This option is only meaningful when building a shared object. It makes | |
1148 | the symbols defined by this shared object available for symbol resolution | |
1149 | of subsequently loaded libraries. | |
1150 | ||
93ab9c0d NC |
1151 | @item globalaudit |
1152 | This option is only meaningful when building a dynamic executable. | |
1153 | This option marks the executable as requiring global auditing by | |
1154 | setting the @code{DF_1_GLOBAUDIT} bit in the @code{DT_FLAGS_1} dynamic | |
1155 | tag. Global auditing requires that any auditing library defined via | |
1156 | the @option{--depaudit} or @option{-P} command line options be run for | |
6c19b93b | 1157 | all dynamic objects loaded by the application. |
93ab9c0d | 1158 | |
e6e2dfbd AM |
1159 | @item ibtplt |
1160 | Generate Intel Indirect Branch Tracking (IBT) enabled PLT entries. | |
1161 | Supported for Linux/i386 and Linux/x86_64. | |
1162 | ||
8df93cb5 | 1163 | @item ibt |
e6e2dfbd AM |
1164 | Generate GNU_PROPERTY_X86_FEATURE_1_IBT in .note.gnu.property section |
1165 | to indicate compatibility with IBT. This also implies @option{ibtplt}. | |
1166 | Supported for Linux/i386 and Linux/x86_64. | |
1167 | ||
cd6d6c15 NC |
1168 | @item initfirst |
1169 | This option is only meaningful when building a shared object. | |
1170 | It marks the object so that its runtime initialization will occur | |
1171 | before the runtime initialization of any other objects brought into | |
1172 | the process at the same time. Similarly the runtime finalization of | |
1173 | the object will occur after the runtime finalization of any other | |
1174 | objects. | |
1175 | ||
1176 | @item interpose | |
e6e2dfbd AM |
1177 | Specify that the dynamic loader should modify its symbol search order |
1178 | so that symbols in this shared library interpose all other shared | |
1179 | libraries not so marked. | |
cd6d6c15 | 1180 | |
5fa222e4 AM |
1181 | @item lazy |
1182 | When generating an executable or shared library, mark it to tell the | |
1183 | dynamic linker to defer function call resolution to the point when | |
1184 | the function is called (lazy binding), rather than at load time. | |
1185 | Lazy binding is the default. | |
1186 | ||
cd6d6c15 | 1187 | @item loadfltr |
e6e2dfbd | 1188 | Specify that the object's filters be processed immediately at runtime. |
cd6d6c15 | 1189 | |
e6e2dfbd AM |
1190 | @item max-page-size=@var{value} |
1191 | Set the maximum memory page size supported to @var{value}. | |
cd6d6c15 | 1192 | |
e6e2dfbd AM |
1193 | @item muldefs |
1194 | Allow multiple definitions. | |
b8871f35 | 1195 | |
cd6d6c15 | 1196 | @item nocopyreloc |
daf220f0 AM |
1197 | Disable linker generated .dynbss variables used in place of variables |
1198 | defined in shared libraries. May result in dynamic text relocations. | |
cd6d6c15 NC |
1199 | |
1200 | @item nodefaultlib | |
e6e2dfbd AM |
1201 | Specify that the dynamic loader search for dependencies of this object |
1202 | should ignore any default library search paths. | |
cd6d6c15 NC |
1203 | |
1204 | @item nodelete | |
e6e2dfbd | 1205 | Specify that the object shouldn't be unloaded at runtime. |
cd6d6c15 NC |
1206 | |
1207 | @item nodlopen | |
e6e2dfbd | 1208 | Specify that the object is not available to @code{dlopen}. |
cd6d6c15 NC |
1209 | |
1210 | @item nodump | |
e6e2dfbd | 1211 | Specify that the object can not be dumped by @code{dldump}. |
cd6d6c15 | 1212 | |
6aa29e7b JJ |
1213 | @item noexecstack |
1214 | Marks the object as not requiring executable stack. | |
1215 | ||
e6e2dfbd AM |
1216 | @item noextern-protected-data |
1217 | Don't treat protected data symbols as external when building a shared | |
1218 | library. This option overrides the linker backend default. It can be | |
1219 | used to work around incorrect relocations against protected data symbols | |
1220 | generated by compiler. Updates on protected data symbols by another | |
1221 | module aren't visible to the resulting shared library. Supported for | |
1222 | i386 and x86-64. | |
8dfef1bd | 1223 | |
e6e2dfbd AM |
1224 | @item noreloc-overflow |
1225 | Disable relocation overflow check. This can be used to disable | |
1226 | relocation overflow check if there will be no dynamic relocation | |
1227 | overflow at run-time. Supported for x86_64. | |
6aa29e7b | 1228 | |
cd6d6c15 NC |
1229 | @item now |
1230 | When generating an executable or shared library, mark it to tell the | |
1231 | dynamic linker to resolve all symbols when the program is started, or | |
e6e2dfbd AM |
1232 | when the shared library is loaded by dlopen, instead of deferring |
1233 | function call resolution to the point when the function is first | |
1234 | called. | |
cd6d6c15 NC |
1235 | |
1236 | @item origin | |
e6e2dfbd | 1237 | Specify that the object requires @samp{$ORIGIN} handling in paths. |
cd6d6c15 | 1238 | |
6aa29e7b | 1239 | @item relro |
e6e2dfbd | 1240 | @itemx norelro |
def5c83c AM |
1241 | Create an ELF @code{PT_GNU_RELRO} segment header in the object. This |
1242 | specifies a memory segment that should be made read-only after | |
1243 | relocation, if supported. Specifying @samp{common-page-size} smaller | |
1244 | than the system page size will render this protection ineffective. | |
e6e2dfbd | 1245 | Don't create an ELF @code{PT_GNU_RELRO} segment if @samp{norelro}. |
6aa29e7b | 1246 | |
47acac12 L |
1247 | @item separate-code |
1248 | @itemx noseparate-code | |
1249 | Create separate code @code{PT_LOAD} segment header in the object. This | |
1250 | specifies a memory segment that should contain only instructions and must | |
1251 | be in wholly disjoint pages from any other data. Don't create separate | |
1252 | code @code{PT_LOAD} segment if @samp{noseparate-code} is used. | |
1253 | ||
e6e2dfbd AM |
1254 | @item shstk |
1255 | Generate GNU_PROPERTY_X86_FEATURE_1_SHSTK in .note.gnu.property section | |
1256 | to indicate compatibility with Intel Shadow Stack. Supported for | |
1257 | Linux/i386 and Linux/x86_64. | |
24718e3b | 1258 | |
04c3a755 | 1259 | @item stack-size=@var{value} |
e6e2dfbd | 1260 | Specify a stack size for an ELF @code{PT_GNU_STACK} segment. |
04c3a755 NS |
1261 | Specifying zero will override any default non-zero sized |
1262 | @code{PT_GNU_STACK} segment creation. | |
1263 | ||
e6e2dfbd AM |
1264 | @item text |
1265 | @itemx notext | |
1266 | @itemx textoff | |
1267 | Report an error if DT_TEXTREL is set, i.e., if the binary has dynamic | |
1268 | relocations in read-only sections. Don't report an error if | |
1269 | @samp{notext} or @samp{textoff}. | |
48580982 | 1270 | |
97a232d7 NC |
1271 | @item undefs |
1272 | Do not report unresolved symbol references from regular object files, | |
1273 | either when creating an executable, or when creating a shared library. | |
1274 | This option is the inverse of @samp{-z defs}. | |
1275 | ||
cd6d6c15 NC |
1276 | @end table |
1277 | ||
ece2d90e | 1278 | Other keywords are ignored for Solaris compatibility. |
252b5132 RH |
1279 | |
1280 | @kindex -( | |
1281 | @cindex groups of archives | |
1282 | @item -( @var{archives} -) | |
1283 | @itemx --start-group @var{archives} --end-group | |
1284 | The @var{archives} should be a list of archive files. They may be | |
1285 | either explicit file names, or @samp{-l} options. | |
1286 | ||
1287 | The specified archives are searched repeatedly until no new undefined | |
1288 | references are created. Normally, an archive is searched only once in | |
1289 | the order that it is specified on the command line. If a symbol in that | |
1290 | archive is needed to resolve an undefined symbol referred to by an | |
1291 | object in an archive that appears later on the command line, the linker | |
1292 | would not be able to resolve that reference. By grouping the archives, | |
1293 | they all be searched repeatedly until all possible references are | |
1294 | resolved. | |
1295 | ||
1296 | Using this option has a significant performance cost. It is best to use | |
1297 | it only when there are unavoidable circular references between two or | |
1298 | more archives. | |
1299 | ||
69da35b5 NC |
1300 | @kindex --accept-unknown-input-arch |
1301 | @kindex --no-accept-unknown-input-arch | |
1302 | @item --accept-unknown-input-arch | |
1303 | @itemx --no-accept-unknown-input-arch | |
1304 | Tells the linker to accept input files whose architecture cannot be | |
2ca22b03 | 1305 | recognised. The assumption is that the user knows what they are doing |
69da35b5 NC |
1306 | and deliberately wants to link in these unknown input files. This was |
1307 | the default behaviour of the linker, before release 2.14. The default | |
1308 | behaviour from release 2.14 onwards is to reject such input files, and | |
1309 | so the @samp{--accept-unknown-input-arch} option has been added to | |
1310 | restore the old behaviour. | |
2ca22b03 | 1311 | |
4a43e768 AM |
1312 | @kindex --as-needed |
1313 | @kindex --no-as-needed | |
1314 | @item --as-needed | |
1315 | @itemx --no-as-needed | |
1316 | This option affects ELF DT_NEEDED tags for dynamic libraries mentioned | |
ddbb8a31 | 1317 | on the command line after the @option{--as-needed} option. Normally |
4a43e768 AM |
1318 | the linker will add a DT_NEEDED tag for each dynamic library mentioned |
1319 | on the command line, regardless of whether the library is actually | |
ddbb8a31 | 1320 | needed or not. @option{--as-needed} causes a DT_NEEDED tag to only be |
ffa9430d AM |
1321 | emitted for a library that @emph{at that point in the link} satisfies a |
1322 | non-weak undefined symbol reference from a regular object file or, if | |
1240be6b AM |
1323 | the library is not found in the DT_NEEDED lists of other needed libraries, a |
1324 | non-weak undefined symbol reference from another needed dynamic library. | |
ffa9430d AM |
1325 | Object files or libraries appearing on the command line @emph{after} |
1326 | the library in question do not affect whether the library is seen as | |
1327 | needed. This is similar to the rules for extraction of object files | |
1328 | from archives. @option{--no-as-needed} restores the default behaviour. | |
4a43e768 | 1329 | |
e56f61be L |
1330 | @kindex --add-needed |
1331 | @kindex --no-add-needed | |
1332 | @item --add-needed | |
1333 | @itemx --no-add-needed | |
ddbb8a31 NC |
1334 | These two options have been deprecated because of the similarity of |
1335 | their names to the @option{--as-needed} and @option{--no-as-needed} | |
1336 | options. They have been replaced by @option{--copy-dt-needed-entries} | |
1337 | and @option{--no-copy-dt-needed-entries}. | |
e56f61be | 1338 | |
252b5132 RH |
1339 | @kindex -assert @var{keyword} |
1340 | @item -assert @var{keyword} | |
1341 | This option is ignored for SunOS compatibility. | |
1342 | ||
1343 | @kindex -Bdynamic | |
1344 | @kindex -dy | |
1345 | @kindex -call_shared | |
1346 | @item -Bdynamic | |
1347 | @itemx -dy | |
1348 | @itemx -call_shared | |
1349 | Link against dynamic libraries. This is only meaningful on platforms | |
1350 | for which shared libraries are supported. This option is normally the | |
1351 | default on such platforms. The different variants of this option are | |
1352 | for compatibility with various systems. You may use this option | |
1353 | multiple times on the command line: it affects library searching for | |
da8bce14 | 1354 | @option{-l} options which follow it. |
252b5132 | 1355 | |
a1ab1d2a UD |
1356 | @kindex -Bgroup |
1357 | @item -Bgroup | |
1358 | Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic | |
1359 | section. This causes the runtime linker to handle lookups in this | |
1360 | object and its dependencies to be performed only inside the group. | |
560e09e9 NC |
1361 | @option{--unresolved-symbols=report-all} is implied. This option is |
1362 | only meaningful on ELF platforms which support shared libraries. | |
a1ab1d2a | 1363 | |
252b5132 RH |
1364 | @kindex -Bstatic |
1365 | @kindex -dn | |
1366 | @kindex -non_shared | |
1367 | @kindex -static | |
a1ab1d2a | 1368 | @item -Bstatic |
252b5132 RH |
1369 | @itemx -dn |
1370 | @itemx -non_shared | |
1371 | @itemx -static | |
1372 | Do not link against shared libraries. This is only meaningful on | |
1373 | platforms for which shared libraries are supported. The different | |
1374 | variants of this option are for compatibility with various systems. You | |
1375 | may use this option multiple times on the command line: it affects | |
560e09e9 | 1376 | library searching for @option{-l} options which follow it. This |
e9156f74 NC |
1377 | option also implies @option{--unresolved-symbols=report-all}. This |
1378 | option can be used with @option{-shared}. Doing so means that a | |
1379 | shared library is being created but that all of the library's external | |
1380 | references must be resolved by pulling in entries from static | |
ece2d90e | 1381 | libraries. |
252b5132 RH |
1382 | |
1383 | @kindex -Bsymbolic | |
1384 | @item -Bsymbolic | |
1385 | When creating a shared library, bind references to global symbols to the | |
1386 | definition within the shared library, if any. Normally, it is possible | |
1387 | for a program linked against a shared library to override the definition | |
e20365c5 L |
1388 | within the shared library. This option can also be used with the |
1389 | @option{--export-dynamic} option, when creating a position independent | |
1390 | executable, to bind references to global symbols to the definition within | |
1391 | the executable. This option is only meaningful on ELF platforms which | |
1392 | support shared libraries and position independent executables. | |
252b5132 | 1393 | |
40b36307 L |
1394 | @kindex -Bsymbolic-functions |
1395 | @item -Bsymbolic-functions | |
1396 | When creating a shared library, bind references to global function | |
c0065db7 | 1397 | symbols to the definition within the shared library, if any. |
e20365c5 L |
1398 | This option can also be used with the @option{--export-dynamic} option, |
1399 | when creating a position independent executable, to bind references | |
1400 | to global function symbols to the definition within the executable. | |
40b36307 | 1401 | This option is only meaningful on ELF platforms which support shared |
e20365c5 | 1402 | libraries and position independent executables. |
40b36307 | 1403 | |
55255dae L |
1404 | @kindex --dynamic-list=@var{dynamic-list-file} |
1405 | @item --dynamic-list=@var{dynamic-list-file} | |
1406 | Specify the name of a dynamic list file to the linker. This is | |
1407 | typically used when creating shared libraries to specify a list of | |
1408 | global symbols whose references shouldn't be bound to the definition | |
1409 | within the shared library, or creating dynamically linked executables | |
1410 | to specify a list of symbols which should be added to the symbol table | |
1411 | in the executable. This option is only meaningful on ELF platforms | |
1412 | which support shared libraries. | |
1413 | ||
1414 | The format of the dynamic list is the same as the version node without | |
1415 | scope and node name. See @ref{VERSION} for more information. | |
1416 | ||
40b36307 L |
1417 | @kindex --dynamic-list-data |
1418 | @item --dynamic-list-data | |
1419 | Include all global data symbols to the dynamic list. | |
1420 | ||
1421 | @kindex --dynamic-list-cpp-new | |
1422 | @item --dynamic-list-cpp-new | |
1423 | Provide the builtin dynamic list for C++ operator new and delete. It | |
1424 | is mainly useful for building shared libstdc++. | |
1425 | ||
0b8a70d9 L |
1426 | @kindex --dynamic-list-cpp-typeinfo |
1427 | @item --dynamic-list-cpp-typeinfo | |
1428 | Provide the builtin dynamic list for C++ runtime type identification. | |
1429 | ||
252b5132 RH |
1430 | @kindex --check-sections |
1431 | @kindex --no-check-sections | |
1432 | @item --check-sections | |
308b1ffd | 1433 | @itemx --no-check-sections |
252b5132 | 1434 | Asks the linker @emph{not} to check section addresses after they have |
7d816a17 | 1435 | been assigned to see if there are any overlaps. Normally the linker will |
252b5132 RH |
1436 | perform this check, and if it finds any overlaps it will produce |
1437 | suitable error messages. The linker does know about, and does make | |
1438 | allowances for sections in overlays. The default behaviour can be | |
560e09e9 | 1439 | restored by using the command line switch @option{--check-sections}. |
02b0b1aa NS |
1440 | Section overlap is not usually checked for relocatable links. You can |
1441 | force checking in that case by using the @option{--check-sections} | |
1442 | option. | |
252b5132 | 1443 | |
ddbb8a31 NC |
1444 | @kindex --copy-dt-needed-entries |
1445 | @kindex --no-copy-dt-needed-entries | |
1446 | @item --copy-dt-needed-entries | |
1447 | @itemx --no-copy-dt-needed-entries | |
9d5777a3 | 1448 | This option affects the treatment of dynamic libraries referred to |
ddbb8a31 | 1449 | by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the |
08efffb8 | 1450 | command line. Normally the linker won't add a DT_NEEDED tag to the |
ddbb8a31 | 1451 | output binary for each library mentioned in a DT_NEEDED tag in an |
08efffb8 | 1452 | input dynamic library. With @option{--copy-dt-needed-entries} |
ddbb8a31 | 1453 | specified on the command line however any dynamic libraries that |
08efffb8 MM |
1454 | follow it will have their DT_NEEDED entries added. The default |
1455 | behaviour can be restored with @option{--no-copy-dt-needed-entries}. | |
ddbb8a31 NC |
1456 | |
1457 | This option also has an effect on the resolution of symbols in dynamic | |
08efffb8 MM |
1458 | libraries. With @option{--copy-dt-needed-entries} dynamic libraries |
1459 | mentioned on the command line will be recursively searched, following | |
1460 | their DT_NEEDED tags to other libraries, in order to resolve symbols | |
1461 | required by the output binary. With the default setting however | |
1462 | the searching of dynamic libraries that follow it will stop with the | |
1463 | dynamic library itself. No DT_NEEDED links will be traversed to resolve | |
ddbb8a31 NC |
1464 | symbols. |
1465 | ||
252b5132 RH |
1466 | @cindex cross reference table |
1467 | @kindex --cref | |
1468 | @item --cref | |
1469 | Output a cross reference table. If a linker map file is being | |
1470 | generated, the cross reference table is printed to the map file. | |
1471 | Otherwise, it is printed on the standard output. | |
1472 | ||
1473 | The format of the table is intentionally simple, so that it may be | |
1474 | easily processed by a script if necessary. The symbols are printed out, | |
1475 | sorted by name. For each symbol, a list of file names is given. If the | |
1476 | symbol is defined, the first file listed is the location of the | |
049c1c8e NC |
1477 | definition. If the symbol is defined as a common value then any files |
1478 | where this happens appear next. Finally any files that reference the | |
1479 | symbol are listed. | |
252b5132 | 1480 | |
4818e05f AM |
1481 | @cindex common allocation |
1482 | @kindex --no-define-common | |
1483 | @item --no-define-common | |
1484 | This option inhibits the assignment of addresses to common symbols. | |
1485 | The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect. | |
1486 | @xref{Miscellaneous Commands}. | |
1487 | ||
1488 | The @samp{--no-define-common} option allows decoupling | |
1489 | the decision to assign addresses to Common symbols from the choice | |
1490 | of the output file type; otherwise a non-Relocatable output type | |
1491 | forces assigning addresses to Common symbols. | |
1492 | Using @samp{--no-define-common} allows Common symbols that are referenced | |
1493 | from a shared library to be assigned addresses only in the main program. | |
1494 | This eliminates the unused duplicate space in the shared library, | |
1495 | and also prevents any possible confusion over resolving to the wrong | |
1496 | duplicate when there are many dynamic modules with specialized search | |
1497 | paths for runtime symbol resolution. | |
1498 | ||
7bdf4127 AB |
1499 | @cindex group allocation in linker script |
1500 | @cindex section groups | |
1501 | @cindex COMDAT | |
1502 | @kindex --force-group-allocation | |
1503 | @item --force-group-allocation | |
1504 | This option causes the linker to place section group members like | |
1505 | normal input sections, and to delete the section groups. This is the | |
1506 | default behaviour for a final link but this option can be used to | |
1507 | change the behaviour of a relocatable link (@samp{-r}). The script | |
1508 | command @code{FORCE_GROUP_ALLOCATION} has the same | |
1509 | effect. @xref{Miscellaneous Commands}. | |
1510 | ||
252b5132 | 1511 | @cindex symbols, from command line |
2509a395 SL |
1512 | @kindex --defsym=@var{symbol}=@var{exp} |
1513 | @item --defsym=@var{symbol}=@var{expression} | |
252b5132 RH |
1514 | Create a global symbol in the output file, containing the absolute |
1515 | address given by @var{expression}. You may use this option as many | |
1516 | times as necessary to define multiple symbols in the command line. A | |
1517 | limited form of arithmetic is supported for the @var{expression} in this | |
1518 | context: you may give a hexadecimal constant or the name of an existing | |
1519 | symbol, or use @code{+} and @code{-} to add or subtract hexadecimal | |
1520 | constants or symbols. If you need more elaborate expressions, consider | |
66bc8739 AM |
1521 | using the linker command language from a script (@pxref{Assignments}). |
1522 | @emph{Note:} there should be no white space between @var{symbol}, the | |
1523 | equals sign (``@key{=}''), and @var{expression}. | |
252b5132 RH |
1524 | |
1525 | @cindex demangling, from command line | |
28c309a2 | 1526 | @kindex --demangle[=@var{style}] |
252b5132 | 1527 | @kindex --no-demangle |
28c309a2 | 1528 | @item --demangle[=@var{style}] |
252b5132 RH |
1529 | @itemx --no-demangle |
1530 | These options control whether to demangle symbol names in error messages | |
1531 | and other output. When the linker is told to demangle, it tries to | |
1532 | present symbol names in a readable fashion: it strips leading | |
1533 | underscores if they are used by the object file format, and converts C++ | |
a1ab1d2a UD |
1534 | mangled symbol names into user readable names. Different compilers have |
1535 | different mangling styles. The optional demangling style argument can be used | |
1536 | to choose an appropriate demangling style for your compiler. The linker will | |
28c309a2 NC |
1537 | demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE} |
1538 | is set. These options may be used to override the default. | |
252b5132 RH |
1539 | |
1540 | @cindex dynamic linker, from command line | |
506eee22 | 1541 | @kindex -I@var{file} |
2509a395 SL |
1542 | @kindex --dynamic-linker=@var{file} |
1543 | @item -I@var{file} | |
1544 | @itemx --dynamic-linker=@var{file} | |
252b5132 RH |
1545 | Set the name of the dynamic linker. This is only meaningful when |
1546 | generating dynamically linked ELF executables. The default dynamic | |
1547 | linker is normally correct; don't use this unless you know what you are | |
1548 | doing. | |
1549 | ||
9b8b325a RF |
1550 | @kindex --no-dynamic-linker |
1551 | @item --no-dynamic-linker | |
1552 | When producing an executable file, omit the request for a dynamic | |
1553 | linker to be used at load-time. This is only meaningful for ELF | |
1554 | executables that contain dynamic relocations, and usually requires | |
1555 | entry point code that is capable of processing these relocations. | |
1556 | ||
a70f34c0 NC |
1557 | @kindex --embedded-relocs |
1558 | @item --embedded-relocs | |
1559 | This option is similar to the @option{--emit-relocs} option except | |
1560 | that the relocs are stored in a target specific section. This option | |
1561 | is only supported by the @samp{BFIN}, @samp{CR16} and @emph{M68K} | |
1562 | targets. | |
1563 | ||
3f0a5f17 ME |
1564 | @kindex --disable-multiple-abs-defs |
1565 | @item --disable-multiple-abs-defs | |
1566 | Do not allow multiple definitions with symbols included | |
1567 | in filename invoked by -R or --just-symbols | |
1568 | ||
7ce691ae | 1569 | @kindex --fatal-warnings |
0fe58ccd | 1570 | @kindex --no-fatal-warnings |
7ce691ae | 1571 | @item --fatal-warnings |
0fe58ccd NC |
1572 | @itemx --no-fatal-warnings |
1573 | Treat all warnings as errors. The default behaviour can be restored | |
1574 | with the option @option{--no-fatal-warnings}. | |
7ce691ae | 1575 | |
252b5132 RH |
1576 | @kindex --force-exe-suffix |
1577 | @item --force-exe-suffix | |
1578 | Make sure that an output file has a .exe suffix. | |
1579 | ||
1580 | If a successfully built fully linked output file does not have a | |
1581 | @code{.exe} or @code{.dll} suffix, this option forces the linker to copy | |
1582 | the output file to one of the same name with a @code{.exe} suffix. This | |
1583 | option is useful when using unmodified Unix makefiles on a Microsoft | |
1584 | Windows host, since some versions of Windows won't run an image unless | |
1585 | it ends in a @code{.exe} suffix. | |
1586 | ||
1587 | @kindex --gc-sections | |
1588 | @kindex --no-gc-sections | |
1589 | @cindex garbage collection | |
c17d87de NC |
1590 | @item --gc-sections |
1591 | @itemx --no-gc-sections | |
252b5132 | 1592 | Enable garbage collection of unused input sections. It is ignored on |
ac69cbc6 | 1593 | targets that do not support this option. The default behaviour (of not |
b3549761 | 1594 | performing this garbage collection) can be restored by specifying |
0f088b2a KT |
1595 | @samp{--no-gc-sections} on the command line. Note that garbage |
1596 | collection for COFF and PE format targets is supported, but the | |
1597 | implementation is currently considered to be experimental. | |
252b5132 | 1598 | |
d5465ba2 AM |
1599 | @samp{--gc-sections} decides which input sections are used by |
1600 | examining symbols and relocations. The section containing the entry | |
1601 | symbol and all sections containing symbols undefined on the | |
1602 | command-line will be kept, as will sections containing symbols | |
1603 | referenced by dynamic objects. Note that when building shared | |
1604 | libraries, the linker must assume that any visible symbol is | |
1605 | referenced. Once this initial set of sections has been determined, | |
1606 | the linker recursively marks as used any section referenced by their | |
1607 | relocations. See @samp{--entry} and @samp{--undefined}. | |
1608 | ||
ac69cbc6 | 1609 | This option can be set when doing a partial link (enabled with option |
9d5777a3 | 1610 | @samp{-r}). In this case the root of symbols kept must be explicitly |
ac69cbc6 TG |
1611 | specified either by an @samp{--entry} or @samp{--undefined} option or by |
1612 | a @code{ENTRY} command in the linker script. | |
1613 | ||
c17d87de NC |
1614 | @kindex --print-gc-sections |
1615 | @kindex --no-print-gc-sections | |
1616 | @cindex garbage collection | |
1617 | @item --print-gc-sections | |
1618 | @itemx --no-print-gc-sections | |
1619 | List all sections removed by garbage collection. The listing is | |
1620 | printed on stderr. This option is only effective if garbage | |
1621 | collection has been enabled via the @samp{--gc-sections}) option. The | |
1622 | default behaviour (of not listing the sections that are removed) can | |
1623 | be restored by specifying @samp{--no-print-gc-sections} on the command | |
1624 | line. | |
1625 | ||
22185505 | 1626 | @kindex --gc-keep-exported |
1627 | @cindex garbage collection | |
1628 | @item --gc-keep-exported | |
1629 | When @samp{--gc-sections} is enabled, this option prevents garbage | |
1630 | collection of unused input sections that contain global symbols having | |
1631 | default or protected visibility. This option is intended to be used for | |
1632 | executables where unreferenced sections would otherwise be garbage | |
1633 | collected regardless of the external visibility of contained symbols. | |
1634 | Note that this option has no effect when linking shared objects since | |
1635 | it is already the default behaviour. This option is only supported for | |
1636 | ELF format targets. | |
1637 | ||
30824704 RM |
1638 | @kindex --print-output-format |
1639 | @cindex output format | |
1640 | @item --print-output-format | |
1641 | Print the name of the default output format (perhaps influenced by | |
1642 | other command-line options). This is the string that would appear | |
1643 | in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}). | |
1644 | ||
3604cb1f TG |
1645 | @kindex --print-memory-usage |
1646 | @cindex memory usage | |
1647 | @item --print-memory-usage | |
1648 | Print used size, total size and used size of memory regions created with | |
1649 | the @ref{MEMORY} command. This is useful on embedded targets to have a | |
1650 | quick view of amount of free memory. The format of the output has one | |
1651 | headline and one line per region. It is both human readable and easily | |
1652 | parsable by tools. Here is an example of an output: | |
1653 | ||
1654 | @smallexample | |
1655 | Memory region Used Size Region Size %age Used | |
1656 | ROM: 256 KB 1 MB 25.00% | |
1657 | RAM: 32 B 2 GB 0.00% | |
1658 | @end smallexample | |
1659 | ||
252b5132 RH |
1660 | @cindex help |
1661 | @cindex usage | |
1662 | @kindex --help | |
1663 | @item --help | |
1664 | Print a summary of the command-line options on the standard output and exit. | |
1665 | ||
ea20a7da CC |
1666 | @kindex --target-help |
1667 | @item --target-help | |
1668 | Print a summary of all target specific options on the standard output and exit. | |
1669 | ||
2509a395 SL |
1670 | @kindex -Map=@var{mapfile} |
1671 | @item -Map=@var{mapfile} | |
252b5132 | 1672 | Print a link map to the file @var{mapfile}. See the description of the |
560e09e9 | 1673 | @option{-M} option, above. |
252b5132 RH |
1674 | |
1675 | @cindex memory usage | |
1676 | @kindex --no-keep-memory | |
1677 | @item --no-keep-memory | |
ff5dcc92 SC |
1678 | @command{ld} normally optimizes for speed over memory usage by caching the |
1679 | symbol tables of input files in memory. This option tells @command{ld} to | |
252b5132 | 1680 | instead optimize for memory usage, by rereading the symbol tables as |
ff5dcc92 | 1681 | necessary. This may be required if @command{ld} runs out of memory space |
252b5132 RH |
1682 | while linking a large executable. |
1683 | ||
1684 | @kindex --no-undefined | |
a1ab1d2a | 1685 | @kindex -z defs |
97a232d7 | 1686 | @kindex -z undefs |
252b5132 | 1687 | @item --no-undefined |
a1ab1d2a | 1688 | @itemx -z defs |
560e09e9 NC |
1689 | Report unresolved symbol references from regular object files. This |
1690 | is done even if the linker is creating a non-symbolic shared library. | |
1691 | The switch @option{--[no-]allow-shlib-undefined} controls the | |
1692 | behaviour for reporting unresolved references found in shared | |
ece2d90e | 1693 | libraries being linked in. |
252b5132 | 1694 | |
97a232d7 NC |
1695 | The effects of this option can be reverted by using @code{-z undefs}. |
1696 | ||
aa713662 L |
1697 | @kindex --allow-multiple-definition |
1698 | @kindex -z muldefs | |
1699 | @item --allow-multiple-definition | |
1700 | @itemx -z muldefs | |
1701 | Normally when a symbol is defined multiple times, the linker will | |
1702 | report a fatal error. These options allow multiple definitions and the | |
1703 | first definition will be used. | |
1704 | ||
b79e8c78 | 1705 | @kindex --allow-shlib-undefined |
ae9a127f | 1706 | @kindex --no-allow-shlib-undefined |
b79e8c78 | 1707 | @item --allow-shlib-undefined |
ae9a127f | 1708 | @itemx --no-allow-shlib-undefined |
903249d7 | 1709 | Allows or disallows undefined symbols in shared libraries. |
560e09e9 NC |
1710 | This switch is similar to @option{--no-undefined} except that it |
1711 | determines the behaviour when the undefined symbols are in a | |
1712 | shared library rather than a regular object file. It does not affect | |
1713 | how undefined symbols in regular object files are handled. | |
1714 | ||
903249d7 NC |
1715 | The default behaviour is to report errors for any undefined symbols |
1716 | referenced in shared libraries if the linker is being used to create | |
1717 | an executable, but to allow them if the linker is being used to create | |
1718 | a shared library. | |
1719 | ||
1720 | The reasons for allowing undefined symbol references in shared | |
1721 | libraries specified at link time are that: | |
1722 | ||
1723 | @itemize @bullet | |
1724 | @item | |
1725 | A shared library specified at link time may not be the same as the one | |
1726 | that is available at load time, so the symbol might actually be | |
1727 | resolvable at load time. | |
1728 | @item | |
1729 | There are some operating systems, eg BeOS and HPPA, where undefined | |
1730 | symbols in shared libraries are normal. | |
1731 | ||
1732 | The BeOS kernel for example patches shared libraries at load time to | |
1733 | select whichever function is most appropriate for the current | |
1734 | architecture. This is used, for example, to dynamically select an | |
1735 | appropriate memset function. | |
1736 | @end itemize | |
b79e8c78 | 1737 | |
31941635 L |
1738 | @kindex --no-undefined-version |
1739 | @item --no-undefined-version | |
1740 | Normally when a symbol has an undefined version, the linker will ignore | |
1741 | it. This option disallows symbols with undefined version and a fatal error | |
1742 | will be issued instead. | |
1743 | ||
3e3b46e5 PB |
1744 | @kindex --default-symver |
1745 | @item --default-symver | |
1746 | Create and use a default symbol version (the soname) for unversioned | |
fc0e6df6 PB |
1747 | exported symbols. |
1748 | ||
1749 | @kindex --default-imported-symver | |
1750 | @item --default-imported-symver | |
1751 | Create and use a default symbol version (the soname) for unversioned | |
1752 | imported symbols. | |
3e3b46e5 | 1753 | |
252b5132 RH |
1754 | @kindex --no-warn-mismatch |
1755 | @item --no-warn-mismatch | |
ff5dcc92 | 1756 | Normally @command{ld} will give an error if you try to link together input |
252b5132 RH |
1757 | files that are mismatched for some reason, perhaps because they have |
1758 | been compiled for different processors or for different endiannesses. | |
ff5dcc92 | 1759 | This option tells @command{ld} that it should silently permit such possible |
252b5132 RH |
1760 | errors. This option should only be used with care, in cases when you |
1761 | have taken some special action that ensures that the linker errors are | |
1762 | inappropriate. | |
1763 | ||
fe7929ce AM |
1764 | @kindex --no-warn-search-mismatch |
1765 | @item --no-warn-search-mismatch | |
1766 | Normally @command{ld} will give a warning if it finds an incompatible | |
1767 | library during a library search. This option silences the warning. | |
1768 | ||
252b5132 RH |
1769 | @kindex --no-whole-archive |
1770 | @item --no-whole-archive | |
ff5dcc92 | 1771 | Turn off the effect of the @option{--whole-archive} option for subsequent |
252b5132 RH |
1772 | archive files. |
1773 | ||
1774 | @cindex output file after errors | |
1775 | @kindex --noinhibit-exec | |
1776 | @item --noinhibit-exec | |
1777 | Retain the executable output file whenever it is still usable. | |
1778 | Normally, the linker will not produce an output file if it encounters | |
1779 | errors during the link process; it exits without writing an output file | |
1780 | when it issues any error whatsoever. | |
1781 | ||
0a9c1c8e CD |
1782 | @kindex -nostdlib |
1783 | @item -nostdlib | |
1784 | Only search library directories explicitly specified on the | |
1785 | command line. Library directories specified in linker scripts | |
1786 | (including linker scripts specified on the command line) are ignored. | |
1787 | ||
252b5132 | 1788 | @ifclear SingleFormat |
2509a395 SL |
1789 | @kindex --oformat=@var{output-format} |
1790 | @item --oformat=@var{output-format} | |
ff5dcc92 SC |
1791 | @command{ld} may be configured to support more than one kind of object |
1792 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 1793 | @samp{--oformat} option to specify the binary format for the output |
ff5dcc92 SC |
1794 | object file. Even when @command{ld} is configured to support alternative |
1795 | object formats, you don't usually need to specify this, as @command{ld} | |
252b5132 RH |
1796 | should be configured to produce as a default output format the most |
1797 | usual format on each machine. @var{output-format} is a text string, the | |
1798 | name of a particular format supported by the BFD libraries. (You can | |
1799 | list the available binary formats with @samp{objdump -i}.) The script | |
1800 | command @code{OUTPUT_FORMAT} can also specify the output format, but | |
1801 | this option overrides it. @xref{BFD}. | |
1802 | @end ifclear | |
1803 | ||
76359541 TP |
1804 | @kindex --out-implib |
1805 | @item --out-implib @var{file} | |
1806 | Create an import library in @var{file} corresponding to the executable | |
1807 | the linker is generating (eg. a DLL or ELF program). This import | |
1808 | library (which should be called @code{*.dll.a} or @code{*.a} for DLLs) | |
1809 | may be used to link clients against the generated executable; this | |
1810 | behaviour makes it possible to skip a separate import library creation | |
1811 | step (eg. @code{dlltool} for DLLs). This option is only available for | |
1812 | the i386 PE and ELF targetted ports of the linker. | |
1813 | ||
36af4a4e JJ |
1814 | @kindex -pie |
1815 | @kindex --pic-executable | |
1816 | @item -pie | |
1817 | @itemx --pic-executable | |
1818 | @cindex position independent executables | |
1819 | Create a position independent executable. This is currently only supported on | |
1820 | ELF platforms. Position independent executables are similar to shared | |
1821 | libraries in that they are relocated by the dynamic linker to the virtual | |
7e7d5768 | 1822 | address the OS chooses for them (which can vary between invocations). Like |
36af4a4e JJ |
1823 | normal dynamically linked executables they can be executed and symbols |
1824 | defined in the executable cannot be overridden by shared libraries. | |
1825 | ||
252b5132 RH |
1826 | @kindex -qmagic |
1827 | @item -qmagic | |
1828 | This option is ignored for Linux compatibility. | |
1829 | ||
1830 | @kindex -Qy | |
1831 | @item -Qy | |
1832 | This option is ignored for SVR4 compatibility. | |
1833 | ||
1834 | @kindex --relax | |
1835 | @cindex synthesizing linker | |
1836 | @cindex relaxing addressing modes | |
28d5f677 | 1837 | @cindex --no-relax |
252b5132 | 1838 | @item --relax |
28d5f677 | 1839 | @itemx --no-relax |
a1ab1d2a | 1840 | An option with machine dependent effects. |
252b5132 RH |
1841 | @ifset GENERIC |
1842 | This option is only supported on a few targets. | |
1843 | @end ifset | |
1844 | @ifset H8300 | |
ff5dcc92 | 1845 | @xref{H8/300,,@command{ld} and the H8/300}. |
252b5132 | 1846 | @end ifset |
e0001a05 NC |
1847 | @ifset XTENSA |
1848 | @xref{Xtensa,, @command{ld} and Xtensa Processors}. | |
1849 | @end ifset | |
93fd0973 SC |
1850 | @ifset M68HC11 |
1851 | @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}. | |
1852 | @end ifset | |
78058a5e SL |
1853 | @ifset NIOSII |
1854 | @xref{Nios II,,@command{ld} and the Altera Nios II}. | |
1855 | @end ifset | |
2a60a7a8 AM |
1856 | @ifset POWERPC |
1857 | @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}. | |
1858 | @end ifset | |
252b5132 | 1859 | |
28d5f677 NC |
1860 | On some platforms the @samp{--relax} option performs target specific, |
1861 | global optimizations that become possible when the linker resolves | |
1862 | addressing in the program, such as relaxing address modes, | |
1863 | synthesizing new instructions, selecting shorter version of current | |
11e7fd74 | 1864 | instructions, and combining constant values. |
252b5132 RH |
1865 | |
1866 | On some platforms these link time global optimizations may make symbolic | |
1867 | debugging of the resulting executable impossible. | |
1868 | @ifset GENERIC | |
28d5f677 NC |
1869 | This is known to be the case for the Matsushita MN10200 and MN10300 |
1870 | family of processors. | |
252b5132 RH |
1871 | @end ifset |
1872 | ||
1873 | @ifset GENERIC | |
1874 | On platforms where this is not supported, @samp{--relax} is accepted, | |
1875 | but ignored. | |
1876 | @end ifset | |
1877 | ||
28d5f677 NC |
1878 | On platforms where @samp{--relax} is accepted the option |
1879 | @samp{--no-relax} can be used to disable the feature. | |
1880 | ||
252b5132 RH |
1881 | @cindex retaining specified symbols |
1882 | @cindex stripping all but some symbols | |
1883 | @cindex symbols, retaining selectively | |
2509a395 SL |
1884 | @kindex --retain-symbols-file=@var{filename} |
1885 | @item --retain-symbols-file=@var{filename} | |
252b5132 RH |
1886 | Retain @emph{only} the symbols listed in the file @var{filename}, |
1887 | discarding all others. @var{filename} is simply a flat file, with one | |
1888 | symbol name per line. This option is especially useful in environments | |
1889 | @ifset GENERIC | |
1890 | (such as VxWorks) | |
1891 | @end ifset | |
1892 | where a large global symbol table is accumulated gradually, to conserve | |
1893 | run-time memory. | |
1894 | ||
1895 | @samp{--retain-symbols-file} does @emph{not} discard undefined symbols, | |
1896 | or symbols needed for relocations. | |
1897 | ||
1898 | You may only specify @samp{--retain-symbols-file} once in the command | |
1899 | line. It overrides @samp{-s} and @samp{-S}. | |
1900 | ||
1901 | @ifset GENERIC | |
2509a395 | 1902 | @item -rpath=@var{dir} |
252b5132 | 1903 | @cindex runtime library search path |
2509a395 | 1904 | @kindex -rpath=@var{dir} |
252b5132 | 1905 | Add a directory to the runtime library search path. This is used when |
ff5dcc92 | 1906 | linking an ELF executable with shared objects. All @option{-rpath} |
252b5132 | 1907 | arguments are concatenated and passed to the runtime linker, which uses |
ff5dcc92 | 1908 | them to locate shared objects at runtime. The @option{-rpath} option is |
252b5132 RH |
1909 | also used when locating shared objects which are needed by shared |
1910 | objects explicitly included in the link; see the description of the | |
ff5dcc92 | 1911 | @option{-rpath-link} option. If @option{-rpath} is not used when linking an |
252b5132 RH |
1912 | ELF executable, the contents of the environment variable |
1913 | @code{LD_RUN_PATH} will be used if it is defined. | |
1914 | ||
ff5dcc92 | 1915 | The @option{-rpath} option may also be used on SunOS. By default, on |
d8506323 | 1916 | SunOS, the linker will form a runtime search path out of all the |
ff5dcc92 SC |
1917 | @option{-L} options it is given. If a @option{-rpath} option is used, the |
1918 | runtime search path will be formed exclusively using the @option{-rpath} | |
1919 | options, ignoring the @option{-L} options. This can be useful when using | |
1920 | gcc, which adds many @option{-L} options which may be on NFS mounted | |
b45619c0 | 1921 | file systems. |
252b5132 | 1922 | |
ff5dcc92 | 1923 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 1924 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 1925 | the @option{-rpath} option. |
252b5132 RH |
1926 | @end ifset |
1927 | ||
1928 | @ifset GENERIC | |
1929 | @cindex link-time runtime library search path | |
2509a395 SL |
1930 | @kindex -rpath-link=@var{dir} |
1931 | @item -rpath-link=@var{dir} | |
252b5132 RH |
1932 | When using ELF or SunOS, one shared library may require another. This |
1933 | happens when an @code{ld -shared} link includes a shared library as one | |
1934 | of the input files. | |
1935 | ||
1936 | When the linker encounters such a dependency when doing a non-shared, | |
1937 | non-relocatable link, it will automatically try to locate the required | |
1938 | shared library and include it in the link, if it is not included | |
ff5dcc92 | 1939 | explicitly. In such a case, the @option{-rpath-link} option |
252b5132 | 1940 | specifies the first set of directories to search. The |
ff5dcc92 | 1941 | @option{-rpath-link} option may specify a sequence of directory names |
252b5132 RH |
1942 | either by specifying a list of names separated by colons, or by |
1943 | appearing multiple times. | |
1944 | ||
e680a6b6 NC |
1945 | The tokens @var{$ORIGIN} and @var{$LIB} can appear in these search |
1946 | directories. They will be replaced by the full path to the directory | |
1947 | containing the program or shared object in the case of @var{$ORIGIN} | |
1948 | and either @samp{lib} - for 32-bit binaries - or @samp{lib64} - for | |
1949 | 64-bit binaries - in the case of @var{$LIB}. | |
1950 | ||
1951 | The alternative form of these tokens - @var{$@{ORIGIN@}} and | |
1952 | @var{$@{LIB@}} can also be used. The token @var{$PLATFORM} is not | |
1953 | supported. | |
1954 | ||
28c309a2 NC |
1955 | This option should be used with caution as it overrides the search path |
1956 | that may have been hard compiled into a shared library. In such a case it | |
1957 | is possible to use unintentionally a different search path than the | |
1958 | runtime linker would do. | |
1959 | ||
252b5132 | 1960 | The linker uses the following search paths to locate required shared |
ece2d90e | 1961 | libraries: |
252b5132 RH |
1962 | @enumerate |
1963 | @item | |
ff5dcc92 | 1964 | Any directories specified by @option{-rpath-link} options. |
252b5132 | 1965 | @item |
ff5dcc92 SC |
1966 | Any directories specified by @option{-rpath} options. The difference |
1967 | between @option{-rpath} and @option{-rpath-link} is that directories | |
1968 | specified by @option{-rpath} options are included in the executable and | |
1969 | used at runtime, whereas the @option{-rpath-link} option is only effective | |
ece2d90e NC |
1970 | at link time. Searching @option{-rpath} in this way is only supported |
1971 | by native linkers and cross linkers which have been configured with | |
1972 | the @option{--with-sysroot} option. | |
252b5132 | 1973 | @item |
e2a83dd0 NC |
1974 | On an ELF system, for native linkers, if the @option{-rpath} and |
1975 | @option{-rpath-link} options were not used, search the contents of the | |
1976 | environment variable @code{LD_RUN_PATH}. | |
252b5132 | 1977 | @item |
ff5dcc92 SC |
1978 | On SunOS, if the @option{-rpath} option was not used, search any |
1979 | directories specified using @option{-L} options. | |
252b5132 | 1980 | @item |
a1b8d843 | 1981 | For a native linker, search the contents of the environment |
e2a83dd0 | 1982 | variable @code{LD_LIBRARY_PATH}. |
252b5132 | 1983 | @item |
ec4eb78a L |
1984 | For a native ELF linker, the directories in @code{DT_RUNPATH} or |
1985 | @code{DT_RPATH} of a shared library are searched for shared | |
1986 | libraries needed by it. The @code{DT_RPATH} entries are ignored if | |
1987 | @code{DT_RUNPATH} entries exist. | |
1988 | @item | |
252b5132 RH |
1989 | The default directories, normally @file{/lib} and @file{/usr/lib}. |
1990 | @item | |
1991 | For a native linker on an ELF system, if the file @file{/etc/ld.so.conf} | |
1992 | exists, the list of directories found in that file. | |
1993 | @end enumerate | |
1994 | ||
1995 | If the required shared library is not found, the linker will issue a | |
1996 | warning and continue with the link. | |
1997 | @end ifset | |
1998 | ||
1999 | @kindex -shared | |
2000 | @kindex -Bshareable | |
2001 | @item -shared | |
2002 | @itemx -Bshareable | |
2003 | @cindex shared libraries | |
2004 | Create a shared library. This is currently only supported on ELF, XCOFF | |
2005 | and SunOS platforms. On SunOS, the linker will automatically create a | |
ff5dcc92 | 2006 | shared library if the @option{-e} option is not used and there are |
252b5132 RH |
2007 | undefined symbols in the link. |
2008 | ||
252b5132 | 2009 | @kindex --sort-common |
2509a395 SL |
2010 | @item --sort-common |
2011 | @itemx --sort-common=ascending | |
2012 | @itemx --sort-common=descending | |
de7dd2bd NC |
2013 | This option tells @command{ld} to sort the common symbols by alignment in |
2014 | ascending or descending order when it places them in the appropriate output | |
2015 | sections. The symbol alignments considered are sixteen-byte or larger, | |
2016 | eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps | |
2017 | between symbols due to alignment constraints. If no sorting order is | |
2018 | specified, then descending order is assumed. | |
252b5132 | 2019 | |
2509a395 SL |
2020 | @kindex --sort-section=name |
2021 | @item --sort-section=name | |
bcaa7b3e L |
2022 | This option will apply @code{SORT_BY_NAME} to all wildcard section |
2023 | patterns in the linker script. | |
2024 | ||
2509a395 SL |
2025 | @kindex --sort-section=alignment |
2026 | @item --sort-section=alignment | |
bcaa7b3e L |
2027 | This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section |
2028 | patterns in the linker script. | |
2029 | ||
a70f34c0 NC |
2030 | @kindex --spare-dynamic-tags |
2031 | @item --spare-dynamic-tags=@var{count} | |
2032 | This option specifies the number of empty slots to leave in the | |
2033 | .dynamic section of ELF shared objects. Empty slots may be needed by | |
2034 | post processing tools, such as the prelinker. The default is 5. | |
2035 | ||
252b5132 | 2036 | @kindex --split-by-file |
2509a395 | 2037 | @item --split-by-file[=@var{size}] |
ff5dcc92 | 2038 | Similar to @option{--split-by-reloc} but creates a new output section for |
a854a4a7 AM |
2039 | each input file when @var{size} is reached. @var{size} defaults to a |
2040 | size of 1 if not given. | |
252b5132 RH |
2041 | |
2042 | @kindex --split-by-reloc | |
2509a395 | 2043 | @item --split-by-reloc[=@var{count}] |
a854a4a7 | 2044 | Tries to creates extra sections in the output file so that no single |
252b5132 | 2045 | output section in the file contains more than @var{count} relocations. |
a854a4a7 | 2046 | This is useful when generating huge relocatable files for downloading into |
252b5132 RH |
2047 | certain real time kernels with the COFF object file format; since COFF |
2048 | cannot represent more than 65535 relocations in a single section. Note | |
2049 | that this will fail to work with object file formats which do not | |
2050 | support arbitrary sections. The linker will not split up individual | |
2051 | input sections for redistribution, so if a single input section contains | |
2052 | more than @var{count} relocations one output section will contain that | |
a854a4a7 | 2053 | many relocations. @var{count} defaults to a value of 32768. |
252b5132 RH |
2054 | |
2055 | @kindex --stats | |
2056 | @item --stats | |
2057 | Compute and display statistics about the operation of the linker, such | |
2058 | as execution time and memory usage. | |
2059 | ||
2509a395 | 2060 | @kindex --sysroot=@var{directory} |
e2243057 RS |
2061 | @item --sysroot=@var{directory} |
2062 | Use @var{directory} as the location of the sysroot, overriding the | |
2063 | configure-time default. This option is only supported by linkers | |
2064 | that were configured using @option{--with-sysroot}. | |
2065 | ||
a70f34c0 NC |
2066 | @kindex --task-link |
2067 | @item --task-link | |
2068 | This is used by COFF/PE based targets to create a task-linked object | |
2069 | file where all of the global symbols have been converted to statics. | |
2070 | ||
252b5132 RH |
2071 | @kindex --traditional-format |
2072 | @cindex traditional format | |
2073 | @item --traditional-format | |
ff5dcc92 SC |
2074 | For some targets, the output of @command{ld} is different in some ways from |
2075 | the output of some existing linker. This switch requests @command{ld} to | |
252b5132 RH |
2076 | use the traditional format instead. |
2077 | ||
2078 | @cindex dbx | |
ff5dcc92 | 2079 | For example, on SunOS, @command{ld} combines duplicate entries in the |
252b5132 RH |
2080 | symbol string table. This can reduce the size of an output file with |
2081 | full debugging information by over 30 percent. Unfortunately, the SunOS | |
2082 | @code{dbx} program can not read the resulting program (@code{gdb} has no | |
ff5dcc92 | 2083 | trouble). The @samp{--traditional-format} switch tells @command{ld} to not |
252b5132 RH |
2084 | combine duplicate entries. |
2085 | ||
2509a395 SL |
2086 | @kindex --section-start=@var{sectionname}=@var{org} |
2087 | @item --section-start=@var{sectionname}=@var{org} | |
176355da NC |
2088 | Locate a section in the output file at the absolute |
2089 | address given by @var{org}. You may use this option as many | |
2090 | times as necessary to locate multiple sections in the command | |
2091 | line. | |
2092 | @var{org} must be a single hexadecimal integer; | |
2093 | for compatibility with other linkers, you may omit the leading | |
2094 | @samp{0x} usually associated with hexadecimal values. @emph{Note:} there | |
2095 | should be no white space between @var{sectionname}, the equals | |
2096 | sign (``@key{=}''), and @var{org}. | |
2097 | ||
2509a395 SL |
2098 | @kindex -Tbss=@var{org} |
2099 | @kindex -Tdata=@var{org} | |
2100 | @kindex -Ttext=@var{org} | |
252b5132 | 2101 | @cindex segment origins, cmd line |
2509a395 SL |
2102 | @item -Tbss=@var{org} |
2103 | @itemx -Tdata=@var{org} | |
2104 | @itemx -Ttext=@var{org} | |
2105 | Same as @option{--section-start}, with @code{.bss}, @code{.data} or | |
a6e02871 | 2106 | @code{.text} as the @var{sectionname}. |
252b5132 | 2107 | |
2509a395 SL |
2108 | @kindex -Ttext-segment=@var{org} |
2109 | @item -Ttext-segment=@var{org} | |
258795f5 | 2110 | @cindex text segment origin, cmd line |
2b8c06a3 L |
2111 | When creating an ELF executable, it will set the address of the first |
2112 | byte of the text segment. | |
258795f5 | 2113 | |
9d5777a3 RM |
2114 | @kindex -Trodata-segment=@var{org} |
2115 | @item -Trodata-segment=@var{org} | |
2116 | @cindex rodata segment origin, cmd line | |
2117 | When creating an ELF executable or shared object for a target where | |
2118 | the read-only data is in its own segment separate from the executable | |
2119 | text, it will set the address of the first byte of the read-only data segment. | |
2120 | ||
0d705e9f AM |
2121 | @kindex -Tldata-segment=@var{org} |
2122 | @item -Tldata-segment=@var{org} | |
2123 | @cindex ldata segment origin, cmd line | |
2124 | When creating an ELF executable or shared object for x86-64 medium memory | |
2125 | model, it will set the address of the first byte of the ldata segment. | |
2126 | ||
560e09e9 NC |
2127 | @kindex --unresolved-symbols |
2128 | @item --unresolved-symbols=@var{method} | |
2129 | Determine how to handle unresolved symbols. There are four possible | |
2130 | values for @samp{method}: | |
2131 | ||
2132 | @table @samp | |
2133 | @item ignore-all | |
da8bce14 | 2134 | Do not report any unresolved symbols. |
560e09e9 NC |
2135 | |
2136 | @item report-all | |
da8bce14 | 2137 | Report all unresolved symbols. This is the default. |
560e09e9 NC |
2138 | |
2139 | @item ignore-in-object-files | |
2140 | Report unresolved symbols that are contained in shared libraries, but | |
2141 | ignore them if they come from regular object files. | |
2142 | ||
2143 | @item ignore-in-shared-libs | |
2144 | Report unresolved symbols that come from regular object files, but | |
2145 | ignore them if they come from shared libraries. This can be useful | |
2146 | when creating a dynamic binary and it is known that all the shared | |
2147 | libraries that it should be referencing are included on the linker's | |
2148 | command line. | |
2149 | @end table | |
2150 | ||
2151 | The behaviour for shared libraries on their own can also be controlled | |
2152 | by the @option{--[no-]allow-shlib-undefined} option. | |
2153 | ||
2154 | Normally the linker will generate an error message for each reported | |
2155 | unresolved symbol but the option @option{--warn-unresolved-symbols} | |
2156 | can change this to a warning. | |
2157 | ||
1715a13c L |
2158 | @kindex --verbose[=@var{NUMBER}] |
2159 | @cindex verbose[=@var{NUMBER}] | |
252b5132 | 2160 | @item --dll-verbose |
1715a13c | 2161 | @itemx --verbose[=@var{NUMBER}] |
ff5dcc92 | 2162 | Display the version number for @command{ld} and list the linker emulations |
252b5132 | 2163 | supported. Display which input files can and cannot be opened. Display |
1715a13c L |
2164 | the linker script being used by the linker. If the optional @var{NUMBER} |
2165 | argument > 1, plugin symbol status will also be displayed. | |
252b5132 RH |
2166 | |
2167 | @kindex --version-script=@var{version-scriptfile} | |
2168 | @cindex version script, symbol versions | |
2509a395 | 2169 | @item --version-script=@var{version-scriptfile} |
252b5132 RH |
2170 | Specify the name of a version script to the linker. This is typically |
2171 | used when creating shared libraries to specify additional information | |
36f63dca | 2172 | about the version hierarchy for the library being created. This option |
09e2aba4 DK |
2173 | is only fully supported on ELF platforms which support shared libraries; |
2174 | see @ref{VERSION}. It is partially supported on PE platforms, which can | |
2175 | use version scripts to filter symbol visibility in auto-export mode: any | |
2176 | symbols marked @samp{local} in the version script will not be exported. | |
2177 | @xref{WIN32}. | |
252b5132 | 2178 | |
7ce691ae | 2179 | @kindex --warn-common |
252b5132 RH |
2180 | @cindex warnings, on combining symbols |
2181 | @cindex combining symbols, warnings on | |
2182 | @item --warn-common | |
2183 | Warn when a common symbol is combined with another common symbol or with | |
11e7fd74 | 2184 | a symbol definition. Unix linkers allow this somewhat sloppy practice, |
252b5132 RH |
2185 | but linkers on some other operating systems do not. This option allows |
2186 | you to find potential problems from combining global symbols. | |
11e7fd74 | 2187 | Unfortunately, some C libraries use this practice, so you may get some |
252b5132 RH |
2188 | warnings about symbols in the libraries as well as in your programs. |
2189 | ||
2190 | There are three kinds of global symbols, illustrated here by C examples: | |
2191 | ||
2192 | @table @samp | |
2193 | @item int i = 1; | |
2194 | A definition, which goes in the initialized data section of the output | |
2195 | file. | |
2196 | ||
2197 | @item extern int i; | |
2198 | An undefined reference, which does not allocate space. | |
2199 | There must be either a definition or a common symbol for the | |
2200 | variable somewhere. | |
2201 | ||
2202 | @item int i; | |
2203 | A common symbol. If there are only (one or more) common symbols for a | |
2204 | variable, it goes in the uninitialized data area of the output file. | |
2205 | The linker merges multiple common symbols for the same variable into a | |
2206 | single symbol. If they are of different sizes, it picks the largest | |
2207 | size. The linker turns a common symbol into a declaration, if there is | |
2208 | a definition of the same variable. | |
2209 | @end table | |
2210 | ||
2211 | The @samp{--warn-common} option can produce five kinds of warnings. | |
2212 | Each warning consists of a pair of lines: the first describes the symbol | |
2213 | just encountered, and the second describes the previous symbol | |
2214 | encountered with the same name. One or both of the two symbols will be | |
2215 | a common symbol. | |
2216 | ||
2217 | @enumerate | |
2218 | @item | |
2219 | Turning a common symbol into a reference, because there is already a | |
2220 | definition for the symbol. | |
2221 | @smallexample | |
2222 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2223 | overridden by definition | |
2224 | @var{file}(@var{section}): warning: defined here | |
2225 | @end smallexample | |
2226 | ||
2227 | @item | |
2228 | Turning a common symbol into a reference, because a later definition for | |
2229 | the symbol is encountered. This is the same as the previous case, | |
2230 | except that the symbols are encountered in a different order. | |
2231 | @smallexample | |
2232 | @var{file}(@var{section}): warning: definition of `@var{symbol}' | |
2233 | overriding common | |
2234 | @var{file}(@var{section}): warning: common is here | |
2235 | @end smallexample | |
2236 | ||
2237 | @item | |
2238 | Merging a common symbol with a previous same-sized common symbol. | |
2239 | @smallexample | |
2240 | @var{file}(@var{section}): warning: multiple common | |
2241 | of `@var{symbol}' | |
2242 | @var{file}(@var{section}): warning: previous common is here | |
2243 | @end smallexample | |
2244 | ||
2245 | @item | |
2246 | Merging a common symbol with a previous larger common symbol. | |
2247 | @smallexample | |
2248 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2249 | overridden by larger common | |
2250 | @var{file}(@var{section}): warning: larger common is here | |
2251 | @end smallexample | |
2252 | ||
2253 | @item | |
2254 | Merging a common symbol with a previous smaller common symbol. This is | |
2255 | the same as the previous case, except that the symbols are | |
2256 | encountered in a different order. | |
2257 | @smallexample | |
2258 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2259 | overriding smaller common | |
2260 | @var{file}(@var{section}): warning: smaller common is here | |
2261 | @end smallexample | |
2262 | @end enumerate | |
2263 | ||
2264 | @kindex --warn-constructors | |
2265 | @item --warn-constructors | |
2266 | Warn if any global constructors are used. This is only useful for a few | |
2267 | object file formats. For formats like COFF or ELF, the linker can not | |
2268 | detect the use of global constructors. | |
2269 | ||
2270 | @kindex --warn-multiple-gp | |
2271 | @item --warn-multiple-gp | |
2272 | Warn if multiple global pointer values are required in the output file. | |
2273 | This is only meaningful for certain processors, such as the Alpha. | |
2274 | Specifically, some processors put large-valued constants in a special | |
2275 | section. A special register (the global pointer) points into the middle | |
2276 | of this section, so that constants can be loaded efficiently via a | |
2277 | base-register relative addressing mode. Since the offset in | |
2278 | base-register relative mode is fixed and relatively small (e.g., 16 | |
2279 | bits), this limits the maximum size of the constant pool. Thus, in | |
2280 | large programs, it is often necessary to use multiple global pointer | |
2281 | values in order to be able to address all possible constants. This | |
2282 | option causes a warning to be issued whenever this case occurs. | |
2283 | ||
2284 | @kindex --warn-once | |
2285 | @cindex warnings, on undefined symbols | |
2286 | @cindex undefined symbols, warnings on | |
2287 | @item --warn-once | |
2288 | Only warn once for each undefined symbol, rather than once per module | |
2289 | which refers to it. | |
2290 | ||
2291 | @kindex --warn-section-align | |
2292 | @cindex warnings, on section alignment | |
2293 | @cindex section alignment, warnings on | |
2294 | @item --warn-section-align | |
2295 | Warn if the address of an output section is changed because of | |
2296 | alignment. Typically, the alignment will be set by an input section. | |
2297 | The address will only be changed if it not explicitly specified; that | |
2298 | is, if the @code{SECTIONS} command does not specify a start address for | |
2299 | the section (@pxref{SECTIONS}). | |
2300 | ||
8fdd7217 NC |
2301 | @kindex --warn-shared-textrel |
2302 | @item --warn-shared-textrel | |
ece2d90e | 2303 | Warn if the linker adds a DT_TEXTREL to a shared object. |
8fdd7217 | 2304 | |
a0c402a5 L |
2305 | @kindex --warn-alternate-em |
2306 | @item --warn-alternate-em | |
2307 | Warn if an object has alternate ELF machine code. | |
2308 | ||
560e09e9 NC |
2309 | @kindex --warn-unresolved-symbols |
2310 | @item --warn-unresolved-symbols | |
2311 | If the linker is going to report an unresolved symbol (see the option | |
2312 | @option{--unresolved-symbols}) it will normally generate an error. | |
2313 | This option makes it generate a warning instead. | |
2314 | ||
2315 | @kindex --error-unresolved-symbols | |
2316 | @item --error-unresolved-symbols | |
2317 | This restores the linker's default behaviour of generating errors when | |
2318 | it is reporting unresolved symbols. | |
2319 | ||
252b5132 RH |
2320 | @kindex --whole-archive |
2321 | @cindex including an entire archive | |
2322 | @item --whole-archive | |
2323 | For each archive mentioned on the command line after the | |
ff5dcc92 | 2324 | @option{--whole-archive} option, include every object file in the archive |
252b5132 RH |
2325 | in the link, rather than searching the archive for the required object |
2326 | files. This is normally used to turn an archive file into a shared | |
2327 | library, forcing every object to be included in the resulting shared | |
2328 | library. This option may be used more than once. | |
2329 | ||
7ec229ce | 2330 | Two notes when using this option from gcc: First, gcc doesn't know |
ff5dcc92 SC |
2331 | about this option, so you have to use @option{-Wl,-whole-archive}. |
2332 | Second, don't forget to use @option{-Wl,-no-whole-archive} after your | |
7ec229ce DD |
2333 | list of archives, because gcc will add its own list of archives to |
2334 | your link and you may not want this flag to affect those as well. | |
2335 | ||
2509a395 SL |
2336 | @kindex --wrap=@var{symbol} |
2337 | @item --wrap=@var{symbol} | |
252b5132 RH |
2338 | Use a wrapper function for @var{symbol}. Any undefined reference to |
2339 | @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any | |
2340 | undefined reference to @code{__real_@var{symbol}} will be resolved to | |
2341 | @var{symbol}. | |
2342 | ||
2343 | This can be used to provide a wrapper for a system function. The | |
2344 | wrapper function should be called @code{__wrap_@var{symbol}}. If it | |
2345 | wishes to call the system function, it should call | |
2346 | @code{__real_@var{symbol}}. | |
2347 | ||
2348 | Here is a trivial example: | |
2349 | ||
2350 | @smallexample | |
2351 | void * | |
cc2f008e | 2352 | __wrap_malloc (size_t c) |
252b5132 | 2353 | @{ |
cc2f008e | 2354 | printf ("malloc called with %zu\n", c); |
252b5132 RH |
2355 | return __real_malloc (c); |
2356 | @} | |
2357 | @end smallexample | |
2358 | ||
ff5dcc92 | 2359 | If you link other code with this file using @option{--wrap malloc}, then |
252b5132 RH |
2360 | all calls to @code{malloc} will call the function @code{__wrap_malloc} |
2361 | instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will | |
2362 | call the real @code{malloc} function. | |
2363 | ||
2364 | You may wish to provide a @code{__real_malloc} function as well, so that | |
ff5dcc92 | 2365 | links without the @option{--wrap} option will succeed. If you do this, |
252b5132 RH |
2366 | you should not put the definition of @code{__real_malloc} in the same |
2367 | file as @code{__wrap_malloc}; if you do, the assembler may resolve the | |
2368 | call before the linker has a chance to wrap it to @code{malloc}. | |
2369 | ||
6aa29e7b | 2370 | @kindex --eh-frame-hdr |
29063f8b | 2371 | @kindex --no-eh-frame-hdr |
6aa29e7b | 2372 | @item --eh-frame-hdr |
29063f8b NC |
2373 | @itemx --no-eh-frame-hdr |
2374 | Request (@option{--eh-frame-hdr}) or suppress | |
2375 | (@option{--no-eh-frame-hdr}) the creation of @code{.eh_frame_hdr} | |
2376 | section and ELF @code{PT_GNU_EH_FRAME} segment header. | |
6aa29e7b | 2377 | |
e41b3a13 JJ |
2378 | @kindex --ld-generated-unwind-info |
2379 | @item --no-ld-generated-unwind-info | |
2380 | Request creation of @code{.eh_frame} unwind info for linker | |
2381 | generated code sections like PLT. This option is on by default | |
2382 | if linker generated unwind info is supported. | |
2383 | ||
6c1439be L |
2384 | @kindex --enable-new-dtags |
2385 | @kindex --disable-new-dtags | |
2386 | @item --enable-new-dtags | |
2387 | @itemx --disable-new-dtags | |
2388 | This linker can create the new dynamic tags in ELF. But the older ELF | |
2389 | systems may not understand them. If you specify | |
b1b00fcc MF |
2390 | @option{--enable-new-dtags}, the new dynamic tags will be created as needed |
2391 | and older dynamic tags will be omitted. | |
ff5dcc92 | 2392 | If you specify @option{--disable-new-dtags}, no new dynamic tags will be |
6c1439be L |
2393 | created. By default, the new dynamic tags are not created. Note that |
2394 | those options are only available for ELF systems. | |
2395 | ||
2d643429 | 2396 | @kindex --hash-size=@var{number} |
e185dd51 | 2397 | @item --hash-size=@var{number} |
2d643429 NC |
2398 | Set the default size of the linker's hash tables to a prime number |
2399 | close to @var{number}. Increasing this value can reduce the length of | |
2400 | time it takes the linker to perform its tasks, at the expense of | |
2401 | increasing the linker's memory requirements. Similarly reducing this | |
2402 | value can reduce the memory requirements at the expense of speed. | |
2403 | ||
fdc90cb4 JJ |
2404 | @kindex --hash-style=@var{style} |
2405 | @item --hash-style=@var{style} | |
2406 | Set the type of linker's hash table(s). @var{style} can be either | |
2407 | @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for | |
2408 | new style GNU @code{.gnu.hash} section or @code{both} for both | |
2409 | the classic ELF @code{.hash} and new style GNU @code{.gnu.hash} | |
2410 | hash tables. The default is @code{sysv}. | |
2411 | ||
0ce398f1 L |
2412 | @kindex --compress-debug-sections=none |
2413 | @kindex --compress-debug-sections=zlib | |
2414 | @kindex --compress-debug-sections=zlib-gnu | |
2415 | @kindex --compress-debug-sections=zlib-gabi | |
2416 | @item --compress-debug-sections=none | |
2417 | @itemx --compress-debug-sections=zlib | |
2418 | @itemx --compress-debug-sections=zlib-gnu | |
2419 | @itemx --compress-debug-sections=zlib-gabi | |
9af89fba NC |
2420 | On ELF platforms, these options control how DWARF debug sections are |
2421 | compressed using zlib. | |
2422 | ||
2423 | @option{--compress-debug-sections=none} doesn't compress DWARF debug | |
2424 | sections. @option{--compress-debug-sections=zlib-gnu} compresses | |
2425 | DWARF debug sections and renames them to begin with @samp{.zdebug} | |
2426 | instead of @samp{.debug}. @option{--compress-debug-sections=zlib-gabi} | |
2427 | also compresses DWARF debug sections, but rather than renaming them it | |
2428 | sets the SHF_COMPRESSED flag in the sections' headers. | |
2429 | ||
2430 | The @option{--compress-debug-sections=zlib} option is an alias for | |
2431 | @option{--compress-debug-sections=zlib-gabi}. | |
2432 | ||
2433 | Note that this option overrides any compression in input debug | |
2434 | sections, so if a binary is linked with @option{--compress-debug-sections=none} | |
2435 | for example, then any compressed debug sections in input files will be | |
2436 | uncompressed before they are copied into the output binary. | |
2437 | ||
2438 | The default compression behaviour varies depending upon the target | |
2439 | involved and the configure options used to build the toolchain. The | |
2440 | default can be determined by examining the output from the linker's | |
2441 | @option{--help} option. | |
0ce398f1 | 2442 | |
35835446 JR |
2443 | @kindex --reduce-memory-overheads |
2444 | @item --reduce-memory-overheads | |
2445 | This option reduces memory requirements at ld runtime, at the expense of | |
f2a8f148 | 2446 | linking speed. This was introduced to select the old O(n^2) algorithm |
35835446 | 2447 | for link map file generation, rather than the new O(n) algorithm which uses |
2d643429 NC |
2448 | about 40% more memory for symbol storage. |
2449 | ||
4f9c04f7 | 2450 | Another effect of the switch is to set the default hash table size to |
2d643429 | 2451 | 1021, which again saves memory at the cost of lengthening the linker's |
a85785bc | 2452 | run time. This is not done however if the @option{--hash-size} switch |
2d643429 NC |
2453 | has been used. |
2454 | ||
2455 | The @option{--reduce-memory-overheads} switch may be also be used to | |
2456 | enable other tradeoffs in future versions of the linker. | |
35835446 | 2457 | |
c0065db7 RM |
2458 | @kindex --build-id |
2459 | @kindex --build-id=@var{style} | |
2460 | @item --build-id | |
2461 | @itemx --build-id=@var{style} | |
61e2488c | 2462 | Request the creation of a @code{.note.gnu.build-id} ELF note section |
6033bf41 | 2463 | or a @code{.buildid} COFF section. The contents of the note are |
61e2488c JT |
2464 | unique bits identifying this linked file. @var{style} can be |
2465 | @code{uuid} to use 128 random bits, @code{sha1} to use a 160-bit | |
2466 | @sc{SHA1} hash on the normative parts of the output contents, | |
2467 | @code{md5} to use a 128-bit @sc{MD5} hash on the normative parts of | |
2468 | the output contents, or @code{0x@var{hexstring}} to use a chosen bit | |
2469 | string specified as an even number of hexadecimal digits (@code{-} and | |
2470 | @code{:} characters between digit pairs are ignored). If @var{style} | |
2471 | is omitted, @code{sha1} is used. | |
24382dca RM |
2472 | |
2473 | The @code{md5} and @code{sha1} styles produces an identifier | |
2474 | that is always the same in an identical output file, but will be | |
2475 | unique among all nonidentical output files. It is not intended | |
2476 | to be compared as a checksum for the file's contents. A linked | |
2477 | file may be changed later by other tools, but the build ID bit | |
2478 | string identifying the original linked file does not change. | |
c0065db7 RM |
2479 | |
2480 | Passing @code{none} for @var{style} disables the setting from any | |
2481 | @code{--build-id} options earlier on the command line. | |
252b5132 RH |
2482 | @end table |
2483 | ||
0285c67d NC |
2484 | @c man end |
2485 | ||
36f63dca | 2486 | @subsection Options Specific to i386 PE Targets |
252b5132 | 2487 | |
0285c67d NC |
2488 | @c man begin OPTIONS |
2489 | ||
ff5dcc92 | 2490 | The i386 PE linker supports the @option{-shared} option, which causes |
252b5132 RH |
2491 | the output to be a dynamically linked library (DLL) instead of a |
2492 | normal executable. You should name the output @code{*.dll} when you | |
2493 | use this option. In addition, the linker fully supports the standard | |
2494 | @code{*.def} files, which may be specified on the linker command line | |
2495 | like an object file (in fact, it should precede archives it exports | |
2496 | symbols from, to ensure that they get linked in, just like a normal | |
2497 | object file). | |
2498 | ||
2499 | In addition to the options common to all targets, the i386 PE linker | |
2500 | support additional command line options that are specific to the i386 | |
2501 | PE target. Options that take values may be separated from their | |
2502 | values by either a space or an equals sign. | |
2503 | ||
ff5dcc92 | 2504 | @table @gcctabopt |
252b5132 RH |
2505 | |
2506 | @kindex --add-stdcall-alias | |
2507 | @item --add-stdcall-alias | |
2508 | If given, symbols with a stdcall suffix (@@@var{nn}) will be exported | |
2509 | as-is and also with the suffix stripped. | |
bb10df36 | 2510 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2511 | |
2512 | @kindex --base-file | |
2513 | @item --base-file @var{file} | |
2514 | Use @var{file} as the name of a file in which to save the base | |
2515 | addresses of all the relocations needed for generating DLLs with | |
2516 | @file{dlltool}. | |
bb10df36 | 2517 | [This is an i386 PE specific option] |
252b5132 RH |
2518 | |
2519 | @kindex --dll | |
2520 | @item --dll | |
2521 | Create a DLL instead of a regular executable. You may also use | |
ff5dcc92 | 2522 | @option{-shared} or specify a @code{LIBRARY} in a given @code{.def} |
252b5132 | 2523 | file. |
bb10df36 | 2524 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2525 | |
88183869 DK |
2526 | @kindex --enable-long-section-names |
2527 | @kindex --disable-long-section-names | |
2528 | @item --enable-long-section-names | |
2529 | @itemx --disable-long-section-names | |
56e6cf80 | 2530 | The PE variants of the COFF object format add an extension that permits |
88183869 | 2531 | the use of section names longer than eight characters, the normal limit |
56e6cf80 NC |
2532 | for COFF. By default, these names are only allowed in object files, as |
2533 | fully-linked executable images do not carry the COFF string table required | |
88183869 DK |
2534 | to support the longer names. As a GNU extension, it is possible to |
2535 | allow their use in executable images as well, or to (probably pointlessly!) | |
2536 | disallow it in object files, by using these two options. Executable images | |
2537 | generated with these long section names are slightly non-standard, carrying | |
2538 | as they do a string table, and may generate confusing output when examined | |
9d5777a3 RM |
2539 | with non-GNU PE-aware tools, such as file viewers and dumpers. However, |
2540 | GDB relies on the use of PE long section names to find Dwarf-2 debug | |
3efd345c DK |
2541 | information sections in an executable image at runtime, and so if neither |
2542 | option is specified on the command-line, @command{ld} will enable long | |
2543 | section names, overriding the default and technically correct behaviour, | |
2544 | when it finds the presence of debug information while linking an executable | |
2545 | image and not stripping symbols. | |
88183869 DK |
2546 | [This option is valid for all PE targeted ports of the linker] |
2547 | ||
252b5132 RH |
2548 | @kindex --enable-stdcall-fixup |
2549 | @kindex --disable-stdcall-fixup | |
2550 | @item --enable-stdcall-fixup | |
2551 | @itemx --disable-stdcall-fixup | |
2552 | If the link finds a symbol that it cannot resolve, it will attempt to | |
36f63dca | 2553 | do ``fuzzy linking'' by looking for another defined symbol that differs |
252b5132 RH |
2554 | only in the format of the symbol name (cdecl vs stdcall) and will |
2555 | resolve that symbol by linking to the match. For example, the | |
2556 | undefined symbol @code{_foo} might be linked to the function | |
2557 | @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked | |
2558 | to the function @code{_bar}. When the linker does this, it prints a | |
2559 | warning, since it normally should have failed to link, but sometimes | |
2560 | import libraries generated from third-party dlls may need this feature | |
ff5dcc92 | 2561 | to be usable. If you specify @option{--enable-stdcall-fixup}, this |
252b5132 | 2562 | feature is fully enabled and warnings are not printed. If you specify |
ff5dcc92 | 2563 | @option{--disable-stdcall-fixup}, this feature is disabled and such |
252b5132 | 2564 | mismatches are considered to be errors. |
bb10df36 | 2565 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2566 | |
522f09cd KT |
2567 | @kindex --leading-underscore |
2568 | @kindex --no-leading-underscore | |
2569 | @item --leading-underscore | |
2570 | @itemx --no-leading-underscore | |
2571 | For most targets default symbol-prefix is an underscore and is defined | |
2572 | in target's description. By this option it is possible to | |
2573 | disable/enable the default underscore symbol-prefix. | |
2574 | ||
252b5132 RH |
2575 | @cindex DLLs, creating |
2576 | @kindex --export-all-symbols | |
2577 | @item --export-all-symbols | |
2578 | If given, all global symbols in the objects used to build a DLL will | |
2579 | be exported by the DLL. Note that this is the default if there | |
2580 | otherwise wouldn't be any exported symbols. When symbols are | |
2581 | explicitly exported via DEF files or implicitly exported via function | |
2582 | attributes, the default is to not export anything else unless this | |
2583 | option is given. Note that the symbols @code{DllMain@@12}, | |
ece2d90e | 2584 | @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and |
b044cda1 | 2585 | @code{impure_ptr} will not be automatically |
ece2d90e NC |
2586 | exported. Also, symbols imported from other DLLs will not be |
2587 | re-exported, nor will symbols specifying the DLL's internal layout | |
2588 | such as those beginning with @code{_head_} or ending with | |
2589 | @code{_iname}. In addition, no symbols from @code{libgcc}, | |
b044cda1 CW |
2590 | @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported. |
2591 | Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will | |
2592 | not be exported, to help with C++ DLLs. Finally, there is an | |
ece2d90e | 2593 | extensive list of cygwin-private symbols that are not exported |
b044cda1 | 2594 | (obviously, this applies on when building DLLs for cygwin targets). |
ece2d90e | 2595 | These cygwin-excludes are: @code{_cygwin_dll_entry@@12}, |
b044cda1 | 2596 | @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12}, |
ece2d90e | 2597 | @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll}, |
b044cda1 | 2598 | @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2}, |
ece2d90e | 2599 | @code{cygwin_premain3}, and @code{environ}. |
bb10df36 | 2600 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2601 | |
2602 | @kindex --exclude-symbols | |
1d0a3c9c | 2603 | @item --exclude-symbols @var{symbol},@var{symbol},... |
252b5132 RH |
2604 | Specifies a list of symbols which should not be automatically |
2605 | exported. The symbol names may be delimited by commas or colons. | |
bb10df36 | 2606 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2607 | |
2927aaca NC |
2608 | @kindex --exclude-all-symbols |
2609 | @item --exclude-all-symbols | |
2610 | Specifies no symbols should be automatically exported. | |
2611 | [This option is specific to the i386 PE targeted port of the linker] | |
2612 | ||
252b5132 RH |
2613 | @kindex --file-alignment |
2614 | @item --file-alignment | |
2615 | Specify the file alignment. Sections in the file will always begin at | |
2616 | file offsets which are multiples of this number. This defaults to | |
2617 | 512. | |
bb10df36 | 2618 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2619 | |
2620 | @cindex heap size | |
2621 | @kindex --heap | |
2622 | @item --heap @var{reserve} | |
2623 | @itemx --heap @var{reserve},@var{commit} | |
a00b50c5 | 2624 | Specify the number of bytes of memory to reserve (and optionally commit) |
fe6d7d6a | 2625 | to be used as heap for this program. The default is 1MB reserved, 4K |
252b5132 | 2626 | committed. |
bb10df36 | 2627 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2628 | |
2629 | @cindex image base | |
2630 | @kindex --image-base | |
2631 | @item --image-base @var{value} | |
2632 | Use @var{value} as the base address of your program or dll. This is | |
2633 | the lowest memory location that will be used when your program or dll | |
2634 | is loaded. To reduce the need to relocate and improve performance of | |
2635 | your dlls, each should have a unique base address and not overlap any | |
2636 | other dlls. The default is 0x400000 for executables, and 0x10000000 | |
2637 | for dlls. | |
bb10df36 | 2638 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2639 | |
2640 | @kindex --kill-at | |
2641 | @item --kill-at | |
2642 | If given, the stdcall suffixes (@@@var{nn}) will be stripped from | |
2643 | symbols before they are exported. | |
bb10df36 | 2644 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2645 | |
26d2d8a2 BF |
2646 | @kindex --large-address-aware |
2647 | @item --large-address-aware | |
b45619c0 | 2648 | If given, the appropriate bit in the ``Characteristics'' field of the COFF |
26d2d8a2 | 2649 | header is set to indicate that this executable supports virtual addresses |
b45619c0 | 2650 | greater than 2 gigabytes. This should be used in conjunction with the /3GB |
26d2d8a2 BF |
2651 | or /USERVA=@var{value} megabytes switch in the ``[operating systems]'' |
2652 | section of the BOOT.INI. Otherwise, this bit has no effect. | |
2653 | [This option is specific to PE targeted ports of the linker] | |
2654 | ||
f69a2f97 NC |
2655 | @kindex --disable-large-address-aware |
2656 | @item --disable-large-address-aware | |
2657 | Reverts the effect of a previous @samp{--large-address-aware} option. | |
2658 | This is useful if @samp{--large-address-aware} is always set by the compiler | |
2659 | driver (e.g. Cygwin gcc) and the executable does not support virtual | |
2660 | addresses greater than 2 gigabytes. | |
2661 | [This option is specific to PE targeted ports of the linker] | |
2662 | ||
252b5132 RH |
2663 | @kindex --major-image-version |
2664 | @item --major-image-version @var{value} | |
36f63dca | 2665 | Sets the major number of the ``image version''. Defaults to 1. |
bb10df36 | 2666 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2667 | |
2668 | @kindex --major-os-version | |
2669 | @item --major-os-version @var{value} | |
36f63dca | 2670 | Sets the major number of the ``os version''. Defaults to 4. |
bb10df36 | 2671 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2672 | |
2673 | @kindex --major-subsystem-version | |
2674 | @item --major-subsystem-version @var{value} | |
36f63dca | 2675 | Sets the major number of the ``subsystem version''. Defaults to 4. |
bb10df36 | 2676 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2677 | |
2678 | @kindex --minor-image-version | |
2679 | @item --minor-image-version @var{value} | |
36f63dca | 2680 | Sets the minor number of the ``image version''. Defaults to 0. |
bb10df36 | 2681 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2682 | |
2683 | @kindex --minor-os-version | |
2684 | @item --minor-os-version @var{value} | |
36f63dca | 2685 | Sets the minor number of the ``os version''. Defaults to 0. |
bb10df36 | 2686 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2687 | |
2688 | @kindex --minor-subsystem-version | |
2689 | @item --minor-subsystem-version @var{value} | |
36f63dca | 2690 | Sets the minor number of the ``subsystem version''. Defaults to 0. |
bb10df36 | 2691 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2692 | |
2693 | @cindex DEF files, creating | |
2694 | @cindex DLLs, creating | |
2695 | @kindex --output-def | |
2696 | @item --output-def @var{file} | |
2697 | The linker will create the file @var{file} which will contain a DEF | |
2698 | file corresponding to the DLL the linker is generating. This DEF file | |
2699 | (which should be called @code{*.def}) may be used to create an import | |
2700 | library with @code{dlltool} or may be used as a reference to | |
2701 | automatically or implicitly exported symbols. | |
bb10df36 | 2702 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2703 | |
b044cda1 | 2704 | @cindex DLLs, creating |
b044cda1 CW |
2705 | @kindex --enable-auto-image-base |
2706 | @item --enable-auto-image-base | |
d0e6d77b CF |
2707 | @itemx --enable-auto-image-base=@var{value} |
2708 | Automatically choose the image base for DLLs, optionally starting with base | |
2709 | @var{value}, unless one is specified using the @code{--image-base} argument. | |
2710 | By using a hash generated from the dllname to create unique image bases | |
2711 | for each DLL, in-memory collisions and relocations which can delay program | |
2712 | execution are avoided. | |
bb10df36 | 2713 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2714 | |
2715 | @kindex --disable-auto-image-base | |
2716 | @item --disable-auto-image-base | |
2717 | Do not automatically generate a unique image base. If there is no | |
2718 | user-specified image base (@code{--image-base}) then use the platform | |
2719 | default. | |
bb10df36 | 2720 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2721 | |
2722 | @cindex DLLs, linking to | |
2723 | @kindex --dll-search-prefix | |
2724 | @item --dll-search-prefix @var{string} | |
489d0400 | 2725 | When linking dynamically to a dll without an import library, |
ece2d90e | 2726 | search for @code{<string><basename>.dll} in preference to |
560e09e9 | 2727 | @code{lib<basename>.dll}. This behaviour allows easy distinction |
b044cda1 CW |
2728 | between DLLs built for the various "subplatforms": native, cygwin, |
2729 | uwin, pw, etc. For instance, cygwin DLLs typically use | |
ece2d90e | 2730 | @code{--dll-search-prefix=cyg}. |
bb10df36 | 2731 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2732 | |
2733 | @kindex --enable-auto-import | |
2734 | @item --enable-auto-import | |
ece2d90e | 2735 | Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for |
317ff008 EB |
2736 | DATA imports from DLLs, thus making it possible to bypass the dllimport |
2737 | mechanism on the user side and to reference unmangled symbol names. | |
2738 | [This option is specific to the i386 PE targeted port of the linker] | |
2739 | ||
2740 | The following remarks pertain to the original implementation of the | |
2741 | feature and are obsolete nowadays for Cygwin and MinGW targets. | |
2742 | ||
2743 | Note: Use of the 'auto-import' extension will cause the text section | |
2744 | of the image file to be made writable. This does not conform to the | |
2745 | PE-COFF format specification published by Microsoft. | |
4d8907ac | 2746 | |
e2a83dd0 NC |
2747 | Note - use of the 'auto-import' extension will also cause read only |
2748 | data which would normally be placed into the .rdata section to be | |
2749 | placed into the .data section instead. This is in order to work | |
2750 | around a problem with consts that is described here: | |
2751 | http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html | |
2752 | ||
4d8907ac DS |
2753 | Using 'auto-import' generally will 'just work' -- but sometimes you may |
2754 | see this message: | |
0d888aac | 2755 | |
ece2d90e | 2756 | "variable '<var>' can't be auto-imported. Please read the |
0d888aac CW |
2757 | documentation for ld's @code{--enable-auto-import} for details." |
2758 | ||
ece2d90e NC |
2759 | This message occurs when some (sub)expression accesses an address |
2760 | ultimately given by the sum of two constants (Win32 import tables only | |
c0065db7 RM |
2761 | allow one). Instances where this may occur include accesses to member |
2762 | fields of struct variables imported from a DLL, as well as using a | |
2763 | constant index into an array variable imported from a DLL. Any | |
2f8d8971 NC |
2764 | multiword variable (arrays, structs, long long, etc) may trigger |
2765 | this error condition. However, regardless of the exact data type | |
2766 | of the offending exported variable, ld will always detect it, issue | |
2767 | the warning, and exit. | |
2768 | ||
2769 | There are several ways to address this difficulty, regardless of the | |
2770 | data type of the exported variable: | |
0d888aac | 2771 | |
2fa9fc65 NC |
2772 | One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task |
2773 | of adjusting references in your client code for runtime environment, so | |
560e09e9 | 2774 | this method works only when runtime environment supports this feature. |
2fa9fc65 | 2775 | |
c0065db7 RM |
2776 | A second solution is to force one of the 'constants' to be a variable -- |
2777 | that is, unknown and un-optimizable at compile time. For arrays, | |
2778 | there are two possibilities: a) make the indexee (the array's address) | |
0d888aac CW |
2779 | a variable, or b) make the 'constant' index a variable. Thus: |
2780 | ||
2781 | @example | |
2782 | extern type extern_array[]; | |
c0065db7 | 2783 | extern_array[1] --> |
0d888aac CW |
2784 | @{ volatile type *t=extern_array; t[1] @} |
2785 | @end example | |
2786 | ||
2787 | or | |
2788 | ||
2789 | @example | |
2790 | extern type extern_array[]; | |
c0065db7 | 2791 | extern_array[1] --> |
0d888aac CW |
2792 | @{ volatile int t=1; extern_array[t] @} |
2793 | @end example | |
2794 | ||
c0065db7 | 2795 | For structs (and most other multiword data types) the only option |
2f8d8971 | 2796 | is to make the struct itself (or the long long, or the ...) variable: |
0d888aac CW |
2797 | |
2798 | @example | |
2799 | extern struct s extern_struct; | |
c0065db7 | 2800 | extern_struct.field --> |
0d888aac CW |
2801 | @{ volatile struct s *t=&extern_struct; t->field @} |
2802 | @end example | |
2803 | ||
c406afaf NC |
2804 | or |
2805 | ||
2806 | @example | |
2807 | extern long long extern_ll; | |
2808 | extern_ll --> | |
2809 | @{ volatile long long * local_ll=&extern_ll; *local_ll @} | |
2810 | @end example | |
2811 | ||
2fa9fc65 | 2812 | A third method of dealing with this difficulty is to abandon |
c0065db7 | 2813 | 'auto-import' for the offending symbol and mark it with |
11e7fd74 | 2814 | @code{__declspec(dllimport)}. However, in practice that |
0d888aac | 2815 | requires using compile-time #defines to indicate whether you are |
c0065db7 RM |
2816 | building a DLL, building client code that will link to the DLL, or |
2817 | merely building/linking to a static library. In making the choice | |
2818 | between the various methods of resolving the 'direct address with | |
0d888aac CW |
2819 | constant offset' problem, you should consider typical real-world usage: |
2820 | ||
2821 | Original: | |
2822 | @example | |
2823 | --foo.h | |
2824 | extern int arr[]; | |
2825 | --foo.c | |
2826 | #include "foo.h" | |
2827 | void main(int argc, char **argv)@{ | |
2828 | printf("%d\n",arr[1]); | |
2829 | @} | |
2830 | @end example | |
2831 | ||
2832 | Solution 1: | |
2833 | @example | |
2834 | --foo.h | |
2835 | extern int arr[]; | |
2836 | --foo.c | |
2837 | #include "foo.h" | |
2838 | void main(int argc, char **argv)@{ | |
2839 | /* This workaround is for win32 and cygwin; do not "optimize" */ | |
2840 | volatile int *parr = arr; | |
2841 | printf("%d\n",parr[1]); | |
2842 | @} | |
2843 | @end example | |
2844 | ||
2845 | Solution 2: | |
2846 | @example | |
2847 | --foo.h | |
2848 | /* Note: auto-export is assumed (no __declspec(dllexport)) */ | |
2849 | #if (defined(_WIN32) || defined(__CYGWIN__)) && \ | |
2850 | !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC)) | |
2851 | #define FOO_IMPORT __declspec(dllimport) | |
2852 | #else | |
2853 | #define FOO_IMPORT | |
2854 | #endif | |
2855 | extern FOO_IMPORT int arr[]; | |
2856 | --foo.c | |
2857 | #include "foo.h" | |
2858 | void main(int argc, char **argv)@{ | |
2859 | printf("%d\n",arr[1]); | |
2860 | @} | |
2861 | @end example | |
2862 | ||
c0065db7 | 2863 | A fourth way to avoid this problem is to re-code your |
0d888aac CW |
2864 | library to use a functional interface rather than a data interface |
2865 | for the offending variables (e.g. set_foo() and get_foo() accessor | |
2866 | functions). | |
b044cda1 CW |
2867 | |
2868 | @kindex --disable-auto-import | |
2869 | @item --disable-auto-import | |
c0065db7 | 2870 | Do not attempt to do sophisticated linking of @code{_symbol} to |
b044cda1 | 2871 | @code{__imp__symbol} for DATA imports from DLLs. |
bb10df36 | 2872 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2873 | |
2fa9fc65 NC |
2874 | @kindex --enable-runtime-pseudo-reloc |
2875 | @item --enable-runtime-pseudo-reloc | |
2876 | If your code contains expressions described in --enable-auto-import section, | |
2877 | that is, DATA imports from DLL with non-zero offset, this switch will create | |
2878 | a vector of 'runtime pseudo relocations' which can be used by runtime | |
c0065db7 | 2879 | environment to adjust references to such data in your client code. |
bb10df36 | 2880 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 NC |
2881 | |
2882 | @kindex --disable-runtime-pseudo-reloc | |
2883 | @item --disable-runtime-pseudo-reloc | |
317ff008 | 2884 | Do not create pseudo relocations for non-zero offset DATA imports from DLLs. |
bb10df36 | 2885 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 | 2886 | |
b044cda1 CW |
2887 | @kindex --enable-extra-pe-debug |
2888 | @item --enable-extra-pe-debug | |
2889 | Show additional debug info related to auto-import symbol thunking. | |
bb10df36 | 2890 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 2891 | |
252b5132 RH |
2892 | @kindex --section-alignment |
2893 | @item --section-alignment | |
2894 | Sets the section alignment. Sections in memory will always begin at | |
2895 | addresses which are a multiple of this number. Defaults to 0x1000. | |
bb10df36 | 2896 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2897 | |
2898 | @cindex stack size | |
2899 | @kindex --stack | |
2900 | @item --stack @var{reserve} | |
2901 | @itemx --stack @var{reserve},@var{commit} | |
a00b50c5 | 2902 | Specify the number of bytes of memory to reserve (and optionally commit) |
fe6d7d6a | 2903 | to be used as stack for this program. The default is 2MB reserved, 4K |
252b5132 | 2904 | committed. |
bb10df36 | 2905 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2906 | |
2907 | @kindex --subsystem | |
2908 | @item --subsystem @var{which} | |
2909 | @itemx --subsystem @var{which}:@var{major} | |
2910 | @itemx --subsystem @var{which}:@var{major}.@var{minor} | |
2911 | Specifies the subsystem under which your program will execute. The | |
2912 | legal values for @var{which} are @code{native}, @code{windows}, | |
33f362e1 NC |
2913 | @code{console}, @code{posix}, and @code{xbox}. You may optionally set |
2914 | the subsystem version also. Numeric values are also accepted for | |
2915 | @var{which}. | |
bb10df36 | 2916 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2917 | |
2f563b51 DK |
2918 | The following options set flags in the @code{DllCharacteristics} field |
2919 | of the PE file header: | |
2920 | [These options are specific to PE targeted ports of the linker] | |
2921 | ||
2d5c3743 NC |
2922 | @kindex --high-entropy-va |
2923 | @item --high-entropy-va | |
2924 | Image is compatible with 64-bit address space layout randomization | |
2925 | (ASLR). | |
2926 | ||
2f563b51 DK |
2927 | @kindex --dynamicbase |
2928 | @item --dynamicbase | |
2929 | The image base address may be relocated using address space layout | |
2930 | randomization (ASLR). This feature was introduced with MS Windows | |
2931 | Vista for i386 PE targets. | |
2932 | ||
2933 | @kindex --forceinteg | |
2934 | @item --forceinteg | |
2935 | Code integrity checks are enforced. | |
2936 | ||
2937 | @kindex --nxcompat | |
2938 | @item --nxcompat | |
2939 | The image is compatible with the Data Execution Prevention. | |
2940 | This feature was introduced with MS Windows XP SP2 for i386 PE targets. | |
2941 | ||
2942 | @kindex --no-isolation | |
2943 | @item --no-isolation | |
2944 | Although the image understands isolation, do not isolate the image. | |
2945 | ||
2946 | @kindex --no-seh | |
2947 | @item --no-seh | |
2948 | The image does not use SEH. No SE handler may be called from | |
2949 | this image. | |
2950 | ||
2951 | @kindex --no-bind | |
2952 | @item --no-bind | |
2953 | Do not bind this image. | |
2954 | ||
2955 | @kindex --wdmdriver | |
2956 | @item --wdmdriver | |
2957 | The driver uses the MS Windows Driver Model. | |
9d5777a3 | 2958 | |
2f563b51 DK |
2959 | @kindex --tsaware |
2960 | @item --tsaware | |
2961 | The image is Terminal Server aware. | |
2962 | ||
0cb112f7 CF |
2963 | @kindex --insert-timestamp |
2964 | @item --insert-timestamp | |
eeb14e5a LZ |
2965 | @itemx --no-insert-timestamp |
2966 | Insert a real timestamp into the image. This is the default behaviour | |
2967 | as it matches legacy code and it means that the image will work with | |
2968 | other, proprietary tools. The problem with this default is that it | |
56e6cf80 | 2969 | will result in slightly different images being produced each time the |
eeb14e5a LZ |
2970 | same sources are linked. The option @option{--no-insert-timestamp} |
2971 | can be used to insert a zero value for the timestamp, this ensuring | |
56e6cf80 | 2972 | that binaries produced from identical sources will compare |
eeb14e5a | 2973 | identically. |
252b5132 RH |
2974 | @end table |
2975 | ||
0285c67d NC |
2976 | @c man end |
2977 | ||
ac145307 BS |
2978 | @ifset C6X |
2979 | @subsection Options specific to C6X uClinux targets | |
2980 | ||
2981 | @c man begin OPTIONS | |
2982 | ||
2983 | The C6X uClinux target uses a binary format called DSBT to support shared | |
2984 | libraries. Each shared library in the system needs to have a unique index; | |
2985 | all executables use an index of 0. | |
2986 | ||
2987 | @table @gcctabopt | |
2988 | ||
2989 | @kindex --dsbt-size | |
2990 | @item --dsbt-size @var{size} | |
56e6cf80 | 2991 | This option sets the number of entries in the DSBT of the current executable |
ac145307 BS |
2992 | or shared library to @var{size}. The default is to create a table with 64 |
2993 | entries. | |
2994 | ||
2995 | @kindex --dsbt-index | |
2996 | @item --dsbt-index @var{index} | |
2997 | This option sets the DSBT index of the current executable or shared library | |
2998 | to @var{index}. The default is 0, which is appropriate for generating | |
2999 | executables. If a shared library is generated with a DSBT index of 0, the | |
3000 | @code{R_C6000_DSBT_INDEX} relocs are copied into the output file. | |
3001 | ||
fbd9ad90 PB |
3002 | @kindex --no-merge-exidx-entries |
3003 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent | |
3004 | exidx entries in frame unwind info. | |
3005 | ||
ac145307 BS |
3006 | @end table |
3007 | ||
3008 | @c man end | |
3009 | @end ifset | |
3010 | ||
93fd0973 SC |
3011 | @ifset M68HC11 |
3012 | @subsection Options specific to Motorola 68HC11 and 68HC12 targets | |
3013 | ||
3014 | @c man begin OPTIONS | |
3015 | ||
3016 | The 68HC11 and 68HC12 linkers support specific options to control the | |
3017 | memory bank switching mapping and trampoline code generation. | |
3018 | ||
3019 | @table @gcctabopt | |
3020 | ||
3021 | @kindex --no-trampoline | |
3022 | @item --no-trampoline | |
3023 | This option disables the generation of trampoline. By default a trampoline | |
3024 | is generated for each far function which is called using a @code{jsr} | |
3025 | instruction (this happens when a pointer to a far function is taken). | |
3026 | ||
3027 | @kindex --bank-window | |
3028 | @item --bank-window @var{name} | |
3029 | This option indicates to the linker the name of the memory region in | |
3030 | the @samp{MEMORY} specification that describes the memory bank window. | |
3031 | The definition of such region is then used by the linker to compute | |
3032 | paging and addresses within the memory window. | |
3033 | ||
3034 | @end table | |
3035 | ||
3036 | @c man end | |
3037 | @end ifset | |
3038 | ||
7fb9f789 NC |
3039 | @ifset M68K |
3040 | @subsection Options specific to Motorola 68K target | |
3041 | ||
3042 | @c man begin OPTIONS | |
3043 | ||
3044 | The following options are supported to control handling of GOT generation | |
3045 | when linking for 68K targets. | |
3046 | ||
3047 | @table @gcctabopt | |
3048 | ||
3049 | @kindex --got | |
3050 | @item --got=@var{type} | |
3051 | This option tells the linker which GOT generation scheme to use. | |
3052 | @var{type} should be one of @samp{single}, @samp{negative}, | |
3053 | @samp{multigot} or @samp{target}. For more information refer to the | |
3054 | Info entry for @file{ld}. | |
3055 | ||
3056 | @end table | |
3057 | ||
3058 | @c man end | |
3059 | @end ifset | |
3060 | ||
833794fc MR |
3061 | @ifset MIPS |
3062 | @subsection Options specific to MIPS targets | |
3063 | ||
3064 | @c man begin OPTIONS | |
3065 | ||
3066 | The following options are supported to control microMIPS instruction | |
8b10b0b3 MR |
3067 | generation and branch relocation checks for ISA mode transitions when |
3068 | linking for MIPS targets. | |
833794fc MR |
3069 | |
3070 | @table @gcctabopt | |
3071 | ||
3072 | @kindex --insn32 | |
3073 | @item --insn32 | |
3074 | @kindex --no-insn32 | |
3075 | @itemx --no-insn32 | |
3076 | These options control the choice of microMIPS instructions used in code | |
3077 | generated by the linker, such as that in the PLT or lazy binding stubs, | |
3078 | or in relaxation. If @samp{--insn32} is used, then the linker only uses | |
3079 | 32-bit instruction encodings. By default or if @samp{--no-insn32} is | |
3080 | used, all instruction encodings are used, including 16-bit ones where | |
3081 | possible. | |
3082 | ||
8b10b0b3 MR |
3083 | @kindex --ignore-branch-isa |
3084 | @item --ignore-branch-isa | |
3085 | @kindex --no-ignore-branch-isa | |
3086 | @itemx --no-ignore-branch-isa | |
3087 | These options control branch relocation checks for invalid ISA mode | |
3088 | transitions. If @samp{--ignore-branch-isa} is used, then the linker | |
3089 | accepts any branch relocations and any ISA mode transition required | |
3090 | is lost in relocation calculation, except for some cases of @code{BAL} | |
3091 | instructions which meet relaxation conditions and are converted to | |
3092 | equivalent @code{JALX} instructions as the associated relocation is | |
3093 | calculated. By default or if @samp{--no-ignore-branch-isa} is used | |
3094 | a check is made causing the loss of an ISA mode transition to produce | |
3095 | an error. | |
3096 | ||
833794fc MR |
3097 | @end table |
3098 | ||
3099 | @c man end | |
3100 | @end ifset | |
3101 | ||
252b5132 RH |
3102 | @ifset UsesEnvVars |
3103 | @node Environment | |
3104 | @section Environment Variables | |
3105 | ||
0285c67d NC |
3106 | @c man begin ENVIRONMENT |
3107 | ||
560e09e9 | 3108 | You can change the behaviour of @command{ld} with the environment variables |
36f63dca NC |
3109 | @ifclear SingleFormat |
3110 | @code{GNUTARGET}, | |
3111 | @end ifclear | |
3112 | @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}. | |
252b5132 | 3113 | |
36f63dca | 3114 | @ifclear SingleFormat |
252b5132 RH |
3115 | @kindex GNUTARGET |
3116 | @cindex default input format | |
3117 | @code{GNUTARGET} determines the input-file object format if you don't | |
3118 | use @samp{-b} (or its synonym @samp{--format}). Its value should be one | |
3119 | of the BFD names for an input format (@pxref{BFD}). If there is no | |
ff5dcc92 | 3120 | @code{GNUTARGET} in the environment, @command{ld} uses the natural format |
252b5132 RH |
3121 | of the target. If @code{GNUTARGET} is set to @code{default} then BFD |
3122 | attempts to discover the input format by examining binary input files; | |
3123 | this method often succeeds, but there are potential ambiguities, since | |
3124 | there is no method of ensuring that the magic number used to specify | |
3125 | object-file formats is unique. However, the configuration procedure for | |
3126 | BFD on each system places the conventional format for that system first | |
3127 | in the search-list, so ambiguities are resolved in favor of convention. | |
36f63dca | 3128 | @end ifclear |
252b5132 RH |
3129 | |
3130 | @kindex LDEMULATION | |
3131 | @cindex default emulation | |
3132 | @cindex emulation, default | |
3133 | @code{LDEMULATION} determines the default emulation if you don't use the | |
3134 | @samp{-m} option. The emulation can affect various aspects of linker | |
3135 | behaviour, particularly the default linker script. You can list the | |
3136 | available emulations with the @samp{--verbose} or @samp{-V} options. If | |
3137 | the @samp{-m} option is not used, and the @code{LDEMULATION} environment | |
3138 | variable is not defined, the default emulation depends upon how the | |
3139 | linker was configured. | |
252b5132 RH |
3140 | |
3141 | @kindex COLLECT_NO_DEMANGLE | |
3142 | @cindex demangling, default | |
3143 | Normally, the linker will default to demangling symbols. However, if | |
3144 | @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will | |
3145 | default to not demangling symbols. This environment variable is used in | |
3146 | a similar fashion by the @code{gcc} linker wrapper program. The default | |
3147 | may be overridden by the @samp{--demangle} and @samp{--no-demangle} | |
3148 | options. | |
3149 | ||
0285c67d NC |
3150 | @c man end |
3151 | @end ifset | |
3152 | ||
252b5132 RH |
3153 | @node Scripts |
3154 | @chapter Linker Scripts | |
3155 | ||
3156 | @cindex scripts | |
3157 | @cindex linker scripts | |
3158 | @cindex command files | |
3159 | Every link is controlled by a @dfn{linker script}. This script is | |
3160 | written in the linker command language. | |
3161 | ||
3162 | The main purpose of the linker script is to describe how the sections in | |
3163 | the input files should be mapped into the output file, and to control | |
3164 | the memory layout of the output file. Most linker scripts do nothing | |
3165 | more than this. However, when necessary, the linker script can also | |
3166 | direct the linker to perform many other operations, using the commands | |
3167 | described below. | |
3168 | ||
3169 | The linker always uses a linker script. If you do not supply one | |
3170 | yourself, the linker will use a default script that is compiled into the | |
3171 | linker executable. You can use the @samp{--verbose} command line option | |
3172 | to display the default linker script. Certain command line options, | |
3173 | such as @samp{-r} or @samp{-N}, will affect the default linker script. | |
3174 | ||
3175 | You may supply your own linker script by using the @samp{-T} command | |
3176 | line option. When you do this, your linker script will replace the | |
3177 | default linker script. | |
3178 | ||
3179 | You may also use linker scripts implicitly by naming them as input files | |
3180 | to the linker, as though they were files to be linked. @xref{Implicit | |
3181 | Linker Scripts}. | |
3182 | ||
3183 | @menu | |
3184 | * Basic Script Concepts:: Basic Linker Script Concepts | |
3185 | * Script Format:: Linker Script Format | |
3186 | * Simple Example:: Simple Linker Script Example | |
3187 | * Simple Commands:: Simple Linker Script Commands | |
3188 | * Assignments:: Assigning Values to Symbols | |
3189 | * SECTIONS:: SECTIONS Command | |
3190 | * MEMORY:: MEMORY Command | |
3191 | * PHDRS:: PHDRS Command | |
3192 | * VERSION:: VERSION Command | |
3193 | * Expressions:: Expressions in Linker Scripts | |
3194 | * Implicit Linker Scripts:: Implicit Linker Scripts | |
3195 | @end menu | |
3196 | ||
3197 | @node Basic Script Concepts | |
3198 | @section Basic Linker Script Concepts | |
3199 | @cindex linker script concepts | |
3200 | We need to define some basic concepts and vocabulary in order to | |
3201 | describe the linker script language. | |
3202 | ||
3203 | The linker combines input files into a single output file. The output | |
3204 | file and each input file are in a special data format known as an | |
3205 | @dfn{object file format}. Each file is called an @dfn{object file}. | |
3206 | The output file is often called an @dfn{executable}, but for our | |
3207 | purposes we will also call it an object file. Each object file has, | |
3208 | among other things, a list of @dfn{sections}. We sometimes refer to a | |
3209 | section in an input file as an @dfn{input section}; similarly, a section | |
3210 | in the output file is an @dfn{output section}. | |
3211 | ||
3212 | Each section in an object file has a name and a size. Most sections | |
3213 | also have an associated block of data, known as the @dfn{section | |
56dd11f0 | 3214 | contents}. A section may be marked as @dfn{loadable}, which means that |
252b5132 RH |
3215 | the contents should be loaded into memory when the output file is run. |
3216 | A section with no contents may be @dfn{allocatable}, which means that an | |
3217 | area in memory should be set aside, but nothing in particular should be | |
3218 | loaded there (in some cases this memory must be zeroed out). A section | |
3219 | which is neither loadable nor allocatable typically contains some sort | |
3220 | of debugging information. | |
3221 | ||
3222 | Every loadable or allocatable output section has two addresses. The | |
3223 | first is the @dfn{VMA}, or virtual memory address. This is the address | |
3224 | the section will have when the output file is run. The second is the | |
3225 | @dfn{LMA}, or load memory address. This is the address at which the | |
3226 | section will be loaded. In most cases the two addresses will be the | |
3227 | same. An example of when they might be different is when a data section | |
3228 | is loaded into ROM, and then copied into RAM when the program starts up | |
3229 | (this technique is often used to initialize global variables in a ROM | |
3230 | based system). In this case the ROM address would be the LMA, and the | |
3231 | RAM address would be the VMA. | |
3232 | ||
3233 | You can see the sections in an object file by using the @code{objdump} | |
3234 | program with the @samp{-h} option. | |
3235 | ||
3236 | Every object file also has a list of @dfn{symbols}, known as the | |
3237 | @dfn{symbol table}. A symbol may be defined or undefined. Each symbol | |
3238 | has a name, and each defined symbol has an address, among other | |
3239 | information. If you compile a C or C++ program into an object file, you | |
3240 | will get a defined symbol for every defined function and global or | |
3241 | static variable. Every undefined function or global variable which is | |
3242 | referenced in the input file will become an undefined symbol. | |
3243 | ||
3244 | You can see the symbols in an object file by using the @code{nm} | |
3245 | program, or by using the @code{objdump} program with the @samp{-t} | |
3246 | option. | |
3247 | ||
3248 | @node Script Format | |
3249 | @section Linker Script Format | |
3250 | @cindex linker script format | |
3251 | Linker scripts are text files. | |
3252 | ||
3253 | You write a linker script as a series of commands. Each command is | |
3254 | either a keyword, possibly followed by arguments, or an assignment to a | |
3255 | symbol. You may separate commands using semicolons. Whitespace is | |
3256 | generally ignored. | |
3257 | ||
3258 | Strings such as file or format names can normally be entered directly. | |
3259 | If the file name contains a character such as a comma which would | |
3260 | otherwise serve to separate file names, you may put the file name in | |
3261 | double quotes. There is no way to use a double quote character in a | |
3262 | file name. | |
3263 | ||
3264 | You may include comments in linker scripts just as in C, delimited by | |
3265 | @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent | |
3266 | to whitespace. | |
3267 | ||
3268 | @node Simple Example | |
3269 | @section Simple Linker Script Example | |
3270 | @cindex linker script example | |
3271 | @cindex example of linker script | |
3272 | Many linker scripts are fairly simple. | |
3273 | ||
3274 | The simplest possible linker script has just one command: | |
3275 | @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the | |
3276 | memory layout of the output file. | |
3277 | ||
3278 | The @samp{SECTIONS} command is a powerful command. Here we will | |
3279 | describe a simple use of it. Let's assume your program consists only of | |
3280 | code, initialized data, and uninitialized data. These will be in the | |
3281 | @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively. | |
3282 | Let's assume further that these are the only sections which appear in | |
3283 | your input files. | |
3284 | ||
3285 | For this example, let's say that the code should be loaded at address | |
3286 | 0x10000, and that the data should start at address 0x8000000. Here is a | |
3287 | linker script which will do that: | |
3288 | @smallexample | |
3289 | SECTIONS | |
3290 | @{ | |
3291 | . = 0x10000; | |
3292 | .text : @{ *(.text) @} | |
3293 | . = 0x8000000; | |
3294 | .data : @{ *(.data) @} | |
3295 | .bss : @{ *(.bss) @} | |
3296 | @} | |
3297 | @end smallexample | |
3298 | ||
3299 | You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS}, | |
3300 | followed by a series of symbol assignments and output section | |
3301 | descriptions enclosed in curly braces. | |
3302 | ||
252b5132 RH |
3303 | The first line inside the @samp{SECTIONS} command of the above example |
3304 | sets the value of the special symbol @samp{.}, which is the location | |
3305 | counter. If you do not specify the address of an output section in some | |
3306 | other way (other ways are described later), the address is set from the | |
3307 | current value of the location counter. The location counter is then | |
3308 | incremented by the size of the output section. At the start of the | |
3309 | @samp{SECTIONS} command, the location counter has the value @samp{0}. | |
3310 | ||
3311 | The second line defines an output section, @samp{.text}. The colon is | |
3312 | required syntax which may be ignored for now. Within the curly braces | |
3313 | after the output section name, you list the names of the input sections | |
3314 | which should be placed into this output section. The @samp{*} is a | |
3315 | wildcard which matches any file name. The expression @samp{*(.text)} | |
3316 | means all @samp{.text} input sections in all input files. | |
3317 | ||
3318 | Since the location counter is @samp{0x10000} when the output section | |
3319 | @samp{.text} is defined, the linker will set the address of the | |
3320 | @samp{.text} section in the output file to be @samp{0x10000}. | |
3321 | ||
3322 | The remaining lines define the @samp{.data} and @samp{.bss} sections in | |
3323 | the output file. The linker will place the @samp{.data} output section | |
3324 | at address @samp{0x8000000}. After the linker places the @samp{.data} | |
3325 | output section, the value of the location counter will be | |
3326 | @samp{0x8000000} plus the size of the @samp{.data} output section. The | |
3327 | effect is that the linker will place the @samp{.bss} output section | |
58434bc1 | 3328 | immediately after the @samp{.data} output section in memory. |
252b5132 RH |
3329 | |
3330 | The linker will ensure that each output section has the required | |
3331 | alignment, by increasing the location counter if necessary. In this | |
3332 | example, the specified addresses for the @samp{.text} and @samp{.data} | |
3333 | sections will probably satisfy any alignment constraints, but the linker | |
3334 | may have to create a small gap between the @samp{.data} and @samp{.bss} | |
3335 | sections. | |
3336 | ||
3337 | That's it! That's a simple and complete linker script. | |
3338 | ||
3339 | @node Simple Commands | |
3340 | @section Simple Linker Script Commands | |
3341 | @cindex linker script simple commands | |
3342 | In this section we describe the simple linker script commands. | |
3343 | ||
3344 | @menu | |
3345 | * Entry Point:: Setting the entry point | |
3346 | * File Commands:: Commands dealing with files | |
3347 | @ifclear SingleFormat | |
3348 | * Format Commands:: Commands dealing with object file formats | |
3349 | @end ifclear | |
3350 | ||
4a93e180 | 3351 | * REGION_ALIAS:: Assign alias names to memory regions |
252b5132 RH |
3352 | * Miscellaneous Commands:: Other linker script commands |
3353 | @end menu | |
3354 | ||
3355 | @node Entry Point | |
36f63dca | 3356 | @subsection Setting the Entry Point |
252b5132 RH |
3357 | @kindex ENTRY(@var{symbol}) |
3358 | @cindex start of execution | |
3359 | @cindex first instruction | |
3360 | @cindex entry point | |
3361 | The first instruction to execute in a program is called the @dfn{entry | |
3362 | point}. You can use the @code{ENTRY} linker script command to set the | |
3363 | entry point. The argument is a symbol name: | |
3364 | @smallexample | |
3365 | ENTRY(@var{symbol}) | |
3366 | @end smallexample | |
3367 | ||
3368 | There are several ways to set the entry point. The linker will set the | |
3369 | entry point by trying each of the following methods in order, and | |
3370 | stopping when one of them succeeds: | |
3371 | @itemize @bullet | |
a1ab1d2a | 3372 | @item |
252b5132 | 3373 | the @samp{-e} @var{entry} command-line option; |
a1ab1d2a | 3374 | @item |
252b5132 | 3375 | the @code{ENTRY(@var{symbol})} command in a linker script; |
a1ab1d2a | 3376 | @item |
3ab904c4 NC |
3377 | the value of a target specific symbol, if it is defined; For many |
3378 | targets this is @code{start}, but PE and BeOS based systems for example | |
3379 | check a list of possible entry symbols, matching the first one found. | |
a1ab1d2a | 3380 | @item |
252b5132 | 3381 | the address of the first byte of the @samp{.text} section, if present; |
a1ab1d2a | 3382 | @item |
252b5132 RH |
3383 | The address @code{0}. |
3384 | @end itemize | |
3385 | ||
3386 | @node File Commands | |
36f63dca | 3387 | @subsection Commands Dealing with Files |
252b5132 RH |
3388 | @cindex linker script file commands |
3389 | Several linker script commands deal with files. | |
3390 | ||
3391 | @table @code | |
3392 | @item INCLUDE @var{filename} | |
3393 | @kindex INCLUDE @var{filename} | |
3394 | @cindex including a linker script | |
3395 | Include the linker script @var{filename} at this point. The file will | |
3396 | be searched for in the current directory, and in any directory specified | |
ff5dcc92 | 3397 | with the @option{-L} option. You can nest calls to @code{INCLUDE} up to |
252b5132 RH |
3398 | 10 levels deep. |
3399 | ||
4006703d NS |
3400 | You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or |
3401 | @code{SECTIONS} commands, or in output section descriptions. | |
3402 | ||
252b5132 RH |
3403 | @item INPUT(@var{file}, @var{file}, @dots{}) |
3404 | @itemx INPUT(@var{file} @var{file} @dots{}) | |
3405 | @kindex INPUT(@var{files}) | |
3406 | @cindex input files in linker scripts | |
3407 | @cindex input object files in linker scripts | |
3408 | @cindex linker script input object files | |
3409 | The @code{INPUT} command directs the linker to include the named files | |
3410 | in the link, as though they were named on the command line. | |
3411 | ||
3412 | For example, if you always want to include @file{subr.o} any time you do | |
3413 | a link, but you can't be bothered to put it on every link command line, | |
3414 | then you can put @samp{INPUT (subr.o)} in your linker script. | |
3415 | ||
3416 | In fact, if you like, you can list all of your input files in the linker | |
3417 | script, and then invoke the linker with nothing but a @samp{-T} option. | |
3418 | ||
e3f2db7f AO |
3419 | In case a @dfn{sysroot prefix} is configured, and the filename starts |
3420 | with the @samp{/} character, and the script being processed was | |
3421 | located inside the @dfn{sysroot prefix}, the filename will be looked | |
3422 | for in the @dfn{sysroot prefix}. Otherwise, the linker will try to | |
3423 | open the file in the current directory. If it is not found, the | |
cad60a33 HPN |
3424 | linker will search through the archive library search path. |
3425 | The @dfn{sysroot prefix} can also be forced by specifying @code{=} | |
3aa2d05a NC |
3426 | as the first character in the filename path, or prefixing the filename |
3427 | path with @code{$SYSROOT}. See also the description of @samp{-L} in | |
3428 | @ref{Options,,Command Line Options}. | |
252b5132 | 3429 | |
ff5dcc92 | 3430 | If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the |
252b5132 RH |
3431 | name to @code{lib@var{file}.a}, as with the command line argument |
3432 | @samp{-l}. | |
3433 | ||
3434 | When you use the @code{INPUT} command in an implicit linker script, the | |
3435 | files will be included in the link at the point at which the linker | |
3436 | script file is included. This can affect archive searching. | |
3437 | ||
3438 | @item GROUP(@var{file}, @var{file}, @dots{}) | |
3439 | @itemx GROUP(@var{file} @var{file} @dots{}) | |
3440 | @kindex GROUP(@var{files}) | |
3441 | @cindex grouping input files | |
3442 | The @code{GROUP} command is like @code{INPUT}, except that the named | |
3443 | files should all be archives, and they are searched repeatedly until no | |
3444 | new undefined references are created. See the description of @samp{-(} | |
3445 | in @ref{Options,,Command Line Options}. | |
3446 | ||
b717d30e JJ |
3447 | @item AS_NEEDED(@var{file}, @var{file}, @dots{}) |
3448 | @itemx AS_NEEDED(@var{file} @var{file} @dots{}) | |
3449 | @kindex AS_NEEDED(@var{files}) | |
3450 | This construct can appear only inside of the @code{INPUT} or @code{GROUP} | |
3451 | commands, among other filenames. The files listed will be handled | |
3452 | as if they appear directly in the @code{INPUT} or @code{GROUP} commands, | |
3453 | with the exception of ELF shared libraries, that will be added only | |
3454 | when they are actually needed. This construct essentially enables | |
3455 | @option{--as-needed} option for all the files listed inside of it | |
3456 | and restores previous @option{--as-needed} resp. @option{--no-as-needed} | |
3457 | setting afterwards. | |
3458 | ||
252b5132 RH |
3459 | @item OUTPUT(@var{filename}) |
3460 | @kindex OUTPUT(@var{filename}) | |
b45619c0 | 3461 | @cindex output file name in linker script |
252b5132 RH |
3462 | The @code{OUTPUT} command names the output file. Using |
3463 | @code{OUTPUT(@var{filename})} in the linker script is exactly like using | |
3464 | @samp{-o @var{filename}} on the command line (@pxref{Options,,Command | |
3465 | Line Options}). If both are used, the command line option takes | |
3466 | precedence. | |
3467 | ||
3468 | You can use the @code{OUTPUT} command to define a default name for the | |
3469 | output file other than the usual default of @file{a.out}. | |
3470 | ||
3471 | @item SEARCH_DIR(@var{path}) | |
3472 | @kindex SEARCH_DIR(@var{path}) | |
3473 | @cindex library search path in linker script | |
3474 | @cindex archive search path in linker script | |
3475 | @cindex search path in linker script | |
3476 | The @code{SEARCH_DIR} command adds @var{path} to the list of paths where | |
ff5dcc92 | 3477 | @command{ld} looks for archive libraries. Using |
252b5132 RH |
3478 | @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}} |
3479 | on the command line (@pxref{Options,,Command Line Options}). If both | |
3480 | are used, then the linker will search both paths. Paths specified using | |
3481 | the command line option are searched first. | |
3482 | ||
3483 | @item STARTUP(@var{filename}) | |
3484 | @kindex STARTUP(@var{filename}) | |
3485 | @cindex first input file | |
3486 | The @code{STARTUP} command is just like the @code{INPUT} command, except | |
3487 | that @var{filename} will become the first input file to be linked, as | |
3488 | though it were specified first on the command line. This may be useful | |
3489 | when using a system in which the entry point is always the start of the | |
3490 | first file. | |
3491 | @end table | |
3492 | ||
3493 | @ifclear SingleFormat | |
3494 | @node Format Commands | |
36f63dca | 3495 | @subsection Commands Dealing with Object File Formats |
252b5132 RH |
3496 | A couple of linker script commands deal with object file formats. |
3497 | ||
3498 | @table @code | |
3499 | @item OUTPUT_FORMAT(@var{bfdname}) | |
3500 | @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little}) | |
3501 | @kindex OUTPUT_FORMAT(@var{bfdname}) | |
3502 | @cindex output file format in linker script | |
3503 | The @code{OUTPUT_FORMAT} command names the BFD format to use for the | |
3504 | output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is | |
024531e2 | 3505 | exactly like using @samp{--oformat @var{bfdname}} on the command line |
252b5132 RH |
3506 | (@pxref{Options,,Command Line Options}). If both are used, the command |
3507 | line option takes precedence. | |
3508 | ||
3509 | You can use @code{OUTPUT_FORMAT} with three arguments to use different | |
3510 | formats based on the @samp{-EB} and @samp{-EL} command line options. | |
3511 | This permits the linker script to set the output format based on the | |
3512 | desired endianness. | |
3513 | ||
3514 | If neither @samp{-EB} nor @samp{-EL} are used, then the output format | |
3515 | will be the first argument, @var{default}. If @samp{-EB} is used, the | |
3516 | output format will be the second argument, @var{big}. If @samp{-EL} is | |
3517 | used, the output format will be the third argument, @var{little}. | |
3518 | ||
3519 | For example, the default linker script for the MIPS ELF target uses this | |
3520 | command: | |
3521 | @smallexample | |
3522 | OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips) | |
3523 | @end smallexample | |
3524 | This says that the default format for the output file is | |
3525 | @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command line | |
3526 | option, the output file will be created in the @samp{elf32-littlemips} | |
3527 | format. | |
3528 | ||
3529 | @item TARGET(@var{bfdname}) | |
3530 | @kindex TARGET(@var{bfdname}) | |
3531 | @cindex input file format in linker script | |
3532 | The @code{TARGET} command names the BFD format to use when reading input | |
3533 | files. It affects subsequent @code{INPUT} and @code{GROUP} commands. | |
3534 | This command is like using @samp{-b @var{bfdname}} on the command line | |
3535 | (@pxref{Options,,Command Line Options}). If the @code{TARGET} command | |
3536 | is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET} | |
3537 | command is also used to set the format for the output file. @xref{BFD}. | |
3538 | @end table | |
3539 | @end ifclear | |
3540 | ||
4a93e180 NC |
3541 | @node REGION_ALIAS |
3542 | @subsection Assign alias names to memory regions | |
3543 | @kindex REGION_ALIAS(@var{alias}, @var{region}) | |
3544 | @cindex region alias | |
3545 | @cindex region names | |
3546 | ||
3547 | Alias names can be added to existing memory regions created with the | |
3548 | @ref{MEMORY} command. Each name corresponds to at most one memory region. | |
3549 | ||
3550 | @smallexample | |
3551 | REGION_ALIAS(@var{alias}, @var{region}) | |
3552 | @end smallexample | |
3553 | ||
3554 | The @code{REGION_ALIAS} function creates an alias name @var{alias} for the | |
3555 | memory region @var{region}. This allows a flexible mapping of output sections | |
3556 | to memory regions. An example follows. | |
3557 | ||
3558 | Suppose we have an application for embedded systems which come with various | |
3559 | memory storage devices. All have a general purpose, volatile memory @code{RAM} | |
3560 | that allows code execution or data storage. Some may have a read-only, | |
3561 | non-volatile memory @code{ROM} that allows code execution and read-only data | |
3562 | access. The last variant is a read-only, non-volatile memory @code{ROM2} with | |
3563 | read-only data access and no code execution capability. We have four output | |
3564 | sections: | |
3565 | ||
3566 | @itemize @bullet | |
3567 | @item | |
3568 | @code{.text} program code; | |
3569 | @item | |
3570 | @code{.rodata} read-only data; | |
3571 | @item | |
3572 | @code{.data} read-write initialized data; | |
3573 | @item | |
3574 | @code{.bss} read-write zero initialized data. | |
3575 | @end itemize | |
3576 | ||
3577 | The goal is to provide a linker command file that contains a system independent | |
3578 | part defining the output sections and a system dependent part mapping the | |
3579 | output sections to the memory regions available on the system. Our embedded | |
3580 | systems come with three different memory setups @code{A}, @code{B} and | |
3581 | @code{C}: | |
3582 | @multitable @columnfractions .25 .25 .25 .25 | |
3583 | @item Section @tab Variant A @tab Variant B @tab Variant C | |
9d5777a3 | 3584 | @item .text @tab RAM @tab ROM @tab ROM |
4a93e180 NC |
3585 | @item .rodata @tab RAM @tab ROM @tab ROM2 |
3586 | @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2 | |
3587 | @item .bss @tab RAM @tab RAM @tab RAM | |
3588 | @end multitable | |
3589 | The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is | |
3590 | loaded into region @code{ROM} or @code{ROM2} respectively. Please note that | |
3591 | the load address of the @code{.data} section starts in all three variants at | |
3592 | the end of the @code{.rodata} section. | |
3593 | ||
3594 | The base linker script that deals with the output sections follows. It | |
3595 | includes the system dependent @code{linkcmds.memory} file that describes the | |
3596 | memory layout: | |
3597 | @smallexample | |
3598 | INCLUDE linkcmds.memory | |
3599 | ||
3600 | SECTIONS | |
3601 | @{ | |
3602 | .text : | |
3603 | @{ | |
3604 | *(.text) | |
3605 | @} > REGION_TEXT | |
3606 | .rodata : | |
3607 | @{ | |
3608 | *(.rodata) | |
3609 | rodata_end = .; | |
3610 | @} > REGION_RODATA | |
3611 | .data : AT (rodata_end) | |
3612 | @{ | |
3613 | data_start = .; | |
3614 | *(.data) | |
3615 | @} > REGION_DATA | |
3616 | data_size = SIZEOF(.data); | |
3617 | data_load_start = LOADADDR(.data); | |
3618 | .bss : | |
3619 | @{ | |
3620 | *(.bss) | |
3621 | @} > REGION_BSS | |
3622 | @} | |
3623 | @end smallexample | |
3624 | ||
3625 | Now we need three different @code{linkcmds.memory} files to define memory | |
3626 | regions and alias names. The content of @code{linkcmds.memory} for the three | |
3627 | variants @code{A}, @code{B} and @code{C}: | |
3628 | @table @code | |
3629 | @item A | |
3630 | Here everything goes into the @code{RAM}. | |
3631 | @smallexample | |
3632 | MEMORY | |
3633 | @{ | |
3634 | RAM : ORIGIN = 0, LENGTH = 4M | |
3635 | @} | |
3636 | ||
3637 | REGION_ALIAS("REGION_TEXT", RAM); | |
3638 | REGION_ALIAS("REGION_RODATA", RAM); | |
3639 | REGION_ALIAS("REGION_DATA", RAM); | |
3640 | REGION_ALIAS("REGION_BSS", RAM); | |
3641 | @end smallexample | |
3642 | @item B | |
3643 | Program code and read-only data go into the @code{ROM}. Read-write data goes | |
3644 | into the @code{RAM}. An image of the initialized data is loaded into the | |
3645 | @code{ROM} and will be copied during system start into the @code{RAM}. | |
3646 | @smallexample | |
3647 | MEMORY | |
3648 | @{ | |
3649 | ROM : ORIGIN = 0, LENGTH = 3M | |
3650 | RAM : ORIGIN = 0x10000000, LENGTH = 1M | |
3651 | @} | |
3652 | ||
3653 | REGION_ALIAS("REGION_TEXT", ROM); | |
3654 | REGION_ALIAS("REGION_RODATA", ROM); | |
3655 | REGION_ALIAS("REGION_DATA", RAM); | |
3656 | REGION_ALIAS("REGION_BSS", RAM); | |
3657 | @end smallexample | |
3658 | @item C | |
3659 | Program code goes into the @code{ROM}. Read-only data goes into the | |
3660 | @code{ROM2}. Read-write data goes into the @code{RAM}. An image of the | |
3661 | initialized data is loaded into the @code{ROM2} and will be copied during | |
3662 | system start into the @code{RAM}. | |
3663 | @smallexample | |
3664 | MEMORY | |
3665 | @{ | |
3666 | ROM : ORIGIN = 0, LENGTH = 2M | |
3667 | ROM2 : ORIGIN = 0x10000000, LENGTH = 1M | |
3668 | RAM : ORIGIN = 0x20000000, LENGTH = 1M | |
3669 | @} | |
3670 | ||
3671 | REGION_ALIAS("REGION_TEXT", ROM); | |
3672 | REGION_ALIAS("REGION_RODATA", ROM2); | |
3673 | REGION_ALIAS("REGION_DATA", RAM); | |
3674 | REGION_ALIAS("REGION_BSS", RAM); | |
3675 | @end smallexample | |
3676 | @end table | |
3677 | ||
3678 | It is possible to write a common system initialization routine to copy the | |
3679 | @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if | |
3680 | necessary: | |
3681 | @smallexample | |
3682 | #include <string.h> | |
3683 | ||
3684 | extern char data_start []; | |
3685 | extern char data_size []; | |
3686 | extern char data_load_start []; | |
3687 | ||
3688 | void copy_data(void) | |
3689 | @{ | |
3690 | if (data_start != data_load_start) | |
3691 | @{ | |
3692 | memcpy(data_start, data_load_start, (size_t) data_size); | |
3693 | @} | |
3694 | @} | |
3695 | @end smallexample | |
3696 | ||
252b5132 | 3697 | @node Miscellaneous Commands |
36f63dca | 3698 | @subsection Other Linker Script Commands |
252b5132 RH |
3699 | There are a few other linker scripts commands. |
3700 | ||
3701 | @table @code | |
3702 | @item ASSERT(@var{exp}, @var{message}) | |
3703 | @kindex ASSERT | |
3704 | @cindex assertion in linker script | |
3705 | Ensure that @var{exp} is non-zero. If it is zero, then exit the linker | |
3706 | with an error code, and print @var{message}. | |
3707 | ||
fd1c4238 NC |
3708 | Note that assertions are checked before the final stages of linking |
3709 | take place. This means that expressions involving symbols PROVIDEd | |
3710 | inside section definitions will fail if the user has not set values | |
3711 | for those symbols. The only exception to this rule is PROVIDEd | |
3712 | symbols that just reference dot. Thus an assertion like this: | |
3713 | ||
3714 | @smallexample | |
3715 | .stack : | |
3716 | @{ | |
3717 | PROVIDE (__stack = .); | |
3718 | PROVIDE (__stack_size = 0x100); | |
3719 | ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack"); | |
3720 | @} | |
3721 | @end smallexample | |
3722 | ||
3723 | will fail if @code{__stack_size} is not defined elsewhere. Symbols | |
3724 | PROVIDEd outside of section definitions are evaluated earlier, so they | |
3725 | can be used inside ASSERTions. Thus: | |
3726 | ||
3727 | @smallexample | |
3728 | PROVIDE (__stack_size = 0x100); | |
3729 | .stack : | |
3730 | @{ | |
3731 | PROVIDE (__stack = .); | |
3732 | ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack"); | |
3733 | @} | |
3734 | @end smallexample | |
3735 | ||
3736 | will work. | |
3737 | ||
252b5132 RH |
3738 | @item EXTERN(@var{symbol} @var{symbol} @dots{}) |
3739 | @kindex EXTERN | |
3740 | @cindex undefined symbol in linker script | |
3741 | Force @var{symbol} to be entered in the output file as an undefined | |
3742 | symbol. Doing this may, for example, trigger linking of additional | |
3743 | modules from standard libraries. You may list several @var{symbol}s for | |
3744 | each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This | |
3745 | command has the same effect as the @samp{-u} command-line option. | |
3746 | ||
3747 | @item FORCE_COMMON_ALLOCATION | |
3748 | @kindex FORCE_COMMON_ALLOCATION | |
3749 | @cindex common allocation in linker script | |
3750 | This command has the same effect as the @samp{-d} command-line option: | |
ff5dcc92 | 3751 | to make @command{ld} assign space to common symbols even if a relocatable |
252b5132 RH |
3752 | output file is specified (@samp{-r}). |
3753 | ||
4818e05f AM |
3754 | @item INHIBIT_COMMON_ALLOCATION |
3755 | @kindex INHIBIT_COMMON_ALLOCATION | |
3756 | @cindex common allocation in linker script | |
3757 | This command has the same effect as the @samp{--no-define-common} | |
3758 | command-line option: to make @code{ld} omit the assignment of addresses | |
3759 | to common symbols even for a non-relocatable output file. | |
3760 | ||
7bdf4127 AB |
3761 | @item FORCE_GROUP_ALLOCATION |
3762 | @kindex FORCE_GROUP_ALLOCATION | |
3763 | @cindex group allocation in linker script | |
3764 | @cindex section groups | |
3765 | @cindex COMDAT | |
3766 | This command has the same effect as the | |
3767 | @samp{--force-group-allocation} command-line option: to make | |
3768 | @command{ld} place section group members like normal input sections, | |
3769 | and to delete the section groups even if a relocatable output file is | |
3770 | specified (@samp{-r}). | |
3771 | ||
53d25da6 AM |
3772 | @item INSERT [ AFTER | BEFORE ] @var{output_section} |
3773 | @kindex INSERT | |
3774 | @cindex insert user script into default script | |
3775 | This command is typically used in a script specified by @samp{-T} to | |
3776 | augment the default @code{SECTIONS} with, for example, overlays. It | |
3777 | inserts all prior linker script statements after (or before) | |
3778 | @var{output_section}, and also causes @samp{-T} to not override the | |
3779 | default linker script. The exact insertion point is as for orphan | |
3780 | sections. @xref{Location Counter}. The insertion happens after the | |
3781 | linker has mapped input sections to output sections. Prior to the | |
3782 | insertion, since @samp{-T} scripts are parsed before the default | |
3783 | linker script, statements in the @samp{-T} script occur before the | |
3784 | default linker script statements in the internal linker representation | |
3785 | of the script. In particular, input section assignments will be made | |
3786 | to @samp{-T} output sections before those in the default script. Here | |
3787 | is an example of how a @samp{-T} script using @code{INSERT} might look: | |
3788 | ||
3789 | @smallexample | |
3790 | SECTIONS | |
3791 | @{ | |
3792 | OVERLAY : | |
3793 | @{ | |
3794 | .ov1 @{ ov1*(.text) @} | |
3795 | .ov2 @{ ov2*(.text) @} | |
3796 | @} | |
3797 | @} | |
3798 | INSERT AFTER .text; | |
3799 | @end smallexample | |
3800 | ||
252b5132 RH |
3801 | @item NOCROSSREFS(@var{section} @var{section} @dots{}) |
3802 | @kindex NOCROSSREFS(@var{sections}) | |
3803 | @cindex cross references | |
ff5dcc92 | 3804 | This command may be used to tell @command{ld} to issue an error about any |
252b5132 RH |
3805 | references among certain output sections. |
3806 | ||
3807 | In certain types of programs, particularly on embedded systems when | |
3808 | using overlays, when one section is loaded into memory, another section | |
3809 | will not be. Any direct references between the two sections would be | |
3810 | errors. For example, it would be an error if code in one section called | |
3811 | a function defined in the other section. | |
3812 | ||
3813 | The @code{NOCROSSREFS} command takes a list of output section names. If | |
ff5dcc92 | 3814 | @command{ld} detects any cross references between the sections, it reports |
252b5132 RH |
3815 | an error and returns a non-zero exit status. Note that the |
3816 | @code{NOCROSSREFS} command uses output section names, not input section | |
3817 | names. | |
3818 | ||
cdf96953 MF |
3819 | @item NOCROSSREFS_TO(@var{tosection} @var{fromsection} @dots{}) |
3820 | @kindex NOCROSSREFS_TO(@var{tosection} @var{fromsections}) | |
3821 | @cindex cross references | |
3822 | This command may be used to tell @command{ld} to issue an error about any | |
3823 | references to one section from a list of other sections. | |
3824 | ||
3825 | The @code{NOCROSSREFS} command is useful when ensuring that two or more | |
3826 | output sections are entirely independent but there are situations where | |
3827 | a one-way dependency is needed. For example, in a multi-core application | |
3828 | there may be shared code that can be called from each core but for safety | |
3829 | must never call back. | |
3830 | ||
3831 | The @code{NOCROSSREFS_TO} command takes a list of output section names. | |
3832 | The first section can not be referenced from any of the other sections. | |
3833 | If @command{ld} detects any references to the first section from any of | |
3834 | the other sections, it reports an error and returns a non-zero exit | |
3835 | status. Note that the @code{NOCROSSREFS_TO} command uses output section | |
3836 | names, not input section names. | |
3837 | ||
252b5132 RH |
3838 | @ifclear SingleFormat |
3839 | @item OUTPUT_ARCH(@var{bfdarch}) | |
3840 | @kindex OUTPUT_ARCH(@var{bfdarch}) | |
3841 | @cindex machine architecture | |
3842 | @cindex architecture | |
3843 | Specify a particular output machine architecture. The argument is one | |
3844 | of the names used by the BFD library (@pxref{BFD}). You can see the | |
3845 | architecture of an object file by using the @code{objdump} program with | |
3846 | the @samp{-f} option. | |
3847 | @end ifclear | |
01554a74 AM |
3848 | |
3849 | @item LD_FEATURE(@var{string}) | |
3850 | @kindex LD_FEATURE(@var{string}) | |
3851 | This command may be used to modify @command{ld} behavior. If | |
3852 | @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers | |
3853 | in a script are simply treated as numbers everywhere. | |
3854 | @xref{Expression Section}. | |
252b5132 RH |
3855 | @end table |
3856 | ||
3857 | @node Assignments | |
3858 | @section Assigning Values to Symbols | |
3859 | @cindex assignment in scripts | |
3860 | @cindex symbol definition, scripts | |
3861 | @cindex variables, defining | |
3862 | You may assign a value to a symbol in a linker script. This will define | |
73ae6183 | 3863 | the symbol and place it into the symbol table with a global scope. |
252b5132 RH |
3864 | |
3865 | @menu | |
3866 | * Simple Assignments:: Simple Assignments | |
eb8476a6 | 3867 | * HIDDEN:: HIDDEN |
252b5132 | 3868 | * PROVIDE:: PROVIDE |
7af8e998 | 3869 | * PROVIDE_HIDDEN:: PROVIDE_HIDDEN |
73ae6183 | 3870 | * Source Code Reference:: How to use a linker script defined symbol in source code |
252b5132 RH |
3871 | @end menu |
3872 | ||
3873 | @node Simple Assignments | |
3874 | @subsection Simple Assignments | |
3875 | ||
3876 | You may assign to a symbol using any of the C assignment operators: | |
3877 | ||
3878 | @table @code | |
3879 | @item @var{symbol} = @var{expression} ; | |
3880 | @itemx @var{symbol} += @var{expression} ; | |
3881 | @itemx @var{symbol} -= @var{expression} ; | |
3882 | @itemx @var{symbol} *= @var{expression} ; | |
3883 | @itemx @var{symbol} /= @var{expression} ; | |
3884 | @itemx @var{symbol} <<= @var{expression} ; | |
3885 | @itemx @var{symbol} >>= @var{expression} ; | |
3886 | @itemx @var{symbol} &= @var{expression} ; | |
3887 | @itemx @var{symbol} |= @var{expression} ; | |
3888 | @end table | |
3889 | ||
3890 | The first case will define @var{symbol} to the value of | |
3891 | @var{expression}. In the other cases, @var{symbol} must already be | |
3892 | defined, and the value will be adjusted accordingly. | |
3893 | ||
3894 | The special symbol name @samp{.} indicates the location counter. You | |
b5666f2f | 3895 | may only use this within a @code{SECTIONS} command. @xref{Location Counter}. |
252b5132 RH |
3896 | |
3897 | The semicolon after @var{expression} is required. | |
3898 | ||
3899 | Expressions are defined below; see @ref{Expressions}. | |
3900 | ||
3901 | You may write symbol assignments as commands in their own right, or as | |
3902 | statements within a @code{SECTIONS} command, or as part of an output | |
3903 | section description in a @code{SECTIONS} command. | |
3904 | ||
3905 | The section of the symbol will be set from the section of the | |
3906 | expression; for more information, see @ref{Expression Section}. | |
3907 | ||
3908 | Here is an example showing the three different places that symbol | |
3909 | assignments may be used: | |
3910 | ||
3911 | @smallexample | |
3912 | floating_point = 0; | |
3913 | SECTIONS | |
3914 | @{ | |
3915 | .text : | |
3916 | @{ | |
3917 | *(.text) | |
3918 | _etext = .; | |
3919 | @} | |
156e34dd | 3920 | _bdata = (. + 3) & ~ 3; |
252b5132 RH |
3921 | .data : @{ *(.data) @} |
3922 | @} | |
3923 | @end smallexample | |
3924 | @noindent | |
3925 | In this example, the symbol @samp{floating_point} will be defined as | |
3926 | zero. The symbol @samp{_etext} will be defined as the address following | |
3927 | the last @samp{.text} input section. The symbol @samp{_bdata} will be | |
3928 | defined as the address following the @samp{.text} output section aligned | |
3929 | upward to a 4 byte boundary. | |
3930 | ||
eb8476a6 MR |
3931 | @node HIDDEN |
3932 | @subsection HIDDEN | |
3933 | @cindex HIDDEN | |
3934 | For ELF targeted ports, define a symbol that will be hidden and won't be | |
3935 | exported. The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}. | |
3936 | ||
3937 | Here is the example from @ref{Simple Assignments}, rewritten to use | |
3938 | @code{HIDDEN}: | |
3939 | ||
3940 | @smallexample | |
3941 | HIDDEN(floating_point = 0); | |
3942 | SECTIONS | |
3943 | @{ | |
3944 | .text : | |
3945 | @{ | |
3946 | *(.text) | |
3947 | HIDDEN(_etext = .); | |
3948 | @} | |
3949 | HIDDEN(_bdata = (. + 3) & ~ 3); | |
3950 | .data : @{ *(.data) @} | |
3951 | @} | |
3952 | @end smallexample | |
3953 | @noindent | |
3954 | In this case none of the three symbols will be visible outside this module. | |
3955 | ||
252b5132 RH |
3956 | @node PROVIDE |
3957 | @subsection PROVIDE | |
3958 | @cindex PROVIDE | |
3959 | In some cases, it is desirable for a linker script to define a symbol | |
3960 | only if it is referenced and is not defined by any object included in | |
3961 | the link. For example, traditional linkers defined the symbol | |
3962 | @samp{etext}. However, ANSI C requires that the user be able to use | |
3963 | @samp{etext} as a function name without encountering an error. The | |
3964 | @code{PROVIDE} keyword may be used to define a symbol, such as | |
3965 | @samp{etext}, only if it is referenced but not defined. The syntax is | |
3966 | @code{PROVIDE(@var{symbol} = @var{expression})}. | |
3967 | ||
3968 | Here is an example of using @code{PROVIDE} to define @samp{etext}: | |
3969 | @smallexample | |
3970 | SECTIONS | |
3971 | @{ | |
3972 | .text : | |
3973 | @{ | |
3974 | *(.text) | |
3975 | _etext = .; | |
3976 | PROVIDE(etext = .); | |
3977 | @} | |
3978 | @} | |
3979 | @end smallexample | |
3980 | ||
3981 | In this example, if the program defines @samp{_etext} (with a leading | |
3982 | underscore), the linker will give a multiple definition error. If, on | |
3983 | the other hand, the program defines @samp{etext} (with no leading | |
3984 | underscore), the linker will silently use the definition in the program. | |
3985 | If the program references @samp{etext} but does not define it, the | |
3986 | linker will use the definition in the linker script. | |
3987 | ||
b0daac83 NC |
3988 | Note - the @code{PROVIDE} directive considers a common symbol to be |
3989 | defined, even though such a symbol could be combined with the symbol | |
3990 | that the @code{PROVIDE} would create. This is particularly important | |
3991 | when considering constructor and destructor list symbols such as | |
3992 | @samp{__CTOR_LIST__} as these are often defined as common symbols. | |
3993 | ||
7af8e998 L |
3994 | @node PROVIDE_HIDDEN |
3995 | @subsection PROVIDE_HIDDEN | |
3996 | @cindex PROVIDE_HIDDEN | |
3997 | Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be | |
3998 | hidden and won't be exported. | |
3999 | ||
73ae6183 NC |
4000 | @node Source Code Reference |
4001 | @subsection Source Code Reference | |
4002 | ||
4003 | Accessing a linker script defined variable from source code is not | |
4004 | intuitive. In particular a linker script symbol is not equivalent to | |
4005 | a variable declaration in a high level language, it is instead a | |
4006 | symbol that does not have a value. | |
4007 | ||
4008 | Before going further, it is important to note that compilers often | |
4009 | transform names in the source code into different names when they are | |
4010 | stored in the symbol table. For example, Fortran compilers commonly | |
4011 | prepend or append an underscore, and C++ performs extensive @samp{name | |
4012 | mangling}. Therefore there might be a discrepancy between the name | |
4013 | of a variable as it is used in source code and the name of the same | |
4014 | variable as it is defined in a linker script. For example in C a | |
4015 | linker script variable might be referred to as: | |
4016 | ||
4017 | @smallexample | |
4018 | extern int foo; | |
4019 | @end smallexample | |
4020 | ||
4021 | But in the linker script it might be defined as: | |
4022 | ||
4023 | @smallexample | |
4024 | _foo = 1000; | |
4025 | @end smallexample | |
4026 | ||
4027 | In the remaining examples however it is assumed that no name | |
4028 | transformation has taken place. | |
4029 | ||
4030 | When a symbol is declared in a high level language such as C, two | |
4031 | things happen. The first is that the compiler reserves enough space | |
4032 | in the program's memory to hold the @emph{value} of the symbol. The | |
4033 | second is that the compiler creates an entry in the program's symbol | |
4034 | table which holds the symbol's @emph{address}. ie the symbol table | |
4035 | contains the address of the block of memory holding the symbol's | |
4036 | value. So for example the following C declaration, at file scope: | |
4037 | ||
4038 | @smallexample | |
4039 | int foo = 1000; | |
4040 | @end smallexample | |
4041 | ||
10bf6894 | 4042 | creates an entry called @samp{foo} in the symbol table. This entry |
73ae6183 NC |
4043 | holds the address of an @samp{int} sized block of memory where the |
4044 | number 1000 is initially stored. | |
4045 | ||
4046 | When a program references a symbol the compiler generates code that | |
4047 | first accesses the symbol table to find the address of the symbol's | |
4048 | memory block and then code to read the value from that memory block. | |
4049 | So: | |
4050 | ||
4051 | @smallexample | |
4052 | foo = 1; | |
4053 | @end smallexample | |
4054 | ||
4055 | looks up the symbol @samp{foo} in the symbol table, gets the address | |
4056 | associated with this symbol and then writes the value 1 into that | |
4057 | address. Whereas: | |
4058 | ||
4059 | @smallexample | |
4060 | int * a = & foo; | |
4061 | @end smallexample | |
4062 | ||
10bf6894 | 4063 | looks up the symbol @samp{foo} in the symbol table, gets its address |
73ae6183 NC |
4064 | and then copies this address into the block of memory associated with |
4065 | the variable @samp{a}. | |
4066 | ||
4067 | Linker scripts symbol declarations, by contrast, create an entry in | |
4068 | the symbol table but do not assign any memory to them. Thus they are | |
4069 | an address without a value. So for example the linker script definition: | |
4070 | ||
4071 | @smallexample | |
4072 | foo = 1000; | |
4073 | @end smallexample | |
4074 | ||
4075 | creates an entry in the symbol table called @samp{foo} which holds | |
4076 | the address of memory location 1000, but nothing special is stored at | |
4077 | address 1000. This means that you cannot access the @emph{value} of a | |
4078 | linker script defined symbol - it has no value - all you can do is | |
4079 | access the @emph{address} of a linker script defined symbol. | |
4080 | ||
4081 | Hence when you are using a linker script defined symbol in source code | |
4082 | you should always take the address of the symbol, and never attempt to | |
4083 | use its value. For example suppose you want to copy the contents of a | |
4084 | section of memory called .ROM into a section called .FLASH and the | |
4085 | linker script contains these declarations: | |
4086 | ||
4087 | @smallexample | |
4088 | @group | |
4089 | start_of_ROM = .ROM; | |
a5e406b5 | 4090 | end_of_ROM = .ROM + sizeof (.ROM); |
73ae6183 NC |
4091 | start_of_FLASH = .FLASH; |
4092 | @end group | |
4093 | @end smallexample | |
4094 | ||
4095 | Then the C source code to perform the copy would be: | |
4096 | ||
4097 | @smallexample | |
4098 | @group | |
4099 | extern char start_of_ROM, end_of_ROM, start_of_FLASH; | |
c0065db7 | 4100 | |
73ae6183 NC |
4101 | memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM); |
4102 | @end group | |
4103 | @end smallexample | |
4104 | ||
4105 | Note the use of the @samp{&} operators. These are correct. | |
5707d2ad NC |
4106 | Alternatively the symbols can be treated as the names of vectors or |
4107 | arrays and then the code will again work as expected: | |
4108 | ||
4109 | @smallexample | |
4110 | @group | |
4111 | extern char start_of_ROM[], end_of_ROM[], start_of_FLASH[]; | |
4112 | ||
4113 | memcpy (start_of_FLASH, start_of_ROM, end_of_ROM - start_of_ROM); | |
4114 | @end group | |
4115 | @end smallexample | |
4116 | ||
4117 | Note how using this method does not require the use of @samp{&} | |
4118 | operators. | |
73ae6183 | 4119 | |
252b5132 | 4120 | @node SECTIONS |
36f63dca | 4121 | @section SECTIONS Command |
252b5132 RH |
4122 | @kindex SECTIONS |
4123 | The @code{SECTIONS} command tells the linker how to map input sections | |
4124 | into output sections, and how to place the output sections in memory. | |
4125 | ||
4126 | The format of the @code{SECTIONS} command is: | |
4127 | @smallexample | |
4128 | SECTIONS | |
4129 | @{ | |
4130 | @var{sections-command} | |
4131 | @var{sections-command} | |
4132 | @dots{} | |
4133 | @} | |
4134 | @end smallexample | |
4135 | ||
4136 | Each @var{sections-command} may of be one of the following: | |
4137 | ||
4138 | @itemize @bullet | |
4139 | @item | |
4140 | an @code{ENTRY} command (@pxref{Entry Point,,Entry command}) | |
4141 | @item | |
4142 | a symbol assignment (@pxref{Assignments}) | |
4143 | @item | |
4144 | an output section description | |
4145 | @item | |
4146 | an overlay description | |
4147 | @end itemize | |
4148 | ||
4149 | The @code{ENTRY} command and symbol assignments are permitted inside the | |
4150 | @code{SECTIONS} command for convenience in using the location counter in | |
4151 | those commands. This can also make the linker script easier to | |
4152 | understand because you can use those commands at meaningful points in | |
4153 | the layout of the output file. | |
4154 | ||
4155 | Output section descriptions and overlay descriptions are described | |
4156 | below. | |
4157 | ||
4158 | If you do not use a @code{SECTIONS} command in your linker script, the | |
4159 | linker will place each input section into an identically named output | |
4160 | section in the order that the sections are first encountered in the | |
4161 | input files. If all input sections are present in the first file, for | |
4162 | example, the order of sections in the output file will match the order | |
4163 | in the first input file. The first section will be at address zero. | |
4164 | ||
4165 | @menu | |
4166 | * Output Section Description:: Output section description | |
4167 | * Output Section Name:: Output section name | |
4168 | * Output Section Address:: Output section address | |
4169 | * Input Section:: Input section description | |
4170 | * Output Section Data:: Output section data | |
4171 | * Output Section Keywords:: Output section keywords | |
4172 | * Output Section Discarding:: Output section discarding | |
4173 | * Output Section Attributes:: Output section attributes | |
4174 | * Overlay Description:: Overlay description | |
4175 | @end menu | |
4176 | ||
4177 | @node Output Section Description | |
36f63dca | 4178 | @subsection Output Section Description |
252b5132 RH |
4179 | The full description of an output section looks like this: |
4180 | @smallexample | |
a1ab1d2a | 4181 | @group |
7e7d5768 | 4182 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 | 4183 | [AT(@var{lma})] |
1eec346e | 4184 | [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT] |
0c71d759 NC |
4185 | [SUBALIGN(@var{subsection_align})] |
4186 | [@var{constraint}] | |
252b5132 RH |
4187 | @{ |
4188 | @var{output-section-command} | |
4189 | @var{output-section-command} | |
4190 | @dots{} | |
abc9061b | 4191 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] [,] |
252b5132 RH |
4192 | @end group |
4193 | @end smallexample | |
4194 | ||
4195 | Most output sections do not use most of the optional section attributes. | |
4196 | ||
4197 | The whitespace around @var{section} is required, so that the section | |
4198 | name is unambiguous. The colon and the curly braces are also required. | |
abc9061b CC |
4199 | The comma at the end may be required if a @var{fillexp} is used and |
4200 | the next @var{sections-command} looks like a continuation of the expression. | |
252b5132 RH |
4201 | The line breaks and other white space are optional. |
4202 | ||
4203 | Each @var{output-section-command} may be one of the following: | |
4204 | ||
4205 | @itemize @bullet | |
4206 | @item | |
4207 | a symbol assignment (@pxref{Assignments}) | |
4208 | @item | |
4209 | an input section description (@pxref{Input Section}) | |
4210 | @item | |
4211 | data values to include directly (@pxref{Output Section Data}) | |
4212 | @item | |
4213 | a special output section keyword (@pxref{Output Section Keywords}) | |
4214 | @end itemize | |
4215 | ||
4216 | @node Output Section Name | |
36f63dca | 4217 | @subsection Output Section Name |
252b5132 RH |
4218 | @cindex name, section |
4219 | @cindex section name | |
4220 | The name of the output section is @var{section}. @var{section} must | |
4221 | meet the constraints of your output format. In formats which only | |
4222 | support a limited number of sections, such as @code{a.out}, the name | |
4223 | must be one of the names supported by the format (@code{a.out}, for | |
4224 | example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the | |
4225 | output format supports any number of sections, but with numbers and not | |
4226 | names (as is the case for Oasys), the name should be supplied as a | |
4227 | quoted numeric string. A section name may consist of any sequence of | |
4228 | characters, but a name which contains any unusual characters such as | |
4229 | commas must be quoted. | |
4230 | ||
4231 | The output section name @samp{/DISCARD/} is special; @ref{Output Section | |
4232 | Discarding}. | |
4233 | ||
4234 | @node Output Section Address | |
2a16d82a | 4235 | @subsection Output Section Address |
252b5132 RH |
4236 | @cindex address, section |
4237 | @cindex section address | |
4238 | The @var{address} is an expression for the VMA (the virtual memory | |
ea5cae92 NC |
4239 | address) of the output section. This address is optional, but if it |
4240 | is provided then the output address will be set exactly as specified. | |
4241 | ||
4242 | If the output address is not specified then one will be chosen for the | |
4243 | section, based on the heuristic below. This address will be adjusted | |
4244 | to fit the alignment requirement of the output section. The | |
4245 | alignment requirement is the strictest alignment of any input section | |
4246 | contained within the output section. | |
4247 | ||
4248 | The output section address heuristic is as follows: | |
4249 | ||
4250 | @itemize @bullet | |
4251 | @item | |
4252 | If an output memory @var{region} is set for the section then it | |
4253 | is added to this region and its address will be the next free address | |
4254 | in that region. | |
4255 | ||
4256 | @item | |
4257 | If the MEMORY command has been used to create a list of memory | |
4258 | regions then the first region which has attributes compatible with the | |
4259 | section is selected to contain it. The section's output address will | |
4260 | be the next free address in that region; @ref{MEMORY}. | |
4261 | ||
4262 | @item | |
4263 | If no memory regions were specified, or none match the section then | |
4264 | the output address will be based on the current value of the location | |
4265 | counter. | |
4266 | @end itemize | |
4267 | ||
4268 | @noindent | |
4269 | For example: | |
4270 | ||
252b5132 RH |
4271 | @smallexample |
4272 | .text . : @{ *(.text) @} | |
4273 | @end smallexample | |
ea5cae92 | 4274 | |
252b5132 RH |
4275 | @noindent |
4276 | and | |
ea5cae92 | 4277 | |
252b5132 RH |
4278 | @smallexample |
4279 | .text : @{ *(.text) @} | |
4280 | @end smallexample | |
ea5cae92 | 4281 | |
252b5132 RH |
4282 | @noindent |
4283 | are subtly different. The first will set the address of the | |
4284 | @samp{.text} output section to the current value of the location | |
4285 | counter. The second will set it to the current value of the location | |
ea5cae92 NC |
4286 | counter aligned to the strictest alignment of any of the @samp{.text} |
4287 | input sections. | |
252b5132 RH |
4288 | |
4289 | The @var{address} may be an arbitrary expression; @ref{Expressions}. | |
4290 | For example, if you want to align the section on a 0x10 byte boundary, | |
4291 | so that the lowest four bits of the section address are zero, you could | |
4292 | do something like this: | |
4293 | @smallexample | |
4294 | .text ALIGN(0x10) : @{ *(.text) @} | |
4295 | @end smallexample | |
4296 | @noindent | |
4297 | This works because @code{ALIGN} returns the current location counter | |
4298 | aligned upward to the specified value. | |
4299 | ||
4300 | Specifying @var{address} for a section will change the value of the | |
6ce340f1 NC |
4301 | location counter, provided that the section is non-empty. (Empty |
4302 | sections are ignored). | |
252b5132 RH |
4303 | |
4304 | @node Input Section | |
36f63dca | 4305 | @subsection Input Section Description |
252b5132 RH |
4306 | @cindex input sections |
4307 | @cindex mapping input sections to output sections | |
4308 | The most common output section command is an input section description. | |
4309 | ||
4310 | The input section description is the most basic linker script operation. | |
4311 | You use output sections to tell the linker how to lay out your program | |
4312 | in memory. You use input section descriptions to tell the linker how to | |
4313 | map the input files into your memory layout. | |
4314 | ||
4315 | @menu | |
4316 | * Input Section Basics:: Input section basics | |
4317 | * Input Section Wildcards:: Input section wildcard patterns | |
4318 | * Input Section Common:: Input section for common symbols | |
4319 | * Input Section Keep:: Input section and garbage collection | |
4320 | * Input Section Example:: Input section example | |
4321 | @end menu | |
4322 | ||
4323 | @node Input Section Basics | |
36f63dca | 4324 | @subsubsection Input Section Basics |
252b5132 RH |
4325 | @cindex input section basics |
4326 | An input section description consists of a file name optionally followed | |
4327 | by a list of section names in parentheses. | |
4328 | ||
4329 | The file name and the section name may be wildcard patterns, which we | |
4330 | describe further below (@pxref{Input Section Wildcards}). | |
4331 | ||
4332 | The most common input section description is to include all input | |
4333 | sections with a particular name in the output section. For example, to | |
4334 | include all input @samp{.text} sections, you would write: | |
4335 | @smallexample | |
4336 | *(.text) | |
4337 | @end smallexample | |
4338 | @noindent | |
18625d54 | 4339 | Here the @samp{*} is a wildcard which matches any file name. To exclude a list |
8f1732fc | 4340 | @cindex EXCLUDE_FILE |
18625d54 CM |
4341 | of files from matching the file name wildcard, EXCLUDE_FILE may be used to |
4342 | match all files except the ones specified in the EXCLUDE_FILE list. For | |
4343 | example: | |
252b5132 | 4344 | @smallexample |
8f1732fc AB |
4345 | EXCLUDE_FILE (*crtend.o *otherfile.o) *(.ctors) |
4346 | @end smallexample | |
4347 | @noindent | |
4348 | will cause all .ctors sections from all files except @file{crtend.o} | |
4349 | and @file{otherfile.o} to be included. The EXCLUDE_FILE can also be | |
4350 | placed inside the section list, for example: | |
4351 | @smallexample | |
b4346c09 | 4352 | *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors) |
252b5132 | 4353 | @end smallexample |
8f1732fc AB |
4354 | @noindent |
4355 | The result of this is identically to the previous example. Supporting | |
4356 | two syntaxes for EXCLUDE_FILE is useful if the section list contains | |
4357 | more than one section, as described below. | |
252b5132 RH |
4358 | |
4359 | There are two ways to include more than one section: | |
4360 | @smallexample | |
4361 | *(.text .rdata) | |
4362 | *(.text) *(.rdata) | |
4363 | @end smallexample | |
4364 | @noindent | |
4365 | The difference between these is the order in which the @samp{.text} and | |
4366 | @samp{.rdata} input sections will appear in the output section. In the | |
b6bf44ba AM |
4367 | first example, they will be intermingled, appearing in the same order as |
4368 | they are found in the linker input. In the second example, all | |
252b5132 RH |
4369 | @samp{.text} input sections will appear first, followed by all |
4370 | @samp{.rdata} input sections. | |
4371 | ||
8f1732fc AB |
4372 | When using EXCLUDE_FILE with more than one section, if the exclusion |
4373 | is within the section list then the exclusion only applies to the | |
4374 | immediately following section, for example: | |
a5bf7d4f AB |
4375 | @smallexample |
4376 | *(EXCLUDE_FILE (*somefile.o) .text .rdata) | |
4377 | @end smallexample | |
4378 | @noindent | |
4379 | will cause all @samp{.text} sections from all files except | |
4380 | @file{somefile.o} to be included, while all @samp{.rdata} sections | |
4381 | from all files, including @file{somefile.o}, will be included. To | |
4382 | exclude the @samp{.rdata} sections from @file{somefile.o} the example | |
8f1732fc | 4383 | could be modified to: |
a5bf7d4f AB |
4384 | @smallexample |
4385 | *(EXCLUDE_FILE (*somefile.o) .text EXCLUDE_FILE (*somefile.o) .rdata) | |
4386 | @end smallexample | |
8f1732fc AB |
4387 | @noindent |
4388 | Alternatively, placing the EXCLUDE_FILE outside of the section list, | |
4389 | before the input file selection, will cause the exclusion to apply for | |
4390 | all sections. Thus the previous example can be rewritten as: | |
4391 | @smallexample | |
4392 | EXCLUDE_FILE (*somefile.o) *(.text .rdata) | |
4393 | @end smallexample | |
a5bf7d4f | 4394 | |
252b5132 RH |
4395 | You can specify a file name to include sections from a particular file. |
4396 | You would do this if one or more of your files contain special data that | |
4397 | needs to be at a particular location in memory. For example: | |
4398 | @smallexample | |
4399 | data.o(.data) | |
4400 | @end smallexample | |
4401 | ||
ae17ab41 CM |
4402 | To refine the sections that are included based on the section flags |
4403 | of an input section, INPUT_SECTION_FLAGS may be used. | |
4404 | ||
4405 | Here is a simple example for using Section header flags for ELF sections: | |
4406 | ||
4407 | @smallexample | |
4408 | @group | |
4409 | SECTIONS @{ | |
4410 | .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @} | |
4411 | .text2 : @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @} | |
4412 | @} | |
4413 | @end group | |
4414 | @end smallexample | |
4415 | ||
4416 | In this example, the output section @samp{.text} will be comprised of any | |
4417 | input section matching the name *(.text) whose section header flags | |
4418 | @code{SHF_MERGE} and @code{SHF_STRINGS} are set. The output section | |
4419 | @samp{.text2} will be comprised of any input section matching the name *(.text) | |
4420 | whose section header flag @code{SHF_WRITE} is clear. | |
4421 | ||
967928e9 AM |
4422 | You can also specify files within archives by writing a pattern |
4423 | matching the archive, a colon, then the pattern matching the file, | |
4424 | with no whitespace around the colon. | |
4425 | ||
4426 | @table @samp | |
4427 | @item archive:file | |
4428 | matches file within archive | |
4429 | @item archive: | |
4430 | matches the whole archive | |
4431 | @item :file | |
4432 | matches file but not one in an archive | |
4433 | @end table | |
4434 | ||
4435 | Either one or both of @samp{archive} and @samp{file} can contain shell | |
4436 | wildcards. On DOS based file systems, the linker will assume that a | |
4437 | single letter followed by a colon is a drive specifier, so | |
4438 | @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o} | |
4439 | within an archive called @samp{c}. @samp{archive:file} filespecs may | |
4440 | also be used within an @code{EXCLUDE_FILE} list, but may not appear in | |
4441 | other linker script contexts. For instance, you cannot extract a file | |
4442 | from an archive by using @samp{archive:file} in an @code{INPUT} | |
4443 | command. | |
4444 | ||
252b5132 RH |
4445 | If you use a file name without a list of sections, then all sections in |
4446 | the input file will be included in the output section. This is not | |
4447 | commonly done, but it may by useful on occasion. For example: | |
4448 | @smallexample | |
4449 | data.o | |
4450 | @end smallexample | |
4451 | ||
967928e9 AM |
4452 | When you use a file name which is not an @samp{archive:file} specifier |
4453 | and does not contain any wild card | |
252b5132 RH |
4454 | characters, the linker will first see if you also specified the file |
4455 | name on the linker command line or in an @code{INPUT} command. If you | |
4456 | did not, the linker will attempt to open the file as an input file, as | |
4457 | though it appeared on the command line. Note that this differs from an | |
4458 | @code{INPUT} command, because the linker will not search for the file in | |
4459 | the archive search path. | |
4460 | ||
4461 | @node Input Section Wildcards | |
36f63dca | 4462 | @subsubsection Input Section Wildcard Patterns |
252b5132 RH |
4463 | @cindex input section wildcards |
4464 | @cindex wildcard file name patterns | |
4465 | @cindex file name wildcard patterns | |
4466 | @cindex section name wildcard patterns | |
4467 | In an input section description, either the file name or the section | |
4468 | name or both may be wildcard patterns. | |
4469 | ||
4470 | The file name of @samp{*} seen in many examples is a simple wildcard | |
4471 | pattern for the file name. | |
4472 | ||
4473 | The wildcard patterns are like those used by the Unix shell. | |
4474 | ||
4475 | @table @samp | |
4476 | @item * | |
4477 | matches any number of characters | |
4478 | @item ? | |
4479 | matches any single character | |
4480 | @item [@var{chars}] | |
4481 | matches a single instance of any of the @var{chars}; the @samp{-} | |
4482 | character may be used to specify a range of characters, as in | |
4483 | @samp{[a-z]} to match any lower case letter | |
4484 | @item \ | |
4485 | quotes the following character | |
4486 | @end table | |
4487 | ||
4488 | When a file name is matched with a wildcard, the wildcard characters | |
4489 | will not match a @samp{/} character (used to separate directory names on | |
4490 | Unix). A pattern consisting of a single @samp{*} character is an | |
4491 | exception; it will always match any file name, whether it contains a | |
4492 | @samp{/} or not. In a section name, the wildcard characters will match | |
4493 | a @samp{/} character. | |
4494 | ||
4495 | File name wildcard patterns only match files which are explicitly | |
4496 | specified on the command line or in an @code{INPUT} command. The linker | |
4497 | does not search directories to expand wildcards. | |
4498 | ||
4499 | If a file name matches more than one wildcard pattern, or if a file name | |
4500 | appears explicitly and is also matched by a wildcard pattern, the linker | |
4501 | will use the first match in the linker script. For example, this | |
4502 | sequence of input section descriptions is probably in error, because the | |
4503 | @file{data.o} rule will not be used: | |
4504 | @smallexample | |
4505 | .data : @{ *(.data) @} | |
4506 | .data1 : @{ data.o(.data) @} | |
4507 | @end smallexample | |
4508 | ||
bcaa7b3e | 4509 | @cindex SORT_BY_NAME |
252b5132 RH |
4510 | Normally, the linker will place files and sections matched by wildcards |
4511 | in the order in which they are seen during the link. You can change | |
bcaa7b3e L |
4512 | this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard |
4513 | pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the | |
4514 | @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections | |
252b5132 RH |
4515 | into ascending order by name before placing them in the output file. |
4516 | ||
bcaa7b3e L |
4517 | @cindex SORT_BY_ALIGNMENT |
4518 | @code{SORT_BY_ALIGNMENT} is very similar to @code{SORT_BY_NAME}. The | |
4519 | difference is @code{SORT_BY_ALIGNMENT} will sort sections into | |
1ae5c3ae | 4520 | descending order by alignment before placing them in the output file. |
ee83b8a6 NC |
4521 | Larger alignments are placed before smaller alignments in order to |
4522 | reduce the amount of padding necessary. | |
bcaa7b3e | 4523 | |
02ecc8e9 L |
4524 | @cindex SORT_BY_INIT_PRIORITY |
4525 | @code{SORT_BY_INIT_PRIORITY} is very similar to @code{SORT_BY_NAME}. The | |
4526 | difference is @code{SORT_BY_INIT_PRIORITY} will sort sections into | |
4527 | ascending order by numerical value of the GCC init_priority attribute | |
4528 | encoded in the section name before placing them in the output file. | |
4529 | ||
bcaa7b3e L |
4530 | @cindex SORT |
4531 | @code{SORT} is an alias for @code{SORT_BY_NAME}. | |
4532 | ||
4533 | When there are nested section sorting commands in linker script, there | |
4534 | can be at most 1 level of nesting for section sorting commands. | |
4535 | ||
4536 | @enumerate | |
4537 | @item | |
4538 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
1ae5c3ae | 4539 | It will sort the input sections by name first, then by alignment if two |
bcaa7b3e L |
4540 | sections have the same name. |
4541 | @item | |
4542 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
1ae5c3ae | 4543 | It will sort the input sections by alignment first, then by name if two |
bcaa7b3e L |
4544 | sections have the same alignment. |
4545 | @item | |
c0065db7 | 4546 | @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is |
bcaa7b3e L |
4547 | treated the same as @code{SORT_BY_NAME} (wildcard section pattern). |
4548 | @item | |
4549 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)) | |
4550 | is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern). | |
4551 | @item | |
4552 | All other nested section sorting commands are invalid. | |
4553 | @end enumerate | |
4554 | ||
4555 | When both command line section sorting option and linker script | |
4556 | section sorting command are used, section sorting command always | |
4557 | takes precedence over the command line option. | |
4558 | ||
4559 | If the section sorting command in linker script isn't nested, the | |
4560 | command line option will make the section sorting command to be | |
4561 | treated as nested sorting command. | |
4562 | ||
4563 | @enumerate | |
4564 | @item | |
4565 | @code{SORT_BY_NAME} (wildcard section pattern ) with | |
4566 | @option{--sort-sections alignment} is equivalent to | |
4567 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
4568 | @item | |
4569 | @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with | |
4570 | @option{--sort-section name} is equivalent to | |
4571 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
4572 | @end enumerate | |
4573 | ||
4574 | If the section sorting command in linker script is nested, the | |
4575 | command line option will be ignored. | |
4576 | ||
eda680f8 L |
4577 | @cindex SORT_NONE |
4578 | @code{SORT_NONE} disables section sorting by ignoring the command line | |
4579 | section sorting option. | |
4580 | ||
252b5132 RH |
4581 | If you ever get confused about where input sections are going, use the |
4582 | @samp{-M} linker option to generate a map file. The map file shows | |
4583 | precisely how input sections are mapped to output sections. | |
4584 | ||
4585 | This example shows how wildcard patterns might be used to partition | |
4586 | files. This linker script directs the linker to place all @samp{.text} | |
4587 | sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}. | |
4588 | The linker will place the @samp{.data} section from all files beginning | |
4589 | with an upper case character in @samp{.DATA}; for all other files, the | |
4590 | linker will place the @samp{.data} section in @samp{.data}. | |
4591 | @smallexample | |
4592 | @group | |
4593 | SECTIONS @{ | |
4594 | .text : @{ *(.text) @} | |
4595 | .DATA : @{ [A-Z]*(.data) @} | |
4596 | .data : @{ *(.data) @} | |
4597 | .bss : @{ *(.bss) @} | |
4598 | @} | |
4599 | @end group | |
4600 | @end smallexample | |
4601 | ||
4602 | @node Input Section Common | |
36f63dca | 4603 | @subsubsection Input Section for Common Symbols |
252b5132 RH |
4604 | @cindex common symbol placement |
4605 | @cindex uninitialized data placement | |
4606 | A special notation is needed for common symbols, because in many object | |
4607 | file formats common symbols do not have a particular input section. The | |
4608 | linker treats common symbols as though they are in an input section | |
4609 | named @samp{COMMON}. | |
4610 | ||
4611 | You may use file names with the @samp{COMMON} section just as with any | |
4612 | other input sections. You can use this to place common symbols from a | |
4613 | particular input file in one section while common symbols from other | |
4614 | input files are placed in another section. | |
4615 | ||
4616 | In most cases, common symbols in input files will be placed in the | |
4617 | @samp{.bss} section in the output file. For example: | |
4618 | @smallexample | |
4619 | .bss @{ *(.bss) *(COMMON) @} | |
4620 | @end smallexample | |
4621 | ||
4622 | @cindex scommon section | |
4623 | @cindex small common symbols | |
4624 | Some object file formats have more than one type of common symbol. For | |
4625 | example, the MIPS ELF object file format distinguishes standard common | |
4626 | symbols and small common symbols. In this case, the linker will use a | |
4627 | different special section name for other types of common symbols. In | |
4628 | the case of MIPS ELF, the linker uses @samp{COMMON} for standard common | |
4629 | symbols and @samp{.scommon} for small common symbols. This permits you | |
4630 | to map the different types of common symbols into memory at different | |
4631 | locations. | |
4632 | ||
4633 | @cindex [COMMON] | |
4634 | You will sometimes see @samp{[COMMON]} in old linker scripts. This | |
4635 | notation is now considered obsolete. It is equivalent to | |
4636 | @samp{*(COMMON)}. | |
4637 | ||
4638 | @node Input Section Keep | |
36f63dca | 4639 | @subsubsection Input Section and Garbage Collection |
252b5132 RH |
4640 | @cindex KEEP |
4641 | @cindex garbage collection | |
4642 | When link-time garbage collection is in use (@samp{--gc-sections}), | |
a1ab1d2a | 4643 | it is often useful to mark sections that should not be eliminated. |
252b5132 RH |
4644 | This is accomplished by surrounding an input section's wildcard entry |
4645 | with @code{KEEP()}, as in @code{KEEP(*(.init))} or | |
bcaa7b3e | 4646 | @code{KEEP(SORT_BY_NAME(*)(.ctors))}. |
252b5132 RH |
4647 | |
4648 | @node Input Section Example | |
36f63dca | 4649 | @subsubsection Input Section Example |
252b5132 RH |
4650 | The following example is a complete linker script. It tells the linker |
4651 | to read all of the sections from file @file{all.o} and place them at the | |
4652 | start of output section @samp{outputa} which starts at location | |
4653 | @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o} | |
4654 | follows immediately, in the same output section. All of section | |
4655 | @samp{.input2} from @file{foo.o} goes into output section | |
4656 | @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}. | |
4657 | All of the remaining @samp{.input1} and @samp{.input2} sections from any | |
4658 | files are written to output section @samp{outputc}. | |
4659 | ||
4660 | @smallexample | |
4661 | @group | |
4662 | SECTIONS @{ | |
4663 | outputa 0x10000 : | |
4664 | @{ | |
4665 | all.o | |
4666 | foo.o (.input1) | |
4667 | @} | |
36f63dca NC |
4668 | @end group |
4669 | @group | |
252b5132 RH |
4670 | outputb : |
4671 | @{ | |
4672 | foo.o (.input2) | |
4673 | foo1.o (.input1) | |
4674 | @} | |
36f63dca NC |
4675 | @end group |
4676 | @group | |
252b5132 RH |
4677 | outputc : |
4678 | @{ | |
4679 | *(.input1) | |
4680 | *(.input2) | |
4681 | @} | |
4682 | @} | |
4683 | @end group | |
a1ab1d2a | 4684 | @end smallexample |
252b5132 | 4685 | |
cbd0eecf L |
4686 | If an output section's name is the same as the input section's name |
4687 | and is representable as a C identifier, then the linker will | |
4688 | automatically @pxref{PROVIDE} two symbols: __start_SECNAME and | |
4689 | __stop_SECNAME, where SECNAME is the name of the section. These | |
4690 | indicate the start address and end address of the output section | |
4691 | respectively. Note: most section names are not representable as | |
4692 | C identifiers because they contain a @samp{.} character. | |
4693 | ||
252b5132 | 4694 | @node Output Section Data |
36f63dca | 4695 | @subsection Output Section Data |
252b5132 RH |
4696 | @cindex data |
4697 | @cindex section data | |
4698 | @cindex output section data | |
4699 | @kindex BYTE(@var{expression}) | |
4700 | @kindex SHORT(@var{expression}) | |
4701 | @kindex LONG(@var{expression}) | |
4702 | @kindex QUAD(@var{expression}) | |
4703 | @kindex SQUAD(@var{expression}) | |
4704 | You can include explicit bytes of data in an output section by using | |
4705 | @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as | |
4706 | an output section command. Each keyword is followed by an expression in | |
4707 | parentheses providing the value to store (@pxref{Expressions}). The | |
4708 | value of the expression is stored at the current value of the location | |
4709 | counter. | |
4710 | ||
4711 | The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands | |
4712 | store one, two, four, and eight bytes (respectively). After storing the | |
4713 | bytes, the location counter is incremented by the number of bytes | |
4714 | stored. | |
4715 | ||
4716 | For example, this will store the byte 1 followed by the four byte value | |
4717 | of the symbol @samp{addr}: | |
4718 | @smallexample | |
4719 | BYTE(1) | |
4720 | LONG(addr) | |
4721 | @end smallexample | |
4722 | ||
4723 | When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the | |
4724 | same; they both store an 8 byte, or 64 bit, value. When both host and | |
4725 | target are 32 bits, an expression is computed as 32 bits. In this case | |
4726 | @code{QUAD} stores a 32 bit value zero extended to 64 bits, and | |
4727 | @code{SQUAD} stores a 32 bit value sign extended to 64 bits. | |
4728 | ||
4729 | If the object file format of the output file has an explicit endianness, | |
4730 | which is the normal case, the value will be stored in that endianness. | |
4731 | When the object file format does not have an explicit endianness, as is | |
4732 | true of, for example, S-records, the value will be stored in the | |
4733 | endianness of the first input object file. | |
4734 | ||
36f63dca | 4735 | Note---these commands only work inside a section description and not |
2b5fc1f5 NC |
4736 | between them, so the following will produce an error from the linker: |
4737 | @smallexample | |
4738 | SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@ | |
4739 | @end smallexample | |
4740 | whereas this will work: | |
4741 | @smallexample | |
4742 | SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@ | |
4743 | @end smallexample | |
4744 | ||
252b5132 RH |
4745 | @kindex FILL(@var{expression}) |
4746 | @cindex holes, filling | |
4747 | @cindex unspecified memory | |
4748 | You may use the @code{FILL} command to set the fill pattern for the | |
4749 | current section. It is followed by an expression in parentheses. Any | |
4750 | otherwise unspecified regions of memory within the section (for example, | |
4751 | gaps left due to the required alignment of input sections) are filled | |
a139d329 | 4752 | with the value of the expression, repeated as |
252b5132 RH |
4753 | necessary. A @code{FILL} statement covers memory locations after the |
4754 | point at which it occurs in the section definition; by including more | |
4755 | than one @code{FILL} statement, you can have different fill patterns in | |
4756 | different parts of an output section. | |
4757 | ||
4758 | This example shows how to fill unspecified regions of memory with the | |
563e308f | 4759 | value @samp{0x90}: |
252b5132 | 4760 | @smallexample |
563e308f | 4761 | FILL(0x90909090) |
252b5132 RH |
4762 | @end smallexample |
4763 | ||
4764 | The @code{FILL} command is similar to the @samp{=@var{fillexp}} output | |
9673c93c | 4765 | section attribute, but it only affects the |
252b5132 RH |
4766 | part of the section following the @code{FILL} command, rather than the |
4767 | entire section. If both are used, the @code{FILL} command takes | |
9673c93c | 4768 | precedence. @xref{Output Section Fill}, for details on the fill |
a139d329 | 4769 | expression. |
252b5132 RH |
4770 | |
4771 | @node Output Section Keywords | |
36f63dca | 4772 | @subsection Output Section Keywords |
252b5132 RH |
4773 | There are a couple of keywords which can appear as output section |
4774 | commands. | |
4775 | ||
4776 | @table @code | |
4777 | @kindex CREATE_OBJECT_SYMBOLS | |
4778 | @cindex input filename symbols | |
4779 | @cindex filename symbols | |
4780 | @item CREATE_OBJECT_SYMBOLS | |
4781 | The command tells the linker to create a symbol for each input file. | |
4782 | The name of each symbol will be the name of the corresponding input | |
4783 | file. The section of each symbol will be the output section in which | |
4784 | the @code{CREATE_OBJECT_SYMBOLS} command appears. | |
4785 | ||
4786 | This is conventional for the a.out object file format. It is not | |
4787 | normally used for any other object file format. | |
4788 | ||
4789 | @kindex CONSTRUCTORS | |
4790 | @cindex C++ constructors, arranging in link | |
4791 | @cindex constructors, arranging in link | |
4792 | @item CONSTRUCTORS | |
4793 | When linking using the a.out object file format, the linker uses an | |
4794 | unusual set construct to support C++ global constructors and | |
4795 | destructors. When linking object file formats which do not support | |
4796 | arbitrary sections, such as ECOFF and XCOFF, the linker will | |
4797 | automatically recognize C++ global constructors and destructors by name. | |
4798 | For these object file formats, the @code{CONSTRUCTORS} command tells the | |
4799 | linker to place constructor information in the output section where the | |
4800 | @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is | |
4801 | ignored for other object file formats. | |
4802 | ||
4803 | The symbol @w{@code{__CTOR_LIST__}} marks the start of the global | |
7e69709c AM |
4804 | constructors, and the symbol @w{@code{__CTOR_END__}} marks the end. |
4805 | Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark | |
4806 | the start and end of the global destructors. The | |
252b5132 RH |
4807 | first word in the list is the number of entries, followed by the address |
4808 | of each constructor or destructor, followed by a zero word. The | |
4809 | compiler must arrange to actually run the code. For these object file | |
4810 | formats @sc{gnu} C++ normally calls constructors from a subroutine | |
4811 | @code{__main}; a call to @code{__main} is automatically inserted into | |
4812 | the startup code for @code{main}. @sc{gnu} C++ normally runs | |
4813 | destructors either by using @code{atexit}, or directly from the function | |
4814 | @code{exit}. | |
4815 | ||
4816 | For object file formats such as @code{COFF} or @code{ELF} which support | |
4817 | arbitrary section names, @sc{gnu} C++ will normally arrange to put the | |
4818 | addresses of global constructors and destructors into the @code{.ctors} | |
4819 | and @code{.dtors} sections. Placing the following sequence into your | |
4820 | linker script will build the sort of table which the @sc{gnu} C++ | |
4821 | runtime code expects to see. | |
4822 | ||
4823 | @smallexample | |
4824 | __CTOR_LIST__ = .; | |
4825 | LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2) | |
4826 | *(.ctors) | |
4827 | LONG(0) | |
4828 | __CTOR_END__ = .; | |
4829 | __DTOR_LIST__ = .; | |
4830 | LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2) | |
4831 | *(.dtors) | |
4832 | LONG(0) | |
4833 | __DTOR_END__ = .; | |
4834 | @end smallexample | |
4835 | ||
4836 | If you are using the @sc{gnu} C++ support for initialization priority, | |
4837 | which provides some control over the order in which global constructors | |
4838 | are run, you must sort the constructors at link time to ensure that they | |
4839 | are executed in the correct order. When using the @code{CONSTRUCTORS} | |
bcaa7b3e L |
4840 | command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the |
4841 | @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and | |
4842 | @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and | |
252b5132 RH |
4843 | @samp{*(.dtors)}. |
4844 | ||
4845 | Normally the compiler and linker will handle these issues automatically, | |
4846 | and you will not need to concern yourself with them. However, you may | |
4847 | need to consider this if you are using C++ and writing your own linker | |
4848 | scripts. | |
4849 | ||
4850 | @end table | |
4851 | ||
4852 | @node Output Section Discarding | |
36f63dca | 4853 | @subsection Output Section Discarding |
252b5132 RH |
4854 | @cindex discarding sections |
4855 | @cindex sections, discarding | |
4856 | @cindex removing sections | |
2edab91c AM |
4857 | The linker will not normally create output sections with no contents. |
4858 | This is for convenience when referring to input sections that may or | |
4859 | may not be present in any of the input files. For example: | |
252b5132 | 4860 | @smallexample |
49c13adb | 4861 | .foo : @{ *(.foo) @} |
252b5132 RH |
4862 | @end smallexample |
4863 | @noindent | |
4864 | will only create a @samp{.foo} section in the output file if there is a | |
74541ad4 AM |
4865 | @samp{.foo} section in at least one input file, and if the input |
4866 | sections are not all empty. Other link script directives that allocate | |
2edab91c AM |
4867 | space in an output section will also create the output section. So |
4868 | too will assignments to dot even if the assignment does not create | |
4869 | space, except for @samp{. = 0}, @samp{. = . + 0}, @samp{. = sym}, | |
4870 | @samp{. = . + sym} and @samp{. = ALIGN (. != 0, expr, 1)} when | |
4871 | @samp{sym} is an absolute symbol of value 0 defined in the script. | |
4872 | This allows you to force output of an empty section with @samp{. = .}. | |
74541ad4 | 4873 | |
a0976ea4 | 4874 | The linker will ignore address assignments (@pxref{Output Section Address}) |
74541ad4 AM |
4875 | on discarded output sections, except when the linker script defines |
4876 | symbols in the output section. In that case the linker will obey | |
a0976ea4 AM |
4877 | the address assignments, possibly advancing dot even though the |
4878 | section is discarded. | |
252b5132 RH |
4879 | |
4880 | @cindex /DISCARD/ | |
4881 | The special output section name @samp{/DISCARD/} may be used to discard | |
4882 | input sections. Any input sections which are assigned to an output | |
4883 | section named @samp{/DISCARD/} are not included in the output file. | |
4884 | ||
4885 | @node Output Section Attributes | |
36f63dca | 4886 | @subsection Output Section Attributes |
252b5132 RH |
4887 | @cindex output section attributes |
4888 | We showed above that the full description of an output section looked | |
4889 | like this: | |
0c71d759 | 4890 | |
252b5132 | 4891 | @smallexample |
a1ab1d2a | 4892 | @group |
7e7d5768 | 4893 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 NC |
4894 | [AT(@var{lma})] |
4895 | [ALIGN(@var{section_align})] | |
4896 | [SUBALIGN(@var{subsection_align})] | |
4897 | [@var{constraint}] | |
252b5132 RH |
4898 | @{ |
4899 | @var{output-section-command} | |
4900 | @var{output-section-command} | |
4901 | @dots{} | |
562d3460 | 4902 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
4903 | @end group |
4904 | @end smallexample | |
0c71d759 | 4905 | |
252b5132 RH |
4906 | We've already described @var{section}, @var{address}, and |
4907 | @var{output-section-command}. In this section we will describe the | |
4908 | remaining section attributes. | |
4909 | ||
a1ab1d2a | 4910 | @menu |
252b5132 RH |
4911 | * Output Section Type:: Output section type |
4912 | * Output Section LMA:: Output section LMA | |
bbf115d3 | 4913 | * Forced Output Alignment:: Forced Output Alignment |
7e7d5768 | 4914 | * Forced Input Alignment:: Forced Input Alignment |
0c71d759 | 4915 | * Output Section Constraint:: Output section constraint |
252b5132 RH |
4916 | * Output Section Region:: Output section region |
4917 | * Output Section Phdr:: Output section phdr | |
4918 | * Output Section Fill:: Output section fill | |
4919 | @end menu | |
4920 | ||
4921 | @node Output Section Type | |
36f63dca | 4922 | @subsubsection Output Section Type |
252b5132 RH |
4923 | Each output section may have a type. The type is a keyword in |
4924 | parentheses. The following types are defined: | |
4925 | ||
4926 | @table @code | |
4927 | @item NOLOAD | |
4928 | The section should be marked as not loadable, so that it will not be | |
4929 | loaded into memory when the program is run. | |
4930 | @item DSECT | |
4931 | @itemx COPY | |
4932 | @itemx INFO | |
4933 | @itemx OVERLAY | |
4934 | These type names are supported for backward compatibility, and are | |
4935 | rarely used. They all have the same effect: the section should be | |
4936 | marked as not allocatable, so that no memory is allocated for the | |
4937 | section when the program is run. | |
4938 | @end table | |
4939 | ||
4940 | @kindex NOLOAD | |
4941 | @cindex prevent unnecessary loading | |
4942 | @cindex loading, preventing | |
4943 | The linker normally sets the attributes of an output section based on | |
4944 | the input sections which map into it. You can override this by using | |
4945 | the section type. For example, in the script sample below, the | |
4946 | @samp{ROM} section is addressed at memory location @samp{0} and does not | |
2e76e85a | 4947 | need to be loaded when the program is run. |
252b5132 RH |
4948 | @smallexample |
4949 | @group | |
4950 | SECTIONS @{ | |
4951 | ROM 0 (NOLOAD) : @{ @dots{} @} | |
4952 | @dots{} | |
4953 | @} | |
4954 | @end group | |
4955 | @end smallexample | |
4956 | ||
4957 | @node Output Section LMA | |
36f63dca | 4958 | @subsubsection Output Section LMA |
562d3460 | 4959 | @kindex AT>@var{lma_region} |
252b5132 RH |
4960 | @kindex AT(@var{lma}) |
4961 | @cindex load address | |
4962 | @cindex section load address | |
4963 | Every section has a virtual address (VMA) and a load address (LMA); see | |
ea5cae92 NC |
4964 | @ref{Basic Script Concepts}. The virtual address is specified by the |
4965 | @pxref{Output Section Address} described earlier. The load address is | |
4966 | specified by the @code{AT} or @code{AT>} keywords. Specifying a load | |
4967 | address is optional. | |
6bdafbeb | 4968 | |
ea5cae92 NC |
4969 | The @code{AT} keyword takes an expression as an argument. This |
4970 | specifies the exact load address of the section. The @code{AT>} keyword | |
4971 | takes the name of a memory region as an argument. @xref{MEMORY}. The | |
4972 | load address of the section is set to the next free address in the | |
4973 | region, aligned to the section's alignment requirements. | |
dc0b6aa0 AM |
4974 | |
4975 | If neither @code{AT} nor @code{AT>} is specified for an allocatable | |
ea5cae92 NC |
4976 | section, the linker will use the following heuristic to determine the |
4977 | load address: | |
4978 | ||
4979 | @itemize @bullet | |
4980 | @item | |
4981 | If the section has a specific VMA address, then this is used as | |
4982 | the LMA address as well. | |
4983 | ||
4984 | @item | |
4985 | If the section is not allocatable then its LMA is set to its VMA. | |
4986 | ||
4987 | @item | |
4988 | Otherwise if a memory region can be found that is compatible | |
4989 | with the current section, and this region contains at least one | |
4990 | section, then the LMA is set so the difference between the | |
4991 | VMA and LMA is the same as the difference between the VMA and LMA of | |
4992 | the last section in the located region. | |
4993 | ||
4994 | @item | |
4995 | If no memory regions have been declared then a default region | |
4996 | that covers the entire address space is used in the previous step. | |
4997 | ||
4998 | @item | |
4999 | If no suitable region could be found, or there was no previous | |
5000 | section then the LMA is set equal to the VMA. | |
5001 | @end itemize | |
252b5132 RH |
5002 | |
5003 | @cindex ROM initialized data | |
5004 | @cindex initialized data in ROM | |
5005 | This feature is designed to make it easy to build a ROM image. For | |
5006 | example, the following linker script creates three output sections: one | |
5007 | called @samp{.text}, which starts at @code{0x1000}, one called | |
5008 | @samp{.mdata}, which is loaded at the end of the @samp{.text} section | |
5009 | even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold | |
5010 | uninitialized data at address @code{0x3000}. The symbol @code{_data} is | |
5011 | defined with the value @code{0x2000}, which shows that the location | |
5012 | counter holds the VMA value, not the LMA value. | |
5013 | ||
5014 | @smallexample | |
5015 | @group | |
5016 | SECTIONS | |
5017 | @{ | |
5018 | .text 0x1000 : @{ *(.text) _etext = . ; @} | |
a1ab1d2a | 5019 | .mdata 0x2000 : |
252b5132 RH |
5020 | AT ( ADDR (.text) + SIZEOF (.text) ) |
5021 | @{ _data = . ; *(.data); _edata = . ; @} | |
5022 | .bss 0x3000 : | |
5023 | @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@} | |
5024 | @} | |
5025 | @end group | |
5026 | @end smallexample | |
5027 | ||
5028 | The run-time initialization code for use with a program generated with | |
5029 | this linker script would include something like the following, to copy | |
5030 | the initialized data from the ROM image to its runtime address. Notice | |
5031 | how this code takes advantage of the symbols defined by the linker | |
5032 | script. | |
5033 | ||
5034 | @smallexample | |
5035 | @group | |
5036 | extern char _etext, _data, _edata, _bstart, _bend; | |
5037 | char *src = &_etext; | |
5038 | char *dst = &_data; | |
5039 | ||
ea5cae92 NC |
5040 | /* ROM has data at end of text; copy it. */ |
5041 | while (dst < &_edata) | |
252b5132 | 5042 | *dst++ = *src++; |
252b5132 | 5043 | |
ea5cae92 | 5044 | /* Zero bss. */ |
252b5132 RH |
5045 | for (dst = &_bstart; dst< &_bend; dst++) |
5046 | *dst = 0; | |
5047 | @end group | |
5048 | @end smallexample | |
5049 | ||
bbf115d3 L |
5050 | @node Forced Output Alignment |
5051 | @subsubsection Forced Output Alignment | |
5052 | @kindex ALIGN(@var{section_align}) | |
5053 | @cindex forcing output section alignment | |
5054 | @cindex output section alignment | |
1eec346e | 5055 | You can increase an output section's alignment by using ALIGN. As an |
13075d04 SH |
5056 | alternative you can enforce that the difference between the VMA and LMA remains |
5057 | intact throughout this output section with the ALIGN_WITH_INPUT attribute. | |
bbf115d3 | 5058 | |
7e7d5768 AM |
5059 | @node Forced Input Alignment |
5060 | @subsubsection Forced Input Alignment | |
5061 | @kindex SUBALIGN(@var{subsection_align}) | |
5062 | @cindex forcing input section alignment | |
5063 | @cindex input section alignment | |
5064 | You can force input section alignment within an output section by using | |
5065 | SUBALIGN. The value specified overrides any alignment given by input | |
5066 | sections, whether larger or smaller. | |
5067 | ||
0c71d759 NC |
5068 | @node Output Section Constraint |
5069 | @subsubsection Output Section Constraint | |
5070 | @kindex ONLY_IF_RO | |
5071 | @kindex ONLY_IF_RW | |
5072 | @cindex constraints on output sections | |
5073 | You can specify that an output section should only be created if all | |
5074 | of its input sections are read-only or all of its input sections are | |
5075 | read-write by using the keyword @code{ONLY_IF_RO} and | |
5076 | @code{ONLY_IF_RW} respectively. | |
5077 | ||
252b5132 | 5078 | @node Output Section Region |
36f63dca | 5079 | @subsubsection Output Section Region |
252b5132 RH |
5080 | @kindex >@var{region} |
5081 | @cindex section, assigning to memory region | |
5082 | @cindex memory regions and sections | |
5083 | You can assign a section to a previously defined region of memory by | |
5084 | using @samp{>@var{region}}. @xref{MEMORY}. | |
5085 | ||
5086 | Here is a simple example: | |
5087 | @smallexample | |
5088 | @group | |
5089 | MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @} | |
5090 | SECTIONS @{ ROM : @{ *(.text) @} >rom @} | |
5091 | @end group | |
5092 | @end smallexample | |
5093 | ||
5094 | @node Output Section Phdr | |
36f63dca | 5095 | @subsubsection Output Section Phdr |
252b5132 RH |
5096 | @kindex :@var{phdr} |
5097 | @cindex section, assigning to program header | |
5098 | @cindex program headers and sections | |
5099 | You can assign a section to a previously defined program segment by | |
5100 | using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to | |
5101 | one or more segments, then all subsequent allocated sections will be | |
5102 | assigned to those segments as well, unless they use an explicitly | |
5103 | @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the | |
5104 | linker to not put the section in any segment at all. | |
5105 | ||
5106 | Here is a simple example: | |
5107 | @smallexample | |
5108 | @group | |
5109 | PHDRS @{ text PT_LOAD ; @} | |
5110 | SECTIONS @{ .text : @{ *(.text) @} :text @} | |
5111 | @end group | |
5112 | @end smallexample | |
5113 | ||
5114 | @node Output Section Fill | |
36f63dca | 5115 | @subsubsection Output Section Fill |
252b5132 RH |
5116 | @kindex =@var{fillexp} |
5117 | @cindex section fill pattern | |
5118 | @cindex fill pattern, entire section | |
5119 | You can set the fill pattern for an entire section by using | |
5120 | @samp{=@var{fillexp}}. @var{fillexp} is an expression | |
5121 | (@pxref{Expressions}). Any otherwise unspecified regions of memory | |
5122 | within the output section (for example, gaps left due to the required | |
a139d329 AM |
5123 | alignment of input sections) will be filled with the value, repeated as |
5124 | necessary. If the fill expression is a simple hex number, ie. a string | |
9673c93c | 5125 | of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then |
a139d329 AM |
5126 | an arbitrarily long sequence of hex digits can be used to specify the |
5127 | fill pattern; Leading zeros become part of the pattern too. For all | |
9673c93c | 5128 | other cases, including extra parentheses or a unary @code{+}, the fill |
a139d329 AM |
5129 | pattern is the four least significant bytes of the value of the |
5130 | expression. In all cases, the number is big-endian. | |
252b5132 RH |
5131 | |
5132 | You can also change the fill value with a @code{FILL} command in the | |
9673c93c | 5133 | output section commands; (@pxref{Output Section Data}). |
252b5132 RH |
5134 | |
5135 | Here is a simple example: | |
5136 | @smallexample | |
5137 | @group | |
563e308f | 5138 | SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @} |
252b5132 RH |
5139 | @end group |
5140 | @end smallexample | |
5141 | ||
5142 | @node Overlay Description | |
36f63dca | 5143 | @subsection Overlay Description |
252b5132 RH |
5144 | @kindex OVERLAY |
5145 | @cindex overlays | |
5146 | An overlay description provides an easy way to describe sections which | |
5147 | are to be loaded as part of a single memory image but are to be run at | |
5148 | the same memory address. At run time, some sort of overlay manager will | |
5149 | copy the overlaid sections in and out of the runtime memory address as | |
5150 | required, perhaps by simply manipulating addressing bits. This approach | |
5151 | can be useful, for example, when a certain region of memory is faster | |
5152 | than another. | |
5153 | ||
5154 | Overlays are described using the @code{OVERLAY} command. The | |
5155 | @code{OVERLAY} command is used within a @code{SECTIONS} command, like an | |
5156 | output section description. The full syntax of the @code{OVERLAY} | |
5157 | command is as follows: | |
5158 | @smallexample | |
5159 | @group | |
5160 | OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )] | |
5161 | @{ | |
5162 | @var{secname1} | |
5163 | @{ | |
5164 | @var{output-section-command} | |
5165 | @var{output-section-command} | |
5166 | @dots{} | |
5167 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
5168 | @var{secname2} | |
5169 | @{ | |
5170 | @var{output-section-command} | |
5171 | @var{output-section-command} | |
5172 | @dots{} | |
5173 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
5174 | @dots{} | |
abc9061b | 5175 | @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] [,] |
252b5132 RH |
5176 | @end group |
5177 | @end smallexample | |
5178 | ||
5179 | Everything is optional except @code{OVERLAY} (a keyword), and each | |
5180 | section must have a name (@var{secname1} and @var{secname2} above). The | |
5181 | section definitions within the @code{OVERLAY} construct are identical to | |
11e7fd74 | 5182 | those within the general @code{SECTIONS} construct (@pxref{SECTIONS}), |
252b5132 RH |
5183 | except that no addresses and no memory regions may be defined for |
5184 | sections within an @code{OVERLAY}. | |
5185 | ||
abc9061b CC |
5186 | The comma at the end may be required if a @var{fill} is used and |
5187 | the next @var{sections-command} looks like a continuation of the expression. | |
5188 | ||
252b5132 RH |
5189 | The sections are all defined with the same starting address. The load |
5190 | addresses of the sections are arranged such that they are consecutive in | |
5191 | memory starting at the load address used for the @code{OVERLAY} as a | |
5192 | whole (as with normal section definitions, the load address is optional, | |
5193 | and defaults to the start address; the start address is also optional, | |
5194 | and defaults to the current value of the location counter). | |
5195 | ||
56dd11f0 NC |
5196 | If the @code{NOCROSSREFS} keyword is used, and there are any |
5197 | references among the sections, the linker will report an error. Since | |
5198 | the sections all run at the same address, it normally does not make | |
5199 | sense for one section to refer directly to another. | |
5200 | @xref{Miscellaneous Commands, NOCROSSREFS}. | |
252b5132 RH |
5201 | |
5202 | For each section within the @code{OVERLAY}, the linker automatically | |
34711ca3 | 5203 | provides two symbols. The symbol @code{__load_start_@var{secname}} is |
252b5132 RH |
5204 | defined as the starting load address of the section. The symbol |
5205 | @code{__load_stop_@var{secname}} is defined as the final load address of | |
5206 | the section. Any characters within @var{secname} which are not legal | |
5207 | within C identifiers are removed. C (or assembler) code may use these | |
5208 | symbols to move the overlaid sections around as necessary. | |
5209 | ||
5210 | At the end of the overlay, the value of the location counter is set to | |
5211 | the start address of the overlay plus the size of the largest section. | |
5212 | ||
5213 | Here is an example. Remember that this would appear inside a | |
5214 | @code{SECTIONS} construct. | |
5215 | @smallexample | |
5216 | @group | |
5217 | OVERLAY 0x1000 : AT (0x4000) | |
5218 | @{ | |
5219 | .text0 @{ o1/*.o(.text) @} | |
5220 | .text1 @{ o2/*.o(.text) @} | |
5221 | @} | |
5222 | @end group | |
5223 | @end smallexample | |
5224 | @noindent | |
5225 | This will define both @samp{.text0} and @samp{.text1} to start at | |
5226 | address 0x1000. @samp{.text0} will be loaded at address 0x4000, and | |
5227 | @samp{.text1} will be loaded immediately after @samp{.text0}. The | |
34711ca3 | 5228 | following symbols will be defined if referenced: @code{__load_start_text0}, |
252b5132 RH |
5229 | @code{__load_stop_text0}, @code{__load_start_text1}, |
5230 | @code{__load_stop_text1}. | |
5231 | ||
5232 | C code to copy overlay @code{.text1} into the overlay area might look | |
5233 | like the following. | |
5234 | ||
5235 | @smallexample | |
5236 | @group | |
5237 | extern char __load_start_text1, __load_stop_text1; | |
5238 | memcpy ((char *) 0x1000, &__load_start_text1, | |
5239 | &__load_stop_text1 - &__load_start_text1); | |
5240 | @end group | |
5241 | @end smallexample | |
5242 | ||
5243 | Note that the @code{OVERLAY} command is just syntactic sugar, since | |
5244 | everything it does can be done using the more basic commands. The above | |
5245 | example could have been written identically as follows. | |
5246 | ||
5247 | @smallexample | |
5248 | @group | |
5249 | .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @} | |
34711ca3 AM |
5250 | PROVIDE (__load_start_text0 = LOADADDR (.text0)); |
5251 | PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0)); | |
252b5132 | 5252 | .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @} |
34711ca3 AM |
5253 | PROVIDE (__load_start_text1 = LOADADDR (.text1)); |
5254 | PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1)); | |
252b5132 RH |
5255 | . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1)); |
5256 | @end group | |
5257 | @end smallexample | |
5258 | ||
5259 | @node MEMORY | |
36f63dca | 5260 | @section MEMORY Command |
252b5132 RH |
5261 | @kindex MEMORY |
5262 | @cindex memory regions | |
5263 | @cindex regions of memory | |
5264 | @cindex allocating memory | |
5265 | @cindex discontinuous memory | |
5266 | The linker's default configuration permits allocation of all available | |
5267 | memory. You can override this by using the @code{MEMORY} command. | |
5268 | ||
5269 | The @code{MEMORY} command describes the location and size of blocks of | |
5270 | memory in the target. You can use it to describe which memory regions | |
5271 | may be used by the linker, and which memory regions it must avoid. You | |
5272 | can then assign sections to particular memory regions. The linker will | |
5273 | set section addresses based on the memory regions, and will warn about | |
5274 | regions that become too full. The linker will not shuffle sections | |
5275 | around to fit into the available regions. | |
5276 | ||
127fcdff AB |
5277 | A linker script may contain many uses of the @code{MEMORY} command, |
5278 | however, all memory blocks defined are treated as if they were | |
5279 | specified inside a single @code{MEMORY} command. The syntax for | |
5280 | @code{MEMORY} is: | |
252b5132 RH |
5281 | @smallexample |
5282 | @group | |
a1ab1d2a | 5283 | MEMORY |
252b5132 RH |
5284 | @{ |
5285 | @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len} | |
5286 | @dots{} | |
5287 | @} | |
5288 | @end group | |
5289 | @end smallexample | |
5290 | ||
5291 | The @var{name} is a name used in the linker script to refer to the | |
5292 | region. The region name has no meaning outside of the linker script. | |
5293 | Region names are stored in a separate name space, and will not conflict | |
5294 | with symbol names, file names, or section names. Each memory region | |
4a93e180 NC |
5295 | must have a distinct name within the @code{MEMORY} command. However you can |
5296 | add later alias names to existing memory regions with the @ref{REGION_ALIAS} | |
9d5777a3 | 5297 | command. |
252b5132 RH |
5298 | |
5299 | @cindex memory region attributes | |
5300 | The @var{attr} string is an optional list of attributes that specify | |
5301 | whether to use a particular memory region for an input section which is | |
5302 | not explicitly mapped in the linker script. As described in | |
5303 | @ref{SECTIONS}, if you do not specify an output section for some input | |
5304 | section, the linker will create an output section with the same name as | |
5305 | the input section. If you define region attributes, the linker will use | |
5306 | them to select the memory region for the output section that it creates. | |
5307 | ||
5308 | The @var{attr} string must consist only of the following characters: | |
5309 | @table @samp | |
5310 | @item R | |
5311 | Read-only section | |
5312 | @item W | |
5313 | Read/write section | |
5314 | @item X | |
5315 | Executable section | |
5316 | @item A | |
5317 | Allocatable section | |
5318 | @item I | |
5319 | Initialized section | |
5320 | @item L | |
5321 | Same as @samp{I} | |
5322 | @item ! | |
c09e9a8c | 5323 | Invert the sense of any of the attributes that follow |
252b5132 RH |
5324 | @end table |
5325 | ||
5326 | If a unmapped section matches any of the listed attributes other than | |
5327 | @samp{!}, it will be placed in the memory region. The @samp{!} | |
5328 | attribute reverses this test, so that an unmapped section will be placed | |
5329 | in the memory region only if it does not match any of the listed | |
5330 | attributes. | |
5331 | ||
5332 | @kindex ORIGIN = | |
5333 | @kindex o = | |
5334 | @kindex org = | |
9cd6d51a NC |
5335 | The @var{origin} is an numerical expression for the start address of |
5336 | the memory region. The expression must evaluate to a constant and it | |
5337 | cannot involve any symbols. The keyword @code{ORIGIN} may be | |
5338 | abbreviated to @code{org} or @code{o} (but not, for example, | |
5339 | @code{ORG}). | |
252b5132 RH |
5340 | |
5341 | @kindex LENGTH = | |
5342 | @kindex len = | |
5343 | @kindex l = | |
5344 | The @var{len} is an expression for the size in bytes of the memory | |
5345 | region. As with the @var{origin} expression, the expression must | |
9cd6d51a NC |
5346 | be numerical only and must evaluate to a constant. The keyword |
5347 | @code{LENGTH} may be abbreviated to @code{len} or @code{l}. | |
252b5132 RH |
5348 | |
5349 | In the following example, we specify that there are two memory regions | |
5350 | available for allocation: one starting at @samp{0} for 256 kilobytes, | |
5351 | and the other starting at @samp{0x40000000} for four megabytes. The | |
5352 | linker will place into the @samp{rom} memory region every section which | |
5353 | is not explicitly mapped into a memory region, and is either read-only | |
5354 | or executable. The linker will place other sections which are not | |
5355 | explicitly mapped into a memory region into the @samp{ram} memory | |
5356 | region. | |
5357 | ||
5358 | @smallexample | |
5359 | @group | |
a1ab1d2a | 5360 | MEMORY |
252b5132 RH |
5361 | @{ |
5362 | rom (rx) : ORIGIN = 0, LENGTH = 256K | |
5363 | ram (!rx) : org = 0x40000000, l = 4M | |
5364 | @} | |
5365 | @end group | |
5366 | @end smallexample | |
5367 | ||
5368 | Once you define a memory region, you can direct the linker to place | |
5369 | specific output sections into that memory region by using the | |
5370 | @samp{>@var{region}} output section attribute. For example, if you have | |
5371 | a memory region named @samp{mem}, you would use @samp{>mem} in the | |
5372 | output section definition. @xref{Output Section Region}. If no address | |
5373 | was specified for the output section, the linker will set the address to | |
5374 | the next available address within the memory region. If the combined | |
5375 | output sections directed to a memory region are too large for the | |
5376 | region, the linker will issue an error message. | |
5377 | ||
3ec57632 | 5378 | It is possible to access the origin and length of a memory in an |
c0065db7 | 5379 | expression via the @code{ORIGIN(@var{memory})} and |
3ec57632 NC |
5380 | @code{LENGTH(@var{memory})} functions: |
5381 | ||
5382 | @smallexample | |
5383 | @group | |
c0065db7 | 5384 | _fstack = ORIGIN(ram) + LENGTH(ram) - 4; |
3ec57632 NC |
5385 | @end group |
5386 | @end smallexample | |
5387 | ||
252b5132 RH |
5388 | @node PHDRS |
5389 | @section PHDRS Command | |
5390 | @kindex PHDRS | |
5391 | @cindex program headers | |
5392 | @cindex ELF program headers | |
5393 | @cindex program segments | |
5394 | @cindex segments, ELF | |
5395 | The ELF object file format uses @dfn{program headers}, also knows as | |
5396 | @dfn{segments}. The program headers describe how the program should be | |
5397 | loaded into memory. You can print them out by using the @code{objdump} | |
5398 | program with the @samp{-p} option. | |
5399 | ||
5400 | When you run an ELF program on a native ELF system, the system loader | |
5401 | reads the program headers in order to figure out how to load the | |
5402 | program. This will only work if the program headers are set correctly. | |
5403 | This manual does not describe the details of how the system loader | |
5404 | interprets program headers; for more information, see the ELF ABI. | |
5405 | ||
5406 | The linker will create reasonable program headers by default. However, | |
5407 | in some cases, you may need to specify the program headers more | |
5408 | precisely. You may use the @code{PHDRS} command for this purpose. When | |
5409 | the linker sees the @code{PHDRS} command in the linker script, it will | |
5410 | not create any program headers other than the ones specified. | |
5411 | ||
5412 | The linker only pays attention to the @code{PHDRS} command when | |
5413 | generating an ELF output file. In other cases, the linker will simply | |
5414 | ignore @code{PHDRS}. | |
5415 | ||
5416 | This is the syntax of the @code{PHDRS} command. The words @code{PHDRS}, | |
5417 | @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords. | |
5418 | ||
5419 | @smallexample | |
5420 | @group | |
5421 | PHDRS | |
5422 | @{ | |
5423 | @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ] | |
5424 | [ FLAGS ( @var{flags} ) ] ; | |
5425 | @} | |
5426 | @end group | |
5427 | @end smallexample | |
5428 | ||
5429 | The @var{name} is used only for reference in the @code{SECTIONS} command | |
5430 | of the linker script. It is not put into the output file. Program | |
5431 | header names are stored in a separate name space, and will not conflict | |
5432 | with symbol names, file names, or section names. Each program header | |
5c1a3f0f NS |
5433 | must have a distinct name. The headers are processed in order and it |
5434 | is usual for them to map to sections in ascending load address order. | |
252b5132 RH |
5435 | |
5436 | Certain program header types describe segments of memory which the | |
5437 | system loader will load from the file. In the linker script, you | |
5438 | specify the contents of these segments by placing allocatable output | |
5439 | sections in the segments. You use the @samp{:@var{phdr}} output section | |
5440 | attribute to place a section in a particular segment. @xref{Output | |
5441 | Section Phdr}. | |
5442 | ||
5443 | It is normal to put certain sections in more than one segment. This | |
5444 | merely implies that one segment of memory contains another. You may | |
5445 | repeat @samp{:@var{phdr}}, using it once for each segment which should | |
5446 | contain the section. | |
5447 | ||
5448 | If you place a section in one or more segments using @samp{:@var{phdr}}, | |
5449 | then the linker will place all subsequent allocatable sections which do | |
5450 | not specify @samp{:@var{phdr}} in the same segments. This is for | |
5451 | convenience, since generally a whole set of contiguous sections will be | |
5452 | placed in a single segment. You can use @code{:NONE} to override the | |
5453 | default segment and tell the linker to not put the section in any | |
5454 | segment at all. | |
5455 | ||
5456 | @kindex FILEHDR | |
5457 | @kindex PHDRS | |
5c1a3f0f | 5458 | You may use the @code{FILEHDR} and @code{PHDRS} keywords after |
252b5132 RH |
5459 | the program header type to further describe the contents of the segment. |
5460 | The @code{FILEHDR} keyword means that the segment should include the ELF | |
5461 | file header. The @code{PHDRS} keyword means that the segment should | |
5c1a3f0f | 5462 | include the ELF program headers themselves. If applied to a loadable |
4100cea3 AM |
5463 | segment (@code{PT_LOAD}), all prior loadable segments must have one of |
5464 | these keywords. | |
252b5132 RH |
5465 | |
5466 | The @var{type} may be one of the following. The numbers indicate the | |
5467 | value of the keyword. | |
5468 | ||
5469 | @table @asis | |
5470 | @item @code{PT_NULL} (0) | |
5471 | Indicates an unused program header. | |
5472 | ||
5473 | @item @code{PT_LOAD} (1) | |
5474 | Indicates that this program header describes a segment to be loaded from | |
5475 | the file. | |
5476 | ||
5477 | @item @code{PT_DYNAMIC} (2) | |
5478 | Indicates a segment where dynamic linking information can be found. | |
5479 | ||
5480 | @item @code{PT_INTERP} (3) | |
5481 | Indicates a segment where the name of the program interpreter may be | |
5482 | found. | |
5483 | ||
5484 | @item @code{PT_NOTE} (4) | |
5485 | Indicates a segment holding note information. | |
5486 | ||
5487 | @item @code{PT_SHLIB} (5) | |
5488 | A reserved program header type, defined but not specified by the ELF | |
5489 | ABI. | |
5490 | ||
5491 | @item @code{PT_PHDR} (6) | |
5492 | Indicates a segment where the program headers may be found. | |
5493 | ||
1a9ccd70 NC |
5494 | @item @code{PT_TLS} (7) |
5495 | Indicates a segment containing thread local storage. | |
5496 | ||
252b5132 RH |
5497 | @item @var{expression} |
5498 | An expression giving the numeric type of the program header. This may | |
5499 | be used for types not defined above. | |
5500 | @end table | |
5501 | ||
5502 | You can specify that a segment should be loaded at a particular address | |
5503 | in memory by using an @code{AT} expression. This is identical to the | |
5504 | @code{AT} command used as an output section attribute (@pxref{Output | |
5505 | Section LMA}). The @code{AT} command for a program header overrides the | |
5506 | output section attribute. | |
5507 | ||
5508 | The linker will normally set the segment flags based on the sections | |
5509 | which comprise the segment. You may use the @code{FLAGS} keyword to | |
5510 | explicitly specify the segment flags. The value of @var{flags} must be | |
5511 | an integer. It is used to set the @code{p_flags} field of the program | |
5512 | header. | |
5513 | ||
5514 | Here is an example of @code{PHDRS}. This shows a typical set of program | |
5515 | headers used on a native ELF system. | |
5516 | ||
5517 | @example | |
5518 | @group | |
5519 | PHDRS | |
5520 | @{ | |
5521 | headers PT_PHDR PHDRS ; | |
5522 | interp PT_INTERP ; | |
5523 | text PT_LOAD FILEHDR PHDRS ; | |
5524 | data PT_LOAD ; | |
5525 | dynamic PT_DYNAMIC ; | |
5526 | @} | |
5527 | ||
5528 | SECTIONS | |
5529 | @{ | |
5530 | . = SIZEOF_HEADERS; | |
5531 | .interp : @{ *(.interp) @} :text :interp | |
5532 | .text : @{ *(.text) @} :text | |
5533 | .rodata : @{ *(.rodata) @} /* defaults to :text */ | |
5534 | @dots{} | |
5535 | . = . + 0x1000; /* move to a new page in memory */ | |
5536 | .data : @{ *(.data) @} :data | |
5537 | .dynamic : @{ *(.dynamic) @} :data :dynamic | |
5538 | @dots{} | |
5539 | @} | |
5540 | @end group | |
5541 | @end example | |
5542 | ||
5543 | @node VERSION | |
5544 | @section VERSION Command | |
5545 | @kindex VERSION @{script text@} | |
5546 | @cindex symbol versions | |
5547 | @cindex version script | |
5548 | @cindex versions of symbols | |
5549 | The linker supports symbol versions when using ELF. Symbol versions are | |
5550 | only useful when using shared libraries. The dynamic linker can use | |
5551 | symbol versions to select a specific version of a function when it runs | |
5552 | a program that may have been linked against an earlier version of the | |
5553 | shared library. | |
5554 | ||
5555 | You can include a version script directly in the main linker script, or | |
5556 | you can supply the version script as an implicit linker script. You can | |
5557 | also use the @samp{--version-script} linker option. | |
5558 | ||
5559 | The syntax of the @code{VERSION} command is simply | |
5560 | @smallexample | |
5561 | VERSION @{ version-script-commands @} | |
5562 | @end smallexample | |
5563 | ||
5564 | The format of the version script commands is identical to that used by | |
5565 | Sun's linker in Solaris 2.5. The version script defines a tree of | |
5566 | version nodes. You specify the node names and interdependencies in the | |
5567 | version script. You can specify which symbols are bound to which | |
5568 | version nodes, and you can reduce a specified set of symbols to local | |
5569 | scope so that they are not globally visible outside of the shared | |
5570 | library. | |
5571 | ||
5572 | The easiest way to demonstrate the version script language is with a few | |
5573 | examples. | |
5574 | ||
5575 | @smallexample | |
5576 | VERS_1.1 @{ | |
5577 | global: | |
5578 | foo1; | |
5579 | local: | |
a1ab1d2a UD |
5580 | old*; |
5581 | original*; | |
5582 | new*; | |
252b5132 RH |
5583 | @}; |
5584 | ||
5585 | VERS_1.2 @{ | |
5586 | foo2; | |
5587 | @} VERS_1.1; | |
5588 | ||
5589 | VERS_2.0 @{ | |
5590 | bar1; bar2; | |
c0065db7 | 5591 | extern "C++" @{ |
86043bbb | 5592 | ns::*; |
bb1515f2 MF |
5593 | "f(int, double)"; |
5594 | @}; | |
252b5132 RH |
5595 | @} VERS_1.2; |
5596 | @end smallexample | |
5597 | ||
5598 | This example version script defines three version nodes. The first | |
5599 | version node defined is @samp{VERS_1.1}; it has no other dependencies. | |
5600 | The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces | |
5601 | a number of symbols to local scope so that they are not visible outside | |
313e35ee AM |
5602 | of the shared library; this is done using wildcard patterns, so that any |
5603 | symbol whose name begins with @samp{old}, @samp{original}, or @samp{new} | |
5604 | is matched. The wildcard patterns available are the same as those used | |
5605 | in the shell when matching filenames (also known as ``globbing''). | |
86043bbb MM |
5606 | However, if you specify the symbol name inside double quotes, then the |
5607 | name is treated as literal, rather than as a glob pattern. | |
252b5132 RH |
5608 | |
5609 | Next, the version script defines node @samp{VERS_1.2}. This node | |
5610 | depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2} | |
5611 | to the version node @samp{VERS_1.2}. | |
5612 | ||
5613 | Finally, the version script defines node @samp{VERS_2.0}. This node | |
5614 | depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1} | |
5615 | and @samp{bar2} are bound to the version node @samp{VERS_2.0}. | |
5616 | ||
5617 | When the linker finds a symbol defined in a library which is not | |
5618 | specifically bound to a version node, it will effectively bind it to an | |
5619 | unspecified base version of the library. You can bind all otherwise | |
a981ed6f | 5620 | unspecified symbols to a given version node by using @samp{global: *;} |
ae5a3597 AM |
5621 | somewhere in the version script. Note that it's slightly crazy to use |
5622 | wildcards in a global spec except on the last version node. Global | |
5623 | wildcards elsewhere run the risk of accidentally adding symbols to the | |
5624 | set exported for an old version. That's wrong since older versions | |
5625 | ought to have a fixed set of symbols. | |
252b5132 RH |
5626 | |
5627 | The names of the version nodes have no specific meaning other than what | |
5628 | they might suggest to the person reading them. The @samp{2.0} version | |
5629 | could just as well have appeared in between @samp{1.1} and @samp{1.2}. | |
5630 | However, this would be a confusing way to write a version script. | |
5631 | ||
0f6bf451 | 5632 | Node name can be omitted, provided it is the only version node |
6b9b879a JJ |
5633 | in the version script. Such version script doesn't assign any versions to |
5634 | symbols, only selects which symbols will be globally visible out and which | |
5635 | won't. | |
5636 | ||
5637 | @smallexample | |
7c9c73be | 5638 | @{ global: foo; bar; local: *; @}; |
9d201f2f | 5639 | @end smallexample |
6b9b879a | 5640 | |
252b5132 RH |
5641 | When you link an application against a shared library that has versioned |
5642 | symbols, the application itself knows which version of each symbol it | |
5643 | requires, and it also knows which version nodes it needs from each | |
5644 | shared library it is linked against. Thus at runtime, the dynamic | |
5645 | loader can make a quick check to make sure that the libraries you have | |
5646 | linked against do in fact supply all of the version nodes that the | |
5647 | application will need to resolve all of the dynamic symbols. In this | |
5648 | way it is possible for the dynamic linker to know with certainty that | |
5649 | all external symbols that it needs will be resolvable without having to | |
5650 | search for each symbol reference. | |
5651 | ||
5652 | The symbol versioning is in effect a much more sophisticated way of | |
5653 | doing minor version checking that SunOS does. The fundamental problem | |
5654 | that is being addressed here is that typically references to external | |
5655 | functions are bound on an as-needed basis, and are not all bound when | |
5656 | the application starts up. If a shared library is out of date, a | |
5657 | required interface may be missing; when the application tries to use | |
5658 | that interface, it may suddenly and unexpectedly fail. With symbol | |
5659 | versioning, the user will get a warning when they start their program if | |
5660 | the libraries being used with the application are too old. | |
5661 | ||
5662 | There are several GNU extensions to Sun's versioning approach. The | |
5663 | first of these is the ability to bind a symbol to a version node in the | |
5664 | source file where the symbol is defined instead of in the versioning | |
5665 | script. This was done mainly to reduce the burden on the library | |
5666 | maintainer. You can do this by putting something like: | |
5667 | @smallexample | |
5668 | __asm__(".symver original_foo,foo@@VERS_1.1"); | |
5669 | @end smallexample | |
5670 | @noindent | |
5671 | in the C source file. This renames the function @samp{original_foo} to | |
5672 | be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}. | |
5673 | The @samp{local:} directive can be used to prevent the symbol | |
96a94295 L |
5674 | @samp{original_foo} from being exported. A @samp{.symver} directive |
5675 | takes precedence over a version script. | |
252b5132 RH |
5676 | |
5677 | The second GNU extension is to allow multiple versions of the same | |
5678 | function to appear in a given shared library. In this way you can make | |
5679 | an incompatible change to an interface without increasing the major | |
5680 | version number of the shared library, while still allowing applications | |
5681 | linked against the old interface to continue to function. | |
5682 | ||
5683 | To do this, you must use multiple @samp{.symver} directives in the | |
5684 | source file. Here is an example: | |
5685 | ||
5686 | @smallexample | |
5687 | __asm__(".symver original_foo,foo@@"); | |
5688 | __asm__(".symver old_foo,foo@@VERS_1.1"); | |
5689 | __asm__(".symver old_foo1,foo@@VERS_1.2"); | |
5690 | __asm__(".symver new_foo,foo@@@@VERS_2.0"); | |
5691 | @end smallexample | |
5692 | ||
5693 | In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the | |
5694 | unspecified base version of the symbol. The source file that contains this | |
5695 | example would define 4 C functions: @samp{original_foo}, @samp{old_foo}, | |
5696 | @samp{old_foo1}, and @samp{new_foo}. | |
5697 | ||
5698 | When you have multiple definitions of a given symbol, there needs to be | |
5699 | some way to specify a default version to which external references to | |
5700 | this symbol will be bound. You can do this with the | |
5701 | @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only | |
5702 | declare one version of a symbol as the default in this manner; otherwise | |
5703 | you would effectively have multiple definitions of the same symbol. | |
5704 | ||
5705 | If you wish to bind a reference to a specific version of the symbol | |
5706 | within the shared library, you can use the aliases of convenience | |
36f63dca | 5707 | (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to |
252b5132 RH |
5708 | specifically bind to an external version of the function in question. |
5709 | ||
cb840a31 L |
5710 | You can also specify the language in the version script: |
5711 | ||
5712 | @smallexample | |
5713 | VERSION extern "lang" @{ version-script-commands @} | |
5714 | @end smallexample | |
5715 | ||
c0065db7 | 5716 | The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}. |
cb840a31 L |
5717 | The linker will iterate over the list of symbols at the link time and |
5718 | demangle them according to @samp{lang} before matching them to the | |
bb1515f2 MF |
5719 | patterns specified in @samp{version-script-commands}. The default |
5720 | @samp{lang} is @samp{C}. | |
cb840a31 | 5721 | |
86043bbb MM |
5722 | Demangled names may contains spaces and other special characters. As |
5723 | described above, you can use a glob pattern to match demangled names, | |
5724 | or you can use a double-quoted string to match the string exactly. In | |
5725 | the latter case, be aware that minor differences (such as differing | |
5726 | whitespace) between the version script and the demangler output will | |
5727 | cause a mismatch. As the exact string generated by the demangler | |
5728 | might change in the future, even if the mangled name does not, you | |
5729 | should check that all of your version directives are behaving as you | |
5730 | expect when you upgrade. | |
5731 | ||
252b5132 RH |
5732 | @node Expressions |
5733 | @section Expressions in Linker Scripts | |
5734 | @cindex expressions | |
5735 | @cindex arithmetic | |
5736 | The syntax for expressions in the linker script language is identical to | |
5737 | that of C expressions. All expressions are evaluated as integers. All | |
5738 | expressions are evaluated in the same size, which is 32 bits if both the | |
5739 | host and target are 32 bits, and is otherwise 64 bits. | |
5740 | ||
5741 | You can use and set symbol values in expressions. | |
5742 | ||
5743 | The linker defines several special purpose builtin functions for use in | |
5744 | expressions. | |
5745 | ||
5746 | @menu | |
5747 | * Constants:: Constants | |
0c71d759 | 5748 | * Symbolic Constants:: Symbolic constants |
252b5132 | 5749 | * Symbols:: Symbol Names |
ecca9871 | 5750 | * Orphan Sections:: Orphan Sections |
252b5132 RH |
5751 | * Location Counter:: The Location Counter |
5752 | * Operators:: Operators | |
5753 | * Evaluation:: Evaluation | |
5754 | * Expression Section:: The Section of an Expression | |
5755 | * Builtin Functions:: Builtin Functions | |
5756 | @end menu | |
5757 | ||
5758 | @node Constants | |
5759 | @subsection Constants | |
5760 | @cindex integer notation | |
5761 | @cindex constants in linker scripts | |
5762 | All constants are integers. | |
5763 | ||
5764 | As in C, the linker considers an integer beginning with @samp{0} to be | |
5765 | octal, and an integer beginning with @samp{0x} or @samp{0X} to be | |
8a308ae8 | 5766 | hexadecimal. Alternatively the linker accepts suffixes of @samp{h} or |
11e7fd74 | 5767 | @samp{H} for hexadecimal, @samp{o} or @samp{O} for octal, @samp{b} or |
8a308ae8 NC |
5768 | @samp{B} for binary and @samp{d} or @samp{D} for decimal. Any integer |
5769 | value without a prefix or a suffix is considered to be decimal. | |
252b5132 RH |
5770 | |
5771 | @cindex scaled integers | |
5772 | @cindex K and M integer suffixes | |
5773 | @cindex M and K integer suffixes | |
5774 | @cindex suffixes for integers | |
5775 | @cindex integer suffixes | |
5776 | In addition, you can use the suffixes @code{K} and @code{M} to scale a | |
5777 | constant by | |
5778 | @c TEXI2ROFF-KILL | |
36f63dca | 5779 | @ifnottex |
252b5132 RH |
5780 | @c END TEXI2ROFF-KILL |
5781 | @code{1024} or @code{1024*1024} | |
5782 | @c TEXI2ROFF-KILL | |
36f63dca | 5783 | @end ifnottex |
252b5132 RH |
5784 | @tex |
5785 | ${\rm 1024}$ or ${\rm 1024}^2$ | |
5786 | @end tex | |
5787 | @c END TEXI2ROFF-KILL | |
8a308ae8 NC |
5788 | respectively. For example, the following |
5789 | all refer to the same quantity: | |
5790 | ||
252b5132 | 5791 | @smallexample |
36f63dca NC |
5792 | _fourk_1 = 4K; |
5793 | _fourk_2 = 4096; | |
5794 | _fourk_3 = 0x1000; | |
8a308ae8 | 5795 | _fourk_4 = 10000o; |
252b5132 RH |
5796 | @end smallexample |
5797 | ||
8a308ae8 NC |
5798 | Note - the @code{K} and @code{M} suffixes cannot be used in |
5799 | conjunction with the base suffixes mentioned above. | |
5800 | ||
0c71d759 NC |
5801 | @node Symbolic Constants |
5802 | @subsection Symbolic Constants | |
5803 | @cindex symbolic constants | |
5804 | @kindex CONSTANT | |
5805 | It is possible to refer to target specific constants via the use of | |
5806 | the @code{CONSTANT(@var{name})} operator, where @var{name} is one of: | |
5807 | ||
5808 | @table @code | |
5809 | @item MAXPAGESIZE | |
5810 | @kindex MAXPAGESIZE | |
5811 | The target's maximum page size. | |
5812 | ||
5813 | @item COMMONPAGESIZE | |
5814 | @kindex COMMONPAGESIZE | |
5815 | The target's default page size. | |
5816 | @end table | |
5817 | ||
5818 | So for example: | |
5819 | ||
5820 | @smallexample | |
9d5777a3 | 5821 | .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @} |
0c71d759 NC |
5822 | @end smallexample |
5823 | ||
5824 | will create a text section aligned to the largest page boundary | |
5825 | supported by the target. | |
5826 | ||
252b5132 RH |
5827 | @node Symbols |
5828 | @subsection Symbol Names | |
5829 | @cindex symbol names | |
5830 | @cindex names | |
5831 | @cindex quoted symbol names | |
5832 | @kindex " | |
5833 | Unless quoted, symbol names start with a letter, underscore, or period | |
5834 | and may include letters, digits, underscores, periods, and hyphens. | |
5835 | Unquoted symbol names must not conflict with any keywords. You can | |
5836 | specify a symbol which contains odd characters or has the same name as a | |
5837 | keyword by surrounding the symbol name in double quotes: | |
5838 | @smallexample | |
36f63dca NC |
5839 | "SECTION" = 9; |
5840 | "with a space" = "also with a space" + 10; | |
252b5132 RH |
5841 | @end smallexample |
5842 | ||
5843 | Since symbols can contain many non-alphabetic characters, it is safest | |
5844 | to delimit symbols with spaces. For example, @samp{A-B} is one symbol, | |
5845 | whereas @samp{A - B} is an expression involving subtraction. | |
5846 | ||
ecca9871 L |
5847 | @node Orphan Sections |
5848 | @subsection Orphan Sections | |
5849 | @cindex orphan | |
5850 | Orphan sections are sections present in the input files which | |
5851 | are not explicitly placed into the output file by the linker | |
5852 | script. The linker will still copy these sections into the | |
a87ded7b AB |
5853 | output file by either finding, or creating a suitable output section |
5854 | in which to place the orphaned input section. | |
5855 | ||
5856 | If the name of an orphaned input section exactly matches the name of | |
5857 | an existing output section, then the orphaned input section will be | |
5858 | placed at the end of that output section. | |
5859 | ||
5860 | If there is no output section with a matching name then new output | |
5861 | sections will be created. Each new output section will have the same | |
5862 | name as the orphan section placed within it. If there are multiple | |
5863 | orphan sections with the same name, these will all be combined into | |
5864 | one new output section. | |
5865 | ||
5866 | If new output sections are created to hold orphaned input sections, | |
5867 | then the linker must decide where to place these new output sections | |
e299b355 AM |
5868 | in relation to existing output sections. On most modern targets, the |
5869 | linker attempts to place orphan sections after sections of the same | |
5870 | attribute, such as code vs data, loadable vs non-loadable, etc. If no | |
5871 | sections with matching attributes are found, or your target lacks this | |
5872 | support, the orphan section is placed at the end of the file. | |
ecca9871 | 5873 | |
c005eb9e AB |
5874 | The command line options @samp{--orphan-handling} and @samp{--unique} |
5875 | (@pxref{Options,,Command Line Options}) can be used to control which | |
5876 | output sections an orphan is placed in. | |
5877 | ||
252b5132 RH |
5878 | @node Location Counter |
5879 | @subsection The Location Counter | |
5880 | @kindex . | |
5881 | @cindex dot | |
5882 | @cindex location counter | |
5883 | @cindex current output location | |
5884 | The special linker variable @dfn{dot} @samp{.} always contains the | |
5885 | current output location counter. Since the @code{.} always refers to a | |
5886 | location in an output section, it may only appear in an expression | |
5887 | within a @code{SECTIONS} command. The @code{.} symbol may appear | |
5888 | anywhere that an ordinary symbol is allowed in an expression. | |
5889 | ||
5890 | @cindex holes | |
5891 | Assigning a value to @code{.} will cause the location counter to be | |
5892 | moved. This may be used to create holes in the output section. The | |
dc0b6aa0 AM |
5893 | location counter may not be moved backwards inside an output section, |
5894 | and may not be moved backwards outside of an output section if so | |
5895 | doing creates areas with overlapping LMAs. | |
252b5132 RH |
5896 | |
5897 | @smallexample | |
5898 | SECTIONS | |
5899 | @{ | |
5900 | output : | |
5901 | @{ | |
5902 | file1(.text) | |
5903 | . = . + 1000; | |
5904 | file2(.text) | |
5905 | . += 1000; | |
5906 | file3(.text) | |
563e308f | 5907 | @} = 0x12345678; |
252b5132 RH |
5908 | @} |
5909 | @end smallexample | |
5910 | @noindent | |
5911 | In the previous example, the @samp{.text} section from @file{file1} is | |
5912 | located at the beginning of the output section @samp{output}. It is | |
5913 | followed by a 1000 byte gap. Then the @samp{.text} section from | |
5914 | @file{file2} appears, also with a 1000 byte gap following before the | |
563e308f | 5915 | @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678} |
252b5132 RH |
5916 | specifies what data to write in the gaps (@pxref{Output Section Fill}). |
5917 | ||
5c6bbab8 NC |
5918 | @cindex dot inside sections |
5919 | Note: @code{.} actually refers to the byte offset from the start of the | |
5920 | current containing object. Normally this is the @code{SECTIONS} | |
69da35b5 | 5921 | statement, whose start address is 0, hence @code{.} can be used as an |
5c6bbab8 NC |
5922 | absolute address. If @code{.} is used inside a section description |
5923 | however, it refers to the byte offset from the start of that section, | |
5924 | not an absolute address. Thus in a script like this: | |
5925 | ||
5926 | @smallexample | |
5927 | SECTIONS | |
5928 | @{ | |
5929 | . = 0x100 | |
5930 | .text: @{ | |
5931 | *(.text) | |
5932 | . = 0x200 | |
5933 | @} | |
5934 | . = 0x500 | |
5935 | .data: @{ | |
5936 | *(.data) | |
5937 | . += 0x600 | |
5938 | @} | |
5939 | @} | |
5940 | @end smallexample | |
5941 | ||
5942 | The @samp{.text} section will be assigned a starting address of 0x100 | |
5943 | and a size of exactly 0x200 bytes, even if there is not enough data in | |
5944 | the @samp{.text} input sections to fill this area. (If there is too | |
5945 | much data, an error will be produced because this would be an attempt to | |
5946 | move @code{.} backwards). The @samp{.data} section will start at 0x500 | |
5947 | and it will have an extra 0x600 bytes worth of space after the end of | |
5948 | the values from the @samp{.data} input sections and before the end of | |
5949 | the @samp{.data} output section itself. | |
5950 | ||
b5666f2f AM |
5951 | @cindex dot outside sections |
5952 | Setting symbols to the value of the location counter outside of an | |
5953 | output section statement can result in unexpected values if the linker | |
5954 | needs to place orphan sections. For example, given the following: | |
5955 | ||
5956 | @smallexample | |
5957 | SECTIONS | |
5958 | @{ | |
5959 | start_of_text = . ; | |
5960 | .text: @{ *(.text) @} | |
5961 | end_of_text = . ; | |
5962 | ||
5963 | start_of_data = . ; | |
5964 | .data: @{ *(.data) @} | |
5965 | end_of_data = . ; | |
5966 | @} | |
5967 | @end smallexample | |
5968 | ||
5969 | If the linker needs to place some input section, e.g. @code{.rodata}, | |
5970 | not mentioned in the script, it might choose to place that section | |
5971 | between @code{.text} and @code{.data}. You might think the linker | |
5972 | should place @code{.rodata} on the blank line in the above script, but | |
5973 | blank lines are of no particular significance to the linker. As well, | |
5974 | the linker doesn't associate the above symbol names with their | |
5975 | sections. Instead, it assumes that all assignments or other | |
5976 | statements belong to the previous output section, except for the | |
5977 | special case of an assignment to @code{.}. I.e., the linker will | |
5978 | place the orphan @code{.rodata} section as if the script was written | |
5979 | as follows: | |
5980 | ||
5981 | @smallexample | |
5982 | SECTIONS | |
5983 | @{ | |
5984 | start_of_text = . ; | |
5985 | .text: @{ *(.text) @} | |
5986 | end_of_text = . ; | |
5987 | ||
5988 | start_of_data = . ; | |
5989 | .rodata: @{ *(.rodata) @} | |
5990 | .data: @{ *(.data) @} | |
5991 | end_of_data = . ; | |
5992 | @} | |
5993 | @end smallexample | |
5994 | ||
5995 | This may or may not be the script author's intention for the value of | |
5996 | @code{start_of_data}. One way to influence the orphan section | |
5997 | placement is to assign the location counter to itself, as the linker | |
5998 | assumes that an assignment to @code{.} is setting the start address of | |
5999 | a following output section and thus should be grouped with that | |
6000 | section. So you could write: | |
6001 | ||
6002 | @smallexample | |
6003 | SECTIONS | |
6004 | @{ | |
6005 | start_of_text = . ; | |
6006 | .text: @{ *(.text) @} | |
6007 | end_of_text = . ; | |
6008 | ||
6009 | . = . ; | |
6010 | start_of_data = . ; | |
6011 | .data: @{ *(.data) @} | |
6012 | end_of_data = . ; | |
6013 | @} | |
6014 | @end smallexample | |
6015 | ||
6016 | Now, the orphan @code{.rodata} section will be placed between | |
6017 | @code{end_of_text} and @code{start_of_data}. | |
6018 | ||
252b5132 RH |
6019 | @need 2000 |
6020 | @node Operators | |
6021 | @subsection Operators | |
6022 | @cindex operators for arithmetic | |
6023 | @cindex arithmetic operators | |
6024 | @cindex precedence in expressions | |
6025 | The linker recognizes the standard C set of arithmetic operators, with | |
6026 | the standard bindings and precedence levels: | |
6027 | @c TEXI2ROFF-KILL | |
36f63dca | 6028 | @ifnottex |
252b5132 RH |
6029 | @c END TEXI2ROFF-KILL |
6030 | @smallexample | |
6031 | precedence associativity Operators Notes | |
6032 | (highest) | |
6033 | 1 left ! - ~ (1) | |
6034 | 2 left * / % | |
6035 | 3 left + - | |
6036 | 4 left >> << | |
6037 | 5 left == != > < <= >= | |
6038 | 6 left & | |
6039 | 7 left | | |
6040 | 8 left && | |
6041 | 9 left || | |
6042 | 10 right ? : | |
6043 | 11 right &= += -= *= /= (2) | |
6044 | (lowest) | |
6045 | @end smallexample | |
6046 | Notes: | |
a1ab1d2a | 6047 | (1) Prefix operators |
252b5132 RH |
6048 | (2) @xref{Assignments}. |
6049 | @c TEXI2ROFF-KILL | |
36f63dca | 6050 | @end ifnottex |
252b5132 RH |
6051 | @tex |
6052 | \vskip \baselineskip | |
6053 | %"lispnarrowing" is the extra indent used generally for smallexample | |
6054 | \hskip\lispnarrowing\vbox{\offinterlineskip | |
6055 | \hrule | |
6056 | \halign | |
6057 | {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr | |
6058 | height2pt&\omit&&\omit&&\omit&\cr | |
6059 | &Precedence&& Associativity &&{\rm Operators}&\cr | |
6060 | height2pt&\omit&&\omit&&\omit&\cr | |
6061 | \noalign{\hrule} | |
6062 | height2pt&\omit&&\omit&&\omit&\cr | |
6063 | &highest&&&&&\cr | |
6064 | % '176 is tilde, '~' in tt font | |
a1ab1d2a | 6065 | &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr |
252b5132 RH |
6066 | &2&&left&&* / \%&\cr |
6067 | &3&&left&&+ -&\cr | |
6068 | &4&&left&&>> <<&\cr | |
6069 | &5&&left&&== != > < <= >=&\cr | |
6070 | &6&&left&&\&&\cr | |
6071 | &7&&left&&|&\cr | |
6072 | &8&&left&&{\&\&}&\cr | |
6073 | &9&&left&&||&\cr | |
6074 | &10&&right&&? :&\cr | |
6075 | &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr | |
6076 | &lowest&&&&&\cr | |
6077 | height2pt&\omit&&\omit&&\omit&\cr} | |
6078 | \hrule} | |
6079 | @end tex | |
6080 | @iftex | |
6081 | { | |
6082 | @obeylines@parskip=0pt@parindent=0pt | |
6083 | @dag@quad Prefix operators. | |
6084 | @ddag@quad @xref{Assignments}. | |
6085 | } | |
6086 | @end iftex | |
6087 | @c END TEXI2ROFF-KILL | |
6088 | ||
6089 | @node Evaluation | |
6090 | @subsection Evaluation | |
6091 | @cindex lazy evaluation | |
6092 | @cindex expression evaluation order | |
6093 | The linker evaluates expressions lazily. It only computes the value of | |
6094 | an expression when absolutely necessary. | |
6095 | ||
6096 | The linker needs some information, such as the value of the start | |
6097 | address of the first section, and the origins and lengths of memory | |
6098 | regions, in order to do any linking at all. These values are computed | |
6099 | as soon as possible when the linker reads in the linker script. | |
6100 | ||
6101 | However, other values (such as symbol values) are not known or needed | |
6102 | until after storage allocation. Such values are evaluated later, when | |
6103 | other information (such as the sizes of output sections) is available | |
6104 | for use in the symbol assignment expression. | |
6105 | ||
6106 | The sizes of sections cannot be known until after allocation, so | |
6107 | assignments dependent upon these are not performed until after | |
6108 | allocation. | |
6109 | ||
6110 | Some expressions, such as those depending upon the location counter | |
6111 | @samp{.}, must be evaluated during section allocation. | |
6112 | ||
6113 | If the result of an expression is required, but the value is not | |
6114 | available, then an error results. For example, a script like the | |
6115 | following | |
6116 | @smallexample | |
6117 | @group | |
6118 | SECTIONS | |
6119 | @{ | |
a1ab1d2a | 6120 | .text 9+this_isnt_constant : |
252b5132 RH |
6121 | @{ *(.text) @} |
6122 | @} | |
6123 | @end group | |
6124 | @end smallexample | |
6125 | @noindent | |
6126 | will cause the error message @samp{non constant expression for initial | |
6127 | address}. | |
6128 | ||
6129 | @node Expression Section | |
6130 | @subsection The Section of an Expression | |
6131 | @cindex expression sections | |
6132 | @cindex absolute expressions | |
6133 | @cindex relative expressions | |
6134 | @cindex absolute and relocatable symbols | |
6135 | @cindex relocatable and absolute symbols | |
6136 | @cindex symbols, relocatable and absolute | |
7542af2a AM |
6137 | Addresses and symbols may be section relative, or absolute. A section |
6138 | relative symbol is relocatable. If you request relocatable output | |
6139 | using the @samp{-r} option, a further link operation may change the | |
6140 | value of a section relative symbol. On the other hand, an absolute | |
6141 | symbol will retain the same value throughout any further link | |
6142 | operations. | |
6143 | ||
abf4be64 AM |
6144 | Some terms in linker expressions are addresses. This is true of |
6145 | section relative symbols and for builtin functions that return an | |
6146 | address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and | |
6147 | @code{SEGMENT_START}. Other terms are simply numbers, or are builtin | |
6148 | functions that return a non-address value, such as @code{LENGTH}. | |
01554a74 AM |
6149 | One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")} |
6150 | (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated | |
5c3049d2 AM |
6151 | differently depending on their location, for compatibility with older |
6152 | versions of @code{ld}. Expressions appearing outside an output | |
6153 | section definition treat all numbers as absolute addresses. | |
6154 | Expressions appearing inside an output section definition treat | |
01554a74 AM |
6155 | absolute symbols as numbers. If @code{LD_FEATURE ("SANE_EXPR")} is |
6156 | given, then absolute symbols and numbers are simply treated as numbers | |
6157 | everywhere. | |
5c3049d2 AM |
6158 | |
6159 | In the following simple example, | |
252b5132 | 6160 | |
7542af2a AM |
6161 | @smallexample |
6162 | @group | |
6163 | SECTIONS | |
6164 | @{ | |
6165 | . = 0x100; | |
6166 | __executable_start = 0x100; | |
6167 | .data : | |
6168 | @{ | |
6169 | . = 0x10; | |
6170 | __data_start = 0x10; | |
6171 | *(.data) | |
6172 | @} | |
6173 | @dots{} | |
6174 | @} | |
6175 | @end group | |
6176 | @end smallexample | |
252b5132 | 6177 | |
7542af2a AM |
6178 | both @code{.} and @code{__executable_start} are set to the absolute |
6179 | address 0x100 in the first two assignments, then both @code{.} and | |
6180 | @code{__data_start} are set to 0x10 relative to the @code{.data} | |
6181 | section in the second two assignments. | |
252b5132 | 6182 | |
5c3049d2 AM |
6183 | For expressions involving numbers, relative addresses and absolute |
6184 | addresses, ld follows these rules to evaluate terms: | |
7542af2a AM |
6185 | |
6186 | @itemize @bullet | |
6187 | @item | |
c05f749e AM |
6188 | Unary operations on an absolute address or number, and binary |
6189 | operations on two absolute addresses or two numbers, or between one | |
6190 | absolute address and a number, apply the operator to the value(s). | |
6191 | @item | |
7542af2a AM |
6192 | Unary operations on a relative address, and binary operations on two |
6193 | relative addresses in the same section or between one relative address | |
6194 | and a number, apply the operator to the offset part of the address(es). | |
6195 | @item | |
c05f749e AM |
6196 | Other binary operations, that is, between two relative addresses not |
6197 | in the same section, or between a relative address and an absolute | |
6198 | address, first convert any non-absolute term to an absolute address | |
6199 | before applying the operator. | |
7542af2a AM |
6200 | @end itemize |
6201 | ||
6202 | The result section of each sub-expression is as follows: | |
6203 | ||
6204 | @itemize @bullet | |
6205 | @item | |
6206 | An operation involving only numbers results in a number. | |
6207 | @item | |
6208 | The result of comparisons, @samp{&&} and @samp{||} is also a number. | |
6209 | @item | |
9bc8bb33 | 6210 | The result of other binary arithmetic and logical operations on two |
11e7fd74 | 6211 | relative addresses in the same section or two absolute addresses |
94b41882 AM |
6212 | (after above conversions) is also a number when |
6213 | @code{LD_FEATURE ("SANE_EXPR")} or inside an output section definition | |
6214 | but an absolute address otherwise. | |
9bc8bb33 AM |
6215 | @item |
6216 | The result of other operations on relative addresses or one | |
6217 | relative address and a number, is a relative address in the same | |
6218 | section as the relative operand(s). | |
7542af2a AM |
6219 | @item |
6220 | The result of other operations on absolute addresses (after above | |
6221 | conversions) is an absolute address. | |
6222 | @end itemize | |
252b5132 RH |
6223 | |
6224 | You can use the builtin function @code{ABSOLUTE} to force an expression | |
6225 | to be absolute when it would otherwise be relative. For example, to | |
6226 | create an absolute symbol set to the address of the end of the output | |
6227 | section @samp{.data}: | |
6228 | @smallexample | |
6229 | SECTIONS | |
6230 | @{ | |
6231 | .data : @{ *(.data) _edata = ABSOLUTE(.); @} | |
6232 | @} | |
6233 | @end smallexample | |
6234 | @noindent | |
6235 | If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the | |
6236 | @samp{.data} section. | |
6237 | ||
7542af2a AM |
6238 | Using @code{LOADADDR} also forces an expression absolute, since this |
6239 | particular builtin function returns an absolute address. | |
6240 | ||
252b5132 RH |
6241 | @node Builtin Functions |
6242 | @subsection Builtin Functions | |
6243 | @cindex functions in expressions | |
6244 | The linker script language includes a number of builtin functions for | |
6245 | use in linker script expressions. | |
6246 | ||
6247 | @table @code | |
6248 | @item ABSOLUTE(@var{exp}) | |
6249 | @kindex ABSOLUTE(@var{exp}) | |
6250 | @cindex expression, absolute | |
6251 | Return the absolute (non-relocatable, as opposed to non-negative) value | |
6252 | of the expression @var{exp}. Primarily useful to assign an absolute | |
6253 | value to a symbol within a section definition, where symbol values are | |
6254 | normally section relative. @xref{Expression Section}. | |
6255 | ||
6256 | @item ADDR(@var{section}) | |
6257 | @kindex ADDR(@var{section}) | |
6258 | @cindex section address in expression | |
7542af2a | 6259 | Return the address (VMA) of the named @var{section}. Your |
252b5132 | 6260 | script must previously have defined the location of that section. In |
7542af2a AM |
6261 | the following example, @code{start_of_output_1}, @code{symbol_1} and |
6262 | @code{symbol_2} are assigned equivalent values, except that | |
6263 | @code{symbol_1} will be relative to the @code{.output1} section while | |
6264 | the other two will be absolute: | |
252b5132 RH |
6265 | @smallexample |
6266 | @group | |
6267 | SECTIONS @{ @dots{} | |
6268 | .output1 : | |
a1ab1d2a | 6269 | @{ |
252b5132 RH |
6270 | start_of_output_1 = ABSOLUTE(.); |
6271 | @dots{} | |
6272 | @} | |
6273 | .output : | |
6274 | @{ | |
6275 | symbol_1 = ADDR(.output1); | |
6276 | symbol_2 = start_of_output_1; | |
6277 | @} | |
6278 | @dots{} @} | |
6279 | @end group | |
6280 | @end smallexample | |
6281 | ||
876f4090 NS |
6282 | @item ALIGN(@var{align}) |
6283 | @itemx ALIGN(@var{exp},@var{align}) | |
6284 | @kindex ALIGN(@var{align}) | |
6285 | @kindex ALIGN(@var{exp},@var{align}) | |
252b5132 RH |
6286 | @cindex round up location counter |
6287 | @cindex align location counter | |
876f4090 NS |
6288 | @cindex round up expression |
6289 | @cindex align expression | |
6290 | Return the location counter (@code{.}) or arbitrary expression aligned | |
6291 | to the next @var{align} boundary. The single operand @code{ALIGN} | |
6292 | doesn't change the value of the location counter---it just does | |
6293 | arithmetic on it. The two operand @code{ALIGN} allows an arbitrary | |
6294 | expression to be aligned upwards (@code{ALIGN(@var{align})} is | |
e0a3af22 | 6295 | equivalent to @code{ALIGN(ABSOLUTE(.), @var{align})}). |
876f4090 NS |
6296 | |
6297 | Here is an example which aligns the output @code{.data} section to the | |
6298 | next @code{0x2000} byte boundary after the preceding section and sets a | |
6299 | variable within the section to the next @code{0x8000} boundary after the | |
6300 | input sections: | |
252b5132 RH |
6301 | @smallexample |
6302 | @group | |
6303 | SECTIONS @{ @dots{} | |
6304 | .data ALIGN(0x2000): @{ | |
6305 | *(.data) | |
6306 | variable = ALIGN(0x8000); | |
6307 | @} | |
6308 | @dots{} @} | |
6309 | @end group | |
6310 | @end smallexample | |
6311 | @noindent | |
6312 | The first use of @code{ALIGN} in this example specifies the location of | |
6313 | a section because it is used as the optional @var{address} attribute of | |
6314 | a section definition (@pxref{Output Section Address}). The second use | |
6315 | of @code{ALIGN} is used to defines the value of a symbol. | |
6316 | ||
6317 | The builtin function @code{NEXT} is closely related to @code{ALIGN}. | |
6318 | ||
362c1d1a NS |
6319 | @item ALIGNOF(@var{section}) |
6320 | @kindex ALIGNOF(@var{section}) | |
6321 | @cindex section alignment | |
6322 | Return the alignment in bytes of the named @var{section}, if that section has | |
6323 | been allocated. If the section has not been allocated when this is | |
6324 | evaluated, the linker will report an error. In the following example, | |
6325 | the alignment of the @code{.output} section is stored as the first | |
6326 | value in that section. | |
6327 | @smallexample | |
6328 | @group | |
6329 | SECTIONS@{ @dots{} | |
6330 | .output @{ | |
6331 | LONG (ALIGNOF (.output)) | |
6332 | @dots{} | |
6333 | @} | |
6334 | @dots{} @} | |
6335 | @end group | |
6336 | @end smallexample | |
6337 | ||
252b5132 RH |
6338 | @item BLOCK(@var{exp}) |
6339 | @kindex BLOCK(@var{exp}) | |
6340 | This is a synonym for @code{ALIGN}, for compatibility with older linker | |
6341 | scripts. It is most often seen when setting the address of an output | |
6342 | section. | |
6343 | ||
2d20f7bf JJ |
6344 | @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) |
6345 | @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) | |
6346 | This is equivalent to either | |
6347 | @smallexample | |
6348 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1))) | |
6349 | @end smallexample | |
6350 | or | |
6351 | @smallexample | |
fe6052e1 AM |
6352 | (ALIGN(@var{maxpagesize}) |
6353 | + ((. + @var{commonpagesize} - 1) & (@var{maxpagesize} - @var{commonpagesize}))) | |
2d20f7bf JJ |
6354 | @end smallexample |
6355 | @noindent | |
6356 | depending on whether the latter uses fewer @var{commonpagesize} sized pages | |
6357 | for the data segment (area between the result of this expression and | |
6358 | @code{DATA_SEGMENT_END}) than the former or not. | |
6359 | If the latter form is used, it means @var{commonpagesize} bytes of runtime | |
6360 | memory will be saved at the expense of up to @var{commonpagesize} wasted | |
6361 | bytes in the on-disk file. | |
6362 | ||
6363 | This expression can only be used directly in @code{SECTIONS} commands, not in | |
6364 | any output section descriptions and only once in the linker script. | |
6365 | @var{commonpagesize} should be less or equal to @var{maxpagesize} and should | |
def5c83c AM |
6366 | be the system page size the object wants to be optimized for while still |
6367 | running on system page sizes up to @var{maxpagesize}. Note however | |
6368 | that @samp{-z relro} protection will not be effective if the system | |
6369 | page size is larger than @var{commonpagesize}. | |
2d20f7bf JJ |
6370 | |
6371 | @noindent | |
6372 | Example: | |
6373 | @smallexample | |
6374 | . = DATA_SEGMENT_ALIGN(0x10000, 0x2000); | |
6375 | @end smallexample | |
6376 | ||
6377 | @item DATA_SEGMENT_END(@var{exp}) | |
6378 | @kindex DATA_SEGMENT_END(@var{exp}) | |
6379 | This defines the end of data segment for @code{DATA_SEGMENT_ALIGN} | |
6380 | evaluation purposes. | |
6381 | ||
6382 | @smallexample | |
6383 | . = DATA_SEGMENT_END(.); | |
6384 | @end smallexample | |
6385 | ||
a4f5ad88 JJ |
6386 | @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) |
6387 | @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) | |
6388 | This defines the end of the @code{PT_GNU_RELRO} segment when | |
eec2f3ed | 6389 | @samp{-z relro} option is used. |
a4f5ad88 JJ |
6390 | When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END} |
6391 | does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that | |
def5c83c AM |
6392 | @var{exp} + @var{offset} is aligned to the @var{commonpagesize} |
6393 | argument given to @code{DATA_SEGMENT_ALIGN}. If present in the linker | |
6394 | script, it must be placed between @code{DATA_SEGMENT_ALIGN} and | |
eec2f3ed AM |
6395 | @code{DATA_SEGMENT_END}. Evaluates to the second argument plus any |
6396 | padding needed at the end of the @code{PT_GNU_RELRO} segment due to | |
6397 | section alignment. | |
a4f5ad88 JJ |
6398 | |
6399 | @smallexample | |
6400 | . = DATA_SEGMENT_RELRO_END(24, .); | |
6401 | @end smallexample | |
6402 | ||
252b5132 RH |
6403 | @item DEFINED(@var{symbol}) |
6404 | @kindex DEFINED(@var{symbol}) | |
6405 | @cindex symbol defaults | |
6406 | Return 1 if @var{symbol} is in the linker global symbol table and is | |
420e579c HPN |
6407 | defined before the statement using DEFINED in the script, otherwise |
6408 | return 0. You can use this function to provide | |
252b5132 RH |
6409 | default values for symbols. For example, the following script fragment |
6410 | shows how to set a global symbol @samp{begin} to the first location in | |
6411 | the @samp{.text} section---but if a symbol called @samp{begin} already | |
6412 | existed, its value is preserved: | |
6413 | ||
6414 | @smallexample | |
6415 | @group | |
6416 | SECTIONS @{ @dots{} | |
6417 | .text : @{ | |
6418 | begin = DEFINED(begin) ? begin : . ; | |
6419 | @dots{} | |
6420 | @} | |
6421 | @dots{} | |
6422 | @} | |
6423 | @end group | |
6424 | @end smallexample | |
6425 | ||
3ec57632 NC |
6426 | @item LENGTH(@var{memory}) |
6427 | @kindex LENGTH(@var{memory}) | |
6428 | Return the length of the memory region named @var{memory}. | |
6429 | ||
252b5132 RH |
6430 | @item LOADADDR(@var{section}) |
6431 | @kindex LOADADDR(@var{section}) | |
6432 | @cindex section load address in expression | |
7542af2a | 6433 | Return the absolute LMA of the named @var{section}. (@pxref{Output |
252b5132 RH |
6434 | Section LMA}). |
6435 | ||
2e53f7d6 NC |
6436 | @item LOG2CEIL(@var{exp}) |
6437 | @kindex LOG2CEIL(@var{exp}) | |
6438 | Return the binary logarithm of @var{exp} rounded towards infinity. | |
6439 | @code{LOG2CEIL(0)} returns 0. | |
6440 | ||
252b5132 RH |
6441 | @kindex MAX |
6442 | @item MAX(@var{exp1}, @var{exp2}) | |
6443 | Returns the maximum of @var{exp1} and @var{exp2}. | |
6444 | ||
6445 | @kindex MIN | |
6446 | @item MIN(@var{exp1}, @var{exp2}) | |
6447 | Returns the minimum of @var{exp1} and @var{exp2}. | |
6448 | ||
6449 | @item NEXT(@var{exp}) | |
6450 | @kindex NEXT(@var{exp}) | |
6451 | @cindex unallocated address, next | |
6452 | Return the next unallocated address that is a multiple of @var{exp}. | |
6453 | This function is closely related to @code{ALIGN(@var{exp})}; unless you | |
6454 | use the @code{MEMORY} command to define discontinuous memory for the | |
6455 | output file, the two functions are equivalent. | |
6456 | ||
3ec57632 NC |
6457 | @item ORIGIN(@var{memory}) |
6458 | @kindex ORIGIN(@var{memory}) | |
6459 | Return the origin of the memory region named @var{memory}. | |
6460 | ||
ba916c8a MM |
6461 | @item SEGMENT_START(@var{segment}, @var{default}) |
6462 | @kindex SEGMENT_START(@var{segment}, @var{default}) | |
6463 | Return the base address of the named @var{segment}. If an explicit | |
c5da8c7d NC |
6464 | value has already been given for this segment (with a command-line |
6465 | @samp{-T} option) then that value will be returned otherwise the value | |
6466 | will be @var{default}. At present, the @samp{-T} command-line option | |
6467 | can only be used to set the base address for the ``text'', ``data'', and | |
7542af2a | 6468 | ``bss'' sections, but you can use @code{SEGMENT_START} with any segment |
ba916c8a MM |
6469 | name. |
6470 | ||
252b5132 RH |
6471 | @item SIZEOF(@var{section}) |
6472 | @kindex SIZEOF(@var{section}) | |
6473 | @cindex section size | |
6474 | Return the size in bytes of the named @var{section}, if that section has | |
6475 | been allocated. If the section has not been allocated when this is | |
6476 | evaluated, the linker will report an error. In the following example, | |
6477 | @code{symbol_1} and @code{symbol_2} are assigned identical values: | |
6478 | @smallexample | |
6479 | @group | |
6480 | SECTIONS@{ @dots{} | |
6481 | .output @{ | |
6482 | .start = . ; | |
6483 | @dots{} | |
6484 | .end = . ; | |
6485 | @} | |
6486 | symbol_1 = .end - .start ; | |
6487 | symbol_2 = SIZEOF(.output); | |
6488 | @dots{} @} | |
6489 | @end group | |
6490 | @end smallexample | |
6491 | ||
6492 | @item SIZEOF_HEADERS | |
6493 | @itemx sizeof_headers | |
6494 | @kindex SIZEOF_HEADERS | |
6495 | @cindex header size | |
6496 | Return the size in bytes of the output file's headers. This is | |
6497 | information which appears at the start of the output file. You can use | |
6498 | this number when setting the start address of the first section, if you | |
6499 | choose, to facilitate paging. | |
6500 | ||
6501 | @cindex not enough room for program headers | |
6502 | @cindex program headers, not enough room | |
6503 | When producing an ELF output file, if the linker script uses the | |
6504 | @code{SIZEOF_HEADERS} builtin function, the linker must compute the | |
6505 | number of program headers before it has determined all the section | |
6506 | addresses and sizes. If the linker later discovers that it needs | |
6507 | additional program headers, it will report an error @samp{not enough | |
6508 | room for program headers}. To avoid this error, you must avoid using | |
6509 | the @code{SIZEOF_HEADERS} function, or you must rework your linker | |
6510 | script to avoid forcing the linker to use additional program headers, or | |
6511 | you must define the program headers yourself using the @code{PHDRS} | |
6512 | command (@pxref{PHDRS}). | |
6513 | @end table | |
6514 | ||
6515 | @node Implicit Linker Scripts | |
6516 | @section Implicit Linker Scripts | |
6517 | @cindex implicit linker scripts | |
6518 | If you specify a linker input file which the linker can not recognize as | |
6519 | an object file or an archive file, it will try to read the file as a | |
6520 | linker script. If the file can not be parsed as a linker script, the | |
6521 | linker will report an error. | |
6522 | ||
6523 | An implicit linker script will not replace the default linker script. | |
6524 | ||
6525 | Typically an implicit linker script would contain only symbol | |
6526 | assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION} | |
6527 | commands. | |
6528 | ||
6529 | Any input files read because of an implicit linker script will be read | |
6530 | at the position in the command line where the implicit linker script was | |
6531 | read. This can affect archive searching. | |
6532 | ||
6533 | @ifset GENERIC | |
6534 | @node Machine Dependent | |
6535 | @chapter Machine Dependent Features | |
6536 | ||
6537 | @cindex machine dependencies | |
ff5dcc92 SC |
6538 | @command{ld} has additional features on some platforms; the following |
6539 | sections describe them. Machines where @command{ld} has no additional | |
252b5132 RH |
6540 | functionality are not listed. |
6541 | ||
6542 | @menu | |
36f63dca NC |
6543 | @ifset H8300 |
6544 | * H8/300:: @command{ld} and the H8/300 | |
6545 | @end ifset | |
7ca01ed9 NC |
6546 | @ifset M68HC11 |
6547 | * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families | |
6548 | @end ifset | |
36f63dca NC |
6549 | @ifset ARM |
6550 | * ARM:: @command{ld} and the ARM family | |
6551 | @end ifset | |
6552 | @ifset HPPA | |
6553 | * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF | |
6554 | @end ifset | |
7fb9f789 NC |
6555 | @ifset M68K |
6556 | * M68K:: @command{ld} and the Motorola 68K family | |
6557 | @end ifset | |
833794fc MR |
6558 | @ifset MIPS |
6559 | * MIPS:: @command{ld} and the MIPS family | |
6560 | @end ifset | |
3c3bdf30 | 6561 | @ifset MMIX |
36f63dca | 6562 | * MMIX:: @command{ld} and MMIX |
3c3bdf30 | 6563 | @end ifset |
2469cfa2 | 6564 | @ifset MSP430 |
36f63dca | 6565 | * MSP430:: @command{ld} and MSP430 |
2469cfa2 | 6566 | @end ifset |
35c08157 KLC |
6567 | @ifset NDS32 |
6568 | * NDS32:: @command{ld} and NDS32 | |
6569 | @end ifset | |
78058a5e SL |
6570 | @ifset NIOSII |
6571 | * Nios II:: @command{ld} and the Altera Nios II | |
6572 | @end ifset | |
2a60a7a8 AM |
6573 | @ifset POWERPC |
6574 | * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support | |
6575 | @end ifset | |
6576 | @ifset POWERPC64 | |
6577 | * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support | |
6578 | @end ifset | |
b4cbbe8f AK |
6579 | @ifset S/390 |
6580 | * S/390 ELF:: @command{ld} and S/390 ELF Support | |
6581 | @end ifset | |
49fa1e15 AM |
6582 | @ifset SPU |
6583 | * SPU ELF:: @command{ld} and SPU ELF Support | |
6584 | @end ifset | |
74459f0e | 6585 | @ifset TICOFF |
ff5dcc92 | 6586 | * TI COFF:: @command{ld} and TI COFF |
74459f0e | 6587 | @end ifset |
2ca22b03 NC |
6588 | @ifset WIN32 |
6589 | * WIN32:: @command{ld} and WIN32 (cygwin/mingw) | |
6590 | @end ifset | |
e0001a05 NC |
6591 | @ifset XTENSA |
6592 | * Xtensa:: @command{ld} and Xtensa Processors | |
6593 | @end ifset | |
252b5132 RH |
6594 | @end menu |
6595 | @end ifset | |
6596 | ||
252b5132 RH |
6597 | @ifset H8300 |
6598 | @ifclear GENERIC | |
6599 | @raisesections | |
6600 | @end ifclear | |
6601 | ||
6602 | @node H8/300 | |
ff5dcc92 | 6603 | @section @command{ld} and the H8/300 |
252b5132 RH |
6604 | |
6605 | @cindex H8/300 support | |
ff5dcc92 | 6606 | For the H8/300, @command{ld} can perform these global optimizations when |
252b5132 RH |
6607 | you specify the @samp{--relax} command-line option. |
6608 | ||
6609 | @table @emph | |
6610 | @cindex relaxing on H8/300 | |
6611 | @item relaxing address modes | |
ff5dcc92 | 6612 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose |
252b5132 RH |
6613 | targets are within eight bits, and turns them into eight-bit |
6614 | program-counter relative @code{bsr} and @code{bra} instructions, | |
6615 | respectively. | |
6616 | ||
6617 | @cindex synthesizing on H8/300 | |
6618 | @item synthesizing instructions | |
81f5558e | 6619 | @c FIXME: specifically mov.b, or any mov instructions really? -> mov.b only, at least on H8, H8H, H8S |
ff5dcc92 | 6620 | @command{ld} finds all @code{mov.b} instructions which use the |
252b5132 RH |
6621 | sixteen-bit absolute address form, but refer to the top |
6622 | page of memory, and changes them to use the eight-bit address form. | |
6623 | (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into | |
6624 | @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the | |
6625 | top page of memory). | |
1502569c | 6626 | |
81f5558e NC |
6627 | @command{ld} finds all @code{mov} instructions which use the register |
6628 | indirect with 32-bit displacement addressing mode, but use a small | |
6629 | displacement inside 16-bit displacement range, and changes them to use | |
6630 | the 16-bit displacement form. (That is: the linker turns @samp{mov.b | |
6631 | @code{@@}@var{d}:32,ERx} into @samp{mov.b @code{@@}@var{d}:16,ERx} | |
6632 | whenever the displacement @var{d} is in the 16 bit signed integer | |
6633 | range. Only implemented in ELF-format ld). | |
6634 | ||
1502569c | 6635 | @item bit manipulation instructions |
c0065db7 | 6636 | @command{ld} finds all bit manipulation instructions like @code{band, bclr, |
1502569c | 6637 | biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor} |
c0065db7 | 6638 | which use 32 bit and 16 bit absolute address form, but refer to the top |
1502569c NC |
6639 | page of memory, and changes them to use the 8 bit address form. |
6640 | (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into | |
c0065db7 | 6641 | @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in |
1502569c NC |
6642 | the top page of memory). |
6643 | ||
6644 | @item system control instructions | |
c0065db7 RM |
6645 | @command{ld} finds all @code{ldc.w, stc.w} instructions which use the |
6646 | 32 bit absolute address form, but refer to the top page of memory, and | |
1502569c NC |
6647 | changes them to use 16 bit address form. |
6648 | (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into | |
c0065db7 | 6649 | @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in |
1502569c | 6650 | the top page of memory). |
252b5132 RH |
6651 | @end table |
6652 | ||
6653 | @ifclear GENERIC | |
6654 | @lowersections | |
6655 | @end ifclear | |
6656 | @end ifset | |
6657 | ||
36f63dca | 6658 | @ifclear GENERIC |
c2dcd04e | 6659 | @ifset Renesas |
36f63dca | 6660 | @c This stuff is pointless to say unless you're especially concerned |
c2dcd04e NC |
6661 | @c with Renesas chips; don't enable it for generic case, please. |
6662 | @node Renesas | |
6663 | @chapter @command{ld} and Other Renesas Chips | |
36f63dca | 6664 | |
c2dcd04e NC |
6665 | @command{ld} also supports the Renesas (formerly Hitachi) H8/300H, |
6666 | H8/500, and SH chips. No special features, commands, or command-line | |
6667 | options are required for these chips. | |
36f63dca NC |
6668 | @end ifset |
6669 | @end ifclear | |
6670 | ||
36f63dca NC |
6671 | @ifset ARM |
6672 | @ifclear GENERIC | |
6673 | @raisesections | |
6674 | @end ifclear | |
6675 | ||
93fd0973 SC |
6676 | @ifset M68HC11 |
6677 | @ifclear GENERIC | |
6678 | @raisesections | |
6679 | @end ifclear | |
6680 | ||
6681 | @node M68HC11/68HC12 | |
6682 | @section @command{ld} and the Motorola 68HC11 and 68HC12 families | |
6683 | ||
6684 | @cindex M68HC11 and 68HC12 support | |
6685 | ||
6686 | @subsection Linker Relaxation | |
6687 | ||
6688 | For the Motorola 68HC11, @command{ld} can perform these global | |
6689 | optimizations when you specify the @samp{--relax} command-line option. | |
6690 | ||
6691 | @table @emph | |
6692 | @cindex relaxing on M68HC11 | |
6693 | @item relaxing address modes | |
6694 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose | |
6695 | targets are within eight bits, and turns them into eight-bit | |
6696 | program-counter relative @code{bsr} and @code{bra} instructions, | |
6697 | respectively. | |
6698 | ||
6699 | @command{ld} also looks at all 16-bit extended addressing modes and | |
6700 | transforms them in a direct addressing mode when the address is in | |
6701 | page 0 (between 0 and 0x0ff). | |
6702 | ||
6703 | @item relaxing gcc instruction group | |
6704 | When @command{gcc} is called with @option{-mrelax}, it can emit group | |
6705 | of instructions that the linker can optimize to use a 68HC11 direct | |
6706 | addressing mode. These instructions consists of @code{bclr} or | |
6707 | @code{bset} instructions. | |
6708 | ||
6709 | @end table | |
6710 | ||
6711 | @subsection Trampoline Generation | |
6712 | ||
6713 | @cindex trampoline generation on M68HC11 | |
6714 | @cindex trampoline generation on M68HC12 | |
6715 | For 68HC11 and 68HC12, @command{ld} can generate trampoline code to | |
6716 | call a far function using a normal @code{jsr} instruction. The linker | |
c0065db7 | 6717 | will also change the relocation to some far function to use the |
93fd0973 SC |
6718 | trampoline address instead of the function address. This is typically the |
6719 | case when a pointer to a function is taken. The pointer will in fact | |
6720 | point to the function trampoline. | |
6721 | ||
6722 | @ifclear GENERIC | |
6723 | @lowersections | |
6724 | @end ifclear | |
6725 | @end ifset | |
6726 | ||
36f63dca | 6727 | @node ARM |
3674e28a | 6728 | @section @command{ld} and the ARM family |
36f63dca NC |
6729 | |
6730 | @cindex ARM interworking support | |
6731 | @kindex --support-old-code | |
6732 | For the ARM, @command{ld} will generate code stubs to allow functions calls | |
b45619c0 | 6733 | between ARM and Thumb code. These stubs only work with code that has |
36f63dca NC |
6734 | been compiled and assembled with the @samp{-mthumb-interwork} command |
6735 | line option. If it is necessary to link with old ARM object files or | |
6736 | libraries, which have not been compiled with the -mthumb-interwork | |
6737 | option then the @samp{--support-old-code} command line switch should be | |
6738 | given to the linker. This will make it generate larger stub functions | |
6739 | which will work with non-interworking aware ARM code. Note, however, | |
6740 | the linker does not support generating stubs for function calls to | |
6741 | non-interworking aware Thumb code. | |
6742 | ||
6743 | @cindex thumb entry point | |
6744 | @cindex entry point, thumb | |
6745 | @kindex --thumb-entry=@var{entry} | |
6746 | The @samp{--thumb-entry} switch is a duplicate of the generic | |
6747 | @samp{--entry} switch, in that it sets the program's starting address. | |
6748 | But it also sets the bottom bit of the address, so that it can be | |
6749 | branched to using a BX instruction, and the program will start | |
6750 | executing in Thumb mode straight away. | |
6751 | ||
ce11ba6c KT |
6752 | @cindex PE import table prefixing |
6753 | @kindex --use-nul-prefixed-import-tables | |
6754 | The @samp{--use-nul-prefixed-import-tables} switch is specifying, that | |
6755 | the import tables idata4 and idata5 have to be generated with a zero | |
11e7fd74 | 6756 | element prefix for import libraries. This is the old style to generate |
ce11ba6c KT |
6757 | import tables. By default this option is turned off. |
6758 | ||
e489d0ae PB |
6759 | @cindex BE8 |
6760 | @kindex --be8 | |
6761 | The @samp{--be8} switch instructs @command{ld} to generate BE8 format | |
080bb7bb NC |
6762 | executables. This option is only valid when linking big-endian |
6763 | objects - ie ones which have been assembled with the @option{-EB} | |
6764 | option. The resulting image will contain big-endian data and | |
6765 | little-endian code. | |
e489d0ae | 6766 | |
3674e28a PB |
6767 | @cindex TARGET1 |
6768 | @kindex --target1-rel | |
6769 | @kindex --target1-abs | |
6770 | The @samp{R_ARM_TARGET1} relocation is typically used for entries in the | |
6771 | @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32} | |
6772 | or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel} | |
6773 | and @samp{--target1-abs} switches override the default. | |
6774 | ||
6775 | @cindex TARGET2 | |
6776 | @kindex --target2=@var{type} | |
6777 | The @samp{--target2=type} switch overrides the default definition of the | |
6778 | @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their | |
6779 | meanings, and target defaults are as follows: | |
6780 | @table @samp | |
6781 | @item rel | |
eeac373a PB |
6782 | @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi) |
6783 | @item abs | |
6784 | @samp{R_ARM_ABS32} (arm*-*-symbianelf) | |
3674e28a PB |
6785 | @item got-rel |
6786 | @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd) | |
6787 | @end table | |
6788 | ||
319850b4 JB |
6789 | @cindex FIX_V4BX |
6790 | @kindex --fix-v4bx | |
6791 | The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF | |
6792 | specification) enables objects compiled for the ARMv4 architecture to be | |
6793 | interworking-safe when linked with other objects compiled for ARMv4t, but | |
6794 | also allows pure ARMv4 binaries to be built from the same ARMv4 objects. | |
6795 | ||
6796 | In the latter case, the switch @option{--fix-v4bx} must be passed to the | |
6797 | linker, which causes v4t @code{BX rM} instructions to be rewritten as | |
6798 | @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction. | |
6799 | ||
6800 | In the former case, the switch should not be used, and @samp{R_ARM_V4BX} | |
6801 | relocations are ignored. | |
6802 | ||
845b51d6 PB |
6803 | @cindex FIX_V4BX_INTERWORKING |
6804 | @kindex --fix-v4bx-interworking | |
6805 | Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX} | |
6806 | relocations with a branch to the following veneer: | |
6807 | ||
6808 | @smallexample | |
6809 | TST rM, #1 | |
6810 | MOVEQ PC, rM | |
6811 | BX Rn | |
6812 | @end smallexample | |
6813 | ||
6814 | This allows generation of libraries/applications that work on ARMv4 cores | |
6815 | and are still interworking safe. Note that the above veneer clobbers the | |
11e7fd74 | 6816 | condition flags, so may cause incorrect program behavior in rare cases. |
845b51d6 | 6817 | |
33bfe774 JB |
6818 | @cindex USE_BLX |
6819 | @kindex --use-blx | |
6820 | The @samp{--use-blx} switch enables the linker to use ARM/Thumb | |
6821 | BLX instructions (available on ARMv5t and above) in various | |
6822 | situations. Currently it is used to perform calls via the PLT from Thumb | |
6823 | code using BLX rather than using BX and a mode-switching stub before | |
6824 | each PLT entry. This should lead to such calls executing slightly faster. | |
6825 | ||
6826 | This option is enabled implicitly for SymbianOS, so there is no need to | |
6827 | specify it if you are using that target. | |
6828 | ||
c6dd86c6 JB |
6829 | @cindex VFP11_DENORM_FIX |
6830 | @kindex --vfp11-denorm-fix | |
6831 | The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a | |
6832 | bug in certain VFP11 coprocessor hardware, which sometimes allows | |
6833 | instructions with denorm operands (which must be handled by support code) | |
6834 | to have those operands overwritten by subsequent instructions before | |
6835 | the support code can read the intended values. | |
6836 | ||
6837 | The bug may be avoided in scalar mode if you allow at least one | |
6838 | intervening instruction between a VFP11 instruction which uses a register | |
6839 | and another instruction which writes to the same register, or at least two | |
6840 | intervening instructions if vector mode is in use. The bug only affects | |
6841 | full-compliance floating-point mode: you do not need this workaround if | |
6842 | you are using "runfast" mode. Please contact ARM for further details. | |
6843 | ||
6844 | If you know you are using buggy VFP11 hardware, you can | |
6845 | enable this workaround by specifying the linker option | |
6846 | @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar | |
6847 | mode only, or @samp{--vfp-denorm-fix=vector} if you are using | |
6848 | vector mode (the latter also works for scalar code). The default is | |
6849 | @samp{--vfp-denorm-fix=none}. | |
6850 | ||
6851 | If the workaround is enabled, instructions are scanned for | |
6852 | potentially-troublesome sequences, and a veneer is created for each | |
6853 | such sequence which may trigger the erratum. The veneer consists of the | |
6854 | first instruction of the sequence and a branch back to the subsequent | |
6855 | instruction. The original instruction is then replaced with a branch to | |
6856 | the veneer. The extra cycles required to call and return from the veneer | |
6857 | are sufficient to avoid the erratum in both the scalar and vector cases. | |
6858 | ||
2de70689 MGD |
6859 | @cindex ARM1176 erratum workaround |
6860 | @kindex --fix-arm1176 | |
6861 | @kindex --no-fix-arm1176 | |
9d5777a3 RM |
6862 | The @samp{--fix-arm1176} switch enables a link-time workaround for an erratum |
6863 | in certain ARM1176 processors. The workaround is enabled by default if you | |
6864 | are targeting ARM v6 (excluding ARM v6T2) or earlier. It can be disabled | |
2de70689 MGD |
6865 | unconditionally by specifying @samp{--no-fix-arm1176}. |
6866 | ||
9d5777a3 | 6867 | Further information is available in the ``ARM1176JZ-S and ARM1176JZF-S |
11e7fd74 | 6868 | Programmer Advice Notice'' available on the ARM documentation website at: |
2de70689 MGD |
6869 | http://infocenter.arm.com/. |
6870 | ||
a504d23a LA |
6871 | @cindex STM32L4xx erratum workaround |
6872 | @kindex --fix-stm32l4xx-629360 | |
6873 | ||
6874 | The @samp{--fix-stm32l4xx-629360} switch enables a link-time | |
6875 | workaround for a bug in the bus matrix / memory controller for some of | |
6876 | the STM32 Cortex-M4 based products (STM32L4xx). When accessing | |
6877 | off-chip memory via the affected bus for bus reads of 9 words or more, | |
6878 | the bus can generate corrupt data and/or abort. These are only | |
6879 | core-initiated accesses (not DMA), and might affect any access: | |
6880 | integer loads such as LDM, POP and floating-point loads such as VLDM, | |
6881 | VPOP. Stores are not affected. | |
6882 | ||
6883 | The bug can be avoided by splitting memory accesses into the | |
6884 | necessary chunks to keep bus reads below 8 words. | |
6885 | ||
6886 | The workaround is not enabled by default, this is equivalent to use | |
6887 | @samp{--fix-stm32l4xx-629360=none}. If you know you are using buggy | |
6888 | STM32L4xx hardware, you can enable the workaround by specifying the | |
6889 | linker option @samp{--fix-stm32l4xx-629360}, or the equivalent | |
6890 | @samp{--fix-stm32l4xx-629360=default}. | |
6891 | ||
6892 | If the workaround is enabled, instructions are scanned for | |
6893 | potentially-troublesome sequences, and a veneer is created for each | |
6894 | such sequence which may trigger the erratum. The veneer consists in a | |
6895 | replacement sequence emulating the behaviour of the original one and a | |
6896 | branch back to the subsequent instruction. The original instruction is | |
6897 | then replaced with a branch to the veneer. | |
6898 | ||
6899 | The workaround does not always preserve the memory access order for | |
6900 | the LDMDB instruction, when the instruction loads the PC. | |
6901 | ||
6902 | The workaround is not able to handle problematic instructions when | |
6903 | they are in the middle of an IT block, since a branch is not allowed | |
6904 | there. In that case, the linker reports a warning and no replacement | |
6905 | occurs. | |
6906 | ||
6907 | The workaround is not able to replace problematic instructions with a | |
6908 | PC-relative branch instruction if the @samp{.text} section is too | |
6909 | large. In that case, when the branch that replaces the original code | |
6910 | cannot be encoded, the linker reports a warning and no replacement | |
6911 | occurs. | |
6912 | ||
bf21ed78 MS |
6913 | @cindex NO_ENUM_SIZE_WARNING |
6914 | @kindex --no-enum-size-warning | |
726150b7 | 6915 | The @option{--no-enum-size-warning} switch prevents the linker from |
bf21ed78 MS |
6916 | warning when linking object files that specify incompatible EABI |
6917 | enumeration size attributes. For example, with this switch enabled, | |
6918 | linking of an object file using 32-bit enumeration values with another | |
6919 | using enumeration values fitted into the smallest possible space will | |
6920 | not be diagnosed. | |
a9dc9481 JM |
6921 | |
6922 | @cindex NO_WCHAR_SIZE_WARNING | |
6923 | @kindex --no-wchar-size-warning | |
6924 | The @option{--no-wchar-size-warning} switch prevents the linker from | |
6925 | warning when linking object files that specify incompatible EABI | |
6926 | @code{wchar_t} size attributes. For example, with this switch enabled, | |
6927 | linking of an object file using 32-bit @code{wchar_t} values with another | |
6928 | using 16-bit @code{wchar_t} values will not be diagnosed. | |
bf21ed78 | 6929 | |
726150b7 NC |
6930 | @cindex PIC_VENEER |
6931 | @kindex --pic-veneer | |
6932 | The @samp{--pic-veneer} switch makes the linker use PIC sequences for | |
6933 | ARM/Thumb interworking veneers, even if the rest of the binary | |
6934 | is not PIC. This avoids problems on uClinux targets where | |
6935 | @samp{--emit-relocs} is used to generate relocatable binaries. | |
6936 | ||
6937 | @cindex STUB_GROUP_SIZE | |
6938 | @kindex --stub-group-size=@var{N} | |
6939 | The linker will automatically generate and insert small sequences of | |
6940 | code into a linked ARM ELF executable whenever an attempt is made to | |
6941 | perform a function call to a symbol that is too far away. The | |
6942 | placement of these sequences of instructions - called stubs - is | |
6943 | controlled by the command line option @option{--stub-group-size=N}. | |
6944 | The placement is important because a poor choice can create a need for | |
11e7fd74 | 6945 | duplicate stubs, increasing the code size. The linker will try to |
726150b7 NC |
6946 | group stubs together in order to reduce interruptions to the flow of |
6947 | code, but it needs guidance as to how big these groups should be and | |
6948 | where they should be placed. | |
6949 | ||
6950 | The value of @samp{N}, the parameter to the | |
6951 | @option{--stub-group-size=} option controls where the stub groups are | |
07d72278 | 6952 | placed. If it is negative then all stubs are placed after the first |
726150b7 NC |
6953 | branch that needs them. If it is positive then the stubs can be |
6954 | placed either before or after the branches that need them. If the | |
6955 | value of @samp{N} is 1 (either +1 or -1) then the linker will choose | |
6956 | exactly where to place groups of stubs, using its built in heuristics. | |
6957 | A value of @samp{N} greater than 1 (or smaller than -1) tells the | |
6958 | linker that a single group of stubs can service at most @samp{N} bytes | |
6959 | from the input sections. | |
6960 | ||
6961 | The default, if @option{--stub-group-size=} is not specified, is | |
6962 | @samp{N = +1}. | |
6963 | ||
1a51c1a4 NC |
6964 | Farcalls stubs insertion is fully supported for the ARM-EABI target |
6965 | only, because it relies on object files properties not present | |
6966 | otherwise. | |
6967 | ||
1db37fe6 YG |
6968 | @cindex Cortex-A8 erratum workaround |
6969 | @kindex --fix-cortex-a8 | |
6970 | @kindex --no-fix-cortex-a8 | |
6971 | 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}. | |
6972 | ||
6973 | The erratum only affects Thumb-2 code. Please contact ARM for further details. | |
6974 | ||
68fcca92 JW |
6975 | @cindex Cortex-A53 erratum 835769 workaround |
6976 | @kindex --fix-cortex-a53-835769 | |
6977 | @kindex --no-fix-cortex-a53-835769 | |
6978 | 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}. | |
6979 | ||
6980 | Please contact ARM for further details. | |
6981 | ||
1db37fe6 YG |
6982 | @kindex --merge-exidx-entries |
6983 | @kindex --no-merge-exidx-entries | |
6984 | @cindex Merging exidx entries | |
6985 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo. | |
6986 | ||
6987 | @kindex --long-plt | |
6988 | @cindex 32-bit PLT entries | |
6989 | The @samp{--long-plt} option enables the use of 16 byte PLT entries | |
6990 | which support up to 4Gb of code. The default is to use 12 byte PLT | |
6991 | entries which only support 512Mb of code. | |
6992 | ||
1f56df9d JW |
6993 | @kindex --no-apply-dynamic-relocs |
6994 | @cindex AArch64 rela addend | |
6995 | The @samp{--no-apply-dynamic-relocs} option makes AArch64 linker do not apply | |
6996 | link-time values for dynamic relocations. | |
6997 | ||
4ba2ef8f TP |
6998 | @cindex Placement of SG veneers |
6999 | All SG veneers are placed in the special output section @code{.gnu.sgstubs}. | |
7000 | Its start address must be set, either with the command line option | |
7001 | @samp{--section-start} or in a linker script, to indicate where to place these | |
7002 | veneers in memory. | |
7003 | ||
54ddd295 TP |
7004 | @kindex --cmse-implib |
7005 | @cindex Secure gateway import library | |
7006 | The @samp{--cmse-implib} option requests that the import libraries | |
7007 | specified by the @samp{--out-implib} and @samp{--in-implib} options are | |
7008 | secure gateway import libraries, suitable for linking a non-secure | |
7009 | executable against secure code as per ARMv8-M Security Extensions. | |
7010 | ||
0955507f TP |
7011 | @kindex --in-implib=@var{file} |
7012 | @cindex Input import library | |
7013 | The @samp{--in-implib=file} specifies an input import library whose symbols | |
7014 | must keep the same address in the executable being produced. A warning is | |
7015 | given if no @samp{--out-implib} is given but new symbols have been introduced | |
7016 | in the executable that should be listed in its import library. Otherwise, if | |
7017 | @samp{--out-implib} is specified, the symbols are added to the output import | |
7018 | library. A warning is also given if some symbols present in the input import | |
7019 | library have disappeared from the executable. This option is only effective | |
7020 | for Secure Gateway import libraries, ie. when @samp{--cmse-implib} is | |
7021 | specified. | |
7022 | ||
36f63dca NC |
7023 | @ifclear GENERIC |
7024 | @lowersections | |
7025 | @end ifclear | |
7026 | @end ifset | |
7027 | ||
7028 | @ifset HPPA | |
7029 | @ifclear GENERIC | |
7030 | @raisesections | |
7031 | @end ifclear | |
7032 | ||
7033 | @node HPPA ELF32 | |
7034 | @section @command{ld} and HPPA 32-bit ELF Support | |
7035 | @cindex HPPA multiple sub-space stubs | |
7036 | @kindex --multi-subspace | |
7037 | When generating a shared library, @command{ld} will by default generate | |
7038 | import stubs suitable for use with a single sub-space application. | |
7039 | The @samp{--multi-subspace} switch causes @command{ld} to generate export | |
7040 | stubs, and different (larger) import stubs suitable for use with | |
7041 | multiple sub-spaces. | |
7042 | ||
7043 | @cindex HPPA stub grouping | |
7044 | @kindex --stub-group-size=@var{N} | |
7045 | Long branch stubs and import/export stubs are placed by @command{ld} in | |
7046 | stub sections located between groups of input sections. | |
7047 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
7048 | sections handled by one stub section. Since branch offsets are signed, | |
7049 | a stub section may serve two groups of input sections, one group before | |
7050 | the stub section, and one group after it. However, when using | |
7051 | conditional branches that require stubs, it may be better (for branch | |
7052 | prediction) that stub sections only serve one group of input sections. | |
7053 | A negative value for @samp{N} chooses this scheme, ensuring that | |
7054 | branches to stubs always use a negative offset. Two special values of | |
7055 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
7056 | @command{ld} to automatically size input section groups for the branch types | |
7057 | detected, with the same behaviour regarding stub placement as other | |
7058 | positive or negative values of @samp{N} respectively. | |
7059 | ||
7060 | Note that @samp{--stub-group-size} does not split input sections. A | |
7061 | single input section larger than the group size specified will of course | |
7062 | create a larger group (of one section). If input sections are too | |
7063 | large, it may not be possible for a branch to reach its stub. | |
7064 | ||
7065 | @ifclear GENERIC | |
7066 | @lowersections | |
7067 | @end ifclear | |
7068 | @end ifset | |
7069 | ||
7fb9f789 NC |
7070 | @ifset M68K |
7071 | @ifclear GENERIC | |
7072 | @raisesections | |
7073 | @end ifclear | |
7074 | ||
7075 | @node M68K | |
7076 | @section @command{ld} and the Motorola 68K family | |
7077 | ||
7078 | @cindex Motorola 68K GOT generation | |
7079 | @kindex --got=@var{type} | |
7080 | The @samp{--got=@var{type}} option lets you choose the GOT generation scheme. | |
7081 | The choices are @samp{single}, @samp{negative}, @samp{multigot} and | |
7082 | @samp{target}. When @samp{target} is selected the linker chooses | |
7083 | the default GOT generation scheme for the current target. | |
7084 | @samp{single} tells the linker to generate a single GOT with | |
7085 | entries only at non-negative offsets. | |
7086 | @samp{negative} instructs the linker to generate a single GOT with | |
7087 | entries at both negative and positive offsets. Not all environments | |
7088 | support such GOTs. | |
7089 | @samp{multigot} allows the linker to generate several GOTs in the | |
7090 | output file. All GOT references from a single input object | |
7091 | file access the same GOT, but references from different input object | |
7092 | files might access different GOTs. Not all environments support such GOTs. | |
7093 | ||
7094 | @ifclear GENERIC | |
7095 | @lowersections | |
7096 | @end ifclear | |
7097 | @end ifset | |
7098 | ||
833794fc MR |
7099 | @ifset MIPS |
7100 | @ifclear GENERIC | |
7101 | @raisesections | |
7102 | @end ifclear | |
7103 | ||
7104 | @node MIPS | |
7105 | @section @command{ld} and the MIPS family | |
7106 | ||
7107 | @cindex MIPS microMIPS instruction choice selection | |
7108 | @kindex --insn32 | |
7109 | @kindex --no-insn32 | |
7110 | The @samp{--insn32} and @samp{--no-insn32} options control the choice of | |
7111 | microMIPS instructions used in code generated by the linker, such as that | |
7112 | in the PLT or lazy binding stubs, or in relaxation. If @samp{--insn32} is | |
7113 | used, then the linker only uses 32-bit instruction encodings. By default | |
7114 | or if @samp{--no-insn32} is used, all instruction encodings are used, | |
7115 | including 16-bit ones where possible. | |
7116 | ||
8b10b0b3 MR |
7117 | @cindex MIPS branch relocation check control |
7118 | @kindex --ignore-branch-isa | |
7119 | @kindex --no-ignore-branch-isa | |
7120 | The @samp{--ignore-branch-isa} and @samp{--no-ignore-branch-isa} options | |
7121 | control branch relocation checks for invalid ISA mode transitions. If | |
7122 | @samp{--ignore-branch-isa} is used, then the linker accepts any branch | |
7123 | relocations and any ISA mode transition required is lost in relocation | |
7124 | calculation, except for some cases of @code{BAL} instructions which meet | |
7125 | relaxation conditions and are converted to equivalent @code{JALX} | |
7126 | instructions as the associated relocation is calculated. By default | |
7127 | or if @samp{--no-ignore-branch-isa} is used a check is made causing | |
7128 | the loss of an ISA mode transition to produce an error. | |
7129 | ||
833794fc MR |
7130 | @ifclear GENERIC |
7131 | @lowersections | |
7132 | @end ifclear | |
7133 | @end ifset | |
7134 | ||
36f63dca NC |
7135 | @ifset MMIX |
7136 | @ifclear GENERIC | |
7137 | @raisesections | |
7138 | @end ifclear | |
7139 | ||
7140 | @node MMIX | |
7141 | @section @code{ld} and MMIX | |
7142 | For MMIX, there is a choice of generating @code{ELF} object files or | |
7143 | @code{mmo} object files when linking. The simulator @code{mmix} | |
7144 | understands the @code{mmo} format. The binutils @code{objcopy} utility | |
7145 | can translate between the two formats. | |
7146 | ||
7147 | There is one special section, the @samp{.MMIX.reg_contents} section. | |
7148 | Contents in this section is assumed to correspond to that of global | |
7149 | registers, and symbols referring to it are translated to special symbols, | |
7150 | equal to registers. In a final link, the start address of the | |
7151 | @samp{.MMIX.reg_contents} section corresponds to the first allocated | |
7152 | global register multiplied by 8. Register @code{$255} is not included in | |
7153 | this section; it is always set to the program entry, which is at the | |
7154 | symbol @code{Main} for @code{mmo} files. | |
7155 | ||
7a2de473 HPN |
7156 | Global symbols with the prefix @code{__.MMIX.start.}, for example |
7157 | @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special. | |
7158 | The default linker script uses these to set the default start address | |
7159 | of a section. | |
36f63dca NC |
7160 | |
7161 | Initial and trailing multiples of zero-valued 32-bit words in a section, | |
7162 | are left out from an mmo file. | |
7163 | ||
7164 | @ifclear GENERIC | |
7165 | @lowersections | |
7166 | @end ifclear | |
7167 | @end ifset | |
7168 | ||
7169 | @ifset MSP430 | |
7170 | @ifclear GENERIC | |
7171 | @raisesections | |
7172 | @end ifclear | |
7173 | ||
7174 | @node MSP430 | |
7175 | @section @code{ld} and MSP430 | |
7176 | For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]} | |
7177 | will select an appropriate linker script for selected MPU type. (To get a list of known MPUs | |
7178 | just pass @samp{-m help} option to the linker). | |
7179 | ||
7180 | @cindex MSP430 extra sections | |
7181 | The linker will recognize some extra sections which are MSP430 specific: | |
7182 | ||
7183 | @table @code | |
7184 | @item @samp{.vectors} | |
7185 | Defines a portion of ROM where interrupt vectors located. | |
7186 | ||
7187 | @item @samp{.bootloader} | |
7188 | Defines the bootloader portion of the ROM (if applicable). Any code | |
7189 | in this section will be uploaded to the MPU. | |
7190 | ||
7191 | @item @samp{.infomem} | |
7192 | Defines an information memory section (if applicable). Any code in | |
7193 | this section will be uploaded to the MPU. | |
7194 | ||
c0065db7 | 7195 | @item @samp{.infomemnobits} |
36f63dca NC |
7196 | This is the same as the @samp{.infomem} section except that any code |
7197 | in this section will not be uploaded to the MPU. | |
7198 | ||
7199 | @item @samp{.noinit} | |
7200 | Denotes a portion of RAM located above @samp{.bss} section. | |
7201 | ||
c0065db7 | 7202 | The last two sections are used by gcc. |
36f63dca NC |
7203 | @end table |
7204 | ||
7ef3addb JL |
7205 | @table @option |
7206 | @cindex MSP430 Options | |
7207 | @kindex --code-region | |
7208 | @item --code-region=[either,lower,upper,none] | |
7209 | This will transform .text* sections to [either,lower,upper].text* sections. The | |
7210 | argument passed to GCC for -mcode-region is propagated to the linker | |
7211 | using this option. | |
7212 | ||
7213 | @kindex --data-region | |
7214 | @item --data-region=[either,lower,upper,none] | |
7215 | This will transform .data*, .bss* and .rodata* sections to | |
7216 | [either,lower,upper].[data,bss,rodata]* sections. The argument passed to GCC | |
7217 | for -mdata-region is propagated to the linker using this option. | |
7218 | ||
7219 | @kindex --disable-sec-transformation | |
7220 | @item --disable-sec-transformation | |
7221 | Prevent the transformation of sections as specified by the @code{--code-region} | |
7222 | and @code{--data-region} options. | |
7223 | This is useful if you are compiling and linking using a single call to the GCC | |
7224 | wrapper, and want to compile the source files using -m[code,data]-region but | |
7225 | not transform the sections for prebuilt libraries and objects. | |
7226 | @end table | |
7227 | ||
36f63dca NC |
7228 | @ifclear GENERIC |
7229 | @lowersections | |
7230 | @end ifclear | |
7231 | @end ifset | |
7232 | ||
35c08157 KLC |
7233 | @ifset NDS32 |
7234 | @ifclear GENERIC | |
7235 | @raisesections | |
7236 | @end ifclear | |
7237 | ||
7238 | @node NDS32 | |
7239 | @section @code{ld} and NDS32 | |
7240 | @kindex relaxing on NDS32 | |
7241 | For NDS32, there are some options to select relaxation behavior. The linker | |
7242 | relaxes objects according to these options. | |
7243 | ||
7244 | @table @code | |
7245 | @item @samp{--m[no-]fp-as-gp} | |
7246 | Disable/enable fp-as-gp relaxation. | |
7247 | ||
7248 | @item @samp{--mexport-symbols=FILE} | |
7249 | Exporting symbols and their address into FILE as linker script. | |
7250 | ||
7251 | @item @samp{--m[no-]ex9} | |
7252 | Disable/enable link-time EX9 relaxation. | |
7253 | ||
7254 | @item @samp{--mexport-ex9=FILE} | |
7255 | Export the EX9 table after linking. | |
7256 | ||
7257 | @item @samp{--mimport-ex9=FILE} | |
7258 | Import the Ex9 table for EX9 relaxation. | |
7259 | ||
7260 | @item @samp{--mupdate-ex9} | |
7261 | Update the existing EX9 table. | |
7262 | ||
7263 | @item @samp{--mex9-limit=NUM} | |
7264 | Maximum number of entries in the ex9 table. | |
7265 | ||
7266 | @item @samp{--mex9-loop-aware} | |
7267 | Avoid generating the EX9 instruction inside the loop. | |
7268 | ||
7269 | @item @samp{--m[no-]ifc} | |
7270 | Disable/enable the link-time IFC optimization. | |
7271 | ||
7272 | @item @samp{--mifc-loop-aware} | |
7273 | Avoid generating the IFC instruction inside the loop. | |
7274 | @end table | |
7275 | ||
7276 | @ifclear GENERIC | |
7277 | @lowersections | |
7278 | @end ifclear | |
7279 | @end ifset | |
7280 | ||
78058a5e SL |
7281 | @ifset NIOSII |
7282 | @ifclear GENERIC | |
7283 | @raisesections | |
7284 | @end ifclear | |
7285 | ||
7286 | @node Nios II | |
7287 | @section @command{ld} and the Altera Nios II | |
7288 | @cindex Nios II call relaxation | |
7289 | @kindex --relax on Nios II | |
7290 | ||
7291 | Call and immediate jump instructions on Nios II processors are limited to | |
7292 | transferring control to addresses in the same 256MB memory segment, | |
7293 | which may result in @command{ld} giving | |
7294 | @samp{relocation truncated to fit} errors with very large programs. | |
7295 | The command-line option @option{--relax} enables the generation of | |
7296 | trampolines that can access the entire 32-bit address space for calls | |
7297 | outside the normal @code{call} and @code{jmpi} address range. These | |
7298 | trampolines are inserted at section boundaries, so may not themselves | |
7299 | be reachable if an input section and its associated call trampolines are | |
7300 | larger than 256MB. | |
7301 | ||
7302 | The @option{--relax} option is enabled by default unless @option{-r} | |
7303 | is also specified. You can disable trampoline generation by using the | |
7304 | @option{--no-relax} linker option. You can also disable this optimization | |
7305 | locally by using the @samp{set .noat} directive in assembly-language | |
7306 | source files, as the linker-inserted trampolines use the @code{at} | |
7307 | register as a temporary. | |
7308 | ||
7309 | Note that the linker @option{--relax} option is independent of assembler | |
7310 | relaxation options, and that using the GNU assembler's @option{-relax-all} | |
7311 | option interferes with the linker's more selective call instruction relaxation. | |
7312 | ||
7313 | @ifclear GENERIC | |
7314 | @lowersections | |
7315 | @end ifclear | |
7316 | @end ifset | |
7317 | ||
2a60a7a8 AM |
7318 | @ifset POWERPC |
7319 | @ifclear GENERIC | |
7320 | @raisesections | |
7321 | @end ifclear | |
7322 | ||
7323 | @node PowerPC ELF32 | |
7324 | @section @command{ld} and PowerPC 32-bit ELF Support | |
7325 | @cindex PowerPC long branches | |
7326 | @kindex --relax on PowerPC | |
7327 | Branches on PowerPC processors are limited to a signed 26-bit | |
7328 | displacement, which may result in @command{ld} giving | |
7329 | @samp{relocation truncated to fit} errors with very large programs. | |
7330 | @samp{--relax} enables the generation of trampolines that can access | |
7331 | the entire 32-bit address space. These trampolines are inserted at | |
7332 | section boundaries, so may not themselves be reachable if an input | |
c8a1f254 NS |
7333 | section exceeds 33M in size. You may combine @samp{-r} and |
7334 | @samp{--relax} to add trampolines in a partial link. In that case | |
7335 | both branches to undefined symbols and inter-section branches are also | |
7336 | considered potentially out of range, and trampolines inserted. | |
2a60a7a8 AM |
7337 | |
7338 | @cindex PowerPC ELF32 options | |
7339 | @table @option | |
7340 | @cindex PowerPC PLT | |
7341 | @kindex --bss-plt | |
7342 | @item --bss-plt | |
7343 | Current PowerPC GCC accepts a @samp{-msecure-plt} option that | |
7344 | generates code capable of using a newer PLT and GOT layout that has | |
7345 | the security advantage of no executable section ever needing to be | |
7346 | writable and no writable section ever being executable. PowerPC | |
7347 | @command{ld} will generate this layout, including stubs to access the | |
7348 | PLT, if all input files (including startup and static libraries) were | |
7349 | compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old | |
7350 | BSS PLT (and GOT layout) which can give slightly better performance. | |
7351 | ||
016687f8 AM |
7352 | @kindex --secure-plt |
7353 | @item --secure-plt | |
7354 | @command{ld} will use the new PLT and GOT layout if it is linking new | |
7355 | @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically | |
7356 | when linking non-PIC code. This option requests the new PLT and GOT | |
7357 | layout. A warning will be given if some object file requires the old | |
7358 | style BSS PLT. | |
7359 | ||
2a60a7a8 AM |
7360 | @cindex PowerPC GOT |
7361 | @kindex --sdata-got | |
7362 | @item --sdata-got | |
7363 | The new secure PLT and GOT are placed differently relative to other | |
7364 | sections compared to older BSS PLT and GOT placement. The location of | |
7365 | @code{.plt} must change because the new secure PLT is an initialized | |
7366 | section while the old PLT is uninitialized. The reason for the | |
7367 | @code{.got} change is more subtle: The new placement allows | |
7368 | @code{.got} to be read-only in applications linked with | |
7369 | @samp{-z relro -z now}. However, this placement means that | |
7370 | @code{.sdata} cannot always be used in shared libraries, because the | |
7371 | PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT | |
7372 | pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC | |
7373 | GCC doesn't use @code{.sdata} in shared libraries, so this option is | |
7374 | really only useful for other compilers that may do so. | |
7375 | ||
7376 | @cindex PowerPC stub symbols | |
7377 | @kindex --emit-stub-syms | |
7378 | @item --emit-stub-syms | |
7379 | This option causes @command{ld} to label linker stubs with a local | |
7380 | symbol that encodes the stub type and destination. | |
7381 | ||
7382 | @cindex PowerPC TLS optimization | |
7383 | @kindex --no-tls-optimize | |
7384 | @item --no-tls-optimize | |
7385 | PowerPC @command{ld} normally performs some optimization of code | |
7386 | sequences used to access Thread-Local Storage. Use this option to | |
7387 | disable the optimization. | |
7388 | @end table | |
7389 | ||
7390 | @ifclear GENERIC | |
7391 | @lowersections | |
7392 | @end ifclear | |
7393 | @end ifset | |
7394 | ||
7395 | @ifset POWERPC64 | |
7396 | @ifclear GENERIC | |
7397 | @raisesections | |
7398 | @end ifclear | |
7399 | ||
7400 | @node PowerPC64 ELF64 | |
7401 | @section @command{ld} and PowerPC64 64-bit ELF Support | |
7402 | ||
7403 | @cindex PowerPC64 ELF64 options | |
7404 | @table @option | |
7405 | @cindex PowerPC64 stub grouping | |
7406 | @kindex --stub-group-size | |
7407 | @item --stub-group-size | |
7408 | Long branch stubs, PLT call stubs and TOC adjusting stubs are placed | |
7409 | by @command{ld} in stub sections located between groups of input sections. | |
7410 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
7411 | sections handled by one stub section. Since branch offsets are signed, | |
7412 | a stub section may serve two groups of input sections, one group before | |
7413 | the stub section, and one group after it. However, when using | |
7414 | conditional branches that require stubs, it may be better (for branch | |
7415 | prediction) that stub sections only serve one group of input sections. | |
7416 | A negative value for @samp{N} chooses this scheme, ensuring that | |
7417 | branches to stubs always use a negative offset. Two special values of | |
7418 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
7419 | @command{ld} to automatically size input section groups for the branch types | |
7420 | detected, with the same behaviour regarding stub placement as other | |
7421 | positive or negative values of @samp{N} respectively. | |
7422 | ||
7423 | Note that @samp{--stub-group-size} does not split input sections. A | |
7424 | single input section larger than the group size specified will of course | |
7425 | create a larger group (of one section). If input sections are too | |
7426 | large, it may not be possible for a branch to reach its stub. | |
7427 | ||
7428 | @cindex PowerPC64 stub symbols | |
7429 | @kindex --emit-stub-syms | |
7430 | @item --emit-stub-syms | |
7431 | This option causes @command{ld} to label linker stubs with a local | |
7432 | symbol that encodes the stub type and destination. | |
7433 | ||
7434 | @cindex PowerPC64 dot symbols | |
7435 | @kindex --dotsyms | |
7436 | @kindex --no-dotsyms | |
95421fb9 AM |
7437 | @item --dotsyms |
7438 | @itemx --no-dotsyms | |
2a60a7a8 AM |
7439 | These two options control how @command{ld} interprets version patterns |
7440 | in a version script. Older PowerPC64 compilers emitted both a | |
7441 | function descriptor symbol with the same name as the function, and a | |
7442 | code entry symbol with the name prefixed by a dot (@samp{.}). To | |
7443 | properly version a function @samp{foo}, the version script thus needs | |
7444 | to control both @samp{foo} and @samp{.foo}. The option | |
7445 | @samp{--dotsyms}, on by default, automatically adds the required | |
7446 | dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this | |
7447 | feature. | |
7448 | ||
7ae4ea7d AM |
7449 | @cindex PowerPC64 register save/restore functions |
7450 | @kindex --save-restore-funcs | |
7451 | @kindex --no-save-restore-funcs | |
95421fb9 AM |
7452 | @item --save-restore-funcs |
7453 | @itemx --no-save-restore-funcs | |
7ae4ea7d AM |
7454 | These two options control whether PowerPC64 @command{ld} automatically |
7455 | provides out-of-line register save and restore functions used by | |
7456 | @samp{-Os} code. The default is to provide any such referenced | |
7457 | function for a normal final link, and to not do so for a relocatable | |
7458 | link. | |
7459 | ||
2a60a7a8 AM |
7460 | @cindex PowerPC64 TLS optimization |
7461 | @kindex --no-tls-optimize | |
7462 | @item --no-tls-optimize | |
7463 | PowerPC64 @command{ld} normally performs some optimization of code | |
7464 | sequences used to access Thread-Local Storage. Use this option to | |
7465 | disable the optimization. | |
7466 | ||
7c9cf415 AM |
7467 | @cindex PowerPC64 __tls_get_addr optimization |
7468 | @kindex --tls-get-addr-optimize | |
7469 | @kindex --no-tls-get-addr-optimize | |
95421fb9 AM |
7470 | @item --tls-get-addr-optimize |
7471 | @itemx --no-tls-get-addr-optimize | |
7c9cf415 AM |
7472 | These options control whether PowerPC64 @command{ld} uses a special |
7473 | stub to call __tls_get_addr. PowerPC64 glibc 2.22 and later support | |
7474 | an optimization that allows the second and subsequent calls to | |
7475 | @code{__tls_get_addr} for a given symbol to be resolved by the special | |
7476 | stub without calling in to glibc. By default the linker enables this | |
7477 | option when glibc advertises the availability of __tls_get_addr_opt. | |
7478 | Forcing this option on when using an older glibc won't do much besides | |
7479 | slow down your applications, but may be useful if linking an | |
7480 | application against an older glibc with the expectation that it will | |
7481 | normally be used on systems having a newer glibc. | |
7482 | ||
2a60a7a8 AM |
7483 | @cindex PowerPC64 OPD optimization |
7484 | @kindex --no-opd-optimize | |
7485 | @item --no-opd-optimize | |
7486 | PowerPC64 @command{ld} normally removes @code{.opd} section entries | |
7487 | corresponding to deleted link-once functions, or functions removed by | |
e7fc76dd | 7488 | the action of @samp{--gc-sections} or linker script @code{/DISCARD/}. |
2a60a7a8 AM |
7489 | Use this option to disable @code{.opd} optimization. |
7490 | ||
7491 | @cindex PowerPC64 OPD spacing | |
7492 | @kindex --non-overlapping-opd | |
7493 | @item --non-overlapping-opd | |
7494 | Some PowerPC64 compilers have an option to generate compressed | |
7495 | @code{.opd} entries spaced 16 bytes apart, overlapping the third word, | |
7496 | the static chain pointer (unused in C) with the first word of the next | |
7497 | entry. This option expands such entries to the full 24 bytes. | |
7498 | ||
7499 | @cindex PowerPC64 TOC optimization | |
7500 | @kindex --no-toc-optimize | |
7501 | @item --no-toc-optimize | |
7502 | PowerPC64 @command{ld} normally removes unused @code{.toc} section | |
7503 | entries. Such entries are detected by examining relocations that | |
7504 | reference the TOC in code sections. A reloc in a deleted code section | |
7505 | marks a TOC word as unneeded, while a reloc in a kept code section | |
7506 | marks a TOC word as needed. Since the TOC may reference itself, TOC | |
7507 | relocs are also examined. TOC words marked as both needed and | |
7508 | unneeded will of course be kept. TOC words without any referencing | |
7509 | reloc are assumed to be part of a multi-word entry, and are kept or | |
7510 | discarded as per the nearest marked preceding word. This works | |
7511 | reliably for compiler generated code, but may be incorrect if assembly | |
7512 | code is used to insert TOC entries. Use this option to disable the | |
7513 | optimization. | |
7514 | ||
7515 | @cindex PowerPC64 multi-TOC | |
7516 | @kindex --no-multi-toc | |
7517 | @item --no-multi-toc | |
794e51c0 AM |
7518 | If given any toc option besides @code{-mcmodel=medium} or |
7519 | @code{-mcmodel=large}, PowerPC64 GCC generates code for a TOC model | |
7520 | where TOC | |
2a60a7a8 AM |
7521 | entries are accessed with a 16-bit offset from r2. This limits the |
7522 | total TOC size to 64K. PowerPC64 @command{ld} extends this limit by | |
7523 | grouping code sections such that each group uses less than 64K for its | |
7524 | TOC entries, then inserts r2 adjusting stubs between inter-group | |
7525 | calls. @command{ld} does not split apart input sections, so cannot | |
7526 | help if a single input file has a @code{.toc} section that exceeds | |
7527 | 64K, most likely from linking multiple files with @command{ld -r}. | |
7528 | Use this option to turn off this feature. | |
794e51c0 AM |
7529 | |
7530 | @cindex PowerPC64 TOC sorting | |
7531 | @kindex --no-toc-sort | |
7532 | @item --no-toc-sort | |
7533 | By default, @command{ld} sorts TOC sections so that those whose file | |
7534 | happens to have a section called @code{.init} or @code{.fini} are | |
7535 | placed first, followed by TOC sections referenced by code generated | |
7536 | with PowerPC64 gcc's @code{-mcmodel=small}, and lastly TOC sections | |
7537 | referenced only by code generated with PowerPC64 gcc's | |
7538 | @code{-mcmodel=medium} or @code{-mcmodel=large} options. Doing this | |
7539 | results in better TOC grouping for multi-TOC. Use this option to turn | |
7540 | off this feature. | |
7541 | ||
7542 | @cindex PowerPC64 PLT stub alignment | |
7543 | @kindex --plt-align | |
7544 | @kindex --no-plt-align | |
7545 | @item --plt-align | |
7546 | @itemx --no-plt-align | |
7547 | Use these options to control whether individual PLT call stubs are | |
2420fff6 AM |
7548 | aligned to a 32-byte boundary, or to the specified power of two |
7549 | boundary when using @code{--plt-align=}. A negative value may be | |
7550 | specified to pad PLT call stubs so that they do not cross the | |
7551 | specified power of two boundary (or the minimum number of boundaries | |
7552 | if a PLT stub is so large that it must cross a boundary). By default | |
7553 | PLT call stubs are aligned to 32-byte boundaries. | |
794e51c0 AM |
7554 | |
7555 | @cindex PowerPC64 PLT call stub static chain | |
7556 | @kindex --plt-static-chain | |
7557 | @kindex --no-plt-static-chain | |
7558 | @item --plt-static-chain | |
7559 | @itemx --no-plt-static-chain | |
7560 | Use these options to control whether PLT call stubs load the static | |
7561 | chain pointer (r11). @code{ld} defaults to not loading the static | |
7562 | chain since there is never any need to do so on a PLT call. | |
7563 | ||
7564 | @cindex PowerPC64 PLT call stub thread safety | |
7565 | @kindex --plt-thread-safe | |
7566 | @kindex --no-plt-thread-safe | |
7567 | @item --plt-thread-safe | |
1be5d8d3 | 7568 | @itemx --no-plt-thread-safe |
794e51c0 AM |
7569 | With power7's weakly ordered memory model, it is possible when using |
7570 | lazy binding for ld.so to update a plt entry in one thread and have | |
7571 | another thread see the individual plt entry words update in the wrong | |
7572 | order, despite ld.so carefully writing in the correct order and using | |
7573 | memory write barriers. To avoid this we need some sort of read | |
7574 | barrier in the call stub, or use LD_BIND_NOW=1. By default, @code{ld} | |
7575 | looks for calls to commonly used functions that create threads, and if | |
7576 | seen, adds the necessary barriers. Use these options to change the | |
7577 | default behaviour. | |
8b5f1ed8 AM |
7578 | |
7579 | @cindex PowerPC64 ELFv2 PLT localentry optimization | |
7580 | @kindex --plt-localentry | |
7581 | @kindex --no-plt-localentry | |
7582 | @item --plt-localentry | |
7583 | @itemx --no-localentry | |
7584 | ELFv2 functions with localentry:0 are those with a single entry point, | |
7585 | ie. global entry == local entry, and that have no requirement on r2 | |
7586 | (the TOC/GOT pointer) or r12, and guarantee r2 is unchanged on return. | |
7587 | Such an external function can be called via the PLT without saving r2 | |
7588 | or restoring it on return, avoiding a common load-hit-store for small | |
7589 | functions. The optimization is attractive, with up to 40% reduction | |
7590 | in execution time for a small function, but can result in symbol | |
d44c746a AM |
7591 | interposition failures. Also, minor changes in a shared library, |
7592 | including system libraries, can cause a function that was localentry:0 | |
7593 | to become localentry:8. This will result in a dynamic loader | |
7594 | complaint and failure to run. The option is experimental, use with | |
7595 | care. @option{--no-plt-localentry} is the default. | |
2a60a7a8 AM |
7596 | @end table |
7597 | ||
7598 | @ifclear GENERIC | |
7599 | @lowersections | |
7600 | @end ifclear | |
7601 | @end ifset | |
7602 | ||
b4cbbe8f AK |
7603 | @ifset S/390 |
7604 | @ifclear GENERIC | |
7605 | @raisesections | |
7606 | @end ifclear | |
7607 | ||
7608 | @node S/390 ELF | |
7609 | @section @command{ld} and S/390 ELF Support | |
7610 | ||
7611 | @cindex S/390 ELF options | |
7612 | @table @option | |
7613 | ||
7614 | @cindex S/390 | |
7615 | @kindex --s390-pgste | |
7616 | @item --s390-pgste | |
7617 | This option marks the result file with a @code{PT_S390_PGSTE} | |
7618 | segment. The Linux kernel is supposed to allocate 4k page tables for | |
7619 | binaries marked that way. | |
7620 | @end table | |
7621 | ||
7622 | @ifclear GENERIC | |
7623 | @lowersections | |
7624 | @end ifclear | |
7625 | @end ifset | |
7626 | ||
49fa1e15 AM |
7627 | @ifset SPU |
7628 | @ifclear GENERIC | |
7629 | @raisesections | |
7630 | @end ifclear | |
7631 | ||
7632 | @node SPU ELF | |
7633 | @section @command{ld} and SPU ELF Support | |
7634 | ||
7635 | @cindex SPU ELF options | |
7636 | @table @option | |
7637 | ||
7638 | @cindex SPU plugins | |
7639 | @kindex --plugin | |
7640 | @item --plugin | |
7641 | This option marks an executable as a PIC plugin module. | |
7642 | ||
7643 | @cindex SPU overlays | |
7644 | @kindex --no-overlays | |
7645 | @item --no-overlays | |
7646 | Normally, @command{ld} recognizes calls to functions within overlay | |
7647 | regions, and redirects such calls to an overlay manager via a stub. | |
7648 | @command{ld} also provides a built-in overlay manager. This option | |
7649 | turns off all this special overlay handling. | |
7650 | ||
7651 | @cindex SPU overlay stub symbols | |
7652 | @kindex --emit-stub-syms | |
7653 | @item --emit-stub-syms | |
7654 | This option causes @command{ld} to label overlay stubs with a local | |
7655 | symbol that encodes the stub type and destination. | |
7656 | ||
7657 | @cindex SPU extra overlay stubs | |
7658 | @kindex --extra-overlay-stubs | |
7659 | @item --extra-overlay-stubs | |
7660 | This option causes @command{ld} to add overlay call stubs on all | |
7661 | function calls out of overlay regions. Normally stubs are not added | |
7662 | on calls to non-overlay regions. | |
7663 | ||
7664 | @cindex SPU local store size | |
7665 | @kindex --local-store=lo:hi | |
7666 | @item --local-store=lo:hi | |
7667 | @command{ld} usually checks that a final executable for SPU fits in | |
7668 | the address range 0 to 256k. This option may be used to change the | |
7669 | range. Disable the check entirely with @option{--local-store=0:0}. | |
7670 | ||
c0065db7 | 7671 | @cindex SPU |
49fa1e15 AM |
7672 | @kindex --stack-analysis |
7673 | @item --stack-analysis | |
7674 | SPU local store space is limited. Over-allocation of stack space | |
7675 | unnecessarily limits space available for code and data, while | |
7676 | under-allocation results in runtime failures. If given this option, | |
7677 | @command{ld} will provide an estimate of maximum stack usage. | |
7678 | @command{ld} does this by examining symbols in code sections to | |
7679 | determine the extents of functions, and looking at function prologues | |
7680 | for stack adjusting instructions. A call-graph is created by looking | |
7681 | for relocations on branch instructions. The graph is then searched | |
7682 | for the maximum stack usage path. Note that this analysis does not | |
7683 | find calls made via function pointers, and does not handle recursion | |
7684 | and other cycles in the call graph. Stack usage may be | |
7685 | under-estimated if your code makes such calls. Also, stack usage for | |
7686 | dynamic allocation, e.g. alloca, will not be detected. If a link map | |
7687 | is requested, detailed information about each function's stack usage | |
7688 | and calls will be given. | |
7689 | ||
c0065db7 | 7690 | @cindex SPU |
49fa1e15 AM |
7691 | @kindex --emit-stack-syms |
7692 | @item --emit-stack-syms | |
7693 | This option, if given along with @option{--stack-analysis} will result | |
7694 | in @command{ld} emitting stack sizing symbols for each function. | |
7695 | These take the form @code{__stack_<function_name>} for global | |
7696 | functions, and @code{__stack_<number>_<function_name>} for static | |
7697 | functions. @code{<number>} is the section id in hex. The value of | |
7698 | such symbols is the stack requirement for the corresponding function. | |
7699 | The symbol size will be zero, type @code{STT_NOTYPE}, binding | |
c0065db7 | 7700 | @code{STB_LOCAL}, and section @code{SHN_ABS}. |
49fa1e15 AM |
7701 | @end table |
7702 | ||
7703 | @ifclear GENERIC | |
7704 | @lowersections | |
7705 | @end ifclear | |
7706 | @end ifset | |
7707 | ||
36f63dca NC |
7708 | @ifset TICOFF |
7709 | @ifclear GENERIC | |
7710 | @raisesections | |
7711 | @end ifclear | |
7712 | ||
7713 | @node TI COFF | |
7714 | @section @command{ld}'s Support for Various TI COFF Versions | |
7715 | @cindex TI COFF versions | |
7716 | @kindex --format=@var{version} | |
7717 | The @samp{--format} switch allows selection of one of the various | |
7718 | TI COFF versions. The latest of this writing is 2; versions 0 and 1 are | |
7719 | also supported. The TI COFF versions also vary in header byte-order | |
7720 | format; @command{ld} will read any version or byte order, but the output | |
7721 | header format depends on the default specified by the specific target. | |
7722 | ||
7723 | @ifclear GENERIC | |
7724 | @lowersections | |
7725 | @end ifclear | |
7726 | @end ifset | |
7727 | ||
2ca22b03 NC |
7728 | @ifset WIN32 |
7729 | @ifclear GENERIC | |
7730 | @raisesections | |
7731 | @end ifclear | |
7732 | ||
7733 | @node WIN32 | |
7734 | @section @command{ld} and WIN32 (cygwin/mingw) | |
7735 | ||
c0065db7 | 7736 | This section describes some of the win32 specific @command{ld} issues. |
b45619c0 | 7737 | See @ref{Options,,Command Line Options} for detailed description of the |
dc8465bf | 7738 | command line options mentioned here. |
2ca22b03 NC |
7739 | |
7740 | @table @emph | |
c0065db7 RM |
7741 | @cindex import libraries |
7742 | @item import libraries | |
69da35b5 | 7743 | The standard Windows linker creates and uses so-called import |
2ca22b03 | 7744 | libraries, which contains information for linking to dll's. They are |
69da35b5 NC |
7745 | regular static archives and are handled as any other static |
7746 | archive. The cygwin and mingw ports of @command{ld} have specific | |
2ca22b03 NC |
7747 | support for creating such libraries provided with the |
7748 | @samp{--out-implib} command line option. | |
7749 | ||
c0065db7 RM |
7750 | @item exporting DLL symbols |
7751 | @cindex exporting DLL symbols | |
dc8465bf NC |
7752 | The cygwin/mingw @command{ld} has several ways to export symbols for dll's. |
7753 | ||
7754 | @table @emph | |
7755 | @item using auto-export functionality | |
7756 | @cindex using auto-export functionality | |
7757 | By default @command{ld} exports symbols with the auto-export functionality, | |
7758 | which is controlled by the following command line options: | |
7759 | ||
0a5d968e NC |
7760 | @itemize |
7761 | @item --export-all-symbols [This is the default] | |
7762 | @item --exclude-symbols | |
7763 | @item --exclude-libs | |
e1c37eb5 | 7764 | @item --exclude-modules-for-implib |
09e2aba4 | 7765 | @item --version-script |
0a5d968e NC |
7766 | @end itemize |
7767 | ||
09e2aba4 DK |
7768 | When auto-export is in operation, @command{ld} will export all the non-local |
7769 | (global and common) symbols it finds in a DLL, with the exception of a few | |
7770 | symbols known to belong to the system's runtime and libraries. As it will | |
7771 | often not be desirable to export all of a DLL's symbols, which may include | |
7772 | private functions that are not part of any public interface, the command-line | |
9d5777a3 | 7773 | options listed above may be used to filter symbols out from the list for |
09e2aba4 DK |
7774 | exporting. The @samp{--output-def} option can be used in order to see the |
7775 | final list of exported symbols with all exclusions taken into effect. | |
7776 | ||
7777 | If @samp{--export-all-symbols} is not given explicitly on the | |
0a5d968e NC |
7778 | command line, then the default auto-export behavior will be @emph{disabled} |
7779 | if either of the following are true: | |
7780 | ||
7781 | @itemize | |
7782 | @item A DEF file is used. | |
7783 | @item Any symbol in any object file was marked with the __declspec(dllexport) attribute. | |
7784 | @end itemize | |
dc8465bf | 7785 | |
c0065db7 RM |
7786 | @item using a DEF file |
7787 | @cindex using a DEF file | |
dc8465bf NC |
7788 | Another way of exporting symbols is using a DEF file. A DEF file is |
7789 | an ASCII file containing definitions of symbols which should be | |
7790 | exported when a dll is created. Usually it is named @samp{<dll | |
7791 | name>.def} and is added as any other object file to the linker's | |
0a5d968e | 7792 | command line. The file's name must end in @samp{.def} or @samp{.DEF}. |
dc8465bf NC |
7793 | |
7794 | @example | |
7795 | gcc -o <output> <objectfiles> <dll name>.def | |
7796 | @end example | |
7797 | ||
0a5d968e NC |
7798 | Using a DEF file turns off the normal auto-export behavior, unless the |
7799 | @samp{--export-all-symbols} option is also used. | |
7800 | ||
dc8465bf NC |
7801 | Here is an example of a DEF file for a shared library called @samp{xyz.dll}: |
7802 | ||
7803 | @example | |
4b5bd4e7 | 7804 | LIBRARY "xyz.dll" BASE=0x20000000 |
dc8465bf NC |
7805 | |
7806 | EXPORTS | |
7807 | foo | |
7808 | bar | |
7809 | _bar = bar | |
4b5bd4e7 DS |
7810 | another_foo = abc.dll.afoo |
7811 | var1 DATA | |
7fcab871 KT |
7812 | doo = foo == foo2 |
7813 | eoo DATA == var1 | |
c0065db7 | 7814 | @end example |
dc8465bf | 7815 | |
7fcab871 | 7816 | This example defines a DLL with a non-default base address and seven |
4b5bd4e7 DS |
7817 | symbols in the export table. The third exported symbol @code{_bar} is an |
7818 | alias for the second. The fourth symbol, @code{another_foo} is resolved | |
7819 | by "forwarding" to another module and treating it as an alias for | |
7820 | @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol | |
7fcab871 KT |
7821 | @code{var1} is declared to be a data object. The @samp{doo} symbol in |
7822 | export library is an alias of @samp{foo}, which gets the string name | |
7823 | in export table @samp{foo2}. The @samp{eoo} symbol is an data export | |
7824 | symbol, which gets in export table the name @samp{var1}. | |
4b5bd4e7 | 7825 | |
6b31ad16 DS |
7826 | The optional @code{LIBRARY <name>} command indicates the @emph{internal} |
7827 | name of the output DLL. If @samp{<name>} does not include a suffix, | |
7828 | the default library suffix, @samp{.DLL} is appended. | |
7829 | ||
b45619c0 NC |
7830 | When the .DEF file is used to build an application, rather than a |
7831 | library, the @code{NAME <name>} command should be used instead of | |
6b31ad16 | 7832 | @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default |
c0065db7 | 7833 | executable suffix, @samp{.EXE} is appended. |
6b31ad16 DS |
7834 | |
7835 | With either @code{LIBRARY <name>} or @code{NAME <name>} the optional | |
7836 | specification @code{BASE = <number>} may be used to specify a | |
c0065db7 | 7837 | non-default base address for the image. |
6b31ad16 DS |
7838 | |
7839 | If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified, | |
a2877985 DS |
7840 | or they specify an empty string, the internal name is the same as the |
7841 | filename specified on the command line. | |
6b31ad16 | 7842 | |
4b5bd4e7 DS |
7843 | The complete specification of an export symbol is: |
7844 | ||
7845 | @example | |
7846 | EXPORTS | |
7847 | ( ( ( <name1> [ = <name2> ] ) | |
7848 | | ( <name1> = <module-name> . <external-name>)) | |
7fcab871 | 7849 | [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) * |
c0065db7 | 7850 | @end example |
4b5bd4e7 DS |
7851 | |
7852 | Declares @samp{<name1>} as an exported symbol from the DLL, or declares | |
7853 | @samp{<name1>} as an exported alias for @samp{<name2>}; or declares | |
7854 | @samp{<name1>} as a "forward" alias for the symbol | |
7855 | @samp{<external-name>} in the DLL @samp{<module-name>}. | |
7856 | Optionally, the symbol may be exported by the specified ordinal | |
7fcab871 KT |
7857 | @samp{<integer>} alias. The optional @samp{<name3>} is the to be used |
7858 | string in import/export table for the symbol. | |
4b5bd4e7 DS |
7859 | |
7860 | The optional keywords that follow the declaration indicate: | |
7861 | ||
7862 | @code{NONAME}: Do not put the symbol name in the DLL's export table. It | |
7863 | will still be exported by its ordinal alias (either the value specified | |
7864 | by the .def specification or, otherwise, the value assigned by the | |
7865 | linker). The symbol name, however, does remain visible in the import | |
7866 | library (if any), unless @code{PRIVATE} is also specified. | |
7867 | ||
7868 | @code{DATA}: The symbol is a variable or object, rather than a function. | |
7869 | The import lib will export only an indirect reference to @code{foo} as | |
7870 | the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as | |
7871 | @code{*_imp__foo}). | |
7872 | ||
7873 | @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as | |
7874 | well as @code{_imp__foo} into the import library. Both refer to the | |
7875 | read-only import address table's pointer to the variable, not to the | |
7876 | variable itself. This can be dangerous. If the user code fails to add | |
7877 | the @code{dllimport} attribute and also fails to explicitly add the | |
7878 | extra indirection that the use of the attribute enforces, the | |
7879 | application will behave unexpectedly. | |
7880 | ||
7881 | @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put | |
7882 | it into the static import library used to resolve imports at link time. The | |
7883 | symbol can still be imported using the @code{LoadLibrary/GetProcAddress} | |
de194d85 | 7884 | API at runtime or by using the GNU ld extension of linking directly to |
4b5bd4e7 | 7885 | the DLL without an import library. |
c0065db7 | 7886 | |
4b5bd4e7 DS |
7887 | See ld/deffilep.y in the binutils sources for the full specification of |
7888 | other DEF file statements | |
dc8465bf NC |
7889 | |
7890 | @cindex creating a DEF file | |
7891 | While linking a shared dll, @command{ld} is able to create a DEF file | |
7892 | with the @samp{--output-def <file>} command line option. | |
0a5d968e NC |
7893 | |
7894 | @item Using decorations | |
7895 | @cindex Using decorations | |
7896 | Another way of marking symbols for export is to modify the source code | |
7897 | itself, so that when building the DLL each symbol to be exported is | |
7898 | declared as: | |
7899 | ||
7900 | @example | |
7901 | __declspec(dllexport) int a_variable | |
7902 | __declspec(dllexport) void a_function(int with_args) | |
7903 | @end example | |
7904 | ||
7905 | All such symbols will be exported from the DLL. If, however, | |
7906 | any of the object files in the DLL contain symbols decorated in | |
7907 | this way, then the normal auto-export behavior is disabled, unless | |
7908 | the @samp{--export-all-symbols} option is also used. | |
7909 | ||
7910 | Note that object files that wish to access these symbols must @emph{not} | |
c0065db7 | 7911 | decorate them with dllexport. Instead, they should use dllimport, |
0a5d968e NC |
7912 | instead: |
7913 | ||
7914 | @example | |
7915 | __declspec(dllimport) int a_variable | |
7916 | __declspec(dllimport) void a_function(int with_args) | |
7917 | @end example | |
7918 | ||
c0065db7 RM |
7919 | This complicates the structure of library header files, because |
7920 | when included by the library itself the header must declare the | |
0a5d968e NC |
7921 | variables and functions as dllexport, but when included by client |
7922 | code the header must declare them as dllimport. There are a number | |
c0065db7 | 7923 | of idioms that are typically used to do this; often client code can |
0a5d968e NC |
7924 | omit the __declspec() declaration completely. See |
7925 | @samp{--enable-auto-import} and @samp{automatic data imports} for more | |
b45619c0 | 7926 | information. |
c0065db7 | 7927 | @end table |
dc8465bf | 7928 | |
2ca22b03 NC |
7929 | @cindex automatic data imports |
7930 | @item automatic data imports | |
7931 | The standard Windows dll format supports data imports from dlls only | |
69da35b5 | 7932 | by adding special decorations (dllimport/dllexport), which let the |
2ca22b03 | 7933 | compiler produce specific assembler instructions to deal with this |
c0065db7 | 7934 | issue. This increases the effort necessary to port existing Un*x |
69da35b5 | 7935 | code to these platforms, especially for large |
2ca22b03 | 7936 | c++ libraries and applications. The auto-import feature, which was |
c0065db7 | 7937 | initially provided by Paul Sokolovsky, allows one to omit the |
b45619c0 | 7938 | decorations to achieve a behavior that conforms to that on POSIX/Un*x |
c0065db7 | 7939 | platforms. This feature is enabled with the @samp{--enable-auto-import} |
69da35b5 NC |
7940 | command-line option, although it is enabled by default on cygwin/mingw. |
7941 | The @samp{--enable-auto-import} option itself now serves mainly to | |
7942 | suppress any warnings that are ordinarily emitted when linked objects | |
7943 | trigger the feature's use. | |
7944 | ||
c0065db7 | 7945 | auto-import of variables does not always work flawlessly without |
69da35b5 NC |
7946 | additional assistance. Sometimes, you will see this message |
7947 | ||
c0065db7 | 7948 | "variable '<var>' can't be auto-imported. Please read the |
69da35b5 NC |
7949 | documentation for ld's @code{--enable-auto-import} for details." |
7950 | ||
c0065db7 RM |
7951 | The @samp{--enable-auto-import} documentation explains why this error |
7952 | occurs, and several methods that can be used to overcome this difficulty. | |
7953 | One of these methods is the @emph{runtime pseudo-relocs} feature, described | |
69da35b5 NC |
7954 | below. |
7955 | ||
7956 | @cindex runtime pseudo-relocation | |
c0065db7 RM |
7957 | For complex variables imported from DLLs (such as structs or classes), |
7958 | object files typically contain a base address for the variable and an | |
7959 | offset (@emph{addend}) within the variable--to specify a particular | |
7960 | field or public member, for instance. Unfortunately, the runtime loader used | |
7961 | in win32 environments is incapable of fixing these references at runtime | |
69da35b5 | 7962 | without the additional information supplied by dllimport/dllexport decorations. |
c0065db7 | 7963 | The standard auto-import feature described above is unable to resolve these |
69da35b5 NC |
7964 | references. |
7965 | ||
c0065db7 RM |
7966 | The @samp{--enable-runtime-pseudo-relocs} switch allows these references to |
7967 | be resolved without error, while leaving the task of adjusting the references | |
7968 | themselves (with their non-zero addends) to specialized code provided by the | |
7969 | runtime environment. Recent versions of the cygwin and mingw environments and | |
7970 | compilers provide this runtime support; older versions do not. However, the | |
7971 | support is only necessary on the developer's platform; the compiled result will | |
69da35b5 NC |
7972 | run without error on an older system. |
7973 | ||
c0065db7 RM |
7974 | @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly |
7975 | enabled as needed. | |
2ca22b03 NC |
7976 | |
7977 | @cindex direct linking to a dll | |
7978 | @item direct linking to a dll | |
7979 | The cygwin/mingw ports of @command{ld} support the direct linking, | |
7980 | including data symbols, to a dll without the usage of any import | |
69da35b5 | 7981 | libraries. This is much faster and uses much less memory than does the |
b45619c0 | 7982 | traditional import library method, especially when linking large |
c0065db7 RM |
7983 | libraries or applications. When @command{ld} creates an import lib, each |
7984 | function or variable exported from the dll is stored in its own bfd, even | |
7985 | though a single bfd could contain many exports. The overhead involved in | |
69da35b5 | 7986 | storing, loading, and processing so many bfd's is quite large, and explains the |
c0065db7 | 7987 | tremendous time, memory, and storage needed to link against particularly |
69da35b5 NC |
7988 | large or complex libraries when using import libs. |
7989 | ||
c0065db7 | 7990 | Linking directly to a dll uses no extra command-line switches other than |
69da35b5 | 7991 | @samp{-L} and @samp{-l}, because @command{ld} already searches for a number |
c0065db7 | 7992 | of names to match each library. All that is needed from the developer's |
69da35b5 NC |
7993 | perspective is an understanding of this search, in order to force ld to |
7994 | select the dll instead of an import library. | |
7995 | ||
2ca22b03 | 7996 | |
69da35b5 NC |
7997 | For instance, when ld is called with the argument @samp{-lxxx} it will attempt |
7998 | to find, in the first directory of its search path, | |
2ca22b03 NC |
7999 | |
8000 | @example | |
45e948fe NC |
8001 | libxxx.dll.a |
8002 | xxx.dll.a | |
8003 | libxxx.a | |
8004 | xxx.lib | |
f6c4d4b1 | 8005 | libxxx.lib |
69da35b5 | 8006 | cygxxx.dll (*) |
45e948fe NC |
8007 | libxxx.dll |
8008 | xxx.dll | |
2ca22b03 NC |
8009 | @end example |
8010 | ||
69da35b5 NC |
8011 | before moving on to the next directory in the search path. |
8012 | ||
c0065db7 RM |
8013 | (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll}, |
8014 | where @samp{<prefix>} is set by the @command{ld} option | |
8015 | @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec | |
8016 | file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for | |
69da35b5 NC |
8017 | @samp{cygxxx.dll}. |
8018 | ||
c0065db7 RM |
8019 | Other win32-based unix environments, such as mingw or pw32, may use other |
8020 | @samp{<prefix>}es, although at present only cygwin makes use of this feature. It | |
69da35b5 NC |
8021 | was originally intended to help avoid name conflicts among dll's built for the |
8022 | various win32/un*x environments, so that (for example) two versions of a zlib dll | |
8023 | could coexist on the same machine. | |
8024 | ||
2ca22b03 NC |
8025 | The generic cygwin/mingw path layout uses a @samp{bin} directory for |
8026 | applications and dll's and a @samp{lib} directory for the import | |
69da35b5 | 8027 | libraries (using cygwin nomenclature): |
2ca22b03 NC |
8028 | |
8029 | @example | |
8030 | bin/ | |
8031 | cygxxx.dll | |
8032 | lib/ | |
8033 | libxxx.dll.a (in case of dll's) | |
c0065db7 | 8034 | libxxx.a (in case of static archive) |
2ca22b03 NC |
8035 | @end example |
8036 | ||
c0065db7 RM |
8037 | Linking directly to a dll without using the import library can be |
8038 | done two ways: | |
2ca22b03 NC |
8039 | |
8040 | 1. Use the dll directly by adding the @samp{bin} path to the link line | |
8041 | @example | |
8042 | gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx | |
c0065db7 | 8043 | @end example |
2ca22b03 | 8044 | |
69da35b5 NC |
8045 | However, as the dll's often have version numbers appended to their names |
8046 | (@samp{cygncurses-5.dll}) this will often fail, unless one specifies | |
8047 | @samp{-L../bin -lncurses-5} to include the version. Import libs are generally | |
8048 | not versioned, and do not have this difficulty. | |
8049 | ||
2ca22b03 NC |
8050 | 2. Create a symbolic link from the dll to a file in the @samp{lib} |
8051 | directory according to the above mentioned search pattern. This | |
8052 | should be used to avoid unwanted changes in the tools needed for | |
8053 | making the app/dll. | |
8054 | ||
8055 | @example | |
8056 | ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a] | |
c0065db7 | 8057 | @end example |
2ca22b03 NC |
8058 | |
8059 | Then you can link without any make environment changes. | |
8060 | ||
8061 | @example | |
8062 | gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx | |
c0065db7 | 8063 | @end example |
69da35b5 NC |
8064 | |
8065 | This technique also avoids the version number problems, because the following is | |
8066 | perfectly legal | |
8067 | ||
8068 | @example | |
8069 | bin/ | |
8070 | cygxxx-5.dll | |
8071 | lib/ | |
c0065db7 | 8072 | libxxx.dll.a -> ../bin/cygxxx-5.dll |
69da35b5 NC |
8073 | @end example |
8074 | ||
dc8465bf | 8075 | Linking directly to a dll without using an import lib will work |
69da35b5 NC |
8076 | even when auto-import features are exercised, and even when |
8077 | @samp{--enable-runtime-pseudo-relocs} is used. | |
8078 | ||
8079 | Given the improvements in speed and memory usage, one might justifiably | |
45e948fe | 8080 | wonder why import libraries are used at all. There are three reasons: |
69da35b5 NC |
8081 | |
8082 | 1. Until recently, the link-directly-to-dll functionality did @emph{not} | |
8083 | work with auto-imported data. | |
8084 | ||
dc8465bf NC |
8085 | 2. Sometimes it is necessary to include pure static objects within the |
8086 | import library (which otherwise contains only bfd's for indirection | |
8087 | symbols that point to the exports of a dll). Again, the import lib | |
8088 | for the cygwin kernel makes use of this ability, and it is not | |
8089 | possible to do this without an import lib. | |
69da35b5 | 8090 | |
45e948fe NC |
8091 | 3. Symbol aliases can only be resolved using an import lib. This is |
8092 | critical when linking against OS-supplied dll's (eg, the win32 API) | |
8093 | in which symbols are usually exported as undecorated aliases of their | |
8094 | stdcall-decorated assembly names. | |
8095 | ||
69da35b5 | 8096 | So, import libs are not going away. But the ability to replace |
c0065db7 RM |
8097 | true import libs with a simple symbolic link to (or a copy of) |
8098 | a dll, in many cases, is a useful addition to the suite of tools | |
8099 | binutils makes available to the win32 developer. Given the | |
69da35b5 NC |
8100 | massive improvements in memory requirements during linking, storage |
8101 | requirements, and linking speed, we expect that many developers | |
8102 | will soon begin to use this feature whenever possible. | |
dc8465bf | 8103 | |
c0065db7 | 8104 | @item symbol aliasing |
dc8465bf | 8105 | @table @emph |
c0065db7 RM |
8106 | @item adding additional names |
8107 | Sometimes, it is useful to export symbols with additional names. | |
dc8465bf NC |
8108 | A symbol @samp{foo} will be exported as @samp{foo}, but it can also be |
8109 | exported as @samp{_foo} by using special directives in the DEF file | |
8110 | when creating the dll. This will affect also the optional created | |
c0065db7 | 8111 | import library. Consider the following DEF file: |
dc8465bf | 8112 | |
c0065db7 | 8113 | @example |
dc8465bf NC |
8114 | LIBRARY "xyz.dll" BASE=0x61000000 |
8115 | ||
8116 | EXPORTS | |
c0065db7 | 8117 | foo |
dc8465bf | 8118 | _foo = foo |
c0065db7 | 8119 | @end example |
dc8465bf NC |
8120 | |
8121 | The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}. | |
8122 | ||
8123 | Another method for creating a symbol alias is to create it in the | |
8124 | source code using the "weak" attribute: | |
8125 | ||
c0065db7 RM |
8126 | @example |
8127 | void foo () @{ /* Do something. */; @} | |
dc8465bf | 8128 | void _foo () __attribute__ ((weak, alias ("foo"))); |
c0065db7 | 8129 | @end example |
dc8465bf NC |
8130 | |
8131 | See the gcc manual for more information about attributes and weak | |
8132 | symbols. | |
8133 | ||
8134 | @item renaming symbols | |
8135 | Sometimes it is useful to rename exports. For instance, the cygwin | |
c0065db7 | 8136 | kernel does this regularly. A symbol @samp{_foo} can be exported as |
dc8465bf NC |
8137 | @samp{foo} but not as @samp{_foo} by using special directives in the |
8138 | DEF file. (This will also affect the import library, if it is | |
c0065db7 | 8139 | created). In the following example: |
dc8465bf | 8140 | |
c0065db7 | 8141 | @example |
dc8465bf NC |
8142 | LIBRARY "xyz.dll" BASE=0x61000000 |
8143 | ||
8144 | EXPORTS | |
8145 | _foo = foo | |
c0065db7 | 8146 | @end example |
dc8465bf NC |
8147 | |
8148 | The line @samp{_foo = foo} maps the exported symbol @samp{foo} to | |
8149 | @samp{_foo}. | |
c0065db7 | 8150 | @end table |
dc8465bf | 8151 | |
0a5d968e | 8152 | Note: using a DEF file disables the default auto-export behavior, |
c0065db7 | 8153 | unless the @samp{--export-all-symbols} command line option is used. |
0a5d968e | 8154 | If, however, you are trying to rename symbols, then you should list |
c0065db7 RM |
8155 | @emph{all} desired exports in the DEF file, including the symbols |
8156 | that are not being renamed, and do @emph{not} use the | |
8157 | @samp{--export-all-symbols} option. If you list only the | |
8158 | renamed symbols in the DEF file, and use @samp{--export-all-symbols} | |
8159 | to handle the other symbols, then the both the new names @emph{and} | |
8160 | the original names for the renamed symbols will be exported. | |
8161 | In effect, you'd be aliasing those symbols, not renaming them, | |
0a5d968e | 8162 | which is probably not what you wanted. |
c87db184 CF |
8163 | |
8164 | @cindex weak externals | |
8165 | @item weak externals | |
8166 | The Windows object format, PE, specifies a form of weak symbols called | |
8167 | weak externals. When a weak symbol is linked and the symbol is not | |
8168 | defined, the weak symbol becomes an alias for some other symbol. There | |
8169 | are three variants of weak externals: | |
8170 | @itemize | |
8171 | @item Definition is searched for in objects and libraries, historically | |
8172 | called lazy externals. | |
8173 | @item Definition is searched for only in other objects, not in libraries. | |
8174 | This form is not presently implemented. | |
8175 | @item No search; the symbol is an alias. This form is not presently | |
8176 | implemented. | |
8177 | @end itemize | |
8178 | As a GNU extension, weak symbols that do not specify an alternate symbol | |
8179 | are supported. If the symbol is undefined when linking, the symbol | |
8180 | uses a default value. | |
c1711530 DK |
8181 | |
8182 | @cindex aligned common symbols | |
8183 | @item aligned common symbols | |
8184 | As a GNU extension to the PE file format, it is possible to specify the | |
8185 | desired alignment for a common symbol. This information is conveyed from | |
8186 | the assembler or compiler to the linker by means of GNU-specific commands | |
8187 | carried in the object file's @samp{.drectve} section, which are recognized | |
8188 | by @command{ld} and respected when laying out the common symbols. Native | |
8189 | tools will be able to process object files employing this GNU extension, | |
8190 | but will fail to respect the alignment instructions, and may issue noisy | |
8191 | warnings about unknown linker directives. | |
5063daf7 | 8192 | |
2ca22b03 NC |
8193 | @end table |
8194 | ||
8195 | @ifclear GENERIC | |
8196 | @lowersections | |
8197 | @end ifclear | |
8198 | @end ifset | |
8199 | ||
e0001a05 NC |
8200 | @ifset XTENSA |
8201 | @ifclear GENERIC | |
8202 | @raisesections | |
8203 | @end ifclear | |
8204 | ||
8205 | @node Xtensa | |
8206 | @section @code{ld} and Xtensa Processors | |
8207 | ||
8208 | @cindex Xtensa processors | |
8209 | The default @command{ld} behavior for Xtensa processors is to interpret | |
8210 | @code{SECTIONS} commands so that lists of explicitly named sections in a | |
8211 | specification with a wildcard file will be interleaved when necessary to | |
8212 | keep literal pools within the range of PC-relative load offsets. For | |
8213 | example, with the command: | |
8214 | ||
8215 | @smallexample | |
8216 | SECTIONS | |
8217 | @{ | |
8218 | .text : @{ | |
8219 | *(.literal .text) | |
8220 | @} | |
8221 | @} | |
8222 | @end smallexample | |
8223 | ||
8224 | @noindent | |
8225 | @command{ld} may interleave some of the @code{.literal} | |
8226 | and @code{.text} sections from different object files to ensure that the | |
8227 | literal pools are within the range of PC-relative load offsets. A valid | |
8228 | interleaving might place the @code{.literal} sections from an initial | |
8229 | group of files followed by the @code{.text} sections of that group of | |
8230 | files. Then, the @code{.literal} sections from the rest of the files | |
8231 | and the @code{.text} sections from the rest of the files would follow. | |
e0001a05 | 8232 | |
43cd72b9 | 8233 | @cindex @option{--relax} on Xtensa |
e0001a05 | 8234 | @cindex relaxing on Xtensa |
43cd72b9 BW |
8235 | Relaxation is enabled by default for the Xtensa version of @command{ld} and |
8236 | provides two important link-time optimizations. The first optimization | |
8237 | is to combine identical literal values to reduce code size. A redundant | |
8238 | literal will be removed and all the @code{L32R} instructions that use it | |
8239 | will be changed to reference an identical literal, as long as the | |
8240 | location of the replacement literal is within the offset range of all | |
8241 | the @code{L32R} instructions. The second optimization is to remove | |
8242 | unnecessary overhead from assembler-generated ``longcall'' sequences of | |
8243 | @code{L32R}/@code{CALLX@var{n}} when the target functions are within | |
8244 | range of direct @code{CALL@var{n}} instructions. | |
8245 | ||
8246 | For each of these cases where an indirect call sequence can be optimized | |
8247 | to a direct call, the linker will change the @code{CALLX@var{n}} | |
8248 | instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R} | |
8249 | instruction, and remove the literal referenced by the @code{L32R} | |
8250 | instruction if it is not used for anything else. Removing the | |
8251 | @code{L32R} instruction always reduces code size but can potentially | |
8252 | hurt performance by changing the alignment of subsequent branch targets. | |
8253 | By default, the linker will always preserve alignments, either by | |
8254 | switching some instructions between 24-bit encodings and the equivalent | |
8255 | density instructions or by inserting a no-op in place of the @code{L32R} | |
8256 | instruction that was removed. If code size is more important than | |
8257 | performance, the @option{--size-opt} option can be used to prevent the | |
8258 | linker from widening density instructions or inserting no-ops, except in | |
8259 | a few cases where no-ops are required for correctness. | |
8260 | ||
8261 | The following Xtensa-specific command-line options can be used to | |
8262 | control the linker: | |
8263 | ||
8264 | @cindex Xtensa options | |
8265 | @table @option | |
43cd72b9 BW |
8266 | @item --size-opt |
8267 | When optimizing indirect calls to direct calls, optimize for code size | |
8268 | more than performance. With this option, the linker will not insert | |
8269 | no-ops or widen density instructions to preserve branch target | |
8270 | alignment. There may still be some cases where no-ops are required to | |
8271 | preserve the correctness of the code. | |
8272 | @end table | |
e0001a05 NC |
8273 | |
8274 | @ifclear GENERIC | |
8275 | @lowersections | |
8276 | @end ifclear | |
8277 | @end ifset | |
8278 | ||
252b5132 RH |
8279 | @ifclear SingleFormat |
8280 | @node BFD | |
8281 | @chapter BFD | |
8282 | ||
8283 | @cindex back end | |
8284 | @cindex object file management | |
8285 | @cindex object formats available | |
8286 | @kindex objdump -i | |
8287 | The linker accesses object and archive files using the BFD libraries. | |
8288 | These libraries allow the linker to use the same routines to operate on | |
8289 | object files whatever the object file format. A different object file | |
8290 | format can be supported simply by creating a new BFD back end and adding | |
8291 | it to the library. To conserve runtime memory, however, the linker and | |
8292 | associated tools are usually configured to support only a subset of the | |
8293 | object file formats available. You can use @code{objdump -i} | |
8294 | (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to | |
8295 | list all the formats available for your configuration. | |
8296 | ||
8297 | @cindex BFD requirements | |
8298 | @cindex requirements for BFD | |
8299 | As with most implementations, BFD is a compromise between | |
8300 | several conflicting requirements. The major factor influencing | |
8301 | BFD design was efficiency: any time used converting between | |
8302 | formats is time which would not have been spent had BFD not | |
8303 | been involved. This is partly offset by abstraction payback; since | |
8304 | BFD simplifies applications and back ends, more time and care | |
8305 | may be spent optimizing algorithms for a greater speed. | |
8306 | ||
8307 | One minor artifact of the BFD solution which you should bear in | |
8308 | mind is the potential for information loss. There are two places where | |
8309 | useful information can be lost using the BFD mechanism: during | |
8310 | conversion and during output. @xref{BFD information loss}. | |
8311 | ||
8312 | @menu | |
8313 | * BFD outline:: How it works: an outline of BFD | |
8314 | @end menu | |
8315 | ||
8316 | @node BFD outline | |
36f63dca | 8317 | @section How It Works: An Outline of BFD |
252b5132 RH |
8318 | @cindex opening object files |
8319 | @include bfdsumm.texi | |
8320 | @end ifclear | |
8321 | ||
8322 | @node Reporting Bugs | |
8323 | @chapter Reporting Bugs | |
ff5dcc92 SC |
8324 | @cindex bugs in @command{ld} |
8325 | @cindex reporting bugs in @command{ld} | |
252b5132 | 8326 | |
ff5dcc92 | 8327 | Your bug reports play an essential role in making @command{ld} reliable. |
252b5132 RH |
8328 | |
8329 | Reporting a bug may help you by bringing a solution to your problem, or | |
8330 | it may not. But in any case the principal function of a bug report is | |
ff5dcc92 | 8331 | to help the entire community by making the next version of @command{ld} |
252b5132 | 8332 | work better. Bug reports are your contribution to the maintenance of |
ff5dcc92 | 8333 | @command{ld}. |
252b5132 RH |
8334 | |
8335 | In order for a bug report to serve its purpose, you must include the | |
8336 | information that enables us to fix the bug. | |
8337 | ||
8338 | @menu | |
8339 | * Bug Criteria:: Have you found a bug? | |
8340 | * Bug Reporting:: How to report bugs | |
8341 | @end menu | |
8342 | ||
8343 | @node Bug Criteria | |
36f63dca | 8344 | @section Have You Found a Bug? |
252b5132 RH |
8345 | @cindex bug criteria |
8346 | ||
8347 | If you are not sure whether you have found a bug, here are some guidelines: | |
8348 | ||
8349 | @itemize @bullet | |
8350 | @cindex fatal signal | |
8351 | @cindex linker crash | |
8352 | @cindex crash of linker | |
8353 | @item | |
8354 | If the linker gets a fatal signal, for any input whatever, that is a | |
ff5dcc92 | 8355 | @command{ld} bug. Reliable linkers never crash. |
252b5132 RH |
8356 | |
8357 | @cindex error on valid input | |
8358 | @item | |
ff5dcc92 | 8359 | If @command{ld} produces an error message for valid input, that is a bug. |
252b5132 RH |
8360 | |
8361 | @cindex invalid input | |
8362 | @item | |
ff5dcc92 | 8363 | If @command{ld} does not produce an error message for invalid input, that |
252b5132 RH |
8364 | may be a bug. In the general case, the linker can not verify that |
8365 | object files are correct. | |
8366 | ||
8367 | @item | |
8368 | If you are an experienced user of linkers, your suggestions for | |
ff5dcc92 | 8369 | improvement of @command{ld} are welcome in any case. |
252b5132 RH |
8370 | @end itemize |
8371 | ||
8372 | @node Bug Reporting | |
36f63dca | 8373 | @section How to Report Bugs |
252b5132 | 8374 | @cindex bug reports |
ff5dcc92 | 8375 | @cindex @command{ld} bugs, reporting |
252b5132 RH |
8376 | |
8377 | A number of companies and individuals offer support for @sc{gnu} | |
ff5dcc92 | 8378 | products. If you obtained @command{ld} from a support organization, we |
252b5132 RH |
8379 | recommend you contact that organization first. |
8380 | ||
8381 | You can find contact information for many support companies and | |
8382 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
8383 | distribution. | |
8384 | ||
ad22bfe8 | 8385 | @ifset BUGURL |
ff5dcc92 | 8386 | Otherwise, send bug reports for @command{ld} to |
ad22bfe8 JM |
8387 | @value{BUGURL}. |
8388 | @end ifset | |
252b5132 RH |
8389 | |
8390 | The fundamental principle of reporting bugs usefully is this: | |
8391 | @strong{report all the facts}. If you are not sure whether to state a | |
8392 | fact or leave it out, state it! | |
8393 | ||
8394 | Often people omit facts because they think they know what causes the | |
8395 | problem and assume that some details do not matter. Thus, you might | |
b553b183 NC |
8396 | assume that the name of a symbol you use in an example does not |
8397 | matter. Well, probably it does not, but one cannot be sure. Perhaps | |
8398 | the bug is a stray memory reference which happens to fetch from the | |
8399 | location where that name is stored in memory; perhaps, if the name | |
8400 | were different, the contents of that location would fool the linker | |
8401 | into doing the right thing despite the bug. Play it safe and give a | |
8402 | specific, complete example. That is the easiest thing for you to do, | |
c0065db7 | 8403 | and the most helpful. |
b553b183 NC |
8404 | |
8405 | Keep in mind that the purpose of a bug report is to enable us to fix | |
8406 | the bug if it is new to us. Therefore, always write your bug reports | |
8407 | on the assumption that the bug has not been reported previously. | |
252b5132 RH |
8408 | |
8409 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
36f63dca NC |
8410 | bell?'' This cannot help us fix a bug, so it is basically useless. We |
8411 | respond by asking for enough details to enable us to investigate. | |
8412 | You might as well expedite matters by sending them to begin with. | |
252b5132 RH |
8413 | |
8414 | To enable us to fix the bug, you should include all these things: | |
8415 | ||
8416 | @itemize @bullet | |
8417 | @item | |
ff5dcc92 | 8418 | The version of @command{ld}. @command{ld} announces it if you start it with |
252b5132 RH |
8419 | the @samp{--version} argument. |
8420 | ||
8421 | Without this, we will not know whether there is any point in looking for | |
ff5dcc92 | 8422 | the bug in the current version of @command{ld}. |
252b5132 RH |
8423 | |
8424 | @item | |
ff5dcc92 | 8425 | Any patches you may have applied to the @command{ld} source, including any |
252b5132 RH |
8426 | patches made to the @code{BFD} library. |
8427 | ||
8428 | @item | |
8429 | The type of machine you are using, and the operating system name and | |
8430 | version number. | |
8431 | ||
8432 | @item | |
ff5dcc92 | 8433 | What compiler (and its version) was used to compile @command{ld}---e.g. |
252b5132 RH |
8434 | ``@code{gcc-2.7}''. |
8435 | ||
8436 | @item | |
8437 | The command arguments you gave the linker to link your example and | |
8438 | observe the bug. To guarantee you will not omit something important, | |
8439 | list them all. A copy of the Makefile (or the output from make) is | |
8440 | sufficient. | |
8441 | ||
8442 | If we were to try to guess the arguments, we would probably guess wrong | |
8443 | and then we might not encounter the bug. | |
8444 | ||
8445 | @item | |
8446 | A complete input file, or set of input files, that will reproduce the | |
b553b183 NC |
8447 | bug. It is generally most helpful to send the actual object files |
8448 | provided that they are reasonably small. Say no more than 10K. For | |
8449 | bigger files you can either make them available by FTP or HTTP or else | |
8450 | state that you are willing to send the object file(s) to whomever | |
8451 | requests them. (Note - your email will be going to a mailing list, so | |
8452 | we do not want to clog it up with large attachments). But small | |
8453 | attachments are best. | |
252b5132 RH |
8454 | |
8455 | If the source files were assembled using @code{gas} or compiled using | |
8456 | @code{gcc}, then it may be OK to send the source files rather than the | |
8457 | object files. In this case, be sure to say exactly what version of | |
8458 | @code{gas} or @code{gcc} was used to produce the object files. Also say | |
8459 | how @code{gas} or @code{gcc} were configured. | |
8460 | ||
8461 | @item | |
8462 | A description of what behavior you observe that you believe is | |
8463 | incorrect. For example, ``It gets a fatal signal.'' | |
8464 | ||
ff5dcc92 | 8465 | Of course, if the bug is that @command{ld} gets a fatal signal, then we |
252b5132 RH |
8466 | will certainly notice it. But if the bug is incorrect output, we might |
8467 | not notice unless it is glaringly wrong. You might as well not give us | |
8468 | a chance to make a mistake. | |
8469 | ||
8470 | Even if the problem you experience is a fatal signal, you should still | |
8471 | say so explicitly. Suppose something strange is going on, such as, your | |
b45619c0 | 8472 | copy of @command{ld} is out of sync, or you have encountered a bug in the |
252b5132 RH |
8473 | C library on your system. (This has happened!) Your copy might crash |
8474 | and ours would not. If you told us to expect a crash, then when ours | |
8475 | fails to crash, we would know that the bug was not happening for us. If | |
8476 | you had not told us to expect a crash, then we would not be able to draw | |
8477 | any conclusion from our observations. | |
8478 | ||
8479 | @item | |
ff5dcc92 | 8480 | If you wish to suggest changes to the @command{ld} source, send us context |
252b5132 RH |
8481 | diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or |
8482 | @samp{-p} option. Always send diffs from the old file to the new file. | |
ff5dcc92 | 8483 | If you even discuss something in the @command{ld} source, refer to it by |
252b5132 RH |
8484 | context, not by line number. |
8485 | ||
8486 | The line numbers in our development sources will not match those in your | |
8487 | sources. Your line numbers would convey no useful information to us. | |
8488 | @end itemize | |
8489 | ||
8490 | Here are some things that are not necessary: | |
8491 | ||
8492 | @itemize @bullet | |
8493 | @item | |
8494 | A description of the envelope of the bug. | |
8495 | ||
8496 | Often people who encounter a bug spend a lot of time investigating | |
8497 | which changes to the input file will make the bug go away and which | |
8498 | changes will not affect it. | |
8499 | ||
8500 | This is often time consuming and not very useful, because the way we | |
8501 | will find the bug is by running a single example under the debugger | |
8502 | with breakpoints, not by pure deduction from a series of examples. | |
8503 | We recommend that you save your time for something else. | |
8504 | ||
8505 | Of course, if you can find a simpler example to report @emph{instead} | |
8506 | of the original one, that is a convenience for us. Errors in the | |
8507 | output will be easier to spot, running under the debugger will take | |
8508 | less time, and so on. | |
8509 | ||
8510 | However, simplification is not vital; if you do not want to do this, | |
8511 | report the bug anyway and send us the entire test case you used. | |
8512 | ||
8513 | @item | |
8514 | A patch for the bug. | |
8515 | ||
8516 | A patch for the bug does help us if it is a good one. But do not omit | |
8517 | the necessary information, such as the test case, on the assumption that | |
8518 | a patch is all we need. We might see problems with your patch and decide | |
8519 | to fix the problem another way, or we might not understand it at all. | |
8520 | ||
ff5dcc92 | 8521 | Sometimes with a program as complicated as @command{ld} it is very hard to |
252b5132 RH |
8522 | construct an example that will make the program follow a certain path |
8523 | through the code. If you do not send us the example, we will not be | |
8524 | able to construct one, so we will not be able to verify that the bug is | |
8525 | fixed. | |
8526 | ||
8527 | And if we cannot understand what bug you are trying to fix, or why your | |
8528 | patch should be an improvement, we will not install it. A test case will | |
8529 | help us to understand. | |
8530 | ||
8531 | @item | |
8532 | A guess about what the bug is or what it depends on. | |
8533 | ||
8534 | Such guesses are usually wrong. Even we cannot guess right about such | |
8535 | things without first using the debugger to find the facts. | |
8536 | @end itemize | |
8537 | ||
8538 | @node MRI | |
8539 | @appendix MRI Compatible Script Files | |
8540 | @cindex MRI compatibility | |
ff5dcc92 SC |
8541 | To aid users making the transition to @sc{gnu} @command{ld} from the MRI |
8542 | linker, @command{ld} can use MRI compatible linker scripts as an | |
252b5132 RH |
8543 | alternative to the more general-purpose linker scripting language |
8544 | described in @ref{Scripts}. MRI compatible linker scripts have a much | |
8545 | simpler command set than the scripting language otherwise used with | |
ff5dcc92 | 8546 | @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI |
252b5132 RH |
8547 | linker commands; these commands are described here. |
8548 | ||
8549 | In general, MRI scripts aren't of much use with the @code{a.out} object | |
8550 | file format, since it only has three sections and MRI scripts lack some | |
8551 | features to make use of them. | |
8552 | ||
8553 | You can specify a file containing an MRI-compatible script using the | |
8554 | @samp{-c} command-line option. | |
8555 | ||
8556 | Each command in an MRI-compatible script occupies its own line; each | |
8557 | command line starts with the keyword that identifies the command (though | |
8558 | blank lines are also allowed for punctuation). If a line of an | |
ff5dcc92 | 8559 | MRI-compatible script begins with an unrecognized keyword, @command{ld} |
252b5132 RH |
8560 | issues a warning message, but continues processing the script. |
8561 | ||
8562 | Lines beginning with @samp{*} are comments. | |
8563 | ||
8564 | You can write these commands using all upper-case letters, or all | |
8565 | lower case; for example, @samp{chip} is the same as @samp{CHIP}. | |
8566 | The following list shows only the upper-case form of each command. | |
8567 | ||
8568 | @table @code | |
8569 | @cindex @code{ABSOLUTE} (MRI) | |
8570 | @item ABSOLUTE @var{secname} | |
8571 | @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname} | |
ff5dcc92 | 8572 | Normally, @command{ld} includes in the output file all sections from all |
252b5132 RH |
8573 | the input files. However, in an MRI-compatible script, you can use the |
8574 | @code{ABSOLUTE} command to restrict the sections that will be present in | |
8575 | your output program. If the @code{ABSOLUTE} command is used at all in a | |
8576 | script, then only the sections named explicitly in @code{ABSOLUTE} | |
8577 | commands will appear in the linker output. You can still use other | |
8578 | input sections (whatever you select on the command line, or using | |
8579 | @code{LOAD}) to resolve addresses in the output file. | |
8580 | ||
8581 | @cindex @code{ALIAS} (MRI) | |
8582 | @item ALIAS @var{out-secname}, @var{in-secname} | |
8583 | Use this command to place the data from input section @var{in-secname} | |
8584 | in a section called @var{out-secname} in the linker output file. | |
8585 | ||
8586 | @var{in-secname} may be an integer. | |
8587 | ||
8588 | @cindex @code{ALIGN} (MRI) | |
8589 | @item ALIGN @var{secname} = @var{expression} | |
8590 | Align the section called @var{secname} to @var{expression}. The | |
8591 | @var{expression} should be a power of two. | |
8592 | ||
8593 | @cindex @code{BASE} (MRI) | |
8594 | @item BASE @var{expression} | |
8595 | Use the value of @var{expression} as the lowest address (other than | |
8596 | absolute addresses) in the output file. | |
8597 | ||
8598 | @cindex @code{CHIP} (MRI) | |
8599 | @item CHIP @var{expression} | |
8600 | @itemx CHIP @var{expression}, @var{expression} | |
8601 | This command does nothing; it is accepted only for compatibility. | |
8602 | ||
8603 | @cindex @code{END} (MRI) | |
8604 | @item END | |
8605 | This command does nothing whatever; it's only accepted for compatibility. | |
8606 | ||
8607 | @cindex @code{FORMAT} (MRI) | |
8608 | @item FORMAT @var{output-format} | |
8609 | Similar to the @code{OUTPUT_FORMAT} command in the more general linker | |
dc12032b | 8610 | language, but restricted to S-records, if @var{output-format} is @samp{S} |
252b5132 RH |
8611 | |
8612 | @cindex @code{LIST} (MRI) | |
8613 | @item LIST @var{anything}@dots{} | |
8614 | Print (to the standard output file) a link map, as produced by the | |
ff5dcc92 | 8615 | @command{ld} command-line option @samp{-M}. |
252b5132 RH |
8616 | |
8617 | The keyword @code{LIST} may be followed by anything on the | |
8618 | same line, with no change in its effect. | |
8619 | ||
8620 | @cindex @code{LOAD} (MRI) | |
8621 | @item LOAD @var{filename} | |
8622 | @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename} | |
8623 | Include one or more object file @var{filename} in the link; this has the | |
ff5dcc92 | 8624 | same effect as specifying @var{filename} directly on the @command{ld} |
252b5132 RH |
8625 | command line. |
8626 | ||
8627 | @cindex @code{NAME} (MRI) | |
8628 | @item NAME @var{output-name} | |
ff5dcc92 | 8629 | @var{output-name} is the name for the program produced by @command{ld}; the |
252b5132 RH |
8630 | MRI-compatible command @code{NAME} is equivalent to the command-line |
8631 | option @samp{-o} or the general script language command @code{OUTPUT}. | |
8632 | ||
8633 | @cindex @code{ORDER} (MRI) | |
8634 | @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname} | |
8635 | @itemx ORDER @var{secname} @var{secname} @var{secname} | |
ff5dcc92 | 8636 | Normally, @command{ld} orders the sections in its output file in the |
252b5132 RH |
8637 | order in which they first appear in the input files. In an MRI-compatible |
8638 | script, you can override this ordering with the @code{ORDER} command. The | |
8639 | sections you list with @code{ORDER} will appear first in your output | |
8640 | file, in the order specified. | |
8641 | ||
8642 | @cindex @code{PUBLIC} (MRI) | |
8643 | @item PUBLIC @var{name}=@var{expression} | |
8644 | @itemx PUBLIC @var{name},@var{expression} | |
8645 | @itemx PUBLIC @var{name} @var{expression} | |
8646 | Supply a value (@var{expression}) for external symbol | |
8647 | @var{name} used in the linker input files. | |
8648 | ||
8649 | @cindex @code{SECT} (MRI) | |
8650 | @item SECT @var{secname}, @var{expression} | |
8651 | @itemx SECT @var{secname}=@var{expression} | |
8652 | @itemx SECT @var{secname} @var{expression} | |
8653 | You can use any of these three forms of the @code{SECT} command to | |
8654 | specify the start address (@var{expression}) for section @var{secname}. | |
8655 | If you have more than one @code{SECT} statement for the same | |
8656 | @var{secname}, only the @emph{first} sets the start address. | |
8657 | @end table | |
8658 | ||
793c5807 NC |
8659 | @node GNU Free Documentation License |
8660 | @appendix GNU Free Documentation License | |
36f63dca | 8661 | @include fdl.texi |
704c465c | 8662 | |
370b66a1 CD |
8663 | @node LD Index |
8664 | @unnumbered LD Index | |
252b5132 RH |
8665 | |
8666 | @printindex cp | |
8667 | ||
8668 | @tex | |
7ca01ed9 | 8669 | % I think something like @@colophon should be in texinfo. In the |
252b5132 RH |
8670 | % meantime: |
8671 | \long\def\colophon{\hbox to0pt{}\vfill | |
8672 | \centerline{The body of this manual is set in} | |
8673 | \centerline{\fontname\tenrm,} | |
8674 | \centerline{with headings in {\bf\fontname\tenbf}} | |
8675 | \centerline{and examples in {\tt\fontname\tentt}.} | |
8676 | \centerline{{\it\fontname\tenit\/} and} | |
8677 | \centerline{{\sl\fontname\tensl\/}} | |
8678 | \centerline{are used for emphasis.}\vfill} | |
8679 | \page\colophon | |
7ca01ed9 | 8680 | % Blame: doc@@cygnus.com, 28mar91. |
252b5132 RH |
8681 | @end tex |
8682 | ||
252b5132 | 8683 | @bye |