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);
50 option_default (value option, value deflt)
52 if (option == Val_int (0)) /* "None" */
55 return Field (option, 0);
60 _raise_virterror (virConnectPtr conn, const char *fn)
67 errp = conn ? virConnGetLastError (conn) : virGetLastError ();
70 /* Fake a _virError structure. */
71 memset (&err, 0, sizeof err);
72 err.code = VIR_ERR_INTERNAL_ERROR;
73 err.domain = VIR_FROM_NONE;
74 err.level = VIR_ERR_ERROR;
75 err.message = (char *) fn;
79 rv = Val_virterror (errp);
80 caml_raise_with_arg (*caml_named_value ("ocaml_libvirt_virterror"), rv);
83 /* Suppresses a compiler warning. */
87 /* Raise an error if a function is not supported. */
89 not_supported (const char *fn)
94 fnv = caml_copy_string (fn);
95 caml_raise_with_arg (*caml_named_value ("ocaml_libvirt_not_supported"), fnv);
98 /* Suppresses a compiler warning. */
102 /* Convert the virErrorNumber, virErrorDomain and virErrorLevel enums
103 * into values (longs because they are variants in OCaml).
105 * The enum values are part of the libvirt ABI so they cannot change,
106 * which means that we can convert these numbers directly into
107 * OCaml variants (which use the same ordering) very fast.
109 * The tricky part here is when we are linked to a newer version of
110 * libvirt than the one we were compiled against. If the newer libvirt
111 * generates an error code which we don't know about then we need
112 * to convert it into VIR_*_UNKNOWN (code).
115 #define MAX_VIR_CODE 50 /* VIR_ERR_NO_STORAGE_VOL */
116 #define MAX_VIR_DOMAIN 17 /* VIR_FROM_STORAGE */
117 #define MAX_VIR_LEVEL VIR_ERR_ERROR
120 Val_err_number (virErrorNumber code)
125 if (0 <= code && code <= MAX_VIR_CODE)
128 rv = caml_alloc (1, 0); /* VIR_ERR_UNKNOWN (code) */
129 Store_field (rv, 0, Val_int (code));
136 Val_err_domain (virErrorDomain code)
141 if (0 <= code && code <= MAX_VIR_DOMAIN)
144 rv = caml_alloc (1, 0); /* VIR_FROM_UNKNOWN (code) */
145 Store_field (rv, 0, Val_int (code));
152 Val_err_level (virErrorLevel code)
157 if (0 <= code && code <= MAX_VIR_LEVEL)
160 rv = caml_alloc (1, 0); /* VIR_ERR_UNKNOWN_LEVEL (code) */
161 Store_field (rv, 0, Val_int (code));
167 /* Convert a virterror to a value. */
169 Val_virterror (virErrorPtr err)
172 CAMLlocal3 (rv, connv, optv);
174 rv = caml_alloc (9, 0);
175 Store_field (rv, 0, Val_err_number (err->code));
176 Store_field (rv, 1, Val_err_domain (err->domain));
178 Val_opt (err->message, (Val_ptr_t) caml_copy_string));
179 Store_field (rv, 3, Val_err_level (err->level));
182 Val_opt (err->str1, (Val_ptr_t) caml_copy_string));
184 Val_opt (err->str2, (Val_ptr_t) caml_copy_string));
186 Val_opt (err->str3, (Val_ptr_t) caml_copy_string));
187 Store_field (rv, 7, caml_copy_int32 (err->int1));
188 Store_field (rv, 8, caml_copy_int32 (err->int2));
193 static void conn_finalize (value);
194 static void dom_finalize (value);
195 static void net_finalize (value);
196 static void pol_finalize (value);
197 static void vol_finalize (value);
199 static struct custom_operations conn_custom_operations = {
200 "conn_custom_operations",
202 custom_compare_default,
204 custom_serialize_default,
205 custom_deserialize_default
208 static struct custom_operations dom_custom_operations = {
209 "dom_custom_operations",
211 custom_compare_default,
213 custom_serialize_default,
214 custom_deserialize_default
218 static struct custom_operations net_custom_operations = {
219 "net_custom_operations",
221 custom_compare_default,
223 custom_serialize_default,
224 custom_deserialize_default
227 static struct custom_operations pol_custom_operations = {
228 "pol_custom_operations",
230 custom_compare_default,
232 custom_serialize_default,
233 custom_deserialize_default
236 static struct custom_operations vol_custom_operations = {
237 "vol_custom_operations",
239 custom_compare_default,
241 custom_serialize_default,
242 custom_deserialize_default
246 Val_connect (virConnectPtr conn)
250 rv = caml_alloc_custom (&conn_custom_operations,
251 sizeof (virConnectPtr), 0, 1);
252 Connect_val (rv) = conn;
257 Val_dom (virDomainPtr dom)
261 rv = caml_alloc_custom (&dom_custom_operations,
262 sizeof (virDomainPtr), 0, 1);
268 Val_net (virNetworkPtr net)
272 rv = caml_alloc_custom (&net_custom_operations,
273 sizeof (virNetworkPtr), 0, 1);
279 Val_pol (virStoragePoolPtr pol)
283 rv = caml_alloc_custom (&pol_custom_operations,
284 sizeof (virStoragePoolPtr), 0, 1);
290 Val_vol (virStorageVolPtr vol)
294 rv = caml_alloc_custom (&vol_custom_operations,
295 sizeof (virStorageVolPtr), 0, 1);
300 /* This wraps up the (dom, conn) pair (Domain.t). */
302 Val_domain (virDomainPtr dom, value connv)
307 rv = caml_alloc_tuple (2);
309 Store_field (rv, 0, v);
310 Store_field (rv, 1, connv);
314 /* This wraps up the (net, conn) pair (Network.t). */
316 Val_network (virNetworkPtr net, value connv)
321 rv = caml_alloc_tuple (2);
323 Store_field (rv, 0, v);
324 Store_field (rv, 1, connv);
328 /* This wraps up the (pol, conn) pair (Pool.t). */
330 Val_pool (virStoragePoolPtr pol, value connv)
335 rv = caml_alloc_tuple (2);
337 Store_field (rv, 0, v);
338 Store_field (rv, 1, connv);
342 /* This wraps up the (vol, conn) pair (Volume.t). */
344 Val_volume (virStorageVolPtr vol, value connv)
349 rv = caml_alloc_tuple (2);
351 Store_field (rv, 0, v);
352 Store_field (rv, 1, connv);
357 conn_finalize (value connv)
359 virConnectPtr conn = Connect_val (connv);
360 if (conn) (void) virConnectClose (conn);
364 dom_finalize (value domv)
366 virDomainPtr dom = Dom_val (domv);
367 if (dom) (void) virDomainFree (dom);
371 net_finalize (value netv)
373 virNetworkPtr net = Net_val (netv);
374 if (net) (void) virNetworkFree (net);
378 pol_finalize (value polv)
380 virStoragePoolPtr pol = Pol_val (polv);
381 if (pol) (void) virStoragePoolFree (pol);
385 vol_finalize (value volv)
387 virStorageVolPtr vol = Vol_val (volv);
388 if (vol) (void) virStorageVolFree (vol);