3 * Copyright (C) 2009 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table below), and
25 * daemon/<somefile>.c to write the implementation.
27 * After editing this file, run it (./src/generator.ml) to regenerate
28 * all the output files.
30 * IMPORTANT: This script should NOT print any warnings. If it prints
31 * warnings, you should treat them as errors.
32 * [Need to add -warn-error to ocaml command line]
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
46 (* "RInt" as a return value means an int which is -1 for error
47 * or any value >= 0 on success. Only use this for smallish
48 * positive ints (0 <= i < 2^30).
51 (* "RInt64" is the same as RInt, but is guaranteed to be able
52 * to return a full 64 bit value, _except_ that -1 means error
53 * (so -1 cannot be a valid, non-error return value).
56 (* "RBool" is a bool return value which can be true/false or
60 (* "RConstString" is a string that refers to a constant value.
61 * Try to avoid using this. In particular you cannot use this
62 * for values returned from the daemon, because there is no
63 * thread-safe way to return them in the C API.
65 | RConstString of string
66 (* "RString" and "RStringList" are caller-frees. *)
68 | RStringList of string
69 (* Some limited tuples are possible: *)
70 | RIntBool of string * string
71 (* LVM PVs, VGs and LVs. *)
78 (* Key-value pairs of untyped strings. Turns into a hashtable or
79 * dictionary in languages which support it. DON'T use this as a
80 * general "bucket" for results. Prefer a stronger typed return
81 * value if one is available, or write a custom struct. Don't use
82 * this if the list could potentially be very long, since it is
83 * inefficient. Keys should be unique. NULLs are not permitted.
85 | RHashtable of string
87 and args = argt list (* Function parameters, guestfs handle is implicit. *)
89 (* Note in future we should allow a "variable args" parameter as
90 * the final parameter, to allow commands like
91 * chmod mode file [file(s)...]
92 * This is not implemented yet, but many commands (such as chmod)
93 * are currently defined with the argument order keeping this future
94 * possibility in mind.
97 | String of string (* const char *name, cannot be NULL *)
98 | OptString of string (* const char *name, may be NULL *)
99 | StringList of string(* list of strings (each string cannot be NULL) *)
100 | Bool of string (* boolean *)
101 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
102 (* These are treated as filenames (simple string parameters) in
103 * the C API and bindings. But in the RPC protocol, we transfer
104 * the actual file content up to or down from the daemon.
105 * FileIn: local machine -> daemon (in request)
106 * FileOut: daemon -> local machine (in reply)
107 * In guestfish (only), the special name "-" means read from
108 * stdin or write to stdout.
114 | ProtocolLimitWarning (* display warning about protocol size limits *)
115 | DangerWillRobinson (* flags particularly dangerous commands *)
116 | FishAlias of string (* provide an alias for this cmd in guestfish *)
117 | FishAction of string (* call this function in guestfish *)
118 | NotInFish (* do not export via guestfish *)
119 | NotInDocs (* do not add this function to documentation *)
121 let protocol_limit_warning =
122 "Because of the message protocol, there is a transfer limit
123 of somewhere between 2MB and 4MB. To transfer large files you should use
126 let danger_will_robinson =
127 "B<This command is dangerous. Without careful use you
128 can easily destroy all your data>."
130 (* You can supply zero or as many tests as you want per API call.
132 * Note that the test environment has 3 block devices, of size 500MB,
133 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
134 * a fourth squashfs block device with some known files on it (/dev/sdd).
136 * Note for partitioning purposes, the 500MB device has 63 cylinders.
138 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
140 * To be able to run the tests in a reasonable amount of time,
141 * the virtual machine and block devices are reused between tests.
142 * So don't try testing kill_subprocess :-x
144 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
146 * Don't assume anything about the previous contents of the block
147 * devices. Use 'Init*' to create some initial scenarios.
149 * You can add a prerequisite clause to any individual test. This
150 * is a run-time check, which, if it fails, causes the test to be
151 * skipped. Useful if testing a command which might not work on
152 * all variations of libguestfs builds. A test that has prerequisite
153 * of 'Always' is run unconditionally.
155 * In addition, packagers can skip individual tests by setting the
156 * environment variables: eg:
157 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
158 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
160 type tests = (test_init * test_prereq * test) list
162 (* Run the command sequence and just expect nothing to fail. *)
164 (* Run the command sequence and expect the output of the final
165 * command to be the string.
167 | TestOutput of seq * string
168 (* Run the command sequence and expect the output of the final
169 * command to be the list of strings.
171 | TestOutputList of seq * string list
172 (* Run the command sequence and expect the output of the final
173 * command to be the list of block devices (could be either
174 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
175 * character of each string).
177 | TestOutputListOfDevices of seq * string list
178 (* Run the command sequence and expect the output of the final
179 * command to be the integer.
181 | TestOutputInt of seq * int
182 (* Run the command sequence and expect the output of the final
183 * command to be a true value (!= 0 or != NULL).
185 | TestOutputTrue of seq
186 (* Run the command sequence and expect the output of the final
187 * command to be a false value (== 0 or == NULL, but not an error).
189 | TestOutputFalse of seq
190 (* Run the command sequence and expect the output of the final
191 * command to be a list of the given length (but don't care about
194 | TestOutputLength of seq * int
195 (* Run the command sequence and expect the output of the final
196 * command to be a structure.
198 | TestOutputStruct of seq * test_field_compare list
199 (* Run the command sequence and expect the final command (only)
202 | TestLastFail of seq
204 and test_field_compare =
205 | CompareWithInt of string * int
206 | CompareWithString of string * string
207 | CompareFieldsIntEq of string * string
208 | CompareFieldsStrEq of string * string
210 (* Test prerequisites. *)
212 (* Test always runs. *)
214 (* Test is currently disabled - eg. it fails, or it tests some
215 * unimplemented feature.
218 (* 'string' is some C code (a function body) that should return
219 * true or false. The test will run if the code returns true.
222 (* As for 'If' but the test runs _unless_ the code returns true. *)
225 (* Some initial scenarios for testing. *)
227 (* Do nothing, block devices could contain random stuff including
228 * LVM PVs, and some filesystems might be mounted. This is usually
232 (* Block devices are empty and no filesystems are mounted. *)
234 (* /dev/sda contains a single partition /dev/sda1, which is formatted
235 * as ext2, empty [except for lost+found] and mounted on /.
236 * /dev/sdb and /dev/sdc may have random content.
241 * /dev/sda1 (is a PV):
242 * /dev/VG/LV (size 8MB):
243 * formatted as ext2, empty [except for lost+found], mounted on /
244 * /dev/sdb and /dev/sdc may have random content.
248 (* Sequence of commands for testing. *)
250 and cmd = string list
252 (* Note about long descriptions: When referring to another
253 * action, use the format C<guestfs_other> (ie. the full name of
254 * the C function). This will be replaced as appropriate in other
257 * Apart from that, long descriptions are just perldoc paragraphs.
260 (* These test functions are used in the language binding tests. *)
262 let test_all_args = [
265 StringList "strlist";
272 let test_all_rets = [
273 (* except for RErr, which is tested thoroughly elsewhere *)
274 "test0rint", RInt "valout";
275 "test0rint64", RInt64 "valout";
276 "test0rbool", RBool "valout";
277 "test0rconststring", RConstString "valout";
278 "test0rstring", RString "valout";
279 "test0rstringlist", RStringList "valout";
280 "test0rintbool", RIntBool ("valout", "valout");
281 "test0rpvlist", RPVList "valout";
282 "test0rvglist", RVGList "valout";
283 "test0rlvlist", RLVList "valout";
284 "test0rstat", RStat "valout";
285 "test0rstatvfs", RStatVFS "valout";
286 "test0rhashtable", RHashtable "valout";
289 let test_functions = [
290 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
292 "internal test function - do not use",
294 This is an internal test function which is used to test whether
295 the automatically generated bindings can handle every possible
296 parameter type correctly.
298 It echos the contents of each parameter to stdout.
300 You probably don't want to call this function.");
304 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
306 "internal test function - do not use",
308 This is an internal test function which is used to test whether
309 the automatically generated bindings can handle every possible
310 return type correctly.
312 It converts string C<val> to the return type.
314 You probably don't want to call this function.");
315 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
317 "internal test function - do not use",
319 This is an internal test function which is used to test whether
320 the automatically generated bindings can handle every possible
321 return type correctly.
323 This function always returns an error.
325 You probably don't want to call this function.")]
329 (* non_daemon_functions are any functions which don't get processed
330 * in the daemon, eg. functions for setting and getting local
331 * configuration values.
334 let non_daemon_functions = test_functions @ [
335 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
337 "launch the qemu subprocess",
339 Internally libguestfs is implemented by running a virtual machine
342 You should call this after configuring the handle
343 (eg. adding drives) but before performing any actions.");
345 ("wait_ready", (RErr, []), -1, [NotInFish],
347 "wait until the qemu subprocess launches",
349 Internally libguestfs is implemented by running a virtual machine
352 You should call this after C<guestfs_launch> to wait for the launch
355 ("kill_subprocess", (RErr, []), -1, [],
357 "kill the qemu subprocess",
359 This kills the qemu subprocess. You should never need to call this.");
361 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
363 "add an image to examine or modify",
365 This function adds a virtual machine disk image C<filename> to the
366 guest. The first time you call this function, the disk appears as IDE
367 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
370 You don't necessarily need to be root when using libguestfs. However
371 you obviously do need sufficient permissions to access the filename
372 for whatever operations you want to perform (ie. read access if you
373 just want to read the image or write access if you want to modify the
376 This is equivalent to the qemu parameter C<-drive file=filename,cache=off>.
378 Note that this call checks for the existence of C<filename>. This
379 stops you from specifying other types of drive which are supported
380 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
381 the general C<guestfs_config> call instead.");
383 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
385 "add a CD-ROM disk image to examine",
387 This function adds a virtual CD-ROM disk image to the guest.
389 This is equivalent to the qemu parameter C<-cdrom filename>.
391 Note that this call checks for the existence of C<filename>. This
392 stops you from specifying other types of drive which are supported
393 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
394 the general C<guestfs_config> call instead.");
396 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
398 "add a drive in snapshot mode (read-only)",
400 This adds a drive in snapshot mode, making it effectively
403 Note that writes to the device are allowed, and will be seen for
404 the duration of the guestfs handle, but they are written
405 to a temporary file which is discarded as soon as the guestfs
406 handle is closed. We don't currently have any method to enable
407 changes to be committed, although qemu can support this.
409 This is equivalent to the qemu parameter
410 C<-drive file=filename,snapshot=on>.
412 Note that this call checks for the existence of C<filename>. This
413 stops you from specifying other types of drive which are supported
414 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
415 the general C<guestfs_config> call instead.");
417 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
419 "add qemu parameters",
421 This can be used to add arbitrary qemu command line parameters
422 of the form C<-param value>. Actually it's not quite arbitrary - we
423 prevent you from setting some parameters which would interfere with
424 parameters that we use.
426 The first character of C<param> string must be a C<-> (dash).
428 C<value> can be NULL.");
430 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
432 "set the qemu binary",
434 Set the qemu binary that we will use.
436 The default is chosen when the library was compiled by the
439 You can also override this by setting the C<LIBGUESTFS_QEMU>
440 environment variable.
442 Setting C<qemu> to C<NULL> restores the default qemu binary.");
444 ("get_qemu", (RConstString "qemu", []), -1, [],
446 "get the qemu binary",
448 Return the current qemu binary.
450 This is always non-NULL. If it wasn't set already, then this will
451 return the default qemu binary name.");
453 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
455 "set the search path",
457 Set the path that libguestfs searches for kernel and initrd.img.
459 The default is C<$libdir/guestfs> unless overridden by setting
460 C<LIBGUESTFS_PATH> environment variable.
462 Setting C<path> to C<NULL> restores the default path.");
464 ("get_path", (RConstString "path", []), -1, [],
466 "get the search path",
468 Return the current search path.
470 This is always non-NULL. If it wasn't set already, then this will
471 return the default path.");
473 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
475 "add options to kernel command line",
477 This function is used to add additional options to the
478 guest kernel command line.
480 The default is C<NULL> unless overridden by setting
481 C<LIBGUESTFS_APPEND> environment variable.
483 Setting C<append> to C<NULL> means I<no> additional options
484 are passed (libguestfs always adds a few of its own).");
486 ("get_append", (RConstString "append", []), -1, [],
488 "get the additional kernel options",
490 Return the additional kernel options which are added to the
491 guest kernel command line.
493 If C<NULL> then no options are added.");
495 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
499 If C<autosync> is true, this enables autosync. Libguestfs will make a
500 best effort attempt to run C<guestfs_umount_all> followed by
501 C<guestfs_sync> when the handle is closed
502 (also if the program exits without closing handles).
504 This is disabled by default (except in guestfish where it is
505 enabled by default).");
507 ("get_autosync", (RBool "autosync", []), -1, [],
511 Get the autosync flag.");
513 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
517 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
519 Verbose messages are disabled unless the environment variable
520 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
522 ("get_verbose", (RBool "verbose", []), -1, [],
526 This returns the verbose messages flag.");
528 ("is_ready", (RBool "ready", []), -1, [],
530 "is ready to accept commands",
532 This returns true iff this handle is ready to accept commands
533 (in the C<READY> state).
535 For more information on states, see L<guestfs(3)>.");
537 ("is_config", (RBool "config", []), -1, [],
539 "is in configuration state",
541 This returns true iff this handle is being configured
542 (in the C<CONFIG> state).
544 For more information on states, see L<guestfs(3)>.");
546 ("is_launching", (RBool "launching", []), -1, [],
548 "is launching subprocess",
550 This returns true iff this handle is launching the subprocess
551 (in the C<LAUNCHING> state).
553 For more information on states, see L<guestfs(3)>.");
555 ("is_busy", (RBool "busy", []), -1, [],
557 "is busy processing a command",
559 This returns true iff this handle is busy processing a command
560 (in the C<BUSY> state).
562 For more information on states, see L<guestfs(3)>.");
564 ("get_state", (RInt "state", []), -1, [],
566 "get the current state",
568 This returns the current state as an opaque integer. This is
569 only useful for printing debug and internal error messages.
571 For more information on states, see L<guestfs(3)>.");
573 ("set_busy", (RErr, []), -1, [NotInFish],
577 This sets the state to C<BUSY>. This is only used when implementing
578 actions using the low-level API.
580 For more information on states, see L<guestfs(3)>.");
582 ("set_ready", (RErr, []), -1, [NotInFish],
584 "set state to ready",
586 This sets the state to C<READY>. This is only used when implementing
587 actions using the low-level API.
589 For more information on states, see L<guestfs(3)>.");
591 ("end_busy", (RErr, []), -1, [NotInFish],
593 "leave the busy state",
595 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
596 state as is. This is only used when implementing
597 actions using the low-level API.
599 For more information on states, see L<guestfs(3)>.");
603 (* daemon_functions are any functions which cause some action
604 * to take place in the daemon.
607 let daemon_functions = [
608 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
609 [InitEmpty, Always, TestOutput (
610 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
611 ["mkfs"; "ext2"; "/dev/sda1"];
612 ["mount"; "/dev/sda1"; "/"];
613 ["write_file"; "/new"; "new file contents"; "0"];
614 ["cat"; "/new"]], "new file contents")],
615 "mount a guest disk at a position in the filesystem",
617 Mount a guest disk at a position in the filesystem. Block devices
618 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
619 the guest. If those block devices contain partitions, they will have
620 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
623 The rules are the same as for L<mount(2)>: A filesystem must
624 first be mounted on C</> before others can be mounted. Other
625 filesystems can only be mounted on directories which already
628 The mounted filesystem is writable, if we have sufficient permissions
629 on the underlying device.
631 The filesystem options C<sync> and C<noatime> are set with this
632 call, in order to improve reliability.");
634 ("sync", (RErr, []), 2, [],
635 [ InitEmpty, Always, TestRun [["sync"]]],
636 "sync disks, writes are flushed through to the disk image",
638 This syncs the disk, so that any writes are flushed through to the
639 underlying disk image.
641 You should always call this if you have modified a disk image, before
642 closing the handle.");
644 ("touch", (RErr, [String "path"]), 3, [],
645 [InitBasicFS, Always, TestOutputTrue (
647 ["exists"; "/new"]])],
648 "update file timestamps or create a new file",
650 Touch acts like the L<touch(1)> command. It can be used to
651 update the timestamps on a file, or, if the file does not exist,
652 to create a new zero-length file.");
654 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
655 [InitBasicFS, Always, TestOutput (
656 [["write_file"; "/new"; "new file contents"; "0"];
657 ["cat"; "/new"]], "new file contents")],
658 "list the contents of a file",
660 Return the contents of the file named C<path>.
662 Note that this function cannot correctly handle binary files
663 (specifically, files containing C<\\0> character which is treated
664 as end of string). For those you need to use the C<guestfs_download>
665 function which has a more complex interface.");
667 ("ll", (RString "listing", [String "directory"]), 5, [],
668 [], (* XXX Tricky to test because it depends on the exact format
669 * of the 'ls -l' command, which changes between F10 and F11.
671 "list the files in a directory (long format)",
673 List the files in C<directory> (relative to the root directory,
674 there is no cwd) in the format of 'ls -la'.
676 This command is mostly useful for interactive sessions. It
677 is I<not> intended that you try to parse the output string.");
679 ("ls", (RStringList "listing", [String "directory"]), 6, [],
680 [InitBasicFS, Always, TestOutputList (
683 ["touch"; "/newest"];
684 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
685 "list the files in a directory",
687 List the files in C<directory> (relative to the root directory,
688 there is no cwd). The '.' and '..' entries are not returned, but
689 hidden files are shown.
691 This command is mostly useful for interactive sessions. Programs
692 should probably use C<guestfs_readdir> instead.");
694 ("list_devices", (RStringList "devices", []), 7, [],
695 [InitEmpty, Always, TestOutputListOfDevices (
696 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
697 "list the block devices",
699 List all the block devices.
701 The full block device names are returned, eg. C</dev/sda>");
703 ("list_partitions", (RStringList "partitions", []), 8, [],
704 [InitBasicFS, Always, TestOutputListOfDevices (
705 [["list_partitions"]], ["/dev/sda1"]);
706 InitEmpty, Always, TestOutputListOfDevices (
707 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
708 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
709 "list the partitions",
711 List all the partitions detected on all block devices.
713 The full partition device names are returned, eg. C</dev/sda1>
715 This does not return logical volumes. For that you will need to
716 call C<guestfs_lvs>.");
718 ("pvs", (RStringList "physvols", []), 9, [],
719 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
720 [["pvs"]], ["/dev/sda1"]);
721 InitEmpty, Always, TestOutputListOfDevices (
722 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
723 ["pvcreate"; "/dev/sda1"];
724 ["pvcreate"; "/dev/sda2"];
725 ["pvcreate"; "/dev/sda3"];
726 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
727 "list the LVM physical volumes (PVs)",
729 List all the physical volumes detected. This is the equivalent
730 of the L<pvs(8)> command.
732 This returns a list of just the device names that contain
733 PVs (eg. C</dev/sda2>).
735 See also C<guestfs_pvs_full>.");
737 ("vgs", (RStringList "volgroups", []), 10, [],
738 [InitBasicFSonLVM, Always, TestOutputList (
740 InitEmpty, Always, TestOutputList (
741 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
742 ["pvcreate"; "/dev/sda1"];
743 ["pvcreate"; "/dev/sda2"];
744 ["pvcreate"; "/dev/sda3"];
745 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
746 ["vgcreate"; "VG2"; "/dev/sda3"];
747 ["vgs"]], ["VG1"; "VG2"])],
748 "list the LVM volume groups (VGs)",
750 List all the volumes groups detected. This is the equivalent
751 of the L<vgs(8)> command.
753 This returns a list of just the volume group names that were
754 detected (eg. C<VolGroup00>).
756 See also C<guestfs_vgs_full>.");
758 ("lvs", (RStringList "logvols", []), 11, [],
759 [InitBasicFSonLVM, Always, TestOutputList (
760 [["lvs"]], ["/dev/VG/LV"]);
761 InitEmpty, Always, TestOutputList (
762 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
763 ["pvcreate"; "/dev/sda1"];
764 ["pvcreate"; "/dev/sda2"];
765 ["pvcreate"; "/dev/sda3"];
766 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
767 ["vgcreate"; "VG2"; "/dev/sda3"];
768 ["lvcreate"; "LV1"; "VG1"; "50"];
769 ["lvcreate"; "LV2"; "VG1"; "50"];
770 ["lvcreate"; "LV3"; "VG2"; "50"];
771 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
772 "list the LVM logical volumes (LVs)",
774 List all the logical volumes detected. This is the equivalent
775 of the L<lvs(8)> command.
777 This returns a list of the logical volume device names
778 (eg. C</dev/VolGroup00/LogVol00>).
780 See also C<guestfs_lvs_full>.");
782 ("pvs_full", (RPVList "physvols", []), 12, [],
783 [], (* XXX how to test? *)
784 "list the LVM physical volumes (PVs)",
786 List all the physical volumes detected. This is the equivalent
787 of the L<pvs(8)> command. The \"full\" version includes all fields.");
789 ("vgs_full", (RVGList "volgroups", []), 13, [],
790 [], (* XXX how to test? *)
791 "list the LVM volume groups (VGs)",
793 List all the volumes groups detected. This is the equivalent
794 of the L<vgs(8)> command. The \"full\" version includes all fields.");
796 ("lvs_full", (RLVList "logvols", []), 14, [],
797 [], (* XXX how to test? *)
798 "list the LVM logical volumes (LVs)",
800 List all the logical volumes detected. This is the equivalent
801 of the L<lvs(8)> command. The \"full\" version includes all fields.");
803 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
804 [InitBasicFS, Always, TestOutputList (
805 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
806 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
807 InitBasicFS, Always, TestOutputList (
808 [["write_file"; "/new"; ""; "0"];
809 ["read_lines"; "/new"]], [])],
810 "read file as lines",
812 Return the contents of the file named C<path>.
814 The file contents are returned as a list of lines. Trailing
815 C<LF> and C<CRLF> character sequences are I<not> returned.
817 Note that this function cannot correctly handle binary files
818 (specifically, files containing C<\\0> character which is treated
819 as end of line). For those you need to use the C<guestfs_read_file>
820 function which has a more complex interface.");
822 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
823 [], (* XXX Augeas code needs tests. *)
824 "create a new Augeas handle",
826 Create a new Augeas handle for editing configuration files.
827 If there was any previous Augeas handle associated with this
828 guestfs session, then it is closed.
830 You must call this before using any other C<guestfs_aug_*>
833 C<root> is the filesystem root. C<root> must not be NULL,
836 The flags are the same as the flags defined in
837 E<lt>augeas.hE<gt>, the logical I<or> of the following
842 =item C<AUG_SAVE_BACKUP> = 1
844 Keep the original file with a C<.augsave> extension.
846 =item C<AUG_SAVE_NEWFILE> = 2
848 Save changes into a file with extension C<.augnew>, and
849 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
851 =item C<AUG_TYPE_CHECK> = 4
853 Typecheck lenses (can be expensive).
855 =item C<AUG_NO_STDINC> = 8
857 Do not use standard load path for modules.
859 =item C<AUG_SAVE_NOOP> = 16
861 Make save a no-op, just record what would have been changed.
863 =item C<AUG_NO_LOAD> = 32
865 Do not load the tree in C<guestfs_aug_init>.
869 To close the handle, you can call C<guestfs_aug_close>.
871 To find out more about Augeas, see L<http://augeas.net/>.");
873 ("aug_close", (RErr, []), 26, [],
874 [], (* XXX Augeas code needs tests. *)
875 "close the current Augeas handle",
877 Close the current Augeas handle and free up any resources
878 used by it. After calling this, you have to call
879 C<guestfs_aug_init> again before you can use any other
882 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
883 [], (* XXX Augeas code needs tests. *)
884 "define an Augeas variable",
886 Defines an Augeas variable C<name> whose value is the result
887 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
890 On success this returns the number of nodes in C<expr>, or
891 C<0> if C<expr> evaluates to something which is not a nodeset.");
893 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
894 [], (* XXX Augeas code needs tests. *)
895 "define an Augeas node",
897 Defines a variable C<name> whose value is the result of
900 If C<expr> evaluates to an empty nodeset, a node is created,
901 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
902 C<name> will be the nodeset containing that single node.
904 On success this returns a pair containing the
905 number of nodes in the nodeset, and a boolean flag
906 if a node was created.");
908 ("aug_get", (RString "val", [String "path"]), 19, [],
909 [], (* XXX Augeas code needs tests. *)
910 "look up the value of an Augeas path",
912 Look up the value associated with C<path>. If C<path>
913 matches exactly one node, the C<value> is returned.");
915 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
916 [], (* XXX Augeas code needs tests. *)
917 "set Augeas path to value",
919 Set the value associated with C<path> to C<value>.");
921 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
922 [], (* XXX Augeas code needs tests. *)
923 "insert a sibling Augeas node",
925 Create a new sibling C<label> for C<path>, inserting it into
926 the tree before or after C<path> (depending on the boolean
929 C<path> must match exactly one existing node in the tree, and
930 C<label> must be a label, ie. not contain C</>, C<*> or end
931 with a bracketed index C<[N]>.");
933 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
934 [], (* XXX Augeas code needs tests. *)
935 "remove an Augeas path",
937 Remove C<path> and all of its children.
939 On success this returns the number of entries which were removed.");
941 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
942 [], (* XXX Augeas code needs tests. *)
945 Move the node C<src> to C<dest>. C<src> must match exactly
946 one node. C<dest> is overwritten if it exists.");
948 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
949 [], (* XXX Augeas code needs tests. *)
950 "return Augeas nodes which match path",
952 Returns a list of paths which match the path expression C<path>.
953 The returned paths are sufficiently qualified so that they match
954 exactly one node in the current tree.");
956 ("aug_save", (RErr, []), 25, [],
957 [], (* XXX Augeas code needs tests. *)
958 "write all pending Augeas changes to disk",
960 This writes all pending changes to disk.
962 The flags which were passed to C<guestfs_aug_init> affect exactly
963 how files are saved.");
965 ("aug_load", (RErr, []), 27, [],
966 [], (* XXX Augeas code needs tests. *)
967 "load files into the tree",
969 Load files into the tree.
971 See C<aug_load> in the Augeas documentation for the full gory
974 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
975 [], (* XXX Augeas code needs tests. *)
976 "list Augeas nodes under a path",
978 This is just a shortcut for listing C<guestfs_aug_match>
979 C<path/*> and sorting the resulting nodes into alphabetical order.");
981 ("rm", (RErr, [String "path"]), 29, [],
982 [InitBasicFS, Always, TestRun
985 InitBasicFS, Always, TestLastFail
987 InitBasicFS, Always, TestLastFail
992 Remove the single file C<path>.");
994 ("rmdir", (RErr, [String "path"]), 30, [],
995 [InitBasicFS, Always, TestRun
998 InitBasicFS, Always, TestLastFail
1000 InitBasicFS, Always, TestLastFail
1002 ["rmdir"; "/new"]]],
1003 "remove a directory",
1005 Remove the single directory C<path>.");
1007 ("rm_rf", (RErr, [String "path"]), 31, [],
1008 [InitBasicFS, Always, TestOutputFalse
1010 ["mkdir"; "/new/foo"];
1011 ["touch"; "/new/foo/bar"];
1013 ["exists"; "/new"]]],
1014 "remove a file or directory recursively",
1016 Remove the file or directory C<path>, recursively removing the
1017 contents if its a directory. This is like the C<rm -rf> shell
1020 ("mkdir", (RErr, [String "path"]), 32, [],
1021 [InitBasicFS, Always, TestOutputTrue
1023 ["is_dir"; "/new"]];
1024 InitBasicFS, Always, TestLastFail
1025 [["mkdir"; "/new/foo/bar"]]],
1026 "create a directory",
1028 Create a directory named C<path>.");
1030 ("mkdir_p", (RErr, [String "path"]), 33, [],
1031 [InitBasicFS, Always, TestOutputTrue
1032 [["mkdir_p"; "/new/foo/bar"];
1033 ["is_dir"; "/new/foo/bar"]];
1034 InitBasicFS, Always, TestOutputTrue
1035 [["mkdir_p"; "/new/foo/bar"];
1036 ["is_dir"; "/new/foo"]];
1037 InitBasicFS, Always, TestOutputTrue
1038 [["mkdir_p"; "/new/foo/bar"];
1039 ["is_dir"; "/new"]];
1040 (* Regression tests for RHBZ#503133: *)
1041 InitBasicFS, Always, TestRun
1043 ["mkdir_p"; "/new"]];
1044 InitBasicFS, Always, TestLastFail
1046 ["mkdir_p"; "/new"]]],
1047 "create a directory and parents",
1049 Create a directory named C<path>, creating any parent directories
1050 as necessary. This is like the C<mkdir -p> shell command.");
1052 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1053 [], (* XXX Need stat command to test *)
1056 Change the mode (permissions) of C<path> to C<mode>. Only
1057 numeric modes are supported.");
1059 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1060 [], (* XXX Need stat command to test *)
1061 "change file owner and group",
1063 Change the file owner to C<owner> and group to C<group>.
1065 Only numeric uid and gid are supported. If you want to use
1066 names, you will need to locate and parse the password file
1067 yourself (Augeas support makes this relatively easy).");
1069 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1070 [InitBasicFS, Always, TestOutputTrue (
1072 ["exists"; "/new"]]);
1073 InitBasicFS, Always, TestOutputTrue (
1075 ["exists"; "/new"]])],
1076 "test if file or directory exists",
1078 This returns C<true> if and only if there is a file, directory
1079 (or anything) with the given C<path> name.
1081 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1083 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1084 [InitBasicFS, Always, TestOutputTrue (
1086 ["is_file"; "/new"]]);
1087 InitBasicFS, Always, TestOutputFalse (
1089 ["is_file"; "/new"]])],
1090 "test if file exists",
1092 This returns C<true> if and only if there is a file
1093 with the given C<path> name. Note that it returns false for
1094 other objects like directories.
1096 See also C<guestfs_stat>.");
1098 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1099 [InitBasicFS, Always, TestOutputFalse (
1101 ["is_dir"; "/new"]]);
1102 InitBasicFS, Always, TestOutputTrue (
1104 ["is_dir"; "/new"]])],
1105 "test if file exists",
1107 This returns C<true> if and only if there is a directory
1108 with the given C<path> name. Note that it returns false for
1109 other objects like files.
1111 See also C<guestfs_stat>.");
1113 ("pvcreate", (RErr, [String "device"]), 39, [],
1114 [InitEmpty, Always, TestOutputListOfDevices (
1115 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1116 ["pvcreate"; "/dev/sda1"];
1117 ["pvcreate"; "/dev/sda2"];
1118 ["pvcreate"; "/dev/sda3"];
1119 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1120 "create an LVM physical volume",
1122 This creates an LVM physical volume on the named C<device>,
1123 where C<device> should usually be a partition name such
1126 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1127 [InitEmpty, Always, TestOutputList (
1128 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1129 ["pvcreate"; "/dev/sda1"];
1130 ["pvcreate"; "/dev/sda2"];
1131 ["pvcreate"; "/dev/sda3"];
1132 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1133 ["vgcreate"; "VG2"; "/dev/sda3"];
1134 ["vgs"]], ["VG1"; "VG2"])],
1135 "create an LVM volume group",
1137 This creates an LVM volume group called C<volgroup>
1138 from the non-empty list of physical volumes C<physvols>.");
1140 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1141 [InitEmpty, Always, TestOutputList (
1142 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1143 ["pvcreate"; "/dev/sda1"];
1144 ["pvcreate"; "/dev/sda2"];
1145 ["pvcreate"; "/dev/sda3"];
1146 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1147 ["vgcreate"; "VG2"; "/dev/sda3"];
1148 ["lvcreate"; "LV1"; "VG1"; "50"];
1149 ["lvcreate"; "LV2"; "VG1"; "50"];
1150 ["lvcreate"; "LV3"; "VG2"; "50"];
1151 ["lvcreate"; "LV4"; "VG2"; "50"];
1152 ["lvcreate"; "LV5"; "VG2"; "50"];
1154 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1155 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1156 "create an LVM volume group",
1158 This creates an LVM volume group called C<logvol>
1159 on the volume group C<volgroup>, with C<size> megabytes.");
1161 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1162 [InitEmpty, Always, TestOutput (
1163 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1164 ["mkfs"; "ext2"; "/dev/sda1"];
1165 ["mount"; "/dev/sda1"; "/"];
1166 ["write_file"; "/new"; "new file contents"; "0"];
1167 ["cat"; "/new"]], "new file contents")],
1168 "make a filesystem",
1170 This creates a filesystem on C<device> (usually a partition
1171 or LVM logical volume). The filesystem type is C<fstype>, for
1174 ("sfdisk", (RErr, [String "device";
1175 Int "cyls"; Int "heads"; Int "sectors";
1176 StringList "lines"]), 43, [DangerWillRobinson],
1178 "create partitions on a block device",
1180 This is a direct interface to the L<sfdisk(8)> program for creating
1181 partitions on block devices.
1183 C<device> should be a block device, for example C</dev/sda>.
1185 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1186 and sectors on the device, which are passed directly to sfdisk as
1187 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1188 of these, then the corresponding parameter is omitted. Usually for
1189 'large' disks, you can just pass C<0> for these, but for small
1190 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1191 out the right geometry and you will need to tell it.
1193 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1194 information refer to the L<sfdisk(8)> manpage.
1196 To create a single partition occupying the whole disk, you would
1197 pass C<lines> as a single element list, when the single element being
1198 the string C<,> (comma).
1200 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1202 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1203 [InitBasicFS, Always, TestOutput (
1204 [["write_file"; "/new"; "new file contents"; "0"];
1205 ["cat"; "/new"]], "new file contents");
1206 InitBasicFS, Always, TestOutput (
1207 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1208 ["cat"; "/new"]], "\nnew file contents\n");
1209 InitBasicFS, Always, TestOutput (
1210 [["write_file"; "/new"; "\n\n"; "0"];
1211 ["cat"; "/new"]], "\n\n");
1212 InitBasicFS, Always, TestOutput (
1213 [["write_file"; "/new"; ""; "0"];
1214 ["cat"; "/new"]], "");
1215 InitBasicFS, Always, TestOutput (
1216 [["write_file"; "/new"; "\n\n\n"; "0"];
1217 ["cat"; "/new"]], "\n\n\n");
1218 InitBasicFS, Always, TestOutput (
1219 [["write_file"; "/new"; "\n"; "0"];
1220 ["cat"; "/new"]], "\n")],
1223 This call creates a file called C<path>. The contents of the
1224 file is the string C<content> (which can contain any 8 bit data),
1225 with length C<size>.
1227 As a special case, if C<size> is C<0>
1228 then the length is calculated using C<strlen> (so in this case
1229 the content cannot contain embedded ASCII NULs).
1231 I<NB.> Owing to a bug, writing content containing ASCII NUL
1232 characters does I<not> work, even if the length is specified.
1233 We hope to resolve this bug in a future version. In the meantime
1234 use C<guestfs_upload>.");
1236 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1237 [InitEmpty, Always, TestOutputListOfDevices (
1238 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1239 ["mkfs"; "ext2"; "/dev/sda1"];
1240 ["mount"; "/dev/sda1"; "/"];
1241 ["mounts"]], ["/dev/sda1"]);
1242 InitEmpty, Always, TestOutputList (
1243 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1244 ["mkfs"; "ext2"; "/dev/sda1"];
1245 ["mount"; "/dev/sda1"; "/"];
1248 "unmount a filesystem",
1250 This unmounts the given filesystem. The filesystem may be
1251 specified either by its mountpoint (path) or the device which
1252 contains the filesystem.");
1254 ("mounts", (RStringList "devices", []), 46, [],
1255 [InitBasicFS, Always, TestOutputListOfDevices (
1256 [["mounts"]], ["/dev/sda1"])],
1257 "show mounted filesystems",
1259 This returns the list of currently mounted filesystems. It returns
1260 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1262 Some internal mounts are not shown.");
1264 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1265 [InitBasicFS, Always, TestOutputList (
1268 (* check that umount_all can unmount nested mounts correctly: *)
1269 InitEmpty, Always, TestOutputList (
1270 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1271 ["mkfs"; "ext2"; "/dev/sda1"];
1272 ["mkfs"; "ext2"; "/dev/sda2"];
1273 ["mkfs"; "ext2"; "/dev/sda3"];
1274 ["mount"; "/dev/sda1"; "/"];
1276 ["mount"; "/dev/sda2"; "/mp1"];
1277 ["mkdir"; "/mp1/mp2"];
1278 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1279 ["mkdir"; "/mp1/mp2/mp3"];
1282 "unmount all filesystems",
1284 This unmounts all mounted filesystems.
1286 Some internal mounts are not unmounted by this call.");
1288 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1290 "remove all LVM LVs, VGs and PVs",
1292 This command removes all LVM logical volumes, volume groups
1293 and physical volumes.");
1295 ("file", (RString "description", [String "path"]), 49, [],
1296 [InitBasicFS, Always, TestOutput (
1298 ["file"; "/new"]], "empty");
1299 InitBasicFS, Always, TestOutput (
1300 [["write_file"; "/new"; "some content\n"; "0"];
1301 ["file"; "/new"]], "ASCII text");
1302 InitBasicFS, Always, TestLastFail (
1303 [["file"; "/nofile"]])],
1304 "determine file type",
1306 This call uses the standard L<file(1)> command to determine
1307 the type or contents of the file. This also works on devices,
1308 for example to find out whether a partition contains a filesystem.
1310 The exact command which runs is C<file -bsL path>. Note in
1311 particular that the filename is not prepended to the output
1312 (the C<-b> option).");
1314 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1315 [InitBasicFS, Always, TestOutput (
1316 [["upload"; "test-command"; "/test-command"];
1317 ["chmod"; "493"; "/test-command"];
1318 ["command"; "/test-command 1"]], "Result1");
1319 InitBasicFS, Always, TestOutput (
1320 [["upload"; "test-command"; "/test-command"];
1321 ["chmod"; "493"; "/test-command"];
1322 ["command"; "/test-command 2"]], "Result2\n");
1323 InitBasicFS, Always, TestOutput (
1324 [["upload"; "test-command"; "/test-command"];
1325 ["chmod"; "493"; "/test-command"];
1326 ["command"; "/test-command 3"]], "\nResult3");
1327 InitBasicFS, Always, TestOutput (
1328 [["upload"; "test-command"; "/test-command"];
1329 ["chmod"; "493"; "/test-command"];
1330 ["command"; "/test-command 4"]], "\nResult4\n");
1331 InitBasicFS, Always, TestOutput (
1332 [["upload"; "test-command"; "/test-command"];
1333 ["chmod"; "493"; "/test-command"];
1334 ["command"; "/test-command 5"]], "\nResult5\n\n");
1335 InitBasicFS, Always, TestOutput (
1336 [["upload"; "test-command"; "/test-command"];
1337 ["chmod"; "493"; "/test-command"];
1338 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1339 InitBasicFS, Always, TestOutput (
1340 [["upload"; "test-command"; "/test-command"];
1341 ["chmod"; "493"; "/test-command"];
1342 ["command"; "/test-command 7"]], "");
1343 InitBasicFS, Always, TestOutput (
1344 [["upload"; "test-command"; "/test-command"];
1345 ["chmod"; "493"; "/test-command"];
1346 ["command"; "/test-command 8"]], "\n");
1347 InitBasicFS, Always, TestOutput (
1348 [["upload"; "test-command"; "/test-command"];
1349 ["chmod"; "493"; "/test-command"];
1350 ["command"; "/test-command 9"]], "\n\n");
1351 InitBasicFS, Always, TestOutput (
1352 [["upload"; "test-command"; "/test-command"];
1353 ["chmod"; "493"; "/test-command"];
1354 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1355 InitBasicFS, Always, TestOutput (
1356 [["upload"; "test-command"; "/test-command"];
1357 ["chmod"; "493"; "/test-command"];
1358 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1359 InitBasicFS, Always, TestLastFail (
1360 [["upload"; "test-command"; "/test-command"];
1361 ["chmod"; "493"; "/test-command"];
1362 ["command"; "/test-command"]])],
1363 "run a command from the guest filesystem",
1365 This call runs a command from the guest filesystem. The
1366 filesystem must be mounted, and must contain a compatible
1367 operating system (ie. something Linux, with the same
1368 or compatible processor architecture).
1370 The single parameter is an argv-style list of arguments.
1371 The first element is the name of the program to run.
1372 Subsequent elements are parameters. The list must be
1373 non-empty (ie. must contain a program name). Note that
1374 the command runs directly, and is I<not> invoked via
1375 the shell (see C<guestfs_sh>).
1377 The return value is anything printed to I<stdout> by
1380 If the command returns a non-zero exit status, then
1381 this function returns an error message. The error message
1382 string is the content of I<stderr> from the command.
1384 The C<$PATH> environment variable will contain at least
1385 C</usr/bin> and C</bin>. If you require a program from
1386 another location, you should provide the full path in the
1389 Shared libraries and data files required by the program
1390 must be available on filesystems which are mounted in the
1391 correct places. It is the caller's responsibility to ensure
1392 all filesystems that are needed are mounted at the right
1395 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1396 [InitBasicFS, Always, TestOutputList (
1397 [["upload"; "test-command"; "/test-command"];
1398 ["chmod"; "493"; "/test-command"];
1399 ["command_lines"; "/test-command 1"]], ["Result1"]);
1400 InitBasicFS, Always, TestOutputList (
1401 [["upload"; "test-command"; "/test-command"];
1402 ["chmod"; "493"; "/test-command"];
1403 ["command_lines"; "/test-command 2"]], ["Result2"]);
1404 InitBasicFS, Always, TestOutputList (
1405 [["upload"; "test-command"; "/test-command"];
1406 ["chmod"; "493"; "/test-command"];
1407 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1408 InitBasicFS, Always, TestOutputList (
1409 [["upload"; "test-command"; "/test-command"];
1410 ["chmod"; "493"; "/test-command"];
1411 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1412 InitBasicFS, Always, TestOutputList (
1413 [["upload"; "test-command"; "/test-command"];
1414 ["chmod"; "493"; "/test-command"];
1415 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1416 InitBasicFS, Always, TestOutputList (
1417 [["upload"; "test-command"; "/test-command"];
1418 ["chmod"; "493"; "/test-command"];
1419 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1420 InitBasicFS, Always, TestOutputList (
1421 [["upload"; "test-command"; "/test-command"];
1422 ["chmod"; "493"; "/test-command"];
1423 ["command_lines"; "/test-command 7"]], []);
1424 InitBasicFS, Always, TestOutputList (
1425 [["upload"; "test-command"; "/test-command"];
1426 ["chmod"; "493"; "/test-command"];
1427 ["command_lines"; "/test-command 8"]], [""]);
1428 InitBasicFS, Always, TestOutputList (
1429 [["upload"; "test-command"; "/test-command"];
1430 ["chmod"; "493"; "/test-command"];
1431 ["command_lines"; "/test-command 9"]], ["";""]);
1432 InitBasicFS, Always, TestOutputList (
1433 [["upload"; "test-command"; "/test-command"];
1434 ["chmod"; "493"; "/test-command"];
1435 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1436 InitBasicFS, Always, TestOutputList (
1437 [["upload"; "test-command"; "/test-command"];
1438 ["chmod"; "493"; "/test-command"];
1439 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1440 "run a command, returning lines",
1442 This is the same as C<guestfs_command>, but splits the
1443 result into a list of lines.
1445 See also: C<guestfs_sh_lines>");
1447 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1448 [InitBasicFS, Always, TestOutputStruct (
1450 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1451 "get file information",
1453 Returns file information for the given C<path>.
1455 This is the same as the C<stat(2)> system call.");
1457 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1458 [InitBasicFS, Always, TestOutputStruct (
1460 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1461 "get file information for a symbolic link",
1463 Returns file information for the given C<path>.
1465 This is the same as C<guestfs_stat> except that if C<path>
1466 is a symbolic link, then the link is stat-ed, not the file it
1469 This is the same as the C<lstat(2)> system call.");
1471 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1472 [InitBasicFS, Always, TestOutputStruct (
1473 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1474 CompareWithInt ("blocks", 490020);
1475 CompareWithInt ("bsize", 1024)])],
1476 "get file system statistics",
1478 Returns file system statistics for any mounted file system.
1479 C<path> should be a file or directory in the mounted file system
1480 (typically it is the mount point itself, but it doesn't need to be).
1482 This is the same as the C<statvfs(2)> system call.");
1484 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1486 "get ext2/ext3/ext4 superblock details",
1488 This returns the contents of the ext2, ext3 or ext4 filesystem
1489 superblock on C<device>.
1491 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1492 manpage for more details. The list of fields returned isn't
1493 clearly defined, and depends on both the version of C<tune2fs>
1494 that libguestfs was built against, and the filesystem itself.");
1496 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1497 [InitEmpty, Always, TestOutputTrue (
1498 [["blockdev_setro"; "/dev/sda"];
1499 ["blockdev_getro"; "/dev/sda"]])],
1500 "set block device to read-only",
1502 Sets the block device named C<device> to read-only.
1504 This uses the L<blockdev(8)> command.");
1506 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1507 [InitEmpty, Always, TestOutputFalse (
1508 [["blockdev_setrw"; "/dev/sda"];
1509 ["blockdev_getro"; "/dev/sda"]])],
1510 "set block device to read-write",
1512 Sets the block device named C<device> to read-write.
1514 This uses the L<blockdev(8)> command.");
1516 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1517 [InitEmpty, Always, TestOutputTrue (
1518 [["blockdev_setro"; "/dev/sda"];
1519 ["blockdev_getro"; "/dev/sda"]])],
1520 "is block device set to read-only",
1522 Returns a boolean indicating if the block device is read-only
1523 (true if read-only, false if not).
1525 This uses the L<blockdev(8)> command.");
1527 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1528 [InitEmpty, Always, TestOutputInt (
1529 [["blockdev_getss"; "/dev/sda"]], 512)],
1530 "get sectorsize of block device",
1532 This returns the size of sectors on a block device.
1533 Usually 512, but can be larger for modern devices.
1535 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1538 This uses the L<blockdev(8)> command.");
1540 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1541 [InitEmpty, Always, TestOutputInt (
1542 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1543 "get blocksize of block device",
1545 This returns the block size of a device.
1547 (Note this is different from both I<size in blocks> and
1548 I<filesystem block size>).
1550 This uses the L<blockdev(8)> command.");
1552 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1554 "set blocksize of block device",
1556 This sets the block size of a device.
1558 (Note this is different from both I<size in blocks> and
1559 I<filesystem block size>).
1561 This uses the L<blockdev(8)> command.");
1563 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1564 [InitEmpty, Always, TestOutputInt (
1565 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1566 "get total size of device in 512-byte sectors",
1568 This returns the size of the device in units of 512-byte sectors
1569 (even if the sectorsize isn't 512 bytes ... weird).
1571 See also C<guestfs_blockdev_getss> for the real sector size of
1572 the device, and C<guestfs_blockdev_getsize64> for the more
1573 useful I<size in bytes>.
1575 This uses the L<blockdev(8)> command.");
1577 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1578 [InitEmpty, Always, TestOutputInt (
1579 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1580 "get total size of device in bytes",
1582 This returns the size of the device in bytes.
1584 See also C<guestfs_blockdev_getsz>.
1586 This uses the L<blockdev(8)> command.");
1588 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1589 [InitEmpty, Always, TestRun
1590 [["blockdev_flushbufs"; "/dev/sda"]]],
1591 "flush device buffers",
1593 This tells the kernel to flush internal buffers associated
1596 This uses the L<blockdev(8)> command.");
1598 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1599 [InitEmpty, Always, TestRun
1600 [["blockdev_rereadpt"; "/dev/sda"]]],
1601 "reread partition table",
1603 Reread the partition table on C<device>.
1605 This uses the L<blockdev(8)> command.");
1607 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1608 [InitBasicFS, Always, TestOutput (
1609 (* Pick a file from cwd which isn't likely to change. *)
1610 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1611 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1612 "upload a file from the local machine",
1614 Upload local file C<filename> to C<remotefilename> on the
1617 C<filename> can also be a named pipe.
1619 See also C<guestfs_download>.");
1621 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1622 [InitBasicFS, Always, TestOutput (
1623 (* Pick a file from cwd which isn't likely to change. *)
1624 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1625 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1626 ["upload"; "testdownload.tmp"; "/upload"];
1627 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1628 "download a file to the local machine",
1630 Download file C<remotefilename> and save it as C<filename>
1631 on the local machine.
1633 C<filename> can also be a named pipe.
1635 See also C<guestfs_upload>, C<guestfs_cat>.");
1637 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1638 [InitBasicFS, Always, TestOutput (
1639 [["write_file"; "/new"; "test\n"; "0"];
1640 ["checksum"; "crc"; "/new"]], "935282863");
1641 InitBasicFS, Always, TestLastFail (
1642 [["checksum"; "crc"; "/new"]]);
1643 InitBasicFS, Always, TestOutput (
1644 [["write_file"; "/new"; "test\n"; "0"];
1645 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1646 InitBasicFS, Always, TestOutput (
1647 [["write_file"; "/new"; "test\n"; "0"];
1648 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1649 InitBasicFS, Always, TestOutput (
1650 [["write_file"; "/new"; "test\n"; "0"];
1651 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1652 InitBasicFS, Always, TestOutput (
1653 [["write_file"; "/new"; "test\n"; "0"];
1654 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1655 InitBasicFS, Always, TestOutput (
1656 [["write_file"; "/new"; "test\n"; "0"];
1657 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1658 InitBasicFS, Always, TestOutput (
1659 [["write_file"; "/new"; "test\n"; "0"];
1660 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1661 InitBasicFS, Always, TestOutput (
1662 (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1663 * the type explicitly.
1665 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1666 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1667 "compute MD5, SHAx or CRC checksum of file",
1669 This call computes the MD5, SHAx or CRC checksum of the
1672 The type of checksum to compute is given by the C<csumtype>
1673 parameter which must have one of the following values:
1679 Compute the cyclic redundancy check (CRC) specified by POSIX
1680 for the C<cksum> command.
1684 Compute the MD5 hash (using the C<md5sum> program).
1688 Compute the SHA1 hash (using the C<sha1sum> program).
1692 Compute the SHA224 hash (using the C<sha224sum> program).
1696 Compute the SHA256 hash (using the C<sha256sum> program).
1700 Compute the SHA384 hash (using the C<sha384sum> program).
1704 Compute the SHA512 hash (using the C<sha512sum> program).
1708 The checksum is returned as a printable string.");
1710 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1711 [InitBasicFS, Always, TestOutput (
1712 [["tar_in"; "../images/helloworld.tar"; "/"];
1713 ["cat"; "/hello"]], "hello\n")],
1714 "unpack tarfile to directory",
1716 This command uploads and unpacks local file C<tarfile> (an
1717 I<uncompressed> tar file) into C<directory>.
1719 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1721 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1723 "pack directory into tarfile",
1725 This command packs the contents of C<directory> and downloads
1726 it to local file C<tarfile>.
1728 To download a compressed tarball, use C<guestfs_tgz_out>.");
1730 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1731 [InitBasicFS, Always, TestOutput (
1732 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1733 ["cat"; "/hello"]], "hello\n")],
1734 "unpack compressed tarball to directory",
1736 This command uploads and unpacks local file C<tarball> (a
1737 I<gzip compressed> tar file) into C<directory>.
1739 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1741 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1743 "pack directory into compressed tarball",
1745 This command packs the contents of C<directory> and downloads
1746 it to local file C<tarball>.
1748 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1750 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1751 [InitBasicFS, Always, TestLastFail (
1753 ["mount_ro"; "/dev/sda1"; "/"];
1754 ["touch"; "/new"]]);
1755 InitBasicFS, Always, TestOutput (
1756 [["write_file"; "/new"; "data"; "0"];
1758 ["mount_ro"; "/dev/sda1"; "/"];
1759 ["cat"; "/new"]], "data")],
1760 "mount a guest disk, read-only",
1762 This is the same as the C<guestfs_mount> command, but it
1763 mounts the filesystem with the read-only (I<-o ro>) flag.");
1765 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1767 "mount a guest disk with mount options",
1769 This is the same as the C<guestfs_mount> command, but it
1770 allows you to set the mount options as for the
1771 L<mount(8)> I<-o> flag.");
1773 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1775 "mount a guest disk with mount options and vfstype",
1777 This is the same as the C<guestfs_mount> command, but it
1778 allows you to set both the mount options and the vfstype
1779 as for the L<mount(8)> I<-o> and I<-t> flags.");
1781 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1783 "debugging and internals",
1785 The C<guestfs_debug> command exposes some internals of
1786 C<guestfsd> (the guestfs daemon) that runs inside the
1789 There is no comprehensive help for this command. You have
1790 to look at the file C<daemon/debug.c> in the libguestfs source
1791 to find out what you can do.");
1793 ("lvremove", (RErr, [String "device"]), 77, [],
1794 [InitEmpty, Always, TestOutputList (
1795 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1796 ["pvcreate"; "/dev/sda1"];
1797 ["vgcreate"; "VG"; "/dev/sda1"];
1798 ["lvcreate"; "LV1"; "VG"; "50"];
1799 ["lvcreate"; "LV2"; "VG"; "50"];
1800 ["lvremove"; "/dev/VG/LV1"];
1801 ["lvs"]], ["/dev/VG/LV2"]);
1802 InitEmpty, Always, TestOutputList (
1803 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1804 ["pvcreate"; "/dev/sda1"];
1805 ["vgcreate"; "VG"; "/dev/sda1"];
1806 ["lvcreate"; "LV1"; "VG"; "50"];
1807 ["lvcreate"; "LV2"; "VG"; "50"];
1808 ["lvremove"; "/dev/VG"];
1810 InitEmpty, Always, TestOutputList (
1811 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1812 ["pvcreate"; "/dev/sda1"];
1813 ["vgcreate"; "VG"; "/dev/sda1"];
1814 ["lvcreate"; "LV1"; "VG"; "50"];
1815 ["lvcreate"; "LV2"; "VG"; "50"];
1816 ["lvremove"; "/dev/VG"];
1818 "remove an LVM logical volume",
1820 Remove an LVM logical volume C<device>, where C<device> is
1821 the path to the LV, such as C</dev/VG/LV>.
1823 You can also remove all LVs in a volume group by specifying
1824 the VG name, C</dev/VG>.");
1826 ("vgremove", (RErr, [String "vgname"]), 78, [],
1827 [InitEmpty, Always, TestOutputList (
1828 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1829 ["pvcreate"; "/dev/sda1"];
1830 ["vgcreate"; "VG"; "/dev/sda1"];
1831 ["lvcreate"; "LV1"; "VG"; "50"];
1832 ["lvcreate"; "LV2"; "VG"; "50"];
1835 InitEmpty, Always, TestOutputList (
1836 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1837 ["pvcreate"; "/dev/sda1"];
1838 ["vgcreate"; "VG"; "/dev/sda1"];
1839 ["lvcreate"; "LV1"; "VG"; "50"];
1840 ["lvcreate"; "LV2"; "VG"; "50"];
1843 "remove an LVM volume group",
1845 Remove an LVM volume group C<vgname>, (for example C<VG>).
1847 This also forcibly removes all logical volumes in the volume
1850 ("pvremove", (RErr, [String "device"]), 79, [],
1851 [InitEmpty, Always, TestOutputListOfDevices (
1852 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1853 ["pvcreate"; "/dev/sda1"];
1854 ["vgcreate"; "VG"; "/dev/sda1"];
1855 ["lvcreate"; "LV1"; "VG"; "50"];
1856 ["lvcreate"; "LV2"; "VG"; "50"];
1858 ["pvremove"; "/dev/sda1"];
1860 InitEmpty, Always, TestOutputListOfDevices (
1861 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1862 ["pvcreate"; "/dev/sda1"];
1863 ["vgcreate"; "VG"; "/dev/sda1"];
1864 ["lvcreate"; "LV1"; "VG"; "50"];
1865 ["lvcreate"; "LV2"; "VG"; "50"];
1867 ["pvremove"; "/dev/sda1"];
1869 InitEmpty, Always, TestOutputListOfDevices (
1870 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1871 ["pvcreate"; "/dev/sda1"];
1872 ["vgcreate"; "VG"; "/dev/sda1"];
1873 ["lvcreate"; "LV1"; "VG"; "50"];
1874 ["lvcreate"; "LV2"; "VG"; "50"];
1876 ["pvremove"; "/dev/sda1"];
1878 "remove an LVM physical volume",
1880 This wipes a physical volume C<device> so that LVM will no longer
1883 The implementation uses the C<pvremove> command which refuses to
1884 wipe physical volumes that contain any volume groups, so you have
1885 to remove those first.");
1887 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1888 [InitBasicFS, Always, TestOutput (
1889 [["set_e2label"; "/dev/sda1"; "testlabel"];
1890 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1891 "set the ext2/3/4 filesystem label",
1893 This sets the ext2/3/4 filesystem label of the filesystem on
1894 C<device> to C<label>. Filesystem labels are limited to
1897 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1898 to return the existing label on a filesystem.");
1900 ("get_e2label", (RString "label", [String "device"]), 81, [],
1902 "get the ext2/3/4 filesystem label",
1904 This returns the ext2/3/4 filesystem label of the filesystem on
1907 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1908 [InitBasicFS, Always, TestOutput (
1909 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1910 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1911 InitBasicFS, Always, TestOutput (
1912 [["set_e2uuid"; "/dev/sda1"; "clear"];
1913 ["get_e2uuid"; "/dev/sda1"]], "");
1914 (* We can't predict what UUIDs will be, so just check the commands run. *)
1915 InitBasicFS, Always, TestRun (
1916 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1917 InitBasicFS, Always, TestRun (
1918 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1919 "set the ext2/3/4 filesystem UUID",
1921 This sets the ext2/3/4 filesystem UUID of the filesystem on
1922 C<device> to C<uuid>. The format of the UUID and alternatives
1923 such as C<clear>, C<random> and C<time> are described in the
1924 L<tune2fs(8)> manpage.
1926 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1927 to return the existing UUID of a filesystem.");
1929 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1931 "get the ext2/3/4 filesystem UUID",
1933 This returns the ext2/3/4 filesystem UUID of the filesystem on
1936 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1937 [InitBasicFS, Always, TestOutputInt (
1938 [["umount"; "/dev/sda1"];
1939 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1940 InitBasicFS, Always, TestOutputInt (
1941 [["umount"; "/dev/sda1"];
1942 ["zero"; "/dev/sda1"];
1943 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1944 "run the filesystem checker",
1946 This runs the filesystem checker (fsck) on C<device> which
1947 should have filesystem type C<fstype>.
1949 The returned integer is the status. See L<fsck(8)> for the
1950 list of status codes from C<fsck>.
1958 Multiple status codes can be summed together.
1962 A non-zero return code can mean \"success\", for example if
1963 errors have been corrected on the filesystem.
1967 Checking or repairing NTFS volumes is not supported
1972 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1974 ("zero", (RErr, [String "device"]), 85, [],
1975 [InitBasicFS, Always, TestOutput (
1976 [["umount"; "/dev/sda1"];
1977 ["zero"; "/dev/sda1"];
1978 ["file"; "/dev/sda1"]], "data")],
1979 "write zeroes to the device",
1981 This command writes zeroes over the first few blocks of C<device>.
1983 How many blocks are zeroed isn't specified (but it's I<not> enough
1984 to securely wipe the device). It should be sufficient to remove
1985 any partition tables, filesystem superblocks and so on.
1987 See also: C<guestfs_scrub_device>.");
1989 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1990 [InitBasicFS, Always, TestOutputTrue (
1991 [["grub_install"; "/"; "/dev/sda1"];
1992 ["is_dir"; "/boot"]])],
1995 This command installs GRUB (the Grand Unified Bootloader) on
1996 C<device>, with the root directory being C<root>.");
1998 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1999 [InitBasicFS, Always, TestOutput (
2000 [["write_file"; "/old"; "file content"; "0"];
2001 ["cp"; "/old"; "/new"];
2002 ["cat"; "/new"]], "file content");
2003 InitBasicFS, Always, TestOutputTrue (
2004 [["write_file"; "/old"; "file content"; "0"];
2005 ["cp"; "/old"; "/new"];
2006 ["is_file"; "/old"]]);
2007 InitBasicFS, Always, TestOutput (
2008 [["write_file"; "/old"; "file content"; "0"];
2010 ["cp"; "/old"; "/dir/new"];
2011 ["cat"; "/dir/new"]], "file content")],
2014 This copies a file from C<src> to C<dest> where C<dest> is
2015 either a destination filename or destination directory.");
2017 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2018 [InitBasicFS, Always, TestOutput (
2019 [["mkdir"; "/olddir"];
2020 ["mkdir"; "/newdir"];
2021 ["write_file"; "/olddir/file"; "file content"; "0"];
2022 ["cp_a"; "/olddir"; "/newdir"];
2023 ["cat"; "/newdir/olddir/file"]], "file content")],
2024 "copy a file or directory recursively",
2026 This copies a file or directory from C<src> to C<dest>
2027 recursively using the C<cp -a> command.");
2029 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2030 [InitBasicFS, Always, TestOutput (
2031 [["write_file"; "/old"; "file content"; "0"];
2032 ["mv"; "/old"; "/new"];
2033 ["cat"; "/new"]], "file content");
2034 InitBasicFS, Always, TestOutputFalse (
2035 [["write_file"; "/old"; "file content"; "0"];
2036 ["mv"; "/old"; "/new"];
2037 ["is_file"; "/old"]])],
2040 This moves a file from C<src> to C<dest> where C<dest> is
2041 either a destination filename or destination directory.");
2043 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2044 [InitEmpty, Always, TestRun (
2045 [["drop_caches"; "3"]])],
2046 "drop kernel page cache, dentries and inodes",
2048 This instructs the guest kernel to drop its page cache,
2049 and/or dentries and inode caches. The parameter C<whattodrop>
2050 tells the kernel what precisely to drop, see
2051 L<http://linux-mm.org/Drop_Caches>
2053 Setting C<whattodrop> to 3 should drop everything.
2055 This automatically calls L<sync(2)> before the operation,
2056 so that the maximum guest memory is freed.");
2058 ("dmesg", (RString "kmsgs", []), 91, [],
2059 [InitEmpty, Always, TestRun (
2061 "return kernel messages",
2063 This returns the kernel messages (C<dmesg> output) from
2064 the guest kernel. This is sometimes useful for extended
2065 debugging of problems.
2067 Another way to get the same information is to enable
2068 verbose messages with C<guestfs_set_verbose> or by setting
2069 the environment variable C<LIBGUESTFS_DEBUG=1> before
2070 running the program.");
2072 ("ping_daemon", (RErr, []), 92, [],
2073 [InitEmpty, Always, TestRun (
2074 [["ping_daemon"]])],
2075 "ping the guest daemon",
2077 This is a test probe into the guestfs daemon running inside
2078 the qemu subprocess. Calling this function checks that the
2079 daemon responds to the ping message, without affecting the daemon
2080 or attached block device(s) in any other way.");
2082 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2083 [InitBasicFS, Always, TestOutputTrue (
2084 [["write_file"; "/file1"; "contents of a file"; "0"];
2085 ["cp"; "/file1"; "/file2"];
2086 ["equal"; "/file1"; "/file2"]]);
2087 InitBasicFS, Always, TestOutputFalse (
2088 [["write_file"; "/file1"; "contents of a file"; "0"];
2089 ["write_file"; "/file2"; "contents of another file"; "0"];
2090 ["equal"; "/file1"; "/file2"]]);
2091 InitBasicFS, Always, TestLastFail (
2092 [["equal"; "/file1"; "/file2"]])],
2093 "test if two files have equal contents",
2095 This compares the two files C<file1> and C<file2> and returns
2096 true if their content is exactly equal, or false otherwise.
2098 The external L<cmp(1)> program is used for the comparison.");
2100 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2101 [InitBasicFS, Always, TestOutputList (
2102 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2103 ["strings"; "/new"]], ["hello"; "world"]);
2104 InitBasicFS, Always, TestOutputList (
2106 ["strings"; "/new"]], [])],
2107 "print the printable strings in a file",
2109 This runs the L<strings(1)> command on a file and returns
2110 the list of printable strings found.");
2112 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2113 [InitBasicFS, Always, TestOutputList (
2114 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2115 ["strings_e"; "b"; "/new"]], []);
2116 InitBasicFS, Disabled, TestOutputList (
2117 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2118 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2119 "print the printable strings in a file",
2121 This is like the C<guestfs_strings> command, but allows you to
2122 specify the encoding.
2124 See the L<strings(1)> manpage for the full list of encodings.
2126 Commonly useful encodings are C<l> (lower case L) which will
2127 show strings inside Windows/x86 files.
2129 The returned strings are transcoded to UTF-8.");
2131 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2132 [InitBasicFS, Always, TestOutput (
2133 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2134 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n");
2135 (* Test for RHBZ#501888c2 regression which caused large hexdump
2136 * commands to segfault.
2138 InitBasicFS, Always, TestRun (
2139 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2140 ["hexdump"; "/100krandom"]])],
2141 "dump a file in hexadecimal",
2143 This runs C<hexdump -C> on the given C<path>. The result is
2144 the human-readable, canonical hex dump of the file.");
2146 ("zerofree", (RErr, [String "device"]), 97, [],
2147 [InitNone, Always, TestOutput (
2148 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2149 ["mkfs"; "ext3"; "/dev/sda1"];
2150 ["mount"; "/dev/sda1"; "/"];
2151 ["write_file"; "/new"; "test file"; "0"];
2152 ["umount"; "/dev/sda1"];
2153 ["zerofree"; "/dev/sda1"];
2154 ["mount"; "/dev/sda1"; "/"];
2155 ["cat"; "/new"]], "test file")],
2156 "zero unused inodes and disk blocks on ext2/3 filesystem",
2158 This runs the I<zerofree> program on C<device>. This program
2159 claims to zero unused inodes and disk blocks on an ext2/3
2160 filesystem, thus making it possible to compress the filesystem
2163 You should B<not> run this program if the filesystem is
2166 It is possible that using this program can damage the filesystem
2167 or data on the filesystem.");
2169 ("pvresize", (RErr, [String "device"]), 98, [],
2171 "resize an LVM physical volume",
2173 This resizes (expands or shrinks) an existing LVM physical
2174 volume to match the new size of the underlying device.");
2176 ("sfdisk_N", (RErr, [String "device"; Int "n";
2177 Int "cyls"; Int "heads"; Int "sectors";
2178 String "line"]), 99, [DangerWillRobinson],
2180 "modify a single partition on a block device",
2182 This runs L<sfdisk(8)> option to modify just the single
2183 partition C<n> (note: C<n> counts from 1).
2185 For other parameters, see C<guestfs_sfdisk>. You should usually
2186 pass C<0> for the cyls/heads/sectors parameters.");
2188 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2190 "display the partition table",
2192 This displays the partition table on C<device>, in the
2193 human-readable output of the L<sfdisk(8)> command. It is
2194 not intended to be parsed.");
2196 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2198 "display the kernel geometry",
2200 This displays the kernel's idea of the geometry of C<device>.
2202 The result is in human-readable format, and not designed to
2205 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2207 "display the disk geometry from the partition table",
2209 This displays the disk geometry of C<device> read from the
2210 partition table. Especially in the case where the underlying
2211 block device has been resized, this can be different from the
2212 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2214 The result is in human-readable format, and not designed to
2217 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2219 "activate or deactivate all volume groups",
2221 This command activates or (if C<activate> is false) deactivates
2222 all logical volumes in all volume groups.
2223 If activated, then they are made known to the
2224 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2225 then those devices disappear.
2227 This command is the same as running C<vgchange -a y|n>");
2229 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2231 "activate or deactivate some volume groups",
2233 This command activates or (if C<activate> is false) deactivates
2234 all logical volumes in the listed volume groups C<volgroups>.
2235 If activated, then they are made known to the
2236 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2237 then those devices disappear.
2239 This command is the same as running C<vgchange -a y|n volgroups...>
2241 Note that if C<volgroups> is an empty list then B<all> volume groups
2242 are activated or deactivated.");
2244 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2245 [InitNone, Always, TestOutput (
2246 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2247 ["pvcreate"; "/dev/sda1"];
2248 ["vgcreate"; "VG"; "/dev/sda1"];
2249 ["lvcreate"; "LV"; "VG"; "10"];
2250 ["mkfs"; "ext2"; "/dev/VG/LV"];
2251 ["mount"; "/dev/VG/LV"; "/"];
2252 ["write_file"; "/new"; "test content"; "0"];
2254 ["lvresize"; "/dev/VG/LV"; "20"];
2255 ["e2fsck_f"; "/dev/VG/LV"];
2256 ["resize2fs"; "/dev/VG/LV"];
2257 ["mount"; "/dev/VG/LV"; "/"];
2258 ["cat"; "/new"]], "test content")],
2259 "resize an LVM logical volume",
2261 This resizes (expands or shrinks) an existing LVM logical
2262 volume to C<mbytes>. When reducing, data in the reduced part
2265 ("resize2fs", (RErr, [String "device"]), 106, [],
2266 [], (* lvresize tests this *)
2267 "resize an ext2/ext3 filesystem",
2269 This resizes an ext2 or ext3 filesystem to match the size of
2270 the underlying device.
2272 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2273 on the C<device> before calling this command. For unknown reasons
2274 C<resize2fs> sometimes gives an error about this and sometimes not.
2275 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2276 calling this function.");
2278 ("find", (RStringList "names", [String "directory"]), 107, [],
2279 [InitBasicFS, Always, TestOutputList (
2280 [["find"; "/"]], ["lost+found"]);
2281 InitBasicFS, Always, TestOutputList (
2285 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2286 InitBasicFS, Always, TestOutputList (
2287 [["mkdir_p"; "/a/b/c"];
2288 ["touch"; "/a/b/c/d"];
2289 ["find"; "/a/b/"]], ["c"; "c/d"])],
2290 "find all files and directories",
2292 This command lists out all files and directories, recursively,
2293 starting at C<directory>. It is essentially equivalent to
2294 running the shell command C<find directory -print> but some
2295 post-processing happens on the output, described below.
2297 This returns a list of strings I<without any prefix>. Thus
2298 if the directory structure was:
2304 then the returned list from C<guestfs_find> C</tmp> would be
2312 If C<directory> is not a directory, then this command returns
2315 The returned list is sorted.");
2317 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2318 [], (* lvresize tests this *)
2319 "check an ext2/ext3 filesystem",
2321 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2322 filesystem checker on C<device>, noninteractively (C<-p>),
2323 even if the filesystem appears to be clean (C<-f>).
2325 This command is only needed because of C<guestfs_resize2fs>
2326 (q.v.). Normally you should use C<guestfs_fsck>.");
2328 ("sleep", (RErr, [Int "secs"]), 109, [],
2329 [InitNone, Always, TestRun (
2331 "sleep for some seconds",
2333 Sleep for C<secs> seconds.");
2335 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2336 [InitNone, Always, TestOutputInt (
2337 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2338 ["mkfs"; "ntfs"; "/dev/sda1"];
2339 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2340 InitNone, Always, TestOutputInt (
2341 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2342 ["mkfs"; "ext2"; "/dev/sda1"];
2343 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2344 "probe NTFS volume",
2346 This command runs the L<ntfs-3g.probe(8)> command which probes
2347 an NTFS C<device> for mountability. (Not all NTFS volumes can
2348 be mounted read-write, and some cannot be mounted at all).
2350 C<rw> is a boolean flag. Set it to true if you want to test
2351 if the volume can be mounted read-write. Set it to false if
2352 you want to test if the volume can be mounted read-only.
2354 The return value is an integer which C<0> if the operation
2355 would succeed, or some non-zero value documented in the
2356 L<ntfs-3g.probe(8)> manual page.");
2358 ("sh", (RString "output", [String "command"]), 111, [],
2359 [], (* XXX needs tests *)
2360 "run a command via the shell",
2362 This call runs a command from the guest filesystem via the
2365 This is like C<guestfs_command>, but passes the command to:
2367 /bin/sh -c \"command\"
2369 Depending on the guest's shell, this usually results in
2370 wildcards being expanded, shell expressions being interpolated
2373 All the provisos about C<guestfs_command> apply to this call.");
2375 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2376 [], (* XXX needs tests *)
2377 "run a command via the shell returning lines",
2379 This is the same as C<guestfs_sh>, but splits the result
2380 into a list of lines.
2382 See also: C<guestfs_command_lines>");
2384 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2385 [InitBasicFS, Always, TestOutputList (
2386 [["mkdir_p"; "/a/b/c"];
2387 ["touch"; "/a/b/c/d"];
2388 ["touch"; "/a/b/c/e"];
2389 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2390 InitBasicFS, Always, TestOutputList (
2391 [["mkdir_p"; "/a/b/c"];
2392 ["touch"; "/a/b/c/d"];
2393 ["touch"; "/a/b/c/e"];
2394 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2395 InitBasicFS, Always, TestOutputList (
2396 [["mkdir_p"; "/a/b/c"];
2397 ["touch"; "/a/b/c/d"];
2398 ["touch"; "/a/b/c/e"];
2399 ["glob_expand"; "/a/*/x/*"]], [])],
2400 "expand a wildcard path",
2402 This command searches for all the pathnames matching
2403 C<pattern> according to the wildcard expansion rules
2406 If no paths match, then this returns an empty list
2407 (note: not an error).
2409 It is just a wrapper around the C L<glob(3)> function
2410 with flags C<GLOB_MARK|GLOB_BRACE>.
2411 See that manual page for more details.");
2413 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2414 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2415 [["scrub_device"; "/dev/sdc"]])],
2416 "scrub (securely wipe) a device",
2418 This command writes patterns over C<device> to make data retrieval
2421 It is an interface to the L<scrub(1)> program. See that
2422 manual page for more details.");
2424 ("scrub_file", (RErr, [String "file"]), 115, [],
2425 [InitBasicFS, Always, TestRun (
2426 [["write_file"; "/file"; "content"; "0"];
2427 ["scrub_file"; "/file"]])],
2428 "scrub (securely wipe) a file",
2430 This command writes patterns over a file to make data retrieval
2433 The file is I<removed> after scrubbing.
2435 It is an interface to the L<scrub(1)> program. See that
2436 manual page for more details.");
2438 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2439 [], (* XXX needs testing *)
2440 "scrub (securely wipe) free space",
2442 This command creates the directory C<dir> and then fills it
2443 with files until the filesystem is full, and scrubs the files
2444 as for C<guestfs_scrub_file>, and deletes them.
2445 The intention is to scrub any free space on the partition
2448 It is an interface to the L<scrub(1)> program. See that
2449 manual page for more details.");
2451 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2452 [InitBasicFS, Always, TestRun (
2454 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2455 "create a temporary directory",
2457 This command creates a temporary directory. The
2458 C<template> parameter should be a full pathname for the
2459 temporary directory name with the final six characters being
2462 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2463 the second one being suitable for Windows filesystems.
2465 The name of the temporary directory that was created
2468 The temporary directory is created with mode 0700
2469 and is owned by root.
2471 The caller is responsible for deleting the temporary
2472 directory and its contents after use.
2474 See also: L<mkdtemp(3)>");
2476 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2477 [InitBasicFS, Always, TestOutputInt (
2478 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2479 ["wc_l"; "/10klines"]], 10000)],
2480 "count lines in a file",
2482 This command counts the lines in a file, using the
2483 C<wc -l> external command.");
2485 ("wc_w", (RInt "words", [String "path"]), 119, [],
2486 [InitBasicFS, Always, TestOutputInt (
2487 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2488 ["wc_w"; "/10klines"]], 10000)],
2489 "count words in a file",
2491 This command counts the words in a file, using the
2492 C<wc -w> external command.");
2494 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2495 [InitBasicFS, Always, TestOutputInt (
2496 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2497 ["wc_c"; "/100kallspaces"]], 102400)],
2498 "count characters in a file",
2500 This command counts the characters in a file, using the
2501 C<wc -c> external command.");
2505 let all_functions = non_daemon_functions @ daemon_functions
2507 (* In some places we want the functions to be displayed sorted
2508 * alphabetically, so this is useful:
2510 let all_functions_sorted =
2511 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2512 compare n1 n2) all_functions
2514 (* Column names and types from LVM PVs/VGs/LVs. *)
2523 "pv_attr", `String (* XXX *);
2524 "pv_pe_count", `Int;
2525 "pv_pe_alloc_count", `Int;
2528 "pv_mda_count", `Int;
2529 "pv_mda_free", `Bytes;
2530 (* Not in Fedora 10:
2531 "pv_mda_size", `Bytes;
2538 "vg_attr", `String (* XXX *);
2541 "vg_sysid", `String;
2542 "vg_extent_size", `Bytes;
2543 "vg_extent_count", `Int;
2544 "vg_free_count", `Int;
2552 "vg_mda_count", `Int;
2553 "vg_mda_free", `Bytes;
2554 (* Not in Fedora 10:
2555 "vg_mda_size", `Bytes;
2561 "lv_attr", `String (* XXX *);
2564 "lv_kernel_major", `Int;
2565 "lv_kernel_minor", `Int;
2569 "snap_percent", `OptPercent;
2570 "copy_percent", `OptPercent;
2573 "mirror_log", `String;
2577 (* Column names and types from stat structures.
2578 * NB. Can't use things like 'st_atime' because glibc header files
2579 * define some of these as macros. Ugh.
2596 let statvfs_cols = [
2610 (* Used for testing language bindings. *)
2612 | CallString of string
2613 | CallOptString of string option
2614 | CallStringList of string list
2618 (* Useful functions.
2619 * Note we don't want to use any external OCaml libraries which
2620 * makes this a bit harder than it should be.
2622 let failwithf fs = ksprintf failwith fs
2624 let replace_char s c1 c2 =
2625 let s2 = String.copy s in
2626 let r = ref false in
2627 for i = 0 to String.length s2 - 1 do
2628 if String.unsafe_get s2 i = c1 then (
2629 String.unsafe_set s2 i c2;
2633 if not !r then s else s2
2637 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2639 let triml ?(test = isspace) str =
2641 let n = ref (String.length str) in
2642 while !n > 0 && test str.[!i]; do
2647 else String.sub str !i !n
2649 let trimr ?(test = isspace) str =
2650 let n = ref (String.length str) in
2651 while !n > 0 && test str.[!n-1]; do
2654 if !n = String.length str then str
2655 else String.sub str 0 !n
2657 let trim ?(test = isspace) str =
2658 trimr ~test (triml ~test str)
2660 let rec find s sub =
2661 let len = String.length s in
2662 let sublen = String.length sub in
2664 if i <= len-sublen then (
2666 if j < sublen then (
2667 if s.[i+j] = sub.[j] then loop2 (j+1)
2673 if r = -1 then loop (i+1) else r
2679 let rec replace_str s s1 s2 =
2680 let len = String.length s in
2681 let sublen = String.length s1 in
2682 let i = find s s1 in
2685 let s' = String.sub s 0 i in
2686 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2687 s' ^ s2 ^ replace_str s'' s1 s2
2690 let rec string_split sep str =
2691 let len = String.length str in
2692 let seplen = String.length sep in
2693 let i = find str sep in
2694 if i = -1 then [str]
2696 let s' = String.sub str 0 i in
2697 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2698 s' :: string_split sep s''
2701 let files_equal n1 n2 =
2702 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2703 match Sys.command cmd with
2706 | i -> failwithf "%s: failed with error code %d" cmd i
2708 let rec find_map f = function
2709 | [] -> raise Not_found
2713 | None -> find_map f xs
2716 let rec loop i = function
2718 | x :: xs -> f i x; loop (i+1) xs
2723 let rec loop i = function
2725 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2729 let name_of_argt = function
2730 | String n | OptString n | StringList n | Bool n | Int n
2731 | FileIn n | FileOut n -> n
2733 let seq_of_test = function
2734 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2735 | TestOutputListOfDevices (s, _)
2736 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2737 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2738 | TestLastFail s -> s
2740 (* Check function names etc. for consistency. *)
2741 let check_functions () =
2742 let contains_uppercase str =
2743 let len = String.length str in
2745 if i >= len then false
2748 if c >= 'A' && c <= 'Z' then true
2755 (* Check function names. *)
2757 fun (name, _, _, _, _, _, _) ->
2758 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2759 failwithf "function name %s does not need 'guestfs' prefix" name;
2761 failwithf "function name is empty";
2762 if name.[0] < 'a' || name.[0] > 'z' then
2763 failwithf "function name %s must start with lowercase a-z" name;
2764 if String.contains name '-' then
2765 failwithf "function name %s should not contain '-', use '_' instead."
2769 (* Check function parameter/return names. *)
2771 fun (name, style, _, _, _, _, _) ->
2772 let check_arg_ret_name n =
2773 if contains_uppercase n then
2774 failwithf "%s param/ret %s should not contain uppercase chars"
2776 if String.contains n '-' || String.contains n '_' then
2777 failwithf "%s param/ret %s should not contain '-' or '_'"
2780 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;
2781 if n = "int" || n = "char" || n = "short" || n = "long" then
2782 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
2784 failwithf "%s has a param/ret called 'i', which will cause some conflicts in the generated code" name;
2785 if n = "argv" || n = "args" then
2786 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
2789 (match fst style with
2791 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2792 | RStringList n | RPVList n | RVGList n | RLVList n
2793 | RStat n | RStatVFS n
2795 check_arg_ret_name n
2797 check_arg_ret_name n;
2798 check_arg_ret_name m
2800 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2803 (* Check short descriptions. *)
2805 fun (name, _, _, _, _, shortdesc, _) ->
2806 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2807 failwithf "short description of %s should begin with lowercase." name;
2808 let c = shortdesc.[String.length shortdesc-1] in
2809 if c = '\n' || c = '.' then
2810 failwithf "short description of %s should not end with . or \\n." name
2813 (* Check long dscriptions. *)
2815 fun (name, _, _, _, _, _, longdesc) ->
2816 if longdesc.[String.length longdesc-1] = '\n' then
2817 failwithf "long description of %s should not end with \\n." name
2820 (* Check proc_nrs. *)
2822 fun (name, _, proc_nr, _, _, _, _) ->
2823 if proc_nr <= 0 then
2824 failwithf "daemon function %s should have proc_nr > 0" name
2828 fun (name, _, proc_nr, _, _, _, _) ->
2829 if proc_nr <> -1 then
2830 failwithf "non-daemon function %s should have proc_nr -1" name
2831 ) non_daemon_functions;
2834 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2837 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2838 let rec loop = function
2841 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2843 | (name1,nr1) :: (name2,nr2) :: _ ->
2844 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2852 (* Ignore functions that have no tests. We generate a
2853 * warning when the user does 'make check' instead.
2855 | name, _, _, _, [], _, _ -> ()
2856 | name, _, _, _, tests, _, _ ->
2860 match seq_of_test test with
2862 failwithf "%s has a test containing an empty sequence" name
2863 | cmds -> List.map List.hd cmds
2865 let funcs = List.flatten funcs in
2867 let tested = List.mem name funcs in
2870 failwithf "function %s has tests but does not test itself" name
2873 (* 'pr' prints to the current output file. *)
2874 let chan = ref stdout
2875 let pr fs = ksprintf (output_string !chan) fs
2877 (* Generate a header block in a number of standard styles. *)
2878 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2879 type license = GPLv2 | LGPLv2
2881 let generate_header comment license =
2882 let c = match comment with
2883 | CStyle -> pr "/* "; " *"
2884 | HashStyle -> pr "# "; "#"
2885 | OCamlStyle -> pr "(* "; " *"
2886 | HaskellStyle -> pr "{- "; " " in
2887 pr "libguestfs generated file\n";
2888 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2889 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2891 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2895 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2896 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2897 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2898 pr "%s (at your option) any later version.\n" c;
2900 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2901 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2902 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2903 pr "%s GNU General Public License for more details.\n" c;
2905 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2906 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2907 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2910 pr "%s This library is free software; you can redistribute it and/or\n" c;
2911 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2912 pr "%s License as published by the Free Software Foundation; either\n" c;
2913 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2915 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2916 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2917 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2918 pr "%s Lesser General Public License for more details.\n" c;
2920 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2921 pr "%s License along with this library; if not, write to the Free Software\n" c;
2922 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2925 | CStyle -> pr " */\n"
2927 | OCamlStyle -> pr " *)\n"
2928 | HaskellStyle -> pr "-}\n"
2932 (* Start of main code generation functions below this line. *)
2934 (* Generate the pod documentation for the C API. *)
2935 let rec generate_actions_pod () =
2937 fun (shortname, style, _, flags, _, _, longdesc) ->
2938 if not (List.mem NotInDocs flags) then (
2939 let name = "guestfs_" ^ shortname in
2940 pr "=head2 %s\n\n" name;
2942 generate_prototype ~extern:false ~handle:"handle" name style;
2944 pr "%s\n\n" longdesc;
2945 (match fst style with
2947 pr "This function returns 0 on success or -1 on error.\n\n"
2949 pr "On error this function returns -1.\n\n"
2951 pr "On error this function returns -1.\n\n"
2953 pr "This function returns a C truth value on success or -1 on error.\n\n"
2955 pr "This function returns a string, or NULL on error.
2956 The string is owned by the guest handle and must I<not> be freed.\n\n"
2958 pr "This function returns a string, or NULL on error.
2959 I<The caller must free the returned string after use>.\n\n"
2961 pr "This function returns a NULL-terminated array of strings
2962 (like L<environ(3)>), or NULL if there was an error.
2963 I<The caller must free the strings and the array after use>.\n\n"
2965 pr "This function returns a C<struct guestfs_int_bool *>,
2966 or NULL if there was an error.
2967 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2969 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2970 (see E<lt>guestfs-structs.hE<gt>),
2971 or NULL if there was an error.
2972 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2974 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2975 (see E<lt>guestfs-structs.hE<gt>),
2976 or NULL if there was an error.
2977 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2979 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2980 (see E<lt>guestfs-structs.hE<gt>),
2981 or NULL if there was an error.
2982 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2984 pr "This function returns a C<struct guestfs_stat *>
2985 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2986 or NULL if there was an error.
2987 I<The caller must call C<free> after use>.\n\n"
2989 pr "This function returns a C<struct guestfs_statvfs *>
2990 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2991 or NULL if there was an error.
2992 I<The caller must call C<free> after use>.\n\n"
2994 pr "This function returns a NULL-terminated array of
2995 strings, or NULL if there was an error.
2996 The array of strings will always have length C<2n+1>, where
2997 C<n> keys and values alternate, followed by the trailing NULL entry.
2998 I<The caller must free the strings and the array after use>.\n\n"
3000 if List.mem ProtocolLimitWarning flags then
3001 pr "%s\n\n" protocol_limit_warning;
3002 if List.mem DangerWillRobinson flags then
3003 pr "%s\n\n" danger_will_robinson
3005 ) all_functions_sorted
3007 and generate_structs_pod () =
3008 (* LVM structs documentation. *)
3011 pr "=head2 guestfs_lvm_%s\n" typ;
3013 pr " struct guestfs_lvm_%s {\n" typ;
3016 | name, `String -> pr " char *%s;\n" name
3018 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3019 pr " char %s[32];\n" name
3020 | name, `Bytes -> pr " uint64_t %s;\n" name
3021 | name, `Int -> pr " int64_t %s;\n" name
3022 | name, `OptPercent ->
3023 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3024 pr " float %s;\n" name
3027 pr " struct guestfs_lvm_%s_list {\n" typ;
3028 pr " uint32_t len; /* Number of elements in list. */\n";
3029 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
3032 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
3035 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3037 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3038 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3040 * We have to use an underscore instead of a dash because otherwise
3041 * rpcgen generates incorrect code.
3043 * This header is NOT exported to clients, but see also generate_structs_h.
3045 and generate_xdr () =
3046 generate_header CStyle LGPLv2;
3048 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3049 pr "typedef string str<>;\n";
3052 (* LVM internal structures. *)
3056 pr "struct guestfs_lvm_int_%s {\n" typ;
3058 | name, `String -> pr " string %s<>;\n" name
3059 | name, `UUID -> pr " opaque %s[32];\n" name
3060 | name, `Bytes -> pr " hyper %s;\n" name
3061 | name, `Int -> pr " hyper %s;\n" name
3062 | name, `OptPercent -> pr " float %s;\n" name
3066 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
3068 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3070 (* Stat internal structures. *)
3074 pr "struct guestfs_int_%s {\n" typ;
3076 | name, `Int -> pr " hyper %s;\n" name
3080 ) ["stat", stat_cols; "statvfs", statvfs_cols];
3083 fun (shortname, style, _, _, _, _, _) ->
3084 let name = "guestfs_" ^ shortname in
3086 (match snd style with
3089 pr "struct %s_args {\n" name;
3092 | String n -> pr " string %s<>;\n" n
3093 | OptString n -> pr " str *%s;\n" n
3094 | StringList n -> pr " str %s<>;\n" n
3095 | Bool n -> pr " bool %s;\n" n
3096 | Int n -> pr " int %s;\n" n
3097 | FileIn _ | FileOut _ -> ()
3101 (match fst style with
3104 pr "struct %s_ret {\n" name;
3108 pr "struct %s_ret {\n" name;
3109 pr " hyper %s;\n" n;
3112 pr "struct %s_ret {\n" name;
3116 failwithf "RConstString cannot be returned from a daemon function"
3118 pr "struct %s_ret {\n" name;
3119 pr " string %s<>;\n" n;
3122 pr "struct %s_ret {\n" name;
3123 pr " str %s<>;\n" n;
3126 pr "struct %s_ret {\n" name;
3131 pr "struct %s_ret {\n" name;
3132 pr " guestfs_lvm_int_pv_list %s;\n" n;
3135 pr "struct %s_ret {\n" name;
3136 pr " guestfs_lvm_int_vg_list %s;\n" n;
3139 pr "struct %s_ret {\n" name;
3140 pr " guestfs_lvm_int_lv_list %s;\n" n;
3143 pr "struct %s_ret {\n" name;
3144 pr " guestfs_int_stat %s;\n" n;
3147 pr "struct %s_ret {\n" name;
3148 pr " guestfs_int_statvfs %s;\n" n;
3151 pr "struct %s_ret {\n" name;
3152 pr " str %s<>;\n" n;
3157 (* Table of procedure numbers. *)
3158 pr "enum guestfs_procedure {\n";
3160 fun (shortname, _, proc_nr, _, _, _, _) ->
3161 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3163 pr " GUESTFS_PROC_NR_PROCS\n";
3167 (* Having to choose a maximum message size is annoying for several
3168 * reasons (it limits what we can do in the API), but it (a) makes
3169 * the protocol a lot simpler, and (b) provides a bound on the size
3170 * of the daemon which operates in limited memory space. For large
3171 * file transfers you should use FTP.
3173 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3176 (* Message header, etc. *)
3178 /* The communication protocol is now documented in the guestfs(3)
3182 const GUESTFS_PROGRAM = 0x2000F5F5;
3183 const GUESTFS_PROTOCOL_VERSION = 1;
3185 /* These constants must be larger than any possible message length. */
3186 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3187 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3189 enum guestfs_message_direction {
3190 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3191 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3194 enum guestfs_message_status {
3195 GUESTFS_STATUS_OK = 0,
3196 GUESTFS_STATUS_ERROR = 1
3199 const GUESTFS_ERROR_LEN = 256;
3201 struct guestfs_message_error {
3202 string error_message<GUESTFS_ERROR_LEN>;
3205 struct guestfs_message_header {
3206 unsigned prog; /* GUESTFS_PROGRAM */
3207 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3208 guestfs_procedure proc; /* GUESTFS_PROC_x */
3209 guestfs_message_direction direction;
3210 unsigned serial; /* message serial number */
3211 guestfs_message_status status;
3214 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3216 struct guestfs_chunk {
3217 int cancel; /* if non-zero, transfer is cancelled */
3218 /* data size is 0 bytes if the transfer has finished successfully */
3219 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3223 (* Generate the guestfs-structs.h file. *)
3224 and generate_structs_h () =
3225 generate_header CStyle LGPLv2;
3227 (* This is a public exported header file containing various
3228 * structures. The structures are carefully written to have
3229 * exactly the same in-memory format as the XDR structures that
3230 * we use on the wire to the daemon. The reason for creating
3231 * copies of these structures here is just so we don't have to
3232 * export the whole of guestfs_protocol.h (which includes much
3233 * unrelated and XDR-dependent stuff that we don't want to be
3234 * public, or required by clients).
3236 * To reiterate, we will pass these structures to and from the
3237 * client with a simple assignment or memcpy, so the format
3238 * must be identical to what rpcgen / the RFC defines.
3241 (* guestfs_int_bool structure. *)
3242 pr "struct guestfs_int_bool {\n";
3248 (* LVM public structures. *)
3252 pr "struct guestfs_lvm_%s {\n" typ;
3255 | name, `String -> pr " char *%s;\n" name
3256 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3257 | name, `Bytes -> pr " uint64_t %s;\n" name
3258 | name, `Int -> pr " int64_t %s;\n" name
3259 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3263 pr "struct guestfs_lvm_%s_list {\n" typ;
3264 pr " uint32_t len;\n";
3265 pr " struct guestfs_lvm_%s *val;\n" typ;
3268 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3270 (* Stat structures. *)
3274 pr "struct guestfs_%s {\n" typ;
3277 | name, `Int -> pr " int64_t %s;\n" name
3281 ) ["stat", stat_cols; "statvfs", statvfs_cols]
3283 (* Generate the guestfs-actions.h file. *)
3284 and generate_actions_h () =
3285 generate_header CStyle LGPLv2;
3287 fun (shortname, style, _, _, _, _, _) ->
3288 let name = "guestfs_" ^ shortname in
3289 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3293 (* Generate the client-side dispatch stubs. *)
3294 and generate_client_actions () =
3295 generate_header CStyle LGPLv2;
3301 #include \"guestfs.h\"
3302 #include \"guestfs_protocol.h\"
3304 #define error guestfs_error
3305 #define perrorf guestfs_perrorf
3306 #define safe_malloc guestfs_safe_malloc
3307 #define safe_realloc guestfs_safe_realloc
3308 #define safe_strdup guestfs_safe_strdup
3309 #define safe_memdup guestfs_safe_memdup
3311 /* Check the return message from a call for validity. */
3313 check_reply_header (guestfs_h *g,
3314 const struct guestfs_message_header *hdr,
3315 int proc_nr, int serial)
3317 if (hdr->prog != GUESTFS_PROGRAM) {
3318 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3321 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3322 error (g, \"wrong protocol version (%%d/%%d)\",
3323 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3326 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3327 error (g, \"unexpected message direction (%%d/%%d)\",
3328 hdr->direction, GUESTFS_DIRECTION_REPLY);
3331 if (hdr->proc != proc_nr) {
3332 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3335 if (hdr->serial != serial) {
3336 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3343 /* Check we are in the right state to run a high-level action. */
3345 check_state (guestfs_h *g, const char *caller)
3347 if (!guestfs_is_ready (g)) {
3348 if (guestfs_is_config (g))
3349 error (g, \"%%s: call launch() before using this function\",
3351 else if (guestfs_is_launching (g))
3352 error (g, \"%%s: call wait_ready() before using this function\",
3355 error (g, \"%%s called from the wrong state, %%d != READY\",
3356 caller, guestfs_get_state (g));
3364 (* Client-side stubs for each function. *)
3366 fun (shortname, style, _, _, _, _, _) ->
3367 let name = "guestfs_" ^ shortname in
3369 (* Generate the context struct which stores the high-level
3370 * state between callback functions.
3372 pr "struct %s_ctx {\n" shortname;
3373 pr " /* This flag is set by the callbacks, so we know we've done\n";
3374 pr " * the callbacks as expected, and in the right sequence.\n";
3375 pr " * 0 = not called, 1 = reply_cb called.\n";
3377 pr " int cb_sequence;\n";
3378 pr " struct guestfs_message_header hdr;\n";
3379 pr " struct guestfs_message_error err;\n";
3380 (match fst style with
3383 failwithf "RConstString cannot be returned from a daemon function"
3385 | RBool _ | RString _ | RStringList _
3387 | RPVList _ | RVGList _ | RLVList _
3388 | RStat _ | RStatVFS _
3390 pr " struct %s_ret ret;\n" name
3395 (* Generate the reply callback function. *)
3396 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3398 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3399 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3401 pr " /* This should definitely not happen. */\n";
3402 pr " if (ctx->cb_sequence != 0) {\n";
3403 pr " ctx->cb_sequence = 9999;\n";
3404 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3408 pr " ml->main_loop_quit (ml, g);\n";
3410 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3411 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3414 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3415 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3416 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3423 (match fst style with
3426 failwithf "RConstString cannot be returned from a daemon function"
3428 | RBool _ | RString _ | RStringList _
3430 | RPVList _ | RVGList _ | RLVList _
3431 | RStat _ | RStatVFS _
3433 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3434 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3440 pr " ctx->cb_sequence = 1;\n";
3443 (* Generate the action stub. *)
3444 generate_prototype ~extern:false ~semicolon:false ~newline:true
3445 ~handle:"g" name style;
3448 match fst style with
3449 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3451 failwithf "RConstString cannot be returned from a daemon function"
3452 | RString _ | RStringList _ | RIntBool _
3453 | RPVList _ | RVGList _ | RLVList _
3454 | RStat _ | RStatVFS _
3460 (match snd style with
3462 | _ -> pr " struct %s_args args;\n" name
3465 pr " struct %s_ctx ctx;\n" shortname;
3466 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3467 pr " int serial;\n";
3469 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3470 pr " guestfs_set_busy (g);\n";
3472 pr " memset (&ctx, 0, sizeof ctx);\n";
3475 (* Send the main header and arguments. *)
3476 (match snd style with
3478 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3479 (String.uppercase shortname)
3484 pr " args.%s = (char *) %s;\n" n n
3486 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3488 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3489 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3491 pr " args.%s = %s;\n" n n
3493 pr " args.%s = %s;\n" n n
3494 | FileIn _ | FileOut _ -> ()
3496 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3497 (String.uppercase shortname);
3498 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3501 pr " if (serial == -1) {\n";
3502 pr " guestfs_end_busy (g);\n";
3503 pr " return %s;\n" error_code;
3507 (* Send any additional files (FileIn) requested. *)
3508 let need_read_reply_label = ref false in
3515 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3516 pr " if (r == -1) {\n";
3517 pr " guestfs_end_busy (g);\n";
3518 pr " return %s;\n" error_code;
3520 pr " if (r == -2) /* daemon cancelled */\n";
3521 pr " goto read_reply;\n";
3522 need_read_reply_label := true;
3528 (* Wait for the reply from the remote end. *)
3529 if !need_read_reply_label then pr " read_reply:\n";
3530 pr " guestfs__switch_to_receiving (g);\n";
3531 pr " ctx.cb_sequence = 0;\n";
3532 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3533 pr " (void) ml->main_loop_run (ml, g);\n";
3534 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3535 pr " if (ctx.cb_sequence != 1) {\n";
3536 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3537 pr " guestfs_end_busy (g);\n";
3538 pr " return %s;\n" error_code;
3542 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3543 (String.uppercase shortname);
3544 pr " guestfs_end_busy (g);\n";
3545 pr " return %s;\n" error_code;
3549 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3550 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3551 pr " free (ctx.err.error_message);\n";
3552 pr " guestfs_end_busy (g);\n";
3553 pr " return %s;\n" error_code;
3557 (* Expecting to receive further files (FileOut)? *)
3561 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3562 pr " guestfs_end_busy (g);\n";
3563 pr " return %s;\n" error_code;
3569 pr " guestfs_end_busy (g);\n";
3571 (match fst style with
3572 | RErr -> pr " return 0;\n"
3573 | RInt n | RInt64 n | RBool n ->
3574 pr " return ctx.ret.%s;\n" n
3576 failwithf "RConstString cannot be returned from a daemon function"
3578 pr " return ctx.ret.%s; /* caller will free */\n" n
3579 | RStringList n | RHashtable n ->
3580 pr " /* caller will free this, but we need to add a NULL entry */\n";
3581 pr " ctx.ret.%s.%s_val =\n" n n;
3582 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3583 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3585 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3586 pr " return ctx.ret.%s.%s_val;\n" n n
3588 pr " /* caller with free this */\n";
3589 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3590 | RPVList n | RVGList n | RLVList n
3591 | RStat n | RStatVFS n ->
3592 pr " /* caller will free this */\n";
3593 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3599 (* Generate daemon/actions.h. *)
3600 and generate_daemon_actions_h () =
3601 generate_header CStyle GPLv2;
3603 pr "#include \"../src/guestfs_protocol.h\"\n";
3607 fun (name, style, _, _, _, _, _) ->
3609 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3613 (* Generate the server-side stubs. *)
3614 and generate_daemon_actions () =
3615 generate_header CStyle GPLv2;
3617 pr "#include <config.h>\n";
3619 pr "#include <stdio.h>\n";
3620 pr "#include <stdlib.h>\n";
3621 pr "#include <string.h>\n";
3622 pr "#include <inttypes.h>\n";
3623 pr "#include <ctype.h>\n";
3624 pr "#include <rpc/types.h>\n";
3625 pr "#include <rpc/xdr.h>\n";
3627 pr "#include \"daemon.h\"\n";
3628 pr "#include \"../src/guestfs_protocol.h\"\n";
3629 pr "#include \"actions.h\"\n";
3633 fun (name, style, _, _, _, _, _) ->
3634 (* Generate server-side stubs. *)
3635 pr "static void %s_stub (XDR *xdr_in)\n" name;
3638 match fst style with
3639 | RErr | RInt _ -> pr " int r;\n"; "-1"
3640 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3641 | RBool _ -> pr " int r;\n"; "-1"
3643 failwithf "RConstString cannot be returned from a daemon function"
3644 | RString _ -> pr " char *r;\n"; "NULL"
3645 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
3646 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
3647 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
3648 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
3649 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
3650 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
3651 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
3653 (match snd style with
3656 pr " struct guestfs_%s_args args;\n" name;
3659 (* Note we allow the string to be writable, in order to
3660 * allow device name translation. This is safe because
3661 * we can modify the string (passed from RPC).
3664 | OptString n -> pr " char *%s;\n" n
3665 | StringList n -> pr " char **%s;\n" n
3666 | Bool n -> pr " int %s;\n" n
3667 | Int n -> pr " int %s;\n" n
3668 | FileIn _ | FileOut _ -> ()
3673 (match snd style with
3676 pr " memset (&args, 0, sizeof args);\n";
3678 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3679 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3684 | String n -> pr " %s = args.%s;\n" n n
3685 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3687 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3688 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3689 pr " if (%s == NULL) {\n" n;
3690 pr " reply_with_perror (\"realloc\");\n";
3693 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3694 pr " args.%s.%s_val = %s;\n" n n n;
3695 | Bool n -> pr " %s = args.%s;\n" n n
3696 | Int n -> pr " %s = args.%s;\n" n n
3697 | FileIn _ | FileOut _ -> ()
3702 (* Don't want to call the impl with any FileIn or FileOut
3703 * parameters, since these go "outside" the RPC protocol.
3706 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3708 pr " r = do_%s " name;
3709 generate_call_args argsnofile;
3712 pr " if (r == %s)\n" error_code;
3713 pr " /* do_%s has already called reply_with_error */\n" name;
3717 (* If there are any FileOut parameters, then the impl must
3718 * send its own reply.
3721 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3723 pr " /* do_%s has already sent a reply */\n" name
3725 match fst style with
3726 | RErr -> pr " reply (NULL, NULL);\n"
3727 | RInt n | RInt64 n | RBool n ->
3728 pr " struct guestfs_%s_ret ret;\n" name;
3729 pr " ret.%s = r;\n" n;
3730 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3733 failwithf "RConstString cannot be returned from a daemon function"
3735 pr " struct guestfs_%s_ret ret;\n" name;
3736 pr " ret.%s = r;\n" n;
3737 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3740 | RStringList n | RHashtable n ->
3741 pr " struct guestfs_%s_ret ret;\n" name;
3742 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3743 pr " ret.%s.%s_val = r;\n" n n;
3744 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3746 pr " free_strings (r);\n"
3748 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3750 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3751 | RPVList n | RVGList n | RLVList n
3752 | RStat n | RStatVFS n ->
3753 pr " struct guestfs_%s_ret ret;\n" name;
3754 pr " ret.%s = *r;\n" n;
3755 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3757 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3761 (* Free the args. *)
3762 (match snd style with
3767 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3774 (* Dispatch function. *)
3775 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3777 pr " switch (proc_nr) {\n";
3780 fun (name, style, _, _, _, _, _) ->
3781 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3782 pr " %s_stub (xdr_in);\n" name;
3787 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d, set LIBGUESTFS_PATH to point to the matching libguestfs appliance directory\", proc_nr);\n";
3792 (* LVM columns and tokenization functions. *)
3793 (* XXX This generates crap code. We should rethink how we
3799 pr "static const char *lvm_%s_cols = \"%s\";\n"
3800 typ (String.concat "," (List.map fst cols));
3803 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3805 pr " char *tok, *p, *next;\n";
3809 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3812 pr " if (!str) {\n";
3813 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3816 pr " if (!*str || isspace (*str)) {\n";
3817 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3822 fun (name, coltype) ->
3823 pr " if (!tok) {\n";
3824 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3827 pr " p = strchrnul (tok, ',');\n";
3828 pr " if (*p) next = p+1; else next = NULL;\n";
3829 pr " *p = '\\0';\n";
3832 pr " r->%s = strdup (tok);\n" name;
3833 pr " if (r->%s == NULL) {\n" name;
3834 pr " perror (\"strdup\");\n";
3838 pr " for (i = j = 0; i < 32; ++j) {\n";
3839 pr " if (tok[j] == '\\0') {\n";
3840 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3842 pr " } else if (tok[j] != '-')\n";
3843 pr " r->%s[i++] = tok[j];\n" name;
3846 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3847 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3851 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3852 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3856 pr " if (tok[0] == '\\0')\n";
3857 pr " r->%s = -1;\n" name;
3858 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3859 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3863 pr " tok = next;\n";
3866 pr " if (tok != NULL) {\n";
3867 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3874 pr "guestfs_lvm_int_%s_list *\n" typ;
3875 pr "parse_command_line_%ss (void)\n" typ;
3877 pr " char *out, *err;\n";
3878 pr " char *p, *pend;\n";
3880 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3881 pr " void *newp;\n";
3883 pr " ret = malloc (sizeof *ret);\n";
3884 pr " if (!ret) {\n";
3885 pr " reply_with_perror (\"malloc\");\n";
3886 pr " return NULL;\n";
3889 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3890 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3892 pr " r = command (&out, &err,\n";
3893 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3894 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3895 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3896 pr " if (r == -1) {\n";
3897 pr " reply_with_error (\"%%s\", err);\n";
3898 pr " free (out);\n";
3899 pr " free (err);\n";
3900 pr " free (ret);\n";
3901 pr " return NULL;\n";
3904 pr " free (err);\n";
3906 pr " /* Tokenize each line of the output. */\n";
3909 pr " while (p) {\n";
3910 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3911 pr " if (pend) {\n";
3912 pr " *pend = '\\0';\n";
3916 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3919 pr " if (!*p) { /* Empty line? Skip it. */\n";
3924 pr " /* Allocate some space to store this next entry. */\n";
3925 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3926 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3927 pr " if (newp == NULL) {\n";
3928 pr " reply_with_perror (\"realloc\");\n";
3929 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3930 pr " free (ret);\n";
3931 pr " free (out);\n";
3932 pr " return NULL;\n";
3934 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3936 pr " /* Tokenize the next entry. */\n";
3937 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3938 pr " if (r == -1) {\n";
3939 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3940 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3941 pr " free (ret);\n";
3942 pr " free (out);\n";
3943 pr " return NULL;\n";
3950 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3952 pr " free (out);\n";
3953 pr " return ret;\n";
3956 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3958 (* Generate the tests. *)
3959 and generate_tests () =
3960 generate_header CStyle GPLv2;
3967 #include <sys/types.h>
3970 #include \"guestfs.h\"
3972 static guestfs_h *g;
3973 static int suppress_error = 0;
3975 static void print_error (guestfs_h *g, void *data, const char *msg)
3977 if (!suppress_error)
3978 fprintf (stderr, \"%%s\\n\", msg);
3981 static void print_strings (char * const * const argv)
3985 for (argc = 0; argv[argc] != NULL; ++argc)
3986 printf (\"\\t%%s\\n\", argv[argc]);
3990 static void print_table (char * const * const argv)
3994 for (i = 0; argv[i] != NULL; i += 2)
3995 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3999 static void no_test_warnings (void)
4005 | name, _, _, _, [], _, _ ->
4006 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4007 | name, _, _, _, tests, _, _ -> ()
4013 (* Generate the actual tests. Note that we generate the tests
4014 * in reverse order, deliberately, so that (in general) the
4015 * newest tests run first. This makes it quicker and easier to
4020 fun (name, _, _, _, tests, _, _) ->
4021 mapi (generate_one_test name) tests
4022 ) (List.rev all_functions) in
4023 let test_names = List.concat test_names in
4024 let nr_tests = List.length test_names in
4027 int main (int argc, char *argv[])
4031 const char *filename;
4033 int nr_tests, test_num = 0;
4035 no_test_warnings ();
4037 g = guestfs_create ();
4039 printf (\"guestfs_create FAILED\\n\");
4043 guestfs_set_error_handler (g, print_error, NULL);
4045 guestfs_set_path (g, \"../appliance\");
4047 filename = \"test1.img\";
4048 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4053 if (lseek (fd, %d, SEEK_SET) == -1) {
4059 if (write (fd, &c, 1) == -1) {
4065 if (close (fd) == -1) {
4070 if (guestfs_add_drive (g, filename) == -1) {
4071 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4075 filename = \"test2.img\";
4076 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4081 if (lseek (fd, %d, SEEK_SET) == -1) {
4087 if (write (fd, &c, 1) == -1) {
4093 if (close (fd) == -1) {
4098 if (guestfs_add_drive (g, filename) == -1) {
4099 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4103 filename = \"test3.img\";
4104 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4109 if (lseek (fd, %d, SEEK_SET) == -1) {
4115 if (write (fd, &c, 1) == -1) {
4121 if (close (fd) == -1) {
4126 if (guestfs_add_drive (g, filename) == -1) {
4127 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4131 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4132 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4136 if (guestfs_launch (g) == -1) {
4137 printf (\"guestfs_launch FAILED\\n\");
4141 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4144 if (guestfs_wait_ready (g) == -1) {
4145 printf (\"guestfs_wait_ready FAILED\\n\");
4149 /* Cancel previous alarm. */
4154 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4158 pr " test_num++;\n";
4159 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4160 pr " if (%s () == -1) {\n" test_name;
4161 pr " printf (\"%s FAILED\\n\");\n" test_name;
4167 pr " guestfs_close (g);\n";
4168 pr " unlink (\"test1.img\");\n";
4169 pr " unlink (\"test2.img\");\n";
4170 pr " unlink (\"test3.img\");\n";
4173 pr " if (failed > 0) {\n";
4174 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4182 and generate_one_test name i (init, prereq, test) =
4183 let test_name = sprintf "test_%s_%d" name i in
4186 static int %s_skip (void)
4190 str = getenv (\"TEST_ONLY\");
4192 return strstr (str, \"%s\") == NULL;
4193 str = getenv (\"SKIP_%s\");
4194 if (str && strcmp (str, \"1\") == 0) return 1;
4195 str = getenv (\"SKIP_TEST_%s\");
4196 if (str && strcmp (str, \"1\") == 0) return 1;
4200 " test_name name (String.uppercase test_name) (String.uppercase name);
4203 | Disabled | Always -> ()
4204 | If code | Unless code ->
4205 pr "static int %s_prereq (void)\n" test_name;
4213 static int %s (void)
4216 printf (\"%%s skipped (reason: environment variable set)\\n\", \"%s\");
4220 " test_name test_name test_name;
4224 pr " printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4226 pr " if (! %s_prereq ()) {\n" test_name;
4227 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4231 generate_one_test_body name i test_name init test;
4233 pr " if (%s_prereq ()) {\n" test_name;
4234 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4238 generate_one_test_body name i test_name init test;
4240 generate_one_test_body name i test_name init test
4248 and generate_one_test_body name i test_name init test =
4252 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4253 List.iter (generate_test_command_call test_name)
4254 [["blockdev_setrw"; "/dev/sda"];
4258 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4259 List.iter (generate_test_command_call test_name)
4260 [["blockdev_setrw"; "/dev/sda"];
4263 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4264 ["mkfs"; "ext2"; "/dev/sda1"];
4265 ["mount"; "/dev/sda1"; "/"]]
4266 | InitBasicFSonLVM ->
4267 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4269 List.iter (generate_test_command_call test_name)
4270 [["blockdev_setrw"; "/dev/sda"];
4273 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4274 ["pvcreate"; "/dev/sda1"];
4275 ["vgcreate"; "VG"; "/dev/sda1"];
4276 ["lvcreate"; "LV"; "VG"; "8"];
4277 ["mkfs"; "ext2"; "/dev/VG/LV"];
4278 ["mount"; "/dev/VG/LV"; "/"]]
4281 let get_seq_last = function
4283 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4286 let seq = List.rev seq in
4287 List.rev (List.tl seq), List.hd seq
4292 pr " /* TestRun for %s (%d) */\n" name i;
4293 List.iter (generate_test_command_call test_name) seq
4294 | TestOutput (seq, expected) ->
4295 pr " /* TestOutput for %s (%d) */\n" name i;
4296 pr " char expected[] = \"%s\";\n" (c_quote expected);
4297 let seq, last = get_seq_last seq in
4299 pr " if (strcmp (r, expected) != 0) {\n";
4300 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4304 List.iter (generate_test_command_call test_name) seq;
4305 generate_test_command_call ~test test_name last
4306 | TestOutputList (seq, expected) ->
4307 pr " /* TestOutputList for %s (%d) */\n" name i;
4308 let seq, last = get_seq_last seq in
4312 pr " if (!r[%d]) {\n" i;
4313 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4314 pr " print_strings (r);\n";
4318 pr " char expected[] = \"%s\";\n" (c_quote str);
4319 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4320 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4325 pr " if (r[%d] != NULL) {\n" (List.length expected);
4326 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4328 pr " print_strings (r);\n";
4332 List.iter (generate_test_command_call test_name) seq;
4333 generate_test_command_call ~test test_name last
4334 | TestOutputListOfDevices (seq, expected) ->
4335 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
4336 let seq, last = get_seq_last seq in
4340 pr " if (!r[%d]) {\n" i;
4341 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4342 pr " print_strings (r);\n";
4346 pr " char expected[] = \"%s\";\n" (c_quote str);
4347 pr " r[%d][5] = 's';\n" i;
4348 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4349 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4354 pr " if (r[%d] != NULL) {\n" (List.length expected);
4355 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4357 pr " print_strings (r);\n";
4361 List.iter (generate_test_command_call test_name) seq;
4362 generate_test_command_call ~test test_name last
4363 | TestOutputInt (seq, expected) ->
4364 pr " /* TestOutputInt for %s (%d) */\n" name i;
4365 let seq, last = get_seq_last seq in
4367 pr " if (r != %d) {\n" expected;
4368 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4374 List.iter (generate_test_command_call test_name) seq;
4375 generate_test_command_call ~test test_name last
4376 | TestOutputTrue seq ->
4377 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4378 let seq, last = get_seq_last seq in
4381 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4386 List.iter (generate_test_command_call test_name) seq;
4387 generate_test_command_call ~test test_name last
4388 | TestOutputFalse seq ->
4389 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4390 let seq, last = get_seq_last seq in
4393 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4398 List.iter (generate_test_command_call test_name) seq;
4399 generate_test_command_call ~test test_name last
4400 | TestOutputLength (seq, expected) ->
4401 pr " /* TestOutputLength for %s (%d) */\n" name i;
4402 let seq, last = get_seq_last seq in
4405 pr " for (j = 0; j < %d; ++j)\n" expected;
4406 pr " if (r[j] == NULL) {\n";
4407 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4409 pr " print_strings (r);\n";
4412 pr " if (r[j] != NULL) {\n";
4413 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4415 pr " print_strings (r);\n";
4419 List.iter (generate_test_command_call test_name) seq;
4420 generate_test_command_call ~test test_name last
4421 | TestOutputStruct (seq, checks) ->
4422 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4423 let seq, last = get_seq_last seq in
4427 | CompareWithInt (field, expected) ->
4428 pr " if (r->%s != %d) {\n" field expected;
4429 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4430 test_name field expected;
4431 pr " (int) r->%s);\n" field;
4434 | CompareWithString (field, expected) ->
4435 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4436 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4437 test_name field expected;
4438 pr " r->%s);\n" field;
4441 | CompareFieldsIntEq (field1, field2) ->
4442 pr " if (r->%s != r->%s) {\n" field1 field2;
4443 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4444 test_name field1 field2;
4445 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
4448 | CompareFieldsStrEq (field1, field2) ->
4449 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4450 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4451 test_name field1 field2;
4452 pr " r->%s, r->%s);\n" field1 field2;
4457 List.iter (generate_test_command_call test_name) seq;
4458 generate_test_command_call ~test test_name last
4459 | TestLastFail seq ->
4460 pr " /* TestLastFail for %s (%d) */\n" name i;
4461 let seq, last = get_seq_last seq in
4462 List.iter (generate_test_command_call test_name) seq;
4463 generate_test_command_call test_name ~expect_error:true last
4465 (* Generate the code to run a command, leaving the result in 'r'.
4466 * If you expect to get an error then you should set expect_error:true.
4468 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4470 | [] -> assert false
4472 (* Look up the command to find out what args/ret it has. *)
4475 let _, style, _, _, _, _, _ =
4476 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4479 failwithf "%s: in test, command %s was not found" test_name name in
4481 if List.length (snd style) <> List.length args then
4482 failwithf "%s: in test, wrong number of args given to %s"
4489 | OptString n, "NULL" -> ()
4491 | OptString n, arg ->
4492 pr " char %s[] = \"%s\";\n" n (c_quote arg);
4495 | FileIn _, _ | FileOut _, _ -> ()
4496 | StringList n, arg ->
4497 let strs = string_split " " arg in
4500 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
4502 pr " char *%s[] = {\n" n;
4504 fun i _ -> pr " %s_%d,\n" n i
4508 ) (List.combine (snd style) args);
4511 match fst style with
4512 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
4513 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4514 | RConstString _ -> pr " const char *r;\n"; "NULL"
4515 | RString _ -> pr " char *r;\n"; "NULL"
4516 | RStringList _ | RHashtable _ ->
4521 pr " struct guestfs_int_bool *r;\n"; "NULL"
4523 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4525 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4527 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4529 pr " struct guestfs_stat *r;\n"; "NULL"
4531 pr " struct guestfs_statvfs *r;\n"; "NULL" in
4533 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4534 pr " r = guestfs_%s (g" name;
4536 (* Generate the parameters. *)
4539 | OptString _, "NULL" -> pr ", NULL"
4543 | FileIn _, arg | FileOut _, arg ->
4544 pr ", \"%s\"" (c_quote arg)
4545 | StringList n, _ ->
4549 try int_of_string arg
4550 with Failure "int_of_string" ->
4551 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4554 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4555 ) (List.combine (snd style) args);
4558 if not expect_error then
4559 pr " if (r == %s)\n" error_code
4561 pr " if (r != %s)\n" error_code;
4564 (* Insert the test code. *)
4570 (match fst style with
4571 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4572 | RString _ -> pr " free (r);\n"
4573 | RStringList _ | RHashtable _ ->
4574 pr " for (i = 0; r[i] != NULL; ++i)\n";
4575 pr " free (r[i]);\n";
4578 pr " guestfs_free_int_bool (r);\n"
4580 pr " guestfs_free_lvm_pv_list (r);\n"
4582 pr " guestfs_free_lvm_vg_list (r);\n"
4584 pr " guestfs_free_lvm_lv_list (r);\n"
4585 | RStat _ | RStatVFS _ ->
4592 let str = replace_str str "\r" "\\r" in
4593 let str = replace_str str "\n" "\\n" in
4594 let str = replace_str str "\t" "\\t" in
4595 let str = replace_str str "\000" "\\0" in
4598 (* Generate a lot of different functions for guestfish. *)
4599 and generate_fish_cmds () =
4600 generate_header CStyle GPLv2;
4604 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4606 let all_functions_sorted =
4608 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4609 ) all_functions_sorted in
4611 pr "#include <stdio.h>\n";
4612 pr "#include <stdlib.h>\n";
4613 pr "#include <string.h>\n";
4614 pr "#include <inttypes.h>\n";
4616 pr "#include <guestfs.h>\n";
4617 pr "#include \"fish.h\"\n";
4620 (* list_commands function, which implements guestfish -h *)
4621 pr "void list_commands (void)\n";
4623 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
4624 pr " list_builtin_commands ();\n";
4626 fun (name, _, _, flags, _, shortdesc, _) ->
4627 let name = replace_char name '_' '-' in
4628 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4630 ) all_functions_sorted;
4631 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4635 (* display_command function, which implements guestfish -h cmd *)
4636 pr "void display_command (const char *cmd)\n";
4639 fun (name, style, _, flags, _, shortdesc, longdesc) ->
4640 let name2 = replace_char name '_' '-' in
4642 try find_map (function FishAlias n -> Some n | _ -> None) flags
4643 with Not_found -> name in
4644 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4646 match snd style with
4650 name2 (String.concat "> <" (List.map name_of_argt args)) in
4653 if List.mem ProtocolLimitWarning flags then
4654 ("\n\n" ^ protocol_limit_warning)
4657 (* For DangerWillRobinson commands, we should probably have
4658 * guestfish prompt before allowing you to use them (especially
4659 * in interactive mode). XXX
4663 if List.mem DangerWillRobinson flags then
4664 ("\n\n" ^ danger_will_robinson)
4667 let describe_alias =
4668 if name <> alias then
4669 sprintf "\n\nYou can use '%s' as an alias for this command." alias
4673 pr "strcasecmp (cmd, \"%s\") == 0" name;
4674 if name <> name2 then
4675 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4676 if name <> alias then
4677 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4679 pr " pod2text (\"%s - %s\", %S);\n"
4681 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4684 pr " display_builtin_command (cmd);\n";
4688 (* print_{pv,vg,lv}_list functions *)
4692 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4699 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4701 pr " printf (\"%s: \");\n" name;
4702 pr " for (i = 0; i < 32; ++i)\n";
4703 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
4704 pr " printf (\"\\n\");\n"
4706 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4708 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4709 | name, `OptPercent ->
4710 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4711 typ name name typ name;
4712 pr " else printf (\"%s: \\n\");\n" name
4716 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4721 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4722 pr " print_%s (&%ss->val[i]);\n" typ typ;
4725 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4727 (* print_{stat,statvfs} functions *)
4731 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4736 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4740 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4742 (* run_<action> actions *)
4744 fun (name, style, _, flags, _, _, _) ->
4745 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4747 (match fst style with
4750 | RBool _ -> pr " int r;\n"
4751 | RInt64 _ -> pr " int64_t r;\n"
4752 | RConstString _ -> pr " const char *r;\n"
4753 | RString _ -> pr " char *r;\n"
4754 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4755 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4756 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4757 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4758 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4759 | RStat _ -> pr " struct guestfs_stat *r;\n"
4760 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4767 | FileOut n -> pr " const char *%s;\n" n
4768 | StringList n -> pr " char **%s;\n" n
4769 | Bool n -> pr " int %s;\n" n
4770 | Int n -> pr " int %s;\n" n
4773 (* Check and convert parameters. *)
4774 let argc_expected = List.length (snd style) in
4775 pr " if (argc != %d) {\n" argc_expected;
4776 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4778 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4784 | String name -> pr " %s = argv[%d];\n" name i
4786 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4789 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4792 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4794 | StringList name ->
4795 pr " %s = parse_string_list (argv[%d]);\n" name i
4797 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4799 pr " %s = atoi (argv[%d]);\n" name i
4802 (* Call C API function. *)
4804 try find_map (function FishAction n -> Some n | _ -> None) flags
4805 with Not_found -> sprintf "guestfs_%s" name in
4807 generate_call_args ~handle:"g" (snd style);
4810 (* Check return value for errors and display command results. *)
4811 (match fst style with
4812 | RErr -> pr " return r;\n"
4814 pr " if (r == -1) return -1;\n";
4815 pr " printf (\"%%d\\n\", r);\n";
4818 pr " if (r == -1) return -1;\n";
4819 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4822 pr " if (r == -1) return -1;\n";
4823 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4826 pr " if (r == NULL) return -1;\n";
4827 pr " printf (\"%%s\\n\", r);\n";
4830 pr " if (r == NULL) return -1;\n";
4831 pr " printf (\"%%s\\n\", r);\n";
4835 pr " if (r == NULL) return -1;\n";
4836 pr " print_strings (r);\n";
4837 pr " free_strings (r);\n";
4840 pr " if (r == NULL) return -1;\n";
4841 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4842 pr " r->b ? \"true\" : \"false\");\n";
4843 pr " guestfs_free_int_bool (r);\n";
4846 pr " if (r == NULL) return -1;\n";
4847 pr " print_pv_list (r);\n";
4848 pr " guestfs_free_lvm_pv_list (r);\n";
4851 pr " if (r == NULL) return -1;\n";
4852 pr " print_vg_list (r);\n";
4853 pr " guestfs_free_lvm_vg_list (r);\n";
4856 pr " if (r == NULL) return -1;\n";
4857 pr " print_lv_list (r);\n";
4858 pr " guestfs_free_lvm_lv_list (r);\n";
4861 pr " if (r == NULL) return -1;\n";
4862 pr " print_stat (r);\n";
4866 pr " if (r == NULL) return -1;\n";
4867 pr " print_statvfs (r);\n";
4871 pr " if (r == NULL) return -1;\n";
4872 pr " print_table (r);\n";
4873 pr " free_strings (r);\n";
4880 (* run_action function *)
4881 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4884 fun (name, _, _, flags, _, _, _) ->
4885 let name2 = replace_char name '_' '-' in
4887 try find_map (function FishAlias n -> Some n | _ -> None) flags
4888 with Not_found -> name in
4890 pr "strcasecmp (cmd, \"%s\") == 0" name;
4891 if name <> name2 then
4892 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4893 if name <> alias then
4894 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4896 pr " return run_%s (cmd, argc, argv);\n" name;
4900 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4907 (* Readline completion for guestfish. *)
4908 and generate_fish_completion () =
4909 generate_header CStyle GPLv2;
4913 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4923 #ifdef HAVE_LIBREADLINE
4924 #include <readline/readline.h>
4929 #ifdef HAVE_LIBREADLINE
4931 static const char *const commands[] = {
4932 BUILTIN_COMMANDS_FOR_COMPLETION,
4935 (* Get the commands, including the aliases. They don't need to be
4936 * sorted - the generator() function just does a dumb linear search.
4940 fun (name, _, _, flags, _, _, _) ->
4941 let name2 = replace_char name '_' '-' in
4943 try find_map (function FishAlias n -> Some n | _ -> None) flags
4944 with Not_found -> name in
4946 if name <> alias then [name2; alias] else [name2]
4948 let commands = List.flatten commands in
4950 List.iter (pr " \"%s\",\n") commands;
4956 generator (const char *text, int state)
4958 static int index, len;
4963 len = strlen (text);
4966 rl_attempted_completion_over = 1;
4968 while ((name = commands[index]) != NULL) {
4970 if (strncasecmp (name, text, len) == 0)
4971 return strdup (name);
4977 #endif /* HAVE_LIBREADLINE */
4979 char **do_completion (const char *text, int start, int end)
4981 char **matches = NULL;
4983 #ifdef HAVE_LIBREADLINE
4984 rl_completion_append_character = ' ';
4987 matches = rl_completion_matches (text, generator);
4988 else if (complete_dest_paths)
4989 matches = rl_completion_matches (text, complete_dest_paths_generator);
4996 (* Generate the POD documentation for guestfish. *)
4997 and generate_fish_actions_pod () =
4998 let all_functions_sorted =
5000 fun (_, _, _, flags, _, _, _) ->
5001 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5002 ) all_functions_sorted in
5004 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5007 fun (name, style, _, flags, _, _, longdesc) ->
5009 Str.global_substitute rex (
5012 try Str.matched_group 1 s
5014 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5015 "C<" ^ replace_char sub '_' '-' ^ ">"
5017 let name = replace_char name '_' '-' in
5019 try find_map (function FishAlias n -> Some n | _ -> None) flags
5020 with Not_found -> name in
5022 pr "=head2 %s" name;
5023 if name <> alias then
5030 | String n -> pr " %s" n
5031 | OptString n -> pr " %s" n
5032 | StringList n -> pr " '%s ...'" n
5033 | Bool _ -> pr " true|false"
5034 | Int n -> pr " %s" n
5035 | FileIn n | FileOut n -> pr " (%s|-)" n
5039 pr "%s\n\n" longdesc;
5041 if List.exists (function FileIn _ | FileOut _ -> true
5042 | _ -> false) (snd style) then
5043 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5045 if List.mem ProtocolLimitWarning flags then
5046 pr "%s\n\n" protocol_limit_warning;
5048 if List.mem DangerWillRobinson flags then
5049 pr "%s\n\n" danger_will_robinson
5050 ) all_functions_sorted
5052 (* Generate a C function prototype. *)
5053 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5054 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5056 ?handle name style =
5057 if extern then pr "extern ";
5058 if static then pr "static ";
5059 (match fst style with
5061 | RInt _ -> pr "int "
5062 | RInt64 _ -> pr "int64_t "
5063 | RBool _ -> pr "int "
5064 | RConstString _ -> pr "const char *"
5065 | RString _ -> pr "char *"
5066 | RStringList _ | RHashtable _ -> pr "char **"
5068 if not in_daemon then pr "struct guestfs_int_bool *"
5069 else pr "guestfs_%s_ret *" name
5071 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
5072 else pr "guestfs_lvm_int_pv_list *"
5074 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
5075 else pr "guestfs_lvm_int_vg_list *"
5077 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
5078 else pr "guestfs_lvm_int_lv_list *"
5080 if not in_daemon then pr "struct guestfs_stat *"
5081 else pr "guestfs_int_stat *"
5083 if not in_daemon then pr "struct guestfs_statvfs *"
5084 else pr "guestfs_int_statvfs *"
5086 pr "%s%s (" prefix name;
5087 if handle = None && List.length (snd style) = 0 then
5090 let comma = ref false in
5093 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5097 if single_line then pr ", " else pr ",\n\t\t"
5106 if not in_daemon then pr "const char *%s" n
5107 else pr "char *%s" n
5110 if not in_daemon then pr "char * const* const %s" n
5111 else pr "char **%s" n
5112 | Bool n -> next (); pr "int %s" n
5113 | Int n -> next (); pr "int %s" n
5116 if not in_daemon then (next (); pr "const char *%s" n)
5120 if semicolon then pr ";";
5121 if newline then pr "\n"
5123 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5124 and generate_call_args ?handle args =
5126 let comma = ref false in
5129 | Some handle -> pr "%s" handle; comma := true
5133 if !comma then pr ", ";
5135 pr "%s" (name_of_argt arg)
5139 (* Generate the OCaml bindings interface. *)
5140 and generate_ocaml_mli () =
5141 generate_header OCamlStyle LGPLv2;
5144 (** For API documentation you should refer to the C API
5145 in the guestfs(3) manual page. The OCaml API uses almost
5146 exactly the same calls. *)
5149 (** A [guestfs_h] handle. *)
5151 exception Error of string
5152 (** This exception is raised when there is an error. *)
5154 val create : unit -> t
5156 val close : t -> unit
5157 (** Handles are closed by the garbage collector when they become
5158 unreferenced, but callers can also call this in order to
5159 provide predictable cleanup. *)
5162 generate_ocaml_lvm_structure_decls ();
5164 generate_ocaml_stat_structure_decls ();
5168 fun (name, style, _, _, _, shortdesc, _) ->
5169 generate_ocaml_prototype name style;
5170 pr "(** %s *)\n" shortdesc;
5174 (* Generate the OCaml bindings implementation. *)
5175 and generate_ocaml_ml () =
5176 generate_header OCamlStyle LGPLv2;
5180 exception Error of string
5181 external create : unit -> t = \"ocaml_guestfs_create\"
5182 external close : t -> unit = \"ocaml_guestfs_close\"
5185 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5189 generate_ocaml_lvm_structure_decls ();
5191 generate_ocaml_stat_structure_decls ();
5195 fun (name, style, _, _, _, shortdesc, _) ->
5196 generate_ocaml_prototype ~is_external:true name style;
5199 (* Generate the OCaml bindings C implementation. *)
5200 and generate_ocaml_c () =
5201 generate_header CStyle LGPLv2;
5208 #include <caml/config.h>
5209 #include <caml/alloc.h>
5210 #include <caml/callback.h>
5211 #include <caml/fail.h>
5212 #include <caml/memory.h>
5213 #include <caml/mlvalues.h>
5214 #include <caml/signals.h>
5216 #include <guestfs.h>
5218 #include \"guestfs_c.h\"
5220 /* Copy a hashtable of string pairs into an assoc-list. We return
5221 * the list in reverse order, but hashtables aren't supposed to be
5224 static CAMLprim value
5225 copy_table (char * const * argv)
5228 CAMLlocal5 (rv, pairv, kv, vv, cons);
5232 for (i = 0; argv[i] != NULL; i += 2) {
5233 kv = caml_copy_string (argv[i]);
5234 vv = caml_copy_string (argv[i+1]);
5235 pairv = caml_alloc (2, 0);
5236 Store_field (pairv, 0, kv);
5237 Store_field (pairv, 1, vv);
5238 cons = caml_alloc (2, 0);
5239 Store_field (cons, 1, rv);
5241 Store_field (cons, 0, pairv);
5249 (* LVM struct copy functions. *)
5252 let has_optpercent_col =
5253 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
5255 pr "static CAMLprim value\n";
5256 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
5258 pr " CAMLparam0 ();\n";
5259 if has_optpercent_col then
5260 pr " CAMLlocal3 (rv, v, v2);\n"
5262 pr " CAMLlocal2 (rv, v);\n";
5264 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5269 pr " v = caml_copy_string (%s->%s);\n" typ name
5271 pr " v = caml_alloc_string (32);\n";
5272 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5275 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5276 | name, `OptPercent ->
5277 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5278 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5279 pr " v = caml_alloc (1, 0);\n";
5280 pr " Store_field (v, 0, v2);\n";
5281 pr " } else /* None */\n";
5282 pr " v = Val_int (0);\n";
5284 pr " Store_field (rv, %d, v);\n" i
5286 pr " CAMLreturn (rv);\n";
5290 pr "static CAMLprim value\n";
5291 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
5294 pr " CAMLparam0 ();\n";
5295 pr " CAMLlocal2 (rv, v);\n";
5298 pr " if (%ss->len == 0)\n" typ;
5299 pr " CAMLreturn (Atom (0));\n";
5301 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5302 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5303 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
5304 pr " caml_modify (&Field (rv, i), v);\n";
5306 pr " CAMLreturn (rv);\n";
5310 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5312 (* Stat copy functions. *)
5315 pr "static CAMLprim value\n";
5316 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5318 pr " CAMLparam0 ();\n";
5319 pr " CAMLlocal2 (rv, v);\n";
5321 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5326 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5328 pr " Store_field (rv, %d, v);\n" i
5330 pr " CAMLreturn (rv);\n";
5333 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5337 fun (name, style, _, _, _, _, _) ->
5339 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5341 pr "CAMLprim value\n";
5342 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5343 List.iter (pr ", value %s") (List.tl params);
5348 | [p1; p2; p3; p4; p5] ->
5349 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5350 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5351 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5352 pr " CAMLxparam%d (%s);\n"
5353 (List.length rest) (String.concat ", " rest)
5355 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5357 pr " CAMLlocal1 (rv);\n";
5360 pr " guestfs_h *g = Guestfs_val (gv);\n";
5361 pr " if (g == NULL)\n";
5362 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5370 pr " const char *%s = String_val (%sv);\n" n n
5372 pr " const char *%s =\n" n;
5373 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5376 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5378 pr " int %s = Bool_val (%sv);\n" n n
5380 pr " int %s = Int_val (%sv);\n" n n
5383 match fst style with
5384 | RErr -> pr " int r;\n"; "-1"
5385 | RInt _ -> pr " int r;\n"; "-1"
5386 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5387 | RBool _ -> pr " int r;\n"; "-1"
5388 | RConstString _ -> pr " const char *r;\n"; "NULL"
5389 | RString _ -> pr " char *r;\n"; "NULL"
5395 pr " struct guestfs_int_bool *r;\n"; "NULL"
5397 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5399 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5401 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5403 pr " struct guestfs_stat *r;\n"; "NULL"
5405 pr " struct guestfs_statvfs *r;\n"; "NULL"
5412 pr " caml_enter_blocking_section ();\n";
5413 pr " r = guestfs_%s " name;
5414 generate_call_args ~handle:"g" (snd style);
5416 pr " caml_leave_blocking_section ();\n";
5421 pr " ocaml_guestfs_free_strings (%s);\n" n;
5422 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5425 pr " if (r == %s)\n" error_code;
5426 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5429 (match fst style with
5430 | RErr -> pr " rv = Val_unit;\n"
5431 | RInt _ -> pr " rv = Val_int (r);\n"
5433 pr " rv = caml_copy_int64 (r);\n"
5434 | RBool _ -> pr " rv = Val_bool (r);\n"
5435 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5437 pr " rv = caml_copy_string (r);\n";
5440 pr " rv = caml_copy_string_array ((const char **) r);\n";
5441 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5444 pr " rv = caml_alloc (2, 0);\n";
5445 pr " Store_field (rv, 0, Val_int (r->i));\n";
5446 pr " Store_field (rv, 1, Val_bool (r->b));\n";
5447 pr " guestfs_free_int_bool (r);\n";
5449 pr " rv = copy_lvm_pv_list (r);\n";
5450 pr " guestfs_free_lvm_pv_list (r);\n";
5452 pr " rv = copy_lvm_vg_list (r);\n";
5453 pr " guestfs_free_lvm_vg_list (r);\n";
5455 pr " rv = copy_lvm_lv_list (r);\n";
5456 pr " guestfs_free_lvm_lv_list (r);\n";
5458 pr " rv = copy_stat (r);\n";
5461 pr " rv = copy_statvfs (r);\n";
5464 pr " rv = copy_table (r);\n";
5465 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5469 pr " CAMLreturn (rv);\n";
5473 if List.length params > 5 then (
5474 pr "CAMLprim value\n";
5475 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5477 pr " return ocaml_guestfs_%s (argv[0]" name;
5478 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5485 and generate_ocaml_lvm_structure_decls () =
5488 pr "type lvm_%s = {\n" typ;
5491 | name, `String -> pr " %s : string;\n" name
5492 | name, `UUID -> pr " %s : string;\n" name
5493 | name, `Bytes -> pr " %s : int64;\n" name
5494 | name, `Int -> pr " %s : int64;\n" name
5495 | name, `OptPercent -> pr " %s : float option;\n" name
5499 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
5501 and generate_ocaml_stat_structure_decls () =
5504 pr "type %s = {\n" typ;
5507 | name, `Int -> pr " %s : int64;\n" name
5511 ) ["stat", stat_cols; "statvfs", statvfs_cols]
5513 and generate_ocaml_prototype ?(is_external = false) name style =
5514 if is_external then pr "external " else pr "val ";
5515 pr "%s : t -> " name;
5518 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5519 | OptString _ -> pr "string option -> "
5520 | StringList _ -> pr "string array -> "
5521 | Bool _ -> pr "bool -> "
5522 | Int _ -> pr "int -> "
5524 (match fst style with
5525 | RErr -> pr "unit" (* all errors are turned into exceptions *)
5526 | RInt _ -> pr "int"
5527 | RInt64 _ -> pr "int64"
5528 | RBool _ -> pr "bool"
5529 | RConstString _ -> pr "string"
5530 | RString _ -> pr "string"
5531 | RStringList _ -> pr "string array"
5532 | RIntBool _ -> pr "int * bool"
5533 | RPVList _ -> pr "lvm_pv array"
5534 | RVGList _ -> pr "lvm_vg array"
5535 | RLVList _ -> pr "lvm_lv array"
5536 | RStat _ -> pr "stat"
5537 | RStatVFS _ -> pr "statvfs"
5538 | RHashtable _ -> pr "(string * string) list"
5540 if is_external then (
5542 if List.length (snd style) + 1 > 5 then
5543 pr "\"ocaml_guestfs_%s_byte\" " name;
5544 pr "\"ocaml_guestfs_%s\"" name
5548 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5549 and generate_perl_xs () =
5550 generate_header CStyle LGPLv2;
5553 #include \"EXTERN.h\"
5557 #include <guestfs.h>
5560 #define PRId64 \"lld\"
5564 my_newSVll(long long val) {
5565 #ifdef USE_64_BIT_ALL
5566 return newSViv(val);
5570 len = snprintf(buf, 100, \"%%\" PRId64, val);
5571 return newSVpv(buf, len);
5576 #define PRIu64 \"llu\"
5580 my_newSVull(unsigned long long val) {
5581 #ifdef USE_64_BIT_ALL
5582 return newSVuv(val);
5586 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5587 return newSVpv(buf, len);
5591 /* http://www.perlmonks.org/?node_id=680842 */
5593 XS_unpack_charPtrPtr (SV *arg) {
5598 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5599 croak (\"array reference expected\");
5601 av = (AV *)SvRV (arg);
5602 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5604 croak (\"malloc failed\");
5606 for (i = 0; i <= av_len (av); i++) {
5607 SV **elem = av_fetch (av, i, 0);
5609 if (!elem || !*elem)
5610 croak (\"missing element in list\");
5612 ret[i] = SvPV_nolen (*elem);
5620 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5627 RETVAL = guestfs_create ();
5629 croak (\"could not create guestfs handle\");
5630 guestfs_set_error_handler (RETVAL, NULL, NULL);
5643 fun (name, style, _, _, _, _, _) ->
5644 (match fst style with
5645 | RErr -> pr "void\n"
5646 | RInt _ -> pr "SV *\n"
5647 | RInt64 _ -> pr "SV *\n"
5648 | RBool _ -> pr "SV *\n"
5649 | RConstString _ -> pr "SV *\n"
5650 | RString _ -> pr "SV *\n"
5653 | RPVList _ | RVGList _ | RLVList _
5654 | RStat _ | RStatVFS _
5656 pr "void\n" (* all lists returned implictly on the stack *)
5658 (* Call and arguments. *)
5660 generate_call_args ~handle:"g" (snd style);
5662 pr " guestfs_h *g;\n";
5666 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5668 (* http://www.perlmonks.org/?node_id=554277
5669 * Note that the implicit handle argument means we have
5670 * to add 1 to the ST(x) operator.
5672 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5673 | StringList n -> pr " char **%s;\n" n
5674 | Bool n -> pr " int %s;\n" n
5675 | Int n -> pr " int %s;\n" n
5678 let do_cleanups () =
5681 | String _ | OptString _ | Bool _ | Int _
5682 | FileIn _ | FileOut _ -> ()
5683 | StringList n -> pr " free (%s);\n" n
5688 (match fst style with
5693 pr " r = guestfs_%s " name;
5694 generate_call_args ~handle:"g" (snd style);
5697 pr " if (r == -1)\n";
5698 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5704 pr " %s = guestfs_%s " n name;
5705 generate_call_args ~handle:"g" (snd style);
5708 pr " if (%s == -1)\n" n;
5709 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5710 pr " RETVAL = newSViv (%s);\n" n;
5715 pr " int64_t %s;\n" n;
5717 pr " %s = guestfs_%s " n name;
5718 generate_call_args ~handle:"g" (snd style);
5721 pr " if (%s == -1)\n" n;
5722 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5723 pr " RETVAL = my_newSVll (%s);\n" n;
5728 pr " const char *%s;\n" n;
5730 pr " %s = guestfs_%s " n name;
5731 generate_call_args ~handle:"g" (snd style);
5734 pr " if (%s == NULL)\n" n;
5735 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5736 pr " RETVAL = newSVpv (%s, 0);\n" n;
5741 pr " char *%s;\n" n;
5743 pr " %s = guestfs_%s " n name;
5744 generate_call_args ~handle:"g" (snd style);
5747 pr " if (%s == NULL)\n" n;
5748 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5749 pr " RETVAL = newSVpv (%s, 0);\n" n;
5750 pr " free (%s);\n" n;
5753 | RStringList n | RHashtable n ->
5755 pr " char **%s;\n" n;
5758 pr " %s = guestfs_%s " n name;
5759 generate_call_args ~handle:"g" (snd style);
5762 pr " if (%s == NULL)\n" n;
5763 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5764 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5765 pr " EXTEND (SP, n);\n";
5766 pr " for (i = 0; i < n; ++i) {\n";
5767 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5768 pr " free (%s[i]);\n" n;
5770 pr " free (%s);\n" n;
5773 pr " struct guestfs_int_bool *r;\n";
5775 pr " r = guestfs_%s " name;
5776 generate_call_args ~handle:"g" (snd style);
5779 pr " if (r == NULL)\n";
5780 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5781 pr " EXTEND (SP, 2);\n";
5782 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5783 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5784 pr " guestfs_free_int_bool (r);\n";
5786 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5788 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5790 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5792 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5794 generate_perl_stat_code
5795 "statvfs" statvfs_cols name style n do_cleanups
5801 and generate_perl_lvm_code typ cols name style n do_cleanups =
5803 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5807 pr " %s = guestfs_%s " n name;
5808 generate_call_args ~handle:"g" (snd style);
5811 pr " if (%s == NULL)\n" n;
5812 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5813 pr " EXTEND (SP, %s->len);\n" n;
5814 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5815 pr " hv = newHV ();\n";
5819 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5820 name (String.length name) n name
5822 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5823 name (String.length name) n name
5825 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5826 name (String.length name) n name
5828 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5829 name (String.length name) n name
5830 | name, `OptPercent ->
5831 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5832 name (String.length name) n name
5834 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5836 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5838 and generate_perl_stat_code typ cols name style n do_cleanups =
5840 pr " struct guestfs_%s *%s;\n" typ n;
5842 pr " %s = guestfs_%s " n name;
5843 generate_call_args ~handle:"g" (snd style);
5846 pr " if (%s == NULL)\n" n;
5847 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5848 pr " EXTEND (SP, %d);\n" (List.length cols);
5852 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5854 pr " free (%s);\n" n
5856 (* Generate Sys/Guestfs.pm. *)
5857 and generate_perl_pm () =
5858 generate_header HashStyle LGPLv2;
5865 Sys::Guestfs - Perl bindings for libguestfs
5871 my $h = Sys::Guestfs->new ();
5872 $h->add_drive ('guest.img');
5875 $h->mount ('/dev/sda1', '/');
5876 $h->touch ('/hello');
5881 The C<Sys::Guestfs> module provides a Perl XS binding to the
5882 libguestfs API for examining and modifying virtual machine
5885 Amongst the things this is good for: making batch configuration
5886 changes to guests, getting disk used/free statistics (see also:
5887 virt-df), migrating between virtualization systems (see also:
5888 virt-p2v), performing partial backups, performing partial guest
5889 clones, cloning guests and changing registry/UUID/hostname info, and
5892 Libguestfs uses Linux kernel and qemu code, and can access any type of
5893 guest filesystem that Linux and qemu can, including but not limited
5894 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5895 schemes, qcow, qcow2, vmdk.
5897 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5898 LVs, what filesystem is in each LV, etc.). It can also run commands
5899 in the context of the guest. Also you can access filesystems over FTP.
5903 All errors turn into calls to C<croak> (see L<Carp(3)>).
5911 package Sys::Guestfs;
5917 XSLoader::load ('Sys::Guestfs');
5919 =item $h = Sys::Guestfs->new ();
5921 Create a new guestfs handle.
5927 my $class = ref ($proto) || $proto;
5929 my $self = Sys::Guestfs::_create ();
5930 bless $self, $class;
5936 (* Actions. We only need to print documentation for these as
5937 * they are pulled in from the XS code automatically.
5940 fun (name, style, _, flags, _, _, longdesc) ->
5941 if not (List.mem NotInDocs flags) then (
5942 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5944 generate_perl_prototype name style;
5946 pr "%s\n\n" longdesc;
5947 if List.mem ProtocolLimitWarning flags then
5948 pr "%s\n\n" protocol_limit_warning;
5949 if List.mem DangerWillRobinson flags then
5950 pr "%s\n\n" danger_will_robinson
5952 ) all_functions_sorted;
5964 Copyright (C) 2009 Red Hat Inc.
5968 Please see the file COPYING.LIB for the full license.
5972 L<guestfs(3)>, L<guestfish(1)>.
5977 and generate_perl_prototype name style =
5978 (match fst style with
5984 | RString n -> pr "$%s = " n
5985 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5989 | RLVList n -> pr "@%s = " n
5992 | RHashtable n -> pr "%%%s = " n
5995 let comma = ref false in
5998 if !comma then pr ", ";
6001 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
6008 (* Generate Python C module. *)
6009 and generate_python_c () =
6010 generate_header CStyle LGPLv2;
6019 #include \"guestfs.h\"
6027 get_handle (PyObject *obj)
6030 assert (obj != Py_None);
6031 return ((Pyguestfs_Object *) obj)->g;
6035 put_handle (guestfs_h *g)
6039 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6042 /* This list should be freed (but not the strings) after use. */
6043 static const char **
6044 get_string_list (PyObject *obj)
6051 if (!PyList_Check (obj)) {
6052 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6056 len = PyList_Size (obj);
6057 r = malloc (sizeof (char *) * (len+1));
6059 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6063 for (i = 0; i < len; ++i)
6064 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6071 put_string_list (char * const * const argv)
6076 for (argc = 0; argv[argc] != NULL; ++argc)
6079 list = PyList_New (argc);
6080 for (i = 0; i < argc; ++i)
6081 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6087 put_table (char * const * const argv)
6089 PyObject *list, *item;
6092 for (argc = 0; argv[argc] != NULL; ++argc)
6095 list = PyList_New (argc >> 1);
6096 for (i = 0; i < argc; i += 2) {
6097 item = PyTuple_New (2);
6098 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6099 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6100 PyList_SetItem (list, i >> 1, item);
6107 free_strings (char **argv)
6111 for (argc = 0; argv[argc] != NULL; ++argc)
6117 py_guestfs_create (PyObject *self, PyObject *args)
6121 g = guestfs_create ();
6123 PyErr_SetString (PyExc_RuntimeError,
6124 \"guestfs.create: failed to allocate handle\");
6127 guestfs_set_error_handler (g, NULL, NULL);
6128 return put_handle (g);
6132 py_guestfs_close (PyObject *self, PyObject *args)
6137 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6139 g = get_handle (py_g);
6143 Py_INCREF (Py_None);
6149 (* LVM structures, turned into Python dictionaries. *)
6152 pr "static PyObject *\n";
6153 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
6155 pr " PyObject *dict;\n";
6157 pr " dict = PyDict_New ();\n";
6161 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6162 pr " PyString_FromString (%s->%s));\n"
6165 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6166 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6169 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6170 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6173 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6174 pr " PyLong_FromLongLong (%s->%s));\n"
6176 | name, `OptPercent ->
6177 pr " if (%s->%s >= 0)\n" typ name;
6178 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6179 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6182 pr " Py_INCREF (Py_None);\n";
6183 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6186 pr " return dict;\n";
6190 pr "static PyObject *\n";
6191 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
6193 pr " PyObject *list;\n";
6196 pr " list = PyList_New (%ss->len);\n" typ;
6197 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6198 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
6199 pr " return list;\n";
6202 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
6204 (* Stat structures, turned into Python dictionaries. *)
6207 pr "static PyObject *\n";
6208 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6210 pr " PyObject *dict;\n";
6212 pr " dict = PyDict_New ();\n";
6216 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6217 pr " PyLong_FromLongLong (%s->%s));\n"
6220 pr " return dict;\n";
6223 ) ["stat", stat_cols; "statvfs", statvfs_cols];
6225 (* Python wrapper functions. *)
6227 fun (name, style, _, _, _, _, _) ->
6228 pr "static PyObject *\n";
6229 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6232 pr " PyObject *py_g;\n";
6233 pr " guestfs_h *g;\n";
6234 pr " PyObject *py_r;\n";
6237 match fst style with
6238 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6239 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6240 | RConstString _ -> pr " const char *r;\n"; "NULL"
6241 | RString _ -> pr " char *r;\n"; "NULL"
6242 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6243 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6244 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6245 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6246 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6247 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6248 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6252 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6253 | OptString n -> pr " const char *%s;\n" n
6255 pr " PyObject *py_%s;\n" n;
6256 pr " const char **%s;\n" n
6257 | Bool n -> pr " int %s;\n" n
6258 | Int n -> pr " int %s;\n" n
6263 (* Convert the parameters. *)
6264 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6267 | String _ | FileIn _ | FileOut _ -> pr "s"
6268 | OptString _ -> pr "z"
6269 | StringList _ -> pr "O"
6270 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6273 pr ":guestfs_%s\",\n" name;
6277 | String n | FileIn n | FileOut n -> pr ", &%s" n
6278 | OptString n -> pr ", &%s" n
6279 | StringList n -> pr ", &py_%s" n
6280 | Bool n -> pr ", &%s" n
6281 | Int n -> pr ", &%s" n
6285 pr " return NULL;\n";
6287 pr " g = get_handle (py_g);\n";
6290 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6292 pr " %s = get_string_list (py_%s);\n" n n;
6293 pr " if (!%s) return NULL;\n" n
6298 pr " r = guestfs_%s " name;
6299 generate_call_args ~handle:"g" (snd style);
6304 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6306 pr " free (%s);\n" n
6309 pr " if (r == %s) {\n" error_code;
6310 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6311 pr " return NULL;\n";
6315 (match fst style with
6317 pr " Py_INCREF (Py_None);\n";
6318 pr " py_r = Py_None;\n"
6320 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6321 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6322 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6324 pr " py_r = PyString_FromString (r);\n";
6327 pr " py_r = put_string_list (r);\n";
6328 pr " free_strings (r);\n"
6330 pr " py_r = PyTuple_New (2);\n";
6331 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
6332 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
6333 pr " guestfs_free_int_bool (r);\n"
6335 pr " py_r = put_lvm_pv_list (r);\n";
6336 pr " guestfs_free_lvm_pv_list (r);\n"
6338 pr " py_r = put_lvm_vg_list (r);\n";
6339 pr " guestfs_free_lvm_vg_list (r);\n"
6341 pr " py_r = put_lvm_lv_list (r);\n";
6342 pr " guestfs_free_lvm_lv_list (r);\n"
6344 pr " py_r = put_stat (r);\n";
6347 pr " py_r = put_statvfs (r);\n";
6350 pr " py_r = put_table (r);\n";
6351 pr " free_strings (r);\n"
6354 pr " return py_r;\n";
6359 (* Table of functions. *)
6360 pr "static PyMethodDef methods[] = {\n";
6361 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6362 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6364 fun (name, _, _, _, _, _, _) ->
6365 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6368 pr " { NULL, NULL, 0, NULL }\n";
6372 (* Init function. *)
6375 initlibguestfsmod (void)
6377 static int initialized = 0;
6379 if (initialized) return;
6380 Py_InitModule ((char *) \"libguestfsmod\", methods);
6385 (* Generate Python module. *)
6386 and generate_python_py () =
6387 generate_header HashStyle LGPLv2;
6390 u\"\"\"Python bindings for libguestfs
6393 g = guestfs.GuestFS ()
6394 g.add_drive (\"guest.img\")
6397 parts = g.list_partitions ()
6399 The guestfs module provides a Python binding to the libguestfs API
6400 for examining and modifying virtual machine disk images.
6402 Amongst the things this is good for: making batch configuration
6403 changes to guests, getting disk used/free statistics (see also:
6404 virt-df), migrating between virtualization systems (see also:
6405 virt-p2v), performing partial backups, performing partial guest
6406 clones, cloning guests and changing registry/UUID/hostname info, and
6409 Libguestfs uses Linux kernel and qemu code, and can access any type of
6410 guest filesystem that Linux and qemu can, including but not limited
6411 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6412 schemes, qcow, qcow2, vmdk.
6414 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6415 LVs, what filesystem is in each LV, etc.). It can also run commands
6416 in the context of the guest. Also you can access filesystems over FTP.
6418 Errors which happen while using the API are turned into Python
6419 RuntimeError exceptions.
6421 To create a guestfs handle you usually have to perform the following
6424 # Create the handle, call add_drive at least once, and possibly
6425 # several times if the guest has multiple block devices:
6426 g = guestfs.GuestFS ()
6427 g.add_drive (\"guest.img\")
6429 # Launch the qemu subprocess and wait for it to become ready:
6433 # Now you can issue commands, for example:
6438 import libguestfsmod
6441 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6443 def __init__ (self):
6444 \"\"\"Create a new libguestfs handle.\"\"\"
6445 self._o = libguestfsmod.create ()
6448 libguestfsmod.close (self._o)
6453 fun (name, style, _, flags, _, _, longdesc) ->
6455 generate_call_args ~handle:"self" (snd style);
6458 if not (List.mem NotInDocs flags) then (
6459 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6461 match fst style with
6462 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6465 doc ^ "\n\nThis function returns a list of strings."
6467 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
6469 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
6471 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
6473 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
6475 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
6477 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
6479 doc ^ "\n\nThis function returns a dictionary." in
6481 if List.mem ProtocolLimitWarning flags then
6482 doc ^ "\n\n" ^ protocol_limit_warning
6485 if List.mem DangerWillRobinson flags then
6486 doc ^ "\n\n" ^ danger_will_robinson
6488 let doc = pod2text ~width:60 name doc in
6489 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6490 let doc = String.concat "\n " doc in
6491 pr " u\"\"\"%s\"\"\"\n" doc;
6493 pr " return libguestfsmod.%s " name;
6494 generate_call_args ~handle:"self._o" (snd style);
6499 (* Useful if you need the longdesc POD text as plain text. Returns a
6502 * This is the slowest thing about autogeneration.
6504 and pod2text ~width name longdesc =
6505 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6506 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6508 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6509 let chan = Unix.open_process_in cmd in
6510 let lines = ref [] in
6512 let line = input_line chan in
6513 if i = 1 then (* discard the first line of output *)
6516 let line = triml line in
6517 lines := line :: !lines;
6520 let lines = try loop 1 with End_of_file -> List.rev !lines in
6521 Unix.unlink filename;
6522 match Unix.close_process_in chan with
6523 | Unix.WEXITED 0 -> lines
6525 failwithf "pod2text: process exited with non-zero status (%d)" i
6526 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6527 failwithf "pod2text: process signalled or stopped by signal %d" i
6529 (* Generate ruby bindings. *)
6530 and generate_ruby_c () =
6531 generate_header CStyle LGPLv2;
6539 #include \"guestfs.h\"
6541 #include \"extconf.h\"
6543 /* For Ruby < 1.9 */
6545 #define RARRAY_LEN(r) (RARRAY((r))->len)
6548 static VALUE m_guestfs; /* guestfs module */
6549 static VALUE c_guestfs; /* guestfs_h handle */
6550 static VALUE e_Error; /* used for all errors */
6552 static void ruby_guestfs_free (void *p)
6555 guestfs_close ((guestfs_h *) p);
6558 static VALUE ruby_guestfs_create (VALUE m)
6562 g = guestfs_create ();
6564 rb_raise (e_Error, \"failed to create guestfs handle\");
6566 /* Don't print error messages to stderr by default. */
6567 guestfs_set_error_handler (g, NULL, NULL);
6569 /* Wrap it, and make sure the close function is called when the
6572 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6575 static VALUE ruby_guestfs_close (VALUE gv)
6578 Data_Get_Struct (gv, guestfs_h, g);
6580 ruby_guestfs_free (g);
6581 DATA_PTR (gv) = NULL;
6589 fun (name, style, _, _, _, _, _) ->
6590 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6591 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6594 pr " guestfs_h *g;\n";
6595 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6597 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6603 | String n | FileIn n | FileOut n ->
6604 pr " Check_Type (%sv, T_STRING);\n" n;
6605 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6607 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6608 pr " \"%s\", \"%s\");\n" n name
6610 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6612 pr " char **%s;\n" n;
6613 pr " Check_Type (%sv, T_ARRAY);\n" n;
6615 pr " int i, len;\n";
6616 pr " len = RARRAY_LEN (%sv);\n" n;
6617 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6619 pr " for (i = 0; i < len; ++i) {\n";
6620 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6621 pr " %s[i] = StringValueCStr (v);\n" n;
6623 pr " %s[len] = NULL;\n" n;
6626 pr " int %s = RTEST (%sv);\n" n n
6628 pr " int %s = NUM2INT (%sv);\n" n n
6633 match fst style with
6634 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6635 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6636 | RConstString _ -> pr " const char *r;\n"; "NULL"
6637 | RString _ -> pr " char *r;\n"; "NULL"
6638 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6639 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6640 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6641 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6642 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6643 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6644 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6647 pr " r = guestfs_%s " name;
6648 generate_call_args ~handle:"g" (snd style);
6653 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6655 pr " free (%s);\n" n
6658 pr " if (r == %s)\n" error_code;
6659 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6662 (match fst style with
6664 pr " return Qnil;\n"
6665 | RInt _ | RBool _ ->
6666 pr " return INT2NUM (r);\n"
6668 pr " return ULL2NUM (r);\n"
6670 pr " return rb_str_new2 (r);\n";
6672 pr " VALUE rv = rb_str_new2 (r);\n";
6676 pr " int i, len = 0;\n";
6677 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6678 pr " VALUE rv = rb_ary_new2 (len);\n";
6679 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6680 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6681 pr " free (r[i]);\n";
6686 pr " VALUE rv = rb_ary_new2 (2);\n";
6687 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
6688 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
6689 pr " guestfs_free_int_bool (r);\n";
6692 generate_ruby_lvm_code "pv" pv_cols
6694 generate_ruby_lvm_code "vg" vg_cols
6696 generate_ruby_lvm_code "lv" lv_cols
6698 pr " VALUE rv = rb_hash_new ();\n";
6702 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6707 pr " VALUE rv = rb_hash_new ();\n";
6711 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6716 pr " VALUE rv = rb_hash_new ();\n";
6718 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
6719 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6720 pr " free (r[i]);\n";
6721 pr " free (r[i+1]);\n";
6732 /* Initialize the module. */
6733 void Init__guestfs ()
6735 m_guestfs = rb_define_module (\"Guestfs\");
6736 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6737 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6739 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6740 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6743 (* Define the rest of the methods. *)
6745 fun (name, style, _, _, _, _, _) ->
6746 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
6747 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6752 (* Ruby code to return an LVM struct list. *)
6753 and generate_ruby_lvm_code typ cols =
6754 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6756 pr " for (i = 0; i < r->len; ++i) {\n";
6757 pr " VALUE hv = rb_hash_new ();\n";
6761 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6763 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6766 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6767 | name, `OptPercent ->
6768 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6770 pr " rb_ary_push (rv, hv);\n";
6772 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6775 (* Generate Java bindings GuestFS.java file. *)
6776 and generate_java_java () =
6777 generate_header CStyle LGPLv2;
6780 package com.redhat.et.libguestfs;
6782 import java.util.HashMap;
6783 import com.redhat.et.libguestfs.LibGuestFSException;
6784 import com.redhat.et.libguestfs.PV;
6785 import com.redhat.et.libguestfs.VG;
6786 import com.redhat.et.libguestfs.LV;
6787 import com.redhat.et.libguestfs.Stat;
6788 import com.redhat.et.libguestfs.StatVFS;
6789 import com.redhat.et.libguestfs.IntBool;
6792 * The GuestFS object is a libguestfs handle.
6796 public class GuestFS {
6797 // Load the native code.
6799 System.loadLibrary (\"guestfs_jni\");
6803 * The native guestfs_h pointer.
6808 * Create a libguestfs handle.
6810 * @throws LibGuestFSException
6812 public GuestFS () throws LibGuestFSException
6816 private native long _create () throws LibGuestFSException;
6819 * Close a libguestfs handle.
6821 * You can also leave handles to be collected by the garbage
6822 * collector, but this method ensures that the resources used
6823 * by the handle are freed up immediately. If you call any
6824 * other methods after closing the handle, you will get an
6827 * @throws LibGuestFSException
6829 public void close () throws LibGuestFSException
6835 private native void _close (long g) throws LibGuestFSException;
6837 public void finalize () throws LibGuestFSException
6845 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6846 if not (List.mem NotInDocs flags); then (
6847 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6849 if List.mem ProtocolLimitWarning flags then
6850 doc ^ "\n\n" ^ protocol_limit_warning
6853 if List.mem DangerWillRobinson flags then
6854 doc ^ "\n\n" ^ danger_will_robinson
6856 let doc = pod2text ~width:60 name doc in
6857 let doc = List.map ( (* RHBZ#501883 *)
6860 | nonempty -> nonempty
6862 let doc = String.concat "\n * " doc in
6865 pr " * %s\n" shortdesc;
6868 pr " * @throws LibGuestFSException\n";
6872 generate_java_prototype ~public:true ~semicolon:false name style;
6875 pr " if (g == 0)\n";
6876 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6879 if fst style <> RErr then pr "return ";
6881 generate_call_args ~handle:"g" (snd style);
6885 generate_java_prototype ~privat:true ~native:true name style;
6892 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6893 ?(semicolon=true) name style =
6894 if privat then pr "private ";
6895 if public then pr "public ";
6896 if native then pr "native ";
6899 (match fst style with
6900 | RErr -> pr "void ";
6901 | RInt _ -> pr "int ";
6902 | RInt64 _ -> pr "long ";
6903 | RBool _ -> pr "boolean ";
6904 | RConstString _ | RString _ -> pr "String ";
6905 | RStringList _ -> pr "String[] ";
6906 | RIntBool _ -> pr "IntBool ";
6907 | RPVList _ -> pr "PV[] ";
6908 | RVGList _ -> pr "VG[] ";
6909 | RLVList _ -> pr "LV[] ";
6910 | RStat _ -> pr "Stat ";
6911 | RStatVFS _ -> pr "StatVFS ";
6912 | RHashtable _ -> pr "HashMap<String,String> ";
6915 if native then pr "_%s " name else pr "%s " name;
6917 let needs_comma = ref false in
6926 if !needs_comma then pr ", ";
6927 needs_comma := true;
6944 pr " throws LibGuestFSException";
6945 if semicolon then pr ";"
6947 and generate_java_struct typ cols =
6948 generate_header CStyle LGPLv2;
6951 package com.redhat.et.libguestfs;
6954 * Libguestfs %s structure.
6965 | name, `UUID -> pr " public String %s;\n" name
6967 | name, `Int -> pr " public long %s;\n" name
6968 | name, `OptPercent ->
6969 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6970 pr " public float %s;\n" name
6975 and generate_java_c () =
6976 generate_header CStyle LGPLv2;
6983 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6984 #include \"guestfs.h\"
6986 /* Note that this function returns. The exception is not thrown
6987 * until after the wrapper function returns.
6990 throw_exception (JNIEnv *env, const char *msg)
6993 cl = (*env)->FindClass (env,
6994 \"com/redhat/et/libguestfs/LibGuestFSException\");
6995 (*env)->ThrowNew (env, cl, msg);
6998 JNIEXPORT jlong JNICALL
6999 Java_com_redhat_et_libguestfs_GuestFS__1create
7000 (JNIEnv *env, jobject obj)
7004 g = guestfs_create ();
7006 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
7009 guestfs_set_error_handler (g, NULL, NULL);
7010 return (jlong) (long) g;
7013 JNIEXPORT void JNICALL
7014 Java_com_redhat_et_libguestfs_GuestFS__1close
7015 (JNIEnv *env, jobject obj, jlong jg)
7017 guestfs_h *g = (guestfs_h *) (long) jg;
7024 fun (name, style, _, _, _, _, _) ->
7026 (match fst style with
7027 | RErr -> pr "void ";
7028 | RInt _ -> pr "jint ";
7029 | RInt64 _ -> pr "jlong ";
7030 | RBool _ -> pr "jboolean ";
7031 | RConstString _ | RString _ -> pr "jstring ";
7032 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
7034 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
7038 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7039 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7041 pr " (JNIEnv *env, jobject obj, jlong jg";
7048 pr ", jstring j%s" n
7050 pr ", jobjectArray j%s" n
7052 pr ", jboolean j%s" n
7058 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7059 let error_code, no_ret =
7060 match fst style with
7061 | RErr -> pr " int r;\n"; "-1", ""
7063 | RInt _ -> pr " int r;\n"; "-1", "0"
7064 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7065 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7067 pr " jstring jr;\n";
7068 pr " char *r;\n"; "NULL", "NULL"
7070 pr " jobjectArray jr;\n";
7073 pr " jstring jstr;\n";
7074 pr " char **r;\n"; "NULL", "NULL"
7076 pr " jobject jr;\n";
7078 pr " jfieldID fl;\n";
7079 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
7081 pr " jobject jr;\n";
7083 pr " jfieldID fl;\n";
7084 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
7086 pr " jobject jr;\n";
7088 pr " jfieldID fl;\n";
7089 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
7091 pr " jobjectArray jr;\n";
7093 pr " jfieldID fl;\n";
7094 pr " jobject jfl;\n";
7095 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
7097 pr " jobjectArray jr;\n";
7099 pr " jfieldID fl;\n";
7100 pr " jobject jfl;\n";
7101 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
7103 pr " jobjectArray jr;\n";
7105 pr " jfieldID fl;\n";
7106 pr " jobject jfl;\n";
7107 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
7108 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
7115 pr " const char *%s;\n" n
7117 pr " int %s_len;\n" n;
7118 pr " const char **%s;\n" n
7125 (match fst style with
7126 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
7127 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7128 | RString _ | RIntBool _ | RStat _ | RStatVFS _
7129 | RHashtable _ -> false) ||
7130 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7136 (* Get the parameters. *)
7142 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7144 (* This is completely undocumented, but Java null becomes
7147 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
7149 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
7150 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
7151 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7152 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7154 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
7156 pr " %s[%s_len] = NULL;\n" n n;
7159 pr " %s = j%s;\n" n n
7162 (* Make the call. *)
7163 pr " r = guestfs_%s " name;
7164 generate_call_args ~handle:"g" (snd style);
7167 (* Release the parameters. *)
7173 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7176 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7178 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7179 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7181 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7183 pr " free (%s);\n" n
7188 (* Check for errors. *)
7189 pr " if (r == %s) {\n" error_code;
7190 pr " throw_exception (env, guestfs_last_error (g));\n";
7191 pr " return %s;\n" no_ret;
7195 (match fst style with
7197 | RInt _ -> pr " return (jint) r;\n"
7198 | RBool _ -> pr " return (jboolean) r;\n"
7199 | RInt64 _ -> pr " return (jlong) r;\n"
7200 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7202 pr " jr = (*env)->NewStringUTF (env, r);\n";
7206 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7207 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7208 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7209 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7210 pr " for (i = 0; i < r_len; ++i) {\n";
7211 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7212 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7213 pr " free (r[i]);\n";
7218 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
7219 pr " jr = (*env)->AllocObject (env, cl);\n";
7220 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
7221 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
7222 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
7223 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
7224 pr " guestfs_free_int_bool (r);\n";
7227 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
7228 pr " jr = (*env)->AllocObject (env, cl);\n";
7232 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7234 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7239 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
7240 pr " jr = (*env)->AllocObject (env, cl);\n";
7244 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7246 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7251 generate_java_lvm_return "pv" "PV" pv_cols
7253 generate_java_lvm_return "vg" "VG" vg_cols
7255 generate_java_lvm_return "lv" "LV" lv_cols
7258 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7259 pr " return NULL;\n"
7266 and generate_java_lvm_return typ jtyp cols =
7267 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7268 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7269 pr " for (i = 0; i < r->len; ++i) {\n";
7270 pr " jfl = (*env)->AllocObject (env, cl);\n";
7274 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7275 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7278 pr " char s[33];\n";
7279 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7281 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7282 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7284 | name, (`Bytes|`Int) ->
7285 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7286 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7287 | name, `OptPercent ->
7288 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7289 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7291 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7293 pr " guestfs_free_lvm_%s_list (r);\n" typ;
7296 and generate_haskell_hs () =
7297 generate_header HaskellStyle LGPLv2;
7299 (* XXX We only know how to generate partial FFI for Haskell
7300 * at the moment. Please help out!
7302 let can_generate style =
7306 | RInt64 _, _ -> true
7317 | RHashtable _, _ -> false in
7320 {-# INCLUDE <guestfs.h> #-}
7321 {-# LANGUAGE ForeignFunctionInterface #-}
7326 (* List out the names of the actions we want to export. *)
7328 fun (name, style, _, _, _, _, _) ->
7329 if can_generate style then pr ",\n %s" name
7336 import Foreign.C.Types
7338 import Control.Exception
7339 import Data.Typeable
7341 data GuestfsS = GuestfsS -- represents the opaque C struct
7342 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7343 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7345 -- XXX define properly later XXX
7349 data IntBool = IntBool
7351 data StatVFS = StatVFS
7352 data Hashtable = Hashtable
7354 foreign import ccall unsafe \"guestfs_create\" c_create
7356 foreign import ccall unsafe \"&guestfs_close\" c_close
7357 :: FunPtr (GuestfsP -> IO ())
7358 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7359 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7361 create :: IO GuestfsH
7364 c_set_error_handler p nullPtr nullPtr
7365 h <- newForeignPtr c_close p
7368 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7369 :: GuestfsP -> IO CString
7371 -- last_error :: GuestfsH -> IO (Maybe String)
7372 -- last_error h = do
7373 -- str <- withForeignPtr h (\\p -> c_last_error p)
7374 -- maybePeek peekCString str
7376 last_error :: GuestfsH -> IO (String)
7378 str <- withForeignPtr h (\\p -> c_last_error p)
7380 then return \"no error\"
7381 else peekCString str
7385 (* Generate wrappers for each foreign function. *)
7387 fun (name, style, _, _, _, _, _) ->
7388 if can_generate style then (
7389 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7391 generate_haskell_prototype ~handle:"GuestfsP" style;
7395 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7397 pr "%s %s = do\n" name
7398 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7400 (* Convert pointer arguments using with* functions. *)
7405 | String n -> pr "withCString %s $ \\%s -> " n n
7406 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7407 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7408 | Bool _ | Int _ -> ()
7410 (* Convert integer arguments. *)
7414 | Bool n -> sprintf "(fromBool %s)" n
7415 | Int n -> sprintf "(fromIntegral %s)" n
7416 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
7418 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7419 (String.concat " " ("p" :: args));
7420 (match fst style with
7421 | RErr | RInt _ | RInt64 _ | RBool _ ->
7422 pr " if (r == -1)\n";
7424 pr " err <- last_error h\n";
7426 | RConstString _ | RString _ | RStringList _ | RIntBool _
7427 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7429 pr " if (r == nullPtr)\n";
7431 pr " err <- last_error h\n";
7434 (match fst style with
7436 pr " else return ()\n"
7438 pr " else return (fromIntegral r)\n"
7440 pr " else return (fromIntegral r)\n"
7442 pr " else return (toBool r)\n"
7453 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7459 and generate_haskell_prototype ~handle ?(hs = false) style =
7461 let string = if hs then "String" else "CString" in
7462 let int = if hs then "Int" else "CInt" in
7463 let bool = if hs then "Bool" else "CInt" in
7464 let int64 = if hs then "Integer" else "Int64" in
7468 | String _ -> pr "%s" string
7469 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7470 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7471 | Bool _ -> pr "%s" bool
7472 | Int _ -> pr "%s" int
7473 | FileIn _ -> pr "%s" string
7474 | FileOut _ -> pr "%s" string
7479 (match fst style with
7480 | RErr -> if not hs then pr "CInt"
7481 | RInt _ -> pr "%s" int
7482 | RInt64 _ -> pr "%s" int64
7483 | RBool _ -> pr "%s" bool
7484 | RConstString _ -> pr "%s" string
7485 | RString _ -> pr "%s" string
7486 | RStringList _ -> pr "[%s]" string
7487 | RIntBool _ -> pr "IntBool"
7488 | RPVList _ -> pr "[PV]"
7489 | RVGList _ -> pr "[VG]"
7490 | RLVList _ -> pr "[LV]"
7491 | RStat _ -> pr "Stat"
7492 | RStatVFS _ -> pr "StatVFS"
7493 | RHashtable _ -> pr "Hashtable"
7497 and generate_bindtests () =
7498 generate_header CStyle LGPLv2;
7503 #include <inttypes.h>
7506 #include \"guestfs.h\"
7507 #include \"guestfs_protocol.h\"
7509 #define error guestfs_error
7512 print_strings (char * const* const argv)
7517 for (argc = 0; argv[argc] != NULL; ++argc) {
7518 if (argc > 0) printf (\", \");
7519 printf (\"\\\"%%s\\\"\", argv[argc]);
7524 /* The test0 function prints its parameters to stdout. */
7528 match test_functions with
7529 | [] -> assert false
7530 | test0 :: tests -> test0, tests in
7533 let (name, style, _, _, _, _, _) = test0 in
7534 generate_prototype ~extern:false ~semicolon:false ~newline:true
7535 ~handle:"g" ~prefix:"guestfs_" name style;
7541 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
7542 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7543 | StringList n -> pr " print_strings (%s);\n" n
7544 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7545 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
7547 pr " /* Java changes stdout line buffering so we need this: */\n";
7548 pr " fflush (stdout);\n";
7554 fun (name, style, _, _, _, _, _) ->
7555 if String.sub name (String.length name - 3) 3 <> "err" then (
7556 pr "/* Test normal return. */\n";
7557 generate_prototype ~extern:false ~semicolon:false ~newline:true
7558 ~handle:"g" ~prefix:"guestfs_" name style;
7560 (match fst style with
7565 pr " sscanf (val, \"%%d\", &r);\n";
7569 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
7572 pr " return strcmp (val, \"true\") == 0;\n"
7574 (* Can't return the input string here. Return a static
7575 * string so we ensure we get a segfault if the caller
7578 pr " return \"static string\";\n"
7580 pr " return strdup (val);\n"
7582 pr " char **strs;\n";
7584 pr " sscanf (val, \"%%d\", &n);\n";
7585 pr " strs = malloc ((n+1) * sizeof (char *));\n";
7586 pr " for (i = 0; i < n; ++i) {\n";
7587 pr " strs[i] = malloc (16);\n";
7588 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
7590 pr " strs[n] = NULL;\n";
7591 pr " return strs;\n"
7593 pr " struct guestfs_int_bool *r;\n";
7594 pr " r = malloc (sizeof (struct guestfs_int_bool));\n";
7595 pr " sscanf (val, \"%%\" SCNi32, &r->i);\n";
7599 pr " struct guestfs_lvm_pv_list *r;\n";
7601 pr " r = malloc (sizeof (struct guestfs_lvm_pv_list));\n";
7602 pr " sscanf (val, \"%%d\", &r->len);\n";
7603 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_pv));\n";
7604 pr " for (i = 0; i < r->len; ++i) {\n";
7605 pr " r->val[i].pv_name = malloc (16);\n";
7606 pr " snprintf (r->val[i].pv_name, 16, \"%%d\", i);\n";
7610 pr " struct guestfs_lvm_vg_list *r;\n";
7612 pr " r = malloc (sizeof (struct guestfs_lvm_vg_list));\n";
7613 pr " sscanf (val, \"%%d\", &r->len);\n";
7614 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_vg));\n";
7615 pr " for (i = 0; i < r->len; ++i) {\n";
7616 pr " r->val[i].vg_name = malloc (16);\n";
7617 pr " snprintf (r->val[i].vg_name, 16, \"%%d\", i);\n";
7621 pr " struct guestfs_lvm_lv_list *r;\n";
7623 pr " r = malloc (sizeof (struct guestfs_lvm_lv_list));\n";
7624 pr " sscanf (val, \"%%d\", &r->len);\n";
7625 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_lv));\n";
7626 pr " for (i = 0; i < r->len; ++i) {\n";
7627 pr " r->val[i].lv_name = malloc (16);\n";
7628 pr " snprintf (r->val[i].lv_name, 16, \"%%d\", i);\n";
7632 pr " struct guestfs_stat *r;\n";
7633 pr " r = calloc (1, sizeof (*r));\n";
7634 pr " sscanf (val, \"%%\" SCNi64, &r->dev);\n";
7637 pr " struct guestfs_statvfs *r;\n";
7638 pr " r = calloc (1, sizeof (*r));\n";
7639 pr " sscanf (val, \"%%\" SCNi64, &r->bsize);\n";
7642 pr " char **strs;\n";
7644 pr " sscanf (val, \"%%d\", &n);\n";
7645 pr " strs = malloc ((n*2+1) * sizeof (char *));\n";
7646 pr " for (i = 0; i < n; ++i) {\n";
7647 pr " strs[i*2] = malloc (16);\n";
7648 pr " strs[i*2+1] = malloc (16);\n";
7649 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
7650 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7652 pr " strs[n*2] = NULL;\n";
7653 pr " return strs;\n"
7658 pr "/* Test error return. */\n";
7659 generate_prototype ~extern:false ~semicolon:false ~newline:true
7660 ~handle:"g" ~prefix:"guestfs_" name style;
7662 pr " error (g, \"error\");\n";
7663 (match fst style with
7664 | RErr | RInt _ | RInt64 _ | RBool _ ->
7667 | RString _ | RStringList _ | RIntBool _
7668 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7670 pr " return NULL;\n"
7677 and generate_ocaml_bindtests () =
7678 generate_header OCamlStyle GPLv2;
7682 let g = Guestfs.create () in
7689 | CallString s -> "\"" ^ s ^ "\""
7690 | CallOptString None -> "None"
7691 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7692 | CallStringList xs ->
7693 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7694 | CallInt i when i >= 0 -> string_of_int i
7695 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7696 | CallBool b -> string_of_bool b
7701 generate_lang_bindtests (
7702 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
7705 pr "print_endline \"EOF\"\n"
7707 and generate_perl_bindtests () =
7708 pr "#!/usr/bin/perl -w\n";
7709 generate_header HashStyle GPLv2;
7716 my $g = Sys::Guestfs->new ();
7720 String.concat ", " (
7723 | CallString s -> "\"" ^ s ^ "\""
7724 | CallOptString None -> "undef"
7725 | CallOptString (Some s) -> sprintf "\"%s\"" s
7726 | CallStringList xs ->
7727 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7728 | CallInt i -> string_of_int i
7729 | CallBool b -> if b then "1" else "0"
7734 generate_lang_bindtests (
7735 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7738 pr "print \"EOF\\n\"\n"
7740 and generate_python_bindtests () =
7741 generate_header HashStyle GPLv2;
7746 g = guestfs.GuestFS ()
7750 String.concat ", " (
7753 | CallString s -> "\"" ^ s ^ "\""
7754 | CallOptString None -> "None"
7755 | CallOptString (Some s) -> sprintf "\"%s\"" s
7756 | CallStringList xs ->
7757 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7758 | CallInt i -> string_of_int i
7759 | CallBool b -> if b then "1" else "0"
7764 generate_lang_bindtests (
7765 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
7768 pr "print \"EOF\"\n"
7770 and generate_ruby_bindtests () =
7771 generate_header HashStyle GPLv2;
7776 g = Guestfs::create()
7780 String.concat ", " (
7783 | CallString s -> "\"" ^ s ^ "\""
7784 | CallOptString None -> "nil"
7785 | CallOptString (Some s) -> sprintf "\"%s\"" s
7786 | CallStringList xs ->
7787 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7788 | CallInt i -> string_of_int i
7789 | CallBool b -> string_of_bool b
7794 generate_lang_bindtests (
7795 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
7798 pr "print \"EOF\\n\"\n"
7800 and generate_java_bindtests () =
7801 generate_header CStyle GPLv2;
7804 import com.redhat.et.libguestfs.*;
7806 public class Bindtests {
7807 public static void main (String[] argv)
7810 GuestFS g = new GuestFS ();
7814 String.concat ", " (
7817 | CallString s -> "\"" ^ s ^ "\""
7818 | CallOptString None -> "null"
7819 | CallOptString (Some s) -> sprintf "\"%s\"" s
7820 | CallStringList xs ->
7822 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
7823 | CallInt i -> string_of_int i
7824 | CallBool b -> string_of_bool b
7829 generate_lang_bindtests (
7830 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
7834 System.out.println (\"EOF\");
7836 catch (Exception exn) {
7837 System.err.println (exn);
7844 and generate_haskell_bindtests () =
7845 generate_header HaskellStyle GPLv2;
7848 module Bindtests where
7849 import qualified Guestfs
7859 | CallString s -> "\"" ^ s ^ "\""
7860 | CallOptString None -> "Nothing"
7861 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
7862 | CallStringList xs ->
7863 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7864 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
7865 | CallInt i -> string_of_int i
7866 | CallBool true -> "True"
7867 | CallBool false -> "False"
7872 generate_lang_bindtests (
7873 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
7876 pr " putStrLn \"EOF\"\n"
7878 (* Language-independent bindings tests - we do it this way to
7879 * ensure there is parity in testing bindings across all languages.
7881 and generate_lang_bindtests call =
7882 call "test0" [CallString "abc"; CallOptString (Some "def");
7883 CallStringList []; CallBool false;
7884 CallInt 0; CallString "123"; CallString "456"];
7885 call "test0" [CallString "abc"; CallOptString None;
7886 CallStringList []; CallBool false;
7887 CallInt 0; CallString "123"; CallString "456"];
7888 call "test0" [CallString ""; CallOptString (Some "def");
7889 CallStringList []; CallBool false;
7890 CallInt 0; CallString "123"; CallString "456"];
7891 call "test0" [CallString ""; CallOptString (Some "");
7892 CallStringList []; CallBool false;
7893 CallInt 0; CallString "123"; CallString "456"];
7894 call "test0" [CallString "abc"; CallOptString (Some "def");
7895 CallStringList ["1"]; CallBool false;
7896 CallInt 0; CallString "123"; CallString "456"];
7897 call "test0" [CallString "abc"; CallOptString (Some "def");
7898 CallStringList ["1"; "2"]; CallBool false;
7899 CallInt 0; CallString "123"; CallString "456"];
7900 call "test0" [CallString "abc"; CallOptString (Some "def");
7901 CallStringList ["1"]; CallBool true;
7902 CallInt 0; CallString "123"; CallString "456"];
7903 call "test0" [CallString "abc"; CallOptString (Some "def");
7904 CallStringList ["1"]; CallBool false;
7905 CallInt (-1); CallString "123"; CallString "456"];
7906 call "test0" [CallString "abc"; CallOptString (Some "def");
7907 CallStringList ["1"]; CallBool false;
7908 CallInt (-2); CallString "123"; CallString "456"];
7909 call "test0" [CallString "abc"; CallOptString (Some "def");
7910 CallStringList ["1"]; CallBool false;
7911 CallInt 1; CallString "123"; CallString "456"];
7912 call "test0" [CallString "abc"; CallOptString (Some "def");
7913 CallStringList ["1"]; CallBool false;
7914 CallInt 2; CallString "123"; CallString "456"];
7915 call "test0" [CallString "abc"; CallOptString (Some "def");
7916 CallStringList ["1"]; CallBool false;
7917 CallInt 4095; CallString "123"; CallString "456"];
7918 call "test0" [CallString "abc"; CallOptString (Some "def");
7919 CallStringList ["1"]; CallBool false;
7920 CallInt 0; CallString ""; CallString ""]
7922 (* XXX Add here tests of the return and error functions. *)
7924 (* This is used to generate the src/MAX_PROC_NR file which
7925 * contains the maximum procedure number, a surrogate for the
7926 * ABI version number. See src/Makefile.am for the details.
7928 and generate_max_proc_nr () =
7929 let proc_nrs = List.map (
7930 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
7931 ) daemon_functions in
7933 let max_proc_nr = List.fold_left max 0 proc_nrs in
7935 pr "%d\n" max_proc_nr
7937 let output_to filename =
7938 let filename_new = filename ^ ".new" in
7939 chan := open_out filename_new;
7944 (* Is the new file different from the current file? *)
7945 if Sys.file_exists filename && files_equal filename filename_new then
7946 Unix.unlink filename_new (* same, so skip it *)
7948 (* different, overwrite old one *)
7949 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
7950 Unix.rename filename_new filename;
7951 Unix.chmod filename 0o444;
7952 printf "written %s\n%!" filename;
7961 if not (Sys.file_exists "configure.ac") then (
7963 You are probably running this from the wrong directory.
7964 Run it from the top source directory using the command
7970 let close = output_to "src/guestfs_protocol.x" in
7974 let close = output_to "src/guestfs-structs.h" in
7975 generate_structs_h ();
7978 let close = output_to "src/guestfs-actions.h" in
7979 generate_actions_h ();
7982 let close = output_to "src/guestfs-actions.c" in
7983 generate_client_actions ();
7986 let close = output_to "daemon/actions.h" in
7987 generate_daemon_actions_h ();
7990 let close = output_to "daemon/stubs.c" in
7991 generate_daemon_actions ();
7994 let close = output_to "capitests/tests.c" in
7998 let close = output_to "src/guestfs-bindtests.c" in
7999 generate_bindtests ();
8002 let close = output_to "fish/cmds.c" in
8003 generate_fish_cmds ();
8006 let close = output_to "fish/completion.c" in
8007 generate_fish_completion ();
8010 let close = output_to "guestfs-structs.pod" in
8011 generate_structs_pod ();
8014 let close = output_to "guestfs-actions.pod" in
8015 generate_actions_pod ();
8018 let close = output_to "guestfish-actions.pod" in
8019 generate_fish_actions_pod ();
8022 let close = output_to "ocaml/guestfs.mli" in
8023 generate_ocaml_mli ();
8026 let close = output_to "ocaml/guestfs.ml" in
8027 generate_ocaml_ml ();
8030 let close = output_to "ocaml/guestfs_c_actions.c" in
8031 generate_ocaml_c ();
8034 let close = output_to "ocaml/bindtests.ml" in
8035 generate_ocaml_bindtests ();
8038 let close = output_to "perl/Guestfs.xs" in
8039 generate_perl_xs ();
8042 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8043 generate_perl_pm ();
8046 let close = output_to "perl/bindtests.pl" in
8047 generate_perl_bindtests ();
8050 let close = output_to "python/guestfs-py.c" in
8051 generate_python_c ();
8054 let close = output_to "python/guestfs.py" in
8055 generate_python_py ();
8058 let close = output_to "python/bindtests.py" in
8059 generate_python_bindtests ();
8062 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8066 let close = output_to "ruby/bindtests.rb" in
8067 generate_ruby_bindtests ();
8070 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8071 generate_java_java ();
8074 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
8075 generate_java_struct "PV" pv_cols;
8078 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
8079 generate_java_struct "VG" vg_cols;
8082 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
8083 generate_java_struct "LV" lv_cols;
8086 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
8087 generate_java_struct "Stat" stat_cols;
8090 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
8091 generate_java_struct "StatVFS" statvfs_cols;
8094 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8098 let close = output_to "java/Bindtests.java" in
8099 generate_java_bindtests ();
8102 let close = output_to "haskell/Guestfs.hs" in
8103 generate_haskell_hs ();
8106 let close = output_to "haskell/Bindtests.hs" in
8107 generate_haskell_bindtests ();
8110 let close = output_to "src/MAX_PROC_NR" in
8111 generate_max_proc_nr ();