3 * Copyright (C) 2009 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table below), and
25 * daemon/<somefile>.c to write the implementation.
27 * After editing this file, run it (./src/generator.ml) to regenerate
28 * all the output files.
30 * IMPORTANT: This script should NOT print any warnings. If it prints
31 * warnings, you should treat them as errors.
32 * [Need to add -warn-error to ocaml command line]
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
46 (* "RInt" as a return value means an int which is -1 for error
47 * or any value >= 0 on success. Only use this for smallish
48 * positive ints (0 <= i < 2^30).
51 (* "RInt64" is the same as RInt, but is guaranteed to be able
52 * to return a full 64 bit value, _except_ that -1 means error
53 * (so -1 cannot be a valid, non-error return value).
56 (* "RBool" is a bool return value which can be true/false or
60 (* "RConstString" is a string that refers to a constant value.
61 * Try to avoid using this. In particular you cannot use this
62 * for values returned from the daemon, because there is no
63 * thread-safe way to return them in the C API.
65 | RConstString of string
66 (* "RString" and "RStringList" are caller-frees. *)
68 | RStringList of string
69 (* Some limited tuples are possible: *)
70 | RIntBool of string * string
71 (* LVM PVs, VGs and LVs. *)
78 (* Key-value pairs of untyped strings. Turns into a hashtable or
79 * dictionary in languages which support it. DON'T use this as a
80 * general "bucket" for results. Prefer a stronger typed return
81 * value if one is available, or write a custom struct. Don't use
82 * this if the list could potentially be very long, since it is
83 * inefficient. Keys should be unique. NULLs are not permitted.
85 | RHashtable of string
87 and args = argt list (* Function parameters, guestfs handle is implicit. *)
89 (* Note in future we should allow a "variable args" parameter as
90 * the final parameter, to allow commands like
91 * chmod mode file [file(s)...]
92 * This is not implemented yet, but many commands (such as chmod)
93 * are currently defined with the argument order keeping this future
94 * possibility in mind.
97 | String of string (* const char *name, cannot be NULL *)
98 | OptString of string (* const char *name, may be NULL *)
99 | StringList of string(* list of strings (each string cannot be NULL) *)
100 | Bool of string (* boolean *)
101 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
102 (* These are treated as filenames (simple string parameters) in
103 * the C API and bindings. But in the RPC protocol, we transfer
104 * the actual file content up to or down from the daemon.
105 * FileIn: local machine -> daemon (in request)
106 * FileOut: daemon -> local machine (in reply)
107 * In guestfish (only), the special name "-" means read from
108 * stdin or write to stdout.
114 | ProtocolLimitWarning (* display warning about protocol size limits *)
115 | DangerWillRobinson (* flags particularly dangerous commands *)
116 | FishAlias of string (* provide an alias for this cmd in guestfish *)
117 | FishAction of string (* call this function in guestfish *)
118 | NotInFish (* do not export via guestfish *)
119 | NotInDocs (* do not add this function to documentation *)
121 let protocol_limit_warning =
122 "Because of the message protocol, there is a transfer limit
123 of somewhere between 2MB and 4MB. To transfer large files you should use
126 let danger_will_robinson =
127 "B<This command is dangerous. Without careful use you
128 can easily destroy all your data>."
130 (* You can supply zero or as many tests as you want per API call.
132 * Note that the test environment has 3 block devices, of size 500MB,
133 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
134 * a fourth squashfs block device with some known files on it (/dev/sdd).
136 * Note for partitioning purposes, the 500MB device has 63 cylinders.
138 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
140 * To be able to run the tests in a reasonable amount of time,
141 * the virtual machine and block devices are reused between tests.
142 * So don't try testing kill_subprocess :-x
144 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
146 * Don't assume anything about the previous contents of the block
147 * devices. Use 'Init*' to create some initial scenarios.
149 * You can add a prerequisite clause to any individual test. This
150 * is a run-time check, which, if it fails, causes the test to be
151 * skipped. Useful if testing a command which might not work on
152 * all variations of libguestfs builds. A test that has prerequisite
153 * of 'Always' is run unconditionally.
155 * In addition, packagers can skip individual tests by setting the
156 * environment variables: eg:
157 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
158 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
160 type tests = (test_init * test_prereq * test) list
162 (* Run the command sequence and just expect nothing to fail. *)
164 (* Run the command sequence and expect the output of the final
165 * command to be the string.
167 | TestOutput of seq * string
168 (* Run the command sequence and expect the output of the final
169 * command to be the list of strings.
171 | TestOutputList of seq * string list
172 (* Run the command sequence and expect the output of the final
173 * command to be the list of block devices (could be either
174 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
175 * character of each string).
177 | TestOutputListOfDevices of seq * string list
178 (* Run the command sequence and expect the output of the final
179 * command to be the integer.
181 | TestOutputInt of seq * int
182 (* Run the command sequence and expect the output of the final
183 * command to be a true value (!= 0 or != NULL).
185 | TestOutputTrue of seq
186 (* Run the command sequence and expect the output of the final
187 * command to be a false value (== 0 or == NULL, but not an error).
189 | TestOutputFalse of seq
190 (* Run the command sequence and expect the output of the final
191 * command to be a list of the given length (but don't care about
194 | TestOutputLength of seq * int
195 (* Run the command sequence and expect the output of the final
196 * command to be a structure.
198 | TestOutputStruct of seq * test_field_compare list
199 (* Run the command sequence and expect the final command (only)
202 | TestLastFail of seq
204 and test_field_compare =
205 | CompareWithInt of string * int
206 | CompareWithString of string * string
207 | CompareFieldsIntEq of string * string
208 | CompareFieldsStrEq of string * string
210 (* Test prerequisites. *)
212 (* Test always runs. *)
214 (* Test is currently disabled - eg. it fails, or it tests some
215 * unimplemented feature.
218 (* 'string' is some C code (a function body) that should return
219 * true or false. The test will run if the code returns true.
222 (* As for 'If' but the test runs _unless_ the code returns true. *)
225 (* Some initial scenarios for testing. *)
227 (* Do nothing, block devices could contain random stuff including
228 * LVM PVs, and some filesystems might be mounted. This is usually
232 (* Block devices are empty and no filesystems are mounted. *)
234 (* /dev/sda contains a single partition /dev/sda1, which is formatted
235 * as ext2, empty [except for lost+found] and mounted on /.
236 * /dev/sdb and /dev/sdc may have random content.
241 * /dev/sda1 (is a PV):
242 * /dev/VG/LV (size 8MB):
243 * formatted as ext2, empty [except for lost+found], mounted on /
244 * /dev/sdb and /dev/sdc may have random content.
248 (* Sequence of commands for testing. *)
250 and cmd = string list
252 (* Note about long descriptions: When referring to another
253 * action, use the format C<guestfs_other> (ie. the full name of
254 * the C function). This will be replaced as appropriate in other
257 * Apart from that, long descriptions are just perldoc paragraphs.
260 (* These test functions are used in the language binding tests. *)
262 let test_all_args = [
265 StringList "strlist";
272 let test_all_rets = [
273 (* except for RErr, which is tested thoroughly elsewhere *)
274 "test0rint", RInt "valout";
275 "test0rint64", RInt64 "valout";
276 "test0rbool", RBool "valout";
277 "test0rconststring", RConstString "valout";
278 "test0rstring", RString "valout";
279 "test0rstringlist", RStringList "valout";
280 "test0rintbool", RIntBool ("valout", "valout");
281 "test0rpvlist", RPVList "valout";
282 "test0rvglist", RVGList "valout";
283 "test0rlvlist", RLVList "valout";
284 "test0rstat", RStat "valout";
285 "test0rstatvfs", RStatVFS "valout";
286 "test0rhashtable", RHashtable "valout";
289 let test_functions = [
290 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
292 "internal test function - do not use",
294 This is an internal test function which is used to test whether
295 the automatically generated bindings can handle every possible
296 parameter type correctly.
298 It echos the contents of each parameter to stdout.
300 You probably don't want to call this function.");
304 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
306 "internal test function - do not use",
308 This is an internal test function which is used to test whether
309 the automatically generated bindings can handle every possible
310 return type correctly.
312 It converts string C<val> to the return type.
314 You probably don't want to call this function.");
315 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
317 "internal test function - do not use",
319 This is an internal test function which is used to test whether
320 the automatically generated bindings can handle every possible
321 return type correctly.
323 This function always returns an error.
325 You probably don't want to call this function.")]
329 (* non_daemon_functions are any functions which don't get processed
330 * in the daemon, eg. functions for setting and getting local
331 * configuration values.
334 let non_daemon_functions = test_functions @ [
335 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
337 "launch the qemu subprocess",
339 Internally libguestfs is implemented by running a virtual machine
342 You should call this after configuring the handle
343 (eg. adding drives) but before performing any actions.");
345 ("wait_ready", (RErr, []), -1, [NotInFish],
347 "wait until the qemu subprocess launches",
349 Internally libguestfs is implemented by running a virtual machine
352 You should call this after C<guestfs_launch> to wait for the launch
355 ("kill_subprocess", (RErr, []), -1, [],
357 "kill the qemu subprocess",
359 This kills the qemu subprocess. You should never need to call this.");
361 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
363 "add an image to examine or modify",
365 This function adds a virtual machine disk image C<filename> to the
366 guest. The first time you call this function, the disk appears as IDE
367 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
370 You don't necessarily need to be root when using libguestfs. However
371 you obviously do need sufficient permissions to access the filename
372 for whatever operations you want to perform (ie. read access if you
373 just want to read the image or write access if you want to modify the
376 This is equivalent to the qemu parameter C<-drive file=filename,cache=off>.
378 Note that this call checks for the existence of C<filename>. This
379 stops you from specifying other types of drive which are supported
380 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
381 the general C<guestfs_config> call instead.");
383 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
385 "add a CD-ROM disk image to examine",
387 This function adds a virtual CD-ROM disk image to the guest.
389 This is equivalent to the qemu parameter C<-cdrom filename>.
391 Note that this call checks for the existence of C<filename>. This
392 stops you from specifying other types of drive which are supported
393 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
394 the general C<guestfs_config> call instead.");
396 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
398 "add a drive in snapshot mode (read-only)",
400 This adds a drive in snapshot mode, making it effectively
403 Note that writes to the device are allowed, and will be seen for
404 the duration of the guestfs handle, but they are written
405 to a temporary file which is discarded as soon as the guestfs
406 handle is closed. We don't currently have any method to enable
407 changes to be committed, although qemu can support this.
409 This is equivalent to the qemu parameter
410 C<-drive file=filename,snapshot=on>.
412 Note that this call checks for the existence of C<filename>. This
413 stops you from specifying other types of drive which are supported
414 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
415 the general C<guestfs_config> call instead.");
417 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
419 "add qemu parameters",
421 This can be used to add arbitrary qemu command line parameters
422 of the form C<-param value>. Actually it's not quite arbitrary - we
423 prevent you from setting some parameters which would interfere with
424 parameters that we use.
426 The first character of C<param> string must be a C<-> (dash).
428 C<value> can be NULL.");
430 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
432 "set the qemu binary",
434 Set the qemu binary that we will use.
436 The default is chosen when the library was compiled by the
439 You can also override this by setting the C<LIBGUESTFS_QEMU>
440 environment variable.
442 Setting C<qemu> to C<NULL> restores the default qemu binary.");
444 ("get_qemu", (RConstString "qemu", []), -1, [],
446 "get the qemu binary",
448 Return the current qemu binary.
450 This is always non-NULL. If it wasn't set already, then this will
451 return the default qemu binary name.");
453 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
455 "set the search path",
457 Set the path that libguestfs searches for kernel and initrd.img.
459 The default is C<$libdir/guestfs> unless overridden by setting
460 C<LIBGUESTFS_PATH> environment variable.
462 Setting C<path> to C<NULL> restores the default path.");
464 ("get_path", (RConstString "path", []), -1, [],
466 "get the search path",
468 Return the current search path.
470 This is always non-NULL. If it wasn't set already, then this will
471 return the default path.");
473 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
475 "add options to kernel command line",
477 This function is used to add additional options to the
478 guest kernel command line.
480 The default is C<NULL> unless overridden by setting
481 C<LIBGUESTFS_APPEND> environment variable.
483 Setting C<append> to C<NULL> means I<no> additional options
484 are passed (libguestfs always adds a few of its own).");
486 ("get_append", (RConstString "append", []), -1, [],
488 "get the additional kernel options",
490 Return the additional kernel options which are added to the
491 guest kernel command line.
493 If C<NULL> then no options are added.");
495 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
499 If C<autosync> is true, this enables autosync. Libguestfs will make a
500 best effort attempt to run C<guestfs_umount_all> followed by
501 C<guestfs_sync> when the handle is closed
502 (also if the program exits without closing handles).
504 This is disabled by default (except in guestfish where it is
505 enabled by default).");
507 ("get_autosync", (RBool "autosync", []), -1, [],
511 Get the autosync flag.");
513 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
517 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
519 Verbose messages are disabled unless the environment variable
520 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
522 ("get_verbose", (RBool "verbose", []), -1, [],
526 This returns the verbose messages flag.");
528 ("is_ready", (RBool "ready", []), -1, [],
530 "is ready to accept commands",
532 This returns true iff this handle is ready to accept commands
533 (in the C<READY> state).
535 For more information on states, see L<guestfs(3)>.");
537 ("is_config", (RBool "config", []), -1, [],
539 "is in configuration state",
541 This returns true iff this handle is being configured
542 (in the C<CONFIG> state).
544 For more information on states, see L<guestfs(3)>.");
546 ("is_launching", (RBool "launching", []), -1, [],
548 "is launching subprocess",
550 This returns true iff this handle is launching the subprocess
551 (in the C<LAUNCHING> state).
553 For more information on states, see L<guestfs(3)>.");
555 ("is_busy", (RBool "busy", []), -1, [],
557 "is busy processing a command",
559 This returns true iff this handle is busy processing a command
560 (in the C<BUSY> state).
562 For more information on states, see L<guestfs(3)>.");
564 ("get_state", (RInt "state", []), -1, [],
566 "get the current state",
568 This returns the current state as an opaque integer. This is
569 only useful for printing debug and internal error messages.
571 For more information on states, see L<guestfs(3)>.");
573 ("set_busy", (RErr, []), -1, [NotInFish],
577 This sets the state to C<BUSY>. This is only used when implementing
578 actions using the low-level API.
580 For more information on states, see L<guestfs(3)>.");
582 ("set_ready", (RErr, []), -1, [NotInFish],
584 "set state to ready",
586 This sets the state to C<READY>. This is only used when implementing
587 actions using the low-level API.
589 For more information on states, see L<guestfs(3)>.");
591 ("end_busy", (RErr, []), -1, [NotInFish],
593 "leave the busy state",
595 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
596 state as is. This is only used when implementing
597 actions using the low-level API.
599 For more information on states, see L<guestfs(3)>.");
603 (* daemon_functions are any functions which cause some action
604 * to take place in the daemon.
607 let daemon_functions = [
608 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
609 [InitEmpty, Always, TestOutput (
610 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
611 ["mkfs"; "ext2"; "/dev/sda1"];
612 ["mount"; "/dev/sda1"; "/"];
613 ["write_file"; "/new"; "new file contents"; "0"];
614 ["cat"; "/new"]], "new file contents")],
615 "mount a guest disk at a position in the filesystem",
617 Mount a guest disk at a position in the filesystem. Block devices
618 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
619 the guest. If those block devices contain partitions, they will have
620 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
623 The rules are the same as for L<mount(2)>: A filesystem must
624 first be mounted on C</> before others can be mounted. Other
625 filesystems can only be mounted on directories which already
628 The mounted filesystem is writable, if we have sufficient permissions
629 on the underlying device.
631 The filesystem options C<sync> and C<noatime> are set with this
632 call, in order to improve reliability.");
634 ("sync", (RErr, []), 2, [],
635 [ InitEmpty, Always, TestRun [["sync"]]],
636 "sync disks, writes are flushed through to the disk image",
638 This syncs the disk, so that any writes are flushed through to the
639 underlying disk image.
641 You should always call this if you have modified a disk image, before
642 closing the handle.");
644 ("touch", (RErr, [String "path"]), 3, [],
645 [InitBasicFS, Always, TestOutputTrue (
647 ["exists"; "/new"]])],
648 "update file timestamps or create a new file",
650 Touch acts like the L<touch(1)> command. It can be used to
651 update the timestamps on a file, or, if the file does not exist,
652 to create a new zero-length file.");
654 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
655 [InitBasicFS, Always, TestOutput (
656 [["write_file"; "/new"; "new file contents"; "0"];
657 ["cat"; "/new"]], "new file contents")],
658 "list the contents of a file",
660 Return the contents of the file named C<path>.
662 Note that this function cannot correctly handle binary files
663 (specifically, files containing C<\\0> character which is treated
664 as end of string). For those you need to use the C<guestfs_download>
665 function which has a more complex interface.");
667 ("ll", (RString "listing", [String "directory"]), 5, [],
668 [], (* XXX Tricky to test because it depends on the exact format
669 * of the 'ls -l' command, which changes between F10 and F11.
671 "list the files in a directory (long format)",
673 List the files in C<directory> (relative to the root directory,
674 there is no cwd) in the format of 'ls -la'.
676 This command is mostly useful for interactive sessions. It
677 is I<not> intended that you try to parse the output string.");
679 ("ls", (RStringList "listing", [String "directory"]), 6, [],
680 [InitBasicFS, Always, TestOutputList (
683 ["touch"; "/newest"];
684 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
685 "list the files in a directory",
687 List the files in C<directory> (relative to the root directory,
688 there is no cwd). The '.' and '..' entries are not returned, but
689 hidden files are shown.
691 This command is mostly useful for interactive sessions. Programs
692 should probably use C<guestfs_readdir> instead.");
694 ("list_devices", (RStringList "devices", []), 7, [],
695 [InitEmpty, Always, TestOutputListOfDevices (
696 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
697 "list the block devices",
699 List all the block devices.
701 The full block device names are returned, eg. C</dev/sda>");
703 ("list_partitions", (RStringList "partitions", []), 8, [],
704 [InitBasicFS, Always, TestOutputListOfDevices (
705 [["list_partitions"]], ["/dev/sda1"]);
706 InitEmpty, Always, TestOutputListOfDevices (
707 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
708 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
709 "list the partitions",
711 List all the partitions detected on all block devices.
713 The full partition device names are returned, eg. C</dev/sda1>
715 This does not return logical volumes. For that you will need to
716 call C<guestfs_lvs>.");
718 ("pvs", (RStringList "physvols", []), 9, [],
719 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
720 [["pvs"]], ["/dev/sda1"]);
721 InitEmpty, Always, TestOutputListOfDevices (
722 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
723 ["pvcreate"; "/dev/sda1"];
724 ["pvcreate"; "/dev/sda2"];
725 ["pvcreate"; "/dev/sda3"];
726 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
727 "list the LVM physical volumes (PVs)",
729 List all the physical volumes detected. This is the equivalent
730 of the L<pvs(8)> command.
732 This returns a list of just the device names that contain
733 PVs (eg. C</dev/sda2>).
735 See also C<guestfs_pvs_full>.");
737 ("vgs", (RStringList "volgroups", []), 10, [],
738 [InitBasicFSonLVM, Always, TestOutputList (
740 InitEmpty, Always, TestOutputList (
741 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
742 ["pvcreate"; "/dev/sda1"];
743 ["pvcreate"; "/dev/sda2"];
744 ["pvcreate"; "/dev/sda3"];
745 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
746 ["vgcreate"; "VG2"; "/dev/sda3"];
747 ["vgs"]], ["VG1"; "VG2"])],
748 "list the LVM volume groups (VGs)",
750 List all the volumes groups detected. This is the equivalent
751 of the L<vgs(8)> command.
753 This returns a list of just the volume group names that were
754 detected (eg. C<VolGroup00>).
756 See also C<guestfs_vgs_full>.");
758 ("lvs", (RStringList "logvols", []), 11, [],
759 [InitBasicFSonLVM, Always, TestOutputList (
760 [["lvs"]], ["/dev/VG/LV"]);
761 InitEmpty, Always, TestOutputList (
762 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
763 ["pvcreate"; "/dev/sda1"];
764 ["pvcreate"; "/dev/sda2"];
765 ["pvcreate"; "/dev/sda3"];
766 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
767 ["vgcreate"; "VG2"; "/dev/sda3"];
768 ["lvcreate"; "LV1"; "VG1"; "50"];
769 ["lvcreate"; "LV2"; "VG1"; "50"];
770 ["lvcreate"; "LV3"; "VG2"; "50"];
771 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
772 "list the LVM logical volumes (LVs)",
774 List all the logical volumes detected. This is the equivalent
775 of the L<lvs(8)> command.
777 This returns a list of the logical volume device names
778 (eg. C</dev/VolGroup00/LogVol00>).
780 See also C<guestfs_lvs_full>.");
782 ("pvs_full", (RPVList "physvols", []), 12, [],
783 [], (* XXX how to test? *)
784 "list the LVM physical volumes (PVs)",
786 List all the physical volumes detected. This is the equivalent
787 of the L<pvs(8)> command. The \"full\" version includes all fields.");
789 ("vgs_full", (RVGList "volgroups", []), 13, [],
790 [], (* XXX how to test? *)
791 "list the LVM volume groups (VGs)",
793 List all the volumes groups detected. This is the equivalent
794 of the L<vgs(8)> command. The \"full\" version includes all fields.");
796 ("lvs_full", (RLVList "logvols", []), 14, [],
797 [], (* XXX how to test? *)
798 "list the LVM logical volumes (LVs)",
800 List all the logical volumes detected. This is the equivalent
801 of the L<lvs(8)> command. The \"full\" version includes all fields.");
803 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
804 [InitBasicFS, Always, TestOutputList (
805 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
806 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
807 InitBasicFS, Always, TestOutputList (
808 [["write_file"; "/new"; ""; "0"];
809 ["read_lines"; "/new"]], [])],
810 "read file as lines",
812 Return the contents of the file named C<path>.
814 The file contents are returned as a list of lines. Trailing
815 C<LF> and C<CRLF> character sequences are I<not> returned.
817 Note that this function cannot correctly handle binary files
818 (specifically, files containing C<\\0> character which is treated
819 as end of line). For those you need to use the C<guestfs_read_file>
820 function which has a more complex interface.");
822 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
823 [], (* XXX Augeas code needs tests. *)
824 "create a new Augeas handle",
826 Create a new Augeas handle for editing configuration files.
827 If there was any previous Augeas handle associated with this
828 guestfs session, then it is closed.
830 You must call this before using any other C<guestfs_aug_*>
833 C<root> is the filesystem root. C<root> must not be NULL,
836 The flags are the same as the flags defined in
837 E<lt>augeas.hE<gt>, the logical I<or> of the following
842 =item C<AUG_SAVE_BACKUP> = 1
844 Keep the original file with a C<.augsave> extension.
846 =item C<AUG_SAVE_NEWFILE> = 2
848 Save changes into a file with extension C<.augnew>, and
849 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
851 =item C<AUG_TYPE_CHECK> = 4
853 Typecheck lenses (can be expensive).
855 =item C<AUG_NO_STDINC> = 8
857 Do not use standard load path for modules.
859 =item C<AUG_SAVE_NOOP> = 16
861 Make save a no-op, just record what would have been changed.
863 =item C<AUG_NO_LOAD> = 32
865 Do not load the tree in C<guestfs_aug_init>.
869 To close the handle, you can call C<guestfs_aug_close>.
871 To find out more about Augeas, see L<http://augeas.net/>.");
873 ("aug_close", (RErr, []), 26, [],
874 [], (* XXX Augeas code needs tests. *)
875 "close the current Augeas handle",
877 Close the current Augeas handle and free up any resources
878 used by it. After calling this, you have to call
879 C<guestfs_aug_init> again before you can use any other
882 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
883 [], (* XXX Augeas code needs tests. *)
884 "define an Augeas variable",
886 Defines an Augeas variable C<name> whose value is the result
887 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
890 On success this returns the number of nodes in C<expr>, or
891 C<0> if C<expr> evaluates to something which is not a nodeset.");
893 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
894 [], (* XXX Augeas code needs tests. *)
895 "define an Augeas node",
897 Defines a variable C<name> whose value is the result of
900 If C<expr> evaluates to an empty nodeset, a node is created,
901 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
902 C<name> will be the nodeset containing that single node.
904 On success this returns a pair containing the
905 number of nodes in the nodeset, and a boolean flag
906 if a node was created.");
908 ("aug_get", (RString "val", [String "path"]), 19, [],
909 [], (* XXX Augeas code needs tests. *)
910 "look up the value of an Augeas path",
912 Look up the value associated with C<path>. If C<path>
913 matches exactly one node, the C<value> is returned.");
915 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
916 [], (* XXX Augeas code needs tests. *)
917 "set Augeas path to value",
919 Set the value associated with C<path> to C<value>.");
921 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
922 [], (* XXX Augeas code needs tests. *)
923 "insert a sibling Augeas node",
925 Create a new sibling C<label> for C<path>, inserting it into
926 the tree before or after C<path> (depending on the boolean
929 C<path> must match exactly one existing node in the tree, and
930 C<label> must be a label, ie. not contain C</>, C<*> or end
931 with a bracketed index C<[N]>.");
933 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
934 [], (* XXX Augeas code needs tests. *)
935 "remove an Augeas path",
937 Remove C<path> and all of its children.
939 On success this returns the number of entries which were removed.");
941 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
942 [], (* XXX Augeas code needs tests. *)
945 Move the node C<src> to C<dest>. C<src> must match exactly
946 one node. C<dest> is overwritten if it exists.");
948 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
949 [], (* XXX Augeas code needs tests. *)
950 "return Augeas nodes which match path",
952 Returns a list of paths which match the path expression C<path>.
953 The returned paths are sufficiently qualified so that they match
954 exactly one node in the current tree.");
956 ("aug_save", (RErr, []), 25, [],
957 [], (* XXX Augeas code needs tests. *)
958 "write all pending Augeas changes to disk",
960 This writes all pending changes to disk.
962 The flags which were passed to C<guestfs_aug_init> affect exactly
963 how files are saved.");
965 ("aug_load", (RErr, []), 27, [],
966 [], (* XXX Augeas code needs tests. *)
967 "load files into the tree",
969 Load files into the tree.
971 See C<aug_load> in the Augeas documentation for the full gory
974 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
975 [], (* XXX Augeas code needs tests. *)
976 "list Augeas nodes under a path",
978 This is just a shortcut for listing C<guestfs_aug_match>
979 C<path/*> and sorting the resulting nodes into alphabetical order.");
981 ("rm", (RErr, [String "path"]), 29, [],
982 [InitBasicFS, Always, TestRun
985 InitBasicFS, Always, TestLastFail
987 InitBasicFS, Always, TestLastFail
992 Remove the single file C<path>.");
994 ("rmdir", (RErr, [String "path"]), 30, [],
995 [InitBasicFS, Always, TestRun
998 InitBasicFS, Always, TestLastFail
1000 InitBasicFS, Always, TestLastFail
1002 ["rmdir"; "/new"]]],
1003 "remove a directory",
1005 Remove the single directory C<path>.");
1007 ("rm_rf", (RErr, [String "path"]), 31, [],
1008 [InitBasicFS, Always, TestOutputFalse
1010 ["mkdir"; "/new/foo"];
1011 ["touch"; "/new/foo/bar"];
1013 ["exists"; "/new"]]],
1014 "remove a file or directory recursively",
1016 Remove the file or directory C<path>, recursively removing the
1017 contents if its a directory. This is like the C<rm -rf> shell
1020 ("mkdir", (RErr, [String "path"]), 32, [],
1021 [InitBasicFS, Always, TestOutputTrue
1023 ["is_dir"; "/new"]];
1024 InitBasicFS, Always, TestLastFail
1025 [["mkdir"; "/new/foo/bar"]]],
1026 "create a directory",
1028 Create a directory named C<path>.");
1030 ("mkdir_p", (RErr, [String "path"]), 33, [],
1031 [InitBasicFS, Always, TestOutputTrue
1032 [["mkdir_p"; "/new/foo/bar"];
1033 ["is_dir"; "/new/foo/bar"]];
1034 InitBasicFS, Always, TestOutputTrue
1035 [["mkdir_p"; "/new/foo/bar"];
1036 ["is_dir"; "/new/foo"]];
1037 InitBasicFS, Always, TestOutputTrue
1038 [["mkdir_p"; "/new/foo/bar"];
1039 ["is_dir"; "/new"]];
1040 (* Regression tests for RHBZ#503133: *)
1041 InitBasicFS, Always, TestRun
1043 ["mkdir_p"; "/new"]];
1044 InitBasicFS, Always, TestLastFail
1046 ["mkdir_p"; "/new"]]],
1047 "create a directory and parents",
1049 Create a directory named C<path>, creating any parent directories
1050 as necessary. This is like the C<mkdir -p> shell command.");
1052 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1053 [], (* XXX Need stat command to test *)
1056 Change the mode (permissions) of C<path> to C<mode>. Only
1057 numeric modes are supported.");
1059 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1060 [], (* XXX Need stat command to test *)
1061 "change file owner and group",
1063 Change the file owner to C<owner> and group to C<group>.
1065 Only numeric uid and gid are supported. If you want to use
1066 names, you will need to locate and parse the password file
1067 yourself (Augeas support makes this relatively easy).");
1069 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1070 [InitBasicFS, Always, TestOutputTrue (
1072 ["exists"; "/new"]]);
1073 InitBasicFS, Always, TestOutputTrue (
1075 ["exists"; "/new"]])],
1076 "test if file or directory exists",
1078 This returns C<true> if and only if there is a file, directory
1079 (or anything) with the given C<path> name.
1081 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1083 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1084 [InitBasicFS, Always, TestOutputTrue (
1086 ["is_file"; "/new"]]);
1087 InitBasicFS, Always, TestOutputFalse (
1089 ["is_file"; "/new"]])],
1090 "test if file exists",
1092 This returns C<true> if and only if there is a file
1093 with the given C<path> name. Note that it returns false for
1094 other objects like directories.
1096 See also C<guestfs_stat>.");
1098 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1099 [InitBasicFS, Always, TestOutputFalse (
1101 ["is_dir"; "/new"]]);
1102 InitBasicFS, Always, TestOutputTrue (
1104 ["is_dir"; "/new"]])],
1105 "test if file exists",
1107 This returns C<true> if and only if there is a directory
1108 with the given C<path> name. Note that it returns false for
1109 other objects like files.
1111 See also C<guestfs_stat>.");
1113 ("pvcreate", (RErr, [String "device"]), 39, [],
1114 [InitEmpty, Always, TestOutputListOfDevices (
1115 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1116 ["pvcreate"; "/dev/sda1"];
1117 ["pvcreate"; "/dev/sda2"];
1118 ["pvcreate"; "/dev/sda3"];
1119 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1120 "create an LVM physical volume",
1122 This creates an LVM physical volume on the named C<device>,
1123 where C<device> should usually be a partition name such
1126 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1127 [InitEmpty, Always, TestOutputList (
1128 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1129 ["pvcreate"; "/dev/sda1"];
1130 ["pvcreate"; "/dev/sda2"];
1131 ["pvcreate"; "/dev/sda3"];
1132 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1133 ["vgcreate"; "VG2"; "/dev/sda3"];
1134 ["vgs"]], ["VG1"; "VG2"])],
1135 "create an LVM volume group",
1137 This creates an LVM volume group called C<volgroup>
1138 from the non-empty list of physical volumes C<physvols>.");
1140 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1141 [InitEmpty, Always, TestOutputList (
1142 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1143 ["pvcreate"; "/dev/sda1"];
1144 ["pvcreate"; "/dev/sda2"];
1145 ["pvcreate"; "/dev/sda3"];
1146 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1147 ["vgcreate"; "VG2"; "/dev/sda3"];
1148 ["lvcreate"; "LV1"; "VG1"; "50"];
1149 ["lvcreate"; "LV2"; "VG1"; "50"];
1150 ["lvcreate"; "LV3"; "VG2"; "50"];
1151 ["lvcreate"; "LV4"; "VG2"; "50"];
1152 ["lvcreate"; "LV5"; "VG2"; "50"];
1154 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1155 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1156 "create an LVM volume group",
1158 This creates an LVM volume group called C<logvol>
1159 on the volume group C<volgroup>, with C<size> megabytes.");
1161 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1162 [InitEmpty, Always, TestOutput (
1163 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1164 ["mkfs"; "ext2"; "/dev/sda1"];
1165 ["mount"; "/dev/sda1"; "/"];
1166 ["write_file"; "/new"; "new file contents"; "0"];
1167 ["cat"; "/new"]], "new file contents")],
1168 "make a filesystem",
1170 This creates a filesystem on C<device> (usually a partition
1171 or LVM logical volume). The filesystem type is C<fstype>, for
1174 ("sfdisk", (RErr, [String "device";
1175 Int "cyls"; Int "heads"; Int "sectors";
1176 StringList "lines"]), 43, [DangerWillRobinson],
1178 "create partitions on a block device",
1180 This is a direct interface to the L<sfdisk(8)> program for creating
1181 partitions on block devices.
1183 C<device> should be a block device, for example C</dev/sda>.
1185 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1186 and sectors on the device, which are passed directly to sfdisk as
1187 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1188 of these, then the corresponding parameter is omitted. Usually for
1189 'large' disks, you can just pass C<0> for these, but for small
1190 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1191 out the right geometry and you will need to tell it.
1193 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1194 information refer to the L<sfdisk(8)> manpage.
1196 To create a single partition occupying the whole disk, you would
1197 pass C<lines> as a single element list, when the single element being
1198 the string C<,> (comma).
1200 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1202 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1203 [InitBasicFS, Always, TestOutput (
1204 [["write_file"; "/new"; "new file contents"; "0"];
1205 ["cat"; "/new"]], "new file contents");
1206 InitBasicFS, Always, TestOutput (
1207 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1208 ["cat"; "/new"]], "\nnew file contents\n");
1209 InitBasicFS, Always, TestOutput (
1210 [["write_file"; "/new"; "\n\n"; "0"];
1211 ["cat"; "/new"]], "\n\n");
1212 InitBasicFS, Always, TestOutput (
1213 [["write_file"; "/new"; ""; "0"];
1214 ["cat"; "/new"]], "");
1215 InitBasicFS, Always, TestOutput (
1216 [["write_file"; "/new"; "\n\n\n"; "0"];
1217 ["cat"; "/new"]], "\n\n\n");
1218 InitBasicFS, Always, TestOutput (
1219 [["write_file"; "/new"; "\n"; "0"];
1220 ["cat"; "/new"]], "\n")],
1223 This call creates a file called C<path>. The contents of the
1224 file is the string C<content> (which can contain any 8 bit data),
1225 with length C<size>.
1227 As a special case, if C<size> is C<0>
1228 then the length is calculated using C<strlen> (so in this case
1229 the content cannot contain embedded ASCII NULs).
1231 I<NB.> Owing to a bug, writing content containing ASCII NUL
1232 characters does I<not> work, even if the length is specified.
1233 We hope to resolve this bug in a future version. In the meantime
1234 use C<guestfs_upload>.");
1236 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1237 [InitEmpty, Always, TestOutputListOfDevices (
1238 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1239 ["mkfs"; "ext2"; "/dev/sda1"];
1240 ["mount"; "/dev/sda1"; "/"];
1241 ["mounts"]], ["/dev/sda1"]);
1242 InitEmpty, Always, TestOutputList (
1243 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1244 ["mkfs"; "ext2"; "/dev/sda1"];
1245 ["mount"; "/dev/sda1"; "/"];
1248 "unmount a filesystem",
1250 This unmounts the given filesystem. The filesystem may be
1251 specified either by its mountpoint (path) or the device which
1252 contains the filesystem.");
1254 ("mounts", (RStringList "devices", []), 46, [],
1255 [InitBasicFS, Always, TestOutputListOfDevices (
1256 [["mounts"]], ["/dev/sda1"])],
1257 "show mounted filesystems",
1259 This returns the list of currently mounted filesystems. It returns
1260 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1262 Some internal mounts are not shown.");
1264 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1265 [InitBasicFS, Always, TestOutputList (
1268 (* check that umount_all can unmount nested mounts correctly: *)
1269 InitEmpty, Always, TestOutputList (
1270 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1271 ["mkfs"; "ext2"; "/dev/sda1"];
1272 ["mkfs"; "ext2"; "/dev/sda2"];
1273 ["mkfs"; "ext2"; "/dev/sda3"];
1274 ["mount"; "/dev/sda1"; "/"];
1276 ["mount"; "/dev/sda2"; "/mp1"];
1277 ["mkdir"; "/mp1/mp2"];
1278 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1279 ["mkdir"; "/mp1/mp2/mp3"];
1282 "unmount all filesystems",
1284 This unmounts all mounted filesystems.
1286 Some internal mounts are not unmounted by this call.");
1288 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1290 "remove all LVM LVs, VGs and PVs",
1292 This command removes all LVM logical volumes, volume groups
1293 and physical volumes.");
1295 ("file", (RString "description", [String "path"]), 49, [],
1296 [InitBasicFS, Always, TestOutput (
1298 ["file"; "/new"]], "empty");
1299 InitBasicFS, Always, TestOutput (
1300 [["write_file"; "/new"; "some content\n"; "0"];
1301 ["file"; "/new"]], "ASCII text");
1302 InitBasicFS, Always, TestLastFail (
1303 [["file"; "/nofile"]])],
1304 "determine file type",
1306 This call uses the standard L<file(1)> command to determine
1307 the type or contents of the file. This also works on devices,
1308 for example to find out whether a partition contains a filesystem.
1310 The exact command which runs is C<file -bsL path>. Note in
1311 particular that the filename is not prepended to the output
1312 (the C<-b> option).");
1314 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1315 [InitBasicFS, Always, TestOutput (
1316 [["upload"; "test-command"; "/test-command"];
1317 ["chmod"; "493"; "/test-command"];
1318 ["command"; "/test-command 1"]], "Result1");
1319 InitBasicFS, Always, TestOutput (
1320 [["upload"; "test-command"; "/test-command"];
1321 ["chmod"; "493"; "/test-command"];
1322 ["command"; "/test-command 2"]], "Result2\n");
1323 InitBasicFS, Always, TestOutput (
1324 [["upload"; "test-command"; "/test-command"];
1325 ["chmod"; "493"; "/test-command"];
1326 ["command"; "/test-command 3"]], "\nResult3");
1327 InitBasicFS, Always, TestOutput (
1328 [["upload"; "test-command"; "/test-command"];
1329 ["chmod"; "493"; "/test-command"];
1330 ["command"; "/test-command 4"]], "\nResult4\n");
1331 InitBasicFS, Always, TestOutput (
1332 [["upload"; "test-command"; "/test-command"];
1333 ["chmod"; "493"; "/test-command"];
1334 ["command"; "/test-command 5"]], "\nResult5\n\n");
1335 InitBasicFS, Always, TestOutput (
1336 [["upload"; "test-command"; "/test-command"];
1337 ["chmod"; "493"; "/test-command"];
1338 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1339 InitBasicFS, Always, TestOutput (
1340 [["upload"; "test-command"; "/test-command"];
1341 ["chmod"; "493"; "/test-command"];
1342 ["command"; "/test-command 7"]], "");
1343 InitBasicFS, Always, TestOutput (
1344 [["upload"; "test-command"; "/test-command"];
1345 ["chmod"; "493"; "/test-command"];
1346 ["command"; "/test-command 8"]], "\n");
1347 InitBasicFS, Always, TestOutput (
1348 [["upload"; "test-command"; "/test-command"];
1349 ["chmod"; "493"; "/test-command"];
1350 ["command"; "/test-command 9"]], "\n\n");
1351 InitBasicFS, Always, TestOutput (
1352 [["upload"; "test-command"; "/test-command"];
1353 ["chmod"; "493"; "/test-command"];
1354 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1355 InitBasicFS, Always, TestOutput (
1356 [["upload"; "test-command"; "/test-command"];
1357 ["chmod"; "493"; "/test-command"];
1358 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1359 InitBasicFS, Always, TestLastFail (
1360 [["upload"; "test-command"; "/test-command"];
1361 ["chmod"; "493"; "/test-command"];
1362 ["command"; "/test-command"]])],
1363 "run a command from the guest filesystem",
1365 This call runs a command from the guest filesystem. The
1366 filesystem must be mounted, and must contain a compatible
1367 operating system (ie. something Linux, with the same
1368 or compatible processor architecture).
1370 The single parameter is an argv-style list of arguments.
1371 The first element is the name of the program to run.
1372 Subsequent elements are parameters. The list must be
1373 non-empty (ie. must contain a program name). Note that
1374 the command runs directly, and is I<not> invoked via
1375 the shell (see C<guestfs_sh>).
1377 The return value is anything printed to I<stdout> by
1380 If the command returns a non-zero exit status, then
1381 this function returns an error message. The error message
1382 string is the content of I<stderr> from the command.
1384 The C<$PATH> environment variable will contain at least
1385 C</usr/bin> and C</bin>. If you require a program from
1386 another location, you should provide the full path in the
1389 Shared libraries and data files required by the program
1390 must be available on filesystems which are mounted in the
1391 correct places. It is the caller's responsibility to ensure
1392 all filesystems that are needed are mounted at the right
1395 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1396 [InitBasicFS, Always, TestOutputList (
1397 [["upload"; "test-command"; "/test-command"];
1398 ["chmod"; "493"; "/test-command"];
1399 ["command_lines"; "/test-command 1"]], ["Result1"]);
1400 InitBasicFS, Always, TestOutputList (
1401 [["upload"; "test-command"; "/test-command"];
1402 ["chmod"; "493"; "/test-command"];
1403 ["command_lines"; "/test-command 2"]], ["Result2"]);
1404 InitBasicFS, Always, TestOutputList (
1405 [["upload"; "test-command"; "/test-command"];
1406 ["chmod"; "493"; "/test-command"];
1407 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1408 InitBasicFS, Always, TestOutputList (
1409 [["upload"; "test-command"; "/test-command"];
1410 ["chmod"; "493"; "/test-command"];
1411 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1412 InitBasicFS, Always, TestOutputList (
1413 [["upload"; "test-command"; "/test-command"];
1414 ["chmod"; "493"; "/test-command"];
1415 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1416 InitBasicFS, Always, TestOutputList (
1417 [["upload"; "test-command"; "/test-command"];
1418 ["chmod"; "493"; "/test-command"];
1419 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1420 InitBasicFS, Always, TestOutputList (
1421 [["upload"; "test-command"; "/test-command"];
1422 ["chmod"; "493"; "/test-command"];
1423 ["command_lines"; "/test-command 7"]], []);
1424 InitBasicFS, Always, TestOutputList (
1425 [["upload"; "test-command"; "/test-command"];
1426 ["chmod"; "493"; "/test-command"];
1427 ["command_lines"; "/test-command 8"]], [""]);
1428 InitBasicFS, Always, TestOutputList (
1429 [["upload"; "test-command"; "/test-command"];
1430 ["chmod"; "493"; "/test-command"];
1431 ["command_lines"; "/test-command 9"]], ["";""]);
1432 InitBasicFS, Always, TestOutputList (
1433 [["upload"; "test-command"; "/test-command"];
1434 ["chmod"; "493"; "/test-command"];
1435 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1436 InitBasicFS, Always, TestOutputList (
1437 [["upload"; "test-command"; "/test-command"];
1438 ["chmod"; "493"; "/test-command"];
1439 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1440 "run a command, returning lines",
1442 This is the same as C<guestfs_command>, but splits the
1443 result into a list of lines.
1445 See also: C<guestfs_sh_lines>");
1447 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1448 [InitBasicFS, Always, TestOutputStruct (
1450 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1451 "get file information",
1453 Returns file information for the given C<path>.
1455 This is the same as the C<stat(2)> system call.");
1457 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1458 [InitBasicFS, Always, TestOutputStruct (
1460 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1461 "get file information for a symbolic link",
1463 Returns file information for the given C<path>.
1465 This is the same as C<guestfs_stat> except that if C<path>
1466 is a symbolic link, then the link is stat-ed, not the file it
1469 This is the same as the C<lstat(2)> system call.");
1471 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1472 [InitBasicFS, Always, TestOutputStruct (
1473 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1474 CompareWithInt ("blocks", 490020);
1475 CompareWithInt ("bsize", 1024)])],
1476 "get file system statistics",
1478 Returns file system statistics for any mounted file system.
1479 C<path> should be a file or directory in the mounted file system
1480 (typically it is the mount point itself, but it doesn't need to be).
1482 This is the same as the C<statvfs(2)> system call.");
1484 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1486 "get ext2/ext3/ext4 superblock details",
1488 This returns the contents of the ext2, ext3 or ext4 filesystem
1489 superblock on C<device>.
1491 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1492 manpage for more details. The list of fields returned isn't
1493 clearly defined, and depends on both the version of C<tune2fs>
1494 that libguestfs was built against, and the filesystem itself.");
1496 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1497 [InitEmpty, Always, TestOutputTrue (
1498 [["blockdev_setro"; "/dev/sda"];
1499 ["blockdev_getro"; "/dev/sda"]])],
1500 "set block device to read-only",
1502 Sets the block device named C<device> to read-only.
1504 This uses the L<blockdev(8)> command.");
1506 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1507 [InitEmpty, Always, TestOutputFalse (
1508 [["blockdev_setrw"; "/dev/sda"];
1509 ["blockdev_getro"; "/dev/sda"]])],
1510 "set block device to read-write",
1512 Sets the block device named C<device> to read-write.
1514 This uses the L<blockdev(8)> command.");
1516 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1517 [InitEmpty, Always, TestOutputTrue (
1518 [["blockdev_setro"; "/dev/sda"];
1519 ["blockdev_getro"; "/dev/sda"]])],
1520 "is block device set to read-only",
1522 Returns a boolean indicating if the block device is read-only
1523 (true if read-only, false if not).
1525 This uses the L<blockdev(8)> command.");
1527 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1528 [InitEmpty, Always, TestOutputInt (
1529 [["blockdev_getss"; "/dev/sda"]], 512)],
1530 "get sectorsize of block device",
1532 This returns the size of sectors on a block device.
1533 Usually 512, but can be larger for modern devices.
1535 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1538 This uses the L<blockdev(8)> command.");
1540 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1541 [InitEmpty, Always, TestOutputInt (
1542 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1543 "get blocksize of block device",
1545 This returns the block size of a device.
1547 (Note this is different from both I<size in blocks> and
1548 I<filesystem block size>).
1550 This uses the L<blockdev(8)> command.");
1552 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1554 "set blocksize of block device",
1556 This sets the block size of a device.
1558 (Note this is different from both I<size in blocks> and
1559 I<filesystem block size>).
1561 This uses the L<blockdev(8)> command.");
1563 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1564 [InitEmpty, Always, TestOutputInt (
1565 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1566 "get total size of device in 512-byte sectors",
1568 This returns the size of the device in units of 512-byte sectors
1569 (even if the sectorsize isn't 512 bytes ... weird).
1571 See also C<guestfs_blockdev_getss> for the real sector size of
1572 the device, and C<guestfs_blockdev_getsize64> for the more
1573 useful I<size in bytes>.
1575 This uses the L<blockdev(8)> command.");
1577 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1578 [InitEmpty, Always, TestOutputInt (
1579 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1580 "get total size of device in bytes",
1582 This returns the size of the device in bytes.
1584 See also C<guestfs_blockdev_getsz>.
1586 This uses the L<blockdev(8)> command.");
1588 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1589 [InitEmpty, Always, TestRun
1590 [["blockdev_flushbufs"; "/dev/sda"]]],
1591 "flush device buffers",
1593 This tells the kernel to flush internal buffers associated
1596 This uses the L<blockdev(8)> command.");
1598 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1599 [InitEmpty, Always, TestRun
1600 [["blockdev_rereadpt"; "/dev/sda"]]],
1601 "reread partition table",
1603 Reread the partition table on C<device>.
1605 This uses the L<blockdev(8)> command.");
1607 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1608 [InitBasicFS, Always, TestOutput (
1609 (* Pick a file from cwd which isn't likely to change. *)
1610 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1611 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1612 "upload a file from the local machine",
1614 Upload local file C<filename> to C<remotefilename> on the
1617 C<filename> can also be a named pipe.
1619 See also C<guestfs_download>.");
1621 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1622 [InitBasicFS, Always, TestOutput (
1623 (* Pick a file from cwd which isn't likely to change. *)
1624 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1625 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1626 ["upload"; "testdownload.tmp"; "/upload"];
1627 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1628 "download a file to the local machine",
1630 Download file C<remotefilename> and save it as C<filename>
1631 on the local machine.
1633 C<filename> can also be a named pipe.
1635 See also C<guestfs_upload>, C<guestfs_cat>.");
1637 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1638 [InitBasicFS, Always, TestOutput (
1639 [["write_file"; "/new"; "test\n"; "0"];
1640 ["checksum"; "crc"; "/new"]], "935282863");
1641 InitBasicFS, Always, TestLastFail (
1642 [["checksum"; "crc"; "/new"]]);
1643 InitBasicFS, Always, TestOutput (
1644 [["write_file"; "/new"; "test\n"; "0"];
1645 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1646 InitBasicFS, Always, TestOutput (
1647 [["write_file"; "/new"; "test\n"; "0"];
1648 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1649 InitBasicFS, Always, TestOutput (
1650 [["write_file"; "/new"; "test\n"; "0"];
1651 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1652 InitBasicFS, Always, TestOutput (
1653 [["write_file"; "/new"; "test\n"; "0"];
1654 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1655 InitBasicFS, Always, TestOutput (
1656 [["write_file"; "/new"; "test\n"; "0"];
1657 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1658 InitBasicFS, Always, TestOutput (
1659 [["write_file"; "/new"; "test\n"; "0"];
1660 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1661 InitBasicFS, Always, TestOutput (
1662 (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1663 * the type explicitly.
1665 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1666 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1667 "compute MD5, SHAx or CRC checksum of file",
1669 This call computes the MD5, SHAx or CRC checksum of the
1672 The type of checksum to compute is given by the C<csumtype>
1673 parameter which must have one of the following values:
1679 Compute the cyclic redundancy check (CRC) specified by POSIX
1680 for the C<cksum> command.
1684 Compute the MD5 hash (using the C<md5sum> program).
1688 Compute the SHA1 hash (using the C<sha1sum> program).
1692 Compute the SHA224 hash (using the C<sha224sum> program).
1696 Compute the SHA256 hash (using the C<sha256sum> program).
1700 Compute the SHA384 hash (using the C<sha384sum> program).
1704 Compute the SHA512 hash (using the C<sha512sum> program).
1708 The checksum is returned as a printable string.");
1710 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1711 [InitBasicFS, Always, TestOutput (
1712 [["tar_in"; "../images/helloworld.tar"; "/"];
1713 ["cat"; "/hello"]], "hello\n")],
1714 "unpack tarfile to directory",
1716 This command uploads and unpacks local file C<tarfile> (an
1717 I<uncompressed> tar file) into C<directory>.
1719 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1721 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1723 "pack directory into tarfile",
1725 This command packs the contents of C<directory> and downloads
1726 it to local file C<tarfile>.
1728 To download a compressed tarball, use C<guestfs_tgz_out>.");
1730 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1731 [InitBasicFS, Always, TestOutput (
1732 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1733 ["cat"; "/hello"]], "hello\n")],
1734 "unpack compressed tarball to directory",
1736 This command uploads and unpacks local file C<tarball> (a
1737 I<gzip compressed> tar file) into C<directory>.
1739 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1741 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1743 "pack directory into compressed tarball",
1745 This command packs the contents of C<directory> and downloads
1746 it to local file C<tarball>.
1748 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1750 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1751 [InitBasicFS, Always, TestLastFail (
1753 ["mount_ro"; "/dev/sda1"; "/"];
1754 ["touch"; "/new"]]);
1755 InitBasicFS, Always, TestOutput (
1756 [["write_file"; "/new"; "data"; "0"];
1758 ["mount_ro"; "/dev/sda1"; "/"];
1759 ["cat"; "/new"]], "data")],
1760 "mount a guest disk, read-only",
1762 This is the same as the C<guestfs_mount> command, but it
1763 mounts the filesystem with the read-only (I<-o ro>) flag.");
1765 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1767 "mount a guest disk with mount options",
1769 This is the same as the C<guestfs_mount> command, but it
1770 allows you to set the mount options as for the
1771 L<mount(8)> I<-o> flag.");
1773 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1775 "mount a guest disk with mount options and vfstype",
1777 This is the same as the C<guestfs_mount> command, but it
1778 allows you to set both the mount options and the vfstype
1779 as for the L<mount(8)> I<-o> and I<-t> flags.");
1781 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1783 "debugging and internals",
1785 The C<guestfs_debug> command exposes some internals of
1786 C<guestfsd> (the guestfs daemon) that runs inside the
1789 There is no comprehensive help for this command. You have
1790 to look at the file C<daemon/debug.c> in the libguestfs source
1791 to find out what you can do.");
1793 ("lvremove", (RErr, [String "device"]), 77, [],
1794 [InitEmpty, Always, TestOutputList (
1795 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1796 ["pvcreate"; "/dev/sda1"];
1797 ["vgcreate"; "VG"; "/dev/sda1"];
1798 ["lvcreate"; "LV1"; "VG"; "50"];
1799 ["lvcreate"; "LV2"; "VG"; "50"];
1800 ["lvremove"; "/dev/VG/LV1"];
1801 ["lvs"]], ["/dev/VG/LV2"]);
1802 InitEmpty, Always, TestOutputList (
1803 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1804 ["pvcreate"; "/dev/sda1"];
1805 ["vgcreate"; "VG"; "/dev/sda1"];
1806 ["lvcreate"; "LV1"; "VG"; "50"];
1807 ["lvcreate"; "LV2"; "VG"; "50"];
1808 ["lvremove"; "/dev/VG"];
1810 InitEmpty, Always, TestOutputList (
1811 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1812 ["pvcreate"; "/dev/sda1"];
1813 ["vgcreate"; "VG"; "/dev/sda1"];
1814 ["lvcreate"; "LV1"; "VG"; "50"];
1815 ["lvcreate"; "LV2"; "VG"; "50"];
1816 ["lvremove"; "/dev/VG"];
1818 "remove an LVM logical volume",
1820 Remove an LVM logical volume C<device>, where C<device> is
1821 the path to the LV, such as C</dev/VG/LV>.
1823 You can also remove all LVs in a volume group by specifying
1824 the VG name, C</dev/VG>.");
1826 ("vgremove", (RErr, [String "vgname"]), 78, [],
1827 [InitEmpty, Always, TestOutputList (
1828 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1829 ["pvcreate"; "/dev/sda1"];
1830 ["vgcreate"; "VG"; "/dev/sda1"];
1831 ["lvcreate"; "LV1"; "VG"; "50"];
1832 ["lvcreate"; "LV2"; "VG"; "50"];
1835 InitEmpty, Always, TestOutputList (
1836 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1837 ["pvcreate"; "/dev/sda1"];
1838 ["vgcreate"; "VG"; "/dev/sda1"];
1839 ["lvcreate"; "LV1"; "VG"; "50"];
1840 ["lvcreate"; "LV2"; "VG"; "50"];
1843 "remove an LVM volume group",
1845 Remove an LVM volume group C<vgname>, (for example C<VG>).
1847 This also forcibly removes all logical volumes in the volume
1850 ("pvremove", (RErr, [String "device"]), 79, [],
1851 [InitEmpty, Always, TestOutputListOfDevices (
1852 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1853 ["pvcreate"; "/dev/sda1"];
1854 ["vgcreate"; "VG"; "/dev/sda1"];
1855 ["lvcreate"; "LV1"; "VG"; "50"];
1856 ["lvcreate"; "LV2"; "VG"; "50"];
1858 ["pvremove"; "/dev/sda1"];
1860 InitEmpty, Always, TestOutputListOfDevices (
1861 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1862 ["pvcreate"; "/dev/sda1"];
1863 ["vgcreate"; "VG"; "/dev/sda1"];
1864 ["lvcreate"; "LV1"; "VG"; "50"];
1865 ["lvcreate"; "LV2"; "VG"; "50"];
1867 ["pvremove"; "/dev/sda1"];
1869 InitEmpty, Always, TestOutputListOfDevices (
1870 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1871 ["pvcreate"; "/dev/sda1"];
1872 ["vgcreate"; "VG"; "/dev/sda1"];
1873 ["lvcreate"; "LV1"; "VG"; "50"];
1874 ["lvcreate"; "LV2"; "VG"; "50"];
1876 ["pvremove"; "/dev/sda1"];
1878 "remove an LVM physical volume",
1880 This wipes a physical volume C<device> so that LVM will no longer
1883 The implementation uses the C<pvremove> command which refuses to
1884 wipe physical volumes that contain any volume groups, so you have
1885 to remove those first.");
1887 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1888 [InitBasicFS, Always, TestOutput (
1889 [["set_e2label"; "/dev/sda1"; "testlabel"];
1890 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1891 "set the ext2/3/4 filesystem label",
1893 This sets the ext2/3/4 filesystem label of the filesystem on
1894 C<device> to C<label>. Filesystem labels are limited to
1897 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1898 to return the existing label on a filesystem.");
1900 ("get_e2label", (RString "label", [String "device"]), 81, [],
1902 "get the ext2/3/4 filesystem label",
1904 This returns the ext2/3/4 filesystem label of the filesystem on
1907 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1908 [InitBasicFS, Always, TestOutput (
1909 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1910 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1911 InitBasicFS, Always, TestOutput (
1912 [["set_e2uuid"; "/dev/sda1"; "clear"];
1913 ["get_e2uuid"; "/dev/sda1"]], "");
1914 (* We can't predict what UUIDs will be, so just check the commands run. *)
1915 InitBasicFS, Always, TestRun (
1916 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1917 InitBasicFS, Always, TestRun (
1918 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1919 "set the ext2/3/4 filesystem UUID",
1921 This sets the ext2/3/4 filesystem UUID of the filesystem on
1922 C<device> to C<uuid>. The format of the UUID and alternatives
1923 such as C<clear>, C<random> and C<time> are described in the
1924 L<tune2fs(8)> manpage.
1926 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1927 to return the existing UUID of a filesystem.");
1929 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1931 "get the ext2/3/4 filesystem UUID",
1933 This returns the ext2/3/4 filesystem UUID of the filesystem on
1936 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1937 [InitBasicFS, Always, TestOutputInt (
1938 [["umount"; "/dev/sda1"];
1939 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1940 InitBasicFS, Always, TestOutputInt (
1941 [["umount"; "/dev/sda1"];
1942 ["zero"; "/dev/sda1"];
1943 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1944 "run the filesystem checker",
1946 This runs the filesystem checker (fsck) on C<device> which
1947 should have filesystem type C<fstype>.
1949 The returned integer is the status. See L<fsck(8)> for the
1950 list of status codes from C<fsck>.
1958 Multiple status codes can be summed together.
1962 A non-zero return code can mean \"success\", for example if
1963 errors have been corrected on the filesystem.
1967 Checking or repairing NTFS volumes is not supported
1972 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1974 ("zero", (RErr, [String "device"]), 85, [],
1975 [InitBasicFS, Always, TestOutput (
1976 [["umount"; "/dev/sda1"];
1977 ["zero"; "/dev/sda1"];
1978 ["file"; "/dev/sda1"]], "data")],
1979 "write zeroes to the device",
1981 This command writes zeroes over the first few blocks of C<device>.
1983 How many blocks are zeroed isn't specified (but it's I<not> enough
1984 to securely wipe the device). It should be sufficient to remove
1985 any partition tables, filesystem superblocks and so on.
1987 See also: C<guestfs_scrub_device>.");
1989 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1990 [InitBasicFS, Always, TestOutputTrue (
1991 [["grub_install"; "/"; "/dev/sda1"];
1992 ["is_dir"; "/boot"]])],
1995 This command installs GRUB (the Grand Unified Bootloader) on
1996 C<device>, with the root directory being C<root>.");
1998 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1999 [InitBasicFS, Always, TestOutput (
2000 [["write_file"; "/old"; "file content"; "0"];
2001 ["cp"; "/old"; "/new"];
2002 ["cat"; "/new"]], "file content");
2003 InitBasicFS, Always, TestOutputTrue (
2004 [["write_file"; "/old"; "file content"; "0"];
2005 ["cp"; "/old"; "/new"];
2006 ["is_file"; "/old"]]);
2007 InitBasicFS, Always, TestOutput (
2008 [["write_file"; "/old"; "file content"; "0"];
2010 ["cp"; "/old"; "/dir/new"];
2011 ["cat"; "/dir/new"]], "file content")],
2014 This copies a file from C<src> to C<dest> where C<dest> is
2015 either a destination filename or destination directory.");
2017 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2018 [InitBasicFS, Always, TestOutput (
2019 [["mkdir"; "/olddir"];
2020 ["mkdir"; "/newdir"];
2021 ["write_file"; "/olddir/file"; "file content"; "0"];
2022 ["cp_a"; "/olddir"; "/newdir"];
2023 ["cat"; "/newdir/olddir/file"]], "file content")],
2024 "copy a file or directory recursively",
2026 This copies a file or directory from C<src> to C<dest>
2027 recursively using the C<cp -a> command.");
2029 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2030 [InitBasicFS, Always, TestOutput (
2031 [["write_file"; "/old"; "file content"; "0"];
2032 ["mv"; "/old"; "/new"];
2033 ["cat"; "/new"]], "file content");
2034 InitBasicFS, Always, TestOutputFalse (
2035 [["write_file"; "/old"; "file content"; "0"];
2036 ["mv"; "/old"; "/new"];
2037 ["is_file"; "/old"]])],
2040 This moves a file from C<src> to C<dest> where C<dest> is
2041 either a destination filename or destination directory.");
2043 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2044 [InitEmpty, Always, TestRun (
2045 [["drop_caches"; "3"]])],
2046 "drop kernel page cache, dentries and inodes",
2048 This instructs the guest kernel to drop its page cache,
2049 and/or dentries and inode caches. The parameter C<whattodrop>
2050 tells the kernel what precisely to drop, see
2051 L<http://linux-mm.org/Drop_Caches>
2053 Setting C<whattodrop> to 3 should drop everything.
2055 This automatically calls L<sync(2)> before the operation,
2056 so that the maximum guest memory is freed.");
2058 ("dmesg", (RString "kmsgs", []), 91, [],
2059 [InitEmpty, Always, TestRun (
2061 "return kernel messages",
2063 This returns the kernel messages (C<dmesg> output) from
2064 the guest kernel. This is sometimes useful for extended
2065 debugging of problems.
2067 Another way to get the same information is to enable
2068 verbose messages with C<guestfs_set_verbose> or by setting
2069 the environment variable C<LIBGUESTFS_DEBUG=1> before
2070 running the program.");
2072 ("ping_daemon", (RErr, []), 92, [],
2073 [InitEmpty, Always, TestRun (
2074 [["ping_daemon"]])],
2075 "ping the guest daemon",
2077 This is a test probe into the guestfs daemon running inside
2078 the qemu subprocess. Calling this function checks that the
2079 daemon responds to the ping message, without affecting the daemon
2080 or attached block device(s) in any other way.");
2082 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2083 [InitBasicFS, Always, TestOutputTrue (
2084 [["write_file"; "/file1"; "contents of a file"; "0"];
2085 ["cp"; "/file1"; "/file2"];
2086 ["equal"; "/file1"; "/file2"]]);
2087 InitBasicFS, Always, TestOutputFalse (
2088 [["write_file"; "/file1"; "contents of a file"; "0"];
2089 ["write_file"; "/file2"; "contents of another file"; "0"];
2090 ["equal"; "/file1"; "/file2"]]);
2091 InitBasicFS, Always, TestLastFail (
2092 [["equal"; "/file1"; "/file2"]])],
2093 "test if two files have equal contents",
2095 This compares the two files C<file1> and C<file2> and returns
2096 true if their content is exactly equal, or false otherwise.
2098 The external L<cmp(1)> program is used for the comparison.");
2100 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2101 [InitBasicFS, Always, TestOutputList (
2102 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2103 ["strings"; "/new"]], ["hello"; "world"]);
2104 InitBasicFS, Always, TestOutputList (
2106 ["strings"; "/new"]], [])],
2107 "print the printable strings in a file",
2109 This runs the L<strings(1)> command on a file and returns
2110 the list of printable strings found.");
2112 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2113 [InitBasicFS, Always, TestOutputList (
2114 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2115 ["strings_e"; "b"; "/new"]], []);
2116 InitBasicFS, Disabled, TestOutputList (
2117 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2118 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2119 "print the printable strings in a file",
2121 This is like the C<guestfs_strings> command, but allows you to
2122 specify the encoding.
2124 See the L<strings(1)> manpage for the full list of encodings.
2126 Commonly useful encodings are C<l> (lower case L) which will
2127 show strings inside Windows/x86 files.
2129 The returned strings are transcoded to UTF-8.");
2131 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2132 [InitBasicFS, Always, TestOutput (
2133 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2134 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n")],
2135 "dump a file in hexadecimal",
2137 This runs C<hexdump -C> on the given C<path>. The result is
2138 the human-readable, canonical hex dump of the file.");
2140 ("zerofree", (RErr, [String "device"]), 97, [],
2141 [InitNone, Always, TestOutput (
2142 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2143 ["mkfs"; "ext3"; "/dev/sda1"];
2144 ["mount"; "/dev/sda1"; "/"];
2145 ["write_file"; "/new"; "test file"; "0"];
2146 ["umount"; "/dev/sda1"];
2147 ["zerofree"; "/dev/sda1"];
2148 ["mount"; "/dev/sda1"; "/"];
2149 ["cat"; "/new"]], "test file")],
2150 "zero unused inodes and disk blocks on ext2/3 filesystem",
2152 This runs the I<zerofree> program on C<device>. This program
2153 claims to zero unused inodes and disk blocks on an ext2/3
2154 filesystem, thus making it possible to compress the filesystem
2157 You should B<not> run this program if the filesystem is
2160 It is possible that using this program can damage the filesystem
2161 or data on the filesystem.");
2163 ("pvresize", (RErr, [String "device"]), 98, [],
2165 "resize an LVM physical volume",
2167 This resizes (expands or shrinks) an existing LVM physical
2168 volume to match the new size of the underlying device.");
2170 ("sfdisk_N", (RErr, [String "device"; Int "n";
2171 Int "cyls"; Int "heads"; Int "sectors";
2172 String "line"]), 99, [DangerWillRobinson],
2174 "modify a single partition on a block device",
2176 This runs L<sfdisk(8)> option to modify just the single
2177 partition C<n> (note: C<n> counts from 1).
2179 For other parameters, see C<guestfs_sfdisk>. You should usually
2180 pass C<0> for the cyls/heads/sectors parameters.");
2182 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2184 "display the partition table",
2186 This displays the partition table on C<device>, in the
2187 human-readable output of the L<sfdisk(8)> command. It is
2188 not intended to be parsed.");
2190 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2192 "display the kernel geometry",
2194 This displays the kernel's idea of the geometry of C<device>.
2196 The result is in human-readable format, and not designed to
2199 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2201 "display the disk geometry from the partition table",
2203 This displays the disk geometry of C<device> read from the
2204 partition table. Especially in the case where the underlying
2205 block device has been resized, this can be different from the
2206 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2208 The result is in human-readable format, and not designed to
2211 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2213 "activate or deactivate all volume groups",
2215 This command activates or (if C<activate> is false) deactivates
2216 all logical volumes in all volume groups.
2217 If activated, then they are made known to the
2218 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2219 then those devices disappear.
2221 This command is the same as running C<vgchange -a y|n>");
2223 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2225 "activate or deactivate some volume groups",
2227 This command activates or (if C<activate> is false) deactivates
2228 all logical volumes in the listed volume groups C<volgroups>.
2229 If activated, then they are made known to the
2230 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2231 then those devices disappear.
2233 This command is the same as running C<vgchange -a y|n volgroups...>
2235 Note that if C<volgroups> is an empty list then B<all> volume groups
2236 are activated or deactivated.");
2238 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2239 [InitNone, Always, TestOutput (
2240 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2241 ["pvcreate"; "/dev/sda1"];
2242 ["vgcreate"; "VG"; "/dev/sda1"];
2243 ["lvcreate"; "LV"; "VG"; "10"];
2244 ["mkfs"; "ext2"; "/dev/VG/LV"];
2245 ["mount"; "/dev/VG/LV"; "/"];
2246 ["write_file"; "/new"; "test content"; "0"];
2248 ["lvresize"; "/dev/VG/LV"; "20"];
2249 ["e2fsck_f"; "/dev/VG/LV"];
2250 ["resize2fs"; "/dev/VG/LV"];
2251 ["mount"; "/dev/VG/LV"; "/"];
2252 ["cat"; "/new"]], "test content")],
2253 "resize an LVM logical volume",
2255 This resizes (expands or shrinks) an existing LVM logical
2256 volume to C<mbytes>. When reducing, data in the reduced part
2259 ("resize2fs", (RErr, [String "device"]), 106, [],
2260 [], (* lvresize tests this *)
2261 "resize an ext2/ext3 filesystem",
2263 This resizes an ext2 or ext3 filesystem to match the size of
2264 the underlying device.
2266 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2267 on the C<device> before calling this command. For unknown reasons
2268 C<resize2fs> sometimes gives an error about this and sometimes not.
2269 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2270 calling this function.");
2272 ("find", (RStringList "names", [String "directory"]), 107, [],
2273 [InitBasicFS, Always, TestOutputList (
2274 [["find"; "/"]], ["lost+found"]);
2275 InitBasicFS, Always, TestOutputList (
2279 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2280 InitBasicFS, Always, TestOutputList (
2281 [["mkdir_p"; "/a/b/c"];
2282 ["touch"; "/a/b/c/d"];
2283 ["find"; "/a/b/"]], ["c"; "c/d"])],
2284 "find all files and directories",
2286 This command lists out all files and directories, recursively,
2287 starting at C<directory>. It is essentially equivalent to
2288 running the shell command C<find directory -print> but some
2289 post-processing happens on the output, described below.
2291 This returns a list of strings I<without any prefix>. Thus
2292 if the directory structure was:
2298 then the returned list from C<guestfs_find> C</tmp> would be
2306 If C<directory> is not a directory, then this command returns
2309 The returned list is sorted.");
2311 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2312 [], (* lvresize tests this *)
2313 "check an ext2/ext3 filesystem",
2315 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2316 filesystem checker on C<device>, noninteractively (C<-p>),
2317 even if the filesystem appears to be clean (C<-f>).
2319 This command is only needed because of C<guestfs_resize2fs>
2320 (q.v.). Normally you should use C<guestfs_fsck>.");
2322 ("sleep", (RErr, [Int "secs"]), 109, [],
2323 [InitNone, Always, TestRun (
2325 "sleep for some seconds",
2327 Sleep for C<secs> seconds.");
2329 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2330 [InitNone, Always, TestOutputInt (
2331 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2332 ["mkfs"; "ntfs"; "/dev/sda1"];
2333 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2334 InitNone, Always, TestOutputInt (
2335 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2336 ["mkfs"; "ext2"; "/dev/sda1"];
2337 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2338 "probe NTFS volume",
2340 This command runs the L<ntfs-3g.probe(8)> command which probes
2341 an NTFS C<device> for mountability. (Not all NTFS volumes can
2342 be mounted read-write, and some cannot be mounted at all).
2344 C<rw> is a boolean flag. Set it to true if you want to test
2345 if the volume can be mounted read-write. Set it to false if
2346 you want to test if the volume can be mounted read-only.
2348 The return value is an integer which C<0> if the operation
2349 would succeed, or some non-zero value documented in the
2350 L<ntfs-3g.probe(8)> manual page.");
2352 ("sh", (RString "output", [String "command"]), 111, [],
2353 [], (* XXX needs tests *)
2354 "run a command via the shell",
2356 This call runs a command from the guest filesystem via the
2359 This is like C<guestfs_command>, but passes the command to:
2361 /bin/sh -c \"command\"
2363 Depending on the guest's shell, this usually results in
2364 wildcards being expanded, shell expressions being interpolated
2367 All the provisos about C<guestfs_command> apply to this call.");
2369 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2370 [], (* XXX needs tests *)
2371 "run a command via the shell returning lines",
2373 This is the same as C<guestfs_sh>, but splits the result
2374 into a list of lines.
2376 See also: C<guestfs_command_lines>");
2378 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2379 [InitBasicFS, Always, TestOutputList (
2380 [["mkdir_p"; "/a/b/c"];
2381 ["touch"; "/a/b/c/d"];
2382 ["touch"; "/a/b/c/e"];
2383 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2384 InitBasicFS, Always, TestOutputList (
2385 [["mkdir_p"; "/a/b/c"];
2386 ["touch"; "/a/b/c/d"];
2387 ["touch"; "/a/b/c/e"];
2388 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2389 InitBasicFS, Always, TestOutputList (
2390 [["mkdir_p"; "/a/b/c"];
2391 ["touch"; "/a/b/c/d"];
2392 ["touch"; "/a/b/c/e"];
2393 ["glob_expand"; "/a/*/x/*"]], [])],
2394 "expand a wildcard path",
2396 This command searches for all the pathnames matching
2397 C<pattern> according to the wildcard expansion rules
2400 If no paths match, then this returns an empty list
2401 (note: not an error).
2403 It is just a wrapper around the C L<glob(3)> function
2404 with flags C<GLOB_MARK|GLOB_BRACE>.
2405 See that manual page for more details.");
2407 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2408 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2409 [["scrub_device"; "/dev/sdc"]])],
2410 "scrub (securely wipe) a device",
2412 This command writes patterns over C<device> to make data retrieval
2415 It is an interface to the L<scrub(1)> program. See that
2416 manual page for more details.");
2418 ("scrub_file", (RErr, [String "file"]), 115, [],
2419 [InitBasicFS, Always, TestRun (
2420 [["write_file"; "/file"; "content"; "0"];
2421 ["scrub_file"; "/file"]])],
2422 "scrub (securely wipe) a file",
2424 This command writes patterns over a file to make data retrieval
2427 The file is I<removed> after scrubbing.
2429 It is an interface to the L<scrub(1)> program. See that
2430 manual page for more details.");
2432 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2433 [], (* XXX needs testing *)
2434 "scrub (securely wipe) free space",
2436 This command creates the directory C<dir> and then fills it
2437 with files until the filesystem is full, and scrubs the files
2438 as for C<guestfs_scrub_file>, and deletes them.
2439 The intention is to scrub any free space on the partition
2442 It is an interface to the L<scrub(1)> program. See that
2443 manual page for more details.");
2445 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2446 [InitBasicFS, Always, TestRun (
2448 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2449 "create a temporary directory",
2451 This command creates a temporary directory. The
2452 C<template> parameter should be a full pathname for the
2453 temporary directory name with the final six characters being
2456 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2457 the second one being suitable for Windows filesystems.
2459 The name of the temporary directory that was created
2462 The temporary directory is created with mode 0700
2463 and is owned by root.
2465 The caller is responsible for deleting the temporary
2466 directory and its contents after use.
2468 See also: L<mkdtemp(3)>");
2472 let all_functions = non_daemon_functions @ daemon_functions
2474 (* In some places we want the functions to be displayed sorted
2475 * alphabetically, so this is useful:
2477 let all_functions_sorted =
2478 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2479 compare n1 n2) all_functions
2481 (* Column names and types from LVM PVs/VGs/LVs. *)
2490 "pv_attr", `String (* XXX *);
2491 "pv_pe_count", `Int;
2492 "pv_pe_alloc_count", `Int;
2495 "pv_mda_count", `Int;
2496 "pv_mda_free", `Bytes;
2497 (* Not in Fedora 10:
2498 "pv_mda_size", `Bytes;
2505 "vg_attr", `String (* XXX *);
2508 "vg_sysid", `String;
2509 "vg_extent_size", `Bytes;
2510 "vg_extent_count", `Int;
2511 "vg_free_count", `Int;
2519 "vg_mda_count", `Int;
2520 "vg_mda_free", `Bytes;
2521 (* Not in Fedora 10:
2522 "vg_mda_size", `Bytes;
2528 "lv_attr", `String (* XXX *);
2531 "lv_kernel_major", `Int;
2532 "lv_kernel_minor", `Int;
2536 "snap_percent", `OptPercent;
2537 "copy_percent", `OptPercent;
2540 "mirror_log", `String;
2544 (* Column names and types from stat structures.
2545 * NB. Can't use things like 'st_atime' because glibc header files
2546 * define some of these as macros. Ugh.
2563 let statvfs_cols = [
2577 (* Used for testing language bindings. *)
2579 | CallString of string
2580 | CallOptString of string option
2581 | CallStringList of string list
2585 (* Useful functions.
2586 * Note we don't want to use any external OCaml libraries which
2587 * makes this a bit harder than it should be.
2589 let failwithf fs = ksprintf failwith fs
2591 let replace_char s c1 c2 =
2592 let s2 = String.copy s in
2593 let r = ref false in
2594 for i = 0 to String.length s2 - 1 do
2595 if String.unsafe_get s2 i = c1 then (
2596 String.unsafe_set s2 i c2;
2600 if not !r then s else s2
2604 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2606 let triml ?(test = isspace) str =
2608 let n = ref (String.length str) in
2609 while !n > 0 && test str.[!i]; do
2614 else String.sub str !i !n
2616 let trimr ?(test = isspace) str =
2617 let n = ref (String.length str) in
2618 while !n > 0 && test str.[!n-1]; do
2621 if !n = String.length str then str
2622 else String.sub str 0 !n
2624 let trim ?(test = isspace) str =
2625 trimr ~test (triml ~test str)
2627 let rec find s sub =
2628 let len = String.length s in
2629 let sublen = String.length sub in
2631 if i <= len-sublen then (
2633 if j < sublen then (
2634 if s.[i+j] = sub.[j] then loop2 (j+1)
2640 if r = -1 then loop (i+1) else r
2646 let rec replace_str s s1 s2 =
2647 let len = String.length s in
2648 let sublen = String.length s1 in
2649 let i = find s s1 in
2652 let s' = String.sub s 0 i in
2653 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2654 s' ^ s2 ^ replace_str s'' s1 s2
2657 let rec string_split sep str =
2658 let len = String.length str in
2659 let seplen = String.length sep in
2660 let i = find str sep in
2661 if i = -1 then [str]
2663 let s' = String.sub str 0 i in
2664 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2665 s' :: string_split sep s''
2668 let files_equal n1 n2 =
2669 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2670 match Sys.command cmd with
2673 | i -> failwithf "%s: failed with error code %d" cmd i
2675 let rec find_map f = function
2676 | [] -> raise Not_found
2680 | None -> find_map f xs
2683 let rec loop i = function
2685 | x :: xs -> f i x; loop (i+1) xs
2690 let rec loop i = function
2692 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2696 let name_of_argt = function
2697 | String n | OptString n | StringList n | Bool n | Int n
2698 | FileIn n | FileOut n -> n
2700 let seq_of_test = function
2701 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2702 | TestOutputListOfDevices (s, _)
2703 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2704 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2705 | TestLastFail s -> s
2707 (* Check function names etc. for consistency. *)
2708 let check_functions () =
2709 let contains_uppercase str =
2710 let len = String.length str in
2712 if i >= len then false
2715 if c >= 'A' && c <= 'Z' then true
2722 (* Check function names. *)
2724 fun (name, _, _, _, _, _, _) ->
2725 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2726 failwithf "function name %s does not need 'guestfs' prefix" name;
2728 failwithf "function name is empty";
2729 if name.[0] < 'a' || name.[0] > 'z' then
2730 failwithf "function name %s must start with lowercase a-z" name;
2731 if String.contains name '-' then
2732 failwithf "function name %s should not contain '-', use '_' instead."
2736 (* Check function parameter/return names. *)
2738 fun (name, style, _, _, _, _, _) ->
2739 let check_arg_ret_name n =
2740 if contains_uppercase n then
2741 failwithf "%s param/ret %s should not contain uppercase chars"
2743 if String.contains n '-' || String.contains n '_' then
2744 failwithf "%s param/ret %s should not contain '-' or '_'"
2747 failwithf "%s has a param/ret called 'value', which causes conflicts in the OCaml bindings, use something like 'val' or a more descriptive name" name;
2748 if n = "int" || n = "char" || n = "short" || n = "long" then
2749 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
2751 failwithf "%s has a param/ret called 'i', which will cause some conflicts in the generated code" name;
2752 if n = "argv" || n = "args" then
2753 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
2756 (match fst style with
2758 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2759 | RStringList n | RPVList n | RVGList n | RLVList n
2760 | RStat n | RStatVFS n
2762 check_arg_ret_name n
2764 check_arg_ret_name n;
2765 check_arg_ret_name m
2767 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2770 (* Check short descriptions. *)
2772 fun (name, _, _, _, _, shortdesc, _) ->
2773 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2774 failwithf "short description of %s should begin with lowercase." name;
2775 let c = shortdesc.[String.length shortdesc-1] in
2776 if c = '\n' || c = '.' then
2777 failwithf "short description of %s should not end with . or \\n." name
2780 (* Check long dscriptions. *)
2782 fun (name, _, _, _, _, _, longdesc) ->
2783 if longdesc.[String.length longdesc-1] = '\n' then
2784 failwithf "long description of %s should not end with \\n." name
2787 (* Check proc_nrs. *)
2789 fun (name, _, proc_nr, _, _, _, _) ->
2790 if proc_nr <= 0 then
2791 failwithf "daemon function %s should have proc_nr > 0" name
2795 fun (name, _, proc_nr, _, _, _, _) ->
2796 if proc_nr <> -1 then
2797 failwithf "non-daemon function %s should have proc_nr -1" name
2798 ) non_daemon_functions;
2801 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2804 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2805 let rec loop = function
2808 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2810 | (name1,nr1) :: (name2,nr2) :: _ ->
2811 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2819 (* Ignore functions that have no tests. We generate a
2820 * warning when the user does 'make check' instead.
2822 | name, _, _, _, [], _, _ -> ()
2823 | name, _, _, _, tests, _, _ ->
2827 match seq_of_test test with
2829 failwithf "%s has a test containing an empty sequence" name
2830 | cmds -> List.map List.hd cmds
2832 let funcs = List.flatten funcs in
2834 let tested = List.mem name funcs in
2837 failwithf "function %s has tests but does not test itself" name
2840 (* 'pr' prints to the current output file. *)
2841 let chan = ref stdout
2842 let pr fs = ksprintf (output_string !chan) fs
2844 (* Generate a header block in a number of standard styles. *)
2845 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2846 type license = GPLv2 | LGPLv2
2848 let generate_header comment license =
2849 let c = match comment with
2850 | CStyle -> pr "/* "; " *"
2851 | HashStyle -> pr "# "; "#"
2852 | OCamlStyle -> pr "(* "; " *"
2853 | HaskellStyle -> pr "{- "; " " in
2854 pr "libguestfs generated file\n";
2855 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2856 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2858 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2862 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2863 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2864 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2865 pr "%s (at your option) any later version.\n" c;
2867 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2868 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2869 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2870 pr "%s GNU General Public License for more details.\n" c;
2872 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2873 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2874 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2877 pr "%s This library is free software; you can redistribute it and/or\n" c;
2878 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2879 pr "%s License as published by the Free Software Foundation; either\n" c;
2880 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2882 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2883 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2884 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2885 pr "%s Lesser General Public License for more details.\n" c;
2887 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2888 pr "%s License along with this library; if not, write to the Free Software\n" c;
2889 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2892 | CStyle -> pr " */\n"
2894 | OCamlStyle -> pr " *)\n"
2895 | HaskellStyle -> pr "-}\n"
2899 (* Start of main code generation functions below this line. *)
2901 (* Generate the pod documentation for the C API. *)
2902 let rec generate_actions_pod () =
2904 fun (shortname, style, _, flags, _, _, longdesc) ->
2905 if not (List.mem NotInDocs flags) then (
2906 let name = "guestfs_" ^ shortname in
2907 pr "=head2 %s\n\n" name;
2909 generate_prototype ~extern:false ~handle:"handle" name style;
2911 pr "%s\n\n" longdesc;
2912 (match fst style with
2914 pr "This function returns 0 on success or -1 on error.\n\n"
2916 pr "On error this function returns -1.\n\n"
2918 pr "On error this function returns -1.\n\n"
2920 pr "This function returns a C truth value on success or -1 on error.\n\n"
2922 pr "This function returns a string, or NULL on error.
2923 The string is owned by the guest handle and must I<not> be freed.\n\n"
2925 pr "This function returns a string, or NULL on error.
2926 I<The caller must free the returned string after use>.\n\n"
2928 pr "This function returns a NULL-terminated array of strings
2929 (like L<environ(3)>), or NULL if there was an error.
2930 I<The caller must free the strings and the array after use>.\n\n"
2932 pr "This function returns a C<struct guestfs_int_bool *>,
2933 or NULL if there was an error.
2934 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2936 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2937 (see E<lt>guestfs-structs.hE<gt>),
2938 or NULL if there was an error.
2939 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2941 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2942 (see E<lt>guestfs-structs.hE<gt>),
2943 or NULL if there was an error.
2944 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2946 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2947 (see E<lt>guestfs-structs.hE<gt>),
2948 or NULL if there was an error.
2949 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2951 pr "This function returns a C<struct guestfs_stat *>
2952 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2953 or NULL if there was an error.
2954 I<The caller must call C<free> after use>.\n\n"
2956 pr "This function returns a C<struct guestfs_statvfs *>
2957 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2958 or NULL if there was an error.
2959 I<The caller must call C<free> after use>.\n\n"
2961 pr "This function returns a NULL-terminated array of
2962 strings, or NULL if there was an error.
2963 The array of strings will always have length C<2n+1>, where
2964 C<n> keys and values alternate, followed by the trailing NULL entry.
2965 I<The caller must free the strings and the array after use>.\n\n"
2967 if List.mem ProtocolLimitWarning flags then
2968 pr "%s\n\n" protocol_limit_warning;
2969 if List.mem DangerWillRobinson flags then
2970 pr "%s\n\n" danger_will_robinson
2972 ) all_functions_sorted
2974 and generate_structs_pod () =
2975 (* LVM structs documentation. *)
2978 pr "=head2 guestfs_lvm_%s\n" typ;
2980 pr " struct guestfs_lvm_%s {\n" typ;
2983 | name, `String -> pr " char *%s;\n" name
2985 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2986 pr " char %s[32];\n" name
2987 | name, `Bytes -> pr " uint64_t %s;\n" name
2988 | name, `Int -> pr " int64_t %s;\n" name
2989 | name, `OptPercent ->
2990 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2991 pr " float %s;\n" name
2994 pr " struct guestfs_lvm_%s_list {\n" typ;
2995 pr " uint32_t len; /* Number of elements in list. */\n";
2996 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2999 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
3002 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3004 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3005 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3007 * We have to use an underscore instead of a dash because otherwise
3008 * rpcgen generates incorrect code.
3010 * This header is NOT exported to clients, but see also generate_structs_h.
3012 and generate_xdr () =
3013 generate_header CStyle LGPLv2;
3015 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3016 pr "typedef string str<>;\n";
3019 (* LVM internal structures. *)
3023 pr "struct guestfs_lvm_int_%s {\n" typ;
3025 | name, `String -> pr " string %s<>;\n" name
3026 | name, `UUID -> pr " opaque %s[32];\n" name
3027 | name, `Bytes -> pr " hyper %s;\n" name
3028 | name, `Int -> pr " hyper %s;\n" name
3029 | name, `OptPercent -> pr " float %s;\n" name
3033 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
3035 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3037 (* Stat internal structures. *)
3041 pr "struct guestfs_int_%s {\n" typ;
3043 | name, `Int -> pr " hyper %s;\n" name
3047 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3050 fun (shortname, style, _, _, _, _, _) ->
3051 let name = "guestfs_" ^ shortname in
3053 (match snd style with
3056 pr "struct %s_args {\n" name;
3059 | String n -> pr " string %s<>;\n" n
3060 | OptString n -> pr " str *%s;\n" n
3061 | StringList n -> pr " str %s<>;\n" n
3062 | Bool n -> pr " bool %s;\n" n
3063 | Int n -> pr " int %s;\n" n
3064 | FileIn _ | FileOut _ -> ()
3068 (match fst style with
3071 pr "struct %s_ret {\n" name;
3075 pr "struct %s_ret {\n" name;
3076 pr " hyper %s;\n" n;
3079 pr "struct %s_ret {\n" name;
3083 failwithf "RConstString cannot be returned from a daemon function"
3085 pr "struct %s_ret {\n" name;
3086 pr " string %s<>;\n" n;
3089 pr "struct %s_ret {\n" name;
3090 pr " str %s<>;\n" n;
3093 pr "struct %s_ret {\n" name;
3098 pr "struct %s_ret {\n" name;
3099 pr " guestfs_lvm_int_pv_list %s;\n" n;
3102 pr "struct %s_ret {\n" name;
3103 pr " guestfs_lvm_int_vg_list %s;\n" n;
3106 pr "struct %s_ret {\n" name;
3107 pr " guestfs_lvm_int_lv_list %s;\n" n;
3110 pr "struct %s_ret {\n" name;
3111 pr " guestfs_int_stat %s;\n" n;
3114 pr "struct %s_ret {\n" name;
3115 pr " guestfs_int_statvfs %s;\n" n;
3118 pr "struct %s_ret {\n" name;
3119 pr " str %s<>;\n" n;
3124 (* Table of procedure numbers. *)
3125 pr "enum guestfs_procedure {\n";
3127 fun (shortname, _, proc_nr, _, _, _, _) ->
3128 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3130 pr " GUESTFS_PROC_NR_PROCS\n";
3134 (* Having to choose a maximum message size is annoying for several
3135 * reasons (it limits what we can do in the API), but it (a) makes
3136 * the protocol a lot simpler, and (b) provides a bound on the size
3137 * of the daemon which operates in limited memory space. For large
3138 * file transfers you should use FTP.
3140 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3143 (* Message header, etc. *)
3145 /* The communication protocol is now documented in the guestfs(3)
3149 const GUESTFS_PROGRAM = 0x2000F5F5;
3150 const GUESTFS_PROTOCOL_VERSION = 1;
3152 /* These constants must be larger than any possible message length. */
3153 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3154 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3156 enum guestfs_message_direction {
3157 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3158 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3161 enum guestfs_message_status {
3162 GUESTFS_STATUS_OK = 0,
3163 GUESTFS_STATUS_ERROR = 1
3166 const GUESTFS_ERROR_LEN = 256;
3168 struct guestfs_message_error {
3169 string error_message<GUESTFS_ERROR_LEN>;
3172 struct guestfs_message_header {
3173 unsigned prog; /* GUESTFS_PROGRAM */
3174 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3175 guestfs_procedure proc; /* GUESTFS_PROC_x */
3176 guestfs_message_direction direction;
3177 unsigned serial; /* message serial number */
3178 guestfs_message_status status;
3181 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3183 struct guestfs_chunk {
3184 int cancel; /* if non-zero, transfer is cancelled */
3185 /* data size is 0 bytes if the transfer has finished successfully */
3186 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3190 (* Generate the guestfs-structs.h file. *)
3191 and generate_structs_h () =
3192 generate_header CStyle LGPLv2;
3194 (* This is a public exported header file containing various
3195 * structures. The structures are carefully written to have
3196 * exactly the same in-memory format as the XDR structures that
3197 * we use on the wire to the daemon. The reason for creating
3198 * copies of these structures here is just so we don't have to
3199 * export the whole of guestfs_protocol.h (which includes much
3200 * unrelated and XDR-dependent stuff that we don't want to be
3201 * public, or required by clients).
3203 * To reiterate, we will pass these structures to and from the
3204 * client with a simple assignment or memcpy, so the format
3205 * must be identical to what rpcgen / the RFC defines.
3208 (* guestfs_int_bool structure. *)
3209 pr "struct guestfs_int_bool {\n";
3215 (* LVM public structures. *)
3219 pr "struct guestfs_lvm_%s {\n" typ;
3222 | name, `String -> pr " char *%s;\n" name
3223 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3224 | name, `Bytes -> pr " uint64_t %s;\n" name
3225 | name, `Int -> pr " int64_t %s;\n" name
3226 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3230 pr "struct guestfs_lvm_%s_list {\n" typ;
3231 pr " uint32_t len;\n";
3232 pr " struct guestfs_lvm_%s *val;\n" typ;
3235 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3237 (* Stat structures. *)
3241 pr "struct guestfs_%s {\n" typ;
3244 | name, `Int -> pr " int64_t %s;\n" name
3248 ) ["stat", stat_cols; "statvfs", statvfs_cols]
3250 (* Generate the guestfs-actions.h file. *)
3251 and generate_actions_h () =
3252 generate_header CStyle LGPLv2;
3254 fun (shortname, style, _, _, _, _, _) ->
3255 let name = "guestfs_" ^ shortname in
3256 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3260 (* Generate the client-side dispatch stubs. *)
3261 and generate_client_actions () =
3262 generate_header CStyle LGPLv2;
3268 #include \"guestfs.h\"
3269 #include \"guestfs_protocol.h\"
3271 #define error guestfs_error
3272 #define perrorf guestfs_perrorf
3273 #define safe_malloc guestfs_safe_malloc
3274 #define safe_realloc guestfs_safe_realloc
3275 #define safe_strdup guestfs_safe_strdup
3276 #define safe_memdup guestfs_safe_memdup
3278 /* Check the return message from a call for validity. */
3280 check_reply_header (guestfs_h *g,
3281 const struct guestfs_message_header *hdr,
3282 int proc_nr, int serial)
3284 if (hdr->prog != GUESTFS_PROGRAM) {
3285 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3288 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3289 error (g, \"wrong protocol version (%%d/%%d)\",
3290 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3293 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3294 error (g, \"unexpected message direction (%%d/%%d)\",
3295 hdr->direction, GUESTFS_DIRECTION_REPLY);
3298 if (hdr->proc != proc_nr) {
3299 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3302 if (hdr->serial != serial) {
3303 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3310 /* Check we are in the right state to run a high-level action. */
3312 check_state (guestfs_h *g, const char *caller)
3314 if (!guestfs_is_ready (g)) {
3315 if (guestfs_is_config (g))
3316 error (g, \"%%s: call launch() before using this function\",
3318 else if (guestfs_is_launching (g))
3319 error (g, \"%%s: call wait_ready() before using this function\",
3322 error (g, \"%%s called from the wrong state, %%d != READY\",
3323 caller, guestfs_get_state (g));
3331 (* Client-side stubs for each function. *)
3333 fun (shortname, style, _, _, _, _, _) ->
3334 let name = "guestfs_" ^ shortname in
3336 (* Generate the context struct which stores the high-level
3337 * state between callback functions.
3339 pr "struct %s_ctx {\n" shortname;
3340 pr " /* This flag is set by the callbacks, so we know we've done\n";
3341 pr " * the callbacks as expected, and in the right sequence.\n";
3342 pr " * 0 = not called, 1 = reply_cb called.\n";
3344 pr " int cb_sequence;\n";
3345 pr " struct guestfs_message_header hdr;\n";
3346 pr " struct guestfs_message_error err;\n";
3347 (match fst style with
3350 failwithf "RConstString cannot be returned from a daemon function"
3352 | RBool _ | RString _ | RStringList _
3354 | RPVList _ | RVGList _ | RLVList _
3355 | RStat _ | RStatVFS _
3357 pr " struct %s_ret ret;\n" name
3362 (* Generate the reply callback function. *)
3363 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3365 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3366 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3368 pr " /* This should definitely not happen. */\n";
3369 pr " if (ctx->cb_sequence != 0) {\n";
3370 pr " ctx->cb_sequence = 9999;\n";
3371 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3375 pr " ml->main_loop_quit (ml, g);\n";
3377 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3378 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3381 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3382 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3383 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3390 (match fst style with
3393 failwithf "RConstString cannot be returned from a daemon function"
3395 | RBool _ | RString _ | RStringList _
3397 | RPVList _ | RVGList _ | RLVList _
3398 | RStat _ | RStatVFS _
3400 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3401 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3407 pr " ctx->cb_sequence = 1;\n";
3410 (* Generate the action stub. *)
3411 generate_prototype ~extern:false ~semicolon:false ~newline:true
3412 ~handle:"g" name style;
3415 match fst style with
3416 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3418 failwithf "RConstString cannot be returned from a daemon function"
3419 | RString _ | RStringList _ | RIntBool _
3420 | RPVList _ | RVGList _ | RLVList _
3421 | RStat _ | RStatVFS _
3427 (match snd style with
3429 | _ -> pr " struct %s_args args;\n" name
3432 pr " struct %s_ctx ctx;\n" shortname;
3433 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3434 pr " int serial;\n";
3436 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3437 pr " guestfs_set_busy (g);\n";
3439 pr " memset (&ctx, 0, sizeof ctx);\n";
3442 (* Send the main header and arguments. *)
3443 (match snd style with
3445 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3446 (String.uppercase shortname)
3451 pr " args.%s = (char *) %s;\n" n n
3453 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3455 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3456 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3458 pr " args.%s = %s;\n" n n
3460 pr " args.%s = %s;\n" n n
3461 | FileIn _ | FileOut _ -> ()
3463 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3464 (String.uppercase shortname);
3465 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3468 pr " if (serial == -1) {\n";
3469 pr " guestfs_end_busy (g);\n";
3470 pr " return %s;\n" error_code;
3474 (* Send any additional files (FileIn) requested. *)
3475 let need_read_reply_label = ref false in
3482 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3483 pr " if (r == -1) {\n";
3484 pr " guestfs_end_busy (g);\n";
3485 pr " return %s;\n" error_code;
3487 pr " if (r == -2) /* daemon cancelled */\n";
3488 pr " goto read_reply;\n";
3489 need_read_reply_label := true;
3495 (* Wait for the reply from the remote end. *)
3496 if !need_read_reply_label then pr " read_reply:\n";
3497 pr " guestfs__switch_to_receiving (g);\n";
3498 pr " ctx.cb_sequence = 0;\n";
3499 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3500 pr " (void) ml->main_loop_run (ml, g);\n";
3501 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3502 pr " if (ctx.cb_sequence != 1) {\n";
3503 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3504 pr " guestfs_end_busy (g);\n";
3505 pr " return %s;\n" error_code;
3509 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3510 (String.uppercase shortname);
3511 pr " guestfs_end_busy (g);\n";
3512 pr " return %s;\n" error_code;
3516 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3517 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3518 pr " free (ctx.err.error_message);\n";
3519 pr " guestfs_end_busy (g);\n";
3520 pr " return %s;\n" error_code;
3524 (* Expecting to receive further files (FileOut)? *)
3528 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3529 pr " guestfs_end_busy (g);\n";
3530 pr " return %s;\n" error_code;
3536 pr " guestfs_end_busy (g);\n";
3538 (match fst style with
3539 | RErr -> pr " return 0;\n"
3540 | RInt n | RInt64 n | RBool n ->
3541 pr " return ctx.ret.%s;\n" n
3543 failwithf "RConstString cannot be returned from a daemon function"
3545 pr " return ctx.ret.%s; /* caller will free */\n" n
3546 | RStringList n | RHashtable n ->
3547 pr " /* caller will free this, but we need to add a NULL entry */\n";
3548 pr " ctx.ret.%s.%s_val =\n" n n;
3549 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3550 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3552 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3553 pr " return ctx.ret.%s.%s_val;\n" n n
3555 pr " /* caller with free this */\n";
3556 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3557 | RPVList n | RVGList n | RLVList n
3558 | RStat n | RStatVFS n ->
3559 pr " /* caller will free this */\n";
3560 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3566 (* Generate daemon/actions.h. *)
3567 and generate_daemon_actions_h () =
3568 generate_header CStyle GPLv2;
3570 pr "#include \"../src/guestfs_protocol.h\"\n";
3574 fun (name, style, _, _, _, _, _) ->
3576 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3580 (* Generate the server-side stubs. *)
3581 and generate_daemon_actions () =
3582 generate_header CStyle GPLv2;
3584 pr "#include <config.h>\n";
3586 pr "#include <stdio.h>\n";
3587 pr "#include <stdlib.h>\n";
3588 pr "#include <string.h>\n";
3589 pr "#include <inttypes.h>\n";
3590 pr "#include <ctype.h>\n";
3591 pr "#include <rpc/types.h>\n";
3592 pr "#include <rpc/xdr.h>\n";
3594 pr "#include \"daemon.h\"\n";
3595 pr "#include \"../src/guestfs_protocol.h\"\n";
3596 pr "#include \"actions.h\"\n";
3600 fun (name, style, _, _, _, _, _) ->
3601 (* Generate server-side stubs. *)
3602 pr "static void %s_stub (XDR *xdr_in)\n" name;
3605 match fst style with
3606 | RErr | RInt _ -> pr " int r;\n"; "-1"
3607 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3608 | RBool _ -> pr " int r;\n"; "-1"
3610 failwithf "RConstString cannot be returned from a daemon function"
3611 | RString _ -> pr " char *r;\n"; "NULL"
3612 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
3613 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
3614 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
3615 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
3616 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
3617 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
3618 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
3620 (match snd style with
3623 pr " struct guestfs_%s_args args;\n" name;
3626 (* Note we allow the string to be writable, in order to
3627 * allow device name translation. This is safe because
3628 * we can modify the string (passed from RPC).
3631 | OptString n -> pr " char *%s;\n" n
3632 | StringList n -> pr " char **%s;\n" n
3633 | Bool n -> pr " int %s;\n" n
3634 | Int n -> pr " int %s;\n" n
3635 | FileIn _ | FileOut _ -> ()
3640 (match snd style with
3643 pr " memset (&args, 0, sizeof args);\n";
3645 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3646 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3651 | String n -> pr " %s = args.%s;\n" n n
3652 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3654 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3655 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3656 pr " if (%s == NULL) {\n" n;
3657 pr " reply_with_perror (\"realloc\");\n";
3660 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3661 pr " args.%s.%s_val = %s;\n" n n n;
3662 | Bool n -> pr " %s = args.%s;\n" n n
3663 | Int n -> pr " %s = args.%s;\n" n n
3664 | FileIn _ | FileOut _ -> ()
3669 (* Don't want to call the impl with any FileIn or FileOut
3670 * parameters, since these go "outside" the RPC protocol.
3673 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3675 pr " r = do_%s " name;
3676 generate_call_args argsnofile;
3679 pr " if (r == %s)\n" error_code;
3680 pr " /* do_%s has already called reply_with_error */\n" name;
3684 (* If there are any FileOut parameters, then the impl must
3685 * send its own reply.
3688 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3690 pr " /* do_%s has already sent a reply */\n" name
3692 match fst style with
3693 | RErr -> pr " reply (NULL, NULL);\n"
3694 | RInt n | RInt64 n | RBool n ->
3695 pr " struct guestfs_%s_ret ret;\n" name;
3696 pr " ret.%s = r;\n" n;
3697 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3700 failwithf "RConstString cannot be returned from a daemon function"
3702 pr " struct guestfs_%s_ret ret;\n" name;
3703 pr " ret.%s = r;\n" n;
3704 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3707 | RStringList n | RHashtable n ->
3708 pr " struct guestfs_%s_ret ret;\n" name;
3709 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3710 pr " ret.%s.%s_val = r;\n" n n;
3711 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3713 pr " free_strings (r);\n"
3715 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3717 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3718 | RPVList n | RVGList n | RLVList n
3719 | RStat n | RStatVFS n ->
3720 pr " struct guestfs_%s_ret ret;\n" name;
3721 pr " ret.%s = *r;\n" n;
3722 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3724 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3728 (* Free the args. *)
3729 (match snd style with
3734 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3741 (* Dispatch function. *)
3742 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3744 pr " switch (proc_nr) {\n";
3747 fun (name, style, _, _, _, _, _) ->
3748 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3749 pr " %s_stub (xdr_in);\n" name;
3754 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d, set LIBGUESTFS_PATH to point to the matching libguestfs appliance directory\", proc_nr);\n";
3759 (* LVM columns and tokenization functions. *)
3760 (* XXX This generates crap code. We should rethink how we
3766 pr "static const char *lvm_%s_cols = \"%s\";\n"
3767 typ (String.concat "," (List.map fst cols));
3770 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3772 pr " char *tok, *p, *next;\n";
3776 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3779 pr " if (!str) {\n";
3780 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3783 pr " if (!*str || isspace (*str)) {\n";
3784 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3789 fun (name, coltype) ->
3790 pr " if (!tok) {\n";
3791 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3794 pr " p = strchrnul (tok, ',');\n";
3795 pr " if (*p) next = p+1; else next = NULL;\n";
3796 pr " *p = '\\0';\n";
3799 pr " r->%s = strdup (tok);\n" name;
3800 pr " if (r->%s == NULL) {\n" name;
3801 pr " perror (\"strdup\");\n";
3805 pr " for (i = j = 0; i < 32; ++j) {\n";
3806 pr " if (tok[j] == '\\0') {\n";
3807 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3809 pr " } else if (tok[j] != '-')\n";
3810 pr " r->%s[i++] = tok[j];\n" name;
3813 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3814 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3818 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3819 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3823 pr " if (tok[0] == '\\0')\n";
3824 pr " r->%s = -1;\n" name;
3825 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3826 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3830 pr " tok = next;\n";
3833 pr " if (tok != NULL) {\n";
3834 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3841 pr "guestfs_lvm_int_%s_list *\n" typ;
3842 pr "parse_command_line_%ss (void)\n" typ;
3844 pr " char *out, *err;\n";
3845 pr " char *p, *pend;\n";
3847 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3848 pr " void *newp;\n";
3850 pr " ret = malloc (sizeof *ret);\n";
3851 pr " if (!ret) {\n";
3852 pr " reply_with_perror (\"malloc\");\n";
3853 pr " return NULL;\n";
3856 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3857 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3859 pr " r = command (&out, &err,\n";
3860 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3861 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3862 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3863 pr " if (r == -1) {\n";
3864 pr " reply_with_error (\"%%s\", err);\n";
3865 pr " free (out);\n";
3866 pr " free (err);\n";
3867 pr " free (ret);\n";
3868 pr " return NULL;\n";
3871 pr " free (err);\n";
3873 pr " /* Tokenize each line of the output. */\n";
3876 pr " while (p) {\n";
3877 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3878 pr " if (pend) {\n";
3879 pr " *pend = '\\0';\n";
3883 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3886 pr " if (!*p) { /* Empty line? Skip it. */\n";
3891 pr " /* Allocate some space to store this next entry. */\n";
3892 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3893 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3894 pr " if (newp == NULL) {\n";
3895 pr " reply_with_perror (\"realloc\");\n";
3896 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3897 pr " free (ret);\n";
3898 pr " free (out);\n";
3899 pr " return NULL;\n";
3901 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3903 pr " /* Tokenize the next entry. */\n";
3904 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3905 pr " if (r == -1) {\n";
3906 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3907 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3908 pr " free (ret);\n";
3909 pr " free (out);\n";
3910 pr " return NULL;\n";
3917 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3919 pr " free (out);\n";
3920 pr " return ret;\n";
3923 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3925 (* Generate the tests. *)
3926 and generate_tests () =
3927 generate_header CStyle GPLv2;
3934 #include <sys/types.h>
3937 #include \"guestfs.h\"
3939 static guestfs_h *g;
3940 static int suppress_error = 0;
3942 static void print_error (guestfs_h *g, void *data, const char *msg)
3944 if (!suppress_error)
3945 fprintf (stderr, \"%%s\\n\", msg);
3948 static void print_strings (char * const * const argv)
3952 for (argc = 0; argv[argc] != NULL; ++argc)
3953 printf (\"\\t%%s\\n\", argv[argc]);
3957 static void print_table (char * const * const argv)
3961 for (i = 0; argv[i] != NULL; i += 2)
3962 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3966 static void no_test_warnings (void)
3972 | name, _, _, _, [], _, _ ->
3973 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3974 | name, _, _, _, tests, _, _ -> ()
3980 (* Generate the actual tests. Note that we generate the tests
3981 * in reverse order, deliberately, so that (in general) the
3982 * newest tests run first. This makes it quicker and easier to
3987 fun (name, _, _, _, tests, _, _) ->
3988 mapi (generate_one_test name) tests
3989 ) (List.rev all_functions) in
3990 let test_names = List.concat test_names in
3991 let nr_tests = List.length test_names in
3994 int main (int argc, char *argv[])
3998 const char *filename;
4000 int nr_tests, test_num = 0;
4002 no_test_warnings ();
4004 g = guestfs_create ();
4006 printf (\"guestfs_create FAILED\\n\");
4010 guestfs_set_error_handler (g, print_error, NULL);
4012 guestfs_set_path (g, \"../appliance\");
4014 filename = \"test1.img\";
4015 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4020 if (lseek (fd, %d, SEEK_SET) == -1) {
4026 if (write (fd, &c, 1) == -1) {
4032 if (close (fd) == -1) {
4037 if (guestfs_add_drive (g, filename) == -1) {
4038 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4042 filename = \"test2.img\";
4043 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4048 if (lseek (fd, %d, SEEK_SET) == -1) {
4054 if (write (fd, &c, 1) == -1) {
4060 if (close (fd) == -1) {
4065 if (guestfs_add_drive (g, filename) == -1) {
4066 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4070 filename = \"test3.img\";
4071 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4076 if (lseek (fd, %d, SEEK_SET) == -1) {
4082 if (write (fd, &c, 1) == -1) {
4088 if (close (fd) == -1) {
4093 if (guestfs_add_drive (g, filename) == -1) {
4094 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4098 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4099 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4103 if (guestfs_launch (g) == -1) {
4104 printf (\"guestfs_launch FAILED\\n\");
4108 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4111 if (guestfs_wait_ready (g) == -1) {
4112 printf (\"guestfs_wait_ready FAILED\\n\");
4116 /* Cancel previous alarm. */
4121 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4125 pr " test_num++;\n";
4126 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4127 pr " if (%s () == -1) {\n" test_name;
4128 pr " printf (\"%s FAILED\\n\");\n" test_name;
4134 pr " guestfs_close (g);\n";
4135 pr " unlink (\"test1.img\");\n";
4136 pr " unlink (\"test2.img\");\n";
4137 pr " unlink (\"test3.img\");\n";
4140 pr " if (failed > 0) {\n";
4141 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4149 and generate_one_test name i (init, prereq, test) =
4150 let test_name = sprintf "test_%s_%d" name i in
4153 static int %s_skip (void)
4157 str = getenv (\"SKIP_%s\");
4158 if (str && strcmp (str, \"1\") == 0) return 1;
4159 str = getenv (\"SKIP_TEST_%s\");
4160 if (str && strcmp (str, \"1\") == 0) return 1;
4164 " test_name (String.uppercase test_name) (String.uppercase name);
4167 | Disabled | Always -> ()
4168 | If code | Unless code ->
4169 pr "static int %s_prereq (void)\n" test_name;
4177 static int %s (void)
4180 printf (\"%%s skipped (reason: SKIP_TEST_* variable set)\\n\", \"%s\");
4184 " test_name test_name test_name;
4188 pr " printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4190 pr " if (! %s_prereq ()) {\n" test_name;
4191 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4195 generate_one_test_body name i test_name init test;
4197 pr " if (%s_prereq ()) {\n" test_name;
4198 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4202 generate_one_test_body name i test_name init test;
4204 generate_one_test_body name i test_name init test
4212 and generate_one_test_body name i test_name init test =
4216 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4217 List.iter (generate_test_command_call test_name)
4218 [["blockdev_setrw"; "/dev/sda"];
4222 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4223 List.iter (generate_test_command_call test_name)
4224 [["blockdev_setrw"; "/dev/sda"];
4227 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4228 ["mkfs"; "ext2"; "/dev/sda1"];
4229 ["mount"; "/dev/sda1"; "/"]]
4230 | InitBasicFSonLVM ->
4231 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4233 List.iter (generate_test_command_call test_name)
4234 [["blockdev_setrw"; "/dev/sda"];
4237 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4238 ["pvcreate"; "/dev/sda1"];
4239 ["vgcreate"; "VG"; "/dev/sda1"];
4240 ["lvcreate"; "LV"; "VG"; "8"];
4241 ["mkfs"; "ext2"; "/dev/VG/LV"];
4242 ["mount"; "/dev/VG/LV"; "/"]]
4245 let get_seq_last = function
4247 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4250 let seq = List.rev seq in
4251 List.rev (List.tl seq), List.hd seq
4256 pr " /* TestRun for %s (%d) */\n" name i;
4257 List.iter (generate_test_command_call test_name) seq
4258 | TestOutput (seq, expected) ->
4259 pr " /* TestOutput for %s (%d) */\n" name i;
4260 pr " char expected[] = \"%s\";\n" (c_quote expected);
4261 let seq, last = get_seq_last seq in
4263 pr " if (strcmp (r, expected) != 0) {\n";
4264 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4268 List.iter (generate_test_command_call test_name) seq;
4269 generate_test_command_call ~test test_name last
4270 | TestOutputList (seq, expected) ->
4271 pr " /* TestOutputList for %s (%d) */\n" name i;
4272 let seq, last = get_seq_last seq in
4276 pr " if (!r[%d]) {\n" i;
4277 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4278 pr " print_strings (r);\n";
4282 pr " char expected[] = \"%s\";\n" (c_quote str);
4283 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4284 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4289 pr " if (r[%d] != NULL) {\n" (List.length expected);
4290 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4292 pr " print_strings (r);\n";
4296 List.iter (generate_test_command_call test_name) seq;
4297 generate_test_command_call ~test test_name last
4298 | TestOutputListOfDevices (seq, expected) ->
4299 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
4300 let seq, last = get_seq_last seq in
4304 pr " if (!r[%d]) {\n" i;
4305 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4306 pr " print_strings (r);\n";
4310 pr " char expected[] = \"%s\";\n" (c_quote str);
4311 pr " r[%d][5] = 's';\n" i;
4312 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4313 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4318 pr " if (r[%d] != NULL) {\n" (List.length expected);
4319 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4321 pr " print_strings (r);\n";
4325 List.iter (generate_test_command_call test_name) seq;
4326 generate_test_command_call ~test test_name last
4327 | TestOutputInt (seq, expected) ->
4328 pr " /* TestOutputInt for %s (%d) */\n" name i;
4329 let seq, last = get_seq_last seq in
4331 pr " if (r != %d) {\n" expected;
4332 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4338 List.iter (generate_test_command_call test_name) seq;
4339 generate_test_command_call ~test test_name last
4340 | TestOutputTrue seq ->
4341 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4342 let seq, last = get_seq_last seq in
4345 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4350 List.iter (generate_test_command_call test_name) seq;
4351 generate_test_command_call ~test test_name last
4352 | TestOutputFalse seq ->
4353 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4354 let seq, last = get_seq_last seq in
4357 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4362 List.iter (generate_test_command_call test_name) seq;
4363 generate_test_command_call ~test test_name last
4364 | TestOutputLength (seq, expected) ->
4365 pr " /* TestOutputLength for %s (%d) */\n" name i;
4366 let seq, last = get_seq_last seq in
4369 pr " for (j = 0; j < %d; ++j)\n" expected;
4370 pr " if (r[j] == NULL) {\n";
4371 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4373 pr " print_strings (r);\n";
4376 pr " if (r[j] != NULL) {\n";
4377 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4379 pr " print_strings (r);\n";
4383 List.iter (generate_test_command_call test_name) seq;
4384 generate_test_command_call ~test test_name last
4385 | TestOutputStruct (seq, checks) ->
4386 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4387 let seq, last = get_seq_last seq in
4391 | CompareWithInt (field, expected) ->
4392 pr " if (r->%s != %d) {\n" field expected;
4393 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4394 test_name field expected;
4395 pr " (int) r->%s);\n" field;
4398 | CompareWithString (field, expected) ->
4399 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4400 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4401 test_name field expected;
4402 pr " r->%s);\n" field;
4405 | CompareFieldsIntEq (field1, field2) ->
4406 pr " if (r->%s != r->%s) {\n" field1 field2;
4407 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4408 test_name field1 field2;
4409 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
4412 | CompareFieldsStrEq (field1, field2) ->
4413 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4414 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4415 test_name field1 field2;
4416 pr " r->%s, r->%s);\n" field1 field2;
4421 List.iter (generate_test_command_call test_name) seq;
4422 generate_test_command_call ~test test_name last
4423 | TestLastFail seq ->
4424 pr " /* TestLastFail for %s (%d) */\n" name i;
4425 let seq, last = get_seq_last seq in
4426 List.iter (generate_test_command_call test_name) seq;
4427 generate_test_command_call test_name ~expect_error:true last
4429 (* Generate the code to run a command, leaving the result in 'r'.
4430 * If you expect to get an error then you should set expect_error:true.
4432 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4434 | [] -> assert false
4436 (* Look up the command to find out what args/ret it has. *)
4439 let _, style, _, _, _, _, _ =
4440 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4443 failwithf "%s: in test, command %s was not found" test_name name in
4445 if List.length (snd style) <> List.length args then
4446 failwithf "%s: in test, wrong number of args given to %s"
4453 | OptString n, "NULL" -> ()
4455 | OptString n, arg ->
4456 pr " char %s[] = \"%s\";\n" n (c_quote arg);
4459 | FileIn _, _ | FileOut _, _ -> ()
4460 | StringList n, arg ->
4461 let strs = string_split " " arg in
4464 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
4466 pr " char *%s[] = {\n" n;
4468 fun i _ -> pr " %s_%d,\n" n i
4472 ) (List.combine (snd style) args);
4475 match fst style with
4476 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
4477 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4478 | RConstString _ -> pr " const char *r;\n"; "NULL"
4479 | RString _ -> pr " char *r;\n"; "NULL"
4480 | RStringList _ | RHashtable _ ->
4485 pr " struct guestfs_int_bool *r;\n"; "NULL"
4487 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4489 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4491 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4493 pr " struct guestfs_stat *r;\n"; "NULL"
4495 pr " struct guestfs_statvfs *r;\n"; "NULL" in
4497 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4498 pr " r = guestfs_%s (g" name;
4500 (* Generate the parameters. *)
4503 | OptString _, "NULL" -> pr ", NULL"
4507 | FileIn _, arg | FileOut _, arg ->
4508 pr ", \"%s\"" (c_quote arg)
4509 | StringList n, _ ->
4513 try int_of_string arg
4514 with Failure "int_of_string" ->
4515 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4518 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4519 ) (List.combine (snd style) args);
4522 if not expect_error then
4523 pr " if (r == %s)\n" error_code
4525 pr " if (r != %s)\n" error_code;
4528 (* Insert the test code. *)
4534 (match fst style with
4535 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4536 | RString _ -> pr " free (r);\n"
4537 | RStringList _ | RHashtable _ ->
4538 pr " for (i = 0; r[i] != NULL; ++i)\n";
4539 pr " free (r[i]);\n";
4542 pr " guestfs_free_int_bool (r);\n"
4544 pr " guestfs_free_lvm_pv_list (r);\n"
4546 pr " guestfs_free_lvm_vg_list (r);\n"
4548 pr " guestfs_free_lvm_lv_list (r);\n"
4549 | RStat _ | RStatVFS _ ->
4556 let str = replace_str str "\r" "\\r" in
4557 let str = replace_str str "\n" "\\n" in
4558 let str = replace_str str "\t" "\\t" in
4559 let str = replace_str str "\000" "\\0" in
4562 (* Generate a lot of different functions for guestfish. *)
4563 and generate_fish_cmds () =
4564 generate_header CStyle GPLv2;
4568 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4570 let all_functions_sorted =
4572 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4573 ) all_functions_sorted in
4575 pr "#include <stdio.h>\n";
4576 pr "#include <stdlib.h>\n";
4577 pr "#include <string.h>\n";
4578 pr "#include <inttypes.h>\n";
4580 pr "#include <guestfs.h>\n";
4581 pr "#include \"fish.h\"\n";
4584 (* list_commands function, which implements guestfish -h *)
4585 pr "void list_commands (void)\n";
4587 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
4588 pr " list_builtin_commands ();\n";
4590 fun (name, _, _, flags, _, shortdesc, _) ->
4591 let name = replace_char name '_' '-' in
4592 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4594 ) all_functions_sorted;
4595 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4599 (* display_command function, which implements guestfish -h cmd *)
4600 pr "void display_command (const char *cmd)\n";
4603 fun (name, style, _, flags, _, shortdesc, longdesc) ->
4604 let name2 = replace_char name '_' '-' in
4606 try find_map (function FishAlias n -> Some n | _ -> None) flags
4607 with Not_found -> name in
4608 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4610 match snd style with
4614 name2 (String.concat "> <" (List.map name_of_argt args)) in
4617 if List.mem ProtocolLimitWarning flags then
4618 ("\n\n" ^ protocol_limit_warning)
4621 (* For DangerWillRobinson commands, we should probably have
4622 * guestfish prompt before allowing you to use them (especially
4623 * in interactive mode). XXX
4627 if List.mem DangerWillRobinson flags then
4628 ("\n\n" ^ danger_will_robinson)
4631 let describe_alias =
4632 if name <> alias then
4633 sprintf "\n\nYou can use '%s' as an alias for this command." alias
4637 pr "strcasecmp (cmd, \"%s\") == 0" name;
4638 if name <> name2 then
4639 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4640 if name <> alias then
4641 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4643 pr " pod2text (\"%s - %s\", %S);\n"
4645 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4648 pr " display_builtin_command (cmd);\n";
4652 (* print_{pv,vg,lv}_list functions *)
4656 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4663 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4665 pr " printf (\"%s: \");\n" name;
4666 pr " for (i = 0; i < 32; ++i)\n";
4667 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
4668 pr " printf (\"\\n\");\n"
4670 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4672 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4673 | name, `OptPercent ->
4674 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4675 typ name name typ name;
4676 pr " else printf (\"%s: \\n\");\n" name
4680 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4685 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4686 pr " print_%s (&%ss->val[i]);\n" typ typ;
4689 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4691 (* print_{stat,statvfs} functions *)
4695 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4700 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4704 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4706 (* run_<action> actions *)
4708 fun (name, style, _, flags, _, _, _) ->
4709 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4711 (match fst style with
4714 | RBool _ -> pr " int r;\n"
4715 | RInt64 _ -> pr " int64_t r;\n"
4716 | RConstString _ -> pr " const char *r;\n"
4717 | RString _ -> pr " char *r;\n"
4718 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4719 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4720 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4721 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4722 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4723 | RStat _ -> pr " struct guestfs_stat *r;\n"
4724 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4731 | FileOut n -> pr " const char *%s;\n" n
4732 | StringList n -> pr " char **%s;\n" n
4733 | Bool n -> pr " int %s;\n" n
4734 | Int n -> pr " int %s;\n" n
4737 (* Check and convert parameters. *)
4738 let argc_expected = List.length (snd style) in
4739 pr " if (argc != %d) {\n" argc_expected;
4740 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4742 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4748 | String name -> pr " %s = argv[%d];\n" name i
4750 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4753 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4756 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4758 | StringList name ->
4759 pr " %s = parse_string_list (argv[%d]);\n" name i
4761 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4763 pr " %s = atoi (argv[%d]);\n" name i
4766 (* Call C API function. *)
4768 try find_map (function FishAction n -> Some n | _ -> None) flags
4769 with Not_found -> sprintf "guestfs_%s" name in
4771 generate_call_args ~handle:"g" (snd style);
4774 (* Check return value for errors and display command results. *)
4775 (match fst style with
4776 | RErr -> pr " return r;\n"
4778 pr " if (r == -1) return -1;\n";
4779 pr " printf (\"%%d\\n\", r);\n";
4782 pr " if (r == -1) return -1;\n";
4783 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4786 pr " if (r == -1) return -1;\n";
4787 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4790 pr " if (r == NULL) return -1;\n";
4791 pr " printf (\"%%s\\n\", r);\n";
4794 pr " if (r == NULL) return -1;\n";
4795 pr " printf (\"%%s\\n\", r);\n";
4799 pr " if (r == NULL) return -1;\n";
4800 pr " print_strings (r);\n";
4801 pr " free_strings (r);\n";
4804 pr " if (r == NULL) return -1;\n";
4805 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4806 pr " r->b ? \"true\" : \"false\");\n";
4807 pr " guestfs_free_int_bool (r);\n";
4810 pr " if (r == NULL) return -1;\n";
4811 pr " print_pv_list (r);\n";
4812 pr " guestfs_free_lvm_pv_list (r);\n";
4815 pr " if (r == NULL) return -1;\n";
4816 pr " print_vg_list (r);\n";
4817 pr " guestfs_free_lvm_vg_list (r);\n";
4820 pr " if (r == NULL) return -1;\n";
4821 pr " print_lv_list (r);\n";
4822 pr " guestfs_free_lvm_lv_list (r);\n";
4825 pr " if (r == NULL) return -1;\n";
4826 pr " print_stat (r);\n";
4830 pr " if (r == NULL) return -1;\n";
4831 pr " print_statvfs (r);\n";
4835 pr " if (r == NULL) return -1;\n";
4836 pr " print_table (r);\n";
4837 pr " free_strings (r);\n";
4844 (* run_action function *)
4845 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4848 fun (name, _, _, flags, _, _, _) ->
4849 let name2 = replace_char name '_' '-' in
4851 try find_map (function FishAlias n -> Some n | _ -> None) flags
4852 with Not_found -> name in
4854 pr "strcasecmp (cmd, \"%s\") == 0" name;
4855 if name <> name2 then
4856 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4857 if name <> alias then
4858 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4860 pr " return run_%s (cmd, argc, argv);\n" name;
4864 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4871 (* Readline completion for guestfish. *)
4872 and generate_fish_completion () =
4873 generate_header CStyle GPLv2;
4877 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4887 #ifdef HAVE_LIBREADLINE
4888 #include <readline/readline.h>
4893 #ifdef HAVE_LIBREADLINE
4895 static const char *const commands[] = {
4896 BUILTIN_COMMANDS_FOR_COMPLETION,
4899 (* Get the commands, including the aliases. They don't need to be
4900 * sorted - the generator() function just does a dumb linear search.
4904 fun (name, _, _, flags, _, _, _) ->
4905 let name2 = replace_char name '_' '-' in
4907 try find_map (function FishAlias n -> Some n | _ -> None) flags
4908 with Not_found -> name in
4910 if name <> alias then [name2; alias] else [name2]
4912 let commands = List.flatten commands in
4914 List.iter (pr " \"%s\",\n") commands;
4920 generator (const char *text, int state)
4922 static int index, len;
4927 len = strlen (text);
4930 rl_attempted_completion_over = 1;
4932 while ((name = commands[index]) != NULL) {
4934 if (strncasecmp (name, text, len) == 0)
4935 return strdup (name);
4941 #endif /* HAVE_LIBREADLINE */
4943 char **do_completion (const char *text, int start, int end)
4945 char **matches = NULL;
4947 #ifdef HAVE_LIBREADLINE
4948 rl_completion_append_character = ' ';
4951 matches = rl_completion_matches (text, generator);
4952 else if (complete_dest_paths)
4953 matches = rl_completion_matches (text, complete_dest_paths_generator);
4960 (* Generate the POD documentation for guestfish. *)
4961 and generate_fish_actions_pod () =
4962 let all_functions_sorted =
4964 fun (_, _, _, flags, _, _, _) ->
4965 not (List.mem NotInFish flags || List.mem NotInDocs flags)
4966 ) all_functions_sorted in
4968 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4971 fun (name, style, _, flags, _, _, longdesc) ->
4973 Str.global_substitute rex (
4976 try Str.matched_group 1 s
4978 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4979 "C<" ^ replace_char sub '_' '-' ^ ">"
4981 let name = replace_char name '_' '-' in
4983 try find_map (function FishAlias n -> Some n | _ -> None) flags
4984 with Not_found -> name in
4986 pr "=head2 %s" name;
4987 if name <> alias then
4994 | String n -> pr " %s" n
4995 | OptString n -> pr " %s" n
4996 | StringList n -> pr " '%s ...'" n
4997 | Bool _ -> pr " true|false"
4998 | Int n -> pr " %s" n
4999 | FileIn n | FileOut n -> pr " (%s|-)" n
5003 pr "%s\n\n" longdesc;
5005 if List.exists (function FileIn _ | FileOut _ -> true
5006 | _ -> false) (snd style) then
5007 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5009 if List.mem ProtocolLimitWarning flags then
5010 pr "%s\n\n" protocol_limit_warning;
5012 if List.mem DangerWillRobinson flags then
5013 pr "%s\n\n" danger_will_robinson
5014 ) all_functions_sorted
5016 (* Generate a C function prototype. *)
5017 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5018 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5020 ?handle name style =
5021 if extern then pr "extern ";
5022 if static then pr "static ";
5023 (match fst style with
5025 | RInt _ -> pr "int "
5026 | RInt64 _ -> pr "int64_t "
5027 | RBool _ -> pr "int "
5028 | RConstString _ -> pr "const char *"
5029 | RString _ -> pr "char *"
5030 | RStringList _ | RHashtable _ -> pr "char **"
5032 if not in_daemon then pr "struct guestfs_int_bool *"
5033 else pr "guestfs_%s_ret *" name
5035 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
5036 else pr "guestfs_lvm_int_pv_list *"
5038 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
5039 else pr "guestfs_lvm_int_vg_list *"
5041 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
5042 else pr "guestfs_lvm_int_lv_list *"
5044 if not in_daemon then pr "struct guestfs_stat *"
5045 else pr "guestfs_int_stat *"
5047 if not in_daemon then pr "struct guestfs_statvfs *"
5048 else pr "guestfs_int_statvfs *"
5050 pr "%s%s (" prefix name;
5051 if handle = None && List.length (snd style) = 0 then
5054 let comma = ref false in
5057 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5061 if single_line then pr ", " else pr ",\n\t\t"
5070 if not in_daemon then pr "const char *%s" n
5071 else pr "char *%s" n
5074 if not in_daemon then pr "char * const* const %s" n
5075 else pr "char **%s" n
5076 | Bool n -> next (); pr "int %s" n
5077 | Int n -> next (); pr "int %s" n
5080 if not in_daemon then (next (); pr "const char *%s" n)
5084 if semicolon then pr ";";
5085 if newline then pr "\n"
5087 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5088 and generate_call_args ?handle args =
5090 let comma = ref false in
5093 | Some handle -> pr "%s" handle; comma := true
5097 if !comma then pr ", ";
5099 pr "%s" (name_of_argt arg)
5103 (* Generate the OCaml bindings interface. *)
5104 and generate_ocaml_mli () =
5105 generate_header OCamlStyle LGPLv2;
5108 (** For API documentation you should refer to the C API
5109 in the guestfs(3) manual page. The OCaml API uses almost
5110 exactly the same calls. *)
5113 (** A [guestfs_h] handle. *)
5115 exception Error of string
5116 (** This exception is raised when there is an error. *)
5118 val create : unit -> t
5120 val close : t -> unit
5121 (** Handles are closed by the garbage collector when they become
5122 unreferenced, but callers can also call this in order to
5123 provide predictable cleanup. *)
5126 generate_ocaml_lvm_structure_decls ();
5128 generate_ocaml_stat_structure_decls ();
5132 fun (name, style, _, _, _, shortdesc, _) ->
5133 generate_ocaml_prototype name style;
5134 pr "(** %s *)\n" shortdesc;
5138 (* Generate the OCaml bindings implementation. *)
5139 and generate_ocaml_ml () =
5140 generate_header OCamlStyle LGPLv2;
5144 exception Error of string
5145 external create : unit -> t = \"ocaml_guestfs_create\"
5146 external close : t -> unit = \"ocaml_guestfs_close\"
5149 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5153 generate_ocaml_lvm_structure_decls ();
5155 generate_ocaml_stat_structure_decls ();
5159 fun (name, style, _, _, _, shortdesc, _) ->
5160 generate_ocaml_prototype ~is_external:true name style;
5163 (* Generate the OCaml bindings C implementation. *)
5164 and generate_ocaml_c () =
5165 generate_header CStyle LGPLv2;
5172 #include <caml/config.h>
5173 #include <caml/alloc.h>
5174 #include <caml/callback.h>
5175 #include <caml/fail.h>
5176 #include <caml/memory.h>
5177 #include <caml/mlvalues.h>
5178 #include <caml/signals.h>
5180 #include <guestfs.h>
5182 #include \"guestfs_c.h\"
5184 /* Copy a hashtable of string pairs into an assoc-list. We return
5185 * the list in reverse order, but hashtables aren't supposed to be
5188 static CAMLprim value
5189 copy_table (char * const * argv)
5192 CAMLlocal5 (rv, pairv, kv, vv, cons);
5196 for (i = 0; argv[i] != NULL; i += 2) {
5197 kv = caml_copy_string (argv[i]);
5198 vv = caml_copy_string (argv[i+1]);
5199 pairv = caml_alloc (2, 0);
5200 Store_field (pairv, 0, kv);
5201 Store_field (pairv, 1, vv);
5202 cons = caml_alloc (2, 0);
5203 Store_field (cons, 1, rv);
5205 Store_field (cons, 0, pairv);
5213 (* LVM struct copy functions. *)
5216 let has_optpercent_col =
5217 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
5219 pr "static CAMLprim value\n";
5220 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
5222 pr " CAMLparam0 ();\n";
5223 if has_optpercent_col then
5224 pr " CAMLlocal3 (rv, v, v2);\n"
5226 pr " CAMLlocal2 (rv, v);\n";
5228 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5233 pr " v = caml_copy_string (%s->%s);\n" typ name
5235 pr " v = caml_alloc_string (32);\n";
5236 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5239 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5240 | name, `OptPercent ->
5241 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5242 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5243 pr " v = caml_alloc (1, 0);\n";
5244 pr " Store_field (v, 0, v2);\n";
5245 pr " } else /* None */\n";
5246 pr " v = Val_int (0);\n";
5248 pr " Store_field (rv, %d, v);\n" i
5250 pr " CAMLreturn (rv);\n";
5254 pr "static CAMLprim value\n";
5255 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
5258 pr " CAMLparam0 ();\n";
5259 pr " CAMLlocal2 (rv, v);\n";
5262 pr " if (%ss->len == 0)\n" typ;
5263 pr " CAMLreturn (Atom (0));\n";
5265 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5266 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5267 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
5268 pr " caml_modify (&Field (rv, i), v);\n";
5270 pr " CAMLreturn (rv);\n";
5274 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5276 (* Stat copy functions. *)
5279 pr "static CAMLprim value\n";
5280 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5282 pr " CAMLparam0 ();\n";
5283 pr " CAMLlocal2 (rv, v);\n";
5285 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5290 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5292 pr " Store_field (rv, %d, v);\n" i
5294 pr " CAMLreturn (rv);\n";
5297 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5301 fun (name, style, _, _, _, _, _) ->
5303 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5305 pr "CAMLprim value\n";
5306 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5307 List.iter (pr ", value %s") (List.tl params);
5312 | [p1; p2; p3; p4; p5] ->
5313 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5314 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5315 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5316 pr " CAMLxparam%d (%s);\n"
5317 (List.length rest) (String.concat ", " rest)
5319 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5321 pr " CAMLlocal1 (rv);\n";
5324 pr " guestfs_h *g = Guestfs_val (gv);\n";
5325 pr " if (g == NULL)\n";
5326 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5334 pr " const char *%s = String_val (%sv);\n" n n
5336 pr " const char *%s =\n" n;
5337 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5340 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5342 pr " int %s = Bool_val (%sv);\n" n n
5344 pr " int %s = Int_val (%sv);\n" n n
5347 match fst style with
5348 | RErr -> pr " int r;\n"; "-1"
5349 | RInt _ -> pr " int r;\n"; "-1"
5350 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5351 | RBool _ -> pr " int r;\n"; "-1"
5352 | RConstString _ -> pr " const char *r;\n"; "NULL"
5353 | RString _ -> pr " char *r;\n"; "NULL"
5359 pr " struct guestfs_int_bool *r;\n"; "NULL"
5361 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5363 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5365 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5367 pr " struct guestfs_stat *r;\n"; "NULL"
5369 pr " struct guestfs_statvfs *r;\n"; "NULL"
5376 pr " caml_enter_blocking_section ();\n";
5377 pr " r = guestfs_%s " name;
5378 generate_call_args ~handle:"g" (snd style);
5380 pr " caml_leave_blocking_section ();\n";
5385 pr " ocaml_guestfs_free_strings (%s);\n" n;
5386 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5389 pr " if (r == %s)\n" error_code;
5390 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5393 (match fst style with
5394 | RErr -> pr " rv = Val_unit;\n"
5395 | RInt _ -> pr " rv = Val_int (r);\n"
5397 pr " rv = caml_copy_int64 (r);\n"
5398 | RBool _ -> pr " rv = Val_bool (r);\n"
5399 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5401 pr " rv = caml_copy_string (r);\n";
5404 pr " rv = caml_copy_string_array ((const char **) r);\n";
5405 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5408 pr " rv = caml_alloc (2, 0);\n";
5409 pr " Store_field (rv, 0, Val_int (r->i));\n";
5410 pr " Store_field (rv, 1, Val_bool (r->b));\n";
5411 pr " guestfs_free_int_bool (r);\n";
5413 pr " rv = copy_lvm_pv_list (r);\n";
5414 pr " guestfs_free_lvm_pv_list (r);\n";
5416 pr " rv = copy_lvm_vg_list (r);\n";
5417 pr " guestfs_free_lvm_vg_list (r);\n";
5419 pr " rv = copy_lvm_lv_list (r);\n";
5420 pr " guestfs_free_lvm_lv_list (r);\n";
5422 pr " rv = copy_stat (r);\n";
5425 pr " rv = copy_statvfs (r);\n";
5428 pr " rv = copy_table (r);\n";
5429 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5433 pr " CAMLreturn (rv);\n";
5437 if List.length params > 5 then (
5438 pr "CAMLprim value\n";
5439 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5441 pr " return ocaml_guestfs_%s (argv[0]" name;
5442 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5449 and generate_ocaml_lvm_structure_decls () =
5452 pr "type lvm_%s = {\n" typ;
5455 | name, `String -> pr " %s : string;\n" name
5456 | name, `UUID -> pr " %s : string;\n" name
5457 | name, `Bytes -> pr " %s : int64;\n" name
5458 | name, `Int -> pr " %s : int64;\n" name
5459 | name, `OptPercent -> pr " %s : float option;\n" name
5463 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
5465 and generate_ocaml_stat_structure_decls () =
5468 pr "type %s = {\n" typ;
5471 | name, `Int -> pr " %s : int64;\n" name
5475 ) ["stat", stat_cols; "statvfs", statvfs_cols]
5477 and generate_ocaml_prototype ?(is_external = false) name style =
5478 if is_external then pr "external " else pr "val ";
5479 pr "%s : t -> " name;
5482 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5483 | OptString _ -> pr "string option -> "
5484 | StringList _ -> pr "string array -> "
5485 | Bool _ -> pr "bool -> "
5486 | Int _ -> pr "int -> "
5488 (match fst style with
5489 | RErr -> pr "unit" (* all errors are turned into exceptions *)
5490 | RInt _ -> pr "int"
5491 | RInt64 _ -> pr "int64"
5492 | RBool _ -> pr "bool"
5493 | RConstString _ -> pr "string"
5494 | RString _ -> pr "string"
5495 | RStringList _ -> pr "string array"
5496 | RIntBool _ -> pr "int * bool"
5497 | RPVList _ -> pr "lvm_pv array"
5498 | RVGList _ -> pr "lvm_vg array"
5499 | RLVList _ -> pr "lvm_lv array"
5500 | RStat _ -> pr "stat"
5501 | RStatVFS _ -> pr "statvfs"
5502 | RHashtable _ -> pr "(string * string) list"
5504 if is_external then (
5506 if List.length (snd style) + 1 > 5 then
5507 pr "\"ocaml_guestfs_%s_byte\" " name;
5508 pr "\"ocaml_guestfs_%s\"" name
5512 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5513 and generate_perl_xs () =
5514 generate_header CStyle LGPLv2;
5517 #include \"EXTERN.h\"
5521 #include <guestfs.h>
5524 #define PRId64 \"lld\"
5528 my_newSVll(long long val) {
5529 #ifdef USE_64_BIT_ALL
5530 return newSViv(val);
5534 len = snprintf(buf, 100, \"%%\" PRId64, val);
5535 return newSVpv(buf, len);
5540 #define PRIu64 \"llu\"
5544 my_newSVull(unsigned long long val) {
5545 #ifdef USE_64_BIT_ALL
5546 return newSVuv(val);
5550 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5551 return newSVpv(buf, len);
5555 /* http://www.perlmonks.org/?node_id=680842 */
5557 XS_unpack_charPtrPtr (SV *arg) {
5562 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5563 croak (\"array reference expected\");
5565 av = (AV *)SvRV (arg);
5566 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5568 croak (\"malloc failed\");
5570 for (i = 0; i <= av_len (av); i++) {
5571 SV **elem = av_fetch (av, i, 0);
5573 if (!elem || !*elem)
5574 croak (\"missing element in list\");
5576 ret[i] = SvPV_nolen (*elem);
5584 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5591 RETVAL = guestfs_create ();
5593 croak (\"could not create guestfs handle\");
5594 guestfs_set_error_handler (RETVAL, NULL, NULL);
5607 fun (name, style, _, _, _, _, _) ->
5608 (match fst style with
5609 | RErr -> pr "void\n"
5610 | RInt _ -> pr "SV *\n"
5611 | RInt64 _ -> pr "SV *\n"
5612 | RBool _ -> pr "SV *\n"
5613 | RConstString _ -> pr "SV *\n"
5614 | RString _ -> pr "SV *\n"
5617 | RPVList _ | RVGList _ | RLVList _
5618 | RStat _ | RStatVFS _
5620 pr "void\n" (* all lists returned implictly on the stack *)
5622 (* Call and arguments. *)
5624 generate_call_args ~handle:"g" (snd style);
5626 pr " guestfs_h *g;\n";
5630 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5632 (* http://www.perlmonks.org/?node_id=554277
5633 * Note that the implicit handle argument means we have
5634 * to add 1 to the ST(x) operator.
5636 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5637 | StringList n -> pr " char **%s;\n" n
5638 | Bool n -> pr " int %s;\n" n
5639 | Int n -> pr " int %s;\n" n
5642 let do_cleanups () =
5645 | String _ | OptString _ | Bool _ | Int _
5646 | FileIn _ | FileOut _ -> ()
5647 | StringList n -> pr " free (%s);\n" n
5652 (match fst style with
5657 pr " r = guestfs_%s " name;
5658 generate_call_args ~handle:"g" (snd style);
5661 pr " if (r == -1)\n";
5662 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5668 pr " %s = guestfs_%s " n name;
5669 generate_call_args ~handle:"g" (snd style);
5672 pr " if (%s == -1)\n" n;
5673 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5674 pr " RETVAL = newSViv (%s);\n" n;
5679 pr " int64_t %s;\n" n;
5681 pr " %s = guestfs_%s " n name;
5682 generate_call_args ~handle:"g" (snd style);
5685 pr " if (%s == -1)\n" n;
5686 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5687 pr " RETVAL = my_newSVll (%s);\n" n;
5692 pr " const char *%s;\n" n;
5694 pr " %s = guestfs_%s " n name;
5695 generate_call_args ~handle:"g" (snd style);
5698 pr " if (%s == NULL)\n" n;
5699 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5700 pr " RETVAL = newSVpv (%s, 0);\n" n;
5705 pr " char *%s;\n" n;
5707 pr " %s = guestfs_%s " n name;
5708 generate_call_args ~handle:"g" (snd style);
5711 pr " if (%s == NULL)\n" n;
5712 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5713 pr " RETVAL = newSVpv (%s, 0);\n" n;
5714 pr " free (%s);\n" n;
5717 | RStringList n | RHashtable n ->
5719 pr " char **%s;\n" n;
5722 pr " %s = guestfs_%s " n name;
5723 generate_call_args ~handle:"g" (snd style);
5726 pr " if (%s == NULL)\n" n;
5727 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5728 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5729 pr " EXTEND (SP, n);\n";
5730 pr " for (i = 0; i < n; ++i) {\n";
5731 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5732 pr " free (%s[i]);\n" n;
5734 pr " free (%s);\n" n;
5737 pr " struct guestfs_int_bool *r;\n";
5739 pr " r = guestfs_%s " name;
5740 generate_call_args ~handle:"g" (snd style);
5743 pr " if (r == NULL)\n";
5744 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5745 pr " EXTEND (SP, 2);\n";
5746 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5747 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5748 pr " guestfs_free_int_bool (r);\n";
5750 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5752 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5754 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5756 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5758 generate_perl_stat_code
5759 "statvfs" statvfs_cols name style n do_cleanups
5765 and generate_perl_lvm_code typ cols name style n do_cleanups =
5767 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5771 pr " %s = guestfs_%s " n name;
5772 generate_call_args ~handle:"g" (snd style);
5775 pr " if (%s == NULL)\n" n;
5776 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5777 pr " EXTEND (SP, %s->len);\n" n;
5778 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5779 pr " hv = newHV ();\n";
5783 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5784 name (String.length name) n name
5786 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5787 name (String.length name) n name
5789 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5790 name (String.length name) n name
5792 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5793 name (String.length name) n name
5794 | name, `OptPercent ->
5795 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5796 name (String.length name) n name
5798 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5800 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5802 and generate_perl_stat_code typ cols name style n do_cleanups =
5804 pr " struct guestfs_%s *%s;\n" typ n;
5806 pr " %s = guestfs_%s " n name;
5807 generate_call_args ~handle:"g" (snd style);
5810 pr " if (%s == NULL)\n" n;
5811 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5812 pr " EXTEND (SP, %d);\n" (List.length cols);
5816 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5818 pr " free (%s);\n" n
5820 (* Generate Sys/Guestfs.pm. *)
5821 and generate_perl_pm () =
5822 generate_header HashStyle LGPLv2;
5829 Sys::Guestfs - Perl bindings for libguestfs
5835 my $h = Sys::Guestfs->new ();
5836 $h->add_drive ('guest.img');
5839 $h->mount ('/dev/sda1', '/');
5840 $h->touch ('/hello');
5845 The C<Sys::Guestfs> module provides a Perl XS binding to the
5846 libguestfs API for examining and modifying virtual machine
5849 Amongst the things this is good for: making batch configuration
5850 changes to guests, getting disk used/free statistics (see also:
5851 virt-df), migrating between virtualization systems (see also:
5852 virt-p2v), performing partial backups, performing partial guest
5853 clones, cloning guests and changing registry/UUID/hostname info, and
5856 Libguestfs uses Linux kernel and qemu code, and can access any type of
5857 guest filesystem that Linux and qemu can, including but not limited
5858 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5859 schemes, qcow, qcow2, vmdk.
5861 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5862 LVs, what filesystem is in each LV, etc.). It can also run commands
5863 in the context of the guest. Also you can access filesystems over FTP.
5867 All errors turn into calls to C<croak> (see L<Carp(3)>).
5875 package Sys::Guestfs;
5881 XSLoader::load ('Sys::Guestfs');
5883 =item $h = Sys::Guestfs->new ();
5885 Create a new guestfs handle.
5891 my $class = ref ($proto) || $proto;
5893 my $self = Sys::Guestfs::_create ();
5894 bless $self, $class;
5900 (* Actions. We only need to print documentation for these as
5901 * they are pulled in from the XS code automatically.
5904 fun (name, style, _, flags, _, _, longdesc) ->
5905 if not (List.mem NotInDocs flags) then (
5906 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5908 generate_perl_prototype name style;
5910 pr "%s\n\n" longdesc;
5911 if List.mem ProtocolLimitWarning flags then
5912 pr "%s\n\n" protocol_limit_warning;
5913 if List.mem DangerWillRobinson flags then
5914 pr "%s\n\n" danger_will_robinson
5916 ) all_functions_sorted;
5928 Copyright (C) 2009 Red Hat Inc.
5932 Please see the file COPYING.LIB for the full license.
5936 L<guestfs(3)>, L<guestfish(1)>.
5941 and generate_perl_prototype name style =
5942 (match fst style with
5948 | RString n -> pr "$%s = " n
5949 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5953 | RLVList n -> pr "@%s = " n
5956 | RHashtable n -> pr "%%%s = " n
5959 let comma = ref false in
5962 if !comma then pr ", ";
5965 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5972 (* Generate Python C module. *)
5973 and generate_python_c () =
5974 generate_header CStyle LGPLv2;
5983 #include \"guestfs.h\"
5991 get_handle (PyObject *obj)
5994 assert (obj != Py_None);
5995 return ((Pyguestfs_Object *) obj)->g;
5999 put_handle (guestfs_h *g)
6003 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6006 /* This list should be freed (but not the strings) after use. */
6007 static const char **
6008 get_string_list (PyObject *obj)
6015 if (!PyList_Check (obj)) {
6016 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6020 len = PyList_Size (obj);
6021 r = malloc (sizeof (char *) * (len+1));
6023 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6027 for (i = 0; i < len; ++i)
6028 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6035 put_string_list (char * const * const argv)
6040 for (argc = 0; argv[argc] != NULL; ++argc)
6043 list = PyList_New (argc);
6044 for (i = 0; i < argc; ++i)
6045 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6051 put_table (char * const * const argv)
6053 PyObject *list, *item;
6056 for (argc = 0; argv[argc] != NULL; ++argc)
6059 list = PyList_New (argc >> 1);
6060 for (i = 0; i < argc; i += 2) {
6061 item = PyTuple_New (2);
6062 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6063 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6064 PyList_SetItem (list, i >> 1, item);
6071 free_strings (char **argv)
6075 for (argc = 0; argv[argc] != NULL; ++argc)
6081 py_guestfs_create (PyObject *self, PyObject *args)
6085 g = guestfs_create ();
6087 PyErr_SetString (PyExc_RuntimeError,
6088 \"guestfs.create: failed to allocate handle\");
6091 guestfs_set_error_handler (g, NULL, NULL);
6092 return put_handle (g);
6096 py_guestfs_close (PyObject *self, PyObject *args)
6101 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6103 g = get_handle (py_g);
6107 Py_INCREF (Py_None);
6113 (* LVM structures, turned into Python dictionaries. *)
6116 pr "static PyObject *\n";
6117 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
6119 pr " PyObject *dict;\n";
6121 pr " dict = PyDict_New ();\n";
6125 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6126 pr " PyString_FromString (%s->%s));\n"
6129 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6130 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6133 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6134 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6137 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6138 pr " PyLong_FromLongLong (%s->%s));\n"
6140 | name, `OptPercent ->
6141 pr " if (%s->%s >= 0)\n" typ name;
6142 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6143 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6146 pr " Py_INCREF (Py_None);\n";
6147 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6150 pr " return dict;\n";
6154 pr "static PyObject *\n";
6155 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
6157 pr " PyObject *list;\n";
6160 pr " list = PyList_New (%ss->len);\n" typ;
6161 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6162 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
6163 pr " return list;\n";
6166 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
6168 (* Stat structures, turned into Python dictionaries. *)
6171 pr "static PyObject *\n";
6172 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6174 pr " PyObject *dict;\n";
6176 pr " dict = PyDict_New ();\n";
6180 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6181 pr " PyLong_FromLongLong (%s->%s));\n"
6184 pr " return dict;\n";
6187 ) ["stat", stat_cols; "statvfs", statvfs_cols];
6189 (* Python wrapper functions. *)
6191 fun (name, style, _, _, _, _, _) ->
6192 pr "static PyObject *\n";
6193 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6196 pr " PyObject *py_g;\n";
6197 pr " guestfs_h *g;\n";
6198 pr " PyObject *py_r;\n";
6201 match fst style with
6202 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6203 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6204 | RConstString _ -> pr " const char *r;\n"; "NULL"
6205 | RString _ -> pr " char *r;\n"; "NULL"
6206 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6207 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6208 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6209 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6210 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6211 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6212 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6216 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6217 | OptString n -> pr " const char *%s;\n" n
6219 pr " PyObject *py_%s;\n" n;
6220 pr " const char **%s;\n" n
6221 | Bool n -> pr " int %s;\n" n
6222 | Int n -> pr " int %s;\n" n
6227 (* Convert the parameters. *)
6228 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6231 | String _ | FileIn _ | FileOut _ -> pr "s"
6232 | OptString _ -> pr "z"
6233 | StringList _ -> pr "O"
6234 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6237 pr ":guestfs_%s\",\n" name;
6241 | String n | FileIn n | FileOut n -> pr ", &%s" n
6242 | OptString n -> pr ", &%s" n
6243 | StringList n -> pr ", &py_%s" n
6244 | Bool n -> pr ", &%s" n
6245 | Int n -> pr ", &%s" n
6249 pr " return NULL;\n";
6251 pr " g = get_handle (py_g);\n";
6254 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6256 pr " %s = get_string_list (py_%s);\n" n n;
6257 pr " if (!%s) return NULL;\n" n
6262 pr " r = guestfs_%s " name;
6263 generate_call_args ~handle:"g" (snd style);
6268 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6270 pr " free (%s);\n" n
6273 pr " if (r == %s) {\n" error_code;
6274 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6275 pr " return NULL;\n";
6279 (match fst style with
6281 pr " Py_INCREF (Py_None);\n";
6282 pr " py_r = Py_None;\n"
6284 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6285 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6286 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6288 pr " py_r = PyString_FromString (r);\n";
6291 pr " py_r = put_string_list (r);\n";
6292 pr " free_strings (r);\n"
6294 pr " py_r = PyTuple_New (2);\n";
6295 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
6296 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
6297 pr " guestfs_free_int_bool (r);\n"
6299 pr " py_r = put_lvm_pv_list (r);\n";
6300 pr " guestfs_free_lvm_pv_list (r);\n"
6302 pr " py_r = put_lvm_vg_list (r);\n";
6303 pr " guestfs_free_lvm_vg_list (r);\n"
6305 pr " py_r = put_lvm_lv_list (r);\n";
6306 pr " guestfs_free_lvm_lv_list (r);\n"
6308 pr " py_r = put_stat (r);\n";
6311 pr " py_r = put_statvfs (r);\n";
6314 pr " py_r = put_table (r);\n";
6315 pr " free_strings (r);\n"
6318 pr " return py_r;\n";
6323 (* Table of functions. *)
6324 pr "static PyMethodDef methods[] = {\n";
6325 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6326 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6328 fun (name, _, _, _, _, _, _) ->
6329 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6332 pr " { NULL, NULL, 0, NULL }\n";
6336 (* Init function. *)
6339 initlibguestfsmod (void)
6341 static int initialized = 0;
6343 if (initialized) return;
6344 Py_InitModule ((char *) \"libguestfsmod\", methods);
6349 (* Generate Python module. *)
6350 and generate_python_py () =
6351 generate_header HashStyle LGPLv2;
6354 u\"\"\"Python bindings for libguestfs
6357 g = guestfs.GuestFS ()
6358 g.add_drive (\"guest.img\")
6361 parts = g.list_partitions ()
6363 The guestfs module provides a Python binding to the libguestfs API
6364 for examining and modifying virtual machine disk images.
6366 Amongst the things this is good for: making batch configuration
6367 changes to guests, getting disk used/free statistics (see also:
6368 virt-df), migrating between virtualization systems (see also:
6369 virt-p2v), performing partial backups, performing partial guest
6370 clones, cloning guests and changing registry/UUID/hostname info, and
6373 Libguestfs uses Linux kernel and qemu code, and can access any type of
6374 guest filesystem that Linux and qemu can, including but not limited
6375 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6376 schemes, qcow, qcow2, vmdk.
6378 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6379 LVs, what filesystem is in each LV, etc.). It can also run commands
6380 in the context of the guest. Also you can access filesystems over FTP.
6382 Errors which happen while using the API are turned into Python
6383 RuntimeError exceptions.
6385 To create a guestfs handle you usually have to perform the following
6388 # Create the handle, call add_drive at least once, and possibly
6389 # several times if the guest has multiple block devices:
6390 g = guestfs.GuestFS ()
6391 g.add_drive (\"guest.img\")
6393 # Launch the qemu subprocess and wait for it to become ready:
6397 # Now you can issue commands, for example:
6402 import libguestfsmod
6405 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6407 def __init__ (self):
6408 \"\"\"Create a new libguestfs handle.\"\"\"
6409 self._o = libguestfsmod.create ()
6412 libguestfsmod.close (self._o)
6417 fun (name, style, _, flags, _, _, longdesc) ->
6419 generate_call_args ~handle:"self" (snd style);
6422 if not (List.mem NotInDocs flags) then (
6423 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6425 match fst style with
6426 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6429 doc ^ "\n\nThis function returns a list of strings."
6431 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
6433 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
6435 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
6437 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
6439 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
6441 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
6443 doc ^ "\n\nThis function returns a dictionary." in
6445 if List.mem ProtocolLimitWarning flags then
6446 doc ^ "\n\n" ^ protocol_limit_warning
6449 if List.mem DangerWillRobinson flags then
6450 doc ^ "\n\n" ^ danger_will_robinson
6452 let doc = pod2text ~width:60 name doc in
6453 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6454 let doc = String.concat "\n " doc in
6455 pr " u\"\"\"%s\"\"\"\n" doc;
6457 pr " return libguestfsmod.%s " name;
6458 generate_call_args ~handle:"self._o" (snd style);
6463 (* Useful if you need the longdesc POD text as plain text. Returns a
6466 * This is the slowest thing about autogeneration.
6468 and pod2text ~width name longdesc =
6469 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6470 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6472 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6473 let chan = Unix.open_process_in cmd in
6474 let lines = ref [] in
6476 let line = input_line chan in
6477 if i = 1 then (* discard the first line of output *)
6480 let line = triml line in
6481 lines := line :: !lines;
6484 let lines = try loop 1 with End_of_file -> List.rev !lines in
6485 Unix.unlink filename;
6486 match Unix.close_process_in chan with
6487 | Unix.WEXITED 0 -> lines
6489 failwithf "pod2text: process exited with non-zero status (%d)" i
6490 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6491 failwithf "pod2text: process signalled or stopped by signal %d" i
6493 (* Generate ruby bindings. *)
6494 and generate_ruby_c () =
6495 generate_header CStyle LGPLv2;
6503 #include \"guestfs.h\"
6505 #include \"extconf.h\"
6507 /* For Ruby < 1.9 */
6509 #define RARRAY_LEN(r) (RARRAY((r))->len)
6512 static VALUE m_guestfs; /* guestfs module */
6513 static VALUE c_guestfs; /* guestfs_h handle */
6514 static VALUE e_Error; /* used for all errors */
6516 static void ruby_guestfs_free (void *p)
6519 guestfs_close ((guestfs_h *) p);
6522 static VALUE ruby_guestfs_create (VALUE m)
6526 g = guestfs_create ();
6528 rb_raise (e_Error, \"failed to create guestfs handle\");
6530 /* Don't print error messages to stderr by default. */
6531 guestfs_set_error_handler (g, NULL, NULL);
6533 /* Wrap it, and make sure the close function is called when the
6536 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6539 static VALUE ruby_guestfs_close (VALUE gv)
6542 Data_Get_Struct (gv, guestfs_h, g);
6544 ruby_guestfs_free (g);
6545 DATA_PTR (gv) = NULL;
6553 fun (name, style, _, _, _, _, _) ->
6554 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6555 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6558 pr " guestfs_h *g;\n";
6559 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6561 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6567 | String n | FileIn n | FileOut n ->
6568 pr " Check_Type (%sv, T_STRING);\n" n;
6569 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6571 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6572 pr " \"%s\", \"%s\");\n" n name
6574 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6576 pr " char **%s;\n" n;
6577 pr " Check_Type (%sv, T_ARRAY);\n" n;
6579 pr " int i, len;\n";
6580 pr " len = RARRAY_LEN (%sv);\n" n;
6581 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6583 pr " for (i = 0; i < len; ++i) {\n";
6584 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6585 pr " %s[i] = StringValueCStr (v);\n" n;
6587 pr " %s[len] = NULL;\n" n;
6590 pr " int %s = RTEST (%sv);\n" n n
6592 pr " int %s = NUM2INT (%sv);\n" n n
6597 match fst style with
6598 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6599 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6600 | RConstString _ -> pr " const char *r;\n"; "NULL"
6601 | RString _ -> pr " char *r;\n"; "NULL"
6602 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6603 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6604 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6605 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6606 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6607 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6608 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6611 pr " r = guestfs_%s " name;
6612 generate_call_args ~handle:"g" (snd style);
6617 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6619 pr " free (%s);\n" n
6622 pr " if (r == %s)\n" error_code;
6623 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6626 (match fst style with
6628 pr " return Qnil;\n"
6629 | RInt _ | RBool _ ->
6630 pr " return INT2NUM (r);\n"
6632 pr " return ULL2NUM (r);\n"
6634 pr " return rb_str_new2 (r);\n";
6636 pr " VALUE rv = rb_str_new2 (r);\n";
6640 pr " int i, len = 0;\n";
6641 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6642 pr " VALUE rv = rb_ary_new2 (len);\n";
6643 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6644 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6645 pr " free (r[i]);\n";
6650 pr " VALUE rv = rb_ary_new2 (2);\n";
6651 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
6652 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
6653 pr " guestfs_free_int_bool (r);\n";
6656 generate_ruby_lvm_code "pv" pv_cols
6658 generate_ruby_lvm_code "vg" vg_cols
6660 generate_ruby_lvm_code "lv" lv_cols
6662 pr " VALUE rv = rb_hash_new ();\n";
6666 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6671 pr " VALUE rv = rb_hash_new ();\n";
6675 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6680 pr " VALUE rv = rb_hash_new ();\n";
6682 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
6683 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6684 pr " free (r[i]);\n";
6685 pr " free (r[i+1]);\n";
6696 /* Initialize the module. */
6697 void Init__guestfs ()
6699 m_guestfs = rb_define_module (\"Guestfs\");
6700 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6701 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6703 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6704 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6707 (* Define the rest of the methods. *)
6709 fun (name, style, _, _, _, _, _) ->
6710 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
6711 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6716 (* Ruby code to return an LVM struct list. *)
6717 and generate_ruby_lvm_code typ cols =
6718 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6720 pr " for (i = 0; i < r->len; ++i) {\n";
6721 pr " VALUE hv = rb_hash_new ();\n";
6725 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6727 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6730 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6731 | name, `OptPercent ->
6732 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6734 pr " rb_ary_push (rv, hv);\n";
6736 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6739 (* Generate Java bindings GuestFS.java file. *)
6740 and generate_java_java () =
6741 generate_header CStyle LGPLv2;
6744 package com.redhat.et.libguestfs;
6746 import java.util.HashMap;
6747 import com.redhat.et.libguestfs.LibGuestFSException;
6748 import com.redhat.et.libguestfs.PV;
6749 import com.redhat.et.libguestfs.VG;
6750 import com.redhat.et.libguestfs.LV;
6751 import com.redhat.et.libguestfs.Stat;
6752 import com.redhat.et.libguestfs.StatVFS;
6753 import com.redhat.et.libguestfs.IntBool;
6756 * The GuestFS object is a libguestfs handle.
6760 public class GuestFS {
6761 // Load the native code.
6763 System.loadLibrary (\"guestfs_jni\");
6767 * The native guestfs_h pointer.
6772 * Create a libguestfs handle.
6774 * @throws LibGuestFSException
6776 public GuestFS () throws LibGuestFSException
6780 private native long _create () throws LibGuestFSException;
6783 * Close a libguestfs handle.
6785 * You can also leave handles to be collected by the garbage
6786 * collector, but this method ensures that the resources used
6787 * by the handle are freed up immediately. If you call any
6788 * other methods after closing the handle, you will get an
6791 * @throws LibGuestFSException
6793 public void close () throws LibGuestFSException
6799 private native void _close (long g) throws LibGuestFSException;
6801 public void finalize () throws LibGuestFSException
6809 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6810 if not (List.mem NotInDocs flags); then (
6811 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6813 if List.mem ProtocolLimitWarning flags then
6814 doc ^ "\n\n" ^ protocol_limit_warning
6817 if List.mem DangerWillRobinson flags then
6818 doc ^ "\n\n" ^ danger_will_robinson
6820 let doc = pod2text ~width:60 name doc in
6821 let doc = List.map ( (* RHBZ#501883 *)
6824 | nonempty -> nonempty
6826 let doc = String.concat "\n * " doc in
6829 pr " * %s\n" shortdesc;
6832 pr " * @throws LibGuestFSException\n";
6836 generate_java_prototype ~public:true ~semicolon:false name style;
6839 pr " if (g == 0)\n";
6840 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6843 if fst style <> RErr then pr "return ";
6845 generate_call_args ~handle:"g" (snd style);
6849 generate_java_prototype ~privat:true ~native:true name style;
6856 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6857 ?(semicolon=true) name style =
6858 if privat then pr "private ";
6859 if public then pr "public ";
6860 if native then pr "native ";
6863 (match fst style with
6864 | RErr -> pr "void ";
6865 | RInt _ -> pr "int ";
6866 | RInt64 _ -> pr "long ";
6867 | RBool _ -> pr "boolean ";
6868 | RConstString _ | RString _ -> pr "String ";
6869 | RStringList _ -> pr "String[] ";
6870 | RIntBool _ -> pr "IntBool ";
6871 | RPVList _ -> pr "PV[] ";
6872 | RVGList _ -> pr "VG[] ";
6873 | RLVList _ -> pr "LV[] ";
6874 | RStat _ -> pr "Stat ";
6875 | RStatVFS _ -> pr "StatVFS ";
6876 | RHashtable _ -> pr "HashMap<String,String> ";
6879 if native then pr "_%s " name else pr "%s " name;
6881 let needs_comma = ref false in
6890 if !needs_comma then pr ", ";
6891 needs_comma := true;
6908 pr " throws LibGuestFSException";
6909 if semicolon then pr ";"
6911 and generate_java_struct typ cols =
6912 generate_header CStyle LGPLv2;
6915 package com.redhat.et.libguestfs;
6918 * Libguestfs %s structure.
6929 | name, `UUID -> pr " public String %s;\n" name
6931 | name, `Int -> pr " public long %s;\n" name
6932 | name, `OptPercent ->
6933 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6934 pr " public float %s;\n" name
6939 and generate_java_c () =
6940 generate_header CStyle LGPLv2;
6947 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6948 #include \"guestfs.h\"
6950 /* Note that this function returns. The exception is not thrown
6951 * until after the wrapper function returns.
6954 throw_exception (JNIEnv *env, const char *msg)
6957 cl = (*env)->FindClass (env,
6958 \"com/redhat/et/libguestfs/LibGuestFSException\");
6959 (*env)->ThrowNew (env, cl, msg);
6962 JNIEXPORT jlong JNICALL
6963 Java_com_redhat_et_libguestfs_GuestFS__1create
6964 (JNIEnv *env, jobject obj)
6968 g = guestfs_create ();
6970 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6973 guestfs_set_error_handler (g, NULL, NULL);
6974 return (jlong) (long) g;
6977 JNIEXPORT void JNICALL
6978 Java_com_redhat_et_libguestfs_GuestFS__1close
6979 (JNIEnv *env, jobject obj, jlong jg)
6981 guestfs_h *g = (guestfs_h *) (long) jg;
6988 fun (name, style, _, _, _, _, _) ->
6990 (match fst style with
6991 | RErr -> pr "void ";
6992 | RInt _ -> pr "jint ";
6993 | RInt64 _ -> pr "jlong ";
6994 | RBool _ -> pr "jboolean ";
6995 | RConstString _ | RString _ -> pr "jstring ";
6996 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6998 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
7002 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7003 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7005 pr " (JNIEnv *env, jobject obj, jlong jg";
7012 pr ", jstring j%s" n
7014 pr ", jobjectArray j%s" n
7016 pr ", jboolean j%s" n
7022 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7023 let error_code, no_ret =
7024 match fst style with
7025 | RErr -> pr " int r;\n"; "-1", ""
7027 | RInt _ -> pr " int r;\n"; "-1", "0"
7028 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7029 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7031 pr " jstring jr;\n";
7032 pr " char *r;\n"; "NULL", "NULL"
7034 pr " jobjectArray jr;\n";
7037 pr " jstring jstr;\n";
7038 pr " char **r;\n"; "NULL", "NULL"
7040 pr " jobject jr;\n";
7042 pr " jfieldID fl;\n";
7043 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
7045 pr " jobject jr;\n";
7047 pr " jfieldID fl;\n";
7048 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
7050 pr " jobject jr;\n";
7052 pr " jfieldID fl;\n";
7053 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
7055 pr " jobjectArray jr;\n";
7057 pr " jfieldID fl;\n";
7058 pr " jobject jfl;\n";
7059 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
7061 pr " jobjectArray jr;\n";
7063 pr " jfieldID fl;\n";
7064 pr " jobject jfl;\n";
7065 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
7067 pr " jobjectArray jr;\n";
7069 pr " jfieldID fl;\n";
7070 pr " jobject jfl;\n";
7071 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
7072 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
7079 pr " const char *%s;\n" n
7081 pr " int %s_len;\n" n;
7082 pr " const char **%s;\n" n
7089 (match fst style with
7090 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
7091 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7092 | RString _ | RIntBool _ | RStat _ | RStatVFS _
7093 | RHashtable _ -> false) ||
7094 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7100 (* Get the parameters. *)
7106 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7108 (* This is completely undocumented, but Java null becomes
7111 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
7113 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
7114 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
7115 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7116 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7118 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
7120 pr " %s[%s_len] = NULL;\n" n n;
7123 pr " %s = j%s;\n" n n
7126 (* Make the call. *)
7127 pr " r = guestfs_%s " name;
7128 generate_call_args ~handle:"g" (snd style);
7131 (* Release the parameters. *)
7137 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7140 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7142 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7143 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7145 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7147 pr " free (%s);\n" n
7152 (* Check for errors. *)
7153 pr " if (r == %s) {\n" error_code;
7154 pr " throw_exception (env, guestfs_last_error (g));\n";
7155 pr " return %s;\n" no_ret;
7159 (match fst style with
7161 | RInt _ -> pr " return (jint) r;\n"
7162 | RBool _ -> pr " return (jboolean) r;\n"
7163 | RInt64 _ -> pr " return (jlong) r;\n"
7164 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7166 pr " jr = (*env)->NewStringUTF (env, r);\n";
7170 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7171 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7172 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7173 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7174 pr " for (i = 0; i < r_len; ++i) {\n";
7175 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7176 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7177 pr " free (r[i]);\n";
7182 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
7183 pr " jr = (*env)->AllocObject (env, cl);\n";
7184 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
7185 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
7186 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
7187 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
7188 pr " guestfs_free_int_bool (r);\n";
7191 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
7192 pr " jr = (*env)->AllocObject (env, cl);\n";
7196 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7198 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7203 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
7204 pr " jr = (*env)->AllocObject (env, cl);\n";
7208 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7210 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7215 generate_java_lvm_return "pv" "PV" pv_cols
7217 generate_java_lvm_return "vg" "VG" vg_cols
7219 generate_java_lvm_return "lv" "LV" lv_cols
7222 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7223 pr " return NULL;\n"
7230 and generate_java_lvm_return typ jtyp cols =
7231 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7232 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7233 pr " for (i = 0; i < r->len; ++i) {\n";
7234 pr " jfl = (*env)->AllocObject (env, cl);\n";
7238 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7239 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7242 pr " char s[33];\n";
7243 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7245 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7246 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7248 | name, (`Bytes|`Int) ->
7249 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7250 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7251 | name, `OptPercent ->
7252 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7253 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7255 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7257 pr " guestfs_free_lvm_%s_list (r);\n" typ;
7260 and generate_haskell_hs () =
7261 generate_header HaskellStyle LGPLv2;
7263 (* XXX We only know how to generate partial FFI for Haskell
7264 * at the moment. Please help out!
7266 let can_generate style =
7270 | RInt64 _, _ -> true
7281 | RHashtable _, _ -> false in
7284 {-# INCLUDE <guestfs.h> #-}
7285 {-# LANGUAGE ForeignFunctionInterface #-}
7290 (* List out the names of the actions we want to export. *)
7292 fun (name, style, _, _, _, _, _) ->
7293 if can_generate style then pr ",\n %s" name
7300 import Foreign.C.Types
7302 import Control.Exception
7303 import Data.Typeable
7305 data GuestfsS = GuestfsS -- represents the opaque C struct
7306 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7307 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7309 -- XXX define properly later XXX
7313 data IntBool = IntBool
7315 data StatVFS = StatVFS
7316 data Hashtable = Hashtable
7318 foreign import ccall unsafe \"guestfs_create\" c_create
7320 foreign import ccall unsafe \"&guestfs_close\" c_close
7321 :: FunPtr (GuestfsP -> IO ())
7322 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7323 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7325 create :: IO GuestfsH
7328 c_set_error_handler p nullPtr nullPtr
7329 h <- newForeignPtr c_close p
7332 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7333 :: GuestfsP -> IO CString
7335 -- last_error :: GuestfsH -> IO (Maybe String)
7336 -- last_error h = do
7337 -- str <- withForeignPtr h (\\p -> c_last_error p)
7338 -- maybePeek peekCString str
7340 last_error :: GuestfsH -> IO (String)
7342 str <- withForeignPtr h (\\p -> c_last_error p)
7344 then return \"no error\"
7345 else peekCString str
7349 (* Generate wrappers for each foreign function. *)
7351 fun (name, style, _, _, _, _, _) ->
7352 if can_generate style then (
7353 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7355 generate_haskell_prototype ~handle:"GuestfsP" style;
7359 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7361 pr "%s %s = do\n" name
7362 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7364 (* Convert pointer arguments using with* functions. *)
7369 | String n -> pr "withCString %s $ \\%s -> " n n
7370 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7371 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7372 | Bool _ | Int _ -> ()
7374 (* Convert integer arguments. *)
7378 | Bool n -> sprintf "(fromBool %s)" n
7379 | Int n -> sprintf "(fromIntegral %s)" n
7380 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
7382 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7383 (String.concat " " ("p" :: args));
7384 (match fst style with
7385 | RErr | RInt _ | RInt64 _ | RBool _ ->
7386 pr " if (r == -1)\n";
7388 pr " err <- last_error h\n";
7390 | RConstString _ | RString _ | RStringList _ | RIntBool _
7391 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7393 pr " if (r == nullPtr)\n";
7395 pr " err <- last_error h\n";
7398 (match fst style with
7400 pr " else return ()\n"
7402 pr " else return (fromIntegral r)\n"
7404 pr " else return (fromIntegral r)\n"
7406 pr " else return (toBool r)\n"
7417 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7423 and generate_haskell_prototype ~handle ?(hs = false) style =
7425 let string = if hs then "String" else "CString" in
7426 let int = if hs then "Int" else "CInt" in
7427 let bool = if hs then "Bool" else "CInt" in
7428 let int64 = if hs then "Integer" else "Int64" in
7432 | String _ -> pr "%s" string
7433 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7434 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7435 | Bool _ -> pr "%s" bool
7436 | Int _ -> pr "%s" int
7437 | FileIn _ -> pr "%s" string
7438 | FileOut _ -> pr "%s" string
7443 (match fst style with
7444 | RErr -> if not hs then pr "CInt"
7445 | RInt _ -> pr "%s" int
7446 | RInt64 _ -> pr "%s" int64
7447 | RBool _ -> pr "%s" bool
7448 | RConstString _ -> pr "%s" string
7449 | RString _ -> pr "%s" string
7450 | RStringList _ -> pr "[%s]" string
7451 | RIntBool _ -> pr "IntBool"
7452 | RPVList _ -> pr "[PV]"
7453 | RVGList _ -> pr "[VG]"
7454 | RLVList _ -> pr "[LV]"
7455 | RStat _ -> pr "Stat"
7456 | RStatVFS _ -> pr "StatVFS"
7457 | RHashtable _ -> pr "Hashtable"
7461 and generate_bindtests () =
7462 generate_header CStyle LGPLv2;
7467 #include <inttypes.h>
7470 #include \"guestfs.h\"
7471 #include \"guestfs_protocol.h\"
7473 #define error guestfs_error
7476 print_strings (char * const* const argv)
7481 for (argc = 0; argv[argc] != NULL; ++argc) {
7482 if (argc > 0) printf (\", \");
7483 printf (\"\\\"%%s\\\"\", argv[argc]);
7488 /* The test0 function prints its parameters to stdout. */
7492 match test_functions with
7493 | [] -> assert false
7494 | test0 :: tests -> test0, tests in
7497 let (name, style, _, _, _, _, _) = test0 in
7498 generate_prototype ~extern:false ~semicolon:false ~newline:true
7499 ~handle:"g" ~prefix:"guestfs_" name style;
7505 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
7506 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7507 | StringList n -> pr " print_strings (%s);\n" n
7508 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7509 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
7511 pr " /* Java changes stdout line buffering so we need this: */\n";
7512 pr " fflush (stdout);\n";
7518 fun (name, style, _, _, _, _, _) ->
7519 if String.sub name (String.length name - 3) 3 <> "err" then (
7520 pr "/* Test normal return. */\n";
7521 generate_prototype ~extern:false ~semicolon:false ~newline:true
7522 ~handle:"g" ~prefix:"guestfs_" name style;
7524 (match fst style with
7529 pr " sscanf (val, \"%%d\", &r);\n";
7533 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
7536 pr " return strcmp (val, \"true\") == 0;\n"
7538 (* Can't return the input string here. Return a static
7539 * string so we ensure we get a segfault if the caller
7542 pr " return \"static string\";\n"
7544 pr " return strdup (val);\n"
7546 pr " char **strs;\n";
7548 pr " sscanf (val, \"%%d\", &n);\n";
7549 pr " strs = malloc ((n+1) * sizeof (char *));\n";
7550 pr " for (i = 0; i < n; ++i) {\n";
7551 pr " strs[i] = malloc (16);\n";
7552 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
7554 pr " strs[n] = NULL;\n";
7555 pr " return strs;\n"
7557 pr " struct guestfs_int_bool *r;\n";
7558 pr " r = malloc (sizeof (struct guestfs_int_bool));\n";
7559 pr " sscanf (val, \"%%\" SCNi32, &r->i);\n";
7563 pr " struct guestfs_lvm_pv_list *r;\n";
7565 pr " r = malloc (sizeof (struct guestfs_lvm_pv_list));\n";
7566 pr " sscanf (val, \"%%d\", &r->len);\n";
7567 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_pv));\n";
7568 pr " for (i = 0; i < r->len; ++i) {\n";
7569 pr " r->val[i].pv_name = malloc (16);\n";
7570 pr " snprintf (r->val[i].pv_name, 16, \"%%d\", i);\n";
7574 pr " struct guestfs_lvm_vg_list *r;\n";
7576 pr " r = malloc (sizeof (struct guestfs_lvm_vg_list));\n";
7577 pr " sscanf (val, \"%%d\", &r->len);\n";
7578 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_vg));\n";
7579 pr " for (i = 0; i < r->len; ++i) {\n";
7580 pr " r->val[i].vg_name = malloc (16);\n";
7581 pr " snprintf (r->val[i].vg_name, 16, \"%%d\", i);\n";
7585 pr " struct guestfs_lvm_lv_list *r;\n";
7587 pr " r = malloc (sizeof (struct guestfs_lvm_lv_list));\n";
7588 pr " sscanf (val, \"%%d\", &r->len);\n";
7589 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_lv));\n";
7590 pr " for (i = 0; i < r->len; ++i) {\n";
7591 pr " r->val[i].lv_name = malloc (16);\n";
7592 pr " snprintf (r->val[i].lv_name, 16, \"%%d\", i);\n";
7596 pr " struct guestfs_stat *r;\n";
7597 pr " r = calloc (1, sizeof (*r));\n";
7598 pr " sscanf (val, \"%%\" SCNi64, &r->dev);\n";
7601 pr " struct guestfs_statvfs *r;\n";
7602 pr " r = calloc (1, sizeof (*r));\n";
7603 pr " sscanf (val, \"%%\" SCNi64, &r->bsize);\n";
7606 pr " char **strs;\n";
7608 pr " sscanf (val, \"%%d\", &n);\n";
7609 pr " strs = malloc ((n*2+1) * sizeof (char *));\n";
7610 pr " for (i = 0; i < n; ++i) {\n";
7611 pr " strs[i*2] = malloc (16);\n";
7612 pr " strs[i*2+1] = malloc (16);\n";
7613 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
7614 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7616 pr " strs[n*2] = NULL;\n";
7617 pr " return strs;\n"
7622 pr "/* Test error return. */\n";
7623 generate_prototype ~extern:false ~semicolon:false ~newline:true
7624 ~handle:"g" ~prefix:"guestfs_" name style;
7626 pr " error (g, \"error\");\n";
7627 (match fst style with
7628 | RErr | RInt _ | RInt64 _ | RBool _ ->
7631 | RString _ | RStringList _ | RIntBool _
7632 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7634 pr " return NULL;\n"
7641 and generate_ocaml_bindtests () =
7642 generate_header OCamlStyle GPLv2;
7646 let g = Guestfs.create () in
7653 | CallString s -> "\"" ^ s ^ "\""
7654 | CallOptString None -> "None"
7655 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7656 | CallStringList xs ->
7657 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7658 | CallInt i when i >= 0 -> string_of_int i
7659 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7660 | CallBool b -> string_of_bool b
7665 generate_lang_bindtests (
7666 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
7669 pr "print_endline \"EOF\"\n"
7671 and generate_perl_bindtests () =
7672 pr "#!/usr/bin/perl -w\n";
7673 generate_header HashStyle GPLv2;
7680 my $g = Sys::Guestfs->new ();
7684 String.concat ", " (
7687 | CallString s -> "\"" ^ s ^ "\""
7688 | CallOptString None -> "undef"
7689 | CallOptString (Some s) -> sprintf "\"%s\"" s
7690 | CallStringList xs ->
7691 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7692 | CallInt i -> string_of_int i
7693 | CallBool b -> if b then "1" else "0"
7698 generate_lang_bindtests (
7699 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7702 pr "print \"EOF\\n\"\n"
7704 and generate_python_bindtests () =
7705 generate_header HashStyle GPLv2;
7710 g = guestfs.GuestFS ()
7714 String.concat ", " (
7717 | CallString s -> "\"" ^ s ^ "\""
7718 | CallOptString None -> "None"
7719 | CallOptString (Some s) -> sprintf "\"%s\"" s
7720 | CallStringList xs ->
7721 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7722 | CallInt i -> string_of_int i
7723 | CallBool b -> if b then "1" else "0"
7728 generate_lang_bindtests (
7729 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
7732 pr "print \"EOF\"\n"
7734 and generate_ruby_bindtests () =
7735 generate_header HashStyle GPLv2;
7740 g = Guestfs::create()
7744 String.concat ", " (
7747 | CallString s -> "\"" ^ s ^ "\""
7748 | CallOptString None -> "nil"
7749 | CallOptString (Some s) -> sprintf "\"%s\"" s
7750 | CallStringList xs ->
7751 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7752 | CallInt i -> string_of_int i
7753 | CallBool b -> string_of_bool b
7758 generate_lang_bindtests (
7759 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
7762 pr "print \"EOF\\n\"\n"
7764 and generate_java_bindtests () =
7765 generate_header CStyle GPLv2;
7768 import com.redhat.et.libguestfs.*;
7770 public class Bindtests {
7771 public static void main (String[] argv)
7774 GuestFS g = new GuestFS ();
7778 String.concat ", " (
7781 | CallString s -> "\"" ^ s ^ "\""
7782 | CallOptString None -> "null"
7783 | CallOptString (Some s) -> sprintf "\"%s\"" s
7784 | CallStringList xs ->
7786 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
7787 | CallInt i -> string_of_int i
7788 | CallBool b -> string_of_bool b
7793 generate_lang_bindtests (
7794 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
7798 System.out.println (\"EOF\");
7800 catch (Exception exn) {
7801 System.err.println (exn);
7808 and generate_haskell_bindtests () =
7809 generate_header HaskellStyle GPLv2;
7812 module Bindtests where
7813 import qualified Guestfs
7823 | CallString s -> "\"" ^ s ^ "\""
7824 | CallOptString None -> "Nothing"
7825 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
7826 | CallStringList xs ->
7827 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7828 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
7829 | CallInt i -> string_of_int i
7830 | CallBool true -> "True"
7831 | CallBool false -> "False"
7836 generate_lang_bindtests (
7837 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
7840 pr " putStrLn \"EOF\"\n"
7842 (* Language-independent bindings tests - we do it this way to
7843 * ensure there is parity in testing bindings across all languages.
7845 and generate_lang_bindtests call =
7846 call "test0" [CallString "abc"; CallOptString (Some "def");
7847 CallStringList []; CallBool false;
7848 CallInt 0; CallString "123"; CallString "456"];
7849 call "test0" [CallString "abc"; CallOptString None;
7850 CallStringList []; CallBool false;
7851 CallInt 0; CallString "123"; CallString "456"];
7852 call "test0" [CallString ""; CallOptString (Some "def");
7853 CallStringList []; CallBool false;
7854 CallInt 0; CallString "123"; CallString "456"];
7855 call "test0" [CallString ""; CallOptString (Some "");
7856 CallStringList []; CallBool false;
7857 CallInt 0; CallString "123"; CallString "456"];
7858 call "test0" [CallString "abc"; CallOptString (Some "def");
7859 CallStringList ["1"]; CallBool false;
7860 CallInt 0; CallString "123"; CallString "456"];
7861 call "test0" [CallString "abc"; CallOptString (Some "def");
7862 CallStringList ["1"; "2"]; CallBool false;
7863 CallInt 0; CallString "123"; CallString "456"];
7864 call "test0" [CallString "abc"; CallOptString (Some "def");
7865 CallStringList ["1"]; CallBool true;
7866 CallInt 0; CallString "123"; CallString "456"];
7867 call "test0" [CallString "abc"; CallOptString (Some "def");
7868 CallStringList ["1"]; CallBool false;
7869 CallInt (-1); CallString "123"; CallString "456"];
7870 call "test0" [CallString "abc"; CallOptString (Some "def");
7871 CallStringList ["1"]; CallBool false;
7872 CallInt (-2); CallString "123"; CallString "456"];
7873 call "test0" [CallString "abc"; CallOptString (Some "def");
7874 CallStringList ["1"]; CallBool false;
7875 CallInt 1; CallString "123"; CallString "456"];
7876 call "test0" [CallString "abc"; CallOptString (Some "def");
7877 CallStringList ["1"]; CallBool false;
7878 CallInt 2; CallString "123"; CallString "456"];
7879 call "test0" [CallString "abc"; CallOptString (Some "def");
7880 CallStringList ["1"]; CallBool false;
7881 CallInt 4095; CallString "123"; CallString "456"];
7882 call "test0" [CallString "abc"; CallOptString (Some "def");
7883 CallStringList ["1"]; CallBool false;
7884 CallInt 0; CallString ""; CallString ""]
7886 (* XXX Add here tests of the return and error functions. *)
7888 (* This is used to generate the src/MAX_PROC_NR file which
7889 * contains the maximum procedure number, a surrogate for the
7890 * ABI version number. See src/Makefile.am for the details.
7892 and generate_max_proc_nr () =
7893 let proc_nrs = List.map (
7894 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
7895 ) daemon_functions in
7897 let max_proc_nr = List.fold_left max 0 proc_nrs in
7899 pr "%d\n" max_proc_nr
7901 let output_to filename =
7902 let filename_new = filename ^ ".new" in
7903 chan := open_out filename_new;
7908 (* Is the new file different from the current file? *)
7909 if Sys.file_exists filename && files_equal filename filename_new then
7910 Unix.unlink filename_new (* same, so skip it *)
7912 (* different, overwrite old one *)
7913 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
7914 Unix.rename filename_new filename;
7915 Unix.chmod filename 0o444;
7916 printf "written %s\n%!" filename;
7925 if not (Sys.file_exists "configure.ac") then (
7927 You are probably running this from the wrong directory.
7928 Run it from the top source directory using the command
7934 let close = output_to "src/guestfs_protocol.x" in
7938 let close = output_to "src/guestfs-structs.h" in
7939 generate_structs_h ();
7942 let close = output_to "src/guestfs-actions.h" in
7943 generate_actions_h ();
7946 let close = output_to "src/guestfs-actions.c" in
7947 generate_client_actions ();
7950 let close = output_to "daemon/actions.h" in
7951 generate_daemon_actions_h ();
7954 let close = output_to "daemon/stubs.c" in
7955 generate_daemon_actions ();
7958 let close = output_to "capitests/tests.c" in
7962 let close = output_to "src/guestfs-bindtests.c" in
7963 generate_bindtests ();
7966 let close = output_to "fish/cmds.c" in
7967 generate_fish_cmds ();
7970 let close = output_to "fish/completion.c" in
7971 generate_fish_completion ();
7974 let close = output_to "guestfs-structs.pod" in
7975 generate_structs_pod ();
7978 let close = output_to "guestfs-actions.pod" in
7979 generate_actions_pod ();
7982 let close = output_to "guestfish-actions.pod" in
7983 generate_fish_actions_pod ();
7986 let close = output_to "ocaml/guestfs.mli" in
7987 generate_ocaml_mli ();
7990 let close = output_to "ocaml/guestfs.ml" in
7991 generate_ocaml_ml ();
7994 let close = output_to "ocaml/guestfs_c_actions.c" in
7995 generate_ocaml_c ();
7998 let close = output_to "ocaml/bindtests.ml" in
7999 generate_ocaml_bindtests ();
8002 let close = output_to "perl/Guestfs.xs" in
8003 generate_perl_xs ();
8006 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8007 generate_perl_pm ();
8010 let close = output_to "perl/bindtests.pl" in
8011 generate_perl_bindtests ();
8014 let close = output_to "python/guestfs-py.c" in
8015 generate_python_c ();
8018 let close = output_to "python/guestfs.py" in
8019 generate_python_py ();
8022 let close = output_to "python/bindtests.py" in
8023 generate_python_bindtests ();
8026 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8030 let close = output_to "ruby/bindtests.rb" in
8031 generate_ruby_bindtests ();
8034 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8035 generate_java_java ();
8038 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
8039 generate_java_struct "PV" pv_cols;
8042 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
8043 generate_java_struct "VG" vg_cols;
8046 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
8047 generate_java_struct "LV" lv_cols;
8050 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
8051 generate_java_struct "Stat" stat_cols;
8054 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
8055 generate_java_struct "StatVFS" statvfs_cols;
8058 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8062 let close = output_to "java/Bindtests.java" in
8063 generate_java_bindtests ();
8066 let close = output_to "haskell/Guestfs.hs" in
8067 generate_haskell_hs ();
8070 let close = output_to "haskell/Bindtests.hs" in
8071 generate_haskell_bindtests ();
8074 let close = output_to "src/MAX_PROC_NR" in
8075 generate_max_proc_nr ();