generator/generator_c.ml

   1 (* libguestfs
   2  * Copyright (C) 2009-2011 Red Hat Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  *)
  18
  19 (* Please read generator/README first. *)
  20
  21 open Printf
  22
  23 open Generator_types
  24 open Generator_utils
  25 open Generator_pr
  26 open Generator_docstrings
  27 open Generator_api_versions
  28 open Generator_optgroups
  29 open Generator_actions
  30 open Generator_structs
  31 open Generator_events
  32
  33 (* Generate C API. *)
  34
  35 type optarg_proto = Dots | VA | Argv
  36
  37 (* Generate a C function prototype. *)
  38 let rec generate_prototype ?(extern = true) ?(static = false)
  39     ?(semicolon = true)
  40     ?(single_line = false) ?(indent = "") ?(newline = false)
  41     ?(in_daemon = false)
  42     ?(prefix = "") ?(suffix = "")
  43     ?handle
  44     ?(optarg_proto = Dots)
  45     name (ret, args, optargs) =
  46   pr "%s" indent;
  47   if extern then pr "extern ";
  48   if static then pr "static ";
  49   (match ret with
  50    | RErr
  51    | RInt _
  52    | RBool _ ->
  53        pr "int";
  54        if single_line then pr " " else pr "\n%s" indent
  55    | RInt64 _ ->
  56        pr "int64_t";
  57        if single_line then pr " " else pr "\n%s" indent
  58    | RConstString _ | RConstOptString _ ->
  59        pr "const char *";
  60        if not single_line then pr "\n%s" indent
  61    | RString _ | RBufferOut _ ->
  62        pr "char *";
  63        if not single_line then pr "\n%s" indent
  64    | RStringList _ | RHashtable _ ->
  65        pr "char **";
  66        if not single_line then pr "\n%s" indent
  67    | RStruct (_, typ) ->
  68        if not in_daemon then pr "struct guestfs_%s *" typ
  69        else pr "guestfs_int_%s *" typ;
  70        if not single_line then pr "\n%s" indent
  71    | RStructList (_, typ) ->
  72        if not in_daemon then pr "struct guestfs_%s_list *" typ
  73        else pr "guestfs_int_%s_list *" typ;
  74        if not single_line then pr "\n%s" indent
  75   );
  76   let is_RBufferOut = match ret with RBufferOut _ -> true | _ -> false in
  77   pr "%s%s%s (" prefix name suffix;
  78   if handle = None && args = [] && optargs = [] && not is_RBufferOut then
  79       pr "void"
  80   else (
  81     let comma = ref false in
  82     (match handle with
  83      | None -> ()
  84      | Some handle -> pr "guestfs_h *%s" handle; comma := true
  85     );
  86     let next () =
  87       if !comma then (
  88         if single_line then pr ", "
  89         else (
  90           let namelen = String.length prefix + String.length name +
  91                         String.length suffix + 2 in
  92           pr ",\n%s%s" indent (spaces namelen)
  93         )
  94       );
  95       comma := true
  96     in
  97     List.iter (
  98       function
  99       | Pathname n
 100       | Device n | Dev_or_Path n
 101       | String n
 102       | OptString n
 103       | Key n ->
 104           next ();
 105           pr "const char *%s" n
 106       | StringList n | DeviceList n ->
 107           next ();
 108           pr "char *const *%s" n
 109       | Bool n -> next (); pr "int %s" n
 110       | Int n -> next (); pr "int %s" n
 111       | Int64 n -> next (); pr "int64_t %s" n
 112       | FileIn n
 113       | FileOut n ->
 114           if not in_daemon then (next (); pr "const char *%s" n)
 115       | BufferIn n ->
 116           next ();
 117           pr "const char *%s" n;
 118           next ();
 119           pr "size_t %s_size" n
 120       | Pointer (t, n) ->
 121           next ();
 122           pr "%s %s" t n
 123     ) args;
 124     if is_RBufferOut then (next (); pr "size_t *size_r");
 125     if optargs <> [] then (
 126       next ();
 127       match optarg_proto with
 128       | Dots -> pr "..."
 129       | VA -> pr "va_list args"
 130       | Argv -> pr "const struct guestfs_%s_argv *optargs" name
 131     );
 132   );
 133   pr ")";
 134   if semicolon then pr ";";
 135   if newline then pr "\n"
 136
 137 (* Generate C call arguments, eg "(handle, foo, bar)" *)
 138 and generate_c_call_args ?handle ?(implicit_size_ptr = "&size")
 139     (ret, args, optargs) =
 140   pr "(";
 141   let comma = ref false in
 142   let next () =
 143     if !comma then pr ", ";
 144     comma := true
 145   in
 146   (match handle with
 147    | None -> ()
 148    | Some handle -> pr "%s" handle; comma := true
 149   );
 150   List.iter (
 151     function
 152     | BufferIn n ->
 153         next ();
 154         pr "%s, %s_size" n n
 155     | arg ->
 156         next ();
 157         pr "%s" (name_of_argt arg)
 158   ) args;
 159   (* For RBufferOut calls, add implicit size pointer parameter. *)
 160   (match ret with
 161    | RBufferOut _ ->
 162        next ();
 163        pr "%s" implicit_size_ptr
 164    | _ -> ()
 165   );
 166   (* For calls with optional arguments, add implicit optargs parameter. *)
 167   if optargs <> [] then (
 168     next ();
 169     pr "optargs"
 170   );
 171   pr ")"
 172
 173 (* Generate the pod documentation for the C API. *)
 174 and generate_actions_pod () =
 175   List.iter (
 176     fun (shortname, (ret, args, optargs as style), _, flags, _, _, longdesc) ->
 177       if not (List.mem NotInDocs flags) then (
 178         let name = "guestfs_" ^ shortname in
 179         pr "=head2 %s\n\n" name;
 180         generate_prototype ~extern:false ~indent:" " ~handle:"g" name style;
 181         pr "\n\n";
 182
 183         let uc_shortname = String.uppercase shortname in
 184         if optargs <> [] then (
 185           pr "You may supply a list of optional arguments to this call.\n";
 186           pr "Use zero or more of the following pairs of parameters,\n";
 187           pr "and terminate the list with C<-1> on its own.\n";
 188           pr "See L</CALLS WITH OPTIONAL ARGUMENTS>.\n\n";
 189           List.iter (
 190             fun argt ->
 191               let n = name_of_argt argt in
 192               let uc_n = String.uppercase n in
 193               pr " GUESTFS_%s_%s, " uc_shortname uc_n;
 194               match argt with
 195               | Bool n -> pr "int %s,\n" n
 196               | Int n -> pr "int %s,\n" n
 197               | Int64 n -> pr "int64_t %s,\n" n
 198               | String n -> pr "const char *%s,\n" n
 199               | _ -> assert false
 200           ) optargs;
 201           pr "\n";
 202         );
 203
 204         pr "%s\n\n" longdesc;
 205         let ret, args, optargs = style in
 206         (match ret with
 207          | RErr ->
 208              pr "This function returns 0 on success or -1 on error.\n\n"
 209          | RInt _ ->
 210              pr "On error this function returns -1.\n\n"
 211          | RInt64 _ ->
 212              pr "On error this function returns -1.\n\n"
 213          | RBool _ ->
 214              pr "This function returns a C truth value on success or -1 on error.\n\n"
 215          | RConstString _ ->
 216              pr "This function returns a string, or NULL on error.
 217 The string is owned by the guest handle and must I<not> be freed.\n\n"
 218          | RConstOptString _ ->
 219              pr "This function returns a string which may be NULL.
 220 There is no way to return an error from this function.
 221 The string is owned by the guest handle and must I<not> be freed.\n\n"
 222          | RString _ ->
 223              pr "This function returns a string, or NULL on error.
 224 I<The caller must free the returned string after use>.\n\n"
 225          | RStringList _ ->
 226              pr "This function returns a NULL-terminated array of strings
 227 (like L<environ(3)>), or NULL if there was an error.
 228 I<The caller must free the strings and the array after use>.\n\n"
 229          | RStruct (_, typ) ->
 230              pr "This function returns a C<struct guestfs_%s *>,
 231 or NULL if there was an error.
 232 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
 233          | RStructList (_, typ) ->
 234              pr "This function returns a C<struct guestfs_%s_list *>,
 235 or NULL if there was an error.
 236 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
 237          | RHashtable _ ->
 238              pr "This function returns a NULL-terminated array of
 239 strings, or NULL if there was an error.
 240 The array of strings will always have length C<2n+1>, where
 241 C<n> keys and values alternate, followed by the trailing NULL entry.
 242 I<The caller must free the strings and the array after use>.\n\n"
 243          | RBufferOut _ ->
 244              pr "This function returns a buffer, or NULL on error.
 245 The size of the returned buffer is written to C<*size_r>.
 246 I<The caller must free the returned buffer after use>.\n\n"
 247         );
 248         if List.mem Progress flags then
 249           pr "%s\n\n" progress_message;
 250         if List.mem ProtocolLimitWarning flags then
 251           pr "%s\n\n" protocol_limit_warning;
 252         if List.mem DangerWillRobinson flags then
 253           pr "%s\n\n" danger_will_robinson;
 254         if List.exists (function Key _ -> true | _ -> false) (args@optargs) then
 255           pr "This function takes a key or passphrase parameter which
 256 could contain sensitive material.  Read the section
 257 L</KEYS AND PASSPHRASES> for more information.\n\n";
 258         (match deprecation_notice flags with
 259          | None -> ()
 260          | Some txt -> pr "%s\n\n" txt
 261         );
 262         (match lookup_api_version name with
 263          | Some version -> pr "(Added in %s)\n\n" version
 264          | None -> ()
 265         );
 266
 267         (* Handling of optional argument variants. *)
 268         if optargs <> [] then (
 269           pr "=head2 %s_va\n\n" name;
 270           generate_prototype ~extern:false ~indent:" " ~handle:"g"
 271             ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
 272             shortname style;
 273           pr "\n\n";
 274           pr "This is the \"va_list variant\" of L</%s>.\n\n" name;
 275           pr "See L</CALLS WITH OPTIONAL ARGUMENTS>.\n\n";
 276           pr "=head2 %s_argv\n\n" name;
 277           generate_prototype ~extern:false ~indent:" " ~handle:"g"
 278             ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
 279             shortname style;
 280           pr "\n\n";
 281           pr "This is the \"argv variant\" of L</%s>.\n\n" name;
 282           pr "See L</CALLS WITH OPTIONAL ARGUMENTS>.\n\n";
 283         );
 284       )
 285   ) all_functions_sorted
 286
 287 and generate_structs_pod () =
 288   (* Structs documentation. *)
 289   List.iter (
 290     fun (typ, cols) ->
 291       pr "=head2 guestfs_%s\n" typ;
 292       pr "\n";
 293       pr " struct guestfs_%s {\n" typ;
 294       List.iter (
 295         function
 296         | name, FChar -> pr "   char %s;\n" name
 297         | name, FUInt32 -> pr "   uint32_t %s;\n" name
 298         | name, FInt32 -> pr "   int32_t %s;\n" name
 299         | name, (FUInt64|FBytes) -> pr "   uint64_t %s;\n" name
 300         | name, FInt64 -> pr "   int64_t %s;\n" name
 301         | name, FString -> pr "   char *%s;\n" name
 302         | name, FBuffer ->
 303             pr "   /* The next two fields describe a byte array. */\n";
 304             pr "   uint32_t %s_len;\n" name;
 305             pr "   char *%s;\n" name
 306         | name, FUUID ->
 307             pr "   /* The next field is NOT nul-terminated, be careful when printing it: */\n";
 308             pr "   char %s[32];\n" name
 309         | name, FOptPercent ->
 310             pr "   /* The next field is [0..100] or -1 meaning 'not present': */\n";
 311             pr "   float %s;\n" name
 312       ) cols;
 313       pr " };\n";
 314       pr " \n";
 315       pr " struct guestfs_%s_list {\n" typ;
 316       pr "   uint32_t len; /* Number of elements in list. */\n";
 317       pr "   struct guestfs_%s *val; /* Elements. */\n" typ;
 318       pr " };\n";
 319       pr " \n";
 320       pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
 321       pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
 322         typ typ;
 323       pr "\n"
 324   ) structs
 325
 326 and generate_availability_pod () =
 327   (* Availability documentation. *)
 328   pr "=over 4\n";
 329   pr "\n";
 330   List.iter (
 331     fun (group, functions) ->
 332       pr "=item B<%s>\n" group;
 333       pr "\n";
 334       pr "The following functions:\n";
 335       List.iter (pr "L</guestfs_%s>\n") functions;
 336       pr "\n"
 337   ) optgroups;
 338   pr "=back\n";
 339   pr "\n"
 340
 341 (* Generate the guestfs.h file. *)
 342 and generate_guestfs_h () =
 343   generate_header CStyle LGPLv2plus;
 344
 345   pr "\
 346 /* ---------- IMPORTANT NOTE ----------
 347  *
 348  * All API documentation is in the manpage, 'guestfs(3)'.
 349  * To read it, type:           man 3 guestfs
 350  * Or read it online here:     http://libguestfs.org/guestfs.3.html
 351  *
 352  * Go and read it now, I'll be right here waiting for you
 353  * when you come back.
 354  *
 355  * ------------------------------------
 356  */
 357
 358 #ifndef GUESTFS_H_
 359 #define GUESTFS_H_
 360
 361 #ifdef __cplusplus
 362 extern \"C\" {
 363 #endif
 364
 365 #include <stddef.h>
 366 #include <stdint.h>
 367 #include <stdarg.h>
 368
 369 #ifdef __GNUC__
 370 # define GUESTFS_GCC_VERSION \\
 371     (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
 372 #endif
 373
 374 /* Define GUESTFS_WARN_DEPRECATED=1 to warn about deprecated API functions. */
 375 #define GUESTFS_DEPRECATED_BY(s)
 376 #if GUESTFS_WARN_DEPRECATED
 377 #  if defined(__GNUC__) && GUESTFS_GCC_VERSION >= 40500 /* gcc >= 4.5 */
 378 #    undef GUESTFS_DEPRECATED_BY
 379 #    define GUESTFS_DEPRECATED_BY(s) __attribute__((__deprecated__(\"change the program to use guestfs_\" s \" instead of this deprecated function\")))
 380 #  endif
 381 #endif /* GUESTFS_WARN_DEPRECATED */
 382
 383 /* The handle. */
 384 #ifndef GUESTFS_TYPEDEF_H
 385 #define GUESTFS_TYPEDEF_H 1
 386 typedef struct guestfs_h guestfs_h;
 387 #endif
 388
 389 /* Connection management. */
 390 extern guestfs_h *guestfs_create (void);
 391 extern void guestfs_close (guestfs_h *g);
 392
 393 /* Error handling. */
 394 extern const char *guestfs_last_error (guestfs_h *g);
 395 #define LIBGUESTFS_HAVE_LAST_ERRNO 1
 396 extern int guestfs_last_errno (guestfs_h *g);
 397
 398 #ifndef GUESTFS_TYPEDEF_ERROR_HANDLER_CB
 399 #define GUESTFS_TYPEDEF_ERROR_HANDLER_CB 1
 400 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *opaque, const char *msg);
 401 #endif
 402
 403 #ifndef GUESTFS_TYPEDEF_ABORT_CB
 404 #define GUESTFS_TYPEDEF_ABORT_CB 1
 405 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
 406 #endif
 407
 408 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *opaque);
 409 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **opaque_rtn);
 410
 411 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
 412 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
 413
 414 /* Events. */
 415 ";
 416
 417   List.iter (
 418     fun (name, bitmask) ->
 419       pr "#define GUESTFS_EVENT_%-16s 0x%04x\n"
 420         (String.uppercase name) bitmask
 421   ) events;
 422   pr "#define GUESTFS_EVENT_%-16s UINT64_MAX\n" "ALL";
 423   pr "\n";
 424
 425   pr "\
 426 #ifndef GUESTFS_TYPEDEF_EVENT_CALLBACK
 427 #define GUESTFS_TYPEDEF_EVENT_CALLBACK 1
 428 typedef void (*guestfs_event_callback) (
 429                         guestfs_h *g,
 430                         void *opaque,
 431                         uint64_t event,
 432                         int event_handle,
 433                         int flags,
 434                         const char *buf, size_t buf_len,
 435                         const uint64_t *array, size_t array_len);
 436 #endif
 437
 438 #define LIBGUESTFS_HAVE_SET_EVENT_CALLBACK 1
 439 extern int guestfs_set_event_callback (guestfs_h *g,
 440                                        guestfs_event_callback cb,
 441                                        uint64_t event_bitmask,
 442                                        int flags,
 443                                        void *opaque);
 444 #define LIBGUESTFS_HAVE_DELETE_EVENT_CALLBACK 1
 445 extern void guestfs_delete_event_callback (guestfs_h *g, int event_handle);
 446
 447 /* Old-style event handling. */
 448 #ifndef GUESTFS_TYPEDEF_LOG_MESSAGE_CB
 449 #define GUESTFS_TYPEDEF_LOG_MESSAGE_CB 1
 450 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, char *buf, int len);
 451 #endif
 452
 453 #ifndef GUESTFS_TYPEDEF_SUBPROCESS_QUIT_CB
 454 #define GUESTFS_TYPEDEF_SUBPROCESS_QUIT_CB 1
 455 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);
 456 #endif
 457
 458 #ifndef GUESTFS_TYPEDEF_LAUNCH_DONE_CB
 459 #define GUESTFS_TYPEDEF_LAUNCH_DONE_CB 1
 460 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);
 461 #endif
 462
 463 #ifndef GUESTFS_TYPEDEF_CLOSE_CB
 464 #define GUESTFS_TYPEDEF_CLOSE_CB 1
 465 typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);
 466 #endif
 467
 468 #ifndef GUESTFS_TYPEDEF_PROGRESS_CB
 469 #define GUESTFS_TYPEDEF_PROGRESS_CB 1
 470 typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque, int proc_nr, int serial, uint64_t position, uint64_t total);
 471 #endif
 472
 473 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque)
 474   GUESTFS_DEPRECATED_BY(\"set_event_callback\");
 475 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque)
 476   GUESTFS_DEPRECATED_BY(\"set_event_callback\");
 477 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque)
 478   GUESTFS_DEPRECATED_BY(\"set_event_callback\");
 479 #define LIBGUESTFS_HAVE_SET_CLOSE_CALLBACK 1
 480 extern void guestfs_set_close_callback (guestfs_h *g, guestfs_close_cb cb, void *opaque)
 481   GUESTFS_DEPRECATED_BY(\"set_event_callback\");
 482 #define LIBGUESTFS_HAVE_SET_PROGRESS_CALLBACK 1
 483 extern void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque)
 484   GUESTFS_DEPRECATED_BY(\"set_event_callback\");
 485
 486 /* User cancellation. */
 487 #define LIBGUESTFS_HAVE_USER_CANCEL 1
 488 extern void guestfs_user_cancel (guestfs_h *g);
 489
 490 /* Private data area. */
 491 #define LIBGUESTFS_HAVE_SET_PRIVATE 1
 492 extern void guestfs_set_private (guestfs_h *g, const char *key, void *data);
 493 #define LIBGUESTFS_HAVE_GET_PRIVATE 1
 494 extern void *guestfs_get_private (guestfs_h *g, const char *key);
 495 #define LIBGUESTFS_HAVE_FIRST_PRIVATE 1
 496 extern void *guestfs_first_private (guestfs_h *g, const char **key_rtn);
 497 #define LIBGUESTFS_HAVE_NEXT_PRIVATE 1
 498 extern void *guestfs_next_private (guestfs_h *g, const char **key_rtn);
 499
 500 /* Structures. */
 501 ";
 502
 503   (* The structures are carefully written to have exactly the same
 504    * in-memory format as the XDR structures that we use on the wire to
 505    * the daemon.  The reason for creating copies of these structures
 506    * here is just so we don't have to export the whole of
 507    * guestfs_protocol.h (which includes much unrelated and
 508    * XDR-dependent stuff that we don't want to be public, or required
 509    * by clients).
 510    *
 511    * To reiterate, we will pass these structures to and from the client
 512    * with a simple assignment or memcpy, so the format must be
 513    * identical to what rpcgen / the RFC defines.
 514    *)
 515
 516   (* Public structures. *)
 517   List.iter (
 518     fun (typ, cols) ->
 519       pr "struct guestfs_%s {\n" typ;
 520       List.iter (
 521         function
 522         | name, FChar -> pr "  char %s;\n" name
 523         | name, FString -> pr "  char *%s;\n" name
 524         | name, FBuffer ->
 525             pr "  uint32_t %s_len;\n" name;
 526             pr "  char *%s;\n" name
 527         | name, FUUID -> pr "  char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
 528         | name, FUInt32 -> pr "  uint32_t %s;\n" name
 529         | name, FInt32 -> pr "  int32_t %s;\n" name
 530         | name, (FUInt64|FBytes) -> pr "  uint64_t %s;\n" name
 531         | name, FInt64 -> pr "  int64_t %s;\n" name
 532         | name, FOptPercent -> pr "  float %s; /* [0..100] or -1 */\n" name
 533       ) cols;
 534       pr "};\n";
 535       pr "\n";
 536       pr "struct guestfs_%s_list {\n" typ;
 537       pr "  uint32_t len;\n";
 538       pr "  struct guestfs_%s *val;\n" typ;
 539       pr "};\n";
 540       pr "\n";
 541       pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
 542       pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
 543       pr "\n"
 544   ) structs;
 545
 546   pr "\
 547 /* Actions. */
 548 ";
 549
 550   List.iter (
 551     fun (shortname, (ret, args, optargs as style), _, flags, _, _, _) ->
 552       let deprecated =
 553         try
 554           Some (find_map (function DeprecatedBy fn -> Some fn | _ -> None)
 555                   flags)
 556         with Not_found -> None in
 557       let test0 =
 558         String.length shortname >= 5 && String.sub shortname 0 5 = "test0" in
 559       let debug =
 560         String.length shortname >= 5 && String.sub shortname 0 5 = "debug" in
 561       if deprecated = None && not test0 && not debug then
 562         pr "#define LIBGUESTFS_HAVE_%s 1\n" (String.uppercase shortname);
 563
 564       if optargs <> [] then (
 565         iteri (
 566           fun i argt ->
 567             let uc_shortname = String.uppercase shortname in
 568             let n = name_of_argt argt in
 569             let uc_n = String.uppercase n in
 570             pr "#define GUESTFS_%s_%s %d\n" uc_shortname uc_n i;
 571         ) optargs;
 572       );
 573
 574       generate_prototype ~single_line:true ~semicolon:false
 575         ~handle:"g" ~prefix:"guestfs_" shortname style;
 576       (match deprecated with
 577        | Some fn -> pr "\n  GUESTFS_DEPRECATED_BY (%S);\n" fn
 578        | None -> pr ";\n"
 579       );
 580
 581       if optargs <> [] then (
 582         generate_prototype ~single_line:true ~newline:true ~handle:"g"
 583           ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
 584           shortname style;
 585
 586         pr "\n";
 587         pr "struct guestfs_%s_argv {\n" shortname;
 588         pr "  uint64_t bitmask;\n";
 589         iteri (
 590           fun i argt ->
 591             let c_type =
 592               match argt with
 593               | Bool n -> "int "
 594               | Int n -> "int "
 595               | Int64 n -> "int64_t "
 596               | String n -> "const char *"
 597               | _ -> assert false (* checked in generator_checks *) in
 598             let uc_shortname = String.uppercase shortname in
 599             let n = name_of_argt argt in
 600             let uc_n = String.uppercase n in
 601             pr "\n";
 602             pr "# define GUESTFS_%s_%s_BITMASK (UINT64_C(1)<<%d)\n" uc_shortname uc_n i;
 603             pr "  /* The field below is only valid in this struct if the\n";
 604             pr "   * GUESTFS_%s_%s_BITMASK bit is set\n" uc_shortname uc_n;
 605             pr "   * in the bitmask above.  If not, the field is ignored.\n";
 606             pr "   */\n";
 607             pr "  %s%s;\n" c_type n
 608         ) optargs;
 609         pr "};\n";
 610         pr "\n";
 611
 612         generate_prototype ~single_line:true ~newline:true ~handle:"g"
 613           ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
 614           shortname style;
 615       );
 616
 617       pr "\n";
 618   ) all_functions_sorted;
 619
 620   pr "\
 621
 622 /* Private functions.
 623  *
 624  * These are NOT part of the public, stable API, and can change at any
 625  * time!  We export them because they are used by some of the language
 626  * bindings.
 627  */
 628 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
 629 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
 630 extern const char *guestfs_tmpdir (void);
 631 #ifdef GUESTFS_PRIVATE_FOR_EACH_DISK
 632 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);
 633 #endif
 634 /* End of private functions. */
 635
 636 #ifdef __cplusplus
 637 }
 638 #endif
 639
 640 #endif /* GUESTFS_H_ */
 641 "
 642
 643 (* Generate the guestfs-internal-actions.h file. *)
 644 and generate_internal_actions_h () =
 645   generate_header CStyle LGPLv2plus;
 646   List.iter (
 647     fun (shortname, style, _, _, _, _, _) ->
 648       generate_prototype ~single_line:true ~newline:true ~handle:"g"
 649         ~prefix:"guestfs__" ~optarg_proto:Argv
 650         shortname style
 651   ) non_daemon_functions
 652
 653 (* Generate the client-side dispatch stubs. *)
 654 and generate_client_actions () =
 655   generate_header CStyle LGPLv2plus;
 656
 657   pr "\
 658 #include <stdio.h>
 659 #include <stdlib.h>
 660 #include <stdint.h>
 661 #include <string.h>
 662 #include <inttypes.h>
 663 #include <unistd.h>
 664 #include <sys/types.h>
 665 #include <sys/stat.h>
 666 #include <assert.h>
 667
 668 #include \"guestfs.h\"
 669 #include \"guestfs-internal.h\"
 670 #include \"guestfs-internal-actions.h\"
 671 #include \"guestfs_protocol.h\"
 672 #include \"errnostring.h\"
 673
 674 /* Check the return message from a call for validity. */
 675 static int
 676 check_reply_header (guestfs_h *g,
 677                     const struct guestfs_message_header *hdr,
 678                     unsigned int proc_nr, unsigned int serial)
 679 {
 680   if (hdr->prog != GUESTFS_PROGRAM) {
 681     error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
 682     return -1;
 683   }
 684   if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
 685     error (g, \"wrong protocol version (%%d/%%d)\",
 686            hdr->vers, GUESTFS_PROTOCOL_VERSION);
 687     return -1;
 688   }
 689   if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
 690     error (g, \"unexpected message direction (%%d/%%d)\",
 691            hdr->direction, GUESTFS_DIRECTION_REPLY);
 692     return -1;
 693   }
 694   if (hdr->proc != proc_nr) {
 695     error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
 696     return -1;
 697   }
 698   if (hdr->serial != serial) {
 699     error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
 700     return -1;
 701   }
 702
 703   return 0;
 704 }
 705
 706 /* Check we are in the right state to run a high-level action. */
 707 static int
 708 check_state (guestfs_h *g, const char *caller)
 709 {
 710   if (!guestfs__is_ready (g)) {
 711     if (guestfs__is_config (g) || guestfs__is_launching (g))
 712       error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
 713         caller);
 714     else
 715       error (g, \"%%s called from the wrong state, %%d != READY\",
 716         caller, guestfs__get_state (g));
 717     return -1;
 718   }
 719   return 0;
 720 }
 721
 722 /* Convenience wrapper for tracing. */
 723 static FILE *
 724 trace_open (guestfs_h *g)
 725 {
 726   assert (g->trace_fp == NULL);
 727   g->trace_buf = NULL;
 728   g->trace_len = 0;
 729   g->trace_fp = open_memstream (&g->trace_buf, &g->trace_len);
 730   if (g->trace_fp)
 731     return g->trace_fp;
 732   else
 733     return stderr;
 734 }
 735
 736 static void
 737 trace_send_line (guestfs_h *g)
 738 {
 739   char *buf;
 740   size_t len;
 741
 742   if (g->trace_fp) {
 743     fclose (g->trace_fp);
 744     g->trace_fp = NULL;
 745
 746     /* The callback might invoke other libguestfs calls, so keep
 747      * a copy of the pointer to the buffer and length.
 748      */
 749     buf = g->trace_buf;
 750     len = g->trace_len;
 751     g->trace_buf = NULL;
 752     guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, buf, len);
 753
 754     free (buf);
 755   }
 756 }
 757
 758 ";
 759
 760   (* Generate code to check String-like parameters are not passed in
 761    * as NULL (returning an error if they are).
 762    *)
 763   let check_null_strings shortname (ret, args, optargs) =
 764     let pr_newline = ref false in
 765     List.iter (
 766       function
 767       (* parameters which should not be NULL *)
 768       | String n
 769       | Device n
 770       | Pathname n
 771       | Dev_or_Path n
 772       | FileIn n
 773       | FileOut n
 774       | BufferIn n
 775       | StringList n
 776       | DeviceList n
 777       | Key n
 778       | Pointer (_, n) ->
 779           pr "  if (%s == NULL) {\n" n;
 780           pr "    error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
 781           pr "           \"%s\", \"%s\");\n" shortname n;
 782           let errcode =
 783             match errcode_of_ret ret with
 784             | `CannotReturnError ->
 785                 if shortname = "test0rconstoptstring" then (* XXX hack *)
 786                   `ErrorIsNULL
 787                 else
 788                   failwithf
 789                     "%s: RConstOptString function has invalid parameter '%s'"
 790                     shortname n
 791             | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
 792           pr "    return %s;\n" (string_of_errcode errcode);
 793           pr "  }\n";
 794           pr_newline := true
 795
 796       (* can be NULL *)
 797       | OptString _
 798
 799       (* not applicable *)
 800       | Bool _
 801       | Int _
 802       | Int64 _ -> ()
 803     ) args;
 804
 805     (* For optional arguments. *)
 806     List.iter (
 807       function
 808       | String n ->
 809           pr "  if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK) &&\n"
 810             (String.uppercase shortname) (String.uppercase n);
 811           pr "      optargs->%s == NULL) {\n" n;
 812           pr "    error (g, \"%%s: %%s: optional parameter cannot be NULL\",\n";
 813           pr "           \"%s\", \"%s\");\n" shortname n;
 814           let errcode =
 815             match errcode_of_ret ret with
 816             | `CannotReturnError -> assert false
 817             | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
 818           pr "    return %s;\n" (string_of_errcode errcode);
 819           pr "  }\n";
 820           pr_newline := true
 821
 822       (* not applicable *)
 823       | Bool _ | Int _ | Int64 _ -> ()
 824
 825       | _ -> assert false
 826     ) optargs;
 827
 828     if !pr_newline then pr "\n";
 829   in
 830
 831   (* Generate code to reject optargs we don't know about. *)
 832   let reject_unknown_optargs shortname = function
 833     | _, _, [] -> ()
 834     | ret, _, optargs ->
 835         let len = List.length optargs in
 836         let mask = Int64.lognot (Int64.pred (Int64.shift_left 1L len)) in
 837         pr "  if (optargs->bitmask & UINT64_C(0x%Lx)) {\n" mask;
 838         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";
 839         pr "           \"%s\", \"%s\");\n" shortname shortname;
 840         let errcode =
 841           match errcode_of_ret ret with
 842           | `CannotReturnError -> assert false
 843           | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
 844         pr "    return %s;\n" (string_of_errcode errcode);
 845         pr "  }\n";
 846         pr "\n";
 847   in
 848
 849   (* Generate code to generate guestfish call traces. *)
 850   let trace_call shortname (ret, args, optargs) =
 851     pr "  if (trace_flag) {\n";
 852
 853     let needs_i =
 854       List.exists (function
 855                    | StringList _ | DeviceList _ -> true
 856                    | _ -> false) args in
 857     if needs_i then (
 858       pr "    size_t i;\n";
 859       pr "\n"
 860     );
 861
 862     pr "    trace_fp = trace_open (g);\n";
 863
 864     pr "    fprintf (trace_fp, \"%%s\", \"%s\");\n" shortname;
 865
 866     (* Required arguments. *)
 867     List.iter (
 868       function
 869       | String n                        (* strings *)
 870       | Device n
 871       | Pathname n
 872       | Dev_or_Path n
 873       | FileIn n
 874       | FileOut n ->
 875           (* guestfish doesn't support string escaping, so neither do we *)
 876           pr "    fprintf (trace_fp, \" \\\"%%s\\\"\", %s);\n" n
 877       | Key n ->
 878           (* don't print keys *)
 879           pr "    fprintf (trace_fp, \" \\\"***\\\"\");\n"
 880       | OptString n ->                  (* string option *)
 881           pr "    if (%s) fprintf (trace_fp, \" \\\"%%s\\\"\", %s);\n" n n;
 882           pr "    else fprintf (trace_fp, \" null\");\n"
 883       | StringList n
 884       | DeviceList n ->                 (* string list *)
 885           pr "    fputc (' ', trace_fp);\n";
 886           pr "    fputc ('\"', trace_fp);\n";
 887           pr "    for (i = 0; %s[i]; ++i) {\n" n;
 888           pr "      if (i > 0) fputc (' ', trace_fp);\n";
 889           pr "      fputs (%s[i], trace_fp);\n" n;
 890           pr "    }\n";
 891           pr "    fputc ('\"', trace_fp);\n";
 892       | Bool n ->                       (* boolean *)
 893           pr "    fputs (%s ? \" true\" : \" false\", trace_fp);\n" n
 894       | Int n ->                        (* int *)
 895           pr "    fprintf (trace_fp, \" %%d\", %s);\n" n
 896       | Int64 n ->
 897           pr "    fprintf (trace_fp, \" %%\" PRIi64, %s);\n" n
 898       | BufferIn n ->                   (* RHBZ#646822 *)
 899           pr "    fputc (' ', trace_fp);\n";
 900           pr "    guestfs___print_BufferIn (trace_fp, %s, %s_size);\n" n n
 901       | Pointer (t, n) ->
 902           pr "    fprintf (trace_fp, \" (%s)%%p\", %s);\n" t n
 903     ) args;
 904
 905     (* Optional arguments. *)
 906     List.iter (
 907       fun argt ->
 908         let n = name_of_argt argt in
 909         let uc_shortname = String.uppercase shortname in
 910         let uc_n = String.uppercase n in
 911         pr "    if (optargs->bitmask & GUESTFS_%s_%s_BITMASK)\n"
 912           uc_shortname uc_n;
 913         (match argt with
 914          | String n ->
 915              pr "      fprintf (trace_fp, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s);\n" n n
 916          | Bool n ->
 917              pr "      fprintf (trace_fp, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s ? \"true\" : \"false\");\n" n n
 918          | Int n ->
 919              pr "      fprintf (trace_fp, \" \\\"%%s:%%d\\\"\", \"%s\", optargs->%s);\n" n n
 920          | Int64 n ->
 921              pr "      fprintf (trace_fp, \" \\\"%%s:%%\" PRIi64 \"\\\"\", \"%s\", optargs->%s);\n" n n
 922          | _ -> assert false
 923         );
 924     ) optargs;
 925
 926     pr "    trace_send_line (g);\n";
 927     pr "  }\n";
 928     pr "\n";
 929   in
 930
 931   let trace_return ?(indent = 2) shortname (ret, _, _) rv =
 932     let indent = spaces indent in
 933
 934     pr "%sif (trace_flag) {\n" indent;
 935
 936     let needs_i =
 937       match ret with
 938       | RStringList _ | RHashtable _ -> true
 939       | _ -> false in
 940     if needs_i then (
 941       pr "%s  size_t i;\n" indent;
 942       pr "\n"
 943     );
 944
 945     pr "%s  trace_fp = trace_open (g);\n" indent;
 946
 947     pr "%s  fprintf (trace_fp, \"%%s = \", \"%s\");\n" indent shortname;
 948
 949     (match ret with
 950      | RErr | RInt _ | RBool _ ->
 951          pr "%s  fprintf (trace_fp, \"%%d\", %s);\n" indent rv
 952      | RInt64 _ ->
 953          pr "%s  fprintf (trace_fp, \"%%\" PRIi64, %s);\n" indent rv
 954      | RConstString _ | RString _ ->
 955          pr "%s  fprintf (trace_fp, \"\\\"%%s\\\"\", %s);\n" indent rv
 956      | RConstOptString _ ->
 957          pr "%s  fprintf (trace_fp, \"\\\"%%s\\\"\", %s != NULL ? %s : \"NULL\");\n"
 958            indent rv rv
 959      | RBufferOut _ ->
 960          pr "%s  guestfs___print_BufferOut (trace_fp, %s, *size_r);\n" indent rv
 961      | RStringList _ | RHashtable _ ->
 962          pr "%s  fputs (\"[\", trace_fp);\n" indent;
 963          pr "%s  for (i = 0; %s[i]; ++i) {\n" indent rv;
 964          pr "%s    if (i > 0) fputs (\", \", trace_fp);\n" indent;
 965          pr "%s    fputs (\"\\\"\", trace_fp);\n" indent;
 966          pr "%s    fputs (%s[i], trace_fp);\n" indent rv;
 967          pr "%s    fputs (\"\\\"\", trace_fp);\n" indent;
 968          pr "%s  }\n" indent;
 969          pr "%s  fputs (\"]\", trace_fp);\n" indent;
 970      | RStruct (_, typ) ->
 971          (* XXX There is code generated for guestfish for printing
 972           * these structures.  We need to make it generally available
 973           * for all callers
 974           *)
 975          pr "%s  fprintf (trace_fp, \"<struct guestfs_%s *>\");\n"
 976            indent typ (* XXX *)
 977      | RStructList (_, typ) ->
 978          pr "%s  fprintf (trace_fp, \"<struct guestfs_%s_list *>\");\n"
 979            indent typ (* XXX *)
 980     );
 981     pr "%s  trace_send_line (g);\n" indent;
 982     pr "%s}\n" indent;
 983     pr "\n";
 984   in
 985
 986   let trace_return_error ?(indent = 2) shortname (ret, _, _) errcode =
 987     let indent = spaces indent in
 988
 989     pr "%sif (trace_flag)\n" indent;
 990
 991     pr "%s  guestfs___trace (g, \"%%s = %%s (error)\",\n" indent;
 992     pr "%s                   \"%s\", \"%s\");\n"
 993       indent shortname (string_of_errcode errcode)
 994   in
 995
 996   (* For non-daemon functions, generate a wrapper around each function. *)
 997   List.iter (
 998     fun (shortname, (ret, _, optargs as style), _, _, _, _, _) ->
 999       if optargs = [] then
1000         generate_prototype ~extern:false ~semicolon:false ~newline:true
1001           ~handle:"g" ~prefix:"guestfs_"
1002           shortname style
1003       else
1004         generate_prototype ~extern:false ~semicolon:false ~newline:true
1005           ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
1006           shortname style;
1007       pr "{\n";
1008       pr "  int trace_flag = g->trace;\n";
1009       pr "  FILE *trace_fp;\n";
1010       (match ret with
1011        | RErr | RInt _ | RBool _ ->
1012            pr "  int r;\n"
1013        | RInt64 _ ->
1014            pr "  int64_t r;\n"
1015        | RConstString _ ->
1016            pr "  const char *r;\n"
1017        | RConstOptString _ ->
1018            pr "  const char *r;\n"
1019        | RString _ | RBufferOut _ ->
1020            pr "  char *r;\n"
1021        | RStringList _ | RHashtable _ ->
1022            pr "  char **r;\n"
1023        | RStruct (_, typ) ->
1024            pr "  struct guestfs_%s *r;\n" typ
1025        | RStructList (_, typ) ->
1026            pr "  struct guestfs_%s_list *r;\n" typ
1027       );
1028       pr "\n";
1029       check_null_strings shortname style;
1030       reject_unknown_optargs shortname style;
1031       trace_call shortname style;
1032       pr "  r = guestfs__%s " shortname;
1033       generate_c_call_args ~handle:"g" ~implicit_size_ptr:"size_r" style;
1034       pr ";\n";
1035       pr "\n";
1036       (match errcode_of_ret ret with
1037        | (`ErrorIsMinusOne | `ErrorIsNULL) as errcode ->
1038            pr "  if (r != %s) {\n" (string_of_errcode errcode);
1039            trace_return ~indent:4 shortname style "r";
1040            pr "  } else {\n";
1041            trace_return_error ~indent:4 shortname style errcode;
1042            pr "  }\n";
1043        | `CannotReturnError ->
1044            trace_return shortname style "r";
1045       );
1046       pr "\n";
1047       pr "  return r;\n";
1048       pr "}\n";
1049       pr "\n"
1050   ) non_daemon_functions;
1051
1052   (* Client-side stubs for each function. *)
1053   List.iter (
1054     fun (shortname, (ret, args, optargs as style), _, _, _, _, _) ->
1055       let name = "guestfs_" ^ shortname in
1056       let errcode =
1057         match errcode_of_ret ret with
1058         | `CannotReturnError -> assert false
1059         | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
1060
1061       (* Generate the action stub. *)
1062       if optargs = [] then
1063         generate_prototype ~extern:false ~semicolon:false ~newline:true
1064           ~handle:"g" ~prefix:"guestfs_" shortname style
1065       else
1066         generate_prototype ~extern:false ~semicolon:false ~newline:true
1067           ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv"
1068           ~optarg_proto:Argv shortname style;
1069
1070       pr "{\n";
1071
1072       (match args with
1073        | [] -> ()
1074        | _ -> pr "  struct %s_args args;\n" name
1075       );
1076
1077       pr "  guestfs_message_header hdr;\n";
1078       pr "  guestfs_message_error err;\n";
1079       let has_ret =
1080         match ret with
1081         | RErr -> false
1082         | RConstString _ | RConstOptString _ ->
1083             failwithf "RConstString|RConstOptString cannot be used by daemon functions"
1084         | RInt _ | RInt64 _
1085         | RBool _ | RString _ | RStringList _
1086         | RStruct _ | RStructList _
1087         | RHashtable _ | RBufferOut _ ->
1088             pr "  struct %s_ret ret;\n" name;
1089             true in
1090
1091       pr "  int serial;\n";
1092       pr "  int r;\n";
1093       pr "  int trace_flag = g->trace;\n";
1094       pr "  FILE *trace_fp;\n";
1095       (match ret with
1096        | RErr | RInt _ | RBool _ ->
1097            pr "  int ret_v;\n"
1098        | RInt64 _ ->
1099            pr "  int64_t ret_v;\n"
1100        | RConstString _ | RConstOptString _ ->
1101            pr "  const char *ret_v;\n"
1102        | RString _ | RBufferOut _ ->
1103            pr "  char *ret_v;\n"
1104        | RStringList _ | RHashtable _ ->
1105            pr "  char **ret_v;\n"
1106        | RStruct (_, typ) ->
1107            pr "  struct guestfs_%s *ret_v;\n" typ
1108        | RStructList (_, typ) ->
1109            pr "  struct guestfs_%s_list *ret_v;\n" typ
1110       );
1111
1112       let has_filein =
1113         List.exists (function FileIn _ -> true | _ -> false) args in
1114       if has_filein then (
1115         pr "  uint64_t progress_hint = 0;\n";
1116         pr "  struct stat progress_stat;\n";
1117       ) else
1118         pr "  const uint64_t progress_hint = 0;\n";
1119
1120       pr "\n";
1121       check_null_strings shortname style;
1122       reject_unknown_optargs shortname style;
1123       trace_call shortname style;
1124
1125       (* Calculate the total size of all FileIn arguments to pass
1126        * as a progress bar hint.
1127        *)
1128       List.iter (
1129         function
1130         | FileIn n ->
1131             pr "  if (stat (%s, &progress_stat) == 0 &&\n" n;
1132             pr "      S_ISREG (progress_stat.st_mode))\n";
1133             pr "    progress_hint += progress_stat.st_size;\n";
1134             pr "\n";
1135         | _ -> ()
1136       ) args;
1137
1138       (* Check we are in the right state for sending a request. *)
1139       pr "  if (check_state (g, \"%s\") == -1) {\n" shortname;
1140       trace_return_error ~indent:4 shortname style errcode;
1141       pr "    return %s;\n" (string_of_errcode errcode);
1142       pr "  }\n";
1143       pr "  guestfs___set_busy (g);\n";
1144       pr "\n";
1145
1146       (* Send the main header and arguments. *)
1147       if args = [] && optargs = [] then (
1148         pr "  serial = guestfs___send (g, GUESTFS_PROC_%s, progress_hint, 0,\n"
1149           (String.uppercase shortname);
1150         pr "                           NULL, NULL);\n"
1151       ) else (
1152         List.iter (
1153           function
1154           | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
1155               pr "  args.%s = (char *) %s;\n" n n
1156           | OptString n ->
1157               pr "  args.%s = %s ? (char **) &%s : NULL;\n" n n n
1158           | StringList n | DeviceList n ->
1159               pr "  args.%s.%s_val = (char **) %s;\n" n n n;
1160               pr "  for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
1161           | Bool n ->
1162               pr "  args.%s = %s;\n" n n
1163           | Int n ->
1164               pr "  args.%s = %s;\n" n n
1165           | Int64 n ->
1166               pr "  args.%s = %s;\n" n n
1167           | FileIn _ | FileOut _ -> ()
1168           | BufferIn n ->
1169               pr "  /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
1170               pr "  if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
1171               trace_return_error ~indent:4 shortname style errcode;
1172               pr "    error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
1173                 shortname;
1174               pr "    guestfs___end_busy (g);\n";
1175               pr "    return %s;\n" (string_of_errcode errcode);
1176               pr "  }\n";
1177               pr "  args.%s.%s_val = (char *) %s;\n" n n n;
1178               pr "  args.%s.%s_len = %s_size;\n" n n n
1179           | Pointer _ -> assert false
1180         ) args;
1181
1182         List.iter (
1183           fun argt ->
1184             let n = name_of_argt argt in
1185             let uc_shortname = String.uppercase shortname in
1186             let uc_n = String.uppercase n in
1187             pr "  if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK))\n"
1188               uc_shortname uc_n;
1189             (match argt with
1190              | Bool n
1191              | Int n
1192              | Int64 n ->
1193                  pr "    args.%s = optargs->%s;\n" n n;
1194                  pr "  else\n";
1195                  pr "    args.%s = 0;\n" n
1196              | String n ->
1197                  pr "    args.%s = (char *) optargs->%s;\n" n n;
1198                  pr "  else\n";
1199                  pr "    args.%s = (char *) \"\";\n" n
1200              | _ -> assert false
1201             )
1202         ) optargs;
1203
1204         pr "  serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
1205           (String.uppercase shortname);
1206         pr "                           progress_hint, %s,\n"
1207           (if optargs <> [] then "optargs->bitmask" else "0");
1208         pr "                           (xdrproc_t) xdr_%s_args, (char *) &args);\n"
1209           name;
1210       );
1211       pr "  if (serial == -1) {\n";
1212       pr "    guestfs___end_busy (g);\n";
1213       trace_return_error ~indent:4 shortname style errcode;
1214       pr "    return %s;\n" (string_of_errcode errcode);
1215       pr "  }\n";
1216       pr "\n";
1217
1218       (* Send any additional files (FileIn) requested. *)
1219       let need_read_reply_label = ref false in
1220       List.iter (
1221         function
1222         | FileIn n ->
1223             pr "  r = guestfs___send_file (g, %s);\n" n;
1224             pr "  if (r == -1) {\n";
1225             pr "    guestfs___end_busy (g);\n";
1226             trace_return_error ~indent:4 shortname style errcode;
1227             pr "    /* daemon will send an error reply which we discard */\n";
1228             pr "    guestfs___recv_discard (g, \"%s\");\n" shortname;
1229             pr "    return %s;\n" (string_of_errcode errcode);
1230             pr "  }\n";
1231             pr "  if (r == -2) /* daemon cancelled */\n";
1232             pr "    goto read_reply;\n";
1233             need_read_reply_label := true;
1234             pr "\n";
1235         | _ -> ()
1236       ) args;
1237
1238       (* Wait for the reply from the remote end. *)
1239       if !need_read_reply_label then pr " read_reply:\n";
1240       pr "  memset (&hdr, 0, sizeof hdr);\n";
1241       pr "  memset (&err, 0, sizeof err);\n";
1242       if has_ret then pr "  memset (&ret, 0, sizeof ret);\n";
1243       pr "\n";
1244       pr "  r = guestfs___recv (g, \"%s\", &hdr, &err,\n        " shortname;
1245       if not has_ret then
1246         pr "NULL, NULL"
1247       else
1248         pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
1249       pr ");\n";
1250
1251       pr "  if (r == -1) {\n";
1252       pr "    guestfs___end_busy (g);\n";
1253       trace_return_error ~indent:4 shortname style errcode;
1254       pr "    return %s;\n" (string_of_errcode errcode);
1255       pr "  }\n";
1256       pr "\n";
1257
1258       pr "  if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
1259         (String.uppercase shortname);
1260       pr "    guestfs___end_busy (g);\n";
1261       trace_return_error ~indent:4 shortname style errcode;
1262       pr "    return %s;\n" (string_of_errcode errcode);
1263       pr "  }\n";
1264       pr "\n";
1265
1266       pr "  if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
1267       trace_return_error ~indent:4 shortname style errcode;
1268       pr "    int errnum = 0;\n";
1269       pr "    if (err.errno_string[0] != '\\0')\n";
1270       pr "      errnum = guestfs___string_to_errno (err.errno_string);\n";
1271       pr "    if (errnum <= 0)\n";
1272       pr "      error (g, \"%%s: %%s\", \"%s\", err.error_message);\n"
1273         shortname;
1274       pr "    else\n";
1275       pr "      guestfs_error_errno (g, errnum, \"%%s: %%s\", \"%s\",\n"
1276         shortname;
1277       pr "                           err.error_message);\n";
1278       pr "    free (err.error_message);\n";
1279       pr "    free (err.errno_string);\n";
1280       pr "    guestfs___end_busy (g);\n";
1281       pr "    return %s;\n" (string_of_errcode errcode);
1282       pr "  }\n";
1283       pr "\n";
1284
1285       (* Expecting to receive further files (FileOut)? *)
1286       List.iter (
1287         function
1288         | FileOut n ->
1289             pr "  if (guestfs___recv_file (g, %s) == -1) {\n" n;
1290             pr "    guestfs___end_busy (g);\n";
1291             trace_return_error ~indent:4 shortname style errcode;
1292             pr "    return %s;\n" (string_of_errcode errcode);
1293             pr "  }\n";
1294             pr "\n";
1295         | _ -> ()
1296       ) args;
1297
1298       pr "  guestfs___end_busy (g);\n";
1299
1300       (match ret with
1301        | RErr ->
1302            pr "  ret_v = 0;\n"
1303        | RInt n | RInt64 n | RBool n ->
1304            pr "  ret_v = ret.%s;\n" n
1305        | RConstString _ | RConstOptString _ ->
1306            failwithf "RConstString|RConstOptString cannot be used by daemon functions"
1307        | RString n ->
1308            pr "  ret_v = ret.%s; /* caller will free */\n" n
1309        | RStringList n | RHashtable n ->
1310            pr "  /* caller will free this, but we need to add a NULL entry */\n";
1311            pr "  ret.%s.%s_val =\n" n n;
1312            pr "    safe_realloc (g, ret.%s.%s_val,\n" n n;
1313            pr "                  sizeof (char *) * (ret.%s.%s_len + 1));\n"
1314              n n;
1315            pr "  ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
1316            pr "  ret_v = ret.%s.%s_val;\n" n n
1317        | RStruct (n, _) ->
1318            pr "  /* caller will free this */\n";
1319            pr "  ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
1320        | RStructList (n, _) ->
1321            pr "  /* caller will free this */\n";
1322            pr "  ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
1323        | RBufferOut n ->
1324            pr "  /* RBufferOut is tricky: If the buffer is zero-length, then\n";
1325            pr "   * _val might be NULL here.  To make the API saner for\n";
1326            pr "   * callers, we turn this case into a unique pointer (using\n";
1327            pr "   * malloc(1)).\n";
1328            pr "   */\n";
1329            pr "  if (ret.%s.%s_len > 0) {\n" n n;
1330            pr "    *size_r = ret.%s.%s_len;\n" n n;
1331            pr "    ret_v = ret.%s.%s_val; /* caller will free */\n" n n;
1332            pr "  } else {\n";
1333            pr "    free (ret.%s.%s_val);\n" n n;
1334            pr "    char *p = safe_malloc (g, 1);\n";
1335            pr "    *size_r = ret.%s.%s_len;\n" n n;
1336            pr "    ret_v = p;\n";
1337            pr "  }\n";
1338       );
1339       trace_return shortname style "ret_v";
1340       pr "  return ret_v;\n";
1341       pr "}\n\n"
1342   ) daemon_functions;
1343
1344   (* Functions to free structures. *)
1345   pr "/* Structure-freeing functions.  These rely on the fact that the\n";
1346   pr " * structure format is identical to the XDR format.  See note in\n";
1347   pr " * generator.ml.\n";
1348   pr " */\n";
1349   pr "\n";
1350
1351   List.iter (
1352     fun (typ, _) ->
1353       pr "void\n";
1354       pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
1355       pr "{\n";
1356       pr "  xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
1357       pr "  free (x);\n";
1358       pr "}\n";
1359       pr "\n";
1360
1361       pr "void\n";
1362       pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
1363       pr "{\n";
1364       pr "  xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
1365       pr "  free (x);\n";
1366       pr "}\n";
1367       pr "\n";
1368
1369   ) structs;
1370
1371   (* Functions which have optional arguments have two generated variants. *)
1372   List.iter (
1373     function
1374     | shortname, (ret, args, (_::_ as optargs) as style), _, _, _, _, _ ->
1375         let uc_shortname = String.uppercase shortname in
1376
1377         (* Get the name of the last regular argument. *)
1378         let last_arg =
1379           match ret with
1380           | RBufferOut _ -> "size_r"
1381           | _ ->
1382               match args with
1383               | [] -> "g"
1384               | args -> name_of_argt (List.hd (List.rev args)) in
1385
1386         let rtype =
1387           match ret with
1388           | RErr | RInt _ | RBool _ -> "int "
1389           | RInt64 _ -> "int64_t "
1390           | RConstString _ | RConstOptString _ -> "const char *"
1391           | RString _ | RBufferOut _ -> "char *"
1392           | RStringList _ | RHashtable _ -> "char **"
1393           | RStruct (_, typ) -> sprintf "struct guestfs_%s *" typ
1394           | RStructList (_, typ) ->
1395               sprintf "struct guestfs_%s_list *" typ in
1396
1397         (* The regular variable args function, just calls the _va variant. *)
1398         generate_prototype ~extern:false ~semicolon:false ~newline:true
1399           ~handle:"g" ~prefix:"guestfs_" shortname style;
1400         pr "{\n";
1401         pr "  va_list optargs;\n";
1402         pr "\n";
1403         pr "  va_start (optargs, %s);\n" last_arg;
1404         pr "  %sr = guestfs_%s_va " rtype shortname;
1405         generate_c_call_args ~handle:"g" ~implicit_size_ptr:"size_r" style;
1406         pr ";\n";
1407         pr "  va_end (optargs);\n";
1408         pr "\n";
1409         pr "  return r;\n";
1410         pr "}\n\n";
1411
1412         generate_prototype ~extern:false ~semicolon:false ~newline:true
1413           ~handle:"g" ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
1414           shortname style;
1415         pr "{\n";
1416         pr "  struct guestfs_%s_argv optargs_s;\n" shortname;
1417         pr "  struct guestfs_%s_argv *optargs = &optargs_s;\n" shortname;
1418         pr "  int i;\n";
1419         pr "\n";
1420         pr "  optargs_s.bitmask = 0;\n";
1421         pr "\n";
1422         pr "  while ((i = va_arg (args, int)) >= 0) {\n";
1423         pr "    switch (i) {\n";
1424
1425         List.iter (
1426           fun argt ->
1427             let n = name_of_argt argt in
1428             let uc_n = String.uppercase n in
1429             pr "    case GUESTFS_%s_%s:\n" uc_shortname uc_n;
1430             pr "      optargs_s.%s = va_arg (args, " n;
1431             (match argt with
1432              | Bool _ | Int _ -> pr "int"
1433              | Int64 _ -> pr "int64_t"
1434              | String _ -> pr "const char *"
1435              | _ -> assert false
1436             );
1437             pr ");\n";
1438             pr "      break;\n";
1439         ) optargs;
1440
1441         let errcode =
1442           match errcode_of_ret ret with
1443           | `CannotReturnError -> assert false
1444           | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
1445
1446         pr "    default:\n";
1447         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";
1448         pr "             \"%s\", i);\n" shortname;
1449         pr "      return %s;\n" (string_of_errcode errcode);
1450         pr "    }\n";
1451         pr "\n";
1452         pr "    uint64_t i_mask = UINT64_C(1) << i;\n";
1453         pr "    if (optargs_s.bitmask & i_mask) {\n";
1454         pr "      error (g, \"%%s: same optional argument specified more than once\",\n";
1455         pr "             \"%s\");\n" shortname;
1456         pr "      return %s;\n" (string_of_errcode errcode);
1457         pr "    }\n";
1458         pr "    optargs_s.bitmask |= i_mask;\n";
1459         pr "  }\n";
1460         pr "\n";
1461         pr "  return guestfs_%s_argv " shortname;
1462         generate_c_call_args ~handle:"g" ~implicit_size_ptr:"size_r" style;
1463         pr ";\n";
1464         pr "}\n\n"
1465     | _ -> ()
1466   ) all_functions_sorted
1467
1468 (* Generate the linker script which controls the visibility of
1469  * symbols in the public ABI and ensures no other symbols get
1470  * exported accidentally.
1471  *)
1472 and generate_linker_script () =
1473   generate_header HashStyle GPLv2plus;
1474
1475   let globals = [
1476     "guestfs_create";
1477     "guestfs_close";
1478     "guestfs_delete_event_callback";
1479     "guestfs_first_private";
1480     "guestfs_get_error_handler";
1481     "guestfs_get_out_of_memory_handler";
1482     "guestfs_get_private";
1483     "guestfs_last_errno";
1484     "guestfs_last_error";
1485     "guestfs_next_private";
1486     "guestfs_set_close_callback";
1487     "guestfs_set_error_handler";
1488     "guestfs_set_event_callback";
1489     "guestfs_set_launch_done_callback";
1490     "guestfs_set_log_message_callback";
1491     "guestfs_set_out_of_memory_handler";
1492     "guestfs_set_private";
1493     "guestfs_set_progress_callback";
1494     "guestfs_set_subprocess_quit_callback";
1495     "guestfs_user_cancel";
1496
1497     (* Unofficial parts of the API: the bindings code use these
1498      * functions, so it is useful to export them.
1499      *)
1500     "guestfs_safe_calloc";
1501     "guestfs_safe_malloc";
1502     "guestfs_safe_strdup";
1503     "guestfs_safe_memdup";
1504     "guestfs_tmpdir";
1505     "guestfs___for_each_disk";
1506   ] in
1507   let functions =
1508     List.flatten (
1509       List.map (
1510         function
1511         | name, (_, _, []), _, _, _, _, _ -> ["guestfs_" ^ name]
1512         | name, (_, _, _), _, _, _, _, _ ->
1513             ["guestfs_" ^ name;
1514              "guestfs_" ^ name ^ "_va";
1515              "guestfs_" ^ name ^ "_argv"]
1516       ) all_functions
1517     ) in
1518   let structs =
1519     List.concat (
1520       List.map (fun (typ, _) ->
1521                   ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
1522         structs
1523     ) in
1524   let globals = List.sort compare (globals @ functions @ structs) in
1525
1526   pr "{\n";
1527   pr "    global:\n";
1528   List.iter (pr "        %s;\n") globals;
1529   pr "\n";
1530
1531   pr "    local:\n";
1532   pr "        *;\n";
1533   pr "};\n"
1534
1535 and generate_max_proc_nr () =
1536   pr "%d\n" max_proc_nr