xref: /freebsd/lib/libkvm/kvm_native.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
17f911abeSJohn Baldwin.\"
27f911abeSJohn Baldwin.\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
37f911abeSJohn Baldwin.\"
47f911abeSJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
57f911abeSJohn Baldwin.\" modification, are permitted provided that the following conditions
67f911abeSJohn Baldwin.\" are met:
77f911abeSJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
87f911abeSJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
97f911abeSJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
107f911abeSJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
117f911abeSJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
127f911abeSJohn Baldwin.\"
137f911abeSJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
147f911abeSJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
157f911abeSJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
167f911abeSJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
177f911abeSJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
187f911abeSJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
197f911abeSJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
207f911abeSJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
217f911abeSJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
227f911abeSJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
237f911abeSJohn Baldwin.\" SUCH DAMAGE.
247f911abeSJohn Baldwin.\"
25*d5f024f2SEnji Cooper.Dd March 15, 2017
26*d5f024f2SEnji Cooper.Dt KVM_NATIVE 3
277f911abeSJohn Baldwin.Os
287f911abeSJohn Baldwin.Sh NAME
297f911abeSJohn Baldwin.Nm kvm_native
307f911abeSJohn Baldwin.Nd is a kvm descriptor opened on a native kernel image
317f911abeSJohn Baldwin.Sh LIBRARY
327f911abeSJohn Baldwin.Lb libkvm
337f911abeSJohn Baldwin.Sh SYNOPSIS
347f911abeSJohn Baldwin.In kvm.h
357f911abeSJohn Baldwin.Ft int
367f911abeSJohn Baldwin.Fn kvm_native "kvm_t *kd"
377f911abeSJohn Baldwin.Sh DESCRIPTION
387f911abeSJohn BaldwinThe
397f911abeSJohn Baldwin.Nm kvm
407f911abeSJohn Baldwinlibrary provides an interface for accessing kernel virtual memory images
417f911abeSJohn Baldwinfor both native kernel images
427f911abeSJohn Baldwin.Pq where the ABI of the kernel executable matches the host system
437f911abeSJohn Baldwinand non-native kernel images.
447f911abeSJohn BaldwinThe
457f911abeSJohn Baldwin.Fn kvm_native
467f911abeSJohn Baldwinfunction returns a non-zero value if the kvm descriptor
477f911abeSJohn Baldwin.Fa kd
487f911abeSJohn Baldwinis attached to a native kernel image;
497f911abeSJohn Baldwinotherwise it returns zero.
507f911abeSJohn Baldwin.Sh RETURN VALUES
517f911abeSJohn BaldwinThe
527f911abeSJohn Baldwin.Fn kvm_native
537f911abeSJohn Baldwinfunction returns a non-zero value if the kvm descriptor
547f911abeSJohn Baldwin.Fa kd
557f911abeSJohn Baldwinis attached to a native kernel image;
567f911abeSJohn Baldwinotherwise it returns zero.
577f911abeSJohn Baldwin.Sh SEE ALSO
587f911abeSJohn Baldwin.Xr kvm 3 ,
597f911abeSJohn Baldwin.Xr kvm_open2 3
60