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
 574       pr "\n";
 575   ) all_functions_sorted;
 576
 577   pr "\
 578
 579 /* Private functions.
 580  *
 581  * These are NOT part of the public, stable API, and can change at any
 582  * time!  We export them because they are used by some of the language
 583  * bindings.
 584  */
 585 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
 586 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
 587 extern const char *guestfs_tmpdir (void);
 588 #ifdef GUESTFS_PRIVATE_FOR_EACH_DISK
 589 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);
 590 #endif
 591 /* End of private functions. */
 592
 593 #ifdef __cplusplus
 594 }
 595 #endif
 596
 597 #endif /* GUESTFS_H_ */
 598 "
 599
 600 (* Generate the guestfs-internal-actions.h file. *)
 601 and generate_internal_actions_h () =
 602   generate_header CStyle LGPLv2plus;
 603   List.iter (
 604     fun (shortname, style, _, _, _, _, _) ->
 605       generate_prototype ~single_line:true ~newline:true ~handle:"g"
 606         ~prefix:"guestfs__" ~optarg_proto:Argv
 607         shortname style
 608   ) non_daemon_functions
 609
 610 (* Generate the client-side dispatch stubs. *)
 611 and generate_client_actions () =
 612   generate_header CStyle LGPLv2plus;
 613
 614   pr "\
 615 #include <stdio.h>
 616 #include <stdlib.h>
 617 #include <stdint.h>
 618 #include <string.h>
 619 #include <inttypes.h>
 620 #include <unistd.h>
 621 #include <sys/types.h>
 622 #include <sys/stat.h>
 623 #include <assert.h>
 624
 625 #include \"guestfs.h\"
 626 #include \"guestfs-internal.h\"
 627 #include \"guestfs-internal-actions.h\"
 628 #include \"guestfs_protocol.h\"
 629 #include \"errnostring.h\"
 630
 631 /* Check the return message from a call for validity. */
 632 static int
 633 check_reply_header (guestfs_h *g,
 634                     const struct guestfs_message_header *hdr,
 635                     unsigned int proc_nr, unsigned int serial)
 636 {
 637   if (hdr->prog != GUESTFS_PROGRAM) {
 638     error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
 639     return -1;
 640   }
 641   if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
 642     error (g, \"wrong protocol version (%%d/%%d)\",
 643            hdr->vers, GUESTFS_PROTOCOL_VERSION);
 644     return -1;
 645   }
 646   if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
 647     error (g, \"unexpected message direction (%%d/%%d)\",
 648            hdr->direction, GUESTFS_DIRECTION_REPLY);
 649     return -1;
 650   }
 651   if (hdr->proc != proc_nr) {
 652     error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
 653     return -1;
 654   }
 655   if (hdr->serial != serial) {
 656     error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
 657     return -1;
 658   }
 659
 660   return 0;
 661 }
 662
 663 /* Check we are in the right state to run a high-level action. */
 664 static int
 665 check_state (guestfs_h *g, const char *caller)
 666 {
 667   if (!guestfs__is_ready (g)) {
 668     if (guestfs__is_config (g) || guestfs__is_launching (g))
 669       error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
 670         caller);
 671     else
 672       error (g, \"%%s called from the wrong state, %%d != READY\",
 673         caller, guestfs__get_state (g));
 674     return -1;
 675   }
 676   return 0;
 677 }
 678
 679 /* Convenience wrapper for tracing. */
 680 static FILE *
 681 trace_open (guestfs_h *g)
 682 {
 683   assert (g->trace_fp == NULL);
 684   g->trace_buf = NULL;
 685   g->trace_len = 0;
 686   g->trace_fp = open_memstream (&g->trace_buf, &g->trace_len);
 687   if (g->trace_fp)
 688     return g->trace_fp;
 689   else
 690     return stderr;
 691 }
 692
 693 static void
 694 trace_send_line (guestfs_h *g)
 695 {
 696   char *buf;
 697   size_t len;
 698
 699   if (g->trace_fp) {
 700     fclose (g->trace_fp);
 701     g->trace_fp = NULL;
 702
 703     /* The callback might invoke other libguestfs calls, so keep
 704      * a copy of the pointer to the buffer and length.
 705      */
 706     buf = g->trace_buf;
 707     len = g->trace_len;
 708     g->trace_buf = NULL;
 709     guestfs___call_callbacks_message (g, GUESTFS_EVENT_TRACE, buf, len);
 710
 711     free (buf);
 712   }
 713 }
 714
 715 ";
 716
 717   (* Generate code to check String-like parameters are not passed in
 718    * as NULL (returning an error if they are).
 719    *)
 720   let check_null_strings shortname (ret, args, optargs) =
 721     let pr_newline = ref false in
 722     List.iter (
 723       function
 724       (* parameters which should not be NULL *)
 725       | String n
 726       | Device n
 727       | Pathname n
 728       | Dev_or_Path n
 729       | FileIn n
 730       | FileOut n
 731       | BufferIn n
 732       | StringList n
 733       | DeviceList n
 734       | Key n
 735       | Pointer (_, n) ->
 736           pr "  if (%s == NULL) {\n" n;
 737           pr "    error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
 738           pr "           \"%s\", \"%s\");\n" shortname n;
 739           let errcode =
 740             match errcode_of_ret ret with
 741             | `CannotReturnError ->
 742                 if shortname = "test0rconstoptstring" then (* XXX hack *)
 743                   `ErrorIsNULL
 744                 else
 745                   failwithf
 746                     "%s: RConstOptString function has invalid parameter '%s'"
 747                     shortname n
 748             | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
 749           pr "    return %s;\n" (string_of_errcode errcode);
 750           pr "  }\n";
 751           pr_newline := true
 752
 753       (* can be NULL *)
 754       | OptString _
 755
 756       (* not applicable *)
 757       | Bool _
 758       | Int _
 759       | Int64 _ -> ()
 760     ) args;
 761
 762     (* For optional arguments. *)
 763     List.iter (
 764       function
 765       | String n ->
 766           pr "  if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK) &&\n"
 767             (String.uppercase shortname) (String.uppercase n);
 768           pr "      optargs->%s == NULL) {\n" n;
 769           pr "    error (g, \"%%s: %%s: optional parameter cannot be NULL\",\n";
 770           pr "           \"%s\", \"%s\");\n" shortname n;
 771           let errcode =
 772             match errcode_of_ret ret with
 773             | `CannotReturnError -> assert false
 774             | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
 775           pr "    return %s;\n" (string_of_errcode errcode);
 776           pr "  }\n";
 777           pr_newline := true
 778
 779       (* not applicable *)
 780       | Bool _ | Int _ | Int64 _ -> ()
 781
 782       | _ -> assert false
 783     ) optargs;
 784
 785     if !pr_newline then pr "\n";
 786   in
 787
 788   (* Generate code to reject optargs we don't know about. *)
 789   let reject_unknown_optargs shortname = function
 790     | _, _, [] -> ()
 791     | ret, _, optargs ->
 792         let len = List.length optargs in
 793         let mask = Int64.lognot (Int64.pred (Int64.shift_left 1L len)) in
 794         pr "  if (optargs->bitmask & UINT64_C(0x%Lx)) {\n" mask;
 795         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";
 796         pr "           \"%s\", \"%s\");\n" shortname shortname;
 797         let errcode =
 798           match errcode_of_ret ret with
 799           | `CannotReturnError -> assert false
 800           | (`ErrorIsMinusOne |`ErrorIsNULL) as e -> e in
 801         pr "    return %s;\n" (string_of_errcode errcode);
 802         pr "  }\n";
 803         pr "\n";
 804   in
 805
 806   (* Generate code to generate guestfish call traces. *)
 807   let trace_call shortname (ret, args, optargs) =
 808     pr "  if (trace_flag) {\n";
 809
 810     let needs_i =
 811       List.exists (function
 812                    | StringList _ | DeviceList _ -> true
 813                    | _ -> false) args in
 814     if needs_i then (
 815       pr "    size_t i;\n";
 816       pr "\n"
 817     );
 818
 819     pr "    trace_fp = trace_open (g);\n";
 820
 821     pr "    fprintf (trace_fp, \"%%s\", \"%s\");\n" shortname;
 822
 823     (* Required arguments. *)
 824     List.iter (
 825       function
 826       | String n                        (* strings *)
 827       | Device n
 828       | Pathname n
 829       | Dev_or_Path n
 830       | FileIn n
 831       | FileOut n ->
 832           (* guestfish doesn't support string escaping, so neither do we *)
 833           pr "    fprintf (trace_fp, \" \\\"%%s\\\"\", %s);\n" n
 834       | Key n ->
 835           (* don't print keys *)
 836           pr "    fprintf (trace_fp, \" \\\"***\\\"\");\n"
 837       | OptString n ->                  (* string option *)
 838           pr "    if (%s) fprintf (trace_fp, \" \\\"%%s\\\"\", %s);\n" n n;
 839           pr "    else fprintf (trace_fp, \" null\");\n"
 840       | StringList n
 841       | DeviceList n ->                 (* string list *)
 842           pr "    fputc (' ', trace_fp);\n";
 843           pr "    fputc ('\"', trace_fp);\n";
 844           pr "    for (i = 0; %s[i]; ++i) {\n" n;
 845           pr "      if (i > 0) fputc (' ', trace_fp);\n";
 846           pr "      fputs (%s[i], trace_fp);\n" n;
 847           pr "    }\n";
 848           pr "    fputc ('\"', trace_fp);\n";
 849       | Bool n ->                       (* boolean *)
 850           pr "    fputs (%s ? \" true\" : \" false\", trace_fp);\n" n
 851       | Int n ->                        (* int *)
 852           pr "    fprintf (trace_fp, \" %%d\", %s);\n" n
 853       | Int64 n ->
 854           pr "    fprintf (trace_fp, \" %%\" PRIi64, %s);\n" n
 855       | BufferIn n ->                   (* RHBZ#646822 *)
 856           pr "    fputc (' ', trace_fp);\n";
 857           pr "    guestfs___print_BufferIn (trace_fp, %s, %s_size);\n" n n
 858       | Pointer (t, n) ->
 859           pr "    fprintf (trace_fp, \" (%s)%%p\", %s);\n" t n
 860     ) args;
 861
 862     (* Optional arguments. *)
 863     List.iter (
 864       fun argt ->
 865         let n = name_of_argt argt in
 866         let uc_shortname = String.uppercase shortname in
 867         let uc_n = String.uppercase n in
 868         pr "    if (optargs->bitmask & GUESTFS_%s_%s_BITMASK)\n"
 869           uc_shortname uc_n;
 870         (match argt with
 871          | String n ->
 872              pr "      fprintf (trace_fp, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s);\n" n n
 873          | Bool n ->
 874              pr "      fprintf (trace_fp, \" \\\"%%s:%%s\\\"\", \"%s\", optargs->%s ? \"true\" : \"false\");\n" n n
 875          | Int n ->
 876              pr "      fprintf (trace_fp, \" \\\"%%s:%%d\\\"\", \"%s\", optargs->%s);\n" n n
 877          | Int64 n ->
 878              pr "      fprintf (trace_fp, \" \\\"%%s:%%\" PRIi64 \"\\\"\", \"%s\", optargs->%s);\n" n n
 879          | _ -> assert false
 880         );
 881     ) optargs;
 882
 883     pr "    trace_send_line (g);\n";
 884     pr "  }\n";
 885     pr "\n";
 886   in
 887
 888   let trace_return ?(indent = 2) shortname (ret, _, _) rv =
 889     let indent = spaces indent in
 890
 891     pr "%sif (trace_flag) {\n" indent;
 892
 893     let needs_i =
 894       match ret with
 895       | RStringList _ | RHashtable _ -> true
 896       | _ -> false in
 897     if needs_i then (
 898       pr "%s  size_t i;\n" indent;
 899       pr "\n"
 900     );
 901
 902     pr "%s  trace_fp = trace_open (g);\n" indent;
 903
 904     pr "%s  fprintf (trace_fp, \"%%s = \", \"%s\");\n" indent shortname;
 905
 906     (match ret with
 907      | RErr | RInt _ | RBool _ ->
 908          pr "%s  fprintf (trace_fp, \"%%d\", %s);\n" indent rv
 909      | RInt64 _ ->
 910          pr "%s  fprintf (trace_fp, \"%%\" PRIi64, %s);\n" indent rv
 911      | RConstString _ | RString _ ->
 912          pr "%s  fprintf (trace_fp, \"\\\"%%s\\\"\", %s);\n" indent rv
 913      | RConstOptString _ ->
 914          pr "%s  fprintf (trace_fp, \"\\\"%%s\\\"\", %s != NULL ? %s : \"NULL\");\n"
 915            indent rv rv
 916      | RBufferOut _ ->
 917          pr "%s  guestfs___print_BufferOut (trace_fp, %s, *size_r);\n" indent rv
 918      | RStringList _ | RHashtable _ ->
 919          pr "%s  fputs (\"[\\\"\", trace_fp);\n" indent;
 920          pr "%s  for (i = 0; %s[i]; ++i) {\n" indent rv;
 921          pr "%s    if (i > 0) fputs (\"\\\", \\\"\", trace_fp);\n" indent;
 922          pr "%s    fputs (%s[i], trace_fp);\n" indent rv;
 923          pr "%s  }\n" indent;
 924          pr "%s  fputs (\"\\\"]\", trace_fp);\n" indent;
 925      | RStruct (_, typ) ->
 926          (* XXX There is code generated for guestfish for printing
 927           * these structures.  We need to make it generally available
 928           * for all callers
 929           *)
 930          pr "%s  fprintf (trace_fp, \"<struct guestfs_%s *>\");\n"
 931            indent typ (* XXX *)
 932      | RStructList (_, typ) ->
 933          pr "%s  fprintf (trace_fp, \"<struct guestfs_%s_list *>\");\n"
 934            indent typ (* XXX *)
 935     );
 936     pr "%s  trace_send_line (g);\n" indent;
 937     pr "%s}\n" indent;
 938     pr "\n";
 939   in
 940
 941   let trace_return_error ?(indent = 2) shortname (ret, _, _) errcode =
 942     let indent = spaces indent in
 943
 944     pr "%sif (trace_flag)\n" indent;
 945
 946     pr "%s  guestfs___trace (g, \"%%s = %%s (error)\",\n" indent;
 947     pr "%s                   \"%s\", \"%s\");\n"
 948       indent shortname (string_of_errcode errcode)
 949   in
 950
 951   (* For non-daemon functions, generate a wrapper around each function. *)
 952   List.iter (
 953     fun (shortname, (ret, _, optargs as style), _, _, _, _, _) ->
 954       if optargs = [] then
 955         generate_prototype ~extern:false ~semicolon:false ~newline:true
 956           ~handle:"g" ~prefix:"guestfs_"
 957           shortname style
 958       else
 959         generate_prototype ~extern:false ~semicolon:false ~newline:true
 960           ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv" ~optarg_proto:Argv
 961           shortname style;
 962       pr "{\n";
 963       pr "  int trace_flag = g->trace;\n";
 964       pr "  FILE *trace_fp;\n";
 965       (match ret with
 966        | RErr | RInt _ | RBool _ ->
 967            pr "  int r;\n"
 968        | RInt64 _ ->
 969            pr "  int64_t r;\n"
 970        | RConstString _ ->
 971            pr "  const char *r;\n"
 972        | RConstOptString _ ->
 973            pr "  const char *r;\n"
 974        | RString _ | RBufferOut _ ->
 975            pr "  char *r;\n"
 976        | RStringList _ | RHashtable _ ->
 977            pr "  char **r;\n"
 978        | RStruct (_, typ) ->
 979            pr "  struct guestfs_%s *r;\n" typ
 980        | RStructList (_, typ) ->
 981            pr "  struct guestfs_%s_list *r;\n" typ
 982       );
 983       pr "\n";
 984       check_null_strings shortname style;
 985       reject_unknown_optargs shortname style;
 986       trace_call shortname style;
 987       pr "  r = guestfs__%s " shortname;
 988       generate_c_call_args ~handle:"g" style;
 989       pr ";\n";
 990       pr "\n";
 991       (match errcode_of_ret ret with
 992        | (`ErrorIsMinusOne | `ErrorIsNULL) as errcode ->
 993            pr "  if (r != %s) {\n" (string_of_errcode errcode);
 994            trace_return ~indent:4 shortname style "r";
 995            pr "  } else {\n";
 996            trace_return_error ~indent:4 shortname style errcode;
 997            pr "  }\n";
 998        | `CannotReturnError ->
 999            trace_return shortname style "r";
1000       );
1001       pr "\n";
1002       pr "  return r;\n";
1003       pr "}\n";
1004       pr "\n"
1005   ) non_daemon_functions;
1006
1007   (* Client-side stubs for each function. *)
1008   List.iter (
1009     fun (shortname, (ret, args, optargs as style), _, _, _, _, _) ->
1010       let name = "guestfs_" ^ shortname in
1011       let errcode =
1012         match errcode_of_ret ret with
1013         | `CannotReturnError -> assert false
1014         | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
1015
1016       (* Generate the action stub. *)
1017       if optargs = [] then
1018         generate_prototype ~extern:false ~semicolon:false ~newline:true
1019           ~handle:"g" ~prefix:"guestfs_" shortname style
1020       else
1021         generate_prototype ~extern:false ~semicolon:false ~newline:true
1022           ~handle:"g" ~prefix:"guestfs_" ~suffix:"_argv"
1023           ~optarg_proto:Argv shortname style;
1024
1025       pr "{\n";
1026
1027       (match args with
1028        | [] -> ()
1029        | _ -> pr "  struct %s_args args;\n" name
1030       );
1031
1032       pr "  guestfs_message_header hdr;\n";
1033       pr "  guestfs_message_error err;\n";
1034       let has_ret =
1035         match ret with
1036         | RErr -> false
1037         | RConstString _ | RConstOptString _ ->
1038             failwithf "RConstString|RConstOptString cannot be used by daemon functions"
1039         | RInt _ | RInt64 _
1040         | RBool _ | RString _ | RStringList _
1041         | RStruct _ | RStructList _
1042         | RHashtable _ | RBufferOut _ ->
1043             pr "  struct %s_ret ret;\n" name;
1044             true in
1045
1046       pr "  int serial;\n";
1047       pr "  int r;\n";
1048       pr "  int trace_flag = g->trace;\n";
1049       pr "  FILE *trace_fp;\n";
1050       (match ret with
1051        | RErr | RInt _ | RBool _ ->
1052            pr "  int ret_v;\n"
1053        | RInt64 _ ->
1054            pr "  int64_t ret_v;\n"
1055        | RConstString _ | RConstOptString _ ->
1056            pr "  const char *ret_v;\n"
1057        | RString _ | RBufferOut _ ->
1058            pr "  char *ret_v;\n"
1059        | RStringList _ | RHashtable _ ->
1060            pr "  char **ret_v;\n"
1061        | RStruct (_, typ) ->
1062            pr "  struct guestfs_%s *ret_v;\n" typ
1063        | RStructList (_, typ) ->
1064            pr "  struct guestfs_%s_list *ret_v;\n" typ
1065       );
1066
1067       let has_filein =
1068         List.exists (function FileIn _ -> true | _ -> false) args in
1069       if has_filein then (
1070         pr "  uint64_t progress_hint = 0;\n";
1071         pr "  struct stat progress_stat;\n";
1072       ) else
1073         pr "  const uint64_t progress_hint = 0;\n";
1074
1075       pr "\n";
1076       check_null_strings shortname style;
1077       reject_unknown_optargs shortname style;
1078       trace_call shortname style;
1079
1080       (* Calculate the total size of all FileIn arguments to pass
1081        * as a progress bar hint.
1082        *)
1083       List.iter (
1084         function
1085         | FileIn n ->
1086             pr "  if (stat (%s, &progress_stat) == 0 &&\n" n;
1087             pr "      S_ISREG (progress_stat.st_mode))\n";
1088             pr "    progress_hint += progress_stat.st_size;\n";
1089             pr "\n";
1090         | _ -> ()
1091       ) args;
1092
1093       (* Check we are in the right state for sending a request. *)
1094       pr "  if (check_state (g, \"%s\") == -1) {\n" shortname;
1095       trace_return_error ~indent:4 shortname style errcode;
1096       pr "    return %s;\n" (string_of_errcode errcode);
1097       pr "  }\n";
1098       pr "  guestfs___set_busy (g);\n";
1099       pr "\n";
1100
1101       (* Send the main header and arguments. *)
1102       if args = [] && optargs = [] then (
1103         pr "  serial = guestfs___send (g, GUESTFS_PROC_%s, progress_hint, 0,\n"
1104           (String.uppercase shortname);
1105         pr "                           NULL, NULL);\n"
1106       ) else (
1107         List.iter (
1108           function
1109           | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
1110               pr "  args.%s = (char *) %s;\n" n n
1111           | OptString n ->
1112               pr "  args.%s = %s ? (char **) &%s : NULL;\n" n n n
1113           | StringList n | DeviceList n ->
1114               pr "  args.%s.%s_val = (char **) %s;\n" n n n;
1115               pr "  for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
1116           | Bool n ->
1117               pr "  args.%s = %s;\n" n n
1118           | Int n ->
1119               pr "  args.%s = %s;\n" n n
1120           | Int64 n ->
1121               pr "  args.%s = %s;\n" n n
1122           | FileIn _ | FileOut _ -> ()
1123           | BufferIn n ->
1124               pr "  /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
1125               pr "  if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
1126               trace_return_error ~indent:4 shortname style errcode;
1127               pr "    error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
1128                 shortname;
1129               pr "    guestfs___end_busy (g);\n";
1130               pr "    return %s;\n" (string_of_errcode errcode);
1131               pr "  }\n";
1132               pr "  args.%s.%s_val = (char *) %s;\n" n n n;
1133               pr "  args.%s.%s_len = %s_size;\n" n n n
1134           | Pointer _ -> assert false
1135         ) args;
1136
1137         List.iter (
1138           fun argt ->
1139             let n = name_of_argt argt in
1140             let uc_shortname = String.uppercase shortname in
1141             let uc_n = String.uppercase n in
1142             pr "  if ((optargs->bitmask & GUESTFS_%s_%s_BITMASK))\n"
1143               uc_shortname uc_n;
1144             (match argt with
1145              | Bool n
1146              | Int n
1147              | Int64 n ->
1148                  pr "    args.%s = optargs->%s;\n" n n;
1149                  pr "  else\n";
1150                  pr "    args.%s = 0;\n" n
1151              | String n ->
1152                  pr "    args.%s = (char *) optargs->%s;\n" n n;
1153                  pr "  else\n";
1154                  pr "    args.%s = (char *) \"\";\n" n
1155              | _ -> assert false
1156             )
1157         ) optargs;
1158
1159         pr "  serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
1160           (String.uppercase shortname);
1161         pr "                           progress_hint, %s,\n"
1162           (if optargs <> [] then "optargs->bitmask" else "0");
1163         pr "                           (xdrproc_t) xdr_%s_args, (char *) &args);\n"
1164           name;
1165       );
1166       pr "  if (serial == -1) {\n";
1167       pr "    guestfs___end_busy (g);\n";
1168       trace_return_error ~indent:4 shortname style errcode;
1169       pr "    return %s;\n" (string_of_errcode errcode);
1170       pr "  }\n";
1171       pr "\n";
1172
1173       (* Send any additional files (FileIn) requested. *)
1174       let need_read_reply_label = ref false in
1175       List.iter (
1176         function
1177         | FileIn n ->
1178             pr "  r = guestfs___send_file (g, %s);\n" n;
1179             pr "  if (r == -1) {\n";
1180             pr "    guestfs___end_busy (g);\n";
1181             trace_return_error ~indent:4 shortname style errcode;
1182             pr "    /* daemon will send an error reply which we discard */\n";
1183             pr "    guestfs___recv_discard (g, \"%s\");\n" shortname;
1184             pr "    return %s;\n" (string_of_errcode errcode);
1185             pr "  }\n";
1186             pr "  if (r == -2) /* daemon cancelled */\n";
1187             pr "    goto read_reply;\n";
1188             need_read_reply_label := true;
1189             pr "\n";
1190         | _ -> ()
1191       ) args;
1192
1193       (* Wait for the reply from the remote end. *)
1194       if !need_read_reply_label then pr " read_reply:\n";
1195       pr "  memset (&hdr, 0, sizeof hdr);\n";
1196       pr "  memset (&err, 0, sizeof err);\n";
1197       if has_ret then pr "  memset (&ret, 0, sizeof ret);\n";
1198       pr "\n";
1199       pr "  r = guestfs___recv (g, \"%s\", &hdr, &err,\n        " shortname;
1200       if not has_ret then
1201         pr "NULL, NULL"
1202       else
1203         pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
1204       pr ");\n";
1205
1206       pr "  if (r == -1) {\n";
1207       pr "    guestfs___end_busy (g);\n";
1208       trace_return_error ~indent:4 shortname style errcode;
1209       pr "    return %s;\n" (string_of_errcode errcode);
1210       pr "  }\n";
1211       pr "\n";
1212
1213       pr "  if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
1214         (String.uppercase shortname);
1215       pr "    guestfs___end_busy (g);\n";
1216       trace_return_error ~indent:4 shortname style errcode;
1217       pr "    return %s;\n" (string_of_errcode errcode);
1218       pr "  }\n";
1219       pr "\n";
1220
1221       pr "  if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
1222       trace_return_error ~indent:4 shortname style errcode;
1223       pr "    int errnum = 0;\n";
1224       pr "    if (err.errno_string[0] != '\\0')\n";
1225       pr "      errnum = guestfs___string_to_errno (err.errno_string);\n";
1226       pr "    if (errnum <= 0)\n";
1227       pr "      error (g, \"%%s: %%s\", \"%s\", err.error_message);\n"
1228         shortname;
1229       pr "    else\n";
1230       pr "      guestfs_error_errno (g, errnum, \"%%s: %%s\", \"%s\",\n"
1231         shortname;
1232       pr "                           err.error_message);\n";
1233       pr "    free (err.error_message);\n";
1234       pr "    free (err.errno_string);\n";
1235       pr "    guestfs___end_busy (g);\n";
1236       pr "    return %s;\n" (string_of_errcode errcode);
1237       pr "  }\n";
1238       pr "\n";
1239
1240       (* Expecting to receive further files (FileOut)? *)
1241       List.iter (
1242         function
1243         | FileOut n ->
1244             pr "  if (guestfs___recv_file (g, %s) == -1) {\n" n;
1245             pr "    guestfs___end_busy (g);\n";
1246             trace_return_error ~indent:4 shortname style errcode;
1247             pr "    return %s;\n" (string_of_errcode errcode);
1248             pr "  }\n";
1249             pr "\n";
1250         | _ -> ()
1251       ) args;
1252
1253       pr "  guestfs___end_busy (g);\n";
1254
1255       (match ret with
1256        | RErr ->
1257            pr "  ret_v = 0;\n"
1258        | RInt n | RInt64 n | RBool n ->
1259            pr "  ret_v = ret.%s;\n" n
1260        | RConstString _ | RConstOptString _ ->
1261            failwithf "RConstString|RConstOptString cannot be used by daemon functions"
1262        | RString n ->
1263            pr "  ret_v = ret.%s; /* caller will free */\n" n
1264        | RStringList n | RHashtable n ->
1265            pr "  /* caller will free this, but we need to add a NULL entry */\n";
1266            pr "  ret.%s.%s_val =\n" n n;
1267            pr "    safe_realloc (g, ret.%s.%s_val,\n" n n;
1268            pr "                  sizeof (char *) * (ret.%s.%s_len + 1));\n"
1269              n n;
1270            pr "  ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
1271            pr "  ret_v = ret.%s.%s_val;\n" n n
1272        | RStruct (n, _) ->
1273            pr "  /* caller will free this */\n";
1274            pr "  ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
1275        | RStructList (n, _) ->
1276            pr "  /* caller will free this */\n";
1277            pr "  ret_v = safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
1278        | RBufferOut n ->
1279            pr "  /* RBufferOut is tricky: If the buffer is zero-length, then\n";
1280            pr "   * _val might be NULL here.  To make the API saner for\n";
1281            pr "   * callers, we turn this case into a unique pointer (using\n";
1282            pr "   * malloc(1)).\n";
1283            pr "   */\n";
1284            pr "  if (ret.%s.%s_len > 0) {\n" n n;
1285            pr "    *size_r = ret.%s.%s_len;\n" n n;
1286            pr "    ret_v = ret.%s.%s_val; /* caller will free */\n" n n;
1287            pr "  } else {\n";
1288            pr "    free (ret.%s.%s_val);\n" n n;
1289            pr "    char *p = safe_malloc (g, 1);\n";
1290            pr "    *size_r = ret.%s.%s_len;\n" n n;
1291            pr "    ret_v = p;\n";
1292            pr "  }\n";
1293       );
1294       trace_return shortname style "ret_v";
1295       pr "  return ret_v;\n";
1296       pr "}\n\n"
1297   ) daemon_functions;
1298
1299   (* Functions to free structures. *)
1300   pr "/* Structure-freeing functions.  These rely on the fact that the\n";
1301   pr " * structure format is identical to the XDR format.  See note in\n";
1302   pr " * generator.ml.\n";
1303   pr " */\n";
1304   pr "\n";
1305
1306   List.iter (
1307     fun (typ, _) ->
1308       pr "void\n";
1309       pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
1310       pr "{\n";
1311       pr "  xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
1312       pr "  free (x);\n";
1313       pr "}\n";
1314       pr "\n";
1315
1316       pr "void\n";
1317       pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
1318       pr "{\n";
1319       pr "  xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
1320       pr "  free (x);\n";
1321       pr "}\n";
1322       pr "\n";
1323
1324   ) structs;
1325
1326   (* Functions which have optional arguments have two generated variants. *)
1327   List.iter (
1328     function
1329     | shortname, (ret, args, (_::_ as optargs) as style), _, _, _, _, _ ->
1330         let uc_shortname = String.uppercase shortname in
1331
1332         (* Get the name of the last regular argument. *)
1333         let last_arg =
1334           match args with
1335           | [] -> "g"
1336           | args -> name_of_argt (List.hd (List.rev args)) in
1337
1338         let rtype =
1339           match ret with
1340           | RErr | RInt _ | RBool _ -> "int "
1341           | RInt64 _ -> "int64_t "
1342           | RConstString _ | RConstOptString _ -> "const char *"
1343           | RString _ | RBufferOut _ -> "char *"
1344           | RStringList _ | RHashtable _ -> "char **"
1345           | RStruct (_, typ) -> sprintf "struct guestfs_%s *" typ
1346           | RStructList (_, typ) ->
1347               sprintf "struct guestfs_%s_list *" typ in
1348
1349         (* The regular variable args function, just calls the _va variant. *)
1350         generate_prototype ~extern:false ~semicolon:false ~newline:true
1351           ~handle:"g" ~prefix:"guestfs_" shortname style;
1352         pr "{\n";
1353         pr "  va_list optargs;\n";
1354         pr "\n";
1355         pr "  va_start (optargs, %s);\n" last_arg;
1356         pr "  %sr = guestfs_%s_va " rtype shortname;
1357         generate_c_call_args ~handle:"g" style;
1358         pr ";\n";
1359         pr "  va_end (optargs);\n";
1360         pr "\n";
1361         pr "  return r;\n";
1362         pr "}\n\n";
1363
1364         generate_prototype ~extern:false ~semicolon:false ~newline:true
1365           ~handle:"g" ~prefix:"guestfs_" ~suffix:"_va" ~optarg_proto:VA
1366           shortname style;
1367         pr "{\n";
1368         pr "  struct guestfs_%s_argv optargs_s;\n" shortname;
1369         pr "  struct guestfs_%s_argv *optargs = &optargs_s;\n" shortname;
1370         pr "  int i;\n";
1371         pr "\n";
1372         pr "  optargs_s.bitmask = 0;\n";
1373         pr "\n";
1374         pr "  while ((i = va_arg (args, int)) >= 0) {\n";
1375         pr "    switch (i) {\n";
1376
1377         List.iter (
1378           fun argt ->
1379             let n = name_of_argt argt in
1380             let uc_n = String.uppercase n in
1381             pr "    case GUESTFS_%s_%s:\n" uc_shortname uc_n;
1382             pr "      optargs_s.%s = va_arg (args, " n;
1383             (match argt with
1384              | Bool _ | Int _ -> pr "int"
1385              | Int64 _ -> pr "int64_t"
1386              | String _ -> pr "const char *"
1387              | _ -> assert false
1388             );
1389             pr ");\n";
1390             pr "      break;\n";
1391         ) optargs;
1392
1393         let errcode =
1394           match errcode_of_ret ret with
1395           | `CannotReturnError -> assert false
1396           | (`ErrorIsMinusOne | `ErrorIsNULL) as e -> e in
1397
1398         pr "    default:\n";
1399         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";
1400         pr "             \"%s\", i);\n" shortname;
1401         pr "      return %s;\n" (string_of_errcode errcode);
1402         pr "    }\n";
1403         pr "\n";
1404         pr "    uint64_t i_mask = UINT64_C(1) << i;\n";
1405         pr "    if (optargs_s.bitmask & i_mask) {\n";
1406         pr "      error (g, \"%%s: same optional argument specified more than once\",\n";
1407         pr "             \"%s\");\n" shortname;
1408         pr "      return %s;\n" (string_of_errcode errcode);
1409         pr "    }\n";
1410         pr "    optargs_s.bitmask |= i_mask;\n";
1411         pr "  }\n";
1412         pr "\n";
1413         pr "  return guestfs_%s_argv " shortname;
1414         generate_c_call_args ~handle:"g" style;
1415         pr ";\n";
1416         pr "}\n\n"
1417     | _ -> ()
1418   ) all_functions_sorted
1419
1420 (* Generate the linker script which controls the visibility of
1421  * symbols in the public ABI and ensures no other symbols get
1422  * exported accidentally.
1423  *)
1424 and generate_linker_script () =
1425   generate_header HashStyle GPLv2plus;
1426
1427   let globals = [
1428     "guestfs_create";
1429     "guestfs_close";
1430     "guestfs_delete_event_callback";
1431     "guestfs_first_private";
1432     "guestfs_get_error_handler";
1433     "guestfs_get_out_of_memory_handler";
1434     "guestfs_get_private";
1435     "guestfs_last_errno";
1436     "guestfs_last_error";
1437     "guestfs_next_private";
1438     "guestfs_set_close_callback";
1439     "guestfs_set_error_handler";
1440     "guestfs_set_event_callback";
1441     "guestfs_set_launch_done_callback";
1442     "guestfs_set_log_message_callback";
1443     "guestfs_set_out_of_memory_handler";
1444     "guestfs_set_private";
1445     "guestfs_set_progress_callback";
1446     "guestfs_set_subprocess_quit_callback";
1447
1448     (* Unofficial parts of the API: the bindings code use these
1449      * functions, so it is useful to export them.
1450      *)
1451     "guestfs_safe_calloc";
1452     "guestfs_safe_malloc";
1453     "guestfs_safe_strdup";
1454     "guestfs_safe_memdup";
1455     "guestfs_tmpdir";
1456     "guestfs___for_each_disk";
1457   ] in
1458   let functions =
1459     List.flatten (
1460       List.map (
1461         function
1462         | name, (_, _, []), _, _, _, _, _ -> ["guestfs_" ^ name]
1463         | name, (_, _, _), _, _, _, _, _ ->
1464             ["guestfs_" ^ name;
1465              "guestfs_" ^ name ^ "_va";
1466              "guestfs_" ^ name ^ "_argv"]
1467       ) all_functions
1468     ) in
1469   let structs =
1470     List.concat (
1471       List.map (fun (typ, _) ->
1472                   ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
1473         structs
1474     ) in
1475   let globals = List.sort compare (globals @ functions @ structs) in
1476
1477   pr "{\n";
1478   pr "    global:\n";
1479   List.iter (pr "        %s;\n") globals;
1480   pr "\n";
1481
1482   pr "    local:\n";
1483   pr "        *;\n";
1484   pr "};\n"
1485
1486 and generate_max_proc_nr () =
1487   pr "%d\n" max_proc_nr