forked from xapi-project/xen-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
device_number.mli
55 lines (38 loc) · 1.75 KB
/
device_number.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
(** Disks are attached to particular bus types: *)
type bus_type =
| Xen (** A xen paravirtualised bus *)
| Scsi (** A SCSI bus *)
| Ide (** An IDE bus *)
(** A specification for a device number. There are more valid specifications than
valid device numbers because of hardware and/or protocol limits. *)
type spec = bus_type * int * int
(** A valid device number *)
type t
val t_of_rpc: Rpc.t -> t
val rpc_of_t: t -> Rpc.t
(** [make spec] validates a given device number specification [spec] and returns
a device number *)
val make: spec -> t
(** [spec t] takes a [t] and returns the corresponding [spec] *)
val spec: t -> spec
(** [of_string hvm name] returns the interface which best matches the [name]
by applying the policy: first check if it is a disk_number, else fall back to
a linux_device for backwards compatability *)
val of_string: bool -> string -> t
(** [to_debug_string i] returns a pretty-printed interface *)
val to_debug_string: t -> string
(** [to_linux_device i] returns a possible linux string representation of interface [i] *)
val to_linux_device: t -> string
(** [of_linux_device x] returns the interface corresponding to string [x] *)
val of_linux_device: string -> t
type xenstore_key = int
(** [to_xenstore_key i] returns the xenstore key from interface [i] *)
val to_xenstore_key: t -> xenstore_key
(** [of_xenstore_key key] returns an interface from a xenstore key *)
val of_xenstore_key: xenstore_key -> t
type disk_number = int
(** [to_disk_number i] returns the corresponding non-negative disk number *)
val to_disk_number: t -> disk_number
(** [of_disk_number hvm n] returns the interface corresponding to disk
number [n] which depends on whether the guest is [hvm] or not. *)
val of_disk_number: bool -> disk_number -> t