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.");
3049 ("grep", (RStringList "lines", [String "regex"; String "path"]), 151, [ProtocolLimitWarning],
3050 [InitSquashFS, Always, TestOutputList (
3051 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3052 InitSquashFS, Always, TestOutputList (
3053 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3054 "return lines matching a pattern",
3056 This calls the external C<grep> program and returns the
3059 ("egrep", (RStringList "lines", [String "regex"; String "path"]), 152, [ProtocolLimitWarning],
3060 [InitSquashFS, Always, TestOutputList (
3061 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3062 "return lines matching a pattern",
3064 This calls the external C<egrep> program and returns the
3067 ("fgrep", (RStringList "lines", [String "pattern"; String "path"]), 153, [ProtocolLimitWarning],
3068 [InitSquashFS, Always, TestOutputList (
3069 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3070 "return lines matching a pattern",
3072 This calls the external C<fgrep> program and returns the
3075 ("grepi", (RStringList "lines", [String "regex"; String "path"]), 154, [ProtocolLimitWarning],
3076 [InitSquashFS, Always, TestOutputList (
3077 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3078 "return lines matching a pattern",
3080 This calls the external C<grep -i> program and returns the
3083 ("egrepi", (RStringList "lines", [String "regex"; String "path"]), 155, [ProtocolLimitWarning],
3084 [InitSquashFS, Always, TestOutputList (
3085 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3086 "return lines matching a pattern",
3088 This calls the external C<egrep -i> program and returns the
3091 ("fgrepi", (RStringList "lines", [String "pattern"; String "path"]), 156, [ProtocolLimitWarning],
3092 [InitSquashFS, Always, TestOutputList (
3093 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3094 "return lines matching a pattern",
3096 This calls the external C<fgrep -i> program and returns the
3099 ("zgrep", (RStringList "lines", [String "regex"; String "path"]), 157, [ProtocolLimitWarning],
3100 [InitSquashFS, Always, TestOutputList (
3101 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3102 "return lines matching a pattern",
3104 This calls the external C<zgrep> program and returns the
3107 ("zegrep", (RStringList "lines", [String "regex"; String "path"]), 158, [ProtocolLimitWarning],
3108 [InitSquashFS, Always, TestOutputList (
3109 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3110 "return lines matching a pattern",
3112 This calls the external C<zegrep> program and returns the
3115 ("zfgrep", (RStringList "lines", [String "pattern"; String "path"]), 159, [ProtocolLimitWarning],
3116 [InitSquashFS, Always, TestOutputList (
3117 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3118 "return lines matching a pattern",
3120 This calls the external C<zfgrep> program and returns the
3123 ("zgrepi", (RStringList "lines", [String "regex"; String "path"]), 160, [ProtocolLimitWarning],
3124 [InitSquashFS, Always, TestOutputList (
3125 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3126 "return lines matching a pattern",
3128 This calls the external C<zgrep -i> program and returns the
3131 ("zegrepi", (RStringList "lines", [String "regex"; String "path"]), 161, [ProtocolLimitWarning],
3132 [InitSquashFS, Always, TestOutputList (
3133 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3134 "return lines matching a pattern",
3136 This calls the external C<zegrep -i> program and returns the
3139 ("zfgrepi", (RStringList "lines", [String "pattern"; String "path"]), 162, [ProtocolLimitWarning],
3140 [InitSquashFS, Always, TestOutputList (
3141 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3142 "return lines matching a pattern",
3144 This calls the external C<zfgrep -i> program and returns the
3149 let all_functions = non_daemon_functions @ daemon_functions
3151 (* In some places we want the functions to be displayed sorted
3152 * alphabetically, so this is useful:
3154 let all_functions_sorted =
3155 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3156 compare n1 n2) all_functions
3158 (* Field types for structures. *)
3160 | FChar (* C 'char' (really, a 7 bit byte). *)
3161 | FString (* nul-terminated ASCII string. *)
3162 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3167 | FBytes (* Any int measure that counts bytes. *)
3168 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3169 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3171 (* Because we generate extra parsing code for LVM command line tools,
3172 * we have to pull out the LVM columns separately here.
3182 "pv_attr", FString (* XXX *);
3183 "pv_pe_count", FInt64;
3184 "pv_pe_alloc_count", FInt64;
3187 "pv_mda_count", FInt64;
3188 "pv_mda_free", FBytes;
3189 (* Not in Fedora 10:
3190 "pv_mda_size", FBytes;
3197 "vg_attr", FString (* XXX *);
3200 "vg_sysid", FString;
3201 "vg_extent_size", FBytes;
3202 "vg_extent_count", FInt64;
3203 "vg_free_count", FInt64;
3208 "snap_count", FInt64;
3211 "vg_mda_count", FInt64;
3212 "vg_mda_free", FBytes;
3213 (* Not in Fedora 10:
3214 "vg_mda_size", FBytes;
3220 "lv_attr", FString (* XXX *);
3223 "lv_kernel_major", FInt64;
3224 "lv_kernel_minor", FInt64;
3226 "seg_count", FInt64;
3228 "snap_percent", FOptPercent;
3229 "copy_percent", FOptPercent;
3232 "mirror_log", FString;
3236 (* Names and fields in all structures (in RStruct and RStructList)
3240 (* The old RIntBool return type, only ever used for aug_defnode. Do
3241 * not use this struct in any new code.
3244 "i", FInt32; (* for historical compatibility *)
3245 "b", FInt32; (* for historical compatibility *)
3248 (* LVM PVs, VGs, LVs. *)
3249 "lvm_pv", lvm_pv_cols;
3250 "lvm_vg", lvm_vg_cols;
3251 "lvm_lv", lvm_lv_cols;
3253 (* Column names and types from stat structures.
3254 * NB. Can't use things like 'st_atime' because glibc header files
3255 * define some of these as macros. Ugh.
3286 (* Column names in dirent structure. *)
3289 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3294 (* Version numbers. *)
3302 (* Extended attribute. *)
3304 "attrname", FString;
3307 ] (* end of structs *)
3309 (* Ugh, Java has to be different ..
3310 * These names are also used by the Haskell bindings.
3312 let java_structs = [
3313 "int_bool", "IntBool";
3318 "statvfs", "StatVFS";
3320 "version", "Version";
3324 (* Used for testing language bindings. *)
3326 | CallString of string
3327 | CallOptString of string option
3328 | CallStringList of string list
3332 (* Used to memoize the result of pod2text. *)
3333 let pod2text_memo_filename = "src/.pod2text.data"
3334 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3336 let chan = open_in pod2text_memo_filename in
3337 let v = input_value chan in
3341 _ -> Hashtbl.create 13
3343 (* Useful functions.
3344 * Note we don't want to use any external OCaml libraries which
3345 * makes this a bit harder than it should be.
3347 let failwithf fs = ksprintf failwith fs
3349 let replace_char s c1 c2 =
3350 let s2 = String.copy s in
3351 let r = ref false in
3352 for i = 0 to String.length s2 - 1 do
3353 if String.unsafe_get s2 i = c1 then (
3354 String.unsafe_set s2 i c2;
3358 if not !r then s else s2
3362 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3364 let triml ?(test = isspace) str =
3366 let n = ref (String.length str) in
3367 while !n > 0 && test str.[!i]; do
3372 else String.sub str !i !n
3374 let trimr ?(test = isspace) str =
3375 let n = ref (String.length str) in
3376 while !n > 0 && test str.[!n-1]; do
3379 if !n = String.length str then str
3380 else String.sub str 0 !n
3382 let trim ?(test = isspace) str =
3383 trimr ~test (triml ~test str)
3385 let rec find s sub =
3386 let len = String.length s in
3387 let sublen = String.length sub in
3389 if i <= len-sublen then (
3391 if j < sublen then (
3392 if s.[i+j] = sub.[j] then loop2 (j+1)
3398 if r = -1 then loop (i+1) else r
3404 let rec replace_str s s1 s2 =
3405 let len = String.length s in
3406 let sublen = String.length s1 in
3407 let i = find s s1 in
3410 let s' = String.sub s 0 i in
3411 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3412 s' ^ s2 ^ replace_str s'' s1 s2
3415 let rec string_split sep str =
3416 let len = String.length str in
3417 let seplen = String.length sep in
3418 let i = find str sep in
3419 if i = -1 then [str]
3421 let s' = String.sub str 0 i in
3422 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3423 s' :: string_split sep s''
3426 let files_equal n1 n2 =
3427 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3428 match Sys.command cmd with
3431 | i -> failwithf "%s: failed with error code %d" cmd i
3433 let rec find_map f = function
3434 | [] -> raise Not_found
3438 | None -> find_map f xs
3441 let rec loop i = function
3443 | x :: xs -> f i x; loop (i+1) xs
3448 let rec loop i = function
3450 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3454 let name_of_argt = function
3455 | String n | OptString n | StringList n | Bool n | Int n
3456 | FileIn n | FileOut n -> n
3458 let java_name_of_struct typ =
3459 try List.assoc typ java_structs
3462 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3464 let cols_of_struct typ =
3465 try List.assoc typ structs
3467 failwithf "cols_of_struct: unknown struct %s" typ
3469 let seq_of_test = function
3470 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3471 | TestOutputListOfDevices (s, _)
3472 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3473 | TestOutputTrue s | TestOutputFalse s
3474 | TestOutputLength (s, _) | TestOutputStruct (s, _)
3475 | TestLastFail s -> s
3477 (* Handling for function flags. *)
3478 let protocol_limit_warning =
3479 "Because of the message protocol, there is a transfer limit
3480 of somewhere between 2MB and 4MB. To transfer large files you should use
3483 let danger_will_robinson =
3484 "B<This command is dangerous. Without careful use you
3485 can easily destroy all your data>."
3487 let deprecation_notice flags =
3490 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
3492 sprintf "This function is deprecated.
3493 In new code, use the C<%s> call instead.
3495 Deprecated functions will not be removed from the API, but the
3496 fact that they are deprecated indicates that there are problems
3497 with correct use of these functions." alt in
3502 (* Check function names etc. for consistency. *)
3503 let check_functions () =
3504 let contains_uppercase str =
3505 let len = String.length str in
3507 if i >= len then false
3510 if c >= 'A' && c <= 'Z' then true
3517 (* Check function names. *)
3519 fun (name, _, _, _, _, _, _) ->
3520 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3521 failwithf "function name %s does not need 'guestfs' prefix" name;
3523 failwithf "function name is empty";
3524 if name.[0] < 'a' || name.[0] > 'z' then
3525 failwithf "function name %s must start with lowercase a-z" name;
3526 if String.contains name '-' then
3527 failwithf "function name %s should not contain '-', use '_' instead."
3531 (* Check function parameter/return names. *)
3533 fun (name, style, _, _, _, _, _) ->
3534 let check_arg_ret_name n =
3535 if contains_uppercase n then
3536 failwithf "%s param/ret %s should not contain uppercase chars"
3538 if String.contains n '-' || String.contains n '_' then
3539 failwithf "%s param/ret %s should not contain '-' or '_'"
3542 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;
3543 if n = "int" || n = "char" || n = "short" || n = "long" then
3544 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3545 if n = "i" || n = "n" then
3546 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3547 if n = "argv" || n = "args" then
3548 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3551 (match fst style with
3553 | RInt n | RInt64 n | RBool n
3554 | RConstString n | RConstOptString n | RString n
3555 | RStringList n | RStruct (n, _) | RStructList (n, _)
3556 | RHashtable n | RBufferOut n ->
3557 check_arg_ret_name n
3559 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3562 (* Check short descriptions. *)
3564 fun (name, _, _, _, _, shortdesc, _) ->
3565 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3566 failwithf "short description of %s should begin with lowercase." name;
3567 let c = shortdesc.[String.length shortdesc-1] in
3568 if c = '\n' || c = '.' then
3569 failwithf "short description of %s should not end with . or \\n." name
3572 (* Check long dscriptions. *)
3574 fun (name, _, _, _, _, _, longdesc) ->
3575 if longdesc.[String.length longdesc-1] = '\n' then
3576 failwithf "long description of %s should not end with \\n." name
3579 (* Check proc_nrs. *)
3581 fun (name, _, proc_nr, _, _, _, _) ->
3582 if proc_nr <= 0 then
3583 failwithf "daemon function %s should have proc_nr > 0" name
3587 fun (name, _, proc_nr, _, _, _, _) ->
3588 if proc_nr <> -1 then
3589 failwithf "non-daemon function %s should have proc_nr -1" name
3590 ) non_daemon_functions;
3593 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3596 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3597 let rec loop = function
3600 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3602 | (name1,nr1) :: (name2,nr2) :: _ ->
3603 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3611 (* Ignore functions that have no tests. We generate a
3612 * warning when the user does 'make check' instead.
3614 | name, _, _, _, [], _, _ -> ()
3615 | name, _, _, _, tests, _, _ ->
3619 match seq_of_test test with
3621 failwithf "%s has a test containing an empty sequence" name
3622 | cmds -> List.map List.hd cmds
3624 let funcs = List.flatten funcs in
3626 let tested = List.mem name funcs in
3629 failwithf "function %s has tests but does not test itself" name
3632 (* 'pr' prints to the current output file. *)
3633 let chan = ref stdout
3634 let pr fs = ksprintf (output_string !chan) fs
3636 (* Generate a header block in a number of standard styles. *)
3637 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3638 type license = GPLv2 | LGPLv2
3640 let generate_header comment license =
3641 let c = match comment with
3642 | CStyle -> pr "/* "; " *"
3643 | HashStyle -> pr "# "; "#"
3644 | OCamlStyle -> pr "(* "; " *"
3645 | HaskellStyle -> pr "{- "; " " in
3646 pr "libguestfs generated file\n";
3647 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3648 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3650 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3654 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3655 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3656 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3657 pr "%s (at your option) any later version.\n" c;
3659 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3660 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3661 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3662 pr "%s GNU General Public License for more details.\n" c;
3664 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3665 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3666 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3669 pr "%s This library is free software; you can redistribute it and/or\n" c;
3670 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3671 pr "%s License as published by the Free Software Foundation; either\n" c;
3672 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3674 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3675 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3676 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3677 pr "%s Lesser General Public License for more details.\n" c;
3679 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3680 pr "%s License along with this library; if not, write to the Free Software\n" c;
3681 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3684 | CStyle -> pr " */\n"
3686 | OCamlStyle -> pr " *)\n"
3687 | HaskellStyle -> pr "-}\n"
3691 (* Start of main code generation functions below this line. *)
3693 (* Generate the pod documentation for the C API. *)
3694 let rec generate_actions_pod () =
3696 fun (shortname, style, _, flags, _, _, longdesc) ->
3697 if not (List.mem NotInDocs flags) then (
3698 let name = "guestfs_" ^ shortname in
3699 pr "=head2 %s\n\n" name;
3701 generate_prototype ~extern:false ~handle:"handle" name style;
3703 pr "%s\n\n" longdesc;
3704 (match fst style with
3706 pr "This function returns 0 on success or -1 on error.\n\n"
3708 pr "On error this function returns -1.\n\n"
3710 pr "On error this function returns -1.\n\n"
3712 pr "This function returns a C truth value on success or -1 on error.\n\n"
3714 pr "This function returns a string, or NULL on error.
3715 The string is owned by the guest handle and must I<not> be freed.\n\n"
3716 | RConstOptString _ ->
3717 pr "This function returns a string which may be NULL.
3718 There is way to return an error from this function.
3719 The string is owned by the guest handle and must I<not> be freed.\n\n"
3721 pr "This function returns a string, or NULL on error.
3722 I<The caller must free the returned string after use>.\n\n"
3724 pr "This function returns a NULL-terminated array of strings
3725 (like L<environ(3)>), or NULL if there was an error.
3726 I<The caller must free the strings and the array after use>.\n\n"
3727 | RStruct (_, typ) ->
3728 pr "This function returns a C<struct guestfs_%s *>,
3729 or NULL if there was an error.
3730 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3731 | RStructList (_, typ) ->
3732 pr "This function returns a C<struct guestfs_%s_list *>
3733 (see E<lt>guestfs-structs.hE<gt>),
3734 or NULL if there was an error.
3735 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3737 pr "This function returns a NULL-terminated array of
3738 strings, or NULL if there was an error.
3739 The array of strings will always have length C<2n+1>, where
3740 C<n> keys and values alternate, followed by the trailing NULL entry.
3741 I<The caller must free the strings and the array after use>.\n\n"
3743 pr "This function returns a buffer, or NULL on error.
3744 The size of the returned buffer is written to C<*size_r>.
3745 I<The caller must free the returned buffer after use>.\n\n"
3747 if List.mem ProtocolLimitWarning flags then
3748 pr "%s\n\n" protocol_limit_warning;
3749 if List.mem DangerWillRobinson flags then
3750 pr "%s\n\n" danger_will_robinson;
3751 match deprecation_notice flags with
3753 | Some txt -> pr "%s\n\n" txt
3755 ) all_functions_sorted
3757 and generate_structs_pod () =
3758 (* Structs documentation. *)
3761 pr "=head2 guestfs_%s\n" typ;
3763 pr " struct guestfs_%s {\n" typ;
3766 | name, FChar -> pr " char %s;\n" name
3767 | name, FUInt32 -> pr " uint32_t %s;\n" name
3768 | name, FInt32 -> pr " int32_t %s;\n" name
3769 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3770 | name, FInt64 -> pr " int64_t %s;\n" name
3771 | name, FString -> pr " char *%s;\n" name
3773 pr " /* The next two fields describe a byte array. */\n";
3774 pr " uint32_t %s_len;\n" name;
3775 pr " char *%s;\n" name
3777 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3778 pr " char %s[32];\n" name
3779 | name, FOptPercent ->
3780 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
3781 pr " float %s;\n" name
3785 pr " struct guestfs_%s_list {\n" typ;
3786 pr " uint32_t len; /* Number of elements in list. */\n";
3787 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
3790 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3791 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3796 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3797 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3799 * We have to use an underscore instead of a dash because otherwise
3800 * rpcgen generates incorrect code.
3802 * This header is NOT exported to clients, but see also generate_structs_h.
3804 and generate_xdr () =
3805 generate_header CStyle LGPLv2;
3807 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3808 pr "typedef string str<>;\n";
3811 (* Internal structures. *)
3815 pr "struct guestfs_int_%s {\n" typ;
3817 | name, FChar -> pr " char %s;\n" name
3818 | name, FString -> pr " string %s<>;\n" name
3819 | name, FBuffer -> pr " opaque %s<>;\n" name
3820 | name, FUUID -> pr " opaque %s[32];\n" name
3821 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
3822 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
3823 | name, FOptPercent -> pr " float %s;\n" name
3827 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3832 fun (shortname, style, _, _, _, _, _) ->
3833 let name = "guestfs_" ^ shortname in
3835 (match snd style with
3838 pr "struct %s_args {\n" name;
3841 | String n -> pr " string %s<>;\n" n
3842 | OptString n -> pr " str *%s;\n" n
3843 | StringList n -> pr " str %s<>;\n" n
3844 | Bool n -> pr " bool %s;\n" n
3845 | Int n -> pr " int %s;\n" n
3846 | FileIn _ | FileOut _ -> ()
3850 (match fst style with
3853 pr "struct %s_ret {\n" name;
3857 pr "struct %s_ret {\n" name;
3858 pr " hyper %s;\n" n;
3861 pr "struct %s_ret {\n" name;
3864 | RConstString _ | RConstOptString _ ->
3865 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
3867 pr "struct %s_ret {\n" name;
3868 pr " string %s<>;\n" n;
3871 pr "struct %s_ret {\n" name;
3872 pr " str %s<>;\n" n;
3874 | RStruct (n, typ) ->
3875 pr "struct %s_ret {\n" name;
3876 pr " guestfs_int_%s %s;\n" typ n;
3878 | RStructList (n, typ) ->
3879 pr "struct %s_ret {\n" name;
3880 pr " guestfs_int_%s_list %s;\n" typ n;
3883 pr "struct %s_ret {\n" name;
3884 pr " str %s<>;\n" n;
3887 pr "struct %s_ret {\n" name;
3888 pr " opaque %s<>;\n" n;
3893 (* Table of procedure numbers. *)
3894 pr "enum guestfs_procedure {\n";
3896 fun (shortname, _, proc_nr, _, _, _, _) ->
3897 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3899 pr " GUESTFS_PROC_NR_PROCS\n";
3903 (* Having to choose a maximum message size is annoying for several
3904 * reasons (it limits what we can do in the API), but it (a) makes
3905 * the protocol a lot simpler, and (b) provides a bound on the size
3906 * of the daemon which operates in limited memory space. For large
3907 * file transfers you should use FTP.
3909 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3912 (* Message header, etc. *)
3914 /* The communication protocol is now documented in the guestfs(3)
3918 const GUESTFS_PROGRAM = 0x2000F5F5;
3919 const GUESTFS_PROTOCOL_VERSION = 1;
3921 /* These constants must be larger than any possible message length. */
3922 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3923 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3925 enum guestfs_message_direction {
3926 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
3927 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
3930 enum guestfs_message_status {
3931 GUESTFS_STATUS_OK = 0,
3932 GUESTFS_STATUS_ERROR = 1
3935 const GUESTFS_ERROR_LEN = 256;
3937 struct guestfs_message_error {
3938 string error_message<GUESTFS_ERROR_LEN>;
3941 struct guestfs_message_header {
3942 unsigned prog; /* GUESTFS_PROGRAM */
3943 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
3944 guestfs_procedure proc; /* GUESTFS_PROC_x */
3945 guestfs_message_direction direction;
3946 unsigned serial; /* message serial number */
3947 guestfs_message_status status;
3950 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3952 struct guestfs_chunk {
3953 int cancel; /* if non-zero, transfer is cancelled */
3954 /* data size is 0 bytes if the transfer has finished successfully */
3955 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3959 (* Generate the guestfs-structs.h file. *)
3960 and generate_structs_h () =
3961 generate_header CStyle LGPLv2;
3963 (* This is a public exported header file containing various
3964 * structures. The structures are carefully written to have
3965 * exactly the same in-memory format as the XDR structures that
3966 * we use on the wire to the daemon. The reason for creating
3967 * copies of these structures here is just so we don't have to
3968 * export the whole of guestfs_protocol.h (which includes much
3969 * unrelated and XDR-dependent stuff that we don't want to be
3970 * public, or required by clients).
3972 * To reiterate, we will pass these structures to and from the
3973 * client with a simple assignment or memcpy, so the format
3974 * must be identical to what rpcgen / the RFC defines.
3977 (* Public structures. *)
3980 pr "struct guestfs_%s {\n" typ;
3983 | name, FChar -> pr " char %s;\n" name
3984 | name, FString -> pr " char *%s;\n" name
3986 pr " uint32_t %s_len;\n" name;
3987 pr " char *%s;\n" name
3988 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3989 | name, FUInt32 -> pr " uint32_t %s;\n" name
3990 | name, FInt32 -> pr " int32_t %s;\n" name
3991 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
3992 | name, FInt64 -> pr " int64_t %s;\n" name
3993 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
3997 pr "struct guestfs_%s_list {\n" typ;
3998 pr " uint32_t len;\n";
3999 pr " struct guestfs_%s *val;\n" typ;
4002 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
4003 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
4007 (* Generate the guestfs-actions.h file. *)
4008 and generate_actions_h () =
4009 generate_header CStyle LGPLv2;
4011 fun (shortname, style, _, _, _, _, _) ->
4012 let name = "guestfs_" ^ shortname in
4013 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
4017 (* Generate the client-side dispatch stubs. *)
4018 and generate_client_actions () =
4019 generate_header CStyle LGPLv2;
4025 #include \"guestfs.h\"
4026 #include \"guestfs_protocol.h\"
4028 #define error guestfs_error
4029 #define perrorf guestfs_perrorf
4030 #define safe_malloc guestfs_safe_malloc
4031 #define safe_realloc guestfs_safe_realloc
4032 #define safe_strdup guestfs_safe_strdup
4033 #define safe_memdup guestfs_safe_memdup
4035 /* Check the return message from a call for validity. */
4037 check_reply_header (guestfs_h *g,
4038 const struct guestfs_message_header *hdr,
4039 int proc_nr, int serial)
4041 if (hdr->prog != GUESTFS_PROGRAM) {
4042 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
4045 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
4046 error (g, \"wrong protocol version (%%d/%%d)\",
4047 hdr->vers, GUESTFS_PROTOCOL_VERSION);
4050 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
4051 error (g, \"unexpected message direction (%%d/%%d)\",
4052 hdr->direction, GUESTFS_DIRECTION_REPLY);
4055 if (hdr->proc != proc_nr) {
4056 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
4059 if (hdr->serial != serial) {
4060 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
4067 /* Check we are in the right state to run a high-level action. */
4069 check_state (guestfs_h *g, const char *caller)
4071 if (!guestfs_is_ready (g)) {
4072 if (guestfs_is_config (g))
4073 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
4075 else if (guestfs_is_launching (g))
4076 error (g, \"%%s: call wait_ready() before using this function\",
4079 error (g, \"%%s called from the wrong state, %%d != READY\",
4080 caller, guestfs_get_state (g));
4088 (* Client-side stubs for each function. *)
4090 fun (shortname, style, _, _, _, _, _) ->
4091 let name = "guestfs_" ^ shortname in
4093 (* Generate the context struct which stores the high-level
4094 * state between callback functions.
4096 pr "struct %s_ctx {\n" shortname;
4097 pr " /* This flag is set by the callbacks, so we know we've done\n";
4098 pr " * the callbacks as expected, and in the right sequence.\n";
4099 pr " * 0 = not called, 1 = reply_cb called.\n";
4101 pr " int cb_sequence;\n";
4102 pr " struct guestfs_message_header hdr;\n";
4103 pr " struct guestfs_message_error err;\n";
4104 (match fst style with
4106 | RConstString _ | RConstOptString _ ->
4107 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4109 | RBool _ | RString _ | RStringList _
4110 | RStruct _ | RStructList _
4111 | RHashtable _ | RBufferOut _ ->
4112 pr " struct %s_ret ret;\n" name
4117 (* Generate the reply callback function. *)
4118 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4120 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4121 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4123 pr " /* This should definitely not happen. */\n";
4124 pr " if (ctx->cb_sequence != 0) {\n";
4125 pr " ctx->cb_sequence = 9999;\n";
4126 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4130 pr " ml->main_loop_quit (ml, g);\n";
4132 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4133 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4136 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4137 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4138 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4145 (match fst style with
4147 | RConstString _ | RConstOptString _ ->
4148 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4150 | RBool _ | RString _ | RStringList _
4151 | RStruct _ | RStructList _
4152 | RHashtable _ | RBufferOut _ ->
4153 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4154 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4160 pr " ctx->cb_sequence = 1;\n";
4163 (* Generate the action stub. *)
4164 generate_prototype ~extern:false ~semicolon:false ~newline:true
4165 ~handle:"g" name style;
4168 match fst style with
4169 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4170 | RConstString _ | RConstOptString _ ->
4171 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4172 | RString _ | RStringList _
4173 | RStruct _ | RStructList _
4174 | RHashtable _ | RBufferOut _ ->
4179 (match snd style with
4181 | _ -> pr " struct %s_args args;\n" name
4184 pr " struct %s_ctx ctx;\n" shortname;
4185 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4186 pr " int serial;\n";
4188 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4189 pr " guestfs_set_busy (g);\n";
4191 pr " memset (&ctx, 0, sizeof ctx);\n";
4194 (* Send the main header and arguments. *)
4195 (match snd style with
4197 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4198 (String.uppercase shortname)
4203 pr " args.%s = (char *) %s;\n" n n
4205 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4207 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4208 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4210 pr " args.%s = %s;\n" n n
4212 pr " args.%s = %s;\n" n n
4213 | FileIn _ | FileOut _ -> ()
4215 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4216 (String.uppercase shortname);
4217 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4220 pr " if (serial == -1) {\n";
4221 pr " guestfs_end_busy (g);\n";
4222 pr " return %s;\n" error_code;
4226 (* Send any additional files (FileIn) requested. *)
4227 let need_read_reply_label = ref false in
4234 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4235 pr " if (r == -1) {\n";
4236 pr " guestfs_end_busy (g);\n";
4237 pr " return %s;\n" error_code;
4239 pr " if (r == -2) /* daemon cancelled */\n";
4240 pr " goto read_reply;\n";
4241 need_read_reply_label := true;
4247 (* Wait for the reply from the remote end. *)
4248 if !need_read_reply_label then pr " read_reply:\n";
4249 pr " guestfs__switch_to_receiving (g);\n";
4250 pr " ctx.cb_sequence = 0;\n";
4251 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4252 pr " (void) ml->main_loop_run (ml, g);\n";
4253 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4254 pr " if (ctx.cb_sequence != 1) {\n";
4255 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4256 pr " guestfs_end_busy (g);\n";
4257 pr " return %s;\n" error_code;
4261 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4262 (String.uppercase shortname);
4263 pr " guestfs_end_busy (g);\n";
4264 pr " return %s;\n" error_code;
4268 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4269 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4270 pr " free (ctx.err.error_message);\n";
4271 pr " guestfs_end_busy (g);\n";
4272 pr " return %s;\n" error_code;
4276 (* Expecting to receive further files (FileOut)? *)
4280 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4281 pr " guestfs_end_busy (g);\n";
4282 pr " return %s;\n" error_code;
4288 pr " guestfs_end_busy (g);\n";
4290 (match fst style with
4291 | RErr -> pr " return 0;\n"
4292 | RInt n | RInt64 n | RBool n ->
4293 pr " return ctx.ret.%s;\n" n
4294 | RConstString _ | RConstOptString _ ->
4295 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4297 pr " return ctx.ret.%s; /* caller will free */\n" n
4298 | RStringList n | RHashtable n ->
4299 pr " /* caller will free this, but we need to add a NULL entry */\n";
4300 pr " ctx.ret.%s.%s_val =\n" n n;
4301 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4302 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4304 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4305 pr " return ctx.ret.%s.%s_val;\n" n n
4307 pr " /* caller will free this */\n";
4308 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4309 | RStructList (n, _) ->
4310 pr " /* caller will free this */\n";
4311 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4313 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4314 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4320 (* Functions to free structures. *)
4321 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4322 pr " * structure format is identical to the XDR format. See note in\n";
4323 pr " * generator.ml.\n";
4330 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4332 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4338 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4340 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4347 (* Generate daemon/actions.h. *)
4348 and generate_daemon_actions_h () =
4349 generate_header CStyle GPLv2;
4351 pr "#include \"../src/guestfs_protocol.h\"\n";
4355 fun (name, style, _, _, _, _, _) ->
4357 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4361 (* Generate the server-side stubs. *)
4362 and generate_daemon_actions () =
4363 generate_header CStyle GPLv2;
4365 pr "#include <config.h>\n";
4367 pr "#include <stdio.h>\n";
4368 pr "#include <stdlib.h>\n";
4369 pr "#include <string.h>\n";
4370 pr "#include <inttypes.h>\n";
4371 pr "#include <ctype.h>\n";
4372 pr "#include <rpc/types.h>\n";
4373 pr "#include <rpc/xdr.h>\n";
4375 pr "#include \"daemon.h\"\n";
4376 pr "#include \"../src/guestfs_protocol.h\"\n";
4377 pr "#include \"actions.h\"\n";
4381 fun (name, style, _, _, _, _, _) ->
4382 (* Generate server-side stubs. *)
4383 pr "static void %s_stub (XDR *xdr_in)\n" name;
4386 match fst style with
4387 | RErr | RInt _ -> pr " int r;\n"; "-1"
4388 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4389 | RBool _ -> pr " int r;\n"; "-1"
4390 | RConstString _ | RConstOptString _ ->
4391 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4392 | RString _ -> pr " char *r;\n"; "NULL"
4393 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4394 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4395 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4397 pr " size_t size;\n";
4401 (match snd style with
4404 pr " struct guestfs_%s_args args;\n" name;
4407 (* Note we allow the string to be writable, in order to
4408 * allow device name translation. This is safe because
4409 * we can modify the string (passed from RPC).
4412 | OptString n -> pr " char *%s;\n" n
4413 | StringList n -> pr " char **%s;\n" n
4414 | Bool n -> pr " int %s;\n" n
4415 | Int n -> pr " int %s;\n" n
4416 | FileIn _ | FileOut _ -> ()
4421 (match snd style with
4424 pr " memset (&args, 0, sizeof args);\n";
4426 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4427 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4432 | String n -> pr " %s = args.%s;\n" n n
4433 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4435 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4436 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4437 pr " if (%s == NULL) {\n" n;
4438 pr " reply_with_perror (\"realloc\");\n";
4441 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4442 pr " args.%s.%s_val = %s;\n" n n n;
4443 | Bool n -> pr " %s = args.%s;\n" n n
4444 | Int n -> pr " %s = args.%s;\n" n n
4445 | FileIn _ | FileOut _ -> ()
4450 (* Don't want to call the impl with any FileIn or FileOut
4451 * parameters, since these go "outside" the RPC protocol.
4454 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4456 pr " r = do_%s " name;
4457 generate_c_call_args (fst style, args');
4460 pr " if (r == %s)\n" error_code;
4461 pr " /* do_%s has already called reply_with_error */\n" name;
4465 (* If there are any FileOut parameters, then the impl must
4466 * send its own reply.
4469 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4471 pr " /* do_%s has already sent a reply */\n" name
4473 match fst style with
4474 | RErr -> pr " reply (NULL, NULL);\n"
4475 | RInt n | RInt64 n | RBool n ->
4476 pr " struct guestfs_%s_ret ret;\n" name;
4477 pr " ret.%s = r;\n" n;
4478 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4480 | RConstString _ | RConstOptString _ ->
4481 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4483 pr " struct guestfs_%s_ret ret;\n" name;
4484 pr " ret.%s = r;\n" n;
4485 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4488 | RStringList n | RHashtable n ->
4489 pr " struct guestfs_%s_ret ret;\n" name;
4490 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4491 pr " ret.%s.%s_val = r;\n" n n;
4492 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4494 pr " free_strings (r);\n"
4496 pr " struct guestfs_%s_ret ret;\n" name;
4497 pr " ret.%s = *r;\n" n;
4498 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4500 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4502 | RStructList (n, _) ->
4503 pr " struct guestfs_%s_ret ret;\n" name;
4504 pr " ret.%s = *r;\n" n;
4505 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4507 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4510 pr " struct guestfs_%s_ret ret;\n" name;
4511 pr " ret.%s.%s_val = r;\n" n n;
4512 pr " ret.%s.%s_len = size;\n" n n;
4513 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4518 (* Free the args. *)
4519 (match snd style with
4524 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4531 (* Dispatch function. *)
4532 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4534 pr " switch (proc_nr) {\n";
4537 fun (name, style, _, _, _, _, _) ->
4538 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4539 pr " %s_stub (xdr_in);\n" name;
4544 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";
4549 (* LVM columns and tokenization functions. *)
4550 (* XXX This generates crap code. We should rethink how we
4556 pr "static const char *lvm_%s_cols = \"%s\";\n"
4557 typ (String.concat "," (List.map fst cols));
4560 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4562 pr " char *tok, *p, *next;\n";
4566 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4569 pr " if (!str) {\n";
4570 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4573 pr " if (!*str || isspace (*str)) {\n";
4574 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4579 fun (name, coltype) ->
4580 pr " if (!tok) {\n";
4581 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4584 pr " p = strchrnul (tok, ',');\n";
4585 pr " if (*p) next = p+1; else next = NULL;\n";
4586 pr " *p = '\\0';\n";
4589 pr " r->%s = strdup (tok);\n" name;
4590 pr " if (r->%s == NULL) {\n" name;
4591 pr " perror (\"strdup\");\n";
4595 pr " for (i = j = 0; i < 32; ++j) {\n";
4596 pr " if (tok[j] == '\\0') {\n";
4597 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4599 pr " } else if (tok[j] != '-')\n";
4600 pr " r->%s[i++] = tok[j];\n" name;
4603 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4604 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4608 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4609 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4613 pr " if (tok[0] == '\\0')\n";
4614 pr " r->%s = -1;\n" name;
4615 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4616 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4619 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4620 assert false (* can never be an LVM column *)
4622 pr " tok = next;\n";
4625 pr " if (tok != NULL) {\n";
4626 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4633 pr "guestfs_int_lvm_%s_list *\n" typ;
4634 pr "parse_command_line_%ss (void)\n" typ;
4636 pr " char *out, *err;\n";
4637 pr " char *p, *pend;\n";
4639 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4640 pr " void *newp;\n";
4642 pr " ret = malloc (sizeof *ret);\n";
4643 pr " if (!ret) {\n";
4644 pr " reply_with_perror (\"malloc\");\n";
4645 pr " return NULL;\n";
4648 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4649 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4651 pr " r = command (&out, &err,\n";
4652 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4653 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4654 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4655 pr " if (r == -1) {\n";
4656 pr " reply_with_error (\"%%s\", err);\n";
4657 pr " free (out);\n";
4658 pr " free (err);\n";
4659 pr " free (ret);\n";
4660 pr " return NULL;\n";
4663 pr " free (err);\n";
4665 pr " /* Tokenize each line of the output. */\n";
4668 pr " while (p) {\n";
4669 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4670 pr " if (pend) {\n";
4671 pr " *pend = '\\0';\n";
4675 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4678 pr " if (!*p) { /* Empty line? Skip it. */\n";
4683 pr " /* Allocate some space to store this next entry. */\n";
4684 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4685 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4686 pr " if (newp == NULL) {\n";
4687 pr " reply_with_perror (\"realloc\");\n";
4688 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4689 pr " free (ret);\n";
4690 pr " free (out);\n";
4691 pr " return NULL;\n";
4693 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4695 pr " /* Tokenize the next entry. */\n";
4696 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4697 pr " if (r == -1) {\n";
4698 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4699 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4700 pr " free (ret);\n";
4701 pr " free (out);\n";
4702 pr " return NULL;\n";
4709 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4711 pr " free (out);\n";
4712 pr " return ret;\n";
4715 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4717 (* Generate a list of function names, for debugging in the daemon.. *)
4718 and generate_daemon_names () =
4719 generate_header CStyle GPLv2;
4721 pr "#include <config.h>\n";
4723 pr "#include \"daemon.h\"\n";
4726 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4727 pr "const char *function_names[] = {\n";
4729 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
4733 (* Generate the tests. *)
4734 and generate_tests () =
4735 generate_header CStyle GPLv2;
4742 #include <sys/types.h>
4745 #include \"guestfs.h\"
4747 static guestfs_h *g;
4748 static int suppress_error = 0;
4750 static void print_error (guestfs_h *g, void *data, const char *msg)
4752 if (!suppress_error)
4753 fprintf (stderr, \"%%s\\n\", msg);
4756 static void print_strings (char * const * const argv)
4760 for (argc = 0; argv[argc] != NULL; ++argc)
4761 printf (\"\\t%%s\\n\", argv[argc]);
4765 static void print_table (char * const * const argv)
4769 for (i = 0; argv[i] != NULL; i += 2)
4770 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
4774 static void no_test_warnings (void)
4780 | name, _, _, _, [], _, _ ->
4781 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
4782 | name, _, _, _, tests, _, _ -> ()
4788 (* Generate the actual tests. Note that we generate the tests
4789 * in reverse order, deliberately, so that (in general) the
4790 * newest tests run first. This makes it quicker and easier to
4795 fun (name, _, _, _, tests, _, _) ->
4796 mapi (generate_one_test name) tests
4797 ) (List.rev all_functions) in
4798 let test_names = List.concat test_names in
4799 let nr_tests = List.length test_names in
4802 int main (int argc, char *argv[])
4806 const char *filename;
4808 int nr_tests, test_num = 0;
4810 setbuf (stdout, NULL);
4812 no_test_warnings ();
4814 g = guestfs_create ();
4816 printf (\"guestfs_create FAILED\\n\");
4820 guestfs_set_error_handler (g, print_error, NULL);
4822 guestfs_set_path (g, \"../appliance\");
4824 filename = \"test1.img\";
4825 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4830 if (lseek (fd, %d, SEEK_SET) == -1) {
4836 if (write (fd, &c, 1) == -1) {
4842 if (close (fd) == -1) {
4847 if (guestfs_add_drive (g, filename) == -1) {
4848 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4852 filename = \"test2.img\";
4853 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4858 if (lseek (fd, %d, SEEK_SET) == -1) {
4864 if (write (fd, &c, 1) == -1) {
4870 if (close (fd) == -1) {
4875 if (guestfs_add_drive (g, filename) == -1) {
4876 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4880 filename = \"test3.img\";
4881 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
4886 if (lseek (fd, %d, SEEK_SET) == -1) {
4892 if (write (fd, &c, 1) == -1) {
4898 if (close (fd) == -1) {
4903 if (guestfs_add_drive (g, filename) == -1) {
4904 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
4908 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
4909 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
4913 if (guestfs_launch (g) == -1) {
4914 printf (\"guestfs_launch FAILED\\n\");
4918 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
4921 if (guestfs_wait_ready (g) == -1) {
4922 printf (\"guestfs_wait_ready FAILED\\n\");
4926 /* Cancel previous alarm. */
4931 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
4935 pr " test_num++;\n";
4936 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
4937 pr " if (%s () == -1) {\n" test_name;
4938 pr " printf (\"%s FAILED\\n\");\n" test_name;
4944 pr " guestfs_close (g);\n";
4945 pr " unlink (\"test1.img\");\n";
4946 pr " unlink (\"test2.img\");\n";
4947 pr " unlink (\"test3.img\");\n";
4950 pr " if (failed > 0) {\n";
4951 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4959 and generate_one_test name i (init, prereq, test) =
4960 let test_name = sprintf "test_%s_%d" name i in
4963 static int %s_skip (void)
4967 str = getenv (\"TEST_ONLY\");
4969 return strstr (str, \"%s\") == NULL;
4970 str = getenv (\"SKIP_%s\");
4971 if (str && strcmp (str, \"1\") == 0) return 1;
4972 str = getenv (\"SKIP_TEST_%s\");
4973 if (str && strcmp (str, \"1\") == 0) return 1;
4977 " test_name name (String.uppercase test_name) (String.uppercase name);
4980 | Disabled | Always -> ()
4981 | If code | Unless code ->
4982 pr "static int %s_prereq (void)\n" test_name;
4990 static int %s (void)
4993 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
4997 " test_name test_name test_name;
5001 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
5003 pr " if (! %s_prereq ()) {\n" test_name;
5004 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5008 generate_one_test_body name i test_name init test;
5010 pr " if (%s_prereq ()) {\n" test_name;
5011 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5015 generate_one_test_body name i test_name init test;
5017 generate_one_test_body name i test_name init test
5025 and generate_one_test_body name i test_name init test =
5027 | InitNone (* XXX at some point, InitNone and InitEmpty became
5028 * folded together as the same thing. Really we should
5029 * make InitNone do nothing at all, but the tests may
5030 * need to be checked to make sure this is OK.
5033 pr " /* InitNone|InitEmpty for %s */\n" test_name;
5034 List.iter (generate_test_command_call test_name)
5035 [["blockdev_setrw"; "/dev/sda"];
5039 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
5040 List.iter (generate_test_command_call test_name)
5041 [["blockdev_setrw"; "/dev/sda"];
5044 ["sfdiskM"; "/dev/sda"; ","];
5045 ["mkfs"; "ext2"; "/dev/sda1"];
5046 ["mount"; "/dev/sda1"; "/"]]
5047 | InitBasicFSonLVM ->
5048 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
5050 List.iter (generate_test_command_call test_name)
5051 [["blockdev_setrw"; "/dev/sda"];
5054 ["sfdiskM"; "/dev/sda"; ","];
5055 ["pvcreate"; "/dev/sda1"];
5056 ["vgcreate"; "VG"; "/dev/sda1"];
5057 ["lvcreate"; "LV"; "VG"; "8"];
5058 ["mkfs"; "ext2"; "/dev/VG/LV"];
5059 ["mount"; "/dev/VG/LV"; "/"]]
5061 pr " /* InitSquashFS for %s */\n" test_name;
5062 List.iter (generate_test_command_call test_name)
5063 [["blockdev_setrw"; "/dev/sda"];
5066 ["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"]]
5069 let get_seq_last = function
5071 failwithf "%s: you cannot use [] (empty list) when expecting a command"
5074 let seq = List.rev seq in
5075 List.rev (List.tl seq), List.hd seq
5080 pr " /* TestRun for %s (%d) */\n" name i;
5081 List.iter (generate_test_command_call test_name) seq
5082 | TestOutput (seq, expected) ->
5083 pr " /* TestOutput for %s (%d) */\n" name i;
5084 pr " const char *expected = \"%s\";\n" (c_quote expected);
5085 let seq, last = get_seq_last seq in
5087 pr " if (strcmp (r, expected) != 0) {\n";
5088 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5092 List.iter (generate_test_command_call test_name) seq;
5093 generate_test_command_call ~test test_name last
5094 | TestOutputList (seq, expected) ->
5095 pr " /* TestOutputList for %s (%d) */\n" name i;
5096 let seq, last = get_seq_last seq in
5100 pr " if (!r[%d]) {\n" i;
5101 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5102 pr " print_strings (r);\n";
5106 pr " const char *expected = \"%s\";\n" (c_quote str);
5107 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5108 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5113 pr " if (r[%d] != NULL) {\n" (List.length expected);
5114 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5116 pr " print_strings (r);\n";
5120 List.iter (generate_test_command_call test_name) seq;
5121 generate_test_command_call ~test test_name last
5122 | TestOutputListOfDevices (seq, expected) ->
5123 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5124 let seq, last = get_seq_last seq in
5128 pr " if (!r[%d]) {\n" i;
5129 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5130 pr " print_strings (r);\n";
5134 pr " const char *expected = \"%s\";\n" (c_quote str);
5135 pr " r[%d][5] = 's';\n" i;
5136 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5137 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5142 pr " if (r[%d] != NULL) {\n" (List.length expected);
5143 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5145 pr " print_strings (r);\n";
5149 List.iter (generate_test_command_call test_name) seq;
5150 generate_test_command_call ~test test_name last
5151 | TestOutputInt (seq, expected) ->
5152 pr " /* TestOutputInt for %s (%d) */\n" name i;
5153 let seq, last = get_seq_last seq in
5155 pr " if (r != %d) {\n" expected;
5156 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5162 List.iter (generate_test_command_call test_name) seq;
5163 generate_test_command_call ~test test_name last
5164 | TestOutputIntOp (seq, op, expected) ->
5165 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5166 let seq, last = get_seq_last seq in
5168 pr " if (! (r %s %d)) {\n" op expected;
5169 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5170 test_name op expected;
5175 List.iter (generate_test_command_call test_name) seq;
5176 generate_test_command_call ~test test_name last
5177 | TestOutputTrue seq ->
5178 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5179 let seq, last = get_seq_last seq in
5182 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5187 List.iter (generate_test_command_call test_name) seq;
5188 generate_test_command_call ~test test_name last
5189 | TestOutputFalse seq ->
5190 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5191 let seq, last = get_seq_last seq in
5194 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5199 List.iter (generate_test_command_call test_name) seq;
5200 generate_test_command_call ~test test_name last
5201 | TestOutputLength (seq, expected) ->
5202 pr " /* TestOutputLength for %s (%d) */\n" name i;
5203 let seq, last = get_seq_last seq in
5206 pr " for (j = 0; j < %d; ++j)\n" expected;
5207 pr " if (r[j] == NULL) {\n";
5208 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5210 pr " print_strings (r);\n";
5213 pr " if (r[j] != NULL) {\n";
5214 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5216 pr " print_strings (r);\n";
5220 List.iter (generate_test_command_call test_name) seq;
5221 generate_test_command_call ~test test_name last
5222 | TestOutputStruct (seq, checks) ->
5223 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5224 let seq, last = get_seq_last seq in
5228 | CompareWithInt (field, expected) ->
5229 pr " if (r->%s != %d) {\n" field expected;
5230 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5231 test_name field expected;
5232 pr " (int) r->%s);\n" field;
5235 | CompareWithIntOp (field, op, expected) ->
5236 pr " if (!(r->%s %s %d)) {\n" field op expected;
5237 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5238 test_name field op expected;
5239 pr " (int) r->%s);\n" field;
5242 | CompareWithString (field, expected) ->
5243 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5244 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5245 test_name field expected;
5246 pr " r->%s);\n" field;
5249 | CompareFieldsIntEq (field1, field2) ->
5250 pr " if (r->%s != r->%s) {\n" field1 field2;
5251 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5252 test_name field1 field2;
5253 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5256 | CompareFieldsStrEq (field1, field2) ->
5257 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5258 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5259 test_name field1 field2;
5260 pr " r->%s, r->%s);\n" field1 field2;
5265 List.iter (generate_test_command_call test_name) seq;
5266 generate_test_command_call ~test test_name last
5267 | TestLastFail seq ->
5268 pr " /* TestLastFail for %s (%d) */\n" name i;
5269 let seq, last = get_seq_last seq in
5270 List.iter (generate_test_command_call test_name) seq;
5271 generate_test_command_call test_name ~expect_error:true last
5273 (* Generate the code to run a command, leaving the result in 'r'.
5274 * If you expect to get an error then you should set expect_error:true.
5276 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5278 | [] -> assert false
5280 (* Look up the command to find out what args/ret it has. *)
5283 let _, style, _, _, _, _, _ =
5284 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5287 failwithf "%s: in test, command %s was not found" test_name name in
5289 if List.length (snd style) <> List.length args then
5290 failwithf "%s: in test, wrong number of args given to %s"
5297 | OptString n, "NULL" -> ()
5299 | OptString n, arg ->
5300 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5303 | FileIn _, _ | FileOut _, _ -> ()
5304 | StringList n, arg ->
5305 let strs = string_split " " arg in
5308 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5310 pr " const char *%s[] = {\n" n;
5312 fun i _ -> pr " %s_%d,\n" n i
5316 ) (List.combine (snd style) args);
5319 match fst style with
5320 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5321 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5322 | RConstString _ | RConstOptString _ ->
5323 pr " const char *r;\n"; "NULL"
5324 | RString _ -> pr " char *r;\n"; "NULL"
5325 | RStringList _ | RHashtable _ ->
5329 | RStruct (_, typ) ->
5330 pr " struct guestfs_%s *r;\n" typ; "NULL"
5331 | RStructList (_, typ) ->
5332 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5335 pr " size_t size;\n";
5338 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5339 pr " r = guestfs_%s (g" name;
5341 (* Generate the parameters. *)
5344 | OptString _, "NULL" -> pr ", NULL"
5348 | FileIn _, arg | FileOut _, arg ->
5349 pr ", \"%s\"" (c_quote arg)
5350 | StringList n, _ ->
5354 try int_of_string arg
5355 with Failure "int_of_string" ->
5356 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5359 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5360 ) (List.combine (snd style) args);
5362 (match fst style with
5363 | RBufferOut _ -> pr ", &size"
5369 if not expect_error then
5370 pr " if (r == %s)\n" error_code
5372 pr " if (r != %s)\n" error_code;
5375 (* Insert the test code. *)
5381 (match fst style with
5382 | RErr | RInt _ | RInt64 _ | RBool _
5383 | RConstString _ | RConstOptString _ -> ()
5384 | RString _ | RBufferOut _ -> pr " free (r);\n"
5385 | RStringList _ | RHashtable _ ->
5386 pr " for (i = 0; r[i] != NULL; ++i)\n";
5387 pr " free (r[i]);\n";
5389 | RStruct (_, typ) ->
5390 pr " guestfs_free_%s (r);\n" typ
5391 | RStructList (_, typ) ->
5392 pr " guestfs_free_%s_list (r);\n" typ
5398 let str = replace_str str "\r" "\\r" in
5399 let str = replace_str str "\n" "\\n" in
5400 let str = replace_str str "\t" "\\t" in
5401 let str = replace_str str "\000" "\\0" in
5404 (* Generate a lot of different functions for guestfish. *)
5405 and generate_fish_cmds () =
5406 generate_header CStyle GPLv2;
5410 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5412 let all_functions_sorted =
5414 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5415 ) all_functions_sorted in
5417 pr "#include <stdio.h>\n";
5418 pr "#include <stdlib.h>\n";
5419 pr "#include <string.h>\n";
5420 pr "#include <inttypes.h>\n";
5421 pr "#include <ctype.h>\n";
5423 pr "#include <guestfs.h>\n";
5424 pr "#include \"fish.h\"\n";
5427 (* list_commands function, which implements guestfish -h *)
5428 pr "void list_commands (void)\n";
5430 pr " printf (\" %%-16s %%s\\n\", \"Command\", \"Description\");\n";
5431 pr " list_builtin_commands ();\n";
5433 fun (name, _, _, flags, _, shortdesc, _) ->
5434 let name = replace_char name '_' '-' in
5435 pr " printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
5437 ) all_functions_sorted;
5438 pr " printf (\" Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
5442 (* display_command function, which implements guestfish -h cmd *)
5443 pr "void display_command (const char *cmd)\n";
5446 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5447 let name2 = replace_char name '_' '-' in
5449 try find_map (function FishAlias n -> Some n | _ -> None) flags
5450 with Not_found -> name in
5451 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5453 match snd style with
5457 name2 (String.concat "> <" (List.map name_of_argt args)) in
5460 if List.mem ProtocolLimitWarning flags then
5461 ("\n\n" ^ protocol_limit_warning)
5464 (* For DangerWillRobinson commands, we should probably have
5465 * guestfish prompt before allowing you to use them (especially
5466 * in interactive mode). XXX
5470 if List.mem DangerWillRobinson flags then
5471 ("\n\n" ^ danger_will_robinson)
5476 match deprecation_notice flags with
5478 | Some txt -> "\n\n" ^ txt in
5480 let describe_alias =
5481 if name <> alias then
5482 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5486 pr "strcasecmp (cmd, \"%s\") == 0" name;
5487 if name <> name2 then
5488 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5489 if name <> alias then
5490 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5492 pr " pod2text (\"%s - %s\", %S);\n"
5494 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5497 pr " display_builtin_command (cmd);\n";
5501 (* print_* functions *)
5505 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5507 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5516 pr " printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
5518 pr " printf (\"%s: \");\n" name;
5519 pr " for (i = 0; i < 32; ++i)\n";
5520 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5521 pr " printf (\"\\n\");\n"
5523 pr " printf (\"%s: \");\n" name;
5524 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5525 pr " if (isprint (%s->%s[i]))\n" typ name;
5526 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
5528 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
5529 pr " printf (\"\\n\");\n"
5530 | name, (FUInt64|FBytes) ->
5531 pr " printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
5533 pr " printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
5535 pr " printf (\"%s: %%\" PRIu32 \"\\n\", %s->%s);\n" name typ name
5537 pr " printf (\"%s: %%\" PRIi32 \"\\n\", %s->%s);\n" name typ name
5539 pr " printf (\"%s: %%c\\n\", %s->%s);\n" name typ name
5540 | name, FOptPercent ->
5541 pr " if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
5542 typ name name typ name;
5543 pr " else printf (\"%s: \\n\");\n" name
5547 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5552 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
5553 pr " print_%s (&%ss->val[i]);\n" typ typ;
5558 (* run_<action> actions *)
5560 fun (name, style, _, flags, _, _, _) ->
5561 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5563 (match fst style with
5566 | RBool _ -> pr " int r;\n"
5567 | RInt64 _ -> pr " int64_t r;\n"
5568 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5569 | RString _ -> pr " char *r;\n"
5570 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5571 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5572 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5575 pr " size_t size;\n";
5582 | FileOut n -> pr " const char *%s;\n" n
5583 | StringList n -> pr " char **%s;\n" n
5584 | Bool n -> pr " int %s;\n" n
5585 | Int n -> pr " int %s;\n" n
5588 (* Check and convert parameters. *)
5589 let argc_expected = List.length (snd style) in
5590 pr " if (argc != %d) {\n" argc_expected;
5591 pr " fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
5593 pr " fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
5599 | String name -> pr " %s = argv[%d];\n" name i
5601 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5604 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5607 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5609 | StringList name ->
5610 pr " %s = parse_string_list (argv[%d]);\n" name i
5612 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5614 pr " %s = atoi (argv[%d]);\n" name i
5617 (* Call C API function. *)
5619 try find_map (function FishAction n -> Some n | _ -> None) flags
5620 with Not_found -> sprintf "guestfs_%s" name in
5622 generate_c_call_args ~handle:"g" style;
5625 (* Check return value for errors and display command results. *)
5626 (match fst style with
5627 | RErr -> pr " return r;\n"
5629 pr " if (r == -1) return -1;\n";
5630 pr " printf (\"%%d\\n\", r);\n";
5633 pr " if (r == -1) return -1;\n";
5634 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5637 pr " if (r == -1) return -1;\n";
5638 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5641 pr " if (r == NULL) return -1;\n";
5642 pr " printf (\"%%s\\n\", r);\n";
5644 | RConstOptString _ ->
5645 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
5648 pr " if (r == NULL) return -1;\n";
5649 pr " printf (\"%%s\\n\", r);\n";
5653 pr " if (r == NULL) return -1;\n";
5654 pr " print_strings (r);\n";
5655 pr " free_strings (r);\n";
5657 | RStruct (_, typ) ->
5658 pr " if (r == NULL) return -1;\n";
5659 pr " print_%s (r);\n" typ;
5660 pr " guestfs_free_%s (r);\n" typ;
5662 | RStructList (_, typ) ->
5663 pr " if (r == NULL) return -1;\n";
5664 pr " print_%s_list (r);\n" typ;
5665 pr " guestfs_free_%s_list (r);\n" typ;
5668 pr " if (r == NULL) return -1;\n";
5669 pr " print_table (r);\n";
5670 pr " free_strings (r);\n";
5673 pr " if (r == NULL) return -1;\n";
5674 pr " fwrite (r, size, 1, stdout);\n";
5682 (* run_action function *)
5683 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
5686 fun (name, _, _, flags, _, _, _) ->
5687 let name2 = replace_char name '_' '-' in
5689 try find_map (function FishAlias n -> Some n | _ -> None) flags
5690 with Not_found -> name in
5692 pr "strcasecmp (cmd, \"%s\") == 0" name;
5693 if name <> name2 then
5694 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5695 if name <> alias then
5696 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5698 pr " return run_%s (cmd, argc, argv);\n" name;
5702 pr " fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
5709 (* Readline completion for guestfish. *)
5710 and generate_fish_completion () =
5711 generate_header CStyle GPLv2;
5715 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5725 #ifdef HAVE_LIBREADLINE
5726 #include <readline/readline.h>
5731 #ifdef HAVE_LIBREADLINE
5733 static const char *const commands[] = {
5734 BUILTIN_COMMANDS_FOR_COMPLETION,
5737 (* Get the commands, including the aliases. They don't need to be
5738 * sorted - the generator() function just does a dumb linear search.
5742 fun (name, _, _, flags, _, _, _) ->
5743 let name2 = replace_char name '_' '-' in
5745 try find_map (function FishAlias n -> Some n | _ -> None) flags
5746 with Not_found -> name in
5748 if name <> alias then [name2; alias] else [name2]
5750 let commands = List.flatten commands in
5752 List.iter (pr " \"%s\",\n") commands;
5758 generator (const char *text, int state)
5760 static int index, len;
5765 len = strlen (text);
5768 rl_attempted_completion_over = 1;
5770 while ((name = commands[index]) != NULL) {
5772 if (strncasecmp (name, text, len) == 0)
5773 return strdup (name);
5779 #endif /* HAVE_LIBREADLINE */
5781 char **do_completion (const char *text, int start, int end)
5783 char **matches = NULL;
5785 #ifdef HAVE_LIBREADLINE
5786 rl_completion_append_character = ' ';
5789 matches = rl_completion_matches (text, generator);
5790 else if (complete_dest_paths)
5791 matches = rl_completion_matches (text, complete_dest_paths_generator);
5798 (* Generate the POD documentation for guestfish. *)
5799 and generate_fish_actions_pod () =
5800 let all_functions_sorted =
5802 fun (_, _, _, flags, _, _, _) ->
5803 not (List.mem NotInFish flags || List.mem NotInDocs flags)
5804 ) all_functions_sorted in
5806 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
5809 fun (name, style, _, flags, _, _, longdesc) ->
5811 Str.global_substitute rex (
5814 try Str.matched_group 1 s
5816 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
5817 "C<" ^ replace_char sub '_' '-' ^ ">"
5819 let name = replace_char name '_' '-' in
5821 try find_map (function FishAlias n -> Some n | _ -> None) flags
5822 with Not_found -> name in
5824 pr "=head2 %s" name;
5825 if name <> alias then
5832 | String n -> pr " %s" n
5833 | OptString n -> pr " %s" n
5834 | StringList n -> pr " '%s ...'" n
5835 | Bool _ -> pr " true|false"
5836 | Int n -> pr " %s" n
5837 | FileIn n | FileOut n -> pr " (%s|-)" n
5841 pr "%s\n\n" longdesc;
5843 if List.exists (function FileIn _ | FileOut _ -> true
5844 | _ -> false) (snd style) then
5845 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
5847 if List.mem ProtocolLimitWarning flags then
5848 pr "%s\n\n" protocol_limit_warning;
5850 if List.mem DangerWillRobinson flags then
5851 pr "%s\n\n" danger_will_robinson;
5853 match deprecation_notice flags with
5855 | Some txt -> pr "%s\n\n" txt
5856 ) all_functions_sorted
5858 (* Generate a C function prototype. *)
5859 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
5860 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
5862 ?handle name style =
5863 if extern then pr "extern ";
5864 if static then pr "static ";
5865 (match fst style with
5867 | RInt _ -> pr "int "
5868 | RInt64 _ -> pr "int64_t "
5869 | RBool _ -> pr "int "
5870 | RConstString _ | RConstOptString _ -> pr "const char *"
5871 | RString _ | RBufferOut _ -> pr "char *"
5872 | RStringList _ | RHashtable _ -> pr "char **"
5873 | RStruct (_, typ) ->
5874 if not in_daemon then pr "struct guestfs_%s *" typ
5875 else pr "guestfs_int_%s *" typ
5876 | RStructList (_, typ) ->
5877 if not in_daemon then pr "struct guestfs_%s_list *" typ
5878 else pr "guestfs_int_%s_list *" typ
5880 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
5881 pr "%s%s (" prefix name;
5882 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
5885 let comma = ref false in
5888 | Some handle -> pr "guestfs_h *%s" handle; comma := true
5892 if single_line then pr ", " else pr ",\n\t\t"
5901 if not in_daemon then pr "const char *%s" n
5902 else pr "char *%s" n
5905 if not in_daemon then pr "char * const* const %s" n
5906 else pr "char **%s" n
5907 | Bool n -> next (); pr "int %s" n
5908 | Int n -> next (); pr "int %s" n
5911 if not in_daemon then (next (); pr "const char *%s" n)
5913 if is_RBufferOut then (next (); pr "size_t *size_r");
5916 if semicolon then pr ";";
5917 if newline then pr "\n"
5919 (* Generate C call arguments, eg "(handle, foo, bar)" *)
5920 and generate_c_call_args ?handle ?(decl = false) style =
5922 let comma = ref false in
5924 if !comma then pr ", ";
5929 | Some handle -> pr "%s" handle; comma := true
5934 pr "%s" (name_of_argt arg)
5936 (* For RBufferOut calls, add implicit &size parameter. *)
5938 match fst style with
5946 (* Generate the OCaml bindings interface. *)
5947 and generate_ocaml_mli () =
5948 generate_header OCamlStyle LGPLv2;
5951 (** For API documentation you should refer to the C API
5952 in the guestfs(3) manual page. The OCaml API uses almost
5953 exactly the same calls. *)
5956 (** A [guestfs_h] handle. *)
5958 exception Error of string
5959 (** This exception is raised when there is an error. *)
5961 val create : unit -> t
5963 val close : t -> unit
5964 (** Handles are closed by the garbage collector when they become
5965 unreferenced, but callers can also call this in order to
5966 provide predictable cleanup. *)
5969 generate_ocaml_structure_decls ();
5973 fun (name, style, _, _, _, shortdesc, _) ->
5974 generate_ocaml_prototype name style;
5975 pr "(** %s *)\n" shortdesc;
5979 (* Generate the OCaml bindings implementation. *)
5980 and generate_ocaml_ml () =
5981 generate_header OCamlStyle LGPLv2;
5985 exception Error of string
5986 external create : unit -> t = \"ocaml_guestfs_create\"
5987 external close : t -> unit = \"ocaml_guestfs_close\"
5990 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5994 generate_ocaml_structure_decls ();
5998 fun (name, style, _, _, _, shortdesc, _) ->
5999 generate_ocaml_prototype ~is_external:true name style;
6002 (* Generate the OCaml bindings C implementation. *)
6003 and generate_ocaml_c () =
6004 generate_header CStyle LGPLv2;
6011 #include <caml/config.h>
6012 #include <caml/alloc.h>
6013 #include <caml/callback.h>
6014 #include <caml/fail.h>
6015 #include <caml/memory.h>
6016 #include <caml/mlvalues.h>
6017 #include <caml/signals.h>
6019 #include <guestfs.h>
6021 #include \"guestfs_c.h\"
6023 /* Copy a hashtable of string pairs into an assoc-list. We return
6024 * the list in reverse order, but hashtables aren't supposed to be
6027 static CAMLprim value
6028 copy_table (char * const * argv)
6031 CAMLlocal5 (rv, pairv, kv, vv, cons);
6035 for (i = 0; argv[i] != NULL; i += 2) {
6036 kv = caml_copy_string (argv[i]);
6037 vv = caml_copy_string (argv[i+1]);
6038 pairv = caml_alloc (2, 0);
6039 Store_field (pairv, 0, kv);
6040 Store_field (pairv, 1, vv);
6041 cons = caml_alloc (2, 0);
6042 Store_field (cons, 1, rv);
6044 Store_field (cons, 0, pairv);
6052 (* Struct copy functions. *)
6055 let has_optpercent_col =
6056 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
6058 pr "static CAMLprim value\n";
6059 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
6061 pr " CAMLparam0 ();\n";
6062 if has_optpercent_col then
6063 pr " CAMLlocal3 (rv, v, v2);\n"
6065 pr " CAMLlocal2 (rv, v);\n";
6067 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
6072 pr " v = caml_copy_string (%s->%s);\n" typ name
6074 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
6075 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
6078 pr " v = caml_alloc_string (32);\n";
6079 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
6080 | name, (FBytes|FInt64|FUInt64) ->
6081 pr " v = caml_copy_int64 (%s->%s);\n" typ name
6082 | name, (FInt32|FUInt32) ->
6083 pr " v = caml_copy_int32 (%s->%s);\n" typ name
6084 | name, FOptPercent ->
6085 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
6086 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
6087 pr " v = caml_alloc (1, 0);\n";
6088 pr " Store_field (v, 0, v2);\n";
6089 pr " } else /* None */\n";
6090 pr " v = Val_int (0);\n";
6092 pr " v = Val_int (%s->%s);\n" typ name
6094 pr " Store_field (rv, %d, v);\n" i
6096 pr " CAMLreturn (rv);\n";
6100 pr "static CAMLprim value\n";
6101 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
6104 pr " CAMLparam0 ();\n";
6105 pr " CAMLlocal2 (rv, v);\n";
6108 pr " if (%ss->len == 0)\n" typ;
6109 pr " CAMLreturn (Atom (0));\n";
6111 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
6112 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6113 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
6114 pr " caml_modify (&Field (rv, i), v);\n";
6116 pr " CAMLreturn (rv);\n";
6124 fun (name, style, _, _, _, _, _) ->
6126 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
6128 let needs_extra_vs =
6129 match fst style with RConstOptString _ -> true | _ -> false in
6131 pr "CAMLprim value\n";
6132 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6133 List.iter (pr ", value %s") (List.tl params);
6138 | [p1; p2; p3; p4; p5] ->
6139 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6140 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6141 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6142 pr " CAMLxparam%d (%s);\n"
6143 (List.length rest) (String.concat ", " rest)
6145 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6147 if not needs_extra_vs then
6148 pr " CAMLlocal1 (rv);\n"
6150 pr " CAMLlocal3 (rv, v, v2);\n";
6153 pr " guestfs_h *g = Guestfs_val (gv);\n";
6154 pr " if (g == NULL)\n";
6155 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6163 pr " const char *%s = String_val (%sv);\n" n n
6165 pr " const char *%s =\n" n;
6166 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6169 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6171 pr " int %s = Bool_val (%sv);\n" n n
6173 pr " int %s = Int_val (%sv);\n" n n
6176 match fst style with
6177 | RErr -> pr " int r;\n"; "-1"
6178 | RInt _ -> pr " int r;\n"; "-1"
6179 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6180 | RBool _ -> pr " int r;\n"; "-1"
6181 | RConstString _ | RConstOptString _ ->
6182 pr " const char *r;\n"; "NULL"
6183 | RString _ -> pr " char *r;\n"; "NULL"
6188 | RStruct (_, typ) ->
6189 pr " struct guestfs_%s *r;\n" typ; "NULL"
6190 | RStructList (_, typ) ->
6191 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6198 pr " size_t size;\n";
6202 pr " caml_enter_blocking_section ();\n";
6203 pr " r = guestfs_%s " name;
6204 generate_c_call_args ~handle:"g" style;
6206 pr " caml_leave_blocking_section ();\n";
6211 pr " ocaml_guestfs_free_strings (%s);\n" n;
6212 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6215 pr " if (r == %s)\n" error_code;
6216 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6219 (match fst style with
6220 | RErr -> pr " rv = Val_unit;\n"
6221 | RInt _ -> pr " rv = Val_int (r);\n"
6223 pr " rv = caml_copy_int64 (r);\n"
6224 | RBool _ -> pr " rv = Val_bool (r);\n"
6226 pr " rv = caml_copy_string (r);\n"
6227 | RConstOptString _ ->
6228 pr " if (r) { /* Some string */\n";
6229 pr " v = caml_alloc (1, 0);\n";
6230 pr " v2 = caml_copy_string (r);\n";
6231 pr " Store_field (v, 0, v2);\n";
6232 pr " } else /* None */\n";
6233 pr " v = Val_int (0);\n";
6235 pr " rv = caml_copy_string (r);\n";
6238 pr " rv = caml_copy_string_array ((const char **) r);\n";
6239 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6241 | RStruct (_, typ) ->
6242 pr " rv = copy_%s (r);\n" typ;
6243 pr " guestfs_free_%s (r);\n" typ;
6244 | RStructList (_, typ) ->
6245 pr " rv = copy_%s_list (r);\n" typ;
6246 pr " guestfs_free_%s_list (r);\n" typ;
6248 pr " rv = copy_table (r);\n";
6249 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6252 pr " rv = caml_alloc_string (size);\n";
6253 pr " memcpy (String_val (rv), r, size);\n";
6256 pr " CAMLreturn (rv);\n";
6260 if List.length params > 5 then (
6261 pr "CAMLprim value\n";
6262 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6264 pr " return ocaml_guestfs_%s (argv[0]" name;
6265 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6272 and generate_ocaml_structure_decls () =
6275 pr "type %s = {\n" typ;
6278 | name, FString -> pr " %s : string;\n" name
6279 | name, FBuffer -> pr " %s : string;\n" name
6280 | name, FUUID -> pr " %s : string;\n" name
6281 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6282 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6283 | name, FChar -> pr " %s : char;\n" name
6284 | name, FOptPercent -> pr " %s : float option;\n" name
6290 and generate_ocaml_prototype ?(is_external = false) name style =
6291 if is_external then pr "external " else pr "val ";
6292 pr "%s : t -> " name;
6295 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6296 | OptString _ -> pr "string option -> "
6297 | StringList _ -> pr "string array -> "
6298 | Bool _ -> pr "bool -> "
6299 | Int _ -> pr "int -> "
6301 (match fst style with
6302 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6303 | RInt _ -> pr "int"
6304 | RInt64 _ -> pr "int64"
6305 | RBool _ -> pr "bool"
6306 | RConstString _ -> pr "string"
6307 | RConstOptString _ -> pr "string option"
6308 | RString _ | RBufferOut _ -> pr "string"
6309 | RStringList _ -> pr "string array"
6310 | RStruct (_, typ) -> pr "%s" typ
6311 | RStructList (_, typ) -> pr "%s array" typ
6312 | RHashtable _ -> pr "(string * string) list"
6314 if is_external then (
6316 if List.length (snd style) + 1 > 5 then
6317 pr "\"ocaml_guestfs_%s_byte\" " name;
6318 pr "\"ocaml_guestfs_%s\"" name
6322 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6323 and generate_perl_xs () =
6324 generate_header CStyle LGPLv2;
6327 #include \"EXTERN.h\"
6331 #include <guestfs.h>
6334 #define PRId64 \"lld\"
6338 my_newSVll(long long val) {
6339 #ifdef USE_64_BIT_ALL
6340 return newSViv(val);
6344 len = snprintf(buf, 100, \"%%\" PRId64, val);
6345 return newSVpv(buf, len);
6350 #define PRIu64 \"llu\"
6354 my_newSVull(unsigned long long val) {
6355 #ifdef USE_64_BIT_ALL
6356 return newSVuv(val);
6360 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6361 return newSVpv(buf, len);
6365 /* http://www.perlmonks.org/?node_id=680842 */
6367 XS_unpack_charPtrPtr (SV *arg) {
6372 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6373 croak (\"array reference expected\");
6375 av = (AV *)SvRV (arg);
6376 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6378 croak (\"malloc failed\");
6380 for (i = 0; i <= av_len (av); i++) {
6381 SV **elem = av_fetch (av, i, 0);
6383 if (!elem || !*elem)
6384 croak (\"missing element in list\");
6386 ret[i] = SvPV_nolen (*elem);
6394 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6401 RETVAL = guestfs_create ();
6403 croak (\"could not create guestfs handle\");
6404 guestfs_set_error_handler (RETVAL, NULL, NULL);
6417 fun (name, style, _, _, _, _, _) ->
6418 (match fst style with
6419 | RErr -> pr "void\n"
6420 | RInt _ -> pr "SV *\n"
6421 | RInt64 _ -> pr "SV *\n"
6422 | RBool _ -> pr "SV *\n"
6423 | RConstString _ -> pr "SV *\n"
6424 | RConstOptString _ -> pr "SV *\n"
6425 | RString _ -> pr "SV *\n"
6426 | RBufferOut _ -> pr "SV *\n"
6428 | RStruct _ | RStructList _
6430 pr "void\n" (* all lists returned implictly on the stack *)
6432 (* Call and arguments. *)
6434 generate_c_call_args ~handle:"g" ~decl:true style;
6436 pr " guestfs_h *g;\n";
6440 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6442 (* http://www.perlmonks.org/?node_id=554277
6443 * Note that the implicit handle argument means we have
6444 * to add 1 to the ST(x) operator.
6446 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6447 | StringList n -> pr " char **%s;\n" n
6448 | Bool n -> pr " int %s;\n" n
6449 | Int n -> pr " int %s;\n" n
6452 let do_cleanups () =
6455 | String _ | OptString _ | Bool _ | Int _
6456 | FileIn _ | FileOut _ -> ()
6457 | StringList n -> pr " free (%s);\n" n
6462 (match fst style with
6467 pr " r = guestfs_%s " name;
6468 generate_c_call_args ~handle:"g" style;
6471 pr " if (r == -1)\n";
6472 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6478 pr " %s = guestfs_%s " n name;
6479 generate_c_call_args ~handle:"g" style;
6482 pr " if (%s == -1)\n" n;
6483 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6484 pr " RETVAL = newSViv (%s);\n" n;
6489 pr " int64_t %s;\n" n;
6491 pr " %s = guestfs_%s " n name;
6492 generate_c_call_args ~handle:"g" style;
6495 pr " if (%s == -1)\n" n;
6496 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6497 pr " RETVAL = my_newSVll (%s);\n" n;
6502 pr " const char *%s;\n" n;
6504 pr " %s = guestfs_%s " n name;
6505 generate_c_call_args ~handle:"g" style;
6508 pr " if (%s == NULL)\n" n;
6509 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6510 pr " RETVAL = newSVpv (%s, 0);\n" n;
6513 | RConstOptString n ->
6515 pr " const char *%s;\n" n;
6517 pr " %s = guestfs_%s " n name;
6518 generate_c_call_args ~handle:"g" style;
6521 pr " if (%s == NULL)\n" n;
6522 pr " RETVAL = &PL_sv_undef;\n";
6524 pr " RETVAL = newSVpv (%s, 0);\n" n;
6529 pr " char *%s;\n" n;
6531 pr " %s = guestfs_%s " n name;
6532 generate_c_call_args ~handle:"g" style;
6535 pr " if (%s == NULL)\n" n;
6536 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6537 pr " RETVAL = newSVpv (%s, 0);\n" n;
6538 pr " free (%s);\n" n;
6541 | RStringList n | RHashtable n ->
6543 pr " char **%s;\n" n;
6546 pr " %s = guestfs_%s " n name;
6547 generate_c_call_args ~handle:"g" style;
6550 pr " if (%s == NULL)\n" n;
6551 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6552 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6553 pr " EXTEND (SP, n);\n";
6554 pr " for (i = 0; i < n; ++i) {\n";
6555 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6556 pr " free (%s[i]);\n" n;
6558 pr " free (%s);\n" n;
6559 | RStruct (n, typ) ->
6560 let cols = cols_of_struct typ in
6561 generate_perl_struct_code typ cols name style n do_cleanups
6562 | RStructList (n, typ) ->
6563 let cols = cols_of_struct typ in
6564 generate_perl_struct_list_code typ cols name style n do_cleanups
6567 pr " char *%s;\n" n;
6568 pr " size_t size;\n";
6570 pr " %s = guestfs_%s " n name;
6571 generate_c_call_args ~handle:"g" style;
6574 pr " if (%s == NULL)\n" n;
6575 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6576 pr " RETVAL = newSVpv (%s, size);\n" n;
6577 pr " free (%s);\n" n;
6585 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6587 pr " struct guestfs_%s_list *%s;\n" typ n;
6591 pr " %s = guestfs_%s " n name;
6592 generate_c_call_args ~handle:"g" style;
6595 pr " if (%s == NULL)\n" n;
6596 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6597 pr " EXTEND (SP, %s->len);\n" n;
6598 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6599 pr " hv = newHV ();\n";
6603 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6604 name (String.length name) n name
6606 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6607 name (String.length name) n name
6609 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6610 name (String.length name) n name n name
6611 | name, (FBytes|FUInt64) ->
6612 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6613 name (String.length name) n name
6615 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6616 name (String.length name) n name
6617 | name, (FInt32|FUInt32) ->
6618 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6619 name (String.length name) n name
6621 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6622 name (String.length name) n name
6623 | name, FOptPercent ->
6624 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6625 name (String.length name) n name
6627 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6629 pr " guestfs_free_%s_list (%s);\n" typ n
6631 and generate_perl_struct_code typ cols name style n do_cleanups =
6633 pr " struct guestfs_%s *%s;\n" typ n;
6635 pr " %s = guestfs_%s " n name;
6636 generate_c_call_args ~handle:"g" style;
6639 pr " if (%s == NULL)\n" n;
6640 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6641 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6643 fun ((name, _) as col) ->
6644 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6648 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6651 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6654 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6656 | name, (FBytes|FUInt64) ->
6657 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6660 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6662 | name, (FInt32|FUInt32) ->
6663 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6666 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6668 | name, FOptPercent ->
6669 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6672 pr " free (%s);\n" n
6674 (* Generate Sys/Guestfs.pm. *)
6675 and generate_perl_pm () =
6676 generate_header HashStyle LGPLv2;
6683 Sys::Guestfs - Perl bindings for libguestfs
6689 my $h = Sys::Guestfs->new ();
6690 $h->add_drive ('guest.img');
6693 $h->mount ('/dev/sda1', '/');
6694 $h->touch ('/hello');
6699 The C<Sys::Guestfs> module provides a Perl XS binding to the
6700 libguestfs API for examining and modifying virtual machine
6703 Amongst the things this is good for: making batch configuration
6704 changes to guests, getting disk used/free statistics (see also:
6705 virt-df), migrating between virtualization systems (see also:
6706 virt-p2v), performing partial backups, performing partial guest
6707 clones, cloning guests and changing registry/UUID/hostname info, and
6710 Libguestfs uses Linux kernel and qemu code, and can access any type of
6711 guest filesystem that Linux and qemu can, including but not limited
6712 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6713 schemes, qcow, qcow2, vmdk.
6715 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6716 LVs, what filesystem is in each LV, etc.). It can also run commands
6717 in the context of the guest. Also you can access filesystems over FTP.
6719 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
6720 functions for using libguestfs from Perl, including integration
6725 All errors turn into calls to C<croak> (see L<Carp(3)>).
6733 package Sys::Guestfs;
6739 XSLoader::load ('Sys::Guestfs');
6741 =item $h = Sys::Guestfs->new ();
6743 Create a new guestfs handle.
6749 my $class = ref ($proto) || $proto;
6751 my $self = Sys::Guestfs::_create ();
6752 bless $self, $class;
6758 (* Actions. We only need to print documentation for these as
6759 * they are pulled in from the XS code automatically.
6762 fun (name, style, _, flags, _, _, longdesc) ->
6763 if not (List.mem NotInDocs flags) then (
6764 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
6766 generate_perl_prototype name style;
6768 pr "%s\n\n" longdesc;
6769 if List.mem ProtocolLimitWarning flags then
6770 pr "%s\n\n" protocol_limit_warning;
6771 if List.mem DangerWillRobinson flags then
6772 pr "%s\n\n" danger_will_robinson;
6773 match deprecation_notice flags with
6775 | Some txt -> pr "%s\n\n" txt
6777 ) all_functions_sorted;
6789 Copyright (C) 2009 Red Hat Inc.
6793 Please see the file COPYING.LIB for the full license.
6799 L<http://libguestfs.org>,
6800 L<Sys::Guestfs::Lib(3)>.
6805 and generate_perl_prototype name style =
6806 (match fst style with
6814 | RBufferOut n -> pr "$%s = " n
6816 | RHashtable n -> pr "%%%s = " n
6818 | RStructList (n,_) -> pr "@%s = " n
6821 let comma = ref false in
6824 if !comma then pr ", ";
6827 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
6834 (* Generate Python C module. *)
6835 and generate_python_c () =
6836 generate_header CStyle LGPLv2;
6845 #include \"guestfs.h\"
6853 get_handle (PyObject *obj)
6856 assert (obj != Py_None);
6857 return ((Pyguestfs_Object *) obj)->g;
6861 put_handle (guestfs_h *g)
6865 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
6868 /* This list should be freed (but not the strings) after use. */
6869 static const char **
6870 get_string_list (PyObject *obj)
6877 if (!PyList_Check (obj)) {
6878 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
6882 len = PyList_Size (obj);
6883 r = malloc (sizeof (char *) * (len+1));
6885 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
6889 for (i = 0; i < len; ++i)
6890 r[i] = PyString_AsString (PyList_GetItem (obj, i));
6897 put_string_list (char * const * const argv)
6902 for (argc = 0; argv[argc] != NULL; ++argc)
6905 list = PyList_New (argc);
6906 for (i = 0; i < argc; ++i)
6907 PyList_SetItem (list, i, PyString_FromString (argv[i]));
6913 put_table (char * const * const argv)
6915 PyObject *list, *item;
6918 for (argc = 0; argv[argc] != NULL; ++argc)
6921 list = PyList_New (argc >> 1);
6922 for (i = 0; i < argc; i += 2) {
6923 item = PyTuple_New (2);
6924 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
6925 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
6926 PyList_SetItem (list, i >> 1, item);
6933 free_strings (char **argv)
6937 for (argc = 0; argv[argc] != NULL; ++argc)
6943 py_guestfs_create (PyObject *self, PyObject *args)
6947 g = guestfs_create ();
6949 PyErr_SetString (PyExc_RuntimeError,
6950 \"guestfs.create: failed to allocate handle\");
6953 guestfs_set_error_handler (g, NULL, NULL);
6954 return put_handle (g);
6958 py_guestfs_close (PyObject *self, PyObject *args)
6963 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
6965 g = get_handle (py_g);
6969 Py_INCREF (Py_None);
6975 (* Structures, turned into Python dictionaries. *)
6978 pr "static PyObject *\n";
6979 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6981 pr " PyObject *dict;\n";
6983 pr " dict = PyDict_New ();\n";
6987 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6988 pr " PyString_FromString (%s->%s));\n"
6991 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6992 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
6995 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
6996 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
6998 | name, (FBytes|FUInt64) ->
6999 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7000 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
7003 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7004 pr " PyLong_FromLongLong (%s->%s));\n"
7007 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7008 pr " PyLong_FromUnsignedLong (%s->%s));\n"
7011 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7012 pr " PyLong_FromLong (%s->%s));\n"
7014 | name, FOptPercent ->
7015 pr " if (%s->%s >= 0)\n" typ name;
7016 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7017 pr " PyFloat_FromDouble ((double) %s->%s));\n"
7020 pr " Py_INCREF (Py_None);\n";
7021 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
7024 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7025 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
7027 pr " return dict;\n";
7031 pr "static PyObject *\n";
7032 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
7034 pr " PyObject *list;\n";
7037 pr " list = PyList_New (%ss->len);\n" typ;
7038 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
7039 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
7040 pr " return list;\n";
7045 (* Python wrapper functions. *)
7047 fun (name, style, _, _, _, _, _) ->
7048 pr "static PyObject *\n";
7049 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
7052 pr " PyObject *py_g;\n";
7053 pr " guestfs_h *g;\n";
7054 pr " PyObject *py_r;\n";
7057 match fst style with
7058 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7059 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7060 | RConstString _ | RConstOptString _ ->
7061 pr " const char *r;\n"; "NULL"
7062 | RString _ -> pr " char *r;\n"; "NULL"
7063 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7064 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7065 | RStructList (_, typ) ->
7066 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7069 pr " size_t size;\n";
7074 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
7075 | OptString n -> pr " const char *%s;\n" n
7077 pr " PyObject *py_%s;\n" n;
7078 pr " const char **%s;\n" n
7079 | Bool n -> pr " int %s;\n" n
7080 | Int n -> pr " int %s;\n" n
7085 (* Convert the parameters. *)
7086 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
7089 | String _ | FileIn _ | FileOut _ -> pr "s"
7090 | OptString _ -> pr "z"
7091 | StringList _ -> pr "O"
7092 | Bool _ -> pr "i" (* XXX Python has booleans? *)
7095 pr ":guestfs_%s\",\n" name;
7099 | String n | FileIn n | FileOut n -> pr ", &%s" n
7100 | OptString n -> pr ", &%s" n
7101 | StringList n -> pr ", &py_%s" n
7102 | Bool n -> pr ", &%s" n
7103 | Int n -> pr ", &%s" n
7107 pr " return NULL;\n";
7109 pr " g = get_handle (py_g);\n";
7112 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7114 pr " %s = get_string_list (py_%s);\n" n n;
7115 pr " if (!%s) return NULL;\n" n
7120 pr " r = guestfs_%s " name;
7121 generate_c_call_args ~handle:"g" style;
7126 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7128 pr " free (%s);\n" n
7131 pr " if (r == %s) {\n" error_code;
7132 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7133 pr " return NULL;\n";
7137 (match fst style with
7139 pr " Py_INCREF (Py_None);\n";
7140 pr " py_r = Py_None;\n"
7142 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7143 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7144 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7145 | RConstOptString _ ->
7147 pr " py_r = PyString_FromString (r);\n";
7149 pr " Py_INCREF (Py_None);\n";
7150 pr " py_r = Py_None;\n";
7153 pr " py_r = PyString_FromString (r);\n";
7156 pr " py_r = put_string_list (r);\n";
7157 pr " free_strings (r);\n"
7158 | RStruct (_, typ) ->
7159 pr " py_r = put_%s (r);\n" typ;
7160 pr " guestfs_free_%s (r);\n" typ
7161 | RStructList (_, typ) ->
7162 pr " py_r = put_%s_list (r);\n" typ;
7163 pr " guestfs_free_%s_list (r);\n" typ
7165 pr " py_r = put_table (r);\n";
7166 pr " free_strings (r);\n"
7168 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7172 pr " return py_r;\n";
7177 (* Table of functions. *)
7178 pr "static PyMethodDef methods[] = {\n";
7179 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7180 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7182 fun (name, _, _, _, _, _, _) ->
7183 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7186 pr " { NULL, NULL, 0, NULL }\n";
7190 (* Init function. *)
7193 initlibguestfsmod (void)
7195 static int initialized = 0;
7197 if (initialized) return;
7198 Py_InitModule ((char *) \"libguestfsmod\", methods);
7203 (* Generate Python module. *)
7204 and generate_python_py () =
7205 generate_header HashStyle LGPLv2;
7208 u\"\"\"Python bindings for libguestfs
7211 g = guestfs.GuestFS ()
7212 g.add_drive (\"guest.img\")
7215 parts = g.list_partitions ()
7217 The guestfs module provides a Python binding to the libguestfs API
7218 for examining and modifying virtual machine disk images.
7220 Amongst the things this is good for: making batch configuration
7221 changes to guests, getting disk used/free statistics (see also:
7222 virt-df), migrating between virtualization systems (see also:
7223 virt-p2v), performing partial backups, performing partial guest
7224 clones, cloning guests and changing registry/UUID/hostname info, and
7227 Libguestfs uses Linux kernel and qemu code, and can access any type of
7228 guest filesystem that Linux and qemu can, including but not limited
7229 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7230 schemes, qcow, qcow2, vmdk.
7232 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7233 LVs, what filesystem is in each LV, etc.). It can also run commands
7234 in the context of the guest. Also you can access filesystems over FTP.
7236 Errors which happen while using the API are turned into Python
7237 RuntimeError exceptions.
7239 To create a guestfs handle you usually have to perform the following
7242 # Create the handle, call add_drive at least once, and possibly
7243 # several times if the guest has multiple block devices:
7244 g = guestfs.GuestFS ()
7245 g.add_drive (\"guest.img\")
7247 # Launch the qemu subprocess and wait for it to become ready:
7251 # Now you can issue commands, for example:
7256 import libguestfsmod
7259 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7261 def __init__ (self):
7262 \"\"\"Create a new libguestfs handle.\"\"\"
7263 self._o = libguestfsmod.create ()
7266 libguestfsmod.close (self._o)
7271 fun (name, style, _, flags, _, _, longdesc) ->
7273 generate_py_call_args ~handle:"self" (snd style);
7276 if not (List.mem NotInDocs flags) then (
7277 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7279 match fst style with
7280 | RErr | RInt _ | RInt64 _ | RBool _
7281 | RConstOptString _ | RConstString _
7282 | RString _ | RBufferOut _ -> doc
7284 doc ^ "\n\nThis function returns a list of strings."
7285 | RStruct (_, typ) ->
7286 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7287 | RStructList (_, typ) ->
7288 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7290 doc ^ "\n\nThis function returns a dictionary." in
7292 if List.mem ProtocolLimitWarning flags then
7293 doc ^ "\n\n" ^ protocol_limit_warning
7296 if List.mem DangerWillRobinson flags then
7297 doc ^ "\n\n" ^ danger_will_robinson
7300 match deprecation_notice flags with
7302 | Some txt -> doc ^ "\n\n" ^ txt in
7303 let doc = pod2text ~width:60 name doc in
7304 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7305 let doc = String.concat "\n " doc in
7306 pr " u\"\"\"%s\"\"\"\n" doc;
7308 pr " return libguestfsmod.%s " name;
7309 generate_py_call_args ~handle:"self._o" (snd style);
7314 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7315 and generate_py_call_args ~handle args =
7317 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7320 (* Useful if you need the longdesc POD text as plain text. Returns a
7323 * Because this is very slow (the slowest part of autogeneration),
7324 * we memoize the results.
7326 and pod2text ~width name longdesc =
7327 let key = width, name, longdesc in
7328 try Hashtbl.find pod2text_memo key
7330 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7331 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7333 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7334 let chan = Unix.open_process_in cmd in
7335 let lines = ref [] in
7337 let line = input_line chan in
7338 if i = 1 then (* discard the first line of output *)
7341 let line = triml line in
7342 lines := line :: !lines;
7345 let lines = try loop 1 with End_of_file -> List.rev !lines in
7346 Unix.unlink filename;
7347 (match Unix.close_process_in chan with
7348 | Unix.WEXITED 0 -> ()
7350 failwithf "pod2text: process exited with non-zero status (%d)" i
7351 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7352 failwithf "pod2text: process signalled or stopped by signal %d" i
7354 Hashtbl.add pod2text_memo key lines;
7355 let chan = open_out pod2text_memo_filename in
7356 output_value chan pod2text_memo;
7360 (* Generate ruby bindings. *)
7361 and generate_ruby_c () =
7362 generate_header CStyle LGPLv2;
7370 #include \"guestfs.h\"
7372 #include \"extconf.h\"
7374 /* For Ruby < 1.9 */
7376 #define RARRAY_LEN(r) (RARRAY((r))->len)
7379 static VALUE m_guestfs; /* guestfs module */
7380 static VALUE c_guestfs; /* guestfs_h handle */
7381 static VALUE e_Error; /* used for all errors */
7383 static void ruby_guestfs_free (void *p)
7386 guestfs_close ((guestfs_h *) p);
7389 static VALUE ruby_guestfs_create (VALUE m)
7393 g = guestfs_create ();
7395 rb_raise (e_Error, \"failed to create guestfs handle\");
7397 /* Don't print error messages to stderr by default. */
7398 guestfs_set_error_handler (g, NULL, NULL);
7400 /* Wrap it, and make sure the close function is called when the
7403 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7406 static VALUE ruby_guestfs_close (VALUE gv)
7409 Data_Get_Struct (gv, guestfs_h, g);
7411 ruby_guestfs_free (g);
7412 DATA_PTR (gv) = NULL;
7420 fun (name, style, _, _, _, _, _) ->
7421 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7422 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7425 pr " guestfs_h *g;\n";
7426 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7428 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7434 | String n | FileIn n | FileOut n ->
7435 pr " Check_Type (%sv, T_STRING);\n" n;
7436 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7438 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7439 pr " \"%s\", \"%s\");\n" n name
7441 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7443 pr " char **%s;\n" n;
7444 pr " Check_Type (%sv, T_ARRAY);\n" n;
7446 pr " int i, len;\n";
7447 pr " len = RARRAY_LEN (%sv);\n" n;
7448 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7450 pr " for (i = 0; i < len; ++i) {\n";
7451 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7452 pr " %s[i] = StringValueCStr (v);\n" n;
7454 pr " %s[len] = NULL;\n" n;
7457 pr " int %s = RTEST (%sv);\n" n n
7459 pr " int %s = NUM2INT (%sv);\n" n n
7464 match fst style with
7465 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7466 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7467 | RConstString _ | RConstOptString _ ->
7468 pr " const char *r;\n"; "NULL"
7469 | RString _ -> pr " char *r;\n"; "NULL"
7470 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7471 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7472 | RStructList (_, typ) ->
7473 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7476 pr " size_t size;\n";
7480 pr " r = guestfs_%s " name;
7481 generate_c_call_args ~handle:"g" style;
7486 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7488 pr " free (%s);\n" n
7491 pr " if (r == %s)\n" error_code;
7492 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7495 (match fst style with
7497 pr " return Qnil;\n"
7498 | RInt _ | RBool _ ->
7499 pr " return INT2NUM (r);\n"
7501 pr " return ULL2NUM (r);\n"
7503 pr " return rb_str_new2 (r);\n";
7504 | RConstOptString _ ->
7506 pr " return rb_str_new2 (r);\n";
7508 pr " return Qnil;\n";
7510 pr " VALUE rv = rb_str_new2 (r);\n";
7514 pr " int i, len = 0;\n";
7515 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7516 pr " VALUE rv = rb_ary_new2 (len);\n";
7517 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7518 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7519 pr " free (r[i]);\n";
7523 | RStruct (_, typ) ->
7524 let cols = cols_of_struct typ in
7525 generate_ruby_struct_code typ cols
7526 | RStructList (_, typ) ->
7527 let cols = cols_of_struct typ in
7528 generate_ruby_struct_list_code typ cols
7530 pr " VALUE rv = rb_hash_new ();\n";
7532 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7533 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7534 pr " free (r[i]);\n";
7535 pr " free (r[i+1]);\n";
7540 pr " VALUE rv = rb_str_new (r, size);\n";
7550 /* Initialize the module. */
7551 void Init__guestfs ()
7553 m_guestfs = rb_define_module (\"Guestfs\");
7554 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7555 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7557 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7558 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7561 (* Define the rest of the methods. *)
7563 fun (name, style, _, _, _, _, _) ->
7564 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7565 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7570 (* Ruby code to return a struct. *)
7571 and generate_ruby_struct_code typ cols =
7572 pr " VALUE rv = rb_hash_new ();\n";
7576 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7578 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7580 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7581 | name, (FBytes|FUInt64) ->
7582 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7584 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7586 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7588 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7589 | name, FOptPercent ->
7590 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7591 | name, FChar -> (* XXX wrong? *)
7592 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7594 pr " guestfs_free_%s (r);\n" typ;
7597 (* Ruby code to return a struct list. *)
7598 and generate_ruby_struct_list_code typ cols =
7599 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7601 pr " for (i = 0; i < r->len; ++i) {\n";
7602 pr " VALUE hv = rb_hash_new ();\n";
7606 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7608 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
7610 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7611 | name, (FBytes|FUInt64) ->
7612 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7614 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7616 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7618 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7619 | name, FOptPercent ->
7620 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7621 | name, FChar -> (* XXX wrong? *)
7622 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7624 pr " rb_ary_push (rv, hv);\n";
7626 pr " guestfs_free_%s_list (r);\n" typ;
7629 (* Generate Java bindings GuestFS.java file. *)
7630 and generate_java_java () =
7631 generate_header CStyle LGPLv2;
7634 package com.redhat.et.libguestfs;
7636 import java.util.HashMap;
7637 import com.redhat.et.libguestfs.LibGuestFSException;
7638 import com.redhat.et.libguestfs.PV;
7639 import com.redhat.et.libguestfs.VG;
7640 import com.redhat.et.libguestfs.LV;
7641 import com.redhat.et.libguestfs.Stat;
7642 import com.redhat.et.libguestfs.StatVFS;
7643 import com.redhat.et.libguestfs.IntBool;
7644 import com.redhat.et.libguestfs.Dirent;
7647 * The GuestFS object is a libguestfs handle.
7651 public class GuestFS {
7652 // Load the native code.
7654 System.loadLibrary (\"guestfs_jni\");
7658 * The native guestfs_h pointer.
7663 * Create a libguestfs handle.
7665 * @throws LibGuestFSException
7667 public GuestFS () throws LibGuestFSException
7671 private native long _create () throws LibGuestFSException;
7674 * Close a libguestfs handle.
7676 * You can also leave handles to be collected by the garbage
7677 * collector, but this method ensures that the resources used
7678 * by the handle are freed up immediately. If you call any
7679 * other methods after closing the handle, you will get an
7682 * @throws LibGuestFSException
7684 public void close () throws LibGuestFSException
7690 private native void _close (long g) throws LibGuestFSException;
7692 public void finalize () throws LibGuestFSException
7700 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7701 if not (List.mem NotInDocs flags); then (
7702 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7704 if List.mem ProtocolLimitWarning flags then
7705 doc ^ "\n\n" ^ protocol_limit_warning
7708 if List.mem DangerWillRobinson flags then
7709 doc ^ "\n\n" ^ danger_will_robinson
7712 match deprecation_notice flags with
7714 | Some txt -> doc ^ "\n\n" ^ txt in
7715 let doc = pod2text ~width:60 name doc in
7716 let doc = List.map ( (* RHBZ#501883 *)
7719 | nonempty -> nonempty
7721 let doc = String.concat "\n * " doc in
7724 pr " * %s\n" shortdesc;
7727 pr " * @throws LibGuestFSException\n";
7731 generate_java_prototype ~public:true ~semicolon:false name style;
7734 pr " if (g == 0)\n";
7735 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
7738 if fst style <> RErr then pr "return ";
7740 generate_java_call_args ~handle:"g" (snd style);
7744 generate_java_prototype ~privat:true ~native:true name style;
7751 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
7752 and generate_java_call_args ~handle args =
7754 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7757 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
7758 ?(semicolon=true) name style =
7759 if privat then pr "private ";
7760 if public then pr "public ";
7761 if native then pr "native ";
7764 (match fst style with
7765 | RErr -> pr "void ";
7766 | RInt _ -> pr "int ";
7767 | RInt64 _ -> pr "long ";
7768 | RBool _ -> pr "boolean ";
7769 | RConstString _ | RConstOptString _ | RString _
7770 | RBufferOut _ -> pr "String ";
7771 | RStringList _ -> pr "String[] ";
7772 | RStruct (_, typ) ->
7773 let name = java_name_of_struct typ in
7775 | RStructList (_, typ) ->
7776 let name = java_name_of_struct typ in
7778 | RHashtable _ -> pr "HashMap<String,String> ";
7781 if native then pr "_%s " name else pr "%s " name;
7783 let needs_comma = ref false in
7792 if !needs_comma then pr ", ";
7793 needs_comma := true;
7810 pr " throws LibGuestFSException";
7811 if semicolon then pr ";"
7813 and generate_java_struct jtyp cols =
7814 generate_header CStyle LGPLv2;
7817 package com.redhat.et.libguestfs;
7820 * Libguestfs %s structure.
7832 | name, FBuffer -> pr " public String %s;\n" name
7833 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
7834 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
7835 | name, FChar -> pr " public char %s;\n" name
7836 | name, FOptPercent ->
7837 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
7838 pr " public float %s;\n" name
7843 and generate_java_c () =
7844 generate_header CStyle LGPLv2;
7851 #include \"com_redhat_et_libguestfs_GuestFS.h\"
7852 #include \"guestfs.h\"
7854 /* Note that this function returns. The exception is not thrown
7855 * until after the wrapper function returns.
7858 throw_exception (JNIEnv *env, const char *msg)
7861 cl = (*env)->FindClass (env,
7862 \"com/redhat/et/libguestfs/LibGuestFSException\");
7863 (*env)->ThrowNew (env, cl, msg);
7866 JNIEXPORT jlong JNICALL
7867 Java_com_redhat_et_libguestfs_GuestFS__1create
7868 (JNIEnv *env, jobject obj)
7872 g = guestfs_create ();
7874 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
7877 guestfs_set_error_handler (g, NULL, NULL);
7878 return (jlong) (long) g;
7881 JNIEXPORT void JNICALL
7882 Java_com_redhat_et_libguestfs_GuestFS__1close
7883 (JNIEnv *env, jobject obj, jlong jg)
7885 guestfs_h *g = (guestfs_h *) (long) jg;
7892 fun (name, style, _, _, _, _, _) ->
7894 (match fst style with
7895 | RErr -> pr "void ";
7896 | RInt _ -> pr "jint ";
7897 | RInt64 _ -> pr "jlong ";
7898 | RBool _ -> pr "jboolean ";
7899 | RConstString _ | RConstOptString _ | RString _
7900 | RBufferOut _ -> pr "jstring ";
7901 | RStruct _ | RHashtable _ ->
7903 | RStringList _ | RStructList _ ->
7907 pr "Java_com_redhat_et_libguestfs_GuestFS_";
7908 pr "%s" (replace_str ("_" ^ name) "_" "_1");
7910 pr " (JNIEnv *env, jobject obj, jlong jg";
7917 pr ", jstring j%s" n
7919 pr ", jobjectArray j%s" n
7921 pr ", jboolean j%s" n
7927 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
7928 let error_code, no_ret =
7929 match fst style with
7930 | RErr -> pr " int r;\n"; "-1", ""
7932 | RInt _ -> pr " int r;\n"; "-1", "0"
7933 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
7934 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
7935 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
7937 pr " jstring jr;\n";
7938 pr " char *r;\n"; "NULL", "NULL"
7940 pr " jobjectArray jr;\n";
7943 pr " jstring jstr;\n";
7944 pr " char **r;\n"; "NULL", "NULL"
7945 | RStruct (_, typ) ->
7946 pr " jobject jr;\n";
7948 pr " jfieldID fl;\n";
7949 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
7950 | RStructList (_, typ) ->
7951 pr " jobjectArray jr;\n";
7953 pr " jfieldID fl;\n";
7954 pr " jobject jfl;\n";
7955 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
7956 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
7958 pr " jstring jr;\n";
7960 pr " size_t size;\n";
7968 pr " const char *%s;\n" n
7970 pr " int %s_len;\n" n;
7971 pr " const char **%s;\n" n
7978 (match fst style with
7979 | RStringList _ | RStructList _ -> true
7980 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
7982 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
7983 List.exists (function StringList _ -> true | _ -> false) (snd style) in
7989 (* Get the parameters. *)
7995 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
7997 (* This is completely undocumented, but Java null becomes
8000 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
8002 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
8003 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
8004 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8005 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8007 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
8009 pr " %s[%s_len] = NULL;\n" n n;
8012 pr " %s = j%s;\n" n n
8015 (* Make the call. *)
8016 pr " r = guestfs_%s " name;
8017 generate_c_call_args ~handle:"g" style;
8020 (* Release the parameters. *)
8026 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8029 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8031 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8032 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8034 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
8036 pr " free (%s);\n" n
8041 (* Check for errors. *)
8042 pr " if (r == %s) {\n" error_code;
8043 pr " throw_exception (env, guestfs_last_error (g));\n";
8044 pr " return %s;\n" no_ret;
8048 (match fst style with
8050 | RInt _ -> pr " return (jint) r;\n"
8051 | RBool _ -> pr " return (jboolean) r;\n"
8052 | RInt64 _ -> pr " return (jlong) r;\n"
8053 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
8054 | RConstOptString _ ->
8055 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
8057 pr " jr = (*env)->NewStringUTF (env, r);\n";
8061 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
8062 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
8063 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
8064 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
8065 pr " for (i = 0; i < r_len; ++i) {\n";
8066 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
8067 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
8068 pr " free (r[i]);\n";
8072 | RStruct (_, typ) ->
8073 let jtyp = java_name_of_struct typ in
8074 let cols = cols_of_struct typ in
8075 generate_java_struct_return typ jtyp cols
8076 | RStructList (_, typ) ->
8077 let jtyp = java_name_of_struct typ in
8078 let cols = cols_of_struct typ in
8079 generate_java_struct_list_return typ jtyp cols
8082 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
8083 pr " return NULL;\n"
8085 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
8094 and generate_java_struct_return typ jtyp cols =
8095 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8096 pr " jr = (*env)->AllocObject (env, cl);\n";
8100 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8101 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
8104 pr " char s[33];\n";
8105 pr " memcpy (s, r->%s, 32);\n" name;
8107 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8108 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8112 pr " int len = r->%s_len;\n" name;
8113 pr " char s[len+1];\n";
8114 pr " memcpy (s, r->%s, len);\n" name;
8115 pr " s[len] = 0;\n";
8116 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8117 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8119 | name, (FBytes|FUInt64|FInt64) ->
8120 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8121 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8122 | name, (FUInt32|FInt32) ->
8123 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8124 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8125 | name, FOptPercent ->
8126 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8127 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
8129 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8130 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8135 and generate_java_struct_list_return typ jtyp cols =
8136 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8137 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
8138 pr " for (i = 0; i < r->len; ++i) {\n";
8139 pr " jfl = (*env)->AllocObject (env, cl);\n";
8143 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8144 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8147 pr " char s[33];\n";
8148 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8150 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8151 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8155 pr " int len = r->val[i].%s_len;\n" name;
8156 pr " char s[len+1];\n";
8157 pr " memcpy (s, r->val[i].%s, len);\n" name;
8158 pr " s[len] = 0;\n";
8159 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8160 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8162 | name, (FBytes|FUInt64|FInt64) ->
8163 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8164 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8165 | name, (FUInt32|FInt32) ->
8166 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8167 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8168 | name, FOptPercent ->
8169 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8170 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8172 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8173 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8175 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8177 pr " guestfs_free_%s_list (r);\n" typ;
8180 and generate_haskell_hs () =
8181 generate_header HaskellStyle LGPLv2;
8183 (* XXX We only know how to generate partial FFI for Haskell
8184 * at the moment. Please help out!
8186 let can_generate style =
8190 | RInt64 _, _ -> true
8193 | RConstOptString _, _
8199 | RBufferOut _, _ -> false in
8202 {-# INCLUDE <guestfs.h> #-}
8203 {-# LANGUAGE ForeignFunctionInterface #-}
8208 (* List out the names of the actions we want to export. *)
8210 fun (name, style, _, _, _, _, _) ->
8211 if can_generate style then pr ",\n %s" name
8218 import Foreign.C.Types
8220 import Control.Exception
8221 import Data.Typeable
8223 data GuestfsS = GuestfsS -- represents the opaque C struct
8224 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8225 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8227 -- XXX define properly later XXX
8231 data IntBool = IntBool
8233 data StatVFS = StatVFS
8234 data Hashtable = Hashtable
8236 foreign import ccall unsafe \"guestfs_create\" c_create
8238 foreign import ccall unsafe \"&guestfs_close\" c_close
8239 :: FunPtr (GuestfsP -> IO ())
8240 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8241 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8243 create :: IO GuestfsH
8246 c_set_error_handler p nullPtr nullPtr
8247 h <- newForeignPtr c_close p
8250 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8251 :: GuestfsP -> IO CString
8253 -- last_error :: GuestfsH -> IO (Maybe String)
8254 -- last_error h = do
8255 -- str <- withForeignPtr h (\\p -> c_last_error p)
8256 -- maybePeek peekCString str
8258 last_error :: GuestfsH -> IO (String)
8260 str <- withForeignPtr h (\\p -> c_last_error p)
8262 then return \"no error\"
8263 else peekCString str
8267 (* Generate wrappers for each foreign function. *)
8269 fun (name, style, _, _, _, _, _) ->
8270 if can_generate style then (
8271 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8273 generate_haskell_prototype ~handle:"GuestfsP" style;
8277 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8279 pr "%s %s = do\n" name
8280 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8282 (* Convert pointer arguments using with* functions. *)
8287 | String n -> pr "withCString %s $ \\%s -> " n n
8288 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8289 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8290 | Bool _ | Int _ -> ()
8292 (* Convert integer arguments. *)
8296 | Bool n -> sprintf "(fromBool %s)" n
8297 | Int n -> sprintf "(fromIntegral %s)" n
8298 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8300 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8301 (String.concat " " ("p" :: args));
8302 (match fst style with
8303 | RErr | RInt _ | RInt64 _ | RBool _ ->
8304 pr " if (r == -1)\n";
8306 pr " err <- last_error h\n";
8308 | RConstString _ | RConstOptString _ | RString _
8309 | RStringList _ | RStruct _
8310 | RStructList _ | RHashtable _ | RBufferOut _ ->
8311 pr " if (r == nullPtr)\n";
8313 pr " err <- last_error h\n";
8316 (match fst style with
8318 pr " else return ()\n"
8320 pr " else return (fromIntegral r)\n"
8322 pr " else return (fromIntegral r)\n"
8324 pr " else return (toBool r)\n"
8333 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8339 and generate_haskell_prototype ~handle ?(hs = false) style =
8341 let string = if hs then "String" else "CString" in
8342 let int = if hs then "Int" else "CInt" in
8343 let bool = if hs then "Bool" else "CInt" in
8344 let int64 = if hs then "Integer" else "Int64" in
8348 | String _ -> pr "%s" string
8349 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8350 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8351 | Bool _ -> pr "%s" bool
8352 | Int _ -> pr "%s" int
8353 | FileIn _ -> pr "%s" string
8354 | FileOut _ -> pr "%s" string
8359 (match fst style with
8360 | RErr -> if not hs then pr "CInt"
8361 | RInt _ -> pr "%s" int
8362 | RInt64 _ -> pr "%s" int64
8363 | RBool _ -> pr "%s" bool
8364 | RConstString _ -> pr "%s" string
8365 | RConstOptString _ -> pr "Maybe %s" string
8366 | RString _ -> pr "%s" string
8367 | RStringList _ -> pr "[%s]" string
8368 | RStruct (_, typ) ->
8369 let name = java_name_of_struct typ in
8371 | RStructList (_, typ) ->
8372 let name = java_name_of_struct typ in
8374 | RHashtable _ -> pr "Hashtable"
8375 | RBufferOut _ -> pr "%s" string
8379 and generate_bindtests () =
8380 generate_header CStyle LGPLv2;
8385 #include <inttypes.h>
8388 #include \"guestfs.h\"
8389 #include \"guestfs_protocol.h\"
8391 #define error guestfs_error
8392 #define safe_calloc guestfs_safe_calloc
8393 #define safe_malloc guestfs_safe_malloc
8396 print_strings (char * const* const argv)
8401 for (argc = 0; argv[argc] != NULL; ++argc) {
8402 if (argc > 0) printf (\", \");
8403 printf (\"\\\"%%s\\\"\", argv[argc]);
8408 /* The test0 function prints its parameters to stdout. */
8412 match test_functions with
8413 | [] -> assert false
8414 | test0 :: tests -> test0, tests in
8417 let (name, style, _, _, _, _, _) = test0 in
8418 generate_prototype ~extern:false ~semicolon:false ~newline:true
8419 ~handle:"g" ~prefix:"guestfs_" name style;
8425 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8426 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8427 | StringList n -> pr " print_strings (%s);\n" n
8428 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8429 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8431 pr " /* Java changes stdout line buffering so we need this: */\n";
8432 pr " fflush (stdout);\n";
8438 fun (name, style, _, _, _, _, _) ->
8439 if String.sub name (String.length name - 3) 3 <> "err" then (
8440 pr "/* Test normal return. */\n";
8441 generate_prototype ~extern:false ~semicolon:false ~newline:true
8442 ~handle:"g" ~prefix:"guestfs_" name style;
8444 (match fst style with
8449 pr " sscanf (val, \"%%d\", &r);\n";
8453 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8456 pr " return strcmp (val, \"true\") == 0;\n"
8458 | RConstOptString _ ->
8459 (* Can't return the input string here. Return a static
8460 * string so we ensure we get a segfault if the caller
8463 pr " return \"static string\";\n"
8465 pr " return strdup (val);\n"
8467 pr " char **strs;\n";
8469 pr " sscanf (val, \"%%d\", &n);\n";
8470 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8471 pr " for (i = 0; i < n; ++i) {\n";
8472 pr " strs[i] = safe_malloc (g, 16);\n";
8473 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8475 pr " strs[n] = NULL;\n";
8476 pr " return strs;\n"
8477 | RStruct (_, typ) ->
8478 pr " struct guestfs_%s *r;\n" typ;
8479 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8481 | RStructList (_, typ) ->
8482 pr " struct guestfs_%s_list *r;\n" typ;
8483 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8484 pr " sscanf (val, \"%%d\", &r->len);\n";
8485 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8488 pr " char **strs;\n";
8490 pr " sscanf (val, \"%%d\", &n);\n";
8491 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8492 pr " for (i = 0; i < n; ++i) {\n";
8493 pr " strs[i*2] = safe_malloc (g, 16);\n";
8494 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8495 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8496 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8498 pr " strs[n*2] = NULL;\n";
8499 pr " return strs;\n"
8501 pr " return strdup (val);\n"
8506 pr "/* Test error return. */\n";
8507 generate_prototype ~extern:false ~semicolon:false ~newline:true
8508 ~handle:"g" ~prefix:"guestfs_" name style;
8510 pr " error (g, \"error\");\n";
8511 (match fst style with
8512 | RErr | RInt _ | RInt64 _ | RBool _ ->
8514 | RConstString _ | RConstOptString _
8515 | RString _ | RStringList _ | RStruct _
8519 pr " return NULL;\n"
8526 and generate_ocaml_bindtests () =
8527 generate_header OCamlStyle GPLv2;
8531 let g = Guestfs.create () in
8538 | CallString s -> "\"" ^ s ^ "\""
8539 | CallOptString None -> "None"
8540 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8541 | CallStringList xs ->
8542 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8543 | CallInt i when i >= 0 -> string_of_int i
8544 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8545 | CallBool b -> string_of_bool b
8550 generate_lang_bindtests (
8551 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8554 pr "print_endline \"EOF\"\n"
8556 and generate_perl_bindtests () =
8557 pr "#!/usr/bin/perl -w\n";
8558 generate_header HashStyle GPLv2;
8565 my $g = Sys::Guestfs->new ();
8569 String.concat ", " (
8572 | CallString s -> "\"" ^ s ^ "\""
8573 | CallOptString None -> "undef"
8574 | CallOptString (Some s) -> sprintf "\"%s\"" s
8575 | CallStringList xs ->
8576 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8577 | CallInt i -> string_of_int i
8578 | CallBool b -> if b then "1" else "0"
8583 generate_lang_bindtests (
8584 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8587 pr "print \"EOF\\n\"\n"
8589 and generate_python_bindtests () =
8590 generate_header HashStyle GPLv2;
8595 g = guestfs.GuestFS ()
8599 String.concat ", " (
8602 | CallString s -> "\"" ^ s ^ "\""
8603 | CallOptString None -> "None"
8604 | CallOptString (Some s) -> sprintf "\"%s\"" s
8605 | CallStringList xs ->
8606 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8607 | CallInt i -> string_of_int i
8608 | CallBool b -> if b then "1" else "0"
8613 generate_lang_bindtests (
8614 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8617 pr "print \"EOF\"\n"
8619 and generate_ruby_bindtests () =
8620 generate_header HashStyle GPLv2;
8625 g = Guestfs::create()
8629 String.concat ", " (
8632 | CallString s -> "\"" ^ s ^ "\""
8633 | CallOptString None -> "nil"
8634 | CallOptString (Some s) -> sprintf "\"%s\"" s
8635 | CallStringList xs ->
8636 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8637 | CallInt i -> string_of_int i
8638 | CallBool b -> string_of_bool b
8643 generate_lang_bindtests (
8644 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8647 pr "print \"EOF\\n\"\n"
8649 and generate_java_bindtests () =
8650 generate_header CStyle GPLv2;
8653 import com.redhat.et.libguestfs.*;
8655 public class Bindtests {
8656 public static void main (String[] argv)
8659 GuestFS g = new GuestFS ();
8663 String.concat ", " (
8666 | CallString s -> "\"" ^ s ^ "\""
8667 | CallOptString None -> "null"
8668 | CallOptString (Some s) -> sprintf "\"%s\"" s
8669 | CallStringList xs ->
8671 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8672 | CallInt i -> string_of_int i
8673 | CallBool b -> string_of_bool b
8678 generate_lang_bindtests (
8679 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8683 System.out.println (\"EOF\");
8685 catch (Exception exn) {
8686 System.err.println (exn);
8693 and generate_haskell_bindtests () =
8694 generate_header HaskellStyle GPLv2;
8697 module Bindtests where
8698 import qualified Guestfs
8708 | CallString s -> "\"" ^ s ^ "\""
8709 | CallOptString None -> "Nothing"
8710 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
8711 | CallStringList xs ->
8712 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8713 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
8714 | CallInt i -> string_of_int i
8715 | CallBool true -> "True"
8716 | CallBool false -> "False"
8721 generate_lang_bindtests (
8722 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
8725 pr " putStrLn \"EOF\"\n"
8727 (* Language-independent bindings tests - we do it this way to
8728 * ensure there is parity in testing bindings across all languages.
8730 and generate_lang_bindtests call =
8731 call "test0" [CallString "abc"; CallOptString (Some "def");
8732 CallStringList []; CallBool false;
8733 CallInt 0; CallString "123"; CallString "456"];
8734 call "test0" [CallString "abc"; CallOptString None;
8735 CallStringList []; CallBool false;
8736 CallInt 0; CallString "123"; CallString "456"];
8737 call "test0" [CallString ""; CallOptString (Some "def");
8738 CallStringList []; CallBool false;
8739 CallInt 0; CallString "123"; CallString "456"];
8740 call "test0" [CallString ""; CallOptString (Some "");
8741 CallStringList []; CallBool false;
8742 CallInt 0; CallString "123"; CallString "456"];
8743 call "test0" [CallString "abc"; CallOptString (Some "def");
8744 CallStringList ["1"]; CallBool false;
8745 CallInt 0; CallString "123"; CallString "456"];
8746 call "test0" [CallString "abc"; CallOptString (Some "def");
8747 CallStringList ["1"; "2"]; CallBool false;
8748 CallInt 0; CallString "123"; CallString "456"];
8749 call "test0" [CallString "abc"; CallOptString (Some "def");
8750 CallStringList ["1"]; CallBool true;
8751 CallInt 0; CallString "123"; CallString "456"];
8752 call "test0" [CallString "abc"; CallOptString (Some "def");
8753 CallStringList ["1"]; CallBool false;
8754 CallInt (-1); CallString "123"; CallString "456"];
8755 call "test0" [CallString "abc"; CallOptString (Some "def");
8756 CallStringList ["1"]; CallBool false;
8757 CallInt (-2); CallString "123"; CallString "456"];
8758 call "test0" [CallString "abc"; CallOptString (Some "def");
8759 CallStringList ["1"]; CallBool false;
8760 CallInt 1; CallString "123"; CallString "456"];
8761 call "test0" [CallString "abc"; CallOptString (Some "def");
8762 CallStringList ["1"]; CallBool false;
8763 CallInt 2; CallString "123"; CallString "456"];
8764 call "test0" [CallString "abc"; CallOptString (Some "def");
8765 CallStringList ["1"]; CallBool false;
8766 CallInt 4095; CallString "123"; CallString "456"];
8767 call "test0" [CallString "abc"; CallOptString (Some "def");
8768 CallStringList ["1"]; CallBool false;
8769 CallInt 0; CallString ""; CallString ""]
8771 (* XXX Add here tests of the return and error functions. *)
8773 (* This is used to generate the src/MAX_PROC_NR file which
8774 * contains the maximum procedure number, a surrogate for the
8775 * ABI version number. See src/Makefile.am for the details.
8777 and generate_max_proc_nr () =
8778 let proc_nrs = List.map (
8779 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
8780 ) daemon_functions in
8782 let max_proc_nr = List.fold_left max 0 proc_nrs in
8784 pr "%d\n" max_proc_nr
8786 let output_to filename =
8787 let filename_new = filename ^ ".new" in
8788 chan := open_out filename_new;
8793 (* Is the new file different from the current file? *)
8794 if Sys.file_exists filename && files_equal filename filename_new then
8795 Unix.unlink filename_new (* same, so skip it *)
8797 (* different, overwrite old one *)
8798 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
8799 Unix.rename filename_new filename;
8800 Unix.chmod filename 0o444;
8801 printf "written %s\n%!" filename;
8810 if not (Sys.file_exists "HACKING") then (
8812 You are probably running this from the wrong directory.
8813 Run it from the top source directory using the command
8819 let close = output_to "src/guestfs_protocol.x" in
8823 let close = output_to "src/guestfs-structs.h" in
8824 generate_structs_h ();
8827 let close = output_to "src/guestfs-actions.h" in
8828 generate_actions_h ();
8831 let close = output_to "src/guestfs-actions.c" in
8832 generate_client_actions ();
8835 let close = output_to "daemon/actions.h" in
8836 generate_daemon_actions_h ();
8839 let close = output_to "daemon/stubs.c" in
8840 generate_daemon_actions ();
8843 let close = output_to "daemon/names.c" in
8844 generate_daemon_names ();
8847 let close = output_to "capitests/tests.c" in
8851 let close = output_to "src/guestfs-bindtests.c" in
8852 generate_bindtests ();
8855 let close = output_to "fish/cmds.c" in
8856 generate_fish_cmds ();
8859 let close = output_to "fish/completion.c" in
8860 generate_fish_completion ();
8863 let close = output_to "guestfs-structs.pod" in
8864 generate_structs_pod ();
8867 let close = output_to "guestfs-actions.pod" in
8868 generate_actions_pod ();
8871 let close = output_to "guestfish-actions.pod" in
8872 generate_fish_actions_pod ();
8875 let close = output_to "ocaml/guestfs.mli" in
8876 generate_ocaml_mli ();
8879 let close = output_to "ocaml/guestfs.ml" in
8880 generate_ocaml_ml ();
8883 let close = output_to "ocaml/guestfs_c_actions.c" in
8884 generate_ocaml_c ();
8887 let close = output_to "ocaml/bindtests.ml" in
8888 generate_ocaml_bindtests ();
8891 let close = output_to "perl/Guestfs.xs" in
8892 generate_perl_xs ();
8895 let close = output_to "perl/lib/Sys/Guestfs.pm" in
8896 generate_perl_pm ();
8899 let close = output_to "perl/bindtests.pl" in
8900 generate_perl_bindtests ();
8903 let close = output_to "python/guestfs-py.c" in
8904 generate_python_c ();
8907 let close = output_to "python/guestfs.py" in
8908 generate_python_py ();
8911 let close = output_to "python/bindtests.py" in
8912 generate_python_bindtests ();
8915 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
8919 let close = output_to "ruby/bindtests.rb" in
8920 generate_ruby_bindtests ();
8923 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
8924 generate_java_java ();
8929 let cols = cols_of_struct typ in
8930 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
8931 let close = output_to filename in
8932 generate_java_struct jtyp cols;
8936 let close = output_to "java/Makefile.inc" in
8937 pr "java_built_sources =";
8940 pr " com/redhat/et/libguestfs/%s.java" jtyp;
8942 pr " com/redhat/et/libguestfs/GuestFS.java\n";
8945 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
8949 let close = output_to "java/Bindtests.java" in
8950 generate_java_bindtests ();
8953 let close = output_to "haskell/Guestfs.hs" in
8954 generate_haskell_hs ();
8957 let close = output_to "haskell/Bindtests.hs" in
8958 generate_haskell_bindtests ();
8961 let close = output_to "src/MAX_PROC_NR" in
8962 generate_max_proc_nr ();
8965 (* Always generate this file last, and unconditionally. It's used
8966 * by the Makefile to know when we must re-run the generator.
8968 let chan = open_out "src/stamp-generator" in