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 [["mount"; "/dev/sdd"; "/"];
1666 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1667 "compute MD5, SHAx or CRC checksum of file",
1669 This call computes the MD5, SHAx or CRC checksum of the
1672 The type of checksum to compute is given by the C<csumtype>
1673 parameter which must have one of the following values:
1679 Compute the cyclic redundancy check (CRC) specified by POSIX
1680 for the C<cksum> command.
1684 Compute the MD5 hash (using the C<md5sum> program).
1688 Compute the SHA1 hash (using the C<sha1sum> program).
1692 Compute the SHA224 hash (using the C<sha224sum> program).
1696 Compute the SHA256 hash (using the C<sha256sum> program).
1700 Compute the SHA384 hash (using the C<sha384sum> program).
1704 Compute the SHA512 hash (using the C<sha512sum> program).
1708 The checksum is returned as a printable string.");
1710 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1711 [InitBasicFS, Always, TestOutput (
1712 [["tar_in"; "../images/helloworld.tar"; "/"];
1713 ["cat"; "/hello"]], "hello\n")],
1714 "unpack tarfile to directory",
1716 This command uploads and unpacks local file C<tarfile> (an
1717 I<uncompressed> tar file) into C<directory>.
1719 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1721 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1723 "pack directory into tarfile",
1725 This command packs the contents of C<directory> and downloads
1726 it to local file C<tarfile>.
1728 To download a compressed tarball, use C<guestfs_tgz_out>.");
1730 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1731 [InitBasicFS, Always, TestOutput (
1732 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1733 ["cat"; "/hello"]], "hello\n")],
1734 "unpack compressed tarball to directory",
1736 This command uploads and unpacks local file C<tarball> (a
1737 I<gzip compressed> tar file) into C<directory>.
1739 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1741 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1743 "pack directory into compressed tarball",
1745 This command packs the contents of C<directory> and downloads
1746 it to local file C<tarball>.
1748 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1750 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1751 [InitBasicFS, Always, TestLastFail (
1753 ["mount_ro"; "/dev/sda1"; "/"];
1754 ["touch"; "/new"]]);
1755 InitBasicFS, Always, TestOutput (
1756 [["write_file"; "/new"; "data"; "0"];
1758 ["mount_ro"; "/dev/sda1"; "/"];
1759 ["cat"; "/new"]], "data")],
1760 "mount a guest disk, read-only",
1762 This is the same as the C<guestfs_mount> command, but it
1763 mounts the filesystem with the read-only (I<-o ro>) flag.");
1765 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1767 "mount a guest disk with mount options",
1769 This is the same as the C<guestfs_mount> command, but it
1770 allows you to set the mount options as for the
1771 L<mount(8)> I<-o> flag.");
1773 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1775 "mount a guest disk with mount options and vfstype",
1777 This is the same as the C<guestfs_mount> command, but it
1778 allows you to set both the mount options and the vfstype
1779 as for the L<mount(8)> I<-o> and I<-t> flags.");
1781 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1783 "debugging and internals",
1785 The C<guestfs_debug> command exposes some internals of
1786 C<guestfsd> (the guestfs daemon) that runs inside the
1789 There is no comprehensive help for this command. You have
1790 to look at the file C<daemon/debug.c> in the libguestfs source
1791 to find out what you can do.");
1793 ("lvremove", (RErr, [String "device"]), 77, [],
1794 [InitEmpty, Always, TestOutputList (
1795 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1796 ["pvcreate"; "/dev/sda1"];
1797 ["vgcreate"; "VG"; "/dev/sda1"];
1798 ["lvcreate"; "LV1"; "VG"; "50"];
1799 ["lvcreate"; "LV2"; "VG"; "50"];
1800 ["lvremove"; "/dev/VG/LV1"];
1801 ["lvs"]], ["/dev/VG/LV2"]);
1802 InitEmpty, Always, TestOutputList (
1803 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1804 ["pvcreate"; "/dev/sda1"];
1805 ["vgcreate"; "VG"; "/dev/sda1"];
1806 ["lvcreate"; "LV1"; "VG"; "50"];
1807 ["lvcreate"; "LV2"; "VG"; "50"];
1808 ["lvremove"; "/dev/VG"];
1810 InitEmpty, Always, TestOutputList (
1811 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1812 ["pvcreate"; "/dev/sda1"];
1813 ["vgcreate"; "VG"; "/dev/sda1"];
1814 ["lvcreate"; "LV1"; "VG"; "50"];
1815 ["lvcreate"; "LV2"; "VG"; "50"];
1816 ["lvremove"; "/dev/VG"];
1818 "remove an LVM logical volume",
1820 Remove an LVM logical volume C<device>, where C<device> is
1821 the path to the LV, such as C</dev/VG/LV>.
1823 You can also remove all LVs in a volume group by specifying
1824 the VG name, C</dev/VG>.");
1826 ("vgremove", (RErr, [String "vgname"]), 78, [],
1827 [InitEmpty, Always, TestOutputList (
1828 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1829 ["pvcreate"; "/dev/sda1"];
1830 ["vgcreate"; "VG"; "/dev/sda1"];
1831 ["lvcreate"; "LV1"; "VG"; "50"];
1832 ["lvcreate"; "LV2"; "VG"; "50"];
1835 InitEmpty, Always, TestOutputList (
1836 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1837 ["pvcreate"; "/dev/sda1"];
1838 ["vgcreate"; "VG"; "/dev/sda1"];
1839 ["lvcreate"; "LV1"; "VG"; "50"];
1840 ["lvcreate"; "LV2"; "VG"; "50"];
1843 "remove an LVM volume group",
1845 Remove an LVM volume group C<vgname>, (for example C<VG>).
1847 This also forcibly removes all logical volumes in the volume
1850 ("pvremove", (RErr, [String "device"]), 79, [],
1851 [InitEmpty, Always, TestOutputListOfDevices (
1852 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1853 ["pvcreate"; "/dev/sda1"];
1854 ["vgcreate"; "VG"; "/dev/sda1"];
1855 ["lvcreate"; "LV1"; "VG"; "50"];
1856 ["lvcreate"; "LV2"; "VG"; "50"];
1858 ["pvremove"; "/dev/sda1"];
1860 InitEmpty, Always, TestOutputListOfDevices (
1861 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1862 ["pvcreate"; "/dev/sda1"];
1863 ["vgcreate"; "VG"; "/dev/sda1"];
1864 ["lvcreate"; "LV1"; "VG"; "50"];
1865 ["lvcreate"; "LV2"; "VG"; "50"];
1867 ["pvremove"; "/dev/sda1"];
1869 InitEmpty, Always, TestOutputListOfDevices (
1870 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1871 ["pvcreate"; "/dev/sda1"];
1872 ["vgcreate"; "VG"; "/dev/sda1"];
1873 ["lvcreate"; "LV1"; "VG"; "50"];
1874 ["lvcreate"; "LV2"; "VG"; "50"];
1876 ["pvremove"; "/dev/sda1"];
1878 "remove an LVM physical volume",
1880 This wipes a physical volume C<device> so that LVM will no longer
1883 The implementation uses the C<pvremove> command which refuses to
1884 wipe physical volumes that contain any volume groups, so you have
1885 to remove those first.");
1887 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1888 [InitBasicFS, Always, TestOutput (
1889 [["set_e2label"; "/dev/sda1"; "testlabel"];
1890 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1891 "set the ext2/3/4 filesystem label",
1893 This sets the ext2/3/4 filesystem label of the filesystem on
1894 C<device> to C<label>. Filesystem labels are limited to
1897 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1898 to return the existing label on a filesystem.");
1900 ("get_e2label", (RString "label", [String "device"]), 81, [],
1902 "get the ext2/3/4 filesystem label",
1904 This returns the ext2/3/4 filesystem label of the filesystem on
1907 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1908 [InitBasicFS, Always, TestOutput (
1909 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1910 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1911 InitBasicFS, Always, TestOutput (
1912 [["set_e2uuid"; "/dev/sda1"; "clear"];
1913 ["get_e2uuid"; "/dev/sda1"]], "");
1914 (* We can't predict what UUIDs will be, so just check the commands run. *)
1915 InitBasicFS, Always, TestRun (
1916 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1917 InitBasicFS, Always, TestRun (
1918 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1919 "set the ext2/3/4 filesystem UUID",
1921 This sets the ext2/3/4 filesystem UUID of the filesystem on
1922 C<device> to C<uuid>. The format of the UUID and alternatives
1923 such as C<clear>, C<random> and C<time> are described in the
1924 L<tune2fs(8)> manpage.
1926 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1927 to return the existing UUID of a filesystem.");
1929 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1931 "get the ext2/3/4 filesystem UUID",
1933 This returns the ext2/3/4 filesystem UUID of the filesystem on
1936 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1937 [InitBasicFS, Always, TestOutputInt (
1938 [["umount"; "/dev/sda1"];
1939 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1940 InitBasicFS, Always, TestOutputInt (
1941 [["umount"; "/dev/sda1"];
1942 ["zero"; "/dev/sda1"];
1943 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1944 "run the filesystem checker",
1946 This runs the filesystem checker (fsck) on C<device> which
1947 should have filesystem type C<fstype>.
1949 The returned integer is the status. See L<fsck(8)> for the
1950 list of status codes from C<fsck>.
1958 Multiple status codes can be summed together.
1962 A non-zero return code can mean \"success\", for example if
1963 errors have been corrected on the filesystem.
1967 Checking or repairing NTFS volumes is not supported
1972 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1974 ("zero", (RErr, [String "device"]), 85, [],
1975 [InitBasicFS, Always, TestOutput (
1976 [["umount"; "/dev/sda1"];
1977 ["zero"; "/dev/sda1"];
1978 ["file"; "/dev/sda1"]], "data")],
1979 "write zeroes to the device",
1981 This command writes zeroes over the first few blocks of C<device>.
1983 How many blocks are zeroed isn't specified (but it's I<not> enough
1984 to securely wipe the device). It should be sufficient to remove
1985 any partition tables, filesystem superblocks and so on.");
1987 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1988 [InitBasicFS, Always, TestOutputTrue (
1989 [["grub_install"; "/"; "/dev/sda1"];
1990 ["is_dir"; "/boot"]])],
1993 This command installs GRUB (the Grand Unified Bootloader) on
1994 C<device>, with the root directory being C<root>.");
1996 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1997 [InitBasicFS, Always, TestOutput (
1998 [["write_file"; "/old"; "file content"; "0"];
1999 ["cp"; "/old"; "/new"];
2000 ["cat"; "/new"]], "file content");
2001 InitBasicFS, Always, TestOutputTrue (
2002 [["write_file"; "/old"; "file content"; "0"];
2003 ["cp"; "/old"; "/new"];
2004 ["is_file"; "/old"]]);
2005 InitBasicFS, Always, TestOutput (
2006 [["write_file"; "/old"; "file content"; "0"];
2008 ["cp"; "/old"; "/dir/new"];
2009 ["cat"; "/dir/new"]], "file content")],
2012 This copies a file from C<src> to C<dest> where C<dest> is
2013 either a destination filename or destination directory.");
2015 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2016 [InitBasicFS, Always, TestOutput (
2017 [["mkdir"; "/olddir"];
2018 ["mkdir"; "/newdir"];
2019 ["write_file"; "/olddir/file"; "file content"; "0"];
2020 ["cp_a"; "/olddir"; "/newdir"];
2021 ["cat"; "/newdir/olddir/file"]], "file content")],
2022 "copy a file or directory recursively",
2024 This copies a file or directory from C<src> to C<dest>
2025 recursively using the C<cp -a> command.");
2027 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2028 [InitBasicFS, Always, TestOutput (
2029 [["write_file"; "/old"; "file content"; "0"];
2030 ["mv"; "/old"; "/new"];
2031 ["cat"; "/new"]], "file content");
2032 InitBasicFS, Always, TestOutputFalse (
2033 [["write_file"; "/old"; "file content"; "0"];
2034 ["mv"; "/old"; "/new"];
2035 ["is_file"; "/old"]])],
2038 This moves a file from C<src> to C<dest> where C<dest> is
2039 either a destination filename or destination directory.");
2041 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2042 [InitEmpty, Always, TestRun (
2043 [["drop_caches"; "3"]])],
2044 "drop kernel page cache, dentries and inodes",
2046 This instructs the guest kernel to drop its page cache,
2047 and/or dentries and inode caches. The parameter C<whattodrop>
2048 tells the kernel what precisely to drop, see
2049 L<http://linux-mm.org/Drop_Caches>
2051 Setting C<whattodrop> to 3 should drop everything.
2053 This automatically calls L<sync(2)> before the operation,
2054 so that the maximum guest memory is freed.");
2056 ("dmesg", (RString "kmsgs", []), 91, [],
2057 [InitEmpty, Always, TestRun (
2059 "return kernel messages",
2061 This returns the kernel messages (C<dmesg> output) from
2062 the guest kernel. This is sometimes useful for extended
2063 debugging of problems.
2065 Another way to get the same information is to enable
2066 verbose messages with C<guestfs_set_verbose> or by setting
2067 the environment variable C<LIBGUESTFS_DEBUG=1> before
2068 running the program.");
2070 ("ping_daemon", (RErr, []), 92, [],
2071 [InitEmpty, Always, TestRun (
2072 [["ping_daemon"]])],
2073 "ping the guest daemon",
2075 This is a test probe into the guestfs daemon running inside
2076 the qemu subprocess. Calling this function checks that the
2077 daemon responds to the ping message, without affecting the daemon
2078 or attached block device(s) in any other way.");
2080 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2081 [InitBasicFS, Always, TestOutputTrue (
2082 [["write_file"; "/file1"; "contents of a file"; "0"];
2083 ["cp"; "/file1"; "/file2"];
2084 ["equal"; "/file1"; "/file2"]]);
2085 InitBasicFS, Always, TestOutputFalse (
2086 [["write_file"; "/file1"; "contents of a file"; "0"];
2087 ["write_file"; "/file2"; "contents of another file"; "0"];
2088 ["equal"; "/file1"; "/file2"]]);
2089 InitBasicFS, Always, TestLastFail (
2090 [["equal"; "/file1"; "/file2"]])],
2091 "test if two files have equal contents",
2093 This compares the two files C<file1> and C<file2> and returns
2094 true if their content is exactly equal, or false otherwise.
2096 The external L<cmp(1)> program is used for the comparison.");
2098 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2099 [InitBasicFS, Always, TestOutputList (
2100 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2101 ["strings"; "/new"]], ["hello"; "world"]);
2102 InitBasicFS, Always, TestOutputList (
2104 ["strings"; "/new"]], [])],
2105 "print the printable strings in a file",
2107 This runs the L<strings(1)> command on a file and returns
2108 the list of printable strings found.");
2110 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2111 [InitBasicFS, Always, TestOutputList (
2112 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2113 ["strings_e"; "b"; "/new"]], []);
2114 InitBasicFS, Disabled, TestOutputList (
2115 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2116 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2117 "print the printable strings in a file",
2119 This is like the C<guestfs_strings> command, but allows you to
2120 specify the encoding.
2122 See the L<strings(1)> manpage for the full list of encodings.
2124 Commonly useful encodings are C<l> (lower case L) which will
2125 show strings inside Windows/x86 files.
2127 The returned strings are transcoded to UTF-8.");
2129 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2130 [InitBasicFS, Always, TestOutput (
2131 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2132 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n")],
2133 "dump a file in hexadecimal",
2135 This runs C<hexdump -C> on the given C<path>. The result is
2136 the human-readable, canonical hex dump of the file.");
2138 ("zerofree", (RErr, [String "device"]), 97, [],
2139 [InitNone, Always, TestOutput (
2140 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2141 ["mkfs"; "ext3"; "/dev/sda1"];
2142 ["mount"; "/dev/sda1"; "/"];
2143 ["write_file"; "/new"; "test file"; "0"];
2144 ["umount"; "/dev/sda1"];
2145 ["zerofree"; "/dev/sda1"];
2146 ["mount"; "/dev/sda1"; "/"];
2147 ["cat"; "/new"]], "test file")],
2148 "zero unused inodes and disk blocks on ext2/3 filesystem",
2150 This runs the I<zerofree> program on C<device>. This program
2151 claims to zero unused inodes and disk blocks on an ext2/3
2152 filesystem, thus making it possible to compress the filesystem
2155 You should B<not> run this program if the filesystem is
2158 It is possible that using this program can damage the filesystem
2159 or data on the filesystem.");
2161 ("pvresize", (RErr, [String "device"]), 98, [],
2163 "resize an LVM physical volume",
2165 This resizes (expands or shrinks) an existing LVM physical
2166 volume to match the new size of the underlying device.");
2168 ("sfdisk_N", (RErr, [String "device"; Int "n";
2169 Int "cyls"; Int "heads"; Int "sectors";
2170 String "line"]), 99, [DangerWillRobinson],
2172 "modify a single partition on a block device",
2174 This runs L<sfdisk(8)> option to modify just the single
2175 partition C<n> (note: C<n> counts from 1).
2177 For other parameters, see C<guestfs_sfdisk>. You should usually
2178 pass C<0> for the cyls/heads/sectors parameters.");
2180 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2182 "display the partition table",
2184 This displays the partition table on C<device>, in the
2185 human-readable output of the L<sfdisk(8)> command. It is
2186 not intended to be parsed.");
2188 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2190 "display the kernel geometry",
2192 This displays the kernel's idea of the geometry of C<device>.
2194 The result is in human-readable format, and not designed to
2197 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2199 "display the disk geometry from the partition table",
2201 This displays the disk geometry of C<device> read from the
2202 partition table. Especially in the case where the underlying
2203 block device has been resized, this can be different from the
2204 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2206 The result is in human-readable format, and not designed to
2209 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2211 "activate or deactivate all volume groups",
2213 This command activates or (if C<activate> is false) deactivates
2214 all logical volumes in all volume groups.
2215 If activated, then they are made known to the
2216 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2217 then those devices disappear.
2219 This command is the same as running C<vgchange -a y|n>");
2221 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2223 "activate or deactivate some volume groups",
2225 This command activates or (if C<activate> is false) deactivates
2226 all logical volumes in the listed volume groups C<volgroups>.
2227 If activated, then they are made known to the
2228 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2229 then those devices disappear.
2231 This command is the same as running C<vgchange -a y|n volgroups...>
2233 Note that if C<volgroups> is an empty list then B<all> volume groups
2234 are activated or deactivated.");
2236 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2237 [InitNone, Always, TestOutput (
2238 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2239 ["pvcreate"; "/dev/sda1"];
2240 ["vgcreate"; "VG"; "/dev/sda1"];
2241 ["lvcreate"; "LV"; "VG"; "10"];
2242 ["mkfs"; "ext2"; "/dev/VG/LV"];
2243 ["mount"; "/dev/VG/LV"; "/"];
2244 ["write_file"; "/new"; "test content"; "0"];
2246 ["lvresize"; "/dev/VG/LV"; "20"];
2247 ["e2fsck_f"; "/dev/VG/LV"];
2248 ["resize2fs"; "/dev/VG/LV"];
2249 ["mount"; "/dev/VG/LV"; "/"];
2250 ["cat"; "/new"]], "test content")],
2251 "resize an LVM logical volume",
2253 This resizes (expands or shrinks) an existing LVM logical
2254 volume to C<mbytes>. When reducing, data in the reduced part
2257 ("resize2fs", (RErr, [String "device"]), 106, [],
2258 [], (* lvresize tests this *)
2259 "resize an ext2/ext3 filesystem",
2261 This resizes an ext2 or ext3 filesystem to match the size of
2262 the underlying device.
2264 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2265 on the C<device> before calling this command. For unknown reasons
2266 C<resize2fs> sometimes gives an error about this and sometimes not.
2267 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2268 calling this function.");
2270 ("find", (RStringList "names", [String "directory"]), 107, [],
2271 [InitBasicFS, Always, TestOutputList (
2272 [["find"; "/"]], ["lost+found"]);
2273 InitBasicFS, Always, TestOutputList (
2277 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2278 InitBasicFS, Always, TestOutputList (
2279 [["mkdir_p"; "/a/b/c"];
2280 ["touch"; "/a/b/c/d"];
2281 ["find"; "/a/b/"]], ["c"; "c/d"])],
2282 "find all files and directories",
2284 This command lists out all files and directories, recursively,
2285 starting at C<directory>. It is essentially equivalent to
2286 running the shell command C<find directory -print> but some
2287 post-processing happens on the output, described below.
2289 This returns a list of strings I<without any prefix>. Thus
2290 if the directory structure was:
2296 then the returned list from C<guestfs_find> C</tmp> would be
2304 If C<directory> is not a directory, then this command returns
2307 The returned list is sorted.");
2309 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2310 [], (* lvresize tests this *)
2311 "check an ext2/ext3 filesystem",
2313 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2314 filesystem checker on C<device>, noninteractively (C<-p>),
2315 even if the filesystem appears to be clean (C<-f>).
2317 This command is only needed because of C<guestfs_resize2fs>
2318 (q.v.). Normally you should use C<guestfs_fsck>.");
2320 ("sleep", (RErr, [Int "secs"]), 109, [],
2321 [InitNone, Always, TestRun (
2323 "sleep for some seconds",
2325 Sleep for C<secs> seconds.");
2327 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2328 [InitNone, Always, TestOutputInt (
2329 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2330 ["mkfs"; "ntfs"; "/dev/sda1"];
2331 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2332 InitNone, Always, TestOutputInt (
2333 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2334 ["mkfs"; "ext2"; "/dev/sda1"];
2335 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2336 "probe NTFS volume",
2338 This command runs the L<ntfs-3g.probe(8)> command which probes
2339 an NTFS C<device> for mountability. (Not all NTFS volumes can
2340 be mounted read-write, and some cannot be mounted at all).
2342 C<rw> is a boolean flag. Set it to true if you want to test
2343 if the volume can be mounted read-write. Set it to false if
2344 you want to test if the volume can be mounted read-only.
2346 The return value is an integer which C<0> if the operation
2347 would succeed, or some non-zero value documented in the
2348 L<ntfs-3g.probe(8)> manual page.");
2352 let all_functions = non_daemon_functions @ daemon_functions
2354 (* In some places we want the functions to be displayed sorted
2355 * alphabetically, so this is useful:
2357 let all_functions_sorted =
2358 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2359 compare n1 n2) all_functions
2361 (* Column names and types from LVM PVs/VGs/LVs. *)
2370 "pv_attr", `String (* XXX *);
2371 "pv_pe_count", `Int;
2372 "pv_pe_alloc_count", `Int;
2375 "pv_mda_count", `Int;
2376 "pv_mda_free", `Bytes;
2377 (* Not in Fedora 10:
2378 "pv_mda_size", `Bytes;
2385 "vg_attr", `String (* XXX *);
2388 "vg_sysid", `String;
2389 "vg_extent_size", `Bytes;
2390 "vg_extent_count", `Int;
2391 "vg_free_count", `Int;
2399 "vg_mda_count", `Int;
2400 "vg_mda_free", `Bytes;
2401 (* Not in Fedora 10:
2402 "vg_mda_size", `Bytes;
2408 "lv_attr", `String (* XXX *);
2411 "lv_kernel_major", `Int;
2412 "lv_kernel_minor", `Int;
2416 "snap_percent", `OptPercent;
2417 "copy_percent", `OptPercent;
2420 "mirror_log", `String;
2424 (* Column names and types from stat structures.
2425 * NB. Can't use things like 'st_atime' because glibc header files
2426 * define some of these as macros. Ugh.
2443 let statvfs_cols = [
2457 (* Used for testing language bindings. *)
2459 | CallString of string
2460 | CallOptString of string option
2461 | CallStringList of string list
2465 (* Useful functions.
2466 * Note we don't want to use any external OCaml libraries which
2467 * makes this a bit harder than it should be.
2469 let failwithf fs = ksprintf failwith fs
2471 let replace_char s c1 c2 =
2472 let s2 = String.copy s in
2473 let r = ref false in
2474 for i = 0 to String.length s2 - 1 do
2475 if String.unsafe_get s2 i = c1 then (
2476 String.unsafe_set s2 i c2;
2480 if not !r then s else s2
2484 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2486 let triml ?(test = isspace) str =
2488 let n = ref (String.length str) in
2489 while !n > 0 && test str.[!i]; do
2494 else String.sub str !i !n
2496 let trimr ?(test = isspace) str =
2497 let n = ref (String.length str) in
2498 while !n > 0 && test str.[!n-1]; do
2501 if !n = String.length str then str
2502 else String.sub str 0 !n
2504 let trim ?(test = isspace) str =
2505 trimr ~test (triml ~test str)
2507 let rec find s sub =
2508 let len = String.length s in
2509 let sublen = String.length sub in
2511 if i <= len-sublen then (
2513 if j < sublen then (
2514 if s.[i+j] = sub.[j] then loop2 (j+1)
2520 if r = -1 then loop (i+1) else r
2526 let rec replace_str s s1 s2 =
2527 let len = String.length s in
2528 let sublen = String.length s1 in
2529 let i = find s s1 in
2532 let s' = String.sub s 0 i in
2533 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2534 s' ^ s2 ^ replace_str s'' s1 s2
2537 let rec string_split sep str =
2538 let len = String.length str in
2539 let seplen = String.length sep in
2540 let i = find str sep in
2541 if i = -1 then [str]
2543 let s' = String.sub str 0 i in
2544 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2545 s' :: string_split sep s''
2548 let files_equal n1 n2 =
2549 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2550 match Sys.command cmd with
2553 | i -> failwithf "%s: failed with error code %d" cmd i
2555 let rec find_map f = function
2556 | [] -> raise Not_found
2560 | None -> find_map f xs
2563 let rec loop i = function
2565 | x :: xs -> f i x; loop (i+1) xs
2570 let rec loop i = function
2572 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2576 let name_of_argt = function
2577 | String n | OptString n | StringList n | Bool n | Int n
2578 | FileIn n | FileOut n -> n
2580 let seq_of_test = function
2581 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2582 | TestOutputListOfDevices (s, _)
2583 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2584 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2585 | TestLastFail s -> s
2587 (* Check function names etc. for consistency. *)
2588 let check_functions () =
2589 let contains_uppercase str =
2590 let len = String.length str in
2592 if i >= len then false
2595 if c >= 'A' && c <= 'Z' then true
2602 (* Check function names. *)
2604 fun (name, _, _, _, _, _, _) ->
2605 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2606 failwithf "function name %s does not need 'guestfs' prefix" name;
2608 failwithf "function name is empty";
2609 if name.[0] < 'a' || name.[0] > 'z' then
2610 failwithf "function name %s must start with lowercase a-z" name;
2611 if String.contains name '-' then
2612 failwithf "function name %s should not contain '-', use '_' instead."
2616 (* Check function parameter/return names. *)
2618 fun (name, style, _, _, _, _, _) ->
2619 let check_arg_ret_name n =
2620 if contains_uppercase n then
2621 failwithf "%s param/ret %s should not contain uppercase chars"
2623 if String.contains n '-' || String.contains n '_' then
2624 failwithf "%s param/ret %s should not contain '-' or '_'"
2627 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;
2628 if n = "int" || n = "char" || n = "short" || n = "long" then
2629 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
2631 failwithf "%s has a param/ret called 'i', which will cause some conflicts in the generated code" name;
2632 if n = "argv" || n = "args" then
2633 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
2636 (match fst style with
2638 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2639 | RStringList n | RPVList n | RVGList n | RLVList n
2640 | RStat n | RStatVFS n
2642 check_arg_ret_name n
2644 check_arg_ret_name n;
2645 check_arg_ret_name m
2647 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2650 (* Check short descriptions. *)
2652 fun (name, _, _, _, _, shortdesc, _) ->
2653 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2654 failwithf "short description of %s should begin with lowercase." name;
2655 let c = shortdesc.[String.length shortdesc-1] in
2656 if c = '\n' || c = '.' then
2657 failwithf "short description of %s should not end with . or \\n." name
2660 (* Check long dscriptions. *)
2662 fun (name, _, _, _, _, _, longdesc) ->
2663 if longdesc.[String.length longdesc-1] = '\n' then
2664 failwithf "long description of %s should not end with \\n." name
2667 (* Check proc_nrs. *)
2669 fun (name, _, proc_nr, _, _, _, _) ->
2670 if proc_nr <= 0 then
2671 failwithf "daemon function %s should have proc_nr > 0" name
2675 fun (name, _, proc_nr, _, _, _, _) ->
2676 if proc_nr <> -1 then
2677 failwithf "non-daemon function %s should have proc_nr -1" name
2678 ) non_daemon_functions;
2681 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2684 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2685 let rec loop = function
2688 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2690 | (name1,nr1) :: (name2,nr2) :: _ ->
2691 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2699 (* Ignore functions that have no tests. We generate a
2700 * warning when the user does 'make check' instead.
2702 | name, _, _, _, [], _, _ -> ()
2703 | name, _, _, _, tests, _, _ ->
2707 match seq_of_test test with
2709 failwithf "%s has a test containing an empty sequence" name
2710 | cmds -> List.map List.hd cmds
2712 let funcs = List.flatten funcs in
2714 let tested = List.mem name funcs in
2717 failwithf "function %s has tests but does not test itself" name
2720 (* 'pr' prints to the current output file. *)
2721 let chan = ref stdout
2722 let pr fs = ksprintf (output_string !chan) fs
2724 (* Generate a header block in a number of standard styles. *)
2725 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2726 type license = GPLv2 | LGPLv2
2728 let generate_header comment license =
2729 let c = match comment with
2730 | CStyle -> pr "/* "; " *"
2731 | HashStyle -> pr "# "; "#"
2732 | OCamlStyle -> pr "(* "; " *"
2733 | HaskellStyle -> pr "{- "; " " in
2734 pr "libguestfs generated file\n";
2735 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2736 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2738 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2742 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2743 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2744 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2745 pr "%s (at your option) any later version.\n" c;
2747 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2748 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2749 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2750 pr "%s GNU General Public License for more details.\n" c;
2752 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2753 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2754 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2757 pr "%s This library is free software; you can redistribute it and/or\n" c;
2758 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2759 pr "%s License as published by the Free Software Foundation; either\n" c;
2760 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2762 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2763 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2764 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2765 pr "%s Lesser General Public License for more details.\n" c;
2767 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2768 pr "%s License along with this library; if not, write to the Free Software\n" c;
2769 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2772 | CStyle -> pr " */\n"
2774 | OCamlStyle -> pr " *)\n"
2775 | HaskellStyle -> pr "-}\n"
2779 (* Start of main code generation functions below this line. *)
2781 (* Generate the pod documentation for the C API. *)
2782 let rec generate_actions_pod () =
2784 fun (shortname, style, _, flags, _, _, longdesc) ->
2785 if not (List.mem NotInDocs flags) then (
2786 let name = "guestfs_" ^ shortname in
2787 pr "=head2 %s\n\n" name;
2789 generate_prototype ~extern:false ~handle:"handle" name style;
2791 pr "%s\n\n" longdesc;
2792 (match fst style with
2794 pr "This function returns 0 on success or -1 on error.\n\n"
2796 pr "On error this function returns -1.\n\n"
2798 pr "On error this function returns -1.\n\n"
2800 pr "This function returns a C truth value on success or -1 on error.\n\n"
2802 pr "This function returns a string, or NULL on error.
2803 The string is owned by the guest handle and must I<not> be freed.\n\n"
2805 pr "This function returns a string, or NULL on error.
2806 I<The caller must free the returned string after use>.\n\n"
2808 pr "This function returns a NULL-terminated array of strings
2809 (like L<environ(3)>), or NULL if there was an error.
2810 I<The caller must free the strings and the array after use>.\n\n"
2812 pr "This function returns a C<struct guestfs_int_bool *>,
2813 or NULL if there was an error.
2814 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2816 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2817 (see E<lt>guestfs-structs.hE<gt>),
2818 or NULL if there was an error.
2819 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2821 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2822 (see E<lt>guestfs-structs.hE<gt>),
2823 or NULL if there was an error.
2824 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2826 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2827 (see E<lt>guestfs-structs.hE<gt>),
2828 or NULL if there was an error.
2829 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2831 pr "This function returns a C<struct guestfs_stat *>
2832 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2833 or NULL if there was an error.
2834 I<The caller must call C<free> after use>.\n\n"
2836 pr "This function returns a C<struct guestfs_statvfs *>
2837 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2838 or NULL if there was an error.
2839 I<The caller must call C<free> after use>.\n\n"
2841 pr "This function returns a NULL-terminated array of
2842 strings, or NULL if there was an error.
2843 The array of strings will always have length C<2n+1>, where
2844 C<n> keys and values alternate, followed by the trailing NULL entry.
2845 I<The caller must free the strings and the array after use>.\n\n"
2847 if List.mem ProtocolLimitWarning flags then
2848 pr "%s\n\n" protocol_limit_warning;
2849 if List.mem DangerWillRobinson flags then
2850 pr "%s\n\n" danger_will_robinson
2852 ) all_functions_sorted
2854 and generate_structs_pod () =
2855 (* LVM structs documentation. *)
2858 pr "=head2 guestfs_lvm_%s\n" typ;
2860 pr " struct guestfs_lvm_%s {\n" typ;
2863 | name, `String -> pr " char *%s;\n" name
2865 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2866 pr " char %s[32];\n" name
2867 | name, `Bytes -> pr " uint64_t %s;\n" name
2868 | name, `Int -> pr " int64_t %s;\n" name
2869 | name, `OptPercent ->
2870 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2871 pr " float %s;\n" name
2874 pr " struct guestfs_lvm_%s_list {\n" typ;
2875 pr " uint32_t len; /* Number of elements in list. */\n";
2876 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2879 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2882 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2884 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2885 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2887 * We have to use an underscore instead of a dash because otherwise
2888 * rpcgen generates incorrect code.
2890 * This header is NOT exported to clients, but see also generate_structs_h.
2892 and generate_xdr () =
2893 generate_header CStyle LGPLv2;
2895 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2896 pr "typedef string str<>;\n";
2899 (* LVM internal structures. *)
2903 pr "struct guestfs_lvm_int_%s {\n" typ;
2905 | name, `String -> pr " string %s<>;\n" name
2906 | name, `UUID -> pr " opaque %s[32];\n" name
2907 | name, `Bytes -> pr " hyper %s;\n" name
2908 | name, `Int -> pr " hyper %s;\n" name
2909 | name, `OptPercent -> pr " float %s;\n" name
2913 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2915 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2917 (* Stat internal structures. *)
2921 pr "struct guestfs_int_%s {\n" typ;
2923 | name, `Int -> pr " hyper %s;\n" name
2927 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2930 fun (shortname, style, _, _, _, _, _) ->
2931 let name = "guestfs_" ^ shortname in
2933 (match snd style with
2936 pr "struct %s_args {\n" name;
2939 | String n -> pr " string %s<>;\n" n
2940 | OptString n -> pr " str *%s;\n" n
2941 | StringList n -> pr " str %s<>;\n" n
2942 | Bool n -> pr " bool %s;\n" n
2943 | Int n -> pr " int %s;\n" n
2944 | FileIn _ | FileOut _ -> ()
2948 (match fst style with
2951 pr "struct %s_ret {\n" name;
2955 pr "struct %s_ret {\n" name;
2956 pr " hyper %s;\n" n;
2959 pr "struct %s_ret {\n" name;
2963 failwithf "RConstString cannot be returned from a daemon function"
2965 pr "struct %s_ret {\n" name;
2966 pr " string %s<>;\n" n;
2969 pr "struct %s_ret {\n" name;
2970 pr " str %s<>;\n" n;
2973 pr "struct %s_ret {\n" name;
2978 pr "struct %s_ret {\n" name;
2979 pr " guestfs_lvm_int_pv_list %s;\n" n;
2982 pr "struct %s_ret {\n" name;
2983 pr " guestfs_lvm_int_vg_list %s;\n" n;
2986 pr "struct %s_ret {\n" name;
2987 pr " guestfs_lvm_int_lv_list %s;\n" n;
2990 pr "struct %s_ret {\n" name;
2991 pr " guestfs_int_stat %s;\n" n;
2994 pr "struct %s_ret {\n" name;
2995 pr " guestfs_int_statvfs %s;\n" n;
2998 pr "struct %s_ret {\n" name;
2999 pr " str %s<>;\n" n;
3004 (* Table of procedure numbers. *)
3005 pr "enum guestfs_procedure {\n";
3007 fun (shortname, _, proc_nr, _, _, _, _) ->
3008 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3010 pr " GUESTFS_PROC_NR_PROCS\n";
3014 (* Having to choose a maximum message size is annoying for several
3015 * reasons (it limits what we can do in the API), but it (a) makes
3016 * the protocol a lot simpler, and (b) provides a bound on the size
3017 * of the daemon which operates in limited memory space. For large
3018 * file transfers you should use FTP.
3020 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3023 (* Message header, etc. *)
3025 /* The communication protocol is now documented in the guestfs(3)
3029 const GUESTFS_PROGRAM = 0x2000F5F5;
3030 const GUESTFS_PROTOCOL_VERSION = 1;
3032 /* These constants must be larger than any possible message length. */
3033 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3034 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3036 enum guestfs_message_direction {
3037 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3038 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3041 enum guestfs_message_status {
3042 GUESTFS_STATUS_OK = 0,
3043 GUESTFS_STATUS_ERROR = 1
3046 const GUESTFS_ERROR_LEN = 256;
3048 struct guestfs_message_error {
3049 string error_message<GUESTFS_ERROR_LEN>;
3052 struct guestfs_message_header {
3053 unsigned prog; /* GUESTFS_PROGRAM */
3054 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3055 guestfs_procedure proc; /* GUESTFS_PROC_x */
3056 guestfs_message_direction direction;
3057 unsigned serial; /* message serial number */
3058 guestfs_message_status status;
3061 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3063 struct guestfs_chunk {
3064 int cancel; /* if non-zero, transfer is cancelled */
3065 /* data size is 0 bytes if the transfer has finished successfully */
3066 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3070 (* Generate the guestfs-structs.h file. *)
3071 and generate_structs_h () =
3072 generate_header CStyle LGPLv2;
3074 (* This is a public exported header file containing various
3075 * structures. The structures are carefully written to have
3076 * exactly the same in-memory format as the XDR structures that
3077 * we use on the wire to the daemon. The reason for creating
3078 * copies of these structures here is just so we don't have to
3079 * export the whole of guestfs_protocol.h (which includes much
3080 * unrelated and XDR-dependent stuff that we don't want to be
3081 * public, or required by clients).
3083 * To reiterate, we will pass these structures to and from the
3084 * client with a simple assignment or memcpy, so the format
3085 * must be identical to what rpcgen / the RFC defines.
3088 (* guestfs_int_bool structure. *)
3089 pr "struct guestfs_int_bool {\n";
3095 (* LVM public structures. *)
3099 pr "struct guestfs_lvm_%s {\n" typ;
3102 | name, `String -> pr " char *%s;\n" name
3103 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3104 | name, `Bytes -> pr " uint64_t %s;\n" name
3105 | name, `Int -> pr " int64_t %s;\n" name
3106 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3110 pr "struct guestfs_lvm_%s_list {\n" typ;
3111 pr " uint32_t len;\n";
3112 pr " struct guestfs_lvm_%s *val;\n" typ;
3115 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3117 (* Stat structures. *)
3121 pr "struct guestfs_%s {\n" typ;
3124 | name, `Int -> pr " int64_t %s;\n" name
3128 ) ["stat", stat_cols; "statvfs", statvfs_cols]
3130 (* Generate the guestfs-actions.h file. *)
3131 and generate_actions_h () =
3132 generate_header CStyle LGPLv2;
3134 fun (shortname, style, _, _, _, _, _) ->
3135 let name = "guestfs_" ^ shortname in
3136 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3140 (* Generate the client-side dispatch stubs. *)
3141 and generate_client_actions () =
3142 generate_header CStyle LGPLv2;
3148 #include \"guestfs.h\"
3149 #include \"guestfs_protocol.h\"
3151 #define error guestfs_error
3152 #define perrorf guestfs_perrorf
3153 #define safe_malloc guestfs_safe_malloc
3154 #define safe_realloc guestfs_safe_realloc
3155 #define safe_strdup guestfs_safe_strdup
3156 #define safe_memdup guestfs_safe_memdup
3158 /* Check the return message from a call for validity. */
3160 check_reply_header (guestfs_h *g,
3161 const struct guestfs_message_header *hdr,
3162 int proc_nr, int serial)
3164 if (hdr->prog != GUESTFS_PROGRAM) {
3165 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3168 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3169 error (g, \"wrong protocol version (%%d/%%d)\",
3170 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3173 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3174 error (g, \"unexpected message direction (%%d/%%d)\",
3175 hdr->direction, GUESTFS_DIRECTION_REPLY);
3178 if (hdr->proc != proc_nr) {
3179 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3182 if (hdr->serial != serial) {
3183 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3190 /* Check we are in the right state to run a high-level action. */
3192 check_state (guestfs_h *g, const char *caller)
3194 if (!guestfs_is_ready (g)) {
3195 if (guestfs_is_config (g))
3196 error (g, \"%%s: call launch() before using this function\",
3198 else if (guestfs_is_launching (g))
3199 error (g, \"%%s: call wait_ready() before using this function\",
3202 error (g, \"%%s called from the wrong state, %%d != READY\",
3203 caller, guestfs_get_state (g));
3211 (* Client-side stubs for each function. *)
3213 fun (shortname, style, _, _, _, _, _) ->
3214 let name = "guestfs_" ^ shortname in
3216 (* Generate the context struct which stores the high-level
3217 * state between callback functions.
3219 pr "struct %s_ctx {\n" shortname;
3220 pr " /* This flag is set by the callbacks, so we know we've done\n";
3221 pr " * the callbacks as expected, and in the right sequence.\n";
3222 pr " * 0 = not called, 1 = reply_cb called.\n";
3224 pr " int cb_sequence;\n";
3225 pr " struct guestfs_message_header hdr;\n";
3226 pr " struct guestfs_message_error err;\n";
3227 (match fst style with
3230 failwithf "RConstString cannot be returned from a daemon function"
3232 | RBool _ | RString _ | RStringList _
3234 | RPVList _ | RVGList _ | RLVList _
3235 | RStat _ | RStatVFS _
3237 pr " struct %s_ret ret;\n" name
3242 (* Generate the reply callback function. *)
3243 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3245 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3246 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3248 pr " /* This should definitely not happen. */\n";
3249 pr " if (ctx->cb_sequence != 0) {\n";
3250 pr " ctx->cb_sequence = 9999;\n";
3251 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3255 pr " ml->main_loop_quit (ml, g);\n";
3257 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3258 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3261 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3262 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3263 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3270 (match fst style with
3273 failwithf "RConstString cannot be returned from a daemon function"
3275 | RBool _ | RString _ | RStringList _
3277 | RPVList _ | RVGList _ | RLVList _
3278 | RStat _ | RStatVFS _
3280 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3281 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3287 pr " ctx->cb_sequence = 1;\n";
3290 (* Generate the action stub. *)
3291 generate_prototype ~extern:false ~semicolon:false ~newline:true
3292 ~handle:"g" name style;
3295 match fst style with
3296 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3298 failwithf "RConstString cannot be returned from a daemon function"
3299 | RString _ | RStringList _ | RIntBool _
3300 | RPVList _ | RVGList _ | RLVList _
3301 | RStat _ | RStatVFS _
3307 (match snd style with
3309 | _ -> pr " struct %s_args args;\n" name
3312 pr " struct %s_ctx ctx;\n" shortname;
3313 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3314 pr " int serial;\n";
3316 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3317 pr " guestfs_set_busy (g);\n";
3319 pr " memset (&ctx, 0, sizeof ctx);\n";
3322 (* Send the main header and arguments. *)
3323 (match snd style with
3325 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3326 (String.uppercase shortname)
3331 pr " args.%s = (char *) %s;\n" n n
3333 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3335 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3336 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3338 pr " args.%s = %s;\n" n n
3340 pr " args.%s = %s;\n" n n
3341 | FileIn _ | FileOut _ -> ()
3343 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3344 (String.uppercase shortname);
3345 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3348 pr " if (serial == -1) {\n";
3349 pr " guestfs_end_busy (g);\n";
3350 pr " return %s;\n" error_code;
3354 (* Send any additional files (FileIn) requested. *)
3355 let need_read_reply_label = ref false in
3362 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3363 pr " if (r == -1) {\n";
3364 pr " guestfs_end_busy (g);\n";
3365 pr " return %s;\n" error_code;
3367 pr " if (r == -2) /* daemon cancelled */\n";
3368 pr " goto read_reply;\n";
3369 need_read_reply_label := true;
3375 (* Wait for the reply from the remote end. *)
3376 if !need_read_reply_label then pr " read_reply:\n";
3377 pr " guestfs__switch_to_receiving (g);\n";
3378 pr " ctx.cb_sequence = 0;\n";
3379 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3380 pr " (void) ml->main_loop_run (ml, g);\n";
3381 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3382 pr " if (ctx.cb_sequence != 1) {\n";
3383 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3384 pr " guestfs_end_busy (g);\n";
3385 pr " return %s;\n" error_code;
3389 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3390 (String.uppercase shortname);
3391 pr " guestfs_end_busy (g);\n";
3392 pr " return %s;\n" error_code;
3396 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3397 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3398 pr " free (ctx.err.error_message);\n";
3399 pr " guestfs_end_busy (g);\n";
3400 pr " return %s;\n" error_code;
3404 (* Expecting to receive further files (FileOut)? *)
3408 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3409 pr " guestfs_end_busy (g);\n";
3410 pr " return %s;\n" error_code;
3416 pr " guestfs_end_busy (g);\n";
3418 (match fst style with
3419 | RErr -> pr " return 0;\n"
3420 | RInt n | RInt64 n | RBool n ->
3421 pr " return ctx.ret.%s;\n" n
3423 failwithf "RConstString cannot be returned from a daemon function"
3425 pr " return ctx.ret.%s; /* caller will free */\n" n
3426 | RStringList n | RHashtable n ->
3427 pr " /* caller will free this, but we need to add a NULL entry */\n";
3428 pr " ctx.ret.%s.%s_val =\n" n n;
3429 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3430 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3432 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3433 pr " return ctx.ret.%s.%s_val;\n" n n
3435 pr " /* caller with free this */\n";
3436 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3437 | RPVList n | RVGList n | RLVList n
3438 | RStat n | RStatVFS n ->
3439 pr " /* caller will free this */\n";
3440 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3446 (* Generate daemon/actions.h. *)
3447 and generate_daemon_actions_h () =
3448 generate_header CStyle GPLv2;
3450 pr "#include \"../src/guestfs_protocol.h\"\n";
3454 fun (name, style, _, _, _, _, _) ->
3456 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3460 (* Generate the server-side stubs. *)
3461 and generate_daemon_actions () =
3462 generate_header CStyle GPLv2;
3464 pr "#include <config.h>\n";
3466 pr "#include <stdio.h>\n";
3467 pr "#include <stdlib.h>\n";
3468 pr "#include <string.h>\n";
3469 pr "#include <inttypes.h>\n";
3470 pr "#include <ctype.h>\n";
3471 pr "#include <rpc/types.h>\n";
3472 pr "#include <rpc/xdr.h>\n";
3474 pr "#include \"daemon.h\"\n";
3475 pr "#include \"../src/guestfs_protocol.h\"\n";
3476 pr "#include \"actions.h\"\n";
3480 fun (name, style, _, _, _, _, _) ->
3481 (* Generate server-side stubs. *)
3482 pr "static void %s_stub (XDR *xdr_in)\n" name;
3485 match fst style with
3486 | RErr | RInt _ -> pr " int r;\n"; "-1"
3487 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3488 | RBool _ -> pr " int r;\n"; "-1"
3490 failwithf "RConstString cannot be returned from a daemon function"
3491 | RString _ -> pr " char *r;\n"; "NULL"
3492 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
3493 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
3494 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
3495 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
3496 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
3497 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
3498 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
3500 (match snd style with
3503 pr " struct guestfs_%s_args args;\n" name;
3506 (* Note we allow the string to be writable, in order to
3507 * allow device name translation. This is safe because
3508 * we can modify the string (passed from RPC).
3511 | OptString n -> pr " char *%s;\n" n
3512 | StringList n -> pr " char **%s;\n" n
3513 | Bool n -> pr " int %s;\n" n
3514 | Int n -> pr " int %s;\n" n
3515 | FileIn _ | FileOut _ -> ()
3520 (match snd style with
3523 pr " memset (&args, 0, sizeof args);\n";
3525 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3526 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3531 | String n -> pr " %s = args.%s;\n" n n
3532 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3534 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3535 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3536 pr " if (%s == NULL) {\n" n;
3537 pr " reply_with_perror (\"realloc\");\n";
3540 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3541 pr " args.%s.%s_val = %s;\n" n n n;
3542 | Bool n -> pr " %s = args.%s;\n" n n
3543 | Int n -> pr " %s = args.%s;\n" n n
3544 | FileIn _ | FileOut _ -> ()
3549 (* Don't want to call the impl with any FileIn or FileOut
3550 * parameters, since these go "outside" the RPC protocol.
3553 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3555 pr " r = do_%s " name;
3556 generate_call_args argsnofile;
3559 pr " if (r == %s)\n" error_code;
3560 pr " /* do_%s has already called reply_with_error */\n" name;
3564 (* If there are any FileOut parameters, then the impl must
3565 * send its own reply.
3568 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3570 pr " /* do_%s has already sent a reply */\n" name
3572 match fst style with
3573 | RErr -> pr " reply (NULL, NULL);\n"
3574 | RInt n | RInt64 n | RBool n ->
3575 pr " struct guestfs_%s_ret ret;\n" name;
3576 pr " ret.%s = r;\n" n;
3577 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3580 failwithf "RConstString cannot be returned from a daemon function"
3582 pr " struct guestfs_%s_ret ret;\n" name;
3583 pr " ret.%s = r;\n" n;
3584 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3587 | RStringList n | RHashtable n ->
3588 pr " struct guestfs_%s_ret ret;\n" name;
3589 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3590 pr " ret.%s.%s_val = r;\n" n n;
3591 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3593 pr " free_strings (r);\n"
3595 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3597 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3598 | RPVList n | RVGList n | RLVList n
3599 | RStat n | RStatVFS n ->
3600 pr " struct guestfs_%s_ret ret;\n" name;
3601 pr " ret.%s = *r;\n" n;
3602 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3604 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3608 (* Free the args. *)
3609 (match snd style with
3614 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3621 (* Dispatch function. *)
3622 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3624 pr " switch (proc_nr) {\n";
3627 fun (name, style, _, _, _, _, _) ->
3628 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3629 pr " %s_stub (xdr_in);\n" name;
3634 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3639 (* LVM columns and tokenization functions. *)
3640 (* XXX This generates crap code. We should rethink how we
3646 pr "static const char *lvm_%s_cols = \"%s\";\n"
3647 typ (String.concat "," (List.map fst cols));
3650 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3652 pr " char *tok, *p, *next;\n";
3656 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3659 pr " if (!str) {\n";
3660 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3663 pr " if (!*str || isspace (*str)) {\n";
3664 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3669 fun (name, coltype) ->
3670 pr " if (!tok) {\n";
3671 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3674 pr " p = strchrnul (tok, ',');\n";
3675 pr " if (*p) next = p+1; else next = NULL;\n";
3676 pr " *p = '\\0';\n";
3679 pr " r->%s = strdup (tok);\n" name;
3680 pr " if (r->%s == NULL) {\n" name;
3681 pr " perror (\"strdup\");\n";
3685 pr " for (i = j = 0; i < 32; ++j) {\n";
3686 pr " if (tok[j] == '\\0') {\n";
3687 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3689 pr " } else if (tok[j] != '-')\n";
3690 pr " r->%s[i++] = tok[j];\n" name;
3693 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3694 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3698 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3699 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3703 pr " if (tok[0] == '\\0')\n";
3704 pr " r->%s = -1;\n" name;
3705 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3706 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3710 pr " tok = next;\n";
3713 pr " if (tok != NULL) {\n";
3714 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3721 pr "guestfs_lvm_int_%s_list *\n" typ;
3722 pr "parse_command_line_%ss (void)\n" typ;
3724 pr " char *out, *err;\n";
3725 pr " char *p, *pend;\n";
3727 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3728 pr " void *newp;\n";
3730 pr " ret = malloc (sizeof *ret);\n";
3731 pr " if (!ret) {\n";
3732 pr " reply_with_perror (\"malloc\");\n";
3733 pr " return NULL;\n";
3736 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3737 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3739 pr " r = command (&out, &err,\n";
3740 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3741 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3742 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3743 pr " if (r == -1) {\n";
3744 pr " reply_with_error (\"%%s\", err);\n";
3745 pr " free (out);\n";
3746 pr " free (err);\n";
3747 pr " free (ret);\n";
3748 pr " return NULL;\n";
3751 pr " free (err);\n";
3753 pr " /* Tokenize each line of the output. */\n";
3756 pr " while (p) {\n";
3757 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3758 pr " if (pend) {\n";
3759 pr " *pend = '\\0';\n";
3763 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3766 pr " if (!*p) { /* Empty line? Skip it. */\n";
3771 pr " /* Allocate some space to store this next entry. */\n";
3772 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3773 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3774 pr " if (newp == NULL) {\n";
3775 pr " reply_with_perror (\"realloc\");\n";
3776 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3777 pr " free (ret);\n";
3778 pr " free (out);\n";
3779 pr " return NULL;\n";
3781 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3783 pr " /* Tokenize the next entry. */\n";
3784 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3785 pr " if (r == -1) {\n";
3786 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3787 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3788 pr " free (ret);\n";
3789 pr " free (out);\n";
3790 pr " return NULL;\n";
3797 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3799 pr " free (out);\n";
3800 pr " return ret;\n";
3803 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3805 (* Generate the tests. *)
3806 and generate_tests () =
3807 generate_header CStyle GPLv2;
3814 #include <sys/types.h>
3817 #include \"guestfs.h\"
3819 static guestfs_h *g;
3820 static int suppress_error = 0;
3822 static void print_error (guestfs_h *g, void *data, const char *msg)
3824 if (!suppress_error)
3825 fprintf (stderr, \"%%s\\n\", msg);
3828 static void print_strings (char * const * const argv)
3832 for (argc = 0; argv[argc] != NULL; ++argc)
3833 printf (\"\\t%%s\\n\", argv[argc]);
3837 static void print_table (char * const * const argv)
3841 for (i = 0; argv[i] != NULL; i += 2)
3842 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3846 static void no_test_warnings (void)
3852 | name, _, _, _, [], _, _ ->
3853 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3854 | name, _, _, _, tests, _, _ -> ()
3860 (* Generate the actual tests. Note that we generate the tests
3861 * in reverse order, deliberately, so that (in general) the
3862 * newest tests run first. This makes it quicker and easier to
3867 fun (name, _, _, _, tests, _, _) ->
3868 mapi (generate_one_test name) tests
3869 ) (List.rev all_functions) in
3870 let test_names = List.concat test_names in
3871 let nr_tests = List.length test_names in
3874 int main (int argc, char *argv[])
3878 const char *filename;
3880 int nr_tests, test_num = 0;
3882 no_test_warnings ();
3884 g = guestfs_create ();
3886 printf (\"guestfs_create FAILED\\n\");
3890 guestfs_set_error_handler (g, print_error, NULL);
3892 guestfs_set_path (g, \"../appliance\");
3894 filename = \"test1.img\";
3895 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3900 if (lseek (fd, %d, SEEK_SET) == -1) {
3906 if (write (fd, &c, 1) == -1) {
3912 if (close (fd) == -1) {
3917 if (guestfs_add_drive (g, filename) == -1) {
3918 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3922 filename = \"test2.img\";
3923 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3928 if (lseek (fd, %d, SEEK_SET) == -1) {
3934 if (write (fd, &c, 1) == -1) {
3940 if (close (fd) == -1) {
3945 if (guestfs_add_drive (g, filename) == -1) {
3946 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3950 filename = \"test3.img\";
3951 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3956 if (lseek (fd, %d, SEEK_SET) == -1) {
3962 if (write (fd, &c, 1) == -1) {
3968 if (close (fd) == -1) {
3973 if (guestfs_add_drive (g, filename) == -1) {
3974 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3978 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
3979 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
3983 if (guestfs_launch (g) == -1) {
3984 printf (\"guestfs_launch FAILED\\n\");
3987 if (guestfs_wait_ready (g) == -1) {
3988 printf (\"guestfs_wait_ready FAILED\\n\");
3994 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3998 pr " test_num++;\n";
3999 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4000 pr " if (%s () == -1) {\n" test_name;
4001 pr " printf (\"%s FAILED\\n\");\n" test_name;
4007 pr " guestfs_close (g);\n";
4008 pr " unlink (\"test1.img\");\n";
4009 pr " unlink (\"test2.img\");\n";
4010 pr " unlink (\"test3.img\");\n";
4013 pr " if (failed > 0) {\n";
4014 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4022 and generate_one_test name i (init, prereq, test) =
4023 let test_name = sprintf "test_%s_%d" name i in
4026 static int %s_skip (void)
4030 str = getenv (\"SKIP_%s\");
4031 if (str && strcmp (str, \"1\") == 0) return 1;
4032 str = getenv (\"SKIP_TEST_%s\");
4033 if (str && strcmp (str, \"1\") == 0) return 1;
4037 " test_name (String.uppercase test_name) (String.uppercase name);
4040 | Disabled | Always -> ()
4041 | If code | Unless code ->
4042 pr "static int %s_prereq (void)\n" test_name;
4050 static int %s (void)
4053 printf (\"%%s skipped (reason: SKIP_TEST_* variable set)\\n\", \"%s\");
4057 " test_name test_name test_name;
4061 pr " printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4063 pr " if (! %s_prereq ()) {\n" test_name;
4064 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4068 generate_one_test_body name i test_name init test;
4070 pr " if (%s_prereq ()) {\n" test_name;
4071 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4075 generate_one_test_body name i test_name init test;
4077 generate_one_test_body name i test_name init test
4085 and generate_one_test_body name i test_name init test =
4089 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4090 List.iter (generate_test_command_call test_name)
4091 [["blockdev_setrw"; "/dev/sda"];
4095 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4096 List.iter (generate_test_command_call test_name)
4097 [["blockdev_setrw"; "/dev/sda"];
4100 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4101 ["mkfs"; "ext2"; "/dev/sda1"];
4102 ["mount"; "/dev/sda1"; "/"]]
4103 | InitBasicFSonLVM ->
4104 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4106 List.iter (generate_test_command_call test_name)
4107 [["blockdev_setrw"; "/dev/sda"];
4110 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4111 ["pvcreate"; "/dev/sda1"];
4112 ["vgcreate"; "VG"; "/dev/sda1"];
4113 ["lvcreate"; "LV"; "VG"; "8"];
4114 ["mkfs"; "ext2"; "/dev/VG/LV"];
4115 ["mount"; "/dev/VG/LV"; "/"]]
4118 let get_seq_last = function
4120 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4123 let seq = List.rev seq in
4124 List.rev (List.tl seq), List.hd seq
4129 pr " /* TestRun for %s (%d) */\n" name i;
4130 List.iter (generate_test_command_call test_name) seq
4131 | TestOutput (seq, expected) ->
4132 pr " /* TestOutput for %s (%d) */\n" name i;
4133 pr " char expected[] = \"%s\";\n" (c_quote expected);
4134 let seq, last = get_seq_last seq in
4136 pr " if (strcmp (r, expected) != 0) {\n";
4137 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4141 List.iter (generate_test_command_call test_name) seq;
4142 generate_test_command_call ~test test_name last
4143 | TestOutputList (seq, expected) ->
4144 pr " /* TestOutputList for %s (%d) */\n" name i;
4145 let seq, last = get_seq_last seq in
4149 pr " if (!r[%d]) {\n" i;
4150 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4151 pr " print_strings (r);\n";
4155 pr " char expected[] = \"%s\";\n" (c_quote str);
4156 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4157 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4162 pr " if (r[%d] != NULL) {\n" (List.length expected);
4163 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4165 pr " print_strings (r);\n";
4169 List.iter (generate_test_command_call test_name) seq;
4170 generate_test_command_call ~test test_name last
4171 | TestOutputListOfDevices (seq, expected) ->
4172 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
4173 let seq, last = get_seq_last seq in
4177 pr " if (!r[%d]) {\n" i;
4178 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4179 pr " print_strings (r);\n";
4183 pr " char expected[] = \"%s\";\n" (c_quote str);
4184 pr " r[%d][5] = 's';\n" i;
4185 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4186 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4191 pr " if (r[%d] != NULL) {\n" (List.length expected);
4192 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4194 pr " print_strings (r);\n";
4198 List.iter (generate_test_command_call test_name) seq;
4199 generate_test_command_call ~test test_name last
4200 | TestOutputInt (seq, expected) ->
4201 pr " /* TestOutputInt for %s (%d) */\n" name i;
4202 let seq, last = get_seq_last seq in
4204 pr " if (r != %d) {\n" expected;
4205 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4211 List.iter (generate_test_command_call test_name) seq;
4212 generate_test_command_call ~test test_name last
4213 | TestOutputTrue seq ->
4214 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4215 let seq, last = get_seq_last seq in
4218 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4223 List.iter (generate_test_command_call test_name) seq;
4224 generate_test_command_call ~test test_name last
4225 | TestOutputFalse seq ->
4226 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4227 let seq, last = get_seq_last seq in
4230 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4235 List.iter (generate_test_command_call test_name) seq;
4236 generate_test_command_call ~test test_name last
4237 | TestOutputLength (seq, expected) ->
4238 pr " /* TestOutputLength for %s (%d) */\n" name i;
4239 let seq, last = get_seq_last seq in
4242 pr " for (j = 0; j < %d; ++j)\n" expected;
4243 pr " if (r[j] == NULL) {\n";
4244 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4246 pr " print_strings (r);\n";
4249 pr " if (r[j] != NULL) {\n";
4250 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4252 pr " print_strings (r);\n";
4256 List.iter (generate_test_command_call test_name) seq;
4257 generate_test_command_call ~test test_name last
4258 | TestOutputStruct (seq, checks) ->
4259 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4260 let seq, last = get_seq_last seq in
4264 | CompareWithInt (field, expected) ->
4265 pr " if (r->%s != %d) {\n" field expected;
4266 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4267 test_name field expected;
4268 pr " (int) r->%s);\n" field;
4271 | CompareWithString (field, expected) ->
4272 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4273 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4274 test_name field expected;
4275 pr " r->%s);\n" field;
4278 | CompareFieldsIntEq (field1, field2) ->
4279 pr " if (r->%s != r->%s) {\n" field1 field2;
4280 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4281 test_name field1 field2;
4282 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
4285 | CompareFieldsStrEq (field1, field2) ->
4286 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4287 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4288 test_name field1 field2;
4289 pr " r->%s, r->%s);\n" field1 field2;
4294 List.iter (generate_test_command_call test_name) seq;
4295 generate_test_command_call ~test test_name last
4296 | TestLastFail seq ->
4297 pr " /* TestLastFail for %s (%d) */\n" name i;
4298 let seq, last = get_seq_last seq in
4299 List.iter (generate_test_command_call test_name) seq;
4300 generate_test_command_call test_name ~expect_error:true last
4302 (* Generate the code to run a command, leaving the result in 'r'.
4303 * If you expect to get an error then you should set expect_error:true.
4305 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4307 | [] -> assert false
4309 (* Look up the command to find out what args/ret it has. *)
4312 let _, style, _, _, _, _, _ =
4313 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4316 failwithf "%s: in test, command %s was not found" test_name name in
4318 if List.length (snd style) <> List.length args then
4319 failwithf "%s: in test, wrong number of args given to %s"
4326 | OptString n, "NULL" -> ()
4328 | OptString n, arg ->
4329 pr " char %s[] = \"%s\";\n" n (c_quote arg);
4332 | FileIn _, _ | FileOut _, _ -> ()
4333 | StringList n, arg ->
4334 let strs = string_split " " arg in
4337 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
4339 pr " char *%s[] = {\n" n;
4341 fun i _ -> pr " %s_%d,\n" n i
4345 ) (List.combine (snd style) args);
4348 match fst style with
4349 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
4350 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4351 | RConstString _ -> pr " const char *r;\n"; "NULL"
4352 | RString _ -> pr " char *r;\n"; "NULL"
4353 | RStringList _ | RHashtable _ ->
4358 pr " struct guestfs_int_bool *r;\n"; "NULL"
4360 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4362 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4364 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4366 pr " struct guestfs_stat *r;\n"; "NULL"
4368 pr " struct guestfs_statvfs *r;\n"; "NULL" in
4370 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4371 pr " r = guestfs_%s (g" name;
4373 (* Generate the parameters. *)
4376 | OptString _, "NULL" -> pr ", NULL"
4380 | FileIn _, arg | FileOut _, arg ->
4381 pr ", \"%s\"" (c_quote arg)
4382 | StringList n, _ ->
4386 try int_of_string arg
4387 with Failure "int_of_string" ->
4388 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4391 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4392 ) (List.combine (snd style) args);
4395 if not expect_error then
4396 pr " if (r == %s)\n" error_code
4398 pr " if (r != %s)\n" error_code;
4401 (* Insert the test code. *)
4407 (match fst style with
4408 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4409 | RString _ -> pr " free (r);\n"
4410 | RStringList _ | RHashtable _ ->
4411 pr " for (i = 0; r[i] != NULL; ++i)\n";
4412 pr " free (r[i]);\n";
4415 pr " guestfs_free_int_bool (r);\n"
4417 pr " guestfs_free_lvm_pv_list (r);\n"
4419 pr " guestfs_free_lvm_vg_list (r);\n"
4421 pr " guestfs_free_lvm_lv_list (r);\n"
4422 | RStat _ | RStatVFS _ ->
4429 let str = replace_str str "\r" "\\r" in
4430 let str = replace_str str "\n" "\\n" in
4431 let str = replace_str str "\t" "\\t" in
4432 let str = replace_str str "\000" "\\0" in
4435 (* Generate a lot of different functions for guestfish. *)
4436 and generate_fish_cmds () =
4437 generate_header CStyle GPLv2;
4441 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4443 let all_functions_sorted =
4445 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4446 ) all_functions_sorted in
4448 pr "#include <stdio.h>\n";
4449 pr "#include <stdlib.h>\n";
4450 pr "#include <string.h>\n";
4451 pr "#include <inttypes.h>\n";
4453 pr "#include <guestfs.h>\n";
4454 pr "#include \"fish.h\"\n";
4457 (* list_commands function, which implements guestfish -h *)
4458 pr "void list_commands (void)\n";
4460 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
4461 pr " list_builtin_commands ();\n";
4463 fun (name, _, _, flags, _, shortdesc, _) ->
4464 let name = replace_char name '_' '-' in
4465 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4467 ) all_functions_sorted;
4468 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4472 (* display_command function, which implements guestfish -h cmd *)
4473 pr "void display_command (const char *cmd)\n";
4476 fun (name, style, _, flags, _, shortdesc, longdesc) ->
4477 let name2 = replace_char name '_' '-' in
4479 try find_map (function FishAlias n -> Some n | _ -> None) flags
4480 with Not_found -> name in
4481 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4483 match snd style with
4487 name2 (String.concat "> <" (List.map name_of_argt args)) in
4490 if List.mem ProtocolLimitWarning flags then
4491 ("\n\n" ^ protocol_limit_warning)
4494 (* For DangerWillRobinson commands, we should probably have
4495 * guestfish prompt before allowing you to use them (especially
4496 * in interactive mode). XXX
4500 if List.mem DangerWillRobinson flags then
4501 ("\n\n" ^ danger_will_robinson)
4504 let describe_alias =
4505 if name <> alias then
4506 sprintf "\n\nYou can use '%s' as an alias for this command." alias
4510 pr "strcasecmp (cmd, \"%s\") == 0" name;
4511 if name <> name2 then
4512 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4513 if name <> alias then
4514 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4516 pr " pod2text (\"%s - %s\", %S);\n"
4518 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4521 pr " display_builtin_command (cmd);\n";
4525 (* print_{pv,vg,lv}_list functions *)
4529 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4536 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4538 pr " printf (\"%s: \");\n" name;
4539 pr " for (i = 0; i < 32; ++i)\n";
4540 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
4541 pr " printf (\"\\n\");\n"
4543 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4545 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4546 | name, `OptPercent ->
4547 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4548 typ name name typ name;
4549 pr " else printf (\"%s: \\n\");\n" name
4553 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4558 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4559 pr " print_%s (&%ss->val[i]);\n" typ typ;
4562 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4564 (* print_{stat,statvfs} functions *)
4568 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4573 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4577 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4579 (* run_<action> actions *)
4581 fun (name, style, _, flags, _, _, _) ->
4582 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4584 (match fst style with
4587 | RBool _ -> pr " int r;\n"
4588 | RInt64 _ -> pr " int64_t r;\n"
4589 | RConstString _ -> pr " const char *r;\n"
4590 | RString _ -> pr " char *r;\n"
4591 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4592 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4593 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4594 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4595 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4596 | RStat _ -> pr " struct guestfs_stat *r;\n"
4597 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4604 | FileOut n -> pr " const char *%s;\n" n
4605 | StringList n -> pr " char **%s;\n" n
4606 | Bool n -> pr " int %s;\n" n
4607 | Int n -> pr " int %s;\n" n
4610 (* Check and convert parameters. *)
4611 let argc_expected = List.length (snd style) in
4612 pr " if (argc != %d) {\n" argc_expected;
4613 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4615 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4621 | String name -> pr " %s = argv[%d];\n" name i
4623 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4626 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4629 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4631 | StringList name ->
4632 pr " %s = parse_string_list (argv[%d]);\n" name i
4634 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4636 pr " %s = atoi (argv[%d]);\n" name i
4639 (* Call C API function. *)
4641 try find_map (function FishAction n -> Some n | _ -> None) flags
4642 with Not_found -> sprintf "guestfs_%s" name in
4644 generate_call_args ~handle:"g" (snd style);
4647 (* Check return value for errors and display command results. *)
4648 (match fst style with
4649 | RErr -> pr " return r;\n"
4651 pr " if (r == -1) return -1;\n";
4652 pr " printf (\"%%d\\n\", r);\n";
4655 pr " if (r == -1) return -1;\n";
4656 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4659 pr " if (r == -1) return -1;\n";
4660 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4663 pr " if (r == NULL) return -1;\n";
4664 pr " printf (\"%%s\\n\", r);\n";
4667 pr " if (r == NULL) return -1;\n";
4668 pr " printf (\"%%s\\n\", r);\n";
4672 pr " if (r == NULL) return -1;\n";
4673 pr " print_strings (r);\n";
4674 pr " free_strings (r);\n";
4677 pr " if (r == NULL) return -1;\n";
4678 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4679 pr " r->b ? \"true\" : \"false\");\n";
4680 pr " guestfs_free_int_bool (r);\n";
4683 pr " if (r == NULL) return -1;\n";
4684 pr " print_pv_list (r);\n";
4685 pr " guestfs_free_lvm_pv_list (r);\n";
4688 pr " if (r == NULL) return -1;\n";
4689 pr " print_vg_list (r);\n";
4690 pr " guestfs_free_lvm_vg_list (r);\n";
4693 pr " if (r == NULL) return -1;\n";
4694 pr " print_lv_list (r);\n";
4695 pr " guestfs_free_lvm_lv_list (r);\n";
4698 pr " if (r == NULL) return -1;\n";
4699 pr " print_stat (r);\n";
4703 pr " if (r == NULL) return -1;\n";
4704 pr " print_statvfs (r);\n";
4708 pr " if (r == NULL) return -1;\n";
4709 pr " print_table (r);\n";
4710 pr " free_strings (r);\n";
4717 (* run_action function *)
4718 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4721 fun (name, _, _, flags, _, _, _) ->
4722 let name2 = replace_char name '_' '-' in
4724 try find_map (function FishAlias n -> Some n | _ -> None) flags
4725 with Not_found -> name in
4727 pr "strcasecmp (cmd, \"%s\") == 0" name;
4728 if name <> name2 then
4729 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4730 if name <> alias then
4731 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4733 pr " return run_%s (cmd, argc, argv);\n" name;
4737 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4744 (* Readline completion for guestfish. *)
4745 and generate_fish_completion () =
4746 generate_header CStyle GPLv2;
4750 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4760 #ifdef HAVE_LIBREADLINE
4761 #include <readline/readline.h>
4766 #ifdef HAVE_LIBREADLINE
4768 static const char *const commands[] = {
4769 BUILTIN_COMMANDS_FOR_COMPLETION,
4772 (* Get the commands, including the aliases. They don't need to be
4773 * sorted - the generator() function just does a dumb linear search.
4777 fun (name, _, _, flags, _, _, _) ->
4778 let name2 = replace_char name '_' '-' in
4780 try find_map (function FishAlias n -> Some n | _ -> None) flags
4781 with Not_found -> name in
4783 if name <> alias then [name2; alias] else [name2]
4785 let commands = List.flatten commands in
4787 List.iter (pr " \"%s\",\n") commands;
4793 generator (const char *text, int state)
4795 static int index, len;
4800 len = strlen (text);
4803 while ((name = commands[index]) != NULL) {
4805 if (strncasecmp (name, text, len) == 0)
4806 return strdup (name);
4812 #endif /* HAVE_LIBREADLINE */
4814 char **do_completion (const char *text, int start, int end)
4816 char **matches = NULL;
4818 #ifdef HAVE_LIBREADLINE
4820 matches = rl_completion_matches (text, generator);
4827 (* Generate the POD documentation for guestfish. *)
4828 and generate_fish_actions_pod () =
4829 let all_functions_sorted =
4831 fun (_, _, _, flags, _, _, _) ->
4832 not (List.mem NotInFish flags || List.mem NotInDocs flags)
4833 ) all_functions_sorted in
4835 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4838 fun (name, style, _, flags, _, _, longdesc) ->
4840 Str.global_substitute rex (
4843 try Str.matched_group 1 s
4845 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4846 "C<" ^ replace_char sub '_' '-' ^ ">"
4848 let name = replace_char name '_' '-' in
4850 try find_map (function FishAlias n -> Some n | _ -> None) flags
4851 with Not_found -> name in
4853 pr "=head2 %s" name;
4854 if name <> alias then
4861 | String n -> pr " %s" n
4862 | OptString n -> pr " %s" n
4863 | StringList n -> pr " '%s ...'" n
4864 | Bool _ -> pr " true|false"
4865 | Int n -> pr " %s" n
4866 | FileIn n | FileOut n -> pr " (%s|-)" n
4870 pr "%s\n\n" longdesc;
4872 if List.exists (function FileIn _ | FileOut _ -> true
4873 | _ -> false) (snd style) then
4874 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4876 if List.mem ProtocolLimitWarning flags then
4877 pr "%s\n\n" protocol_limit_warning;
4879 if List.mem DangerWillRobinson flags then
4880 pr "%s\n\n" danger_will_robinson
4881 ) all_functions_sorted
4883 (* Generate a C function prototype. *)
4884 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4885 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4887 ?handle name style =
4888 if extern then pr "extern ";
4889 if static then pr "static ";
4890 (match fst style with
4892 | RInt _ -> pr "int "
4893 | RInt64 _ -> pr "int64_t "
4894 | RBool _ -> pr "int "
4895 | RConstString _ -> pr "const char *"
4896 | RString _ -> pr "char *"
4897 | RStringList _ | RHashtable _ -> pr "char **"
4899 if not in_daemon then pr "struct guestfs_int_bool *"
4900 else pr "guestfs_%s_ret *" name
4902 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4903 else pr "guestfs_lvm_int_pv_list *"
4905 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4906 else pr "guestfs_lvm_int_vg_list *"
4908 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4909 else pr "guestfs_lvm_int_lv_list *"
4911 if not in_daemon then pr "struct guestfs_stat *"
4912 else pr "guestfs_int_stat *"
4914 if not in_daemon then pr "struct guestfs_statvfs *"
4915 else pr "guestfs_int_statvfs *"
4917 pr "%s%s (" prefix name;
4918 if handle = None && List.length (snd style) = 0 then
4921 let comma = ref false in
4924 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4928 if single_line then pr ", " else pr ",\n\t\t"
4937 if not in_daemon then pr "const char *%s" n
4938 else pr "char *%s" n
4941 if not in_daemon then pr "char * const* const %s" n
4942 else pr "char **%s" n
4943 | Bool n -> next (); pr "int %s" n
4944 | Int n -> next (); pr "int %s" n
4947 if not in_daemon then (next (); pr "const char *%s" n)
4951 if semicolon then pr ";";
4952 if newline then pr "\n"
4954 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4955 and generate_call_args ?handle args =
4957 let comma = ref false in
4960 | Some handle -> pr "%s" handle; comma := true
4964 if !comma then pr ", ";
4966 pr "%s" (name_of_argt arg)
4970 (* Generate the OCaml bindings interface. *)
4971 and generate_ocaml_mli () =
4972 generate_header OCamlStyle LGPLv2;
4975 (** For API documentation you should refer to the C API
4976 in the guestfs(3) manual page. The OCaml API uses almost
4977 exactly the same calls. *)
4980 (** A [guestfs_h] handle. *)
4982 exception Error of string
4983 (** This exception is raised when there is an error. *)
4985 val create : unit -> t
4987 val close : t -> unit
4988 (** Handles are closed by the garbage collector when they become
4989 unreferenced, but callers can also call this in order to
4990 provide predictable cleanup. *)
4993 generate_ocaml_lvm_structure_decls ();
4995 generate_ocaml_stat_structure_decls ();
4999 fun (name, style, _, _, _, shortdesc, _) ->
5000 generate_ocaml_prototype name style;
5001 pr "(** %s *)\n" shortdesc;
5005 (* Generate the OCaml bindings implementation. *)
5006 and generate_ocaml_ml () =
5007 generate_header OCamlStyle LGPLv2;
5011 exception Error of string
5012 external create : unit -> t = \"ocaml_guestfs_create\"
5013 external close : t -> unit = \"ocaml_guestfs_close\"
5016 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5020 generate_ocaml_lvm_structure_decls ();
5022 generate_ocaml_stat_structure_decls ();
5026 fun (name, style, _, _, _, shortdesc, _) ->
5027 generate_ocaml_prototype ~is_external:true name style;
5030 (* Generate the OCaml bindings C implementation. *)
5031 and generate_ocaml_c () =
5032 generate_header CStyle LGPLv2;
5039 #include <caml/config.h>
5040 #include <caml/alloc.h>
5041 #include <caml/callback.h>
5042 #include <caml/fail.h>
5043 #include <caml/memory.h>
5044 #include <caml/mlvalues.h>
5045 #include <caml/signals.h>
5047 #include <guestfs.h>
5049 #include \"guestfs_c.h\"
5051 /* Copy a hashtable of string pairs into an assoc-list. We return
5052 * the list in reverse order, but hashtables aren't supposed to be
5055 static CAMLprim value
5056 copy_table (char * const * argv)
5059 CAMLlocal5 (rv, pairv, kv, vv, cons);
5063 for (i = 0; argv[i] != NULL; i += 2) {
5064 kv = caml_copy_string (argv[i]);
5065 vv = caml_copy_string (argv[i+1]);
5066 pairv = caml_alloc (2, 0);
5067 Store_field (pairv, 0, kv);
5068 Store_field (pairv, 1, vv);
5069 cons = caml_alloc (2, 0);
5070 Store_field (cons, 1, rv);
5072 Store_field (cons, 0, pairv);
5080 (* LVM struct copy functions. *)
5083 let has_optpercent_col =
5084 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
5086 pr "static CAMLprim value\n";
5087 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
5089 pr " CAMLparam0 ();\n";
5090 if has_optpercent_col then
5091 pr " CAMLlocal3 (rv, v, v2);\n"
5093 pr " CAMLlocal2 (rv, v);\n";
5095 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5100 pr " v = caml_copy_string (%s->%s);\n" typ name
5102 pr " v = caml_alloc_string (32);\n";
5103 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5106 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5107 | name, `OptPercent ->
5108 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5109 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5110 pr " v = caml_alloc (1, 0);\n";
5111 pr " Store_field (v, 0, v2);\n";
5112 pr " } else /* None */\n";
5113 pr " v = Val_int (0);\n";
5115 pr " Store_field (rv, %d, v);\n" i
5117 pr " CAMLreturn (rv);\n";
5121 pr "static CAMLprim value\n";
5122 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
5125 pr " CAMLparam0 ();\n";
5126 pr " CAMLlocal2 (rv, v);\n";
5129 pr " if (%ss->len == 0)\n" typ;
5130 pr " CAMLreturn (Atom (0));\n";
5132 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5133 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5134 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
5135 pr " caml_modify (&Field (rv, i), v);\n";
5137 pr " CAMLreturn (rv);\n";
5141 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5143 (* Stat copy functions. *)
5146 pr "static CAMLprim value\n";
5147 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5149 pr " CAMLparam0 ();\n";
5150 pr " CAMLlocal2 (rv, v);\n";
5152 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5157 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5159 pr " Store_field (rv, %d, v);\n" i
5161 pr " CAMLreturn (rv);\n";
5164 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5168 fun (name, style, _, _, _, _, _) ->
5170 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5172 pr "CAMLprim value\n";
5173 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5174 List.iter (pr ", value %s") (List.tl params);
5179 | [p1; p2; p3; p4; p5] ->
5180 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5181 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5182 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5183 pr " CAMLxparam%d (%s);\n"
5184 (List.length rest) (String.concat ", " rest)
5186 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5188 pr " CAMLlocal1 (rv);\n";
5191 pr " guestfs_h *g = Guestfs_val (gv);\n";
5192 pr " if (g == NULL)\n";
5193 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5201 pr " const char *%s = String_val (%sv);\n" n n
5203 pr " const char *%s =\n" n;
5204 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5207 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5209 pr " int %s = Bool_val (%sv);\n" n n
5211 pr " int %s = Int_val (%sv);\n" n n
5214 match fst style with
5215 | RErr -> pr " int r;\n"; "-1"
5216 | RInt _ -> pr " int r;\n"; "-1"
5217 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5218 | RBool _ -> pr " int r;\n"; "-1"
5219 | RConstString _ -> pr " const char *r;\n"; "NULL"
5220 | RString _ -> pr " char *r;\n"; "NULL"
5226 pr " struct guestfs_int_bool *r;\n"; "NULL"
5228 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5230 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5232 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5234 pr " struct guestfs_stat *r;\n"; "NULL"
5236 pr " struct guestfs_statvfs *r;\n"; "NULL"
5243 pr " caml_enter_blocking_section ();\n";
5244 pr " r = guestfs_%s " name;
5245 generate_call_args ~handle:"g" (snd style);
5247 pr " caml_leave_blocking_section ();\n";
5252 pr " ocaml_guestfs_free_strings (%s);\n" n;
5253 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5256 pr " if (r == %s)\n" error_code;
5257 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5260 (match fst style with
5261 | RErr -> pr " rv = Val_unit;\n"
5262 | RInt _ -> pr " rv = Val_int (r);\n"
5264 pr " rv = caml_copy_int64 (r);\n"
5265 | RBool _ -> pr " rv = Val_bool (r);\n"
5266 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5268 pr " rv = caml_copy_string (r);\n";
5271 pr " rv = caml_copy_string_array ((const char **) r);\n";
5272 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5275 pr " rv = caml_alloc (2, 0);\n";
5276 pr " Store_field (rv, 0, Val_int (r->i));\n";
5277 pr " Store_field (rv, 1, Val_bool (r->b));\n";
5278 pr " guestfs_free_int_bool (r);\n";
5280 pr " rv = copy_lvm_pv_list (r);\n";
5281 pr " guestfs_free_lvm_pv_list (r);\n";
5283 pr " rv = copy_lvm_vg_list (r);\n";
5284 pr " guestfs_free_lvm_vg_list (r);\n";
5286 pr " rv = copy_lvm_lv_list (r);\n";
5287 pr " guestfs_free_lvm_lv_list (r);\n";
5289 pr " rv = copy_stat (r);\n";
5292 pr " rv = copy_statvfs (r);\n";
5295 pr " rv = copy_table (r);\n";
5296 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5300 pr " CAMLreturn (rv);\n";
5304 if List.length params > 5 then (
5305 pr "CAMLprim value\n";
5306 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5308 pr " return ocaml_guestfs_%s (argv[0]" name;
5309 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5316 and generate_ocaml_lvm_structure_decls () =
5319 pr "type lvm_%s = {\n" typ;
5322 | name, `String -> pr " %s : string;\n" name
5323 | name, `UUID -> pr " %s : string;\n" name
5324 | name, `Bytes -> pr " %s : int64;\n" name
5325 | name, `Int -> pr " %s : int64;\n" name
5326 | name, `OptPercent -> pr " %s : float option;\n" name
5330 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
5332 and generate_ocaml_stat_structure_decls () =
5335 pr "type %s = {\n" typ;
5338 | name, `Int -> pr " %s : int64;\n" name
5342 ) ["stat", stat_cols; "statvfs", statvfs_cols]
5344 and generate_ocaml_prototype ?(is_external = false) name style =
5345 if is_external then pr "external " else pr "val ";
5346 pr "%s : t -> " name;
5349 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5350 | OptString _ -> pr "string option -> "
5351 | StringList _ -> pr "string array -> "
5352 | Bool _ -> pr "bool -> "
5353 | Int _ -> pr "int -> "
5355 (match fst style with
5356 | RErr -> pr "unit" (* all errors are turned into exceptions *)
5357 | RInt _ -> pr "int"
5358 | RInt64 _ -> pr "int64"
5359 | RBool _ -> pr "bool"
5360 | RConstString _ -> pr "string"
5361 | RString _ -> pr "string"
5362 | RStringList _ -> pr "string array"
5363 | RIntBool _ -> pr "int * bool"
5364 | RPVList _ -> pr "lvm_pv array"
5365 | RVGList _ -> pr "lvm_vg array"
5366 | RLVList _ -> pr "lvm_lv array"
5367 | RStat _ -> pr "stat"
5368 | RStatVFS _ -> pr "statvfs"
5369 | RHashtable _ -> pr "(string * string) list"
5371 if is_external then (
5373 if List.length (snd style) + 1 > 5 then
5374 pr "\"ocaml_guestfs_%s_byte\" " name;
5375 pr "\"ocaml_guestfs_%s\"" name
5379 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5380 and generate_perl_xs () =
5381 generate_header CStyle LGPLv2;
5384 #include \"EXTERN.h\"
5388 #include <guestfs.h>
5391 #define PRId64 \"lld\"
5395 my_newSVll(long long val) {
5396 #ifdef USE_64_BIT_ALL
5397 return newSViv(val);
5401 len = snprintf(buf, 100, \"%%\" PRId64, val);
5402 return newSVpv(buf, len);
5407 #define PRIu64 \"llu\"
5411 my_newSVull(unsigned long long val) {
5412 #ifdef USE_64_BIT_ALL
5413 return newSVuv(val);
5417 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5418 return newSVpv(buf, len);
5422 /* http://www.perlmonks.org/?node_id=680842 */
5424 XS_unpack_charPtrPtr (SV *arg) {
5429 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5430 croak (\"array reference expected\");
5432 av = (AV *)SvRV (arg);
5433 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5435 croak (\"malloc failed\");
5437 for (i = 0; i <= av_len (av); i++) {
5438 SV **elem = av_fetch (av, i, 0);
5440 if (!elem || !*elem)
5441 croak (\"missing element in list\");
5443 ret[i] = SvPV_nolen (*elem);
5451 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5458 RETVAL = guestfs_create ();
5460 croak (\"could not create guestfs handle\");
5461 guestfs_set_error_handler (RETVAL, NULL, NULL);
5474 fun (name, style, _, _, _, _, _) ->
5475 (match fst style with
5476 | RErr -> pr "void\n"
5477 | RInt _ -> pr "SV *\n"
5478 | RInt64 _ -> pr "SV *\n"
5479 | RBool _ -> pr "SV *\n"
5480 | RConstString _ -> pr "SV *\n"
5481 | RString _ -> pr "SV *\n"
5484 | RPVList _ | RVGList _ | RLVList _
5485 | RStat _ | RStatVFS _
5487 pr "void\n" (* all lists returned implictly on the stack *)
5489 (* Call and arguments. *)
5491 generate_call_args ~handle:"g" (snd style);
5493 pr " guestfs_h *g;\n";
5497 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5499 (* http://www.perlmonks.org/?node_id=554277
5500 * Note that the implicit handle argument means we have
5501 * to add 1 to the ST(x) operator.
5503 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5504 | StringList n -> pr " char **%s;\n" n
5505 | Bool n -> pr " int %s;\n" n
5506 | Int n -> pr " int %s;\n" n
5509 let do_cleanups () =
5512 | String _ | OptString _ | Bool _ | Int _
5513 | FileIn _ | FileOut _ -> ()
5514 | StringList n -> pr " free (%s);\n" n
5519 (match fst style with
5524 pr " r = guestfs_%s " name;
5525 generate_call_args ~handle:"g" (snd style);
5528 pr " if (r == -1)\n";
5529 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5535 pr " %s = guestfs_%s " n name;
5536 generate_call_args ~handle:"g" (snd style);
5539 pr " if (%s == -1)\n" n;
5540 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5541 pr " RETVAL = newSViv (%s);\n" n;
5546 pr " int64_t %s;\n" n;
5548 pr " %s = guestfs_%s " n name;
5549 generate_call_args ~handle:"g" (snd style);
5552 pr " if (%s == -1)\n" n;
5553 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5554 pr " RETVAL = my_newSVll (%s);\n" n;
5559 pr " const char *%s;\n" n;
5561 pr " %s = guestfs_%s " n name;
5562 generate_call_args ~handle:"g" (snd style);
5565 pr " if (%s == NULL)\n" n;
5566 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5567 pr " RETVAL = newSVpv (%s, 0);\n" n;
5572 pr " char *%s;\n" n;
5574 pr " %s = guestfs_%s " n name;
5575 generate_call_args ~handle:"g" (snd style);
5578 pr " if (%s == NULL)\n" n;
5579 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5580 pr " RETVAL = newSVpv (%s, 0);\n" n;
5581 pr " free (%s);\n" n;
5584 | RStringList n | RHashtable n ->
5586 pr " char **%s;\n" n;
5589 pr " %s = guestfs_%s " n name;
5590 generate_call_args ~handle:"g" (snd style);
5593 pr " if (%s == NULL)\n" n;
5594 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5595 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5596 pr " EXTEND (SP, n);\n";
5597 pr " for (i = 0; i < n; ++i) {\n";
5598 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5599 pr " free (%s[i]);\n" n;
5601 pr " free (%s);\n" n;
5604 pr " struct guestfs_int_bool *r;\n";
5606 pr " r = guestfs_%s " name;
5607 generate_call_args ~handle:"g" (snd style);
5610 pr " if (r == NULL)\n";
5611 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5612 pr " EXTEND (SP, 2);\n";
5613 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5614 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5615 pr " guestfs_free_int_bool (r);\n";
5617 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5619 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5621 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5623 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5625 generate_perl_stat_code
5626 "statvfs" statvfs_cols name style n do_cleanups
5632 and generate_perl_lvm_code typ cols name style n do_cleanups =
5634 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5638 pr " %s = guestfs_%s " n name;
5639 generate_call_args ~handle:"g" (snd style);
5642 pr " if (%s == NULL)\n" n;
5643 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5644 pr " EXTEND (SP, %s->len);\n" n;
5645 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5646 pr " hv = newHV ();\n";
5650 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5651 name (String.length name) n name
5653 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5654 name (String.length name) n name
5656 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5657 name (String.length name) n name
5659 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5660 name (String.length name) n name
5661 | name, `OptPercent ->
5662 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5663 name (String.length name) n name
5665 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5667 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5669 and generate_perl_stat_code typ cols name style n do_cleanups =
5671 pr " struct guestfs_%s *%s;\n" typ n;
5673 pr " %s = guestfs_%s " n name;
5674 generate_call_args ~handle:"g" (snd style);
5677 pr " if (%s == NULL)\n" n;
5678 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5679 pr " EXTEND (SP, %d);\n" (List.length cols);
5683 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5685 pr " free (%s);\n" n
5687 (* Generate Sys/Guestfs.pm. *)
5688 and generate_perl_pm () =
5689 generate_header HashStyle LGPLv2;
5696 Sys::Guestfs - Perl bindings for libguestfs
5702 my $h = Sys::Guestfs->new ();
5703 $h->add_drive ('guest.img');
5706 $h->mount ('/dev/sda1', '/');
5707 $h->touch ('/hello');
5712 The C<Sys::Guestfs> module provides a Perl XS binding to the
5713 libguestfs API for examining and modifying virtual machine
5716 Amongst the things this is good for: making batch configuration
5717 changes to guests, getting disk used/free statistics (see also:
5718 virt-df), migrating between virtualization systems (see also:
5719 virt-p2v), performing partial backups, performing partial guest
5720 clones, cloning guests and changing registry/UUID/hostname info, and
5723 Libguestfs uses Linux kernel and qemu code, and can access any type of
5724 guest filesystem that Linux and qemu can, including but not limited
5725 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5726 schemes, qcow, qcow2, vmdk.
5728 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5729 LVs, what filesystem is in each LV, etc.). It can also run commands
5730 in the context of the guest. Also you can access filesystems over FTP.
5734 All errors turn into calls to C<croak> (see L<Carp(3)>).
5742 package Sys::Guestfs;
5748 XSLoader::load ('Sys::Guestfs');
5750 =item $h = Sys::Guestfs->new ();
5752 Create a new guestfs handle.
5758 my $class = ref ($proto) || $proto;
5760 my $self = Sys::Guestfs::_create ();
5761 bless $self, $class;
5767 (* Actions. We only need to print documentation for these as
5768 * they are pulled in from the XS code automatically.
5771 fun (name, style, _, flags, _, _, longdesc) ->
5772 if not (List.mem NotInDocs flags) then (
5773 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5775 generate_perl_prototype name style;
5777 pr "%s\n\n" longdesc;
5778 if List.mem ProtocolLimitWarning flags then
5779 pr "%s\n\n" protocol_limit_warning;
5780 if List.mem DangerWillRobinson flags then
5781 pr "%s\n\n" danger_will_robinson
5783 ) all_functions_sorted;
5795 Copyright (C) 2009 Red Hat Inc.
5799 Please see the file COPYING.LIB for the full license.
5803 L<guestfs(3)>, L<guestfish(1)>.
5808 and generate_perl_prototype name style =
5809 (match fst style with
5815 | RString n -> pr "$%s = " n
5816 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5820 | RLVList n -> pr "@%s = " n
5823 | RHashtable n -> pr "%%%s = " n
5826 let comma = ref false in
5829 if !comma then pr ", ";
5832 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5839 (* Generate Python C module. *)
5840 and generate_python_c () =
5841 generate_header CStyle LGPLv2;
5850 #include \"guestfs.h\"
5858 get_handle (PyObject *obj)
5861 assert (obj != Py_None);
5862 return ((Pyguestfs_Object *) obj)->g;
5866 put_handle (guestfs_h *g)
5870 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5873 /* This list should be freed (but not the strings) after use. */
5874 static const char **
5875 get_string_list (PyObject *obj)
5882 if (!PyList_Check (obj)) {
5883 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5887 len = PyList_Size (obj);
5888 r = malloc (sizeof (char *) * (len+1));
5890 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5894 for (i = 0; i < len; ++i)
5895 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5902 put_string_list (char * const * const argv)
5907 for (argc = 0; argv[argc] != NULL; ++argc)
5910 list = PyList_New (argc);
5911 for (i = 0; i < argc; ++i)
5912 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5918 put_table (char * const * const argv)
5920 PyObject *list, *item;
5923 for (argc = 0; argv[argc] != NULL; ++argc)
5926 list = PyList_New (argc >> 1);
5927 for (i = 0; i < argc; i += 2) {
5928 item = PyTuple_New (2);
5929 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5930 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5931 PyList_SetItem (list, i >> 1, item);
5938 free_strings (char **argv)
5942 for (argc = 0; argv[argc] != NULL; ++argc)
5948 py_guestfs_create (PyObject *self, PyObject *args)
5952 g = guestfs_create ();
5954 PyErr_SetString (PyExc_RuntimeError,
5955 \"guestfs.create: failed to allocate handle\");
5958 guestfs_set_error_handler (g, NULL, NULL);
5959 return put_handle (g);
5963 py_guestfs_close (PyObject *self, PyObject *args)
5968 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5970 g = get_handle (py_g);
5974 Py_INCREF (Py_None);
5980 (* LVM structures, turned into Python dictionaries. *)
5983 pr "static PyObject *\n";
5984 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5986 pr " PyObject *dict;\n";
5988 pr " dict = PyDict_New ();\n";
5992 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5993 pr " PyString_FromString (%s->%s));\n"
5996 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5997 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6000 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6001 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6004 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6005 pr " PyLong_FromLongLong (%s->%s));\n"
6007 | name, `OptPercent ->
6008 pr " if (%s->%s >= 0)\n" typ name;
6009 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6010 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6013 pr " Py_INCREF (Py_None);\n";
6014 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6017 pr " return dict;\n";
6021 pr "static PyObject *\n";
6022 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
6024 pr " PyObject *list;\n";
6027 pr " list = PyList_New (%ss->len);\n" typ;
6028 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6029 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
6030 pr " return list;\n";
6033 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
6035 (* Stat structures, turned into Python dictionaries. *)
6038 pr "static PyObject *\n";
6039 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6041 pr " PyObject *dict;\n";
6043 pr " dict = PyDict_New ();\n";
6047 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6048 pr " PyLong_FromLongLong (%s->%s));\n"
6051 pr " return dict;\n";
6054 ) ["stat", stat_cols; "statvfs", statvfs_cols];
6056 (* Python wrapper functions. *)
6058 fun (name, style, _, _, _, _, _) ->
6059 pr "static PyObject *\n";
6060 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6063 pr " PyObject *py_g;\n";
6064 pr " guestfs_h *g;\n";
6065 pr " PyObject *py_r;\n";
6068 match fst style with
6069 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6070 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6071 | RConstString _ -> pr " const char *r;\n"; "NULL"
6072 | RString _ -> pr " char *r;\n"; "NULL"
6073 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6074 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6075 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6076 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6077 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6078 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6079 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6083 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6084 | OptString n -> pr " const char *%s;\n" n
6086 pr " PyObject *py_%s;\n" n;
6087 pr " const char **%s;\n" n
6088 | Bool n -> pr " int %s;\n" n
6089 | Int n -> pr " int %s;\n" n
6094 (* Convert the parameters. *)
6095 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6098 | String _ | FileIn _ | FileOut _ -> pr "s"
6099 | OptString _ -> pr "z"
6100 | StringList _ -> pr "O"
6101 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6104 pr ":guestfs_%s\",\n" name;
6108 | String n | FileIn n | FileOut n -> pr ", &%s" n
6109 | OptString n -> pr ", &%s" n
6110 | StringList n -> pr ", &py_%s" n
6111 | Bool n -> pr ", &%s" n
6112 | Int n -> pr ", &%s" n
6116 pr " return NULL;\n";
6118 pr " g = get_handle (py_g);\n";
6121 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6123 pr " %s = get_string_list (py_%s);\n" n n;
6124 pr " if (!%s) return NULL;\n" n
6129 pr " r = guestfs_%s " name;
6130 generate_call_args ~handle:"g" (snd style);
6135 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6137 pr " free (%s);\n" n
6140 pr " if (r == %s) {\n" error_code;
6141 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6142 pr " return NULL;\n";
6146 (match fst style with
6148 pr " Py_INCREF (Py_None);\n";
6149 pr " py_r = Py_None;\n"
6151 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6152 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6153 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6155 pr " py_r = PyString_FromString (r);\n";
6158 pr " py_r = put_string_list (r);\n";
6159 pr " free_strings (r);\n"
6161 pr " py_r = PyTuple_New (2);\n";
6162 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
6163 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
6164 pr " guestfs_free_int_bool (r);\n"
6166 pr " py_r = put_lvm_pv_list (r);\n";
6167 pr " guestfs_free_lvm_pv_list (r);\n"
6169 pr " py_r = put_lvm_vg_list (r);\n";
6170 pr " guestfs_free_lvm_vg_list (r);\n"
6172 pr " py_r = put_lvm_lv_list (r);\n";
6173 pr " guestfs_free_lvm_lv_list (r);\n"
6175 pr " py_r = put_stat (r);\n";
6178 pr " py_r = put_statvfs (r);\n";
6181 pr " py_r = put_table (r);\n";
6182 pr " free_strings (r);\n"
6185 pr " return py_r;\n";
6190 (* Table of functions. *)
6191 pr "static PyMethodDef methods[] = {\n";
6192 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6193 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6195 fun (name, _, _, _, _, _, _) ->
6196 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6199 pr " { NULL, NULL, 0, NULL }\n";
6203 (* Init function. *)
6206 initlibguestfsmod (void)
6208 static int initialized = 0;
6210 if (initialized) return;
6211 Py_InitModule ((char *) \"libguestfsmod\", methods);
6216 (* Generate Python module. *)
6217 and generate_python_py () =
6218 generate_header HashStyle LGPLv2;
6221 u\"\"\"Python bindings for libguestfs
6224 g = guestfs.GuestFS ()
6225 g.add_drive (\"guest.img\")
6228 parts = g.list_partitions ()
6230 The guestfs module provides a Python binding to the libguestfs API
6231 for examining and modifying virtual machine disk images.
6233 Amongst the things this is good for: making batch configuration
6234 changes to guests, getting disk used/free statistics (see also:
6235 virt-df), migrating between virtualization systems (see also:
6236 virt-p2v), performing partial backups, performing partial guest
6237 clones, cloning guests and changing registry/UUID/hostname info, and
6240 Libguestfs uses Linux kernel and qemu code, and can access any type of
6241 guest filesystem that Linux and qemu can, including but not limited
6242 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6243 schemes, qcow, qcow2, vmdk.
6245 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6246 LVs, what filesystem is in each LV, etc.). It can also run commands
6247 in the context of the guest. Also you can access filesystems over FTP.
6249 Errors which happen while using the API are turned into Python
6250 RuntimeError exceptions.
6252 To create a guestfs handle you usually have to perform the following
6255 # Create the handle, call add_drive at least once, and possibly
6256 # several times if the guest has multiple block devices:
6257 g = guestfs.GuestFS ()
6258 g.add_drive (\"guest.img\")
6260 # Launch the qemu subprocess and wait for it to become ready:
6264 # Now you can issue commands, for example:
6269 import libguestfsmod
6272 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6274 def __init__ (self):
6275 \"\"\"Create a new libguestfs handle.\"\"\"
6276 self._o = libguestfsmod.create ()
6279 libguestfsmod.close (self._o)
6284 fun (name, style, _, flags, _, _, longdesc) ->
6286 generate_call_args ~handle:"self" (snd style);
6289 if not (List.mem NotInDocs flags) then (
6290 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6292 match fst style with
6293 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6296 doc ^ "\n\nThis function returns a list of strings."
6298 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
6300 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
6302 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
6304 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
6306 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
6308 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
6310 doc ^ "\n\nThis function returns a dictionary." in
6312 if List.mem ProtocolLimitWarning flags then
6313 doc ^ "\n\n" ^ protocol_limit_warning
6316 if List.mem DangerWillRobinson flags then
6317 doc ^ "\n\n" ^ danger_will_robinson
6319 let doc = pod2text ~width:60 name doc in
6320 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6321 let doc = String.concat "\n " doc in
6322 pr " u\"\"\"%s\"\"\"\n" doc;
6324 pr " return libguestfsmod.%s " name;
6325 generate_call_args ~handle:"self._o" (snd style);
6330 (* Useful if you need the longdesc POD text as plain text. Returns a
6333 * This is the slowest thing about autogeneration.
6335 and pod2text ~width name longdesc =
6336 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6337 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6339 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6340 let chan = Unix.open_process_in cmd in
6341 let lines = ref [] in
6343 let line = input_line chan in
6344 if i = 1 then (* discard the first line of output *)
6347 let line = triml line in
6348 lines := line :: !lines;
6351 let lines = try loop 1 with End_of_file -> List.rev !lines in
6352 Unix.unlink filename;
6353 match Unix.close_process_in chan with
6354 | Unix.WEXITED 0 -> lines
6356 failwithf "pod2text: process exited with non-zero status (%d)" i
6357 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6358 failwithf "pod2text: process signalled or stopped by signal %d" i
6360 (* Generate ruby bindings. *)
6361 and generate_ruby_c () =
6362 generate_header CStyle LGPLv2;
6370 #include \"guestfs.h\"
6372 #include \"extconf.h\"
6374 /* For Ruby < 1.9 */
6376 #define RARRAY_LEN(r) (RARRAY((r))->len)
6379 static VALUE m_guestfs; /* guestfs module */
6380 static VALUE c_guestfs; /* guestfs_h handle */
6381 static VALUE e_Error; /* used for all errors */
6383 static void ruby_guestfs_free (void *p)
6386 guestfs_close ((guestfs_h *) p);
6389 static VALUE ruby_guestfs_create (VALUE m)
6393 g = guestfs_create ();
6395 rb_raise (e_Error, \"failed to create guestfs handle\");
6397 /* Don't print error messages to stderr by default. */
6398 guestfs_set_error_handler (g, NULL, NULL);
6400 /* Wrap it, and make sure the close function is called when the
6403 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6406 static VALUE ruby_guestfs_close (VALUE gv)
6409 Data_Get_Struct (gv, guestfs_h, g);
6411 ruby_guestfs_free (g);
6412 DATA_PTR (gv) = NULL;
6420 fun (name, style, _, _, _, _, _) ->
6421 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6422 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6425 pr " guestfs_h *g;\n";
6426 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6428 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6434 | String n | FileIn n | FileOut n ->
6435 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6437 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6438 pr " \"%s\", \"%s\");\n" n name
6440 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6444 pr " int i, len;\n";
6445 pr " len = RARRAY_LEN (%sv);\n" n;
6446 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6448 pr " for (i = 0; i < len; ++i) {\n";
6449 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6450 pr " %s[i] = StringValueCStr (v);\n" n;
6452 pr " %s[len] = NULL;\n" n;
6455 pr " int %s = RTEST (%sv);\n" n n
6457 pr " int %s = NUM2INT (%sv);\n" n n
6462 match fst style with
6463 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6464 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6465 | RConstString _ -> pr " const char *r;\n"; "NULL"
6466 | RString _ -> pr " char *r;\n"; "NULL"
6467 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6468 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6469 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6470 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6471 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6472 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6473 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6476 pr " r = guestfs_%s " name;
6477 generate_call_args ~handle:"g" (snd style);
6482 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6484 pr " free (%s);\n" n
6487 pr " if (r == %s)\n" error_code;
6488 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6491 (match fst style with
6493 pr " return Qnil;\n"
6494 | RInt _ | RBool _ ->
6495 pr " return INT2NUM (r);\n"
6497 pr " return ULL2NUM (r);\n"
6499 pr " return rb_str_new2 (r);\n";
6501 pr " VALUE rv = rb_str_new2 (r);\n";
6505 pr " int i, len = 0;\n";
6506 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6507 pr " VALUE rv = rb_ary_new2 (len);\n";
6508 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6509 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6510 pr " free (r[i]);\n";
6515 pr " VALUE rv = rb_ary_new2 (2);\n";
6516 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
6517 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
6518 pr " guestfs_free_int_bool (r);\n";
6521 generate_ruby_lvm_code "pv" pv_cols
6523 generate_ruby_lvm_code "vg" vg_cols
6525 generate_ruby_lvm_code "lv" lv_cols
6527 pr " VALUE rv = rb_hash_new ();\n";
6531 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6536 pr " VALUE rv = rb_hash_new ();\n";
6540 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6545 pr " VALUE rv = rb_hash_new ();\n";
6547 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
6548 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6549 pr " free (r[i]);\n";
6550 pr " free (r[i+1]);\n";
6561 /* Initialize the module. */
6562 void Init__guestfs ()
6564 m_guestfs = rb_define_module (\"Guestfs\");
6565 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6566 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6568 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6569 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6572 (* Define the rest of the methods. *)
6574 fun (name, style, _, _, _, _, _) ->
6575 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
6576 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6581 (* Ruby code to return an LVM struct list. *)
6582 and generate_ruby_lvm_code typ cols =
6583 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6585 pr " for (i = 0; i < r->len; ++i) {\n";
6586 pr " VALUE hv = rb_hash_new ();\n";
6590 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6592 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6595 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6596 | name, `OptPercent ->
6597 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6599 pr " rb_ary_push (rv, hv);\n";
6601 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6604 (* Generate Java bindings GuestFS.java file. *)
6605 and generate_java_java () =
6606 generate_header CStyle LGPLv2;
6609 package com.redhat.et.libguestfs;
6611 import java.util.HashMap;
6612 import com.redhat.et.libguestfs.LibGuestFSException;
6613 import com.redhat.et.libguestfs.PV;
6614 import com.redhat.et.libguestfs.VG;
6615 import com.redhat.et.libguestfs.LV;
6616 import com.redhat.et.libguestfs.Stat;
6617 import com.redhat.et.libguestfs.StatVFS;
6618 import com.redhat.et.libguestfs.IntBool;
6621 * The GuestFS object is a libguestfs handle.
6625 public class GuestFS {
6626 // Load the native code.
6628 System.loadLibrary (\"guestfs_jni\");
6632 * The native guestfs_h pointer.
6637 * Create a libguestfs handle.
6639 * @throws LibGuestFSException
6641 public GuestFS () throws LibGuestFSException
6645 private native long _create () throws LibGuestFSException;
6648 * Close a libguestfs handle.
6650 * You can also leave handles to be collected by the garbage
6651 * collector, but this method ensures that the resources used
6652 * by the handle are freed up immediately. If you call any
6653 * other methods after closing the handle, you will get an
6656 * @throws LibGuestFSException
6658 public void close () throws LibGuestFSException
6664 private native void _close (long g) throws LibGuestFSException;
6666 public void finalize () throws LibGuestFSException
6674 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6675 if not (List.mem NotInDocs flags); then (
6676 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6678 if List.mem ProtocolLimitWarning flags then
6679 doc ^ "\n\n" ^ protocol_limit_warning
6682 if List.mem DangerWillRobinson flags then
6683 doc ^ "\n\n" ^ danger_will_robinson
6685 let doc = pod2text ~width:60 name doc in
6686 let doc = List.map ( (* RHBZ#501883 *)
6689 | nonempty -> nonempty
6691 let doc = String.concat "\n * " doc in
6694 pr " * %s\n" shortdesc;
6697 pr " * @throws LibGuestFSException\n";
6701 generate_java_prototype ~public:true ~semicolon:false name style;
6704 pr " if (g == 0)\n";
6705 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6708 if fst style <> RErr then pr "return ";
6710 generate_call_args ~handle:"g" (snd style);
6714 generate_java_prototype ~privat:true ~native:true name style;
6721 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6722 ?(semicolon=true) name style =
6723 if privat then pr "private ";
6724 if public then pr "public ";
6725 if native then pr "native ";
6728 (match fst style with
6729 | RErr -> pr "void ";
6730 | RInt _ -> pr "int ";
6731 | RInt64 _ -> pr "long ";
6732 | RBool _ -> pr "boolean ";
6733 | RConstString _ | RString _ -> pr "String ";
6734 | RStringList _ -> pr "String[] ";
6735 | RIntBool _ -> pr "IntBool ";
6736 | RPVList _ -> pr "PV[] ";
6737 | RVGList _ -> pr "VG[] ";
6738 | RLVList _ -> pr "LV[] ";
6739 | RStat _ -> pr "Stat ";
6740 | RStatVFS _ -> pr "StatVFS ";
6741 | RHashtable _ -> pr "HashMap<String,String> ";
6744 if native then pr "_%s " name else pr "%s " name;
6746 let needs_comma = ref false in
6755 if !needs_comma then pr ", ";
6756 needs_comma := true;
6773 pr " throws LibGuestFSException";
6774 if semicolon then pr ";"
6776 and generate_java_struct typ cols =
6777 generate_header CStyle LGPLv2;
6780 package com.redhat.et.libguestfs;
6783 * Libguestfs %s structure.
6794 | name, `UUID -> pr " public String %s;\n" name
6796 | name, `Int -> pr " public long %s;\n" name
6797 | name, `OptPercent ->
6798 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6799 pr " public float %s;\n" name
6804 and generate_java_c () =
6805 generate_header CStyle LGPLv2;
6812 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6813 #include \"guestfs.h\"
6815 /* Note that this function returns. The exception is not thrown
6816 * until after the wrapper function returns.
6819 throw_exception (JNIEnv *env, const char *msg)
6822 cl = (*env)->FindClass (env,
6823 \"com/redhat/et/libguestfs/LibGuestFSException\");
6824 (*env)->ThrowNew (env, cl, msg);
6827 JNIEXPORT jlong JNICALL
6828 Java_com_redhat_et_libguestfs_GuestFS__1create
6829 (JNIEnv *env, jobject obj)
6833 g = guestfs_create ();
6835 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6838 guestfs_set_error_handler (g, NULL, NULL);
6839 return (jlong) (long) g;
6842 JNIEXPORT void JNICALL
6843 Java_com_redhat_et_libguestfs_GuestFS__1close
6844 (JNIEnv *env, jobject obj, jlong jg)
6846 guestfs_h *g = (guestfs_h *) (long) jg;
6853 fun (name, style, _, _, _, _, _) ->
6855 (match fst style with
6856 | RErr -> pr "void ";
6857 | RInt _ -> pr "jint ";
6858 | RInt64 _ -> pr "jlong ";
6859 | RBool _ -> pr "jboolean ";
6860 | RConstString _ | RString _ -> pr "jstring ";
6861 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6863 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6867 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6868 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6870 pr " (JNIEnv *env, jobject obj, jlong jg";
6877 pr ", jstring j%s" n
6879 pr ", jobjectArray j%s" n
6881 pr ", jboolean j%s" n
6887 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6888 let error_code, no_ret =
6889 match fst style with
6890 | RErr -> pr " int r;\n"; "-1", ""
6892 | RInt _ -> pr " int r;\n"; "-1", "0"
6893 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6894 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6896 pr " jstring jr;\n";
6897 pr " char *r;\n"; "NULL", "NULL"
6899 pr " jobjectArray jr;\n";
6902 pr " jstring jstr;\n";
6903 pr " char **r;\n"; "NULL", "NULL"
6905 pr " jobject jr;\n";
6907 pr " jfieldID fl;\n";
6908 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6910 pr " jobject jr;\n";
6912 pr " jfieldID fl;\n";
6913 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6915 pr " jobject jr;\n";
6917 pr " jfieldID fl;\n";
6918 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6920 pr " jobjectArray jr;\n";
6922 pr " jfieldID fl;\n";
6923 pr " jobject jfl;\n";
6924 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6926 pr " jobjectArray jr;\n";
6928 pr " jfieldID fl;\n";
6929 pr " jobject jfl;\n";
6930 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6932 pr " jobjectArray jr;\n";
6934 pr " jfieldID fl;\n";
6935 pr " jobject jfl;\n";
6936 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6937 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6944 pr " const char *%s;\n" n
6946 pr " int %s_len;\n" n;
6947 pr " const char **%s;\n" n
6954 (match fst style with
6955 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6956 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6957 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6958 | RHashtable _ -> false) ||
6959 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6965 (* Get the parameters. *)
6971 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6973 (* This is completely undocumented, but Java null becomes
6976 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
6978 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6979 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6980 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6981 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6983 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6985 pr " %s[%s_len] = NULL;\n" n n;
6988 pr " %s = j%s;\n" n n
6991 (* Make the call. *)
6992 pr " r = guestfs_%s " name;
6993 generate_call_args ~handle:"g" (snd style);
6996 (* Release the parameters. *)
7002 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7005 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7007 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7008 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7010 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7012 pr " free (%s);\n" n
7017 (* Check for errors. *)
7018 pr " if (r == %s) {\n" error_code;
7019 pr " throw_exception (env, guestfs_last_error (g));\n";
7020 pr " return %s;\n" no_ret;
7024 (match fst style with
7026 | RInt _ -> pr " return (jint) r;\n"
7027 | RBool _ -> pr " return (jboolean) r;\n"
7028 | RInt64 _ -> pr " return (jlong) r;\n"
7029 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7031 pr " jr = (*env)->NewStringUTF (env, r);\n";
7035 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7036 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7037 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7038 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7039 pr " for (i = 0; i < r_len; ++i) {\n";
7040 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7041 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7042 pr " free (r[i]);\n";
7047 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
7048 pr " jr = (*env)->AllocObject (env, cl);\n";
7049 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
7050 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
7051 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
7052 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
7053 pr " guestfs_free_int_bool (r);\n";
7056 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
7057 pr " jr = (*env)->AllocObject (env, cl);\n";
7061 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7063 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7068 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
7069 pr " jr = (*env)->AllocObject (env, cl);\n";
7073 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7075 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7080 generate_java_lvm_return "pv" "PV" pv_cols
7082 generate_java_lvm_return "vg" "VG" vg_cols
7084 generate_java_lvm_return "lv" "LV" lv_cols
7087 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7088 pr " return NULL;\n"
7095 and generate_java_lvm_return typ jtyp cols =
7096 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7097 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7098 pr " for (i = 0; i < r->len; ++i) {\n";
7099 pr " jfl = (*env)->AllocObject (env, cl);\n";
7103 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7104 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7107 pr " char s[33];\n";
7108 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7110 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7111 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7113 | name, (`Bytes|`Int) ->
7114 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7115 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7116 | name, `OptPercent ->
7117 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7118 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7120 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7122 pr " guestfs_free_lvm_%s_list (r);\n" typ;
7125 and generate_haskell_hs () =
7126 generate_header HaskellStyle LGPLv2;
7128 (* XXX We only know how to generate partial FFI for Haskell
7129 * at the moment. Please help out!
7131 let can_generate style =
7132 let check_no_bad_args =
7133 List.for_all (function Bool _ | Int _ -> false | _ -> true)
7136 | RErr, args -> check_no_bad_args args
7149 | RHashtable _, _ -> false in
7152 {-# INCLUDE <guestfs.h> #-}
7153 {-# LANGUAGE ForeignFunctionInterface #-}
7158 (* List out the names of the actions we want to export. *)
7160 fun (name, style, _, _, _, _, _) ->
7161 if can_generate style then pr ",\n %s" name
7169 import Control.Exception
7170 import Data.Typeable
7172 data GuestfsS = GuestfsS -- represents the opaque C struct
7173 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7174 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7176 -- XXX define properly later XXX
7180 data IntBool = IntBool
7182 data StatVFS = StatVFS
7183 data Hashtable = Hashtable
7185 foreign import ccall unsafe \"guestfs_create\" c_create
7187 foreign import ccall unsafe \"&guestfs_close\" c_close
7188 :: FunPtr (GuestfsP -> IO ())
7189 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7190 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7192 create :: IO GuestfsH
7195 c_set_error_handler p nullPtr nullPtr
7196 h <- newForeignPtr c_close p
7199 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7200 :: GuestfsP -> IO CString
7202 -- last_error :: GuestfsH -> IO (Maybe String)
7203 -- last_error h = do
7204 -- str <- withForeignPtr h (\\p -> c_last_error p)
7205 -- maybePeek peekCString str
7207 last_error :: GuestfsH -> IO (String)
7209 str <- withForeignPtr h (\\p -> c_last_error p)
7211 then return \"no error\"
7212 else peekCString str
7216 (* Generate wrappers for each foreign function. *)
7218 fun (name, style, _, _, _, _, _) ->
7219 if can_generate style then (
7220 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7222 generate_haskell_prototype ~handle:"GuestfsP" style;
7226 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7228 pr "%s %s = do\n" name
7229 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7235 | String n -> pr "withCString %s $ \\%s -> " n n
7236 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7237 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7239 (* XXX this doesn't work *)
7241 pr " %s = case %s of\n" n n;
7244 pr " in fromIntegral %s $ \\%s ->\n" n n
7245 | Int n -> pr "fromIntegral %s $ \\%s -> " n n
7247 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7248 (String.concat " " ("p" :: List.map name_of_argt (snd style)));
7249 (match fst style with
7250 | RErr | RInt _ | RInt64 _ | RBool _ ->
7251 pr " if (r == -1)\n";
7253 pr " err <- last_error h\n";
7255 | RConstString _ | RString _ | RStringList _ | RIntBool _
7256 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7258 pr " if (r == nullPtr)\n";
7260 pr " err <- last_error h\n";
7263 (match fst style with
7265 pr " else return ()\n"
7267 pr " else return (fromIntegral r)\n"
7269 pr " else return (fromIntegral r)\n"
7271 pr " else return (toBool r)\n"
7282 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7288 and generate_haskell_prototype ~handle ?(hs = false) style =
7290 let string = if hs then "String" else "CString" in
7291 let int = if hs then "Int" else "CInt" in
7292 let bool = if hs then "Bool" else "CInt" in
7293 let int64 = if hs then "Integer" else "Int64" in
7297 | String _ -> pr "%s" string
7298 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7299 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7300 | Bool _ -> pr "%s" bool
7301 | Int _ -> pr "%s" int
7302 | FileIn _ -> pr "%s" string
7303 | FileOut _ -> pr "%s" string
7308 (match fst style with
7309 | RErr -> if not hs then pr "CInt"
7310 | RInt _ -> pr "%s" int
7311 | RInt64 _ -> pr "%s" int64
7312 | RBool _ -> pr "%s" bool
7313 | RConstString _ -> pr "%s" string
7314 | RString _ -> pr "%s" string
7315 | RStringList _ -> pr "[%s]" string
7316 | RIntBool _ -> pr "IntBool"
7317 | RPVList _ -> pr "[PV]"
7318 | RVGList _ -> pr "[VG]"
7319 | RLVList _ -> pr "[LV]"
7320 | RStat _ -> pr "Stat"
7321 | RStatVFS _ -> pr "StatVFS"
7322 | RHashtable _ -> pr "Hashtable"
7326 and generate_bindtests () =
7327 generate_header CStyle LGPLv2;
7332 #include <inttypes.h>
7335 #include \"guestfs.h\"
7336 #include \"guestfs_protocol.h\"
7338 #define error guestfs_error
7341 print_strings (char * const* const argv)
7346 for (argc = 0; argv[argc] != NULL; ++argc) {
7347 if (argc > 0) printf (\", \");
7348 printf (\"\\\"%%s\\\"\", argv[argc]);
7353 /* The test0 function prints its parameters to stdout. */
7357 match test_functions with
7358 | [] -> assert false
7359 | test0 :: tests -> test0, tests in
7362 let (name, style, _, _, _, _, _) = test0 in
7363 generate_prototype ~extern:false ~semicolon:false ~newline:true
7364 ~handle:"g" ~prefix:"guestfs_" name style;
7370 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
7371 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7372 | StringList n -> pr " print_strings (%s);\n" n
7373 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7374 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
7376 pr " /* Java changes stdout line buffering so we need this: */\n";
7377 pr " fflush (stdout);\n";
7383 fun (name, style, _, _, _, _, _) ->
7384 if String.sub name (String.length name - 3) 3 <> "err" then (
7385 pr "/* Test normal return. */\n";
7386 generate_prototype ~extern:false ~semicolon:false ~newline:true
7387 ~handle:"g" ~prefix:"guestfs_" name style;
7389 (match fst style with
7394 pr " sscanf (val, \"%%d\", &r);\n";
7398 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
7401 pr " return strcmp (val, \"true\") == 0;\n"
7403 (* Can't return the input string here. Return a static
7404 * string so we ensure we get a segfault if the caller
7407 pr " return \"static string\";\n"
7409 pr " return strdup (val);\n"
7411 pr " char **strs;\n";
7413 pr " sscanf (val, \"%%d\", &n);\n";
7414 pr " strs = malloc ((n+1) * sizeof (char *));\n";
7415 pr " for (i = 0; i < n; ++i) {\n";
7416 pr " strs[i] = malloc (16);\n";
7417 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
7419 pr " strs[n] = NULL;\n";
7420 pr " return strs;\n"
7422 pr " struct guestfs_int_bool *r;\n";
7423 pr " r = malloc (sizeof (struct guestfs_int_bool));\n";
7424 pr " sscanf (val, \"%%\" SCNi32, &r->i);\n";
7428 pr " struct guestfs_lvm_pv_list *r;\n";
7430 pr " r = malloc (sizeof (struct guestfs_lvm_pv_list));\n";
7431 pr " sscanf (val, \"%%d\", &r->len);\n";
7432 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_pv));\n";
7433 pr " for (i = 0; i < r->len; ++i) {\n";
7434 pr " r->val[i].pv_name = malloc (16);\n";
7435 pr " snprintf (r->val[i].pv_name, 16, \"%%d\", i);\n";
7439 pr " struct guestfs_lvm_vg_list *r;\n";
7441 pr " r = malloc (sizeof (struct guestfs_lvm_vg_list));\n";
7442 pr " sscanf (val, \"%%d\", &r->len);\n";
7443 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_vg));\n";
7444 pr " for (i = 0; i < r->len; ++i) {\n";
7445 pr " r->val[i].vg_name = malloc (16);\n";
7446 pr " snprintf (r->val[i].vg_name, 16, \"%%d\", i);\n";
7450 pr " struct guestfs_lvm_lv_list *r;\n";
7452 pr " r = malloc (sizeof (struct guestfs_lvm_lv_list));\n";
7453 pr " sscanf (val, \"%%d\", &r->len);\n";
7454 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_lv));\n";
7455 pr " for (i = 0; i < r->len; ++i) {\n";
7456 pr " r->val[i].lv_name = malloc (16);\n";
7457 pr " snprintf (r->val[i].lv_name, 16, \"%%d\", i);\n";
7461 pr " struct guestfs_stat *r;\n";
7462 pr " r = calloc (1, sizeof (*r));\n";
7463 pr " sscanf (val, \"%%\" SCNi64, &r->dev);\n";
7466 pr " struct guestfs_statvfs *r;\n";
7467 pr " r = calloc (1, sizeof (*r));\n";
7468 pr " sscanf (val, \"%%\" SCNi64, &r->bsize);\n";
7471 pr " char **strs;\n";
7473 pr " sscanf (val, \"%%d\", &n);\n";
7474 pr " strs = malloc ((n*2+1) * sizeof (char *));\n";
7475 pr " for (i = 0; i < n; ++i) {\n";
7476 pr " strs[i*2] = malloc (16);\n";
7477 pr " strs[i*2+1] = malloc (16);\n";
7478 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
7479 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7481 pr " strs[n*2] = NULL;\n";
7482 pr " return strs;\n"
7487 pr "/* Test error return. */\n";
7488 generate_prototype ~extern:false ~semicolon:false ~newline:true
7489 ~handle:"g" ~prefix:"guestfs_" name style;
7491 pr " error (g, \"error\");\n";
7492 (match fst style with
7493 | RErr | RInt _ | RInt64 _ | RBool _ ->
7496 | RString _ | RStringList _ | RIntBool _
7497 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7499 pr " return NULL;\n"
7506 and generate_ocaml_bindtests () =
7507 generate_header OCamlStyle GPLv2;
7511 let g = Guestfs.create () in
7518 | CallString s -> "\"" ^ s ^ "\""
7519 | CallOptString None -> "None"
7520 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7521 | CallStringList xs ->
7522 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7523 | CallInt i when i >= 0 -> string_of_int i
7524 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7525 | CallBool b -> string_of_bool b
7530 generate_lang_bindtests (
7531 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
7534 pr "print_endline \"EOF\"\n"
7536 and generate_perl_bindtests () =
7537 pr "#!/usr/bin/perl -w\n";
7538 generate_header HashStyle GPLv2;
7545 my $g = Sys::Guestfs->new ();
7549 String.concat ", " (
7552 | CallString s -> "\"" ^ s ^ "\""
7553 | CallOptString None -> "undef"
7554 | CallOptString (Some s) -> sprintf "\"%s\"" s
7555 | CallStringList xs ->
7556 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7557 | CallInt i -> string_of_int i
7558 | CallBool b -> if b then "1" else "0"
7563 generate_lang_bindtests (
7564 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7567 pr "print \"EOF\\n\"\n"
7569 and generate_python_bindtests () =
7570 generate_header HashStyle GPLv2;
7575 g = guestfs.GuestFS ()
7579 String.concat ", " (
7582 | CallString s -> "\"" ^ s ^ "\""
7583 | CallOptString None -> "None"
7584 | CallOptString (Some s) -> sprintf "\"%s\"" s
7585 | CallStringList xs ->
7586 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7587 | CallInt i -> string_of_int i
7588 | CallBool b -> if b then "1" else "0"
7593 generate_lang_bindtests (
7594 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
7597 pr "print \"EOF\"\n"
7599 and generate_ruby_bindtests () =
7600 generate_header HashStyle GPLv2;
7605 g = Guestfs::create()
7609 String.concat ", " (
7612 | CallString s -> "\"" ^ s ^ "\""
7613 | CallOptString None -> "nil"
7614 | CallOptString (Some s) -> sprintf "\"%s\"" s
7615 | CallStringList xs ->
7616 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7617 | CallInt i -> string_of_int i
7618 | CallBool b -> string_of_bool b
7623 generate_lang_bindtests (
7624 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
7627 pr "print \"EOF\\n\"\n"
7629 and generate_java_bindtests () =
7630 generate_header CStyle GPLv2;
7633 import com.redhat.et.libguestfs.*;
7635 public class Bindtests {
7636 public static void main (String[] argv)
7639 GuestFS g = new GuestFS ();
7643 String.concat ", " (
7646 | CallString s -> "\"" ^ s ^ "\""
7647 | CallOptString None -> "null"
7648 | CallOptString (Some s) -> sprintf "\"%s\"" s
7649 | CallStringList xs ->
7651 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
7652 | CallInt i -> string_of_int i
7653 | CallBool b -> string_of_bool b
7658 generate_lang_bindtests (
7659 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
7663 System.out.println (\"EOF\");
7665 catch (Exception exn) {
7666 System.err.println (exn);
7673 and generate_haskell_bindtests () =
7674 () (* XXX Haskell bindings need to be fleshed out. *)
7676 (* Language-independent bindings tests - we do it this way to
7677 * ensure there is parity in testing bindings across all languages.
7679 and generate_lang_bindtests call =
7680 call "test0" [CallString "abc"; CallOptString (Some "def");
7681 CallStringList []; CallBool false;
7682 CallInt 0; CallString "123"; CallString "456"];
7683 call "test0" [CallString "abc"; CallOptString None;
7684 CallStringList []; CallBool false;
7685 CallInt 0; CallString "123"; CallString "456"];
7686 call "test0" [CallString ""; CallOptString (Some "def");
7687 CallStringList []; CallBool false;
7688 CallInt 0; CallString "123"; CallString "456"];
7689 call "test0" [CallString ""; CallOptString (Some "");
7690 CallStringList []; CallBool false;
7691 CallInt 0; CallString "123"; CallString "456"];
7692 call "test0" [CallString "abc"; CallOptString (Some "def");
7693 CallStringList ["1"]; CallBool false;
7694 CallInt 0; CallString "123"; CallString "456"];
7695 call "test0" [CallString "abc"; CallOptString (Some "def");
7696 CallStringList ["1"; "2"]; CallBool false;
7697 CallInt 0; CallString "123"; CallString "456"];
7698 call "test0" [CallString "abc"; CallOptString (Some "def");
7699 CallStringList ["1"]; CallBool true;
7700 CallInt 0; CallString "123"; CallString "456"];
7701 call "test0" [CallString "abc"; CallOptString (Some "def");
7702 CallStringList ["1"]; CallBool false;
7703 CallInt (-1); CallString "123"; CallString "456"];
7704 call "test0" [CallString "abc"; CallOptString (Some "def");
7705 CallStringList ["1"]; CallBool false;
7706 CallInt (-2); CallString "123"; CallString "456"];
7707 call "test0" [CallString "abc"; CallOptString (Some "def");
7708 CallStringList ["1"]; CallBool false;
7709 CallInt 1; CallString "123"; CallString "456"];
7710 call "test0" [CallString "abc"; CallOptString (Some "def");
7711 CallStringList ["1"]; CallBool false;
7712 CallInt 2; CallString "123"; CallString "456"];
7713 call "test0" [CallString "abc"; CallOptString (Some "def");
7714 CallStringList ["1"]; CallBool false;
7715 CallInt 4095; CallString "123"; CallString "456"];
7716 call "test0" [CallString "abc"; CallOptString (Some "def");
7717 CallStringList ["1"]; CallBool false;
7718 CallInt 0; CallString ""; CallString ""]
7720 (* XXX Add here tests of the return and error functions. *)
7722 let output_to filename =
7723 let filename_new = filename ^ ".new" in
7724 chan := open_out filename_new;
7729 (* Is the new file different from the current file? *)
7730 if Sys.file_exists filename && files_equal filename filename_new then
7731 Unix.unlink filename_new (* same, so skip it *)
7733 (* different, overwrite old one *)
7734 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
7735 Unix.rename filename_new filename;
7736 Unix.chmod filename 0o444;
7737 printf "written %s\n%!" filename;
7746 if not (Sys.file_exists "configure.ac") then (
7748 You are probably running this from the wrong directory.
7749 Run it from the top source directory using the command
7755 let close = output_to "src/guestfs_protocol.x" in
7759 let close = output_to "src/guestfs-structs.h" in
7760 generate_structs_h ();
7763 let close = output_to "src/guestfs-actions.h" in
7764 generate_actions_h ();
7767 let close = output_to "src/guestfs-actions.c" in
7768 generate_client_actions ();
7771 let close = output_to "daemon/actions.h" in
7772 generate_daemon_actions_h ();
7775 let close = output_to "daemon/stubs.c" in
7776 generate_daemon_actions ();
7779 let close = output_to "capitests/tests.c" in
7783 let close = output_to "src/guestfs-bindtests.c" in
7784 generate_bindtests ();
7787 let close = output_to "fish/cmds.c" in
7788 generate_fish_cmds ();
7791 let close = output_to "fish/completion.c" in
7792 generate_fish_completion ();
7795 let close = output_to "guestfs-structs.pod" in
7796 generate_structs_pod ();
7799 let close = output_to "guestfs-actions.pod" in
7800 generate_actions_pod ();
7803 let close = output_to "guestfish-actions.pod" in
7804 generate_fish_actions_pod ();
7807 let close = output_to "ocaml/guestfs.mli" in
7808 generate_ocaml_mli ();
7811 let close = output_to "ocaml/guestfs.ml" in
7812 generate_ocaml_ml ();
7815 let close = output_to "ocaml/guestfs_c_actions.c" in
7816 generate_ocaml_c ();
7819 let close = output_to "ocaml/bindtests.ml" in
7820 generate_ocaml_bindtests ();
7823 let close = output_to "perl/Guestfs.xs" in
7824 generate_perl_xs ();
7827 let close = output_to "perl/lib/Sys/Guestfs.pm" in
7828 generate_perl_pm ();
7831 let close = output_to "perl/bindtests.pl" in
7832 generate_perl_bindtests ();
7835 let close = output_to "python/guestfs-py.c" in
7836 generate_python_c ();
7839 let close = output_to "python/guestfs.py" in
7840 generate_python_py ();
7843 let close = output_to "python/bindtests.py" in
7844 generate_python_bindtests ();
7847 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
7851 let close = output_to "ruby/bindtests.rb" in
7852 generate_ruby_bindtests ();
7855 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
7856 generate_java_java ();
7859 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
7860 generate_java_struct "PV" pv_cols;
7863 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
7864 generate_java_struct "VG" vg_cols;
7867 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
7868 generate_java_struct "LV" lv_cols;
7871 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
7872 generate_java_struct "Stat" stat_cols;
7875 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
7876 generate_java_struct "StatVFS" statvfs_cols;
7879 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
7883 let close = output_to "java/Bindtests.java" in
7884 generate_java_bindtests ();
7887 let close = output_to "haskell/Guestfs.hs" in
7888 generate_haskell_hs ();
7891 let close = output_to "haskell/bindtests.hs" in
7892 generate_haskell_bindtests ();