sys/sys/cdefs.h

   1 /*
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Berkeley Software Design, Inc.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)cdefs.h     8.8 (Berkeley) 1/9/95
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _SYS_CDEFS_H_
  41 #define _SYS_CDEFS_H_
  42
  43 #if defined(__cplusplus)
  44 #define __BEGIN_DECLS   extern "C" {
  45 #define __END_DECLS     }
  46 #else
  47 #define __BEGIN_DECLS
  48 #define __END_DECLS
  49 #endif
  50
  51 /*
  52  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
  53  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
  54  * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
  55  * mode -- there must be no spaces between its arguments, and for nested
  56  * __CONCAT's, all the __CONCAT's must be at the left.  __CONCAT can also
  57  * concatenate double-quoted strings produced by the __STRING macro, but
  58  * this only works with ANSI C.
  59  *
  60  * __XSTRING is like __STRING, but it expands any macros in its argument
  61  * first.  It is only available with ANSI C.
  62  */
  63 #if defined(__STDC__) || defined(__cplusplus)
  64 #define __P(protos)     protos          /* full-blown ANSI C */
  65 #define __CONCAT1(x,y)  x ## y
  66 #define __CONCAT(x,y)   __CONCAT1(x,y)
  67 #define __STRING(x)     #x              /* stringify without expanding x */
  68 #define __XSTRING(x)    __STRING(x)     /* expand x, then stringify */
  69
  70 #define __const         const           /* define reserved names to standard */
  71 #define __signed        signed
  72 #define __volatile      volatile
  73 #if defined(__cplusplus)
  74 #define __inline        inline          /* convert to C++ keyword */
  75 #else
  76 #ifndef __GNUC__
  77 #define __inline                        /* delete GCC keyword */
  78 #endif /* !__GNUC__ */
  79 #endif /* !__cplusplus */
  80
  81 #else   /* !(__STDC__ || __cplusplus) */
  82 #define __P(protos)     ()              /* traditional C preprocessor */
  83 #define __CONCAT(x,y)   x/**/y
  84 #define __STRING(x)     "x"
  85
  86 #ifndef __GNUC__
  87 #define __const                         /* delete pseudo-ANSI C keywords */
  88 #define __inline
  89 #define __signed
  90 #define __volatile
  91 /*
  92  * In non-ANSI C environments, new programs will want ANSI-only C keywords
  93  * deleted from the program and old programs will want them left alone.
  94  * When using a compiler other than gcc, programs using the ANSI C keywords
  95  * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
  96  * When using "gcc -traditional", we assume that this is the intent; if
  97  * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
  98  */
  99 #ifndef NO_ANSI_KEYWORDS
 100 #define const                           /* delete ANSI C keywords */
 101 #define inline
 102 #define signed
 103 #define volatile
 104 #endif  /* !NO_ANSI_KEYWORDS */
 105 #endif  /* !__GNUC__ */
 106 #endif  /* !(__STDC__ || __cplusplus) */
 107
 108 /*
 109  * Compiler-dependent macros to help declare dead (non-returning) and
 110  * pure (no side effects) functions, and unused variables.  They are
 111  * null except for versions of gcc that are known to support the features
 112  * properly (old versions of gcc-2 supported the dead and pure features
 113  * in a different (wrong) way).
 114  */
 115 #if __GNUC__ < 2 || __GNUC__ == 2 && __GNUC_MINOR__ < 5
 116 #define __dead2
 117 #define __pure2
 118 #define __unused
 119 #endif
 120 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7
 121 #define __dead2         __attribute__((__noreturn__))
 122 #define __pure2         __attribute__((__const__))
 123 #define __unused
 124 #endif
 125 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ == 3
 126 #define __dead2         __attribute__((__noreturn__))
 127 #define __pure2         __attribute__((__const__))
 128 #define __unused        __attribute__((__unused__))
 129 #endif
 130
 131 /* XXX: should use `#if __STDC_VERSION__ < 199901'. */
 132 #if !(__GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3)
 133 #define __func__        NULL
 134 #endif
 135
 136 /*
 137  * Compiler-dependent macros to declare that functions take printf-like
 138  * or scanf-like arguments.  They are null except for versions of gcc
 139  * that are known to support the features properly (old versions of gcc-2
 140  * didn't permit keeping the keywords out of the application namespace).
 141  */
 142 #if __GNUC__ < 2 || __GNUC__ == 2 && __GNUC_MINOR__ < 7
 143 #define __printflike(fmtarg, firstvararg)
 144 #define __scanflike(fmtarg, firstvararg)
 145 #else
 146 #define __printflike(fmtarg, firstvararg) \
 147             __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
 148 #define __scanflike(fmtarg, firstvararg) \
 149             __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
 150 #endif
 151
 152 /* Compiler-dependent macros that rely on FreeBSD-specific extensions. */
 153 #if __FreeBSD_cc_version >= 300001
 154 #define __printf0like(fmtarg, firstvararg) \
 155             __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
 156 #else
 157 #define __printf0like(fmtarg, firstvararg)
 158 #endif
 159
 160 #ifdef __GNUC__
 161 #define __strong_reference(sym,aliassym)        \
 162         extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
 163 #ifdef __ELF__
 164 #ifdef __STDC__
 165 #define __weak_reference(sym,alias)     \
 166         __asm__(".weak " #alias);       \
 167         __asm__(".equ "  #alias ", " #sym)
 168 #define __warn_references(sym,msg)      \
 169         __asm__(".section .gnu.warning." #sym); \
 170         __asm__(".asciz \"" msg "\"");  \
 171         __asm__(".previous")
 172 #else
 173 #define __weak_reference(sym,alias)     \
 174         __asm__(".weak alias");         \
 175         __asm__(".equ alias, sym")
 176 #define __warn_references(sym,msg)      \
 177         __asm__(".section .gnu.warning.sym"); \
 178         __asm__(".asciz \"msg\"");      \
 179         __asm__(".previous")
 180 #endif  /* __STDC__ */
 181 #else   /* !__ELF__ */
 182 #ifdef __STDC__
 183 #define __weak_reference(sym,alias)     \
 184         __asm__(".stabs \"_" #alias "\",11,0,0,0");     \
 185         __asm__(".stabs \"_" #sym "\",1,0,0,0")
 186 #define __warn_references(sym,msg)      \
 187         __asm__(".stabs \"" msg "\",30,0,0,0");         \
 188         __asm__(".stabs \"_" #sym "\",1,0,0,0")
 189 #else
 190 #define __weak_reference(sym,alias)     \
 191         __asm__(".stabs \"_/**/alias\",11,0,0,0");      \
 192         __asm__(".stabs \"_/**/sym\",1,0,0,0")
 193 #define __warn_references(sym,msg)      \
 194         __asm__(".stabs msg,30,0,0,0");                 \
 195         __asm__(".stabs \"_/**/sym\",1,0,0,0")
 196 #endif  /* __STDC__ */
 197 #endif  /* __ELF__ */
 198 #endif  /* __GNUC__ */
 199
 200 #ifdef __GNUC__
 201 #ifdef __ELF__
 202 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
 203 #else
 204 #define __IDSTRING(name,string) __asm__(".data\n\t.asciz\t\"" string "\"\n\t.previous")
 205 #endif
 206 #else
 207 /*
 208  * This doesn't work in header files. But it may be better than nothing.
 209  * The alternative is: #define __IDSTRING(name,string)  [nothing]
 210  */
 211 #define __IDSTRING(name,string) static const char name[] __unused = string
 212 #endif
 213
 214 #ifndef __RCSID
 215 #define __RCSID(s)      __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
 216 #endif
 217
 218 /*
 219  * Embed the rcs id of a source file in the resulting library.  Note that in
 220  * more recent ELF binutils, we use .ident allowing the ID to be stripped.
 221  * Usage:
 222  *      __FBSDID("$FreeBSD$");
 223  */
 224 #ifndef __FBSDID
 225 #if !defined(lint) && !defined(STRIP_FBSDID)
 226 #define __FBSDID(s)     __IDSTRING(__CONCAT(__rcsid_,__LINE__),s)
 227 #else
 228 #define __FBSDID(s)     struct __hack
 229 #endif
 230 #endif
 231
 232 #ifndef __RCSID_SOURCE
 233 #define __RCSID_SOURCE(s)       __IDSTRING(__CONCAT(__rcsid_source_,__LINE__),s)
 234 #endif
 235
 236 #ifndef __COPYRIGHT
 237 #define __COPYRIGHT(s)  __IDSTRING(__CONCAT(__copyright_,__LINE__),s)
 238 #endif
 239
 240 #ifndef __DECONST
 241 #define __DECONST(type, var)    ((type)(uintptr_t)(const void *)(var))
 242 #endif
 243
 244 #ifndef __DEVOLATILE
 245 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
 246 #endif
 247
 248 #ifndef __DEQUALIFY
 249 #define __DEQUALIFY(type, var)  ((type)(uintptr_t)(const volatile void *)(var))
 250 #endif
 251
 252 #endif /* !_SYS_CDEFS_H_ */