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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)core.5      8.3 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/share/man/man5/core.5,v 1.8.2.5 2003/01/07 22:03:50 keramida Exp $
  34 .\" $DragonFly: src/share/man/man5/core.5,v 1.4 2006/05/26 19:39:40 swildner Exp $
  35 .\"
  36 .Dd January 9, 2002
  37 .Dt CORE 5
  38 .Os
  39 .Sh NAME
  40 .Nm core
  41 .Nd memory image file format
  42 .Sh SYNOPSIS
  43 .In sys/param.h
  44 .Sh DESCRIPTION
  45 A small number of signals which cause abnormal termination of a process
  46 also cause a record of the process's in-core state to be written
  47 to disk for later examination by one of the available debuggers.
  48 (See
  49 .Xr sigaction 2 . )
  50 This memory image is written to a file named by default
  51 .Nm programname.core
  52 in the working directory;
  53 provided the terminated process had write permission in the directory,
  54 and provided the abnormality did not cause
  55 a system crash.
  56 (In this event, the decision to save the core file is arbitrary, see
  57 .Xr savecore 8 . )
  58 .Pp
  59 The maximum size of a core file is limited by
  60 .Xr setrlimit 2 .
  61 Files which would be larger than the limit are not created.
  62 .Pp
  63 The name of the file is controlled via the
  64 .Xr sysctl 8
  65 variable
  66 .Va kern.corefile .
  67 The contents of this variable describes a filename to store
  68 the core image to.
  69 This filename can be absolute, or relative (which
  70 will resolve to the current working directory of the program
  71 generating it).
  72 Any sequence of
  73 .Em \&%N
  74 in this filename template will be replaced by the process name,
  75 .Em \&%P
  76 by the processes PID, and
  77 .Em \&%U
  78 by the UID.
  79 The name defaults to
  80 .Em \&%N.core ,
  81 yielding the traditional
  82 .Dx
  83 behaviour.
  84 .Pp
  85 By default, a process that changes user or group credentials whether
  86 real or effective will not create a corefile.
  87 This behaviour can be
  88 changed to generate a core dump by setting the
  89 .Xr sysctl 8
  90 variable
  91 .Va kern.sugid_coredump
  92 to 1.
  93 .Pp
  94 The core file consists of the
  95 .Fa u.
  96 area, whose size (in pages) is
  97 defined by the
  98 .Dv UPAGES
  99 manifest in the
 100 .In sys/param.h
 101 file.
 102 The
 103 .Fa u.
 104 area starts with a
 105 .Fa user
 106 structure as given in
 107 .In sys/user.h .
 108 The remainder of the core
 109 file consists of the data pages followed by
 110 the stack pages of the process image.
 111 The amount of data space image in the core
 112 file is given (in pages) by the
 113 variable
 114 .Fa u_dsize
 115 in the
 116 .Fa u.
 117 area.
 118 The amount of stack image in the core file is given (in pages) by the
 119 variable
 120 .Fa u_ssize
 121 in the
 122 .Fa u.
 123 area.
 124 The size of a ``page'' is given by the constant
 125 .Dv PAGE_SIZE
 126 (also from
 127 .In sys/param.h ) .
 128 .Sh EXAMPLES
 129 In order to store all core images in per-user private areas under
 130 .Pa /var/coredumps ,
 131 the following
 132 .Xr sysctl 8
 133 command can be used:
 134 .Pp
 135 .Dl sysctl kern.corefile="/var/coredumps/\&%U/\&%N.core"
 136 .Sh SEE ALSO
 137 .Xr gdb 1 ,
 138 .Xr kgdb 1 ,
 139 .Xr setrlimit 2 ,
 140 .Xr sigaction 2 ,
 141 .Xr sysctl 8
 142 .Sh HISTORY
 143 A
 144 .Nm
 145 file format appeared in
 146 .At v6 .