lib/libkvm/kvm_kerndisp.3

   1 .\"
   2 .\" Copyright (c) 2020 Leandro Lupori <luporl@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 February 5, 2020
  28 .Dt KVM_KERNDISP 3
  29 .Os
  30 .Sh NAME
  31 .Nm kvm_kerndisp
  32 .Nd get kernel displacement
  33 .Sh LIBRARY
  34 .Lb libkvm
  35 .Sh SYNOPSIS
  36 .In kvm.h
  37 .Ft kssize_t
  38 .Fn kvm_kerndisp "kvm_t *kd"
  39 .Sh DESCRIPTION
  40 .Fn kvm_kerndisp
  41 returns the number of bytes by which the kernel referenced by
  42 .Fa kd
  43 is displaced.
  44 This is the difference between the kernel's base virtual address at run time
  45 and the kernel base virtual address specified in the kernel image file.
  46 .Pp
  47 Note that if the kernel is moved to a lower memory address,
  48 the displacement will be negative.
  49 .Sh RETURN VALUES
  50 .Fn kvm_kerndisp
  51 returns the number of bytes by which the kernel is displaced.
  52 If the kernel is not displaced or if it is not possible to find the
  53 displacement then 0 is returned.
  54 .Sh SEE ALSO
  55 .Xr kvm 3 ,
  56 .Xr kvm_close 3 ,
  57 .Xr kvm_open 3