3 * Copyright (C) 2009 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table below), and
25 * daemon/<somefile>.c to write the implementation.
27 * After editing this file, run it (./src/generator.ml) to regenerate
28 * all the output files.
30 * IMPORTANT: This script should NOT print any warnings. If it prints
31 * warnings, you should treat them as errors.
32 * [Need to add -warn-error to ocaml command line]
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
46 (* "RInt" as a return value means an int which is -1 for error
47 * or any value >= 0 on success. Only use this for smallish
48 * positive ints (0 <= i < 2^30).
51 (* "RInt64" is the same as RInt, but is guaranteed to be able
52 * to return a full 64 bit value, _except_ that -1 means error
53 * (so -1 cannot be a valid, non-error return value).
56 (* "RBool" is a bool return value which can be true/false or
60 (* "RConstString" is a string that refers to a constant value.
61 * Try to avoid using this. In particular you cannot use this
62 * for values returned from the daemon, because there is no
63 * thread-safe way to return them in the C API.
65 | RConstString of string
66 (* "RString" and "RStringList" are caller-frees. *)
68 | RStringList of string
69 (* Some limited tuples are possible: *)
70 | RIntBool of string * string
71 (* LVM PVs, VGs and LVs. *)
78 (* Key-value pairs of untyped strings. Turns into a hashtable or
79 * dictionary in languages which support it. DON'T use this as a
80 * general "bucket" for results. Prefer a stronger typed return
81 * value if one is available, or write a custom struct. Don't use
82 * this if the list could potentially be very long, since it is
83 * inefficient. Keys should be unique. NULLs are not permitted.
85 | RHashtable of string
87 and args = argt list (* Function parameters, guestfs handle is implicit. *)
89 (* Note in future we should allow a "variable args" parameter as
90 * the final parameter, to allow commands like
91 * chmod mode file [file(s)...]
92 * This is not implemented yet, but many commands (such as chmod)
93 * are currently defined with the argument order keeping this future
94 * possibility in mind.
97 | String of string (* const char *name, cannot be NULL *)
98 | OptString of string (* const char *name, may be NULL *)
99 | StringList of string(* list of strings (each string cannot be NULL) *)
100 | Bool of string (* boolean *)
101 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
102 (* These are treated as filenames (simple string parameters) in
103 * the C API and bindings. But in the RPC protocol, we transfer
104 * the actual file content up to or down from the daemon.
105 * FileIn: local machine -> daemon (in request)
106 * FileOut: daemon -> local machine (in reply)
107 * In guestfish (only), the special name "-" means read from
108 * stdin or write to stdout.
114 | ProtocolLimitWarning (* display warning about protocol size limits *)
115 | DangerWillRobinson (* flags particularly dangerous commands *)
116 | FishAlias of string (* provide an alias for this cmd in guestfish *)
117 | FishAction of string (* call this function in guestfish *)
118 | NotInFish (* do not export via guestfish *)
119 | NotInDocs (* do not add this function to documentation *)
121 let protocol_limit_warning =
122 "Because of the message protocol, there is a transfer limit
123 of somewhere between 2MB and 4MB. To transfer large files you should use
126 let danger_will_robinson =
127 "B<This command is dangerous. Without careful use you
128 can easily destroy all your data>."
130 (* You can supply zero or as many tests as you want per API call.
132 * Note that the test environment has 3 block devices, of size 500MB,
133 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
134 * a fourth squashfs block device with some known files on it (/dev/sdd).
136 * Note for partitioning purposes, the 500MB device has 63 cylinders.
138 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
140 * To be able to run the tests in a reasonable amount of time,
141 * the virtual machine and block devices are reused between tests.
142 * So don't try testing kill_subprocess :-x
144 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
146 * If the appliance is running an older Linux kernel (eg. RHEL 5) then
147 * devices are named /dev/hda etc. To cope with this, the test suite
148 * adds some hairly logic to detect this case, and then automagically
149 * replaces all strings which match "/dev/sd.*" with "/dev/hd.*".
150 * When writing test cases you shouldn't have to worry about this
153 * Don't assume anything about the previous contents of the block
154 * devices. Use 'Init*' to create some initial scenarios.
156 * You can add a prerequisite clause to any individual test. This
157 * is a run-time check, which, if it fails, causes the test to be
158 * skipped. Useful if testing a command which might not work on
159 * all variations of libguestfs builds. A test that has prerequisite
160 * of 'Always' is run unconditionally.
162 * In addition, packagers can skip individual tests by setting the
163 * environment variables: eg:
164 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
165 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
167 type tests = (test_init * test_prereq * test) list
169 (* Run the command sequence and just expect nothing to fail. *)
171 (* Run the command sequence and expect the output of the final
172 * command to be the string.
174 | TestOutput of seq * string
175 (* Run the command sequence and expect the output of the final
176 * command to be the list of strings.
178 | TestOutputList of seq * string list
179 (* Run the command sequence and expect the output of the final
180 * command to be the integer.
182 | TestOutputInt of seq * int
183 (* Run the command sequence and expect the output of the final
184 * command to be a true value (!= 0 or != NULL).
186 | TestOutputTrue of seq
187 (* Run the command sequence and expect the output of the final
188 * command to be a false value (== 0 or == NULL, but not an error).
190 | TestOutputFalse of seq
191 (* Run the command sequence and expect the output of the final
192 * command to be a list of the given length (but don't care about
195 | TestOutputLength of seq * int
196 (* Run the command sequence and expect the output of the final
197 * command to be a structure.
199 | TestOutputStruct of seq * test_field_compare list
200 (* Run the command sequence and expect the final command (only)
203 | TestLastFail of seq
205 and test_field_compare =
206 | CompareWithInt of string * int
207 | CompareWithString of string * string
208 | CompareFieldsIntEq of string * string
209 | CompareFieldsStrEq of string * string
211 (* Test prerequisites. *)
213 (* Test always runs. *)
215 (* Test is currently disabled - eg. it fails, or it tests some
216 * unimplemented feature.
219 (* 'string' is some C code (a function body) that should return
220 * true or false. The test will run if the code returns true.
223 (* As for 'If' but the test runs _unless_ the code returns true. *)
226 (* Some initial scenarios for testing. *)
228 (* Do nothing, block devices could contain random stuff including
229 * LVM PVs, and some filesystems might be mounted. This is usually
233 (* Block devices are empty and no filesystems are mounted. *)
235 (* /dev/sda contains a single partition /dev/sda1, which is formatted
236 * as ext2, empty [except for lost+found] and mounted on /.
237 * /dev/sdb and /dev/sdc may have random content.
242 * /dev/sda1 (is a PV):
243 * /dev/VG/LV (size 8MB):
244 * formatted as ext2, empty [except for lost+found], mounted on /
245 * /dev/sdb and /dev/sdc may have random content.
249 (* Sequence of commands for testing. *)
251 and cmd = string list
253 (* Note about long descriptions: When referring to another
254 * action, use the format C<guestfs_other> (ie. the full name of
255 * the C function). This will be replaced as appropriate in other
258 * Apart from that, long descriptions are just perldoc paragraphs.
261 (* These test functions are used in the language binding tests. *)
263 let test_all_args = [
266 StringList "strlist";
273 let test_all_rets = [
274 (* except for RErr, which is tested thoroughly elsewhere *)
275 "test0rint", RInt "valout";
276 "test0rint64", RInt64 "valout";
277 "test0rbool", RBool "valout";
278 "test0rconststring", RConstString "valout";
279 "test0rstring", RString "valout";
280 "test0rstringlist", RStringList "valout";
281 "test0rintbool", RIntBool ("valout", "valout");
282 "test0rpvlist", RPVList "valout";
283 "test0rvglist", RVGList "valout";
284 "test0rlvlist", RLVList "valout";
285 "test0rstat", RStat "valout";
286 "test0rstatvfs", RStatVFS "valout";
287 "test0rhashtable", RHashtable "valout";
290 let test_functions = [
291 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
293 "internal test function - do not use",
295 This is an internal test function which is used to test whether
296 the automatically generated bindings can handle every possible
297 parameter type correctly.
299 It echos the contents of each parameter to stdout.
301 You probably don't want to call this function.");
305 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
307 "internal test function - do not use",
309 This is an internal test function which is used to test whether
310 the automatically generated bindings can handle every possible
311 return type correctly.
313 It converts string C<val> to the return type.
315 You probably don't want to call this function.");
316 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
318 "internal test function - do not use",
320 This is an internal test function which is used to test whether
321 the automatically generated bindings can handle every possible
322 return type correctly.
324 This function always returns an error.
326 You probably don't want to call this function.")]
330 (* non_daemon_functions are any functions which don't get processed
331 * in the daemon, eg. functions for setting and getting local
332 * configuration values.
335 let non_daemon_functions = test_functions @ [
336 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
338 "launch the qemu subprocess",
340 Internally libguestfs is implemented by running a virtual machine
343 You should call this after configuring the handle
344 (eg. adding drives) but before performing any actions.");
346 ("wait_ready", (RErr, []), -1, [NotInFish],
348 "wait until the qemu subprocess launches",
350 Internally libguestfs is implemented by running a virtual machine
353 You should call this after C<guestfs_launch> to wait for the launch
356 ("kill_subprocess", (RErr, []), -1, [],
358 "kill the qemu subprocess",
360 This kills the qemu subprocess. You should never need to call this.");
362 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
364 "add an image to examine or modify",
366 This function adds a virtual machine disk image C<filename> to the
367 guest. The first time you call this function, the disk appears as IDE
368 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
371 You don't necessarily need to be root when using libguestfs. However
372 you obviously do need sufficient permissions to access the filename
373 for whatever operations you want to perform (ie. read access if you
374 just want to read the image or write access if you want to modify the
377 This is equivalent to the qemu parameter C<-drive file=filename>.");
379 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
381 "add a CD-ROM disk image to examine",
383 This function adds a virtual CD-ROM disk image to the guest.
385 This is equivalent to the qemu parameter C<-cdrom filename>.");
387 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
389 "add qemu parameters",
391 This can be used to add arbitrary qemu command line parameters
392 of the form C<-param value>. Actually it's not quite arbitrary - we
393 prevent you from setting some parameters which would interfere with
394 parameters that we use.
396 The first character of C<param> string must be a C<-> (dash).
398 C<value> can be NULL.");
400 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
402 "set the qemu binary",
404 Set the qemu binary that we will use.
406 The default is chosen when the library was compiled by the
409 You can also override this by setting the C<LIBGUESTFS_QEMU>
410 environment variable.
412 Setting C<qemu> to C<NULL> restores the default qemu binary.");
414 ("get_qemu", (RConstString "qemu", []), -1, [],
416 "get the qemu binary",
418 Return the current qemu binary.
420 This is always non-NULL. If it wasn't set already, then this will
421 return the default qemu binary name.");
423 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
425 "set the search path",
427 Set the path that libguestfs searches for kernel and initrd.img.
429 The default is C<$libdir/guestfs> unless overridden by setting
430 C<LIBGUESTFS_PATH> environment variable.
432 Setting C<path> to C<NULL> restores the default path.");
434 ("get_path", (RConstString "path", []), -1, [],
436 "get the search path",
438 Return the current search path.
440 This is always non-NULL. If it wasn't set already, then this will
441 return the default path.");
443 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
445 "add options to kernel command line",
447 This function is used to add additional options to the
448 guest kernel command line.
450 The default is C<NULL> unless overridden by setting
451 C<LIBGUESTFS_APPEND> environment variable.
453 Setting C<append> to C<NULL> means I<no> additional options
454 are passed (libguestfs always adds a few of its own).");
456 ("get_append", (RConstString "append", []), -1, [],
458 "get the additional kernel options",
460 Return the additional kernel options which are added to the
461 guest kernel command line.
463 If C<NULL> then no options are added.");
465 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
469 If C<autosync> is true, this enables autosync. Libguestfs will make a
470 best effort attempt to run C<guestfs_umount_all> followed by
471 C<guestfs_sync> when the handle is closed
472 (also if the program exits without closing handles).
474 This is disabled by default (except in guestfish where it is
475 enabled by default).");
477 ("get_autosync", (RBool "autosync", []), -1, [],
481 Get the autosync flag.");
483 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
487 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
489 Verbose messages are disabled unless the environment variable
490 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
492 ("get_verbose", (RBool "verbose", []), -1, [],
496 This returns the verbose messages flag.");
498 ("is_ready", (RBool "ready", []), -1, [],
500 "is ready to accept commands",
502 This returns true iff this handle is ready to accept commands
503 (in the C<READY> state).
505 For more information on states, see L<guestfs(3)>.");
507 ("is_config", (RBool "config", []), -1, [],
509 "is in configuration state",
511 This returns true iff this handle is being configured
512 (in the C<CONFIG> state).
514 For more information on states, see L<guestfs(3)>.");
516 ("is_launching", (RBool "launching", []), -1, [],
518 "is launching subprocess",
520 This returns true iff this handle is launching the subprocess
521 (in the C<LAUNCHING> state).
523 For more information on states, see L<guestfs(3)>.");
525 ("is_busy", (RBool "busy", []), -1, [],
527 "is busy processing a command",
529 This returns true iff this handle is busy processing a command
530 (in the C<BUSY> state).
532 For more information on states, see L<guestfs(3)>.");
534 ("get_state", (RInt "state", []), -1, [],
536 "get the current state",
538 This returns the current state as an opaque integer. This is
539 only useful for printing debug and internal error messages.
541 For more information on states, see L<guestfs(3)>.");
543 ("set_busy", (RErr, []), -1, [NotInFish],
547 This sets the state to C<BUSY>. This is only used when implementing
548 actions using the low-level API.
550 For more information on states, see L<guestfs(3)>.");
552 ("set_ready", (RErr, []), -1, [NotInFish],
554 "set state to ready",
556 This sets the state to C<READY>. This is only used when implementing
557 actions using the low-level API.
559 For more information on states, see L<guestfs(3)>.");
561 ("end_busy", (RErr, []), -1, [NotInFish],
563 "leave the busy state",
565 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
566 state as is. This is only used when implementing
567 actions using the low-level API.
569 For more information on states, see L<guestfs(3)>.");
573 (* daemon_functions are any functions which cause some action
574 * to take place in the daemon.
577 let daemon_functions = [
578 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
579 [InitEmpty, Always, TestOutput (
580 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
581 ["mkfs"; "ext2"; "/dev/sda1"];
582 ["mount"; "/dev/sda1"; "/"];
583 ["write_file"; "/new"; "new file contents"; "0"];
584 ["cat"; "/new"]], "new file contents")],
585 "mount a guest disk at a position in the filesystem",
587 Mount a guest disk at a position in the filesystem. Block devices
588 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
589 the guest. If those block devices contain partitions, they will have
590 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
593 The rules are the same as for L<mount(2)>: A filesystem must
594 first be mounted on C</> before others can be mounted. Other
595 filesystems can only be mounted on directories which already
598 The mounted filesystem is writable, if we have sufficient permissions
599 on the underlying device.
601 The filesystem options C<sync> and C<noatime> are set with this
602 call, in order to improve reliability.");
604 ("sync", (RErr, []), 2, [],
605 [ InitEmpty, Always, TestRun [["sync"]]],
606 "sync disks, writes are flushed through to the disk image",
608 This syncs the disk, so that any writes are flushed through to the
609 underlying disk image.
611 You should always call this if you have modified a disk image, before
612 closing the handle.");
614 ("touch", (RErr, [String "path"]), 3, [],
615 [InitBasicFS, Always, TestOutputTrue (
617 ["exists"; "/new"]])],
618 "update file timestamps or create a new file",
620 Touch acts like the L<touch(1)> command. It can be used to
621 update the timestamps on a file, or, if the file does not exist,
622 to create a new zero-length file.");
624 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
625 [InitBasicFS, Always, TestOutput (
626 [["write_file"; "/new"; "new file contents"; "0"];
627 ["cat"; "/new"]], "new file contents")],
628 "list the contents of a file",
630 Return the contents of the file named C<path>.
632 Note that this function cannot correctly handle binary files
633 (specifically, files containing C<\\0> character which is treated
634 as end of string). For those you need to use the C<guestfs_download>
635 function which has a more complex interface.");
637 ("ll", (RString "listing", [String "directory"]), 5, [],
638 [], (* XXX Tricky to test because it depends on the exact format
639 * of the 'ls -l' command, which changes between F10 and F11.
641 "list the files in a directory (long format)",
643 List the files in C<directory> (relative to the root directory,
644 there is no cwd) in the format of 'ls -la'.
646 This command is mostly useful for interactive sessions. It
647 is I<not> intended that you try to parse the output string.");
649 ("ls", (RStringList "listing", [String "directory"]), 6, [],
650 [InitBasicFS, Always, TestOutputList (
653 ["touch"; "/newest"];
654 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
655 "list the files in a directory",
657 List the files in C<directory> (relative to the root directory,
658 there is no cwd). The '.' and '..' entries are not returned, but
659 hidden files are shown.
661 This command is mostly useful for interactive sessions. Programs
662 should probably use C<guestfs_readdir> instead.");
664 ("list_devices", (RStringList "devices", []), 7, [],
665 [InitEmpty, Always, TestOutputList (
666 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
667 "list the block devices",
669 List all the block devices.
671 The full block device names are returned, eg. C</dev/sda>");
673 ("list_partitions", (RStringList "partitions", []), 8, [],
674 [InitBasicFS, Always, TestOutputList (
675 [["list_partitions"]], ["/dev/sda1"]);
676 InitEmpty, Always, TestOutputList (
677 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
678 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
679 "list the partitions",
681 List all the partitions detected on all block devices.
683 The full partition device names are returned, eg. C</dev/sda1>
685 This does not return logical volumes. For that you will need to
686 call C<guestfs_lvs>.");
688 ("pvs", (RStringList "physvols", []), 9, [],
689 [InitBasicFSonLVM, Always, TestOutputList (
690 [["pvs"]], ["/dev/sda1"]);
691 InitEmpty, Always, TestOutputList (
692 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
693 ["pvcreate"; "/dev/sda1"];
694 ["pvcreate"; "/dev/sda2"];
695 ["pvcreate"; "/dev/sda3"];
696 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
697 "list the LVM physical volumes (PVs)",
699 List all the physical volumes detected. This is the equivalent
700 of the L<pvs(8)> command.
702 This returns a list of just the device names that contain
703 PVs (eg. C</dev/sda2>).
705 See also C<guestfs_pvs_full>.");
707 ("vgs", (RStringList "volgroups", []), 10, [],
708 [InitBasicFSonLVM, Always, TestOutputList (
710 InitEmpty, Always, TestOutputList (
711 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
712 ["pvcreate"; "/dev/sda1"];
713 ["pvcreate"; "/dev/sda2"];
714 ["pvcreate"; "/dev/sda3"];
715 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
716 ["vgcreate"; "VG2"; "/dev/sda3"];
717 ["vgs"]], ["VG1"; "VG2"])],
718 "list the LVM volume groups (VGs)",
720 List all the volumes groups detected. This is the equivalent
721 of the L<vgs(8)> command.
723 This returns a list of just the volume group names that were
724 detected (eg. C<VolGroup00>).
726 See also C<guestfs_vgs_full>.");
728 ("lvs", (RStringList "logvols", []), 11, [],
729 [InitBasicFSonLVM, Always, TestOutputList (
730 [["lvs"]], ["/dev/VG/LV"]);
731 InitEmpty, Always, TestOutputList (
732 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
733 ["pvcreate"; "/dev/sda1"];
734 ["pvcreate"; "/dev/sda2"];
735 ["pvcreate"; "/dev/sda3"];
736 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
737 ["vgcreate"; "VG2"; "/dev/sda3"];
738 ["lvcreate"; "LV1"; "VG1"; "50"];
739 ["lvcreate"; "LV2"; "VG1"; "50"];
740 ["lvcreate"; "LV3"; "VG2"; "50"];
741 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
742 "list the LVM logical volumes (LVs)",
744 List all the logical volumes detected. This is the equivalent
745 of the L<lvs(8)> command.
747 This returns a list of the logical volume device names
748 (eg. C</dev/VolGroup00/LogVol00>).
750 See also C<guestfs_lvs_full>.");
752 ("pvs_full", (RPVList "physvols", []), 12, [],
753 [], (* XXX how to test? *)
754 "list the LVM physical volumes (PVs)",
756 List all the physical volumes detected. This is the equivalent
757 of the L<pvs(8)> command. The \"full\" version includes all fields.");
759 ("vgs_full", (RVGList "volgroups", []), 13, [],
760 [], (* XXX how to test? *)
761 "list the LVM volume groups (VGs)",
763 List all the volumes groups detected. This is the equivalent
764 of the L<vgs(8)> command. The \"full\" version includes all fields.");
766 ("lvs_full", (RLVList "logvols", []), 14, [],
767 [], (* XXX how to test? *)
768 "list the LVM logical volumes (LVs)",
770 List all the logical volumes detected. This is the equivalent
771 of the L<lvs(8)> command. The \"full\" version includes all fields.");
773 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
774 [InitBasicFS, Always, TestOutputList (
775 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
776 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
777 InitBasicFS, Always, TestOutputList (
778 [["write_file"; "/new"; ""; "0"];
779 ["read_lines"; "/new"]], [])],
780 "read file as lines",
782 Return the contents of the file named C<path>.
784 The file contents are returned as a list of lines. Trailing
785 C<LF> and C<CRLF> character sequences are I<not> returned.
787 Note that this function cannot correctly handle binary files
788 (specifically, files containing C<\\0> character which is treated
789 as end of line). For those you need to use the C<guestfs_read_file>
790 function which has a more complex interface.");
792 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
793 [], (* XXX Augeas code needs tests. *)
794 "create a new Augeas handle",
796 Create a new Augeas handle for editing configuration files.
797 If there was any previous Augeas handle associated with this
798 guestfs session, then it is closed.
800 You must call this before using any other C<guestfs_aug_*>
803 C<root> is the filesystem root. C<root> must not be NULL,
806 The flags are the same as the flags defined in
807 E<lt>augeas.hE<gt>, the logical I<or> of the following
812 =item C<AUG_SAVE_BACKUP> = 1
814 Keep the original file with a C<.augsave> extension.
816 =item C<AUG_SAVE_NEWFILE> = 2
818 Save changes into a file with extension C<.augnew>, and
819 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
821 =item C<AUG_TYPE_CHECK> = 4
823 Typecheck lenses (can be expensive).
825 =item C<AUG_NO_STDINC> = 8
827 Do not use standard load path for modules.
829 =item C<AUG_SAVE_NOOP> = 16
831 Make save a no-op, just record what would have been changed.
833 =item C<AUG_NO_LOAD> = 32
835 Do not load the tree in C<guestfs_aug_init>.
839 To close the handle, you can call C<guestfs_aug_close>.
841 To find out more about Augeas, see L<http://augeas.net/>.");
843 ("aug_close", (RErr, []), 26, [],
844 [], (* XXX Augeas code needs tests. *)
845 "close the current Augeas handle",
847 Close the current Augeas handle and free up any resources
848 used by it. After calling this, you have to call
849 C<guestfs_aug_init> again before you can use any other
852 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
853 [], (* XXX Augeas code needs tests. *)
854 "define an Augeas variable",
856 Defines an Augeas variable C<name> whose value is the result
857 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
860 On success this returns the number of nodes in C<expr>, or
861 C<0> if C<expr> evaluates to something which is not a nodeset.");
863 ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
864 [], (* XXX Augeas code needs tests. *)
865 "define an Augeas node",
867 Defines a variable C<name> whose value is the result of
870 If C<expr> evaluates to an empty nodeset, a node is created,
871 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
872 C<name> will be the nodeset containing that single node.
874 On success this returns a pair containing the
875 number of nodes in the nodeset, and a boolean flag
876 if a node was created.");
878 ("aug_get", (RString "val", [String "path"]), 19, [],
879 [], (* XXX Augeas code needs tests. *)
880 "look up the value of an Augeas path",
882 Look up the value associated with C<path>. If C<path>
883 matches exactly one node, the C<value> is returned.");
885 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
886 [], (* XXX Augeas code needs tests. *)
887 "set Augeas path to value",
889 Set the value associated with C<path> to C<value>.");
891 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
892 [], (* XXX Augeas code needs tests. *)
893 "insert a sibling Augeas node",
895 Create a new sibling C<label> for C<path>, inserting it into
896 the tree before or after C<path> (depending on the boolean
899 C<path> must match exactly one existing node in the tree, and
900 C<label> must be a label, ie. not contain C</>, C<*> or end
901 with a bracketed index C<[N]>.");
903 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
904 [], (* XXX Augeas code needs tests. *)
905 "remove an Augeas path",
907 Remove C<path> and all of its children.
909 On success this returns the number of entries which were removed.");
911 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
912 [], (* XXX Augeas code needs tests. *)
915 Move the node C<src> to C<dest>. C<src> must match exactly
916 one node. C<dest> is overwritten if it exists.");
918 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
919 [], (* XXX Augeas code needs tests. *)
920 "return Augeas nodes which match path",
922 Returns a list of paths which match the path expression C<path>.
923 The returned paths are sufficiently qualified so that they match
924 exactly one node in the current tree.");
926 ("aug_save", (RErr, []), 25, [],
927 [], (* XXX Augeas code needs tests. *)
928 "write all pending Augeas changes to disk",
930 This writes all pending changes to disk.
932 The flags which were passed to C<guestfs_aug_init> affect exactly
933 how files are saved.");
935 ("aug_load", (RErr, []), 27, [],
936 [], (* XXX Augeas code needs tests. *)
937 "load files into the tree",
939 Load files into the tree.
941 See C<aug_load> in the Augeas documentation for the full gory
944 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
945 [], (* XXX Augeas code needs tests. *)
946 "list Augeas nodes under a path",
948 This is just a shortcut for listing C<guestfs_aug_match>
949 C<path/*> and sorting the resulting nodes into alphabetical order.");
951 ("rm", (RErr, [String "path"]), 29, [],
952 [InitBasicFS, Always, TestRun
955 InitBasicFS, Always, TestLastFail
957 InitBasicFS, Always, TestLastFail
962 Remove the single file C<path>.");
964 ("rmdir", (RErr, [String "path"]), 30, [],
965 [InitBasicFS, Always, TestRun
968 InitBasicFS, Always, TestLastFail
970 InitBasicFS, Always, TestLastFail
973 "remove a directory",
975 Remove the single directory C<path>.");
977 ("rm_rf", (RErr, [String "path"]), 31, [],
978 [InitBasicFS, Always, TestOutputFalse
980 ["mkdir"; "/new/foo"];
981 ["touch"; "/new/foo/bar"];
983 ["exists"; "/new"]]],
984 "remove a file or directory recursively",
986 Remove the file or directory C<path>, recursively removing the
987 contents if its a directory. This is like the C<rm -rf> shell
990 ("mkdir", (RErr, [String "path"]), 32, [],
991 [InitBasicFS, Always, TestOutputTrue
994 InitBasicFS, Always, TestLastFail
995 [["mkdir"; "/new/foo/bar"]]],
996 "create a directory",
998 Create a directory named C<path>.");
1000 ("mkdir_p", (RErr, [String "path"]), 33, [],
1001 [InitBasicFS, Always, TestOutputTrue
1002 [["mkdir_p"; "/new/foo/bar"];
1003 ["is_dir"; "/new/foo/bar"]];
1004 InitBasicFS, Always, TestOutputTrue
1005 [["mkdir_p"; "/new/foo/bar"];
1006 ["is_dir"; "/new/foo"]];
1007 InitBasicFS, Always, TestOutputTrue
1008 [["mkdir_p"; "/new/foo/bar"];
1009 ["is_dir"; "/new"]];
1010 (* Regression tests for RHBZ#503133: *)
1011 InitBasicFS, Always, TestRun
1013 ["mkdir_p"; "/new"]];
1014 InitBasicFS, Always, TestLastFail
1016 ["mkdir_p"; "/new"]]],
1017 "create a directory and parents",
1019 Create a directory named C<path>, creating any parent directories
1020 as necessary. This is like the C<mkdir -p> shell command.");
1022 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1023 [], (* XXX Need stat command to test *)
1026 Change the mode (permissions) of C<path> to C<mode>. Only
1027 numeric modes are supported.");
1029 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1030 [], (* XXX Need stat command to test *)
1031 "change file owner and group",
1033 Change the file owner to C<owner> and group to C<group>.
1035 Only numeric uid and gid are supported. If you want to use
1036 names, you will need to locate and parse the password file
1037 yourself (Augeas support makes this relatively easy).");
1039 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1040 [InitBasicFS, Always, TestOutputTrue (
1042 ["exists"; "/new"]]);
1043 InitBasicFS, Always, TestOutputTrue (
1045 ["exists"; "/new"]])],
1046 "test if file or directory exists",
1048 This returns C<true> if and only if there is a file, directory
1049 (or anything) with the given C<path> name.
1051 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1053 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1054 [InitBasicFS, Always, TestOutputTrue (
1056 ["is_file"; "/new"]]);
1057 InitBasicFS, Always, TestOutputFalse (
1059 ["is_file"; "/new"]])],
1060 "test if file exists",
1062 This returns C<true> if and only if there is a file
1063 with the given C<path> name. Note that it returns false for
1064 other objects like directories.
1066 See also C<guestfs_stat>.");
1068 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1069 [InitBasicFS, Always, TestOutputFalse (
1071 ["is_dir"; "/new"]]);
1072 InitBasicFS, Always, TestOutputTrue (
1074 ["is_dir"; "/new"]])],
1075 "test if file exists",
1077 This returns C<true> if and only if there is a directory
1078 with the given C<path> name. Note that it returns false for
1079 other objects like files.
1081 See also C<guestfs_stat>.");
1083 ("pvcreate", (RErr, [String "device"]), 39, [],
1084 [InitEmpty, Always, TestOutputList (
1085 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1086 ["pvcreate"; "/dev/sda1"];
1087 ["pvcreate"; "/dev/sda2"];
1088 ["pvcreate"; "/dev/sda3"];
1089 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1090 "create an LVM physical volume",
1092 This creates an LVM physical volume on the named C<device>,
1093 where C<device> should usually be a partition name such
1096 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1097 [InitEmpty, Always, TestOutputList (
1098 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1099 ["pvcreate"; "/dev/sda1"];
1100 ["pvcreate"; "/dev/sda2"];
1101 ["pvcreate"; "/dev/sda3"];
1102 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1103 ["vgcreate"; "VG2"; "/dev/sda3"];
1104 ["vgs"]], ["VG1"; "VG2"])],
1105 "create an LVM volume group",
1107 This creates an LVM volume group called C<volgroup>
1108 from the non-empty list of physical volumes C<physvols>.");
1110 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1111 [InitEmpty, Always, TestOutputList (
1112 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1113 ["pvcreate"; "/dev/sda1"];
1114 ["pvcreate"; "/dev/sda2"];
1115 ["pvcreate"; "/dev/sda3"];
1116 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1117 ["vgcreate"; "VG2"; "/dev/sda3"];
1118 ["lvcreate"; "LV1"; "VG1"; "50"];
1119 ["lvcreate"; "LV2"; "VG1"; "50"];
1120 ["lvcreate"; "LV3"; "VG2"; "50"];
1121 ["lvcreate"; "LV4"; "VG2"; "50"];
1122 ["lvcreate"; "LV5"; "VG2"; "50"];
1124 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1125 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1126 "create an LVM volume group",
1128 This creates an LVM volume group called C<logvol>
1129 on the volume group C<volgroup>, with C<size> megabytes.");
1131 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1132 [InitEmpty, Always, TestOutput (
1133 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1134 ["mkfs"; "ext2"; "/dev/sda1"];
1135 ["mount"; "/dev/sda1"; "/"];
1136 ["write_file"; "/new"; "new file contents"; "0"];
1137 ["cat"; "/new"]], "new file contents")],
1138 "make a filesystem",
1140 This creates a filesystem on C<device> (usually a partition
1141 or LVM logical volume). The filesystem type is C<fstype>, for
1144 ("sfdisk", (RErr, [String "device";
1145 Int "cyls"; Int "heads"; Int "sectors";
1146 StringList "lines"]), 43, [DangerWillRobinson],
1148 "create partitions on a block device",
1150 This is a direct interface to the L<sfdisk(8)> program for creating
1151 partitions on block devices.
1153 C<device> should be a block device, for example C</dev/sda>.
1155 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1156 and sectors on the device, which are passed directly to sfdisk as
1157 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1158 of these, then the corresponding parameter is omitted. Usually for
1159 'large' disks, you can just pass C<0> for these, but for small
1160 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1161 out the right geometry and you will need to tell it.
1163 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1164 information refer to the L<sfdisk(8)> manpage.
1166 To create a single partition occupying the whole disk, you would
1167 pass C<lines> as a single element list, when the single element being
1168 the string C<,> (comma).
1170 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1172 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1173 [InitBasicFS, Always, TestOutput (
1174 [["write_file"; "/new"; "new file contents"; "0"];
1175 ["cat"; "/new"]], "new file contents");
1176 InitBasicFS, Always, TestOutput (
1177 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1178 ["cat"; "/new"]], "\nnew file contents\n");
1179 InitBasicFS, Always, TestOutput (
1180 [["write_file"; "/new"; "\n\n"; "0"];
1181 ["cat"; "/new"]], "\n\n");
1182 InitBasicFS, Always, TestOutput (
1183 [["write_file"; "/new"; ""; "0"];
1184 ["cat"; "/new"]], "");
1185 InitBasicFS, Always, TestOutput (
1186 [["write_file"; "/new"; "\n\n\n"; "0"];
1187 ["cat"; "/new"]], "\n\n\n");
1188 InitBasicFS, Always, TestOutput (
1189 [["write_file"; "/new"; "\n"; "0"];
1190 ["cat"; "/new"]], "\n")],
1193 This call creates a file called C<path>. The contents of the
1194 file is the string C<content> (which can contain any 8 bit data),
1195 with length C<size>.
1197 As a special case, if C<size> is C<0>
1198 then the length is calculated using C<strlen> (so in this case
1199 the content cannot contain embedded ASCII NULs).
1201 I<NB.> Owing to a bug, writing content containing ASCII NUL
1202 characters does I<not> work, even if the length is specified.
1203 We hope to resolve this bug in a future version. In the meantime
1204 use C<guestfs_upload>.");
1206 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1207 [InitEmpty, Always, TestOutputList (
1208 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1209 ["mkfs"; "ext2"; "/dev/sda1"];
1210 ["mount"; "/dev/sda1"; "/"];
1211 ["mounts"]], ["/dev/sda1"]);
1212 InitEmpty, Always, TestOutputList (
1213 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1214 ["mkfs"; "ext2"; "/dev/sda1"];
1215 ["mount"; "/dev/sda1"; "/"];
1218 "unmount a filesystem",
1220 This unmounts the given filesystem. The filesystem may be
1221 specified either by its mountpoint (path) or the device which
1222 contains the filesystem.");
1224 ("mounts", (RStringList "devices", []), 46, [],
1225 [InitBasicFS, Always, TestOutputList (
1226 [["mounts"]], ["/dev/sda1"])],
1227 "show mounted filesystems",
1229 This returns the list of currently mounted filesystems. It returns
1230 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1232 Some internal mounts are not shown.");
1234 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1235 [InitBasicFS, Always, TestOutputList (
1238 (* check that umount_all can unmount nested mounts correctly: *)
1239 InitEmpty, Always, TestOutputList (
1240 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1241 ["mkfs"; "ext2"; "/dev/sda1"];
1242 ["mkfs"; "ext2"; "/dev/sda2"];
1243 ["mkfs"; "ext2"; "/dev/sda3"];
1244 ["mount"; "/dev/sda1"; "/"];
1246 ["mount"; "/dev/sda2"; "/mp1"];
1247 ["mkdir"; "/mp1/mp2"];
1248 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1249 ["mkdir"; "/mp1/mp2/mp3"];
1252 "unmount all filesystems",
1254 This unmounts all mounted filesystems.
1256 Some internal mounts are not unmounted by this call.");
1258 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1260 "remove all LVM LVs, VGs and PVs",
1262 This command removes all LVM logical volumes, volume groups
1263 and physical volumes.");
1265 ("file", (RString "description", [String "path"]), 49, [],
1266 [InitBasicFS, Always, TestOutput (
1268 ["file"; "/new"]], "empty");
1269 InitBasicFS, Always, TestOutput (
1270 [["write_file"; "/new"; "some content\n"; "0"];
1271 ["file"; "/new"]], "ASCII text");
1272 InitBasicFS, Always, TestLastFail (
1273 [["file"; "/nofile"]])],
1274 "determine file type",
1276 This call uses the standard L<file(1)> command to determine
1277 the type or contents of the file. This also works on devices,
1278 for example to find out whether a partition contains a filesystem.
1280 The exact command which runs is C<file -bsL path>. Note in
1281 particular that the filename is not prepended to the output
1282 (the C<-b> option).");
1284 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1285 [InitBasicFS, Always, TestOutput (
1286 [["upload"; "test-command"; "/test-command"];
1287 ["chmod"; "493"; "/test-command"];
1288 ["command"; "/test-command 1"]], "Result1");
1289 InitBasicFS, Always, TestOutput (
1290 [["upload"; "test-command"; "/test-command"];
1291 ["chmod"; "493"; "/test-command"];
1292 ["command"; "/test-command 2"]], "Result2\n");
1293 InitBasicFS, Always, TestOutput (
1294 [["upload"; "test-command"; "/test-command"];
1295 ["chmod"; "493"; "/test-command"];
1296 ["command"; "/test-command 3"]], "\nResult3");
1297 InitBasicFS, Always, TestOutput (
1298 [["upload"; "test-command"; "/test-command"];
1299 ["chmod"; "493"; "/test-command"];
1300 ["command"; "/test-command 4"]], "\nResult4\n");
1301 InitBasicFS, Always, TestOutput (
1302 [["upload"; "test-command"; "/test-command"];
1303 ["chmod"; "493"; "/test-command"];
1304 ["command"; "/test-command 5"]], "\nResult5\n\n");
1305 InitBasicFS, Always, TestOutput (
1306 [["upload"; "test-command"; "/test-command"];
1307 ["chmod"; "493"; "/test-command"];
1308 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1309 InitBasicFS, Always, TestOutput (
1310 [["upload"; "test-command"; "/test-command"];
1311 ["chmod"; "493"; "/test-command"];
1312 ["command"; "/test-command 7"]], "");
1313 InitBasicFS, Always, TestOutput (
1314 [["upload"; "test-command"; "/test-command"];
1315 ["chmod"; "493"; "/test-command"];
1316 ["command"; "/test-command 8"]], "\n");
1317 InitBasicFS, Always, TestOutput (
1318 [["upload"; "test-command"; "/test-command"];
1319 ["chmod"; "493"; "/test-command"];
1320 ["command"; "/test-command 9"]], "\n\n");
1321 InitBasicFS, Always, TestOutput (
1322 [["upload"; "test-command"; "/test-command"];
1323 ["chmod"; "493"; "/test-command"];
1324 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1325 InitBasicFS, Always, TestOutput (
1326 [["upload"; "test-command"; "/test-command"];
1327 ["chmod"; "493"; "/test-command"];
1328 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1329 InitBasicFS, Always, TestLastFail (
1330 [["upload"; "test-command"; "/test-command"];
1331 ["chmod"; "493"; "/test-command"];
1332 ["command"; "/test-command"]])],
1333 "run a command from the guest filesystem",
1335 This call runs a command from the guest filesystem. The
1336 filesystem must be mounted, and must contain a compatible
1337 operating system (ie. something Linux, with the same
1338 or compatible processor architecture).
1340 The single parameter is an argv-style list of arguments.
1341 The first element is the name of the program to run.
1342 Subsequent elements are parameters. The list must be
1343 non-empty (ie. must contain a program name).
1345 The return value is anything printed to I<stdout> by
1348 If the command returns a non-zero exit status, then
1349 this function returns an error message. The error message
1350 string is the content of I<stderr> from the command.
1352 The C<$PATH> environment variable will contain at least
1353 C</usr/bin> and C</bin>. If you require a program from
1354 another location, you should provide the full path in the
1357 Shared libraries and data files required by the program
1358 must be available on filesystems which are mounted in the
1359 correct places. It is the caller's responsibility to ensure
1360 all filesystems that are needed are mounted at the right
1363 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1364 [InitBasicFS, Always, TestOutputList (
1365 [["upload"; "test-command"; "/test-command"];
1366 ["chmod"; "493"; "/test-command"];
1367 ["command_lines"; "/test-command 1"]], ["Result1"]);
1368 InitBasicFS, Always, TestOutputList (
1369 [["upload"; "test-command"; "/test-command"];
1370 ["chmod"; "493"; "/test-command"];
1371 ["command_lines"; "/test-command 2"]], ["Result2"]);
1372 InitBasicFS, Always, TestOutputList (
1373 [["upload"; "test-command"; "/test-command"];
1374 ["chmod"; "493"; "/test-command"];
1375 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1376 InitBasicFS, Always, TestOutputList (
1377 [["upload"; "test-command"; "/test-command"];
1378 ["chmod"; "493"; "/test-command"];
1379 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1380 InitBasicFS, Always, TestOutputList (
1381 [["upload"; "test-command"; "/test-command"];
1382 ["chmod"; "493"; "/test-command"];
1383 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1384 InitBasicFS, Always, TestOutputList (
1385 [["upload"; "test-command"; "/test-command"];
1386 ["chmod"; "493"; "/test-command"];
1387 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1388 InitBasicFS, Always, TestOutputList (
1389 [["upload"; "test-command"; "/test-command"];
1390 ["chmod"; "493"; "/test-command"];
1391 ["command_lines"; "/test-command 7"]], []);
1392 InitBasicFS, Always, TestOutputList (
1393 [["upload"; "test-command"; "/test-command"];
1394 ["chmod"; "493"; "/test-command"];
1395 ["command_lines"; "/test-command 8"]], [""]);
1396 InitBasicFS, Always, TestOutputList (
1397 [["upload"; "test-command"; "/test-command"];
1398 ["chmod"; "493"; "/test-command"];
1399 ["command_lines"; "/test-command 9"]], ["";""]);
1400 InitBasicFS, Always, TestOutputList (
1401 [["upload"; "test-command"; "/test-command"];
1402 ["chmod"; "493"; "/test-command"];
1403 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1404 InitBasicFS, Always, TestOutputList (
1405 [["upload"; "test-command"; "/test-command"];
1406 ["chmod"; "493"; "/test-command"];
1407 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1408 "run a command, returning lines",
1410 This is the same as C<guestfs_command>, but splits the
1411 result into a list of lines.");
1413 ("stat", (RStat "statbuf", [String "path"]), 52, [],
1414 [InitBasicFS, Always, TestOutputStruct (
1416 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1417 "get file information",
1419 Returns file information for the given C<path>.
1421 This is the same as the C<stat(2)> system call.");
1423 ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1424 [InitBasicFS, Always, TestOutputStruct (
1426 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1427 "get file information for a symbolic link",
1429 Returns file information for the given C<path>.
1431 This is the same as C<guestfs_stat> except that if C<path>
1432 is a symbolic link, then the link is stat-ed, not the file it
1435 This is the same as the C<lstat(2)> system call.");
1437 ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1438 [InitBasicFS, Always, TestOutputStruct (
1439 [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1440 CompareWithInt ("blocks", 490020);
1441 CompareWithInt ("bsize", 1024)])],
1442 "get file system statistics",
1444 Returns file system statistics for any mounted file system.
1445 C<path> should be a file or directory in the mounted file system
1446 (typically it is the mount point itself, but it doesn't need to be).
1448 This is the same as the C<statvfs(2)> system call.");
1450 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1452 "get ext2/ext3/ext4 superblock details",
1454 This returns the contents of the ext2, ext3 or ext4 filesystem
1455 superblock on C<device>.
1457 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1458 manpage for more details. The list of fields returned isn't
1459 clearly defined, and depends on both the version of C<tune2fs>
1460 that libguestfs was built against, and the filesystem itself.");
1462 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1463 [InitEmpty, Always, TestOutputTrue (
1464 [["blockdev_setro"; "/dev/sda"];
1465 ["blockdev_getro"; "/dev/sda"]])],
1466 "set block device to read-only",
1468 Sets the block device named C<device> to read-only.
1470 This uses the L<blockdev(8)> command.");
1472 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1473 [InitEmpty, Always, TestOutputFalse (
1474 [["blockdev_setrw"; "/dev/sda"];
1475 ["blockdev_getro"; "/dev/sda"]])],
1476 "set block device to read-write",
1478 Sets the block device named C<device> to read-write.
1480 This uses the L<blockdev(8)> command.");
1482 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1483 [InitEmpty, Always, TestOutputTrue (
1484 [["blockdev_setro"; "/dev/sda"];
1485 ["blockdev_getro"; "/dev/sda"]])],
1486 "is block device set to read-only",
1488 Returns a boolean indicating if the block device is read-only
1489 (true if read-only, false if not).
1491 This uses the L<blockdev(8)> command.");
1493 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1494 [InitEmpty, Always, TestOutputInt (
1495 [["blockdev_getss"; "/dev/sda"]], 512)],
1496 "get sectorsize of block device",
1498 This returns the size of sectors on a block device.
1499 Usually 512, but can be larger for modern devices.
1501 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1504 This uses the L<blockdev(8)> command.");
1506 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1507 [InitEmpty, Always, TestOutputInt (
1508 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1509 "get blocksize of block device",
1511 This returns the block size of a device.
1513 (Note this is different from both I<size in blocks> and
1514 I<filesystem block size>).
1516 This uses the L<blockdev(8)> command.");
1518 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1520 "set blocksize of block device",
1522 This sets the block size of a device.
1524 (Note this is different from both I<size in blocks> and
1525 I<filesystem block size>).
1527 This uses the L<blockdev(8)> command.");
1529 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1530 [InitEmpty, Always, TestOutputInt (
1531 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1532 "get total size of device in 512-byte sectors",
1534 This returns the size of the device in units of 512-byte sectors
1535 (even if the sectorsize isn't 512 bytes ... weird).
1537 See also C<guestfs_blockdev_getss> for the real sector size of
1538 the device, and C<guestfs_blockdev_getsize64> for the more
1539 useful I<size in bytes>.
1541 This uses the L<blockdev(8)> command.");
1543 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1544 [InitEmpty, Always, TestOutputInt (
1545 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1546 "get total size of device in bytes",
1548 This returns the size of the device in bytes.
1550 See also C<guestfs_blockdev_getsz>.
1552 This uses the L<blockdev(8)> command.");
1554 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1555 [InitEmpty, Always, TestRun
1556 [["blockdev_flushbufs"; "/dev/sda"]]],
1557 "flush device buffers",
1559 This tells the kernel to flush internal buffers associated
1562 This uses the L<blockdev(8)> command.");
1564 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1565 [InitEmpty, Always, TestRun
1566 [["blockdev_rereadpt"; "/dev/sda"]]],
1567 "reread partition table",
1569 Reread the partition table on C<device>.
1571 This uses the L<blockdev(8)> command.");
1573 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1574 [InitBasicFS, Always, TestOutput (
1575 (* Pick a file from cwd which isn't likely to change. *)
1576 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1577 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1578 "upload a file from the local machine",
1580 Upload local file C<filename> to C<remotefilename> on the
1583 C<filename> can also be a named pipe.
1585 See also C<guestfs_download>.");
1587 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1588 [InitBasicFS, Always, TestOutput (
1589 (* Pick a file from cwd which isn't likely to change. *)
1590 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1591 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1592 ["upload"; "testdownload.tmp"; "/upload"];
1593 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1594 "download a file to the local machine",
1596 Download file C<remotefilename> and save it as C<filename>
1597 on the local machine.
1599 C<filename> can also be a named pipe.
1601 See also C<guestfs_upload>, C<guestfs_cat>.");
1603 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1604 [InitBasicFS, Always, TestOutput (
1605 [["write_file"; "/new"; "test\n"; "0"];
1606 ["checksum"; "crc"; "/new"]], "935282863");
1607 InitBasicFS, Always, TestLastFail (
1608 [["checksum"; "crc"; "/new"]]);
1609 InitBasicFS, Always, TestOutput (
1610 [["write_file"; "/new"; "test\n"; "0"];
1611 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1612 InitBasicFS, Always, TestOutput (
1613 [["write_file"; "/new"; "test\n"; "0"];
1614 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1615 InitBasicFS, Always, TestOutput (
1616 [["write_file"; "/new"; "test\n"; "0"];
1617 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1618 InitBasicFS, Always, TestOutput (
1619 [["write_file"; "/new"; "test\n"; "0"];
1620 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1621 InitBasicFS, Always, TestOutput (
1622 [["write_file"; "/new"; "test\n"; "0"];
1623 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1624 InitBasicFS, Always, TestOutput (
1625 [["write_file"; "/new"; "test\n"; "0"];
1626 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1627 InitBasicFS, Always, TestOutput (
1628 [["mount"; "/dev/sdd"; "/"];
1629 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1630 "compute MD5, SHAx or CRC checksum of file",
1632 This call computes the MD5, SHAx or CRC checksum of the
1635 The type of checksum to compute is given by the C<csumtype>
1636 parameter which must have one of the following values:
1642 Compute the cyclic redundancy check (CRC) specified by POSIX
1643 for the C<cksum> command.
1647 Compute the MD5 hash (using the C<md5sum> program).
1651 Compute the SHA1 hash (using the C<sha1sum> program).
1655 Compute the SHA224 hash (using the C<sha224sum> program).
1659 Compute the SHA256 hash (using the C<sha256sum> program).
1663 Compute the SHA384 hash (using the C<sha384sum> program).
1667 Compute the SHA512 hash (using the C<sha512sum> program).
1671 The checksum is returned as a printable string.");
1673 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1674 [InitBasicFS, Always, TestOutput (
1675 [["tar_in"; "../images/helloworld.tar"; "/"];
1676 ["cat"; "/hello"]], "hello\n")],
1677 "unpack tarfile to directory",
1679 This command uploads and unpacks local file C<tarfile> (an
1680 I<uncompressed> tar file) into C<directory>.
1682 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1684 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1686 "pack directory into tarfile",
1688 This command packs the contents of C<directory> and downloads
1689 it to local file C<tarfile>.
1691 To download a compressed tarball, use C<guestfs_tgz_out>.");
1693 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1694 [InitBasicFS, Always, TestOutput (
1695 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1696 ["cat"; "/hello"]], "hello\n")],
1697 "unpack compressed tarball to directory",
1699 This command uploads and unpacks local file C<tarball> (a
1700 I<gzip compressed> tar file) into C<directory>.
1702 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1704 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1706 "pack directory into compressed tarball",
1708 This command packs the contents of C<directory> and downloads
1709 it to local file C<tarball>.
1711 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1713 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1714 [InitBasicFS, Always, TestLastFail (
1716 ["mount_ro"; "/dev/sda1"; "/"];
1717 ["touch"; "/new"]]);
1718 InitBasicFS, Always, TestOutput (
1719 [["write_file"; "/new"; "data"; "0"];
1721 ["mount_ro"; "/dev/sda1"; "/"];
1722 ["cat"; "/new"]], "data")],
1723 "mount a guest disk, read-only",
1725 This is the same as the C<guestfs_mount> command, but it
1726 mounts the filesystem with the read-only (I<-o ro>) flag.");
1728 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1730 "mount a guest disk with mount options",
1732 This is the same as the C<guestfs_mount> command, but it
1733 allows you to set the mount options as for the
1734 L<mount(8)> I<-o> flag.");
1736 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1738 "mount a guest disk with mount options and vfstype",
1740 This is the same as the C<guestfs_mount> command, but it
1741 allows you to set both the mount options and the vfstype
1742 as for the L<mount(8)> I<-o> and I<-t> flags.");
1744 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1746 "debugging and internals",
1748 The C<guestfs_debug> command exposes some internals of
1749 C<guestfsd> (the guestfs daemon) that runs inside the
1752 There is no comprehensive help for this command. You have
1753 to look at the file C<daemon/debug.c> in the libguestfs source
1754 to find out what you can do.");
1756 ("lvremove", (RErr, [String "device"]), 77, [],
1757 [InitEmpty, Always, TestOutputList (
1758 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1759 ["pvcreate"; "/dev/sda1"];
1760 ["vgcreate"; "VG"; "/dev/sda1"];
1761 ["lvcreate"; "LV1"; "VG"; "50"];
1762 ["lvcreate"; "LV2"; "VG"; "50"];
1763 ["lvremove"; "/dev/VG/LV1"];
1764 ["lvs"]], ["/dev/VG/LV2"]);
1765 InitEmpty, Always, TestOutputList (
1766 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1767 ["pvcreate"; "/dev/sda1"];
1768 ["vgcreate"; "VG"; "/dev/sda1"];
1769 ["lvcreate"; "LV1"; "VG"; "50"];
1770 ["lvcreate"; "LV2"; "VG"; "50"];
1771 ["lvremove"; "/dev/VG"];
1773 InitEmpty, Always, TestOutputList (
1774 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1775 ["pvcreate"; "/dev/sda1"];
1776 ["vgcreate"; "VG"; "/dev/sda1"];
1777 ["lvcreate"; "LV1"; "VG"; "50"];
1778 ["lvcreate"; "LV2"; "VG"; "50"];
1779 ["lvremove"; "/dev/VG"];
1781 "remove an LVM logical volume",
1783 Remove an LVM logical volume C<device>, where C<device> is
1784 the path to the LV, such as C</dev/VG/LV>.
1786 You can also remove all LVs in a volume group by specifying
1787 the VG name, C</dev/VG>.");
1789 ("vgremove", (RErr, [String "vgname"]), 78, [],
1790 [InitEmpty, Always, TestOutputList (
1791 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1792 ["pvcreate"; "/dev/sda1"];
1793 ["vgcreate"; "VG"; "/dev/sda1"];
1794 ["lvcreate"; "LV1"; "VG"; "50"];
1795 ["lvcreate"; "LV2"; "VG"; "50"];
1798 InitEmpty, Always, TestOutputList (
1799 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1800 ["pvcreate"; "/dev/sda1"];
1801 ["vgcreate"; "VG"; "/dev/sda1"];
1802 ["lvcreate"; "LV1"; "VG"; "50"];
1803 ["lvcreate"; "LV2"; "VG"; "50"];
1806 "remove an LVM volume group",
1808 Remove an LVM volume group C<vgname>, (for example C<VG>).
1810 This also forcibly removes all logical volumes in the volume
1813 ("pvremove", (RErr, [String "device"]), 79, [],
1814 [InitEmpty, Always, TestOutputList (
1815 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1816 ["pvcreate"; "/dev/sda1"];
1817 ["vgcreate"; "VG"; "/dev/sda1"];
1818 ["lvcreate"; "LV1"; "VG"; "50"];
1819 ["lvcreate"; "LV2"; "VG"; "50"];
1821 ["pvremove"; "/dev/sda1"];
1823 InitEmpty, Always, TestOutputList (
1824 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1825 ["pvcreate"; "/dev/sda1"];
1826 ["vgcreate"; "VG"; "/dev/sda1"];
1827 ["lvcreate"; "LV1"; "VG"; "50"];
1828 ["lvcreate"; "LV2"; "VG"; "50"];
1830 ["pvremove"; "/dev/sda1"];
1832 InitEmpty, Always, TestOutputList (
1833 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1834 ["pvcreate"; "/dev/sda1"];
1835 ["vgcreate"; "VG"; "/dev/sda1"];
1836 ["lvcreate"; "LV1"; "VG"; "50"];
1837 ["lvcreate"; "LV2"; "VG"; "50"];
1839 ["pvremove"; "/dev/sda1"];
1841 "remove an LVM physical volume",
1843 This wipes a physical volume C<device> so that LVM will no longer
1846 The implementation uses the C<pvremove> command which refuses to
1847 wipe physical volumes that contain any volume groups, so you have
1848 to remove those first.");
1850 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1851 [InitBasicFS, Always, TestOutput (
1852 [["set_e2label"; "/dev/sda1"; "testlabel"];
1853 ["get_e2label"; "/dev/sda1"]], "testlabel")],
1854 "set the ext2/3/4 filesystem label",
1856 This sets the ext2/3/4 filesystem label of the filesystem on
1857 C<device> to C<label>. Filesystem labels are limited to
1860 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1861 to return the existing label on a filesystem.");
1863 ("get_e2label", (RString "label", [String "device"]), 81, [],
1865 "get the ext2/3/4 filesystem label",
1867 This returns the ext2/3/4 filesystem label of the filesystem on
1870 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1871 [InitBasicFS, Always, TestOutput (
1872 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1873 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1874 InitBasicFS, Always, TestOutput (
1875 [["set_e2uuid"; "/dev/sda1"; "clear"];
1876 ["get_e2uuid"; "/dev/sda1"]], "");
1877 (* We can't predict what UUIDs will be, so just check the commands run. *)
1878 InitBasicFS, Always, TestRun (
1879 [["set_e2uuid"; "/dev/sda1"; "random"]]);
1880 InitBasicFS, Always, TestRun (
1881 [["set_e2uuid"; "/dev/sda1"; "time"]])],
1882 "set the ext2/3/4 filesystem UUID",
1884 This sets the ext2/3/4 filesystem UUID of the filesystem on
1885 C<device> to C<uuid>. The format of the UUID and alternatives
1886 such as C<clear>, C<random> and C<time> are described in the
1887 L<tune2fs(8)> manpage.
1889 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1890 to return the existing UUID of a filesystem.");
1892 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1894 "get the ext2/3/4 filesystem UUID",
1896 This returns the ext2/3/4 filesystem UUID of the filesystem on
1899 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1900 [InitBasicFS, Always, TestOutputInt (
1901 [["umount"; "/dev/sda1"];
1902 ["fsck"; "ext2"; "/dev/sda1"]], 0);
1903 InitBasicFS, Always, TestOutputInt (
1904 [["umount"; "/dev/sda1"];
1905 ["zero"; "/dev/sda1"];
1906 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1907 "run the filesystem checker",
1909 This runs the filesystem checker (fsck) on C<device> which
1910 should have filesystem type C<fstype>.
1912 The returned integer is the status. See L<fsck(8)> for the
1913 list of status codes from C<fsck>.
1921 Multiple status codes can be summed together.
1925 A non-zero return code can mean \"success\", for example if
1926 errors have been corrected on the filesystem.
1930 Checking or repairing NTFS volumes is not supported
1935 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1937 ("zero", (RErr, [String "device"]), 85, [],
1938 [InitBasicFS, Always, TestOutput (
1939 [["umount"; "/dev/sda1"];
1940 ["zero"; "/dev/sda1"];
1941 ["file"; "/dev/sda1"]], "data")],
1942 "write zeroes to the device",
1944 This command writes zeroes over the first few blocks of C<device>.
1946 How many blocks are zeroed isn't specified (but it's I<not> enough
1947 to securely wipe the device). It should be sufficient to remove
1948 any partition tables, filesystem superblocks and so on.");
1950 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1951 [InitBasicFS, Always, TestOutputTrue (
1952 [["grub_install"; "/"; "/dev/sda1"];
1953 ["is_dir"; "/boot"]])],
1956 This command installs GRUB (the Grand Unified Bootloader) on
1957 C<device>, with the root directory being C<root>.");
1959 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1960 [InitBasicFS, Always, TestOutput (
1961 [["write_file"; "/old"; "file content"; "0"];
1962 ["cp"; "/old"; "/new"];
1963 ["cat"; "/new"]], "file content");
1964 InitBasicFS, Always, TestOutputTrue (
1965 [["write_file"; "/old"; "file content"; "0"];
1966 ["cp"; "/old"; "/new"];
1967 ["is_file"; "/old"]]);
1968 InitBasicFS, Always, TestOutput (
1969 [["write_file"; "/old"; "file content"; "0"];
1971 ["cp"; "/old"; "/dir/new"];
1972 ["cat"; "/dir/new"]], "file content")],
1975 This copies a file from C<src> to C<dest> where C<dest> is
1976 either a destination filename or destination directory.");
1978 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
1979 [InitBasicFS, Always, TestOutput (
1980 [["mkdir"; "/olddir"];
1981 ["mkdir"; "/newdir"];
1982 ["write_file"; "/olddir/file"; "file content"; "0"];
1983 ["cp_a"; "/olddir"; "/newdir"];
1984 ["cat"; "/newdir/olddir/file"]], "file content")],
1985 "copy a file or directory recursively",
1987 This copies a file or directory from C<src> to C<dest>
1988 recursively using the C<cp -a> command.");
1990 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
1991 [InitBasicFS, Always, TestOutput (
1992 [["write_file"; "/old"; "file content"; "0"];
1993 ["mv"; "/old"; "/new"];
1994 ["cat"; "/new"]], "file content");
1995 InitBasicFS, Always, TestOutputFalse (
1996 [["write_file"; "/old"; "file content"; "0"];
1997 ["mv"; "/old"; "/new"];
1998 ["is_file"; "/old"]])],
2001 This moves a file from C<src> to C<dest> where C<dest> is
2002 either a destination filename or destination directory.");
2004 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2005 [InitEmpty, Always, TestRun (
2006 [["drop_caches"; "3"]])],
2007 "drop kernel page cache, dentries and inodes",
2009 This instructs the guest kernel to drop its page cache,
2010 and/or dentries and inode caches. The parameter C<whattodrop>
2011 tells the kernel what precisely to drop, see
2012 L<http://linux-mm.org/Drop_Caches>
2014 Setting C<whattodrop> to 3 should drop everything.
2016 This automatically calls L<sync(2)> before the operation,
2017 so that the maximum guest memory is freed.");
2019 ("dmesg", (RString "kmsgs", []), 91, [],
2020 [InitEmpty, Always, TestRun (
2022 "return kernel messages",
2024 This returns the kernel messages (C<dmesg> output) from
2025 the guest kernel. This is sometimes useful for extended
2026 debugging of problems.
2028 Another way to get the same information is to enable
2029 verbose messages with C<guestfs_set_verbose> or by setting
2030 the environment variable C<LIBGUESTFS_DEBUG=1> before
2031 running the program.");
2033 ("ping_daemon", (RErr, []), 92, [],
2034 [InitEmpty, Always, TestRun (
2035 [["ping_daemon"]])],
2036 "ping the guest daemon",
2038 This is a test probe into the guestfs daemon running inside
2039 the qemu subprocess. Calling this function checks that the
2040 daemon responds to the ping message, without affecting the daemon
2041 or attached block device(s) in any other way.");
2043 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2044 [InitBasicFS, Always, TestOutputTrue (
2045 [["write_file"; "/file1"; "contents of a file"; "0"];
2046 ["cp"; "/file1"; "/file2"];
2047 ["equal"; "/file1"; "/file2"]]);
2048 InitBasicFS, Always, TestOutputFalse (
2049 [["write_file"; "/file1"; "contents of a file"; "0"];
2050 ["write_file"; "/file2"; "contents of another file"; "0"];
2051 ["equal"; "/file1"; "/file2"]]);
2052 InitBasicFS, Always, TestLastFail (
2053 [["equal"; "/file1"; "/file2"]])],
2054 "test if two files have equal contents",
2056 This compares the two files C<file1> and C<file2> and returns
2057 true if their content is exactly equal, or false otherwise.
2059 The external L<cmp(1)> program is used for the comparison.");
2061 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2062 [InitBasicFS, Always, TestOutputList (
2063 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2064 ["strings"; "/new"]], ["hello"; "world"]);
2065 InitBasicFS, Always, TestOutputList (
2067 ["strings"; "/new"]], [])],
2068 "print the printable strings in a file",
2070 This runs the L<strings(1)> command on a file and returns
2071 the list of printable strings found.");
2073 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2074 [InitBasicFS, Always, TestOutputList (
2075 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2076 ["strings_e"; "b"; "/new"]], []);
2077 InitBasicFS, Disabled, TestOutputList (
2078 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2079 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2080 "print the printable strings in a file",
2082 This is like the C<guestfs_strings> command, but allows you to
2083 specify the encoding.
2085 See the L<strings(1)> manpage for the full list of encodings.
2087 Commonly useful encodings are C<l> (lower case L) which will
2088 show strings inside Windows/x86 files.
2090 The returned strings are transcoded to UTF-8.");
2092 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2093 [InitBasicFS, Always, TestOutput (
2094 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2095 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n")],
2096 "dump a file in hexadecimal",
2098 This runs C<hexdump -C> on the given C<path>. The result is
2099 the human-readable, canonical hex dump of the file.");
2101 ("zerofree", (RErr, [String "device"]), 97, [],
2102 [InitNone, Always, TestOutput (
2103 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2104 ["mkfs"; "ext3"; "/dev/sda1"];
2105 ["mount"; "/dev/sda1"; "/"];
2106 ["write_file"; "/new"; "test file"; "0"];
2107 ["umount"; "/dev/sda1"];
2108 ["zerofree"; "/dev/sda1"];
2109 ["mount"; "/dev/sda1"; "/"];
2110 ["cat"; "/new"]], "test file")],
2111 "zero unused inodes and disk blocks on ext2/3 filesystem",
2113 This runs the I<zerofree> program on C<device>. This program
2114 claims to zero unused inodes and disk blocks on an ext2/3
2115 filesystem, thus making it possible to compress the filesystem
2118 You should B<not> run this program if the filesystem is
2121 It is possible that using this program can damage the filesystem
2122 or data on the filesystem.");
2124 ("pvresize", (RErr, [String "device"]), 98, [],
2126 "resize an LVM physical volume",
2128 This resizes (expands or shrinks) an existing LVM physical
2129 volume to match the new size of the underlying device.");
2131 ("sfdisk_N", (RErr, [String "device"; Int "n";
2132 Int "cyls"; Int "heads"; Int "sectors";
2133 String "line"]), 99, [DangerWillRobinson],
2135 "modify a single partition on a block device",
2137 This runs L<sfdisk(8)> option to modify just the single
2138 partition C<n> (note: C<n> counts from 1).
2140 For other parameters, see C<guestfs_sfdisk>. You should usually
2141 pass C<0> for the cyls/heads/sectors parameters.");
2143 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2145 "display the partition table",
2147 This displays the partition table on C<device>, in the
2148 human-readable output of the L<sfdisk(8)> command. It is
2149 not intended to be parsed.");
2151 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2153 "display the kernel geometry",
2155 This displays the kernel's idea of the geometry of C<device>.
2157 The result is in human-readable format, and not designed to
2160 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2162 "display the disk geometry from the partition table",
2164 This displays the disk geometry of C<device> read from the
2165 partition table. Especially in the case where the underlying
2166 block device has been resized, this can be different from the
2167 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2169 The result is in human-readable format, and not designed to
2172 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2174 "activate or deactivate all volume groups",
2176 This command activates or (if C<activate> is false) deactivates
2177 all logical volumes in all volume groups.
2178 If activated, then they are made known to the
2179 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2180 then those devices disappear.
2182 This command is the same as running C<vgchange -a y|n>");
2184 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2186 "activate or deactivate some volume groups",
2188 This command activates or (if C<activate> is false) deactivates
2189 all logical volumes in the listed volume groups C<volgroups>.
2190 If activated, then they are made known to the
2191 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2192 then those devices disappear.
2194 This command is the same as running C<vgchange -a y|n volgroups...>
2196 Note that if C<volgroups> is an empty list then B<all> volume groups
2197 are activated or deactivated.");
2199 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2200 [InitNone, Always, TestOutput (
2201 [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2202 ["pvcreate"; "/dev/sda1"];
2203 ["vgcreate"; "VG"; "/dev/sda1"];
2204 ["lvcreate"; "LV"; "VG"; "10"];
2205 ["mkfs"; "ext2"; "/dev/VG/LV"];
2206 ["mount"; "/dev/VG/LV"; "/"];
2207 ["write_file"; "/new"; "test content"; "0"];
2209 ["lvresize"; "/dev/VG/LV"; "20"];
2210 ["e2fsck_f"; "/dev/VG/LV"];
2211 ["resize2fs"; "/dev/VG/LV"];
2212 ["mount"; "/dev/VG/LV"; "/"];
2213 ["cat"; "/new"]], "test content")],
2214 "resize an LVM logical volume",
2216 This resizes (expands or shrinks) an existing LVM logical
2217 volume to C<mbytes>. When reducing, data in the reduced part
2220 ("resize2fs", (RErr, [String "device"]), 106, [],
2221 [], (* lvresize tests this *)
2222 "resize an ext2/ext3 filesystem",
2224 This resizes an ext2 or ext3 filesystem to match the size of
2225 the underlying device.
2227 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2228 on the C<device> before calling this command. For unknown reasons
2229 C<resize2fs> sometimes gives an error about this and sometimes not.
2230 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2231 calling this function.");
2233 ("find", (RStringList "names", [String "directory"]), 107, [],
2234 [InitBasicFS, Always, TestOutputList (
2235 [["find"; "/"]], ["lost+found"]);
2236 InitBasicFS, Always, TestOutputList (
2240 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2241 InitBasicFS, Always, TestOutputList (
2242 [["mkdir_p"; "/a/b/c"];
2243 ["touch"; "/a/b/c/d"];
2244 ["find"; "/a/b/"]], ["c"; "c/d"])],
2245 "find all files and directories",
2247 This command lists out all files and directories, recursively,
2248 starting at C<directory>. It is essentially equivalent to
2249 running the shell command C<find directory -print> but some
2250 post-processing happens on the output, described below.
2252 This returns a list of strings I<without any prefix>. Thus
2253 if the directory structure was:
2259 then the returned list from C<guestfs_find> C</tmp> would be
2267 If C<directory> is not a directory, then this command returns
2270 The returned list is sorted.");
2272 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2273 [], (* lvresize tests this *)
2274 "check an ext2/ext3 filesystem",
2276 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2277 filesystem checker on C<device>, noninteractively (C<-p>),
2278 even if the filesystem appears to be clean (C<-f>).
2280 This command is only needed because of C<guestfs_resize2fs>
2281 (q.v.). Normally you should use C<guestfs_fsck>.");
2285 let all_functions = non_daemon_functions @ daemon_functions
2287 (* In some places we want the functions to be displayed sorted
2288 * alphabetically, so this is useful:
2290 let all_functions_sorted =
2291 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2292 compare n1 n2) all_functions
2294 (* Column names and types from LVM PVs/VGs/LVs. *)
2303 "pv_attr", `String (* XXX *);
2304 "pv_pe_count", `Int;
2305 "pv_pe_alloc_count", `Int;
2308 "pv_mda_count", `Int;
2309 "pv_mda_free", `Bytes;
2310 (* Not in Fedora 10:
2311 "pv_mda_size", `Bytes;
2318 "vg_attr", `String (* XXX *);
2321 "vg_sysid", `String;
2322 "vg_extent_size", `Bytes;
2323 "vg_extent_count", `Int;
2324 "vg_free_count", `Int;
2332 "vg_mda_count", `Int;
2333 "vg_mda_free", `Bytes;
2334 (* Not in Fedora 10:
2335 "vg_mda_size", `Bytes;
2341 "lv_attr", `String (* XXX *);
2344 "lv_kernel_major", `Int;
2345 "lv_kernel_minor", `Int;
2349 "snap_percent", `OptPercent;
2350 "copy_percent", `OptPercent;
2353 "mirror_log", `String;
2357 (* Column names and types from stat structures.
2358 * NB. Can't use things like 'st_atime' because glibc header files
2359 * define some of these as macros. Ugh.
2376 let statvfs_cols = [
2390 (* Used for testing language bindings. *)
2392 | CallString of string
2393 | CallOptString of string option
2394 | CallStringList of string list
2398 (* Useful functions.
2399 * Note we don't want to use any external OCaml libraries which
2400 * makes this a bit harder than it should be.
2402 let failwithf fs = ksprintf failwith fs
2404 let replace_char s c1 c2 =
2405 let s2 = String.copy s in
2406 let r = ref false in
2407 for i = 0 to String.length s2 - 1 do
2408 if String.unsafe_get s2 i = c1 then (
2409 String.unsafe_set s2 i c2;
2413 if not !r then s else s2
2417 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2419 let triml ?(test = isspace) str =
2421 let n = ref (String.length str) in
2422 while !n > 0 && test str.[!i]; do
2427 else String.sub str !i !n
2429 let trimr ?(test = isspace) str =
2430 let n = ref (String.length str) in
2431 while !n > 0 && test str.[!n-1]; do
2434 if !n = String.length str then str
2435 else String.sub str 0 !n
2437 let trim ?(test = isspace) str =
2438 trimr ~test (triml ~test str)
2440 let rec find s sub =
2441 let len = String.length s in
2442 let sublen = String.length sub in
2444 if i <= len-sublen then (
2446 if j < sublen then (
2447 if s.[i+j] = sub.[j] then loop2 (j+1)
2453 if r = -1 then loop (i+1) else r
2459 let rec replace_str s s1 s2 =
2460 let len = String.length s in
2461 let sublen = String.length s1 in
2462 let i = find s s1 in
2465 let s' = String.sub s 0 i in
2466 let s'' = String.sub s (i+sublen) (len-i-sublen) in
2467 s' ^ s2 ^ replace_str s'' s1 s2
2470 let rec string_split sep str =
2471 let len = String.length str in
2472 let seplen = String.length sep in
2473 let i = find str sep in
2474 if i = -1 then [str]
2476 let s' = String.sub str 0 i in
2477 let s'' = String.sub str (i+seplen) (len-i-seplen) in
2478 s' :: string_split sep s''
2481 let files_equal n1 n2 =
2482 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2483 match Sys.command cmd with
2486 | i -> failwithf "%s: failed with error code %d" cmd i
2488 let rec find_map f = function
2489 | [] -> raise Not_found
2493 | None -> find_map f xs
2496 let rec loop i = function
2498 | x :: xs -> f i x; loop (i+1) xs
2503 let rec loop i = function
2505 | x :: xs -> let r = f i x in r :: loop (i+1) xs
2509 let name_of_argt = function
2510 | String n | OptString n | StringList n | Bool n | Int n
2511 | FileIn n | FileOut n -> n
2513 let seq_of_test = function
2514 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2515 | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2516 | TestOutputLength (s, _) | TestOutputStruct (s, _)
2517 | TestLastFail s -> s
2519 (* Check function names etc. for consistency. *)
2520 let check_functions () =
2521 let contains_uppercase str =
2522 let len = String.length str in
2524 if i >= len then false
2527 if c >= 'A' && c <= 'Z' then true
2534 (* Check function names. *)
2536 fun (name, _, _, _, _, _, _) ->
2537 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2538 failwithf "function name %s does not need 'guestfs' prefix" name;
2540 failwithf "function name is empty";
2541 if name.[0] < 'a' || name.[0] > 'z' then
2542 failwithf "function name %s must start with lowercase a-z" name;
2543 if String.contains name '-' then
2544 failwithf "function name %s should not contain '-', use '_' instead."
2548 (* Check function parameter/return names. *)
2550 fun (name, style, _, _, _, _, _) ->
2551 let check_arg_ret_name n =
2552 if contains_uppercase n then
2553 failwithf "%s param/ret %s should not contain uppercase chars"
2555 if String.contains n '-' || String.contains n '_' then
2556 failwithf "%s param/ret %s should not contain '-' or '_'"
2559 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;
2560 if n = "int" || n = "char" || n = "short" || n = "long" then
2561 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
2563 failwithf "%s has a param/ret called 'i', which will cause some conflicts in the generated code" name;
2564 if n = "argv" || n = "args" then
2565 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
2568 (match fst style with
2570 | RInt n | RInt64 n | RBool n | RConstString n | RString n
2571 | RStringList n | RPVList n | RVGList n | RLVList n
2572 | RStat n | RStatVFS n
2574 check_arg_ret_name n
2576 check_arg_ret_name n;
2577 check_arg_ret_name m
2579 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2582 (* Check short descriptions. *)
2584 fun (name, _, _, _, _, shortdesc, _) ->
2585 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2586 failwithf "short description of %s should begin with lowercase." name;
2587 let c = shortdesc.[String.length shortdesc-1] in
2588 if c = '\n' || c = '.' then
2589 failwithf "short description of %s should not end with . or \\n." name
2592 (* Check long dscriptions. *)
2594 fun (name, _, _, _, _, _, longdesc) ->
2595 if longdesc.[String.length longdesc-1] = '\n' then
2596 failwithf "long description of %s should not end with \\n." name
2599 (* Check proc_nrs. *)
2601 fun (name, _, proc_nr, _, _, _, _) ->
2602 if proc_nr <= 0 then
2603 failwithf "daemon function %s should have proc_nr > 0" name
2607 fun (name, _, proc_nr, _, _, _, _) ->
2608 if proc_nr <> -1 then
2609 failwithf "non-daemon function %s should have proc_nr -1" name
2610 ) non_daemon_functions;
2613 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2616 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2617 let rec loop = function
2620 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2622 | (name1,nr1) :: (name2,nr2) :: _ ->
2623 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2631 (* Ignore functions that have no tests. We generate a
2632 * warning when the user does 'make check' instead.
2634 | name, _, _, _, [], _, _ -> ()
2635 | name, _, _, _, tests, _, _ ->
2639 match seq_of_test test with
2641 failwithf "%s has a test containing an empty sequence" name
2642 | cmds -> List.map List.hd cmds
2644 let funcs = List.flatten funcs in
2646 let tested = List.mem name funcs in
2649 failwithf "function %s has tests but does not test itself" name
2652 (* 'pr' prints to the current output file. *)
2653 let chan = ref stdout
2654 let pr fs = ksprintf (output_string !chan) fs
2656 (* Generate a header block in a number of standard styles. *)
2657 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2658 type license = GPLv2 | LGPLv2
2660 let generate_header comment license =
2661 let c = match comment with
2662 | CStyle -> pr "/* "; " *"
2663 | HashStyle -> pr "# "; "#"
2664 | OCamlStyle -> pr "(* "; " *"
2665 | HaskellStyle -> pr "{- "; " " in
2666 pr "libguestfs generated file\n";
2667 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2668 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2670 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2674 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2675 pr "%s it under the terms of the GNU General Public License as published by\n" c;
2676 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2677 pr "%s (at your option) any later version.\n" c;
2679 pr "%s This program is distributed in the hope that it will be useful,\n" c;
2680 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2681 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
2682 pr "%s GNU General Public License for more details.\n" c;
2684 pr "%s You should have received a copy of the GNU General Public License along\n" c;
2685 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2686 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2689 pr "%s This library is free software; you can redistribute it and/or\n" c;
2690 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2691 pr "%s License as published by the Free Software Foundation; either\n" c;
2692 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2694 pr "%s This library is distributed in the hope that it will be useful,\n" c;
2695 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2696 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
2697 pr "%s Lesser General Public License for more details.\n" c;
2699 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2700 pr "%s License along with this library; if not, write to the Free Software\n" c;
2701 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2704 | CStyle -> pr " */\n"
2706 | OCamlStyle -> pr " *)\n"
2707 | HaskellStyle -> pr "-}\n"
2711 (* Start of main code generation functions below this line. *)
2713 (* Generate the pod documentation for the C API. *)
2714 let rec generate_actions_pod () =
2716 fun (shortname, style, _, flags, _, _, longdesc) ->
2717 if not (List.mem NotInDocs flags) then (
2718 let name = "guestfs_" ^ shortname in
2719 pr "=head2 %s\n\n" name;
2721 generate_prototype ~extern:false ~handle:"handle" name style;
2723 pr "%s\n\n" longdesc;
2724 (match fst style with
2726 pr "This function returns 0 on success or -1 on error.\n\n"
2728 pr "On error this function returns -1.\n\n"
2730 pr "On error this function returns -1.\n\n"
2732 pr "This function returns a C truth value on success or -1 on error.\n\n"
2734 pr "This function returns a string, or NULL on error.
2735 The string is owned by the guest handle and must I<not> be freed.\n\n"
2737 pr "This function returns a string, or NULL on error.
2738 I<The caller must free the returned string after use>.\n\n"
2740 pr "This function returns a NULL-terminated array of strings
2741 (like L<environ(3)>), or NULL if there was an error.
2742 I<The caller must free the strings and the array after use>.\n\n"
2744 pr "This function returns a C<struct guestfs_int_bool *>,
2745 or NULL if there was an error.
2746 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2748 pr "This function returns a C<struct guestfs_lvm_pv_list *>
2749 (see E<lt>guestfs-structs.hE<gt>),
2750 or NULL if there was an error.
2751 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2753 pr "This function returns a C<struct guestfs_lvm_vg_list *>
2754 (see E<lt>guestfs-structs.hE<gt>),
2755 or NULL if there was an error.
2756 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2758 pr "This function returns a C<struct guestfs_lvm_lv_list *>
2759 (see E<lt>guestfs-structs.hE<gt>),
2760 or NULL if there was an error.
2761 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2763 pr "This function returns a C<struct guestfs_stat *>
2764 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2765 or NULL if there was an error.
2766 I<The caller must call C<free> after use>.\n\n"
2768 pr "This function returns a C<struct guestfs_statvfs *>
2769 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2770 or NULL if there was an error.
2771 I<The caller must call C<free> after use>.\n\n"
2773 pr "This function returns a NULL-terminated array of
2774 strings, or NULL if there was an error.
2775 The array of strings will always have length C<2n+1>, where
2776 C<n> keys and values alternate, followed by the trailing NULL entry.
2777 I<The caller must free the strings and the array after use>.\n\n"
2779 if List.mem ProtocolLimitWarning flags then
2780 pr "%s\n\n" protocol_limit_warning;
2781 if List.mem DangerWillRobinson flags then
2782 pr "%s\n\n" danger_will_robinson
2784 ) all_functions_sorted
2786 and generate_structs_pod () =
2787 (* LVM structs documentation. *)
2790 pr "=head2 guestfs_lvm_%s\n" typ;
2792 pr " struct guestfs_lvm_%s {\n" typ;
2795 | name, `String -> pr " char *%s;\n" name
2797 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2798 pr " char %s[32];\n" name
2799 | name, `Bytes -> pr " uint64_t %s;\n" name
2800 | name, `Int -> pr " int64_t %s;\n" name
2801 | name, `OptPercent ->
2802 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
2803 pr " float %s;\n" name
2806 pr " struct guestfs_lvm_%s_list {\n" typ;
2807 pr " uint32_t len; /* Number of elements in list. */\n";
2808 pr " struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2811 pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2814 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2816 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2817 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2819 * We have to use an underscore instead of a dash because otherwise
2820 * rpcgen generates incorrect code.
2822 * This header is NOT exported to clients, but see also generate_structs_h.
2824 and generate_xdr () =
2825 generate_header CStyle LGPLv2;
2827 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2828 pr "typedef string str<>;\n";
2831 (* LVM internal structures. *)
2835 pr "struct guestfs_lvm_int_%s {\n" typ;
2837 | name, `String -> pr " string %s<>;\n" name
2838 | name, `UUID -> pr " opaque %s[32];\n" name
2839 | name, `Bytes -> pr " hyper %s;\n" name
2840 | name, `Int -> pr " hyper %s;\n" name
2841 | name, `OptPercent -> pr " float %s;\n" name
2845 pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2847 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2849 (* Stat internal structures. *)
2853 pr "struct guestfs_int_%s {\n" typ;
2855 | name, `Int -> pr " hyper %s;\n" name
2859 ) ["stat", stat_cols; "statvfs", statvfs_cols];
2862 fun (shortname, style, _, _, _, _, _) ->
2863 let name = "guestfs_" ^ shortname in
2865 (match snd style with
2868 pr "struct %s_args {\n" name;
2871 | String n -> pr " string %s<>;\n" n
2872 | OptString n -> pr " str *%s;\n" n
2873 | StringList n -> pr " str %s<>;\n" n
2874 | Bool n -> pr " bool %s;\n" n
2875 | Int n -> pr " int %s;\n" n
2876 | FileIn _ | FileOut _ -> ()
2880 (match fst style with
2883 pr "struct %s_ret {\n" name;
2887 pr "struct %s_ret {\n" name;
2888 pr " hyper %s;\n" n;
2891 pr "struct %s_ret {\n" name;
2895 failwithf "RConstString cannot be returned from a daemon function"
2897 pr "struct %s_ret {\n" name;
2898 pr " string %s<>;\n" n;
2901 pr "struct %s_ret {\n" name;
2902 pr " str %s<>;\n" n;
2905 pr "struct %s_ret {\n" name;
2910 pr "struct %s_ret {\n" name;
2911 pr " guestfs_lvm_int_pv_list %s;\n" n;
2914 pr "struct %s_ret {\n" name;
2915 pr " guestfs_lvm_int_vg_list %s;\n" n;
2918 pr "struct %s_ret {\n" name;
2919 pr " guestfs_lvm_int_lv_list %s;\n" n;
2922 pr "struct %s_ret {\n" name;
2923 pr " guestfs_int_stat %s;\n" n;
2926 pr "struct %s_ret {\n" name;
2927 pr " guestfs_int_statvfs %s;\n" n;
2930 pr "struct %s_ret {\n" name;
2931 pr " str %s<>;\n" n;
2936 (* Table of procedure numbers. *)
2937 pr "enum guestfs_procedure {\n";
2939 fun (shortname, _, proc_nr, _, _, _, _) ->
2940 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
2942 pr " GUESTFS_PROC_NR_PROCS\n";
2946 (* Having to choose a maximum message size is annoying for several
2947 * reasons (it limits what we can do in the API), but it (a) makes
2948 * the protocol a lot simpler, and (b) provides a bound on the size
2949 * of the daemon which operates in limited memory space. For large
2950 * file transfers you should use FTP.
2952 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
2955 (* Message header, etc. *)
2957 /* The communication protocol is now documented in the guestfs(3)
2961 const GUESTFS_PROGRAM = 0x2000F5F5;
2962 const GUESTFS_PROTOCOL_VERSION = 1;
2964 /* These constants must be larger than any possible message length. */
2965 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
2966 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
2968 enum guestfs_message_direction {
2969 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
2970 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
2973 enum guestfs_message_status {
2974 GUESTFS_STATUS_OK = 0,
2975 GUESTFS_STATUS_ERROR = 1
2978 const GUESTFS_ERROR_LEN = 256;
2980 struct guestfs_message_error {
2981 string error_message<GUESTFS_ERROR_LEN>;
2984 struct guestfs_message_header {
2985 unsigned prog; /* GUESTFS_PROGRAM */
2986 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
2987 guestfs_procedure proc; /* GUESTFS_PROC_x */
2988 guestfs_message_direction direction;
2989 unsigned serial; /* message serial number */
2990 guestfs_message_status status;
2993 const GUESTFS_MAX_CHUNK_SIZE = 8192;
2995 struct guestfs_chunk {
2996 int cancel; /* if non-zero, transfer is cancelled */
2997 /* data size is 0 bytes if the transfer has finished successfully */
2998 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3002 (* Generate the guestfs-structs.h file. *)
3003 and generate_structs_h () =
3004 generate_header CStyle LGPLv2;
3006 (* This is a public exported header file containing various
3007 * structures. The structures are carefully written to have
3008 * exactly the same in-memory format as the XDR structures that
3009 * we use on the wire to the daemon. The reason for creating
3010 * copies of these structures here is just so we don't have to
3011 * export the whole of guestfs_protocol.h (which includes much
3012 * unrelated and XDR-dependent stuff that we don't want to be
3013 * public, or required by clients).
3015 * To reiterate, we will pass these structures to and from the
3016 * client with a simple assignment or memcpy, so the format
3017 * must be identical to what rpcgen / the RFC defines.
3020 (* guestfs_int_bool structure. *)
3021 pr "struct guestfs_int_bool {\n";
3027 (* LVM public structures. *)
3031 pr "struct guestfs_lvm_%s {\n" typ;
3034 | name, `String -> pr " char *%s;\n" name
3035 | name, `UUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3036 | name, `Bytes -> pr " uint64_t %s;\n" name
3037 | name, `Int -> pr " int64_t %s;\n" name
3038 | name, `OptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3042 pr "struct guestfs_lvm_%s_list {\n" typ;
3043 pr " uint32_t len;\n";
3044 pr " struct guestfs_lvm_%s *val;\n" typ;
3047 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3049 (* Stat structures. *)
3053 pr "struct guestfs_%s {\n" typ;
3056 | name, `Int -> pr " int64_t %s;\n" name
3060 ) ["stat", stat_cols; "statvfs", statvfs_cols]
3062 (* Generate the guestfs-actions.h file. *)
3063 and generate_actions_h () =
3064 generate_header CStyle LGPLv2;
3066 fun (shortname, style, _, _, _, _, _) ->
3067 let name = "guestfs_" ^ shortname in
3068 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3072 (* Generate the client-side dispatch stubs. *)
3073 and generate_client_actions () =
3074 generate_header CStyle LGPLv2;
3080 #include \"guestfs.h\"
3081 #include \"guestfs_protocol.h\"
3083 #define error guestfs_error
3084 #define perrorf guestfs_perrorf
3085 #define safe_malloc guestfs_safe_malloc
3086 #define safe_realloc guestfs_safe_realloc
3087 #define safe_strdup guestfs_safe_strdup
3088 #define safe_memdup guestfs_safe_memdup
3090 /* Check the return message from a call for validity. */
3092 check_reply_header (guestfs_h *g,
3093 const struct guestfs_message_header *hdr,
3094 int proc_nr, int serial)
3096 if (hdr->prog != GUESTFS_PROGRAM) {
3097 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3100 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3101 error (g, \"wrong protocol version (%%d/%%d)\",
3102 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3105 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3106 error (g, \"unexpected message direction (%%d/%%d)\",
3107 hdr->direction, GUESTFS_DIRECTION_REPLY);
3110 if (hdr->proc != proc_nr) {
3111 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3114 if (hdr->serial != serial) {
3115 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3122 /* Check we are in the right state to run a high-level action. */
3124 check_state (guestfs_h *g, const char *caller)
3126 if (!guestfs_is_ready (g)) {
3127 if (guestfs_is_config (g))
3128 error (g, \"%%s: call launch() before using this function\",
3130 else if (guestfs_is_launching (g))
3131 error (g, \"%%s: call wait_ready() before using this function\",
3134 error (g, \"%%s called from the wrong state, %%d != READY\",
3135 caller, guestfs_get_state (g));
3143 (* Client-side stubs for each function. *)
3145 fun (shortname, style, _, _, _, _, _) ->
3146 let name = "guestfs_" ^ shortname in
3148 (* Generate the context struct which stores the high-level
3149 * state between callback functions.
3151 pr "struct %s_ctx {\n" shortname;
3152 pr " /* This flag is set by the callbacks, so we know we've done\n";
3153 pr " * the callbacks as expected, and in the right sequence.\n";
3154 pr " * 0 = not called, 1 = reply_cb called.\n";
3156 pr " int cb_sequence;\n";
3157 pr " struct guestfs_message_header hdr;\n";
3158 pr " struct guestfs_message_error err;\n";
3159 (match fst style with
3162 failwithf "RConstString cannot be returned from a daemon function"
3164 | RBool _ | RString _ | RStringList _
3166 | RPVList _ | RVGList _ | RLVList _
3167 | RStat _ | RStatVFS _
3169 pr " struct %s_ret ret;\n" name
3174 (* Generate the reply callback function. *)
3175 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3177 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3178 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3180 pr " /* This should definitely not happen. */\n";
3181 pr " if (ctx->cb_sequence != 0) {\n";
3182 pr " ctx->cb_sequence = 9999;\n";
3183 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3187 pr " ml->main_loop_quit (ml, g);\n";
3189 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3190 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3193 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3194 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3195 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3202 (match fst style with
3205 failwithf "RConstString cannot be returned from a daemon function"
3207 | RBool _ | RString _ | RStringList _
3209 | RPVList _ | RVGList _ | RLVList _
3210 | RStat _ | RStatVFS _
3212 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3213 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3219 pr " ctx->cb_sequence = 1;\n";
3222 (* Generate the action stub. *)
3223 generate_prototype ~extern:false ~semicolon:false ~newline:true
3224 ~handle:"g" name style;
3227 match fst style with
3228 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3230 failwithf "RConstString cannot be returned from a daemon function"
3231 | RString _ | RStringList _ | RIntBool _
3232 | RPVList _ | RVGList _ | RLVList _
3233 | RStat _ | RStatVFS _
3239 (match snd style with
3241 | _ -> pr " struct %s_args args;\n" name
3244 pr " struct %s_ctx ctx;\n" shortname;
3245 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3246 pr " int serial;\n";
3248 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3249 pr " guestfs_set_busy (g);\n";
3251 pr " memset (&ctx, 0, sizeof ctx);\n";
3254 (* Send the main header and arguments. *)
3255 (match snd style with
3257 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3258 (String.uppercase shortname)
3263 pr " args.%s = (char *) %s;\n" n n
3265 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3267 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3268 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3270 pr " args.%s = %s;\n" n n
3272 pr " args.%s = %s;\n" n n
3273 | FileIn _ | FileOut _ -> ()
3275 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3276 (String.uppercase shortname);
3277 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3280 pr " if (serial == -1) {\n";
3281 pr " guestfs_end_busy (g);\n";
3282 pr " return %s;\n" error_code;
3286 (* Send any additional files (FileIn) requested. *)
3287 let need_read_reply_label = ref false in
3294 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3295 pr " if (r == -1) {\n";
3296 pr " guestfs_end_busy (g);\n";
3297 pr " return %s;\n" error_code;
3299 pr " if (r == -2) /* daemon cancelled */\n";
3300 pr " goto read_reply;\n";
3301 need_read_reply_label := true;
3307 (* Wait for the reply from the remote end. *)
3308 if !need_read_reply_label then pr " read_reply:\n";
3309 pr " guestfs__switch_to_receiving (g);\n";
3310 pr " ctx.cb_sequence = 0;\n";
3311 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3312 pr " (void) ml->main_loop_run (ml, g);\n";
3313 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3314 pr " if (ctx.cb_sequence != 1) {\n";
3315 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3316 pr " guestfs_end_busy (g);\n";
3317 pr " return %s;\n" error_code;
3321 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3322 (String.uppercase shortname);
3323 pr " guestfs_end_busy (g);\n";
3324 pr " return %s;\n" error_code;
3328 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3329 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3330 pr " free (ctx.err.error_message);\n";
3331 pr " guestfs_end_busy (g);\n";
3332 pr " return %s;\n" error_code;
3336 (* Expecting to receive further files (FileOut)? *)
3340 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3341 pr " guestfs_end_busy (g);\n";
3342 pr " return %s;\n" error_code;
3348 pr " guestfs_end_busy (g);\n";
3350 (match fst style with
3351 | RErr -> pr " return 0;\n"
3352 | RInt n | RInt64 n | RBool n ->
3353 pr " return ctx.ret.%s;\n" n
3355 failwithf "RConstString cannot be returned from a daemon function"
3357 pr " return ctx.ret.%s; /* caller will free */\n" n
3358 | RStringList n | RHashtable n ->
3359 pr " /* caller will free this, but we need to add a NULL entry */\n";
3360 pr " ctx.ret.%s.%s_val =\n" n n;
3361 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3362 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3364 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3365 pr " return ctx.ret.%s.%s_val;\n" n n
3367 pr " /* caller with free this */\n";
3368 pr " return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3369 | RPVList n | RVGList n | RLVList n
3370 | RStat n | RStatVFS n ->
3371 pr " /* caller will free this */\n";
3372 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3378 (* Generate daemon/actions.h. *)
3379 and generate_daemon_actions_h () =
3380 generate_header CStyle GPLv2;
3382 pr "#include \"../src/guestfs_protocol.h\"\n";
3386 fun (name, style, _, _, _, _, _) ->
3388 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3392 (* Generate the server-side stubs. *)
3393 and generate_daemon_actions () =
3394 generate_header CStyle GPLv2;
3396 pr "#include <config.h>\n";
3398 pr "#include <stdio.h>\n";
3399 pr "#include <stdlib.h>\n";
3400 pr "#include <string.h>\n";
3401 pr "#include <inttypes.h>\n";
3402 pr "#include <ctype.h>\n";
3403 pr "#include <rpc/types.h>\n";
3404 pr "#include <rpc/xdr.h>\n";
3406 pr "#include \"daemon.h\"\n";
3407 pr "#include \"../src/guestfs_protocol.h\"\n";
3408 pr "#include \"actions.h\"\n";
3412 fun (name, style, _, _, _, _, _) ->
3413 (* Generate server-side stubs. *)
3414 pr "static void %s_stub (XDR *xdr_in)\n" name;
3417 match fst style with
3418 | RErr | RInt _ -> pr " int r;\n"; "-1"
3419 | RInt64 _ -> pr " int64_t r;\n"; "-1"
3420 | RBool _ -> pr " int r;\n"; "-1"
3422 failwithf "RConstString cannot be returned from a daemon function"
3423 | RString _ -> pr " char *r;\n"; "NULL"
3424 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
3425 | RIntBool _ -> pr " guestfs_%s_ret *r;\n" name; "NULL"
3426 | RPVList _ -> pr " guestfs_lvm_int_pv_list *r;\n"; "NULL"
3427 | RVGList _ -> pr " guestfs_lvm_int_vg_list *r;\n"; "NULL"
3428 | RLVList _ -> pr " guestfs_lvm_int_lv_list *r;\n"; "NULL"
3429 | RStat _ -> pr " guestfs_int_stat *r;\n"; "NULL"
3430 | RStatVFS _ -> pr " guestfs_int_statvfs *r;\n"; "NULL" in
3432 (match snd style with
3435 pr " struct guestfs_%s_args args;\n" name;
3439 | OptString n -> pr " const char *%s;\n" n
3440 | StringList n -> pr " char **%s;\n" n
3441 | Bool n -> pr " int %s;\n" n
3442 | Int n -> pr " int %s;\n" n
3443 | FileIn _ | FileOut _ -> ()
3448 (match snd style with
3451 pr " memset (&args, 0, sizeof args);\n";
3453 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3454 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3459 | String n -> pr " %s = args.%s;\n" n n
3460 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
3462 pr " %s = realloc (args.%s.%s_val,\n" n n n;
3463 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3464 pr " if (%s == NULL) {\n" n;
3465 pr " reply_with_perror (\"realloc\");\n";
3468 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
3469 pr " args.%s.%s_val = %s;\n" n n n;
3470 | Bool n -> pr " %s = args.%s;\n" n n
3471 | Int n -> pr " %s = args.%s;\n" n n
3472 | FileIn _ | FileOut _ -> ()
3477 (* Don't want to call the impl with any FileIn or FileOut
3478 * parameters, since these go "outside" the RPC protocol.
3481 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3483 pr " r = do_%s " name;
3484 generate_call_args argsnofile;
3487 pr " if (r == %s)\n" error_code;
3488 pr " /* do_%s has already called reply_with_error */\n" name;
3492 (* If there are any FileOut parameters, then the impl must
3493 * send its own reply.
3496 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3498 pr " /* do_%s has already sent a reply */\n" name
3500 match fst style with
3501 | RErr -> pr " reply (NULL, NULL);\n"
3502 | RInt n | RInt64 n | RBool n ->
3503 pr " struct guestfs_%s_ret ret;\n" name;
3504 pr " ret.%s = r;\n" n;
3505 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3508 failwithf "RConstString cannot be returned from a daemon function"
3510 pr " struct guestfs_%s_ret ret;\n" name;
3511 pr " ret.%s = r;\n" n;
3512 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3515 | RStringList n | RHashtable n ->
3516 pr " struct guestfs_%s_ret ret;\n" name;
3517 pr " ret.%s.%s_len = count_strings (r);\n" n n;
3518 pr " ret.%s.%s_val = r;\n" n n;
3519 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3521 pr " free_strings (r);\n"
3523 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3525 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3526 | RPVList n | RVGList n | RLVList n
3527 | RStat n | RStatVFS n ->
3528 pr " struct guestfs_%s_ret ret;\n" name;
3529 pr " ret.%s = *r;\n" n;
3530 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3532 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3536 (* Free the args. *)
3537 (match snd style with
3542 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3549 (* Dispatch function. *)
3550 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3552 pr " switch (proc_nr) {\n";
3555 fun (name, style, _, _, _, _, _) ->
3556 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
3557 pr " %s_stub (xdr_in);\n" name;
3562 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3567 (* LVM columns and tokenization functions. *)
3568 (* XXX This generates crap code. We should rethink how we
3574 pr "static const char *lvm_%s_cols = \"%s\";\n"
3575 typ (String.concat "," (List.map fst cols));
3578 pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3580 pr " char *tok, *p, *next;\n";
3584 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3587 pr " if (!str) {\n";
3588 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3591 pr " if (!*str || isspace (*str)) {\n";
3592 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3597 fun (name, coltype) ->
3598 pr " if (!tok) {\n";
3599 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3602 pr " p = strchrnul (tok, ',');\n";
3603 pr " if (*p) next = p+1; else next = NULL;\n";
3604 pr " *p = '\\0';\n";
3607 pr " r->%s = strdup (tok);\n" name;
3608 pr " if (r->%s == NULL) {\n" name;
3609 pr " perror (\"strdup\");\n";
3613 pr " for (i = j = 0; i < 32; ++j) {\n";
3614 pr " if (tok[j] == '\\0') {\n";
3615 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3617 pr " } else if (tok[j] != '-')\n";
3618 pr " r->%s[i++] = tok[j];\n" name;
3621 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3622 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3626 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3627 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3631 pr " if (tok[0] == '\\0')\n";
3632 pr " r->%s = -1;\n" name;
3633 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3634 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3638 pr " tok = next;\n";
3641 pr " if (tok != NULL) {\n";
3642 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3649 pr "guestfs_lvm_int_%s_list *\n" typ;
3650 pr "parse_command_line_%ss (void)\n" typ;
3652 pr " char *out, *err;\n";
3653 pr " char *p, *pend;\n";
3655 pr " guestfs_lvm_int_%s_list *ret;\n" typ;
3656 pr " void *newp;\n";
3658 pr " ret = malloc (sizeof *ret);\n";
3659 pr " if (!ret) {\n";
3660 pr " reply_with_perror (\"malloc\");\n";
3661 pr " return NULL;\n";
3664 pr " ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3665 pr " ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3667 pr " r = command (&out, &err,\n";
3668 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
3669 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3670 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3671 pr " if (r == -1) {\n";
3672 pr " reply_with_error (\"%%s\", err);\n";
3673 pr " free (out);\n";
3674 pr " free (err);\n";
3675 pr " free (ret);\n";
3676 pr " return NULL;\n";
3679 pr " free (err);\n";
3681 pr " /* Tokenize each line of the output. */\n";
3684 pr " while (p) {\n";
3685 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
3686 pr " if (pend) {\n";
3687 pr " *pend = '\\0';\n";
3691 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
3694 pr " if (!*p) { /* Empty line? Skip it. */\n";
3699 pr " /* Allocate some space to store this next entry. */\n";
3700 pr " newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3701 pr " sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3702 pr " if (newp == NULL) {\n";
3703 pr " reply_with_perror (\"realloc\");\n";
3704 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3705 pr " free (ret);\n";
3706 pr " free (out);\n";
3707 pr " return NULL;\n";
3709 pr " ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3711 pr " /* Tokenize the next entry. */\n";
3712 pr " r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3713 pr " if (r == -1) {\n";
3714 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3715 pr " free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3716 pr " free (ret);\n";
3717 pr " free (out);\n";
3718 pr " return NULL;\n";
3725 pr " ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3727 pr " free (out);\n";
3728 pr " return ret;\n";
3731 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3733 (* Generate the tests. *)
3734 and generate_tests () =
3735 generate_header CStyle GPLv2;
3742 #include <sys/types.h>
3745 #include \"guestfs.h\"
3747 static guestfs_h *g;
3748 static int suppress_error = 0;
3750 /* This will be 's' or 'h' depending on whether the guest kernel
3751 * names IDE devices /dev/sd* or /dev/hd*.
3753 static char devchar = 's';
3755 static void print_error (guestfs_h *g, void *data, const char *msg)
3757 if (!suppress_error)
3758 fprintf (stderr, \"%%s\\n\", msg);
3761 static void print_strings (char * const * const argv)
3765 for (argc = 0; argv[argc] != NULL; ++argc)
3766 printf (\"\\t%%s\\n\", argv[argc]);
3770 static void print_table (char * const * const argv)
3774 for (i = 0; argv[i] != NULL; i += 2)
3775 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3779 static void no_test_warnings (void)
3785 | name, _, _, _, [], _, _ ->
3786 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3787 | name, _, _, _, tests, _, _ -> ()
3793 (* Generate the actual tests. Note that we generate the tests
3794 * in reverse order, deliberately, so that (in general) the
3795 * newest tests run first. This makes it quicker and easier to
3800 fun (name, _, _, _, tests, _, _) ->
3801 mapi (generate_one_test name) tests
3802 ) (List.rev all_functions) in
3803 let test_names = List.concat test_names in
3804 let nr_tests = List.length test_names in
3807 int main (int argc, char *argv[])
3812 const char *filename;
3814 int nr_tests, test_num = 0;
3817 no_test_warnings ();
3819 g = guestfs_create ();
3821 printf (\"guestfs_create FAILED\\n\");
3825 guestfs_set_error_handler (g, print_error, NULL);
3827 guestfs_set_path (g, \"../appliance\");
3829 filename = \"test1.img\";
3830 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3835 if (lseek (fd, %d, SEEK_SET) == -1) {
3841 if (write (fd, &c, 1) == -1) {
3847 if (close (fd) == -1) {
3852 if (guestfs_add_drive (g, filename) == -1) {
3853 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3857 filename = \"test2.img\";
3858 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3863 if (lseek (fd, %d, SEEK_SET) == -1) {
3869 if (write (fd, &c, 1) == -1) {
3875 if (close (fd) == -1) {
3880 if (guestfs_add_drive (g, filename) == -1) {
3881 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3885 filename = \"test3.img\";
3886 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3891 if (lseek (fd, %d, SEEK_SET) == -1) {
3897 if (write (fd, &c, 1) == -1) {
3903 if (close (fd) == -1) {
3908 if (guestfs_add_drive (g, filename) == -1) {
3909 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3913 if (guestfs_add_drive (g, \"../images/test.sqsh\") == -1) {
3914 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3918 if (guestfs_launch (g) == -1) {
3919 printf (\"guestfs_launch FAILED\\n\");
3922 if (guestfs_wait_ready (g) == -1) {
3923 printf (\"guestfs_wait_ready FAILED\\n\");
3927 /* Detect if the appliance uses /dev/sd* or /dev/hd* in device
3928 * names. This changed between RHEL 5 and RHEL 6 so we have to
3931 devs = guestfs_list_devices (g);
3932 if (devs == NULL || devs[0] == NULL) {
3933 printf (\"guestfs_list_devices FAILED\\n\");
3936 if (strncmp (devs[0], \"/dev/sd\", 7) == 0)
3938 else if (strncmp (devs[0], \"/dev/hd\", 7) == 0)
3941 printf (\"guestfs_list_devices returned unexpected string '%%s'\\n\",
3945 for (i = 0; devs[i] != NULL; ++i)
3951 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3955 pr " test_num++;\n";
3956 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3957 pr " if (%s () == -1) {\n" test_name;
3958 pr " printf (\"%s FAILED\\n\");\n" test_name;
3964 pr " guestfs_close (g);\n";
3965 pr " unlink (\"test1.img\");\n";
3966 pr " unlink (\"test2.img\");\n";
3967 pr " unlink (\"test3.img\");\n";
3970 pr " if (failed > 0) {\n";
3971 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
3979 and generate_one_test name i (init, prereq, test) =
3980 let test_name = sprintf "test_%s_%d" name i in
3983 static int %s_skip (void)
3987 str = getenv (\"SKIP_%s\");
3988 if (str && strcmp (str, \"1\") == 0) return 1;
3989 str = getenv (\"SKIP_TEST_%s\");
3990 if (str && strcmp (str, \"1\") == 0) return 1;
3994 " test_name (String.uppercase test_name) (String.uppercase name);
3997 | Disabled | Always -> ()
3998 | If code | Unless code ->
3999 pr "static int %s_prereq (void)\n" test_name;
4007 static int %s (void)
4010 printf (\"%%s skipped (reason: SKIP_TEST_* variable set)\\n\", \"%s\");
4014 " test_name test_name test_name;
4018 pr " printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4020 pr " if (! %s_prereq ()) {\n" test_name;
4021 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4025 generate_one_test_body name i test_name init test;
4027 pr " if (%s_prereq ()) {\n" test_name;
4028 pr " printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4032 generate_one_test_body name i test_name init test;
4034 generate_one_test_body name i test_name init test
4042 and generate_one_test_body name i test_name init test =
4046 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4047 List.iter (generate_test_command_call test_name)
4048 [["blockdev_setrw"; "/dev/sda"];
4052 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4053 List.iter (generate_test_command_call test_name)
4054 [["blockdev_setrw"; "/dev/sda"];
4057 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4058 ["mkfs"; "ext2"; "/dev/sda1"];
4059 ["mount"; "/dev/sda1"; "/"]]
4060 | InitBasicFSonLVM ->
4061 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4063 List.iter (generate_test_command_call test_name)
4064 [["blockdev_setrw"; "/dev/sda"];
4067 ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4068 ["pvcreate"; "/dev/sda1"];
4069 ["vgcreate"; "VG"; "/dev/sda1"];
4070 ["lvcreate"; "LV"; "VG"; "8"];
4071 ["mkfs"; "ext2"; "/dev/VG/LV"];
4072 ["mount"; "/dev/VG/LV"; "/"]]
4075 let get_seq_last = function
4077 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4080 let seq = List.rev seq in
4081 List.rev (List.tl seq), List.hd seq
4086 pr " /* TestRun for %s (%d) */\n" name i;
4087 List.iter (generate_test_command_call test_name) seq
4088 | TestOutput (seq, expected) ->
4089 pr " /* TestOutput for %s (%d) */\n" name i;
4090 pr " char expected[] = \"%s\";\n" (c_quote expected);
4091 if String.length expected > 7 &&
4092 String.sub expected 0 7 = "/dev/sd" then
4093 pr " expected[5] = devchar;\n";
4094 let seq, last = get_seq_last seq in
4096 pr " if (strcmp (r, expected) != 0) {\n";
4097 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4101 List.iter (generate_test_command_call test_name) seq;
4102 generate_test_command_call ~test test_name last
4103 | TestOutputList (seq, expected) ->
4104 pr " /* TestOutputList for %s (%d) */\n" name i;
4105 let seq, last = get_seq_last seq in
4109 pr " if (!r[%d]) {\n" i;
4110 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4111 pr " print_strings (r);\n";
4115 pr " char expected[] = \"%s\";\n" (c_quote str);
4116 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
4117 pr " expected[5] = devchar;\n";
4118 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4119 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4124 pr " if (r[%d] != NULL) {\n" (List.length expected);
4125 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4127 pr " print_strings (r);\n";
4131 List.iter (generate_test_command_call test_name) seq;
4132 generate_test_command_call ~test test_name last
4133 | TestOutputInt (seq, expected) ->
4134 pr " /* TestOutputInt for %s (%d) */\n" name i;
4135 let seq, last = get_seq_last seq in
4137 pr " if (r != %d) {\n" expected;
4138 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4144 List.iter (generate_test_command_call test_name) seq;
4145 generate_test_command_call ~test test_name last
4146 | TestOutputTrue seq ->
4147 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4148 let seq, last = get_seq_last seq in
4151 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4156 List.iter (generate_test_command_call test_name) seq;
4157 generate_test_command_call ~test test_name last
4158 | TestOutputFalse seq ->
4159 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4160 let seq, last = get_seq_last seq in
4163 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4168 List.iter (generate_test_command_call test_name) seq;
4169 generate_test_command_call ~test test_name last
4170 | TestOutputLength (seq, expected) ->
4171 pr " /* TestOutputLength for %s (%d) */\n" name i;
4172 let seq, last = get_seq_last seq in
4175 pr " for (j = 0; j < %d; ++j)\n" expected;
4176 pr " if (r[j] == NULL) {\n";
4177 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4179 pr " print_strings (r);\n";
4182 pr " if (r[j] != NULL) {\n";
4183 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4185 pr " print_strings (r);\n";
4189 List.iter (generate_test_command_call test_name) seq;
4190 generate_test_command_call ~test test_name last
4191 | TestOutputStruct (seq, checks) ->
4192 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4193 let seq, last = get_seq_last seq in
4197 | CompareWithInt (field, expected) ->
4198 pr " if (r->%s != %d) {\n" field expected;
4199 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4200 test_name field expected;
4201 pr " (int) r->%s);\n" field;
4204 | CompareWithString (field, expected) ->
4205 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4206 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4207 test_name field expected;
4208 pr " r->%s);\n" field;
4211 | CompareFieldsIntEq (field1, field2) ->
4212 pr " if (r->%s != r->%s) {\n" field1 field2;
4213 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4214 test_name field1 field2;
4215 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
4218 | CompareFieldsStrEq (field1, field2) ->
4219 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4220 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4221 test_name field1 field2;
4222 pr " r->%s, r->%s);\n" field1 field2;
4227 List.iter (generate_test_command_call test_name) seq;
4228 generate_test_command_call ~test test_name last
4229 | TestLastFail seq ->
4230 pr " /* TestLastFail for %s (%d) */\n" name i;
4231 let seq, last = get_seq_last seq in
4232 List.iter (generate_test_command_call test_name) seq;
4233 generate_test_command_call test_name ~expect_error:true last
4235 (* Generate the code to run a command, leaving the result in 'r'.
4236 * If you expect to get an error then you should set expect_error:true.
4238 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4240 | [] -> assert false
4242 (* Look up the command to find out what args/ret it has. *)
4245 let _, style, _, _, _, _, _ =
4246 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4249 failwithf "%s: in test, command %s was not found" test_name name in
4251 if List.length (snd style) <> List.length args then
4252 failwithf "%s: in test, wrong number of args given to %s"
4259 | OptString n, "NULL" -> ()
4261 | OptString n, arg ->
4262 pr " char %s[] = \"%s\";\n" n (c_quote arg);
4263 if String.length arg > 7 && String.sub arg 0 7 = "/dev/sd" then
4264 pr " %s[5] = devchar;\n" n
4267 | FileIn _, _ | FileOut _, _ -> ()
4268 | StringList n, arg ->
4269 let strs = string_split " " arg in
4272 pr " char %s_%d[] = \"%s\";\n" n i (c_quote str);
4273 if String.length str > 7 && String.sub str 0 7 = "/dev/sd" then
4274 pr " %s_%d[5] = devchar;\n" n i
4276 pr " char *%s[] = {\n" n;
4278 fun i _ -> pr " %s_%d,\n" n i
4282 ) (List.combine (snd style) args);
4285 match fst style with
4286 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
4287 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4288 | RConstString _ -> pr " const char *r;\n"; "NULL"
4289 | RString _ -> pr " char *r;\n"; "NULL"
4290 | RStringList _ | RHashtable _ ->
4295 pr " struct guestfs_int_bool *r;\n"; "NULL"
4297 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
4299 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
4301 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
4303 pr " struct guestfs_stat *r;\n"; "NULL"
4305 pr " struct guestfs_statvfs *r;\n"; "NULL" in
4307 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4308 pr " r = guestfs_%s (g" name;
4310 (* Generate the parameters. *)
4313 | OptString _, "NULL" -> pr ", NULL"
4317 | FileIn _, arg | FileOut _, arg ->
4318 pr ", \"%s\"" (c_quote arg)
4319 | StringList n, _ ->
4323 try int_of_string arg
4324 with Failure "int_of_string" ->
4325 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4328 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4329 ) (List.combine (snd style) args);
4332 if not expect_error then
4333 pr " if (r == %s)\n" error_code
4335 pr " if (r != %s)\n" error_code;
4338 (* Insert the test code. *)
4344 (match fst style with
4345 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4346 | RString _ -> pr " free (r);\n"
4347 | RStringList _ | RHashtable _ ->
4348 pr " for (i = 0; r[i] != NULL; ++i)\n";
4349 pr " free (r[i]);\n";
4352 pr " guestfs_free_int_bool (r);\n"
4354 pr " guestfs_free_lvm_pv_list (r);\n"
4356 pr " guestfs_free_lvm_vg_list (r);\n"
4358 pr " guestfs_free_lvm_lv_list (r);\n"
4359 | RStat _ | RStatVFS _ ->
4366 let str = replace_str str "\r" "\\r" in
4367 let str = replace_str str "\n" "\\n" in
4368 let str = replace_str str "\t" "\\t" in
4369 let str = replace_str str "\000" "\\0" in
4372 (* Generate a lot of different functions for guestfish. *)
4373 and generate_fish_cmds () =
4374 generate_header CStyle GPLv2;
4378 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4380 let all_functions_sorted =
4382 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4383 ) all_functions_sorted in
4385 pr "#include <stdio.h>\n";
4386 pr "#include <stdlib.h>\n";
4387 pr "#include <string.h>\n";
4388 pr "#include <inttypes.h>\n";
4390 pr "#include <guestfs.h>\n";
4391 pr "#include \"fish.h\"\n";
4394 (* list_commands function, which implements guestfish -h *)
4395 pr "void list_commands (void)\n";
4397 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
4398 pr " list_builtin_commands ();\n";
4400 fun (name, _, _, flags, _, shortdesc, _) ->
4401 let name = replace_char name '_' '-' in
4402 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4404 ) all_functions_sorted;
4405 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4409 (* display_command function, which implements guestfish -h cmd *)
4410 pr "void display_command (const char *cmd)\n";
4413 fun (name, style, _, flags, _, shortdesc, longdesc) ->
4414 let name2 = replace_char name '_' '-' in
4416 try find_map (function FishAlias n -> Some n | _ -> None) flags
4417 with Not_found -> name in
4418 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4420 match snd style with
4424 name2 (String.concat "> <" (List.map name_of_argt args)) in
4427 if List.mem ProtocolLimitWarning flags then
4428 ("\n\n" ^ protocol_limit_warning)
4431 (* For DangerWillRobinson commands, we should probably have
4432 * guestfish prompt before allowing you to use them (especially
4433 * in interactive mode). XXX
4437 if List.mem DangerWillRobinson flags then
4438 ("\n\n" ^ danger_will_robinson)
4441 let describe_alias =
4442 if name <> alias then
4443 sprintf "\n\nYou can use '%s' as an alias for this command." alias
4447 pr "strcasecmp (cmd, \"%s\") == 0" name;
4448 if name <> name2 then
4449 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4450 if name <> alias then
4451 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4453 pr " pod2text (\"%s - %s\", %S);\n"
4455 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4458 pr " display_builtin_command (cmd);\n";
4462 (* print_{pv,vg,lv}_list functions *)
4466 pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4473 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4475 pr " printf (\"%s: \");\n" name;
4476 pr " for (i = 0; i < 32; ++i)\n";
4477 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
4478 pr " printf (\"\\n\");\n"
4480 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4482 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4483 | name, `OptPercent ->
4484 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4485 typ name name typ name;
4486 pr " else printf (\"%s: \\n\");\n" name
4490 pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4495 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
4496 pr " print_%s (&%ss->val[i]);\n" typ typ;
4499 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4501 (* print_{stat,statvfs} functions *)
4505 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4510 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4514 ) ["stat", stat_cols; "statvfs", statvfs_cols];
4516 (* run_<action> actions *)
4518 fun (name, style, _, flags, _, _, _) ->
4519 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4521 (match fst style with
4524 | RBool _ -> pr " int r;\n"
4525 | RInt64 _ -> pr " int64_t r;\n"
4526 | RConstString _ -> pr " const char *r;\n"
4527 | RString _ -> pr " char *r;\n"
4528 | RStringList _ | RHashtable _ -> pr " char **r;\n"
4529 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"
4530 | RPVList _ -> pr " struct guestfs_lvm_pv_list *r;\n"
4531 | RVGList _ -> pr " struct guestfs_lvm_vg_list *r;\n"
4532 | RLVList _ -> pr " struct guestfs_lvm_lv_list *r;\n"
4533 | RStat _ -> pr " struct guestfs_stat *r;\n"
4534 | RStatVFS _ -> pr " struct guestfs_statvfs *r;\n"
4541 | FileOut n -> pr " const char *%s;\n" n
4542 | StringList n -> pr " char **%s;\n" n
4543 | Bool n -> pr " int %s;\n" n
4544 | Int n -> pr " int %s;\n" n
4547 (* Check and convert parameters. *)
4548 let argc_expected = List.length (snd style) in
4549 pr " if (argc != %d) {\n" argc_expected;
4550 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4552 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4558 | String name -> pr " %s = argv[%d];\n" name i
4560 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4563 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4566 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4568 | StringList name ->
4569 pr " %s = parse_string_list (argv[%d]);\n" name i
4571 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4573 pr " %s = atoi (argv[%d]);\n" name i
4576 (* Call C API function. *)
4578 try find_map (function FishAction n -> Some n | _ -> None) flags
4579 with Not_found -> sprintf "guestfs_%s" name in
4581 generate_call_args ~handle:"g" (snd style);
4584 (* Check return value for errors and display command results. *)
4585 (match fst style with
4586 | RErr -> pr " return r;\n"
4588 pr " if (r == -1) return -1;\n";
4589 pr " printf (\"%%d\\n\", r);\n";
4592 pr " if (r == -1) return -1;\n";
4593 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
4596 pr " if (r == -1) return -1;\n";
4597 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4600 pr " if (r == NULL) return -1;\n";
4601 pr " printf (\"%%s\\n\", r);\n";
4604 pr " if (r == NULL) return -1;\n";
4605 pr " printf (\"%%s\\n\", r);\n";
4609 pr " if (r == NULL) return -1;\n";
4610 pr " print_strings (r);\n";
4611 pr " free_strings (r);\n";
4614 pr " if (r == NULL) return -1;\n";
4615 pr " printf (\"%%d, %%s\\n\", r->i,\n";
4616 pr " r->b ? \"true\" : \"false\");\n";
4617 pr " guestfs_free_int_bool (r);\n";
4620 pr " if (r == NULL) return -1;\n";
4621 pr " print_pv_list (r);\n";
4622 pr " guestfs_free_lvm_pv_list (r);\n";
4625 pr " if (r == NULL) return -1;\n";
4626 pr " print_vg_list (r);\n";
4627 pr " guestfs_free_lvm_vg_list (r);\n";
4630 pr " if (r == NULL) return -1;\n";
4631 pr " print_lv_list (r);\n";
4632 pr " guestfs_free_lvm_lv_list (r);\n";
4635 pr " if (r == NULL) return -1;\n";
4636 pr " print_stat (r);\n";
4640 pr " if (r == NULL) return -1;\n";
4641 pr " print_statvfs (r);\n";
4645 pr " if (r == NULL) return -1;\n";
4646 pr " print_table (r);\n";
4647 pr " free_strings (r);\n";
4654 (* run_action function *)
4655 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4658 fun (name, _, _, flags, _, _, _) ->
4659 let name2 = replace_char name '_' '-' in
4661 try find_map (function FishAlias n -> Some n | _ -> None) flags
4662 with Not_found -> name in
4664 pr "strcasecmp (cmd, \"%s\") == 0" name;
4665 if name <> name2 then
4666 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4667 if name <> alias then
4668 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4670 pr " return run_%s (cmd, argc, argv);\n" name;
4674 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4681 (* Readline completion for guestfish. *)
4682 and generate_fish_completion () =
4683 generate_header CStyle GPLv2;
4687 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4697 #ifdef HAVE_LIBREADLINE
4698 #include <readline/readline.h>
4703 #ifdef HAVE_LIBREADLINE
4705 static const char *const commands[] = {
4706 BUILTIN_COMMANDS_FOR_COMPLETION,
4709 (* Get the commands, including the aliases. They don't need to be
4710 * sorted - the generator() function just does a dumb linear search.
4714 fun (name, _, _, flags, _, _, _) ->
4715 let name2 = replace_char name '_' '-' in
4717 try find_map (function FishAlias n -> Some n | _ -> None) flags
4718 with Not_found -> name in
4720 if name <> alias then [name2; alias] else [name2]
4722 let commands = List.flatten commands in
4724 List.iter (pr " \"%s\",\n") commands;
4730 generator (const char *text, int state)
4732 static int index, len;
4737 len = strlen (text);
4740 while ((name = commands[index]) != NULL) {
4742 if (strncasecmp (name, text, len) == 0)
4743 return strdup (name);
4749 #endif /* HAVE_LIBREADLINE */
4751 char **do_completion (const char *text, int start, int end)
4753 char **matches = NULL;
4755 #ifdef HAVE_LIBREADLINE
4757 matches = rl_completion_matches (text, generator);
4764 (* Generate the POD documentation for guestfish. *)
4765 and generate_fish_actions_pod () =
4766 let all_functions_sorted =
4768 fun (_, _, _, flags, _, _, _) ->
4769 not (List.mem NotInFish flags || List.mem NotInDocs flags)
4770 ) all_functions_sorted in
4772 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4775 fun (name, style, _, flags, _, _, longdesc) ->
4777 Str.global_substitute rex (
4780 try Str.matched_group 1 s
4782 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4783 "C<" ^ replace_char sub '_' '-' ^ ">"
4785 let name = replace_char name '_' '-' in
4787 try find_map (function FishAlias n -> Some n | _ -> None) flags
4788 with Not_found -> name in
4790 pr "=head2 %s" name;
4791 if name <> alias then
4798 | String n -> pr " %s" n
4799 | OptString n -> pr " %s" n
4800 | StringList n -> pr " '%s ...'" n
4801 | Bool _ -> pr " true|false"
4802 | Int n -> pr " %s" n
4803 | FileIn n | FileOut n -> pr " (%s|-)" n
4807 pr "%s\n\n" longdesc;
4809 if List.exists (function FileIn _ | FileOut _ -> true
4810 | _ -> false) (snd style) then
4811 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4813 if List.mem ProtocolLimitWarning flags then
4814 pr "%s\n\n" protocol_limit_warning;
4816 if List.mem DangerWillRobinson flags then
4817 pr "%s\n\n" danger_will_robinson
4818 ) all_functions_sorted
4820 (* Generate a C function prototype. *)
4821 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4822 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4824 ?handle name style =
4825 if extern then pr "extern ";
4826 if static then pr "static ";
4827 (match fst style with
4829 | RInt _ -> pr "int "
4830 | RInt64 _ -> pr "int64_t "
4831 | RBool _ -> pr "int "
4832 | RConstString _ -> pr "const char *"
4833 | RString _ -> pr "char *"
4834 | RStringList _ | RHashtable _ -> pr "char **"
4836 if not in_daemon then pr "struct guestfs_int_bool *"
4837 else pr "guestfs_%s_ret *" name
4839 if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4840 else pr "guestfs_lvm_int_pv_list *"
4842 if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4843 else pr "guestfs_lvm_int_vg_list *"
4845 if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4846 else pr "guestfs_lvm_int_lv_list *"
4848 if not in_daemon then pr "struct guestfs_stat *"
4849 else pr "guestfs_int_stat *"
4851 if not in_daemon then pr "struct guestfs_statvfs *"
4852 else pr "guestfs_int_statvfs *"
4854 pr "%s%s (" prefix name;
4855 if handle = None && List.length (snd style) = 0 then
4858 let comma = ref false in
4861 | Some handle -> pr "guestfs_h *%s" handle; comma := true
4865 if single_line then pr ", " else pr ",\n\t\t"
4872 | OptString n -> next (); pr "const char *%s" n
4873 | StringList n -> next (); pr "char * const* const %s" n
4874 | Bool n -> next (); pr "int %s" n
4875 | Int n -> next (); pr "int %s" n
4878 if not in_daemon then (next (); pr "const char *%s" n)
4882 if semicolon then pr ";";
4883 if newline then pr "\n"
4885 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4886 and generate_call_args ?handle args =
4888 let comma = ref false in
4891 | Some handle -> pr "%s" handle; comma := true
4895 if !comma then pr ", ";
4897 pr "%s" (name_of_argt arg)
4901 (* Generate the OCaml bindings interface. *)
4902 and generate_ocaml_mli () =
4903 generate_header OCamlStyle LGPLv2;
4906 (** For API documentation you should refer to the C API
4907 in the guestfs(3) manual page. The OCaml API uses almost
4908 exactly the same calls. *)
4911 (** A [guestfs_h] handle. *)
4913 exception Error of string
4914 (** This exception is raised when there is an error. *)
4916 val create : unit -> t
4918 val close : t -> unit
4919 (** Handles are closed by the garbage collector when they become
4920 unreferenced, but callers can also call this in order to
4921 provide predictable cleanup. *)
4924 generate_ocaml_lvm_structure_decls ();
4926 generate_ocaml_stat_structure_decls ();
4930 fun (name, style, _, _, _, shortdesc, _) ->
4931 generate_ocaml_prototype name style;
4932 pr "(** %s *)\n" shortdesc;
4936 (* Generate the OCaml bindings implementation. *)
4937 and generate_ocaml_ml () =
4938 generate_header OCamlStyle LGPLv2;
4942 exception Error of string
4943 external create : unit -> t = \"ocaml_guestfs_create\"
4944 external close : t -> unit = \"ocaml_guestfs_close\"
4947 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
4951 generate_ocaml_lvm_structure_decls ();
4953 generate_ocaml_stat_structure_decls ();
4957 fun (name, style, _, _, _, shortdesc, _) ->
4958 generate_ocaml_prototype ~is_external:true name style;
4961 (* Generate the OCaml bindings C implementation. *)
4962 and generate_ocaml_c () =
4963 generate_header CStyle LGPLv2;
4970 #include <caml/config.h>
4971 #include <caml/alloc.h>
4972 #include <caml/callback.h>
4973 #include <caml/fail.h>
4974 #include <caml/memory.h>
4975 #include <caml/mlvalues.h>
4976 #include <caml/signals.h>
4978 #include <guestfs.h>
4980 #include \"guestfs_c.h\"
4982 /* Copy a hashtable of string pairs into an assoc-list. We return
4983 * the list in reverse order, but hashtables aren't supposed to be
4986 static CAMLprim value
4987 copy_table (char * const * argv)
4990 CAMLlocal5 (rv, pairv, kv, vv, cons);
4994 for (i = 0; argv[i] != NULL; i += 2) {
4995 kv = caml_copy_string (argv[i]);
4996 vv = caml_copy_string (argv[i+1]);
4997 pairv = caml_alloc (2, 0);
4998 Store_field (pairv, 0, kv);
4999 Store_field (pairv, 1, vv);
5000 cons = caml_alloc (2, 0);
5001 Store_field (cons, 1, rv);
5003 Store_field (cons, 0, pairv);
5011 (* LVM struct copy functions. *)
5014 let has_optpercent_col =
5015 List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
5017 pr "static CAMLprim value\n";
5018 pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
5020 pr " CAMLparam0 ();\n";
5021 if has_optpercent_col then
5022 pr " CAMLlocal3 (rv, v, v2);\n"
5024 pr " CAMLlocal2 (rv, v);\n";
5026 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5031 pr " v = caml_copy_string (%s->%s);\n" typ name
5033 pr " v = caml_alloc_string (32);\n";
5034 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5037 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5038 | name, `OptPercent ->
5039 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5040 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5041 pr " v = caml_alloc (1, 0);\n";
5042 pr " Store_field (v, 0, v2);\n";
5043 pr " } else /* None */\n";
5044 pr " v = Val_int (0);\n";
5046 pr " Store_field (rv, %d, v);\n" i
5048 pr " CAMLreturn (rv);\n";
5052 pr "static CAMLprim value\n";
5053 pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
5056 pr " CAMLparam0 ();\n";
5057 pr " CAMLlocal2 (rv, v);\n";
5060 pr " if (%ss->len == 0)\n" typ;
5061 pr " CAMLreturn (Atom (0));\n";
5063 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5064 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5065 pr " v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
5066 pr " caml_modify (&Field (rv, i), v);\n";
5068 pr " CAMLreturn (rv);\n";
5072 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5074 (* Stat copy functions. *)
5077 pr "static CAMLprim value\n";
5078 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5080 pr " CAMLparam0 ();\n";
5081 pr " CAMLlocal2 (rv, v);\n";
5083 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5088 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5090 pr " Store_field (rv, %d, v);\n" i
5092 pr " CAMLreturn (rv);\n";
5095 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5099 fun (name, style, _, _, _, _, _) ->
5101 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5103 pr "CAMLprim value\n";
5104 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5105 List.iter (pr ", value %s") (List.tl params);
5110 | [p1; p2; p3; p4; p5] ->
5111 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5112 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5113 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5114 pr " CAMLxparam%d (%s);\n"
5115 (List.length rest) (String.concat ", " rest)
5117 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5119 pr " CAMLlocal1 (rv);\n";
5122 pr " guestfs_h *g = Guestfs_val (gv);\n";
5123 pr " if (g == NULL)\n";
5124 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5132 pr " const char *%s = String_val (%sv);\n" n n
5134 pr " const char *%s =\n" n;
5135 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5138 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5140 pr " int %s = Bool_val (%sv);\n" n n
5142 pr " int %s = Int_val (%sv);\n" n n
5145 match fst style with
5146 | RErr -> pr " int r;\n"; "-1"
5147 | RInt _ -> pr " int r;\n"; "-1"
5148 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5149 | RBool _ -> pr " int r;\n"; "-1"
5150 | RConstString _ -> pr " const char *r;\n"; "NULL"
5151 | RString _ -> pr " char *r;\n"; "NULL"
5157 pr " struct guestfs_int_bool *r;\n"; "NULL"
5159 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
5161 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
5163 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
5165 pr " struct guestfs_stat *r;\n"; "NULL"
5167 pr " struct guestfs_statvfs *r;\n"; "NULL"
5174 pr " caml_enter_blocking_section ();\n";
5175 pr " r = guestfs_%s " name;
5176 generate_call_args ~handle:"g" (snd style);
5178 pr " caml_leave_blocking_section ();\n";
5183 pr " ocaml_guestfs_free_strings (%s);\n" n;
5184 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5187 pr " if (r == %s)\n" error_code;
5188 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5191 (match fst style with
5192 | RErr -> pr " rv = Val_unit;\n"
5193 | RInt _ -> pr " rv = Val_int (r);\n"
5195 pr " rv = caml_copy_int64 (r);\n"
5196 | RBool _ -> pr " rv = Val_bool (r);\n"
5197 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5199 pr " rv = caml_copy_string (r);\n";
5202 pr " rv = caml_copy_string_array ((const char **) r);\n";
5203 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5206 pr " rv = caml_alloc (2, 0);\n";
5207 pr " Store_field (rv, 0, Val_int (r->i));\n";
5208 pr " Store_field (rv, 1, Val_bool (r->b));\n";
5209 pr " guestfs_free_int_bool (r);\n";
5211 pr " rv = copy_lvm_pv_list (r);\n";
5212 pr " guestfs_free_lvm_pv_list (r);\n";
5214 pr " rv = copy_lvm_vg_list (r);\n";
5215 pr " guestfs_free_lvm_vg_list (r);\n";
5217 pr " rv = copy_lvm_lv_list (r);\n";
5218 pr " guestfs_free_lvm_lv_list (r);\n";
5220 pr " rv = copy_stat (r);\n";
5223 pr " rv = copy_statvfs (r);\n";
5226 pr " rv = copy_table (r);\n";
5227 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5231 pr " CAMLreturn (rv);\n";
5235 if List.length params > 5 then (
5236 pr "CAMLprim value\n";
5237 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5239 pr " return ocaml_guestfs_%s (argv[0]" name;
5240 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5247 and generate_ocaml_lvm_structure_decls () =
5250 pr "type lvm_%s = {\n" typ;
5253 | name, `String -> pr " %s : string;\n" name
5254 | name, `UUID -> pr " %s : string;\n" name
5255 | name, `Bytes -> pr " %s : int64;\n" name
5256 | name, `Int -> pr " %s : int64;\n" name
5257 | name, `OptPercent -> pr " %s : float option;\n" name
5261 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
5263 and generate_ocaml_stat_structure_decls () =
5266 pr "type %s = {\n" typ;
5269 | name, `Int -> pr " %s : int64;\n" name
5273 ) ["stat", stat_cols; "statvfs", statvfs_cols]
5275 and generate_ocaml_prototype ?(is_external = false) name style =
5276 if is_external then pr "external " else pr "val ";
5277 pr "%s : t -> " name;
5280 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5281 | OptString _ -> pr "string option -> "
5282 | StringList _ -> pr "string array -> "
5283 | Bool _ -> pr "bool -> "
5284 | Int _ -> pr "int -> "
5286 (match fst style with
5287 | RErr -> pr "unit" (* all errors are turned into exceptions *)
5288 | RInt _ -> pr "int"
5289 | RInt64 _ -> pr "int64"
5290 | RBool _ -> pr "bool"
5291 | RConstString _ -> pr "string"
5292 | RString _ -> pr "string"
5293 | RStringList _ -> pr "string array"
5294 | RIntBool _ -> pr "int * bool"
5295 | RPVList _ -> pr "lvm_pv array"
5296 | RVGList _ -> pr "lvm_vg array"
5297 | RLVList _ -> pr "lvm_lv array"
5298 | RStat _ -> pr "stat"
5299 | RStatVFS _ -> pr "statvfs"
5300 | RHashtable _ -> pr "(string * string) list"
5302 if is_external then (
5304 if List.length (snd style) + 1 > 5 then
5305 pr "\"ocaml_guestfs_%s_byte\" " name;
5306 pr "\"ocaml_guestfs_%s\"" name
5310 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5311 and generate_perl_xs () =
5312 generate_header CStyle LGPLv2;
5315 #include \"EXTERN.h\"
5319 #include <guestfs.h>
5322 #define PRId64 \"lld\"
5326 my_newSVll(long long val) {
5327 #ifdef USE_64_BIT_ALL
5328 return newSViv(val);
5332 len = snprintf(buf, 100, \"%%\" PRId64, val);
5333 return newSVpv(buf, len);
5338 #define PRIu64 \"llu\"
5342 my_newSVull(unsigned long long val) {
5343 #ifdef USE_64_BIT_ALL
5344 return newSVuv(val);
5348 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5349 return newSVpv(buf, len);
5353 /* http://www.perlmonks.org/?node_id=680842 */
5355 XS_unpack_charPtrPtr (SV *arg) {
5360 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5361 croak (\"array reference expected\");
5363 av = (AV *)SvRV (arg);
5364 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5366 croak (\"malloc failed\");
5368 for (i = 0; i <= av_len (av); i++) {
5369 SV **elem = av_fetch (av, i, 0);
5371 if (!elem || !*elem)
5372 croak (\"missing element in list\");
5374 ret[i] = SvPV_nolen (*elem);
5382 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5389 RETVAL = guestfs_create ();
5391 croak (\"could not create guestfs handle\");
5392 guestfs_set_error_handler (RETVAL, NULL, NULL);
5405 fun (name, style, _, _, _, _, _) ->
5406 (match fst style with
5407 | RErr -> pr "void\n"
5408 | RInt _ -> pr "SV *\n"
5409 | RInt64 _ -> pr "SV *\n"
5410 | RBool _ -> pr "SV *\n"
5411 | RConstString _ -> pr "SV *\n"
5412 | RString _ -> pr "SV *\n"
5415 | RPVList _ | RVGList _ | RLVList _
5416 | RStat _ | RStatVFS _
5418 pr "void\n" (* all lists returned implictly on the stack *)
5420 (* Call and arguments. *)
5422 generate_call_args ~handle:"g" (snd style);
5424 pr " guestfs_h *g;\n";
5428 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5430 (* http://www.perlmonks.org/?node_id=554277
5431 * Note that the implicit handle argument means we have
5432 * to add 1 to the ST(x) operator.
5434 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5435 | StringList n -> pr " char **%s;\n" n
5436 | Bool n -> pr " int %s;\n" n
5437 | Int n -> pr " int %s;\n" n
5440 let do_cleanups () =
5443 | String _ | OptString _ | Bool _ | Int _
5444 | FileIn _ | FileOut _ -> ()
5445 | StringList n -> pr " free (%s);\n" n
5450 (match fst style with
5455 pr " r = guestfs_%s " name;
5456 generate_call_args ~handle:"g" (snd style);
5459 pr " if (r == -1)\n";
5460 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5466 pr " %s = guestfs_%s " n name;
5467 generate_call_args ~handle:"g" (snd style);
5470 pr " if (%s == -1)\n" n;
5471 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5472 pr " RETVAL = newSViv (%s);\n" n;
5477 pr " int64_t %s;\n" n;
5479 pr " %s = guestfs_%s " n name;
5480 generate_call_args ~handle:"g" (snd style);
5483 pr " if (%s == -1)\n" n;
5484 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5485 pr " RETVAL = my_newSVll (%s);\n" n;
5490 pr " const char *%s;\n" n;
5492 pr " %s = guestfs_%s " n name;
5493 generate_call_args ~handle:"g" (snd style);
5496 pr " if (%s == NULL)\n" n;
5497 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5498 pr " RETVAL = newSVpv (%s, 0);\n" n;
5503 pr " char *%s;\n" n;
5505 pr " %s = guestfs_%s " n name;
5506 generate_call_args ~handle:"g" (snd style);
5509 pr " if (%s == NULL)\n" n;
5510 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5511 pr " RETVAL = newSVpv (%s, 0);\n" n;
5512 pr " free (%s);\n" n;
5515 | RStringList n | RHashtable n ->
5517 pr " char **%s;\n" n;
5520 pr " %s = guestfs_%s " n name;
5521 generate_call_args ~handle:"g" (snd style);
5524 pr " if (%s == NULL)\n" n;
5525 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5526 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5527 pr " EXTEND (SP, n);\n";
5528 pr " for (i = 0; i < n; ++i) {\n";
5529 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5530 pr " free (%s[i]);\n" n;
5532 pr " free (%s);\n" n;
5535 pr " struct guestfs_int_bool *r;\n";
5537 pr " r = guestfs_%s " name;
5538 generate_call_args ~handle:"g" (snd style);
5541 pr " if (r == NULL)\n";
5542 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5543 pr " EXTEND (SP, 2);\n";
5544 pr " PUSHs (sv_2mortal (newSViv (r->i)));\n";
5545 pr " PUSHs (sv_2mortal (newSViv (r->b)));\n";
5546 pr " guestfs_free_int_bool (r);\n";
5548 generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5550 generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5552 generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5554 generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5556 generate_perl_stat_code
5557 "statvfs" statvfs_cols name style n do_cleanups
5563 and generate_perl_lvm_code typ cols name style n do_cleanups =
5565 pr " struct guestfs_lvm_%s_list *%s;\n" typ n;
5569 pr " %s = guestfs_%s " n name;
5570 generate_call_args ~handle:"g" (snd style);
5573 pr " if (%s == NULL)\n" n;
5574 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5575 pr " EXTEND (SP, %s->len);\n" n;
5576 pr " for (i = 0; i < %s->len; ++i) {\n" n;
5577 pr " hv = newHV ();\n";
5581 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5582 name (String.length name) n name
5584 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5585 name (String.length name) n name
5587 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5588 name (String.length name) n name
5590 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5591 name (String.length name) n name
5592 | name, `OptPercent ->
5593 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5594 name (String.length name) n name
5596 pr " PUSHs (sv_2mortal ((SV *) hv));\n";
5598 pr " guestfs_free_lvm_%s_list (%s);\n" typ n
5600 and generate_perl_stat_code typ cols name style n do_cleanups =
5602 pr " struct guestfs_%s *%s;\n" typ n;
5604 pr " %s = guestfs_%s " n name;
5605 generate_call_args ~handle:"g" (snd style);
5608 pr " if (%s == NULL)\n" n;
5609 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5610 pr " EXTEND (SP, %d);\n" (List.length cols);
5614 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5616 pr " free (%s);\n" n
5618 (* Generate Sys/Guestfs.pm. *)
5619 and generate_perl_pm () =
5620 generate_header HashStyle LGPLv2;
5627 Sys::Guestfs - Perl bindings for libguestfs
5633 my $h = Sys::Guestfs->new ();
5634 $h->add_drive ('guest.img');
5637 $h->mount ('/dev/sda1', '/');
5638 $h->touch ('/hello');
5643 The C<Sys::Guestfs> module provides a Perl XS binding to the
5644 libguestfs API for examining and modifying virtual machine
5647 Amongst the things this is good for: making batch configuration
5648 changes to guests, getting disk used/free statistics (see also:
5649 virt-df), migrating between virtualization systems (see also:
5650 virt-p2v), performing partial backups, performing partial guest
5651 clones, cloning guests and changing registry/UUID/hostname info, and
5654 Libguestfs uses Linux kernel and qemu code, and can access any type of
5655 guest filesystem that Linux and qemu can, including but not limited
5656 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5657 schemes, qcow, qcow2, vmdk.
5659 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5660 LVs, what filesystem is in each LV, etc.). It can also run commands
5661 in the context of the guest. Also you can access filesystems over FTP.
5665 All errors turn into calls to C<croak> (see L<Carp(3)>).
5673 package Sys::Guestfs;
5679 XSLoader::load ('Sys::Guestfs');
5681 =item $h = Sys::Guestfs->new ();
5683 Create a new guestfs handle.
5689 my $class = ref ($proto) || $proto;
5691 my $self = Sys::Guestfs::_create ();
5692 bless $self, $class;
5698 (* Actions. We only need to print documentation for these as
5699 * they are pulled in from the XS code automatically.
5702 fun (name, style, _, flags, _, _, longdesc) ->
5703 if not (List.mem NotInDocs flags) then (
5704 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5706 generate_perl_prototype name style;
5708 pr "%s\n\n" longdesc;
5709 if List.mem ProtocolLimitWarning flags then
5710 pr "%s\n\n" protocol_limit_warning;
5711 if List.mem DangerWillRobinson flags then
5712 pr "%s\n\n" danger_will_robinson
5714 ) all_functions_sorted;
5726 Copyright (C) 2009 Red Hat Inc.
5730 Please see the file COPYING.LIB for the full license.
5734 L<guestfs(3)>, L<guestfish(1)>.
5739 and generate_perl_prototype name style =
5740 (match fst style with
5746 | RString n -> pr "$%s = " n
5747 | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5751 | RLVList n -> pr "@%s = " n
5754 | RHashtable n -> pr "%%%s = " n
5757 let comma = ref false in
5760 if !comma then pr ", ";
5763 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5770 (* Generate Python C module. *)
5771 and generate_python_c () =
5772 generate_header CStyle LGPLv2;
5781 #include \"guestfs.h\"
5789 get_handle (PyObject *obj)
5792 assert (obj != Py_None);
5793 return ((Pyguestfs_Object *) obj)->g;
5797 put_handle (guestfs_h *g)
5801 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5804 /* This list should be freed (but not the strings) after use. */
5805 static const char **
5806 get_string_list (PyObject *obj)
5813 if (!PyList_Check (obj)) {
5814 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5818 len = PyList_Size (obj);
5819 r = malloc (sizeof (char *) * (len+1));
5821 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5825 for (i = 0; i < len; ++i)
5826 r[i] = PyString_AsString (PyList_GetItem (obj, i));
5833 put_string_list (char * const * const argv)
5838 for (argc = 0; argv[argc] != NULL; ++argc)
5841 list = PyList_New (argc);
5842 for (i = 0; i < argc; ++i)
5843 PyList_SetItem (list, i, PyString_FromString (argv[i]));
5849 put_table (char * const * const argv)
5851 PyObject *list, *item;
5854 for (argc = 0; argv[argc] != NULL; ++argc)
5857 list = PyList_New (argc >> 1);
5858 for (i = 0; i < argc; i += 2) {
5859 item = PyTuple_New (2);
5860 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5861 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5862 PyList_SetItem (list, i >> 1, item);
5869 free_strings (char **argv)
5873 for (argc = 0; argv[argc] != NULL; ++argc)
5879 py_guestfs_create (PyObject *self, PyObject *args)
5883 g = guestfs_create ();
5885 PyErr_SetString (PyExc_RuntimeError,
5886 \"guestfs.create: failed to allocate handle\");
5889 guestfs_set_error_handler (g, NULL, NULL);
5890 return put_handle (g);
5894 py_guestfs_close (PyObject *self, PyObject *args)
5899 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5901 g = get_handle (py_g);
5905 Py_INCREF (Py_None);
5911 (* LVM structures, turned into Python dictionaries. *)
5914 pr "static PyObject *\n";
5915 pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5917 pr " PyObject *dict;\n";
5919 pr " dict = PyDict_New ();\n";
5923 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5924 pr " PyString_FromString (%s->%s));\n"
5927 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5928 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
5931 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5932 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
5935 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5936 pr " PyLong_FromLongLong (%s->%s));\n"
5938 | name, `OptPercent ->
5939 pr " if (%s->%s >= 0)\n" typ name;
5940 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5941 pr " PyFloat_FromDouble ((double) %s->%s));\n"
5944 pr " Py_INCREF (Py_None);\n";
5945 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
5948 pr " return dict;\n";
5952 pr "static PyObject *\n";
5953 pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
5955 pr " PyObject *list;\n";
5958 pr " list = PyList_New (%ss->len);\n" typ;
5959 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5960 pr " PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
5961 pr " return list;\n";
5964 ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5966 (* Stat structures, turned into Python dictionaries. *)
5969 pr "static PyObject *\n";
5970 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
5972 pr " PyObject *dict;\n";
5974 pr " dict = PyDict_New ();\n";
5978 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
5979 pr " PyLong_FromLongLong (%s->%s));\n"
5982 pr " return dict;\n";
5985 ) ["stat", stat_cols; "statvfs", statvfs_cols];
5987 (* Python wrapper functions. *)
5989 fun (name, style, _, _, _, _, _) ->
5990 pr "static PyObject *\n";
5991 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
5994 pr " PyObject *py_g;\n";
5995 pr " guestfs_h *g;\n";
5996 pr " PyObject *py_r;\n";
5999 match fst style with
6000 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6001 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6002 | RConstString _ -> pr " const char *r;\n"; "NULL"
6003 | RString _ -> pr " char *r;\n"; "NULL"
6004 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6005 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6006 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6007 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6008 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6009 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6010 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6014 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6015 | OptString n -> pr " const char *%s;\n" n
6017 pr " PyObject *py_%s;\n" n;
6018 pr " const char **%s;\n" n
6019 | Bool n -> pr " int %s;\n" n
6020 | Int n -> pr " int %s;\n" n
6025 (* Convert the parameters. *)
6026 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6029 | String _ | FileIn _ | FileOut _ -> pr "s"
6030 | OptString _ -> pr "z"
6031 | StringList _ -> pr "O"
6032 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6035 pr ":guestfs_%s\",\n" name;
6039 | String n | FileIn n | FileOut n -> pr ", &%s" n
6040 | OptString n -> pr ", &%s" n
6041 | StringList n -> pr ", &py_%s" n
6042 | Bool n -> pr ", &%s" n
6043 | Int n -> pr ", &%s" n
6047 pr " return NULL;\n";
6049 pr " g = get_handle (py_g);\n";
6052 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6054 pr " %s = get_string_list (py_%s);\n" n n;
6055 pr " if (!%s) return NULL;\n" n
6060 pr " r = guestfs_%s " name;
6061 generate_call_args ~handle:"g" (snd style);
6066 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6068 pr " free (%s);\n" n
6071 pr " if (r == %s) {\n" error_code;
6072 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6073 pr " return NULL;\n";
6077 (match fst style with
6079 pr " Py_INCREF (Py_None);\n";
6080 pr " py_r = Py_None;\n"
6082 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6083 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6084 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6086 pr " py_r = PyString_FromString (r);\n";
6089 pr " py_r = put_string_list (r);\n";
6090 pr " free_strings (r);\n"
6092 pr " py_r = PyTuple_New (2);\n";
6093 pr " PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
6094 pr " PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
6095 pr " guestfs_free_int_bool (r);\n"
6097 pr " py_r = put_lvm_pv_list (r);\n";
6098 pr " guestfs_free_lvm_pv_list (r);\n"
6100 pr " py_r = put_lvm_vg_list (r);\n";
6101 pr " guestfs_free_lvm_vg_list (r);\n"
6103 pr " py_r = put_lvm_lv_list (r);\n";
6104 pr " guestfs_free_lvm_lv_list (r);\n"
6106 pr " py_r = put_stat (r);\n";
6109 pr " py_r = put_statvfs (r);\n";
6112 pr " py_r = put_table (r);\n";
6113 pr " free_strings (r);\n"
6116 pr " return py_r;\n";
6121 (* Table of functions. *)
6122 pr "static PyMethodDef methods[] = {\n";
6123 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6124 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6126 fun (name, _, _, _, _, _, _) ->
6127 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6130 pr " { NULL, NULL, 0, NULL }\n";
6134 (* Init function. *)
6137 initlibguestfsmod (void)
6139 static int initialized = 0;
6141 if (initialized) return;
6142 Py_InitModule ((char *) \"libguestfsmod\", methods);
6147 (* Generate Python module. *)
6148 and generate_python_py () =
6149 generate_header HashStyle LGPLv2;
6152 u\"\"\"Python bindings for libguestfs
6155 g = guestfs.GuestFS ()
6156 g.add_drive (\"guest.img\")
6159 parts = g.list_partitions ()
6161 The guestfs module provides a Python binding to the libguestfs API
6162 for examining and modifying virtual machine disk images.
6164 Amongst the things this is good for: making batch configuration
6165 changes to guests, getting disk used/free statistics (see also:
6166 virt-df), migrating between virtualization systems (see also:
6167 virt-p2v), performing partial backups, performing partial guest
6168 clones, cloning guests and changing registry/UUID/hostname info, and
6171 Libguestfs uses Linux kernel and qemu code, and can access any type of
6172 guest filesystem that Linux and qemu can, including but not limited
6173 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6174 schemes, qcow, qcow2, vmdk.
6176 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6177 LVs, what filesystem is in each LV, etc.). It can also run commands
6178 in the context of the guest. Also you can access filesystems over FTP.
6180 Errors which happen while using the API are turned into Python
6181 RuntimeError exceptions.
6183 To create a guestfs handle you usually have to perform the following
6186 # Create the handle, call add_drive at least once, and possibly
6187 # several times if the guest has multiple block devices:
6188 g = guestfs.GuestFS ()
6189 g.add_drive (\"guest.img\")
6191 # Launch the qemu subprocess and wait for it to become ready:
6195 # Now you can issue commands, for example:
6200 import libguestfsmod
6203 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6205 def __init__ (self):
6206 \"\"\"Create a new libguestfs handle.\"\"\"
6207 self._o = libguestfsmod.create ()
6210 libguestfsmod.close (self._o)
6215 fun (name, style, _, flags, _, _, longdesc) ->
6217 generate_call_args ~handle:"self" (snd style);
6220 if not (List.mem NotInDocs flags) then (
6221 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6223 match fst style with
6224 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6227 doc ^ "\n\nThis function returns a list of strings."
6229 doc ^ "\n\nThis function returns a tuple (int, bool).\n"
6231 doc ^ "\n\nThis function returns a list of PVs. Each PV is represented as a dictionary."
6233 doc ^ "\n\nThis function returns a list of VGs. Each VG is represented as a dictionary."
6235 doc ^ "\n\nThis function returns a list of LVs. Each LV is represented as a dictionary."
6237 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
6239 doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
6241 doc ^ "\n\nThis function returns a dictionary." in
6243 if List.mem ProtocolLimitWarning flags then
6244 doc ^ "\n\n" ^ protocol_limit_warning
6247 if List.mem DangerWillRobinson flags then
6248 doc ^ "\n\n" ^ danger_will_robinson
6250 let doc = pod2text ~width:60 name doc in
6251 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6252 let doc = String.concat "\n " doc in
6253 pr " u\"\"\"%s\"\"\"\n" doc;
6255 pr " return libguestfsmod.%s " name;
6256 generate_call_args ~handle:"self._o" (snd style);
6261 (* Useful if you need the longdesc POD text as plain text. Returns a
6264 * This is the slowest thing about autogeneration.
6266 and pod2text ~width name longdesc =
6267 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6268 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6270 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6271 let chan = Unix.open_process_in cmd in
6272 let lines = ref [] in
6274 let line = input_line chan in
6275 if i = 1 then (* discard the first line of output *)
6278 let line = triml line in
6279 lines := line :: !lines;
6282 let lines = try loop 1 with End_of_file -> List.rev !lines in
6283 Unix.unlink filename;
6284 match Unix.close_process_in chan with
6285 | Unix.WEXITED 0 -> lines
6287 failwithf "pod2text: process exited with non-zero status (%d)" i
6288 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6289 failwithf "pod2text: process signalled or stopped by signal %d" i
6291 (* Generate ruby bindings. *)
6292 and generate_ruby_c () =
6293 generate_header CStyle LGPLv2;
6301 #include \"guestfs.h\"
6303 #include \"extconf.h\"
6305 /* For Ruby < 1.9 */
6307 #define RARRAY_LEN(r) (RARRAY((r))->len)
6310 static VALUE m_guestfs; /* guestfs module */
6311 static VALUE c_guestfs; /* guestfs_h handle */
6312 static VALUE e_Error; /* used for all errors */
6314 static void ruby_guestfs_free (void *p)
6317 guestfs_close ((guestfs_h *) p);
6320 static VALUE ruby_guestfs_create (VALUE m)
6324 g = guestfs_create ();
6326 rb_raise (e_Error, \"failed to create guestfs handle\");
6328 /* Don't print error messages to stderr by default. */
6329 guestfs_set_error_handler (g, NULL, NULL);
6331 /* Wrap it, and make sure the close function is called when the
6334 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6337 static VALUE ruby_guestfs_close (VALUE gv)
6340 Data_Get_Struct (gv, guestfs_h, g);
6342 ruby_guestfs_free (g);
6343 DATA_PTR (gv) = NULL;
6351 fun (name, style, _, _, _, _, _) ->
6352 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6353 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6356 pr " guestfs_h *g;\n";
6357 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6359 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6365 | String n | FileIn n | FileOut n ->
6366 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6368 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6369 pr " \"%s\", \"%s\");\n" n name
6371 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6375 pr " int i, len;\n";
6376 pr " len = RARRAY_LEN (%sv);\n" n;
6377 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6379 pr " for (i = 0; i < len; ++i) {\n";
6380 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6381 pr " %s[i] = StringValueCStr (v);\n" n;
6383 pr " %s[len] = NULL;\n" n;
6386 pr " int %s = RTEST (%sv);\n" n n
6388 pr " int %s = NUM2INT (%sv);\n" n n
6393 match fst style with
6394 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6395 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6396 | RConstString _ -> pr " const char *r;\n"; "NULL"
6397 | RString _ -> pr " char *r;\n"; "NULL"
6398 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6399 | RIntBool _ -> pr " struct guestfs_int_bool *r;\n"; "NULL"
6400 | RPVList n -> pr " struct guestfs_lvm_pv_list *r;\n"; "NULL"
6401 | RVGList n -> pr " struct guestfs_lvm_vg_list *r;\n"; "NULL"
6402 | RLVList n -> pr " struct guestfs_lvm_lv_list *r;\n"; "NULL"
6403 | RStat n -> pr " struct guestfs_stat *r;\n"; "NULL"
6404 | RStatVFS n -> pr " struct guestfs_statvfs *r;\n"; "NULL" in
6407 pr " r = guestfs_%s " name;
6408 generate_call_args ~handle:"g" (snd style);
6413 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6415 pr " free (%s);\n" n
6418 pr " if (r == %s)\n" error_code;
6419 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6422 (match fst style with
6424 pr " return Qnil;\n"
6425 | RInt _ | RBool _ ->
6426 pr " return INT2NUM (r);\n"
6428 pr " return ULL2NUM (r);\n"
6430 pr " return rb_str_new2 (r);\n";
6432 pr " VALUE rv = rb_str_new2 (r);\n";
6436 pr " int i, len = 0;\n";
6437 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6438 pr " VALUE rv = rb_ary_new2 (len);\n";
6439 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6440 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6441 pr " free (r[i]);\n";
6446 pr " VALUE rv = rb_ary_new2 (2);\n";
6447 pr " rb_ary_push (rv, INT2NUM (r->i));\n";
6448 pr " rb_ary_push (rv, INT2NUM (r->b));\n";
6449 pr " guestfs_free_int_bool (r);\n";
6452 generate_ruby_lvm_code "pv" pv_cols
6454 generate_ruby_lvm_code "vg" vg_cols
6456 generate_ruby_lvm_code "lv" lv_cols
6458 pr " VALUE rv = rb_hash_new ();\n";
6462 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6467 pr " VALUE rv = rb_hash_new ();\n";
6471 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6476 pr " VALUE rv = rb_hash_new ();\n";
6478 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
6479 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6480 pr " free (r[i]);\n";
6481 pr " free (r[i+1]);\n";
6492 /* Initialize the module. */
6493 void Init__guestfs ()
6495 m_guestfs = rb_define_module (\"Guestfs\");
6496 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6497 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6499 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6500 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6503 (* Define the rest of the methods. *)
6505 fun (name, style, _, _, _, _, _) ->
6506 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
6507 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6512 (* Ruby code to return an LVM struct list. *)
6513 and generate_ruby_lvm_code typ cols =
6514 pr " VALUE rv = rb_ary_new2 (r->len);\n";
6516 pr " for (i = 0; i < r->len; ++i) {\n";
6517 pr " VALUE hv = rb_hash_new ();\n";
6521 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6523 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6526 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6527 | name, `OptPercent ->
6528 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6530 pr " rb_ary_push (rv, hv);\n";
6532 pr " guestfs_free_lvm_%s_list (r);\n" typ;
6535 (* Generate Java bindings GuestFS.java file. *)
6536 and generate_java_java () =
6537 generate_header CStyle LGPLv2;
6540 package com.redhat.et.libguestfs;
6542 import java.util.HashMap;
6543 import com.redhat.et.libguestfs.LibGuestFSException;
6544 import com.redhat.et.libguestfs.PV;
6545 import com.redhat.et.libguestfs.VG;
6546 import com.redhat.et.libguestfs.LV;
6547 import com.redhat.et.libguestfs.Stat;
6548 import com.redhat.et.libguestfs.StatVFS;
6549 import com.redhat.et.libguestfs.IntBool;
6552 * The GuestFS object is a libguestfs handle.
6556 public class GuestFS {
6557 // Load the native code.
6559 System.loadLibrary (\"guestfs_jni\");
6563 * The native guestfs_h pointer.
6568 * Create a libguestfs handle.
6570 * @throws LibGuestFSException
6572 public GuestFS () throws LibGuestFSException
6576 private native long _create () throws LibGuestFSException;
6579 * Close a libguestfs handle.
6581 * You can also leave handles to be collected by the garbage
6582 * collector, but this method ensures that the resources used
6583 * by the handle are freed up immediately. If you call any
6584 * other methods after closing the handle, you will get an
6587 * @throws LibGuestFSException
6589 public void close () throws LibGuestFSException
6595 private native void _close (long g) throws LibGuestFSException;
6597 public void finalize () throws LibGuestFSException
6605 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6606 if not (List.mem NotInDocs flags); then (
6607 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6609 if List.mem ProtocolLimitWarning flags then
6610 doc ^ "\n\n" ^ protocol_limit_warning
6613 if List.mem DangerWillRobinson flags then
6614 doc ^ "\n\n" ^ danger_will_robinson
6616 let doc = pod2text ~width:60 name doc in
6617 let doc = List.map ( (* RHBZ#501883 *)
6620 | nonempty -> nonempty
6622 let doc = String.concat "\n * " doc in
6625 pr " * %s\n" shortdesc;
6628 pr " * @throws LibGuestFSException\n";
6632 generate_java_prototype ~public:true ~semicolon:false name style;
6635 pr " if (g == 0)\n";
6636 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
6639 if fst style <> RErr then pr "return ";
6641 generate_call_args ~handle:"g" (snd style);
6645 generate_java_prototype ~privat:true ~native:true name style;
6652 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6653 ?(semicolon=true) name style =
6654 if privat then pr "private ";
6655 if public then pr "public ";
6656 if native then pr "native ";
6659 (match fst style with
6660 | RErr -> pr "void ";
6661 | RInt _ -> pr "int ";
6662 | RInt64 _ -> pr "long ";
6663 | RBool _ -> pr "boolean ";
6664 | RConstString _ | RString _ -> pr "String ";
6665 | RStringList _ -> pr "String[] ";
6666 | RIntBool _ -> pr "IntBool ";
6667 | RPVList _ -> pr "PV[] ";
6668 | RVGList _ -> pr "VG[] ";
6669 | RLVList _ -> pr "LV[] ";
6670 | RStat _ -> pr "Stat ";
6671 | RStatVFS _ -> pr "StatVFS ";
6672 | RHashtable _ -> pr "HashMap<String,String> ";
6675 if native then pr "_%s " name else pr "%s " name;
6677 let needs_comma = ref false in
6686 if !needs_comma then pr ", ";
6687 needs_comma := true;
6704 pr " throws LibGuestFSException";
6705 if semicolon then pr ";"
6707 and generate_java_struct typ cols =
6708 generate_header CStyle LGPLv2;
6711 package com.redhat.et.libguestfs;
6714 * Libguestfs %s structure.
6725 | name, `UUID -> pr " public String %s;\n" name
6727 | name, `Int -> pr " public long %s;\n" name
6728 | name, `OptPercent ->
6729 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6730 pr " public float %s;\n" name
6735 and generate_java_c () =
6736 generate_header CStyle LGPLv2;
6743 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6744 #include \"guestfs.h\"
6746 /* Note that this function returns. The exception is not thrown
6747 * until after the wrapper function returns.
6750 throw_exception (JNIEnv *env, const char *msg)
6753 cl = (*env)->FindClass (env,
6754 \"com/redhat/et/libguestfs/LibGuestFSException\");
6755 (*env)->ThrowNew (env, cl, msg);
6758 JNIEXPORT jlong JNICALL
6759 Java_com_redhat_et_libguestfs_GuestFS__1create
6760 (JNIEnv *env, jobject obj)
6764 g = guestfs_create ();
6766 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6769 guestfs_set_error_handler (g, NULL, NULL);
6770 return (jlong) (long) g;
6773 JNIEXPORT void JNICALL
6774 Java_com_redhat_et_libguestfs_GuestFS__1close
6775 (JNIEnv *env, jobject obj, jlong jg)
6777 guestfs_h *g = (guestfs_h *) (long) jg;
6784 fun (name, style, _, _, _, _, _) ->
6786 (match fst style with
6787 | RErr -> pr "void ";
6788 | RInt _ -> pr "jint ";
6789 | RInt64 _ -> pr "jlong ";
6790 | RBool _ -> pr "jboolean ";
6791 | RConstString _ | RString _ -> pr "jstring ";
6792 | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6794 | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6798 pr "Java_com_redhat_et_libguestfs_GuestFS_";
6799 pr "%s" (replace_str ("_" ^ name) "_" "_1");
6801 pr " (JNIEnv *env, jobject obj, jlong jg";
6808 pr ", jstring j%s" n
6810 pr ", jobjectArray j%s" n
6812 pr ", jboolean j%s" n
6818 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
6819 let error_code, no_ret =
6820 match fst style with
6821 | RErr -> pr " int r;\n"; "-1", ""
6823 | RInt _ -> pr " int r;\n"; "-1", "0"
6824 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
6825 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
6827 pr " jstring jr;\n";
6828 pr " char *r;\n"; "NULL", "NULL"
6830 pr " jobjectArray jr;\n";
6833 pr " jstring jstr;\n";
6834 pr " char **r;\n"; "NULL", "NULL"
6836 pr " jobject jr;\n";
6838 pr " jfieldID fl;\n";
6839 pr " struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6841 pr " jobject jr;\n";
6843 pr " jfieldID fl;\n";
6844 pr " struct guestfs_stat *r;\n"; "NULL", "NULL"
6846 pr " jobject jr;\n";
6848 pr " jfieldID fl;\n";
6849 pr " struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6851 pr " jobjectArray jr;\n";
6853 pr " jfieldID fl;\n";
6854 pr " jobject jfl;\n";
6855 pr " struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6857 pr " jobjectArray jr;\n";
6859 pr " jfieldID fl;\n";
6860 pr " jobject jfl;\n";
6861 pr " struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6863 pr " jobjectArray jr;\n";
6865 pr " jfieldID fl;\n";
6866 pr " jobject jfl;\n";
6867 pr " struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6868 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
6875 pr " const char *%s;\n" n
6877 pr " int %s_len;\n" n;
6878 pr " const char **%s;\n" n
6885 (match fst style with
6886 | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6887 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6888 | RString _ | RIntBool _ | RStat _ | RStatVFS _
6889 | RHashtable _ -> false) ||
6890 List.exists (function StringList _ -> true | _ -> false) (snd style) in
6896 (* Get the parameters. *)
6902 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6904 (* This is completely undocumented, but Java null becomes
6907 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
6909 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6910 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6911 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6912 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6914 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6916 pr " %s[%s_len] = NULL;\n" n n;
6919 pr " %s = j%s;\n" n n
6922 (* Make the call. *)
6923 pr " r = guestfs_%s " name;
6924 generate_call_args ~handle:"g" (snd style);
6927 (* Release the parameters. *)
6933 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6936 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6938 pr " for (i = 0; i < %s_len; ++i) {\n" n;
6939 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6941 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
6943 pr " free (%s);\n" n
6948 (* Check for errors. *)
6949 pr " if (r == %s) {\n" error_code;
6950 pr " throw_exception (env, guestfs_last_error (g));\n";
6951 pr " return %s;\n" no_ret;
6955 (match fst style with
6957 | RInt _ -> pr " return (jint) r;\n"
6958 | RBool _ -> pr " return (jboolean) r;\n"
6959 | RInt64 _ -> pr " return (jlong) r;\n"
6960 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
6962 pr " jr = (*env)->NewStringUTF (env, r);\n";
6966 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
6967 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
6968 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
6969 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
6970 pr " for (i = 0; i < r_len; ++i) {\n";
6971 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
6972 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
6973 pr " free (r[i]);\n";
6978 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
6979 pr " jr = (*env)->AllocObject (env, cl);\n";
6980 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
6981 pr " (*env)->SetIntField (env, jr, fl, r->i);\n";
6982 pr " fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
6983 pr " (*env)->SetBooleanField (env, jr, fl, r->b);\n";
6984 pr " guestfs_free_int_bool (r);\n";
6987 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
6988 pr " jr = (*env)->AllocObject (env, cl);\n";
6992 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
6994 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
6999 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
7000 pr " jr = (*env)->AllocObject (env, cl);\n";
7004 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7006 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7011 generate_java_lvm_return "pv" "PV" pv_cols
7013 generate_java_lvm_return "vg" "VG" vg_cols
7015 generate_java_lvm_return "lv" "LV" lv_cols
7018 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7019 pr " return NULL;\n"
7026 and generate_java_lvm_return typ jtyp cols =
7027 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7028 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7029 pr " for (i = 0; i < r->len; ++i) {\n";
7030 pr " jfl = (*env)->AllocObject (env, cl);\n";
7034 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7035 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7038 pr " char s[33];\n";
7039 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7041 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7042 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7044 | name, (`Bytes|`Int) ->
7045 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7046 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7047 | name, `OptPercent ->
7048 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7049 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7051 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7053 pr " guestfs_free_lvm_%s_list (r);\n" typ;
7056 and generate_haskell_hs () =
7057 generate_header HaskellStyle LGPLv2;
7059 (* XXX We only know how to generate partial FFI for Haskell
7060 * at the moment. Please help out!
7062 let can_generate style =
7063 let check_no_bad_args =
7064 List.for_all (function Bool _ | Int _ -> false | _ -> true)
7067 | RErr, args -> check_no_bad_args args
7080 | RHashtable _, _ -> false in
7083 {-# INCLUDE <guestfs.h> #-}
7084 {-# LANGUAGE ForeignFunctionInterface #-}
7089 (* List out the names of the actions we want to export. *)
7091 fun (name, style, _, _, _, _, _) ->
7092 if can_generate style then pr ",\n %s" name
7100 import Control.Exception
7101 import Data.Typeable
7103 data GuestfsS = GuestfsS -- represents the opaque C struct
7104 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7105 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7107 -- XXX define properly later XXX
7111 data IntBool = IntBool
7113 data StatVFS = StatVFS
7114 data Hashtable = Hashtable
7116 foreign import ccall unsafe \"guestfs_create\" c_create
7118 foreign import ccall unsafe \"&guestfs_close\" c_close
7119 :: FunPtr (GuestfsP -> IO ())
7120 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7121 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7123 create :: IO GuestfsH
7126 c_set_error_handler p nullPtr nullPtr
7127 h <- newForeignPtr c_close p
7130 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7131 :: GuestfsP -> IO CString
7133 -- last_error :: GuestfsH -> IO (Maybe String)
7134 -- last_error h = do
7135 -- str <- withForeignPtr h (\\p -> c_last_error p)
7136 -- maybePeek peekCString str
7138 last_error :: GuestfsH -> IO (String)
7140 str <- withForeignPtr h (\\p -> c_last_error p)
7142 then return \"no error\"
7143 else peekCString str
7147 (* Generate wrappers for each foreign function. *)
7149 fun (name, style, _, _, _, _, _) ->
7150 if can_generate style then (
7151 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7153 generate_haskell_prototype ~handle:"GuestfsP" style;
7157 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7159 pr "%s %s = do\n" name
7160 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7166 | String n -> pr "withCString %s $ \\%s -> " n n
7167 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7168 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7170 (* XXX this doesn't work *)
7172 pr " %s = case %s of\n" n n;
7175 pr " in fromIntegral %s $ \\%s ->\n" n n
7176 | Int n -> pr "fromIntegral %s $ \\%s -> " n n
7178 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7179 (String.concat " " ("p" :: List.map name_of_argt (snd style)));
7180 (match fst style with
7181 | RErr | RInt _ | RInt64 _ | RBool _ ->
7182 pr " if (r == -1)\n";
7184 pr " err <- last_error h\n";
7186 | RConstString _ | RString _ | RStringList _ | RIntBool _
7187 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7189 pr " if (r == nullPtr)\n";
7191 pr " err <- last_error h\n";
7194 (match fst style with
7196 pr " else return ()\n"
7198 pr " else return (fromIntegral r)\n"
7200 pr " else return (fromIntegral r)\n"
7202 pr " else return (toBool r)\n"
7213 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7219 and generate_haskell_prototype ~handle ?(hs = false) style =
7221 let string = if hs then "String" else "CString" in
7222 let int = if hs then "Int" else "CInt" in
7223 let bool = if hs then "Bool" else "CInt" in
7224 let int64 = if hs then "Integer" else "Int64" in
7228 | String _ -> pr "%s" string
7229 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7230 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7231 | Bool _ -> pr "%s" bool
7232 | Int _ -> pr "%s" int
7233 | FileIn _ -> pr "%s" string
7234 | FileOut _ -> pr "%s" string
7239 (match fst style with
7240 | RErr -> if not hs then pr "CInt"
7241 | RInt _ -> pr "%s" int
7242 | RInt64 _ -> pr "%s" int64
7243 | RBool _ -> pr "%s" bool
7244 | RConstString _ -> pr "%s" string
7245 | RString _ -> pr "%s" string
7246 | RStringList _ -> pr "[%s]" string
7247 | RIntBool _ -> pr "IntBool"
7248 | RPVList _ -> pr "[PV]"
7249 | RVGList _ -> pr "[VG]"
7250 | RLVList _ -> pr "[LV]"
7251 | RStat _ -> pr "Stat"
7252 | RStatVFS _ -> pr "StatVFS"
7253 | RHashtable _ -> pr "Hashtable"
7257 and generate_bindtests () =
7258 generate_header CStyle LGPLv2;
7263 #include <inttypes.h>
7266 #include \"guestfs.h\"
7267 #include \"guestfs_protocol.h\"
7269 #define error guestfs_error
7272 print_strings (char * const* const argv)
7277 for (argc = 0; argv[argc] != NULL; ++argc) {
7278 if (argc > 0) printf (\", \");
7279 printf (\"\\\"%%s\\\"\", argv[argc]);
7284 /* The test0 function prints its parameters to stdout. */
7288 match test_functions with
7289 | [] -> assert false
7290 | test0 :: tests -> test0, tests in
7293 let (name, style, _, _, _, _, _) = test0 in
7294 generate_prototype ~extern:false ~semicolon:false ~newline:true
7295 ~handle:"g" ~prefix:"guestfs_" name style;
7301 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
7302 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7303 | StringList n -> pr " print_strings (%s);\n" n
7304 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7305 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
7307 pr " /* Java changes stdout line buffering so we need this: */\n";
7308 pr " fflush (stdout);\n";
7314 fun (name, style, _, _, _, _, _) ->
7315 if String.sub name (String.length name - 3) 3 <> "err" then (
7316 pr "/* Test normal return. */\n";
7317 generate_prototype ~extern:false ~semicolon:false ~newline:true
7318 ~handle:"g" ~prefix:"guestfs_" name style;
7320 (match fst style with
7325 pr " sscanf (val, \"%%d\", &r);\n";
7329 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
7332 pr " return strcmp (val, \"true\") == 0;\n"
7334 (* Can't return the input string here. Return a static
7335 * string so we ensure we get a segfault if the caller
7338 pr " return \"static string\";\n"
7340 pr " return strdup (val);\n"
7342 pr " char **strs;\n";
7344 pr " sscanf (val, \"%%d\", &n);\n";
7345 pr " strs = malloc ((n+1) * sizeof (char *));\n";
7346 pr " for (i = 0; i < n; ++i) {\n";
7347 pr " strs[i] = malloc (16);\n";
7348 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
7350 pr " strs[n] = NULL;\n";
7351 pr " return strs;\n"
7353 pr " struct guestfs_int_bool *r;\n";
7354 pr " r = malloc (sizeof (struct guestfs_int_bool));\n";
7355 pr " sscanf (val, \"%%\" SCNi32, &r->i);\n";
7359 pr " struct guestfs_lvm_pv_list *r;\n";
7361 pr " r = malloc (sizeof (struct guestfs_lvm_pv_list));\n";
7362 pr " sscanf (val, \"%%d\", &r->len);\n";
7363 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_pv));\n";
7364 pr " for (i = 0; i < r->len; ++i) {\n";
7365 pr " r->val[i].pv_name = malloc (16);\n";
7366 pr " snprintf (r->val[i].pv_name, 16, \"%%d\", i);\n";
7370 pr " struct guestfs_lvm_vg_list *r;\n";
7372 pr " r = malloc (sizeof (struct guestfs_lvm_vg_list));\n";
7373 pr " sscanf (val, \"%%d\", &r->len);\n";
7374 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_vg));\n";
7375 pr " for (i = 0; i < r->len; ++i) {\n";
7376 pr " r->val[i].vg_name = malloc (16);\n";
7377 pr " snprintf (r->val[i].vg_name, 16, \"%%d\", i);\n";
7381 pr " struct guestfs_lvm_lv_list *r;\n";
7383 pr " r = malloc (sizeof (struct guestfs_lvm_lv_list));\n";
7384 pr " sscanf (val, \"%%d\", &r->len);\n";
7385 pr " r->val = calloc (r->len, sizeof (struct guestfs_lvm_lv));\n";
7386 pr " for (i = 0; i < r->len; ++i) {\n";
7387 pr " r->val[i].lv_name = malloc (16);\n";
7388 pr " snprintf (r->val[i].lv_name, 16, \"%%d\", i);\n";
7392 pr " struct guestfs_stat *r;\n";
7393 pr " r = calloc (1, sizeof (*r));\n";
7394 pr " sscanf (val, \"%%\" SCNi64, &r->dev);\n";
7397 pr " struct guestfs_statvfs *r;\n";
7398 pr " r = calloc (1, sizeof (*r));\n";
7399 pr " sscanf (val, \"%%\" SCNi64, &r->bsize);\n";
7402 pr " char **strs;\n";
7404 pr " sscanf (val, \"%%d\", &n);\n";
7405 pr " strs = malloc ((n*2+1) * sizeof (char *));\n";
7406 pr " for (i = 0; i < n; ++i) {\n";
7407 pr " strs[i*2] = malloc (16);\n";
7408 pr " strs[i*2+1] = malloc (16);\n";
7409 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
7410 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7412 pr " strs[n*2] = NULL;\n";
7413 pr " return strs;\n"
7418 pr "/* Test error return. */\n";
7419 generate_prototype ~extern:false ~semicolon:false ~newline:true
7420 ~handle:"g" ~prefix:"guestfs_" name style;
7422 pr " error (g, \"error\");\n";
7423 (match fst style with
7424 | RErr | RInt _ | RInt64 _ | RBool _ ->
7427 | RString _ | RStringList _ | RIntBool _
7428 | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7430 pr " return NULL;\n"
7437 and generate_ocaml_bindtests () =
7438 generate_header OCamlStyle GPLv2;
7442 let g = Guestfs.create () in
7449 | CallString s -> "\"" ^ s ^ "\""
7450 | CallOptString None -> "None"
7451 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7452 | CallStringList xs ->
7453 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7454 | CallInt i when i >= 0 -> string_of_int i
7455 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7456 | CallBool b -> string_of_bool b
7461 generate_lang_bindtests (
7462 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
7465 pr "print_endline \"EOF\"\n"
7467 and generate_perl_bindtests () =
7468 pr "#!/usr/bin/perl -w\n";
7469 generate_header HashStyle GPLv2;
7476 my $g = Sys::Guestfs->new ();
7480 String.concat ", " (
7483 | CallString s -> "\"" ^ s ^ "\""
7484 | CallOptString None -> "undef"
7485 | CallOptString (Some s) -> sprintf "\"%s\"" s
7486 | CallStringList xs ->
7487 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7488 | CallInt i -> string_of_int i
7489 | CallBool b -> if b then "1" else "0"
7494 generate_lang_bindtests (
7495 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7498 pr "print \"EOF\\n\"\n"
7500 and generate_python_bindtests () =
7501 generate_header HashStyle GPLv2;
7506 g = guestfs.GuestFS ()
7510 String.concat ", " (
7513 | CallString s -> "\"" ^ s ^ "\""
7514 | CallOptString None -> "None"
7515 | CallOptString (Some s) -> sprintf "\"%s\"" s
7516 | CallStringList xs ->
7517 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7518 | CallInt i -> string_of_int i
7519 | CallBool b -> if b then "1" else "0"
7524 generate_lang_bindtests (
7525 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
7528 pr "print \"EOF\"\n"
7530 and generate_ruby_bindtests () =
7531 generate_header HashStyle GPLv2;
7536 g = Guestfs::create()
7540 String.concat ", " (
7543 | CallString s -> "\"" ^ s ^ "\""
7544 | CallOptString None -> "nil"
7545 | CallOptString (Some s) -> sprintf "\"%s\"" s
7546 | CallStringList xs ->
7547 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7548 | CallInt i -> string_of_int i
7549 | CallBool b -> string_of_bool b
7554 generate_lang_bindtests (
7555 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
7558 pr "print \"EOF\\n\"\n"
7560 and generate_java_bindtests () =
7561 generate_header CStyle GPLv2;
7564 import com.redhat.et.libguestfs.*;
7566 public class Bindtests {
7567 public static void main (String[] argv)
7570 GuestFS g = new GuestFS ();
7574 String.concat ", " (
7577 | CallString s -> "\"" ^ s ^ "\""
7578 | CallOptString None -> "null"
7579 | CallOptString (Some s) -> sprintf "\"%s\"" s
7580 | CallStringList xs ->
7582 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
7583 | CallInt i -> string_of_int i
7584 | CallBool b -> string_of_bool b
7589 generate_lang_bindtests (
7590 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
7594 System.out.println (\"EOF\");
7596 catch (Exception exn) {
7597 System.err.println (exn);
7604 and generate_haskell_bindtests () =
7605 () (* XXX Haskell bindings need to be fleshed out. *)
7607 (* Language-independent bindings tests - we do it this way to
7608 * ensure there is parity in testing bindings across all languages.
7610 and generate_lang_bindtests call =
7611 call "test0" [CallString "abc"; CallOptString (Some "def");
7612 CallStringList []; CallBool false;
7613 CallInt 0; CallString "123"; CallString "456"];
7614 call "test0" [CallString "abc"; CallOptString None;
7615 CallStringList []; CallBool false;
7616 CallInt 0; CallString "123"; CallString "456"];
7617 call "test0" [CallString ""; CallOptString (Some "def");
7618 CallStringList []; CallBool false;
7619 CallInt 0; CallString "123"; CallString "456"];
7620 call "test0" [CallString ""; CallOptString (Some "");
7621 CallStringList []; CallBool false;
7622 CallInt 0; CallString "123"; CallString "456"];
7623 call "test0" [CallString "abc"; CallOptString (Some "def");
7624 CallStringList ["1"]; CallBool false;
7625 CallInt 0; CallString "123"; CallString "456"];
7626 call "test0" [CallString "abc"; CallOptString (Some "def");
7627 CallStringList ["1"; "2"]; CallBool false;
7628 CallInt 0; CallString "123"; CallString "456"];
7629 call "test0" [CallString "abc"; CallOptString (Some "def");
7630 CallStringList ["1"]; CallBool true;
7631 CallInt 0; CallString "123"; CallString "456"];
7632 call "test0" [CallString "abc"; CallOptString (Some "def");
7633 CallStringList ["1"]; CallBool false;
7634 CallInt (-1); CallString "123"; CallString "456"];
7635 call "test0" [CallString "abc"; CallOptString (Some "def");
7636 CallStringList ["1"]; CallBool false;
7637 CallInt (-2); CallString "123"; CallString "456"];
7638 call "test0" [CallString "abc"; CallOptString (Some "def");
7639 CallStringList ["1"]; CallBool false;
7640 CallInt 1; CallString "123"; CallString "456"];
7641 call "test0" [CallString "abc"; CallOptString (Some "def");
7642 CallStringList ["1"]; CallBool false;
7643 CallInt 2; CallString "123"; CallString "456"];
7644 call "test0" [CallString "abc"; CallOptString (Some "def");
7645 CallStringList ["1"]; CallBool false;
7646 CallInt 4095; CallString "123"; CallString "456"];
7647 call "test0" [CallString "abc"; CallOptString (Some "def");
7648 CallStringList ["1"]; CallBool false;
7649 CallInt 0; CallString ""; CallString ""]
7651 (* XXX Add here tests of the return and error functions. *)
7653 let output_to filename =
7654 let filename_new = filename ^ ".new" in
7655 chan := open_out filename_new;
7660 (* Is the new file different from the current file? *)
7661 if Sys.file_exists filename && files_equal filename filename_new then
7662 Unix.unlink filename_new (* same, so skip it *)
7664 (* different, overwrite old one *)
7665 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
7666 Unix.rename filename_new filename;
7667 Unix.chmod filename 0o444;
7668 printf "written %s\n%!" filename;
7677 if not (Sys.file_exists "configure.ac") then (
7679 You are probably running this from the wrong directory.
7680 Run it from the top source directory using the command
7686 let close = output_to "src/guestfs_protocol.x" in
7690 let close = output_to "src/guestfs-structs.h" in
7691 generate_structs_h ();
7694 let close = output_to "src/guestfs-actions.h" in
7695 generate_actions_h ();
7698 let close = output_to "src/guestfs-actions.c" in
7699 generate_client_actions ();
7702 let close = output_to "daemon/actions.h" in
7703 generate_daemon_actions_h ();
7706 let close = output_to "daemon/stubs.c" in
7707 generate_daemon_actions ();
7710 let close = output_to "capitests/tests.c" in
7714 let close = output_to "src/guestfs-bindtests.c" in
7715 generate_bindtests ();
7718 let close = output_to "fish/cmds.c" in
7719 generate_fish_cmds ();
7722 let close = output_to "fish/completion.c" in
7723 generate_fish_completion ();
7726 let close = output_to "guestfs-structs.pod" in
7727 generate_structs_pod ();
7730 let close = output_to "guestfs-actions.pod" in
7731 generate_actions_pod ();
7734 let close = output_to "guestfish-actions.pod" in
7735 generate_fish_actions_pod ();
7738 let close = output_to "ocaml/guestfs.mli" in
7739 generate_ocaml_mli ();
7742 let close = output_to "ocaml/guestfs.ml" in
7743 generate_ocaml_ml ();
7746 let close = output_to "ocaml/guestfs_c_actions.c" in
7747 generate_ocaml_c ();
7750 let close = output_to "ocaml/bindtests.ml" in
7751 generate_ocaml_bindtests ();
7754 let close = output_to "perl/Guestfs.xs" in
7755 generate_perl_xs ();
7758 let close = output_to "perl/lib/Sys/Guestfs.pm" in
7759 generate_perl_pm ();
7762 let close = output_to "perl/bindtests.pl" in
7763 generate_perl_bindtests ();
7766 let close = output_to "python/guestfs-py.c" in
7767 generate_python_c ();
7770 let close = output_to "python/guestfs.py" in
7771 generate_python_py ();
7774 let close = output_to "python/bindtests.py" in
7775 generate_python_bindtests ();
7778 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
7782 let close = output_to "ruby/bindtests.rb" in
7783 generate_ruby_bindtests ();
7786 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
7787 generate_java_java ();
7790 let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
7791 generate_java_struct "PV" pv_cols;
7794 let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
7795 generate_java_struct "VG" vg_cols;
7798 let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
7799 generate_java_struct "LV" lv_cols;
7802 let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
7803 generate_java_struct "Stat" stat_cols;
7806 let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
7807 generate_java_struct "StatVFS" statvfs_cols;
7810 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
7814 let close = output_to "java/Bindtests.java" in
7815 generate_java_bindtests ();
7818 let close = output_to "haskell/Guestfs.hs" in
7819 generate_haskell_hs ();
7822 let close = output_to "haskell/bindtests.hs" in
7823 generate_haskell_bindtests ();