original/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 .TH CORE 5 2010-11-15 "Linux" "Linux Programmer's Manual"
  24 .SH NAME
  25 core \- core dump file
  26 .SH DESCRIPTION
  27 The default action of certain signals is to cause a process to terminate
  28 and produce a
  29 .IR "core dump file" ,
  30 a disk file containing an image of the process's memory at
  31 the time of termination.
  32 This image can be used in a debugger (e.g.,
  33 .BR gdb (1))
  34 to inspect the state of the program at the time that it terminated.
  35 A list of the signals which cause a process to dump core can be found in
  36 .BR signal (7).
  37
  38 A process can set its soft
  39 .B RLIMIT_CORE
  40 resource limit to place an upper limit on the size of the core dump file
  41 that will be produced if it receives a "core dump" signal; see
  42 .BR getrlimit (2)
  43 for details.
  44
  45 There are various circumstances in which a core dump file is
  46 not produced:
  47 .IP * 3
  48 The process does not have permission to write the core file.
  49 (By default the core file is called
  50 .IR core ,
  51 and is created in the current working directory.
  52 See below for details on naming.)
  53 Writing the core file will fail if the directory in which
  54 it is to be created is nonwritable,
  55 or if a file with the same name exists and
  56 is not writable
  57 or is not a regular file
  58 (e.g., it is a directory or a symbolic link).
  59 .IP *
  60 A (writable, regular) file with the same name as would be used for the
  61 core dump already exists, but there is more than one hard link to that
  62 file.
  63 .IP *
  64 The file system where the core dump file would be created is full;
  65 or has run out of inodes; or is mounted read-only;
  66 or the user has reached their quota for the file system.
  67 .IP *
  68 The directory in which the core dump file is to be created does
  69 not exist.
  70 .IP *
  71 The
  72 .B RLIMIT_CORE
  73 (core file size) or
  74 .B RLIMIT_FSIZE
  75 (file size) resource limits for the process are set to zero; see
  76 .BR getrlimit (2)
  77 and the documentation of the shell's
  78 .I ulimit
  79 command
  80 .RI ( limit
  81 in
  82 .BR csh (1)).
  83 .IP *
  84 The binary being executed by the process does not have read
  85 permission enabled.
  86 .IP *
  87 The process is executing a set-user-ID (set-group-ID) program
  88 that is owned by a user (group) other than the real user (group)
  89 ID of the process.
  90 (However, see the description of the
  91 .BR prctl (2)
  92 .B PR_SET_DUMPABLE
  93 operation, and the description of the
  94 .I /proc/sys/fs/suid_dumpable
  95 .\" FIXME . Perhaps relocate discussion of /proc/sys/fs/suid_dumpable
  96 .\" and PR_SET_DUMPABLE to this page?
  97 file in
  98 .BR proc (5).)
  99 .SS Naming of core dump files
 100 By default, a core dump file is named
 101 .IR core ,
 102 but the
 103 .I /proc/sys/kernel/core_pattern
 104 file (since Linux 2.6 and 2.4.21)
 105 can be set to define a template that is used to name core dump files.
 106 The template can contain % specifiers which are substituted
 107 by the following values when a core file is created:
 108 .PP
 109 .RS 4
 110 .PD 0
 111 .TP 4
 112 %%
 113 a single % character
 114 .TP
 115 %p
 116 PID of dumped process
 117 .TP
 118 %u
 119 (numeric) real UID of dumped process
 120 .TP
 121 %g
 122 (numeric) real GID of dumped process
 123 .TP
 124 %s
 125 number of signal causing dump
 126 .TP
 127 %t
 128 time of dump, expressed as seconds since the
 129 Epoch, 1970-01-01 00:00:00 +0000 (UTC)
 130 .TP
 131 %h
 132 hostname (same as \fInodename\fP returned by \fBuname\fP(2))
 133 .TP
 134 %e
 135 executable filename (without path prefix)
 136 .TP
 137 %c
 138 core file size soft resource limit of crashing process (since Linux 2.6.24)
 139 .PD
 140 .RE
 141 .PP
 142 A single % at the end of the template is dropped from the
 143 core filename, as is the combination of a % followed by any
 144 character other than those listed above.
 145 All other characters in the template become a literal
 146 part of the core filename.
 147 The template may include \(aq/\(aq characters, which are interpreted
 148 as delimiters for directory names.
 149 The maximum size of the resulting core filename is 128 bytes (64 bytes
 150 in kernels before 2.6.19).
 151 The default value in this file is "core".
 152 For backward compatibility, if
 153 .I /proc/sys/kernel/core_pattern
 154 does not include "%p" and
 155 .I /proc/sys/kernel/core_uses_pid
 156 (see below)
 157 is nonzero, then .PID will be appended to the core filename.
 158
 159 Since version 2.4, Linux has also provided
 160 a more primitive method of controlling
 161 the name of the core dump file.
 162 If the
 163 .I /proc/sys/kernel/core_uses_pid
 164 file contains the value 0, then a core dump file is simply named
 165 .IR core .
 166 If this file contains a nonzero value, then the core dump file includes
 167 the process ID in a name of the form
 168 .IR core.PID .
 169 .SS Piping core dumps to a program
 170 Since kernel 2.6.19, Linux supports an alternate syntax for the
 171 .I /proc/sys/kernel/core_pattern
 172 file.
 173 If the first character of this file is a pipe symbol (\fB|\fP),
 174 then the remainder of the line is interpreted as a program to be
 175 executed.
 176 Instead of being written to a disk file, the core dump is given as
 177 standard input to the program.
 178 Note the following points:
 179 .IP * 3
 180 The program must be specified using an absolute pathname (or a
 181 pathname relative to the root directory, \fI/\fP),
 182 and must immediately follow the '|' character.
 183 .IP *
 184 The process created to run the program runs as user and group
 185 .IR root .
 186 .IP *
 187 Command-line arguments can be supplied to the
 188 program (since kernel 2.6.24),
 189 delimited by white space (up to a total line length of 128 bytes).
 190 .IP *
 191 The command-line arguments can include any of
 192 the % specifiers listed above.
 193 For example, to pass the PID of the process that is being dumped, specify
 194 .I %p
 195 in an argument.
 196 .SS Controlling which mappings are written to the core dump
 197 Since kernel 2.6.23, the Linux-specific
 198 .IR /proc/PID/coredump_filter
 199 file can be used to control which memory segments are written to the
 200 core dump file in the event that a core dump is performed for the
 201 process with the corresponding process ID.
 202
 203 The value in the file is a bit mask of memory mapping types (see
 204 .BR mmap (2)).
 205 If a bit is set in the mask, then memory mappings of the
 206 corresponding type are dumped; otherwise they are not dumped.
 207 The bits in this file have the following meanings:
 208 .PP
 209 .PD 0
 210 .RS 4
 211 .TP
 212 bit 0
 213 Dump anonymous private mappings.
 214 .TP
 215 bit 1
 216 Dump anonymous shared mappings.
 217 .TP
 218 bit 2
 219 Dump file-backed private mappings.
 220 .TP
 221 bit 3
 222 Dump file-backed shared mappings.
 223 .\" file-backed shared mappings of course also update the underlying
 224 .\" mapped file.
 225 .TP
 226 bit 4 (since Linux 2.6.24)
 227 Dump ELF headers.
 228 .TP
 229 bit 5 (since Linux 2.6.28)
 230 Dump private huge pages.
 231 .TP
 232 bit 6 (since Linux 2.6.28)
 233 Dump shared huge pages.
 234 .RE
 235 .PD
 236 .PP
 237 By default, the following bits are set: 0, 1, 4 (if the
 238 .B CONFIG_CORE_DUMP_DEFAULT_ELF_HEADERS
 239 kernel configuration option is enabled), and 5.
 240 The value of this file is displayed in hexadecimal.
 241 (The default value is thus displayed as 33.)
 242
 243 Memory-mapped I/O pages such as frame buffer are never dumped, and
 244 virtual DSO pages are always dumped, regardless of the
 245 .I coredump_filter
 246 value.
 247
 248 A child process created via
 249 .BR fork (2)
 250 inherits its parent's
 251 .I coredump_filter
 252 value;
 253 the
 254 .I coredump_filter
 255 value is preserved across an
 256 .BR execve (2).
 257
 258 It can be useful to set
 259 .I coredump_filter
 260 in the parent shell before running a program, for example:
 261
 262 .in +4n
 263 .nf
 264 .RB "$" " echo 0x7 > /proc/self/coredump_filter"
 265 .RB "$" " ./some_program"
 266 .fi
 267 .in
 268 .PP
 269 This file is only provided if the kernel was built with the
 270 .B CONFIG_ELF_CORE
 271 configuration option.
 272 .SH NOTES
 273 The
 274 .BR gdb (1)
 275 .I gcore
 276 command can be used to obtain a core dump of a running process.
 277
 278 If a multithreaded process (or, more precisely, a process that
 279 shares its memory with another process by being created with the
 280 .B CLONE_VM
 281 flag of
 282 .BR clone (2))
 283 dumps core, then the process ID is always appended to the core filename,
 284 unless the process ID was already included elsewhere in the
 285 filename via a %p specification in
 286 .IR /proc/sys/kernel/core_pattern .
 287 (This is primarily useful when employing the LinuxThreads implementation,
 288 where each thread of a process has a different PID.)
 289 .\" Always including the PID in the name of the core file made
 290 .\" sense for LinuxThreads, where each thread had a unique PID,
 291 .\" but doesn't seem to serve any purpose with NPTL, where all the
 292 .\" threads in a process share the same PID (as POSIX.1 requires).
 293 .\" Probably the behavior is maintained so that applications using
 294 .\" LinuxThreads continue appending the PID (the kernel has no easy
 295 .\" way of telling which threading implementation the userspace
 296 .\" application is using). -- mtk, April 2006
 297 .SH EXAMPLE
 298 The program below can be used to demonstrate the use of the
 299 pipe syntax in the
 300 .I /proc/sys/kernel/core_pattern
 301 file.
 302 The following shell session demonstrates the use of this program
 303 (compiled to create an executable named
 304 .IR core_pattern_pipe_test ):
 305 .PP
 306 .in +4n
 307 .nf
 308 .RB "$" " cc \-o core_pattern_pipe_test core_pattern_pipe_test.c"
 309 .RB "$" " su"
 310 Password:
 311 .RB "#" " echo \(dq|$PWD/core_pattern_pipe_test %p \
 312 UID=%u GID=%g sig=%s\(dq > \e"
 313 .B "    /proc/sys/kernel/core_pattern"
 314 .RB "#" " exit"
 315 .RB "$" " sleep 100"
 316 .BR "^\e" "                     # type control-backslash"
 317 Quit (core dumped)
 318 .RB "$" " cat core.info"
 319 argc=5
 320 argc[0]=</home/mtk/core_pattern_pipe_test>
 321 argc[1]=<20575>
 322 argc[2]=<UID=1000>
 323 argc[3]=<GID=100>
 324 argc[4]=<sig=3>
 325 Total bytes in core dump: 282624
 326 .fi
 327 .in
 328 .SS Program source
 329 \&
 330 .nf
 331 /* core_pattern_pipe_test.c */
 332
 333 #define _GNU_SOURCE
 334 #include <sys/stat.h>
 335 #include <fcntl.h>
 336 #include <limits.h>
 337 #include <stdio.h>
 338 #include <stdlib.h>
 339 #include <unistd.h>
 340
 341 #define BUF_SIZE 1024
 342
 343 int
 344 main(int argc, char *argv[])
 345 {
 346     int tot, j;
 347     ssize_t nread;
 348     char buf[BUF_SIZE];
 349     FILE *fp;
 350     char cwd[PATH_MAX];
 351
 352     /* Change our current working directory to that of the
 353        crashing process */
 354
 355     snprintf(cwd, PATH_MAX, "/proc/%s/cwd", argv[1]);
 356     chdir(cwd);
 357
 358     /* Write output to file "core.info" in that directory */
 359
 360     fp = fopen("core.info", "w+");
 361     if (fp == NULL)
 362         exit(EXIT_FAILURE);
 363
 364     /* Display command\-line arguments given to core_pattern
 365        pipe program */
 366
 367     fprintf(fp, "argc=%d\\n", argc);
 368     for (j = 0; j < argc; j++)
 369         fprintf(fp, "argc[%d]=<%s>\\n", j, argv[j]);
 370
 371     /* Count bytes in standard input (the core dump) */
 372
 373     tot = 0;
 374     while ((nread = read(STDIN_FILENO, buf, BUF_SIZE)) > 0)
 375         tot += nread;
 376     fprintf(fp, "Total bytes in core dump: %d\\n", tot);
 377
 378     exit(EXIT_SUCCESS);
 379 }
 380 .fi
 381 .SH SEE ALSO
 382 .BR bash (1),
 383 .BR gdb (1),
 384 .BR getrlimit (2),
 385 .BR mmap (2),
 386 .BR prctl (2),
 387 .BR sigaction (2),
 388 .BR elf (5),
 389 .BR proc (5),
 390 .BR pthreads (7),
 391 .BR signal (7)