forked from xapi-project/xen-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
device_common.mli
75 lines (60 loc) · 3.06 KB
/
device_common.mli
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
(*
* Copyright (C) 2006-2009 Citrix Systems Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; version 2.1 only. with the special
* exception on linking described in file LICENSE.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*)
type kind = Vif | Vbd | Tap | Pci | Vfs | Vfb | Vkbd
type devid = int
(** Represents one end of a device *)
type endpoint = { domid: Xenctrl.domid; kind: kind; devid: int }
(** Represent a device as a pair of endpoints *)
type device = {
frontend: endpoint;
backend: endpoint
}
exception Device_frontend_already_connected of device
exception Device_backend_vanished of device
exception Device_disconnect_timeout of device
exception Device_error of device * string
exception Device_unrecognized of string
exception Hotplug_script_expecting_field of device * string
val backend_path : xs:Xenstore.Xs.xsh -> endpoint -> Xenctrl.domid -> string
val backend_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val frontend_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val disconnect_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val error_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val backend_error_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val backend_shutdown_request_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val backend_shutdown_done_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val backend_pause_request_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val backend_pause_token_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val backend_pause_done_path_of_device : xs:Xenstore.Xs.xsh -> device -> string
val string_of_endpoint : endpoint -> string
val string_of_device : device -> string
val string_of_kind : kind -> string
val kind_of_string : string -> kind
(** [list_backends xs domid] returns a list of devices where there is a
backend in [domid]. This function only reads data stored in the backend
directory.*)
val list_backends : xs:Xenstore.Xs.xsh -> Xenctrl.domid -> device list
(** [list_frontends xs domid] returns a list of devices where there is a
frontend in [domid]. This function only reads data stored in the frontend
directory.*)
val list_frontends : xs:Xenstore.Xs.xsh -> Xenctrl.domid -> device list
(** Return a list of devices connecting two domains. Ignore those whose kind
we don't recognise *)
val list_devices_between : xs:Xenstore.Xs.xsh -> Xenctrl.domid -> Xenctrl.domid -> device list
val device_of_backend : endpoint -> Xenctrl.domid -> device
type protocol = Protocol_Native | Protocol_X86_32 | Protocol_X86_64
val string_of_protocol : protocol -> string
val protocol_of_string : string -> protocol
val qemu_save_path: (int -> 'a, 'b, 'a) format
val qemu_restore_path: (int -> 'a, 'b, 'a) format