xref: /titanic_44/usr/src/man/man3kvm/kvm_kread.3kvm (revision 56b2bdd1f04d465cfe4a95b88ae5cba5884154e4)
te
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
KVM_KREAD 3KVM "May 2, 2002"
NAME
kvm_kread, kvm_kwrite, kvm_uread, kvm_uwrite - copy data to or from a kernel image or running system
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lkvm [ library.\|.\|.]
#include <kvm.h>

ssize_t kvm_kread(kvm_t *kd, uintptr_t addr, void *buf, size_t nbytes);

ssize_t kvm_kwrite(kvm_t *kd, uintptr_t addr, void *buf, size_t nbytes);

ssize_t kvm_uread(kvm_t *kd, uintptr_t addr, void *buf, size_t nbytes);

ssize_t kvm_uwrite(kvm_t *kd, uintptr_t addr, void *buf, size_t nbytes);
DESCRIPTION

The kvm_kread() function transfers data from the kernel address space to the address space of the process. nbytes bytes of data are copied from the kernel virtual address given by addr to the buffer pointed to by buf.

The kvm_kwrite() function is like kvm_kread(), except that the direction of the transfer is reversed. To use this function, the kvm_open(3KVM) call that returned kd must have specified write access.

The kvm_uread() function transfers data from the address space of the processes specified in the most recent kvm_getu(3KVM) call. nbytes bytes of data are copied from the user virtual address given by addr to the buffer pointed to by buf.

The kvm_uwrite() function is like kvm_uread(), except that the direction of the transfer is reversed. To use this function, the kvm_open(3KVM) call that returned kd must have specified write access. The address is resolved in the address space of the process specified in the most recent kvm_getu(3KVM) call.

RETURN VALUES

On success, these functions return the number of bytes actually transferred. On failure, they return -1.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Stable
MT-Level Unsafe
SEE ALSO

kvm_getu(3KVM), kvm_nlist(3KVM), kvm_open(3KVM), attributes(5)