manual/LDP_man-pages/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 .\" Japanese Version Copyright (c) 2006-2008 Akihiro MOTOKI
  24 .\" Translated 2006-04-15, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  25 .\" Updated 2007-01-05, Akihiro MOTOKI, LDP v2.43
  26 .\" Updated 2007-09-03, Akihiro MOTOKI, LDP v2.64
  27 .\" Updated 2008-08-10, Akihiro MOTOKI, LDP v3.05
  28 .\" Updated 2008-09-19, Akihiro MOTOKI, LDP v3.08
  29 .\"
  30 .TH CORE 5 2010-11-15 "Linux" "Linux Programmer's Manual"
  31 .SH 名前
  32 core \- コアダンプファイル
  33 .SH 説明
  34 ある種のシグナルを受けた場合のデフォルトのアクションは、
  35 プロセスを終了し (terminate)、
  36 .I "コアダンプファイル (core dump file)"
  37 を生成することである。コアダンプファイルは、ディスク上に生成される
  38 終了時のプロセスのメモリイメージを内容とするファイルである。
  39 このイメージをデバッガ (例えば
  40 .BR gdb (1))
  41 に読み込んで、
  42 プログラムが終了した時点のプログラムの状態を検査することができる。
  43 どのシグナルを受けたときにプロセスがコアダンプを生成するかのリストは
  44 .BR signal (7)
  45 に書かれている。
  46
  47 プロセスはソフト・リソース制限
  48 .B RLIMIT_CORE
  49 を設定することで、「コアダンプ」シグナルを受信した際に生成される
  50 コアダンプファイルのサイズに上限を課すことができる。詳細は
  51 .BR getrlimit (2)
  52 を参照。
  53
  54 コアダンプファイルが生成されない状況がいくつかある:
  55 .IP * 3
  56 プロセスがコアファイルを書き込む許可を持たない場合
  57 (デフォルトでは、コアファイルは
  58 .I core
  59 という名前で、カレント・ワーキング・ディレクトリに生成される。
  60 命名規則の詳細は下記を参照)。
  61 コアファイルを生成しようとしたディレクトリが書き込み可能でない場合、
  62 もしくは同じ名前のファイルが存在し、そのファイルが書き込み可能でも
  63 通常のファイルでもない場合 (例えば、ディレクトリやシンボリックリンク)、
  64 コアファイルの生成は失敗する。
  65 .IP *
  66 コアダンプに使おうとしたのと同じ名前の (書き込み可能な、通常の) ファイルが
  67 すでに存在し、そのファイルに対するハードリンクが 2個以上ある場合。
  68 .IP *
  69 コアダンプファイルを生成しようとしたファイルシステムがフルであるか、
  70 inode が全て使用されているか、読み込み専用でマウントされている場合。
  71 または、そのユーザのディスク使用量がそのファイルシステムの
  72 クオータ (quota) に達している。
  73 .IP *
  74 コアダンプファイルを生成しようとしたディレクトリが存在しない場合。
  75 .IP *
  76 プロセス毎のリソース制限
  77 .B RLIMIT_CORE
  78 (コアファイルのサイズ) か
  79 .B RLIMIT_FSIZE
  80 (ファイルサイズ) が 0 に設定されている場合。
  81 .BR getrlimit (2)
  82 やシェルの
  83 .I ulimit
  84 コマンドのドキュメント
  85 .RB ( csh (1)
  86 の
  87 .IR limit )
  88 を参照。
  89 .IP *
  90 プロセスが実行したバイナリファイルの読み出し許可が有効になっていない場合。
  91 .IP *
  92 プロセスが実行している set-user-ID (set-group-ID) プログラムの所有者の
  93 ユーザ (グループ) が、プロセスの実 UID (実 GID) と異なる場合
  94 (但し、
  95 .BR prctl (2)
  96 .B PR_SET_DUMPABLE
  97 操作の説明と、
  98 .BR proc (5)
  99 の
 100 .I /proc/sys/fs/suid_dumpable
 101 ファイルの説明も参照のこと)。
 102 .\" FIXME . Perhaps relocate discussion of /proc/sys/fs/suid_dumpable
 103 .\" and PR_SET_DUMPABLE to this page?
 104 .SS コアダンプファイルの名前
 105 .\" motoki XXX 同じ内容が重複して書かれている。
 106 デフォルトでは、コアダンプファイルの名前は
 107 .I core
 108 となるが、コアダンプファイルの名前を決めるのに使われるテンプレートを
 109 .I /proc/sys/kernel/core_pattern
 110 ファイルに定義することで、ファイル名を変更することができる
 111 .RI ( /proc/sys/kernel/core_pattern
 112 は Linux 2.6 および 2.4.21 以降で利用できる)。
 113 テンプレートには % 指示子 (specifier) を入れることができる。
 114 これはコアファイルが生成される際に、以下の値に置き換えられる。
 115 .PP
 116 .RS 4
 117 .PD 0
 118 .TP 4
 119 %%
 120 1 つの % 文字
 121 .TP
 122 %p
 123 ダンプされたプロセスのプロセスID (PID)
 124 .TP
 125 %u
 126 ダンプされたプロセスの実ユーザ ID (real UID)
 127 .TP
 128 %g
 129 ダンプされたプロセスの実グループ ID (real GID)
 130 .TP
 131 %s
 132 ダンプを引き起こしたシグナルの番号
 133 .TP
 134 %t
 135 ダンプ時刻、紀元 (Epoch; 1970-01-01 00:00:00 +0000 (UTC))
 136 からの秒数。
 137 .TP
 138 %h
 139 ホスト名 (\fBuname\fP(2) で返される \fInodename\fP と同じ)
 140 .TP
 141 %e
 142 実行ファイル名 (パス名のプレフィックスは含まれない)
 143 .TP
 144 %c
 145 クラッシュしたプロセスのコアファイルのサイズに関するソフトリソース上限
 146 (Linux 2.6.24 以降)
 147 .PD
 148 .RE
 149 .PP
 150 テンプレートの末尾に 1 個だけ % がある場合、
 151 その % はコアファイル名には含められない。また、上で列挙されて
 152 いない % と文字の組み合わせがあった場合も同様である。
 153 テンプレートにおける他の文字は、
 154 コアファイル名としてそのまま使われる。
 155 テンプレートには \(aq/\(aq 文字を入れることができ、
 156 ディレクトリ名の区切り文字と解釈される。
 157 結果として生成されるコアファイル名の最大サイズは 128 バイトである
 158 (2.6.19 より前のカーネルでは 64 バイト)。
 159 このファイルのデフォルト値は "core" である。
 160 以前のものとの互換性のため、
 161 .I /proc/sys/kernel/core_pattern
 162 に "%p" が含まれず、
 163 かつ
 164 .I /proc/sys/kernel/core_uses_pid
 165 (下記参照) が 0 でない場合は、.PID がコアファイル名に追加される。
 166
 167 バージョン 2.4 以降の Linux では
 168 コアダンプファイルの名前を制御する原始的な方法も提供されている。
 169 .I /proc/sys/kernel/core_uses_pid
 170 ファイルに値 0 が書かれている場合、コアダンプファイルは単純に
 171 .I core
 172 という名前になる。このファイルに 0 以外の値が書かれている場合、
 173 コアダンプファイルは
 174 .I core.PID
 175 という形式の名前になり、ファイル名にプロセス ID が含まれる。
 176 .SS コアダンプのプログラムへのパイプ
 177 カーネル 2.6.19 以降では、Linux は
 178 .I /proc/sys/kernel/core_pattern
 179 ファイルの別の構文をサポートしている。
 180 このファイルの最初の文字がパイプ記号 (\fB|\fP) であれば、
 181 その行の残りの部分は実行するプログラムとして解釈される。
 182 コアダンプは、ディスク上のファイルに書き込まれるのではなく、
 183 プログラムの標準入力として渡される。
 184 以下の点に注意すること。
 185 .IP * 3
 186 プログラムは絶対パス名 (もしくはルートディレクトリ \fI/\fP からの
 187 相対パス名) で指定されなければならない。
 188 また、'|' 文字の直後から始めなければならない。
 189 .IP *
 190 プログラムを実行するために生成されるプロセスは、
 191 ユーザ、グループとも
 192 .I root
 193 として実行される。
 194 .IP *
 195 コマンドライン引き数をプログラムに与えることができ (カーネル 2.6.24 以降)、
 196 引き数はホワイトスペースで区切る
 197 (1行の最大長は 128 バイトが上限である)。
 198 .IP *
 199 コマンドライン引き数には、上記のリストにある % 指示子を含めることができる。
 200 例えば、ダンプされるプロセスの PID を渡すには、
 201 引き数に
 202 .I %p
 203 を指定する。
 204 .SS どのマッピングをコアダンプに書き込むかを制御する
 205 カーネル 2.6.23 以降では、Linux 固有のファイル
 206 .I /proc/PID/coredump_filter
 207 を使って、対応するプロセス ID を持つプロセスに対してコアダンプが行われる
 208 際に、どのメモリセグメントをコアダンプファイルに書き込むかを制御できる。
 209
 210 このファイルの値はメモリマッピング種別
 211 .RB ( mmap (2)
 212 参照) のビットマスクである。
 213 マスク内のあるビットがセットされると、そのビットに対応する種別の
 214 メモリマッピングがダンプされる。セットされていないものはダンプされない。
 215 このファイルの各ビットは以下の意味を持つ。
 216 .PP
 217 .PD 0
 218 .RS 4
 219 .TP
 220 bit 0
 221 無名のプライベートマッピング (anonymous private mappings) をダンプする。
 222 .TP
 223 bit 1
 224 無名の共有マッピング (anonymous shared mappings) をダンプする。
 225 .TP
 226 bit 2
 227 ファイルと関連付けられたプライベートマッピング
 228 (file-backed private mappings) をダンプする。
 229 .TP
 230 bit 3
 231 ファイルと関連付けられた共有マッピング
 232 (file-backed shared mappings) をダンプする。
 233 .\" file-backed shared mappings of course also update the underlying
 234 .\" mapped file.
 235 .TP
 236 bit 4 (Linux 2.6.24 以降)
 237 ELF ヘッダをダンプする。
 238 .TP
 239 bit 5 (Linux 2.6.28 以降)
 240 プライベートなヒュージページ (private huge page) をダンプする。
 241 .TP
 242 bit 6 (Linux 2.6.28 以降)
 243 共有されたヒュージページ (shared huge page) をダンプする。
 244 .RE
 245 .PD
 246 .PP
 247 デフォルトでは、ビット 0, 1, 4, 5 がセットされる。
 248 (ビット 4 がセットされるのは、カーネルが設定オプション
 249 .B CONFIG_CORE_DUMP_DEFAULT_ELF_HEADERS
 250 を有効にして作成された場合である)。
 251 このファイルの値は 16 進形式で表示される
 252 (したがって、デフォルト値は 33 と表示される)。
 253
 254 .I coredump_filter
 255 の値に関わらず、フレームバッファなどの memory-mapped I/O に関する
 256 ページは決してダンプされず、仮想 DSO ページは常にダンプされる。
 257
 258 .BR fork (2)
 259 で作成される子プロセスは親プロセスの
 260 .I coredump_filter
 261 の値を継承する。
 262 .BR execve (2)
 263 の前後で
 264 .I coredump_filter
 265 の値は保持される。
 266
 267 例のように、プログラムを実行する前に親シェルの
 268 .I coredump_filter
 269 を設定しておくと役立つことがある。
 270
 271 .in +4n
 272 .nf
 273 .RB "$" " echo 0x7 > /proc/self/coredump_filter"
 274 .RB "$" " ./some_program"
 275 .fi
 276 .in
 277 .PP
 278 このファイルが提供されるのは、カーネルが設定オプション
 279 .B CONFIG_ELF_CORE
 280 を有効にして作成された場合だけである。
 281 .SH 備考
 282 .BR gdb (1)
 283 の
 284 .I gcore
 285 コマンドを使用すると、実行中のプロセスのコアダンプを取得できる。
 286
 287 マルチスレッドプロセス
 288 (より正確には、
 289 .BR clone (2)
 290 の
 291 .B CLONE_VM
 292 で生成された別プロセスとメモリを共有しているプロセス)
 293 がコアダンプを生成する場合、
 294 コアファイル名にプロセス ID が必ず付加される。
 295 ただし、
 296 .I /proc/sys/kernel/core_pattern
 297 の %p 指定によりコアファイル名のどこか他の場所にプロセス ID が
 298 すでに含まれている場合は、プロセス ID が末尾に付加されない。
 299 (この機能がまず役に立つのは LinuxThreads 実装を利用している場合である。
 300 LinuxThreads 実装では、プロセス内の個々のスレッドは異なるプロセス ID
 301 を持つ。)
 302 .\" Always including the PID in the name of the core file made
 303 .\" sense for LinuxThreads, where each thread had a unique PID,
 304 .\" but doesn't seem to serve any purpose with NPTL, where all the
 305 .\" threads in a process share the same PID (as POSIX.1 requires).
 306 .\" Probably the behavior is maintained so that applications using
 307 .\" LinuxThreads continue appending the PID (the kernel has no easy
 308 .\" way of telling which threading implementation the userspace
 309 .\" application is using). -- mtk, April 2006
 310 .SH 例
 311 以下のプログラムは
 312 .I /proc/sys/kernel/core_pattern
 313 ファイルのパイプ構文の使用例を示している。
 314 以下のシェルのセッションはこのプログラムの使用例を示すものである
 315 (コンパイルして
 316 .I core_pattern_pipe_test
 317 という名前の実行ファイルを作成している)。
 318 .PP
 319 .in +4n
 320 .nf
 321 .RB "$" " cc \-o core_pattern_pipe_test core_pattern_pipe_test.c"
 322 .RB "$" " su"
 323 Password:
 324 .RB "#" " echo \(dq|$PWD/core_pattern_pipe_test %p \
 325 UID=%u GID=%g sig=%s\(dq > \e"
 326 .B "    /proc/sys/kernel/core_pattern"
 327 .RB "#" " exit"
 328 .RB "$" " sleep 100"
 329 .BR "^\e" "                     # type control-backslash"
 330 Quit (core dumped)
 331 .RB "$" " cat core.info"
 332 argc=5
 333 argc[0]=</home/mtk/core_pattern_pipe_test>
 334 argc[1]=<20575>
 335 argc[2]=<UID=1000>
 336 argc[3]=<GID=100>
 337 argc[4]=<sig=3>
 338 Total bytes in core dump: 282624
 339 .fi
 340 .in
 341 .SS プログラムのソース
 342 \&
 343 .nf
 344 /* core_pattern_pipe_test.c */
 345
 346 #define _GNU_SOURCE
 347 #include <sys/stat.h>
 348 #include <fcntl.h>
 349 #include <limits.h>
 350 #include <stdio.h>
 351 #include <stdlib.h>
 352 #include <unistd.h>
 353
 354 #define BUF_SIZE 1024
 355
 356 int
 357 main(int argc, char *argv[])
 358 {
 359     int tot, j;
 360     ssize_t nread;
 361     char buf[BUF_SIZE];
 362     FILE *fp;
 363     char cwd[PATH_MAX];
 364
 365     /* Change our current working directory to that of the
 366        crashing process */
 367
 368     snprintf(cwd, PATH_MAX, "/proc/%s/cwd", argv[1]);
 369     chdir(cwd);
 370
 371     /* Write output to file "core.info" in that directory */
 372
 373     fp = fopen("core.info", "w+");
 374     if (fp == NULL)
 375         exit(EXIT_FAILURE);
 376
 377     /* Display command\-line arguments given to core_pattern
 378        pipe program */
 379
 380     fprintf(fp, "argc=%d\\n", argc);
 381     for (j = 0; j < argc; j++)
 382         fprintf(fp, "argc[%d]=<%s>\\n", j, argv[j]);
 383
 384     /* Count bytes in standard input (the core dump) */
 385
 386     tot = 0;
 387     while ((nread = read(STDIN_FILENO, buf, BUF_SIZE)) > 0)
 388         tot += nread;
 389     fprintf(fp, "Total bytes in core dump: %d\\n", tot);
 390
 391     exit(EXIT_SUCCESS);
 392 }
 393 .fi
 394 .SH 関連項目
 395 .BR bash (1),
 396 .BR gdb (1),
 397 .BR getrlimit (2),
 398 .BR mmap (2),
 399 .BR prctl (2),
 400 .BR sigaction (2),
 401 .BR elf (5),
 402 .BR proc (5),
 403 .BR pthreads (7),
 404 .BR signal (7)