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