7997c8d0de23f00363de4da58ed3f6f645ff4cc8
[kopensolaris-gnu/glibc.git] / 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 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
18 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
19 Cambridge, MA 02139, USA.  */
20
21 #ifndef _LIBC_SYMBOLS_H
22 #define _LIBC_SYMBOLS_H
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_GNU_LD if using GNU ld, with support for weak symbols in a.out,
31    and for symbol set and warning messages extensions in a.out and ELF.
32    This implies HAVE_WEAK_SYMBOLS; set by --with-gnu-ld.
33    * HAVE_ELF if using ELF, which supports weak symbols.
34    This implies HAVE_WEAK_SYMBOLS; set by --with-elf.
35
36    * HAVE_WEAK_SYMBOLS if weak symbols are available in the assembler and
37    linker being used.  Set by --with-weak-symbols.
38
39    */
40 #include <config.h>
41
42 /* This is defined for the compilation of all C library code.
43    features.h tests this to avoid inclusion of stubs.h while
44    compiling the library, before stubs.h has been generated.
45    Some library code that is shared with other packages also
46    tests this symbol to see if it is being compiled as part
47    of the C library.  */
48 #define _LIBC   1
49 /*
50 \f
51
52   Define the macro `_' for conveniently marking translatable strings
53   in the libc source code.  */
54
55 #include <libintl.h>
56 extern const char _libc_intl_domainname[];
57 #ifdef dgettext
58 /* This is defined as an optimizing macro, so use it.  */
59 #define _(msgid)        dgettext (_libc_intl_domainname, (msgid))
60 #else
61 /* Be sure to use only the __ name when `dgettext' is a plain function
62    instead of an optimizing macro.  */
63 #define _(msgid)        __dgettext (_libc_intl_domainname, (msgid))
64 #endif
65
66 /*
67 \f
68 */
69 /* The symbols in all the user (non-_) macros are C symbols.  Predefined
70    should be HAVE_WEAK_SYMBOLS and/or HAVE_ELF and/or HAVE_GNU_LD.
71    HAVE_WEAK_SYMBOLS is implied by the other two.  HAVE_GNU_LD without
72    HAVE_ELF implies a.out.  */
73
74 #ifndef HAVE_WEAK_SYMBOLS
75 #if defined (HAVE_ELF) || defined (HAVE_GNU_LD)
76 #define HAVE_WEAK_SYMBOLS
77 #endif
78 #endif
79
80 #ifndef __SYMBOL_PREFIX
81 #ifdef HAVE_ELF
82 #define NO_UNDERSCORES
83 #else
84 #include <sysdep.h>             /* Should define NO_UNDERSCORES.  */
85 #endif
86 #ifdef NO_UNDERSCORES
87 #define __SYMBOL_PREFIX
88 #else
89 #define __SYMBOL_PREFIX "_"
90 #endif
91 #endif
92
93 #ifndef C_SYMBOL_NAME
94 #ifdef NO_UNDERSCORES
95 #define C_SYMBOL_NAME(name) name
96 #else
97 #define C_SYMBOL_NAME(name) _##name
98 #endif
99 #endif
100
101
102 /* Define ALIAS as a strong alias for ORIGINAL.  */
103 #ifdef HAVE_ASM_SET_DIRECTIVE
104 #define strong_alias_asm(original, alias)       \
105   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias);   \
106   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original)
107 #ifdef ASSEMBLER
108 #define strong_alias(original, alias)   strong_alias_asm (original, alias)
109 #else
110 #define strong_alias(original, alias)   \
111   asm (__string_1 (ASM_GLOBAL_DIRECTIVE) " " __SYMBOL_PREFIX #alias "\n" \
112        ".set " __SYMBOL_PREFIX #alias "," __SYMBOL_PREFIX #original);
113 #endif
114 #else
115 #define strong_alias_asm(original, alias)       \
116   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias);   \
117   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
118 #ifdef ASSEMBLER
119 #define strong_alias(original, alias)   strong_alias_asm (original, alias)
120 #else
121 #define strong_alias(original, alias)   \
122   asm (__string_1 (ASM_GLOBAL_DIRECTIVE) " " __SYMBOL_PREFIX #alias "\n" \
123        __SYMBOL_PREFIX #alias " = " __SYMBOL_PREFIX #original);
124 #endif
125 #endif
126
127 /* Helper macros used above.  */
128 #define __string_1(x) __string_0(x)
129 #define __string_0(x) #x
130
131
132 #ifdef HAVE_WEAK_SYMBOLS
133 #ifdef ASSEMBLER
134
135 /* Define ALIAS as a weak alias for ORIGINAL.
136    If weak aliases are not available, this defines a strong alias.  */
137 #define weak_alias(original, alias)     \
138   .weak C_SYMBOL_NAME (alias);  \
139   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
140
141 /* Declare SYMBOL to be weak.  */
142 #define weak_symbol(symbol)     .weak C_SYMBOL_NAME (symbol)
143
144 #else
145 #define weak_symbol(symbol)     asm (".weak " __SYMBOL_PREFIX #symbol);
146 #define weak_alias(original, alias) \
147   asm (".weak " __SYMBOL_PREFIX #alias "\n" \
148        __SYMBOL_PREFIX #alias " = " __SYMBOL_PREFIX #original);
149 #endif
150 #else
151 #define weak_alias(original, alias) strong_alias(original, alias)
152 #define weak_symbol(symbol)     /* Do nothing.  */
153 #endif
154
155
156 #if (!defined (ASSEMBLER) && \
157      (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)))
158 /* GCC 2.7 and later has special syntax for weak symbols and aliases.
159    Using that is better when possible, because the compiler and assembler
160    are better clued in to what we are doing.  */
161 #undef  strong_alias
162 #define strong_alias(name, aliasname) \
163   extern __typeof (name) aliasname __attribute__ ((alias (#name)));
164
165 #ifdef HAVE_WEAK_SYMBOLS
166 #undef  weak_symbol
167 #define weak_symbol(name) \
168   extern __typeof (name) name __attribute__ ((weak));
169 #undef  weak_alias
170 #define weak_alias(name, aliasname) \
171   extern __typeof (name) aliasname __attribute__ ((weak, alias (#name)));
172 #endif  /* HAVE_WEAK_SYMBOLS.  */
173 #endif  /* Not ASSEMBLER, and GCC 2.7 or later.  */
174
175
176
177 /* When a reference to SYMBOL is encountered, the linker will emit a
178    warning message MSG.  */
179 #ifdef HAVE_GNU_LD
180 #ifdef HAVE_ELF
181 #define link_warning(symbol, msg)                       \
182   static const char __evoke_link_warning_##symbol[]     \
183     __attribute__ ((section (".gnu.warning." #symbol))) = msg;
184 #else
185 #define link_warning(symbol, msg)               \
186   asm(".stabs \"" msg "\",30,0,0,0\n"   \
187       ".stabs \"" __SYMBOL_PREFIX #symbol "\",1,0,0,0\n");
188 #endif
189 #else
190 /* We will never be heard; they will all die horribly.  */
191 #define link_warning(symbol, msg)
192 #endif
193
194 /* A canned warning for sysdeps/stub functions.  */
195 #define stub_warning(name) \
196   link_warning (name, \
197                 "warning: " #name " is not implemented and will always fail")
198
199 /*
200 \f
201 */
202
203 #ifdef HAVE_GNU_LD
204
205 /* Symbol set support macros.  */
206
207 #ifdef HAVE_ELF
208
209 /* Make SYMBOL, which is in the text segment, an element of SET.  */
210 #define text_set_element(set, symbol)   _elf_set_element(set, symbol)
211 /* Make SYMBOL, which is in the data segment, an element of SET.  */
212 #define data_set_element(set, symbol)   _elf_set_element(set, symbol)
213 /* Make SYMBOL, which is in the bss segment, an element of SET.  */
214 #define bss_set_element(set, symbol)    _elf_set_element(set, symbol)
215
216 /* These are all done the same way in ELF.
217    There is a new section created for each set.  */
218 #ifdef PIC
219 /* When building a shared library, make the set section writable,
220    because it will need to be relocated at run time anyway.  */
221 #define _elf_set_element(set, symbol) \
222   static const void *__elf_set_##set##_element_##symbol##__ \
223     __attribute__ ((unused, section (#set))) = &(symbol)
224 #else
225 #define _elf_set_element(set, symbol) \
226   static const void *const __elf_set_##set##_element_##symbol##__ \
227     __attribute__ ((unused, section (#set))) = &(symbol)
228 #endif
229
230 /* Define SET as a symbol set.  This may be required (it is in a.out) to
231    be able to use the set's contents.  */
232 #define symbol_set_define(set)  symbol_set_declare(set)
233
234 /* Declare SET for use in this module, if defined in another module.  */
235 #define symbol_set_declare(set) \
236   extern void *const __start_##set __attribute__ ((__weak__));  \
237   extern void *const __stop_##set __attribute__ ((__weak__));
238
239 /* Return a pointer (void *const *) to the first element of SET.  */
240 #define symbol_set_first_element(set)   (&__start_##set)
241
242 /* Return true iff PTR (a void *const *) has been incremented
243    past the last element in SET.  */
244 #define symbol_set_end_p(set, ptr)      ((ptr) >= &__stop_##set)
245
246 #else   /* Not ELF: a.out.  */
247
248 #define text_set_element(set, symbol)   \
249   asm(".stabs \"" __SYMBOL_PREFIX #set "\",23,0,0," __SYMBOL_PREFIX #symbol)
250 #define data_set_element(set, symbol)   \
251   asm(".stabs \"" __SYMBOL_PREFIX #set "\",25,0,0," __SYMBOL_PREFIX #symbol)
252 #define bss_set_element(set, symbol)    ?error Must use initialized data.
253 #define symbol_set_define(set)          void *const (set)[1];
254 #define symbol_set_declare(set)         extern void *const (set)[1];
255
256 #define symbol_set_first_element(set)   &(set)[1]
257 #define symbol_set_end_p(set, ptr)      (*(ptr) == 0)
258
259 #endif  /* ELF.  */
260 #endif  /* Have GNU ld.  */
261
262 #endif /* libc-symbols.h */