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