1.\" $NetBSD: cpu_coredump.9,v 1.10 2010/12/02 12:54:13 wiz 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.\" 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 December 24, 2005 31.Dt CPU_COREDUMP 9 32.Os 33.Sh NAME 34.Nm cpu_coredump 35.Nd machine-dependent process core dump interface 36.Sh SYNOPSIS 37.In sys/signalvar.h 38.Ft int 39.Fn cpu_coredump "struct lwp *l" "void *iocookie" "struct core *chdr" 40.Ft int 41.Fn cpu_coredump32 "struct lwp *l" "void *iocookie" "struct core32 *chdr" 42.Sh DESCRIPTION 43.Fn cpu_coredump 44is the machine-dependent interface invoked by machine-independent code 45to dump the machine-dependent header information at the start of a 46process core dump. 47The header information primarily consists of the 48CPU and floating-point registers. 49.Fa l 50is the lwp structure of the thread being dumped. 51.Fa iocookie 52is an opaque pointer to be passed to 53.Fn coredump_write . 54Information about the machine-dependent header sections are returned in 55.Fa chdr . 56.Pp 57.Fn cpu_coredump 58returns 0 on success and an appropriate error code on failure. 59.Sh CODE REFERENCES 60Process core dumps are initiated within the file 61.Pa sys/kern/kern_sig.c . 62Process core dumps for ELF 63.Nx 64binaries are performed within the files 65.Pa sys/kern/core_elf32.c 66or 67.Pa sys/kern/core_elf64.c . 68Process core dumps for other 69.Nx 70binaries are performed within the file 71.Pa sys/kern/core_netbsd.c . 72.Sh SEE ALSO 73.Xr coredump_write 9 74