draft/man5/core.5

   1 .\" Copyright (c) 2006, 2008 by Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\"*******************************************************************
  26 .\"
  27 .\" This file was generated with po4a. Translate the source file.
  28 .\"
  29 .\"*******************************************************************
  30 .\"
  31 .\" Japanese Version Copyright (c) 2006-2008 Akihiro MOTOKI
  32 .\" Translated 2006-04-15, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  33 .\" Updated 2007-01-05, Akihiro MOTOKI, LDP v2.43
  34 .\" Updated 2007-09-03, Akihiro MOTOKI, LDP v2.64
  35 .\" Updated 2008-08-10, Akihiro MOTOKI, LDP v3.05
  36 .\" Updated 2008-09-19, Akihiro MOTOKI, LDP v3.08
  37 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
  38 .\" Updated 2013-05-01, Akihiro MOTOKI <amotoki@gmail.com>
  39 .\" Updated 2013-05-06, Akihiro MOTOKI <amotoki@gmail.com>
  40 .\" Updated 2013-07-24, Akihiro MOTOKI <amotoki@gmail.com>
  41 .\"
  42 .TH CORE 5 2013\-06\-08 Linux "Linux Programmer's Manual"
  43 .SH 名前
  44 core \- コアダンプファイル
  45 .SH 説明
  46 ある種のシグナルを受けた場合のデフォルトのアクションは、 プロセスを終了し (terminate)、 \fIコアダンプファイル (core dump
  47 file)\fP を生成することである。コアダンプファイルは、ディスク上に生成される 終了時のプロセスのメモリイメージを内容とするファイルである。
  48 このイメージをデバッガ (例えば \fBgdb\fP(1))  に読み込んで、 プログラムが終了した時点のプログラムの状態を検査することができる。
  49 どのシグナルを受けたときにプロセスがコアダンプを生成するかのリストは \fBsignal\fP(7)  に書かれている。
  50
  51 プロセスはソフト・リソース制限 \fBRLIMIT_CORE\fP を設定することで、「コアダンプ」シグナルを受信した際に生成される
  52 コアダンプファイルのサイズに上限を課すことができる。詳細は \fBgetrlimit\fP(2)  を参照。
  53
  54 コアダンプファイルが生成されない状況がいくつかある:
  55 .IP * 3
  56 プロセスがコアファイルを書き込む許可を持たない場合 (デフォルトでは、コアファイルは \fIcore\fP
  57 という名前で、カレント・ワーキング・ディレクトリに生成される。 命名規則の詳細は下記を参照)。
  58 コアファイルを生成しようとしたディレクトリが書き込み可能でない場合、 もしくは同じ名前のファイルが存在し、そのファイルが書き込み可能でも
  59 通常のファイルでもない場合 (例えば、ディレクトリやシンボリックリンク)、 コアファイルの生成は失敗する。
  60 .IP *
  61 コアダンプに使おうとしたのと同じ名前の (書き込み可能な、通常の) ファイルが すでに存在し、そのファイルに対するハードリンクが 2個以上ある場合。
  62 .IP *
  63 The filesystem where the core dump file would be created is full; or has run
  64 out of inodes; or is mounted read\-only; or the user has reached their quota
  65 for the filesystem.
  66 .IP *
  67 コアダンプファイルを生成しようとしたディレクトリが存在しない場合。
  68 .IP *
  69 プロセス毎のリソース制限 \fBRLIMIT_CORE\fP (コアファイルのサイズ) か \fBRLIMIT_FSIZE\fP (ファイルサイズ) が 0
  70 に設定されている場合。 \fBgetrlimit\fP(2)  やシェルの \fIulimit\fP コマンドのドキュメント (\fBcsh\fP(1)  の
  71 \fIlimit\fP)  を参照。
  72 .IP *
  73 プロセスが実行したバイナリファイルの読み出し許可が有効になっていない場合。
  74 .IP *
  75 .\" FIXME . Perhaps relocate discussion of /proc/sys/fs/suid_dumpable
  76 .\" and PR_SET_DUMPABLE to this page?
  77 プロセスが実行している set\-user\-ID (set\-group\-ID) プログラムの所有者の ユーザ (グループ) が、プロセスの実 UID (実
  78 GID) と異なる場合 (但し、 \fBprctl\fP(2)  \fBPR_SET_DUMPABLE\fP 操作の説明と、 \fBproc\fP(5)  の
  79 \fI/proc/sys/fs/suid_dumpable\fP ファイルの説明も参照のこと)。
  80 .IP *
  81 .\" commit 046d662f481830e652ac34cd112249adde16452a
  82 (Linux 3.7 以降) カーネルの設定で \fBCONFIG_COREDUMP\fP オプションが有効になっていない。
  83 .PP
  84 上記に加えて、 \fBmadvise\fP(2) の \fBMADV_DONTDUMP\fP
  85 フラグが使用されている場合、プロセスのアドレス空間の一部がコアダンプから除外される場合がある。
  86 .SS コアダンプファイルの名前
  87 デフォルトでは、コアダンプファイルの名前は \fIcore\fP となるが、コアダンプファイルの名前を決めるのに使われるテンプレートを
  88 \fI/proc/sys/kernel/core_pattern\fP ファイルに定義することで、ファイル名を変更することができる
  89 (\fI/proc/sys/kernel/core_pattern\fP は Linux 2.6 および 2.4.21 以降で利用できる)。 テンプレートには
  90 % 指示子 (specifier) を入れることができる。 これはコアファイルが生成される際に、以下の値に置き換えられる。
  91 .PP
  92 .RS 4
  93 .PD 0
  94 .TP  4
  95 %%
  96 1 つの % 文字
  97 .TP
  98 %p
  99 ダンプされたプロセスのプロセスID (PID)
 100 .TP
 101 %u
 102 ダンプされたプロセスの実ユーザ ID (real UID)
 103 .TP
 104 %g
 105 ダンプされたプロセスの実グループ ID (real GID)
 106 .TP
 107 %s
 108 ダンプを引き起こしたシグナルの番号
 109 .TP
 110 %t
 111 ダンプ時刻、紀元 (Epoch; 1970\-01\-01 00:00:00 +0000 (UTC))  からの秒数。
 112 .TP
 113 %h
 114 ホスト名 (\fBuname\fP(2) で返される \fInodename\fP と同じ)
 115 .TP
 116 %e
 117 実行ファイル名 (パス名のプレフィックスは含まれない)
 118 .TP
 119 %E
 120 実行ファイルのパス名。スラッシュ (\(aq/\(aq) は感嘆符 (\(aq!\(aq) に置き換えられる。
 121 .TP
 122 %c
 123 クラッシュしたプロセスのコアファイルのサイズに関するソフトリソース上限 (Linux 2.6.24 以降)
 124 .PD
 125 .RE
 126 .PP
 127 テンプレートの末尾に 1 個だけ % がある場合、 その % はコアファイル名には含められない。また、上で列挙されて いない %
 128 と文字の組み合わせがあった場合も同様である。 テンプレートにおける他の文字は、 コアファイル名としてそのまま使われる。 テンプレートには
 129 \(aq/\(aq 文字を入れることができ、 ディレクトリ名の区切り文字と解釈される。 結果として生成されるコアファイル名の最大サイズは 128
 130 バイトである (2.6.19 より前のカーネルでは 64 バイト)。 このファイルのデフォルト値は "core" である。 以前のものとの互換性のため、
 131 \fI/proc/sys/kernel/core_pattern\fP に "%p" が含まれず、 かつ
 132 \fI/proc/sys/kernel/core_uses_pid\fP (下記参照) が 0 でない場合は、.PID がコアファイル名に追加される。
 133
 134 バージョン 2.4 以降の Linux では コアダンプファイルの名前を制御する原始的な方法も提供されている。
 135 \fI/proc/sys/kernel/core_uses_pid\fP ファイルに値 0 が書かれている場合、コアダンプファイルは単純に \fIcore\fP
 136 という名前になる。このファイルに 0 以外の値が書かれている場合、 コアダンプファイルは \fIcore.PID\fP
 137 という形式の名前になり、ファイル名にプロセス ID が含まれる。
 138
 139 .\" 9520628e8ceb69fa9a4aee6b57f22675d9e1b709
 140 Linux 3.6 以降では、\fI/proc/sys/fs/suid_dumpable\fP が 2 ("suidsafe")
 141 に設定されている場合、テンプレートは、絶対パス名 (先頭に \(aq/\(aq 文字があるパス名) かパイプ (以下で説明)
 142 のどちらかでなければならない。
 143 .SS コアダンプのプログラムへのパイプ
 144 カーネル 2.6.19 以降では、Linux は \fI/proc/sys/kernel/core_pattern\fP
 145 ファイルの別の構文をサポートしている。 このファイルの最初の文字がパイプ記号 (\fB|\fP) であれば、
 146 その行の残りの部分は実行するプログラムとして解釈される。 コアダンプは、ディスク上のファイルに書き込まれるのではなく、
 147 プログラムの標準入力として渡される。 以下の点に注意すること。
 148 .IP * 3
 149 プログラムは絶対パス名 (もしくはルートディレクトリ \fI/\fP からの 相対パス名) で指定されなければならない。 また、'|'
 150 文字の直後から始めなければならない。
 151 .IP *
 152 プログラムを実行するために生成されるプロセスは、 ユーザ、グループとも \fIroot\fP として実行される。
 153 .IP *
 154 コマンドライン引き数をプログラムに与えることができ (Linux 2.6.24 以降)、 引き数はホワイトスペースで区切る (1行の最大長は 128
 155 バイトが上限である)。
 156 .IP *
 157 コマンドライン引き数には、上記のリストにある % 指示子を含めることができる。 例えば、ダンプされるプロセスの PID を渡すには、 引き数に
 158 \fI%p\fP を指定する。
 159 .SS どのマッピングをコアダンプに書き込むかを制御する
 160 カーネル 2.6.23 以降では、Linux 固有のファイル \fI/proc/PID/coredump_filter\fP を使って、対応するプロセス ID
 161 を持つプロセスに対してコアダンプが行われる 際に、どのメモリセグメントをコアダンプファイルに書き込むかを制御できる。
 162
 163 このファイルの値はメモリマッピング種別 (\fBmmap\fP(2)  参照) のビットマスクである。
 164 マスク内のあるビットがセットされると、そのビットに対応する種別の メモリマッピングがダンプされる。セットされていないものはダンプされない。
 165 このファイルの各ビットは以下の意味を持つ。
 166 .PP
 167 .PD 0
 168 .RS 4
 169 .TP
 170 bit 0
 171 無名のプライベートマッピング (anonymous private mappings) をダンプする。
 172 .TP
 173 bit 1
 174 無名の共有マッピング (anonymous shared mappings) をダンプする。
 175 .TP
 176 bit 2
 177 ファイルと関連付けられたプライベートマッピング (file\-backed private mappings) をダンプする。
 178 .TP
 179 bit 3
 180 .\" file-backed shared mappings of course also update the underlying
 181 .\" mapped file.
 182 ファイルと関連付けられた共有マッピング (file\-backed shared mappings) をダンプする。
 183 .TP
 184 bit 4 (Linux 2.6.24 以降)
 185 ELF ヘッダをダンプする。
 186 .TP
 187 bit 5 (Linux 2.6.28 以降)
 188 プライベートなヒュージページ (private huge page) をダンプする。
 189 .TP
 190 bit 6 (Linux 2.6.28 以降)
 191 共有されたヒュージページ (shared huge page) をダンプする。
 192 .RE
 193 .PD
 194 .PP
 195 デフォルトでは、ビット 0, 1, 4, 5 がセットされる。 (ビット 4 がセットされるのは、カーネルが設定オプション
 196 \fBCONFIG_CORE_DUMP_DEFAULT_ELF_HEADERS\fP を有効にして作成された場合である)。 このファイルの値は 16
 197 進形式で表示される (したがって、デフォルト値は 33 と表示される)。
 198
 199 \fIcoredump_filter\fP の値に関わらず、フレームバッファなどの memory\-mapped I/O に関する
 200 ページは決してダンプされず、仮想 DSO ページは常にダンプされる。
 201
 202 \fBfork\fP(2)  で作成される子プロセスは親プロセスの \fIcoredump_filter\fP の値を継承する。 \fBexecve\fP(2)
 203 の前後で \fIcoredump_filter\fP の値は保持される。
 204
 205 例のように、プログラムを実行する前に親シェルの \fIcoredump_filter\fP を設定しておくと役立つことがある。
 206
 207 .in +4n
 208 .nf
 209 $\fB echo 0x7 > /proc/self/coredump_filter\fP
 210 $\fB ./some_program\fP
 211 .fi
 212 .in
 213 .PP
 214 このファイルが提供されるのは、カーネルが設定オプション \fBCONFIG_ELF_CORE\fP を有効にして作成された場合だけである。
 215 .SH 注意
 216 \fBgdb\fP(1)  の \fIgcore\fP コマンドを使用すると、実行中のプロセスのコアダンプを取得できる。
 217
 218 .\" Changed with commit 6409324b385f3f63a03645b4422e3be67348d922
 219 .\" Always including the PID in the name of the core file made
 220 .\" sense for LinuxThreads, where each thread had a unique PID,
 221 .\" but doesn't seem to serve any purpose with NPTL, where all the
 222 .\" threads in a process share the same PID (as POSIX.1 requires).
 223 .\" Probably the behavior is maintained so that applications using
 224 .\" LinuxThreads continue appending the PID (the kernel has no easy
 225 .\" way of telling which threading implementation the user-space
 226 .\" application is using). -- mtk, April 2006
 227 バージョン 2.6.27 以前の Linux では、 マルチスレッドプロセス (より正確には、 \fBclone\fP(2)  の \fBCLONE_VM\fP
 228 で生成された別プロセスとメモリを共有しているプロセス)  がコアダンプを生成する場合、 コアファイル名にプロセス ID が必ず付加される。 ただし、
 229 \fI/proc/sys/kernel/core_pattern\fP の %p 指定によりコアファイル名のどこか他の場所にプロセス ID が
 230 すでに含まれている場合は、プロセス ID が末尾に付加されない。 (この機能が主に役に立つのはすでに使われなくなった LinuxThreads
 231 実装を利用している場合である。 LinuxThreads 実装では、プロセス内の個々のスレッドは異なるプロセス ID を持つ。)
 232 .SH 例
 233 以下のプログラムは \fI/proc/sys/kernel/core_pattern\fP ファイルのパイプ構文の使用例を示している。
 234 以下のシェルのセッションはこのプログラムの使用例を示すものである (コンパイルして \fIcore_pattern_pipe_test\fP
 235 という名前の実行ファイルを作成している)。
 236 .PP
 237 .in +4n
 238 .nf
 239 $\fB cc \-o core_pattern_pipe_test core_pattern_pipe_test.c\fP
 240 $\fB su\fP
 241 Password:
 242 #\fB echo "|$PWD/core_pattern_pipe_test %p UID=%u GID=%g sig=%s" > \e\fP
 243 \fB/proc/sys/kernel/core_pattern\fP
 244 #\fB exit\fP
 245 $\fB sleep 100\fP
 246 \fB^\e\fP                     # type control\-backslash
 247 Quit (core dumped)
 248 $\fB cat core.info\fP
 249 argc=5
 250 argc[0]=</home/mtk/core_pattern_pipe_test>
 251 argc[1]=<20575>
 252 argc[2]=<UID=1000>
 253 argc[3]=<GID=100>
 254 argc[4]=<sig=3>
 255 Total bytes in core dump: 282624
 256 .fi
 257 .in
 258 .SS プログラムのソース
 259 \&
 260 .nf
 261 /* core_pattern_pipe_test.c */
 262
 263 #define _GNU_SOURCE
 264 #include <sys/stat.h>
 265 #include <fcntl.h>
 266 #include <limits.h>
 267 #include <stdio.h>
 268 #include <stdlib.h>
 269 #include <unistd.h>
 270
 271 #define BUF_SIZE 1024
 272
 273 int
 274 main(int argc, char *argv[])
 275 {
 276     int tot, j;
 277     ssize_t nread;
 278     char buf[BUF_SIZE];
 279     FILE *fp;
 280     char cwd[PATH_MAX];
 281
 282     /* Change our current working directory to that of the
 283        crashing process */
 284
 285     snprintf(cwd, PATH_MAX, "/proc/%s/cwd", argv[1]);
 286     chdir(cwd);
 287
 288     /* Write output to file "core.info" in that directory */
 289
 290     fp = fopen("core.info", "w+");
 291     if (fp == NULL)
 292         exit(EXIT_FAILURE);
 293
 294     /* Display command\-line arguments given to core_pattern
 295        pipe program */
 296
 297     fprintf(fp, "argc=%d\en", argc);
 298     for (j = 0; j < argc; j++)
 299         fprintf(fp, "argc[%d]=<%s>\en", j, argv[j]);
 300
 301     /* Count bytes in standard input (the core dump) */
 302
 303     tot = 0;
 304     while ((nread = read(STDIN_FILENO, buf, BUF_SIZE)) > 0)
 305         tot += nread;
 306     fprintf(fp, "Total bytes in core dump: %d\en", tot);
 307
 308     exit(EXIT_SUCCESS);
 309 }
 310 .fi
 311 .SH 関連項目
 312 \fBbash\fP(1), \fBgdb\fP(1), \fBgetrlimit\fP(2), \fBmmap\fP(2), \fBprctl\fP(2),
 313 \fBsigaction\fP(2), \fBelf\fP(5), \fBproc\fP(5), \fBpthreads\fP(7), \fBsignal\fP(7)
 314 .SH この文書について
 315 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.54 の一部
 316 である。プロジェクトの説明とバグ報告に関する情報は
 317 http://www.kernel.org/doc/man\-pages/ に書かれている。