original/man7/feature_test_macros.7

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .TH FEATURE_TEST_MACROS 7 2011-09-17 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 feature_test_macros \- feature test macros
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <features.h>
  31 .fi
  32 .SH DESCRIPTION
  33 Feature test macros allow the programmer to control the definitions that
  34 are exposed by system header files when a program is compiled.
  35
  36 .B NOTE:
  37 In order to be effective, a feature test macro
  38 .IR "must be defined before including any header files" .
  39 This can be done either in the compilation command
  40 .RI ( "cc \-DMACRO=value" )
  41 or by defining the macro within the source code before
  42 including any headers.
  43
  44 Some feature test macros are useful for creating portable applications,
  45 by preventing nonstandard definitions from being exposed.
  46 Other macros can be used to expose nonstandard definitions that
  47 are not exposed by default.
  48 The precise effects of each of the feature test macros described below
  49 can be ascertained by inspecting the
  50 .I <features.h>
  51 header file.
  52 .SS Specification of feature test macro requirements in manual pages
  53 When a function requires that a feature test macro is defined,
  54 the manual page SYNOPSIS typically includes a note of the following form
  55 (this example from the
  56 .BR acct (2)
  57 manual page):
  58 .RS 8
  59 .sp
  60 .B #include <unistd.h>
  61 .sp
  62 .BI "int acct(const char *" filename );
  63 .sp
  64 .nf
  65 .in -4n
  66 Feature Test Macro Requirements for glibc (see
  67 .BR feature_test_macros (7)):
  68 .fi
  69 .in
  70 .sp
  71 .BR acct ():
  72 _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\ <\ 500)
  73 .RE
  74 .PP
  75 The \fB||\fP means that in order to obtain the declaration of
  76 .BR acct (2)
  77 from
  78 .IR <unistd.h> ,
  79 \fIeither\fP of the following macro
  80 definitions must be made before including any header files:
  81 .RS
  82 .nf
  83
  84 #define _BSD_SOURCE
  85 #define _XOPEN_SOURCE        /* or any value < 500 */
  86 .fi
  87 .RE
  88 .PP
  89 Alternatively, equivalent definitions can be included in the
  90 compilation command:
  91 .RS
  92 .nf
  93
  94 cc \-D_BSD_SOURCE
  95 cc \-D_XOPEN_SOURCE           # Or any value < 500
  96 .fi
  97 .RE
  98 .PP
  99 Note that, as described below,
 100 .BR "some feature test macros are defined by default" ,
 101 so that it may not always be necessary to
 102 explicitly specify the feature test macro(s) shown in the
 103 SYNOPSIS.
 104
 105 In a few cases, manual pages use a shorthand for expressing the
 106 feature test macro requirements (this example from
 107 .BR readahead (2)):
 108 .RS
 109 .nf
 110
 111 .B #define _GNU_SOURCE
 112 .B #include <fcntl.h>
 113 .sp
 114 .BI "ssize_t readahead(int " fd ", off64_t *" offset ", size_t " count );
 115 .fi
 116 .RE
 117 .PP
 118 This format is employed in cases where only a single
 119 feature test macro can be used to expose the function
 120 declaration, and that macro is not defined by default.
 121 .SS Feature test macros understood by glibc
 122 The following paragraphs explain how feature test macros are handled
 123 in Linux glibc 2.\fIx\fP, \fIx\fP > 0.
 124 .\" The details in glibc 2.0 are simpler, but combining a
 125 .\" a description of them with the details in later glibc versions
 126 .\" would make for a complicated description.
 127
 128 Linux glibc understands the following feature test macros:
 129 .TP
 130 .B __STRICT_ANSI__
 131 ISO Standard C.
 132 This macro is implicitly defined by
 133 .BR gcc (1)
 134 when invoked with, for example, the
 135 .I -std=c99
 136 or
 137 .I -ansi
 138 flag.
 139 .TP
 140 .B _POSIX_C_SOURCE
 141 Defining this macro causes header files to expose definitions as follows:
 142 .RS
 143 .IP \(bu 3
 144 The value 1 exposes definitions conforming to POSIX.1-1990 and
 145 ISO C (1990).
 146 .IP \(bu
 147 The value 2 or greater additionally exposes
 148 definitions for POSIX.2-1992.
 149 .IP \(bu
 150 The value 199309L or greater additionally exposes
 151 definitions for POSIX.1b (real-time extensions).
 152 .\" 199506L functionality is only available since glibc 2.1
 153 .IP \(bu
 154 The value 199506L or greater additionally exposes
 155 definitions for POSIX.1c (threads).
 156 .IP \(bu
 157 (Since glibc 2.3.3)
 158 The value 200112L or greater exposes definitions corresponding
 159 to the POSIX.1-2001 base specification (excluding the XSI extension).
 160 .IP \(bu
 161 (Since glibc 2.10)
 162 The value 200809L or greater exposes definitions corresponding
 163 to the POSIX.1-2008 base specification (excluding the XSI extension).
 164 .RE
 165 .TP
 166 .B _POSIX_SOURCE
 167 Defining this obsolete macro with any value is equivalent to defining
 168 .B _POSIX_C_SOURCE
 169 with the value 1.
 170 .TP
 171 .B _XOPEN_SOURCE
 172 Defining this macro causes header files to expose definitions as follows:
 173 .RS
 174 .IP \(bu 3
 175 Defining with any value exposes
 176 definitions conforming to POSIX.1, POSIX.2, and XPG4.
 177 .IP \(bu
 178 The value 500 or greater additionally exposes
 179 definitions for SUSv2 (UNIX 98).
 180 .IP \(bu
 181 (Since glibc 2.2) The value 600 or greater additionally exposes
 182 definitions for SUSv3 (UNIX 03; i.e., the POSIX.1-2001 base specification
 183 plus the XSI extension) and C99 definitions.
 184 .IP \(bu
 185 (Since glibc 2.10) The value 700 or greater additionally exposes
 186 definitions for SUSv4 (i.e., the POSIX.1-2008 base specification
 187 plus the XSI extension).
 188 .RE
 189 .TP
 190 .B _XOPEN_SOURCE_EXTENDED
 191 If this macro is defined, and
 192 .B _XOPEN_SOURCE
 193 is defined, then expose definitions corresponding to the XPG4v2
 194 (SUSv1) UNIX extensions (UNIX 95).
 195 This macro is also implicitly defined if
 196 .B _XOPEN_SOURCE
 197 is defined with a value of 500 or more.
 198 .TP
 199 .B _ISOC95_SOURCE
 200 Exposes ISO C (1990) Amendment 1 definitions (also known as C95).
 201 This macro is recognized since glibc 2.12.
 202 The primary change in C95 was support for international character sets.
 203 The C95 changes were included in the subsequent C99 standard
 204 (in other words,
 205 .B _ISOC99_SOURCE
 206 implies
 207 .BR _ISOC95_SOURCE ).
 208 .TP
 209 .B _ISOC99_SOURCE
 210 Exposes C99 extensions to ISO C (1990).
 211 This macro is recognized since glibc 2.1.3;
 212 earlier glibc 2.1.x versions recognized an equivalent macro named
 213 .B _ISOC9X_SOURCE
 214 (because the C99 standard had not then been finalized).
 215 Although the use of the latter macro is obsolete, glibc continues
 216 to recognize it for backward compatibility.
 217 .TP
 218 .B _LARGEFILE64_SOURCE
 219 Expose definitions for the alternative API specified by the
 220 LFS (Large File Summit) as a "transitional extension" to the
 221 Single UNIX Specification.
 222 (See http://opengroup.org/platform/lfs.html.)
 223 The alternative API consists of a set of new objects
 224 (i.e., functions and types) whose names are suffixed with "64"
 225 (e.g.,
 226 .I off64_t
 227 versus
 228 .IR off_t ,
 229 .BR lseek64 ()
 230 versus
 231 .BR lseek (),
 232 etc.).
 233 New programs should not employ this interface; instead
 234 .I _FILE_OFFSET_BITS=64
 235 should be employed.
 236 .TP
 237 .B _FILE_OFFSET_BITS
 238 Defining this macro with the value 64
 239 automatically converts references to 32-bit functions and data types
 240 related to file I/O and file system operations into references to
 241 their 64-bit counterparts.
 242 This is useful for performing I/O on large files (> 2 Gigabytes)
 243 on 32-bit systems.
 244 (Defining this macro permits correctly written programs to use
 245 large files with only a recompilation being required.)
 246 64-bit systems naturally permit file sizes greater than 2 Gigabytes,
 247 and on those systems this macro has no effect.
 248 .TP
 249 .B _BSD_SOURCE
 250 Defining this macro with any value causes header files to expose
 251 BSD-derived definitions.
 252 Defining this macro also causes BSD definitions to be preferred in
 253 some situations where standards conflict, unless one or more of
 254 .BR _SVID_SOURCE ,
 255 .BR _POSIX_SOURCE ,
 256 .BR _POSIX_C_SOURCE ,
 257 .BR _XOPEN_SOURCE ,
 258 .BR _XOPEN_SOURCE_EXTENDED ,
 259 or
 260 .B _GNU_SOURCE
 261 is defined, in which case BSD definitions are disfavored.
 262 .TP
 263 .B _SVID_SOURCE
 264 Defining this macro with any value causes header files to expose
 265 System V-derived definitions.
 266 (SVID == System V Interface Definition; see
 267 .BR standards (7).)
 268 .TP
 269 .BR _ATFILE_SOURCE " (since glibc 2.4)"
 270 Defining this macro with any value causes header files to expose
 271 declarations of a range of functions with the suffix "at";
 272 see
 273 .BR openat (2).
 274 Since glibc 2.10, this macro is also implicitly defined if
 275 .BR _POSIX_C_SOURCE
 276 is defined with a value greater than or equal to 200809L.
 277 .TP
 278 .B _GNU_SOURCE
 279 Defining this macro (with any value) is equivalent to defining
 280 .BR _BSD_SOURCE ,
 281 .BR _SVID_SOURCE ,
 282 .BR _ATFILE_SOURCE ,
 283 .BR _LARGEFILE64_SOURCE ,
 284 .BR _ISOC99_SOURCE ,
 285 .BR _XOPEN_SOURCE_EXTENDED ,
 286 .BR _POSIX_SOURCE ,
 287 .B _POSIX_C_SOURCE
 288 with the value 200809L
 289 (200112L in glibc versions before 2.10;
 290 199506L in glibc versions before 2.5;
 291 199309L in glibc versions before 2.1)
 292 and
 293 .B _XOPEN_SOURCE
 294 with the value 700
 295 (600 in glibc versions before 2.10;
 296 500 in glibc versions before 2.2).
 297 In addition, various GNU-specific extensions are also exposed.
 298 Where standards conflict, BSD definitions are disfavored.
 299 .TP
 300 .B _REENTRANT
 301 Defining this macro exposes definitions of certain reentrant functions.
 302 For multithreaded programs, use
 303 .I "cc\ \-pthread"
 304 instead.
 305 .TP
 306 .B _THREAD_SAFE
 307 Synonym for
 308 .BR _REENTRANT ,
 309 provided for compatibility with some other implementations.
 310 .TP
 311 .BR _FORTIFY_SOURCE " (since glibc 2.3.4)"
 312 .\" For more detail, see:
 313 .\" http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html
 314 .\" [PATCH] Object size checking to prevent (some) buffer overflows
 315 .\" * From: Jakub Jelinek <jakub at redhat dot com>
 316 .\" * To: gcc-patches at gcc dot gnu dot org
 317 .\" * Date: Tue, 21 Sep 2004 04:16:40 -0400
 318 Defining this macro causes some lightweight checks to be performed
 319 to detect some buffer overflow errors when employing
 320 various string and memory manipulation functions.
 321 Not all buffer overflows are detected, just some common cases.
 322 In the current implementation checks are added for
 323 calls to
 324 .BR memcpy (3),
 325 .BR mempcpy (3),
 326 .BR memmove (3),
 327 .BR memset (3),
 328 .BR stpcpy (3),
 329 .BR strcpy (3),
 330 .BR strncpy (3),
 331 .BR strcat (3),
 332 .BR strncat (3),
 333 .BR sprintf (3),
 334 .BR snprintf (3),
 335 .BR vsprintf (3),
 336 .BR vsnprintf (3),
 337 and
 338 .BR gets (3).
 339 If
 340 .B _FORTIFY_SOURCE
 341 is set to 1, with compiler optimization level 1
 342 .RI ( "gcc\ \-O1" )
 343 and above, checks that shouldn't change the behavior of
 344 conforming programs are performed.
 345 With
 346 .B _FORTIFY_SOURCE
 347 set to 2 some more checking is added, but
 348 some conforming programs might fail.
 349 Some of the checks can be performed at compile time,
 350 and result in compiler warnings;
 351 other checks take place at run time,
 352 and result in a run-time error if the check fails.
 353 Use of this macro requires compiler support, available with
 354 .BR gcc (1)
 355 since version 4.0.
 356 .SS Default definitions, implicit definitions, and combining definitions
 357 .PP
 358 If no feature test macros are explicitly defined,
 359 then the following feature test macros are defined by default:
 360 .BR _BSD_SOURCE ,
 361 .BR _SVID_SOURCE ,
 362 .BR _POSIX_SOURCE ,
 363 and
 364 .BR _POSIX_C_SOURCE =200809L
 365 (200112L in glibc versions before 2.10;
 366 199506L in glibc versions before 2.4;
 367 199309L in glibc versions before 2.1).
 368 .PP
 369 If any of
 370 .BR __STRICT_ANSI__ ,
 371 .BR _ISOC99_SOURCE ,
 372 .BR _POSIX_SOURCE ,
 373 .BR _POSIX_C_SOURCE  ,
 374 .BR _XOPEN_SOURCE ,
 375 .BR _XOPEN_SOURCE_EXTENDED ,
 376 .BR _BSD_SOURCE ,
 377 or
 378 .B _SVID_SOURCE
 379 is explicitly defined, then
 380 .BR _BSD_SOURCE ,
 381 and
 382 .B _SVID_SOURCE
 383 are not defined by default.
 384
 385 If
 386 .B _POSIX_SOURCE
 387 and
 388 .B _POSIX_C_SOURCE
 389 are not explicitly defined,
 390 and either
 391 .B __STRICT_ANSI__
 392 is not defined or
 393 .B _XOPEN_SOURCE
 394 is defined with a value of 500 or more, then
 395 .RS 3
 396 .IP * 3
 397 .B _POSIX_SOURCE
 398 is defined with the value 1; and
 399 .IP *
 400 .B _POSIX_C_SOURCE
 401 is defined with one of the following values:
 402 .RS 6
 403 .IP \(bu 3
 404 2,
 405 if
 406 .B XOPEN_SOURCE
 407 is defined with a value less than 500;
 408 .IP \(bu
 409 199506L,
 410 if
 411 .B XOPEN_SOURCE
 412 is defined with a value greater than or equal to 500 and less than 600;
 413 or
 414 .IP \(bu
 415 (since glibc 2.4) 200112L,
 416 if
 417 .B XOPEN_SOURCE
 418 is defined with a value greater than or equal to 600 and less than 700.
 419 .IP \(bu
 420 (Since glibc 2.10)
 421 200809L,
 422 if
 423 .B XOPEN_SOURCE
 424 is defined with a value greater than or equal to 700.
 425 .IP \(bu
 426 Older versions of glibc do not know about the values
 427 200112L and 200809L for
 428 .BR _POSIX_C_SOURCE ,
 429 and the setting of this macro will depend on the glibc version.
 430 .IP \(bu
 431 If
 432 .B _XOPEN_SOURCE
 433 is undefined, then the setting of
 434 .B _POSIX_C_SOURCE
 435 depends on the glibc version:
 436 199506L, in glibc versions before 2.4;
 437 200112L, in glibc 2.4 to 2.9; and
 438 200809L, since glibc 2.10.
 439 .RE
 440 .RE
 441 .PP
 442 Multiple macros can be defined; the results are additive.
 443 .SH CONFORMING TO
 444 POSIX.1 specifies
 445 .BR _POSIX_C_SOURCE ,
 446 .BR _POSIX_SOURCE ,
 447 and
 448 .BR _XOPEN_SOURCE .
 449 .B _XOPEN_SOURCE_EXTENDED
 450 was specified by XPG4v2 (aka SUSv1).
 451
 452 .B _FILE_OFFSET_BITS
 453 is not specified by any standard,
 454 but is employed on some other implementations.
 455
 456 .BR _BSD_SOURCE ,
 457 .BR _SVID_SOURCE ,
 458 .BR _ATFILE_SOURCE ,
 459 .BR _GNU_SOURCE ,
 460 .BR _FORTIFY_SOURCE ,
 461 .BR _REENTRANT ,
 462 and
 463 .B _THREAD_SAFE
 464 are specific to Linux (glibc).
 465 .SH NOTES
 466 .I <features.h>
 467 is a Linux/glibc-specific header file.
 468 Other systems have an analogous file, but typically with a different name.
 469 This header file is automatically included by other header files as
 470 required: it is not necessary to explicitly include it in order to
 471 employ feature test macros.
 472
 473 According to which of the above feature test macros are defined,
 474 .I <features.h>
 475 internally defines various other macros that are checked by
 476 other glibc header files.
 477 These macros have names prefixed by two underscores (e.g.,
 478 .BR __USE_MISC ).
 479 Programs should \fInever\fP define these macros directly:
 480 instead, the appropriate feature test macro(s) from the
 481 list above should be employed.
 482 .SH EXAMPLE
 483 The program below can be used to explore how the various
 484 feature test macros are set depending on the glibc version
 485 and what feature test macros are explicitly set.
 486 The following shell session, on a system with glibc 2.10,
 487 shows some examples of what we would see:
 488 .in +4n
 489 .nf
 490
 491 $ \fBcc ftm.c\fP
 492 $ \fB./a.out\fP
 493 _POSIX_SOURCE defined
 494 _POSIX_C_SOURCE defined: 200809L
 495 _BSD_SOURCE defined
 496 _SVID_SOURCE defined
 497 _ATFILE_SOURCE defined
 498 $ \fBcc \-D_XOPEN_SOURCE=500 ftm.c\fP
 499 $ \fB./a.out\fP
 500 _POSIX_SOURCE defined
 501 _POSIX_C_SOURCE defined: 199506L
 502 _XOPEN_SOURCE defined: 500
 503 $ \fBcc \-D_GNU_SOURCE ftm.c\fP
 504 $ \fB./a.out\fP
 505 _POSIX_SOURCE defined
 506 _POSIX_C_SOURCE defined: 200809L
 507 _ISOC99_SOURCE defined
 508 _XOPEN_SOURCE defined: 700
 509 _XOPEN_SOURCE_EXTENDED defined
 510 _LARGEFILE64_SOURCE defined
 511 _BSD_SOURCE defined
 512 _SVID_SOURCE defined
 513 _ATFILE_SOURCE defined
 514 _GNU_SOURCE defined
 515 .fi
 516 .in
 517 .SS Program source
 518 \&
 519 .nf
 520 /* ftm.c */
 521
 522 #include <stdio.h>
 523 #include <unistd.h>
 524 #include <stdlib.h>
 525
 526 int
 527 main(int argc, char *argv[])
 528 {
 529 #ifdef _POSIX_SOURCE
 530     printf("_POSIX_SOURCE defined\\n");
 531 #endif
 532
 533 #ifdef _POSIX_C_SOURCE
 534     printf("_POSIX_C_SOURCE defined: %ldL\\n", (long) _POSIX_C_SOURCE);
 535 #endif
 536
 537 #ifdef _ISOC99_SOURCE
 538     printf("_ISOC99_SOURCE defined\\n");
 539 #endif
 540
 541 #ifdef _XOPEN_SOURCE
 542     printf("_XOPEN_SOURCE defined: %d\\n", _XOPEN_SOURCE);
 543 #endif
 544
 545 #ifdef _XOPEN_SOURCE_EXTENDED
 546     printf("_XOPEN_SOURCE_EXTENDED defined\\n");
 547 #endif
 548
 549 #ifdef _LARGEFILE64_SOURCE
 550     printf("_LARGEFILE64_SOURCE defined\\n");
 551 #endif
 552
 553 #ifdef _FILE_OFFSET_BITS
 554     printf("_FILE_OFFSET_BITS defined: %d\\n", _FILE_OFFSET_BITS);
 555 #endif
 556
 557 #ifdef _BSD_SOURCE
 558     printf("_BSD_SOURCE defined\\n");
 559 #endif
 560
 561 #ifdef _SVID_SOURCE
 562     printf("_SVID_SOURCE defined\\n");
 563 #endif
 564
 565 #ifdef _ATFILE_SOURCE
 566     printf("_ATFILE_SOURCE defined\\n");
 567 #endif
 568
 569 #ifdef _GNU_SOURCE
 570     printf("_GNU_SOURCE defined\\n");
 571 #endif
 572
 573 #ifdef _REENTRANT
 574     printf("_REENTRANT defined\\n");
 575 #endif
 576
 577 #ifdef _THREAD_SAFE
 578     printf("_THREAD_SAFE defined\\n");
 579 #endif
 580
 581 #ifdef _FORTIFY_SOURCE
 582     printf("_FORTIFY_SOURCE defined\\n");
 583 #endif
 584
 585     exit(EXIT_SUCCESS);
 586 }
 587 .fi
 588 .SH SEE ALSO
 589 .BR libc (7),
 590 .BR standards (7)
 591 .sp
 592 The section "Feature Test Macros" under
 593 .IR "info libc" .
 594 .\" But beware: the info libc document is out of date (Jul 07, mtk)
 595 .sp
 596 .I /usr/include/features.h