daemon: debug segv correct use of dereferencing NULL.
[libguestfs.git] / generator / generator_daemon.ml
index f15ae61..9f15abd 100644 (file)
@@ -42,7 +42,7 @@ let generate_daemon_actions_h () =
         iteri (
           fun i arg ->
             let uc_shortname = String.uppercase shortname in
-            let n = name_of_argt arg in
+            let n = name_of_optargt arg in
             let uc_n = String.uppercase n in
             pr "#define GUESTFS_%s_%s_BITMASK (UINT64_C(1)<<%d)\n"
               uc_shortname uc_n i
@@ -52,7 +52,7 @@ let generate_daemon_actions_h () =
 
   List.iter (
     fun (name, (ret, args, optargs), _, _, _, _, _) ->
-      let style = ret, args @ optargs, [] in
+      let style = ret, args @ args_of_optargs optargs, [] in
       generate_prototype
         ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
         name style;
@@ -82,21 +82,20 @@ and generate_daemon_actions () =
       (* Generate server-side stubs. *)
       pr "static void %s_stub (XDR *xdr_in)\n" name;
       pr "{\n";
-      let error_code =
-        match ret with
-        | RErr | RInt _ -> pr "  int r;\n"; "-1"
-        | RInt64 _ -> pr "  int64_t r;\n"; "-1"
-        | RBool _ -> pr "  int r;\n"; "-1"
-        | RConstString _ | RConstOptString _ ->
-            failwithf "RConstString|RConstOptString cannot be used by daemon functions"
-        | RString _ -> pr "  char *r;\n"; "NULL"
-        | RStringList _ | RHashtable _ -> pr "  char **r;\n"; "NULL"
-        | RStruct (_, typ) -> pr "  guestfs_int_%s *r;\n" typ; "NULL"
-        | RStructList (_, typ) -> pr "  guestfs_int_%s_list *r;\n" typ; "NULL"
-        | RBufferOut _ ->
-            pr "  size_t size = 1;\n";
-            pr "  char *r;\n";
-            "NULL" in
+      (match ret with
+       | RErr | RInt _ -> pr "  int r;\n"
+       | RInt64 _ -> pr "  int64_t r;\n"
+       | RBool _ -> pr "  int r;\n"
+       | RConstString _ | RConstOptString _ ->
+           failwithf "RConstString|RConstOptString cannot be used by daemon functions"
+       | RString _ -> pr "  char *r;\n"
+       | RStringList _ | RHashtable _ -> pr "  char **r;\n"
+       | RStruct (_, typ) -> pr "  guestfs_int_%s *r;\n" typ
+       | RStructList (_, typ) -> pr "  guestfs_int_%s_list *r;\n" typ
+       | RBufferOut _ ->
+           pr "  size_t size = 1;\n";
+           pr "  char *r;\n"
+      );
 
       if args <> [] || optargs <> [] then (
         pr "  struct guestfs_%s_args args;\n" name;
@@ -116,25 +115,36 @@ and generate_daemon_actions () =
               pr "  const char *%s;\n" n;
               pr "  size_t %s_size;\n" n
           | Pointer _ -> assert false
-        ) (args @ optargs)
+        ) (args @ args_of_optargs optargs)
       );
       pr "\n";
 
       let is_filein =
         List.exists (function FileIn _ -> true | _ -> false) args in
 
-      (* Reject unknown optional arguments. *)
+      (* Reject unknown optional arguments.
+       * Note this code is included even for calls with no optional
+       * args because the caller must not pass optargs_bitmask != 0
+       * in that case.
+       *)
       if optargs <> [] then (
         let len = List.length optargs in
         let mask = Int64.lognot (Int64.pred (Int64.shift_left 1L len)) in
         pr "  if (optargs_bitmask & UINT64_C(0x%Lx)) {\n" mask;
         if is_filein then
-          pr "    if (cancel_receive () != -2)\n";
+          pr "    cancel_receive ();\n";
         pr "    reply_with_error (\"unknown option in optional arguments bitmask (this can happen if a program is compiled against a newer version of libguestfs, then run against an older version of the daemon)\");\n";
         pr "    goto done;\n";
         pr "  }\n";
-        pr "\n"
+      ) else (
+        pr "  if (optargs_bitmask != 0) {\n";
+        if is_filein then
+          pr "    cancel_receive ();\n";
+        pr "    reply_with_error (\"header optargs_bitmask field must be passed as 0 for calls that don't take optional arguments\");\n";
+        pr "    goto done;\n";
+        pr "  }\n";
       );
+      pr "\n";
 
       (* Decode arguments. *)
       if args <> [] || optargs <> [] then (
@@ -142,8 +152,8 @@ and generate_daemon_actions () =
         pr "\n";
         pr "  if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
         if is_filein then
-          pr "    if (cancel_receive () != -2)\n";
-        pr "      reply_with_error (\"daemon failed to decode procedure arguments\");\n";
+          pr "    cancel_receive ();\n";
+        pr "    reply_with_error (\"daemon failed to decode procedure arguments\");\n";
         pr "    goto done;\n";
         pr "  }\n";
         let pr_args n =
@@ -154,8 +164,8 @@ and generate_daemon_actions () =
           pr "                sizeof (char *) * (args.%s.%s_len+1));\n" n n;
           pr "  if (%s == NULL) {\n" n;
           if is_filein then
-            pr "    if (cancel_receive () != -2)\n";
-          pr "      reply_with_perror (\"realloc\");\n";
+            pr "    cancel_receive ();\n";
+          pr "    reply_with_perror (\"realloc\");\n";
           pr "    goto done;\n";
           pr "  }\n";
           pr "  %s[args.%s.%s_len] = NULL;\n" n n n;
@@ -166,15 +176,15 @@ and generate_daemon_actions () =
           | Pathname n ->
               pr_args n;
               pr "  ABS_PATH (%s, %s, goto done);\n"
-                n (if is_filein then "cancel_receive ()" else "0");
+                n (if is_filein then "cancel_receive ()" else "");
           | Device n ->
               pr_args n;
               pr "  RESOLVE_DEVICE (%s, %s, goto done);\n"
-                n (if is_filein then "cancel_receive ()" else "0");
+                n (if is_filein then "cancel_receive ()" else "");
           | Dev_or_Path n ->
               pr_args n;
               pr "  REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
-                n (if is_filein then "cancel_receive ()" else "0");
+                n (if is_filein then "cancel_receive ()" else "");
           | String n | Key n -> pr_args n
           | OptString n -> pr "  %s = args.%s ? *args.%s : NULL;\n" n n n
           | StringList n ->
@@ -188,7 +198,7 @@ and generate_daemon_actions () =
               pr "    size_t i;\n";
               pr "    for (i = 0; %s[i] != NULL; ++i)\n" n;
               pr "      RESOLVE_DEVICE (%s[i], %s, goto done);\n" n
-                (if is_filein then "cancel_receive ()" else "0");
+                (if is_filein then "cancel_receive ()" else "");
               pr "  }\n";
           | Bool n -> pr "  %s = args.%s;\n" n n
           | Int n -> pr "  %s = args.%s;\n" n n
@@ -198,7 +208,7 @@ and generate_daemon_actions () =
               pr "  %s = args.%s.%s_val;\n" n n n;
               pr "  %s_size = args.%s.%s_len;\n" n n n
           | Pointer _ -> assert false
-        ) (args @ optargs);
+        ) (args @ args_of_optargs optargs);
         pr "\n"
       );
 
@@ -207,7 +217,7 @@ and generate_daemon_actions () =
         (* Emit NEED_ROOT just once, even when there are two or
            more Pathname args *)
         pr "  NEED_ROOT (%s, goto done);\n"
-          (if is_filein then "cancel_receive ()" else "0");
+          (if is_filein then "cancel_receive ()" else "");
       );
 
       (* Don't want to call the impl with any FileIn or FileOut
@@ -217,17 +227,22 @@ and generate_daemon_actions () =
         let args' =
           List.filter
             (function FileIn _ | FileOut _ -> false | _ -> true) args in
-        let style = ret, args' @ optargs, [] in
+        let style = ret, args' @ args_of_optargs optargs, [] in
         pr "  r = do_%s " name;
         generate_c_call_args style;
         pr ";\n" in
 
       (match ret with
+       | RConstOptString _ -> assert false
        | RErr | RInt _ | RInt64 _ | RBool _
-       | RConstString _ | RConstOptString _
+       | RConstString _
        | RString _ | RStringList _ | RHashtable _
        | RStruct (_, _) | RStructList (_, _) ->
-           pr "  if (r == %s)\n" error_code;
+           let errcode =
+             match errcode_of_ret ret with
+             | `CannotReturnError -> assert false
+             | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
+           pr "  if (r == %s)\n" (string_of_errcode errcode);
            pr "    /* do_%s has already called reply_with_error */\n" name;
            pr "    goto done;\n";
            pr "\n"
@@ -235,7 +250,7 @@ and generate_daemon_actions () =
            pr "  /* size == 0 && r == NULL could be a non-error case (just\n";
            pr "   * an ordinary zero-length buffer), so be careful ...\n";
            pr "   */\n";
-           pr "  if (size == 1 && r == %s)\n" error_code;
+           pr "  if (size == 1 && r == NULL)\n";
            pr "    /* do_%s has already called reply_with_error */\n" name;
            pr "    goto done;\n";
            pr "\n"
@@ -274,6 +289,7 @@ and generate_daemon_actions () =
         | RStruct (n, _) ->
             pr "  struct guestfs_%s_ret ret;\n" name;
             pr "  ret.%s = *r;\n" n;
+            pr "  free (r);\n";
             pr "  reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
               name;
             pr "  xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
@@ -281,6 +297,7 @@ and generate_daemon_actions () =
         | RStructList (n, _) ->
             pr "  struct guestfs_%s_ret ret;\n" name;
             pr "  ret.%s = *r;\n" n;
+            pr "  free (r);\n";
             pr "  reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
               name;
             pr "  xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"