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 (* "RStruct" is a function which returns a single named structure
70 * or an error indication (in C, a struct, and in other languages
71 * with varying representations, but usually very efficient). See
72 * after the function list below for the structures.
74 | RStruct of string * string (* name of retval, name of struct *)
75 (* "RStructList" is a function which returns either a list/array
76 * of structures (could be zero-length), or an error indication.
78 | RStructList of string * string (* name of retval, name of struct *)
79 (* Key-value pairs of untyped strings. Turns into a hashtable or
80 * dictionary in languages which support it. DON'T use this as a
81 * general "bucket" for results. Prefer a stronger typed return
82 * value if one is available, or write a custom struct. Don't use
83 * this if the list could potentially be very long, since it is
84 * inefficient. Keys should be unique. NULLs are not permitted.
86 | RHashtable of string
88 (* "RBufferOut" is handled almost exactly like RString, but
89 * it allows the string to contain arbitrary 8 bit data including
90 * ASCII NUL. In the C API this causes an implicit extra parameter
91 * to be added of type <size_t *size_r>. Other programming languages
92 * support strings with arbitrary 8 bit data. At the RPC layer
93 * we have to use the opaque<> type instead of string<>.
95 | RBufferOut of string
98 and args = argt list (* Function parameters, guestfs handle is implicit. *)
100 (* Note in future we should allow a "variable args" parameter as
101 * the final parameter, to allow commands like
102 * chmod mode file [file(s)...]
103 * This is not implemented yet, but many commands (such as chmod)
104 * are currently defined with the argument order keeping this future
105 * possibility in mind.
108 | String of string (* const char *name, cannot be NULL *)
109 | OptString of string (* const char *name, may be NULL *)
110 | StringList of string(* list of strings (each string cannot be NULL) *)
111 | Bool of string (* boolean *)
112 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
113 (* These are treated as filenames (simple string parameters) in
114 * the C API and bindings. But in the RPC protocol, we transfer
115 * the actual file content up to or down from the daemon.
116 * FileIn: local machine -> daemon (in request)
117 * FileOut: daemon -> local machine (in reply)
118 * In guestfish (only), the special name "-" means read from
119 * stdin or write to stdout.
124 (* Opaque buffer which can contain arbitrary 8 bit data.
125 * In the C API, this is expressed as <char *, int> pair.
126 * Most other languages have a string type which can contain
127 * ASCII NUL. We use whatever type is appropriate for each
129 * Buffers are limited by the total message size. To transfer
130 * large blocks of data, use FileIn/FileOut parameters instead.
131 * To return an arbitrary buffer, use RBufferOut.
137 | ProtocolLimitWarning (* display warning about protocol size limits *)
138 | DangerWillRobinson (* flags particularly dangerous commands *)
139 | FishAlias of string (* provide an alias for this cmd in guestfish *)
140 | FishAction of string (* call this function in guestfish *)
141 | NotInFish (* do not export via guestfish *)
142 | NotInDocs (* do not add this function to documentation *)
144 let protocol_limit_warning =
145 "Because of the message protocol, there is a transfer limit
146 of somewhere between 2MB and 4MB. To transfer large files you should use
149 let danger_will_robinson =
150 "B<This command is dangerous. Without careful use you
151 can easily destroy all your data>."
153 (* You can supply zero or as many tests as you want per API call.
155 * Note that the test environment has 3 block devices, of size 500MB,
156 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
157 * a fourth squashfs block device with some known files on it (/dev/sdd).
159 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
160 * Number of cylinders was 63 for IDE emulated disks with precisely
161 * the same size. How exactly this is calculated is a mystery.
163 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
165 * To be able to run the tests in a reasonable amount of time,
166 * the virtual machine and block devices are reused between tests.
167 * So don't try testing kill_subprocess :-x
169 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
171 * Don't assume anything about the previous contents of the block
172 * devices. Use 'Init*' to create some initial scenarios.
174 * You can add a prerequisite clause to any individual test. This
175 * is a run-time check, which, if it fails, causes the test to be
176 * skipped. Useful if testing a command which might not work on
177 * all variations of libguestfs builds. A test that has prerequisite
178 * of 'Always' is run unconditionally.
180 * In addition, packagers can skip individual tests by setting the
181 * environment variables: eg:
182 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
183 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
185 type tests = (test_init * test_prereq * test) list
187 (* Run the command sequence and just expect nothing to fail. *)
189 (* Run the command sequence and expect the output of the final
190 * command to be the string.
192 | TestOutput of seq * string
193 (* Run the command sequence and expect the output of the final
194 * command to be the list of strings.
196 | TestOutputList of seq * string list
197 (* Run the command sequence and expect the output of the final
198 * command to be the list of block devices (could be either
199 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
200 * character of each string).
202 | TestOutputListOfDevices of seq * string list
203 (* Run the command sequence and expect the output of the final
204 * command to be the integer.
206 | TestOutputInt of seq * int
207 (* Run the command sequence and expect the output of the final
208 * command to be <op> <int>, eg. ">=", "1".
210 | TestOutputIntOp of seq * string * int
211 (* Run the command sequence and expect the output of the final
212 * command to be a true value (!= 0 or != NULL).
214 | TestOutputTrue of seq
215 (* Run the command sequence and expect the output of the final
216 * command to be a false value (== 0 or == NULL, but not an error).
218 | TestOutputFalse of seq
219 (* Run the command sequence and expect the output of the final
220 * command to be a list of the given length (but don't care about
223 | TestOutputLength of seq * int
224 (* Run the command sequence and expect the output of the final
225 * command to be a structure.
227 | TestOutputStruct of seq * test_field_compare list
228 (* Run the command sequence and expect the final command (only)
231 | TestLastFail of seq
233 and test_field_compare =
234 | CompareWithInt of string * int
235 | CompareWithIntOp of string * string * int
236 | CompareWithString of string * string
237 | CompareFieldsIntEq of string * string
238 | CompareFieldsStrEq of string * string
240 (* Test prerequisites. *)
242 (* Test always runs. *)
244 (* Test is currently disabled - eg. it fails, or it tests some
245 * unimplemented feature.
248 (* 'string' is some C code (a function body) that should return
249 * true or false. The test will run if the code returns true.
252 (* As for 'If' but the test runs _unless_ the code returns true. *)
255 (* Some initial scenarios for testing. *)
257 (* Do nothing, block devices could contain random stuff including
258 * LVM PVs, and some filesystems might be mounted. This is usually
262 (* Block devices are empty and no filesystems are mounted. *)
264 (* /dev/sda contains a single partition /dev/sda1, which is formatted
265 * as ext2, empty [except for lost+found] and mounted on /.
266 * /dev/sdb and /dev/sdc may have random content.
271 * /dev/sda1 (is a PV):
272 * /dev/VG/LV (size 8MB):
273 * formatted as ext2, empty [except for lost+found], mounted on /
274 * /dev/sdb and /dev/sdc may have random content.
278 (* Sequence of commands for testing. *)
280 and cmd = string list
282 (* Note about long descriptions: When referring to another
283 * action, use the format C<guestfs_other> (ie. the full name of
284 * the C function). This will be replaced as appropriate in other
287 * Apart from that, long descriptions are just perldoc paragraphs.
290 (* These test functions are used in the language binding tests. *)
292 let test_all_args = [
295 StringList "strlist";
302 let test_all_rets = [
303 (* except for RErr, which is tested thoroughly elsewhere *)
304 "test0rint", RInt "valout";
305 "test0rint64", RInt64 "valout";
306 "test0rbool", RBool "valout";
307 "test0rconststring", RConstString "valout";
308 "test0rstring", RString "valout";
309 "test0rstringlist", RStringList "valout";
310 "test0rstruct", RStruct ("valout", "lvm_pv");
311 "test0rstructlist", RStructList ("valout", "lvm_pv");
312 "test0rhashtable", RHashtable "valout";
315 let test_functions = [
316 ("test0", (RErr, test_all_args), -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 parameter type correctly.
324 It echos the contents of each parameter to stdout.
326 You probably don't want to call this function.");
330 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
332 "internal test function - do not use",
334 This is an internal test function which is used to test whether
335 the automatically generated bindings can handle every possible
336 return type correctly.
338 It converts string C<val> to the return type.
340 You probably don't want to call this function.");
341 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
343 "internal test function - do not use",
345 This is an internal test function which is used to test whether
346 the automatically generated bindings can handle every possible
347 return type correctly.
349 This function always returns an error.
351 You probably don't want to call this function.")]
355 (* non_daemon_functions are any functions which don't get processed
356 * in the daemon, eg. functions for setting and getting local
357 * configuration values.
360 let non_daemon_functions = test_functions @ [
361 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
363 "launch the qemu subprocess",
365 Internally libguestfs is implemented by running a virtual machine
368 You should call this after configuring the handle
369 (eg. adding drives) but before performing any actions.");
371 ("wait_ready", (RErr, []), -1, [NotInFish],
373 "wait until the qemu subprocess launches",
375 Internally libguestfs is implemented by running a virtual machine
378 You should call this after C<guestfs_launch> to wait for the launch
381 ("kill_subprocess", (RErr, []), -1, [],
383 "kill the qemu subprocess",
385 This kills the qemu subprocess. You should never need to call this.");
387 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
389 "add an image to examine or modify",
391 This function adds a virtual machine disk image C<filename> to the
392 guest. The first time you call this function, the disk appears as IDE
393 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
396 You don't necessarily need to be root when using libguestfs. However
397 you obviously do need sufficient permissions to access the filename
398 for whatever operations you want to perform (ie. read access if you
399 just want to read the image or write access if you want to modify the
402 This is equivalent to the qemu parameter
403 C<-drive file=filename,cache=off,if=...>.
405 Note that this call checks for the existence of C<filename>. This
406 stops you from specifying other types of drive which are supported
407 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
408 the general C<guestfs_config> call instead.");
410 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
412 "add a CD-ROM disk image to examine",
414 This function adds a virtual CD-ROM disk image to the guest.
416 This is equivalent to the qemu parameter C<-cdrom filename>.
418 Note that this call checks for the existence of C<filename>. This
419 stops you from specifying other types of drive which are supported
420 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
421 the general C<guestfs_config> call instead.");
423 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
425 "add a drive in snapshot mode (read-only)",
427 This adds a drive in snapshot mode, making it effectively
430 Note that writes to the device are allowed, and will be seen for
431 the duration of the guestfs handle, but they are written
432 to a temporary file which is discarded as soon as the guestfs
433 handle is closed. We don't currently have any method to enable
434 changes to be committed, although qemu can support this.
436 This is equivalent to the qemu parameter
437 C<-drive file=filename,snapshot=on,if=...>.
439 Note that this call checks for the existence of C<filename>. This
440 stops you from specifying other types of drive which are supported
441 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
442 the general C<guestfs_config> call instead.");
444 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
446 "add qemu parameters",
448 This can be used to add arbitrary qemu command line parameters
449 of the form C<-param value>. Actually it's not quite arbitrary - we
450 prevent you from setting some parameters which would interfere with
451 parameters that we use.
453 The first character of C<param> string must be a C<-> (dash).
455 C<value> can be NULL.");
457 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
459 "set the qemu binary",
461 Set the qemu binary that we will use.
463 The default is chosen when the library was compiled by the
466 You can also override this by setting the C<LIBGUESTFS_QEMU>
467 environment variable.
469 Setting C<qemu> to C<NULL> restores the default qemu binary.");
471 ("get_qemu", (RConstString "qemu", []), -1, [],
472 [InitNone, Always, TestRun (
474 "get the qemu binary",
476 Return the current qemu binary.
478 This is always non-NULL. If it wasn't set already, then this will
479 return the default qemu binary name.");
481 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
483 "set the search path",
485 Set the path that libguestfs searches for kernel and initrd.img.
487 The default is C<$libdir/guestfs> unless overridden by setting
488 C<LIBGUESTFS_PATH> environment variable.
490 Setting C<path> to C<NULL> restores the default path.");
492 ("get_path", (RConstString "path", []), -1, [],
493 [InitNone, Always, TestRun (
495 "get the search path",
497 Return the current search path.
499 This is always non-NULL. If it wasn't set already, then this will
500 return the default path.");
502 ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
504 "add options to kernel command line",
506 This function is used to add additional options to the
507 guest kernel command line.
509 The default is C<NULL> unless overridden by setting
510 C<LIBGUESTFS_APPEND> environment variable.
512 Setting C<append> to C<NULL> means I<no> additional options
513 are passed (libguestfs always adds a few of its own).");
515 ("get_append", (RConstString "append", []), -1, [],
516 (* This cannot be tested with the current framework. The
517 * function can return NULL in normal operations, which the
518 * test framework interprets as an error.
521 "get the additional kernel options",
523 Return the additional kernel options which are added to the
524 guest kernel command line.
526 If C<NULL> then no options are added.");
528 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
532 If C<autosync> is true, this enables autosync. Libguestfs will make a
533 best effort attempt to run C<guestfs_umount_all> followed by
534 C<guestfs_sync> when the handle is closed
535 (also if the program exits without closing handles).
537 This is disabled by default (except in guestfish where it is
538 enabled by default).");
540 ("get_autosync", (RBool "autosync", []), -1, [],
541 [InitNone, Always, TestRun (
542 [["get_autosync"]])],
545 Get the autosync flag.");
547 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
551 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
553 Verbose messages are disabled unless the environment variable
554 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
556 ("get_verbose", (RBool "verbose", []), -1, [],
560 This returns the verbose messages flag.");
562 ("is_ready", (RBool "ready", []), -1, [],
563 [InitNone, Always, TestOutputTrue (
565 "is ready to accept commands",
567 This returns true iff this handle is ready to accept commands
568 (in the C<READY> state).
570 For more information on states, see L<guestfs(3)>.");
572 ("is_config", (RBool "config", []), -1, [],
573 [InitNone, Always, TestOutputFalse (
575 "is in configuration state",
577 This returns true iff this handle is being configured
578 (in the C<CONFIG> state).
580 For more information on states, see L<guestfs(3)>.");
582 ("is_launching", (RBool "launching", []), -1, [],
583 [InitNone, Always, TestOutputFalse (
584 [["is_launching"]])],
585 "is launching subprocess",
587 This returns true iff this handle is launching the subprocess
588 (in the C<LAUNCHING> state).
590 For more information on states, see L<guestfs(3)>.");
592 ("is_busy", (RBool "busy", []), -1, [],
593 [InitNone, Always, TestOutputFalse (
595 "is busy processing a command",
597 This returns true iff this handle is busy processing a command
598 (in the C<BUSY> state).
600 For more information on states, see L<guestfs(3)>.");
602 ("get_state", (RInt "state", []), -1, [],
604 "get the current state",
606 This returns the current state as an opaque integer. This is
607 only useful for printing debug and internal error messages.
609 For more information on states, see L<guestfs(3)>.");
611 ("set_busy", (RErr, []), -1, [NotInFish],
615 This sets the state to C<BUSY>. This is only used when implementing
616 actions using the low-level API.
618 For more information on states, see L<guestfs(3)>.");
620 ("set_ready", (RErr, []), -1, [NotInFish],
622 "set state to ready",
624 This sets the state to C<READY>. This is only used when implementing
625 actions using the low-level API.
627 For more information on states, see L<guestfs(3)>.");
629 ("end_busy", (RErr, []), -1, [NotInFish],
631 "leave the busy state",
633 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
634 state as is. This is only used when implementing
635 actions using the low-level API.
637 For more information on states, see L<guestfs(3)>.");
639 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
640 [InitNone, Always, TestOutputInt (
641 [["set_memsize"; "500"];
642 ["get_memsize"]], 500)],
643 "set memory allocated to the qemu subprocess",
645 This sets the memory size in megabytes allocated to the
646 qemu subprocess. This only has any effect if called before
649 You can also change this by setting the environment
650 variable C<LIBGUESTFS_MEMSIZE> before the handle is
653 For more information on the architecture of libguestfs,
654 see L<guestfs(3)>.");
656 ("get_memsize", (RInt "memsize", []), -1, [],
657 [InitNone, Always, TestOutputIntOp (
658 [["get_memsize"]], ">=", 256)],
659 "get memory allocated to the qemu subprocess",
661 This gets the memory size in megabytes allocated to the
664 If C<guestfs_set_memsize> was not called
665 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
666 then this returns the compiled-in default value for memsize.
668 For more information on the architecture of libguestfs,
669 see L<guestfs(3)>.");
671 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
672 [InitNone, Always, TestOutputIntOp (
673 [["get_pid"]], ">=", 1)],
674 "get PID of qemu subprocess",
676 Return the process ID of the qemu subprocess. If there is no
677 qemu subprocess, then this will return an error.
679 This is an internal call used for debugging and testing.");
681 ("version", (RStruct ("version", "version"), []), -1, [],
682 [InitNone, Always, TestOutputStruct (
683 [["version"]], [CompareWithInt ("major", 1)])],
684 "get the library version number",
686 Return the libguestfs version number that the program is linked
689 Note that because of dynamic linking this is not necessarily
690 the version of libguestfs that you compiled against. You can
691 compile the program, and then at runtime dynamically link
692 against a completely different C<libguestfs.so> library.
694 This call was added in version C<1.0.58>. In previous
695 versions of libguestfs there was no way to get the version
696 number. From C code you can use ELF weak linking tricks to find out if
697 this symbol exists (if it doesn't, then it's an earlier version).
699 The call returns a structure with four elements. The first
700 three (C<major>, C<minor> and C<release>) are numbers and
701 correspond to the usual version triplet. The fourth element
702 (C<extra>) is a string and is normally empty, but may be
703 used for distro-specific information.
705 To construct the original version string:
706 C<$major.$minor.$release$extra>
708 I<Note:> Don't use this call to test for availability
709 of features. Distro backports makes this unreliable.");
713 (* daemon_functions are any functions which cause some action
714 * to take place in the daemon.
717 let daemon_functions = [
718 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
719 [InitEmpty, Always, TestOutput (
720 [["sfdiskM"; "/dev/sda"; ","];
721 ["mkfs"; "ext2"; "/dev/sda1"];
722 ["mount"; "/dev/sda1"; "/"];
723 ["write_file"; "/new"; "new file contents"; "0"];
724 ["cat"; "/new"]], "new file contents")],
725 "mount a guest disk at a position in the filesystem",
727 Mount a guest disk at a position in the filesystem. Block devices
728 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
729 the guest. If those block devices contain partitions, they will have
730 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
733 The rules are the same as for L<mount(2)>: A filesystem must
734 first be mounted on C</> before others can be mounted. Other
735 filesystems can only be mounted on directories which already
738 The mounted filesystem is writable, if we have sufficient permissions
739 on the underlying device.
741 The filesystem options C<sync> and C<noatime> are set with this
742 call, in order to improve reliability.");
744 ("sync", (RErr, []), 2, [],
745 [ InitEmpty, Always, TestRun [["sync"]]],
746 "sync disks, writes are flushed through to the disk image",
748 This syncs the disk, so that any writes are flushed through to the
749 underlying disk image.
751 You should always call this if you have modified a disk image, before
752 closing the handle.");
754 ("touch", (RErr, [String "path"]), 3, [],
755 [InitBasicFS, Always, TestOutputTrue (
757 ["exists"; "/new"]])],
758 "update file timestamps or create a new file",
760 Touch acts like the L<touch(1)> command. It can be used to
761 update the timestamps on a file, or, if the file does not exist,
762 to create a new zero-length file.");
764 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
765 [InitBasicFS, Always, TestOutput (
766 [["write_file"; "/new"; "new file contents"; "0"];
767 ["cat"; "/new"]], "new file contents")],
768 "list the contents of a file",
770 Return the contents of the file named C<path>.
772 Note that this function cannot correctly handle binary files
773 (specifically, files containing C<\\0> character which is treated
774 as end of string). For those you need to use the C<guestfs_download>
775 function which has a more complex interface.");
777 ("ll", (RString "listing", [String "directory"]), 5, [],
778 [], (* XXX Tricky to test because it depends on the exact format
779 * of the 'ls -l' command, which changes between F10 and F11.
781 "list the files in a directory (long format)",
783 List the files in C<directory> (relative to the root directory,
784 there is no cwd) in the format of 'ls -la'.
786 This command is mostly useful for interactive sessions. It
787 is I<not> intended that you try to parse the output string.");
789 ("ls", (RStringList "listing", [String "directory"]), 6, [],
790 [InitBasicFS, Always, TestOutputList (
793 ["touch"; "/newest"];
794 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
795 "list the files in a directory",
797 List the files in C<directory> (relative to the root directory,
798 there is no cwd). The '.' and '..' entries are not returned, but
799 hidden files are shown.
801 This command is mostly useful for interactive sessions. Programs
802 should probably use C<guestfs_readdir> instead.");
804 ("list_devices", (RStringList "devices", []), 7, [],
805 [InitEmpty, Always, TestOutputListOfDevices (
806 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
807 "list the block devices",
809 List all the block devices.
811 The full block device names are returned, eg. C</dev/sda>");
813 ("list_partitions", (RStringList "partitions", []), 8, [],
814 [InitBasicFS, Always, TestOutputListOfDevices (
815 [["list_partitions"]], ["/dev/sda1"]);
816 InitEmpty, Always, TestOutputListOfDevices (
817 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
818 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
819 "list the partitions",
821 List all the partitions detected on all block devices.
823 The full partition device names are returned, eg. C</dev/sda1>
825 This does not return logical volumes. For that you will need to
826 call C<guestfs_lvs>.");
828 ("pvs", (RStringList "physvols", []), 9, [],
829 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
830 [["pvs"]], ["/dev/sda1"]);
831 InitEmpty, Always, TestOutputListOfDevices (
832 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
833 ["pvcreate"; "/dev/sda1"];
834 ["pvcreate"; "/dev/sda2"];
835 ["pvcreate"; "/dev/sda3"];
836 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
837 "list the LVM physical volumes (PVs)",
839 List all the physical volumes detected. This is the equivalent
840 of the L<pvs(8)> command.
842 This returns a list of just the device names that contain
843 PVs (eg. C</dev/sda2>).
845 See also C<guestfs_pvs_full>.");
847 ("vgs", (RStringList "volgroups", []), 10, [],
848 [InitBasicFSonLVM, Always, TestOutputList (
850 InitEmpty, Always, TestOutputList (
851 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
852 ["pvcreate"; "/dev/sda1"];
853 ["pvcreate"; "/dev/sda2"];
854 ["pvcreate"; "/dev/sda3"];
855 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
856 ["vgcreate"; "VG2"; "/dev/sda3"];
857 ["vgs"]], ["VG1"; "VG2"])],
858 "list the LVM volume groups (VGs)",
860 List all the volumes groups detected. This is the equivalent
861 of the L<vgs(8)> command.
863 This returns a list of just the volume group names that were
864 detected (eg. C<VolGroup00>).
866 See also C<guestfs_vgs_full>.");
868 ("lvs", (RStringList "logvols", []), 11, [],
869 [InitBasicFSonLVM, Always, TestOutputList (
870 [["lvs"]], ["/dev/VG/LV"]);
871 InitEmpty, Always, TestOutputList (
872 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
873 ["pvcreate"; "/dev/sda1"];
874 ["pvcreate"; "/dev/sda2"];
875 ["pvcreate"; "/dev/sda3"];
876 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
877 ["vgcreate"; "VG2"; "/dev/sda3"];
878 ["lvcreate"; "LV1"; "VG1"; "50"];
879 ["lvcreate"; "LV2"; "VG1"; "50"];
880 ["lvcreate"; "LV3"; "VG2"; "50"];
881 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
882 "list the LVM logical volumes (LVs)",
884 List all the logical volumes detected. This is the equivalent
885 of the L<lvs(8)> command.
887 This returns a list of the logical volume device names
888 (eg. C</dev/VolGroup00/LogVol00>).
890 See also C<guestfs_lvs_full>.");
892 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
893 [], (* XXX how to test? *)
894 "list the LVM physical volumes (PVs)",
896 List all the physical volumes detected. This is the equivalent
897 of the L<pvs(8)> command. The \"full\" version includes all fields.");
899 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
900 [], (* XXX how to test? *)
901 "list the LVM volume groups (VGs)",
903 List all the volumes groups detected. This is the equivalent
904 of the L<vgs(8)> command. The \"full\" version includes all fields.");
906 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
907 [], (* XXX how to test? *)
908 "list the LVM logical volumes (LVs)",
910 List all the logical volumes detected. This is the equivalent
911 of the L<lvs(8)> command. The \"full\" version includes all fields.");
913 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
914 [InitBasicFS, Always, TestOutputList (
915 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
916 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
917 InitBasicFS, Always, TestOutputList (
918 [["write_file"; "/new"; ""; "0"];
919 ["read_lines"; "/new"]], [])],
920 "read file as lines",
922 Return the contents of the file named C<path>.
924 The file contents are returned as a list of lines. Trailing
925 C<LF> and C<CRLF> character sequences are I<not> returned.
927 Note that this function cannot correctly handle binary files
928 (specifically, files containing C<\\0> character which is treated
929 as end of line). For those you need to use the C<guestfs_read_file>
930 function which has a more complex interface.");
932 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
933 [], (* XXX Augeas code needs tests. *)
934 "create a new Augeas handle",
936 Create a new Augeas handle for editing configuration files.
937 If there was any previous Augeas handle associated with this
938 guestfs session, then it is closed.
940 You must call this before using any other C<guestfs_aug_*>
943 C<root> is the filesystem root. C<root> must not be NULL,
946 The flags are the same as the flags defined in
947 E<lt>augeas.hE<gt>, the logical I<or> of the following
952 =item C<AUG_SAVE_BACKUP> = 1
954 Keep the original file with a C<.augsave> extension.
956 =item C<AUG_SAVE_NEWFILE> = 2
958 Save changes into a file with extension C<.augnew>, and
959 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
961 =item C<AUG_TYPE_CHECK> = 4
963 Typecheck lenses (can be expensive).
965 =item C<AUG_NO_STDINC> = 8
967 Do not use standard load path for modules.
969 =item C<AUG_SAVE_NOOP> = 16
971 Make save a no-op, just record what would have been changed.
973 =item C<AUG_NO_LOAD> = 32
975 Do not load the tree in C<guestfs_aug_init>.
979 To close the handle, you can call C<guestfs_aug_close>.
981 To find out more about Augeas, see L<http://augeas.net/>.");
983 ("aug_close", (RErr, []), 26, [],
984 [], (* XXX Augeas code needs tests. *)
985 "close the current Augeas handle",
987 Close the current Augeas handle and free up any resources
988 used by it. After calling this, you have to call
989 C<guestfs_aug_init> again before you can use any other
992 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
993 [], (* XXX Augeas code needs tests. *)
994 "define an Augeas variable",
996 Defines an Augeas variable C<name> whose value is the result
997 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1000 On success this returns the number of nodes in C<expr>, or
1001 C<0> if C<expr> evaluates to something which is not a nodeset.");
1003 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1004 [], (* XXX Augeas code needs tests. *)
1005 "define an Augeas node",
1007 Defines a variable C<name> whose value is the result of
1010 If C<expr> evaluates to an empty nodeset, a node is created,
1011 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1012 C<name> will be the nodeset containing that single node.
1014 On success this returns a pair containing the
1015 number of nodes in the nodeset, and a boolean flag
1016 if a node was created.");
1018 ("aug_get", (RString "val", [String "path"]), 19, [],
1019 [], (* XXX Augeas code needs tests. *)
1020 "look up the value of an Augeas path",
1022 Look up the value associated with C<path>. If C<path>
1023 matches exactly one node, the C<value> is returned.");
1025 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
1026 [], (* XXX Augeas code needs tests. *)
1027 "set Augeas path to value",
1029 Set the value associated with C<path> to C<value>.");
1031 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
1032 [], (* XXX Augeas code needs tests. *)
1033 "insert a sibling Augeas node",
1035 Create a new sibling C<label> for C<path>, inserting it into
1036 the tree before or after C<path> (depending on the boolean
1039 C<path> must match exactly one existing node in the tree, and
1040 C<label> must be a label, ie. not contain C</>, C<*> or end
1041 with a bracketed index C<[N]>.");
1043 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
1044 [], (* XXX Augeas code needs tests. *)
1045 "remove an Augeas path",
1047 Remove C<path> and all of its children.
1049 On success this returns the number of entries which were removed.");
1051 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1052 [], (* XXX Augeas code needs tests. *)
1055 Move the node C<src> to C<dest>. C<src> must match exactly
1056 one node. C<dest> is overwritten if it exists.");
1058 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
1059 [], (* XXX Augeas code needs tests. *)
1060 "return Augeas nodes which match path",
1062 Returns a list of paths which match the path expression C<path>.
1063 The returned paths are sufficiently qualified so that they match
1064 exactly one node in the current tree.");
1066 ("aug_save", (RErr, []), 25, [],
1067 [], (* XXX Augeas code needs tests. *)
1068 "write all pending Augeas changes to disk",
1070 This writes all pending changes to disk.
1072 The flags which were passed to C<guestfs_aug_init> affect exactly
1073 how files are saved.");
1075 ("aug_load", (RErr, []), 27, [],
1076 [], (* XXX Augeas code needs tests. *)
1077 "load files into the tree",
1079 Load files into the tree.
1081 See C<aug_load> in the Augeas documentation for the full gory
1084 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
1085 [], (* XXX Augeas code needs tests. *)
1086 "list Augeas nodes under a path",
1088 This is just a shortcut for listing C<guestfs_aug_match>
1089 C<path/*> and sorting the resulting nodes into alphabetical order.");
1091 ("rm", (RErr, [String "path"]), 29, [],
1092 [InitBasicFS, Always, TestRun
1095 InitBasicFS, Always, TestLastFail
1097 InitBasicFS, Always, TestLastFail
1102 Remove the single file C<path>.");
1104 ("rmdir", (RErr, [String "path"]), 30, [],
1105 [InitBasicFS, Always, TestRun
1108 InitBasicFS, Always, TestLastFail
1109 [["rmdir"; "/new"]];
1110 InitBasicFS, Always, TestLastFail
1112 ["rmdir"; "/new"]]],
1113 "remove a directory",
1115 Remove the single directory C<path>.");
1117 ("rm_rf", (RErr, [String "path"]), 31, [],
1118 [InitBasicFS, Always, TestOutputFalse
1120 ["mkdir"; "/new/foo"];
1121 ["touch"; "/new/foo/bar"];
1123 ["exists"; "/new"]]],
1124 "remove a file or directory recursively",
1126 Remove the file or directory C<path>, recursively removing the
1127 contents if its a directory. This is like the C<rm -rf> shell
1130 ("mkdir", (RErr, [String "path"]), 32, [],
1131 [InitBasicFS, Always, TestOutputTrue
1133 ["is_dir"; "/new"]];
1134 InitBasicFS, Always, TestLastFail
1135 [["mkdir"; "/new/foo/bar"]]],
1136 "create a directory",
1138 Create a directory named C<path>.");
1140 ("mkdir_p", (RErr, [String "path"]), 33, [],
1141 [InitBasicFS, Always, TestOutputTrue
1142 [["mkdir_p"; "/new/foo/bar"];
1143 ["is_dir"; "/new/foo/bar"]];
1144 InitBasicFS, Always, TestOutputTrue
1145 [["mkdir_p"; "/new/foo/bar"];
1146 ["is_dir"; "/new/foo"]];
1147 InitBasicFS, Always, TestOutputTrue
1148 [["mkdir_p"; "/new/foo/bar"];
1149 ["is_dir"; "/new"]];
1150 (* Regression tests for RHBZ#503133: *)
1151 InitBasicFS, Always, TestRun
1153 ["mkdir_p"; "/new"]];
1154 InitBasicFS, Always, TestLastFail
1156 ["mkdir_p"; "/new"]]],
1157 "create a directory and parents",
1159 Create a directory named C<path>, creating any parent directories
1160 as necessary. This is like the C<mkdir -p> shell command.");
1162 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1163 [], (* XXX Need stat command to test *)
1166 Change the mode (permissions) of C<path> to C<mode>. Only
1167 numeric modes are supported.");
1169 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1170 [], (* XXX Need stat command to test *)
1171 "change file owner and group",
1173 Change the file owner to C<owner> and group to C<group>.
1175 Only numeric uid and gid are supported. If you want to use
1176 names, you will need to locate and parse the password file
1177 yourself (Augeas support makes this relatively easy).");
1179 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1180 [InitBasicFS, Always, TestOutputTrue (
1182 ["exists"; "/new"]]);
1183 InitBasicFS, Always, TestOutputTrue (
1185 ["exists"; "/new"]])],
1186 "test if file or directory exists",
1188 This returns C<true> if and only if there is a file, directory
1189 (or anything) with the given C<path> name.
1191 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1193 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1194 [InitBasicFS, Always, TestOutputTrue (
1196 ["is_file"; "/new"]]);
1197 InitBasicFS, Always, TestOutputFalse (
1199 ["is_file"; "/new"]])],
1200 "test if file exists",
1202 This returns C<true> if and only if there is a file
1203 with the given C<path> name. Note that it returns false for
1204 other objects like directories.
1206 See also C<guestfs_stat>.");
1208 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1209 [InitBasicFS, Always, TestOutputFalse (
1211 ["is_dir"; "/new"]]);
1212 InitBasicFS, Always, TestOutputTrue (
1214 ["is_dir"; "/new"]])],
1215 "test if file exists",
1217 This returns C<true> if and only if there is a directory
1218 with the given C<path> name. Note that it returns false for
1219 other objects like files.
1221 See also C<guestfs_stat>.");
1223 ("pvcreate", (RErr, [String "device"]), 39, [],
1224 [InitEmpty, Always, TestOutputListOfDevices (
1225 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1226 ["pvcreate"; "/dev/sda1"];
1227 ["pvcreate"; "/dev/sda2"];
1228 ["pvcreate"; "/dev/sda3"];
1229 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1230 "create an LVM physical volume",
1232 This creates an LVM physical volume on the named C<device>,
1233 where C<device> should usually be a partition name such
1236 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1237 [InitEmpty, Always, TestOutputList (
1238 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1239 ["pvcreate"; "/dev/sda1"];
1240 ["pvcreate"; "/dev/sda2"];
1241 ["pvcreate"; "/dev/sda3"];
1242 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1243 ["vgcreate"; "VG2"; "/dev/sda3"];
1244 ["vgs"]], ["VG1"; "VG2"])],
1245 "create an LVM volume group",
1247 This creates an LVM volume group called C<volgroup>
1248 from the non-empty list of physical volumes C<physvols>.");
1250 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1251 [InitEmpty, Always, TestOutputList (
1252 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1253 ["pvcreate"; "/dev/sda1"];
1254 ["pvcreate"; "/dev/sda2"];
1255 ["pvcreate"; "/dev/sda3"];
1256 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1257 ["vgcreate"; "VG2"; "/dev/sda3"];
1258 ["lvcreate"; "LV1"; "VG1"; "50"];
1259 ["lvcreate"; "LV2"; "VG1"; "50"];
1260 ["lvcreate"; "LV3"; "VG2"; "50"];
1261 ["lvcreate"; "LV4"; "VG2"; "50"];
1262 ["lvcreate"; "LV5"; "VG2"; "50"];
1264 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1265 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1266 "create an LVM volume group",
1268 This creates an LVM volume group called C<logvol>
1269 on the volume group C<volgroup>, with C<size> megabytes.");
1271 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1272 [InitEmpty, Always, TestOutput (
1273 [["sfdiskM"; "/dev/sda"; ","];
1274 ["mkfs"; "ext2"; "/dev/sda1"];
1275 ["mount"; "/dev/sda1"; "/"];
1276 ["write_file"; "/new"; "new file contents"; "0"];
1277 ["cat"; "/new"]], "new file contents")],
1278 "make a filesystem",
1280 This creates a filesystem on C<device> (usually a partition
1281 or LVM logical volume). The filesystem type is C<fstype>, for
1284 ("sfdisk", (RErr, [String "device";
1285 Int "cyls"; Int "heads"; Int "sectors";
1286 StringList "lines"]), 43, [DangerWillRobinson],
1288 "create partitions on a block device",
1290 This is a direct interface to the L<sfdisk(8)> program for creating
1291 partitions on block devices.
1293 C<device> should be a block device, for example C</dev/sda>.
1295 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1296 and sectors on the device, which are passed directly to sfdisk as
1297 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1298 of these, then the corresponding parameter is omitted. Usually for
1299 'large' disks, you can just pass C<0> for these, but for small
1300 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1301 out the right geometry and you will need to tell it.
1303 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1304 information refer to the L<sfdisk(8)> manpage.
1306 To create a single partition occupying the whole disk, you would
1307 pass C<lines> as a single element list, when the single element being
1308 the string C<,> (comma).
1310 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1312 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1313 [InitBasicFS, Always, TestOutput (
1314 [["write_file"; "/new"; "new file contents"; "0"];
1315 ["cat"; "/new"]], "new file contents");
1316 InitBasicFS, Always, TestOutput (
1317 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1318 ["cat"; "/new"]], "\nnew file contents\n");
1319 InitBasicFS, Always, TestOutput (
1320 [["write_file"; "/new"; "\n\n"; "0"];
1321 ["cat"; "/new"]], "\n\n");
1322 InitBasicFS, Always, TestOutput (
1323 [["write_file"; "/new"; ""; "0"];
1324 ["cat"; "/new"]], "");
1325 InitBasicFS, Always, TestOutput (
1326 [["write_file"; "/new"; "\n\n\n"; "0"];
1327 ["cat"; "/new"]], "\n\n\n");
1328 InitBasicFS, Always, TestOutput (
1329 [["write_file"; "/new"; "\n"; "0"];
1330 ["cat"; "/new"]], "\n")],
1333 This call creates a file called C<path>. The contents of the
1334 file is the string C<content> (which can contain any 8 bit data),
1335 with length C<size>.
1337 As a special case, if C<size> is C<0>
1338 then the length is calculated using C<strlen> (so in this case
1339 the content cannot contain embedded ASCII NULs).
1341 I<NB.> Owing to a bug, writing content containing ASCII NUL
1342 characters does I<not> work, even if the length is specified.
1343 We hope to resolve this bug in a future version. In the meantime
1344 use C<guestfs_upload>.");
1346 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1347 [InitEmpty, Always, TestOutputListOfDevices (
1348 [["sfdiskM"; "/dev/sda"; ","];
1349 ["mkfs"; "ext2"; "/dev/sda1"];
1350 ["mount"; "/dev/sda1"; "/"];
1351 ["mounts"]], ["/dev/sda1"]);
1352 InitEmpty, Always, TestOutputList (
1353 [["sfdiskM"; "/dev/sda"; ","];
1354 ["mkfs"; "ext2"; "/dev/sda1"];
1355 ["mount"; "/dev/sda1"; "/"];
1358 "unmount a filesystem",
1360 This unmounts the given filesystem. The filesystem may be
1361 specified either by its mountpoint (path) or the device which
1362 contains the filesystem.");
1364 ("mounts", (RStringList "devices", []), 46, [],
1365 [InitBasicFS, Always, TestOutputListOfDevices (
1366 [["mounts"]], ["/dev/sda1"])],
1367 "show mounted filesystems",
1369 This returns the list of currently mounted filesystems. It returns
1370 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1372 Some internal mounts are not shown.");
1374 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1375 [InitBasicFS, Always, TestOutputList (
1378 (* check that umount_all can unmount nested mounts correctly: *)
1379 InitEmpty, Always, TestOutputList (
1380 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1381 ["mkfs"; "ext2"; "/dev/sda1"];
1382 ["mkfs"; "ext2"; "/dev/sda2"];
1383 ["mkfs"; "ext2"; "/dev/sda3"];
1384 ["mount"; "/dev/sda1"; "/"];
1386 ["mount"; "/dev/sda2"; "/mp1"];
1387 ["mkdir"; "/mp1/mp2"];
1388 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1389 ["mkdir"; "/mp1/mp2/mp3"];
1392 "unmount all filesystems",
1394 This unmounts all mounted filesystems.
1396 Some internal mounts are not unmounted by this call.");
1398 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1400 "remove all LVM LVs, VGs and PVs",
1402 This command removes all LVM logical volumes, volume groups
1403 and physical volumes.");
1405 ("file", (RString "description", [String "path"]), 49, [],
1406 [InitBasicFS, Always, TestOutput (
1408 ["file"; "/new"]], "empty");
1409 InitBasicFS, Always, TestOutput (
1410 [["write_file"; "/new"; "some content\n"; "0"];
1411 ["file"; "/new"]], "ASCII text");
1412 InitBasicFS, Always, TestLastFail (
1413 [["file"; "/nofile"]])],
1414 "determine file type",
1416 This call uses the standard L<file(1)> command to determine
1417 the type or contents of the file. This also works on devices,
1418 for example to find out whether a partition contains a filesystem.
1420 The exact command which runs is C<file -bsL path>. Note in
1421 particular that the filename is not prepended to the output
1422 (the C<-b> option).");
1424 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1425 [InitBasicFS, Always, TestOutput (
1426 [["upload"; "test-command"; "/test-command"];
1427 ["chmod"; "0o755"; "/test-command"];
1428 ["command"; "/test-command 1"]], "Result1");
1429 InitBasicFS, Always, TestOutput (
1430 [["upload"; "test-command"; "/test-command"];
1431 ["chmod"; "0o755"; "/test-command"];
1432 ["command"; "/test-command 2"]], "Result2\n");
1433 InitBasicFS, Always, TestOutput (
1434 [["upload"; "test-command"; "/test-command"];
1435 ["chmod"; "0o755"; "/test-command"];
1436 ["command"; "/test-command 3"]], "\nResult3");
1437 InitBasicFS, Always, TestOutput (
1438 [["upload"; "test-command"; "/test-command"];
1439 ["chmod"; "0o755"; "/test-command"];
1440 ["command"; "/test-command 4"]], "\nResult4\n");
1441 InitBasicFS, Always, TestOutput (
1442 [["upload"; "test-command"; "/test-command"];
1443 ["chmod"; "0o755"; "/test-command"];
1444 ["command"; "/test-command 5"]], "\nResult5\n\n");
1445 InitBasicFS, Always, TestOutput (
1446 [["upload"; "test-command"; "/test-command"];
1447 ["chmod"; "0o755"; "/test-command"];
1448 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1449 InitBasicFS, Always, TestOutput (
1450 [["upload"; "test-command"; "/test-command"];
1451 ["chmod"; "0o755"; "/test-command"];
1452 ["command"; "/test-command 7"]], "");
1453 InitBasicFS, Always, TestOutput (
1454 [["upload"; "test-command"; "/test-command"];
1455 ["chmod"; "0o755"; "/test-command"];
1456 ["command"; "/test-command 8"]], "\n");
1457 InitBasicFS, Always, TestOutput (
1458 [["upload"; "test-command"; "/test-command"];
1459 ["chmod"; "0o755"; "/test-command"];
1460 ["command"; "/test-command 9"]], "\n\n");
1461 InitBasicFS, Always, TestOutput (
1462 [["upload"; "test-command"; "/test-command"];
1463 ["chmod"; "0o755"; "/test-command"];
1464 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1465 InitBasicFS, Always, TestOutput (
1466 [["upload"; "test-command"; "/test-command"];
1467 ["chmod"; "0o755"; "/test-command"];
1468 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1469 InitBasicFS, Always, TestLastFail (
1470 [["upload"; "test-command"; "/test-command"];
1471 ["chmod"; "0o755"; "/test-command"];
1472 ["command"; "/test-command"]])],
1473 "run a command from the guest filesystem",
1475 This call runs a command from the guest filesystem. The
1476 filesystem must be mounted, and must contain a compatible
1477 operating system (ie. something Linux, with the same
1478 or compatible processor architecture).
1480 The single parameter is an argv-style list of arguments.
1481 The first element is the name of the program to run.
1482 Subsequent elements are parameters. The list must be
1483 non-empty (ie. must contain a program name). Note that
1484 the command runs directly, and is I<not> invoked via
1485 the shell (see C<guestfs_sh>).
1487 The return value is anything printed to I<stdout> by
1490 If the command returns a non-zero exit status, then
1491 this function returns an error message. The error message
1492 string is the content of I<stderr> from the command.
1494 The C<$PATH> environment variable will contain at least
1495 C</usr/bin> and C</bin>. If you require a program from
1496 another location, you should provide the full path in the
1499 Shared libraries and data files required by the program
1500 must be available on filesystems which are mounted in the
1501 correct places. It is the caller's responsibility to ensure
1502 all filesystems that are needed are mounted at the right
1505 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1506 [InitBasicFS, Always, TestOutputList (
1507 [["upload"; "test-command"; "/test-command"];
1508 ["chmod"; "0o755"; "/test-command"];
1509 ["command_lines"; "/test-command 1"]], ["Result1"]);
1510 InitBasicFS, Always, TestOutputList (
1511 [["upload"; "test-command"; "/test-command"];
1512 ["chmod"; "0o755"; "/test-command"];
1513 ["command_lines"; "/test-command 2"]], ["Result2"]);
1514 InitBasicFS, Always, TestOutputList (
1515 [["upload"; "test-command"; "/test-command"];
1516 ["chmod"; "0o755"; "/test-command"];
1517 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1518 InitBasicFS, Always, TestOutputList (
1519 [["upload"; "test-command"; "/test-command"];
1520 ["chmod"; "0o755"; "/test-command"];
1521 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1522 InitBasicFS, Always, TestOutputList (
1523 [["upload"; "test-command"; "/test-command"];
1524 ["chmod"; "0o755"; "/test-command"];
1525 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1526 InitBasicFS, Always, TestOutputList (
1527 [["upload"; "test-command"; "/test-command"];
1528 ["chmod"; "0o755"; "/test-command"];
1529 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1530 InitBasicFS, Always, TestOutputList (
1531 [["upload"; "test-command"; "/test-command"];
1532 ["chmod"; "0o755"; "/test-command"];
1533 ["command_lines"; "/test-command 7"]], []);
1534 InitBasicFS, Always, TestOutputList (
1535 [["upload"; "test-command"; "/test-command"];
1536 ["chmod"; "0o755"; "/test-command"];
1537 ["command_lines"; "/test-command 8"]], [""]);
1538 InitBasicFS, Always, TestOutputList (
1539 [["upload"; "test-command"; "/test-command"];
1540 ["chmod"; "0o755"; "/test-command"];
1541 ["command_lines"; "/test-command 9"]], ["";""]);
1542 InitBasicFS, Always, TestOutputList (
1543 [["upload"; "test-command"; "/test-command"];
1544 ["chmod"; "0o755"; "/test-command"];
1545 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1546 InitBasicFS, Always, TestOutputList (
1547 [["upload"; "test-command"; "/test-command"];
1548 ["chmod"; "0o755"; "/test-command"];
1549 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1550 "run a command, returning lines",
1552 This is the same as C<guestfs_command>, but splits the
1553 result into a list of lines.
1555 See also: C<guestfs_sh_lines>");
1557 ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1558 [InitBasicFS, Always, TestOutputStruct (
1560 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1561 "get file information",
1563 Returns file information for the given C<path>.
1565 This is the same as the C<stat(2)> system call.");
1567 ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1568 [InitBasicFS, Always, TestOutputStruct (
1570 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1571 "get file information for a symbolic link",
1573 Returns file information for the given C<path>.
1575 This is the same as C<guestfs_stat> except that if C<path>
1576 is a symbolic link, then the link is stat-ed, not the file it
1579 This is the same as the C<lstat(2)> system call.");
1581 ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1582 [InitBasicFS, Always, TestOutputStruct (
1583 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255);
1584 CompareWithInt ("bsize", 1024)])],
1585 "get file system statistics",
1587 Returns file system statistics for any mounted file system.
1588 C<path> should be a file or directory in the mounted file system
1589 (typically it is the mount point itself, but it doesn't need to be).
1591 This is the same as the C<statvfs(2)> system call.");
1593 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1595 "get ext2/ext3/ext4 superblock details",
1597 This returns the contents of the ext2, ext3 or ext4 filesystem
1598 superblock on C<device>.
1600 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1601 manpage for more details. The list of fields returned isn't
1602 clearly defined, and depends on both the version of C<tune2fs>
1603 that libguestfs was built against, and the filesystem itself.");
1605 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1606 [InitEmpty, Always, TestOutputTrue (
1607 [["blockdev_setro"; "/dev/sda"];
1608 ["blockdev_getro"; "/dev/sda"]])],
1609 "set block device to read-only",
1611 Sets the block device named C<device> to read-only.
1613 This uses the L<blockdev(8)> command.");
1615 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1616 [InitEmpty, Always, TestOutputFalse (
1617 [["blockdev_setrw"; "/dev/sda"];
1618 ["blockdev_getro"; "/dev/sda"]])],
1619 "set block device to read-write",
1621 Sets the block device named C<device> to read-write.
1623 This uses the L<blockdev(8)> command.");
1625 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1626 [InitEmpty, Always, TestOutputTrue (
1627 [["blockdev_setro"; "/dev/sda"];
1628 ["blockdev_getro"; "/dev/sda"]])],
1629 "is block device set to read-only",
1631 Returns a boolean indicating if the block device is read-only
1632 (true if read-only, false if not).
1634 This uses the L<blockdev(8)> command.");
1636 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1637 [InitEmpty, Always, TestOutputInt (
1638 [["blockdev_getss"; "/dev/sda"]], 512)],
1639 "get sectorsize of block device",
1641 This returns the size of sectors on a block device.
1642 Usually 512, but can be larger for modern devices.
1644 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1647 This uses the L<blockdev(8)> command.");
1649 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1650 [InitEmpty, Always, TestOutputInt (
1651 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1652 "get blocksize of block device",
1654 This returns the block size of a device.
1656 (Note this is different from both I<size in blocks> and
1657 I<filesystem block size>).
1659 This uses the L<blockdev(8)> command.");
1661 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1663 "set blocksize of block device",
1665 This sets the block size of a device.
1667 (Note this is different from both I<size in blocks> and
1668 I<filesystem block size>).
1670 This uses the L<blockdev(8)> command.");
1672 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1673 [InitEmpty, Always, TestOutputInt (
1674 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1675 "get total size of device in 512-byte sectors",
1677 This returns the size of the device in units of 512-byte sectors
1678 (even if the sectorsize isn't 512 bytes ... weird).
1680 See also C<guestfs_blockdev_getss> for the real sector size of
1681 the device, and C<guestfs_blockdev_getsize64> for the more
1682 useful I<size in bytes>.
1684 This uses the L<blockdev(8)> command.");
1686 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1687 [InitEmpty, Always, TestOutputInt (
1688 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1689 "get total size of device in bytes",
1691 This returns the size of the device in bytes.
1693 See also C<guestfs_blockdev_getsz>.
1695 This uses the L<blockdev(8)> command.");
1697 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1698 [InitEmpty, Always, TestRun
1699 [["blockdev_flushbufs"; "/dev/sda"]]],
1700 "flush device buffers",
1702 This tells the kernel to flush internal buffers associated
1705 This uses the L<blockdev(8)> command.");
1707 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1708 [InitEmpty, Always, TestRun
1709 [["blockdev_rereadpt"; "/dev/sda"]]],
1710 "reread partition table",
1712 Reread the partition table on C<device>.
1714 This uses the L<blockdev(8)> command.");
1716 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1717 [InitBasicFS, Always, TestOutput (
1718 (* Pick a file from cwd which isn't likely to change. *)
1719 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1720 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1721 "upload a file from the local machine",
1723 Upload local file C<filename> to C<remotefilename> on the
1726 C<filename> can also be a named pipe.
1728 See also C<guestfs_download>.");
1730 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1731 [InitBasicFS, Always, TestOutput (
1732 (* Pick a file from cwd which isn't likely to change. *)
1733 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1734 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1735 ["upload"; "testdownload.tmp"; "/upload"];
1736 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1737 "download a file to the local machine",
1739 Download file C<remotefilename> and save it as C<filename>
1740 on the local machine.
1742 C<filename> can also be a named pipe.
1744 See also C<guestfs_upload>, C<guestfs_cat>.");
1746 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1747 [InitBasicFS, Always, TestOutput (
1748 [["write_file"; "/new"; "test\n"; "0"];
1749 ["checksum"; "crc"; "/new"]], "935282863");
1750 InitBasicFS, Always, TestLastFail (
1751 [["checksum"; "crc"; "/new"]]);
1752 InitBasicFS, Always, TestOutput (
1753 [["write_file"; "/new"; "test\n"; "0"];
1754 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1755 InitBasicFS, Always, TestOutput (
1756 [["write_file"; "/new"; "test\n"; "0"];
1757 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1758 InitBasicFS, Always, TestOutput (
1759 [["write_file"; "/new"; "test\n"; "0"];
1760 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1761 InitBasicFS, Always, TestOutput (
1762 [["write_file"; "/new"; "test\n"; "0"];
1763 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1764 InitBasicFS, Always, TestOutput (
1765 [["write_file"; "/new"; "test\n"; "0"];
1766 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1767 InitBasicFS, Always, TestOutput (
1768 [["write_file"; "/new"; "test\n"; "0"];
1769 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1770 InitBasicFS, Always, TestOutput (
1771 (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1772 * the type explicitly.
1774 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1775 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1776 "compute MD5, SHAx or CRC checksum of file",
1778 This call computes the MD5, SHAx or CRC checksum of the
1781 The type of checksum to compute is given by the C<csumtype>
1782 parameter which must have one of the following values:
1788 Compute the cyclic redundancy check (CRC) specified by POSIX
1789 for the C<cksum> command.
1793 Compute the MD5 hash (using the C<md5sum> program).
1797 Compute the SHA1 hash (using the C<sha1sum> program).
1801 Compute the SHA224 hash (using the C<sha224sum> program).
1805 Compute the SHA256 hash (using the C<sha256sum> program).
1809 Compute the SHA384 hash (using the C<sha384sum> program).
1813 Compute the SHA512 hash (using the C<sha512sum> program).
1817 The checksum is returned as a printable string.");
1819 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1820 [InitBasicFS, Always, TestOutput (
1821 [["tar_in"; "../images/helloworld.tar"; "/"];
1822 ["cat"; "/hello"]], "hello\n")],
1823 "unpack tarfile to directory",
1825 This command uploads and unpacks local file C<tarfile> (an
1826 I<uncompressed> tar file) into C<directory>.
1828 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1830 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1832 "pack directory into tarfile",
1834 This command packs the contents of C<directory> and downloads
1835 it to local file C<tarfile>.
1837 To download a compressed tarball, use C<guestfs_tgz_out>.");
1839 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1840 [InitBasicFS, Always, TestOutput (
1841 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1842 ["cat"; "/hello"]], "hello\n")],
1843 "unpack compressed tarball to directory",
1845 This command uploads and unpacks local file C<tarball> (a
1846 I<gzip compressed> tar file) into C<directory>.
1848 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1850 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1852 "pack directory into compressed tarball",
1854 This command packs the contents of C<directory> and downloads
1855 it to local file C<tarball>.
1857 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1859 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1860 [InitBasicFS, Always, TestLastFail (
1862 ["mount_ro"; "/dev/sda1"; "/"];
1863 ["touch"; "/new"]]);
1864 InitBasicFS, Always, TestOutput (
1865 [["write_file"; "/new"; "data"; "0"];
1867 ["mount_ro"; "/dev/sda1"; "/"];
1868 ["cat"; "/new"]], "data")],
1869 "mount a guest disk, read-only",
1871 This is the same as the C<guestfs_mount> command, but it
1872 mounts the filesystem with the read-only (I<-o ro>) flag.");
1874 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1876 "mount a guest disk with mount options",
1878 This is the same as the C<guestfs_mount> command, but it
1879 allows you to set the mount options as for the
1880 L<mount(8)> I<-o> flag.");
1882 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1884 "mount a guest disk with mount options and vfstype",
1886 This is the same as the C<guestfs_mount> command, but it
1887 allows you to set both the mount options and the vfstype
1888 as for the L<mount(8)> I<-o> and I<-t> flags.");
1890 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1892 "debugging and internals",
1894 The C<guestfs_debug> command exposes some internals of
1895 C<guestfsd> (the guestfs daemon) that runs inside the
1898 There is no comprehensive help for this command. You have
1899 to look at the file C<daemon/debug.c> in the libguestfs source
1900 to find out what you can do.");
1902 ("lvremove", (RErr, [String "device"]), 77, [],
1903 [InitEmpty, Always, TestOutputList (
1904 [["sfdiskM"; "/dev/sda"; ","];
1905 ["pvcreate"; "/dev/sda1"];
1906 ["vgcreate"; "VG"; "/dev/sda1"];
1907 ["lvcreate"; "LV1"; "VG"; "50"];
1908 ["lvcreate"; "LV2"; "VG"; "50"];
1909 ["lvremove"; "/dev/VG/LV1"];
1910 ["lvs"]], ["/dev/VG/LV2"]);
1911 InitEmpty, Always, TestOutputList (
1912 [["sfdiskM"; "/dev/sda"; ","];
1913 ["pvcreate"; "/dev/sda1"];
1914 ["vgcreate"; "VG"; "/dev/sda1"];
1915 ["lvcreate"; "LV1"; "VG"; "50"];
1916 ["lvcreate"; "LV2"; "VG"; "50"];
1917 ["lvremove"; "/dev/VG"];
1919 InitEmpty, Always, TestOutputList (
1920 [["sfdiskM"; "/dev/sda"; ","];
1921 ["pvcreate"; "/dev/sda1"];
1922 ["vgcreate"; "VG"; "/dev/sda1"];
1923 ["lvcreate"; "LV1"; "VG"; "50"];
1924 ["lvcreate"; "LV2"; "VG"; "50"];
1925 ["lvremove"; "/dev/VG"];
1927 "remove an LVM logical volume",
1929 Remove an LVM logical volume C<device>, where C<device> is
1930 the path to the LV, such as C</dev/VG/LV>.
1932 You can also remove all LVs in a volume group by specifying
1933 the VG name, C</dev/VG>.");
1935 ("vgremove", (RErr, [String "vgname"]), 78, [],
1936 [InitEmpty, Always, TestOutputList (
1937 [["sfdiskM"; "/dev/sda"; ","];
1938 ["pvcreate"; "/dev/sda1"];
1939 ["vgcreate"; "VG"; "/dev/sda1"];
1940 ["lvcreate"; "LV1"; "VG"; "50"];
1941 ["lvcreate"; "LV2"; "VG"; "50"];
1944 InitEmpty, Always, TestOutputList (
1945 [["sfdiskM"; "/dev/sda"; ","];
1946 ["pvcreate"; "/dev/sda1"];
1947 ["vgcreate"; "VG"; "/dev/sda1"];
1948 ["lvcreate"; "LV1"; "VG"; "50"];
1949 ["lvcreate"; "LV2"; "VG"; "50"];
1952 "remove an LVM volume group",
1954 Remove an LVM volume group C<vgname>, (for example C<VG>).
1956 This also forcibly removes all logical volumes in the volume
1959 ("pvremove", (RErr, [String "device"]), 79, [],
1960 [InitEmpty, Always, TestOutputListOfDevices (
1961 [["sfdiskM"; "/dev/sda"; ","];
1962 ["pvcreate"; "/dev/sda1"];
1963 ["vgcreate"; "VG"; "/dev/sda1"];
1964 ["lvcreate"; "LV1"; "VG"; "50"];
1965 ["lvcreate"; "LV2"; "VG"; "50"];
1967 ["pvremove"; "/dev/sda1"];
1969 InitEmpty, Always, TestOutputListOfDevices (
1970 [["sfdiskM"; "/dev/sda"; ","];
1971 ["pvcreate"; "/dev/sda1"];
1972 ["vgcreate"; "VG"; "/dev/sda1"];
1973 ["lvcreate"; "LV1"; "VG"; "50"];
1974 ["lvcreate"; "LV2"; "VG"; "50"];
1976 ["pvremove"; "/dev/sda1"];
1978 InitEmpty, Always, TestOutputListOfDevices (
1979 [["sfdiskM"; "/dev/sda"; ","];
1980 ["pvcreate"; "/dev/sda1"];
1981 ["vgcreate"; "VG"; "/dev/sda1"];
1982 ["lvcreate"; "LV1"; "VG"; "50"];
1983 ["lvcreate"; "LV2"; "VG"; "50"];
1985 ["pvremove"; "/dev/sda1"];
1987 "remove an LVM physical volume",
1989 This wipes a physical volume C<device> so that LVM will no longer
1992 The implementation uses the C<pvremove> command which refuses to
1993 wipe physical volumes that contain any volume groups, so you have
1994 to remove those first.");
1996 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1997 [InitBasicFS, Always, TestOutput (
1998 [["set_e2label"; "/dev/sda1"; "testlabel"];
1999 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2000 "set the ext2/3/4 filesystem label",
2002 This sets the ext2/3/4 filesystem label of the filesystem on
2003 C<device> to C<label>. Filesystem labels are limited to
2006 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2007 to return the existing label on a filesystem.");
2009 ("get_e2label", (RString "label", [String "device"]), 81, [],
2011 "get the ext2/3/4 filesystem label",
2013 This returns the ext2/3/4 filesystem label of the filesystem on
2016 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2017 [InitBasicFS, Always, TestOutput (
2018 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2019 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2020 InitBasicFS, Always, TestOutput (
2021 [["set_e2uuid"; "/dev/sda1"; "clear"];
2022 ["get_e2uuid"; "/dev/sda1"]], "");
2023 (* We can't predict what UUIDs will be, so just check the commands run. *)
2024 InitBasicFS, Always, TestRun (
2025 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2026 InitBasicFS, Always, TestRun (
2027 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2028 "set the ext2/3/4 filesystem UUID",
2030 This sets the ext2/3/4 filesystem UUID of the filesystem on
2031 C<device> to C<uuid>. The format of the UUID and alternatives
2032 such as C<clear>, C<random> and C<time> are described in the
2033 L<tune2fs(8)> manpage.
2035 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2036 to return the existing UUID of a filesystem.");
2038 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2040 "get the ext2/3/4 filesystem UUID",
2042 This returns the ext2/3/4 filesystem UUID of the filesystem on
2045 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2046 [InitBasicFS, Always, TestOutputInt (
2047 [["umount"; "/dev/sda1"];
2048 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2049 InitBasicFS, Always, TestOutputInt (
2050 [["umount"; "/dev/sda1"];
2051 ["zero"; "/dev/sda1"];
2052 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2053 "run the filesystem checker",
2055 This runs the filesystem checker (fsck) on C<device> which
2056 should have filesystem type C<fstype>.
2058 The returned integer is the status. See L<fsck(8)> for the
2059 list of status codes from C<fsck>.
2067 Multiple status codes can be summed together.
2071 A non-zero return code can mean \"success\", for example if
2072 errors have been corrected on the filesystem.
2076 Checking or repairing NTFS volumes is not supported
2081 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2083 ("zero", (RErr, [String "device"]), 85, [],
2084 [InitBasicFS, Always, TestOutput (
2085 [["umount"; "/dev/sda1"];
2086 ["zero"; "/dev/sda1"];
2087 ["file"; "/dev/sda1"]], "data")],
2088 "write zeroes to the device",
2090 This command writes zeroes over the first few blocks of C<device>.
2092 How many blocks are zeroed isn't specified (but it's I<not> enough
2093 to securely wipe the device). It should be sufficient to remove
2094 any partition tables, filesystem superblocks and so on.
2096 See also: C<guestfs_scrub_device>.");
2098 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2099 (* Test disabled because grub-install incompatible with virtio-blk driver.
2100 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2102 [InitBasicFS, Disabled, TestOutputTrue (
2103 [["grub_install"; "/"; "/dev/sda1"];
2104 ["is_dir"; "/boot"]])],
2107 This command installs GRUB (the Grand Unified Bootloader) on
2108 C<device>, with the root directory being C<root>.");
2110 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2111 [InitBasicFS, Always, TestOutput (
2112 [["write_file"; "/old"; "file content"; "0"];
2113 ["cp"; "/old"; "/new"];
2114 ["cat"; "/new"]], "file content");
2115 InitBasicFS, Always, TestOutputTrue (
2116 [["write_file"; "/old"; "file content"; "0"];
2117 ["cp"; "/old"; "/new"];
2118 ["is_file"; "/old"]]);
2119 InitBasicFS, Always, TestOutput (
2120 [["write_file"; "/old"; "file content"; "0"];
2122 ["cp"; "/old"; "/dir/new"];
2123 ["cat"; "/dir/new"]], "file content")],
2126 This copies a file from C<src> to C<dest> where C<dest> is
2127 either a destination filename or destination directory.");
2129 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2130 [InitBasicFS, Always, TestOutput (
2131 [["mkdir"; "/olddir"];
2132 ["mkdir"; "/newdir"];
2133 ["write_file"; "/olddir/file"; "file content"; "0"];
2134 ["cp_a"; "/olddir"; "/newdir"];
2135 ["cat"; "/newdir/olddir/file"]], "file content")],
2136 "copy a file or directory recursively",
2138 This copies a file or directory from C<src> to C<dest>
2139 recursively using the C<cp -a> command.");
2141 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2142 [InitBasicFS, Always, TestOutput (
2143 [["write_file"; "/old"; "file content"; "0"];
2144 ["mv"; "/old"; "/new"];
2145 ["cat"; "/new"]], "file content");
2146 InitBasicFS, Always, TestOutputFalse (
2147 [["write_file"; "/old"; "file content"; "0"];
2148 ["mv"; "/old"; "/new"];
2149 ["is_file"; "/old"]])],
2152 This moves a file from C<src> to C<dest> where C<dest> is
2153 either a destination filename or destination directory.");
2155 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2156 [InitEmpty, Always, TestRun (
2157 [["drop_caches"; "3"]])],
2158 "drop kernel page cache, dentries and inodes",
2160 This instructs the guest kernel to drop its page cache,
2161 and/or dentries and inode caches. The parameter C<whattodrop>
2162 tells the kernel what precisely to drop, see
2163 L<http://linux-mm.org/Drop_Caches>
2165 Setting C<whattodrop> to 3 should drop everything.
2167 This automatically calls L<sync(2)> before the operation,
2168 so that the maximum guest memory is freed.");
2170 ("dmesg", (RString "kmsgs", []), 91, [],
2171 [InitEmpty, Always, TestRun (
2173 "return kernel messages",
2175 This returns the kernel messages (C<dmesg> output) from
2176 the guest kernel. This is sometimes useful for extended
2177 debugging of problems.
2179 Another way to get the same information is to enable
2180 verbose messages with C<guestfs_set_verbose> or by setting
2181 the environment variable C<LIBGUESTFS_DEBUG=1> before
2182 running the program.");
2184 ("ping_daemon", (RErr, []), 92, [],
2185 [InitEmpty, Always, TestRun (
2186 [["ping_daemon"]])],
2187 "ping the guest daemon",
2189 This is a test probe into the guestfs daemon running inside
2190 the qemu subprocess. Calling this function checks that the
2191 daemon responds to the ping message, without affecting the daemon
2192 or attached block device(s) in any other way.");
2194 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2195 [InitBasicFS, Always, TestOutputTrue (
2196 [["write_file"; "/file1"; "contents of a file"; "0"];
2197 ["cp"; "/file1"; "/file2"];
2198 ["equal"; "/file1"; "/file2"]]);
2199 InitBasicFS, Always, TestOutputFalse (
2200 [["write_file"; "/file1"; "contents of a file"; "0"];
2201 ["write_file"; "/file2"; "contents of another file"; "0"];
2202 ["equal"; "/file1"; "/file2"]]);
2203 InitBasicFS, Always, TestLastFail (
2204 [["equal"; "/file1"; "/file2"]])],
2205 "test if two files have equal contents",
2207 This compares the two files C<file1> and C<file2> and returns
2208 true if their content is exactly equal, or false otherwise.
2210 The external L<cmp(1)> program is used for the comparison.");
2212 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2213 [InitBasicFS, Always, TestOutputList (
2214 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2215 ["strings"; "/new"]], ["hello"; "world"]);
2216 InitBasicFS, Always, TestOutputList (
2218 ["strings"; "/new"]], [])],
2219 "print the printable strings in a file",
2221 This runs the L<strings(1)> command on a file and returns
2222 the list of printable strings found.");
2224 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2225 [InitBasicFS, Always, TestOutputList (
2226 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2227 ["strings_e"; "b"; "/new"]], []);
2228 InitBasicFS, Disabled, TestOutputList (
2229 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2230 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2231 "print the printable strings in a file",
2233 This is like the C<guestfs_strings> command, but allows you to
2234 specify the encoding.
2236 See the L<strings(1)> manpage for the full list of encodings.
2238 Commonly useful encodings are C<l> (lower case L) which will
2239 show strings inside Windows/x86 files.
2241 The returned strings are transcoded to UTF-8.");
2243 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2244 [InitBasicFS, Always, TestOutput (
2245 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2246 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n");
2247 (* Test for RHBZ#501888c2 regression which caused large hexdump
2248 * commands to segfault.
2250 InitBasicFS, Always, TestRun (
2251 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2252 ["hexdump"; "/100krandom"]])],
2253 "dump a file in hexadecimal",
2255 This runs C<hexdump -C> on the given C<path>. The result is
2256 the human-readable, canonical hex dump of the file.");
2258 ("zerofree", (RErr, [String "device"]), 97, [],
2259 [InitNone, Always, TestOutput (
2260 [["sfdiskM"; "/dev/sda"; ","];
2261 ["mkfs"; "ext3"; "/dev/sda1"];
2262 ["mount"; "/dev/sda1"; "/"];
2263 ["write_file"; "/new"; "test file"; "0"];
2264 ["umount"; "/dev/sda1"];
2265 ["zerofree"; "/dev/sda1"];
2266 ["mount"; "/dev/sda1"; "/"];
2267 ["cat"; "/new"]], "test file")],
2268 "zero unused inodes and disk blocks on ext2/3 filesystem",
2270 This runs the I<zerofree> program on C<device>. This program
2271 claims to zero unused inodes and disk blocks on an ext2/3
2272 filesystem, thus making it possible to compress the filesystem
2275 You should B<not> run this program if the filesystem is
2278 It is possible that using this program can damage the filesystem
2279 or data on the filesystem.");
2281 ("pvresize", (RErr, [String "device"]), 98, [],
2283 "resize an LVM physical volume",
2285 This resizes (expands or shrinks) an existing LVM physical
2286 volume to match the new size of the underlying device.");
2288 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2289 Int "cyls"; Int "heads"; Int "sectors";
2290 String "line"]), 99, [DangerWillRobinson],
2292 "modify a single partition on a block device",
2294 This runs L<sfdisk(8)> option to modify just the single
2295 partition C<n> (note: C<n> counts from 1).
2297 For other parameters, see C<guestfs_sfdisk>. You should usually
2298 pass C<0> for the cyls/heads/sectors parameters.");
2300 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2302 "display the partition table",
2304 This displays the partition table on C<device>, in the
2305 human-readable output of the L<sfdisk(8)> command. It is
2306 not intended to be parsed.");
2308 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2310 "display the kernel geometry",
2312 This displays the kernel's idea of the geometry of C<device>.
2314 The result is in human-readable format, and not designed to
2317 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2319 "display the disk geometry from the partition table",
2321 This displays the disk geometry of C<device> read from the
2322 partition table. Especially in the case where the underlying
2323 block device has been resized, this can be different from the
2324 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2326 The result is in human-readable format, and not designed to
2329 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2331 "activate or deactivate all volume groups",
2333 This command activates or (if C<activate> is false) deactivates
2334 all logical volumes in all volume groups.
2335 If activated, then they are made known to the
2336 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2337 then those devices disappear.
2339 This command is the same as running C<vgchange -a y|n>");
2341 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2343 "activate or deactivate some volume groups",
2345 This command activates or (if C<activate> is false) deactivates
2346 all logical volumes in the listed volume groups C<volgroups>.
2347 If activated, then they are made known to the
2348 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2349 then those devices disappear.
2351 This command is the same as running C<vgchange -a y|n volgroups...>
2353 Note that if C<volgroups> is an empty list then B<all> volume groups
2354 are activated or deactivated.");
2356 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2357 [InitNone, Always, TestOutput (
2358 [["sfdiskM"; "/dev/sda"; ","];
2359 ["pvcreate"; "/dev/sda1"];
2360 ["vgcreate"; "VG"; "/dev/sda1"];
2361 ["lvcreate"; "LV"; "VG"; "10"];
2362 ["mkfs"; "ext2"; "/dev/VG/LV"];
2363 ["mount"; "/dev/VG/LV"; "/"];
2364 ["write_file"; "/new"; "test content"; "0"];
2366 ["lvresize"; "/dev/VG/LV"; "20"];
2367 ["e2fsck_f"; "/dev/VG/LV"];
2368 ["resize2fs"; "/dev/VG/LV"];
2369 ["mount"; "/dev/VG/LV"; "/"];
2370 ["cat"; "/new"]], "test content")],
2371 "resize an LVM logical volume",
2373 This resizes (expands or shrinks) an existing LVM logical
2374 volume to C<mbytes>. When reducing, data in the reduced part
2377 ("resize2fs", (RErr, [String "device"]), 106, [],
2378 [], (* lvresize tests this *)
2379 "resize an ext2/ext3 filesystem",
2381 This resizes an ext2 or ext3 filesystem to match the size of
2382 the underlying device.
2384 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2385 on the C<device> before calling this command. For unknown reasons
2386 C<resize2fs> sometimes gives an error about this and sometimes not.
2387 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2388 calling this function.");
2390 ("find", (RStringList "names", [String "directory"]), 107, [],
2391 [InitBasicFS, Always, TestOutputList (
2392 [["find"; "/"]], ["lost+found"]);
2393 InitBasicFS, Always, TestOutputList (
2397 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2398 InitBasicFS, Always, TestOutputList (
2399 [["mkdir_p"; "/a/b/c"];
2400 ["touch"; "/a/b/c/d"];
2401 ["find"; "/a/b/"]], ["c"; "c/d"])],
2402 "find all files and directories",
2404 This command lists out all files and directories, recursively,
2405 starting at C<directory>. It is essentially equivalent to
2406 running the shell command C<find directory -print> but some
2407 post-processing happens on the output, described below.
2409 This returns a list of strings I<without any prefix>. Thus
2410 if the directory structure was:
2416 then the returned list from C<guestfs_find> C</tmp> would be
2424 If C<directory> is not a directory, then this command returns
2427 The returned list is sorted.");
2429 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2430 [], (* lvresize tests this *)
2431 "check an ext2/ext3 filesystem",
2433 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2434 filesystem checker on C<device>, noninteractively (C<-p>),
2435 even if the filesystem appears to be clean (C<-f>).
2437 This command is only needed because of C<guestfs_resize2fs>
2438 (q.v.). Normally you should use C<guestfs_fsck>.");
2440 ("sleep", (RErr, [Int "secs"]), 109, [],
2441 [InitNone, Always, TestRun (
2443 "sleep for some seconds",
2445 Sleep for C<secs> seconds.");
2447 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2448 [InitNone, Always, TestOutputInt (
2449 [["sfdiskM"; "/dev/sda"; ","];
2450 ["mkfs"; "ntfs"; "/dev/sda1"];
2451 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2452 InitNone, Always, TestOutputInt (
2453 [["sfdiskM"; "/dev/sda"; ","];
2454 ["mkfs"; "ext2"; "/dev/sda1"];
2455 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2456 "probe NTFS volume",
2458 This command runs the L<ntfs-3g.probe(8)> command which probes
2459 an NTFS C<device> for mountability. (Not all NTFS volumes can
2460 be mounted read-write, and some cannot be mounted at all).
2462 C<rw> is a boolean flag. Set it to true if you want to test
2463 if the volume can be mounted read-write. Set it to false if
2464 you want to test if the volume can be mounted read-only.
2466 The return value is an integer which C<0> if the operation
2467 would succeed, or some non-zero value documented in the
2468 L<ntfs-3g.probe(8)> manual page.");
2470 ("sh", (RString "output", [String "command"]), 111, [],
2471 [], (* XXX needs tests *)
2472 "run a command via the shell",
2474 This call runs a command from the guest filesystem via the
2477 This is like C<guestfs_command>, but passes the command to:
2479 /bin/sh -c \"command\"
2481 Depending on the guest's shell, this usually results in
2482 wildcards being expanded, shell expressions being interpolated
2485 All the provisos about C<guestfs_command> apply to this call.");
2487 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2488 [], (* XXX needs tests *)
2489 "run a command via the shell returning lines",
2491 This is the same as C<guestfs_sh>, but splits the result
2492 into a list of lines.
2494 See also: C<guestfs_command_lines>");
2496 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2497 [InitBasicFS, Always, TestOutputList (
2498 [["mkdir_p"; "/a/b/c"];
2499 ["touch"; "/a/b/c/d"];
2500 ["touch"; "/a/b/c/e"];
2501 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2502 InitBasicFS, Always, TestOutputList (
2503 [["mkdir_p"; "/a/b/c"];
2504 ["touch"; "/a/b/c/d"];
2505 ["touch"; "/a/b/c/e"];
2506 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2507 InitBasicFS, Always, TestOutputList (
2508 [["mkdir_p"; "/a/b/c"];
2509 ["touch"; "/a/b/c/d"];
2510 ["touch"; "/a/b/c/e"];
2511 ["glob_expand"; "/a/*/x/*"]], [])],
2512 "expand a wildcard path",
2514 This command searches for all the pathnames matching
2515 C<pattern> according to the wildcard expansion rules
2518 If no paths match, then this returns an empty list
2519 (note: not an error).
2521 It is just a wrapper around the C L<glob(3)> function
2522 with flags C<GLOB_MARK|GLOB_BRACE>.
2523 See that manual page for more details.");
2525 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2526 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2527 [["scrub_device"; "/dev/sdc"]])],
2528 "scrub (securely wipe) a device",
2530 This command writes patterns over C<device> to make data retrieval
2533 It is an interface to the L<scrub(1)> program. See that
2534 manual page for more details.");
2536 ("scrub_file", (RErr, [String "file"]), 115, [],
2537 [InitBasicFS, Always, TestRun (
2538 [["write_file"; "/file"; "content"; "0"];
2539 ["scrub_file"; "/file"]])],
2540 "scrub (securely wipe) a file",
2542 This command writes patterns over a file to make data retrieval
2545 The file is I<removed> after scrubbing.
2547 It is an interface to the L<scrub(1)> program. See that
2548 manual page for more details.");
2550 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2551 [], (* XXX needs testing *)
2552 "scrub (securely wipe) free space",
2554 This command creates the directory C<dir> and then fills it
2555 with files until the filesystem is full, and scrubs the files
2556 as for C<guestfs_scrub_file>, and deletes them.
2557 The intention is to scrub any free space on the partition
2560 It is an interface to the L<scrub(1)> program. See that
2561 manual page for more details.");
2563 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2564 [InitBasicFS, Always, TestRun (
2566 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2567 "create a temporary directory",
2569 This command creates a temporary directory. The
2570 C<template> parameter should be a full pathname for the
2571 temporary directory name with the final six characters being
2574 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2575 the second one being suitable for Windows filesystems.
2577 The name of the temporary directory that was created
2580 The temporary directory is created with mode 0700
2581 and is owned by root.
2583 The caller is responsible for deleting the temporary
2584 directory and its contents after use.
2586 See also: L<mkdtemp(3)>");
2588 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2589 [InitBasicFS, Always, TestOutputInt (
2590 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2591 ["wc_l"; "/10klines"]], 10000)],
2592 "count lines in a file",
2594 This command counts the lines in a file, using the
2595 C<wc -l> external command.");
2597 ("wc_w", (RInt "words", [String "path"]), 119, [],
2598 [InitBasicFS, Always, TestOutputInt (
2599 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2600 ["wc_w"; "/10klines"]], 10000)],
2601 "count words in a file",
2603 This command counts the words in a file, using the
2604 C<wc -w> external command.");
2606 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2607 [InitBasicFS, Always, TestOutputInt (
2608 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2609 ["wc_c"; "/100kallspaces"]], 102400)],
2610 "count characters in a file",
2612 This command counts the characters in a file, using the
2613 C<wc -c> external command.");
2615 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2616 [InitBasicFS, Always, TestOutputList (
2617 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2618 ["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2619 "return first 10 lines of a file",
2621 This command returns up to the first 10 lines of a file as
2622 a list of strings.");
2624 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2625 [InitBasicFS, Always, TestOutputList (
2626 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2627 ["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2628 InitBasicFS, Always, TestOutputList (
2629 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2630 ["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2631 InitBasicFS, Always, TestOutputList (
2632 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2633 ["head_n"; "0"; "/10klines"]], [])],
2634 "return first N lines of a file",
2636 If the parameter C<nrlines> is a positive number, this returns the first
2637 C<nrlines> lines of the file C<path>.
2639 If the parameter C<nrlines> is a negative number, this returns lines
2640 from the file C<path>, excluding the last C<nrlines> lines.
2642 If the parameter C<nrlines> is zero, this returns an empty list.");
2644 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2645 [InitBasicFS, Always, TestOutputList (
2646 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2647 ["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2648 "return last 10 lines of a file",
2650 This command returns up to the last 10 lines of a file as
2651 a list of strings.");
2653 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2654 [InitBasicFS, Always, TestOutputList (
2655 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2656 ["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2657 InitBasicFS, Always, TestOutputList (
2658 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2659 ["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2660 InitBasicFS, Always, TestOutputList (
2661 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2662 ["tail_n"; "0"; "/10klines"]], [])],
2663 "return last N lines of a file",
2665 If the parameter C<nrlines> is a positive number, this returns the last
2666 C<nrlines> lines of the file C<path>.
2668 If the parameter C<nrlines> is a negative number, this returns lines
2669 from the file C<path>, starting with the C<-nrlines>th line.
2671 If the parameter C<nrlines> is zero, this returns an empty list.");
2673 ("df", (RString "output", []), 125, [],
2674 [], (* XXX Tricky to test because it depends on the exact format
2675 * of the 'df' command and other imponderables.
2677 "report file system disk space usage",
2679 This command runs the C<df> command to report disk space used.
2681 This command is mostly useful for interactive sessions. It
2682 is I<not> intended that you try to parse the output string.
2683 Use C<statvfs> from programs.");
2685 ("df_h", (RString "output", []), 126, [],
2686 [], (* XXX Tricky to test because it depends on the exact format
2687 * of the 'df' command and other imponderables.
2689 "report file system disk space usage (human readable)",
2691 This command runs the C<df -h> command to report disk space used
2692 in human-readable format.
2694 This command is mostly useful for interactive sessions. It
2695 is I<not> intended that you try to parse the output string.
2696 Use C<statvfs> from programs.");
2698 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2699 [InitBasicFS, Always, TestOutputInt (
2701 ["du"; "/p"]], 1 (* ie. 1 block, so depends on ext3 blocksize *))],
2702 "estimate file space usage",
2704 This command runs the C<du -s> command to estimate file space
2707 C<path> can be a file or a directory. If C<path> is a directory
2708 then the estimate includes the contents of the directory and all
2709 subdirectories (recursively).
2711 The result is the estimated size in I<kilobytes>
2712 (ie. units of 1024 bytes).");
2714 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2715 [InitBasicFS, Always, TestOutputList (
2716 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2717 ["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3"])],
2718 "list files in an initrd",
2720 This command lists out files contained in an initrd.
2722 The files are listed without any initial C</> character. The
2723 files are listed in the order they appear (not necessarily
2724 alphabetical). Directory names are listed as separate items.
2726 Old Linux kernels (2.4 and earlier) used a compressed ext2
2727 filesystem as initrd. We I<only> support the newer initramfs
2728 format (compressed cpio files).");
2730 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2732 "mount a file using the loop device",
2734 This command lets you mount C<file> (a filesystem image
2735 in a file) on a mount point. It is entirely equivalent to
2736 the command C<mount -o loop file mountpoint>.");
2738 ("mkswap", (RErr, [String "device"]), 130, [],
2739 [InitEmpty, Always, TestRun (
2740 [["sfdiskM"; "/dev/sda"; ","];
2741 ["mkswap"; "/dev/sda1"]])],
2742 "create a swap partition",
2744 Create a swap partition on C<device>.");
2746 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2747 [InitEmpty, Always, TestRun (
2748 [["sfdiskM"; "/dev/sda"; ","];
2749 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2750 "create a swap partition with a label",
2752 Create a swap partition on C<device> with label C<label>.");
2754 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2755 [InitEmpty, Always, TestRun (
2756 [["sfdiskM"; "/dev/sda"; ","];
2757 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2758 "create a swap partition with an explicit UUID",
2760 Create a swap partition on C<device> with UUID C<uuid>.");
2762 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2763 [InitBasicFS, Always, TestOutputStruct (
2764 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2765 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2766 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2767 InitBasicFS, Always, TestOutputStruct (
2768 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2769 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2770 "make block, character or FIFO devices",
2772 This call creates block or character special devices, or
2773 named pipes (FIFOs).
2775 The C<mode> parameter should be the mode, using the standard
2776 constants. C<devmajor> and C<devminor> are the
2777 device major and minor numbers, only used when creating block
2778 and character special devices.");
2780 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2781 [InitBasicFS, Always, TestOutputStruct (
2782 [["mkfifo"; "0o777"; "/node"];
2783 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2784 "make FIFO (named pipe)",
2786 This call creates a FIFO (named pipe) called C<path> with
2787 mode C<mode>. It is just a convenient wrapper around
2788 C<guestfs_mknod>.");
2790 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2791 [InitBasicFS, Always, TestOutputStruct (
2792 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2793 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2794 "make block device node",
2796 This call creates a block device node called C<path> with
2797 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2798 It is just a convenient wrapper around C<guestfs_mknod>.");
2800 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2801 [InitBasicFS, Always, TestOutputStruct (
2802 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2803 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2804 "make char device node",
2806 This call creates a char device node called C<path> with
2807 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2808 It is just a convenient wrapper around C<guestfs_mknod>.");
2810 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2811 [], (* XXX umask is one of those stateful things that we should
2812 * reset between each test.
2814 "set file mode creation mask (umask)",
2816 This function sets the mask used for creating new files and
2817 device nodes to C<mask & 0777>.
2819 Typical umask values would be C<022> which creates new files
2820 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2821 C<002> which creates new files with permissions like
2822 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2824 The default umask is C<022>. This is important because it
2825 means that directories and device nodes will be created with
2826 C<0644> or C<0755> mode even if you specify C<0777>.
2828 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2830 This call returns the previous umask.");
2832 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2834 "read directories entries",
2836 This returns the list of directory entries in directory C<dir>.
2838 All entries in the directory are returned, including C<.> and
2839 C<..>. The entries are I<not> sorted, but returned in the same
2840 order as the underlying filesystem.
2842 This function is primarily intended for use by programs. To
2843 get a simple list of names, use C<guestfs_ls>. To get a printable
2844 directory for human consumption, use C<guestfs_ll>.");
2846 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2848 "create partitions on a block device",
2850 This is a simplified interface to the C<guestfs_sfdisk>
2851 command, where partition sizes are specified in megabytes
2852 only (rounded to the nearest cylinder) and you don't need
2853 to specify the cyls, heads and sectors parameters which
2854 were rarely if ever used anyway.
2856 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2860 let all_functions = non_daemon_functions @ daemon_functions
2862 (* In some places we want the functions to be displayed sorted
2863 * alphabetically, so this is useful:
2865 let all_functions_sorted =
2866 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2867 compare n1 n2) all_functions
2869 (* Field types for structures. *)
2871 | FChar (* C 'char' (really, a 7 bit byte). *)
2872 | FString (* nul-terminated ASCII string. *)
2877 | FBytes (* Any int measure that counts bytes. *)
2878 | FUUID (* 32 bytes long, NOT nul-terminated. *)
2879 | FOptPercent (* [0..100], or -1 meaning "not present". *)
2881 (* Because we generate extra parsing code for LVM command line tools,
2882 * we have to pull out the LVM columns separately here.
2892 "pv_attr", FString (* XXX *);
2893 "pv_pe_count", FInt64;
2894 "pv_pe_alloc_count", FInt64;
2897 "pv_mda_count", FInt64;
2898 "pv_mda_free", FBytes;
2899 (* Not in Fedora 10:
2900 "pv_mda_size", FBytes;
2907 "vg_attr", FString (* XXX *);
2910 "vg_sysid", FString;
2911 "vg_extent_size", FBytes;
2912 "vg_extent_count", FInt64;
2913 "vg_free_count", FInt64;
2918 "snap_count", FInt64;
2921 "vg_mda_count", FInt64;
2922 "vg_mda_free", FBytes;
2923 (* Not in Fedora 10:
2924 "vg_mda_size", FBytes;
2930 "lv_attr", FString (* XXX *);
2933 "lv_kernel_major", FInt64;
2934 "lv_kernel_minor", FInt64;
2936 "seg_count", FInt64;
2938 "snap_percent", FOptPercent;
2939 "copy_percent", FOptPercent;
2942 "mirror_log", FString;
2946 (* Names and fields in all structures (in RStruct and RStructList)
2950 (* The old RIntBool return type, only ever used for aug_defnode. Do
2951 * not use this struct in any new code.
2954 "i", FInt32; (* for historical compatibility *)
2955 "b", FInt32; (* for historical compatibility *)
2958 (* LVM PVs, VGs, LVs. *)
2959 "lvm_pv", lvm_pv_cols;
2960 "lvm_vg", lvm_vg_cols;
2961 "lvm_lv", lvm_lv_cols;
2963 (* Column names and types from stat structures.
2964 * NB. Can't use things like 'st_atime' because glibc header files
2965 * define some of these as macros. Ugh.
2996 (* Column names in dirent structure. *)
2999 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3004 (* Version numbers. *)
3011 ] (* end of structs *)
3013 (* Ugh, Java has to be different ..
3014 * These names are also used by the Haskell bindings.
3016 let java_structs = [
3017 "int_bool", "IntBool";
3022 "statvfs", "StatVFS";
3024 "version", "Version";
3027 (* Used for testing language bindings. *)
3029 | CallString of string
3030 | CallOptString of string option
3031 | CallStringList of string list
3035 (* Used to memoize the result of pod2text. *)
3036 let pod2text_memo_filename = "src/.pod2text.data"
3037 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3039 let chan = open_in pod2text_memo_filename in
3040 let v = input_value chan in
3044 _ -> Hashtbl.create 13
3046 (* Useful functions.
3047 * Note we don't want to use any external OCaml libraries which
3048 * makes this a bit harder than it should be.
3050 let failwithf fs = ksprintf failwith fs
3052 let replace_char s c1 c2 =
3053 let s2 = String.copy s in
3054 let r = ref false in
3055 for i = 0 to String.length s2 - 1 do
3056 if String.unsafe_get s2 i = c1 then (
3057 String.unsafe_set s2 i c2;
3061 if not !r then s else s2
3065 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3067 let triml ?(test = isspace) str =
3069 let n = ref (String.length str) in
3070 while !n > 0 && test str.[!i]; do
3075 else String.sub str !i !n
3077 let trimr ?(test = isspace) str =
3078 let n = ref (String.length str) in
3079 while !n > 0 && test str.[!n-1]; do
3082 if !n = String.length str then str
3083 else String.sub str 0 !n
3085 let trim ?(test = isspace) str =
3086 trimr ~test (triml ~test str)
3088 let rec find s sub =
3089 let len = String.length s in
3090 let sublen = String.length sub in
3092 if i <= len-sublen then (
3094 if j < sublen then (
3095 if s.[i+j] = sub.[j] then loop2 (j+1)
3101 if r = -1 then loop (i+1) else r
3107 let rec replace_str s s1 s2 =
3108 let len = String.length s in
3109 let sublen = String.length s1 in
3110 let i = find s s1 in
3113 let s' = String.sub s 0 i in
3114 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3115 s' ^ s2 ^ replace_str s'' s1 s2
3118 let rec string_split sep str =
3119 let len = String.length str in
3120 let seplen = String.length sep in
3121 let i = find str sep in
3122 if i = -1 then [str]
3124 let s' = String.sub str 0 i in
3125 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3126 s' :: string_split sep s''
3129 let files_equal n1 n2 =
3130 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3131 match Sys.command cmd with
3134 | i -> failwithf "%s: failed with error code %d" cmd i
3136 let rec find_map f = function
3137 | [] -> raise Not_found
3141 | None -> find_map f xs
3144 let rec loop i = function
3146 | x :: xs -> f i x; loop (i+1) xs
3151 let rec loop i = function
3153 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3157 let name_of_argt = function
3158 | String n | OptString n | StringList n | Bool n | Int n
3159 | FileIn n | FileOut n -> n
3161 let java_name_of_struct typ =
3162 try List.assoc typ java_structs
3165 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3167 let cols_of_struct typ =
3168 try List.assoc typ structs
3170 failwithf "cols_of_struct: unknown struct %s" typ
3172 let seq_of_test = function
3173 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3174 | TestOutputListOfDevices (s, _)
3175 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3176 | TestOutputTrue s | TestOutputFalse s
3177 | TestOutputLength (s, _) | TestOutputStruct (s, _)
3178 | TestLastFail s -> s
3180 (* Check function names etc. for consistency. *)
3181 let check_functions () =
3182 let contains_uppercase str =
3183 let len = String.length str in
3185 if i >= len then false
3188 if c >= 'A' && c <= 'Z' then true
3195 (* Check function names. *)
3197 fun (name, _, _, _, _, _, _) ->
3198 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3199 failwithf "function name %s does not need 'guestfs' prefix" name;
3201 failwithf "function name is empty";
3202 if name.[0] < 'a' || name.[0] > 'z' then
3203 failwithf "function name %s must start with lowercase a-z" name;
3204 if String.contains name '-' then
3205 failwithf "function name %s should not contain '-', use '_' instead."
3209 (* Check function parameter/return names. *)
3211 fun (name, style, _, _, _, _, _) ->
3212 let check_arg_ret_name n =
3213 if contains_uppercase n then
3214 failwithf "%s param/ret %s should not contain uppercase chars"
3216 if String.contains n '-' || String.contains n '_' then
3217 failwithf "%s param/ret %s should not contain '-' or '_'"
3220 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;
3221 if n = "int" || n = "char" || n = "short" || n = "long" then
3222 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3223 if n = "i" || n = "n" then
3224 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3225 if n = "argv" || n = "args" then
3226 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3229 (match fst style with
3231 | RInt n | RInt64 n | RBool n | RConstString n | RString n
3232 | RStringList n | RStruct (n, _) | RStructList (n, _)
3234 check_arg_ret_name n
3236 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3239 (* Check short descriptions. *)
3241 fun (name, _, _, _, _, shortdesc, _) ->
3242 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3243 failwithf "short description of %s should begin with lowercase." name;
3244 let c = shortdesc.[String.length shortdesc-1] in
3245 if c = '\n' || c = '.' then
3246 failwithf "short description of %s should not end with . or \\n." name
3249 (* Check long dscriptions. *)
3251 fun (name, _, _, _, _, _, longdesc) ->
3252 if longdesc.[String.length longdesc-1] = '\n' then
3253 failwithf "long description of %s should not end with \\n." name
3256 (* Check proc_nrs. *)
3258 fun (name, _, proc_nr, _, _, _, _) ->
3259 if proc_nr <= 0 then
3260 failwithf "daemon function %s should have proc_nr > 0" name
3264 fun (name, _, proc_nr, _, _, _, _) ->
3265 if proc_nr <> -1 then
3266 failwithf "non-daemon function %s should have proc_nr -1" name
3267 ) non_daemon_functions;
3270 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3273 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3274 let rec loop = function
3277 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3279 | (name1,nr1) :: (name2,nr2) :: _ ->
3280 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3288 (* Ignore functions that have no tests. We generate a
3289 * warning when the user does 'make check' instead.
3291 | name, _, _, _, [], _, _ -> ()
3292 | name, _, _, _, tests, _, _ ->
3296 match seq_of_test test with
3298 failwithf "%s has a test containing an empty sequence" name
3299 | cmds -> List.map List.hd cmds
3301 let funcs = List.flatten funcs in
3303 let tested = List.mem name funcs in
3306 failwithf "function %s has tests but does not test itself" name
3309 (* 'pr' prints to the current output file. *)
3310 let chan = ref stdout
3311 let pr fs = ksprintf (output_string !chan) fs
3313 (* Generate a header block in a number of standard styles. *)
3314 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3315 type license = GPLv2 | LGPLv2
3317 let generate_header comment license =
3318 let c = match comment with
3319 | CStyle -> pr "/* "; " *"
3320 | HashStyle -> pr "# "; "#"
3321 | OCamlStyle -> pr "(* "; " *"
3322 | HaskellStyle -> pr "{- "; " " in
3323 pr "libguestfs generated file\n";
3324 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3325 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3327 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3331 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3332 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3333 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3334 pr "%s (at your option) any later version.\n" c;
3336 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3337 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3338 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3339 pr "%s GNU General Public License for more details.\n" c;
3341 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3342 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3343 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3346 pr "%s This library is free software; you can redistribute it and/or\n" c;
3347 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3348 pr "%s License as published by the Free Software Foundation; either\n" c;
3349 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3351 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3352 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3353 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3354 pr "%s Lesser General Public License for more details.\n" c;
3356 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3357 pr "%s License along with this library; if not, write to the Free Software\n" c;
3358 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3361 | CStyle -> pr " */\n"
3363 | OCamlStyle -> pr " *)\n"
3364 | HaskellStyle -> pr "-}\n"
3368 (* Start of main code generation functions below this line. *)
3370 (* Generate the pod documentation for the C API. *)
3371 let rec generate_actions_pod () =
3373 fun (shortname, style, _, flags, _, _, longdesc) ->
3374 if not (List.mem NotInDocs flags) then (
3375 let name = "guestfs_" ^ shortname in
3376 pr "=head2 %s\n\n" name;
3378 generate_prototype ~extern:false ~handle:"handle" name style;
3380 pr "%s\n\n" longdesc;
3381 (match fst style with
3383 pr "This function returns 0 on success or -1 on error.\n\n"
3385 pr "On error this function returns -1.\n\n"
3387 pr "On error this function returns -1.\n\n"
3389 pr "This function returns a C truth value on success or -1 on error.\n\n"
3391 pr "This function returns a string, or NULL on error.
3392 The string is owned by the guest handle and must I<not> be freed.\n\n"
3394 pr "This function returns a string, or NULL on error.
3395 I<The caller must free the returned string after use>.\n\n"
3397 pr "This function returns a NULL-terminated array of strings
3398 (like L<environ(3)>), or NULL if there was an error.
3399 I<The caller must free the strings and the array after use>.\n\n"
3400 | RStruct (_, typ) ->
3401 pr "This function returns a C<struct guestfs_%s *>,
3402 or NULL if there was an error.
3403 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3404 | RStructList (_, typ) ->
3405 pr "This function returns a C<struct guestfs_%s_list *>
3406 (see E<lt>guestfs-structs.hE<gt>),
3407 or NULL if there was an error.
3408 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3410 pr "This function returns a NULL-terminated array of
3411 strings, or NULL if there was an error.
3412 The array of strings will always have length C<2n+1>, where
3413 C<n> keys and values alternate, followed by the trailing NULL entry.
3414 I<The caller must free the strings and the array after use>.\n\n"
3416 if List.mem ProtocolLimitWarning flags then
3417 pr "%s\n\n" protocol_limit_warning;
3418 if List.mem DangerWillRobinson flags then
3419 pr "%s\n\n" danger_will_robinson
3421 ) all_functions_sorted
3423 and generate_structs_pod () =
3424 (* Structs documentation. *)
3427 pr "=head2 guestfs_%s\n" typ;
3429 pr " struct guestfs_%s {\n" typ;
3432 | name, FChar -> pr " char %s;\n" name
3433 | name, FUInt32 -> pr " uint32_t %s;\n" name
3434 | name, FInt32 -> pr " int32_t %s;\n" name
3435 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3436 | name, FInt64 -> pr " int64_t %s;\n" name
3437 | name, FString -> pr " char *%s;\n" name
3439 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3440 pr " char %s[32];\n" name
3441 | name, FOptPercent ->
3442 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3443 pr " float %s;\n" name
3447 pr " struct guestfs_%s_list {\n" typ;
3448 pr " uint32_t len; /* Number of elements in list. */\n";
3449 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
3452 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3453 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3458 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3459 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3461 * We have to use an underscore instead of a dash because otherwise
3462 * rpcgen generates incorrect code.
3464 * This header is NOT exported to clients, but see also generate_structs_h.
3466 and generate_xdr () =
3467 generate_header CStyle LGPLv2;
3469 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3470 pr "typedef string str<>;\n";
3473 (* Internal structures. *)
3477 pr "struct guestfs_int_%s {\n" typ;
3479 | name, FChar -> pr " char %s;\n" name
3480 | name, FString -> pr " string %s<>;\n" name
3481 | name, FUUID -> pr " opaque %s[32];\n" name
3482 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
3483 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
3484 | name, FOptPercent -> pr " float %s;\n" name
3488 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3493 fun (shortname, style, _, _, _, _, _) ->
3494 let name = "guestfs_" ^ shortname in
3496 (match snd style with
3499 pr "struct %s_args {\n" name;
3502 | String n -> pr " string %s<>;\n" n
3503 | OptString n -> pr " str *%s;\n" n
3504 | StringList n -> pr " str %s<>;\n" n
3505 | Bool n -> pr " bool %s;\n" n
3506 | Int n -> pr " int %s;\n" n
3507 | FileIn _ | FileOut _ -> ()
3511 (match fst style with
3514 pr "struct %s_ret {\n" name;
3518 pr "struct %s_ret {\n" name;
3519 pr " hyper %s;\n" n;
3522 pr "struct %s_ret {\n" name;
3526 failwithf "RConstString cannot be returned from a daemon function"
3528 pr "struct %s_ret {\n" name;
3529 pr " string %s<>;\n" n;
3532 pr "struct %s_ret {\n" name;
3533 pr " str %s<>;\n" n;
3535 | RStruct (n, typ) ->
3536 pr "struct %s_ret {\n" name;
3537 pr " guestfs_int_%s %s;\n" typ n;
3539 | RStructList (n, typ) ->
3540 pr "struct %s_ret {\n" name;
3541 pr " guestfs_int_%s_list %s;\n" typ n;
3544 pr "struct %s_ret {\n" name;
3545 pr " str %s<>;\n" n;
3550 (* Table of procedure numbers. *)
3551 pr "enum guestfs_procedure {\n";
3553 fun (shortname, _, proc_nr, _, _, _, _) ->
3554 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3556 pr " GUESTFS_PROC_NR_PROCS\n";
3560 (* Having to choose a maximum message size is annoying for several
3561 * reasons (it limits what we can do in the API), but it (a) makes
3562 * the protocol a lot simpler, and (b) provides a bound on the size
3563 * of the daemon which operates in limited memory space. For large
3564 * file transfers you should use FTP.
3566 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3569 (* Message header, etc. *)
3571 /* The communication protocol is now documented in the guestfs(3)
3575 const GUESTFS_PROGRAM = 0x2000F5F5;
3576 const GUESTFS_PROTOCOL_VERSION = 1;
3578 /* These constants must be larger than any possible message length. */
3579 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3580 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3582 enum guestfs_message_direction {
3583 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3584 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3587 enum guestfs_message_status {
3588 GUESTFS_STATUS_OK = 0,
3589 GUESTFS_STATUS_ERROR = 1
3592 const GUESTFS_ERROR_LEN = 256;
3594 struct guestfs_message_error {
3595 string error_message<GUESTFS_ERROR_LEN>;
3598 struct guestfs_message_header {
3599 unsigned prog; /* GUESTFS_PROGRAM */
3600 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3601 guestfs_procedure proc; /* GUESTFS_PROC_x */
3602 guestfs_message_direction direction;
3603 unsigned serial; /* message serial number */
3604 guestfs_message_status status;
3607 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3609 struct guestfs_chunk {
3610 int cancel; /* if non-zero, transfer is cancelled */
3611 /* data size is 0 bytes if the transfer has finished successfully */
3612 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3616 (* Generate the guestfs-structs.h file. *)
3617 and generate_structs_h () =
3618 generate_header CStyle LGPLv2;
3620 (* This is a public exported header file containing various
3621 * structures. The structures are carefully written to have
3622 * exactly the same in-memory format as the XDR structures that
3623 * we use on the wire to the daemon. The reason for creating
3624 * copies of these structures here is just so we don't have to
3625 * export the whole of guestfs_protocol.h (which includes much
3626 * unrelated and XDR-dependent stuff that we don't want to be
3627 * public, or required by clients).
3629 * To reiterate, we will pass these structures to and from the
3630 * client with a simple assignment or memcpy, so the format
3631 * must be identical to what rpcgen / the RFC defines.
3634 (* Public structures. *)
3637 pr "struct guestfs_%s {\n" typ;
3640 | name, FChar -> pr " char %s;\n" name
3641 | name, FString -> pr " char *%s;\n" name
3642 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3643 | name, FUInt32 -> pr " uint32_t %s;\n" name
3644 | name, FInt32 -> pr " int32_t %s;\n" name
3645 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3646 | name, FInt64 -> pr " int64_t %s;\n" name
3647 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3651 pr "struct guestfs_%s_list {\n" typ;
3652 pr " uint32_t len;\n";
3653 pr " struct guestfs_%s *val;\n" typ;
3656 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
3657 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
3661 (* Generate the guestfs-actions.h file. *)
3662 and generate_actions_h () =
3663 generate_header CStyle LGPLv2;
3665 fun (shortname, style, _, _, _, _, _) ->
3666 let name = "guestfs_" ^ shortname in
3667 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3671 (* Generate the client-side dispatch stubs. *)
3672 and generate_client_actions () =
3673 generate_header CStyle LGPLv2;
3679 #include \"guestfs.h\"
3680 #include \"guestfs_protocol.h\"
3682 #define error guestfs_error
3683 #define perrorf guestfs_perrorf
3684 #define safe_malloc guestfs_safe_malloc
3685 #define safe_realloc guestfs_safe_realloc
3686 #define safe_strdup guestfs_safe_strdup
3687 #define safe_memdup guestfs_safe_memdup
3689 /* Check the return message from a call for validity. */
3691 check_reply_header (guestfs_h *g,
3692 const struct guestfs_message_header *hdr,
3693 int proc_nr, int serial)
3695 if (hdr->prog != GUESTFS_PROGRAM) {
3696 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3699 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3700 error (g, \"wrong protocol version (%%d/%%d)\",
3701 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3704 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3705 error (g, \"unexpected message direction (%%d/%%d)\",
3706 hdr->direction, GUESTFS_DIRECTION_REPLY);
3709 if (hdr->proc != proc_nr) {
3710 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3713 if (hdr->serial != serial) {
3714 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3721 /* Check we are in the right state to run a high-level action. */
3723 check_state (guestfs_h *g, const char *caller)
3725 if (!guestfs_is_ready (g)) {
3726 if (guestfs_is_config (g))
3727 error (g, \"%%s: call launch() before using this function\",
3729 else if (guestfs_is_launching (g))
3730 error (g, \"%%s: call wait_ready() before using this function\",
3733 error (g, \"%%s called from the wrong state, %%d != READY\",
3734 caller, guestfs_get_state (g));
3742 (* Client-side stubs for each function. *)
3744 fun (shortname, style, _, _, _, _, _) ->
3745 let name = "guestfs_" ^ shortname in
3747 (* Generate the context struct which stores the high-level
3748 * state between callback functions.
3750 pr "struct %s_ctx {\n" shortname;
3751 pr " /* This flag is set by the callbacks, so we know we've done\n";
3752 pr " * the callbacks as expected, and in the right sequence.\n";
3753 pr " * 0 = not called, 1 = reply_cb called.\n";
3755 pr " int cb_sequence;\n";
3756 pr " struct guestfs_message_header hdr;\n";
3757 pr " struct guestfs_message_error err;\n";
3758 (match fst style with
3761 failwithf "RConstString cannot be returned from a daemon function"
3763 | RBool _ | RString _ | RStringList _
3764 | RStruct _ | RStructList _
3766 pr " struct %s_ret ret;\n" name
3771 (* Generate the reply callback function. *)
3772 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3774 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3775 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3777 pr " /* This should definitely not happen. */\n";
3778 pr " if (ctx->cb_sequence != 0) {\n";
3779 pr " ctx->cb_sequence = 9999;\n";
3780 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3784 pr " ml->main_loop_quit (ml, g);\n";
3786 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3787 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3790 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3791 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3792 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3799 (match fst style with
3802 failwithf "RConstString cannot be returned from a daemon function"
3804 | RBool _ | RString _ | RStringList _
3805 | RStruct _ | RStructList _
3807 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3808 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3814 pr " ctx->cb_sequence = 1;\n";
3817 (* Generate the action stub. *)
3818 generate_prototype ~extern:false ~semicolon:false ~newline:true
3819 ~handle:"g" name style;
3822 match fst style with
3823 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3825 failwithf "RConstString cannot be returned from a daemon function"
3826 | RString _ | RStringList _
3827 | RStruct _ | RStructList _
3833 (match snd style with
3835 | _ -> pr " struct %s_args args;\n" name
3838 pr " struct %s_ctx ctx;\n" shortname;
3839 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3840 pr " int serial;\n";
3842 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3843 pr " guestfs_set_busy (g);\n";
3845 pr " memset (&ctx, 0, sizeof ctx);\n";
3848 (* Send the main header and arguments. *)
3849 (match snd style with
3851 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3852 (String.uppercase shortname)
3857 pr " args.%s = (char *) %s;\n" n n
3859 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
3861 pr " args.%s.%s_val = (char **) %s;\n" n n n;
3862 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3864 pr " args.%s = %s;\n" n n
3866 pr " args.%s = %s;\n" n n
3867 | FileIn _ | FileOut _ -> ()
3869 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3870 (String.uppercase shortname);
3871 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3874 pr " if (serial == -1) {\n";
3875 pr " guestfs_end_busy (g);\n";
3876 pr " return %s;\n" error_code;
3880 (* Send any additional files (FileIn) requested. *)
3881 let need_read_reply_label = ref false in
3888 pr " r = guestfs__send_file_sync (g, %s);\n" n;
3889 pr " if (r == -1) {\n";
3890 pr " guestfs_end_busy (g);\n";
3891 pr " return %s;\n" error_code;
3893 pr " if (r == -2) /* daemon cancelled */\n";
3894 pr " goto read_reply;\n";
3895 need_read_reply_label := true;
3901 (* Wait for the reply from the remote end. *)
3902 if !need_read_reply_label then pr " read_reply:\n";
3903 pr " guestfs__switch_to_receiving (g);\n";
3904 pr " ctx.cb_sequence = 0;\n";
3905 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3906 pr " (void) ml->main_loop_run (ml, g);\n";
3907 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
3908 pr " if (ctx.cb_sequence != 1) {\n";
3909 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3910 pr " guestfs_end_busy (g);\n";
3911 pr " return %s;\n" error_code;
3915 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3916 (String.uppercase shortname);
3917 pr " guestfs_end_busy (g);\n";
3918 pr " return %s;\n" error_code;
3922 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3923 pr " error (g, \"%%s\", ctx.err.error_message);\n";
3924 pr " free (ctx.err.error_message);\n";
3925 pr " guestfs_end_busy (g);\n";
3926 pr " return %s;\n" error_code;
3930 (* Expecting to receive further files (FileOut)? *)
3934 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3935 pr " guestfs_end_busy (g);\n";
3936 pr " return %s;\n" error_code;
3942 pr " guestfs_end_busy (g);\n";
3944 (match fst style with
3945 | RErr -> pr " return 0;\n"
3946 | RInt n | RInt64 n | RBool n ->
3947 pr " return ctx.ret.%s;\n" n
3949 failwithf "RConstString cannot be returned from a daemon function"
3951 pr " return ctx.ret.%s; /* caller will free */\n" n
3952 | RStringList n | RHashtable n ->
3953 pr " /* caller will free this, but we need to add a NULL entry */\n";
3954 pr " ctx.ret.%s.%s_val =\n" n n;
3955 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3956 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3958 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3959 pr " return ctx.ret.%s.%s_val;\n" n n
3961 pr " /* caller will free this */\n";
3962 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3963 | RStructList (n, _) ->
3964 pr " /* caller will free this */\n";
3965 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3971 (* Functions to free structures. *)
3972 pr "/* Structure-freeing functions. These rely on the fact that the\n";
3973 pr " * structure format is identical to the XDR format. See note in\n";
3974 pr " * generator.ml.\n";
3981 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
3983 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
3989 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
3991 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
3998 (* Generate daemon/actions.h. *)
3999 and generate_daemon_actions_h () =
4000 generate_header CStyle GPLv2;
4002 pr "#include \"../src/guestfs_protocol.h\"\n";
4006 fun (name, style, _, _, _, _, _) ->
4008 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4012 (* Generate the server-side stubs. *)
4013 and generate_daemon_actions () =
4014 generate_header CStyle GPLv2;
4016 pr "#include <config.h>\n";
4018 pr "#include <stdio.h>\n";
4019 pr "#include <stdlib.h>\n";
4020 pr "#include <string.h>\n";
4021 pr "#include <inttypes.h>\n";
4022 pr "#include <ctype.h>\n";
4023 pr "#include <rpc/types.h>\n";
4024 pr "#include <rpc/xdr.h>\n";
4026 pr "#include \"daemon.h\"\n";
4027 pr "#include \"../src/guestfs_protocol.h\"\n";
4028 pr "#include \"actions.h\"\n";
4032 fun (name, style, _, _, _, _, _) ->
4033 (* Generate server-side stubs. *)
4034 pr "static void %s_stub (XDR *xdr_in)\n" name;
4037 match fst style with
4038 | RErr | RInt _ -> pr " int r;\n"; "-1"
4039 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4040 | RBool _ -> pr " int r;\n"; "-1"
4042 failwithf "RConstString cannot be returned from a daemon function"
4043 | RString _ -> pr " char *r;\n"; "NULL"
4044 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4045 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4046 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL" in
4048 (match snd style with
4051 pr " struct guestfs_%s_args args;\n" name;
4054 (* Note we allow the string to be writable, in order to
4055 * allow device name translation. This is safe because
4056 * we can modify the string (passed from RPC).
4059 | OptString n -> pr " char *%s;\n" n
4060 | StringList n -> pr " char **%s;\n" n
4061 | Bool n -> pr " int %s;\n" n
4062 | Int n -> pr " int %s;\n" n
4063 | FileIn _ | FileOut _ -> ()
4068 (match snd style with
4071 pr " memset (&args, 0, sizeof args);\n";
4073 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4074 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4079 | String n -> pr " %s = args.%s;\n" n n
4080 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4082 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4083 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4084 pr " if (%s == NULL) {\n" n;
4085 pr " reply_with_perror (\"realloc\");\n";
4088 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4089 pr " args.%s.%s_val = %s;\n" n n n;
4090 | Bool n -> pr " %s = args.%s;\n" n n
4091 | Int n -> pr " %s = args.%s;\n" n n
4092 | FileIn _ | FileOut _ -> ()
4097 (* Don't want to call the impl with any FileIn or FileOut
4098 * parameters, since these go "outside" the RPC protocol.
4101 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4103 pr " r = do_%s " name;
4104 generate_call_args argsnofile;
4107 pr " if (r == %s)\n" error_code;
4108 pr " /* do_%s has already called reply_with_error */\n" name;
4112 (* If there are any FileOut parameters, then the impl must
4113 * send its own reply.
4116 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4118 pr " /* do_%s has already sent a reply */\n" name
4120 match fst style with
4121 | RErr -> pr " reply (NULL, NULL);\n"
4122 | RInt n | RInt64 n | RBool n ->
4123 pr " struct guestfs_%s_ret ret;\n" name;
4124 pr " ret.%s = r;\n" n;
4125 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4128 failwithf "RConstString cannot be returned from a daemon function"
4130 pr " struct guestfs_%s_ret ret;\n" name;
4131 pr " ret.%s = r;\n" n;
4132 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4135 | RStringList n | RHashtable n ->
4136 pr " struct guestfs_%s_ret ret;\n" name;
4137 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4138 pr " ret.%s.%s_val = r;\n" n n;
4139 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4141 pr " free_strings (r);\n"
4143 pr " struct guestfs_%s_ret ret;\n" name;
4144 pr " ret.%s = *r;\n" n;
4145 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4147 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4149 | RStructList (n, _) ->
4150 pr " struct guestfs_%s_ret ret;\n" name;
4151 pr " ret.%s = *r;\n" n;
4152 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4154 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4158 (* Free the args. *)
4159 (match snd style with
4164 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4171 (* Dispatch function. *)
4172 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4174 pr " switch (proc_nr) {\n";
4177 fun (name, style, _, _, _, _, _) ->
4178 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4179 pr " %s_stub (xdr_in);\n" name;
4184 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d, set LIBGUESTFS_PATH to point to the matching libguestfs appliance directory\", proc_nr);\n";
4189 (* LVM columns and tokenization functions. *)
4190 (* XXX This generates crap code. We should rethink how we
4196 pr "static const char *lvm_%s_cols = \"%s\";\n"
4197 typ (String.concat "," (List.map fst cols));
4200 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4202 pr " char *tok, *p, *next;\n";
4206 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4209 pr " if (!str) {\n";
4210 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4213 pr " if (!*str || isspace (*str)) {\n";
4214 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4219 fun (name, coltype) ->
4220 pr " if (!tok) {\n";
4221 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4224 pr " p = strchrnul (tok, ',');\n";
4225 pr " if (*p) next = p+1; else next = NULL;\n";
4226 pr " *p = '\\0';\n";
4229 pr " r->%s = strdup (tok);\n" name;
4230 pr " if (r->%s == NULL) {\n" name;
4231 pr " perror (\"strdup\");\n";
4235 pr " for (i = j = 0; i < 32; ++j) {\n";
4236 pr " if (tok[j] == '\\0') {\n";
4237 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4239 pr " } else if (tok[j] != '-')\n";
4240 pr " r->%s[i++] = tok[j];\n" name;
4243 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4244 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4248 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4249 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4253 pr " if (tok[0] == '\\0')\n";
4254 pr " r->%s = -1;\n" name;
4255 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4256 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4259 | FInt32 | FUInt32 | FUInt64 | FChar ->
4260 assert false (* can never be an LVM column *)
4262 pr " tok = next;\n";
4265 pr " if (tok != NULL) {\n";
4266 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4273 pr "guestfs_int_lvm_%s_list *\n" typ;
4274 pr "parse_command_line_%ss (void)\n" typ;
4276 pr " char *out, *err;\n";
4277 pr " char *p, *pend;\n";
4279 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4280 pr " void *newp;\n";
4282 pr " ret = malloc (sizeof *ret);\n";
4283 pr " if (!ret) {\n";
4284 pr " reply_with_perror (\"malloc\");\n";
4285 pr " return NULL;\n";
4288 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4289 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4291 pr " r = command (&out, &err,\n";
4292 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4293 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4294 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4295 pr " if (r == -1) {\n";
4296 pr " reply_with_error (\"%%s\", err);\n";
4297 pr " free (out);\n";
4298 pr " free (err);\n";
4299 pr " free (ret);\n";
4300 pr " return NULL;\n";
4303 pr " free (err);\n";
4305 pr " /* Tokenize each line of the output. */\n";
4308 pr " while (p) {\n";
4309 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4310 pr " if (pend) {\n";
4311 pr " *pend = '\\0';\n";
4315 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4318 pr " if (!*p) { /* Empty line? Skip it. */\n";
4323 pr " /* Allocate some space to store this next entry. */\n";
4324 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4325 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4326 pr " if (newp == NULL) {\n";
4327 pr " reply_with_perror (\"realloc\");\n";
4328 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4329 pr " free (ret);\n";
4330 pr " free (out);\n";
4331 pr " return NULL;\n";
4333 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4335 pr " /* Tokenize the next entry. */\n";
4336 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4337 pr " if (r == -1) {\n";
4338 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4339 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4340 pr " free (ret);\n";
4341 pr " free (out);\n";
4342 pr " return NULL;\n";
4349 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4351 pr " free (out);\n";
4352 pr " return ret;\n";
4355 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4357 (* Generate a list of function names, for debugging in the daemon.. *)
4358 and generate_daemon_names () =
4359 generate_header CStyle GPLv2;
4361 pr "#include <config.h>\n";
4363 pr "#include \"daemon.h\"\n";
4366 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4367 pr "const char *function_names[] = {\n";
4369 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4373 (* Generate the tests. *)
4374 and generate_tests () =
4375 generate_header CStyle GPLv2;
4382 #include <sys/types.h>
4385 #include \"guestfs.h\"
4387 static guestfs_h *g;
4388 static int suppress_error = 0;
4390 static void print_error (guestfs_h *g, void *data, const char *msg)
4392 if (!suppress_error)
4393 fprintf (stderr, \"%%s\\n\", msg);
4396 static void print_strings (char * const * const argv)
4400 for (argc = 0; argv[argc] != NULL; ++argc)
4401 printf (\"\\t%%s\\n\", argv[argc]);
4405 static void print_table (char * const * const argv)
4409 for (i = 0; argv[i] != NULL; i += 2)
4410 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
4414 static void no_test_warnings (void)
4420 | name, _, _, _, [], _, _ ->
4421 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4422 | name, _, _, _, tests, _, _ -> ()
4428 (* Generate the actual tests. Note that we generate the tests
4429 * in reverse order, deliberately, so that (in general) the
4430 * newest tests run first. This makes it quicker and easier to
4435 fun (name, _, _, _, tests, _, _) ->
4436 mapi (generate_one_test name) tests
4437 ) (List.rev all_functions) in
4438 let test_names = List.concat test_names in
4439 let nr_tests = List.length test_names in
4442 int main (int argc, char *argv[])
4446 const char *filename;
4448 int nr_tests, test_num = 0;
4450 setbuf (stdout, NULL);
4452 no_test_warnings ();
4454 g = guestfs_create ();
4456 printf (\"guestfs_create FAILED\\n\");
4460 guestfs_set_error_handler (g, print_error, NULL);
4462 guestfs_set_path (g, \"../appliance\");
4464 filename = \"test1.img\";
4465 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4470 if (lseek (fd, %d, SEEK_SET) == -1) {
4476 if (write (fd, &c, 1) == -1) {
4482 if (close (fd) == -1) {
4487 if (guestfs_add_drive (g, filename) == -1) {
4488 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4492 filename = \"test2.img\";
4493 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4498 if (lseek (fd, %d, SEEK_SET) == -1) {
4504 if (write (fd, &c, 1) == -1) {
4510 if (close (fd) == -1) {
4515 if (guestfs_add_drive (g, filename) == -1) {
4516 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4520 filename = \"test3.img\";
4521 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4526 if (lseek (fd, %d, SEEK_SET) == -1) {
4532 if (write (fd, &c, 1) == -1) {
4538 if (close (fd) == -1) {
4543 if (guestfs_add_drive (g, filename) == -1) {
4544 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4548 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4549 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4553 if (guestfs_launch (g) == -1) {
4554 printf (\"guestfs_launch FAILED\\n\");
4558 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4561 if (guestfs_wait_ready (g) == -1) {
4562 printf (\"guestfs_wait_ready FAILED\\n\");
4566 /* Cancel previous alarm. */
4571 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4575 pr " test_num++;\n";
4576 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4577 pr " if (%s () == -1) {\n" test_name;
4578 pr " printf (\"%s FAILED\\n\");\n" test_name;
4584 pr " guestfs_close (g);\n";
4585 pr " unlink (\"test1.img\");\n";
4586 pr " unlink (\"test2.img\");\n";
4587 pr " unlink (\"test3.img\");\n";
4590 pr " if (failed > 0) {\n";
4591 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4599 and generate_one_test name i (init, prereq, test) =
4600 let test_name = sprintf "test_%s_%d" name i in
4603 static int %s_skip (void)
4607 str = getenv (\"TEST_ONLY\");
4609 return strstr (str, \"%s\") == NULL;
4610 str = getenv (\"SKIP_%s\");
4611 if (str && strcmp (str, \"1\") == 0) return 1;
4612 str = getenv (\"SKIP_TEST_%s\");
4613 if (str && strcmp (str, \"1\") == 0) return 1;
4617 " test_name name (String.uppercase test_name) (String.uppercase name);
4620 | Disabled | Always -> ()
4621 | If code | Unless code ->
4622 pr "static int %s_prereq (void)\n" test_name;
4630 static int %s (void)
4633 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
4637 " test_name test_name test_name;
4641 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4643 pr " if (! %s_prereq ()) {\n" test_name;
4644 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4648 generate_one_test_body name i test_name init test;
4650 pr " if (%s_prereq ()) {\n" test_name;
4651 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4655 generate_one_test_body name i test_name init test;
4657 generate_one_test_body name i test_name init test
4665 and generate_one_test_body name i test_name init test =
4667 | InitNone (* XXX at some point, InitNone and InitEmpty became
4668 * folded together as the same thing. Really we should
4669 * make InitNone do nothing at all, but the tests may
4670 * need to be checked to make sure this is OK.
4673 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4674 List.iter (generate_test_command_call test_name)
4675 [["blockdev_setrw"; "/dev/sda"];
4679 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4680 List.iter (generate_test_command_call test_name)
4681 [["blockdev_setrw"; "/dev/sda"];
4684 ["sfdiskM"; "/dev/sda"; ","];
4685 ["mkfs"; "ext2"; "/dev/sda1"];
4686 ["mount"; "/dev/sda1"; "/"]]
4687 | InitBasicFSonLVM ->
4688 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4690 List.iter (generate_test_command_call test_name)
4691 [["blockdev_setrw"; "/dev/sda"];
4694 ["sfdiskM"; "/dev/sda"; ","];
4695 ["pvcreate"; "/dev/sda1"];
4696 ["vgcreate"; "VG"; "/dev/sda1"];
4697 ["lvcreate"; "LV"; "VG"; "8"];
4698 ["mkfs"; "ext2"; "/dev/VG/LV"];
4699 ["mount"; "/dev/VG/LV"; "/"]]
4702 let get_seq_last = function
4704 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4707 let seq = List.rev seq in
4708 List.rev (List.tl seq), List.hd seq
4713 pr " /* TestRun for %s (%d) */\n" name i;
4714 List.iter (generate_test_command_call test_name) seq
4715 | TestOutput (seq, expected) ->
4716 pr " /* TestOutput for %s (%d) */\n" name i;
4717 pr " const char *expected = \"%s\";\n" (c_quote expected);
4718 let seq, last = get_seq_last seq in
4720 pr " if (strcmp (r, expected) != 0) {\n";
4721 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4725 List.iter (generate_test_command_call test_name) seq;
4726 generate_test_command_call ~test test_name last
4727 | TestOutputList (seq, expected) ->
4728 pr " /* TestOutputList for %s (%d) */\n" name i;
4729 let seq, last = get_seq_last seq in
4733 pr " if (!r[%d]) {\n" i;
4734 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4735 pr " print_strings (r);\n";
4739 pr " const char *expected = \"%s\";\n" (c_quote str);
4740 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4741 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4746 pr " if (r[%d] != NULL) {\n" (List.length expected);
4747 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4749 pr " print_strings (r);\n";
4753 List.iter (generate_test_command_call test_name) seq;
4754 generate_test_command_call ~test test_name last
4755 | TestOutputListOfDevices (seq, expected) ->
4756 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
4757 let seq, last = get_seq_last seq in
4761 pr " if (!r[%d]) {\n" i;
4762 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4763 pr " print_strings (r);\n";
4767 pr " const char *expected = \"%s\";\n" (c_quote str);
4768 pr " r[%d][5] = 's';\n" i;
4769 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4770 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4775 pr " if (r[%d] != NULL) {\n" (List.length expected);
4776 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4778 pr " print_strings (r);\n";
4782 List.iter (generate_test_command_call test_name) seq;
4783 generate_test_command_call ~test test_name last
4784 | TestOutputInt (seq, expected) ->
4785 pr " /* TestOutputInt for %s (%d) */\n" name i;
4786 let seq, last = get_seq_last seq in
4788 pr " if (r != %d) {\n" expected;
4789 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4795 List.iter (generate_test_command_call test_name) seq;
4796 generate_test_command_call ~test test_name last
4797 | TestOutputIntOp (seq, op, expected) ->
4798 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
4799 let seq, last = get_seq_last seq in
4801 pr " if (! (r %s %d)) {\n" op expected;
4802 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
4803 test_name op expected;
4808 List.iter (generate_test_command_call test_name) seq;
4809 generate_test_command_call ~test test_name last
4810 | TestOutputTrue seq ->
4811 pr " /* TestOutputTrue for %s (%d) */\n" name i;
4812 let seq, last = get_seq_last seq in
4815 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4820 List.iter (generate_test_command_call test_name) seq;
4821 generate_test_command_call ~test test_name last
4822 | TestOutputFalse seq ->
4823 pr " /* TestOutputFalse for %s (%d) */\n" name i;
4824 let seq, last = get_seq_last seq in
4827 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4832 List.iter (generate_test_command_call test_name) seq;
4833 generate_test_command_call ~test test_name last
4834 | TestOutputLength (seq, expected) ->
4835 pr " /* TestOutputLength for %s (%d) */\n" name i;
4836 let seq, last = get_seq_last seq in
4839 pr " for (j = 0; j < %d; ++j)\n" expected;
4840 pr " if (r[j] == NULL) {\n";
4841 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
4843 pr " print_strings (r);\n";
4846 pr " if (r[j] != NULL) {\n";
4847 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
4849 pr " print_strings (r);\n";
4853 List.iter (generate_test_command_call test_name) seq;
4854 generate_test_command_call ~test test_name last
4855 | TestOutputStruct (seq, checks) ->
4856 pr " /* TestOutputStruct for %s (%d) */\n" name i;
4857 let seq, last = get_seq_last seq in
4861 | CompareWithInt (field, expected) ->
4862 pr " if (r->%s != %d) {\n" field expected;
4863 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4864 test_name field expected;
4865 pr " (int) r->%s);\n" field;
4868 | CompareWithIntOp (field, op, expected) ->
4869 pr " if (!(r->%s %s %d)) {\n" field op expected;
4870 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
4871 test_name field op expected;
4872 pr " (int) r->%s);\n" field;
4875 | CompareWithString (field, expected) ->
4876 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4877 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4878 test_name field expected;
4879 pr " r->%s);\n" field;
4882 | CompareFieldsIntEq (field1, field2) ->
4883 pr " if (r->%s != r->%s) {\n" field1 field2;
4884 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4885 test_name field1 field2;
4886 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
4889 | CompareFieldsStrEq (field1, field2) ->
4890 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4891 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4892 test_name field1 field2;
4893 pr " r->%s, r->%s);\n" field1 field2;
4898 List.iter (generate_test_command_call test_name) seq;
4899 generate_test_command_call ~test test_name last
4900 | TestLastFail seq ->
4901 pr " /* TestLastFail for %s (%d) */\n" name i;
4902 let seq, last = get_seq_last seq in
4903 List.iter (generate_test_command_call test_name) seq;
4904 generate_test_command_call test_name ~expect_error:true last
4906 (* Generate the code to run a command, leaving the result in 'r'.
4907 * If you expect to get an error then you should set expect_error:true.
4909 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4911 | [] -> assert false
4913 (* Look up the command to find out what args/ret it has. *)
4916 let _, style, _, _, _, _, _ =
4917 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4920 failwithf "%s: in test, command %s was not found" test_name name in
4922 if List.length (snd style) <> List.length args then
4923 failwithf "%s: in test, wrong number of args given to %s"
4930 | OptString n, "NULL" -> ()
4932 | OptString n, arg ->
4933 pr " const char *%s = \"%s\";\n" n (c_quote arg);
4936 | FileIn _, _ | FileOut _, _ -> ()
4937 | StringList n, arg ->
4938 let strs = string_split " " arg in
4941 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
4943 pr " const char *%s[] = {\n" n;
4945 fun i _ -> pr " %s_%d,\n" n i
4949 ) (List.combine (snd style) args);
4952 match fst style with
4953 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
4954 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4955 | RConstString _ -> pr " const char *r;\n"; "NULL"
4956 | RString _ -> pr " char *r;\n"; "NULL"
4957 | RStringList _ | RHashtable _ ->
4961 | RStruct (_, typ) ->
4962 pr " struct guestfs_%s *r;\n" typ; "NULL"
4963 | RStructList (_, typ) ->
4964 pr " struct guestfs_%s_list *r;\n" typ; "NULL" in
4966 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
4967 pr " r = guestfs_%s (g" name;
4969 (* Generate the parameters. *)
4972 | OptString _, "NULL" -> pr ", NULL"
4976 | FileIn _, arg | FileOut _, arg ->
4977 pr ", \"%s\"" (c_quote arg)
4978 | StringList n, _ ->
4982 try int_of_string arg
4983 with Failure "int_of_string" ->
4984 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4987 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4988 ) (List.combine (snd style) args);
4991 if not expect_error then
4992 pr " if (r == %s)\n" error_code
4994 pr " if (r != %s)\n" error_code;
4997 (* Insert the test code. *)
5003 (match fst style with
5004 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
5005 | RString _ -> pr " free (r);\n"
5006 | RStringList _ | RHashtable _ ->
5007 pr " for (i = 0; r[i] != NULL; ++i)\n";
5008 pr " free (r[i]);\n";
5010 | RStruct (_, typ) ->
5011 pr " guestfs_free_%s (r);\n" typ
5012 | RStructList (_, typ) ->
5013 pr " guestfs_free_%s_list (r);\n" typ
5019 let str = replace_str str "\r" "\\r" in
5020 let str = replace_str str "\n" "\\n" in
5021 let str = replace_str str "\t" "\\t" in
5022 let str = replace_str str "\000" "\\0" in
5025 (* Generate a lot of different functions for guestfish. *)
5026 and generate_fish_cmds () =
5027 generate_header CStyle GPLv2;
5031 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5033 let all_functions_sorted =
5035 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5036 ) all_functions_sorted in
5038 pr "#include <stdio.h>\n";
5039 pr "#include <stdlib.h>\n";
5040 pr "#include <string.h>\n";
5041 pr "#include <inttypes.h>\n";
5043 pr "#include <guestfs.h>\n";
5044 pr "#include \"fish.h\"\n";
5047 (* list_commands function, which implements guestfish -h *)
5048 pr "void list_commands (void)\n";
5050 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
5051 pr " list_builtin_commands ();\n";
5053 fun (name, _, _, flags, _, shortdesc, _) ->
5054 let name = replace_char name '_' '-' in
5055 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
5057 ) all_functions_sorted;
5058 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
5062 (* display_command function, which implements guestfish -h cmd *)
5063 pr "void display_command (const char *cmd)\n";
5066 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5067 let name2 = replace_char name '_' '-' in
5069 try find_map (function FishAlias n -> Some n | _ -> None) flags
5070 with Not_found -> name in
5071 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5073 match snd style with
5077 name2 (String.concat "> <" (List.map name_of_argt args)) in
5080 if List.mem ProtocolLimitWarning flags then
5081 ("\n\n" ^ protocol_limit_warning)
5084 (* For DangerWillRobinson commands, we should probably have
5085 * guestfish prompt before allowing you to use them (especially
5086 * in interactive mode). XXX
5090 if List.mem DangerWillRobinson flags then
5091 ("\n\n" ^ danger_will_robinson)
5094 let describe_alias =
5095 if name <> alias then
5096 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5100 pr "strcasecmp (cmd, \"%s\") == 0" name;
5101 if name <> name2 then
5102 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5103 if name <> alias then
5104 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5106 pr " pod2text (\"%s - %s\", %S);\n"
5108 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5111 pr " display_builtin_command (cmd);\n";
5115 (* print_* functions *)
5119 List.exists (function (_, FUUID) -> true | _ -> false) cols in
5121 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5130 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5132 pr " printf (\"%s: \");\n" name;
5133 pr " for (i = 0; i < 32; ++i)\n";
5134 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5135 pr " printf (\"\\n\");\n"
5136 | name, (FUInt64|FBytes) ->
5137 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5139 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5141 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5143 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5145 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5146 | name, FOptPercent ->
5147 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5148 typ name name typ name;
5149 pr " else printf (\"%s: \\n\");\n" name
5153 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5158 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5159 pr " print_%s (&%ss->val[i]);\n" typ typ;
5164 (* run_<action> actions *)
5166 fun (name, style, _, flags, _, _, _) ->
5167 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5169 (match fst style with
5172 | RBool _ -> pr " int r;\n"
5173 | RInt64 _ -> pr " int64_t r;\n"
5174 | RConstString _ -> pr " const char *r;\n"
5175 | RString _ -> pr " char *r;\n"
5176 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5177 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5178 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5185 | FileOut n -> pr " const char *%s;\n" n
5186 | StringList n -> pr " char **%s;\n" n
5187 | Bool n -> pr " int %s;\n" n
5188 | Int n -> pr " int %s;\n" n
5191 (* Check and convert parameters. *)
5192 let argc_expected = List.length (snd style) in
5193 pr " if (argc != %d) {\n" argc_expected;
5194 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
5196 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
5202 | String name -> pr " %s = argv[%d];\n" name i
5204 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5207 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5210 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5212 | StringList name ->
5213 pr " %s = parse_string_list (argv[%d]);\n" name i
5215 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5217 pr " %s = atoi (argv[%d]);\n" name i
5220 (* Call C API function. *)
5222 try find_map (function FishAction n -> Some n | _ -> None) flags
5223 with Not_found -> sprintf "guestfs_%s" name in
5225 generate_call_args ~handle:"g" (snd style);
5228 (* Check return value for errors and display command results. *)
5229 (match fst style with
5230 | RErr -> pr " return r;\n"
5232 pr " if (r == -1) return -1;\n";
5233 pr " printf (\"%%d\\n\", r);\n";
5236 pr " if (r == -1) return -1;\n";
5237 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5240 pr " if (r == -1) return -1;\n";
5241 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5244 pr " if (r == NULL) return -1;\n";
5245 pr " printf (\"%%s\\n\", r);\n";
5248 pr " if (r == NULL) return -1;\n";
5249 pr " printf (\"%%s\\n\", r);\n";
5253 pr " if (r == NULL) return -1;\n";
5254 pr " print_strings (r);\n";
5255 pr " free_strings (r);\n";
5257 | RStruct (_, typ) ->
5258 pr " if (r == NULL) return -1;\n";
5259 pr " print_%s (r);\n" typ;
5260 pr " guestfs_free_%s (r);\n" typ;
5262 | RStructList (_, typ) ->
5263 pr " if (r == NULL) return -1;\n";
5264 pr " print_%s_list (r);\n" typ;
5265 pr " guestfs_free_%s_list (r);\n" typ;
5268 pr " if (r == NULL) return -1;\n";
5269 pr " print_table (r);\n";
5270 pr " free_strings (r);\n";
5277 (* run_action function *)
5278 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5281 fun (name, _, _, flags, _, _, _) ->
5282 let name2 = replace_char name '_' '-' in
5284 try find_map (function FishAlias n -> Some n | _ -> None) flags
5285 with Not_found -> name in
5287 pr "strcasecmp (cmd, \"%s\") == 0" name;
5288 if name <> name2 then
5289 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5290 if name <> alias then
5291 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5293 pr " return run_%s (cmd, argc, argv);\n" name;
5297 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
5304 (* Readline completion for guestfish. *)
5305 and generate_fish_completion () =
5306 generate_header CStyle GPLv2;
5310 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5320 #ifdef HAVE_LIBREADLINE
5321 #include <readline/readline.h>
5326 #ifdef HAVE_LIBREADLINE
5328 static const char *const commands[] = {
5329 BUILTIN_COMMANDS_FOR_COMPLETION,
5332 (* Get the commands, including the aliases. They don't need to be
5333 * sorted - the generator() function just does a dumb linear search.
5337 fun (name, _, _, flags, _, _, _) ->
5338 let name2 = replace_char name '_' '-' in
5340 try find_map (function FishAlias n -> Some n | _ -> None) flags
5341 with Not_found -> name in
5343 if name <> alias then [name2; alias] else [name2]
5345 let commands = List.flatten commands in
5347 List.iter (pr " \"%s\",\n") commands;
5353 generator (const char *text, int state)
5355 static int index, len;
5360 len = strlen (text);
5363 rl_attempted_completion_over = 1;
5365 while ((name = commands[index]) != NULL) {
5367 if (strncasecmp (name, text, len) == 0)
5368 return strdup (name);
5374 #endif /* HAVE_LIBREADLINE */
5376 char **do_completion (const char *text, int start, int end)
5378 char **matches = NULL;
5380 #ifdef HAVE_LIBREADLINE
5381 rl_completion_append_character = ' ';
5384 matches = rl_completion_matches (text, generator);
5385 else if (complete_dest_paths)
5386 matches = rl_completion_matches (text, complete_dest_paths_generator);
5393 (* Generate the POD documentation for guestfish. *)
5394 and generate_fish_actions_pod () =
5395 let all_functions_sorted =
5397 fun (_, _, _, flags, _, _, _) ->
5398 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5399 ) all_functions_sorted in
5401 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5404 fun (name, style, _, flags, _, _, longdesc) ->
5406 Str.global_substitute rex (
5409 try Str.matched_group 1 s
5411 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5412 "C<" ^ replace_char sub '_' '-' ^ ">"
5414 let name = replace_char name '_' '-' in
5416 try find_map (function FishAlias n -> Some n | _ -> None) flags
5417 with Not_found -> name in
5419 pr "=head2 %s" name;
5420 if name <> alias then
5427 | String n -> pr " %s" n
5428 | OptString n -> pr " %s" n
5429 | StringList n -> pr " '%s ...'" n
5430 | Bool _ -> pr " true|false"
5431 | Int n -> pr " %s" n
5432 | FileIn n | FileOut n -> pr " (%s|-)" n
5436 pr "%s\n\n" longdesc;
5438 if List.exists (function FileIn _ | FileOut _ -> true
5439 | _ -> false) (snd style) then
5440 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5442 if List.mem ProtocolLimitWarning flags then
5443 pr "%s\n\n" protocol_limit_warning;
5445 if List.mem DangerWillRobinson flags then
5446 pr "%s\n\n" danger_will_robinson
5447 ) all_functions_sorted
5449 (* Generate a C function prototype. *)
5450 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5451 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5453 ?handle name style =
5454 if extern then pr "extern ";
5455 if static then pr "static ";
5456 (match fst style with
5458 | RInt _ -> pr "int "
5459 | RInt64 _ -> pr "int64_t "
5460 | RBool _ -> pr "int "
5461 | RConstString _ -> pr "const char *"
5462 | RString _ -> pr "char *"
5463 | RStringList _ | RHashtable _ -> pr "char **"
5464 | RStruct (_, typ) ->
5465 if not in_daemon then pr "struct guestfs_%s *" typ
5466 else pr "guestfs_int_%s *" typ
5467 | RStructList (_, typ) ->
5468 if not in_daemon then pr "struct guestfs_%s_list *" typ
5469 else pr "guestfs_int_%s_list *" typ
5471 pr "%s%s (" prefix name;
5472 if handle = None && List.length (snd style) = 0 then
5475 let comma = ref false in
5478 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5482 if single_line then pr ", " else pr ",\n\t\t"
5491 if not in_daemon then pr "const char *%s" n
5492 else pr "char *%s" n
5495 if not in_daemon then pr "char * const* const %s" n
5496 else pr "char **%s" n
5497 | Bool n -> next (); pr "int %s" n
5498 | Int n -> next (); pr "int %s" n
5501 if not in_daemon then (next (); pr "const char *%s" n)
5505 if semicolon then pr ";";
5506 if newline then pr "\n"
5508 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5509 and generate_call_args ?handle args =
5511 let comma = ref false in
5514 | Some handle -> pr "%s" handle; comma := true
5518 if !comma then pr ", ";
5520 pr "%s" (name_of_argt arg)
5524 (* Generate the OCaml bindings interface. *)
5525 and generate_ocaml_mli () =
5526 generate_header OCamlStyle LGPLv2;
5529 (** For API documentation you should refer to the C API
5530 in the guestfs(3) manual page. The OCaml API uses almost
5531 exactly the same calls. *)
5534 (** A [guestfs_h] handle. *)
5536 exception Error of string
5537 (** This exception is raised when there is an error. *)
5539 val create : unit -> t
5541 val close : t -> unit
5542 (** Handles are closed by the garbage collector when they become
5543 unreferenced, but callers can also call this in order to
5544 provide predictable cleanup. *)
5547 generate_ocaml_structure_decls ();
5551 fun (name, style, _, _, _, shortdesc, _) ->
5552 generate_ocaml_prototype name style;
5553 pr "(** %s *)\n" shortdesc;
5557 (* Generate the OCaml bindings implementation. *)
5558 and generate_ocaml_ml () =
5559 generate_header OCamlStyle LGPLv2;
5563 exception Error of string
5564 external create : unit -> t = \"ocaml_guestfs_create\"
5565 external close : t -> unit = \"ocaml_guestfs_close\"
5568 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5572 generate_ocaml_structure_decls ();
5576 fun (name, style, _, _, _, shortdesc, _) ->
5577 generate_ocaml_prototype ~is_external:true name style;
5580 (* Generate the OCaml bindings C implementation. *)
5581 and generate_ocaml_c () =
5582 generate_header CStyle LGPLv2;
5589 #include <caml/config.h>
5590 #include <caml/alloc.h>
5591 #include <caml/callback.h>
5592 #include <caml/fail.h>
5593 #include <caml/memory.h>
5594 #include <caml/mlvalues.h>
5595 #include <caml/signals.h>
5597 #include <guestfs.h>
5599 #include \"guestfs_c.h\"
5601 /* Copy a hashtable of string pairs into an assoc-list. We return
5602 * the list in reverse order, but hashtables aren't supposed to be
5605 static CAMLprim value
5606 copy_table (char * const * argv)
5609 CAMLlocal5 (rv, pairv, kv, vv, cons);
5613 for (i = 0; argv[i] != NULL; i += 2) {
5614 kv = caml_copy_string (argv[i]);
5615 vv = caml_copy_string (argv[i+1]);
5616 pairv = caml_alloc (2, 0);
5617 Store_field (pairv, 0, kv);
5618 Store_field (pairv, 1, vv);
5619 cons = caml_alloc (2, 0);
5620 Store_field (cons, 1, rv);
5622 Store_field (cons, 0, pairv);
5630 (* Struct copy functions. *)
5633 let has_optpercent_col =
5634 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
5636 pr "static CAMLprim value\n";
5637 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5639 pr " CAMLparam0 ();\n";
5640 if has_optpercent_col then
5641 pr " CAMLlocal3 (rv, v, v2);\n"
5643 pr " CAMLlocal2 (rv, v);\n";
5645 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5650 pr " v = caml_copy_string (%s->%s);\n" typ name
5652 pr " v = caml_alloc_string (32);\n";
5653 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5654 | name, (FBytes|FInt64|FUInt64) ->
5655 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5656 | name, (FInt32|FUInt32) ->
5657 pr " v = caml_copy_int32 (%s->%s);\n" typ name
5658 | name, FOptPercent ->
5659 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5660 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5661 pr " v = caml_alloc (1, 0);\n";
5662 pr " Store_field (v, 0, v2);\n";
5663 pr " } else /* None */\n";
5664 pr " v = Val_int (0);\n";
5666 pr " v = Val_int (%s->%s);\n" typ name
5668 pr " Store_field (rv, %d, v);\n" i
5670 pr " CAMLreturn (rv);\n";
5674 pr "static CAMLprim value\n";
5675 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
5678 pr " CAMLparam0 ();\n";
5679 pr " CAMLlocal2 (rv, v);\n";
5682 pr " if (%ss->len == 0)\n" typ;
5683 pr " CAMLreturn (Atom (0));\n";
5685 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5686 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5687 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
5688 pr " caml_modify (&Field (rv, i), v);\n";
5690 pr " CAMLreturn (rv);\n";
5698 fun (name, style, _, _, _, _, _) ->
5700 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5702 pr "CAMLprim value\n";
5703 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5704 List.iter (pr ", value %s") (List.tl params);
5709 | [p1; p2; p3; p4; p5] ->
5710 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
5711 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5712 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5713 pr " CAMLxparam%d (%s);\n"
5714 (List.length rest) (String.concat ", " rest)
5716 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5718 pr " CAMLlocal1 (rv);\n";
5721 pr " guestfs_h *g = Guestfs_val (gv);\n";
5722 pr " if (g == NULL)\n";
5723 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
5731 pr " const char *%s = String_val (%sv);\n" n n
5733 pr " const char *%s =\n" n;
5734 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5737 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5739 pr " int %s = Bool_val (%sv);\n" n n
5741 pr " int %s = Int_val (%sv);\n" n n
5744 match fst style with
5745 | RErr -> pr " int r;\n"; "-1"
5746 | RInt _ -> pr " int r;\n"; "-1"
5747 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5748 | RBool _ -> pr " int r;\n"; "-1"
5749 | RConstString _ -> pr " const char *r;\n"; "NULL"
5750 | RString _ -> pr " char *r;\n"; "NULL"
5755 | RStruct (_, typ) ->
5756 pr " struct guestfs_%s *r;\n" typ; "NULL"
5757 | RStructList (_, typ) ->
5758 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5765 pr " caml_enter_blocking_section ();\n";
5766 pr " r = guestfs_%s " name;
5767 generate_call_args ~handle:"g" (snd style);
5769 pr " caml_leave_blocking_section ();\n";
5774 pr " ocaml_guestfs_free_strings (%s);\n" n;
5775 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5778 pr " if (r == %s)\n" error_code;
5779 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5782 (match fst style with
5783 | RErr -> pr " rv = Val_unit;\n"
5784 | RInt _ -> pr " rv = Val_int (r);\n"
5786 pr " rv = caml_copy_int64 (r);\n"
5787 | RBool _ -> pr " rv = Val_bool (r);\n"
5788 | RConstString _ -> pr " rv = caml_copy_string (r);\n"
5790 pr " rv = caml_copy_string (r);\n";
5793 pr " rv = caml_copy_string_array ((const char **) r);\n";
5794 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5796 | RStruct (_, typ) ->
5797 pr " rv = copy_%s (r);\n" typ;
5798 pr " guestfs_free_%s (r);\n" typ;
5799 | RStructList (_, typ) ->
5800 pr " rv = copy_%s_list (r);\n" typ;
5801 pr " guestfs_free_%s_list (r);\n" typ;
5803 pr " rv = copy_table (r);\n";
5804 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5808 pr " CAMLreturn (rv);\n";
5812 if List.length params > 5 then (
5813 pr "CAMLprim value\n";
5814 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5816 pr " return ocaml_guestfs_%s (argv[0]" name;
5817 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5824 and generate_ocaml_structure_decls () =
5827 pr "type %s = {\n" typ;
5830 | name, FString -> pr " %s : string;\n" name
5831 | name, FUUID -> pr " %s : string;\n" name
5832 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
5833 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
5834 | name, FChar -> pr " %s : char;\n" name
5835 | name, FOptPercent -> pr " %s : float option;\n" name
5841 and generate_ocaml_prototype ?(is_external = false) name style =
5842 if is_external then pr "external " else pr "val ";
5843 pr "%s : t -> " name;
5846 | String _ | FileIn _ | FileOut _ -> pr "string -> "
5847 | OptString _ -> pr "string option -> "
5848 | StringList _ -> pr "string array -> "
5849 | Bool _ -> pr "bool -> "
5850 | Int _ -> pr "int -> "
5852 (match fst style with
5853 | RErr -> pr "unit" (* all errors are turned into exceptions *)
5854 | RInt _ -> pr "int"
5855 | RInt64 _ -> pr "int64"
5856 | RBool _ -> pr "bool"
5857 | RConstString _ -> pr "string"
5858 | RString _ -> pr "string"
5859 | RStringList _ -> pr "string array"
5860 | RStruct (_, typ) -> pr "%s" typ
5861 | RStructList (_, typ) -> pr "%s array" typ
5862 | RHashtable _ -> pr "(string * string) list"
5864 if is_external then (
5866 if List.length (snd style) + 1 > 5 then
5867 pr "\"ocaml_guestfs_%s_byte\" " name;
5868 pr "\"ocaml_guestfs_%s\"" name
5872 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5873 and generate_perl_xs () =
5874 generate_header CStyle LGPLv2;
5877 #include \"EXTERN.h\"
5881 #include <guestfs.h>
5884 #define PRId64 \"lld\"
5888 my_newSVll(long long val) {
5889 #ifdef USE_64_BIT_ALL
5890 return newSViv(val);
5894 len = snprintf(buf, 100, \"%%\" PRId64, val);
5895 return newSVpv(buf, len);
5900 #define PRIu64 \"llu\"
5904 my_newSVull(unsigned long long val) {
5905 #ifdef USE_64_BIT_ALL
5906 return newSVuv(val);
5910 len = snprintf(buf, 100, \"%%\" PRIu64, val);
5911 return newSVpv(buf, len);
5915 /* http://www.perlmonks.org/?node_id=680842 */
5917 XS_unpack_charPtrPtr (SV *arg) {
5922 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5923 croak (\"array reference expected\");
5925 av = (AV *)SvRV (arg);
5926 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5928 croak (\"malloc failed\");
5930 for (i = 0; i <= av_len (av); i++) {
5931 SV **elem = av_fetch (av, i, 0);
5933 if (!elem || !*elem)
5934 croak (\"missing element in list\");
5936 ret[i] = SvPV_nolen (*elem);
5944 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
5951 RETVAL = guestfs_create ();
5953 croak (\"could not create guestfs handle\");
5954 guestfs_set_error_handler (RETVAL, NULL, NULL);
5967 fun (name, style, _, _, _, _, _) ->
5968 (match fst style with
5969 | RErr -> pr "void\n"
5970 | RInt _ -> pr "SV *\n"
5971 | RInt64 _ -> pr "SV *\n"
5972 | RBool _ -> pr "SV *\n"
5973 | RConstString _ -> pr "SV *\n"
5974 | RString _ -> pr "SV *\n"
5976 | RStruct _ | RStructList _
5978 pr "void\n" (* all lists returned implictly on the stack *)
5980 (* Call and arguments. *)
5982 generate_call_args ~handle:"g" (snd style);
5984 pr " guestfs_h *g;\n";
5988 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
5990 (* http://www.perlmonks.org/?node_id=554277
5991 * Note that the implicit handle argument means we have
5992 * to add 1 to the ST(x) operator.
5994 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5995 | StringList n -> pr " char **%s;\n" n
5996 | Bool n -> pr " int %s;\n" n
5997 | Int n -> pr " int %s;\n" n
6000 let do_cleanups () =
6003 | String _ | OptString _ | Bool _ | Int _
6004 | FileIn _ | FileOut _ -> ()
6005 | StringList n -> pr " free (%s);\n" n
6010 (match fst style with
6015 pr " r = guestfs_%s " name;
6016 generate_call_args ~handle:"g" (snd style);
6019 pr " if (r == -1)\n";
6020 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6026 pr " %s = guestfs_%s " n name;
6027 generate_call_args ~handle:"g" (snd style);
6030 pr " if (%s == -1)\n" n;
6031 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6032 pr " RETVAL = newSViv (%s);\n" n;
6037 pr " int64_t %s;\n" n;
6039 pr " %s = guestfs_%s " n name;
6040 generate_call_args ~handle:"g" (snd style);
6043 pr " if (%s == -1)\n" n;
6044 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6045 pr " RETVAL = my_newSVll (%s);\n" n;
6050 pr " const char *%s;\n" n;
6052 pr " %s = guestfs_%s " n name;
6053 generate_call_args ~handle:"g" (snd style);
6056 pr " if (%s == NULL)\n" n;
6057 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6058 pr " RETVAL = newSVpv (%s, 0);\n" n;
6063 pr " char *%s;\n" n;
6065 pr " %s = guestfs_%s " n name;
6066 generate_call_args ~handle:"g" (snd style);
6069 pr " if (%s == NULL)\n" n;
6070 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6071 pr " RETVAL = newSVpv (%s, 0);\n" n;
6072 pr " free (%s);\n" n;
6075 | RStringList n | RHashtable n ->
6077 pr " char **%s;\n" n;
6080 pr " %s = guestfs_%s " n name;
6081 generate_call_args ~handle:"g" (snd style);
6084 pr " if (%s == NULL)\n" n;
6085 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6086 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6087 pr " EXTEND (SP, n);\n";
6088 pr " for (i = 0; i < n; ++i) {\n";
6089 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6090 pr " free (%s[i]);\n" n;
6092 pr " free (%s);\n" n;
6093 | RStruct (n, typ) ->
6094 let cols = cols_of_struct typ in
6095 generate_perl_struct_code typ cols name style n do_cleanups
6096 | RStructList (n, typ) ->
6097 let cols = cols_of_struct typ in
6098 generate_perl_struct_list_code typ cols name style n do_cleanups
6104 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6106 pr " struct guestfs_%s_list *%s;\n" typ n;
6110 pr " %s = guestfs_%s " n name;
6111 generate_call_args ~handle:"g" (snd style);
6114 pr " if (%s == NULL)\n" n;
6115 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6116 pr " EXTEND (SP, %s->len);\n" n;
6117 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6118 pr " hv = newHV ();\n";
6122 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6123 name (String.length name) n name
6125 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6126 name (String.length name) n name
6127 | name, (FBytes|FUInt64) ->
6128 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6129 name (String.length name) n name
6131 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6132 name (String.length name) n name
6133 | name, (FInt32|FUInt32) ->
6134 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6135 name (String.length name) n name
6137 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6138 name (String.length name) n name
6139 | name, FOptPercent ->
6140 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6141 name (String.length name) n name
6143 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6145 pr " guestfs_free_%s_list (%s);\n" typ n
6147 and generate_perl_struct_code typ cols name style n do_cleanups =
6149 pr " struct guestfs_%s *%s;\n" typ n;
6151 pr " %s = guestfs_%s " n name;
6152 generate_call_args ~handle:"g" (snd style);
6155 pr " if (%s == NULL)\n" n;
6156 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6157 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6159 fun ((name, _) as col) ->
6160 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6164 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6167 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6169 | name, (FBytes|FUInt64) ->
6170 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6173 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6175 | name, (FInt32|FUInt32) ->
6176 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6179 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6181 | name, FOptPercent ->
6182 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6185 pr " free (%s);\n" n
6187 (* Generate Sys/Guestfs.pm. *)
6188 and generate_perl_pm () =
6189 generate_header HashStyle LGPLv2;
6196 Sys::Guestfs - Perl bindings for libguestfs
6202 my $h = Sys::Guestfs->new ();
6203 $h->add_drive ('guest.img');
6206 $h->mount ('/dev/sda1', '/');
6207 $h->touch ('/hello');
6212 The C<Sys::Guestfs> module provides a Perl XS binding to the
6213 libguestfs API for examining and modifying virtual machine
6216 Amongst the things this is good for: making batch configuration
6217 changes to guests, getting disk used/free statistics (see also:
6218 virt-df), migrating between virtualization systems (see also:
6219 virt-p2v), performing partial backups, performing partial guest
6220 clones, cloning guests and changing registry/UUID/hostname info, and
6223 Libguestfs uses Linux kernel and qemu code, and can access any type of
6224 guest filesystem that Linux and qemu can, including but not limited
6225 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6226 schemes, qcow, qcow2, vmdk.
6228 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6229 LVs, what filesystem is in each LV, etc.). It can also run commands
6230 in the context of the guest. Also you can access filesystems over FTP.
6232 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
6233 functions for using libguestfs from Perl, including integration
6238 All errors turn into calls to C<croak> (see L<Carp(3)>).
6246 package Sys::Guestfs;
6252 XSLoader::load ('Sys::Guestfs');
6254 =item $h = Sys::Guestfs->new ();
6256 Create a new guestfs handle.
6262 my $class = ref ($proto) || $proto;
6264 my $self = Sys::Guestfs::_create ();
6265 bless $self, $class;
6271 (* Actions. We only need to print documentation for these as
6272 * they are pulled in from the XS code automatically.
6275 fun (name, style, _, flags, _, _, longdesc) ->
6276 if not (List.mem NotInDocs flags) then (
6277 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
6279 generate_perl_prototype name style;
6281 pr "%s\n\n" longdesc;
6282 if List.mem ProtocolLimitWarning flags then
6283 pr "%s\n\n" protocol_limit_warning;
6284 if List.mem DangerWillRobinson flags then
6285 pr "%s\n\n" danger_will_robinson
6287 ) all_functions_sorted;
6299 Copyright (C) 2009 Red Hat Inc.
6303 Please see the file COPYING.LIB for the full license.
6309 L<http://libguestfs.org>,
6310 L<Sys::Guestfs::Lib(3)>.
6315 and generate_perl_prototype name style =
6316 (match fst style with
6322 | RString n -> pr "$%s = " n
6324 | RHashtable n -> pr "%%%s = " n
6326 | RStructList (n,_) -> pr "@%s = " n
6329 let comma = ref false in
6332 if !comma then pr ", ";
6335 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
6342 (* Generate Python C module. *)
6343 and generate_python_c () =
6344 generate_header CStyle LGPLv2;
6353 #include \"guestfs.h\"
6361 get_handle (PyObject *obj)
6364 assert (obj != Py_None);
6365 return ((Pyguestfs_Object *) obj)->g;
6369 put_handle (guestfs_h *g)
6373 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6376 /* This list should be freed (but not the strings) after use. */
6377 static const char **
6378 get_string_list (PyObject *obj)
6385 if (!PyList_Check (obj)) {
6386 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6390 len = PyList_Size (obj);
6391 r = malloc (sizeof (char *) * (len+1));
6393 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6397 for (i = 0; i < len; ++i)
6398 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6405 put_string_list (char * const * const argv)
6410 for (argc = 0; argv[argc] != NULL; ++argc)
6413 list = PyList_New (argc);
6414 for (i = 0; i < argc; ++i)
6415 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6421 put_table (char * const * const argv)
6423 PyObject *list, *item;
6426 for (argc = 0; argv[argc] != NULL; ++argc)
6429 list = PyList_New (argc >> 1);
6430 for (i = 0; i < argc; i += 2) {
6431 item = PyTuple_New (2);
6432 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6433 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6434 PyList_SetItem (list, i >> 1, item);
6441 free_strings (char **argv)
6445 for (argc = 0; argv[argc] != NULL; ++argc)
6451 py_guestfs_create (PyObject *self, PyObject *args)
6455 g = guestfs_create ();
6457 PyErr_SetString (PyExc_RuntimeError,
6458 \"guestfs.create: failed to allocate handle\");
6461 guestfs_set_error_handler (g, NULL, NULL);
6462 return put_handle (g);
6466 py_guestfs_close (PyObject *self, PyObject *args)
6471 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6473 g = get_handle (py_g);
6477 Py_INCREF (Py_None);
6483 (* Structures, turned into Python dictionaries. *)
6486 pr "static PyObject *\n";
6487 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6489 pr " PyObject *dict;\n";
6491 pr " dict = PyDict_New ();\n";
6495 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6496 pr " PyString_FromString (%s->%s));\n"
6499 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6500 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6502 | name, (FBytes|FUInt64) ->
6503 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6504 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6507 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6508 pr " PyLong_FromLongLong (%s->%s));\n"
6511 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6512 pr " PyLong_FromUnsignedLong (%s->%s));\n"
6515 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6516 pr " PyLong_FromLong (%s->%s));\n"
6518 | name, FOptPercent ->
6519 pr " if (%s->%s >= 0)\n" typ name;
6520 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6521 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6524 pr " Py_INCREF (Py_None);\n";
6525 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6528 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6529 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
6531 pr " return dict;\n";
6535 pr "static PyObject *\n";
6536 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
6538 pr " PyObject *list;\n";
6541 pr " list = PyList_New (%ss->len);\n" typ;
6542 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6543 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
6544 pr " return list;\n";
6549 (* Python wrapper functions. *)
6551 fun (name, style, _, _, _, _, _) ->
6552 pr "static PyObject *\n";
6553 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6556 pr " PyObject *py_g;\n";
6557 pr " guestfs_h *g;\n";
6558 pr " PyObject *py_r;\n";
6561 match fst style with
6562 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6563 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6564 | RConstString _ -> pr " const char *r;\n"; "NULL"
6565 | RString _ -> pr " char *r;\n"; "NULL"
6566 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6567 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
6568 | RStructList (_, typ) ->
6569 pr " struct guestfs_%s_list *r;\n" typ; "NULL" in
6573 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6574 | OptString n -> pr " const char *%s;\n" n
6576 pr " PyObject *py_%s;\n" n;
6577 pr " const char **%s;\n" n
6578 | Bool n -> pr " int %s;\n" n
6579 | Int n -> pr " int %s;\n" n
6584 (* Convert the parameters. *)
6585 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6588 | String _ | FileIn _ | FileOut _ -> pr "s"
6589 | OptString _ -> pr "z"
6590 | StringList _ -> pr "O"
6591 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6594 pr ":guestfs_%s\",\n" name;
6598 | String n | FileIn n | FileOut n -> pr ", &%s" n
6599 | OptString n -> pr ", &%s" n
6600 | StringList n -> pr ", &py_%s" n
6601 | Bool n -> pr ", &%s" n
6602 | Int n -> pr ", &%s" n
6606 pr " return NULL;\n";
6608 pr " g = get_handle (py_g);\n";
6611 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6613 pr " %s = get_string_list (py_%s);\n" n n;
6614 pr " if (!%s) return NULL;\n" n
6619 pr " r = guestfs_%s " name;
6620 generate_call_args ~handle:"g" (snd style);
6625 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6627 pr " free (%s);\n" n
6630 pr " if (r == %s) {\n" error_code;
6631 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6632 pr " return NULL;\n";
6636 (match fst style with
6638 pr " Py_INCREF (Py_None);\n";
6639 pr " py_r = Py_None;\n"
6641 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
6642 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
6643 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
6645 pr " py_r = PyString_FromString (r);\n";
6648 pr " py_r = put_string_list (r);\n";
6649 pr " free_strings (r);\n"
6650 | RStruct (_, typ) ->
6651 pr " py_r = put_%s (r);\n" typ;
6652 pr " guestfs_free_%s (r);\n" typ
6653 | RStructList (_, typ) ->
6654 pr " py_r = put_%s_list (r);\n" typ;
6655 pr " guestfs_free_%s_list (r);\n" typ
6657 pr " py_r = put_table (r);\n";
6658 pr " free_strings (r);\n"
6661 pr " return py_r;\n";
6666 (* Table of functions. *)
6667 pr "static PyMethodDef methods[] = {\n";
6668 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6669 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6671 fun (name, _, _, _, _, _, _) ->
6672 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6675 pr " { NULL, NULL, 0, NULL }\n";
6679 (* Init function. *)
6682 initlibguestfsmod (void)
6684 static int initialized = 0;
6686 if (initialized) return;
6687 Py_InitModule ((char *) \"libguestfsmod\", methods);
6692 (* Generate Python module. *)
6693 and generate_python_py () =
6694 generate_header HashStyle LGPLv2;
6697 u\"\"\"Python bindings for libguestfs
6700 g = guestfs.GuestFS ()
6701 g.add_drive (\"guest.img\")
6704 parts = g.list_partitions ()
6706 The guestfs module provides a Python binding to the libguestfs API
6707 for examining and modifying virtual machine disk images.
6709 Amongst the things this is good for: making batch configuration
6710 changes to guests, getting disk used/free statistics (see also:
6711 virt-df), migrating between virtualization systems (see also:
6712 virt-p2v), performing partial backups, performing partial guest
6713 clones, cloning guests and changing registry/UUID/hostname info, and
6716 Libguestfs uses Linux kernel and qemu code, and can access any type of
6717 guest filesystem that Linux and qemu can, including but not limited
6718 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6719 schemes, qcow, qcow2, vmdk.
6721 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6722 LVs, what filesystem is in each LV, etc.). It can also run commands
6723 in the context of the guest. Also you can access filesystems over FTP.
6725 Errors which happen while using the API are turned into Python
6726 RuntimeError exceptions.
6728 To create a guestfs handle you usually have to perform the following
6731 # Create the handle, call add_drive at least once, and possibly
6732 # several times if the guest has multiple block devices:
6733 g = guestfs.GuestFS ()
6734 g.add_drive (\"guest.img\")
6736 # Launch the qemu subprocess and wait for it to become ready:
6740 # Now you can issue commands, for example:
6745 import libguestfsmod
6748 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6750 def __init__ (self):
6751 \"\"\"Create a new libguestfs handle.\"\"\"
6752 self._o = libguestfsmod.create ()
6755 libguestfsmod.close (self._o)
6760 fun (name, style, _, flags, _, _, longdesc) ->
6762 generate_call_args ~handle:"self" (snd style);
6765 if not (List.mem NotInDocs flags) then (
6766 let doc = replace_str longdesc "C<guestfs_" "C<g." in
6768 match fst style with
6769 | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6772 doc ^ "\n\nThis function returns a list of strings."
6773 | RStruct (_, typ) ->
6774 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
6775 | RStructList (_, typ) ->
6776 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
6778 doc ^ "\n\nThis function returns a dictionary." in
6780 if List.mem ProtocolLimitWarning flags then
6781 doc ^ "\n\n" ^ protocol_limit_warning
6784 if List.mem DangerWillRobinson flags then
6785 doc ^ "\n\n" ^ danger_will_robinson
6787 let doc = pod2text ~width:60 name doc in
6788 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6789 let doc = String.concat "\n " doc in
6790 pr " u\"\"\"%s\"\"\"\n" doc;
6792 pr " return libguestfsmod.%s " name;
6793 generate_call_args ~handle:"self._o" (snd style);
6798 (* Useful if you need the longdesc POD text as plain text. Returns a
6801 * Because this is very slow (the slowest part of autogeneration),
6802 * we memoize the results.
6804 and pod2text ~width name longdesc =
6805 let key = width, name, longdesc in
6806 try Hashtbl.find pod2text_memo key
6808 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6809 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6811 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6812 let chan = Unix.open_process_in cmd in
6813 let lines = ref [] in
6815 let line = input_line chan in
6816 if i = 1 then (* discard the first line of output *)
6819 let line = triml line in
6820 lines := line :: !lines;
6823 let lines = try loop 1 with End_of_file -> List.rev !lines in
6824 Unix.unlink filename;
6825 (match Unix.close_process_in chan with
6826 | Unix.WEXITED 0 -> ()
6828 failwithf "pod2text: process exited with non-zero status (%d)" i
6829 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6830 failwithf "pod2text: process signalled or stopped by signal %d" i
6832 Hashtbl.add pod2text_memo key lines;
6833 let chan = open_out pod2text_memo_filename in
6834 output_value chan pod2text_memo;
6838 (* Generate ruby bindings. *)
6839 and generate_ruby_c () =
6840 generate_header CStyle LGPLv2;
6848 #include \"guestfs.h\"
6850 #include \"extconf.h\"
6852 /* For Ruby < 1.9 */
6854 #define RARRAY_LEN(r) (RARRAY((r))->len)
6857 static VALUE m_guestfs; /* guestfs module */
6858 static VALUE c_guestfs; /* guestfs_h handle */
6859 static VALUE e_Error; /* used for all errors */
6861 static void ruby_guestfs_free (void *p)
6864 guestfs_close ((guestfs_h *) p);
6867 static VALUE ruby_guestfs_create (VALUE m)
6871 g = guestfs_create ();
6873 rb_raise (e_Error, \"failed to create guestfs handle\");
6875 /* Don't print error messages to stderr by default. */
6876 guestfs_set_error_handler (g, NULL, NULL);
6878 /* Wrap it, and make sure the close function is called when the
6881 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6884 static VALUE ruby_guestfs_close (VALUE gv)
6887 Data_Get_Struct (gv, guestfs_h, g);
6889 ruby_guestfs_free (g);
6890 DATA_PTR (gv) = NULL;
6898 fun (name, style, _, _, _, _, _) ->
6899 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6900 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6903 pr " guestfs_h *g;\n";
6904 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
6906 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6912 | String n | FileIn n | FileOut n ->
6913 pr " Check_Type (%sv, T_STRING);\n" n;
6914 pr " const char *%s = StringValueCStr (%sv);\n" n n;
6916 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6917 pr " \"%s\", \"%s\");\n" n name
6919 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6921 pr " char **%s;\n" n;
6922 pr " Check_Type (%sv, T_ARRAY);\n" n;
6924 pr " int i, len;\n";
6925 pr " len = RARRAY_LEN (%sv);\n" n;
6926 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6928 pr " for (i = 0; i < len; ++i) {\n";
6929 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
6930 pr " %s[i] = StringValueCStr (v);\n" n;
6932 pr " %s[len] = NULL;\n" n;
6935 pr " int %s = RTEST (%sv);\n" n n
6937 pr " int %s = NUM2INT (%sv);\n" n n
6942 match fst style with
6943 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6944 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6945 | RConstString _ -> pr " const char *r;\n"; "NULL"
6946 | RString _ -> pr " char *r;\n"; "NULL"
6947 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6948 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
6949 | RStructList (_, typ) ->
6950 pr " struct guestfs_%s_list *r;\n" typ; "NULL" in
6953 pr " r = guestfs_%s " name;
6954 generate_call_args ~handle:"g" (snd style);
6959 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6961 pr " free (%s);\n" n
6964 pr " if (r == %s)\n" error_code;
6965 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6968 (match fst style with
6970 pr " return Qnil;\n"
6971 | RInt _ | RBool _ ->
6972 pr " return INT2NUM (r);\n"
6974 pr " return ULL2NUM (r);\n"
6976 pr " return rb_str_new2 (r);\n";
6978 pr " VALUE rv = rb_str_new2 (r);\n";
6982 pr " int i, len = 0;\n";
6983 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
6984 pr " VALUE rv = rb_ary_new2 (len);\n";
6985 pr " for (i = 0; r[i] != NULL; ++i) {\n";
6986 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6987 pr " free (r[i]);\n";
6991 | RStruct (_, typ) ->
6992 let cols = cols_of_struct typ in
6993 generate_ruby_struct_code typ cols
6994 | RStructList (_, typ) ->
6995 let cols = cols_of_struct typ in
6996 generate_ruby_struct_list_code typ cols
6998 pr " VALUE rv = rb_hash_new ();\n";
7000 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7001 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7002 pr " free (r[i]);\n";
7003 pr " free (r[i+1]);\n";
7014 /* Initialize the module. */
7015 void Init__guestfs ()
7017 m_guestfs = rb_define_module (\"Guestfs\");
7018 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7019 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7021 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7022 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7025 (* Define the rest of the methods. *)
7027 fun (name, style, _, _, _, _, _) ->
7028 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7029 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7034 (* Ruby code to return a struct. *)
7035 and generate_ruby_struct_code typ cols =
7036 pr " VALUE rv = rb_hash_new ();\n";
7040 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7042 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7043 | name, (FBytes|FUInt64) ->
7044 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7046 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7048 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7050 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7051 | name, FOptPercent ->
7052 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7053 | name, FChar -> (* XXX wrong? *)
7054 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7056 pr " guestfs_free_%s (r);\n" typ;
7059 (* Ruby code to return a struct list. *)
7060 and generate_ruby_struct_list_code typ cols =
7061 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7063 pr " for (i = 0; i < r->len; ++i) {\n";
7064 pr " VALUE hv = rb_hash_new ();\n";
7068 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7070 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7071 | name, (FBytes|FUInt64) ->
7072 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7074 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7076 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7078 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7079 | name, FOptPercent ->
7080 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7081 | name, FChar -> (* XXX wrong? *)
7082 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7084 pr " rb_ary_push (rv, hv);\n";
7086 pr " guestfs_free_%s_list (r);\n" typ;
7089 (* Generate Java bindings GuestFS.java file. *)
7090 and generate_java_java () =
7091 generate_header CStyle LGPLv2;
7094 package com.redhat.et.libguestfs;
7096 import java.util.HashMap;
7097 import com.redhat.et.libguestfs.LibGuestFSException;
7098 import com.redhat.et.libguestfs.PV;
7099 import com.redhat.et.libguestfs.VG;
7100 import com.redhat.et.libguestfs.LV;
7101 import com.redhat.et.libguestfs.Stat;
7102 import com.redhat.et.libguestfs.StatVFS;
7103 import com.redhat.et.libguestfs.IntBool;
7104 import com.redhat.et.libguestfs.Dirent;
7107 * The GuestFS object is a libguestfs handle.
7111 public class GuestFS {
7112 // Load the native code.
7114 System.loadLibrary (\"guestfs_jni\");
7118 * The native guestfs_h pointer.
7123 * Create a libguestfs handle.
7125 * @throws LibGuestFSException
7127 public GuestFS () throws LibGuestFSException
7131 private native long _create () throws LibGuestFSException;
7134 * Close a libguestfs handle.
7136 * You can also leave handles to be collected by the garbage
7137 * collector, but this method ensures that the resources used
7138 * by the handle are freed up immediately. If you call any
7139 * other methods after closing the handle, you will get an
7142 * @throws LibGuestFSException
7144 public void close () throws LibGuestFSException
7150 private native void _close (long g) throws LibGuestFSException;
7152 public void finalize () throws LibGuestFSException
7160 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7161 if not (List.mem NotInDocs flags); then (
7162 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7164 if List.mem ProtocolLimitWarning flags then
7165 doc ^ "\n\n" ^ protocol_limit_warning
7168 if List.mem DangerWillRobinson flags then
7169 doc ^ "\n\n" ^ danger_will_robinson
7171 let doc = pod2text ~width:60 name doc in
7172 let doc = List.map ( (* RHBZ#501883 *)
7175 | nonempty -> nonempty
7177 let doc = String.concat "\n * " doc in
7180 pr " * %s\n" shortdesc;
7183 pr " * @throws LibGuestFSException\n";
7187 generate_java_prototype ~public:true ~semicolon:false name style;
7190 pr " if (g == 0)\n";
7191 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
7194 if fst style <> RErr then pr "return ";
7196 generate_call_args ~handle:"g" (snd style);
7200 generate_java_prototype ~privat:true ~native:true name style;
7207 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
7208 ?(semicolon=true) name style =
7209 if privat then pr "private ";
7210 if public then pr "public ";
7211 if native then pr "native ";
7214 (match fst style with
7215 | RErr -> pr "void ";
7216 | RInt _ -> pr "int ";
7217 | RInt64 _ -> pr "long ";
7218 | RBool _ -> pr "boolean ";
7219 | RConstString _ | RString _ -> pr "String ";
7220 | RStringList _ -> pr "String[] ";
7221 | RStruct (_, typ) ->
7222 let name = java_name_of_struct typ in
7224 | RStructList (_, typ) ->
7225 let name = java_name_of_struct typ in
7227 | RHashtable _ -> pr "HashMap<String,String> ";
7230 if native then pr "_%s " name else pr "%s " name;
7232 let needs_comma = ref false in
7241 if !needs_comma then pr ", ";
7242 needs_comma := true;
7259 pr " throws LibGuestFSException";
7260 if semicolon then pr ";"
7262 and generate_java_struct jtyp cols =
7263 generate_header CStyle LGPLv2;
7266 package com.redhat.et.libguestfs;
7269 * Libguestfs %s structure.
7280 | name, FUUID -> pr " public String %s;\n" name
7281 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
7282 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
7283 | name, FChar -> pr " public char %s;\n" name
7284 | name, FOptPercent ->
7285 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
7286 pr " public float %s;\n" name
7291 and generate_java_c () =
7292 generate_header CStyle LGPLv2;
7299 #include \"com_redhat_et_libguestfs_GuestFS.h\"
7300 #include \"guestfs.h\"
7302 /* Note that this function returns. The exception is not thrown
7303 * until after the wrapper function returns.
7306 throw_exception (JNIEnv *env, const char *msg)
7309 cl = (*env)->FindClass (env,
7310 \"com/redhat/et/libguestfs/LibGuestFSException\");
7311 (*env)->ThrowNew (env, cl, msg);
7314 JNIEXPORT jlong JNICALL
7315 Java_com_redhat_et_libguestfs_GuestFS__1create
7316 (JNIEnv *env, jobject obj)
7320 g = guestfs_create ();
7322 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
7325 guestfs_set_error_handler (g, NULL, NULL);
7326 return (jlong) (long) g;
7329 JNIEXPORT void JNICALL
7330 Java_com_redhat_et_libguestfs_GuestFS__1close
7331 (JNIEnv *env, jobject obj, jlong jg)
7333 guestfs_h *g = (guestfs_h *) (long) jg;
7340 fun (name, style, _, _, _, _, _) ->
7342 (match fst style with
7343 | RErr -> pr "void ";
7344 | RInt _ -> pr "jint ";
7345 | RInt64 _ -> pr "jlong ";
7346 | RBool _ -> pr "jboolean ";
7347 | RConstString _ | RString _ -> pr "jstring ";
7348 | RStruct _ | RHashtable _ ->
7350 | RStringList _ | RStructList _ ->
7354 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7355 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7357 pr " (JNIEnv *env, jobject obj, jlong jg";
7364 pr ", jstring j%s" n
7366 pr ", jobjectArray j%s" n
7368 pr ", jboolean j%s" n
7374 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7375 let error_code, no_ret =
7376 match fst style with
7377 | RErr -> pr " int r;\n"; "-1", ""
7379 | RInt _ -> pr " int r;\n"; "-1", "0"
7380 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7381 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7383 pr " jstring jr;\n";
7384 pr " char *r;\n"; "NULL", "NULL"
7386 pr " jobjectArray jr;\n";
7389 pr " jstring jstr;\n";
7390 pr " char **r;\n"; "NULL", "NULL"
7391 | RStruct (_, typ) ->
7392 pr " jobject jr;\n";
7394 pr " jfieldID fl;\n";
7395 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
7396 | RStructList (_, typ) ->
7397 pr " jobjectArray jr;\n";
7399 pr " jfieldID fl;\n";
7400 pr " jobject jfl;\n";
7401 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
7402 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL" in
7409 pr " const char *%s;\n" n
7411 pr " int %s_len;\n" n;
7412 pr " const char **%s;\n" n
7419 (match fst style with
7420 | RStringList _ | RStructList _ -> true
7421 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7422 | RString _ | RStruct _ | RHashtable _ -> false) ||
7423 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7429 (* Get the parameters. *)
7435 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7437 (* This is completely undocumented, but Java null becomes
7440 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
7442 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
7443 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
7444 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7445 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7447 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
7449 pr " %s[%s_len] = NULL;\n" n n;
7452 pr " %s = j%s;\n" n n
7455 (* Make the call. *)
7456 pr " r = guestfs_%s " name;
7457 generate_call_args ~handle:"g" (snd style);
7460 (* Release the parameters. *)
7466 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7469 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7471 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7472 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7474 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7476 pr " free (%s);\n" n
7481 (* Check for errors. *)
7482 pr " if (r == %s) {\n" error_code;
7483 pr " throw_exception (env, guestfs_last_error (g));\n";
7484 pr " return %s;\n" no_ret;
7488 (match fst style with
7490 | RInt _ -> pr " return (jint) r;\n"
7491 | RBool _ -> pr " return (jboolean) r;\n"
7492 | RInt64 _ -> pr " return (jlong) r;\n"
7493 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7495 pr " jr = (*env)->NewStringUTF (env, r);\n";
7499 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7500 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7501 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7502 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7503 pr " for (i = 0; i < r_len; ++i) {\n";
7504 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7505 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7506 pr " free (r[i]);\n";
7510 | RStruct (_, typ) ->
7511 let jtyp = java_name_of_struct typ in
7512 let cols = cols_of_struct typ in
7513 generate_java_struct_return typ jtyp cols
7514 | RStructList (_, typ) ->
7515 let jtyp = java_name_of_struct typ in
7516 let cols = cols_of_struct typ in
7517 generate_java_struct_list_return typ jtyp cols
7520 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7521 pr " return NULL;\n"
7528 and generate_java_struct_return typ jtyp cols =
7529 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7530 pr " jr = (*env)->AllocObject (env, cl);\n";
7534 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7535 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
7538 pr " char s[33];\n";
7539 pr " memcpy (s, r->%s, 32);\n" name;
7541 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7542 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
7544 | name, (FBytes|FUInt64|FInt64) ->
7545 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7546 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7547 | name, (FUInt32|FInt32) ->
7548 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
7549 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7550 | name, FOptPercent ->
7551 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7552 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
7554 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
7555 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7560 and generate_java_struct_list_return typ jtyp cols =
7561 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7562 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7563 pr " for (i = 0; i < r->len; ++i) {\n";
7564 pr " jfl = (*env)->AllocObject (env, cl);\n";
7568 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7569 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7572 pr " char s[33];\n";
7573 pr " memcpy (s, r->val[i].%s, 32);\n" name;
7575 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7576 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7578 | name, (FBytes|FUInt64|FInt64) ->
7579 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7580 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7581 | name, (FUInt32|FInt32) ->
7582 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
7583 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7584 | name, FOptPercent ->
7585 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7586 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7588 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
7589 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7591 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7593 pr " guestfs_free_%s_list (r);\n" typ;
7596 and generate_haskell_hs () =
7597 generate_header HaskellStyle LGPLv2;
7599 (* XXX We only know how to generate partial FFI for Haskell
7600 * at the moment. Please help out!
7602 let can_generate style =
7606 | RInt64 _, _ -> true
7613 | RHashtable _, _ -> false in
7616 {-# INCLUDE <guestfs.h> #-}
7617 {-# LANGUAGE ForeignFunctionInterface #-}
7622 (* List out the names of the actions we want to export. *)
7624 fun (name, style, _, _, _, _, _) ->
7625 if can_generate style then pr ",\n %s" name
7632 import Foreign.C.Types
7634 import Control.Exception
7635 import Data.Typeable
7637 data GuestfsS = GuestfsS -- represents the opaque C struct
7638 type GuestfsP = Ptr GuestfsS -- guestfs_h *
7639 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7641 -- XXX define properly later XXX
7645 data IntBool = IntBool
7647 data StatVFS = StatVFS
7648 data Hashtable = Hashtable
7650 foreign import ccall unsafe \"guestfs_create\" c_create
7652 foreign import ccall unsafe \"&guestfs_close\" c_close
7653 :: FunPtr (GuestfsP -> IO ())
7654 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7655 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7657 create :: IO GuestfsH
7660 c_set_error_handler p nullPtr nullPtr
7661 h <- newForeignPtr c_close p
7664 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7665 :: GuestfsP -> IO CString
7667 -- last_error :: GuestfsH -> IO (Maybe String)
7668 -- last_error h = do
7669 -- str <- withForeignPtr h (\\p -> c_last_error p)
7670 -- maybePeek peekCString str
7672 last_error :: GuestfsH -> IO (String)
7674 str <- withForeignPtr h (\\p -> c_last_error p)
7676 then return \"no error\"
7677 else peekCString str
7681 (* Generate wrappers for each foreign function. *)
7683 fun (name, style, _, _, _, _, _) ->
7684 if can_generate style then (
7685 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7687 generate_haskell_prototype ~handle:"GuestfsP" style;
7691 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7693 pr "%s %s = do\n" name
7694 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7696 (* Convert pointer arguments using with* functions. *)
7701 | String n -> pr "withCString %s $ \\%s -> " n n
7702 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7703 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7704 | Bool _ | Int _ -> ()
7706 (* Convert integer arguments. *)
7710 | Bool n -> sprintf "(fromBool %s)" n
7711 | Int n -> sprintf "(fromIntegral %s)" n
7712 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
7714 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7715 (String.concat " " ("p" :: args));
7716 (match fst style with
7717 | RErr | RInt _ | RInt64 _ | RBool _ ->
7718 pr " if (r == -1)\n";
7720 pr " err <- last_error h\n";
7722 | RConstString _ | RString _ | RStringList _ | RStruct _
7723 | RStructList _ | RHashtable _ ->
7724 pr " if (r == nullPtr)\n";
7726 pr " err <- last_error h\n";
7729 (match fst style with
7731 pr " else return ()\n"
7733 pr " else return (fromIntegral r)\n"
7735 pr " else return (fromIntegral r)\n"
7737 pr " else return (toBool r)\n"
7744 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7750 and generate_haskell_prototype ~handle ?(hs = false) style =
7752 let string = if hs then "String" else "CString" in
7753 let int = if hs then "Int" else "CInt" in
7754 let bool = if hs then "Bool" else "CInt" in
7755 let int64 = if hs then "Integer" else "Int64" in
7759 | String _ -> pr "%s" string
7760 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7761 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7762 | Bool _ -> pr "%s" bool
7763 | Int _ -> pr "%s" int
7764 | FileIn _ -> pr "%s" string
7765 | FileOut _ -> pr "%s" string
7770 (match fst style with
7771 | RErr -> if not hs then pr "CInt"
7772 | RInt _ -> pr "%s" int
7773 | RInt64 _ -> pr "%s" int64
7774 | RBool _ -> pr "%s" bool
7775 | RConstString _ -> pr "%s" string
7776 | RString _ -> pr "%s" string
7777 | RStringList _ -> pr "[%s]" string
7778 | RStruct (_, typ) ->
7779 let name = java_name_of_struct typ in
7781 | RStructList (_, typ) ->
7782 let name = java_name_of_struct typ in
7784 | RHashtable _ -> pr "Hashtable"
7788 and generate_bindtests () =
7789 generate_header CStyle LGPLv2;
7794 #include <inttypes.h>
7797 #include \"guestfs.h\"
7798 #include \"guestfs_protocol.h\"
7800 #define error guestfs_error
7801 #define safe_calloc guestfs_safe_calloc
7802 #define safe_malloc guestfs_safe_malloc
7805 print_strings (char * const* const argv)
7810 for (argc = 0; argv[argc] != NULL; ++argc) {
7811 if (argc > 0) printf (\", \");
7812 printf (\"\\\"%%s\\\"\", argv[argc]);
7817 /* The test0 function prints its parameters to stdout. */
7821 match test_functions with
7822 | [] -> assert false
7823 | test0 :: tests -> test0, tests in
7826 let (name, style, _, _, _, _, _) = test0 in
7827 generate_prototype ~extern:false ~semicolon:false ~newline:true
7828 ~handle:"g" ~prefix:"guestfs_" name style;
7834 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
7835 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7836 | StringList n -> pr " print_strings (%s);\n" n
7837 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7838 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
7840 pr " /* Java changes stdout line buffering so we need this: */\n";
7841 pr " fflush (stdout);\n";
7847 fun (name, style, _, _, _, _, _) ->
7848 if String.sub name (String.length name - 3) 3 <> "err" then (
7849 pr "/* Test normal return. */\n";
7850 generate_prototype ~extern:false ~semicolon:false ~newline:true
7851 ~handle:"g" ~prefix:"guestfs_" name style;
7853 (match fst style with
7858 pr " sscanf (val, \"%%d\", &r);\n";
7862 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
7865 pr " return strcmp (val, \"true\") == 0;\n"
7867 (* Can't return the input string here. Return a static
7868 * string so we ensure we get a segfault if the caller
7871 pr " return \"static string\";\n"
7873 pr " return strdup (val);\n"
7875 pr " char **strs;\n";
7877 pr " sscanf (val, \"%%d\", &n);\n";
7878 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
7879 pr " for (i = 0; i < n; ++i) {\n";
7880 pr " strs[i] = safe_malloc (g, 16);\n";
7881 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
7883 pr " strs[n] = NULL;\n";
7884 pr " return strs;\n"
7885 | RStruct (_, typ) ->
7886 pr " struct guestfs_%s *r;\n" typ;
7887 pr " r = safe_calloc (g, sizeof *r, 1);\n";
7889 | RStructList (_, typ) ->
7890 pr " struct guestfs_%s_list *r;\n" typ;
7891 pr " r = safe_calloc (g, sizeof *r, 1);\n";
7892 pr " sscanf (val, \"%%d\", &r->len);\n";
7893 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
7896 pr " char **strs;\n";
7898 pr " sscanf (val, \"%%d\", &n);\n";
7899 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
7900 pr " for (i = 0; i < n; ++i) {\n";
7901 pr " strs[i*2] = safe_malloc (g, 16);\n";
7902 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
7903 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
7904 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7906 pr " strs[n*2] = NULL;\n";
7907 pr " return strs;\n"
7912 pr "/* Test error return. */\n";
7913 generate_prototype ~extern:false ~semicolon:false ~newline:true
7914 ~handle:"g" ~prefix:"guestfs_" name style;
7916 pr " error (g, \"error\");\n";
7917 (match fst style with
7918 | RErr | RInt _ | RInt64 _ | RBool _ ->
7921 | RString _ | RStringList _ | RStruct _
7924 pr " return NULL;\n"
7931 and generate_ocaml_bindtests () =
7932 generate_header OCamlStyle GPLv2;
7936 let g = Guestfs.create () in
7943 | CallString s -> "\"" ^ s ^ "\""
7944 | CallOptString None -> "None"
7945 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7946 | CallStringList xs ->
7947 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7948 | CallInt i when i >= 0 -> string_of_int i
7949 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7950 | CallBool b -> string_of_bool b
7955 generate_lang_bindtests (
7956 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
7959 pr "print_endline \"EOF\"\n"
7961 and generate_perl_bindtests () =
7962 pr "#!/usr/bin/perl -w\n";
7963 generate_header HashStyle GPLv2;
7970 my $g = Sys::Guestfs->new ();
7974 String.concat ", " (
7977 | CallString s -> "\"" ^ s ^ "\""
7978 | CallOptString None -> "undef"
7979 | CallOptString (Some s) -> sprintf "\"%s\"" s
7980 | CallStringList xs ->
7981 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7982 | CallInt i -> string_of_int i
7983 | CallBool b -> if b then "1" else "0"
7988 generate_lang_bindtests (
7989 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7992 pr "print \"EOF\\n\"\n"
7994 and generate_python_bindtests () =
7995 generate_header HashStyle GPLv2;
8000 g = guestfs.GuestFS ()
8004 String.concat ", " (
8007 | CallString s -> "\"" ^ s ^ "\""
8008 | CallOptString None -> "None"
8009 | CallOptString (Some s) -> sprintf "\"%s\"" s
8010 | CallStringList xs ->
8011 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8012 | CallInt i -> string_of_int i
8013 | CallBool b -> if b then "1" else "0"
8018 generate_lang_bindtests (
8019 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8022 pr "print \"EOF\"\n"
8024 and generate_ruby_bindtests () =
8025 generate_header HashStyle GPLv2;
8030 g = Guestfs::create()
8034 String.concat ", " (
8037 | CallString s -> "\"" ^ s ^ "\""
8038 | CallOptString None -> "nil"
8039 | CallOptString (Some s) -> sprintf "\"%s\"" s
8040 | CallStringList xs ->
8041 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8042 | CallInt i -> string_of_int i
8043 | CallBool b -> string_of_bool b
8048 generate_lang_bindtests (
8049 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8052 pr "print \"EOF\\n\"\n"
8054 and generate_java_bindtests () =
8055 generate_header CStyle GPLv2;
8058 import com.redhat.et.libguestfs.*;
8060 public class Bindtests {
8061 public static void main (String[] argv)
8064 GuestFS g = new GuestFS ();
8068 String.concat ", " (
8071 | CallString s -> "\"" ^ s ^ "\""
8072 | CallOptString None -> "null"
8073 | CallOptString (Some s) -> sprintf "\"%s\"" s
8074 | CallStringList xs ->
8076 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8077 | CallInt i -> string_of_int i
8078 | CallBool b -> string_of_bool b
8083 generate_lang_bindtests (
8084 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8088 System.out.println (\"EOF\");
8090 catch (Exception exn) {
8091 System.err.println (exn);
8098 and generate_haskell_bindtests () =
8099 generate_header HaskellStyle GPLv2;
8102 module Bindtests where
8103 import qualified Guestfs
8113 | CallString s -> "\"" ^ s ^ "\""
8114 | CallOptString None -> "Nothing"
8115 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
8116 | CallStringList xs ->
8117 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8118 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
8119 | CallInt i -> string_of_int i
8120 | CallBool true -> "True"
8121 | CallBool false -> "False"
8126 generate_lang_bindtests (
8127 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
8130 pr " putStrLn \"EOF\"\n"
8132 (* Language-independent bindings tests - we do it this way to
8133 * ensure there is parity in testing bindings across all languages.
8135 and generate_lang_bindtests call =
8136 call "test0" [CallString "abc"; CallOptString (Some "def");
8137 CallStringList []; CallBool false;
8138 CallInt 0; CallString "123"; CallString "456"];
8139 call "test0" [CallString "abc"; CallOptString None;
8140 CallStringList []; CallBool false;
8141 CallInt 0; CallString "123"; CallString "456"];
8142 call "test0" [CallString ""; CallOptString (Some "def");
8143 CallStringList []; CallBool false;
8144 CallInt 0; CallString "123"; CallString "456"];
8145 call "test0" [CallString ""; CallOptString (Some "");
8146 CallStringList []; CallBool false;
8147 CallInt 0; CallString "123"; CallString "456"];
8148 call "test0" [CallString "abc"; CallOptString (Some "def");
8149 CallStringList ["1"]; CallBool false;
8150 CallInt 0; CallString "123"; CallString "456"];
8151 call "test0" [CallString "abc"; CallOptString (Some "def");
8152 CallStringList ["1"; "2"]; CallBool false;
8153 CallInt 0; CallString "123"; CallString "456"];
8154 call "test0" [CallString "abc"; CallOptString (Some "def");
8155 CallStringList ["1"]; CallBool true;
8156 CallInt 0; CallString "123"; CallString "456"];
8157 call "test0" [CallString "abc"; CallOptString (Some "def");
8158 CallStringList ["1"]; CallBool false;
8159 CallInt (-1); CallString "123"; CallString "456"];
8160 call "test0" [CallString "abc"; CallOptString (Some "def");
8161 CallStringList ["1"]; CallBool false;
8162 CallInt (-2); CallString "123"; CallString "456"];
8163 call "test0" [CallString "abc"; CallOptString (Some "def");
8164 CallStringList ["1"]; CallBool false;
8165 CallInt 1; CallString "123"; CallString "456"];
8166 call "test0" [CallString "abc"; CallOptString (Some "def");
8167 CallStringList ["1"]; CallBool false;
8168 CallInt 2; CallString "123"; CallString "456"];
8169 call "test0" [CallString "abc"; CallOptString (Some "def");
8170 CallStringList ["1"]; CallBool false;
8171 CallInt 4095; CallString "123"; CallString "456"];
8172 call "test0" [CallString "abc"; CallOptString (Some "def");
8173 CallStringList ["1"]; CallBool false;
8174 CallInt 0; CallString ""; CallString ""]
8176 (* XXX Add here tests of the return and error functions. *)
8178 (* This is used to generate the src/MAX_PROC_NR file which
8179 * contains the maximum procedure number, a surrogate for the
8180 * ABI version number. See src/Makefile.am for the details.
8182 and generate_max_proc_nr () =
8183 let proc_nrs = List.map (
8184 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
8185 ) daemon_functions in
8187 let max_proc_nr = List.fold_left max 0 proc_nrs in
8189 pr "%d\n" max_proc_nr
8191 let output_to filename =
8192 let filename_new = filename ^ ".new" in
8193 chan := open_out filename_new;
8198 (* Is the new file different from the current file? *)
8199 if Sys.file_exists filename && files_equal filename filename_new then
8200 Unix.unlink filename_new (* same, so skip it *)
8202 (* different, overwrite old one *)
8203 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
8204 Unix.rename filename_new filename;
8205 Unix.chmod filename 0o444;
8206 printf "written %s\n%!" filename;
8215 if not (Sys.file_exists "HACKING") then (
8217 You are probably running this from the wrong directory.
8218 Run it from the top source directory using the command
8224 let close = output_to "src/guestfs_protocol.x" in
8228 let close = output_to "src/guestfs-structs.h" in
8229 generate_structs_h ();
8232 let close = output_to "src/guestfs-actions.h" in
8233 generate_actions_h ();
8236 let close = output_to "src/guestfs-actions.c" in
8237 generate_client_actions ();
8240 let close = output_to "daemon/actions.h" in
8241 generate_daemon_actions_h ();
8244 let close = output_to "daemon/stubs.c" in
8245 generate_daemon_actions ();
8248 let close = output_to "daemon/names.c" in
8249 generate_daemon_names ();
8252 let close = output_to "capitests/tests.c" in
8256 let close = output_to "src/guestfs-bindtests.c" in
8257 generate_bindtests ();
8260 let close = output_to "fish/cmds.c" in
8261 generate_fish_cmds ();
8264 let close = output_to "fish/completion.c" in
8265 generate_fish_completion ();
8268 let close = output_to "guestfs-structs.pod" in
8269 generate_structs_pod ();
8272 let close = output_to "guestfs-actions.pod" in
8273 generate_actions_pod ();
8276 let close = output_to "guestfish-actions.pod" in
8277 generate_fish_actions_pod ();
8280 let close = output_to "ocaml/guestfs.mli" in
8281 generate_ocaml_mli ();
8284 let close = output_to "ocaml/guestfs.ml" in
8285 generate_ocaml_ml ();
8288 let close = output_to "ocaml/guestfs_c_actions.c" in
8289 generate_ocaml_c ();
8292 let close = output_to "ocaml/bindtests.ml" in
8293 generate_ocaml_bindtests ();
8296 let close = output_to "perl/Guestfs.xs" in
8297 generate_perl_xs ();
8300 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8301 generate_perl_pm ();
8304 let close = output_to "perl/bindtests.pl" in
8305 generate_perl_bindtests ();
8308 let close = output_to "python/guestfs-py.c" in
8309 generate_python_c ();
8312 let close = output_to "python/guestfs.py" in
8313 generate_python_py ();
8316 let close = output_to "python/bindtests.py" in
8317 generate_python_bindtests ();
8320 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8324 let close = output_to "ruby/bindtests.rb" in
8325 generate_ruby_bindtests ();
8328 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8329 generate_java_java ();
8334 let cols = cols_of_struct typ in
8335 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
8336 let close = output_to filename in
8337 generate_java_struct jtyp cols;
8341 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8345 let close = output_to "java/Bindtests.java" in
8346 generate_java_bindtests ();
8349 let close = output_to "haskell/Guestfs.hs" in
8350 generate_haskell_hs ();
8353 let close = output_to "haskell/Bindtests.hs" in
8354 generate_haskell_bindtests ();
8357 let close = output_to "src/MAX_PROC_NR" in
8358 generate_max_proc_nr ();
8361 (* Always generate this file last, and unconditionally. It's used
8362 * by the Makefile to know when we must re-run the generator.
8364 let chan = open_out "src/stamp-generator" in