1.\" $NetBSD: coredump_write.9,v 1.5 2010/12/02 12:54:13 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.\" 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 COREDUMP_WRITE 9 32.Os 33.Sh NAME 34.Nm coredump_write 35.Nd common coredump write routine 36.Sh SYNOPSIS 37.In sys/signalvar.h 38.Ft int 39.Fn coredump_write "void *iocookie" "enum uio_seg segflg" \ 40"const void *data" "size_t len" 41.Sh DESCRIPTION 42.Fn coredump_write 43is used by both machine-dependent and machine-independent components 44to write information to a coredump. 45.Fa iocookie 46is an opaque pointer that was supplied to the caller of 47.Fn coredump_write . 48.Fa segflg 49indicates where the 50.Fa data 51is located, system space or user space. 52.Fa data 53points to the information to be written to the coredump. 54.Fa len 55is the amount of data to be written. 56.Pp 57.Fn coredump_write 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 cpu_coredump 9 74