[! HAVE_ASM_SET_DIRECTIVE] (strong_alias, strong_alias_asm): Use
[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
49
50 /* The symbols in all the user (non-_) macros are C symbols.  Predefined
51    should be HAVE_WEAK_SYMBOLS and/or HAVE_ELF and/or HAVE_GNU_LD.
52    HAVE_WEAK_SYMBOLS is implied by the other two.  HAVE_GNU_LD without
53    HAVE_ELF implies a.out.  */
54
55 #ifndef HAVE_WEAK_SYMBOLS
56 #if defined (HAVE_ELF) || defined (HAVE_GNU_LD)
57 #define HAVE_WEAK_SYMBOLS
58 #endif
59 #endif
60
61 #ifndef __SYMBOL_PREFIX
62 #ifdef HAVE_ELF
63 #define NO_UNDERSCORES
64 #else
65 #include <sysdep.h>             /* Should define NO_UNDERSCORES.  */
66 #endif
67 #ifdef NO_UNDERSCORES
68 #define __SYMBOL_PREFIX
69 #else
70 #define __SYMBOL_PREFIX "_"
71 #endif
72 #endif
73
74 #ifndef C_SYMBOL_NAME
75 #ifdef NO_UNDERSCORES
76 #define C_SYMBOL_NAME(name) name
77 #else
78 #define C_SYMBOL_NAME(name) _##name
79 #endif
80 #endif
81
82 /* Define ALIAS as a strong alias for ORIGINAL.  */
83 #ifdef HAVE_ASM_SET_DIRECTIVE
84 #define strong_alias_asm(original, alias)       \
85   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original)
86 #ifdef ASSEMBLER
87 #define strong_alias(original, alias)   strong_alias_asm (original, alias)
88 #else
89 #define strong_alias(original, alias)   \
90   asm (".set " __SYMBOL_PREFIX #alias "," __SYMBOL_PREFIX #original);
91 #endif
92 #else
93 #define strong_alias_asm(original, alias)       \
94   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
95 #ifdef ASSEMBLER
96 #define strong_alias(original, alias)   strong_alias_asm (original, alias)
97 #else
98 #define strong_alias(original, alias)   \
99   asm (__SYMBOL_PREFIX #alias " = " __SYMBOL_PREFIX #original);
100 #endif
101 #endif
102
103 /* Define ALIAS as a weak alias for ORIGINAL.
104    If weak aliases are not available, this defines a strong alias.  */
105 #ifdef HAVE_WEAK_SYMBOLS
106 #ifdef ASSEMBLER
107 #define weak_alias(original, alias)     \
108   .weak C_SYMBOL_NAME (alias);  \
109   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
110
111 /* Declare SYMBOL to be weak.  */
112 #define weak_symbol(symbol)     .weak C_SYMBOL_NAME (symbol)
113 #else
114 #define weak_symbol(symbol)     asm (".weak " __SYMBOL_PREFIX #symbol);
115 #define weak_alias(original, alias) \
116   asm (".weak " __SYMBOL_PREFIX #alias "\n" \
117        __SYMBOL_PREFIX #alias " = " __SYMBOL_PREFIX #original);
118 #endif
119 #else
120 #define weak_alias(original, alias) strong_alias(original, alias)
121 #define weak_symbol(symbol)     /* Do nothing.  */
122 #endif
123
124
125
126 /* When the file using this macro is linked in, the linker
127    will emit a warning message MSG.  */
128 #ifdef HAVE_GNU_LD
129 #ifdef HAVE_ELF
130 #define link_warning(msg)                       \
131   static const char __evoke_link_warning__[]    \
132     __attribute__ ((section (".gnu.warning"))) = msg;
133 #else
134 #define link_warning(msg)               \
135   asm(".stabs \"" msg "\",30,0,0,0\n"   \
136       ".stabs \"__evoke_link_warning__\",1,0,0,0\n"\
137       ".stabs \"__evoke_link_warning__\",2,0,0,0\n");
138 #endif
139 #else
140 /* We will never be heard; they will all die horribly.  */
141 #define link_warning(msg)
142 #endif
143
144 /* A canned warning for sysdeps/stub functions.  */
145 #define stub_warning(name) \
146   link_warning ("warning: " #name " is not implemented and will always fail")
147
148 /*
149 \f
150 */
151
152 #ifdef HAVE_GNU_LD
153
154 /* Symbol set support macros.  */
155
156 #ifdef HAVE_ELF
157
158 /* Make SYMBOL, which is in the text segment, an element of SET.  */
159 #define text_set_element(set, symbol)   _elf_set_element(set, symbol)
160 /* Make SYMBOL, which is in the data segment, an element of SET.  */
161 #define data_set_element(set, symbol)   _elf_set_element(set, symbol)
162 /* Make SYMBOL, which is in the bss segment, an element of SET.  */
163 #define bss_set_element(set, symbol)    _elf_set_element(set, symbol)
164
165 /* These are all done the same way in ELF.
166    There is a new section created for each set.  */
167 #ifdef PIC
168 /* When building a shared library, make the set section writable,
169    because it will need to be relocated at run time anyway.  */
170 #define _elf_set_element(set, symbol) \
171   static const void *__elf_set_##set##_element_##symbol##__ \
172     __attribute__ ((section (#set))) = &(symbol)
173 #else
174 #define _elf_set_element(set, symbol) \
175   static const void *const __elf_set_##set##_element_##symbol##__ \
176     __attribute__ ((section (#set))) = &(symbol)
177 #endif
178
179 /* Define SET as a symbol set.  This may be required (it is in a.out) to
180    be able to use the set's contents.  */
181 #define symbol_set_define(set)  symbol_set_declare(set)
182
183 /* Declare SET for use in this module, if defined in another module.  */
184 #define symbol_set_declare(set) \
185   extern void *const __start_##set, *const __stop_##set;
186
187 /* Return a pointer (void *const *) to the first element of SET.  */
188 #define symbol_set_first_element(set)   (&__start_##set)
189
190 /* Return true iff PTR (a void *const *) has been incremented
191    past the last element in SET.  */
192 #define symbol_set_end_p(set, ptr)      ((ptr) >= &__stop_##set)
193
194 #else   /* Not ELF: a.out.  */
195
196 #define text_set_element(set, symbol)   \
197   asm(".stabs \"" __SYMBOL_PREFIX #set "\",23,0,0," __SYMBOL_PREFIX #symbol)
198 #define data_set_element(set, symbol)   \
199   asm(".stabs \"" __SYMBOL_PREFIX #set "\",25,0,0," __SYMBOL_PREFIX #symbol)
200 #define bss_set_element(set, symbol)    ?error Must use initialized data.
201 #define symbol_set_define(set)          void *const (set)[1];
202 #define symbol_set_declare(set)         extern void *const (set)[1];
203
204 #define symbol_set_first_element(set)   &(set)[1]
205 #define symbol_set_end_p(set, ptr)      (*(ptr) == 0)
206
207 #endif  /* ELF.  */
208 #endif  /* Have GNU ld.  */
209
210 #endif /* libc-symbols.h */