bsd/sys/cdefs.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright 1995 NeXT Computer, Inc. All rights reserved. */
  23 /*
  24  * Copyright (c) 1991, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * This code is derived from software contributed to Berkeley by
  28  * Berkeley Software Design, Inc.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, this list of conditions and the following disclaimer.
  35  * 2. Redistributions in binary form must reproduce the above copyright
  36  *    notice, this list of conditions and the following disclaimer in the
  37  *    documentation and/or other materials provided with the distribution.
  38  * 3. All advertising materials mentioning features or use of this software
  39  *    must display the following acknowledgement:
  40  *      This product includes software developed by the University of
  41  *      California, Berkeley and its contributors.
  42  * 4. Neither the name of the University nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  *      @(#)cdefs.h     8.8 (Berkeley) 1/9/95
  59  */
  60
  61 #ifndef _CDEFS_H_
  62 #define _CDEFS_H_
  63
  64 #if defined(__cplusplus)
  65 #define __BEGIN_DECLS   extern "C" {
  66 #define __END_DECLS     }
  67 #else
  68 #define __BEGIN_DECLS
  69 #define __END_DECLS
  70 #endif
  71
  72 /*
  73  * The __CONCAT macro is used to concatenate parts of symbol names, e.g.
  74  * with "#define OLD(foo) __CONCAT(old,foo)", OLD(foo) produces oldfoo.
  75  * The __CONCAT macro is a bit tricky -- make sure you don't put spaces
  76  * in between its arguments.  __CONCAT can also concatenate double-quoted
  77  * strings produced by the __STRING macro, but this only works with ANSI C.
  78  */
  79 #if defined(__STDC__) || defined(__cplusplus)
  80 #define __P(protos)     protos          /* full-blown ANSI C */
  81 #define __CONCAT(x,y)   x ## y
  82 #define __STRING(x)     #x
  83
  84 #define __const         const           /* define reserved names to standard */
  85 #define __signed        signed
  86 #define __volatile      volatile
  87 #if defined(__cplusplus)
  88 #define __inline        inline          /* convert to C++ keyword */
  89 #else
  90 #ifndef __GNUC__
  91 #define __inline                        /* delete GCC keyword */
  92 #endif /* !__GNUC__ */
  93 #endif /* !__cplusplus */
  94
  95 #else   /* !(__STDC__ || __cplusplus) */
  96 #define __P(protos)     ()              /* traditional C preprocessor */
  97 #define __CONCAT(x,y)   x/**/y
  98 #define __STRING(x)     "x"
  99
 100 #ifndef __GNUC__
 101 #define __const                         /* delete pseudo-ANSI C keywords */
 102 #define __inline
 103 #define __signed
 104 #define __volatile
 105 #endif  /* !__GNUC__ */
 106
 107 /*
 108  * In non-ANSI C environments, new programs will want ANSI-only C keywords
 109  * deleted from the program and old programs will want them left alone.
 110  * When using a compiler other than gcc, programs using the ANSI C keywords
 111  * const, inline etc. as normal identifiers should define -DNO_ANSI_KEYWORDS.
 112  * When using "gcc -traditional", we assume that this is the intent; if
 113  * __GNUC__ is defined but __STDC__ is not, we leave the new keywords alone.
 114  */
 115 #ifndef NO_ANSI_KEYWORDS
 116 #define const           __const                 /* convert ANSI C keywords */
 117 #define inline          __inline
 118 #define signed          __signed
 119 #define volatile        __volatile
 120 #endif /* !NO_ANSI_KEYWORDS */
 121 #endif /* !(__STDC__ || __cplusplus) */
 122
 123 /*
 124  * GCC1 and some versions of GCC2 declare dead (non-returning) and
 125  * pure (no side effects) functions using "volatile" and "const";
 126  * unfortunately, these then cause warnings under "-ansi -pedantic".
 127  * GCC2 uses a new, peculiar __attribute__((attrs)) style.  All of
 128  * these work for GNU C++ (modulo a slight glitch in the C++ grammar
 129  * in the distribution version of 2.5.5).
 130  */
 131 #if defined(__MWERKS__) && (__MWERKS__ > 0x2400)
 132         /* newer Metrowerks compilers support __attribute__() */
 133 #elif __GNUC__ > 2 || __GNUC__ == 2 && __GNUC_MINOR__ >= 5
 134 #define __dead2         __attribute__((__noreturn__))
 135 #define __pure2         __attribute__((__const__))
 136 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 && __GNUC_MINOR__ < 7
 137 #define __unused        /* no attribute */
 138 #else
 139 #define __unused        __attribute__((__unused__))
 140 #endif
 141 #else
 142 #define __attribute__(x)        /* delete __attribute__ if non-gcc or gcc1 */
 143 #if defined(__GNUC__) && !defined(__STRICT_ANSI__)
 144 /* __dead and __pure are depreciated.  Use __dead2 and __pure2 instead */
 145 #define __dead          __volatile
 146 #define __pure          __const
 147 #endif
 148 #endif
 149
 150 /* Delete pseudo-keywords wherever they are not available or needed. */
 151 #ifndef __dead
 152 #define __dead
 153 #define __pure
 154 #endif
 155 #ifndef __dead2
 156 #define __dead2
 157 #define __pure2
 158 #define __unused
 159 #endif
 160
 161 /*
 162  * GCC 2.95 provides `__restrict' as an extension to C90 to support the
 163  * C99-specific `restrict' type qualifier.  We happen to use `__restrict' as
 164  * a way to define the `restrict' type qualifier without disturbing older
 165  * software that is unaware of C99 keywords.
 166  */
 167 #if !(__GNUC__ == 2 && __GNUC_MINOR__ == 95)
 168 #if __STDC_VERSION__ < 199901
 169 #define __restrict
 170 #else
 171 #define __restrict      restrict
 172 #endif
 173 #endif
 174
 175 /*
 176  * Compiler-dependent macros to declare that functions take printf-like
 177  * or scanf-like arguments.  They are null except for versions of gcc
 178  * that are known to support the features properly.  Functions declared
 179  * with these attributes will cause compilation warnings if there is a
 180  * mismatch between the format string and subsequent function parameter
 181  * types.
 182  */
 183 #if __GNUC__ > 2 || __GNUC__ == 2 && __GNUC_MINOR__ >= 7
 184 #define __printflike(fmtarg, firstvararg) \
 185                 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
 186 #define __scanflike(fmtarg, firstvararg) \
 187                 __attribute__((__format__ (__scanf__, fmtarg, firstvararg)))
 188 #else
 189 #define __printflike(fmtarg, firstvararg)
 190 #define __scanflike(fmtarg, firstvararg)
 191 #endif
 192
 193 #define __IDSTRING(name,string) static const char name[] __unused = string
 194
 195 #ifndef __COPYRIGHT
 196 #define __COPYRIGHT(s) __IDSTRING(copyright,s)
 197 #endif
 198
 199 #ifndef __RCSID
 200 #define __RCSID(s) __IDSTRING(rcsid,s)
 201 #endif
 202
 203 #ifndef __SCCSID
 204 #define __SCCSID(s) __IDSTRING(sccsid,s)
 205 #endif
 206
 207 #ifndef __PROJECT_VERSION
 208 #define __PROJECT_VERSION(s) __IDSTRING(project_version,s)
 209 #endif
 210
 211 /*
 212  * The __DARWIN_ALIAS macros is used to do symbol renaming,
 213  * they allow old code to use the old symbol thus maintiang binary
 214  * compatability while new code can use a new improved version of the
 215  * same function.
 216  *
 217  * By default newly complied code will actually get the same symbols
 218  * that the old code did.  Defining any of _APPLE_C_SOURCE, _XOPEN_SOURCE,
 219  * or _POSIX_C_SOURCE will give you the new symbols.  Defining _XOPEN_SOURCE
 220  * or _POSIX_C_SOURCE also restricts the avilable symbols to a subset of
 221  * Apple's APIs.
 222  *
 223  * __DARWIN_ALIAS is used by itself if the function signature has not
 224  * changed, it is used along with a #ifdef check for __DARWIN_UNIX03
 225  * if the signature has changed.  Because the __LP64__ enviroment
 226  * only supports UNIX03 sementics it causes __DARWIN_UNIX03 to be
 227  * defined, but causes __DARWIN_ALIAS to do no symbol mangling.
 228  */
 229
 230 #if !defined(__DARWIN_UNIX03)
 231 #if defined(_APPLE_C_SOURCE) || defined(_XOPEN_SOURCE) || defined(_POSIX_C_SOURCE) || defined(__LP64__)
 232 #if defined(_NONSTD_SOURCE)
 233 #error "Can't define both _NONSTD_SOURCE and any of _APPLE_C_SOURCE, _XOPEN_SOURCE, _POSIX_C_SOURCE, or __LP64__"
 234 #endif /* _NONSTD_SOURCE */
 235 #define __DARWIN_UNIX03 1
 236 #elif defined(_NONSTD_SOURCE)
 237 #define __DARWIN_UNIX03 0
 238 #else /* default */
 239 #define __DARWIN_UNIX03 0
 240 #endif /* _APPLE_C_SOURCE || _XOPEN_SOURCE || _POSIX_C_SOURCE || __LP64__ */
 241 #endif /* !__DARWIN_UNIX03 */
 242
 243 #if __DARWIN_UNIX03 && !defined(__LP64__)
 244 #define __DARWIN_ALIAS(sym) __asm("_" __STRING(sym) "$UNIX2003")
 245 #else
 246 #define __DARWIN_ALIAS(sym)
 247 #endif
 248
 249
 250 /*
 251  * POSIX.1 requires that the macros we test be defined before any standard
 252  * header file is included.  This permits us to convert values for feature
 253  * testing, as necessary, using only _POSIX_C_SOURCE.
 254  *
 255  * Here's a quick run-down of the versions:
 256  *  defined(_POSIX_SOURCE)              1003.1-1988
 257  *  _POSIX_C_SOURCE == 1L               1003.1-1990
 258  *  _POSIX_C_SOURCE == 2L               1003.2-1992 C Language Binding Option
 259  *  _POSIX_C_SOURCE == 199309L          1003.1b-1993
 260  *  _POSIX_C_SOURCE == 199506L          1003.1c-1995, 1003.1i-1995,
 261  *                                      and the omnibus ISO/IEC 9945-1: 1996
 262  *  _POSIX_C_SOURCE == 200112L          1003.1-2001
 263  *
 264  * In addition, the X/Open Portability Guide, which is now the Single UNIX
 265  * Specification, defines a feature-test macro which indicates the version of
 266  * that specification, and which subsumes _POSIX_C_SOURCE.
 267  */
 268
 269 /* Deal with IEEE Std. 1003.1-1990, in which _POSIX_C_SOURCE == 1L. */
 270 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 1L
 271 #undef _POSIX_C_SOURCE
 272 #define _POSIX_C_SOURCE         199009L
 273 #endif
 274
 275 /* Deal with IEEE Std. 1003.2-1992, in which _POSIX_C_SOURCE == 2L. */
 276 #if defined(_POSIX_C_SOURCE) && _POSIX_C_SOURCE == 2L
 277 #undef _POSIX_C_SOURCE
 278 #define _POSIX_C_SOURCE         199209L
 279 #endif
 280
 281 /* Deal with various X/Open Portability Guides and Single UNIX Spec. */
 282 #ifdef _XOPEN_SOURCE
 283 #if _XOPEN_SOURCE - 0L >= 600L
 284 #undef _POSIX_C_SOURCE
 285 #define _POSIX_C_SOURCE         200112L
 286 #elif _XOPEN_SOURCE - 0L >= 500L
 287 #undef _POSIX_C_SOURCE
 288 #define _POSIX_C_SOURCE         199506L
 289 #endif
 290 #endif
 291
 292 /*
 293  * Deal with all versions of POSIX.  The ordering relative to the tests above is
 294  * important.
 295  */
 296 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
 297 #define _POSIX_C_SOURCE         198808L
 298 #endif
 299
 300 /*
 301  * long long is not supported in c89 (__STRICT_ANSI__), but g++ -ansi and
 302  * c99 still want long longs.  While not perfect, we allow long longs for
 303  * g++.
 304  */
 305 #define __DARWIN_NO_LONG_LONG   (defined(__STRICT_ANSI__) \
 306                                 && (__STDC_VERSION__-0 < 199901L) \
 307                                 && !defined(__GNUG__))
 308
 309 /*
 310  * Long double compatibility macro allow selecting variant symbols based
 311  * on the old (compatible) 64-bit long doubles, or the new 128-bit
 312  * long doubles.  This applies only to ppc; i386 already has long double
 313  * support, while ppc64 doesn't have any backwards history.
 314  */
 315 #if defined(__ppc__)
 316 #  if defined(__LDBL_MANT_DIG__) && defined(__DBL_MANT_DIG__) && \
 317         __LDBL_MANT_DIG__ > __DBL_MANT_DIG__
 318 #    if __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__-0 < 1040
 319 #      define   __DARWIN_LDBL_COMPAT(x) __asm("_" __STRING(x) "$LDBLStub")
 320 #    else
 321 #      define   __DARWIN_LDBL_COMPAT(x) __asm("_" __STRING(x) "$LDBL128")
 322 #    endif
 323 #    define     __DARWIN_LDBL_COMPAT2(x) __asm("_" __STRING(x) "$LDBL128")
 324 #    define     __DARWIN_LONG_DOUBLE_IS_DOUBLE  0
 325 #  else
 326 #   define      __DARWIN_LDBL_COMPAT(x) /* nothing */
 327 #   define      __DARWIN_LDBL_COMPAT2(x) /* nothing */
 328 #   define      __DARWIN_LONG_DOUBLE_IS_DOUBLE  1
 329 #  endif
 330 #elif defined(__i386__) || defined(__ppc64__)
 331 #  define       __DARWIN_LDBL_COMPAT(x) /* nothing */
 332 #  define       __DARWIN_LDBL_COMPAT2(x) /* nothing */
 333 #  define       __DARWIN_LONG_DOUBLE_IS_DOUBLE  0
 334 #else
 335 #  error Unknown architecture
 336 #endif
 337
 338 /*
 339  * Structure alignment control macros.  These specify how certain
 340  * shared structures should be aligned.  Some may need backward
 341  * compatible legacy (POWER) alignment, while others may need
 342  * forward compatible (NATURAL) alignment.
 343  */
 344 #if !defined(__DARWIN_ALIGN_POWER)
 345 #if defined(__ppc64__)
 346 #define __DARWIN_ALIGN_POWER 1
 347 #else
 348 #define __DARWIN_ALIGN_POWER 0
 349 #endif
 350 #endif /* __DARWIN_ALIGN_POWER */
 351
 352 #if !defined(__DARWIN_ALIGN_NATURAL)
 353 #if defined(__ppc__) && defined(KERNEL)
 354 #define __DARWIN_ALIGN_NATURAL 1
 355 #else
 356 #define __DARWIN_ALIGN_NATURAL 0
 357 #endif
 358 #endif /* __DARWIN_ALIGN_NATURAL */
 359
 360 #endif /* !_CDEFS_H_ */