dd573b32a8f88121cfaef45fcca98adb47a41ce0
[kopensolaris-gnu/glibc.git] / include / libc-symbols.h
1 /* Support macros for making weak and strong aliases for symbols,
2    and for using symbol sets and linker warnings with GNU ld.
3    Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
4    This file is part of the GNU C Library.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Library General Public License as
8    published by the Free Software Foundation; either version 2 of the
9    License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Library General Public License for more details.
15
16    You should have received a copy of the GNU Library General Public
17    License along with the GNU C Library; see the file COPYING.LIB.  If not,
18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19    Boston, MA 02111-1307, USA.  */
20
21 #ifndef _LIBC_SYMBOLS_H
22 #define _LIBC_SYMBOLS_H 1
23
24 /* This file's macros are included implicitly in the compilation of every
25    file in the C library by -imacros.
26
27    We include config.h which is generated by configure.
28    It should define for us the following symbols:
29
30    * HAVE_ASM_SET_DIRECTIVE if we have `.set B, A' instead of `A = B'.
31    * ASM_GLOBAL_DIRECTIVE with `.globl' or `.global'.
32    * HAVE_GNU_LD if using GNU ld, with support for weak symbols in a.out,
33    and for symbol set and warning messages extensions in a.out and ELF.
34    * HAVE_ELF if using ELF, which supports weak symbols using `.weak'.
35    * HAVE_ASM_WEAK_DIRECTIVE if we have weak symbols using `.weak'.
36    * HAVE_ASM_WEAKEXT_DIRECTIVE if we have weak symbols using `.weakext'.
37
38    */
39
40 /* This is defined for the compilation of all C library code.  features.h
41    tests this to avoid inclusion of stubs.h while compiling the library,
42    before stubs.h has been generated.  Some library code that is shared
43    with other packages also tests this symbol to see if it is being
44    compiled as part of the C library.  We must define this before including
45    config.h, because it makes some definitions conditional on whether libc
46    itself is being compiled, or just some generator program.  */
47 #define _LIBC   1
48
49 /* Enable declarations of GNU extensions, since we are compiling them.  */
50 #define _GNU_SOURCE     1
51 /* And we also need the data for the reentrant functions.  */
52 #define _REENTRANT      1
53
54 #include <config.h>
55
56 /* The symbols in all the user (non-_) macros are C symbols.
57    HAVE_GNU_LD without HAVE_ELF implies a.out.  */
58
59 #if defined HAVE_ASM_WEAK_DIRECTIVE || defined HAVE_ASM_WEAKEXT_DIRECTIVE
60 # define HAVE_WEAK_SYMBOLS
61 #endif
62
63 #ifndef __SYMBOL_PREFIX
64 # ifdef NO_UNDERSCORES
65 #  define __SYMBOL_PREFIX
66 # else
67 #  define __SYMBOL_PREFIX "_"
68 # endif
69 #endif
70
71 #ifndef C_SYMBOL_NAME
72 # ifdef NO_UNDERSCORES
73 #  define C_SYMBOL_NAME(name) name
74 # else
75 #  define C_SYMBOL_NAME(name) _##name
76 # endif
77 #endif
78
79
80 /* Define ALIAS as a strong alias for ORIGINAL.  */
81 #ifdef HAVE_ASM_SET_DIRECTIVE
82 # define strong_alias_asm(original, alias)      \
83   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias);   \
84   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original)
85 # ifdef __ASSEMBLER__
86 #  define strong_alias(original, alias) strong_alias_asm (original, alias)
87 # else
88 #  define strong_alias(original, alias) \
89   asm (__string_1 (ASM_GLOBAL_DIRECTIVE) " " __SYMBOL_PREFIX #alias "\n" \
90        ".set " __SYMBOL_PREFIX #alias "," __SYMBOL_PREFIX #original);
91 # endif
92 #else
93 # define strong_alias_asm(original, alias)      \
94   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias);   \
95   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
96 # ifdef __ASSEMBLER__
97 #  define strong_alias(original, alias) strong_alias_asm (original, alias)
98 # else
99 #  define strong_alias(original, alias) \
100   asm (__string_1 (ASM_GLOBAL_DIRECTIVE) " " __SYMBOL_PREFIX #alias "\n" \
101        __SYMBOL_PREFIX #alias " = " __SYMBOL_PREFIX #original);
102 # endif
103 #endif
104
105 /* Helper macros used above.  */
106 #define __string_1(x) __string_0(x)
107 #define __string_0(x) #x
108
109
110 #ifdef HAVE_WEAK_SYMBOLS
111
112 # ifdef __ASSEMBLER__
113
114 #  ifdef HAVE_ASM_WEAKEXT_DIRECTIVE
115
116 /* Define ALIAS as a weak alias for ORIGINAL.
117    If weak aliases are not available, this defines a strong alias.  */
118 #   define weak_alias(original, alias)  \
119   .weakext C_SYMBOL_NAME (alias), C_SYMBOL_NAME (original)
120
121 /* Declare SYMBOL as weak undefined symbol (resolved to 0 if not defined).  */
122 #   define weak_extern(symbol)  \
123   .weakext C_SYMBOL_NAME (symbol)
124
125 #  else /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
126
127 /* Define ALIAS as a weak alias for ORIGINAL.
128    If weak aliases are not available, this defines a strong alias.  */
129 #   define weak_alias(original, alias)  \
130   .weak C_SYMBOL_NAME (alias);  \
131   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
132
133
134 /* Declare SYMBOL as weak undefined symbol (resolved to 0 if not defined).  */
135 #   define weak_extern(symbol)  \
136   .weak C_SYMBOL_NAME (symbol)
137
138 #  endif /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
139
140 # else /* ! __ASSEMBLER__ */
141
142 #  ifdef HAVE_ASM_WEAKEXT_DIRECTIVE
143 #   define weak_extern_asm(symbol) asm (".weakext " __SYMBOL_PREFIX #symbol);
144 #   define weak_alias_asm(original, alias) \
145   asm (".weakext " __SYMBOL_PREFIX #alias ", " __SYMBOL_PREFIX #original);
146 #  else /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
147 #   define weak_extern_asm(symbol)      asm (".weak " __SYMBOL_PREFIX #symbol);
148 #   define weak_alias_asm(original, alias) \
149   asm (".weak " __SYMBOL_PREFIX #alias "\n" \
150        __SYMBOL_PREFIX #alias " = " __SYMBOL_PREFIX #original);
151 #  endif /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
152
153 #  define weak_alias(o, a) weak_alias_asm (o, a)
154 #  define weak_extern(symbol) weak_extern_asm (symbol)
155
156 # endif /* ! __ASSEMBLER__ */
157 #else
158 # define weak_alias(original, alias) strong_alias(original, alias)
159 # define weak_extern(symbol)    /* Do nothing; the ref will be strong.  */
160 #endif
161
162
163 #if (!defined __ASSEMBLER__ && \
164      (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)))
165 /* GCC 2.7 and later has special syntax for weak symbols and aliases.
166    Using that is better when possible, because the compiler and assembler
167    are better clued in to what we are doing.  */
168 # undef strong_alias
169 # define strong_alias(name, aliasname) \
170   extern __typeof (name) aliasname __attribute__ ((alias (#name)));
171
172 # ifdef HAVE_WEAK_SYMBOLS
173 #  undef weak_alias
174 #  define weak_alias(name, aliasname) \
175   extern __typeof (name) aliasname __attribute__ ((weak, alias (#name)));
176
177 /* This comes between the return type and function name in
178    a function definition to make that definition weak.  */
179 #  define weak_function __attribute__ ((weak))
180 #  define weak_const_function __attribute__ ((weak, __const__))
181
182 # endif /* HAVE_WEAK_SYMBOLS.  */
183 #endif  /* Not __ASSEMBLER__, and GCC 2.7 or later.  */
184
185
186 #ifndef weak_function
187 /* If we do not have the __attribute__ ((weak)) syntax, there is no way we
188    can define functions as weak symbols.  The compiler will emit a `.globl'
189    directive for the function symbol, and a `.weak' directive in addition
190    will produce an error from the assembler.  */
191 # define weak_function          /* empty */
192 # define weak_const_function    /* empty */
193 #endif
194
195 /* On some platforms we can make internal function calls (i.e., calls of
196    functions not exported) a bit faster by using a different calling
197    convention.  */
198 #ifndef internal_function
199 # define internal_function      /* empty */
200 #endif
201
202 /* Prepare for the case that `__builtin_expect' is not available.  */
203 #ifndef HAVE_BUILTIN_EXPECT
204 # define __builtin_expect(expr, val) (expr)
205 #endif
206
207 /* When a reference to SYMBOL is encountered, the linker will emit a
208    warning message MSG.  */
209 #ifdef HAVE_GNU_LD
210 # ifdef HAVE_ELF
211
212 /* We want the .gnu.warning.SYMBOL section to be unallocated.  */
213 #  ifdef HAVE_ASM_PREVIOUS_DIRECTIVE
214 #   define __make_section_unallocated(section_string)   \
215   asm(".section " section_string "; .previous");
216 #  elif defined (HAVE_ASM_POPSECTION_DIRECTIVE)
217 #   define __make_section_unallocated(section_string)   \
218   asm(".pushsection " section_string "; .popsection");
219 #  else
220 #   define __make_section_unallocated(section_string)
221 #  endif
222
223 #  define link_warning(symbol, msg)                     \
224   __make_section_unallocated (".gnu.warning." #symbol)  \
225   static const char __evoke_link_warning_##symbol[]     \
226     __attribute__ ((section (".gnu.warning." #symbol))) = msg;
227 # else
228 #  define link_warning(symbol, msg)             \
229   asm(".stabs \"" msg "\",30,0,0,0\n"   \
230       ".stabs \"" __SYMBOL_PREFIX #symbol "\",1,0,0,0\n");
231 # endif
232 #else
233 /* We will never be heard; they will all die horribly.  */
234 # define link_warning(symbol, msg)
235 #endif
236
237 /* A canned warning for sysdeps/stub functions.  */
238 #define stub_warning(name) \
239   link_warning (name, \
240                 "warning: " #name " is not implemented and will always fail")
241
242 /*
243 \f
244 */
245
246 #ifdef HAVE_GNU_LD
247
248 /* Symbol set support macros.  */
249
250 # ifdef HAVE_ELF
251
252 /* Make SYMBOL, which is in the text segment, an element of SET.  */
253 #  define text_set_element(set, symbol) _elf_set_element(set, symbol)
254 /* Make SYMBOL, which is in the data segment, an element of SET.  */
255 #  define data_set_element(set, symbol) _elf_set_element(set, symbol)
256 /* Make SYMBOL, which is in the bss segment, an element of SET.  */
257 #  define bss_set_element(set, symbol)  _elf_set_element(set, symbol)
258
259 /* These are all done the same way in ELF.
260    There is a new section created for each set.  */
261 #  ifdef PIC
262 /* When building a shared library, make the set section writable,
263    because it will need to be relocated at run time anyway.  */
264 #   define _elf_set_element(set, symbol) \
265   static const void *__elf_set_##set##_element_##symbol##__ \
266     __attribute__ ((unused, section (#set))) = &(symbol)
267 #  else
268 #   define _elf_set_element(set, symbol) \
269   static const void *const __elf_set_##set##_element_##symbol##__ \
270     __attribute__ ((unused, section (#set))) = &(symbol)
271 #  endif
272
273 /* Define SET as a symbol set.  This may be required (it is in a.out) to
274    be able to use the set's contents.  */
275 #  define symbol_set_define(set)        symbol_set_declare(set)
276
277 /* Declare SET for use in this module, if defined in another module.  */
278 #  define symbol_set_declare(set) \
279   extern void *const __start_##set __attribute__ ((__weak__));          \
280   extern void *const __stop_##set __attribute__ ((__weak__));           \
281   weak_extern (__start_##set) weak_extern (__stop_##set)
282
283 /* Return a pointer (void *const *) to the first element of SET.  */
284 #  define symbol_set_first_element(set) (&__start_##set)
285
286 /* Return true iff PTR (a void *const *) has been incremented
287    past the last element in SET.  */
288 #  define symbol_set_end_p(set, ptr)    ((ptr) >= &__stop_##set)
289
290 # else  /* Not ELF: a.out.  */
291
292 #  define text_set_element(set, symbol) \
293   asm(".stabs \"" __SYMBOL_PREFIX #set "\",23,0,0," __SYMBOL_PREFIX #symbol)
294 #  define data_set_element(set, symbol) \
295   asm(".stabs \"" __SYMBOL_PREFIX #set "\",25,0,0," __SYMBOL_PREFIX #symbol)
296 #  define bss_set_element(set, symbol)  ?error Must use initialized data.
297 #  define symbol_set_define(set)        void *const (set)[1];
298 #  define symbol_set_declare(set)       extern void *const (set)[1];
299
300 #  define symbol_set_first_element(set) &(set)[1]
301 #  define symbol_set_end_p(set, ptr)    (*(ptr) == 0)
302
303 # endif /* ELF.  */
304 #endif  /* Have GNU ld.  */
305
306 #if DO_VERSIONING
307 # ifdef __ASSEMBLER__
308 #  define symbol_version(real, name, version) \
309      .symver real, name##@##version
310 #  define default_symbol_version(real, name, version) \
311      .symver real, name##@##@##version
312 # else
313 #  define symbol_version(real, name, version) \
314      __asm__ (".symver " #real "," #name "@" #version)
315 #  define default_symbol_version(real, name, version) \
316      __asm__ (".symver " #real "," #name "@@" #version)
317 # endif
318 #else
319 # define symbol_version(real, name, version)
320 # define default_symbol_version(real, name, version) \
321   strong_alias(real, name)
322 #endif
323
324 #endif /* libc-symbols.h */