share/man/man5/core.5

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)core.5      8.3 (Berkeley) 12/11/93
  29 .\"
  30 .Dd October 5, 2021
  31 .Dt CORE 5
  32 .Os
  33 .Sh NAME
  34 .Nm core
  35 .Nd memory image file format
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .Sh DESCRIPTION
  39 A small number of signals which cause abnormal termination of a process
  40 also cause a record of the process's in-core state to be written
  41 to disk for later examination by one of the available debuggers.
  42 (See
  43 .Xr sigaction 2 . )
  44 This memory image is written to a file named by default
  45 .Nm programname.core
  46 in the working directory;
  47 provided the terminated process had write permission in the directory,
  48 and provided the abnormality did not cause
  49 a system crash.
  50 (In this event, the decision to save the core file is arbitrary, see
  51 .Xr savecore 8 . )
  52 .Pp
  53 The maximum size of a core file is limited by the
  54 .Dv RLIMIT_CORE
  55 .Xr setrlimit 2
  56 limit.
  57 Files which would be larger than the limit are not created.
  58 .Pp
  59 With a large limit, a process that had mapped a very large,
  60 and perhaps sparsely populated, virtual memory region, could take
  61 a very long time to create core dumps.
  62 The system ignores all signals sent to a process writing a core file, except
  63 .Dv SIGKILL
  64 which terminates the writing and causes immediate exit of the process.
  65 The behavior of
  66 .Dv SIGKILL
  67 can be disabled by setting tunable
  68 .Xr sysctl 8
  69 variable
  70 .Va kern.core_dump_can_intr
  71 to zero.
  72 .Pp
  73 The name of the file is controlled via the
  74 .Xr sysctl 8
  75 variable
  76 .Va kern.corefile .
  77 The contents of this variable describes a filename to store
  78 the core image to.
  79 This filename can be absolute, or relative (which
  80 will resolve to the current working directory of the program
  81 generating it).
  82 .Pp
  83 The following format specifiers may be used in the
  84 .Va kern.corefile
  85 sysctl to insert additional information into the resulting core
  86 filename:
  87 .Bl -tag -width "1234567890" -compact -offset "12345"
  88 .It Em \&%H
  89 Machine hostname.
  90 .It Em \&%I
  91 An index starting at zero until the sysctl
  92 .Em debug.ncores
  93 is reached.
  94 This can be useful for limiting the number of corefiles
  95 generated by a particular process.
  96 .It Em \&%N
  97 process name.
  98 .It Em \&%P
  99 processes PID.
 100 .It Em \&%S
 101 signal during core.
 102 .It Em \&%U
 103 process UID.
 104 .El
 105 .Pp
 106 The name defaults to
 107 .Em \&%N.core ,
 108 yielding the traditional
 109 .Fx
 110 behaviour.
 111 .Pp
 112 By default, a process that changes user or group credentials whether
 113 real or effective will not create a corefile.
 114 This behaviour can be
 115 changed to generate a core dump by setting the
 116 .Xr sysctl 8
 117 variable
 118 .Va kern.sugid_coredump
 119 to 1.
 120 .Pp
 121 Corefiles can be compressed by the kernel if the following item
 122 is included in the kernel configuration file:
 123 .Bl -tag -width "1234567890" -compact -offset "12345"
 124 .It options
 125 GZIO
 126 .El
 127 .Pp
 128 The following sysctl control core file compression:
 129 .Bl -tag -width "kern.compress_user_cores_level" -compact -offset "12345"
 130 .It Em kern.compress_user_cores
 131 Enable compression of user cores.
 132 A value of 1 configures
 133 .Xr gzip 1
 134 compression,
 135 and a value of 2 configures
 136 .Xr zstd 1
 137 compression.
 138 Compressed core files will have a suffix of
 139 .Ql .gz
 140 or
 141 .Ql .zst
 142 appended to their filenames depending on the selected format.
 143 .It Em kern.compress_user_cores_level
 144 Compression level.
 145 Defaults to 6.
 146 .El
 147 .Sh NOTES
 148 Corefiles are written with open file descriptor information as an ELF note.
 149 By default, file paths are packed to only use as much space as needed.
 150 However, file paths can change at any time, including during core dump,
 151 and this can result in truncated file descriptor data.
 152 .Pp
 153 All file descriptor information can be preserved by disabling packing.
 154 This potentially wastes up to PATH_MAX bytes per open fd.
 155 Packing is disabled with
 156 .Dl sysctl kern.coredump_pack_fileinfo=0 .
 157 .Pp
 158 Similarly, corefiles are written with vmmap information as an ELF note, which
 159 contains file paths.
 160 By default, they are packed to only use as much space as
 161 needed.
 162 By the same mechanism as for the open files note, these paths can also
 163 change at any time and result in a truncated note.
 164 .Pp
 165 All vmmap information can be preserved by disabling packing.
 166 Like the file information, this potentially wastes up to PATH_MAX bytes per
 167 mapped object.
 168 Packing is disabled with
 169 .Dl sysctl kern.coredump_pack_vmmapinfo=0 .
 170 .Sh EXAMPLES
 171 In order to store all core images in per-user private areas under
 172 .Pa /var/coredumps ,
 173 the following
 174 .Xr sysctl 8
 175 command can be used:
 176 .Pp
 177 .Dl sysctl kern.corefile=/var/coredumps/\&%U/\&%N.core
 178 .Sh SEE ALSO
 179 .Xr gdb 1 Pq Pa ports/devel/gdb ,
 180 .Xr gzip 1 ,
 181 .Xr kgdb 1 Pq Pa ports/devel/gdb ,
 182 .Xr setrlimit 2 ,
 183 .Xr sigaction 2 ,
 184 .Xr sysctl 8
 185 .Sh HISTORY
 186 A
 187 .Nm
 188 file format appeared in
 189 .At v1 .