* include/libc-symbols.h (symbol_set_declare): Revert 2000-06-26 mods.
[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, 2000 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 #ifndef __ASSEMBLER__
80 /* GCC understands weak symbols and aliases; use its interface where
81    possible, instead of embedded assembly language.  */
82
83 /* Define ALIASNAME as a strong alias for NAME.  */
84 # define strong_alias(name, aliasname) _strong_alias(name, aliasname)
85 # define _strong_alias(name, aliasname) \
86   extern __typeof (name) aliasname __attribute__ ((alias (#name)));
87
88 /* This comes between the return type and function name in
89    a function definition to make that definition weak.  */
90 # define weak_function __attribute__ ((weak))
91 # define weak_const_function __attribute__ ((weak, __const__))
92
93 # ifdef HAVE_WEAK_SYMBOLS
94
95 /* Define ALIASNAME as a weak alias for NAME.
96    If weak aliases are not available, this defines a strong alias.  */
97 #  define weak_alias(name, aliasname) _weak_alias (name, aliasname)
98 #  define _weak_alias(name, aliasname) \
99   extern __typeof (name) aliasname __attribute__ ((weak, alias (#name)));
100
101 /* Declare SYMBOL as weak undefined symbol (resolved to 0 if not defined).  */
102 #  define weak_extern(symbol) _weak_extern (symbol)
103 #  ifdef HAVE_ASM_WEAKEXT_DIRECTIVE
104 #   define _weak_extern(symbol) asm (".weakext " __SYMBOL_PREFIX #symbol);
105 #  else
106 #   define _weak_extern(symbol)    asm (".weak " __SYMBOL_PREFIX #symbol);
107 #  endif
108
109 # else
110
111 #  define weak_alias(name, aliasname) strong_alias(name, aliasname)
112 #  define weak_extern(symbol) /* Nothing. */
113
114 # endif
115
116 #else /* __ASSEMBLER__ */
117
118 # ifdef HAVE_ASM_SET_DIRECTIVE
119 #  define strong_alias(original, alias)         \
120   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias);   \
121   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original)
122 # else
123 #  define strong_alias(original, alias)         \
124   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias);   \
125   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
126 # endif
127
128 # ifdef HAVE_WEAK_SYMBOLS
129 #  ifdef HAVE_ASM_WEAKEXT_DIRECTIVE
130 #   define weak_alias(original, alias)  \
131   .weakext C_SYMBOL_NAME (alias), C_SYMBOL_NAME (original)
132 #   define weak_extern(symbol)  \
133   .weakext C_SYMBOL_NAME (symbol)
134
135 #  else /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
136
137 #   define weak_alias(original, alias)  \
138   .weak C_SYMBOL_NAME (alias);  \
139   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
140
141 #   define weak_extern(symbol)  \
142   .weak C_SYMBOL_NAME (symbol)
143
144 #  endif /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
145
146 # else /* ! HAVE_WEAK_SYMBOLS */
147
148 #  define weak_alias(original, alias) strong_alias(original, alias)
149 #  define weak_extern(symbol) /* Nothing */
150 # endif /* ! HAVE_WEAK_SYMBOLS */
151
152 #endif /* __ASSEMBLER__ */
153
154 /* On some platforms we can make internal function calls (i.e., calls of
155    functions not exported) a bit faster by using a different calling
156    convention.  */
157 #ifndef internal_function
158 # define internal_function      /* empty */
159 #endif
160
161 /* Prepare for the case that `__builtin_expect' is not available.  */
162 #ifndef HAVE_BUILTIN_EXPECT
163 # define __builtin_expect(expr, val) (expr)
164 #endif
165
166 /* When a reference to SYMBOL is encountered, the linker will emit a
167    warning message MSG.  */
168 #ifdef HAVE_GNU_LD
169 # ifdef HAVE_ELF
170
171 /* We want the .gnu.warning.SYMBOL section to be unallocated.  */
172 #  ifdef HAVE_ASM_PREVIOUS_DIRECTIVE
173 #   define __make_section_unallocated(section_string)   \
174   asm(".section " section_string "; .previous");
175 #  elif defined HAVE_ASM_POPSECTION_DIRECTIVE
176 #   define __make_section_unallocated(section_string)   \
177   asm(".pushsection " section_string "; .popsection");
178 #  else
179 #   define __make_section_unallocated(section_string)
180 #  endif
181
182 #  ifdef HAVE_SECTION_QUOTES
183 #   define link_warning(symbol, msg) \
184   __make_section_unallocated (".gnu.warning." #symbol) \
185   static const char __evoke_link_warning_##symbol[]     \
186     __attribute__ ((section (".gnu.warning." #symbol "\"\n\t#\""))) = msg;
187 #  else
188 #   define link_warning(symbol, msg) \
189   __make_section_unallocated (".gnu.warning." #symbol) \
190   static const char __evoke_link_warning_##symbol[]     \
191     __attribute__ ((section (".gnu.warning." #symbol "\n\t#"))) = msg;
192 #  endif
193 # else
194 #  define link_warning(symbol, msg)             \
195   asm(".stabs \"" msg "\",30,0,0,0\n"   \
196       ".stabs \"" __SYMBOL_PREFIX #symbol "\",1,0,0,0\n");
197 # endif
198 #else
199 /* We will never be heard; they will all die horribly.  */
200 # define link_warning(symbol, msg)
201 #endif
202
203 /* A canned warning for sysdeps/stub functions.  */
204 #define stub_warning(name) \
205   link_warning (name, \
206                 "warning: " #name " is not implemented and will always fail")
207
208 /*
209 \f
210 */
211
212 #ifdef HAVE_GNU_LD
213
214 /* Symbol set support macros.  */
215
216 # ifdef HAVE_ELF
217
218 /* Make SYMBOL, which is in the text segment, an element of SET.  */
219 #  define text_set_element(set, symbol) _elf_set_element(set, symbol)
220 /* Make SYMBOL, which is in the data segment, an element of SET.  */
221 #  define data_set_element(set, symbol) _elf_set_element(set, symbol)
222 /* Make SYMBOL, which is in the bss segment, an element of SET.  */
223 #  define bss_set_element(set, symbol)  _elf_set_element(set, symbol)
224
225 /* These are all done the same way in ELF.
226    There is a new section created for each set.  */
227 #  ifdef SHARED
228 /* When building a shared library, make the set section writable,
229    because it will need to be relocated at run time anyway.  */
230 #   define _elf_set_element(set, symbol) \
231   static const void *__elf_set_##set##_element_##symbol##__ \
232     __attribute__ ((unused, section (#set))) = &(symbol)
233 #  else
234 #   define _elf_set_element(set, symbol) \
235   static const void *const __elf_set_##set##_element_##symbol##__ \
236     __attribute__ ((unused, section (#set))) = &(symbol)
237 #  endif
238
239 /* Define SET as a symbol set.  This may be required (it is in a.out) to
240    be able to use the set's contents.  */
241 #  define symbol_set_define(set)        symbol_set_declare(set)
242
243 /* Declare SET for use in this module, if defined in another module.  */
244 #  define symbol_set_declare(set) \
245   extern void *const __start_##set __attribute__ ((__weak__));          \
246   extern void *const __stop_##set __attribute__ ((__weak__));           \
247   weak_extern (__start_##set) weak_extern (__stop_##set)
248
249 /* Return a pointer (void *const *) to the first element of SET.  */
250 #  define symbol_set_first_element(set) (&__start_##set)
251
252 /* Return true iff PTR (a void *const *) has been incremented
253    past the last element in SET.  */
254 #  define symbol_set_end_p(set, ptr)    ((ptr) >= &__stop_##set)
255
256 # else  /* Not ELF: a.out.  */
257
258 #  define text_set_element(set, symbol) \
259   asm(".stabs \"" __SYMBOL_PREFIX #set "\",23,0,0," __SYMBOL_PREFIX #symbol)
260 #  define data_set_element(set, symbol) \
261   asm(".stabs \"" __SYMBOL_PREFIX #set "\",25,0,0," __SYMBOL_PREFIX #symbol)
262 #  define bss_set_element(set, symbol)  ?error Must use initialized data.
263 #  define symbol_set_define(set)        void *const (set)[1];
264 #  define symbol_set_declare(set)       extern void *const (set)[1];
265
266 #  define symbol_set_first_element(set) &(set)[1]
267 #  define symbol_set_end_p(set, ptr)    (*(ptr) == 0)
268
269 # endif /* ELF.  */
270 #endif  /* Have GNU ld.  */
271
272 #if DO_VERSIONING
273 # define symbol_version(real, name, version) \
274      _symbol_version(real, name, version)
275 # define default_symbol_version(real, name, version) \
276      _default_symbol_version(real, name, version)
277 # ifdef __ASSEMBLER__
278 #  define _symbol_version(real, name, version) \
279      .symver real, name##@##version
280 #  define _default_symbol_version(real, name, version) \
281      .symver real, name##@##@##version
282 # else
283 #  define _symbol_version(real, name, version) \
284      __asm__ (".symver " #real "," #name "@" #version)
285 #  define _default_symbol_version(real, name, version) \
286      __asm__ (".symver " #real "," #name "@@" #version)
287 # endif
288 #else
289 # define symbol_version(real, name, version)
290 # define default_symbol_version(real, name, version) \
291   strong_alias(real, name)
292 #endif
293
294 #endif /* libc-symbols.h */