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