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 *)
172 | DeprecatedBy of string (* function is deprecated, use .. instead *)
174 (* You can supply zero or as many tests as you want per API call.
176 * Note that the test environment has 3 block devices, of size 500MB,
177 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
178 * a fourth squashfs block device with some known files on it (/dev/sdd).
180 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
181 * Number of cylinders was 63 for IDE emulated disks with precisely
182 * the same size. How exactly this is calculated is a mystery.
184 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
186 * To be able to run the tests in a reasonable amount of time,
187 * the virtual machine and block devices are reused between tests.
188 * So don't try testing kill_subprocess :-x
190 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
192 * Don't assume anything about the previous contents of the block
193 * devices. Use 'Init*' to create some initial scenarios.
195 * You can add a prerequisite clause to any individual test. This
196 * is a run-time check, which, if it fails, causes the test to be
197 * skipped. Useful if testing a command which might not work on
198 * all variations of libguestfs builds. A test that has prerequisite
199 * of 'Always' is run unconditionally.
201 * In addition, packagers can skip individual tests by setting the
202 * environment variables: eg:
203 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
204 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
206 type tests = (test_init * test_prereq * test) list
208 (* Run the command sequence and just expect nothing to fail. *)
210 (* Run the command sequence and expect the output of the final
211 * command to be the string.
213 | TestOutput of seq * string
214 (* Run the command sequence and expect the output of the final
215 * command to be the list of strings.
217 | TestOutputList of seq * string list
218 (* Run the command sequence and expect the output of the final
219 * command to be the list of block devices (could be either
220 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
221 * character of each string).
223 | TestOutputListOfDevices of seq * string list
224 (* Run the command sequence and expect the output of the final
225 * command to be the integer.
227 | TestOutputInt of seq * int
228 (* Run the command sequence and expect the output of the final
229 * command to be <op> <int>, eg. ">=", "1".
231 | TestOutputIntOp of seq * string * int
232 (* Run the command sequence and expect the output of the final
233 * command to be a true value (!= 0 or != NULL).
235 | TestOutputTrue of seq
236 (* Run the command sequence and expect the output of the final
237 * command to be a false value (== 0 or == NULL, but not an error).
239 | TestOutputFalse of seq
240 (* Run the command sequence and expect the output of the final
241 * command to be a list of the given length (but don't care about
244 | TestOutputLength of seq * int
245 (* Run the command sequence and expect the output of the final
246 * command to be a structure.
248 | TestOutputStruct of seq * test_field_compare list
249 (* Run the command sequence and expect the final command (only)
252 | TestLastFail of seq
254 and test_field_compare =
255 | CompareWithInt of string * int
256 | CompareWithIntOp of string * string * int
257 | CompareWithString of string * string
258 | CompareFieldsIntEq of string * string
259 | CompareFieldsStrEq of string * string
261 (* Test prerequisites. *)
263 (* Test always runs. *)
265 (* Test is currently disabled - eg. it fails, or it tests some
266 * unimplemented feature.
269 (* 'string' is some C code (a function body) that should return
270 * true or false. The test will run if the code returns true.
273 (* As for 'If' but the test runs _unless_ the code returns true. *)
276 (* Some initial scenarios for testing. *)
278 (* Do nothing, block devices could contain random stuff including
279 * LVM PVs, and some filesystems might be mounted. This is usually
284 (* Block devices are empty and no filesystems are mounted. *)
287 (* /dev/sda contains a single partition /dev/sda1, which is formatted
288 * as ext2, empty [except for lost+found] and mounted on /.
289 * /dev/sdb and /dev/sdc may have random content.
295 * /dev/sda1 (is a PV):
296 * /dev/VG/LV (size 8MB):
297 * formatted as ext2, empty [except for lost+found], mounted on /
298 * /dev/sdb and /dev/sdc may have random content.
302 (* /dev/sdd (the squashfs, see images/ directory in source)
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 This call will also transparently look inside various types
1455 The exact command which runs is C<file -zbsL path>. Note in
1456 particular that the filename is not prepended to the output
1457 (the C<-b> option).");
1459 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1460 [InitBasicFS, Always, TestOutput (
1461 [["upload"; "test-command"; "/test-command"];
1462 ["chmod"; "0o755"; "/test-command"];
1463 ["command"; "/test-command 1"]], "Result1");
1464 InitBasicFS, Always, TestOutput (
1465 [["upload"; "test-command"; "/test-command"];
1466 ["chmod"; "0o755"; "/test-command"];
1467 ["command"; "/test-command 2"]], "Result2\n");
1468 InitBasicFS, Always, TestOutput (
1469 [["upload"; "test-command"; "/test-command"];
1470 ["chmod"; "0o755"; "/test-command"];
1471 ["command"; "/test-command 3"]], "\nResult3");
1472 InitBasicFS, Always, TestOutput (
1473 [["upload"; "test-command"; "/test-command"];
1474 ["chmod"; "0o755"; "/test-command"];
1475 ["command"; "/test-command 4"]], "\nResult4\n");
1476 InitBasicFS, Always, TestOutput (
1477 [["upload"; "test-command"; "/test-command"];
1478 ["chmod"; "0o755"; "/test-command"];
1479 ["command"; "/test-command 5"]], "\nResult5\n\n");
1480 InitBasicFS, Always, TestOutput (
1481 [["upload"; "test-command"; "/test-command"];
1482 ["chmod"; "0o755"; "/test-command"];
1483 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1484 InitBasicFS, Always, TestOutput (
1485 [["upload"; "test-command"; "/test-command"];
1486 ["chmod"; "0o755"; "/test-command"];
1487 ["command"; "/test-command 7"]], "");
1488 InitBasicFS, Always, TestOutput (
1489 [["upload"; "test-command"; "/test-command"];
1490 ["chmod"; "0o755"; "/test-command"];
1491 ["command"; "/test-command 8"]], "\n");
1492 InitBasicFS, Always, TestOutput (
1493 [["upload"; "test-command"; "/test-command"];
1494 ["chmod"; "0o755"; "/test-command"];
1495 ["command"; "/test-command 9"]], "\n\n");
1496 InitBasicFS, Always, TestOutput (
1497 [["upload"; "test-command"; "/test-command"];
1498 ["chmod"; "0o755"; "/test-command"];
1499 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1500 InitBasicFS, Always, TestOutput (
1501 [["upload"; "test-command"; "/test-command"];
1502 ["chmod"; "0o755"; "/test-command"];
1503 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1504 InitBasicFS, Always, TestLastFail (
1505 [["upload"; "test-command"; "/test-command"];
1506 ["chmod"; "0o755"; "/test-command"];
1507 ["command"; "/test-command"]])],
1508 "run a command from the guest filesystem",
1510 This call runs a command from the guest filesystem. The
1511 filesystem must be mounted, and must contain a compatible
1512 operating system (ie. something Linux, with the same
1513 or compatible processor architecture).
1515 The single parameter is an argv-style list of arguments.
1516 The first element is the name of the program to run.
1517 Subsequent elements are parameters. The list must be
1518 non-empty (ie. must contain a program name). Note that
1519 the command runs directly, and is I<not> invoked via
1520 the shell (see C<guestfs_sh>).
1522 The return value is anything printed to I<stdout> by
1525 If the command returns a non-zero exit status, then
1526 this function returns an error message. The error message
1527 string is the content of I<stderr> from the command.
1529 The C<$PATH> environment variable will contain at least
1530 C</usr/bin> and C</bin>. If you require a program from
1531 another location, you should provide the full path in the
1534 Shared libraries and data files required by the program
1535 must be available on filesystems which are mounted in the
1536 correct places. It is the caller's responsibility to ensure
1537 all filesystems that are needed are mounted at the right
1540 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1541 [InitBasicFS, Always, TestOutputList (
1542 [["upload"; "test-command"; "/test-command"];
1543 ["chmod"; "0o755"; "/test-command"];
1544 ["command_lines"; "/test-command 1"]], ["Result1"]);
1545 InitBasicFS, Always, TestOutputList (
1546 [["upload"; "test-command"; "/test-command"];
1547 ["chmod"; "0o755"; "/test-command"];
1548 ["command_lines"; "/test-command 2"]], ["Result2"]);
1549 InitBasicFS, Always, TestOutputList (
1550 [["upload"; "test-command"; "/test-command"];
1551 ["chmod"; "0o755"; "/test-command"];
1552 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1553 InitBasicFS, Always, TestOutputList (
1554 [["upload"; "test-command"; "/test-command"];
1555 ["chmod"; "0o755"; "/test-command"];
1556 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1557 InitBasicFS, Always, TestOutputList (
1558 [["upload"; "test-command"; "/test-command"];
1559 ["chmod"; "0o755"; "/test-command"];
1560 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1561 InitBasicFS, Always, TestOutputList (
1562 [["upload"; "test-command"; "/test-command"];
1563 ["chmod"; "0o755"; "/test-command"];
1564 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1565 InitBasicFS, Always, TestOutputList (
1566 [["upload"; "test-command"; "/test-command"];
1567 ["chmod"; "0o755"; "/test-command"];
1568 ["command_lines"; "/test-command 7"]], []);
1569 InitBasicFS, Always, TestOutputList (
1570 [["upload"; "test-command"; "/test-command"];
1571 ["chmod"; "0o755"; "/test-command"];
1572 ["command_lines"; "/test-command 8"]], [""]);
1573 InitBasicFS, Always, TestOutputList (
1574 [["upload"; "test-command"; "/test-command"];
1575 ["chmod"; "0o755"; "/test-command"];
1576 ["command_lines"; "/test-command 9"]], ["";""]);
1577 InitBasicFS, Always, TestOutputList (
1578 [["upload"; "test-command"; "/test-command"];
1579 ["chmod"; "0o755"; "/test-command"];
1580 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1581 InitBasicFS, Always, TestOutputList (
1582 [["upload"; "test-command"; "/test-command"];
1583 ["chmod"; "0o755"; "/test-command"];
1584 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1585 "run a command, returning lines",
1587 This is the same as C<guestfs_command>, but splits the
1588 result into a list of lines.
1590 See also: C<guestfs_sh_lines>");
1592 ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1593 [InitBasicFS, Always, TestOutputStruct (
1595 ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1596 "get file information",
1598 Returns file information for the given C<path>.
1600 This is the same as the C<stat(2)> system call.");
1602 ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1603 [InitBasicFS, Always, TestOutputStruct (
1605 ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1606 "get file information for a symbolic link",
1608 Returns file information for the given C<path>.
1610 This is the same as C<guestfs_stat> except that if C<path>
1611 is a symbolic link, then the link is stat-ed, not the file it
1614 This is the same as the C<lstat(2)> system call.");
1616 ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1617 [InitBasicFS, Always, TestOutputStruct (
1618 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255);
1619 CompareWithInt ("bsize", 1024)])],
1620 "get file system statistics",
1622 Returns file system statistics for any mounted file system.
1623 C<path> should be a file or directory in the mounted file system
1624 (typically it is the mount point itself, but it doesn't need to be).
1626 This is the same as the C<statvfs(2)> system call.");
1628 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1630 "get ext2/ext3/ext4 superblock details",
1632 This returns the contents of the ext2, ext3 or ext4 filesystem
1633 superblock on C<device>.
1635 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1636 manpage for more details. The list of fields returned isn't
1637 clearly defined, and depends on both the version of C<tune2fs>
1638 that libguestfs was built against, and the filesystem itself.");
1640 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1641 [InitEmpty, Always, TestOutputTrue (
1642 [["blockdev_setro"; "/dev/sda"];
1643 ["blockdev_getro"; "/dev/sda"]])],
1644 "set block device to read-only",
1646 Sets the block device named C<device> to read-only.
1648 This uses the L<blockdev(8)> command.");
1650 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1651 [InitEmpty, Always, TestOutputFalse (
1652 [["blockdev_setrw"; "/dev/sda"];
1653 ["blockdev_getro"; "/dev/sda"]])],
1654 "set block device to read-write",
1656 Sets the block device named C<device> to read-write.
1658 This uses the L<blockdev(8)> command.");
1660 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1661 [InitEmpty, Always, TestOutputTrue (
1662 [["blockdev_setro"; "/dev/sda"];
1663 ["blockdev_getro"; "/dev/sda"]])],
1664 "is block device set to read-only",
1666 Returns a boolean indicating if the block device is read-only
1667 (true if read-only, false if not).
1669 This uses the L<blockdev(8)> command.");
1671 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1672 [InitEmpty, Always, TestOutputInt (
1673 [["blockdev_getss"; "/dev/sda"]], 512)],
1674 "get sectorsize of block device",
1676 This returns the size of sectors on a block device.
1677 Usually 512, but can be larger for modern devices.
1679 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1682 This uses the L<blockdev(8)> command.");
1684 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1685 [InitEmpty, Always, TestOutputInt (
1686 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1687 "get blocksize of block device",
1689 This returns the block size of a device.
1691 (Note this is different from both I<size in blocks> and
1692 I<filesystem block size>).
1694 This uses the L<blockdev(8)> command.");
1696 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1698 "set blocksize of block device",
1700 This sets the block size of a device.
1702 (Note this is different from both I<size in blocks> and
1703 I<filesystem block size>).
1705 This uses the L<blockdev(8)> command.");
1707 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1708 [InitEmpty, Always, TestOutputInt (
1709 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1710 "get total size of device in 512-byte sectors",
1712 This returns the size of the device in units of 512-byte sectors
1713 (even if the sectorsize isn't 512 bytes ... weird).
1715 See also C<guestfs_blockdev_getss> for the real sector size of
1716 the device, and C<guestfs_blockdev_getsize64> for the more
1717 useful I<size in bytes>.
1719 This uses the L<blockdev(8)> command.");
1721 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1722 [InitEmpty, Always, TestOutputInt (
1723 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1724 "get total size of device in bytes",
1726 This returns the size of the device in bytes.
1728 See also C<guestfs_blockdev_getsz>.
1730 This uses the L<blockdev(8)> command.");
1732 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1733 [InitEmpty, Always, TestRun
1734 [["blockdev_flushbufs"; "/dev/sda"]]],
1735 "flush device buffers",
1737 This tells the kernel to flush internal buffers associated
1740 This uses the L<blockdev(8)> command.");
1742 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1743 [InitEmpty, Always, TestRun
1744 [["blockdev_rereadpt"; "/dev/sda"]]],
1745 "reread partition table",
1747 Reread the partition table on C<device>.
1749 This uses the L<blockdev(8)> command.");
1751 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1752 [InitBasicFS, Always, TestOutput (
1753 (* Pick a file from cwd which isn't likely to change. *)
1754 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1755 ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1756 "upload a file from the local machine",
1758 Upload local file C<filename> to C<remotefilename> on the
1761 C<filename> can also be a named pipe.
1763 See also C<guestfs_download>.");
1765 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1766 [InitBasicFS, Always, TestOutput (
1767 (* Pick a file from cwd which isn't likely to change. *)
1768 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1769 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1770 ["upload"; "testdownload.tmp"; "/upload"];
1771 ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1772 "download a file to the local machine",
1774 Download file C<remotefilename> and save it as C<filename>
1775 on the local machine.
1777 C<filename> can also be a named pipe.
1779 See also C<guestfs_upload>, C<guestfs_cat>.");
1781 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1782 [InitBasicFS, Always, TestOutput (
1783 [["write_file"; "/new"; "test\n"; "0"];
1784 ["checksum"; "crc"; "/new"]], "935282863");
1785 InitBasicFS, Always, TestLastFail (
1786 [["checksum"; "crc"; "/new"]]);
1787 InitBasicFS, Always, TestOutput (
1788 [["write_file"; "/new"; "test\n"; "0"];
1789 ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1790 InitBasicFS, Always, TestOutput (
1791 [["write_file"; "/new"; "test\n"; "0"];
1792 ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1793 InitBasicFS, Always, TestOutput (
1794 [["write_file"; "/new"; "test\n"; "0"];
1795 ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1796 InitBasicFS, Always, TestOutput (
1797 [["write_file"; "/new"; "test\n"; "0"];
1798 ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1799 InitBasicFS, Always, TestOutput (
1800 [["write_file"; "/new"; "test\n"; "0"];
1801 ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1802 InitBasicFS, Always, TestOutput (
1803 [["write_file"; "/new"; "test\n"; "0"];
1804 ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1805 InitSquashFS, Always, TestOutput (
1806 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1807 "compute MD5, SHAx or CRC checksum of file",
1809 This call computes the MD5, SHAx or CRC checksum of the
1812 The type of checksum to compute is given by the C<csumtype>
1813 parameter which must have one of the following values:
1819 Compute the cyclic redundancy check (CRC) specified by POSIX
1820 for the C<cksum> command.
1824 Compute the MD5 hash (using the C<md5sum> program).
1828 Compute the SHA1 hash (using the C<sha1sum> program).
1832 Compute the SHA224 hash (using the C<sha224sum> program).
1836 Compute the SHA256 hash (using the C<sha256sum> program).
1840 Compute the SHA384 hash (using the C<sha384sum> program).
1844 Compute the SHA512 hash (using the C<sha512sum> program).
1848 The checksum is returned as a printable string.");
1850 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1851 [InitBasicFS, Always, TestOutput (
1852 [["tar_in"; "../images/helloworld.tar"; "/"];
1853 ["cat"; "/hello"]], "hello\n")],
1854 "unpack tarfile to directory",
1856 This command uploads and unpacks local file C<tarfile> (an
1857 I<uncompressed> tar file) into C<directory>.
1859 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1861 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1863 "pack directory into tarfile",
1865 This command packs the contents of C<directory> and downloads
1866 it to local file C<tarfile>.
1868 To download a compressed tarball, use C<guestfs_tgz_out>.");
1870 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1871 [InitBasicFS, Always, TestOutput (
1872 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1873 ["cat"; "/hello"]], "hello\n")],
1874 "unpack compressed tarball to directory",
1876 This command uploads and unpacks local file C<tarball> (a
1877 I<gzip compressed> tar file) into C<directory>.
1879 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1881 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1883 "pack directory into compressed tarball",
1885 This command packs the contents of C<directory> and downloads
1886 it to local file C<tarball>.
1888 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1890 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1891 [InitBasicFS, Always, TestLastFail (
1893 ["mount_ro"; "/dev/sda1"; "/"];
1894 ["touch"; "/new"]]);
1895 InitBasicFS, Always, TestOutput (
1896 [["write_file"; "/new"; "data"; "0"];
1898 ["mount_ro"; "/dev/sda1"; "/"];
1899 ["cat"; "/new"]], "data")],
1900 "mount a guest disk, read-only",
1902 This is the same as the C<guestfs_mount> command, but it
1903 mounts the filesystem with the read-only (I<-o ro>) flag.");
1905 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1907 "mount a guest disk with mount options",
1909 This is the same as the C<guestfs_mount> command, but it
1910 allows you to set the mount options as for the
1911 L<mount(8)> I<-o> flag.");
1913 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1915 "mount a guest disk with mount options and vfstype",
1917 This is the same as the C<guestfs_mount> command, but it
1918 allows you to set both the mount options and the vfstype
1919 as for the L<mount(8)> I<-o> and I<-t> flags.");
1921 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1923 "debugging and internals",
1925 The C<guestfs_debug> command exposes some internals of
1926 C<guestfsd> (the guestfs daemon) that runs inside the
1929 There is no comprehensive help for this command. You have
1930 to look at the file C<daemon/debug.c> in the libguestfs source
1931 to find out what you can do.");
1933 ("lvremove", (RErr, [String "device"]), 77, [],
1934 [InitEmpty, Always, TestOutputList (
1935 [["sfdiskM"; "/dev/sda"; ","];
1936 ["pvcreate"; "/dev/sda1"];
1937 ["vgcreate"; "VG"; "/dev/sda1"];
1938 ["lvcreate"; "LV1"; "VG"; "50"];
1939 ["lvcreate"; "LV2"; "VG"; "50"];
1940 ["lvremove"; "/dev/VG/LV1"];
1941 ["lvs"]], ["/dev/VG/LV2"]);
1942 InitEmpty, Always, TestOutputList (
1943 [["sfdiskM"; "/dev/sda"; ","];
1944 ["pvcreate"; "/dev/sda1"];
1945 ["vgcreate"; "VG"; "/dev/sda1"];
1946 ["lvcreate"; "LV1"; "VG"; "50"];
1947 ["lvcreate"; "LV2"; "VG"; "50"];
1948 ["lvremove"; "/dev/VG"];
1950 InitEmpty, Always, TestOutputList (
1951 [["sfdiskM"; "/dev/sda"; ","];
1952 ["pvcreate"; "/dev/sda1"];
1953 ["vgcreate"; "VG"; "/dev/sda1"];
1954 ["lvcreate"; "LV1"; "VG"; "50"];
1955 ["lvcreate"; "LV2"; "VG"; "50"];
1956 ["lvremove"; "/dev/VG"];
1958 "remove an LVM logical volume",
1960 Remove an LVM logical volume C<device>, where C<device> is
1961 the path to the LV, such as C</dev/VG/LV>.
1963 You can also remove all LVs in a volume group by specifying
1964 the VG name, C</dev/VG>.");
1966 ("vgremove", (RErr, [String "vgname"]), 78, [],
1967 [InitEmpty, Always, TestOutputList (
1968 [["sfdiskM"; "/dev/sda"; ","];
1969 ["pvcreate"; "/dev/sda1"];
1970 ["vgcreate"; "VG"; "/dev/sda1"];
1971 ["lvcreate"; "LV1"; "VG"; "50"];
1972 ["lvcreate"; "LV2"; "VG"; "50"];
1975 InitEmpty, Always, TestOutputList (
1976 [["sfdiskM"; "/dev/sda"; ","];
1977 ["pvcreate"; "/dev/sda1"];
1978 ["vgcreate"; "VG"; "/dev/sda1"];
1979 ["lvcreate"; "LV1"; "VG"; "50"];
1980 ["lvcreate"; "LV2"; "VG"; "50"];
1983 "remove an LVM volume group",
1985 Remove an LVM volume group C<vgname>, (for example C<VG>).
1987 This also forcibly removes all logical volumes in the volume
1990 ("pvremove", (RErr, [String "device"]), 79, [],
1991 [InitEmpty, Always, TestOutputListOfDevices (
1992 [["sfdiskM"; "/dev/sda"; ","];
1993 ["pvcreate"; "/dev/sda1"];
1994 ["vgcreate"; "VG"; "/dev/sda1"];
1995 ["lvcreate"; "LV1"; "VG"; "50"];
1996 ["lvcreate"; "LV2"; "VG"; "50"];
1998 ["pvremove"; "/dev/sda1"];
2000 InitEmpty, Always, TestOutputListOfDevices (
2001 [["sfdiskM"; "/dev/sda"; ","];
2002 ["pvcreate"; "/dev/sda1"];
2003 ["vgcreate"; "VG"; "/dev/sda1"];
2004 ["lvcreate"; "LV1"; "VG"; "50"];
2005 ["lvcreate"; "LV2"; "VG"; "50"];
2007 ["pvremove"; "/dev/sda1"];
2009 InitEmpty, Always, TestOutputListOfDevices (
2010 [["sfdiskM"; "/dev/sda"; ","];
2011 ["pvcreate"; "/dev/sda1"];
2012 ["vgcreate"; "VG"; "/dev/sda1"];
2013 ["lvcreate"; "LV1"; "VG"; "50"];
2014 ["lvcreate"; "LV2"; "VG"; "50"];
2016 ["pvremove"; "/dev/sda1"];
2018 "remove an LVM physical volume",
2020 This wipes a physical volume C<device> so that LVM will no longer
2023 The implementation uses the C<pvremove> command which refuses to
2024 wipe physical volumes that contain any volume groups, so you have
2025 to remove those first.");
2027 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
2028 [InitBasicFS, Always, TestOutput (
2029 [["set_e2label"; "/dev/sda1"; "testlabel"];
2030 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2031 "set the ext2/3/4 filesystem label",
2033 This sets the ext2/3/4 filesystem label of the filesystem on
2034 C<device> to C<label>. Filesystem labels are limited to
2037 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2038 to return the existing label on a filesystem.");
2040 ("get_e2label", (RString "label", [String "device"]), 81, [],
2042 "get the ext2/3/4 filesystem label",
2044 This returns the ext2/3/4 filesystem label of the filesystem on
2047 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2048 [InitBasicFS, Always, TestOutput (
2049 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2050 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2051 InitBasicFS, Always, TestOutput (
2052 [["set_e2uuid"; "/dev/sda1"; "clear"];
2053 ["get_e2uuid"; "/dev/sda1"]], "");
2054 (* We can't predict what UUIDs will be, so just check the commands run. *)
2055 InitBasicFS, Always, TestRun (
2056 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2057 InitBasicFS, Always, TestRun (
2058 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2059 "set the ext2/3/4 filesystem UUID",
2061 This sets the ext2/3/4 filesystem UUID of the filesystem on
2062 C<device> to C<uuid>. The format of the UUID and alternatives
2063 such as C<clear>, C<random> and C<time> are described in the
2064 L<tune2fs(8)> manpage.
2066 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2067 to return the existing UUID of a filesystem.");
2069 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2071 "get the ext2/3/4 filesystem UUID",
2073 This returns the ext2/3/4 filesystem UUID of the filesystem on
2076 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2077 [InitBasicFS, Always, TestOutputInt (
2078 [["umount"; "/dev/sda1"];
2079 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2080 InitBasicFS, Always, TestOutputInt (
2081 [["umount"; "/dev/sda1"];
2082 ["zero"; "/dev/sda1"];
2083 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2084 "run the filesystem checker",
2086 This runs the filesystem checker (fsck) on C<device> which
2087 should have filesystem type C<fstype>.
2089 The returned integer is the status. See L<fsck(8)> for the
2090 list of status codes from C<fsck>.
2098 Multiple status codes can be summed together.
2102 A non-zero return code can mean \"success\", for example if
2103 errors have been corrected on the filesystem.
2107 Checking or repairing NTFS volumes is not supported
2112 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2114 ("zero", (RErr, [String "device"]), 85, [],
2115 [InitBasicFS, Always, TestOutput (
2116 [["umount"; "/dev/sda1"];
2117 ["zero"; "/dev/sda1"];
2118 ["file"; "/dev/sda1"]], "data")],
2119 "write zeroes to the device",
2121 This command writes zeroes over the first few blocks of C<device>.
2123 How many blocks are zeroed isn't specified (but it's I<not> enough
2124 to securely wipe the device). It should be sufficient to remove
2125 any partition tables, filesystem superblocks and so on.
2127 See also: C<guestfs_scrub_device>.");
2129 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2130 (* Test disabled because grub-install incompatible with virtio-blk driver.
2131 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2133 [InitBasicFS, Disabled, TestOutputTrue (
2134 [["grub_install"; "/"; "/dev/sda1"];
2135 ["is_dir"; "/boot"]])],
2138 This command installs GRUB (the Grand Unified Bootloader) on
2139 C<device>, with the root directory being C<root>.");
2141 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2142 [InitBasicFS, Always, TestOutput (
2143 [["write_file"; "/old"; "file content"; "0"];
2144 ["cp"; "/old"; "/new"];
2145 ["cat"; "/new"]], "file content");
2146 InitBasicFS, Always, TestOutputTrue (
2147 [["write_file"; "/old"; "file content"; "0"];
2148 ["cp"; "/old"; "/new"];
2149 ["is_file"; "/old"]]);
2150 InitBasicFS, Always, TestOutput (
2151 [["write_file"; "/old"; "file content"; "0"];
2153 ["cp"; "/old"; "/dir/new"];
2154 ["cat"; "/dir/new"]], "file content")],
2157 This copies a file from C<src> to C<dest> where C<dest> is
2158 either a destination filename or destination directory.");
2160 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2161 [InitBasicFS, Always, TestOutput (
2162 [["mkdir"; "/olddir"];
2163 ["mkdir"; "/newdir"];
2164 ["write_file"; "/olddir/file"; "file content"; "0"];
2165 ["cp_a"; "/olddir"; "/newdir"];
2166 ["cat"; "/newdir/olddir/file"]], "file content")],
2167 "copy a file or directory recursively",
2169 This copies a file or directory from C<src> to C<dest>
2170 recursively using the C<cp -a> command.");
2172 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2173 [InitBasicFS, Always, TestOutput (
2174 [["write_file"; "/old"; "file content"; "0"];
2175 ["mv"; "/old"; "/new"];
2176 ["cat"; "/new"]], "file content");
2177 InitBasicFS, Always, TestOutputFalse (
2178 [["write_file"; "/old"; "file content"; "0"];
2179 ["mv"; "/old"; "/new"];
2180 ["is_file"; "/old"]])],
2183 This moves a file from C<src> to C<dest> where C<dest> is
2184 either a destination filename or destination directory.");
2186 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2187 [InitEmpty, Always, TestRun (
2188 [["drop_caches"; "3"]])],
2189 "drop kernel page cache, dentries and inodes",
2191 This instructs the guest kernel to drop its page cache,
2192 and/or dentries and inode caches. The parameter C<whattodrop>
2193 tells the kernel what precisely to drop, see
2194 L<http://linux-mm.org/Drop_Caches>
2196 Setting C<whattodrop> to 3 should drop everything.
2198 This automatically calls L<sync(2)> before the operation,
2199 so that the maximum guest memory is freed.");
2201 ("dmesg", (RString "kmsgs", []), 91, [],
2202 [InitEmpty, Always, TestRun (
2204 "return kernel messages",
2206 This returns the kernel messages (C<dmesg> output) from
2207 the guest kernel. This is sometimes useful for extended
2208 debugging of problems.
2210 Another way to get the same information is to enable
2211 verbose messages with C<guestfs_set_verbose> or by setting
2212 the environment variable C<LIBGUESTFS_DEBUG=1> before
2213 running the program.");
2215 ("ping_daemon", (RErr, []), 92, [],
2216 [InitEmpty, Always, TestRun (
2217 [["ping_daemon"]])],
2218 "ping the guest daemon",
2220 This is a test probe into the guestfs daemon running inside
2221 the qemu subprocess. Calling this function checks that the
2222 daemon responds to the ping message, without affecting the daemon
2223 or attached block device(s) in any other way.");
2225 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2226 [InitBasicFS, Always, TestOutputTrue (
2227 [["write_file"; "/file1"; "contents of a file"; "0"];
2228 ["cp"; "/file1"; "/file2"];
2229 ["equal"; "/file1"; "/file2"]]);
2230 InitBasicFS, Always, TestOutputFalse (
2231 [["write_file"; "/file1"; "contents of a file"; "0"];
2232 ["write_file"; "/file2"; "contents of another file"; "0"];
2233 ["equal"; "/file1"; "/file2"]]);
2234 InitBasicFS, Always, TestLastFail (
2235 [["equal"; "/file1"; "/file2"]])],
2236 "test if two files have equal contents",
2238 This compares the two files C<file1> and C<file2> and returns
2239 true if their content is exactly equal, or false otherwise.
2241 The external L<cmp(1)> program is used for the comparison.");
2243 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2244 [InitBasicFS, Always, TestOutputList (
2245 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2246 ["strings"; "/new"]], ["hello"; "world"]);
2247 InitBasicFS, Always, TestOutputList (
2249 ["strings"; "/new"]], [])],
2250 "print the printable strings in a file",
2252 This runs the L<strings(1)> command on a file and returns
2253 the list of printable strings found.");
2255 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2256 [InitBasicFS, Always, TestOutputList (
2257 [["write_file"; "/new"; "hello\nworld\n"; "0"];
2258 ["strings_e"; "b"; "/new"]], []);
2259 InitBasicFS, Disabled, TestOutputList (
2260 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2261 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2262 "print the printable strings in a file",
2264 This is like the C<guestfs_strings> command, but allows you to
2265 specify the encoding.
2267 See the L<strings(1)> manpage for the full list of encodings.
2269 Commonly useful encodings are C<l> (lower case L) which will
2270 show strings inside Windows/x86 files.
2272 The returned strings are transcoded to UTF-8.");
2274 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2275 [InitBasicFS, Always, TestOutput (
2276 [["write_file"; "/new"; "hello\nworld\n"; "12"];
2277 ["hexdump"; "/new"]], "00000000 68 65 6c 6c 6f 0a 77 6f 72 6c 64 0a |hello.world.|\n0000000c\n");
2278 (* Test for RHBZ#501888c2 regression which caused large hexdump
2279 * commands to segfault.
2281 InitSquashFS, Always, TestRun (
2282 [["hexdump"; "/100krandom"]])],
2283 "dump a file in hexadecimal",
2285 This runs C<hexdump -C> on the given C<path>. The result is
2286 the human-readable, canonical hex dump of the file.");
2288 ("zerofree", (RErr, [String "device"]), 97, [],
2289 [InitNone, Always, TestOutput (
2290 [["sfdiskM"; "/dev/sda"; ","];
2291 ["mkfs"; "ext3"; "/dev/sda1"];
2292 ["mount"; "/dev/sda1"; "/"];
2293 ["write_file"; "/new"; "test file"; "0"];
2294 ["umount"; "/dev/sda1"];
2295 ["zerofree"; "/dev/sda1"];
2296 ["mount"; "/dev/sda1"; "/"];
2297 ["cat"; "/new"]], "test file")],
2298 "zero unused inodes and disk blocks on ext2/3 filesystem",
2300 This runs the I<zerofree> program on C<device>. This program
2301 claims to zero unused inodes and disk blocks on an ext2/3
2302 filesystem, thus making it possible to compress the filesystem
2305 You should B<not> run this program if the filesystem is
2308 It is possible that using this program can damage the filesystem
2309 or data on the filesystem.");
2311 ("pvresize", (RErr, [String "device"]), 98, [],
2313 "resize an LVM physical volume",
2315 This resizes (expands or shrinks) an existing LVM physical
2316 volume to match the new size of the underlying device.");
2318 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2319 Int "cyls"; Int "heads"; Int "sectors";
2320 String "line"]), 99, [DangerWillRobinson],
2322 "modify a single partition on a block device",
2324 This runs L<sfdisk(8)> option to modify just the single
2325 partition C<n> (note: C<n> counts from 1).
2327 For other parameters, see C<guestfs_sfdisk>. You should usually
2328 pass C<0> for the cyls/heads/sectors parameters.");
2330 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2332 "display the partition table",
2334 This displays the partition table on C<device>, in the
2335 human-readable output of the L<sfdisk(8)> command. It is
2336 not intended to be parsed.");
2338 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2340 "display the kernel geometry",
2342 This displays the kernel's idea of the geometry of C<device>.
2344 The result is in human-readable format, and not designed to
2347 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2349 "display the disk geometry from the partition table",
2351 This displays the disk geometry of C<device> read from the
2352 partition table. Especially in the case where the underlying
2353 block device has been resized, this can be different from the
2354 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2356 The result is in human-readable format, and not designed to
2359 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2361 "activate or deactivate all volume groups",
2363 This command activates or (if C<activate> is false) deactivates
2364 all logical volumes in all volume groups.
2365 If activated, then they are made known to the
2366 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2367 then those devices disappear.
2369 This command is the same as running C<vgchange -a y|n>");
2371 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2373 "activate or deactivate some volume groups",
2375 This command activates or (if C<activate> is false) deactivates
2376 all logical volumes in the listed volume groups C<volgroups>.
2377 If activated, then they are made known to the
2378 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2379 then those devices disappear.
2381 This command is the same as running C<vgchange -a y|n volgroups...>
2383 Note that if C<volgroups> is an empty list then B<all> volume groups
2384 are activated or deactivated.");
2386 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2387 [InitNone, Always, TestOutput (
2388 [["sfdiskM"; "/dev/sda"; ","];
2389 ["pvcreate"; "/dev/sda1"];
2390 ["vgcreate"; "VG"; "/dev/sda1"];
2391 ["lvcreate"; "LV"; "VG"; "10"];
2392 ["mkfs"; "ext2"; "/dev/VG/LV"];
2393 ["mount"; "/dev/VG/LV"; "/"];
2394 ["write_file"; "/new"; "test content"; "0"];
2396 ["lvresize"; "/dev/VG/LV"; "20"];
2397 ["e2fsck_f"; "/dev/VG/LV"];
2398 ["resize2fs"; "/dev/VG/LV"];
2399 ["mount"; "/dev/VG/LV"; "/"];
2400 ["cat"; "/new"]], "test content")],
2401 "resize an LVM logical volume",
2403 This resizes (expands or shrinks) an existing LVM logical
2404 volume to C<mbytes>. When reducing, data in the reduced part
2407 ("resize2fs", (RErr, [String "device"]), 106, [],
2408 [], (* lvresize tests this *)
2409 "resize an ext2/ext3 filesystem",
2411 This resizes an ext2 or ext3 filesystem to match the size of
2412 the underlying device.
2414 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2415 on the C<device> before calling this command. For unknown reasons
2416 C<resize2fs> sometimes gives an error about this and sometimes not.
2417 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2418 calling this function.");
2420 ("find", (RStringList "names", [String "directory"]), 107, [],
2421 [InitBasicFS, Always, TestOutputList (
2422 [["find"; "/"]], ["lost+found"]);
2423 InitBasicFS, Always, TestOutputList (
2427 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2428 InitBasicFS, Always, TestOutputList (
2429 [["mkdir_p"; "/a/b/c"];
2430 ["touch"; "/a/b/c/d"];
2431 ["find"; "/a/b/"]], ["c"; "c/d"])],
2432 "find all files and directories",
2434 This command lists out all files and directories, recursively,
2435 starting at C<directory>. It is essentially equivalent to
2436 running the shell command C<find directory -print> but some
2437 post-processing happens on the output, described below.
2439 This returns a list of strings I<without any prefix>. Thus
2440 if the directory structure was:
2446 then the returned list from C<guestfs_find> C</tmp> would be
2454 If C<directory> is not a directory, then this command returns
2457 The returned list is sorted.");
2459 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2460 [], (* lvresize tests this *)
2461 "check an ext2/ext3 filesystem",
2463 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2464 filesystem checker on C<device>, noninteractively (C<-p>),
2465 even if the filesystem appears to be clean (C<-f>).
2467 This command is only needed because of C<guestfs_resize2fs>
2468 (q.v.). Normally you should use C<guestfs_fsck>.");
2470 ("sleep", (RErr, [Int "secs"]), 109, [],
2471 [InitNone, Always, TestRun (
2473 "sleep for some seconds",
2475 Sleep for C<secs> seconds.");
2477 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2478 [InitNone, Always, TestOutputInt (
2479 [["sfdiskM"; "/dev/sda"; ","];
2480 ["mkfs"; "ntfs"; "/dev/sda1"];
2481 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2482 InitNone, Always, TestOutputInt (
2483 [["sfdiskM"; "/dev/sda"; ","];
2484 ["mkfs"; "ext2"; "/dev/sda1"];
2485 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2486 "probe NTFS volume",
2488 This command runs the L<ntfs-3g.probe(8)> command which probes
2489 an NTFS C<device> for mountability. (Not all NTFS volumes can
2490 be mounted read-write, and some cannot be mounted at all).
2492 C<rw> is a boolean flag. Set it to true if you want to test
2493 if the volume can be mounted read-write. Set it to false if
2494 you want to test if the volume can be mounted read-only.
2496 The return value is an integer which C<0> if the operation
2497 would succeed, or some non-zero value documented in the
2498 L<ntfs-3g.probe(8)> manual page.");
2500 ("sh", (RString "output", [String "command"]), 111, [],
2501 [], (* XXX needs tests *)
2502 "run a command via the shell",
2504 This call runs a command from the guest filesystem via the
2507 This is like C<guestfs_command>, but passes the command to:
2509 /bin/sh -c \"command\"
2511 Depending on the guest's shell, this usually results in
2512 wildcards being expanded, shell expressions being interpolated
2515 All the provisos about C<guestfs_command> apply to this call.");
2517 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2518 [], (* XXX needs tests *)
2519 "run a command via the shell returning lines",
2521 This is the same as C<guestfs_sh>, but splits the result
2522 into a list of lines.
2524 See also: C<guestfs_command_lines>");
2526 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2527 [InitBasicFS, Always, TestOutputList (
2528 [["mkdir_p"; "/a/b/c"];
2529 ["touch"; "/a/b/c/d"];
2530 ["touch"; "/a/b/c/e"];
2531 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2532 InitBasicFS, Always, TestOutputList (
2533 [["mkdir_p"; "/a/b/c"];
2534 ["touch"; "/a/b/c/d"];
2535 ["touch"; "/a/b/c/e"];
2536 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2537 InitBasicFS, Always, TestOutputList (
2538 [["mkdir_p"; "/a/b/c"];
2539 ["touch"; "/a/b/c/d"];
2540 ["touch"; "/a/b/c/e"];
2541 ["glob_expand"; "/a/*/x/*"]], [])],
2542 "expand a wildcard path",
2544 This command searches for all the pathnames matching
2545 C<pattern> according to the wildcard expansion rules
2548 If no paths match, then this returns an empty list
2549 (note: not an error).
2551 It is just a wrapper around the C L<glob(3)> function
2552 with flags C<GLOB_MARK|GLOB_BRACE>.
2553 See that manual page for more details.");
2555 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2556 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2557 [["scrub_device"; "/dev/sdc"]])],
2558 "scrub (securely wipe) a device",
2560 This command writes patterns over C<device> to make data retrieval
2563 It is an interface to the L<scrub(1)> program. See that
2564 manual page for more details.");
2566 ("scrub_file", (RErr, [String "file"]), 115, [],
2567 [InitBasicFS, Always, TestRun (
2568 [["write_file"; "/file"; "content"; "0"];
2569 ["scrub_file"; "/file"]])],
2570 "scrub (securely wipe) a file",
2572 This command writes patterns over a file to make data retrieval
2575 The file is I<removed> after scrubbing.
2577 It is an interface to the L<scrub(1)> program. See that
2578 manual page for more details.");
2580 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2581 [], (* XXX needs testing *)
2582 "scrub (securely wipe) free space",
2584 This command creates the directory C<dir> and then fills it
2585 with files until the filesystem is full, and scrubs the files
2586 as for C<guestfs_scrub_file>, and deletes them.
2587 The intention is to scrub any free space on the partition
2590 It is an interface to the L<scrub(1)> program. See that
2591 manual page for more details.");
2593 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2594 [InitBasicFS, Always, TestRun (
2596 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2597 "create a temporary directory",
2599 This command creates a temporary directory. The
2600 C<template> parameter should be a full pathname for the
2601 temporary directory name with the final six characters being
2604 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2605 the second one being suitable for Windows filesystems.
2607 The name of the temporary directory that was created
2610 The temporary directory is created with mode 0700
2611 and is owned by root.
2613 The caller is responsible for deleting the temporary
2614 directory and its contents after use.
2616 See also: L<mkdtemp(3)>");
2618 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2619 [InitSquashFS, Always, TestOutputInt (
2620 [["wc_l"; "/10klines"]], 10000)],
2621 "count lines in a file",
2623 This command counts the lines in a file, using the
2624 C<wc -l> external command.");
2626 ("wc_w", (RInt "words", [String "path"]), 119, [],
2627 [InitSquashFS, Always, TestOutputInt (
2628 [["wc_w"; "/10klines"]], 10000)],
2629 "count words in a file",
2631 This command counts the words in a file, using the
2632 C<wc -w> external command.");
2634 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2635 [InitSquashFS, Always, TestOutputInt (
2636 [["wc_c"; "/100kallspaces"]], 102400)],
2637 "count characters in a file",
2639 This command counts the characters in a file, using the
2640 C<wc -c> external command.");
2642 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2643 [InitSquashFS, Always, TestOutputList (
2644 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2645 "return first 10 lines of a file",
2647 This command returns up to the first 10 lines of a file as
2648 a list of strings.");
2650 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2651 [InitSquashFS, Always, TestOutputList (
2652 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2653 InitSquashFS, Always, TestOutputList (
2654 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2655 InitSquashFS, Always, TestOutputList (
2656 [["head_n"; "0"; "/10klines"]], [])],
2657 "return first N lines of a file",
2659 If the parameter C<nrlines> is a positive number, this returns the first
2660 C<nrlines> lines of the file C<path>.
2662 If the parameter C<nrlines> is a negative number, this returns lines
2663 from the file C<path>, excluding the last C<nrlines> lines.
2665 If the parameter C<nrlines> is zero, this returns an empty list.");
2667 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2668 [InitSquashFS, Always, TestOutputList (
2669 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2670 "return last 10 lines of a file",
2672 This command returns up to the last 10 lines of a file as
2673 a list of strings.");
2675 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2676 [InitSquashFS, Always, TestOutputList (
2677 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2678 InitSquashFS, Always, TestOutputList (
2679 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2680 InitSquashFS, Always, TestOutputList (
2681 [["tail_n"; "0"; "/10klines"]], [])],
2682 "return last N lines of a file",
2684 If the parameter C<nrlines> is a positive number, this returns the last
2685 C<nrlines> lines of the file C<path>.
2687 If the parameter C<nrlines> is a negative number, this returns lines
2688 from the file C<path>, starting with the C<-nrlines>th line.
2690 If the parameter C<nrlines> is zero, this returns an empty list.");
2692 ("df", (RString "output", []), 125, [],
2693 [], (* XXX Tricky to test because it depends on the exact format
2694 * of the 'df' command and other imponderables.
2696 "report file system disk space usage",
2698 This command runs the C<df> command to report disk space used.
2700 This command is mostly useful for interactive sessions. It
2701 is I<not> intended that you try to parse the output string.
2702 Use C<statvfs> from programs.");
2704 ("df_h", (RString "output", []), 126, [],
2705 [], (* XXX Tricky to test because it depends on the exact format
2706 * of the 'df' command and other imponderables.
2708 "report file system disk space usage (human readable)",
2710 This command runs the C<df -h> command to report disk space used
2711 in human-readable format.
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 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2718 [InitBasicFS, Always, TestOutputInt (
2720 ["du"; "/p"]], 1 (* ie. 1 block, so depends on ext3 blocksize *))],
2721 "estimate file space usage",
2723 This command runs the C<du -s> command to estimate file space
2726 C<path> can be a file or a directory. If C<path> is a directory
2727 then the estimate includes the contents of the directory and all
2728 subdirectories (recursively).
2730 The result is the estimated size in I<kilobytes>
2731 (ie. units of 1024 bytes).");
2733 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2734 [InitSquashFS, Always, TestOutputList (
2735 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3"])],
2736 "list files in an initrd",
2738 This command lists out files contained in an initrd.
2740 The files are listed without any initial C</> character. The
2741 files are listed in the order they appear (not necessarily
2742 alphabetical). Directory names are listed as separate items.
2744 Old Linux kernels (2.4 and earlier) used a compressed ext2
2745 filesystem as initrd. We I<only> support the newer initramfs
2746 format (compressed cpio files).");
2748 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2750 "mount a file using the loop device",
2752 This command lets you mount C<file> (a filesystem image
2753 in a file) on a mount point. It is entirely equivalent to
2754 the command C<mount -o loop file mountpoint>.");
2756 ("mkswap", (RErr, [String "device"]), 130, [],
2757 [InitEmpty, Always, TestRun (
2758 [["sfdiskM"; "/dev/sda"; ","];
2759 ["mkswap"; "/dev/sda1"]])],
2760 "create a swap partition",
2762 Create a swap partition on C<device>.");
2764 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2765 [InitEmpty, Always, TestRun (
2766 [["sfdiskM"; "/dev/sda"; ","];
2767 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2768 "create a swap partition with a label",
2770 Create a swap partition on C<device> with label C<label>.");
2772 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2773 [InitEmpty, Always, TestRun (
2774 [["sfdiskM"; "/dev/sda"; ","];
2775 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2776 "create a swap partition with an explicit UUID",
2778 Create a swap partition on C<device> with UUID C<uuid>.");
2780 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2781 [InitBasicFS, Always, TestOutputStruct (
2782 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2783 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2784 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2785 InitBasicFS, Always, TestOutputStruct (
2786 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2787 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2788 "make block, character or FIFO devices",
2790 This call creates block or character special devices, or
2791 named pipes (FIFOs).
2793 The C<mode> parameter should be the mode, using the standard
2794 constants. C<devmajor> and C<devminor> are the
2795 device major and minor numbers, only used when creating block
2796 and character special devices.");
2798 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2799 [InitBasicFS, Always, TestOutputStruct (
2800 [["mkfifo"; "0o777"; "/node"];
2801 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2802 "make FIFO (named pipe)",
2804 This call creates a FIFO (named pipe) called C<path> with
2805 mode C<mode>. It is just a convenient wrapper around
2806 C<guestfs_mknod>.");
2808 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2809 [InitBasicFS, Always, TestOutputStruct (
2810 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2811 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2812 "make block device node",
2814 This call creates a block device node called C<path> with
2815 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2816 It is just a convenient wrapper around C<guestfs_mknod>.");
2818 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2819 [InitBasicFS, Always, TestOutputStruct (
2820 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2821 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2822 "make char device node",
2824 This call creates a char device node called C<path> with
2825 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2826 It is just a convenient wrapper around C<guestfs_mknod>.");
2828 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2829 [], (* XXX umask is one of those stateful things that we should
2830 * reset between each test.
2832 "set file mode creation mask (umask)",
2834 This function sets the mask used for creating new files and
2835 device nodes to C<mask & 0777>.
2837 Typical umask values would be C<022> which creates new files
2838 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2839 C<002> which creates new files with permissions like
2840 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2842 The default umask is C<022>. This is important because it
2843 means that directories and device nodes will be created with
2844 C<0644> or C<0755> mode even if you specify C<0777>.
2846 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2848 This call returns the previous umask.");
2850 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2852 "read directories entries",
2854 This returns the list of directory entries in directory C<dir>.
2856 All entries in the directory are returned, including C<.> and
2857 C<..>. The entries are I<not> sorted, but returned in the same
2858 order as the underlying filesystem.
2860 Also this call returns basic file type information about each
2861 file. The C<ftyp> field will contain one of the following characters:
2899 The L<readdir(3)> returned a C<d_type> field with an
2904 This function is primarily intended for use by programs. To
2905 get a simple list of names, use C<guestfs_ls>. To get a printable
2906 directory for human consumption, use C<guestfs_ll>.");
2908 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2910 "create partitions on a block device",
2912 This is a simplified interface to the C<guestfs_sfdisk>
2913 command, where partition sizes are specified in megabytes
2914 only (rounded to the nearest cylinder) and you don't need
2915 to specify the cyls, heads and sectors parameters which
2916 were rarely if ever used anyway.
2918 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2920 ("zfile", (RString "description", [String "method"; String "path"]), 140, [DeprecatedBy "file"],
2922 "determine file type inside a compressed file",
2924 This command runs C<file> after first decompressing C<path>
2927 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
2929 Since 1.0.63, use C<guestfs_file> instead which can now
2930 process compressed files.");
2932 ("getxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 141, [],
2934 "list extended attributes of a file or directory",
2936 This call lists the extended attributes of the file or directory
2939 At the system call level, this is a combination of the
2940 L<listxattr(2)> and L<getxattr(2)> calls.
2942 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
2944 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 142, [],
2946 "list extended attributes of a file or directory",
2948 This is the same as C<guestfs_getxattrs>, but if C<path>
2949 is a symbolic link, then it returns the extended attributes
2950 of the link itself.");
2952 ("setxattr", (RErr, [String "xattr";
2953 String "val"; Int "vallen"; (* will be BufferIn *)
2954 String "path"]), 143, [],
2956 "set extended attribute of a file or directory",
2958 This call sets the extended attribute named C<xattr>
2959 of the file C<path> to the value C<val> (of length C<vallen>).
2960 The value is arbitrary 8 bit data.
2962 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
2964 ("lsetxattr", (RErr, [String "xattr";
2965 String "val"; Int "vallen"; (* will be BufferIn *)
2966 String "path"]), 144, [],
2968 "set extended attribute of a file or directory",
2970 This is the same as C<guestfs_setxattr>, but if C<path>
2971 is a symbolic link, then it sets an extended attribute
2972 of the link itself.");
2974 ("removexattr", (RErr, [String "xattr"; String "path"]), 145, [],
2976 "remove extended attribute of a file or directory",
2978 This call removes the extended attribute named C<xattr>
2979 of the file C<path>.
2981 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
2983 ("lremovexattr", (RErr, [String "xattr"; String "path"]), 146, [],
2985 "remove extended attribute of a file or directory",
2987 This is the same as C<guestfs_removexattr>, but if C<path>
2988 is a symbolic link, then it removes an extended attribute
2989 of the link itself.");
2991 ("mountpoints", (RHashtable "mps", []), 147, [],
2995 This call is similar to C<guestfs_mounts>. That call returns
2996 a list of devices. This one returns a hash table (map) of
2997 device name to directory where the device is mounted.");
2999 ("mkmountpoint", (RErr, [String "path"]), 148, [],
3001 "create a mountpoint",
3003 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3004 specialized calls that can be used to create extra mountpoints
3005 before mounting the first filesystem.
3007 These calls are I<only> necessary in some very limited circumstances,
3008 mainly the case where you want to mount a mix of unrelated and/or
3009 read-only filesystems together.
3011 For example, live CDs often contain a \"Russian doll\" nest of
3012 filesystems, an ISO outer layer, with a squashfs image inside, with
3013 an ext2/3 image inside that. You can unpack this as follows
3016 add-ro Fedora-11-i686-Live.iso
3019 mkmountpoint /squash
3022 mount-loop /cd/LiveOS/squashfs.img /squash
3023 mount-loop /squash/LiveOS/ext3fs.img /ext3
3025 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3027 ("rmmountpoint", (RErr, [String "path"]), 149, [],
3029 "remove a mountpoint",
3031 This calls removes a mountpoint that was previously created
3032 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3033 for full details.");
3035 ("read_file", (RBufferOut "content", [String "path"]), 150, [ProtocolLimitWarning],
3036 [InitBasicFS, Always, TestOutput (
3037 [["write_file"; "/new"; "new file contents"; "0"];
3038 ["read_file"; "/new"]], "new file contents")],
3041 This calls returns the contents of the file C<path> as a
3044 Unlike C<guestfs_cat>, this function can correctly
3045 handle files that contain embedded ASCII NUL characters.
3046 However unlike C<guestfs_download>, this function is limited
3047 in the total size of file that can be handled.");
3051 let all_functions = non_daemon_functions @ daemon_functions
3053 (* In some places we want the functions to be displayed sorted
3054 * alphabetically, so this is useful:
3056 let all_functions_sorted =
3057 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3058 compare n1 n2) all_functions
3060 (* Field types for structures. *)
3062 | FChar (* C 'char' (really, a 7 bit byte). *)
3063 | FString (* nul-terminated ASCII string. *)
3064 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3069 | FBytes (* Any int measure that counts bytes. *)
3070 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3071 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3073 (* Because we generate extra parsing code for LVM command line tools,
3074 * we have to pull out the LVM columns separately here.
3084 "pv_attr", FString (* XXX *);
3085 "pv_pe_count", FInt64;
3086 "pv_pe_alloc_count", FInt64;
3089 "pv_mda_count", FInt64;
3090 "pv_mda_free", FBytes;
3091 (* Not in Fedora 10:
3092 "pv_mda_size", FBytes;
3099 "vg_attr", FString (* XXX *);
3102 "vg_sysid", FString;
3103 "vg_extent_size", FBytes;
3104 "vg_extent_count", FInt64;
3105 "vg_free_count", FInt64;
3110 "snap_count", FInt64;
3113 "vg_mda_count", FInt64;
3114 "vg_mda_free", FBytes;
3115 (* Not in Fedora 10:
3116 "vg_mda_size", FBytes;
3122 "lv_attr", FString (* XXX *);
3125 "lv_kernel_major", FInt64;
3126 "lv_kernel_minor", FInt64;
3128 "seg_count", FInt64;
3130 "snap_percent", FOptPercent;
3131 "copy_percent", FOptPercent;
3134 "mirror_log", FString;
3138 (* Names and fields in all structures (in RStruct and RStructList)
3142 (* The old RIntBool return type, only ever used for aug_defnode. Do
3143 * not use this struct in any new code.
3146 "i", FInt32; (* for historical compatibility *)
3147 "b", FInt32; (* for historical compatibility *)
3150 (* LVM PVs, VGs, LVs. *)
3151 "lvm_pv", lvm_pv_cols;
3152 "lvm_vg", lvm_vg_cols;
3153 "lvm_lv", lvm_lv_cols;
3155 (* Column names and types from stat structures.
3156 * NB. Can't use things like 'st_atime' because glibc header files
3157 * define some of these as macros. Ugh.
3188 (* Column names in dirent structure. *)
3191 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3196 (* Version numbers. *)
3204 (* Extended attribute. *)
3206 "attrname", FString;
3209 ] (* end of structs *)
3211 (* Ugh, Java has to be different ..
3212 * These names are also used by the Haskell bindings.
3214 let java_structs = [
3215 "int_bool", "IntBool";
3220 "statvfs", "StatVFS";
3222 "version", "Version";
3226 (* Used for testing language bindings. *)
3228 | CallString of string
3229 | CallOptString of string option
3230 | CallStringList of string list
3234 (* Used to memoize the result of pod2text. *)
3235 let pod2text_memo_filename = "src/.pod2text.data"
3236 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3238 let chan = open_in pod2text_memo_filename in
3239 let v = input_value chan in
3243 _ -> Hashtbl.create 13
3245 (* Useful functions.
3246 * Note we don't want to use any external OCaml libraries which
3247 * makes this a bit harder than it should be.
3249 let failwithf fs = ksprintf failwith fs
3251 let replace_char s c1 c2 =
3252 let s2 = String.copy s in
3253 let r = ref false in
3254 for i = 0 to String.length s2 - 1 do
3255 if String.unsafe_get s2 i = c1 then (
3256 String.unsafe_set s2 i c2;
3260 if not !r then s else s2
3264 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3266 let triml ?(test = isspace) str =
3268 let n = ref (String.length str) in
3269 while !n > 0 && test str.[!i]; do
3274 else String.sub str !i !n
3276 let trimr ?(test = isspace) str =
3277 let n = ref (String.length str) in
3278 while !n > 0 && test str.[!n-1]; do
3281 if !n = String.length str then str
3282 else String.sub str 0 !n
3284 let trim ?(test = isspace) str =
3285 trimr ~test (triml ~test str)
3287 let rec find s sub =
3288 let len = String.length s in
3289 let sublen = String.length sub in
3291 if i <= len-sublen then (
3293 if j < sublen then (
3294 if s.[i+j] = sub.[j] then loop2 (j+1)
3300 if r = -1 then loop (i+1) else r
3306 let rec replace_str s s1 s2 =
3307 let len = String.length s in
3308 let sublen = String.length s1 in
3309 let i = find s s1 in
3312 let s' = String.sub s 0 i in
3313 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3314 s' ^ s2 ^ replace_str s'' s1 s2
3317 let rec string_split sep str =
3318 let len = String.length str in
3319 let seplen = String.length sep in
3320 let i = find str sep in
3321 if i = -1 then [str]
3323 let s' = String.sub str 0 i in
3324 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3325 s' :: string_split sep s''
3328 let files_equal n1 n2 =
3329 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3330 match Sys.command cmd with
3333 | i -> failwithf "%s: failed with error code %d" cmd i
3335 let rec find_map f = function
3336 | [] -> raise Not_found
3340 | None -> find_map f xs
3343 let rec loop i = function
3345 | x :: xs -> f i x; loop (i+1) xs
3350 let rec loop i = function
3352 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3356 let name_of_argt = function
3357 | String n | OptString n | StringList n | Bool n | Int n
3358 | FileIn n | FileOut n -> n
3360 let java_name_of_struct typ =
3361 try List.assoc typ java_structs
3364 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3366 let cols_of_struct typ =
3367 try List.assoc typ structs
3369 failwithf "cols_of_struct: unknown struct %s" typ
3371 let seq_of_test = function
3372 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3373 | TestOutputListOfDevices (s, _)
3374 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3375 | TestOutputTrue s | TestOutputFalse s
3376 | TestOutputLength (s, _) | TestOutputStruct (s, _)
3377 | TestLastFail s -> s
3379 (* Handling for function flags. *)
3380 let protocol_limit_warning =
3381 "Because of the message protocol, there is a transfer limit
3382 of somewhere between 2MB and 4MB. To transfer large files you should use
3385 let danger_will_robinson =
3386 "B<This command is dangerous. Without careful use you
3387 can easily destroy all your data>."
3389 let deprecation_notice flags =
3392 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
3394 sprintf "This function is deprecated.
3395 In new code, use the C<%s> call instead.
3397 Deprecated functions will not be removed from the API, but the
3398 fact that they are deprecated indicates that there are problems
3399 with correct use of these functions." alt in
3404 (* Check function names etc. for consistency. *)
3405 let check_functions () =
3406 let contains_uppercase str =
3407 let len = String.length str in
3409 if i >= len then false
3412 if c >= 'A' && c <= 'Z' then true
3419 (* Check function names. *)
3421 fun (name, _, _, _, _, _, _) ->
3422 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3423 failwithf "function name %s does not need 'guestfs' prefix" name;
3425 failwithf "function name is empty";
3426 if name.[0] < 'a' || name.[0] > 'z' then
3427 failwithf "function name %s must start with lowercase a-z" name;
3428 if String.contains name '-' then
3429 failwithf "function name %s should not contain '-', use '_' instead."
3433 (* Check function parameter/return names. *)
3435 fun (name, style, _, _, _, _, _) ->
3436 let check_arg_ret_name n =
3437 if contains_uppercase n then
3438 failwithf "%s param/ret %s should not contain uppercase chars"
3440 if String.contains n '-' || String.contains n '_' then
3441 failwithf "%s param/ret %s should not contain '-' or '_'"
3444 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;
3445 if n = "int" || n = "char" || n = "short" || n = "long" then
3446 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3447 if n = "i" || n = "n" then
3448 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3449 if n = "argv" || n = "args" then
3450 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3453 (match fst style with
3455 | RInt n | RInt64 n | RBool n
3456 | RConstString n | RConstOptString n | RString n
3457 | RStringList n | RStruct (n, _) | RStructList (n, _)
3458 | RHashtable n | RBufferOut n ->
3459 check_arg_ret_name n
3461 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3464 (* Check short descriptions. *)
3466 fun (name, _, _, _, _, shortdesc, _) ->
3467 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3468 failwithf "short description of %s should begin with lowercase." name;
3469 let c = shortdesc.[String.length shortdesc-1] in
3470 if c = '\n' || c = '.' then
3471 failwithf "short description of %s should not end with . or \\n." name
3474 (* Check long dscriptions. *)
3476 fun (name, _, _, _, _, _, longdesc) ->
3477 if longdesc.[String.length longdesc-1] = '\n' then
3478 failwithf "long description of %s should not end with \\n." name
3481 (* Check proc_nrs. *)
3483 fun (name, _, proc_nr, _, _, _, _) ->
3484 if proc_nr <= 0 then
3485 failwithf "daemon function %s should have proc_nr > 0" name
3489 fun (name, _, proc_nr, _, _, _, _) ->
3490 if proc_nr <> -1 then
3491 failwithf "non-daemon function %s should have proc_nr -1" name
3492 ) non_daemon_functions;
3495 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3498 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3499 let rec loop = function
3502 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3504 | (name1,nr1) :: (name2,nr2) :: _ ->
3505 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3513 (* Ignore functions that have no tests. We generate a
3514 * warning when the user does 'make check' instead.
3516 | name, _, _, _, [], _, _ -> ()
3517 | name, _, _, _, tests, _, _ ->
3521 match seq_of_test test with
3523 failwithf "%s has a test containing an empty sequence" name
3524 | cmds -> List.map List.hd cmds
3526 let funcs = List.flatten funcs in
3528 let tested = List.mem name funcs in
3531 failwithf "function %s has tests but does not test itself" name
3534 (* 'pr' prints to the current output file. *)
3535 let chan = ref stdout
3536 let pr fs = ksprintf (output_string !chan) fs
3538 (* Generate a header block in a number of standard styles. *)
3539 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3540 type license = GPLv2 | LGPLv2
3542 let generate_header comment license =
3543 let c = match comment with
3544 | CStyle -> pr "/* "; " *"
3545 | HashStyle -> pr "# "; "#"
3546 | OCamlStyle -> pr "(* "; " *"
3547 | HaskellStyle -> pr "{- "; " " in
3548 pr "libguestfs generated file\n";
3549 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3550 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3552 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3556 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3557 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3558 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3559 pr "%s (at your option) any later version.\n" c;
3561 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3562 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3563 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3564 pr "%s GNU General Public License for more details.\n" c;
3566 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3567 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3568 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3571 pr "%s This library is free software; you can redistribute it and/or\n" c;
3572 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3573 pr "%s License as published by the Free Software Foundation; either\n" c;
3574 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3576 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3577 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3578 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3579 pr "%s Lesser General Public License for more details.\n" c;
3581 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3582 pr "%s License along with this library; if not, write to the Free Software\n" c;
3583 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3586 | CStyle -> pr " */\n"
3588 | OCamlStyle -> pr " *)\n"
3589 | HaskellStyle -> pr "-}\n"
3593 (* Start of main code generation functions below this line. *)
3595 (* Generate the pod documentation for the C API. *)
3596 let rec generate_actions_pod () =
3598 fun (shortname, style, _, flags, _, _, longdesc) ->
3599 if not (List.mem NotInDocs flags) then (
3600 let name = "guestfs_" ^ shortname in
3601 pr "=head2 %s\n\n" name;
3603 generate_prototype ~extern:false ~handle:"handle" name style;
3605 pr "%s\n\n" longdesc;
3606 (match fst style with
3608 pr "This function returns 0 on success or -1 on error.\n\n"
3610 pr "On error this function returns -1.\n\n"
3612 pr "On error this function returns -1.\n\n"
3614 pr "This function returns a C truth value on success or -1 on error.\n\n"
3616 pr "This function returns a string, or NULL on error.
3617 The string is owned by the guest handle and must I<not> be freed.\n\n"
3618 | RConstOptString _ ->
3619 pr "This function returns a string which may be NULL.
3620 There is way to return an error from this function.
3621 The string is owned by the guest handle and must I<not> be freed.\n\n"
3623 pr "This function returns a string, or NULL on error.
3624 I<The caller must free the returned string after use>.\n\n"
3626 pr "This function returns a NULL-terminated array of strings
3627 (like L<environ(3)>), or NULL if there was an error.
3628 I<The caller must free the strings and the array after use>.\n\n"
3629 | RStruct (_, typ) ->
3630 pr "This function returns a C<struct guestfs_%s *>,
3631 or NULL if there was an error.
3632 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3633 | RStructList (_, typ) ->
3634 pr "This function returns a C<struct guestfs_%s_list *>
3635 (see E<lt>guestfs-structs.hE<gt>),
3636 or NULL if there was an error.
3637 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3639 pr "This function returns a NULL-terminated array of
3640 strings, or NULL if there was an error.
3641 The array of strings will always have length C<2n+1>, where
3642 C<n> keys and values alternate, followed by the trailing NULL entry.
3643 I<The caller must free the strings and the array after use>.\n\n"
3645 pr "This function returns a buffer, or NULL on error.
3646 The size of the returned buffer is written to C<*size_r>.
3647 I<The caller must free the returned buffer after use>.\n\n"
3649 if List.mem ProtocolLimitWarning flags then
3650 pr "%s\n\n" protocol_limit_warning;
3651 if List.mem DangerWillRobinson flags then
3652 pr "%s\n\n" danger_will_robinson;
3653 match deprecation_notice flags with
3655 | Some txt -> pr "%s\n\n" txt
3657 ) all_functions_sorted
3659 and generate_structs_pod () =
3660 (* Structs documentation. *)
3663 pr "=head2 guestfs_%s\n" typ;
3665 pr " struct guestfs_%s {\n" typ;
3668 | name, FChar -> pr " char %s;\n" name
3669 | name, FUInt32 -> pr " uint32_t %s;\n" name
3670 | name, FInt32 -> pr " int32_t %s;\n" name
3671 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3672 | name, FInt64 -> pr " int64_t %s;\n" name
3673 | name, FString -> pr " char *%s;\n" name
3675 pr " /* The next two fields describe a byte array. */\n";
3676 pr " uint32_t %s_len;\n" name;
3677 pr " char *%s;\n" name
3679 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3680 pr " char %s[32];\n" name
3681 | name, FOptPercent ->
3682 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3683 pr " float %s;\n" name
3687 pr " struct guestfs_%s_list {\n" typ;
3688 pr " uint32_t len; /* Number of elements in list. */\n";
3689 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
3692 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3693 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3698 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3699 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3701 * We have to use an underscore instead of a dash because otherwise
3702 * rpcgen generates incorrect code.
3704 * This header is NOT exported to clients, but see also generate_structs_h.
3706 and generate_xdr () =
3707 generate_header CStyle LGPLv2;
3709 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3710 pr "typedef string str<>;\n";
3713 (* Internal structures. *)
3717 pr "struct guestfs_int_%s {\n" typ;
3719 | name, FChar -> pr " char %s;\n" name
3720 | name, FString -> pr " string %s<>;\n" name
3721 | name, FBuffer -> pr " opaque %s<>;\n" name
3722 | name, FUUID -> pr " opaque %s[32];\n" name
3723 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
3724 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
3725 | name, FOptPercent -> pr " float %s;\n" name
3729 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3734 fun (shortname, style, _, _, _, _, _) ->
3735 let name = "guestfs_" ^ shortname in
3737 (match snd style with
3740 pr "struct %s_args {\n" name;
3743 | String n -> pr " string %s<>;\n" n
3744 | OptString n -> pr " str *%s;\n" n
3745 | StringList n -> pr " str %s<>;\n" n
3746 | Bool n -> pr " bool %s;\n" n
3747 | Int n -> pr " int %s;\n" n
3748 | FileIn _ | FileOut _ -> ()
3752 (match fst style with
3755 pr "struct %s_ret {\n" name;
3759 pr "struct %s_ret {\n" name;
3760 pr " hyper %s;\n" n;
3763 pr "struct %s_ret {\n" name;
3766 | RConstString _ | RConstOptString _ ->
3767 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
3769 pr "struct %s_ret {\n" name;
3770 pr " string %s<>;\n" n;
3773 pr "struct %s_ret {\n" name;
3774 pr " str %s<>;\n" n;
3776 | RStruct (n, typ) ->
3777 pr "struct %s_ret {\n" name;
3778 pr " guestfs_int_%s %s;\n" typ n;
3780 | RStructList (n, typ) ->
3781 pr "struct %s_ret {\n" name;
3782 pr " guestfs_int_%s_list %s;\n" typ n;
3785 pr "struct %s_ret {\n" name;
3786 pr " str %s<>;\n" n;
3789 pr "struct %s_ret {\n" name;
3790 pr " opaque %s<>;\n" n;
3795 (* Table of procedure numbers. *)
3796 pr "enum guestfs_procedure {\n";
3798 fun (shortname, _, proc_nr, _, _, _, _) ->
3799 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3801 pr " GUESTFS_PROC_NR_PROCS\n";
3805 (* Having to choose a maximum message size is annoying for several
3806 * reasons (it limits what we can do in the API), but it (a) makes
3807 * the protocol a lot simpler, and (b) provides a bound on the size
3808 * of the daemon which operates in limited memory space. For large
3809 * file transfers you should use FTP.
3811 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3814 (* Message header, etc. *)
3816 /* The communication protocol is now documented in the guestfs(3)
3820 const GUESTFS_PROGRAM = 0x2000F5F5;
3821 const GUESTFS_PROTOCOL_VERSION = 1;
3823 /* These constants must be larger than any possible message length. */
3824 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3825 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3827 enum guestfs_message_direction {
3828 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3829 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3832 enum guestfs_message_status {
3833 GUESTFS_STATUS_OK = 0,
3834 GUESTFS_STATUS_ERROR = 1
3837 const GUESTFS_ERROR_LEN = 256;
3839 struct guestfs_message_error {
3840 string error_message<GUESTFS_ERROR_LEN>;
3843 struct guestfs_message_header {
3844 unsigned prog; /* GUESTFS_PROGRAM */
3845 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3846 guestfs_procedure proc; /* GUESTFS_PROC_x */
3847 guestfs_message_direction direction;
3848 unsigned serial; /* message serial number */
3849 guestfs_message_status status;
3852 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3854 struct guestfs_chunk {
3855 int cancel; /* if non-zero, transfer is cancelled */
3856 /* data size is 0 bytes if the transfer has finished successfully */
3857 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3861 (* Generate the guestfs-structs.h file. *)
3862 and generate_structs_h () =
3863 generate_header CStyle LGPLv2;
3865 (* This is a public exported header file containing various
3866 * structures. The structures are carefully written to have
3867 * exactly the same in-memory format as the XDR structures that
3868 * we use on the wire to the daemon. The reason for creating
3869 * copies of these structures here is just so we don't have to
3870 * export the whole of guestfs_protocol.h (which includes much
3871 * unrelated and XDR-dependent stuff that we don't want to be
3872 * public, or required by clients).
3874 * To reiterate, we will pass these structures to and from the
3875 * client with a simple assignment or memcpy, so the format
3876 * must be identical to what rpcgen / the RFC defines.
3879 (* Public structures. *)
3882 pr "struct guestfs_%s {\n" typ;
3885 | name, FChar -> pr " char %s;\n" name
3886 | name, FString -> pr " char *%s;\n" name
3888 pr " uint32_t %s_len;\n" name;
3889 pr " char *%s;\n" name
3890 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3891 | name, FUInt32 -> pr " uint32_t %s;\n" name
3892 | name, FInt32 -> pr " int32_t %s;\n" name
3893 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3894 | name, FInt64 -> pr " int64_t %s;\n" name
3895 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3899 pr "struct guestfs_%s_list {\n" typ;
3900 pr " uint32_t len;\n";
3901 pr " struct guestfs_%s *val;\n" typ;
3904 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
3905 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
3909 (* Generate the guestfs-actions.h file. *)
3910 and generate_actions_h () =
3911 generate_header CStyle LGPLv2;
3913 fun (shortname, style, _, _, _, _, _) ->
3914 let name = "guestfs_" ^ shortname in
3915 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3919 (* Generate the client-side dispatch stubs. *)
3920 and generate_client_actions () =
3921 generate_header CStyle LGPLv2;
3927 #include \"guestfs.h\"
3928 #include \"guestfs_protocol.h\"
3930 #define error guestfs_error
3931 #define perrorf guestfs_perrorf
3932 #define safe_malloc guestfs_safe_malloc
3933 #define safe_realloc guestfs_safe_realloc
3934 #define safe_strdup guestfs_safe_strdup
3935 #define safe_memdup guestfs_safe_memdup
3937 /* Check the return message from a call for validity. */
3939 check_reply_header (guestfs_h *g,
3940 const struct guestfs_message_header *hdr,
3941 int proc_nr, int serial)
3943 if (hdr->prog != GUESTFS_PROGRAM) {
3944 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3947 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3948 error (g, \"wrong protocol version (%%d/%%d)\",
3949 hdr->vers, GUESTFS_PROTOCOL_VERSION);
3952 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3953 error (g, \"unexpected message direction (%%d/%%d)\",
3954 hdr->direction, GUESTFS_DIRECTION_REPLY);
3957 if (hdr->proc != proc_nr) {
3958 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3961 if (hdr->serial != serial) {
3962 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3969 /* Check we are in the right state to run a high-level action. */
3971 check_state (guestfs_h *g, const char *caller)
3973 if (!guestfs_is_ready (g)) {
3974 if (guestfs_is_config (g))
3975 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
3977 else if (guestfs_is_launching (g))
3978 error (g, \"%%s: call wait_ready() before using this function\",
3981 error (g, \"%%s called from the wrong state, %%d != READY\",
3982 caller, guestfs_get_state (g));
3990 (* Client-side stubs for each function. *)
3992 fun (shortname, style, _, _, _, _, _) ->
3993 let name = "guestfs_" ^ shortname in
3995 (* Generate the context struct which stores the high-level
3996 * state between callback functions.
3998 pr "struct %s_ctx {\n" shortname;
3999 pr " /* This flag is set by the callbacks, so we know we've done\n";
4000 pr " * the callbacks as expected, and in the right sequence.\n";
4001 pr " * 0 = not called, 1 = reply_cb called.\n";
4003 pr " int cb_sequence;\n";
4004 pr " struct guestfs_message_header hdr;\n";
4005 pr " struct guestfs_message_error err;\n";
4006 (match fst style with
4008 | RConstString _ | RConstOptString _ ->
4009 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4011 | RBool _ | RString _ | RStringList _
4012 | RStruct _ | RStructList _
4013 | RHashtable _ | RBufferOut _ ->
4014 pr " struct %s_ret ret;\n" name
4019 (* Generate the reply callback function. *)
4020 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4022 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4023 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4025 pr " /* This should definitely not happen. */\n";
4026 pr " if (ctx->cb_sequence != 0) {\n";
4027 pr " ctx->cb_sequence = 9999;\n";
4028 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4032 pr " ml->main_loop_quit (ml, g);\n";
4034 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4035 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4038 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4039 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4040 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4047 (match fst style with
4049 | RConstString _ | RConstOptString _ ->
4050 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4052 | RBool _ | RString _ | RStringList _
4053 | RStruct _ | RStructList _
4054 | RHashtable _ | RBufferOut _ ->
4055 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4056 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4062 pr " ctx->cb_sequence = 1;\n";
4065 (* Generate the action stub. *)
4066 generate_prototype ~extern:false ~semicolon:false ~newline:true
4067 ~handle:"g" name style;
4070 match fst style with
4071 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4072 | RConstString _ | RConstOptString _ ->
4073 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4074 | RString _ | RStringList _
4075 | RStruct _ | RStructList _
4076 | RHashtable _ | RBufferOut _ ->
4081 (match snd style with
4083 | _ -> pr " struct %s_args args;\n" name
4086 pr " struct %s_ctx ctx;\n" shortname;
4087 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4088 pr " int serial;\n";
4090 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4091 pr " guestfs_set_busy (g);\n";
4093 pr " memset (&ctx, 0, sizeof ctx);\n";
4096 (* Send the main header and arguments. *)
4097 (match snd style with
4099 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4100 (String.uppercase shortname)
4105 pr " args.%s = (char *) %s;\n" n n
4107 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4109 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4110 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4112 pr " args.%s = %s;\n" n n
4114 pr " args.%s = %s;\n" n n
4115 | FileIn _ | FileOut _ -> ()
4117 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4118 (String.uppercase shortname);
4119 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4122 pr " if (serial == -1) {\n";
4123 pr " guestfs_end_busy (g);\n";
4124 pr " return %s;\n" error_code;
4128 (* Send any additional files (FileIn) requested. *)
4129 let need_read_reply_label = ref false in
4136 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4137 pr " if (r == -1) {\n";
4138 pr " guestfs_end_busy (g);\n";
4139 pr " return %s;\n" error_code;
4141 pr " if (r == -2) /* daemon cancelled */\n";
4142 pr " goto read_reply;\n";
4143 need_read_reply_label := true;
4149 (* Wait for the reply from the remote end. *)
4150 if !need_read_reply_label then pr " read_reply:\n";
4151 pr " guestfs__switch_to_receiving (g);\n";
4152 pr " ctx.cb_sequence = 0;\n";
4153 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4154 pr " (void) ml->main_loop_run (ml, g);\n";
4155 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4156 pr " if (ctx.cb_sequence != 1) {\n";
4157 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4158 pr " guestfs_end_busy (g);\n";
4159 pr " return %s;\n" error_code;
4163 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4164 (String.uppercase shortname);
4165 pr " guestfs_end_busy (g);\n";
4166 pr " return %s;\n" error_code;
4170 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4171 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4172 pr " free (ctx.err.error_message);\n";
4173 pr " guestfs_end_busy (g);\n";
4174 pr " return %s;\n" error_code;
4178 (* Expecting to receive further files (FileOut)? *)
4182 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4183 pr " guestfs_end_busy (g);\n";
4184 pr " return %s;\n" error_code;
4190 pr " guestfs_end_busy (g);\n";
4192 (match fst style with
4193 | RErr -> pr " return 0;\n"
4194 | RInt n | RInt64 n | RBool n ->
4195 pr " return ctx.ret.%s;\n" n
4196 | RConstString _ | RConstOptString _ ->
4197 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4199 pr " return ctx.ret.%s; /* caller will free */\n" n
4200 | RStringList n | RHashtable n ->
4201 pr " /* caller will free this, but we need to add a NULL entry */\n";
4202 pr " ctx.ret.%s.%s_val =\n" n n;
4203 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4204 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4206 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4207 pr " return ctx.ret.%s.%s_val;\n" n n
4209 pr " /* caller will free this */\n";
4210 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4211 | RStructList (n, _) ->
4212 pr " /* caller will free this */\n";
4213 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4215 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4216 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4222 (* Functions to free structures. *)
4223 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4224 pr " * structure format is identical to the XDR format. See note in\n";
4225 pr " * generator.ml.\n";
4232 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4234 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4240 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4242 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4249 (* Generate daemon/actions.h. *)
4250 and generate_daemon_actions_h () =
4251 generate_header CStyle GPLv2;
4253 pr "#include \"../src/guestfs_protocol.h\"\n";
4257 fun (name, style, _, _, _, _, _) ->
4259 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4263 (* Generate the server-side stubs. *)
4264 and generate_daemon_actions () =
4265 generate_header CStyle GPLv2;
4267 pr "#include <config.h>\n";
4269 pr "#include <stdio.h>\n";
4270 pr "#include <stdlib.h>\n";
4271 pr "#include <string.h>\n";
4272 pr "#include <inttypes.h>\n";
4273 pr "#include <ctype.h>\n";
4274 pr "#include <rpc/types.h>\n";
4275 pr "#include <rpc/xdr.h>\n";
4277 pr "#include \"daemon.h\"\n";
4278 pr "#include \"../src/guestfs_protocol.h\"\n";
4279 pr "#include \"actions.h\"\n";
4283 fun (name, style, _, _, _, _, _) ->
4284 (* Generate server-side stubs. *)
4285 pr "static void %s_stub (XDR *xdr_in)\n" name;
4288 match fst style with
4289 | RErr | RInt _ -> pr " int r;\n"; "-1"
4290 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4291 | RBool _ -> pr " int r;\n"; "-1"
4292 | RConstString _ | RConstOptString _ ->
4293 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4294 | RString _ -> pr " char *r;\n"; "NULL"
4295 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4296 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4297 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4299 pr " size_t size;\n";
4303 (match snd style with
4306 pr " struct guestfs_%s_args args;\n" name;
4309 (* Note we allow the string to be writable, in order to
4310 * allow device name translation. This is safe because
4311 * we can modify the string (passed from RPC).
4314 | OptString n -> pr " char *%s;\n" n
4315 | StringList n -> pr " char **%s;\n" n
4316 | Bool n -> pr " int %s;\n" n
4317 | Int n -> pr " int %s;\n" n
4318 | FileIn _ | FileOut _ -> ()
4323 (match snd style with
4326 pr " memset (&args, 0, sizeof args);\n";
4328 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4329 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4334 | String n -> pr " %s = args.%s;\n" n n
4335 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4337 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4338 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4339 pr " if (%s == NULL) {\n" n;
4340 pr " reply_with_perror (\"realloc\");\n";
4343 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4344 pr " args.%s.%s_val = %s;\n" n n n;
4345 | Bool n -> pr " %s = args.%s;\n" n n
4346 | Int n -> pr " %s = args.%s;\n" n n
4347 | FileIn _ | FileOut _ -> ()
4352 (* Don't want to call the impl with any FileIn or FileOut
4353 * parameters, since these go "outside" the RPC protocol.
4356 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4358 pr " r = do_%s " name;
4359 generate_c_call_args (fst style, args');
4362 pr " if (r == %s)\n" error_code;
4363 pr " /* do_%s has already called reply_with_error */\n" name;
4367 (* If there are any FileOut parameters, then the impl must
4368 * send its own reply.
4371 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4373 pr " /* do_%s has already sent a reply */\n" name
4375 match fst style with
4376 | RErr -> pr " reply (NULL, NULL);\n"
4377 | RInt n | RInt64 n | RBool n ->
4378 pr " struct guestfs_%s_ret ret;\n" name;
4379 pr " ret.%s = r;\n" n;
4380 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4382 | RConstString _ | RConstOptString _ ->
4383 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4385 pr " struct guestfs_%s_ret ret;\n" name;
4386 pr " ret.%s = r;\n" n;
4387 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4390 | RStringList n | RHashtable n ->
4391 pr " struct guestfs_%s_ret ret;\n" name;
4392 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4393 pr " ret.%s.%s_val = r;\n" n n;
4394 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4396 pr " free_strings (r);\n"
4398 pr " struct guestfs_%s_ret ret;\n" name;
4399 pr " ret.%s = *r;\n" n;
4400 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4402 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4404 | RStructList (n, _) ->
4405 pr " struct guestfs_%s_ret ret;\n" name;
4406 pr " ret.%s = *r;\n" n;
4407 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4409 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4412 pr " struct guestfs_%s_ret ret;\n" name;
4413 pr " ret.%s.%s_val = r;\n" n n;
4414 pr " ret.%s.%s_len = size;\n" n n;
4415 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4420 (* Free the args. *)
4421 (match snd style with
4426 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4433 (* Dispatch function. *)
4434 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4436 pr " switch (proc_nr) {\n";
4439 fun (name, style, _, _, _, _, _) ->
4440 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4441 pr " %s_stub (xdr_in);\n" name;
4446 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";
4451 (* LVM columns and tokenization functions. *)
4452 (* XXX This generates crap code. We should rethink how we
4458 pr "static const char *lvm_%s_cols = \"%s\";\n"
4459 typ (String.concat "," (List.map fst cols));
4462 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4464 pr " char *tok, *p, *next;\n";
4468 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4471 pr " if (!str) {\n";
4472 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4475 pr " if (!*str || isspace (*str)) {\n";
4476 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4481 fun (name, coltype) ->
4482 pr " if (!tok) {\n";
4483 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4486 pr " p = strchrnul (tok, ',');\n";
4487 pr " if (*p) next = p+1; else next = NULL;\n";
4488 pr " *p = '\\0';\n";
4491 pr " r->%s = strdup (tok);\n" name;
4492 pr " if (r->%s == NULL) {\n" name;
4493 pr " perror (\"strdup\");\n";
4497 pr " for (i = j = 0; i < 32; ++j) {\n";
4498 pr " if (tok[j] == '\\0') {\n";
4499 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4501 pr " } else if (tok[j] != '-')\n";
4502 pr " r->%s[i++] = tok[j];\n" name;
4505 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4506 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4510 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4511 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4515 pr " if (tok[0] == '\\0')\n";
4516 pr " r->%s = -1;\n" name;
4517 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4518 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4521 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4522 assert false (* can never be an LVM column *)
4524 pr " tok = next;\n";
4527 pr " if (tok != NULL) {\n";
4528 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4535 pr "guestfs_int_lvm_%s_list *\n" typ;
4536 pr "parse_command_line_%ss (void)\n" typ;
4538 pr " char *out, *err;\n";
4539 pr " char *p, *pend;\n";
4541 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4542 pr " void *newp;\n";
4544 pr " ret = malloc (sizeof *ret);\n";
4545 pr " if (!ret) {\n";
4546 pr " reply_with_perror (\"malloc\");\n";
4547 pr " return NULL;\n";
4550 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4551 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4553 pr " r = command (&out, &err,\n";
4554 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4555 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4556 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4557 pr " if (r == -1) {\n";
4558 pr " reply_with_error (\"%%s\", err);\n";
4559 pr " free (out);\n";
4560 pr " free (err);\n";
4561 pr " free (ret);\n";
4562 pr " return NULL;\n";
4565 pr " free (err);\n";
4567 pr " /* Tokenize each line of the output. */\n";
4570 pr " while (p) {\n";
4571 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4572 pr " if (pend) {\n";
4573 pr " *pend = '\\0';\n";
4577 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4580 pr " if (!*p) { /* Empty line? Skip it. */\n";
4585 pr " /* Allocate some space to store this next entry. */\n";
4586 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4587 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4588 pr " if (newp == NULL) {\n";
4589 pr " reply_with_perror (\"realloc\");\n";
4590 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4591 pr " free (ret);\n";
4592 pr " free (out);\n";
4593 pr " return NULL;\n";
4595 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4597 pr " /* Tokenize the next entry. */\n";
4598 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4599 pr " if (r == -1) {\n";
4600 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4601 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4602 pr " free (ret);\n";
4603 pr " free (out);\n";
4604 pr " return NULL;\n";
4611 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4613 pr " free (out);\n";
4614 pr " return ret;\n";
4617 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4619 (* Generate a list of function names, for debugging in the daemon.. *)
4620 and generate_daemon_names () =
4621 generate_header CStyle GPLv2;
4623 pr "#include <config.h>\n";
4625 pr "#include \"daemon.h\"\n";
4628 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4629 pr "const char *function_names[] = {\n";
4631 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4635 (* Generate the tests. *)
4636 and generate_tests () =
4637 generate_header CStyle GPLv2;
4644 #include <sys/types.h>
4647 #include \"guestfs.h\"
4649 static guestfs_h *g;
4650 static int suppress_error = 0;
4652 static void print_error (guestfs_h *g, void *data, const char *msg)
4654 if (!suppress_error)
4655 fprintf (stderr, \"%%s\\n\", msg);
4658 static void print_strings (char * const * const argv)
4662 for (argc = 0; argv[argc] != NULL; ++argc)
4663 printf (\"\\t%%s\\n\", argv[argc]);
4667 static void print_table (char * const * const argv)
4671 for (i = 0; argv[i] != NULL; i += 2)
4672 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
4676 static void no_test_warnings (void)
4682 | name, _, _, _, [], _, _ ->
4683 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4684 | name, _, _, _, tests, _, _ -> ()
4690 (* Generate the actual tests. Note that we generate the tests
4691 * in reverse order, deliberately, so that (in general) the
4692 * newest tests run first. This makes it quicker and easier to
4697 fun (name, _, _, _, tests, _, _) ->
4698 mapi (generate_one_test name) tests
4699 ) (List.rev all_functions) in
4700 let test_names = List.concat test_names in
4701 let nr_tests = List.length test_names in
4704 int main (int argc, char *argv[])
4708 const char *filename;
4710 int nr_tests, test_num = 0;
4712 setbuf (stdout, NULL);
4714 no_test_warnings ();
4716 g = guestfs_create ();
4718 printf (\"guestfs_create FAILED\\n\");
4722 guestfs_set_error_handler (g, print_error, NULL);
4724 guestfs_set_path (g, \"../appliance\");
4726 filename = \"test1.img\";
4727 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4732 if (lseek (fd, %d, SEEK_SET) == -1) {
4738 if (write (fd, &c, 1) == -1) {
4744 if (close (fd) == -1) {
4749 if (guestfs_add_drive (g, filename) == -1) {
4750 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4754 filename = \"test2.img\";
4755 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4760 if (lseek (fd, %d, SEEK_SET) == -1) {
4766 if (write (fd, &c, 1) == -1) {
4772 if (close (fd) == -1) {
4777 if (guestfs_add_drive (g, filename) == -1) {
4778 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4782 filename = \"test3.img\";
4783 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4788 if (lseek (fd, %d, SEEK_SET) == -1) {
4794 if (write (fd, &c, 1) == -1) {
4800 if (close (fd) == -1) {
4805 if (guestfs_add_drive (g, filename) == -1) {
4806 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4810 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4811 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4815 if (guestfs_launch (g) == -1) {
4816 printf (\"guestfs_launch FAILED\\n\");
4820 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4823 if (guestfs_wait_ready (g) == -1) {
4824 printf (\"guestfs_wait_ready FAILED\\n\");
4828 /* Cancel previous alarm. */
4833 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4837 pr " test_num++;\n";
4838 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4839 pr " if (%s () == -1) {\n" test_name;
4840 pr " printf (\"%s FAILED\\n\");\n" test_name;
4846 pr " guestfs_close (g);\n";
4847 pr " unlink (\"test1.img\");\n";
4848 pr " unlink (\"test2.img\");\n";
4849 pr " unlink (\"test3.img\");\n";
4852 pr " if (failed > 0) {\n";
4853 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4861 and generate_one_test name i (init, prereq, test) =
4862 let test_name = sprintf "test_%s_%d" name i in
4865 static int %s_skip (void)
4869 str = getenv (\"TEST_ONLY\");
4871 return strstr (str, \"%s\") == NULL;
4872 str = getenv (\"SKIP_%s\");
4873 if (str && strcmp (str, \"1\") == 0) return 1;
4874 str = getenv (\"SKIP_TEST_%s\");
4875 if (str && strcmp (str, \"1\") == 0) return 1;
4879 " test_name name (String.uppercase test_name) (String.uppercase name);
4882 | Disabled | Always -> ()
4883 | If code | Unless code ->
4884 pr "static int %s_prereq (void)\n" test_name;
4892 static int %s (void)
4895 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
4899 " test_name test_name test_name;
4903 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4905 pr " if (! %s_prereq ()) {\n" test_name;
4906 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4910 generate_one_test_body name i test_name init test;
4912 pr " if (%s_prereq ()) {\n" test_name;
4913 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4917 generate_one_test_body name i test_name init test;
4919 generate_one_test_body name i test_name init test
4927 and generate_one_test_body name i test_name init test =
4929 | InitNone (* XXX at some point, InitNone and InitEmpty became
4930 * folded together as the same thing. Really we should
4931 * make InitNone do nothing at all, but the tests may
4932 * need to be checked to make sure this is OK.
4935 pr " /* InitNone|InitEmpty for %s */\n" test_name;
4936 List.iter (generate_test_command_call test_name)
4937 [["blockdev_setrw"; "/dev/sda"];
4941 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4942 List.iter (generate_test_command_call test_name)
4943 [["blockdev_setrw"; "/dev/sda"];
4946 ["sfdiskM"; "/dev/sda"; ","];
4947 ["mkfs"; "ext2"; "/dev/sda1"];
4948 ["mount"; "/dev/sda1"; "/"]]
4949 | InitBasicFSonLVM ->
4950 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4952 List.iter (generate_test_command_call test_name)
4953 [["blockdev_setrw"; "/dev/sda"];
4956 ["sfdiskM"; "/dev/sda"; ","];
4957 ["pvcreate"; "/dev/sda1"];
4958 ["vgcreate"; "VG"; "/dev/sda1"];
4959 ["lvcreate"; "LV"; "VG"; "8"];
4960 ["mkfs"; "ext2"; "/dev/VG/LV"];
4961 ["mount"; "/dev/VG/LV"; "/"]]
4963 pr " /* InitSquashFS for %s */\n" test_name;
4964 List.iter (generate_test_command_call test_name)
4965 [["blockdev_setrw"; "/dev/sda"];
4968 ["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"]]
4971 let get_seq_last = function
4973 failwithf "%s: you cannot use [] (empty list) when expecting a command"
4976 let seq = List.rev seq in
4977 List.rev (List.tl seq), List.hd seq
4982 pr " /* TestRun for %s (%d) */\n" name i;
4983 List.iter (generate_test_command_call test_name) seq
4984 | TestOutput (seq, expected) ->
4985 pr " /* TestOutput for %s (%d) */\n" name i;
4986 pr " const char *expected = \"%s\";\n" (c_quote expected);
4987 let seq, last = get_seq_last seq in
4989 pr " if (strcmp (r, expected) != 0) {\n";
4990 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4994 List.iter (generate_test_command_call test_name) seq;
4995 generate_test_command_call ~test test_name last
4996 | TestOutputList (seq, expected) ->
4997 pr " /* TestOutputList for %s (%d) */\n" name i;
4998 let seq, last = get_seq_last seq in
5002 pr " if (!r[%d]) {\n" i;
5003 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5004 pr " print_strings (r);\n";
5008 pr " const char *expected = \"%s\";\n" (c_quote str);
5009 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5010 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5015 pr " if (r[%d] != NULL) {\n" (List.length expected);
5016 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5018 pr " print_strings (r);\n";
5022 List.iter (generate_test_command_call test_name) seq;
5023 generate_test_command_call ~test test_name last
5024 | TestOutputListOfDevices (seq, expected) ->
5025 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5026 let seq, last = get_seq_last seq in
5030 pr " if (!r[%d]) {\n" i;
5031 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5032 pr " print_strings (r);\n";
5036 pr " const char *expected = \"%s\";\n" (c_quote str);
5037 pr " r[%d][5] = 's';\n" i;
5038 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5039 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5044 pr " if (r[%d] != NULL) {\n" (List.length expected);
5045 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5047 pr " print_strings (r);\n";
5051 List.iter (generate_test_command_call test_name) seq;
5052 generate_test_command_call ~test test_name last
5053 | TestOutputInt (seq, expected) ->
5054 pr " /* TestOutputInt for %s (%d) */\n" name i;
5055 let seq, last = get_seq_last seq in
5057 pr " if (r != %d) {\n" expected;
5058 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5064 List.iter (generate_test_command_call test_name) seq;
5065 generate_test_command_call ~test test_name last
5066 | TestOutputIntOp (seq, op, expected) ->
5067 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5068 let seq, last = get_seq_last seq in
5070 pr " if (! (r %s %d)) {\n" op expected;
5071 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5072 test_name op expected;
5077 List.iter (generate_test_command_call test_name) seq;
5078 generate_test_command_call ~test test_name last
5079 | TestOutputTrue seq ->
5080 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5081 let seq, last = get_seq_last seq in
5084 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5089 List.iter (generate_test_command_call test_name) seq;
5090 generate_test_command_call ~test test_name last
5091 | TestOutputFalse seq ->
5092 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5093 let seq, last = get_seq_last seq in
5096 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5101 List.iter (generate_test_command_call test_name) seq;
5102 generate_test_command_call ~test test_name last
5103 | TestOutputLength (seq, expected) ->
5104 pr " /* TestOutputLength for %s (%d) */\n" name i;
5105 let seq, last = get_seq_last seq in
5108 pr " for (j = 0; j < %d; ++j)\n" expected;
5109 pr " if (r[j] == NULL) {\n";
5110 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5112 pr " print_strings (r);\n";
5115 pr " if (r[j] != NULL) {\n";
5116 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5118 pr " print_strings (r);\n";
5122 List.iter (generate_test_command_call test_name) seq;
5123 generate_test_command_call ~test test_name last
5124 | TestOutputStruct (seq, checks) ->
5125 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5126 let seq, last = get_seq_last seq in
5130 | CompareWithInt (field, expected) ->
5131 pr " if (r->%s != %d) {\n" field expected;
5132 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5133 test_name field expected;
5134 pr " (int) r->%s);\n" field;
5137 | CompareWithIntOp (field, op, expected) ->
5138 pr " if (!(r->%s %s %d)) {\n" field op expected;
5139 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5140 test_name field op expected;
5141 pr " (int) r->%s);\n" field;
5144 | CompareWithString (field, expected) ->
5145 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5146 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5147 test_name field expected;
5148 pr " r->%s);\n" field;
5151 | CompareFieldsIntEq (field1, field2) ->
5152 pr " if (r->%s != r->%s) {\n" field1 field2;
5153 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5154 test_name field1 field2;
5155 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5158 | CompareFieldsStrEq (field1, field2) ->
5159 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5160 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5161 test_name field1 field2;
5162 pr " r->%s, r->%s);\n" field1 field2;
5167 List.iter (generate_test_command_call test_name) seq;
5168 generate_test_command_call ~test test_name last
5169 | TestLastFail seq ->
5170 pr " /* TestLastFail for %s (%d) */\n" name i;
5171 let seq, last = get_seq_last seq in
5172 List.iter (generate_test_command_call test_name) seq;
5173 generate_test_command_call test_name ~expect_error:true last
5175 (* Generate the code to run a command, leaving the result in 'r'.
5176 * If you expect to get an error then you should set expect_error:true.
5178 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5180 | [] -> assert false
5182 (* Look up the command to find out what args/ret it has. *)
5185 let _, style, _, _, _, _, _ =
5186 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5189 failwithf "%s: in test, command %s was not found" test_name name in
5191 if List.length (snd style) <> List.length args then
5192 failwithf "%s: in test, wrong number of args given to %s"
5199 | OptString n, "NULL" -> ()
5201 | OptString n, arg ->
5202 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5205 | FileIn _, _ | FileOut _, _ -> ()
5206 | StringList n, arg ->
5207 let strs = string_split " " arg in
5210 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5212 pr " const char *%s[] = {\n" n;
5214 fun i _ -> pr " %s_%d,\n" n i
5218 ) (List.combine (snd style) args);
5221 match fst style with
5222 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5223 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5224 | RConstString _ | RConstOptString _ ->
5225 pr " const char *r;\n"; "NULL"
5226 | RString _ -> pr " char *r;\n"; "NULL"
5227 | RStringList _ | RHashtable _ ->
5231 | RStruct (_, typ) ->
5232 pr " struct guestfs_%s *r;\n" typ; "NULL"
5233 | RStructList (_, typ) ->
5234 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5237 pr " size_t size;\n";
5240 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5241 pr " r = guestfs_%s (g" name;
5243 (* Generate the parameters. *)
5246 | OptString _, "NULL" -> pr ", NULL"
5250 | FileIn _, arg | FileOut _, arg ->
5251 pr ", \"%s\"" (c_quote arg)
5252 | StringList n, _ ->
5256 try int_of_string arg
5257 with Failure "int_of_string" ->
5258 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5261 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5262 ) (List.combine (snd style) args);
5264 (match fst style with
5265 | RBufferOut _ -> pr ", &size"
5271 if not expect_error then
5272 pr " if (r == %s)\n" error_code
5274 pr " if (r != %s)\n" error_code;
5277 (* Insert the test code. *)
5283 (match fst style with
5284 | RErr | RInt _ | RInt64 _ | RBool _
5285 | RConstString _ | RConstOptString _ -> ()
5286 | RString _ | RBufferOut _ -> pr " free (r);\n"
5287 | RStringList _ | RHashtable _ ->
5288 pr " for (i = 0; r[i] != NULL; ++i)\n";
5289 pr " free (r[i]);\n";
5291 | RStruct (_, typ) ->
5292 pr " guestfs_free_%s (r);\n" typ
5293 | RStructList (_, typ) ->
5294 pr " guestfs_free_%s_list (r);\n" typ
5300 let str = replace_str str "\r" "\\r" in
5301 let str = replace_str str "\n" "\\n" in
5302 let str = replace_str str "\t" "\\t" in
5303 let str = replace_str str "\000" "\\0" in
5306 (* Generate a lot of different functions for guestfish. *)
5307 and generate_fish_cmds () =
5308 generate_header CStyle GPLv2;
5312 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5314 let all_functions_sorted =
5316 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5317 ) all_functions_sorted in
5319 pr "#include <stdio.h>\n";
5320 pr "#include <stdlib.h>\n";
5321 pr "#include <string.h>\n";
5322 pr "#include <inttypes.h>\n";
5323 pr "#include <ctype.h>\n";
5325 pr "#include <guestfs.h>\n";
5326 pr "#include \"fish.h\"\n";
5329 (* list_commands function, which implements guestfish -h *)
5330 pr "void list_commands (void)\n";
5332 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
5333 pr " list_builtin_commands ();\n";
5335 fun (name, _, _, flags, _, shortdesc, _) ->
5336 let name = replace_char name '_' '-' in
5337 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
5339 ) all_functions_sorted;
5340 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
5344 (* display_command function, which implements guestfish -h cmd *)
5345 pr "void display_command (const char *cmd)\n";
5348 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5349 let name2 = replace_char name '_' '-' in
5351 try find_map (function FishAlias n -> Some n | _ -> None) flags
5352 with Not_found -> name in
5353 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5355 match snd style with
5359 name2 (String.concat "> <" (List.map name_of_argt args)) in
5362 if List.mem ProtocolLimitWarning flags then
5363 ("\n\n" ^ protocol_limit_warning)
5366 (* For DangerWillRobinson commands, we should probably have
5367 * guestfish prompt before allowing you to use them (especially
5368 * in interactive mode). XXX
5372 if List.mem DangerWillRobinson flags then
5373 ("\n\n" ^ danger_will_robinson)
5378 match deprecation_notice flags with
5380 | Some txt -> "\n\n" ^ txt in
5382 let describe_alias =
5383 if name <> alias then
5384 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5388 pr "strcasecmp (cmd, \"%s\") == 0" name;
5389 if name <> name2 then
5390 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5391 if name <> alias then
5392 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5394 pr " pod2text (\"%s - %s\", %S);\n"
5396 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5399 pr " display_builtin_command (cmd);\n";
5403 (* print_* functions *)
5407 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5409 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5418 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5420 pr " printf (\"%s: \");\n" name;
5421 pr " for (i = 0; i < 32; ++i)\n";
5422 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5423 pr " printf (\"\\n\");\n"
5425 pr " printf (\"%s: \");\n" name;
5426 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5427 pr " if (isprint (%s->%s[i]))\n" typ name;
5428 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5430 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
5431 pr " printf (\"\\n\");\n"
5432 | name, (FUInt64|FBytes) ->
5433 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5435 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5437 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5439 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5441 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5442 | name, FOptPercent ->
5443 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5444 typ name name typ name;
5445 pr " else printf (\"%s: \\n\");\n" name
5449 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5454 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5455 pr " print_%s (&%ss->val[i]);\n" typ typ;
5460 (* run_<action> actions *)
5462 fun (name, style, _, flags, _, _, _) ->
5463 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5465 (match fst style with
5468 | RBool _ -> pr " int r;\n"
5469 | RInt64 _ -> pr " int64_t r;\n"
5470 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5471 | RString _ -> pr " char *r;\n"
5472 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5473 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5474 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5477 pr " size_t size;\n";
5484 | FileOut n -> pr " const char *%s;\n" n
5485 | StringList n -> pr " char **%s;\n" n
5486 | Bool n -> pr " int %s;\n" n
5487 | Int n -> pr " int %s;\n" n
5490 (* Check and convert parameters. *)
5491 let argc_expected = List.length (snd style) in
5492 pr " if (argc != %d) {\n" argc_expected;
5493 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
5495 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
5501 | String name -> pr " %s = argv[%d];\n" name i
5503 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5506 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5509 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5511 | StringList name ->
5512 pr " %s = parse_string_list (argv[%d]);\n" name i
5514 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5516 pr " %s = atoi (argv[%d]);\n" name i
5519 (* Call C API function. *)
5521 try find_map (function FishAction n -> Some n | _ -> None) flags
5522 with Not_found -> sprintf "guestfs_%s" name in
5524 generate_c_call_args ~handle:"g" style;
5527 (* Check return value for errors and display command results. *)
5528 (match fst style with
5529 | RErr -> pr " return r;\n"
5531 pr " if (r == -1) return -1;\n";
5532 pr " printf (\"%%d\\n\", r);\n";
5535 pr " if (r == -1) return -1;\n";
5536 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5539 pr " if (r == -1) return -1;\n";
5540 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5543 pr " if (r == NULL) return -1;\n";
5544 pr " printf (\"%%s\\n\", r);\n";
5546 | RConstOptString _ ->
5547 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
5550 pr " if (r == NULL) return -1;\n";
5551 pr " printf (\"%%s\\n\", r);\n";
5555 pr " if (r == NULL) return -1;\n";
5556 pr " print_strings (r);\n";
5557 pr " free_strings (r);\n";
5559 | RStruct (_, typ) ->
5560 pr " if (r == NULL) return -1;\n";
5561 pr " print_%s (r);\n" typ;
5562 pr " guestfs_free_%s (r);\n" typ;
5564 | RStructList (_, typ) ->
5565 pr " if (r == NULL) return -1;\n";
5566 pr " print_%s_list (r);\n" typ;
5567 pr " guestfs_free_%s_list (r);\n" typ;
5570 pr " if (r == NULL) return -1;\n";
5571 pr " print_table (r);\n";
5572 pr " free_strings (r);\n";
5575 pr " if (r == NULL) return -1;\n";
5576 pr " fwrite (r, size, 1, stdout);\n";
5584 (* run_action function *)
5585 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5588 fun (name, _, _, flags, _, _, _) ->
5589 let name2 = replace_char name '_' '-' in
5591 try find_map (function FishAlias n -> Some n | _ -> None) flags
5592 with Not_found -> name in
5594 pr "strcasecmp (cmd, \"%s\") == 0" name;
5595 if name <> name2 then
5596 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5597 if name <> alias then
5598 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5600 pr " return run_%s (cmd, argc, argv);\n" name;
5604 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
5611 (* Readline completion for guestfish. *)
5612 and generate_fish_completion () =
5613 generate_header CStyle GPLv2;
5617 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5627 #ifdef HAVE_LIBREADLINE
5628 #include <readline/readline.h>
5633 #ifdef HAVE_LIBREADLINE
5635 static const char *const commands[] = {
5636 BUILTIN_COMMANDS_FOR_COMPLETION,
5639 (* Get the commands, including the aliases. They don't need to be
5640 * sorted - the generator() function just does a dumb linear search.
5644 fun (name, _, _, flags, _, _, _) ->
5645 let name2 = replace_char name '_' '-' in
5647 try find_map (function FishAlias n -> Some n | _ -> None) flags
5648 with Not_found -> name in
5650 if name <> alias then [name2; alias] else [name2]
5652 let commands = List.flatten commands in
5654 List.iter (pr " \"%s\",\n") commands;
5660 generator (const char *text, int state)
5662 static int index, len;
5667 len = strlen (text);
5670 rl_attempted_completion_over = 1;
5672 while ((name = commands[index]) != NULL) {
5674 if (strncasecmp (name, text, len) == 0)
5675 return strdup (name);
5681 #endif /* HAVE_LIBREADLINE */
5683 char **do_completion (const char *text, int start, int end)
5685 char **matches = NULL;
5687 #ifdef HAVE_LIBREADLINE
5688 rl_completion_append_character = ' ';
5691 matches = rl_completion_matches (text, generator);
5692 else if (complete_dest_paths)
5693 matches = rl_completion_matches (text, complete_dest_paths_generator);
5700 (* Generate the POD documentation for guestfish. *)
5701 and generate_fish_actions_pod () =
5702 let all_functions_sorted =
5704 fun (_, _, _, flags, _, _, _) ->
5705 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5706 ) all_functions_sorted in
5708 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5711 fun (name, style, _, flags, _, _, longdesc) ->
5713 Str.global_substitute rex (
5716 try Str.matched_group 1 s
5718 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5719 "C<" ^ replace_char sub '_' '-' ^ ">"
5721 let name = replace_char name '_' '-' in
5723 try find_map (function FishAlias n -> Some n | _ -> None) flags
5724 with Not_found -> name in
5726 pr "=head2 %s" name;
5727 if name <> alias then
5734 | String n -> pr " %s" n
5735 | OptString n -> pr " %s" n
5736 | StringList n -> pr " '%s ...'" n
5737 | Bool _ -> pr " true|false"
5738 | Int n -> pr " %s" n
5739 | FileIn n | FileOut n -> pr " (%s|-)" n
5743 pr "%s\n\n" longdesc;
5745 if List.exists (function FileIn _ | FileOut _ -> true
5746 | _ -> false) (snd style) then
5747 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5749 if List.mem ProtocolLimitWarning flags then
5750 pr "%s\n\n" protocol_limit_warning;
5752 if List.mem DangerWillRobinson flags then
5753 pr "%s\n\n" danger_will_robinson;
5755 match deprecation_notice flags with
5757 | Some txt -> pr "%s\n\n" txt
5758 ) all_functions_sorted
5760 (* Generate a C function prototype. *)
5761 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5762 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5764 ?handle name style =
5765 if extern then pr "extern ";
5766 if static then pr "static ";
5767 (match fst style with
5769 | RInt _ -> pr "int "
5770 | RInt64 _ -> pr "int64_t "
5771 | RBool _ -> pr "int "
5772 | RConstString _ | RConstOptString _ -> pr "const char *"
5773 | RString _ | RBufferOut _ -> pr "char *"
5774 | RStringList _ | RHashtable _ -> pr "char **"
5775 | RStruct (_, typ) ->
5776 if not in_daemon then pr "struct guestfs_%s *" typ
5777 else pr "guestfs_int_%s *" typ
5778 | RStructList (_, typ) ->
5779 if not in_daemon then pr "struct guestfs_%s_list *" typ
5780 else pr "guestfs_int_%s_list *" typ
5782 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
5783 pr "%s%s (" prefix name;
5784 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
5787 let comma = ref false in
5790 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5794 if single_line then pr ", " else pr ",\n\t\t"
5803 if not in_daemon then pr "const char *%s" n
5804 else pr "char *%s" n
5807 if not in_daemon then pr "char * const* const %s" n
5808 else pr "char **%s" n
5809 | Bool n -> next (); pr "int %s" n
5810 | Int n -> next (); pr "int %s" n
5813 if not in_daemon then (next (); pr "const char *%s" n)
5815 if is_RBufferOut then (next (); pr "size_t *size_r");
5818 if semicolon then pr ";";
5819 if newline then pr "\n"
5821 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5822 and generate_c_call_args ?handle ?(decl = false) style =
5824 let comma = ref false in
5826 if !comma then pr ", ";
5831 | Some handle -> pr "%s" handle; comma := true
5836 pr "%s" (name_of_argt arg)
5838 (* For RBufferOut calls, add implicit &size parameter. *)
5840 match fst style with
5848 (* Generate the OCaml bindings interface. *)
5849 and generate_ocaml_mli () =
5850 generate_header OCamlStyle LGPLv2;
5853 (** For API documentation you should refer to the C API
5854 in the guestfs(3) manual page. The OCaml API uses almost
5855 exactly the same calls. *)
5858 (** A [guestfs_h] handle. *)
5860 exception Error of string
5861 (** This exception is raised when there is an error. *)
5863 val create : unit -> t
5865 val close : t -> unit
5866 (** Handles are closed by the garbage collector when they become
5867 unreferenced, but callers can also call this in order to
5868 provide predictable cleanup. *)
5871 generate_ocaml_structure_decls ();
5875 fun (name, style, _, _, _, shortdesc, _) ->
5876 generate_ocaml_prototype name style;
5877 pr "(** %s *)\n" shortdesc;
5881 (* Generate the OCaml bindings implementation. *)
5882 and generate_ocaml_ml () =
5883 generate_header OCamlStyle LGPLv2;
5887 exception Error of string
5888 external create : unit -> t = \"ocaml_guestfs_create\"
5889 external close : t -> unit = \"ocaml_guestfs_close\"
5892 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5896 generate_ocaml_structure_decls ();
5900 fun (name, style, _, _, _, shortdesc, _) ->
5901 generate_ocaml_prototype ~is_external:true name style;
5904 (* Generate the OCaml bindings C implementation. *)
5905 and generate_ocaml_c () =
5906 generate_header CStyle LGPLv2;
5913 #include <caml/config.h>
5914 #include <caml/alloc.h>
5915 #include <caml/callback.h>
5916 #include <caml/fail.h>
5917 #include <caml/memory.h>
5918 #include <caml/mlvalues.h>
5919 #include <caml/signals.h>
5921 #include <guestfs.h>
5923 #include \"guestfs_c.h\"
5925 /* Copy a hashtable of string pairs into an assoc-list. We return
5926 * the list in reverse order, but hashtables aren't supposed to be
5929 static CAMLprim value
5930 copy_table (char * const * argv)
5933 CAMLlocal5 (rv, pairv, kv, vv, cons);
5937 for (i = 0; argv[i] != NULL; i += 2) {
5938 kv = caml_copy_string (argv[i]);
5939 vv = caml_copy_string (argv[i+1]);
5940 pairv = caml_alloc (2, 0);
5941 Store_field (pairv, 0, kv);
5942 Store_field (pairv, 1, vv);
5943 cons = caml_alloc (2, 0);
5944 Store_field (cons, 1, rv);
5946 Store_field (cons, 0, pairv);
5954 (* Struct copy functions. *)
5957 let has_optpercent_col =
5958 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
5960 pr "static CAMLprim value\n";
5961 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5963 pr " CAMLparam0 ();\n";
5964 if has_optpercent_col then
5965 pr " CAMLlocal3 (rv, v, v2);\n"
5967 pr " CAMLlocal2 (rv, v);\n";
5969 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
5974 pr " v = caml_copy_string (%s->%s);\n" typ name
5976 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
5977 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
5980 pr " v = caml_alloc_string (32);\n";
5981 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
5982 | name, (FBytes|FInt64|FUInt64) ->
5983 pr " v = caml_copy_int64 (%s->%s);\n" typ name
5984 | name, (FInt32|FUInt32) ->
5985 pr " v = caml_copy_int32 (%s->%s);\n" typ name
5986 | name, FOptPercent ->
5987 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5988 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
5989 pr " v = caml_alloc (1, 0);\n";
5990 pr " Store_field (v, 0, v2);\n";
5991 pr " } else /* None */\n";
5992 pr " v = Val_int (0);\n";
5994 pr " v = Val_int (%s->%s);\n" typ name
5996 pr " Store_field (rv, %d, v);\n" i
5998 pr " CAMLreturn (rv);\n";
6002 pr "static CAMLprim value\n";
6003 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
6006 pr " CAMLparam0 ();\n";
6007 pr " CAMLlocal2 (rv, v);\n";
6010 pr " if (%ss->len == 0)\n" typ;
6011 pr " CAMLreturn (Atom (0));\n";
6013 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
6014 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6015 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
6016 pr " caml_modify (&Field (rv, i), v);\n";
6018 pr " CAMLreturn (rv);\n";
6026 fun (name, style, _, _, _, _, _) ->
6028 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
6030 let needs_extra_vs =
6031 match fst style with RConstOptString _ -> true | _ -> false in
6033 pr "CAMLprim value\n";
6034 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6035 List.iter (pr ", value %s") (List.tl params);
6040 | [p1; p2; p3; p4; p5] ->
6041 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6042 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6043 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6044 pr " CAMLxparam%d (%s);\n"
6045 (List.length rest) (String.concat ", " rest)
6047 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6049 if not needs_extra_vs then
6050 pr " CAMLlocal1 (rv);\n"
6052 pr " CAMLlocal3 (rv, v, v2);\n";
6055 pr " guestfs_h *g = Guestfs_val (gv);\n";
6056 pr " if (g == NULL)\n";
6057 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6065 pr " const char *%s = String_val (%sv);\n" n n
6067 pr " const char *%s =\n" n;
6068 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6071 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6073 pr " int %s = Bool_val (%sv);\n" n n
6075 pr " int %s = Int_val (%sv);\n" n n
6078 match fst style with
6079 | RErr -> pr " int r;\n"; "-1"
6080 | RInt _ -> pr " int r;\n"; "-1"
6081 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6082 | RBool _ -> pr " int r;\n"; "-1"
6083 | RConstString _ | RConstOptString _ ->
6084 pr " const char *r;\n"; "NULL"
6085 | RString _ -> pr " char *r;\n"; "NULL"
6090 | RStruct (_, typ) ->
6091 pr " struct guestfs_%s *r;\n" typ; "NULL"
6092 | RStructList (_, typ) ->
6093 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6100 pr " size_t size;\n";
6104 pr " caml_enter_blocking_section ();\n";
6105 pr " r = guestfs_%s " name;
6106 generate_c_call_args ~handle:"g" style;
6108 pr " caml_leave_blocking_section ();\n";
6113 pr " ocaml_guestfs_free_strings (%s);\n" n;
6114 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6117 pr " if (r == %s)\n" error_code;
6118 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6121 (match fst style with
6122 | RErr -> pr " rv = Val_unit;\n"
6123 | RInt _ -> pr " rv = Val_int (r);\n"
6125 pr " rv = caml_copy_int64 (r);\n"
6126 | RBool _ -> pr " rv = Val_bool (r);\n"
6128 pr " rv = caml_copy_string (r);\n"
6129 | RConstOptString _ ->
6130 pr " if (r) { /* Some string */\n";
6131 pr " v = caml_alloc (1, 0);\n";
6132 pr " v2 = caml_copy_string (r);\n";
6133 pr " Store_field (v, 0, v2);\n";
6134 pr " } else /* None */\n";
6135 pr " v = Val_int (0);\n";
6137 pr " rv = caml_copy_string (r);\n";
6140 pr " rv = caml_copy_string_array ((const char **) r);\n";
6141 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6143 | RStruct (_, typ) ->
6144 pr " rv = copy_%s (r);\n" typ;
6145 pr " guestfs_free_%s (r);\n" typ;
6146 | RStructList (_, typ) ->
6147 pr " rv = copy_%s_list (r);\n" typ;
6148 pr " guestfs_free_%s_list (r);\n" typ;
6150 pr " rv = copy_table (r);\n";
6151 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6154 pr " rv = caml_alloc_string (size);\n";
6155 pr " memcpy (String_val (rv), r, size);\n";
6158 pr " CAMLreturn (rv);\n";
6162 if List.length params > 5 then (
6163 pr "CAMLprim value\n";
6164 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6166 pr " return ocaml_guestfs_%s (argv[0]" name;
6167 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6174 and generate_ocaml_structure_decls () =
6177 pr "type %s = {\n" typ;
6180 | name, FString -> pr " %s : string;\n" name
6181 | name, FBuffer -> pr " %s : string;\n" name
6182 | name, FUUID -> pr " %s : string;\n" name
6183 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6184 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6185 | name, FChar -> pr " %s : char;\n" name
6186 | name, FOptPercent -> pr " %s : float option;\n" name
6192 and generate_ocaml_prototype ?(is_external = false) name style =
6193 if is_external then pr "external " else pr "val ";
6194 pr "%s : t -> " name;
6197 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6198 | OptString _ -> pr "string option -> "
6199 | StringList _ -> pr "string array -> "
6200 | Bool _ -> pr "bool -> "
6201 | Int _ -> pr "int -> "
6203 (match fst style with
6204 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6205 | RInt _ -> pr "int"
6206 | RInt64 _ -> pr "int64"
6207 | RBool _ -> pr "bool"
6208 | RConstString _ -> pr "string"
6209 | RConstOptString _ -> pr "string option"
6210 | RString _ | RBufferOut _ -> pr "string"
6211 | RStringList _ -> pr "string array"
6212 | RStruct (_, typ) -> pr "%s" typ
6213 | RStructList (_, typ) -> pr "%s array" typ
6214 | RHashtable _ -> pr "(string * string) list"
6216 if is_external then (
6218 if List.length (snd style) + 1 > 5 then
6219 pr "\"ocaml_guestfs_%s_byte\" " name;
6220 pr "\"ocaml_guestfs_%s\"" name
6224 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6225 and generate_perl_xs () =
6226 generate_header CStyle LGPLv2;
6229 #include \"EXTERN.h\"
6233 #include <guestfs.h>
6236 #define PRId64 \"lld\"
6240 my_newSVll(long long val) {
6241 #ifdef USE_64_BIT_ALL
6242 return newSViv(val);
6246 len = snprintf(buf, 100, \"%%\" PRId64, val);
6247 return newSVpv(buf, len);
6252 #define PRIu64 \"llu\"
6256 my_newSVull(unsigned long long val) {
6257 #ifdef USE_64_BIT_ALL
6258 return newSVuv(val);
6262 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6263 return newSVpv(buf, len);
6267 /* http://www.perlmonks.org/?node_id=680842 */
6269 XS_unpack_charPtrPtr (SV *arg) {
6274 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6275 croak (\"array reference expected\");
6277 av = (AV *)SvRV (arg);
6278 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6280 croak (\"malloc failed\");
6282 for (i = 0; i <= av_len (av); i++) {
6283 SV **elem = av_fetch (av, i, 0);
6285 if (!elem || !*elem)
6286 croak (\"missing element in list\");
6288 ret[i] = SvPV_nolen (*elem);
6296 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6303 RETVAL = guestfs_create ();
6305 croak (\"could not create guestfs handle\");
6306 guestfs_set_error_handler (RETVAL, NULL, NULL);
6319 fun (name, style, _, _, _, _, _) ->
6320 (match fst style with
6321 | RErr -> pr "void\n"
6322 | RInt _ -> pr "SV *\n"
6323 | RInt64 _ -> pr "SV *\n"
6324 | RBool _ -> pr "SV *\n"
6325 | RConstString _ -> pr "SV *\n"
6326 | RConstOptString _ -> pr "SV *\n"
6327 | RString _ -> pr "SV *\n"
6328 | RBufferOut _ -> pr "SV *\n"
6330 | RStruct _ | RStructList _
6332 pr "void\n" (* all lists returned implictly on the stack *)
6334 (* Call and arguments. *)
6336 generate_c_call_args ~handle:"g" ~decl:true style;
6338 pr " guestfs_h *g;\n";
6342 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6344 (* http://www.perlmonks.org/?node_id=554277
6345 * Note that the implicit handle argument means we have
6346 * to add 1 to the ST(x) operator.
6348 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6349 | StringList n -> pr " char **%s;\n" n
6350 | Bool n -> pr " int %s;\n" n
6351 | Int n -> pr " int %s;\n" n
6354 let do_cleanups () =
6357 | String _ | OptString _ | Bool _ | Int _
6358 | FileIn _ | FileOut _ -> ()
6359 | StringList n -> pr " free (%s);\n" n
6364 (match fst style with
6369 pr " r = guestfs_%s " name;
6370 generate_c_call_args ~handle:"g" style;
6373 pr " if (r == -1)\n";
6374 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6380 pr " %s = guestfs_%s " n name;
6381 generate_c_call_args ~handle:"g" style;
6384 pr " if (%s == -1)\n" n;
6385 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6386 pr " RETVAL = newSViv (%s);\n" n;
6391 pr " int64_t %s;\n" n;
6393 pr " %s = guestfs_%s " n name;
6394 generate_c_call_args ~handle:"g" style;
6397 pr " if (%s == -1)\n" n;
6398 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6399 pr " RETVAL = my_newSVll (%s);\n" n;
6404 pr " const char *%s;\n" n;
6406 pr " %s = guestfs_%s " n name;
6407 generate_c_call_args ~handle:"g" style;
6410 pr " if (%s == NULL)\n" n;
6411 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6412 pr " RETVAL = newSVpv (%s, 0);\n" n;
6415 | RConstOptString n ->
6417 pr " const char *%s;\n" n;
6419 pr " %s = guestfs_%s " n name;
6420 generate_c_call_args ~handle:"g" style;
6423 pr " if (%s == NULL)\n" n;
6424 pr " RETVAL = &PL_sv_undef;\n";
6426 pr " RETVAL = newSVpv (%s, 0);\n" n;
6431 pr " char *%s;\n" n;
6433 pr " %s = guestfs_%s " n name;
6434 generate_c_call_args ~handle:"g" style;
6437 pr " if (%s == NULL)\n" n;
6438 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6439 pr " RETVAL = newSVpv (%s, 0);\n" n;
6440 pr " free (%s);\n" n;
6443 | RStringList n | RHashtable n ->
6445 pr " char **%s;\n" n;
6448 pr " %s = guestfs_%s " n name;
6449 generate_c_call_args ~handle:"g" style;
6452 pr " if (%s == NULL)\n" n;
6453 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6454 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6455 pr " EXTEND (SP, n);\n";
6456 pr " for (i = 0; i < n; ++i) {\n";
6457 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6458 pr " free (%s[i]);\n" n;
6460 pr " free (%s);\n" n;
6461 | RStruct (n, typ) ->
6462 let cols = cols_of_struct typ in
6463 generate_perl_struct_code typ cols name style n do_cleanups
6464 | RStructList (n, typ) ->
6465 let cols = cols_of_struct typ in
6466 generate_perl_struct_list_code typ cols name style n do_cleanups
6469 pr " char *%s;\n" n;
6470 pr " size_t size;\n";
6472 pr " %s = guestfs_%s " n name;
6473 generate_c_call_args ~handle:"g" style;
6476 pr " if (%s == NULL)\n" n;
6477 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6478 pr " RETVAL = newSVpv (%s, size);\n" n;
6479 pr " free (%s);\n" n;
6487 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6489 pr " struct guestfs_%s_list *%s;\n" typ n;
6493 pr " %s = guestfs_%s " n name;
6494 generate_c_call_args ~handle:"g" style;
6497 pr " if (%s == NULL)\n" n;
6498 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6499 pr " EXTEND (SP, %s->len);\n" n;
6500 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6501 pr " hv = newHV ();\n";
6505 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6506 name (String.length name) n name
6508 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6509 name (String.length name) n name
6511 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6512 name (String.length name) n name n name
6513 | name, (FBytes|FUInt64) ->
6514 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6515 name (String.length name) n name
6517 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6518 name (String.length name) n name
6519 | name, (FInt32|FUInt32) ->
6520 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6521 name (String.length name) n name
6523 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6524 name (String.length name) n name
6525 | name, FOptPercent ->
6526 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6527 name (String.length name) n name
6529 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6531 pr " guestfs_free_%s_list (%s);\n" typ n
6533 and generate_perl_struct_code typ cols name style n do_cleanups =
6535 pr " struct guestfs_%s *%s;\n" typ n;
6537 pr " %s = guestfs_%s " n name;
6538 generate_c_call_args ~handle:"g" style;
6541 pr " if (%s == NULL)\n" n;
6542 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6543 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6545 fun ((name, _) as col) ->
6546 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6550 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6553 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6556 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6558 | name, (FBytes|FUInt64) ->
6559 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6562 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6564 | name, (FInt32|FUInt32) ->
6565 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6568 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6570 | name, FOptPercent ->
6571 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6574 pr " free (%s);\n" n
6576 (* Generate Sys/Guestfs.pm. *)
6577 and generate_perl_pm () =
6578 generate_header HashStyle LGPLv2;
6585 Sys::Guestfs - Perl bindings for libguestfs
6591 my $h = Sys::Guestfs->new ();
6592 $h->add_drive ('guest.img');
6595 $h->mount ('/dev/sda1', '/');
6596 $h->touch ('/hello');
6601 The C<Sys::Guestfs> module provides a Perl XS binding to the
6602 libguestfs API for examining and modifying virtual machine
6605 Amongst the things this is good for: making batch configuration
6606 changes to guests, getting disk used/free statistics (see also:
6607 virt-df), migrating between virtualization systems (see also:
6608 virt-p2v), performing partial backups, performing partial guest
6609 clones, cloning guests and changing registry/UUID/hostname info, and
6612 Libguestfs uses Linux kernel and qemu code, and can access any type of
6613 guest filesystem that Linux and qemu can, including but not limited
6614 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6615 schemes, qcow, qcow2, vmdk.
6617 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6618 LVs, what filesystem is in each LV, etc.). It can also run commands
6619 in the context of the guest. Also you can access filesystems over FTP.
6621 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
6622 functions for using libguestfs from Perl, including integration
6627 All errors turn into calls to C<croak> (see L<Carp(3)>).
6635 package Sys::Guestfs;
6641 XSLoader::load ('Sys::Guestfs');
6643 =item $h = Sys::Guestfs->new ();
6645 Create a new guestfs handle.
6651 my $class = ref ($proto) || $proto;
6653 my $self = Sys::Guestfs::_create ();
6654 bless $self, $class;
6660 (* Actions. We only need to print documentation for these as
6661 * they are pulled in from the XS code automatically.
6664 fun (name, style, _, flags, _, _, longdesc) ->
6665 if not (List.mem NotInDocs flags) then (
6666 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
6668 generate_perl_prototype name style;
6670 pr "%s\n\n" longdesc;
6671 if List.mem ProtocolLimitWarning flags then
6672 pr "%s\n\n" protocol_limit_warning;
6673 if List.mem DangerWillRobinson flags then
6674 pr "%s\n\n" danger_will_robinson;
6675 match deprecation_notice flags with
6677 | Some txt -> pr "%s\n\n" txt
6679 ) all_functions_sorted;
6691 Copyright (C) 2009 Red Hat Inc.
6695 Please see the file COPYING.LIB for the full license.
6701 L<http://libguestfs.org>,
6702 L<Sys::Guestfs::Lib(3)>.
6707 and generate_perl_prototype name style =
6708 (match fst style with
6716 | RBufferOut n -> pr "$%s = " n
6718 | RHashtable n -> pr "%%%s = " n
6720 | RStructList (n,_) -> pr "@%s = " n
6723 let comma = ref false in
6726 if !comma then pr ", ";
6729 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
6736 (* Generate Python C module. *)
6737 and generate_python_c () =
6738 generate_header CStyle LGPLv2;
6747 #include \"guestfs.h\"
6755 get_handle (PyObject *obj)
6758 assert (obj != Py_None);
6759 return ((Pyguestfs_Object *) obj)->g;
6763 put_handle (guestfs_h *g)
6767 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6770 /* This list should be freed (but not the strings) after use. */
6771 static const char **
6772 get_string_list (PyObject *obj)
6779 if (!PyList_Check (obj)) {
6780 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6784 len = PyList_Size (obj);
6785 r = malloc (sizeof (char *) * (len+1));
6787 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6791 for (i = 0; i < len; ++i)
6792 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6799 put_string_list (char * const * const argv)
6804 for (argc = 0; argv[argc] != NULL; ++argc)
6807 list = PyList_New (argc);
6808 for (i = 0; i < argc; ++i)
6809 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6815 put_table (char * const * const argv)
6817 PyObject *list, *item;
6820 for (argc = 0; argv[argc] != NULL; ++argc)
6823 list = PyList_New (argc >> 1);
6824 for (i = 0; i < argc; i += 2) {
6825 item = PyTuple_New (2);
6826 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6827 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6828 PyList_SetItem (list, i >> 1, item);
6835 free_strings (char **argv)
6839 for (argc = 0; argv[argc] != NULL; ++argc)
6845 py_guestfs_create (PyObject *self, PyObject *args)
6849 g = guestfs_create ();
6851 PyErr_SetString (PyExc_RuntimeError,
6852 \"guestfs.create: failed to allocate handle\");
6855 guestfs_set_error_handler (g, NULL, NULL);
6856 return put_handle (g);
6860 py_guestfs_close (PyObject *self, PyObject *args)
6865 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6867 g = get_handle (py_g);
6871 Py_INCREF (Py_None);
6877 (* Structures, turned into Python dictionaries. *)
6880 pr "static PyObject *\n";
6881 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6883 pr " PyObject *dict;\n";
6885 pr " dict = PyDict_New ();\n";
6889 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6890 pr " PyString_FromString (%s->%s));\n"
6893 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6894 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
6897 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6898 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6900 | name, (FBytes|FUInt64) ->
6901 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6902 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
6905 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6906 pr " PyLong_FromLongLong (%s->%s));\n"
6909 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6910 pr " PyLong_FromUnsignedLong (%s->%s));\n"
6913 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6914 pr " PyLong_FromLong (%s->%s));\n"
6916 | name, FOptPercent ->
6917 pr " if (%s->%s >= 0)\n" typ name;
6918 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6919 pr " PyFloat_FromDouble ((double) %s->%s));\n"
6922 pr " Py_INCREF (Py_None);\n";
6923 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6926 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6927 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
6929 pr " return dict;\n";
6933 pr "static PyObject *\n";
6934 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
6936 pr " PyObject *list;\n";
6939 pr " list = PyList_New (%ss->len);\n" typ;
6940 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
6941 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
6942 pr " return list;\n";
6947 (* Python wrapper functions. *)
6949 fun (name, style, _, _, _, _, _) ->
6950 pr "static PyObject *\n";
6951 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6954 pr " PyObject *py_g;\n";
6955 pr " guestfs_h *g;\n";
6956 pr " PyObject *py_r;\n";
6959 match fst style with
6960 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6961 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6962 | RConstString _ | RConstOptString _ ->
6963 pr " const char *r;\n"; "NULL"
6964 | RString _ -> pr " char *r;\n"; "NULL"
6965 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6966 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
6967 | RStructList (_, typ) ->
6968 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6971 pr " size_t size;\n";
6976 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
6977 | OptString n -> pr " const char *%s;\n" n
6979 pr " PyObject *py_%s;\n" n;
6980 pr " const char **%s;\n" n
6981 | Bool n -> pr " int %s;\n" n
6982 | Int n -> pr " int %s;\n" n
6987 (* Convert the parameters. *)
6988 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
6991 | String _ | FileIn _ | FileOut _ -> pr "s"
6992 | OptString _ -> pr "z"
6993 | StringList _ -> pr "O"
6994 | Bool _ -> pr "i" (* XXX Python has booleans? *)
6997 pr ":guestfs_%s\",\n" name;
7001 | String n | FileIn n | FileOut n -> pr ", &%s" n
7002 | OptString n -> pr ", &%s" n
7003 | StringList n -> pr ", &py_%s" n
7004 | Bool n -> pr ", &%s" n
7005 | Int n -> pr ", &%s" n
7009 pr " return NULL;\n";
7011 pr " g = get_handle (py_g);\n";
7014 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7016 pr " %s = get_string_list (py_%s);\n" n n;
7017 pr " if (!%s) return NULL;\n" n
7022 pr " r = guestfs_%s " name;
7023 generate_c_call_args ~handle:"g" style;
7028 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7030 pr " free (%s);\n" n
7033 pr " if (r == %s) {\n" error_code;
7034 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7035 pr " return NULL;\n";
7039 (match fst style with
7041 pr " Py_INCREF (Py_None);\n";
7042 pr " py_r = Py_None;\n"
7044 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7045 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7046 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7047 | RConstOptString _ ->
7049 pr " py_r = PyString_FromString (r);\n";
7051 pr " Py_INCREF (Py_None);\n";
7052 pr " py_r = Py_None;\n";
7055 pr " py_r = PyString_FromString (r);\n";
7058 pr " py_r = put_string_list (r);\n";
7059 pr " free_strings (r);\n"
7060 | RStruct (_, typ) ->
7061 pr " py_r = put_%s (r);\n" typ;
7062 pr " guestfs_free_%s (r);\n" typ
7063 | RStructList (_, typ) ->
7064 pr " py_r = put_%s_list (r);\n" typ;
7065 pr " guestfs_free_%s_list (r);\n" typ
7067 pr " py_r = put_table (r);\n";
7068 pr " free_strings (r);\n"
7070 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7074 pr " return py_r;\n";
7079 (* Table of functions. *)
7080 pr "static PyMethodDef methods[] = {\n";
7081 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7082 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7084 fun (name, _, _, _, _, _, _) ->
7085 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7088 pr " { NULL, NULL, 0, NULL }\n";
7092 (* Init function. *)
7095 initlibguestfsmod (void)
7097 static int initialized = 0;
7099 if (initialized) return;
7100 Py_InitModule ((char *) \"libguestfsmod\", methods);
7105 (* Generate Python module. *)
7106 and generate_python_py () =
7107 generate_header HashStyle LGPLv2;
7110 u\"\"\"Python bindings for libguestfs
7113 g = guestfs.GuestFS ()
7114 g.add_drive (\"guest.img\")
7117 parts = g.list_partitions ()
7119 The guestfs module provides a Python binding to the libguestfs API
7120 for examining and modifying virtual machine disk images.
7122 Amongst the things this is good for: making batch configuration
7123 changes to guests, getting disk used/free statistics (see also:
7124 virt-df), migrating between virtualization systems (see also:
7125 virt-p2v), performing partial backups, performing partial guest
7126 clones, cloning guests and changing registry/UUID/hostname info, and
7129 Libguestfs uses Linux kernel and qemu code, and can access any type of
7130 guest filesystem that Linux and qemu can, including but not limited
7131 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7132 schemes, qcow, qcow2, vmdk.
7134 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7135 LVs, what filesystem is in each LV, etc.). It can also run commands
7136 in the context of the guest. Also you can access filesystems over FTP.
7138 Errors which happen while using the API are turned into Python
7139 RuntimeError exceptions.
7141 To create a guestfs handle you usually have to perform the following
7144 # Create the handle, call add_drive at least once, and possibly
7145 # several times if the guest has multiple block devices:
7146 g = guestfs.GuestFS ()
7147 g.add_drive (\"guest.img\")
7149 # Launch the qemu subprocess and wait for it to become ready:
7153 # Now you can issue commands, for example:
7158 import libguestfsmod
7161 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7163 def __init__ (self):
7164 \"\"\"Create a new libguestfs handle.\"\"\"
7165 self._o = libguestfsmod.create ()
7168 libguestfsmod.close (self._o)
7173 fun (name, style, _, flags, _, _, longdesc) ->
7175 generate_py_call_args ~handle:"self" (snd style);
7178 if not (List.mem NotInDocs flags) then (
7179 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7181 match fst style with
7182 | RErr | RInt _ | RInt64 _ | RBool _
7183 | RConstOptString _ | RConstString _
7184 | RString _ | RBufferOut _ -> doc
7186 doc ^ "\n\nThis function returns a list of strings."
7187 | RStruct (_, typ) ->
7188 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7189 | RStructList (_, typ) ->
7190 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7192 doc ^ "\n\nThis function returns a dictionary." in
7194 if List.mem ProtocolLimitWarning flags then
7195 doc ^ "\n\n" ^ protocol_limit_warning
7198 if List.mem DangerWillRobinson flags then
7199 doc ^ "\n\n" ^ danger_will_robinson
7202 match deprecation_notice flags with
7204 | Some txt -> doc ^ "\n\n" ^ txt in
7205 let doc = pod2text ~width:60 name doc in
7206 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7207 let doc = String.concat "\n " doc in
7208 pr " u\"\"\"%s\"\"\"\n" doc;
7210 pr " return libguestfsmod.%s " name;
7211 generate_py_call_args ~handle:"self._o" (snd style);
7216 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7217 and generate_py_call_args ~handle args =
7219 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7222 (* Useful if you need the longdesc POD text as plain text. Returns a
7225 * Because this is very slow (the slowest part of autogeneration),
7226 * we memoize the results.
7228 and pod2text ~width name longdesc =
7229 let key = width, name, longdesc in
7230 try Hashtbl.find pod2text_memo key
7232 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7233 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7235 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7236 let chan = Unix.open_process_in cmd in
7237 let lines = ref [] in
7239 let line = input_line chan in
7240 if i = 1 then (* discard the first line of output *)
7243 let line = triml line in
7244 lines := line :: !lines;
7247 let lines = try loop 1 with End_of_file -> List.rev !lines in
7248 Unix.unlink filename;
7249 (match Unix.close_process_in chan with
7250 | Unix.WEXITED 0 -> ()
7252 failwithf "pod2text: process exited with non-zero status (%d)" i
7253 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7254 failwithf "pod2text: process signalled or stopped by signal %d" i
7256 Hashtbl.add pod2text_memo key lines;
7257 let chan = open_out pod2text_memo_filename in
7258 output_value chan pod2text_memo;
7262 (* Generate ruby bindings. *)
7263 and generate_ruby_c () =
7264 generate_header CStyle LGPLv2;
7272 #include \"guestfs.h\"
7274 #include \"extconf.h\"
7276 /* For Ruby < 1.9 */
7278 #define RARRAY_LEN(r) (RARRAY((r))->len)
7281 static VALUE m_guestfs; /* guestfs module */
7282 static VALUE c_guestfs; /* guestfs_h handle */
7283 static VALUE e_Error; /* used for all errors */
7285 static void ruby_guestfs_free (void *p)
7288 guestfs_close ((guestfs_h *) p);
7291 static VALUE ruby_guestfs_create (VALUE m)
7295 g = guestfs_create ();
7297 rb_raise (e_Error, \"failed to create guestfs handle\");
7299 /* Don't print error messages to stderr by default. */
7300 guestfs_set_error_handler (g, NULL, NULL);
7302 /* Wrap it, and make sure the close function is called when the
7305 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7308 static VALUE ruby_guestfs_close (VALUE gv)
7311 Data_Get_Struct (gv, guestfs_h, g);
7313 ruby_guestfs_free (g);
7314 DATA_PTR (gv) = NULL;
7322 fun (name, style, _, _, _, _, _) ->
7323 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7324 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7327 pr " guestfs_h *g;\n";
7328 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7330 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7336 | String n | FileIn n | FileOut n ->
7337 pr " Check_Type (%sv, T_STRING);\n" n;
7338 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7340 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7341 pr " \"%s\", \"%s\");\n" n name
7343 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7345 pr " char **%s;\n" n;
7346 pr " Check_Type (%sv, T_ARRAY);\n" n;
7348 pr " int i, len;\n";
7349 pr " len = RARRAY_LEN (%sv);\n" n;
7350 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7352 pr " for (i = 0; i < len; ++i) {\n";
7353 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7354 pr " %s[i] = StringValueCStr (v);\n" n;
7356 pr " %s[len] = NULL;\n" n;
7359 pr " int %s = RTEST (%sv);\n" n n
7361 pr " int %s = NUM2INT (%sv);\n" n n
7366 match fst style with
7367 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7368 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7369 | RConstString _ | RConstOptString _ ->
7370 pr " const char *r;\n"; "NULL"
7371 | RString _ -> pr " char *r;\n"; "NULL"
7372 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7373 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7374 | RStructList (_, typ) ->
7375 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7378 pr " size_t size;\n";
7382 pr " r = guestfs_%s " name;
7383 generate_c_call_args ~handle:"g" style;
7388 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7390 pr " free (%s);\n" n
7393 pr " if (r == %s)\n" error_code;
7394 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7397 (match fst style with
7399 pr " return Qnil;\n"
7400 | RInt _ | RBool _ ->
7401 pr " return INT2NUM (r);\n"
7403 pr " return ULL2NUM (r);\n"
7405 pr " return rb_str_new2 (r);\n";
7406 | RConstOptString _ ->
7408 pr " return rb_str_new2 (r);\n";
7410 pr " return Qnil;\n";
7412 pr " VALUE rv = rb_str_new2 (r);\n";
7416 pr " int i, len = 0;\n";
7417 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7418 pr " VALUE rv = rb_ary_new2 (len);\n";
7419 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7420 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7421 pr " free (r[i]);\n";
7425 | RStruct (_, typ) ->
7426 let cols = cols_of_struct typ in
7427 generate_ruby_struct_code typ cols
7428 | RStructList (_, typ) ->
7429 let cols = cols_of_struct typ in
7430 generate_ruby_struct_list_code typ cols
7432 pr " VALUE rv = rb_hash_new ();\n";
7434 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7435 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7436 pr " free (r[i]);\n";
7437 pr " free (r[i+1]);\n";
7442 pr " VALUE rv = rb_str_new (r, size);\n";
7452 /* Initialize the module. */
7453 void Init__guestfs ()
7455 m_guestfs = rb_define_module (\"Guestfs\");
7456 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7457 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7459 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7460 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7463 (* Define the rest of the methods. *)
7465 fun (name, style, _, _, _, _, _) ->
7466 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7467 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7472 (* Ruby code to return a struct. *)
7473 and generate_ruby_struct_code typ cols =
7474 pr " VALUE rv = rb_hash_new ();\n";
7478 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7480 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7482 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7483 | name, (FBytes|FUInt64) ->
7484 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7486 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7488 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7490 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7491 | name, FOptPercent ->
7492 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7493 | name, FChar -> (* XXX wrong? *)
7494 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7496 pr " guestfs_free_%s (r);\n" typ;
7499 (* Ruby code to return a struct list. *)
7500 and generate_ruby_struct_list_code typ cols =
7501 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7503 pr " for (i = 0; i < r->len; ++i) {\n";
7504 pr " VALUE hv = rb_hash_new ();\n";
7508 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7510 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
7512 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7513 | name, (FBytes|FUInt64) ->
7514 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7516 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7518 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7520 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7521 | name, FOptPercent ->
7522 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7523 | name, FChar -> (* XXX wrong? *)
7524 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7526 pr " rb_ary_push (rv, hv);\n";
7528 pr " guestfs_free_%s_list (r);\n" typ;
7531 (* Generate Java bindings GuestFS.java file. *)
7532 and generate_java_java () =
7533 generate_header CStyle LGPLv2;
7536 package com.redhat.et.libguestfs;
7538 import java.util.HashMap;
7539 import com.redhat.et.libguestfs.LibGuestFSException;
7540 import com.redhat.et.libguestfs.PV;
7541 import com.redhat.et.libguestfs.VG;
7542 import com.redhat.et.libguestfs.LV;
7543 import com.redhat.et.libguestfs.Stat;
7544 import com.redhat.et.libguestfs.StatVFS;
7545 import com.redhat.et.libguestfs.IntBool;
7546 import com.redhat.et.libguestfs.Dirent;
7549 * The GuestFS object is a libguestfs handle.
7553 public class GuestFS {
7554 // Load the native code.
7556 System.loadLibrary (\"guestfs_jni\");
7560 * The native guestfs_h pointer.
7565 * Create a libguestfs handle.
7567 * @throws LibGuestFSException
7569 public GuestFS () throws LibGuestFSException
7573 private native long _create () throws LibGuestFSException;
7576 * Close a libguestfs handle.
7578 * You can also leave handles to be collected by the garbage
7579 * collector, but this method ensures that the resources used
7580 * by the handle are freed up immediately. If you call any
7581 * other methods after closing the handle, you will get an
7584 * @throws LibGuestFSException
7586 public void close () throws LibGuestFSException
7592 private native void _close (long g) throws LibGuestFSException;
7594 public void finalize () throws LibGuestFSException
7602 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7603 if not (List.mem NotInDocs flags); then (
7604 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7606 if List.mem ProtocolLimitWarning flags then
7607 doc ^ "\n\n" ^ protocol_limit_warning
7610 if List.mem DangerWillRobinson flags then
7611 doc ^ "\n\n" ^ danger_will_robinson
7614 match deprecation_notice flags with
7616 | Some txt -> doc ^ "\n\n" ^ txt in
7617 let doc = pod2text ~width:60 name doc in
7618 let doc = List.map ( (* RHBZ#501883 *)
7621 | nonempty -> nonempty
7623 let doc = String.concat "\n * " doc in
7626 pr " * %s\n" shortdesc;
7629 pr " * @throws LibGuestFSException\n";
7633 generate_java_prototype ~public:true ~semicolon:false name style;
7636 pr " if (g == 0)\n";
7637 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
7640 if fst style <> RErr then pr "return ";
7642 generate_java_call_args ~handle:"g" (snd style);
7646 generate_java_prototype ~privat:true ~native:true name style;
7653 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
7654 and generate_java_call_args ~handle args =
7656 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7659 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
7660 ?(semicolon=true) name style =
7661 if privat then pr "private ";
7662 if public then pr "public ";
7663 if native then pr "native ";
7666 (match fst style with
7667 | RErr -> pr "void ";
7668 | RInt _ -> pr "int ";
7669 | RInt64 _ -> pr "long ";
7670 | RBool _ -> pr "boolean ";
7671 | RConstString _ | RConstOptString _ | RString _
7672 | RBufferOut _ -> pr "String ";
7673 | RStringList _ -> pr "String[] ";
7674 | RStruct (_, typ) ->
7675 let name = java_name_of_struct typ in
7677 | RStructList (_, typ) ->
7678 let name = java_name_of_struct typ in
7680 | RHashtable _ -> pr "HashMap<String,String> ";
7683 if native then pr "_%s " name else pr "%s " name;
7685 let needs_comma = ref false in
7694 if !needs_comma then pr ", ";
7695 needs_comma := true;
7712 pr " throws LibGuestFSException";
7713 if semicolon then pr ";"
7715 and generate_java_struct jtyp cols =
7716 generate_header CStyle LGPLv2;
7719 package com.redhat.et.libguestfs;
7722 * Libguestfs %s structure.
7734 | name, FBuffer -> pr " public String %s;\n" name
7735 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
7736 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
7737 | name, FChar -> pr " public char %s;\n" name
7738 | name, FOptPercent ->
7739 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
7740 pr " public float %s;\n" name
7745 and generate_java_c () =
7746 generate_header CStyle LGPLv2;
7753 #include \"com_redhat_et_libguestfs_GuestFS.h\"
7754 #include \"guestfs.h\"
7756 /* Note that this function returns. The exception is not thrown
7757 * until after the wrapper function returns.
7760 throw_exception (JNIEnv *env, const char *msg)
7763 cl = (*env)->FindClass (env,
7764 \"com/redhat/et/libguestfs/LibGuestFSException\");
7765 (*env)->ThrowNew (env, cl, msg);
7768 JNIEXPORT jlong JNICALL
7769 Java_com_redhat_et_libguestfs_GuestFS__1create
7770 (JNIEnv *env, jobject obj)
7774 g = guestfs_create ();
7776 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
7779 guestfs_set_error_handler (g, NULL, NULL);
7780 return (jlong) (long) g;
7783 JNIEXPORT void JNICALL
7784 Java_com_redhat_et_libguestfs_GuestFS__1close
7785 (JNIEnv *env, jobject obj, jlong jg)
7787 guestfs_h *g = (guestfs_h *) (long) jg;
7794 fun (name, style, _, _, _, _, _) ->
7796 (match fst style with
7797 | RErr -> pr "void ";
7798 | RInt _ -> pr "jint ";
7799 | RInt64 _ -> pr "jlong ";
7800 | RBool _ -> pr "jboolean ";
7801 | RConstString _ | RConstOptString _ | RString _
7802 | RBufferOut _ -> pr "jstring ";
7803 | RStruct _ | RHashtable _ ->
7805 | RStringList _ | RStructList _ ->
7809 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7810 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7812 pr " (JNIEnv *env, jobject obj, jlong jg";
7819 pr ", jstring j%s" n
7821 pr ", jobjectArray j%s" n
7823 pr ", jboolean j%s" n
7829 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7830 let error_code, no_ret =
7831 match fst style with
7832 | RErr -> pr " int r;\n"; "-1", ""
7834 | RInt _ -> pr " int r;\n"; "-1", "0"
7835 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7836 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7837 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
7839 pr " jstring jr;\n";
7840 pr " char *r;\n"; "NULL", "NULL"
7842 pr " jobjectArray jr;\n";
7845 pr " jstring jstr;\n";
7846 pr " char **r;\n"; "NULL", "NULL"
7847 | RStruct (_, typ) ->
7848 pr " jobject jr;\n";
7850 pr " jfieldID fl;\n";
7851 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
7852 | RStructList (_, typ) ->
7853 pr " jobjectArray jr;\n";
7855 pr " jfieldID fl;\n";
7856 pr " jobject jfl;\n";
7857 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
7858 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
7860 pr " jstring jr;\n";
7862 pr " size_t size;\n";
7870 pr " const char *%s;\n" n
7872 pr " int %s_len;\n" n;
7873 pr " const char **%s;\n" n
7880 (match fst style with
7881 | RStringList _ | RStructList _ -> true
7882 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7884 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
7885 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7891 (* Get the parameters. *)
7897 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7899 (* This is completely undocumented, but Java null becomes
7902 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
7904 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
7905 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
7906 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7907 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7909 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
7911 pr " %s[%s_len] = NULL;\n" n n;
7914 pr " %s = j%s;\n" n n
7917 (* Make the call. *)
7918 pr " r = guestfs_%s " name;
7919 generate_c_call_args ~handle:"g" style;
7922 (* Release the parameters. *)
7928 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7931 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7933 pr " for (i = 0; i < %s_len; ++i) {\n" n;
7934 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7936 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7938 pr " free (%s);\n" n
7943 (* Check for errors. *)
7944 pr " if (r == %s) {\n" error_code;
7945 pr " throw_exception (env, guestfs_last_error (g));\n";
7946 pr " return %s;\n" no_ret;
7950 (match fst style with
7952 | RInt _ -> pr " return (jint) r;\n"
7953 | RBool _ -> pr " return (jboolean) r;\n"
7954 | RInt64 _ -> pr " return (jlong) r;\n"
7955 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
7956 | RConstOptString _ ->
7957 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
7959 pr " jr = (*env)->NewStringUTF (env, r);\n";
7963 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7964 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7965 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
7966 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7967 pr " for (i = 0; i < r_len; ++i) {\n";
7968 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
7969 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7970 pr " free (r[i]);\n";
7974 | RStruct (_, typ) ->
7975 let jtyp = java_name_of_struct typ in
7976 let cols = cols_of_struct typ in
7977 generate_java_struct_return typ jtyp cols
7978 | RStructList (_, typ) ->
7979 let jtyp = java_name_of_struct typ in
7980 let cols = cols_of_struct typ in
7981 generate_java_struct_list_return typ jtyp cols
7984 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7985 pr " return NULL;\n"
7987 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
7996 and generate_java_struct_return typ jtyp cols =
7997 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7998 pr " jr = (*env)->AllocObject (env, cl);\n";
8002 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8003 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
8006 pr " char s[33];\n";
8007 pr " memcpy (s, r->%s, 32);\n" name;
8009 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8010 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8014 pr " int len = r->%s_len;\n" name;
8015 pr " char s[len+1];\n";
8016 pr " memcpy (s, r->%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, jr, 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, jr, fl, r->%s);\n" name;
8024 | name, (FUInt32|FInt32) ->
8025 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8026 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8027 | name, FOptPercent ->
8028 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8029 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
8031 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8032 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8037 and generate_java_struct_list_return typ jtyp cols =
8038 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8039 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
8040 pr " for (i = 0; i < r->len; ++i) {\n";
8041 pr " jfl = (*env)->AllocObject (env, cl);\n";
8045 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8046 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8049 pr " char s[33];\n";
8050 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8052 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8053 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8057 pr " int len = r->val[i].%s_len;\n" name;
8058 pr " char s[len+1];\n";
8059 pr " memcpy (s, r->val[i].%s, len);\n" name;
8060 pr " s[len] = 0;\n";
8061 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8062 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8064 | name, (FBytes|FUInt64|FInt64) ->
8065 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8066 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8067 | name, (FUInt32|FInt32) ->
8068 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8069 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8070 | name, FOptPercent ->
8071 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8072 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8074 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8075 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8077 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8079 pr " guestfs_free_%s_list (r);\n" typ;
8082 and generate_haskell_hs () =
8083 generate_header HaskellStyle LGPLv2;
8085 (* XXX We only know how to generate partial FFI for Haskell
8086 * at the moment. Please help out!
8088 let can_generate style =
8092 | RInt64 _, _ -> true
8095 | RConstOptString _, _
8101 | RBufferOut _, _ -> false in
8104 {-# INCLUDE <guestfs.h> #-}
8105 {-# LANGUAGE ForeignFunctionInterface #-}
8110 (* List out the names of the actions we want to export. *)
8112 fun (name, style, _, _, _, _, _) ->
8113 if can_generate style then pr ",\n %s" name
8120 import Foreign.C.Types
8122 import Control.Exception
8123 import Data.Typeable
8125 data GuestfsS = GuestfsS -- represents the opaque C struct
8126 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8127 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8129 -- XXX define properly later XXX
8133 data IntBool = IntBool
8135 data StatVFS = StatVFS
8136 data Hashtable = Hashtable
8138 foreign import ccall unsafe \"guestfs_create\" c_create
8140 foreign import ccall unsafe \"&guestfs_close\" c_close
8141 :: FunPtr (GuestfsP -> IO ())
8142 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8143 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8145 create :: IO GuestfsH
8148 c_set_error_handler p nullPtr nullPtr
8149 h <- newForeignPtr c_close p
8152 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8153 :: GuestfsP -> IO CString
8155 -- last_error :: GuestfsH -> IO (Maybe String)
8156 -- last_error h = do
8157 -- str <- withForeignPtr h (\\p -> c_last_error p)
8158 -- maybePeek peekCString str
8160 last_error :: GuestfsH -> IO (String)
8162 str <- withForeignPtr h (\\p -> c_last_error p)
8164 then return \"no error\"
8165 else peekCString str
8169 (* Generate wrappers for each foreign function. *)
8171 fun (name, style, _, _, _, _, _) ->
8172 if can_generate style then (
8173 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8175 generate_haskell_prototype ~handle:"GuestfsP" style;
8179 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8181 pr "%s %s = do\n" name
8182 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8184 (* Convert pointer arguments using with* functions. *)
8189 | String n -> pr "withCString %s $ \\%s -> " n n
8190 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8191 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8192 | Bool _ | Int _ -> ()
8194 (* Convert integer arguments. *)
8198 | Bool n -> sprintf "(fromBool %s)" n
8199 | Int n -> sprintf "(fromIntegral %s)" n
8200 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8202 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8203 (String.concat " " ("p" :: args));
8204 (match fst style with
8205 | RErr | RInt _ | RInt64 _ | RBool _ ->
8206 pr " if (r == -1)\n";
8208 pr " err <- last_error h\n";
8210 | RConstString _ | RConstOptString _ | RString _
8211 | RStringList _ | RStruct _
8212 | RStructList _ | RHashtable _ | RBufferOut _ ->
8213 pr " if (r == nullPtr)\n";
8215 pr " err <- last_error h\n";
8218 (match fst style with
8220 pr " else return ()\n"
8222 pr " else return (fromIntegral r)\n"
8224 pr " else return (fromIntegral r)\n"
8226 pr " else return (toBool r)\n"
8235 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8241 and generate_haskell_prototype ~handle ?(hs = false) style =
8243 let string = if hs then "String" else "CString" in
8244 let int = if hs then "Int" else "CInt" in
8245 let bool = if hs then "Bool" else "CInt" in
8246 let int64 = if hs then "Integer" else "Int64" in
8250 | String _ -> pr "%s" string
8251 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8252 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8253 | Bool _ -> pr "%s" bool
8254 | Int _ -> pr "%s" int
8255 | FileIn _ -> pr "%s" string
8256 | FileOut _ -> pr "%s" string
8261 (match fst style with
8262 | RErr -> if not hs then pr "CInt"
8263 | RInt _ -> pr "%s" int
8264 | RInt64 _ -> pr "%s" int64
8265 | RBool _ -> pr "%s" bool
8266 | RConstString _ -> pr "%s" string
8267 | RConstOptString _ -> pr "Maybe %s" string
8268 | RString _ -> pr "%s" string
8269 | RStringList _ -> pr "[%s]" string
8270 | RStruct (_, typ) ->
8271 let name = java_name_of_struct typ in
8273 | RStructList (_, typ) ->
8274 let name = java_name_of_struct typ in
8276 | RHashtable _ -> pr "Hashtable"
8277 | RBufferOut _ -> pr "%s" string
8281 and generate_bindtests () =
8282 generate_header CStyle LGPLv2;
8287 #include <inttypes.h>
8290 #include \"guestfs.h\"
8291 #include \"guestfs_protocol.h\"
8293 #define error guestfs_error
8294 #define safe_calloc guestfs_safe_calloc
8295 #define safe_malloc guestfs_safe_malloc
8298 print_strings (char * const* const argv)
8303 for (argc = 0; argv[argc] != NULL; ++argc) {
8304 if (argc > 0) printf (\", \");
8305 printf (\"\\\"%%s\\\"\", argv[argc]);
8310 /* The test0 function prints its parameters to stdout. */
8314 match test_functions with
8315 | [] -> assert false
8316 | test0 :: tests -> test0, tests in
8319 let (name, style, _, _, _, _, _) = test0 in
8320 generate_prototype ~extern:false ~semicolon:false ~newline:true
8321 ~handle:"g" ~prefix:"guestfs_" name style;
8327 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8328 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8329 | StringList n -> pr " print_strings (%s);\n" n
8330 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8331 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8333 pr " /* Java changes stdout line buffering so we need this: */\n";
8334 pr " fflush (stdout);\n";
8340 fun (name, style, _, _, _, _, _) ->
8341 if String.sub name (String.length name - 3) 3 <> "err" then (
8342 pr "/* Test normal return. */\n";
8343 generate_prototype ~extern:false ~semicolon:false ~newline:true
8344 ~handle:"g" ~prefix:"guestfs_" name style;
8346 (match fst style with
8351 pr " sscanf (val, \"%%d\", &r);\n";
8355 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8358 pr " return strcmp (val, \"true\") == 0;\n"
8360 | RConstOptString _ ->
8361 (* Can't return the input string here. Return a static
8362 * string so we ensure we get a segfault if the caller
8365 pr " return \"static string\";\n"
8367 pr " return strdup (val);\n"
8369 pr " char **strs;\n";
8371 pr " sscanf (val, \"%%d\", &n);\n";
8372 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8373 pr " for (i = 0; i < n; ++i) {\n";
8374 pr " strs[i] = safe_malloc (g, 16);\n";
8375 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8377 pr " strs[n] = NULL;\n";
8378 pr " return strs;\n"
8379 | RStruct (_, typ) ->
8380 pr " struct guestfs_%s *r;\n" typ;
8381 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8383 | RStructList (_, typ) ->
8384 pr " struct guestfs_%s_list *r;\n" typ;
8385 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8386 pr " sscanf (val, \"%%d\", &r->len);\n";
8387 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8390 pr " char **strs;\n";
8392 pr " sscanf (val, \"%%d\", &n);\n";
8393 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8394 pr " for (i = 0; i < n; ++i) {\n";
8395 pr " strs[i*2] = safe_malloc (g, 16);\n";
8396 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8397 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8398 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8400 pr " strs[n*2] = NULL;\n";
8401 pr " return strs;\n"
8403 pr " return strdup (val);\n"
8408 pr "/* Test error return. */\n";
8409 generate_prototype ~extern:false ~semicolon:false ~newline:true
8410 ~handle:"g" ~prefix:"guestfs_" name style;
8412 pr " error (g, \"error\");\n";
8413 (match fst style with
8414 | RErr | RInt _ | RInt64 _ | RBool _ ->
8416 | RConstString _ | RConstOptString _
8417 | RString _ | RStringList _ | RStruct _
8421 pr " return NULL;\n"
8428 and generate_ocaml_bindtests () =
8429 generate_header OCamlStyle GPLv2;
8433 let g = Guestfs.create () in
8440 | CallString s -> "\"" ^ s ^ "\""
8441 | CallOptString None -> "None"
8442 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8443 | CallStringList xs ->
8444 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8445 | CallInt i when i >= 0 -> string_of_int i
8446 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8447 | CallBool b -> string_of_bool b
8452 generate_lang_bindtests (
8453 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8456 pr "print_endline \"EOF\"\n"
8458 and generate_perl_bindtests () =
8459 pr "#!/usr/bin/perl -w\n";
8460 generate_header HashStyle GPLv2;
8467 my $g = Sys::Guestfs->new ();
8471 String.concat ", " (
8474 | CallString s -> "\"" ^ s ^ "\""
8475 | CallOptString None -> "undef"
8476 | CallOptString (Some s) -> sprintf "\"%s\"" s
8477 | CallStringList xs ->
8478 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8479 | CallInt i -> string_of_int i
8480 | CallBool b -> if b then "1" else "0"
8485 generate_lang_bindtests (
8486 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8489 pr "print \"EOF\\n\"\n"
8491 and generate_python_bindtests () =
8492 generate_header HashStyle GPLv2;
8497 g = guestfs.GuestFS ()
8501 String.concat ", " (
8504 | CallString s -> "\"" ^ s ^ "\""
8505 | CallOptString None -> "None"
8506 | CallOptString (Some s) -> sprintf "\"%s\"" s
8507 | CallStringList xs ->
8508 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8509 | CallInt i -> string_of_int i
8510 | CallBool b -> if b then "1" else "0"
8515 generate_lang_bindtests (
8516 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8519 pr "print \"EOF\"\n"
8521 and generate_ruby_bindtests () =
8522 generate_header HashStyle GPLv2;
8527 g = Guestfs::create()
8531 String.concat ", " (
8534 | CallString s -> "\"" ^ s ^ "\""
8535 | CallOptString None -> "nil"
8536 | CallOptString (Some s) -> sprintf "\"%s\"" s
8537 | CallStringList xs ->
8538 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8539 | CallInt i -> string_of_int i
8540 | CallBool b -> string_of_bool b
8545 generate_lang_bindtests (
8546 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8549 pr "print \"EOF\\n\"\n"
8551 and generate_java_bindtests () =
8552 generate_header CStyle GPLv2;
8555 import com.redhat.et.libguestfs.*;
8557 public class Bindtests {
8558 public static void main (String[] argv)
8561 GuestFS g = new GuestFS ();
8565 String.concat ", " (
8568 | CallString s -> "\"" ^ s ^ "\""
8569 | CallOptString None -> "null"
8570 | CallOptString (Some s) -> sprintf "\"%s\"" s
8571 | CallStringList xs ->
8573 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8574 | CallInt i -> string_of_int i
8575 | CallBool b -> string_of_bool b
8580 generate_lang_bindtests (
8581 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8585 System.out.println (\"EOF\");
8587 catch (Exception exn) {
8588 System.err.println (exn);
8595 and generate_haskell_bindtests () =
8596 generate_header HaskellStyle GPLv2;
8599 module Bindtests where
8600 import qualified Guestfs
8610 | CallString s -> "\"" ^ s ^ "\""
8611 | CallOptString None -> "Nothing"
8612 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
8613 | CallStringList xs ->
8614 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8615 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
8616 | CallInt i -> string_of_int i
8617 | CallBool true -> "True"
8618 | CallBool false -> "False"
8623 generate_lang_bindtests (
8624 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
8627 pr " putStrLn \"EOF\"\n"
8629 (* Language-independent bindings tests - we do it this way to
8630 * ensure there is parity in testing bindings across all languages.
8632 and generate_lang_bindtests call =
8633 call "test0" [CallString "abc"; CallOptString (Some "def");
8634 CallStringList []; CallBool false;
8635 CallInt 0; CallString "123"; CallString "456"];
8636 call "test0" [CallString "abc"; CallOptString None;
8637 CallStringList []; CallBool false;
8638 CallInt 0; CallString "123"; CallString "456"];
8639 call "test0" [CallString ""; CallOptString (Some "def");
8640 CallStringList []; CallBool false;
8641 CallInt 0; CallString "123"; CallString "456"];
8642 call "test0" [CallString ""; CallOptString (Some "");
8643 CallStringList []; CallBool false;
8644 CallInt 0; CallString "123"; CallString "456"];
8645 call "test0" [CallString "abc"; CallOptString (Some "def");
8646 CallStringList ["1"]; CallBool false;
8647 CallInt 0; CallString "123"; CallString "456"];
8648 call "test0" [CallString "abc"; CallOptString (Some "def");
8649 CallStringList ["1"; "2"]; CallBool false;
8650 CallInt 0; CallString "123"; CallString "456"];
8651 call "test0" [CallString "abc"; CallOptString (Some "def");
8652 CallStringList ["1"]; CallBool true;
8653 CallInt 0; CallString "123"; CallString "456"];
8654 call "test0" [CallString "abc"; CallOptString (Some "def");
8655 CallStringList ["1"]; CallBool false;
8656 CallInt (-1); CallString "123"; CallString "456"];
8657 call "test0" [CallString "abc"; CallOptString (Some "def");
8658 CallStringList ["1"]; CallBool false;
8659 CallInt (-2); CallString "123"; CallString "456"];
8660 call "test0" [CallString "abc"; CallOptString (Some "def");
8661 CallStringList ["1"]; CallBool false;
8662 CallInt 1; CallString "123"; CallString "456"];
8663 call "test0" [CallString "abc"; CallOptString (Some "def");
8664 CallStringList ["1"]; CallBool false;
8665 CallInt 2; CallString "123"; CallString "456"];
8666 call "test0" [CallString "abc"; CallOptString (Some "def");
8667 CallStringList ["1"]; CallBool false;
8668 CallInt 4095; CallString "123"; CallString "456"];
8669 call "test0" [CallString "abc"; CallOptString (Some "def");
8670 CallStringList ["1"]; CallBool false;
8671 CallInt 0; CallString ""; CallString ""]
8673 (* XXX Add here tests of the return and error functions. *)
8675 (* This is used to generate the src/MAX_PROC_NR file which
8676 * contains the maximum procedure number, a surrogate for the
8677 * ABI version number. See src/Makefile.am for the details.
8679 and generate_max_proc_nr () =
8680 let proc_nrs = List.map (
8681 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
8682 ) daemon_functions in
8684 let max_proc_nr = List.fold_left max 0 proc_nrs in
8686 pr "%d\n" max_proc_nr
8688 let output_to filename =
8689 let filename_new = filename ^ ".new" in
8690 chan := open_out filename_new;
8695 (* Is the new file different from the current file? *)
8696 if Sys.file_exists filename && files_equal filename filename_new then
8697 Unix.unlink filename_new (* same, so skip it *)
8699 (* different, overwrite old one *)
8700 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
8701 Unix.rename filename_new filename;
8702 Unix.chmod filename 0o444;
8703 printf "written %s\n%!" filename;
8712 if not (Sys.file_exists "HACKING") then (
8714 You are probably running this from the wrong directory.
8715 Run it from the top source directory using the command
8721 let close = output_to "src/guestfs_protocol.x" in
8725 let close = output_to "src/guestfs-structs.h" in
8726 generate_structs_h ();
8729 let close = output_to "src/guestfs-actions.h" in
8730 generate_actions_h ();
8733 let close = output_to "src/guestfs-actions.c" in
8734 generate_client_actions ();
8737 let close = output_to "daemon/actions.h" in
8738 generate_daemon_actions_h ();
8741 let close = output_to "daemon/stubs.c" in
8742 generate_daemon_actions ();
8745 let close = output_to "daemon/names.c" in
8746 generate_daemon_names ();
8749 let close = output_to "capitests/tests.c" in
8753 let close = output_to "src/guestfs-bindtests.c" in
8754 generate_bindtests ();
8757 let close = output_to "fish/cmds.c" in
8758 generate_fish_cmds ();
8761 let close = output_to "fish/completion.c" in
8762 generate_fish_completion ();
8765 let close = output_to "guestfs-structs.pod" in
8766 generate_structs_pod ();
8769 let close = output_to "guestfs-actions.pod" in
8770 generate_actions_pod ();
8773 let close = output_to "guestfish-actions.pod" in
8774 generate_fish_actions_pod ();
8777 let close = output_to "ocaml/guestfs.mli" in
8778 generate_ocaml_mli ();
8781 let close = output_to "ocaml/guestfs.ml" in
8782 generate_ocaml_ml ();
8785 let close = output_to "ocaml/guestfs_c_actions.c" in
8786 generate_ocaml_c ();
8789 let close = output_to "ocaml/bindtests.ml" in
8790 generate_ocaml_bindtests ();
8793 let close = output_to "perl/Guestfs.xs" in
8794 generate_perl_xs ();
8797 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8798 generate_perl_pm ();
8801 let close = output_to "perl/bindtests.pl" in
8802 generate_perl_bindtests ();
8805 let close = output_to "python/guestfs-py.c" in
8806 generate_python_c ();
8809 let close = output_to "python/guestfs.py" in
8810 generate_python_py ();
8813 let close = output_to "python/bindtests.py" in
8814 generate_python_bindtests ();
8817 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8821 let close = output_to "ruby/bindtests.rb" in
8822 generate_ruby_bindtests ();
8825 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8826 generate_java_java ();
8831 let cols = cols_of_struct typ in
8832 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
8833 let close = output_to filename in
8834 generate_java_struct jtyp cols;
8838 let close = output_to "java/Makefile.inc" in
8839 pr "java_built_sources =";
8842 pr " com/redhat/et/libguestfs/%s.java" jtyp;
8844 pr " com/redhat/et/libguestfs/GuestFS.java\n";
8847 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8851 let close = output_to "java/Bindtests.java" in
8852 generate_java_bindtests ();
8855 let close = output_to "haskell/Guestfs.hs" in
8856 generate_haskell_hs ();
8859 let close = output_to "haskell/Bindtests.hs" in
8860 generate_haskell_bindtests ();
8863 let close = output_to "src/MAX_PROC_NR" in
8864 generate_max_proc_nr ();
8867 (* Always generate this file last, and unconditionally. It's used
8868 * by the Makefile to know when we must re-run the generator.
8870 let chan = open_out "src/stamp-generator" in