xref: /freebsd/lib/libkvm/kvm_native.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\"
2.\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd March 15, 2017
26.Dt KVM_NATIVE 3
27.Os
28.Sh NAME
29.Nm kvm_native
30.Nd is a kvm descriptor opened on a native kernel image
31.Sh LIBRARY
32.Lb libkvm
33.Sh SYNOPSIS
34.In kvm.h
35.Ft int
36.Fn kvm_native "kvm_t *kd"
37.Sh DESCRIPTION
38The
39.Nm kvm
40library provides an interface for accessing kernel virtual memory images
41for both native kernel images
42.Pq where the ABI of the kernel executable matches the host system
43and non-native kernel images.
44The
45.Fn kvm_native
46function returns a non-zero value if the kvm descriptor
47.Fa kd
48is attached to a native kernel image;
49otherwise it returns zero.
50.Sh RETURN VALUES
51The
52.Fn kvm_native
53function returns a non-zero value if the kvm descriptor
54.Fa kd
55is attached to a native kernel image;
56otherwise it returns zero.
57.Sh SEE ALSO
58.Xr kvm 3 ,
59.Xr kvm_open2 3
60