1.\" $NetBSD: cpu_coredump.9,v 1.4 2002/10/14 13:43:18 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_COREDUMP 9 39.Os 40.Sh NAME 41.Nm cpu_coredump 42.Nd machine-dependent process core dump interface 43.Sh SYNOPSIS 44.Fd #include \*[Lt]sys/signalvar.h\*[Gt] 45.Ft int 46.Fn cpu_coredump "struct proc *p" "struct vnode *vp" "struct ucred *cred" \ 47"struct core *chdr" 48.Sh DESCRIPTION 49.Fn cpu_coredump 50is the machine-dependent interface invoked by machine-independent code 51to dump the machine-dependent header information at the start of a 52process core dump. 53The header information primarily consists of the 54CPU and floating-point registers. 55.Fa p 56is the process structure of the processing being dumped. 57.Fa vp 58is the vnode pointer to the process core dump file. 59.Fa cred 60are the credentials of the core dump file. 61Information about the machine-dependent header sections are returned in 62.Fa chdr . 63.Pp 64.Fn cpu_coredump 65returns 0 on success and an appropriate error code on failure. 66.Sh CODE REFERENCES 67This section describes places within the 68.Nx 69source tree where actual code implementing or utilizing the 70machine-dependent coredump interface can be found. 71All pathnames are relative to 72.Pa /usr/src . 73.Pp 74Process core dumps are initiated within the file 75.Pa sys/kern/kern_sig.c . 76Process core dumps for native 77.Nx 78binaries are performed within the file 79.Pa sys/kern/core_netbsd.c . 80.Sh SEE ALSO 81.Xr vnode 9 82