generator: trace mode prints return values.
[libguestfs.git] / generator / generator_c.ml
index 7ebd846..9d3efe9 100644 (file)
@@ -360,14 +360,13 @@ and generate_guestfs_h () =
 extern \"C\" {
 #endif
 
+#include <stddef.h>
 #include <stdint.h>
 #include <stdarg.h>
-#include <rpc/types.h>
-#include <rpc/xdr.h>
 
 /* The handle. */
-#ifndef GUESTFS_TYPEDEF_GUESTFS_H
-#define GUESTFS_TYPEDEF_GUESTFS_H 1
+#ifndef GUESTFS_TYPEDEF_H
+#define GUESTFS_TYPEDEF_H 1
 typedef struct guestfs_h guestfs_h;
 #endif
 
@@ -380,13 +379,13 @@ 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_GUESTFS_ERROR_HANDLER_CB
-#define GUESTFS_TYPEDEF_GUESTFS_ERROR_HANDLER_CB 1
+#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_GUESTFS_ABORT_CB
-#define GUESTFS_TYPEDEF_GUESTFS_ABORT_CB 1
+#ifndef GUESTFS_TYPEDEF_ABORT_CB
+#define GUESTFS_TYPEDEF_ABORT_CB 1
 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
 #endif
 
@@ -397,28 +396,28 @@ 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. */
-#ifndef GUESTFS_TYPEDEF_GUESTFS_LOG_MESSAGE_CB
-#define GUESTFS_TYPEDEF_GUESTFS_LOG_MESSAGE_CB 1
+#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_GUESTFS_SUBPROCESS_QUIT_CB
-#define GUESTFS_TYPEDEF_GUESTFS_SUBPROCESS_QUIT_CB 1
+#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_GUESTFS_LAUNCH_DONE_CB
-#define GUESTFS_TYPEDEF_GUESTFS_LAUNCH_DONE_CB 1
+#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_GUESTFS_CLOSE_CB
-#define GUESTFS_TYPEDEF_GUESTFS_CLOSE_CB 1
+#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_GUESTFS_PROGRESS_CB
-#define GUESTFS_TYPEDEF_GUESTFS_PROGRESS_CB 1
+#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
 
@@ -713,7 +712,7 @@ check_state (guestfs_h *g, const char *caller)
 
   (* 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
@@ -786,14 +785,82 @@ check_state (guestfs_h *g, const char *caller)
         );
     ) optargs;
 
-    pr "    fputc ('\\n', stderr);\n";
     pr "  }\n";
     pr "\n";
   in
 
+  let trace_return ?(indent = 2) (ret, _, _) rv =
+    let indent = spaces indent in
+
+    pr "%sif (trace_flag) {\n" indent;
+
+    let needs_i =
+      match ret with
+      | RStringList _ | RHashtable _ | RStructList _ -> true
+      | _ -> false in
+    if needs_i then (
+      pr "%s  size_t i;\n" indent;
+      pr "\n"
+    );
+
+    pr "%s  fputs (\" = \", stderr);\n" indent;
+    (match ret with
+     | RErr | RInt _ | RBool _ ->
+         pr "%s  fprintf (stderr, \"%%d\", %s);\n" indent rv
+     | RInt64 _ ->
+         pr "%s  fprintf (stderr, \"%%\" PRIi64, %s);\n" indent rv
+     | RConstString _ | RString _ ->
+         pr "%s  fprintf (stderr, \"\\\"%%s\\\"\", %s);\n" indent rv
+     | RConstOptString _ ->
+         pr "%s  fprintf (stderr, \"\\\"%%s\\\"\", %s != NULL ? %s : \"NULL\");\n"
+           indent rv rv
+     | RBufferOut _ ->
+         pr "%s  guestfs___print_BufferOut (stderr, %s, *size_r);\n" indent rv
+     | RStringList _ | RHashtable _ ->
+         pr "%s  fputs (\"[\\\"\", stderr);\n" indent;
+         pr "%s  for (i = 0; %s[i]; ++i) {\n" indent rv;
+         pr "%s    if (i > 0) fputs (\"\\\", \\\"\", stderr);\n" indent;
+         pr "%s    fputs (%s[i], stderr);\n" indent rv;
+         pr "%s  }\n" indent;
+         pr "%s  fputs (\"\\\"]\", stderr);\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 (stderr, \"<struct guestfs_%s *>\");\n"
+           indent typ (* XXX *)
+     | RStructList (_, typ) ->
+         pr "%s  fprintf (stderr, \"<struct guestfs_%s_list *>\");\n"
+           indent typ (* XXX *)
+    );
+    pr "%s  fputc ('\\n', stderr);\n" indent;
+    pr "%s}\n" indent;
+    pr "\n";
+  in
+
+  let trace_return_error ?(indent = 2) (ret, _, _) =
+    let indent = spaces indent in
+
+    pr "%sif (trace_flag)\n" indent;
+
+    (match ret with
+     | RErr | RInt _ | RBool _
+     | RInt64 _ ->
+         pr "%s  fputs (\" = -1 (error)\\n\", stderr);\n" indent
+     | RConstString _ | RString _
+     | RConstOptString _
+     | RBufferOut _
+     | RStringList _ | RHashtable _
+     | RStruct _
+     | RStructList _ ->
+         pr "%s  fputs (\" = NULL (error)\\n\", stderr);\n" indent
+    );
+  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_"
@@ -803,12 +870,32 @@ 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";
+      (match ret with
+       | RErr | RInt _ | RBool _ ->
+           pr "  int r;\n"
+       | RInt64 _ ->
+           pr "  int64_t r;\n"
+       | RConstString _ | 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";
       check_null_strings shortname style;
       reject_unknown_optargs shortname style;
       trace_call shortname style;
-      pr "  return guestfs__%s " shortname;
+      pr "  r = guestfs__%s " shortname;
       generate_c_call_args ~handle:"g" style;
       pr ";\n";
+      trace_return style "r";
+      pr "  return r;\n";
       pr "}\n";
       pr "\n"
   ) non_daemon_functions;
@@ -853,12 +940,31 @@ check_state (guestfs_h *g, const char *caller)
 
       pr "  int serial;\n";
       pr "  int r;\n";
+      pr "  int trace_flag = g->trace;\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
+      );
       pr "\n";
       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;
+      pr "  if (check_state (g, \"%s\") == -1) {\n" shortname;
+      trace_return_error ~indent:4 style;
+      pr "    return %s;\n" error_code;
+      pr "  }\n";
       pr "  guestfs___set_busy (g);\n";
       pr "\n";
 
@@ -887,6 +993,7 @@ check_state (guestfs_h *g, const char *caller)
              | 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 style;
                  pr "    error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
                    shortname;
                  pr "    guestfs___end_busy (g);\n";
@@ -903,6 +1010,7 @@ check_state (guestfs_h *g, const char *caller)
       );
       pr "  if (serial == -1) {\n";
       pr "    guestfs___end_busy (g);\n";
+      trace_return_error ~indent:4 style;
       pr "    return %s;\n" error_code;
       pr "  }\n";
       pr "\n";
@@ -915,6 +1023,7 @@ 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";
+            trace_return_error ~indent:4 style;
             pr "    return %s;\n" error_code;
             pr "  }\n";
             pr "  if (r == -2) /* daemon cancelled */\n";
@@ -939,6 +1048,7 @@ check_state (guestfs_h *g, const char *caller)
 
       pr "  if (r == -1) {\n";
       pr "    guestfs___end_busy (g);\n";
+      trace_return_error ~indent:4 style;
       pr "    return %s;\n" error_code;
       pr "  }\n";
       pr "\n";
@@ -946,11 +1056,13 @@ check_state (guestfs_h *g, const char *caller)
       pr "  if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
         (String.uppercase shortname);
       pr "    guestfs___end_busy (g);\n";
+      trace_return_error ~indent:4 style;
       pr "    return %s;\n" error_code;
       pr "  }\n";
       pr "\n";
 
       pr "  if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
+      trace_return_error ~indent:4 style;
       pr "    int errnum = 0;\n";
       pr "    if (err.errno_string[0] != '\\0')\n";
       pr "      errnum = guestfs___string_to_errno (err.errno_string);\n";
@@ -974,6 +1086,7 @@ 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";
+            trace_return_error ~indent:4 style;
             pr "    return %s;\n" error_code;
             pr "  }\n";
             pr "\n";
@@ -983,13 +1096,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;
@@ -997,13 +1111,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";
@@ -1012,15 +1126,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 style "ret_v";
+      pr "  return ret_v;\n";
       pr "}\n\n"
   ) daemon_functions;