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 2010-09-10 "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 _ISOC99_SOURCE
 200 Exposes C99 extensions to ISO C (1990).
 201 This macro is recognized since glibc 2.1.3;
 202 earlier glibc 2.1.x versions recognized an equivalent macro named
 203 .B _ISOC9X_SOURCE
 204 (because the C99 standard had not then been finalized).
 205 Although the use of the latter macro is obsolete, glibc continues
 206 to recognize it for backward compatibility.
 207 .TP
 208 .B _LARGEFILE64_SOURCE
 209 Expose definitions for the alternative API specified by the
 210 LFS (Large File Summit) as a "transitional extension" to the
 211 Single UNIX Specification.
 212 (See http://opengroup.org/platform/lfs.html.)
 213 The alternative API consists of a set of new objects
 214 (i.e., functions and types) whose names are suffixed with "64"
 215 (e.g.,
 216 .I off64_t
 217 versus
 218 .IR off_t ,
 219 .BR lseek64 ()
 220 versus
 221 .BR lseek (),
 222 etc.).
 223 New programs should not employ this interface; instead
 224 .I _FILE_OFFSET_BITS=64
 225 should be employed.
 226 .TP
 227 .B _FILE_OFFSET_BITS
 228 Defining this macro with the value 64
 229 automatically converts references to 32-bit functions and data types
 230 related to file I/O and file system operations into references to
 231 their 64-bit counterparts.
 232 This is useful for performing I/O on large files (> 2 Gigabytes)
 233 on 32-bit systems.
 234 (Defining this macro permits correctly written programs to use
 235 large files with only a recompilation being required.)
 236 64-bit systems naturally permit file sizes greater than 2 Gigabytes,
 237 and on those systems this macro has no effect.
 238 .TP
 239 .B _BSD_SOURCE
 240 Defining this macro with any value causes header files to expose
 241 BSD-derived definitions.
 242 Defining this macro also causes BSD definitions to be preferred in
 243 some situations where standards conflict, unless one or more of
 244 .BR _SVID_SOURCE ,
 245 .BR _POSIX_SOURCE ,
 246 .BR _POSIX_C_SOURCE ,
 247 .BR _XOPEN_SOURCE ,
 248 .BR _XOPEN_SOURCE_EXTENDED ,
 249 or
 250 .B _GNU_SOURCE
 251 is defined, in which case BSD definitions are disfavored.
 252 .TP
 253 .B _SVID_SOURCE
 254 Defining this macro with any value causes header files to expose
 255 System V-derived definitions.
 256 (SVID == System V Interface Definition; see
 257 .BR standards (7).)
 258 .TP
 259 .BR _ATFILE_SOURCE " (since glibc 2.4)"
 260 Defining this macro with any value causes header files to expose
 261 declarations of a range of functions with the suffix "at";
 262 see
 263 .BR openat (2).
 264 Since glibc 2.10, this macro is also implicitly defined if
 265 .BR _POSIX_C_SOURCE
 266 is defined with a value greater than or equal to 200809L.
 267 .TP
 268 .B _GNU_SOURCE
 269 Defining this macro (with any value) is equivalent to defining
 270 .BR _BSD_SOURCE ,
 271 .BR _SVID_SOURCE ,
 272 .BR _ATFILE_SOURCE ,
 273 .BR _LARGEFILE64_SOURCE ,
 274 .BR _ISOC99_SOURCE ,
 275 .BR _XOPEN_SOURCE_EXTENDED ,
 276 .BR _POSIX_SOURCE ,
 277 .B _POSIX_C_SOURCE
 278 with the value 200809L
 279 (200112L in glibc versions before 2.10;
 280 199506L in glibc versions before 2.5;
 281 199309L in glibc versions before 2.1)
 282 and
 283 .B _XOPEN_SOURCE
 284 with the value 700
 285 (600 in glibc versions before 2.10;
 286 500 in glibc versions before 2.2).
 287 In addition, various GNU-specific extensions are also exposed.
 288 Where standards conflict, BSD definitions are disfavored.
 289 .TP
 290 .B _REENTRANT
 291 Defining this macro exposes definitions of certain reentrant functions.
 292 For multithreaded programs, use
 293 .I "cc\ \-pthread"
 294 instead.
 295 .TP
 296 .B _THREAD_SAFE
 297 Synonym for
 298 .BR _REENTRANT ,
 299 provided for compatibility with some other implementations.
 300 .TP
 301 .BR _FORTIFY_SOURCE " (since glibc 2.3.4)"
 302 .\" For more detail, see:
 303 .\" http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html
 304 .\" [PATCH] Object size checking to prevent (some) buffer overflows
 305 .\" * From: Jakub Jelinek <jakub at redhat dot com>
 306 .\" * To: gcc-patches at gcc dot gnu dot org
 307 .\" * Date: Tue, 21 Sep 2004 04:16:40 -0400
 308 Defining this macro causes some lightweight checks to be performed
 309 to detect some buffer overflow errors when employing
 310 various string and memory manipulation functions.
 311 Not all buffer overflows are detected, just some common cases.
 312 In the current implementation checks are added for
 313 calls to
 314 .BR memcpy (3),
 315 .BR mempcpy (3),
 316 .BR memmove (3),
 317 .BR memset (3),
 318 .BR stpcpy (3),
 319 .BR strcpy (3),
 320 .BR strncpy (3),
 321 .BR strcat (3),
 322 .BR strncat (3),
 323 .BR sprintf (3),
 324 .BR snprintf (3),
 325 .BR vsprintf (3),
 326 .BR vsnprintf (3),
 327 and
 328 .BR gets (3).
 329 If
 330 .B _FORTIFY_SOURCE
 331 is set to 1, with compiler optimization level 1
 332 .RI ( "gcc\ \-O1" )
 333 and above, checks that shouldn't change the behavior of
 334 conforming programs are performed.
 335 With
 336 .B _FORTIFY_SOURCE
 337 set to 2 some more checking is added, but
 338 some conforming programs might fail.
 339 Some of the checks can be performed at compile time,
 340 and result in compiler warnings;
 341 other checks take place at run time,
 342 and result in a run-time error if the check fails.
 343 Use of this macro requires compiler support, available with
 344 .BR gcc (1)
 345 since version 4.0.
 346 .SS Default definitions, implicit definitions, and combining definitions
 347 .PP
 348 If no feature test macros are explicitly defined,
 349 then the following feature test macros are defined by default:
 350 .BR _BSD_SOURCE ,
 351 .BR _SVID_SOURCE ,
 352 .BR _POSIX_SOURCE ,
 353 and
 354 .BR _POSIX_C_SOURCE =200809L
 355 (200112L in glibc versions before 2.10;
 356 199506L in glibc versions before 2.4;
 357 199309L in glibc versions before 2.1).
 358 .PP
 359 If any of
 360 .BR __STRICT_ANSI__ ,
 361 .BR _ISOC99_SOURCE ,
 362 .BR _POSIX_SOURCE ,
 363 .BR _POSIX_C_SOURCE  ,
 364 .BR _XOPEN_SOURCE ,
 365 .BR _XOPEN_SOURCE_EXTENDED ,
 366 .BR _BSD_SOURCE ,
 367 or
 368 .B _SVID_SOURCE
 369 is explicitly defined, then
 370 .BR _BSD_SOURCE ,
 371 and
 372 .B _SVID_SOURCE
 373 are not defined by default.
 374
 375 If
 376 .B _POSIX_SOURCE
 377 and
 378 .B _POSIX_C_SOURCE
 379 are not explicitly defined,
 380 and either
 381 .B __STRICT_ANSI__
 382 is not defined or
 383 .B _XOPEN_SOURCE
 384 is defined with a value of 500 or more, then
 385 .RS 3
 386 .IP * 3
 387 .B _POSIX_SOURCE
 388 is defined with the value 1; and
 389 .IP *
 390 .B _POSIX_C_SOURCE
 391 is defined with one of the following values:
 392 .RS 6
 393 .IP \(bu 3
 394 2,
 395 if
 396 .B XOPEN_SOURCE
 397 is defined with a value less than 500;
 398 .IP \(bu
 399 199506L,
 400 if
 401 .B XOPEN_SOURCE
 402 is defined with a value greater than or equal to 500 and less than 600;
 403 or
 404 .IP \(bu
 405 (since glibc 2.4) 200112L,
 406 if
 407 .B XOPEN_SOURCE
 408 is defined with a value greater than or equal to 600 and less than 700.
 409 .IP \(bu
 410 (Since glibc 2.10)
 411 200809L,
 412 if
 413 .B XOPEN_SOURCE
 414 is defined with a value greater than or equal to 700.
 415 .IP \(bu
 416 Older versions of glibc do not know about the values
 417 200112L and 200809L for
 418 .BR _POSIX_C_SOURCE ,
 419 and the setting of this macro will depend on the glibc version.
 420 .IP \(bu
 421 If
 422 .B _XOPEN_SOURCE
 423 is undefined, then the setting of
 424 .B _POSIX_C_SOURCE
 425 depends on the glibc version:
 426 199506L, in glibc versions before 2.4;
 427 200112L, in glibc 2.4 to 2.9; and
 428 200809L, since glibc 2.10.
 429 .RE
 430 .RE
 431 .PP
 432 Multiple macros can be defined; the results are additive.
 433 .SH CONFORMING TO
 434 POSIX.1 specifies
 435 .BR _POSIX_C_SOURCE ,
 436 .BR _POSIX_SOURCE ,
 437 and
 438 .BR _XOPEN_SOURCE .
 439 .B _XOPEN_SOURCE_EXTENDED
 440 was specified by XPG4v2 (aka SUSv1).
 441
 442 .B _FILE_OFFSET_BITS
 443 is not specified by any standard,
 444 but is employed on some other implementations.
 445
 446 .BR _BSD_SOURCE ,
 447 .BR _SVID_SOURCE ,
 448 .BR _ATFILE_SOURCE ,
 449 .BR _GNU_SOURCE ,
 450 .BR _FORTIFY_SOURCE ,
 451 .BR _REENTRANT ,
 452 and
 453 .B _THREAD_SAFE
 454 are specific to Linux (glibc).
 455 .SH NOTES
 456 .I <features.h>
 457 is a Linux/glibc-specific header file.
 458 Other systems have an analogous file, but typically with a different name.
 459 This header file is automatically included by other header files as
 460 required: it is not necessary to explicitly include it in order to
 461 employ feature test macros.
 462
 463 According to which of the above feature test macros are defined,
 464 .I <features.h>
 465 internally defines various other macros that are checked by
 466 other glibc header files.
 467 These macros have names prefixed by two underscores (e.g.,
 468 .BR __USE_MISC ).
 469 Programs should \fInever\fP define these macros directly:
 470 instead, the appropriate feature test macro(s) from the
 471 list above should be employed.
 472 .SH EXAMPLE
 473 The program below can be used to explore how the various
 474 feature test macros are set depending on the glibc version
 475 and what feature test macros are explicitly set.
 476 The following shell session, on a system with glibc 2.10,
 477 shows some examples of what we would see:
 478 .in +4n
 479 .nf
 480
 481 $ \fBcc ftm.c\fP
 482 $ \fB./a.out\fP
 483 _POSIX_SOURCE defined
 484 _POSIX_C_SOURCE defined: 200809L
 485 _BSD_SOURCE defined
 486 _SVID_SOURCE defined
 487 _ATFILE_SOURCE defined
 488 $ \fBcc -D_XOPEN_SOURCE=500 ftm.c\fP
 489 $ \fB./a.out\fP
 490 _POSIX_SOURCE defined
 491 _POSIX_C_SOURCE defined: 199506L
 492 _XOPEN_SOURCE defined: 500
 493 $ \fBcc -D_GNU_SOURCE ftm.c\fP
 494 $ \fB./a.out\fP
 495 _POSIX_SOURCE defined
 496 _POSIX_C_SOURCE defined: 200809L
 497 _ISOC99_SOURCE defined
 498 _XOPEN_SOURCE defined: 700
 499 _XOPEN_SOURCE_EXTENDED defined
 500 _LARGEFILE64_SOURCE defined
 501 _BSD_SOURCE defined
 502 _SVID_SOURCE defined
 503 _ATFILE_SOURCE defined
 504 _GNU_SOURCE defined
 505 .fi
 506 .in
 507 .SS Program source
 508 \&
 509 .nf
 510 /* ftm.c */
 511
 512 #include <stdio.h>
 513 #include <unistd.h>
 514 #include <stdlib.h>
 515
 516 int
 517 main(int argc, char *argv[])
 518 {
 519 #ifdef _POSIX_SOURCE
 520     printf("_POSIX_SOURCE defined\\n");
 521 #endif
 522
 523 #ifdef _POSIX_C_SOURCE
 524     printf("_POSIX_C_SOURCE defined: %ldL\\n", (long) _POSIX_C_SOURCE);
 525 #endif
 526
 527 #ifdef _ISOC99_SOURCE
 528     printf("_ISOC99_SOURCE defined\\n");
 529 #endif
 530
 531 #ifdef _XOPEN_SOURCE
 532     printf("_XOPEN_SOURCE defined: %d\\n", _XOPEN_SOURCE);
 533 #endif
 534
 535 #ifdef _XOPEN_SOURCE_EXTENDED
 536     printf("_XOPEN_SOURCE_EXTENDED defined\\n");
 537 #endif
 538
 539 #ifdef _LARGEFILE64_SOURCE
 540     printf("_LARGEFILE64_SOURCE defined\\n");
 541 #endif
 542
 543 #ifdef _FILE_OFFSET_BITS
 544     printf("_FILE_OFFSET_BITS defined: %d\\n", _FILE_OFFSET_BITS);
 545 #endif
 546
 547 #ifdef _BSD_SOURCE
 548     printf("_BSD_SOURCE defined\\n");
 549 #endif
 550
 551 #ifdef _SVID_SOURCE
 552     printf("_SVID_SOURCE defined\\n");
 553 #endif
 554
 555 #ifdef _ATFILE_SOURCE
 556     printf("_ATFILE_SOURCE defined\\n");
 557 #endif
 558
 559 #ifdef _GNU_SOURCE
 560     printf("_GNU_SOURCE defined\\n");
 561 #endif
 562
 563 #ifdef _REENTRANT
 564     printf("_REENTRANT defined\\n");
 565 #endif
 566
 567 #ifdef _THREAD_SAFE
 568     printf("_THREAD_SAFE defined\\n");
 569 #endif
 570
 571 #ifdef _FORTIFY_SOURCE
 572     printf("_FORTIFY_SOURCE defined\\n");
 573 #endif
 574
 575     exit(EXIT_SUCCESS);
 576 }
 577 .fi
 578 .SH SEE ALSO
 579 .BR libc (7),
 580 .BR standards (7)
 581 .sp
 582 The section "Feature Test Macros" under
 583 .IR "info libc" .
 584 .\" But beware: the info libc document is out of date (Jul 07, mtk)
 585 .sp
 586 .I /usr/include/features.h