2 * Copyright (C) 2009-2010 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_api_versions
28 open Generator_optgroups
29 open Generator_actions
30 open Generator_structs
34 type optarg_proto = Dots | VA | Argv
36 (* Generate a C function prototype. *)
37 let rec generate_prototype ?(extern = true) ?(static = false)
39 ?(single_line = false) ?(indent = "") ?(newline = false)
41 ?(prefix = "") ?(suffix = "")
43 ?(optarg_proto = Dots)
44 name (ret, args, optargs) =
46 if extern then pr "extern ";
47 if static then pr "static ";
53 if single_line then pr " " else pr "\n%s" indent
56 if single_line then pr " " else pr "\n%s" indent
57 | RConstString _ | RConstOptString _ ->
59 if not single_line then pr "\n%s" indent
60 | RString _ | RBufferOut _ ->
62 if not single_line then pr "\n%s" indent
63 | RStringList _ | RHashtable _ ->
65 if not single_line then pr "\n%s" indent
67 if not in_daemon then pr "struct guestfs_%s *" typ
68 else pr "guestfs_int_%s *" typ;
69 if not single_line then pr "\n%s" indent
70 | RStructList (_, typ) ->
71 if not in_daemon then pr "struct guestfs_%s_list *" typ
72 else pr "guestfs_int_%s_list *" typ;
73 if not single_line then pr "\n%s" indent
75 let is_RBufferOut = match ret with RBufferOut _ -> true | _ -> false in
76 pr "%s%s%s (" prefix name suffix;
77 if handle = None && args = [] && optargs = [] && not is_RBufferOut then
80 let comma = ref false in
83 | Some handle -> pr "guestfs_h *%s" handle; comma := true
87 if single_line then pr ", "
89 let namelen = String.length prefix + String.length name +
90 String.length suffix + 2 in
91 pr ",\n%s%s" indent (spaces namelen)
99 | Device n | Dev_or_Path n
104 pr "const char *%s" n
105 | StringList n | DeviceList n ->
107 pr "char *const *%s" n
108 | Bool n -> next (); pr "int %s" n
109 | Int n -> next (); pr "int %s" n
110 | Int64 n -> next (); pr "int64_t %s" n
113 if not in_daemon then (next (); pr "const char *%s" n)
116 pr "const char *%s" n;
118 pr "size_t %s_size" n
123 if is_RBufferOut then (next (); pr "size_t *size_r");
124 if optargs <> [] then (
126 match optarg_proto with
128 | VA -> pr "va_list args"
129 | Argv -> pr "const struct guestfs_%s_argv *optargs" name
133 if semicolon then pr ";";
134 if newline then pr "\n"
136 (* Generate C call arguments, eg "(handle, foo, bar)" *)
137 and generate_c_call_args ?handle (ret, args, optargs) =
139 let comma = ref false in
141 if !comma then pr ", ";
146 | Some handle -> pr "%s" handle; comma := true
155 pr "%s" (name_of_argt arg)
157 (* For RBufferOut calls, add implicit &size parameter. *)
164 (* For calls with optional arguments, add implicit optargs parameter. *)
165 if optargs <> [] then (
171 (* Generate the pod documentation for the C API. *)
172 and generate_actions_pod () =
174 fun (shortname, (ret, args, optargs as style), _, flags, _, _, longdesc) ->
175 if not (List.mem NotInDocs flags) then (
176 let name = "guestfs_" ^ shortname in
177 pr "=head2 %s\n\n" name;
178 generate_prototype ~extern:false ~indent:" " ~handle:"g" name style;
181 let uc_shortname = String.uppercase shortname in
182 if optargs <> [] then (
183 pr "You may supply a list of optional arguments to this call.\n";
184 pr "Use zero or more of the following pairs of parameters,\n";
185 pr "and terminate the list with C<-1> on its own.\n";
186 pr "See L</CALLS WITH OPTIONAL ARGUMENTS>.\n\n";
189 let n = name_of_argt argt in
190 let uc_n = String.uppercase n in
191 pr " GUESTFS_%s_%s, " uc_shortname uc_n;
193 | Bool n -> pr "int %s,\n" n
194 | Int n -> pr "int %s,\n" n
195 | Int64 n -> pr "int64_t %s,\n" n
196 | String n -> pr "const char *%s,\n" n
202 pr "%s\n\n" longdesc;
203 let ret, args, optargs = style in
206 pr "This function returns 0 on success or -1 on error.\n\n"
208 pr "On error this function returns -1.\n\n"
210 pr "On error this function returns -1.\n\n"
212 pr "This function returns a C truth value on success or -1 on error.\n\n"
214 pr "This function returns a string, or NULL on error.
215 The string is owned by the guest handle and must I<not> be freed.\n\n"
216 | RConstOptString _ ->
217 pr "This function returns a string which may be NULL.
218 There is no way to return an error from this function.
219 The string is owned by the guest handle and must I<not> be freed.\n\n"
221 pr "This function returns a string, or NULL on error.
222 I<The caller must free the returned string after use>.\n\n"
224 pr "This function returns a NULL-terminated array of strings
225 (like L<environ(3)>), or NULL if there was an error.
226 I<The caller must free the strings and the array after use>.\n\n"
227 | RStruct (_, typ) ->
228 pr "This function returns a C<struct guestfs_%s *>,
229 or NULL if there was an error.
230 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
231 | RStructList (_, typ) ->
232 pr "This function returns a C<struct guestfs_%s_list *>,
233 or NULL if there was an error.
234 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
236 pr "This function returns a NULL-terminated array of
237 strings, or NULL if there was an error.
238 The array of strings will always have length C<2n+1>, where
239 C<n> keys and values alternate, followed by the trailing NULL entry.
240 I<The caller must free the strings and the array after use>.\n\n"
242 pr "This function returns a buffer, or NULL on error.
243 The size of the returned buffer is written to C<*size_r>.
244 I<The caller must free the returned buffer after use>.\n\n"
246 if List.mem Progress flags then
247 pr "%s\n\n" progress_message;
248 if List.mem ProtocolLimitWarning flags then
249 pr "%s\n\n" protocol_limit_warning;
250 if List.mem DangerWillRobinson flags then
251 pr "%s\n\n" danger_will_robinson;
252 if List.exists (function Key _ -> true | _ -> false) (args@optargs) then
253 pr "This function takes a key or passphrase parameter which
254 could contain sensitive material. Read the section
255 L</KEYS AND PASSPHRASES> for more information.\n\n";
256 (match deprecation_notice flags with
258 | Some txt -> pr "%s\n\n" txt
260 (match lookup_api_version name with
261 | Some version -> pr "(Added in %s)\n\n" version
265 (* Handling of optional argument variants. *)
266 if optargs <> [] then (
267 pr "=head2 %s_va\n\n" name;
268 generate_prototype ~extern:false ~indent:" " ~handle:"g"
269 ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
272 pr "This is the \"va_list variant\" of L</%s>.\n\n" name;
273 pr "See L</CALLS WITH OPTIONAL ARGUMENTS>.\n\n";
274 pr "=head2 %s_argv\n\n" name;
275 generate_prototype ~extern:false ~indent:" " ~handle:"g"
276 ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
279 pr "This is the \"argv variant\" of L</%s>.\n\n" name;
280 pr "See L</CALLS WITH OPTIONAL ARGUMENTS>.\n\n";
283 ) all_functions_sorted
285 and generate_structs_pod () =
286 (* Structs documentation. *)
289 pr "=head2 guestfs_%s\n" typ;
291 pr " struct guestfs_%s {\n" typ;
294 | name, FChar -> pr " char %s;\n" name
295 | name, FUInt32 -> pr " uint32_t %s;\n" name
296 | name, FInt32 -> pr " int32_t %s;\n" name
297 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
298 | name, FInt64 -> pr " int64_t %s;\n" name
299 | name, FString -> pr " char *%s;\n" name
301 pr " /* The next two fields describe a byte array. */\n";
302 pr " uint32_t %s_len;\n" name;
303 pr " char *%s;\n" name
305 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
306 pr " char %s[32];\n" name
307 | name, FOptPercent ->
308 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
309 pr " float %s;\n" name
313 pr " struct guestfs_%s_list {\n" typ;
314 pr " uint32_t len; /* Number of elements in list. */\n";
315 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
318 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
319 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
324 and generate_availability_pod () =
325 (* Availability documentation. *)
329 fun (group, functions) ->
330 pr "=item B<%s>\n" group;
332 pr "The following functions:\n";
333 List.iter (pr "L</guestfs_%s>\n") functions;
339 (* Generate the guestfs.h file. *)
340 and generate_guestfs_h () =
341 generate_header CStyle LGPLv2plus;
344 /* ---------- IMPORTANT NOTE ----------
346 * All API documentation is in the manpage, 'guestfs(3)'.
347 * To read it, type: man 3 guestfs
348 * Or read it online here: http://libguestfs.org/guestfs.3.html
350 * Go and read it now, I'll be right here waiting for you
351 * when you come back.
353 * ------------------------------------
368 #ifndef GUESTFS_TYPEDEF_H
369 #define GUESTFS_TYPEDEF_H 1
370 typedef struct guestfs_h guestfs_h;
373 /* Connection management. */
374 extern guestfs_h *guestfs_create (void);
375 extern void guestfs_close (guestfs_h *g);
377 /* Error handling. */
378 extern const char *guestfs_last_error (guestfs_h *g);
379 #define LIBGUESTFS_HAVE_LAST_ERRNO 1
380 extern int guestfs_last_errno (guestfs_h *g);
382 #ifndef GUESTFS_TYPEDEF_ERROR_HANDLER_CB
383 #define GUESTFS_TYPEDEF_ERROR_HANDLER_CB 1
384 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *opaque, const char *msg);
387 #ifndef GUESTFS_TYPEDEF_ABORT_CB
388 #define GUESTFS_TYPEDEF_ABORT_CB 1
389 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
392 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *opaque);
393 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **opaque_rtn);
395 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
396 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
399 #ifndef GUESTFS_TYPEDEF_LOG_MESSAGE_CB
400 #define GUESTFS_TYPEDEF_LOG_MESSAGE_CB 1
401 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, char *buf, int len);
404 #ifndef GUESTFS_TYPEDEF_SUBPROCESS_QUIT_CB
405 #define GUESTFS_TYPEDEF_SUBPROCESS_QUIT_CB 1
406 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);
409 #ifndef GUESTFS_TYPEDEF_LAUNCH_DONE_CB
410 #define GUESTFS_TYPEDEF_LAUNCH_DONE_CB 1
411 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);
414 #ifndef GUESTFS_TYPEDEF_CLOSE_CB
415 #define GUESTFS_TYPEDEF_CLOSE_CB 1
416 typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);
419 #ifndef GUESTFS_TYPEDEF_PROGRESS_CB
420 #define GUESTFS_TYPEDEF_PROGRESS_CB 1
421 typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque, int proc_nr, int serial, uint64_t position, uint64_t total);
424 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
425 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
426 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
427 #define LIBGUESTFS_HAVE_SET_CLOSE_CALLBACK 1
428 extern void guestfs_set_close_callback (guestfs_h *g, guestfs_close_cb cb, void *opaque);
429 #define LIBGUESTFS_HAVE_SET_PROGRESS_CALLBACK 1
430 extern void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque);
432 /* Private data area. */
433 #define LIBGUESTFS_HAVE_SET_PRIVATE 1
434 extern void guestfs_set_private (guestfs_h *g, const char *key, void *data);
435 #define LIBGUESTFS_HAVE_GET_PRIVATE 1
436 extern void *guestfs_get_private (guestfs_h *g, const char *key);
441 (* The structures are carefully written to have exactly the same
442 * in-memory format as the XDR structures that we use on the wire to
443 * the daemon. The reason for creating copies of these structures
444 * here is just so we don't have to export the whole of
445 * guestfs_protocol.h (which includes much unrelated and
446 * XDR-dependent stuff that we don't want to be public, or required
449 * To reiterate, we will pass these structures to and from the client
450 * with a simple assignment or memcpy, so the format must be
451 * identical to what rpcgen / the RFC defines.
454 (* Public structures. *)
457 pr "struct guestfs_%s {\n" typ;
460 | name, FChar -> pr " char %s;\n" name
461 | name, FString -> pr " char *%s;\n" name
463 pr " uint32_t %s_len;\n" name;
464 pr " char *%s;\n" name
465 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
466 | name, FUInt32 -> pr " uint32_t %s;\n" name
467 | name, FInt32 -> pr " int32_t %s;\n" name
468 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
469 | name, FInt64 -> pr " int64_t %s;\n" name
470 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
474 pr "struct guestfs_%s_list {\n" typ;
475 pr " uint32_t len;\n";
476 pr " struct guestfs_%s *val;\n" typ;
479 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
480 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
489 fun (shortname, (ret, args, optargs as style), _, flags, _, _, _) ->
491 List.exists (function DeprecatedBy _ -> true | _ -> false) flags in
493 String.length shortname >= 5 && String.sub shortname 0 5 = "test0" in
495 String.length shortname >= 5 && String.sub shortname 0 5 = "debug" in
496 if not deprecated && not test0 && not debug then
497 pr "#define LIBGUESTFS_HAVE_%s 1\n" (String.uppercase shortname);
499 generate_prototype ~single_line:true ~newline:true ~handle:"g"
500 ~prefix:"guestfs_" shortname style;
502 if optargs <> [] then (
503 generate_prototype ~single_line:true ~newline:true ~handle:"g"
504 ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
507 pr "struct guestfs_%s_argv {\n" shortname;
508 pr " uint64_t bitmask;\n";
515 | Int64 n -> "int64_t "
516 | String n -> "const char *"
517 | _ -> assert false (* checked in generator_checks *) in
518 let uc_shortname = String.uppercase shortname in
519 let n = name_of_argt argt in
520 let uc_n = String.uppercase n in
521 pr "#define GUESTFS_%s_%s %d\n" uc_shortname uc_n i;
522 pr "#define GUESTFS_%s_%s_BITMASK (UINT64_C(1)<<%d)\n" uc_shortname uc_n i;
523 pr "/* The field below is only valid in this struct if the\n";
524 pr " * GUESTFS_%s_%s_BITMASK bit is set\n" uc_shortname uc_n;
525 pr " * in the bitmask above, otherwise the contents are ignored.\n";
527 pr " %s%s;\n" c_type n
531 generate_prototype ~single_line:true ~newline:true ~handle:"g"
532 ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
535 ) all_functions_sorted;
539 /* Private functions.
541 * These are NOT part of the public, stable API, and can change at any
542 * time! We export them because they are used by some of the language
545 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
546 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
547 extern const char *guestfs_tmpdir (void);
548 #ifdef GUESTFS_PRIVATE_FOR_EACH_DISK
549 extern int guestfs___for_each_disk (guestfs_h *g, virDomainPtr dom, int (*)(guestfs_h *g, const char *filename, const char *format, void *data), void *data);
551 /* End of private functions. */
557 #endif /* GUESTFS_H_ */
560 (* Generate the guestfs-internal-actions.h file. *)
561 and generate_internal_actions_h () =
562 generate_header CStyle LGPLv2plus;
564 fun (shortname, style, _, _, _, _, _) ->
565 generate_prototype ~single_line:true ~newline:true ~handle:"g"
566 ~prefix:"guestfs__" ~optarg_proto:Argv
568 ) non_daemon_functions
570 (* Generate the client-side dispatch stubs. *)
571 and generate_client_actions () =
572 generate_header CStyle LGPLv2plus;
579 #include <inttypes.h>
581 #include <sys/types.h>
582 #include <sys/stat.h>
584 #include \"guestfs.h\"
585 #include \"guestfs-internal.h\"
586 #include \"guestfs-internal-actions.h\"
587 #include \"guestfs_protocol.h\"
588 #include \"errnostring.h\"
590 /* Check the return message from a call for validity. */
592 check_reply_header (guestfs_h *g,
593 const struct guestfs_message_header *hdr,
594 unsigned int proc_nr, unsigned int serial)
596 if (hdr->prog != GUESTFS_PROGRAM) {
597 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
600 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
601 error (g, \"wrong protocol version (%%d/%%d)\",
602 hdr->vers, GUESTFS_PROTOCOL_VERSION);
605 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
606 error (g, \"unexpected message direction (%%d/%%d)\",
607 hdr->direction, GUESTFS_DIRECTION_REPLY);
610 if (hdr->proc != proc_nr) {
611 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
614 if (hdr->serial != serial) {
615 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
622 /* Check we are in the right state to run a high-level action. */
624 check_state (guestfs_h *g, const char *caller)
626 if (!guestfs__is_ready (g)) {
627 if (guestfs__is_config (g) || guestfs__is_launching (g))
628 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
631 error (g, \"%%s called from the wrong state, %%d != READY\",
632 caller, guestfs__get_state (g));
640 (* Generate code to check String-like parameters are not passed in
641 * as NULL (returning an error if they are).
643 let check_null_strings shortname (ret, args, optargs) =
644 let pr_newline = ref false in
647 (* parameters which should not be NULL *)
659 pr " if (%s == NULL) {\n" n;
660 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
661 pr " \"%s\", \"%s\");\n" shortname n;
663 match errcode_of_ret ret with
664 | `CannotReturnError ->
665 if shortname = "test0rconstoptstring" then (* XXX hack *)
669 "%s: RConstOptString function has invalid parameter '%s'"
671 | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
672 pr " return %s;\n" (string_of_errcode errcode);
685 (* For optional arguments. *)
689 pr " if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK) &&\n"
690 (String.uppercase shortname) (String.uppercase n);
691 pr " optargs->%s == NULL) {\n" n;
692 pr " error (g, \"%%s: %%s: optional parameter cannot be NULL\",\n";
693 pr " \"%s\", \"%s\");\n" shortname n;
695 match errcode_of_ret ret with
696 | `CannotReturnError -> assert false
697 | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
698 pr " return %s;\n" (string_of_errcode errcode);
703 | Bool _ | Int _ | Int64 _ -> ()
708 if !pr_newline then pr "\n";
711 (* Generate code to reject optargs we don't know about. *)
712 let reject_unknown_optargs shortname = function
715 let len = List.length optargs in
716 let mask = Int64.lognot (Int64.pred (Int64.shift_left 1L len)) in
717 pr " if (optargs->bitmask & UINT64_C(0x%Lx)) {\n" mask;
718 pr " error (g, \"%%s: unknown option in guestfs_%%s_argv->bitmask (this can happen if a program is compiled against a newer version of libguestfs, then dynamically linked to an older version)\",\n";
719 pr " \"%s\", \"%s\");\n" shortname shortname;
721 match errcode_of_ret ret with
722 | `CannotReturnError -> assert false
723 | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
724 pr " return %s;\n" (string_of_errcode errcode);
729 (* Generate code to generate guestfish call traces. *)
730 let trace_call shortname (ret, args, optargs) =
731 pr " if (trace_flag) {\n";
734 List.exists (function
735 | StringList _ | DeviceList _ -> true
736 | _ -> false) args in
742 pr " fprintf (stderr, \"%s\");\n" shortname;
744 (* Required arguments. *)
747 | String n (* strings *)
753 (* guestfish doesn't support string escaping, so neither do we *)
754 pr " fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n
756 (* don't print keys *)
757 pr " fprintf (stderr, \" \\\"***\\\"\");\n"
758 | OptString n -> (* string option *)
759 pr " if (%s) fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n n;
760 pr " else fprintf (stderr, \" null\");\n"
762 | DeviceList n -> (* string list *)
763 pr " fputc (' ', stderr);\n";
764 pr " fputc ('\"', stderr);\n";
765 pr " for (i = 0; %s[i]; ++i) {\n" n;
766 pr " if (i > 0) fputc (' ', stderr);\n";
767 pr " fputs (%s[i], stderr);\n" n;
769 pr " fputc ('\"', stderr);\n";
770 | Bool n -> (* boolean *)
771 pr " fputs (%s ? \" true\" : \" false\", stderr);\n" n
773 pr " fprintf (stderr, \" %%d\", %s);\n" n
775 pr " fprintf (stderr, \" %%\" PRIi64, %s);\n" n
776 | BufferIn n -> (* RHBZ#646822 *)
777 pr " fputc (' ', stderr);\n";
778 pr " guestfs___print_BufferIn (stderr, %s, %s_size);\n" n n
780 pr " fprintf (stderr, \" (%s)%%p\", %s);\n" t n
783 (* Optional arguments. *)
786 let n = name_of_argt argt in
787 let uc_shortname = String.uppercase shortname in
788 let uc_n = String.uppercase n in
789 pr " if (optargs->bitmask & GUESTFS_%s_%s_BITMASK)\n"
793 pr " fprintf (stderr, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s);\n" n n
795 pr " fprintf (stderr, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s ? \"true\" : \"false\");\n" n n
797 pr " fprintf (stderr, \" \\\"%%s:%%d\\\"\", \"%s\", optargs->%s);\n" n n
799 pr " fprintf (stderr, \" \\\"%%s:%%\" PRIi64 \"\\\"\", \"%s\", optargs->%s);\n" n n
808 let trace_return ?(indent = 2) (ret, _, _) rv =
809 let indent = spaces indent in
811 pr "%sif (trace_flag) {\n" indent;
815 | RStringList _ | RHashtable _ -> true
818 pr "%s size_t i;\n" indent;
822 pr "%s fputs (\" = \", stderr);\n" indent;
824 | RErr | RInt _ | RBool _ ->
825 pr "%s fprintf (stderr, \"%%d\", %s);\n" indent rv
827 pr "%s fprintf (stderr, \"%%\" PRIi64, %s);\n" indent rv
828 | RConstString _ | RString _ ->
829 pr "%s fprintf (stderr, \"\\\"%%s\\\"\", %s);\n" indent rv
830 | RConstOptString _ ->
831 pr "%s fprintf (stderr, \"\\\"%%s\\\"\", %s != NULL ? %s : \"NULL\");\n"
834 pr "%s guestfs___print_BufferOut (stderr, %s, *size_r);\n" indent rv
835 | RStringList _ | RHashtable _ ->
836 pr "%s fputs (\"[\\\"\", stderr);\n" indent;
837 pr "%s for (i = 0; %s[i]; ++i) {\n" indent rv;
838 pr "%s if (i > 0) fputs (\"\\\", \\\"\", stderr);\n" indent;
839 pr "%s fputs (%s[i], stderr);\n" indent rv;
841 pr "%s fputs (\"\\\"]\", stderr);\n" indent;
842 | RStruct (_, typ) ->
843 (* XXX There is code generated for guestfish for printing
844 * these structures. We need to make it generally available
847 pr "%s fprintf (stderr, \"<struct guestfs_%s *>\");\n"
849 | RStructList (_, typ) ->
850 pr "%s fprintf (stderr, \"<struct guestfs_%s_list *>\");\n"
853 pr "%s fputc ('\\n', stderr);\n" indent;
858 let trace_return_error ?(indent = 2) (ret, _, _) =
859 let indent = spaces indent in
861 pr "%sif (trace_flag)\n" indent;
864 | RErr | RInt _ | RBool _
866 pr "%s fputs (\" = -1 (error)\\n\", stderr);\n" indent
867 | RConstString _ | RString _
870 | RStringList _ | RHashtable _
873 pr "%s fputs (\" = NULL (error)\\n\", stderr);\n" indent
877 (* For non-daemon functions, generate a wrapper around each function. *)
879 fun (shortname, (ret, _, optargs as style), _, _, _, _, _) ->
881 generate_prototype ~extern:false ~semicolon:false ~newline:true
882 ~handle:"g" ~prefix:"guestfs_"
885 generate_prototype ~extern:false ~semicolon:false ~newline:true
886 ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
889 pr " int trace_flag = g->trace;\n";
891 | RErr | RInt _ | RBool _ ->
896 pr " const char *r;\n"
897 | RConstOptString _ ->
898 pr " const char *r;\n"
899 | RString _ | RBufferOut _ ->
901 | RStringList _ | RHashtable _ ->
903 | RStruct (_, typ) ->
904 pr " struct guestfs_%s *r;\n" typ
905 | RStructList (_, typ) ->
906 pr " struct guestfs_%s_list *r;\n" typ
909 check_null_strings shortname style;
910 reject_unknown_optargs shortname style;
911 trace_call shortname style;
912 pr " r = guestfs__%s " shortname;
913 generate_c_call_args ~handle:"g" style;
916 (match errcode_of_ret ret with
917 | (`ErrorIsMinusOne | `ErrorIsNULL) as errcode ->
918 pr " if (r != %s) {\n" (string_of_errcode errcode);
919 trace_return ~indent:4 style "r";
921 trace_return_error ~indent:4 style;
923 | `CannotReturnError ->
924 trace_return style "r";
930 ) non_daemon_functions;
932 (* Client-side stubs for each function. *)
934 fun (shortname, (ret, args, optargs as style), _, _, _, _, _) ->
935 let name = "guestfs_" ^ shortname in
937 match errcode_of_ret ret with
938 | `CannotReturnError -> assert false
939 | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
941 (* Generate the action stub. *)
943 generate_prototype ~extern:false ~semicolon:false ~newline:true
944 ~handle:"g" ~prefix:"guestfs_" shortname style
946 generate_prototype ~extern:false ~semicolon:false ~newline:true
947 ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv"
948 ~optarg_proto:Argv shortname style;
954 | _ -> pr " struct %s_args args;\n" name
957 pr " guestfs_message_header hdr;\n";
958 pr " guestfs_message_error err;\n";
962 | RConstString _ | RConstOptString _ ->
963 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
965 | RBool _ | RString _ | RStringList _
966 | RStruct _ | RStructList _
967 | RHashtable _ | RBufferOut _ ->
968 pr " struct %s_ret ret;\n" name;
973 pr " int trace_flag = g->trace;\n";
975 | RErr | RInt _ | RBool _ ->
978 pr " int64_t ret_v;\n"
979 | RConstString _ | RConstOptString _ ->
980 pr " const char *ret_v;\n"
981 | RString _ | RBufferOut _ ->
983 | RStringList _ | RHashtable _ ->
984 pr " char **ret_v;\n"
985 | RStruct (_, typ) ->
986 pr " struct guestfs_%s *ret_v;\n" typ
987 | RStructList (_, typ) ->
988 pr " struct guestfs_%s_list *ret_v;\n" typ
992 List.exists (function FileIn _ -> true | _ -> false) args in
994 pr " uint64_t progress_hint = 0;\n";
995 pr " struct stat progress_stat;\n";
997 pr " const uint64_t progress_hint = 0;\n";
1000 check_null_strings shortname style;
1001 reject_unknown_optargs shortname style;
1002 trace_call shortname style;
1004 (* Calculate the total size of all FileIn arguments to pass
1005 * as a progress bar hint.
1010 pr " if (stat (%s, &progress_stat) == 0 &&\n" n;
1011 pr " S_ISREG (progress_stat.st_mode))\n";
1012 pr " progress_hint += progress_stat.st_size;\n";
1017 (* Check we are in the right state for sending a request. *)
1018 pr " if (check_state (g, \"%s\") == -1) {\n" shortname;
1019 trace_return_error ~indent:4 style;
1020 pr " return %s;\n" (string_of_errcode errcode);
1022 pr " guestfs___set_busy (g);\n";
1025 (* Send the main header and arguments. *)
1026 if args = [] && optargs = [] then (
1027 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, progress_hint, 0,\n"
1028 (String.uppercase shortname);
1029 pr " NULL, NULL);\n"
1033 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
1034 pr " args.%s = (char *) %s;\n" n n
1036 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
1037 | StringList n | DeviceList n ->
1038 pr " args.%s.%s_val = (char **) %s;\n" n n n;
1039 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
1041 pr " args.%s = %s;\n" n n
1043 pr " args.%s = %s;\n" n n
1045 pr " args.%s = %s;\n" n n
1046 | FileIn _ | FileOut _ -> ()
1048 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
1049 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
1050 trace_return_error ~indent:4 style;
1051 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
1053 pr " guestfs___end_busy (g);\n";
1054 pr " return %s;\n" (string_of_errcode errcode);
1056 pr " args.%s.%s_val = (char *) %s;\n" n n n;
1057 pr " args.%s.%s_len = %s_size;\n" n n n
1058 | Pointer _ -> assert false
1063 let n = name_of_argt argt in
1064 let uc_shortname = String.uppercase shortname in
1065 let uc_n = String.uppercase n in
1066 pr " if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK))\n"
1072 pr " args.%s = optargs->%s;\n" n n;
1074 pr " args.%s = 0;\n" n
1076 pr " args.%s = (char *) optargs->%s;\n" n n;
1078 pr " args.%s = (char *) \"\";\n" n
1083 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
1084 (String.uppercase shortname);
1085 pr " progress_hint, %s,\n"
1086 (if optargs <> [] then "optargs->bitmask" else "0");
1087 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
1090 pr " if (serial == -1) {\n";
1091 pr " guestfs___end_busy (g);\n";
1092 trace_return_error ~indent:4 style;
1093 pr " return %s;\n" (string_of_errcode errcode);
1097 (* Send any additional files (FileIn) requested. *)
1098 let need_read_reply_label = ref false in
1102 pr " r = guestfs___send_file (g, %s);\n" n;
1103 pr " if (r == -1) {\n";
1104 pr " guestfs___end_busy (g);\n";
1105 trace_return_error ~indent:4 style;
1106 pr " return %s;\n" (string_of_errcode errcode);
1108 pr " if (r == -2) /* daemon cancelled */\n";
1109 pr " goto read_reply;\n";
1110 need_read_reply_label := true;
1115 (* Wait for the reply from the remote end. *)
1116 if !need_read_reply_label then pr " read_reply:\n";
1117 pr " memset (&hdr, 0, sizeof hdr);\n";
1118 pr " memset (&err, 0, sizeof err);\n";
1119 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
1121 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
1125 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
1128 pr " if (r == -1) {\n";
1129 pr " guestfs___end_busy (g);\n";
1130 trace_return_error ~indent:4 style;
1131 pr " return %s;\n" (string_of_errcode errcode);
1135 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
1136 (String.uppercase shortname);
1137 pr " guestfs___end_busy (g);\n";
1138 trace_return_error ~indent:4 style;
1139 pr " return %s;\n" (string_of_errcode errcode);
1143 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
1144 trace_return_error ~indent:4 style;
1145 pr " int errnum = 0;\n";
1146 pr " if (err.errno_string[0] != '\\0')\n";
1147 pr " errnum = guestfs___string_to_errno (err.errno_string);\n";
1148 pr " if (errnum <= 0)\n";
1149 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n"
1152 pr " guestfs_error_errno (g, errnum, \"%%s: %%s\", \"%s\",\n"
1154 pr " err.error_message);\n";
1155 pr " free (err.error_message);\n";
1156 pr " free (err.errno_string);\n";
1157 pr " guestfs___end_busy (g);\n";
1158 pr " return %s;\n" (string_of_errcode errcode);
1162 (* Expecting to receive further files (FileOut)? *)
1166 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
1167 pr " guestfs___end_busy (g);\n";
1168 trace_return_error ~indent:4 style;
1169 pr " return %s;\n" (string_of_errcode errcode);
1175 pr " guestfs___end_busy (g);\n";
1180 | RInt n | RInt64 n | RBool n ->
1181 pr " ret_v = ret.%s;\n" n
1182 | RConstString _ | RConstOptString _ ->
1183 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
1185 pr " ret_v = ret.%s; /* caller will free */\n" n
1186 | RStringList n | RHashtable n ->
1187 pr " /* caller will free this, but we need to add a NULL entry */\n";
1188 pr " ret.%s.%s_val =\n" n n;
1189 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
1190 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
1192 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
1193 pr " ret_v = ret.%s.%s_val;\n" n n
1195 pr " /* caller will free this */\n";
1196 pr " ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
1197 | RStructList (n, _) ->
1198 pr " /* caller will free this */\n";
1199 pr " ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
1201 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
1202 pr " * _val might be NULL here. To make the API saner for\n";
1203 pr " * callers, we turn this case into a unique pointer (using\n";
1204 pr " * malloc(1)).\n";
1206 pr " if (ret.%s.%s_len > 0) {\n" n n;
1207 pr " *size_r = ret.%s.%s_len;\n" n n;
1208 pr " ret_v = ret.%s.%s_val; /* caller will free */\n" n n;
1210 pr " free (ret.%s.%s_val);\n" n n;
1211 pr " char *p = safe_malloc (g, 1);\n";
1212 pr " *size_r = ret.%s.%s_len;\n" n n;
1216 trace_return style "ret_v";
1217 pr " return ret_v;\n";
1221 (* Functions to free structures. *)
1222 pr "/* Structure-freeing functions. These rely on the fact that the\n";
1223 pr " * structure format is identical to the XDR format. See note in\n";
1224 pr " * generator.ml.\n";
1231 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
1233 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
1239 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
1241 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
1248 (* Functions which have optional arguments have two generated variants. *)
1251 | shortname, (ret, args, (_::_ as optargs) as style), _, _, _, _, _ ->
1252 let uc_shortname = String.uppercase shortname in
1254 (* Get the name of the last regular argument. *)
1258 | args -> name_of_argt (List.hd (List.rev args)) in
1262 | RErr | RInt _ | RBool _ -> "int "
1263 | RInt64 _ -> "int64_t "
1264 | RConstString _ | RConstOptString _ -> "const char *"
1265 | RString _ | RBufferOut _ -> "char *"
1266 | RStringList _ | RHashtable _ -> "char **"
1267 | RStruct (_, typ) -> sprintf "struct guestfs_%s *" typ
1268 | RStructList (_, typ) ->
1269 sprintf "struct guestfs_%s_list *" typ in
1271 (* The regular variable args function, just calls the _va variant. *)
1272 generate_prototype ~extern:false ~semicolon:false ~newline:true
1273 ~handle:"g" ~prefix:"guestfs_" shortname style;
1275 pr " va_list optargs;\n";
1277 pr " va_start (optargs, %s);\n" last_arg;
1278 pr " %sr = guestfs_%s_va " rtype shortname;
1279 generate_c_call_args ~handle:"g" style;
1281 pr " va_end (optargs);\n";
1286 generate_prototype ~extern:false ~semicolon:false ~newline:true
1287 ~handle:"g" ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
1290 pr " struct guestfs_%s_argv optargs_s;\n" shortname;
1291 pr " struct guestfs_%s_argv *optargs = &optargs_s;\n" shortname;
1294 pr " optargs_s.bitmask = 0;\n";
1296 pr " while ((i = va_arg (args, int)) >= 0) {\n";
1297 pr " switch (i) {\n";
1301 let n = name_of_argt argt in
1302 let uc_n = String.uppercase n in
1303 pr " case GUESTFS_%s_%s:\n" uc_shortname uc_n;
1304 pr " optargs_s.%s = va_arg (args, " n;
1306 | Bool _ | Int _ -> pr "int"
1307 | Int64 _ -> pr "int64_t"
1308 | String _ -> pr "const char *"
1316 match errcode_of_ret ret with
1317 | `CannotReturnError -> assert false
1318 | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
1321 pr " error (g, \"%%s: unknown option %%d (this can happen if a program is compiled against a newer version of libguestfs, then dynamically linked to an older version)\",\n";
1322 pr " \"%s\", i);\n" shortname;
1323 pr " return %s;\n" (string_of_errcode errcode);
1326 pr " uint64_t i_mask = UINT64_C(1) << i;\n";
1327 pr " if (optargs_s.bitmask & i_mask) {\n";
1328 pr " error (g, \"%%s: same optional argument specified more than once\",\n";
1329 pr " \"%s\");\n" shortname;
1330 pr " return %s;\n" (string_of_errcode errcode);
1332 pr " optargs_s.bitmask |= i_mask;\n";
1335 pr " return guestfs_%s_argv " shortname;
1336 generate_c_call_args ~handle:"g" style;
1340 ) all_functions_sorted
1342 (* Generate the linker script which controls the visibility of
1343 * symbols in the public ABI and ensures no other symbols get
1344 * exported accidentally.
1346 and generate_linker_script () =
1347 generate_header HashStyle GPLv2plus;
1352 "guestfs_get_error_handler";
1353 "guestfs_get_out_of_memory_handler";
1354 "guestfs_get_private";
1355 "guestfs_last_errno";
1356 "guestfs_last_error";
1357 "guestfs_set_close_callback";
1358 "guestfs_set_error_handler";
1359 "guestfs_set_launch_done_callback";
1360 "guestfs_set_log_message_callback";
1361 "guestfs_set_out_of_memory_handler";
1362 "guestfs_set_private";
1363 "guestfs_set_progress_callback";
1364 "guestfs_set_subprocess_quit_callback";
1366 (* Unofficial parts of the API: the bindings code use these
1367 * functions, so it is useful to export them.
1369 "guestfs_safe_calloc";
1370 "guestfs_safe_malloc";
1371 "guestfs_safe_strdup";
1372 "guestfs_safe_memdup";
1374 "guestfs___for_each_disk";
1380 | name, (_, _, []), _, _, _, _, _ -> ["guestfs_" ^ name]
1381 | name, (_, _, _), _, _, _, _, _ ->
1383 "guestfs_" ^ name ^ "_va";
1384 "guestfs_" ^ name ^ "_argv"]
1389 List.map (fun (typ, _) ->
1390 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
1393 let globals = List.sort compare (globals @ functions @ structs) in
1397 List.iter (pr " %s;\n") globals;
1404 and generate_max_proc_nr () =
1405 pr "%d\n" max_proc_nr