Fix Volume.lookup_by_key and Volume.lookup_by_path
[virt-top.git] / libvirt / libvirt.ml
1 (* OCaml bindings for libvirt.
2    (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
3    http://libvirt.org/
4
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
10    This library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with this library; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
18 *)
19
20 type uuid = string
21
22 type xml = string
23
24 type filename = string
25
26 external get_version : ?driver:string -> unit -> int * int = "ocaml_libvirt_get_version"
27
28 let uuid_length = 16
29 let uuid_string_length = 36
30
31 (* http://caml.inria.fr/pub/ml-archives/caml-list/2004/07/80683af867cce6bf8fff273973f70c95.en.html *)
32 type rw = [`R|`W]
33 type ro = [`R]
34
35 type ('a, 'b) job_t
36
37 module Connect =
38 struct
39   type 'rw t
40
41   type node_info = {
42     model : string;
43     memory : int64;
44     cpus : int;
45     mhz : int;
46     nodes : int;
47     sockets : int;
48     cores : int;
49     threads : int;
50   }
51
52   external connect : ?name:string -> unit -> rw t = "ocaml_libvirt_connect_open"
53   external connect_readonly : ?name:string -> unit -> ro t = "ocaml_libvirt_connect_open_readonly"
54   external close : [>`R] t -> unit = "ocaml_libvirt_connect_close"
55   external get_type : [>`R] t -> string = "ocaml_libvirt_connect_get_type"
56   external get_version : [>`R] t -> int = "ocaml_libvirt_connect_get_version"
57   external get_hostname : [>`R] t -> string = "ocaml_libvirt_connect_get_hostname"
58   external get_uri : [>`R] t -> string = "ocaml_libvirt_connect_get_uri"
59   external get_max_vcpus : [>`R] t -> ?type_:string -> unit -> int = "ocaml_libvirt_connect_get_max_vcpus"
60   external list_domains : [>`R] t -> int -> int array = "ocaml_libvirt_connect_list_domains"
61   external num_of_domains : [>`R] t -> int = "ocaml_libvirt_connect_num_of_domains"
62   external get_capabilities : [>`R] t -> xml = "ocaml_libvirt_connect_get_capabilities"
63   external num_of_defined_domains : [>`R] t -> int = "ocaml_libvirt_connect_num_of_defined_domains"
64   external list_defined_domains : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_defined_domains"
65   external num_of_networks : [>`R] t -> int = "ocaml_libvirt_connect_num_of_networks"
66   external list_networks : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_networks"
67   external num_of_defined_networks : [>`R] t -> int = "ocaml_libvirt_connect_num_of_defined_networks"
68   external list_defined_networks : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_defined_networks"
69   external num_of_pools : [>`R] t -> int = "ocaml_libvirt_connect_num_of_storage_pools"
70   external list_pools : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_storage_pools"
71   external num_of_defined_pools : [>`R] t -> int = "ocaml_libvirt_connect_num_of_defined_storage_pools"
72   external list_defined_pools : [>`R] t -> int -> string array = "ocaml_libvirt_connect_list_defined_storage_pools"
73
74   external get_node_info : [>`R] t -> node_info = "ocaml_libvirt_connect_get_node_info"
75   external node_get_free_memory : [> `R] t -> int64 = "ocaml_libvirt_connect_node_get_free_memory"
76   external node_get_cells_free_memory : [> `R] t -> int -> int -> int64 array = "ocaml_libvirt_connect_node_get_cells_free_memory"
77
78   (* See VIR_NODEINFO_MAXCPUS macro defined in <libvirt.h>. *)
79   let maxcpus_of_node_info { nodes = nodes; sockets = sockets;
80                              cores = cores; threads = threads } =
81     nodes * sockets * cores * threads
82
83   (* See VIR_CPU_MAPLEN macro defined in <libvirt.h>. *)
84   let cpumaplen nr_cpus =
85     (nr_cpus + 7) / 8
86
87   (* See VIR_USE_CPU, VIR_UNUSE_CPU, VIR_CPU_USABLE macros defined in <libvirt.h>. *)
88   let use_cpu cpumap cpu =
89     cpumap.[cpu/8] <-
90       Char.chr (Char.code cpumap.[cpu/8] lor (1 lsl (cpu mod 8)))
91   let unuse_cpu cpumap cpu =
92     cpumap.[cpu/8] <-
93       Char.chr (Char.code cpumap.[cpu/8] land (lnot (1 lsl (cpu mod 8))))
94   let cpu_usable cpumaps maplen vcpu cpu =
95     Char.code cpumaps.[vcpu*maplen + cpu/8] land (1 lsl (cpu mod 8)) <> 0
96
97   external const : [>`R] t -> ro t = "%identity"
98 end
99
100 module Domain =
101 struct
102   type 'rw t
103
104   type state =
105     | InfoNoState | InfoRunning | InfoBlocked | InfoPaused
106     | InfoShutdown | InfoShutoff | InfoCrashed
107
108   type info = {
109     state : state;
110     max_mem : int64;
111     memory : int64;
112     nr_virt_cpu : int;
113     cpu_time : int64;
114   }
115
116   type vcpu_state = VcpuOffline | VcpuRunning | VcpuBlocked
117
118   type vcpu_info = {
119     number : int;
120     vcpu_state : vcpu_state;
121     vcpu_time : int64;
122     cpu : int;
123   }
124
125   type sched_param = string * sched_param_value
126   and sched_param_value =
127     | SchedFieldInt32 of int32 | SchedFieldUInt32 of int32
128     | SchedFieldInt64 of int64 | SchedFieldUInt64 of int64
129     | SchedFieldFloat of float | SchedFieldBool of bool
130
131   type migrate_flag = Live
132
133   type block_stats = {
134     rd_req : int64;
135     rd_bytes : int64;
136     wr_req : int64;
137     wr_bytes : int64;
138     errs : int64;
139   }
140
141   type interface_stats = {
142     rx_bytes : int64;
143     rx_packets : int64;
144     rx_errs : int64;
145     rx_drop : int64;
146     tx_bytes : int64;
147     tx_packets : int64;
148     tx_errs : int64;
149     tx_drop : int64;
150   }
151
152   external create_linux : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_domain_create_linux"
153   external create_linux_job : [>`W] Connect.t -> xml -> ([`Domain], rw) job_t = "ocaml_libvirt_domain_create_linux_job"
154   external lookup_by_id : 'a Connect.t -> int -> 'a t = "ocaml_libvirt_domain_lookup_by_id"
155   external lookup_by_uuid : 'a Connect.t -> uuid -> 'a t = "ocaml_libvirt_domain_lookup_by_uuid"
156   external lookup_by_uuid_string : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_domain_lookup_by_uuid_string"
157   external lookup_by_name : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_domain_lookup_by_name"
158   external destroy : [>`W] t -> unit = "ocaml_libvirt_domain_destroy"
159   external free : [>`R] t -> unit = "ocaml_libvirt_domain_free"
160   external suspend : [>`W] t -> unit = "ocaml_libvirt_domain_suspend"
161   external resume : [>`W] t -> unit = "ocaml_libvirt_domain_resume"
162   external save : [>`W] t -> filename -> unit = "ocaml_libvirt_domain_save"
163   external save_job : [>`W] t -> filename -> ([`Domain_nocreate], rw) job_t = "ocaml_libvirt_domain_save_job"
164   external restore : [>`W] Connect.t -> filename -> unit = "ocaml_libvirt_domain_restore"
165   external restore_job : [>`W] Connect.t -> filename -> ([`Domain_nocreate], rw) job_t = "ocaml_libvirt_domain_restore_job"
166   external core_dump : [>`W] t -> filename -> unit = "ocaml_libvirt_domain_core_dump"
167   external core_dump_job : [>`W] t -> filename -> ([`Domain_nocreate], rw) job_t = "ocaml_libvirt_domain_core_dump_job"
168   external shutdown : [>`W] t -> unit = "ocaml_libvirt_domain_shutdown"
169   external reboot : [>`W] t -> unit = "ocaml_libvirt_domain_reboot"
170   external get_name : [>`R] t -> string = "ocaml_libvirt_domain_get_name"
171   external get_uuid : [>`R] t -> uuid = "ocaml_libvirt_domain_get_uuid"
172   external get_uuid_string : [>`R] t -> string = "ocaml_libvirt_domain_get_uuid_string"
173   external get_id : [>`R] t -> int = "ocaml_libvirt_domain_get_id"
174   external get_os_type : [>`R] t -> string = "ocaml_libvirt_domain_get_os_type"
175   external get_max_memory : [>`R] t -> int64 = "ocaml_libvirt_domain_get_max_memory"
176   external set_max_memory : [>`W] t -> int64 -> unit = "ocaml_libvirt_domain_set_max_memory"
177   external set_memory : [>`W] t -> int64 -> unit = "ocaml_libvirt_domain_set_memory"
178   external get_info : [>`R] t -> info = "ocaml_libvirt_domain_get_info"
179   external get_xml_desc : [>`R] t -> xml = "ocaml_libvirt_domain_get_xml_desc"
180   external get_scheduler_type : [>`R] t -> string * int = "ocaml_libvirt_domain_get_scheduler_type"
181   external get_scheduler_parameters : [>`R] t -> int -> sched_param array = "ocaml_libvirt_domain_get_scheduler_parameters"
182   external set_scheduler_parameters : [>`W] t -> sched_param array -> unit = "ocaml_libvirt_domain_set_scheduler_parameters"
183   external define_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_domain_define_xml"
184   external undefine : [>`W] t -> unit = "ocaml_libvirt_domain_undefine"
185   external create : [>`W] t -> unit = "ocaml_libvirt_domain_create"
186   external create_job : [>`W] t -> ([`Domain_nocreate], rw) job_t = "ocaml_libvirt_domain_create_job"
187   external get_autostart : [>`R] t -> bool = "ocaml_libvirt_domain_get_autostart"
188   external set_autostart : [>`W] t -> bool -> unit = "ocaml_libvirt_domain_set_autostart"
189   external set_vcpus : [>`W] t -> int -> unit = "ocaml_libvirt_domain_set_vcpus"
190   external pin_vcpu : [>`W] t -> int -> string -> unit = "ocaml_libvirt_domain_pin_vcpu"
191   external get_vcpus : [>`R] t -> int -> int -> int * vcpu_info array * string = "ocaml_libvirt_domain_get_vcpus"
192   external get_max_vcpus : [>`R] t -> int = "ocaml_libvirt_domain_get_max_vcpus"
193   external attach_device : [>`W] t -> xml -> unit = "ocaml_libvirt_domain_attach_device"
194   external detach_device : [>`W] t -> xml -> unit = "ocaml_libvirt_domain_detach_device"
195   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"
196   external block_stats : [>`R] t -> string -> block_stats = "ocaml_libvirt_domain_block_stats"
197   external interface_stats : [>`R] t -> string -> interface_stats = "ocaml_libvirt_domain_interface_stats"
198
199   external const : [>`R] t -> ro t = "%identity"
200 end
201
202 module Network =
203 struct
204   type 'rw t
205
206   external lookup_by_name : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_network_lookup_by_name"
207   external lookup_by_uuid : 'a Connect.t -> uuid -> 'a t = "ocaml_libvirt_network_lookup_by_uuid"
208   external lookup_by_uuid_string : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_network_lookup_by_uuid_string"
209   external create_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_network_create_xml"
210   external create_xml_job : [>`W] Connect.t -> xml -> ([`Network], rw) job_t = "ocaml_libvirt_network_create_xml_job"
211   external define_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_network_define_xml"
212   external undefine : [>`W] t -> unit = "ocaml_libvirt_network_undefine"
213   external create : [>`W] t -> unit = "ocaml_libvirt_network_create"
214   external create_job : [>`W] t -> ([`Network_nocreate], rw) job_t = "ocaml_libvirt_network_create_job"
215   external destroy : [>`W] t -> unit = "ocaml_libvirt_network_destroy"
216   external free : [>`R] t -> unit = "ocaml_libvirt_network_free"
217   external get_name : [>`R] t -> string = "ocaml_libvirt_network_get_name"
218   external get_uuid : [>`R] t -> uuid = "ocaml_libvirt_network_get_uuid"
219   external get_uuid_string : [>`R] t -> string = "ocaml_libvirt_network_get_uuid_string"
220   external get_xml_desc : [>`R] t -> xml = "ocaml_libvirt_network_get_xml_desc"
221   external get_bridge_name : [>`R] t -> string = "ocaml_libvirt_network_get_bridge_name"
222   external get_autostart : [>`R] t -> bool = "ocaml_libvirt_network_get_autostart"
223   external set_autostart : [>`W] t -> bool -> unit = "ocaml_libvirt_network_set_autostart"
224
225   external const : [>`R] t -> ro t = "%identity"
226 end
227
228 module Pool =
229 struct
230   type 'rw t
231   type pool_state = Inactive | Active
232   type pool_info = {
233     state : pool_state;
234     capacity : int64;
235     allocation : int64;
236   }
237
238   external lookup_by_name : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_pool_lookup_by_name"
239   external lookup_by_uuid : 'a Connect.t -> uuid -> 'a t = "ocaml_libvirt_storage_pool_lookup_by_uuid"
240   external lookup_by_uuid_string : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_pool_lookup_by_uuid_string"
241   external create_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_storage_pool_create_xml"
242   external define_xml : [>`W] Connect.t -> xml -> rw t = "ocaml_libvirt_storage_pool_define_xml"
243   external undefine : [>`W] t -> unit = "ocaml_libvirt_storage_pool_undefine"
244   external create : [>`W] t -> unit = "ocaml_libvirt_storage_pool_create"
245   external destroy : [>`W] t -> unit = "ocaml_libvirt_storage_pool_destroy"
246   external shutdown : [>`W] t -> unit = "ocaml_libvirt_storage_pool_shutdown"
247   external free : [>`R] t -> unit = "ocaml_libvirt_storage_pool_free"
248   external refresh : [`R] t -> unit = "ocaml_libvirt_storage_pool_refresh"
249   external get_name : [`R] t -> string = "ocaml_libvirt_storage_pool_get_name"
250   external get_uuid : [`R] t -> uuid = "ocaml_libvirt_storage_pool_get_uuid"
251   external get_uuid_string : [`R] t -> string = "ocaml_libvirt_storage_pool_get_uuid_string"
252   external get_info : [`R] t -> pool_info = "ocaml_libvirt_storage_pool_get_info"
253   external get_xml_desc : [`R] t -> xml = "ocaml_libvirt_storage_pool_get_xml_desc"
254   external get_autostart : [`R] t -> bool = "ocaml_libvirt_storage_pool_get_autostart"
255   external set_autostart : [`W] t -> bool -> unit = "ocaml_libvirt_storage_pool_set_autostart"
256   external const : [>`R] t -> ro t = "%identity"
257 end
258
259 module Volume =
260 struct
261   type 'rw t
262   type vol_type = File | Block | Virtual
263   type vol_info = {
264     typ : vol_type;
265     capacity : int64;
266     allocation : int64;
267   }
268
269   external lookup_by_name : 'a Pool.t -> string -> 'a t = "ocaml_libvirt_storage_vol_lookup_by_name"
270   external lookup_by_key : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_vol_lookup_by_key"
271   external lookup_by_path : 'a Connect.t -> string -> 'a t = "ocaml_libvirt_storage_vol_lookup_by_path"
272   external pool_of_volume : 'a t -> 'a Pool.t = "ocaml_libvirt_storage_pool_lookup_by_volume"
273   external get_name : [`R] t -> string = "ocaml_libvirt_storage_vol_get_name"
274   external get_key : [`R] t -> string = "ocaml_libvirt_storage_vol_get_key"
275   external get_path : [`R] t -> string = "ocaml_libvirt_storage_vol_get_path"
276   external get_info : [`R] t -> vol_info = "ocaml_libvirt_storage_vol_get_info"
277   external get_xml_desc : [`R] t -> xml = "ocaml_libvirt_storage_vol_get_xml_desc"
278   external create_xml : [`W] Pool.t -> xml -> unit = "ocaml_libvirt_storage_vol_create_xml"
279   external destroy : [`W] t -> unit = "ocaml_libvirt_storage_vol_destroy"
280   external free : [>`R] t -> unit = "ocaml_libvirt_storage_vol_free"
281   external const : [>`R] t -> ro t = "%identity"
282 end
283
284 module Job =
285 struct
286   type ('jobclass, 'rw) t = ('jobclass, 'rw) job_t
287   type job_type = Bounded | Unbounded
288   type job_state = Running | Complete | Failed | Cancelled
289   type job_info = {
290     typ : job_type;
291     state : job_state;
292     running_time : int;
293     remaining_time : int;
294     percent_complete : int
295   }
296   external get_info : ('a,'b) t -> job_info = "ocaml_libvirt_job_get_info"
297   external get_domain : ([`Domain], 'a) t -> 'a Domain.t = "ocaml_libvirt_job_get_domain"
298   external get_network : ([`Network], 'a) t -> 'a Network.t = "ocaml_libvirt_job_get_network"
299   external cancel : ('a,'b) t -> unit = "ocaml_libvirt_job_cancel"
300   external free : ('a, [>`R]) t -> unit = "ocaml_libvirt_job_free"
301   external const : ('a, [>`R]) t -> ('a, ro) t = "%identity"
302 end
303
304 module Virterror =
305 struct
306   type code =
307     | VIR_ERR_OK
308     | VIR_ERR_INTERNAL_ERROR
309     | VIR_ERR_NO_MEMORY
310     | VIR_ERR_NO_SUPPORT
311     | VIR_ERR_UNKNOWN_HOST
312     | VIR_ERR_NO_CONNECT
313     | VIR_ERR_INVALID_CONN
314     | VIR_ERR_INVALID_DOMAIN
315     | VIR_ERR_INVALID_ARG
316     | VIR_ERR_OPERATION_FAILED
317     | VIR_ERR_GET_FAILED
318     | VIR_ERR_POST_FAILED
319     | VIR_ERR_HTTP_ERROR
320     | VIR_ERR_SEXPR_SERIAL
321     | VIR_ERR_NO_XEN
322     | VIR_ERR_XEN_CALL
323     | VIR_ERR_OS_TYPE
324     | VIR_ERR_NO_KERNEL
325     | VIR_ERR_NO_ROOT
326     | VIR_ERR_NO_SOURCE
327     | VIR_ERR_NO_TARGET
328     | VIR_ERR_NO_NAME
329     | VIR_ERR_NO_OS
330     | VIR_ERR_NO_DEVICE
331     | VIR_ERR_NO_XENSTORE
332     | VIR_ERR_DRIVER_FULL
333     | VIR_ERR_CALL_FAILED
334     | VIR_ERR_XML_ERROR
335     | VIR_ERR_DOM_EXIST
336     | VIR_ERR_OPERATION_DENIED
337     | VIR_ERR_OPEN_FAILED
338     | VIR_ERR_READ_FAILED
339     | VIR_ERR_PARSE_FAILED
340     | VIR_ERR_CONF_SYNTAX
341     | VIR_ERR_WRITE_FAILED
342     | VIR_ERR_XML_DETAIL
343     | VIR_ERR_INVALID_NETWORK
344     | VIR_ERR_NETWORK_EXIST
345     | VIR_ERR_SYSTEM_ERROR
346     | VIR_ERR_RPC
347     | VIR_ERR_GNUTLS_ERROR
348     | VIR_WAR_NO_NETWORK
349     | VIR_ERR_NO_DOMAIN
350     | VIR_ERR_NO_NETWORK
351     | VIR_ERR_INVALID_MAC
352     | VIR_ERR_AUTH_FAILED
353     | VIR_ERR_INVALID_STORAGE_POOL
354     | VIR_ERR_INVALID_STORAGE_VOL
355     | VIR_WAR_NO_STORAGE
356     | VIR_ERR_NO_STORAGE_POOL
357     | VIR_ERR_NO_STORAGE_VOL
358     | VIR_ERR_UNKNOWN of int
359
360   let string_of_code = function
361     | VIR_ERR_OK -> "VIR_ERR_OK"
362     | VIR_ERR_INTERNAL_ERROR -> "VIR_ERR_INTERNAL_ERROR"
363     | VIR_ERR_NO_MEMORY -> "VIR_ERR_NO_MEMORY"
364     | VIR_ERR_NO_SUPPORT -> "VIR_ERR_NO_SUPPORT"
365     | VIR_ERR_UNKNOWN_HOST -> "VIR_ERR_UNKNOWN_HOST"
366     | VIR_ERR_NO_CONNECT -> "VIR_ERR_NO_CONNECT"
367     | VIR_ERR_INVALID_CONN -> "VIR_ERR_INVALID_CONN"
368     | VIR_ERR_INVALID_DOMAIN -> "VIR_ERR_INVALID_DOMAIN"
369     | VIR_ERR_INVALID_ARG -> "VIR_ERR_INVALID_ARG"
370     | VIR_ERR_OPERATION_FAILED -> "VIR_ERR_OPERATION_FAILED"
371     | VIR_ERR_GET_FAILED -> "VIR_ERR_GET_FAILED"
372     | VIR_ERR_POST_FAILED -> "VIR_ERR_POST_FAILED"
373     | VIR_ERR_HTTP_ERROR -> "VIR_ERR_HTTP_ERROR"
374     | VIR_ERR_SEXPR_SERIAL -> "VIR_ERR_SEXPR_SERIAL"
375     | VIR_ERR_NO_XEN -> "VIR_ERR_NO_XEN"
376     | VIR_ERR_XEN_CALL -> "VIR_ERR_XEN_CALL"
377     | VIR_ERR_OS_TYPE -> "VIR_ERR_OS_TYPE"
378     | VIR_ERR_NO_KERNEL -> "VIR_ERR_NO_KERNEL"
379     | VIR_ERR_NO_ROOT -> "VIR_ERR_NO_ROOT"
380     | VIR_ERR_NO_SOURCE -> "VIR_ERR_NO_SOURCE"
381     | VIR_ERR_NO_TARGET -> "VIR_ERR_NO_TARGET"
382     | VIR_ERR_NO_NAME -> "VIR_ERR_NO_NAME"
383     | VIR_ERR_NO_OS -> "VIR_ERR_NO_OS"
384     | VIR_ERR_NO_DEVICE -> "VIR_ERR_NO_DEVICE"
385     | VIR_ERR_NO_XENSTORE -> "VIR_ERR_NO_XENSTORE"
386     | VIR_ERR_DRIVER_FULL -> "VIR_ERR_DRIVER_FULL"
387     | VIR_ERR_CALL_FAILED -> "VIR_ERR_CALL_FAILED"
388     | VIR_ERR_XML_ERROR -> "VIR_ERR_XML_ERROR"
389     | VIR_ERR_DOM_EXIST -> "VIR_ERR_DOM_EXIST"
390     | VIR_ERR_OPERATION_DENIED -> "VIR_ERR_OPERATION_DENIED"
391     | VIR_ERR_OPEN_FAILED -> "VIR_ERR_OPEN_FAILED"
392     | VIR_ERR_READ_FAILED -> "VIR_ERR_READ_FAILED"
393     | VIR_ERR_PARSE_FAILED -> "VIR_ERR_PARSE_FAILED"
394     | VIR_ERR_CONF_SYNTAX -> "VIR_ERR_CONF_SYNTAX"
395     | VIR_ERR_WRITE_FAILED -> "VIR_ERR_WRITE_FAILED"
396     | VIR_ERR_XML_DETAIL -> "VIR_ERR_XML_DETAIL"
397     | VIR_ERR_INVALID_NETWORK -> "VIR_ERR_INVALID_NETWORK"
398     | VIR_ERR_NETWORK_EXIST -> "VIR_ERR_NETWORK_EXIST"
399     | VIR_ERR_SYSTEM_ERROR -> "VIR_ERR_SYSTEM_ERROR"
400     | VIR_ERR_RPC -> "VIR_ERR_RPC"
401     | VIR_ERR_GNUTLS_ERROR -> "VIR_ERR_GNUTLS_ERROR"
402     | VIR_WAR_NO_NETWORK -> "VIR_WAR_NO_NETWORK"
403     | VIR_ERR_NO_DOMAIN -> "VIR_ERR_NO_DOMAIN"
404     | VIR_ERR_NO_NETWORK -> "VIR_ERR_NO_NETWORK"
405     | VIR_ERR_INVALID_MAC -> "VIR_ERR_INVALID_MAC"
406     | VIR_ERR_AUTH_FAILED -> "VIR_ERR_AUTH_FAILED"
407     | VIR_ERR_INVALID_STORAGE_POOL -> "VIR_ERR_INVALID_STORAGE_POOL"
408     | VIR_ERR_INVALID_STORAGE_VOL -> "VIR_ERR_INVALID_STORAGE_VOL"
409     | VIR_WAR_NO_STORAGE -> "VIR_WAR_NO_STORAGE"
410     | VIR_ERR_NO_STORAGE_POOL -> "VIR_ERR_NO_STORAGE_POOL"
411     | VIR_ERR_NO_STORAGE_VOL -> "VIR_ERR_NO_STORAGE_VOL"
412     | VIR_ERR_UNKNOWN i -> "VIR_ERR_" ^ string_of_int i
413
414   type domain =
415     | VIR_FROM_NONE
416     | VIR_FROM_XEN
417     | VIR_FROM_XEND
418     | VIR_FROM_XENSTORE
419     | VIR_FROM_SEXPR
420     | VIR_FROM_XML
421     | VIR_FROM_DOM
422     | VIR_FROM_RPC
423     | VIR_FROM_PROXY
424     | VIR_FROM_CONF
425     | VIR_FROM_QEMU
426     | VIR_FROM_NET
427     | VIR_FROM_TEST
428     | VIR_FROM_REMOTE
429     | VIR_FROM_OPENVZ
430     | VIR_FROM_XENXM
431     | VIR_FROM_STATS_LINUX
432     | VIR_FROM_STORAGE
433     | VIR_FROM_UNKNOWN of int
434
435   let string_of_domain = function
436     | VIR_FROM_NONE -> "VIR_FROM_NONE"
437     | VIR_FROM_XEN -> "VIR_FROM_XEN"
438     | VIR_FROM_XEND -> "VIR_FROM_XEND"
439     | VIR_FROM_XENSTORE -> "VIR_FROM_XENSTORE"
440     | VIR_FROM_SEXPR -> "VIR_FROM_SEXPR"
441     | VIR_FROM_XML -> "VIR_FROM_XML"
442     | VIR_FROM_DOM -> "VIR_FROM_DOM"
443     | VIR_FROM_RPC -> "VIR_FROM_RPC"
444     | VIR_FROM_PROXY -> "VIR_FROM_PROXY"
445     | VIR_FROM_CONF -> "VIR_FROM_CONF"
446     | VIR_FROM_QEMU -> "VIR_FROM_QEMU"
447     | VIR_FROM_NET -> "VIR_FROM_NET"
448     | VIR_FROM_TEST -> "VIR_FROM_TEST"
449     | VIR_FROM_REMOTE -> "VIR_FROM_REMOTE"
450     | VIR_FROM_OPENVZ -> "VIR_FROM_OPENVZ"
451     | VIR_FROM_XENXM -> "VIR_FROM_XENXM"
452     | VIR_FROM_STATS_LINUX -> "VIR_FROM_STATS_LINUX"
453     | VIR_FROM_STORAGE -> "VIR_FROM_STORAGE"
454     | VIR_FROM_UNKNOWN i -> "VIR_FROM_" ^ string_of_int i
455
456   type level =
457     | VIR_ERR_NONE
458     | VIR_ERR_WARNING
459     | VIR_ERR_ERROR
460     | VIR_ERR_UNKNOWN_LEVEL of int
461
462   let string_of_level = function
463     | VIR_ERR_NONE -> "VIR_ERR_NONE"
464     | VIR_ERR_WARNING -> "VIR_ERR_WARNING"
465     | VIR_ERR_ERROR -> "VIR_ERR_ERROR"
466     | VIR_ERR_UNKNOWN_LEVEL i -> "VIR_ERR_LEVEL_" ^ string_of_int i
467
468   type t = {
469     code : code;
470     domain : domain;
471     message : string option;
472     level : level;
473     conn : ro Connect.t option;
474     dom : ro Domain.t option;
475     str1 : string option;
476     str2 : string option;
477     str3 : string option;
478     int1 : int32;
479     int2 : int32;
480     net : ro Network.t option;
481   }
482
483   let to_string { code = code; domain = domain; message = message } =
484     let buf = Buffer.create 128 in
485     Buffer.add_string buf "libvirt: ";
486     Buffer.add_string buf (string_of_code code);
487     Buffer.add_string buf ": ";
488     Buffer.add_string buf (string_of_domain domain);
489     Buffer.add_string buf ": ";
490     (match message with Some msg -> Buffer.add_string buf msg | None -> ());
491     Buffer.contents buf
492
493   external get_last_error : unit -> t option = "ocaml_libvirt_virterror_get_last_error"
494   external get_last_conn_error : [>`R] Connect.t -> t option = "ocaml_libvirt_virterror_get_last_conn_error"
495   external reset_last_error : unit -> unit = "ocaml_libvirt_virterror_reset_last_error"
496   external reset_last_conn_error : [>`R] Connect.t -> unit = "ocaml_libvirt_virterror_reset_last_conn_error"
497
498   let no_error () =
499     { code = VIR_ERR_OK; domain = VIR_FROM_NONE; message = None;
500       level = VIR_ERR_NONE; conn = None; dom = None;
501       str1 = None; str2 = None; str3 = None;
502       int1 = 0_l; int2 = 0_l; net = None }
503 end
504
505 exception Virterror of Virterror.t
506 exception Not_supported of string
507
508 (* Initialization. *)
509 external c_init : unit -> unit = "ocaml_libvirt_init"
510 let () =
511   Callback.register_exception
512     "ocaml_libvirt_virterror" (Virterror (Virterror.no_error ()));
513   Callback.register_exception
514     "ocaml_libvirt_not_supported" (Not_supported "");
515   c_init ()