xref: /freebsd/lib/libkvm/kvm_native.3 (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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.\" $FreeBSD$
26.\"
27.Dd March 15, 2017
28.Dt KVM_NATIVE 3
29.Os
30.Sh NAME
31.Nm kvm_native
32.Nd is a kvm descriptor opened on a native kernel image
33.Sh LIBRARY
34.Lb libkvm
35.Sh SYNOPSIS
36.In kvm.h
37.Ft int
38.Fn kvm_native "kvm_t *kd"
39.Sh DESCRIPTION
40The
41.Nm kvm
42library provides an interface for accessing kernel virtual memory images
43for both native kernel images
44.Pq where the ABI of the kernel executable matches the host system
45and non-native kernel images.
46The
47.Fn kvm_native
48function returns a non-zero value if the kvm descriptor
49.Fa kd
50is attached to a native kernel image;
51otherwise it returns zero.
52.Sh RETURN VALUES
53The
54.Fn kvm_native
55function returns a non-zero value if the kvm descriptor
56.Fa kd
57is attached to a native kernel image;
58otherwise it returns zero.
59.Sh SEE ALSO
60.Xr kvm 3 ,
61.Xr kvm_open2 3
62