43e0efbdeb
difficult to read and understand. Most manuals of English style therefore say that you should use "use".
82 lines
3.3 KiB
Groff
82 lines
3.3 KiB
Groff
.\" $NetBSD: cpu_coredump.9,v 1.5 2003/02/04 22:38:18 perry Exp $
|
|
.\"
|
|
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Gregory McGarry.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the NetBSD
|
|
.\" Foundation, Inc. and its contributors.
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
.\" contributors may be used to endorse or promote products derived
|
|
.\" from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd May 24, 2002
|
|
.Dt CPU_COREDUMP 9
|
|
.Os
|
|
.Sh NAME
|
|
.Nm cpu_coredump
|
|
.Nd machine-dependent process core dump interface
|
|
.Sh SYNOPSIS
|
|
.Fd #include \*[Lt]sys/signalvar.h\*[Gt]
|
|
.Ft int
|
|
.Fn cpu_coredump "struct proc *p" "struct vnode *vp" "struct ucred *cred" \
|
|
"struct core *chdr"
|
|
.Sh DESCRIPTION
|
|
.Fn cpu_coredump
|
|
is the machine-dependent interface invoked by machine-independent code
|
|
to dump the machine-dependent header information at the start of a
|
|
process core dump.
|
|
The header information primarily consists of the
|
|
CPU and floating-point registers.
|
|
.Fa p
|
|
is the process structure of the processing being dumped.
|
|
.Fa vp
|
|
is the vnode pointer to the process core dump file.
|
|
.Fa cred
|
|
are the credentials of the core dump file.
|
|
Information about the machine-dependent header sections are returned in
|
|
.Fa chdr .
|
|
.Pp
|
|
.Fn cpu_coredump
|
|
returns 0 on success and an appropriate error code on failure.
|
|
.Sh CODE REFERENCES
|
|
This section describes places within the
|
|
.Nx
|
|
source tree where actual code implementing or using the
|
|
machine-dependent coredump interface can be found.
|
|
All pathnames are relative to
|
|
.Pa /usr/src .
|
|
.Pp
|
|
Process core dumps are initiated within the file
|
|
.Pa sys/kern/kern_sig.c .
|
|
Process core dumps for native
|
|
.Nx
|
|
binaries are performed within the file
|
|
.Pa sys/kern/core_netbsd.c .
|
|
.Sh SEE ALSO
|
|
.Xr vnode 9
|