generator/generator_c.ml

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