1.\" $NetBSD: kvm_read.3,v 1.2 1996/03/18 22:34:01 thorpej Exp $ 2.\" 3.\" Copyright (c) 1992, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software developed by the Computer Systems 7.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract 8.\" BG 91-66 and contributed to Berkeley. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgement: 20.\" This product includes software developed by the University of 21.\" California, Berkeley and its contributors. 22.\" 4. Neither the name of the University nor the names of its contributors 23.\" may be used to endorse or promote products derived from this software 24.\" without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36.\" SUCH DAMAGE. 37.\" 38.\" @(#)kvm_read.3 8.1 (Berkeley) 6/4/93 39.\" 40.Dd June 4, 1993 41.Dt KVM_READ 3 42.Os 43.Sh NAME 44.Nm kvm_read , 45.Nm kvm_write 46.Nd read or write kernel virtual memory 47.Sh SYNOPSIS 48.Fd #include <kvm.h> 49.Ft ssize_t 50.Fn kvm_read "kvm_t *kd" "u_long addr" "void *buf" "size_t nbytes" 51.Ft ssize_t 52.Fn kvm_write "kvm_t *kd" "u_long addr" "const void *buf" "size_t nbytes" 53.Sh DESCRIPTION 54The 55.Fn kvm_read 56and 57.Fn kvm_write 58functions are used to read and write kernel virtual memory (or a crash 59dump file). See 60.Fn kvm_open 3 61or 62.Fn kvm_openfiles 3 63for information regarding opening kernel virtual memory and crash dumps. 64.Pp 65The 66.Fn kvm_read 67function transfers 68.Fa nbytes 69bytes of data from 70the kernel space address 71.Fa addr 72to 73.Fa buf . 74Conversely, 75.Fn kvm_write 76transfers data from 77.Fa buf 78to 79.Fa addr . 80Unlike their SunOS counterparts, these functions cannot be used to 81read or write process address spaces. 82.Sh RETURN VALUES 83Upon success, the number of bytes actually transferred is returned. 84Otherwise, -1 is returned. 85.Sh SEE ALSO 86.Xr kvm 3 , 87.Xr kvm_close 3 , 88.Xr kvm_getargv 3 , 89.Xr kvm_getenvv 3 , 90.Xr kvm_geterr 3 , 91.Xr kvm_getprocs 3 , 92.Xr kvm_nlist 3 , 93.Xr kvm_open 3 , 94.Xr kvm_openfiles 3 95