Revert "Fix checking of generator being run from the right directory."

[libguestfs.git] / src / generator.ml

diff --git a/src/generator.ml b/src/generator.ml
index 7c0e566..2446299 100755 (executable)
--- a/src/generator.ml
+++ b/src/generator.ml
@@ -24,8 +24,10 @@
  * this one to describe the interface (see the big table below), and
  * daemon/<somefile>.c to write the implementation.
  *
  * this one to describe the interface (see the big table below), and
  * daemon/<somefile>.c to write the implementation.
  *

- * After editing this file, run it (./src/generator.ml) to regenerate
- * all the output files.
+ * After editing this file, run it (./src/generator.ml) to regenerate all the
+ * output files. Note that if you are using a separate build directory you must
+ * run generator.ml from your top level build directory. You must also have run
+ * configure before generator.ml will run.

  *
  * IMPORTANT: This script should NOT print any warnings.  If it prints
  * warnings, you should treat them as errors.
  *
  * IMPORTANT: This script should NOT print any warnings.  If it prints
  * warnings, you should treat them as errors.


@@ -84,6 +86,16 @@ and ret =
      * inefficient.  Keys should be unique.  NULLs are not permitted.
      *)
   | RHashtable of string
      * inefficient.  Keys should be unique.  NULLs are not permitted.
      *)
   | RHashtable of string

+(* Not implemented:
+    (* "RBufferOut" is handled almost exactly like RString, but
+     * it allows the string to contain arbitrary 8 bit data including
+     * ASCII NUL.  In the C API this causes an implicit extra parameter
+     * to be added of type <size_t *size_r>.  Other programming languages
+     * support strings with arbitrary 8 bit data.  At the RPC layer
+     * we have to use the opaque<> type instead of string<>.
+     *)
+  | RBufferOut of string
+*)

 
 and args = argt list   (* Function parameters, guestfs handle is implicit. *)
 
 
 and args = argt list   (* Function parameters, guestfs handle is implicit. *)
 


@@ -110,6 +122,18 @@ and argt =
      *)
   | FileIn of string
   | FileOut of string
      *)
   | FileIn of string
   | FileOut of string

+(* Not implemented:
+    (* Opaque buffer which can contain arbitrary 8 bit data.
+     * In the C API, this is expressed as <char *, int> pair.
+     * Most other languages have a string type which can contain
+     * ASCII NUL.  We use whatever type is appropriate for each
+     * language.
+     * Buffers are limited by the total message size.  To transfer
+     * large blocks of data, use FileIn/FileOut parameters instead.
+     * To return an arbitrary buffer, use RBufferOut.
+     *)
+  | BufferIn of string
+*)

 
 type flags =
   | ProtocolLimitWarning  (* display warning about protocol size limits *)
 
 type flags =
   | ProtocolLimitWarning  (* display warning about protocol size limits *)


@@ -183,6 +207,10 @@ and test =
      *)
   | TestOutputInt of seq * int
     (* Run the command sequence and expect the output of the final
      *)
   | TestOutputInt of seq * int
     (* Run the command sequence and expect the output of the final

+     * command to be <op> <int>, eg. ">=", "1".
+     *)
+  | TestOutputIntOp of seq * string * int
+    (* Run the command sequence and expect the output of the final

      * command to be a true value (!= 0 or != NULL).
      *)
   | TestOutputTrue of seq
      * command to be a true value (!= 0 or != NULL).
      *)
   | TestOutputTrue of seq


@@ -206,6 +234,7 @@ and test =
 
 and test_field_compare =
   | CompareWithInt of string * int
 
 and test_field_compare =
   | CompareWithInt of string * int

+  | CompareWithIntOp of string * string * int

   | CompareWithString of string * string
   | CompareFieldsIntEq of string * string
   | CompareFieldsStrEq of string * string
   | CompareWithString of string * string
   | CompareFieldsIntEq of string * string
   | CompareFieldsStrEq of string * string


@@ -442,7 +471,8 @@ environment variable.
 Setting C<qemu> to C<NULL> restores the default qemu binary.");
 
   ("get_qemu", (RConstString "qemu", []), -1, [],
 Setting C<qemu> to C<NULL> restores the default qemu binary.");
 
   ("get_qemu", (RConstString "qemu", []), -1, [],

-   [],
+   [InitNone, Always, TestRun (
+      [["get_qemu"]])],

    "get the qemu binary",
    "\
 Return the current qemu binary.
    "get the qemu binary",
    "\
 Return the current qemu binary.


@@ -462,7 +492,8 @@ C<LIBGUESTFS_PATH> environment variable.
 Setting C<path> to C<NULL> restores the default path.");
 
   ("get_path", (RConstString "path", []), -1, [],
 Setting C<path> to C<NULL> restores the default path.");
 
   ("get_path", (RConstString "path", []), -1, [],

-   [],
+   [InitNone, Always, TestRun (
+      [["get_path"]])],

    "get the search path",
    "\
 Return the current search path.
    "get the search path",
    "\
 Return the current search path.


@@ -484,6 +515,10 @@ Setting C<append> to C<NULL> means I<no> additional options
 are passed (libguestfs always adds a few of its own).");
 
   ("get_append", (RConstString "append", []), -1, [],
 are passed (libguestfs always adds a few of its own).");
 
   ("get_append", (RConstString "append", []), -1, [],

+   (* This cannot be tested with the current framework.  The
+    * function can return NULL in normal operations, which the
+    * test framework interprets as an error.
+    *)

    [],
    "get the additional kernel options",
    "\
    [],
    "get the additional kernel options",
    "\


@@ -505,7 +540,8 @@ This is disabled by default (except in guestfish where it is
 enabled by default).");
 
   ("get_autosync", (RBool "autosync", []), -1, [],
 enabled by default).");
 
   ("get_autosync", (RBool "autosync", []), -1, [],

-   [],
+   [InitNone, Always, TestRun (
+      [["get_autosync"]])],

    "get autosync mode",
    "\
 Get the autosync flag.");
    "get autosync mode",
    "\
 Get the autosync flag.");


@@ -526,7 +562,8 @@ C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
 This returns the verbose messages flag.");
 
   ("is_ready", (RBool "ready", []), -1, [],
 This returns the verbose messages flag.");
 
   ("is_ready", (RBool "ready", []), -1, [],

-   [],
+   [InitNone, Always, TestOutputTrue (
+      [["is_ready"]])],

    "is ready to accept commands",
    "\
 This returns true iff this handle is ready to accept commands
    "is ready to accept commands",
    "\
 This returns true iff this handle is ready to accept commands


@@ -535,7 +572,8 @@ This returns true iff this handle is ready to accept commands
 For more information on states, see L<guestfs(3)>.");
 
   ("is_config", (RBool "config", []), -1, [],
 For more information on states, see L<guestfs(3)>.");
 
   ("is_config", (RBool "config", []), -1, [],

-   [],
+   [InitNone, Always, TestOutputFalse (
+      [["is_config"]])],

    "is in configuration state",
    "\
 This returns true iff this handle is being configured
    "is in configuration state",
    "\
 This returns true iff this handle is being configured


@@ -544,7 +582,8 @@ This returns true iff this handle is being configured
 For more information on states, see L<guestfs(3)>.");
 
   ("is_launching", (RBool "launching", []), -1, [],
 For more information on states, see L<guestfs(3)>.");
 
   ("is_launching", (RBool "launching", []), -1, [],

-   [],
+   [InitNone, Always, TestOutputFalse (
+      [["is_launching"]])],

    "is launching subprocess",
    "\
 This returns true iff this handle is launching the subprocess
    "is launching subprocess",
    "\
 This returns true iff this handle is launching the subprocess


@@ -553,7 +592,8 @@ This returns true iff this handle is launching the subprocess
 For more information on states, see L<guestfs(3)>.");
 
   ("is_busy", (RBool "busy", []), -1, [],
 For more information on states, see L<guestfs(3)>.");
 
   ("is_busy", (RBool "busy", []), -1, [],

-   [],
+   [InitNone, Always, TestOutputFalse (
+      [["is_busy"]])],

    "is busy processing a command",
    "\
 This returns true iff this handle is busy processing a command
    "is busy processing a command",
    "\
 This returns true iff this handle is busy processing a command


@@ -599,7 +639,9 @@ actions using the low-level API.
 For more information on states, see L<guestfs(3)>.");
 
   ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
 For more information on states, see L<guestfs(3)>.");
 
   ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],

-   [],
+   [InitNone, Always, TestOutputInt (
+      [["set_memsize"; "500"];
+       ["get_memsize"]], 500)],

    "set memory allocated to the qemu subprocess",
    "\
 This sets the memory size in megabytes allocated to the
    "set memory allocated to the qemu subprocess",
    "\
 This sets the memory size in megabytes allocated to the


@@ -614,7 +656,8 @@ For more information on the architecture of libguestfs,
 see L<guestfs(3)>.");
 
   ("get_memsize", (RInt "memsize", []), -1, [],
 see L<guestfs(3)>.");
 
   ("get_memsize", (RInt "memsize", []), -1, [],

-   [],
+   [InitNone, Always, TestOutputIntOp (
+      [["get_memsize"]], ">=", 256)],

    "get memory allocated to the qemu subprocess",
    "\
 This gets the memory size in megabytes allocated to the
    "get memory allocated to the qemu subprocess",
    "\
 This gets the memory size in megabytes allocated to the


@@ -628,7 +671,8 @@ For more information on the architecture of libguestfs,
 see L<guestfs(3)>.");
 
   ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
 see L<guestfs(3)>.");
 
   ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],

-   [],
+   [InitNone, Always, TestOutputIntOp (
+      [["get_pid"]], ">=", 1)],

    "get PID of qemu subprocess",
    "\
 Return the process ID of the qemu subprocess.  If there is no
    "get PID of qemu subprocess",
    "\
 Return the process ID of the qemu subprocess.  If there is no


@@ -636,6 +680,36 @@ qemu subprocess, then this will return an error.
 
 This is an internal call used for debugging and testing.");
 
 
 This is an internal call used for debugging and testing.");
 

+  ("version", (RStruct ("version", "version"), []), -1, [],
+   [InitNone, Always, TestOutputStruct (
+      [["version"]], [CompareWithInt ("major", 1)])],
+   "get the library version number",
+   "\
+Return the libguestfs version number that the program is linked
+against.
+
+Note that because of dynamic linking this is not necessarily
+the version of libguestfs that you compiled against.  You can
+compile the program, and then at runtime dynamically link
+against a completely different C<libguestfs.so> library.
+
+This call was added in version C<1.0.58>.  In previous
+versions of libguestfs there was no way to get the version
+number.  From C code you can use ELF weak linking tricks to find out if
+this symbol exists (if it doesn't, then it's an earlier version).
+
+The call returns a structure with four elements.  The first
+three (C<major>, C<minor> and C<release>) are numbers and
+correspond to the usual version triplet.  The fourth element
+(C<extra>) is a string and is normally empty, but may be
+used for distro-specific information.
+
+To construct the original version string:
+C<$major.$minor.$release$extra>
+
+I<Note:> Don't use this call to test for availability
+of features.  Distro backports makes this unreliable.");
+

 ]
 
 (* daemon_functions are any functions which cause some action
 ]
 
 (* daemon_functions are any functions which cause some action


@@ -2928,6 +3002,14 @@ let structs = [
     "ftyp", FChar;
     "name", FString;
   ];
     "ftyp", FChar;
     "name", FString;
   ];

+
+  (* Version numbers. *)
+  "version", [
+    "major", FInt64;
+    "minor", FInt64;
+    "release", FInt64;
+    "extra", FString;
+  ];

 ] (* end of structs *)
 
 (* Ugh, Java has to be different ..
 ] (* end of structs *)
 
 (* Ugh, Java has to be different ..


@@ -2940,7 +3022,8 @@ let java_structs = [
   "lvm_lv", "LV";
   "stat", "Stat";
   "statvfs", "StatVFS";
   "lvm_lv", "LV";
   "stat", "Stat";
   "statvfs", "StatVFS";

-  "dirent", "Dirent"
+  "dirent", "Dirent";
+  "version", "Version";

 ]
 
 (* Used for testing language bindings. *)
 ]
 
 (* Used for testing language bindings. *)


@@ -3091,7 +3174,8 @@ let cols_of_struct typ =
 let seq_of_test = function
   | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
   | TestOutputListOfDevices (s, _)
 let seq_of_test = function
   | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
   | TestOutputListOfDevices (s, _)

-  | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
+  | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
+  | TestOutputTrue s | TestOutputFalse s

   | TestOutputLength (s, _) | TestOutputStruct (s, _)
   | TestLastFail s -> s
 
   | TestOutputLength (s, _) | TestOutputStruct (s, _)
   | TestLastFail s -> s
 


@@ -4582,7 +4666,11 @@ static int %s (void)
 
 and generate_one_test_body name i test_name init test =
   (match init with
 
 and generate_one_test_body name i test_name init test =
   (match init with

-   | InitNone
+   | InitNone (* XXX at some point, InitNone and InitEmpty became
+              * folded together as the same thing.  Really we should
+              * make InitNone do nothing at all, but the tests may
+              * need to be checked to make sure this is OK.
+              *)

    | InitEmpty ->
        pr "  /* InitNone|InitEmpty for %s */\n" test_name;
        List.iter (generate_test_command_call test_name)
    | InitEmpty ->
        pr "  /* InitNone|InitEmpty for %s */\n" test_name;
        List.iter (generate_test_command_call test_name)


@@ -4708,6 +4796,19 @@ and generate_one_test_body name i test_name init test =
       in
       List.iter (generate_test_command_call test_name) seq;
       generate_test_command_call ~test test_name last
       in
       List.iter (generate_test_command_call test_name) seq;
       generate_test_command_call ~test test_name last

+  | TestOutputIntOp (seq, op, expected) ->
+      pr "  /* TestOutputIntOp for %s (%d) */\n" name i;
+      let seq, last = get_seq_last seq in
+      let test () =
+       pr "    if (! (r %s %d)) {\n" op expected;
+       pr "      fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
+         test_name op expected;
+       pr "               (int) r);\n";
+       pr "      return -1;\n";
+       pr "    }\n"
+      in
+      List.iter (generate_test_command_call test_name) seq;
+      generate_test_command_call ~test test_name last

   | TestOutputTrue seq ->
       pr "  /* TestOutputTrue for %s (%d) */\n" name i;
       let seq, last = get_seq_last seq in
   | TestOutputTrue seq ->
       pr "  /* TestOutputTrue for %s (%d) */\n" name i;
       let seq, last = get_seq_last seq in


@@ -4766,6 +4867,13 @@ and generate_one_test_body name i test_name init test =
              pr "               (int) r->%s);\n" field;
              pr "      return -1;\n";
              pr "    }\n"
              pr "               (int) r->%s);\n" field;
              pr "      return -1;\n";
              pr "    }\n"

+         | CompareWithIntOp (field, op, expected) ->
+             pr "    if (!(r->%s %s %d)) {\n" field op expected;
+             pr "      fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
+               test_name field op expected;
+             pr "               (int) r->%s);\n" field;
+             pr "      return -1;\n";
+             pr "    }\n"

          | CompareWithString (field, expected) ->
              pr "    if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
              pr "      fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
          | CompareWithString (field, expected) ->
              pr "    if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
              pr "      fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"


@@ -8106,7 +8214,7 @@ let output_to filename =
 let () =
   check_functions ();
 
 let () =
   check_functions ();
 

-  if not (Sys.file_exists "HACKING") then (
+  if not (Sys.file_exists "config.status") then (

     eprintf "\
 You are probably running this from the wrong directory.
 Run it from the top source directory using the command
     eprintf "\
 You are probably running this from the wrong directory.
 Run it from the top source directory using the command