sys/cddl/contrib/opensolaris/uts/common/sys/feature_tests.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright 2013 Garrett D'Amore <garrett@damore.org>
  24  *
  25  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
  26  * Use is subject to license terms.
  27  */
  28
  29 #ifndef _SYS_FEATURE_TESTS_H
  30 #define _SYS_FEATURE_TESTS_H
  31
  32 #include <sys/ccompile.h>
  33
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /*
  39  * Values of _POSIX_C_SOURCE
  40  *
  41  *              undefined   not a POSIX compilation
  42  *              1           POSIX.1-1990 compilation
  43  *              2           POSIX.2-1992 compilation
  44  *              199309L     POSIX.1b-1993 compilation (Real Time)
  45  *              199506L     POSIX.1c-1995 compilation (POSIX Threads)
  46  *              200112L     POSIX.1-2001 compilation (Austin Group Revision)
  47  *              200809L     POSIX.1-2008 compilation
  48  */
  49 #if defined(_POSIX_SOURCE) && !defined(_POSIX_C_SOURCE)
  50 #define _POSIX_C_SOURCE 1
  51 #endif
  52
  53 /*
  54  * The feature test macros __XOPEN_OR_POSIX, _STRICT_STDC, _STRICT_SYMBOLS,
  55  * and _STDC_C99 are Sun implementation specific macros created in order to
  56  * compress common standards specified feature test macros for easier reading.
  57  * These macros should not be used by the application developer as
  58  * unexpected results may occur. Instead, the user should reference
  59  * standards(5) for correct usage of the standards feature test macros.
  60  *
  61  * __XOPEN_OR_POSIX     Used in cases where a symbol is defined by both
  62  *                      X/Open or POSIX or in the negative, when neither
  63  *                      X/Open or POSIX defines a symbol.
  64  *
  65  * _STRICT_STDC         __STDC__ is specified by the C Standards and defined
  66  *                      by the compiler. For Sun compilers the value of
  67  *                      __STDC__ is either 1, 0, or not defined based on the
  68  *                      compilation mode (see cc(1)). When the value of
  69  *                      __STDC__ is 1 and in the absence of any other feature
  70  *                      test macros, the namespace available to the application
  71  *                      is limited to only those symbols defined by the C
  72  *                      Standard. _STRICT_STDC provides a more readable means
  73  *                      of identifying symbols defined by the standard, or in
  74  *                      the negative, symbols that are extensions to the C
  75  *                      Standard. See additional comments for GNU C differences.
  76  *
  77  * _STDC_C99            __STDC_VERSION__ is specified by the C standards and
  78  *                      defined by the compiler and indicates the version of
  79  *                      the C standard. A value of 199901L indicates a
  80  *                      compiler that complies with ISO/IEC 9899:1999, other-
  81  *                      wise known as the C99 standard.
  82  *
  83  * _STRICT_SYMBOLS      Used in cases where symbol visibility is restricted
  84  *                      by the standards, and the user has not explicitly
  85  *                      relaxed the strictness via __EXTENSIONS__.
  86  */
  87
  88 #if defined(_XOPEN_SOURCE) || defined(_POSIX_C_SOURCE)
  89 #define __XOPEN_OR_POSIX
  90 #endif
  91
  92 /*
  93  * ISO/IEC 9899:1990 and it's revision, ISO/IEC 9899:1999 specify the
  94  * following predefined macro name:
  95  *
  96  * __STDC__     The integer constant 1, intended to indicate a conforming
  97  *              implementation.
  98  *
  99  * Furthermore, a strictly conforming program shall use only those features
 100  * of the language and library specified in these standards. A conforming
 101  * implementation shall accept any strictly conforming program.
 102  *
 103  * Based on these requirements, Sun's C compiler defines __STDC__ to 1 for
 104  * strictly conforming environments and __STDC__ to 0 for environments that
 105  * use ANSI C semantics but allow extensions to the C standard. For non-ANSI
 106  * C semantics, Sun's C compiler does not define __STDC__.
 107  *
 108  * The GNU C project interpretation is that __STDC__ should always be defined
 109  * to 1 for compilation modes that accept ANSI C syntax regardless of whether
 110  * or not extensions to the C standard are used. Violations of conforming
 111  * behavior are conditionally flagged as warnings via the use of the
 112  * -pedantic option. In addition to defining __STDC__ to 1, the GNU C
 113  * compiler also defines __STRICT_ANSI__ as a means of specifying strictly
 114  * conforming environments using the -ansi or -std=<standard> options.
 115  *
 116  * In the absence of any other compiler options, Sun and GNU set the value
 117  * of __STDC__ as follows when using the following options:
 118  *
 119  *                              Value of __STDC__  __STRICT_ANSI__
 120  *
 121  * cc -Xa (default)                     0             undefined
 122  * cc -Xt (transitional)                0             undefined
 123  * cc -Xc (strictly conforming)         1             undefined
 124  * cc -Xs (K&R C)                   undefined         undefined
 125  *
 126  * gcc (default)                        1             undefined
 127  * gcc -ansi, -std={c89, c99,...)       1              defined
 128  * gcc -traditional (K&R)           undefined         undefined
 129  *
 130  * The default compilation modes for Sun C compilers versus GNU C compilers
 131  * results in a differing value for __STDC__ which results in a more
 132  * restricted namespace when using Sun compilers. To allow both GNU and Sun
 133  * interpretations to peacefully co-exist, we use the following Sun
 134  * implementation _STRICT_STDC_ macro:
 135  */
 136
 137 #if (__STDC__ - 0 == 1 && !defined(__GNUC__)) || \
 138         (defined(__GNUC__) && defined(__STRICT_ANSI__))
 139 #define _STRICT_STDC
 140 #else
 141 #undef  _STRICT_STDC
 142 #endif
 143
 144 /*
 145  * Compiler complies with ISO/IEC 9899:1999
 146  */
 147
 148 #if __STDC_VERSION__ - 0 >= 199901L
 149 #ifndef _STDC_C99
 150 #define _STDC_C99
 151 #endif
 152 #endif
 153
 154 /*
 155  * Use strict symbol visibility.
 156  */
 157 #if (defined(_STRICT_STDC) || defined(__XOPEN_OR_POSIX)) && \
 158         !defined(__EXTENSIONS__)
 159 #define _STRICT_SYMBOLS
 160 #endif
 161
 162 /*
 163  * Large file interfaces:
 164  *
 165  *      _LARGEFILE_SOURCE
 166  *              1               large file-related additions to POSIX
 167  *                              interfaces requested (fseeko, etc.)
 168  *      _LARGEFILE64_SOURCE
 169  *              1               transitional large-file-related interfaces
 170  *                              requested (seek64, stat64, etc.)
 171  *
 172  * The corresponding announcement macros are respectively:
 173  *      _LFS_LARGEFILE
 174  *      _LFS64_LARGEFILE
 175  * (These are set in <unistd.h>.)
 176  *
 177  * Requesting _LARGEFILE64_SOURCE implies requesting _LARGEFILE_SOURCE as
 178  * well.
 179  *
 180  * The large file interfaces are made visible regardless of the initial values
 181  * of the feature test macros under certain circumstances:
 182  *    - If no explicit standards-conforming environment is requested (neither
 183  *      of _POSIX_SOURCE nor _XOPEN_SOURCE is defined and the value of
 184  *      __STDC__ does not imply standards conformance).
 185  *    - Extended system interfaces are explicitly requested (__EXTENSIONS__
 186  *      is defined).
 187  *    - Access to in-kernel interfaces is requested (_KERNEL or _KMEMUSER is
 188  *      defined).  (Note that this dependency is an artifact of the current
 189  *      kernel implementation and may change in future releases.)
 190  */
 191 #if     (!defined(_STRICT_STDC) && !defined(__XOPEN_OR_POSIX)) || \
 192                 defined(_KERNEL) || defined(_KMEMUSER) || \
 193                 defined(__EXTENSIONS__)
 194 #undef  _LARGEFILE64_SOURCE
 195 #define _LARGEFILE64_SOURCE     1
 196 #endif
 197 #if     _LARGEFILE64_SOURCE - 0 == 1
 198 #undef  _LARGEFILE_SOURCE
 199 #define _LARGEFILE_SOURCE       1
 200 #endif
 201
 202 /*
 203  * Large file compilation environment control:
 204  *
 205  * The setting of _FILE_OFFSET_BITS controls the size of various file-related
 206  * types and governs the mapping between file-related source function symbol
 207  * names and the corresponding binary entry points.
 208  *
 209  * In the 32-bit environment, the default value is 32; if not set, set it to
 210  * the default here, to simplify tests in other headers.
 211  *
 212  * In the 64-bit compilation environment, the only value allowed is 64.
 213  */
 214 #if defined(_LP64)
 215 #ifndef _FILE_OFFSET_BITS
 216 #define _FILE_OFFSET_BITS       64
 217 #endif
 218 #if     _FILE_OFFSET_BITS - 0 != 64
 219 #error  "invalid _FILE_OFFSET_BITS value specified"
 220 #endif
 221 #else   /* _LP64 */
 222 #ifndef _FILE_OFFSET_BITS
 223 #define _FILE_OFFSET_BITS       32
 224 #endif
 225 #if     _FILE_OFFSET_BITS - 0 != 32 && _FILE_OFFSET_BITS - 0 != 64
 226 #error  "invalid _FILE_OFFSET_BITS value specified"
 227 #endif
 228 #endif  /* _LP64 */
 229
 230 /*
 231  * Use of _XOPEN_SOURCE
 232  *
 233  * The following X/Open specifications are supported:
 234  *
 235  * X/Open Portability Guide, Issue 3 (XPG3)
 236  * X/Open CAE Specification, Issue 4 (XPG4)
 237  * X/Open CAE Specification, Issue 4, Version 2 (XPG4v2)
 238  * X/Open CAE Specification, Issue 5 (XPG5)
 239  * Open Group Technical Standard, Issue 6 (XPG6), also referred to as
 240  *    IEEE Std. 1003.1-2001 and ISO/IEC 9945:2002.
 241  * Open Group Technical Standard, Issue 7 (XPG7), also referred to as
 242  *    IEEE Std. 1003.1-2008 and ISO/IEC 9945:2009.
 243  *
 244  * XPG4v2 is also referred to as UNIX 95 (SUS or SUSv1).
 245  * XPG5 is also referred to as UNIX 98 or the Single Unix Specification,
 246  *     Version 2 (SUSv2)
 247  * XPG6 is the result of a merge of the X/Open and POSIX specifications
 248  *     and as such is also referred to as IEEE Std. 1003.1-2001 in
 249  *     addition to UNIX 03 and SUSv3.
 250  * XPG7 is also referred to as UNIX 08 and SUSv4.
 251  *
 252  * When writing a conforming X/Open application, as per the specification
 253  * requirements, the appropriate feature test macros must be defined at
 254  * compile time. These are as follows. For more info, see standards(5).
 255  *
 256  * Feature Test Macro                                Specification
 257  * ------------------------------------------------  -------------
 258  * _XOPEN_SOURCE                                         XPG3
 259  * _XOPEN_SOURCE && _XOPEN_VERSION = 4                   XPG4
 260  * _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED = 1           XPG4v2
 261  * _XOPEN_SOURCE = 500                                   XPG5
 262  * _XOPEN_SOURCE = 600  (or POSIX_C_SOURCE=200112L)      XPG6
 263  * _XOPEN_SOURCE = 700  (or POSIX_C_SOURCE=200809L)      XPG7
 264  *
 265  * In order to simplify the guards within the headers, the following
 266  * implementation private test macros have been created. Applications
 267  * must NOT use these private test macros as unexpected results will
 268  * occur.
 269  *
 270  * Note that in general, the use of these private macros is cumulative.
 271  * For example, the use of _XPG3 with no other restrictions on the X/Open
 272  * namespace will make the symbols visible for XPG3 through XPG6
 273  * compilation environments. The use of _XPG4_2 with no other X/Open
 274  * namespace restrictions indicates that the symbols were introduced in
 275  * XPG4v2 and are therefore visible for XPG4v2 through XPG6 compilation
 276  * environments, but not for XPG3 or XPG4 compilation environments.
 277  *
 278  * _XPG3    X/Open Portability Guide, Issue 3 (XPG3)
 279  * _XPG4    X/Open CAE Specification, Issue 4 (XPG4)
 280  * _XPG4_2  X/Open CAE Specification, Issue 4, Version 2 (XPG4v2/UNIX 95/SUS)
 281  * _XPG5    X/Open CAE Specification, Issue 5 (XPG5/UNIX 98/SUSv2)
 282  * _XPG6    Open Group Technical Standard, Issue 6 (XPG6/UNIX 03/SUSv3)
 283  * _XPG7    Open Group Technical Standard, Issue 7 (XPG7/UNIX 08/SUSv4)
 284  */
 285
 286 /* X/Open Portability Guide, Issue 3 */
 287 #if defined(_XOPEN_SOURCE) && (_XOPEN_SOURCE - 0 < 500) && \
 288         (_XOPEN_VERSION - 0 < 4) && !defined(_XOPEN_SOURCE_EXTENDED)
 289 #define _XPG3
 290 /* X/Open CAE Specification, Issue 4 */
 291 #elif   (defined(_XOPEN_SOURCE) && _XOPEN_VERSION - 0 == 4)
 292 #define _XPG4
 293 #define _XPG3
 294 /* X/Open CAE Specification, Issue 4, Version 2 */
 295 #elif (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE_EXTENDED - 0 == 1)
 296 #define _XPG4_2
 297 #define _XPG4
 298 #define _XPG3
 299 /* X/Open CAE Specification, Issue 5 */
 300 #elif   (_XOPEN_SOURCE - 0 == 500)
 301 #define _XPG5
 302 #define _XPG4_2
 303 #define _XPG4
 304 #define _XPG3
 305 #undef  _POSIX_C_SOURCE
 306 #define _POSIX_C_SOURCE                 199506L
 307 /* Open Group Technical Standard , Issue 6 */
 308 #elif   (_XOPEN_SOURCE - 0 == 600) || (_POSIX_C_SOURCE - 0 == 200112L)
 309 #define _XPG6
 310 #define _XPG5
 311 #define _XPG4_2
 312 #define _XPG4
 313 #define _XPG3
 314 #undef  _POSIX_C_SOURCE
 315 #define _POSIX_C_SOURCE                 200112L
 316 #undef  _XOPEN_SOURCE
 317 #define _XOPEN_SOURCE                   600
 318
 319 /* Open Group Technical Standard, Issue 7 */
 320 #elif   (_XOPEN_SOURCE - 0 == 700) || (_POSIX_C_SOURCE - 0 == 200809L)
 321 #define _XPG7
 322 #define _XPG6
 323 #define _XPG5
 324 #define _XPG4_2
 325 #define _XPG4
 326 #define _XPG3
 327 #undef  _POSIX_C_SOURCE
 328 #define _POSIX_C_SOURCE                 200809L
 329 #undef  _XOPEN_SOURCE
 330 #define _XOPEN_SOURCE                   700
 331 #endif
 332
 333 /*
 334  * _XOPEN_VERSION is defined by the X/Open specifications and is not
 335  * normally defined by the application, except in the case of an XPG4
 336  * application.  On the implementation side, _XOPEN_VERSION defined with
 337  * the value of 3 indicates an XPG3 application. _XOPEN_VERSION defined
 338  * with the value of 4 indicates an XPG4 or XPG4v2 (UNIX 95) application.
 339  * _XOPEN_VERSION  defined with a value of 500 indicates an XPG5 (UNIX 98)
 340  * application and with a value of 600 indicates an XPG6 (UNIX 03)
 341  * application and with a value of 700 indicates an XPG7 (UNIX 08).
 342  * The appropriate version is determined by the use of the
 343  * feature test macros described earlier.  The value of _XOPEN_VERSION
 344  * defaults to 3 otherwise indicating support for XPG3 applications.
 345  */
 346 #ifndef _XOPEN_VERSION
 347 #if     defined(_XPG7)
 348 #define _XOPEN_VERSION 700
 349 #elif   defined(_XPG6)
 350 #define _XOPEN_VERSION 600
 351 #elif defined(_XPG5)
 352 #define _XOPEN_VERSION 500
 353 #elif   defined(_XPG4_2)
 354 #define _XOPEN_VERSION  4
 355 #else
 356 #define _XOPEN_VERSION  3
 357 #endif
 358 #endif
 359
 360 /*
 361  * ANSI C and ISO 9899:1990 say the type long long doesn't exist in strictly
 362  * conforming environments.  ISO 9899:1999 says it does.
 363  *
 364  * The presence of _LONGLONG_TYPE says "long long exists" which is therefore
 365  * defined in all but strictly conforming environments that disallow it.
 366  */
 367 #if !defined(_STDC_C99) && defined(_STRICT_STDC) && !defined(__GNUC__)
 368 /*
 369  * Resist attempts to force the definition of long long in this case.
 370  */
 371 #if defined(_LONGLONG_TYPE)
 372 #error  "No long long in strictly conforming ANSI C & 1990 ISO C environments"
 373 #endif
 374 #else
 375 #if !defined(_LONGLONG_TYPE)
 376 #define _LONGLONG_TYPE
 377 #endif
 378 #endif
 379
 380 /*
 381  * It is invalid to compile an XPG3, XPG4, XPG4v2, or XPG5 application
 382  * using c99.  The same is true for POSIX.1-1990, POSIX.2-1992, POSIX.1b,
 383  * and POSIX.1c applications. Likewise, it is invalid to compile an XPG6
 384  * or a POSIX.1-2001 application with anything other than a c99 or later
 385  * compiler.  Therefore, we force an error in both cases.
 386  */
 387 #if defined(_STDC_C99) && (defined(__XOPEN_OR_POSIX) && !defined(_XPG6))
 388 #error "Compiler or options invalid for pre-UNIX 03 X/Open applications \
 389         and pre-2001 POSIX applications"
 390 #elif !defined(_STDC_C99) && \
 391         (defined(__XOPEN_OR_POSIX) && defined(_XPG6))
 392 #error "Compiler or options invalid; UNIX 03 and POSIX.1-2001 applications \
 393         require the use of c99"
 394 #endif
 395
 396 /*
 397  * The following macro defines a value for the ISO C99 restrict
 398  * keyword so that _RESTRICT_KYWD resolves to "restrict" if
 399  * an ISO C99 compiler is used and "" (null string) if any other
 400  * compiler is used. This allows for the use of single prototype
 401  * declarations regardless of compiler version.
 402  */
 403 #if (defined(__STDC__) && defined(_STDC_C99)) && !defined(__cplusplus)
 404 #define _RESTRICT_KYWD  restrict
 405 #else
 406 #define _RESTRICT_KYWD
 407 #endif
 408
 409 /*
 410  * The following macro indicates header support for the ANSI C++
 411  * standard.  The ISO/IEC designation for this is ISO/IEC FDIS 14882.
 412  */
 413 #define _ISO_CPP_14882_1998
 414
 415 /*
 416  * The following macro indicates header support for the C99 standard,
 417  * ISO/IEC 9899:1999, Programming Languages - C.
 418  */
 419 #define _ISO_C_9899_1999
 420
 421 /*
 422  * The following macro indicates header support for DTrace. The value is an
 423  * integer that corresponds to the major version number for DTrace.
 424  */
 425 #define _DTRACE_VERSION 1
 426
 427 #ifdef  __cplusplus
 428 }
 429 #endif
 430
 431 #endif  /* _SYS_FEATURE_TESTS_H */