1.\" $NetBSD: coredump_write.9,v 1.2 2006/01/12 20:20:15 wiz Exp $ 2.\" 3.\" Copyright (c) 2005 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Matt THomas. 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 COREDUMP_WRITE 9 39.Os 40.Sh NAME 41.Nm coredump_write 42.Nd common coredump write routine 43.Sh SYNOPSIS 44.In sys/signalvar.h 45.Ft int 46.Fn coredump_write "void *iocookie" "enum uio_seg segflg" \ 47"const void *data" "size_t len" 48.Sh DESCRIPTION 49.Fn coredump_write 50is used by both machine-dependent and machine-independent components 51to write information to a coredump. 52.Fa iocookie 53is an opaque pointer that was supplied to the caller of 54.Fn coredump_write . 55.Fa segflg 56indicates where the 57.Fa data 58is located, system space or user space. 59.Fa data 60points to the information to be written to the coredump. 61.Fa len 62is the amount of data to be written. 63.Pp 64.Fn coredump_write 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 70.Fn coredump_write 71can be found. 72All pathnames are relative to 73.Pa /usr/src . 74.Pp 75Process core dumps are initiated within the file 76.Pa sys/kern/kern_sig.c . 77Process core dumps for ELF 78.Nx 79binaries are performed within the files 80.Pa sys/kern/core_elf32.c 81or 82.Pa sys/kern/core_elf64.c . 83Process core dumps for other 84.Nx 85binaries are performed within the file 86.Pa sys/kern/core_netbsd.c . 87.Sh SEE ALSO 88.Xr cpu_coredump 9 89