1 .\" Hey Emacs! This file is -*- nroff -*- source.
3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
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.
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.
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
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" Japanese Version Copyright (c) 2006 Akihiro MOTOKI all rights reserved.
26 .\" Translated 2006-07-16, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
27 .\" Updated 2007-05-01, Akihiro MOTOKI, LDP v2.46
28 .\" Updated 2007-09-08, Akihiro MOTOKI, LDP v2.64
29 .\" Updated 2009-04-23, Akihiro MOTOKI, LDP v3.21
31 .\"WORD: feature test macro 機能検査マクロ
32 .\"WORD: feature test macro requirements 機能検査マクロの要件
34 .TH FEATURE_TEST_MACROS 7 2010-09-10 "Linux" "Linux Programmer's Manual"
36 feature_test_macros \- 機能検査マクロ
39 .B #include <features.h>
42 機能検査マクロ (feature test macro) により、プログラマは
43 プログラムがコンパイルされる際にシステムのヘッダファイルにより
47 機能検査マクロを機能させるには、機能検査マクロの定義を
48 「どのヘッダファイルのインクルードよりも前で」行わなければならない。
51 .RI ( "cc \-DMACRO=value" )
53 どのヘッダのインクルードよりも前で行う方法がある。
55 機能検査マクロを使うと、非標準の定義が公開されないようにでき、
56 移植性のあるアプリケーションを作成するのに役立つ。
57 他のマクロを使うと、デフォルトでは公開されない非標準の定義を
59 以下で説明する機能検査マクロのそれぞれの正確な影響を確認するには、
64 .SS マニュアルページでの機能検査マクロの要件の規定
65 関数が機能検査マクロの定義を必要とする場合、
66 マニュアルページの書式 (SYNOPSIS) の節に
73 .B #include <unistd.h>
75 .BI "int acct(const char *" filename );
80 .RB ( feature_test_macros (7)
86 _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE\ <\ 500)
93 から得るには、以下のマクロの定義のいずれかを、どのヘッダファイルの
94 インクルードよりも前で行わなければならないことを意味する。
99 #define _XOPEN_SOURCE /* or any value < 500 */
103 別の方法としては、等価な定義をコンパイル用のコマンドで
109 cc \-D_XOPEN_SOURCE # Or any value < 500
114 .B 「いくつかの機能検査マクロはデフォルトで定義される」
116 このため、「書式」に記載された機能検査マクロを常に
119 あまり多くないが、マニュアルページによっては、
120 機能検査マクロの要件を以下のように簡単な表現で記載する場合がある。
127 .B #define _GNU_SOURCE
128 .B #include <fcntl.h>
130 .BI "ssize_t readahead(int " fd ", off64_t *" offset ", size_t " count );
134 関数定義の公開に使える機能検査マクロが一つだけで、
135 デフォルトではそのマクロが定義されない場合に、
137 .SS glibc が解釈する機能検査マクロ
138 以下では、Linux glibc 2.\fIx\fP (\fIx\fP > 0) において、
139 機能検査マクロがどのように扱われるかを説明する。
140 .\" The details in glibc 2.0 are simpler, but combining a
141 .\" a description of them with the details in later glibc versions
142 .\" would make for a complicated description.
144 Linux/glibc は以下の機能検査マクロを解釈する:
161 値が 1 の場合、POSIX.1-1990 と ISO C (1990) に準拠する定義が公開される。
164 POSIX.2-1992 関連の定義も追加で公開される。
167 POSIX.1b (リアルタイム拡張) 関連の定義が追加で公開される。
168 .\" 199506L functionality is only available since glibc 2.1
171 POSIX.1c (スレッド) 関連の定義が追加で公開される。
175 (XSI 拡張を除く) POSIX.1-2001 基本仕様に対応する定義が公開される。
179 (XSI 拡張を除く) POSIX.1-2008 基本仕様に対応する定義が公開される。
189 このマクロを定義すると、ヘッダファイルで以下の定義が公開される。
193 POSIX.1, POSIX.2, XPG4 に準拠する定義が公開される。
196 SUSv2 (UNIX 98) 関連の定義が追加で公開される。
200 SUSv3 (UNIX 03; POSIX.1-2001 基本仕様 + XSI 拡張と同じ)
201 関連の定義と C99 での定義が追加で公開される。
205 SUSv4 (POSIX.1-2008 基本仕様 + XSI 拡張と同じ)
209 .B _XOPEN_SOURCE_EXTENDED
212 が定義されていると、XPG4v2 (SUSv1) UNIX 拡張 (UNIX 95)
215 が 500 以上の値で定義された場合、このマクロは暗黙のうちに定義される。
218 ISO C (1990) の C99 拡張を公開する。
219 このマクロは glibc 2.1.3 以降で認識される。
220 初期のバージョン 2.1.x の glibc では、これと等価な
223 (なぜなら、C99 標準はまだ確定していなかったからである)。
226 glibc は過去との互換性のため今でもこのマクロを認識する。
228 .B _LARGEFILE64_SOURCE
229 LFS (Large File Summit) により
230 "暫定拡張 (transitional extension)" Single UNIX Specification
231 として規定された代替 API (alternative API) に関する定義を公開する
232 (http://opengroup.org/platform/lfs.html 参照)。
233 代替 API は新規オブジェクト (関数と型) の集合で構成され、
234 その名前は "64" で終わる (例えば、
242 新しいプログラムではこのインタフェースを利用しないこと。
244 .I _FILE_OFFSET_BITS=64
248 このマクロを値 64 で定義すると、ファイル I/O とファイルシステム操作に
249 関連する 32 ビット版の関数とデータタイプは自動的に 64 ビット版に
251 これは、32 ビットシステムで大きなファイル (> 2 ギガバイト) の I/O
253 (このマクロを定義すると、コンパイルし直すだけで大きなファイルを
255 64 ビットシステムは、もともと 2 ギガバイトより大きなファイルを
256 扱えるので、64 ビットシステムではこのマクロは効果を持たない。
259 このマクロを定義すると (値に関わらず) ヘッダファイルで
261 また、このマクロを定義すると、相容れない標準が存在する状況において
266 .BR _POSIX_C_SOURCE ,
268 .BR _XOPEN_SOURCE_EXTENDED ,
270 が一つでも定義された場合には、BSD 由来の定義は優先されなくなる。
273 このマクロを定義すると (値に関わらず) ヘッダファイルで
275 (SVID == System V Interface Definition;
279 .BR _ATFILE_SOURCE " (glibc 2.4 以降)"
280 このマクロを定義すると (値に関わらず) ヘッダファイルで
281 名前の末尾が "at" の各種の関数の定義が公開される。
286 が 200809L 以上の値で定義された場合には、
290 このマクロを定義すると (値に関わらず) 以下のマクロを定義するのと
295 .BR _LARGEFILE64_SOURCE ,
297 .BR _XOPEN_SOURCE_EXTENDED ,
301 (バージョン 2.10 より前の glibc では値は 200112L、
302 バージョン 2.5 より前の glibc では値は 199506L、
303 バージョン 2.1 より前の glibc では値は 199309L),
306 (バージョン 2.10 より前の glibc では値は 600、
307 バージョン 2.2 より前の glibc では値は 500)。
308 さらに、各種の GNU 固有の拡張も公開される。
313 このマクロを定義すると、いくつかのリエントラント (再入可能) な関数
314 定義が公開される。マルチスレッド・プログラムでは、この代わりに
321 他のいくつかの実装との互換性を提供するためのもの。
323 .BR _FORTIFY_SOURCE " (glibc 2.3.4 以降)"
324 .\" For more detail, see:
325 .\" http://gcc.gnu.org/ml/gcc-patches/2004-09/msg02055.html
326 .\" [PATCH] Object size checking to prevent (some) buffer overflows
327 .\" * From: Jakub Jelinek <jakub at redhat dot com>
328 .\" * To: gcc-patches at gcc dot gnu dot org
329 .\" * Date: Tue, 21 Sep 2004 04:16:40 -0400
330 このマクロを定義すると、文字列やメモリの操作を行う様々な関数を
331 使用する際にバッファオーバーフローを検出するための軽めのチェックが
332 実行されるようになる。すべてのバッファオーバーフローが検出される
333 わけではなく、あくまでよくある例についてだけである。
334 現在の実装では、以下の関数にチェックが追加されている:
350 が 1 に設定された場合、コンパイラの最適化レベルが 1
352 かそれ以上であれば、規格に準拠するプログラムの振る舞いを
355 が 2 に設定された場合、さらなるチェックが追加されるが、
356 規格に準拠するプログラムのいくつかが失敗する可能性がある。
357 いくつかのチェックはコンパイル時に実行でき、コンパイラの警告として
358 表示される。他のチェックは実行時に行われ、チェックに失敗した場合
360 このマクロを使用するにはコンパイラの対応が必要であり、
364 .SS デフォルトの定義、暗黙の定義、組み合わせ定義
366 機能検査マクロが一つも明示的に定義されなかった場合、
371 .BR _POSIX_C_SOURCE =200809L
373 (バージョン 2.10 より前の glibc では値は 200112L、
374 バージョン 2.4 より前の glibc では値は 199506L、
375 バージョン 2.1 より前の glibc では値は 199309L)。
377 .BR __STRICT_ANSI__ ,
380 .BR _POSIX_C_SOURCE ,
382 .BR _XOPEN_SOURCE_EXTENDED ,
398 が 500 以上の値で定義されたときには、
414 が 500 以上 600 未満の値で定義された場合)
419 が 600 以上 700 未満の値で定義された場合)
428 の値として 200112L や 200809L は存在せず、
430 の値がどうなるかは glibc のバージョンにより異なる。
435 の値は glibc のバージョンにより異なる。
436 バージョン 2.4 より前の glibc では 199506L、
437 バージョン 2.4 以降 2.9 未満では 200112L、
438 glibc 2.10 以降では 200809L となる。
442 また、複数のマクロを定義することもできる。
443 この場合、定義したマクロはすべて有効になる。
446 .BR _POSIX_C_SOURCE ,
450 .B _XOPEN_SOURCE_EXTENDED
451 は XPG4v2 (別名 SUSv1) で規定されていた。
461 .BR _FORTIFY_SOURCE ,
464 は Linux (glibc) 固有である。
467 は Linux/glibc 固有のヘッダファイルである。
468 他のシステムにも同様の目的のファイルがあるが、普通は違う名前である。
469 このヘッダファイルは、他のヘッダファイルにより必要に応じて
470 自動的にインクルードされる。機能検査マクロを利用するために
473 上記の機能検査マクロのうちどれが定義されたかにしたがって、
475 は、他の glibc ヘッダファイルでチェックされる各種の他のマクロを、
476 内部で定義する。これらのマクロの名前はアンダースコア 2つで始まる
479 ユーザプログラムはこれらのマクロを \fI決して\fP 直接定義すべきではない。
480 代わりに、上記のリストにある適切な機能検査マクロを利用すべきである。
482 下記のプログラムを使うと、各種の機能検査マクロが glibc のバージョン
483 に応じてどのように設定されるかや、どの機能検査マクロが明示的に
486 glibc 2.10 のシステムでの実行結果の例である。
492 _POSIX_SOURCE defined
493 _POSIX_C_SOURCE defined: 200809L
496 _ATFILE_SOURCE defined
497 $ \fBcc -D_XOPEN_SOURCE=500 ftm.c\fP
499 _POSIX_SOURCE defined
500 _POSIX_C_SOURCE defined: 199506L
501 _XOPEN_SOURCE defined: 500
502 $ \fBcc -D_GNU_SOURCE ftm.c\fP
504 _POSIX_SOURCE defined
505 _POSIX_C_SOURCE defined: 200809L
506 _ISOC99_SOURCE defined
507 _XOPEN_SOURCE defined: 700
508 _XOPEN_SOURCE_EXTENDED defined
509 _LARGEFILE64_SOURCE defined
512 _ATFILE_SOURCE defined
526 main(int argc, char *argv[])
529 printf("_POSIX_SOURCE defined\\n");
532 #ifdef _POSIX_C_SOURCE
533 printf("_POSIX_C_SOURCE defined: %ldL\\n", (long) _POSIX_C_SOURCE);
536 #ifdef _ISOC99_SOURCE
537 printf("_ISOC99_SOURCE defined\\n");
541 printf("_XOPEN_SOURCE defined: %d\\n", _XOPEN_SOURCE);
544 #ifdef _XOPEN_SOURCE_EXTENDED
545 printf("_XOPEN_SOURCE_EXTENDED defined\\n");
548 #ifdef _LARGEFILE64_SOURCE
549 printf("_LARGEFILE64_SOURCE defined\\n");
552 #ifdef _FILE_OFFSET_BITS
553 printf("_FILE_OFFSET_BITS defined: %d\\n", _FILE_OFFSET_BITS);
557 printf("_BSD_SOURCE defined\\n");
561 printf("_SVID_SOURCE defined\\n");
564 #ifdef _ATFILE_SOURCE
565 printf("_ATFILE_SOURCE defined\\n");
569 printf("_GNU_SOURCE defined\\n");
573 printf("_REENTRANT defined\\n");
577 printf("_THREAD_SAFE defined\\n");
580 #ifdef _FORTIFY_SOURCE
581 printf("_FORTIFY_SOURCE defined\\n");
592 の "Feature Test Macros" の節。
593 .\" But beware: the info libc document is out of date (Jul 07, mtk)
595 .I /usr/include/features.h