src/search.mli

   1 (* virt-dmesg
   2  * (C) Copyright 2008-2011 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  *)
  18
  19 (** Functions for searching for kernels in guest memory. *)
  20
  21 val search : ?dump:bool -> Libvirt.rw Libvirt.Domain.t -> Kernel.t * Utils.symbol_table
  22   (** Search for a kernel in the given libvirt domain.  This call
  23       checks for the kernel at a number of possible addresses.
  24
  25       Returns a fully populated {!Kernel.t} struct and symbol table if
  26       found, but if not then it raises [Not_found] exception.
  27
  28       If the optional [~dump] parameter is true, then the kernel
  29       contents are dumped to stdout, and we {i do not} try to look
  30       for symbols. *)
  31
  32 val search_at : ?dump:bool -> Libvirt.rw Libvirt.Domain.t -> int64 -> Kernel.t * Utils.symbol_table
  33   (** Search for a kernel starting at the given fixed address (ie.
  34       virtual address in guest memory).  Works otherwise just like
  35       {!search}. *)