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