34f3fe7a9176b6b83c8dd7680d372bc7a5694d3d
[virt-mem.git] / lib / virt_mem_types.ml
1 (** Common types. *)
2 (* Memory info command for virtual domains.
3    (C) Copyright 2008 Richard W.M. Jones, Red Hat Inc.
4    http://libvirt.org/
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20    Common types.
21  *)
22
23 (** A kernel image. *)
24 type image0 =
25     int option                          (* Domain ID, if known. *)
26     * string                            (* Domain name. *)
27     * Virt_mem_utils.architecture       (* Architecture, eg. i386. *)
28     * ([`Wordsize], [`Endian], [`HasMapping]) Virt_mem_mmap.t (* Memory map. *)
29
30 (** A kernel symbol. *)
31 type ksym = string
32
33 (** A kernel image, after finding kernel symbols. *)
34 type image1 =
35     int option                          (* Domain ID, if known. *)
36     * string                            (* Domain name. *)
37     * Virt_mem_utils.architecture       (* Architecture, eg. i386. *)
38     * ([`Wordsize], [`Endian], [`HasMapping]) Virt_mem_mmap.t (* Memory map. *)
39     * (ksym -> Virt_mem_mmap.addr)      (* Kernel symbol lookup function. *)
40
41 (** A kernel image, after finding kernel version (like 'uname'). *)
42 type image2 =
43     int option                          (* Domain ID, if known. *)
44     * string                            (* Domain name. *)
45     * Virt_mem_utils.architecture       (* Architecture, eg. i386. *)
46     * ([`Wordsize], [`Endian], [`HasMapping]) Virt_mem_mmap.t (* Memory map. *)
47     * (ksym -> Virt_mem_mmap.addr)      (* Kernel symbol lookup function. *)
48     * utsname option                    (* Kernel version, etc., if known. *)
49
50 and utsname = {
51   kernel_name : string;
52   nodename : string;
53   kernel_release : string;
54   kernel_version : string;
55   machine : string;
56   domainname : string;
57 }