2 * Copyright (C) 2009-2011 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
26 open Generator_docstrings
27 open Generator_optgroups
28 open Generator_actions
29 open Generator_structs
33 (* Generate ruby bindings. *)
34 let rec generate_ruby_c () =
35 generate_header CStyle LGPLv2plus;
44 #include \"guestfs.h\"
46 #include \"extconf.h\"
50 #define RARRAY_LEN(r) (RARRAY((r))->len)
53 static VALUE m_guestfs; /* guestfs module */
54 static VALUE c_guestfs; /* guestfs_h handle */
55 static VALUE e_Error; /* used for all errors */
57 static void ruby_event_callback_wrapper (guestfs_h *g, void *data, uint64_t event, int event_handle, int flags, const char *buf, size_t buf_len, const uint64_t *array, size_t array_len);
58 static VALUE **get_all_event_callbacks (guestfs_h *g, size_t *len_rtn);
61 ruby_guestfs_free (void *gvp)
66 /* As in the OCaml binding, there is a nasty, difficult to
67 * solve case here where the user deletes events in one of
68 * the callbacks that we are about to invoke, resulting in
72 VALUE **roots = get_all_event_callbacks (g, &len);
74 /* Close the handle: this could invoke callbacks from the list
75 * above, which is why we don't want to delete them before
80 /* Now unregister the global roots. */
81 for (i = 0; i < len; ++i) {
82 rb_gc_unregister_address (roots[i]);
90 * Guestfs::Guestfs.new() -> Guestfs::Guestfs
93 * +guestfs_create+[http://libguestfs.org/guestfs.3.html#guestfs_create]
94 * to create a new libguestfs handle. The handle is represented in
95 * Ruby as an instance of the Guestfs::Guestfs class.
98 ruby_guestfs_create (VALUE m)
102 g = guestfs_create ();
104 rb_raise (e_Error, \"failed to create guestfs handle\");
106 /* Don't print error messages to stderr by default. */
107 guestfs_set_error_handler (g, NULL, NULL);
109 /* Wrap it, and make sure the close function is called when the
112 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
120 * +guestfs_close+[http://libguestfs.org/guestfs.3.html#guestfs_close]
121 * to close the libguestfs handle.
124 ruby_guestfs_close (VALUE gv)
127 Data_Get_Struct (gv, guestfs_h, g);
129 ruby_guestfs_free (g);
130 DATA_PTR (gv) = NULL;
137 * g.set_event_callback(cb, event_bitmask) -> event_handle
140 * +guestfs_set_event_callback+[http://libguestfs.org/guestfs.3.html#guestfs_set_event_callback]
141 * to register an event callback. This returns an event handle.
144 ruby_set_event_callback (VALUE gv, VALUE cbv, VALUE event_bitmaskv)
147 uint64_t event_bitmask;
152 Data_Get_Struct (gv, guestfs_h, g);
154 event_bitmask = NUM2ULL (event_bitmaskv);
156 root = guestfs_safe_malloc (g, sizeof *root);
159 eh = guestfs_set_event_callback (g, ruby_event_callback_wrapper,
160 event_bitmask, 0, root);
163 rb_raise (e_Error, \"%%s\", guestfs_last_error (g));
166 rb_gc_register_address (root);
168 snprintf (key, sizeof key, \"_ruby_event_%%d\", eh);
169 guestfs_set_private (g, key, root);
176 * g.delete_event_callback(event_handle) -> nil
179 * +guestfs_delete_event_callback+[http://libguestfs.org/guestfs.3.html#guestfs_delete_event_callback]
180 * to delete an event callback.
183 ruby_delete_event_callback (VALUE gv, VALUE event_handlev)
187 int eh = NUM2INT (event_handlev);
190 Data_Get_Struct (gv, guestfs_h, g);
192 snprintf (key, sizeof key, \"_ruby_event_%%d\", eh);
194 root = guestfs_get_private (g, key);
196 rb_gc_unregister_address (root);
198 guestfs_set_private (g, key, NULL);
199 guestfs_delete_event_callback (g, eh);
206 ruby_event_callback_wrapper (guestfs_h *g,
211 const char *buf, size_t buf_len,
212 const uint64_t *array, size_t array_len)
215 VALUE eventv, event_handlev, bufv, arrayv;
217 eventv = ULL2NUM (event);
218 event_handlev = INT2NUM (event_handle);
220 bufv = rb_str_new (buf, buf_len);
222 arrayv = rb_ary_new2 (array_len);
223 for (i = 0; i < array_len; ++i)
224 rb_ary_push (arrayv, ULL2NUM (array[i]));
226 /* XXX If the Ruby callback raises any sort of exception then
227 * it causes the process to segfault. I don't understand how
228 * to catch exceptions here.
230 rb_funcall (*(VALUE *) data, rb_intern (\"call\"), 4,
231 eventv, event_handlev, bufv, arrayv);
235 get_all_event_callbacks (guestfs_h *g, size_t *len_rtn)
242 /* Count the length of the array that will be needed. */
244 root = guestfs_first_private (g, &key);
245 while (root != NULL) {
246 if (strncmp (key, \"_ruby_event_\", strlen (\"_ruby_event_\")) == 0)
248 root = guestfs_next_private (g, &key);
251 /* Copy them into the return array. */
252 r = guestfs_safe_malloc (g, sizeof (VALUE *) * (*len_rtn));
255 root = guestfs_first_private (g, &key);
256 while (root != NULL) {
257 if (strncmp (key, \"_ruby_event_\", strlen (\"_ruby_event_\")) == 0) {
261 root = guestfs_next_private (g, &key);
270 fun (name, (ret, args, optargs as style), _, flags, _, shortdesc, longdesc) ->
272 if not (List.mem NotInDocs flags); then (
273 let doc = replace_str longdesc "C<guestfs_" "C<g." in
275 if optargs <> [] then
276 doc ^ "\n\nOptional arguments are supplied in the final hash parameter, which is a hash of the argument name to its value. Pass an empty {} for no optional arguments."
279 if List.mem ProtocolLimitWarning flags then
280 doc ^ "\n\n" ^ protocol_limit_warning
283 if List.mem DangerWillRobinson flags then
284 doc ^ "\n\n" ^ danger_will_robinson
287 match deprecation_notice flags with
289 | Some txt -> doc ^ "\n\n" ^ txt in
290 let doc = pod2text ~width:60 name doc in
291 let doc = String.concat "\n * " doc in
292 let doc = trim doc in
294 let args = List.map name_of_argt args in
295 let args = if optargs <> [] then args @ ["{optargs...}"] else args in
296 let args = String.concat ", " args in
301 | RBool _ -> "[True|False]"
303 | RInt64 _ -> "fixnum"
304 | RConstString _ -> "string"
305 | RConstOptString _ -> "string"
306 | RString _ -> "string"
307 | RBufferOut _ -> "string"
309 | RHashtable _ -> "hash"
311 | RStructList _ -> "list" in
322 * (For the C API documentation for this function, see
323 * +guestfs_%s+[http://libguestfs.org/guestfs.3.html#guestfs_%s]).
325 " name args ret shortdesc doc name name
328 (* Generate the function. *)
330 pr "ruby_guestfs_%s (VALUE gv" name;
331 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) args;
332 (* XXX This makes the hash mandatory, meaning that you have
333 * to specify {} for no arguments. We could make it so this
334 * can be omitted. However that is a load of hassle because
335 * you have to completely change the way that arguments are
337 * http://www.redhat.com/archives/libvir-list/2008-April/msg00004.html
339 if optargs <> [] then
340 pr ", VALUE optargsv";
343 pr " guestfs_h *g;\n";
344 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
346 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
352 | Pathname n | Device n | Dev_or_Path n | String n | Key n
353 | FileIn n | FileOut n ->
354 pr " const char *%s = StringValueCStr (%sv);\n" n n;
356 pr " Check_Type (%sv, T_STRING);\n" n;
357 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
359 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
360 pr " \"%s\", \"%s\");\n" n name;
361 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
363 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
364 | StringList n | DeviceList n ->
365 pr " char **%s;\n" n;
366 pr " Check_Type (%sv, T_ARRAY);\n" n;
368 pr " size_t i, len;\n";
369 pr " len = RARRAY_LEN (%sv);\n" n;
370 pr " %s = ALLOC_N (char *, len+1);\n"
372 pr " for (i = 0; i < len; ++i) {\n";
373 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
374 pr " %s[i] = StringValueCStr (v);\n" n;
376 pr " %s[len] = NULL;\n" n;
379 pr " int %s = RTEST (%sv);\n" n n
381 pr " int %s = NUM2INT (%sv);\n" n n
383 pr " long long %s = NUM2LL (%sv);\n" n n
385 pr " %s %s = (%s) (intptr_t) NUM2LL (%sv);\n" t n t n
389 (* Optional arguments are passed in a final hash parameter. *)
390 if optargs <> [] then (
391 let uc_name = String.uppercase name in
392 pr " Check_Type (optargsv, T_HASH);\n";
393 pr " struct guestfs_%s_argv optargs_s = { .bitmask = 0 };\n" name;
394 pr " struct guestfs_%s_argv *optargs = &optargs_s;\n" name;
398 let n = name_of_argt argt in
399 let uc_n = String.uppercase n in
400 pr " v = rb_hash_lookup (optargsv, ID2SYM (rb_intern (\"%s\")));\n" n;
401 pr " if (v != Qnil) {\n";
404 pr " optargs_s.%s = RTEST (v);\n" n;
406 pr " optargs_s.%s = NUM2INT (v);\n" n;
408 pr " optargs_s.%s = NUM2LL (v);\n" n;
410 pr " optargs_s.%s = StringValueCStr (v);\n" n
413 pr " optargs_s.bitmask |= GUESTFS_%s_%s_BITMASK;\n" uc_name uc_n;
420 | RErr | RInt _ | RBool _ -> pr " int r;\n"
421 | RInt64 _ -> pr " int64_t r;\n"
422 | RConstString _ | RConstOptString _ ->
423 pr " const char *r;\n"
424 | RString _ -> pr " char *r;\n"
425 | RStringList _ | RHashtable _ -> pr " char **r;\n"
426 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
427 | RStructList (_, typ) ->
428 pr " struct guestfs_%s_list *r;\n" typ
436 pr " r = guestfs_%s " name
438 pr " r = guestfs_%s_argv " name;
439 generate_c_call_args ~handle:"g" style;
444 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
445 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
446 | BufferIn _ | Pointer _ -> ()
447 | StringList n | DeviceList n ->
451 (match errcode_of_ret ret with
452 | `CannotReturnError -> ()
453 | `ErrorIsMinusOne ->
454 pr " if (r == -1)\n";
455 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n"
457 pr " if (r == NULL)\n";
458 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n"
465 | RInt _ | RBool _ ->
466 pr " return INT2NUM (r);\n"
468 pr " return ULL2NUM (r);\n"
470 pr " return rb_str_new2 (r);\n";
471 | RConstOptString _ ->
473 pr " return rb_str_new2 (r);\n";
475 pr " return Qnil;\n";
477 pr " VALUE rv = rb_str_new2 (r);\n";
481 pr " size_t i, len = 0;\n";
482 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
483 pr " VALUE rv = rb_ary_new2 (len);\n";
484 pr " for (i = 0; r[i] != NULL; ++i) {\n";
485 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
486 pr " free (r[i]);\n";
490 | RStruct (_, typ) ->
491 let cols = cols_of_struct typ in
492 generate_ruby_struct_code typ cols
493 | RStructList (_, typ) ->
494 let cols = cols_of_struct typ in
495 generate_ruby_struct_list_code typ cols
497 pr " VALUE rv = rb_hash_new ();\n";
499 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
500 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
501 pr " free (r[i]);\n";
502 pr " free (r[i+1]);\n";
507 pr " VALUE rv = rb_str_new (r, size);\n";
517 /* Initialize the module. */
518 void Init__guestfs ()
520 m_guestfs = rb_define_module (\"Guestfs\");
521 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
522 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
524 #ifdef HAVE_RB_DEFINE_ALLOC_FUNC
525 rb_define_alloc_func (c_guestfs, ruby_guestfs_create);
528 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
529 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
530 rb_define_method (c_guestfs, \"set_event_callback\",
531 ruby_set_event_callback, 2);
532 rb_define_method (c_guestfs, \"delete_event_callback\",
533 ruby_delete_event_callback, 1);
539 fun (name, bitmask) ->
540 pr " rb_define_const (m_guestfs, \"EVENT_%s\",\n"
541 (String.uppercase name);
542 pr " ULL2NUM (UINT64_C (0x%x)));\n" bitmask;
548 fun (name, (_, args, optargs), _, _, _, _, _) ->
549 let nr_args = List.length args + if optargs <> [] then 1 else 0 in
550 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
551 pr " ruby_guestfs_%s, %d);\n" name nr_args
556 (* Ruby code to return a struct. *)
557 and generate_ruby_struct_code typ cols =
558 pr " VALUE rv = rb_hash_new ();\n";
562 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
564 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
566 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
567 | name, (FBytes|FUInt64) ->
568 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
570 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
572 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
574 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
575 | name, FOptPercent ->
576 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
577 | name, FChar -> (* XXX wrong? *)
578 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
580 pr " guestfs_free_%s (r);\n" typ;
583 (* Ruby code to return a struct list. *)
584 and generate_ruby_struct_list_code typ cols =
585 pr " VALUE rv = rb_ary_new2 (r->len);\n";
587 pr " for (i = 0; i < r->len; ++i) {\n";
588 pr " VALUE hv = rb_hash_new ();\n";
592 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
594 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, r->val[i].%s_len));\n" name name name
596 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
597 | name, (FBytes|FUInt64) ->
598 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
600 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
602 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
604 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
605 | name, FOptPercent ->
606 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
607 | name, FChar -> (* XXX wrong? *)
608 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
610 pr " rb_ary_push (rv, hv);\n";
612 pr " guestfs_free_%s_list (r);\n" typ;