X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=src%2Fgenerator.ml;h=fdd228eb1106535c26b03964af763087cafcab07;hp=607b6d16e33d5d6283268e04677684f830d96460;hb=50d2af4f8541a81d047753d7d300804ff649230c;hpb=946dc06bb861a38cae959416362e4561c9e4829a diff --git a/src/generator.ml b/src/generator.ml index 607b6d1..fdd228e 100755 --- a/src/generator.ml +++ b/src/generator.ml @@ -19,17 +19,17 @@ (* This script generates a large amount of code and documentation for * all the daemon actions. - * + * * To add a new action there are only two files you need to change, * this one to describe the interface (see the big table of * 'daemon_functions' below), and daemon/.c to write the * implementation. - * + * * After editing this file, run it (./src/generator.ml) to regenerate * all the output files. 'make' will rerun this automatically when * necessary. Note that if you are using a separate build directory * you must run generator.ml from the _source_ directory. - * + * * IMPORTANT: This script should NOT print any warnings. If it prints * warnings, you should treat them as errors. * @@ -544,13 +544,15 @@ handle is closed. We don't currently have any method to enable changes to be committed, although qemu can support this. This is equivalent to the qemu parameter -C<-drive file=filename,snapshot=on,if=...>. +C<-drive file=filename,snapshot=on,readonly=on,if=...>. C is set at compile time by the configuration option C<./configure --with-drive-if=...>. In the rare case where you might need to change this at run time, use C or C. +C is only added where qemu supports this option. + Note that this call checks for the existence of C. This stops you from specifying other types of drive which are supported by qemu such as C and C URLs. To specify those, use @@ -581,7 +583,15 @@ configure script. You can also override this by setting the C environment variable. -Setting C to C restores the default qemu binary."); +Setting C to C restores the default qemu binary. + +Note that you should call this function as early as possible +after creating the handle. This is because some pre-launch +operations depend on testing qemu features (by running C). +If the qemu binary changes, we don't retest features, and +so you might see inconsistent results. Using the environment +variable C is safest of all since that picks +the qemu binary at the same time as the handle is created."); ("get_qemu", (RConstString "qemu", []), -1, [], [InitNone, Always, TestRun ( @@ -4263,7 +4273,7 @@ Rename a logical volume C with the new name C."); "\ Rename a volume group C with the new name C."); - ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [], + ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning], [InitISOFS, Always, TestOutputBuffer ( [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")], "list the contents of a single file in an initrd", @@ -4280,6 +4290,48 @@ contained in a Linux initrd or initramfs image: See also C."); + ("pvuuid", (RString "uuid", [Device "device"]), 222, [], + [], + "get the UUID of a physical volume", + "\ +This command returns the UUID of the LVM PV C."); + + ("vguuid", (RString "uuid", [String "vgname"]), 223, [], + [], + "get the UUID of a volume group", + "\ +This command returns the UUID of the LVM VG named C."); + + ("lvuuid", (RString "uuid", [Device "device"]), 224, [], + [], + "get the UUID of a logical volume", + "\ +This command returns the UUID of the LVM LV C."); + + ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [], + [], + "get the PV UUIDs containing the volume group", + "\ +Given a VG called C, this returns the UUIDs of all +the physical volumes that this volume group resides on. + +You can use this along with C and C +calls to associate physical volumes and volume groups. + +See also C."); + + ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [], + [], + "get the LV UUIDs of all LVs in the volume group", + "\ +Given a VG called C, this returns the UUIDs of all +the logical volumes created in this volume group. + +You can use this along with C and C +calls to associate logical volumes and volume groups. + +See also C."); + ] let all_functions = non_daemon_functions @ daemon_functions @@ -4704,8 +4756,7 @@ let seq_of_test = function (* Handling for function flags. *) let protocol_limit_warning = "Because of the message protocol, there is a transfer limit -of somewhere between 2MB and 4MB. To transfer large files you should use -FTP." +of somewhere between 2MB and 4MB. See L." let danger_will_robinson = "B () | StringList n, "" | DeviceList n, "" -> - pr " const char *const %s[1] = { NULL };\n" n + pr " const char *const %s[1] = { NULL };\n" n | StringList n, arg | DeviceList n, arg -> let strs = string_split " " arg in iteri ( @@ -7223,7 +7273,7 @@ and generate_fish_cmds () = and comment = "The Int type in the generator is a signed 31 bit int." in Some (min, max, comment) in - parse_integer "xstrtol" "long" "int" range name i + parse_integer "xstrtoll" "long long" "int" range name i | Int64 name -> parse_integer "xstrtoll" "long long" "int64_t" None name i ) (snd style); @@ -8149,7 +8199,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (r == -1)\n"; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; | RInt n | RBool n -> pr "PREINIT:\n"; @@ -8160,7 +8210,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (%s == -1)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " RETVAL = newSViv (%s);\n" n; pr " OUTPUT:\n"; pr " RETVAL\n" @@ -8173,7 +8223,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (%s == -1)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " RETVAL = my_newSVll (%s);\n" n; pr " OUTPUT:\n"; pr " RETVAL\n" @@ -8186,7 +8236,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (%s == NULL)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " RETVAL = newSVpv (%s, 0);\n" n; pr " OUTPUT:\n"; pr " RETVAL\n" @@ -8213,7 +8263,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (%s == NULL)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " RETVAL = newSVpv (%s, 0);\n" n; pr " free (%s);\n" n; pr " OUTPUT:\n"; @@ -8228,7 +8278,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (%s == NULL)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n; pr " EXTEND (SP, n);\n"; pr " for (i = 0; i < n; ++i) {\n"; @@ -8252,7 +8302,7 @@ DESTROY (g) pr ";\n"; do_cleanups (); pr " if (%s == NULL)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " RETVAL = newSVpv (%s, size);\n" n; pr " free (%s);\n" n; pr " OUTPUT:\n"; @@ -8273,7 +8323,7 @@ and generate_perl_struct_list_code typ cols name style n do_cleanups = pr ";\n"; do_cleanups (); pr " if (%s == NULL)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " EXTEND (SP, %s->len);\n" n; pr " for (i = 0; i < %s->len; ++i) {\n" n; pr " hv = newHV ();\n"; @@ -8317,7 +8367,7 @@ and generate_perl_struct_code typ cols name style n do_cleanups = pr ";\n"; do_cleanups (); pr " if (%s == NULL)\n" n; - pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name; + pr " croak (\"%%s\", guestfs_last_error (g));\n"; pr " EXTEND (SP, 2 * %d);\n" (List.length cols); List.iter ( fun ((name, _) as col) -> @@ -8393,7 +8443,8 @@ schemes, qcow, qcow2, vmdk. Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, what filesystem is in each LV, etc.). It can also run commands -in the context of the guest. Also you can access filesystems over FTP. +in the context of the guest. Also you can access filesystems over +FUSE. See also L for a set of useful library functions for using libguestfs from Perl, including integration @@ -8930,7 +8981,8 @@ schemes, qcow, qcow2, vmdk. Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, what filesystem is in each LV, etc.). It can also run commands -in the context of the guest. Also you can access filesystems over FTP. +in the context of the guest. Also you can access filesystems over +FUSE. Errors which happen while using the API are turned into Python RuntimeError exceptions. @@ -10223,96 +10275,96 @@ namespace Guestfs List.iter ( fun (name, style, _, _, _, shortdesc, _) -> let rec csharp_return_type () = - match fst style with - | RErr -> "void" - | RBool n -> "bool" - | RInt n -> "int" - | RInt64 n -> "long" - | RConstString n - | RConstOptString n - | RString n - | RBufferOut n -> "string" - | RStruct (_,n) -> "_" ^ n - | RHashtable n -> "Hashtable" - | RStringList n -> "string[]" - | RStructList (_,n) -> sprintf "_%s[]" n + match fst style with + | RErr -> "void" + | RBool n -> "bool" + | RInt n -> "int" + | RInt64 n -> "long" + | RConstString n + | RConstOptString n + | RString n + | RBufferOut n -> "string" + | RStruct (_,n) -> "_" ^ n + | RHashtable n -> "Hashtable" + | RStringList n -> "string[]" + | RStructList (_,n) -> sprintf "_%s[]" n and c_return_type () = - match fst style with - | RErr - | RBool _ - | RInt _ -> "int" - | RInt64 _ -> "long" - | RConstString _ - | RConstOptString _ - | RString _ - | RBufferOut _ -> "string" - | RStruct (_,n) -> "_" ^ n - | RHashtable _ - | RStringList _ -> "string[]" - | RStructList (_,n) -> sprintf "_%s[]" n - + match fst style with + | RErr + | RBool _ + | RInt _ -> "int" + | RInt64 _ -> "long" + | RConstString _ + | RConstOptString _ + | RString _ + | RBufferOut _ -> "string" + | RStruct (_,n) -> "_" ^ n + | RHashtable _ + | RStringList _ -> "string[]" + | RStructList (_,n) -> sprintf "_%s[]" n + and c_error_comparison () = - match fst style with - | RErr - | RBool _ - | RInt _ - | RInt64 _ -> "== -1" - | RConstString _ - | RConstOptString _ - | RString _ - | RBufferOut _ - | RStruct (_,_) - | RHashtable _ - | RStringList _ - | RStructList (_,_) -> "== null" - + match fst style with + | RErr + | RBool _ + | RInt _ + | RInt64 _ -> "== -1" + | RConstString _ + | RConstOptString _ + | RString _ + | RBufferOut _ + | RStruct (_,_) + | RHashtable _ + | RStringList _ + | RStructList (_,_) -> "== null" + and generate_extern_prototype () = - pr " static extern %s guestfs_%s (IntPtr h" - (c_return_type ()) name; - List.iter ( - function - | Pathname n | Device n | Dev_or_Path n | String n | OptString n - | FileIn n | FileOut n -> + pr " static extern %s guestfs_%s (IntPtr h" + (c_return_type ()) name; + List.iter ( + function + | Pathname n | Device n | Dev_or_Path n | String n | OptString n + | FileIn n | FileOut n -> pr ", [In] string %s" n - | StringList n | DeviceList n -> + | StringList n | DeviceList n -> pr ", [In] string[] %s" n - | Bool n -> - pr ", bool %s" n - | Int n -> - pr ", int %s" n - | Int64 n -> - pr ", long %s" n - ) (snd style); - pr ");\n" + | Bool n -> + pr ", bool %s" n + | Int n -> + pr ", int %s" n + | Int64 n -> + pr ", long %s" n + ) (snd style); + pr ");\n" and generate_public_prototype () = - pr " public %s %s (" (csharp_return_type ()) name; - let comma = ref false in - let next () = - if !comma then pr ", "; - comma := true - in - List.iter ( - function - | Pathname n | Device n | Dev_or_Path n | String n | OptString n - | FileIn n | FileOut n -> + pr " public %s %s (" (csharp_return_type ()) name; + let comma = ref false in + let next () = + if !comma then pr ", "; + comma := true + in + List.iter ( + function + | Pathname n | Device n | Dev_or_Path n | String n | OptString n + | FileIn n | FileOut n -> next (); pr "string %s" n - | StringList n | DeviceList n -> + | StringList n | DeviceList n -> next (); pr "string[] %s" n - | Bool n -> - next (); pr "bool %s" n - | Int n -> - next (); pr "int %s" n - | Int64 n -> - next (); pr "long %s" n - ) (snd style); - pr ")\n" + | Bool n -> + next (); pr "bool %s" n + | Int n -> + next (); pr "int %s" n + | Int64 n -> + next (); pr "long %s" n + ) (snd style); + pr ")\n" and generate_call () = - pr "guestfs_%s (_handle" name; - List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style); - pr ");\n"; + pr "guestfs_%s (_handle" name; + List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style); + pr ");\n"; in pr " [DllImport (\"%s\")]\n" library; @@ -10327,8 +10379,7 @@ namespace Guestfs pr " r = "; generate_call (); pr " if (r %s)\n" (c_error_comparison ()); - pr " throw new Error (\"%s: \" + guestfs_last_error (_handle));\n" - name; + pr " throw new Error (guestfs_last_error (_handle));\n"; (match fst style with | RErr -> () | RBool _ ->