share/man/man9/coredump_write.9

   1 .\"     $NetBSD: coredump_write.9,v 1.3 2008/04/30 13:10:58 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2005 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Matt Thomas.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd December 24, 2005
  31 .Dt COREDUMP_WRITE 9
  32 .Os
  33 .Sh NAME
  34 .Nm coredump_write
  35 .Nd common coredump write routine
  36 .Sh SYNOPSIS
  37 .In sys/signalvar.h
  38 .Ft int
  39 .Fn coredump_write "void *iocookie" "enum uio_seg segflg" \
  40 "const void *data" "size_t len"
  41 .Sh DESCRIPTION
  42 .Fn coredump_write
  43 is used by both machine-dependent and machine-independent components
  44 to write information to a coredump.
  45 .Fa iocookie
  46 is an opaque pointer that was supplied to the caller of
  47 .Fn coredump_write .
  48 .Fa segflg
  49 indicates where the
  50 .Fa data
  51 is located, system space or user space.
  52 .Fa data
  53 points to the information to be written to the coredump.
  54 .Fa len
  55 is the amount of data to be written.
  56 .Pp
  57 .Fn coredump_write
  58 returns 0 on success and an appropriate error code on failure.
  59 .Sh CODE REFERENCES
  60 This section describes places within the
  61 .Nx
  62 source tree where actual code implementing or using
  63 .Fn coredump_write
  64 can be found.
  65 All pathnames are relative to
  66 .Pa /usr/src .
  67 .Pp
  68 Process core dumps are initiated within the file
  69 .Pa sys/kern/kern_sig.c .
  70 Process core dumps for ELF
  71 .Nx
  72 binaries are performed within the files
  73 .Pa sys/kern/core_elf32.c
  74 or
  75 .Pa sys/kern/core_elf64.c .
  76 Process core dumps for other
  77 .Nx
  78 binaries are performed within the file
  79 .Pa sys/kern/core_netbsd.c .
  80 .Sh SEE ALSO
  81 .Xr cpu_coredump 9