X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=src%2Fgenerator.ml;h=4653d65cfdc219bf3434bc1fbad4d20ad99ce9fd;hp=c20e43fcc30de8401a633b047ececbc86a8bfd7f;hb=05712b2457a44ee0f0020eced77db03c2aa419a1;hpb=0c2376a5c05053ce6a0479ade544be860c400fdb diff --git a/src/generator.ml b/src/generator.ml index c20e43f..4653d65 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -43,9 +43,15 @@ and ret = *) | RErr (* "RInt" as a return value means an int which is -1 for error - * or any value >= 0 on success. + * or any value >= 0 on success. Only use this for smallish + * positive ints (0 <= i < 2^30). *) | RInt of string + (* "RInt64" is the same as RInt, but is guaranteed to be able + * to return a full 64 bit value, _except_ that -1 means error + * (so -1 cannot be a valid, non-error return value). + *) + | RInt64 of string (* "RBool" is a bool return value which can be true/false or * -1 for error. *) @@ -908,12 +914,24 @@ pass C as a single element list, when the single element being the string C<,> (comma)."); ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning], - [InitEmpty, TestOutput ( - [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","]; - ["mkfs"; "ext2"; "/dev/sda1"]; - ["mount"; "/dev/sda1"; "/"]; - ["write_file"; "/new"; "new file contents"; "0"]; - ["cat"; "/new"]], "new file contents")], + [InitBasicFS, TestOutput ( + [["write_file"; "/new"; "new file contents"; "0"]; + ["cat"; "/new"]], "new file contents"); + InitBasicFS, TestOutput ( + [["write_file"; "/new"; "\nnew file contents\n"; "0"]; + ["cat"; "/new"]], "\nnew file contents\n"); + InitBasicFS, TestOutput ( + [["write_file"; "/new"; "\n\n"; "0"]; + ["cat"; "/new"]], "\n\n"); + InitBasicFS, TestOutput ( + [["write_file"; "/new"; ""; "0"]; + ["cat"; "/new"]], ""); + InitBasicFS, TestOutput ( + [["write_file"; "/new"; "\n\n\n"; "0"]; + ["cat"; "/new"]], "\n\n\n"); + InitBasicFS, TestOutput ( + [["write_file"; "/new"; "\n"; "0"]; + ["cat"; "/new"]], "\n")], "create a file", "\ This call creates a file called C. The contents of the @@ -1069,6 +1087,117 @@ manpage for more details. The list of fields returned isn't clearly defined, and depends on both the version of C that libguestfs was built against, and the filesystem itself."); + ("blockdev_setro", (RErr, [String "device"]), 56, [], + [InitEmpty, TestOutputTrue ( + [["blockdev_setro"; "/dev/sda"]; + ["blockdev_getro"; "/dev/sda"]])], + "set block device to read-only", + "\ +Sets the block device named C to read-only. + +This uses the L command."); + + ("blockdev_setrw", (RErr, [String "device"]), 57, [], + [InitEmpty, TestOutputFalse ( + [["blockdev_setrw"; "/dev/sda"]; + ["blockdev_getro"; "/dev/sda"]])], + "set block device to read-write", + "\ +Sets the block device named C to read-write. + +This uses the L command."); + + ("blockdev_getro", (RBool "ro", [String "device"]), 58, [], + [InitEmpty, TestOutputTrue ( + [["blockdev_setro"; "/dev/sda"]; + ["blockdev_getro"; "/dev/sda"]])], + "is block device set to read-only", + "\ +Returns a boolean indicating if the block device is read-only +(true if read-only, false if not). + +This uses the L command."); + + ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [], + [InitEmpty, TestOutputInt ( + [["blockdev_getss"; "/dev/sda"]], 512)], + "get sectorsize of block device", + "\ +This returns the size of sectors on a block device. +Usually 512, but can be larger for modern devices. + +(Note, this is not the size in sectors, use C +for that). + +This uses the L command."); + + ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [], + [InitEmpty, TestOutputInt ( + [["blockdev_getbsz"; "/dev/sda"]], 4096)], + "get blocksize of block device", + "\ +This returns the block size of a device. + +(Note this is different from both I and +I). + +This uses the L command."); + + ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [], + [], (* XXX test *) + "set blocksize of block device", + "\ +This sets the block size of a device. + +(Note this is different from both I and +I). + +This uses the L command."); + + ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [], + [InitEmpty, TestOutputInt ( + [["blockdev_getsz"; "/dev/sda"]], 1024000)], + "get total size of device in 512-byte sectors", + "\ +This returns the size of the device in units of 512-byte sectors +(even if the sectorsize isn't 512 bytes ... weird). + +See also C for the real sector size of +the device, and C for the more +useful I. + +This uses the L command."); + + ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [], + [InitEmpty, TestOutputInt ( + [["blockdev_getsize64"; "/dev/sda"]], 524288000)], + "get total size of device in bytes", + "\ +This returns the size of the device in bytes. + +See also C. + +This uses the L command."); + + ("blockdev_flushbufs", (RErr, [String "device"]), 64, [], + [InitEmpty, TestRun + [["blockdev_flushbufs"; "/dev/sda"]]], + "flush device buffers", + "\ +This tells the kernel to flush internal buffers associated +with C. + +This uses the L command."); + + ("blockdev_rereadpt", (RErr, [String "device"]), 65, [], + [InitEmpty, TestRun + [["blockdev_rereadpt"; "/dev/sda"]]], + "reread partition table", + "\ +Reread the partition table on C. + +This uses the L command."); + ] let all_functions = non_daemon_functions @ daemon_functions @@ -1258,6 +1387,12 @@ let mapi f xs = let name_of_argt = function | String n | OptString n | StringList n | Bool n | Int n -> n +let seq_of_test = function + | TestRun s | TestOutput (s, _) | TestOutputList (s, _) + | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s + | TestOutputLength (s, _) | TestOutputStruct (s, _) + | TestLastFail s -> s + (* Check function names etc. for consistency. *) let check_functions () = let contains_uppercase str = @@ -1303,7 +1438,7 @@ let check_functions () = (match fst style with | RErr -> () - | RInt n | RBool n | RConstString n | RString n + | RInt n | RInt64 n | RBool n | RConstString n | RString n | RStringList n | RPVList n | RVGList n | RLVList n | RStat n | RStatVFS n | RHashtable n -> @@ -1359,7 +1494,31 @@ let check_functions () = failwithf "%s and %s have conflicting procedure numbers (%d, %d)" name1 name2 nr1 nr2 in - loop proc_nrs + loop proc_nrs; + + (* Check tests. *) + List.iter ( + function + (* Ignore functions that have no tests. We generate a + * warning when the user does 'make check' instead. + *) + | name, _, _, _, [], _, _ -> () + | name, _, _, _, tests, _, _ -> + let funcs = + List.map ( + fun (_, test) -> + match seq_of_test test with + | [] -> + failwithf "%s has a test containing an empty sequence" name + | cmds -> List.map List.hd cmds + ) tests in + let funcs = List.flatten funcs in + + let tested = List.mem name funcs in + + if not tested then + failwithf "function %s has tests but does not test itself" name + ) all_functions (* 'pr' prints to the current output file. *) let chan = ref stdout @@ -1435,6 +1594,8 @@ let rec generate_actions_pod () = pr "This function returns 0 on success or -1 on error.\n\n" | RInt _ -> pr "On error this function returns -1.\n\n" + | RInt64 _ -> + pr "On error this function returns -1.\n\n" | RBool _ -> pr "This function returns a C truth value on success or -1 on error.\n\n" | RConstString _ -> @@ -1588,6 +1749,10 @@ and generate_xdr () = pr "struct %s_ret {\n" name; pr " int %s;\n" n; pr "};\n\n" + | RInt64 n -> + pr "struct %s_ret {\n" name; + pr " hyper %s;\n" n; + pr "};\n\n" | RBool n -> pr "struct %s_ret {\n" name; pr " bool %s;\n" n; @@ -1772,7 +1937,7 @@ and generate_client_actions () = | RErr -> () | RConstString _ -> failwithf "RConstString cannot be returned from a daemon function" - | RInt _ + | RInt _ | RInt64 _ | RBool _ | RString _ | RStringList _ | RIntBool _ | RPVList _ | RVGList _ | RLVList _ @@ -1803,7 +1968,7 @@ and generate_client_actions () = | RErr -> () | RConstString _ -> failwithf "RConstString cannot be returned from a daemon function" - | RInt _ + | RInt _ | RInt64 _ | RBool _ | RString _ | RStringList _ | RIntBool _ | RPVList _ | RVGList _ | RLVList _ @@ -1826,7 +1991,7 @@ and generate_client_actions () = let error_code = match fst style with - | RErr | RInt _ | RBool _ -> "-1" + | RErr | RInt _ | RInt64 _ | RBool _ -> "-1" | RConstString _ -> failwithf "RConstString cannot be returned from a daemon function" | RString _ | RStringList _ | RIntBool _ @@ -1908,8 +2073,8 @@ and generate_client_actions () = (match fst style with | RErr -> pr " return 0;\n" - | RInt n - | RBool n -> pr " return rv.ret.%s;\n" n + | RInt n | RInt64 n | RBool n -> + pr " return rv.ret.%s;\n" n | RConstString _ -> failwithf "RConstString cannot be returned from a daemon function" | RString n -> @@ -1975,6 +2140,7 @@ and generate_daemon_actions () = let error_code = match fst style with | RErr | RInt _ -> pr " int r;\n"; "-1" + | RInt64 _ -> pr " int64_t r;\n"; "-1" | RBool _ -> pr " int r;\n"; "-1" | RConstString _ -> failwithf "RConstString cannot be returned from a daemon function" @@ -2036,11 +2202,7 @@ and generate_daemon_actions () = (match fst style with | RErr -> pr " reply (NULL, NULL);\n" - | RInt n -> - pr " struct guestfs_%s_ret ret;\n" name; - pr " ret.%s = r;\n" n; - pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n" name - | RBool n -> + | RInt n | RInt64 n | RBool n -> pr " struct guestfs_%s_ret ret;\n" name; pr " ret.%s = r;\n" n; pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n" name @@ -2295,6 +2457,7 @@ static void print_strings (char * const * const argv) printf (\"\\t%%s\\n\", argv[argc]); } +/* static void print_table (char * const * const argv) { int i; @@ -2302,14 +2465,32 @@ static void print_table (char * const * const argv) for (i = 0; argv[i] != NULL; i += 2) printf (\"%%s: %%s\\n\", argv[i], argv[i+1]); } +*/ +static void no_test_warnings (void) +{ "; + List.iter ( + function + | name, _, _, _, [], _, _ -> + pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name + | name, _, _, _, tests, _, _ -> () + ) all_functions; + + pr "}\n"; + pr "\n"; + + (* Generate the actual tests. Note that we generate the tests + * in reverse order, deliberately, so that (in general) the + * newest tests run first. This makes it quicker and easier to + * debug them. + *) let test_names = List.map ( fun (name, _, _, _, tests, _, _) -> mapi (generate_one_test name) tests - ) all_functions in + ) (List.rev all_functions) in let test_names = List.concat test_names in let nr_tests = List.length test_names in @@ -2321,7 +2502,9 @@ int main (int argc, char *argv[]) const char *srcdir; int fd; char buf[256]; - int nr_tests; + int nr_tests, test_num = 0; + + no_test_warnings (); g = guestfs_create (); if (g == NULL) { @@ -2429,11 +2612,13 @@ int main (int argc, char *argv[]) } nr_tests = %d; + " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests; iteri ( fun i test_name -> - pr " printf (\"%3d/%%3d %s\\n\", nr_tests);\n" (i+1) test_name; + pr " test_num++;\n"; + pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name; pr " if (%s () == -1) {\n" test_name; pr " printf (\"%s FAILED\\n\");\n" test_name; pr " failed++;\n"; @@ -2548,8 +2733,9 @@ and generate_one_test name i (init, test) = let seq, last = get_seq_last seq in let test () = pr " if (r != %d) {\n" expected; - pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\", r);\n" + pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\"," test_name expected; + pr " (int) r);\n"; pr " return -1;\n"; pr " }\n" in @@ -2691,6 +2877,7 @@ and generate_test_command_call ?(expect_error = false) ?test test_name cmd = let error_code = match fst style with | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1" + | RInt64 _ -> pr " int64_t r;\n"; "-1" | RConstString _ -> pr " const char *r;\n"; "NULL" | RString _ -> pr " char *r;\n"; "NULL" | RStringList _ | RHashtable _ -> @@ -2745,7 +2932,7 @@ and generate_test_command_call ?(expect_error = false) ?test test_name cmd = ); (match fst style with - | RErr | RInt _ | RBool _ | RConstString _ -> () + | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> () | RString _ -> pr " free (r);\n" | RStringList _ | RHashtable _ -> pr " for (i = 0; r[i] != NULL; ++i)\n"; @@ -2924,6 +3111,7 @@ and generate_fish_cmds () = | RErr | RInt _ | RBool _ -> pr " int r;\n" + | RInt64 _ -> pr " int64_t r;\n" | RConstString _ -> pr " const char *r;\n" | RString _ -> pr " char *r;\n" | RStringList _ | RHashtable _ -> pr " char **r;\n" @@ -2979,7 +3167,11 @@ and generate_fish_cmds () = | RErr -> pr " return r;\n" | RInt _ -> pr " if (r == -1) return -1;\n"; - pr " if (r) printf (\"%%d\\n\", r);\n"; + pr " printf (\"%%d\\n\", r);\n"; + pr " return 0;\n" + | RInt64 _ -> + pr " if (r == -1) return -1;\n"; + pr " printf (\"%%\" PRIi64 \"\\n\", r);\n"; pr " return 0;\n" | RBool _ -> pr " if (r == -1) return -1;\n"; @@ -3198,6 +3390,7 @@ and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true) (match fst style with | RErr -> pr "int " | RInt _ -> pr "int " + | RInt64 _ -> pr "int64_t " | RBool _ -> pr "int " | RConstString _ -> pr "const char *" | RString _ -> pr "char *" @@ -3513,6 +3706,7 @@ copy_table (char * const * argv) match fst style with | RErr -> pr " int r;\n"; "-1" | RInt _ -> pr " int r;\n"; "-1" + | RInt64 _ -> pr " int64_t r;\n"; "-1" | RBool _ -> pr " int r;\n"; "-1" | RConstString _ -> pr " const char *r;\n"; "NULL" | RString _ -> pr " char *r;\n"; "NULL" @@ -3558,6 +3752,8 @@ copy_table (char * const * argv) (match fst style with | RErr -> pr " rv = Val_unit;\n" | RInt _ -> pr " rv = Val_int (r);\n" + | RInt64 _ -> + pr " rv = caml_copy_int64 (r);\n" | RBool _ -> pr " rv = Val_bool (r);\n" | RConstString _ -> pr " rv = caml_copy_string (r);\n" | RString _ -> @@ -3651,6 +3847,7 @@ and generate_ocaml_prototype ?(is_external = false) name style = (match fst style with | RErr -> pr "unit" (* all errors are turned into exceptions *) | RInt _ -> pr "int" + | RInt64 _ -> pr "int64" | RBool _ -> pr "bool" | RConstString _ -> pr "string" | RString _ -> pr "string" @@ -3767,6 +3964,7 @@ DESTROY (g) (match fst style with | RErr -> pr "void\n" | RInt _ -> pr "SV *\n" + | RInt64 _ -> pr "SV *\n" | RBool _ -> pr "SV *\n" | RConstString _ -> pr "SV *\n" | RString _ -> pr "SV *\n" @@ -3828,6 +4026,19 @@ DESTROY (g) pr " RETVAL = newSViv (%s);\n" n; pr " OUTPUT:\n"; pr " RETVAL\n" + | RInt64 n -> + pr "PREINIT:\n"; + pr " int64_t %s;\n" n; + pr " CODE:\n"; + pr " %s = guestfs_%s " n name; + generate_call_args ~handle:"g" style; + pr ";\n"; + do_cleanups (); + pr " if (%s == -1)\n" n; + pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " RETVAL = my_newSVll (%s);\n" n; + pr " OUTPUT:\n"; + pr " RETVAL\n" | RConstString n -> pr "PREINIT:\n"; pr " const char *%s;\n" n; @@ -4082,6 +4293,7 @@ and generate_perl_prototype name style = | RErr -> () | RBool n | RInt n + | RInt64 n | RConstString n | RString n -> pr "$%s = " n | RIntBool (n, m) -> pr "($%s, $%s) = " n m @@ -4339,6 +4551,7 @@ py_guestfs_close (PyObject *self, PyObject *args) let error_code = match fst style with | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1" + | RInt64 _ -> pr " int64_t r;\n"; "-1" | RConstString _ -> pr " const char *r;\n"; "NULL" | RString _ -> pr " char *r;\n"; "NULL" | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL" @@ -4420,6 +4633,7 @@ py_guestfs_close (PyObject *self, PyObject *args) pr " py_r = Py_None;\n" | RInt _ | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n" + | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n" | RConstString _ -> pr " py_r = PyString_FromString (r);\n" | RString _ -> pr " py_r = PyString_FromString (r);\n";