1 (* OCaml bindings for libvirt.
2 (C) Copyright 2007-2015 Richard W.M. Jones, Red Hat Inc.
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version,
9 with the OCaml linking exception described in ../COPYING.LIB.
11 This library 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 GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with this library; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 type filename = string
27 external get_version : ?driver:string -> unit -> int * int = "ocaml_libvirt_get_version"
30 let uuid_string_length = 36
32 (* http://caml.inria.fr/pub/ml-archives/caml-list/2004/07/80683af867cce6bf8fff273973f70c95.en.html *)
52 | ListNoState | ListRunning | ListBlocked
53 | ListPaused | ListShutdown | ListShutoff | ListCrashed
58 external connect : ?name:string -> unit -> rw t = "ocaml_libvirt_connect_open"
59 external connect_readonly : ?name:string -> unit -> ro t = "ocaml_libvirt_connect_open_readonly"
60 external close : [>`R] t -> unit = "ocaml_libvirt_connect_close"
61 external get_type : [>`R] t -> string = "ocaml_libvirt_connect_get_type"
62 external get_version : [>`R] t -> int = "ocaml_libvirt_connect_get_version"
63 external get_hostname : [>`R] t -> string = "ocaml_libvirt_connect_get_hostname"
64 external get_uri : [>`R] t -> string = "ocaml_libvirt_connect_get_uri"
65 external get_max_vcpus : [>`R] t -> ?type_:string -> unit -> int = "ocaml_libvirt_connect_get_max_vcpus"
66 external list_domains : [>`R] t -> int -> int array = "ocaml_libvirt_connect_list_domains"
67 external num_of_domains : [>`R] t -> int = "ocaml_libvirt_connect_num_of_domains"
68 external get_capabilities : [>`R] t -> xml = "ocaml_libvirt_connect_get_capabilities"
69 external num_of_defined_domains : [>`R] t -> int = "ocaml_libvirt_connect_num_of_defined_domains"
70 external list_defined_domains : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_defined_domains"
71 external num_of_networks : [>`R] t -> int = "ocaml_libvirt_connect_num_of_networks"
72 external list_networks : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_networks"
73 external num_of_defined_networks : [>`R] t -> int = "ocaml_libvirt_connect_num_of_defined_networks"
74 external list_defined_networks : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_defined_networks"
75 external num_of_pools : [>`R] t -> int = "ocaml_libvirt_connect_num_of_storage_pools"
76 external list_pools : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_storage_pools"
77 external num_of_defined_pools : [>`R] t -> int = "ocaml_libvirt_connect_num_of_defined_storage_pools"
78 external list_defined_pools : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_defined_storage_pools"
80 external get_node_info : [>`R] t -> node_info = "ocaml_libvirt_connect_get_node_info"
81 external node_get_free_memory : [> `R] t -> int64 = "ocaml_libvirt_connect_node_get_free_memory"
82 external node_get_cells_free_memory : [> `R] t -> int -> int -> int64 array = "ocaml_libvirt_connect_node_get_cells_free_memory"
84 (* See VIR_NODEINFO_MAXCPUS macro defined in <libvirt.h>. *)
85 let maxcpus_of_node_info { nodes = nodes; sockets = sockets;
86 cores = cores; threads = threads } =
87 nodes * sockets * cores * threads
89 (* See VIR_CPU_MAPLEN macro defined in <libvirt.h>. *)
90 let cpumaplen nr_cpus =
93 (* See VIR_USE_CPU, VIR_UNUSE_CPU, VIR_CPU_USABLE macros defined in <libvirt.h>. *)
94 let use_cpu cpumap cpu =
96 Char.chr (Char.code cpumap.[cpu/8] lor (1 lsl (cpu mod 8)))
97 let unuse_cpu cpumap cpu =
99 Char.chr (Char.code cpumap.[cpu/8] land (lnot (1 lsl (cpu mod 8))))
100 let cpu_usable cpumaps maplen vcpu cpu =
101 Char.code cpumaps.[vcpu*maplen + cpu/8] land (1 lsl (cpu mod 8)) <> 0
103 external set_keep_alive : [>`R] t -> int -> int -> unit = "ocaml_libvirt_connect_set_keep_alive"
105 external const : [>`R] t -> ro t = "%identity"
112 | VIR_ERR_INTERNAL_ERROR
115 | VIR_ERR_UNKNOWN_HOST
117 | VIR_ERR_INVALID_CONN
118 | VIR_ERR_INVALID_DOMAIN
119 | VIR_ERR_INVALID_ARG
120 | VIR_ERR_OPERATION_FAILED
122 | VIR_ERR_POST_FAILED
124 | VIR_ERR_SEXPR_SERIAL
135 | VIR_ERR_NO_XENSTORE
136 | VIR_ERR_DRIVER_FULL
137 | VIR_ERR_CALL_FAILED
140 | VIR_ERR_OPERATION_DENIED
141 | VIR_ERR_OPEN_FAILED
142 | VIR_ERR_READ_FAILED
143 | VIR_ERR_PARSE_FAILED
144 | VIR_ERR_CONF_SYNTAX
145 | VIR_ERR_WRITE_FAILED
147 | VIR_ERR_INVALID_NETWORK
148 | VIR_ERR_NETWORK_EXIST
149 | VIR_ERR_SYSTEM_ERROR
151 | VIR_ERR_GNUTLS_ERROR
155 | VIR_ERR_INVALID_MAC
156 | VIR_ERR_AUTH_FAILED
157 | VIR_ERR_INVALID_STORAGE_POOL
158 | VIR_ERR_INVALID_STORAGE_VOL
160 | VIR_ERR_NO_STORAGE_POOL
161 | VIR_ERR_NO_STORAGE_VOL
162 | VIR_ERR_UNKNOWN of int
164 let string_of_code = function
165 | VIR_ERR_OK -> "VIR_ERR_OK"
166 | VIR_ERR_INTERNAL_ERROR -> "VIR_ERR_INTERNAL_ERROR"
167 | VIR_ERR_NO_MEMORY -> "VIR_ERR_NO_MEMORY"
168 | VIR_ERR_NO_SUPPORT -> "VIR_ERR_NO_SUPPORT"
169 | VIR_ERR_UNKNOWN_HOST -> "VIR_ERR_UNKNOWN_HOST"
170 | VIR_ERR_NO_CONNECT -> "VIR_ERR_NO_CONNECT"
171 | VIR_ERR_INVALID_CONN -> "VIR_ERR_INVALID_CONN"
172 | VIR_ERR_INVALID_DOMAIN -> "VIR_ERR_INVALID_DOMAIN"
173 | VIR_ERR_INVALID_ARG -> "VIR_ERR_INVALID_ARG"
174 | VIR_ERR_OPERATION_FAILED -> "VIR_ERR_OPERATION_FAILED"
175 | VIR_ERR_GET_FAILED -> "VIR_ERR_GET_FAILED"
176 | VIR_ERR_POST_FAILED -> "VIR_ERR_POST_FAILED"
177 | VIR_ERR_HTTP_ERROR -> "VIR_ERR_HTTP_ERROR"
178 | VIR_ERR_SEXPR_SERIAL -> "VIR_ERR_SEXPR_SERIAL"
179 | VIR_ERR_NO_XEN -> "VIR_ERR_NO_XEN"
180 | VIR_ERR_XEN_CALL -> "VIR_ERR_XEN_CALL"
181 | VIR_ERR_OS_TYPE -> "VIR_ERR_OS_TYPE"
182 | VIR_ERR_NO_KERNEL -> "VIR_ERR_NO_KERNEL"
183 | VIR_ERR_NO_ROOT -> "VIR_ERR_NO_ROOT"
184 | VIR_ERR_NO_SOURCE -> "VIR_ERR_NO_SOURCE"
185 | VIR_ERR_NO_TARGET -> "VIR_ERR_NO_TARGET"
186 | VIR_ERR_NO_NAME -> "VIR_ERR_NO_NAME"
187 | VIR_ERR_NO_OS -> "VIR_ERR_NO_OS"
188 | VIR_ERR_NO_DEVICE -> "VIR_ERR_NO_DEVICE"
189 | VIR_ERR_NO_XENSTORE -> "VIR_ERR_NO_XENSTORE"
190 | VIR_ERR_DRIVER_FULL -> "VIR_ERR_DRIVER_FULL"
191 | VIR_ERR_CALL_FAILED -> "VIR_ERR_CALL_FAILED"
192 | VIR_ERR_XML_ERROR -> "VIR_ERR_XML_ERROR"
193 | VIR_ERR_DOM_EXIST -> "VIR_ERR_DOM_EXIST"
194 | VIR_ERR_OPERATION_DENIED -> "VIR_ERR_OPERATION_DENIED"
195 | VIR_ERR_OPEN_FAILED -> "VIR_ERR_OPEN_FAILED"
196 | VIR_ERR_READ_FAILED -> "VIR_ERR_READ_FAILED"
197 | VIR_ERR_PARSE_FAILED -> "VIR_ERR_PARSE_FAILED"
198 | VIR_ERR_CONF_SYNTAX -> "VIR_ERR_CONF_SYNTAX"
199 | VIR_ERR_WRITE_FAILED -> "VIR_ERR_WRITE_FAILED"
200 | VIR_ERR_XML_DETAIL -> "VIR_ERR_XML_DETAIL"
201 | VIR_ERR_INVALID_NETWORK -> "VIR_ERR_INVALID_NETWORK"
202 | VIR_ERR_NETWORK_EXIST -> "VIR_ERR_NETWORK_EXIST"
203 | VIR_ERR_SYSTEM_ERROR -> "VIR_ERR_SYSTEM_ERROR"
204 | VIR_ERR_RPC -> "VIR_ERR_RPC"
205 | VIR_ERR_GNUTLS_ERROR -> "VIR_ERR_GNUTLS_ERROR"
206 | VIR_WAR_NO_NETWORK -> "VIR_WAR_NO_NETWORK"
207 | VIR_ERR_NO_DOMAIN -> "VIR_ERR_NO_DOMAIN"
208 | VIR_ERR_NO_NETWORK -> "VIR_ERR_NO_NETWORK"
209 | VIR_ERR_INVALID_MAC -> "VIR_ERR_INVALID_MAC"
210 | VIR_ERR_AUTH_FAILED -> "VIR_ERR_AUTH_FAILED"
211 | VIR_ERR_INVALID_STORAGE_POOL -> "VIR_ERR_INVALID_STORAGE_POOL"
212 | VIR_ERR_INVALID_STORAGE_VOL -> "VIR_ERR_INVALID_STORAGE_VOL"
213 | VIR_WAR_NO_STORAGE -> "VIR_WAR_NO_STORAGE"
214 | VIR_ERR_NO_STORAGE_POOL -> "VIR_ERR_NO_STORAGE_POOL"
215 | VIR_ERR_NO_STORAGE_VOL -> "VIR_ERR_NO_STORAGE_VOL"
216 | VIR_ERR_UNKNOWN i -> "VIR_ERR_" ^ string_of_int i
235 | VIR_FROM_STATS_LINUX
237 | VIR_FROM_UNKNOWN of int
239 let string_of_domain = function
240 | VIR_FROM_NONE -> "VIR_FROM_NONE"
241 | VIR_FROM_XEN -> "VIR_FROM_XEN"
242 | VIR_FROM_XEND -> "VIR_FROM_XEND"
243 | VIR_FROM_XENSTORE -> "VIR_FROM_XENSTORE"
244 | VIR_FROM_SEXPR -> "VIR_FROM_SEXPR"
245 | VIR_FROM_XML -> "VIR_FROM_XML"
246 | VIR_FROM_DOM -> "VIR_FROM_DOM"
247 | VIR_FROM_RPC -> "VIR_FROM_RPC"
248 | VIR_FROM_PROXY -> "VIR_FROM_PROXY"
249 | VIR_FROM_CONF -> "VIR_FROM_CONF"
250 | VIR_FROM_QEMU -> "VIR_FROM_QEMU"
251 | VIR_FROM_NET -> "VIR_FROM_NET"
252 | VIR_FROM_TEST -> "VIR_FROM_TEST"
253 | VIR_FROM_REMOTE -> "VIR_FROM_REMOTE"
254 | VIR_FROM_OPENVZ -> "VIR_FROM_OPENVZ"
255 | VIR_FROM_XENXM -> "VIR_FROM_XENXM"
256 | VIR_FROM_STATS_LINUX -> "VIR_FROM_STATS_LINUX"
257 | VIR_FROM_STORAGE -> "VIR_FROM_STORAGE"
258 | VIR_FROM_UNKNOWN i -> "VIR_FROM_" ^ string_of_int i
264 | VIR_ERR_UNKNOWN_LEVEL of int
266 let string_of_level = function
267 | VIR_ERR_NONE -> "VIR_ERR_NONE"
268 | VIR_ERR_WARNING -> "VIR_ERR_WARNING"
269 | VIR_ERR_ERROR -> "VIR_ERR_ERROR"
270 | VIR_ERR_UNKNOWN_LEVEL i -> "VIR_ERR_LEVEL_" ^ string_of_int i
275 message : string option;
277 str1 : string option;
278 str2 : string option;
279 str3 : string option;
284 let to_string { code = code; domain = domain; message = message } =
285 let buf = Buffer.create 128 in
286 Buffer.add_string buf "libvirt: ";
287 Buffer.add_string buf (string_of_code code);
288 Buffer.add_string buf ": ";
289 Buffer.add_string buf (string_of_domain domain);
290 Buffer.add_string buf ": ";
291 (match message with Some msg -> Buffer.add_string buf msg | None -> ());
294 external get_last_error : unit -> t option = "ocaml_libvirt_virterror_get_last_error"
295 external get_last_conn_error : [>`R] Connect.t -> t option = "ocaml_libvirt_virterror_get_last_conn_error"
296 external reset_last_error : unit -> unit = "ocaml_libvirt_virterror_reset_last_error"
297 external reset_last_conn_error : [>`R] Connect.t -> unit = "ocaml_libvirt_virterror_reset_last_conn_error"
300 { code = VIR_ERR_OK; domain = VIR_FROM_NONE;
301 message = None; level = VIR_ERR_NONE;
302 str1 = None; str2 = None; str3 = None;
303 int1 = 0_l; int2 = 0_l }
306 exception Virterror of Virterror.t
307 exception Not_supported of string
309 let rec map_ignore_errors f = function
312 try f x :: map_ignore_errors f xs
313 with Virterror _ -> map_ignore_errors f xs
320 | InfoNoState | InfoRunning | InfoBlocked | InfoPaused
321 | InfoShutdown | InfoShutoff | InfoCrashed
331 type vcpu_state = VcpuOffline | VcpuRunning | VcpuBlocked
335 vcpu_state : vcpu_state;
340 type domain_create_flag =
346 let rec int_of_domain_create_flags = function
348 | START_PAUSED :: flags -> 1 lor int_of_domain_create_flags flags
349 | START_AUTODESTROY :: flags -> 2 lor int_of_domain_create_flags flags
350 | START_BYPASS_CACHE :: flags -> 4 lor int_of_domain_create_flags flags
351 | START_FORCE_BOOT :: flags -> 8 lor int_of_domain_create_flags flags
352 | START_VALIDATE :: flags -> 16 lor int_of_domain_create_flags flags
354 type sched_param = string * sched_param_value
355 and sched_param_value =
356 | SchedFieldInt32 of int32 | SchedFieldUInt32 of int32
357 | SchedFieldInt64 of int64 | SchedFieldUInt64 of int64
358 | SchedFieldFloat of float | SchedFieldBool of bool
360 type typed_param = string * typed_param_value
361 and typed_param_value =
362 | TypedFieldInt32 of int32 | TypedFieldUInt32 of int32
363 | TypedFieldInt64 of int64 | TypedFieldUInt64 of int64
364 | TypedFieldFloat of float | TypedFieldBool of bool
365 | TypedFieldString of string
367 type migrate_flag = Live
369 type memory_flag = Virtual
384 type interface_stats = {
395 (* The maximum size for Domain.memory_peek and Domain.block_peek
396 * supported by libvirt. This may change with different versions
397 * of libvirt in the future, hence it's a function.
399 let max_peek _ = 65536
401 external create_linux : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_domain_create_linux"
402 external _create_xml : [>`W] Connect.t -> xml -> int -> rw t = "ocaml_libvirt_domain_create_xml"
403 let create_xml conn xml flags =
404 _create_xml conn xml (int_of_domain_create_flags flags)
405 external lookup_by_id : 'a Connect.t -> int -> 'a t = "ocaml_libvirt_domain_lookup_by_id"
406 external lookup_by_uuid : 'a Connect.t -> uuid -> 'a t = "ocaml_libvirt_domain_lookup_by_uuid"
407 external lookup_by_uuid_string : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_domain_lookup_by_uuid_string"
408 external lookup_by_name : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_domain_lookup_by_name"
409 external destroy : [>`W] t -> unit = "ocaml_libvirt_domain_destroy"
410 external free : [>`R] t -> unit = "ocaml_libvirt_domain_free"
411 external suspend : [>`W] t -> unit = "ocaml_libvirt_domain_suspend"
412 external resume : [>`W] t -> unit = "ocaml_libvirt_domain_resume"
413 external save : [>`W] t -> filename -> unit = "ocaml_libvirt_domain_save"
414 external restore : [>`W] Connect.t -> filename -> unit = "ocaml_libvirt_domain_restore"
415 external core_dump : [>`W] t -> filename -> unit = "ocaml_libvirt_domain_core_dump"
416 external shutdown : [>`W] t -> unit = "ocaml_libvirt_domain_shutdown"
417 external reboot : [>`W] t -> unit = "ocaml_libvirt_domain_reboot"
418 external get_name : [>`R] t -> string = "ocaml_libvirt_domain_get_name"
419 external get_uuid : [>`R] t -> uuid = "ocaml_libvirt_domain_get_uuid"
420 external get_uuid_string : [>`R] t -> string = "ocaml_libvirt_domain_get_uuid_string"
421 external get_id : [>`R] t -> int = "ocaml_libvirt_domain_get_id"
422 external get_os_type : [>`R] t -> string = "ocaml_libvirt_domain_get_os_type"
423 external get_max_memory : [>`R] t -> int64 = "ocaml_libvirt_domain_get_max_memory"
424 external set_max_memory : [>`W] t -> int64 -> unit = "ocaml_libvirt_domain_set_max_memory"
425 external set_memory : [>`W] t -> int64 -> unit = "ocaml_libvirt_domain_set_memory"
426 external get_info : [>`R] t -> info = "ocaml_libvirt_domain_get_info"
427 external get_xml_desc : [>`R] t -> xml = "ocaml_libvirt_domain_get_xml_desc"
428 external get_scheduler_type : [>`R] t -> string * int = "ocaml_libvirt_domain_get_scheduler_type"
429 external get_scheduler_parameters : [>`R] t -> int -> sched_param array = "ocaml_libvirt_domain_get_scheduler_parameters"
430 external set_scheduler_parameters : [>`W] t -> sched_param array -> unit = "ocaml_libvirt_domain_set_scheduler_parameters"
431 external define_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_domain_define_xml"
432 external undefine : [>`W] t -> unit = "ocaml_libvirt_domain_undefine"
433 external create : [>`W] t -> unit = "ocaml_libvirt_domain_create"
434 external get_autostart : [>`R] t -> bool = "ocaml_libvirt_domain_get_autostart"
435 external set_autostart : [>`W] t -> bool -> unit = "ocaml_libvirt_domain_set_autostart"
436 external set_vcpus : [>`W] t -> int -> unit = "ocaml_libvirt_domain_set_vcpus"
437 external pin_vcpu : [>`W] t -> int -> string -> unit = "ocaml_libvirt_domain_pin_vcpu"
438 external get_vcpus : [>`R] t -> int -> int -> int * vcpu_info array * string = "ocaml_libvirt_domain_get_vcpus"
439 external get_cpu_stats : [>`R] t -> typed_param list array = "ocaml_libvirt_domain_get_cpu_stats"
440 external get_max_vcpus : [>`R] t -> int = "ocaml_libvirt_domain_get_max_vcpus"
441 external attach_device : [>`W] t -> xml -> unit = "ocaml_libvirt_domain_attach_device"
442 external detach_device : [>`W] t -> xml -> unit = "ocaml_libvirt_domain_detach_device"
443 external migrate : [>`W] t -> [>`W] Connect.t -> migrate_flag list -> ?dname:string -> ?uri:string -> ?bandwidth:int -> unit -> rw t = "ocaml_libvirt_domain_migrate_bytecode" "ocaml_libvirt_domain_migrate_native"
444 external block_stats : [>`R] t -> string -> block_stats = "ocaml_libvirt_domain_block_stats"
445 external interface_stats : [>`R] t -> string -> interface_stats = "ocaml_libvirt_domain_interface_stats"
446 external block_peek : [>`W] t -> string -> int64 -> int -> string -> int -> unit = "ocaml_libvirt_domain_block_peek_bytecode" "ocaml_libvirt_domain_block_peek_native"
447 external memory_peek : [>`W] t -> memory_flag list -> int64 -> int -> string -> int -> unit = "ocaml_libvirt_domain_memory_peek_bytecode" "ocaml_libvirt_domain_memory_peek_native"
449 external const : [>`R] t -> ro t = "%identity"
451 let get_domains conn flags =
452 (* Old/slow/inefficient method. *)
453 let get_active, get_inactive =
454 if List.mem ListAll flags then
457 (List.mem ListActive flags, List.mem ListInactive flags) in
460 let n = Connect.num_of_domains conn in
461 let ids = Connect.list_domains conn n in
462 let ids = Array.to_list ids in
463 map_ignore_errors (lookup_by_id conn) ids
467 if get_inactive then (
468 let n = Connect.num_of_defined_domains conn in
469 let names = Connect.list_defined_domains conn n in
470 let names = Array.to_list names in
471 map_ignore_errors (lookup_by_name conn) names
474 active_doms @ inactive_doms
476 let get_domains_and_infos conn flags =
477 (* Old/slow/inefficient method. *)
478 let get_active, get_inactive =
479 if List.mem ListAll flags then
481 else (List.mem ListActive flags, List.mem ListInactive flags) in
484 let n = Connect.num_of_domains conn in
485 let ids = Connect.list_domains conn n in
486 let ids = Array.to_list ids in
487 map_ignore_errors (lookup_by_id conn) ids
491 if get_inactive then (
492 let n = Connect.num_of_defined_domains conn in
493 let names = Connect.list_defined_domains conn n in
494 let names = Array.to_list names in
495 map_ignore_errors (lookup_by_name conn) names
498 let doms = active_doms @ inactive_doms in
500 map_ignore_errors (fun dom -> (dom, get_info dom)) doms
506 module Defined = struct
513 let to_string = function
515 | `Updated -> "Updated"
516 | `Unknown x -> Printf.sprintf "Unknown Defined.detail: %d" x
521 | x -> `Unknown x (* newer libvirt *)
524 module Undefined = struct
530 let to_string = function
531 | `Removed -> "UndefinedRemoved"
532 | `Unknown x -> Printf.sprintf "Unknown Undefined.detail: %d" x
536 | x -> `Unknown x (* newer libvirt *)
539 module Started = struct
549 let to_string = function
550 | `Booted -> "Booted"
551 | `Migrated -> "Migrated"
552 | `Restored -> "Restored"
553 | `FromSnapshot -> "FromSnapshot"
554 | `Wakeup -> "Wakeup"
555 | `Unknown x -> Printf.sprintf "Unknown Started.detail: %d" x
563 | x -> `Unknown x (* newer libvirt *)
566 module Suspended = struct
575 | `Unknown of int (* newer libvirt *)
578 let to_string = function
579 | `Paused -> "Paused"
580 | `Migrated -> "Migrated"
581 | `IOError -> "IOError"
582 | `Watchdog -> "Watchdog"
583 | `Restored -> "Restored"
584 | `FromSnapshot -> "FromSnapshot"
585 | `APIError -> "APIError"
586 | `Unknown x -> Printf.sprintf "Unknown Suspended.detail: %d" x
596 | x -> `Unknown x (* newer libvirt *)
599 module Resumed = struct
604 | `Unknown of int (* newer libvirt *)
607 let to_string = function
608 | `Unpaused -> "Unpaused"
609 | `Migrated -> "Migrated"
610 | `FromSnapshot -> "FromSnapshot"
611 | `Unknown x -> Printf.sprintf "Unknown Resumed.detail: %d" x
617 | x -> `Unknown x (* newer libvirt *)
620 module Stopped = struct
631 let to_string = function
632 | `Shutdown -> "Shutdown"
633 | `Destroyed -> "Destroyed"
634 | `Crashed -> "Crashed"
635 | `Migrated -> "Migrated"
637 | `Failed -> "Failed"
638 | `FromSnapshot -> "FromSnapshot"
639 | `Unknown x -> Printf.sprintf "Unknown Stopped.detail: %d" x
649 | x -> `Unknown x (* newer libvirt *)
652 module PM_suspended = struct
656 | `Unknown of int (* newer libvirt *)
659 let to_string = function
660 | `Memory -> "Memory"
662 | `Unknown x -> Printf.sprintf "Unknown PM_suspended.detail: %d" x
667 | x -> `Unknown x (* newer libvirt *)
670 let string_option x = match x with
672 | Some x' -> "Some " ^ x'
674 module Lifecycle = struct
676 | `Defined of Defined.t
677 | `Undefined of Undefined.t
678 | `Started of Started.t
679 | `Suspended of Suspended.t
680 | `Resumed of Resumed.t
681 | `Stopped of Stopped.t
682 | `Shutdown (* no detail defined yet *)
683 | `PMSuspended of PM_suspended.t
684 | `Unknown of int (* newer libvirt *)
687 let to_string = function
688 | `Defined x -> "Defined " ^ (Defined.to_string x)
689 | `Undefined x -> "Undefined " ^ (Undefined.to_string x)
690 | `Started x -> "Started " ^ (Started.to_string x)
691 | `Suspended x -> "Suspended " ^ (Suspended.to_string x)
692 | `Resumed x -> "Resumed " ^ (Resumed.to_string x)
693 | `Stopped x -> "Stopped " ^ (Stopped.to_string x)
694 | `Shutdown -> "Shutdown"
695 | `PMSuspended x -> "PMSuspended " ^ (PM_suspended.to_string x)
696 | `Unknown x -> Printf.sprintf "Unknown Lifecycle event: %d" x
698 let make (ty, detail) = match ty with
699 | 0 -> `Defined (Defined.make detail)
700 | 1 -> `Undefined (Undefined.make detail)
701 | 2 -> `Started (Started.make detail)
702 | 3 -> `Suspended (Suspended.make detail)
703 | 4 -> `Resumed (Resumed.make detail)
704 | 5 -> `Stopped (Stopped.make detail)
706 | 7 -> `PMSuspended (PM_suspended.make detail)
710 module Reboot = struct
713 let to_string _ = "()"
718 module Rtc_change = struct
721 let to_string = Int64.to_string
726 module Watchdog = struct
737 let to_string = function
741 | `Poweroff -> "Poweroff"
742 | `Shutdown -> "Shutdown"
744 | `Unknown x -> Printf.sprintf "Unknown watchdog_action: %d" x
753 | x -> `Unknown x (* newer libvirt *)
756 module Io_error = struct
761 | `Unknown of int (* newer libvirt *)
764 let string_of_action = function
767 | `Report -> "Report"
768 | `Unknown x -> Printf.sprintf "Unknown Io_error.action: %d" x
770 let action_of_int = function
777 src_path: string option;
778 dev_alias: string option;
780 reason: string option;
783 let to_string t = Printf.sprintf
784 "{ Io_error.src_path = %s; dev_alias = %s; action = %s; reason = %s }"
785 (string_option t.src_path)
786 (string_option t.dev_alias)
787 (string_of_action t.action)
788 (string_option t.reason)
790 let make (src_path, dev_alias, action, reason) = {
792 dev_alias = dev_alias;
793 action = action_of_int action;
797 let make_noreason (src_path, dev_alias, action) =
798 make (src_path, dev_alias, action, None)
801 module Graphics_address = struct
806 | `Unknown of int (* newer libvirt *)
809 let string_of_family = function
813 | `Unknown x -> Printf.sprintf "Unknown Graphics_address.family: %d" x
815 let family_of_int = function
823 family: family; (** Address family *)
824 node: string option; (** Address of node (eg IP address, or UNIX path *)
825 service: string option; (** Service name/number (eg TCP port, or NULL) *)
828 let to_string t = Printf.sprintf
829 "{ family = %s; node = %s; service = %s }"
830 (string_of_family t.family)
831 (string_option t.node)
832 (string_option t.service)
834 let make (family, node, service) = {
835 family = family_of_int family;
841 module Graphics_subject = struct
847 let string_of_identity t = Printf.sprintf
848 "{ ty = %s; name = %s }"
850 (string_option t.name)
852 type t = identity list
855 "[ " ^ (String.concat "; " (List.map string_of_identity ts)) ^ " ]"
858 List.map (fun (ty, name) -> { ty = ty; name = name })
862 module Graphics = struct
867 | `Unknown of int (** newer libvirt *)
870 let string_of_phase = function
871 | `Connect -> "Connect"
872 | `Initialize -> "Initialize"
873 | `Disconnect -> "Disconnect"
874 | `Unknown x -> Printf.sprintf "Unknown Graphics.phase: %d" x
876 let phase_of_int = function
883 phase: phase; (** the phase of the connection *)
884 local: Graphics_address.t; (** the local server address *)
885 remote: Graphics_address.t; (** the remote client address *)
886 auth_scheme: string option; (** the authentication scheme activated *)
887 subject: Graphics_subject.t; (** the authenticated subject (user) *)
891 let phase = Printf.sprintf "phase = %s"
892 (string_of_phase t.phase) in
893 let local = Printf.sprintf "local = %s"
894 (Graphics_address.to_string t.local) in
895 let remote = Printf.sprintf "remote = %s"
896 (Graphics_address.to_string t.remote) in
897 let auth_scheme = Printf.sprintf "auth_scheme = %s"
898 (string_option t.auth_scheme) in
899 let subject = Printf.sprintf "subject = %s"
900 (Graphics_subject.to_string t.subject) in
901 "{ " ^ (String.concat "; " [ phase; local; remote; auth_scheme; subject ]) ^ " }"
903 let make (phase, local, remote, auth_scheme, subject) = {
904 phase = phase_of_int phase;
905 local = Graphics_address.make local;
906 remote = Graphics_address.make remote;
907 auth_scheme = auth_scheme;
908 subject = Graphics_subject.make subject;
912 module Control_error = struct
915 let to_string () = "()"
920 module Block_job = struct
922 | `KnownUnknown (* explicitly named UNKNOWN in the spec *)
926 | `Unknown of int (* newer libvirt *)
929 let string_of_ty = function
930 | `KnownUnknown -> "KnownUnknown"
933 | `Commit -> "Commit"
934 | `Unknown x -> Printf.sprintf "Unknown Block_job.ty: %d" x
936 let ty_of_int = function
941 | x -> `Unknown x (* newer libvirt *)
951 let string_of_status = function
952 | `Completed -> "Completed"
953 | `Failed -> "Failed"
954 | `Cancelled -> "Cancelled"
956 | `Unknown x -> Printf.sprintf "Unknown Block_job.status: %d" x
958 let status_of_int = function
971 let to_string t = Printf.sprintf "{ disk = %s; ty = %s; status = %s }"
972 (string_option t.disk)
974 (string_of_status t.status)
976 let make (disk, ty, status) = {
979 status = status_of_int ty;
983 module Disk_change = struct
989 let string_of_reason = function
990 | `MissingOnStart -> "MissingOnStart"
991 | `Unknown x -> Printf.sprintf "Unknown Disk_change.reason: %d" x
993 let reason_of_int = function
994 | 0 -> `MissingOnStart
998 old_src_path: string option;
999 new_src_path: string option;
1000 dev_alias: string option;
1005 let o = Printf.sprintf "old_src_path = %s" (string_option t.old_src_path) in
1006 let n = Printf.sprintf "new_src_path = %s" (string_option t.new_src_path) in
1007 let d = Printf.sprintf "dev_alias = %s" (string_option t.dev_alias) in
1008 let r = string_of_reason t.reason in
1009 "{ " ^ (String.concat "; " [ o; n; d; r ]) ^ " }"
1011 let make (o, n, d, r) = {
1015 reason = reason_of_int r;
1019 module Tray_change = struct
1026 let string_of_reason = function
1029 | `Unknown x -> Printf.sprintf "Unknown Tray_change.reason: %d" x
1031 let reason_of_int = function
1037 dev_alias: string option;
1041 let to_string t = Printf.sprintf
1042 "{ dev_alias = %s; reason = %s }"
1043 (string_option t.dev_alias)
1044 (string_of_reason t.reason)
1046 let make (dev_alias, reason) = {
1047 dev_alias = dev_alias;
1048 reason = reason_of_int reason;
1052 module PM_wakeup = struct
1059 let to_string = function
1060 | `Unknown x -> Printf.sprintf "Unknown PM_wakeup.reason: %d" x
1062 let make x = `Unknown x
1065 module PM_suspend = struct
1072 let to_string = function
1073 | `Unknown x -> Printf.sprintf "Unknown PM_suspend.reason: %d" x
1075 let make x = `Unknown x
1078 module Balloon_change = struct
1081 let to_string = Int64.to_string
1085 module PM_suspend_disk = struct
1092 let to_string = function
1093 | `Unknown x -> Printf.sprintf "Unknown PM_suspend_disk.reason: %d" x
1095 let make x = `Unknown x
1099 | Lifecycle of ([`R] Domain.t -> Lifecycle.t -> unit)
1100 | Reboot of ([`R] Domain.t -> Reboot.t -> unit)
1101 | RtcChange of ([`R] Domain.t -> Rtc_change.t -> unit)
1102 | Watchdog of ([`R] Domain.t -> Watchdog.t -> unit)
1103 | IOError of ([`R] Domain.t -> Io_error.t -> unit)
1104 | Graphics of ([`R] Domain.t -> Graphics.t -> unit)
1105 | IOErrorReason of ([`R] Domain.t -> Io_error.t -> unit)
1106 | ControlError of ([`R] Domain.t -> Control_error.t -> unit)
1107 | BlockJob of ([`R] Domain.t -> Block_job.t -> unit)
1108 | DiskChange of ([`R] Domain.t -> Disk_change.t -> unit)
1109 | TrayChange of ([`R] Domain.t -> Tray_change.t -> unit)
1110 | PMWakeUp of ([`R] Domain.t -> PM_wakeup.t -> unit)
1111 | PMSuspend of ([`R] Domain.t -> PM_suspend.t -> unit)
1112 | BalloonChange of ([`R] Domain.t -> Balloon_change.t -> unit)
1113 | PMSuspendDisk of ([`R] Domain.t -> PM_suspend_disk.t -> unit)
1115 type callback_id = int64
1117 let fresh_callback_id =
1118 let next = ref 0L in
1120 let result = !next in
1121 next := Int64.succ !next;
1124 let make_table value_name =
1125 let table = Hashtbl.create 16 in
1126 let callback callback_id generic x =
1127 if Hashtbl.mem table callback_id
1128 then Hashtbl.find table callback_id generic x in
1129 let _ = Callback.register value_name callback in
1132 let u_table = make_table "Libvirt.u_callback"
1133 let i_table = make_table "Libvirt.i_callback"
1134 let i64_table = make_table "Libvirt.i64_callback"
1135 let i_i_table = make_table "Libvirt.i_i_callback"
1136 let s_i_table = make_table "Libvirt.s_i_callback"
1137 let s_i_i_table = make_table "Libvirt.s_i_i_callback"
1138 let s_s_i_table = make_table "Libvirt.s_s_i_callback"
1139 let s_s_i_s_table = make_table "Libvirt.s_s_i_s_callback"
1140 let s_s_s_i_table = make_table "Libvirt.s_s_s_i_callback"
1141 let i_ga_ga_s_gs_table = make_table "Libvirt.i_ga_ga_s_gs_callback"
1143 external register_default_impl : unit -> unit = "ocaml_libvirt_event_register_default_impl"
1145 external run_default_impl : unit -> unit = "ocaml_libvirt_event_run_default_impl"
1147 external register_any' : 'a Connect.t -> 'a Domain.t option -> callback -> callback_id -> int = "ocaml_libvirt_connect_domain_event_register_any"
1149 external deregister_any' : 'a Connect.t -> int -> unit = "ocaml_libvirt_connect_domain_event_deregister_any"
1151 let our_id_to_libvirt_id = Hashtbl.create 16
1153 let register_any conn ?dom callback =
1154 let id = fresh_callback_id () in
1155 begin match callback with
1157 Hashtbl.add i_i_table id (fun dom x ->
1158 f dom (Lifecycle.make x)
1161 Hashtbl.add u_table id (fun dom x ->
1162 f dom (Reboot.make x)
1165 Hashtbl.add i64_table id (fun dom x ->
1166 f dom (Rtc_change.make x)
1169 Hashtbl.add i_table id (fun dom x ->
1170 f dom (Watchdog.make x)
1173 Hashtbl.add s_s_i_table id (fun dom x ->
1174 f dom (Io_error.make_noreason x)
1177 Hashtbl.add i_ga_ga_s_gs_table id (fun dom x ->
1178 f dom (Graphics.make x)
1180 | IOErrorReason f ->
1181 Hashtbl.add s_s_i_s_table id (fun dom x ->
1182 f dom (Io_error.make x)
1185 Hashtbl.add u_table id (fun dom x ->
1186 f dom (Control_error.make x)
1189 Hashtbl.add s_i_i_table id (fun dom x ->
1190 f dom (Block_job.make x)
1193 Hashtbl.add s_s_s_i_table id (fun dom x ->
1194 f dom (Disk_change.make x)
1197 Hashtbl.add s_i_table id (fun dom x ->
1198 f dom (Tray_change.make x)
1201 Hashtbl.add i_table id (fun dom x ->
1202 f dom (PM_wakeup.make x)
1205 Hashtbl.add i_table id (fun dom x ->
1206 f dom (PM_suspend.make x)
1208 | BalloonChange f ->
1209 Hashtbl.add i64_table id (fun dom x ->
1210 f dom (Balloon_change.make x)
1212 | PMSuspendDisk f ->
1213 Hashtbl.add i_table id (fun dom x ->
1214 f dom (PM_suspend_disk.make x)
1217 let libvirt_id = register_any' conn dom callback id in
1218 Hashtbl.replace our_id_to_libvirt_id id libvirt_id;
1221 let deregister_any conn id =
1222 if Hashtbl.mem our_id_to_libvirt_id id then begin
1223 let libvirt_id = Hashtbl.find our_id_to_libvirt_id id in
1224 deregister_any' conn libvirt_id
1226 Hashtbl.remove our_id_to_libvirt_id id;
1227 Hashtbl.remove u_table id;
1228 Hashtbl.remove i_table id;
1229 Hashtbl.remove i64_table id;
1230 Hashtbl.remove i_i_table id;
1231 Hashtbl.remove s_i_table id;
1232 Hashtbl.remove s_i_i_table id;
1233 Hashtbl.remove s_s_i_table id;
1234 Hashtbl.remove s_s_i_s_table id;
1235 Hashtbl.remove s_s_s_i_table id;
1236 Hashtbl.remove i_ga_ga_s_gs_table id
1238 let timeout_table = Hashtbl.create 16
1241 if Hashtbl.mem timeout_table x
1242 then Hashtbl.find timeout_table x () in
1243 Callback.register "Libvirt.timeout_callback" callback
1245 type timer_id = int64
1247 external add_timeout' : 'a Connect.t -> int -> int64 -> int = "ocaml_libvirt_event_add_timeout"
1249 external remove_timeout' : 'a Connect.t -> int -> unit = "ocaml_libvirt_event_remove_timeout"
1251 let our_id_to_timer_id = Hashtbl.create 16
1252 let add_timeout conn ms fn =
1253 let id = fresh_callback_id () in
1254 Hashtbl.add timeout_table id fn;
1255 let timer_id = add_timeout' conn ms id in
1256 Hashtbl.add our_id_to_timer_id id timer_id;
1259 let remove_timeout conn id =
1260 if Hashtbl.mem our_id_to_timer_id id then begin
1261 let timer_id = Hashtbl.find our_id_to_timer_id id in
1262 remove_timeout' conn timer_id
1264 Hashtbl.remove our_id_to_timer_id id;
1265 Hashtbl.remove timeout_table id
1272 external lookup_by_name : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_network_lookup_by_name"
1273 external lookup_by_uuid : 'a Connect.t -> uuid -> 'a t = "ocaml_libvirt_network_lookup_by_uuid"
1274 external lookup_by_uuid_string : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_network_lookup_by_uuid_string"
1275 external create_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_network_create_xml"
1276 external define_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_network_define_xml"
1277 external undefine : [>`W] t -> unit = "ocaml_libvirt_network_undefine"
1278 external create : [>`W] t -> unit = "ocaml_libvirt_network_create"
1279 external destroy : [>`W] t -> unit = "ocaml_libvirt_network_destroy"
1280 external free : [>`R] t -> unit = "ocaml_libvirt_network_free"
1281 external get_name : [>`R] t -> string = "ocaml_libvirt_network_get_name"
1282 external get_uuid : [>`R] t -> uuid = "ocaml_libvirt_network_get_uuid"
1283 external get_uuid_string : [>`R] t -> string = "ocaml_libvirt_network_get_uuid_string"
1284 external get_xml_desc : [>`R] t -> xml = "ocaml_libvirt_network_get_xml_desc"
1285 external get_bridge_name : [>`R] t -> string = "ocaml_libvirt_network_get_bridge_name"
1286 external get_autostart : [>`R] t -> bool = "ocaml_libvirt_network_get_autostart"
1287 external set_autostart : [>`W] t -> bool -> unit = "ocaml_libvirt_network_set_autostart"
1289 external const : [>`R] t -> ro t = "%identity"
1295 type pool_state = Inactive | Building | Running | Degraded
1296 type pool_build_flags = New | Repair | Resize
1297 type pool_delete_flags = Normal | Zeroed
1305 external lookup_by_name : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_pool_lookup_by_name"
1306 external lookup_by_uuid : 'a Connect.t -> uuid -> 'a t = "ocaml_libvirt_storage_pool_lookup_by_uuid"
1307 external lookup_by_uuid_string : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_pool_lookup_by_uuid_string"
1308 external create_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_storage_pool_create_xml"
1309 external define_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_storage_pool_define_xml"
1310 external build : [>`W] t -> pool_build_flags -> unit = "ocaml_libvirt_storage_pool_build"
1311 external undefine : [>`W] t -> unit = "ocaml_libvirt_storage_pool_undefine"
1312 external create : [>`W] t -> unit = "ocaml_libvirt_storage_pool_create"
1313 external destroy : [>`W] t -> unit = "ocaml_libvirt_storage_pool_destroy"
1314 external delete : [>`W] t -> unit = "ocaml_libvirt_storage_pool_delete"
1315 external free : [>`R] t -> unit = "ocaml_libvirt_storage_pool_free"
1316 external refresh : [`R] t -> unit = "ocaml_libvirt_storage_pool_refresh"
1317 external get_name : [`R] t -> string = "ocaml_libvirt_storage_pool_get_name"
1318 external get_uuid : [`R] t -> uuid = "ocaml_libvirt_storage_pool_get_uuid"
1319 external get_uuid_string : [`R] t -> string = "ocaml_libvirt_storage_pool_get_uuid_string"
1320 external get_info : [`R] t -> pool_info = "ocaml_libvirt_storage_pool_get_info"
1321 external get_xml_desc : [`R] t -> xml = "ocaml_libvirt_storage_pool_get_xml_desc"
1322 external get_autostart : [`R] t -> bool = "ocaml_libvirt_storage_pool_get_autostart"
1323 external set_autostart : [>`W] t -> bool -> unit = "ocaml_libvirt_storage_pool_set_autostart"
1324 external num_of_volumes : [`R] t -> int = "ocaml_libvirt_storage_pool_num_of_volumes"
1325 external list_volumes : [`R] t -> int -> string array = "ocaml_libvirt_storage_pool_list_volumes"
1326 external const : [>`R] t -> ro t = "%identity"
1332 type vol_type = File | Block
1333 type vol_delete_flags = Normal | Zeroed
1340 external lookup_by_name : 'a Pool.t -> string -> 'a t = "ocaml_libvirt_storage_vol_lookup_by_name"
1341 external lookup_by_key : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_vol_lookup_by_key"
1342 external lookup_by_path : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_vol_lookup_by_path"
1343 external pool_of_volume : 'a t -> 'a Pool.t = "ocaml_libvirt_storage_pool_lookup_by_volume"
1344 external get_name : [`R] t -> string = "ocaml_libvirt_storage_vol_get_name"
1345 external get_key : [`R] t -> string = "ocaml_libvirt_storage_vol_get_key"
1346 external get_path : [`R] t -> string = "ocaml_libvirt_storage_vol_get_path"
1347 external get_info : [`R] t -> vol_info = "ocaml_libvirt_storage_vol_get_info"
1348 external get_xml_desc : [`R] t -> xml = "ocaml_libvirt_storage_vol_get_xml_desc"
1349 external create_xml : [>`W] Pool.t -> xml -> unit = "ocaml_libvirt_storage_vol_create_xml"
1350 external delete : [>`W] t -> vol_delete_flags -> unit = "ocaml_libvirt_storage_vol_delete"
1351 external free : [>`R] t -> unit = "ocaml_libvirt_storage_vol_free"
1352 external const : [>`R] t -> ro t = "%identity"
1355 (* Initialization. *)
1356 external c_init : unit -> unit = "ocaml_libvirt_init"
1358 Callback.register_exception
1359 "ocaml_libvirt_virterror" (Virterror (Virterror.no_error ()));
1360 Callback.register_exception
1361 "ocaml_libvirt_not_supported" (Not_supported "");