X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=generator%2Fgenerator_c.ml;h=4324ec06edcc1be8ca7bda61200b685d9aa33dcb;hp=a2f40da30c107fd2b138e86428383e14e893ab19;hb=HEAD;hpb=4ada0a7815075c9cbe9d8b00da791c105ae739a9 diff --git a/generator/generator_c.ml b/generator/generator_c.ml index a2f40da..4324ec0 100644 --- a/generator/generator_c.ml +++ b/generator/generator_c.ml @@ -1,5 +1,5 @@ (* libguestfs - * Copyright (C) 2009-2010 Red Hat Inc. + * Copyright (C) 2009-2011 Red Hat Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -28,6 +28,7 @@ open Generator_api_versions open Generator_optgroups open Generator_actions open Generator_structs +open Generator_events (* Generate C API. *) @@ -134,7 +135,8 @@ let rec generate_prototype ?(extern = true) ?(static = false) if newline then pr "\n" (* Generate C call arguments, eg "(handle, foo, bar)" *) -and generate_c_call_args ?handle (ret, args, optargs) = +and generate_c_call_args ?handle ?(implicit_size_ptr = "&size") + (ret, args, optargs) = pr "("; let comma = ref false in let next () = @@ -154,11 +156,11 @@ and generate_c_call_args ?handle (ret, args, optargs) = next (); pr "%s" (name_of_argt arg) ) args; - (* For RBufferOut calls, add implicit &size parameter. *) + (* For RBufferOut calls, add implicit size pointer parameter. *) (match ret with | RBufferOut _ -> next (); - pr "&size" + pr "%s" implicit_size_ptr | _ -> () ); (* For calls with optional arguments, add implicit optargs parameter. *) @@ -178,6 +180,11 @@ and generate_actions_pod () = generate_prototype ~extern:false ~indent:" " ~handle:"g" name style; pr "\n\n"; + (match deprecation_notice ~prefix:"guestfs_" flags with + | None -> () + | Some txt -> pr "%s\n\n" txt + ); + let uc_shortname = String.uppercase shortname in if optargs <> [] then ( pr "You may supply a list of optional arguments to this call.\n"; @@ -186,15 +193,14 @@ and generate_actions_pod () = pr "See L.\n\n"; List.iter ( fun argt -> - let n = name_of_argt argt in + let n = name_of_optargt argt in let uc_n = String.uppercase n in pr " GUESTFS_%s_%s, " uc_shortname uc_n; match argt with - | Bool n -> pr "int %s,\n" n - | Int n -> pr "int %s,\n" n - | Int64 n -> pr "int64_t %s,\n" n - | String n -> pr "const char *%s,\n" n - | _ -> assert false + | OBool n -> pr "int %s,\n" n + | OInt n -> pr "int %s,\n" n + | OInt64 n -> pr "int64_t %s,\n" n + | OString n -> pr "const char *%s,\n" n ) optargs; pr "\n"; ); @@ -229,8 +235,7 @@ I.\n\n" or NULL if there was an error. I after use>.\n\n" typ typ | RStructList (_, typ) -> - pr "This function returns a C -(see Eguestfs-structs.hE), + pr "This function returns a C, or NULL if there was an error. I after use>.\n\n" typ typ | RHashtable _ -> @@ -248,16 +253,10 @@ I.\n\n" pr "%s\n\n" progress_message; if List.mem ProtocolLimitWarning flags then pr "%s\n\n" protocol_limit_warning; - if List.mem DangerWillRobinson flags then - pr "%s\n\n" danger_will_robinson; - if List.exists (function Key _ -> true | _ -> false) (args@optargs) then + if List.exists (function Key _ -> true | _ -> false) args then pr "This function takes a key or passphrase parameter which could contain sensitive material. Read the section L for more information.\n\n"; - (match deprecation_notice flags with - | None -> () - | Some txt -> pr "%s\n\n" txt - ); (match lookup_api_version name with | Some version -> pr "(Added in %s)\n\n" version | None -> () @@ -337,22 +336,179 @@ and generate_availability_pod () = pr "=back\n"; pr "\n" -(* Generate the guestfs-structs.h file. *) -and generate_structs_h () = +(* Generate the guestfs.h file. *) +and generate_guestfs_h () = generate_header CStyle LGPLv2plus; - (* This is a public exported header file containing various - * structures. The structures are carefully written to have - * exactly the same in-memory format as the XDR structures that - * we use on the wire to the daemon. The reason for creating - * copies of these structures here is just so we don't have to - * export the whole of guestfs_protocol.h (which includes much - * unrelated and XDR-dependent stuff that we don't want to be - * public, or required by clients). - * - * To reiterate, we will pass these structures to and from the - * client with a simple assignment or memcpy, so the format - * must be identical to what rpcgen / the RFC defines. + pr "\ +/* ---------- IMPORTANT NOTE ---------- + * + * All API documentation is in the manpage, 'guestfs(3)'. + * To read it, type: man 3 guestfs + * Or read it online here: http://libguestfs.org/guestfs.3.html + * + * Go and read it now, I'll be right here waiting for you + * when you come back. + * + * ------------------------------------ + */ + +#ifndef GUESTFS_H_ +#define GUESTFS_H_ + +#ifdef __cplusplus +extern \"C\" { +#endif + +#include +#include +#include + +#ifdef __GNUC__ +# define GUESTFS_GCC_VERSION \\ + (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) +#endif + +/* Define GUESTFS_WARN_DEPRECATED=1 to warn about deprecated API functions. */ +#define GUESTFS_DEPRECATED_BY(s) +#if GUESTFS_WARN_DEPRECATED +# if defined(__GNUC__) && GUESTFS_GCC_VERSION >= 40500 /* gcc >= 4.5 */ +# undef GUESTFS_DEPRECATED_BY +# define GUESTFS_DEPRECATED_BY(s) __attribute__((__deprecated__(\"change the program to use guestfs_\" s \" instead of this deprecated function\"))) +# endif +#endif /* GUESTFS_WARN_DEPRECATED */ + +/* The handle. */ +#ifndef GUESTFS_TYPEDEF_H +#define GUESTFS_TYPEDEF_H 1 +typedef struct guestfs_h guestfs_h; +#endif + +/* Connection management. */ +extern guestfs_h *guestfs_create (void); +extern void guestfs_close (guestfs_h *g); + +/* Error handling. */ +extern const char *guestfs_last_error (guestfs_h *g); +#define LIBGUESTFS_HAVE_LAST_ERRNO 1 +extern int guestfs_last_errno (guestfs_h *g); + +#ifndef GUESTFS_TYPEDEF_ERROR_HANDLER_CB +#define GUESTFS_TYPEDEF_ERROR_HANDLER_CB 1 +typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *opaque, const char *msg); +#endif + +#ifndef GUESTFS_TYPEDEF_ABORT_CB +#define GUESTFS_TYPEDEF_ABORT_CB 1 +typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__)); +#endif + +extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *opaque); +extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **opaque_rtn); + +extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb); +extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g); + +/* Events. */ +"; + + List.iter ( + fun (name, bitmask) -> + pr "#define GUESTFS_EVENT_%-16s 0x%04x\n" + (String.uppercase name) bitmask + ) events; + pr "#define GUESTFS_EVENT_%-16s UINT64_MAX\n" "ALL"; + pr "\n"; + + pr "\ +#ifndef GUESTFS_TYPEDEF_EVENT_CALLBACK +#define GUESTFS_TYPEDEF_EVENT_CALLBACK 1 +typedef void (*guestfs_event_callback) ( + guestfs_h *g, + void *opaque, + uint64_t event, + int event_handle, + int flags, + const char *buf, size_t buf_len, + const uint64_t *array, size_t array_len); +#endif + +#define LIBGUESTFS_HAVE_SET_EVENT_CALLBACK 1 +extern int guestfs_set_event_callback (guestfs_h *g, + guestfs_event_callback cb, + uint64_t event_bitmask, + int flags, + void *opaque); +#define LIBGUESTFS_HAVE_DELETE_EVENT_CALLBACK 1 +extern void guestfs_delete_event_callback (guestfs_h *g, int event_handle); + +/* Old-style event handling. */ +#ifndef GUESTFS_TYPEDEF_LOG_MESSAGE_CB +#define GUESTFS_TYPEDEF_LOG_MESSAGE_CB 1 +typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, char *buf, int len); +#endif + +#ifndef GUESTFS_TYPEDEF_SUBPROCESS_QUIT_CB +#define GUESTFS_TYPEDEF_SUBPROCESS_QUIT_CB 1 +typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque); +#endif + +#ifndef GUESTFS_TYPEDEF_LAUNCH_DONE_CB +#define GUESTFS_TYPEDEF_LAUNCH_DONE_CB 1 +typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque); +#endif + +#ifndef GUESTFS_TYPEDEF_CLOSE_CB +#define GUESTFS_TYPEDEF_CLOSE_CB 1 +typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque); +#endif + +#ifndef GUESTFS_TYPEDEF_PROGRESS_CB +#define GUESTFS_TYPEDEF_PROGRESS_CB 1 +typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque, int proc_nr, int serial, uint64_t position, uint64_t total); +#endif + +extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque) + GUESTFS_DEPRECATED_BY(\"set_event_callback\"); +extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque) + GUESTFS_DEPRECATED_BY(\"set_event_callback\"); +extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque) + GUESTFS_DEPRECATED_BY(\"set_event_callback\"); +#define LIBGUESTFS_HAVE_SET_CLOSE_CALLBACK 1 +extern void guestfs_set_close_callback (guestfs_h *g, guestfs_close_cb cb, void *opaque) + GUESTFS_DEPRECATED_BY(\"set_event_callback\"); +#define LIBGUESTFS_HAVE_SET_PROGRESS_CALLBACK 1 +extern void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque) + GUESTFS_DEPRECATED_BY(\"set_event_callback\"); + +/* User cancellation. */ +#define LIBGUESTFS_HAVE_USER_CANCEL 1 +extern void guestfs_user_cancel (guestfs_h *g); + +/* Private data area. */ +#define LIBGUESTFS_HAVE_SET_PRIVATE 1 +extern void guestfs_set_private (guestfs_h *g, const char *key, void *data); +#define LIBGUESTFS_HAVE_GET_PRIVATE 1 +extern void *guestfs_get_private (guestfs_h *g, const char *key); +#define LIBGUESTFS_HAVE_FIRST_PRIVATE 1 +extern void *guestfs_first_private (guestfs_h *g, const char **key_rtn); +#define LIBGUESTFS_HAVE_NEXT_PRIVATE 1 +extern void *guestfs_next_private (guestfs_h *g, const char **key_rtn); + +/* Structures. */ +"; + + (* The structures are carefully written to have exactly the same + * in-memory format as the XDR structures that we use on the wire to + * the daemon. The reason for creating copies of these structures + * here is just so we don't have to export the whole of + * guestfs_protocol.h (which includes much unrelated and + * XDR-dependent stuff that we don't want to be public, or required + * by clients). + * + * To reiterate, we will pass these structures to and from the client + * with a simple assignment or memcpy, so the format must be + * identical to what rpcgen / the RFC defines. *) (* Public structures. *) @@ -383,59 +539,103 @@ and generate_structs_h () = pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ; pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ; pr "\n" - ) structs + ) structs; + + pr "\ +/* Actions. */ +"; -(* Generate the guestfs-actions.h file. *) -and generate_actions_h () = - generate_header CStyle LGPLv2plus; List.iter ( fun (shortname, (ret, args, optargs as style), _, flags, _, _, _) -> let deprecated = - List.exists (function DeprecatedBy _ -> true | _ -> false) flags in + try + Some (find_map (function DeprecatedBy fn -> Some fn | _ -> None) + flags) + with Not_found -> None in let test0 = String.length shortname >= 5 && String.sub shortname 0 5 = "test0" in let debug = String.length shortname >= 5 && String.sub shortname 0 5 = "debug" in - if not deprecated && not test0 && not debug then + if deprecated = None && not test0 && not debug then pr "#define LIBGUESTFS_HAVE_%s 1\n" (String.uppercase shortname); - generate_prototype ~single_line:true ~newline:true ~handle:"g" - ~prefix:"guestfs_" shortname style; + if optargs <> [] then ( + iteri ( + fun i argt -> + let uc_shortname = String.uppercase shortname in + let n = name_of_optargt argt in + let uc_n = String.uppercase n in + pr "#define GUESTFS_%s_%s %d\n" uc_shortname uc_n i; + ) optargs; + ); + + generate_prototype ~single_line:true ~semicolon:false + ~handle:"g" ~prefix:"guestfs_" shortname style; + (match deprecated with + | Some fn -> pr "\n GUESTFS_DEPRECATED_BY (%S);\n" fn + | None -> pr ";\n" + ); if optargs <> [] then ( generate_prototype ~single_line:true ~newline:true ~handle:"g" ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA shortname style; + pr "\n"; pr "struct guestfs_%s_argv {\n" shortname; pr " uint64_t bitmask;\n"; iteri ( fun i argt -> let c_type = match argt with - | Bool n -> "int " - | Int n -> "int64_t " - | Int64 n -> "int " - | String n -> "const char *" - | _ -> assert false (* checked in generator_checks *) in + | OBool n -> "int " + | OInt n -> "int " + | OInt64 n -> "int64_t " + | OString n -> "const char *" in let uc_shortname = String.uppercase shortname in - let n = name_of_argt argt in + let n = name_of_optargt argt in let uc_n = String.uppercase n in - pr "#define GUESTFS_%s_%s %d\n" uc_shortname uc_n i; - pr "#define GUESTFS_%s_%s_BITMASK (UINT64_C(1)<<%d)\n" uc_shortname uc_n i; - pr "/* The field below is only valid in this struct if the\n"; - pr " * GUESTFS_%s_%s_BITMASK bit is set\n" uc_shortname uc_n; - pr " * in the bitmask above, otherwise the contents are ignored.\n"; - pr " */\n"; + pr "\n"; + pr "# define GUESTFS_%s_%s_BITMASK (UINT64_C(1)<<%d)\n" uc_shortname uc_n i; + pr " /* The field below is only valid in this struct if the\n"; + pr " * GUESTFS_%s_%s_BITMASK bit is set\n" uc_shortname uc_n; + pr " * in the bitmask above. If not, the field is ignored.\n"; + pr " */\n"; pr " %s%s;\n" c_type n ) optargs; pr "};\n"; + pr "\n"; generate_prototype ~single_line:true ~newline:true ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv shortname style; ); - ) all_functions_sorted + + pr "\n"; + ) all_functions_sorted; + + pr "\ + +/* Private functions. + * + * These are NOT part of the public, stable API, and can change at any + * time! We export them because they are used by some of the language + * bindings. + */ +extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes); +extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s); +extern const char *guestfs_tmpdir (void); +#ifdef GUESTFS_PRIVATE_FOR_EACH_DISK +extern int guestfs___for_each_disk (guestfs_h *g, virDomainPtr dom, int (*)(guestfs_h *g, const char *filename, const char *format, int readonly, void *data), void *data); +#endif +/* End of private functions. */ + +#ifdef __cplusplus +} +#endif + +#endif /* GUESTFS_H_ */ +" (* Generate the guestfs-internal-actions.h file. *) and generate_internal_actions_h () = @@ -457,6 +657,10 @@ and generate_client_actions () = #include #include #include +#include +#include +#include +#include #include \"guestfs.h\" #include \"guestfs-internal.h\" @@ -512,14 +716,49 @@ check_state (guestfs_h *g, const char *caller) return 0; } +/* Convenience wrapper for tracing. */ +static FILE * +trace_open (guestfs_h *g) +{ + assert (g->trace_fp == NULL); + g->trace_buf = NULL; + g->trace_len = 0; + g->trace_fp = open_memstream (&g->trace_buf, &g->trace_len); + if (g->trace_fp) + return g->trace_fp; + else + return stderr; +} + +static void +trace_send_line (guestfs_h *g) +{ + char *buf; + size_t len; + + if (g->trace_fp) { + fclose (g->trace_fp); + g->trace_fp = NULL; + + /* The callback might invoke other libguestfs calls, so keep + * a copy of the pointer to the buffer and length. + */ + buf = g->trace_buf; + len = g->trace_len; + g->trace_buf = NULL; + guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, buf, len); + + free (buf); + } +} + "; - let error_code_of = function - | RErr | RInt _ | RInt64 _ | RBool _ -> "-1" - | RConstString _ | RConstOptString _ - | RString _ | RStringList _ - | RStruct _ | RStructList _ - | RHashtable _ | RBufferOut _ -> "NULL" + (* Generate code for enter events. *) + let enter_event shortname = + pr " guestfs___call_callbacks_message (g, GUESTFS_EVENT_ENTER,\n"; + pr " \"%s\", %d);\n" + shortname (String.length shortname) in (* Generate code to check String-like parameters are not passed in @@ -544,7 +783,17 @@ check_state (guestfs_h *g, const char *caller) pr " if (%s == NULL) {\n" n; pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n"; pr " \"%s\", \"%s\");\n" shortname n; - pr " return %s;\n" (error_code_of ret); + let errcode = + match errcode_of_ret ret with + | `CannotReturnError -> + if shortname = "test0rconstoptstring" then (* XXX hack *) + `ErrorIsNULL + else + failwithf + "%s: RConstOptString function has invalid parameter '%s'" + shortname n + | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr_newline := true @@ -560,20 +809,22 @@ check_state (guestfs_h *g, const char *caller) (* For optional arguments. *) List.iter ( function - | String n -> + | OString n -> pr " if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK) &&\n" (String.uppercase shortname) (String.uppercase n); pr " optargs->%s == NULL) {\n" n; pr " error (g, \"%%s: %%s: optional parameter cannot be NULL\",\n"; pr " \"%s\", \"%s\");\n" shortname n; - pr " return %s;\n" (error_code_of ret); + let errcode = + match errcode_of_ret ret with + | `CannotReturnError -> assert false + | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr_newline := true (* not applicable *) - | Bool _ | Int _ | Int64 _ -> () - - | _ -> assert false + | OBool _ | OInt _ | OInt64 _ -> () ) optargs; if !pr_newline then pr "\n"; @@ -588,14 +839,18 @@ check_state (guestfs_h *g, const char *caller) pr " if (optargs->bitmask & UINT64_C(0x%Lx)) {\n" mask; 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"; pr " \"%s\", \"%s\");\n" shortname shortname; - pr " return %s;\n" (error_code_of ret); + let errcode = + match errcode_of_ret ret with + | `CannotReturnError -> assert false + | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; in (* Generate code to generate guestfish call traces. *) let trace_call shortname (ret, args, optargs) = - pr " if (guestfs__get_trace (g)) {\n"; + pr " if (trace_flag) {\n"; let needs_i = List.exists (function @@ -606,7 +861,9 @@ check_state (guestfs_h *g, const char *caller) pr "\n" ); - pr " fprintf (stderr, \"%s\");\n" shortname; + pr " trace_fp = trace_open (g);\n"; + + pr " fprintf (trace_fp, \"%%s\", \"%s\");\n" shortname; (* Required arguments. *) List.iter ( @@ -618,64 +875,128 @@ check_state (guestfs_h *g, const char *caller) | FileIn n | FileOut n -> (* guestfish doesn't support string escaping, so neither do we *) - pr " fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n + pr " fprintf (trace_fp, \" \\\"%%s\\\"\", %s);\n" n | Key n -> (* don't print keys *) - pr " fprintf (stderr, \" \\\"***\\\"\");\n" + pr " fprintf (trace_fp, \" \\\"***\\\"\");\n" | OptString n -> (* string option *) - pr " if (%s) fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n n; - pr " else fprintf (stderr, \" null\");\n" + pr " if (%s) fprintf (trace_fp, \" \\\"%%s\\\"\", %s);\n" n n; + pr " else fprintf (trace_fp, \" null\");\n" | StringList n | DeviceList n -> (* string list *) - pr " fputc (' ', stderr);\n"; - pr " fputc ('\"', stderr);\n"; + pr " fputc (' ', trace_fp);\n"; + pr " fputc ('\"', trace_fp);\n"; pr " for (i = 0; %s[i]; ++i) {\n" n; - pr " if (i > 0) fputc (' ', stderr);\n"; - pr " fputs (%s[i], stderr);\n" n; + pr " if (i > 0) fputc (' ', trace_fp);\n"; + pr " fputs (%s[i], trace_fp);\n" n; pr " }\n"; - pr " fputc ('\"', stderr);\n"; + pr " fputc ('\"', trace_fp);\n"; | Bool n -> (* boolean *) - pr " fputs (%s ? \" true\" : \" false\", stderr);\n" n + pr " fputs (%s ? \" true\" : \" false\", trace_fp);\n" n | Int n -> (* int *) - pr " fprintf (stderr, \" %%d\", %s);\n" n + pr " fprintf (trace_fp, \" %%d\", %s);\n" n | Int64 n -> - pr " fprintf (stderr, \" %%\" PRIi64, %s);\n" n + pr " fprintf (trace_fp, \" %%\" PRIi64, %s);\n" n | BufferIn n -> (* RHBZ#646822 *) - pr " fputc (' ', stderr);\n"; - pr " guestfs___print_BufferIn (stderr, %s, %s_size);\n" n n + pr " fputc (' ', trace_fp);\n"; + pr " guestfs___print_BufferIn (trace_fp, %s, %s_size);\n" n n | Pointer (t, n) -> - pr " fprintf (stderr, \" (%s)%%p\", %s);\n" t n + pr " fprintf (trace_fp, \" (%s)%%p\", %s);\n" t n ) args; (* Optional arguments. *) List.iter ( fun argt -> - let n = name_of_argt argt in + let n = name_of_optargt argt in let uc_shortname = String.uppercase shortname in let uc_n = String.uppercase n in pr " if (optargs->bitmask & GUESTFS_%s_%s_BITMASK)\n" uc_shortname uc_n; (match argt with - | String n -> - pr " fprintf (stderr, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s);\n" n n - | Bool n -> - pr " fprintf (stderr, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s ? \"true\" : \"false\");\n" n n - | Int n -> - pr " fprintf (stderr, \" \\\"%%s:%%d\\\"\", \"%s\", optargs->%s);\n" n n - | Int64 n -> - pr " fprintf (stderr, \" \\\"%%s:%%\" PRIi64 \"\\\"\", \"%s\", optargs->%s);\n" n n - | _ -> assert false + | OString n -> + pr " fprintf (trace_fp, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s);\n" n n + | OBool n -> + pr " fprintf (trace_fp, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s ? \"true\" : \"false\");\n" n n + | OInt n -> + pr " fprintf (trace_fp, \" \\\"%%s:%%d\\\"\", \"%s\", optargs->%s);\n" n n + | OInt64 n -> + pr " fprintf (trace_fp, \" \\\"%%s:%%\" PRIi64 \"\\\"\", \"%s\", optargs->%s);\n" n n ); ) optargs; - pr " fputc ('\\n', stderr);\n"; + pr " trace_send_line (g);\n"; pr " }\n"; pr "\n"; in + let trace_return ?(indent = 2) shortname (ret, _, _) rv = + let indent = spaces indent in + + pr "%sif (trace_flag) {\n" indent; + + let needs_i = + match ret with + | RStringList _ | RHashtable _ -> true + | _ -> false in + if needs_i then ( + pr "%s size_t i;\n" indent; + pr "\n" + ); + + pr "%s trace_fp = trace_open (g);\n" indent; + + pr "%s fprintf (trace_fp, \"%%s = \", \"%s\");\n" indent shortname; + + (match ret with + | RErr | RInt _ | RBool _ -> + pr "%s fprintf (trace_fp, \"%%d\", %s);\n" indent rv + | RInt64 _ -> + pr "%s fprintf (trace_fp, \"%%\" PRIi64, %s);\n" indent rv + | RConstString _ | RString _ -> + pr "%s fprintf (trace_fp, \"\\\"%%s\\\"\", %s);\n" indent rv + | RConstOptString _ -> + pr "%s fprintf (trace_fp, \"\\\"%%s\\\"\", %s != NULL ? %s : \"NULL\");\n" + indent rv rv + | RBufferOut _ -> + pr "%s guestfs___print_BufferOut (trace_fp, %s, *size_r);\n" indent rv + | RStringList _ | RHashtable _ -> + pr "%s fputs (\"[\", trace_fp);\n" indent; + pr "%s for (i = 0; %s[i]; ++i) {\n" indent rv; + pr "%s if (i > 0) fputs (\", \", trace_fp);\n" indent; + pr "%s fputs (\"\\\"\", trace_fp);\n" indent; + pr "%s fputs (%s[i], trace_fp);\n" indent rv; + pr "%s fputs (\"\\\"\", trace_fp);\n" indent; + pr "%s }\n" indent; + pr "%s fputs (\"]\", trace_fp);\n" indent; + | RStruct (_, typ) -> + (* XXX There is code generated for guestfish for printing + * these structures. We need to make it generally available + * for all callers + *) + pr "%s fprintf (trace_fp, \"\");\n" + indent typ (* XXX *) + | RStructList (_, typ) -> + pr "%s fprintf (trace_fp, \"\");\n" + indent typ (* XXX *) + ); + pr "%s trace_send_line (g);\n" indent; + pr "%s}\n" indent; + pr "\n"; + in + + let trace_return_error ?(indent = 2) shortname (ret, _, _) errcode = + let indent = spaces indent in + + pr "%sif (trace_flag)\n" indent; + + pr "%s guestfs___trace (g, \"%%s = %%s (error)\",\n" indent; + pr "%s \"%s\", \"%s\");\n" + indent shortname (string_of_errcode errcode) + in + (* For non-daemon functions, generate a wrapper around each function. *) List.iter ( - fun (shortname, (_, _, optargs as style), _, _, _, _, _) -> + fun (shortname, (ret, _, optargs as style), _, _, _, _, _) -> if optargs = [] then generate_prototype ~extern:false ~semicolon:false ~newline:true ~handle:"g" ~prefix:"guestfs_" @@ -685,12 +1006,47 @@ check_state (guestfs_h *g, const char *caller) ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv shortname style; pr "{\n"; + pr " int trace_flag = g->trace;\n"; + pr " FILE *trace_fp;\n"; + (match ret with + | RErr | RInt _ | RBool _ -> + pr " int r;\n" + | RInt64 _ -> + pr " int64_t r;\n" + | RConstString _ -> + pr " const char *r;\n" + | RConstOptString _ -> + pr " const char *r;\n" + | RString _ | RBufferOut _ -> + pr " char *r;\n" + | RStringList _ | RHashtable _ -> + pr " char **r;\n" + | RStruct (_, typ) -> + pr " struct guestfs_%s *r;\n" typ + | RStructList (_, typ) -> + pr " struct guestfs_%s_list *r;\n" typ + ); + pr "\n"; + enter_event shortname; check_null_strings shortname style; reject_unknown_optargs shortname style; trace_call shortname style; - pr " return guestfs__%s " shortname; - generate_c_call_args ~handle:"g" style; + pr " r = guestfs__%s " shortname; + generate_c_call_args ~handle:"g" ~implicit_size_ptr:"size_r" style; pr ";\n"; + pr "\n"; + (match errcode_of_ret ret with + | (`ErrorIsMinusOne | `ErrorIsNULL) as errcode -> + pr " if (r != %s) {\n" (string_of_errcode errcode); + trace_return ~indent:4 shortname style "r"; + pr " } else {\n"; + trace_return_error ~indent:4 shortname style errcode; + pr " }\n"; + | `CannotReturnError -> + trace_return shortname style "r"; + ); + pr "\n"; + pr " return r;\n"; pr "}\n"; pr "\n" ) non_daemon_functions; @@ -698,19 +1054,20 @@ check_state (guestfs_h *g, const char *caller) (* Client-side stubs for each function. *) List.iter ( fun (shortname, (ret, args, optargs as style), _, _, _, _, _) -> - if optargs <> [] then - failwithf "optargs not yet implemented for daemon functions"; - let name = "guestfs_" ^ shortname in - let error_code = error_code_of ret in + let errcode = + match errcode_of_ret ret with + | `CannotReturnError -> assert false + | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in (* Generate the action stub. *) if optargs = [] then generate_prototype ~extern:false ~semicolon:false ~newline:true - ~handle:"g" name style + ~handle:"g" ~prefix:"guestfs_" shortname style else generate_prototype ~extern:false ~semicolon:false ~newline:true - ~handle:"g" ~suffix:"_argv" ~optarg_proto:Argv name style; + ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv" + ~optarg_proto:Argv shortname style; pr "{\n"; @@ -735,57 +1092,128 @@ check_state (guestfs_h *g, const char *caller) pr " int serial;\n"; pr " int r;\n"; + pr " int trace_flag = g->trace;\n"; + pr " FILE *trace_fp;\n"; + (match ret with + | RErr | RInt _ | RBool _ -> + pr " int ret_v;\n" + | RInt64 _ -> + pr " int64_t ret_v;\n" + | RConstString _ | RConstOptString _ -> + pr " const char *ret_v;\n" + | RString _ | RBufferOut _ -> + pr " char *ret_v;\n" + | RStringList _ | RHashtable _ -> + pr " char **ret_v;\n" + | RStruct (_, typ) -> + pr " struct guestfs_%s *ret_v;\n" typ + | RStructList (_, typ) -> + pr " struct guestfs_%s_list *ret_v;\n" typ + ); + + let has_filein = + List.exists (function FileIn _ -> true | _ -> false) args in + if has_filein then ( + pr " uint64_t progress_hint = 0;\n"; + pr " struct stat progress_stat;\n"; + ) else + pr " const uint64_t progress_hint = 0;\n"; + pr "\n"; + enter_event shortname; check_null_strings shortname style; reject_unknown_optargs shortname style; trace_call shortname style; - pr " if (check_state (g, \"%s\") == -1) return %s;\n" - shortname error_code; + + (* Calculate the total size of all FileIn arguments to pass + * as a progress bar hint. + *) + List.iter ( + function + | FileIn n -> + pr " if (stat (%s, &progress_stat) == 0 &&\n" n; + pr " S_ISREG (progress_stat.st_mode))\n"; + pr " progress_hint += progress_stat.st_size;\n"; + pr "\n"; + | _ -> () + ) args; + + (* Check we are in the right state for sending a request. *) + pr " if (check_state (g, \"%s\") == -1) {\n" shortname; + trace_return_error ~indent:4 shortname style errcode; + pr " return %s;\n" (string_of_errcode errcode); + pr " }\n"; pr " guestfs___set_busy (g);\n"; pr "\n"; (* Send the main header and arguments. *) - (match args with - | [] -> - pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n" - (String.uppercase shortname) - | args -> - List.iter ( - function - | Pathname n | Device n | Dev_or_Path n | String n | Key n -> - pr " args.%s = (char *) %s;\n" n n - | OptString n -> - pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n - | StringList n | DeviceList n -> - pr " args.%s.%s_val = (char **) %s;\n" n n n; - pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n; - | Bool n -> - pr " args.%s = %s;\n" n n - | Int n -> - pr " args.%s = %s;\n" n n - | Int64 n -> - pr " args.%s = %s;\n" n n - | FileIn _ | FileOut _ -> () - | BufferIn n -> - pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n"; - pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n; - pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n" - shortname; - pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; - pr " }\n"; - pr " args.%s.%s_val = (char *) %s;\n" n n n; - pr " args.%s.%s_len = %s_size;\n" n n n - | Pointer _ -> assert false - ) args; - pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n" - (String.uppercase shortname); - pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n" - name; + if args = [] && optargs = [] then ( + pr " serial = guestfs___send (g, GUESTFS_PROC_%s, progress_hint, 0,\n" + (String.uppercase shortname); + pr " NULL, NULL);\n" + ) else ( + List.iter ( + function + | Pathname n | Device n | Dev_or_Path n | String n | Key n -> + pr " args.%s = (char *) %s;\n" n n + | OptString n -> + pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n + | StringList n | DeviceList n -> + pr " args.%s.%s_val = (char **) %s;\n" n n n; + pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n; + | Bool n -> + pr " args.%s = %s;\n" n n + | Int n -> + pr " args.%s = %s;\n" n n + | Int64 n -> + pr " args.%s = %s;\n" n n + | FileIn _ | FileOut _ -> () + | BufferIn n -> + pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n"; + pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n; + trace_return_error ~indent:4 shortname style errcode; + pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n" + shortname; + pr " guestfs___end_busy (g);\n"; + pr " return %s;\n" (string_of_errcode errcode); + pr " }\n"; + pr " args.%s.%s_val = (char *) %s;\n" n n n; + pr " args.%s.%s_len = %s_size;\n" n n n + | Pointer _ -> assert false + ) args; + + List.iter ( + fun argt -> + let n = name_of_optargt argt in + let uc_shortname = String.uppercase shortname in + let uc_n = String.uppercase n in + pr " if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK))\n" + uc_shortname uc_n; + (match argt with + | OBool n + | OInt n + | OInt64 n -> + pr " args.%s = optargs->%s;\n" n n; + pr " else\n"; + pr " args.%s = 0;\n" n + | OString n -> + pr " args.%s = (char *) optargs->%s;\n" n n; + pr " else\n"; + pr " args.%s = (char *) \"\";\n" n + ) + ) optargs; + + pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n" + (String.uppercase shortname); + pr " progress_hint, %s,\n" + (if optargs <> [] then "optargs->bitmask" else "0"); + pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n" + name; ); pr " if (serial == -1) {\n"; pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; + trace_return_error ~indent:4 shortname style errcode; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; @@ -797,7 +1225,10 @@ check_state (guestfs_h *g, const char *caller) pr " r = guestfs___send_file (g, %s);\n" n; pr " if (r == -1) {\n"; pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; + trace_return_error ~indent:4 shortname style errcode; + pr " /* daemon will send an error reply which we discard */\n"; + pr " guestfs___recv_discard (g, \"%s\");\n" shortname; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr " if (r == -2) /* daemon cancelled */\n"; pr " goto read_reply;\n"; @@ -821,18 +1252,21 @@ check_state (guestfs_h *g, const char *caller) pr " if (r == -1) {\n"; pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; + trace_return_error ~indent:4 shortname style errcode; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n" (String.uppercase shortname); pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; + trace_return_error ~indent:4 shortname style errcode; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n"; + trace_return_error ~indent:4 shortname style errcode; pr " int errnum = 0;\n"; pr " if (err.errno_string[0] != '\\0')\n"; pr " errnum = guestfs___string_to_errno (err.errno_string);\n"; @@ -846,7 +1280,7 @@ check_state (guestfs_h *g, const char *caller) pr " free (err.error_message);\n"; pr " free (err.errno_string);\n"; pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; @@ -856,7 +1290,8 @@ check_state (guestfs_h *g, const char *caller) | FileOut n -> pr " if (guestfs___recv_file (g, %s) == -1) {\n" n; pr " guestfs___end_busy (g);\n"; - pr " return %s;\n" error_code; + trace_return_error ~indent:4 shortname style errcode; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; | _ -> () @@ -865,13 +1300,14 @@ check_state (guestfs_h *g, const char *caller) pr " guestfs___end_busy (g);\n"; (match ret with - | RErr -> pr " return 0;\n" + | RErr -> + pr " ret_v = 0;\n" | RInt n | RInt64 n | RBool n -> - pr " return ret.%s;\n" n + pr " ret_v = ret.%s;\n" n | RConstString _ | RConstOptString _ -> failwithf "RConstString|RConstOptString cannot be used by daemon functions" | RString n -> - pr " return ret.%s; /* caller will free */\n" n + pr " ret_v = ret.%s; /* caller will free */\n" n | RStringList n | RHashtable n -> pr " /* caller will free this, but we need to add a NULL entry */\n"; pr " ret.%s.%s_val =\n" n n; @@ -879,13 +1315,13 @@ check_state (guestfs_h *g, const char *caller) pr " sizeof (char *) * (ret.%s.%s_len + 1));\n" n n; pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n; - pr " return ret.%s.%s_val;\n" n n + pr " ret_v = ret.%s.%s_val;\n" n n | RStruct (n, _) -> pr " /* caller will free this */\n"; - pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n + pr " ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n | RStructList (n, _) -> pr " /* caller will free this */\n"; - pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n + pr " ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n | RBufferOut n -> pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n"; pr " * _val might be NULL here. To make the API saner for\n"; @@ -894,15 +1330,16 @@ check_state (guestfs_h *g, const char *caller) pr " */\n"; pr " if (ret.%s.%s_len > 0) {\n" n n; pr " *size_r = ret.%s.%s_len;\n" n n; - pr " return ret.%s.%s_val; /* caller will free */\n" n n; + pr " ret_v = ret.%s.%s_val; /* caller will free */\n" n n; pr " } else {\n"; pr " free (ret.%s.%s_val);\n" n n; pr " char *p = safe_malloc (g, 1);\n"; pr " *size_r = ret.%s.%s_len;\n" n n; - pr " return p;\n"; + pr " ret_v = p;\n"; pr " }\n"; ); - + trace_return shortname style "ret_v"; + pr " return ret_v;\n"; pr "}\n\n" ) daemon_functions; @@ -941,20 +1378,23 @@ check_state (guestfs_h *g, const char *caller) (* Get the name of the last regular argument. *) let last_arg = - match args with - | [] -> "g" - | args -> name_of_argt (List.hd (List.rev args)) in + match ret with + | RBufferOut _ -> "size_r" + | _ -> + match args with + | [] -> "g" + | args -> name_of_argt (List.hd (List.rev args)) in - let rerrcode, rtype = + let rtype = match ret with - | RErr | RInt _ | RBool _ -> "-1", "int " - | RInt64 _ -> "-1", "int64_t " - | RConstString _ | RConstOptString _ -> "NULL", "const char *" - | RString _ | RBufferOut _ -> "NULL", "char *" - | RStringList _ | RHashtable _ -> "NULL", "char **" - | RStruct (_, typ) -> "NULL", sprintf "struct guestfs_%s *" typ + | RErr | RInt _ | RBool _ -> "int " + | RInt64 _ -> "int64_t " + | RConstString _ | RConstOptString _ -> "const char *" + | RString _ | RBufferOut _ -> "char *" + | RStringList _ | RHashtable _ -> "char **" + | RStruct (_, typ) -> sprintf "struct guestfs_%s *" typ | RStructList (_, typ) -> - "NULL", sprintf "struct guestfs_%s_list *" typ in + sprintf "struct guestfs_%s_list *" typ in (* The regular variable args function, just calls the _va variant. *) generate_prototype ~extern:false ~semicolon:false ~newline:true @@ -964,7 +1404,7 @@ check_state (guestfs_h *g, const char *caller) pr "\n"; pr " va_start (optargs, %s);\n" last_arg; pr " %sr = guestfs_%s_va " rtype shortname; - generate_c_call_args ~handle:"g" style; + generate_c_call_args ~handle:"g" ~implicit_size_ptr:"size_r" style; pr ";\n"; pr " va_end (optargs);\n"; pr "\n"; @@ -986,37 +1426,41 @@ check_state (guestfs_h *g, const char *caller) List.iter ( fun argt -> - let n = name_of_argt argt in + let n = name_of_optargt argt in let uc_n = String.uppercase n in pr " case GUESTFS_%s_%s:\n" uc_shortname uc_n; pr " optargs_s.%s = va_arg (args, " n; (match argt with - | Bool _ | Int _ -> pr "int" - | Int64 _ -> pr "int64_t" - | String _ -> pr "const char *" - | _ -> assert false + | OBool _ | OInt _ -> pr "int" + | OInt64 _ -> pr "int64_t" + | OString _ -> pr "const char *" ); pr ");\n"; pr " break;\n"; ) optargs; + let errcode = + match errcode_of_ret ret with + | `CannotReturnError -> assert false + | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in + pr " default:\n"; 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"; pr " \"%s\", i);\n" shortname; - pr " return %s;\n" rerrcode; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr "\n"; pr " uint64_t i_mask = UINT64_C(1) << i;\n"; pr " if (optargs_s.bitmask & i_mask) {\n"; pr " error (g, \"%%s: same optional argument specified more than once\",\n"; pr " \"%s\");\n" shortname; - pr " return %s;\n" rerrcode; + pr " return %s;\n" (string_of_errcode errcode); pr " }\n"; pr " optargs_s.bitmask |= i_mask;\n"; pr " }\n"; pr "\n"; pr " return guestfs_%s_argv " shortname; - generate_c_call_args ~handle:"g" style; + generate_c_call_args ~handle:"g" ~implicit_size_ptr:"size_r" style; pr ";\n"; pr "}\n\n" | _ -> () @@ -1032,19 +1476,24 @@ and generate_linker_script () = let globals = [ "guestfs_create"; "guestfs_close"; + "guestfs_delete_event_callback"; + "guestfs_first_private"; "guestfs_get_error_handler"; "guestfs_get_out_of_memory_handler"; "guestfs_get_private"; "guestfs_last_errno"; "guestfs_last_error"; + "guestfs_next_private"; "guestfs_set_close_callback"; "guestfs_set_error_handler"; + "guestfs_set_event_callback"; "guestfs_set_launch_done_callback"; "guestfs_set_log_message_callback"; "guestfs_set_out_of_memory_handler"; "guestfs_set_private"; "guestfs_set_progress_callback"; "guestfs_set_subprocess_quit_callback"; + "guestfs_user_cancel"; (* Unofficial parts of the API: the bindings code use these * functions, so it is useful to export them. @@ -1054,6 +1503,7 @@ and generate_linker_script () = "guestfs_safe_strdup"; "guestfs_safe_memdup"; "guestfs_tmpdir"; + "guestfs___for_each_disk"; ] in let functions = List.flatten (