Commit | Line | Data |
---|---|---|
252b5132 RH |
1 | \input texinfo |
2 | @setfilename ld.info | |
b3adc24a | 3 | @c Copyright (C) 1991-2020 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 |
b8891f8d | 24 | @set CSKY |
49fa1e15 | 25 | @set H8300 |
0285c67d | 26 | @set HPPA |
0285c67d | 27 | @set M68HC11 |
7fb9f789 | 28 | @set M68K |
833794fc | 29 | @set MIPS |
3c3bdf30 | 30 | @set MMIX |
2469cfa2 | 31 | @set MSP430 |
35c08157 | 32 | @set NDS32 |
78058a5e | 33 | @set NIOSII |
fa1477dc | 34 | @set PDP11 |
2a60a7a8 AM |
35 | @set POWERPC |
36 | @set POWERPC64 | |
49fa1e15 | 37 | @set Renesas |
b4cbbe8f | 38 | @set S/390 |
49fa1e15 AM |
39 | @set SPU |
40 | @set TICOFF | |
2ca22b03 | 41 | @set WIN32 |
e0001a05 | 42 | @set XTENSA |
0285c67d NC |
43 | @end ifset |
44 | @c man end | |
45 | ||
9160ea82 AM |
46 | @ifnottex |
47 | @dircategory Software development | |
48 | @direntry | |
252b5132 | 49 | * Ld: (ld). The GNU linker. |
9160ea82 AM |
50 | @end direntry |
51 | @end ifnottex | |
252b5132 | 52 | |
0e9517a9 | 53 | @copying |
e49e529d JM |
54 | This file documents the @sc{gnu} linker LD |
55 | @ifset VERSION_PACKAGE | |
56 | @value{VERSION_PACKAGE} | |
57 | @end ifset | |
58 | version @value{VERSION}. | |
252b5132 | 59 | |
b3adc24a | 60 | Copyright @copyright{} 1991-2020 Free Software Foundation, Inc. |
252b5132 | 61 | |
cf055d54 | 62 | Permission is granted to copy, distribute and/or modify this document |
793c5807 | 63 | under the terms of the GNU Free Documentation License, Version 1.3 |
cf055d54 NC |
64 | or any later version published by the Free Software Foundation; |
65 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
66 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 67 | section entitled ``GNU Free Documentation License''. |
0e9517a9 | 68 | @end copying |
252b5132 RH |
69 | @iftex |
70 | @finalout | |
71 | @setchapternewpage odd | |
71ba23f6 | 72 | @settitle The GNU linker |
252b5132 | 73 | @titlepage |
71ba23f6 | 74 | @title The GNU linker |
252b5132 | 75 | @sp 1 |
e49e529d JM |
76 | @subtitle @code{ld} |
77 | @ifset VERSION_PACKAGE | |
78 | @subtitle @value{VERSION_PACKAGE} | |
79 | @end ifset | |
252b5132 RH |
80 | @subtitle Version @value{VERSION} |
81 | @author Steve Chamberlain | |
82 | @author Ian Lance Taylor | |
252b5132 RH |
83 | @page |
84 | ||
85 | @tex | |
86 | {\parskip=0pt | |
704c465c NC |
87 | \hfill Red Hat Inc\par |
88 | \hfill nickc\@credhat.com, doc\@redhat.com\par | |
71ba23f6 | 89 | \hfill {\it The GNU linker}\par |
252b5132 RH |
90 | \hfill Edited by Jeffrey Osier (jeffrey\@cygnus.com)\par |
91 | } | |
92 | \global\parindent=0pt % Steve likes it this way. | |
93 | @end tex | |
94 | ||
95 | @vskip 0pt plus 1filll | |
0285c67d | 96 | @c man begin COPYRIGHT |
b3adc24a | 97 | Copyright @copyright{} 1991-2020 Free Software Foundation, Inc. |
252b5132 | 98 | |
0285c67d | 99 | Permission is granted to copy, distribute and/or modify this document |
793c5807 | 100 | under the terms of the GNU Free Documentation License, Version 1.3 |
0285c67d NC |
101 | or any later version published by the Free Software Foundation; |
102 | with no Invariant Sections, with no Front-Cover Texts, and with no | |
103 | Back-Cover Texts. A copy of the license is included in the | |
36f63dca | 104 | section entitled ``GNU Free Documentation License''. |
0285c67d | 105 | @c man end |
252b5132 | 106 | |
252b5132 RH |
107 | @end titlepage |
108 | @end iftex | |
4ecceb71 | 109 | @contents |
252b5132 RH |
110 | @c FIXME: Talk about importance of *order* of args, cmds to linker! |
111 | ||
84ec0e6d | 112 | @ifnottex |
252b5132 | 113 | @node Top |
71ba23f6 | 114 | @top LD |
e49e529d JM |
115 | This file documents the @sc{gnu} linker ld |
116 | @ifset VERSION_PACKAGE | |
117 | @value{VERSION_PACKAGE} | |
118 | @end ifset | |
119 | version @value{VERSION}. | |
252b5132 | 120 | |
cf055d54 | 121 | This document is distributed under the terms of the GNU Free |
793c5807 NC |
122 | Documentation License version 1.3. A copy of the license is included |
123 | in the section entitled ``GNU Free Documentation License''. | |
cf055d54 | 124 | |
252b5132 RH |
125 | @menu |
126 | * Overview:: Overview | |
127 | * Invocation:: Invocation | |
128 | * Scripts:: Linker Scripts | |
129 | @ifset GENERIC | |
130 | * Machine Dependent:: Machine Dependent Features | |
131 | @end ifset | |
132 | @ifclear GENERIC | |
133 | @ifset H8300 | |
134 | * H8/300:: ld and the H8/300 | |
135 | @end ifset | |
c2dcd04e NC |
136 | @ifset Renesas |
137 | * Renesas:: ld and other Renesas micros | |
252b5132 | 138 | @end ifset |
36f63dca NC |
139 | @ifset ARM |
140 | * ARM:: ld and the ARM family | |
141 | @end ifset | |
93fd0973 SC |
142 | @ifset M68HC11 |
143 | * M68HC11/68HC12:: ld and the Motorola 68HC11 and 68HC12 families | |
144 | @end ifset | |
7ca01ed9 NC |
145 | @ifset HPPA |
146 | * HPPA ELF32:: ld and HPPA 32-bit ELF | |
147 | @end ifset | |
7fb9f789 NC |
148 | @ifset M68K |
149 | * M68K:: ld and Motorola 68K family | |
150 | @end ifset | |
833794fc MR |
151 | @ifset MIPS |
152 | * MIPS:: ld and MIPS family | |
153 | @end ifset | |
2a60a7a8 AM |
154 | @ifset POWERPC |
155 | * PowerPC ELF32:: ld and PowerPC 32-bit ELF Support | |
156 | @end ifset | |
157 | @ifset POWERPC64 | |
158 | * PowerPC64 ELF64:: ld and PowerPC64 64-bit ELF Support | |
159 | @end ifset | |
b4cbbe8f AK |
160 | @ifset S/390 |
161 | * S/390 ELF:: ld and S/390 ELF Support | |
162 | @end ifset | |
49fa1e15 AM |
163 | @ifset SPU |
164 | * SPU ELF:: ld and SPU ELF Support | |
165 | @end ifset | |
74459f0e TW |
166 | @ifset TICOFF |
167 | * TI COFF:: ld and the TI COFF | |
168 | @end ifset | |
2ca22b03 NC |
169 | @ifset WIN32 |
170 | * Win32:: ld and WIN32 (cygwin/mingw) | |
171 | @end ifset | |
e0001a05 NC |
172 | @ifset XTENSA |
173 | * Xtensa:: ld and Xtensa Processors | |
174 | @end ifset | |
252b5132 RH |
175 | @end ifclear |
176 | @ifclear SingleFormat | |
177 | * BFD:: BFD | |
178 | @end ifclear | |
179 | @c Following blank line required for remaining bug in makeinfo conds/menus | |
180 | ||
181 | * Reporting Bugs:: Reporting Bugs | |
182 | * MRI:: MRI Compatible Script Files | |
704c465c | 183 | * GNU Free Documentation License:: GNU Free Documentation License |
370b66a1 | 184 | * LD Index:: LD Index |
252b5132 | 185 | @end menu |
84ec0e6d | 186 | @end ifnottex |
252b5132 RH |
187 | |
188 | @node Overview | |
189 | @chapter Overview | |
190 | ||
191 | @cindex @sc{gnu} linker | |
192 | @cindex what is this? | |
0285c67d | 193 | |
0879a67a | 194 | @ifset man |
0285c67d | 195 | @c man begin SYNOPSIS |
ff5dcc92 | 196 | ld [@b{options}] @var{objfile} @dots{} |
0285c67d NC |
197 | @c man end |
198 | ||
199 | @c man begin SEEALSO | |
200 | ar(1), nm(1), objcopy(1), objdump(1), readelf(1) and | |
201 | the Info entries for @file{binutils} and | |
202 | @file{ld}. | |
203 | @c man end | |
204 | @end ifset | |
205 | ||
206 | @c man begin DESCRIPTION | |
207 | ||
ff5dcc92 | 208 | @command{ld} combines a number of object and archive files, relocates |
252b5132 | 209 | their data and ties up symbol references. Usually the last step in |
ff5dcc92 | 210 | compiling a program is to run @command{ld}. |
252b5132 | 211 | |
ff5dcc92 | 212 | @command{ld} accepts Linker Command Language files written in |
252b5132 RH |
213 | a superset of AT&T's Link Editor Command Language syntax, |
214 | to provide explicit and total control over the linking process. | |
215 | ||
0285c67d NC |
216 | @ifset man |
217 | @c For the man only | |
ece2d90e | 218 | This man page does not describe the command language; see the |
71ba23f6 NC |
219 | @command{ld} entry in @code{info} for full details on the command |
220 | language and on other aspects of the GNU linker. | |
0285c67d NC |
221 | @end ifset |
222 | ||
252b5132 | 223 | @ifclear SingleFormat |
ff5dcc92 SC |
224 | This version of @command{ld} uses the general purpose BFD libraries |
225 | to operate on object files. This allows @command{ld} to read, combine, and | |
252b5132 RH |
226 | write object files in many different formats---for example, COFF or |
227 | @code{a.out}. Different formats may be linked together to produce any | |
228 | available kind of object file. @xref{BFD}, for more information. | |
229 | @end ifclear | |
230 | ||
231 | Aside from its flexibility, the @sc{gnu} linker is more helpful than other | |
232 | linkers in providing diagnostic information. Many linkers abandon | |
233 | execution immediately upon encountering an error; whenever possible, | |
ff5dcc92 | 234 | @command{ld} continues executing, allowing you to identify other errors |
252b5132 RH |
235 | (or, in some cases, to get an output file in spite of the error). |
236 | ||
0285c67d NC |
237 | @c man end |
238 | ||
252b5132 RH |
239 | @node Invocation |
240 | @chapter Invocation | |
241 | ||
0285c67d NC |
242 | @c man begin DESCRIPTION |
243 | ||
ff5dcc92 | 244 | The @sc{gnu} linker @command{ld} is meant to cover a broad range of situations, |
252b5132 RH |
245 | and to be as compatible as possible with other linkers. As a result, |
246 | you have many choices to control its behavior. | |
247 | ||
0285c67d NC |
248 | @c man end |
249 | ||
252b5132 RH |
250 | @ifset UsesEnvVars |
251 | @menu | |
a05a5b64 | 252 | * Options:: Command-line Options |
252b5132 RH |
253 | * Environment:: Environment Variables |
254 | @end menu | |
255 | ||
256 | @node Options | |
a05a5b64 | 257 | @section Command-line Options |
252b5132 RH |
258 | @end ifset |
259 | ||
260 | @cindex command line | |
261 | @cindex options | |
0285c67d NC |
262 | |
263 | @c man begin OPTIONS | |
264 | ||
252b5132 RH |
265 | The linker supports a plethora of command-line options, but in actual |
266 | practice few of them are used in any particular context. | |
267 | @cindex standard Unix system | |
ff5dcc92 | 268 | For instance, a frequent use of @command{ld} is to link standard Unix |
252b5132 RH |
269 | object files on a standard, supported Unix system. On such a system, to |
270 | link a file @code{hello.o}: | |
271 | ||
272 | @smallexample | |
273 | ld -o @var{output} /lib/crt0.o hello.o -lc | |
274 | @end smallexample | |
275 | ||
ff5dcc92 | 276 | This tells @command{ld} to produce a file called @var{output} as the |
252b5132 RH |
277 | result of linking the file @code{/lib/crt0.o} with @code{hello.o} and |
278 | the library @code{libc.a}, which will come from the standard search | |
279 | directories. (See the discussion of the @samp{-l} option below.) | |
280 | ||
ff5dcc92 | 281 | Some of the command-line options to @command{ld} may be specified at any |
511ab9e9 ILT |
282 | point in the command line. However, options which refer to files, such |
283 | as @samp{-l} or @samp{-T}, cause the file to be read at the point at | |
284 | which the option appears in the command line, relative to the object | |
285 | files and other file options. Repeating non-file options with a | |
286 | different argument will either have no further effect, or override prior | |
252b5132 RH |
287 | occurrences (those further to the left on the command line) of that |
288 | option. Options which may be meaningfully specified more than once are | |
289 | noted in the descriptions below. | |
290 | ||
291 | @cindex object files | |
511ab9e9 ILT |
292 | Non-option arguments are object files or archives which are to be linked |
293 | together. They may follow, precede, or be mixed in with command-line | |
294 | options, except that an object file argument may not be placed between | |
295 | an option and its argument. | |
252b5132 RH |
296 | |
297 | Usually the linker is invoked with at least one object file, but you can | |
298 | specify other forms of binary input files using @samp{-l}, @samp{-R}, | |
299 | and the script command language. If @emph{no} binary input files at all | |
300 | are specified, the linker does not produce any output, and issues the | |
301 | message @samp{No input files}. | |
302 | ||
36f63dca | 303 | If the linker cannot recognize the format of an object file, it will |
252b5132 RH |
304 | assume that it is a linker script. A script specified in this way |
305 | augments the main linker script used for the link (either the default | |
306 | linker script or the one specified by using @samp{-T}). This feature | |
307 | permits the linker to link against a file which appears to be an object | |
308 | or an archive, but actually merely defines some symbol values, or uses | |
53d25da6 AM |
309 | @code{INPUT} or @code{GROUP} to load other objects. Specifying a |
310 | script in this way merely augments the main linker script, with the | |
311 | extra commands placed after the main script; use the @samp{-T} option | |
312 | to replace the default linker script entirely, but note the effect of | |
313 | the @code{INSERT} command. @xref{Scripts}. | |
252b5132 RH |
314 | |
315 | For options whose names are a single letter, | |
316 | option arguments must either follow the option letter without intervening | |
317 | whitespace, or be given as separate arguments immediately following the | |
318 | option that requires them. | |
319 | ||
320 | For options whose names are multiple letters, either one dash or two can | |
e4897a32 | 321 | precede the option name; for example, @samp{-trace-symbol} and |
36f63dca | 322 | @samp{--trace-symbol} are equivalent. Note---there is one exception to |
e4897a32 | 323 | this rule. Multiple letter options that start with a lower case 'o' can |
ba1be17e | 324 | only be preceded by two dashes. This is to reduce confusion with the |
e4897a32 NC |
325 | @samp{-o} option. So for example @samp{-omagic} sets the output file |
326 | name to @samp{magic} whereas @samp{--omagic} sets the NMAGIC flag on the | |
327 | output. | |
328 | ||
329 | Arguments to multiple-letter options must either be separated from the | |
330 | option name by an equals sign, or be given as separate arguments | |
331 | immediately following the option that requires them. For example, | |
332 | @samp{--trace-symbol foo} and @samp{--trace-symbol=foo} are equivalent. | |
333 | Unique abbreviations of the names of multiple-letter options are | |
334 | accepted. | |
252b5132 | 335 | |
36f63dca | 336 | Note---if the linker is being invoked indirectly, via a compiler driver |
a05a5b64 | 337 | (e.g. @samp{gcc}) then all the linker command-line options should be |
fa19fce0 NC |
338 | prefixed by @samp{-Wl,} (or whatever is appropriate for the particular |
339 | compiler driver) like this: | |
4e53152f NC |
340 | |
341 | @smallexample | |
2509a395 | 342 | gcc -Wl,--start-group foo.o bar.o -Wl,--end-group |
4e53152f NC |
343 | @end smallexample |
344 | ||
345 | This is important, because otherwise the compiler driver program may | |
2509a395 SL |
346 | silently drop the linker options, resulting in a bad link. Confusion |
347 | may also arise when passing options that require values through a | |
348 | driver, as the use of a space between option and argument acts as | |
349 | a separator, and causes the driver to pass only the option to the linker | |
350 | and the argument to the compiler. In this case, it is simplest to use | |
351 | the joined forms of both single- and multiple-letter options, such as: | |
352 | ||
353 | @smallexample | |
354 | gcc foo.o bar.o -Wl,-eENTRY -Wl,-Map=a.map | |
355 | @end smallexample | |
4e53152f | 356 | |
a05a5b64 | 357 | Here is a table of the generic command-line switches accepted by the GNU |
4e53152f NC |
358 | linker: |
359 | ||
ff5dcc92 | 360 | @table @gcctabopt |
38fc1cb1 | 361 | @include at-file.texi |
dff70155 | 362 | |
2509a395 SL |
363 | @kindex -a @var{keyword} |
364 | @item -a @var{keyword} | |
252b5132 RH |
365 | This option is supported for HP/UX compatibility. The @var{keyword} |
366 | argument must be one of the strings @samp{archive}, @samp{shared}, or | |
367 | @samp{default}. @samp{-aarchive} is functionally equivalent to | |
368 | @samp{-Bstatic}, and the other two keywords are functionally equivalent | |
369 | to @samp{-Bdynamic}. This option may be used any number of times. | |
370 | ||
7ee314fa AM |
371 | @kindex --audit @var{AUDITLIB} |
372 | @item --audit @var{AUDITLIB} | |
373 | Adds @var{AUDITLIB} to the @code{DT_AUDIT} entry of the dynamic section. | |
374 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
375 | specified in the library. If specified multiple times @code{DT_AUDIT} | |
376 | will contain a colon separated list of audit interfaces to use. If the linker | |
377 | finds an object with an audit entry while searching for shared libraries, | |
9d5777a3 | 378 | it will add a corresponding @code{DT_DEPAUDIT} entry in the output file. |
7ee314fa | 379 | This option is only meaningful on ELF platforms supporting the rtld-audit |
9d5777a3 | 380 | interface. |
7ee314fa | 381 | |
252b5132 RH |
382 | @ifclear SingleFormat |
383 | @cindex binary input format | |
384 | @kindex -b @var{format} | |
385 | @kindex --format=@var{format} | |
386 | @cindex input format | |
387 | @cindex input format | |
388 | @item -b @var{input-format} | |
389 | @itemx --format=@var{input-format} | |
ff5dcc92 SC |
390 | @command{ld} may be configured to support more than one kind of object |
391 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 392 | @samp{-b} option to specify the binary format for input object files |
ff5dcc92 | 393 | that follow this option on the command line. Even when @command{ld} is |
252b5132 | 394 | configured to support alternative object formats, you don't usually need |
ff5dcc92 | 395 | to specify this, as @command{ld} should be configured to expect as a |
252b5132 RH |
396 | default input format the most usual format on each machine. |
397 | @var{input-format} is a text string, the name of a particular format | |
398 | supported by the BFD libraries. (You can list the available binary | |
399 | formats with @samp{objdump -i}.) | |
400 | @xref{BFD}. | |
401 | ||
402 | You may want to use this option if you are linking files with an unusual | |
403 | binary format. You can also use @samp{-b} to switch formats explicitly (when | |
404 | linking object files of different formats), by including | |
405 | @samp{-b @var{input-format}} before each group of object files in a | |
a1ab1d2a | 406 | particular format. |
252b5132 RH |
407 | |
408 | The default format is taken from the environment variable | |
409 | @code{GNUTARGET}. | |
410 | @ifset UsesEnvVars | |
411 | @xref{Environment}. | |
412 | @end ifset | |
413 | You can also define the input format from a script, using the command | |
0285c67d NC |
414 | @code{TARGET}; |
415 | @ifclear man | |
416 | see @ref{Format Commands}. | |
417 | @end ifclear | |
252b5132 RH |
418 | @end ifclear |
419 | ||
420 | @kindex -c @var{MRI-cmdfile} | |
421 | @kindex --mri-script=@var{MRI-cmdfile} | |
422 | @cindex compatibility, MRI | |
423 | @item -c @var{MRI-commandfile} | |
424 | @itemx --mri-script=@var{MRI-commandfile} | |
ff5dcc92 | 425 | For compatibility with linkers produced by MRI, @command{ld} accepts script |
252b5132 | 426 | files written in an alternate, restricted command language, described in |
0285c67d NC |
427 | @ifclear man |
428 | @ref{MRI,,MRI Compatible Script Files}. | |
429 | @end ifclear | |
430 | @ifset man | |
431 | the MRI Compatible Script Files section of GNU ld documentation. | |
432 | @end ifset | |
433 | Introduce MRI script files with | |
252b5132 | 434 | the option @samp{-c}; use the @samp{-T} option to run linker |
ff5dcc92 SC |
435 | scripts written in the general-purpose @command{ld} scripting language. |
436 | If @var{MRI-cmdfile} does not exist, @command{ld} looks for it in the directories | |
252b5132 RH |
437 | specified by any @samp{-L} options. |
438 | ||
439 | @cindex common allocation | |
440 | @kindex -d | |
441 | @kindex -dc | |
442 | @kindex -dp | |
a1ab1d2a | 443 | @item -d |
252b5132 RH |
444 | @itemx -dc |
445 | @itemx -dp | |
446 | These three options are equivalent; multiple forms are supported for | |
447 | compatibility with other linkers. They assign space to common symbols | |
448 | even if a relocatable output file is specified (with @samp{-r}). The | |
449 | script command @code{FORCE_COMMON_ALLOCATION} has the same effect. | |
450 | @xref{Miscellaneous Commands}. | |
451 | ||
7ee314fa AM |
452 | @kindex --depaudit @var{AUDITLIB} |
453 | @kindex -P @var{AUDITLIB} | |
454 | @item --depaudit @var{AUDITLIB} | |
455 | @itemx -P @var{AUDITLIB} | |
456 | Adds @var{AUDITLIB} to the @code{DT_DEPAUDIT} entry of the dynamic section. | |
457 | @var{AUDITLIB} is not checked for existence, nor will it use the DT_SONAME | |
458 | specified in the library. If specified multiple times @code{DT_DEPAUDIT} | |
459 | will contain a colon separated list of audit interfaces to use. This | |
460 | option is only meaningful on ELF platforms supporting the rtld-audit interface. | |
9d5777a3 | 461 | The -P option is provided for Solaris compatibility. |
7ee314fa | 462 | |
abf874aa CL |
463 | @kindex --enable-non-contiguous-regions |
464 | @item --enable-non-contiguous-regions | |
465 | This option avoids generating an error if an input section does not | |
466 | fit a matching output section. The linker tries to allocate the input | |
467 | section to subseque nt matching output sections, and generates an | |
468 | error only if no output section is large enough. This is useful when | |
469 | several non-contiguous memory regions are available and the input | |
470 | section does not require a particular one. The order in which input | |
471 | sections are evaluated does not change, for instance: | |
472 | ||
473 | @smallexample | |
474 | MEMORY @{ | |
475 | MEM1 (rwx) : ORIGIN : 0x1000, LENGTH = 0x14 | |
476 | MEM2 (rwx) : ORIGIN : 0x1000, LENGTH = 0x40 | |
477 | MEM3 (rwx) : ORIGIN : 0x2000, LENGTH = 0x40 | |
478 | @} | |
479 | SECTIONS @{ | |
480 | mem1 : @{ *(.data.*); @} > MEM1 | |
481 | mem2 : @{ *(.data.*); @} > MEM2 | |
482 | mem3 : @{ *(.data.*); @} > MEM2 | |
483 | @} | |
484 | ||
485 | with input sections: | |
486 | .data.1: size 8 | |
487 | .data.2: size 0x10 | |
488 | .data.3: size 4 | |
489 | ||
490 | results in .data.1 affected to mem1, and .data.2 and .data.3 | |
491 | affected to mem2, even though .data.3 would fit in mem3. | |
492 | @end smallexample | |
493 | ||
494 | This option is incompatible with INSERT statements because it changes | |
495 | the way input sections are mapped to output sections. | |
496 | ||
497 | @kindex --enable-non-contiguous-regions-warnings | |
498 | @item --enable-non-contiguous-regions-warnings | |
499 | This option enables warnings when | |
500 | @code{--enable-non-contiguous-regions} allows possibly unexpected | |
501 | matches in sections mapping, potentially leading to silently | |
502 | discarding a section instead of failing because it does not fit any | |
503 | output region. | |
504 | ||
252b5132 RH |
505 | @cindex entry point, from command line |
506 | @kindex -e @var{entry} | |
507 | @kindex --entry=@var{entry} | |
a1ab1d2a | 508 | @item -e @var{entry} |
252b5132 RH |
509 | @itemx --entry=@var{entry} |
510 | Use @var{entry} as the explicit symbol for beginning execution of your | |
511 | program, rather than the default entry point. If there is no symbol | |
512 | named @var{entry}, the linker will try to parse @var{entry} as a number, | |
513 | and use that as the entry address (the number will be interpreted in | |
514 | base 10; you may use a leading @samp{0x} for base 16, or a leading | |
515 | @samp{0} for base 8). @xref{Entry Point}, for a discussion of defaults | |
516 | and other ways of specifying the entry point. | |
517 | ||
b58f81ae DJ |
518 | @kindex --exclude-libs |
519 | @item --exclude-libs @var{lib},@var{lib},... | |
520 | Specifies a list of archive libraries from which symbols should not be automatically | |
e1c37eb5 | 521 | exported. The library names may be delimited by commas or colons. Specifying |
b58f81ae DJ |
522 | @code{--exclude-libs ALL} excludes symbols in all archive libraries from |
523 | automatic export. This option is available only for the i386 PE targeted | |
524 | port of the linker and for ELF targeted ports. For i386 PE, symbols | |
525 | explicitly listed in a .def file are still exported, regardless of this | |
526 | option. For ELF targeted ports, symbols affected by this option will | |
527 | be treated as hidden. | |
528 | ||
e1c37eb5 DK |
529 | @kindex --exclude-modules-for-implib |
530 | @item --exclude-modules-for-implib @var{module},@var{module},... | |
531 | Specifies a list of object files or archive members, from which symbols | |
532 | should not be automatically exported, but which should be copied wholesale | |
533 | into the import library being generated during the link. The module names | |
534 | may be delimited by commas or colons, and must match exactly the filenames | |
535 | used by @command{ld} to open the files; for archive members, this is simply | |
536 | the member name, but for object files the name listed must include and | |
537 | match precisely any path used to specify the input file on the linker's | |
538 | command-line. This option is available only for the i386 PE targeted port | |
539 | of the linker. Symbols explicitly listed in a .def file are still exported, | |
540 | regardless of this option. | |
541 | ||
252b5132 RH |
542 | @cindex dynamic symbol table |
543 | @kindex -E | |
544 | @kindex --export-dynamic | |
267e2722 | 545 | @kindex --no-export-dynamic |
252b5132 RH |
546 | @item -E |
547 | @itemx --export-dynamic | |
267e2722 CD |
548 | @itemx --no-export-dynamic |
549 | When creating a dynamically linked executable, using the @option{-E} | |
550 | option or the @option{--export-dynamic} option causes the linker to add | |
551 | all symbols to the dynamic symbol table. The dynamic symbol table is the | |
552 | set of symbols which are visible from dynamic objects at run time. | |
553 | ||
554 | If you do not use either of these options (or use the | |
555 | @option{--no-export-dynamic} option to restore the default behavior), the | |
556 | dynamic symbol table will normally contain only those symbols which are | |
557 | referenced by some dynamic object mentioned in the link. | |
252b5132 RH |
558 | |
559 | If you use @code{dlopen} to load a dynamic object which needs to refer | |
560 | back to the symbols defined by the program, rather than some other | |
561 | dynamic object, then you will probably need to use this option when | |
562 | linking the program itself. | |
563 | ||
55255dae | 564 | You can also use the dynamic list to control what symbols should |
cb840a31 | 565 | be added to the dynamic symbol table if the output format supports it. |
55255dae | 566 | See the description of @samp{--dynamic-list}. |
cb840a31 | 567 | |
8b747e1a DK |
568 | Note that this option is specific to ELF targeted ports. PE targets |
569 | support a similar function to export all symbols from a DLL or EXE; see | |
570 | the description of @samp{--export-all-symbols} below. | |
571 | ||
37a141bf FS |
572 | @kindex --export-dynamic-symbol=@var{glob} |
573 | @cindex export dynamic symbol | |
574 | @item --export-dynamic-symbol=@var{glob} | |
575 | When creating a dynamically linked executable, symbols matching | |
576 | @var{glob} will be added to the dynamic symbol table. When creating a | |
577 | shared library, references to symbols matching @var{glob} will not be | |
578 | bound to the definitions within the shared library. This option is a | |
579 | no-op when creating a shared library and @samp{-Bsymbolic} or | |
580 | @samp{--dynamic-list} are not specified. This option is only meaningful | |
581 | on ELF platforms which support shared libraries. | |
582 | ||
583 | @kindex --export-dynamic-symbol-list=@var{file} | |
584 | @cindex export dynamic symbol list | |
585 | @item --export-dynamic-symbol-list=@var{file} | |
586 | Specify a @samp{--export-dynamic-symbol} for each pattern in the file. | |
587 | The format of the file is the same as the version node without | |
588 | scope and node name. See @ref{VERSION} for more information. | |
589 | ||
36f63dca | 590 | @ifclear SingleFormat |
252b5132 RH |
591 | @cindex big-endian objects |
592 | @cindex endianness | |
593 | @kindex -EB | |
594 | @item -EB | |
595 | Link big-endian objects. This affects the default output format. | |
596 | ||
597 | @cindex little-endian objects | |
598 | @kindex -EL | |
599 | @item -EL | |
600 | Link little-endian objects. This affects the default output format. | |
36f63dca | 601 | @end ifclear |
252b5132 | 602 | |
2509a395 SL |
603 | @kindex -f @var{name} |
604 | @kindex --auxiliary=@var{name} | |
605 | @item -f @var{name} | |
606 | @itemx --auxiliary=@var{name} | |
252b5132 RH |
607 | When creating an ELF shared object, set the internal DT_AUXILIARY field |
608 | to the specified name. This tells the dynamic linker that the symbol | |
609 | table of the shared object should be used as an auxiliary filter on the | |
610 | symbol table of the shared object @var{name}. | |
611 | ||
612 | If you later link a program against this filter object, then, when you | |
613 | run the program, the dynamic linker will see the DT_AUXILIARY field. If | |
614 | the dynamic linker resolves any symbols from the filter object, it will | |
615 | first check whether there is a definition in the shared object | |
616 | @var{name}. If there is one, it will be used instead of the definition | |
617 | in the filter object. The shared object @var{name} need not exist. | |
618 | Thus the shared object @var{name} may be used to provide an alternative | |
619 | implementation of certain functions, perhaps for debugging or for | |
a094d01f | 620 | machine-specific performance. |
252b5132 RH |
621 | |
622 | This option may be specified more than once. The DT_AUXILIARY entries | |
623 | will be created in the order in which they appear on the command line. | |
624 | ||
2509a395 SL |
625 | @kindex -F @var{name} |
626 | @kindex --filter=@var{name} | |
252b5132 | 627 | @item -F @var{name} |
2509a395 | 628 | @itemx --filter=@var{name} |
252b5132 RH |
629 | When creating an ELF shared object, set the internal DT_FILTER field to |
630 | the specified name. This tells the dynamic linker that the symbol table | |
631 | of the shared object which is being created should be used as a filter | |
632 | on the symbol table of the shared object @var{name}. | |
633 | ||
634 | If you later link a program against this filter object, then, when you | |
635 | run the program, the dynamic linker will see the DT_FILTER field. The | |
636 | dynamic linker will resolve symbols according to the symbol table of the | |
637 | filter object as usual, but it will actually link to the definitions | |
638 | found in the shared object @var{name}. Thus the filter object can be | |
639 | used to select a subset of the symbols provided by the object | |
640 | @var{name}. | |
641 | ||
ff5dcc92 | 642 | Some older linkers used the @option{-F} option throughout a compilation |
252b5132 | 643 | toolchain for specifying object-file format for both input and output |
36f63dca NC |
644 | object files. |
645 | @ifclear SingleFormat | |
646 | The @sc{gnu} linker uses other mechanisms for this purpose: the | |
ece2d90e | 647 | @option{-b}, @option{--format}, @option{--oformat} options, the |
252b5132 | 648 | @code{TARGET} command in linker scripts, and the @code{GNUTARGET} |
36f63dca NC |
649 | environment variable. |
650 | @end ifclear | |
651 | The @sc{gnu} linker will ignore the @option{-F} option when not | |
652 | creating an ELF shared object. | |
252b5132 | 653 | |
3dbf70a2 | 654 | @cindex finalization function |
2509a395 SL |
655 | @kindex -fini=@var{name} |
656 | @item -fini=@var{name} | |
3dbf70a2 MM |
657 | When creating an ELF executable or shared object, call NAME when the |
658 | executable or shared object is unloaded, by setting DT_FINI to the | |
659 | address of the function. By default, the linker uses @code{_fini} as | |
660 | the function to call. | |
661 | ||
252b5132 RH |
662 | @kindex -g |
663 | @item -g | |
664 | Ignored. Provided for compatibility with other tools. | |
665 | ||
2509a395 SL |
666 | @kindex -G @var{value} |
667 | @kindex --gpsize=@var{value} | |
252b5132 | 668 | @cindex object size |
2509a395 | 669 | @item -G @var{value} |
252b5132 RH |
670 | @itemx --gpsize=@var{value} |
671 | Set the maximum size of objects to be optimized using the GP register to | |
672 | @var{size}. This is only meaningful for object file formats such as | |
e8044f35 | 673 | MIPS ELF that support putting large and small objects into different |
252b5132 RH |
674 | sections. This is ignored for other object file formats. |
675 | ||
676 | @cindex runtime library name | |
2509a395 | 677 | @kindex -h @var{name} |
252b5132 | 678 | @kindex -soname=@var{name} |
2509a395 | 679 | @item -h @var{name} |
252b5132 RH |
680 | @itemx -soname=@var{name} |
681 | When creating an ELF shared object, set the internal DT_SONAME field to | |
682 | the specified name. When an executable is linked with a shared object | |
683 | which has a DT_SONAME field, then when the executable is run the dynamic | |
684 | linker will attempt to load the shared object specified by the DT_SONAME | |
685 | field rather than the using the file name given to the linker. | |
686 | ||
687 | @kindex -i | |
688 | @cindex incremental link | |
689 | @item -i | |
690 | Perform an incremental link (same as option @samp{-r}). | |
691 | ||
3dbf70a2 | 692 | @cindex initialization function |
2509a395 SL |
693 | @kindex -init=@var{name} |
694 | @item -init=@var{name} | |
3dbf70a2 MM |
695 | When creating an ELF executable or shared object, call NAME when the |
696 | executable or shared object is loaded, by setting DT_INIT to the address | |
697 | of the function. By default, the linker uses @code{_init} as the | |
698 | function to call. | |
699 | ||
252b5132 | 700 | @cindex archive files, from cmd line |
2509a395 | 701 | @kindex -l @var{namespec} |
bcb674cf | 702 | @kindex --library=@var{namespec} |
2509a395 | 703 | @item -l @var{namespec} |
bcb674cf RS |
704 | @itemx --library=@var{namespec} |
705 | Add the archive or object file specified by @var{namespec} to the | |
706 | list of files to link. This option may be used any number of times. | |
707 | If @var{namespec} is of the form @file{:@var{filename}}, @command{ld} | |
07d8eb55 | 708 | will search the library path for a file called @var{filename}, otherwise it |
bcb674cf | 709 | will search the library path for a file called @file{lib@var{namespec}.a}. |
252b5132 | 710 | |
ff5dcc92 | 711 | On systems which support shared libraries, @command{ld} may also search for |
bcb674cf RS |
712 | files other than @file{lib@var{namespec}.a}. Specifically, on ELF |
713 | and SunOS systems, @command{ld} will search a directory for a library | |
714 | called @file{lib@var{namespec}.so} before searching for one called | |
715 | @file{lib@var{namespec}.a}. (By convention, a @code{.so} extension | |
716 | indicates a shared library.) Note that this behavior does not apply | |
717 | to @file{:@var{filename}}, which always specifies a file called | |
718 | @var{filename}. | |
252b5132 RH |
719 | |
720 | The linker will search an archive only once, at the location where it is | |
721 | specified on the command line. If the archive defines a symbol which | |
722 | was undefined in some object which appeared before the archive on the | |
723 | command line, the linker will include the appropriate file(s) from the | |
724 | archive. However, an undefined symbol in an object appearing later on | |
725 | the command line will not cause the linker to search the archive again. | |
726 | ||
ff5dcc92 | 727 | See the @option{-(} option for a way to force the linker to search |
252b5132 RH |
728 | archives multiple times. |
729 | ||
730 | You may list the same archive multiple times on the command line. | |
731 | ||
732 | @ifset GENERIC | |
733 | This type of archive searching is standard for Unix linkers. However, | |
ff5dcc92 | 734 | if you are using @command{ld} on AIX, note that it is different from the |
252b5132 RH |
735 | behaviour of the AIX linker. |
736 | @end ifset | |
737 | ||
738 | @cindex search directory, from cmd line | |
2509a395 | 739 | @kindex -L @var{dir} |
252b5132 | 740 | @kindex --library-path=@var{dir} |
2509a395 | 741 | @item -L @var{searchdir} |
252b5132 | 742 | @itemx --library-path=@var{searchdir} |
ff5dcc92 SC |
743 | Add path @var{searchdir} to the list of paths that @command{ld} will search |
744 | for archive libraries and @command{ld} control scripts. You may use this | |
252b5132 RH |
745 | option any number of times. The directories are searched in the order |
746 | in which they are specified on the command line. Directories specified | |
747 | on the command line are searched before the default directories. All | |
ff5dcc92 | 748 | @option{-L} options apply to all @option{-l} options, regardless of the |
7d24f02c KH |
749 | order in which the options appear. @option{-L} options do not affect |
750 | how @command{ld} searches for a linker script unless @option{-T} | |
751 | option is specified. | |
252b5132 | 752 | |
3aa2d05a NC |
753 | If @var{searchdir} begins with @code{=} or @code{$SYSROOT}, then this |
754 | prefix will be replaced by the @dfn{sysroot prefix}, controlled by the | |
755 | @samp{--sysroot} option, or specified when the linker is configured. | |
9c8ebd6a | 756 | |
252b5132 RH |
757 | @ifset UsesEnvVars |
758 | The default set of paths searched (without being specified with | |
ff5dcc92 | 759 | @samp{-L}) depends on which emulation mode @command{ld} is using, and in |
252b5132 RH |
760 | some cases also on how it was configured. @xref{Environment}. |
761 | @end ifset | |
762 | ||
763 | The paths can also be specified in a link script with the | |
764 | @code{SEARCH_DIR} command. Directories specified this way are searched | |
765 | at the point in which the linker script appears in the command line. | |
766 | ||
767 | @cindex emulation | |
768 | @kindex -m @var{emulation} | |
2509a395 | 769 | @item -m @var{emulation} |
252b5132 RH |
770 | Emulate the @var{emulation} linker. You can list the available |
771 | emulations with the @samp{--verbose} or @samp{-V} options. | |
772 | ||
773 | If the @samp{-m} option is not used, the emulation is taken from the | |
774 | @code{LDEMULATION} environment variable, if that is defined. | |
775 | ||
776 | Otherwise, the default emulation depends upon how the linker was | |
777 | configured. | |
778 | ||
779 | @cindex link map | |
780 | @kindex -M | |
781 | @kindex --print-map | |
782 | @item -M | |
783 | @itemx --print-map | |
784 | Print a link map to the standard output. A link map provides | |
785 | information about the link, including the following: | |
786 | ||
787 | @itemize @bullet | |
788 | @item | |
3b83e13a | 789 | Where object files are mapped into memory. |
252b5132 RH |
790 | @item |
791 | How common symbols are allocated. | |
792 | @item | |
793 | All archive members included in the link, with a mention of the symbol | |
794 | which caused the archive member to be brought in. | |
3b83e13a NC |
795 | @item |
796 | The values assigned to symbols. | |
797 | ||
798 | Note - symbols whose values are computed by an expression which | |
799 | involves a reference to a previous value of the same symbol may not | |
800 | have correct result displayed in the link map. This is because the | |
801 | linker discards intermediate results and only retains the final value | |
802 | of an expression. Under such circumstances the linker will display | |
803 | the final value enclosed by square brackets. Thus for example a | |
804 | linker script containing: | |
805 | ||
806 | @smallexample | |
807 | foo = 1 | |
808 | foo = foo * 4 | |
809 | foo = foo + 8 | |
810 | @end smallexample | |
811 | ||
812 | will produce the following output in the link map if the @option{-M} | |
813 | option is used: | |
814 | ||
815 | @smallexample | |
816 | 0x00000001 foo = 0x1 | |
817 | [0x0000000c] foo = (foo * 0x4) | |
818 | [0x0000000c] foo = (foo + 0x8) | |
819 | @end smallexample | |
820 | ||
821 | See @ref{Expressions} for more information about expressions in linker | |
822 | scripts. | |
d2ef37eb | 823 | |
06ddcada AM |
824 | @item |
825 | How GNU properties are merged. | |
d2ef37eb | 826 | |
06ddcada AM |
827 | When the linker merges input .note.gnu.property sections into one output |
828 | .note.gnu.property section, some properties are removed or updated. | |
829 | These actions are reported in the link map. For example: | |
d2ef37eb L |
830 | |
831 | @smallexample | |
832 | Removed property 0xc0000002 to merge foo.o (0x1) and bar.o (not found) | |
833 | @end smallexample | |
834 | ||
06ddcada | 835 | This indicates that property 0xc0000002 is removed from output when |
d2ef37eb L |
836 | merging properties in @file{foo.o}, whose property 0xc0000002 value |
837 | is 0x1, and @file{bar.o}, which doesn't have property 0xc0000002. | |
838 | ||
839 | @smallexample | |
06ddcada | 840 | Updated property 0xc0010001 (0x1) to merge foo.o (0x1) and bar.o (0x1) |
d2ef37eb L |
841 | @end smallexample |
842 | ||
06ddcada | 843 | This indicates that property 0xc0010001 value is updated to 0x1 in output |
d2ef37eb L |
844 | when merging properties in @file{foo.o}, whose 0xc0010001 property value |
845 | is 0x1, and @file{bar.o}, whose 0xc0010001 property value is 0x1. | |
252b5132 RH |
846 | @end itemize |
847 | ||
035801ce FS |
848 | @cindex link map discarded |
849 | @kindex --print-map-discarded | |
850 | @kindex --no-print-map-discarded | |
851 | @item --print-map-discarded | |
852 | @itemx --no-print-map-discarded | |
853 | Print (or do not print) the list of discarded and garbage collected sections | |
854 | in the link map. Enabled by default. | |
855 | ||
252b5132 RH |
856 | @kindex -n |
857 | @cindex read-only text | |
858 | @cindex NMAGIC | |
859 | @kindex --nmagic | |
860 | @item -n | |
861 | @itemx --nmagic | |
90f5d9d9 JZ |
862 | Turn off page alignment of sections, and disable linking against shared |
863 | libraries. If the output format supports Unix style magic numbers, | |
864 | mark the output as @code{NMAGIC}. | |
252b5132 RH |
865 | |
866 | @kindex -N | |
867 | @kindex --omagic | |
868 | @cindex read/write from cmd line | |
869 | @cindex OMAGIC | |
a1ab1d2a | 870 | @item -N |
252b5132 RH |
871 | @itemx --omagic |
872 | Set the text and data sections to be readable and writable. Also, do | |
63fd3b82 NC |
873 | not page-align the data segment, and disable linking against shared |
874 | libraries. If the output format supports Unix style magic numbers, | |
4d8907ac DS |
875 | mark the output as @code{OMAGIC}. Note: Although a writable text section |
876 | is allowed for PE-COFF targets, it does not conform to the format | |
877 | specification published by Microsoft. | |
63fd3b82 NC |
878 | |
879 | @kindex --no-omagic | |
880 | @cindex OMAGIC | |
881 | @item --no-omagic | |
882 | This option negates most of the effects of the @option{-N} option. It | |
883 | sets the text section to be read-only, and forces the data segment to | |
884 | be page-aligned. Note - this option does not enable linking against | |
885 | shared libraries. Use @option{-Bdynamic} for this. | |
252b5132 RH |
886 | |
887 | @kindex -o @var{output} | |
888 | @kindex --output=@var{output} | |
889 | @cindex naming the output file | |
890 | @item -o @var{output} | |
891 | @itemx --output=@var{output} | |
ff5dcc92 | 892 | Use @var{output} as the name for the program produced by @command{ld}; if this |
252b5132 RH |
893 | option is not specified, the name @file{a.out} is used by default. The |
894 | script command @code{OUTPUT} can also specify the output file name. | |
895 | ||
f37b21b4 RM |
896 | @kindex --dependency-file=@var{depfile} |
897 | @cindex dependency file | |
898 | @item --dependency-file=@var{depfile} | |
899 | Write a @dfn{dependency file} to @var{depfile}. This file contains a rule | |
900 | suitable for @code{make} describing the output file and all the input files | |
901 | that were read to produce it. The output is similar to the compiler's | |
902 | output with @samp{-M -MP} (@pxref{Preprocessor Options,, Options | |
903 | Controlling the Preprocessor, gcc.info, Using the GNU Compiler | |
904 | Collection}). Note that there is no option like the compiler's @samp{-MM}, | |
905 | to exclude ``system files'' (which is not a well-specified concept in the | |
906 | linker, unlike ``system headers'' in the compiler). So the output from | |
907 | @samp{--dependency-file} is always specific to the exact state of the | |
908 | installation where it was produced, and should not be copied into | |
909 | distributed makefiles without careful editing. | |
910 | ||
252b5132 RH |
911 | @kindex -O @var{level} |
912 | @cindex generating optimized output | |
913 | @item -O @var{level} | |
ff5dcc92 | 914 | If @var{level} is a numeric values greater than zero @command{ld} optimizes |
252b5132 | 915 | the output. This might take significantly longer and therefore probably |
98c503ac NC |
916 | should only be enabled for the final binary. At the moment this |
917 | option only affects ELF shared library generation. Future releases of | |
918 | the linker may make more use of this option. Also currently there is | |
919 | no difference in the linker's behaviour for different non-zero values | |
920 | of this option. Again this may change with future releases. | |
252b5132 | 921 | |
387dd777 DP |
922 | @kindex -plugin @var{name} |
923 | @item -plugin @var{name} | |
924 | Involve a plugin in the linking process. The @var{name} parameter is | |
925 | the absolute filename of the plugin. Usually this parameter is | |
926 | automatically added by the complier, when using link time | |
927 | optimization, but users can also add their own plugins if they so | |
928 | wish. | |
929 | ||
930 | Note that the location of the compiler originated plugins is different | |
931 | from the place where the @command{ar}, @command{nm} and | |
932 | @command{ranlib} programs search for their plugins. In order for | |
933 | those commands to make use of a compiler based plugin it must first be | |
41f37a6f | 934 | copied into the @file{$@{libdir@}/bfd-plugins} directory. All gcc |
387dd777 | 935 | based linker plugins are backward compatible, so it is sufficient to |
6c19b93b | 936 | just copy in the newest one. |
387dd777 | 937 | |
26278bb8 UD |
938 | @kindex --push-state |
939 | @cindex push state governing input file handling | |
940 | @item --push-state | |
941 | The @option{--push-state} allows to preserve the current state of the | |
942 | flags which govern the input file handling so that they can all be | |
943 | restored with one corresponding @option{--pop-state} option. | |
944 | ||
945 | The option which are covered are: @option{-Bdynamic}, @option{-Bstatic}, | |
946 | @option{-dn}, @option{-dy}, @option{-call_shared}, @option{-non_shared}, | |
947 | @option{-static}, @option{-N}, @option{-n}, @option{--whole-archive}, | |
948 | @option{--no-whole-archive}, @option{-r}, @option{-Ur}, | |
949 | @option{--copy-dt-needed-entries}, @option{--no-copy-dt-needed-entries}, | |
950 | @option{--as-needed}, @option{--no-as-needed}, and @option{-a}. | |
951 | ||
952 | One target for this option are specifications for @file{pkg-config}. When | |
953 | used with the @option{--libs} option all possibly needed libraries are | |
954 | listed and then possibly linked with all the time. It is better to return | |
955 | something as follows: | |
956 | ||
957 | @smallexample | |
958 | -Wl,--push-state,--as-needed -libone -libtwo -Wl,--pop-state | |
959 | @end smallexample | |
960 | ||
961 | @kindex --pop-state | |
962 | @cindex pop state governing input file handling | |
67cecaba | 963 | @item --pop-state |
26278bb8 UD |
964 | Undoes the effect of --push-state, restores the previous values of the |
965 | flags governing input file handling. | |
966 | ||
a712da20 NC |
967 | @kindex -q |
968 | @kindex --emit-relocs | |
969 | @cindex retain relocations in final executable | |
970 | @item -q | |
971 | @itemx --emit-relocs | |
ba1be17e | 972 | Leave relocation sections and contents in fully linked executables. |
a712da20 NC |
973 | Post link analysis and optimization tools may need this information in |
974 | order to perform correct modifications of executables. This results | |
975 | in larger executables. | |
976 | ||
dbab7a7b NC |
977 | This option is currently only supported on ELF platforms. |
978 | ||
4f471f39 RS |
979 | @kindex --force-dynamic |
980 | @cindex forcing the creation of dynamic sections | |
981 | @item --force-dynamic | |
982 | Force the output file to have dynamic sections. This option is specific | |
983 | to VxWorks targets. | |
984 | ||
252b5132 RH |
985 | @cindex partial link |
986 | @cindex relocatable output | |
987 | @kindex -r | |
1049f94e | 988 | @kindex --relocatable |
252b5132 | 989 | @item -r |
1049f94e | 990 | @itemx --relocatable |
252b5132 | 991 | Generate relocatable output---i.e., generate an output file that can in |
ff5dcc92 | 992 | turn serve as input to @command{ld}. This is often called @dfn{partial |
252b5132 RH |
993 | linking}. As a side effect, in environments that support standard Unix |
994 | magic numbers, this option also sets the output file's magic number to | |
995 | @code{OMAGIC}. | |
ff5dcc92 | 996 | @c ; see @option{-N}. |
252b5132 RH |
997 | If this option is not specified, an absolute file is produced. When |
998 | linking C++ programs, this option @emph{will not} resolve references to | |
999 | constructors; to do that, use @samp{-Ur}. | |
1000 | ||
62bf86b4 HPN |
1001 | When an input file does not have the same format as the output file, |
1002 | partial linking is only supported if that input file does not contain any | |
1003 | relocations. Different output formats can have further restrictions; for | |
1004 | example some @code{a.out}-based formats do not support partial linking | |
1005 | with input files in other formats at all. | |
1006 | ||
252b5132 RH |
1007 | This option does the same thing as @samp{-i}. |
1008 | ||
1009 | @kindex -R @var{file} | |
1010 | @kindex --just-symbols=@var{file} | |
1011 | @cindex symbol-only input | |
1012 | @item -R @var{filename} | |
1013 | @itemx --just-symbols=@var{filename} | |
1014 | Read symbol names and their addresses from @var{filename}, but do not | |
1015 | relocate it or include it in the output. This allows your output file | |
1016 | to refer symbolically to absolute locations of memory defined in other | |
1017 | programs. You may use this option more than once. | |
1018 | ||
ff5dcc92 | 1019 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 1020 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 1021 | the @option{-rpath} option. |
252b5132 RH |
1022 | |
1023 | @kindex -s | |
1024 | @kindex --strip-all | |
1025 | @cindex strip all symbols | |
a1ab1d2a | 1026 | @item -s |
252b5132 RH |
1027 | @itemx --strip-all |
1028 | Omit all symbol information from the output file. | |
1029 | ||
1030 | @kindex -S | |
1031 | @kindex --strip-debug | |
1032 | @cindex strip debugger symbols | |
a1ab1d2a | 1033 | @item -S |
252b5132 RH |
1034 | @itemx --strip-debug |
1035 | Omit debugger symbol information (but not all symbols) from the output file. | |
1036 | ||
a70f34c0 NC |
1037 | @kindex --strip-discarded |
1038 | @kindex --no-strip-discarded | |
1039 | @item --strip-discarded | |
1040 | @itemx --no-strip-discarded | |
1041 | Omit (or do not omit) global symbols defined in discarded sections. | |
1042 | Enabled by default. | |
1043 | ||
252b5132 RH |
1044 | @kindex -t |
1045 | @kindex --trace | |
1046 | @cindex input files, displaying | |
a1ab1d2a | 1047 | @item -t |
252b5132 | 1048 | @itemx --trace |
4f4690cd AM |
1049 | Print the names of the input files as @command{ld} processes them. If |
1050 | @samp{-t} is given twice then members within archives are also printed. | |
1051 | @samp{-t} output is useful to generate a list of all the object files | |
1052 | and scripts involved in linking, for example, when packaging files for | |
1053 | a linker bug report. | |
252b5132 RH |
1054 | |
1055 | @kindex -T @var{script} | |
1056 | @kindex --script=@var{script} | |
1057 | @cindex script files | |
1058 | @item -T @var{scriptfile} | |
1059 | @itemx --script=@var{scriptfile} | |
1060 | Use @var{scriptfile} as the linker script. This script replaces | |
ff5dcc92 | 1061 | @command{ld}'s default linker script (rather than adding to it), so |
252b5132 | 1062 | @var{commandfile} must specify everything necessary to describe the |
114283d8 NC |
1063 | output file. @xref{Scripts}. If @var{scriptfile} does not exist in |
1064 | the current directory, @code{ld} looks for it in the directories | |
1065 | specified by any preceding @samp{-L} options. Multiple @samp{-T} | |
1066 | options accumulate. | |
252b5132 | 1067 | |
14be8564 L |
1068 | @kindex -dT @var{script} |
1069 | @kindex --default-script=@var{script} | |
1070 | @cindex script files | |
1071 | @item -dT @var{scriptfile} | |
1072 | @itemx --default-script=@var{scriptfile} | |
1073 | Use @var{scriptfile} as the default linker script. @xref{Scripts}. | |
1074 | ||
1075 | This option is similar to the @option{--script} option except that | |
1076 | processing of the script is delayed until after the rest of the | |
1077 | command line has been processed. This allows options placed after the | |
1078 | @option{--default-script} option on the command line to affect the | |
1079 | behaviour of the linker script, which can be important when the linker | |
1080 | command line cannot be directly controlled by the user. (eg because | |
1081 | the command line is being constructed by another tool, such as | |
1082 | @samp{gcc}). | |
1083 | ||
252b5132 RH |
1084 | @kindex -u @var{symbol} |
1085 | @kindex --undefined=@var{symbol} | |
1086 | @cindex undefined symbol | |
1087 | @item -u @var{symbol} | |
1088 | @itemx --undefined=@var{symbol} | |
1089 | Force @var{symbol} to be entered in the output file as an undefined | |
1090 | symbol. Doing this may, for example, trigger linking of additional | |
1091 | modules from standard libraries. @samp{-u} may be repeated with | |
1092 | different option arguments to enter additional undefined symbols. This | |
1093 | option is equivalent to the @code{EXTERN} linker script command. | |
1094 | ||
0a618243 AB |
1095 | If this option is being used to force additional modules to be pulled |
1096 | into the link, and if it is an error for the symbol to remain | |
1097 | undefined, then the option @option{--require-defined} should be used | |
1098 | instead. | |
1099 | ||
1100 | @kindex --require-defined=@var{symbol} | |
1101 | @cindex symbols, require defined | |
1102 | @cindex defined symbol | |
1103 | @item --require-defined=@var{symbol} | |
1104 | Require that @var{symbol} is defined in the output file. This option | |
1105 | is the same as option @option{--undefined} except that if @var{symbol} | |
1106 | is not defined in the output file then the linker will issue an error | |
1107 | and exit. The same effect can be achieved in a linker script by using | |
1108 | @code{EXTERN}, @code{ASSERT} and @code{DEFINED} together. This option | |
1109 | can be used multiple times to require additional symbols. | |
1110 | ||
252b5132 RH |
1111 | @kindex -Ur |
1112 | @cindex constructors | |
a1ab1d2a | 1113 | @item -Ur |
252b5132 RH |
1114 | For anything other than C++ programs, this option is equivalent to |
1115 | @samp{-r}: it generates relocatable output---i.e., an output file that can in | |
ff5dcc92 | 1116 | turn serve as input to @command{ld}. When linking C++ programs, @samp{-Ur} |
252b5132 RH |
1117 | @emph{does} resolve references to constructors, unlike @samp{-r}. |
1118 | It does not work to use @samp{-Ur} on files that were themselves linked | |
1119 | with @samp{-Ur}; once the constructor table has been built, it cannot | |
1120 | be added to. Use @samp{-Ur} only for the last partial link, and | |
1121 | @samp{-r} for the others. | |
1122 | ||
c005eb9e AB |
1123 | @kindex --orphan-handling=@var{MODE} |
1124 | @cindex orphan sections | |
1125 | @cindex sections, orphan | |
1126 | @item --orphan-handling=@var{MODE} | |
1127 | Control how orphan sections are handled. An orphan section is one not | |
1128 | specifically mentioned in a linker script. @xref{Orphan Sections}. | |
1129 | ||
1130 | @var{MODE} can have any of the following values: | |
1131 | ||
1132 | @table @code | |
1133 | @item place | |
1134 | Orphan sections are placed into a suitable output section following | |
1135 | the strategy described in @ref{Orphan Sections}. The option | |
d2732b69 | 1136 | @samp{--unique} also affects how sections are placed. |
c005eb9e AB |
1137 | |
1138 | @item discard | |
1139 | All orphan sections are discarded, by placing them in the | |
1140 | @samp{/DISCARD/} section (@pxref{Output Section Discarding}). | |
1141 | ||
1142 | @item warn | |
1143 | The linker will place the orphan section as for @code{place} and also | |
1144 | issue a warning. | |
1145 | ||
1146 | @item error | |
1147 | The linker will exit with an error if any orphan section is found. | |
1148 | @end table | |
1149 | ||
1150 | The default if @samp{--orphan-handling} is not given is @code{place}. | |
1151 | ||
577a0623 AM |
1152 | @kindex --unique[=@var{SECTION}] |
1153 | @item --unique[=@var{SECTION}] | |
1154 | Creates a separate output section for every input section matching | |
1155 | @var{SECTION}, or if the optional wildcard @var{SECTION} argument is | |
1156 | missing, for every orphan input section. An orphan section is one not | |
1157 | specifically mentioned in a linker script. You may use this option | |
1158 | multiple times on the command line; It prevents the normal merging of | |
1159 | input sections with the same name, overriding output section assignments | |
1160 | in a linker script. | |
a854a4a7 | 1161 | |
252b5132 RH |
1162 | @kindex -v |
1163 | @kindex -V | |
1164 | @kindex --version | |
1165 | @cindex version | |
1166 | @item -v | |
1167 | @itemx --version | |
1168 | @itemx -V | |
ff5dcc92 | 1169 | Display the version number for @command{ld}. The @option{-V} option also |
252b5132 RH |
1170 | lists the supported emulations. |
1171 | ||
1172 | @kindex -x | |
1173 | @kindex --discard-all | |
1174 | @cindex deleting local symbols | |
1175 | @item -x | |
1176 | @itemx --discard-all | |
1177 | Delete all local symbols. | |
1178 | ||
1179 | @kindex -X | |
1180 | @kindex --discard-locals | |
1181 | @cindex local symbols, deleting | |
a1ab1d2a | 1182 | @item -X |
252b5132 | 1183 | @itemx --discard-locals |
3c68c38f BW |
1184 | Delete all temporary local symbols. (These symbols start with |
1185 | system-specific local label prefixes, typically @samp{.L} for ELF systems | |
1186 | or @samp{L} for traditional a.out systems.) | |
252b5132 RH |
1187 | |
1188 | @kindex -y @var{symbol} | |
1189 | @kindex --trace-symbol=@var{symbol} | |
1190 | @cindex symbol tracing | |
1191 | @item -y @var{symbol} | |
1192 | @itemx --trace-symbol=@var{symbol} | |
1193 | Print the name of each linked file in which @var{symbol} appears. This | |
1194 | option may be given any number of times. On many systems it is necessary | |
1195 | to prepend an underscore. | |
1196 | ||
1197 | This option is useful when you have an undefined symbol in your link but | |
1198 | don't know where the reference is coming from. | |
1199 | ||
1200 | @kindex -Y @var{path} | |
1201 | @item -Y @var{path} | |
1202 | Add @var{path} to the default library search path. This option exists | |
1203 | for Solaris compatibility. | |
1204 | ||
1205 | @kindex -z @var{keyword} | |
1206 | @item -z @var{keyword} | |
cd6d6c15 NC |
1207 | The recognized keywords are: |
1208 | @table @samp | |
1209 | ||
e6e2dfbd AM |
1210 | @item bndplt |
1211 | Always generate BND prefix in PLT entries. Supported for Linux/x86_64. | |
1212 | ||
1213 | @item call-nop=prefix-addr | |
1214 | @itemx call-nop=suffix-nop | |
1215 | @itemx call-nop=prefix-@var{byte} | |
1216 | @itemx call-nop=suffix-@var{byte} | |
1217 | Specify the 1-byte @code{NOP} padding when transforming indirect call | |
1218 | to a locally defined function, foo, via its GOT slot. | |
1219 | @option{call-nop=prefix-addr} generates @code{0x67 call foo}. | |
1220 | @option{call-nop=suffix-nop} generates @code{call foo 0x90}. | |
1221 | @option{call-nop=prefix-@var{byte}} generates @code{@var{byte} call foo}. | |
1222 | @option{call-nop=suffix-@var{byte}} generates @code{call foo @var{byte}}. | |
1223 | Supported for i386 and x86_64. | |
1224 | ||
233a0083 L |
1225 | @item cet-report=none |
1226 | @itemx cet-report=warning | |
1227 | @itemx cet-report=error | |
1228 | Specify how to report the missing GNU_PROPERTY_X86_FEATURE_1_IBT and | |
1229 | GNU_PROPERTY_X86_FEATURE_1_SHSTK properties in input .note.gnu.property | |
1230 | section. @option{cet-report=none}, which is the default, will make the | |
1231 | linker not report missing properties in input files. | |
1232 | @option{cet-report=warning} will make the linker issue a warning for | |
1233 | missing properties in input files. @option{cet-report=error} will make | |
1234 | the linker issue an error for missing properties in input files. | |
1235 | Note that @option{ibt} will turn off the missing | |
1236 | GNU_PROPERTY_X86_FEATURE_1_IBT property report and @option{shstk} will | |
1237 | turn off the missing GNU_PROPERTY_X86_FEATURE_1_SHSTK property report. | |
1238 | Supported for Linux/i386 and Linux/x86_64. | |
1239 | ||
cd6d6c15 | 1240 | @item combreloc |
e6e2dfbd AM |
1241 | @itemx nocombreloc |
1242 | Combine multiple dynamic relocation sections and sort to improve | |
1243 | dynamic symbol lookup caching. Do not do this if @samp{nocombreloc}. | |
cd6d6c15 | 1244 | |
b8871f35 | 1245 | @item common |
e6e2dfbd AM |
1246 | @itemx nocommon |
1247 | Generate common symbols with STT_COMMON type during a relocatable | |
1248 | link. Use STT_OBJECT type if @samp{nocommon}. | |
1249 | ||
1250 | @item common-page-size=@var{value} | |
1251 | Set the page size most commonly used to @var{value}. Memory image | |
1252 | layout will be optimized to minimize memory pages if the system is | |
1253 | using pages of this size. | |
b8871f35 | 1254 | |
cd6d6c15 | 1255 | @item defs |
97a232d7 NC |
1256 | Report unresolved symbol references from regular object files. This |
1257 | is done even if the linker is creating a non-symbolic shared library. | |
1258 | This option is the inverse of @samp{-z undefs}. | |
cd6d6c15 | 1259 | |
e6e2dfbd AM |
1260 | @item dynamic-undefined-weak |
1261 | @itemx nodynamic-undefined-weak | |
1262 | Make undefined weak symbols dynamic when building a dynamic object, | |
1263 | if they are referenced from a regular object file and not forced local | |
1264 | by symbol visibility or versioning. Do not make them dynamic if | |
1265 | @samp{nodynamic-undefined-weak}. If neither option is given, a target | |
1266 | may default to either option being in force, or make some other | |
1267 | selection of undefined weak symbols dynamic. Not all targets support | |
1268 | these options. | |
1269 | ||
6aa29e7b JJ |
1270 | @item execstack |
1271 | Marks the object as requiring executable stack. | |
1272 | ||
b039ef04 L |
1273 | @item global |
1274 | This option is only meaningful when building a shared object. It makes | |
1275 | the symbols defined by this shared object available for symbol resolution | |
1276 | of subsequently loaded libraries. | |
1277 | ||
93ab9c0d NC |
1278 | @item globalaudit |
1279 | This option is only meaningful when building a dynamic executable. | |
1280 | This option marks the executable as requiring global auditing by | |
1281 | setting the @code{DF_1_GLOBAUDIT} bit in the @code{DT_FLAGS_1} dynamic | |
1282 | tag. Global auditing requires that any auditing library defined via | |
a05a5b64 | 1283 | the @option{--depaudit} or @option{-P} command-line options be run for |
6c19b93b | 1284 | all dynamic objects loaded by the application. |
93ab9c0d | 1285 | |
e6e2dfbd AM |
1286 | @item ibtplt |
1287 | Generate Intel Indirect Branch Tracking (IBT) enabled PLT entries. | |
1288 | Supported for Linux/i386 and Linux/x86_64. | |
1289 | ||
8df93cb5 | 1290 | @item ibt |
e6e2dfbd AM |
1291 | Generate GNU_PROPERTY_X86_FEATURE_1_IBT in .note.gnu.property section |
1292 | to indicate compatibility with IBT. This also implies @option{ibtplt}. | |
1293 | Supported for Linux/i386 and Linux/x86_64. | |
1294 | ||
cd6d6c15 NC |
1295 | @item initfirst |
1296 | This option is only meaningful when building a shared object. | |
1297 | It marks the object so that its runtime initialization will occur | |
1298 | before the runtime initialization of any other objects brought into | |
1299 | the process at the same time. Similarly the runtime finalization of | |
1300 | the object will occur after the runtime finalization of any other | |
1301 | objects. | |
1302 | ||
1303 | @item interpose | |
e6e2dfbd AM |
1304 | Specify that the dynamic loader should modify its symbol search order |
1305 | so that symbols in this shared library interpose all other shared | |
1306 | libraries not so marked. | |
cd6d6c15 | 1307 | |
5fa222e4 AM |
1308 | @item lazy |
1309 | When generating an executable or shared library, mark it to tell the | |
1310 | dynamic linker to defer function call resolution to the point when | |
1311 | the function is called (lazy binding), rather than at load time. | |
1312 | Lazy binding is the default. | |
1313 | ||
cd6d6c15 | 1314 | @item loadfltr |
e6e2dfbd | 1315 | Specify that the object's filters be processed immediately at runtime. |
cd6d6c15 | 1316 | |
e6e2dfbd AM |
1317 | @item max-page-size=@var{value} |
1318 | Set the maximum memory page size supported to @var{value}. | |
cd6d6c15 | 1319 | |
e6e2dfbd AM |
1320 | @item muldefs |
1321 | Allow multiple definitions. | |
b8871f35 | 1322 | |
cd6d6c15 | 1323 | @item nocopyreloc |
daf220f0 AM |
1324 | Disable linker generated .dynbss variables used in place of variables |
1325 | defined in shared libraries. May result in dynamic text relocations. | |
cd6d6c15 NC |
1326 | |
1327 | @item nodefaultlib | |
e6e2dfbd AM |
1328 | Specify that the dynamic loader search for dependencies of this object |
1329 | should ignore any default library search paths. | |
cd6d6c15 NC |
1330 | |
1331 | @item nodelete | |
e6e2dfbd | 1332 | Specify that the object shouldn't be unloaded at runtime. |
cd6d6c15 NC |
1333 | |
1334 | @item nodlopen | |
e6e2dfbd | 1335 | Specify that the object is not available to @code{dlopen}. |
cd6d6c15 NC |
1336 | |
1337 | @item nodump | |
e6e2dfbd | 1338 | Specify that the object can not be dumped by @code{dldump}. |
cd6d6c15 | 1339 | |
6aa29e7b JJ |
1340 | @item noexecstack |
1341 | Marks the object as not requiring executable stack. | |
1342 | ||
e6e2dfbd AM |
1343 | @item noextern-protected-data |
1344 | Don't treat protected data symbols as external when building a shared | |
1345 | library. This option overrides the linker backend default. It can be | |
1346 | used to work around incorrect relocations against protected data symbols | |
1347 | generated by compiler. Updates on protected data symbols by another | |
1348 | module aren't visible to the resulting shared library. Supported for | |
1349 | i386 and x86-64. | |
8dfef1bd | 1350 | |
e6e2dfbd AM |
1351 | @item noreloc-overflow |
1352 | Disable relocation overflow check. This can be used to disable | |
1353 | relocation overflow check if there will be no dynamic relocation | |
1354 | overflow at run-time. Supported for x86_64. | |
6aa29e7b | 1355 | |
cd6d6c15 NC |
1356 | @item now |
1357 | When generating an executable or shared library, mark it to tell the | |
1358 | dynamic linker to resolve all symbols when the program is started, or | |
e6e2dfbd AM |
1359 | when the shared library is loaded by dlopen, instead of deferring |
1360 | function call resolution to the point when the function is first | |
1361 | called. | |
cd6d6c15 NC |
1362 | |
1363 | @item origin | |
e6e2dfbd | 1364 | Specify that the object requires @samp{$ORIGIN} handling in paths. |
cd6d6c15 | 1365 | |
6aa29e7b | 1366 | @item relro |
e6e2dfbd | 1367 | @itemx norelro |
def5c83c AM |
1368 | Create an ELF @code{PT_GNU_RELRO} segment header in the object. This |
1369 | specifies a memory segment that should be made read-only after | |
1370 | relocation, if supported. Specifying @samp{common-page-size} smaller | |
1371 | than the system page size will render this protection ineffective. | |
e6e2dfbd | 1372 | Don't create an ELF @code{PT_GNU_RELRO} segment if @samp{norelro}. |
6aa29e7b | 1373 | |
47acac12 L |
1374 | @item separate-code |
1375 | @itemx noseparate-code | |
1376 | Create separate code @code{PT_LOAD} segment header in the object. This | |
1377 | specifies a memory segment that should contain only instructions and must | |
1378 | be in wholly disjoint pages from any other data. Don't create separate | |
1379 | code @code{PT_LOAD} segment if @samp{noseparate-code} is used. | |
1380 | ||
496afd17 L |
1381 | @item unique-symbol |
1382 | @itemx nounique-symbol | |
1383 | Avoid duplicated local symbol names in the symbol string table. Append | |
1384 | ".@code{number}" to duplicated local symbol names if @samp{unique-symbol} | |
1385 | is used. @option{nounique-symbol} is the default. | |
1386 | ||
e6e2dfbd AM |
1387 | @item shstk |
1388 | Generate GNU_PROPERTY_X86_FEATURE_1_SHSTK in .note.gnu.property section | |
1389 | to indicate compatibility with Intel Shadow Stack. Supported for | |
1390 | Linux/i386 and Linux/x86_64. | |
24718e3b | 1391 | |
04c3a755 | 1392 | @item stack-size=@var{value} |
e6e2dfbd | 1393 | Specify a stack size for an ELF @code{PT_GNU_STACK} segment. |
04c3a755 NS |
1394 | Specifying zero will override any default non-zero sized |
1395 | @code{PT_GNU_STACK} segment creation. | |
1396 | ||
cae64165 RM |
1397 | @item start-stop-visibility=@var{value} |
1398 | @cindex visibility | |
1399 | @cindex ELF symbol visibility | |
1400 | Specify the ELF symbol visibility for synthesized | |
1401 | @code{__start_SECNAME} and @code{__stop_SECNAME} symbols (@pxref{Input | |
1402 | Section Example}). @var{value} must be exactly @samp{default}, | |
1403 | @samp{internal}, @samp{hidden}, or @samp{protected}. If no @samp{-z | |
1404 | start-stop-visibility} option is given, @samp{protected} is used for | |
1405 | compatibility with historical practice. However, it's highly | |
1406 | recommended to use @samp{-z start-stop-visibility=hidden} in new | |
1407 | programs and shared libraries so that these symbols are not exported | |
1408 | between shared objects, which is not usually what's intended. | |
1409 | ||
e6e2dfbd AM |
1410 | @item text |
1411 | @itemx notext | |
1412 | @itemx textoff | |
a6dbf402 L |
1413 | Report an error if DT_TEXTREL is set, i.e., if the position-independent |
1414 | or shared object has dynamic relocations in read-only sections. Don't | |
1415 | report an error if @samp{notext} or @samp{textoff}. | |
48580982 | 1416 | |
97a232d7 NC |
1417 | @item undefs |
1418 | Do not report unresolved symbol references from regular object files, | |
1419 | either when creating an executable, or when creating a shared library. | |
1420 | This option is the inverse of @samp{-z defs}. | |
1421 | ||
32930e4e L |
1422 | @item x86-64-v2 |
1423 | @item x86-64-v3 | |
1424 | @itemx x86-64-v4 | |
1425 | Specify the x86-64 ISA level needed in .note.gnu.property section. | |
1426 | @option{x86-64-v2} generates @code{GNU_PROPERTY_X86_ISA_1_V2}. | |
1427 | @option{x86-64-v3} generates @code{GNU_PROPERTY_X86_ISA_1_V3}. | |
1428 | @option{x86-64-v4} generates @code{GNU_PROPERTY_X86_ISA_1_V4}. | |
1429 | Supported for Linux/i386 and Linux/x86_64. | |
1430 | ||
cd6d6c15 NC |
1431 | @end table |
1432 | ||
ece2d90e | 1433 | Other keywords are ignored for Solaris compatibility. |
252b5132 RH |
1434 | |
1435 | @kindex -( | |
1436 | @cindex groups of archives | |
1437 | @item -( @var{archives} -) | |
1438 | @itemx --start-group @var{archives} --end-group | |
1439 | The @var{archives} should be a list of archive files. They may be | |
1440 | either explicit file names, or @samp{-l} options. | |
1441 | ||
1442 | The specified archives are searched repeatedly until no new undefined | |
1443 | references are created. Normally, an archive is searched only once in | |
1444 | the order that it is specified on the command line. If a symbol in that | |
1445 | archive is needed to resolve an undefined symbol referred to by an | |
1446 | object in an archive that appears later on the command line, the linker | |
1447 | would not be able to resolve that reference. By grouping the archives, | |
5d3db3e2 | 1448 | they will all be searched repeatedly until all possible references are |
252b5132 RH |
1449 | resolved. |
1450 | ||
1451 | Using this option has a significant performance cost. It is best to use | |
1452 | it only when there are unavoidable circular references between two or | |
1453 | more archives. | |
1454 | ||
69da35b5 NC |
1455 | @kindex --accept-unknown-input-arch |
1456 | @kindex --no-accept-unknown-input-arch | |
1457 | @item --accept-unknown-input-arch | |
1458 | @itemx --no-accept-unknown-input-arch | |
1459 | Tells the linker to accept input files whose architecture cannot be | |
2ca22b03 | 1460 | recognised. The assumption is that the user knows what they are doing |
69da35b5 NC |
1461 | and deliberately wants to link in these unknown input files. This was |
1462 | the default behaviour of the linker, before release 2.14. The default | |
1463 | behaviour from release 2.14 onwards is to reject such input files, and | |
1464 | so the @samp{--accept-unknown-input-arch} option has been added to | |
1465 | restore the old behaviour. | |
2ca22b03 | 1466 | |
4a43e768 AM |
1467 | @kindex --as-needed |
1468 | @kindex --no-as-needed | |
1469 | @item --as-needed | |
1470 | @itemx --no-as-needed | |
1471 | This option affects ELF DT_NEEDED tags for dynamic libraries mentioned | |
ddbb8a31 | 1472 | on the command line after the @option{--as-needed} option. Normally |
4a43e768 AM |
1473 | the linker will add a DT_NEEDED tag for each dynamic library mentioned |
1474 | on the command line, regardless of whether the library is actually | |
ddbb8a31 | 1475 | needed or not. @option{--as-needed} causes a DT_NEEDED tag to only be |
ffa9430d AM |
1476 | emitted for a library that @emph{at that point in the link} satisfies a |
1477 | non-weak undefined symbol reference from a regular object file or, if | |
1240be6b AM |
1478 | the library is not found in the DT_NEEDED lists of other needed libraries, a |
1479 | non-weak undefined symbol reference from another needed dynamic library. | |
ffa9430d AM |
1480 | Object files or libraries appearing on the command line @emph{after} |
1481 | the library in question do not affect whether the library is seen as | |
1482 | needed. This is similar to the rules for extraction of object files | |
1483 | from archives. @option{--no-as-needed} restores the default behaviour. | |
4a43e768 | 1484 | |
e56f61be L |
1485 | @kindex --add-needed |
1486 | @kindex --no-add-needed | |
1487 | @item --add-needed | |
1488 | @itemx --no-add-needed | |
ddbb8a31 NC |
1489 | These two options have been deprecated because of the similarity of |
1490 | their names to the @option{--as-needed} and @option{--no-as-needed} | |
1491 | options. They have been replaced by @option{--copy-dt-needed-entries} | |
1492 | and @option{--no-copy-dt-needed-entries}. | |
e56f61be | 1493 | |
252b5132 RH |
1494 | @kindex -assert @var{keyword} |
1495 | @item -assert @var{keyword} | |
1496 | This option is ignored for SunOS compatibility. | |
1497 | ||
1498 | @kindex -Bdynamic | |
1499 | @kindex -dy | |
1500 | @kindex -call_shared | |
1501 | @item -Bdynamic | |
1502 | @itemx -dy | |
1503 | @itemx -call_shared | |
1504 | Link against dynamic libraries. This is only meaningful on platforms | |
1505 | for which shared libraries are supported. This option is normally the | |
1506 | default on such platforms. The different variants of this option are | |
1507 | for compatibility with various systems. You may use this option | |
1508 | multiple times on the command line: it affects library searching for | |
da8bce14 | 1509 | @option{-l} options which follow it. |
252b5132 | 1510 | |
a1ab1d2a UD |
1511 | @kindex -Bgroup |
1512 | @item -Bgroup | |
1513 | Set the @code{DF_1_GROUP} flag in the @code{DT_FLAGS_1} entry in the dynamic | |
1514 | section. This causes the runtime linker to handle lookups in this | |
1515 | object and its dependencies to be performed only inside the group. | |
560e09e9 NC |
1516 | @option{--unresolved-symbols=report-all} is implied. This option is |
1517 | only meaningful on ELF platforms which support shared libraries. | |
a1ab1d2a | 1518 | |
252b5132 RH |
1519 | @kindex -Bstatic |
1520 | @kindex -dn | |
1521 | @kindex -non_shared | |
1522 | @kindex -static | |
a1ab1d2a | 1523 | @item -Bstatic |
252b5132 RH |
1524 | @itemx -dn |
1525 | @itemx -non_shared | |
1526 | @itemx -static | |
1527 | Do not link against shared libraries. This is only meaningful on | |
1528 | platforms for which shared libraries are supported. The different | |
1529 | variants of this option are for compatibility with various systems. You | |
1530 | may use this option multiple times on the command line: it affects | |
560e09e9 | 1531 | library searching for @option{-l} options which follow it. This |
e9156f74 NC |
1532 | option also implies @option{--unresolved-symbols=report-all}. This |
1533 | option can be used with @option{-shared}. Doing so means that a | |
1534 | shared library is being created but that all of the library's external | |
1535 | references must be resolved by pulling in entries from static | |
ece2d90e | 1536 | libraries. |
252b5132 RH |
1537 | |
1538 | @kindex -Bsymbolic | |
1539 | @item -Bsymbolic | |
1540 | When creating a shared library, bind references to global symbols to the | |
1541 | definition within the shared library, if any. Normally, it is possible | |
1542 | for a program linked against a shared library to override the definition | |
1914e264 AM |
1543 | within the shared library. This option is only meaningful on ELF |
1544 | platforms which support shared libraries. | |
252b5132 | 1545 | |
40b36307 L |
1546 | @kindex -Bsymbolic-functions |
1547 | @item -Bsymbolic-functions | |
1548 | When creating a shared library, bind references to global function | |
c0065db7 | 1549 | symbols to the definition within the shared library, if any. |
40b36307 | 1550 | This option is only meaningful on ELF platforms which support shared |
1914e264 | 1551 | libraries. |
40b36307 | 1552 | |
55255dae L |
1553 | @kindex --dynamic-list=@var{dynamic-list-file} |
1554 | @item --dynamic-list=@var{dynamic-list-file} | |
1555 | Specify the name of a dynamic list file to the linker. This is | |
1556 | typically used when creating shared libraries to specify a list of | |
1557 | global symbols whose references shouldn't be bound to the definition | |
1558 | within the shared library, or creating dynamically linked executables | |
1559 | to specify a list of symbols which should be added to the symbol table | |
1560 | in the executable. This option is only meaningful on ELF platforms | |
1561 | which support shared libraries. | |
1562 | ||
1563 | The format of the dynamic list is the same as the version node without | |
1564 | scope and node name. See @ref{VERSION} for more information. | |
1565 | ||
40b36307 L |
1566 | @kindex --dynamic-list-data |
1567 | @item --dynamic-list-data | |
1568 | Include all global data symbols to the dynamic list. | |
1569 | ||
1570 | @kindex --dynamic-list-cpp-new | |
1571 | @item --dynamic-list-cpp-new | |
1572 | Provide the builtin dynamic list for C++ operator new and delete. It | |
1573 | is mainly useful for building shared libstdc++. | |
1574 | ||
0b8a70d9 L |
1575 | @kindex --dynamic-list-cpp-typeinfo |
1576 | @item --dynamic-list-cpp-typeinfo | |
1577 | Provide the builtin dynamic list for C++ runtime type identification. | |
1578 | ||
252b5132 RH |
1579 | @kindex --check-sections |
1580 | @kindex --no-check-sections | |
1581 | @item --check-sections | |
308b1ffd | 1582 | @itemx --no-check-sections |
252b5132 | 1583 | Asks the linker @emph{not} to check section addresses after they have |
7d816a17 | 1584 | been assigned to see if there are any overlaps. Normally the linker will |
252b5132 RH |
1585 | perform this check, and if it finds any overlaps it will produce |
1586 | suitable error messages. The linker does know about, and does make | |
1587 | allowances for sections in overlays. The default behaviour can be | |
a05a5b64 | 1588 | restored by using the command-line switch @option{--check-sections}. |
02b0b1aa NS |
1589 | Section overlap is not usually checked for relocatable links. You can |
1590 | force checking in that case by using the @option{--check-sections} | |
1591 | option. | |
252b5132 | 1592 | |
ddbb8a31 NC |
1593 | @kindex --copy-dt-needed-entries |
1594 | @kindex --no-copy-dt-needed-entries | |
1595 | @item --copy-dt-needed-entries | |
1596 | @itemx --no-copy-dt-needed-entries | |
9d5777a3 | 1597 | This option affects the treatment of dynamic libraries referred to |
ddbb8a31 | 1598 | by DT_NEEDED tags @emph{inside} ELF dynamic libraries mentioned on the |
08efffb8 | 1599 | command line. Normally the linker won't add a DT_NEEDED tag to the |
ddbb8a31 | 1600 | output binary for each library mentioned in a DT_NEEDED tag in an |
08efffb8 | 1601 | input dynamic library. With @option{--copy-dt-needed-entries} |
ddbb8a31 | 1602 | specified on the command line however any dynamic libraries that |
08efffb8 MM |
1603 | follow it will have their DT_NEEDED entries added. The default |
1604 | behaviour can be restored with @option{--no-copy-dt-needed-entries}. | |
ddbb8a31 NC |
1605 | |
1606 | This option also has an effect on the resolution of symbols in dynamic | |
08efffb8 MM |
1607 | libraries. With @option{--copy-dt-needed-entries} dynamic libraries |
1608 | mentioned on the command line will be recursively searched, following | |
1609 | their DT_NEEDED tags to other libraries, in order to resolve symbols | |
1610 | required by the output binary. With the default setting however | |
1611 | the searching of dynamic libraries that follow it will stop with the | |
1612 | dynamic library itself. No DT_NEEDED links will be traversed to resolve | |
ddbb8a31 NC |
1613 | symbols. |
1614 | ||
252b5132 RH |
1615 | @cindex cross reference table |
1616 | @kindex --cref | |
1617 | @item --cref | |
1618 | Output a cross reference table. If a linker map file is being | |
1619 | generated, the cross reference table is printed to the map file. | |
1620 | Otherwise, it is printed on the standard output. | |
1621 | ||
1622 | The format of the table is intentionally simple, so that it may be | |
1623 | easily processed by a script if necessary. The symbols are printed out, | |
1624 | sorted by name. For each symbol, a list of file names is given. If the | |
1625 | symbol is defined, the first file listed is the location of the | |
049c1c8e NC |
1626 | definition. If the symbol is defined as a common value then any files |
1627 | where this happens appear next. Finally any files that reference the | |
1628 | symbol are listed. | |
252b5132 | 1629 | |
5dba6f05 NA |
1630 | @cindex ctf variables |
1631 | @kindex --ctf-variables | |
1632 | @kindex --no-ctf-variables | |
1633 | @item --ctf-variables | |
1634 | @item --no-ctf-variables | |
1635 | The CTF debuginfo format supports a section which encodes the names and | |
1636 | types of variables found in the program which do not appear in any symbol | |
1637 | table. These variables clearly cannot be looked up by address by | |
1638 | conventional debuggers, so the space used for their types and names is | |
1639 | usually wasted: the types are usually small but the names are often not. | |
1640 | @option{--ctf-variables} causes the generation of such a section. | |
1641 | The default behaviour can be restored with @option{--no-ctf-variables}. | |
1642 | ||
1643 | @cindex ctf type sharing | |
1644 | @kindex --ctf-share-types | |
1645 | @item --ctf-share-types=@var{method} | |
1646 | Adjust the method used to share types between translation units in CTF. | |
1647 | ||
1648 | @table @samp | |
1649 | @item share-unconflicted | |
1650 | Put all types that do not have ambiguous definitions into the shared dictionary, | |
1651 | where debuggers can easily access them, even if they only occur in one | |
1652 | translation unit. This is the default. | |
1653 | ||
1654 | @item share-duplicated | |
1655 | Put only types that occur in multiple translation units into the shared | |
1656 | dictionary: types with only one definition go into per-translation-unit | |
1657 | dictionaries. Types with ambiguous definitions in multiple translation units | |
1658 | always go into per-translation-unit dictionaries. This tends to make the CTF | |
1659 | larger, but may reduce the amount of CTF in the shared dictionary. For very | |
1660 | large projects this may speed up opening the CTF and save memory in the CTF | |
1661 | consumer at runtime. | |
1662 | @end table | |
1663 | ||
4818e05f AM |
1664 | @cindex common allocation |
1665 | @kindex --no-define-common | |
1666 | @item --no-define-common | |
1667 | This option inhibits the assignment of addresses to common symbols. | |
1668 | The script command @code{INHIBIT_COMMON_ALLOCATION} has the same effect. | |
1669 | @xref{Miscellaneous Commands}. | |
1670 | ||
1671 | The @samp{--no-define-common} option allows decoupling | |
1672 | the decision to assign addresses to Common symbols from the choice | |
1673 | of the output file type; otherwise a non-Relocatable output type | |
1674 | forces assigning addresses to Common symbols. | |
1675 | Using @samp{--no-define-common} allows Common symbols that are referenced | |
1676 | from a shared library to be assigned addresses only in the main program. | |
1677 | This eliminates the unused duplicate space in the shared library, | |
1678 | and also prevents any possible confusion over resolving to the wrong | |
1679 | duplicate when there are many dynamic modules with specialized search | |
1680 | paths for runtime symbol resolution. | |
1681 | ||
7bdf4127 AB |
1682 | @cindex group allocation in linker script |
1683 | @cindex section groups | |
1684 | @cindex COMDAT | |
1685 | @kindex --force-group-allocation | |
1686 | @item --force-group-allocation | |
1687 | This option causes the linker to place section group members like | |
1688 | normal input sections, and to delete the section groups. This is the | |
1689 | default behaviour for a final link but this option can be used to | |
1690 | change the behaviour of a relocatable link (@samp{-r}). The script | |
1691 | command @code{FORCE_GROUP_ALLOCATION} has the same | |
1692 | effect. @xref{Miscellaneous Commands}. | |
1693 | ||
252b5132 | 1694 | @cindex symbols, from command line |
2509a395 SL |
1695 | @kindex --defsym=@var{symbol}=@var{exp} |
1696 | @item --defsym=@var{symbol}=@var{expression} | |
252b5132 RH |
1697 | Create a global symbol in the output file, containing the absolute |
1698 | address given by @var{expression}. You may use this option as many | |
1699 | times as necessary to define multiple symbols in the command line. A | |
1700 | limited form of arithmetic is supported for the @var{expression} in this | |
1701 | context: you may give a hexadecimal constant or the name of an existing | |
1702 | symbol, or use @code{+} and @code{-} to add or subtract hexadecimal | |
1703 | constants or symbols. If you need more elaborate expressions, consider | |
66bc8739 AM |
1704 | using the linker command language from a script (@pxref{Assignments}). |
1705 | @emph{Note:} there should be no white space between @var{symbol}, the | |
1706 | equals sign (``@key{=}''), and @var{expression}. | |
252b5132 RH |
1707 | |
1708 | @cindex demangling, from command line | |
28c309a2 | 1709 | @kindex --demangle[=@var{style}] |
252b5132 | 1710 | @kindex --no-demangle |
28c309a2 | 1711 | @item --demangle[=@var{style}] |
252b5132 RH |
1712 | @itemx --no-demangle |
1713 | These options control whether to demangle symbol names in error messages | |
1714 | and other output. When the linker is told to demangle, it tries to | |
1715 | present symbol names in a readable fashion: it strips leading | |
1716 | underscores if they are used by the object file format, and converts C++ | |
a1ab1d2a UD |
1717 | mangled symbol names into user readable names. Different compilers have |
1718 | different mangling styles. The optional demangling style argument can be used | |
1719 | to choose an appropriate demangling style for your compiler. The linker will | |
28c309a2 NC |
1720 | demangle by default unless the environment variable @samp{COLLECT_NO_DEMANGLE} |
1721 | is set. These options may be used to override the default. | |
252b5132 RH |
1722 | |
1723 | @cindex dynamic linker, from command line | |
506eee22 | 1724 | @kindex -I@var{file} |
2509a395 SL |
1725 | @kindex --dynamic-linker=@var{file} |
1726 | @item -I@var{file} | |
1727 | @itemx --dynamic-linker=@var{file} | |
252b5132 RH |
1728 | Set the name of the dynamic linker. This is only meaningful when |
1729 | generating dynamically linked ELF executables. The default dynamic | |
1730 | linker is normally correct; don't use this unless you know what you are | |
1731 | doing. | |
1732 | ||
9b8b325a RF |
1733 | @kindex --no-dynamic-linker |
1734 | @item --no-dynamic-linker | |
1735 | When producing an executable file, omit the request for a dynamic | |
1736 | linker to be used at load-time. This is only meaningful for ELF | |
1737 | executables that contain dynamic relocations, and usually requires | |
1738 | entry point code that is capable of processing these relocations. | |
1739 | ||
a70f34c0 NC |
1740 | @kindex --embedded-relocs |
1741 | @item --embedded-relocs | |
1742 | This option is similar to the @option{--emit-relocs} option except | |
a094d01f | 1743 | that the relocs are stored in a target-specific section. This option |
a70f34c0 NC |
1744 | is only supported by the @samp{BFIN}, @samp{CR16} and @emph{M68K} |
1745 | targets. | |
1746 | ||
3f0a5f17 ME |
1747 | @kindex --disable-multiple-abs-defs |
1748 | @item --disable-multiple-abs-defs | |
1749 | Do not allow multiple definitions with symbols included | |
1750 | in filename invoked by -R or --just-symbols | |
1751 | ||
7ce691ae | 1752 | @kindex --fatal-warnings |
0fe58ccd | 1753 | @kindex --no-fatal-warnings |
7ce691ae | 1754 | @item --fatal-warnings |
0fe58ccd NC |
1755 | @itemx --no-fatal-warnings |
1756 | Treat all warnings as errors. The default behaviour can be restored | |
1757 | with the option @option{--no-fatal-warnings}. | |
7ce691ae | 1758 | |
252b5132 RH |
1759 | @kindex --force-exe-suffix |
1760 | @item --force-exe-suffix | |
1761 | Make sure that an output file has a .exe suffix. | |
1762 | ||
1763 | If a successfully built fully linked output file does not have a | |
1764 | @code{.exe} or @code{.dll} suffix, this option forces the linker to copy | |
1765 | the output file to one of the same name with a @code{.exe} suffix. This | |
1766 | option is useful when using unmodified Unix makefiles on a Microsoft | |
1767 | Windows host, since some versions of Windows won't run an image unless | |
1768 | it ends in a @code{.exe} suffix. | |
1769 | ||
1770 | @kindex --gc-sections | |
1771 | @kindex --no-gc-sections | |
1772 | @cindex garbage collection | |
c17d87de NC |
1773 | @item --gc-sections |
1774 | @itemx --no-gc-sections | |
252b5132 | 1775 | Enable garbage collection of unused input sections. It is ignored on |
ac69cbc6 | 1776 | targets that do not support this option. The default behaviour (of not |
b3549761 | 1777 | performing this garbage collection) can be restored by specifying |
0f088b2a KT |
1778 | @samp{--no-gc-sections} on the command line. Note that garbage |
1779 | collection for COFF and PE format targets is supported, but the | |
1780 | implementation is currently considered to be experimental. | |
252b5132 | 1781 | |
d5465ba2 AM |
1782 | @samp{--gc-sections} decides which input sections are used by |
1783 | examining symbols and relocations. The section containing the entry | |
1784 | symbol and all sections containing symbols undefined on the | |
1785 | command-line will be kept, as will sections containing symbols | |
1786 | referenced by dynamic objects. Note that when building shared | |
1787 | libraries, the linker must assume that any visible symbol is | |
1788 | referenced. Once this initial set of sections has been determined, | |
1789 | the linker recursively marks as used any section referenced by their | |
b69e1ff3 CC |
1790 | relocations. See @samp{--entry}, @samp{--undefined}, and |
1791 | @samp{--gc-keep-exported}. | |
d5465ba2 | 1792 | |
ac69cbc6 | 1793 | This option can be set when doing a partial link (enabled with option |
9d5777a3 | 1794 | @samp{-r}). In this case the root of symbols kept must be explicitly |
b69e1ff3 CC |
1795 | specified either by one of the options @samp{--entry}, |
1796 | @samp{--undefined}, or @samp{--gc-keep-exported} or by a @code{ENTRY} | |
1797 | command in the linker script. | |
ac69cbc6 | 1798 | |
c17d87de NC |
1799 | @kindex --print-gc-sections |
1800 | @kindex --no-print-gc-sections | |
1801 | @cindex garbage collection | |
1802 | @item --print-gc-sections | |
1803 | @itemx --no-print-gc-sections | |
1804 | List all sections removed by garbage collection. The listing is | |
1805 | printed on stderr. This option is only effective if garbage | |
1806 | collection has been enabled via the @samp{--gc-sections}) option. The | |
1807 | default behaviour (of not listing the sections that are removed) can | |
1808 | be restored by specifying @samp{--no-print-gc-sections} on the command | |
1809 | line. | |
1810 | ||
22185505 | 1811 | @kindex --gc-keep-exported |
1812 | @cindex garbage collection | |
1813 | @item --gc-keep-exported | |
1814 | When @samp{--gc-sections} is enabled, this option prevents garbage | |
1815 | collection of unused input sections that contain global symbols having | |
1816 | default or protected visibility. This option is intended to be used for | |
1817 | executables where unreferenced sections would otherwise be garbage | |
1818 | collected regardless of the external visibility of contained symbols. | |
1819 | Note that this option has no effect when linking shared objects since | |
1820 | it is already the default behaviour. This option is only supported for | |
1821 | ELF format targets. | |
1822 | ||
30824704 RM |
1823 | @kindex --print-output-format |
1824 | @cindex output format | |
1825 | @item --print-output-format | |
1826 | Print the name of the default output format (perhaps influenced by | |
1827 | other command-line options). This is the string that would appear | |
1828 | in an @code{OUTPUT_FORMAT} linker script command (@pxref{File Commands}). | |
1829 | ||
3604cb1f TG |
1830 | @kindex --print-memory-usage |
1831 | @cindex memory usage | |
1832 | @item --print-memory-usage | |
1833 | Print used size, total size and used size of memory regions created with | |
1834 | the @ref{MEMORY} command. This is useful on embedded targets to have a | |
1835 | quick view of amount of free memory. The format of the output has one | |
1836 | headline and one line per region. It is both human readable and easily | |
1837 | parsable by tools. Here is an example of an output: | |
1838 | ||
1839 | @smallexample | |
1840 | Memory region Used Size Region Size %age Used | |
1841 | ROM: 256 KB 1 MB 25.00% | |
1842 | RAM: 32 B 2 GB 0.00% | |
1843 | @end smallexample | |
1844 | ||
252b5132 RH |
1845 | @cindex help |
1846 | @cindex usage | |
1847 | @kindex --help | |
1848 | @item --help | |
1849 | Print a summary of the command-line options on the standard output and exit. | |
1850 | ||
ea20a7da CC |
1851 | @kindex --target-help |
1852 | @item --target-help | |
a094d01f | 1853 | Print a summary of all target-specific options on the standard output and exit. |
ea20a7da | 1854 | |
2509a395 SL |
1855 | @kindex -Map=@var{mapfile} |
1856 | @item -Map=@var{mapfile} | |
252b5132 | 1857 | Print a link map to the file @var{mapfile}. See the description of the |
72a3b182 NC |
1858 | @option{-M} option, above. Specifying a directory as @var{mapfile} |
1859 | causes the linker map to be written into a file inside the directory. | |
1860 | The name of the file is based upon the @var{output} filename with | |
1861 | @code{.map} appended. | |
252b5132 RH |
1862 | |
1863 | @cindex memory usage | |
1864 | @kindex --no-keep-memory | |
1865 | @item --no-keep-memory | |
ff5dcc92 SC |
1866 | @command{ld} normally optimizes for speed over memory usage by caching the |
1867 | symbol tables of input files in memory. This option tells @command{ld} to | |
252b5132 | 1868 | instead optimize for memory usage, by rereading the symbol tables as |
ff5dcc92 | 1869 | necessary. This may be required if @command{ld} runs out of memory space |
252b5132 RH |
1870 | while linking a large executable. |
1871 | ||
1872 | @kindex --no-undefined | |
a1ab1d2a | 1873 | @kindex -z defs |
97a232d7 | 1874 | @kindex -z undefs |
252b5132 | 1875 | @item --no-undefined |
a1ab1d2a | 1876 | @itemx -z defs |
560e09e9 NC |
1877 | Report unresolved symbol references from regular object files. This |
1878 | is done even if the linker is creating a non-symbolic shared library. | |
1879 | The switch @option{--[no-]allow-shlib-undefined} controls the | |
1880 | behaviour for reporting unresolved references found in shared | |
ece2d90e | 1881 | libraries being linked in. |
252b5132 | 1882 | |
97a232d7 NC |
1883 | The effects of this option can be reverted by using @code{-z undefs}. |
1884 | ||
aa713662 L |
1885 | @kindex --allow-multiple-definition |
1886 | @kindex -z muldefs | |
1887 | @item --allow-multiple-definition | |
1888 | @itemx -z muldefs | |
1889 | Normally when a symbol is defined multiple times, the linker will | |
1890 | report a fatal error. These options allow multiple definitions and the | |
1891 | first definition will be used. | |
1892 | ||
b79e8c78 | 1893 | @kindex --allow-shlib-undefined |
ae9a127f | 1894 | @kindex --no-allow-shlib-undefined |
b79e8c78 | 1895 | @item --allow-shlib-undefined |
ae9a127f | 1896 | @itemx --no-allow-shlib-undefined |
903249d7 | 1897 | Allows or disallows undefined symbols in shared libraries. |
560e09e9 NC |
1898 | This switch is similar to @option{--no-undefined} except that it |
1899 | determines the behaviour when the undefined symbols are in a | |
1900 | shared library rather than a regular object file. It does not affect | |
1901 | how undefined symbols in regular object files are handled. | |
1902 | ||
903249d7 NC |
1903 | The default behaviour is to report errors for any undefined symbols |
1904 | referenced in shared libraries if the linker is being used to create | |
1905 | an executable, but to allow them if the linker is being used to create | |
1906 | a shared library. | |
1907 | ||
1908 | The reasons for allowing undefined symbol references in shared | |
1909 | libraries specified at link time are that: | |
1910 | ||
1911 | @itemize @bullet | |
1912 | @item | |
1913 | A shared library specified at link time may not be the same as the one | |
1914 | that is available at load time, so the symbol might actually be | |
1915 | resolvable at load time. | |
1916 | @item | |
1917 | There are some operating systems, eg BeOS and HPPA, where undefined | |
1918 | symbols in shared libraries are normal. | |
1919 | ||
1920 | The BeOS kernel for example patches shared libraries at load time to | |
1921 | select whichever function is most appropriate for the current | |
1922 | architecture. This is used, for example, to dynamically select an | |
1923 | appropriate memset function. | |
1924 | @end itemize | |
b79e8c78 | 1925 | |
23ae20f5 NC |
1926 | @kindex --error-handling-script=@var{scriptname} |
1927 | @item --error-handling-script=@var{scriptname} | |
1928 | If this option is provided then the linker will invoke | |
1929 | @var{scriptname} whenever an error is encountered. Currently however | |
1930 | only two kinds of error are supported: missing symbols and missing | |
1931 | libraries. Two arguments will be passed to script: the keyword | |
1932 | ``missing-symbol'' or `missing-lib'' and the @var{name} of the | |
1933 | missing symbol or library. The intention is that the script will | |
1934 | provide suggestions to the user as to where the symbol or library | |
1935 | might be found. After the script has finished then the normal linker | |
1936 | error message will be displayed. | |
1937 | ||
1938 | The availability of this option is controlled by a configure time | |
1939 | switch, so it may not be present in specific implementations. | |
1940 | ||
31941635 L |
1941 | @kindex --no-undefined-version |
1942 | @item --no-undefined-version | |
1943 | Normally when a symbol has an undefined version, the linker will ignore | |
1944 | it. This option disallows symbols with undefined version and a fatal error | |
1945 | will be issued instead. | |
1946 | ||
3e3b46e5 PB |
1947 | @kindex --default-symver |
1948 | @item --default-symver | |
1949 | Create and use a default symbol version (the soname) for unversioned | |
fc0e6df6 PB |
1950 | exported symbols. |
1951 | ||
1952 | @kindex --default-imported-symver | |
1953 | @item --default-imported-symver | |
1954 | Create and use a default symbol version (the soname) for unversioned | |
1955 | imported symbols. | |
3e3b46e5 | 1956 | |
252b5132 RH |
1957 | @kindex --no-warn-mismatch |
1958 | @item --no-warn-mismatch | |
ff5dcc92 | 1959 | Normally @command{ld} will give an error if you try to link together input |
252b5132 RH |
1960 | files that are mismatched for some reason, perhaps because they have |
1961 | been compiled for different processors or for different endiannesses. | |
ff5dcc92 | 1962 | This option tells @command{ld} that it should silently permit such possible |
252b5132 RH |
1963 | errors. This option should only be used with care, in cases when you |
1964 | have taken some special action that ensures that the linker errors are | |
1965 | inappropriate. | |
1966 | ||
fe7929ce AM |
1967 | @kindex --no-warn-search-mismatch |
1968 | @item --no-warn-search-mismatch | |
1969 | Normally @command{ld} will give a warning if it finds an incompatible | |
1970 | library during a library search. This option silences the warning. | |
1971 | ||
252b5132 RH |
1972 | @kindex --no-whole-archive |
1973 | @item --no-whole-archive | |
ff5dcc92 | 1974 | Turn off the effect of the @option{--whole-archive} option for subsequent |
252b5132 RH |
1975 | archive files. |
1976 | ||
1977 | @cindex output file after errors | |
1978 | @kindex --noinhibit-exec | |
1979 | @item --noinhibit-exec | |
1980 | Retain the executable output file whenever it is still usable. | |
1981 | Normally, the linker will not produce an output file if it encounters | |
1982 | errors during the link process; it exits without writing an output file | |
1983 | when it issues any error whatsoever. | |
1984 | ||
0a9c1c8e CD |
1985 | @kindex -nostdlib |
1986 | @item -nostdlib | |
1987 | Only search library directories explicitly specified on the | |
1988 | command line. Library directories specified in linker scripts | |
1989 | (including linker scripts specified on the command line) are ignored. | |
1990 | ||
252b5132 | 1991 | @ifclear SingleFormat |
2509a395 SL |
1992 | @kindex --oformat=@var{output-format} |
1993 | @item --oformat=@var{output-format} | |
ff5dcc92 SC |
1994 | @command{ld} may be configured to support more than one kind of object |
1995 | file. If your @command{ld} is configured this way, you can use the | |
252b5132 | 1996 | @samp{--oformat} option to specify the binary format for the output |
ff5dcc92 SC |
1997 | object file. Even when @command{ld} is configured to support alternative |
1998 | object formats, you don't usually need to specify this, as @command{ld} | |
252b5132 RH |
1999 | should be configured to produce as a default output format the most |
2000 | usual format on each machine. @var{output-format} is a text string, the | |
2001 | name of a particular format supported by the BFD libraries. (You can | |
2002 | list the available binary formats with @samp{objdump -i}.) The script | |
2003 | command @code{OUTPUT_FORMAT} can also specify the output format, but | |
2004 | this option overrides it. @xref{BFD}. | |
2005 | @end ifclear | |
2006 | ||
76359541 TP |
2007 | @kindex --out-implib |
2008 | @item --out-implib @var{file} | |
2009 | Create an import library in @var{file} corresponding to the executable | |
2010 | the linker is generating (eg. a DLL or ELF program). This import | |
2011 | library (which should be called @code{*.dll.a} or @code{*.a} for DLLs) | |
2012 | may be used to link clients against the generated executable; this | |
2013 | behaviour makes it possible to skip a separate import library creation | |
2014 | step (eg. @code{dlltool} for DLLs). This option is only available for | |
2015 | the i386 PE and ELF targetted ports of the linker. | |
2016 | ||
36af4a4e JJ |
2017 | @kindex -pie |
2018 | @kindex --pic-executable | |
2019 | @item -pie | |
2020 | @itemx --pic-executable | |
2021 | @cindex position independent executables | |
2022 | Create a position independent executable. This is currently only supported on | |
2023 | ELF platforms. Position independent executables are similar to shared | |
2024 | libraries in that they are relocated by the dynamic linker to the virtual | |
7e7d5768 | 2025 | address the OS chooses for them (which can vary between invocations). Like |
36af4a4e JJ |
2026 | normal dynamically linked executables they can be executed and symbols |
2027 | defined in the executable cannot be overridden by shared libraries. | |
2028 | ||
252b5132 RH |
2029 | @kindex -qmagic |
2030 | @item -qmagic | |
2031 | This option is ignored for Linux compatibility. | |
2032 | ||
2033 | @kindex -Qy | |
2034 | @item -Qy | |
2035 | This option is ignored for SVR4 compatibility. | |
2036 | ||
2037 | @kindex --relax | |
2038 | @cindex synthesizing linker | |
2039 | @cindex relaxing addressing modes | |
28d5f677 | 2040 | @cindex --no-relax |
252b5132 | 2041 | @item --relax |
28d5f677 | 2042 | @itemx --no-relax |
a1ab1d2a | 2043 | An option with machine dependent effects. |
252b5132 RH |
2044 | @ifset GENERIC |
2045 | This option is only supported on a few targets. | |
2046 | @end ifset | |
2047 | @ifset H8300 | |
ff5dcc92 | 2048 | @xref{H8/300,,@command{ld} and the H8/300}. |
252b5132 | 2049 | @end ifset |
e0001a05 NC |
2050 | @ifset XTENSA |
2051 | @xref{Xtensa,, @command{ld} and Xtensa Processors}. | |
2052 | @end ifset | |
93fd0973 SC |
2053 | @ifset M68HC11 |
2054 | @xref{M68HC11/68HC12,,@command{ld} and the 68HC11 and 68HC12}. | |
2055 | @end ifset | |
78058a5e SL |
2056 | @ifset NIOSII |
2057 | @xref{Nios II,,@command{ld} and the Altera Nios II}. | |
2058 | @end ifset | |
2a60a7a8 AM |
2059 | @ifset POWERPC |
2060 | @xref{PowerPC ELF32,,@command{ld} and PowerPC 32-bit ELF Support}. | |
2061 | @end ifset | |
252b5132 | 2062 | |
ccd9fae5 | 2063 | On some platforms the @option{--relax} option performs target specific, |
28d5f677 NC |
2064 | global optimizations that become possible when the linker resolves |
2065 | addressing in the program, such as relaxing address modes, | |
2066 | synthesizing new instructions, selecting shorter version of current | |
11e7fd74 | 2067 | instructions, and combining constant values. |
252b5132 RH |
2068 | |
2069 | On some platforms these link time global optimizations may make symbolic | |
2070 | debugging of the resulting executable impossible. | |
2071 | @ifset GENERIC | |
28d5f677 NC |
2072 | This is known to be the case for the Matsushita MN10200 and MN10300 |
2073 | family of processors. | |
252b5132 RH |
2074 | @end ifset |
2075 | ||
ccd9fae5 NC |
2076 | On platforms where the feature is supported, the option |
2077 | @option{--no-relax} will disable it. | |
28d5f677 | 2078 | |
ccd9fae5 NC |
2079 | On platforms where the feature is not supported, both @option{--relax} |
2080 | and @option{--no-relax} are accepted, but ignored. | |
2081 | ||
252b5132 RH |
2082 | @cindex retaining specified symbols |
2083 | @cindex stripping all but some symbols | |
2084 | @cindex symbols, retaining selectively | |
2509a395 SL |
2085 | @kindex --retain-symbols-file=@var{filename} |
2086 | @item --retain-symbols-file=@var{filename} | |
252b5132 RH |
2087 | Retain @emph{only} the symbols listed in the file @var{filename}, |
2088 | discarding all others. @var{filename} is simply a flat file, with one | |
2089 | symbol name per line. This option is especially useful in environments | |
2090 | @ifset GENERIC | |
2091 | (such as VxWorks) | |
2092 | @end ifset | |
2093 | where a large global symbol table is accumulated gradually, to conserve | |
2094 | run-time memory. | |
2095 | ||
2096 | @samp{--retain-symbols-file} does @emph{not} discard undefined symbols, | |
2097 | or symbols needed for relocations. | |
2098 | ||
2099 | You may only specify @samp{--retain-symbols-file} once in the command | |
2100 | line. It overrides @samp{-s} and @samp{-S}. | |
2101 | ||
2102 | @ifset GENERIC | |
2509a395 | 2103 | @item -rpath=@var{dir} |
252b5132 | 2104 | @cindex runtime library search path |
2509a395 | 2105 | @kindex -rpath=@var{dir} |
252b5132 | 2106 | Add a directory to the runtime library search path. This is used when |
ff5dcc92 | 2107 | linking an ELF executable with shared objects. All @option{-rpath} |
252b5132 | 2108 | arguments are concatenated and passed to the runtime linker, which uses |
c1b00498 MR |
2109 | them to locate shared objects at runtime. |
2110 | ||
2111 | The @option{-rpath} option is also used when locating shared objects which | |
2112 | are needed by shared objects explicitly included in the link; see the | |
2113 | description of the @option{-rpath-link} option. Searching @option{-rpath} | |
2114 | in this way is only supported by native linkers and cross linkers which | |
2115 | have been configured with the @option{--with-sysroot} option. | |
2116 | ||
2117 | If @option{-rpath} is not used when linking an ELF executable, the | |
2118 | contents of the environment variable @code{LD_RUN_PATH} will be used if it | |
2119 | is defined. | |
252b5132 | 2120 | |
ff5dcc92 | 2121 | The @option{-rpath} option may also be used on SunOS. By default, on |
d8506323 | 2122 | SunOS, the linker will form a runtime search path out of all the |
ff5dcc92 SC |
2123 | @option{-L} options it is given. If a @option{-rpath} option is used, the |
2124 | runtime search path will be formed exclusively using the @option{-rpath} | |
2125 | options, ignoring the @option{-L} options. This can be useful when using | |
2126 | gcc, which adds many @option{-L} options which may be on NFS mounted | |
b45619c0 | 2127 | file systems. |
252b5132 | 2128 | |
ff5dcc92 | 2129 | For compatibility with other ELF linkers, if the @option{-R} option is |
252b5132 | 2130 | followed by a directory name, rather than a file name, it is treated as |
ff5dcc92 | 2131 | the @option{-rpath} option. |
252b5132 RH |
2132 | @end ifset |
2133 | ||
2134 | @ifset GENERIC | |
2135 | @cindex link-time runtime library search path | |
2509a395 SL |
2136 | @kindex -rpath-link=@var{dir} |
2137 | @item -rpath-link=@var{dir} | |
252b5132 RH |
2138 | When using ELF or SunOS, one shared library may require another. This |
2139 | happens when an @code{ld -shared} link includes a shared library as one | |
2140 | of the input files. | |
2141 | ||
2142 | When the linker encounters such a dependency when doing a non-shared, | |
2143 | non-relocatable link, it will automatically try to locate the required | |
2144 | shared library and include it in the link, if it is not included | |
ff5dcc92 | 2145 | explicitly. In such a case, the @option{-rpath-link} option |
252b5132 | 2146 | specifies the first set of directories to search. The |
ff5dcc92 | 2147 | @option{-rpath-link} option may specify a sequence of directory names |
252b5132 RH |
2148 | either by specifying a list of names separated by colons, or by |
2149 | appearing multiple times. | |
2150 | ||
e680a6b6 NC |
2151 | The tokens @var{$ORIGIN} and @var{$LIB} can appear in these search |
2152 | directories. They will be replaced by the full path to the directory | |
2153 | containing the program or shared object in the case of @var{$ORIGIN} | |
2154 | and either @samp{lib} - for 32-bit binaries - or @samp{lib64} - for | |
2155 | 64-bit binaries - in the case of @var{$LIB}. | |
2156 | ||
2157 | The alternative form of these tokens - @var{$@{ORIGIN@}} and | |
2158 | @var{$@{LIB@}} can also be used. The token @var{$PLATFORM} is not | |
2159 | supported. | |
2160 | ||
28c309a2 NC |
2161 | This option should be used with caution as it overrides the search path |
2162 | that may have been hard compiled into a shared library. In such a case it | |
2163 | is possible to use unintentionally a different search path than the | |
2164 | runtime linker would do. | |
2165 | ||
252b5132 | 2166 | The linker uses the following search paths to locate required shared |
ece2d90e | 2167 | libraries: |
d8e4137b | 2168 | |
252b5132 RH |
2169 | @enumerate |
2170 | @item | |
ff5dcc92 | 2171 | Any directories specified by @option{-rpath-link} options. |
252b5132 | 2172 | @item |
ff5dcc92 SC |
2173 | Any directories specified by @option{-rpath} options. The difference |
2174 | between @option{-rpath} and @option{-rpath-link} is that directories | |
2175 | specified by @option{-rpath} options are included in the executable and | |
2176 | used at runtime, whereas the @option{-rpath-link} option is only effective | |
ece2d90e NC |
2177 | at link time. Searching @option{-rpath} in this way is only supported |
2178 | by native linkers and cross linkers which have been configured with | |
2179 | the @option{--with-sysroot} option. | |
252b5132 | 2180 | @item |
e2a83dd0 NC |
2181 | On an ELF system, for native linkers, if the @option{-rpath} and |
2182 | @option{-rpath-link} options were not used, search the contents of the | |
2183 | environment variable @code{LD_RUN_PATH}. | |
252b5132 | 2184 | @item |
ff5dcc92 SC |
2185 | On SunOS, if the @option{-rpath} option was not used, search any |
2186 | directories specified using @option{-L} options. | |
252b5132 | 2187 | @item |
a1b8d843 | 2188 | For a native linker, search the contents of the environment |
e2a83dd0 | 2189 | variable @code{LD_LIBRARY_PATH}. |
252b5132 | 2190 | @item |
ec4eb78a L |
2191 | For a native ELF linker, the directories in @code{DT_RUNPATH} or |
2192 | @code{DT_RPATH} of a shared library are searched for shared | |
2193 | libraries needed by it. The @code{DT_RPATH} entries are ignored if | |
2194 | @code{DT_RUNPATH} entries exist. | |
2195 | @item | |
252b5132 RH |
2196 | The default directories, normally @file{/lib} and @file{/usr/lib}. |
2197 | @item | |
d8e4137b NC |
2198 | For a linker for a Linux system, if the file @file{/etc/ld.so.conf} |
2199 | exists, the list of directories found in that file. Note: the path | |
2200 | to this file is prefixed with the @code{sysroot} value, if that is | |
2201 | defined, and then any @code{prefix} string if the linker was | |
2202 | configured with the @command{--prefix=<path>} option. | |
2203 | @item | |
2204 | For a native linker on a FreeBSD system, any directories specified by | |
2205 | the @code{_PATH_ELF_HINTS} macro defined in the @file{elf-hints.h} | |
2206 | header file. | |
2207 | @item | |
2208 | Any directories specifed by a @code{SEARCH_DIR} command in the | |
2209 | linker script being used. | |
252b5132 RH |
2210 | @end enumerate |
2211 | ||
2212 | If the required shared library is not found, the linker will issue a | |
2213 | warning and continue with the link. | |
2214 | @end ifset | |
2215 | ||
2216 | @kindex -shared | |
2217 | @kindex -Bshareable | |
2218 | @item -shared | |
2219 | @itemx -Bshareable | |
2220 | @cindex shared libraries | |
2221 | Create a shared library. This is currently only supported on ELF, XCOFF | |
2222 | and SunOS platforms. On SunOS, the linker will automatically create a | |
ff5dcc92 | 2223 | shared library if the @option{-e} option is not used and there are |
252b5132 RH |
2224 | undefined symbols in the link. |
2225 | ||
252b5132 | 2226 | @kindex --sort-common |
2509a395 SL |
2227 | @item --sort-common |
2228 | @itemx --sort-common=ascending | |
2229 | @itemx --sort-common=descending | |
de7dd2bd NC |
2230 | This option tells @command{ld} to sort the common symbols by alignment in |
2231 | ascending or descending order when it places them in the appropriate output | |
2232 | sections. The symbol alignments considered are sixteen-byte or larger, | |
2233 | eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps | |
2234 | between symbols due to alignment constraints. If no sorting order is | |
2235 | specified, then descending order is assumed. | |
252b5132 | 2236 | |
2509a395 SL |
2237 | @kindex --sort-section=name |
2238 | @item --sort-section=name | |
bcaa7b3e L |
2239 | This option will apply @code{SORT_BY_NAME} to all wildcard section |
2240 | patterns in the linker script. | |
2241 | ||
2509a395 SL |
2242 | @kindex --sort-section=alignment |
2243 | @item --sort-section=alignment | |
bcaa7b3e L |
2244 | This option will apply @code{SORT_BY_ALIGNMENT} to all wildcard section |
2245 | patterns in the linker script. | |
2246 | ||
a70f34c0 NC |
2247 | @kindex --spare-dynamic-tags |
2248 | @item --spare-dynamic-tags=@var{count} | |
2249 | This option specifies the number of empty slots to leave in the | |
2250 | .dynamic section of ELF shared objects. Empty slots may be needed by | |
2251 | post processing tools, such as the prelinker. The default is 5. | |
2252 | ||
252b5132 | 2253 | @kindex --split-by-file |
2509a395 | 2254 | @item --split-by-file[=@var{size}] |
ff5dcc92 | 2255 | Similar to @option{--split-by-reloc} but creates a new output section for |
a854a4a7 AM |
2256 | each input file when @var{size} is reached. @var{size} defaults to a |
2257 | size of 1 if not given. | |
252b5132 RH |
2258 | |
2259 | @kindex --split-by-reloc | |
2509a395 | 2260 | @item --split-by-reloc[=@var{count}] |
a854a4a7 | 2261 | Tries to creates extra sections in the output file so that no single |
252b5132 | 2262 | output section in the file contains more than @var{count} relocations. |
a854a4a7 | 2263 | This is useful when generating huge relocatable files for downloading into |
252b5132 RH |
2264 | certain real time kernels with the COFF object file format; since COFF |
2265 | cannot represent more than 65535 relocations in a single section. Note | |
2266 | that this will fail to work with object file formats which do not | |
2267 | support arbitrary sections. The linker will not split up individual | |
2268 | input sections for redistribution, so if a single input section contains | |
2269 | more than @var{count} relocations one output section will contain that | |
a854a4a7 | 2270 | many relocations. @var{count} defaults to a value of 32768. |
252b5132 RH |
2271 | |
2272 | @kindex --stats | |
2273 | @item --stats | |
2274 | Compute and display statistics about the operation of the linker, such | |
2275 | as execution time and memory usage. | |
2276 | ||
2509a395 | 2277 | @kindex --sysroot=@var{directory} |
e2243057 RS |
2278 | @item --sysroot=@var{directory} |
2279 | Use @var{directory} as the location of the sysroot, overriding the | |
2280 | configure-time default. This option is only supported by linkers | |
2281 | that were configured using @option{--with-sysroot}. | |
2282 | ||
a70f34c0 NC |
2283 | @kindex --task-link |
2284 | @item --task-link | |
2285 | This is used by COFF/PE based targets to create a task-linked object | |
2286 | file where all of the global symbols have been converted to statics. | |
2287 | ||
252b5132 RH |
2288 | @kindex --traditional-format |
2289 | @cindex traditional format | |
2290 | @item --traditional-format | |
ff5dcc92 SC |
2291 | For some targets, the output of @command{ld} is different in some ways from |
2292 | the output of some existing linker. This switch requests @command{ld} to | |
252b5132 RH |
2293 | use the traditional format instead. |
2294 | ||
2295 | @cindex dbx | |
ff5dcc92 | 2296 | For example, on SunOS, @command{ld} combines duplicate entries in the |
252b5132 RH |
2297 | symbol string table. This can reduce the size of an output file with |
2298 | full debugging information by over 30 percent. Unfortunately, the SunOS | |
2299 | @code{dbx} program can not read the resulting program (@code{gdb} has no | |
ff5dcc92 | 2300 | trouble). The @samp{--traditional-format} switch tells @command{ld} to not |
252b5132 RH |
2301 | combine duplicate entries. |
2302 | ||
2509a395 SL |
2303 | @kindex --section-start=@var{sectionname}=@var{org} |
2304 | @item --section-start=@var{sectionname}=@var{org} | |
176355da NC |
2305 | Locate a section in the output file at the absolute |
2306 | address given by @var{org}. You may use this option as many | |
2307 | times as necessary to locate multiple sections in the command | |
2308 | line. | |
2309 | @var{org} must be a single hexadecimal integer; | |
2310 | for compatibility with other linkers, you may omit the leading | |
2311 | @samp{0x} usually associated with hexadecimal values. @emph{Note:} there | |
2312 | should be no white space between @var{sectionname}, the equals | |
2313 | sign (``@key{=}''), and @var{org}. | |
2314 | ||
2509a395 SL |
2315 | @kindex -Tbss=@var{org} |
2316 | @kindex -Tdata=@var{org} | |
2317 | @kindex -Ttext=@var{org} | |
252b5132 | 2318 | @cindex segment origins, cmd line |
2509a395 SL |
2319 | @item -Tbss=@var{org} |
2320 | @itemx -Tdata=@var{org} | |
2321 | @itemx -Ttext=@var{org} | |
2322 | Same as @option{--section-start}, with @code{.bss}, @code{.data} or | |
a6e02871 | 2323 | @code{.text} as the @var{sectionname}. |
252b5132 | 2324 | |
2509a395 SL |
2325 | @kindex -Ttext-segment=@var{org} |
2326 | @item -Ttext-segment=@var{org} | |
258795f5 | 2327 | @cindex text segment origin, cmd line |
2b8c06a3 L |
2328 | When creating an ELF executable, it will set the address of the first |
2329 | byte of the text segment. | |
258795f5 | 2330 | |
9d5777a3 RM |
2331 | @kindex -Trodata-segment=@var{org} |
2332 | @item -Trodata-segment=@var{org} | |
2333 | @cindex rodata segment origin, cmd line | |
2334 | When creating an ELF executable or shared object for a target where | |
2335 | the read-only data is in its own segment separate from the executable | |
2336 | text, it will set the address of the first byte of the read-only data segment. | |
2337 | ||
0d705e9f AM |
2338 | @kindex -Tldata-segment=@var{org} |
2339 | @item -Tldata-segment=@var{org} | |
2340 | @cindex ldata segment origin, cmd line | |
2341 | When creating an ELF executable or shared object for x86-64 medium memory | |
2342 | model, it will set the address of the first byte of the ldata segment. | |
2343 | ||
560e09e9 NC |
2344 | @kindex --unresolved-symbols |
2345 | @item --unresolved-symbols=@var{method} | |
2346 | Determine how to handle unresolved symbols. There are four possible | |
2347 | values for @samp{method}: | |
2348 | ||
2349 | @table @samp | |
2350 | @item ignore-all | |
da8bce14 | 2351 | Do not report any unresolved symbols. |
560e09e9 NC |
2352 | |
2353 | @item report-all | |
da8bce14 | 2354 | Report all unresolved symbols. This is the default. |
560e09e9 NC |
2355 | |
2356 | @item ignore-in-object-files | |
2357 | Report unresolved symbols that are contained in shared libraries, but | |
2358 | ignore them if they come from regular object files. | |
2359 | ||
2360 | @item ignore-in-shared-libs | |
2361 | Report unresolved symbols that come from regular object files, but | |
2362 | ignore them if they come from shared libraries. This can be useful | |
2363 | when creating a dynamic binary and it is known that all the shared | |
2364 | libraries that it should be referencing are included on the linker's | |
2365 | command line. | |
2366 | @end table | |
2367 | ||
2368 | The behaviour for shared libraries on their own can also be controlled | |
2369 | by the @option{--[no-]allow-shlib-undefined} option. | |
2370 | ||
2371 | Normally the linker will generate an error message for each reported | |
2372 | unresolved symbol but the option @option{--warn-unresolved-symbols} | |
2373 | can change this to a warning. | |
2374 | ||
1715a13c L |
2375 | @kindex --verbose[=@var{NUMBER}] |
2376 | @cindex verbose[=@var{NUMBER}] | |
252b5132 | 2377 | @item --dll-verbose |
1715a13c | 2378 | @itemx --verbose[=@var{NUMBER}] |
ff5dcc92 | 2379 | Display the version number for @command{ld} and list the linker emulations |
252b5132 | 2380 | supported. Display which input files can and cannot be opened. Display |
1715a13c L |
2381 | the linker script being used by the linker. If the optional @var{NUMBER} |
2382 | argument > 1, plugin symbol status will also be displayed. | |
252b5132 RH |
2383 | |
2384 | @kindex --version-script=@var{version-scriptfile} | |
2385 | @cindex version script, symbol versions | |
2509a395 | 2386 | @item --version-script=@var{version-scriptfile} |
252b5132 RH |
2387 | Specify the name of a version script to the linker. This is typically |
2388 | used when creating shared libraries to specify additional information | |
36f63dca | 2389 | about the version hierarchy for the library being created. This option |
09e2aba4 DK |
2390 | is only fully supported on ELF platforms which support shared libraries; |
2391 | see @ref{VERSION}. It is partially supported on PE platforms, which can | |
2392 | use version scripts to filter symbol visibility in auto-export mode: any | |
2393 | symbols marked @samp{local} in the version script will not be exported. | |
2394 | @xref{WIN32}. | |
252b5132 | 2395 | |
7ce691ae | 2396 | @kindex --warn-common |
252b5132 RH |
2397 | @cindex warnings, on combining symbols |
2398 | @cindex combining symbols, warnings on | |
2399 | @item --warn-common | |
2400 | Warn when a common symbol is combined with another common symbol or with | |
11e7fd74 | 2401 | a symbol definition. Unix linkers allow this somewhat sloppy practice, |
252b5132 RH |
2402 | but linkers on some other operating systems do not. This option allows |
2403 | you to find potential problems from combining global symbols. | |
11e7fd74 | 2404 | Unfortunately, some C libraries use this practice, so you may get some |
252b5132 RH |
2405 | warnings about symbols in the libraries as well as in your programs. |
2406 | ||
2407 | There are three kinds of global symbols, illustrated here by C examples: | |
2408 | ||
2409 | @table @samp | |
2410 | @item int i = 1; | |
2411 | A definition, which goes in the initialized data section of the output | |
2412 | file. | |
2413 | ||
2414 | @item extern int i; | |
2415 | An undefined reference, which does not allocate space. | |
2416 | There must be either a definition or a common symbol for the | |
2417 | variable somewhere. | |
2418 | ||
2419 | @item int i; | |
2420 | A common symbol. If there are only (one or more) common symbols for a | |
2421 | variable, it goes in the uninitialized data area of the output file. | |
2422 | The linker merges multiple common symbols for the same variable into a | |
2423 | single symbol. If they are of different sizes, it picks the largest | |
2424 | size. The linker turns a common symbol into a declaration, if there is | |
2425 | a definition of the same variable. | |
2426 | @end table | |
2427 | ||
2428 | The @samp{--warn-common} option can produce five kinds of warnings. | |
2429 | Each warning consists of a pair of lines: the first describes the symbol | |
2430 | just encountered, and the second describes the previous symbol | |
2431 | encountered with the same name. One or both of the two symbols will be | |
2432 | a common symbol. | |
2433 | ||
2434 | @enumerate | |
2435 | @item | |
2436 | Turning a common symbol into a reference, because there is already a | |
2437 | definition for the symbol. | |
2438 | @smallexample | |
2439 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2440 | overridden by definition | |
2441 | @var{file}(@var{section}): warning: defined here | |
2442 | @end smallexample | |
2443 | ||
2444 | @item | |
2445 | Turning a common symbol into a reference, because a later definition for | |
2446 | the symbol is encountered. This is the same as the previous case, | |
2447 | except that the symbols are encountered in a different order. | |
2448 | @smallexample | |
2449 | @var{file}(@var{section}): warning: definition of `@var{symbol}' | |
2450 | overriding common | |
2451 | @var{file}(@var{section}): warning: common is here | |
2452 | @end smallexample | |
2453 | ||
2454 | @item | |
2455 | Merging a common symbol with a previous same-sized common symbol. | |
2456 | @smallexample | |
2457 | @var{file}(@var{section}): warning: multiple common | |
2458 | of `@var{symbol}' | |
2459 | @var{file}(@var{section}): warning: previous common is here | |
2460 | @end smallexample | |
2461 | ||
2462 | @item | |
2463 | Merging a common symbol with a previous larger common symbol. | |
2464 | @smallexample | |
2465 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2466 | overridden by larger common | |
2467 | @var{file}(@var{section}): warning: larger common is here | |
2468 | @end smallexample | |
2469 | ||
2470 | @item | |
2471 | Merging a common symbol with a previous smaller common symbol. This is | |
2472 | the same as the previous case, except that the symbols are | |
2473 | encountered in a different order. | |
2474 | @smallexample | |
2475 | @var{file}(@var{section}): warning: common of `@var{symbol}' | |
2476 | overriding smaller common | |
2477 | @var{file}(@var{section}): warning: smaller common is here | |
2478 | @end smallexample | |
2479 | @end enumerate | |
2480 | ||
2481 | @kindex --warn-constructors | |
2482 | @item --warn-constructors | |
2483 | Warn if any global constructors are used. This is only useful for a few | |
2484 | object file formats. For formats like COFF or ELF, the linker can not | |
2485 | detect the use of global constructors. | |
2486 | ||
2487 | @kindex --warn-multiple-gp | |
2488 | @item --warn-multiple-gp | |
2489 | Warn if multiple global pointer values are required in the output file. | |
2490 | This is only meaningful for certain processors, such as the Alpha. | |
2491 | Specifically, some processors put large-valued constants in a special | |
2492 | section. A special register (the global pointer) points into the middle | |
2493 | of this section, so that constants can be loaded efficiently via a | |
2494 | base-register relative addressing mode. Since the offset in | |
2495 | base-register relative mode is fixed and relatively small (e.g., 16 | |
2496 | bits), this limits the maximum size of the constant pool. Thus, in | |
2497 | large programs, it is often necessary to use multiple global pointer | |
2498 | values in order to be able to address all possible constants. This | |
2499 | option causes a warning to be issued whenever this case occurs. | |
2500 | ||
2501 | @kindex --warn-once | |
2502 | @cindex warnings, on undefined symbols | |
2503 | @cindex undefined symbols, warnings on | |
2504 | @item --warn-once | |
2505 | Only warn once for each undefined symbol, rather than once per module | |
2506 | which refers to it. | |
2507 | ||
2508 | @kindex --warn-section-align | |
2509 | @cindex warnings, on section alignment | |
2510 | @cindex section alignment, warnings on | |
2511 | @item --warn-section-align | |
2512 | Warn if the address of an output section is changed because of | |
2513 | alignment. Typically, the alignment will be set by an input section. | |
2514 | The address will only be changed if it not explicitly specified; that | |
2515 | is, if the @code{SECTIONS} command does not specify a start address for | |
2516 | the section (@pxref{SECTIONS}). | |
2517 | ||
a6dbf402 L |
2518 | @kindex --warn-textrel |
2519 | @item --warn-textrel | |
2520 | Warn if the linker adds DT_TEXTREL to a position-independent executable | |
2521 | or shared object. | |
8fdd7217 | 2522 | |
a0c402a5 L |
2523 | @kindex --warn-alternate-em |
2524 | @item --warn-alternate-em | |
2525 | Warn if an object has alternate ELF machine code. | |
2526 | ||
560e09e9 NC |
2527 | @kindex --warn-unresolved-symbols |
2528 | @item --warn-unresolved-symbols | |
2529 | If the linker is going to report an unresolved symbol (see the option | |
2530 | @option{--unresolved-symbols}) it will normally generate an error. | |
2531 | This option makes it generate a warning instead. | |
2532 | ||
2533 | @kindex --error-unresolved-symbols | |
2534 | @item --error-unresolved-symbols | |
2535 | This restores the linker's default behaviour of generating errors when | |
2536 | it is reporting unresolved symbols. | |
2537 | ||
252b5132 RH |
2538 | @kindex --whole-archive |
2539 | @cindex including an entire archive | |
2540 | @item --whole-archive | |
2541 | For each archive mentioned on the command line after the | |
ff5dcc92 | 2542 | @option{--whole-archive} option, include every object file in the archive |
252b5132 RH |
2543 | in the link, rather than searching the archive for the required object |
2544 | files. This is normally used to turn an archive file into a shared | |
2545 | library, forcing every object to be included in the resulting shared | |
2546 | library. This option may be used more than once. | |
2547 | ||
7ec229ce | 2548 | Two notes when using this option from gcc: First, gcc doesn't know |
ff5dcc92 SC |
2549 | about this option, so you have to use @option{-Wl,-whole-archive}. |
2550 | Second, don't forget to use @option{-Wl,-no-whole-archive} after your | |
7ec229ce DD |
2551 | list of archives, because gcc will add its own list of archives to |
2552 | your link and you may not want this flag to affect those as well. | |
2553 | ||
2509a395 SL |
2554 | @kindex --wrap=@var{symbol} |
2555 | @item --wrap=@var{symbol} | |
252b5132 RH |
2556 | Use a wrapper function for @var{symbol}. Any undefined reference to |
2557 | @var{symbol} will be resolved to @code{__wrap_@var{symbol}}. Any | |
2558 | undefined reference to @code{__real_@var{symbol}} will be resolved to | |
2559 | @var{symbol}. | |
2560 | ||
2561 | This can be used to provide a wrapper for a system function. The | |
2562 | wrapper function should be called @code{__wrap_@var{symbol}}. If it | |
2563 | wishes to call the system function, it should call | |
2564 | @code{__real_@var{symbol}}. | |
2565 | ||
2566 | Here is a trivial example: | |
2567 | ||
2568 | @smallexample | |
2569 | void * | |
cc2f008e | 2570 | __wrap_malloc (size_t c) |
252b5132 | 2571 | @{ |
cc2f008e | 2572 | printf ("malloc called with %zu\n", c); |
252b5132 RH |
2573 | return __real_malloc (c); |
2574 | @} | |
2575 | @end smallexample | |
2576 | ||
ff5dcc92 | 2577 | If you link other code with this file using @option{--wrap malloc}, then |
252b5132 RH |
2578 | all calls to @code{malloc} will call the function @code{__wrap_malloc} |
2579 | instead. The call to @code{__real_malloc} in @code{__wrap_malloc} will | |
2580 | call the real @code{malloc} function. | |
2581 | ||
2582 | You may wish to provide a @code{__real_malloc} function as well, so that | |
ff5dcc92 | 2583 | links without the @option{--wrap} option will succeed. If you do this, |
252b5132 RH |
2584 | you should not put the definition of @code{__real_malloc} in the same |
2585 | file as @code{__wrap_malloc}; if you do, the assembler may resolve the | |
2586 | call before the linker has a chance to wrap it to @code{malloc}. | |
2587 | ||
4ea904ed SH |
2588 | Only undefined references are replaced by the linker. So, translation unit |
2589 | internal references to @var{symbol} are not resolved to | |
2590 | @code{__wrap_@var{symbol}}. In the next example, the call to @code{f} in | |
2591 | @code{g} is not resolved to @code{__wrap_f}. | |
2592 | ||
2593 | @smallexample | |
2594 | int | |
2595 | f (void) | |
2596 | @{ | |
2597 | return 123; | |
2598 | @} | |
2599 | ||
2600 | int | |
2601 | g (void) | |
2602 | @{ | |
2603 | return f(); | |
2604 | @} | |
2605 | @end smallexample | |
2606 | ||
6aa29e7b | 2607 | @kindex --eh-frame-hdr |
29063f8b | 2608 | @kindex --no-eh-frame-hdr |
6aa29e7b | 2609 | @item --eh-frame-hdr |
29063f8b NC |
2610 | @itemx --no-eh-frame-hdr |
2611 | Request (@option{--eh-frame-hdr}) or suppress | |
2612 | (@option{--no-eh-frame-hdr}) the creation of @code{.eh_frame_hdr} | |
2613 | section and ELF @code{PT_GNU_EH_FRAME} segment header. | |
6aa29e7b | 2614 | |
e41b3a13 JJ |
2615 | @kindex --ld-generated-unwind-info |
2616 | @item --no-ld-generated-unwind-info | |
2617 | Request creation of @code{.eh_frame} unwind info for linker | |
2618 | generated code sections like PLT. This option is on by default | |
2619 | if linker generated unwind info is supported. | |
2620 | ||
6c1439be L |
2621 | @kindex --enable-new-dtags |
2622 | @kindex --disable-new-dtags | |
2623 | @item --enable-new-dtags | |
2624 | @itemx --disable-new-dtags | |
2625 | This linker can create the new dynamic tags in ELF. But the older ELF | |
2626 | systems may not understand them. If you specify | |
b1b00fcc MF |
2627 | @option{--enable-new-dtags}, the new dynamic tags will be created as needed |
2628 | and older dynamic tags will be omitted. | |
ff5dcc92 | 2629 | If you specify @option{--disable-new-dtags}, no new dynamic tags will be |
6c1439be L |
2630 | created. By default, the new dynamic tags are not created. Note that |
2631 | those options are only available for ELF systems. | |
2632 | ||
2d643429 | 2633 | @kindex --hash-size=@var{number} |
e185dd51 | 2634 | @item --hash-size=@var{number} |
2d643429 NC |
2635 | Set the default size of the linker's hash tables to a prime number |
2636 | close to @var{number}. Increasing this value can reduce the length of | |
2637 | time it takes the linker to perform its tasks, at the expense of | |
2638 | increasing the linker's memory requirements. Similarly reducing this | |
2639 | value can reduce the memory requirements at the expense of speed. | |
2640 | ||
fdc90cb4 JJ |
2641 | @kindex --hash-style=@var{style} |
2642 | @item --hash-style=@var{style} | |
2643 | Set the type of linker's hash table(s). @var{style} can be either | |
2644 | @code{sysv} for classic ELF @code{.hash} section, @code{gnu} for | |
2645 | new style GNU @code{.gnu.hash} section or @code{both} for both | |
2646 | the classic ELF @code{.hash} and new style GNU @code{.gnu.hash} | |
c8455dc9 NC |
2647 | hash tables. The default depends upon how the linker was configured, |
2648 | but for most Linux based systems it will be @code{both}. | |
fdc90cb4 | 2649 | |
0ce398f1 L |
2650 | @kindex --compress-debug-sections=none |
2651 | @kindex --compress-debug-sections=zlib | |
2652 | @kindex --compress-debug-sections=zlib-gnu | |
2653 | @kindex --compress-debug-sections=zlib-gabi | |
2654 | @item --compress-debug-sections=none | |
2655 | @itemx --compress-debug-sections=zlib | |
2656 | @itemx --compress-debug-sections=zlib-gnu | |
2657 | @itemx --compress-debug-sections=zlib-gabi | |
9af89fba NC |
2658 | On ELF platforms, these options control how DWARF debug sections are |
2659 | compressed using zlib. | |
2660 | ||
2661 | @option{--compress-debug-sections=none} doesn't compress DWARF debug | |
2662 | sections. @option{--compress-debug-sections=zlib-gnu} compresses | |
2663 | DWARF debug sections and renames them to begin with @samp{.zdebug} | |
2664 | instead of @samp{.debug}. @option{--compress-debug-sections=zlib-gabi} | |
2665 | also compresses DWARF debug sections, but rather than renaming them it | |
2666 | sets the SHF_COMPRESSED flag in the sections' headers. | |
2667 | ||
2668 | The @option{--compress-debug-sections=zlib} option is an alias for | |
2669 | @option{--compress-debug-sections=zlib-gabi}. | |
2670 | ||
2671 | Note that this option overrides any compression in input debug | |
2672 | sections, so if a binary is linked with @option{--compress-debug-sections=none} | |
2673 | for example, then any compressed debug sections in input files will be | |
2674 | uncompressed before they are copied into the output binary. | |
2675 | ||
2676 | The default compression behaviour varies depending upon the target | |
2677 | involved and the configure options used to build the toolchain. The | |
2678 | default can be determined by examining the output from the linker's | |
2679 | @option{--help} option. | |
0ce398f1 | 2680 | |
35835446 JR |
2681 | @kindex --reduce-memory-overheads |
2682 | @item --reduce-memory-overheads | |
2683 | This option reduces memory requirements at ld runtime, at the expense of | |
f2a8f148 | 2684 | linking speed. This was introduced to select the old O(n^2) algorithm |
35835446 | 2685 | for link map file generation, rather than the new O(n) algorithm which uses |
2d643429 NC |
2686 | about 40% more memory for symbol storage. |
2687 | ||
4f9c04f7 | 2688 | Another effect of the switch is to set the default hash table size to |
2d643429 | 2689 | 1021, which again saves memory at the cost of lengthening the linker's |
a85785bc | 2690 | run time. This is not done however if the @option{--hash-size} switch |
2d643429 NC |
2691 | has been used. |
2692 | ||
2693 | The @option{--reduce-memory-overheads} switch may be also be used to | |
2694 | enable other tradeoffs in future versions of the linker. | |
35835446 | 2695 | |
c0065db7 RM |
2696 | @kindex --build-id |
2697 | @kindex --build-id=@var{style} | |
2698 | @item --build-id | |
2699 | @itemx --build-id=@var{style} | |
61e2488c | 2700 | Request the creation of a @code{.note.gnu.build-id} ELF note section |
6033bf41 | 2701 | or a @code{.buildid} COFF section. The contents of the note are |
61e2488c JT |
2702 | unique bits identifying this linked file. @var{style} can be |
2703 | @code{uuid} to use 128 random bits, @code{sha1} to use a 160-bit | |
2704 | @sc{SHA1} hash on the normative parts of the output contents, | |
2705 | @code{md5} to use a 128-bit @sc{MD5} hash on the normative parts of | |
2706 | the output contents, or @code{0x@var{hexstring}} to use a chosen bit | |
2707 | string specified as an even number of hexadecimal digits (@code{-} and | |
2708 | @code{:} characters between digit pairs are ignored). If @var{style} | |
2709 | is omitted, @code{sha1} is used. | |
24382dca RM |
2710 | |
2711 | The @code{md5} and @code{sha1} styles produces an identifier | |
2712 | that is always the same in an identical output file, but will be | |
2713 | unique among all nonidentical output files. It is not intended | |
2714 | to be compared as a checksum for the file's contents. A linked | |
2715 | file may be changed later by other tools, but the build ID bit | |
2716 | string identifying the original linked file does not change. | |
c0065db7 RM |
2717 | |
2718 | Passing @code{none} for @var{style} disables the setting from any | |
2719 | @code{--build-id} options earlier on the command line. | |
252b5132 RH |
2720 | @end table |
2721 | ||
0285c67d NC |
2722 | @c man end |
2723 | ||
36f63dca | 2724 | @subsection Options Specific to i386 PE Targets |
252b5132 | 2725 | |
0285c67d NC |
2726 | @c man begin OPTIONS |
2727 | ||
ff5dcc92 | 2728 | The i386 PE linker supports the @option{-shared} option, which causes |
252b5132 RH |
2729 | the output to be a dynamically linked library (DLL) instead of a |
2730 | normal executable. You should name the output @code{*.dll} when you | |
2731 | use this option. In addition, the linker fully supports the standard | |
2732 | @code{*.def} files, which may be specified on the linker command line | |
2733 | like an object file (in fact, it should precede archives it exports | |
2734 | symbols from, to ensure that they get linked in, just like a normal | |
2735 | object file). | |
2736 | ||
2737 | In addition to the options common to all targets, the i386 PE linker | |
a05a5b64 | 2738 | support additional command-line options that are specific to the i386 |
252b5132 RH |
2739 | PE target. Options that take values may be separated from their |
2740 | values by either a space or an equals sign. | |
2741 | ||
ff5dcc92 | 2742 | @table @gcctabopt |
252b5132 RH |
2743 | |
2744 | @kindex --add-stdcall-alias | |
2745 | @item --add-stdcall-alias | |
2746 | If given, symbols with a stdcall suffix (@@@var{nn}) will be exported | |
2747 | as-is and also with the suffix stripped. | |
bb10df36 | 2748 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2749 | |
2750 | @kindex --base-file | |
2751 | @item --base-file @var{file} | |
2752 | Use @var{file} as the name of a file in which to save the base | |
2753 | addresses of all the relocations needed for generating DLLs with | |
2754 | @file{dlltool}. | |
bb10df36 | 2755 | [This is an i386 PE specific option] |
252b5132 RH |
2756 | |
2757 | @kindex --dll | |
2758 | @item --dll | |
2759 | Create a DLL instead of a regular executable. You may also use | |
ff5dcc92 | 2760 | @option{-shared} or specify a @code{LIBRARY} in a given @code{.def} |
252b5132 | 2761 | file. |
bb10df36 | 2762 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2763 | |
88183869 DK |
2764 | @kindex --enable-long-section-names |
2765 | @kindex --disable-long-section-names | |
2766 | @item --enable-long-section-names | |
2767 | @itemx --disable-long-section-names | |
56e6cf80 | 2768 | The PE variants of the COFF object format add an extension that permits |
88183869 | 2769 | the use of section names longer than eight characters, the normal limit |
56e6cf80 NC |
2770 | for COFF. By default, these names are only allowed in object files, as |
2771 | fully-linked executable images do not carry the COFF string table required | |
88183869 DK |
2772 | to support the longer names. As a GNU extension, it is possible to |
2773 | allow their use in executable images as well, or to (probably pointlessly!) | |
2774 | disallow it in object files, by using these two options. Executable images | |
2775 | generated with these long section names are slightly non-standard, carrying | |
2776 | as they do a string table, and may generate confusing output when examined | |
9d5777a3 RM |
2777 | with non-GNU PE-aware tools, such as file viewers and dumpers. However, |
2778 | GDB relies on the use of PE long section names to find Dwarf-2 debug | |
3efd345c DK |
2779 | information sections in an executable image at runtime, and so if neither |
2780 | option is specified on the command-line, @command{ld} will enable long | |
2781 | section names, overriding the default and technically correct behaviour, | |
2782 | when it finds the presence of debug information while linking an executable | |
2783 | image and not stripping symbols. | |
88183869 DK |
2784 | [This option is valid for all PE targeted ports of the linker] |
2785 | ||
252b5132 RH |
2786 | @kindex --enable-stdcall-fixup |
2787 | @kindex --disable-stdcall-fixup | |
2788 | @item --enable-stdcall-fixup | |
2789 | @itemx --disable-stdcall-fixup | |
2790 | If the link finds a symbol that it cannot resolve, it will attempt to | |
36f63dca | 2791 | do ``fuzzy linking'' by looking for another defined symbol that differs |
252b5132 RH |
2792 | only in the format of the symbol name (cdecl vs stdcall) and will |
2793 | resolve that symbol by linking to the match. For example, the | |
2794 | undefined symbol @code{_foo} might be linked to the function | |
2795 | @code{_foo@@12}, or the undefined symbol @code{_bar@@16} might be linked | |
2796 | to the function @code{_bar}. When the linker does this, it prints a | |
2797 | warning, since it normally should have failed to link, but sometimes | |
2798 | import libraries generated from third-party dlls may need this feature | |
ff5dcc92 | 2799 | to be usable. If you specify @option{--enable-stdcall-fixup}, this |
252b5132 | 2800 | feature is fully enabled and warnings are not printed. If you specify |
ff5dcc92 | 2801 | @option{--disable-stdcall-fixup}, this feature is disabled and such |
252b5132 | 2802 | mismatches are considered to be errors. |
bb10df36 | 2803 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2804 | |
522f09cd KT |
2805 | @kindex --leading-underscore |
2806 | @kindex --no-leading-underscore | |
2807 | @item --leading-underscore | |
2808 | @itemx --no-leading-underscore | |
2809 | For most targets default symbol-prefix is an underscore and is defined | |
2810 | in target's description. By this option it is possible to | |
2811 | disable/enable the default underscore symbol-prefix. | |
2812 | ||
252b5132 RH |
2813 | @cindex DLLs, creating |
2814 | @kindex --export-all-symbols | |
2815 | @item --export-all-symbols | |
2816 | If given, all global symbols in the objects used to build a DLL will | |
2817 | be exported by the DLL. Note that this is the default if there | |
2818 | otherwise wouldn't be any exported symbols. When symbols are | |
2819 | explicitly exported via DEF files or implicitly exported via function | |
2820 | attributes, the default is to not export anything else unless this | |
2821 | option is given. Note that the symbols @code{DllMain@@12}, | |
ece2d90e | 2822 | @code{DllEntryPoint@@0}, @code{DllMainCRTStartup@@12}, and |
b044cda1 | 2823 | @code{impure_ptr} will not be automatically |
ece2d90e NC |
2824 | exported. Also, symbols imported from other DLLs will not be |
2825 | re-exported, nor will symbols specifying the DLL's internal layout | |
2826 | such as those beginning with @code{_head_} or ending with | |
2827 | @code{_iname}. In addition, no symbols from @code{libgcc}, | |
b044cda1 CW |
2828 | @code{libstd++}, @code{libmingw32}, or @code{crtX.o} will be exported. |
2829 | Symbols whose names begin with @code{__rtti_} or @code{__builtin_} will | |
2830 | not be exported, to help with C++ DLLs. Finally, there is an | |
ece2d90e | 2831 | extensive list of cygwin-private symbols that are not exported |
b044cda1 | 2832 | (obviously, this applies on when building DLLs for cygwin targets). |
ece2d90e | 2833 | These cygwin-excludes are: @code{_cygwin_dll_entry@@12}, |
b044cda1 | 2834 | @code{_cygwin_crt0_common@@8}, @code{_cygwin_noncygwin_dll_entry@@12}, |
ece2d90e | 2835 | @code{_fmode}, @code{_impure_ptr}, @code{cygwin_attach_dll}, |
b044cda1 | 2836 | @code{cygwin_premain0}, @code{cygwin_premain1}, @code{cygwin_premain2}, |
ece2d90e | 2837 | @code{cygwin_premain3}, and @code{environ}. |
bb10df36 | 2838 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2839 | |
2840 | @kindex --exclude-symbols | |
1d0a3c9c | 2841 | @item --exclude-symbols @var{symbol},@var{symbol},... |
252b5132 RH |
2842 | Specifies a list of symbols which should not be automatically |
2843 | exported. The symbol names may be delimited by commas or colons. | |
bb10df36 | 2844 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2845 | |
2927aaca NC |
2846 | @kindex --exclude-all-symbols |
2847 | @item --exclude-all-symbols | |
2848 | Specifies no symbols should be automatically exported. | |
2849 | [This option is specific to the i386 PE targeted port of the linker] | |
2850 | ||
252b5132 RH |
2851 | @kindex --file-alignment |
2852 | @item --file-alignment | |
2853 | Specify the file alignment. Sections in the file will always begin at | |
2854 | file offsets which are multiples of this number. This defaults to | |
2855 | 512. | |
bb10df36 | 2856 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2857 | |
2858 | @cindex heap size | |
2859 | @kindex --heap | |
2860 | @item --heap @var{reserve} | |
2861 | @itemx --heap @var{reserve},@var{commit} | |
a00b50c5 | 2862 | Specify the number of bytes of memory to reserve (and optionally commit) |
fe6d7d6a | 2863 | to be used as heap for this program. The default is 1MB reserved, 4K |
252b5132 | 2864 | committed. |
bb10df36 | 2865 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2866 | |
2867 | @cindex image base | |
2868 | @kindex --image-base | |
2869 | @item --image-base @var{value} | |
2870 | Use @var{value} as the base address of your program or dll. This is | |
2871 | the lowest memory location that will be used when your program or dll | |
2872 | is loaded. To reduce the need to relocate and improve performance of | |
2873 | your dlls, each should have a unique base address and not overlap any | |
2874 | other dlls. The default is 0x400000 for executables, and 0x10000000 | |
2875 | for dlls. | |
bb10df36 | 2876 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2877 | |
2878 | @kindex --kill-at | |
2879 | @item --kill-at | |
2880 | If given, the stdcall suffixes (@@@var{nn}) will be stripped from | |
2881 | symbols before they are exported. | |
bb10df36 | 2882 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2883 | |
26d2d8a2 BF |
2884 | @kindex --large-address-aware |
2885 | @item --large-address-aware | |
b45619c0 | 2886 | If given, the appropriate bit in the ``Characteristics'' field of the COFF |
26d2d8a2 | 2887 | header is set to indicate that this executable supports virtual addresses |
b45619c0 | 2888 | greater than 2 gigabytes. This should be used in conjunction with the /3GB |
26d2d8a2 BF |
2889 | or /USERVA=@var{value} megabytes switch in the ``[operating systems]'' |
2890 | section of the BOOT.INI. Otherwise, this bit has no effect. | |
2891 | [This option is specific to PE targeted ports of the linker] | |
2892 | ||
f69a2f97 NC |
2893 | @kindex --disable-large-address-aware |
2894 | @item --disable-large-address-aware | |
2895 | Reverts the effect of a previous @samp{--large-address-aware} option. | |
2896 | This is useful if @samp{--large-address-aware} is always set by the compiler | |
2897 | driver (e.g. Cygwin gcc) and the executable does not support virtual | |
2898 | addresses greater than 2 gigabytes. | |
2899 | [This option is specific to PE targeted ports of the linker] | |
2900 | ||
252b5132 RH |
2901 | @kindex --major-image-version |
2902 | @item --major-image-version @var{value} | |
36f63dca | 2903 | Sets the major number of the ``image version''. Defaults to 1. |
bb10df36 | 2904 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2905 | |
2906 | @kindex --major-os-version | |
2907 | @item --major-os-version @var{value} | |
36f63dca | 2908 | Sets the major number of the ``os version''. Defaults to 4. |
bb10df36 | 2909 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2910 | |
2911 | @kindex --major-subsystem-version | |
2912 | @item --major-subsystem-version @var{value} | |
36f63dca | 2913 | Sets the major number of the ``subsystem version''. Defaults to 4. |
bb10df36 | 2914 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2915 | |
2916 | @kindex --minor-image-version | |
2917 | @item --minor-image-version @var{value} | |
36f63dca | 2918 | Sets the minor number of the ``image version''. Defaults to 0. |
bb10df36 | 2919 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2920 | |
2921 | @kindex --minor-os-version | |
2922 | @item --minor-os-version @var{value} | |
36f63dca | 2923 | Sets the minor number of the ``os version''. Defaults to 0. |
bb10df36 | 2924 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2925 | |
2926 | @kindex --minor-subsystem-version | |
2927 | @item --minor-subsystem-version @var{value} | |
36f63dca | 2928 | Sets the minor number of the ``subsystem version''. Defaults to 0. |
bb10df36 | 2929 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
2930 | |
2931 | @cindex DEF files, creating | |
2932 | @cindex DLLs, creating | |
2933 | @kindex --output-def | |
2934 | @item --output-def @var{file} | |
2935 | The linker will create the file @var{file} which will contain a DEF | |
2936 | file corresponding to the DLL the linker is generating. This DEF file | |
2937 | (which should be called @code{*.def}) may be used to create an import | |
2938 | library with @code{dlltool} or may be used as a reference to | |
2939 | automatically or implicitly exported symbols. | |
bb10df36 | 2940 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 2941 | |
b044cda1 | 2942 | @cindex DLLs, creating |
b044cda1 CW |
2943 | @kindex --enable-auto-image-base |
2944 | @item --enable-auto-image-base | |
d0e6d77b CF |
2945 | @itemx --enable-auto-image-base=@var{value} |
2946 | Automatically choose the image base for DLLs, optionally starting with base | |
2947 | @var{value}, unless one is specified using the @code{--image-base} argument. | |
2948 | By using a hash generated from the dllname to create unique image bases | |
2949 | for each DLL, in-memory collisions and relocations which can delay program | |
2950 | execution are avoided. | |
bb10df36 | 2951 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2952 | |
2953 | @kindex --disable-auto-image-base | |
2954 | @item --disable-auto-image-base | |
2955 | Do not automatically generate a unique image base. If there is no | |
2956 | user-specified image base (@code{--image-base}) then use the platform | |
2957 | default. | |
bb10df36 | 2958 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2959 | |
2960 | @cindex DLLs, linking to | |
2961 | @kindex --dll-search-prefix | |
2962 | @item --dll-search-prefix @var{string} | |
489d0400 | 2963 | When linking dynamically to a dll without an import library, |
ece2d90e | 2964 | search for @code{<string><basename>.dll} in preference to |
560e09e9 | 2965 | @code{lib<basename>.dll}. This behaviour allows easy distinction |
b044cda1 CW |
2966 | between DLLs built for the various "subplatforms": native, cygwin, |
2967 | uwin, pw, etc. For instance, cygwin DLLs typically use | |
ece2d90e | 2968 | @code{--dll-search-prefix=cyg}. |
bb10df36 | 2969 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 CW |
2970 | |
2971 | @kindex --enable-auto-import | |
2972 | @item --enable-auto-import | |
ece2d90e | 2973 | Do sophisticated linking of @code{_symbol} to @code{__imp__symbol} for |
317ff008 EB |
2974 | DATA imports from DLLs, thus making it possible to bypass the dllimport |
2975 | mechanism on the user side and to reference unmangled symbol names. | |
2976 | [This option is specific to the i386 PE targeted port of the linker] | |
2977 | ||
2978 | The following remarks pertain to the original implementation of the | |
2979 | feature and are obsolete nowadays for Cygwin and MinGW targets. | |
2980 | ||
2981 | Note: Use of the 'auto-import' extension will cause the text section | |
2982 | of the image file to be made writable. This does not conform to the | |
2983 | PE-COFF format specification published by Microsoft. | |
4d8907ac | 2984 | |
e2a83dd0 NC |
2985 | Note - use of the 'auto-import' extension will also cause read only |
2986 | data which would normally be placed into the .rdata section to be | |
2987 | placed into the .data section instead. This is in order to work | |
2988 | around a problem with consts that is described here: | |
2989 | http://www.cygwin.com/ml/cygwin/2004-09/msg01101.html | |
2990 | ||
4d8907ac DS |
2991 | Using 'auto-import' generally will 'just work' -- but sometimes you may |
2992 | see this message: | |
0d888aac | 2993 | |
ece2d90e | 2994 | "variable '<var>' can't be auto-imported. Please read the |
0d888aac CW |
2995 | documentation for ld's @code{--enable-auto-import} for details." |
2996 | ||
ece2d90e NC |
2997 | This message occurs when some (sub)expression accesses an address |
2998 | ultimately given by the sum of two constants (Win32 import tables only | |
c0065db7 RM |
2999 | allow one). Instances where this may occur include accesses to member |
3000 | fields of struct variables imported from a DLL, as well as using a | |
3001 | constant index into an array variable imported from a DLL. Any | |
2f8d8971 NC |
3002 | multiword variable (arrays, structs, long long, etc) may trigger |
3003 | this error condition. However, regardless of the exact data type | |
3004 | of the offending exported variable, ld will always detect it, issue | |
3005 | the warning, and exit. | |
3006 | ||
3007 | There are several ways to address this difficulty, regardless of the | |
3008 | data type of the exported variable: | |
0d888aac | 3009 | |
2fa9fc65 NC |
3010 | One way is to use --enable-runtime-pseudo-reloc switch. This leaves the task |
3011 | of adjusting references in your client code for runtime environment, so | |
560e09e9 | 3012 | this method works only when runtime environment supports this feature. |
2fa9fc65 | 3013 | |
c0065db7 RM |
3014 | A second solution is to force one of the 'constants' to be a variable -- |
3015 | that is, unknown and un-optimizable at compile time. For arrays, | |
3016 | there are two possibilities: a) make the indexee (the array's address) | |
0d888aac CW |
3017 | a variable, or b) make the 'constant' index a variable. Thus: |
3018 | ||
3019 | @example | |
3020 | extern type extern_array[]; | |
c0065db7 | 3021 | extern_array[1] --> |
0d888aac CW |
3022 | @{ volatile type *t=extern_array; t[1] @} |
3023 | @end example | |
3024 | ||
3025 | or | |
3026 | ||
3027 | @example | |
3028 | extern type extern_array[]; | |
c0065db7 | 3029 | extern_array[1] --> |
0d888aac CW |
3030 | @{ volatile int t=1; extern_array[t] @} |
3031 | @end example | |
3032 | ||
c0065db7 | 3033 | For structs (and most other multiword data types) the only option |
2f8d8971 | 3034 | is to make the struct itself (or the long long, or the ...) variable: |
0d888aac CW |
3035 | |
3036 | @example | |
3037 | extern struct s extern_struct; | |
c0065db7 | 3038 | extern_struct.field --> |
0d888aac CW |
3039 | @{ volatile struct s *t=&extern_struct; t->field @} |
3040 | @end example | |
3041 | ||
c406afaf NC |
3042 | or |
3043 | ||
3044 | @example | |
3045 | extern long long extern_ll; | |
3046 | extern_ll --> | |
3047 | @{ volatile long long * local_ll=&extern_ll; *local_ll @} | |
3048 | @end example | |
3049 | ||
2fa9fc65 | 3050 | A third method of dealing with this difficulty is to abandon |
c0065db7 | 3051 | 'auto-import' for the offending symbol and mark it with |
11e7fd74 | 3052 | @code{__declspec(dllimport)}. However, in practice that |
0d888aac | 3053 | requires using compile-time #defines to indicate whether you are |
c0065db7 RM |
3054 | building a DLL, building client code that will link to the DLL, or |
3055 | merely building/linking to a static library. In making the choice | |
3056 | between the various methods of resolving the 'direct address with | |
0d888aac CW |
3057 | constant offset' problem, you should consider typical real-world usage: |
3058 | ||
3059 | Original: | |
3060 | @example | |
3061 | --foo.h | |
3062 | extern int arr[]; | |
3063 | --foo.c | |
3064 | #include "foo.h" | |
3065 | void main(int argc, char **argv)@{ | |
3066 | printf("%d\n",arr[1]); | |
3067 | @} | |
3068 | @end example | |
3069 | ||
3070 | Solution 1: | |
3071 | @example | |
3072 | --foo.h | |
3073 | extern int arr[]; | |
3074 | --foo.c | |
3075 | #include "foo.h" | |
3076 | void main(int argc, char **argv)@{ | |
3077 | /* This workaround is for win32 and cygwin; do not "optimize" */ | |
3078 | volatile int *parr = arr; | |
3079 | printf("%d\n",parr[1]); | |
3080 | @} | |
3081 | @end example | |
3082 | ||
3083 | Solution 2: | |
3084 | @example | |
3085 | --foo.h | |
3086 | /* Note: auto-export is assumed (no __declspec(dllexport)) */ | |
3087 | #if (defined(_WIN32) || defined(__CYGWIN__)) && \ | |
3088 | !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC)) | |
3089 | #define FOO_IMPORT __declspec(dllimport) | |
3090 | #else | |
3091 | #define FOO_IMPORT | |
3092 | #endif | |
3093 | extern FOO_IMPORT int arr[]; | |
3094 | --foo.c | |
3095 | #include "foo.h" | |
3096 | void main(int argc, char **argv)@{ | |
3097 | printf("%d\n",arr[1]); | |
3098 | @} | |
3099 | @end example | |
3100 | ||
c0065db7 | 3101 | A fourth way to avoid this problem is to re-code your |
0d888aac CW |
3102 | library to use a functional interface rather than a data interface |
3103 | for the offending variables (e.g. set_foo() and get_foo() accessor | |
3104 | functions). | |
b044cda1 CW |
3105 | |
3106 | @kindex --disable-auto-import | |
3107 | @item --disable-auto-import | |
c0065db7 | 3108 | Do not attempt to do sophisticated linking of @code{_symbol} to |
b044cda1 | 3109 | @code{__imp__symbol} for DATA imports from DLLs. |
bb10df36 | 3110 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 3111 | |
2fa9fc65 NC |
3112 | @kindex --enable-runtime-pseudo-reloc |
3113 | @item --enable-runtime-pseudo-reloc | |
3114 | If your code contains expressions described in --enable-auto-import section, | |
3115 | that is, DATA imports from DLL with non-zero offset, this switch will create | |
3116 | a vector of 'runtime pseudo relocations' which can be used by runtime | |
c0065db7 | 3117 | environment to adjust references to such data in your client code. |
bb10df36 | 3118 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 NC |
3119 | |
3120 | @kindex --disable-runtime-pseudo-reloc | |
3121 | @item --disable-runtime-pseudo-reloc | |
317ff008 | 3122 | Do not create pseudo relocations for non-zero offset DATA imports from DLLs. |
bb10df36 | 3123 | [This option is specific to the i386 PE targeted port of the linker] |
2fa9fc65 | 3124 | |
b044cda1 CW |
3125 | @kindex --enable-extra-pe-debug |
3126 | @item --enable-extra-pe-debug | |
3127 | Show additional debug info related to auto-import symbol thunking. | |
bb10df36 | 3128 | [This option is specific to the i386 PE targeted port of the linker] |
b044cda1 | 3129 | |
252b5132 RH |
3130 | @kindex --section-alignment |
3131 | @item --section-alignment | |
3132 | Sets the section alignment. Sections in memory will always begin at | |
3133 | addresses which are a multiple of this number. Defaults to 0x1000. | |
bb10df36 | 3134 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
3135 | |
3136 | @cindex stack size | |
3137 | @kindex --stack | |
3138 | @item --stack @var{reserve} | |
3139 | @itemx --stack @var{reserve},@var{commit} | |
a00b50c5 | 3140 | Specify the number of bytes of memory to reserve (and optionally commit) |
fe6d7d6a | 3141 | to be used as stack for this program. The default is 2MB reserved, 4K |
252b5132 | 3142 | committed. |
bb10df36 | 3143 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 RH |
3144 | |
3145 | @kindex --subsystem | |
3146 | @item --subsystem @var{which} | |
3147 | @itemx --subsystem @var{which}:@var{major} | |
3148 | @itemx --subsystem @var{which}:@var{major}.@var{minor} | |
3149 | Specifies the subsystem under which your program will execute. The | |
3150 | legal values for @var{which} are @code{native}, @code{windows}, | |
33f362e1 NC |
3151 | @code{console}, @code{posix}, and @code{xbox}. You may optionally set |
3152 | the subsystem version also. Numeric values are also accepted for | |
3153 | @var{which}. | |
bb10df36 | 3154 | [This option is specific to the i386 PE targeted port of the linker] |
252b5132 | 3155 | |
2f563b51 DK |
3156 | The following options set flags in the @code{DllCharacteristics} field |
3157 | of the PE file header: | |
3158 | [These options are specific to PE targeted ports of the linker] | |
3159 | ||
2d5c3743 NC |
3160 | @kindex --high-entropy-va |
3161 | @item --high-entropy-va | |
514b4e19 | 3162 | @itemx --disable-high-entropy-va |
2d5c3743 | 3163 | Image is compatible with 64-bit address space layout randomization |
514b4e19 JD |
3164 | (ASLR). This option is enabled by default for 64-bit PE images. |
3165 | ||
dc9bd8c9 HD |
3166 | This option also implies @option{--dynamicbase} and |
3167 | @option{--enable-reloc-section}. | |
2d5c3743 | 3168 | |
2f563b51 DK |
3169 | @kindex --dynamicbase |
3170 | @item --dynamicbase | |
514b4e19 | 3171 | @itemx --disable-dynamicbase |
2f563b51 DK |
3172 | The image base address may be relocated using address space layout |
3173 | randomization (ASLR). This feature was introduced with MS Windows | |
514b4e19 JD |
3174 | Vista for i386 PE targets. This option is enabled by default but |
3175 | can be disabled via the @option{--disable-dynamicbase} option. | |
dc9bd8c9 | 3176 | This option also implies @option{--enable-reloc-section}. |
2f563b51 DK |
3177 | |
3178 | @kindex --forceinteg | |
3179 | @item --forceinteg | |
514b4e19 JD |
3180 | @itemx --disable-forceinteg |
3181 | Code integrity checks are enforced. This option is disabled by | |
3182 | default. | |
2f563b51 DK |
3183 | |
3184 | @kindex --nxcompat | |
3185 | @item --nxcompat | |
514b4e19 | 3186 | @item --disable-nxcompat |
2f563b51 | 3187 | The image is compatible with the Data Execution Prevention. |
514b4e19 JD |
3188 | This feature was introduced with MS Windows XP SP2 for i386 PE |
3189 | targets. The option is enabled by default. | |
2f563b51 DK |
3190 | |
3191 | @kindex --no-isolation | |
3192 | @item --no-isolation | |
514b4e19 | 3193 | @itemx --disable-no-isolation |
2f563b51 | 3194 | Although the image understands isolation, do not isolate the image. |
514b4e19 | 3195 | This option is disabled by default. |
2f563b51 DK |
3196 | |
3197 | @kindex --no-seh | |
3198 | @item --no-seh | |
514b4e19 | 3199 | @itemx --disable-no-seh |
2f563b51 | 3200 | The image does not use SEH. No SE handler may be called from |
514b4e19 | 3201 | this image. This option is disabled by default. |
2f563b51 DK |
3202 | |
3203 | @kindex --no-bind | |
3204 | @item --no-bind | |
514b4e19 JD |
3205 | @itemx --disable-no-bind |
3206 | Do not bind this image. This option is disabled by default. | |
2f563b51 DK |
3207 | |
3208 | @kindex --wdmdriver | |
3209 | @item --wdmdriver | |
514b4e19 JD |
3210 | @itemx --disable-wdmdriver |
3211 | The driver uses the MS Windows Driver Model. This option is disabled | |
3212 | by default. | |
9d5777a3 | 3213 | |
2f563b51 DK |
3214 | @kindex --tsaware |
3215 | @item --tsaware | |
514b4e19 JD |
3216 | @itemx --disable-tsaware |
3217 | The image is Terminal Server aware. This option is disabled by | |
3218 | default. | |
2f563b51 | 3219 | |
0cb112f7 CF |
3220 | @kindex --insert-timestamp |
3221 | @item --insert-timestamp | |
eeb14e5a LZ |
3222 | @itemx --no-insert-timestamp |
3223 | Insert a real timestamp into the image. This is the default behaviour | |
3224 | as it matches legacy code and it means that the image will work with | |
3225 | other, proprietary tools. The problem with this default is that it | |
56e6cf80 | 3226 | will result in slightly different images being produced each time the |
eeb14e5a LZ |
3227 | same sources are linked. The option @option{--no-insert-timestamp} |
3228 | can be used to insert a zero value for the timestamp, this ensuring | |
56e6cf80 | 3229 | that binaries produced from identical sources will compare |
eeb14e5a | 3230 | identically. |
dc9bd8c9 HD |
3231 | |
3232 | @kindex --enable-reloc-section | |
3233 | @item --enable-reloc-section | |
514b4e19 | 3234 | @itemx --disable-reloc-section |
dc9bd8c9 HD |
3235 | Create the base relocation table, which is necessary if the image |
3236 | is loaded at a different image base than specified in the PE header. | |
514b4e19 | 3237 | This option is enabled by default. |
252b5132 RH |
3238 | @end table |
3239 | ||
0285c67d NC |
3240 | @c man end |
3241 | ||
ac145307 BS |
3242 | @ifset C6X |
3243 | @subsection Options specific to C6X uClinux targets | |
3244 | ||
3245 | @c man begin OPTIONS | |
3246 | ||
3247 | The C6X uClinux target uses a binary format called DSBT to support shared | |
3248 | libraries. Each shared library in the system needs to have a unique index; | |
3249 | all executables use an index of 0. | |
3250 | ||
3251 | @table @gcctabopt | |
3252 | ||
3253 | @kindex --dsbt-size | |
3254 | @item --dsbt-size @var{size} | |
56e6cf80 | 3255 | This option sets the number of entries in the DSBT of the current executable |
ac145307 BS |
3256 | or shared library to @var{size}. The default is to create a table with 64 |
3257 | entries. | |
3258 | ||
3259 | @kindex --dsbt-index | |
3260 | @item --dsbt-index @var{index} | |
3261 | This option sets the DSBT index of the current executable or shared library | |
3262 | to @var{index}. The default is 0, which is appropriate for generating | |
3263 | executables. If a shared library is generated with a DSBT index of 0, the | |
3264 | @code{R_C6000_DSBT_INDEX} relocs are copied into the output file. | |
3265 | ||
fbd9ad90 PB |
3266 | @kindex --no-merge-exidx-entries |
3267 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent | |
3268 | exidx entries in frame unwind info. | |
3269 | ||
ac145307 BS |
3270 | @end table |
3271 | ||
3272 | @c man end | |
3273 | @end ifset | |
3274 | ||
b8891f8d AJ |
3275 | @ifset CSKY |
3276 | @subsection Options specific to C-SKY targets | |
3277 | ||
3278 | @c man begin OPTIONS | |
3279 | ||
3280 | @table @gcctabopt | |
3281 | ||
3282 | @kindex --branch-stub on C-SKY | |
3283 | @item --branch-stub | |
3284 | This option enables linker branch relaxation by inserting branch stub | |
3285 | sections when needed to extend the range of branches. This option is | |
3286 | usually not required since C-SKY supports branch and call instructions that | |
3287 | can access the full memory range and branch relaxation is normally handled by | |
3288 | the compiler or assembler. | |
3289 | ||
3290 | @kindex --stub-group-size on C-SKY | |
3291 | @item --stub-group-size=@var{N} | |
3292 | This option allows finer control of linker branch stub creation. | |
3293 | It sets the maximum size of a group of input sections that can | |
3294 | be handled by one stub section. A negative value of @var{N} locates | |
3295 | stub sections after their branches, while a positive value allows stub | |
3296 | sections to appear either before or after the branches. Values of | |
3297 | @samp{1} or @samp{-1} indicate that the | |
3298 | linker should choose suitable defaults. | |
3299 | ||
3300 | @end table | |
3301 | ||
3302 | @c man end | |
3303 | @end ifset | |
3304 | ||
93fd0973 SC |
3305 | @ifset M68HC11 |
3306 | @subsection Options specific to Motorola 68HC11 and 68HC12 targets | |
3307 | ||
3308 | @c man begin OPTIONS | |
3309 | ||
3310 | The 68HC11 and 68HC12 linkers support specific options to control the | |
3311 | memory bank switching mapping and trampoline code generation. | |
3312 | ||
3313 | @table @gcctabopt | |
3314 | ||
3315 | @kindex --no-trampoline | |
3316 | @item --no-trampoline | |
3317 | This option disables the generation of trampoline. By default a trampoline | |
3318 | is generated for each far function which is called using a @code{jsr} | |
3319 | instruction (this happens when a pointer to a far function is taken). | |
3320 | ||
3321 | @kindex --bank-window | |
3322 | @item --bank-window @var{name} | |
3323 | This option indicates to the linker the name of the memory region in | |
3324 | the @samp{MEMORY} specification that describes the memory bank window. | |
3325 | The definition of such region is then used by the linker to compute | |
3326 | paging and addresses within the memory window. | |
3327 | ||
3328 | @end table | |
3329 | ||
3330 | @c man end | |
3331 | @end ifset | |
3332 | ||
7fb9f789 NC |
3333 | @ifset M68K |
3334 | @subsection Options specific to Motorola 68K target | |
3335 | ||
3336 | @c man begin OPTIONS | |
3337 | ||
3338 | The following options are supported to control handling of GOT generation | |
3339 | when linking for 68K targets. | |
3340 | ||
3341 | @table @gcctabopt | |
3342 | ||
3343 | @kindex --got | |
3344 | @item --got=@var{type} | |
3345 | This option tells the linker which GOT generation scheme to use. | |
3346 | @var{type} should be one of @samp{single}, @samp{negative}, | |
3347 | @samp{multigot} or @samp{target}. For more information refer to the | |
3348 | Info entry for @file{ld}. | |
3349 | ||
3350 | @end table | |
3351 | ||
3352 | @c man end | |
3353 | @end ifset | |
3354 | ||
833794fc MR |
3355 | @ifset MIPS |
3356 | @subsection Options specific to MIPS targets | |
3357 | ||
3358 | @c man begin OPTIONS | |
3359 | ||
3360 | The following options are supported to control microMIPS instruction | |
8b10b0b3 MR |
3361 | generation and branch relocation checks for ISA mode transitions when |
3362 | linking for MIPS targets. | |
833794fc MR |
3363 | |
3364 | @table @gcctabopt | |
3365 | ||
3366 | @kindex --insn32 | |
3367 | @item --insn32 | |
3368 | @kindex --no-insn32 | |
3369 | @itemx --no-insn32 | |
3370 | These options control the choice of microMIPS instructions used in code | |
3371 | generated by the linker, such as that in the PLT or lazy binding stubs, | |
3372 | or in relaxation. If @samp{--insn32} is used, then the linker only uses | |
3373 | 32-bit instruction encodings. By default or if @samp{--no-insn32} is | |
3374 | used, all instruction encodings are used, including 16-bit ones where | |
3375 | possible. | |
3376 | ||
8b10b0b3 MR |
3377 | @kindex --ignore-branch-isa |
3378 | @item --ignore-branch-isa | |
3379 | @kindex --no-ignore-branch-isa | |
3380 | @itemx --no-ignore-branch-isa | |
3381 | These options control branch relocation checks for invalid ISA mode | |
3382 | transitions. If @samp{--ignore-branch-isa} is used, then the linker | |
3383 | accepts any branch relocations and any ISA mode transition required | |
3384 | is lost in relocation calculation, except for some cases of @code{BAL} | |
3385 | instructions which meet relaxation conditions and are converted to | |
3386 | equivalent @code{JALX} instructions as the associated relocation is | |
3387 | calculated. By default or if @samp{--no-ignore-branch-isa} is used | |
3388 | a check is made causing the loss of an ISA mode transition to produce | |
3389 | an error. | |
3390 | ||
3734320d MF |
3391 | @kindex --compact-branches |
3392 | @item --compact-branches | |
3393 | @kindex --no-compact-branches | |
fa1477dc | 3394 | @itemx --no-compact-branches |
3734320d MF |
3395 | These options control the generation of compact instructions by the linker |
3396 | in the PLT entries for MIPS R6. | |
3397 | ||
833794fc MR |
3398 | @end table |
3399 | ||
3400 | @c man end | |
3401 | @end ifset | |
3402 | ||
fa1477dc SC |
3403 | |
3404 | @ifset PDP11 | |
3405 | @subsection Options specific to PDP11 targets | |
3406 | ||
3407 | @c man begin OPTIONS | |
3408 | ||
3409 | For the pdp11-aout target, three variants of the output format can be | |
3410 | produced as selected by the following options. The default variant | |
3411 | for pdp11-aout is the @samp{--omagic} option, whereas for other | |
3412 | targets @samp{--nmagic} is the default. The @samp{--imagic} option is | |
3413 | defined only for the pdp11-aout target, while the others are described | |
3414 | here as they apply to the pdp11-aout target. | |
3415 | ||
3416 | @table @gcctabopt | |
3417 | ||
3418 | @kindex -N | |
3419 | @item -N | |
3420 | @kindex --omagic | |
3421 | @itemx --omagic | |
3422 | ||
3423 | Mark the output as @code{OMAGIC} (0407) in the @file{a.out} header to | |
3424 | indicate that the text segment is not to be write-protected and | |
3425 | shared. Since the text and data sections are both readable and | |
3426 | writable, the data section is allocated immediately contiguous after | |
3427 | the text segment. This is the oldest format for PDP11 executable | |
3428 | programs and is the default for @command{ld} on PDP11 Unix systems | |
3429 | from the beginning through 2.11BSD. | |
3430 | ||
3431 | @kindex -n | |
3432 | @item -n | |
3433 | @kindex --nmagic | |
3434 | @itemx --nmagic | |
3435 | ||
3436 | Mark the output as @code{NMAGIC} (0410) in the @file{a.out} header to | |
3437 | indicate that when the output file is executed, the text portion will | |
3438 | be read-only and shareable among all processes executing the same | |
3439 | file. This involves moving the data areas up to the first possible 8K | |
3440 | byte page boundary following the end of the text. This option creates | |
3441 | a @emph{pure executable} format. | |
3442 | ||
3443 | @kindex -z | |
3444 | @item -z | |
3445 | @kindex --imagic | |
3446 | @itemx --imagic | |
3447 | ||
3448 | Mark the output as @code{IMAGIC} (0411) in the @file{a.out} header to | |
3449 | indicate that when the output file is executed, the program text and | |
3450 | data areas will be loaded into separate address spaces using the split | |
3451 | instruction and data space feature of the memory management unit in | |
3452 | larger models of the PDP11. This doubles the address space available | |
3453 | to the program. The text segment is again pure, write-protected, and | |
3454 | shareable. The only difference in the output format between this | |
3455 | option and the others, besides the magic number, is that both the text | |
3456 | and data sections start at location 0. The @samp{-z} option selected | |
3457 | this format in 2.11BSD. This option creates a @emph{separate | |
3458 | executable} format. | |
3459 | ||
3460 | @kindex --no-omagic | |
3461 | @item --no-omagic | |
3462 | ||
3463 | Equivalent to @samp{--nmagic} for pdp11-aout. | |
3464 | ||
3465 | @end table | |
3466 | ||
3467 | @c man end | |
3468 | @end ifset | |
3469 | ||
252b5132 RH |
3470 | @ifset UsesEnvVars |
3471 | @node Environment | |
3472 | @section Environment Variables | |
3473 | ||
0285c67d NC |
3474 | @c man begin ENVIRONMENT |
3475 | ||
560e09e9 | 3476 | You can change the behaviour of @command{ld} with the environment variables |
36f63dca NC |
3477 | @ifclear SingleFormat |
3478 | @code{GNUTARGET}, | |
3479 | @end ifclear | |
3480 | @code{LDEMULATION} and @code{COLLECT_NO_DEMANGLE}. | |
252b5132 | 3481 | |
36f63dca | 3482 | @ifclear SingleFormat |
252b5132 RH |
3483 | @kindex GNUTARGET |
3484 | @cindex default input format | |
3485 | @code{GNUTARGET} determines the input-file object format if you don't | |
3486 | use @samp{-b} (or its synonym @samp{--format}). Its value should be one | |
3487 | of the BFD names for an input format (@pxref{BFD}). If there is no | |
ff5dcc92 | 3488 | @code{GNUTARGET} in the environment, @command{ld} uses the natural format |
252b5132 RH |
3489 | of the target. If @code{GNUTARGET} is set to @code{default} then BFD |
3490 | attempts to discover the input format by examining binary input files; | |
3491 | this method often succeeds, but there are potential ambiguities, since | |
3492 | there is no method of ensuring that the magic number used to specify | |
3493 | object-file formats is unique. However, the configuration procedure for | |
3494 | BFD on each system places the conventional format for that system first | |
3495 | in the search-list, so ambiguities are resolved in favor of convention. | |
36f63dca | 3496 | @end ifclear |
252b5132 RH |
3497 | |
3498 | @kindex LDEMULATION | |
3499 | @cindex default emulation | |
3500 | @cindex emulation, default | |
3501 | @code{LDEMULATION} determines the default emulation if you don't use the | |
3502 | @samp{-m} option. The emulation can affect various aspects of linker | |
3503 | behaviour, particularly the default linker script. You can list the | |
3504 | available emulations with the @samp{--verbose} or @samp{-V} options. If | |
3505 | the @samp{-m} option is not used, and the @code{LDEMULATION} environment | |
3506 | variable is not defined, the default emulation depends upon how the | |
3507 | linker was configured. | |
252b5132 RH |
3508 | |
3509 | @kindex COLLECT_NO_DEMANGLE | |
3510 | @cindex demangling, default | |
3511 | Normally, the linker will default to demangling symbols. However, if | |
3512 | @code{COLLECT_NO_DEMANGLE} is set in the environment, then it will | |
3513 | default to not demangling symbols. This environment variable is used in | |
3514 | a similar fashion by the @code{gcc} linker wrapper program. The default | |
3515 | may be overridden by the @samp{--demangle} and @samp{--no-demangle} | |
3516 | options. | |
3517 | ||
0285c67d NC |
3518 | @c man end |
3519 | @end ifset | |
3520 | ||
252b5132 RH |
3521 | @node Scripts |
3522 | @chapter Linker Scripts | |
3523 | ||
3524 | @cindex scripts | |
3525 | @cindex linker scripts | |
3526 | @cindex command files | |
3527 | Every link is controlled by a @dfn{linker script}. This script is | |
3528 | written in the linker command language. | |
3529 | ||
3530 | The main purpose of the linker script is to describe how the sections in | |
3531 | the input files should be mapped into the output file, and to control | |
3532 | the memory layout of the output file. Most linker scripts do nothing | |
3533 | more than this. However, when necessary, the linker script can also | |
3534 | direct the linker to perform many other operations, using the commands | |
3535 | described below. | |
3536 | ||
3537 | The linker always uses a linker script. If you do not supply one | |
3538 | yourself, the linker will use a default script that is compiled into the | |
a05a5b64 TP |
3539 | linker executable. You can use the @samp{--verbose} command-line option |
3540 | to display the default linker script. Certain command-line options, | |
252b5132 RH |
3541 | such as @samp{-r} or @samp{-N}, will affect the default linker script. |
3542 | ||
3543 | You may supply your own linker script by using the @samp{-T} command | |
3544 | line option. When you do this, your linker script will replace the | |
3545 | default linker script. | |
3546 | ||
3547 | You may also use linker scripts implicitly by naming them as input files | |
3548 | to the linker, as though they were files to be linked. @xref{Implicit | |
3549 | Linker Scripts}. | |
3550 | ||
3551 | @menu | |
3552 | * Basic Script Concepts:: Basic Linker Script Concepts | |
3553 | * Script Format:: Linker Script Format | |
3554 | * Simple Example:: Simple Linker Script Example | |
3555 | * Simple Commands:: Simple Linker Script Commands | |
3556 | * Assignments:: Assigning Values to Symbols | |
3557 | * SECTIONS:: SECTIONS Command | |
3558 | * MEMORY:: MEMORY Command | |
3559 | * PHDRS:: PHDRS Command | |
3560 | * VERSION:: VERSION Command | |
3561 | * Expressions:: Expressions in Linker Scripts | |
3562 | * Implicit Linker Scripts:: Implicit Linker Scripts | |
3563 | @end menu | |
3564 | ||
3565 | @node Basic Script Concepts | |
3566 | @section Basic Linker Script Concepts | |
3567 | @cindex linker script concepts | |
3568 | We need to define some basic concepts and vocabulary in order to | |
3569 | describe the linker script language. | |
3570 | ||
3571 | The linker combines input files into a single output file. The output | |
3572 | file and each input file are in a special data format known as an | |
3573 | @dfn{object file format}. Each file is called an @dfn{object file}. | |
3574 | The output file is often called an @dfn{executable}, but for our | |
3575 | purposes we will also call it an object file. Each object file has, | |
3576 | among other things, a list of @dfn{sections}. We sometimes refer to a | |
3577 | section in an input file as an @dfn{input section}; similarly, a section | |
3578 | in the output file is an @dfn{output section}. | |
3579 | ||
3580 | Each section in an object file has a name and a size. Most sections | |
3581 | also have an associated block of data, known as the @dfn{section | |
56dd11f0 | 3582 | contents}. A section may be marked as @dfn{loadable}, which means that |
252b5132 RH |
3583 | the contents should be loaded into memory when the output file is run. |
3584 | A section with no contents may be @dfn{allocatable}, which means that an | |
3585 | area in memory should be set aside, but nothing in particular should be | |
3586 | loaded there (in some cases this memory must be zeroed out). A section | |
3587 | which is neither loadable nor allocatable typically contains some sort | |
3588 | of debugging information. | |
3589 | ||
3590 | Every loadable or allocatable output section has two addresses. The | |
3591 | first is the @dfn{VMA}, or virtual memory address. This is the address | |
3592 | the section will have when the output file is run. The second is the | |
3593 | @dfn{LMA}, or load memory address. This is the address at which the | |
3594 | section will be loaded. In most cases the two addresses will be the | |
3595 | same. An example of when they might be different is when a data section | |
3596 | is loaded into ROM, and then copied into RAM when the program starts up | |
3597 | (this technique is often used to initialize global variables in a ROM | |
3598 | based system). In this case the ROM address would be the LMA, and the | |
3599 | RAM address would be the VMA. | |
3600 | ||
3601 | You can see the sections in an object file by using the @code{objdump} | |
3602 | program with the @samp{-h} option. | |
3603 | ||
3604 | Every object file also has a list of @dfn{symbols}, known as the | |
3605 | @dfn{symbol table}. A symbol may be defined or undefined. Each symbol | |
3606 | has a name, and each defined symbol has an address, among other | |
3607 | information. If you compile a C or C++ program into an object file, you | |
3608 | will get a defined symbol for every defined function and global or | |
3609 | static variable. Every undefined function or global variable which is | |
3610 | referenced in the input file will become an undefined symbol. | |
3611 | ||
3612 | You can see the symbols in an object file by using the @code{nm} | |
3613 | program, or by using the @code{objdump} program with the @samp{-t} | |
3614 | option. | |
3615 | ||
3616 | @node Script Format | |
3617 | @section Linker Script Format | |
3618 | @cindex linker script format | |
3619 | Linker scripts are text files. | |
3620 | ||
3621 | You write a linker script as a series of commands. Each command is | |
3622 | either a keyword, possibly followed by arguments, or an assignment to a | |
3623 | symbol. You may separate commands using semicolons. Whitespace is | |
3624 | generally ignored. | |
3625 | ||
3626 | Strings such as file or format names can normally be entered directly. | |
3627 | If the file name contains a character such as a comma which would | |
3628 | otherwise serve to separate file names, you may put the file name in | |
3629 | double quotes. There is no way to use a double quote character in a | |
3630 | file name. | |
3631 | ||
3632 | You may include comments in linker scripts just as in C, delimited by | |
3633 | @samp{/*} and @samp{*/}. As in C, comments are syntactically equivalent | |
3634 | to whitespace. | |
3635 | ||
3636 | @node Simple Example | |
3637 | @section Simple Linker Script Example | |
3638 | @cindex linker script example | |
3639 | @cindex example of linker script | |
3640 | Many linker scripts are fairly simple. | |
3641 | ||
3642 | The simplest possible linker script has just one command: | |
3643 | @samp{SECTIONS}. You use the @samp{SECTIONS} command to describe the | |
3644 | memory layout of the output file. | |
3645 | ||
3646 | The @samp{SECTIONS} command is a powerful command. Here we will | |
3647 | describe a simple use of it. Let's assume your program consists only of | |
3648 | code, initialized data, and uninitialized data. These will be in the | |
3649 | @samp{.text}, @samp{.data}, and @samp{.bss} sections, respectively. | |
3650 | Let's assume further that these are the only sections which appear in | |
3651 | your input files. | |
3652 | ||
3653 | For this example, let's say that the code should be loaded at address | |
3654 | 0x10000, and that the data should start at address 0x8000000. Here is a | |
3655 | linker script which will do that: | |
3656 | @smallexample | |
3657 | SECTIONS | |
3658 | @{ | |
3659 | . = 0x10000; | |
3660 | .text : @{ *(.text) @} | |
3661 | . = 0x8000000; | |
3662 | .data : @{ *(.data) @} | |
3663 | .bss : @{ *(.bss) @} | |
3664 | @} | |
3665 | @end smallexample | |
3666 | ||
3667 | You write the @samp{SECTIONS} command as the keyword @samp{SECTIONS}, | |
3668 | followed by a series of symbol assignments and output section | |
3669 | descriptions enclosed in curly braces. | |
3670 | ||
252b5132 RH |
3671 | The first line inside the @samp{SECTIONS} command of the above example |
3672 | sets the value of the special symbol @samp{.}, which is the location | |
3673 | counter. If you do not specify the address of an output section in some | |
3674 | other way (other ways are described later), the address is set from the | |
3675 | current value of the location counter. The location counter is then | |
3676 | incremented by the size of the output section. At the start of the | |
3677 | @samp{SECTIONS} command, the location counter has the value @samp{0}. | |
3678 | ||
3679 | The second line defines an output section, @samp{.text}. The colon is | |
3680 | required syntax which may be ignored for now. Within the curly braces | |
3681 | after the output section name, you list the names of the input sections | |
3682 | which should be placed into this output section. The @samp{*} is a | |
3683 | wildcard which matches any file name. The expression @samp{*(.text)} | |
3684 | means all @samp{.text} input sections in all input files. | |
3685 | ||
3686 | Since the location counter is @samp{0x10000} when the output section | |
3687 | @samp{.text} is defined, the linker will set the address of the | |
3688 | @samp{.text} section in the output file to be @samp{0x10000}. | |
3689 | ||
3690 | The remaining lines define the @samp{.data} and @samp{.bss} sections in | |
3691 | the output file. The linker will place the @samp{.data} output section | |
3692 | at address @samp{0x8000000}. After the linker places the @samp{.data} | |
3693 | output section, the value of the location counter will be | |
3694 | @samp{0x8000000} plus the size of the @samp{.data} output section. The | |
3695 | effect is that the linker will place the @samp{.bss} output section | |
58434bc1 | 3696 | immediately after the @samp{.data} output section in memory. |
252b5132 RH |
3697 | |
3698 | The linker will ensure that each output section has the required | |
3699 | alignment, by increasing the location counter if necessary. In this | |
3700 | example, the specified addresses for the @samp{.text} and @samp{.data} | |
3701 | sections will probably satisfy any alignment constraints, but the linker | |
3702 | may have to create a small gap between the @samp{.data} and @samp{.bss} | |
3703 | sections. | |
3704 | ||
3705 | That's it! That's a simple and complete linker script. | |
3706 | ||
3707 | @node Simple Commands | |
3708 | @section Simple Linker Script Commands | |
3709 | @cindex linker script simple commands | |
3710 | In this section we describe the simple linker script commands. | |
3711 | ||
3712 | @menu | |
3713 | * Entry Point:: Setting the entry point | |
3714 | * File Commands:: Commands dealing with files | |
3715 | @ifclear SingleFormat | |
3716 | * Format Commands:: Commands dealing with object file formats | |
3717 | @end ifclear | |
3718 | ||
4a93e180 | 3719 | * REGION_ALIAS:: Assign alias names to memory regions |
252b5132 RH |
3720 | * Miscellaneous Commands:: Other linker script commands |
3721 | @end menu | |
3722 | ||
3723 | @node Entry Point | |
36f63dca | 3724 | @subsection Setting the Entry Point |
252b5132 RH |
3725 | @kindex ENTRY(@var{symbol}) |
3726 | @cindex start of execution | |
3727 | @cindex first instruction | |
3728 | @cindex entry point | |
3729 | The first instruction to execute in a program is called the @dfn{entry | |
3730 | point}. You can use the @code{ENTRY} linker script command to set the | |
3731 | entry point. The argument is a symbol name: | |
3732 | @smallexample | |
3733 | ENTRY(@var{symbol}) | |
3734 | @end smallexample | |
3735 | ||
3736 | There are several ways to set the entry point. The linker will set the | |
3737 | entry point by trying each of the following methods in order, and | |
3738 | stopping when one of them succeeds: | |
3739 | @itemize @bullet | |
a1ab1d2a | 3740 | @item |
252b5132 | 3741 | the @samp{-e} @var{entry} command-line option; |
a1ab1d2a | 3742 | @item |
252b5132 | 3743 | the @code{ENTRY(@var{symbol})} command in a linker script; |
a1ab1d2a | 3744 | @item |
a094d01f | 3745 | the value of a target-specific symbol, if it is defined; For many |
8a758655 | 3746 | targets this is @code{start}, but PE- and BeOS-based systems for example |
3ab904c4 | 3747 | check a list of possible entry symbols, matching the first one found. |
a1ab1d2a | 3748 | @item |
252b5132 | 3749 | the address of the first byte of the @samp{.text} section, if present; |
a1ab1d2a | 3750 | @item |
252b5132 RH |
3751 | The address @code{0}. |
3752 | @end itemize | |
3753 | ||
3754 | @node File Commands | |
36f63dca | 3755 | @subsection Commands Dealing with Files |
252b5132 RH |
3756 | @cindex linker script file commands |
3757 | Several linker script commands deal with files. | |
3758 | ||
3759 | @table @code | |
3760 | @item INCLUDE @var{filename} | |
3761 | @kindex INCLUDE @var{filename} | |
3762 | @cindex including a linker script | |
3763 | Include the linker script @var{filename} at this point. The file will | |
3764 | be searched for in the current directory, and in any directory specified | |
ff5dcc92 | 3765 | with the @option{-L} option. You can nest calls to @code{INCLUDE} up to |
252b5132 RH |
3766 | 10 levels deep. |
3767 | ||
4006703d NS |
3768 | You can place @code{INCLUDE} directives at the top level, in @code{MEMORY} or |
3769 | @code{SECTIONS} commands, or in output section descriptions. | |
3770 | ||
252b5132 RH |
3771 | @item INPUT(@var{file}, @var{file}, @dots{}) |
3772 | @itemx INPUT(@var{file} @var{file} @dots{}) | |
3773 | @kindex INPUT(@var{files}) | |
3774 | @cindex input files in linker scripts | |
3775 | @cindex input object files in linker scripts | |
3776 | @cindex linker script input object files | |
3777 | The @code{INPUT} command directs the linker to include the named files | |
3778 | in the link, as though they were named on the command line. | |
3779 | ||
3780 | For example, if you always want to include @file{subr.o} any time you do | |
3781 | a link, but you can't be bothered to put it on every link command line, | |
3782 | then you can put @samp{INPUT (subr.o)} in your linker script. | |
3783 | ||
3784 | In fact, if you like, you can list all of your input files in the linker | |
3785 | script, and then invoke the linker with nothing but a @samp{-T} option. | |
3786 | ||
e3f2db7f AO |
3787 | In case a @dfn{sysroot prefix} is configured, and the filename starts |
3788 | with the @samp{/} character, and the script being processed was | |
3789 | located inside the @dfn{sysroot prefix}, the filename will be looked | |
16171946 FS |
3790 | for in the @dfn{sysroot prefix}. The @dfn{sysroot prefix} can also be forced by specifying |
3791 | @code{=} as the first character in the filename path, or prefixing the | |
3792 | filename path with @code{$SYSROOT}. See also the description of | |
3793 | @samp{-L} in @ref{Options,,Command-line Options}. | |
3794 | ||
3795 | If a @dfn{sysroot prefix} is not used then the linker will try to open | |
3796 | the file in the directory containing the linker script. If it is not | |
3797 | found the linker will then search the current directory. If it is still | |
3798 | not found the linker will search through the archive library search | |
3799 | path. | |
252b5132 | 3800 | |
ff5dcc92 | 3801 | If you use @samp{INPUT (-l@var{file})}, @command{ld} will transform the |
a05a5b64 | 3802 | name to @code{lib@var{file}.a}, as with the command-line argument |
252b5132 RH |
3803 | @samp{-l}. |
3804 | ||
3805 | When you use the @code{INPUT} command in an implicit linker script, the | |
3806 | files will be included in the link at the point at which the linker | |
3807 | script file is included. This can affect archive searching. | |
3808 | ||
3809 | @item GROUP(@var{file}, @var{file}, @dots{}) | |
3810 | @itemx GROUP(@var{file} @var{file} @dots{}) | |
3811 | @kindex GROUP(@var{files}) | |
3812 | @cindex grouping input files | |
3813 | The @code{GROUP} command is like @code{INPUT}, except that the named | |
3814 | files should all be archives, and they are searched repeatedly until no | |
3815 | new undefined references are created. See the description of @samp{-(} | |
a05a5b64 | 3816 | in @ref{Options,,Command-line Options}. |
252b5132 | 3817 | |
b717d30e JJ |
3818 | @item AS_NEEDED(@var{file}, @var{file}, @dots{}) |
3819 | @itemx AS_NEEDED(@var{file} @var{file} @dots{}) | |
3820 | @kindex AS_NEEDED(@var{files}) | |
3821 | This construct can appear only inside of the @code{INPUT} or @code{GROUP} | |
3822 | commands, among other filenames. The files listed will be handled | |
3823 | as if they appear directly in the @code{INPUT} or @code{GROUP} commands, | |
3824 | with the exception of ELF shared libraries, that will be added only | |
3825 | when they are actually needed. This construct essentially enables | |
3826 | @option{--as-needed} option for all the files listed inside of it | |
3827 | and restores previous @option{--as-needed} resp. @option{--no-as-needed} | |
3828 | setting afterwards. | |
3829 | ||
252b5132 RH |
3830 | @item OUTPUT(@var{filename}) |
3831 | @kindex OUTPUT(@var{filename}) | |
b45619c0 | 3832 | @cindex output file name in linker script |
252b5132 RH |
3833 | The @code{OUTPUT} command names the output file. Using |
3834 | @code{OUTPUT(@var{filename})} in the linker script is exactly like using | |
3835 | @samp{-o @var{filename}} on the command line (@pxref{Options,,Command | |
a05a5b64 | 3836 | Line Options}). If both are used, the command-line option takes |
252b5132 RH |
3837 | precedence. |
3838 | ||
3839 | You can use the @code{OUTPUT} command to define a default name for the | |
3840 | output file other than the usual default of @file{a.out}. | |
3841 | ||
3842 | @item SEARCH_DIR(@var{path}) | |
3843 | @kindex SEARCH_DIR(@var{path}) | |
3844 | @cindex library search path in linker script | |
3845 | @cindex archive search path in linker script | |
3846 | @cindex search path in linker script | |
3847 | The @code{SEARCH_DIR} command adds @var{path} to the list of paths where | |
ff5dcc92 | 3848 | @command{ld} looks for archive libraries. Using |
252b5132 | 3849 | @code{SEARCH_DIR(@var{path})} is exactly like using @samp{-L @var{path}} |
a05a5b64 | 3850 | on the command line (@pxref{Options,,Command-line Options}). If both |
252b5132 | 3851 | are used, then the linker will search both paths. Paths specified using |
a05a5b64 | 3852 | the command-line option are searched first. |
252b5132 RH |
3853 | |
3854 | @item STARTUP(@var{filename}) | |
3855 | @kindex STARTUP(@var{filename}) | |
3856 | @cindex first input file | |
3857 | The @code{STARTUP} command is just like the @code{INPUT} command, except | |
3858 | that @var{filename} will become the first input file to be linked, as | |
3859 | though it were specified first on the command line. This may be useful | |
3860 | when using a system in which the entry point is always the start of the | |
3861 | first file. | |
3862 | @end table | |
3863 | ||
3864 | @ifclear SingleFormat | |
3865 | @node Format Commands | |
36f63dca | 3866 | @subsection Commands Dealing with Object File Formats |
252b5132 RH |
3867 | A couple of linker script commands deal with object file formats. |
3868 | ||
3869 | @table @code | |
3870 | @item OUTPUT_FORMAT(@var{bfdname}) | |
3871 | @itemx OUTPUT_FORMAT(@var{default}, @var{big}, @var{little}) | |
3872 | @kindex OUTPUT_FORMAT(@var{bfdname}) | |
3873 | @cindex output file format in linker script | |
3874 | The @code{OUTPUT_FORMAT} command names the BFD format to use for the | |
3875 | output file (@pxref{BFD}). Using @code{OUTPUT_FORMAT(@var{bfdname})} is | |
024531e2 | 3876 | exactly like using @samp{--oformat @var{bfdname}} on the command line |
a05a5b64 | 3877 | (@pxref{Options,,Command-line Options}). If both are used, the command |
252b5132 RH |
3878 | line option takes precedence. |
3879 | ||
3880 | You can use @code{OUTPUT_FORMAT} with three arguments to use different | |
a05a5b64 | 3881 | formats based on the @samp{-EB} and @samp{-EL} command-line options. |
252b5132 RH |
3882 | This permits the linker script to set the output format based on the |
3883 | desired endianness. | |
3884 | ||
3885 | If neither @samp{-EB} nor @samp{-EL} are used, then the output format | |
3886 | will be the first argument, @var{default}. If @samp{-EB} is used, the | |
3887 | output format will be the second argument, @var{big}. If @samp{-EL} is | |
3888 | used, the output format will be the third argument, @var{little}. | |
3889 | ||
3890 | For example, the default linker script for the MIPS ELF target uses this | |
3891 | command: | |
3892 | @smallexample | |
3893 | OUTPUT_FORMAT(elf32-bigmips, elf32-bigmips, elf32-littlemips) | |
3894 | @end smallexample | |
3895 | This says that the default format for the output file is | |
a05a5b64 | 3896 | @samp{elf32-bigmips}, but if the user uses the @samp{-EL} command-line |
252b5132 RH |
3897 | option, the output file will be created in the @samp{elf32-littlemips} |
3898 | format. | |
3899 | ||
3900 | @item TARGET(@var{bfdname}) | |
3901 | @kindex TARGET(@var{bfdname}) | |
3902 | @cindex input file format in linker script | |
3903 | The @code{TARGET} command names the BFD format to use when reading input | |
3904 | files. It affects subsequent @code{INPUT} and @code{GROUP} commands. | |
3905 | This command is like using @samp{-b @var{bfdname}} on the command line | |
a05a5b64 | 3906 | (@pxref{Options,,Command-line Options}). If the @code{TARGET} command |
252b5132 RH |
3907 | is used but @code{OUTPUT_FORMAT} is not, then the last @code{TARGET} |
3908 | command is also used to set the format for the output file. @xref{BFD}. | |
3909 | @end table | |
3910 | @end ifclear | |
3911 | ||
4a93e180 NC |
3912 | @node REGION_ALIAS |
3913 | @subsection Assign alias names to memory regions | |
3914 | @kindex REGION_ALIAS(@var{alias}, @var{region}) | |
3915 | @cindex region alias | |
3916 | @cindex region names | |
3917 | ||
3918 | Alias names can be added to existing memory regions created with the | |
3919 | @ref{MEMORY} command. Each name corresponds to at most one memory region. | |
3920 | ||
3921 | @smallexample | |
3922 | REGION_ALIAS(@var{alias}, @var{region}) | |
3923 | @end smallexample | |
3924 | ||
3925 | The @code{REGION_ALIAS} function creates an alias name @var{alias} for the | |
3926 | memory region @var{region}. This allows a flexible mapping of output sections | |
3927 | to memory regions. An example follows. | |
3928 | ||
3929 | Suppose we have an application for embedded systems which come with various | |
3930 | memory storage devices. All have a general purpose, volatile memory @code{RAM} | |
3931 | that allows code execution or data storage. Some may have a read-only, | |
3932 | non-volatile memory @code{ROM} that allows code execution and read-only data | |
3933 | access. The last variant is a read-only, non-volatile memory @code{ROM2} with | |
3934 | read-only data access and no code execution capability. We have four output | |
3935 | sections: | |
3936 | ||
3937 | @itemize @bullet | |
3938 | @item | |
3939 | @code{.text} program code; | |
3940 | @item | |
3941 | @code{.rodata} read-only data; | |
3942 | @item | |
3943 | @code{.data} read-write initialized data; | |
3944 | @item | |
3945 | @code{.bss} read-write zero initialized data. | |
3946 | @end itemize | |
3947 | ||
3948 | The goal is to provide a linker command file that contains a system independent | |
3949 | part defining the output sections and a system dependent part mapping the | |
3950 | output sections to the memory regions available on the system. Our embedded | |
3951 | systems come with three different memory setups @code{A}, @code{B} and | |
3952 | @code{C}: | |
3953 | @multitable @columnfractions .25 .25 .25 .25 | |
3954 | @item Section @tab Variant A @tab Variant B @tab Variant C | |
9d5777a3 | 3955 | @item .text @tab RAM @tab ROM @tab ROM |
4a93e180 NC |
3956 | @item .rodata @tab RAM @tab ROM @tab ROM2 |
3957 | @item .data @tab RAM @tab RAM/ROM @tab RAM/ROM2 | |
3958 | @item .bss @tab RAM @tab RAM @tab RAM | |
3959 | @end multitable | |
3960 | The notation @code{RAM/ROM} or @code{RAM/ROM2} means that this section is | |
3961 | loaded into region @code{ROM} or @code{ROM2} respectively. Please note that | |
3962 | the load address of the @code{.data} section starts in all three variants at | |
3963 | the end of the @code{.rodata} section. | |
3964 | ||
3965 | The base linker script that deals with the output sections follows. It | |
3966 | includes the system dependent @code{linkcmds.memory} file that describes the | |
3967 | memory layout: | |
3968 | @smallexample | |
3969 | INCLUDE linkcmds.memory | |
3970 | ||
3971 | SECTIONS | |
3972 | @{ | |
3973 | .text : | |
3974 | @{ | |
3975 | *(.text) | |
3976 | @} > REGION_TEXT | |
3977 | .rodata : | |
3978 | @{ | |
3979 | *(.rodata) | |
3980 | rodata_end = .; | |
3981 | @} > REGION_RODATA | |
3982 | .data : AT (rodata_end) | |
3983 | @{ | |
3984 | data_start = .; | |
3985 | *(.data) | |
3986 | @} > REGION_DATA | |
3987 | data_size = SIZEOF(.data); | |
3988 | data_load_start = LOADADDR(.data); | |
3989 | .bss : | |
3990 | @{ | |
3991 | *(.bss) | |
3992 | @} > REGION_BSS | |
3993 | @} | |
3994 | @end smallexample | |
3995 | ||
3996 | Now we need three different @code{linkcmds.memory} files to define memory | |
3997 | regions and alias names. The content of @code{linkcmds.memory} for the three | |
3998 | variants @code{A}, @code{B} and @code{C}: | |
3999 | @table @code | |
4000 | @item A | |
4001 | Here everything goes into the @code{RAM}. | |
4002 | @smallexample | |
4003 | MEMORY | |
4004 | @{ | |
4005 | RAM : ORIGIN = 0, LENGTH = 4M | |
4006 | @} | |
4007 | ||
4008 | REGION_ALIAS("REGION_TEXT", RAM); | |
4009 | REGION_ALIAS("REGION_RODATA", RAM); | |
4010 | REGION_ALIAS("REGION_DATA", RAM); | |
4011 | REGION_ALIAS("REGION_BSS", RAM); | |
4012 | @end smallexample | |
4013 | @item B | |
4014 | Program code and read-only data go into the @code{ROM}. Read-write data goes | |
4015 | into the @code{RAM}. An image of the initialized data is loaded into the | |
4016 | @code{ROM} and will be copied during system start into the @code{RAM}. | |
4017 | @smallexample | |
4018 | MEMORY | |
4019 | @{ | |
4020 | ROM : ORIGIN = 0, LENGTH = 3M | |
4021 | RAM : ORIGIN = 0x10000000, LENGTH = 1M | |
4022 | @} | |
4023 | ||
4024 | REGION_ALIAS("REGION_TEXT", ROM); | |
4025 | REGION_ALIAS("REGION_RODATA", ROM); | |
4026 | REGION_ALIAS("REGION_DATA", RAM); | |
4027 | REGION_ALIAS("REGION_BSS", RAM); | |
4028 | @end smallexample | |
4029 | @item C | |
4030 | Program code goes into the @code{ROM}. Read-only data goes into the | |
4031 | @code{ROM2}. Read-write data goes into the @code{RAM}. An image of the | |
4032 | initialized data is loaded into the @code{ROM2} and will be copied during | |
4033 | system start into the @code{RAM}. | |
4034 | @smallexample | |
4035 | MEMORY | |
4036 | @{ | |
4037 | ROM : ORIGIN = 0, LENGTH = 2M | |
4038 | ROM2 : ORIGIN = 0x10000000, LENGTH = 1M | |
4039 | RAM : ORIGIN = 0x20000000, LENGTH = 1M | |
4040 | @} | |
4041 | ||
4042 | REGION_ALIAS("REGION_TEXT", ROM); | |
4043 | REGION_ALIAS("REGION_RODATA", ROM2); | |
4044 | REGION_ALIAS("REGION_DATA", RAM); | |
4045 | REGION_ALIAS("REGION_BSS", RAM); | |
4046 | @end smallexample | |
4047 | @end table | |
4048 | ||
4049 | It is possible to write a common system initialization routine to copy the | |
4050 | @code{.data} section from @code{ROM} or @code{ROM2} into the @code{RAM} if | |
4051 | necessary: | |
4052 | @smallexample | |
4053 | #include <string.h> | |
4054 | ||
4055 | extern char data_start []; | |
4056 | extern char data_size []; | |
4057 | extern char data_load_start []; | |
4058 | ||
4059 | void copy_data(void) | |
4060 | @{ | |
4061 | if (data_start != data_load_start) | |
4062 | @{ | |
4063 | memcpy(data_start, data_load_start, (size_t) data_size); | |
4064 | @} | |
4065 | @} | |
4066 | @end smallexample | |
4067 | ||
252b5132 | 4068 | @node Miscellaneous Commands |
36f63dca | 4069 | @subsection Other Linker Script Commands |
252b5132 RH |
4070 | There are a few other linker scripts commands. |
4071 | ||
4072 | @table @code | |
4073 | @item ASSERT(@var{exp}, @var{message}) | |
4074 | @kindex ASSERT | |
4075 | @cindex assertion in linker script | |
4076 | Ensure that @var{exp} is non-zero. If it is zero, then exit the linker | |
4077 | with an error code, and print @var{message}. | |
4078 | ||
fd1c4238 NC |
4079 | Note that assertions are checked before the final stages of linking |
4080 | take place. This means that expressions involving symbols PROVIDEd | |
4081 | inside section definitions will fail if the user has not set values | |
4082 | for those symbols. The only exception to this rule is PROVIDEd | |
4083 | symbols that just reference dot. Thus an assertion like this: | |
4084 | ||
4085 | @smallexample | |
4086 | .stack : | |
4087 | @{ | |
4088 | PROVIDE (__stack = .); | |
4089 | PROVIDE (__stack_size = 0x100); | |
4090 | ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack"); | |
4091 | @} | |
4092 | @end smallexample | |
4093 | ||
4094 | will fail if @code{__stack_size} is not defined elsewhere. Symbols | |
4095 | PROVIDEd outside of section definitions are evaluated earlier, so they | |
4096 | can be used inside ASSERTions. Thus: | |
4097 | ||
4098 | @smallexample | |
4099 | PROVIDE (__stack_size = 0x100); | |
4100 | .stack : | |
4101 | @{ | |
4102 | PROVIDE (__stack = .); | |
4103 | ASSERT ((__stack > (_end + __stack_size)), "Error: No room left for the stack"); | |
4104 | @} | |
4105 | @end smallexample | |
4106 | ||
4107 | will work. | |
4108 | ||
252b5132 RH |
4109 | @item EXTERN(@var{symbol} @var{symbol} @dots{}) |
4110 | @kindex EXTERN | |
4111 | @cindex undefined symbol in linker script | |
4112 | Force @var{symbol} to be entered in the output file as an undefined | |
4113 | symbol. Doing this may, for example, trigger linking of additional | |
4114 | modules from standard libraries. You may list several @var{symbol}s for | |
4115 | each @code{EXTERN}, and you may use @code{EXTERN} multiple times. This | |
4116 | command has the same effect as the @samp{-u} command-line option. | |
4117 | ||
4118 | @item FORCE_COMMON_ALLOCATION | |
4119 | @kindex FORCE_COMMON_ALLOCATION | |
4120 | @cindex common allocation in linker script | |
4121 | This command has the same effect as the @samp{-d} command-line option: | |
ff5dcc92 | 4122 | to make @command{ld} assign space to common symbols even if a relocatable |
252b5132 RH |
4123 | output file is specified (@samp{-r}). |
4124 | ||
4818e05f AM |
4125 | @item INHIBIT_COMMON_ALLOCATION |
4126 | @kindex INHIBIT_COMMON_ALLOCATION | |
4127 | @cindex common allocation in linker script | |
4128 | This command has the same effect as the @samp{--no-define-common} | |
4129 | command-line option: to make @code{ld} omit the assignment of addresses | |
4130 | to common symbols even for a non-relocatable output file. | |
4131 | ||
7bdf4127 AB |
4132 | @item FORCE_GROUP_ALLOCATION |
4133 | @kindex FORCE_GROUP_ALLOCATION | |
4134 | @cindex group allocation in linker script | |
4135 | @cindex section groups | |
4136 | @cindex COMDAT | |
4137 | This command has the same effect as the | |
4138 | @samp{--force-group-allocation} command-line option: to make | |
4139 | @command{ld} place section group members like normal input sections, | |
4140 | and to delete the section groups even if a relocatable output file is | |
4141 | specified (@samp{-r}). | |
4142 | ||
53d25da6 AM |
4143 | @item INSERT [ AFTER | BEFORE ] @var{output_section} |
4144 | @kindex INSERT | |
4145 | @cindex insert user script into default script | |
4146 | This command is typically used in a script specified by @samp{-T} to | |
4147 | augment the default @code{SECTIONS} with, for example, overlays. It | |
4148 | inserts all prior linker script statements after (or before) | |
4149 | @var{output_section}, and also causes @samp{-T} to not override the | |
4150 | default linker script. The exact insertion point is as for orphan | |
4151 | sections. @xref{Location Counter}. The insertion happens after the | |
4152 | linker has mapped input sections to output sections. Prior to the | |
4153 | insertion, since @samp{-T} scripts are parsed before the default | |
4154 | linker script, statements in the @samp{-T} script occur before the | |
4155 | default linker script statements in the internal linker representation | |
4156 | of the script. In particular, input section assignments will be made | |
4157 | to @samp{-T} output sections before those in the default script. Here | |
4158 | is an example of how a @samp{-T} script using @code{INSERT} might look: | |
4159 | ||
4160 | @smallexample | |
4161 | SECTIONS | |
4162 | @{ | |
4163 | OVERLAY : | |
4164 | @{ | |
4165 | .ov1 @{ ov1*(.text) @} | |
4166 | .ov2 @{ ov2*(.text) @} | |
4167 | @} | |
4168 | @} | |
4169 | INSERT AFTER .text; | |
4170 | @end smallexample | |
4171 | ||
252b5132 RH |
4172 | @item NOCROSSREFS(@var{section} @var{section} @dots{}) |
4173 | @kindex NOCROSSREFS(@var{sections}) | |
4174 | @cindex cross references | |
ff5dcc92 | 4175 | This command may be used to tell @command{ld} to issue an error about any |
252b5132 RH |
4176 | references among certain output sections. |
4177 | ||
4178 | In certain types of programs, particularly on embedded systems when | |
4179 | using overlays, when one section is loaded into memory, another section | |
4180 | will not be. Any direct references between the two sections would be | |
4181 | errors. For example, it would be an error if code in one section called | |
4182 | a function defined in the other section. | |
4183 | ||
4184 | The @code{NOCROSSREFS} command takes a list of output section names. If | |
ff5dcc92 | 4185 | @command{ld} detects any cross references between the sections, it reports |
252b5132 RH |
4186 | an error and returns a non-zero exit status. Note that the |
4187 | @code{NOCROSSREFS} command uses output section names, not input section | |
4188 | names. | |
4189 | ||
cdf96953 MF |
4190 | @item NOCROSSREFS_TO(@var{tosection} @var{fromsection} @dots{}) |
4191 | @kindex NOCROSSREFS_TO(@var{tosection} @var{fromsections}) | |
4192 | @cindex cross references | |
4193 | This command may be used to tell @command{ld} to issue an error about any | |
4194 | references to one section from a list of other sections. | |
4195 | ||
4196 | The @code{NOCROSSREFS} command is useful when ensuring that two or more | |
4197 | output sections are entirely independent but there are situations where | |
4198 | a one-way dependency is needed. For example, in a multi-core application | |
4199 | there may be shared code that can be called from each core but for safety | |
4200 | must never call back. | |
4201 | ||
4202 | The @code{NOCROSSREFS_TO} command takes a list of output section names. | |
4203 | The first section can not be referenced from any of the other sections. | |
4204 | If @command{ld} detects any references to the first section from any of | |
4205 | the other sections, it reports an error and returns a non-zero exit | |
4206 | status. Note that the @code{NOCROSSREFS_TO} command uses output section | |
4207 | names, not input section names. | |
4208 | ||
252b5132 RH |
4209 | @ifclear SingleFormat |
4210 | @item OUTPUT_ARCH(@var{bfdarch}) | |
4211 | @kindex OUTPUT_ARCH(@var{bfdarch}) | |
4212 | @cindex machine architecture | |
4213 | @cindex architecture | |
4214 | Specify a particular output machine architecture. The argument is one | |
4215 | of the names used by the BFD library (@pxref{BFD}). You can see the | |
4216 | architecture of an object file by using the @code{objdump} program with | |
4217 | the @samp{-f} option. | |
4218 | @end ifclear | |
01554a74 AM |
4219 | |
4220 | @item LD_FEATURE(@var{string}) | |
4221 | @kindex LD_FEATURE(@var{string}) | |
4222 | This command may be used to modify @command{ld} behavior. If | |
4223 | @var{string} is @code{"SANE_EXPR"} then absolute symbols and numbers | |
4224 | in a script are simply treated as numbers everywhere. | |
4225 | @xref{Expression Section}. | |
252b5132 RH |
4226 | @end table |
4227 | ||
4228 | @node Assignments | |
4229 | @section Assigning Values to Symbols | |
4230 | @cindex assignment in scripts | |
4231 | @cindex symbol definition, scripts | |
4232 | @cindex variables, defining | |
4233 | You may assign a value to a symbol in a linker script. This will define | |
73ae6183 | 4234 | the symbol and place it into the symbol table with a global scope. |
252b5132 RH |
4235 | |
4236 | @menu | |
4237 | * Simple Assignments:: Simple Assignments | |
eb8476a6 | 4238 | * HIDDEN:: HIDDEN |
252b5132 | 4239 | * PROVIDE:: PROVIDE |
7af8e998 | 4240 | * PROVIDE_HIDDEN:: PROVIDE_HIDDEN |
73ae6183 | 4241 | * Source Code Reference:: How to use a linker script defined symbol in source code |
252b5132 RH |
4242 | @end menu |
4243 | ||
4244 | @node Simple Assignments | |
4245 | @subsection Simple Assignments | |
4246 | ||
4247 | You may assign to a symbol using any of the C assignment operators: | |
4248 | ||
4249 | @table @code | |
4250 | @item @var{symbol} = @var{expression} ; | |
4251 | @itemx @var{symbol} += @var{expression} ; | |
4252 | @itemx @var{symbol} -= @var{expression} ; | |
4253 | @itemx @var{symbol} *= @var{expression} ; | |
4254 | @itemx @var{symbol} /= @var{expression} ; | |
4255 | @itemx @var{symbol} <<= @var{expression} ; | |
4256 | @itemx @var{symbol} >>= @var{expression} ; | |
4257 | @itemx @var{symbol} &= @var{expression} ; | |
4258 | @itemx @var{symbol} |= @var{expression} ; | |
4259 | @end table | |
4260 | ||
4261 | The first case will define @var{symbol} to the value of | |
4262 | @var{expression}. In the other cases, @var{symbol} must already be | |
4263 | defined, and the value will be adjusted accordingly. | |
4264 | ||
4265 | The special symbol name @samp{.} indicates the location counter. You | |
b5666f2f | 4266 | may only use this within a @code{SECTIONS} command. @xref{Location Counter}. |
252b5132 RH |
4267 | |
4268 | The semicolon after @var{expression} is required. | |
4269 | ||
4270 | Expressions are defined below; see @ref{Expressions}. | |
4271 | ||
4272 | You may write symbol assignments as commands in their own right, or as | |
4273 | statements within a @code{SECTIONS} command, or as part of an output | |
4274 | section description in a @code{SECTIONS} command. | |
4275 | ||
4276 | The section of the symbol will be set from the section of the | |
4277 | expression; for more information, see @ref{Expression Section}. | |
4278 | ||
4279 | Here is an example showing the three different places that symbol | |
4280 | assignments may be used: | |
4281 | ||
4282 | @smallexample | |
4283 | floating_point = 0; | |
4284 | SECTIONS | |
4285 | @{ | |
4286 | .text : | |
4287 | @{ | |
4288 | *(.text) | |
4289 | _etext = .; | |
4290 | @} | |
156e34dd | 4291 | _bdata = (. + 3) & ~ 3; |
252b5132 RH |
4292 | .data : @{ *(.data) @} |
4293 | @} | |
4294 | @end smallexample | |
4295 | @noindent | |
4296 | In this example, the symbol @samp{floating_point} will be defined as | |
4297 | zero. The symbol @samp{_etext} will be defined as the address following | |
4298 | the last @samp{.text} input section. The symbol @samp{_bdata} will be | |
4299 | defined as the address following the @samp{.text} output section aligned | |
4300 | upward to a 4 byte boundary. | |
4301 | ||
eb8476a6 MR |
4302 | @node HIDDEN |
4303 | @subsection HIDDEN | |
4304 | @cindex HIDDEN | |
4305 | For ELF targeted ports, define a symbol that will be hidden and won't be | |
4306 | exported. The syntax is @code{HIDDEN(@var{symbol} = @var{expression})}. | |
4307 | ||
4308 | Here is the example from @ref{Simple Assignments}, rewritten to use | |
4309 | @code{HIDDEN}: | |
4310 | ||
4311 | @smallexample | |
4312 | HIDDEN(floating_point = 0); | |
4313 | SECTIONS | |
4314 | @{ | |
4315 | .text : | |
4316 | @{ | |
4317 | *(.text) | |
4318 | HIDDEN(_etext = .); | |
4319 | @} | |
4320 | HIDDEN(_bdata = (. + 3) & ~ 3); | |
4321 | .data : @{ *(.data) @} | |
4322 | @} | |
4323 | @end smallexample | |
4324 | @noindent | |
4325 | In this case none of the three symbols will be visible outside this module. | |
4326 | ||
252b5132 RH |
4327 | @node PROVIDE |
4328 | @subsection PROVIDE | |
4329 | @cindex PROVIDE | |
4330 | In some cases, it is desirable for a linker script to define a symbol | |
4331 | only if it is referenced and is not defined by any object included in | |
4332 | the link. For example, traditional linkers defined the symbol | |
4333 | @samp{etext}. However, ANSI C requires that the user be able to use | |
4334 | @samp{etext} as a function name without encountering an error. The | |
4335 | @code{PROVIDE} keyword may be used to define a symbol, such as | |
4336 | @samp{etext}, only if it is referenced but not defined. The syntax is | |
4337 | @code{PROVIDE(@var{symbol} = @var{expression})}. | |
4338 | ||
4339 | Here is an example of using @code{PROVIDE} to define @samp{etext}: | |
4340 | @smallexample | |
4341 | SECTIONS | |
4342 | @{ | |
4343 | .text : | |
4344 | @{ | |
4345 | *(.text) | |
4346 | _etext = .; | |
4347 | PROVIDE(etext = .); | |
4348 | @} | |
4349 | @} | |
4350 | @end smallexample | |
4351 | ||
4352 | In this example, if the program defines @samp{_etext} (with a leading | |
4353 | underscore), the linker will give a multiple definition error. If, on | |
4354 | the other hand, the program defines @samp{etext} (with no leading | |
4355 | underscore), the linker will silently use the definition in the program. | |
4356 | If the program references @samp{etext} but does not define it, the | |
4357 | linker will use the definition in the linker script. | |
4358 | ||
b0daac83 NC |
4359 | Note - the @code{PROVIDE} directive considers a common symbol to be |
4360 | defined, even though such a symbol could be combined with the symbol | |
4361 | that the @code{PROVIDE} would create. This is particularly important | |
4362 | when considering constructor and destructor list symbols such as | |
4363 | @samp{__CTOR_LIST__} as these are often defined as common symbols. | |
4364 | ||
7af8e998 L |
4365 | @node PROVIDE_HIDDEN |
4366 | @subsection PROVIDE_HIDDEN | |
4367 | @cindex PROVIDE_HIDDEN | |
4368 | Similar to @code{PROVIDE}. For ELF targeted ports, the symbol will be | |
4369 | hidden and won't be exported. | |
4370 | ||
73ae6183 NC |
4371 | @node Source Code Reference |
4372 | @subsection Source Code Reference | |
4373 | ||
4374 | Accessing a linker script defined variable from source code is not | |
4375 | intuitive. In particular a linker script symbol is not equivalent to | |
4376 | a variable declaration in a high level language, it is instead a | |
4377 | symbol that does not have a value. | |
4378 | ||
4379 | Before going further, it is important to note that compilers often | |
4380 | transform names in the source code into different names when they are | |
4381 | stored in the symbol table. For example, Fortran compilers commonly | |
4382 | prepend or append an underscore, and C++ performs extensive @samp{name | |
4383 | mangling}. Therefore there might be a discrepancy between the name | |
4384 | of a variable as it is used in source code and the name of the same | |
4385 | variable as it is defined in a linker script. For example in C a | |
4386 | linker script variable might be referred to as: | |
4387 | ||
4388 | @smallexample | |
4389 | extern int foo; | |
4390 | @end smallexample | |
4391 | ||
4392 | But in the linker script it might be defined as: | |
4393 | ||
4394 | @smallexample | |
4395 | _foo = 1000; | |
4396 | @end smallexample | |
4397 | ||
4398 | In the remaining examples however it is assumed that no name | |
4399 | transformation has taken place. | |
4400 | ||
4401 | When a symbol is declared in a high level language such as C, two | |
4402 | things happen. The first is that the compiler reserves enough space | |
4403 | in the program's memory to hold the @emph{value} of the symbol. The | |
4404 | second is that the compiler creates an entry in the program's symbol | |
4405 | table which holds the symbol's @emph{address}. ie the symbol table | |
4406 | contains the address of the block of memory holding the symbol's | |
4407 | value. So for example the following C declaration, at file scope: | |
4408 | ||
4409 | @smallexample | |
4410 | int foo = 1000; | |
4411 | @end smallexample | |
4412 | ||
10bf6894 | 4413 | creates an entry called @samp{foo} in the symbol table. This entry |
73ae6183 NC |
4414 | holds the address of an @samp{int} sized block of memory where the |
4415 | number 1000 is initially stored. | |
4416 | ||
4417 | When a program references a symbol the compiler generates code that | |
4418 | first accesses the symbol table to find the address of the symbol's | |
4419 | memory block and then code to read the value from that memory block. | |
4420 | So: | |
4421 | ||
4422 | @smallexample | |
4423 | foo = 1; | |
4424 | @end smallexample | |
4425 | ||
4426 | looks up the symbol @samp{foo} in the symbol table, gets the address | |
4427 | associated with this symbol and then writes the value 1 into that | |
4428 | address. Whereas: | |
4429 | ||
4430 | @smallexample | |
4431 | int * a = & foo; | |
4432 | @end smallexample | |
4433 | ||
10bf6894 | 4434 | looks up the symbol @samp{foo} in the symbol table, gets its address |
73ae6183 NC |
4435 | and then copies this address into the block of memory associated with |
4436 | the variable @samp{a}. | |
4437 | ||
4438 | Linker scripts symbol declarations, by contrast, create an entry in | |
4439 | the symbol table but do not assign any memory to them. Thus they are | |
4440 | an address without a value. So for example the linker script definition: | |
4441 | ||
4442 | @smallexample | |
4443 | foo = 1000; | |
4444 | @end smallexample | |
4445 | ||
4446 | creates an entry in the symbol table called @samp{foo} which holds | |
4447 | the address of memory location 1000, but nothing special is stored at | |
4448 | address 1000. This means that you cannot access the @emph{value} of a | |
4449 | linker script defined symbol - it has no value - all you can do is | |
4450 | access the @emph{address} of a linker script defined symbol. | |
4451 | ||
4452 | Hence when you are using a linker script defined symbol in source code | |
4453 | you should always take the address of the symbol, and never attempt to | |
4454 | use its value. For example suppose you want to copy the contents of a | |
4455 | section of memory called .ROM into a section called .FLASH and the | |
4456 | linker script contains these declarations: | |
4457 | ||
4458 | @smallexample | |
4459 | @group | |
4460 | start_of_ROM = .ROM; | |
a5e406b5 | 4461 | end_of_ROM = .ROM + sizeof (.ROM); |
73ae6183 NC |
4462 | start_of_FLASH = .FLASH; |
4463 | @end group | |
4464 | @end smallexample | |
4465 | ||
4466 | Then the C source code to perform the copy would be: | |
4467 | ||
4468 | @smallexample | |
4469 | @group | |
4470 | extern char start_of_ROM, end_of_ROM, start_of_FLASH; | |
c0065db7 | 4471 | |
73ae6183 NC |
4472 | memcpy (& start_of_FLASH, & start_of_ROM, & end_of_ROM - & start_of_ROM); |
4473 | @end group | |
4474 | @end smallexample | |
4475 | ||
4476 | Note the use of the @samp{&} operators. These are correct. | |
5707d2ad NC |
4477 | Alternatively the symbols can be treated as the names of vectors or |
4478 | arrays and then the code will again work as expected: | |
4479 | ||
4480 | @smallexample | |
4481 | @group | |
4482 | extern char start_of_ROM[], end_of_ROM[], start_of_FLASH[]; | |
4483 | ||
4484 | memcpy (start_of_FLASH, start_of_ROM, end_of_ROM - start_of_ROM); | |
4485 | @end group | |
4486 | @end smallexample | |
4487 | ||
4488 | Note how using this method does not require the use of @samp{&} | |
4489 | operators. | |
73ae6183 | 4490 | |
252b5132 | 4491 | @node SECTIONS |
36f63dca | 4492 | @section SECTIONS Command |
252b5132 RH |
4493 | @kindex SECTIONS |
4494 | The @code{SECTIONS} command tells the linker how to map input sections | |
4495 | into output sections, and how to place the output sections in memory. | |
4496 | ||
4497 | The format of the @code{SECTIONS} command is: | |
4498 | @smallexample | |
4499 | SECTIONS | |
4500 | @{ | |
4501 | @var{sections-command} | |
4502 | @var{sections-command} | |
4503 | @dots{} | |
4504 | @} | |
4505 | @end smallexample | |
4506 | ||
4507 | Each @var{sections-command} may of be one of the following: | |
4508 | ||
4509 | @itemize @bullet | |
4510 | @item | |
4511 | an @code{ENTRY} command (@pxref{Entry Point,,Entry command}) | |
4512 | @item | |
4513 | a symbol assignment (@pxref{Assignments}) | |
4514 | @item | |
4515 | an output section description | |
4516 | @item | |
4517 | an overlay description | |
4518 | @end itemize | |
4519 | ||
4520 | The @code{ENTRY} command and symbol assignments are permitted inside the | |
4521 | @code{SECTIONS} command for convenience in using the location counter in | |
4522 | those commands. This can also make the linker script easier to | |
4523 | understand because you can use those commands at meaningful points in | |
4524 | the layout of the output file. | |
4525 | ||
4526 | Output section descriptions and overlay descriptions are described | |
4527 | below. | |
4528 | ||
4529 | If you do not use a @code{SECTIONS} command in your linker script, the | |
4530 | linker will place each input section into an identically named output | |
4531 | section in the order that the sections are first encountered in the | |
4532 | input files. If all input sections are present in the first file, for | |
4533 | example, the order of sections in the output file will match the order | |
4534 | in the first input file. The first section will be at address zero. | |
4535 | ||
4536 | @menu | |
4537 | * Output Section Description:: Output section description | |
4538 | * Output Section Name:: Output section name | |
4539 | * Output Section Address:: Output section address | |
4540 | * Input Section:: Input section description | |
4541 | * Output Section Data:: Output section data | |
4542 | * Output Section Keywords:: Output section keywords | |
4543 | * Output Section Discarding:: Output section discarding | |
4544 | * Output Section Attributes:: Output section attributes | |
4545 | * Overlay Description:: Overlay description | |
4546 | @end menu | |
4547 | ||
4548 | @node Output Section Description | |
36f63dca | 4549 | @subsection Output Section Description |
252b5132 RH |
4550 | The full description of an output section looks like this: |
4551 | @smallexample | |
a1ab1d2a | 4552 | @group |
7e7d5768 | 4553 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 | 4554 | [AT(@var{lma})] |
1eec346e | 4555 | [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT] |
0c71d759 NC |
4556 | [SUBALIGN(@var{subsection_align})] |
4557 | [@var{constraint}] | |
252b5132 RH |
4558 | @{ |
4559 | @var{output-section-command} | |
4560 | @var{output-section-command} | |
4561 | @dots{} | |
abc9061b | 4562 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] [,] |
252b5132 RH |
4563 | @end group |
4564 | @end smallexample | |
4565 | ||
4566 | Most output sections do not use most of the optional section attributes. | |
4567 | ||
4568 | The whitespace around @var{section} is required, so that the section | |
4569 | name is unambiguous. The colon and the curly braces are also required. | |
abc9061b CC |
4570 | The comma at the end may be required if a @var{fillexp} is used and |
4571 | the next @var{sections-command} looks like a continuation of the expression. | |
252b5132 RH |
4572 | The line breaks and other white space are optional. |
4573 | ||
4574 | Each @var{output-section-command} may be one of the following: | |
4575 | ||
4576 | @itemize @bullet | |
4577 | @item | |
4578 | a symbol assignment (@pxref{Assignments}) | |
4579 | @item | |
4580 | an input section description (@pxref{Input Section}) | |
4581 | @item | |
4582 | data values to include directly (@pxref{Output Section Data}) | |
4583 | @item | |
4584 | a special output section keyword (@pxref{Output Section Keywords}) | |
4585 | @end itemize | |
4586 | ||
4587 | @node Output Section Name | |
36f63dca | 4588 | @subsection Output Section Name |
252b5132 RH |
4589 | @cindex name, section |
4590 | @cindex section name | |
4591 | The name of the output section is @var{section}. @var{section} must | |
4592 | meet the constraints of your output format. In formats which only | |
4593 | support a limited number of sections, such as @code{a.out}, the name | |
4594 | must be one of the names supported by the format (@code{a.out}, for | |
4595 | example, allows only @samp{.text}, @samp{.data} or @samp{.bss}). If the | |
4596 | output format supports any number of sections, but with numbers and not | |
4597 | names (as is the case for Oasys), the name should be supplied as a | |
4598 | quoted numeric string. A section name may consist of any sequence of | |
4599 | characters, but a name which contains any unusual characters such as | |
4600 | commas must be quoted. | |
4601 | ||
4602 | The output section name @samp{/DISCARD/} is special; @ref{Output Section | |
4603 | Discarding}. | |
4604 | ||
4605 | @node Output Section Address | |
2a16d82a | 4606 | @subsection Output Section Address |
252b5132 RH |
4607 | @cindex address, section |
4608 | @cindex section address | |
4609 | The @var{address} is an expression for the VMA (the virtual memory | |
ea5cae92 NC |
4610 | address) of the output section. This address is optional, but if it |
4611 | is provided then the output address will be set exactly as specified. | |
4612 | ||
4613 | If the output address is not specified then one will be chosen for the | |
4614 | section, based on the heuristic below. This address will be adjusted | |
4615 | to fit the alignment requirement of the output section. The | |
4616 | alignment requirement is the strictest alignment of any input section | |
4617 | contained within the output section. | |
4618 | ||
4619 | The output section address heuristic is as follows: | |
4620 | ||
4621 | @itemize @bullet | |
4622 | @item | |
4623 | If an output memory @var{region} is set for the section then it | |
4624 | is added to this region and its address will be the next free address | |
4625 | in that region. | |
4626 | ||
4627 | @item | |
4628 | If the MEMORY command has been used to create a list of memory | |
4629 | regions then the first region which has attributes compatible with the | |
4630 | section is selected to contain it. The section's output address will | |
4631 | be the next free address in that region; @ref{MEMORY}. | |
4632 | ||
4633 | @item | |
4634 | If no memory regions were specified, or none match the section then | |
4635 | the output address will be based on the current value of the location | |
4636 | counter. | |
4637 | @end itemize | |
4638 | ||
4639 | @noindent | |
4640 | For example: | |
4641 | ||
252b5132 RH |
4642 | @smallexample |
4643 | .text . : @{ *(.text) @} | |
4644 | @end smallexample | |
ea5cae92 | 4645 | |
252b5132 RH |
4646 | @noindent |
4647 | and | |
ea5cae92 | 4648 | |
252b5132 RH |
4649 | @smallexample |
4650 | .text : @{ *(.text) @} | |
4651 | @end smallexample | |
ea5cae92 | 4652 | |
252b5132 RH |
4653 | @noindent |
4654 | are subtly different. The first will set the address of the | |
4655 | @samp{.text} output section to the current value of the location | |
4656 | counter. The second will set it to the current value of the location | |
ea5cae92 NC |
4657 | counter aligned to the strictest alignment of any of the @samp{.text} |
4658 | input sections. | |
252b5132 RH |
4659 | |
4660 | The @var{address} may be an arbitrary expression; @ref{Expressions}. | |
4661 | For example, if you want to align the section on a 0x10 byte boundary, | |
4662 | so that the lowest four bits of the section address are zero, you could | |
4663 | do something like this: | |
4664 | @smallexample | |
4665 | .text ALIGN(0x10) : @{ *(.text) @} | |
4666 | @end smallexample | |
4667 | @noindent | |
4668 | This works because @code{ALIGN} returns the current location counter | |
4669 | aligned upward to the specified value. | |
4670 | ||
4671 | Specifying @var{address} for a section will change the value of the | |
6ce340f1 NC |
4672 | location counter, provided that the section is non-empty. (Empty |
4673 | sections are ignored). | |
252b5132 RH |
4674 | |
4675 | @node Input Section | |
36f63dca | 4676 | @subsection Input Section Description |
252b5132 RH |
4677 | @cindex input sections |
4678 | @cindex mapping input sections to output sections | |
4679 | The most common output section command is an input section description. | |
4680 | ||
4681 | The input section description is the most basic linker script operation. | |
4682 | You use output sections to tell the linker how to lay out your program | |
4683 | in memory. You use input section descriptions to tell the linker how to | |
4684 | map the input files into your memory layout. | |
4685 | ||
4686 | @menu | |
4687 | * Input Section Basics:: Input section basics | |
4688 | * Input Section Wildcards:: Input section wildcard patterns | |
4689 | * Input Section Common:: Input section for common symbols | |
4690 | * Input Section Keep:: Input section and garbage collection | |
4691 | * Input Section Example:: Input section example | |
4692 | @end menu | |
4693 | ||
4694 | @node Input Section Basics | |
36f63dca | 4695 | @subsubsection Input Section Basics |
252b5132 RH |
4696 | @cindex input section basics |
4697 | An input section description consists of a file name optionally followed | |
4698 | by a list of section names in parentheses. | |
4699 | ||
4700 | The file name and the section name may be wildcard patterns, which we | |
4701 | describe further below (@pxref{Input Section Wildcards}). | |
4702 | ||
4703 | The most common input section description is to include all input | |
4704 | sections with a particular name in the output section. For example, to | |
4705 | include all input @samp{.text} sections, you would write: | |
4706 | @smallexample | |
4707 | *(.text) | |
4708 | @end smallexample | |
4709 | @noindent | |
18625d54 | 4710 | Here the @samp{*} is a wildcard which matches any file name. To exclude a list |
8f1732fc | 4711 | @cindex EXCLUDE_FILE |
18625d54 CM |
4712 | of files from matching the file name wildcard, EXCLUDE_FILE may be used to |
4713 | match all files except the ones specified in the EXCLUDE_FILE list. For | |
4714 | example: | |
252b5132 | 4715 | @smallexample |
8f1732fc AB |
4716 | EXCLUDE_FILE (*crtend.o *otherfile.o) *(.ctors) |
4717 | @end smallexample | |
4718 | @noindent | |
4719 | will cause all .ctors sections from all files except @file{crtend.o} | |
4720 | and @file{otherfile.o} to be included. The EXCLUDE_FILE can also be | |
4721 | placed inside the section list, for example: | |
4722 | @smallexample | |
b4346c09 | 4723 | *(EXCLUDE_FILE (*crtend.o *otherfile.o) .ctors) |
252b5132 | 4724 | @end smallexample |
8f1732fc AB |
4725 | @noindent |
4726 | The result of this is identically to the previous example. Supporting | |
4727 | two syntaxes for EXCLUDE_FILE is useful if the section list contains | |
4728 | more than one section, as described below. | |
252b5132 RH |
4729 | |
4730 | There are two ways to include more than one section: | |
4731 | @smallexample | |
4732 | *(.text .rdata) | |
4733 | *(.text) *(.rdata) | |
4734 | @end smallexample | |
4735 | @noindent | |
4736 | The difference between these is the order in which the @samp{.text} and | |
4737 | @samp{.rdata} input sections will appear in the output section. In the | |
b6bf44ba AM |
4738 | first example, they will be intermingled, appearing in the same order as |
4739 | they are found in the linker input. In the second example, all | |
252b5132 RH |
4740 | @samp{.text} input sections will appear first, followed by all |
4741 | @samp{.rdata} input sections. | |
4742 | ||
8f1732fc AB |
4743 | When using EXCLUDE_FILE with more than one section, if the exclusion |
4744 | is within the section list then the exclusion only applies to the | |
4745 | immediately following section, for example: | |
a5bf7d4f AB |
4746 | @smallexample |
4747 | *(EXCLUDE_FILE (*somefile.o) .text .rdata) | |
4748 | @end smallexample | |
4749 | @noindent | |
4750 | will cause all @samp{.text} sections from all files except | |
4751 | @file{somefile.o} to be included, while all @samp{.rdata} sections | |
4752 | from all files, including @file{somefile.o}, will be included. To | |
4753 | exclude the @samp{.rdata} sections from @file{somefile.o} the example | |
8f1732fc | 4754 | could be modified to: |
a5bf7d4f AB |
4755 | @smallexample |
4756 | *(EXCLUDE_FILE (*somefile.o) .text EXCLUDE_FILE (*somefile.o) .rdata) | |
4757 | @end smallexample | |
8f1732fc AB |
4758 | @noindent |
4759 | Alternatively, placing the EXCLUDE_FILE outside of the section list, | |
4760 | before the input file selection, will cause the exclusion to apply for | |
4761 | all sections. Thus the previous example can be rewritten as: | |
4762 | @smallexample | |
4763 | EXCLUDE_FILE (*somefile.o) *(.text .rdata) | |
4764 | @end smallexample | |
a5bf7d4f | 4765 | |
252b5132 RH |
4766 | You can specify a file name to include sections from a particular file. |
4767 | You would do this if one or more of your files contain special data that | |
4768 | needs to be at a particular location in memory. For example: | |
4769 | @smallexample | |
4770 | data.o(.data) | |
4771 | @end smallexample | |
4772 | ||
ae17ab41 CM |
4773 | To refine the sections that are included based on the section flags |
4774 | of an input section, INPUT_SECTION_FLAGS may be used. | |
4775 | ||
4776 | Here is a simple example for using Section header flags for ELF sections: | |
4777 | ||
4778 | @smallexample | |
4779 | @group | |
4780 | SECTIONS @{ | |
4781 | .text : @{ INPUT_SECTION_FLAGS (SHF_MERGE & SHF_STRINGS) *(.text) @} | |
4782 | .text2 : @{ INPUT_SECTION_FLAGS (!SHF_WRITE) *(.text) @} | |
4783 | @} | |
4784 | @end group | |
4785 | @end smallexample | |
4786 | ||
4787 | In this example, the output section @samp{.text} will be comprised of any | |
4788 | input section matching the name *(.text) whose section header flags | |
4789 | @code{SHF_MERGE} and @code{SHF_STRINGS} are set. The output section | |
4790 | @samp{.text2} will be comprised of any input section matching the name *(.text) | |
4791 | whose section header flag @code{SHF_WRITE} is clear. | |
4792 | ||
967928e9 AM |
4793 | You can also specify files within archives by writing a pattern |
4794 | matching the archive, a colon, then the pattern matching the file, | |
4795 | with no whitespace around the colon. | |
4796 | ||
4797 | @table @samp | |
4798 | @item archive:file | |
4799 | matches file within archive | |
4800 | @item archive: | |
4801 | matches the whole archive | |
4802 | @item :file | |
4803 | matches file but not one in an archive | |
4804 | @end table | |
4805 | ||
4806 | Either one or both of @samp{archive} and @samp{file} can contain shell | |
4807 | wildcards. On DOS based file systems, the linker will assume that a | |
4808 | single letter followed by a colon is a drive specifier, so | |
4809 | @samp{c:myfile.o} is a simple file specification, not @samp{myfile.o} | |
4810 | within an archive called @samp{c}. @samp{archive:file} filespecs may | |
4811 | also be used within an @code{EXCLUDE_FILE} list, but may not appear in | |
4812 | other linker script contexts. For instance, you cannot extract a file | |
4813 | from an archive by using @samp{archive:file} in an @code{INPUT} | |
4814 | command. | |
4815 | ||
252b5132 RH |
4816 | If you use a file name without a list of sections, then all sections in |
4817 | the input file will be included in the output section. This is not | |
4818 | commonly done, but it may by useful on occasion. For example: | |
4819 | @smallexample | |
4820 | data.o | |
4821 | @end smallexample | |
4822 | ||
967928e9 AM |
4823 | When you use a file name which is not an @samp{archive:file} specifier |
4824 | and does not contain any wild card | |
252b5132 RH |
4825 | characters, the linker will first see if you also specified the file |
4826 | name on the linker command line or in an @code{INPUT} command. If you | |
4827 | did not, the linker will attempt to open the file as an input file, as | |
4828 | though it appeared on the command line. Note that this differs from an | |
4829 | @code{INPUT} command, because the linker will not search for the file in | |
4830 | the archive search path. | |
4831 | ||
4832 | @node Input Section Wildcards | |
36f63dca | 4833 | @subsubsection Input Section Wildcard Patterns |
252b5132 RH |
4834 | @cindex input section wildcards |
4835 | @cindex wildcard file name patterns | |
4836 | @cindex file name wildcard patterns | |
4837 | @cindex section name wildcard patterns | |
4838 | In an input section description, either the file name or the section | |
4839 | name or both may be wildcard patterns. | |
4840 | ||
4841 | The file name of @samp{*} seen in many examples is a simple wildcard | |
4842 | pattern for the file name. | |
4843 | ||
4844 | The wildcard patterns are like those used by the Unix shell. | |
4845 | ||
4846 | @table @samp | |
4847 | @item * | |
4848 | matches any number of characters | |
4849 | @item ? | |
4850 | matches any single character | |
4851 | @item [@var{chars}] | |
4852 | matches a single instance of any of the @var{chars}; the @samp{-} | |
4853 | character may be used to specify a range of characters, as in | |
4854 | @samp{[a-z]} to match any lower case letter | |
4855 | @item \ | |
4856 | quotes the following character | |
4857 | @end table | |
4858 | ||
4859 | When a file name is matched with a wildcard, the wildcard characters | |
4860 | will not match a @samp{/} character (used to separate directory names on | |
4861 | Unix). A pattern consisting of a single @samp{*} character is an | |
4862 | exception; it will always match any file name, whether it contains a | |
4863 | @samp{/} or not. In a section name, the wildcard characters will match | |
4864 | a @samp{/} character. | |
4865 | ||
4866 | File name wildcard patterns only match files which are explicitly | |
4867 | specified on the command line or in an @code{INPUT} command. The linker | |
4868 | does not search directories to expand wildcards. | |
4869 | ||
4870 | If a file name matches more than one wildcard pattern, or if a file name | |
4871 | appears explicitly and is also matched by a wildcard pattern, the linker | |
4872 | will use the first match in the linker script. For example, this | |
4873 | sequence of input section descriptions is probably in error, because the | |
4874 | @file{data.o} rule will not be used: | |
4875 | @smallexample | |
4876 | .data : @{ *(.data) @} | |
4877 | .data1 : @{ data.o(.data) @} | |
4878 | @end smallexample | |
4879 | ||
bcaa7b3e | 4880 | @cindex SORT_BY_NAME |
252b5132 RH |
4881 | Normally, the linker will place files and sections matched by wildcards |
4882 | in the order in which they are seen during the link. You can change | |
bcaa7b3e L |
4883 | this by using the @code{SORT_BY_NAME} keyword, which appears before a wildcard |
4884 | pattern in parentheses (e.g., @code{SORT_BY_NAME(.text*)}). When the | |
4885 | @code{SORT_BY_NAME} keyword is used, the linker will sort the files or sections | |
252b5132 RH |
4886 | into ascending order by name before placing them in the output file. |
4887 | ||
bcaa7b3e | 4888 | @cindex SORT_BY_ALIGNMENT |
9a24a276 AM |
4889 | @code{SORT_BY_ALIGNMENT} is similar to @code{SORT_BY_NAME}. |
4890 | @code{SORT_BY_ALIGNMENT} will sort sections into descending order of | |
4891 | alignment before placing them in the output file. Placing larger | |
4892 | alignments before smaller alignments can reduce the amount of padding | |
4893 | needed. | |
bcaa7b3e | 4894 | |
02ecc8e9 | 4895 | @cindex SORT_BY_INIT_PRIORITY |
9a24a276 AM |
4896 | @code{SORT_BY_INIT_PRIORITY} is also similar to @code{SORT_BY_NAME}. |
4897 | @code{SORT_BY_INIT_PRIORITY} will sort sections into ascending | |
4898 | numerical order of the GCC init_priority attribute encoded in the | |
4899 | section name before placing them in the output file. In | |
4900 | @code{.init_array.NNNNN} and @code{.fini_array.NNNNN}, @code{NNNNN} is | |
4901 | the init_priority. In @code{.ctors.NNNNN} and @code{.dtors.NNNNN}, | |
4902 | @code{NNNNN} is 65535 minus the init_priority. | |
02ecc8e9 | 4903 | |
bcaa7b3e L |
4904 | @cindex SORT |
4905 | @code{SORT} is an alias for @code{SORT_BY_NAME}. | |
4906 | ||
4907 | When there are nested section sorting commands in linker script, there | |
4908 | can be at most 1 level of nesting for section sorting commands. | |
4909 | ||
4910 | @enumerate | |
4911 | @item | |
4912 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
1ae5c3ae | 4913 | It will sort the input sections by name first, then by alignment if two |
bcaa7b3e L |
4914 | sections have the same name. |
4915 | @item | |
4916 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
1ae5c3ae | 4917 | It will sort the input sections by alignment first, then by name if two |
bcaa7b3e L |
4918 | sections have the same alignment. |
4919 | @item | |
c0065db7 | 4920 | @code{SORT_BY_NAME} (@code{SORT_BY_NAME} (wildcard section pattern)) is |
bcaa7b3e L |
4921 | treated the same as @code{SORT_BY_NAME} (wildcard section pattern). |
4922 | @item | |
4923 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)) | |
4924 | is treated the same as @code{SORT_BY_ALIGNMENT} (wildcard section pattern). | |
4925 | @item | |
4926 | All other nested section sorting commands are invalid. | |
4927 | @end enumerate | |
4928 | ||
a05a5b64 | 4929 | When both command-line section sorting option and linker script |
bcaa7b3e | 4930 | section sorting command are used, section sorting command always |
a05a5b64 | 4931 | takes precedence over the command-line option. |
bcaa7b3e L |
4932 | |
4933 | If the section sorting command in linker script isn't nested, the | |
a05a5b64 | 4934 | command-line option will make the section sorting command to be |
bcaa7b3e L |
4935 | treated as nested sorting command. |
4936 | ||
4937 | @enumerate | |
4938 | @item | |
4939 | @code{SORT_BY_NAME} (wildcard section pattern ) with | |
4940 | @option{--sort-sections alignment} is equivalent to | |
4941 | @code{SORT_BY_NAME} (@code{SORT_BY_ALIGNMENT} (wildcard section pattern)). | |
4942 | @item | |
4943 | @code{SORT_BY_ALIGNMENT} (wildcard section pattern) with | |
4944 | @option{--sort-section name} is equivalent to | |
4945 | @code{SORT_BY_ALIGNMENT} (@code{SORT_BY_NAME} (wildcard section pattern)). | |
4946 | @end enumerate | |
4947 | ||
4948 | If the section sorting command in linker script is nested, the | |
a05a5b64 | 4949 | command-line option will be ignored. |
bcaa7b3e | 4950 | |
eda680f8 | 4951 | @cindex SORT_NONE |
a05a5b64 | 4952 | @code{SORT_NONE} disables section sorting by ignoring the command-line |
eda680f8 L |
4953 | section sorting option. |
4954 | ||
252b5132 RH |
4955 | If you ever get confused about where input sections are going, use the |
4956 | @samp{-M} linker option to generate a map file. The map file shows | |
4957 | precisely how input sections are mapped to output sections. | |
4958 | ||
4959 | This example shows how wildcard patterns might be used to partition | |
4960 | files. This linker script directs the linker to place all @samp{.text} | |
4961 | sections in @samp{.text} and all @samp{.bss} sections in @samp{.bss}. | |
4962 | The linker will place the @samp{.data} section from all files beginning | |
4963 | with an upper case character in @samp{.DATA}; for all other files, the | |
4964 | linker will place the @samp{.data} section in @samp{.data}. | |
4965 | @smallexample | |
4966 | @group | |
4967 | SECTIONS @{ | |
4968 | .text : @{ *(.text) @} | |
4969 | .DATA : @{ [A-Z]*(.data) @} | |
4970 | .data : @{ *(.data) @} | |
4971 | .bss : @{ *(.bss) @} | |
4972 | @} | |
4973 | @end group | |
4974 | @end smallexample | |
4975 | ||
4976 | @node Input Section Common | |
36f63dca | 4977 | @subsubsection Input Section for Common Symbols |
252b5132 RH |
4978 | @cindex common symbol placement |
4979 | @cindex uninitialized data placement | |
4980 | A special notation is needed for common symbols, because in many object | |
4981 | file formats common symbols do not have a particular input section. The | |
4982 | linker treats common symbols as though they are in an input section | |
4983 | named @samp{COMMON}. | |
4984 | ||
4985 | You may use file names with the @samp{COMMON} section just as with any | |
4986 | other input sections. You can use this to place common symbols from a | |
4987 | particular input file in one section while common symbols from other | |
4988 | input files are placed in another section. | |
4989 | ||
4990 | In most cases, common symbols in input files will be placed in the | |
4991 | @samp{.bss} section in the output file. For example: | |
4992 | @smallexample | |
4993 | .bss @{ *(.bss) *(COMMON) @} | |
4994 | @end smallexample | |
4995 | ||
4996 | @cindex scommon section | |
4997 | @cindex small common symbols | |
4998 | Some object file formats have more than one type of common symbol. For | |
4999 | example, the MIPS ELF object file format distinguishes standard common | |
5000 | symbols and small common symbols. In this case, the linker will use a | |
5001 | different special section name for other types of common symbols. In | |
5002 | the case of MIPS ELF, the linker uses @samp{COMMON} for standard common | |
5003 | symbols and @samp{.scommon} for small common symbols. This permits you | |
5004 | to map the different types of common symbols into memory at different | |
5005 | locations. | |
5006 | ||
5007 | @cindex [COMMON] | |
5008 | You will sometimes see @samp{[COMMON]} in old linker scripts. This | |
5009 | notation is now considered obsolete. It is equivalent to | |
5010 | @samp{*(COMMON)}. | |
5011 | ||
5012 | @node Input Section Keep | |
36f63dca | 5013 | @subsubsection Input Section and Garbage Collection |
252b5132 RH |
5014 | @cindex KEEP |
5015 | @cindex garbage collection | |
5016 | When link-time garbage collection is in use (@samp{--gc-sections}), | |
a1ab1d2a | 5017 | it is often useful to mark sections that should not be eliminated. |
252b5132 RH |
5018 | This is accomplished by surrounding an input section's wildcard entry |
5019 | with @code{KEEP()}, as in @code{KEEP(*(.init))} or | |
bcaa7b3e | 5020 | @code{KEEP(SORT_BY_NAME(*)(.ctors))}. |
252b5132 RH |
5021 | |
5022 | @node Input Section Example | |
36f63dca | 5023 | @subsubsection Input Section Example |
252b5132 RH |
5024 | The following example is a complete linker script. It tells the linker |
5025 | to read all of the sections from file @file{all.o} and place them at the | |
5026 | start of output section @samp{outputa} which starts at location | |
5027 | @samp{0x10000}. All of section @samp{.input1} from file @file{foo.o} | |
5028 | follows immediately, in the same output section. All of section | |
5029 | @samp{.input2} from @file{foo.o} goes into output section | |
5030 | @samp{outputb}, followed by section @samp{.input1} from @file{foo1.o}. | |
5031 | All of the remaining @samp{.input1} and @samp{.input2} sections from any | |
5032 | files are written to output section @samp{outputc}. | |
5033 | ||
5034 | @smallexample | |
5035 | @group | |
5036 | SECTIONS @{ | |
5037 | outputa 0x10000 : | |
5038 | @{ | |
5039 | all.o | |
5040 | foo.o (.input1) | |
5041 | @} | |
36f63dca NC |
5042 | @end group |
5043 | @group | |
252b5132 RH |
5044 | outputb : |
5045 | @{ | |
5046 | foo.o (.input2) | |
5047 | foo1.o (.input1) | |
5048 | @} | |
36f63dca NC |
5049 | @end group |
5050 | @group | |
252b5132 RH |
5051 | outputc : |
5052 | @{ | |
5053 | *(.input1) | |
5054 | *(.input2) | |
5055 | @} | |
5056 | @} | |
5057 | @end group | |
a1ab1d2a | 5058 | @end smallexample |
252b5132 | 5059 | |
cbd0eecf L |
5060 | If an output section's name is the same as the input section's name |
5061 | and is representable as a C identifier, then the linker will | |
5062 | automatically @pxref{PROVIDE} two symbols: __start_SECNAME and | |
5063 | __stop_SECNAME, where SECNAME is the name of the section. These | |
5064 | indicate the start address and end address of the output section | |
5065 | respectively. Note: most section names are not representable as | |
5066 | C identifiers because they contain a @samp{.} character. | |
5067 | ||
252b5132 | 5068 | @node Output Section Data |
36f63dca | 5069 | @subsection Output Section Data |
252b5132 RH |
5070 | @cindex data |
5071 | @cindex section data | |
5072 | @cindex output section data | |
5073 | @kindex BYTE(@var{expression}) | |
5074 | @kindex SHORT(@var{expression}) | |
5075 | @kindex LONG(@var{expression}) | |
5076 | @kindex QUAD(@var{expression}) | |
5077 | @kindex SQUAD(@var{expression}) | |
5078 | You can include explicit bytes of data in an output section by using | |
5079 | @code{BYTE}, @code{SHORT}, @code{LONG}, @code{QUAD}, or @code{SQUAD} as | |
5080 | an output section command. Each keyword is followed by an expression in | |
5081 | parentheses providing the value to store (@pxref{Expressions}). The | |
5082 | value of the expression is stored at the current value of the location | |
5083 | counter. | |
5084 | ||
5085 | The @code{BYTE}, @code{SHORT}, @code{LONG}, and @code{QUAD} commands | |
5086 | store one, two, four, and eight bytes (respectively). After storing the | |
5087 | bytes, the location counter is incremented by the number of bytes | |
5088 | stored. | |
5089 | ||
5090 | For example, this will store the byte 1 followed by the four byte value | |
5091 | of the symbol @samp{addr}: | |
5092 | @smallexample | |
5093 | BYTE(1) | |
5094 | LONG(addr) | |
5095 | @end smallexample | |
5096 | ||
5097 | When using a 64 bit host or target, @code{QUAD} and @code{SQUAD} are the | |
5098 | same; they both store an 8 byte, or 64 bit, value. When both host and | |
5099 | target are 32 bits, an expression is computed as 32 bits. In this case | |
5100 | @code{QUAD} stores a 32 bit value zero extended to 64 bits, and | |
5101 | @code{SQUAD} stores a 32 bit value sign extended to 64 bits. | |
5102 | ||
5103 | If the object file format of the output file has an explicit endianness, | |
5104 | which is the normal case, the value will be stored in that endianness. | |
5105 | When the object file format does not have an explicit endianness, as is | |
5106 | true of, for example, S-records, the value will be stored in the | |
5107 | endianness of the first input object file. | |
5108 | ||
36f63dca | 5109 | Note---these commands only work inside a section description and not |
2b5fc1f5 NC |
5110 | between them, so the following will produce an error from the linker: |
5111 | @smallexample | |
5112 | SECTIONS @{@ .text : @{@ *(.text) @}@ LONG(1) .data : @{@ *(.data) @}@ @}@ | |
5113 | @end smallexample | |
5114 | whereas this will work: | |
5115 | @smallexample | |
5116 | SECTIONS @{@ .text : @{@ *(.text) ; LONG(1) @}@ .data : @{@ *(.data) @}@ @}@ | |
5117 | @end smallexample | |
5118 | ||
252b5132 RH |
5119 | @kindex FILL(@var{expression}) |
5120 | @cindex holes, filling | |
5121 | @cindex unspecified memory | |
5122 | You may use the @code{FILL} command to set the fill pattern for the | |
5123 | current section. It is followed by an expression in parentheses. Any | |
5124 | otherwise unspecified regions of memory within the section (for example, | |
5125 | gaps left due to the required alignment of input sections) are filled | |
a139d329 | 5126 | with the value of the expression, repeated as |
252b5132 RH |
5127 | necessary. A @code{FILL} statement covers memory locations after the |
5128 | point at which it occurs in the section definition; by including more | |
5129 | than one @code{FILL} statement, you can have different fill patterns in | |
5130 | different parts of an output section. | |
5131 | ||
5132 | This example shows how to fill unspecified regions of memory with the | |
563e308f | 5133 | value @samp{0x90}: |
252b5132 | 5134 | @smallexample |
563e308f | 5135 | FILL(0x90909090) |
252b5132 RH |
5136 | @end smallexample |
5137 | ||
5138 | The @code{FILL} command is similar to the @samp{=@var{fillexp}} output | |
9673c93c | 5139 | section attribute, but it only affects the |
252b5132 RH |
5140 | part of the section following the @code{FILL} command, rather than the |
5141 | entire section. If both are used, the @code{FILL} command takes | |
9673c93c | 5142 | precedence. @xref{Output Section Fill}, for details on the fill |
a139d329 | 5143 | expression. |
252b5132 RH |
5144 | |
5145 | @node Output Section Keywords | |
36f63dca | 5146 | @subsection Output Section Keywords |
252b5132 RH |
5147 | There are a couple of keywords which can appear as output section |
5148 | commands. | |
5149 | ||
5150 | @table @code | |
5151 | @kindex CREATE_OBJECT_SYMBOLS | |
5152 | @cindex input filename symbols | |
5153 | @cindex filename symbols | |
5154 | @item CREATE_OBJECT_SYMBOLS | |
5155 | The command tells the linker to create a symbol for each input file. | |
5156 | The name of each symbol will be the name of the corresponding input | |
5157 | file. The section of each symbol will be the output section in which | |
5158 | the @code{CREATE_OBJECT_SYMBOLS} command appears. | |
5159 | ||
5160 | This is conventional for the a.out object file format. It is not | |
5161 | normally used for any other object file format. | |
5162 | ||
5163 | @kindex CONSTRUCTORS | |
5164 | @cindex C++ constructors, arranging in link | |
5165 | @cindex constructors, arranging in link | |
5166 | @item CONSTRUCTORS | |
5167 | When linking using the a.out object file format, the linker uses an | |
5168 | unusual set construct to support C++ global constructors and | |
5169 | destructors. When linking object file formats which do not support | |
5170 | arbitrary sections, such as ECOFF and XCOFF, the linker will | |
5171 | automatically recognize C++ global constructors and destructors by name. | |
5172 | For these object file formats, the @code{CONSTRUCTORS} command tells the | |
5173 | linker to place constructor information in the output section where the | |
5174 | @code{CONSTRUCTORS} command appears. The @code{CONSTRUCTORS} command is | |
5175 | ignored for other object file formats. | |
5176 | ||
5177 | The symbol @w{@code{__CTOR_LIST__}} marks the start of the global | |
7e69709c AM |
5178 | constructors, and the symbol @w{@code{__CTOR_END__}} marks the end. |
5179 | Similarly, @w{@code{__DTOR_LIST__}} and @w{@code{__DTOR_END__}} mark | |
5180 | the start and end of the global destructors. The | |
252b5132 RH |
5181 | first word in the list is the number of entries, followed by the address |
5182 | of each constructor or destructor, followed by a zero word. The | |
5183 | compiler must arrange to actually run the code. For these object file | |
5184 | formats @sc{gnu} C++ normally calls constructors from a subroutine | |
5185 | @code{__main}; a call to @code{__main} is automatically inserted into | |
5186 | the startup code for @code{main}. @sc{gnu} C++ normally runs | |
5187 | destructors either by using @code{atexit}, or directly from the function | |
5188 | @code{exit}. | |
5189 | ||
5190 | For object file formats such as @code{COFF} or @code{ELF} which support | |
5191 | arbitrary section names, @sc{gnu} C++ will normally arrange to put the | |
5192 | addresses of global constructors and destructors into the @code{.ctors} | |
5193 | and @code{.dtors} sections. Placing the following sequence into your | |
5194 | linker script will build the sort of table which the @sc{gnu} C++ | |
5195 | runtime code expects to see. | |
5196 | ||
5197 | @smallexample | |
5198 | __CTOR_LIST__ = .; | |
5199 | LONG((__CTOR_END__ - __CTOR_LIST__) / 4 - 2) | |
5200 | *(.ctors) | |
5201 | LONG(0) | |
5202 | __CTOR_END__ = .; | |
5203 | __DTOR_LIST__ = .; | |
5204 | LONG((__DTOR_END__ - __DTOR_LIST__) / 4 - 2) | |
5205 | *(.dtors) | |
5206 | LONG(0) | |
5207 | __DTOR_END__ = .; | |
5208 | @end smallexample | |
5209 | ||
5210 | If you are using the @sc{gnu} C++ support for initialization priority, | |
5211 | which provides some control over the order in which global constructors | |
5212 | are run, you must sort the constructors at link time to ensure that they | |
5213 | are executed in the correct order. When using the @code{CONSTRUCTORS} | |
bcaa7b3e L |
5214 | command, use @samp{SORT_BY_NAME(CONSTRUCTORS)} instead. When using the |
5215 | @code{.ctors} and @code{.dtors} sections, use @samp{*(SORT_BY_NAME(.ctors))} and | |
5216 | @samp{*(SORT_BY_NAME(.dtors))} instead of just @samp{*(.ctors)} and | |
252b5132 RH |
5217 | @samp{*(.dtors)}. |
5218 | ||
5219 | Normally the compiler and linker will handle these issues automatically, | |
5220 | and you will not need to concern yourself with them. However, you may | |
5221 | need to consider this if you are using C++ and writing your own linker | |
5222 | scripts. | |
5223 | ||
5224 | @end table | |
5225 | ||
5226 | @node Output Section Discarding | |
36f63dca | 5227 | @subsection Output Section Discarding |
252b5132 RH |
5228 | @cindex discarding sections |
5229 | @cindex sections, discarding | |
5230 | @cindex removing sections | |
2edab91c AM |
5231 | The linker will not normally create output sections with no contents. |
5232 | This is for convenience when referring to input sections that may or | |
5233 | may not be present in any of the input files. For example: | |
252b5132 | 5234 | @smallexample |
49c13adb | 5235 | .foo : @{ *(.foo) @} |
252b5132 RH |
5236 | @end smallexample |
5237 | @noindent | |
5238 | will only create a @samp{.foo} section in the output file if there is a | |
74541ad4 AM |
5239 | @samp{.foo} section in at least one input file, and if the input |
5240 | sections are not all empty. Other link script directives that allocate | |
2edab91c AM |
5241 | space in an output section will also create the output section. So |
5242 | too will assignments to dot even if the assignment does not create | |
5243 | space, except for @samp{. = 0}, @samp{. = . + 0}, @samp{. = sym}, | |
5244 | @samp{. = . + sym} and @samp{. = ALIGN (. != 0, expr, 1)} when | |
5245 | @samp{sym} is an absolute symbol of value 0 defined in the script. | |
5246 | This allows you to force output of an empty section with @samp{. = .}. | |
74541ad4 | 5247 | |
a0976ea4 | 5248 | The linker will ignore address assignments (@pxref{Output Section Address}) |
74541ad4 AM |
5249 | on discarded output sections, except when the linker script defines |
5250 | symbols in the output section. In that case the linker will obey | |
a0976ea4 AM |
5251 | the address assignments, possibly advancing dot even though the |
5252 | section is discarded. | |
252b5132 RH |
5253 | |
5254 | @cindex /DISCARD/ | |
5255 | The special output section name @samp{/DISCARD/} may be used to discard | |
5256 | input sections. Any input sections which are assigned to an output | |
5257 | section named @samp{/DISCARD/} are not included in the output file. | |
5258 | ||
a2e098c3 NC |
5259 | Note, sections that match the @samp{/DISCARD/} output section will be |
5260 | discarded even if they are in an ELF section group which has other | |
5261 | members which are not being discarded. This is deliberate. | |
5262 | Discarding takes precedence over grouping. | |
5263 | ||
252b5132 | 5264 | @node Output Section Attributes |
36f63dca | 5265 | @subsection Output Section Attributes |
252b5132 RH |
5266 | @cindex output section attributes |
5267 | We showed above that the full description of an output section looked | |
5268 | like this: | |
0c71d759 | 5269 | |
252b5132 | 5270 | @smallexample |
a1ab1d2a | 5271 | @group |
7e7d5768 | 5272 | @var{section} [@var{address}] [(@var{type})] : |
0c71d759 | 5273 | [AT(@var{lma})] |
3bbec4bd | 5274 | [ALIGN(@var{section_align}) | ALIGN_WITH_INPUT] |
0c71d759 NC |
5275 | [SUBALIGN(@var{subsection_align})] |
5276 | [@var{constraint}] | |
252b5132 RH |
5277 | @{ |
5278 | @var{output-section-command} | |
5279 | @var{output-section-command} | |
5280 | @dots{} | |
562d3460 | 5281 | @} [>@var{region}] [AT>@var{lma_region}] [:@var{phdr} :@var{phdr} @dots{}] [=@var{fillexp}] |
252b5132 RH |
5282 | @end group |
5283 | @end smallexample | |
0c71d759 | 5284 | |
252b5132 RH |
5285 | We've already described @var{section}, @var{address}, and |
5286 | @var{output-section-command}. In this section we will describe the | |
5287 | remaining section attributes. | |
5288 | ||
a1ab1d2a | 5289 | @menu |
252b5132 RH |
5290 | * Output Section Type:: Output section type |
5291 | * Output Section LMA:: Output section LMA | |
bbf115d3 | 5292 | * Forced Output Alignment:: Forced Output Alignment |
7e7d5768 | 5293 | * Forced Input Alignment:: Forced Input Alignment |
0c71d759 | 5294 | * Output Section Constraint:: Output section constraint |
252b5132 RH |
5295 | * Output Section Region:: Output section region |
5296 | * Output Section Phdr:: Output section phdr | |
5297 | * Output Section Fill:: Output section fill | |
5298 | @end menu | |
5299 | ||
5300 | @node Output Section Type | |
36f63dca | 5301 | @subsubsection Output Section Type |
252b5132 RH |
5302 | Each output section may have a type. The type is a keyword in |
5303 | parentheses. The following types are defined: | |
5304 | ||
5305 | @table @code | |
5306 | @item NOLOAD | |
5307 | The section should be marked as not loadable, so that it will not be | |
5308 | loaded into memory when the program is run. | |
5309 | @item DSECT | |
5310 | @itemx COPY | |
5311 | @itemx INFO | |
5312 | @itemx OVERLAY | |
5313 | These type names are supported for backward compatibility, and are | |
5314 | rarely used. They all have the same effect: the section should be | |
5315 | marked as not allocatable, so that no memory is allocated for the | |
5316 | section when the program is run. | |
5317 | @end table | |
5318 | ||
5319 | @kindex NOLOAD | |
5320 | @cindex prevent unnecessary loading | |
5321 | @cindex loading, preventing | |
5322 | The linker normally sets the attributes of an output section based on | |
5323 | the input sections which map into it. You can override this by using | |
5324 | the section type. For example, in the script sample below, the | |
5325 | @samp{ROM} section is addressed at memory location @samp{0} and does not | |
2e76e85a | 5326 | need to be loaded when the program is run. |
252b5132 RH |
5327 | @smallexample |
5328 | @group | |
5329 | SECTIONS @{ | |
5330 | ROM 0 (NOLOAD) : @{ @dots{} @} | |
5331 | @dots{} | |
5332 | @} | |
5333 | @end group | |
5334 | @end smallexample | |
5335 | ||
5336 | @node Output Section LMA | |
36f63dca | 5337 | @subsubsection Output Section LMA |
562d3460 | 5338 | @kindex AT>@var{lma_region} |
252b5132 RH |
5339 | @kindex AT(@var{lma}) |
5340 | @cindex load address | |
5341 | @cindex section load address | |
5342 | Every section has a virtual address (VMA) and a load address (LMA); see | |
ea5cae92 NC |
5343 | @ref{Basic Script Concepts}. The virtual address is specified by the |
5344 | @pxref{Output Section Address} described earlier. The load address is | |
5345 | specified by the @code{AT} or @code{AT>} keywords. Specifying a load | |
5346 | address is optional. | |
6bdafbeb | 5347 | |
ea5cae92 NC |
5348 | The @code{AT} keyword takes an expression as an argument. This |
5349 | specifies the exact load address of the section. The @code{AT>} keyword | |
5350 | takes the name of a memory region as an argument. @xref{MEMORY}. The | |
5351 | load address of the section is set to the next free address in the | |
5352 | region, aligned to the section's alignment requirements. | |
dc0b6aa0 AM |
5353 | |
5354 | If neither @code{AT} nor @code{AT>} is specified for an allocatable | |
ea5cae92 NC |
5355 | section, the linker will use the following heuristic to determine the |
5356 | load address: | |
5357 | ||
5358 | @itemize @bullet | |
5359 | @item | |
5360 | If the section has a specific VMA address, then this is used as | |
5361 | the LMA address as well. | |
5362 | ||
5363 | @item | |
5364 | If the section is not allocatable then its LMA is set to its VMA. | |
5365 | ||
5366 | @item | |
5367 | Otherwise if a memory region can be found that is compatible | |
5368 | with the current section, and this region contains at least one | |
5369 | section, then the LMA is set so the difference between the | |
5370 | VMA and LMA is the same as the difference between the VMA and LMA of | |
5371 | the last section in the located region. | |
5372 | ||
5373 | @item | |
5374 | If no memory regions have been declared then a default region | |
5375 | that covers the entire address space is used in the previous step. | |
5376 | ||
5377 | @item | |
5378 | If no suitable region could be found, or there was no previous | |
5379 | section then the LMA is set equal to the VMA. | |
5380 | @end itemize | |
252b5132 RH |
5381 | |
5382 | @cindex ROM initialized data | |
5383 | @cindex initialized data in ROM | |
5384 | This feature is designed to make it easy to build a ROM image. For | |
5385 | example, the following linker script creates three output sections: one | |
5386 | called @samp{.text}, which starts at @code{0x1000}, one called | |
5387 | @samp{.mdata}, which is loaded at the end of the @samp{.text} section | |
5388 | even though its VMA is @code{0x2000}, and one called @samp{.bss} to hold | |
5389 | uninitialized data at address @code{0x3000}. The symbol @code{_data} is | |
5390 | defined with the value @code{0x2000}, which shows that the location | |
5391 | counter holds the VMA value, not the LMA value. | |
5392 | ||
5393 | @smallexample | |
5394 | @group | |
5395 | SECTIONS | |
5396 | @{ | |
5397 | .text 0x1000 : @{ *(.text) _etext = . ; @} | |
a1ab1d2a | 5398 | .mdata 0x2000 : |
252b5132 RH |
5399 | AT ( ADDR (.text) + SIZEOF (.text) ) |
5400 | @{ _data = . ; *(.data); _edata = . ; @} | |
5401 | .bss 0x3000 : | |
5402 | @{ _bstart = . ; *(.bss) *(COMMON) ; _bend = . ;@} | |
5403 | @} | |
5404 | @end group | |
5405 | @end smallexample | |
5406 | ||
5407 | The run-time initialization code for use with a program generated with | |
5408 | this linker script would include something like the following, to copy | |
5409 | the initialized data from the ROM image to its runtime address. Notice | |
5410 | how this code takes advantage of the symbols defined by the linker | |
5411 | script. | |
5412 | ||
5413 | @smallexample | |
5414 | @group | |
5415 | extern char _etext, _data, _edata, _bstart, _bend; | |
5416 | char *src = &_etext; | |
5417 | char *dst = &_data; | |
5418 | ||
ea5cae92 NC |
5419 | /* ROM has data at end of text; copy it. */ |
5420 | while (dst < &_edata) | |
252b5132 | 5421 | *dst++ = *src++; |
252b5132 | 5422 | |
ea5cae92 | 5423 | /* Zero bss. */ |
252b5132 RH |
5424 | for (dst = &_bstart; dst< &_bend; dst++) |
5425 | *dst = 0; | |
5426 | @end group | |
5427 | @end smallexample | |
5428 | ||
bbf115d3 L |
5429 | @node Forced Output Alignment |
5430 | @subsubsection Forced Output Alignment | |
5431 | @kindex ALIGN(@var{section_align}) | |
5432 | @cindex forcing output section alignment | |
5433 | @cindex output section alignment | |
1eec346e | 5434 | You can increase an output section's alignment by using ALIGN. As an |
13075d04 SH |
5435 | alternative you can enforce that the difference between the VMA and LMA remains |
5436 | intact throughout this output section with the ALIGN_WITH_INPUT attribute. | |
bbf115d3 | 5437 | |
7e7d5768 AM |
5438 | @node Forced Input Alignment |
5439 | @subsubsection Forced Input Alignment | |
5440 | @kindex SUBALIGN(@var{subsection_align}) | |
5441 | @cindex forcing input section alignment | |
5442 | @cindex input section alignment | |
5443 | You can force input section alignment within an output section by using | |
5444 | SUBALIGN. The value specified overrides any alignment given by input | |
5445 | sections, whether larger or smaller. | |
5446 | ||
0c71d759 NC |
5447 | @node Output Section Constraint |
5448 | @subsubsection Output Section Constraint | |
5449 | @kindex ONLY_IF_RO | |
5450 | @kindex ONLY_IF_RW | |
5451 | @cindex constraints on output sections | |
5452 | You can specify that an output section should only be created if all | |
5453 | of its input sections are read-only or all of its input sections are | |
5454 | read-write by using the keyword @code{ONLY_IF_RO} and | |
5455 | @code{ONLY_IF_RW} respectively. | |
5456 | ||
252b5132 | 5457 | @node Output Section Region |
36f63dca | 5458 | @subsubsection Output Section Region |
252b5132 RH |
5459 | @kindex >@var{region} |
5460 | @cindex section, assigning to memory region | |
5461 | @cindex memory regions and sections | |
5462 | You can assign a section to a previously defined region of memory by | |
5463 | using @samp{>@var{region}}. @xref{MEMORY}. | |
5464 | ||
5465 | Here is a simple example: | |
5466 | @smallexample | |
5467 | @group | |
5468 | MEMORY @{ rom : ORIGIN = 0x1000, LENGTH = 0x1000 @} | |
5469 | SECTIONS @{ ROM : @{ *(.text) @} >rom @} | |
5470 | @end group | |
5471 | @end smallexample | |
5472 | ||
5473 | @node Output Section Phdr | |
36f63dca | 5474 | @subsubsection Output Section Phdr |
252b5132 RH |
5475 | @kindex :@var{phdr} |
5476 | @cindex section, assigning to program header | |
5477 | @cindex program headers and sections | |
5478 | You can assign a section to a previously defined program segment by | |
5479 | using @samp{:@var{phdr}}. @xref{PHDRS}. If a section is assigned to | |
5480 | one or more segments, then all subsequent allocated sections will be | |
5481 | assigned to those segments as well, unless they use an explicitly | |
5482 | @code{:@var{phdr}} modifier. You can use @code{:NONE} to tell the | |
5483 | linker to not put the section in any segment at all. | |
5484 | ||
5485 | Here is a simple example: | |
5486 | @smallexample | |
5487 | @group | |
5488 | PHDRS @{ text PT_LOAD ; @} | |
5489 | SECTIONS @{ .text : @{ *(.text) @} :text @} | |
5490 | @end group | |
5491 | @end smallexample | |
5492 | ||
5493 | @node Output Section Fill | |
36f63dca | 5494 | @subsubsection Output Section Fill |
252b5132 RH |
5495 | @kindex =@var{fillexp} |
5496 | @cindex section fill pattern | |
5497 | @cindex fill pattern, entire section | |
5498 | You can set the fill pattern for an entire section by using | |
5499 | @samp{=@var{fillexp}}. @var{fillexp} is an expression | |
5500 | (@pxref{Expressions}). Any otherwise unspecified regions of memory | |
5501 | within the output section (for example, gaps left due to the required | |
a139d329 AM |
5502 | alignment of input sections) will be filled with the value, repeated as |
5503 | necessary. If the fill expression is a simple hex number, ie. a string | |
9673c93c | 5504 | of hex digit starting with @samp{0x} and without a trailing @samp{k} or @samp{M}, then |
a139d329 AM |
5505 | an arbitrarily long sequence of hex digits can be used to specify the |
5506 | fill pattern; Leading zeros become part of the pattern too. For all | |
9673c93c | 5507 | other cases, including extra parentheses or a unary @code{+}, the fill |
a139d329 AM |
5508 | pattern is the four least significant bytes of the value of the |
5509 | expression. In all cases, the number is big-endian. | |
252b5132 RH |
5510 | |
5511 | You can also change the fill value with a @code{FILL} command in the | |
9673c93c | 5512 | output section commands; (@pxref{Output Section Data}). |
252b5132 RH |
5513 | |
5514 | Here is a simple example: | |
5515 | @smallexample | |
5516 | @group | |
563e308f | 5517 | SECTIONS @{ .text : @{ *(.text) @} =0x90909090 @} |
252b5132 RH |
5518 | @end group |
5519 | @end smallexample | |
5520 | ||
5521 | @node Overlay Description | |
36f63dca | 5522 | @subsection Overlay Description |
252b5132 RH |
5523 | @kindex OVERLAY |
5524 | @cindex overlays | |
5525 | An overlay description provides an easy way to describe sections which | |
5526 | are to be loaded as part of a single memory image but are to be run at | |
5527 | the same memory address. At run time, some sort of overlay manager will | |
5528 | copy the overlaid sections in and out of the runtime memory address as | |
5529 | required, perhaps by simply manipulating addressing bits. This approach | |
5530 | can be useful, for example, when a certain region of memory is faster | |
5531 | than another. | |
5532 | ||
5533 | Overlays are described using the @code{OVERLAY} command. The | |
5534 | @code{OVERLAY} command is used within a @code{SECTIONS} command, like an | |
5535 | output section description. The full syntax of the @code{OVERLAY} | |
5536 | command is as follows: | |
5537 | @smallexample | |
5538 | @group | |
5539 | OVERLAY [@var{start}] : [NOCROSSREFS] [AT ( @var{ldaddr} )] | |
5540 | @{ | |
5541 | @var{secname1} | |
5542 | @{ | |
5543 | @var{output-section-command} | |
5544 | @var{output-section-command} | |
5545 | @dots{} | |
5546 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
5547 | @var{secname2} | |
5548 | @{ | |
5549 | @var{output-section-command} | |
5550 | @var{output-section-command} | |
5551 | @dots{} | |
5552 | @} [:@var{phdr}@dots{}] [=@var{fill}] | |
5553 | @dots{} | |
abc9061b | 5554 | @} [>@var{region}] [:@var{phdr}@dots{}] [=@var{fill}] [,] |
252b5132 RH |
5555 | @end group |
5556 | @end smallexample | |
5557 | ||
5558 | Everything is optional except @code{OVERLAY} (a keyword), and each | |
5559 | section must have a name (@var{secname1} and @var{secname2} above). The | |
5560 | section definitions within the @code{OVERLAY} construct are identical to | |
11e7fd74 | 5561 | those within the general @code{SECTIONS} construct (@pxref{SECTIONS}), |
252b5132 RH |
5562 | except that no addresses and no memory regions may be defined for |
5563 | sections within an @code{OVERLAY}. | |
5564 | ||
abc9061b CC |
5565 | The comma at the end may be required if a @var{fill} is used and |
5566 | the next @var{sections-command} looks like a continuation of the expression. | |
5567 | ||
252b5132 RH |
5568 | The sections are all defined with the same starting address. The load |
5569 | addresses of the sections are arranged such that they are consecutive in | |
5570 | memory starting at the load address used for the @code{OVERLAY} as a | |
5571 | whole (as with normal section definitions, the load address is optional, | |
5572 | and defaults to the start address; the start address is also optional, | |
5573 | and defaults to the current value of the location counter). | |
5574 | ||
56dd11f0 NC |
5575 | If the @code{NOCROSSREFS} keyword is used, and there are any |
5576 | references among the sections, the linker will report an error. Since | |
5577 | the sections all run at the same address, it normally does not make | |
5578 | sense for one section to refer directly to another. | |
5579 | @xref{Miscellaneous Commands, NOCROSSREFS}. | |
252b5132 RH |
5580 | |
5581 | For each section within the @code{OVERLAY}, the linker automatically | |
34711ca3 | 5582 | provides two symbols. The symbol @code{__load_start_@var{secname}} is |
252b5132 RH |
5583 | defined as the starting load address of the section. The symbol |
5584 | @code{__load_stop_@var{secname}} is defined as the final load address of | |
5585 | the section. Any characters within @var{secname} which are not legal | |
5586 | within C identifiers are removed. C (or assembler) code may use these | |
5587 | symbols to move the overlaid sections around as necessary. | |
5588 | ||
5589 | At the end of the overlay, the value of the location counter is set to | |
5590 | the start address of the overlay plus the size of the largest section. | |
5591 | ||
5592 | Here is an example. Remember that this would appear inside a | |
5593 | @code{SECTIONS} construct. | |
5594 | @smallexample | |
5595 | @group | |
5596 | OVERLAY 0x1000 : AT (0x4000) | |
5597 | @{ | |
5598 | .text0 @{ o1/*.o(.text) @} | |
5599 | .text1 @{ o2/*.o(.text) @} | |
5600 | @} | |
5601 | @end group | |
5602 | @end smallexample | |
5603 | @noindent | |
5604 | This will define both @samp{.text0} and @samp{.text1} to start at | |
5605 | address 0x1000. @samp{.text0} will be loaded at address 0x4000, and | |
5606 | @samp{.text1} will be loaded immediately after @samp{.text0}. The | |
34711ca3 | 5607 | following symbols will be defined if referenced: @code{__load_start_text0}, |
252b5132 RH |
5608 | @code{__load_stop_text0}, @code{__load_start_text1}, |
5609 | @code{__load_stop_text1}. | |
5610 | ||
5611 | C code to copy overlay @code{.text1} into the overlay area might look | |
5612 | like the following. | |
5613 | ||
5614 | @smallexample | |
5615 | @group | |
5616 | extern char __load_start_text1, __load_stop_text1; | |
5617 | memcpy ((char *) 0x1000, &__load_start_text1, | |
5618 | &__load_stop_text1 - &__load_start_text1); | |
5619 | @end group | |
5620 | @end smallexample | |
5621 | ||
5622 | Note that the @code{OVERLAY} command is just syntactic sugar, since | |
5623 | everything it does can be done using the more basic commands. The above | |
5624 | example could have been written identically as follows. | |
5625 | ||
5626 | @smallexample | |
5627 | @group | |
5628 | .text0 0x1000 : AT (0x4000) @{ o1/*.o(.text) @} | |
34711ca3 AM |
5629 | PROVIDE (__load_start_text0 = LOADADDR (.text0)); |
5630 | PROVIDE (__load_stop_text0 = LOADADDR (.text0) + SIZEOF (.text0)); | |
252b5132 | 5631 | .text1 0x1000 : AT (0x4000 + SIZEOF (.text0)) @{ o2/*.o(.text) @} |
34711ca3 AM |
5632 | PROVIDE (__load_start_text1 = LOADADDR (.text1)); |
5633 | PROVIDE (__load_stop_text1 = LOADADDR (.text1) + SIZEOF (.text1)); | |
252b5132 RH |
5634 | . = 0x1000 + MAX (SIZEOF (.text0), SIZEOF (.text1)); |
5635 | @end group | |
5636 | @end smallexample | |
5637 | ||
5638 | @node MEMORY | |
36f63dca | 5639 | @section MEMORY Command |
252b5132 RH |
5640 | @kindex MEMORY |
5641 | @cindex memory regions | |
5642 | @cindex regions of memory | |
5643 | @cindex allocating memory | |
5644 | @cindex discontinuous memory | |
5645 | The linker's default configuration permits allocation of all available | |
5646 | memory. You can override this by using the @code{MEMORY} command. | |
5647 | ||
5648 | The @code{MEMORY} command describes the location and size of blocks of | |
5649 | memory in the target. You can use it to describe which memory regions | |
5650 | may be used by the linker, and which memory regions it must avoid. You | |
5651 | can then assign sections to particular memory regions. The linker will | |
5652 | set section addresses based on the memory regions, and will warn about | |
5653 | regions that become too full. The linker will not shuffle sections | |
5654 | around to fit into the available regions. | |
5655 | ||
127fcdff AB |
5656 | A linker script may contain many uses of the @code{MEMORY} command, |
5657 | however, all memory blocks defined are treated as if they were | |
5658 | specified inside a single @code{MEMORY} command. The syntax for | |
5659 | @code{MEMORY} is: | |
252b5132 RH |
5660 | @smallexample |
5661 | @group | |
a1ab1d2a | 5662 | MEMORY |
252b5132 RH |
5663 | @{ |
5664 | @var{name} [(@var{attr})] : ORIGIN = @var{origin}, LENGTH = @var{len} | |
5665 | @dots{} | |
5666 | @} | |
5667 | @end group | |
5668 | @end smallexample | |
5669 | ||
5670 | The @var{name} is a name used in the linker script to refer to the | |
5671 | region. The region name has no meaning outside of the linker script. | |
5672 | Region names are stored in a separate name space, and will not conflict | |
5673 | with symbol names, file names, or section names. Each memory region | |
4a93e180 NC |
5674 | must have a distinct name within the @code{MEMORY} command. However you can |
5675 | add later alias names to existing memory regions with the @ref{REGION_ALIAS} | |
9d5777a3 | 5676 | command. |
252b5132 RH |
5677 | |
5678 | @cindex memory region attributes | |
5679 | The @var{attr} string is an optional list of attributes that specify | |
5680 | whether to use a particular memory region for an input section which is | |
5681 | not explicitly mapped in the linker script. As described in | |
5682 | @ref{SECTIONS}, if you do not specify an output section for some input | |
5683 | section, the linker will create an output section with the same name as | |
5684 | the input section. If you define region attributes, the linker will use | |
5685 | them to select the memory region for the output section that it creates. | |
5686 | ||
5687 | The @var{attr} string must consist only of the following characters: | |
5688 | @table @samp | |
5689 | @item R | |
5690 | Read-only section | |
5691 | @item W | |
5692 | Read/write section | |
5693 | @item X | |
5694 | Executable section | |
5695 | @item A | |
5696 | Allocatable section | |
5697 | @item I | |
5698 | Initialized section | |
5699 | @item L | |
5700 | Same as @samp{I} | |
5701 | @item ! | |
c09e9a8c | 5702 | Invert the sense of any of the attributes that follow |
252b5132 RH |
5703 | @end table |
5704 | ||
81c688d5 | 5705 | If an unmapped section matches any of the listed attributes other than |
252b5132 | 5706 | @samp{!}, it will be placed in the memory region. The @samp{!} |
81c688d5 NC |
5707 | attribute reverses the test for the characters that follow, so that an |
5708 | unmapped section will be placed in the memory region only if it does | |
5709 | not match any of the attributes listed afterwards. Thus an attribute | |
5710 | string of @samp{RW!X} will match any unmapped section that has either | |
5711 | or both of the @samp{R} and @samp{W} attributes, but only as long as | |
5712 | the section does not also have the @samp{X} attribute. | |
252b5132 RH |
5713 | |
5714 | @kindex ORIGIN = | |
5715 | @kindex o = | |
5716 | @kindex org = | |
9cd6d51a NC |
5717 | The @var{origin} is an numerical expression for the start address of |
5718 | the memory region. The expression must evaluate to a constant and it | |
5719 | cannot involve any symbols. The keyword @code{ORIGIN} may be | |
5720 | abbreviated to @code{org} or @code{o} (but not, for example, | |
5721 | @code{ORG}). | |
252b5132 RH |
5722 | |
5723 | @kindex LENGTH = | |
5724 | @kindex len = | |
5725 | @kindex l = | |
5726 | The @var{len} is an expression for the size in bytes of the memory | |
5727 | region. As with the @var{origin} expression, the expression must | |
9cd6d51a NC |
5728 | be numerical only and must evaluate to a constant. The keyword |
5729 | @code{LENGTH} may be abbreviated to @code{len} or @code{l}. | |
252b5132 RH |
5730 | |
5731 | In the following example, we specify that there are two memory regions | |
5732 | available for allocation: one starting at @samp{0} for 256 kilobytes, | |
5733 | and the other starting at @samp{0x40000000} for four megabytes. The | |
5734 | linker will place into the @samp{rom} memory region every section which | |
5735 | is not explicitly mapped into a memory region, and is either read-only | |
5736 | or executable. The linker will place other sections which are not | |
5737 | explicitly mapped into a memory region into the @samp{ram} memory | |
5738 | region. | |
5739 | ||
5740 | @smallexample | |
5741 | @group | |
a1ab1d2a | 5742 | MEMORY |
252b5132 RH |
5743 | @{ |
5744 | rom (rx) : ORIGIN = 0, LENGTH = 256K | |
5745 | ram (!rx) : org = 0x40000000, l = 4M | |
5746 | @} | |
5747 | @end group | |
5748 | @end smallexample | |
5749 | ||
5750 | Once you define a memory region, you can direct the linker to place | |
5751 | specific output sections into that memory region by using the | |
5752 | @samp{>@var{region}} output section attribute. For example, if you have | |
5753 | a memory region named @samp{mem}, you would use @samp{>mem} in the | |
5754 | output section definition. @xref{Output Section Region}. If no address | |
5755 | was specified for the output section, the linker will set the address to | |
5756 | the next available address within the memory region. If the combined | |
5757 | output sections directed to a memory region are too large for the | |
5758 | region, the linker will issue an error message. | |
5759 | ||
3ec57632 | 5760 | It is possible to access the origin and length of a memory in an |
c0065db7 | 5761 | expression via the @code{ORIGIN(@var{memory})} and |
3ec57632 NC |
5762 | @code{LENGTH(@var{memory})} functions: |
5763 | ||
5764 | @smallexample | |
5765 | @group | |
c0065db7 | 5766 | _fstack = ORIGIN(ram) + LENGTH(ram) - 4; |
3ec57632 NC |
5767 | @end group |
5768 | @end smallexample | |
5769 | ||
252b5132 RH |
5770 | @node PHDRS |
5771 | @section PHDRS Command | |
5772 | @kindex PHDRS | |
5773 | @cindex program headers | |
5774 | @cindex ELF program headers | |
5775 | @cindex program segments | |
5776 | @cindex segments, ELF | |
5777 | The ELF object file format uses @dfn{program headers}, also knows as | |
5778 | @dfn{segments}. The program headers describe how the program should be | |
5779 | loaded into memory. You can print them out by using the @code{objdump} | |
5780 | program with the @samp{-p} option. | |
5781 | ||
5782 | When you run an ELF program on a native ELF system, the system loader | |
5783 | reads the program headers in order to figure out how to load the | |
5784 | program. This will only work if the program headers are set correctly. | |
5785 | This manual does not describe the details of how the system loader | |
5786 | interprets program headers; for more information, see the ELF ABI. | |
5787 | ||
5788 | The linker will create reasonable program headers by default. However, | |
5789 | in some cases, you may need to specify the program headers more | |
5790 | precisely. You may use the @code{PHDRS} command for this purpose. When | |
5791 | the linker sees the @code{PHDRS} command in the linker script, it will | |
5792 | not create any program headers other than the ones specified. | |
5793 | ||
5794 | The linker only pays attention to the @code{PHDRS} command when | |
5795 | generating an ELF output file. In other cases, the linker will simply | |
5796 | ignore @code{PHDRS}. | |
5797 | ||
5798 | This is the syntax of the @code{PHDRS} command. The words @code{PHDRS}, | |
5799 | @code{FILEHDR}, @code{AT}, and @code{FLAGS} are keywords. | |
5800 | ||
5801 | @smallexample | |
5802 | @group | |
5803 | PHDRS | |
5804 | @{ | |
5805 | @var{name} @var{type} [ FILEHDR ] [ PHDRS ] [ AT ( @var{address} ) ] | |
5806 | [ FLAGS ( @var{flags} ) ] ; | |
5807 | @} | |
5808 | @end group | |
5809 | @end smallexample | |
5810 | ||
5811 | The @var{name} is used only for reference in the @code{SECTIONS} command | |
5812 | of the linker script. It is not put into the output file. Program | |
5813 | header names are stored in a separate name space, and will not conflict | |
5814 | with symbol names, file names, or section names. Each program header | |
5c1a3f0f NS |
5815 | must have a distinct name. The headers are processed in order and it |
5816 | is usual for them to map to sections in ascending load address order. | |
252b5132 RH |
5817 | |
5818 | Certain program header types describe segments of memory which the | |
5819 | system loader will load from the file. In the linker script, you | |
5820 | specify the contents of these segments by placing allocatable output | |
5821 | sections in the segments. You use the @samp{:@var{phdr}} output section | |
5822 | attribute to place a section in a particular segment. @xref{Output | |
5823 | Section Phdr}. | |
5824 | ||
5825 | It is normal to put certain sections in more than one segment. This | |
5826 | merely implies that one segment of memory contains another. You may | |
5827 | repeat @samp{:@var{phdr}}, using it once for each segment which should | |
5828 | contain the section. | |
5829 | ||
5830 | If you place a section in one or more segments using @samp{:@var{phdr}}, | |
5831 | then the linker will place all subsequent allocatable sections which do | |
5832 | not specify @samp{:@var{phdr}} in the same segments. This is for | |
5833 | convenience, since generally a whole set of contiguous sections will be | |
5834 | placed in a single segment. You can use @code{:NONE} to override the | |
5835 | default segment and tell the linker to not put the section in any | |
5836 | segment at all. | |
5837 | ||
5838 | @kindex FILEHDR | |
5839 | @kindex PHDRS | |
5c1a3f0f | 5840 | You may use the @code{FILEHDR} and @code{PHDRS} keywords after |
252b5132 RH |
5841 | the program header type to further describe the contents of the segment. |
5842 | The @code{FILEHDR} keyword means that the segment should include the ELF | |
5843 | file header. The @code{PHDRS} keyword means that the segment should | |
5c1a3f0f | 5844 | include the ELF program headers themselves. If applied to a loadable |
4100cea3 AM |
5845 | segment (@code{PT_LOAD}), all prior loadable segments must have one of |
5846 | these keywords. | |
252b5132 RH |
5847 | |
5848 | The @var{type} may be one of the following. The numbers indicate the | |
5849 | value of the keyword. | |
5850 | ||
5851 | @table @asis | |
5852 | @item @code{PT_NULL} (0) | |
5853 | Indicates an unused program header. | |
5854 | ||
5855 | @item @code{PT_LOAD} (1) | |
5856 | Indicates that this program header describes a segment to be loaded from | |
5857 | the file. | |
5858 | ||
5859 | @item @code{PT_DYNAMIC} (2) | |
5860 | Indicates a segment where dynamic linking information can be found. | |
5861 | ||
5862 | @item @code{PT_INTERP} (3) | |
5863 | Indicates a segment where the name of the program interpreter may be | |
5864 | found. | |
5865 | ||
5866 | @item @code{PT_NOTE} (4) | |
5867 | Indicates a segment holding note information. | |
5868 | ||
5869 | @item @code{PT_SHLIB} (5) | |
5870 | A reserved program header type, defined but not specified by the ELF | |
5871 | ABI. | |
5872 | ||
5873 | @item @code{PT_PHDR} (6) | |
5874 | Indicates a segment where the program headers may be found. | |
5875 | ||
1a9ccd70 NC |
5876 | @item @code{PT_TLS} (7) |
5877 | Indicates a segment containing thread local storage. | |
5878 | ||
252b5132 RH |
5879 | @item @var{expression} |
5880 | An expression giving the numeric type of the program header. This may | |
5881 | be used for types not defined above. | |
5882 | @end table | |
5883 | ||
5884 | You can specify that a segment should be loaded at a particular address | |
5885 | in memory by using an @code{AT} expression. This is identical to the | |
5886 | @code{AT} command used as an output section attribute (@pxref{Output | |
5887 | Section LMA}). The @code{AT} command for a program header overrides the | |
5888 | output section attribute. | |
5889 | ||
5890 | The linker will normally set the segment flags based on the sections | |
5891 | which comprise the segment. You may use the @code{FLAGS} keyword to | |
5892 | explicitly specify the segment flags. The value of @var{flags} must be | |
5893 | an integer. It is used to set the @code{p_flags} field of the program | |
5894 | header. | |
5895 | ||
5896 | Here is an example of @code{PHDRS}. This shows a typical set of program | |
5897 | headers used on a native ELF system. | |
5898 | ||
5899 | @example | |
5900 | @group | |
5901 | PHDRS | |
5902 | @{ | |
5903 | headers PT_PHDR PHDRS ; | |
5904 | interp PT_INTERP ; | |
5905 | text PT_LOAD FILEHDR PHDRS ; | |
5906 | data PT_LOAD ; | |
5907 | dynamic PT_DYNAMIC ; | |
5908 | @} | |
5909 | ||
5910 | SECTIONS | |
5911 | @{ | |
5912 | . = SIZEOF_HEADERS; | |
5913 | .interp : @{ *(.interp) @} :text :interp | |
5914 | .text : @{ *(.text) @} :text | |
5915 | .rodata : @{ *(.rodata) @} /* defaults to :text */ | |
5916 | @dots{} | |
5917 | . = . + 0x1000; /* move to a new page in memory */ | |
5918 | .data : @{ *(.data) @} :data | |
5919 | .dynamic : @{ *(.dynamic) @} :data :dynamic | |
5920 | @dots{} | |
5921 | @} | |
5922 | @end group | |
5923 | @end example | |
5924 | ||
5925 | @node VERSION | |
5926 | @section VERSION Command | |
5927 | @kindex VERSION @{script text@} | |
5928 | @cindex symbol versions | |
5929 | @cindex version script | |
5930 | @cindex versions of symbols | |
5931 | The linker supports symbol versions when using ELF. Symbol versions are | |
5932 | only useful when using shared libraries. The dynamic linker can use | |
5933 | symbol versions to select a specific version of a function when it runs | |
5934 | a program that may have been linked against an earlier version of the | |
5935 | shared library. | |
5936 | ||
5937 | You can include a version script directly in the main linker script, or | |
5938 | you can supply the version script as an implicit linker script. You can | |
5939 | also use the @samp{--version-script} linker option. | |
5940 | ||
5941 | The syntax of the @code{VERSION} command is simply | |
5942 | @smallexample | |
5943 | VERSION @{ version-script-commands @} | |
5944 | @end smallexample | |
5945 | ||
5946 | The format of the version script commands is identical to that used by | |
5947 | Sun's linker in Solaris 2.5. The version script defines a tree of | |
5948 | version nodes. You specify the node names and interdependencies in the | |
5949 | version script. You can specify which symbols are bound to which | |
5950 | version nodes, and you can reduce a specified set of symbols to local | |
5951 | scope so that they are not globally visible outside of the shared | |
5952 | library. | |
5953 | ||
5954 | The easiest way to demonstrate the version script language is with a few | |
5955 | examples. | |
5956 | ||
5957 | @smallexample | |
5958 | VERS_1.1 @{ | |
5959 | global: | |
5960 | foo1; | |
5961 | local: | |
a1ab1d2a UD |
5962 | old*; |
5963 | original*; | |
5964 | new*; | |
252b5132 RH |
5965 | @}; |
5966 | ||
5967 | VERS_1.2 @{ | |
5968 | foo2; | |
5969 | @} VERS_1.1; | |
5970 | ||
5971 | VERS_2.0 @{ | |
5972 | bar1; bar2; | |
c0065db7 | 5973 | extern "C++" @{ |
86043bbb | 5974 | ns::*; |
bb1515f2 MF |
5975 | "f(int, double)"; |
5976 | @}; | |
252b5132 RH |
5977 | @} VERS_1.2; |
5978 | @end smallexample | |
5979 | ||
5980 | This example version script defines three version nodes. The first | |
5981 | version node defined is @samp{VERS_1.1}; it has no other dependencies. | |
5982 | The script binds the symbol @samp{foo1} to @samp{VERS_1.1}. It reduces | |
5983 | a number of symbols to local scope so that they are not visible outside | |
313e35ee AM |
5984 | of the shared library; this is done using wildcard patterns, so that any |
5985 | symbol whose name begins with @samp{old}, @samp{original}, or @samp{new} | |
5986 | is matched. The wildcard patterns available are the same as those used | |
5987 | in the shell when matching filenames (also known as ``globbing''). | |
86043bbb MM |
5988 | However, if you specify the symbol name inside double quotes, then the |
5989 | name is treated as literal, rather than as a glob pattern. | |
252b5132 RH |
5990 | |
5991 | Next, the version script defines node @samp{VERS_1.2}. This node | |
5992 | depends upon @samp{VERS_1.1}. The script binds the symbol @samp{foo2} | |
5993 | to the version node @samp{VERS_1.2}. | |
5994 | ||
5995 | Finally, the version script defines node @samp{VERS_2.0}. This node | |
5996 | depends upon @samp{VERS_1.2}. The scripts binds the symbols @samp{bar1} | |
5997 | and @samp{bar2} are bound to the version node @samp{VERS_2.0}. | |
5998 | ||
5999 | When the linker finds a symbol defined in a library which is not | |
6000 | specifically bound to a version node, it will effectively bind it to an | |
6001 | unspecified base version of the library. You can bind all otherwise | |
a981ed6f | 6002 | unspecified symbols to a given version node by using @samp{global: *;} |
ae5a3597 AM |
6003 | somewhere in the version script. Note that it's slightly crazy to use |
6004 | wildcards in a global spec except on the last version node. Global | |
6005 | wildcards elsewhere run the risk of accidentally adding symbols to the | |
6006 | set exported for an old version. That's wrong since older versions | |
6007 | ought to have a fixed set of symbols. | |
252b5132 RH |
6008 | |
6009 | The names of the version nodes have no specific meaning other than what | |
6010 | they might suggest to the person reading them. The @samp{2.0} version | |
6011 | could just as well have appeared in between @samp{1.1} and @samp{1.2}. | |
6012 | However, this would be a confusing way to write a version script. | |
6013 | ||
0f6bf451 | 6014 | Node name can be omitted, provided it is the only version node |
6b9b879a JJ |
6015 | in the version script. Such version script doesn't assign any versions to |
6016 | symbols, only selects which symbols will be globally visible out and which | |
6017 | won't. | |
6018 | ||
6019 | @smallexample | |
7c9c73be | 6020 | @{ global: foo; bar; local: *; @}; |
9d201f2f | 6021 | @end smallexample |
6b9b879a | 6022 | |
252b5132 RH |
6023 | When you link an application against a shared library that has versioned |
6024 | symbols, the application itself knows which version of each symbol it | |
6025 | requires, and it also knows which version nodes it needs from each | |
6026 | shared library it is linked against. Thus at runtime, the dynamic | |
6027 | loader can make a quick check to make sure that the libraries you have | |
6028 | linked against do in fact supply all of the version nodes that the | |
6029 | application will need to resolve all of the dynamic symbols. In this | |
6030 | way it is possible for the dynamic linker to know with certainty that | |
6031 | all external symbols that it needs will be resolvable without having to | |
6032 | search for each symbol reference. | |
6033 | ||
6034 | The symbol versioning is in effect a much more sophisticated way of | |
6035 | doing minor version checking that SunOS does. The fundamental problem | |
6036 | that is being addressed here is that typically references to external | |
6037 | functions are bound on an as-needed basis, and are not all bound when | |
6038 | the application starts up. If a shared library is out of date, a | |
6039 | required interface may be missing; when the application tries to use | |
6040 | that interface, it may suddenly and unexpectedly fail. With symbol | |
6041 | versioning, the user will get a warning when they start their program if | |
6042 | the libraries being used with the application are too old. | |
6043 | ||
6044 | There are several GNU extensions to Sun's versioning approach. The | |
6045 | first of these is the ability to bind a symbol to a version node in the | |
6046 | source file where the symbol is defined instead of in the versioning | |
6047 | script. This was done mainly to reduce the burden on the library | |
6048 | maintainer. You can do this by putting something like: | |
6049 | @smallexample | |
6050 | __asm__(".symver original_foo,foo@@VERS_1.1"); | |
6051 | @end smallexample | |
6052 | @noindent | |
6053 | in the C source file. This renames the function @samp{original_foo} to | |
6054 | be an alias for @samp{foo} bound to the version node @samp{VERS_1.1}. | |
6055 | The @samp{local:} directive can be used to prevent the symbol | |
96a94295 L |
6056 | @samp{original_foo} from being exported. A @samp{.symver} directive |
6057 | takes precedence over a version script. | |
252b5132 RH |
6058 | |
6059 | The second GNU extension is to allow multiple versions of the same | |
6060 | function to appear in a given shared library. In this way you can make | |
6061 | an incompatible change to an interface without increasing the major | |
6062 | version number of the shared library, while still allowing applications | |
6063 | linked against the old interface to continue to function. | |
6064 | ||
6065 | To do this, you must use multiple @samp{.symver} directives in the | |
6066 | source file. Here is an example: | |
6067 | ||
6068 | @smallexample | |
6069 | __asm__(".symver original_foo,foo@@"); | |
6070 | __asm__(".symver old_foo,foo@@VERS_1.1"); | |
6071 | __asm__(".symver old_foo1,foo@@VERS_1.2"); | |
6072 | __asm__(".symver new_foo,foo@@@@VERS_2.0"); | |
6073 | @end smallexample | |
6074 | ||
6075 | In this example, @samp{foo@@} represents the symbol @samp{foo} bound to the | |
6076 | unspecified base version of the symbol. The source file that contains this | |
6077 | example would define 4 C functions: @samp{original_foo}, @samp{old_foo}, | |
6078 | @samp{old_foo1}, and @samp{new_foo}. | |
6079 | ||
6080 | When you have multiple definitions of a given symbol, there needs to be | |
6081 | some way to specify a default version to which external references to | |
6082 | this symbol will be bound. You can do this with the | |
6083 | @samp{foo@@@@VERS_2.0} type of @samp{.symver} directive. You can only | |
6084 | declare one version of a symbol as the default in this manner; otherwise | |
6085 | you would effectively have multiple definitions of the same symbol. | |
6086 | ||
6087 | If you wish to bind a reference to a specific version of the symbol | |
6088 | within the shared library, you can use the aliases of convenience | |
36f63dca | 6089 | (i.e., @samp{old_foo}), or you can use the @samp{.symver} directive to |
252b5132 RH |
6090 | specifically bind to an external version of the function in question. |
6091 | ||
cb840a31 L |
6092 | You can also specify the language in the version script: |
6093 | ||
6094 | @smallexample | |
6095 | VERSION extern "lang" @{ version-script-commands @} | |
6096 | @end smallexample | |
6097 | ||
c0065db7 | 6098 | The supported @samp{lang}s are @samp{C}, @samp{C++}, and @samp{Java}. |
cb840a31 L |
6099 | The linker will iterate over the list of symbols at the link time and |
6100 | demangle them according to @samp{lang} before matching them to the | |
bb1515f2 MF |
6101 | patterns specified in @samp{version-script-commands}. The default |
6102 | @samp{lang} is @samp{C}. | |
cb840a31 | 6103 | |
86043bbb MM |
6104 | Demangled names may contains spaces and other special characters. As |
6105 | described above, you can use a glob pattern to match demangled names, | |
6106 | or you can use a double-quoted string to match the string exactly. In | |
6107 | the latter case, be aware that minor differences (such as differing | |
6108 | whitespace) between the version script and the demangler output will | |
6109 | cause a mismatch. As the exact string generated by the demangler | |
6110 | might change in the future, even if the mangled name does not, you | |
6111 | should check that all of your version directives are behaving as you | |
6112 | expect when you upgrade. | |
6113 | ||
252b5132 RH |
6114 | @node Expressions |
6115 | @section Expressions in Linker Scripts | |
6116 | @cindex expressions | |
6117 | @cindex arithmetic | |
6118 | The syntax for expressions in the linker script language is identical to | |
6119 | that of C expressions. All expressions are evaluated as integers. All | |
6120 | expressions are evaluated in the same size, which is 32 bits if both the | |
6121 | host and target are 32 bits, and is otherwise 64 bits. | |
6122 | ||
6123 | You can use and set symbol values in expressions. | |
6124 | ||
6125 | The linker defines several special purpose builtin functions for use in | |
6126 | expressions. | |
6127 | ||
6128 | @menu | |
6129 | * Constants:: Constants | |
0c71d759 | 6130 | * Symbolic Constants:: Symbolic constants |
252b5132 | 6131 | * Symbols:: Symbol Names |
ecca9871 | 6132 | * Orphan Sections:: Orphan Sections |
252b5132 RH |
6133 | * Location Counter:: The Location Counter |
6134 | * Operators:: Operators | |
6135 | * Evaluation:: Evaluation | |
6136 | * Expression Section:: The Section of an Expression | |
6137 | * Builtin Functions:: Builtin Functions | |
6138 | @end menu | |
6139 | ||
6140 | @node Constants | |
6141 | @subsection Constants | |
6142 | @cindex integer notation | |
6143 | @cindex constants in linker scripts | |
6144 | All constants are integers. | |
6145 | ||
6146 | As in C, the linker considers an integer beginning with @samp{0} to be | |
6147 | octal, and an integer beginning with @samp{0x} or @samp{0X} to be | |
8a308ae8 | 6148 | hexadecimal. Alternatively the linker accepts suffixes of @samp{h} or |
11e7fd74 | 6149 | @samp{H} for hexadecimal, @samp{o} or @samp{O} for octal, @samp{b} or |
8a308ae8 NC |
6150 | @samp{B} for binary and @samp{d} or @samp{D} for decimal. Any integer |
6151 | value without a prefix or a suffix is considered to be decimal. | |
252b5132 RH |
6152 | |
6153 | @cindex scaled integers | |
6154 | @cindex K and M integer suffixes | |
6155 | @cindex M and K integer suffixes | |
6156 | @cindex suffixes for integers | |
6157 | @cindex integer suffixes | |
6158 | In addition, you can use the suffixes @code{K} and @code{M} to scale a | |
6159 | constant by | |
6160 | @c TEXI2ROFF-KILL | |
36f63dca | 6161 | @ifnottex |
252b5132 RH |
6162 | @c END TEXI2ROFF-KILL |
6163 | @code{1024} or @code{1024*1024} | |
6164 | @c TEXI2ROFF-KILL | |
36f63dca | 6165 | @end ifnottex |
252b5132 RH |
6166 | @tex |
6167 | ${\rm 1024}$ or ${\rm 1024}^2$ | |
6168 | @end tex | |
6169 | @c END TEXI2ROFF-KILL | |
8a308ae8 NC |
6170 | respectively. For example, the following |
6171 | all refer to the same quantity: | |
6172 | ||
252b5132 | 6173 | @smallexample |
36f63dca NC |
6174 | _fourk_1 = 4K; |
6175 | _fourk_2 = 4096; | |
6176 | _fourk_3 = 0x1000; | |
8a308ae8 | 6177 | _fourk_4 = 10000o; |
252b5132 RH |
6178 | @end smallexample |
6179 | ||
8a308ae8 NC |
6180 | Note - the @code{K} and @code{M} suffixes cannot be used in |
6181 | conjunction with the base suffixes mentioned above. | |
6182 | ||
0c71d759 NC |
6183 | @node Symbolic Constants |
6184 | @subsection Symbolic Constants | |
6185 | @cindex symbolic constants | |
6186 | @kindex CONSTANT | |
a094d01f | 6187 | It is possible to refer to target-specific constants via the use of |
0c71d759 NC |
6188 | the @code{CONSTANT(@var{name})} operator, where @var{name} is one of: |
6189 | ||
6190 | @table @code | |
6191 | @item MAXPAGESIZE | |
6192 | @kindex MAXPAGESIZE | |
6193 | The target's maximum page size. | |
6194 | ||
6195 | @item COMMONPAGESIZE | |
6196 | @kindex COMMONPAGESIZE | |
6197 | The target's default page size. | |
6198 | @end table | |
6199 | ||
6200 | So for example: | |
6201 | ||
6202 | @smallexample | |
9d5777a3 | 6203 | .text ALIGN (CONSTANT (MAXPAGESIZE)) : @{ *(.text) @} |
0c71d759 NC |
6204 | @end smallexample |
6205 | ||
6206 | will create a text section aligned to the largest page boundary | |
6207 | supported by the target. | |
6208 | ||
252b5132 RH |
6209 | @node Symbols |
6210 | @subsection Symbol Names | |
6211 | @cindex symbol names | |
6212 | @cindex names | |
6213 | @cindex quoted symbol names | |
6214 | @kindex " | |
6215 | Unless quoted, symbol names start with a letter, underscore, or period | |
6216 | and may include letters, digits, underscores, periods, and hyphens. | |
6217 | Unquoted symbol names must not conflict with any keywords. You can | |
6218 | specify a symbol which contains odd characters or has the same name as a | |
6219 | keyword by surrounding the symbol name in double quotes: | |
6220 | @smallexample | |
36f63dca NC |
6221 | "SECTION" = 9; |
6222 | "with a space" = "also with a space" + 10; | |
252b5132 RH |
6223 | @end smallexample |
6224 | ||
6225 | Since symbols can contain many non-alphabetic characters, it is safest | |
6226 | to delimit symbols with spaces. For example, @samp{A-B} is one symbol, | |
6227 | whereas @samp{A - B} is an expression involving subtraction. | |
6228 | ||
ecca9871 L |
6229 | @node Orphan Sections |
6230 | @subsection Orphan Sections | |
6231 | @cindex orphan | |
6232 | Orphan sections are sections present in the input files which | |
6233 | are not explicitly placed into the output file by the linker | |
6234 | script. The linker will still copy these sections into the | |
a87ded7b AB |
6235 | output file by either finding, or creating a suitable output section |
6236 | in which to place the orphaned input section. | |
6237 | ||
6238 | If the name of an orphaned input section exactly matches the name of | |
6239 | an existing output section, then the orphaned input section will be | |
6240 | placed at the end of that output section. | |
6241 | ||
6242 | If there is no output section with a matching name then new output | |
6243 | sections will be created. Each new output section will have the same | |
6244 | name as the orphan section placed within it. If there are multiple | |
6245 | orphan sections with the same name, these will all be combined into | |
6246 | one new output section. | |
6247 | ||
6248 | If new output sections are created to hold orphaned input sections, | |
6249 | then the linker must decide where to place these new output sections | |
e299b355 AM |
6250 | in relation to existing output sections. On most modern targets, the |
6251 | linker attempts to place orphan sections after sections of the same | |
6252 | attribute, such as code vs data, loadable vs non-loadable, etc. If no | |
6253 | sections with matching attributes are found, or your target lacks this | |
6254 | support, the orphan section is placed at the end of the file. | |
ecca9871 | 6255 | |
a05a5b64 TP |
6256 | The command-line options @samp{--orphan-handling} and @samp{--unique} |
6257 | (@pxref{Options,,Command-line Options}) can be used to control which | |
c005eb9e AB |
6258 | output sections an orphan is placed in. |
6259 | ||
252b5132 RH |
6260 | @node Location Counter |
6261 | @subsection The Location Counter | |
6262 | @kindex . | |
6263 | @cindex dot | |
6264 | @cindex location counter | |
6265 | @cindex current output location | |
6266 | The special linker variable @dfn{dot} @samp{.} always contains the | |
6267 | current output location counter. Since the @code{.} always refers to a | |
6268 | location in an output section, it may only appear in an expression | |
6269 | within a @code{SECTIONS} command. The @code{.} symbol may appear | |
6270 | anywhere that an ordinary symbol is allowed in an expression. | |
6271 | ||
6272 | @cindex holes | |
6273 | Assigning a value to @code{.} will cause the location counter to be | |
6274 | moved. This may be used to create holes in the output section. The | |
dc0b6aa0 AM |
6275 | location counter may not be moved backwards inside an output section, |
6276 | and may not be moved backwards outside of an output section if so | |
6277 | doing creates areas with overlapping LMAs. | |
252b5132 RH |
6278 | |
6279 | @smallexample | |
6280 | SECTIONS | |
6281 | @{ | |
6282 | output : | |
6283 | @{ | |
6284 | file1(.text) | |
6285 | . = . + 1000; | |
6286 | file2(.text) | |
6287 | . += 1000; | |
6288 | file3(.text) | |
563e308f | 6289 | @} = 0x12345678; |
252b5132 RH |
6290 | @} |
6291 | @end smallexample | |
6292 | @noindent | |
6293 | In the previous example, the @samp{.text} section from @file{file1} is | |
6294 | located at the beginning of the output section @samp{output}. It is | |
6295 | followed by a 1000 byte gap. Then the @samp{.text} section from | |
6296 | @file{file2} appears, also with a 1000 byte gap following before the | |
563e308f | 6297 | @samp{.text} section from @file{file3}. The notation @samp{= 0x12345678} |
252b5132 RH |
6298 | specifies what data to write in the gaps (@pxref{Output Section Fill}). |
6299 | ||
5c6bbab8 NC |
6300 | @cindex dot inside sections |
6301 | Note: @code{.} actually refers to the byte offset from the start of the | |
6302 | current containing object. Normally this is the @code{SECTIONS} | |
69da35b5 | 6303 | statement, whose start address is 0, hence @code{.} can be used as an |
5c6bbab8 NC |
6304 | absolute address. If @code{.} is used inside a section description |
6305 | however, it refers to the byte offset from the start of that section, | |
6306 | not an absolute address. Thus in a script like this: | |
6307 | ||
6308 | @smallexample | |
6309 | SECTIONS | |
6310 | @{ | |
6311 | . = 0x100 | |
6312 | .text: @{ | |
6313 | *(.text) | |
6314 | . = 0x200 | |
6315 | @} | |
6316 | . = 0x500 | |
6317 | .data: @{ | |
6318 | *(.data) | |
6319 | . += 0x600 | |
6320 | @} | |
6321 | @} | |
6322 | @end smallexample | |
6323 | ||
6324 | The @samp{.text} section will be assigned a starting address of 0x100 | |
6325 | and a size of exactly 0x200 bytes, even if there is not enough data in | |
6326 | the @samp{.text} input sections to fill this area. (If there is too | |
6327 | much data, an error will be produced because this would be an attempt to | |
6328 | move @code{.} backwards). The @samp{.data} section will start at 0x500 | |
6329 | and it will have an extra 0x600 bytes worth of space after the end of | |
6330 | the values from the @samp{.data} input sections and before the end of | |
6331 | the @samp{.data} output section itself. | |
6332 | ||
b5666f2f AM |
6333 | @cindex dot outside sections |
6334 | Setting symbols to the value of the location counter outside of an | |
6335 | output section statement can result in unexpected values if the linker | |
6336 | needs to place orphan sections. For example, given the following: | |
6337 | ||
6338 | @smallexample | |
6339 | SECTIONS | |
6340 | @{ | |
6341 | start_of_text = . ; | |
6342 | .text: @{ *(.text) @} | |
6343 | end_of_text = . ; | |
6344 | ||
6345 | start_of_data = . ; | |
6346 | .data: @{ *(.data) @} | |
6347 | end_of_data = . ; | |
6348 | @} | |
6349 | @end smallexample | |
6350 | ||
6351 | If the linker needs to place some input section, e.g. @code{.rodata}, | |
6352 | not mentioned in the script, it might choose to place that section | |
6353 | between @code{.text} and @code{.data}. You might think the linker | |
6354 | should place @code{.rodata} on the blank line in the above script, but | |
6355 | blank lines are of no particular significance to the linker. As well, | |
6356 | the linker doesn't associate the above symbol names with their | |
6357 | sections. Instead, it assumes that all assignments or other | |
6358 | statements belong to the previous output section, except for the | |
6359 | special case of an assignment to @code{.}. I.e., the linker will | |
6360 | place the orphan @code{.rodata} section as if the script was written | |
6361 | as follows: | |
6362 | ||
6363 | @smallexample | |
6364 | SECTIONS | |
6365 | @{ | |
6366 | start_of_text = . ; | |
6367 | .text: @{ *(.text) @} | |
6368 | end_of_text = . ; | |
6369 | ||
6370 | start_of_data = . ; | |
6371 | .rodata: @{ *(.rodata) @} | |
6372 | .data: @{ *(.data) @} | |
6373 | end_of_data = . ; | |
6374 | @} | |
6375 | @end smallexample | |
6376 | ||
6377 | This may or may not be the script author's intention for the value of | |
6378 | @code{start_of_data}. One way to influence the orphan section | |
6379 | placement is to assign the location counter to itself, as the linker | |
6380 | assumes that an assignment to @code{.} is setting the start address of | |
6381 | a following output section and thus should be grouped with that | |
6382 | section. So you could write: | |
6383 | ||
6384 | @smallexample | |
6385 | SECTIONS | |
6386 | @{ | |
6387 | start_of_text = . ; | |
6388 | .text: @{ *(.text) @} | |
6389 | end_of_text = . ; | |
6390 | ||
6391 | . = . ; | |
6392 | start_of_data = . ; | |
6393 | .data: @{ *(.data) @} | |
6394 | end_of_data = . ; | |
6395 | @} | |
6396 | @end smallexample | |
6397 | ||
6398 | Now, the orphan @code{.rodata} section will be placed between | |
6399 | @code{end_of_text} and @code{start_of_data}. | |
6400 | ||
252b5132 RH |
6401 | @need 2000 |
6402 | @node Operators | |
6403 | @subsection Operators | |
6404 | @cindex operators for arithmetic | |
6405 | @cindex arithmetic operators | |
6406 | @cindex precedence in expressions | |
6407 | The linker recognizes the standard C set of arithmetic operators, with | |
6408 | the standard bindings and precedence levels: | |
6409 | @c TEXI2ROFF-KILL | |
36f63dca | 6410 | @ifnottex |
252b5132 RH |
6411 | @c END TEXI2ROFF-KILL |
6412 | @smallexample | |
6413 | precedence associativity Operators Notes | |
6414 | (highest) | |
6415 | 1 left ! - ~ (1) | |
6416 | 2 left * / % | |
6417 | 3 left + - | |
6418 | 4 left >> << | |
6419 | 5 left == != > < <= >= | |
6420 | 6 left & | |
6421 | 7 left | | |
6422 | 8 left && | |
6423 | 9 left || | |
6424 | 10 right ? : | |
6425 | 11 right &= += -= *= /= (2) | |
6426 | (lowest) | |
6427 | @end smallexample | |
6428 | Notes: | |
a1ab1d2a | 6429 | (1) Prefix operators |
252b5132 RH |
6430 | (2) @xref{Assignments}. |
6431 | @c TEXI2ROFF-KILL | |
36f63dca | 6432 | @end ifnottex |
252b5132 RH |
6433 | @tex |
6434 | \vskip \baselineskip | |
6435 | %"lispnarrowing" is the extra indent used generally for smallexample | |
6436 | \hskip\lispnarrowing\vbox{\offinterlineskip | |
6437 | \hrule | |
6438 | \halign | |
6439 | {\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ #\ \hfil&\vrule#&\strut\hfil\ {\tt #}\ \hfil&\vrule#\cr | |
6440 | height2pt&\omit&&\omit&&\omit&\cr | |
6441 | &Precedence&& Associativity &&{\rm Operators}&\cr | |
6442 | height2pt&\omit&&\omit&&\omit&\cr | |
6443 | \noalign{\hrule} | |
6444 | height2pt&\omit&&\omit&&\omit&\cr | |
6445 | &highest&&&&&\cr | |
6446 | % '176 is tilde, '~' in tt font | |
a1ab1d2a | 6447 | &1&&left&&\qquad- \char'176\ !\qquad\dag&\cr |
252b5132 RH |
6448 | &2&&left&&* / \%&\cr |
6449 | &3&&left&&+ -&\cr | |
6450 | &4&&left&&>> <<&\cr | |
6451 | &5&&left&&== != > < <= >=&\cr | |
6452 | &6&&left&&\&&\cr | |
6453 | &7&&left&&|&\cr | |
6454 | &8&&left&&{\&\&}&\cr | |
6455 | &9&&left&&||&\cr | |
6456 | &10&&right&&? :&\cr | |
6457 | &11&&right&&\qquad\&= += -= *= /=\qquad\ddag&\cr | |
6458 | &lowest&&&&&\cr | |
6459 | height2pt&\omit&&\omit&&\omit&\cr} | |
6460 | \hrule} | |
6461 | @end tex | |
6462 | @iftex | |
6463 | { | |
6464 | @obeylines@parskip=0pt@parindent=0pt | |
6465 | @dag@quad Prefix operators. | |
6466 | @ddag@quad @xref{Assignments}. | |
6467 | } | |
6468 | @end iftex | |
6469 | @c END TEXI2ROFF-KILL | |
6470 | ||
6471 | @node Evaluation | |
6472 | @subsection Evaluation | |
6473 | @cindex lazy evaluation | |
6474 | @cindex expression evaluation order | |
6475 | The linker evaluates expressions lazily. It only computes the value of | |
6476 | an expression when absolutely necessary. | |
6477 | ||
6478 | The linker needs some information, such as the value of the start | |
6479 | address of the first section, and the origins and lengths of memory | |
6480 | regions, in order to do any linking at all. These values are computed | |
6481 | as soon as possible when the linker reads in the linker script. | |
6482 | ||
6483 | However, other values (such as symbol values) are not known or needed | |
6484 | until after storage allocation. Such values are evaluated later, when | |
6485 | other information (such as the sizes of output sections) is available | |
6486 | for use in the symbol assignment expression. | |
6487 | ||
6488 | The sizes of sections cannot be known until after allocation, so | |
6489 | assignments dependent upon these are not performed until after | |
6490 | allocation. | |
6491 | ||
6492 | Some expressions, such as those depending upon the location counter | |
6493 | @samp{.}, must be evaluated during section allocation. | |
6494 | ||
6495 | If the result of an expression is required, but the value is not | |
6496 | available, then an error results. For example, a script like the | |
6497 | following | |
6498 | @smallexample | |
6499 | @group | |
6500 | SECTIONS | |
6501 | @{ | |
a1ab1d2a | 6502 | .text 9+this_isnt_constant : |
252b5132 RH |
6503 | @{ *(.text) @} |
6504 | @} | |
6505 | @end group | |
6506 | @end smallexample | |
6507 | @noindent | |
6508 | will cause the error message @samp{non constant expression for initial | |
6509 | address}. | |
6510 | ||
6511 | @node Expression Section | |
6512 | @subsection The Section of an Expression | |
6513 | @cindex expression sections | |
6514 | @cindex absolute expressions | |
6515 | @cindex relative expressions | |
6516 | @cindex absolute and relocatable symbols | |
6517 | @cindex relocatable and absolute symbols | |
6518 | @cindex symbols, relocatable and absolute | |
7542af2a AM |
6519 | Addresses and symbols may be section relative, or absolute. A section |
6520 | relative symbol is relocatable. If you request relocatable output | |
6521 | using the @samp{-r} option, a further link operation may change the | |
6522 | value of a section relative symbol. On the other hand, an absolute | |
6523 | symbol will retain the same value throughout any further link | |
6524 | operations. | |
6525 | ||
abf4be64 AM |
6526 | Some terms in linker expressions are addresses. This is true of |
6527 | section relative symbols and for builtin functions that return an | |
6528 | address, such as @code{ADDR}, @code{LOADADDR}, @code{ORIGIN} and | |
6529 | @code{SEGMENT_START}. Other terms are simply numbers, or are builtin | |
6530 | functions that return a non-address value, such as @code{LENGTH}. | |
01554a74 AM |
6531 | One complication is that unless you set @code{LD_FEATURE ("SANE_EXPR")} |
6532 | (@pxref{Miscellaneous Commands}), numbers and absolute symbols are treated | |
5c3049d2 AM |
6533 | differently depending on their location, for compatibility with older |
6534 | versions of @code{ld}. Expressions appearing outside an output | |
6535 | section definition treat all numbers as absolute addresses. | |
6536 | Expressions appearing inside an output section definition treat | |
01554a74 AM |
6537 | absolute symbols as numbers. If @code{LD_FEATURE ("SANE_EXPR")} is |
6538 | given, then absolute symbols and numbers are simply treated as numbers | |
6539 | everywhere. | |
5c3049d2 AM |
6540 | |
6541 | In the following simple example, | |
252b5132 | 6542 | |
7542af2a AM |
6543 | @smallexample |
6544 | @group | |
6545 | SECTIONS | |
6546 | @{ | |
6547 | . = 0x100; | |
6548 | __executable_start = 0x100; | |
6549 | .data : | |
6550 | @{ | |
6551 | . = 0x10; | |
6552 | __data_start = 0x10; | |
6553 | *(.data) | |
6554 | @} | |
6555 | @dots{} | |
6556 | @} | |
6557 | @end group | |
6558 | @end smallexample | |
252b5132 | 6559 | |
7542af2a AM |
6560 | both @code{.} and @code{__executable_start} are set to the absolute |
6561 | address 0x100 in the first two assignments, then both @code{.} and | |
6562 | @code{__data_start} are set to 0x10 relative to the @code{.data} | |
6563 | section in the second two assignments. | |
252b5132 | 6564 | |
5c3049d2 AM |
6565 | For expressions involving numbers, relative addresses and absolute |
6566 | addresses, ld follows these rules to evaluate terms: | |
7542af2a AM |
6567 | |
6568 | @itemize @bullet | |
6569 | @item | |
c05f749e AM |
6570 | Unary operations on an absolute address or number, and binary |
6571 | operations on two absolute addresses or two numbers, or between one | |
6572 | absolute address and a number, apply the operator to the value(s). | |
6573 | @item | |
7542af2a AM |
6574 | Unary operations on a relative address, and binary operations on two |
6575 | relative addresses in the same section or between one relative address | |
6576 | and a number, apply the operator to the offset part of the address(es). | |
6577 | @item | |
c05f749e AM |
6578 | Other binary operations, that is, between two relative addresses not |
6579 | in the same section, or between a relative address and an absolute | |
6580 | address, first convert any non-absolute term to an absolute address | |
6581 | before applying the operator. | |
7542af2a AM |
6582 | @end itemize |
6583 | ||
6584 | The result section of each sub-expression is as follows: | |
6585 | ||
6586 | @itemize @bullet | |
6587 | @item | |
6588 | An operation involving only numbers results in a number. | |
6589 | @item | |
6590 | The result of comparisons, @samp{&&} and @samp{||} is also a number. | |
6591 | @item | |
9bc8bb33 | 6592 | The result of other binary arithmetic and logical operations on two |
11e7fd74 | 6593 | relative addresses in the same section or two absolute addresses |
94b41882 AM |
6594 | (after above conversions) is also a number when |
6595 | @code{LD_FEATURE ("SANE_EXPR")} or inside an output section definition | |
6596 | but an absolute address otherwise. | |
9bc8bb33 AM |
6597 | @item |
6598 | The result of other operations on relative addresses or one | |
6599 | relative address and a number, is a relative address in the same | |
6600 | section as the relative operand(s). | |
7542af2a AM |
6601 | @item |
6602 | The result of other operations on absolute addresses (after above | |
6603 | conversions) is an absolute address. | |
6604 | @end itemize | |
252b5132 RH |
6605 | |
6606 | You can use the builtin function @code{ABSOLUTE} to force an expression | |
6607 | to be absolute when it would otherwise be relative. For example, to | |
6608 | create an absolute symbol set to the address of the end of the output | |
6609 | section @samp{.data}: | |
6610 | @smallexample | |
6611 | SECTIONS | |
6612 | @{ | |
6613 | .data : @{ *(.data) _edata = ABSOLUTE(.); @} | |
6614 | @} | |
6615 | @end smallexample | |
6616 | @noindent | |
6617 | If @samp{ABSOLUTE} were not used, @samp{_edata} would be relative to the | |
6618 | @samp{.data} section. | |
6619 | ||
7542af2a AM |
6620 | Using @code{LOADADDR} also forces an expression absolute, since this |
6621 | particular builtin function returns an absolute address. | |
6622 | ||
252b5132 RH |
6623 | @node Builtin Functions |
6624 | @subsection Builtin Functions | |
6625 | @cindex functions in expressions | |
6626 | The linker script language includes a number of builtin functions for | |
6627 | use in linker script expressions. | |
6628 | ||
6629 | @table @code | |
6630 | @item ABSOLUTE(@var{exp}) | |
6631 | @kindex ABSOLUTE(@var{exp}) | |
6632 | @cindex expression, absolute | |
6633 | Return the absolute (non-relocatable, as opposed to non-negative) value | |
6634 | of the expression @var{exp}. Primarily useful to assign an absolute | |
6635 | value to a symbol within a section definition, where symbol values are | |
6636 | normally section relative. @xref{Expression Section}. | |
6637 | ||
6638 | @item ADDR(@var{section}) | |
6639 | @kindex ADDR(@var{section}) | |
6640 | @cindex section address in expression | |
7542af2a | 6641 | Return the address (VMA) of the named @var{section}. Your |
252b5132 | 6642 | script must previously have defined the location of that section. In |
7542af2a AM |
6643 | the following example, @code{start_of_output_1}, @code{symbol_1} and |
6644 | @code{symbol_2} are assigned equivalent values, except that | |
6645 | @code{symbol_1} will be relative to the @code{.output1} section while | |
6646 | the other two will be absolute: | |
252b5132 RH |
6647 | @smallexample |
6648 | @group | |
6649 | SECTIONS @{ @dots{} | |
6650 | .output1 : | |
a1ab1d2a | 6651 | @{ |
252b5132 RH |
6652 | start_of_output_1 = ABSOLUTE(.); |
6653 | @dots{} | |
6654 | @} | |
6655 | .output : | |
6656 | @{ | |
6657 | symbol_1 = ADDR(.output1); | |
6658 | symbol_2 = start_of_output_1; | |
6659 | @} | |
6660 | @dots{} @} | |
6661 | @end group | |
6662 | @end smallexample | |
6663 | ||
876f4090 NS |
6664 | @item ALIGN(@var{align}) |
6665 | @itemx ALIGN(@var{exp},@var{align}) | |
6666 | @kindex ALIGN(@var{align}) | |
6667 | @kindex ALIGN(@var{exp},@var{align}) | |
252b5132 RH |
6668 | @cindex round up location counter |
6669 | @cindex align location counter | |
876f4090 NS |
6670 | @cindex round up expression |
6671 | @cindex align expression | |
6672 | Return the location counter (@code{.}) or arbitrary expression aligned | |
6673 | to the next @var{align} boundary. The single operand @code{ALIGN} | |
6674 | doesn't change the value of the location counter---it just does | |
6675 | arithmetic on it. The two operand @code{ALIGN} allows an arbitrary | |
6676 | expression to be aligned upwards (@code{ALIGN(@var{align})} is | |
e0a3af22 | 6677 | equivalent to @code{ALIGN(ABSOLUTE(.), @var{align})}). |
876f4090 NS |
6678 | |
6679 | Here is an example which aligns the output @code{.data} section to the | |
6680 | next @code{0x2000} byte boundary after the preceding section and sets a | |
6681 | variable within the section to the next @code{0x8000} boundary after the | |
6682 | input sections: | |
252b5132 RH |
6683 | @smallexample |
6684 | @group | |
6685 | SECTIONS @{ @dots{} | |
6686 | .data ALIGN(0x2000): @{ | |
6687 | *(.data) | |
6688 | variable = ALIGN(0x8000); | |
6689 | @} | |
6690 | @dots{} @} | |
6691 | @end group | |
6692 | @end smallexample | |
6693 | @noindent | |
6694 | The first use of @code{ALIGN} in this example specifies the location of | |
6695 | a section because it is used as the optional @var{address} attribute of | |
6696 | a section definition (@pxref{Output Section Address}). The second use | |
6697 | of @code{ALIGN} is used to defines the value of a symbol. | |
6698 | ||
6699 | The builtin function @code{NEXT} is closely related to @code{ALIGN}. | |
6700 | ||
362c1d1a NS |
6701 | @item ALIGNOF(@var{section}) |
6702 | @kindex ALIGNOF(@var{section}) | |
6703 | @cindex section alignment | |
6704 | Return the alignment in bytes of the named @var{section}, if that section has | |
6705 | been allocated. If the section has not been allocated when this is | |
6706 | evaluated, the linker will report an error. In the following example, | |
6707 | the alignment of the @code{.output} section is stored as the first | |
6708 | value in that section. | |
6709 | @smallexample | |
6710 | @group | |
6711 | SECTIONS@{ @dots{} | |
6712 | .output @{ | |
6713 | LONG (ALIGNOF (.output)) | |
6714 | @dots{} | |
6715 | @} | |
6716 | @dots{} @} | |
6717 | @end group | |
6718 | @end smallexample | |
6719 | ||
252b5132 RH |
6720 | @item BLOCK(@var{exp}) |
6721 | @kindex BLOCK(@var{exp}) | |
6722 | This is a synonym for @code{ALIGN}, for compatibility with older linker | |
6723 | scripts. It is most often seen when setting the address of an output | |
6724 | section. | |
6725 | ||
2d20f7bf JJ |
6726 | @item DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) |
6727 | @kindex DATA_SEGMENT_ALIGN(@var{maxpagesize}, @var{commonpagesize}) | |
6728 | This is equivalent to either | |
6729 | @smallexample | |
6730 | (ALIGN(@var{maxpagesize}) + (. & (@var{maxpagesize} - 1))) | |
6731 | @end smallexample | |
6732 | or | |
6733 | @smallexample | |
fe6052e1 AM |
6734 | (ALIGN(@var{maxpagesize}) |
6735 | + ((. + @var{commonpagesize} - 1) & (@var{maxpagesize} - @var{commonpagesize}))) | |
2d20f7bf JJ |
6736 | @end smallexample |
6737 | @noindent | |
6738 | depending on whether the latter uses fewer @var{commonpagesize} sized pages | |
6739 | for the data segment (area between the result of this expression and | |
6740 | @code{DATA_SEGMENT_END}) than the former or not. | |
6741 | If the latter form is used, it means @var{commonpagesize} bytes of runtime | |
6742 | memory will be saved at the expense of up to @var{commonpagesize} wasted | |
6743 | bytes in the on-disk file. | |
6744 | ||
6745 | This expression can only be used directly in @code{SECTIONS} commands, not in | |
6746 | any output section descriptions and only once in the linker script. | |
6747 | @var{commonpagesize} should be less or equal to @var{maxpagesize} and should | |
def5c83c AM |
6748 | be the system page size the object wants to be optimized for while still |
6749 | running on system page sizes up to @var{maxpagesize}. Note however | |
6750 | that @samp{-z relro} protection will not be effective if the system | |
6751 | page size is larger than @var{commonpagesize}. | |
2d20f7bf JJ |
6752 | |
6753 | @noindent | |
6754 | Example: | |
6755 | @smallexample | |
6756 | . = DATA_SEGMENT_ALIGN(0x10000, 0x2000); | |
6757 | @end smallexample | |
6758 | ||
6759 | @item DATA_SEGMENT_END(@var{exp}) | |
6760 | @kindex DATA_SEGMENT_END(@var{exp}) | |
6761 | This defines the end of data segment for @code{DATA_SEGMENT_ALIGN} | |
6762 | evaluation purposes. | |
6763 | ||
6764 | @smallexample | |
6765 | . = DATA_SEGMENT_END(.); | |
6766 | @end smallexample | |
6767 | ||
a4f5ad88 JJ |
6768 | @item DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) |
6769 | @kindex DATA_SEGMENT_RELRO_END(@var{offset}, @var{exp}) | |
6770 | This defines the end of the @code{PT_GNU_RELRO} segment when | |
eec2f3ed | 6771 | @samp{-z relro} option is used. |
a4f5ad88 JJ |
6772 | When @samp{-z relro} option is not present, @code{DATA_SEGMENT_RELRO_END} |
6773 | does nothing, otherwise @code{DATA_SEGMENT_ALIGN} is padded so that | |
def5c83c AM |
6774 | @var{exp} + @var{offset} is aligned to the @var{commonpagesize} |
6775 | argument given to @code{DATA_SEGMENT_ALIGN}. If present in the linker | |
6776 | script, it must be placed between @code{DATA_SEGMENT_ALIGN} and | |
eec2f3ed AM |
6777 | @code{DATA_SEGMENT_END}. Evaluates to the second argument plus any |
6778 | padding needed at the end of the @code{PT_GNU_RELRO} segment due to | |
6779 | section alignment. | |
a4f5ad88 JJ |
6780 | |
6781 | @smallexample | |
6782 | . = DATA_SEGMENT_RELRO_END(24, .); | |
6783 | @end smallexample | |
6784 | ||
252b5132 RH |
6785 | @item DEFINED(@var{symbol}) |
6786 | @kindex DEFINED(@var{symbol}) | |
6787 | @cindex symbol defaults | |
6788 | Return 1 if @var{symbol} is in the linker global symbol table and is | |
420e579c HPN |
6789 | defined before the statement using DEFINED in the script, otherwise |
6790 | return 0. You can use this function to provide | |
252b5132 RH |
6791 | default values for symbols. For example, the following script fragment |
6792 | shows how to set a global symbol @samp{begin} to the first location in | |
6793 | the @samp{.text} section---but if a symbol called @samp{begin} already | |
6794 | existed, its value is preserved: | |
6795 | ||
6796 | @smallexample | |
6797 | @group | |
6798 | SECTIONS @{ @dots{} | |
6799 | .text : @{ | |
6800 | begin = DEFINED(begin) ? begin : . ; | |
6801 | @dots{} | |
6802 | @} | |
6803 | @dots{} | |
6804 | @} | |
6805 | @end group | |
6806 | @end smallexample | |
6807 | ||
3ec57632 NC |
6808 | @item LENGTH(@var{memory}) |
6809 | @kindex LENGTH(@var{memory}) | |
6810 | Return the length of the memory region named @var{memory}. | |
6811 | ||
252b5132 RH |
6812 | @item LOADADDR(@var{section}) |
6813 | @kindex LOADADDR(@var{section}) | |
6814 | @cindex section load address in expression | |
7542af2a | 6815 | Return the absolute LMA of the named @var{section}. (@pxref{Output |
252b5132 RH |
6816 | Section LMA}). |
6817 | ||
2e53f7d6 NC |
6818 | @item LOG2CEIL(@var{exp}) |
6819 | @kindex LOG2CEIL(@var{exp}) | |
6820 | Return the binary logarithm of @var{exp} rounded towards infinity. | |
6821 | @code{LOG2CEIL(0)} returns 0. | |
6822 | ||
252b5132 RH |
6823 | @kindex MAX |
6824 | @item MAX(@var{exp1}, @var{exp2}) | |
6825 | Returns the maximum of @var{exp1} and @var{exp2}. | |
6826 | ||
6827 | @kindex MIN | |
6828 | @item MIN(@var{exp1}, @var{exp2}) | |
6829 | Returns the minimum of @var{exp1} and @var{exp2}. | |
6830 | ||
6831 | @item NEXT(@var{exp}) | |
6832 | @kindex NEXT(@var{exp}) | |
6833 | @cindex unallocated address, next | |
6834 | Return the next unallocated address that is a multiple of @var{exp}. | |
6835 | This function is closely related to @code{ALIGN(@var{exp})}; unless you | |
6836 | use the @code{MEMORY} command to define discontinuous memory for the | |
6837 | output file, the two functions are equivalent. | |
6838 | ||
3ec57632 NC |
6839 | @item ORIGIN(@var{memory}) |
6840 | @kindex ORIGIN(@var{memory}) | |
6841 | Return the origin of the memory region named @var{memory}. | |
6842 | ||
ba916c8a MM |
6843 | @item SEGMENT_START(@var{segment}, @var{default}) |
6844 | @kindex SEGMENT_START(@var{segment}, @var{default}) | |
6845 | Return the base address of the named @var{segment}. If an explicit | |
c5da8c7d NC |
6846 | value has already been given for this segment (with a command-line |
6847 | @samp{-T} option) then that value will be returned otherwise the value | |
6848 | will be @var{default}. At present, the @samp{-T} command-line option | |
6849 | can only be used to set the base address for the ``text'', ``data'', and | |
7542af2a | 6850 | ``bss'' sections, but you can use @code{SEGMENT_START} with any segment |
ba916c8a MM |
6851 | name. |
6852 | ||
252b5132 RH |
6853 | @item SIZEOF(@var{section}) |
6854 | @kindex SIZEOF(@var{section}) | |
6855 | @cindex section size | |
6856 | Return the size in bytes of the named @var{section}, if that section has | |
6857 | been allocated. If the section has not been allocated when this is | |
6858 | evaluated, the linker will report an error. In the following example, | |
6859 | @code{symbol_1} and @code{symbol_2} are assigned identical values: | |
6860 | @smallexample | |
6861 | @group | |
6862 | SECTIONS@{ @dots{} | |
6863 | .output @{ | |
6864 | .start = . ; | |
6865 | @dots{} | |
6866 | .end = . ; | |
6867 | @} | |
6868 | symbol_1 = .end - .start ; | |
6869 | symbol_2 = SIZEOF(.output); | |
6870 | @dots{} @} | |
6871 | @end group | |
6872 | @end smallexample | |
6873 | ||
6874 | @item SIZEOF_HEADERS | |
6875 | @itemx sizeof_headers | |
6876 | @kindex SIZEOF_HEADERS | |
6877 | @cindex header size | |
6878 | Return the size in bytes of the output file's headers. This is | |
6879 | information which appears at the start of the output file. You can use | |
6880 | this number when setting the start address of the first section, if you | |
6881 | choose, to facilitate paging. | |
6882 | ||
6883 | @cindex not enough room for program headers | |
6884 | @cindex program headers, not enough room | |
6885 | When producing an ELF output file, if the linker script uses the | |
6886 | @code{SIZEOF_HEADERS} builtin function, the linker must compute the | |
6887 | number of program headers before it has determined all the section | |
6888 | addresses and sizes. If the linker later discovers that it needs | |
6889 | additional program headers, it will report an error @samp{not enough | |
6890 | room for program headers}. To avoid this error, you must avoid using | |
6891 | the @code{SIZEOF_HEADERS} function, or you must rework your linker | |
6892 | script to avoid forcing the linker to use additional program headers, or | |
6893 | you must define the program headers yourself using the @code{PHDRS} | |
6894 | command (@pxref{PHDRS}). | |
6895 | @end table | |
6896 | ||
6897 | @node Implicit Linker Scripts | |
6898 | @section Implicit Linker Scripts | |
6899 | @cindex implicit linker scripts | |
6900 | If you specify a linker input file which the linker can not recognize as | |
6901 | an object file or an archive file, it will try to read the file as a | |
6902 | linker script. If the file can not be parsed as a linker script, the | |
6903 | linker will report an error. | |
6904 | ||
6905 | An implicit linker script will not replace the default linker script. | |
6906 | ||
6907 | Typically an implicit linker script would contain only symbol | |
6908 | assignments, or the @code{INPUT}, @code{GROUP}, or @code{VERSION} | |
6909 | commands. | |
6910 | ||
6911 | Any input files read because of an implicit linker script will be read | |
6912 | at the position in the command line where the implicit linker script was | |
6913 | read. This can affect archive searching. | |
6914 | ||
6915 | @ifset GENERIC | |
6916 | @node Machine Dependent | |
6917 | @chapter Machine Dependent Features | |
6918 | ||
6919 | @cindex machine dependencies | |
ff5dcc92 SC |
6920 | @command{ld} has additional features on some platforms; the following |
6921 | sections describe them. Machines where @command{ld} has no additional | |
252b5132 RH |
6922 | functionality are not listed. |
6923 | ||
6924 | @menu | |
36f63dca NC |
6925 | @ifset H8300 |
6926 | * H8/300:: @command{ld} and the H8/300 | |
6927 | @end ifset | |
7ca01ed9 NC |
6928 | @ifset M68HC11 |
6929 | * M68HC11/68HC12:: @code{ld} and the Motorola 68HC11 and 68HC12 families | |
6930 | @end ifset | |
36f63dca NC |
6931 | @ifset ARM |
6932 | * ARM:: @command{ld} and the ARM family | |
6933 | @end ifset | |
6934 | @ifset HPPA | |
6935 | * HPPA ELF32:: @command{ld} and HPPA 32-bit ELF | |
6936 | @end ifset | |
7fb9f789 NC |
6937 | @ifset M68K |
6938 | * M68K:: @command{ld} and the Motorola 68K family | |
6939 | @end ifset | |
833794fc MR |
6940 | @ifset MIPS |
6941 | * MIPS:: @command{ld} and the MIPS family | |
6942 | @end ifset | |
3c3bdf30 | 6943 | @ifset MMIX |
36f63dca | 6944 | * MMIX:: @command{ld} and MMIX |
3c3bdf30 | 6945 | @end ifset |
2469cfa2 | 6946 | @ifset MSP430 |
36f63dca | 6947 | * MSP430:: @command{ld} and MSP430 |
2469cfa2 | 6948 | @end ifset |
35c08157 KLC |
6949 | @ifset NDS32 |
6950 | * NDS32:: @command{ld} and NDS32 | |
6951 | @end ifset | |
78058a5e SL |
6952 | @ifset NIOSII |
6953 | * Nios II:: @command{ld} and the Altera Nios II | |
6954 | @end ifset | |
2a60a7a8 AM |
6955 | @ifset POWERPC |
6956 | * PowerPC ELF32:: @command{ld} and PowerPC 32-bit ELF Support | |
6957 | @end ifset | |
6958 | @ifset POWERPC64 | |
6959 | * PowerPC64 ELF64:: @command{ld} and PowerPC64 64-bit ELF Support | |
6960 | @end ifset | |
b4cbbe8f AK |
6961 | @ifset S/390 |
6962 | * S/390 ELF:: @command{ld} and S/390 ELF Support | |
6963 | @end ifset | |
49fa1e15 AM |
6964 | @ifset SPU |
6965 | * SPU ELF:: @command{ld} and SPU ELF Support | |
6966 | @end ifset | |
74459f0e | 6967 | @ifset TICOFF |
ff5dcc92 | 6968 | * TI COFF:: @command{ld} and TI COFF |
74459f0e | 6969 | @end ifset |
2ca22b03 NC |
6970 | @ifset WIN32 |
6971 | * WIN32:: @command{ld} and WIN32 (cygwin/mingw) | |
6972 | @end ifset | |
e0001a05 NC |
6973 | @ifset XTENSA |
6974 | * Xtensa:: @command{ld} and Xtensa Processors | |
6975 | @end ifset | |
252b5132 RH |
6976 | @end menu |
6977 | @end ifset | |
6978 | ||
252b5132 RH |
6979 | @ifset H8300 |
6980 | @ifclear GENERIC | |
6981 | @raisesections | |
6982 | @end ifclear | |
6983 | ||
6984 | @node H8/300 | |
ff5dcc92 | 6985 | @section @command{ld} and the H8/300 |
252b5132 RH |
6986 | |
6987 | @cindex H8/300 support | |
ff5dcc92 | 6988 | For the H8/300, @command{ld} can perform these global optimizations when |
252b5132 RH |
6989 | you specify the @samp{--relax} command-line option. |
6990 | ||
6991 | @table @emph | |
6992 | @cindex relaxing on H8/300 | |
6993 | @item relaxing address modes | |
ff5dcc92 | 6994 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose |
252b5132 RH |
6995 | targets are within eight bits, and turns them into eight-bit |
6996 | program-counter relative @code{bsr} and @code{bra} instructions, | |
6997 | respectively. | |
6998 | ||
6999 | @cindex synthesizing on H8/300 | |
7000 | @item synthesizing instructions | |
81f5558e | 7001 | @c FIXME: specifically mov.b, or any mov instructions really? -> mov.b only, at least on H8, H8H, H8S |
ff5dcc92 | 7002 | @command{ld} finds all @code{mov.b} instructions which use the |
252b5132 RH |
7003 | sixteen-bit absolute address form, but refer to the top |
7004 | page of memory, and changes them to use the eight-bit address form. | |
7005 | (That is: the linker turns @samp{mov.b @code{@@}@var{aa}:16} into | |
7006 | @samp{mov.b @code{@@}@var{aa}:8} whenever the address @var{aa} is in the | |
7007 | top page of memory). | |
1502569c | 7008 | |
81f5558e NC |
7009 | @command{ld} finds all @code{mov} instructions which use the register |
7010 | indirect with 32-bit displacement addressing mode, but use a small | |
7011 | displacement inside 16-bit displacement range, and changes them to use | |
7012 | the 16-bit displacement form. (That is: the linker turns @samp{mov.b | |
7013 | @code{@@}@var{d}:32,ERx} into @samp{mov.b @code{@@}@var{d}:16,ERx} | |
7014 | whenever the displacement @var{d} is in the 16 bit signed integer | |
7015 | range. Only implemented in ELF-format ld). | |
7016 | ||
1502569c | 7017 | @item bit manipulation instructions |
c0065db7 | 7018 | @command{ld} finds all bit manipulation instructions like @code{band, bclr, |
1502569c | 7019 | biand, bild, bior, bist, bixor, bld, bnot, bor, bset, bst, btst, bxor} |
c0065db7 | 7020 | which use 32 bit and 16 bit absolute address form, but refer to the top |
1502569c NC |
7021 | page of memory, and changes them to use the 8 bit address form. |
7022 | (That is: the linker turns @samp{bset #xx:3,@code{@@}@var{aa}:32} into | |
c0065db7 | 7023 | @samp{bset #xx:3,@code{@@}@var{aa}:8} whenever the address @var{aa} is in |
1502569c NC |
7024 | the top page of memory). |
7025 | ||
7026 | @item system control instructions | |
c0065db7 RM |
7027 | @command{ld} finds all @code{ldc.w, stc.w} instructions which use the |
7028 | 32 bit absolute address form, but refer to the top page of memory, and | |
1502569c NC |
7029 | changes them to use 16 bit address form. |
7030 | (That is: the linker turns @samp{ldc.w @code{@@}@var{aa}:32,ccr} into | |
c0065db7 | 7031 | @samp{ldc.w @code{@@}@var{aa}:16,ccr} whenever the address @var{aa} is in |
1502569c | 7032 | the top page of memory). |
252b5132 RH |
7033 | @end table |
7034 | ||
7035 | @ifclear GENERIC | |
7036 | @lowersections | |
7037 | @end ifclear | |
7038 | @end ifset | |
7039 | ||
36f63dca | 7040 | @ifclear GENERIC |
c2dcd04e | 7041 | @ifset Renesas |
36f63dca | 7042 | @c This stuff is pointless to say unless you're especially concerned |
c2dcd04e NC |
7043 | @c with Renesas chips; don't enable it for generic case, please. |
7044 | @node Renesas | |
7045 | @chapter @command{ld} and Other Renesas Chips | |
36f63dca | 7046 | |
c2dcd04e NC |
7047 | @command{ld} also supports the Renesas (formerly Hitachi) H8/300H, |
7048 | H8/500, and SH chips. No special features, commands, or command-line | |
7049 | options are required for these chips. | |
36f63dca NC |
7050 | @end ifset |
7051 | @end ifclear | |
7052 | ||
36f63dca NC |
7053 | @ifset ARM |
7054 | @ifclear GENERIC | |
7055 | @raisesections | |
7056 | @end ifclear | |
7057 | ||
93fd0973 SC |
7058 | @ifset M68HC11 |
7059 | @ifclear GENERIC | |
7060 | @raisesections | |
7061 | @end ifclear | |
7062 | ||
7063 | @node M68HC11/68HC12 | |
7064 | @section @command{ld} and the Motorola 68HC11 and 68HC12 families | |
7065 | ||
7066 | @cindex M68HC11 and 68HC12 support | |
7067 | ||
7068 | @subsection Linker Relaxation | |
7069 | ||
7070 | For the Motorola 68HC11, @command{ld} can perform these global | |
7071 | optimizations when you specify the @samp{--relax} command-line option. | |
7072 | ||
7073 | @table @emph | |
7074 | @cindex relaxing on M68HC11 | |
7075 | @item relaxing address modes | |
7076 | @command{ld} finds all @code{jsr} and @code{jmp} instructions whose | |
7077 | targets are within eight bits, and turns them into eight-bit | |
7078 | program-counter relative @code{bsr} and @code{bra} instructions, | |
7079 | respectively. | |
7080 | ||
7081 | @command{ld} also looks at all 16-bit extended addressing modes and | |
7082 | transforms them in a direct addressing mode when the address is in | |
7083 | page 0 (between 0 and 0x0ff). | |
7084 | ||
7085 | @item relaxing gcc instruction group | |
7086 | When @command{gcc} is called with @option{-mrelax}, it can emit group | |
7087 | of instructions that the linker can optimize to use a 68HC11 direct | |
7088 | addressing mode. These instructions consists of @code{bclr} or | |
7089 | @code{bset} instructions. | |
7090 | ||
7091 | @end table | |
7092 | ||
7093 | @subsection Trampoline Generation | |
7094 | ||
7095 | @cindex trampoline generation on M68HC11 | |
7096 | @cindex trampoline generation on M68HC12 | |
7097 | For 68HC11 and 68HC12, @command{ld} can generate trampoline code to | |
7098 | call a far function using a normal @code{jsr} instruction. The linker | |
c0065db7 | 7099 | will also change the relocation to some far function to use the |
93fd0973 SC |
7100 | trampoline address instead of the function address. This is typically the |
7101 | case when a pointer to a function is taken. The pointer will in fact | |
7102 | point to the function trampoline. | |
7103 | ||
7104 | @ifclear GENERIC | |
7105 | @lowersections | |
7106 | @end ifclear | |
7107 | @end ifset | |
7108 | ||
36f63dca | 7109 | @node ARM |
3674e28a | 7110 | @section @command{ld} and the ARM family |
36f63dca NC |
7111 | |
7112 | @cindex ARM interworking support | |
7113 | @kindex --support-old-code | |
7114 | For the ARM, @command{ld} will generate code stubs to allow functions calls | |
b45619c0 | 7115 | between ARM and Thumb code. These stubs only work with code that has |
36f63dca NC |
7116 | been compiled and assembled with the @samp{-mthumb-interwork} command |
7117 | line option. If it is necessary to link with old ARM object files or | |
7118 | libraries, which have not been compiled with the -mthumb-interwork | |
a05a5b64 | 7119 | option then the @samp{--support-old-code} command-line switch should be |
36f63dca NC |
7120 | given to the linker. This will make it generate larger stub functions |
7121 | which will work with non-interworking aware ARM code. Note, however, | |
7122 | the linker does not support generating stubs for function calls to | |
7123 | non-interworking aware Thumb code. | |
7124 | ||
7125 | @cindex thumb entry point | |
7126 | @cindex entry point, thumb | |
7127 | @kindex --thumb-entry=@var{entry} | |
7128 | The @samp{--thumb-entry} switch is a duplicate of the generic | |
7129 | @samp{--entry} switch, in that it sets the program's starting address. | |
7130 | But it also sets the bottom bit of the address, so that it can be | |
7131 | branched to using a BX instruction, and the program will start | |
7132 | executing in Thumb mode straight away. | |
7133 | ||
ce11ba6c KT |
7134 | @cindex PE import table prefixing |
7135 | @kindex --use-nul-prefixed-import-tables | |
7136 | The @samp{--use-nul-prefixed-import-tables} switch is specifying, that | |
7137 | the import tables idata4 and idata5 have to be generated with a zero | |
11e7fd74 | 7138 | element prefix for import libraries. This is the old style to generate |
ce11ba6c KT |
7139 | import tables. By default this option is turned off. |
7140 | ||
e489d0ae PB |
7141 | @cindex BE8 |
7142 | @kindex --be8 | |
7143 | The @samp{--be8} switch instructs @command{ld} to generate BE8 format | |
080bb7bb NC |
7144 | executables. This option is only valid when linking big-endian |
7145 | objects - ie ones which have been assembled with the @option{-EB} | |
7146 | option. The resulting image will contain big-endian data and | |
7147 | little-endian code. | |
e489d0ae | 7148 | |
3674e28a PB |
7149 | @cindex TARGET1 |
7150 | @kindex --target1-rel | |
7151 | @kindex --target1-abs | |
7152 | The @samp{R_ARM_TARGET1} relocation is typically used for entries in the | |
7153 | @samp{.init_array} section. It is interpreted as either @samp{R_ARM_REL32} | |
7154 | or @samp{R_ARM_ABS32}, depending on the target. The @samp{--target1-rel} | |
7155 | and @samp{--target1-abs} switches override the default. | |
7156 | ||
7157 | @cindex TARGET2 | |
7158 | @kindex --target2=@var{type} | |
7159 | The @samp{--target2=type} switch overrides the default definition of the | |
7160 | @samp{R_ARM_TARGET2} relocation. Valid values for @samp{type}, their | |
7161 | meanings, and target defaults are as follows: | |
7162 | @table @samp | |
7163 | @item rel | |
eeac373a PB |
7164 | @samp{R_ARM_REL32} (arm*-*-elf, arm*-*-eabi) |
7165 | @item abs | |
7166 | @samp{R_ARM_ABS32} (arm*-*-symbianelf) | |
3674e28a PB |
7167 | @item got-rel |
7168 | @samp{R_ARM_GOT_PREL} (arm*-*-linux, arm*-*-*bsd) | |
7169 | @end table | |
7170 | ||
319850b4 JB |
7171 | @cindex FIX_V4BX |
7172 | @kindex --fix-v4bx | |
7173 | The @samp{R_ARM_V4BX} relocation (defined by the ARM AAELF | |
7174 | specification) enables objects compiled for the ARMv4 architecture to be | |
7175 | interworking-safe when linked with other objects compiled for ARMv4t, but | |
7176 | also allows pure ARMv4 binaries to be built from the same ARMv4 objects. | |
7177 | ||
7178 | In the latter case, the switch @option{--fix-v4bx} must be passed to the | |
7179 | linker, which causes v4t @code{BX rM} instructions to be rewritten as | |
7180 | @code{MOV PC,rM}, since v4 processors do not have a @code{BX} instruction. | |
7181 | ||
7182 | In the former case, the switch should not be used, and @samp{R_ARM_V4BX} | |
7183 | relocations are ignored. | |
7184 | ||
845b51d6 PB |
7185 | @cindex FIX_V4BX_INTERWORKING |
7186 | @kindex --fix-v4bx-interworking | |
7187 | Replace @code{BX rM} instructions identified by @samp{R_ARM_V4BX} | |
7188 | relocations with a branch to the following veneer: | |
7189 | ||
7190 | @smallexample | |
7191 | TST rM, #1 | |
7192 | MOVEQ PC, rM | |
7193 | BX Rn | |
7194 | @end smallexample | |
7195 | ||
7196 | This allows generation of libraries/applications that work on ARMv4 cores | |
7197 | and are still interworking safe. Note that the above veneer clobbers the | |
11e7fd74 | 7198 | condition flags, so may cause incorrect program behavior in rare cases. |
845b51d6 | 7199 | |
33bfe774 JB |
7200 | @cindex USE_BLX |
7201 | @kindex --use-blx | |
7202 | The @samp{--use-blx} switch enables the linker to use ARM/Thumb | |
7203 | BLX instructions (available on ARMv5t and above) in various | |
7204 | situations. Currently it is used to perform calls via the PLT from Thumb | |
7205 | code using BLX rather than using BX and a mode-switching stub before | |
7206 | each PLT entry. This should lead to such calls executing slightly faster. | |
7207 | ||
7208 | This option is enabled implicitly for SymbianOS, so there is no need to | |
7209 | specify it if you are using that target. | |
7210 | ||
c6dd86c6 JB |
7211 | @cindex VFP11_DENORM_FIX |
7212 | @kindex --vfp11-denorm-fix | |
7213 | The @samp{--vfp11-denorm-fix} switch enables a link-time workaround for a | |
7214 | bug in certain VFP11 coprocessor hardware, which sometimes allows | |
7215 | instructions with denorm operands (which must be handled by support code) | |
7216 | to have those operands overwritten by subsequent instructions before | |
7217 | the support code can read the intended values. | |
7218 | ||
7219 | The bug may be avoided in scalar mode if you allow at least one | |
7220 | intervening instruction between a VFP11 instruction which uses a register | |
7221 | and another instruction which writes to the same register, or at least two | |
7222 | intervening instructions if vector mode is in use. The bug only affects | |
7223 | full-compliance floating-point mode: you do not need this workaround if | |
7224 | you are using "runfast" mode. Please contact ARM for further details. | |
7225 | ||
7226 | If you know you are using buggy VFP11 hardware, you can | |
7227 | enable this workaround by specifying the linker option | |
7228 | @samp{--vfp-denorm-fix=scalar} if you are using the VFP11 scalar | |
7229 | mode only, or @samp{--vfp-denorm-fix=vector} if you are using | |
7230 | vector mode (the latter also works for scalar code). The default is | |
7231 | @samp{--vfp-denorm-fix=none}. | |
7232 | ||
7233 | If the workaround is enabled, instructions are scanned for | |
7234 | potentially-troublesome sequences, and a veneer is created for each | |
7235 | such sequence which may trigger the erratum. The veneer consists of the | |
7236 | first instruction of the sequence and a branch back to the subsequent | |
7237 | instruction. The original instruction is then replaced with a branch to | |
7238 | the veneer. The extra cycles required to call and return from the veneer | |
7239 | are sufficient to avoid the erratum in both the scalar and vector cases. | |
7240 | ||
2de70689 MGD |
7241 | @cindex ARM1176 erratum workaround |
7242 | @kindex --fix-arm1176 | |
7243 | @kindex --no-fix-arm1176 | |
9d5777a3 RM |
7244 | The @samp{--fix-arm1176} switch enables a link-time workaround for an erratum |
7245 | in certain ARM1176 processors. The workaround is enabled by default if you | |
7246 | are targeting ARM v6 (excluding ARM v6T2) or earlier. It can be disabled | |
2de70689 MGD |
7247 | unconditionally by specifying @samp{--no-fix-arm1176}. |
7248 | ||
9d5777a3 | 7249 | Further information is available in the ``ARM1176JZ-S and ARM1176JZF-S |
11e7fd74 | 7250 | Programmer Advice Notice'' available on the ARM documentation website at: |
2de70689 MGD |
7251 | http://infocenter.arm.com/. |
7252 | ||
a504d23a LA |
7253 | @cindex STM32L4xx erratum workaround |
7254 | @kindex --fix-stm32l4xx-629360 | |
7255 | ||
7256 | The @samp{--fix-stm32l4xx-629360} switch enables a link-time | |
7257 | workaround for a bug in the bus matrix / memory controller for some of | |
7258 | the STM32 Cortex-M4 based products (STM32L4xx). When accessing | |
7259 | off-chip memory via the affected bus for bus reads of 9 words or more, | |
7260 | the bus can generate corrupt data and/or abort. These are only | |
7261 | core-initiated accesses (not DMA), and might affect any access: | |
7262 | integer loads such as LDM, POP and floating-point loads such as VLDM, | |
7263 | VPOP. Stores are not affected. | |
7264 | ||
7265 | The bug can be avoided by splitting memory accesses into the | |
7266 | necessary chunks to keep bus reads below 8 words. | |
7267 | ||
7268 | The workaround is not enabled by default, this is equivalent to use | |
7269 | @samp{--fix-stm32l4xx-629360=none}. If you know you are using buggy | |
7270 | STM32L4xx hardware, you can enable the workaround by specifying the | |
7271 | linker option @samp{--fix-stm32l4xx-629360}, or the equivalent | |
7272 | @samp{--fix-stm32l4xx-629360=default}. | |
7273 | ||
7274 | If the workaround is enabled, instructions are scanned for | |
7275 | potentially-troublesome sequences, and a veneer is created for each | |
7276 | such sequence which may trigger the erratum. The veneer consists in a | |
7277 | replacement sequence emulating the behaviour of the original one and a | |
7278 | branch back to the subsequent instruction. The original instruction is | |
7279 | then replaced with a branch to the veneer. | |
7280 | ||
7281 | The workaround does not always preserve the memory access order for | |
7282 | the LDMDB instruction, when the instruction loads the PC. | |
7283 | ||
7284 | The workaround is not able to handle problematic instructions when | |
7285 | they are in the middle of an IT block, since a branch is not allowed | |
7286 | there. In that case, the linker reports a warning and no replacement | |
7287 | occurs. | |
7288 | ||
7289 | The workaround is not able to replace problematic instructions with a | |
7290 | PC-relative branch instruction if the @samp{.text} section is too | |
7291 | large. In that case, when the branch that replaces the original code | |
7292 | cannot be encoded, the linker reports a warning and no replacement | |
7293 | occurs. | |
7294 | ||
bf21ed78 MS |
7295 | @cindex NO_ENUM_SIZE_WARNING |
7296 | @kindex --no-enum-size-warning | |
726150b7 | 7297 | The @option{--no-enum-size-warning} switch prevents the linker from |
bf21ed78 MS |
7298 | warning when linking object files that specify incompatible EABI |
7299 | enumeration size attributes. For example, with this switch enabled, | |
7300 | linking of an object file using 32-bit enumeration values with another | |
7301 | using enumeration values fitted into the smallest possible space will | |
7302 | not be diagnosed. | |
a9dc9481 JM |
7303 | |
7304 | @cindex NO_WCHAR_SIZE_WARNING | |
7305 | @kindex --no-wchar-size-warning | |
7306 | The @option{--no-wchar-size-warning} switch prevents the linker from | |
7307 | warning when linking object files that specify incompatible EABI | |
7308 | @code{wchar_t} size attributes. For example, with this switch enabled, | |
7309 | linking of an object file using 32-bit @code{wchar_t} values with another | |
7310 | using 16-bit @code{wchar_t} values will not be diagnosed. | |
bf21ed78 | 7311 | |
726150b7 NC |
7312 | @cindex PIC_VENEER |
7313 | @kindex --pic-veneer | |
7314 | The @samp{--pic-veneer} switch makes the linker use PIC sequences for | |
7315 | ARM/Thumb interworking veneers, even if the rest of the binary | |
7316 | is not PIC. This avoids problems on uClinux targets where | |
7317 | @samp{--emit-relocs} is used to generate relocatable binaries. | |
7318 | ||
7319 | @cindex STUB_GROUP_SIZE | |
7320 | @kindex --stub-group-size=@var{N} | |
7321 | The linker will automatically generate and insert small sequences of | |
7322 | code into a linked ARM ELF executable whenever an attempt is made to | |
7323 | perform a function call to a symbol that is too far away. The | |
7324 | placement of these sequences of instructions - called stubs - is | |
a05a5b64 | 7325 | controlled by the command-line option @option{--stub-group-size=N}. |
726150b7 | 7326 | The placement is important because a poor choice can create a need for |
11e7fd74 | 7327 | duplicate stubs, increasing the code size. The linker will try to |
726150b7 NC |
7328 | group stubs together in order to reduce interruptions to the flow of |
7329 | code, but it needs guidance as to how big these groups should be and | |
7330 | where they should be placed. | |
7331 | ||
7332 | The value of @samp{N}, the parameter to the | |
7333 | @option{--stub-group-size=} option controls where the stub groups are | |
07d72278 | 7334 | placed. If it is negative then all stubs are placed after the first |
726150b7 NC |
7335 | branch that needs them. If it is positive then the stubs can be |
7336 | placed either before or after the branches that need them. If the | |
7337 | value of @samp{N} is 1 (either +1 or -1) then the linker will choose | |
7338 | exactly where to place groups of stubs, using its built in heuristics. | |
7339 | A value of @samp{N} greater than 1 (or smaller than -1) tells the | |
7340 | linker that a single group of stubs can service at most @samp{N} bytes | |
7341 | from the input sections. | |
7342 | ||
7343 | The default, if @option{--stub-group-size=} is not specified, is | |
7344 | @samp{N = +1}. | |
7345 | ||
1a51c1a4 NC |
7346 | Farcalls stubs insertion is fully supported for the ARM-EABI target |
7347 | only, because it relies on object files properties not present | |
7348 | otherwise. | |
7349 | ||
1db37fe6 YG |
7350 | @cindex Cortex-A8 erratum workaround |
7351 | @kindex --fix-cortex-a8 | |
7352 | @kindex --no-fix-cortex-a8 | |
7353 | 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}. | |
7354 | ||
7355 | The erratum only affects Thumb-2 code. Please contact ARM for further details. | |
7356 | ||
68fcca92 JW |
7357 | @cindex Cortex-A53 erratum 835769 workaround |
7358 | @kindex --fix-cortex-a53-835769 | |
7359 | @kindex --no-fix-cortex-a53-835769 | |
7360 | 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}. | |
7361 | ||
7362 | Please contact ARM for further details. | |
7363 | ||
1db37fe6 YG |
7364 | @kindex --merge-exidx-entries |
7365 | @kindex --no-merge-exidx-entries | |
7366 | @cindex Merging exidx entries | |
7367 | The @samp{--no-merge-exidx-entries} switch disables the merging of adjacent exidx entries in debuginfo. | |
7368 | ||
7369 | @kindex --long-plt | |
7370 | @cindex 32-bit PLT entries | |
7371 | The @samp{--long-plt} option enables the use of 16 byte PLT entries | |
7372 | which support up to 4Gb of code. The default is to use 12 byte PLT | |
7373 | entries which only support 512Mb of code. | |
7374 | ||
1f56df9d JW |
7375 | @kindex --no-apply-dynamic-relocs |
7376 | @cindex AArch64 rela addend | |
7377 | The @samp{--no-apply-dynamic-relocs} option makes AArch64 linker do not apply | |
7378 | link-time values for dynamic relocations. | |
7379 | ||
4ba2ef8f TP |
7380 | @cindex Placement of SG veneers |
7381 | All SG veneers are placed in the special output section @code{.gnu.sgstubs}. | |
a05a5b64 | 7382 | Its start address must be set, either with the command-line option |
4ba2ef8f TP |
7383 | @samp{--section-start} or in a linker script, to indicate where to place these |
7384 | veneers in memory. | |
7385 | ||
54ddd295 TP |
7386 | @kindex --cmse-implib |
7387 | @cindex Secure gateway import library | |
7388 | The @samp{--cmse-implib} option requests that the import libraries | |
7389 | specified by the @samp{--out-implib} and @samp{--in-implib} options are | |
7390 | secure gateway import libraries, suitable for linking a non-secure | |
7391 | executable against secure code as per ARMv8-M Security Extensions. | |
7392 | ||
0955507f TP |
7393 | @kindex --in-implib=@var{file} |
7394 | @cindex Input import library | |
7395 | The @samp{--in-implib=file} specifies an input import library whose symbols | |
7396 | must keep the same address in the executable being produced. A warning is | |
7397 | given if no @samp{--out-implib} is given but new symbols have been introduced | |
7398 | in the executable that should be listed in its import library. Otherwise, if | |
7399 | @samp{--out-implib} is specified, the symbols are added to the output import | |
7400 | library. A warning is also given if some symbols present in the input import | |
7401 | library have disappeared from the executable. This option is only effective | |
7402 | for Secure Gateway import libraries, ie. when @samp{--cmse-implib} is | |
7403 | specified. | |
7404 | ||
36f63dca NC |
7405 | @ifclear GENERIC |
7406 | @lowersections | |
7407 | @end ifclear | |
7408 | @end ifset | |
7409 | ||
7410 | @ifset HPPA | |
7411 | @ifclear GENERIC | |
7412 | @raisesections | |
7413 | @end ifclear | |
7414 | ||
7415 | @node HPPA ELF32 | |
7416 | @section @command{ld} and HPPA 32-bit ELF Support | |
7417 | @cindex HPPA multiple sub-space stubs | |
7418 | @kindex --multi-subspace | |
7419 | When generating a shared library, @command{ld} will by default generate | |
7420 | import stubs suitable for use with a single sub-space application. | |
7421 | The @samp{--multi-subspace} switch causes @command{ld} to generate export | |
7422 | stubs, and different (larger) import stubs suitable for use with | |
7423 | multiple sub-spaces. | |
7424 | ||
7425 | @cindex HPPA stub grouping | |
7426 | @kindex --stub-group-size=@var{N} | |
7427 | Long branch stubs and import/export stubs are placed by @command{ld} in | |
7428 | stub sections located between groups of input sections. | |
7429 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
7430 | sections handled by one stub section. Since branch offsets are signed, | |
7431 | a stub section may serve two groups of input sections, one group before | |
7432 | the stub section, and one group after it. However, when using | |
7433 | conditional branches that require stubs, it may be better (for branch | |
7434 | prediction) that stub sections only serve one group of input sections. | |
7435 | A negative value for @samp{N} chooses this scheme, ensuring that | |
7436 | branches to stubs always use a negative offset. Two special values of | |
7437 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
7438 | @command{ld} to automatically size input section groups for the branch types | |
7439 | detected, with the same behaviour regarding stub placement as other | |
7440 | positive or negative values of @samp{N} respectively. | |
7441 | ||
7442 | Note that @samp{--stub-group-size} does not split input sections. A | |
7443 | single input section larger than the group size specified will of course | |
7444 | create a larger group (of one section). If input sections are too | |
7445 | large, it may not be possible for a branch to reach its stub. | |
7446 | ||
7447 | @ifclear GENERIC | |
7448 | @lowersections | |
7449 | @end ifclear | |
7450 | @end ifset | |
7451 | ||
7fb9f789 NC |
7452 | @ifset M68K |
7453 | @ifclear GENERIC | |
7454 | @raisesections | |
7455 | @end ifclear | |
7456 | ||
7457 | @node M68K | |
7458 | @section @command{ld} and the Motorola 68K family | |
7459 | ||
7460 | @cindex Motorola 68K GOT generation | |
7461 | @kindex --got=@var{type} | |
7462 | The @samp{--got=@var{type}} option lets you choose the GOT generation scheme. | |
7463 | The choices are @samp{single}, @samp{negative}, @samp{multigot} and | |
7464 | @samp{target}. When @samp{target} is selected the linker chooses | |
7465 | the default GOT generation scheme for the current target. | |
7466 | @samp{single} tells the linker to generate a single GOT with | |
7467 | entries only at non-negative offsets. | |
7468 | @samp{negative} instructs the linker to generate a single GOT with | |
7469 | entries at both negative and positive offsets. Not all environments | |
7470 | support such GOTs. | |
7471 | @samp{multigot} allows the linker to generate several GOTs in the | |
7472 | output file. All GOT references from a single input object | |
7473 | file access the same GOT, but references from different input object | |
7474 | files might access different GOTs. Not all environments support such GOTs. | |
7475 | ||
7476 | @ifclear GENERIC | |
7477 | @lowersections | |
7478 | @end ifclear | |
7479 | @end ifset | |
7480 | ||
833794fc MR |
7481 | @ifset MIPS |
7482 | @ifclear GENERIC | |
7483 | @raisesections | |
7484 | @end ifclear | |
7485 | ||
7486 | @node MIPS | |
7487 | @section @command{ld} and the MIPS family | |
7488 | ||
7489 | @cindex MIPS microMIPS instruction choice selection | |
7490 | @kindex --insn32 | |
7491 | @kindex --no-insn32 | |
7492 | The @samp{--insn32} and @samp{--no-insn32} options control the choice of | |
7493 | microMIPS instructions used in code generated by the linker, such as that | |
7494 | in the PLT or lazy binding stubs, or in relaxation. If @samp{--insn32} is | |
7495 | used, then the linker only uses 32-bit instruction encodings. By default | |
7496 | or if @samp{--no-insn32} is used, all instruction encodings are used, | |
7497 | including 16-bit ones where possible. | |
7498 | ||
8b10b0b3 MR |
7499 | @cindex MIPS branch relocation check control |
7500 | @kindex --ignore-branch-isa | |
7501 | @kindex --no-ignore-branch-isa | |
7502 | The @samp{--ignore-branch-isa} and @samp{--no-ignore-branch-isa} options | |
7503 | control branch relocation checks for invalid ISA mode transitions. If | |
7504 | @samp{--ignore-branch-isa} is used, then the linker accepts any branch | |
7505 | relocations and any ISA mode transition required is lost in relocation | |
7506 | calculation, except for some cases of @code{BAL} instructions which meet | |
7507 | relaxation conditions and are converted to equivalent @code{JALX} | |
7508 | instructions as the associated relocation is calculated. By default | |
7509 | or if @samp{--no-ignore-branch-isa} is used a check is made causing | |
7510 | the loss of an ISA mode transition to produce an error. | |
7511 | ||
833794fc MR |
7512 | @ifclear GENERIC |
7513 | @lowersections | |
7514 | @end ifclear | |
7515 | @end ifset | |
7516 | ||
36f63dca NC |
7517 | @ifset MMIX |
7518 | @ifclear GENERIC | |
7519 | @raisesections | |
7520 | @end ifclear | |
7521 | ||
7522 | @node MMIX | |
7523 | @section @code{ld} and MMIX | |
7524 | For MMIX, there is a choice of generating @code{ELF} object files or | |
7525 | @code{mmo} object files when linking. The simulator @code{mmix} | |
7526 | understands the @code{mmo} format. The binutils @code{objcopy} utility | |
7527 | can translate between the two formats. | |
7528 | ||
7529 | There is one special section, the @samp{.MMIX.reg_contents} section. | |
7530 | Contents in this section is assumed to correspond to that of global | |
7531 | registers, and symbols referring to it are translated to special symbols, | |
7532 | equal to registers. In a final link, the start address of the | |
7533 | @samp{.MMIX.reg_contents} section corresponds to the first allocated | |
7534 | global register multiplied by 8. Register @code{$255} is not included in | |
7535 | this section; it is always set to the program entry, which is at the | |
7536 | symbol @code{Main} for @code{mmo} files. | |
7537 | ||
7a2de473 HPN |
7538 | Global symbols with the prefix @code{__.MMIX.start.}, for example |
7539 | @code{__.MMIX.start..text} and @code{__.MMIX.start..data} are special. | |
7540 | The default linker script uses these to set the default start address | |
7541 | of a section. | |
36f63dca NC |
7542 | |
7543 | Initial and trailing multiples of zero-valued 32-bit words in a section, | |
7544 | are left out from an mmo file. | |
7545 | ||
7546 | @ifclear GENERIC | |
7547 | @lowersections | |
7548 | @end ifclear | |
7549 | @end ifset | |
7550 | ||
7551 | @ifset MSP430 | |
7552 | @ifclear GENERIC | |
7553 | @raisesections | |
7554 | @end ifclear | |
7555 | ||
7556 | @node MSP430 | |
7557 | @section @code{ld} and MSP430 | |
7558 | For the MSP430 it is possible to select the MPU architecture. The flag @samp{-m [mpu type]} | |
7559 | will select an appropriate linker script for selected MPU type. (To get a list of known MPUs | |
7560 | just pass @samp{-m help} option to the linker). | |
7561 | ||
7562 | @cindex MSP430 extra sections | |
7563 | The linker will recognize some extra sections which are MSP430 specific: | |
7564 | ||
7565 | @table @code | |
7566 | @item @samp{.vectors} | |
7567 | Defines a portion of ROM where interrupt vectors located. | |
7568 | ||
7569 | @item @samp{.bootloader} | |
7570 | Defines the bootloader portion of the ROM (if applicable). Any code | |
7571 | in this section will be uploaded to the MPU. | |
7572 | ||
7573 | @item @samp{.infomem} | |
7574 | Defines an information memory section (if applicable). Any code in | |
7575 | this section will be uploaded to the MPU. | |
7576 | ||
c0065db7 | 7577 | @item @samp{.infomemnobits} |
36f63dca NC |
7578 | This is the same as the @samp{.infomem} section except that any code |
7579 | in this section will not be uploaded to the MPU. | |
7580 | ||
7581 | @item @samp{.noinit} | |
7582 | Denotes a portion of RAM located above @samp{.bss} section. | |
7583 | ||
c0065db7 | 7584 | The last two sections are used by gcc. |
36f63dca NC |
7585 | @end table |
7586 | ||
7ef3addb JL |
7587 | @table @option |
7588 | @cindex MSP430 Options | |
7589 | @kindex --code-region | |
7590 | @item --code-region=[either,lower,upper,none] | |
7591 | This will transform .text* sections to [either,lower,upper].text* sections. The | |
7592 | argument passed to GCC for -mcode-region is propagated to the linker | |
7593 | using this option. | |
7594 | ||
7595 | @kindex --data-region | |
7596 | @item --data-region=[either,lower,upper,none] | |
7597 | This will transform .data*, .bss* and .rodata* sections to | |
7598 | [either,lower,upper].[data,bss,rodata]* sections. The argument passed to GCC | |
7599 | for -mdata-region is propagated to the linker using this option. | |
7600 | ||
7601 | @kindex --disable-sec-transformation | |
7602 | @item --disable-sec-transformation | |
7603 | Prevent the transformation of sections as specified by the @code{--code-region} | |
7604 | and @code{--data-region} options. | |
7605 | This is useful if you are compiling and linking using a single call to the GCC | |
7606 | wrapper, and want to compile the source files using -m[code,data]-region but | |
7607 | not transform the sections for prebuilt libraries and objects. | |
7608 | @end table | |
7609 | ||
36f63dca NC |
7610 | @ifclear GENERIC |
7611 | @lowersections | |
7612 | @end ifclear | |
7613 | @end ifset | |
7614 | ||
35c08157 KLC |
7615 | @ifset NDS32 |
7616 | @ifclear GENERIC | |
7617 | @raisesections | |
7618 | @end ifclear | |
7619 | ||
7620 | @node NDS32 | |
7621 | @section @code{ld} and NDS32 | |
7622 | @kindex relaxing on NDS32 | |
7623 | For NDS32, there are some options to select relaxation behavior. The linker | |
7624 | relaxes objects according to these options. | |
7625 | ||
7626 | @table @code | |
7627 | @item @samp{--m[no-]fp-as-gp} | |
7628 | Disable/enable fp-as-gp relaxation. | |
7629 | ||
7630 | @item @samp{--mexport-symbols=FILE} | |
7631 | Exporting symbols and their address into FILE as linker script. | |
7632 | ||
7633 | @item @samp{--m[no-]ex9} | |
7634 | Disable/enable link-time EX9 relaxation. | |
7635 | ||
7636 | @item @samp{--mexport-ex9=FILE} | |
7637 | Export the EX9 table after linking. | |
7638 | ||
7639 | @item @samp{--mimport-ex9=FILE} | |
7640 | Import the Ex9 table for EX9 relaxation. | |
7641 | ||
7642 | @item @samp{--mupdate-ex9} | |
7643 | Update the existing EX9 table. | |
7644 | ||
7645 | @item @samp{--mex9-limit=NUM} | |
7646 | Maximum number of entries in the ex9 table. | |
7647 | ||
7648 | @item @samp{--mex9-loop-aware} | |
7649 | Avoid generating the EX9 instruction inside the loop. | |
7650 | ||
7651 | @item @samp{--m[no-]ifc} | |
7652 | Disable/enable the link-time IFC optimization. | |
7653 | ||
7654 | @item @samp{--mifc-loop-aware} | |
7655 | Avoid generating the IFC instruction inside the loop. | |
7656 | @end table | |
7657 | ||
7658 | @ifclear GENERIC | |
7659 | @lowersections | |
7660 | @end ifclear | |
7661 | @end ifset | |
7662 | ||
78058a5e SL |
7663 | @ifset NIOSII |
7664 | @ifclear GENERIC | |
7665 | @raisesections | |
7666 | @end ifclear | |
7667 | ||
7668 | @node Nios II | |
7669 | @section @command{ld} and the Altera Nios II | |
7670 | @cindex Nios II call relaxation | |
7671 | @kindex --relax on Nios II | |
7672 | ||
7673 | Call and immediate jump instructions on Nios II processors are limited to | |
7674 | transferring control to addresses in the same 256MB memory segment, | |
7675 | which may result in @command{ld} giving | |
7676 | @samp{relocation truncated to fit} errors with very large programs. | |
7677 | The command-line option @option{--relax} enables the generation of | |
7678 | trampolines that can access the entire 32-bit address space for calls | |
7679 | outside the normal @code{call} and @code{jmpi} address range. These | |
7680 | trampolines are inserted at section boundaries, so may not themselves | |
7681 | be reachable if an input section and its associated call trampolines are | |
7682 | larger than 256MB. | |
7683 | ||
7684 | The @option{--relax} option is enabled by default unless @option{-r} | |
7685 | is also specified. You can disable trampoline generation by using the | |
7686 | @option{--no-relax} linker option. You can also disable this optimization | |
7687 | locally by using the @samp{set .noat} directive in assembly-language | |
7688 | source files, as the linker-inserted trampolines use the @code{at} | |
7689 | register as a temporary. | |
7690 | ||
7691 | Note that the linker @option{--relax} option is independent of assembler | |
7692 | relaxation options, and that using the GNU assembler's @option{-relax-all} | |
7693 | option interferes with the linker's more selective call instruction relaxation. | |
7694 | ||
7695 | @ifclear GENERIC | |
7696 | @lowersections | |
7697 | @end ifclear | |
7698 | @end ifset | |
7699 | ||
2a60a7a8 AM |
7700 | @ifset POWERPC |
7701 | @ifclear GENERIC | |
7702 | @raisesections | |
7703 | @end ifclear | |
7704 | ||
7705 | @node PowerPC ELF32 | |
7706 | @section @command{ld} and PowerPC 32-bit ELF Support | |
7707 | @cindex PowerPC long branches | |
7708 | @kindex --relax on PowerPC | |
7709 | Branches on PowerPC processors are limited to a signed 26-bit | |
7710 | displacement, which may result in @command{ld} giving | |
7711 | @samp{relocation truncated to fit} errors with very large programs. | |
7712 | @samp{--relax} enables the generation of trampolines that can access | |
7713 | the entire 32-bit address space. These trampolines are inserted at | |
7714 | section boundaries, so may not themselves be reachable if an input | |
c8a1f254 NS |
7715 | section exceeds 33M in size. You may combine @samp{-r} and |
7716 | @samp{--relax} to add trampolines in a partial link. In that case | |
7717 | both branches to undefined symbols and inter-section branches are also | |
7718 | considered potentially out of range, and trampolines inserted. | |
2a60a7a8 AM |
7719 | |
7720 | @cindex PowerPC ELF32 options | |
7721 | @table @option | |
7722 | @cindex PowerPC PLT | |
7723 | @kindex --bss-plt | |
7724 | @item --bss-plt | |
7725 | Current PowerPC GCC accepts a @samp{-msecure-plt} option that | |
7726 | generates code capable of using a newer PLT and GOT layout that has | |
7727 | the security advantage of no executable section ever needing to be | |
7728 | writable and no writable section ever being executable. PowerPC | |
7729 | @command{ld} will generate this layout, including stubs to access the | |
7730 | PLT, if all input files (including startup and static libraries) were | |
7731 | compiled with @samp{-msecure-plt}. @samp{--bss-plt} forces the old | |
7732 | BSS PLT (and GOT layout) which can give slightly better performance. | |
7733 | ||
016687f8 AM |
7734 | @kindex --secure-plt |
7735 | @item --secure-plt | |
7736 | @command{ld} will use the new PLT and GOT layout if it is linking new | |
7737 | @samp{-fpic} or @samp{-fPIC} code, but does not do so automatically | |
7738 | when linking non-PIC code. This option requests the new PLT and GOT | |
7739 | layout. A warning will be given if some object file requires the old | |
7740 | style BSS PLT. | |
7741 | ||
2a60a7a8 AM |
7742 | @cindex PowerPC GOT |
7743 | @kindex --sdata-got | |
7744 | @item --sdata-got | |
7745 | The new secure PLT and GOT are placed differently relative to other | |
7746 | sections compared to older BSS PLT and GOT placement. The location of | |
7747 | @code{.plt} must change because the new secure PLT is an initialized | |
7748 | section while the old PLT is uninitialized. The reason for the | |
7749 | @code{.got} change is more subtle: The new placement allows | |
7750 | @code{.got} to be read-only in applications linked with | |
7751 | @samp{-z relro -z now}. However, this placement means that | |
7752 | @code{.sdata} cannot always be used in shared libraries, because the | |
7753 | PowerPC ABI accesses @code{.sdata} in shared libraries from the GOT | |
7754 | pointer. @samp{--sdata-got} forces the old GOT placement. PowerPC | |
7755 | GCC doesn't use @code{.sdata} in shared libraries, so this option is | |
7756 | really only useful for other compilers that may do so. | |
7757 | ||
7758 | @cindex PowerPC stub symbols | |
7759 | @kindex --emit-stub-syms | |
7760 | @item --emit-stub-syms | |
7761 | This option causes @command{ld} to label linker stubs with a local | |
7762 | symbol that encodes the stub type and destination. | |
7763 | ||
7764 | @cindex PowerPC TLS optimization | |
7765 | @kindex --no-tls-optimize | |
7766 | @item --no-tls-optimize | |
7767 | PowerPC @command{ld} normally performs some optimization of code | |
7768 | sequences used to access Thread-Local Storage. Use this option to | |
7769 | disable the optimization. | |
7770 | @end table | |
7771 | ||
7772 | @ifclear GENERIC | |
7773 | @lowersections | |
7774 | @end ifclear | |
7775 | @end ifset | |
7776 | ||
7777 | @ifset POWERPC64 | |
7778 | @ifclear GENERIC | |
7779 | @raisesections | |
7780 | @end ifclear | |
7781 | ||
7782 | @node PowerPC64 ELF64 | |
7783 | @section @command{ld} and PowerPC64 64-bit ELF Support | |
7784 | ||
7785 | @cindex PowerPC64 ELF64 options | |
7786 | @table @option | |
7787 | @cindex PowerPC64 stub grouping | |
7788 | @kindex --stub-group-size | |
7789 | @item --stub-group-size | |
7790 | Long branch stubs, PLT call stubs and TOC adjusting stubs are placed | |
7791 | by @command{ld} in stub sections located between groups of input sections. | |
7792 | @samp{--stub-group-size} specifies the maximum size of a group of input | |
7793 | sections handled by one stub section. Since branch offsets are signed, | |
7794 | a stub section may serve two groups of input sections, one group before | |
7795 | the stub section, and one group after it. However, when using | |
7796 | conditional branches that require stubs, it may be better (for branch | |
7797 | prediction) that stub sections only serve one group of input sections. | |
7798 | A negative value for @samp{N} chooses this scheme, ensuring that | |
7799 | branches to stubs always use a negative offset. Two special values of | |
7800 | @samp{N} are recognized, @samp{1} and @samp{-1}. These both instruct | |
7801 | @command{ld} to automatically size input section groups for the branch types | |
7802 | detected, with the same behaviour regarding stub placement as other | |
7803 | positive or negative values of @samp{N} respectively. | |
7804 | ||
7805 | Note that @samp{--stub-group-size} does not split input sections. A | |
7806 | single input section larger than the group size specified will of course | |
7807 | create a larger group (of one section). If input sections are too | |
7808 | large, it may not be possible for a branch to reach its stub. | |
7809 | ||
7810 | @cindex PowerPC64 stub symbols | |
7811 | @kindex --emit-stub-syms | |
7812 | @item --emit-stub-syms | |
7813 | This option causes @command{ld} to label linker stubs with a local | |
7814 | symbol that encodes the stub type and destination. | |
7815 | ||
7816 | @cindex PowerPC64 dot symbols | |
7817 | @kindex --dotsyms | |
7818 | @kindex --no-dotsyms | |
95421fb9 AM |
7819 | @item --dotsyms |
7820 | @itemx --no-dotsyms | |
2a60a7a8 AM |
7821 | These two options control how @command{ld} interprets version patterns |
7822 | in a version script. Older PowerPC64 compilers emitted both a | |
7823 | function descriptor symbol with the same name as the function, and a | |
7824 | code entry symbol with the name prefixed by a dot (@samp{.}). To | |
7825 | properly version a function @samp{foo}, the version script thus needs | |
7826 | to control both @samp{foo} and @samp{.foo}. The option | |
7827 | @samp{--dotsyms}, on by default, automatically adds the required | |
7828 | dot-prefixed patterns. Use @samp{--no-dotsyms} to disable this | |
7829 | feature. | |
7830 | ||
7ae4ea7d AM |
7831 | @cindex PowerPC64 register save/restore functions |
7832 | @kindex --save-restore-funcs | |
7833 | @kindex --no-save-restore-funcs | |
95421fb9 AM |
7834 | @item --save-restore-funcs |
7835 | @itemx --no-save-restore-funcs | |
7ae4ea7d AM |
7836 | These two options control whether PowerPC64 @command{ld} automatically |
7837 | provides out-of-line register save and restore functions used by | |
7838 | @samp{-Os} code. The default is to provide any such referenced | |
7839 | function for a normal final link, and to not do so for a relocatable | |
7840 | link. | |
7841 | ||
2a60a7a8 AM |
7842 | @cindex PowerPC64 TLS optimization |
7843 | @kindex --no-tls-optimize | |
7844 | @item --no-tls-optimize | |
7845 | PowerPC64 @command{ld} normally performs some optimization of code | |
7846 | sequences used to access Thread-Local Storage. Use this option to | |
7847 | disable the optimization. | |
7848 | ||
7c9cf415 AM |
7849 | @cindex PowerPC64 __tls_get_addr optimization |
7850 | @kindex --tls-get-addr-optimize | |
7851 | @kindex --no-tls-get-addr-optimize | |
9e7028aa AM |
7852 | @kindex --tls-get-addr-regsave |
7853 | @kindex --no-tls-get-addr-regsave | |
95421fb9 AM |
7854 | @item --tls-get-addr-optimize |
7855 | @itemx --no-tls-get-addr-optimize | |
9e7028aa | 7856 | These options control how PowerPC64 @command{ld} uses a special |
7c9cf415 AM |
7857 | stub to call __tls_get_addr. PowerPC64 glibc 2.22 and later support |
7858 | an optimization that allows the second and subsequent calls to | |
7859 | @code{__tls_get_addr} for a given symbol to be resolved by the special | |
9e7028aa AM |
7860 | stub without calling in to glibc. By default the linker enables |
7861 | generation of the stub when glibc advertises the availability of | |
7862 | __tls_get_addr_opt. | |
7863 | Using @option{--tls-get-addr-optimize} with an older glibc won't do | |
7864 | much besides slow down your applications, but may be useful if linking | |
7865 | an application against an older glibc with the expectation that it | |
7866 | will normally be used on systems having a newer glibc. | |
7867 | @option{--tls-get-addr-regsave} forces generation of a stub that saves | |
7868 | and restores volatile registers around the call into glibc. Normally, | |
7869 | this is done when the linker detects a call to __tls_get_addr_desc. | |
7870 | Such calls then go via the register saving stub to __tls_get_addr_opt. | |
5cebc931 | 7871 | @option{--no-tls-get-addr-regsave} disables generation of the |
9e7028aa | 7872 | register saves. |
7c9cf415 | 7873 | |
2a60a7a8 AM |
7874 | @cindex PowerPC64 OPD optimization |
7875 | @kindex --no-opd-optimize | |
7876 | @item --no-opd-optimize | |
7877 | PowerPC64 @command{ld} normally removes @code{.opd} section entries | |
7878 | corresponding to deleted link-once functions, or functions removed by | |
e7fc76dd | 7879 | the action of @samp{--gc-sections} or linker script @code{/DISCARD/}. |
2a60a7a8 AM |
7880 | Use this option to disable @code{.opd} optimization. |
7881 | ||
7882 | @cindex PowerPC64 OPD spacing | |
7883 | @kindex --non-overlapping-opd | |
7884 | @item --non-overlapping-opd | |
7885 | Some PowerPC64 compilers have an option to generate compressed | |
7886 | @code{.opd} entries spaced 16 bytes apart, overlapping the third word, | |
7887 | the static chain pointer (unused in C) with the first word of the next | |
7888 | entry. This option expands such entries to the full 24 bytes. | |
7889 | ||
7890 | @cindex PowerPC64 TOC optimization | |
7891 | @kindex --no-toc-optimize | |
7892 | @item --no-toc-optimize | |
7893 | PowerPC64 @command{ld} normally removes unused @code{.toc} section | |
7894 | entries. Such entries are detected by examining relocations that | |
7895 | reference the TOC in code sections. A reloc in a deleted code section | |
7896 | marks a TOC word as unneeded, while a reloc in a kept code section | |
7897 | marks a TOC word as needed. Since the TOC may reference itself, TOC | |
7898 | relocs are also examined. TOC words marked as both needed and | |
7899 | unneeded will of course be kept. TOC words without any referencing | |
7900 | reloc are assumed to be part of a multi-word entry, and are kept or | |
7901 | discarded as per the nearest marked preceding word. This works | |
7902 | reliably for compiler generated code, but may be incorrect if assembly | |
7903 | code is used to insert TOC entries. Use this option to disable the | |
7904 | optimization. | |
7905 | ||
d882c988 AM |
7906 | @cindex PowerPC64 inline PLT call optimization |
7907 | @kindex --no-inline-optimize | |
7908 | @item --no-inline-optimize | |
7909 | PowerPC64 @command{ld} normally replaces inline PLT call sequences | |
7910 | marked with @code{R_PPC64_PLTSEQ}, @code{R_PPC64_PLTCALL}, | |
7911 | @code{R_PPC64_PLT16_HA} and @code{R_PPC64_PLT16_LO_DS} relocations by | |
7912 | a number of @code{nop}s and a direct call when the function is defined | |
7913 | locally and can't be overridden by some other definition. This option | |
7914 | disables that optimization. | |
7915 | ||
2a60a7a8 AM |
7916 | @cindex PowerPC64 multi-TOC |
7917 | @kindex --no-multi-toc | |
7918 | @item --no-multi-toc | |
794e51c0 AM |
7919 | If given any toc option besides @code{-mcmodel=medium} or |
7920 | @code{-mcmodel=large}, PowerPC64 GCC generates code for a TOC model | |
7921 | where TOC | |
2a60a7a8 AM |
7922 | entries are accessed with a 16-bit offset from r2. This limits the |
7923 | total TOC size to 64K. PowerPC64 @command{ld} extends this limit by | |
7924 | grouping code sections such that each group uses less than 64K for its | |
7925 | TOC entries, then inserts r2 adjusting stubs between inter-group | |
7926 | calls. @command{ld} does not split apart input sections, so cannot | |
7927 | help if a single input file has a @code{.toc} section that exceeds | |
7928 | 64K, most likely from linking multiple files with @command{ld -r}. | |
7929 | Use this option to turn off this feature. | |
794e51c0 AM |
7930 | |
7931 | @cindex PowerPC64 TOC sorting | |
7932 | @kindex --no-toc-sort | |
7933 | @item --no-toc-sort | |
7934 | By default, @command{ld} sorts TOC sections so that those whose file | |
7935 | happens to have a section called @code{.init} or @code{.fini} are | |
7936 | placed first, followed by TOC sections referenced by code generated | |
7937 | with PowerPC64 gcc's @code{-mcmodel=small}, and lastly TOC sections | |
7938 | referenced only by code generated with PowerPC64 gcc's | |
7939 | @code{-mcmodel=medium} or @code{-mcmodel=large} options. Doing this | |
7940 | results in better TOC grouping for multi-TOC. Use this option to turn | |
7941 | off this feature. | |
7942 | ||
7943 | @cindex PowerPC64 PLT stub alignment | |
7944 | @kindex --plt-align | |
7945 | @kindex --no-plt-align | |
7946 | @item --plt-align | |
7947 | @itemx --no-plt-align | |
7948 | Use these options to control whether individual PLT call stubs are | |
2420fff6 AM |
7949 | aligned to a 32-byte boundary, or to the specified power of two |
7950 | boundary when using @code{--plt-align=}. A negative value may be | |
7951 | specified to pad PLT call stubs so that they do not cross the | |
7952 | specified power of two boundary (or the minimum number of boundaries | |
7953 | if a PLT stub is so large that it must cross a boundary). By default | |
7954 | PLT call stubs are aligned to 32-byte boundaries. | |
794e51c0 AM |
7955 | |
7956 | @cindex PowerPC64 PLT call stub static chain | |
7957 | @kindex --plt-static-chain | |
7958 | @kindex --no-plt-static-chain | |
7959 | @item --plt-static-chain | |
7960 | @itemx --no-plt-static-chain | |
7961 | Use these options to control whether PLT call stubs load the static | |
7962 | chain pointer (r11). @code{ld} defaults to not loading the static | |
7963 | chain since there is never any need to do so on a PLT call. | |
7964 | ||
7965 | @cindex PowerPC64 PLT call stub thread safety | |
7966 | @kindex --plt-thread-safe | |
7967 | @kindex --no-plt-thread-safe | |
7968 | @item --plt-thread-safe | |
1be5d8d3 | 7969 | @itemx --no-plt-thread-safe |
794e51c0 AM |
7970 | With power7's weakly ordered memory model, it is possible when using |
7971 | lazy binding for ld.so to update a plt entry in one thread and have | |
7972 | another thread see the individual plt entry words update in the wrong | |
7973 | order, despite ld.so carefully writing in the correct order and using | |
7974 | memory write barriers. To avoid this we need some sort of read | |
7975 | barrier in the call stub, or use LD_BIND_NOW=1. By default, @code{ld} | |
7976 | looks for calls to commonly used functions that create threads, and if | |
7977 | seen, adds the necessary barriers. Use these options to change the | |
7978 | default behaviour. | |
8b5f1ed8 AM |
7979 | |
7980 | @cindex PowerPC64 ELFv2 PLT localentry optimization | |
7981 | @kindex --plt-localentry | |
7982 | @kindex --no-plt-localentry | |
7983 | @item --plt-localentry | |
7984 | @itemx --no-localentry | |
7985 | ELFv2 functions with localentry:0 are those with a single entry point, | |
7986 | ie. global entry == local entry, and that have no requirement on r2 | |
7987 | (the TOC/GOT pointer) or r12, and guarantee r2 is unchanged on return. | |
7988 | Such an external function can be called via the PLT without saving r2 | |
7989 | or restoring it on return, avoiding a common load-hit-store for small | |
7990 | functions. The optimization is attractive, with up to 40% reduction | |
7991 | in execution time for a small function, but can result in symbol | |
d44c746a AM |
7992 | interposition failures. Also, minor changes in a shared library, |
7993 | including system libraries, can cause a function that was localentry:0 | |
7994 | to become localentry:8. This will result in a dynamic loader | |
7995 | complaint and failure to run. The option is experimental, use with | |
7996 | care. @option{--no-plt-localentry} is the default. | |
d882c988 AM |
7997 | |
7998 | @cindex PowerPC64 Power10 stubs | |
7999 | @kindex --power10-stubs | |
8000 | @kindex --no-power10-stubs | |
8001 | @item --power10-stubs | |
8002 | @itemx --no-power10-stubs | |
8003 | When PowerPC64 @command{ld} links input object files containing | |
8004 | relocations used on power10 prefixed instructions it normally creates | |
e10a07b3 AM |
8005 | linkage stubs (PLT call and long branch) using power10 instructions |
8006 | for @code{@@notoc} PLT calls where @code{r2} is not known. The | |
8007 | power10 notoc stubs are smaller and faster, so are preferred for | |
d882c988 AM |
8008 | power10. @option{--power10-stubs} and @option{--no-power10-stubs} |
8009 | allow you to override the linker's selection of stub instructions. | |
e10a07b3 AM |
8010 | @option{--power10-stubs=auto} allows the user to select the default |
8011 | auto mode. | |
2a60a7a8 AM |
8012 | @end table |
8013 | ||
8014 | @ifclear GENERIC | |
8015 | @lowersections | |
8016 | @end ifclear | |
8017 | @end ifset | |
8018 | ||
b4cbbe8f AK |
8019 | @ifset S/390 |
8020 | @ifclear GENERIC | |
8021 | @raisesections | |
8022 | @end ifclear | |
8023 | ||
8024 | @node S/390 ELF | |
8025 | @section @command{ld} and S/390 ELF Support | |
8026 | ||
8027 | @cindex S/390 ELF options | |
8028 | @table @option | |
8029 | ||
8030 | @cindex S/390 | |
8031 | @kindex --s390-pgste | |
8032 | @item --s390-pgste | |
8033 | This option marks the result file with a @code{PT_S390_PGSTE} | |
8034 | segment. The Linux kernel is supposed to allocate 4k page tables for | |
8035 | binaries marked that way. | |
8036 | @end table | |
8037 | ||
8038 | @ifclear GENERIC | |
8039 | @lowersections | |
8040 | @end ifclear | |
8041 | @end ifset | |
8042 | ||
49fa1e15 AM |
8043 | @ifset SPU |
8044 | @ifclear GENERIC | |
8045 | @raisesections | |
8046 | @end ifclear | |
8047 | ||
8048 | @node SPU ELF | |
8049 | @section @command{ld} and SPU ELF Support | |
8050 | ||
8051 | @cindex SPU ELF options | |
8052 | @table @option | |
8053 | ||
8054 | @cindex SPU plugins | |
8055 | @kindex --plugin | |
8056 | @item --plugin | |
8057 | This option marks an executable as a PIC plugin module. | |
8058 | ||
8059 | @cindex SPU overlays | |
8060 | @kindex --no-overlays | |
8061 | @item --no-overlays | |
8062 | Normally, @command{ld} recognizes calls to functions within overlay | |
8063 | regions, and redirects such calls to an overlay manager via a stub. | |
8064 | @command{ld} also provides a built-in overlay manager. This option | |
8065 | turns off all this special overlay handling. | |
8066 | ||
8067 | @cindex SPU overlay stub symbols | |
8068 | @kindex --emit-stub-syms | |
8069 | @item --emit-stub-syms | |
8070 | This option causes @command{ld} to label overlay stubs with a local | |
8071 | symbol that encodes the stub type and destination. | |
8072 | ||
8073 | @cindex SPU extra overlay stubs | |
8074 | @kindex --extra-overlay-stubs | |
8075 | @item --extra-overlay-stubs | |
8076 | This option causes @command{ld} to add overlay call stubs on all | |
8077 | function calls out of overlay regions. Normally stubs are not added | |
8078 | on calls to non-overlay regions. | |
8079 | ||
8080 | @cindex SPU local store size | |
8081 | @kindex --local-store=lo:hi | |
8082 | @item --local-store=lo:hi | |
8083 | @command{ld} usually checks that a final executable for SPU fits in | |
8084 | the address range 0 to 256k. This option may be used to change the | |
8085 | range. Disable the check entirely with @option{--local-store=0:0}. | |
8086 | ||
c0065db7 | 8087 | @cindex SPU |
49fa1e15 AM |
8088 | @kindex --stack-analysis |
8089 | @item --stack-analysis | |
8090 | SPU local store space is limited. Over-allocation of stack space | |
8091 | unnecessarily limits space available for code and data, while | |
8092 | under-allocation results in runtime failures. If given this option, | |
8093 | @command{ld} will provide an estimate of maximum stack usage. | |
8094 | @command{ld} does this by examining symbols in code sections to | |
8095 | determine the extents of functions, and looking at function prologues | |
8096 | for stack adjusting instructions. A call-graph is created by looking | |
8097 | for relocations on branch instructions. The graph is then searched | |
8098 | for the maximum stack usage path. Note that this analysis does not | |
8099 | find calls made via function pointers, and does not handle recursion | |
8100 | and other cycles in the call graph. Stack usage may be | |
8101 | under-estimated if your code makes such calls. Also, stack usage for | |
8102 | dynamic allocation, e.g. alloca, will not be detected. If a link map | |
8103 | is requested, detailed information about each function's stack usage | |
8104 | and calls will be given. | |
8105 | ||
c0065db7 | 8106 | @cindex SPU |
49fa1e15 AM |
8107 | @kindex --emit-stack-syms |
8108 | @item --emit-stack-syms | |
8109 | This option, if given along with @option{--stack-analysis} will result | |
8110 | in @command{ld} emitting stack sizing symbols for each function. | |
8111 | These take the form @code{__stack_<function_name>} for global | |
8112 | functions, and @code{__stack_<number>_<function_name>} for static | |
8113 | functions. @code{<number>} is the section id in hex. The value of | |
8114 | such symbols is the stack requirement for the corresponding function. | |
8115 | The symbol size will be zero, type @code{STT_NOTYPE}, binding | |
c0065db7 | 8116 | @code{STB_LOCAL}, and section @code{SHN_ABS}. |
49fa1e15 AM |
8117 | @end table |
8118 | ||
8119 | @ifclear GENERIC | |
8120 | @lowersections | |
8121 | @end ifclear | |
8122 | @end ifset | |
8123 | ||
36f63dca NC |
8124 | @ifset TICOFF |
8125 | @ifclear GENERIC | |
8126 | @raisesections | |
8127 | @end ifclear | |
8128 | ||
8129 | @node TI COFF | |
8130 | @section @command{ld}'s Support for Various TI COFF Versions | |
8131 | @cindex TI COFF versions | |
8132 | @kindex --format=@var{version} | |
8133 | The @samp{--format} switch allows selection of one of the various | |
8134 | TI COFF versions. The latest of this writing is 2; versions 0 and 1 are | |
8135 | also supported. The TI COFF versions also vary in header byte-order | |
8136 | format; @command{ld} will read any version or byte order, but the output | |
8137 | header format depends on the default specified by the specific target. | |
8138 | ||
8139 | @ifclear GENERIC | |
8140 | @lowersections | |
8141 | @end ifclear | |
8142 | @end ifset | |
8143 | ||
2ca22b03 NC |
8144 | @ifset WIN32 |
8145 | @ifclear GENERIC | |
8146 | @raisesections | |
8147 | @end ifclear | |
8148 | ||
8149 | @node WIN32 | |
8150 | @section @command{ld} and WIN32 (cygwin/mingw) | |
8151 | ||
c0065db7 | 8152 | This section describes some of the win32 specific @command{ld} issues. |
a05a5b64 TP |
8153 | See @ref{Options,,Command-line Options} for detailed description of the |
8154 | command-line options mentioned here. | |
2ca22b03 NC |
8155 | |
8156 | @table @emph | |
c0065db7 RM |
8157 | @cindex import libraries |
8158 | @item import libraries | |
69da35b5 | 8159 | The standard Windows linker creates and uses so-called import |
2ca22b03 | 8160 | libraries, which contains information for linking to dll's. They are |
69da35b5 NC |
8161 | regular static archives and are handled as any other static |
8162 | archive. The cygwin and mingw ports of @command{ld} have specific | |
2ca22b03 | 8163 | support for creating such libraries provided with the |
a05a5b64 | 8164 | @samp{--out-implib} command-line option. |
2ca22b03 | 8165 | |
c0065db7 RM |
8166 | @item exporting DLL symbols |
8167 | @cindex exporting DLL symbols | |
dc8465bf NC |
8168 | The cygwin/mingw @command{ld} has several ways to export symbols for dll's. |
8169 | ||
8170 | @table @emph | |
8171 | @item using auto-export functionality | |
8172 | @cindex using auto-export functionality | |
8173 | By default @command{ld} exports symbols with the auto-export functionality, | |
a05a5b64 | 8174 | which is controlled by the following command-line options: |
dc8465bf | 8175 | |
0a5d968e NC |
8176 | @itemize |
8177 | @item --export-all-symbols [This is the default] | |
8178 | @item --exclude-symbols | |
8179 | @item --exclude-libs | |
e1c37eb5 | 8180 | @item --exclude-modules-for-implib |
09e2aba4 | 8181 | @item --version-script |
0a5d968e NC |
8182 | @end itemize |
8183 | ||
09e2aba4 DK |
8184 | When auto-export is in operation, @command{ld} will export all the non-local |
8185 | (global and common) symbols it finds in a DLL, with the exception of a few | |
8186 | symbols known to belong to the system's runtime and libraries. As it will | |
8187 | often not be desirable to export all of a DLL's symbols, which may include | |
8188 | private functions that are not part of any public interface, the command-line | |
9d5777a3 | 8189 | options listed above may be used to filter symbols out from the list for |
09e2aba4 DK |
8190 | exporting. The @samp{--output-def} option can be used in order to see the |
8191 | final list of exported symbols with all exclusions taken into effect. | |
8192 | ||
8193 | If @samp{--export-all-symbols} is not given explicitly on the | |
0a5d968e NC |
8194 | command line, then the default auto-export behavior will be @emph{disabled} |
8195 | if either of the following are true: | |
8196 | ||
8197 | @itemize | |
8198 | @item A DEF file is used. | |
8199 | @item Any symbol in any object file was marked with the __declspec(dllexport) attribute. | |
8200 | @end itemize | |
dc8465bf | 8201 | |
c0065db7 RM |
8202 | @item using a DEF file |
8203 | @cindex using a DEF file | |
dc8465bf NC |
8204 | Another way of exporting symbols is using a DEF file. A DEF file is |
8205 | an ASCII file containing definitions of symbols which should be | |
8206 | exported when a dll is created. Usually it is named @samp{<dll | |
8207 | name>.def} and is added as any other object file to the linker's | |
0a5d968e | 8208 | command line. The file's name must end in @samp{.def} or @samp{.DEF}. |
dc8465bf NC |
8209 | |
8210 | @example | |
8211 | gcc -o <output> <objectfiles> <dll name>.def | |
8212 | @end example | |
8213 | ||
0a5d968e NC |
8214 | Using a DEF file turns off the normal auto-export behavior, unless the |
8215 | @samp{--export-all-symbols} option is also used. | |
8216 | ||
dc8465bf NC |
8217 | Here is an example of a DEF file for a shared library called @samp{xyz.dll}: |
8218 | ||
8219 | @example | |
4b5bd4e7 | 8220 | LIBRARY "xyz.dll" BASE=0x20000000 |
dc8465bf NC |
8221 | |
8222 | EXPORTS | |
8223 | foo | |
8224 | bar | |
8225 | _bar = bar | |
4b5bd4e7 DS |
8226 | another_foo = abc.dll.afoo |
8227 | var1 DATA | |
7fcab871 KT |
8228 | doo = foo == foo2 |
8229 | eoo DATA == var1 | |
c0065db7 | 8230 | @end example |
dc8465bf | 8231 | |
7fcab871 | 8232 | This example defines a DLL with a non-default base address and seven |
4b5bd4e7 DS |
8233 | symbols in the export table. The third exported symbol @code{_bar} is an |
8234 | alias for the second. The fourth symbol, @code{another_foo} is resolved | |
8235 | by "forwarding" to another module and treating it as an alias for | |
8236 | @code{afoo} exported from the DLL @samp{abc.dll}. The final symbol | |
7fcab871 KT |
8237 | @code{var1} is declared to be a data object. The @samp{doo} symbol in |
8238 | export library is an alias of @samp{foo}, which gets the string name | |
8239 | in export table @samp{foo2}. The @samp{eoo} symbol is an data export | |
8240 | symbol, which gets in export table the name @samp{var1}. | |
4b5bd4e7 | 8241 | |
6b31ad16 DS |
8242 | The optional @code{LIBRARY <name>} command indicates the @emph{internal} |
8243 | name of the output DLL. If @samp{<name>} does not include a suffix, | |
8244 | the default library suffix, @samp{.DLL} is appended. | |
8245 | ||
b45619c0 NC |
8246 | When the .DEF file is used to build an application, rather than a |
8247 | library, the @code{NAME <name>} command should be used instead of | |
6b31ad16 | 8248 | @code{LIBRARY}. If @samp{<name>} does not include a suffix, the default |
c0065db7 | 8249 | executable suffix, @samp{.EXE} is appended. |
6b31ad16 DS |
8250 | |
8251 | With either @code{LIBRARY <name>} or @code{NAME <name>} the optional | |
8252 | specification @code{BASE = <number>} may be used to specify a | |
c0065db7 | 8253 | non-default base address for the image. |
6b31ad16 DS |
8254 | |
8255 | If neither @code{LIBRARY <name>} nor @code{NAME <name>} is specified, | |
a2877985 DS |
8256 | or they specify an empty string, the internal name is the same as the |
8257 | filename specified on the command line. | |
6b31ad16 | 8258 | |
4b5bd4e7 DS |
8259 | The complete specification of an export symbol is: |
8260 | ||
8261 | @example | |
8262 | EXPORTS | |
8263 | ( ( ( <name1> [ = <name2> ] ) | |
8264 | | ( <name1> = <module-name> . <external-name>)) | |
7fcab871 | 8265 | [ @@ <integer> ] [NONAME] [DATA] [CONSTANT] [PRIVATE] [== <name3>] ) * |
c0065db7 | 8266 | @end example |
4b5bd4e7 DS |
8267 | |
8268 | Declares @samp{<name1>} as an exported symbol from the DLL, or declares | |
8269 | @samp{<name1>} as an exported alias for @samp{<name2>}; or declares | |
8270 | @samp{<name1>} as a "forward" alias for the symbol | |
8271 | @samp{<external-name>} in the DLL @samp{<module-name>}. | |
8272 | Optionally, the symbol may be exported by the specified ordinal | |
7fcab871 KT |
8273 | @samp{<integer>} alias. The optional @samp{<name3>} is the to be used |
8274 | string in import/export table for the symbol. | |
4b5bd4e7 DS |
8275 | |
8276 | The optional keywords that follow the declaration indicate: | |
8277 | ||
8278 | @code{NONAME}: Do not put the symbol name in the DLL's export table. It | |
8279 | will still be exported by its ordinal alias (either the value specified | |
8280 | by the .def specification or, otherwise, the value assigned by the | |
8281 | linker). The symbol name, however, does remain visible in the import | |
8282 | library (if any), unless @code{PRIVATE} is also specified. | |
8283 | ||
8284 | @code{DATA}: The symbol is a variable or object, rather than a function. | |
8285 | The import lib will export only an indirect reference to @code{foo} as | |
8286 | the symbol @code{_imp__foo} (ie, @code{foo} must be resolved as | |
8287 | @code{*_imp__foo}). | |
8288 | ||
8289 | @code{CONSTANT}: Like @code{DATA}, but put the undecorated @code{foo} as | |
8290 | well as @code{_imp__foo} into the import library. Both refer to the | |
8291 | read-only import address table's pointer to the variable, not to the | |
8292 | variable itself. This can be dangerous. If the user code fails to add | |
8293 | the @code{dllimport} attribute and also fails to explicitly add the | |
8294 | extra indirection that the use of the attribute enforces, the | |
8295 | application will behave unexpectedly. | |
8296 | ||
8297 | @code{PRIVATE}: Put the symbol in the DLL's export table, but do not put | |
8298 | it into the static import library used to resolve imports at link time. The | |
8299 | symbol can still be imported using the @code{LoadLibrary/GetProcAddress} | |
de194d85 | 8300 | API at runtime or by using the GNU ld extension of linking directly to |
4b5bd4e7 | 8301 | the DLL without an import library. |
c0065db7 | 8302 | |
4b5bd4e7 DS |
8303 | See ld/deffilep.y in the binutils sources for the full specification of |
8304 | other DEF file statements | |
dc8465bf NC |
8305 | |
8306 | @cindex creating a DEF file | |
8307 | While linking a shared dll, @command{ld} is able to create a DEF file | |
a05a5b64 | 8308 | with the @samp{--output-def <file>} command-line option. |
0a5d968e NC |
8309 | |
8310 | @item Using decorations | |
8311 | @cindex Using decorations | |
8312 | Another way of marking symbols for export is to modify the source code | |
8313 | itself, so that when building the DLL each symbol to be exported is | |
8314 | declared as: | |
8315 | ||
8316 | @example | |
8317 | __declspec(dllexport) int a_variable | |
8318 | __declspec(dllexport) void a_function(int with_args) | |
8319 | @end example | |
8320 | ||
8321 | All such symbols will be exported from the DLL. If, however, | |
8322 | any of the object files in the DLL contain symbols decorated in | |
8323 | this way, then the normal auto-export behavior is disabled, unless | |
8324 | the @samp{--export-all-symbols} option is also used. | |
8325 | ||
8326 | Note that object files that wish to access these symbols must @emph{not} | |
c0065db7 | 8327 | decorate them with dllexport. Instead, they should use dllimport, |
0a5d968e NC |
8328 | instead: |
8329 | ||
8330 | @example | |
8331 | __declspec(dllimport) int a_variable | |
8332 | __declspec(dllimport) void a_function(int with_args) | |
8333 | @end example | |
8334 | ||
c0065db7 RM |
8335 | This complicates the structure of library header files, because |
8336 | when included by the library itself the header must declare the | |
0a5d968e NC |
8337 | variables and functions as dllexport, but when included by client |
8338 | code the header must declare them as dllimport. There are a number | |
c0065db7 | 8339 | of idioms that are typically used to do this; often client code can |
0a5d968e NC |
8340 | omit the __declspec() declaration completely. See |
8341 | @samp{--enable-auto-import} and @samp{automatic data imports} for more | |
b45619c0 | 8342 | information. |
c0065db7 | 8343 | @end table |
dc8465bf | 8344 | |
2ca22b03 NC |
8345 | @cindex automatic data imports |
8346 | @item automatic data imports | |
8347 | The standard Windows dll format supports data imports from dlls only | |
69da35b5 | 8348 | by adding special decorations (dllimport/dllexport), which let the |
2ca22b03 | 8349 | compiler produce specific assembler instructions to deal with this |
c0065db7 | 8350 | issue. This increases the effort necessary to port existing Un*x |
69da35b5 | 8351 | code to these platforms, especially for large |
2ca22b03 | 8352 | c++ libraries and applications. The auto-import feature, which was |
c0065db7 | 8353 | initially provided by Paul Sokolovsky, allows one to omit the |
b45619c0 | 8354 | decorations to achieve a behavior that conforms to that on POSIX/Un*x |
c0065db7 | 8355 | platforms. This feature is enabled with the @samp{--enable-auto-import} |
69da35b5 NC |
8356 | command-line option, although it is enabled by default on cygwin/mingw. |
8357 | The @samp{--enable-auto-import} option itself now serves mainly to | |
8358 | suppress any warnings that are ordinarily emitted when linked objects | |
8359 | trigger the feature's use. | |
8360 | ||
c0065db7 | 8361 | auto-import of variables does not always work flawlessly without |
69da35b5 NC |
8362 | additional assistance. Sometimes, you will see this message |
8363 | ||
c0065db7 | 8364 | "variable '<var>' can't be auto-imported. Please read the |
69da35b5 NC |
8365 | documentation for ld's @code{--enable-auto-import} for details." |
8366 | ||
c0065db7 RM |
8367 | The @samp{--enable-auto-import} documentation explains why this error |
8368 | occurs, and several methods that can be used to overcome this difficulty. | |
8369 | One of these methods is the @emph{runtime pseudo-relocs} feature, described | |
69da35b5 NC |
8370 | below. |
8371 | ||
8372 | @cindex runtime pseudo-relocation | |
c0065db7 RM |
8373 | For complex variables imported from DLLs (such as structs or classes), |
8374 | object files typically contain a base address for the variable and an | |
8375 | offset (@emph{addend}) within the variable--to specify a particular | |
8376 | field or public member, for instance. Unfortunately, the runtime loader used | |
8377 | in win32 environments is incapable of fixing these references at runtime | |
69da35b5 | 8378 | without the additional information supplied by dllimport/dllexport decorations. |
c0065db7 | 8379 | The standard auto-import feature described above is unable to resolve these |
69da35b5 NC |
8380 | references. |
8381 | ||
c0065db7 RM |
8382 | The @samp{--enable-runtime-pseudo-relocs} switch allows these references to |
8383 | be resolved without error, while leaving the task of adjusting the references | |
8384 | themselves (with their non-zero addends) to specialized code provided by the | |
8385 | runtime environment. Recent versions of the cygwin and mingw environments and | |
8386 | compilers provide this runtime support; older versions do not. However, the | |
8387 | support is only necessary on the developer's platform; the compiled result will | |
69da35b5 NC |
8388 | run without error on an older system. |
8389 | ||
c0065db7 RM |
8390 | @samp{--enable-runtime-pseudo-relocs} is not the default; it must be explicitly |
8391 | enabled as needed. | |
2ca22b03 NC |
8392 | |
8393 | @cindex direct linking to a dll | |
8394 | @item direct linking to a dll | |
8395 | The cygwin/mingw ports of @command{ld} support the direct linking, | |
8396 | including data symbols, to a dll without the usage of any import | |
69da35b5 | 8397 | libraries. This is much faster and uses much less memory than does the |
b45619c0 | 8398 | traditional import library method, especially when linking large |
c0065db7 RM |
8399 | libraries or applications. When @command{ld} creates an import lib, each |
8400 | function or variable exported from the dll is stored in its own bfd, even | |
8401 | though a single bfd could contain many exports. The overhead involved in | |
69da35b5 | 8402 | storing, loading, and processing so many bfd's is quite large, and explains the |
c0065db7 | 8403 | tremendous time, memory, and storage needed to link against particularly |
69da35b5 NC |
8404 | large or complex libraries when using import libs. |
8405 | ||
c0065db7 | 8406 | Linking directly to a dll uses no extra command-line switches other than |
69da35b5 | 8407 | @samp{-L} and @samp{-l}, because @command{ld} already searches for a number |
c0065db7 | 8408 | of names to match each library. All that is needed from the developer's |
69da35b5 NC |
8409 | perspective is an understanding of this search, in order to force ld to |
8410 | select the dll instead of an import library. | |
8411 | ||
2ca22b03 | 8412 | |
69da35b5 NC |
8413 | For instance, when ld is called with the argument @samp{-lxxx} it will attempt |
8414 | to find, in the first directory of its search path, | |
2ca22b03 NC |
8415 | |
8416 | @example | |
45e948fe NC |
8417 | libxxx.dll.a |
8418 | xxx.dll.a | |
8419 | libxxx.a | |
8420 | xxx.lib | |
f6c4d4b1 | 8421 | libxxx.lib |
69da35b5 | 8422 | cygxxx.dll (*) |
45e948fe NC |
8423 | libxxx.dll |
8424 | xxx.dll | |
2ca22b03 NC |
8425 | @end example |
8426 | ||
69da35b5 NC |
8427 | before moving on to the next directory in the search path. |
8428 | ||
c0065db7 RM |
8429 | (*) Actually, this is not @samp{cygxxx.dll} but in fact is @samp{<prefix>xxx.dll}, |
8430 | where @samp{<prefix>} is set by the @command{ld} option | |
8431 | @samp{--dll-search-prefix=<prefix>}. In the case of cygwin, the standard gcc spec | |
8432 | file includes @samp{--dll-search-prefix=cyg}, so in effect we actually search for | |
69da35b5 NC |
8433 | @samp{cygxxx.dll}. |
8434 | ||
c0065db7 RM |
8435 | Other win32-based unix environments, such as mingw or pw32, may use other |
8436 | @samp{<prefix>}es, although at present only cygwin makes use of this feature. It | |
69da35b5 NC |
8437 | was originally intended to help avoid name conflicts among dll's built for the |
8438 | various win32/un*x environments, so that (for example) two versions of a zlib dll | |
8439 | could coexist on the same machine. | |
8440 | ||
2ca22b03 NC |
8441 | The generic cygwin/mingw path layout uses a @samp{bin} directory for |
8442 | applications and dll's and a @samp{lib} directory for the import | |
69da35b5 | 8443 | libraries (using cygwin nomenclature): |
2ca22b03 NC |
8444 | |
8445 | @example | |
8446 | bin/ | |
8447 | cygxxx.dll | |
8448 | lib/ | |
8449 | libxxx.dll.a (in case of dll's) | |
c0065db7 | 8450 | libxxx.a (in case of static archive) |
2ca22b03 NC |
8451 | @end example |
8452 | ||
c0065db7 RM |
8453 | Linking directly to a dll without using the import library can be |
8454 | done two ways: | |
2ca22b03 NC |
8455 | |
8456 | 1. Use the dll directly by adding the @samp{bin} path to the link line | |
8457 | @example | |
8458 | gcc -Wl,-verbose -o a.exe -L../bin/ -lxxx | |
c0065db7 | 8459 | @end example |
2ca22b03 | 8460 | |
69da35b5 NC |
8461 | However, as the dll's often have version numbers appended to their names |
8462 | (@samp{cygncurses-5.dll}) this will often fail, unless one specifies | |
8463 | @samp{-L../bin -lncurses-5} to include the version. Import libs are generally | |
8464 | not versioned, and do not have this difficulty. | |
8465 | ||
2ca22b03 NC |
8466 | 2. Create a symbolic link from the dll to a file in the @samp{lib} |
8467 | directory according to the above mentioned search pattern. This | |
8468 | should be used to avoid unwanted changes in the tools needed for | |
8469 | making the app/dll. | |
8470 | ||
8471 | @example | |
8472 | ln -s bin/cygxxx.dll lib/[cyg|lib|]xxx.dll[.a] | |
c0065db7 | 8473 | @end example |
2ca22b03 NC |
8474 | |
8475 | Then you can link without any make environment changes. | |
8476 | ||
8477 | @example | |
8478 | gcc -Wl,-verbose -o a.exe -L../lib/ -lxxx | |
c0065db7 | 8479 | @end example |
69da35b5 NC |
8480 | |
8481 | This technique also avoids the version number problems, because the following is | |
8482 | perfectly legal | |
8483 | ||
8484 | @example | |
8485 | bin/ | |
8486 | cygxxx-5.dll | |
8487 | lib/ | |
c0065db7 | 8488 | libxxx.dll.a -> ../bin/cygxxx-5.dll |
69da35b5 NC |
8489 | @end example |
8490 | ||
dc8465bf | 8491 | Linking directly to a dll without using an import lib will work |
69da35b5 NC |
8492 | even when auto-import features are exercised, and even when |
8493 | @samp{--enable-runtime-pseudo-relocs} is used. | |
8494 | ||
8495 | Given the improvements in speed and memory usage, one might justifiably | |
45e948fe | 8496 | wonder why import libraries are used at all. There are three reasons: |
69da35b5 NC |
8497 | |
8498 | 1. Until recently, the link-directly-to-dll functionality did @emph{not} | |
8499 | work with auto-imported data. | |
8500 | ||
dc8465bf NC |
8501 | 2. Sometimes it is necessary to include pure static objects within the |
8502 | import library (which otherwise contains only bfd's for indirection | |
8503 | symbols that point to the exports of a dll). Again, the import lib | |
8504 | for the cygwin kernel makes use of this ability, and it is not | |
8505 | possible to do this without an import lib. | |
69da35b5 | 8506 | |
45e948fe NC |
8507 | 3. Symbol aliases can only be resolved using an import lib. This is |
8508 | critical when linking against OS-supplied dll's (eg, the win32 API) | |
8509 | in which symbols are usually exported as undecorated aliases of their | |
8510 | stdcall-decorated assembly names. | |
8511 | ||
69da35b5 | 8512 | So, import libs are not going away. But the ability to replace |
c0065db7 RM |
8513 | true import libs with a simple symbolic link to (or a copy of) |
8514 | a dll, in many cases, is a useful addition to the suite of tools | |
8515 | binutils makes available to the win32 developer. Given the | |
69da35b5 NC |
8516 | massive improvements in memory requirements during linking, storage |
8517 | requirements, and linking speed, we expect that many developers | |
8518 | will soon begin to use this feature whenever possible. | |
dc8465bf | 8519 | |
c0065db7 | 8520 | @item symbol aliasing |
dc8465bf | 8521 | @table @emph |
c0065db7 RM |
8522 | @item adding additional names |
8523 | Sometimes, it is useful to export symbols with additional names. | |
dc8465bf NC |
8524 | A symbol @samp{foo} will be exported as @samp{foo}, but it can also be |
8525 | exported as @samp{_foo} by using special directives in the DEF file | |
8526 | when creating the dll. This will affect also the optional created | |
c0065db7 | 8527 | import library. Consider the following DEF file: |
dc8465bf | 8528 | |
c0065db7 | 8529 | @example |
dc8465bf NC |
8530 | LIBRARY "xyz.dll" BASE=0x61000000 |
8531 | ||
8532 | EXPORTS | |
c0065db7 | 8533 | foo |
dc8465bf | 8534 | _foo = foo |
c0065db7 | 8535 | @end example |
dc8465bf NC |
8536 | |
8537 | The line @samp{_foo = foo} maps the symbol @samp{foo} to @samp{_foo}. | |
8538 | ||
8539 | Another method for creating a symbol alias is to create it in the | |
8540 | source code using the "weak" attribute: | |
8541 | ||
c0065db7 RM |
8542 | @example |
8543 | void foo () @{ /* Do something. */; @} | |
dc8465bf | 8544 | void _foo () __attribute__ ((weak, alias ("foo"))); |
c0065db7 | 8545 | @end example |
dc8465bf NC |
8546 | |
8547 | See the gcc manual for more information about attributes and weak | |
8548 | symbols. | |
8549 | ||
8550 | @item renaming symbols | |
8551 | Sometimes it is useful to rename exports. For instance, the cygwin | |
c0065db7 | 8552 | kernel does this regularly. A symbol @samp{_foo} can be exported as |
dc8465bf NC |
8553 | @samp{foo} but not as @samp{_foo} by using special directives in the |
8554 | DEF file. (This will also affect the import library, if it is | |
c0065db7 | 8555 | created). In the following example: |
dc8465bf | 8556 | |
c0065db7 | 8557 | @example |
dc8465bf NC |
8558 | LIBRARY "xyz.dll" BASE=0x61000000 |
8559 | ||
8560 | EXPORTS | |
8561 | _foo = foo | |
c0065db7 | 8562 | @end example |
dc8465bf NC |
8563 | |
8564 | The line @samp{_foo = foo} maps the exported symbol @samp{foo} to | |
8565 | @samp{_foo}. | |
c0065db7 | 8566 | @end table |
dc8465bf | 8567 | |
0a5d968e | 8568 | Note: using a DEF file disables the default auto-export behavior, |
a05a5b64 | 8569 | unless the @samp{--export-all-symbols} command-line option is used. |
0a5d968e | 8570 | If, however, you are trying to rename symbols, then you should list |
c0065db7 RM |
8571 | @emph{all} desired exports in the DEF file, including the symbols |
8572 | that are not being renamed, and do @emph{not} use the | |
8573 | @samp{--export-all-symbols} option. If you list only the | |
8574 | renamed symbols in the DEF file, and use @samp{--export-all-symbols} | |
8575 | to handle the other symbols, then the both the new names @emph{and} | |
8576 | the original names for the renamed symbols will be exported. | |
8577 | In effect, you'd be aliasing those symbols, not renaming them, | |
0a5d968e | 8578 | which is probably not what you wanted. |
c87db184 CF |
8579 | |
8580 | @cindex weak externals | |
8581 | @item weak externals | |
8582 | The Windows object format, PE, specifies a form of weak symbols called | |
8583 | weak externals. When a weak symbol is linked and the symbol is not | |
8584 | defined, the weak symbol becomes an alias for some other symbol. There | |
8585 | are three variants of weak externals: | |
8586 | @itemize | |
8587 | @item Definition is searched for in objects and libraries, historically | |
8588 | called lazy externals. | |
8589 | @item Definition is searched for only in other objects, not in libraries. | |
8590 | This form is not presently implemented. | |
8591 | @item No search; the symbol is an alias. This form is not presently | |
8592 | implemented. | |
8593 | @end itemize | |
8594 | As a GNU extension, weak symbols that do not specify an alternate symbol | |
8595 | are supported. If the symbol is undefined when linking, the symbol | |
8596 | uses a default value. | |
c1711530 DK |
8597 | |
8598 | @cindex aligned common symbols | |
8599 | @item aligned common symbols | |
8600 | As a GNU extension to the PE file format, it is possible to specify the | |
8601 | desired alignment for a common symbol. This information is conveyed from | |
8602 | the assembler or compiler to the linker by means of GNU-specific commands | |
8603 | carried in the object file's @samp{.drectve} section, which are recognized | |
8604 | by @command{ld} and respected when laying out the common symbols. Native | |
8605 | tools will be able to process object files employing this GNU extension, | |
8606 | but will fail to respect the alignment instructions, and may issue noisy | |
8607 | warnings about unknown linker directives. | |
5063daf7 | 8608 | |
2ca22b03 NC |
8609 | @end table |
8610 | ||
8611 | @ifclear GENERIC | |
8612 | @lowersections | |
8613 | @end ifclear | |
8614 | @end ifset | |
8615 | ||
e0001a05 NC |
8616 | @ifset XTENSA |
8617 | @ifclear GENERIC | |
8618 | @raisesections | |
8619 | @end ifclear | |
8620 | ||
8621 | @node Xtensa | |
8622 | @section @code{ld} and Xtensa Processors | |
8623 | ||
8624 | @cindex Xtensa processors | |
8625 | The default @command{ld} behavior for Xtensa processors is to interpret | |
8626 | @code{SECTIONS} commands so that lists of explicitly named sections in a | |
8627 | specification with a wildcard file will be interleaved when necessary to | |
8628 | keep literal pools within the range of PC-relative load offsets. For | |
8629 | example, with the command: | |
8630 | ||
8631 | @smallexample | |
8632 | SECTIONS | |
8633 | @{ | |
8634 | .text : @{ | |
8635 | *(.literal .text) | |
8636 | @} | |
8637 | @} | |
8638 | @end smallexample | |
8639 | ||
8640 | @noindent | |
8641 | @command{ld} may interleave some of the @code{.literal} | |
8642 | and @code{.text} sections from different object files to ensure that the | |
8643 | literal pools are within the range of PC-relative load offsets. A valid | |
8644 | interleaving might place the @code{.literal} sections from an initial | |
8645 | group of files followed by the @code{.text} sections of that group of | |
8646 | files. Then, the @code{.literal} sections from the rest of the files | |
8647 | and the @code{.text} sections from the rest of the files would follow. | |
e0001a05 | 8648 | |
43cd72b9 | 8649 | @cindex @option{--relax} on Xtensa |
e0001a05 | 8650 | @cindex relaxing on Xtensa |
43cd72b9 BW |
8651 | Relaxation is enabled by default for the Xtensa version of @command{ld} and |
8652 | provides two important link-time optimizations. The first optimization | |
8653 | is to combine identical literal values to reduce code size. A redundant | |
8654 | literal will be removed and all the @code{L32R} instructions that use it | |
8655 | will be changed to reference an identical literal, as long as the | |
8656 | location of the replacement literal is within the offset range of all | |
8657 | the @code{L32R} instructions. The second optimization is to remove | |
8658 | unnecessary overhead from assembler-generated ``longcall'' sequences of | |
8659 | @code{L32R}/@code{CALLX@var{n}} when the target functions are within | |
8660 | range of direct @code{CALL@var{n}} instructions. | |
8661 | ||
8662 | For each of these cases where an indirect call sequence can be optimized | |
8663 | to a direct call, the linker will change the @code{CALLX@var{n}} | |
8664 | instruction to a @code{CALL@var{n}} instruction, remove the @code{L32R} | |
8665 | instruction, and remove the literal referenced by the @code{L32R} | |
8666 | instruction if it is not used for anything else. Removing the | |
8667 | @code{L32R} instruction always reduces code size but can potentially | |
8668 | hurt performance by changing the alignment of subsequent branch targets. | |
8669 | By default, the linker will always preserve alignments, either by | |
8670 | switching some instructions between 24-bit encodings and the equivalent | |
8671 | density instructions or by inserting a no-op in place of the @code{L32R} | |
8672 | instruction that was removed. If code size is more important than | |
8673 | performance, the @option{--size-opt} option can be used to prevent the | |
8674 | linker from widening density instructions or inserting no-ops, except in | |
8675 | a few cases where no-ops are required for correctness. | |
8676 | ||
8677 | The following Xtensa-specific command-line options can be used to | |
8678 | control the linker: | |
8679 | ||
8680 | @cindex Xtensa options | |
8681 | @table @option | |
43cd72b9 BW |
8682 | @item --size-opt |
8683 | When optimizing indirect calls to direct calls, optimize for code size | |
8684 | more than performance. With this option, the linker will not insert | |
8685 | no-ops or widen density instructions to preserve branch target | |
8686 | alignment. There may still be some cases where no-ops are required to | |
8687 | preserve the correctness of the code. | |
7a77f1ac MF |
8688 | |
8689 | @item --abi-windowed | |
8690 | @itemx --abi-call0 | |
8691 | Choose ABI for the output object and for the generated PLT code. | |
8692 | PLT code inserted by the linker must match ABI of the output object | |
8693 | because windowed and call0 ABI use incompatible function call | |
8694 | conventions. | |
8695 | Default ABI is chosen by the ABI tag in the @code{.xtensa.info} section | |
8696 | of the first input object. | |
8697 | A warning is issued if ABI tags of input objects do not match each other | |
8698 | or the chosen output object ABI. | |
43cd72b9 | 8699 | @end table |
e0001a05 NC |
8700 | |
8701 | @ifclear GENERIC | |
8702 | @lowersections | |
8703 | @end ifclear | |
8704 | @end ifset | |
8705 | ||
252b5132 RH |
8706 | @ifclear SingleFormat |
8707 | @node BFD | |
8708 | @chapter BFD | |
8709 | ||
8710 | @cindex back end | |
8711 | @cindex object file management | |
8712 | @cindex object formats available | |
8713 | @kindex objdump -i | |
8714 | The linker accesses object and archive files using the BFD libraries. | |
8715 | These libraries allow the linker to use the same routines to operate on | |
8716 | object files whatever the object file format. A different object file | |
8717 | format can be supported simply by creating a new BFD back end and adding | |
8718 | it to the library. To conserve runtime memory, however, the linker and | |
8719 | associated tools are usually configured to support only a subset of the | |
8720 | object file formats available. You can use @code{objdump -i} | |
8721 | (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}) to | |
8722 | list all the formats available for your configuration. | |
8723 | ||
8724 | @cindex BFD requirements | |
8725 | @cindex requirements for BFD | |
8726 | As with most implementations, BFD is a compromise between | |
8727 | several conflicting requirements. The major factor influencing | |
8728 | BFD design was efficiency: any time used converting between | |
8729 | formats is time which would not have been spent had BFD not | |
8730 | been involved. This is partly offset by abstraction payback; since | |
8731 | BFD simplifies applications and back ends, more time and care | |
8732 | may be spent optimizing algorithms for a greater speed. | |
8733 | ||
8734 | One minor artifact of the BFD solution which you should bear in | |
8735 | mind is the potential for information loss. There are two places where | |
8736 | useful information can be lost using the BFD mechanism: during | |
8737 | conversion and during output. @xref{BFD information loss}. | |
8738 | ||
8739 | @menu | |
8740 | * BFD outline:: How it works: an outline of BFD | |
8741 | @end menu | |
8742 | ||
8743 | @node BFD outline | |
36f63dca | 8744 | @section How It Works: An Outline of BFD |
252b5132 RH |
8745 | @cindex opening object files |
8746 | @include bfdsumm.texi | |
8747 | @end ifclear | |
8748 | ||
8749 | @node Reporting Bugs | |
8750 | @chapter Reporting Bugs | |
ff5dcc92 SC |
8751 | @cindex bugs in @command{ld} |
8752 | @cindex reporting bugs in @command{ld} | |
252b5132 | 8753 | |
ff5dcc92 | 8754 | Your bug reports play an essential role in making @command{ld} reliable. |
252b5132 RH |
8755 | |
8756 | Reporting a bug may help you by bringing a solution to your problem, or | |
8757 | it may not. But in any case the principal function of a bug report is | |
ff5dcc92 | 8758 | to help the entire community by making the next version of @command{ld} |
252b5132 | 8759 | work better. Bug reports are your contribution to the maintenance of |
ff5dcc92 | 8760 | @command{ld}. |
252b5132 RH |
8761 | |
8762 | In order for a bug report to serve its purpose, you must include the | |
8763 | information that enables us to fix the bug. | |
8764 | ||
8765 | @menu | |
8766 | * Bug Criteria:: Have you found a bug? | |
8767 | * Bug Reporting:: How to report bugs | |
8768 | @end menu | |
8769 | ||
8770 | @node Bug Criteria | |
36f63dca | 8771 | @section Have You Found a Bug? |
252b5132 RH |
8772 | @cindex bug criteria |
8773 | ||
8774 | If you are not sure whether you have found a bug, here are some guidelines: | |
8775 | ||
8776 | @itemize @bullet | |
8777 | @cindex fatal signal | |
8778 | @cindex linker crash | |
8779 | @cindex crash of linker | |
8780 | @item | |
8781 | If the linker gets a fatal signal, for any input whatever, that is a | |
ff5dcc92 | 8782 | @command{ld} bug. Reliable linkers never crash. |
252b5132 RH |
8783 | |
8784 | @cindex error on valid input | |
8785 | @item | |
ff5dcc92 | 8786 | If @command{ld} produces an error message for valid input, that is a bug. |
252b5132 RH |
8787 | |
8788 | @cindex invalid input | |
8789 | @item | |
ff5dcc92 | 8790 | If @command{ld} does not produce an error message for invalid input, that |
252b5132 RH |
8791 | may be a bug. In the general case, the linker can not verify that |
8792 | object files are correct. | |
8793 | ||
8794 | @item | |
8795 | If you are an experienced user of linkers, your suggestions for | |
ff5dcc92 | 8796 | improvement of @command{ld} are welcome in any case. |
252b5132 RH |
8797 | @end itemize |
8798 | ||
8799 | @node Bug Reporting | |
36f63dca | 8800 | @section How to Report Bugs |
252b5132 | 8801 | @cindex bug reports |
ff5dcc92 | 8802 | @cindex @command{ld} bugs, reporting |
252b5132 RH |
8803 | |
8804 | A number of companies and individuals offer support for @sc{gnu} | |
ff5dcc92 | 8805 | products. If you obtained @command{ld} from a support organization, we |
252b5132 RH |
8806 | recommend you contact that organization first. |
8807 | ||
8808 | You can find contact information for many support companies and | |
8809 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
8810 | distribution. | |
8811 | ||
ad22bfe8 | 8812 | @ifset BUGURL |
ff5dcc92 | 8813 | Otherwise, send bug reports for @command{ld} to |
ad22bfe8 JM |
8814 | @value{BUGURL}. |
8815 | @end ifset | |
252b5132 RH |
8816 | |
8817 | The fundamental principle of reporting bugs usefully is this: | |
8818 | @strong{report all the facts}. If you are not sure whether to state a | |
8819 | fact or leave it out, state it! | |
8820 | ||
8821 | Often people omit facts because they think they know what causes the | |
8822 | problem and assume that some details do not matter. Thus, you might | |
b553b183 NC |
8823 | assume that the name of a symbol you use in an example does not |
8824 | matter. Well, probably it does not, but one cannot be sure. Perhaps | |
8825 | the bug is a stray memory reference which happens to fetch from the | |
8826 | location where that name is stored in memory; perhaps, if the name | |
8827 | were different, the contents of that location would fool the linker | |
8828 | into doing the right thing despite the bug. Play it safe and give a | |
8829 | specific, complete example. That is the easiest thing for you to do, | |
c0065db7 | 8830 | and the most helpful. |
b553b183 NC |
8831 | |
8832 | Keep in mind that the purpose of a bug report is to enable us to fix | |
8833 | the bug if it is new to us. Therefore, always write your bug reports | |
8834 | on the assumption that the bug has not been reported previously. | |
252b5132 RH |
8835 | |
8836 | Sometimes people give a few sketchy facts and ask, ``Does this ring a | |
36f63dca NC |
8837 | bell?'' This cannot help us fix a bug, so it is basically useless. We |
8838 | respond by asking for enough details to enable us to investigate. | |
8839 | You might as well expedite matters by sending them to begin with. | |
252b5132 RH |
8840 | |
8841 | To enable us to fix the bug, you should include all these things: | |
8842 | ||
8843 | @itemize @bullet | |
8844 | @item | |
ff5dcc92 | 8845 | The version of @command{ld}. @command{ld} announces it if you start it with |
252b5132 RH |
8846 | the @samp{--version} argument. |
8847 | ||
8848 | Without this, we will not know whether there is any point in looking for | |
ff5dcc92 | 8849 | the bug in the current version of @command{ld}. |
252b5132 RH |
8850 | |
8851 | @item | |
ff5dcc92 | 8852 | Any patches you may have applied to the @command{ld} source, including any |
252b5132 RH |
8853 | patches made to the @code{BFD} library. |
8854 | ||
8855 | @item | |
8856 | The type of machine you are using, and the operating system name and | |
8857 | version number. | |
8858 | ||
8859 | @item | |
ff5dcc92 | 8860 | What compiler (and its version) was used to compile @command{ld}---e.g. |
252b5132 RH |
8861 | ``@code{gcc-2.7}''. |
8862 | ||
8863 | @item | |
8864 | The command arguments you gave the linker to link your example and | |
8865 | observe the bug. To guarantee you will not omit something important, | |
8866 | list them all. A copy of the Makefile (or the output from make) is | |
8867 | sufficient. | |
8868 | ||
8869 | If we were to try to guess the arguments, we would probably guess wrong | |
8870 | and then we might not encounter the bug. | |
8871 | ||
8872 | @item | |
8873 | A complete input file, or set of input files, that will reproduce the | |
b553b183 NC |
8874 | bug. It is generally most helpful to send the actual object files |
8875 | provided that they are reasonably small. Say no more than 10K. For | |
8876 | bigger files you can either make them available by FTP or HTTP or else | |
8877 | state that you are willing to send the object file(s) to whomever | |
8878 | requests them. (Note - your email will be going to a mailing list, so | |
8879 | we do not want to clog it up with large attachments). But small | |
8880 | attachments are best. | |
252b5132 RH |
8881 | |
8882 | If the source files were assembled using @code{gas} or compiled using | |
8883 | @code{gcc}, then it may be OK to send the source files rather than the | |
8884 | object files. In this case, be sure to say exactly what version of | |
8885 | @code{gas} or @code{gcc} was used to produce the object files. Also say | |
8886 | how @code{gas} or @code{gcc} were configured. | |
8887 | ||
8888 | @item | |
8889 | A description of what behavior you observe that you believe is | |
8890 | incorrect. For example, ``It gets a fatal signal.'' | |
8891 | ||
ff5dcc92 | 8892 | Of course, if the bug is that @command{ld} gets a fatal signal, then we |
252b5132 RH |
8893 | will certainly notice it. But if the bug is incorrect output, we might |
8894 | not notice unless it is glaringly wrong. You might as well not give us | |
8895 | a chance to make a mistake. | |
8896 | ||
8897 | Even if the problem you experience is a fatal signal, you should still | |
8898 | say so explicitly. Suppose something strange is going on, such as, your | |
b45619c0 | 8899 | copy of @command{ld} is out of sync, or you have encountered a bug in the |
252b5132 RH |
8900 | C library on your system. (This has happened!) Your copy might crash |
8901 | and ours would not. If you told us to expect a crash, then when ours | |
8902 | fails to crash, we would know that the bug was not happening for us. If | |
8903 | you had not told us to expect a crash, then we would not be able to draw | |
8904 | any conclusion from our observations. | |
8905 | ||
8906 | @item | |
ff5dcc92 | 8907 | If you wish to suggest changes to the @command{ld} source, send us context |
252b5132 RH |
8908 | diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or |
8909 | @samp{-p} option. Always send diffs from the old file to the new file. | |
ff5dcc92 | 8910 | If you even discuss something in the @command{ld} source, refer to it by |
252b5132 RH |
8911 | context, not by line number. |
8912 | ||
8913 | The line numbers in our development sources will not match those in your | |
8914 | sources. Your line numbers would convey no useful information to us. | |
8915 | @end itemize | |
8916 | ||
8917 | Here are some things that are not necessary: | |
8918 | ||
8919 | @itemize @bullet | |
8920 | @item | |
8921 | A description of the envelope of the bug. | |
8922 | ||
8923 | Often people who encounter a bug spend a lot of time investigating | |
8924 | which changes to the input file will make the bug go away and which | |
8925 | changes will not affect it. | |
8926 | ||
8927 | This is often time consuming and not very useful, because the way we | |
8928 | will find the bug is by running a single example under the debugger | |
8929 | with breakpoints, not by pure deduction from a series of examples. | |
8930 | We recommend that you save your time for something else. | |
8931 | ||
8932 | Of course, if you can find a simpler example to report @emph{instead} | |
8933 | of the original one, that is a convenience for us. Errors in the | |
8934 | output will be easier to spot, running under the debugger will take | |
8935 | less time, and so on. | |
8936 | ||
8937 | However, simplification is not vital; if you do not want to do this, | |
8938 | report the bug anyway and send us the entire test case you used. | |
8939 | ||
8940 | @item | |
8941 | A patch for the bug. | |
8942 | ||
8943 | A patch for the bug does help us if it is a good one. But do not omit | |
8944 | the necessary information, such as the test case, on the assumption that | |
8945 | a patch is all we need. We might see problems with your patch and decide | |
8946 | to fix the problem another way, or we might not understand it at all. | |
8947 | ||
ff5dcc92 | 8948 | Sometimes with a program as complicated as @command{ld} it is very hard to |
252b5132 RH |
8949 | construct an example that will make the program follow a certain path |
8950 | through the code. If you do not send us the example, we will not be | |
8951 | able to construct one, so we will not be able to verify that the bug is | |
8952 | fixed. | |
8953 | ||
8954 | And if we cannot understand what bug you are trying to fix, or why your | |
8955 | patch should be an improvement, we will not install it. A test case will | |
8956 | help us to understand. | |
8957 | ||
8958 | @item | |
8959 | A guess about what the bug is or what it depends on. | |
8960 | ||
8961 | Such guesses are usually wrong. Even we cannot guess right about such | |
8962 | things without first using the debugger to find the facts. | |
8963 | @end itemize | |
8964 | ||
8965 | @node MRI | |
8966 | @appendix MRI Compatible Script Files | |
8967 | @cindex MRI compatibility | |
ff5dcc92 SC |
8968 | To aid users making the transition to @sc{gnu} @command{ld} from the MRI |
8969 | linker, @command{ld} can use MRI compatible linker scripts as an | |
252b5132 RH |
8970 | alternative to the more general-purpose linker scripting language |
8971 | described in @ref{Scripts}. MRI compatible linker scripts have a much | |
8972 | simpler command set than the scripting language otherwise used with | |
ff5dcc92 | 8973 | @command{ld}. @sc{gnu} @command{ld} supports the most commonly used MRI |
252b5132 RH |
8974 | linker commands; these commands are described here. |
8975 | ||
8976 | In general, MRI scripts aren't of much use with the @code{a.out} object | |
8977 | file format, since it only has three sections and MRI scripts lack some | |
8978 | features to make use of them. | |
8979 | ||
8980 | You can specify a file containing an MRI-compatible script using the | |
8981 | @samp{-c} command-line option. | |
8982 | ||
8983 | Each command in an MRI-compatible script occupies its own line; each | |
8984 | command line starts with the keyword that identifies the command (though | |
8985 | blank lines are also allowed for punctuation). If a line of an | |
ff5dcc92 | 8986 | MRI-compatible script begins with an unrecognized keyword, @command{ld} |
252b5132 RH |
8987 | issues a warning message, but continues processing the script. |
8988 | ||
8989 | Lines beginning with @samp{*} are comments. | |
8990 | ||
8991 | You can write these commands using all upper-case letters, or all | |
8992 | lower case; for example, @samp{chip} is the same as @samp{CHIP}. | |
8993 | The following list shows only the upper-case form of each command. | |
8994 | ||
8995 | @table @code | |
8996 | @cindex @code{ABSOLUTE} (MRI) | |
8997 | @item ABSOLUTE @var{secname} | |
8998 | @itemx ABSOLUTE @var{secname}, @var{secname}, @dots{} @var{secname} | |
ff5dcc92 | 8999 | Normally, @command{ld} includes in the output file all sections from all |
252b5132 RH |
9000 | the input files. However, in an MRI-compatible script, you can use the |
9001 | @code{ABSOLUTE} command to restrict the sections that will be present in | |
9002 | your output program. If the @code{ABSOLUTE} command is used at all in a | |
9003 | script, then only the sections named explicitly in @code{ABSOLUTE} | |
9004 | commands will appear in the linker output. You can still use other | |
9005 | input sections (whatever you select on the command line, or using | |
9006 | @code{LOAD}) to resolve addresses in the output file. | |
9007 | ||
9008 | @cindex @code{ALIAS} (MRI) | |
9009 | @item ALIAS @var{out-secname}, @var{in-secname} | |
9010 | Use this command to place the data from input section @var{in-secname} | |
9011 | in a section called @var{out-secname} in the linker output file. | |
9012 | ||
9013 | @var{in-secname} may be an integer. | |
9014 | ||
9015 | @cindex @code{ALIGN} (MRI) | |
9016 | @item ALIGN @var{secname} = @var{expression} | |
9017 | Align the section called @var{secname} to @var{expression}. The | |
9018 | @var{expression} should be a power of two. | |
9019 | ||
9020 | @cindex @code{BASE} (MRI) | |
9021 | @item BASE @var{expression} | |
9022 | Use the value of @var{expression} as the lowest address (other than | |
9023 | absolute addresses) in the output file. | |
9024 | ||
9025 | @cindex @code{CHIP} (MRI) | |
9026 | @item CHIP @var{expression} | |
9027 | @itemx CHIP @var{expression}, @var{expression} | |
9028 | This command does nothing; it is accepted only for compatibility. | |
9029 | ||
9030 | @cindex @code{END} (MRI) | |
9031 | @item END | |
9032 | This command does nothing whatever; it's only accepted for compatibility. | |
9033 | ||
9034 | @cindex @code{FORMAT} (MRI) | |
9035 | @item FORMAT @var{output-format} | |
9036 | Similar to the @code{OUTPUT_FORMAT} command in the more general linker | |
dc12032b | 9037 | language, but restricted to S-records, if @var{output-format} is @samp{S} |
252b5132 RH |
9038 | |
9039 | @cindex @code{LIST} (MRI) | |
9040 | @item LIST @var{anything}@dots{} | |
9041 | Print (to the standard output file) a link map, as produced by the | |
ff5dcc92 | 9042 | @command{ld} command-line option @samp{-M}. |
252b5132 RH |
9043 | |
9044 | The keyword @code{LIST} may be followed by anything on the | |
9045 | same line, with no change in its effect. | |
9046 | ||
9047 | @cindex @code{LOAD} (MRI) | |
9048 | @item LOAD @var{filename} | |
9049 | @itemx LOAD @var{filename}, @var{filename}, @dots{} @var{filename} | |
9050 | Include one or more object file @var{filename} in the link; this has the | |
ff5dcc92 | 9051 | same effect as specifying @var{filename} directly on the @command{ld} |
252b5132 RH |
9052 | command line. |
9053 | ||
9054 | @cindex @code{NAME} (MRI) | |
9055 | @item NAME @var{output-name} | |
ff5dcc92 | 9056 | @var{output-name} is the name for the program produced by @command{ld}; the |
252b5132 RH |
9057 | MRI-compatible command @code{NAME} is equivalent to the command-line |
9058 | option @samp{-o} or the general script language command @code{OUTPUT}. | |
9059 | ||
9060 | @cindex @code{ORDER} (MRI) | |
9061 | @item ORDER @var{secname}, @var{secname}, @dots{} @var{secname} | |
9062 | @itemx ORDER @var{secname} @var{secname} @var{secname} | |
ff5dcc92 | 9063 | Normally, @command{ld} orders the sections in its output file in the |
252b5132 RH |
9064 | order in which they first appear in the input files. In an MRI-compatible |
9065 | script, you can override this ordering with the @code{ORDER} command. The | |
9066 | sections you list with @code{ORDER} will appear first in your output | |
9067 | file, in the order specified. | |
9068 | ||
9069 | @cindex @code{PUBLIC} (MRI) | |
9070 | @item PUBLIC @var{name}=@var{expression} | |
9071 | @itemx PUBLIC @var{name},@var{expression} | |
9072 | @itemx PUBLIC @var{name} @var{expression} | |
9073 | Supply a value (@var{expression}) for external symbol | |
9074 | @var{name} used in the linker input files. | |
9075 | ||
9076 | @cindex @code{SECT} (MRI) | |
9077 | @item SECT @var{secname}, @var{expression} | |
9078 | @itemx SECT @var{secname}=@var{expression} | |
9079 | @itemx SECT @var{secname} @var{expression} | |
9080 | You can use any of these three forms of the @code{SECT} command to | |
9081 | specify the start address (@var{expression}) for section @var{secname}. | |
9082 | If you have more than one @code{SECT} statement for the same | |
9083 | @var{secname}, only the @emph{first} sets the start address. | |
9084 | @end table | |
9085 | ||
793c5807 NC |
9086 | @node GNU Free Documentation License |
9087 | @appendix GNU Free Documentation License | |
36f63dca | 9088 | @include fdl.texi |
704c465c | 9089 | |
370b66a1 CD |
9090 | @node LD Index |
9091 | @unnumbered LD Index | |
252b5132 RH |
9092 | |
9093 | @printindex cp | |
9094 | ||
9095 | @tex | |
7ca01ed9 | 9096 | % I think something like @@colophon should be in texinfo. In the |
252b5132 RH |
9097 | % meantime: |
9098 | \long\def\colophon{\hbox to0pt{}\vfill | |
9099 | \centerline{The body of this manual is set in} | |
9100 | \centerline{\fontname\tenrm,} | |
9101 | \centerline{with headings in {\bf\fontname\tenbf}} | |
9102 | \centerline{and examples in {\tt\fontname\tentt}.} | |
9103 | \centerline{{\it\fontname\tenit\/} and} | |
9104 | \centerline{{\sl\fontname\tensl\/}} | |
9105 | \centerline{are used for emphasis.}\vfill} | |
9106 | \page\colophon | |
7ca01ed9 | 9107 | % Blame: doc@@cygnus.com, 28mar91. |
252b5132 RH |
9108 | @end tex |
9109 | ||
252b5132 | 9110 | @bye |