Skip to content

Commit

Permalink
generator: Add an explicit Cancellable flag
Browse files Browse the repository at this point in the history 
Currently any api which takes a FileIn or FileOut parameter is implicitly
cancellable. This change make cancellable an explicit flag in anticipation of it
being added to other apis.

Note that a Cancellable function must be able to return an error, which means it
can't return RConstOptString.
  • Loading branch information
@mdbooth
mdbooth committed Jan 16, 2012
1 parent c00b6a0 commit a5f0ddb
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 19 deletions.
53 changes: 35 additions & 18 deletions generator/generator_actions.ml
View file
Expand Up @@ -58,7 +58,7 @@ let test_all_rets = [
]

let test_functions = [
("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs; Cancellable],
[],
"internal test function - do not use",
"\
Expand Down Expand Up @@ -2714,7 +2714,8 @@ Reread the partition table on C<device>.
This uses the L<blockdev(8)> command.");

("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66,
[Progress; Cancellable],
[InitScratchFS, Always, TestOutput (
(* Pick a file from cwd which isn't likely to change. *)
[["mkdir"; "/upload"];
Expand All @@ -2730,7 +2731,8 @@ C<filename> can also be a named pipe.
See also C<guestfs_download>.");

("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67,
[Progress; Cancellable],
[InitScratchFS, Always, TestOutput (
(* Pick a file from cwd which isn't likely to change. *)
[["mkdir"; "/download"];
Expand Down Expand Up @@ -2815,7 +2817,8 @@ To get the checksum for a device, use C<guestfs_checksum_device>.
To get the checksums for many files, use C<guestfs_checksums_out>.");

("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69,
[Cancellable],
[InitScratchFS, Always, TestOutput (
[["mkdir"; "/tar_in"];
["tar_in"; "../data/helloworld.tar"; "/tar_in"];
Expand All @@ -2828,7 +2831,8 @@ I<uncompressed> tar file) into C<directory>.
To upload a compressed tarball, use C<guestfs_tgz_in>
or C<guestfs_txz_in>.");

("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70,
[Cancellable],
[],
"pack directory into tarfile",
"\
Expand All @@ -2838,7 +2842,8 @@ it to local file C<tarfile>.
To download a compressed tarball, use C<guestfs_tgz_out>
or C<guestfs_txz_out>.");

("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71,
[Cancellable],
[InitScratchFS, Always, TestOutput (
[["mkdir"; "/tgz_in"];
["tgz_in"; "../data/helloworld.tar.gz"; "/tgz_in"];
Expand All @@ -2850,7 +2855,8 @@ I<gzip compressed> tar file) into C<directory>.
To upload an uncompressed tarball, use C<guestfs_tar_in>.");

("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72,
[Cancellable],
[],
"pack directory into compressed tarball",
"\
Expand Down Expand Up @@ -4688,7 +4694,8 @@ You can use this command to test the connection through to the daemon.
See also C<guestfs_ping_daemon>.");

("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196,
[Cancellable],
[], (* There is a regression test for this. *)
"find all files and directories, returning NUL-separated list",
"\
Expand Down Expand Up @@ -5382,7 +5389,8 @@ If blocks are already zero, then this command avoids writing
zeroes. This prevents the underlying device from becoming non-sparse
or growing unnecessarily.");

("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229,
[Optional "xz"; Cancellable],
[InitScratchFS, Always, TestOutput (
[["mkdir"; "/txz_in"];
["txz_in"; "../data/helloworld.tar.xz"; "/txz_in"];
Expand All @@ -5392,7 +5400,8 @@ or growing unnecessarily.");
This command uploads and unpacks local file C<tarball> (an
I<xz compressed> tar file) into C<directory>.");

("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230,
[Optional "xz"; Cancellable],
[],
"pack directory into compressed tarball",
"\
Expand Down Expand Up @@ -5519,7 +5528,8 @@ is the same as the L<augtool(1)> C<clear> command.");
Return the current umask. By default the umask is C<022>
unless it has been set by calling C<guestfs_umask>.");

("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241,
[NotInDocs; Cancellable],
[],
"upload a file to the appliance (internal use only)",
"\
Expand All @@ -5530,7 +5540,8 @@ There is no comprehensive help for this command. You have
to look at the file C<daemon/debug.c> in the libguestfs source
to find out what it is for.");

("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242,
[Cancellable],
[InitScratchFS, Always, TestOutput (
[["base64_in"; "../data/hello.b64"; "/base64_in"];
["cat"; "/base64_in"]], "hello\n")],
Expand All @@ -5539,14 +5550,16 @@ to find out what it is for.");
This command uploads base64-encoded data from C<base64file>
to C<filename>.");

("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243,
[Cancellable],
[],
"download file and encode as base64",
"\
This command downloads the contents of C<filename>, writing
it out to local file C<base64file> encoded as base64.");

("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244,
[Cancellable],
[],
"compute MD5, SHAx or CRC checksum of files in a directory",
"\
Expand Down Expand Up @@ -5933,7 +5946,8 @@ from C<guestfs_list_partitions>.
See also C<guestfs_part_to_partnum>.");

("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273,
[Progress; Cancellable],
(let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
[InitScratchFS, Always, TestOutput (
[["upload_offset"; "../../COPYING.LIB"; "/upload_offset"; "0"];
Expand All @@ -5957,7 +5971,8 @@ error occurs.
See also C<guestfs_upload>, C<guestfs_pwrite>.");

("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274,
[Progress; Cancellable],
(let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
let offset = string_of_int 100 in
let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
Expand Down Expand Up @@ -6265,7 +6280,8 @@ C<path> does not exist, then a new file is created.
See also C<guestfs_write>.");

("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [OInt "level"]), 291, [],
("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [OInt "level"]), 291,
[Cancellable],
[],
"output compressed file",
"\
Expand All @@ -6282,7 +6298,8 @@ The optional C<level> parameter controls compression level. The
meaning and default for this parameter depends on the compression
program being used.");

("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [OInt "level"]), 292, [],
("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [OInt "level"]), 292,
[Cancellable],
[],
"output compressed device",
"\
Expand Down
8 changes: 7 additions & 1 deletion generator/generator_checks.ml
View file
Expand Up @@ -182,7 +182,7 @@ let () =

(* Check flags. *)
List.iter (
fun (name, _, _, flags, _, _, _) ->
fun (name, (ret, _, _), _, flags, _, _, _) ->
List.iter (
function
| ProtocolLimitWarning
Expand Down Expand Up @@ -213,6 +213,12 @@ let () =
failwithf "%s: camel case name must contains uppercase characters" name n;
if String.contains n '_' then
failwithf "%s: camel case name must not contain '_'" name n;
| Cancellable ->
(match ret with
| RConstOptString n ->
failwithf "%s: Cancellable function cannot return RConstOptString"
name
| _ -> ())
) flags
) (all_functions @ fish_commands);

Expand Down
1 change: 1 addition & 0 deletions generator/generator_types.ml
View file
Expand Up @@ -225,6 +225,7 @@ type flags =
| CamelName of string (* Pretty camel case name of function. Only specify
this if the generator doesn't make a good job of
it, for example if it contains an abbreviation *)
| Cancellable (* The user can cancel this long-running function *)

and fish_output_t =
| FishOutputOctal (* for int return, print in octal *)
Expand Down

0 comments on commit a5f0ddb

Please sign in to comment.