xref: /netbsd/share/man/man9/cpu_dumpconf.9 (revision c4a72b64)
1.\"     $NetBSD: cpu_dumpconf.9,v 1.3 2002/10/14 13:43:19 wiz 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd May 24, 2002
38.Dt CPU_DUMPCONF 9
39.Os
40.Sh NAME
41.Nm cpu_dumpconf ,
42.Nm cpu_dump ,
43.Nm cpu_dumpsize ,
44.Nm dumpsys
45.Nd machine-dependent kernel core dumps
46.Sh SYNOPSIS
47.Fd #include \*[Lt]sys/types.h\*[Gt]
48.Fd #include \*[Lt]sys/systm.h\*[Gt]
49.Ft void
50.Fn cpu_dumpconf "void"
51.Ft int
52.Fn cpu_dump "int (*dump)(dev_t, daddr_t, caddr_t, size_t)" "daddr_t *blknop"
53.Ft int
54.Fn cpu_dumpsize "void"
55.Ft void
56.Fn dumpsys "void"
57.Sh DESCRIPTION
58.Fn cpu_dumpconf
59is the machine-dependent interface invoked during system bootstrap to
60determine the dump device and initialize machine-dependent kernel core
61dump state.
62Internally,
63.Fn cpu_dumpconf
64will invoke
65.Fn cpu_dumpsize
66to calculate the size of machine-dependent kernel core dump headers.
67.Pp
68.Fn dumpsys
69is invoked by
70.Fn cpu_reboot
71to dump kernel physical memory onto the dump device.
72.Fn dumpsys
73invokes
74.Fn cpu_dump
75to write the machine-dependent header to the dump device at block number
76.Fa *blknop
77using the dump device's PIO dump routine specified by the
78.Fa dump
79argument.
80.Pp
81.Fn cpu_dumpsize ,
82.Fn cpu_dump ,
83and
84.Fn dumpsys
85are parts of the machine-dependent interface, however they are not
86exported to machine-independent code.
87.Sh SEE ALSO
88.Xr cpu_reboot 9
89