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 all the
28 * output files. Note that if you are using a separate build directory you
29 * must run generator.ml from the _source_ directory.
31 * IMPORTANT: This script should NOT print any warnings. If it prints
32 * warnings, you should treat them as errors.
33 * [Need to add -warn-error to ocaml command line]
41 type style = ret * args
43 (* "RErr" as a return value means an int used as a simple error
44 * indication, ie. 0 or -1.
48 (* "RInt" as a return value means an int which is -1 for error
49 * or any value >= 0 on success. Only use this for smallish
50 * positive ints (0 <= i < 2^30).
54 (* "RInt64" is the same as RInt, but is guaranteed to be able
55 * to return a full 64 bit value, _except_ that -1 means error
56 * (so -1 cannot be a valid, non-error return value).
60 (* "RBool" is a bool return value which can be true/false or
65 (* "RConstString" is a string that refers to a constant value.
66 * The return value must NOT be NULL (since NULL indicates
69 * Try to avoid using this. In particular you cannot use this
70 * for values returned from the daemon, because there is no
71 * thread-safe way to return them in the C API.
73 | RConstString of string
75 (* "RConstOptString" is an even more broken version of
76 * "RConstString". The returned string may be NULL and there
77 * is no way to return an error indication. Avoid using this!
79 | RConstOptString of string
81 (* "RString" is a returned string. It must NOT be NULL, since
82 * a NULL return indicates an error. The caller frees this.
86 (* "RStringList" is a list of strings. No string in the list
87 * can be NULL. The caller frees the strings and the array.
89 | RStringList of string
91 (* "RStruct" is a function which returns a single named structure
92 * or an error indication (in C, a struct, and in other languages
93 * with varying representations, but usually very efficient). See
94 * after the function list below for the structures.
96 | RStruct of string * string (* name of retval, name of struct *)
98 (* "RStructList" is a function which returns either a list/array
99 * of structures (could be zero-length), or an error indication.
101 | RStructList of string * string (* name of retval, name of struct *)
103 (* Key-value pairs of untyped strings. Turns into a hashtable or
104 * dictionary in languages which support it. DON'T use this as a
105 * general "bucket" for results. Prefer a stronger typed return
106 * value if one is available, or write a custom struct. Don't use
107 * this if the list could potentially be very long, since it is
108 * inefficient. Keys should be unique. NULLs are not permitted.
110 | RHashtable of string
112 (* "RBufferOut" is handled almost exactly like RString, but
113 * it allows the string to contain arbitrary 8 bit data including
114 * ASCII NUL. In the C API this causes an implicit extra parameter
115 * to be added of type <size_t *size_r>. The extra parameter
116 * returns the actual size of the return buffer in bytes.
118 * Other programming languages support strings with arbitrary 8 bit
121 * At the RPC layer we have to use the opaque<> type instead of
122 * string<>. Returned data is still limited to the max message
125 | RBufferOut of string
127 and args = argt list (* Function parameters, guestfs handle is implicit. *)
129 (* Note in future we should allow a "variable args" parameter as
130 * the final parameter, to allow commands like
131 * chmod mode file [file(s)...]
132 * This is not implemented yet, but many commands (such as chmod)
133 * are currently defined with the argument order keeping this future
134 * possibility in mind.
137 | String of string (* const char *name, cannot be NULL *)
138 | OptString of string (* const char *name, may be NULL *)
139 | StringList of string(* list of strings (each string cannot be NULL) *)
140 | Bool of string (* boolean *)
141 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
142 (* These are treated as filenames (simple string parameters) in
143 * the C API and bindings. But in the RPC protocol, we transfer
144 * the actual file content up to or down from the daemon.
145 * FileIn: local machine -> daemon (in request)
146 * FileOut: daemon -> local machine (in reply)
147 * In guestfish (only), the special name "-" means read from
148 * stdin or write to stdout.
153 (* Opaque buffer which can contain arbitrary 8 bit data.
154 * In the C API, this is expressed as <char *, int> pair.
155 * Most other languages have a string type which can contain
156 * ASCII NUL. We use whatever type is appropriate for each
158 * Buffers are limited by the total message size. To transfer
159 * large blocks of data, use FileIn/FileOut parameters instead.
160 * To return an arbitrary buffer, use RBufferOut.
166 | ProtocolLimitWarning (* display warning about protocol size limits *)
167 | DangerWillRobinson (* flags particularly dangerous commands *)
168 | FishAlias of string (* provide an alias for this cmd in guestfish *)
169 | FishAction of string (* call this function in guestfish *)
170 | NotInFish (* do not export via guestfish *)
171 | NotInDocs (* do not add this function to documentation *)
173 let protocol_limit_warning =
174 "Because of the message protocol, there is a transfer limit
175 of somewhere between 2MB and 4MB. To transfer large files you should use
178 let danger_will_robinson =
179 "B<This command is dangerous. Without careful use you
180 can easily destroy all your data>."
182 (* You can supply zero or as many tests as you want per API call.
184 * Note that the test environment has 3 block devices, of size 500MB,
185 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
186 * a fourth squashfs block device with some known files on it (/dev/sdd).
188 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
189 * Number of cylinders was 63 for IDE emulated disks with precisely
190 * the same size. How exactly this is calculated is a mystery.
192 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
194 * To be able to run the tests in a reasonable amount of time,
195 * the virtual machine and block devices are reused between tests.
196 * So don't try testing kill_subprocess :-x
198 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
200 * Don't assume anything about the previous contents of the block
201 * devices. Use 'Init*' to create some initial scenarios.
203 * You can add a prerequisite clause to any individual test. This
204 * is a run-time check, which, if it fails, causes the test to be
205 * skipped. Useful if testing a command which might not work on
206 * all variations of libguestfs builds. A test that has prerequisite
207 * of 'Always' is run unconditionally.
209 * In addition, packagers can skip individual tests by setting the
210 * environment variables: eg:
211 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
212 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
214 type tests = (test_init * test_prereq * test) list
216 (* Run the command sequence and just expect nothing to fail. *)
218 (* Run the command sequence and expect the output of the final
219 * command to be the string.
221 | TestOutput of seq * string
222 (* Run the command sequence and expect the output of the final
223 * command to be the list of strings.
225 | TestOutputList of seq * string list
226 (* Run the command sequence and expect the output of the final
227 * command to be the list of block devices (could be either
228 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
229 * character of each string).
231 | TestOutputListOfDevices of seq * string list
232 (* Run the command sequence and expect the output of the final
233 * command to be the integer.
235 | TestOutputInt of seq * int
236 (* Run the command sequence and expect the output of the final
237 * command to be <op> <int>, eg. ">=", "1".
239 | TestOutputIntOp of seq * string * int
240 (* Run the command sequence and expect the output of the final
241 * command to be a true value (!= 0 or != NULL).
243 | TestOutputTrue of seq
244 (* Run the command sequence and expect the output of the final
245 * command to be a false value (== 0 or == NULL, but not an error).
247 | TestOutputFalse of seq
248 (* Run the command sequence and expect the output of the final
249 * command to be a list of the given length (but don't care about
252 | TestOutputLength of seq * int
253 (* Run the command sequence and expect the output of the final
254 * command to be a structure.
256 | TestOutputStruct of seq * test_field_compare list
257 (* Run the command sequence and expect the final command (only)
260 | TestLastFail of seq
262 and test_field_compare =
263 | CompareWithInt of string * int
264 | CompareWithIntOp of string * string * int
265 | CompareWithString of string * string
266 | CompareFieldsIntEq of string * string
267 | CompareFieldsStrEq of string * string
269 (* Test prerequisites. *)
271 (* Test always runs. *)
273 (* Test is currently disabled - eg. it fails, or it tests some
274 * unimplemented feature.
277 (* 'string' is some C code (a function body) that should return
278 * true or false. The test will run if the code returns true.
281 (* As for 'If' but the test runs _unless_ the code returns true. *)
284 (* Some initial scenarios for testing. *)
286 (* Do nothing, block devices could contain random stuff including
287 * LVM PVs, and some filesystems might be mounted. This is usually
291 (* Block devices are empty and no filesystems are mounted. *)
293 (* /dev/sda contains a single partition /dev/sda1, which is formatted
294 * as ext2, empty [except for lost+found] and mounted on /.
295 * /dev/sdb and /dev/sdc may have random content.
300 * /dev/sda1 (is a PV):
301 * /dev/VG/LV (size 8MB):
302 * formatted as ext2, empty [except for lost+found], mounted on /
303 * /dev/sdb and /dev/sdc may have random content.
307 (* Sequence of commands for testing. *)
309 and cmd = string list
311 (* Note about long descriptions: When referring to another
312 * action, use the format C<guestfs_other> (ie. the full name of
313 * the C function). This will be replaced as appropriate in other
316 * Apart from that, long descriptions are just perldoc paragraphs.
319 (* These test functions are used in the language binding tests. *)
321 let test_all_args = [
324 StringList "strlist";
331 let test_all_rets = [
332 (* except for RErr, which is tested thoroughly elsewhere *)
333 "test0rint", RInt "valout";
334 "test0rint64", RInt64 "valout";
335 "test0rbool", RBool "valout";
336 "test0rconststring", RConstString "valout";
337 "test0rconstoptstring", RConstOptString "valout";
338 "test0rstring", RString "valout";
339 "test0rstringlist", RStringList "valout";
340 "test0rstruct", RStruct ("valout", "lvm_pv");
341 "test0rstructlist", RStructList ("valout", "lvm_pv");
342 "test0rhashtable", RHashtable "valout";
345 let test_functions = [
346 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
348 "internal test function - do not use",
350 This is an internal test function which is used to test whether
351 the automatically generated bindings can handle every possible
352 parameter type correctly.
354 It echos the contents of each parameter to stdout.
356 You probably don't want to call this function.");
360 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
362 "internal test function - do not use",
364 This is an internal test function which is used to test whether
365 the automatically generated bindings can handle every possible
366 return type correctly.
368 It converts string C<val> to the return type.
370 You probably don't want to call this function.");
371 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
373 "internal test function - do not use",
375 This is an internal test function which is used to test whether
376 the automatically generated bindings can handle every possible
377 return type correctly.
379 This function always returns an error.
381 You probably don't want to call this function.")]
385 (* non_daemon_functions are any functions which don't get processed
386 * in the daemon, eg. functions for setting and getting local
387 * configuration values.
390 let non_daemon_functions = test_functions @ [
391 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
393 "launch the qemu subprocess",
395 Internally libguestfs is implemented by running a virtual machine
398 You should call this after configuring the handle
399 (eg. adding drives) but before performing any actions.");
401 ("wait_ready", (RErr, []), -1, [NotInFish],
403 "wait until the qemu subprocess launches",
405 Internally libguestfs is implemented by running a virtual machine
408 You should call this after C<guestfs_launch> to wait for the launch
411 ("kill_subprocess", (RErr, []), -1, [],
413 "kill the qemu subprocess",
415 This kills the qemu subprocess. You should never need to call this.");
417 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
419 "add an image to examine or modify",
421 This function adds a virtual machine disk image C<filename> to the
422 guest. The first time you call this function, the disk appears as IDE
423 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
426 You don't necessarily need to be root when using libguestfs. However
427 you obviously do need sufficient permissions to access the filename
428 for whatever operations you want to perform (ie. read access if you
429 just want to read the image or write access if you want to modify the
432 This is equivalent to the qemu parameter
433 C<-drive file=filename,cache=off,if=...>.
435 Note that this call checks for the existence of C<filename>. This
436 stops you from specifying other types of drive which are supported
437 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
438 the general C<guestfs_config> call instead.");
440 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
442 "add a CD-ROM disk image to examine",
444 This function adds a virtual CD-ROM disk image to the guest.
446 This is equivalent to the qemu parameter C<-cdrom filename>.
448 Note that this call checks for the existence of C<filename>. This
449 stops you from specifying other types of drive which are supported
450 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
451 the general C<guestfs_config> call instead.");
453 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
455 "add a drive in snapshot mode (read-only)",
457 This adds a drive in snapshot mode, making it effectively
460 Note that writes to the device are allowed, and will be seen for
461 the duration of the guestfs handle, but they are written
462 to a temporary file which is discarded as soon as the guestfs
463 handle is closed. We don't currently have any method to enable
464 changes to be committed, although qemu can support this.
466 This is equivalent to the qemu parameter
467 C<-drive file=filename,snapshot=on,if=...>.
469 Note that this call checks for the existence of C<filename>. This
470 stops you from specifying other types of drive which are supported
471 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
472 the general C<guestfs_config> call instead.");
474 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
476 "add qemu parameters",
478 This can be used to add arbitrary qemu command line parameters
479 of the form C<-param value>. Actually it's not quite arbitrary - we
480 prevent you from setting some parameters which would interfere with
481 parameters that we use.
483 The first character of C<param> string must be a C<-> (dash).
485 C<value> can be NULL.");
487 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
489 "set the qemu binary",
491 Set the qemu binary that we will use.
493 The default is chosen when the library was compiled by the
496 You can also override this by setting the C<LIBGUESTFS_QEMU>
497 environment variable.
499 Setting C<qemu> to C<NULL> restores the default qemu binary.");
501 ("get_qemu", (RConstString "qemu", []), -1, [],
502 [InitNone, Always, TestRun (
504 "get the qemu binary",
506 Return the current qemu binary.
508 This is always non-NULL. If it wasn't set already, then this will
509 return the default qemu binary name.");
511 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
513 "set the search path",
515 Set the path that libguestfs searches for kernel and initrd.img.
517 The default is C<$libdir/guestfs> unless overridden by setting
518 C<LIBGUESTFS_PATH> environment variable.
520 Setting C<path> to C<NULL> restores the default path.");
522 ("get_path", (RConstString "path", []), -1, [],
523 [InitNone, Always, TestRun (
525 "get the search path",
527 Return the current search path.
529 This is always non-NULL. If it wasn't set already, then this will
530 return the default path.");
532 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
534 "add options to kernel command line",
536 This function is used to add additional options to the
537 guest kernel command line.
539 The default is C<NULL> unless overridden by setting
540 C<LIBGUESTFS_APPEND> environment variable.
542 Setting C<append> to C<NULL> means I<no> additional options
543 are passed (libguestfs always adds a few of its own).");
545 ("get_append", (RConstOptString "append", []), -1, [],
546 (* This cannot be tested with the current framework. The
547 * function can return NULL in normal operations, which the
548 * test framework interprets as an error.
551 "get the additional kernel options",
553 Return the additional kernel options which are added to the
554 guest kernel command line.
556 If C<NULL> then no options are added.");
558 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
562 If C<autosync> is true, this enables autosync. Libguestfs will make a
563 best effort attempt to run C<guestfs_umount_all> followed by
564 C<guestfs_sync> when the handle is closed
565 (also if the program exits without closing handles).
567 This is disabled by default (except in guestfish where it is
568 enabled by default).");
570 ("get_autosync", (RBool "autosync", []), -1, [],
571 [InitNone, Always, TestRun (
572 [["get_autosync"]])],
575 Get the autosync flag.");
577 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
581 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
583 Verbose messages are disabled unless the environment variable
584 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
586 ("get_verbose", (RBool "verbose", []), -1, [],
590 This returns the verbose messages flag.");
592 ("is_ready", (RBool "ready", []), -1, [],
593 [InitNone, Always, TestOutputTrue (
595 "is ready to accept commands",
597 This returns true iff this handle is ready to accept commands
598 (in the C<READY> state).
600 For more information on states, see L<guestfs(3)>.");
602 ("is_config", (RBool "config", []), -1, [],
603 [InitNone, Always, TestOutputFalse (
605 "is in configuration state",
607 This returns true iff this handle is being configured
608 (in the C<CONFIG> state).
610 For more information on states, see L<guestfs(3)>.");
612 ("is_launching", (RBool "launching", []), -1, [],
613 [InitNone, Always, TestOutputFalse (
614 [["is_launching"]])],
615 "is launching subprocess",
617 This returns true iff this handle is launching the subprocess
618 (in the C<LAUNCHING> state).
620 For more information on states, see L<guestfs(3)>.");
622 ("is_busy", (RBool "busy", []), -1, [],
623 [InitNone, Always, TestOutputFalse (
625 "is busy processing a command",
627 This returns true iff this handle is busy processing a command
628 (in the C<BUSY> state).
630 For more information on states, see L<guestfs(3)>.");
632 ("get_state", (RInt "state", []), -1, [],
634 "get the current state",
636 This returns the current state as an opaque integer. This is
637 only useful for printing debug and internal error messages.
639 For more information on states, see L<guestfs(3)>.");
641 ("set_busy", (RErr, []), -1, [NotInFish],
645 This sets the state to C<BUSY>. This is only used when implementing
646 actions using the low-level API.
648 For more information on states, see L<guestfs(3)>.");
650 ("set_ready", (RErr, []), -1, [NotInFish],
652 "set state to ready",
654 This sets the state to C<READY>. This is only used when implementing
655 actions using the low-level API.
657 For more information on states, see L<guestfs(3)>.");
659 ("end_busy", (RErr, []), -1, [NotInFish],
661 "leave the busy state",
663 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
664 state as is. This is only used when implementing
665 actions using the low-level API.
667 For more information on states, see L<guestfs(3)>.");
669 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
670 [InitNone, Always, TestOutputInt (
671 [["set_memsize"; "500"];
672 ["get_memsize"]], 500)],
673 "set memory allocated to the qemu subprocess",
675 This sets the memory size in megabytes allocated to the
676 qemu subprocess. This only has any effect if called before
679 You can also change this by setting the environment
680 variable C<LIBGUESTFS_MEMSIZE> before the handle is
683 For more information on the architecture of libguestfs,
684 see L<guestfs(3)>.");
686 ("get_memsize", (RInt "memsize", []), -1, [],
687 [InitNone, Always, TestOutputIntOp (
688 [["get_memsize"]], ">=", 256)],
689 "get memory allocated to the qemu subprocess",
691 This gets the memory size in megabytes allocated to the
694 If C<guestfs_set_memsize> was not called
695 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
696 then this returns the compiled-in default value for memsize.
698 For more information on the architecture of libguestfs,
699 see L<guestfs(3)>.");
701 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
702 [InitNone, Always, TestOutputIntOp (
703 [["get_pid"]], ">=", 1)],
704 "get PID of qemu subprocess",
706 Return the process ID of the qemu subprocess. If there is no
707 qemu subprocess, then this will return an error.
709 This is an internal call used for debugging and testing.");
711 ("version", (RStruct ("version", "version"), []), -1, [],
712 [InitNone, Always, TestOutputStruct (
713 [["version"]], [CompareWithInt ("major", 1)])],
714 "get the library version number",
716 Return the libguestfs version number that the program is linked
719 Note that because of dynamic linking this is not necessarily
720 the version of libguestfs that you compiled against. You can
721 compile the program, and then at runtime dynamically link
722 against a completely different C<libguestfs.so> library.
724 This call was added in version C<1.0.58>. In previous
725 versions of libguestfs there was no way to get the version
726 number. From C code you can use ELF weak linking tricks to find out if
727 this symbol exists (if it doesn't, then it's an earlier version).
729 The call returns a structure with four elements. The first
730 three (C<major>, C<minor> and C<release>) are numbers and
731 correspond to the usual version triplet. The fourth element
732 (C<extra>) is a string and is normally empty, but may be
733 used for distro-specific information.
735 To construct the original version string:
736 C<$major.$minor.$release$extra>
738 I<Note:> Don't use this call to test for availability
739 of features. Distro backports makes this unreliable.");
743 (* daemon_functions are any functions which cause some action
744 * to take place in the daemon.
747 let daemon_functions = [
748 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
749 [InitEmpty, Always, TestOutput (
750 [["sfdiskM"; "/dev/sda"; ","];
751 ["mkfs"; "ext2"; "/dev/sda1"];
752 ["mount"; "/dev/sda1"; "/"];
753 ["write_file"; "/new"; "new file contents"; "0"];
754 ["cat"; "/new"]], "new file contents")],
755 "mount a guest disk at a position in the filesystem",
757 Mount a guest disk at a position in the filesystem. Block devices
758 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
759 the guest. If those block devices contain partitions, they will have
760 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
763 The rules are the same as for L<mount(2)>: A filesystem must
764 first be mounted on C</> before others can be mounted. Other
765 filesystems can only be mounted on directories which already
768 The mounted filesystem is writable, if we have sufficient permissions
769 on the underlying device.
771 The filesystem options C<sync> and C<noatime> are set with this
772 call, in order to improve reliability.");
774 ("sync", (RErr, []), 2, [],
775 [ InitEmpty, Always, TestRun [["sync"]]],
776 "sync disks, writes are flushed through to the disk image",
778 This syncs the disk, so that any writes are flushed through to the
779 underlying disk image.
781 You should always call this if you have modified a disk image, before
782 closing the handle.");
784 ("touch", (RErr, [String "path"]), 3, [],
785 [InitBasicFS, Always, TestOutputTrue (
787 ["exists"; "/new"]])],
788 "update file timestamps or create a new file",
790 Touch acts like the L<touch(1)> command. It can be used to
791 update the timestamps on a file, or, if the file does not exist,
792 to create a new zero-length file.");
794 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
795 [InitBasicFS, Always, TestOutput (
796 [["write_file"; "/new"; "new file contents"; "0"];
797 ["cat"; "/new"]], "new file contents")],
798 "list the contents of a file",
800 Return the contents of the file named C<path>.
802 Note that this function cannot correctly handle binary files
803 (specifically, files containing C<\\0> character which is treated
804 as end of string). For those you need to use the C<guestfs_read_file>
805 or C<guestfs_download> functions which have a more complex interface.");
807 ("ll", (RString "listing", [String "directory"]), 5, [],
808 [], (* XXX Tricky to test because it depends on the exact format
809 * of the 'ls -l' command, which changes between F10 and F11.
811 "list the files in a directory (long format)",
813 List the files in C<directory> (relative to the root directory,
814 there is no cwd) in the format of 'ls -la'.
816 This command is mostly useful for interactive sessions. It
817 is I<not> intended that you try to parse the output string.");
819 ("ls", (RStringList "listing", [String "directory"]), 6, [],
820 [InitBasicFS, Always, TestOutputList (
823 ["touch"; "/newest"];
824 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
825 "list the files in a directory",
827 List the files in C<directory> (relative to the root directory,
828 there is no cwd). The '.' and '..' entries are not returned, but
829 hidden files are shown.
831 This command is mostly useful for interactive sessions. Programs
832 should probably use C<guestfs_readdir> instead.");
834 ("list_devices", (RStringList "devices", []), 7, [],
835 [InitEmpty, Always, TestOutputListOfDevices (
836 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
837 "list the block devices",
839 List all the block devices.
841 The full block device names are returned, eg. C</dev/sda>");
843 ("list_partitions", (RStringList "partitions", []), 8, [],
844 [InitBasicFS, Always, TestOutputListOfDevices (
845 [["list_partitions"]], ["/dev/sda1"]);
846 InitEmpty, Always, TestOutputListOfDevices (
847 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
848 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
849 "list the partitions",
851 List all the partitions detected on all block devices.
853 The full partition device names are returned, eg. C</dev/sda1>
855 This does not return logical volumes. For that you will need to
856 call C<guestfs_lvs>.");
858 ("pvs", (RStringList "physvols", []), 9, [],
859 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
860 [["pvs"]], ["/dev/sda1"]);
861 InitEmpty, Always, TestOutputListOfDevices (
862 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
863 ["pvcreate"; "/dev/sda1"];
864 ["pvcreate"; "/dev/sda2"];
865 ["pvcreate"; "/dev/sda3"];
866 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
867 "list the LVM physical volumes (PVs)",
869 List all the physical volumes detected. This is the equivalent
870 of the L<pvs(8)> command.
872 This returns a list of just the device names that contain
873 PVs (eg. C</dev/sda2>).
875 See also C<guestfs_pvs_full>.");
877 ("vgs", (RStringList "volgroups", []), 10, [],
878 [InitBasicFSonLVM, Always, TestOutputList (
880 InitEmpty, Always, TestOutputList (
881 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
882 ["pvcreate"; "/dev/sda1"];
883 ["pvcreate"; "/dev/sda2"];
884 ["pvcreate"; "/dev/sda3"];
885 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
886 ["vgcreate"; "VG2"; "/dev/sda3"];
887 ["vgs"]], ["VG1"; "VG2"])],
888 "list the LVM volume groups (VGs)",
890 List all the volumes groups detected. This is the equivalent
891 of the L<vgs(8)> command.
893 This returns a list of just the volume group names that were
894 detected (eg. C<VolGroup00>).
896 See also C<guestfs_vgs_full>.");
898 ("lvs", (RStringList "logvols", []), 11, [],
899 [InitBasicFSonLVM, Always, TestOutputList (
900 [["lvs"]], ["/dev/VG/LV"]);
901 InitEmpty, Always, TestOutputList (
902 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
903 ["pvcreate"; "/dev/sda1"];
904 ["pvcreate"; "/dev/sda2"];
905 ["pvcreate"; "/dev/sda3"];
906 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
907 ["vgcreate"; "VG2"; "/dev/sda3"];
908 ["lvcreate"; "LV1"; "VG1"; "50"];
909 ["lvcreate"; "LV2"; "VG1"; "50"];
910 ["lvcreate"; "LV3"; "VG2"; "50"];
911 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
912 "list the LVM logical volumes (LVs)",
914 List all the logical volumes detected. This is the equivalent
915 of the L<lvs(8)> command.
917 This returns a list of the logical volume device names
918 (eg. C</dev/VolGroup00/LogVol00>).
920 See also C<guestfs_lvs_full>.");
922 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
923 [], (* XXX how to test? *)
924 "list the LVM physical volumes (PVs)",
926 List all the physical volumes detected. This is the equivalent
927 of the L<pvs(8)> command. The \"full\" version includes all fields.");
929 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
930 [], (* XXX how to test? *)
931 "list the LVM volume groups (VGs)",
933 List all the volumes groups detected. This is the equivalent
934 of the L<vgs(8)> command. The \"full\" version includes all fields.");
936 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
937 [], (* XXX how to test? *)
938 "list the LVM logical volumes (LVs)",
940 List all the logical volumes detected. This is the equivalent
941 of the L<lvs(8)> command. The \"full\" version includes all fields.");
943 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
944 [InitBasicFS, Always, TestOutputList (
945 [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
946 ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
947 InitBasicFS, Always, TestOutputList (
948 [["write_file"; "/new"; ""; "0"];
949 ["read_lines"; "/new"]], [])],
950 "read file as lines",
952 Return the contents of the file named C<path>.
954 The file contents are returned as a list of lines. Trailing
955 C<LF> and C<CRLF> character sequences are I<not> returned.
957 Note that this function cannot correctly handle binary files
958 (specifically, files containing C<\\0> character which is treated
959 as end of line). For those you need to use the C<guestfs_read_file>
960 function which has a more complex interface.");
962 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
963 [], (* XXX Augeas code needs tests. *)
964 "create a new Augeas handle",
966 Create a new Augeas handle for editing configuration files.
967 If there was any previous Augeas handle associated with this
968 guestfs session, then it is closed.
970 You must call this before using any other C<guestfs_aug_*>
973 C<root> is the filesystem root. C<root> must not be NULL,
976 The flags are the same as the flags defined in
977 E<lt>augeas.hE<gt>, the logical I<or> of the following
982 =item C<AUG_SAVE_BACKUP> = 1
984 Keep the original file with a C<.augsave> extension.
986 =item C<AUG_SAVE_NEWFILE> = 2
988 Save changes into a file with extension C<.augnew>, and
989 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
991 =item C<AUG_TYPE_CHECK> = 4
993 Typecheck lenses (can be expensive).
995 =item C<AUG_NO_STDINC> = 8
997 Do not use standard load path for modules.
999 =item C<AUG_SAVE_NOOP> = 16
1001 Make save a no-op, just record what would have been changed.
1003 =item C<AUG_NO_LOAD> = 32
1005 Do not load the tree in C<guestfs_aug_init>.
1009 To close the handle, you can call C<guestfs_aug_close>.
1011 To find out more about Augeas, see L<http://augeas.net/>.");
1013 ("aug_close", (RErr, []), 26, [],
1014 [], (* XXX Augeas code needs tests. *)
1015 "close the current Augeas handle",
1017 Close the current Augeas handle and free up any resources
1018 used by it. After calling this, you have to call
1019 C<guestfs_aug_init> again before you can use any other
1020 Augeas functions.");
1022 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
1023 [], (* XXX Augeas code needs tests. *)
1024 "define an Augeas variable",
1026 Defines an Augeas variable C<name> whose value is the result
1027 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1030 On success this returns the number of nodes in C<expr>, or
1031 C<0> if C<expr> evaluates to something which is not a nodeset.");
1033 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1034 [], (* XXX Augeas code needs tests. *)
1035 "define an Augeas node",
1037 Defines a variable C<name> whose value is the result of
1040 If C<expr> evaluates to an empty nodeset, a node is created,
1041 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1042 C<name> will be the nodeset containing that single node.
1044 On success this returns a pair containing the
1045 number of nodes in the nodeset, and a boolean flag
1046 if a node was created.");
1048 ("aug_get", (RString "val", [String "path"]), 19, [],
1049 [], (* XXX Augeas code needs tests. *)
1050 "look up the value of an Augeas path",
1052 Look up the value associated with C<path>. If C<path>
1053 matches exactly one node, the C<value> is returned.");
1055 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
1056 [], (* XXX Augeas code needs tests. *)
1057 "set Augeas path to value",
1059 Set the value associated with C<path> to C<value>.");
1061 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
1062 [], (* XXX Augeas code needs tests. *)
1063 "insert a sibling Augeas node",
1065 Create a new sibling C<label> for C<path>, inserting it into
1066 the tree before or after C<path> (depending on the boolean
1069 C<path> must match exactly one existing node in the tree, and
1070 C<label> must be a label, ie. not contain C</>, C<*> or end
1071 with a bracketed index C<[N]>.");
1073 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
1074 [], (* XXX Augeas code needs tests. *)
1075 "remove an Augeas path",
1077 Remove C<path> and all of its children.
1079 On success this returns the number of entries which were removed.");
1081 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1082 [], (* XXX Augeas code needs tests. *)
1085 Move the node C<src> to C<dest>. C<src> must match exactly
1086 one node. C<dest> is overwritten if it exists.");
1088 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
1089 [], (* XXX Augeas code needs tests. *)
1090 "return Augeas nodes which match path",
1092 Returns a list of paths which match the path expression C<path>.
1093 The returned paths are sufficiently qualified so that they match
1094 exactly one node in the current tree.");
1096 ("aug_save", (RErr, []), 25, [],
1097 [], (* XXX Augeas code needs tests. *)
1098 "write all pending Augeas changes to disk",
1100 This writes all pending changes to disk.
1102 The flags which were passed to C<guestfs_aug_init> affect exactly
1103 how files are saved.");
1105 ("aug_load", (RErr, []), 27, [],
1106 [], (* XXX Augeas code needs tests. *)
1107 "load files into the tree",
1109 Load files into the tree.
1111 See C<aug_load> in the Augeas documentation for the full gory
1114 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
1115 [], (* XXX Augeas code needs tests. *)
1116 "list Augeas nodes under a path",
1118 This is just a shortcut for listing C<guestfs_aug_match>
1119 C<path/*> and sorting the resulting nodes into alphabetical order.");
1121 ("rm", (RErr, [String "path"]), 29, [],
1122 [InitBasicFS, Always, TestRun
1125 InitBasicFS, Always, TestLastFail
1127 InitBasicFS, Always, TestLastFail
1132 Remove the single file C<path>.");
1134 ("rmdir", (RErr, [String "path"]), 30, [],
1135 [InitBasicFS, Always, TestRun
1138 InitBasicFS, Always, TestLastFail
1139 [["rmdir"; "/new"]];
1140 InitBasicFS, Always, TestLastFail
1142 ["rmdir"; "/new"]]],
1143 "remove a directory",
1145 Remove the single directory C<path>.");
1147 ("rm_rf", (RErr, [String "path"]), 31, [],
1148 [InitBasicFS, Always, TestOutputFalse
1150 ["mkdir"; "/new/foo"];
1151 ["touch"; "/new/foo/bar"];
1153 ["exists"; "/new"]]],
1154 "remove a file or directory recursively",
1156 Remove the file or directory C<path>, recursively removing the
1157 contents if its a directory. This is like the C<rm -rf> shell
1160 ("mkdir", (RErr, [String "path"]), 32, [],
1161 [InitBasicFS, Always, TestOutputTrue
1163 ["is_dir"; "/new"]];
1164 InitBasicFS, Always, TestLastFail
1165 [["mkdir"; "/new/foo/bar"]]],
1166 "create a directory",
1168 Create a directory named C<path>.");
1170 ("mkdir_p", (RErr, [String "path"]), 33, [],
1171 [InitBasicFS, Always, TestOutputTrue
1172 [["mkdir_p"; "/new/foo/bar"];
1173 ["is_dir"; "/new/foo/bar"]];
1174 InitBasicFS, Always, TestOutputTrue
1175 [["mkdir_p"; "/new/foo/bar"];
1176 ["is_dir"; "/new/foo"]];
1177 InitBasicFS, Always, TestOutputTrue
1178 [["mkdir_p"; "/new/foo/bar"];
1179 ["is_dir"; "/new"]];
1180 (* Regression tests for RHBZ#503133: *)
1181 InitBasicFS, Always, TestRun
1183 ["mkdir_p"; "/new"]];
1184 InitBasicFS, Always, TestLastFail
1186 ["mkdir_p"; "/new"]]],
1187 "create a directory and parents",
1189 Create a directory named C<path>, creating any parent directories
1190 as necessary. This is like the C<mkdir -p> shell command.");
1192 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1193 [], (* XXX Need stat command to test *)
1196 Change the mode (permissions) of C<path> to C<mode>. Only
1197 numeric modes are supported.");
1199 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1200 [], (* XXX Need stat command to test *)
1201 "change file owner and group",
1203 Change the file owner to C<owner> and group to C<group>.
1205 Only numeric uid and gid are supported. If you want to use
1206 names, you will need to locate and parse the password file
1207 yourself (Augeas support makes this relatively easy).");
1209 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1210 [InitBasicFS, Always, TestOutputTrue (
1212 ["exists"; "/new"]]);
1213 InitBasicFS, Always, TestOutputTrue (
1215 ["exists"; "/new"]])],
1216 "test if file or directory exists",
1218 This returns C<true> if and only if there is a file, directory
1219 (or anything) with the given C<path> name.
1221 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1223 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1224 [InitBasicFS, Always, TestOutputTrue (
1226 ["is_file"; "/new"]]);
1227 InitBasicFS, Always, TestOutputFalse (
1229 ["is_file"; "/new"]])],
1230 "test if file exists",
1232 This returns C<true> if and only if there is a file
1233 with the given C<path> name. Note that it returns false for
1234 other objects like directories.
1236 See also C<guestfs_stat>.");
1238 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1239 [InitBasicFS, Always, TestOutputFalse (
1241 ["is_dir"; "/new"]]);
1242 InitBasicFS, Always, TestOutputTrue (
1244 ["is_dir"; "/new"]])],
1245 "test if file exists",
1247 This returns C<true> if and only if there is a directory
1248 with the given C<path> name. Note that it returns false for
1249 other objects like files.
1251 See also C<guestfs_stat>.");
1253 ("pvcreate", (RErr, [String "device"]), 39, [],
1254 [InitEmpty, Always, TestOutputListOfDevices (
1255 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1256 ["pvcreate"; "/dev/sda1"];
1257 ["pvcreate"; "/dev/sda2"];
1258 ["pvcreate"; "/dev/sda3"];
1259 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1260 "create an LVM physical volume",
1262 This creates an LVM physical volume on the named C<device>,
1263 where C<device> should usually be a partition name such
1266 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1267 [InitEmpty, Always, TestOutputList (
1268 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1269 ["pvcreate"; "/dev/sda1"];
1270 ["pvcreate"; "/dev/sda2"];
1271 ["pvcreate"; "/dev/sda3"];
1272 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1273 ["vgcreate"; "VG2"; "/dev/sda3"];
1274 ["vgs"]], ["VG1"; "VG2"])],
1275 "create an LVM volume group",
1277 This creates an LVM volume group called C<volgroup>
1278 from the non-empty list of physical volumes C<physvols>.");
1280 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1281 [InitEmpty, Always, TestOutputList (
1282 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1283 ["pvcreate"; "/dev/sda1"];
1284 ["pvcreate"; "/dev/sda2"];
1285 ["pvcreate"; "/dev/sda3"];
1286 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1287 ["vgcreate"; "VG2"; "/dev/sda3"];
1288 ["lvcreate"; "LV1"; "VG1"; "50"];
1289 ["lvcreate"; "LV2"; "VG1"; "50"];
1290 ["lvcreate"; "LV3"; "VG2"; "50"];
1291 ["lvcreate"; "LV4"; "VG2"; "50"];
1292 ["lvcreate"; "LV5"; "VG2"; "50"];
1294 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1295 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1296 "create an LVM volume group",
1298 This creates an LVM volume group called C<logvol>
1299 on the volume group C<volgroup>, with C<size> megabytes.");
1301 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1302 [InitEmpty, Always, TestOutput (
1303 [["sfdiskM"; "/dev/sda"; ","];
1304 ["mkfs"; "ext2"; "/dev/sda1"];
1305 ["mount"; "/dev/sda1"; "/"];
1306 ["write_file"; "/new"; "new file contents"; "0"];
1307 ["cat"; "/new"]], "new file contents")],
1308 "make a filesystem",
1310 This creates a filesystem on C<device> (usually a partition
1311 or LVM logical volume). The filesystem type is C<fstype>, for
1314 ("sfdisk", (RErr, [String "device";
1315 Int "cyls"; Int "heads"; Int "sectors";
1316 StringList "lines"]), 43, [DangerWillRobinson],
1318 "create partitions on a block device",
1320 This is a direct interface to the L<sfdisk(8)> program for creating
1321 partitions on block devices.
1323 C<device> should be a block device, for example C</dev/sda>.
1325 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1326 and sectors on the device, which are passed directly to sfdisk as
1327 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1328 of these, then the corresponding parameter is omitted. Usually for
1329 'large' disks, you can just pass C<0> for these, but for small
1330 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1331 out the right geometry and you will need to tell it.
1333 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1334 information refer to the L<sfdisk(8)> manpage.
1336 To create a single partition occupying the whole disk, you would
1337 pass C<lines> as a single element list, when the single element being
1338 the string C<,> (comma).
1340 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1342 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1343 [InitBasicFS, Always, TestOutput (
1344 [["write_file"; "/new"; "new file contents"; "0"];
1345 ["cat"; "/new"]], "new file contents");
1346 InitBasicFS, Always, TestOutput (
1347 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1348 ["cat"; "/new"]], "\nnew file contents\n");
1349 InitBasicFS, Always, TestOutput (
1350 [["write_file"; "/new"; "\n\n"; "0"];
1351 ["cat"; "/new"]], "\n\n");
1352 InitBasicFS, Always, TestOutput (
1353 [["write_file"; "/new"; ""; "0"];
1354 ["cat"; "/new"]], "");
1355 InitBasicFS, Always, TestOutput (
1356 [["write_file"; "/new"; "\n\n\n"; "0"];
1357 ["cat"; "/new"]], "\n\n\n");
1358 InitBasicFS, Always, TestOutput (
1359 [["write_file"; "/new"; "\n"; "0"];
1360 ["cat"; "/new"]], "\n")],
1363 This call creates a file called C<path>. The contents of the
1364 file is the string C<content> (which can contain any 8 bit data),
1365 with length C<size>.
1367 As a special case, if C<size> is C<0>
1368 then the length is calculated using C<strlen> (so in this case
1369 the content cannot contain embedded ASCII NULs).
1371 I<NB.> Owing to a bug, writing content containing ASCII NUL
1372 characters does I<not> work, even if the length is specified.
1373 We hope to resolve this bug in a future version. In the meantime
1374 use C<guestfs_upload>.");
1376 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1377 [InitEmpty, Always, TestOutputListOfDevices (
1378 [["sfdiskM"; "/dev/sda"; ","];
1379 ["mkfs"; "ext2"; "/dev/sda1"];
1380 ["mount"; "/dev/sda1"; "/"];
1381 ["mounts"]], ["/dev/sda1"]);
1382 InitEmpty, Always, TestOutputList (
1383 [["sfdiskM"; "/dev/sda"; ","];
1384 ["mkfs"; "ext2"; "/dev/sda1"];
1385 ["mount"; "/dev/sda1"; "/"];
1388 "unmount a filesystem",
1390 This unmounts the given filesystem. The filesystem may be
1391 specified either by its mountpoint (path) or the device which
1392 contains the filesystem.");
1394 ("mounts", (RStringList "devices", []), 46, [],
1395 [InitBasicFS, Always, TestOutputListOfDevices (
1396 [["mounts"]], ["/dev/sda1"])],
1397 "show mounted filesystems",
1399 This returns the list of currently mounted filesystems. It returns
1400 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1402 Some internal mounts are not shown.
1404 See also: C<guestfs_mountpoints>");
1406 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1407 [InitBasicFS, Always, TestOutputList (
1410 (* check that umount_all can unmount nested mounts correctly: *)
1411 InitEmpty, Always, TestOutputList (
1412 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1413 ["mkfs"; "ext2"; "/dev/sda1"];
1414 ["mkfs"; "ext2"; "/dev/sda2"];
1415 ["mkfs"; "ext2"; "/dev/sda3"];
1416 ["mount"; "/dev/sda1"; "/"];
1418 ["mount"; "/dev/sda2"; "/mp1"];
1419 ["mkdir"; "/mp1/mp2"];
1420 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1421 ["mkdir"; "/mp1/mp2/mp3"];
1424 "unmount all filesystems",
1426 This unmounts all mounted filesystems.
1428 Some internal mounts are not unmounted by this call.");
1430 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1432 "remove all LVM LVs, VGs and PVs",
1434 This command removes all LVM logical volumes, volume groups
1435 and physical volumes.");
1437 ("file", (RString "description", [String "path"]), 49, [],
1438 [InitBasicFS, Always, TestOutput (
1440 ["file"; "/new"]], "empty");
1441 InitBasicFS, Always, TestOutput (
1442 [["write_file"; "/new"; "some content\n"; "0"];
1443 ["file"; "/new"]], "ASCII text");
1444 InitBasicFS, Always, TestLastFail (
1445 [["file"; "/nofile"]])],
1446 "determine file type",
1448 This call uses the standard L<file(1)> command to determine
1449 the type or contents of the file. This also works on devices,
1450 for example to find out whether a partition contains a filesystem.
1452 The exact command which runs is C<file -bsL path>. Note in
1453 particular that the filename is not prepended to the output
1454 (the C<-b> option).");
1456 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1457 [InitBasicFS, Always, TestOutput (
1458 [["upload"; "test-command"; "/test-command"];
1459 ["chmod"; "0o755"; "/test-command"];
1460 ["command"; "/test-command 1"]], "Result1");
1461 InitBasicFS, Always, TestOutput (
1462 [["upload"; "test-command"; "/test-command"];
1463 ["chmod"; "0o755"; "/test-command"];
1464 ["command"; "/test-command 2"]], "Result2\n");
1465 InitBasicFS, Always, TestOutput (
1466 [["upload"; "test-command"; "/test-command"];
1467 ["chmod"; "0o755"; "/test-command"];
1468 ["command"; "/test-command 3"]], "\nResult3");
1469 InitBasicFS, Always, TestOutput (
1470 [["upload"; "test-command"; "/test-command"];
1471 ["chmod"; "0o755"; "/test-command"];
1472 ["command"; "/test-command 4"]], "\nResult4\n");
1473 InitBasicFS, Always, TestOutput (
1474 [["upload"; "test-command"; "/test-command"];
1475 ["chmod"; "0o755"; "/test-command"];
1476 ["command"; "/test-command 5"]], "\nResult5\n\n");
1477 InitBasicFS, Always, TestOutput (
1478 [["upload"; "test-command"; "/test-command"];
1479 ["chmod"; "0o755"; "/test-command"];
1480 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1481 InitBasicFS, Always, TestOutput (
1482 [["upload"; "test-command"; "/test-command"];
1483 ["chmod"; "0o755"; "/test-command"];
1484 ["command"; "/test-command 7"]], "");
1485 InitBasicFS, Always, TestOutput (
1486 [["upload"; "test-command"; "/test-command"];
1487 ["chmod"; "0o755"; "/test-command"];
1488 ["command"; "/test-command 8"]], "\n");
1489 InitBasicFS, Always, TestOutput (
1490 [["upload"; "test-command"; "/test-command"];
1491 ["chmod"; "0o755"; "/test-command"];
1492 ["command"; "/test-command 9"]], "\n\n");
1493 InitBasicFS, Always, TestOutput (
1494 [["upload"; "test-command"; "/test-command"];
1495 ["chmod"; "0o755"; "/test-command"];
1496 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1497 InitBasicFS, Always, TestOutput (
1498 [["upload"; "test-command"; "/test-command"];
1499 ["chmod"; "0o755"; "/test-command"];
1500 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1501 InitBasicFS, Always, TestLastFail (
1502 [["upload"; "test-command"; "/test-command"];
1503 ["chmod"; "0o755"; "/test-command"];
1504 ["command"; "/test-command"]])],
1505 "run a command from the guest filesystem",
1507 This call runs a command from the guest filesystem. The
1508 filesystem must be mounted, and must contain a compatible
1509 operating system (ie. something Linux, with the same
1510 or compatible processor architecture).
1512 The single parameter is an argv-style list of arguments.
1513 The first element is the name of the program to run.
1514 Subsequent elements are parameters. The list must be
1515 non-empty (ie. must contain a program name). Note that
1516 the command runs directly, and is I<not> invoked via
1517 the shell (see C<guestfs_sh>).
1519 The return value is anything printed to I<stdout> by
1522 If the command returns a non-zero exit status, then
1523 this function returns an error message. The error message
1524 string is the content of I<stderr> from the command.
1526 The C<$PATH> environment variable will contain at least
1527 C</usr/bin> and C</bin>. If you require a program from
1528 another location, you should provide the full path in the
1531 Shared libraries and data files required by the program
1532 must be available on filesystems which are mounted in the
1533 correct places. It is the caller's responsibility to ensure
1534 all filesystems that are needed are mounted at the right
1537 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1538 [InitBasicFS, Always, TestOutputList (
1539 [["upload"; "test-command"; "/test-command"];
1540 ["chmod"; "0o755"; "/test-command"];
1541 ["command_lines"; "/test-command 1"]], ["Result1"]);
1542 InitBasicFS, Always, TestOutputList (
1543 [["upload"; "test-command"; "/test-command"];
1544 ["chmod"; "0o755"; "/test-command"];
1545 ["command_lines"; "/test-command 2"]], ["Result2"]);
1546 InitBasicFS, Always, TestOutputList (
1547 [["upload"; "test-command"; "/test-command"];
1548 ["chmod"; "0o755"; "/test-command"];
1549 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1550 InitBasicFS, Always, TestOutputList (
1551 [["upload"; "test-command"; "/test-command"];
1552 ["chmod"; "0o755"; "/test-command"];
1553 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1554 InitBasicFS, Always, TestOutputList (
1555 [["upload"; "test-command"; "/test-command"];
1556 ["chmod"; "0o755"; "/test-command"];
1557 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1558 InitBasicFS, Always, TestOutputList (
1559 [["upload"; "test-command"; "/test-command"];
1560 ["chmod"; "0o755"; "/test-command"];
1561 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1562 InitBasicFS, Always, TestOutputList (
1563 [["upload"; "test-command"; "/test-command"];
1564 ["chmod"; "0o755"; "/test-command"];
1565 ["command_lines"; "/test-command 7"]], []);
1566 InitBasicFS, Always, TestOutputList (
1567 [["upload"; "test-command"; "/test-command"];
1568 ["chmod"; "0o755"; "/test-command"];
1569 ["command_lines"; "/test-command 8"]], [""]);
1570 InitBasicFS, Always, TestOutputList (
1571 [["upload"; "test-command"; "/test-command"];
1572 ["chmod"; "0o755"; "/test-command"];
1573 ["command_lines"; "/test-command 9"]], ["";""]);
1574 InitBasicFS, Always, TestOutputList (
1575 [["upload"; "test-command"; "/test-command"];
1576 ["chmod"; "0o755"; "/test-command"];
1577 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1578 InitBasicFS, Always, TestOutputList (
1579 [["upload"; "test-command"; "/test-command"];
1580 ["chmod"; "0o755"; "/test-command"];
1581 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1582 "run a command, returning lines",
1584 This is the same as C<guestfs_command>, but splits the
1585 result into a list of lines.
1587 See also: C<guestfs_sh_lines>");
1589 ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1590 [InitBasicFS, Always, TestOutputStruct (
1592 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1593 "get file information",
1595 Returns file information for the given C<path>.
1597 This is the same as the C<stat(2)> system call.");
1599 ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1600 [InitBasicFS, Always, TestOutputStruct (
1602 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1603 "get file information for a symbolic link",
1605 Returns file information for the given C<path>.
1607 This is the same as C<guestfs_stat> except that if C<path>
1608 is a symbolic link, then the link is stat-ed, not the file it
1611 This is the same as the C<lstat(2)> system call.");
1613 ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1614 [InitBasicFS, Always, TestOutputStruct (
1615 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255);
1616 CompareWithInt ("bsize", 1024)])],
1617 "get file system statistics",
1619 Returns file system statistics for any mounted file system.
1620 C<path> should be a file or directory in the mounted file system
1621 (typically it is the mount point itself, but it doesn't need to be).
1623 This is the same as the C<statvfs(2)> system call.");
1625 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1627 "get ext2/ext3/ext4 superblock details",
1629 This returns the contents of the ext2, ext3 or ext4 filesystem
1630 superblock on C<device>.
1632 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1633 manpage for more details. The list of fields returned isn't
1634 clearly defined, and depends on both the version of C<tune2fs>
1635 that libguestfs was built against, and the filesystem itself.");
1637 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1638 [InitEmpty, Always, TestOutputTrue (
1639 [["blockdev_setro"; "/dev/sda"];
1640 ["blockdev_getro"; "/dev/sda"]])],
1641 "set block device to read-only",
1643 Sets the block device named C<device> to read-only.
1645 This uses the L<blockdev(8)> command.");
1647 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1648 [InitEmpty, Always, TestOutputFalse (
1649 [["blockdev_setrw"; "/dev/sda"];
1650 ["blockdev_getro"; "/dev/sda"]])],
1651 "set block device to read-write",
1653 Sets the block device named C<device> to read-write.
1655 This uses the L<blockdev(8)> command.");
1657 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1658 [InitEmpty, Always, TestOutputTrue (
1659 [["blockdev_setro"; "/dev/sda"];
1660 ["blockdev_getro"; "/dev/sda"]])],
1661 "is block device set to read-only",
1663 Returns a boolean indicating if the block device is read-only
1664 (true if read-only, false if not).
1666 This uses the L<blockdev(8)> command.");
1668 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1669 [InitEmpty, Always, TestOutputInt (
1670 [["blockdev_getss"; "/dev/sda"]], 512)],
1671 "get sectorsize of block device",
1673 This returns the size of sectors on a block device.
1674 Usually 512, but can be larger for modern devices.
1676 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1679 This uses the L<blockdev(8)> command.");
1681 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1682 [InitEmpty, Always, TestOutputInt (
1683 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1684 "get blocksize of block device",
1686 This returns the block size of a device.
1688 (Note this is different from both I<size in blocks> and
1689 I<filesystem block size>).
1691 This uses the L<blockdev(8)> command.");
1693 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1695 "set blocksize of block device",
1697 This sets the block size of a device.
1699 (Note this is different from both I<size in blocks> and
1700 I<filesystem block size>).
1702 This uses the L<blockdev(8)> command.");
1704 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1705 [InitEmpty, Always, TestOutputInt (
1706 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1707 "get total size of device in 512-byte sectors",
1709 This returns the size of the device in units of 512-byte sectors
1710 (even if the sectorsize isn't 512 bytes ... weird).
1712 See also C<guestfs_blockdev_getss> for the real sector size of
1713 the device, and C<guestfs_blockdev_getsize64> for the more
1714 useful I<size in bytes>.
1716 This uses the L<blockdev(8)> command.");
1718 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1719 [InitEmpty, Always, TestOutputInt (
1720 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1721 "get total size of device in bytes",
1723 This returns the size of the device in bytes.
1725 See also C<guestfs_blockdev_getsz>.
1727 This uses the L<blockdev(8)> command.");
1729 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1730 [InitEmpty, Always, TestRun
1731 [["blockdev_flushbufs"; "/dev/sda"]]],
1732 "flush device buffers",
1734 This tells the kernel to flush internal buffers associated
1737 This uses the L<blockdev(8)> command.");
1739 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1740 [InitEmpty, Always, TestRun
1741 [["blockdev_rereadpt"; "/dev/sda"]]],
1742 "reread partition table",
1744 Reread the partition table on C<device>.
1746 This uses the L<blockdev(8)> command.");
1748 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1749 [InitBasicFS, Always, TestOutput (
1750 (* Pick a file from cwd which isn't likely to change. *)
1751 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1752 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1753 "upload a file from the local machine",
1755 Upload local file C<filename> to C<remotefilename> on the
1758 C<filename> can also be a named pipe.
1760 See also C<guestfs_download>.");
1762 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1763 [InitBasicFS, Always, TestOutput (
1764 (* Pick a file from cwd which isn't likely to change. *)
1765 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1766 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1767 ["upload"; "testdownload.tmp"; "/upload"];
1768 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1769 "download a file to the local machine",
1771 Download file C<remotefilename> and save it as C<filename>
1772 on the local machine.
1774 C<filename> can also be a named pipe.
1776 See also C<guestfs_upload>, C<guestfs_cat>.");
1778 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1779 [InitBasicFS, Always, TestOutput (
1780 [["write_file"; "/new"; "test\n"; "0"];
1781 ["checksum"; "crc"; "/new"]], "935282863");
1782 InitBasicFS, Always, TestLastFail (
1783 [["checksum"; "crc"; "/new"]]);
1784 InitBasicFS, Always, TestOutput (
1785 [["write_file"; "/new"; "test\n"; "0"];
1786 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1787 InitBasicFS, Always, TestOutput (
1788 [["write_file"; "/new"; "test\n"; "0"];
1789 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1790 InitBasicFS, Always, TestOutput (
1791 [["write_file"; "/new"; "test\n"; "0"];
1792 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1793 InitBasicFS, Always, TestOutput (
1794 [["write_file"; "/new"; "test\n"; "0"];
1795 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1796 InitBasicFS, Always, TestOutput (
1797 [["write_file"; "/new"; "test\n"; "0"];
1798 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1799 InitBasicFS, Always, TestOutput (
1800 [["write_file"; "/new"; "test\n"; "0"];
1801 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1802 InitBasicFS, Always, TestOutput (
1803 (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1804 * the type explicitly.
1806 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1807 ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1808 "compute MD5, SHAx or CRC checksum of file",
1810 This call computes the MD5, SHAx or CRC checksum of the
1813 The type of checksum to compute is given by the C<csumtype>
1814 parameter which must have one of the following values:
1820 Compute the cyclic redundancy check (CRC) specified by POSIX
1821 for the C<cksum> command.
1825 Compute the MD5 hash (using the C<md5sum> program).
1829 Compute the SHA1 hash (using the C<sha1sum> program).
1833 Compute the SHA224 hash (using the C<sha224sum> program).
1837 Compute the SHA256 hash (using the C<sha256sum> program).
1841 Compute the SHA384 hash (using the C<sha384sum> program).
1845 Compute the SHA512 hash (using the C<sha512sum> program).
1849 The checksum is returned as a printable string.");
1851 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1852 [InitBasicFS, Always, TestOutput (
1853 [["tar_in"; "../images/helloworld.tar"; "/"];
1854 ["cat"; "/hello"]], "hello\n")],
1855 "unpack tarfile to directory",
1857 This command uploads and unpacks local file C<tarfile> (an
1858 I<uncompressed> tar file) into C<directory>.
1860 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1862 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1864 "pack directory into tarfile",
1866 This command packs the contents of C<directory> and downloads
1867 it to local file C<tarfile>.
1869 To download a compressed tarball, use C<guestfs_tgz_out>.");
1871 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1872 [InitBasicFS, Always, TestOutput (
1873 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1874 ["cat"; "/hello"]], "hello\n")],
1875 "unpack compressed tarball to directory",
1877 This command uploads and unpacks local file C<tarball> (a
1878 I<gzip compressed> tar file) into C<directory>.
1880 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1882 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1884 "pack directory into compressed tarball",
1886 This command packs the contents of C<directory> and downloads
1887 it to local file C<tarball>.
1889 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1891 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1892 [InitBasicFS, Always, TestLastFail (
1894 ["mount_ro"; "/dev/sda1"; "/"];
1895 ["touch"; "/new"]]);
1896 InitBasicFS, Always, TestOutput (
1897 [["write_file"; "/new"; "data"; "0"];
1899 ["mount_ro"; "/dev/sda1"; "/"];
1900 ["cat"; "/new"]], "data")],
1901 "mount a guest disk, read-only",
1903 This is the same as the C<guestfs_mount> command, but it
1904 mounts the filesystem with the read-only (I<-o ro>) flag.");
1906 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1908 "mount a guest disk with mount options",
1910 This is the same as the C<guestfs_mount> command, but it
1911 allows you to set the mount options as for the
1912 L<mount(8)> I<-o> flag.");
1914 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1916 "mount a guest disk with mount options and vfstype",
1918 This is the same as the C<guestfs_mount> command, but it
1919 allows you to set both the mount options and the vfstype
1920 as for the L<mount(8)> I<-o> and I<-t> flags.");
1922 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1924 "debugging and internals",
1926 The C<guestfs_debug> command exposes some internals of
1927 C<guestfsd> (the guestfs daemon) that runs inside the
1930 There is no comprehensive help for this command. You have
1931 to look at the file C<daemon/debug.c> in the libguestfs source
1932 to find out what you can do.");
1934 ("lvremove", (RErr, [String "device"]), 77, [],
1935 [InitEmpty, Always, TestOutputList (
1936 [["sfdiskM"; "/dev/sda"; ","];
1937 ["pvcreate"; "/dev/sda1"];
1938 ["vgcreate"; "VG"; "/dev/sda1"];
1939 ["lvcreate"; "LV1"; "VG"; "50"];
1940 ["lvcreate"; "LV2"; "VG"; "50"];
1941 ["lvremove"; "/dev/VG/LV1"];
1942 ["lvs"]], ["/dev/VG/LV2"]);
1943 InitEmpty, Always, TestOutputList (
1944 [["sfdiskM"; "/dev/sda"; ","];
1945 ["pvcreate"; "/dev/sda1"];
1946 ["vgcreate"; "VG"; "/dev/sda1"];
1947 ["lvcreate"; "LV1"; "VG"; "50"];
1948 ["lvcreate"; "LV2"; "VG"; "50"];
1949 ["lvremove"; "/dev/VG"];
1951 InitEmpty, Always, TestOutputList (
1952 [["sfdiskM"; "/dev/sda"; ","];
1953 ["pvcreate"; "/dev/sda1"];
1954 ["vgcreate"; "VG"; "/dev/sda1"];
1955 ["lvcreate"; "LV1"; "VG"; "50"];
1956 ["lvcreate"; "LV2"; "VG"; "50"];
1957 ["lvremove"; "/dev/VG"];
1959 "remove an LVM logical volume",
1961 Remove an LVM logical volume C<device>, where C<device> is
1962 the path to the LV, such as C</dev/VG/LV>.
1964 You can also remove all LVs in a volume group by specifying
1965 the VG name, C</dev/VG>.");
1967 ("vgremove", (RErr, [String "vgname"]), 78, [],
1968 [InitEmpty, Always, TestOutputList (
1969 [["sfdiskM"; "/dev/sda"; ","];
1970 ["pvcreate"; "/dev/sda1"];
1971 ["vgcreate"; "VG"; "/dev/sda1"];
1972 ["lvcreate"; "LV1"; "VG"; "50"];
1973 ["lvcreate"; "LV2"; "VG"; "50"];
1976 InitEmpty, Always, TestOutputList (
1977 [["sfdiskM"; "/dev/sda"; ","];
1978 ["pvcreate"; "/dev/sda1"];
1979 ["vgcreate"; "VG"; "/dev/sda1"];
1980 ["lvcreate"; "LV1"; "VG"; "50"];
1981 ["lvcreate"; "LV2"; "VG"; "50"];
1984 "remove an LVM volume group",
1986 Remove an LVM volume group C<vgname>, (for example C<VG>).
1988 This also forcibly removes all logical volumes in the volume
1991 ("pvremove", (RErr, [String "device"]), 79, [],
1992 [InitEmpty, Always, TestOutputListOfDevices (
1993 [["sfdiskM"; "/dev/sda"; ","];
1994 ["pvcreate"; "/dev/sda1"];
1995 ["vgcreate"; "VG"; "/dev/sda1"];
1996 ["lvcreate"; "LV1"; "VG"; "50"];
1997 ["lvcreate"; "LV2"; "VG"; "50"];
1999 ["pvremove"; "/dev/sda1"];
2001 InitEmpty, Always, TestOutputListOfDevices (
2002 [["sfdiskM"; "/dev/sda"; ","];
2003 ["pvcreate"; "/dev/sda1"];
2004 ["vgcreate"; "VG"; "/dev/sda1"];
2005 ["lvcreate"; "LV1"; "VG"; "50"];
2006 ["lvcreate"; "LV2"; "VG"; "50"];
2008 ["pvremove"; "/dev/sda1"];
2010 InitEmpty, Always, TestOutputListOfDevices (
2011 [["sfdiskM"; "/dev/sda"; ","];
2012 ["pvcreate"; "/dev/sda1"];
2013 ["vgcreate"; "VG"; "/dev/sda1"];
2014 ["lvcreate"; "LV1"; "VG"; "50"];
2015 ["lvcreate"; "LV2"; "VG"; "50"];
2017 ["pvremove"; "/dev/sda1"];
2019 "remove an LVM physical volume",
2021 This wipes a physical volume C<device> so that LVM will no longer
2024 The implementation uses the C<pvremove> command which refuses to
2025 wipe physical volumes that contain any volume groups, so you have
2026 to remove those first.");
2028 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
2029 [InitBasicFS, Always, TestOutput (
2030 [["set_e2label"; "/dev/sda1"; "testlabel"];
2031 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2032 "set the ext2/3/4 filesystem label",
2034 This sets the ext2/3/4 filesystem label of the filesystem on
2035 C<device> to C<label>. Filesystem labels are limited to
2038 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2039 to return the existing label on a filesystem.");
2041 ("get_e2label", (RString "label", [String "device"]), 81, [],
2043 "get the ext2/3/4 filesystem label",
2045 This returns the ext2/3/4 filesystem label of the filesystem on
2048 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2049 [InitBasicFS, Always, TestOutput (
2050 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2051 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2052 InitBasicFS, Always, TestOutput (
2053 [["set_e2uuid"; "/dev/sda1"; "clear"];
2054 ["get_e2uuid"; "/dev/sda1"]], "");
2055 (* We can't predict what UUIDs will be, so just check the commands run. *)
2056 InitBasicFS, Always, TestRun (
2057 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2058 InitBasicFS, Always, TestRun (
2059 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2060 "set the ext2/3/4 filesystem UUID",
2062 This sets the ext2/3/4 filesystem UUID of the filesystem on
2063 C<device> to C<uuid>. The format of the UUID and alternatives
2064 such as C<clear>, C<random> and C<time> are described in the
2065 L<tune2fs(8)> manpage.
2067 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2068 to return the existing UUID of a filesystem.");
2070 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2072 "get the ext2/3/4 filesystem UUID",
2074 This returns the ext2/3/4 filesystem UUID of the filesystem on
2077 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2078 [InitBasicFS, Always, TestOutputInt (
2079 [["umount"; "/dev/sda1"];
2080 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2081 InitBasicFS, Always, TestOutputInt (
2082 [["umount"; "/dev/sda1"];
2083 ["zero"; "/dev/sda1"];
2084 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2085 "run the filesystem checker",
2087 This runs the filesystem checker (fsck) on C<device> which
2088 should have filesystem type C<fstype>.
2090 The returned integer is the status. See L<fsck(8)> for the
2091 list of status codes from C<fsck>.
2099 Multiple status codes can be summed together.
2103 A non-zero return code can mean \"success\", for example if
2104 errors have been corrected on the filesystem.
2108 Checking or repairing NTFS volumes is not supported
2113 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2115 ("zero", (RErr, [String "device"]), 85, [],
2116 [InitBasicFS, Always, TestOutput (
2117 [["umount"; "/dev/sda1"];
2118 ["zero"; "/dev/sda1"];
2119 ["file"; "/dev/sda1"]], "data")],
2120 "write zeroes to the device",
2122 This command writes zeroes over the first few blocks of C<device>.
2124 How many blocks are zeroed isn't specified (but it's I<not> enough
2125 to securely wipe the device). It should be sufficient to remove
2126 any partition tables, filesystem superblocks and so on.
2128 See also: C<guestfs_scrub_device>.");
2130 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2131 (* Test disabled because grub-install incompatible with virtio-blk driver.
2132 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2134 [InitBasicFS, Disabled, TestOutputTrue (
2135 [["grub_install"; "/"; "/dev/sda1"];
2136 ["is_dir"; "/boot"]])],
2139 This command installs GRUB (the Grand Unified Bootloader) on
2140 C<device>, with the root directory being C<root>.");
2142 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2143 [InitBasicFS, Always, TestOutput (
2144 [["write_file"; "/old"; "file content"; "0"];
2145 ["cp"; "/old"; "/new"];
2146 ["cat"; "/new"]], "file content");
2147 InitBasicFS, Always, TestOutputTrue (
2148 [["write_file"; "/old"; "file content"; "0"];
2149 ["cp"; "/old"; "/new"];
2150 ["is_file"; "/old"]]);
2151 InitBasicFS, Always, TestOutput (
2152 [["write_file"; "/old"; "file content"; "0"];
2154 ["cp"; "/old"; "/dir/new"];
2155 ["cat"; "/dir/new"]], "file content")],
2158 This copies a file from C<src> to C<dest> where C<dest> is
2159 either a destination filename or destination directory.");
2161 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2162 [InitBasicFS, Always, TestOutput (
2163 [["mkdir"; "/olddir"];
2164 ["mkdir"; "/newdir"];
2165 ["write_file"; "/olddir/file"; "file content"; "0"];
2166 ["cp_a"; "/olddir"; "/newdir"];
2167 ["cat"; "/newdir/olddir/file"]], "file content")],
2168 "copy a file or directory recursively",
2170 This copies a file or directory from C<src> to C<dest>
2171 recursively using the C<cp -a> command.");
2173 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2174 [InitBasicFS, Always, TestOutput (
2175 [["write_file"; "/old"; "file content"; "0"];
2176 ["mv"; "/old"; "/new"];
2177 ["cat"; "/new"]], "file content");
2178 InitBasicFS, Always, TestOutputFalse (
2179 [["write_file"; "/old"; "file content"; "0"];
2180 ["mv"; "/old"; "/new"];
2181 ["is_file"; "/old"]])],
2184 This moves a file from C<src> to C<dest> where C<dest> is
2185 either a destination filename or destination directory.");
2187 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2188 [InitEmpty, Always, TestRun (
2189 [["drop_caches"; "3"]])],
2190 "drop kernel page cache, dentries and inodes",
2192 This instructs the guest kernel to drop its page cache,
2193 and/or dentries and inode caches. The parameter C<whattodrop>
2194 tells the kernel what precisely to drop, see
2195 L<http://linux-mm.org/Drop_Caches>
2197 Setting C<whattodrop> to 3 should drop everything.
2199 This automatically calls L<sync(2)> before the operation,
2200 so that the maximum guest memory is freed.");
2202 ("dmesg", (RString "kmsgs", []), 91, [],
2203 [InitEmpty, Always, TestRun (
2205 "return kernel messages",
2207 This returns the kernel messages (C<dmesg> output) from
2208 the guest kernel. This is sometimes useful for extended
2209 debugging of problems.
2211 Another way to get the same information is to enable
2212 verbose messages with C<guestfs_set_verbose> or by setting
2213 the environment variable C<LIBGUESTFS_DEBUG=1> before
2214 running the program.");
2216 ("ping_daemon", (RErr, []), 92, [],
2217 [InitEmpty, Always, TestRun (
2218 [["ping_daemon"]])],
2219 "ping the guest daemon",
2221 This is a test probe into the guestfs daemon running inside
2222 the qemu subprocess. Calling this function checks that the
2223 daemon responds to the ping message, without affecting the daemon
2224 or attached block device(s) in any other way.");
2226 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2227 [InitBasicFS, Always, TestOutputTrue (
2228 [["write_file"; "/file1"; "contents of a file"; "0"];
2229 ["cp"; "/file1"; "/file2"];
2230 ["equal"; "/file1"; "/file2"]]);
2231 InitBasicFS, Always, TestOutputFalse (
2232 [["write_file"; "/file1"; "contents of a file"; "0"];
2233 ["write_file"; "/file2"; "contents of another file"; "0"];
2234 ["equal"; "/file1"; "/file2"]]);
2235 InitBasicFS, Always, TestLastFail (
2236 [["equal"; "/file1"; "/file2"]])],
2237 "test if two files have equal contents",
2239 This compares the two files C<file1> and C<file2> and returns
2240 true if their content is exactly equal, or false otherwise.
2242 The external L<cmp(1)> program is used for the comparison.");
2244 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2245 [InitBasicFS, Always, TestOutputList (
2246 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2247 ["strings"; "/new"]], ["hello"; "world"]);
2248 InitBasicFS, Always, TestOutputList (
2250 ["strings"; "/new"]], [])],
2251 "print the printable strings in a file",
2253 This runs the L<strings(1)> command on a file and returns
2254 the list of printable strings found.");
2256 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2257 [InitBasicFS, Always, TestOutputList (
2258 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2259 ["strings_e"; "b"; "/new"]], []);
2260 InitBasicFS, Disabled, TestOutputList (
2261 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2262 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2263 "print the printable strings in a file",
2265 This is like the C<guestfs_strings> command, but allows you to
2266 specify the encoding.
2268 See the L<strings(1)> manpage for the full list of encodings.
2270 Commonly useful encodings are C<l> (lower case L) which will
2271 show strings inside Windows/x86 files.
2273 The returned strings are transcoded to UTF-8.");
2275 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2276 [InitBasicFS, Always, TestOutput (
2277 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2278 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n");
2279 (* Test for RHBZ#501888c2 regression which caused large hexdump
2280 * commands to segfault.
2282 InitBasicFS, Always, TestRun (
2283 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2284 ["hexdump"; "/100krandom"]])],
2285 "dump a file in hexadecimal",
2287 This runs C<hexdump -C> on the given C<path>. The result is
2288 the human-readable, canonical hex dump of the file.");
2290 ("zerofree", (RErr, [String "device"]), 97, [],
2291 [InitNone, Always, TestOutput (
2292 [["sfdiskM"; "/dev/sda"; ","];
2293 ["mkfs"; "ext3"; "/dev/sda1"];
2294 ["mount"; "/dev/sda1"; "/"];
2295 ["write_file"; "/new"; "test file"; "0"];
2296 ["umount"; "/dev/sda1"];
2297 ["zerofree"; "/dev/sda1"];
2298 ["mount"; "/dev/sda1"; "/"];
2299 ["cat"; "/new"]], "test file")],
2300 "zero unused inodes and disk blocks on ext2/3 filesystem",
2302 This runs the I<zerofree> program on C<device>. This program
2303 claims to zero unused inodes and disk blocks on an ext2/3
2304 filesystem, thus making it possible to compress the filesystem
2307 You should B<not> run this program if the filesystem is
2310 It is possible that using this program can damage the filesystem
2311 or data on the filesystem.");
2313 ("pvresize", (RErr, [String "device"]), 98, [],
2315 "resize an LVM physical volume",
2317 This resizes (expands or shrinks) an existing LVM physical
2318 volume to match the new size of the underlying device.");
2320 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2321 Int "cyls"; Int "heads"; Int "sectors";
2322 String "line"]), 99, [DangerWillRobinson],
2324 "modify a single partition on a block device",
2326 This runs L<sfdisk(8)> option to modify just the single
2327 partition C<n> (note: C<n> counts from 1).
2329 For other parameters, see C<guestfs_sfdisk>. You should usually
2330 pass C<0> for the cyls/heads/sectors parameters.");
2332 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2334 "display the partition table",
2336 This displays the partition table on C<device>, in the
2337 human-readable output of the L<sfdisk(8)> command. It is
2338 not intended to be parsed.");
2340 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2342 "display the kernel geometry",
2344 This displays the kernel's idea of the geometry of C<device>.
2346 The result is in human-readable format, and not designed to
2349 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2351 "display the disk geometry from the partition table",
2353 This displays the disk geometry of C<device> read from the
2354 partition table. Especially in the case where the underlying
2355 block device has been resized, this can be different from the
2356 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2358 The result is in human-readable format, and not designed to
2361 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2363 "activate or deactivate all volume groups",
2365 This command activates or (if C<activate> is false) deactivates
2366 all logical volumes in all volume groups.
2367 If activated, then they are made known to the
2368 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2369 then those devices disappear.
2371 This command is the same as running C<vgchange -a y|n>");
2373 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2375 "activate or deactivate some volume groups",
2377 This command activates or (if C<activate> is false) deactivates
2378 all logical volumes in the listed volume groups C<volgroups>.
2379 If activated, then they are made known to the
2380 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2381 then those devices disappear.
2383 This command is the same as running C<vgchange -a y|n volgroups...>
2385 Note that if C<volgroups> is an empty list then B<all> volume groups
2386 are activated or deactivated.");
2388 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2389 [InitNone, Always, TestOutput (
2390 [["sfdiskM"; "/dev/sda"; ","];
2391 ["pvcreate"; "/dev/sda1"];
2392 ["vgcreate"; "VG"; "/dev/sda1"];
2393 ["lvcreate"; "LV"; "VG"; "10"];
2394 ["mkfs"; "ext2"; "/dev/VG/LV"];
2395 ["mount"; "/dev/VG/LV"; "/"];
2396 ["write_file"; "/new"; "test content"; "0"];
2398 ["lvresize"; "/dev/VG/LV"; "20"];
2399 ["e2fsck_f"; "/dev/VG/LV"];
2400 ["resize2fs"; "/dev/VG/LV"];
2401 ["mount"; "/dev/VG/LV"; "/"];
2402 ["cat"; "/new"]], "test content")],
2403 "resize an LVM logical volume",
2405 This resizes (expands or shrinks) an existing LVM logical
2406 volume to C<mbytes>. When reducing, data in the reduced part
2409 ("resize2fs", (RErr, [String "device"]), 106, [],
2410 [], (* lvresize tests this *)
2411 "resize an ext2/ext3 filesystem",
2413 This resizes an ext2 or ext3 filesystem to match the size of
2414 the underlying device.
2416 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2417 on the C<device> before calling this command. For unknown reasons
2418 C<resize2fs> sometimes gives an error about this and sometimes not.
2419 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2420 calling this function.");
2422 ("find", (RStringList "names", [String "directory"]), 107, [],
2423 [InitBasicFS, Always, TestOutputList (
2424 [["find"; "/"]], ["lost+found"]);
2425 InitBasicFS, Always, TestOutputList (
2429 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2430 InitBasicFS, Always, TestOutputList (
2431 [["mkdir_p"; "/a/b/c"];
2432 ["touch"; "/a/b/c/d"];
2433 ["find"; "/a/b/"]], ["c"; "c/d"])],
2434 "find all files and directories",
2436 This command lists out all files and directories, recursively,
2437 starting at C<directory>. It is essentially equivalent to
2438 running the shell command C<find directory -print> but some
2439 post-processing happens on the output, described below.
2441 This returns a list of strings I<without any prefix>. Thus
2442 if the directory structure was:
2448 then the returned list from C<guestfs_find> C</tmp> would be
2456 If C<directory> is not a directory, then this command returns
2459 The returned list is sorted.");
2461 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2462 [], (* lvresize tests this *)
2463 "check an ext2/ext3 filesystem",
2465 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2466 filesystem checker on C<device>, noninteractively (C<-p>),
2467 even if the filesystem appears to be clean (C<-f>).
2469 This command is only needed because of C<guestfs_resize2fs>
2470 (q.v.). Normally you should use C<guestfs_fsck>.");
2472 ("sleep", (RErr, [Int "secs"]), 109, [],
2473 [InitNone, Always, TestRun (
2475 "sleep for some seconds",
2477 Sleep for C<secs> seconds.");
2479 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2480 [InitNone, Always, TestOutputInt (
2481 [["sfdiskM"; "/dev/sda"; ","];
2482 ["mkfs"; "ntfs"; "/dev/sda1"];
2483 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2484 InitNone, Always, TestOutputInt (
2485 [["sfdiskM"; "/dev/sda"; ","];
2486 ["mkfs"; "ext2"; "/dev/sda1"];
2487 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2488 "probe NTFS volume",
2490 This command runs the L<ntfs-3g.probe(8)> command which probes
2491 an NTFS C<device> for mountability. (Not all NTFS volumes can
2492 be mounted read-write, and some cannot be mounted at all).
2494 C<rw> is a boolean flag. Set it to true if you want to test
2495 if the volume can be mounted read-write. Set it to false if
2496 you want to test if the volume can be mounted read-only.
2498 The return value is an integer which C<0> if the operation
2499 would succeed, or some non-zero value documented in the
2500 L<ntfs-3g.probe(8)> manual page.");
2502 ("sh", (RString "output", [String "command"]), 111, [],
2503 [], (* XXX needs tests *)
2504 "run a command via the shell",
2506 This call runs a command from the guest filesystem via the
2509 This is like C<guestfs_command>, but passes the command to:
2511 /bin/sh -c \"command\"
2513 Depending on the guest's shell, this usually results in
2514 wildcards being expanded, shell expressions being interpolated
2517 All the provisos about C<guestfs_command> apply to this call.");
2519 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2520 [], (* XXX needs tests *)
2521 "run a command via the shell returning lines",
2523 This is the same as C<guestfs_sh>, but splits the result
2524 into a list of lines.
2526 See also: C<guestfs_command_lines>");
2528 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2529 [InitBasicFS, Always, TestOutputList (
2530 [["mkdir_p"; "/a/b/c"];
2531 ["touch"; "/a/b/c/d"];
2532 ["touch"; "/a/b/c/e"];
2533 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2534 InitBasicFS, Always, TestOutputList (
2535 [["mkdir_p"; "/a/b/c"];
2536 ["touch"; "/a/b/c/d"];
2537 ["touch"; "/a/b/c/e"];
2538 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2539 InitBasicFS, Always, TestOutputList (
2540 [["mkdir_p"; "/a/b/c"];
2541 ["touch"; "/a/b/c/d"];
2542 ["touch"; "/a/b/c/e"];
2543 ["glob_expand"; "/a/*/x/*"]], [])],
2544 "expand a wildcard path",
2546 This command searches for all the pathnames matching
2547 C<pattern> according to the wildcard expansion rules
2550 If no paths match, then this returns an empty list
2551 (note: not an error).
2553 It is just a wrapper around the C L<glob(3)> function
2554 with flags C<GLOB_MARK|GLOB_BRACE>.
2555 See that manual page for more details.");
2557 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2558 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2559 [["scrub_device"; "/dev/sdc"]])],
2560 "scrub (securely wipe) a device",
2562 This command writes patterns over C<device> to make data retrieval
2565 It is an interface to the L<scrub(1)> program. See that
2566 manual page for more details.");
2568 ("scrub_file", (RErr, [String "file"]), 115, [],
2569 [InitBasicFS, Always, TestRun (
2570 [["write_file"; "/file"; "content"; "0"];
2571 ["scrub_file"; "/file"]])],
2572 "scrub (securely wipe) a file",
2574 This command writes patterns over a file to make data retrieval
2577 The file is I<removed> after scrubbing.
2579 It is an interface to the L<scrub(1)> program. See that
2580 manual page for more details.");
2582 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2583 [], (* XXX needs testing *)
2584 "scrub (securely wipe) free space",
2586 This command creates the directory C<dir> and then fills it
2587 with files until the filesystem is full, and scrubs the files
2588 as for C<guestfs_scrub_file>, and deletes them.
2589 The intention is to scrub any free space on the partition
2592 It is an interface to the L<scrub(1)> program. See that
2593 manual page for more details.");
2595 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2596 [InitBasicFS, Always, TestRun (
2598 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2599 "create a temporary directory",
2601 This command creates a temporary directory. The
2602 C<template> parameter should be a full pathname for the
2603 temporary directory name with the final six characters being
2606 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2607 the second one being suitable for Windows filesystems.
2609 The name of the temporary directory that was created
2612 The temporary directory is created with mode 0700
2613 and is owned by root.
2615 The caller is responsible for deleting the temporary
2616 directory and its contents after use.
2618 See also: L<mkdtemp(3)>");
2620 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2621 [InitBasicFS, Always, TestOutputInt (
2622 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2623 ["wc_l"; "/10klines"]], 10000)],
2624 "count lines in a file",
2626 This command counts the lines in a file, using the
2627 C<wc -l> external command.");
2629 ("wc_w", (RInt "words", [String "path"]), 119, [],
2630 [InitBasicFS, Always, TestOutputInt (
2631 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2632 ["wc_w"; "/10klines"]], 10000)],
2633 "count words in a file",
2635 This command counts the words in a file, using the
2636 C<wc -w> external command.");
2638 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2639 [InitBasicFS, Always, TestOutputInt (
2640 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2641 ["wc_c"; "/100kallspaces"]], 102400)],
2642 "count characters in a file",
2644 This command counts the characters in a file, using the
2645 C<wc -c> external command.");
2647 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2648 [InitBasicFS, Always, TestOutputList (
2649 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2650 ["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2651 "return first 10 lines of a file",
2653 This command returns up to the first 10 lines of a file as
2654 a list of strings.");
2656 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2657 [InitBasicFS, Always, TestOutputList (
2658 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2659 ["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2660 InitBasicFS, Always, TestOutputList (
2661 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2662 ["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2663 InitBasicFS, Always, TestOutputList (
2664 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2665 ["head_n"; "0"; "/10klines"]], [])],
2666 "return first N lines of a file",
2668 If the parameter C<nrlines> is a positive number, this returns the first
2669 C<nrlines> lines of the file C<path>.
2671 If the parameter C<nrlines> is a negative number, this returns lines
2672 from the file C<path>, excluding the last C<nrlines> lines.
2674 If the parameter C<nrlines> is zero, this returns an empty list.");
2676 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2677 [InitBasicFS, Always, TestOutputList (
2678 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2679 ["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2680 "return last 10 lines of a file",
2682 This command returns up to the last 10 lines of a file as
2683 a list of strings.");
2685 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2686 [InitBasicFS, Always, TestOutputList (
2687 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2688 ["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2689 InitBasicFS, Always, TestOutputList (
2690 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2691 ["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2692 InitBasicFS, Always, TestOutputList (
2693 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2694 ["tail_n"; "0"; "/10klines"]], [])],
2695 "return last N lines of a file",
2697 If the parameter C<nrlines> is a positive number, this returns the last
2698 C<nrlines> lines of the file C<path>.
2700 If the parameter C<nrlines> is a negative number, this returns lines
2701 from the file C<path>, starting with the C<-nrlines>th line.
2703 If the parameter C<nrlines> is zero, this returns an empty list.");
2705 ("df", (RString "output", []), 125, [],
2706 [], (* XXX Tricky to test because it depends on the exact format
2707 * of the 'df' command and other imponderables.
2709 "report file system disk space usage",
2711 This command runs the C<df> command to report disk space used.
2713 This command is mostly useful for interactive sessions. It
2714 is I<not> intended that you try to parse the output string.
2715 Use C<statvfs> from programs.");
2717 ("df_h", (RString "output", []), 126, [],
2718 [], (* XXX Tricky to test because it depends on the exact format
2719 * of the 'df' command and other imponderables.
2721 "report file system disk space usage (human readable)",
2723 This command runs the C<df -h> command to report disk space used
2724 in human-readable format.
2726 This command is mostly useful for interactive sessions. It
2727 is I<not> intended that you try to parse the output string.
2728 Use C<statvfs> from programs.");
2730 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2731 [InitBasicFS, Always, TestOutputInt (
2733 ["du"; "/p"]], 1 (* ie. 1 block, so depends on ext3 blocksize *))],
2734 "estimate file space usage",
2736 This command runs the C<du -s> command to estimate file space
2739 C<path> can be a file or a directory. If C<path> is a directory
2740 then the estimate includes the contents of the directory and all
2741 subdirectories (recursively).
2743 The result is the estimated size in I<kilobytes>
2744 (ie. units of 1024 bytes).");
2746 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2747 [InitBasicFS, Always, TestOutputList (
2748 [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2749 ["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3"])],
2750 "list files in an initrd",
2752 This command lists out files contained in an initrd.
2754 The files are listed without any initial C</> character. The
2755 files are listed in the order they appear (not necessarily
2756 alphabetical). Directory names are listed as separate items.
2758 Old Linux kernels (2.4 and earlier) used a compressed ext2
2759 filesystem as initrd. We I<only> support the newer initramfs
2760 format (compressed cpio files).");
2762 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2764 "mount a file using the loop device",
2766 This command lets you mount C<file> (a filesystem image
2767 in a file) on a mount point. It is entirely equivalent to
2768 the command C<mount -o loop file mountpoint>.");
2770 ("mkswap", (RErr, [String "device"]), 130, [],
2771 [InitEmpty, Always, TestRun (
2772 [["sfdiskM"; "/dev/sda"; ","];
2773 ["mkswap"; "/dev/sda1"]])],
2774 "create a swap partition",
2776 Create a swap partition on C<device>.");
2778 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2779 [InitEmpty, Always, TestRun (
2780 [["sfdiskM"; "/dev/sda"; ","];
2781 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2782 "create a swap partition with a label",
2784 Create a swap partition on C<device> with label C<label>.");
2786 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2787 [InitEmpty, Always, TestRun (
2788 [["sfdiskM"; "/dev/sda"; ","];
2789 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2790 "create a swap partition with an explicit UUID",
2792 Create a swap partition on C<device> with UUID C<uuid>.");
2794 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2795 [InitBasicFS, Always, TestOutputStruct (
2796 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2797 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2798 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2799 InitBasicFS, Always, TestOutputStruct (
2800 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2801 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2802 "make block, character or FIFO devices",
2804 This call creates block or character special devices, or
2805 named pipes (FIFOs).
2807 The C<mode> parameter should be the mode, using the standard
2808 constants. C<devmajor> and C<devminor> are the
2809 device major and minor numbers, only used when creating block
2810 and character special devices.");
2812 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2813 [InitBasicFS, Always, TestOutputStruct (
2814 [["mkfifo"; "0o777"; "/node"];
2815 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2816 "make FIFO (named pipe)",
2818 This call creates a FIFO (named pipe) called C<path> with
2819 mode C<mode>. It is just a convenient wrapper around
2820 C<guestfs_mknod>.");
2822 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2823 [InitBasicFS, Always, TestOutputStruct (
2824 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2825 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2826 "make block device node",
2828 This call creates a block device node called C<path> with
2829 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2830 It is just a convenient wrapper around C<guestfs_mknod>.");
2832 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2833 [InitBasicFS, Always, TestOutputStruct (
2834 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2835 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2836 "make char device node",
2838 This call creates a char device node called C<path> with
2839 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2840 It is just a convenient wrapper around C<guestfs_mknod>.");
2842 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2843 [], (* XXX umask is one of those stateful things that we should
2844 * reset between each test.
2846 "set file mode creation mask (umask)",
2848 This function sets the mask used for creating new files and
2849 device nodes to C<mask & 0777>.
2851 Typical umask values would be C<022> which creates new files
2852 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2853 C<002> which creates new files with permissions like
2854 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2856 The default umask is C<022>. This is important because it
2857 means that directories and device nodes will be created with
2858 C<0644> or C<0755> mode even if you specify C<0777>.
2860 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2862 This call returns the previous umask.");
2864 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2866 "read directories entries",
2868 This returns the list of directory entries in directory C<dir>.
2870 All entries in the directory are returned, including C<.> and
2871 C<..>. The entries are I<not> sorted, but returned in the same
2872 order as the underlying filesystem.
2874 Also this call returns basic file type information about each
2875 file. The C<ftyp> field will contain one of the following characters:
2913 The L<readdir(3)> returned a C<d_type> field with an
2918 This function is primarily intended for use by programs. To
2919 get a simple list of names, use C<guestfs_ls>. To get a printable
2920 directory for human consumption, use C<guestfs_ll>.");
2922 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2924 "create partitions on a block device",
2926 This is a simplified interface to the C<guestfs_sfdisk>
2927 command, where partition sizes are specified in megabytes
2928 only (rounded to the nearest cylinder) and you don't need
2929 to specify the cyls, heads and sectors parameters which
2930 were rarely if ever used anyway.
2932 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2934 ("zfile", (RString "description", [String "method"; String "path"]), 140, [],
2936 "determine file type inside a compressed file",
2938 This command runs C<file> after first decompressing C<path>
2941 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
2943 See also: C<guestfs_file>");
2945 ("getxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 141, [],
2947 "list extended attributes of a file or directory",
2949 This call lists the extended attributes of the file or directory
2952 At the system call level, this is a combination of the
2953 L<listxattr(2)> and L<getxattr(2)> calls.
2955 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
2957 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 142, [],
2959 "list extended attributes of a file or directory",
2961 This is the same as C<guestfs_getxattrs>, but if C<path>
2962 is a symbolic link, then it returns the extended attributes
2963 of the link itself.");
2965 ("setxattr", (RErr, [String "xattr";
2966 String "val"; Int "vallen"; (* will be BufferIn *)
2967 String "path"]), 143, [],
2969 "set extended attribute of a file or directory",
2971 This call sets the extended attribute named C<xattr>
2972 of the file C<path> to the value C<val> (of length C<vallen>).
2973 The value is arbitrary 8 bit data.
2975 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
2977 ("lsetxattr", (RErr, [String "xattr";
2978 String "val"; Int "vallen"; (* will be BufferIn *)
2979 String "path"]), 144, [],
2981 "set extended attribute of a file or directory",
2983 This is the same as C<guestfs_setxattr>, but if C<path>
2984 is a symbolic link, then it sets an extended attribute
2985 of the link itself.");
2987 ("removexattr", (RErr, [String "xattr"; String "path"]), 145, [],
2989 "remove extended attribute of a file or directory",
2991 This call removes the extended attribute named C<xattr>
2992 of the file C<path>.
2994 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
2996 ("lremovexattr", (RErr, [String "xattr"; String "path"]), 146, [],
2998 "remove extended attribute of a file or directory",
3000 This is the same as C<guestfs_removexattr>, but if C<path>
3001 is a symbolic link, then it removes an extended attribute
3002 of the link itself.");
3004 ("mountpoints", (RHashtable "mps", []), 147, [],
3008 This call is similar to C<guestfs_mounts>. That call returns
3009 a list of devices. This one returns a hash table (map) of
3010 device name to directory where the device is mounted.");
3012 ("mkmountpoint", (RErr, [String "path"]), 148, [],
3014 "create a mountpoint",
3016 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3017 specialized calls that can be used to create extra mountpoints
3018 before mounting the first filesystem.
3020 These calls are I<only> necessary in some very limited circumstances,
3021 mainly the case where you want to mount a mix of unrelated and/or
3022 read-only filesystems together.
3024 For example, live CDs often contain a \"Russian doll\" nest of
3025 filesystems, an ISO outer layer, with a squashfs image inside, with
3026 an ext2/3 image inside that. You can unpack this as follows
3029 add-ro Fedora-11-i686-Live.iso
3032 mkmountpoint /squash
3035 mount-loop /cd/LiveOS/squashfs.img /squash
3036 mount-loop /squash/LiveOS/ext3fs.img /ext3
3038 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3040 ("rmmountpoint", (RErr, [String "path"]), 149, [],
3042 "remove a mountpoint",
3044 This calls removes a mountpoint that was previously created
3045 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3046 for full details.");
3048 ("read_file", (RBufferOut "content", [String "path"]), 150, [ProtocolLimitWarning],
3049 [InitBasicFS, Always, TestOutput (
3050 [["write_file"; "/new"; "new file contents"; "0"];
3051 ["read_file"; "/new"]], "new file contents")],
3054 This calls returns the contents of the file C<path> as a
3057 Unlike C<guestfs_cat>, this function can correctly
3058 handle files that contain embedded ASCII NUL characters.
3059 However unlike C<guestfs_download>, this function is limited
3060 in the total size of file that can be handled.");
3064 let all_functions = non_daemon_functions @ daemon_functions
3066 (* In some places we want the functions to be displayed sorted
3067 * alphabetically, so this is useful:
3069 let all_functions_sorted =
3070 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3071 compare n1 n2) all_functions
3073 (* Field types for structures. *)
3075 | FChar (* C 'char' (really, a 7 bit byte). *)
3076 | FString (* nul-terminated ASCII string. *)
3077 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3082 | FBytes (* Any int measure that counts bytes. *)
3083 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3084 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3086 (* Because we generate extra parsing code for LVM command line tools,
3087 * we have to pull out the LVM columns separately here.
3097 "pv_attr", FString (* XXX *);
3098 "pv_pe_count", FInt64;
3099 "pv_pe_alloc_count", FInt64;
3102 "pv_mda_count", FInt64;
3103 "pv_mda_free", FBytes;
3104 (* Not in Fedora 10:
3105 "pv_mda_size", FBytes;
3112 "vg_attr", FString (* XXX *);
3115 "vg_sysid", FString;
3116 "vg_extent_size", FBytes;
3117 "vg_extent_count", FInt64;
3118 "vg_free_count", FInt64;
3123 "snap_count", FInt64;
3126 "vg_mda_count", FInt64;
3127 "vg_mda_free", FBytes;
3128 (* Not in Fedora 10:
3129 "vg_mda_size", FBytes;
3135 "lv_attr", FString (* XXX *);
3138 "lv_kernel_major", FInt64;
3139 "lv_kernel_minor", FInt64;
3141 "seg_count", FInt64;
3143 "snap_percent", FOptPercent;
3144 "copy_percent", FOptPercent;
3147 "mirror_log", FString;
3151 (* Names and fields in all structures (in RStruct and RStructList)
3155 (* The old RIntBool return type, only ever used for aug_defnode. Do
3156 * not use this struct in any new code.
3159 "i", FInt32; (* for historical compatibility *)
3160 "b", FInt32; (* for historical compatibility *)
3163 (* LVM PVs, VGs, LVs. *)
3164 "lvm_pv", lvm_pv_cols;
3165 "lvm_vg", lvm_vg_cols;
3166 "lvm_lv", lvm_lv_cols;
3168 (* Column names and types from stat structures.
3169 * NB. Can't use things like 'st_atime' because glibc header files
3170 * define some of these as macros. Ugh.
3201 (* Column names in dirent structure. *)
3204 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3209 (* Version numbers. *)
3217 (* Extended attribute. *)
3219 "attrname", FString;
3222 ] (* end of structs *)
3224 (* Ugh, Java has to be different ..
3225 * These names are also used by the Haskell bindings.
3227 let java_structs = [
3228 "int_bool", "IntBool";
3233 "statvfs", "StatVFS";
3235 "version", "Version";
3239 (* Used for testing language bindings. *)
3241 | CallString of string
3242 | CallOptString of string option
3243 | CallStringList of string list
3247 (* Used to memoize the result of pod2text. *)
3248 let pod2text_memo_filename = "src/.pod2text.data"
3249 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3251 let chan = open_in pod2text_memo_filename in
3252 let v = input_value chan in
3256 _ -> Hashtbl.create 13
3258 (* Useful functions.
3259 * Note we don't want to use any external OCaml libraries which
3260 * makes this a bit harder than it should be.
3262 let failwithf fs = ksprintf failwith fs
3264 let replace_char s c1 c2 =
3265 let s2 = String.copy s in
3266 let r = ref false in
3267 for i = 0 to String.length s2 - 1 do
3268 if String.unsafe_get s2 i = c1 then (
3269 String.unsafe_set s2 i c2;
3273 if not !r then s else s2
3277 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3279 let triml ?(test = isspace) str =
3281 let n = ref (String.length str) in
3282 while !n > 0 && test str.[!i]; do
3287 else String.sub str !i !n
3289 let trimr ?(test = isspace) str =
3290 let n = ref (String.length str) in
3291 while !n > 0 && test str.[!n-1]; do
3294 if !n = String.length str then str
3295 else String.sub str 0 !n
3297 let trim ?(test = isspace) str =
3298 trimr ~test (triml ~test str)
3300 let rec find s sub =
3301 let len = String.length s in
3302 let sublen = String.length sub in
3304 if i <= len-sublen then (
3306 if j < sublen then (
3307 if s.[i+j] = sub.[j] then loop2 (j+1)
3313 if r = -1 then loop (i+1) else r
3319 let rec replace_str s s1 s2 =
3320 let len = String.length s in
3321 let sublen = String.length s1 in
3322 let i = find s s1 in
3325 let s' = String.sub s 0 i in
3326 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3327 s' ^ s2 ^ replace_str s'' s1 s2
3330 let rec string_split sep str =
3331 let len = String.length str in
3332 let seplen = String.length sep in
3333 let i = find str sep in
3334 if i = -1 then [str]
3336 let s' = String.sub str 0 i in
3337 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3338 s' :: string_split sep s''
3341 let files_equal n1 n2 =
3342 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3343 match Sys.command cmd with
3346 | i -> failwithf "%s: failed with error code %d" cmd i
3348 let rec find_map f = function
3349 | [] -> raise Not_found
3353 | None -> find_map f xs
3356 let rec loop i = function
3358 | x :: xs -> f i x; loop (i+1) xs
3363 let rec loop i = function
3365 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3369 let name_of_argt = function
3370 | String n | OptString n | StringList n | Bool n | Int n
3371 | FileIn n | FileOut n -> n
3373 let java_name_of_struct typ =
3374 try List.assoc typ java_structs
3377 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3379 let cols_of_struct typ =
3380 try List.assoc typ structs
3382 failwithf "cols_of_struct: unknown struct %s" typ
3384 let seq_of_test = function
3385 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3386 | TestOutputListOfDevices (s, _)
3387 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3388 | TestOutputTrue s | TestOutputFalse s
3389 | TestOutputLength (s, _) | TestOutputStruct (s, _)
3390 | TestLastFail s -> s
3392 (* Check function names etc. for consistency. *)
3393 let check_functions () =
3394 let contains_uppercase str =
3395 let len = String.length str in
3397 if i >= len then false
3400 if c >= 'A' && c <= 'Z' then true
3407 (* Check function names. *)
3409 fun (name, _, _, _, _, _, _) ->
3410 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3411 failwithf "function name %s does not need 'guestfs' prefix" name;
3413 failwithf "function name is empty";
3414 if name.[0] < 'a' || name.[0] > 'z' then
3415 failwithf "function name %s must start with lowercase a-z" name;
3416 if String.contains name '-' then
3417 failwithf "function name %s should not contain '-', use '_' instead."
3421 (* Check function parameter/return names. *)
3423 fun (name, style, _, _, _, _, _) ->
3424 let check_arg_ret_name n =
3425 if contains_uppercase n then
3426 failwithf "%s param/ret %s should not contain uppercase chars"
3428 if String.contains n '-' || String.contains n '_' then
3429 failwithf "%s param/ret %s should not contain '-' or '_'"
3432 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;
3433 if n = "int" || n = "char" || n = "short" || n = "long" then
3434 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3435 if n = "i" || n = "n" then
3436 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3437 if n = "argv" || n = "args" then
3438 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3441 (match fst style with
3443 | RInt n | RInt64 n | RBool n
3444 | RConstString n | RConstOptString n | RString n
3445 | RStringList n | RStruct (n, _) | RStructList (n, _)
3446 | RHashtable n | RBufferOut n ->
3447 check_arg_ret_name n
3449 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3452 (* Check short descriptions. *)
3454 fun (name, _, _, _, _, shortdesc, _) ->
3455 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3456 failwithf "short description of %s should begin with lowercase." name;
3457 let c = shortdesc.[String.length shortdesc-1] in
3458 if c = '\n' || c = '.' then
3459 failwithf "short description of %s should not end with . or \\n." name
3462 (* Check long dscriptions. *)
3464 fun (name, _, _, _, _, _, longdesc) ->
3465 if longdesc.[String.length longdesc-1] = '\n' then
3466 failwithf "long description of %s should not end with \\n." name
3469 (* Check proc_nrs. *)
3471 fun (name, _, proc_nr, _, _, _, _) ->
3472 if proc_nr <= 0 then
3473 failwithf "daemon function %s should have proc_nr > 0" name
3477 fun (name, _, proc_nr, _, _, _, _) ->
3478 if proc_nr <> -1 then
3479 failwithf "non-daemon function %s should have proc_nr -1" name
3480 ) non_daemon_functions;
3483 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3486 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3487 let rec loop = function
3490 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3492 | (name1,nr1) :: (name2,nr2) :: _ ->
3493 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3501 (* Ignore functions that have no tests. We generate a
3502 * warning when the user does 'make check' instead.
3504 | name, _, _, _, [], _, _ -> ()
3505 | name, _, _, _, tests, _, _ ->
3509 match seq_of_test test with
3511 failwithf "%s has a test containing an empty sequence" name
3512 | cmds -> List.map List.hd cmds
3514 let funcs = List.flatten funcs in
3516 let tested = List.mem name funcs in
3519 failwithf "function %s has tests but does not test itself" name
3522 (* 'pr' prints to the current output file. *)
3523 let chan = ref stdout
3524 let pr fs = ksprintf (output_string !chan) fs
3526 (* Generate a header block in a number of standard styles. *)
3527 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3528 type license = GPLv2 | LGPLv2
3530 let generate_header comment license =
3531 let c = match comment with
3532 | CStyle -> pr "/* "; " *"
3533 | HashStyle -> pr "# "; "#"
3534 | OCamlStyle -> pr "(* "; " *"
3535 | HaskellStyle -> pr "{- "; " " in
3536 pr "libguestfs generated file\n";
3537 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3538 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3540 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3544 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3545 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3546 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3547 pr "%s (at your option) any later version.\n" c;
3549 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3550 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3551 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3552 pr "%s GNU General Public License for more details.\n" c;
3554 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3555 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3556 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3559 pr "%s This library is free software; you can redistribute it and/or\n" c;
3560 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3561 pr "%s License as published by the Free Software Foundation; either\n" c;
3562 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3564 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3565 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3566 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3567 pr "%s Lesser General Public License for more details.\n" c;
3569 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3570 pr "%s License along with this library; if not, write to the Free Software\n" c;
3571 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3574 | CStyle -> pr " */\n"
3576 | OCamlStyle -> pr " *)\n"
3577 | HaskellStyle -> pr "-}\n"
3581 (* Start of main code generation functions below this line. *)
3583 (* Generate the pod documentation for the C API. *)
3584 let rec generate_actions_pod () =
3586 fun (shortname, style, _, flags, _, _, longdesc) ->
3587 if not (List.mem NotInDocs flags) then (
3588 let name = "guestfs_" ^ shortname in
3589 pr "=head2 %s\n\n" name;
3591 generate_prototype ~extern:false ~handle:"handle" name style;
3593 pr "%s\n\n" longdesc;
3594 (match fst style with
3596 pr "This function returns 0 on success or -1 on error.\n\n"
3598 pr "On error this function returns -1.\n\n"
3600 pr "On error this function returns -1.\n\n"
3602 pr "This function returns a C truth value on success or -1 on error.\n\n"
3604 pr "This function returns a string, or NULL on error.
3605 The string is owned by the guest handle and must I<not> be freed.\n\n"
3606 | RConstOptString _ ->
3607 pr "This function returns a string which may be NULL.
3608 There is way to return an error from this function.
3609 The string is owned by the guest handle and must I<not> be freed.\n\n"
3611 pr "This function returns a string, or NULL on error.
3612 I<The caller must free the returned string after use>.\n\n"
3614 pr "This function returns a NULL-terminated array of strings
3615 (like L<environ(3)>), or NULL if there was an error.
3616 I<The caller must free the strings and the array after use>.\n\n"
3617 | RStruct (_, typ) ->
3618 pr "This function returns a C<struct guestfs_%s *>,
3619 or NULL if there was an error.
3620 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3621 | RStructList (_, typ) ->
3622 pr "This function returns a C<struct guestfs_%s_list *>
3623 (see E<lt>guestfs-structs.hE<gt>),
3624 or NULL if there was an error.
3625 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3627 pr "This function returns a NULL-terminated array of
3628 strings, or NULL if there was an error.
3629 The array of strings will always have length C<2n+1>, where
3630 C<n> keys and values alternate, followed by the trailing NULL entry.
3631 I<The caller must free the strings and the array after use>.\n\n"
3633 pr "This function returns a buffer, or NULL on error.
3634 The size of the returned buffer is written to C<*size_r>.
3635 I<The caller must free the returned buffer after use>.\n\n"
3637 if List.mem ProtocolLimitWarning flags then
3638 pr "%s\n\n" protocol_limit_warning;
3639 if List.mem DangerWillRobinson flags then
3640 pr "%s\n\n" danger_will_robinson
3642 ) all_functions_sorted
3644 and generate_structs_pod () =
3645 (* Structs documentation. *)
3648 pr "=head2 guestfs_%s\n" typ;
3650 pr " struct guestfs_%s {\n" typ;
3653 | name, FChar -> pr " char %s;\n" name
3654 | name, FUInt32 -> pr " uint32_t %s;\n" name
3655 | name, FInt32 -> pr " int32_t %s;\n" name
3656 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3657 | name, FInt64 -> pr " int64_t %s;\n" name
3658 | name, FString -> pr " char *%s;\n" name
3660 pr " /* The next two fields describe a byte array. */\n";
3661 pr " uint32_t %s_len;\n" name;
3662 pr " char *%s;\n" name
3664 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3665 pr " char %s[32];\n" name
3666 | name, FOptPercent ->
3667 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3668 pr " float %s;\n" name
3672 pr " struct guestfs_%s_list {\n" typ;
3673 pr " uint32_t len; /* Number of elements in list. */\n";
3674 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
3677 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3678 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3683 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3684 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3686 * We have to use an underscore instead of a dash because otherwise
3687 * rpcgen generates incorrect code.
3689 * This header is NOT exported to clients, but see also generate_structs_h.
3691 and generate_xdr () =
3692 generate_header CStyle LGPLv2;
3694 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3695 pr "typedef string str<>;\n";
3698 (* Internal structures. *)
3702 pr "struct guestfs_int_%s {\n" typ;
3704 | name, FChar -> pr " char %s;\n" name
3705 | name, FString -> pr " string %s<>;\n" name
3706 | name, FBuffer -> pr " opaque %s<>;\n" name
3707 | name, FUUID -> pr " opaque %s[32];\n" name
3708 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
3709 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
3710 | name, FOptPercent -> pr " float %s;\n" name
3714 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3719 fun (shortname, style, _, _, _, _, _) ->
3720 let name = "guestfs_" ^ shortname in
3722 (match snd style with
3725 pr "struct %s_args {\n" name;
3728 | String n -> pr " string %s<>;\n" n
3729 | OptString n -> pr " str *%s;\n" n
3730 | StringList n -> pr " str %s<>;\n" n
3731 | Bool n -> pr " bool %s;\n" n
3732 | Int n -> pr " int %s;\n" n
3733 | FileIn _ | FileOut _ -> ()
3737 (match fst style with
3740 pr "struct %s_ret {\n" name;
3744 pr "struct %s_ret {\n" name;
3745 pr " hyper %s;\n" n;
3748 pr "struct %s_ret {\n" name;
3751 | RConstString _ | RConstOptString _ ->
3752 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
3754 pr "struct %s_ret {\n" name;
3755 pr " string %s<>;\n" n;
3758 pr "struct %s_ret {\n" name;
3759 pr " str %s<>;\n" n;
3761 | RStruct (n, typ) ->
3762 pr "struct %s_ret {\n" name;
3763 pr " guestfs_int_%s %s;\n" typ n;
3765 | RStructList (n, typ) ->
3766 pr "struct %s_ret {\n" name;
3767 pr " guestfs_int_%s_list %s;\n" typ n;
3770 pr "struct %s_ret {\n" name;
3771 pr " str %s<>;\n" n;
3774 pr "struct %s_ret {\n" name;
3775 pr " opaque %s<>;\n" n;
3780 (* Table of procedure numbers. *)
3781 pr "enum guestfs_procedure {\n";
3783 fun (shortname, _, proc_nr, _, _, _, _) ->
3784 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3786 pr " GUESTFS_PROC_NR_PROCS\n";
3790 (* Having to choose a maximum message size is annoying for several
3791 * reasons (it limits what we can do in the API), but it (a) makes
3792 * the protocol a lot simpler, and (b) provides a bound on the size
3793 * of the daemon which operates in limited memory space. For large
3794 * file transfers you should use FTP.
3796 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3799 (* Message header, etc. *)
3801 /* The communication protocol is now documented in the guestfs(3)
3805 const GUESTFS_PROGRAM = 0x2000F5F5;
3806 const GUESTFS_PROTOCOL_VERSION = 1;
3808 /* These constants must be larger than any possible message length. */
3809 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3810 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3812 enum guestfs_message_direction {
3813 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3814 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3817 enum guestfs_message_status {
3818 GUESTFS_STATUS_OK = 0,
3819 GUESTFS_STATUS_ERROR = 1
3822 const GUESTFS_ERROR_LEN = 256;
3824 struct guestfs_message_error {
3825 string error_message<GUESTFS_ERROR_LEN>;
3828 struct guestfs_message_header {
3829 unsigned prog; /* GUESTFS_PROGRAM */
3830 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3831 guestfs_procedure proc; /* GUESTFS_PROC_x */
3832 guestfs_message_direction direction;
3833 unsigned serial; /* message serial number */
3834 guestfs_message_status status;
3837 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3839 struct guestfs_chunk {
3840 int cancel; /* if non-zero, transfer is cancelled */
3841 /* data size is 0 bytes if the transfer has finished successfully */
3842 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3846 (* Generate the guestfs-structs.h file. *)
3847 and generate_structs_h () =
3848 generate_header CStyle LGPLv2;
3850 (* This is a public exported header file containing various
3851 * structures. The structures are carefully written to have
3852 * exactly the same in-memory format as the XDR structures that
3853 * we use on the wire to the daemon. The reason for creating
3854 * copies of these structures here is just so we don't have to
3855 * export the whole of guestfs_protocol.h (which includes much
3856 * unrelated and XDR-dependent stuff that we don't want to be
3857 * public, or required by clients).
3859 * To reiterate, we will pass these structures to and from the
3860 * client with a simple assignment or memcpy, so the format
3861 * must be identical to what rpcgen / the RFC defines.
3864 (* Public structures. *)
3867 pr "struct guestfs_%s {\n" typ;
3870 | name, FChar -> pr " char %s;\n" name
3871 | name, FString -> pr " char *%s;\n" name
3873 pr " uint32_t %s_len;\n" name;
3874 pr " char *%s;\n" name
3875 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3876 | name, FUInt32 -> pr " uint32_t %s;\n" name
3877 | name, FInt32 -> pr " int32_t %s;\n" name
3878 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3879 | name, FInt64 -> pr " int64_t %s;\n" name
3880 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3884 pr "struct guestfs_%s_list {\n" typ;
3885 pr " uint32_t len;\n";
3886 pr " struct guestfs_%s *val;\n" typ;
3889 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
3890 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
3894 (* Generate the guestfs-actions.h file. *)
3895 and generate_actions_h () =
3896 generate_header CStyle LGPLv2;
3898 fun (shortname, style, _, _, _, _, _) ->
3899 let name = "guestfs_" ^ shortname in
3900 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3904 (* Generate the client-side dispatch stubs. *)
3905 and generate_client_actions () =
3906 generate_header CStyle LGPLv2;
3912 #include \"guestfs.h\"
3913 #include \"guestfs_protocol.h\"
3915 #define error guestfs_error
3916 #define perrorf guestfs_perrorf
3917 #define safe_malloc guestfs_safe_malloc
3918 #define safe_realloc guestfs_safe_realloc
3919 #define safe_strdup guestfs_safe_strdup
3920 #define safe_memdup guestfs_safe_memdup
3922 /* Check the return message from a call for validity. */
3924 check_reply_header (guestfs_h *g,
3925 const struct guestfs_message_header *hdr,
3926 int proc_nr, int serial)
3928 if (hdr->prog != GUESTFS_PROGRAM) {
3929 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3932 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3933 error (g, \"wrong protocol version (%%d/%%d)\",
3934 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3937 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3938 error (g, \"unexpected message direction (%%d/%%d)\",
3939 hdr->direction, GUESTFS_DIRECTION_REPLY);
3942 if (hdr->proc != proc_nr) {
3943 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3946 if (hdr->serial != serial) {
3947 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3954 /* Check we are in the right state to run a high-level action. */
3956 check_state (guestfs_h *g, const char *caller)
3958 if (!guestfs_is_ready (g)) {
3959 if (guestfs_is_config (g))
3960 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
3962 else if (guestfs_is_launching (g))
3963 error (g, \"%%s: call wait_ready() before using this function\",
3966 error (g, \"%%s called from the wrong state, %%d != READY\",
3967 caller, guestfs_get_state (g));
3975 (* Client-side stubs for each function. *)
3977 fun (shortname, style, _, _, _, _, _) ->
3978 let name = "guestfs_" ^ shortname in
3980 (* Generate the context struct which stores the high-level
3981 * state between callback functions.
3983 pr "struct %s_ctx {\n" shortname;
3984 pr " /* This flag is set by the callbacks, so we know we've done\n";
3985 pr " * the callbacks as expected, and in the right sequence.\n";
3986 pr " * 0 = not called, 1 = reply_cb called.\n";
3988 pr " int cb_sequence;\n";
3989 pr " struct guestfs_message_header hdr;\n";
3990 pr " struct guestfs_message_error err;\n";
3991 (match fst style with
3993 | RConstString _ | RConstOptString _ ->
3994 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
3996 | RBool _ | RString _ | RStringList _
3997 | RStruct _ | RStructList _
3998 | RHashtable _ | RBufferOut _ ->
3999 pr " struct %s_ret ret;\n" name
4004 (* Generate the reply callback function. *)
4005 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4007 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4008 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4010 pr " /* This should definitely not happen. */\n";
4011 pr " if (ctx->cb_sequence != 0) {\n";
4012 pr " ctx->cb_sequence = 9999;\n";
4013 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4017 pr " ml->main_loop_quit (ml, g);\n";
4019 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4020 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4023 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4024 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4025 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4032 (match fst style with
4034 | RConstString _ | RConstOptString _ ->
4035 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4037 | RBool _ | RString _ | RStringList _
4038 | RStruct _ | RStructList _
4039 | RHashtable _ | RBufferOut _ ->
4040 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4041 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4047 pr " ctx->cb_sequence = 1;\n";
4050 (* Generate the action stub. *)
4051 generate_prototype ~extern:false ~semicolon:false ~newline:true
4052 ~handle:"g" name style;
4055 match fst style with
4056 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4057 | RConstString _ | RConstOptString _ ->
4058 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4059 | RString _ | RStringList _
4060 | RStruct _ | RStructList _
4061 | RHashtable _ | RBufferOut _ ->
4066 (match snd style with
4068 | _ -> pr " struct %s_args args;\n" name
4071 pr " struct %s_ctx ctx;\n" shortname;
4072 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4073 pr " int serial;\n";
4075 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4076 pr " guestfs_set_busy (g);\n";
4078 pr " memset (&ctx, 0, sizeof ctx);\n";
4081 (* Send the main header and arguments. *)
4082 (match snd style with
4084 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4085 (String.uppercase shortname)
4090 pr " args.%s = (char *) %s;\n" n n
4092 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4094 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4095 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4097 pr " args.%s = %s;\n" n n
4099 pr " args.%s = %s;\n" n n
4100 | FileIn _ | FileOut _ -> ()
4102 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4103 (String.uppercase shortname);
4104 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4107 pr " if (serial == -1) {\n";
4108 pr " guestfs_end_busy (g);\n";
4109 pr " return %s;\n" error_code;
4113 (* Send any additional files (FileIn) requested. *)
4114 let need_read_reply_label = ref false in
4121 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4122 pr " if (r == -1) {\n";
4123 pr " guestfs_end_busy (g);\n";
4124 pr " return %s;\n" error_code;
4126 pr " if (r == -2) /* daemon cancelled */\n";
4127 pr " goto read_reply;\n";
4128 need_read_reply_label := true;
4134 (* Wait for the reply from the remote end. *)
4135 if !need_read_reply_label then pr " read_reply:\n";
4136 pr " guestfs__switch_to_receiving (g);\n";
4137 pr " ctx.cb_sequence = 0;\n";
4138 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4139 pr " (void) ml->main_loop_run (ml, g);\n";
4140 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4141 pr " if (ctx.cb_sequence != 1) {\n";
4142 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4143 pr " guestfs_end_busy (g);\n";
4144 pr " return %s;\n" error_code;
4148 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4149 (String.uppercase shortname);
4150 pr " guestfs_end_busy (g);\n";
4151 pr " return %s;\n" error_code;
4155 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4156 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4157 pr " free (ctx.err.error_message);\n";
4158 pr " guestfs_end_busy (g);\n";
4159 pr " return %s;\n" error_code;
4163 (* Expecting to receive further files (FileOut)? *)
4167 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4168 pr " guestfs_end_busy (g);\n";
4169 pr " return %s;\n" error_code;
4175 pr " guestfs_end_busy (g);\n";
4177 (match fst style with
4178 | RErr -> pr " return 0;\n"
4179 | RInt n | RInt64 n | RBool n ->
4180 pr " return ctx.ret.%s;\n" n
4181 | RConstString _ | RConstOptString _ ->
4182 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4184 pr " return ctx.ret.%s; /* caller will free */\n" n
4185 | RStringList n | RHashtable n ->
4186 pr " /* caller will free this, but we need to add a NULL entry */\n";
4187 pr " ctx.ret.%s.%s_val =\n" n n;
4188 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4189 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4191 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4192 pr " return ctx.ret.%s.%s_val;\n" n n
4194 pr " /* caller will free this */\n";
4195 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4196 | RStructList (n, _) ->
4197 pr " /* caller will free this */\n";
4198 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4200 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4201 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4207 (* Functions to free structures. *)
4208 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4209 pr " * structure format is identical to the XDR format. See note in\n";
4210 pr " * generator.ml.\n";
4217 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4219 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4225 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4227 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4234 (* Generate daemon/actions.h. *)
4235 and generate_daemon_actions_h () =
4236 generate_header CStyle GPLv2;
4238 pr "#include \"../src/guestfs_protocol.h\"\n";
4242 fun (name, style, _, _, _, _, _) ->
4244 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4248 (* Generate the server-side stubs. *)
4249 and generate_daemon_actions () =
4250 generate_header CStyle GPLv2;
4252 pr "#include <config.h>\n";
4254 pr "#include <stdio.h>\n";
4255 pr "#include <stdlib.h>\n";
4256 pr "#include <string.h>\n";
4257 pr "#include <inttypes.h>\n";
4258 pr "#include <ctype.h>\n";
4259 pr "#include <rpc/types.h>\n";
4260 pr "#include <rpc/xdr.h>\n";
4262 pr "#include \"daemon.h\"\n";
4263 pr "#include \"../src/guestfs_protocol.h\"\n";
4264 pr "#include \"actions.h\"\n";
4268 fun (name, style, _, _, _, _, _) ->
4269 (* Generate server-side stubs. *)
4270 pr "static void %s_stub (XDR *xdr_in)\n" name;
4273 match fst style with
4274 | RErr | RInt _ -> pr " int r;\n"; "-1"
4275 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4276 | RBool _ -> pr " int r;\n"; "-1"
4277 | RConstString _ | RConstOptString _ ->
4278 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4279 | RString _ -> pr " char *r;\n"; "NULL"
4280 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4281 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4282 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4284 pr " size_t size;\n";
4288 (match snd style with
4291 pr " struct guestfs_%s_args args;\n" name;
4294 (* Note we allow the string to be writable, in order to
4295 * allow device name translation. This is safe because
4296 * we can modify the string (passed from RPC).
4299 | OptString n -> pr " char *%s;\n" n
4300 | StringList n -> pr " char **%s;\n" n
4301 | Bool n -> pr " int %s;\n" n
4302 | Int n -> pr " int %s;\n" n
4303 | FileIn _ | FileOut _ -> ()
4308 (match snd style with
4311 pr " memset (&args, 0, sizeof args);\n";
4313 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4314 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4319 | String n -> pr " %s = args.%s;\n" n n
4320 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4322 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4323 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4324 pr " if (%s == NULL) {\n" n;
4325 pr " reply_with_perror (\"realloc\");\n";
4328 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4329 pr " args.%s.%s_val = %s;\n" n n n;
4330 | Bool n -> pr " %s = args.%s;\n" n n
4331 | Int n -> pr " %s = args.%s;\n" n n
4332 | FileIn _ | FileOut _ -> ()
4337 (* Don't want to call the impl with any FileIn or FileOut
4338 * parameters, since these go "outside" the RPC protocol.
4341 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4343 pr " r = do_%s " name;
4344 generate_c_call_args (fst style, args');
4347 pr " if (r == %s)\n" error_code;
4348 pr " /* do_%s has already called reply_with_error */\n" name;
4352 (* If there are any FileOut parameters, then the impl must
4353 * send its own reply.
4356 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4358 pr " /* do_%s has already sent a reply */\n" name
4360 match fst style with
4361 | RErr -> pr " reply (NULL, NULL);\n"
4362 | RInt n | RInt64 n | RBool n ->
4363 pr " struct guestfs_%s_ret ret;\n" name;
4364 pr " ret.%s = r;\n" n;
4365 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4367 | RConstString _ | RConstOptString _ ->
4368 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4370 pr " struct guestfs_%s_ret ret;\n" name;
4371 pr " ret.%s = r;\n" n;
4372 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4375 | RStringList n | RHashtable n ->
4376 pr " struct guestfs_%s_ret ret;\n" name;
4377 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4378 pr " ret.%s.%s_val = r;\n" n n;
4379 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4381 pr " free_strings (r);\n"
4383 pr " struct guestfs_%s_ret ret;\n" name;
4384 pr " ret.%s = *r;\n" n;
4385 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4387 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4389 | RStructList (n, _) ->
4390 pr " struct guestfs_%s_ret ret;\n" name;
4391 pr " ret.%s = *r;\n" n;
4392 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4394 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4397 pr " struct guestfs_%s_ret ret;\n" name;
4398 pr " ret.%s.%s_val = r;\n" n n;
4399 pr " ret.%s.%s_len = size;\n" n n;
4400 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4405 (* Free the args. *)
4406 (match snd style with
4411 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4418 (* Dispatch function. *)
4419 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4421 pr " switch (proc_nr) {\n";
4424 fun (name, style, _, _, _, _, _) ->
4425 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4426 pr " %s_stub (xdr_in);\n" name;
4431 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";
4436 (* LVM columns and tokenization functions. *)
4437 (* XXX This generates crap code. We should rethink how we
4443 pr "static const char *lvm_%s_cols = \"%s\";\n"
4444 typ (String.concat "," (List.map fst cols));
4447 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4449 pr " char *tok, *p, *next;\n";
4453 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4456 pr " if (!str) {\n";
4457 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4460 pr " if (!*str || isspace (*str)) {\n";
4461 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4466 fun (name, coltype) ->
4467 pr " if (!tok) {\n";
4468 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4471 pr " p = strchrnul (tok, ',');\n";
4472 pr " if (*p) next = p+1; else next = NULL;\n";
4473 pr " *p = '\\0';\n";
4476 pr " r->%s = strdup (tok);\n" name;
4477 pr " if (r->%s == NULL) {\n" name;
4478 pr " perror (\"strdup\");\n";
4482 pr " for (i = j = 0; i < 32; ++j) {\n";
4483 pr " if (tok[j] == '\\0') {\n";
4484 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4486 pr " } else if (tok[j] != '-')\n";
4487 pr " r->%s[i++] = tok[j];\n" name;
4490 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4491 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4495 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4496 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4500 pr " if (tok[0] == '\\0')\n";
4501 pr " r->%s = -1;\n" name;
4502 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4503 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4506 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4507 assert false (* can never be an LVM column *)
4509 pr " tok = next;\n";
4512 pr " if (tok != NULL) {\n";
4513 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4520 pr "guestfs_int_lvm_%s_list *\n" typ;
4521 pr "parse_command_line_%ss (void)\n" typ;
4523 pr " char *out, *err;\n";
4524 pr " char *p, *pend;\n";
4526 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4527 pr " void *newp;\n";
4529 pr " ret = malloc (sizeof *ret);\n";
4530 pr " if (!ret) {\n";
4531 pr " reply_with_perror (\"malloc\");\n";
4532 pr " return NULL;\n";
4535 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4536 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4538 pr " r = command (&out, &err,\n";
4539 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4540 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4541 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4542 pr " if (r == -1) {\n";
4543 pr " reply_with_error (\"%%s\", err);\n";
4544 pr " free (out);\n";
4545 pr " free (err);\n";
4546 pr " free (ret);\n";
4547 pr " return NULL;\n";
4550 pr " free (err);\n";
4552 pr " /* Tokenize each line of the output. */\n";
4555 pr " while (p) {\n";
4556 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4557 pr " if (pend) {\n";
4558 pr " *pend = '\\0';\n";
4562 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4565 pr " if (!*p) { /* Empty line? Skip it. */\n";
4570 pr " /* Allocate some space to store this next entry. */\n";
4571 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4572 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4573 pr " if (newp == NULL) {\n";
4574 pr " reply_with_perror (\"realloc\");\n";
4575 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4576 pr " free (ret);\n";
4577 pr " free (out);\n";
4578 pr " return NULL;\n";
4580 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4582 pr " /* Tokenize the next entry. */\n";
4583 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4584 pr " if (r == -1) {\n";
4585 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4586 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4587 pr " free (ret);\n";
4588 pr " free (out);\n";
4589 pr " return NULL;\n";
4596 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4598 pr " free (out);\n";
4599 pr " return ret;\n";
4602 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4604 (* Generate a list of function names, for debugging in the daemon.. *)
4605 and generate_daemon_names () =
4606 generate_header CStyle GPLv2;
4608 pr "#include <config.h>\n";
4610 pr "#include \"daemon.h\"\n";
4613 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4614 pr "const char *function_names[] = {\n";
4616 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4620 (* Generate the tests. *)
4621 and generate_tests () =
4622 generate_header CStyle GPLv2;
4629 #include <sys/types.h>
4632 #include \"guestfs.h\"
4634 static guestfs_h *g;
4635 static int suppress_error = 0;
4637 static void print_error (guestfs_h *g, void *data, const char *msg)
4639 if (!suppress_error)
4640 fprintf (stderr, \"%%s\\n\", msg);
4643 static void print_strings (char * const * const argv)
4647 for (argc = 0; argv[argc] != NULL; ++argc)
4648 printf (\"\\t%%s\\n\", argv[argc]);
4652 static void print_table (char * const * const argv)
4656 for (i = 0; argv[i] != NULL; i += 2)
4657 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
4661 static void no_test_warnings (void)
4667 | name, _, _, _, [], _, _ ->
4668 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4669 | name, _, _, _, tests, _, _ -> ()
4675 (* Generate the actual tests. Note that we generate the tests
4676 * in reverse order, deliberately, so that (in general) the
4677 * newest tests run first. This makes it quicker and easier to
4682 fun (name, _, _, _, tests, _, _) ->
4683 mapi (generate_one_test name) tests
4684 ) (List.rev all_functions) in
4685 let test_names = List.concat test_names in
4686 let nr_tests = List.length test_names in
4689 int main (int argc, char *argv[])
4693 const char *filename;
4695 int nr_tests, test_num = 0;
4697 setbuf (stdout, NULL);
4699 no_test_warnings ();
4701 g = guestfs_create ();
4703 printf (\"guestfs_create FAILED\\n\");
4707 guestfs_set_error_handler (g, print_error, NULL);
4709 guestfs_set_path (g, \"../appliance\");
4711 filename = \"test1.img\";
4712 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4717 if (lseek (fd, %d, SEEK_SET) == -1) {
4723 if (write (fd, &c, 1) == -1) {
4729 if (close (fd) == -1) {
4734 if (guestfs_add_drive (g, filename) == -1) {
4735 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4739 filename = \"test2.img\";
4740 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4745 if (lseek (fd, %d, SEEK_SET) == -1) {
4751 if (write (fd, &c, 1) == -1) {
4757 if (close (fd) == -1) {
4762 if (guestfs_add_drive (g, filename) == -1) {
4763 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4767 filename = \"test3.img\";
4768 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4773 if (lseek (fd, %d, SEEK_SET) == -1) {
4779 if (write (fd, &c, 1) == -1) {
4785 if (close (fd) == -1) {
4790 if (guestfs_add_drive (g, filename) == -1) {
4791 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4795 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4796 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4800 if (guestfs_launch (g) == -1) {
4801 printf (\"guestfs_launch FAILED\\n\");
4805 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4808 if (guestfs_wait_ready (g) == -1) {
4809 printf (\"guestfs_wait_ready FAILED\\n\");
4813 /* Cancel previous alarm. */
4818 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4822 pr " test_num++;\n";
4823 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4824 pr " if (%s () == -1) {\n" test_name;
4825 pr " printf (\"%s FAILED\\n\");\n" test_name;
4831 pr " guestfs_close (g);\n";
4832 pr " unlink (\"test1.img\");\n";
4833 pr " unlink (\"test2.img\");\n";
4834 pr " unlink (\"test3.img\");\n";
4837 pr " if (failed > 0) {\n";
4838 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4846 and generate_one_test name i (init, prereq, test) =
4847 let test_name = sprintf "test_%s_%d" name i in
4850 static int %s_skip (void)
4854 str = getenv (\"TEST_ONLY\");
4856 return strstr (str, \"%s\") == NULL;
4857 str = getenv (\"SKIP_%s\");
4858 if (str && strcmp (str, \"1\") == 0) return 1;
4859 str = getenv (\"SKIP_TEST_%s\");
4860 if (str && strcmp (str, \"1\") == 0) return 1;
4864 " test_name name (String.uppercase test_name) (String.uppercase name);
4867 | Disabled | Always -> ()
4868 | If code | Unless code ->
4869 pr "static int %s_prereq (void)\n" test_name;
4877 static int %s (void)
4880 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
4884 " test_name test_name test_name;
4888 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4890 pr " if (! %s_prereq ()) {\n" test_name;
4891 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4895 generate_one_test_body name i test_name init test;
4897 pr " if (%s_prereq ()) {\n" test_name;
4898 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4902 generate_one_test_body name i test_name init test;
4904 generate_one_test_body name i test_name init test
4912 and generate_one_test_body name i test_name init test =
4914 | InitNone (* XXX at some point, InitNone and InitEmpty became
4915 * folded together as the same thing. Really we should
4916 * make InitNone do nothing at all, but the tests may
4917 * need to be checked to make sure this is OK.
4920 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4921 List.iter (generate_test_command_call test_name)
4922 [["blockdev_setrw"; "/dev/sda"];
4926 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4927 List.iter (generate_test_command_call test_name)
4928 [["blockdev_setrw"; "/dev/sda"];
4931 ["sfdiskM"; "/dev/sda"; ","];
4932 ["mkfs"; "ext2"; "/dev/sda1"];
4933 ["mount"; "/dev/sda1"; "/"]]
4934 | InitBasicFSonLVM ->
4935 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4937 List.iter (generate_test_command_call test_name)
4938 [["blockdev_setrw"; "/dev/sda"];
4941 ["sfdiskM"; "/dev/sda"; ","];
4942 ["pvcreate"; "/dev/sda1"];
4943 ["vgcreate"; "VG"; "/dev/sda1"];
4944 ["lvcreate"; "LV"; "VG"; "8"];
4945 ["mkfs"; "ext2"; "/dev/VG/LV"];
4946 ["mount"; "/dev/VG/LV"; "/"]]
4949 let get_seq_last = function
4951 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4954 let seq = List.rev seq in
4955 List.rev (List.tl seq), List.hd seq
4960 pr " /* TestRun for %s (%d) */\n" name i;
4961 List.iter (generate_test_command_call test_name) seq
4962 | TestOutput (seq, expected) ->
4963 pr " /* TestOutput for %s (%d) */\n" name i;
4964 pr " const char *expected = \"%s\";\n" (c_quote expected);
4965 let seq, last = get_seq_last seq in
4967 pr " if (strcmp (r, expected) != 0) {\n";
4968 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4972 List.iter (generate_test_command_call test_name) seq;
4973 generate_test_command_call ~test test_name last
4974 | TestOutputList (seq, expected) ->
4975 pr " /* TestOutputList for %s (%d) */\n" name i;
4976 let seq, last = get_seq_last seq in
4980 pr " if (!r[%d]) {\n" i;
4981 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4982 pr " print_strings (r);\n";
4986 pr " const char *expected = \"%s\";\n" (c_quote str);
4987 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
4988 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4993 pr " if (r[%d] != NULL) {\n" (List.length expected);
4994 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4996 pr " print_strings (r);\n";
5000 List.iter (generate_test_command_call test_name) seq;
5001 generate_test_command_call ~test test_name last
5002 | TestOutputListOfDevices (seq, expected) ->
5003 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5004 let seq, last = get_seq_last seq in
5008 pr " if (!r[%d]) {\n" i;
5009 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5010 pr " print_strings (r);\n";
5014 pr " const char *expected = \"%s\";\n" (c_quote str);
5015 pr " r[%d][5] = 's';\n" i;
5016 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5017 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5022 pr " if (r[%d] != NULL) {\n" (List.length expected);
5023 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5025 pr " print_strings (r);\n";
5029 List.iter (generate_test_command_call test_name) seq;
5030 generate_test_command_call ~test test_name last
5031 | TestOutputInt (seq, expected) ->
5032 pr " /* TestOutputInt for %s (%d) */\n" name i;
5033 let seq, last = get_seq_last seq in
5035 pr " if (r != %d) {\n" expected;
5036 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5042 List.iter (generate_test_command_call test_name) seq;
5043 generate_test_command_call ~test test_name last
5044 | TestOutputIntOp (seq, op, expected) ->
5045 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5046 let seq, last = get_seq_last seq in
5048 pr " if (! (r %s %d)) {\n" op expected;
5049 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5050 test_name op expected;
5055 List.iter (generate_test_command_call test_name) seq;
5056 generate_test_command_call ~test test_name last
5057 | TestOutputTrue seq ->
5058 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5059 let seq, last = get_seq_last seq in
5062 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5067 List.iter (generate_test_command_call test_name) seq;
5068 generate_test_command_call ~test test_name last
5069 | TestOutputFalse seq ->
5070 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5071 let seq, last = get_seq_last seq in
5074 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5079 List.iter (generate_test_command_call test_name) seq;
5080 generate_test_command_call ~test test_name last
5081 | TestOutputLength (seq, expected) ->
5082 pr " /* TestOutputLength for %s (%d) */\n" name i;
5083 let seq, last = get_seq_last seq in
5086 pr " for (j = 0; j < %d; ++j)\n" expected;
5087 pr " if (r[j] == NULL) {\n";
5088 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5090 pr " print_strings (r);\n";
5093 pr " if (r[j] != NULL) {\n";
5094 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5096 pr " print_strings (r);\n";
5100 List.iter (generate_test_command_call test_name) seq;
5101 generate_test_command_call ~test test_name last
5102 | TestOutputStruct (seq, checks) ->
5103 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5104 let seq, last = get_seq_last seq in
5108 | CompareWithInt (field, expected) ->
5109 pr " if (r->%s != %d) {\n" field expected;
5110 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5111 test_name field expected;
5112 pr " (int) r->%s);\n" field;
5115 | CompareWithIntOp (field, op, expected) ->
5116 pr " if (!(r->%s %s %d)) {\n" field op expected;
5117 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5118 test_name field op expected;
5119 pr " (int) r->%s);\n" field;
5122 | CompareWithString (field, expected) ->
5123 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5124 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5125 test_name field expected;
5126 pr " r->%s);\n" field;
5129 | CompareFieldsIntEq (field1, field2) ->
5130 pr " if (r->%s != r->%s) {\n" field1 field2;
5131 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5132 test_name field1 field2;
5133 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5136 | CompareFieldsStrEq (field1, field2) ->
5137 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5138 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5139 test_name field1 field2;
5140 pr " r->%s, r->%s);\n" field1 field2;
5145 List.iter (generate_test_command_call test_name) seq;
5146 generate_test_command_call ~test test_name last
5147 | TestLastFail seq ->
5148 pr " /* TestLastFail for %s (%d) */\n" name i;
5149 let seq, last = get_seq_last seq in
5150 List.iter (generate_test_command_call test_name) seq;
5151 generate_test_command_call test_name ~expect_error:true last
5153 (* Generate the code to run a command, leaving the result in 'r'.
5154 * If you expect to get an error then you should set expect_error:true.
5156 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5158 | [] -> assert false
5160 (* Look up the command to find out what args/ret it has. *)
5163 let _, style, _, _, _, _, _ =
5164 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5167 failwithf "%s: in test, command %s was not found" test_name name in
5169 if List.length (snd style) <> List.length args then
5170 failwithf "%s: in test, wrong number of args given to %s"
5177 | OptString n, "NULL" -> ()
5179 | OptString n, arg ->
5180 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5183 | FileIn _, _ | FileOut _, _ -> ()
5184 | StringList n, arg ->
5185 let strs = string_split " " arg in
5188 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5190 pr " const char *%s[] = {\n" n;
5192 fun i _ -> pr " %s_%d,\n" n i
5196 ) (List.combine (snd style) args);
5199 match fst style with
5200 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5201 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5202 | RConstString _ | RConstOptString _ ->
5203 pr " const char *r;\n"; "NULL"
5204 | RString _ -> pr " char *r;\n"; "NULL"
5205 | RStringList _ | RHashtable _ ->
5209 | RStruct (_, typ) ->
5210 pr " struct guestfs_%s *r;\n" typ; "NULL"
5211 | RStructList (_, typ) ->
5212 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5215 pr " size_t size;\n";
5218 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5219 pr " r = guestfs_%s (g" name;
5221 (* Generate the parameters. *)
5224 | OptString _, "NULL" -> pr ", NULL"
5228 | FileIn _, arg | FileOut _, arg ->
5229 pr ", \"%s\"" (c_quote arg)
5230 | StringList n, _ ->
5234 try int_of_string arg
5235 with Failure "int_of_string" ->
5236 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5239 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5240 ) (List.combine (snd style) args);
5242 (match fst style with
5243 | RBufferOut _ -> pr ", &size"
5249 if not expect_error then
5250 pr " if (r == %s)\n" error_code
5252 pr " if (r != %s)\n" error_code;
5255 (* Insert the test code. *)
5261 (match fst style with
5262 | RErr | RInt _ | RInt64 _ | RBool _
5263 | RConstString _ | RConstOptString _ -> ()
5264 | RString _ | RBufferOut _ -> pr " free (r);\n"
5265 | RStringList _ | RHashtable _ ->
5266 pr " for (i = 0; r[i] != NULL; ++i)\n";
5267 pr " free (r[i]);\n";
5269 | RStruct (_, typ) ->
5270 pr " guestfs_free_%s (r);\n" typ
5271 | RStructList (_, typ) ->
5272 pr " guestfs_free_%s_list (r);\n" typ
5278 let str = replace_str str "\r" "\\r" in
5279 let str = replace_str str "\n" "\\n" in
5280 let str = replace_str str "\t" "\\t" in
5281 let str = replace_str str "\000" "\\0" in
5284 (* Generate a lot of different functions for guestfish. *)
5285 and generate_fish_cmds () =
5286 generate_header CStyle GPLv2;
5290 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5292 let all_functions_sorted =
5294 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5295 ) all_functions_sorted in
5297 pr "#include <stdio.h>\n";
5298 pr "#include <stdlib.h>\n";
5299 pr "#include <string.h>\n";
5300 pr "#include <inttypes.h>\n";
5301 pr "#include <ctype.h>\n";
5303 pr "#include <guestfs.h>\n";
5304 pr "#include \"fish.h\"\n";
5307 (* list_commands function, which implements guestfish -h *)
5308 pr "void list_commands (void)\n";
5310 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
5311 pr " list_builtin_commands ();\n";
5313 fun (name, _, _, flags, _, shortdesc, _) ->
5314 let name = replace_char name '_' '-' in
5315 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
5317 ) all_functions_sorted;
5318 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
5322 (* display_command function, which implements guestfish -h cmd *)
5323 pr "void display_command (const char *cmd)\n";
5326 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5327 let name2 = replace_char name '_' '-' in
5329 try find_map (function FishAlias n -> Some n | _ -> None) flags
5330 with Not_found -> name in
5331 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5333 match snd style with
5337 name2 (String.concat "> <" (List.map name_of_argt args)) in
5340 if List.mem ProtocolLimitWarning flags then
5341 ("\n\n" ^ protocol_limit_warning)
5344 (* For DangerWillRobinson commands, we should probably have
5345 * guestfish prompt before allowing you to use them (especially
5346 * in interactive mode). XXX
5350 if List.mem DangerWillRobinson flags then
5351 ("\n\n" ^ danger_will_robinson)
5354 let describe_alias =
5355 if name <> alias then
5356 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5360 pr "strcasecmp (cmd, \"%s\") == 0" name;
5361 if name <> name2 then
5362 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5363 if name <> alias then
5364 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5366 pr " pod2text (\"%s - %s\", %S);\n"
5368 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5371 pr " display_builtin_command (cmd);\n";
5375 (* print_* functions *)
5379 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5381 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5390 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5392 pr " printf (\"%s: \");\n" name;
5393 pr " for (i = 0; i < 32; ++i)\n";
5394 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5395 pr " printf (\"\\n\");\n"
5397 pr " printf (\"%s: \");\n" name;
5398 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5399 pr " if (isprint (%s->%s[i]))\n" typ name;
5400 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5402 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
5403 pr " printf (\"\\n\");\n"
5404 | name, (FUInt64|FBytes) ->
5405 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5407 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5409 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5411 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5413 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5414 | name, FOptPercent ->
5415 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5416 typ name name typ name;
5417 pr " else printf (\"%s: \\n\");\n" name
5421 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5426 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5427 pr " print_%s (&%ss->val[i]);\n" typ typ;
5432 (* run_<action> actions *)
5434 fun (name, style, _, flags, _, _, _) ->
5435 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5437 (match fst style with
5440 | RBool _ -> pr " int r;\n"
5441 | RInt64 _ -> pr " int64_t r;\n"
5442 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5443 | RString _ -> pr " char *r;\n"
5444 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5445 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5446 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5449 pr " size_t size;\n";
5456 | FileOut n -> pr " const char *%s;\n" n
5457 | StringList n -> pr " char **%s;\n" n
5458 | Bool n -> pr " int %s;\n" n
5459 | Int n -> pr " int %s;\n" n
5462 (* Check and convert parameters. *)
5463 let argc_expected = List.length (snd style) in
5464 pr " if (argc != %d) {\n" argc_expected;
5465 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
5467 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
5473 | String name -> pr " %s = argv[%d];\n" name i
5475 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5478 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5481 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5483 | StringList name ->
5484 pr " %s = parse_string_list (argv[%d]);\n" name i
5486 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5488 pr " %s = atoi (argv[%d]);\n" name i
5491 (* Call C API function. *)
5493 try find_map (function FishAction n -> Some n | _ -> None) flags
5494 with Not_found -> sprintf "guestfs_%s" name in
5496 generate_c_call_args ~handle:"g" style;
5499 (* Check return value for errors and display command results. *)
5500 (match fst style with
5501 | RErr -> pr " return r;\n"
5503 pr " if (r == -1) return -1;\n";
5504 pr " printf (\"%%d\\n\", r);\n";
5507 pr " if (r == -1) return -1;\n";
5508 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5511 pr " if (r == -1) return -1;\n";
5512 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5515 pr " if (r == NULL) return -1;\n";
5516 pr " printf (\"%%s\\n\", r);\n";
5518 | RConstOptString _ ->
5519 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
5522 pr " if (r == NULL) return -1;\n";
5523 pr " printf (\"%%s\\n\", r);\n";
5527 pr " if (r == NULL) return -1;\n";
5528 pr " print_strings (r);\n";
5529 pr " free_strings (r);\n";
5531 | RStruct (_, typ) ->
5532 pr " if (r == NULL) return -1;\n";
5533 pr " print_%s (r);\n" typ;
5534 pr " guestfs_free_%s (r);\n" typ;
5536 | RStructList (_, typ) ->
5537 pr " if (r == NULL) return -1;\n";
5538 pr " print_%s_list (r);\n" typ;
5539 pr " guestfs_free_%s_list (r);\n" typ;
5542 pr " if (r == NULL) return -1;\n";
5543 pr " print_table (r);\n";
5544 pr " free_strings (r);\n";
5547 pr " if (r == NULL) return -1;\n";
5548 pr " fwrite (r, size, 1, stdout);\n";
5556 (* run_action function *)
5557 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5560 fun (name, _, _, flags, _, _, _) ->
5561 let name2 = replace_char name '_' '-' in
5563 try find_map (function FishAlias n -> Some n | _ -> None) flags
5564 with Not_found -> name in
5566 pr "strcasecmp (cmd, \"%s\") == 0" name;
5567 if name <> name2 then
5568 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5569 if name <> alias then
5570 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5572 pr " return run_%s (cmd, argc, argv);\n" name;
5576 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
5583 (* Readline completion for guestfish. *)
5584 and generate_fish_completion () =
5585 generate_header CStyle GPLv2;
5589 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5599 #ifdef HAVE_LIBREADLINE
5600 #include <readline/readline.h>
5605 #ifdef HAVE_LIBREADLINE
5607 static const char *const commands[] = {
5608 BUILTIN_COMMANDS_FOR_COMPLETION,
5611 (* Get the commands, including the aliases. They don't need to be
5612 * sorted - the generator() function just does a dumb linear search.
5616 fun (name, _, _, flags, _, _, _) ->
5617 let name2 = replace_char name '_' '-' in
5619 try find_map (function FishAlias n -> Some n | _ -> None) flags
5620 with Not_found -> name in
5622 if name <> alias then [name2; alias] else [name2]
5624 let commands = List.flatten commands in
5626 List.iter (pr " \"%s\",\n") commands;
5632 generator (const char *text, int state)
5634 static int index, len;
5639 len = strlen (text);
5642 rl_attempted_completion_over = 1;
5644 while ((name = commands[index]) != NULL) {
5646 if (strncasecmp (name, text, len) == 0)
5647 return strdup (name);
5653 #endif /* HAVE_LIBREADLINE */
5655 char **do_completion (const char *text, int start, int end)
5657 char **matches = NULL;
5659 #ifdef HAVE_LIBREADLINE
5660 rl_completion_append_character = ' ';
5663 matches = rl_completion_matches (text, generator);
5664 else if (complete_dest_paths)
5665 matches = rl_completion_matches (text, complete_dest_paths_generator);
5672 (* Generate the POD documentation for guestfish. *)
5673 and generate_fish_actions_pod () =
5674 let all_functions_sorted =
5676 fun (_, _, _, flags, _, _, _) ->
5677 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5678 ) all_functions_sorted in
5680 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5683 fun (name, style, _, flags, _, _, longdesc) ->
5685 Str.global_substitute rex (
5688 try Str.matched_group 1 s
5690 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5691 "C<" ^ replace_char sub '_' '-' ^ ">"
5693 let name = replace_char name '_' '-' in
5695 try find_map (function FishAlias n -> Some n | _ -> None) flags
5696 with Not_found -> name in
5698 pr "=head2 %s" name;
5699 if name <> alias then
5706 | String n -> pr " %s" n
5707 | OptString n -> pr " %s" n
5708 | StringList n -> pr " '%s ...'" n
5709 | Bool _ -> pr " true|false"
5710 | Int n -> pr " %s" n
5711 | FileIn n | FileOut n -> pr " (%s|-)" n
5715 pr "%s\n\n" longdesc;
5717 if List.exists (function FileIn _ | FileOut _ -> true
5718 | _ -> false) (snd style) then
5719 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5721 if List.mem ProtocolLimitWarning flags then
5722 pr "%s\n\n" protocol_limit_warning;
5724 if List.mem DangerWillRobinson flags then
5725 pr "%s\n\n" danger_will_robinson
5726 ) all_functions_sorted
5728 (* Generate a C function prototype. *)
5729 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5730 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5732 ?handle name style =
5733 if extern then pr "extern ";
5734 if static then pr "static ";
5735 (match fst style with
5737 | RInt _ -> pr "int "
5738 | RInt64 _ -> pr "int64_t "
5739 | RBool _ -> pr "int "
5740 | RConstString _ | RConstOptString _ -> pr "const char *"
5741 | RString _ | RBufferOut _ -> pr "char *"
5742 | RStringList _ | RHashtable _ -> pr "char **"
5743 | RStruct (_, typ) ->
5744 if not in_daemon then pr "struct guestfs_%s *" typ
5745 else pr "guestfs_int_%s *" typ
5746 | RStructList (_, typ) ->
5747 if not in_daemon then pr "struct guestfs_%s_list *" typ
5748 else pr "guestfs_int_%s_list *" typ
5750 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
5751 pr "%s%s (" prefix name;
5752 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
5755 let comma = ref false in
5758 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5762 if single_line then pr ", " else pr ",\n\t\t"
5771 if not in_daemon then pr "const char *%s" n
5772 else pr "char *%s" n
5775 if not in_daemon then pr "char * const* const %s" n
5776 else pr "char **%s" n
5777 | Bool n -> next (); pr "int %s" n
5778 | Int n -> next (); pr "int %s" n
5781 if not in_daemon then (next (); pr "const char *%s" n)
5783 if is_RBufferOut then (next (); pr "size_t *size_r");
5786 if semicolon then pr ";";
5787 if newline then pr "\n"
5789 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5790 and generate_c_call_args ?handle ?(decl = false) style =
5792 let comma = ref false in
5794 if !comma then pr ", ";
5799 | Some handle -> pr "%s" handle; comma := true
5804 pr "%s" (name_of_argt arg)
5806 (* For RBufferOut calls, add implicit &size parameter. *)
5808 match fst style with
5816 (* Generate the OCaml bindings interface. *)
5817 and generate_ocaml_mli () =
5818 generate_header OCamlStyle LGPLv2;
5821 (** For API documentation you should refer to the C API
5822 in the guestfs(3) manual page. The OCaml API uses almost
5823 exactly the same calls. *)
5826 (** A [guestfs_h] handle. *)
5828 exception Error of string
5829 (** This exception is raised when there is an error. *)
5831 val create : unit -> t
5833 val close : t -> unit
5834 (** Handles are closed by the garbage collector when they become
5835 unreferenced, but callers can also call this in order to
5836 provide predictable cleanup. *)
5839 generate_ocaml_structure_decls ();
5843 fun (name, style, _, _, _, shortdesc, _) ->
5844 generate_ocaml_prototype name style;
5845 pr "(** %s *)\n" shortdesc;
5849 (* Generate the OCaml bindings implementation. *)
5850 and generate_ocaml_ml () =
5851 generate_header OCamlStyle LGPLv2;
5855 exception Error of string
5856 external create : unit -> t = \"ocaml_guestfs_create\"
5857 external close : t -> unit = \"ocaml_guestfs_close\"
5860 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5864 generate_ocaml_structure_decls ();
5868 fun (name, style, _, _, _, shortdesc, _) ->
5869 generate_ocaml_prototype ~is_external:true name style;
5872 (* Generate the OCaml bindings C implementation. *)
5873 and generate_ocaml_c () =
5874 generate_header CStyle LGPLv2;
5881 #include <caml/config.h>
5882 #include <caml/alloc.h>
5883 #include <caml/callback.h>
5884 #include <caml/fail.h>
5885 #include <caml/memory.h>
5886 #include <caml/mlvalues.h>
5887 #include <caml/signals.h>
5889 #include <guestfs.h>
5891 #include \"guestfs_c.h\"
5893 /* Copy a hashtable of string pairs into an assoc-list. We return
5894 * the list in reverse order, but hashtables aren't supposed to be
5897 static CAMLprim value
5898 copy_table (char * const * argv)
5901 CAMLlocal5 (rv, pairv, kv, vv, cons);
5905 for (i = 0; argv[i] != NULL; i += 2) {
5906 kv = caml_copy_string (argv[i]);
5907 vv = caml_copy_string (argv[i+1]);
5908 pairv = caml_alloc (2, 0);
5909 Store_field (pairv, 0, kv);
5910 Store_field (pairv, 1, vv);
5911 cons = caml_alloc (2, 0);
5912 Store_field (cons, 1, rv);
5914 Store_field (cons, 0, pairv);
5922 (* Struct copy functions. *)
5925 let has_optpercent_col =
5926 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
5928 pr "static CAMLprim value\n";
5929 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5931 pr " CAMLparam0 ();\n";
5932 if has_optpercent_col then
5933 pr " CAMLlocal3 (rv, v, v2);\n"
5935 pr " CAMLlocal2 (rv, v);\n";
5937 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5942 pr " v = caml_copy_string (%s->%s);\n" typ name
5944 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
5945 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
5948 pr " v = caml_alloc_string (32);\n";
5949 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5950 | name, (FBytes|FInt64|FUInt64) ->
5951 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5952 | name, (FInt32|FUInt32) ->
5953 pr " v = caml_copy_int32 (%s->%s);\n" typ name
5954 | name, FOptPercent ->
5955 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5956 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5957 pr " v = caml_alloc (1, 0);\n";
5958 pr " Store_field (v, 0, v2);\n";
5959 pr " } else /* None */\n";
5960 pr " v = Val_int (0);\n";
5962 pr " v = Val_int (%s->%s);\n" typ name
5964 pr " Store_field (rv, %d, v);\n" i
5966 pr " CAMLreturn (rv);\n";
5970 pr "static CAMLprim value\n";
5971 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
5974 pr " CAMLparam0 ();\n";
5975 pr " CAMLlocal2 (rv, v);\n";
5978 pr " if (%ss->len == 0)\n" typ;
5979 pr " CAMLreturn (Atom (0));\n";
5981 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
5982 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5983 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
5984 pr " caml_modify (&Field (rv, i), v);\n";
5986 pr " CAMLreturn (rv);\n";
5994 fun (name, style, _, _, _, _, _) ->
5996 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5998 let needs_extra_vs =
5999 match fst style with RConstOptString _ -> true | _ -> false in
6001 pr "CAMLprim value\n";
6002 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6003 List.iter (pr ", value %s") (List.tl params);
6008 | [p1; p2; p3; p4; p5] ->
6009 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6010 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6011 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6012 pr " CAMLxparam%d (%s);\n"
6013 (List.length rest) (String.concat ", " rest)
6015 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6017 if not needs_extra_vs then
6018 pr " CAMLlocal1 (rv);\n"
6020 pr " CAMLlocal3 (rv, v, v2);\n";
6023 pr " guestfs_h *g = Guestfs_val (gv);\n";
6024 pr " if (g == NULL)\n";
6025 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6033 pr " const char *%s = String_val (%sv);\n" n n
6035 pr " const char *%s =\n" n;
6036 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6039 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6041 pr " int %s = Bool_val (%sv);\n" n n
6043 pr " int %s = Int_val (%sv);\n" n n
6046 match fst style with
6047 | RErr -> pr " int r;\n"; "-1"
6048 | RInt _ -> pr " int r;\n"; "-1"
6049 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6050 | RBool _ -> pr " int r;\n"; "-1"
6051 | RConstString _ | RConstOptString _ ->
6052 pr " const char *r;\n"; "NULL"
6053 | RString _ -> pr " char *r;\n"; "NULL"
6058 | RStruct (_, typ) ->
6059 pr " struct guestfs_%s *r;\n" typ; "NULL"
6060 | RStructList (_, typ) ->
6061 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6068 pr " size_t size;\n";
6072 pr " caml_enter_blocking_section ();\n";
6073 pr " r = guestfs_%s " name;
6074 generate_c_call_args ~handle:"g" style;
6076 pr " caml_leave_blocking_section ();\n";
6081 pr " ocaml_guestfs_free_strings (%s);\n" n;
6082 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6085 pr " if (r == %s)\n" error_code;
6086 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6089 (match fst style with
6090 | RErr -> pr " rv = Val_unit;\n"
6091 | RInt _ -> pr " rv = Val_int (r);\n"
6093 pr " rv = caml_copy_int64 (r);\n"
6094 | RBool _ -> pr " rv = Val_bool (r);\n"
6096 pr " rv = caml_copy_string (r);\n"
6097 | RConstOptString _ ->
6098 pr " if (r) { /* Some string */\n";
6099 pr " v = caml_alloc (1, 0);\n";
6100 pr " v2 = caml_copy_string (r);\n";
6101 pr " Store_field (v, 0, v2);\n";
6102 pr " } else /* None */\n";
6103 pr " v = Val_int (0);\n";
6105 pr " rv = caml_copy_string (r);\n";
6108 pr " rv = caml_copy_string_array ((const char **) r);\n";
6109 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6111 | RStruct (_, typ) ->
6112 pr " rv = copy_%s (r);\n" typ;
6113 pr " guestfs_free_%s (r);\n" typ;
6114 | RStructList (_, typ) ->
6115 pr " rv = copy_%s_list (r);\n" typ;
6116 pr " guestfs_free_%s_list (r);\n" typ;
6118 pr " rv = copy_table (r);\n";
6119 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6122 pr " rv = caml_alloc_string (size);\n";
6123 pr " memcpy (String_val (rv), r, size);\n";
6126 pr " CAMLreturn (rv);\n";
6130 if List.length params > 5 then (
6131 pr "CAMLprim value\n";
6132 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6134 pr " return ocaml_guestfs_%s (argv[0]" name;
6135 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6142 and generate_ocaml_structure_decls () =
6145 pr "type %s = {\n" typ;
6148 | name, FString -> pr " %s : string;\n" name
6149 | name, FBuffer -> pr " %s : string;\n" name
6150 | name, FUUID -> pr " %s : string;\n" name
6151 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6152 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6153 | name, FChar -> pr " %s : char;\n" name
6154 | name, FOptPercent -> pr " %s : float option;\n" name
6160 and generate_ocaml_prototype ?(is_external = false) name style =
6161 if is_external then pr "external " else pr "val ";
6162 pr "%s : t -> " name;
6165 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6166 | OptString _ -> pr "string option -> "
6167 | StringList _ -> pr "string array -> "
6168 | Bool _ -> pr "bool -> "
6169 | Int _ -> pr "int -> "
6171 (match fst style with
6172 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6173 | RInt _ -> pr "int"
6174 | RInt64 _ -> pr "int64"
6175 | RBool _ -> pr "bool"
6176 | RConstString _ -> pr "string"
6177 | RConstOptString _ -> pr "string option"
6178 | RString _ | RBufferOut _ -> pr "string"
6179 | RStringList _ -> pr "string array"
6180 | RStruct (_, typ) -> pr "%s" typ
6181 | RStructList (_, typ) -> pr "%s array" typ
6182 | RHashtable _ -> pr "(string * string) list"
6184 if is_external then (
6186 if List.length (snd style) + 1 > 5 then
6187 pr "\"ocaml_guestfs_%s_byte\" " name;
6188 pr "\"ocaml_guestfs_%s\"" name
6192 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6193 and generate_perl_xs () =
6194 generate_header CStyle LGPLv2;
6197 #include \"EXTERN.h\"
6201 #include <guestfs.h>
6204 #define PRId64 \"lld\"
6208 my_newSVll(long long val) {
6209 #ifdef USE_64_BIT_ALL
6210 return newSViv(val);
6214 len = snprintf(buf, 100, \"%%\" PRId64, val);
6215 return newSVpv(buf, len);
6220 #define PRIu64 \"llu\"
6224 my_newSVull(unsigned long long val) {
6225 #ifdef USE_64_BIT_ALL
6226 return newSVuv(val);
6230 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6231 return newSVpv(buf, len);
6235 /* http://www.perlmonks.org/?node_id=680842 */
6237 XS_unpack_charPtrPtr (SV *arg) {
6242 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6243 croak (\"array reference expected\");
6245 av = (AV *)SvRV (arg);
6246 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6248 croak (\"malloc failed\");
6250 for (i = 0; i <= av_len (av); i++) {
6251 SV **elem = av_fetch (av, i, 0);
6253 if (!elem || !*elem)
6254 croak (\"missing element in list\");
6256 ret[i] = SvPV_nolen (*elem);
6264 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6271 RETVAL = guestfs_create ();
6273 croak (\"could not create guestfs handle\");
6274 guestfs_set_error_handler (RETVAL, NULL, NULL);
6287 fun (name, style, _, _, _, _, _) ->
6288 (match fst style with
6289 | RErr -> pr "void\n"
6290 | RInt _ -> pr "SV *\n"
6291 | RInt64 _ -> pr "SV *\n"
6292 | RBool _ -> pr "SV *\n"
6293 | RConstString _ -> pr "SV *\n"
6294 | RConstOptString _ -> pr "SV *\n"
6295 | RString _ -> pr "SV *\n"
6296 | RBufferOut _ -> pr "SV *\n"
6298 | RStruct _ | RStructList _
6300 pr "void\n" (* all lists returned implictly on the stack *)
6302 (* Call and arguments. *)
6304 generate_c_call_args ~handle:"g" ~decl:true style;
6306 pr " guestfs_h *g;\n";
6310 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6312 (* http://www.perlmonks.org/?node_id=554277
6313 * Note that the implicit handle argument means we have
6314 * to add 1 to the ST(x) operator.
6316 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6317 | StringList n -> pr " char **%s;\n" n
6318 | Bool n -> pr " int %s;\n" n
6319 | Int n -> pr " int %s;\n" n
6322 let do_cleanups () =
6325 | String _ | OptString _ | Bool _ | Int _
6326 | FileIn _ | FileOut _ -> ()
6327 | StringList n -> pr " free (%s);\n" n
6332 (match fst style with
6337 pr " r = guestfs_%s " name;
6338 generate_c_call_args ~handle:"g" style;
6341 pr " if (r == -1)\n";
6342 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6348 pr " %s = guestfs_%s " n name;
6349 generate_c_call_args ~handle:"g" style;
6352 pr " if (%s == -1)\n" n;
6353 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6354 pr " RETVAL = newSViv (%s);\n" n;
6359 pr " int64_t %s;\n" n;
6361 pr " %s = guestfs_%s " n name;
6362 generate_c_call_args ~handle:"g" style;
6365 pr " if (%s == -1)\n" n;
6366 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6367 pr " RETVAL = my_newSVll (%s);\n" n;
6372 pr " const char *%s;\n" n;
6374 pr " %s = guestfs_%s " n name;
6375 generate_c_call_args ~handle:"g" style;
6378 pr " if (%s == NULL)\n" n;
6379 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6380 pr " RETVAL = newSVpv (%s, 0);\n" n;
6383 | RConstOptString n ->
6385 pr " const char *%s;\n" n;
6387 pr " %s = guestfs_%s " n name;
6388 generate_c_call_args ~handle:"g" style;
6391 pr " if (%s == NULL)\n" n;
6392 pr " RETVAL = &PL_sv_undef;\n";
6394 pr " RETVAL = newSVpv (%s, 0);\n" n;
6399 pr " char *%s;\n" n;
6401 pr " %s = guestfs_%s " n name;
6402 generate_c_call_args ~handle:"g" style;
6405 pr " if (%s == NULL)\n" n;
6406 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6407 pr " RETVAL = newSVpv (%s, 0);\n" n;
6408 pr " free (%s);\n" n;
6411 | RStringList n | RHashtable n ->
6413 pr " char **%s;\n" n;
6416 pr " %s = guestfs_%s " n name;
6417 generate_c_call_args ~handle:"g" style;
6420 pr " if (%s == NULL)\n" n;
6421 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6422 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6423 pr " EXTEND (SP, n);\n";
6424 pr " for (i = 0; i < n; ++i) {\n";
6425 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6426 pr " free (%s[i]);\n" n;
6428 pr " free (%s);\n" n;
6429 | RStruct (n, typ) ->
6430 let cols = cols_of_struct typ in
6431 generate_perl_struct_code typ cols name style n do_cleanups
6432 | RStructList (n, typ) ->
6433 let cols = cols_of_struct typ in
6434 generate_perl_struct_list_code typ cols name style n do_cleanups
6437 pr " char *%s;\n" n;
6438 pr " size_t size;\n";
6440 pr " %s = guestfs_%s " n name;
6441 generate_c_call_args ~handle:"g" style;
6444 pr " if (%s == NULL)\n" n;
6445 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6446 pr " RETVAL = newSVpv (%s, size);\n" n;
6447 pr " free (%s);\n" n;
6455 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6457 pr " struct guestfs_%s_list *%s;\n" typ n;
6461 pr " %s = guestfs_%s " n name;
6462 generate_c_call_args ~handle:"g" style;
6465 pr " if (%s == NULL)\n" n;
6466 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6467 pr " EXTEND (SP, %s->len);\n" n;
6468 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6469 pr " hv = newHV ();\n";
6473 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6474 name (String.length name) n name
6476 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6477 name (String.length name) n name
6479 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6480 name (String.length name) n name n name
6481 | name, (FBytes|FUInt64) ->
6482 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6483 name (String.length name) n name
6485 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6486 name (String.length name) n name
6487 | name, (FInt32|FUInt32) ->
6488 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6489 name (String.length name) n name
6491 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6492 name (String.length name) n name
6493 | name, FOptPercent ->
6494 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6495 name (String.length name) n name
6497 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6499 pr " guestfs_free_%s_list (%s);\n" typ n
6501 and generate_perl_struct_code typ cols name style n do_cleanups =
6503 pr " struct guestfs_%s *%s;\n" typ n;
6505 pr " %s = guestfs_%s " n name;
6506 generate_c_call_args ~handle:"g" style;
6509 pr " if (%s == NULL)\n" n;
6510 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6511 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6513 fun ((name, _) as col) ->
6514 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6518 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6521 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6524 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6526 | name, (FBytes|FUInt64) ->
6527 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6530 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6532 | name, (FInt32|FUInt32) ->
6533 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6536 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6538 | name, FOptPercent ->
6539 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6542 pr " free (%s);\n" n
6544 (* Generate Sys/Guestfs.pm. *)
6545 and generate_perl_pm () =
6546 generate_header HashStyle LGPLv2;
6553 Sys::Guestfs - Perl bindings for libguestfs
6559 my $h = Sys::Guestfs->new ();
6560 $h->add_drive ('guest.img');
6563 $h->mount ('/dev/sda1', '/');
6564 $h->touch ('/hello');
6569 The C<Sys::Guestfs> module provides a Perl XS binding to the
6570 libguestfs API for examining and modifying virtual machine
6573 Amongst the things this is good for: making batch configuration
6574 changes to guests, getting disk used/free statistics (see also:
6575 virt-df), migrating between virtualization systems (see also:
6576 virt-p2v), performing partial backups, performing partial guest
6577 clones, cloning guests and changing registry/UUID/hostname info, and
6580 Libguestfs uses Linux kernel and qemu code, and can access any type of
6581 guest filesystem that Linux and qemu can, including but not limited
6582 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6583 schemes, qcow, qcow2, vmdk.
6585 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6586 LVs, what filesystem is in each LV, etc.). It can also run commands
6587 in the context of the guest. Also you can access filesystems over FTP.
6589 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
6590 functions for using libguestfs from Perl, including integration
6595 All errors turn into calls to C<croak> (see L<Carp(3)>).
6603 package Sys::Guestfs;
6609 XSLoader::load ('Sys::Guestfs');
6611 =item $h = Sys::Guestfs->new ();
6613 Create a new guestfs handle.
6619 my $class = ref ($proto) || $proto;
6621 my $self = Sys::Guestfs::_create ();
6622 bless $self, $class;
6628 (* Actions. We only need to print documentation for these as
6629 * they are pulled in from the XS code automatically.
6632 fun (name, style, _, flags, _, _, longdesc) ->
6633 if not (List.mem NotInDocs flags) then (
6634 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
6636 generate_perl_prototype name style;
6638 pr "%s\n\n" longdesc;
6639 if List.mem ProtocolLimitWarning flags then
6640 pr "%s\n\n" protocol_limit_warning;
6641 if List.mem DangerWillRobinson flags then
6642 pr "%s\n\n" danger_will_robinson
6644 ) all_functions_sorted;
6656 Copyright (C) 2009 Red Hat Inc.
6660 Please see the file COPYING.LIB for the full license.
6666 L<http://libguestfs.org>,
6667 L<Sys::Guestfs::Lib(3)>.
6672 and generate_perl_prototype name style =
6673 (match fst style with
6681 | RBufferOut n -> pr "$%s = " n
6683 | RHashtable n -> pr "%%%s = " n
6685 | RStructList (n,_) -> pr "@%s = " n
6688 let comma = ref false in
6691 if !comma then pr ", ";
6694 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
6701 (* Generate Python C module. *)
6702 and generate_python_c () =
6703 generate_header CStyle LGPLv2;
6712 #include \"guestfs.h\"
6720 get_handle (PyObject *obj)
6723 assert (obj != Py_None);
6724 return ((Pyguestfs_Object *) obj)->g;
6728 put_handle (guestfs_h *g)
6732 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6735 /* This list should be freed (but not the strings) after use. */
6736 static const char **
6737 get_string_list (PyObject *obj)
6744 if (!PyList_Check (obj)) {
6745 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6749 len = PyList_Size (obj);
6750 r = malloc (sizeof (char *) * (len+1));
6752 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6756 for (i = 0; i < len; ++i)
6757 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6764 put_string_list (char * const * const argv)
6769 for (argc = 0; argv[argc] != NULL; ++argc)
6772 list = PyList_New (argc);
6773 for (i = 0; i < argc; ++i)
6774 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6780 put_table (char * const * const argv)
6782 PyObject *list, *item;
6785 for (argc = 0; argv[argc] != NULL; ++argc)
6788 list = PyList_New (argc >> 1);
6789 for (i = 0; i < argc; i += 2) {
6790 item = PyTuple_New (2);
6791 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6792 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6793 PyList_SetItem (list, i >> 1, item);
6800 free_strings (char **argv)
6804 for (argc = 0; argv[argc] != NULL; ++argc)
6810 py_guestfs_create (PyObject *self, PyObject *args)
6814 g = guestfs_create ();
6816 PyErr_SetString (PyExc_RuntimeError,
6817 \"guestfs.create: failed to allocate handle\");
6820 guestfs_set_error_handler (g, NULL, NULL);
6821 return put_handle (g);
6825 py_guestfs_close (PyObject *self, PyObject *args)
6830 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6832 g = get_handle (py_g);
6836 Py_INCREF (Py_None);
6842 (* Structures, turned into Python dictionaries. *)
6845 pr "static PyObject *\n";
6846 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6848 pr " PyObject *dict;\n";
6850 pr " dict = PyDict_New ();\n";
6854 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6855 pr " PyString_FromString (%s->%s));\n"
6858 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6859 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
6862 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6863 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6865 | name, (FBytes|FUInt64) ->
6866 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6867 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6870 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6871 pr " PyLong_FromLongLong (%s->%s));\n"
6874 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6875 pr " PyLong_FromUnsignedLong (%s->%s));\n"
6878 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6879 pr " PyLong_FromLong (%s->%s));\n"
6881 | name, FOptPercent ->
6882 pr " if (%s->%s >= 0)\n" typ name;
6883 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6884 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6887 pr " Py_INCREF (Py_None);\n";
6888 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6891 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6892 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
6894 pr " return dict;\n";
6898 pr "static PyObject *\n";
6899 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
6901 pr " PyObject *list;\n";
6904 pr " list = PyList_New (%ss->len);\n" typ;
6905 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6906 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
6907 pr " return list;\n";
6912 (* Python wrapper functions. *)
6914 fun (name, style, _, _, _, _, _) ->
6915 pr "static PyObject *\n";
6916 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6919 pr " PyObject *py_g;\n";
6920 pr " guestfs_h *g;\n";
6921 pr " PyObject *py_r;\n";
6924 match fst style with
6925 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6926 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6927 | RConstString _ | RConstOptString _ ->
6928 pr " const char *r;\n"; "NULL"
6929 | RString _ -> pr " char *r;\n"; "NULL"
6930 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6931 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
6932 | RStructList (_, typ) ->
6933 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6936 pr " size_t size;\n";
6941 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6942 | OptString n -> pr " const char *%s;\n" n
6944 pr " PyObject *py_%s;\n" n;
6945 pr " const char **%s;\n" n
6946 | Bool n -> pr " int %s;\n" n
6947 | Int n -> pr " int %s;\n" n
6952 (* Convert the parameters. *)
6953 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6956 | String _ | FileIn _ | FileOut _ -> pr "s"
6957 | OptString _ -> pr "z"
6958 | StringList _ -> pr "O"
6959 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6962 pr ":guestfs_%s\",\n" name;
6966 | String n | FileIn n | FileOut n -> pr ", &%s" n
6967 | OptString n -> pr ", &%s" n
6968 | StringList n -> pr ", &py_%s" n
6969 | Bool n -> pr ", &%s" n
6970 | Int n -> pr ", &%s" n
6974 pr " return NULL;\n";
6976 pr " g = get_handle (py_g);\n";
6979 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6981 pr " %s = get_string_list (py_%s);\n" n n;
6982 pr " if (!%s) return NULL;\n" n
6987 pr " r = guestfs_%s " name;
6988 generate_c_call_args ~handle:"g" style;
6993 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6995 pr " free (%s);\n" n
6998 pr " if (r == %s) {\n" error_code;
6999 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7000 pr " return NULL;\n";
7004 (match fst style with
7006 pr " Py_INCREF (Py_None);\n";
7007 pr " py_r = Py_None;\n"
7009 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7010 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7011 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7012 | RConstOptString _ ->
7014 pr " py_r = PyString_FromString (r);\n";
7016 pr " Py_INCREF (Py_None);\n";
7017 pr " py_r = Py_None;\n";
7020 pr " py_r = PyString_FromString (r);\n";
7023 pr " py_r = put_string_list (r);\n";
7024 pr " free_strings (r);\n"
7025 | RStruct (_, typ) ->
7026 pr " py_r = put_%s (r);\n" typ;
7027 pr " guestfs_free_%s (r);\n" typ
7028 | RStructList (_, typ) ->
7029 pr " py_r = put_%s_list (r);\n" typ;
7030 pr " guestfs_free_%s_list (r);\n" typ
7032 pr " py_r = put_table (r);\n";
7033 pr " free_strings (r);\n"
7035 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7039 pr " return py_r;\n";
7044 (* Table of functions. *)
7045 pr "static PyMethodDef methods[] = {\n";
7046 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7047 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7049 fun (name, _, _, _, _, _, _) ->
7050 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7053 pr " { NULL, NULL, 0, NULL }\n";
7057 (* Init function. *)
7060 initlibguestfsmod (void)
7062 static int initialized = 0;
7064 if (initialized) return;
7065 Py_InitModule ((char *) \"libguestfsmod\", methods);
7070 (* Generate Python module. *)
7071 and generate_python_py () =
7072 generate_header HashStyle LGPLv2;
7075 u\"\"\"Python bindings for libguestfs
7078 g = guestfs.GuestFS ()
7079 g.add_drive (\"guest.img\")
7082 parts = g.list_partitions ()
7084 The guestfs module provides a Python binding to the libguestfs API
7085 for examining and modifying virtual machine disk images.
7087 Amongst the things this is good for: making batch configuration
7088 changes to guests, getting disk used/free statistics (see also:
7089 virt-df), migrating between virtualization systems (see also:
7090 virt-p2v), performing partial backups, performing partial guest
7091 clones, cloning guests and changing registry/UUID/hostname info, and
7094 Libguestfs uses Linux kernel and qemu code, and can access any type of
7095 guest filesystem that Linux and qemu can, including but not limited
7096 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7097 schemes, qcow, qcow2, vmdk.
7099 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7100 LVs, what filesystem is in each LV, etc.). It can also run commands
7101 in the context of the guest. Also you can access filesystems over FTP.
7103 Errors which happen while using the API are turned into Python
7104 RuntimeError exceptions.
7106 To create a guestfs handle you usually have to perform the following
7109 # Create the handle, call add_drive at least once, and possibly
7110 # several times if the guest has multiple block devices:
7111 g = guestfs.GuestFS ()
7112 g.add_drive (\"guest.img\")
7114 # Launch the qemu subprocess and wait for it to become ready:
7118 # Now you can issue commands, for example:
7123 import libguestfsmod
7126 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7128 def __init__ (self):
7129 \"\"\"Create a new libguestfs handle.\"\"\"
7130 self._o = libguestfsmod.create ()
7133 libguestfsmod.close (self._o)
7138 fun (name, style, _, flags, _, _, longdesc) ->
7140 generate_py_call_args ~handle:"self" (snd style);
7143 if not (List.mem NotInDocs flags) then (
7144 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7146 match fst style with
7147 | RErr | RInt _ | RInt64 _ | RBool _
7148 | RConstOptString _ | RConstString _
7149 | RString _ | RBufferOut _ -> doc
7151 doc ^ "\n\nThis function returns a list of strings."
7152 | RStruct (_, typ) ->
7153 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7154 | RStructList (_, typ) ->
7155 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7157 doc ^ "\n\nThis function returns a dictionary." in
7159 if List.mem ProtocolLimitWarning flags then
7160 doc ^ "\n\n" ^ protocol_limit_warning
7163 if List.mem DangerWillRobinson flags then
7164 doc ^ "\n\n" ^ danger_will_robinson
7166 let doc = pod2text ~width:60 name doc in
7167 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7168 let doc = String.concat "\n " doc in
7169 pr " u\"\"\"%s\"\"\"\n" doc;
7171 pr " return libguestfsmod.%s " name;
7172 generate_py_call_args ~handle:"self._o" (snd style);
7177 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7178 and generate_py_call_args ~handle args =
7180 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7183 (* Useful if you need the longdesc POD text as plain text. Returns a
7186 * Because this is very slow (the slowest part of autogeneration),
7187 * we memoize the results.
7189 and pod2text ~width name longdesc =
7190 let key = width, name, longdesc in
7191 try Hashtbl.find pod2text_memo key
7193 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7194 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7196 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7197 let chan = Unix.open_process_in cmd in
7198 let lines = ref [] in
7200 let line = input_line chan in
7201 if i = 1 then (* discard the first line of output *)
7204 let line = triml line in
7205 lines := line :: !lines;
7208 let lines = try loop 1 with End_of_file -> List.rev !lines in
7209 Unix.unlink filename;
7210 (match Unix.close_process_in chan with
7211 | Unix.WEXITED 0 -> ()
7213 failwithf "pod2text: process exited with non-zero status (%d)" i
7214 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7215 failwithf "pod2text: process signalled or stopped by signal %d" i
7217 Hashtbl.add pod2text_memo key lines;
7218 let chan = open_out pod2text_memo_filename in
7219 output_value chan pod2text_memo;
7223 (* Generate ruby bindings. *)
7224 and generate_ruby_c () =
7225 generate_header CStyle LGPLv2;
7233 #include \"guestfs.h\"
7235 #include \"extconf.h\"
7237 /* For Ruby < 1.9 */
7239 #define RARRAY_LEN(r) (RARRAY((r))->len)
7242 static VALUE m_guestfs; /* guestfs module */
7243 static VALUE c_guestfs; /* guestfs_h handle */
7244 static VALUE e_Error; /* used for all errors */
7246 static void ruby_guestfs_free (void *p)
7249 guestfs_close ((guestfs_h *) p);
7252 static VALUE ruby_guestfs_create (VALUE m)
7256 g = guestfs_create ();
7258 rb_raise (e_Error, \"failed to create guestfs handle\");
7260 /* Don't print error messages to stderr by default. */
7261 guestfs_set_error_handler (g, NULL, NULL);
7263 /* Wrap it, and make sure the close function is called when the
7266 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7269 static VALUE ruby_guestfs_close (VALUE gv)
7272 Data_Get_Struct (gv, guestfs_h, g);
7274 ruby_guestfs_free (g);
7275 DATA_PTR (gv) = NULL;
7283 fun (name, style, _, _, _, _, _) ->
7284 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7285 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7288 pr " guestfs_h *g;\n";
7289 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7291 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7297 | String n | FileIn n | FileOut n ->
7298 pr " Check_Type (%sv, T_STRING);\n" n;
7299 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7301 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7302 pr " \"%s\", \"%s\");\n" n name
7304 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7306 pr " char **%s;\n" n;
7307 pr " Check_Type (%sv, T_ARRAY);\n" n;
7309 pr " int i, len;\n";
7310 pr " len = RARRAY_LEN (%sv);\n" n;
7311 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7313 pr " for (i = 0; i < len; ++i) {\n";
7314 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7315 pr " %s[i] = StringValueCStr (v);\n" n;
7317 pr " %s[len] = NULL;\n" n;
7320 pr " int %s = RTEST (%sv);\n" n n
7322 pr " int %s = NUM2INT (%sv);\n" n n
7327 match fst style with
7328 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7329 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7330 | RConstString _ | RConstOptString _ ->
7331 pr " const char *r;\n"; "NULL"
7332 | RString _ -> pr " char *r;\n"; "NULL"
7333 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7334 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7335 | RStructList (_, typ) ->
7336 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7339 pr " size_t size;\n";
7343 pr " r = guestfs_%s " name;
7344 generate_c_call_args ~handle:"g" style;
7349 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7351 pr " free (%s);\n" n
7354 pr " if (r == %s)\n" error_code;
7355 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7358 (match fst style with
7360 pr " return Qnil;\n"
7361 | RInt _ | RBool _ ->
7362 pr " return INT2NUM (r);\n"
7364 pr " return ULL2NUM (r);\n"
7366 pr " return rb_str_new2 (r);\n";
7367 | RConstOptString _ ->
7369 pr " return rb_str_new2 (r);\n";
7371 pr " return Qnil;\n";
7373 pr " VALUE rv = rb_str_new2 (r);\n";
7377 pr " int i, len = 0;\n";
7378 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7379 pr " VALUE rv = rb_ary_new2 (len);\n";
7380 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7381 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7382 pr " free (r[i]);\n";
7386 | RStruct (_, typ) ->
7387 let cols = cols_of_struct typ in
7388 generate_ruby_struct_code typ cols
7389 | RStructList (_, typ) ->
7390 let cols = cols_of_struct typ in
7391 generate_ruby_struct_list_code typ cols
7393 pr " VALUE rv = rb_hash_new ();\n";
7395 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7396 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7397 pr " free (r[i]);\n";
7398 pr " free (r[i+1]);\n";
7403 pr " VALUE rv = rb_str_new (r, size);\n";
7413 /* Initialize the module. */
7414 void Init__guestfs ()
7416 m_guestfs = rb_define_module (\"Guestfs\");
7417 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7418 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7420 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7421 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7424 (* Define the rest of the methods. *)
7426 fun (name, style, _, _, _, _, _) ->
7427 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7428 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7433 (* Ruby code to return a struct. *)
7434 and generate_ruby_struct_code typ cols =
7435 pr " VALUE rv = rb_hash_new ();\n";
7439 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7441 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7443 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7444 | name, (FBytes|FUInt64) ->
7445 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7447 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7449 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7451 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7452 | name, FOptPercent ->
7453 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7454 | name, FChar -> (* XXX wrong? *)
7455 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7457 pr " guestfs_free_%s (r);\n" typ;
7460 (* Ruby code to return a struct list. *)
7461 and generate_ruby_struct_list_code typ cols =
7462 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7464 pr " for (i = 0; i < r->len; ++i) {\n";
7465 pr " VALUE hv = rb_hash_new ();\n";
7469 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7471 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, r->val[i].%s_len));\n" name name name
7473 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7474 | name, (FBytes|FUInt64) ->
7475 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7477 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7479 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7481 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7482 | name, FOptPercent ->
7483 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7484 | name, FChar -> (* XXX wrong? *)
7485 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7487 pr " rb_ary_push (rv, hv);\n";
7489 pr " guestfs_free_%s_list (r);\n" typ;
7492 (* Generate Java bindings GuestFS.java file. *)
7493 and generate_java_java () =
7494 generate_header CStyle LGPLv2;
7497 package com.redhat.et.libguestfs;
7499 import java.util.HashMap;
7500 import com.redhat.et.libguestfs.LibGuestFSException;
7501 import com.redhat.et.libguestfs.PV;
7502 import com.redhat.et.libguestfs.VG;
7503 import com.redhat.et.libguestfs.LV;
7504 import com.redhat.et.libguestfs.Stat;
7505 import com.redhat.et.libguestfs.StatVFS;
7506 import com.redhat.et.libguestfs.IntBool;
7507 import com.redhat.et.libguestfs.Dirent;
7510 * The GuestFS object is a libguestfs handle.
7514 public class GuestFS {
7515 // Load the native code.
7517 System.loadLibrary (\"guestfs_jni\");
7521 * The native guestfs_h pointer.
7526 * Create a libguestfs handle.
7528 * @throws LibGuestFSException
7530 public GuestFS () throws LibGuestFSException
7534 private native long _create () throws LibGuestFSException;
7537 * Close a libguestfs handle.
7539 * You can also leave handles to be collected by the garbage
7540 * collector, but this method ensures that the resources used
7541 * by the handle are freed up immediately. If you call any
7542 * other methods after closing the handle, you will get an
7545 * @throws LibGuestFSException
7547 public void close () throws LibGuestFSException
7553 private native void _close (long g) throws LibGuestFSException;
7555 public void finalize () throws LibGuestFSException
7563 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7564 if not (List.mem NotInDocs flags); then (
7565 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7567 if List.mem ProtocolLimitWarning flags then
7568 doc ^ "\n\n" ^ protocol_limit_warning
7571 if List.mem DangerWillRobinson flags then
7572 doc ^ "\n\n" ^ danger_will_robinson
7574 let doc = pod2text ~width:60 name doc in
7575 let doc = List.map ( (* RHBZ#501883 *)
7578 | nonempty -> nonempty
7580 let doc = String.concat "\n * " doc in
7583 pr " * %s\n" shortdesc;
7586 pr " * @throws LibGuestFSException\n";
7590 generate_java_prototype ~public:true ~semicolon:false name style;
7593 pr " if (g == 0)\n";
7594 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
7597 if fst style <> RErr then pr "return ";
7599 generate_java_call_args ~handle:"g" (snd style);
7603 generate_java_prototype ~privat:true ~native:true name style;
7610 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
7611 and generate_java_call_args ~handle args =
7613 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7616 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
7617 ?(semicolon=true) name style =
7618 if privat then pr "private ";
7619 if public then pr "public ";
7620 if native then pr "native ";
7623 (match fst style with
7624 | RErr -> pr "void ";
7625 | RInt _ -> pr "int ";
7626 | RInt64 _ -> pr "long ";
7627 | RBool _ -> pr "boolean ";
7628 | RConstString _ | RConstOptString _ | RString _
7629 | RBufferOut _ -> pr "String ";
7630 | RStringList _ -> pr "String[] ";
7631 | RStruct (_, typ) ->
7632 let name = java_name_of_struct typ in
7634 | RStructList (_, typ) ->
7635 let name = java_name_of_struct typ in
7637 | RHashtable _ -> pr "HashMap<String,String> ";
7640 if native then pr "_%s " name else pr "%s " name;
7642 let needs_comma = ref false in
7651 if !needs_comma then pr ", ";
7652 needs_comma := true;
7669 pr " throws LibGuestFSException";
7670 if semicolon then pr ";"
7672 and generate_java_struct jtyp cols =
7673 generate_header CStyle LGPLv2;
7676 package com.redhat.et.libguestfs;
7679 * Libguestfs %s structure.
7691 | name, FBuffer -> pr " public String %s;\n" name
7692 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
7693 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
7694 | name, FChar -> pr " public char %s;\n" name
7695 | name, FOptPercent ->
7696 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
7697 pr " public float %s;\n" name
7702 and generate_java_c () =
7703 generate_header CStyle LGPLv2;
7710 #include \"com_redhat_et_libguestfs_GuestFS.h\"
7711 #include \"guestfs.h\"
7713 /* Note that this function returns. The exception is not thrown
7714 * until after the wrapper function returns.
7717 throw_exception (JNIEnv *env, const char *msg)
7720 cl = (*env)->FindClass (env,
7721 \"com/redhat/et/libguestfs/LibGuestFSException\");
7722 (*env)->ThrowNew (env, cl, msg);
7725 JNIEXPORT jlong JNICALL
7726 Java_com_redhat_et_libguestfs_GuestFS__1create
7727 (JNIEnv *env, jobject obj)
7731 g = guestfs_create ();
7733 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
7736 guestfs_set_error_handler (g, NULL, NULL);
7737 return (jlong) (long) g;
7740 JNIEXPORT void JNICALL
7741 Java_com_redhat_et_libguestfs_GuestFS__1close
7742 (JNIEnv *env, jobject obj, jlong jg)
7744 guestfs_h *g = (guestfs_h *) (long) jg;
7751 fun (name, style, _, _, _, _, _) ->
7753 (match fst style with
7754 | RErr -> pr "void ";
7755 | RInt _ -> pr "jint ";
7756 | RInt64 _ -> pr "jlong ";
7757 | RBool _ -> pr "jboolean ";
7758 | RConstString _ | RConstOptString _ | RString _
7759 | RBufferOut _ -> pr "jstring ";
7760 | RStruct _ | RHashtable _ ->
7762 | RStringList _ | RStructList _ ->
7766 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7767 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7769 pr " (JNIEnv *env, jobject obj, jlong jg";
7776 pr ", jstring j%s" n
7778 pr ", jobjectArray j%s" n
7780 pr ", jboolean j%s" n
7786 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7787 let error_code, no_ret =
7788 match fst style with
7789 | RErr -> pr " int r;\n"; "-1", ""
7791 | RInt _ -> pr " int r;\n"; "-1", "0"
7792 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7793 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7794 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
7796 pr " jstring jr;\n";
7797 pr " char *r;\n"; "NULL", "NULL"
7799 pr " jobjectArray jr;\n";
7802 pr " jstring jstr;\n";
7803 pr " char **r;\n"; "NULL", "NULL"
7804 | RStruct (_, typ) ->
7805 pr " jobject jr;\n";
7807 pr " jfieldID fl;\n";
7808 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
7809 | RStructList (_, typ) ->
7810 pr " jobjectArray jr;\n";
7812 pr " jfieldID fl;\n";
7813 pr " jobject jfl;\n";
7814 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
7815 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
7817 pr " jstring jr;\n";
7819 pr " size_t size;\n";
7827 pr " const char *%s;\n" n
7829 pr " int %s_len;\n" n;
7830 pr " const char **%s;\n" n
7837 (match fst style with
7838 | RStringList _ | RStructList _ -> true
7839 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7841 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
7842 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7848 (* Get the parameters. *)
7854 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7856 (* This is completely undocumented, but Java null becomes
7859 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
7861 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
7862 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
7863 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7864 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7866 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
7868 pr " %s[%s_len] = NULL;\n" n n;
7871 pr " %s = j%s;\n" n n
7874 (* Make the call. *)
7875 pr " r = guestfs_%s " name;
7876 generate_c_call_args ~handle:"g" style;
7879 (* Release the parameters. *)
7885 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7888 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7890 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7891 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7893 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7895 pr " free (%s);\n" n
7900 (* Check for errors. *)
7901 pr " if (r == %s) {\n" error_code;
7902 pr " throw_exception (env, guestfs_last_error (g));\n";
7903 pr " return %s;\n" no_ret;
7907 (match fst style with
7909 | RInt _ -> pr " return (jint) r;\n"
7910 | RBool _ -> pr " return (jboolean) r;\n"
7911 | RInt64 _ -> pr " return (jlong) r;\n"
7912 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7913 | RConstOptString _ ->
7914 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
7916 pr " jr = (*env)->NewStringUTF (env, r);\n";
7920 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7921 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7922 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7923 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7924 pr " for (i = 0; i < r_len; ++i) {\n";
7925 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7926 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7927 pr " free (r[i]);\n";
7931 | RStruct (_, typ) ->
7932 let jtyp = java_name_of_struct typ in
7933 let cols = cols_of_struct typ in
7934 generate_java_struct_return typ jtyp cols
7935 | RStructList (_, typ) ->
7936 let jtyp = java_name_of_struct typ in
7937 let cols = cols_of_struct typ in
7938 generate_java_struct_list_return typ jtyp cols
7941 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7942 pr " return NULL;\n"
7944 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
7953 and generate_java_struct_return typ jtyp cols =
7954 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7955 pr " jr = (*env)->AllocObject (env, cl);\n";
7959 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7960 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
7963 pr " char s[33];\n";
7964 pr " memcpy (s, r->%s, 32);\n" name;
7966 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7967 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
7971 pr " int len = r->%s_len;\n" name;
7972 pr " char s[len+1];\n";
7973 pr " memcpy (s, r->%s, len);\n" name;
7974 pr " s[len] = 0;\n";
7975 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7976 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
7978 | name, (FBytes|FUInt64|FInt64) ->
7979 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7980 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7981 | name, (FUInt32|FInt32) ->
7982 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
7983 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7984 | name, FOptPercent ->
7985 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7986 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
7988 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
7989 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7994 and generate_java_struct_list_return typ jtyp cols =
7995 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7996 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7997 pr " for (i = 0; i < r->len; ++i) {\n";
7998 pr " jfl = (*env)->AllocObject (env, cl);\n";
8002 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8003 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8006 pr " char s[33];\n";
8007 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8009 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8010 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8014 pr " int len = r->val[i].%s_len;\n" name;
8015 pr " char s[len+1];\n";
8016 pr " memcpy (s, r->val[i].%s, len);\n" name;
8017 pr " s[len] = 0;\n";
8018 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8019 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8021 | name, (FBytes|FUInt64|FInt64) ->
8022 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8023 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8024 | name, (FUInt32|FInt32) ->
8025 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8026 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8027 | name, FOptPercent ->
8028 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8029 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8031 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8032 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8034 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8036 pr " guestfs_free_%s_list (r);\n" typ;
8039 and generate_haskell_hs () =
8040 generate_header HaskellStyle LGPLv2;
8042 (* XXX We only know how to generate partial FFI for Haskell
8043 * at the moment. Please help out!
8045 let can_generate style =
8049 | RInt64 _, _ -> true
8052 | RConstOptString _, _
8058 | RBufferOut _, _ -> false in
8061 {-# INCLUDE <guestfs.h> #-}
8062 {-# LANGUAGE ForeignFunctionInterface #-}
8067 (* List out the names of the actions we want to export. *)
8069 fun (name, style, _, _, _, _, _) ->
8070 if can_generate style then pr ",\n %s" name
8077 import Foreign.C.Types
8079 import Control.Exception
8080 import Data.Typeable
8082 data GuestfsS = GuestfsS -- represents the opaque C struct
8083 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8084 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8086 -- XXX define properly later XXX
8090 data IntBool = IntBool
8092 data StatVFS = StatVFS
8093 data Hashtable = Hashtable
8095 foreign import ccall unsafe \"guestfs_create\" c_create
8097 foreign import ccall unsafe \"&guestfs_close\" c_close
8098 :: FunPtr (GuestfsP -> IO ())
8099 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8100 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8102 create :: IO GuestfsH
8105 c_set_error_handler p nullPtr nullPtr
8106 h <- newForeignPtr c_close p
8109 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8110 :: GuestfsP -> IO CString
8112 -- last_error :: GuestfsH -> IO (Maybe String)
8113 -- last_error h = do
8114 -- str <- withForeignPtr h (\\p -> c_last_error p)
8115 -- maybePeek peekCString str
8117 last_error :: GuestfsH -> IO (String)
8119 str <- withForeignPtr h (\\p -> c_last_error p)
8121 then return \"no error\"
8122 else peekCString str
8126 (* Generate wrappers for each foreign function. *)
8128 fun (name, style, _, _, _, _, _) ->
8129 if can_generate style then (
8130 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8132 generate_haskell_prototype ~handle:"GuestfsP" style;
8136 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8138 pr "%s %s = do\n" name
8139 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8141 (* Convert pointer arguments using with* functions. *)
8146 | String n -> pr "withCString %s $ \\%s -> " n n
8147 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8148 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8149 | Bool _ | Int _ -> ()
8151 (* Convert integer arguments. *)
8155 | Bool n -> sprintf "(fromBool %s)" n
8156 | Int n -> sprintf "(fromIntegral %s)" n
8157 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8159 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8160 (String.concat " " ("p" :: args));
8161 (match fst style with
8162 | RErr | RInt _ | RInt64 _ | RBool _ ->
8163 pr " if (r == -1)\n";
8165 pr " err <- last_error h\n";
8167 | RConstString _ | RConstOptString _ | RString _
8168 | RStringList _ | RStruct _
8169 | RStructList _ | RHashtable _ | RBufferOut _ ->
8170 pr " if (r == nullPtr)\n";
8172 pr " err <- last_error h\n";
8175 (match fst style with
8177 pr " else return ()\n"
8179 pr " else return (fromIntegral r)\n"
8181 pr " else return (fromIntegral r)\n"
8183 pr " else return (toBool r)\n"
8192 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8198 and generate_haskell_prototype ~handle ?(hs = false) style =
8200 let string = if hs then "String" else "CString" in
8201 let int = if hs then "Int" else "CInt" in
8202 let bool = if hs then "Bool" else "CInt" in
8203 let int64 = if hs then "Integer" else "Int64" in
8207 | String _ -> pr "%s" string
8208 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8209 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8210 | Bool _ -> pr "%s" bool
8211 | Int _ -> pr "%s" int
8212 | FileIn _ -> pr "%s" string
8213 | FileOut _ -> pr "%s" string
8218 (match fst style with
8219 | RErr -> if not hs then pr "CInt"
8220 | RInt _ -> pr "%s" int
8221 | RInt64 _ -> pr "%s" int64
8222 | RBool _ -> pr "%s" bool
8223 | RConstString _ -> pr "%s" string
8224 | RConstOptString _ -> pr "Maybe %s" string
8225 | RString _ -> pr "%s" string
8226 | RStringList _ -> pr "[%s]" string
8227 | RStruct (_, typ) ->
8228 let name = java_name_of_struct typ in
8230 | RStructList (_, typ) ->
8231 let name = java_name_of_struct typ in
8233 | RHashtable _ -> pr "Hashtable"
8234 | RBufferOut _ -> pr "%s" string
8238 and generate_bindtests () =
8239 generate_header CStyle LGPLv2;
8244 #include <inttypes.h>
8247 #include \"guestfs.h\"
8248 #include \"guestfs_protocol.h\"
8250 #define error guestfs_error
8251 #define safe_calloc guestfs_safe_calloc
8252 #define safe_malloc guestfs_safe_malloc
8255 print_strings (char * const* const argv)
8260 for (argc = 0; argv[argc] != NULL; ++argc) {
8261 if (argc > 0) printf (\", \");
8262 printf (\"\\\"%%s\\\"\", argv[argc]);
8267 /* The test0 function prints its parameters to stdout. */
8271 match test_functions with
8272 | [] -> assert false
8273 | test0 :: tests -> test0, tests in
8276 let (name, style, _, _, _, _, _) = test0 in
8277 generate_prototype ~extern:false ~semicolon:false ~newline:true
8278 ~handle:"g" ~prefix:"guestfs_" name style;
8284 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8285 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8286 | StringList n -> pr " print_strings (%s);\n" n
8287 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8288 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8290 pr " /* Java changes stdout line buffering so we need this: */\n";
8291 pr " fflush (stdout);\n";
8297 fun (name, style, _, _, _, _, _) ->
8298 if String.sub name (String.length name - 3) 3 <> "err" then (
8299 pr "/* Test normal return. */\n";
8300 generate_prototype ~extern:false ~semicolon:false ~newline:true
8301 ~handle:"g" ~prefix:"guestfs_" name style;
8303 (match fst style with
8308 pr " sscanf (val, \"%%d\", &r);\n";
8312 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8315 pr " return strcmp (val, \"true\") == 0;\n"
8317 | RConstOptString _ ->
8318 (* Can't return the input string here. Return a static
8319 * string so we ensure we get a segfault if the caller
8322 pr " return \"static string\";\n"
8324 pr " return strdup (val);\n"
8326 pr " char **strs;\n";
8328 pr " sscanf (val, \"%%d\", &n);\n";
8329 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8330 pr " for (i = 0; i < n; ++i) {\n";
8331 pr " strs[i] = safe_malloc (g, 16);\n";
8332 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8334 pr " strs[n] = NULL;\n";
8335 pr " return strs;\n"
8336 | RStruct (_, typ) ->
8337 pr " struct guestfs_%s *r;\n" typ;
8338 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8340 | RStructList (_, typ) ->
8341 pr " struct guestfs_%s_list *r;\n" typ;
8342 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8343 pr " sscanf (val, \"%%d\", &r->len);\n";
8344 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8347 pr " char **strs;\n";
8349 pr " sscanf (val, \"%%d\", &n);\n";
8350 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8351 pr " for (i = 0; i < n; ++i) {\n";
8352 pr " strs[i*2] = safe_malloc (g, 16);\n";
8353 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8354 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8355 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8357 pr " strs[n*2] = NULL;\n";
8358 pr " return strs;\n"
8360 pr " return strdup (val);\n"
8365 pr "/* Test error return. */\n";
8366 generate_prototype ~extern:false ~semicolon:false ~newline:true
8367 ~handle:"g" ~prefix:"guestfs_" name style;
8369 pr " error (g, \"error\");\n";
8370 (match fst style with
8371 | RErr | RInt _ | RInt64 _ | RBool _ ->
8373 | RConstString _ | RConstOptString _
8374 | RString _ | RStringList _ | RStruct _
8378 pr " return NULL;\n"
8385 and generate_ocaml_bindtests () =
8386 generate_header OCamlStyle GPLv2;
8390 let g = Guestfs.create () in
8397 | CallString s -> "\"" ^ s ^ "\""
8398 | CallOptString None -> "None"
8399 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8400 | CallStringList xs ->
8401 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8402 | CallInt i when i >= 0 -> string_of_int i
8403 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8404 | CallBool b -> string_of_bool b
8409 generate_lang_bindtests (
8410 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8413 pr "print_endline \"EOF\"\n"
8415 and generate_perl_bindtests () =
8416 pr "#!/usr/bin/perl -w\n";
8417 generate_header HashStyle GPLv2;
8424 my $g = Sys::Guestfs->new ();
8428 String.concat ", " (
8431 | CallString s -> "\"" ^ s ^ "\""
8432 | CallOptString None -> "undef"
8433 | CallOptString (Some s) -> sprintf "\"%s\"" s
8434 | CallStringList xs ->
8435 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8436 | CallInt i -> string_of_int i
8437 | CallBool b -> if b then "1" else "0"
8442 generate_lang_bindtests (
8443 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8446 pr "print \"EOF\\n\"\n"
8448 and generate_python_bindtests () =
8449 generate_header HashStyle GPLv2;
8454 g = guestfs.GuestFS ()
8458 String.concat ", " (
8461 | CallString s -> "\"" ^ s ^ "\""
8462 | CallOptString None -> "None"
8463 | CallOptString (Some s) -> sprintf "\"%s\"" s
8464 | CallStringList xs ->
8465 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8466 | CallInt i -> string_of_int i
8467 | CallBool b -> if b then "1" else "0"
8472 generate_lang_bindtests (
8473 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8476 pr "print \"EOF\"\n"
8478 and generate_ruby_bindtests () =
8479 generate_header HashStyle GPLv2;
8484 g = Guestfs::create()
8488 String.concat ", " (
8491 | CallString s -> "\"" ^ s ^ "\""
8492 | CallOptString None -> "nil"
8493 | CallOptString (Some s) -> sprintf "\"%s\"" s
8494 | CallStringList xs ->
8495 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8496 | CallInt i -> string_of_int i
8497 | CallBool b -> string_of_bool b
8502 generate_lang_bindtests (
8503 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8506 pr "print \"EOF\\n\"\n"
8508 and generate_java_bindtests () =
8509 generate_header CStyle GPLv2;
8512 import com.redhat.et.libguestfs.*;
8514 public class Bindtests {
8515 public static void main (String[] argv)
8518 GuestFS g = new GuestFS ();
8522 String.concat ", " (
8525 | CallString s -> "\"" ^ s ^ "\""
8526 | CallOptString None -> "null"
8527 | CallOptString (Some s) -> sprintf "\"%s\"" s
8528 | CallStringList xs ->
8530 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8531 | CallInt i -> string_of_int i
8532 | CallBool b -> string_of_bool b
8537 generate_lang_bindtests (
8538 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8542 System.out.println (\"EOF\");
8544 catch (Exception exn) {
8545 System.err.println (exn);
8552 and generate_haskell_bindtests () =
8553 generate_header HaskellStyle GPLv2;
8556 module Bindtests where
8557 import qualified Guestfs
8567 | CallString s -> "\"" ^ s ^ "\""
8568 | CallOptString None -> "Nothing"
8569 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
8570 | CallStringList xs ->
8571 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8572 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
8573 | CallInt i -> string_of_int i
8574 | CallBool true -> "True"
8575 | CallBool false -> "False"
8580 generate_lang_bindtests (
8581 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
8584 pr " putStrLn \"EOF\"\n"
8586 (* Language-independent bindings tests - we do it this way to
8587 * ensure there is parity in testing bindings across all languages.
8589 and generate_lang_bindtests call =
8590 call "test0" [CallString "abc"; CallOptString (Some "def");
8591 CallStringList []; CallBool false;
8592 CallInt 0; CallString "123"; CallString "456"];
8593 call "test0" [CallString "abc"; CallOptString None;
8594 CallStringList []; CallBool false;
8595 CallInt 0; CallString "123"; CallString "456"];
8596 call "test0" [CallString ""; CallOptString (Some "def");
8597 CallStringList []; CallBool false;
8598 CallInt 0; CallString "123"; CallString "456"];
8599 call "test0" [CallString ""; CallOptString (Some "");
8600 CallStringList []; CallBool false;
8601 CallInt 0; CallString "123"; CallString "456"];
8602 call "test0" [CallString "abc"; CallOptString (Some "def");
8603 CallStringList ["1"]; CallBool false;
8604 CallInt 0; CallString "123"; CallString "456"];
8605 call "test0" [CallString "abc"; CallOptString (Some "def");
8606 CallStringList ["1"; "2"]; CallBool false;
8607 CallInt 0; CallString "123"; CallString "456"];
8608 call "test0" [CallString "abc"; CallOptString (Some "def");
8609 CallStringList ["1"]; CallBool true;
8610 CallInt 0; CallString "123"; CallString "456"];
8611 call "test0" [CallString "abc"; CallOptString (Some "def");
8612 CallStringList ["1"]; CallBool false;
8613 CallInt (-1); CallString "123"; CallString "456"];
8614 call "test0" [CallString "abc"; CallOptString (Some "def");
8615 CallStringList ["1"]; CallBool false;
8616 CallInt (-2); CallString "123"; CallString "456"];
8617 call "test0" [CallString "abc"; CallOptString (Some "def");
8618 CallStringList ["1"]; CallBool false;
8619 CallInt 1; CallString "123"; CallString "456"];
8620 call "test0" [CallString "abc"; CallOptString (Some "def");
8621 CallStringList ["1"]; CallBool false;
8622 CallInt 2; CallString "123"; CallString "456"];
8623 call "test0" [CallString "abc"; CallOptString (Some "def");
8624 CallStringList ["1"]; CallBool false;
8625 CallInt 4095; CallString "123"; CallString "456"];
8626 call "test0" [CallString "abc"; CallOptString (Some "def");
8627 CallStringList ["1"]; CallBool false;
8628 CallInt 0; CallString ""; CallString ""]
8630 (* XXX Add here tests of the return and error functions. *)
8632 (* This is used to generate the src/MAX_PROC_NR file which
8633 * contains the maximum procedure number, a surrogate for the
8634 * ABI version number. See src/Makefile.am for the details.
8636 and generate_max_proc_nr () =
8637 let proc_nrs = List.map (
8638 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
8639 ) daemon_functions in
8641 let max_proc_nr = List.fold_left max 0 proc_nrs in
8643 pr "%d\n" max_proc_nr
8645 let output_to filename =
8646 let filename_new = filename ^ ".new" in
8647 chan := open_out filename_new;
8652 (* Is the new file different from the current file? *)
8653 if Sys.file_exists filename && files_equal filename filename_new then
8654 Unix.unlink filename_new (* same, so skip it *)
8656 (* different, overwrite old one *)
8657 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
8658 Unix.rename filename_new filename;
8659 Unix.chmod filename 0o444;
8660 printf "written %s\n%!" filename;
8669 if not (Sys.file_exists "HACKING") then (
8671 You are probably running this from the wrong directory.
8672 Run it from the top source directory using the command
8678 let close = output_to "src/guestfs_protocol.x" in
8682 let close = output_to "src/guestfs-structs.h" in
8683 generate_structs_h ();
8686 let close = output_to "src/guestfs-actions.h" in
8687 generate_actions_h ();
8690 let close = output_to "src/guestfs-actions.c" in
8691 generate_client_actions ();
8694 let close = output_to "daemon/actions.h" in
8695 generate_daemon_actions_h ();
8698 let close = output_to "daemon/stubs.c" in
8699 generate_daemon_actions ();
8702 let close = output_to "daemon/names.c" in
8703 generate_daemon_names ();
8706 let close = output_to "capitests/tests.c" in
8710 let close = output_to "src/guestfs-bindtests.c" in
8711 generate_bindtests ();
8714 let close = output_to "fish/cmds.c" in
8715 generate_fish_cmds ();
8718 let close = output_to "fish/completion.c" in
8719 generate_fish_completion ();
8722 let close = output_to "guestfs-structs.pod" in
8723 generate_structs_pod ();
8726 let close = output_to "guestfs-actions.pod" in
8727 generate_actions_pod ();
8730 let close = output_to "guestfish-actions.pod" in
8731 generate_fish_actions_pod ();
8734 let close = output_to "ocaml/guestfs.mli" in
8735 generate_ocaml_mli ();
8738 let close = output_to "ocaml/guestfs.ml" in
8739 generate_ocaml_ml ();
8742 let close = output_to "ocaml/guestfs_c_actions.c" in
8743 generate_ocaml_c ();
8746 let close = output_to "ocaml/bindtests.ml" in
8747 generate_ocaml_bindtests ();
8750 let close = output_to "perl/Guestfs.xs" in
8751 generate_perl_xs ();
8754 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8755 generate_perl_pm ();
8758 let close = output_to "perl/bindtests.pl" in
8759 generate_perl_bindtests ();
8762 let close = output_to "python/guestfs-py.c" in
8763 generate_python_c ();
8766 let close = output_to "python/guestfs.py" in
8767 generate_python_py ();
8770 let close = output_to "python/bindtests.py" in
8771 generate_python_bindtests ();
8774 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8778 let close = output_to "ruby/bindtests.rb" in
8779 generate_ruby_bindtests ();
8782 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8783 generate_java_java ();
8788 let cols = cols_of_struct typ in
8789 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
8790 let close = output_to filename in
8791 generate_java_struct jtyp cols;
8795 let close = output_to "java/Makefile.inc" in
8796 pr "java_built_sources =";
8799 pr " com/redhat/et/libguestfs/%s.java" jtyp;
8801 pr " com/redhat/et/libguestfs/GuestFS.java\n";
8804 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8808 let close = output_to "java/Bindtests.java" in
8809 generate_java_bindtests ();
8812 let close = output_to "haskell/Guestfs.hs" in
8813 generate_haskell_hs ();
8816 let close = output_to "haskell/Bindtests.hs" in
8817 generate_haskell_bindtests ();
8820 let close = output_to "src/MAX_PROC_NR" in
8821 generate_max_proc_nr ();
8824 (* Always generate this file last, and unconditionally. It's used
8825 * by the Makefile to know when we must re-run the generator.
8827 let chan = open_out "src/stamp-generator" in