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-1998,2000-2006,2008,2009,2011
   4    Free Software Foundation, Inc.
   5    This file is part of the GNU C Library.
   6
   7    The GNU C Library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Lesser General Public
   9    License as published by the Free Software Foundation; either
  10    version 2.1 of the License, or (at your option) any later version.
  11
  12    The GNU C Library is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    Lesser General Public License for more details.
  16
  17    You should have received a copy of the GNU Lesser General Public
  18    License along with the GNU C Library; if not, write to the Free
  19    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20    02111-1307 USA.  */
  21
  22 #ifndef _LIBC_SYMBOLS_H
  23 #define _LIBC_SYMBOLS_H 1
  24
  25 /* This file's macros are included implicitly in the compilation of every
  26    file in the C library by -imacros.
  27
  28    We include config.h which is generated by configure.
  29    It should define for us the following symbols:
  30
  31    * HAVE_ASM_SET_DIRECTIVE if we have `.set B, A' instead of `A = B'.
  32    * ASM_GLOBAL_DIRECTIVE with `.globl' or `.global'.
  33    * ASM_TYPE_DIRECTIVE_PREFIX with `@' or `#' or whatever for .type,
  34      or leave it undefined if there is no .type directive.
  35    * HAVE_ELF if using ELF, which supports weak symbols using `.weak'.
  36    * HAVE_ASM_WEAK_DIRECTIVE if we have weak symbols using `.weak'.
  37    * HAVE_ASM_WEAKEXT_DIRECTIVE if we have weak symbols using `.weakext'.
  38
  39    */
  40
  41 /* This is defined for the compilation of all C library code.  features.h
  42    tests this to avoid inclusion of stubs.h while compiling the library,
  43    before stubs.h has been generated.  Some library code that is shared
  44    with other packages also tests this symbol to see if it is being
  45    compiled as part of the C library.  We must define this before including
  46    config.h, because it makes some definitions conditional on whether libc
  47    itself is being compiled, or just some generator program.  */
  48 #define _LIBC   1
  49
  50 /* Enable declarations of GNU extensions, since we are compiling them.  */
  51 #define _GNU_SOURCE     1
  52 /* And we also need the data for the reentrant functions.  */
  53 #define _REENTRANT      1
  54
  55 #include <config.h>
  56
  57 /* The symbols in all the user (non-_) macros are C symbols.
  58    NO HAVE_ELF implies a.out.  */
  59
  60 #if defined HAVE_ASM_WEAK_DIRECTIVE || defined HAVE_ASM_WEAKEXT_DIRECTIVE
  61 # define HAVE_WEAK_SYMBOLS
  62 #endif
  63
  64 #ifndef __SYMBOL_PREFIX
  65 # ifdef NO_UNDERSCORES
  66 #  define __SYMBOL_PREFIX
  67 # else
  68 #  define __SYMBOL_PREFIX "_"
  69 # endif
  70 #endif
  71
  72 #ifndef C_SYMBOL_NAME
  73 # ifdef NO_UNDERSCORES
  74 #  define C_SYMBOL_NAME(name) name
  75 # else
  76 #  define C_SYMBOL_NAME(name) _##name
  77 # endif
  78 #endif
  79
  80 #ifndef ASM_LINE_SEP
  81 # define ASM_LINE_SEP ;
  82 #endif
  83
  84 #ifdef HAVE_ASM_GLOBAL_DOT_NAME
  85 # ifndef C_SYMBOL_DOT_NAME
  86 #  if defined __GNUC__ && defined __GNUC_MINOR__ \
  87       && (__GNUC__ << 16) + __GNUC_MINOR__ >= (3 << 16) + 1
  88 #   define C_SYMBOL_DOT_NAME(name) .name
  89 #  else
  90 #   define C_SYMBOL_DOT_NAME(name) .##name
  91 #  endif
  92 # endif
  93 #endif
  94
  95 #ifndef __ASSEMBLER__
  96 /* GCC understands weak symbols and aliases; use its interface where
  97    possible, instead of embedded assembly language.  */
  98
  99 /* Define ALIASNAME as a strong alias for NAME.  */
 100 # define strong_alias(name, aliasname) _strong_alias(name, aliasname)
 101 # define _strong_alias(name, aliasname) \
 102   extern __typeof (name) aliasname __attribute__ ((alias (#name)));
 103
 104 /* This comes between the return type and function name in
 105    a function definition to make that definition weak.  */
 106 # define weak_function __attribute__ ((weak))
 107 # define weak_const_function __attribute__ ((weak, __const__))
 108
 109 # ifdef HAVE_WEAK_SYMBOLS
 110
 111 /* Define ALIASNAME as a weak alias for NAME.
 112    If weak aliases are not available, this defines a strong alias.  */
 113 #  define weak_alias(name, aliasname) _weak_alias (name, aliasname)
 114 #  define _weak_alias(name, aliasname) \
 115   extern __typeof (name) aliasname __attribute__ ((weak, alias (#name)));
 116
 117 /* Same as WEAK_ALIAS, but mark symbol as hidden.  */
 118 #  define weak_hidden_alias(name, aliasname) \
 119   _weak_hidden_alias (name, aliasname)
 120 #  define _weak_hidden_alias(name, aliasname) \
 121   extern __typeof (name) aliasname \
 122     __attribute__ ((weak, alias (#name), __visibility__ ("hidden")));
 123
 124 /* Declare SYMBOL as weak undefined symbol (resolved to 0 if not defined).  */
 125 #  define weak_extern(symbol) _weak_extern (weak symbol)
 126 #  define _weak_extern(expr) _Pragma (#expr)
 127
 128 # else
 129
 130 #  define weak_alias(name, aliasname) strong_alias(name, aliasname)
 131 #  define weak_hidden_alias(name, aliasname) strong_alias(name, aliasname)
 132 #  define weak_extern(symbol) /* Nothing. */
 133
 134 # endif
 135
 136 #else /* __ASSEMBLER__ */
 137
 138 # ifdef HAVE_ASM_SET_DIRECTIVE
 139 #  ifdef HAVE_ASM_GLOBAL_DOT_NAME
 140 #   define strong_alias(original, alias)                                \
 141   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias) ASM_LINE_SEP               \
 142   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original) ASM_LINE_SEP      \
 143   ASM_GLOBAL_DIRECTIVE C_SYMBOL_DOT_NAME (alias) ASM_LINE_SEP           \
 144   .set C_SYMBOL_DOT_NAME (alias),C_SYMBOL_DOT_NAME (original)
 145 #   define strong_data_alias(original, alias)                           \
 146   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias) ASM_LINE_SEP               \
 147   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original)
 148 #  else
 149 #   define strong_alias(original, alias)                                \
 150   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias) ASM_LINE_SEP               \
 151   .set C_SYMBOL_NAME (alias),C_SYMBOL_NAME (original)
 152 #   define strong_data_alias(original, alias) strong_alias(original, alias)
 153 #  endif
 154 # else
 155 #  ifdef HAVE_ASM_GLOBAL_DOT_NAME
 156 #   define strong_alias(original, alias)                                \
 157   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias) ASM_LINE_SEP               \
 158   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original) ASM_LINE_SEP         \
 159   ASM_GLOBAL_DIRECTIVE C_SYMBOL_DOT_NAME (alias) ASM_LINE_SEP           \
 160   C_SYMBOL_DOT_NAME (alias) = C_SYMBOL_DOT_NAME (original)
 161 #   define strong_data_alias(original, alias)                           \
 162   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias) ASM_LINE_SEP               \
 163   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
 164 #  else
 165 #   define strong_alias(original, alias)                                \
 166   ASM_GLOBAL_DIRECTIVE C_SYMBOL_NAME (alias) ASM_LINE_SEP               \
 167   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
 168 #   define strong_data_alias(original, alias) strong_alias(original, alias)
 169 #  endif
 170 # endif
 171
 172 # ifdef HAVE_WEAK_SYMBOLS
 173 #  ifdef HAVE_ASM_WEAKEXT_DIRECTIVE
 174 #   ifdef HAVE_ASM_GLOBAL_DOT_NAME
 175 #    define weak_alias(original, alias)                                 \
 176   .weakext C_SYMBOL_NAME (alias), C_SYMBOL_NAME (original) ASM_LINE_SEP \
 177   .weakext C_SYMBOL_DOT_NAME (alias), C_SYMBOL_DOT_NAME (original)
 178 #   else
 179 #    define weak_alias(original, alias)                                 \
 180   .weakext C_SYMBOL_NAME (alias), C_SYMBOL_NAME (original)
 181 #   endif
 182 #   define weak_extern(symbol)                                          \
 183   .weakext C_SYMBOL_NAME (symbol)
 184
 185 #  else /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
 186
 187 #   ifdef HAVE_ASM_GLOBAL_DOT_NAME
 188 #    define weak_alias(original, alias)                                 \
 189   .weak C_SYMBOL_NAME (alias) ASM_LINE_SEP                              \
 190   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original) ASM_LINE_SEP         \
 191   .weak C_SYMBOL_DOT_NAME (alias) ASM_LINE_SEP                          \
 192   C_SYMBOL_DOT_NAME (alias) = C_SYMBOL_DOT_NAME (original)
 193 #   else
 194 #    define weak_alias(original, alias)                                 \
 195   .weak C_SYMBOL_NAME (alias) ASM_LINE_SEP                              \
 196   C_SYMBOL_NAME (alias) = C_SYMBOL_NAME (original)
 197 #   endif
 198
 199 #   define weak_extern(symbol)                                          \
 200   .weak C_SYMBOL_NAME (symbol)
 201
 202 #  endif /* ! HAVE_ASM_WEAKEXT_DIRECTIVE */
 203
 204 # else /* ! HAVE_WEAK_SYMBOLS */
 205
 206 #  define weak_alias(original, alias) strong_alias(original, alias)
 207 #  define weak_extern(symbol) /* Nothing */
 208 # endif /* ! HAVE_WEAK_SYMBOLS */
 209
 210 #endif /* __ASSEMBLER__ */
 211
 212 /* On some platforms we can make internal function calls (i.e., calls of
 213    functions not exported) a bit faster by using a different calling
 214    convention.  */
 215 #ifndef internal_function
 216 # define internal_function      /* empty */
 217 #endif
 218
 219 /* Determine the return address.  */
 220 #define RETURN_ADDRESS(nr) \
 221   __builtin_extract_return_addr (__builtin_return_address (nr))
 222
 223 /* When a reference to SYMBOL is encountered, the linker will emit a
 224    warning message MSG.  */
 225 #ifdef HAVE_ELF
 226
 227 /* We want the .gnu.warning.SYMBOL section to be unallocated.  */
 228 # ifdef HAVE_ASM_PREVIOUS_DIRECTIVE
 229 #  define __make_section_unallocated(section_string)    \
 230   asm (".section " section_string "\n\t.previous");
 231 # elif defined HAVE_ASM_POPSECTION_DIRECTIVE
 232 #  define __make_section_unallocated(section_string)    \
 233   asm (".pushsection " section_string "\n\t.popsection");
 234 # else
 235 #  define __make_section_unallocated(section_string)
 236 # endif
 237
 238 /* Tacking on "\n\t#" to the section name makes gcc put it's bogus
 239    section attributes on what looks like a comment to the assembler.  */
 240 # ifdef HAVE_SECTION_QUOTES
 241 #  define __sec_comment "\"\n\t#\""
 242 # else
 243 #  define __sec_comment "\n\t#"
 244 # endif
 245 # define link_warning(symbol, msg) \
 246   __make_section_unallocated (".gnu.warning." #symbol) \
 247   static const char __evoke_link_warning_##symbol[]     \
 248     __attribute__ ((used, section (".gnu.warning." #symbol __sec_comment))) \
 249     = msg;
 250 # define libc_freeres_ptr(decl) \
 251   __make_section_unallocated ("__libc_freeres_ptrs, \"aw\", %nobits") \
 252   decl __attribute__ ((section ("__libc_freeres_ptrs" __sec_comment)))
 253 # define __libc_freeres_fn_section \
 254   __attribute__ ((section ("__libc_freeres_fn")))
 255 #else /* Not ELF: a.out */
 256 # ifdef HAVE_XCOFF
 257 /* XCOFF does not support .stabs.
 258    The native aix linker will remove the .stab and .stabstr sections
 259    The gnu linker will have a fatal error if there is a relocation for
 260    symbol in the .stab section.  Silently disable this macro.  */
 261 #  define link_warning(symbol, msg)
 262 # else
 263 #  define link_warning(symbol, msg)             \
 264      asm (".stabs \"" msg "\",30,0,0,0\n\t"     \
 265           ".stabs \"" __SYMBOL_PREFIX #symbol "\",1,0,0,0\n");
 266 # endif /* XCOFF */
 267 # define libc_freeres_ptr(decl) decl
 268 # define __libc_freeres_fn_section
 269 #endif
 270 #define libc_freeres_fn(name)   \
 271   static void name (void) __attribute_used__ __libc_freeres_fn_section; \
 272   text_set_element (__libc_subfreeres, name);                           \
 273   static void name (void)
 274
 275 /* A canned warning for sysdeps/stub functions.  */
 276 #define stub_warning(name) \
 277   __make_section_unallocated (".gnu.glibc-stub." #name) \
 278   link_warning (name, \
 279                 "warning: " #name " is not implemented and will always fail")
 280
 281 /* Warning for linking functions calling dlopen into static binaries.  */
 282 #ifdef SHARED
 283 #define static_link_warning(name)
 284 #else
 285 #define static_link_warning(name) static_link_warning1(name)
 286 #define static_link_warning1(name) \
 287   link_warning(name, "Using '" #name "' in statically linked applications \
 288 requires at runtime the shared libraries from the glibc version used \
 289 for linking")
 290 #endif
 291
 292 /* Declare SYMBOL to be TYPE (`function' or `object') of SIZE bytes
 293    alias to ORIGINAL, when the assembler supports such declarations
 294    (such as in ELF).
 295    This is only necessary when defining something in assembly, or playing
 296    funny alias games where the size should be other than what the compiler
 297    thinks it is.  */
 298 #define declare_symbol_alias(symbol, original, type, size) \
 299   declare_symbol_alias_1 (symbol, original, type, size)
 300 #ifdef ASM_TYPE_DIRECTIVE_PREFIX
 301 # ifdef __ASSEMBLER__
 302 #  define declare_symbol_alias_1(symbol, original, type, size) \
 303     strong_alias (original, symbol); \
 304     .type C_SYMBOL_NAME (symbol), \
 305           declare_symbol_alias_1_paste (ASM_TYPE_DIRECTIVE_PREFIX, type); \
 306     .size C_SYMBOL_NAME (symbol), size
 307 #  define declare_symbol_alias_1_paste(a, b) \
 308   declare_symbol_alias_1_paste_1 (a,b)
 309 #  define declare_symbol_alias_1_paste_1(a,b)   a##b
 310 # else /* Not __ASSEMBLER__.  */
 311 #  define declare_symbol_alias_1(symbol, original, type, size) \
 312     asm (declare_symbol_alias_1_stringify (ASM_GLOBAL_DIRECTIVE) \
 313          " " __SYMBOL_PREFIX #symbol \
 314          "\n\t" declare_symbol_alias_1_alias (symbol, original) \
 315          "\n\t.type " __SYMBOL_PREFIX #symbol ", " \
 316          declare_symbol_alias_1_stringify (ASM_TYPE_DIRECTIVE_PREFIX) #type \
 317          "\n\t.size " __SYMBOL_PREFIX #symbol ", " #size);
 318 #  define declare_symbol_alias_1_stringify(x) \
 319   declare_symbol_alias_1_stringify_1 (x)
 320 #  define declare_symbol_alias_1_stringify_1(x) #x
 321 #  ifdef HAVE_ASM_SET_DIRECTIVE
 322 #   define declare_symbol_alias_1_alias(symbol, original) \
 323          ".set " __SYMBOL_PREFIX #symbol ", " __SYMBOL_PREFIX #original
 324 #  else
 325 #   define declare_symbol_alias_1_alias(symbol, original) \
 326          __SYMBOL_PREFIX #symbol " = " __SYMBOL_PREFIX #original
 327 #  endif /* HAVE_ASM_SET_DIRECTIVE */
 328 # endif /* __ASSEMBLER__ */
 329 #else
 330 # define declare_symbol_1(symbol, type, size) /* Nothing.  */
 331 #endif
 332
 333
 334 /*
 335 \f
 336 */
 337
 338 /* Symbol set support macros.  */
 339
 340 #ifdef HAVE_ELF
 341
 342 /* Make SYMBOL, which is in the text segment, an element of SET.  */
 343 # define text_set_element(set, symbol)  _elf_set_element(set, symbol)
 344 /* Make SYMBOL, which is in the data segment, an element of SET.  */
 345 # define data_set_element(set, symbol)  _elf_set_element(set, symbol)
 346 /* Make SYMBOL, which is in the bss segment, an element of SET.  */
 347 # define bss_set_element(set, symbol)   _elf_set_element(set, symbol)
 348
 349 /* These are all done the same way in ELF.
 350    There is a new section created for each set.  */
 351 # ifdef SHARED
 352 /* When building a shared library, make the set section writable,
 353    because it will need to be relocated at run time anyway.  */
 354 #  define _elf_set_element(set, symbol) \
 355   static const void *__elf_set_##set##_element_##symbol##__ \
 356     __attribute__ ((used, section (#set))) = &(symbol)
 357 # else
 358 #  define _elf_set_element(set, symbol) \
 359   static const void *const __elf_set_##set##_element_##symbol##__ \
 360     __attribute__ ((used, section (#set))) = &(symbol)
 361 # endif
 362
 363 /* Define SET as a symbol set.  This may be required (it is in a.out) to
 364    be able to use the set's contents.  */
 365 # define symbol_set_define(set) symbol_set_declare(set)
 366
 367 /* Declare SET for use in this module, if defined in another module.
 368    In a shared library, this is always local to that shared object.
 369    For static linking, the set might be wholly absent and so we use
 370    weak references.  */
 371 # define symbol_set_declare(set) \
 372   extern char const __start_##set[] __symbol_set_attribute; \
 373   extern char const __stop_##set[] __symbol_set_attribute;
 374 # ifdef SHARED
 375 #  define __symbol_set_attribute attribute_hidden
 376 # else
 377 #  define __symbol_set_attribute __attribute__ ((weak))
 378 # endif
 379
 380 /* Return a pointer (void *const *) to the first element of SET.  */
 381 # define symbol_set_first_element(set)  ((void *const *) (&__start_##set))
 382
 383 /* Return true iff PTR (a void *const *) has been incremented
 384    past the last element in SET.  */
 385 # define symbol_set_end_p(set, ptr) ((ptr) >= (void *const *) &__stop_##set)
 386
 387 #else   /* Not ELF: a.out.  */
 388
 389 # ifdef HAVE_XCOFF
 390 /* XCOFF does not support .stabs.
 391    The native aix linker will remove the .stab and .stabstr sections
 392    The gnu linker will have a fatal error if there is a relocation for
 393    symbol in the .stab section.  Silently disable these macros.  */
 394 #  define text_set_element(set, symbol)
 395 #  define data_set_element(set, symbol)
 396 #  define bss_set_element(set, symbol)
 397 # else
 398 #  define text_set_element(set, symbol) \
 399     asm (".stabs \"" __SYMBOL_PREFIX #set "\",23,0,0," __SYMBOL_PREFIX #symbol)
 400 #  define data_set_element(set, symbol) \
 401     asm (".stabs \"" __SYMBOL_PREFIX #set "\",25,0,0," __SYMBOL_PREFIX #symbol)
 402 #  define bss_set_element(set, symbol)  ?error Must use initialized data.
 403 # endif /* XCOFF */
 404 # define symbol_set_define(set) void *const (set)[1];
 405 # define symbol_set_declare(set)        extern void *const (set)[1];
 406
 407 # define symbol_set_first_element(set)  &(set)[1]
 408 # define symbol_set_end_p(set, ptr)     (*(ptr) == 0)
 409
 410 #endif  /* ELF.  */
 411
 412 #if DO_VERSIONING
 413 # define symbol_version(real, name, version) \
 414      _symbol_version(real, name, version)
 415 # define default_symbol_version(real, name, version) \
 416      _default_symbol_version(real, name, version)
 417 # ifdef __ASSEMBLER__
 418 #  ifdef HAVE_ASM_GLOBAL_DOT_NAME
 419 #   define _symbol_version(real, name, version) \
 420      .symver real, name##@##version ASM_LINE_SEP                        \
 421      .symver C_SYMBOL_DOT_NAME(real), C_SYMBOL_DOT_NAME(name##@##version)
 422 #   define _default_symbol_version(real, name, version) \
 423      .symver real, name##@##@##version ASM_LINE_SEP                     \
 424      .symver C_SYMBOL_DOT_NAME(real), C_SYMBOL_DOT_NAME(name##@##@##version)
 425 #  else
 426 #   define _symbol_version(real, name, version) \
 427      .symver real, name##@##version
 428 #   define _default_symbol_version(real, name, version) \
 429      .symver real, name##@##@##version
 430 #  endif
 431 # else
 432 #  ifdef HAVE_ASM_GLOBAL_DOT_NAME
 433 #   define _symbol_version(real, name, version) \
 434      __asm__ (".symver " #real "," #name "@" #version "\n\t"    \
 435               ".symver ." #real ",." #name "@" #version)
 436 #   define _default_symbol_version(real, name, version) \
 437      __asm__ (".symver " #real "," #name "@@" #version "\n\t"   \
 438               ".symver ." #real ",." #name "@@" #version)
 439 #  else
 440 #   define _symbol_version(real, name, version) \
 441      __asm__ (".symver " #real "," #name "@" #version)
 442 #   define _default_symbol_version(real, name, version) \
 443      __asm__ (".symver " #real "," #name "@@" #version)
 444 #  endif
 445 # endif
 446 #else
 447 # define symbol_version(real, name, version)
 448 # define default_symbol_version(real, name, version) \
 449   strong_alias(real, name)
 450 #endif
 451
 452 #if defined SHARED || defined LIBC_NONSHARED
 453 # define attribute_hidden __attribute__ ((visibility ("hidden")))
 454 #else
 455 # define attribute_hidden
 456 #endif
 457
 458 #define attribute_tls_model_ie __attribute__ ((tls_model ("initial-exec")))
 459
 460 #define attribute_relro __attribute__ ((section (".data.rel.ro")))
 461
 462 /* Handling on non-exported internal names.  We have to do this only
 463    for shared code.  */
 464 #ifdef SHARED
 465 # define INTUSE(name) name##_internal
 466 # define INTDEF(name) strong_alias (name, name##_internal)
 467 # define INTVARDEF(name) \
 468   _INTVARDEF (name, name##_internal)
 469 # define _INTVARDEF(name, aliasname) \
 470   extern __typeof (name) aliasname __attribute__ ((alias (#name), \
 471                                                    visibility ("hidden")));
 472 # define INTDEF2(name, newname) strong_alias (name, newname##_internal)
 473 # define INTVARDEF2(name, newname) _INTVARDEF (name, newname##_internal)
 474 #else
 475 # define INTUSE(name) name
 476 # define INTDEF(name)
 477 # define INTVARDEF(name)
 478 # define INTDEF2(name, newname)
 479 # define INTVARDEF2(name, newname)
 480 #endif
 481
 482 /* The following macros are used for PLT bypassing within libc.so
 483    (and if needed other libraries similarly).
 484    First of all, you need to have the function prototyped somewhere,
 485    say in foo/foo.h:
 486
 487    int foo (int __bar);
 488
 489    If calls to foo within libc.so should always go to foo defined in libc.so,
 490    then in include/foo.h you add:
 491
 492    libc_hidden_proto (foo)
 493
 494    line and after the foo function definition:
 495
 496    int foo (int __bar)
 497    {
 498      return __bar;
 499    }
 500    libc_hidden_def (foo)
 501
 502    or
 503
 504    int foo (int __bar)
 505    {
 506      return __bar;
 507    }
 508    libc_hidden_weak (foo)
 509
 510    Similarly for global data.  If references to foo within libc.so should
 511    always go to foo defined in libc.so, then in include/foo.h you add:
 512
 513    libc_hidden_proto (foo)
 514
 515    line and after foo's definition:
 516
 517    int foo = INITIAL_FOO_VALUE;
 518    libc_hidden_data_def (foo)
 519
 520    or
 521
 522    int foo = INITIAL_FOO_VALUE;
 523    libc_hidden_data_weak (foo)
 524
 525    If foo is normally just an alias (strong or weak) to some other function,
 526    you should use the normal strong_alias first, then add libc_hidden_def
 527    or libc_hidden_weak:
 528
 529    int baz (int __bar)
 530    {
 531      return __bar;
 532    }
 533    strong_alias (baz, foo)
 534    libc_hidden_weak (foo)
 535
 536    If the function should be internal to multiple objects, say ld.so and
 537    libc.so, the best way is to use:
 538
 539    #if !defined NOT_IN_libc || defined IS_IN_rtld
 540    hidden_proto (foo)
 541    #endif
 542
 543    in include/foo.h and the normal macros at all function definitions
 544    depending on what DSO they belong to.
 545
 546    If versioned_symbol macro is used to define foo,
 547    libc_hidden_ver macro should be used, as in:
 548
 549    int __real_foo (int __bar)
 550    {
 551      return __bar;
 552    }
 553    versioned_symbol (libc, __real_foo, foo, GLIBC_2_1);
 554    libc_hidden_ver (__real_foo, foo)  */
 555
 556 #if defined SHARED && defined DO_VERSIONING && !defined NO_HIDDEN
 557 # ifndef __ASSEMBLER__
 558 #  define __hidden_proto_hiddenattr(attrs...) \
 559   __attribute__ ((visibility ("hidden"), ##attrs))
 560 #  define hidden_proto(name, attrs...) \
 561   __hidden_proto (name, __GI_##name, ##attrs)
 562 #  define __hidden_proto(name, internal, attrs...) \
 563   extern __typeof (name) name __asm__ (__hidden_asmname (#internal)) \
 564   __hidden_proto_hiddenattr (attrs);
 565 #  define __hidden_asmname(name) \
 566   __hidden_asmname1 (__USER_LABEL_PREFIX__, name)
 567 #  define __hidden_asmname1(prefix, name) __hidden_asmname2(prefix, name)
 568 #  define __hidden_asmname2(prefix, name) #prefix name
 569 #  define __hidden_ver1(local, internal, name) \
 570   extern __typeof (name) __EI_##name __asm__(__hidden_asmname (#internal)); \
 571   extern __typeof (name) __EI_##name \
 572         __attribute__((alias (__hidden_asmname (#local))))
 573 #  define hidden_ver(local, name)       __hidden_ver1(local, __GI_##name, name);
 574 #  define hidden_data_ver(local, name)  hidden_ver(local, name)
 575 #  define hidden_def(name)              __hidden_ver1(__GI_##name, name, name);
 576 #  define hidden_data_def(name)         hidden_def(name)
 577 #  define hidden_weak(name) \
 578         __hidden_ver1(__GI_##name, name, name) __attribute__((weak));
 579 #  define hidden_data_weak(name)        hidden_weak(name)
 580 #  define hidden_nolink(name, lib, version) \
 581   __hidden_nolink1 (__GI_##name, __EI_##name, name, VERSION_##lib##_##version)
 582 #  define __hidden_nolink1(local, internal, name, version) \
 583   __hidden_nolink2 (local, internal, name, version)
 584 #  define __hidden_nolink2(local, internal, name, version) \
 585   extern __typeof (name) internal __attribute__ ((alias (#local))); \
 586   __hidden_nolink3 (local, internal, #name "@" #version)
 587 #  define __hidden_nolink3(local, internal, vername) \
 588   __asm__ (".symver " #internal ", " vername);
 589 # else
 590 /* For assembly, we need to do the opposite of what we do in C:
 591    in assembly gcc __REDIRECT stuff is not in place, so functions
 592    are defined by its normal name and we need to create the
 593    __GI_* alias to it, in C __REDIRECT causes the function definition
 594    to use __GI_* name and we need to add alias to the real name.
 595    There is no reason to use hidden_weak over hidden_def in assembly,
 596    but we provide it for consistency with the C usage.
 597    hidden_proto doesn't make sense for assembly but the equivalent
 598    is to call via the HIDDEN_JUMPTARGET macro instead of JUMPTARGET.  */
 599 #  define hidden_def(name)      strong_alias (name, __GI_##name)
 600 #  define hidden_weak(name)     hidden_def (name)
 601 #  define hidden_ver(local, name) strong_alias (local, __GI_##name)
 602 #  define hidden_data_def(name) strong_data_alias (name, __GI_##name)
 603 #  define hidden_data_weak(name)        hidden_data_def (name)
 604 #  define hidden_data_ver(local, name) strong_data_alias (local, __GI_##name)
 605 #  ifdef HAVE_ASM_GLOBAL_DOT_NAME
 606 #   define HIDDEN_JUMPTARGET(name) .__GI_##name
 607 #  else
 608 #   define HIDDEN_JUMPTARGET(name) __GI_##name
 609 #  endif
 610 # endif
 611 #else
 612 # ifndef __ASSEMBLER__
 613 #  define hidden_proto(name, attrs...)
 614 # else
 615 #  define HIDDEN_JUMPTARGET(name) JUMPTARGET(name)
 616 # endif /* Not  __ASSEMBLER__ */
 617 # define hidden_weak(name)
 618 # define hidden_def(name)
 619 # define hidden_ver(local, name)
 620 # define hidden_data_weak(name)
 621 # define hidden_data_def(name)
 622 # define hidden_data_ver(local, name)
 623 #endif
 624
 625 #if !defined NOT_IN_libc
 626 # define libc_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 627 # define libc_hidden_def(name) hidden_def (name)
 628 # define libc_hidden_weak(name) hidden_weak (name)
 629 # define libc_hidden_nolink(name, version) hidden_nolink (name, libc, version)
 630 # define libc_hidden_ver(local, name) hidden_ver (local, name)
 631 # define libc_hidden_data_def(name) hidden_data_def (name)
 632 # define libc_hidden_data_weak(name) hidden_data_weak (name)
 633 # define libc_hidden_data_ver(local, name) hidden_data_ver (local, name)
 634 #else
 635 # define libc_hidden_proto(name, attrs...)
 636 # define libc_hidden_def(name)
 637 # define libc_hidden_weak(name)
 638 # define libc_hidden_ver(local, name)
 639 # define libc_hidden_data_def(name)
 640 # define libc_hidden_data_weak(name)
 641 # define libc_hidden_data_ver(local, name)
 642 #endif
 643
 644 #if defined NOT_IN_libc && defined IS_IN_rtld
 645 # define rtld_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 646 # define rtld_hidden_def(name) hidden_def (name)
 647 # define rtld_hidden_weak(name) hidden_weak (name)
 648 # define rtld_hidden_ver(local, name) hidden_ver (local, name)
 649 # define rtld_hidden_data_def(name) hidden_data_def (name)
 650 # define rtld_hidden_data_weak(name) hidden_data_weak (name)
 651 # define rtld_hidden_data_ver(local, name) hidden_data_ver (local, name)
 652 #else
 653 # define rtld_hidden_proto(name, attrs...)
 654 # define rtld_hidden_def(name)
 655 # define rtld_hidden_weak(name)
 656 # define rtld_hidden_ver(local, name)
 657 # define rtld_hidden_data_def(name)
 658 # define rtld_hidden_data_weak(name)
 659 # define rtld_hidden_data_ver(local, name)
 660 #endif
 661
 662 #if defined NOT_IN_libc && defined IS_IN_libm
 663 # define libm_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 664 # define libm_hidden_def(name) hidden_def (name)
 665 # define libm_hidden_weak(name) hidden_weak (name)
 666 # define libm_hidden_ver(local, name) hidden_ver (local, name)
 667 # define libm_hidden_data_def(name) hidden_data_def (name)
 668 # define libm_hidden_data_weak(name) hidden_data_weak (name)
 669 # define libm_hidden_data_ver(local, name) hidden_data_ver (local, name)
 670 #else
 671 # define libm_hidden_proto(name, attrs...)
 672 # define libm_hidden_def(name)
 673 # define libm_hidden_weak(name)
 674 # define libm_hidden_ver(local, name)
 675 # define libm_hidden_data_def(name)
 676 # define libm_hidden_data_weak(name)
 677 # define libm_hidden_data_ver(local, name)
 678 #endif
 679
 680 #if defined NOT_IN_libc && defined IS_IN_libresolv
 681 # define libresolv_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 682 # define libresolv_hidden_def(name) hidden_def (name)
 683 # define libresolv_hidden_weak(name) hidden_weak (name)
 684 # define libresolv_hidden_ver(local, name) hidden_ver (local, name)
 685 # define libresolv_hidden_data_def(name) hidden_data_def (name)
 686 # define libresolv_hidden_data_weak(name) hidden_data_weak (name)
 687 # define libresolv_hidden_data_ver(local, name) hidden_data_ver (local, name)
 688 #else
 689 # define libresolv_hidden_proto(name, attrs...)
 690 # define libresolv_hidden_def(name)
 691 # define libresolv_hidden_weak(name)
 692 # define libresolv_hidden_ver(local, name)
 693 # define libresolv_hidden_data_def(name)
 694 # define libresolv_hidden_data_weak(name)
 695 # define libresolv_hidden_data_ver(local, name)
 696 #endif
 697
 698 #if defined NOT_IN_libc && defined IS_IN_librt
 699 # define librt_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 700 # define librt_hidden_def(name) hidden_def (name)
 701 # define librt_hidden_weak(name) hidden_weak (name)
 702 # define librt_hidden_ver(local, name) hidden_ver (local, name)
 703 # define librt_hidden_data_def(name) hidden_data_def (name)
 704 # define librt_hidden_data_weak(name) hidden_data_weak (name)
 705 # define librt_hidden_data_ver(local, name) hidden_data_ver (local, name)
 706 #else
 707 # define librt_hidden_proto(name, attrs...)
 708 # define librt_hidden_def(name)
 709 # define librt_hidden_weak(name)
 710 # define librt_hidden_ver(local, name)
 711 # define librt_hidden_data_def(name)
 712 # define librt_hidden_data_weak(name)
 713 # define librt_hidden_data_ver(local, name)
 714 #endif
 715
 716 #if defined NOT_IN_libc && defined IS_IN_libdl
 717 # define libdl_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 718 # define libdl_hidden_def(name) hidden_def (name)
 719 # define libdl_hidden_weak(name) hidden_weak (name)
 720 # define libdl_hidden_ver(local, name) hidden_ver (local, name)
 721 # define libdl_hidden_data_def(name) hidden_data_def (name)
 722 # define libdl_hidden_data_weak(name) hidden_data_weak (name)
 723 # define libdl_hidden_data_ver(local, name) hidden_data_ver (local, name)
 724 #else
 725 # define libdl_hidden_proto(name, attrs...)
 726 # define libdl_hidden_def(name)
 727 # define libdl_hidden_weak(name)
 728 # define libdl_hidden_ver(local, name)
 729 # define libdl_hidden_data_def(name)
 730 # define libdl_hidden_data_weak(name)
 731 # define libdl_hidden_data_ver(local, name)
 732 #endif
 733
 734 #if defined NOT_IN_libc && defined IS_IN_libnss_files
 735 # define libnss_files_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 736 # define libnss_files_hidden_def(name) hidden_def (name)
 737 # define libnss_files_hidden_weak(name) hidden_weak (name)
 738 # define libnss_files_hidden_ver(local, name) hidden_ver (local, name)
 739 # define libnss_files_hidden_data_def(name) hidden_data_def (name)
 740 # define libnss_files_hidden_data_weak(name) hidden_data_weak (name)
 741 # define libnss_files_hidden_data_ver(local, name) hidden_data_ver(local, name)
 742 #else
 743 # define libnss_files_hidden_proto(name, attrs...)
 744 # define libnss_files_hidden_def(name)
 745 # define libnss_files_hidden_weak(name)
 746 # define libnss_files_hidden_ver(local, name)
 747 # define libnss_files_hidden_data_def(name)
 748 # define libnss_files_hidden_data_weak(name)
 749 # define libnss_files_hidden_data_ver(local, name)
 750 #endif
 751
 752 #if defined NOT_IN_libc && defined IS_IN_libnsl
 753 # define libnsl_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 754 # define libnsl_hidden_def(name) hidden_def (name)
 755 # define libnsl_hidden_weak(name) hidden_weak (name)
 756 # define libnsl_hidden_ver(local, name) hidden_ver (local, name)
 757 # define libnsl_hidden_data_def(name) hidden_data_def (name)
 758 # define libnsl_hidden_data_weak(name) hidden_data_weak (name)
 759 # define libnsl_hidden_data_ver(local, name) hidden_data_ver (local, name)
 760 #else
 761 # define libnsl_hidden_proto(name, attrs...)
 762 # define libnsl_hidden_def(name)
 763 # define libnsl_hidden_weak(name)
 764 # define libnsl_hidden_ver(local, name)
 765 # define libnsl_hidden_data_def(name)
 766 # define libnsl_hidden_data_weak(name)
 767 # define libnsl_hidden_data_ver(local, name)
 768 #endif
 769
 770 #if defined NOT_IN_libc && defined IS_IN_libnss_nisplus
 771 # define libnss_nisplus_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 772 # define libnss_nisplus_hidden_def(name) hidden_def (name)
 773 # define libnss_nisplus_hidden_weak(name) hidden_weak (name)
 774 # define libnss_nisplus_hidden_ver(local, name) hidden_ver (local, name)
 775 # define libnss_nisplus_hidden_data_def(name) hidden_data_def (name)
 776 # define libnss_nisplus_hidden_data_weak(name) hidden_data_weak (name)
 777 # define libnss_nisplus_hidden_data_ver(local, name) hidden_data_ver (local, name)
 778 #else
 779 # define libnss_nisplus_hidden_proto(name, attrs...)
 780 # define libnss_nisplus_hidden_def(name)
 781 # define libnss_nisplus_hidden_weak(name)
 782 # define libnss_nisplus_hidden_ver(local, name)
 783 # define libnss_nisplus_hidden_data_def(name)
 784 # define libnss_nisplus_hidden_data_weak(name)
 785 # define libnss_nisplus_hidden_data_ver(local, name)
 786 #endif
 787
 788 #define libc_hidden_builtin_proto(name, attrs...) libc_hidden_proto (name, ##attrs)
 789 #define libc_hidden_builtin_def(name) libc_hidden_def (name)
 790 #define libc_hidden_builtin_weak(name) libc_hidden_weak (name)
 791 #define libc_hidden_builtin_ver(local, name) libc_hidden_ver (local, name)
 792 #ifdef __ASSEMBLER__
 793 # define HIDDEN_BUILTIN_JUMPTARGET(name) HIDDEN_JUMPTARGET(name)
 794 #endif
 795
 796 #if defined NOT_IN_libc && defined IS_IN_libutil
 797 # define libutil_hidden_proto(name, attrs...) hidden_proto (name, ##attrs)
 798 # define libutil_hidden_def(name) hidden_def (name)
 799 # define libutil_hidden_weak(name) hidden_weak (name)
 800 # define libutil_hidden_ver(local, name) hidden_ver (local, name)
 801 # define libutil_hidden_data_def(name) hidden_data_def (name)
 802 # define libutil_hidden_data_weak(name) hidden_data_weak (name)
 803 # define libutil_hidden_data_ver(local, name) hidden_data_ver (local, name)
 804 #else
 805 # define libutil_hidden_proto(name, attrs...)
 806 # define libutil_hidden_def(name)
 807 # define libutil_hidden_weak(name)
 808 # define libutil_hidden_ver(local, name)
 809 # define libutil_hidden_data_def(name)
 810 # define libutil_hidden_data_weak(name)
 811 # define libutil_hidden_data_ver(local, name)
 812 #endif
 813
 814 /* Get some dirty hacks.  */
 815 #include <symbol-hacks.h>
 816
 817 /* Move compatibility symbols out of the way by placing them all in a
 818    special section.  */
 819 #ifndef __ASSEMBLER__
 820 # define attribute_compat_text_section \
 821     __attribute__ ((section (".text.compat")))
 822 # define attribute_compat_data_section \
 823     __attribute__ ((section (".data.compat")))
 824 #else
 825 # define compat_text_section .section ".text.compat", "ax";
 826 # define compat_data_section .section ".data.compat", "aw";
 827 #endif
 828
 829 /* Marker used for indirection function symbols.  */
 830 #define libc_ifunc(name, expr)                                          \
 831   extern void *name##_ifunc (void) __asm__ (#name);                     \
 832   void *name##_ifunc (void)                                             \
 833   {                                                                     \
 834     INIT_ARCH ();                                                       \
 835     __typeof (name) *res = expr;                                        \
 836     return res;                                                         \
 837   }                                                                     \
 838   __asm__ (".type " #name ", %gnu_indirect_function");
 839
 840 /* The body of the function is supposed to use __get_cpu_features
 841    which will, if necessary, initialize the data first.  */
 842 #define libm_ifunc(name, expr)                                          \
 843   extern void *name##_ifunc (void) __asm__ (#name);                     \
 844   void *name##_ifunc (void)                                             \
 845   {                                                                     \
 846     __typeof (name) *res = expr;                                        \
 847     return res;                                                         \
 848   }                                                                     \
 849   __asm__ (".type " #name ", %gnu_indirect_function");
 850
 851 #ifdef HAVE_ASM_SET_DIRECTIVE
 852 # define libc_ifunc_hidden_def1(local, name)                            \
 853     __asm__ (declare_symbol_alias_1_stringify (ASM_GLOBAL_DIRECTIVE)    \
 854              " " #local "\n\t"                                          \
 855              ".hidden " #local "\n\t"                                   \
 856              ".set " #local ", " #name);
 857 #else
 858 # define libc_ifunc_hidden_def1(local, name)                            \
 859     __asm__ (declare_symbol_alias_1_stringify (ASM_GLOBAL_DIRECTIVE)    \
 860              " " #local "\n\t"                                          \
 861              ".hidden " #local "\n\t"                                   \
 862              #local " = " #name);
 863 #endif
 864
 865 #define libc_ifunc_hidden_def(name) \
 866   libc_ifunc_hidden_def1 (__GI_##name, name)
 867
 868 #endif /* libc-symbols.h */