release/man5/core.5

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