1 /* OCaml bindings for libvirt.
2 * (C) Copyright 2007 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
21 /* Please read libvirt/README file. */
24 Optstring_val (value strv)
26 if (strv == Val_int (0)) /* None */
28 else /* Some string */
29 return String_val (Field (strv, 0));
33 Val_opt (void *ptr, Val_ptr_t Val_ptr)
36 CAMLlocal2 (optv, ptrv);
38 if (ptr) { /* Some ptr */
39 optv = caml_alloc (1, 0);
41 Store_field (optv, 0, ptrv);
49 Val_opt_const (const void *ptr, Val_const_ptr_t Val_ptr)
52 CAMLlocal2 (optv, ptrv);
54 if (ptr) { /* Some ptr */
55 optv = caml_alloc (1, 0);
57 Store_field (optv, 0, ptrv);
66 option_default (value option, value deflt)
68 if (option == Val_int (0)) /* "None" */
71 return Field (option, 0);
76 _raise_virterror (const char *fn)
83 errp = virGetLastError ();
86 /* Fake a _virError structure. */
87 memset (&err, 0, sizeof err);
88 err.code = VIR_ERR_INTERNAL_ERROR;
89 err.domain = VIR_FROM_NONE;
90 err.level = VIR_ERR_ERROR;
91 err.message = (char *) fn;
95 rv = Val_virterror (errp);
96 caml_raise_with_arg (*caml_named_value ("ocaml_libvirt_virterror"), rv);
99 /* Suppresses a compiler warning. */
103 /* Convert the virErrorNumber, virErrorDomain and virErrorLevel enums
104 * into values (longs because they are variants in OCaml).
106 * The enum values are part of the libvirt ABI so they cannot change,
107 * which means that we can convert these numbers directly into
108 * OCaml variants (which use the same ordering) very fast.
110 * The tricky part here is when we are linked to a newer version of
111 * libvirt than the one we were compiled against. If the newer libvirt
112 * generates an error code which we don't know about then we need
113 * to convert it into VIR_*_UNKNOWN (code).
116 #define MAX_VIR_CODE 50 /* VIR_ERR_NO_STORAGE_VOL */
117 #define MAX_VIR_DOMAIN 17 /* VIR_FROM_STORAGE */
118 #define MAX_VIR_LEVEL VIR_ERR_ERROR
121 Val_err_number (virErrorNumber code)
126 if (0 <= code && code <= MAX_VIR_CODE)
129 rv = caml_alloc (1, 0); /* VIR_ERR_UNKNOWN (code) */
130 Store_field (rv, 0, Val_int (code));
137 Val_err_domain (virErrorDomain code)
142 if (0 <= code && code <= MAX_VIR_DOMAIN)
145 rv = caml_alloc (1, 0); /* VIR_FROM_UNKNOWN (code) */
146 Store_field (rv, 0, Val_int (code));
153 Val_err_level (virErrorLevel code)
158 if (0 <= code && code <= MAX_VIR_LEVEL)
161 rv = caml_alloc (1, 0); /* VIR_ERR_UNKNOWN_LEVEL (code) */
162 Store_field (rv, 0, Val_int (code));
168 /* Convert a virterror to a value. */
170 Val_virterror (virErrorPtr err)
173 CAMLlocal3 (rv, connv, optv);
175 rv = caml_alloc (9, 0);
176 Store_field (rv, 0, Val_err_number (err->code));
177 Store_field (rv, 1, Val_err_domain (err->domain));
179 Val_opt (err->message, (Val_ptr_t) caml_copy_string));
180 Store_field (rv, 3, Val_err_level (err->level));
183 Val_opt (err->str1, (Val_ptr_t) caml_copy_string));
185 Val_opt (err->str2, (Val_ptr_t) caml_copy_string));
187 Val_opt (err->str3, (Val_ptr_t) caml_copy_string));
188 Store_field (rv, 7, caml_copy_int32 (err->int1));
189 Store_field (rv, 8, caml_copy_int32 (err->int2));
194 static void conn_finalize (value);
195 static void dom_finalize (value);
196 static void net_finalize (value);
197 static void pol_finalize (value);
198 static void vol_finalize (value);
200 static struct custom_operations conn_custom_operations = {
201 "conn_custom_operations",
203 custom_compare_default,
205 custom_serialize_default,
206 custom_deserialize_default
209 static struct custom_operations dom_custom_operations = {
210 "dom_custom_operations",
212 custom_compare_default,
214 custom_serialize_default,
215 custom_deserialize_default
219 static struct custom_operations net_custom_operations = {
220 "net_custom_operations",
222 custom_compare_default,
224 custom_serialize_default,
225 custom_deserialize_default
228 static struct custom_operations pol_custom_operations = {
229 "pol_custom_operations",
231 custom_compare_default,
233 custom_serialize_default,
234 custom_deserialize_default
237 static struct custom_operations vol_custom_operations = {
238 "vol_custom_operations",
240 custom_compare_default,
242 custom_serialize_default,
243 custom_deserialize_default
247 Val_connect (virConnectPtr conn)
251 rv = caml_alloc_custom (&conn_custom_operations,
252 sizeof (virConnectPtr), 0, 1);
253 Connect_val (rv) = conn;
258 Val_dom (virDomainPtr dom)
262 rv = caml_alloc_custom (&dom_custom_operations,
263 sizeof (virDomainPtr), 0, 1);
269 Val_net (virNetworkPtr net)
273 rv = caml_alloc_custom (&net_custom_operations,
274 sizeof (virNetworkPtr), 0, 1);
280 Val_pol (virStoragePoolPtr pol)
284 rv = caml_alloc_custom (&pol_custom_operations,
285 sizeof (virStoragePoolPtr), 0, 1);
291 Val_vol (virStorageVolPtr vol)
295 rv = caml_alloc_custom (&vol_custom_operations,
296 sizeof (virStorageVolPtr), 0, 1);
301 /* This wraps up the (dom, conn) pair (Domain.t). */
303 Val_domain (virDomainPtr dom, value connv)
308 rv = caml_alloc_tuple (2);
310 Store_field (rv, 0, v);
311 Store_field (rv, 1, connv);
315 /* This wraps up the (net, conn) pair (Network.t). */
317 Val_network (virNetworkPtr net, value connv)
322 rv = caml_alloc_tuple (2);
324 Store_field (rv, 0, v);
325 Store_field (rv, 1, connv);
329 /* This wraps up the (pol, conn) pair (Pool.t). */
331 Val_pool (virStoragePoolPtr pol, value connv)
336 rv = caml_alloc_tuple (2);
338 Store_field (rv, 0, v);
339 Store_field (rv, 1, connv);
343 /* This wraps up the (vol, conn) pair (Volume.t). */
345 Val_volume (virStorageVolPtr vol, value connv)
350 rv = caml_alloc_tuple (2);
352 Store_field (rv, 0, v);
353 Store_field (rv, 1, connv);
358 conn_finalize (value connv)
360 virConnectPtr conn = Connect_val (connv);
361 if (conn) (void) virConnectClose (conn);
365 dom_finalize (value domv)
367 virDomainPtr dom = Dom_val (domv);
368 if (dom) (void) virDomainFree (dom);
372 net_finalize (value netv)
374 virNetworkPtr net = Net_val (netv);
375 if (net) (void) virNetworkFree (net);
379 pol_finalize (value polv)
381 virStoragePoolPtr pol = Pol_val (polv);
382 if (pol) (void) virStoragePoolFree (pol);
386 vol_finalize (value volv)
388 virStorageVolPtr vol = Vol_val (volv);
389 if (vol) (void) virStorageVolFree (vol);