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: src/sys/sys/cdefs.h,v 1.28.2.8 2002/09/18 04:05:13 mikeh Exp $
  38  * $DragonFly: src/sys/sys/cdefs.h,v 1.17 2005/04/24 09:56:31 asmodai Exp $
  39  */
  40
  41 #ifndef _SYS_CDEFS_H_
  42 #define _SYS_CDEFS_H_
  43
  44 #if defined(__cplusplus)
  45 #define __BEGIN_DECLS   extern "C" {
  46 #define __END_DECLS     }
  47 #else
  48 #define __BEGIN_DECLS
  49 #define __END_DECLS
  50 #endif
  51
  52 /*
  53  * Macro to test if we are using a specific version of gcc or later.
  54  */
  55 #if defined(__GNUC__) && !defined(__INTEL_COMPILER)
  56 #define __GNUC_PREREQ__(ma, mi) \
  57         (__GNUC__ > (ma) || __GNUC__ == (ma) && __GNUC_MINOR__ >= (mi))
  58 #else
  59 #define __GNUC_PREREQ__(ma, mi) 0
  60 #endif
  61
  62 /*
  63  * The __VM_CACHELINE_SIZE macro defines the common cache line alignment
  64  * size that can be found across most recent and somewhat latest Intel
  65  * hardware, i.e. L1 cache sizes etc.
  66  *
  67  * If needed, this value can be TUNED.  Suitable values for this macro
  68  * are 32, 64 and 128 bytes.  The unit of measurement for this macro is
  69  * bytes.
  70  *
  71  * XXX: This macro and related macros will eventually move to a MD
  72  * header, but currently, we do need such a hierarchy.
  73  */
  74 #define __VM_CACHELINE_SIZE     32
  75
  76 /*
  77  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
  78  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
  79  * The __CONCAT macro is a bit tricky to use if it must work in non-ANSI
  80  * mode -- there must be no spaces between its arguments, and for nested
  81  * __CONCAT's, all the __CONCAT's must be at the left.  __CONCAT can also
  82  * concatenate double-quoted strings produced by the __STRING macro, but
  83  * this only works with ANSI C.
  84  *
  85  * __XSTRING is like __STRING, but it expands any macros in its argument
  86  * first.  It is only available with ANSI C.
  87  */
  88 #if defined(__STDC__) || defined(__cplusplus)
  89 #define __P(protos)     protos          /* full-blown ANSI C */
  90 #define __CONCAT1(x,y)  x ## y
  91 #define __CONCAT(x,y)   __CONCAT1(x,y)
  92 #define __STRING(x)     #x              /* stringify without expanding x */
  93 #define __XSTRING(x)    __STRING(x)     /* expand x, then stringify */
  94
  95 #define __const         const           /* define reserved names to standard */
  96 #define __signed        signed
  97 #define __volatile      volatile
  98 #if defined(__cplusplus)
  99 #define __inline        inline          /* convert to C++ keyword */
 100 #else
 101 #ifndef __GNUC__
 102 #define __inline                        /* delete GCC keyword */
 103 #endif /* !__GNUC__ */
 104 #endif /* !__cplusplus */
 105
 106 #else   /* !(__STDC__ || __cplusplus) */
 107 #define __P(protos)     ()              /* traditional C preprocessor */
 108 #define __CONCAT(x,y)   x/**/y
 109 #define __STRING(x)     "x"
 110
 111 #ifndef __GNUC__
 112 #define __const                         /* delete pseudo-ANSI C keywords */
 113 #define __inline
 114 #define __signed
 115 #define __volatile
 116 /*
 117  * In non-ANSI C environments, new programs will want ANSI-only C keywords
 118  * deleted from the program and old programs will want them left alone.
 119  * When using a compiler other than gcc, programs using the ANSI C keywords
 120  * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
 121  * When using "gcc -traditional", we assume that this is the intent; if
 122  * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
 123  */
 124 #ifndef NO_ANSI_KEYWORDS
 125 #define const                           /* delete ANSI C keywords */
 126 #define inline
 127 #define signed
 128 #define volatile
 129 #endif  /* !NO_ANSI_KEYWORDS */
 130 #endif  /* !__GNUC__ */
 131 #endif  /* !(__STDC__ || __cplusplus) */
 132
 133 /*
 134  * Compiler-dependent macros to help declare dead (non-returning) and
 135  * pure (no side effects) functions, and unused variables.  They are
 136  * null except for versions of gcc that are known to support the features
 137  * properly (old versions of gcc-2 supported the dead and pure features
 138  * in a different (wrong) way).
 139  */
 140 #ifdef lint
 141
 142 #define __dead2
 143 #define __pure
 144 #define __pure2
 145 #define __unused
 146 #define __packed
 147 #define __aligned(x)
 148 #define __section(x)
 149 #define __always_inline
 150 #define __nonnull(x)
 151
 152 #else
 153
 154 #if !__GNUC_PREREQ__(2, 7)
 155 #define __dead2
 156 #define __pure2
 157 #define __unused
 158 #endif
 159
 160 #if __GNUC_PREREQ__(2, 7)
 161 #define __dead2         __attribute__((__noreturn__))
 162 #define __pure2         __attribute__((__const__))
 163 #define __unused        __attribute__((__unused__))
 164 #define __packed        __attribute__((__packed__))
 165 #define __aligned(x)    __attribute__((__aligned__(x)))
 166 #define __section(x)    __attribute__((__section__(x)))
 167 #endif
 168
 169 #if __GNUC_PREREQ__(2, 96)
 170 #define __pure          __attribute__((__pure__))
 171 #else
 172 #define __pure          __pure2
 173 #endif
 174
 175 #if __GNUC_PREREQ__(3, 1)
 176 #define __always_inline __attribute__((__always_inline__))
 177 #else
 178 #define __always_inline
 179 #endif
 180
 181 #if __GNUC_PREREQ__(3, 3)
 182 #define __nonnull(x)    __attribute__((__nonnull__(x)))
 183 #define __used          __attribute__((__used__))
 184 #else
 185 #define __nonnull(x)
 186 #define __used          __unused
 187 #endif
 188
 189 #endif  /* LINT */
 190
 191 #if !__GNUC_PREREQ__(2, 7) && __STDC_VERSION < 199901
 192 #define __func__        NULL
 193 #endif
 194
 195 #if (__GNUC_PREREQ__(2, 0) && !defined(__STRICT_ANSI)) || \
 196     __STDC_VERSION__ >= 199901
 197 #define __LONG_LONG_SUPPORTED
 198 #endif
 199
 200 /*
 201  * GCC 2.95 and later provides `__restrict' as an extention to C90 to support
 202  * the C99-specific `restrict' type qualifier.  We happen to use `__restrict'
 203  * as a way to define the `restrict' type qualifier without disturbing older
 204  * software that is unaware of C99 keywords.
 205  */
 206 #if !__GNUC_PREREQ__(2, 95)
 207 #if __STDC_VERSION__ < 199901
 208 #define __restrict
 209 #else
 210 #define __restrict      restrict
 211 #endif
 212 #endif
 213
 214 /*
 215  * Compiler-dependent macros to declare that functions take printf-like
 216  * or scanf-like arguments.  They are null except for versions of gcc
 217  * that are known to support the features properly (old versions of gcc-2
 218  * didn't permit keeping the keywords out of the application namespace).
 219  *
 220  * The printf0like macro for GCC 2 uses DragonFly specific compiler extensions.
 221  */
 222 #if !__GNUC_PREREQ__(2, 7)
 223 #define __printflike(fmtarg, firstvararg)
 224 #define __scanflike(fmtarg, firstvararg)
 225 #define __printf0like(fmtarg, firstvararg)
 226 #elif __GNUC_PREREQ__(3, 0)
 227 #define __printflike(fmtarg, firstvararg) \
 228             __attribute__((__nonnull__(fmtarg), \
 229                           __format__ (__printf__, fmtarg, firstvararg)))
 230 #define __printf0like(fmtarg, firstvararg) \
 231             __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
 232 #define __scanflike(fmtarg, firstvararg) \
 233             __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
 234
 235 #else
 236 #define __printflike(fmtarg, firstvararg) \
 237             __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
 238 #define __printf0like(fmtarg, firstvararg) \
 239             __attribute__((__format__ (__printf0__, fmtarg, firstvararg)))
 240 #define __scanflike(fmtarg, firstvararg) \
 241             __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
 242 #endif
 243
 244 #if !__GNUC_PREREQ__(3, 0)
 245 #define __ARRAY_ZERO    0
 246 #else
 247 #define __ARRAY_ZERO
 248 #endif
 249
 250 /*
 251  * Handy GCC based macros:
 252  *
 253  *      __cachealign:
 254  *
 255  *      The __cachealign macro can be used for cache line aligning structures
 256  *      of small to medium size.  It aligns the particular structure or
 257  *      storage type to a system default cache line alignment, thus giving us
 258  *      a much more better cache utilization by making the hardware work at
 259  *      its best burst speeds.
 260  *
 261  *      __usereg:
 262  *
 263  *      The __usereg macro can/should be used when a function contains
 264  *      arguments not more than 3.  It can be very useful to us due to the
 265  *      message-passing nature of the kernel.
 266  *
 267  * !!NOTE - USAGE INFORMATION!!
 268  *
 269  * The __cachealign macro should not be used for data structures that are
 270  * as big struct proc, struct vnode, struct thread, and other structs which
 271  * are as big as them; simply because it will be useless in that case.
 272  *
 273  * The __usereg macro should be used whenever possible, i.e., when a function
 274  * does not exceed more than 3 arguments, and should not be used for vararg
 275  * type functions.
 276  *
 277  * In other words, AVOID MISUSE OF THESE MACROS. :-)
 278  */
 279 #ifdef __GNUC__
 280 #define __cachealign    __attribute__((__aligned__(__VM_CACHELINE_SIZE)))
 281 #define __usereg        __attribute__((__regparm__(3)))
 282 #else
 283 #define __cachealign
 284 #define __usereg
 285 #endif
 286
 287 #ifdef __GNUC__
 288 #define __strong_reference(sym,aliassym)        \
 289         extern __typeof (sym) aliassym __attribute__ ((__alias__ (#sym)));
 290 #define __weak_reference(sym,alias)     \
 291         __asm__(".weak " #alias);       \
 292         __asm__(".equ "  #alias ", " #sym)
 293 #define __warn_references(sym,msg)      \
 294         __asm__(".section .gnu.warning." #sym); \
 295         __asm__(".asciz \"" msg "\"");  \
 296         __asm__(".previous")
 297 #endif  /* __GNUC__ */
 298
 299 #if defined(__GNUC__)
 300 #define __IDSTRING(name,string) __asm__(".ident\t\"" string "\"")
 301 #endif
 302
 303 #ifndef __RCSID
 304 #define __RCSID(s)      __IDSTRING(rcsid,s)
 305 #endif
 306
 307 #ifndef __RCSID_SOURCE
 308 #define __RCSID_SOURCE(s) __IDSTRING(rcsid_source,s)
 309 #endif
 310
 311 #ifndef __COPYRIGHT
 312 #define __COPYRIGHT(s)  __IDSTRING(copyright,s)
 313 #endif
 314
 315 #ifndef __DECONST
 316 #define __DECONST(type, var)    ((type)(uintptr_t)(const void *)(var))
 317 #endif
 318
 319 #ifndef __DEVOLATILE
 320 #define __DEVOLATILE(type, var) ((type)(uintptr_t)(volatile void *)(var))
 321 #endif
 322
 323 #ifndef __DEQUALIFY
 324 #define __DEQUALIFY(type, var)  ((type)(uintptr_t)(const volatile void *)(var))
 325 #endif
 326
 327 /*-
 328  * The following definitions are an extension of the behavior originally
 329  * implemented in <sys/_posix.h>, but with a different level of granularity.
 330  * POSIX.1 requires that the macros we test be defined before any standard
 331  * header file is included.
 332  *
 333  * Here's a quick run-down of the versions:
 334  *  defined(_POSIX_SOURCE)              1003.1-1988
 335  *  _POSIX_C_SOURCE == 1                1003.1-1990
 336  *  _POSIX_C_SOURCE == 2                1003.2-1992 C Language Binding Option
 337  *  _POSIX_C_SOURCE == 199309           1003.1b-1993
 338  *  _POSIX_C_SOURCE == 199506           1003.1c-1995, 1003.1i-1995,
 339  *                                      and the omnibus ISO/IEC 9945-1: 1996
 340  *  _POSIX_C_SOURCE == 200112           1003.1-2001
 341  *
 342  * In addition, the X/Open Portability Guide, which is now the Single UNIX
 343  * Specification, defines a feature-test macro which indicates the version of
 344  * that specification, and which subsumes _POSIX_C_SOURCE.
 345  *
 346  * Our macros begin with two underscores to avoid namespace screwage.
 347  */
 348
 349 #if defined(_POSIX_C_SOURCE)
 350
 351 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1. */
 352 #if _POSIX_C_SOURCE == 1
 353 #undef _POSIX_C_SOURCE          /* Probably illegal, but beyond caring now. */
 354 #define _POSIX_C_SOURCE         199009
 355 #endif
 356
 357 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2. */
 358 #if _POSIX_C_SOURCE == 2
 359 #undef _POSIX_C_SOURCE
 360 #define _POSIX_C_SOURCE         199209
 361 #endif
 362
 363 #endif  /* _POSIX_C_SOURCE */
 364
 365 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
 366 #ifdef _XOPEN_SOURCE
 367 #if _XOPEN_SOURCE - 0 >= 600
 368 #define __XSI_VISIBLE           600
 369 #undef _POSIX_C_SOURCE
 370 #define _POSIX_C_SOURCE         200112
 371 #elif _XOPEN_SOURCE - 0 >= 500
 372 #define __XSI_VISIBLE           500
 373 #undef _POSIX_C_SOURCE
 374 #define _POSIX_C_SOURCE         199506
 375 #endif
 376 #endif
 377
 378 /*
 379  * Deal with all versions of POSIX.  The ordering relative to the tests above is
 380  * important.
 381  */
 382 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
 383 #define _POSIX_C_SOURCE         198808
 384 #endif
 385 #ifdef _POSIX_C_SOURCE
 386 #if _POSIX_C_SOURCE >= 200112
 387 #define __POSIX_VISIBLE         200112
 388 #define __ISO_C_VISIBLE         1999
 389 #elif _POSIX_C_SOURCE >= 199506
 390 #define __POSIX_VISIBLE         199506
 391 #define __ISO_C_VISIBLE         1990
 392 #elif _POSIX_C_SOURCE >= 199309
 393 #define __POSIX_VISIBLE         199309
 394 #define __ISO_C_VISIBLE         1990
 395 #elif _POSIX_C_SOURCE >= 199209
 396 #define __POSIX_VISIBLE         199209
 397 #define __ISO_C_VISIBLE         1990
 398 #elif _POSIX_C_SOURCE >= 199009
 399 #define __POSIX_VISIBLE         199009
 400 #define __ISO_C_VISIBLE         1990
 401 #else
 402 #define __POSIX_VISIBLE         198808
 403 #define __ISO_C_VISIBLE         0
 404 #endif /* _POSIX_C_SOURCE */
 405 #else
 406 /*-
 407  * Deal with _ANSI_SOURCE:
 408  * If it is defined, and no other compilation environment is explicitly
 409  * requested, then define our internal feature-test macros to zero.  This
 410  * makes no difference to the preprocessor (undefined symbols in preprocessing
 411  * expressions are defined to have value zero), but makes it more convenient for
 412  * a test program to print out the values.
 413  *
 414  * If a program mistakenly defines _ANSI_SOURCE and some other macro such as
 415  * _POSIX_C_SOURCE, we will assume that it wants the broader compilation
 416  * environment (and in fact we will never get here).
 417  */
 418 #ifdef _ANSI_SOURCE             /* Hide almost everything. */
 419 #define __POSIX_VISIBLE         0
 420 #define __XSI_VISIBLE           0
 421 #define __BSD_VISIBLE           0
 422 #define __ISO_C_VISIBLE         1990
 423 #elif defined(_C99_SOURCE)      /* Localism to specify strict C99 env. */
 424 #define __POSIX_VISIBLE         0
 425 #define __XSI_VISIBLE           0
 426 #define __BSD_VISIBLE           0
 427 #define __ISO_C_VISIBLE         1999
 428 #else                           /* Default environment: show everything. */
 429 #define __POSIX_VISIBLE         200112
 430 #define __XSI_VISIBLE           600
 431 #define __BSD_VISIBLE           1
 432 #define __ISO_C_VISIBLE         1999
 433 #endif
 434 #endif
 435
 436 #endif /* !_SYS_CDEFS_H_ */