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