1.\" $NetBSD: cpu_coredump.9,v 1.8 2005/12/24 21:07:05 matt Exp $ 2.\" 3.\" Copyright (c) 2002, 2005 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 December 24, 2005 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.In sys/signalvar.h 45.Ft int 46.Fn cpu_coredump "struct lwp *l" "void *iocookie" "struct core *chdr" 47.Ft int 48.Fn cpu_coredump32 "struct lwp *l" "void *iocookie" "struct core32 *chdr" 49.Sh DESCRIPTION 50.Fn cpu_coredump 51is the machine-dependent interface invoked by machine-independent code 52to dump the machine-dependent header information at the start of a 53process core dump. 54The header information primarily consists of the 55CPU and floating-point registers. 56.Fa l 57is the lwp structure of the thread being dumped. 58.Fa iocookie 59is an opaque pointer to be passed to 60.Fn coredump_write . 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 using 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 ELF 77.Nx 78binaries are performed within the files 79.Pa sys/kern/core_elf32.c 80or 81.Pa sys/kern/core_elf64.c . 82Process core dumps for other 83.Nx 84binaries are performed within the file 85.Pa sys/kern/core_netbsd.c . 86.Sh SEE ALSO 87.Xr coredump_write 9 88