share/man/man9/cpu_dumpconf.9

   1 .\"     $NetBSD: cpu_dumpconf.9,v 1.5 2007/07/30 22:48:46 alc Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Gregory McGarry.
   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 May 24, 2002
  31 .Dt CPU_DUMPCONF 9
  32 .Os
  33 .Sh NAME
  34 .Nm cpu_dumpconf ,
  35 .Nm cpu_dump ,
  36 .Nm cpu_dumpsize ,
  37 .Nm dumpsys
  38 .Nd machine-dependent kernel core dumps
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/systm.h
  42 .Ft void
  43 .Fn cpu_dumpconf "void"
  44 .Ft int
  45 .Fn cpu_dump "int (*dump)(dev_t, daddr_t, void *, size_t)" "daddr_t *blknop"
  46 .Ft int
  47 .Fn cpu_dumpsize "void"
  48 .Ft void
  49 .Fn dumpsys "void"
  50 .Sh DESCRIPTION
  51 .Fn cpu_dumpconf
  52 is the machine-dependent interface invoked during system bootstrap to
  53 determine the dump device and initialize machine-dependent kernel core
  54 dump state.
  55 Internally,
  56 .Fn cpu_dumpconf
  57 will invoke
  58 .Fn cpu_dumpsize
  59 to calculate the size of machine-dependent kernel core dump headers.
  60 .Pp
  61 .Fn dumpsys
  62 is invoked by
  63 .Fn cpu_reboot
  64 to dump kernel physical memory onto the dump device.
  65 .Fn dumpsys
  66 invokes
  67 .Fn cpu_dump
  68 to write the machine-dependent header to the dump device at block number
  69 .Fa *blknop
  70 using the dump device's PIO dump routine specified by the
  71 .Fa dump
  72 argument.
  73 .Pp
  74 .Fn cpu_dumpsize ,
  75 .Fn cpu_dump ,
  76 and
  77 .Fn dumpsys
  78 are parts of the machine-dependent interface, however they are not
  79 exported to machine-independent code.
  80 .Sh SEE ALSO
  81 .Xr cpu_reboot 9