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 * If the appliance is running an older Linux kernel (eg. RHEL 5) then
147 * devices are named /dev/hda etc. To cope with this, the test suite
148 * adds some hairly logic to detect this case, and then automagically
149 * replaces all strings which match "/dev/sd.*" with "/dev/hd.*".
150 * When writing test cases you shouldn't have to worry about this
153 * Don't assume anything about the previous contents of the block
154 * devices. Use 'Init*' to create some initial scenarios.
156 * You can add a prerequisite clause to any individual test. This
157 * is a run-time check, which, if it fails, causes the test to be
158 * skipped. Useful if testing a command which might not work on
159 * all variations of libguestfs builds. A test that has prerequisite
160 * of 'Always' is run unconditionally.
162 * In addition, packagers can skip individual tests by setting the
163 * environment variables: eg:
164 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
165 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
167 type tests = (test_init * test_prereq * test) list
169 (* Run the command sequence and just expect nothing to fail. *)
171 (* Run the command sequence and expect the output of the final
172 * command to be the string.
174 | TestOutput of seq * string
175 (* Run the command sequence and expect the output of the final
176 * command to be the list of strings.
178 | TestOutputList of seq * string list
179 (* Run the command sequence and expect the output of the final
180 * command to be the list of block devices (could be either
181 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
182 * character of each string).
184 | TestOutputListOfDevices of seq * string list
185 (* Run the command sequence and expect the output of the final
186 * command to be the integer.
188 | TestOutputInt of seq * int
189 (* Run the command sequence and expect the output of the final
190 * command to be a true value (!= 0 or != NULL).
192 | TestOutputTrue of seq
193 (* Run the command sequence and expect the output of the final
194 * command to be a false value (== 0 or == NULL, but not an error).
196 | TestOutputFalse of seq
197 (* Run the command sequence and expect the output of the final
198 * command to be a list of the given length (but don't care about
201 | TestOutputLength of seq * int
202 (* Run the command sequence and expect the output of the final
203 * command to be a structure.
205 | TestOutputStruct of seq * test_field_compare list
206 (* Run the command sequence and expect the final command (only)
209 | TestLastFail of seq
211 and test_field_compare =
212 | CompareWithInt of string * int
213 | CompareWithString of string * string
214 | CompareFieldsIntEq of string * string
215 | CompareFieldsStrEq of string * string
217 (* Test prerequisites. *)
219 (* Test always runs. *)
221 (* Test is currently disabled - eg. it fails, or it tests some
222 * unimplemented feature.
225 (* 'string' is some C code (a function body) that should return
226 * true or false. The test will run if the code returns true.
229 (* As for 'If' but the test runs _unless_ the code returns true. *)
232 (* Some initial scenarios for testing. *)
234 (* Do nothing, block devices could contain random stuff including
235 * LVM PVs, and some filesystems might be mounted. This is usually
239 (* Block devices are empty and no filesystems are mounted. *)
241 (* /dev/sda contains a single partition /dev/sda1, which is formatted
242 * as ext2, empty [except for lost+found] and mounted on /.
243 * /dev/sdb and /dev/sdc may have random content.
248 * /dev/sda1 (is a PV):
249 * /dev/VG/LV (size 8MB):
250 * formatted as ext2, empty [except for lost+found], mounted on /
251 * /dev/sdb and /dev/sdc may have random content.
255 (* Sequence of commands for testing. *)
257 and cmd = string list
259 (* Note about long descriptions: When referring to another
260 * action, use the format C<guestfs_other> (ie. the full name of
261 * the C function). This will be replaced as appropriate in other
264 * Apart from that, long descriptions are just perldoc paragraphs.
267 (* These test functions are used in the language binding tests. *)
269 let test_all_args = [
272 StringList "strlist";
279 let test_all_rets = [
280 (* except for RErr, which is tested thoroughly elsewhere *)
281 "test0rint", RInt "valout";
282 "test0rint64", RInt64 "valout";
283 "test0rbool", RBool "valout";
284 "test0rconststring", RConstString "valout";
285 "test0rstring", RString "valout";
286 "test0rstringlist", RStringList "valout";
287 "test0rintbool", RIntBool ("valout", "valout");
288 "test0rpvlist", RPVList "valout";
289 "test0rvglist", RVGList "valout";
290 "test0rlvlist", RLVList "valout";
291 "test0rstat", RStat "valout";
292 "test0rstatvfs", RStatVFS "valout";
293 "test0rhashtable", RHashtable "valout";
296 let test_functions = [
297 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
299 "internal test function - do not use",
301 This is an internal test function which is used to test whether
302 the automatically generated bindings can handle every possible
303 parameter type correctly.
305 It echos the contents of each parameter to stdout.
307 You probably don't want to call this function.");
311 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
313 "internal test function - do not use",
315 This is an internal test function which is used to test whether
316 the automatically generated bindings can handle every possible
317 return type correctly.
319 It converts string C<val> to the return type.
321 You probably don't want to call this function.");
322 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
324 "internal test function - do not use",
326 This is an internal test function which is used to test whether
327 the automatically generated bindings can handle every possible
328 return type correctly.
330 This function always returns an error.
332 You probably don't want to call this function.")]
336 (* non_daemon_functions are any functions which don't get processed
337 * in the daemon, eg. functions for setting and getting local
338 * configuration values.
341 let non_daemon_functions = test_functions @ [
342 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
344 "launch the qemu subprocess",
346 Internally libguestfs is implemented by running a virtual machine
349 You should call this after configuring the handle
350 (eg. adding drives) but before performing any actions.");
352 ("wait_ready", (RErr, []), -1, [NotInFish],
354 "wait until the qemu subprocess launches",
356 Internally libguestfs is implemented by running a virtual machine
359 You should call this after C<guestfs_launch> to wait for the launch
362 ("kill_subprocess", (RErr, []), -1, [],
364 "kill the qemu subprocess",
366 This kills the qemu subprocess. You should never need to call this.");
368 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
370 "add an image to examine or modify",
372 This function adds a virtual machine disk image C<filename> to the
373 guest. The first time you call this function, the disk appears as IDE
374 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
377 You don't necessarily need to be root when using libguestfs. However
378 you obviously do need sufficient permissions to access the filename
379 for whatever operations you want to perform (ie. read access if you
380 just want to read the image or write access if you want to modify the
383 This is equivalent to the qemu parameter C<-drive file=filename>.
385 Note that this call checks for the existence of C<filename>. This
386 stops you from specifying other types of drive which are supported
387 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
388 the general C<guestfs_config> call instead.");
390 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
392 "add a CD-ROM disk image to examine",
394 This function adds a virtual CD-ROM disk image to the guest.
396 This is equivalent to the qemu parameter C<-cdrom filename>.
398 Note that this call checks for the existence of C<filename>. This
399 stops you from specifying other types of drive which are supported
400 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
401 the general C<guestfs_config> call instead.");
403 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
405 "add a drive in snapshot mode (read-only)",
407 This adds a drive in snapshot mode, making it effectively
410 Note that writes to the device are allowed, and will be seen for
411 the duration of the guestfs handle, but they are written
412 to a temporary file which is discarded as soon as the guestfs
413 handle is closed. We don't currently have any method to enable
414 changes to be committed, although qemu can support this.
416 This is equivalent to the qemu parameter
417 C<-drive file=filename,snapshot=on>.
419 Note that this call checks for the existence of C<filename>. This
420 stops you from specifying other types of drive which are supported
421 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
422 the general C<guestfs_config> call instead.");
424 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
426 "add qemu parameters",
428 This can be used to add arbitrary qemu command line parameters
429 of the form C<-param value>. Actually it's not quite arbitrary - we
430 prevent you from setting some parameters which would interfere with
431 parameters that we use.
433 The first character of C<param> string must be a C<-> (dash).
435 C<value> can be NULL.");
437 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
439 "set the qemu binary",
441 Set the qemu binary that we will use.
443 The default is chosen when the library was compiled by the
446 You can also override this by setting the C<LIBGUESTFS_QEMU>
447 environment variable.
449 Setting C<qemu> to C<NULL> restores the default qemu binary.");
451 ("get_qemu", (RConstString "qemu", []), -1, [],
453 "get the qemu binary",
455 Return the current qemu binary.
457 This is always non-NULL. If it wasn't set already, then this will
458 return the default qemu binary name.");
460 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
462 "set the search path",
464 Set the path that libguestfs searches for kernel and initrd.img.
466 The default is C<$libdir/guestfs> unless overridden by setting
467 C<LIBGUESTFS_PATH> environment variable.
469 Setting C<path> to C<NULL> restores the default path.");
471 ("get_path", (RConstString "path", []), -1, [],
473 "get the search path",
475 Return the current search path.
477 This is always non-NULL. If it wasn't set already, then this will
478 return the default path.");
480 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
482 "add options to kernel command line",
484 This function is used to add additional options to the
485 guest kernel command line.
487 The default is C<NULL> unless overridden by setting
488 C<LIBGUESTFS_APPEND> environment variable.
490 Setting C<append> to C<NULL> means I<no> additional options
491 are passed (libguestfs always adds a few of its own).");
493 ("get_append", (RConstString "append", []), -1, [],
495 "get the additional kernel options",
497 Return the additional kernel options which are added to the
498 guest kernel command line.
500 If C<NULL> then no options are added.");
502 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
506 If C<autosync> is true, this enables autosync. Libguestfs will make a
507 best effort attempt to run C<guestfs_umount_all> followed by
508 C<guestfs_sync> when the handle is closed
509 (also if the program exits without closing handles).
511 This is disabled by default (except in guestfish where it is
512 enabled by default).");
514 ("get_autosync", (RBool "autosync", []), -1, [],
518 Get the autosync flag.");
520 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
524 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
526 Verbose messages are disabled unless the environment variable
527 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
529 ("get_verbose", (RBool "verbose", []), -1, [],
533 This returns the verbose messages flag.");
535 ("is_ready", (RBool "ready", []), -1, [],
537 "is ready to accept commands",
539 This returns true iff this handle is ready to accept commands
540 (in the C<READY> state).
542 For more information on states, see L<guestfs(3)>.");
544 ("is_config", (RBool "config", []), -1, [],
546 "is in configuration state",
548 This returns true iff this handle is being configured
549 (in the C<CONFIG> state).
551 For more information on states, see L<guestfs(3)>.");
553 ("is_launching", (RBool "launching", []), -1, [],
555 "is launching subprocess",
557 This returns true iff this handle is launching the subprocess
558 (in the C<LAUNCHING> state).
560 For more information on states, see L<guestfs(3)>.");
562 ("is_busy", (RBool "busy", []), -1, [],
564 "is busy processing a command",
566 This returns true iff this handle is busy processing a command
567 (in the C<BUSY> state).
569 For more information on states, see L<guestfs(3)>.");
571 ("get_state", (RInt "state", []), -1, [],
573 "get the current state",
575 This returns the current state as an opaque integer. This is
576 only useful for printing debug and internal error messages.
578 For more information on states, see L<guestfs(3)>.");
580 ("set_busy", (RErr, []), -1, [NotInFish],
584 This sets the state to C<BUSY>. This is only used when implementing
585 actions using the low-level API.
587 For more information on states, see L<guestfs(3)>.");
589 ("set_ready", (RErr, []), -1, [NotInFish],
591 "set state to ready",
593 This sets the state to C<READY>. This is only used when implementing
594 actions using the low-level API.
596 For more information on states, see L<guestfs(3)>.");
598 ("end_busy", (RErr, []), -1, [NotInFish],
600 "leave the busy state",
602 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
603 state as is. This is only used when implementing
604 actions using the low-level API.
606 For more information on states, see L<guestfs(3)>.");
610 (* daemon_functions are any functions which cause some action
611 * to take place in the daemon.
614 let daemon_functions = [
615 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
616 [InitEmpty, Always, TestOutput (
617 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
618 ["mkfs"; "ext2"; "/dev/sda1"];
619 ["mount"; "/dev/sda1"; "/"];
620 ["write_file"; "/new"; "new file contents"; "0"];
621 ["cat"; "/new"]], "new file contents")],
622 "mount a guest disk at a position in the filesystem",
624 Mount a guest disk at a position in the filesystem. Block devices
625 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
626 the guest. If those block devices contain partitions, they will have
627 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
630 The rules are the same as for L<mount(2)>: A filesystem must
631 first be mounted on C</> before others can be mounted. Other
632 filesystems can only be mounted on directories which already
635 The mounted filesystem is writable, if we have sufficient permissions
636 on the underlying device.
638 The filesystem options C<sync> and C<noatime> are set with this
639 call, in order to improve reliability.");
641 ("sync", (RErr, []), 2, [],
642 [ InitEmpty, Always, TestRun [["sync"]]],
643 "sync disks, writes are flushed through to the disk image",
645 This syncs the disk, so that any writes are flushed through to the
646 underlying disk image.
648 You should always call this if you have modified a disk image, before
649 closing the handle.");
651 ("touch", (RErr, [String "path"]), 3, [],
652 [InitBasicFS, Always, TestOutputTrue (
654 ["exists"; "/new"]])],
655 "update file timestamps or create a new file",
657 Touch acts like the L<touch(1)> command. It can be used to
658 update the timestamps on a file, or, if the file does not exist,
659 to create a new zero-length file.");
661 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
662 [InitBasicFS, Always, TestOutput (
663 [["write_file"; "/new"; "new file contents"; "0"];
664 ["cat"; "/new"]], "new file contents")],
665 "list the contents of a file",
667 Return the contents of the file named C<path>.
669 Note that this function cannot correctly handle binary files
670 (specifically, files containing C<\\0> character which is treated
671 as end of string). For those you need to use the C<guestfs_download>
672 function which has a more complex interface.");
674 ("ll", (RString "listing", [String "directory"]), 5, [],
675 [], (* XXX Tricky to test because it depends on the exact format
676 * of the 'ls -l' command, which changes between F10 and F11.
678 "list the files in a directory (long format)",
680 List the files in C<directory> (relative to the root directory,
681 there is no cwd) in the format of 'ls -la'.
683 This command is mostly useful for interactive sessions. It
684 is I<not> intended that you try to parse the output string.");
686 ("ls", (RStringList "listing", [String "directory"]), 6, [],
687 [InitBasicFS, Always, TestOutputList (
690 ["touch"; "/newest"];
691 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
692 "list the files in a directory",
694 List the files in C<directory> (relative to the root directory,
695 there is no cwd). The '.' and '..' entries are not returned, but
696 hidden files are shown.
698 This command is mostly useful for interactive sessions. Programs
699 should probably use C<guestfs_readdir> instead.");
701 ("list_devices", (RStringList "devices", []), 7, [],
702 [InitEmpty, Always, TestOutputListOfDevices (
703 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
704 "list the block devices",
706 List all the block devices.
708 The full block device names are returned, eg. C</dev/sda>");
710 ("list_partitions", (RStringList "partitions", []), 8, [],
711 [InitBasicFS, Always, TestOutputListOfDevices (
712 [["list_partitions"]], ["/dev/sda1"]);
713 InitEmpty, Always, TestOutputListOfDevices (
714 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
715 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
716 "list the partitions",
718 List all the partitions detected on all block devices.
720 The full partition device names are returned, eg. C</dev/sda1>
722 This does not return logical volumes. For that you will need to
723 call C<guestfs_lvs>.");
725 ("pvs", (RStringList "physvols", []), 9, [],
726 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
727 [["pvs"]], ["/dev/sda1"]);
728 InitEmpty, Always, TestOutputListOfDevices (
729 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
730 ["pvcreate"; "/dev/sda1"];
731 ["pvcreate"; "/dev/sda2"];
732 ["pvcreate"; "/dev/sda3"];
733 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
734 "list the LVM physical volumes (PVs)",
736 List all the physical volumes detected. This is the equivalent
737 of the L<pvs(8)> command.
739 This returns a list of just the device names that contain
740 PVs (eg. C</dev/sda2>).
742 See also C<guestfs_pvs_full>.");
744 ("vgs", (RStringList "volgroups", []), 10, [],
745 [InitBasicFSonLVM, Always, TestOutputList (
747 InitEmpty, Always, TestOutputList (
748 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
749 ["pvcreate"; "/dev/sda1"];
750 ["pvcreate"; "/dev/sda2"];
751 ["pvcreate"; "/dev/sda3"];
752 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
753 ["vgcreate"; "VG2"; "/dev/sda3"];
754 ["vgs"]], ["VG1"; "VG2"])],
755 "list the LVM volume groups (VGs)",
757 List all the volumes groups detected. This is the equivalent
758 of the L<vgs(8)> command.
760 This returns a list of just the volume group names that were
761 detected (eg. C<VolGroup00>).
763 See also C<guestfs_vgs_full>.");
765 ("lvs", (RStringList "logvols", []), 11, [],
766 [InitBasicFSonLVM, Always, TestOutputList (
767 [["lvs"]], ["/dev/VG/LV"]);
768 InitEmpty, Always, TestOutputList (
769 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
770 ["pvcreate"; "/dev/sda1"];
771 ["pvcreate"; "/dev/sda2"];
772 ["pvcreate"; "/dev/sda3"];
773 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
774 ["vgcreate"; "VG2"; "/dev/sda3"];
775 ["lvcreate"; "LV1"; "VG1"; "50"];
776 ["lvcreate"; "LV2"; "VG1"; "50"];
777 ["lvcreate"; "LV3"; "VG2"; "50"];
778 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
779 "list the LVM logical volumes (LVs)",
781 List all the logical volumes detected. This is the equivalent
782 of the L<lvs(8)> command.
784 This returns a list of the logical volume device names
785 (eg. C</dev/VolGroup00/LogVol00>).
787 See also C<guestfs_lvs_full>.");
789 ("pvs_full", (RPVList "physvols", []), 12, [],
790 [], (* XXX how to test? *)
791 "list the LVM physical volumes (PVs)",
793 List all the physical volumes detected. This is the equivalent
794 of the L<pvs(8)> command. The \"full\" version includes all fields.");
796 ("vgs_full", (RVGList "volgroups", []), 13, [],
797 [], (* XXX how to test? *)
798 "list the LVM volume groups (VGs)",
800 List all the volumes groups detected. This is the equivalent
801 of the L<vgs(8)> command. The \"full\" version includes all fields.");
803 ("lvs_full", (RLVList "logvols", []), 14, [],
804 [], (* XXX how to test? *)
805 "list the LVM logical volumes (LVs)",
807 List all the logical volumes detected. This is the equivalent
808 of the L<lvs(8)> command. The \"full\" version includes all fields.");
810 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
811 [InitBasicFS, Always, TestOutputList (
812 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
813 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
814 InitBasicFS, Always, TestOutputList (
815 [["write_file"; "/new"; ""; "0"];
816 ["read_lines"; "/new"]], [])],
817 "read file as lines",
819 Return the contents of the file named C<path>.
821 The file contents are returned as a list of lines. Trailing
822 C<LF> and C<CRLF> character sequences are I<not> returned.
824 Note that this function cannot correctly handle binary files
825 (specifically, files containing C<\\0> character which is treated
826 as end of line). For those you need to use the C<guestfs_read_file>
827 function which has a more complex interface.");
829 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
830 [], (* XXX Augeas code needs tests. *)
831 "create a new Augeas handle",
833 Create a new Augeas handle for editing configuration files.
834 If there was any previous Augeas handle associated with this
835 guestfs session, then it is closed.
837 You must call this before using any other C<guestfs_aug_*>
840 C<root> is the filesystem root. C<root> must not be NULL,
843 The flags are the same as the flags defined in
844 E<lt>augeas.hE<gt>, the logical I<or> of the following
849 =item C<AUG_SAVE_BACKUP> = 1
851 Keep the original file with a C<.augsave> extension.
853 =item C<AUG_SAVE_NEWFILE> = 2
855 Save changes into a file with extension C<.augnew>, and
856 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
858 =item C<AUG_TYPE_CHECK> = 4
860 Typecheck lenses (can be expensive).
862 =item C<AUG_NO_STDINC> = 8
864 Do not use standard load path for modules.
866 =item C<AUG_SAVE_NOOP> = 16
868 Make save a no-op, just record what would have been changed.
870 =item C<AUG_NO_LOAD> = 32
872 Do not load the tree in C<guestfs_aug_init>.
876 To close the handle, you can call C<guestfs_aug_close>.
878 To find out more about Augeas, see L<http://augeas.net/>.");
880 ("aug_close", (RErr, []), 26, [],
881 [], (* XXX Augeas code needs tests. *)
882 "close the current Augeas handle",
884 Close the current Augeas handle and free up any resources
885 used by it. After calling this, you have to call
886 C<guestfs_aug_init> again before you can use any other
889 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
890 [], (* XXX Augeas code needs tests. *)
891 "define an Augeas variable",
893 Defines an Augeas variable C<name> whose value is the result
894 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
897 On success this returns the number of nodes in C<expr>, or
898 C<0> if C<expr> evaluates to something which is not a nodeset.");
900 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
901 [], (* XXX Augeas code needs tests. *)
902 "define an Augeas node",
904 Defines a variable C<name> whose value is the result of
907 If C<expr> evaluates to an empty nodeset, a node is created,
908 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
909 C<name> will be the nodeset containing that single node.
911 On success this returns a pair containing the
912 number of nodes in the nodeset, and a boolean flag
913 if a node was created.");
915 ("aug_get", (RString "val", [String "path"]), 19, [],
916 [], (* XXX Augeas code needs tests. *)
917 "look up the value of an Augeas path",
919 Look up the value associated with C<path>. If C<path>
920 matches exactly one node, the C<value> is returned.");
922 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
923 [], (* XXX Augeas code needs tests. *)
924 "set Augeas path to value",
926 Set the value associated with C<path> to C<value>.");
928 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
929 [], (* XXX Augeas code needs tests. *)
930 "insert a sibling Augeas node",
932 Create a new sibling C<label> for C<path>, inserting it into
933 the tree before or after C<path> (depending on the boolean
936 C<path> must match exactly one existing node in the tree, and
937 C<label> must be a label, ie. not contain C</>, C<*> or end
938 with a bracketed index C<[N]>.");
940 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
941 [], (* XXX Augeas code needs tests. *)
942 "remove an Augeas path",
944 Remove C<path> and all of its children.
946 On success this returns the number of entries which were removed.");
948 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
949 [], (* XXX Augeas code needs tests. *)
952 Move the node C<src> to C<dest>. C<src> must match exactly
953 one node. C<dest> is overwritten if it exists.");
955 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
956 [], (* XXX Augeas code needs tests. *)
957 "return Augeas nodes which match path",
959 Returns a list of paths which match the path expression C<path>.
960 The returned paths are sufficiently qualified so that they match
961 exactly one node in the current tree.");
963 ("aug_save", (RErr, []), 25, [],
964 [], (* XXX Augeas code needs tests. *)
965 "write all pending Augeas changes to disk",
967 This writes all pending changes to disk.
969 The flags which were passed to C<guestfs_aug_init> affect exactly
970 how files are saved.");
972 ("aug_load", (RErr, []), 27, [],
973 [], (* XXX Augeas code needs tests. *)
974 "load files into the tree",
976 Load files into the tree.
978 See C<aug_load> in the Augeas documentation for the full gory
981 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
982 [], (* XXX Augeas code needs tests. *)
983 "list Augeas nodes under a path",
985 This is just a shortcut for listing C<guestfs_aug_match>
986 C<path/*> and sorting the resulting nodes into alphabetical order.");
988 ("rm", (RErr, [String "path"]), 29, [],
989 [InitBasicFS, Always, TestRun
992 InitBasicFS, Always, TestLastFail
994 InitBasicFS, Always, TestLastFail
999 Remove the single file C<path>.");
1001 ("rmdir", (RErr, [String "path"]), 30, [],
1002 [InitBasicFS, Always, TestRun
1005 InitBasicFS, Always, TestLastFail
1006 [["rmdir"; "/new"]];
1007 InitBasicFS, Always, TestLastFail
1009 ["rmdir"; "/new"]]],
1010 "remove a directory",
1012 Remove the single directory C<path>.");
1014 ("rm_rf", (RErr, [String "path"]), 31, [],
1015 [InitBasicFS, Always, TestOutputFalse
1017 ["mkdir"; "/new/foo"];
1018 ["touch"; "/new/foo/bar"];
1020 ["exists"; "/new"]]],
1021 "remove a file or directory recursively",
1023 Remove the file or directory C<path>, recursively removing the
1024 contents if its a directory. This is like the C<rm -rf> shell
1027 ("mkdir", (RErr, [String "path"]), 32, [],
1028 [InitBasicFS, Always, TestOutputTrue
1030 ["is_dir"; "/new"]];
1031 InitBasicFS, Always, TestLastFail
1032 [["mkdir"; "/new/foo/bar"]]],
1033 "create a directory",
1035 Create a directory named C<path>.");
1037 ("mkdir_p", (RErr, [String "path"]), 33, [],
1038 [InitBasicFS, Always, TestOutputTrue
1039 [["mkdir_p"; "/new/foo/bar"];
1040 ["is_dir"; "/new/foo/bar"]];
1041 InitBasicFS, Always, TestOutputTrue
1042 [["mkdir_p"; "/new/foo/bar"];
1043 ["is_dir"; "/new/foo"]];
1044 InitBasicFS, Always, TestOutputTrue
1045 [["mkdir_p"; "/new/foo/bar"];
1046 ["is_dir"; "/new"]];
1047 (* Regression tests for RHBZ#503133: *)
1048 InitBasicFS, Always, TestRun
1050 ["mkdir_p"; "/new"]];
1051 InitBasicFS, Always, TestLastFail
1053 ["mkdir_p"; "/new"]]],
1054 "create a directory and parents",
1056 Create a directory named C<path>, creating any parent directories
1057 as necessary. This is like the C<mkdir -p> shell command.");
1059 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1060 [], (* XXX Need stat command to test *)
1063 Change the mode (permissions) of C<path> to C<mode>. Only
1064 numeric modes are supported.");
1066 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1067 [], (* XXX Need stat command to test *)
1068 "change file owner and group",
1070 Change the file owner to C<owner> and group to C<group>.
1072 Only numeric uid and gid are supported. If you want to use
1073 names, you will need to locate and parse the password file
1074 yourself (Augeas support makes this relatively easy).");
1076 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1077 [InitBasicFS, Always, TestOutputTrue (
1079 ["exists"; "/new"]]);
1080 InitBasicFS, Always, TestOutputTrue (
1082 ["exists"; "/new"]])],
1083 "test if file or directory exists",
1085 This returns C<true> if and only if there is a file, directory
1086 (or anything) with the given C<path> name.
1088 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1090 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1091 [InitBasicFS, Always, TestOutputTrue (
1093 ["is_file"; "/new"]]);
1094 InitBasicFS, Always, TestOutputFalse (
1096 ["is_file"; "/new"]])],
1097 "test if file exists",
1099 This returns C<true> if and only if there is a file
1100 with the given C<path> name. Note that it returns false for
1101 other objects like directories.
1103 See also C<guestfs_stat>.");
1105 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1106 [InitBasicFS, Always, TestOutputFalse (
1108 ["is_dir"; "/new"]]);
1109 InitBasicFS, Always, TestOutputTrue (
1111 ["is_dir"; "/new"]])],
1112 "test if file exists",
1114 This returns C<true> if and only if there is a directory
1115 with the given C<path> name. Note that it returns false for
1116 other objects like files.
1118 See also C<guestfs_stat>.");
1120 ("pvcreate", (RErr, [String "device"]), 39, [],
1121 [InitEmpty, Always, TestOutputListOfDevices (
1122 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1123 ["pvcreate"; "/dev/sda1"];
1124 ["pvcreate"; "/dev/sda2"];
1125 ["pvcreate"; "/dev/sda3"];
1126 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1127 "create an LVM physical volume",
1129 This creates an LVM physical volume on the named C<device>,
1130 where C<device> should usually be a partition name such
1133 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1134 [InitEmpty, Always, TestOutputList (
1135 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1136 ["pvcreate"; "/dev/sda1"];
1137 ["pvcreate"; "/dev/sda2"];
1138 ["pvcreate"; "/dev/sda3"];
1139 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1140 ["vgcreate"; "VG2"; "/dev/sda3"];
1141 ["vgs"]], ["VG1"; "VG2"])],
1142 "create an LVM volume group",
1144 This creates an LVM volume group called C<volgroup>
1145 from the non-empty list of physical volumes C<physvols>.");
1147 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1148 [InitEmpty, Always, TestOutputList (
1149 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1150 ["pvcreate"; "/dev/sda1"];
1151 ["pvcreate"; "/dev/sda2"];
1152 ["pvcreate"; "/dev/sda3"];
1153 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1154 ["vgcreate"; "VG2"; "/dev/sda3"];
1155 ["lvcreate"; "LV1"; "VG1"; "50"];
1156 ["lvcreate"; "LV2"; "VG1"; "50"];
1157 ["lvcreate"; "LV3"; "VG2"; "50"];
1158 ["lvcreate"; "LV4"; "VG2"; "50"];
1159 ["lvcreate"; "LV5"; "VG2"; "50"];
1161 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1162 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1163 "create an LVM volume group",
1165 This creates an LVM volume group called C<logvol>
1166 on the volume group C<volgroup>, with C<size> megabytes.");
1168 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1169 [InitEmpty, Always, TestOutput (
1170 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1171 ["mkfs"; "ext2"; "/dev/sda1"];
1172 ["mount"; "/dev/sda1"; "/"];
1173 ["write_file"; "/new"; "new file contents"; "0"];
1174 ["cat"; "/new"]], "new file contents")],
1175 "make a filesystem",
1177 This creates a filesystem on C<device> (usually a partition
1178 or LVM logical volume). The filesystem type is C<fstype>, for
1181 ("sfdisk", (RErr, [String "device";
1182 Int "cyls"; Int "heads"; Int "sectors";
1183 StringList "lines"]), 43, [DangerWillRobinson],
1185 "create partitions on a block device",
1187 This is a direct interface to the L<sfdisk(8)> program for creating
1188 partitions on block devices.
1190 C<device> should be a block device, for example C</dev/sda>.
1192 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1193 and sectors on the device, which are passed directly to sfdisk as
1194 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1195 of these, then the corresponding parameter is omitted. Usually for
1196 'large' disks, you can just pass C<0> for these, but for small
1197 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1198 out the right geometry and you will need to tell it.
1200 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1201 information refer to the L<sfdisk(8)> manpage.
1203 To create a single partition occupying the whole disk, you would
1204 pass C<lines> as a single element list, when the single element being
1205 the string C<,> (comma).
1207 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1209 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1210 [InitBasicFS, Always, TestOutput (
1211 [["write_file"; "/new"; "new file contents"; "0"];
1212 ["cat"; "/new"]], "new file contents");
1213 InitBasicFS, Always, TestOutput (
1214 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1215 ["cat"; "/new"]], "\nnew file contents\n");
1216 InitBasicFS, Always, TestOutput (
1217 [["write_file"; "/new"; "\n\n"; "0"];
1218 ["cat"; "/new"]], "\n\n");
1219 InitBasicFS, Always, TestOutput (
1220 [["write_file"; "/new"; ""; "0"];
1221 ["cat"; "/new"]], "");
1222 InitBasicFS, Always, TestOutput (
1223 [["write_file"; "/new"; "\n\n\n"; "0"];
1224 ["cat"; "/new"]], "\n\n\n");
1225 InitBasicFS, Always, TestOutput (
1226 [["write_file"; "/new"; "\n"; "0"];
1227 ["cat"; "/new"]], "\n")],
1230 This call creates a file called C<path>. The contents of the
1231 file is the string C<content> (which can contain any 8 bit data),
1232 with length C<size>.
1234 As a special case, if C<size> is C<0>
1235 then the length is calculated using C<strlen> (so in this case
1236 the content cannot contain embedded ASCII NULs).
1238 I<NB.> Owing to a bug, writing content containing ASCII NUL
1239 characters does I<not> work, even if the length is specified.
1240 We hope to resolve this bug in a future version. In the meantime
1241 use C<guestfs_upload>.");
1243 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1244 [InitEmpty, Always, TestOutputListOfDevices (
1245 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1246 ["mkfs"; "ext2"; "/dev/sda1"];
1247 ["mount"; "/dev/sda1"; "/"];
1248 ["mounts"]], ["/dev/sda1"]);
1249 InitEmpty, Always, TestOutputList (
1250 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1251 ["mkfs"; "ext2"; "/dev/sda1"];
1252 ["mount"; "/dev/sda1"; "/"];
1255 "unmount a filesystem",
1257 This unmounts the given filesystem. The filesystem may be
1258 specified either by its mountpoint (path) or the device which
1259 contains the filesystem.");
1261 ("mounts", (RStringList "devices", []), 46, [],
1262 [InitBasicFS, Always, TestOutputListOfDevices (
1263 [["mounts"]], ["/dev/sda1"])],
1264 "show mounted filesystems",
1266 This returns the list of currently mounted filesystems. It returns
1267 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1269 Some internal mounts are not shown.");
1271 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1272 [InitBasicFS, Always, TestOutputList (
1275 (* check that umount_all can unmount nested mounts correctly: *)
1276 InitEmpty, Always, TestOutputList (
1277 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1278 ["mkfs"; "ext2"; "/dev/sda1"];
1279 ["mkfs"; "ext2"; "/dev/sda2"];
1280 ["mkfs"; "ext2"; "/dev/sda3"];
1281 ["mount"; "/dev/sda1"; "/"];
1283 ["mount"; "/dev/sda2"; "/mp1"];
1284 ["mkdir"; "/mp1/mp2"];
1285 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1286 ["mkdir"; "/mp1/mp2/mp3"];
1289 "unmount all filesystems",
1291 This unmounts all mounted filesystems.
1293 Some internal mounts are not unmounted by this call.");
1295 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1297 "remove all LVM LVs, VGs and PVs",
1299 This command removes all LVM logical volumes, volume groups
1300 and physical volumes.");
1302 ("file", (RString "description", [String "path"]), 49, [],
1303 [InitBasicFS, Always, TestOutput (
1305 ["file"; "/new"]], "empty");
1306 InitBasicFS, Always, TestOutput (
1307 [["write_file"; "/new"; "some content\n"; "0"];
1308 ["file"; "/new"]], "ASCII text");
1309 InitBasicFS, Always, TestLastFail (
1310 [["file"; "/nofile"]])],
1311 "determine file type",
1313 This call uses the standard L<file(1)> command to determine
1314 the type or contents of the file. This also works on devices,
1315 for example to find out whether a partition contains a filesystem.
1317 The exact command which runs is C<file -bsL path>. Note in
1318 particular that the filename is not prepended to the output
1319 (the C<-b> option).");
1321 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1322 [InitBasicFS, Always, TestOutput (
1323 [["upload"; "test-command"; "/test-command"];
1324 ["chmod"; "493"; "/test-command"];
1325 ["command"; "/test-command 1"]], "Result1");
1326 InitBasicFS, Always, TestOutput (
1327 [["upload"; "test-command"; "/test-command"];
1328 ["chmod"; "493"; "/test-command"];
1329 ["command"; "/test-command 2"]], "Result2\n");
1330 InitBasicFS, Always, TestOutput (
1331 [["upload"; "test-command"; "/test-command"];
1332 ["chmod"; "493"; "/test-command"];
1333 ["command"; "/test-command 3"]], "\nResult3");
1334 InitBasicFS, Always, TestOutput (
1335 [["upload"; "test-command"; "/test-command"];
1336 ["chmod"; "493"; "/test-command"];
1337 ["command"; "/test-command 4"]], "\nResult4\n");
1338 InitBasicFS, Always, TestOutput (
1339 [["upload"; "test-command"; "/test-command"];
1340 ["chmod"; "493"; "/test-command"];
1341 ["command"; "/test-command 5"]], "\nResult5\n\n");
1342 InitBasicFS, Always, TestOutput (
1343 [["upload"; "test-command"; "/test-command"];
1344 ["chmod"; "493"; "/test-command"];
1345 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1346 InitBasicFS, Always, TestOutput (
1347 [["upload"; "test-command"; "/test-command"];
1348 ["chmod"; "493"; "/test-command"];
1349 ["command"; "/test-command 7"]], "");
1350 InitBasicFS, Always, TestOutput (
1351 [["upload"; "test-command"; "/test-command"];
1352 ["chmod"; "493"; "/test-command"];
1353 ["command"; "/test-command 8"]], "\n");
1354 InitBasicFS, Always, TestOutput (
1355 [["upload"; "test-command"; "/test-command"];
1356 ["chmod"; "493"; "/test-command"];
1357 ["command"; "/test-command 9"]], "\n\n");
1358 InitBasicFS, Always, TestOutput (
1359 [["upload"; "test-command"; "/test-command"];
1360 ["chmod"; "493"; "/test-command"];
1361 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1362 InitBasicFS, Always, TestOutput (
1363 [["upload"; "test-command"; "/test-command"];
1364 ["chmod"; "493"; "/test-command"];
1365 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1366 InitBasicFS, Always, TestLastFail (
1367 [["upload"; "test-command"; "/test-command"];
1368 ["chmod"; "493"; "/test-command"];
1369 ["command"; "/test-command"]])],
1370 "run a command from the guest filesystem",
1372 This call runs a command from the guest filesystem. The
1373 filesystem must be mounted, and must contain a compatible
1374 operating system (ie. something Linux, with the same
1375 or compatible processor architecture).
1377 The single parameter is an argv-style list of arguments.
1378 The first element is the name of the program to run.
1379 Subsequent elements are parameters. The list must be
1380 non-empty (ie. must contain a program name).
1382 The return value is anything printed to I<stdout> by
1385 If the command returns a non-zero exit status, then
1386 this function returns an error message. The error message
1387 string is the content of I<stderr> from the command.
1389 The C<$PATH> environment variable will contain at least
1390 C</usr/bin> and C</bin>. If you require a program from
1391 another location, you should provide the full path in the
1394 Shared libraries and data files required by the program
1395 must be available on filesystems which are mounted in the
1396 correct places. It is the caller's responsibility to ensure
1397 all filesystems that are needed are mounted at the right
1400 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1401 [InitBasicFS, Always, TestOutputList (
1402 [["upload"; "test-command"; "/test-command"];
1403 ["chmod"; "493"; "/test-command"];
1404 ["command_lines"; "/test-command 1"]], ["Result1"]);
1405 InitBasicFS, Always, TestOutputList (
1406 [["upload"; "test-command"; "/test-command"];
1407 ["chmod"; "493"; "/test-command"];
1408 ["command_lines"; "/test-command 2"]], ["Result2"]);
1409 InitBasicFS, Always, TestOutputList (
1410 [["upload"; "test-command"; "/test-command"];
1411 ["chmod"; "493"; "/test-command"];
1412 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1413 InitBasicFS, Always, TestOutputList (
1414 [["upload"; "test-command"; "/test-command"];
1415 ["chmod"; "493"; "/test-command"];
1416 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1417 InitBasicFS, Always, TestOutputList (
1418 [["upload"; "test-command"; "/test-command"];
1419 ["chmod"; "493"; "/test-command"];
1420 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1421 InitBasicFS, Always, TestOutputList (
1422 [["upload"; "test-command"; "/test-command"];
1423 ["chmod"; "493"; "/test-command"];
1424 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1425 InitBasicFS, Always, TestOutputList (
1426 [["upload"; "test-command"; "/test-command"];
1427 ["chmod"; "493"; "/test-command"];
1428 ["command_lines"; "/test-command 7"]], []);
1429 InitBasicFS, Always, TestOutputList (
1430 [["upload"; "test-command"; "/test-command"];
1431 ["chmod"; "493"; "/test-command"];
1432 ["command_lines"; "/test-command 8"]], [""]);
1433 InitBasicFS, Always, TestOutputList (
1434 [["upload"; "test-command"; "/test-command"];
1435 ["chmod"; "493"; "/test-command"];
1436 ["command_lines"; "/test-command 9"]], ["";""]);
1437 InitBasicFS, Always, TestOutputList (
1438 [["upload"; "test-command"; "/test-command"];
1439 ["chmod"; "493"; "/test-command"];
1440 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1441 InitBasicFS, Always, TestOutputList (
1442 [["upload"; "test-command"; "/test-command"];
1443 ["chmod"; "493"; "/test-command"];
1444 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1445 "run a command, returning lines",
1447 This is the same as C<guestfs_command>, but splits the
1448 result into a list of lines.");
1450 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1451 [InitBasicFS, Always, TestOutputStruct (
1453 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1454 "get file information",
1456 Returns file information for the given C<path>.
1458 This is the same as the C<stat(2)> system call.");
1460 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1461 [InitBasicFS, Always, TestOutputStruct (
1463 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1464 "get file information for a symbolic link",
1466 Returns file information for the given C<path>.
1468 This is the same as C<guestfs_stat> except that if C<path>
1469 is a symbolic link, then the link is stat-ed, not the file it
1472 This is the same as the C<lstat(2)> system call.");
1474 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1475 [InitBasicFS, Always, TestOutputStruct (
1476 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1477 CompareWithInt ("blocks", 490020);
1478 CompareWithInt ("bsize", 1024)])],
1479 "get file system statistics",
1481 Returns file system statistics for any mounted file system.
1482 C<path> should be a file or directory in the mounted file system
1483 (typically it is the mount point itself, but it doesn't need to be).
1485 This is the same as the C<statvfs(2)> system call.");
1487 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1489 "get ext2/ext3/ext4 superblock details",
1491 This returns the contents of the ext2, ext3 or ext4 filesystem
1492 superblock on C<device>.
1494 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1495 manpage for more details. The list of fields returned isn't
1496 clearly defined, and depends on both the version of C<tune2fs>
1497 that libguestfs was built against, and the filesystem itself.");
1499 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1500 [InitEmpty, Always, TestOutputTrue (
1501 [["blockdev_setro"; "/dev/sda"];
1502 ["blockdev_getro"; "/dev/sda"]])],
1503 "set block device to read-only",
1505 Sets the block device named C<device> to read-only.
1507 This uses the L<blockdev(8)> command.");
1509 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1510 [InitEmpty, Always, TestOutputFalse (
1511 [["blockdev_setrw"; "/dev/sda"];
1512 ["blockdev_getro"; "/dev/sda"]])],
1513 "set block device to read-write",
1515 Sets the block device named C<device> to read-write.
1517 This uses the L<blockdev(8)> command.");
1519 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1520 [InitEmpty, Always, TestOutputTrue (
1521 [["blockdev_setro"; "/dev/sda"];
1522 ["blockdev_getro"; "/dev/sda"]])],
1523 "is block device set to read-only",
1525 Returns a boolean indicating if the block device is read-only
1526 (true if read-only, false if not).
1528 This uses the L<blockdev(8)> command.");
1530 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1531 [InitEmpty, Always, TestOutputInt (
1532 [["blockdev_getss"; "/dev/sda"]], 512)],
1533 "get sectorsize of block device",
1535 This returns the size of sectors on a block device.
1536 Usually 512, but can be larger for modern devices.
1538 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1541 This uses the L<blockdev(8)> command.");
1543 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1544 [InitEmpty, Always, TestOutputInt (
1545 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1546 "get blocksize of block device",
1548 This returns the block size of a device.
1550 (Note this is different from both I<size in blocks> and
1551 I<filesystem block size>).
1553 This uses the L<blockdev(8)> command.");
1555 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1557 "set blocksize of block device",
1559 This sets the block size of a device.
1561 (Note this is different from both I<size in blocks> and
1562 I<filesystem block size>).
1564 This uses the L<blockdev(8)> command.");
1566 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1567 [InitEmpty, Always, TestOutputInt (
1568 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1569 "get total size of device in 512-byte sectors",
1571 This returns the size of the device in units of 512-byte sectors
1572 (even if the sectorsize isn't 512 bytes ... weird).
1574 See also C<guestfs_blockdev_getss> for the real sector size of
1575 the device, and C<guestfs_blockdev_getsize64> for the more
1576 useful I<size in bytes>.
1578 This uses the L<blockdev(8)> command.");
1580 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1581 [InitEmpty, Always, TestOutputInt (
1582 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1583 "get total size of device in bytes",
1585 This returns the size of the device in bytes.
1587 See also C<guestfs_blockdev_getsz>.
1589 This uses the L<blockdev(8)> command.");
1591 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1592 [InitEmpty, Always, TestRun
1593 [["blockdev_flushbufs"; "/dev/sda"]]],
1594 "flush device buffers",
1596 This tells the kernel to flush internal buffers associated
1599 This uses the L<blockdev(8)> command.");
1601 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1602 [InitEmpty, Always, TestRun
1603 [["blockdev_rereadpt"; "/dev/sda"]]],
1604 "reread partition table",
1606 Reread the partition table on C<device>.
1608 This uses the L<blockdev(8)> command.");
1610 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1611 [InitBasicFS, Always, TestOutput (
1612 (* Pick a file from cwd which isn't likely to change. *)
1613 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1614 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1615 "upload a file from the local machine",
1617 Upload local file C<filename> to C<remotefilename> on the
1620 C<filename> can also be a named pipe.
1622 See also C<guestfs_download>.");
1624 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1625 [InitBasicFS, Always, TestOutput (
1626 (* Pick a file from cwd which isn't likely to change. *)
1627 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1628 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1629 ["upload"; "testdownload.tmp"; "/upload"];
1630 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1631 "download a file to the local machine",
1633 Download file C<remotefilename> and save it as C<filename>
1634 on the local machine.
1636 C<filename> can also be a named pipe.
1638 See also C<guestfs_upload>, C<guestfs_cat>.");
1640 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1641 [InitBasicFS, Always, TestOutput (
1642 [["write_file"; "/new"; "test\n"; "0"];
1643 ["checksum"; "crc"; "/new"]], "935282863");
1644 InitBasicFS, Always, TestLastFail (
1645 [["checksum"; "crc"; "/new"]]);
1646 InitBasicFS, Always, TestOutput (
1647 [["write_file"; "/new"; "test\n"; "0"];
1648 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1649 InitBasicFS, Always, TestOutput (
1650 [["write_file"; "/new"; "test\n"; "0"];
1651 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1652 InitBasicFS, Always, TestOutput (
1653 [["write_file"; "/new"; "test\n"; "0"];
1654 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1655 InitBasicFS, Always, TestOutput (
1656 [["write_file"; "/new"; "test\n"; "0"];
1657 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1658 InitBasicFS, Always, TestOutput (
1659 [["write_file"; "/new"; "test\n"; "0"];
1660 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1661 InitBasicFS, Always, TestOutput (
1662 [["write_file"; "/new"; "test\n"; "0"];
1663 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1664 InitBasicFS, Always, TestOutput (
1665 (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1666 * the type explicitly.
1668 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1669 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1670 "compute MD5, SHAx or CRC checksum of file",
1672 This call computes the MD5, SHAx or CRC checksum of the
1675 The type of checksum to compute is given by the C<csumtype>
1676 parameter which must have one of the following values:
1682 Compute the cyclic redundancy check (CRC) specified by POSIX
1683 for the C<cksum> command.
1687 Compute the MD5 hash (using the C<md5sum> program).
1691 Compute the SHA1 hash (using the C<sha1sum> program).
1695 Compute the SHA224 hash (using the C<sha224sum> program).
1699 Compute the SHA256 hash (using the C<sha256sum> program).
1703 Compute the SHA384 hash (using the C<sha384sum> program).
1707 Compute the SHA512 hash (using the C<sha512sum> program).
1711 The checksum is returned as a printable string.");
1713 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1714 [InitBasicFS, Always, TestOutput (
1715 [["tar_in"; "../images/helloworld.tar"; "/"];
1716 ["cat"; "/hello"]], "hello\n")],
1717 "unpack tarfile to directory",
1719 This command uploads and unpacks local file C<tarfile> (an
1720 I<uncompressed> tar file) into C<directory>.
1722 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1724 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1726 "pack directory into tarfile",
1728 This command packs the contents of C<directory> and downloads
1729 it to local file C<tarfile>.
1731 To download a compressed tarball, use C<guestfs_tgz_out>.");
1733 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1734 [InitBasicFS, Always, TestOutput (
1735 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1736 ["cat"; "/hello"]], "hello\n")],
1737 "unpack compressed tarball to directory",
1739 This command uploads and unpacks local file C<tarball> (a
1740 I<gzip compressed> tar file) into C<directory>.
1742 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1744 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1746 "pack directory into compressed tarball",
1748 This command packs the contents of C<directory> and downloads
1749 it to local file C<tarball>.
1751 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1753 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1754 [InitBasicFS, Always, TestLastFail (
1756 ["mount_ro"; "/dev/sda1"; "/"];
1757 ["touch"; "/new"]]);
1758 InitBasicFS, Always, TestOutput (
1759 [["write_file"; "/new"; "data"; "0"];
1761 ["mount_ro"; "/dev/sda1"; "/"];
1762 ["cat"; "/new"]], "data")],
1763 "mount a guest disk, read-only",
1765 This is the same as the C<guestfs_mount> command, but it
1766 mounts the filesystem with the read-only (I<-o ro>) flag.");
1768 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1770 "mount a guest disk with mount options",
1772 This is the same as the C<guestfs_mount> command, but it
1773 allows you to set the mount options as for the
1774 L<mount(8)> I<-o> flag.");
1776 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1778 "mount a guest disk with mount options and vfstype",
1780 This is the same as the C<guestfs_mount> command, but it
1781 allows you to set both the mount options and the vfstype
1782 as for the L<mount(8)> I<-o> and I<-t> flags.");
1784 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1786 "debugging and internals",
1788 The C<guestfs_debug> command exposes some internals of
1789 C<guestfsd> (the guestfs daemon) that runs inside the
1792 There is no comprehensive help for this command. You have
1793 to look at the file C<daemon/debug.c> in the libguestfs source
1794 to find out what you can do.");
1796 ("lvremove", (RErr, [String "device"]), 77, [],
1797 [InitEmpty, Always, TestOutputList (
1798 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1799 ["pvcreate"; "/dev/sda1"];
1800 ["vgcreate"; "VG"; "/dev/sda1"];
1801 ["lvcreate"; "LV1"; "VG"; "50"];
1802 ["lvcreate"; "LV2"; "VG"; "50"];
1803 ["lvremove"; "/dev/VG/LV1"];
1804 ["lvs"]], ["/dev/VG/LV2"]);
1805 InitEmpty, Always, TestOutputList (
1806 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1807 ["pvcreate"; "/dev/sda1"];
1808 ["vgcreate"; "VG"; "/dev/sda1"];
1809 ["lvcreate"; "LV1"; "VG"; "50"];
1810 ["lvcreate"; "LV2"; "VG"; "50"];
1811 ["lvremove"; "/dev/VG"];
1813 InitEmpty, Always, TestOutputList (
1814 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1815 ["pvcreate"; "/dev/sda1"];
1816 ["vgcreate"; "VG"; "/dev/sda1"];
1817 ["lvcreate"; "LV1"; "VG"; "50"];
1818 ["lvcreate"; "LV2"; "VG"; "50"];
1819 ["lvremove"; "/dev/VG"];
1821 "remove an LVM logical volume",
1823 Remove an LVM logical volume C<device>, where C<device> is
1824 the path to the LV, such as C</dev/VG/LV>.
1826 You can also remove all LVs in a volume group by specifying
1827 the VG name, C</dev/VG>.");
1829 ("vgremove", (RErr, [String "vgname"]), 78, [],
1830 [InitEmpty, Always, TestOutputList (
1831 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1832 ["pvcreate"; "/dev/sda1"];
1833 ["vgcreate"; "VG"; "/dev/sda1"];
1834 ["lvcreate"; "LV1"; "VG"; "50"];
1835 ["lvcreate"; "LV2"; "VG"; "50"];
1838 InitEmpty, Always, TestOutputList (
1839 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1840 ["pvcreate"; "/dev/sda1"];
1841 ["vgcreate"; "VG"; "/dev/sda1"];
1842 ["lvcreate"; "LV1"; "VG"; "50"];
1843 ["lvcreate"; "LV2"; "VG"; "50"];
1846 "remove an LVM volume group",
1848 Remove an LVM volume group C<vgname>, (for example C<VG>).
1850 This also forcibly removes all logical volumes in the volume
1853 ("pvremove", (RErr, [String "device"]), 79, [],
1854 [InitEmpty, Always, TestOutputListOfDevices (
1855 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1856 ["pvcreate"; "/dev/sda1"];
1857 ["vgcreate"; "VG"; "/dev/sda1"];
1858 ["lvcreate"; "LV1"; "VG"; "50"];
1859 ["lvcreate"; "LV2"; "VG"; "50"];
1861 ["pvremove"; "/dev/sda1"];
1863 InitEmpty, Always, TestOutputListOfDevices (
1864 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1865 ["pvcreate"; "/dev/sda1"];
1866 ["vgcreate"; "VG"; "/dev/sda1"];
1867 ["lvcreate"; "LV1"; "VG"; "50"];
1868 ["lvcreate"; "LV2"; "VG"; "50"];
1870 ["pvremove"; "/dev/sda1"];
1872 InitEmpty, Always, TestOutputListOfDevices (
1873 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1874 ["pvcreate"; "/dev/sda1"];
1875 ["vgcreate"; "VG"; "/dev/sda1"];
1876 ["lvcreate"; "LV1"; "VG"; "50"];
1877 ["lvcreate"; "LV2"; "VG"; "50"];
1879 ["pvremove"; "/dev/sda1"];
1881 "remove an LVM physical volume",
1883 This wipes a physical volume C<device> so that LVM will no longer
1886 The implementation uses the C<pvremove> command which refuses to
1887 wipe physical volumes that contain any volume groups, so you have
1888 to remove those first.");
1890 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1891 [InitBasicFS, Always, TestOutput (
1892 [["set_e2label"; "/dev/sda1"; "testlabel"];
1893 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1894 "set the ext2/3/4 filesystem label",
1896 This sets the ext2/3/4 filesystem label of the filesystem on
1897 C<device> to C<label>. Filesystem labels are limited to
1900 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1901 to return the existing label on a filesystem.");
1903 ("get_e2label", (RString "label", [String "device"]), 81, [],
1905 "get the ext2/3/4 filesystem label",
1907 This returns the ext2/3/4 filesystem label of the filesystem on
1910 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1911 [InitBasicFS, Always, TestOutput (
1912 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1913 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1914 InitBasicFS, Always, TestOutput (
1915 [["set_e2uuid"; "/dev/sda1"; "clear"];
1916 ["get_e2uuid"; "/dev/sda1"]], "");
1917 (* We can't predict what UUIDs will be, so just check the commands run. *)
1918 InitBasicFS, Always, TestRun (
1919 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1920 InitBasicFS, Always, TestRun (
1921 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1922 "set the ext2/3/4 filesystem UUID",
1924 This sets the ext2/3/4 filesystem UUID of the filesystem on
1925 C<device> to C<uuid>. The format of the UUID and alternatives
1926 such as C<clear>, C<random> and C<time> are described in the
1927 L<tune2fs(8)> manpage.
1929 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1930 to return the existing UUID of a filesystem.");
1932 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1934 "get the ext2/3/4 filesystem UUID",
1936 This returns the ext2/3/4 filesystem UUID of the filesystem on
1939 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1940 [InitBasicFS, Always, TestOutputInt (
1941 [["umount"; "/dev/sda1"];
1942 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1943 InitBasicFS, Always, TestOutputInt (
1944 [["umount"; "/dev/sda1"];
1945 ["zero"; "/dev/sda1"];
1946 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1947 "run the filesystem checker",
1949 This runs the filesystem checker (fsck) on C<device> which
1950 should have filesystem type C<fstype>.
1952 The returned integer is the status. See L<fsck(8)> for the
1953 list of status codes from C<fsck>.
1961 Multiple status codes can be summed together.
1965 A non-zero return code can mean \"success\", for example if
1966 errors have been corrected on the filesystem.
1970 Checking or repairing NTFS volumes is not supported
1975 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1977 ("zero", (RErr, [String "device"]), 85, [],
1978 [InitBasicFS, Always, TestOutput (
1979 [["umount"; "/dev/sda1"];
1980 ["zero"; "/dev/sda1"];
1981 ["file"; "/dev/sda1"]], "data")],
1982 "write zeroes to the device",
1984 This command writes zeroes over the first few blocks of C<device>.
1986 How many blocks are zeroed isn't specified (but it's I<not> enough
1987 to securely wipe the device). It should be sufficient to remove
1988 any partition tables, filesystem superblocks and so on.");
1990 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1991 [InitBasicFS, Always, TestOutputTrue (
1992 [["grub_install"; "/"; "/dev/sda1"];
1993 ["is_dir"; "/boot"]])],
1996 This command installs GRUB (the Grand Unified Bootloader) on
1997 C<device>, with the root directory being C<root>.");
1999 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2000 [InitBasicFS, Always, TestOutput (
2001 [["write_file"; "/old"; "file content"; "0"];
2002 ["cp"; "/old"; "/new"];
2003 ["cat"; "/new"]], "file content");
2004 InitBasicFS, Always, TestOutputTrue (
2005 [["write_file"; "/old"; "file content"; "0"];
2006 ["cp"; "/old"; "/new"];
2007 ["is_file"; "/old"]]);
2008 InitBasicFS, Always, TestOutput (
2009 [["write_file"; "/old"; "file content"; "0"];
2011 ["cp"; "/old"; "/dir/new"];
2012 ["cat"; "/dir/new"]], "file content")],
2015 This copies a file from C<src> to C<dest> where C<dest> is
2016 either a destination filename or destination directory.");
2018 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2019 [InitBasicFS, Always, TestOutput (
2020 [["mkdir"; "/olddir"];
2021 ["mkdir"; "/newdir"];
2022 ["write_file"; "/olddir/file"; "file content"; "0"];
2023 ["cp_a"; "/olddir"; "/newdir"];
2024 ["cat"; "/newdir/olddir/file"]], "file content")],
2025 "copy a file or directory recursively",
2027 This copies a file or directory from C<src> to C<dest>
2028 recursively using the C<cp -a> command.");
2030 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2031 [InitBasicFS, Always, TestOutput (
2032 [["write_file"; "/old"; "file content"; "0"];
2033 ["mv"; "/old"; "/new"];
2034 ["cat"; "/new"]], "file content");
2035 InitBasicFS, Always, TestOutputFalse (
2036 [["write_file"; "/old"; "file content"; "0"];
2037 ["mv"; "/old"; "/new"];
2038 ["is_file"; "/old"]])],
2041 This moves a file from C<src> to C<dest> where C<dest> is
2042 either a destination filename or destination directory.");
2044 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2045 [InitEmpty, Always, TestRun (
2046 [["drop_caches"; "3"]])],
2047 "drop kernel page cache, dentries and inodes",
2049 This instructs the guest kernel to drop its page cache,
2050 and/or dentries and inode caches. The parameter C<whattodrop>
2051 tells the kernel what precisely to drop, see
2052 L<http://linux-mm.org/Drop_Caches>
2054 Setting C<whattodrop> to 3 should drop everything.
2056 This automatically calls L<sync(2)> before the operation,
2057 so that the maximum guest memory is freed.");
2059 ("dmesg", (RString "kmsgs", []), 91, [],
2060 [InitEmpty, Always, TestRun (
2062 "return kernel messages",
2064 This returns the kernel messages (C<dmesg> output) from
2065 the guest kernel. This is sometimes useful for extended
2066 debugging of problems.
2068 Another way to get the same information is to enable
2069 verbose messages with C<guestfs_set_verbose> or by setting
2070 the environment variable C<LIBGUESTFS_DEBUG=1> before
2071 running the program.");
2073 ("ping_daemon", (RErr, []), 92, [],
2074 [InitEmpty, Always, TestRun (
2075 [["ping_daemon"]])],
2076 "ping the guest daemon",
2078 This is a test probe into the guestfs daemon running inside
2079 the qemu subprocess. Calling this function checks that the
2080 daemon responds to the ping message, without affecting the daemon
2081 or attached block device(s) in any other way.");
2083 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2084 [InitBasicFS, Always, TestOutputTrue (
2085 [["write_file"; "/file1"; "contents of a file"; "0"];
2086 ["cp"; "/file1"; "/file2"];
2087 ["equal"; "/file1"; "/file2"]]);
2088 InitBasicFS, Always, TestOutputFalse (
2089 [["write_file"; "/file1"; "contents of a file"; "0"];
2090 ["write_file"; "/file2"; "contents of another file"; "0"];
2091 ["equal"; "/file1"; "/file2"]]);
2092 InitBasicFS, Always, TestLastFail (
2093 [["equal"; "/file1"; "/file2"]])],
2094 "test if two files have equal contents",
2096 This compares the two files C<file1> and C<file2> and returns
2097 true if their content is exactly equal, or false otherwise.
2099 The external L<cmp(1)> program is used for the comparison.");
2101 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2102 [InitBasicFS, Always, TestOutputList (
2103 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2104 ["strings"; "/new"]], ["hello"; "world"]);
2105 InitBasicFS, Always, TestOutputList (
2107 ["strings"; "/new"]], [])],
2108 "print the printable strings in a file",
2110 This runs the L<strings(1)> command on a file and returns
2111 the list of printable strings found.");
2113 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2114 [InitBasicFS, Always, TestOutputList (
2115 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2116 ["strings_e"; "b"; "/new"]], []);
2117 InitBasicFS, Disabled, TestOutputList (
2118 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2119 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2120 "print the printable strings in a file",
2122 This is like the C<guestfs_strings> command, but allows you to
2123 specify the encoding.
2125 See the L<strings(1)> manpage for the full list of encodings.
2127 Commonly useful encodings are C<l> (lower case L) which will
2128 show strings inside Windows/x86 files.
2130 The returned strings are transcoded to UTF-8.");
2132 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2133 [InitBasicFS, Always, TestOutput (
2134 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2135 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n")],
2136 "dump a file in hexadecimal",
2138 This runs C<hexdump -C> on the given C<path>. The result is
2139 the human-readable, canonical hex dump of the file.");
2141 ("zerofree", (RErr, [String "device"]), 97, [],
2142 [InitNone, Always, TestOutput (
2143 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2144 ["mkfs"; "ext3"; "/dev/sda1"];
2145 ["mount"; "/dev/sda1"; "/"];
2146 ["write_file"; "/new"; "test file"; "0"];
2147 ["umount"; "/dev/sda1"];
2148 ["zerofree"; "/dev/sda1"];
2149 ["mount"; "/dev/sda1"; "/"];
2150 ["cat"; "/new"]], "test file")],
2151 "zero unused inodes and disk blocks on ext2/3 filesystem",
2153 This runs the I<zerofree> program on C<device>. This program
2154 claims to zero unused inodes and disk blocks on an ext2/3
2155 filesystem, thus making it possible to compress the filesystem
2158 You should B<not> run this program if the filesystem is
2161 It is possible that using this program can damage the filesystem
2162 or data on the filesystem.");
2164 ("pvresize", (RErr, [String "device"]), 98, [],
2166 "resize an LVM physical volume",
2168 This resizes (expands or shrinks) an existing LVM physical
2169 volume to match the new size of the underlying device.");
2171 ("sfdisk_N", (RErr, [String "device"; Int "n";
2172 Int "cyls"; Int "heads"; Int "sectors";
2173 String "line"]), 99, [DangerWillRobinson],
2175 "modify a single partition on a block device",
2177 This runs L<sfdisk(8)> option to modify just the single
2178 partition C<n> (note: C<n> counts from 1).
2180 For other parameters, see C<guestfs_sfdisk>. You should usually
2181 pass C<0> for the cyls/heads/sectors parameters.");
2183 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2185 "display the partition table",
2187 This displays the partition table on C<device>, in the
2188 human-readable output of the L<sfdisk(8)> command. It is
2189 not intended to be parsed.");
2191 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2193 "display the kernel geometry",
2195 This displays the kernel's idea of the geometry of C<device>.
2197 The result is in human-readable format, and not designed to
2200 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2202 "display the disk geometry from the partition table",
2204 This displays the disk geometry of C<device> read from the
2205 partition table. Especially in the case where the underlying
2206 block device has been resized, this can be different from the
2207 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2209 The result is in human-readable format, and not designed to
2212 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2214 "activate or deactivate all volume groups",
2216 This command activates or (if C<activate> is false) deactivates
2217 all logical volumes in all volume groups.
2218 If activated, then they are made known to the
2219 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2220 then those devices disappear.
2222 This command is the same as running C<vgchange -a y|n>");
2224 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2226 "activate or deactivate some volume groups",
2228 This command activates or (if C<activate> is false) deactivates
2229 all logical volumes in the listed volume groups C<volgroups>.
2230 If activated, then they are made known to the
2231 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2232 then those devices disappear.
2234 This command is the same as running C<vgchange -a y|n volgroups...>
2236 Note that if C<volgroups> is an empty list then B<all> volume groups
2237 are activated or deactivated.");
2239 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2240 [InitNone, Always, TestOutput (
2241 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2242 ["pvcreate"; "/dev/sda1"];
2243 ["vgcreate"; "VG"; "/dev/sda1"];
2244 ["lvcreate"; "LV"; "VG"; "10"];
2245 ["mkfs"; "ext2"; "/dev/VG/LV"];
2246 ["mount"; "/dev/VG/LV"; "/"];
2247 ["write_file"; "/new"; "test content"; "0"];
2249 ["lvresize"; "/dev/VG/LV"; "20"];
2250 ["e2fsck_f"; "/dev/VG/LV"];
2251 ["resize2fs"; "/dev/VG/LV"];
2252 ["mount"; "/dev/VG/LV"; "/"];
2253 ["cat"; "/new"]], "test content")],
2254 "resize an LVM logical volume",
2256 This resizes (expands or shrinks) an existing LVM logical
2257 volume to C<mbytes>. When reducing, data in the reduced part
2260 ("resize2fs", (RErr, [String "device"]), 106, [],
2261 [], (* lvresize tests this *)
2262 "resize an ext2/ext3 filesystem",
2264 This resizes an ext2 or ext3 filesystem to match the size of
2265 the underlying device.
2267 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2268 on the C<device> before calling this command. For unknown reasons
2269 C<resize2fs> sometimes gives an error about this and sometimes not.
2270 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2271 calling this function.");
2273 ("find", (RStringList "names", [String "directory"]), 107, [],
2274 [InitBasicFS, Always, TestOutputList (
2275 [["find"; "/"]], ["lost+found"]);
2276 InitBasicFS, Always, TestOutputList (
2280 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2281 InitBasicFS, Always, TestOutputList (
2282 [["mkdir_p"; "/a/b/c"];
2283 ["touch"; "/a/b/c/d"];
2284 ["find"; "/a/b/"]], ["c"; "c/d"])],
2285 "find all files and directories",
2287 This command lists out all files and directories, recursively,
2288 starting at C<directory>. It is essentially equivalent to
2289 running the shell command C<find directory -print> but some
2290 post-processing happens on the output, described below.
2292 This returns a list of strings I<without any prefix>. Thus
2293 if the directory structure was:
2299 then the returned list from C<guestfs_find> C</tmp> would be
2307 If C<directory> is not a directory, then this command returns
2310 The returned list is sorted.");
2312 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2313 [], (* lvresize tests this *)
2314 "check an ext2/ext3 filesystem",
2316 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2317 filesystem checker on C<device>, noninteractively (C<-p>),
2318 even if the filesystem appears to be clean (C<-f>).
2320 This command is only needed because of C<guestfs_resize2fs>
2321 (q.v.). Normally you should use C<guestfs_fsck>.");
2323 ("sleep", (RErr, [Int "secs"]), 109, [],
2324 [InitNone, Always, TestRun (
2326 "sleep for some seconds",
2328 Sleep for C<secs> seconds.");
2330 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2331 [InitNone, Always, TestOutputInt (
2332 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2333 ["mkfs"; "ntfs"; "/dev/sda1"];
2334 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2335 InitNone, Always, TestOutputInt (
2336 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2337 ["mkfs"; "ext2"; "/dev/sda1"];
2338 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2339 "probe NTFS volume",
2341 This command runs the L<ntfs-3g.probe(8)> command which probes
2342 an NTFS C<device> for mountability. (Not all NTFS volumes can
2343 be mounted read-write, and some cannot be mounted at all).
2345 C<rw> is a boolean flag. Set it to true if you want to test
2346 if the volume can be mounted read-write. Set it to false if
2347 you want to test if the volume can be mounted read-only.
2349 The return value is an integer which C<0> if the operation
2350 would succeed, or some non-zero value documented in the
2351 L<ntfs-3g.probe(8)> manual page.");
2355 let all_functions = non_daemon_functions @ daemon_functions
2357 (* In some places we want the functions to be displayed sorted
2358 * alphabetically, so this is useful:
2360 let all_functions_sorted =
2361 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2362 compare n1 n2) all_functions
2364 (* Column names and types from LVM PVs/VGs/LVs. *)
2373 "pv_attr", `String (* XXX *);
2374 "pv_pe_count", `Int;
2375 "pv_pe_alloc_count", `Int;
2378 "pv_mda_count", `Int;
2379 "pv_mda_free", `Bytes;
2380 (* Not in Fedora 10:
2381 "pv_mda_size", `Bytes;
2388 "vg_attr", `String (* XXX *);
2391 "vg_sysid", `String;
2392 "vg_extent_size", `Bytes;
2393 "vg_extent_count", `Int;
2394 "vg_free_count", `Int;
2402 "vg_mda_count", `Int;
2403 "vg_mda_free", `Bytes;
2404 (* Not in Fedora 10:
2405 "vg_mda_size", `Bytes;
2411 "lv_attr", `String (* XXX *);
2414 "lv_kernel_major", `Int;
2415 "lv_kernel_minor", `Int;
2419 "snap_percent", `OptPercent;
2420 "copy_percent", `OptPercent;
2423 "mirror_log", `String;
2427 (* Column names and types from stat structures.
2428 * NB. Can't use things like 'st_atime' because glibc header files
2429 * define some of these as macros. Ugh.
2446 let statvfs_cols = [
2460 (* Used for testing language bindings. *)
2462 | CallString of string
2463 | CallOptString of string option
2464 | CallStringList of string list
2468 (* Useful functions.
2469 * Note we don't want to use any external OCaml libraries which
2470 * makes this a bit harder than it should be.
2472 let failwithf fs = ksprintf failwith fs
2474 let replace_char s c1 c2 =
2475 let s2 = String.copy s in
2476 let r = ref false in
2477 for i = 0 to String.length s2 - 1 do
2478 if String.unsafe_get s2 i = c1 then (
2479 String.unsafe_set s2 i c2;
2483 if not !r then s else s2
2487 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2489 let triml ?(test = isspace) str =
2491 let n = ref (String.length str) in
2492 while !n > 0 && test str.[!i]; do
2497 else String.sub str !i !n
2499 let trimr ?(test = isspace) str =
2500 let n = ref (String.length str) in
2501 while !n > 0 && test str.[!n-1]; do
2504 if !n = String.length str then str
2505 else String.sub str 0 !n
2507 let trim ?(test = isspace) str =
2508 trimr ~test (triml ~test str)
2510 let rec find s sub =
2511 let len = String.length s in
2512 let sublen = String.length sub in
2514 if i <= len-sublen then (
2516 if j < sublen then (
2517 if s.[i+j] = sub.[j] then loop2 (j+1)
2523 if r = -1 then loop (i+1) else r
2529 let rec replace_str s s1 s2 =
2530 let len = String.length s in
2531 let sublen = String.length s1 in
2532 let i = find s s1 in
2535 let s' = String.sub s 0 i in
2536 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2537 s' ^ s2 ^ replace_str s'' s1 s2
2540 let rec string_split sep str =
2541 let len = String.length str in
2542 let seplen = String.length sep in
2543 let i = find str sep in
2544 if i = -1 then [str]
2546 let s' = String.sub str 0 i in
2547 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2548 s' :: string_split sep s''
2551 let files_equal n1 n2 =
2552 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2553 match Sys.command cmd with
2556 | i -> failwithf "%s: failed with error code %d" cmd i
2558 let rec find_map f = function
2559 | [] -> raise Not_found
2563 | None -> find_map f xs
2566 let rec loop i = function
2568 | x :: xs -> f i x; loop (i+1) xs
2573 let rec loop i = function
2575 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2579 let name_of_argt = function
2580 | String n | OptString n | StringList n | Bool n | Int n
2581 | FileIn n | FileOut n -> n
2583 let seq_of_test = function
2584 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2585 | TestOutputListOfDevices (s, _)
2586 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2587 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2588 | TestLastFail s -> s
2590 (* Check function names etc. for consistency. *)
2591 let check_functions () =
2592 let contains_uppercase str =
2593 let len = String.length str in
2595 if i >= len then false
2598 if c >= 'A' && c <= 'Z' then true
2605 (* Check function names. *)
2607 fun (name, _, _, _, _, _, _) ->
2608 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2609 failwithf "function name %s does not need 'guestfs' prefix" name;
2611 failwithf "function name is empty";
2612 if name.[0] < 'a' || name.[0] > 'z' then
2613 failwithf "function name %s must start with lowercase a-z" name;
2614 if String.contains name '-' then
2615 failwithf "function name %s should not contain '-', use '_' instead."
2619 (* Check function parameter/return names. *)
2621 fun (name, style, _, _, _, _, _) ->
2622 let check_arg_ret_name n =
2623 if contains_uppercase n then
2624 failwithf "%s param/ret %s should not contain uppercase chars"
2626 if String.contains n '-' || String.contains n '_' then
2627 failwithf "%s param/ret %s should not contain '-' or '_'"
2630 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;
2631 if n = "int" || n = "char" || n = "short" || n = "long" then
2632 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
2634 failwithf "%s has a param/ret called 'i', which will cause some conflicts in the generated code" name;
2635 if n = "argv" || n = "args" then
2636 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
2639 (match fst style with
2641 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2642 | RStringList n | RPVList n | RVGList n | RLVList n
2643 | RStat n | RStatVFS n
2645 check_arg_ret_name n
2647 check_arg_ret_name n;
2648 check_arg_ret_name m
2650 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2653 (* Check short descriptions. *)
2655 fun (name, _, _, _, _, shortdesc, _) ->
2656 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2657 failwithf "short description of %s should begin with lowercase." name;
2658 let c = shortdesc.[String.length shortdesc-1] in
2659 if c = '\n' || c = '.' then
2660 failwithf "short description of %s should not end with . or \\n." name
2663 (* Check long dscriptions. *)
2665 fun (name, _, _, _, _, _, longdesc) ->
2666 if longdesc.[String.length longdesc-1] = '\n' then
2667 failwithf "long description of %s should not end with \\n." name
2670 (* Check proc_nrs. *)
2672 fun (name, _, proc_nr, _, _, _, _) ->
2673 if proc_nr <= 0 then
2674 failwithf "daemon function %s should have proc_nr > 0" name
2678 fun (name, _, proc_nr, _, _, _, _) ->
2679 if proc_nr <> -1 then
2680 failwithf "non-daemon function %s should have proc_nr -1" name
2681 ) non_daemon_functions;
2684 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2687 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2688 let rec loop = function
2691 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2693 | (name1,nr1) :: (name2,nr2) :: _ ->
2694 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2702 (* Ignore functions that have no tests. We generate a
2703 * warning when the user does 'make check' instead.
2705 | name, _, _, _, [], _, _ -> ()
2706 | name, _, _, _, tests, _, _ ->
2710 match seq_of_test test with
2712 failwithf "%s has a test containing an empty sequence" name
2713 | cmds -> List.map List.hd cmds
2715 let funcs = List.flatten funcs in
2717 let tested = List.mem name funcs in
2720 failwithf "function %s has tests but does not test itself" name
2723 (* 'pr' prints to the current output file. *)
2724 let chan = ref stdout
2725 let pr fs = ksprintf (output_string !chan) fs
2727 (* Generate a header block in a number of standard styles. *)
2728 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2729 type license = GPLv2 | LGPLv2
2731 let generate_header comment license =
2732 let c = match comment with
2733 | CStyle -> pr "/* "; " *"
2734 | HashStyle -> pr "# "; "#"
2735 | OCamlStyle -> pr "(* "; " *"
2736 | HaskellStyle -> pr "{- "; " " in
2737 pr "libguestfs generated file\n";
2738 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2739 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2741 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2745 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2746 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2747 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2748 pr "%s (at your option) any later version.\n" c;
2750 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2751 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2752 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2753 pr "%s GNU General Public License for more details.\n" c;
2755 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2756 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2757 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2760 pr "%s This library is free software; you can redistribute it and/or\n" c;
2761 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2762 pr "%s License as published by the Free Software Foundation; either\n" c;
2763 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2765 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2766 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2767 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2768 pr "%s Lesser General Public License for more details.\n" c;
2770 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2771 pr "%s License along with this library; if not, write to the Free Software\n" c;
2772 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2775 | CStyle -> pr " */\n"
2777 | OCamlStyle -> pr " *)\n"
2778 | HaskellStyle -> pr "-}\n"
2782 (* Start of main code generation functions below this line. *)
2784 (* Generate the pod documentation for the C API. *)
2785 let rec generate_actions_pod () =
2787 fun (shortname, style, _, flags, _, _, longdesc) ->
2788 if not (List.mem NotInDocs flags) then (
2789 let name = "guestfs_" ^ shortname in
2790 pr "=head2 %s\n\n" name;
2792 generate_prototype ~extern:false ~handle:"handle" name style;
2794 pr "%s\n\n" longdesc;
2795 (match fst style with
2797 pr "This function returns 0 on success or -1 on error.\n\n"
2799 pr "On error this function returns -1.\n\n"
2801 pr "On error this function returns -1.\n\n"
2803 pr "This function returns a C truth value on success or -1 on error.\n\n"
2805 pr "This function returns a string, or NULL on error.
2806 The string is owned by the guest handle and must I<not> be freed.\n\n"
2808 pr "This function returns a string, or NULL on error.
2809 I<The caller must free the returned string after use>.\n\n"
2811 pr "This function returns a NULL-terminated array of strings
2812 (like L<environ(3)>), or NULL if there was an error.
2813 I<The caller must free the strings and the array after use>.\n\n"
2815 pr "This function returns a C<struct guestfs_int_bool *>,
2816 or NULL if there was an error.
2817 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2819 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2820 (see E<lt>guestfs-structs.hE<gt>),
2821 or NULL if there was an error.
2822 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2824 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2825 (see E<lt>guestfs-structs.hE<gt>),
2826 or NULL if there was an error.
2827 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2829 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2830 (see E<lt>guestfs-structs.hE<gt>),
2831 or NULL if there was an error.
2832 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2834 pr "This function returns a C<struct guestfs_stat *>
2835 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2836 or NULL if there was an error.
2837 I<The caller must call C<free> after use>.\n\n"
2839 pr "This function returns a C<struct guestfs_statvfs *>
2840 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2841 or NULL if there was an error.
2842 I<The caller must call C<free> after use>.\n\n"
2844 pr "This function returns a NULL-terminated array of
2845 strings, or NULL if there was an error.
2846 The array of strings will always have length C<2n+1>, where
2847 C<n> keys and values alternate, followed by the trailing NULL entry.
2848 I<The caller must free the strings and the array after use>.\n\n"
2850 if List.mem ProtocolLimitWarning flags then
2851 pr "%s\n\n" protocol_limit_warning;
2852 if List.mem DangerWillRobinson flags then
2853 pr "%s\n\n" danger_will_robinson
2855 ) all_functions_sorted
2857 and generate_structs_pod () =
2858 (* LVM structs documentation. *)
2861 pr "=head2 guestfs_lvm_%s\n" typ;
2863 pr " struct guestfs_lvm_%s {\n" typ;
2866 | name, `String -> pr " char *%s;\n" name
2868 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2869 pr " char %s[32];\n" name
2870 | name, `Bytes -> pr " uint64_t %s;\n" name
2871 | name, `Int -> pr " int64_t %s;\n" name
2872 | name, `OptPercent ->
2873 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2874 pr " float %s;\n" name
2877 pr " struct guestfs_lvm_%s_list {\n" typ;
2878 pr " uint32_t len; /* Number of elements in list. */\n";
2879 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2882 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2885 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2887 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2888 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2890 * We have to use an underscore instead of a dash because otherwise
2891 * rpcgen generates incorrect code.
2893 * This header is NOT exported to clients, but see also generate_structs_h.
2895 and generate_xdr () =
2896 generate_header CStyle LGPLv2;
2898 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2899 pr "typedef string str<>;\n";
2902 (* LVM internal structures. *)
2906 pr "struct guestfs_lvm_int_%s {\n" typ;
2908 | name, `String -> pr " string %s<>;\n" name
2909 | name, `UUID -> pr " opaque %s[32];\n" name
2910 | name, `Bytes -> pr " hyper %s;\n" name
2911 | name, `Int -> pr " hyper %s;\n" name
2912 | name, `OptPercent -> pr " float %s;\n" name
2916 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2918 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2920 (* Stat internal structures. *)
2924 pr "struct guestfs_int_%s {\n" typ;
2926 | name, `Int -> pr " hyper %s;\n" name
2930 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2933 fun (shortname, style, _, _, _, _, _) ->
2934 let name = "guestfs_" ^ shortname in
2936 (match snd style with
2939 pr "struct %s_args {\n" name;
2942 | String n -> pr " string %s<>;\n" n
2943 | OptString n -> pr " str *%s;\n" n
2944 | StringList n -> pr " str %s<>;\n" n
2945 | Bool n -> pr " bool %s;\n" n
2946 | Int n -> pr " int %s;\n" n
2947 | FileIn _ | FileOut _ -> ()
2951 (match fst style with
2954 pr "struct %s_ret {\n" name;
2958 pr "struct %s_ret {\n" name;
2959 pr " hyper %s;\n" n;
2962 pr "struct %s_ret {\n" name;
2966 failwithf "RConstString cannot be returned from a daemon function"
2968 pr "struct %s_ret {\n" name;
2969 pr " string %s<>;\n" n;
2972 pr "struct %s_ret {\n" name;
2973 pr " str %s<>;\n" n;
2976 pr "struct %s_ret {\n" name;
2981 pr "struct %s_ret {\n" name;
2982 pr " guestfs_lvm_int_pv_list %s;\n" n;
2985 pr "struct %s_ret {\n" name;
2986 pr " guestfs_lvm_int_vg_list %s;\n" n;
2989 pr "struct %s_ret {\n" name;
2990 pr " guestfs_lvm_int_lv_list %s;\n" n;
2993 pr "struct %s_ret {\n" name;
2994 pr " guestfs_int_stat %s;\n" n;
2997 pr "struct %s_ret {\n" name;
2998 pr " guestfs_int_statvfs %s;\n" n;
3001 pr "struct %s_ret {\n" name;
3002 pr " str %s<>;\n" n;
3007 (* Table of procedure numbers. *)
3008 pr "enum guestfs_procedure {\n";
3010 fun (shortname, _, proc_nr, _, _, _, _) ->
3011 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3013 pr " GUESTFS_PROC_NR_PROCS\n";
3017 (* Having to choose a maximum message size is annoying for several
3018 * reasons (it limits what we can do in the API), but it (a) makes
3019 * the protocol a lot simpler, and (b) provides a bound on the size
3020 * of the daemon which operates in limited memory space. For large
3021 * file transfers you should use FTP.
3023 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3026 (* Message header, etc. *)
3028 /* The communication protocol is now documented in the guestfs(3)
3032 const GUESTFS_PROGRAM = 0x2000F5F5;
3033 const GUESTFS_PROTOCOL_VERSION = 1;
3035 /* These constants must be larger than any possible message length. */
3036 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3037 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3039 enum guestfs_message_direction {
3040 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3041 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3044 enum guestfs_message_status {
3045 GUESTFS_STATUS_OK = 0,
3046 GUESTFS_STATUS_ERROR = 1
3049 const GUESTFS_ERROR_LEN = 256;
3051 struct guestfs_message_error {
3052 string error_message<GUESTFS_ERROR_LEN>;
3055 struct guestfs_message_header {
3056 unsigned prog; /* GUESTFS_PROGRAM */
3057 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3058 guestfs_procedure proc; /* GUESTFS_PROC_x */
3059 guestfs_message_direction direction;
3060 unsigned serial; /* message serial number */
3061 guestfs_message_status status;
3064 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3066 struct guestfs_chunk {
3067 int cancel; /* if non-zero, transfer is cancelled */
3068 /* data size is 0 bytes if the transfer has finished successfully */
3069 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3073 (* Generate the guestfs-structs.h file. *)
3074 and generate_structs_h () =
3075 generate_header CStyle LGPLv2;
3077 (* This is a public exported header file containing various
3078 * structures. The structures are carefully written to have
3079 * exactly the same in-memory format as the XDR structures that
3080 * we use on the wire to the daemon. The reason for creating
3081 * copies of these structures here is just so we don't have to
3082 * export the whole of guestfs_protocol.h (which includes much
3083 * unrelated and XDR-dependent stuff that we don't want to be
3084 * public, or required by clients).
3086 * To reiterate, we will pass these structures to and from the
3087 * client with a simple assignment or memcpy, so the format
3088 * must be identical to what rpcgen / the RFC defines.
3091 (* guestfs_int_bool structure. *)
3092 pr "struct guestfs_int_bool {\n";
3098 (* LVM public structures. *)
3102 pr "struct guestfs_lvm_%s {\n" typ;
3105 | name, `String -> pr " char *%s;\n" name
3106 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3107 | name, `Bytes -> pr " uint64_t %s;\n" name
3108 | name, `Int -> pr " int64_t %s;\n" name
3109 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3113 pr "struct guestfs_lvm_%s_list {\n" typ;
3114 pr " uint32_t len;\n";
3115 pr " struct guestfs_lvm_%s *val;\n" typ;
3118 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3120 (* Stat structures. *)
3124 pr "struct guestfs_%s {\n" typ;
3127 | name, `Int -> pr " int64_t %s;\n" name
3131 ) ["stat", stat_cols; "statvfs", statvfs_cols]
3133 (* Generate the guestfs-actions.h file. *)
3134 and generate_actions_h () =
3135 generate_header CStyle LGPLv2;
3137 fun (shortname, style, _, _, _, _, _) ->
3138 let name = "guestfs_" ^ shortname in
3139 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3143 (* Generate the client-side dispatch stubs. *)
3144 and generate_client_actions () =
3145 generate_header CStyle LGPLv2;
3151 #include \"guestfs.h\"
3152 #include \"guestfs_protocol.h\"
3154 #define error guestfs_error
3155 #define perrorf guestfs_perrorf
3156 #define safe_malloc guestfs_safe_malloc
3157 #define safe_realloc guestfs_safe_realloc
3158 #define safe_strdup guestfs_safe_strdup
3159 #define safe_memdup guestfs_safe_memdup
3161 /* Check the return message from a call for validity. */
3163 check_reply_header (guestfs_h *g,
3164 const struct guestfs_message_header *hdr,
3165 int proc_nr, int serial)
3167 if (hdr->prog != GUESTFS_PROGRAM) {
3168 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3171 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3172 error (g, \"wrong protocol version (%%d/%%d)\",
3173 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3176 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3177 error (g, \"unexpected message direction (%%d/%%d)\",
3178 hdr->direction, GUESTFS_DIRECTION_REPLY);
3181 if (hdr->proc != proc_nr) {
3182 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3185 if (hdr->serial != serial) {
3186 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3193 /* Check we are in the right state to run a high-level action. */
3195 check_state (guestfs_h *g, const char *caller)
3197 if (!guestfs_is_ready (g)) {
3198 if (guestfs_is_config (g))
3199 error (g, \"%%s: call launch() before using this function\",
3201 else if (guestfs_is_launching (g))
3202 error (g, \"%%s: call wait_ready() before using this function\",
3205 error (g, \"%%s called from the wrong state, %%d != READY\",
3206 caller, guestfs_get_state (g));
3214 (* Client-side stubs for each function. *)
3216 fun (shortname, style, _, _, _, _, _) ->
3217 let name = "guestfs_" ^ shortname in
3219 (* Generate the context struct which stores the high-level
3220 * state between callback functions.
3222 pr "struct %s_ctx {\n" shortname;
3223 pr " /* This flag is set by the callbacks, so we know we've done\n";
3224 pr " * the callbacks as expected, and in the right sequence.\n";
3225 pr " * 0 = not called, 1 = reply_cb called.\n";
3227 pr " int cb_sequence;\n";
3228 pr " struct guestfs_message_header hdr;\n";
3229 pr " struct guestfs_message_error err;\n";
3230 (match fst style with
3233 failwithf "RConstString cannot be returned from a daemon function"
3235 | RBool _ | RString _ | RStringList _
3237 | RPVList _ | RVGList _ | RLVList _
3238 | RStat _ | RStatVFS _
3240 pr " struct %s_ret ret;\n" name
3245 (* Generate the reply callback function. *)
3246 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3248 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3249 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3251 pr " /* This should definitely not happen. */\n";
3252 pr " if (ctx->cb_sequence != 0) {\n";
3253 pr " ctx->cb_sequence = 9999;\n";
3254 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3258 pr " ml->main_loop_quit (ml, g);\n";
3260 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3261 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3264 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3265 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3266 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3273 (match fst style with
3276 failwithf "RConstString cannot be returned from a daemon function"
3278 | RBool _ | RString _ | RStringList _
3280 | RPVList _ | RVGList _ | RLVList _
3281 | RStat _ | RStatVFS _
3283 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3284 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3290 pr " ctx->cb_sequence = 1;\n";
3293 (* Generate the action stub. *)
3294 generate_prototype ~extern:false ~semicolon:false ~newline:true
3295 ~handle:"g" name style;
3298 match fst style with
3299 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3301 failwithf "RConstString cannot be returned from a daemon function"
3302 | RString _ | RStringList _ | RIntBool _
3303 | RPVList _ | RVGList _ | RLVList _
3304 | RStat _ | RStatVFS _
3310 (match snd style with
3312 | _ -> pr " struct %s_args args;\n" name
3315 pr " struct %s_ctx ctx;\n" shortname;
3316 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3317 pr " int serial;\n";
3319 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3320 pr " guestfs_set_busy (g);\n";
3322 pr " memset (&ctx, 0, sizeof ctx);\n";
3325 (* Send the main header and arguments. *)
3326 (match snd style with
3328 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3329 (String.uppercase shortname)
3334 pr " args.%s = (char *) %s;\n" n n
3336 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3338 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3339 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3341 pr " args.%s = %s;\n" n n
3343 pr " args.%s = %s;\n" n n
3344 | FileIn _ | FileOut _ -> ()
3346 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3347 (String.uppercase shortname);
3348 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3351 pr " if (serial == -1) {\n";
3352 pr " guestfs_end_busy (g);\n";
3353 pr " return %s;\n" error_code;
3357 (* Send any additional files (FileIn) requested. *)
3358 let need_read_reply_label = ref false in
3365 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3366 pr " if (r == -1) {\n";
3367 pr " guestfs_end_busy (g);\n";
3368 pr " return %s;\n" error_code;
3370 pr " if (r == -2) /* daemon cancelled */\n";
3371 pr " goto read_reply;\n";
3372 need_read_reply_label := true;
3378 (* Wait for the reply from the remote end. *)
3379 if !need_read_reply_label then pr " read_reply:\n";
3380 pr " guestfs__switch_to_receiving (g);\n";
3381 pr " ctx.cb_sequence = 0;\n";
3382 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3383 pr " (void) ml->main_loop_run (ml, g);\n";
3384 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3385 pr " if (ctx.cb_sequence != 1) {\n";
3386 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3387 pr " guestfs_end_busy (g);\n";
3388 pr " return %s;\n" error_code;
3392 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3393 (String.uppercase shortname);
3394 pr " guestfs_end_busy (g);\n";
3395 pr " return %s;\n" error_code;
3399 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3400 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3401 pr " free (ctx.err.error_message);\n";
3402 pr " guestfs_end_busy (g);\n";
3403 pr " return %s;\n" error_code;
3407 (* Expecting to receive further files (FileOut)? *)
3411 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3412 pr " guestfs_end_busy (g);\n";
3413 pr " return %s;\n" error_code;
3419 pr " guestfs_end_busy (g);\n";
3421 (match fst style with
3422 | RErr -> pr " return 0;\n"
3423 | RInt n | RInt64 n | RBool n ->
3424 pr " return ctx.ret.%s;\n" n
3426 failwithf "RConstString cannot be returned from a daemon function"
3428 pr " return ctx.ret.%s; /* caller will free */\n" n
3429 | RStringList n | RHashtable n ->
3430 pr " /* caller will free this, but we need to add a NULL entry */\n";
3431 pr " ctx.ret.%s.%s_val =\n" n n;
3432 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3433 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3435 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3436 pr " return ctx.ret.%s.%s_val;\n" n n
3438 pr " /* caller with free this */\n";
3439 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3440 | RPVList n | RVGList n | RLVList n
3441 | RStat n | RStatVFS n ->
3442 pr " /* caller will free this */\n";
3443 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3449 (* Generate daemon/actions.h. *)
3450 and generate_daemon_actions_h () =
3451 generate_header CStyle GPLv2;
3453 pr "#include \"../src/guestfs_protocol.h\"\n";
3457 fun (name, style, _, _, _, _, _) ->
3459 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3463 (* Generate the server-side stubs. *)
3464 and generate_daemon_actions () =
3465 generate_header CStyle GPLv2;
3467 pr "#include <config.h>\n";
3469 pr "#include <stdio.h>\n";
3470 pr "#include <stdlib.h>\n";
3471 pr "#include <string.h>\n";
3472 pr "#include <inttypes.h>\n";
3473 pr "#include <ctype.h>\n";
3474 pr "#include <rpc/types.h>\n";
3475 pr "#include <rpc/xdr.h>\n";
3477 pr "#include \"daemon.h\"\n";
3478 pr "#include \"../src/guestfs_protocol.h\"\n";
3479 pr "#include \"actions.h\"\n";
3483 fun (name, style, _, _, _, _, _) ->
3484 (* Generate server-side stubs. *)
3485 pr "static void %s_stub (XDR *xdr_in)\n" name;
3488 match fst style with
3489 | RErr | RInt _ -> pr " int r;\n"; "-1"
3490 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3491 | RBool _ -> pr " int r;\n"; "-1"
3493 failwithf "RConstString cannot be returned from a daemon function"
3494 | RString _ -> pr " char *r;\n"; "NULL"
3495 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
3496 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
3497 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
3498 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
3499 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
3500 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
3501 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
3503 (match snd style with
3506 pr " struct guestfs_%s_args args;\n" name;
3509 (* Note we allow the string to be writable, in order to
3510 * allow device name translation. This is safe because
3511 * we can modify the string (passed from RPC).
3514 | OptString n -> pr " char *%s;\n" n
3515 | StringList n -> pr " char **%s;\n" n
3516 | Bool n -> pr " int %s;\n" n
3517 | Int n -> pr " int %s;\n" n
3518 | FileIn _ | FileOut _ -> ()
3523 (match snd style with
3526 pr " memset (&args, 0, sizeof args);\n";
3528 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3529 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3534 | String n -> pr " %s = args.%s;\n" n n
3535 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3537 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3538 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3539 pr " if (%s == NULL) {\n" n;
3540 pr " reply_with_perror (\"realloc\");\n";
3543 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3544 pr " args.%s.%s_val = %s;\n" n n n;
3545 | Bool n -> pr " %s = args.%s;\n" n n
3546 | Int n -> pr " %s = args.%s;\n" n n
3547 | FileIn _ | FileOut _ -> ()
3552 (* Don't want to call the impl with any FileIn or FileOut
3553 * parameters, since these go "outside" the RPC protocol.
3556 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3558 pr " r = do_%s " name;
3559 generate_call_args argsnofile;
3562 pr " if (r == %s)\n" error_code;
3563 pr " /* do_%s has already called reply_with_error */\n" name;
3567 (* If there are any FileOut parameters, then the impl must
3568 * send its own reply.
3571 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3573 pr " /* do_%s has already sent a reply */\n" name
3575 match fst style with
3576 | RErr -> pr " reply (NULL, NULL);\n"
3577 | RInt n | RInt64 n | RBool n ->
3578 pr " struct guestfs_%s_ret ret;\n" name;
3579 pr " ret.%s = r;\n" n;
3580 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3583 failwithf "RConstString cannot be returned from a daemon function"
3585 pr " struct guestfs_%s_ret ret;\n" name;
3586 pr " ret.%s = r;\n" n;
3587 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3590 | RStringList n | RHashtable n ->
3591 pr " struct guestfs_%s_ret ret;\n" name;
3592 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3593 pr " ret.%s.%s_val = r;\n" n n;
3594 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3596 pr " free_strings (r);\n"
3598 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3600 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3601 | RPVList n | RVGList n | RLVList n
3602 | RStat n | RStatVFS n ->
3603 pr " struct guestfs_%s_ret ret;\n" name;
3604 pr " ret.%s = *r;\n" n;
3605 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3607 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3611 (* Free the args. *)
3612 (match snd style with
3617 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3624 (* Dispatch function. *)
3625 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3627 pr " switch (proc_nr) {\n";
3630 fun (name, style, _, _, _, _, _) ->
3631 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3632 pr " %s_stub (xdr_in);\n" name;
3637 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3642 (* LVM columns and tokenization functions. *)
3643 (* XXX This generates crap code. We should rethink how we
3649 pr "static const char *lvm_%s_cols = \"%s\";\n"
3650 typ (String.concat "," (List.map fst cols));
3653 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3655 pr " char *tok, *p, *next;\n";
3659 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3662 pr " if (!str) {\n";
3663 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3666 pr " if (!*str || isspace (*str)) {\n";
3667 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3672 fun (name, coltype) ->
3673 pr " if (!tok) {\n";
3674 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3677 pr " p = strchrnul (tok, ',');\n";
3678 pr " if (*p) next = p+1; else next = NULL;\n";
3679 pr " *p = '\\0';\n";
3682 pr " r->%s = strdup (tok);\n" name;
3683 pr " if (r->%s == NULL) {\n" name;
3684 pr " perror (\"strdup\");\n";
3688 pr " for (i = j = 0; i < 32; ++j) {\n";
3689 pr " if (tok[j] == '\\0') {\n";
3690 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3692 pr " } else if (tok[j] != '-')\n";
3693 pr " r->%s[i++] = tok[j];\n" name;
3696 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3697 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3701 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3702 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3706 pr " if (tok[0] == '\\0')\n";
3707 pr " r->%s = -1;\n" name;
3708 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3709 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3713 pr " tok = next;\n";
3716 pr " if (tok != NULL) {\n";
3717 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3724 pr "guestfs_lvm_int_%s_list *\n" typ;
3725 pr "parse_command_line_%ss (void)\n" typ;
3727 pr " char *out, *err;\n";
3728 pr " char *p, *pend;\n";
3730 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3731 pr " void *newp;\n";
3733 pr " ret = malloc (sizeof *ret);\n";
3734 pr " if (!ret) {\n";
3735 pr " reply_with_perror (\"malloc\");\n";
3736 pr " return NULL;\n";
3739 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3740 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3742 pr " r = command (&out, &err,\n";
3743 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3744 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3745 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3746 pr " if (r == -1) {\n";
3747 pr " reply_with_error (\"%%s\", err);\n";
3748 pr " free (out);\n";
3749 pr " free (err);\n";
3750 pr " free (ret);\n";
3751 pr " return NULL;\n";
3754 pr " free (err);\n";
3756 pr " /* Tokenize each line of the output. */\n";
3759 pr " while (p) {\n";
3760 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3761 pr " if (pend) {\n";
3762 pr " *pend = '\\0';\n";
3766 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3769 pr " if (!*p) { /* Empty line? Skip it. */\n";
3774 pr " /* Allocate some space to store this next entry. */\n";
3775 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3776 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3777 pr " if (newp == NULL) {\n";
3778 pr " reply_with_perror (\"realloc\");\n";
3779 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3780 pr " free (ret);\n";
3781 pr " free (out);\n";
3782 pr " return NULL;\n";
3784 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3786 pr " /* Tokenize the next entry. */\n";
3787 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3788 pr " if (r == -1) {\n";
3789 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3790 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3791 pr " free (ret);\n";
3792 pr " free (out);\n";
3793 pr " return NULL;\n";
3800 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3802 pr " free (out);\n";
3803 pr " return ret;\n";
3806 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3808 (* Generate the tests. *)
3809 and generate_tests () =
3810 generate_header CStyle GPLv2;
3817 #include <sys/types.h>
3820 #include \"guestfs.h\"
3822 static guestfs_h *g;
3823 static int suppress_error = 0;
3825 static void print_error (guestfs_h *g, void *data, const char *msg)
3827 if (!suppress_error)
3828 fprintf (stderr, \"%%s\\n\", msg);
3831 static void print_strings (char * const * const argv)
3835 for (argc = 0; argv[argc] != NULL; ++argc)
3836 printf (\"\\t%%s\\n\", argv[argc]);
3840 static void print_table (char * const * const argv)
3844 for (i = 0; argv[i] != NULL; i += 2)
3845 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3849 static void no_test_warnings (void)
3855 | name, _, _, _, [], _, _ ->
3856 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3857 | name, _, _, _, tests, _, _ -> ()
3863 (* Generate the actual tests. Note that we generate the tests
3864 * in reverse order, deliberately, so that (in general) the
3865 * newest tests run first. This makes it quicker and easier to
3870 fun (name, _, _, _, tests, _, _) ->
3871 mapi (generate_one_test name) tests
3872 ) (List.rev all_functions) in
3873 let test_names = List.concat test_names in
3874 let nr_tests = List.length test_names in
3877 int main (int argc, char *argv[])
3881 const char *filename;
3883 int nr_tests, test_num = 0;
3885 no_test_warnings ();
3887 g = guestfs_create ();
3889 printf (\"guestfs_create FAILED\\n\");
3893 guestfs_set_error_handler (g, print_error, NULL);
3895 guestfs_set_path (g, \"../appliance\");
3897 filename = \"test1.img\";
3898 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3903 if (lseek (fd, %d, SEEK_SET) == -1) {
3909 if (write (fd, &c, 1) == -1) {
3915 if (close (fd) == -1) {
3920 if (guestfs_add_drive (g, filename) == -1) {
3921 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3925 filename = \"test2.img\";
3926 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3931 if (lseek (fd, %d, SEEK_SET) == -1) {
3937 if (write (fd, &c, 1) == -1) {
3943 if (close (fd) == -1) {
3948 if (guestfs_add_drive (g, filename) == -1) {
3949 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3953 filename = \"test3.img\";
3954 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3959 if (lseek (fd, %d, SEEK_SET) == -1) {
3965 if (write (fd, &c, 1) == -1) {
3971 if (close (fd) == -1) {
3976 if (guestfs_add_drive (g, filename) == -1) {
3977 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3981 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
3982 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
3986 if (guestfs_launch (g) == -1) {
3987 printf (\"guestfs_launch FAILED\\n\");
3990 if (guestfs_wait_ready (g) == -1) {
3991 printf (\"guestfs_wait_ready FAILED\\n\");
3997 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4001 pr " test_num++;\n";
4002 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4003 pr " if (%s () == -1) {\n" test_name;
4004 pr " printf (\"%s FAILED\\n\");\n" test_name;
4010 pr " guestfs_close (g);\n";
4011 pr " unlink (\"test1.img\");\n";
4012 pr " unlink (\"test2.img\");\n";
4013 pr " unlink (\"test3.img\");\n";
4016 pr " if (failed > 0) {\n";
4017 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4025 and generate_one_test name i (init, prereq, test) =
4026 let test_name = sprintf "test_%s_%d" name i in
4029 static int %s_skip (void)
4033 str = getenv (\"SKIP_%s\");
4034 if (str && strcmp (str, \"1\") == 0) return 1;
4035 str = getenv (\"SKIP_TEST_%s\");
4036 if (str && strcmp (str, \"1\") == 0) return 1;
4040 " test_name (String.uppercase test_name) (String.uppercase name);
4043 | Disabled | Always -> ()
4044 | If code | Unless code ->
4045 pr "static int %s_prereq (void)\n" test_name;
4053 static int %s (void)
4056 printf (\"%%s skipped (reason: SKIP_TEST_* variable set)\\n\", \"%s\");
4060 " test_name test_name test_name;
4064 pr " printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4066 pr " if (! %s_prereq ()) {\n" test_name;
4067 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4071 generate_one_test_body name i test_name init test;
4073 pr " if (%s_prereq ()) {\n" test_name;
4074 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4078 generate_one_test_body name i test_name init test;
4080 generate_one_test_body name i test_name init test
4088 and generate_one_test_body name i test_name init test =
4092 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4093 List.iter (generate_test_command_call test_name)
4094 [["blockdev_setrw"; "/dev/sda"];
4098 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4099 List.iter (generate_test_command_call test_name)
4100 [["blockdev_setrw"; "/dev/sda"];
4103 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4104 ["mkfs"; "ext2"; "/dev/sda1"];
4105 ["mount"; "/dev/sda1"; "/"]]
4106 | InitBasicFSonLVM ->
4107 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4109 List.iter (generate_test_command_call test_name)
4110 [["blockdev_setrw"; "/dev/sda"];
4113 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4114 ["pvcreate"; "/dev/sda1"];
4115 ["vgcreate"; "VG"; "/dev/sda1"];
4116 ["lvcreate"; "LV"; "VG"; "8"];
4117 ["mkfs"; "ext2"; "/dev/VG/LV"];
4118 ["mount"; "/dev/VG/LV"; "/"]]
4121 let get_seq_last = function
4123 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4126 let seq = List.rev seq in
4127 List.rev (List.tl seq), List.hd seq
4132 pr " /* TestRun for %s (%d) */\n" name i;
4133 List.iter (generate_test_command_call test_name) seq
4134 | TestOutput (seq, expected) ->
4135 pr " /* TestOutput for %s (%d) */\n" name i;
4136 pr " char expected[] = \"%s\";\n" (c_quote expected);
4137 let seq, last = get_seq_last seq in
4139 pr " if (strcmp (r, expected) != 0) {\n";
4140 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4144 List.iter (generate_test_command_call test_name) seq;
4145 generate_test_command_call ~test test_name last
4146 | TestOutputList (seq, expected) ->
4147 pr " /* TestOutputList for %s (%d) */\n" name i;
4148 let seq, last = get_seq_last seq in
4152 pr " if (!r[%d]) {\n" i;
4153 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4154 pr " print_strings (r);\n";
4158 pr " char expected[] = \"%s\";\n" (c_quote str);
4159 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4160 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4165 pr " if (r[%d] != NULL) {\n" (List.length expected);
4166 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4168 pr " print_strings (r);\n";
4172 List.iter (generate_test_command_call test_name) seq;
4173 generate_test_command_call ~test test_name last
4174 | TestOutputListOfDevices (seq, expected) ->
4175 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
4176 let seq, last = get_seq_last seq in
4180 pr " if (!r[%d]) {\n" i;
4181 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4182 pr " print_strings (r);\n";
4186 pr " char expected[] = \"%s\";\n" (c_quote str);
4187 pr " r[%d][5] = 's';\n" i;
4188 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4189 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4194 pr " if (r[%d] != NULL) {\n" (List.length expected);
4195 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4197 pr " print_strings (r);\n";
4201 List.iter (generate_test_command_call test_name) seq;
4202 generate_test_command_call ~test test_name last
4203 | TestOutputInt (seq, expected) ->
4204 pr " /* TestOutputInt for %s (%d) */\n" name i;
4205 let seq, last = get_seq_last seq in
4207 pr " if (r != %d) {\n" expected;
4208 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4214 List.iter (generate_test_command_call test_name) seq;
4215 generate_test_command_call ~test test_name last
4216 | TestOutputTrue seq ->
4217 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4218 let seq, last = get_seq_last seq in
4221 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4226 List.iter (generate_test_command_call test_name) seq;
4227 generate_test_command_call ~test test_name last
4228 | TestOutputFalse seq ->
4229 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4230 let seq, last = get_seq_last seq in
4233 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4238 List.iter (generate_test_command_call test_name) seq;
4239 generate_test_command_call ~test test_name last
4240 | TestOutputLength (seq, expected) ->
4241 pr " /* TestOutputLength for %s (%d) */\n" name i;
4242 let seq, last = get_seq_last seq in
4245 pr " for (j = 0; j < %d; ++j)\n" expected;
4246 pr " if (r[j] == NULL) {\n";
4247 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4249 pr " print_strings (r);\n";
4252 pr " if (r[j] != NULL) {\n";
4253 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4255 pr " print_strings (r);\n";
4259 List.iter (generate_test_command_call test_name) seq;
4260 generate_test_command_call ~test test_name last
4261 | TestOutputStruct (seq, checks) ->
4262 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4263 let seq, last = get_seq_last seq in
4267 | CompareWithInt (field, expected) ->
4268 pr " if (r->%s != %d) {\n" field expected;
4269 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4270 test_name field expected;
4271 pr " (int) r->%s);\n" field;
4274 | CompareWithString (field, expected) ->
4275 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4276 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4277 test_name field expected;
4278 pr " r->%s);\n" field;
4281 | CompareFieldsIntEq (field1, field2) ->
4282 pr " if (r->%s != r->%s) {\n" field1 field2;
4283 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4284 test_name field1 field2;
4285 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
4288 | CompareFieldsStrEq (field1, field2) ->
4289 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4290 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4291 test_name field1 field2;
4292 pr " r->%s, r->%s);\n" field1 field2;
4297 List.iter (generate_test_command_call test_name) seq;
4298 generate_test_command_call ~test test_name last
4299 | TestLastFail seq ->
4300 pr " /* TestLastFail for %s (%d) */\n" name i;
4301 let seq, last = get_seq_last seq in
4302 List.iter (generate_test_command_call test_name) seq;
4303 generate_test_command_call test_name ~expect_error:true last
4305 (* Generate the code to run a command, leaving the result in 'r'.
4306 * If you expect to get an error then you should set expect_error:true.
4308 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4310 | [] -> assert false
4312 (* Look up the command to find out what args/ret it has. *)
4315 let _, style, _, _, _, _, _ =
4316 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4319 failwithf "%s: in test, command %s was not found" test_name name in
4321 if List.length (snd style) <> List.length args then
4322 failwithf "%s: in test, wrong number of args given to %s"
4329 | OptString n, "NULL" -> ()
4331 | OptString n, arg ->
4332 pr " char %s[] = \"%s\";\n" n (c_quote arg);
4335 | FileIn _, _ | FileOut _, _ -> ()
4336 | StringList n, arg ->
4337 let strs = string_split " " arg in
4340 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
4342 pr " char *%s[] = {\n" n;
4344 fun i _ -> pr " %s_%d,\n" n i
4348 ) (List.combine (snd style) args);
4351 match fst style with
4352 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
4353 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4354 | RConstString _ -> pr " const char *r;\n"; "NULL"
4355 | RString _ -> pr " char *r;\n"; "NULL"
4356 | RStringList _ | RHashtable _ ->
4361 pr " struct guestfs_int_bool *r;\n"; "NULL"
4363 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4365 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4367 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4369 pr " struct guestfs_stat *r;\n"; "NULL"
4371 pr " struct guestfs_statvfs *r;\n"; "NULL" in
4373 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4374 pr " r = guestfs_%s (g" name;
4376 (* Generate the parameters. *)
4379 | OptString _, "NULL" -> pr ", NULL"
4383 | FileIn _, arg | FileOut _, arg ->
4384 pr ", \"%s\"" (c_quote arg)
4385 | StringList n, _ ->
4389 try int_of_string arg
4390 with Failure "int_of_string" ->
4391 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4394 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4395 ) (List.combine (snd style) args);
4398 if not expect_error then
4399 pr " if (r == %s)\n" error_code
4401 pr " if (r != %s)\n" error_code;
4404 (* Insert the test code. *)
4410 (match fst style with
4411 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4412 | RString _ -> pr " free (r);\n"
4413 | RStringList _ | RHashtable _ ->
4414 pr " for (i = 0; r[i] != NULL; ++i)\n";
4415 pr " free (r[i]);\n";
4418 pr " guestfs_free_int_bool (r);\n"
4420 pr " guestfs_free_lvm_pv_list (r);\n"
4422 pr " guestfs_free_lvm_vg_list (r);\n"
4424 pr " guestfs_free_lvm_lv_list (r);\n"
4425 | RStat _ | RStatVFS _ ->
4432 let str = replace_str str "\r" "\\r" in
4433 let str = replace_str str "\n" "\\n" in
4434 let str = replace_str str "\t" "\\t" in
4435 let str = replace_str str "\000" "\\0" in
4438 (* Generate a lot of different functions for guestfish. *)
4439 and generate_fish_cmds () =
4440 generate_header CStyle GPLv2;
4444 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4446 let all_functions_sorted =
4448 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4449 ) all_functions_sorted in
4451 pr "#include <stdio.h>\n";
4452 pr "#include <stdlib.h>\n";
4453 pr "#include <string.h>\n";
4454 pr "#include <inttypes.h>\n";
4456 pr "#include <guestfs.h>\n";
4457 pr "#include \"fish.h\"\n";
4460 (* list_commands function, which implements guestfish -h *)
4461 pr "void list_commands (void)\n";
4463 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
4464 pr " list_builtin_commands ();\n";
4466 fun (name, _, _, flags, _, shortdesc, _) ->
4467 let name = replace_char name '_' '-' in
4468 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4470 ) all_functions_sorted;
4471 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4475 (* display_command function, which implements guestfish -h cmd *)
4476 pr "void display_command (const char *cmd)\n";
4479 fun (name, style, _, flags, _, shortdesc, longdesc) ->
4480 let name2 = replace_char name '_' '-' in
4482 try find_map (function FishAlias n -> Some n | _ -> None) flags
4483 with Not_found -> name in
4484 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4486 match snd style with
4490 name2 (String.concat "> <" (List.map name_of_argt args)) in
4493 if List.mem ProtocolLimitWarning flags then
4494 ("\n\n" ^ protocol_limit_warning)
4497 (* For DangerWillRobinson commands, we should probably have
4498 * guestfish prompt before allowing you to use them (especially
4499 * in interactive mode). XXX
4503 if List.mem DangerWillRobinson flags then
4504 ("\n\n" ^ danger_will_robinson)
4507 let describe_alias =
4508 if name <> alias then
4509 sprintf "\n\nYou can use '%s' as an alias for this command." alias
4513 pr "strcasecmp (cmd, \"%s\") == 0" name;
4514 if name <> name2 then
4515 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4516 if name <> alias then
4517 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4519 pr " pod2text (\"%s - %s\", %S);\n"
4521 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4524 pr " display_builtin_command (cmd);\n";
4528 (* print_{pv,vg,lv}_list functions *)
4532 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4539 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4541 pr " printf (\"%s: \");\n" name;
4542 pr " for (i = 0; i < 32; ++i)\n";
4543 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
4544 pr " printf (\"\\n\");\n"
4546 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4548 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4549 | name, `OptPercent ->
4550 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4551 typ name name typ name;
4552 pr " else printf (\"%s: \\n\");\n" name
4556 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4561 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4562 pr " print_%s (&%ss->val[i]);\n" typ typ;
4565 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4567 (* print_{stat,statvfs} functions *)
4571 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4576 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4580 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4582 (* run_<action> actions *)
4584 fun (name, style, _, flags, _, _, _) ->
4585 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4587 (match fst style with
4590 | RBool _ -> pr " int r;\n"
4591 | RInt64 _ -> pr " int64_t r;\n"
4592 | RConstString _ -> pr " const char *r;\n"
4593 | RString _ -> pr " char *r;\n"
4594 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4595 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4596 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4597 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4598 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4599 | RStat _ -> pr " struct guestfs_stat *r;\n"
4600 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4607 | FileOut n -> pr " const char *%s;\n" n
4608 | StringList n -> pr " char **%s;\n" n
4609 | Bool n -> pr " int %s;\n" n
4610 | Int n -> pr " int %s;\n" n
4613 (* Check and convert parameters. *)
4614 let argc_expected = List.length (snd style) in
4615 pr " if (argc != %d) {\n" argc_expected;
4616 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4618 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4624 | String name -> pr " %s = argv[%d];\n" name i
4626 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4629 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4632 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4634 | StringList name ->
4635 pr " %s = parse_string_list (argv[%d]);\n" name i
4637 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4639 pr " %s = atoi (argv[%d]);\n" name i
4642 (* Call C API function. *)
4644 try find_map (function FishAction n -> Some n | _ -> None) flags
4645 with Not_found -> sprintf "guestfs_%s" name in
4647 generate_call_args ~handle:"g" (snd style);
4650 (* Check return value for errors and display command results. *)
4651 (match fst style with
4652 | RErr -> pr " return r;\n"
4654 pr " if (r == -1) return -1;\n";
4655 pr " printf (\"%%d\\n\", r);\n";
4658 pr " if (r == -1) return -1;\n";
4659 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4662 pr " if (r == -1) return -1;\n";
4663 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4666 pr " if (r == NULL) return -1;\n";
4667 pr " printf (\"%%s\\n\", r);\n";
4670 pr " if (r == NULL) return -1;\n";
4671 pr " printf (\"%%s\\n\", r);\n";
4675 pr " if (r == NULL) return -1;\n";
4676 pr " print_strings (r);\n";
4677 pr " free_strings (r);\n";
4680 pr " if (r == NULL) return -1;\n";
4681 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4682 pr " r->b ? \"true\" : \"false\");\n";
4683 pr " guestfs_free_int_bool (r);\n";
4686 pr " if (r == NULL) return -1;\n";
4687 pr " print_pv_list (r);\n";
4688 pr " guestfs_free_lvm_pv_list (r);\n";
4691 pr " if (r == NULL) return -1;\n";
4692 pr " print_vg_list (r);\n";
4693 pr " guestfs_free_lvm_vg_list (r);\n";
4696 pr " if (r == NULL) return -1;\n";
4697 pr " print_lv_list (r);\n";
4698 pr " guestfs_free_lvm_lv_list (r);\n";
4701 pr " if (r == NULL) return -1;\n";
4702 pr " print_stat (r);\n";
4706 pr " if (r == NULL) return -1;\n";
4707 pr " print_statvfs (r);\n";
4711 pr " if (r == NULL) return -1;\n";
4712 pr " print_table (r);\n";
4713 pr " free_strings (r);\n";
4720 (* run_action function *)
4721 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4724 fun (name, _, _, flags, _, _, _) ->
4725 let name2 = replace_char name '_' '-' in
4727 try find_map (function FishAlias n -> Some n | _ -> None) flags
4728 with Not_found -> name in
4730 pr "strcasecmp (cmd, \"%s\") == 0" name;
4731 if name <> name2 then
4732 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4733 if name <> alias then
4734 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4736 pr " return run_%s (cmd, argc, argv);\n" name;
4740 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4747 (* Readline completion for guestfish. *)
4748 and generate_fish_completion () =
4749 generate_header CStyle GPLv2;
4753 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4763 #ifdef HAVE_LIBREADLINE
4764 #include <readline/readline.h>
4769 #ifdef HAVE_LIBREADLINE
4771 static const char *const commands[] = {
4772 BUILTIN_COMMANDS_FOR_COMPLETION,
4775 (* Get the commands, including the aliases. They don't need to be
4776 * sorted - the generator() function just does a dumb linear search.
4780 fun (name, _, _, flags, _, _, _) ->
4781 let name2 = replace_char name '_' '-' in
4783 try find_map (function FishAlias n -> Some n | _ -> None) flags
4784 with Not_found -> name in
4786 if name <> alias then [name2; alias] else [name2]
4788 let commands = List.flatten commands in
4790 List.iter (pr " \"%s\",\n") commands;
4796 generator (const char *text, int state)
4798 static int index, len;
4803 len = strlen (text);
4806 while ((name = commands[index]) != NULL) {
4808 if (strncasecmp (name, text, len) == 0)
4809 return strdup (name);
4815 #endif /* HAVE_LIBREADLINE */
4817 char **do_completion (const char *text, int start, int end)
4819 char **matches = NULL;
4821 #ifdef HAVE_LIBREADLINE
4823 matches = rl_completion_matches (text, generator);
4830 (* Generate the POD documentation for guestfish. *)
4831 and generate_fish_actions_pod () =
4832 let all_functions_sorted =
4834 fun (_, _, _, flags, _, _, _) ->
4835 not (List.mem NotInFish flags || List.mem NotInDocs flags)
4836 ) all_functions_sorted in
4838 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4841 fun (name, style, _, flags, _, _, longdesc) ->
4843 Str.global_substitute rex (
4846 try Str.matched_group 1 s
4848 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4849 "C<" ^ replace_char sub '_' '-' ^ ">"
4851 let name = replace_char name '_' '-' in
4853 try find_map (function FishAlias n -> Some n | _ -> None) flags
4854 with Not_found -> name in
4856 pr "=head2 %s" name;
4857 if name <> alias then
4864 | String n -> pr " %s" n
4865 | OptString n -> pr " %s" n
4866 | StringList n -> pr " '%s ...'" n
4867 | Bool _ -> pr " true|false"
4868 | Int n -> pr " %s" n
4869 | FileIn n | FileOut n -> pr " (%s|-)" n
4873 pr "%s\n\n" longdesc;
4875 if List.exists (function FileIn _ | FileOut _ -> true
4876 | _ -> false) (snd style) then
4877 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4879 if List.mem ProtocolLimitWarning flags then
4880 pr "%s\n\n" protocol_limit_warning;
4882 if List.mem DangerWillRobinson flags then
4883 pr "%s\n\n" danger_will_robinson
4884 ) all_functions_sorted
4886 (* Generate a C function prototype. *)
4887 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4888 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4890 ?handle name style =
4891 if extern then pr "extern ";
4892 if static then pr "static ";
4893 (match fst style with
4895 | RInt _ -> pr "int "
4896 | RInt64 _ -> pr "int64_t "
4897 | RBool _ -> pr "int "
4898 | RConstString _ -> pr "const char *"
4899 | RString _ -> pr "char *"
4900 | RStringList _ | RHashtable _ -> pr "char **"
4902 if not in_daemon then pr "struct guestfs_int_bool *"
4903 else pr "guestfs_%s_ret *" name
4905 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4906 else pr "guestfs_lvm_int_pv_list *"
4908 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4909 else pr "guestfs_lvm_int_vg_list *"
4911 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4912 else pr "guestfs_lvm_int_lv_list *"
4914 if not in_daemon then pr "struct guestfs_stat *"
4915 else pr "guestfs_int_stat *"
4917 if not in_daemon then pr "struct guestfs_statvfs *"
4918 else pr "guestfs_int_statvfs *"
4920 pr "%s%s (" prefix name;
4921 if handle = None && List.length (snd style) = 0 then
4924 let comma = ref false in
4927 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4931 if single_line then pr ", " else pr ",\n\t\t"
4940 if not in_daemon then pr "const char *%s" n
4941 else pr "char *%s" n
4944 if not in_daemon then pr "char * const* const %s" n
4945 else pr "char **%s" n
4946 | Bool n -> next (); pr "int %s" n
4947 | Int n -> next (); pr "int %s" n
4950 if not in_daemon then (next (); pr "const char *%s" n)
4954 if semicolon then pr ";";
4955 if newline then pr "\n"
4957 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4958 and generate_call_args ?handle args =
4960 let comma = ref false in
4963 | Some handle -> pr "%s" handle; comma := true
4967 if !comma then pr ", ";
4969 pr "%s" (name_of_argt arg)
4973 (* Generate the OCaml bindings interface. *)
4974 and generate_ocaml_mli () =
4975 generate_header OCamlStyle LGPLv2;
4978 (** For API documentation you should refer to the C API
4979 in the guestfs(3) manual page. The OCaml API uses almost
4980 exactly the same calls. *)
4983 (** A [guestfs_h] handle. *)
4985 exception Error of string
4986 (** This exception is raised when there is an error. *)
4988 val create : unit -> t
4990 val close : t -> unit
4991 (** Handles are closed by the garbage collector when they become
4992 unreferenced, but callers can also call this in order to
4993 provide predictable cleanup. *)
4996 generate_ocaml_lvm_structure_decls ();
4998 generate_ocaml_stat_structure_decls ();
5002 fun (name, style, _, _, _, shortdesc, _) ->
5003 generate_ocaml_prototype name style;
5004 pr "(** %s *)\n" shortdesc;
5008 (* Generate the OCaml bindings implementation. *)
5009 and generate_ocaml_ml () =
5010 generate_header OCamlStyle LGPLv2;
5014 exception Error of string
5015 external create : unit -> t = \"ocaml_guestfs_create\"
5016 external close : t -> unit = \"ocaml_guestfs_close\"
5019 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5023 generate_ocaml_lvm_structure_decls ();
5025 generate_ocaml_stat_structure_decls ();
5029 fun (name, style, _, _, _, shortdesc, _) ->
5030 generate_ocaml_prototype ~is_external:true name style;
5033 (* Generate the OCaml bindings C implementation. *)
5034 and generate_ocaml_c () =
5035 generate_header CStyle LGPLv2;
5042 #include <caml/config.h>
5043 #include <caml/alloc.h>
5044 #include <caml/callback.h>
5045 #include <caml/fail.h>
5046 #include <caml/memory.h>
5047 #include <caml/mlvalues.h>
5048 #include <caml/signals.h>
5050 #include <guestfs.h>
5052 #include \"guestfs_c.h\"
5054 /* Copy a hashtable of string pairs into an assoc-list. We return
5055 * the list in reverse order, but hashtables aren't supposed to be
5058 static CAMLprim value
5059 copy_table (char * const * argv)
5062 CAMLlocal5 (rv, pairv, kv, vv, cons);
5066 for (i = 0; argv[i] != NULL; i += 2) {
5067 kv = caml_copy_string (argv[i]);
5068 vv = caml_copy_string (argv[i+1]);
5069 pairv = caml_alloc (2, 0);
5070 Store_field (pairv, 0, kv);
5071 Store_field (pairv, 1, vv);
5072 cons = caml_alloc (2, 0);
5073 Store_field (cons, 1, rv);
5075 Store_field (cons, 0, pairv);
5083 (* LVM struct copy functions. *)
5086 let has_optpercent_col =
5087 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
5089 pr "static CAMLprim value\n";
5090 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
5092 pr " CAMLparam0 ();\n";
5093 if has_optpercent_col then
5094 pr " CAMLlocal3 (rv, v, v2);\n"
5096 pr " CAMLlocal2 (rv, v);\n";
5098 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5103 pr " v = caml_copy_string (%s->%s);\n" typ name
5105 pr " v = caml_alloc_string (32);\n";
5106 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5109 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5110 | name, `OptPercent ->
5111 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5112 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5113 pr " v = caml_alloc (1, 0);\n";
5114 pr " Store_field (v, 0, v2);\n";
5115 pr " } else /* None */\n";
5116 pr " v = Val_int (0);\n";
5118 pr " Store_field (rv, %d, v);\n" i
5120 pr " CAMLreturn (rv);\n";
5124 pr "static CAMLprim value\n";
5125 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
5128 pr " CAMLparam0 ();\n";
5129 pr " CAMLlocal2 (rv, v);\n";
5132 pr " if (%ss->len == 0)\n" typ;
5133 pr " CAMLreturn (Atom (0));\n";
5135 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5136 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5137 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
5138 pr " caml_modify (&Field (rv, i), v);\n";
5140 pr " CAMLreturn (rv);\n";
5144 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5146 (* Stat copy functions. *)
5149 pr "static CAMLprim value\n";
5150 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5152 pr " CAMLparam0 ();\n";
5153 pr " CAMLlocal2 (rv, v);\n";
5155 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5160 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5162 pr " Store_field (rv, %d, v);\n" i
5164 pr " CAMLreturn (rv);\n";
5167 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5171 fun (name, style, _, _, _, _, _) ->
5173 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5175 pr "CAMLprim value\n";
5176 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5177 List.iter (pr ", value %s") (List.tl params);
5182 | [p1; p2; p3; p4; p5] ->
5183 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5184 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5185 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5186 pr " CAMLxparam%d (%s);\n"
5187 (List.length rest) (String.concat ", " rest)
5189 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5191 pr " CAMLlocal1 (rv);\n";
5194 pr " guestfs_h *g = Guestfs_val (gv);\n";
5195 pr " if (g == NULL)\n";
5196 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5204 pr " const char *%s = String_val (%sv);\n" n n
5206 pr " const char *%s =\n" n;
5207 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5210 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5212 pr " int %s = Bool_val (%sv);\n" n n
5214 pr " int %s = Int_val (%sv);\n" n n
5217 match fst style with
5218 | RErr -> pr " int r;\n"; "-1"
5219 | RInt _ -> pr " int r;\n"; "-1"
5220 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5221 | RBool _ -> pr " int r;\n"; "-1"
5222 | RConstString _ -> pr " const char *r;\n"; "NULL"
5223 | RString _ -> pr " char *r;\n"; "NULL"
5229 pr " struct guestfs_int_bool *r;\n"; "NULL"
5231 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5233 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5235 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5237 pr " struct guestfs_stat *r;\n"; "NULL"
5239 pr " struct guestfs_statvfs *r;\n"; "NULL"
5246 pr " caml_enter_blocking_section ();\n";
5247 pr " r = guestfs_%s " name;
5248 generate_call_args ~handle:"g" (snd style);
5250 pr " caml_leave_blocking_section ();\n";
5255 pr " ocaml_guestfs_free_strings (%s);\n" n;
5256 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5259 pr " if (r == %s)\n" error_code;
5260 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5263 (match fst style with
5264 | RErr -> pr " rv = Val_unit;\n"
5265 | RInt _ -> pr " rv = Val_int (r);\n"
5267 pr " rv = caml_copy_int64 (r);\n"
5268 | RBool _ -> pr " rv = Val_bool (r);\n"
5269 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5271 pr " rv = caml_copy_string (r);\n";
5274 pr " rv = caml_copy_string_array ((const char **) r);\n";
5275 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5278 pr " rv = caml_alloc (2, 0);\n";
5279 pr " Store_field (rv, 0, Val_int (r->i));\n";
5280 pr " Store_field (rv, 1, Val_bool (r->b));\n";
5281 pr " guestfs_free_int_bool (r);\n";
5283 pr " rv = copy_lvm_pv_list (r);\n";
5284 pr " guestfs_free_lvm_pv_list (r);\n";
5286 pr " rv = copy_lvm_vg_list (r);\n";
5287 pr " guestfs_free_lvm_vg_list (r);\n";
5289 pr " rv = copy_lvm_lv_list (r);\n";
5290 pr " guestfs_free_lvm_lv_list (r);\n";
5292 pr " rv = copy_stat (r);\n";
5295 pr " rv = copy_statvfs (r);\n";
5298 pr " rv = copy_table (r);\n";
5299 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5303 pr " CAMLreturn (rv);\n";
5307 if List.length params > 5 then (
5308 pr "CAMLprim value\n";
5309 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5311 pr " return ocaml_guestfs_%s (argv[0]" name;
5312 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5319 and generate_ocaml_lvm_structure_decls () =
5322 pr "type lvm_%s = {\n" typ;
5325 | name, `String -> pr " %s : string;\n" name
5326 | name, `UUID -> pr " %s : string;\n" name
5327 | name, `Bytes -> pr " %s : int64;\n" name
5328 | name, `Int -> pr " %s : int64;\n" name
5329 | name, `OptPercent -> pr " %s : float option;\n" name
5333 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
5335 and generate_ocaml_stat_structure_decls () =
5338 pr "type %s = {\n" typ;
5341 | name, `Int -> pr " %s : int64;\n" name
5345 ) ["stat", stat_cols; "statvfs", statvfs_cols]
5347 and generate_ocaml_prototype ?(is_external = false) name style =
5348 if is_external then pr "external " else pr "val ";
5349 pr "%s : t -> " name;
5352 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5353 | OptString _ -> pr "string option -> "
5354 | StringList _ -> pr "string array -> "
5355 | Bool _ -> pr "bool -> "
5356 | Int _ -> pr "int -> "
5358 (match fst style with
5359 | RErr -> pr "unit" (* all errors are turned into exceptions *)
5360 | RInt _ -> pr "int"
5361 | RInt64 _ -> pr "int64"
5362 | RBool _ -> pr "bool"
5363 | RConstString _ -> pr "string"
5364 | RString _ -> pr "string"
5365 | RStringList _ -> pr "string array"
5366 | RIntBool _ -> pr "int * bool"
5367 | RPVList _ -> pr "lvm_pv array"
5368 | RVGList _ -> pr "lvm_vg array"
5369 | RLVList _ -> pr "lvm_lv array"
5370 | RStat _ -> pr "stat"
5371 | RStatVFS _ -> pr "statvfs"
5372 | RHashtable _ -> pr "(string * string) list"
5374 if is_external then (
5376 if List.length (snd style) + 1 > 5 then
5377 pr "\"ocaml_guestfs_%s_byte\" " name;
5378 pr "\"ocaml_guestfs_%s\"" name
5382 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5383 and generate_perl_xs () =
5384 generate_header CStyle LGPLv2;
5387 #include \"EXTERN.h\"
5391 #include <guestfs.h>
5394 #define PRId64 \"lld\"
5398 my_newSVll(long long val) {
5399 #ifdef USE_64_BIT_ALL
5400 return newSViv(val);
5404 len = snprintf(buf, 100, \"%%\" PRId64, val);
5405 return newSVpv(buf, len);
5410 #define PRIu64 \"llu\"
5414 my_newSVull(unsigned long long val) {
5415 #ifdef USE_64_BIT_ALL
5416 return newSVuv(val);
5420 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5421 return newSVpv(buf, len);
5425 /* http://www.perlmonks.org/?node_id=680842 */
5427 XS_unpack_charPtrPtr (SV *arg) {
5432 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5433 croak (\"array reference expected\");
5435 av = (AV *)SvRV (arg);
5436 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5438 croak (\"malloc failed\");
5440 for (i = 0; i <= av_len (av); i++) {
5441 SV **elem = av_fetch (av, i, 0);
5443 if (!elem || !*elem)
5444 croak (\"missing element in list\");
5446 ret[i] = SvPV_nolen (*elem);
5454 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5461 RETVAL = guestfs_create ();
5463 croak (\"could not create guestfs handle\");
5464 guestfs_set_error_handler (RETVAL, NULL, NULL);
5477 fun (name, style, _, _, _, _, _) ->
5478 (match fst style with
5479 | RErr -> pr "void\n"
5480 | RInt _ -> pr "SV *\n"
5481 | RInt64 _ -> pr "SV *\n"
5482 | RBool _ -> pr "SV *\n"
5483 | RConstString _ -> pr "SV *\n"
5484 | RString _ -> pr "SV *\n"
5487 | RPVList _ | RVGList _ | RLVList _
5488 | RStat _ | RStatVFS _
5490 pr "void\n" (* all lists returned implictly on the stack *)
5492 (* Call and arguments. *)
5494 generate_call_args ~handle:"g" (snd style);
5496 pr " guestfs_h *g;\n";
5500 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5502 (* http://www.perlmonks.org/?node_id=554277
5503 * Note that the implicit handle argument means we have
5504 * to add 1 to the ST(x) operator.
5506 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5507 | StringList n -> pr " char **%s;\n" n
5508 | Bool n -> pr " int %s;\n" n
5509 | Int n -> pr " int %s;\n" n
5512 let do_cleanups () =
5515 | String _ | OptString _ | Bool _ | Int _
5516 | FileIn _ | FileOut _ -> ()
5517 | StringList n -> pr " free (%s);\n" n
5522 (match fst style with
5527 pr " r = guestfs_%s " name;
5528 generate_call_args ~handle:"g" (snd style);
5531 pr " if (r == -1)\n";
5532 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5538 pr " %s = guestfs_%s " n name;
5539 generate_call_args ~handle:"g" (snd style);
5542 pr " if (%s == -1)\n" n;
5543 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5544 pr " RETVAL = newSViv (%s);\n" n;
5549 pr " int64_t %s;\n" n;
5551 pr " %s = guestfs_%s " n name;
5552 generate_call_args ~handle:"g" (snd style);
5555 pr " if (%s == -1)\n" n;
5556 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5557 pr " RETVAL = my_newSVll (%s);\n" n;
5562 pr " const char *%s;\n" n;
5564 pr " %s = guestfs_%s " n name;
5565 generate_call_args ~handle:"g" (snd style);
5568 pr " if (%s == NULL)\n" n;
5569 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5570 pr " RETVAL = newSVpv (%s, 0);\n" n;
5575 pr " char *%s;\n" n;
5577 pr " %s = guestfs_%s " n name;
5578 generate_call_args ~handle:"g" (snd style);
5581 pr " if (%s == NULL)\n" n;
5582 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5583 pr " RETVAL = newSVpv (%s, 0);\n" n;
5584 pr " free (%s);\n" n;
5587 | RStringList n | RHashtable n ->
5589 pr " char **%s;\n" n;
5592 pr " %s = guestfs_%s " n name;
5593 generate_call_args ~handle:"g" (snd style);
5596 pr " if (%s == NULL)\n" n;
5597 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5598 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5599 pr " EXTEND (SP, n);\n";
5600 pr " for (i = 0; i < n; ++i) {\n";
5601 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5602 pr " free (%s[i]);\n" n;
5604 pr " free (%s);\n" n;
5607 pr " struct guestfs_int_bool *r;\n";
5609 pr " r = guestfs_%s " name;
5610 generate_call_args ~handle:"g" (snd style);
5613 pr " if (r == NULL)\n";
5614 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5615 pr " EXTEND (SP, 2);\n";
5616 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5617 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5618 pr " guestfs_free_int_bool (r);\n";
5620 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5622 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5624 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5626 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5628 generate_perl_stat_code
5629 "statvfs" statvfs_cols name style n do_cleanups
5635 and generate_perl_lvm_code typ cols name style n do_cleanups =
5637 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5641 pr " %s = guestfs_%s " n name;
5642 generate_call_args ~handle:"g" (snd style);
5645 pr " if (%s == NULL)\n" n;
5646 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5647 pr " EXTEND (SP, %s->len);\n" n;
5648 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5649 pr " hv = newHV ();\n";
5653 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5654 name (String.length name) n name
5656 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5657 name (String.length name) n name
5659 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5660 name (String.length name) n name
5662 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5663 name (String.length name) n name
5664 | name, `OptPercent ->
5665 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5666 name (String.length name) n name
5668 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5670 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5672 and generate_perl_stat_code typ cols name style n do_cleanups =
5674 pr " struct guestfs_%s *%s;\n" typ n;
5676 pr " %s = guestfs_%s " n name;
5677 generate_call_args ~handle:"g" (snd style);
5680 pr " if (%s == NULL)\n" n;
5681 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5682 pr " EXTEND (SP, %d);\n" (List.length cols);
5686 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5688 pr " free (%s);\n" n
5690 (* Generate Sys/Guestfs.pm. *)
5691 and generate_perl_pm () =
5692 generate_header HashStyle LGPLv2;
5699 Sys::Guestfs - Perl bindings for libguestfs
5705 my $h = Sys::Guestfs->new ();
5706 $h->add_drive ('guest.img');
5709 $h->mount ('/dev/sda1', '/');
5710 $h->touch ('/hello');
5715 The C<Sys::Guestfs> module provides a Perl XS binding to the
5716 libguestfs API for examining and modifying virtual machine
5719 Amongst the things this is good for: making batch configuration
5720 changes to guests, getting disk used/free statistics (see also:
5721 virt-df), migrating between virtualization systems (see also:
5722 virt-p2v), performing partial backups, performing partial guest
5723 clones, cloning guests and changing registry/UUID/hostname info, and
5726 Libguestfs uses Linux kernel and qemu code, and can access any type of
5727 guest filesystem that Linux and qemu can, including but not limited
5728 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5729 schemes, qcow, qcow2, vmdk.
5731 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5732 LVs, what filesystem is in each LV, etc.). It can also run commands
5733 in the context of the guest. Also you can access filesystems over FTP.
5737 All errors turn into calls to C<croak> (see L<Carp(3)>).
5745 package Sys::Guestfs;
5751 XSLoader::load ('Sys::Guestfs');
5753 =item $h = Sys::Guestfs->new ();
5755 Create a new guestfs handle.
5761 my $class = ref ($proto) || $proto;
5763 my $self = Sys::Guestfs::_create ();
5764 bless $self, $class;
5770 (* Actions. We only need to print documentation for these as
5771 * they are pulled in from the XS code automatically.
5774 fun (name, style, _, flags, _, _, longdesc) ->
5775 if not (List.mem NotInDocs flags) then (
5776 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5778 generate_perl_prototype name style;
5780 pr "%s\n\n" longdesc;
5781 if List.mem ProtocolLimitWarning flags then
5782 pr "%s\n\n" protocol_limit_warning;
5783 if List.mem DangerWillRobinson flags then
5784 pr "%s\n\n" danger_will_robinson
5786 ) all_functions_sorted;
5798 Copyright (C) 2009 Red Hat Inc.
5802 Please see the file COPYING.LIB for the full license.
5806 L<guestfs(3)>, L<guestfish(1)>.
5811 and generate_perl_prototype name style =
5812 (match fst style with
5818 | RString n -> pr "$%s = " n
5819 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5823 | RLVList n -> pr "@%s = " n
5826 | RHashtable n -> pr "%%%s = " n
5829 let comma = ref false in
5832 if !comma then pr ", ";
5835 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5842 (* Generate Python C module. *)
5843 and generate_python_c () =
5844 generate_header CStyle LGPLv2;
5853 #include \"guestfs.h\"
5861 get_handle (PyObject *obj)
5864 assert (obj != Py_None);
5865 return ((Pyguestfs_Object *) obj)->g;
5869 put_handle (guestfs_h *g)
5873 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5876 /* This list should be freed (but not the strings) after use. */
5877 static const char **
5878 get_string_list (PyObject *obj)
5885 if (!PyList_Check (obj)) {
5886 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5890 len = PyList_Size (obj);
5891 r = malloc (sizeof (char *) * (len+1));
5893 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5897 for (i = 0; i < len; ++i)
5898 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5905 put_string_list (char * const * const argv)
5910 for (argc = 0; argv[argc] != NULL; ++argc)
5913 list = PyList_New (argc);
5914 for (i = 0; i < argc; ++i)
5915 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5921 put_table (char * const * const argv)
5923 PyObject *list, *item;
5926 for (argc = 0; argv[argc] != NULL; ++argc)
5929 list = PyList_New (argc >> 1);
5930 for (i = 0; i < argc; i += 2) {
5931 item = PyTuple_New (2);
5932 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5933 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5934 PyList_SetItem (list, i >> 1, item);
5941 free_strings (char **argv)
5945 for (argc = 0; argv[argc] != NULL; ++argc)
5951 py_guestfs_create (PyObject *self, PyObject *args)
5955 g = guestfs_create ();
5957 PyErr_SetString (PyExc_RuntimeError,
5958 \"guestfs.create: failed to allocate handle\");
5961 guestfs_set_error_handler (g, NULL, NULL);
5962 return put_handle (g);
5966 py_guestfs_close (PyObject *self, PyObject *args)
5971 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5973 g = get_handle (py_g);
5977 Py_INCREF (Py_None);
5983 (* LVM structures, turned into Python dictionaries. *)
5986 pr "static PyObject *\n";
5987 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5989 pr " PyObject *dict;\n";
5991 pr " dict = PyDict_New ();\n";
5995 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5996 pr " PyString_FromString (%s->%s));\n"
5999 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6000 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6003 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6004 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6007 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6008 pr " PyLong_FromLongLong (%s->%s));\n"
6010 | name, `OptPercent ->
6011 pr " if (%s->%s >= 0)\n" typ name;
6012 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6013 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6016 pr " Py_INCREF (Py_None);\n";
6017 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6020 pr " return dict;\n";
6024 pr "static PyObject *\n";
6025 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
6027 pr " PyObject *list;\n";
6030 pr " list = PyList_New (%ss->len);\n" typ;
6031 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6032 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
6033 pr " return list;\n";
6036 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
6038 (* Stat structures, turned into Python dictionaries. *)
6041 pr "static PyObject *\n";
6042 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6044 pr " PyObject *dict;\n";
6046 pr " dict = PyDict_New ();\n";
6050 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6051 pr " PyLong_FromLongLong (%s->%s));\n"
6054 pr " return dict;\n";
6057 ) ["stat", stat_cols; "statvfs", statvfs_cols];
6059 (* Python wrapper functions. *)
6061 fun (name, style, _, _, _, _, _) ->
6062 pr "static PyObject *\n";
6063 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6066 pr " PyObject *py_g;\n";
6067 pr " guestfs_h *g;\n";
6068 pr " PyObject *py_r;\n";
6071 match fst style with
6072 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6073 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6074 | RConstString _ -> pr " const char *r;\n"; "NULL"
6075 | RString _ -> pr " char *r;\n"; "NULL"
6076 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6077 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6078 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6079 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6080 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6081 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6082 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6086 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6087 | OptString n -> pr " const char *%s;\n" n
6089 pr " PyObject *py_%s;\n" n;
6090 pr " const char **%s;\n" n
6091 | Bool n -> pr " int %s;\n" n
6092 | Int n -> pr " int %s;\n" n
6097 (* Convert the parameters. *)
6098 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6101 | String _ | FileIn _ | FileOut _ -> pr "s"
6102 | OptString _ -> pr "z"
6103 | StringList _ -> pr "O"
6104 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6107 pr ":guestfs_%s\",\n" name;
6111 | String n | FileIn n | FileOut n -> pr ", &%s" n
6112 | OptString n -> pr ", &%s" n
6113 | StringList n -> pr ", &py_%s" n
6114 | Bool n -> pr ", &%s" n
6115 | Int n -> pr ", &%s" n
6119 pr " return NULL;\n";
6121 pr " g = get_handle (py_g);\n";
6124 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6126 pr " %s = get_string_list (py_%s);\n" n n;
6127 pr " if (!%s) return NULL;\n" n
6132 pr " r = guestfs_%s " name;
6133 generate_call_args ~handle:"g" (snd style);
6138 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6140 pr " free (%s);\n" n
6143 pr " if (r == %s) {\n" error_code;
6144 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6145 pr " return NULL;\n";
6149 (match fst style with
6151 pr " Py_INCREF (Py_None);\n";
6152 pr " py_r = Py_None;\n"
6154 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6155 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6156 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6158 pr " py_r = PyString_FromString (r);\n";
6161 pr " py_r = put_string_list (r);\n";
6162 pr " free_strings (r);\n"
6164 pr " py_r = PyTuple_New (2);\n";
6165 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
6166 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
6167 pr " guestfs_free_int_bool (r);\n"
6169 pr " py_r = put_lvm_pv_list (r);\n";
6170 pr " guestfs_free_lvm_pv_list (r);\n"
6172 pr " py_r = put_lvm_vg_list (r);\n";
6173 pr " guestfs_free_lvm_vg_list (r);\n"
6175 pr " py_r = put_lvm_lv_list (r);\n";
6176 pr " guestfs_free_lvm_lv_list (r);\n"
6178 pr " py_r = put_stat (r);\n";
6181 pr " py_r = put_statvfs (r);\n";
6184 pr " py_r = put_table (r);\n";
6185 pr " free_strings (r);\n"
6188 pr " return py_r;\n";
6193 (* Table of functions. *)
6194 pr "static PyMethodDef methods[] = {\n";
6195 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6196 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6198 fun (name, _, _, _, _, _, _) ->
6199 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6202 pr " { NULL, NULL, 0, NULL }\n";
6206 (* Init function. *)
6209 initlibguestfsmod (void)
6211 static int initialized = 0;
6213 if (initialized) return;
6214 Py_InitModule ((char *) \"libguestfsmod\", methods);
6219 (* Generate Python module. *)
6220 and generate_python_py () =
6221 generate_header HashStyle LGPLv2;
6224 u\"\"\"Python bindings for libguestfs
6227 g = guestfs.GuestFS ()
6228 g.add_drive (\"guest.img\")
6231 parts = g.list_partitions ()
6233 The guestfs module provides a Python binding to the libguestfs API
6234 for examining and modifying virtual machine disk images.
6236 Amongst the things this is good for: making batch configuration
6237 changes to guests, getting disk used/free statistics (see also:
6238 virt-df), migrating between virtualization systems (see also:
6239 virt-p2v), performing partial backups, performing partial guest
6240 clones, cloning guests and changing registry/UUID/hostname info, and
6243 Libguestfs uses Linux kernel and qemu code, and can access any type of
6244 guest filesystem that Linux and qemu can, including but not limited
6245 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6246 schemes, qcow, qcow2, vmdk.
6248 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6249 LVs, what filesystem is in each LV, etc.). It can also run commands
6250 in the context of the guest. Also you can access filesystems over FTP.
6252 Errors which happen while using the API are turned into Python
6253 RuntimeError exceptions.
6255 To create a guestfs handle you usually have to perform the following
6258 # Create the handle, call add_drive at least once, and possibly
6259 # several times if the guest has multiple block devices:
6260 g = guestfs.GuestFS ()
6261 g.add_drive (\"guest.img\")
6263 # Launch the qemu subprocess and wait for it to become ready:
6267 # Now you can issue commands, for example:
6272 import libguestfsmod
6275 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6277 def __init__ (self):
6278 \"\"\"Create a new libguestfs handle.\"\"\"
6279 self._o = libguestfsmod.create ()
6282 libguestfsmod.close (self._o)
6287 fun (name, style, _, flags, _, _, longdesc) ->
6289 generate_call_args ~handle:"self" (snd style);
6292 if not (List.mem NotInDocs flags) then (
6293 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6295 match fst style with
6296 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6299 doc ^ "\n\nThis function returns a list of strings."
6301 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
6303 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
6305 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
6307 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
6309 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
6311 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
6313 doc ^ "\n\nThis function returns a dictionary." in
6315 if List.mem ProtocolLimitWarning flags then
6316 doc ^ "\n\n" ^ protocol_limit_warning
6319 if List.mem DangerWillRobinson flags then
6320 doc ^ "\n\n" ^ danger_will_robinson
6322 let doc = pod2text ~width:60 name doc in
6323 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6324 let doc = String.concat "\n " doc in
6325 pr " u\"\"\"%s\"\"\"\n" doc;
6327 pr " return libguestfsmod.%s " name;
6328 generate_call_args ~handle:"self._o" (snd style);
6333 (* Useful if you need the longdesc POD text as plain text. Returns a
6336 * This is the slowest thing about autogeneration.
6338 and pod2text ~width name longdesc =
6339 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6340 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6342 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6343 let chan = Unix.open_process_in cmd in
6344 let lines = ref [] in
6346 let line = input_line chan in
6347 if i = 1 then (* discard the first line of output *)
6350 let line = triml line in
6351 lines := line :: !lines;
6354 let lines = try loop 1 with End_of_file -> List.rev !lines in
6355 Unix.unlink filename;
6356 match Unix.close_process_in chan with
6357 | Unix.WEXITED 0 -> lines
6359 failwithf "pod2text: process exited with non-zero status (%d)" i
6360 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6361 failwithf "pod2text: process signalled or stopped by signal %d" i
6363 (* Generate ruby bindings. *)
6364 and generate_ruby_c () =
6365 generate_header CStyle LGPLv2;
6373 #include \"guestfs.h\"
6375 #include \"extconf.h\"
6377 /* For Ruby < 1.9 */
6379 #define RARRAY_LEN(r) (RARRAY((r))->len)
6382 static VALUE m_guestfs; /* guestfs module */
6383 static VALUE c_guestfs; /* guestfs_h handle */
6384 static VALUE e_Error; /* used for all errors */
6386 static void ruby_guestfs_free (void *p)
6389 guestfs_close ((guestfs_h *) p);
6392 static VALUE ruby_guestfs_create (VALUE m)
6396 g = guestfs_create ();
6398 rb_raise (e_Error, \"failed to create guestfs handle\");
6400 /* Don't print error messages to stderr by default. */
6401 guestfs_set_error_handler (g, NULL, NULL);
6403 /* Wrap it, and make sure the close function is called when the
6406 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6409 static VALUE ruby_guestfs_close (VALUE gv)
6412 Data_Get_Struct (gv, guestfs_h, g);
6414 ruby_guestfs_free (g);
6415 DATA_PTR (gv) = NULL;
6423 fun (name, style, _, _, _, _, _) ->
6424 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6425 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6428 pr " guestfs_h *g;\n";
6429 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6431 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6437 | String n | FileIn n | FileOut n ->
6438 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6440 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6441 pr " \"%s\", \"%s\");\n" n name
6443 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6447 pr " int i, len;\n";
6448 pr " len = RARRAY_LEN (%sv);\n" n;
6449 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6451 pr " for (i = 0; i < len; ++i) {\n";
6452 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6453 pr " %s[i] = StringValueCStr (v);\n" n;
6455 pr " %s[len] = NULL;\n" n;
6458 pr " int %s = RTEST (%sv);\n" n n
6460 pr " int %s = NUM2INT (%sv);\n" n n
6465 match fst style with
6466 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6467 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6468 | RConstString _ -> pr " const char *r;\n"; "NULL"
6469 | RString _ -> pr " char *r;\n"; "NULL"
6470 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6471 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6472 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6473 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6474 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6475 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6476 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6479 pr " r = guestfs_%s " name;
6480 generate_call_args ~handle:"g" (snd style);
6485 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6487 pr " free (%s);\n" n
6490 pr " if (r == %s)\n" error_code;
6491 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6494 (match fst style with
6496 pr " return Qnil;\n"
6497 | RInt _ | RBool _ ->
6498 pr " return INT2NUM (r);\n"
6500 pr " return ULL2NUM (r);\n"
6502 pr " return rb_str_new2 (r);\n";
6504 pr " VALUE rv = rb_str_new2 (r);\n";
6508 pr " int i, len = 0;\n";
6509 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6510 pr " VALUE rv = rb_ary_new2 (len);\n";
6511 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6512 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6513 pr " free (r[i]);\n";
6518 pr " VALUE rv = rb_ary_new2 (2);\n";
6519 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
6520 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
6521 pr " guestfs_free_int_bool (r);\n";
6524 generate_ruby_lvm_code "pv" pv_cols
6526 generate_ruby_lvm_code "vg" vg_cols
6528 generate_ruby_lvm_code "lv" lv_cols
6530 pr " VALUE rv = rb_hash_new ();\n";
6534 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6539 pr " VALUE rv = rb_hash_new ();\n";
6543 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6548 pr " VALUE rv = rb_hash_new ();\n";
6550 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
6551 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6552 pr " free (r[i]);\n";
6553 pr " free (r[i+1]);\n";
6564 /* Initialize the module. */
6565 void Init__guestfs ()
6567 m_guestfs = rb_define_module (\"Guestfs\");
6568 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6569 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6571 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6572 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6575 (* Define the rest of the methods. *)
6577 fun (name, style, _, _, _, _, _) ->
6578 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
6579 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6584 (* Ruby code to return an LVM struct list. *)
6585 and generate_ruby_lvm_code typ cols =
6586 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6588 pr " for (i = 0; i < r->len; ++i) {\n";
6589 pr " VALUE hv = rb_hash_new ();\n";
6593 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6595 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6598 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6599 | name, `OptPercent ->
6600 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6602 pr " rb_ary_push (rv, hv);\n";
6604 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6607 (* Generate Java bindings GuestFS.java file. *)
6608 and generate_java_java () =
6609 generate_header CStyle LGPLv2;
6612 package com.redhat.et.libguestfs;
6614 import java.util.HashMap;
6615 import com.redhat.et.libguestfs.LibGuestFSException;
6616 import com.redhat.et.libguestfs.PV;
6617 import com.redhat.et.libguestfs.VG;
6618 import com.redhat.et.libguestfs.LV;
6619 import com.redhat.et.libguestfs.Stat;
6620 import com.redhat.et.libguestfs.StatVFS;
6621 import com.redhat.et.libguestfs.IntBool;
6624 * The GuestFS object is a libguestfs handle.
6628 public class GuestFS {
6629 // Load the native code.
6631 System.loadLibrary (\"guestfs_jni\");
6635 * The native guestfs_h pointer.
6640 * Create a libguestfs handle.
6642 * @throws LibGuestFSException
6644 public GuestFS () throws LibGuestFSException
6648 private native long _create () throws LibGuestFSException;
6651 * Close a libguestfs handle.
6653 * You can also leave handles to be collected by the garbage
6654 * collector, but this method ensures that the resources used
6655 * by the handle are freed up immediately. If you call any
6656 * other methods after closing the handle, you will get an
6659 * @throws LibGuestFSException
6661 public void close () throws LibGuestFSException
6667 private native void _close (long g) throws LibGuestFSException;
6669 public void finalize () throws LibGuestFSException
6677 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6678 if not (List.mem NotInDocs flags); then (
6679 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6681 if List.mem ProtocolLimitWarning flags then
6682 doc ^ "\n\n" ^ protocol_limit_warning
6685 if List.mem DangerWillRobinson flags then
6686 doc ^ "\n\n" ^ danger_will_robinson
6688 let doc = pod2text ~width:60 name doc in
6689 let doc = List.map ( (* RHBZ#501883 *)
6692 | nonempty -> nonempty
6694 let doc = String.concat "\n * " doc in
6697 pr " * %s\n" shortdesc;
6700 pr " * @throws LibGuestFSException\n";
6704 generate_java_prototype ~public:true ~semicolon:false name style;
6707 pr " if (g == 0)\n";
6708 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6711 if fst style <> RErr then pr "return ";
6713 generate_call_args ~handle:"g" (snd style);
6717 generate_java_prototype ~privat:true ~native:true name style;
6724 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6725 ?(semicolon=true) name style =
6726 if privat then pr "private ";
6727 if public then pr "public ";
6728 if native then pr "native ";
6731 (match fst style with
6732 | RErr -> pr "void ";
6733 | RInt _ -> pr "int ";
6734 | RInt64 _ -> pr "long ";
6735 | RBool _ -> pr "boolean ";
6736 | RConstString _ | RString _ -> pr "String ";
6737 | RStringList _ -> pr "String[] ";
6738 | RIntBool _ -> pr "IntBool ";
6739 | RPVList _ -> pr "PV[] ";
6740 | RVGList _ -> pr "VG[] ";
6741 | RLVList _ -> pr "LV[] ";
6742 | RStat _ -> pr "Stat ";
6743 | RStatVFS _ -> pr "StatVFS ";
6744 | RHashtable _ -> pr "HashMap<String,String> ";
6747 if native then pr "_%s " name else pr "%s " name;
6749 let needs_comma = ref false in
6758 if !needs_comma then pr ", ";
6759 needs_comma := true;
6776 pr " throws LibGuestFSException";
6777 if semicolon then pr ";"
6779 and generate_java_struct typ cols =
6780 generate_header CStyle LGPLv2;
6783 package com.redhat.et.libguestfs;
6786 * Libguestfs %s structure.
6797 | name, `UUID -> pr " public String %s;\n" name
6799 | name, `Int -> pr " public long %s;\n" name
6800 | name, `OptPercent ->
6801 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6802 pr " public float %s;\n" name
6807 and generate_java_c () =
6808 generate_header CStyle LGPLv2;
6815 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6816 #include \"guestfs.h\"
6818 /* Note that this function returns. The exception is not thrown
6819 * until after the wrapper function returns.
6822 throw_exception (JNIEnv *env, const char *msg)
6825 cl = (*env)->FindClass (env,
6826 \"com/redhat/et/libguestfs/LibGuestFSException\");
6827 (*env)->ThrowNew (env, cl, msg);
6830 JNIEXPORT jlong JNICALL
6831 Java_com_redhat_et_libguestfs_GuestFS__1create
6832 (JNIEnv *env, jobject obj)
6836 g = guestfs_create ();
6838 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6841 guestfs_set_error_handler (g, NULL, NULL);
6842 return (jlong) (long) g;
6845 JNIEXPORT void JNICALL
6846 Java_com_redhat_et_libguestfs_GuestFS__1close
6847 (JNIEnv *env, jobject obj, jlong jg)
6849 guestfs_h *g = (guestfs_h *) (long) jg;
6856 fun (name, style, _, _, _, _, _) ->
6858 (match fst style with
6859 | RErr -> pr "void ";
6860 | RInt _ -> pr "jint ";
6861 | RInt64 _ -> pr "jlong ";
6862 | RBool _ -> pr "jboolean ";
6863 | RConstString _ | RString _ -> pr "jstring ";
6864 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6866 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6870 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6871 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6873 pr " (JNIEnv *env, jobject obj, jlong jg";
6880 pr ", jstring j%s" n
6882 pr ", jobjectArray j%s" n
6884 pr ", jboolean j%s" n
6890 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6891 let error_code, no_ret =
6892 match fst style with
6893 | RErr -> pr " int r;\n"; "-1", ""
6895 | RInt _ -> pr " int r;\n"; "-1", "0"
6896 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6897 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6899 pr " jstring jr;\n";
6900 pr " char *r;\n"; "NULL", "NULL"
6902 pr " jobjectArray jr;\n";
6905 pr " jstring jstr;\n";
6906 pr " char **r;\n"; "NULL", "NULL"
6908 pr " jobject jr;\n";
6910 pr " jfieldID fl;\n";
6911 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6913 pr " jobject jr;\n";
6915 pr " jfieldID fl;\n";
6916 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6918 pr " jobject jr;\n";
6920 pr " jfieldID fl;\n";
6921 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6923 pr " jobjectArray jr;\n";
6925 pr " jfieldID fl;\n";
6926 pr " jobject jfl;\n";
6927 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6929 pr " jobjectArray jr;\n";
6931 pr " jfieldID fl;\n";
6932 pr " jobject jfl;\n";
6933 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6935 pr " jobjectArray jr;\n";
6937 pr " jfieldID fl;\n";
6938 pr " jobject jfl;\n";
6939 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6940 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6947 pr " const char *%s;\n" n
6949 pr " int %s_len;\n" n;
6950 pr " const char **%s;\n" n
6957 (match fst style with
6958 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6959 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6960 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6961 | RHashtable _ -> false) ||
6962 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6968 (* Get the parameters. *)
6974 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6976 (* This is completely undocumented, but Java null becomes
6979 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
6981 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6982 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6983 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6984 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6986 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6988 pr " %s[%s_len] = NULL;\n" n n;
6991 pr " %s = j%s;\n" n n
6994 (* Make the call. *)
6995 pr " r = guestfs_%s " name;
6996 generate_call_args ~handle:"g" (snd style);
6999 (* Release the parameters. *)
7005 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7008 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7010 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7011 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7013 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7015 pr " free (%s);\n" n
7020 (* Check for errors. *)
7021 pr " if (r == %s) {\n" error_code;
7022 pr " throw_exception (env, guestfs_last_error (g));\n";
7023 pr " return %s;\n" no_ret;
7027 (match fst style with
7029 | RInt _ -> pr " return (jint) r;\n"
7030 | RBool _ -> pr " return (jboolean) r;\n"
7031 | RInt64 _ -> pr " return (jlong) r;\n"
7032 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7034 pr " jr = (*env)->NewStringUTF (env, r);\n";
7038 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7039 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7040 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7041 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7042 pr " for (i = 0; i < r_len; ++i) {\n";
7043 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7044 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7045 pr " free (r[i]);\n";
7050 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
7051 pr " jr = (*env)->AllocObject (env, cl);\n";
7052 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
7053 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
7054 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
7055 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
7056 pr " guestfs_free_int_bool (r);\n";
7059 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
7060 pr " jr = (*env)->AllocObject (env, cl);\n";
7064 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7066 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7071 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
7072 pr " jr = (*env)->AllocObject (env, cl);\n";
7076 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7078 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7083 generate_java_lvm_return "pv" "PV" pv_cols
7085 generate_java_lvm_return "vg" "VG" vg_cols
7087 generate_java_lvm_return "lv" "LV" lv_cols
7090 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7091 pr " return NULL;\n"
7098 and generate_java_lvm_return typ jtyp cols =
7099 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7100 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7101 pr " for (i = 0; i < r->len; ++i) {\n";
7102 pr " jfl = (*env)->AllocObject (env, cl);\n";
7106 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7107 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7110 pr " char s[33];\n";
7111 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7113 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7114 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7116 | name, (`Bytes|`Int) ->
7117 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7118 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7119 | name, `OptPercent ->
7120 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7121 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7123 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7125 pr " guestfs_free_lvm_%s_list (r);\n" typ;
7128 and generate_haskell_hs () =
7129 generate_header HaskellStyle LGPLv2;
7131 (* XXX We only know how to generate partial FFI for Haskell
7132 * at the moment. Please help out!
7134 let can_generate style =
7135 let check_no_bad_args =
7136 List.for_all (function Bool _ | Int _ -> false | _ -> true)
7139 | RErr, args -> check_no_bad_args args
7152 | RHashtable _, _ -> false in
7155 {-# INCLUDE <guestfs.h> #-}
7156 {-# LANGUAGE ForeignFunctionInterface #-}
7161 (* List out the names of the actions we want to export. *)
7163 fun (name, style, _, _, _, _, _) ->
7164 if can_generate style then pr ",\n %s" name
7172 import Control.Exception
7173 import Data.Typeable
7175 data GuestfsS = GuestfsS -- represents the opaque C struct
7176 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7177 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7179 -- XXX define properly later XXX
7183 data IntBool = IntBool
7185 data StatVFS = StatVFS
7186 data Hashtable = Hashtable
7188 foreign import ccall unsafe \"guestfs_create\" c_create
7190 foreign import ccall unsafe \"&guestfs_close\" c_close
7191 :: FunPtr (GuestfsP -> IO ())
7192 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7193 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7195 create :: IO GuestfsH
7198 c_set_error_handler p nullPtr nullPtr
7199 h <- newForeignPtr c_close p
7202 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7203 :: GuestfsP -> IO CString
7205 -- last_error :: GuestfsH -> IO (Maybe String)
7206 -- last_error h = do
7207 -- str <- withForeignPtr h (\\p -> c_last_error p)
7208 -- maybePeek peekCString str
7210 last_error :: GuestfsH -> IO (String)
7212 str <- withForeignPtr h (\\p -> c_last_error p)
7214 then return \"no error\"
7215 else peekCString str
7219 (* Generate wrappers for each foreign function. *)
7221 fun (name, style, _, _, _, _, _) ->
7222 if can_generate style then (
7223 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7225 generate_haskell_prototype ~handle:"GuestfsP" style;
7229 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7231 pr "%s %s = do\n" name
7232 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7238 | String n -> pr "withCString %s $ \\%s -> " n n
7239 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7240 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7242 (* XXX this doesn't work *)
7244 pr " %s = case %s of\n" n n;
7247 pr " in fromIntegral %s $ \\%s ->\n" n n
7248 | Int n -> pr "fromIntegral %s $ \\%s -> " n n
7250 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7251 (String.concat " " ("p" :: List.map name_of_argt (snd style)));
7252 (match fst style with
7253 | RErr | RInt _ | RInt64 _ | RBool _ ->
7254 pr " if (r == -1)\n";
7256 pr " err <- last_error h\n";
7258 | RConstString _ | RString _ | RStringList _ | RIntBool _
7259 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7261 pr " if (r == nullPtr)\n";
7263 pr " err <- last_error h\n";
7266 (match fst style with
7268 pr " else return ()\n"
7270 pr " else return (fromIntegral r)\n"
7272 pr " else return (fromIntegral r)\n"
7274 pr " else return (toBool r)\n"
7285 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7291 and generate_haskell_prototype ~handle ?(hs = false) style =
7293 let string = if hs then "String" else "CString" in
7294 let int = if hs then "Int" else "CInt" in
7295 let bool = if hs then "Bool" else "CInt" in
7296 let int64 = if hs then "Integer" else "Int64" in
7300 | String _ -> pr "%s" string
7301 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7302 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7303 | Bool _ -> pr "%s" bool
7304 | Int _ -> pr "%s" int
7305 | FileIn _ -> pr "%s" string
7306 | FileOut _ -> pr "%s" string
7311 (match fst style with
7312 | RErr -> if not hs then pr "CInt"
7313 | RInt _ -> pr "%s" int
7314 | RInt64 _ -> pr "%s" int64
7315 | RBool _ -> pr "%s" bool
7316 | RConstString _ -> pr "%s" string
7317 | RString _ -> pr "%s" string
7318 | RStringList _ -> pr "[%s]" string
7319 | RIntBool _ -> pr "IntBool"
7320 | RPVList _ -> pr "[PV]"
7321 | RVGList _ -> pr "[VG]"
7322 | RLVList _ -> pr "[LV]"
7323 | RStat _ -> pr "Stat"
7324 | RStatVFS _ -> pr "StatVFS"
7325 | RHashtable _ -> pr "Hashtable"
7329 and generate_bindtests () =
7330 generate_header CStyle LGPLv2;
7335 #include <inttypes.h>
7338 #include \"guestfs.h\"
7339 #include \"guestfs_protocol.h\"
7341 #define error guestfs_error
7344 print_strings (char * const* const argv)
7349 for (argc = 0; argv[argc] != NULL; ++argc) {
7350 if (argc > 0) printf (\", \");
7351 printf (\"\\\"%%s\\\"\", argv[argc]);
7356 /* The test0 function prints its parameters to stdout. */
7360 match test_functions with
7361 | [] -> assert false
7362 | test0 :: tests -> test0, tests in
7365 let (name, style, _, _, _, _, _) = test0 in
7366 generate_prototype ~extern:false ~semicolon:false ~newline:true
7367 ~handle:"g" ~prefix:"guestfs_" name style;
7373 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
7374 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7375 | StringList n -> pr " print_strings (%s);\n" n
7376 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7377 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
7379 pr " /* Java changes stdout line buffering so we need this: */\n";
7380 pr " fflush (stdout);\n";
7386 fun (name, style, _, _, _, _, _) ->
7387 if String.sub name (String.length name - 3) 3 <> "err" then (
7388 pr "/* Test normal return. */\n";
7389 generate_prototype ~extern:false ~semicolon:false ~newline:true
7390 ~handle:"g" ~prefix:"guestfs_" name style;
7392 (match fst style with
7397 pr " sscanf (val, \"%%d\", &r);\n";
7401 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
7404 pr " return strcmp (val, \"true\") == 0;\n"
7406 (* Can't return the input string here. Return a static
7407 * string so we ensure we get a segfault if the caller
7410 pr " return \"static string\";\n"
7412 pr " return strdup (val);\n"
7414 pr " char **strs;\n";
7416 pr " sscanf (val, \"%%d\", &n);\n";
7417 pr " strs = malloc ((n+1) * sizeof (char *));\n";
7418 pr " for (i = 0; i < n; ++i) {\n";
7419 pr " strs[i] = malloc (16);\n";
7420 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
7422 pr " strs[n] = NULL;\n";
7423 pr " return strs;\n"
7425 pr " struct guestfs_int_bool *r;\n";
7426 pr " r = malloc (sizeof (struct guestfs_int_bool));\n";
7427 pr " sscanf (val, \"%%\" SCNi32, &r->i);\n";
7431 pr " struct guestfs_lvm_pv_list *r;\n";
7433 pr " r = malloc (sizeof (struct guestfs_lvm_pv_list));\n";
7434 pr " sscanf (val, \"%%d\", &r->len);\n";
7435 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_pv));\n";
7436 pr " for (i = 0; i < r->len; ++i) {\n";
7437 pr " r->val[i].pv_name = malloc (16);\n";
7438 pr " snprintf (r->val[i].pv_name, 16, \"%%d\", i);\n";
7442 pr " struct guestfs_lvm_vg_list *r;\n";
7444 pr " r = malloc (sizeof (struct guestfs_lvm_vg_list));\n";
7445 pr " sscanf (val, \"%%d\", &r->len);\n";
7446 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_vg));\n";
7447 pr " for (i = 0; i < r->len; ++i) {\n";
7448 pr " r->val[i].vg_name = malloc (16);\n";
7449 pr " snprintf (r->val[i].vg_name, 16, \"%%d\", i);\n";
7453 pr " struct guestfs_lvm_lv_list *r;\n";
7455 pr " r = malloc (sizeof (struct guestfs_lvm_lv_list));\n";
7456 pr " sscanf (val, \"%%d\", &r->len);\n";
7457 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_lv));\n";
7458 pr " for (i = 0; i < r->len; ++i) {\n";
7459 pr " r->val[i].lv_name = malloc (16);\n";
7460 pr " snprintf (r->val[i].lv_name, 16, \"%%d\", i);\n";
7464 pr " struct guestfs_stat *r;\n";
7465 pr " r = calloc (1, sizeof (*r));\n";
7466 pr " sscanf (val, \"%%\" SCNi64, &r->dev);\n";
7469 pr " struct guestfs_statvfs *r;\n";
7470 pr " r = calloc (1, sizeof (*r));\n";
7471 pr " sscanf (val, \"%%\" SCNi64, &r->bsize);\n";
7474 pr " char **strs;\n";
7476 pr " sscanf (val, \"%%d\", &n);\n";
7477 pr " strs = malloc ((n*2+1) * sizeof (char *));\n";
7478 pr " for (i = 0; i < n; ++i) {\n";
7479 pr " strs[i*2] = malloc (16);\n";
7480 pr " strs[i*2+1] = malloc (16);\n";
7481 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
7482 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7484 pr " strs[n*2] = NULL;\n";
7485 pr " return strs;\n"
7490 pr "/* Test error return. */\n";
7491 generate_prototype ~extern:false ~semicolon:false ~newline:true
7492 ~handle:"g" ~prefix:"guestfs_" name style;
7494 pr " error (g, \"error\");\n";
7495 (match fst style with
7496 | RErr | RInt _ | RInt64 _ | RBool _ ->
7499 | RString _ | RStringList _ | RIntBool _
7500 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7502 pr " return NULL;\n"
7509 and generate_ocaml_bindtests () =
7510 generate_header OCamlStyle GPLv2;
7514 let g = Guestfs.create () in
7521 | CallString s -> "\"" ^ s ^ "\""
7522 | CallOptString None -> "None"
7523 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7524 | CallStringList xs ->
7525 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7526 | CallInt i when i >= 0 -> string_of_int i
7527 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7528 | CallBool b -> string_of_bool b
7533 generate_lang_bindtests (
7534 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
7537 pr "print_endline \"EOF\"\n"
7539 and generate_perl_bindtests () =
7540 pr "#!/usr/bin/perl -w\n";
7541 generate_header HashStyle GPLv2;
7548 my $g = Sys::Guestfs->new ();
7552 String.concat ", " (
7555 | CallString s -> "\"" ^ s ^ "\""
7556 | CallOptString None -> "undef"
7557 | CallOptString (Some s) -> sprintf "\"%s\"" s
7558 | CallStringList xs ->
7559 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7560 | CallInt i -> string_of_int i
7561 | CallBool b -> if b then "1" else "0"
7566 generate_lang_bindtests (
7567 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7570 pr "print \"EOF\\n\"\n"
7572 and generate_python_bindtests () =
7573 generate_header HashStyle GPLv2;
7578 g = guestfs.GuestFS ()
7582 String.concat ", " (
7585 | CallString s -> "\"" ^ s ^ "\""
7586 | CallOptString None -> "None"
7587 | CallOptString (Some s) -> sprintf "\"%s\"" s
7588 | CallStringList xs ->
7589 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7590 | CallInt i -> string_of_int i
7591 | CallBool b -> if b then "1" else "0"
7596 generate_lang_bindtests (
7597 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
7600 pr "print \"EOF\"\n"
7602 and generate_ruby_bindtests () =
7603 generate_header HashStyle GPLv2;
7608 g = Guestfs::create()
7612 String.concat ", " (
7615 | CallString s -> "\"" ^ s ^ "\""
7616 | CallOptString None -> "nil"
7617 | CallOptString (Some s) -> sprintf "\"%s\"" s
7618 | CallStringList xs ->
7619 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7620 | CallInt i -> string_of_int i
7621 | CallBool b -> string_of_bool b
7626 generate_lang_bindtests (
7627 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
7630 pr "print \"EOF\\n\"\n"
7632 and generate_java_bindtests () =
7633 generate_header CStyle GPLv2;
7636 import com.redhat.et.libguestfs.*;
7638 public class Bindtests {
7639 public static void main (String[] argv)
7642 GuestFS g = new GuestFS ();
7646 String.concat ", " (
7649 | CallString s -> "\"" ^ s ^ "\""
7650 | CallOptString None -> "null"
7651 | CallOptString (Some s) -> sprintf "\"%s\"" s
7652 | CallStringList xs ->
7654 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
7655 | CallInt i -> string_of_int i
7656 | CallBool b -> string_of_bool b
7661 generate_lang_bindtests (
7662 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
7666 System.out.println (\"EOF\");
7668 catch (Exception exn) {
7669 System.err.println (exn);
7676 and generate_haskell_bindtests () =
7677 () (* XXX Haskell bindings need to be fleshed out. *)
7679 (* Language-independent bindings tests - we do it this way to
7680 * ensure there is parity in testing bindings across all languages.
7682 and generate_lang_bindtests call =
7683 call "test0" [CallString "abc"; CallOptString (Some "def");
7684 CallStringList []; CallBool false;
7685 CallInt 0; CallString "123"; CallString "456"];
7686 call "test0" [CallString "abc"; CallOptString None;
7687 CallStringList []; CallBool false;
7688 CallInt 0; CallString "123"; CallString "456"];
7689 call "test0" [CallString ""; CallOptString (Some "def");
7690 CallStringList []; CallBool false;
7691 CallInt 0; CallString "123"; CallString "456"];
7692 call "test0" [CallString ""; CallOptString (Some "");
7693 CallStringList []; CallBool false;
7694 CallInt 0; CallString "123"; CallString "456"];
7695 call "test0" [CallString "abc"; CallOptString (Some "def");
7696 CallStringList ["1"]; CallBool false;
7697 CallInt 0; CallString "123"; CallString "456"];
7698 call "test0" [CallString "abc"; CallOptString (Some "def");
7699 CallStringList ["1"; "2"]; CallBool false;
7700 CallInt 0; CallString "123"; CallString "456"];
7701 call "test0" [CallString "abc"; CallOptString (Some "def");
7702 CallStringList ["1"]; CallBool true;
7703 CallInt 0; CallString "123"; CallString "456"];
7704 call "test0" [CallString "abc"; CallOptString (Some "def");
7705 CallStringList ["1"]; CallBool false;
7706 CallInt (-1); CallString "123"; CallString "456"];
7707 call "test0" [CallString "abc"; CallOptString (Some "def");
7708 CallStringList ["1"]; CallBool false;
7709 CallInt (-2); CallString "123"; CallString "456"];
7710 call "test0" [CallString "abc"; CallOptString (Some "def");
7711 CallStringList ["1"]; CallBool false;
7712 CallInt 1; CallString "123"; CallString "456"];
7713 call "test0" [CallString "abc"; CallOptString (Some "def");
7714 CallStringList ["1"]; CallBool false;
7715 CallInt 2; CallString "123"; CallString "456"];
7716 call "test0" [CallString "abc"; CallOptString (Some "def");
7717 CallStringList ["1"]; CallBool false;
7718 CallInt 4095; CallString "123"; CallString "456"];
7719 call "test0" [CallString "abc"; CallOptString (Some "def");
7720 CallStringList ["1"]; CallBool false;
7721 CallInt 0; CallString ""; CallString ""]
7723 (* XXX Add here tests of the return and error functions. *)
7725 let output_to filename =
7726 let filename_new = filename ^ ".new" in
7727 chan := open_out filename_new;
7732 (* Is the new file different from the current file? *)
7733 if Sys.file_exists filename && files_equal filename filename_new then
7734 Unix.unlink filename_new (* same, so skip it *)
7736 (* different, overwrite old one *)
7737 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
7738 Unix.rename filename_new filename;
7739 Unix.chmod filename 0o444;
7740 printf "written %s\n%!" filename;
7749 if not (Sys.file_exists "configure.ac") then (
7751 You are probably running this from the wrong directory.
7752 Run it from the top source directory using the command
7758 let close = output_to "src/guestfs_protocol.x" in
7762 let close = output_to "src/guestfs-structs.h" in
7763 generate_structs_h ();
7766 let close = output_to "src/guestfs-actions.h" in
7767 generate_actions_h ();
7770 let close = output_to "src/guestfs-actions.c" in
7771 generate_client_actions ();
7774 let close = output_to "daemon/actions.h" in
7775 generate_daemon_actions_h ();
7778 let close = output_to "daemon/stubs.c" in
7779 generate_daemon_actions ();
7782 let close = output_to "capitests/tests.c" in
7786 let close = output_to "src/guestfs-bindtests.c" in
7787 generate_bindtests ();
7790 let close = output_to "fish/cmds.c" in
7791 generate_fish_cmds ();
7794 let close = output_to "fish/completion.c" in
7795 generate_fish_completion ();
7798 let close = output_to "guestfs-structs.pod" in
7799 generate_structs_pod ();
7802 let close = output_to "guestfs-actions.pod" in
7803 generate_actions_pod ();
7806 let close = output_to "guestfish-actions.pod" in
7807 generate_fish_actions_pod ();
7810 let close = output_to "ocaml/guestfs.mli" in
7811 generate_ocaml_mli ();
7814 let close = output_to "ocaml/guestfs.ml" in
7815 generate_ocaml_ml ();
7818 let close = output_to "ocaml/guestfs_c_actions.c" in
7819 generate_ocaml_c ();
7822 let close = output_to "ocaml/bindtests.ml" in
7823 generate_ocaml_bindtests ();
7826 let close = output_to "perl/Guestfs.xs" in
7827 generate_perl_xs ();
7830 let close = output_to "perl/lib/Sys/Guestfs.pm" in
7831 generate_perl_pm ();
7834 let close = output_to "perl/bindtests.pl" in
7835 generate_perl_bindtests ();
7838 let close = output_to "python/guestfs-py.c" in
7839 generate_python_c ();
7842 let close = output_to "python/guestfs.py" in
7843 generate_python_py ();
7846 let close = output_to "python/bindtests.py" in
7847 generate_python_bindtests ();
7850 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
7854 let close = output_to "ruby/bindtests.rb" in
7855 generate_ruby_bindtests ();
7858 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
7859 generate_java_java ();
7862 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
7863 generate_java_struct "PV" pv_cols;
7866 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
7867 generate_java_struct "VG" vg_cols;
7870 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
7871 generate_java_struct "LV" lv_cols;
7874 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
7875 generate_java_struct "Stat" stat_cols;
7878 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
7879 generate_java_struct "StatVFS" statvfs_cols;
7882 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
7886 let close = output_to "java/Bindtests.java" in
7887 generate_java_bindtests ();
7890 let close = output_to "haskell/Guestfs.hs" in
7891 generate_haskell_hs ();
7894 let close = output_to "haskell/bindtests.hs" in
7895 generate_haskell_bindtests ();