1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<!-- This file documents the GNU linker LD
4(GNU Toolchain for the A-profile Architecture 10.3-2021.07 (arm-10.29))
5version 2.36.1.
6
7Copyright (C) 1991-2021 Free Software Foundation, Inc.
8
9Permission is granted to copy, distribute and/or modify this document
10under the terms of the GNU Free Documentation License, Version 1.3
11or any later version published by the Free Software Foundation;
12with no Invariant Sections, with no Front-Cover Texts, and with no
13Back-Cover Texts.  A copy of the license is included in the
14section entitled "GNU Free Documentation License". -->
15<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
16<head>
17<title>LD: PROVIDE</title>
18
19<meta name="description" content="LD: PROVIDE">
20<meta name="keywords" content="LD: PROVIDE">
21<meta name="resource-type" content="document">
22<meta name="distribution" content="global">
23<meta name="Generator" content="makeinfo">
24<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
25<link href="index.html#Top" rel="start" title="Top">
26<link href="LD-Index.html#LD-Index" rel="index" title="LD Index">
27<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
28<link href="Assignments.html#Assignments" rel="up" title="Assignments">
29<link href="PROVIDE_005fHIDDEN.html#PROVIDE_005fHIDDEN" rel="next" title="PROVIDE_HIDDEN">
30<link href="HIDDEN.html#HIDDEN" rel="previous" title="HIDDEN">
31<style type="text/css">
32<!--
33a.summary-letter {text-decoration: none}
34blockquote.smallquotation {font-size: smaller}
35div.display {margin-left: 3.2em}
36div.example {margin-left: 3.2em}
37div.indentedblock {margin-left: 3.2em}
38div.lisp {margin-left: 3.2em}
39div.smalldisplay {margin-left: 3.2em}
40div.smallexample {margin-left: 3.2em}
41div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
42div.smalllisp {margin-left: 3.2em}
43kbd {font-style:oblique}
44pre.display {font-family: inherit}
45pre.format {font-family: inherit}
46pre.menu-comment {font-family: serif}
47pre.menu-preformatted {font-family: serif}
48pre.smalldisplay {font-family: inherit; font-size: smaller}
49pre.smallexample {font-size: smaller}
50pre.smallformat {font-family: inherit; font-size: smaller}
51pre.smalllisp {font-size: smaller}
52span.nocodebreak {white-space:nowrap}
53span.nolinebreak {white-space:nowrap}
54span.roman {font-family:serif; font-weight:normal}
55span.sansserif {font-family:sans-serif; font-weight:normal}
56ul.no-bullet {list-style: none}
57-->
58</style>
59
60
61</head>
62
63<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
64<a name="PROVIDE"></a>
65<div class="header">
66<p>
67Next: <a href="PROVIDE_005fHIDDEN.html#PROVIDE_005fHIDDEN" accesskey="n" rel="next">PROVIDE_HIDDEN</a>, Previous: <a href="HIDDEN.html#HIDDEN" accesskey="p" rel="previous">HIDDEN</a>, Up: <a href="Assignments.html#Assignments" accesskey="u" rel="up">Assignments</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="LD-Index.html#LD-Index" title="Index" rel="index">Index</a>]</p>
68</div>
69<hr>
70<a name="PROVIDE-1"></a>
71<h4 class="subsection">3.5.3 PROVIDE</h4>
72<a name="index-PROVIDE"></a>
73<p>In some cases, it is desirable for a linker script to define a symbol
74only if it is referenced and is not defined by any object included in
75the link.  For example, traditional linkers defined the symbol
76&lsquo;<samp>etext</samp>&rsquo;.  However, ANSI C requires that the user be able to use
77&lsquo;<samp>etext</samp>&rsquo; as a function name without encountering an error.  The
78<code>PROVIDE</code> keyword may be used to define a symbol, such as
79&lsquo;<samp>etext</samp>&rsquo;, only if it is referenced but not defined.  The syntax is
80<code>PROVIDE(<var>symbol</var> = <var>expression</var>)</code>.
81</p>
82<p>Here is an example of using <code>PROVIDE</code> to define &lsquo;<samp>etext</samp>&rsquo;:
83</p><div class="smallexample">
84<pre class="smallexample">SECTIONS
85{
86  .text :
87    {
88      *(.text)
89      _etext = .;
90      PROVIDE(etext = .);
91    }
92}
93</pre></div>
94
95<p>In this example, if the program defines &lsquo;<samp>_etext</samp>&rsquo; (with a leading
96underscore), the linker will give a multiple definition error.  If, on
97the other hand, the program defines &lsquo;<samp>etext</samp>&rsquo; (with no leading
98underscore), the linker will silently use the definition in the program.
99If the program references &lsquo;<samp>etext</samp>&rsquo; but does not define it, the
100linker will use the definition in the linker script.
101</p>
102<p>Note - the <code>PROVIDE</code> directive considers a common symbol to be
103defined, even though such a symbol could be combined with the symbol
104that the <code>PROVIDE</code> would create.  This is particularly important
105when considering constructor and destructor list symbols such as
106&lsquo;<samp>__CTOR_LIST__</samp>&rsquo; as these are often defined as common symbols.
107</p>
108
109
110
111</body>
112</html>
113