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