3 * Copyright (C) 2009-2010 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 of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
168 (* Opaque buffer which can contain arbitrary 8 bit data.
169 * In the C API, this is expressed as <char *, int> pair.
170 * Most other languages have a string type which can contain
171 * ASCII NUL. We use whatever type is appropriate for each
173 * Buffers are limited by the total message size. To transfer
174 * large blocks of data, use FileIn/FileOut parameters instead.
175 * To return an arbitrary buffer, use RBufferOut.
181 | ProtocolLimitWarning (* display warning about protocol size limits *)
182 | DangerWillRobinson (* flags particularly dangerous commands *)
183 | FishAlias of string (* provide an alias for this cmd in guestfish *)
184 | FishAction of string (* call this function in guestfish *)
185 | NotInFish (* do not export via guestfish *)
186 | NotInDocs (* do not add this function to documentation *)
187 | DeprecatedBy of string (* function is deprecated, use .. instead *)
188 | Optional of string (* function is part of an optional group *)
190 (* You can supply zero or as many tests as you want per API call.
192 * Note that the test environment has 3 block devices, of size 500MB,
193 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
194 * a fourth ISO block device with some known files on it (/dev/sdd).
196 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
197 * Number of cylinders was 63 for IDE emulated disks with precisely
198 * the same size. How exactly this is calculated is a mystery.
200 * The ISO block device (/dev/sdd) comes from images/test.iso.
202 * To be able to run the tests in a reasonable amount of time,
203 * the virtual machine and block devices are reused between tests.
204 * So don't try testing kill_subprocess :-x
206 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
208 * Don't assume anything about the previous contents of the block
209 * devices. Use 'Init*' to create some initial scenarios.
211 * You can add a prerequisite clause to any individual test. This
212 * is a run-time check, which, if it fails, causes the test to be
213 * skipped. Useful if testing a command which might not work on
214 * all variations of libguestfs builds. A test that has prerequisite
215 * of 'Always' is run unconditionally.
217 * In addition, packagers can skip individual tests by setting the
218 * environment variables: eg:
219 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
220 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
222 type tests = (test_init * test_prereq * test) list
224 (* Run the command sequence and just expect nothing to fail. *)
227 (* Run the command sequence and expect the output of the final
228 * command to be the string.
230 | TestOutput of seq * string
232 (* Run the command sequence and expect the output of the final
233 * command to be the list of strings.
235 | TestOutputList of seq * string list
237 (* Run the command sequence and expect the output of the final
238 * command to be the list of block devices (could be either
239 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
240 * character of each string).
242 | TestOutputListOfDevices of seq * string list
244 (* Run the command sequence and expect the output of the final
245 * command to be the integer.
247 | TestOutputInt of seq * int
249 (* Run the command sequence and expect the output of the final
250 * command to be <op> <int>, eg. ">=", "1".
252 | TestOutputIntOp of seq * string * int
254 (* Run the command sequence and expect the output of the final
255 * command to be a true value (!= 0 or != NULL).
257 | TestOutputTrue of seq
259 (* Run the command sequence and expect the output of the final
260 * command to be a false value (== 0 or == NULL, but not an error).
262 | TestOutputFalse of seq
264 (* Run the command sequence and expect the output of the final
265 * command to be a list of the given length (but don't care about
268 | TestOutputLength of seq * int
270 (* Run the command sequence and expect the output of the final
271 * command to be a buffer (RBufferOut), ie. string + size.
273 | TestOutputBuffer of seq * string
275 (* Run the command sequence and expect the output of the final
276 * command to be a structure.
278 | TestOutputStruct of seq * test_field_compare list
280 (* Run the command sequence and expect the final command (only)
283 | TestLastFail of seq
285 and test_field_compare =
286 | CompareWithInt of string * int
287 | CompareWithIntOp of string * string * int
288 | CompareWithString of string * string
289 | CompareFieldsIntEq of string * string
290 | CompareFieldsStrEq of string * string
292 (* Test prerequisites. *)
294 (* Test always runs. *)
297 (* Test is currently disabled - eg. it fails, or it tests some
298 * unimplemented feature.
302 (* 'string' is some C code (a function body) that should return
303 * true or false. The test will run if the code returns true.
307 (* As for 'If' but the test runs _unless_ the code returns true. *)
310 (* Run the test only if 'string' is available in the daemon. *)
311 | IfAvailable of string
313 (* Some initial scenarios for testing. *)
315 (* Do nothing, block devices could contain random stuff including
316 * LVM PVs, and some filesystems might be mounted. This is usually
321 (* Block devices are empty and no filesystems are mounted. *)
324 (* /dev/sda contains a single partition /dev/sda1, with random
325 * content. /dev/sdb and /dev/sdc may have random content.
330 (* /dev/sda contains a single partition /dev/sda1, which is formatted
331 * as ext2, empty [except for lost+found] and mounted on /.
332 * /dev/sdb and /dev/sdc may have random content.
338 * /dev/sda1 (is a PV):
339 * /dev/VG/LV (size 8MB):
340 * formatted as ext2, empty [except for lost+found], mounted on /
341 * /dev/sdb and /dev/sdc may have random content.
345 (* /dev/sdd (the ISO, see images/ directory in source)
350 (* Sequence of commands for testing. *)
352 and cmd = string list
354 (* Note about long descriptions: When referring to another
355 * action, use the format C<guestfs_other> (ie. the full name of
356 * the C function). This will be replaced as appropriate in other
359 * Apart from that, long descriptions are just perldoc paragraphs.
362 (* Generate a random UUID (used in tests). *)
364 let chan = open_process_in "uuidgen" in
365 let uuid = input_line chan in
366 (match close_process_in chan with
369 failwith "uuidgen: process exited with non-zero status"
370 | WSIGNALED _ | WSTOPPED _ ->
371 failwith "uuidgen: process signalled or stopped by signal"
375 (* These test functions are used in the language binding tests. *)
377 let test_all_args = [
380 StringList "strlist";
388 let test_all_rets = [
389 (* except for RErr, which is tested thoroughly elsewhere *)
390 "test0rint", RInt "valout";
391 "test0rint64", RInt64 "valout";
392 "test0rbool", RBool "valout";
393 "test0rconststring", RConstString "valout";
394 "test0rconstoptstring", RConstOptString "valout";
395 "test0rstring", RString "valout";
396 "test0rstringlist", RStringList "valout";
397 "test0rstruct", RStruct ("valout", "lvm_pv");
398 "test0rstructlist", RStructList ("valout", "lvm_pv");
399 "test0rhashtable", RHashtable "valout";
402 let test_functions = [
403 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
405 "internal test function - do not use",
407 This is an internal test function which is used to test whether
408 the automatically generated bindings can handle every possible
409 parameter type correctly.
411 It echos the contents of each parameter to stdout.
413 You probably don't want to call this function.");
417 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
419 "internal test function - do not use",
421 This is an internal test function which is used to test whether
422 the automatically generated bindings can handle every possible
423 return type correctly.
425 It converts string C<val> to the return type.
427 You probably don't want to call this function.");
428 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 This function always returns an error.
438 You probably don't want to call this function.")]
442 (* non_daemon_functions are any functions which don't get processed
443 * in the daemon, eg. functions for setting and getting local
444 * configuration values.
447 let non_daemon_functions = test_functions @ [
448 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
450 "launch the qemu subprocess",
452 Internally libguestfs is implemented by running a virtual machine
455 You should call this after configuring the handle
456 (eg. adding drives) but before performing any actions.");
458 ("wait_ready", (RErr, []), -1, [NotInFish],
460 "wait until the qemu subprocess launches (no op)",
462 This function is a no op.
464 In versions of the API E<lt> 1.0.71 you had to call this function
465 just after calling C<guestfs_launch> to wait for the launch
466 to complete. However this is no longer necessary because
467 C<guestfs_launch> now does the waiting.
469 If you see any calls to this function in code then you can just
470 remove them, unless you want to retain compatibility with older
471 versions of the API.");
473 ("kill_subprocess", (RErr, []), -1, [],
475 "kill the qemu subprocess",
477 This kills the qemu subprocess. You should never need to call this.");
479 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
481 "add an image to examine or modify",
483 This function adds a virtual machine disk image C<filename> to the
484 guest. The first time you call this function, the disk appears as IDE
485 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
488 You don't necessarily need to be root when using libguestfs. However
489 you obviously do need sufficient permissions to access the filename
490 for whatever operations you want to perform (ie. read access if you
491 just want to read the image or write access if you want to modify the
494 This is equivalent to the qemu parameter
495 C<-drive file=filename,cache=off,if=...>.
497 C<cache=off> is omitted in cases where it is not supported by
498 the underlying filesystem.
500 C<if=...> is set at compile time by the configuration option
501 C<./configure --with-drive-if=...>. In the rare case where you
502 might need to change this at run time, use C<guestfs_add_drive_with_if>
503 or C<guestfs_add_drive_ro_with_if>.
505 Note that this call checks for the existence of C<filename>. This
506 stops you from specifying other types of drive which are supported
507 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
508 the general C<guestfs_config> call instead.");
510 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
512 "add a CD-ROM disk image to examine",
514 This function adds a virtual CD-ROM disk image to the guest.
516 This is equivalent to the qemu parameter C<-cdrom filename>.
524 This call checks for the existence of C<filename>. This
525 stops you from specifying other types of drive which are supported
526 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
527 the general C<guestfs_config> call instead.
531 If you just want to add an ISO file (often you use this as an
532 efficient way to transfer large files into the guest), then you
533 should probably use C<guestfs_add_drive_ro> instead.
537 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
539 "add a drive in snapshot mode (read-only)",
541 This adds a drive in snapshot mode, making it effectively
544 Note that writes to the device are allowed, and will be seen for
545 the duration of the guestfs handle, but they are written
546 to a temporary file which is discarded as soon as the guestfs
547 handle is closed. We don't currently have any method to enable
548 changes to be committed, although qemu can support this.
550 This is equivalent to the qemu parameter
551 C<-drive file=filename,snapshot=on,if=...>.
553 C<if=...> is set at compile time by the configuration option
554 C<./configure --with-drive-if=...>. In the rare case where you
555 might need to change this at run time, use C<guestfs_add_drive_with_if>
556 or C<guestfs_add_drive_ro_with_if>.
558 Note that this call checks for the existence of C<filename>. This
559 stops you from specifying other types of drive which are supported
560 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
561 the general C<guestfs_config> call instead.");
563 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
565 "add qemu parameters",
567 This can be used to add arbitrary qemu command line parameters
568 of the form C<-param value>. Actually it's not quite arbitrary - we
569 prevent you from setting some parameters which would interfere with
570 parameters that we use.
572 The first character of C<param> string must be a C<-> (dash).
574 C<value> can be NULL.");
576 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
578 "set the qemu binary",
580 Set the qemu binary that we will use.
582 The default is chosen when the library was compiled by the
585 You can also override this by setting the C<LIBGUESTFS_QEMU>
586 environment variable.
588 Setting C<qemu> to C<NULL> restores the default qemu binary.
590 Note that you should call this function as early as possible
591 after creating the handle. This is because some pre-launch
592 operations depend on testing qemu features (by running C<qemu -help>).
593 If the qemu binary changes, we don't retest features, and
594 so you might see inconsistent results. Using the environment
595 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
596 the qemu binary at the same time as the handle is created.");
598 ("get_qemu", (RConstString "qemu", []), -1, [],
599 [InitNone, Always, TestRun (
601 "get the qemu binary",
603 Return the current qemu binary.
605 This is always non-NULL. If it wasn't set already, then this will
606 return the default qemu binary name.");
608 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
610 "set the search path",
612 Set the path that libguestfs searches for kernel and initrd.img.
614 The default is C<$libdir/guestfs> unless overridden by setting
615 C<LIBGUESTFS_PATH> environment variable.
617 Setting C<path> to C<NULL> restores the default path.");
619 ("get_path", (RConstString "path", []), -1, [],
620 [InitNone, Always, TestRun (
622 "get the search path",
624 Return the current search path.
626 This is always non-NULL. If it wasn't set already, then this will
627 return the default path.");
629 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
631 "add options to kernel command line",
633 This function is used to add additional options to the
634 guest kernel command line.
636 The default is C<NULL> unless overridden by setting
637 C<LIBGUESTFS_APPEND> environment variable.
639 Setting C<append> to C<NULL> means I<no> additional options
640 are passed (libguestfs always adds a few of its own).");
642 ("get_append", (RConstOptString "append", []), -1, [],
643 (* This cannot be tested with the current framework. The
644 * function can return NULL in normal operations, which the
645 * test framework interprets as an error.
648 "get the additional kernel options",
650 Return the additional kernel options which are added to the
651 guest kernel command line.
653 If C<NULL> then no options are added.");
655 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
659 If C<autosync> is true, this enables autosync. Libguestfs will make a
660 best effort attempt to run C<guestfs_umount_all> followed by
661 C<guestfs_sync> when the handle is closed
662 (also if the program exits without closing handles).
664 This is disabled by default (except in guestfish where it is
665 enabled by default).");
667 ("get_autosync", (RBool "autosync", []), -1, [],
668 [InitNone, Always, TestRun (
669 [["get_autosync"]])],
672 Get the autosync flag.");
674 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
678 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
680 Verbose messages are disabled unless the environment variable
681 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
683 ("get_verbose", (RBool "verbose", []), -1, [],
687 This returns the verbose messages flag.");
689 ("is_ready", (RBool "ready", []), -1, [],
690 [InitNone, Always, TestOutputTrue (
692 "is ready to accept commands",
694 This returns true iff this handle is ready to accept commands
695 (in the C<READY> state).
697 For more information on states, see L<guestfs(3)>.");
699 ("is_config", (RBool "config", []), -1, [],
700 [InitNone, Always, TestOutputFalse (
702 "is in configuration state",
704 This returns true iff this handle is being configured
705 (in the C<CONFIG> state).
707 For more information on states, see L<guestfs(3)>.");
709 ("is_launching", (RBool "launching", []), -1, [],
710 [InitNone, Always, TestOutputFalse (
711 [["is_launching"]])],
712 "is launching subprocess",
714 This returns true iff this handle is launching the subprocess
715 (in the C<LAUNCHING> state).
717 For more information on states, see L<guestfs(3)>.");
719 ("is_busy", (RBool "busy", []), -1, [],
720 [InitNone, Always, TestOutputFalse (
722 "is busy processing a command",
724 This returns true iff this handle is busy processing a command
725 (in the C<BUSY> state).
727 For more information on states, see L<guestfs(3)>.");
729 ("get_state", (RInt "state", []), -1, [],
731 "get the current state",
733 This returns the current state as an opaque integer. This is
734 only useful for printing debug and internal error messages.
736 For more information on states, see L<guestfs(3)>.");
738 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
739 [InitNone, Always, TestOutputInt (
740 [["set_memsize"; "500"];
741 ["get_memsize"]], 500)],
742 "set memory allocated to the qemu subprocess",
744 This sets the memory size in megabytes allocated to the
745 qemu subprocess. This only has any effect if called before
748 You can also change this by setting the environment
749 variable C<LIBGUESTFS_MEMSIZE> before the handle is
752 For more information on the architecture of libguestfs,
753 see L<guestfs(3)>.");
755 ("get_memsize", (RInt "memsize", []), -1, [],
756 [InitNone, Always, TestOutputIntOp (
757 [["get_memsize"]], ">=", 256)],
758 "get memory allocated to the qemu subprocess",
760 This gets the memory size in megabytes allocated to the
763 If C<guestfs_set_memsize> was not called
764 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
765 then this returns the compiled-in default value for memsize.
767 For more information on the architecture of libguestfs,
768 see L<guestfs(3)>.");
770 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
771 [InitNone, Always, TestOutputIntOp (
772 [["get_pid"]], ">=", 1)],
773 "get PID of qemu subprocess",
775 Return the process ID of the qemu subprocess. If there is no
776 qemu subprocess, then this will return an error.
778 This is an internal call used for debugging and testing.");
780 ("version", (RStruct ("version", "version"), []), -1, [],
781 [InitNone, Always, TestOutputStruct (
782 [["version"]], [CompareWithInt ("major", 1)])],
783 "get the library version number",
785 Return the libguestfs version number that the program is linked
788 Note that because of dynamic linking this is not necessarily
789 the version of libguestfs that you compiled against. You can
790 compile the program, and then at runtime dynamically link
791 against a completely different C<libguestfs.so> library.
793 This call was added in version C<1.0.58>. In previous
794 versions of libguestfs there was no way to get the version
795 number. From C code you can use dynamic linker functions
796 to find out if this symbol exists (if it doesn't, then
797 it's an earlier version).
799 The call returns a structure with four elements. The first
800 three (C<major>, C<minor> and C<release>) are numbers and
801 correspond to the usual version triplet. The fourth element
802 (C<extra>) is a string and is normally empty, but may be
803 used for distro-specific information.
805 To construct the original version string:
806 C<$major.$minor.$release$extra>
808 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
810 I<Note:> Don't use this call to test for availability
811 of features. In enterprise distributions we backport
812 features from later versions into earlier versions,
813 making this an unreliable way to test for features.
814 Use C<guestfs_available> instead.");
816 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
817 [InitNone, Always, TestOutputTrue (
818 [["set_selinux"; "true"];
820 "set SELinux enabled or disabled at appliance boot",
822 This sets the selinux flag that is passed to the appliance
823 at boot time. The default is C<selinux=0> (disabled).
825 Note that if SELinux is enabled, it is always in
826 Permissive mode (C<enforcing=0>).
828 For more information on the architecture of libguestfs,
829 see L<guestfs(3)>.");
831 ("get_selinux", (RBool "selinux", []), -1, [],
833 "get SELinux enabled flag",
835 This returns the current setting of the selinux flag which
836 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
838 For more information on the architecture of libguestfs,
839 see L<guestfs(3)>.");
841 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
842 [InitNone, Always, TestOutputFalse (
843 [["set_trace"; "false"];
845 "enable or disable command traces",
847 If the command trace flag is set to 1, then commands are
848 printed on stdout before they are executed in a format
849 which is very similar to the one used by guestfish. In
850 other words, you can run a program with this enabled, and
851 you will get out a script which you can feed to guestfish
852 to perform the same set of actions.
854 If you want to trace C API calls into libguestfs (and
855 other libraries) then possibly a better way is to use
856 the external ltrace(1) command.
858 Command traces are disabled unless the environment variable
859 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
861 ("get_trace", (RBool "trace", []), -1, [],
863 "get command trace enabled flag",
865 Return the command trace flag.");
867 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
868 [InitNone, Always, TestOutputFalse (
869 [["set_direct"; "false"];
871 "enable or disable direct appliance mode",
873 If the direct appliance mode flag is enabled, then stdin and
874 stdout are passed directly through to the appliance once it
877 One consequence of this is that log messages aren't caught
878 by the library and handled by C<guestfs_set_log_message_callback>,
879 but go straight to stdout.
881 You probably don't want to use this unless you know what you
884 The default is disabled.");
886 ("get_direct", (RBool "direct", []), -1, [],
888 "get direct appliance mode flag",
890 Return the direct appliance mode flag.");
892 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
893 [InitNone, Always, TestOutputTrue (
894 [["set_recovery_proc"; "true"];
895 ["get_recovery_proc"]])],
896 "enable or disable the recovery process",
898 If this is called with the parameter C<false> then
899 C<guestfs_launch> does not create a recovery process. The
900 purpose of the recovery process is to stop runaway qemu
901 processes in the case where the main program aborts abruptly.
903 This only has any effect if called before C<guestfs_launch>,
904 and the default is true.
906 About the only time when you would want to disable this is
907 if the main process will fork itself into the background
908 (\"daemonize\" itself). In this case the recovery process
909 thinks that the main program has disappeared and so kills
910 qemu, which is not very helpful.");
912 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
914 "get recovery process enabled flag",
916 Return the recovery process enabled flag.");
918 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
920 "add a drive specifying the QEMU block emulation to use",
922 This is the same as C<guestfs_add_drive> but it allows you
923 to specify the QEMU interface emulation to use at run time.");
925 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
927 "add a drive read-only specifying the QEMU block emulation to use",
929 This is the same as C<guestfs_add_drive_ro> but it allows you
930 to specify the QEMU interface emulation to use at run time.");
934 (* daemon_functions are any functions which cause some action
935 * to take place in the daemon.
938 let daemon_functions = [
939 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
940 [InitEmpty, Always, TestOutput (
941 [["part_disk"; "/dev/sda"; "mbr"];
942 ["mkfs"; "ext2"; "/dev/sda1"];
943 ["mount"; "/dev/sda1"; "/"];
944 ["write_file"; "/new"; "new file contents"; "0"];
945 ["cat"; "/new"]], "new file contents")],
946 "mount a guest disk at a position in the filesystem",
948 Mount a guest disk at a position in the filesystem. Block devices
949 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
950 the guest. If those block devices contain partitions, they will have
951 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
954 The rules are the same as for L<mount(2)>: A filesystem must
955 first be mounted on C</> before others can be mounted. Other
956 filesystems can only be mounted on directories which already
959 The mounted filesystem is writable, if we have sufficient permissions
960 on the underlying device.
963 When you use this call, the filesystem options C<sync> and C<noatime>
964 are set implicitly. This was originally done because we thought it
965 would improve reliability, but it turns out that I<-o sync> has a
966 very large negative performance impact and negligible effect on
967 reliability. Therefore we recommend that you avoid using
968 C<guestfs_mount> in any code that needs performance, and instead
969 use C<guestfs_mount_options> (use an empty string for the first
970 parameter if you don't want any options).");
972 ("sync", (RErr, []), 2, [],
973 [ InitEmpty, Always, TestRun [["sync"]]],
974 "sync disks, writes are flushed through to the disk image",
976 This syncs the disk, so that any writes are flushed through to the
977 underlying disk image.
979 You should always call this if you have modified a disk image, before
980 closing the handle.");
982 ("touch", (RErr, [Pathname "path"]), 3, [],
983 [InitBasicFS, Always, TestOutputTrue (
985 ["exists"; "/new"]])],
986 "update file timestamps or create a new file",
988 Touch acts like the L<touch(1)> command. It can be used to
989 update the timestamps on a file, or, if the file does not exist,
990 to create a new zero-length file.");
992 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
993 [InitISOFS, Always, TestOutput (
994 [["cat"; "/known-2"]], "abcdef\n")],
995 "list the contents of a file",
997 Return the contents of the file named C<path>.
999 Note that this function cannot correctly handle binary files
1000 (specifically, files containing C<\\0> character which is treated
1001 as end of string). For those you need to use the C<guestfs_read_file>
1002 or C<guestfs_download> functions which have a more complex interface.");
1004 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1005 [], (* XXX Tricky to test because it depends on the exact format
1006 * of the 'ls -l' command, which changes between F10 and F11.
1008 "list the files in a directory (long format)",
1010 List the files in C<directory> (relative to the root directory,
1011 there is no cwd) in the format of 'ls -la'.
1013 This command is mostly useful for interactive sessions. It
1014 is I<not> intended that you try to parse the output string.");
1016 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1017 [InitBasicFS, Always, TestOutputList (
1019 ["touch"; "/newer"];
1020 ["touch"; "/newest"];
1021 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1022 "list the files in a directory",
1024 List the files in C<directory> (relative to the root directory,
1025 there is no cwd). The '.' and '..' entries are not returned, but
1026 hidden files are shown.
1028 This command is mostly useful for interactive sessions. Programs
1029 should probably use C<guestfs_readdir> instead.");
1031 ("list_devices", (RStringList "devices", []), 7, [],
1032 [InitEmpty, Always, TestOutputListOfDevices (
1033 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1034 "list the block devices",
1036 List all the block devices.
1038 The full block device names are returned, eg. C</dev/sda>");
1040 ("list_partitions", (RStringList "partitions", []), 8, [],
1041 [InitBasicFS, Always, TestOutputListOfDevices (
1042 [["list_partitions"]], ["/dev/sda1"]);
1043 InitEmpty, Always, TestOutputListOfDevices (
1044 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1045 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1046 "list the partitions",
1048 List all the partitions detected on all block devices.
1050 The full partition device names are returned, eg. C</dev/sda1>
1052 This does not return logical volumes. For that you will need to
1053 call C<guestfs_lvs>.");
1055 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1056 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1057 [["pvs"]], ["/dev/sda1"]);
1058 InitEmpty, Always, TestOutputListOfDevices (
1059 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1060 ["pvcreate"; "/dev/sda1"];
1061 ["pvcreate"; "/dev/sda2"];
1062 ["pvcreate"; "/dev/sda3"];
1063 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1064 "list the LVM physical volumes (PVs)",
1066 List all the physical volumes detected. This is the equivalent
1067 of the L<pvs(8)> command.
1069 This returns a list of just the device names that contain
1070 PVs (eg. C</dev/sda2>).
1072 See also C<guestfs_pvs_full>.");
1074 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1075 [InitBasicFSonLVM, Always, TestOutputList (
1077 InitEmpty, Always, TestOutputList (
1078 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1079 ["pvcreate"; "/dev/sda1"];
1080 ["pvcreate"; "/dev/sda2"];
1081 ["pvcreate"; "/dev/sda3"];
1082 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1083 ["vgcreate"; "VG2"; "/dev/sda3"];
1084 ["vgs"]], ["VG1"; "VG2"])],
1085 "list the LVM volume groups (VGs)",
1087 List all the volumes groups detected. This is the equivalent
1088 of the L<vgs(8)> command.
1090 This returns a list of just the volume group names that were
1091 detected (eg. C<VolGroup00>).
1093 See also C<guestfs_vgs_full>.");
1095 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1096 [InitBasicFSonLVM, Always, TestOutputList (
1097 [["lvs"]], ["/dev/VG/LV"]);
1098 InitEmpty, Always, TestOutputList (
1099 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1100 ["pvcreate"; "/dev/sda1"];
1101 ["pvcreate"; "/dev/sda2"];
1102 ["pvcreate"; "/dev/sda3"];
1103 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1104 ["vgcreate"; "VG2"; "/dev/sda3"];
1105 ["lvcreate"; "LV1"; "VG1"; "50"];
1106 ["lvcreate"; "LV2"; "VG1"; "50"];
1107 ["lvcreate"; "LV3"; "VG2"; "50"];
1108 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1109 "list the LVM logical volumes (LVs)",
1111 List all the logical volumes detected. This is the equivalent
1112 of the L<lvs(8)> command.
1114 This returns a list of the logical volume device names
1115 (eg. C</dev/VolGroup00/LogVol00>).
1117 See also C<guestfs_lvs_full>.");
1119 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1120 [], (* XXX how to test? *)
1121 "list the LVM physical volumes (PVs)",
1123 List all the physical volumes detected. This is the equivalent
1124 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1126 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1127 [], (* XXX how to test? *)
1128 "list the LVM volume groups (VGs)",
1130 List all the volumes groups detected. This is the equivalent
1131 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1133 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1134 [], (* XXX how to test? *)
1135 "list the LVM logical volumes (LVs)",
1137 List all the logical volumes detected. This is the equivalent
1138 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1140 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1141 [InitISOFS, Always, TestOutputList (
1142 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1143 InitISOFS, Always, TestOutputList (
1144 [["read_lines"; "/empty"]], [])],
1145 "read file as lines",
1147 Return the contents of the file named C<path>.
1149 The file contents are returned as a list of lines. Trailing
1150 C<LF> and C<CRLF> character sequences are I<not> returned.
1152 Note that this function cannot correctly handle binary files
1153 (specifically, files containing C<\\0> character which is treated
1154 as end of line). For those you need to use the C<guestfs_read_file>
1155 function which has a more complex interface.");
1157 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1158 [], (* XXX Augeas code needs tests. *)
1159 "create a new Augeas handle",
1161 Create a new Augeas handle for editing configuration files.
1162 If there was any previous Augeas handle associated with this
1163 guestfs session, then it is closed.
1165 You must call this before using any other C<guestfs_aug_*>
1168 C<root> is the filesystem root. C<root> must not be NULL,
1171 The flags are the same as the flags defined in
1172 E<lt>augeas.hE<gt>, the logical I<or> of the following
1177 =item C<AUG_SAVE_BACKUP> = 1
1179 Keep the original file with a C<.augsave> extension.
1181 =item C<AUG_SAVE_NEWFILE> = 2
1183 Save changes into a file with extension C<.augnew>, and
1184 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1186 =item C<AUG_TYPE_CHECK> = 4
1188 Typecheck lenses (can be expensive).
1190 =item C<AUG_NO_STDINC> = 8
1192 Do not use standard load path for modules.
1194 =item C<AUG_SAVE_NOOP> = 16
1196 Make save a no-op, just record what would have been changed.
1198 =item C<AUG_NO_LOAD> = 32
1200 Do not load the tree in C<guestfs_aug_init>.
1204 To close the handle, you can call C<guestfs_aug_close>.
1206 To find out more about Augeas, see L<http://augeas.net/>.");
1208 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1209 [], (* XXX Augeas code needs tests. *)
1210 "close the current Augeas handle",
1212 Close the current Augeas handle and free up any resources
1213 used by it. After calling this, you have to call
1214 C<guestfs_aug_init> again before you can use any other
1215 Augeas functions.");
1217 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1218 [], (* XXX Augeas code needs tests. *)
1219 "define an Augeas variable",
1221 Defines an Augeas variable C<name> whose value is the result
1222 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1225 On success this returns the number of nodes in C<expr>, or
1226 C<0> if C<expr> evaluates to something which is not a nodeset.");
1228 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1229 [], (* XXX Augeas code needs tests. *)
1230 "define an Augeas node",
1232 Defines a variable C<name> whose value is the result of
1235 If C<expr> evaluates to an empty nodeset, a node is created,
1236 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1237 C<name> will be the nodeset containing that single node.
1239 On success this returns a pair containing the
1240 number of nodes in the nodeset, and a boolean flag
1241 if a node was created.");
1243 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1244 [], (* XXX Augeas code needs tests. *)
1245 "look up the value of an Augeas path",
1247 Look up the value associated with C<path>. If C<path>
1248 matches exactly one node, the C<value> is returned.");
1250 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1251 [], (* XXX Augeas code needs tests. *)
1252 "set Augeas path to value",
1254 Set the value associated with C<path> to C<value>.");
1256 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1257 [], (* XXX Augeas code needs tests. *)
1258 "insert a sibling Augeas node",
1260 Create a new sibling C<label> for C<path>, inserting it into
1261 the tree before or after C<path> (depending on the boolean
1264 C<path> must match exactly one existing node in the tree, and
1265 C<label> must be a label, ie. not contain C</>, C<*> or end
1266 with a bracketed index C<[N]>.");
1268 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1269 [], (* XXX Augeas code needs tests. *)
1270 "remove an Augeas path",
1272 Remove C<path> and all of its children.
1274 On success this returns the number of entries which were removed.");
1276 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1277 [], (* XXX Augeas code needs tests. *)
1280 Move the node C<src> to C<dest>. C<src> must match exactly
1281 one node. C<dest> is overwritten if it exists.");
1283 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1284 [], (* XXX Augeas code needs tests. *)
1285 "return Augeas nodes which match augpath",
1287 Returns a list of paths which match the path expression C<path>.
1288 The returned paths are sufficiently qualified so that they match
1289 exactly one node in the current tree.");
1291 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1292 [], (* XXX Augeas code needs tests. *)
1293 "write all pending Augeas changes to disk",
1295 This writes all pending changes to disk.
1297 The flags which were passed to C<guestfs_aug_init> affect exactly
1298 how files are saved.");
1300 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1301 [], (* XXX Augeas code needs tests. *)
1302 "load files into the tree",
1304 Load files into the tree.
1306 See C<aug_load> in the Augeas documentation for the full gory
1309 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1310 [], (* XXX Augeas code needs tests. *)
1311 "list Augeas nodes under augpath",
1313 This is just a shortcut for listing C<guestfs_aug_match>
1314 C<path/*> and sorting the resulting nodes into alphabetical order.");
1316 ("rm", (RErr, [Pathname "path"]), 29, [],
1317 [InitBasicFS, Always, TestRun
1320 InitBasicFS, Always, TestLastFail
1322 InitBasicFS, Always, TestLastFail
1327 Remove the single file C<path>.");
1329 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1330 [InitBasicFS, Always, TestRun
1333 InitBasicFS, Always, TestLastFail
1334 [["rmdir"; "/new"]];
1335 InitBasicFS, Always, TestLastFail
1337 ["rmdir"; "/new"]]],
1338 "remove a directory",
1340 Remove the single directory C<path>.");
1342 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1343 [InitBasicFS, Always, TestOutputFalse
1345 ["mkdir"; "/new/foo"];
1346 ["touch"; "/new/foo/bar"];
1348 ["exists"; "/new"]]],
1349 "remove a file or directory recursively",
1351 Remove the file or directory C<path>, recursively removing the
1352 contents if its a directory. This is like the C<rm -rf> shell
1355 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1356 [InitBasicFS, Always, TestOutputTrue
1358 ["is_dir"; "/new"]];
1359 InitBasicFS, Always, TestLastFail
1360 [["mkdir"; "/new/foo/bar"]]],
1361 "create a directory",
1363 Create a directory named C<path>.");
1365 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1366 [InitBasicFS, Always, TestOutputTrue
1367 [["mkdir_p"; "/new/foo/bar"];
1368 ["is_dir"; "/new/foo/bar"]];
1369 InitBasicFS, Always, TestOutputTrue
1370 [["mkdir_p"; "/new/foo/bar"];
1371 ["is_dir"; "/new/foo"]];
1372 InitBasicFS, Always, TestOutputTrue
1373 [["mkdir_p"; "/new/foo/bar"];
1374 ["is_dir"; "/new"]];
1375 (* Regression tests for RHBZ#503133: *)
1376 InitBasicFS, Always, TestRun
1378 ["mkdir_p"; "/new"]];
1379 InitBasicFS, Always, TestLastFail
1381 ["mkdir_p"; "/new"]]],
1382 "create a directory and parents",
1384 Create a directory named C<path>, creating any parent directories
1385 as necessary. This is like the C<mkdir -p> shell command.");
1387 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1388 [], (* XXX Need stat command to test *)
1391 Change the mode (permissions) of C<path> to C<mode>. Only
1392 numeric modes are supported.
1394 I<Note>: When using this command from guestfish, C<mode>
1395 by default would be decimal, unless you prefix it with
1396 C<0> to get octal, ie. use C<0700> not C<700>.
1398 The mode actually set is affected by the umask.");
1400 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1401 [], (* XXX Need stat command to test *)
1402 "change file owner and group",
1404 Change the file owner to C<owner> and group to C<group>.
1406 Only numeric uid and gid are supported. If you want to use
1407 names, you will need to locate and parse the password file
1408 yourself (Augeas support makes this relatively easy).");
1410 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1411 [InitISOFS, Always, TestOutputTrue (
1412 [["exists"; "/empty"]]);
1413 InitISOFS, Always, TestOutputTrue (
1414 [["exists"; "/directory"]])],
1415 "test if file or directory exists",
1417 This returns C<true> if and only if there is a file, directory
1418 (or anything) with the given C<path> name.
1420 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1422 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1423 [InitISOFS, Always, TestOutputTrue (
1424 [["is_file"; "/known-1"]]);
1425 InitISOFS, Always, TestOutputFalse (
1426 [["is_file"; "/directory"]])],
1427 "test if file exists",
1429 This returns C<true> if and only if there is a file
1430 with the given C<path> name. Note that it returns false for
1431 other objects like directories.
1433 See also C<guestfs_stat>.");
1435 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1436 [InitISOFS, Always, TestOutputFalse (
1437 [["is_dir"; "/known-3"]]);
1438 InitISOFS, Always, TestOutputTrue (
1439 [["is_dir"; "/directory"]])],
1440 "test if file exists",
1442 This returns C<true> if and only if there is a directory
1443 with the given C<path> name. Note that it returns false for
1444 other objects like files.
1446 See also C<guestfs_stat>.");
1448 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1449 [InitEmpty, Always, TestOutputListOfDevices (
1450 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1451 ["pvcreate"; "/dev/sda1"];
1452 ["pvcreate"; "/dev/sda2"];
1453 ["pvcreate"; "/dev/sda3"];
1454 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1455 "create an LVM physical volume",
1457 This creates an LVM physical volume on the named C<device>,
1458 where C<device> should usually be a partition name such
1461 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1462 [InitEmpty, Always, TestOutputList (
1463 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1464 ["pvcreate"; "/dev/sda1"];
1465 ["pvcreate"; "/dev/sda2"];
1466 ["pvcreate"; "/dev/sda3"];
1467 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1468 ["vgcreate"; "VG2"; "/dev/sda3"];
1469 ["vgs"]], ["VG1"; "VG2"])],
1470 "create an LVM volume group",
1472 This creates an LVM volume group called C<volgroup>
1473 from the non-empty list of physical volumes C<physvols>.");
1475 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1476 [InitEmpty, Always, TestOutputList (
1477 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1478 ["pvcreate"; "/dev/sda1"];
1479 ["pvcreate"; "/dev/sda2"];
1480 ["pvcreate"; "/dev/sda3"];
1481 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1482 ["vgcreate"; "VG2"; "/dev/sda3"];
1483 ["lvcreate"; "LV1"; "VG1"; "50"];
1484 ["lvcreate"; "LV2"; "VG1"; "50"];
1485 ["lvcreate"; "LV3"; "VG2"; "50"];
1486 ["lvcreate"; "LV4"; "VG2"; "50"];
1487 ["lvcreate"; "LV5"; "VG2"; "50"];
1489 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1490 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1491 "create an LVM logical volume",
1493 This creates an LVM logical volume called C<logvol>
1494 on the volume group C<volgroup>, with C<size> megabytes.");
1496 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1497 [InitEmpty, Always, TestOutput (
1498 [["part_disk"; "/dev/sda"; "mbr"];
1499 ["mkfs"; "ext2"; "/dev/sda1"];
1500 ["mount_options"; ""; "/dev/sda1"; "/"];
1501 ["write_file"; "/new"; "new file contents"; "0"];
1502 ["cat"; "/new"]], "new file contents")],
1503 "make a filesystem",
1505 This creates a filesystem on C<device> (usually a partition
1506 or LVM logical volume). The filesystem type is C<fstype>, for
1509 ("sfdisk", (RErr, [Device "device";
1510 Int "cyls"; Int "heads"; Int "sectors";
1511 StringList "lines"]), 43, [DangerWillRobinson],
1513 "create partitions on a block device",
1515 This is a direct interface to the L<sfdisk(8)> program for creating
1516 partitions on block devices.
1518 C<device> should be a block device, for example C</dev/sda>.
1520 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1521 and sectors on the device, which are passed directly to sfdisk as
1522 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1523 of these, then the corresponding parameter is omitted. Usually for
1524 'large' disks, you can just pass C<0> for these, but for small
1525 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1526 out the right geometry and you will need to tell it.
1528 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1529 information refer to the L<sfdisk(8)> manpage.
1531 To create a single partition occupying the whole disk, you would
1532 pass C<lines> as a single element list, when the single element being
1533 the string C<,> (comma).
1535 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1536 C<guestfs_part_init>");
1538 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1539 [InitBasicFS, Always, TestOutput (
1540 [["write_file"; "/new"; "new file contents"; "0"];
1541 ["cat"; "/new"]], "new file contents");
1542 InitBasicFS, Always, TestOutput (
1543 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1544 ["cat"; "/new"]], "\nnew file contents\n");
1545 InitBasicFS, Always, TestOutput (
1546 [["write_file"; "/new"; "\n\n"; "0"];
1547 ["cat"; "/new"]], "\n\n");
1548 InitBasicFS, Always, TestOutput (
1549 [["write_file"; "/new"; ""; "0"];
1550 ["cat"; "/new"]], "");
1551 InitBasicFS, Always, TestOutput (
1552 [["write_file"; "/new"; "\n\n\n"; "0"];
1553 ["cat"; "/new"]], "\n\n\n");
1554 InitBasicFS, Always, TestOutput (
1555 [["write_file"; "/new"; "\n"; "0"];
1556 ["cat"; "/new"]], "\n");
1557 (* Regression test for RHBZ#597135. *)
1558 InitBasicFS, Always, TestLastFail
1559 [["write_file"; "/new"; "abc"; "10000"]]],
1562 This call creates a file called C<path>. The contents of the
1563 file is the string C<content> (which can contain any 8 bit data),
1564 with length C<size>.
1566 As a special case, if C<size> is C<0>
1567 then the length is calculated using C<strlen> (so in this case
1568 the content cannot contain embedded ASCII NULs).
1570 I<NB.> Owing to a bug, writing content containing ASCII NUL
1571 characters does I<not> work, even if the length is specified.
1572 We hope to resolve this bug in a future version. In the meantime
1573 use C<guestfs_upload>.");
1575 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1576 [InitEmpty, Always, TestOutputListOfDevices (
1577 [["part_disk"; "/dev/sda"; "mbr"];
1578 ["mkfs"; "ext2"; "/dev/sda1"];
1579 ["mount_options"; ""; "/dev/sda1"; "/"];
1580 ["mounts"]], ["/dev/sda1"]);
1581 InitEmpty, Always, TestOutputList (
1582 [["part_disk"; "/dev/sda"; "mbr"];
1583 ["mkfs"; "ext2"; "/dev/sda1"];
1584 ["mount_options"; ""; "/dev/sda1"; "/"];
1587 "unmount a filesystem",
1589 This unmounts the given filesystem. The filesystem may be
1590 specified either by its mountpoint (path) or the device which
1591 contains the filesystem.");
1593 ("mounts", (RStringList "devices", []), 46, [],
1594 [InitBasicFS, Always, TestOutputListOfDevices (
1595 [["mounts"]], ["/dev/sda1"])],
1596 "show mounted filesystems",
1598 This returns the list of currently mounted filesystems. It returns
1599 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1601 Some internal mounts are not shown.
1603 See also: C<guestfs_mountpoints>");
1605 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1606 [InitBasicFS, Always, TestOutputList (
1609 (* check that umount_all can unmount nested mounts correctly: *)
1610 InitEmpty, Always, TestOutputList (
1611 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1612 ["mkfs"; "ext2"; "/dev/sda1"];
1613 ["mkfs"; "ext2"; "/dev/sda2"];
1614 ["mkfs"; "ext2"; "/dev/sda3"];
1615 ["mount_options"; ""; "/dev/sda1"; "/"];
1617 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1618 ["mkdir"; "/mp1/mp2"];
1619 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1620 ["mkdir"; "/mp1/mp2/mp3"];
1623 "unmount all filesystems",
1625 This unmounts all mounted filesystems.
1627 Some internal mounts are not unmounted by this call.");
1629 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1631 "remove all LVM LVs, VGs and PVs",
1633 This command removes all LVM logical volumes, volume groups
1634 and physical volumes.");
1636 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1637 [InitISOFS, Always, TestOutput (
1638 [["file"; "/empty"]], "empty");
1639 InitISOFS, Always, TestOutput (
1640 [["file"; "/known-1"]], "ASCII text");
1641 InitISOFS, Always, TestLastFail (
1642 [["file"; "/notexists"]])],
1643 "determine file type",
1645 This call uses the standard L<file(1)> command to determine
1646 the type or contents of the file. This also works on devices,
1647 for example to find out whether a partition contains a filesystem.
1649 This call will also transparently look inside various types
1652 The exact command which runs is C<file -zbsL path>. Note in
1653 particular that the filename is not prepended to the output
1654 (the C<-b> option).");
1656 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1657 [InitBasicFS, Always, TestOutput (
1658 [["upload"; "test-command"; "/test-command"];
1659 ["chmod"; "0o755"; "/test-command"];
1660 ["command"; "/test-command 1"]], "Result1");
1661 InitBasicFS, Always, TestOutput (
1662 [["upload"; "test-command"; "/test-command"];
1663 ["chmod"; "0o755"; "/test-command"];
1664 ["command"; "/test-command 2"]], "Result2\n");
1665 InitBasicFS, Always, TestOutput (
1666 [["upload"; "test-command"; "/test-command"];
1667 ["chmod"; "0o755"; "/test-command"];
1668 ["command"; "/test-command 3"]], "\nResult3");
1669 InitBasicFS, Always, TestOutput (
1670 [["upload"; "test-command"; "/test-command"];
1671 ["chmod"; "0o755"; "/test-command"];
1672 ["command"; "/test-command 4"]], "\nResult4\n");
1673 InitBasicFS, Always, TestOutput (
1674 [["upload"; "test-command"; "/test-command"];
1675 ["chmod"; "0o755"; "/test-command"];
1676 ["command"; "/test-command 5"]], "\nResult5\n\n");
1677 InitBasicFS, Always, TestOutput (
1678 [["upload"; "test-command"; "/test-command"];
1679 ["chmod"; "0o755"; "/test-command"];
1680 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1681 InitBasicFS, Always, TestOutput (
1682 [["upload"; "test-command"; "/test-command"];
1683 ["chmod"; "0o755"; "/test-command"];
1684 ["command"; "/test-command 7"]], "");
1685 InitBasicFS, Always, TestOutput (
1686 [["upload"; "test-command"; "/test-command"];
1687 ["chmod"; "0o755"; "/test-command"];
1688 ["command"; "/test-command 8"]], "\n");
1689 InitBasicFS, Always, TestOutput (
1690 [["upload"; "test-command"; "/test-command"];
1691 ["chmod"; "0o755"; "/test-command"];
1692 ["command"; "/test-command 9"]], "\n\n");
1693 InitBasicFS, Always, TestOutput (
1694 [["upload"; "test-command"; "/test-command"];
1695 ["chmod"; "0o755"; "/test-command"];
1696 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1697 InitBasicFS, Always, TestOutput (
1698 [["upload"; "test-command"; "/test-command"];
1699 ["chmod"; "0o755"; "/test-command"];
1700 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1701 InitBasicFS, Always, TestLastFail (
1702 [["upload"; "test-command"; "/test-command"];
1703 ["chmod"; "0o755"; "/test-command"];
1704 ["command"; "/test-command"]])],
1705 "run a command from the guest filesystem",
1707 This call runs a command from the guest filesystem. The
1708 filesystem must be mounted, and must contain a compatible
1709 operating system (ie. something Linux, with the same
1710 or compatible processor architecture).
1712 The single parameter is an argv-style list of arguments.
1713 The first element is the name of the program to run.
1714 Subsequent elements are parameters. The list must be
1715 non-empty (ie. must contain a program name). Note that
1716 the command runs directly, and is I<not> invoked via
1717 the shell (see C<guestfs_sh>).
1719 The return value is anything printed to I<stdout> by
1722 If the command returns a non-zero exit status, then
1723 this function returns an error message. The error message
1724 string is the content of I<stderr> from the command.
1726 The C<$PATH> environment variable will contain at least
1727 C</usr/bin> and C</bin>. If you require a program from
1728 another location, you should provide the full path in the
1731 Shared libraries and data files required by the program
1732 must be available on filesystems which are mounted in the
1733 correct places. It is the caller's responsibility to ensure
1734 all filesystems that are needed are mounted at the right
1737 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1738 [InitBasicFS, Always, TestOutputList (
1739 [["upload"; "test-command"; "/test-command"];
1740 ["chmod"; "0o755"; "/test-command"];
1741 ["command_lines"; "/test-command 1"]], ["Result1"]);
1742 InitBasicFS, Always, TestOutputList (
1743 [["upload"; "test-command"; "/test-command"];
1744 ["chmod"; "0o755"; "/test-command"];
1745 ["command_lines"; "/test-command 2"]], ["Result2"]);
1746 InitBasicFS, Always, TestOutputList (
1747 [["upload"; "test-command"; "/test-command"];
1748 ["chmod"; "0o755"; "/test-command"];
1749 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1750 InitBasicFS, Always, TestOutputList (
1751 [["upload"; "test-command"; "/test-command"];
1752 ["chmod"; "0o755"; "/test-command"];
1753 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1754 InitBasicFS, Always, TestOutputList (
1755 [["upload"; "test-command"; "/test-command"];
1756 ["chmod"; "0o755"; "/test-command"];
1757 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1758 InitBasicFS, Always, TestOutputList (
1759 [["upload"; "test-command"; "/test-command"];
1760 ["chmod"; "0o755"; "/test-command"];
1761 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1762 InitBasicFS, Always, TestOutputList (
1763 [["upload"; "test-command"; "/test-command"];
1764 ["chmod"; "0o755"; "/test-command"];
1765 ["command_lines"; "/test-command 7"]], []);
1766 InitBasicFS, Always, TestOutputList (
1767 [["upload"; "test-command"; "/test-command"];
1768 ["chmod"; "0o755"; "/test-command"];
1769 ["command_lines"; "/test-command 8"]], [""]);
1770 InitBasicFS, Always, TestOutputList (
1771 [["upload"; "test-command"; "/test-command"];
1772 ["chmod"; "0o755"; "/test-command"];
1773 ["command_lines"; "/test-command 9"]], ["";""]);
1774 InitBasicFS, Always, TestOutputList (
1775 [["upload"; "test-command"; "/test-command"];
1776 ["chmod"; "0o755"; "/test-command"];
1777 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1778 InitBasicFS, Always, TestOutputList (
1779 [["upload"; "test-command"; "/test-command"];
1780 ["chmod"; "0o755"; "/test-command"];
1781 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1782 "run a command, returning lines",
1784 This is the same as C<guestfs_command>, but splits the
1785 result into a list of lines.
1787 See also: C<guestfs_sh_lines>");
1789 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1790 [InitISOFS, Always, TestOutputStruct (
1791 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1792 "get file information",
1794 Returns file information for the given C<path>.
1796 This is the same as the C<stat(2)> system call.");
1798 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1799 [InitISOFS, Always, TestOutputStruct (
1800 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1801 "get file information for a symbolic link",
1803 Returns file information for the given C<path>.
1805 This is the same as C<guestfs_stat> except that if C<path>
1806 is a symbolic link, then the link is stat-ed, not the file it
1809 This is the same as the C<lstat(2)> system call.");
1811 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1812 [InitISOFS, Always, TestOutputStruct (
1813 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1814 "get file system statistics",
1816 Returns file system statistics for any mounted file system.
1817 C<path> should be a file or directory in the mounted file system
1818 (typically it is the mount point itself, but it doesn't need to be).
1820 This is the same as the C<statvfs(2)> system call.");
1822 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1824 "get ext2/ext3/ext4 superblock details",
1826 This returns the contents of the ext2, ext3 or ext4 filesystem
1827 superblock on C<device>.
1829 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1830 manpage for more details. The list of fields returned isn't
1831 clearly defined, and depends on both the version of C<tune2fs>
1832 that libguestfs was built against, and the filesystem itself.");
1834 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1835 [InitEmpty, Always, TestOutputTrue (
1836 [["blockdev_setro"; "/dev/sda"];
1837 ["blockdev_getro"; "/dev/sda"]])],
1838 "set block device to read-only",
1840 Sets the block device named C<device> to read-only.
1842 This uses the L<blockdev(8)> command.");
1844 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1845 [InitEmpty, Always, TestOutputFalse (
1846 [["blockdev_setrw"; "/dev/sda"];
1847 ["blockdev_getro"; "/dev/sda"]])],
1848 "set block device to read-write",
1850 Sets the block device named C<device> to read-write.
1852 This uses the L<blockdev(8)> command.");
1854 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1855 [InitEmpty, Always, TestOutputTrue (
1856 [["blockdev_setro"; "/dev/sda"];
1857 ["blockdev_getro"; "/dev/sda"]])],
1858 "is block device set to read-only",
1860 Returns a boolean indicating if the block device is read-only
1861 (true if read-only, false if not).
1863 This uses the L<blockdev(8)> command.");
1865 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1866 [InitEmpty, Always, TestOutputInt (
1867 [["blockdev_getss"; "/dev/sda"]], 512)],
1868 "get sectorsize of block device",
1870 This returns the size of sectors on a block device.
1871 Usually 512, but can be larger for modern devices.
1873 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1876 This uses the L<blockdev(8)> command.");
1878 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1879 [InitEmpty, Always, TestOutputInt (
1880 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1881 "get blocksize of block device",
1883 This returns the block size of a device.
1885 (Note this is different from both I<size in blocks> and
1886 I<filesystem block size>).
1888 This uses the L<blockdev(8)> command.");
1890 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1892 "set blocksize of block device",
1894 This sets the block size of a device.
1896 (Note this is different from both I<size in blocks> and
1897 I<filesystem block size>).
1899 This uses the L<blockdev(8)> command.");
1901 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1902 [InitEmpty, Always, TestOutputInt (
1903 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1904 "get total size of device in 512-byte sectors",
1906 This returns the size of the device in units of 512-byte sectors
1907 (even if the sectorsize isn't 512 bytes ... weird).
1909 See also C<guestfs_blockdev_getss> for the real sector size of
1910 the device, and C<guestfs_blockdev_getsize64> for the more
1911 useful I<size in bytes>.
1913 This uses the L<blockdev(8)> command.");
1915 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1916 [InitEmpty, Always, TestOutputInt (
1917 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1918 "get total size of device in bytes",
1920 This returns the size of the device in bytes.
1922 See also C<guestfs_blockdev_getsz>.
1924 This uses the L<blockdev(8)> command.");
1926 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1927 [InitEmpty, Always, TestRun
1928 [["blockdev_flushbufs"; "/dev/sda"]]],
1929 "flush device buffers",
1931 This tells the kernel to flush internal buffers associated
1934 This uses the L<blockdev(8)> command.");
1936 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1937 [InitEmpty, Always, TestRun
1938 [["blockdev_rereadpt"; "/dev/sda"]]],
1939 "reread partition table",
1941 Reread the partition table on C<device>.
1943 This uses the L<blockdev(8)> command.");
1945 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1946 [InitBasicFS, Always, TestOutput (
1947 (* Pick a file from cwd which isn't likely to change. *)
1948 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1949 ["checksum"; "md5"; "/COPYING.LIB"]],
1950 Digest.to_hex (Digest.file "COPYING.LIB"))],
1951 "upload a file from the local machine",
1953 Upload local file C<filename> to C<remotefilename> on the
1956 C<filename> can also be a named pipe.
1958 See also C<guestfs_download>.");
1960 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1961 [InitBasicFS, Always, TestOutput (
1962 (* Pick a file from cwd which isn't likely to change. *)
1963 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1964 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1965 ["upload"; "testdownload.tmp"; "/upload"];
1966 ["checksum"; "md5"; "/upload"]],
1967 Digest.to_hex (Digest.file "COPYING.LIB"))],
1968 "download a file to the local machine",
1970 Download file C<remotefilename> and save it as C<filename>
1971 on the local machine.
1973 C<filename> can also be a named pipe.
1975 See also C<guestfs_upload>, C<guestfs_cat>.");
1977 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1978 [InitISOFS, Always, TestOutput (
1979 [["checksum"; "crc"; "/known-3"]], "2891671662");
1980 InitISOFS, Always, TestLastFail (
1981 [["checksum"; "crc"; "/notexists"]]);
1982 InitISOFS, Always, TestOutput (
1983 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1984 InitISOFS, Always, TestOutput (
1985 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1986 InitISOFS, Always, TestOutput (
1987 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1988 InitISOFS, Always, TestOutput (
1989 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1990 InitISOFS, Always, TestOutput (
1991 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1992 InitISOFS, Always, TestOutput (
1993 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1994 "compute MD5, SHAx or CRC checksum of file",
1996 This call computes the MD5, SHAx or CRC checksum of the
1999 The type of checksum to compute is given by the C<csumtype>
2000 parameter which must have one of the following values:
2006 Compute the cyclic redundancy check (CRC) specified by POSIX
2007 for the C<cksum> command.
2011 Compute the MD5 hash (using the C<md5sum> program).
2015 Compute the SHA1 hash (using the C<sha1sum> program).
2019 Compute the SHA224 hash (using the C<sha224sum> program).
2023 Compute the SHA256 hash (using the C<sha256sum> program).
2027 Compute the SHA384 hash (using the C<sha384sum> program).
2031 Compute the SHA512 hash (using the C<sha512sum> program).
2035 The checksum is returned as a printable string.");
2037 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
2038 [InitBasicFS, Always, TestOutput (
2039 [["tar_in"; "../images/helloworld.tar"; "/"];
2040 ["cat"; "/hello"]], "hello\n")],
2041 "unpack tarfile to directory",
2043 This command uploads and unpacks local file C<tarfile> (an
2044 I<uncompressed> tar file) into C<directory>.
2046 To upload a compressed tarball, use C<guestfs_tgz_in>.");
2048 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2050 "pack directory into tarfile",
2052 This command packs the contents of C<directory> and downloads
2053 it to local file C<tarfile>.
2055 To download a compressed tarball, use C<guestfs_tgz_out>.");
2057 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
2058 [InitBasicFS, Always, TestOutput (
2059 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2060 ["cat"; "/hello"]], "hello\n")],
2061 "unpack compressed tarball to directory",
2063 This command uploads and unpacks local file C<tarball> (a
2064 I<gzip compressed> tar file) into C<directory>.
2066 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2068 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2070 "pack directory into compressed tarball",
2072 This command packs the contents of C<directory> and downloads
2073 it to local file C<tarball>.
2075 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2077 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2078 [InitBasicFS, Always, TestLastFail (
2080 ["mount_ro"; "/dev/sda1"; "/"];
2081 ["touch"; "/new"]]);
2082 InitBasicFS, Always, TestOutput (
2083 [["write_file"; "/new"; "data"; "0"];
2085 ["mount_ro"; "/dev/sda1"; "/"];
2086 ["cat"; "/new"]], "data")],
2087 "mount a guest disk, read-only",
2089 This is the same as the C<guestfs_mount> command, but it
2090 mounts the filesystem with the read-only (I<-o ro>) flag.");
2092 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2094 "mount a guest disk with mount options",
2096 This is the same as the C<guestfs_mount> command, but it
2097 allows you to set the mount options as for the
2098 L<mount(8)> I<-o> flag.
2100 If the C<options> parameter is an empty string, then
2101 no options are passed (all options default to whatever
2102 the filesystem uses).");
2104 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2106 "mount a guest disk with mount options and vfstype",
2108 This is the same as the C<guestfs_mount> command, but it
2109 allows you to set both the mount options and the vfstype
2110 as for the L<mount(8)> I<-o> and I<-t> flags.");
2112 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2114 "debugging and internals",
2116 The C<guestfs_debug> command exposes some internals of
2117 C<guestfsd> (the guestfs daemon) that runs inside the
2120 There is no comprehensive help for this command. You have
2121 to look at the file C<daemon/debug.c> in the libguestfs source
2122 to find out what you can do.");
2124 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2125 [InitEmpty, Always, TestOutputList (
2126 [["part_disk"; "/dev/sda"; "mbr"];
2127 ["pvcreate"; "/dev/sda1"];
2128 ["vgcreate"; "VG"; "/dev/sda1"];
2129 ["lvcreate"; "LV1"; "VG"; "50"];
2130 ["lvcreate"; "LV2"; "VG"; "50"];
2131 ["lvremove"; "/dev/VG/LV1"];
2132 ["lvs"]], ["/dev/VG/LV2"]);
2133 InitEmpty, Always, TestOutputList (
2134 [["part_disk"; "/dev/sda"; "mbr"];
2135 ["pvcreate"; "/dev/sda1"];
2136 ["vgcreate"; "VG"; "/dev/sda1"];
2137 ["lvcreate"; "LV1"; "VG"; "50"];
2138 ["lvcreate"; "LV2"; "VG"; "50"];
2139 ["lvremove"; "/dev/VG"];
2141 InitEmpty, Always, TestOutputList (
2142 [["part_disk"; "/dev/sda"; "mbr"];
2143 ["pvcreate"; "/dev/sda1"];
2144 ["vgcreate"; "VG"; "/dev/sda1"];
2145 ["lvcreate"; "LV1"; "VG"; "50"];
2146 ["lvcreate"; "LV2"; "VG"; "50"];
2147 ["lvremove"; "/dev/VG"];
2149 "remove an LVM logical volume",
2151 Remove an LVM logical volume C<device>, where C<device> is
2152 the path to the LV, such as C</dev/VG/LV>.
2154 You can also remove all LVs in a volume group by specifying
2155 the VG name, C</dev/VG>.");
2157 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2158 [InitEmpty, Always, TestOutputList (
2159 [["part_disk"; "/dev/sda"; "mbr"];
2160 ["pvcreate"; "/dev/sda1"];
2161 ["vgcreate"; "VG"; "/dev/sda1"];
2162 ["lvcreate"; "LV1"; "VG"; "50"];
2163 ["lvcreate"; "LV2"; "VG"; "50"];
2166 InitEmpty, Always, TestOutputList (
2167 [["part_disk"; "/dev/sda"; "mbr"];
2168 ["pvcreate"; "/dev/sda1"];
2169 ["vgcreate"; "VG"; "/dev/sda1"];
2170 ["lvcreate"; "LV1"; "VG"; "50"];
2171 ["lvcreate"; "LV2"; "VG"; "50"];
2174 "remove an LVM volume group",
2176 Remove an LVM volume group C<vgname>, (for example C<VG>).
2178 This also forcibly removes all logical volumes in the volume
2181 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2182 [InitEmpty, Always, TestOutputListOfDevices (
2183 [["part_disk"; "/dev/sda"; "mbr"];
2184 ["pvcreate"; "/dev/sda1"];
2185 ["vgcreate"; "VG"; "/dev/sda1"];
2186 ["lvcreate"; "LV1"; "VG"; "50"];
2187 ["lvcreate"; "LV2"; "VG"; "50"];
2189 ["pvremove"; "/dev/sda1"];
2191 InitEmpty, Always, TestOutputListOfDevices (
2192 [["part_disk"; "/dev/sda"; "mbr"];
2193 ["pvcreate"; "/dev/sda1"];
2194 ["vgcreate"; "VG"; "/dev/sda1"];
2195 ["lvcreate"; "LV1"; "VG"; "50"];
2196 ["lvcreate"; "LV2"; "VG"; "50"];
2198 ["pvremove"; "/dev/sda1"];
2200 InitEmpty, Always, TestOutputListOfDevices (
2201 [["part_disk"; "/dev/sda"; "mbr"];
2202 ["pvcreate"; "/dev/sda1"];
2203 ["vgcreate"; "VG"; "/dev/sda1"];
2204 ["lvcreate"; "LV1"; "VG"; "50"];
2205 ["lvcreate"; "LV2"; "VG"; "50"];
2207 ["pvremove"; "/dev/sda1"];
2209 "remove an LVM physical volume",
2211 This wipes a physical volume C<device> so that LVM will no longer
2214 The implementation uses the C<pvremove> command which refuses to
2215 wipe physical volumes that contain any volume groups, so you have
2216 to remove those first.");
2218 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2219 [InitBasicFS, Always, TestOutput (
2220 [["set_e2label"; "/dev/sda1"; "testlabel"];
2221 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2222 "set the ext2/3/4 filesystem label",
2224 This sets the ext2/3/4 filesystem label of the filesystem on
2225 C<device> to C<label>. Filesystem labels are limited to
2228 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2229 to return the existing label on a filesystem.");
2231 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2233 "get the ext2/3/4 filesystem label",
2235 This returns the ext2/3/4 filesystem label of the filesystem on
2238 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2239 (let uuid = uuidgen () in
2240 [InitBasicFS, Always, TestOutput (
2241 [["set_e2uuid"; "/dev/sda1"; uuid];
2242 ["get_e2uuid"; "/dev/sda1"]], uuid);
2243 InitBasicFS, Always, TestOutput (
2244 [["set_e2uuid"; "/dev/sda1"; "clear"];
2245 ["get_e2uuid"; "/dev/sda1"]], "");
2246 (* We can't predict what UUIDs will be, so just check the commands run. *)
2247 InitBasicFS, Always, TestRun (
2248 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2249 InitBasicFS, Always, TestRun (
2250 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2251 "set the ext2/3/4 filesystem UUID",
2253 This sets the ext2/3/4 filesystem UUID of the filesystem on
2254 C<device> to C<uuid>. The format of the UUID and alternatives
2255 such as C<clear>, C<random> and C<time> are described in the
2256 L<tune2fs(8)> manpage.
2258 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2259 to return the existing UUID of a filesystem.");
2261 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2263 "get the ext2/3/4 filesystem UUID",
2265 This returns the ext2/3/4 filesystem UUID of the filesystem on
2268 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2269 [InitBasicFS, Always, TestOutputInt (
2270 [["umount"; "/dev/sda1"];
2271 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2272 InitBasicFS, Always, TestOutputInt (
2273 [["umount"; "/dev/sda1"];
2274 ["zero"; "/dev/sda1"];
2275 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2276 "run the filesystem checker",
2278 This runs the filesystem checker (fsck) on C<device> which
2279 should have filesystem type C<fstype>.
2281 The returned integer is the status. See L<fsck(8)> for the
2282 list of status codes from C<fsck>.
2290 Multiple status codes can be summed together.
2294 A non-zero return code can mean \"success\", for example if
2295 errors have been corrected on the filesystem.
2299 Checking or repairing NTFS volumes is not supported
2304 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2306 ("zero", (RErr, [Device "device"]), 85, [],
2307 [InitBasicFS, Always, TestOutput (
2308 [["umount"; "/dev/sda1"];
2309 ["zero"; "/dev/sda1"];
2310 ["file"; "/dev/sda1"]], "data")],
2311 "write zeroes to the device",
2313 This command writes zeroes over the first few blocks of C<device>.
2315 How many blocks are zeroed isn't specified (but it's I<not> enough
2316 to securely wipe the device). It should be sufficient to remove
2317 any partition tables, filesystem superblocks and so on.
2319 See also: C<guestfs_scrub_device>.");
2321 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2322 (* Test disabled because grub-install incompatible with virtio-blk driver.
2323 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2325 [InitBasicFS, Disabled, TestOutputTrue (
2326 [["grub_install"; "/"; "/dev/sda1"];
2327 ["is_dir"; "/boot"]])],
2330 This command installs GRUB (the Grand Unified Bootloader) on
2331 C<device>, with the root directory being C<root>.
2333 Note: If grub-install reports the error
2334 \"No suitable drive was found in the generated device map.\"
2335 it may be that you need to create a C</boot/grub/device.map>
2336 file first that contains the mapping between grub device names
2337 and Linux device names. It is usually sufficient to create
2342 replacing C</dev/vda> with the name of the installation device.");
2344 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2345 [InitBasicFS, Always, TestOutput (
2346 [["write_file"; "/old"; "file content"; "0"];
2347 ["cp"; "/old"; "/new"];
2348 ["cat"; "/new"]], "file content");
2349 InitBasicFS, Always, TestOutputTrue (
2350 [["write_file"; "/old"; "file content"; "0"];
2351 ["cp"; "/old"; "/new"];
2352 ["is_file"; "/old"]]);
2353 InitBasicFS, Always, TestOutput (
2354 [["write_file"; "/old"; "file content"; "0"];
2356 ["cp"; "/old"; "/dir/new"];
2357 ["cat"; "/dir/new"]], "file content")],
2360 This copies a file from C<src> to C<dest> where C<dest> is
2361 either a destination filename or destination directory.");
2363 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2364 [InitBasicFS, Always, TestOutput (
2365 [["mkdir"; "/olddir"];
2366 ["mkdir"; "/newdir"];
2367 ["write_file"; "/olddir/file"; "file content"; "0"];
2368 ["cp_a"; "/olddir"; "/newdir"];
2369 ["cat"; "/newdir/olddir/file"]], "file content")],
2370 "copy a file or directory recursively",
2372 This copies a file or directory from C<src> to C<dest>
2373 recursively using the C<cp -a> command.");
2375 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2376 [InitBasicFS, Always, TestOutput (
2377 [["write_file"; "/old"; "file content"; "0"];
2378 ["mv"; "/old"; "/new"];
2379 ["cat"; "/new"]], "file content");
2380 InitBasicFS, Always, TestOutputFalse (
2381 [["write_file"; "/old"; "file content"; "0"];
2382 ["mv"; "/old"; "/new"];
2383 ["is_file"; "/old"]])],
2386 This moves a file from C<src> to C<dest> where C<dest> is
2387 either a destination filename or destination directory.");
2389 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2390 [InitEmpty, Always, TestRun (
2391 [["drop_caches"; "3"]])],
2392 "drop kernel page cache, dentries and inodes",
2394 This instructs the guest kernel to drop its page cache,
2395 and/or dentries and inode caches. The parameter C<whattodrop>
2396 tells the kernel what precisely to drop, see
2397 L<http://linux-mm.org/Drop_Caches>
2399 Setting C<whattodrop> to 3 should drop everything.
2401 This automatically calls L<sync(2)> before the operation,
2402 so that the maximum guest memory is freed.");
2404 ("dmesg", (RString "kmsgs", []), 91, [],
2405 [InitEmpty, Always, TestRun (
2407 "return kernel messages",
2409 This returns the kernel messages (C<dmesg> output) from
2410 the guest kernel. This is sometimes useful for extended
2411 debugging of problems.
2413 Another way to get the same information is to enable
2414 verbose messages with C<guestfs_set_verbose> or by setting
2415 the environment variable C<LIBGUESTFS_DEBUG=1> before
2416 running the program.");
2418 ("ping_daemon", (RErr, []), 92, [],
2419 [InitEmpty, Always, TestRun (
2420 [["ping_daemon"]])],
2421 "ping the guest daemon",
2423 This is a test probe into the guestfs daemon running inside
2424 the qemu subprocess. Calling this function checks that the
2425 daemon responds to the ping message, without affecting the daemon
2426 or attached block device(s) in any other way.");
2428 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2429 [InitBasicFS, Always, TestOutputTrue (
2430 [["write_file"; "/file1"; "contents of a file"; "0"];
2431 ["cp"; "/file1"; "/file2"];
2432 ["equal"; "/file1"; "/file2"]]);
2433 InitBasicFS, Always, TestOutputFalse (
2434 [["write_file"; "/file1"; "contents of a file"; "0"];
2435 ["write_file"; "/file2"; "contents of another file"; "0"];
2436 ["equal"; "/file1"; "/file2"]]);
2437 InitBasicFS, Always, TestLastFail (
2438 [["equal"; "/file1"; "/file2"]])],
2439 "test if two files have equal contents",
2441 This compares the two files C<file1> and C<file2> and returns
2442 true if their content is exactly equal, or false otherwise.
2444 The external L<cmp(1)> program is used for the comparison.");
2446 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2447 [InitISOFS, Always, TestOutputList (
2448 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2449 InitISOFS, Always, TestOutputList (
2450 [["strings"; "/empty"]], [])],
2451 "print the printable strings in a file",
2453 This runs the L<strings(1)> command on a file and returns
2454 the list of printable strings found.");
2456 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2457 [InitISOFS, Always, TestOutputList (
2458 [["strings_e"; "b"; "/known-5"]], []);
2459 InitBasicFS, Disabled, TestOutputList (
2460 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2461 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2462 "print the printable strings in a file",
2464 This is like the C<guestfs_strings> command, but allows you to
2465 specify the encoding of strings that are looked for in
2466 the source file C<path>.
2468 Allowed encodings are:
2474 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2475 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2479 Single 8-bit-byte characters.
2483 16-bit big endian strings such as those encoded in
2484 UTF-16BE or UCS-2BE.
2486 =item l (lower case letter L)
2488 16-bit little endian such as UTF-16LE and UCS-2LE.
2489 This is useful for examining binaries in Windows guests.
2493 32-bit big endian such as UCS-4BE.
2497 32-bit little endian such as UCS-4LE.
2501 The returned strings are transcoded to UTF-8.");
2503 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2504 [InitISOFS, Always, TestOutput (
2505 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2506 (* Test for RHBZ#501888c2 regression which caused large hexdump
2507 * commands to segfault.
2509 InitISOFS, Always, TestRun (
2510 [["hexdump"; "/100krandom"]])],
2511 "dump a file in hexadecimal",
2513 This runs C<hexdump -C> on the given C<path>. The result is
2514 the human-readable, canonical hex dump of the file.");
2516 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2517 [InitNone, Always, TestOutput (
2518 [["part_disk"; "/dev/sda"; "mbr"];
2519 ["mkfs"; "ext3"; "/dev/sda1"];
2520 ["mount_options"; ""; "/dev/sda1"; "/"];
2521 ["write_file"; "/new"; "test file"; "0"];
2522 ["umount"; "/dev/sda1"];
2523 ["zerofree"; "/dev/sda1"];
2524 ["mount_options"; ""; "/dev/sda1"; "/"];
2525 ["cat"; "/new"]], "test file")],
2526 "zero unused inodes and disk blocks on ext2/3 filesystem",
2528 This runs the I<zerofree> program on C<device>. This program
2529 claims to zero unused inodes and disk blocks on an ext2/3
2530 filesystem, thus making it possible to compress the filesystem
2533 You should B<not> run this program if the filesystem is
2536 It is possible that using this program can damage the filesystem
2537 or data on the filesystem.");
2539 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2541 "resize an LVM physical volume",
2543 This resizes (expands or shrinks) an existing LVM physical
2544 volume to match the new size of the underlying device.");
2546 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2547 Int "cyls"; Int "heads"; Int "sectors";
2548 String "line"]), 99, [DangerWillRobinson],
2550 "modify a single partition on a block device",
2552 This runs L<sfdisk(8)> option to modify just the single
2553 partition C<n> (note: C<n> counts from 1).
2555 For other parameters, see C<guestfs_sfdisk>. You should usually
2556 pass C<0> for the cyls/heads/sectors parameters.
2558 See also: C<guestfs_part_add>");
2560 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2562 "display the partition table",
2564 This displays the partition table on C<device>, in the
2565 human-readable output of the L<sfdisk(8)> command. It is
2566 not intended to be parsed.
2568 See also: C<guestfs_part_list>");
2570 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2572 "display the kernel geometry",
2574 This displays the kernel's idea of the geometry of C<device>.
2576 The result is in human-readable format, and not designed to
2579 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2581 "display the disk geometry from the partition table",
2583 This displays the disk geometry of C<device> read from the
2584 partition table. Especially in the case where the underlying
2585 block device has been resized, this can be different from the
2586 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2588 The result is in human-readable format, and not designed to
2591 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2593 "activate or deactivate all volume groups",
2595 This command activates or (if C<activate> is false) deactivates
2596 all logical volumes in all volume groups.
2597 If activated, then they are made known to the
2598 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2599 then those devices disappear.
2601 This command is the same as running C<vgchange -a y|n>");
2603 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2605 "activate or deactivate some volume groups",
2607 This command activates or (if C<activate> is false) deactivates
2608 all logical volumes in the listed volume groups C<volgroups>.
2609 If activated, then they are made known to the
2610 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2611 then those devices disappear.
2613 This command is the same as running C<vgchange -a y|n volgroups...>
2615 Note that if C<volgroups> is an empty list then B<all> volume groups
2616 are activated or deactivated.");
2618 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2619 [InitNone, Always, TestOutput (
2620 [["part_disk"; "/dev/sda"; "mbr"];
2621 ["pvcreate"; "/dev/sda1"];
2622 ["vgcreate"; "VG"; "/dev/sda1"];
2623 ["lvcreate"; "LV"; "VG"; "10"];
2624 ["mkfs"; "ext2"; "/dev/VG/LV"];
2625 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2626 ["write_file"; "/new"; "test content"; "0"];
2628 ["lvresize"; "/dev/VG/LV"; "20"];
2629 ["e2fsck_f"; "/dev/VG/LV"];
2630 ["resize2fs"; "/dev/VG/LV"];
2631 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2632 ["cat"; "/new"]], "test content");
2633 InitNone, Always, TestRun (
2634 (* Make an LV smaller to test RHBZ#587484. *)
2635 [["part_disk"; "/dev/sda"; "mbr"];
2636 ["pvcreate"; "/dev/sda1"];
2637 ["vgcreate"; "VG"; "/dev/sda1"];
2638 ["lvcreate"; "LV"; "VG"; "20"];
2639 ["lvresize"; "/dev/VG/LV"; "10"]])],
2640 "resize an LVM logical volume",
2642 This resizes (expands or shrinks) an existing LVM logical
2643 volume to C<mbytes>. When reducing, data in the reduced part
2646 ("resize2fs", (RErr, [Device "device"]), 106, [],
2647 [], (* lvresize tests this *)
2648 "resize an ext2, ext3 or ext4 filesystem",
2650 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2651 the underlying device.
2653 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2654 on the C<device> before calling this command. For unknown reasons
2655 C<resize2fs> sometimes gives an error about this and sometimes not.
2656 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2657 calling this function.");
2659 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2660 [InitBasicFS, Always, TestOutputList (
2661 [["find"; "/"]], ["lost+found"]);
2662 InitBasicFS, Always, TestOutputList (
2666 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2667 InitBasicFS, Always, TestOutputList (
2668 [["mkdir_p"; "/a/b/c"];
2669 ["touch"; "/a/b/c/d"];
2670 ["find"; "/a/b/"]], ["c"; "c/d"])],
2671 "find all files and directories",
2673 This command lists out all files and directories, recursively,
2674 starting at C<directory>. It is essentially equivalent to
2675 running the shell command C<find directory -print> but some
2676 post-processing happens on the output, described below.
2678 This returns a list of strings I<without any prefix>. Thus
2679 if the directory structure was:
2685 then the returned list from C<guestfs_find> C</tmp> would be
2693 If C<directory> is not a directory, then this command returns
2696 The returned list is sorted.
2698 See also C<guestfs_find0>.");
2700 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2701 [], (* lvresize tests this *)
2702 "check an ext2/ext3 filesystem",
2704 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2705 filesystem checker on C<device>, noninteractively (C<-p>),
2706 even if the filesystem appears to be clean (C<-f>).
2708 This command is only needed because of C<guestfs_resize2fs>
2709 (q.v.). Normally you should use C<guestfs_fsck>.");
2711 ("sleep", (RErr, [Int "secs"]), 109, [],
2712 [InitNone, Always, TestRun (
2714 "sleep for some seconds",
2716 Sleep for C<secs> seconds.");
2718 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2719 [InitNone, Always, TestOutputInt (
2720 [["part_disk"; "/dev/sda"; "mbr"];
2721 ["mkfs"; "ntfs"; "/dev/sda1"];
2722 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2723 InitNone, Always, TestOutputInt (
2724 [["part_disk"; "/dev/sda"; "mbr"];
2725 ["mkfs"; "ext2"; "/dev/sda1"];
2726 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2727 "probe NTFS volume",
2729 This command runs the L<ntfs-3g.probe(8)> command which probes
2730 an NTFS C<device> for mountability. (Not all NTFS volumes can
2731 be mounted read-write, and some cannot be mounted at all).
2733 C<rw> is a boolean flag. Set it to true if you want to test
2734 if the volume can be mounted read-write. Set it to false if
2735 you want to test if the volume can be mounted read-only.
2737 The return value is an integer which C<0> if the operation
2738 would succeed, or some non-zero value documented in the
2739 L<ntfs-3g.probe(8)> manual page.");
2741 ("sh", (RString "output", [String "command"]), 111, [],
2742 [], (* XXX needs tests *)
2743 "run a command via the shell",
2745 This call runs a command from the guest filesystem via the
2748 This is like C<guestfs_command>, but passes the command to:
2750 /bin/sh -c \"command\"
2752 Depending on the guest's shell, this usually results in
2753 wildcards being expanded, shell expressions being interpolated
2756 All the provisos about C<guestfs_command> apply to this call.");
2758 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2759 [], (* XXX needs tests *)
2760 "run a command via the shell returning lines",
2762 This is the same as C<guestfs_sh>, but splits the result
2763 into a list of lines.
2765 See also: C<guestfs_command_lines>");
2767 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2768 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2769 * code in stubs.c, since all valid glob patterns must start with "/".
2770 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2772 [InitBasicFS, Always, TestOutputList (
2773 [["mkdir_p"; "/a/b/c"];
2774 ["touch"; "/a/b/c/d"];
2775 ["touch"; "/a/b/c/e"];
2776 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2777 InitBasicFS, Always, TestOutputList (
2778 [["mkdir_p"; "/a/b/c"];
2779 ["touch"; "/a/b/c/d"];
2780 ["touch"; "/a/b/c/e"];
2781 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2782 InitBasicFS, Always, TestOutputList (
2783 [["mkdir_p"; "/a/b/c"];
2784 ["touch"; "/a/b/c/d"];
2785 ["touch"; "/a/b/c/e"];
2786 ["glob_expand"; "/a/*/x/*"]], [])],
2787 "expand a wildcard path",
2789 This command searches for all the pathnames matching
2790 C<pattern> according to the wildcard expansion rules
2793 If no paths match, then this returns an empty list
2794 (note: not an error).
2796 It is just a wrapper around the C L<glob(3)> function
2797 with flags C<GLOB_MARK|GLOB_BRACE>.
2798 See that manual page for more details.");
2800 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2801 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2802 [["scrub_device"; "/dev/sdc"]])],
2803 "scrub (securely wipe) a device",
2805 This command writes patterns over C<device> to make data retrieval
2808 It is an interface to the L<scrub(1)> program. See that
2809 manual page for more details.");
2811 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2812 [InitBasicFS, Always, TestRun (
2813 [["write_file"; "/file"; "content"; "0"];
2814 ["scrub_file"; "/file"]])],
2815 "scrub (securely wipe) a file",
2817 This command writes patterns over a file to make data retrieval
2820 The file is I<removed> after scrubbing.
2822 It is an interface to the L<scrub(1)> program. See that
2823 manual page for more details.");
2825 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2826 [], (* XXX needs testing *)
2827 "scrub (securely wipe) free space",
2829 This command creates the directory C<dir> and then fills it
2830 with files until the filesystem is full, and scrubs the files
2831 as for C<guestfs_scrub_file>, and deletes them.
2832 The intention is to scrub any free space on the partition
2835 It is an interface to the L<scrub(1)> program. See that
2836 manual page for more details.");
2838 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2839 [InitBasicFS, Always, TestRun (
2841 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2842 "create a temporary directory",
2844 This command creates a temporary directory. The
2845 C<template> parameter should be a full pathname for the
2846 temporary directory name with the final six characters being
2849 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2850 the second one being suitable for Windows filesystems.
2852 The name of the temporary directory that was created
2855 The temporary directory is created with mode 0700
2856 and is owned by root.
2858 The caller is responsible for deleting the temporary
2859 directory and its contents after use.
2861 See also: L<mkdtemp(3)>");
2863 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2864 [InitISOFS, Always, TestOutputInt (
2865 [["wc_l"; "/10klines"]], 10000)],
2866 "count lines in a file",
2868 This command counts the lines in a file, using the
2869 C<wc -l> external command.");
2871 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2872 [InitISOFS, Always, TestOutputInt (
2873 [["wc_w"; "/10klines"]], 10000)],
2874 "count words in a file",
2876 This command counts the words in a file, using the
2877 C<wc -w> external command.");
2879 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2880 [InitISOFS, Always, TestOutputInt (
2881 [["wc_c"; "/100kallspaces"]], 102400)],
2882 "count characters in a file",
2884 This command counts the characters in a file, using the
2885 C<wc -c> external command.");
2887 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2888 [InitISOFS, Always, TestOutputList (
2889 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2890 "return first 10 lines of a file",
2892 This command returns up to the first 10 lines of a file as
2893 a list of strings.");
2895 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2896 [InitISOFS, Always, TestOutputList (
2897 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2898 InitISOFS, Always, TestOutputList (
2899 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2900 InitISOFS, Always, TestOutputList (
2901 [["head_n"; "0"; "/10klines"]], [])],
2902 "return first N lines of a file",
2904 If the parameter C<nrlines> is a positive number, this returns the first
2905 C<nrlines> lines of the file C<path>.
2907 If the parameter C<nrlines> is a negative number, this returns lines
2908 from the file C<path>, excluding the last C<nrlines> lines.
2910 If the parameter C<nrlines> is zero, this returns an empty list.");
2912 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2913 [InitISOFS, Always, TestOutputList (
2914 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2915 "return last 10 lines of a file",
2917 This command returns up to the last 10 lines of a file as
2918 a list of strings.");
2920 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2921 [InitISOFS, Always, TestOutputList (
2922 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2923 InitISOFS, Always, TestOutputList (
2924 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2925 InitISOFS, Always, TestOutputList (
2926 [["tail_n"; "0"; "/10klines"]], [])],
2927 "return last N lines of a file",
2929 If the parameter C<nrlines> is a positive number, this returns the last
2930 C<nrlines> lines of the file C<path>.
2932 If the parameter C<nrlines> is a negative number, this returns lines
2933 from the file C<path>, starting with the C<-nrlines>th line.
2935 If the parameter C<nrlines> is zero, this returns an empty list.");
2937 ("df", (RString "output", []), 125, [],
2938 [], (* XXX Tricky to test because it depends on the exact format
2939 * of the 'df' command and other imponderables.
2941 "report file system disk space usage",
2943 This command runs the C<df> command to report disk space used.
2945 This command is mostly useful for interactive sessions. It
2946 is I<not> intended that you try to parse the output string.
2947 Use C<statvfs> from programs.");
2949 ("df_h", (RString "output", []), 126, [],
2950 [], (* XXX Tricky to test because it depends on the exact format
2951 * of the 'df' command and other imponderables.
2953 "report file system disk space usage (human readable)",
2955 This command runs the C<df -h> command to report disk space used
2956 in human-readable format.
2958 This command is mostly useful for interactive sessions. It
2959 is I<not> intended that you try to parse the output string.
2960 Use C<statvfs> from programs.");
2962 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2963 [InitISOFS, Always, TestOutputInt (
2964 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2965 "estimate file space usage",
2967 This command runs the C<du -s> command to estimate file space
2970 C<path> can be a file or a directory. If C<path> is a directory
2971 then the estimate includes the contents of the directory and all
2972 subdirectories (recursively).
2974 The result is the estimated size in I<kilobytes>
2975 (ie. units of 1024 bytes).");
2977 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2978 [InitISOFS, Always, TestOutputList (
2979 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2980 "list files in an initrd",
2982 This command lists out files contained in an initrd.
2984 The files are listed without any initial C</> character. The
2985 files are listed in the order they appear (not necessarily
2986 alphabetical). Directory names are listed as separate items.
2988 Old Linux kernels (2.4 and earlier) used a compressed ext2
2989 filesystem as initrd. We I<only> support the newer initramfs
2990 format (compressed cpio files).");
2992 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2994 "mount a file using the loop device",
2996 This command lets you mount C<file> (a filesystem image
2997 in a file) on a mount point. It is entirely equivalent to
2998 the command C<mount -o loop file mountpoint>.");
3000 ("mkswap", (RErr, [Device "device"]), 130, [],
3001 [InitEmpty, Always, TestRun (
3002 [["part_disk"; "/dev/sda"; "mbr"];
3003 ["mkswap"; "/dev/sda1"]])],
3004 "create a swap partition",
3006 Create a swap partition on C<device>.");
3008 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3009 [InitEmpty, Always, TestRun (
3010 [["part_disk"; "/dev/sda"; "mbr"];
3011 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3012 "create a swap partition with a label",
3014 Create a swap partition on C<device> with label C<label>.
3016 Note that you cannot attach a swap label to a block device
3017 (eg. C</dev/sda>), just to a partition. This appears to be
3018 a limitation of the kernel or swap tools.");
3020 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3021 (let uuid = uuidgen () in
3022 [InitEmpty, Always, TestRun (
3023 [["part_disk"; "/dev/sda"; "mbr"];
3024 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3025 "create a swap partition with an explicit UUID",
3027 Create a swap partition on C<device> with UUID C<uuid>.");
3029 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3030 [InitBasicFS, Always, TestOutputStruct (
3031 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3032 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3033 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3034 InitBasicFS, Always, TestOutputStruct (
3035 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3036 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3037 "make block, character or FIFO devices",
3039 This call creates block or character special devices, or
3040 named pipes (FIFOs).
3042 The C<mode> parameter should be the mode, using the standard
3043 constants. C<devmajor> and C<devminor> are the
3044 device major and minor numbers, only used when creating block
3045 and character special devices.
3047 Note that, just like L<mknod(2)>, the mode must be bitwise
3048 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3049 just creates a regular file). These constants are
3050 available in the standard Linux header files, or you can use
3051 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3052 which are wrappers around this command which bitwise OR
3053 in the appropriate constant for you.
3055 The mode actually set is affected by the umask.");
3057 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3058 [InitBasicFS, Always, TestOutputStruct (
3059 [["mkfifo"; "0o777"; "/node"];
3060 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3061 "make FIFO (named pipe)",
3063 This call creates a FIFO (named pipe) called C<path> with
3064 mode C<mode>. It is just a convenient wrapper around
3067 The mode actually set is affected by the umask.");
3069 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3070 [InitBasicFS, Always, TestOutputStruct (
3071 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3072 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3073 "make block device node",
3075 This call creates a block device node called C<path> with
3076 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3077 It is just a convenient wrapper around C<guestfs_mknod>.
3079 The mode actually set is affected by the umask.");
3081 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3082 [InitBasicFS, Always, TestOutputStruct (
3083 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3084 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3085 "make char device node",
3087 This call creates a char device node called C<path> with
3088 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3089 It is just a convenient wrapper around C<guestfs_mknod>.
3091 The mode actually set is affected by the umask.");
3093 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
3094 [InitEmpty, Always, TestOutputInt (
3095 [["umask"; "0o22"]], 0o22)],
3096 "set file mode creation mask (umask)",
3098 This function sets the mask used for creating new files and
3099 device nodes to C<mask & 0777>.
3101 Typical umask values would be C<022> which creates new files
3102 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3103 C<002> which creates new files with permissions like
3104 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3106 The default umask is C<022>. This is important because it
3107 means that directories and device nodes will be created with
3108 C<0644> or C<0755> mode even if you specify C<0777>.
3110 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3112 This call returns the previous umask.");
3114 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3116 "read directories entries",
3118 This returns the list of directory entries in directory C<dir>.
3120 All entries in the directory are returned, including C<.> and
3121 C<..>. The entries are I<not> sorted, but returned in the same
3122 order as the underlying filesystem.
3124 Also this call returns basic file type information about each
3125 file. The C<ftyp> field will contain one of the following characters:
3163 The L<readdir(3)> call returned a C<d_type> field with an
3168 This function is primarily intended for use by programs. To
3169 get a simple list of names, use C<guestfs_ls>. To get a printable
3170 directory for human consumption, use C<guestfs_ll>.");
3172 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3174 "create partitions on a block device",
3176 This is a simplified interface to the C<guestfs_sfdisk>
3177 command, where partition sizes are specified in megabytes
3178 only (rounded to the nearest cylinder) and you don't need
3179 to specify the cyls, heads and sectors parameters which
3180 were rarely if ever used anyway.
3182 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3183 and C<guestfs_part_disk>");
3185 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3187 "determine file type inside a compressed file",
3189 This command runs C<file> after first decompressing C<path>
3192 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3194 Since 1.0.63, use C<guestfs_file> instead which can now
3195 process compressed files.");
3197 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3199 "list extended attributes of a file or directory",
3201 This call lists the extended attributes of the file or directory
3204 At the system call level, this is a combination of the
3205 L<listxattr(2)> and L<getxattr(2)> calls.
3207 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3209 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3211 "list extended attributes of a file or directory",
3213 This is the same as C<guestfs_getxattrs>, but if C<path>
3214 is a symbolic link, then it returns the extended attributes
3215 of the link itself.");
3217 ("setxattr", (RErr, [String "xattr";
3218 String "val"; Int "vallen"; (* will be BufferIn *)
3219 Pathname "path"]), 143, [Optional "linuxxattrs"],
3221 "set extended attribute of a file or directory",
3223 This call sets the extended attribute named C<xattr>
3224 of the file C<path> to the value C<val> (of length C<vallen>).
3225 The value is arbitrary 8 bit data.
3227 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3229 ("lsetxattr", (RErr, [String "xattr";
3230 String "val"; Int "vallen"; (* will be BufferIn *)
3231 Pathname "path"]), 144, [Optional "linuxxattrs"],
3233 "set extended attribute of a file or directory",
3235 This is the same as C<guestfs_setxattr>, but if C<path>
3236 is a symbolic link, then it sets an extended attribute
3237 of the link itself.");
3239 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3241 "remove extended attribute of a file or directory",
3243 This call removes the extended attribute named C<xattr>
3244 of the file C<path>.
3246 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3248 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3250 "remove extended attribute of a file or directory",
3252 This is the same as C<guestfs_removexattr>, but if C<path>
3253 is a symbolic link, then it removes an extended attribute
3254 of the link itself.");
3256 ("mountpoints", (RHashtable "mps", []), 147, [],
3260 This call is similar to C<guestfs_mounts>. That call returns
3261 a list of devices. This one returns a hash table (map) of
3262 device name to directory where the device is mounted.");
3264 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3265 (* This is a special case: while you would expect a parameter
3266 * of type "Pathname", that doesn't work, because it implies
3267 * NEED_ROOT in the generated calling code in stubs.c, and
3268 * this function cannot use NEED_ROOT.
3271 "create a mountpoint",
3273 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3274 specialized calls that can be used to create extra mountpoints
3275 before mounting the first filesystem.
3277 These calls are I<only> necessary in some very limited circumstances,
3278 mainly the case where you want to mount a mix of unrelated and/or
3279 read-only filesystems together.
3281 For example, live CDs often contain a \"Russian doll\" nest of
3282 filesystems, an ISO outer layer, with a squashfs image inside, with
3283 an ext2/3 image inside that. You can unpack this as follows
3286 add-ro Fedora-11-i686-Live.iso
3289 mkmountpoint /squash
3292 mount-loop /cd/LiveOS/squashfs.img /squash
3293 mount-loop /squash/LiveOS/ext3fs.img /ext3
3295 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3297 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3299 "remove a mountpoint",
3301 This calls removes a mountpoint that was previously created
3302 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3303 for full details.");
3305 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3306 [InitISOFS, Always, TestOutputBuffer (
3307 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3308 (* Test various near large, large and too large files (RHBZ#589039). *)
3309 InitBasicFS, Always, TestLastFail (
3311 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3312 ["read_file"; "/a"]]);
3313 InitBasicFS, Always, TestLastFail (
3315 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3316 ["read_file"; "/a"]]);
3317 InitBasicFS, Always, TestLastFail (
3319 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3320 ["read_file"; "/a"]])],
3323 This calls returns the contents of the file C<path> as a
3326 Unlike C<guestfs_cat>, this function can correctly
3327 handle files that contain embedded ASCII NUL characters.
3328 However unlike C<guestfs_download>, this function is limited
3329 in the total size of file that can be handled.");
3331 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3332 [InitISOFS, Always, TestOutputList (
3333 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3334 InitISOFS, Always, TestOutputList (
3335 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3336 "return lines matching a pattern",
3338 This calls the external C<grep> program and returns the
3341 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3342 [InitISOFS, Always, TestOutputList (
3343 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3344 "return lines matching a pattern",
3346 This calls the external C<egrep> program and returns the
3349 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3350 [InitISOFS, Always, TestOutputList (
3351 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3352 "return lines matching a pattern",
3354 This calls the external C<fgrep> program and returns the
3357 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3358 [InitISOFS, Always, TestOutputList (
3359 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3360 "return lines matching a pattern",
3362 This calls the external C<grep -i> program and returns the
3365 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3366 [InitISOFS, Always, TestOutputList (
3367 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3368 "return lines matching a pattern",
3370 This calls the external C<egrep -i> program and returns the
3373 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3374 [InitISOFS, Always, TestOutputList (
3375 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3376 "return lines matching a pattern",
3378 This calls the external C<fgrep -i> program and returns the
3381 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3382 [InitISOFS, Always, TestOutputList (
3383 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3384 "return lines matching a pattern",
3386 This calls the external C<zgrep> program and returns the
3389 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3390 [InitISOFS, Always, TestOutputList (
3391 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3392 "return lines matching a pattern",
3394 This calls the external C<zegrep> program and returns the
3397 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3398 [InitISOFS, Always, TestOutputList (
3399 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3400 "return lines matching a pattern",
3402 This calls the external C<zfgrep> program and returns the
3405 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3406 [InitISOFS, Always, TestOutputList (
3407 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3408 "return lines matching a pattern",
3410 This calls the external C<zgrep -i> program and returns the
3413 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3414 [InitISOFS, Always, TestOutputList (
3415 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3416 "return lines matching a pattern",
3418 This calls the external C<zegrep -i> program and returns the
3421 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3422 [InitISOFS, Always, TestOutputList (
3423 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3424 "return lines matching a pattern",
3426 This calls the external C<zfgrep -i> program and returns the
3429 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3430 [InitISOFS, Always, TestOutput (
3431 [["realpath"; "/../directory"]], "/directory")],
3432 "canonicalized absolute pathname",
3434 Return the canonicalized absolute pathname of C<path>. The
3435 returned path has no C<.>, C<..> or symbolic link path elements.");
3437 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3438 [InitBasicFS, Always, TestOutputStruct (
3441 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3442 "create a hard link",
3444 This command creates a hard link using the C<ln> command.");
3446 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3447 [InitBasicFS, Always, TestOutputStruct (
3450 ["ln_f"; "/a"; "/b"];
3451 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3452 "create a hard link",
3454 This command creates a hard link using the C<ln -f> command.
3455 The C<-f> option removes the link (C<linkname>) if it exists already.");
3457 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3458 [InitBasicFS, Always, TestOutputStruct (
3460 ["ln_s"; "a"; "/b"];
3461 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3462 "create a symbolic link",
3464 This command creates a symbolic link using the C<ln -s> command.");
3466 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3467 [InitBasicFS, Always, TestOutput (
3468 [["mkdir_p"; "/a/b"];
3469 ["touch"; "/a/b/c"];
3470 ["ln_sf"; "../d"; "/a/b/c"];
3471 ["readlink"; "/a/b/c"]], "../d")],
3472 "create a symbolic link",
3474 This command creates a symbolic link using the C<ln -sf> command,
3475 The C<-f> option removes the link (C<linkname>) if it exists already.");
3477 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3478 [] (* XXX tested above *),
3479 "read the target of a symbolic link",
3481 This command reads the target of a symbolic link.");
3483 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3484 [InitBasicFS, Always, TestOutputStruct (
3485 [["fallocate"; "/a"; "1000000"];
3486 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3487 "preallocate a file in the guest filesystem",
3489 This command preallocates a file (containing zero bytes) named
3490 C<path> of size C<len> bytes. If the file exists already, it
3493 Do not confuse this with the guestfish-specific
3494 C<alloc> command which allocates a file in the host and
3495 attaches it as a device.");
3497 ("swapon_device", (RErr, [Device "device"]), 170, [],
3498 [InitPartition, Always, TestRun (
3499 [["mkswap"; "/dev/sda1"];
3500 ["swapon_device"; "/dev/sda1"];
3501 ["swapoff_device"; "/dev/sda1"]])],
3502 "enable swap on device",
3504 This command enables the libguestfs appliance to use the
3505 swap device or partition named C<device>. The increased
3506 memory is made available for all commands, for example
3507 those run using C<guestfs_command> or C<guestfs_sh>.
3509 Note that you should not swap to existing guest swap
3510 partitions unless you know what you are doing. They may
3511 contain hibernation information, or other information that
3512 the guest doesn't want you to trash. You also risk leaking
3513 information about the host to the guest this way. Instead,
3514 attach a new host device to the guest and swap on that.");
3516 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3517 [], (* XXX tested by swapon_device *)
3518 "disable swap on device",
3520 This command disables the libguestfs appliance swap
3521 device or partition named C<device>.
3522 See C<guestfs_swapon_device>.");
3524 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3525 [InitBasicFS, Always, TestRun (
3526 [["fallocate"; "/swap"; "8388608"];
3527 ["mkswap_file"; "/swap"];
3528 ["swapon_file"; "/swap"];
3529 ["swapoff_file"; "/swap"]])],
3530 "enable swap on file",
3532 This command enables swap to a file.
3533 See C<guestfs_swapon_device> for other notes.");
3535 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3536 [], (* XXX tested by swapon_file *)
3537 "disable swap on file",
3539 This command disables the libguestfs appliance swap on file.");
3541 ("swapon_label", (RErr, [String "label"]), 174, [],
3542 [InitEmpty, Always, TestRun (
3543 [["part_disk"; "/dev/sdb"; "mbr"];
3544 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3545 ["swapon_label"; "swapit"];
3546 ["swapoff_label"; "swapit"];
3547 ["zero"; "/dev/sdb"];
3548 ["blockdev_rereadpt"; "/dev/sdb"]])],
3549 "enable swap on labeled swap partition",
3551 This command enables swap to a labeled swap partition.
3552 See C<guestfs_swapon_device> for other notes.");
3554 ("swapoff_label", (RErr, [String "label"]), 175, [],
3555 [], (* XXX tested by swapon_label *)
3556 "disable swap on labeled swap partition",
3558 This command disables the libguestfs appliance swap on
3559 labeled swap partition.");
3561 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3562 (let uuid = uuidgen () in
3563 [InitEmpty, Always, TestRun (
3564 [["mkswap_U"; uuid; "/dev/sdb"];
3565 ["swapon_uuid"; uuid];
3566 ["swapoff_uuid"; uuid]])]),
3567 "enable swap on swap partition by UUID",
3569 This command enables swap to a swap partition with the given UUID.
3570 See C<guestfs_swapon_device> for other notes.");
3572 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3573 [], (* XXX tested by swapon_uuid *)
3574 "disable swap on swap partition by UUID",
3576 This command disables the libguestfs appliance swap partition
3577 with the given UUID.");
3579 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3580 [InitBasicFS, Always, TestRun (
3581 [["fallocate"; "/swap"; "8388608"];
3582 ["mkswap_file"; "/swap"]])],
3583 "create a swap file",
3587 This command just writes a swap file signature to an existing
3588 file. To create the file itself, use something like C<guestfs_fallocate>.");
3590 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3591 [InitISOFS, Always, TestRun (
3592 [["inotify_init"; "0"]])],
3593 "create an inotify handle",
3595 This command creates a new inotify handle.
3596 The inotify subsystem can be used to notify events which happen to
3597 objects in the guest filesystem.
3599 C<maxevents> is the maximum number of events which will be
3600 queued up between calls to C<guestfs_inotify_read> or
3601 C<guestfs_inotify_files>.
3602 If this is passed as C<0>, then the kernel (or previously set)
3603 default is used. For Linux 2.6.29 the default was 16384 events.
3604 Beyond this limit, the kernel throws away events, but records
3605 the fact that it threw them away by setting a flag
3606 C<IN_Q_OVERFLOW> in the returned structure list (see
3607 C<guestfs_inotify_read>).
3609 Before any events are generated, you have to add some
3610 watches to the internal watch list. See:
3611 C<guestfs_inotify_add_watch>,
3612 C<guestfs_inotify_rm_watch> and
3613 C<guestfs_inotify_watch_all>.
3615 Queued up events should be read periodically by calling
3616 C<guestfs_inotify_read>
3617 (or C<guestfs_inotify_files> which is just a helpful
3618 wrapper around C<guestfs_inotify_read>). If you don't
3619 read the events out often enough then you risk the internal
3622 The handle should be closed after use by calling
3623 C<guestfs_inotify_close>. This also removes any
3624 watches automatically.
3626 See also L<inotify(7)> for an overview of the inotify interface
3627 as exposed by the Linux kernel, which is roughly what we expose
3628 via libguestfs. Note that there is one global inotify handle
3629 per libguestfs instance.");
3631 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3632 [InitBasicFS, Always, TestOutputList (
3633 [["inotify_init"; "0"];
3634 ["inotify_add_watch"; "/"; "1073741823"];
3637 ["inotify_files"]], ["a"; "b"])],
3638 "add an inotify watch",
3640 Watch C<path> for the events listed in C<mask>.
3642 Note that if C<path> is a directory then events within that
3643 directory are watched, but this does I<not> happen recursively
3644 (in subdirectories).
3646 Note for non-C or non-Linux callers: the inotify events are
3647 defined by the Linux kernel ABI and are listed in
3648 C</usr/include/sys/inotify.h>.");
3650 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3652 "remove an inotify watch",
3654 Remove a previously defined inotify watch.
3655 See C<guestfs_inotify_add_watch>.");
3657 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3659 "return list of inotify events",
3661 Return the complete queue of events that have happened
3662 since the previous read call.
3664 If no events have happened, this returns an empty list.
3666 I<Note>: In order to make sure that all events have been
3667 read, you must call this function repeatedly until it
3668 returns an empty list. The reason is that the call will
3669 read events up to the maximum appliance-to-host message
3670 size and leave remaining events in the queue.");
3672 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3674 "return list of watched files that had events",
3676 This function is a helpful wrapper around C<guestfs_inotify_read>
3677 which just returns a list of pathnames of objects that were
3678 touched. The returned pathnames are sorted and deduplicated.");
3680 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3682 "close the inotify handle",
3684 This closes the inotify handle which was previously
3685 opened by inotify_init. It removes all watches, throws
3686 away any pending events, and deallocates all resources.");
3688 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3690 "set SELinux security context",
3692 This sets the SELinux security context of the daemon
3693 to the string C<context>.
3695 See the documentation about SELINUX in L<guestfs(3)>.");
3697 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3699 "get SELinux security context",
3701 This gets the SELinux security context of the daemon.
3703 See the documentation about SELINUX in L<guestfs(3)>,
3704 and C<guestfs_setcon>");
3706 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3707 [InitEmpty, Always, TestOutput (
3708 [["part_disk"; "/dev/sda"; "mbr"];
3709 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3710 ["mount_options"; ""; "/dev/sda1"; "/"];
3711 ["write_file"; "/new"; "new file contents"; "0"];
3712 ["cat"; "/new"]], "new file contents")],
3713 "make a filesystem with block size",
3715 This call is similar to C<guestfs_mkfs>, but it allows you to
3716 control the block size of the resulting filesystem. Supported
3717 block sizes depend on the filesystem type, but typically they
3718 are C<1024>, C<2048> or C<4096> only.");
3720 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3721 [InitEmpty, Always, TestOutput (
3722 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3723 ["mke2journal"; "4096"; "/dev/sda1"];
3724 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3725 ["mount_options"; ""; "/dev/sda2"; "/"];
3726 ["write_file"; "/new"; "new file contents"; "0"];
3727 ["cat"; "/new"]], "new file contents")],
3728 "make ext2/3/4 external journal",
3730 This creates an ext2 external journal on C<device>. It is equivalent
3733 mke2fs -O journal_dev -b blocksize device");
3735 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3736 [InitEmpty, Always, TestOutput (
3737 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3738 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3739 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3740 ["mount_options"; ""; "/dev/sda2"; "/"];
3741 ["write_file"; "/new"; "new file contents"; "0"];
3742 ["cat"; "/new"]], "new file contents")],
3743 "make ext2/3/4 external journal with label",
3745 This creates an ext2 external journal on C<device> with label C<label>.");
3747 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3748 (let uuid = uuidgen () in
3749 [InitEmpty, Always, TestOutput (
3750 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3751 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3752 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3753 ["mount_options"; ""; "/dev/sda2"; "/"];
3754 ["write_file"; "/new"; "new file contents"; "0"];
3755 ["cat"; "/new"]], "new file contents")]),
3756 "make ext2/3/4 external journal with UUID",
3758 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3760 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3762 "make ext2/3/4 filesystem with external journal",
3764 This creates an ext2/3/4 filesystem on C<device> with
3765 an external journal on C<journal>. It is equivalent
3768 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3770 See also C<guestfs_mke2journal>.");
3772 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3774 "make ext2/3/4 filesystem with external journal",
3776 This creates an ext2/3/4 filesystem on C<device> with
3777 an external journal on the journal labeled C<label>.
3779 See also C<guestfs_mke2journal_L>.");
3781 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3783 "make ext2/3/4 filesystem with external journal",
3785 This creates an ext2/3/4 filesystem on C<device> with
3786 an external journal on the journal with UUID C<uuid>.
3788 See also C<guestfs_mke2journal_U>.");
3790 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3791 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3792 "load a kernel module",
3794 This loads a kernel module in the appliance.
3796 The kernel module must have been whitelisted when libguestfs
3797 was built (see C<appliance/kmod.whitelist.in> in the source).");
3799 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3800 [InitNone, Always, TestOutput (
3801 [["echo_daemon"; "This is a test"]], "This is a test"
3803 "echo arguments back to the client",
3805 This command concatenates the list of C<words> passed with single spaces
3806 between them and returns the resulting string.
3808 You can use this command to test the connection through to the daemon.
3810 See also C<guestfs_ping_daemon>.");
3812 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3813 [], (* There is a regression test for this. *)
3814 "find all files and directories, returning NUL-separated list",
3816 This command lists out all files and directories, recursively,
3817 starting at C<directory>, placing the resulting list in the
3818 external file called C<files>.
3820 This command works the same way as C<guestfs_find> with the
3821 following exceptions:
3827 The resulting list is written to an external file.
3831 Items (filenames) in the result are separated
3832 by C<\\0> characters. See L<find(1)> option I<-print0>.
3836 This command is not limited in the number of names that it
3841 The result list is not sorted.
3845 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3846 [InitISOFS, Always, TestOutput (
3847 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3848 InitISOFS, Always, TestOutput (
3849 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3850 InitISOFS, Always, TestOutput (
3851 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3852 InitISOFS, Always, TestLastFail (
3853 [["case_sensitive_path"; "/Known-1/"]]);
3854 InitBasicFS, Always, TestOutput (
3856 ["mkdir"; "/a/bbb"];
3857 ["touch"; "/a/bbb/c"];
3858 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3859 InitBasicFS, Always, TestOutput (
3861 ["mkdir"; "/a/bbb"];
3862 ["touch"; "/a/bbb/c"];
3863 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3864 InitBasicFS, Always, TestLastFail (
3866 ["mkdir"; "/a/bbb"];
3867 ["touch"; "/a/bbb/c"];
3868 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3869 "return true path on case-insensitive filesystem",
3871 This can be used to resolve case insensitive paths on
3872 a filesystem which is case sensitive. The use case is
3873 to resolve paths which you have read from Windows configuration
3874 files or the Windows Registry, to the true path.
3876 The command handles a peculiarity of the Linux ntfs-3g
3877 filesystem driver (and probably others), which is that although
3878 the underlying filesystem is case-insensitive, the driver
3879 exports the filesystem to Linux as case-sensitive.
3881 One consequence of this is that special directories such
3882 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3883 (or other things) depending on the precise details of how
3884 they were created. In Windows itself this would not be
3887 Bug or feature? You decide:
3888 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3890 This function resolves the true case of each element in the
3891 path and returns the case-sensitive path.
3893 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3894 might return C<\"/WINDOWS/system32\"> (the exact return value
3895 would depend on details of how the directories were originally
3896 created under Windows).
3899 This function does not handle drive names, backslashes etc.
3901 See also C<guestfs_realpath>.");
3903 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3904 [InitBasicFS, Always, TestOutput (
3905 [["vfs_type"; "/dev/sda1"]], "ext2")],
3906 "get the Linux VFS type corresponding to a mounted device",
3908 This command gets the filesystem type corresponding to
3909 the filesystem on C<device>.
3911 For most filesystems, the result is the name of the Linux
3912 VFS module which would be used to mount this filesystem
3913 if you mounted it without specifying the filesystem type.
3914 For example a string such as C<ext3> or C<ntfs>.");
3916 ("truncate", (RErr, [Pathname "path"]), 199, [],
3917 [InitBasicFS, Always, TestOutputStruct (
3918 [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3919 ["truncate"; "/test"];
3920 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3921 "truncate a file to zero size",
3923 This command truncates C<path> to a zero-length file. The
3924 file must exist already.");
3926 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3927 [InitBasicFS, Always, TestOutputStruct (
3928 [["touch"; "/test"];
3929 ["truncate_size"; "/test"; "1000"];
3930 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3931 "truncate a file to a particular size",
3933 This command truncates C<path> to size C<size> bytes. The file
3936 If the current file size is less than C<size> then
3937 the file is extended to the required size with zero bytes.
3938 This creates a sparse file (ie. disk blocks are not allocated
3939 for the file until you write to it). To create a non-sparse
3940 file of zeroes, use C<guestfs_fallocate64> instead.");
3942 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3943 [InitBasicFS, Always, TestOutputStruct (
3944 [["touch"; "/test"];
3945 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3946 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3947 "set timestamp of a file with nanosecond precision",
3949 This command sets the timestamps of a file with nanosecond
3952 C<atsecs, atnsecs> are the last access time (atime) in secs and
3953 nanoseconds from the epoch.
3955 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3956 secs and nanoseconds from the epoch.
3958 If the C<*nsecs> field contains the special value C<-1> then
3959 the corresponding timestamp is set to the current time. (The
3960 C<*secs> field is ignored in this case).
3962 If the C<*nsecs> field contains the special value C<-2> then
3963 the corresponding timestamp is left unchanged. (The
3964 C<*secs> field is ignored in this case).");
3966 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3967 [InitBasicFS, Always, TestOutputStruct (
3968 [["mkdir_mode"; "/test"; "0o111"];
3969 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3970 "create a directory with a particular mode",
3972 This command creates a directory, setting the initial permissions
3973 of the directory to C<mode>.
3975 For common Linux filesystems, the actual mode which is set will
3976 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
3977 interpret the mode in other ways.
3979 See also C<guestfs_mkdir>, C<guestfs_umask>");
3981 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3983 "change file owner and group",
3985 Change the file owner to C<owner> and group to C<group>.
3986 This is like C<guestfs_chown> but if C<path> is a symlink then
3987 the link itself is changed, not the target.
3989 Only numeric uid and gid are supported. If you want to use
3990 names, you will need to locate and parse the password file
3991 yourself (Augeas support makes this relatively easy).");
3993 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3995 "lstat on multiple files",
3997 This call allows you to perform the C<guestfs_lstat> operation
3998 on multiple files, where all files are in the directory C<path>.
3999 C<names> is the list of files from this directory.
4001 On return you get a list of stat structs, with a one-to-one
4002 correspondence to the C<names> list. If any name did not exist
4003 or could not be lstat'd, then the C<ino> field of that structure
4006 This call is intended for programs that want to efficiently
4007 list a directory contents without making many round-trips.
4008 See also C<guestfs_lxattrlist> for a similarly efficient call
4009 for getting extended attributes. Very long directory listings
4010 might cause the protocol message size to be exceeded, causing
4011 this call to fail. The caller must split up such requests
4012 into smaller groups of names.");
4014 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4016 "lgetxattr on multiple files",
4018 This call allows you to get the extended attributes
4019 of multiple files, where all files are in the directory C<path>.
4020 C<names> is the list of files from this directory.
4022 On return you get a flat list of xattr structs which must be
4023 interpreted sequentially. The first xattr struct always has a zero-length
4024 C<attrname>. C<attrval> in this struct is zero-length
4025 to indicate there was an error doing C<lgetxattr> for this
4026 file, I<or> is a C string which is a decimal number
4027 (the number of following attributes for this file, which could
4028 be C<\"0\">). Then after the first xattr struct are the
4029 zero or more attributes for the first named file.
4030 This repeats for the second and subsequent files.
4032 This call is intended for programs that want to efficiently
4033 list a directory contents without making many round-trips.
4034 See also C<guestfs_lstatlist> for a similarly efficient call
4035 for getting standard stats. Very long directory listings
4036 might cause the protocol message size to be exceeded, causing
4037 this call to fail. The caller must split up such requests
4038 into smaller groups of names.");
4040 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4042 "readlink on multiple files",
4044 This call allows you to do a C<readlink> operation
4045 on multiple files, where all files are in the directory C<path>.
4046 C<names> is the list of files from this directory.
4048 On return you get a list of strings, with a one-to-one
4049 correspondence to the C<names> list. Each string is the
4050 value of the symbolic link.
4052 If the C<readlink(2)> operation fails on any name, then
4053 the corresponding result string is the empty string C<\"\">.
4054 However the whole operation is completed even if there
4055 were C<readlink(2)> errors, and so you can call this
4056 function with names where you don't know if they are
4057 symbolic links already (albeit slightly less efficient).
4059 This call is intended for programs that want to efficiently
4060 list a directory contents without making many round-trips.
4061 Very long directory listings might cause the protocol
4062 message size to be exceeded, causing
4063 this call to fail. The caller must split up such requests
4064 into smaller groups of names.");
4066 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4067 [InitISOFS, Always, TestOutputBuffer (
4068 [["pread"; "/known-4"; "1"; "3"]], "\n");
4069 InitISOFS, Always, TestOutputBuffer (
4070 [["pread"; "/empty"; "0"; "100"]], "")],
4071 "read part of a file",
4073 This command lets you read part of a file. It reads C<count>
4074 bytes of the file, starting at C<offset>, from file C<path>.
4076 This may read fewer bytes than requested. For further details
4077 see the L<pread(2)> system call.");
4079 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4080 [InitEmpty, Always, TestRun (
4081 [["part_init"; "/dev/sda"; "gpt"]])],
4082 "create an empty partition table",
4084 This creates an empty partition table on C<device> of one of the
4085 partition types listed below. Usually C<parttype> should be
4086 either C<msdos> or C<gpt> (for large disks).
4088 Initially there are no partitions. Following this, you should
4089 call C<guestfs_part_add> for each partition required.
4091 Possible values for C<parttype> are:
4095 =item B<efi> | B<gpt>
4097 Intel EFI / GPT partition table.
4099 This is recommended for >= 2 TB partitions that will be accessed
4100 from Linux and Intel-based Mac OS X. It also has limited backwards
4101 compatibility with the C<mbr> format.
4103 =item B<mbr> | B<msdos>
4105 The standard PC \"Master Boot Record\" (MBR) format used
4106 by MS-DOS and Windows. This partition type will B<only> work
4107 for device sizes up to 2 TB. For large disks we recommend
4112 Other partition table types that may work but are not
4121 =item B<amiga> | B<rdb>
4123 Amiga \"Rigid Disk Block\" format.
4131 DASD, used on IBM mainframes.
4139 Old Mac partition format. Modern Macs use C<gpt>.
4143 NEC PC-98 format, common in Japan apparently.
4151 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4152 [InitEmpty, Always, TestRun (
4153 [["part_init"; "/dev/sda"; "mbr"];
4154 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4155 InitEmpty, Always, TestRun (
4156 [["part_init"; "/dev/sda"; "gpt"];
4157 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4158 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4159 InitEmpty, Always, TestRun (
4160 [["part_init"; "/dev/sda"; "mbr"];
4161 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4162 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4163 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4164 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4165 "add a partition to the device",
4167 This command adds a partition to C<device>. If there is no partition
4168 table on the device, call C<guestfs_part_init> first.
4170 The C<prlogex> parameter is the type of partition. Normally you
4171 should pass C<p> or C<primary> here, but MBR partition tables also
4172 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4175 C<startsect> and C<endsect> are the start and end of the partition
4176 in I<sectors>. C<endsect> may be negative, which means it counts
4177 backwards from the end of the disk (C<-1> is the last sector).
4179 Creating a partition which covers the whole disk is not so easy.
4180 Use C<guestfs_part_disk> to do that.");
4182 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4183 [InitEmpty, Always, TestRun (
4184 [["part_disk"; "/dev/sda"; "mbr"]]);
4185 InitEmpty, Always, TestRun (
4186 [["part_disk"; "/dev/sda"; "gpt"]])],
4187 "partition whole disk with a single primary partition",
4189 This command is simply a combination of C<guestfs_part_init>
4190 followed by C<guestfs_part_add> to create a single primary partition
4191 covering the whole disk.
4193 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4194 but other possible values are described in C<guestfs_part_init>.");
4196 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4197 [InitEmpty, Always, TestRun (
4198 [["part_disk"; "/dev/sda"; "mbr"];
4199 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4200 "make a partition bootable",
4202 This sets the bootable flag on partition numbered C<partnum> on
4203 device C<device>. Note that partitions are numbered from 1.
4205 The bootable flag is used by some operating systems (notably
4206 Windows) to determine which partition to boot from. It is by
4207 no means universally recognized.");
4209 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4210 [InitEmpty, Always, TestRun (
4211 [["part_disk"; "/dev/sda"; "gpt"];
4212 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4213 "set partition name",
4215 This sets the partition name on partition numbered C<partnum> on
4216 device C<device>. Note that partitions are numbered from 1.
4218 The partition name can only be set on certain types of partition
4219 table. This works on C<gpt> but not on C<mbr> partitions.");
4221 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4222 [], (* XXX Add a regression test for this. *)
4223 "list partitions on a device",
4225 This command parses the partition table on C<device> and
4226 returns the list of partitions found.
4228 The fields in the returned structure are:
4234 Partition number, counting from 1.
4238 Start of the partition I<in bytes>. To get sectors you have to
4239 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4243 End of the partition in bytes.
4247 Size of the partition in bytes.
4251 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4252 [InitEmpty, Always, TestOutput (
4253 [["part_disk"; "/dev/sda"; "gpt"];
4254 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4255 "get the partition table type",
4257 This command examines the partition table on C<device> and
4258 returns the partition table type (format) being used.
4260 Common return values include: C<msdos> (a DOS/Windows style MBR
4261 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4262 values are possible, although unusual. See C<guestfs_part_init>
4265 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4266 [InitBasicFS, Always, TestOutputBuffer (
4267 [["fill"; "0x63"; "10"; "/test"];
4268 ["read_file"; "/test"]], "cccccccccc")],
4269 "fill a file with octets",
4271 This command creates a new file called C<path>. The initial
4272 content of the file is C<len> octets of C<c>, where C<c>
4273 must be a number in the range C<[0..255]>.
4275 To fill a file with zero bytes (sparsely), it is
4276 much more efficient to use C<guestfs_truncate_size>.");
4278 ("available", (RErr, [StringList "groups"]), 216, [],
4279 [InitNone, Always, TestRun [["available"; ""]]],
4280 "test availability of some parts of the API",
4282 This command is used to check the availability of some
4283 groups of functionality in the appliance, which not all builds of
4284 the libguestfs appliance will be able to provide.
4286 The libguestfs groups, and the functions that those
4287 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4289 The argument C<groups> is a list of group names, eg:
4290 C<[\"inotify\", \"augeas\"]> would check for the availability of
4291 the Linux inotify functions and Augeas (configuration file
4294 The command returns no error if I<all> requested groups are available.
4296 It fails with an error if one or more of the requested
4297 groups is unavailable in the appliance.
4299 If an unknown group name is included in the
4300 list of groups then an error is always returned.
4308 You must call C<guestfs_launch> before calling this function.
4310 The reason is because we don't know what groups are
4311 supported by the appliance/daemon until it is running and can
4316 If a group of functions is available, this does not necessarily
4317 mean that they will work. You still have to check for errors
4318 when calling individual API functions even if they are
4323 It is usually the job of distro packagers to build
4324 complete functionality into the libguestfs appliance.
4325 Upstream libguestfs, if built from source with all
4326 requirements satisfied, will support everything.
4330 This call was added in version C<1.0.80>. In previous
4331 versions of libguestfs all you could do would be to speculatively
4332 execute a command to find out if the daemon implemented it.
4333 See also C<guestfs_version>.
4337 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4338 [InitBasicFS, Always, TestOutputBuffer (
4339 [["write_file"; "/src"; "hello, world"; "0"];
4340 ["dd"; "/src"; "/dest"];
4341 ["read_file"; "/dest"]], "hello, world")],
4342 "copy from source to destination using dd",
4344 This command copies from one source device or file C<src>
4345 to another destination device or file C<dest>. Normally you
4346 would use this to copy to or from a device or partition, for
4347 example to duplicate a filesystem.
4349 If the destination is a device, it must be as large or larger
4350 than the source file or device, otherwise the copy will fail.
4351 This command cannot do partial copies (see C<guestfs_copy_size>).");
4353 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4354 [InitBasicFS, Always, TestOutputInt (
4355 [["write_file"; "/file"; "hello, world"; "0"];
4356 ["filesize"; "/file"]], 12)],
4357 "return the size of the file in bytes",
4359 This command returns the size of C<file> in bytes.
4361 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4362 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4363 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4365 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4366 [InitBasicFSonLVM, Always, TestOutputList (
4367 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4368 ["lvs"]], ["/dev/VG/LV2"])],
4369 "rename an LVM logical volume",
4371 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4373 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4374 [InitBasicFSonLVM, Always, TestOutputList (
4376 ["vg_activate"; "false"; "VG"];
4377 ["vgrename"; "VG"; "VG2"];
4378 ["vg_activate"; "true"; "VG2"];
4379 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4380 ["vgs"]], ["VG2"])],
4381 "rename an LVM volume group",
4383 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4385 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4386 [InitISOFS, Always, TestOutputBuffer (
4387 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4388 "list the contents of a single file in an initrd",
4390 This command unpacks the file C<filename> from the initrd file
4391 called C<initrdpath>. The filename must be given I<without> the
4392 initial C</> character.
4394 For example, in guestfish you could use the following command
4395 to examine the boot script (usually called C</init>)
4396 contained in a Linux initrd or initramfs image:
4398 initrd-cat /boot/initrd-<version>.img init
4400 See also C<guestfs_initrd_list>.");
4402 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4404 "get the UUID of a physical volume",
4406 This command returns the UUID of the LVM PV C<device>.");
4408 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4410 "get the UUID of a volume group",
4412 This command returns the UUID of the LVM VG named C<vgname>.");
4414 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4416 "get the UUID of a logical volume",
4418 This command returns the UUID of the LVM LV C<device>.");
4420 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4422 "get the PV UUIDs containing the volume group",
4424 Given a VG called C<vgname>, this returns the UUIDs of all
4425 the physical volumes that this volume group resides on.
4427 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4428 calls to associate physical volumes and volume groups.
4430 See also C<guestfs_vglvuuids>.");
4432 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4434 "get the LV UUIDs of all LVs in the volume group",
4436 Given a VG called C<vgname>, this returns the UUIDs of all
4437 the logical volumes created in this volume group.
4439 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4440 calls to associate logical volumes and volume groups.
4442 See also C<guestfs_vgpvuuids>.");
4444 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4445 [InitBasicFS, Always, TestOutputBuffer (
4446 [["write_file"; "/src"; "hello, world"; "0"];
4447 ["copy_size"; "/src"; "/dest"; "5"];
4448 ["read_file"; "/dest"]], "hello")],
4449 "copy size bytes from source to destination using dd",
4451 This command copies exactly C<size> bytes from one source device
4452 or file C<src> to another destination device or file C<dest>.
4454 Note this will fail if the source is too short or if the destination
4455 is not large enough.");
4457 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4458 [InitEmpty, Always, TestRun (
4459 [["part_init"; "/dev/sda"; "mbr"];
4460 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4461 ["part_del"; "/dev/sda"; "1"]])],
4462 "delete a partition",
4464 This command deletes the partition numbered C<partnum> on C<device>.
4466 Note that in the case of MBR partitioning, deleting an
4467 extended partition also deletes any logical partitions
4470 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4471 [InitEmpty, Always, TestOutputTrue (
4472 [["part_init"; "/dev/sda"; "mbr"];
4473 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4474 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4475 ["part_get_bootable"; "/dev/sda"; "1"]])],
4476 "return true if a partition is bootable",
4478 This command returns true if the partition C<partnum> on
4479 C<device> has the bootable flag set.
4481 See also C<guestfs_part_set_bootable>.");
4483 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [],
4484 [InitEmpty, Always, TestOutputInt (
4485 [["part_init"; "/dev/sda"; "mbr"];
4486 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4487 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4488 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4489 "get the MBR type byte (ID byte) from a partition",
4491 Returns the MBR type byte (also known as the ID byte) from
4492 the numbered partition C<partnum>.
4494 Note that only MBR (old DOS-style) partitions have type bytes.
4495 You will get undefined results for other partition table
4496 types (see C<guestfs_part_get_parttype>).");
4498 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4499 [], (* tested by part_get_mbr_id *)
4500 "set the MBR type byte (ID byte) of a partition",
4502 Sets the MBR type byte (also known as the ID byte) of
4503 the numbered partition C<partnum> to C<idbyte>. Note
4504 that the type bytes quoted in most documentation are
4505 in fact hexadecimal numbers, but usually documented
4506 without any leading \"0x\" which might be confusing.
4508 Note that only MBR (old DOS-style) partitions have type bytes.
4509 You will get undefined results for other partition table
4510 types (see C<guestfs_part_get_parttype>).");
4514 let all_functions = non_daemon_functions @ daemon_functions
4516 (* In some places we want the functions to be displayed sorted
4517 * alphabetically, so this is useful:
4519 let all_functions_sorted =
4520 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4521 compare n1 n2) all_functions
4523 (* Field types for structures. *)
4525 | FChar (* C 'char' (really, a 7 bit byte). *)
4526 | FString (* nul-terminated ASCII string, NOT NULL. *)
4527 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4532 | FBytes (* Any int measure that counts bytes. *)
4533 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4534 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4536 (* Because we generate extra parsing code for LVM command line tools,
4537 * we have to pull out the LVM columns separately here.
4547 "pv_attr", FString (* XXX *);
4548 "pv_pe_count", FInt64;
4549 "pv_pe_alloc_count", FInt64;
4552 "pv_mda_count", FInt64;
4553 "pv_mda_free", FBytes;
4554 (* Not in Fedora 10:
4555 "pv_mda_size", FBytes;
4562 "vg_attr", FString (* XXX *);
4565 "vg_sysid", FString;
4566 "vg_extent_size", FBytes;
4567 "vg_extent_count", FInt64;
4568 "vg_free_count", FInt64;
4573 "snap_count", FInt64;
4576 "vg_mda_count", FInt64;
4577 "vg_mda_free", FBytes;
4578 (* Not in Fedora 10:
4579 "vg_mda_size", FBytes;
4585 "lv_attr", FString (* XXX *);
4588 "lv_kernel_major", FInt64;
4589 "lv_kernel_minor", FInt64;
4591 "seg_count", FInt64;
4593 "snap_percent", FOptPercent;
4594 "copy_percent", FOptPercent;
4597 "mirror_log", FString;
4601 (* Names and fields in all structures (in RStruct and RStructList)
4605 (* The old RIntBool return type, only ever used for aug_defnode. Do
4606 * not use this struct in any new code.
4609 "i", FInt32; (* for historical compatibility *)
4610 "b", FInt32; (* for historical compatibility *)
4613 (* LVM PVs, VGs, LVs. *)
4614 "lvm_pv", lvm_pv_cols;
4615 "lvm_vg", lvm_vg_cols;
4616 "lvm_lv", lvm_lv_cols;
4618 (* Column names and types from stat structures.
4619 * NB. Can't use things like 'st_atime' because glibc header files
4620 * define some of these as macros. Ugh.
4651 (* Column names in dirent structure. *)
4654 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4659 (* Version numbers. *)
4667 (* Extended attribute. *)
4669 "attrname", FString;
4673 (* Inotify events. *)
4677 "in_cookie", FUInt32;
4681 (* Partition table entry. *)
4684 "part_start", FBytes;
4686 "part_size", FBytes;
4688 ] (* end of structs *)
4690 (* Ugh, Java has to be different ..
4691 * These names are also used by the Haskell bindings.
4693 let java_structs = [
4694 "int_bool", "IntBool";
4699 "statvfs", "StatVFS";
4701 "version", "Version";
4703 "inotify_event", "INotifyEvent";
4704 "partition", "Partition";
4707 (* What structs are actually returned. *)
4708 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4710 (* Returns a list of RStruct/RStructList structs that are returned
4711 * by any function. Each element of returned list is a pair:
4713 * (structname, RStructOnly)
4714 * == there exists function which returns RStruct (_, structname)
4715 * (structname, RStructListOnly)
4716 * == there exists function which returns RStructList (_, structname)
4717 * (structname, RStructAndList)
4718 * == there are functions returning both RStruct (_, structname)
4719 * and RStructList (_, structname)
4721 let rstructs_used_by functions =
4722 (* ||| is a "logical OR" for rstructs_used_t *)
4726 | _, RStructAndList -> RStructAndList
4727 | RStructOnly, RStructListOnly
4728 | RStructListOnly, RStructOnly -> RStructAndList
4729 | RStructOnly, RStructOnly -> RStructOnly
4730 | RStructListOnly, RStructListOnly -> RStructListOnly
4733 let h = Hashtbl.create 13 in
4735 (* if elem->oldv exists, update entry using ||| operator,
4736 * else just add elem->newv to the hash
4738 let update elem newv =
4739 try let oldv = Hashtbl.find h elem in
4740 Hashtbl.replace h elem (newv ||| oldv)
4741 with Not_found -> Hashtbl.add h elem newv
4745 fun (_, style, _, _, _, _, _) ->
4746 match fst style with
4747 | RStruct (_, structname) -> update structname RStructOnly
4748 | RStructList (_, structname) -> update structname RStructListOnly
4752 (* return key->values as a list of (key,value) *)
4753 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4755 (* Used for testing language bindings. *)
4757 | CallString of string
4758 | CallOptString of string option
4759 | CallStringList of string list
4761 | CallInt64 of int64
4764 (* Used to memoize the result of pod2text. *)
4765 let pod2text_memo_filename = "src/.pod2text.data"
4766 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4768 let chan = open_in pod2text_memo_filename in
4769 let v = input_value chan in
4773 _ -> Hashtbl.create 13
4774 let pod2text_memo_updated () =
4775 let chan = open_out pod2text_memo_filename in
4776 output_value chan pod2text_memo;
4779 (* Useful functions.
4780 * Note we don't want to use any external OCaml libraries which
4781 * makes this a bit harder than it should be.
4783 module StringMap = Map.Make (String)
4785 let failwithf fs = ksprintf failwith fs
4787 let unique = let i = ref 0 in fun () -> incr i; !i
4789 let replace_char s c1 c2 =
4790 let s2 = String.copy s in
4791 let r = ref false in
4792 for i = 0 to String.length s2 - 1 do
4793 if String.unsafe_get s2 i = c1 then (
4794 String.unsafe_set s2 i c2;
4798 if not !r then s else s2
4802 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4804 let triml ?(test = isspace) str =
4806 let n = ref (String.length str) in
4807 while !n > 0 && test str.[!i]; do
4812 else String.sub str !i !n
4814 let trimr ?(test = isspace) str =
4815 let n = ref (String.length str) in
4816 while !n > 0 && test str.[!n-1]; do
4819 if !n = String.length str then str
4820 else String.sub str 0 !n
4822 let trim ?(test = isspace) str =
4823 trimr ~test (triml ~test str)
4825 let rec find s sub =
4826 let len = String.length s in
4827 let sublen = String.length sub in
4829 if i <= len-sublen then (
4831 if j < sublen then (
4832 if s.[i+j] = sub.[j] then loop2 (j+1)
4838 if r = -1 then loop (i+1) else r
4844 let rec replace_str s s1 s2 =
4845 let len = String.length s in
4846 let sublen = String.length s1 in
4847 let i = find s s1 in
4850 let s' = String.sub s 0 i in
4851 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4852 s' ^ s2 ^ replace_str s'' s1 s2
4855 let rec string_split sep str =
4856 let len = String.length str in
4857 let seplen = String.length sep in
4858 let i = find str sep in
4859 if i = -1 then [str]
4861 let s' = String.sub str 0 i in
4862 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4863 s' :: string_split sep s''
4866 let files_equal n1 n2 =
4867 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4868 match Sys.command cmd with
4871 | i -> failwithf "%s: failed with error code %d" cmd i
4873 let rec filter_map f = function
4877 | Some y -> y :: filter_map f xs
4878 | None -> filter_map f xs
4880 let rec find_map f = function
4881 | [] -> raise Not_found
4885 | None -> find_map f xs
4888 let rec loop i = function
4890 | x :: xs -> f i x; loop (i+1) xs
4895 let rec loop i = function
4897 | x :: xs -> let r = f i x in r :: loop (i+1) xs
4901 let count_chars c str =
4902 let count = ref 0 in
4903 for i = 0 to String.length str - 1 do
4904 if c = String.unsafe_get str i then incr count
4908 let name_of_argt = function
4909 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4910 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4911 | FileIn n | FileOut n -> n
4913 let java_name_of_struct typ =
4914 try List.assoc typ java_structs
4917 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4919 let cols_of_struct typ =
4920 try List.assoc typ structs
4922 failwithf "cols_of_struct: unknown struct %s" typ
4924 let seq_of_test = function
4925 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4926 | TestOutputListOfDevices (s, _)
4927 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4928 | TestOutputTrue s | TestOutputFalse s
4929 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4930 | TestOutputStruct (s, _)
4931 | TestLastFail s -> s
4933 (* Handling for function flags. *)
4934 let protocol_limit_warning =
4935 "Because of the message protocol, there is a transfer limit
4936 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4938 let danger_will_robinson =
4939 "B<This command is dangerous. Without careful use you
4940 can easily destroy all your data>."
4942 let deprecation_notice flags =
4945 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4947 sprintf "This function is deprecated.
4948 In new code, use the C<%s> call instead.
4950 Deprecated functions will not be removed from the API, but the
4951 fact that they are deprecated indicates that there are problems
4952 with correct use of these functions." alt in
4957 (* Create list of optional groups. *)
4959 let h = Hashtbl.create 13 in
4961 fun (name, _, _, flags, _, _, _) ->
4965 let names = try Hashtbl.find h group with Not_found -> [] in
4966 Hashtbl.replace h group (name :: names)
4970 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4973 fun group -> group, List.sort compare (Hashtbl.find h group)
4975 List.sort (fun x y -> compare (fst x) (fst y)) groups
4977 (* Check function names etc. for consistency. *)
4978 let check_functions () =
4979 let contains_uppercase str =
4980 let len = String.length str in
4982 if i >= len then false
4985 if c >= 'A' && c <= 'Z' then true
4992 (* Check function names. *)
4994 fun (name, _, _, _, _, _, _) ->
4995 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4996 failwithf "function name %s does not need 'guestfs' prefix" name;
4998 failwithf "function name is empty";
4999 if name.[0] < 'a' || name.[0] > 'z' then
5000 failwithf "function name %s must start with lowercase a-z" name;
5001 if String.contains name '-' then
5002 failwithf "function name %s should not contain '-', use '_' instead."
5006 (* Check function parameter/return names. *)
5008 fun (name, style, _, _, _, _, _) ->
5009 let check_arg_ret_name n =
5010 if contains_uppercase n then
5011 failwithf "%s param/ret %s should not contain uppercase chars"
5013 if String.contains n '-' || String.contains n '_' then
5014 failwithf "%s param/ret %s should not contain '-' or '_'"
5017 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;
5018 if n = "int" || n = "char" || n = "short" || n = "long" then
5019 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5020 if n = "i" || n = "n" then
5021 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5022 if n = "argv" || n = "args" then
5023 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5025 (* List Haskell, OCaml and C keywords here.
5026 * http://www.haskell.org/haskellwiki/Keywords
5027 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5028 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5029 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5030 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5031 * Omitting _-containing words, since they're handled above.
5032 * Omitting the OCaml reserved word, "val", is ok,
5033 * and saves us from renaming several parameters.
5036 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5037 "char"; "class"; "const"; "constraint"; "continue"; "data";
5038 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5039 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5040 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5041 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5042 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5044 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5045 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5046 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5047 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5048 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5049 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5050 "volatile"; "when"; "where"; "while";
5052 if List.mem n reserved then
5053 failwithf "%s has param/ret using reserved word %s" name n;
5056 (match fst style with
5058 | RInt n | RInt64 n | RBool n
5059 | RConstString n | RConstOptString n | RString n
5060 | RStringList n | RStruct (n, _) | RStructList (n, _)
5061 | RHashtable n | RBufferOut n ->
5062 check_arg_ret_name n
5064 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5067 (* Check short descriptions. *)
5069 fun (name, _, _, _, _, shortdesc, _) ->
5070 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5071 failwithf "short description of %s should begin with lowercase." name;
5072 let c = shortdesc.[String.length shortdesc-1] in
5073 if c = '\n' || c = '.' then
5074 failwithf "short description of %s should not end with . or \\n." name
5077 (* Check long descriptions. *)
5079 fun (name, _, _, _, _, _, longdesc) ->
5080 if longdesc.[String.length longdesc-1] = '\n' then
5081 failwithf "long description of %s should not end with \\n." name
5084 (* Check proc_nrs. *)
5086 fun (name, _, proc_nr, _, _, _, _) ->
5087 if proc_nr <= 0 then
5088 failwithf "daemon function %s should have proc_nr > 0" name
5092 fun (name, _, proc_nr, _, _, _, _) ->
5093 if proc_nr <> -1 then
5094 failwithf "non-daemon function %s should have proc_nr -1" name
5095 ) non_daemon_functions;
5098 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5101 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5102 let rec loop = function
5105 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5107 | (name1,nr1) :: (name2,nr2) :: _ ->
5108 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5116 (* Ignore functions that have no tests. We generate a
5117 * warning when the user does 'make check' instead.
5119 | name, _, _, _, [], _, _ -> ()
5120 | name, _, _, _, tests, _, _ ->
5124 match seq_of_test test with
5126 failwithf "%s has a test containing an empty sequence" name
5127 | cmds -> List.map List.hd cmds
5129 let funcs = List.flatten funcs in
5131 let tested = List.mem name funcs in
5134 failwithf "function %s has tests but does not test itself" name
5137 (* 'pr' prints to the current output file. *)
5138 let chan = ref Pervasives.stdout
5143 let i = count_chars '\n' str in
5144 lines := !lines + i;
5145 output_string !chan str
5148 let copyright_years =
5149 let this_year = 1900 + (localtime (time ())).tm_year in
5150 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5152 (* Generate a header block in a number of standard styles. *)
5153 type comment_style =
5154 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5155 type license = GPLv2plus | LGPLv2plus
5157 let generate_header ?(extra_inputs = []) comment license =
5158 let inputs = "src/generator.ml" :: extra_inputs in
5159 let c = match comment with
5160 | CStyle -> pr "/* "; " *"
5161 | CPlusPlusStyle -> pr "// "; "//"
5162 | HashStyle -> pr "# "; "#"
5163 | OCamlStyle -> pr "(* "; " *"
5164 | HaskellStyle -> pr "{- "; " " in
5165 pr "libguestfs generated file\n";
5166 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5167 List.iter (pr "%s %s\n" c) inputs;
5168 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5170 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5174 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5175 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5176 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5177 pr "%s (at your option) any later version.\n" c;
5179 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5180 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5181 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5182 pr "%s GNU General Public License for more details.\n" c;
5184 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5185 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5186 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5189 pr "%s This library is free software; you can redistribute it and/or\n" c;
5190 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5191 pr "%s License as published by the Free Software Foundation; either\n" c;
5192 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5194 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5195 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5196 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5197 pr "%s Lesser General Public License for more details.\n" c;
5199 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5200 pr "%s License along with this library; if not, write to the Free Software\n" c;
5201 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5204 | CStyle -> pr " */\n"
5207 | OCamlStyle -> pr " *)\n"
5208 | HaskellStyle -> pr "-}\n"
5212 (* Start of main code generation functions below this line. *)
5214 (* Generate the pod documentation for the C API. *)
5215 let rec generate_actions_pod () =
5217 fun (shortname, style, _, flags, _, _, longdesc) ->
5218 if not (List.mem NotInDocs flags) then (
5219 let name = "guestfs_" ^ shortname in
5220 pr "=head2 %s\n\n" name;
5222 generate_prototype ~extern:false ~handle:"g" name style;
5224 pr "%s\n\n" longdesc;
5225 (match fst style with
5227 pr "This function returns 0 on success or -1 on error.\n\n"
5229 pr "On error this function returns -1.\n\n"
5231 pr "On error this function returns -1.\n\n"
5233 pr "This function returns a C truth value on success or -1 on error.\n\n"
5235 pr "This function returns a string, or NULL on error.
5236 The string is owned by the guest handle and must I<not> be freed.\n\n"
5237 | RConstOptString _ ->
5238 pr "This function returns a string which may be NULL.
5239 There is no way to return an error from this function.
5240 The string is owned by the guest handle and must I<not> be freed.\n\n"
5242 pr "This function returns a string, or NULL on error.
5243 I<The caller must free the returned string after use>.\n\n"
5245 pr "This function returns a NULL-terminated array of strings
5246 (like L<environ(3)>), or NULL if there was an error.
5247 I<The caller must free the strings and the array after use>.\n\n"
5248 | RStruct (_, typ) ->
5249 pr "This function returns a C<struct guestfs_%s *>,
5250 or NULL if there was an error.
5251 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5252 | RStructList (_, typ) ->
5253 pr "This function returns a C<struct guestfs_%s_list *>
5254 (see E<lt>guestfs-structs.hE<gt>),
5255 or NULL if there was an error.
5256 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5258 pr "This function returns a NULL-terminated array of
5259 strings, or NULL if there was an error.
5260 The array of strings will always have length C<2n+1>, where
5261 C<n> keys and values alternate, followed by the trailing NULL entry.
5262 I<The caller must free the strings and the array after use>.\n\n"
5264 pr "This function returns a buffer, or NULL on error.
5265 The size of the returned buffer is written to C<*size_r>.
5266 I<The caller must free the returned buffer after use>.\n\n"
5268 if List.mem ProtocolLimitWarning flags then
5269 pr "%s\n\n" protocol_limit_warning;
5270 if List.mem DangerWillRobinson flags then
5271 pr "%s\n\n" danger_will_robinson;
5272 match deprecation_notice flags with
5274 | Some txt -> pr "%s\n\n" txt
5276 ) all_functions_sorted
5278 and generate_structs_pod () =
5279 (* Structs documentation. *)
5282 pr "=head2 guestfs_%s\n" typ;
5284 pr " struct guestfs_%s {\n" typ;
5287 | name, FChar -> pr " char %s;\n" name
5288 | name, FUInt32 -> pr " uint32_t %s;\n" name
5289 | name, FInt32 -> pr " int32_t %s;\n" name
5290 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5291 | name, FInt64 -> pr " int64_t %s;\n" name
5292 | name, FString -> pr " char *%s;\n" name
5294 pr " /* The next two fields describe a byte array. */\n";
5295 pr " uint32_t %s_len;\n" name;
5296 pr " char *%s;\n" name
5298 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5299 pr " char %s[32];\n" name
5300 | name, FOptPercent ->
5301 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5302 pr " float %s;\n" name
5306 pr " struct guestfs_%s_list {\n" typ;
5307 pr " uint32_t len; /* Number of elements in list. */\n";
5308 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5311 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5312 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5317 and generate_availability_pod () =
5318 (* Availability documentation. *)
5322 fun (group, functions) ->
5323 pr "=item B<%s>\n" group;
5325 pr "The following functions:\n";
5326 List.iter (pr "L</guestfs_%s>\n") functions;
5332 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5333 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5335 * We have to use an underscore instead of a dash because otherwise
5336 * rpcgen generates incorrect code.
5338 * This header is NOT exported to clients, but see also generate_structs_h.
5340 and generate_xdr () =
5341 generate_header CStyle LGPLv2plus;
5343 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5344 pr "typedef string str<>;\n";
5347 (* Internal structures. *)
5351 pr "struct guestfs_int_%s {\n" typ;
5353 | name, FChar -> pr " char %s;\n" name
5354 | name, FString -> pr " string %s<>;\n" name
5355 | name, FBuffer -> pr " opaque %s<>;\n" name
5356 | name, FUUID -> pr " opaque %s[32];\n" name
5357 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5358 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5359 | name, FOptPercent -> pr " float %s;\n" name
5363 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5368 fun (shortname, style, _, _, _, _, _) ->
5369 let name = "guestfs_" ^ shortname in
5371 (match snd style with
5374 pr "struct %s_args {\n" name;
5377 | Pathname n | Device n | Dev_or_Path n | String n ->
5378 pr " string %s<>;\n" n
5379 | OptString n -> pr " str *%s;\n" n
5380 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5381 | Bool n -> pr " bool %s;\n" n
5382 | Int n -> pr " int %s;\n" n
5383 | Int64 n -> pr " hyper %s;\n" n
5384 | FileIn _ | FileOut _ -> ()
5388 (match fst style with
5391 pr "struct %s_ret {\n" name;
5395 pr "struct %s_ret {\n" name;
5396 pr " hyper %s;\n" n;
5399 pr "struct %s_ret {\n" name;
5402 | RConstString _ | RConstOptString _ ->
5403 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5405 pr "struct %s_ret {\n" name;
5406 pr " string %s<>;\n" n;
5409 pr "struct %s_ret {\n" name;
5410 pr " str %s<>;\n" n;
5412 | RStruct (n, typ) ->
5413 pr "struct %s_ret {\n" name;
5414 pr " guestfs_int_%s %s;\n" typ n;
5416 | RStructList (n, typ) ->
5417 pr "struct %s_ret {\n" name;
5418 pr " guestfs_int_%s_list %s;\n" typ n;
5421 pr "struct %s_ret {\n" name;
5422 pr " str %s<>;\n" n;
5425 pr "struct %s_ret {\n" name;
5426 pr " opaque %s<>;\n" n;
5431 (* Table of procedure numbers. *)
5432 pr "enum guestfs_procedure {\n";
5434 fun (shortname, _, proc_nr, _, _, _, _) ->
5435 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5437 pr " GUESTFS_PROC_NR_PROCS\n";
5441 (* Having to choose a maximum message size is annoying for several
5442 * reasons (it limits what we can do in the API), but it (a) makes
5443 * the protocol a lot simpler, and (b) provides a bound on the size
5444 * of the daemon which operates in limited memory space.
5446 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5449 (* Message header, etc. *)
5451 /* The communication protocol is now documented in the guestfs(3)
5455 const GUESTFS_PROGRAM = 0x2000F5F5;
5456 const GUESTFS_PROTOCOL_VERSION = 1;
5458 /* These constants must be larger than any possible message length. */
5459 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5460 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5462 enum guestfs_message_direction {
5463 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5464 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5467 enum guestfs_message_status {
5468 GUESTFS_STATUS_OK = 0,
5469 GUESTFS_STATUS_ERROR = 1
5472 const GUESTFS_ERROR_LEN = 256;
5474 struct guestfs_message_error {
5475 string error_message<GUESTFS_ERROR_LEN>;
5478 struct guestfs_message_header {
5479 unsigned prog; /* GUESTFS_PROGRAM */
5480 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5481 guestfs_procedure proc; /* GUESTFS_PROC_x */
5482 guestfs_message_direction direction;
5483 unsigned serial; /* message serial number */
5484 guestfs_message_status status;
5487 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5489 struct guestfs_chunk {
5490 int cancel; /* if non-zero, transfer is cancelled */
5491 /* data size is 0 bytes if the transfer has finished successfully */
5492 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5496 (* Generate the guestfs-structs.h file. *)
5497 and generate_structs_h () =
5498 generate_header CStyle LGPLv2plus;
5500 (* This is a public exported header file containing various
5501 * structures. The structures are carefully written to have
5502 * exactly the same in-memory format as the XDR structures that
5503 * we use on the wire to the daemon. The reason for creating
5504 * copies of these structures here is just so we don't have to
5505 * export the whole of guestfs_protocol.h (which includes much
5506 * unrelated and XDR-dependent stuff that we don't want to be
5507 * public, or required by clients).
5509 * To reiterate, we will pass these structures to and from the
5510 * client with a simple assignment or memcpy, so the format
5511 * must be identical to what rpcgen / the RFC defines.
5514 (* Public structures. *)
5517 pr "struct guestfs_%s {\n" typ;
5520 | name, FChar -> pr " char %s;\n" name
5521 | name, FString -> pr " char *%s;\n" name
5523 pr " uint32_t %s_len;\n" name;
5524 pr " char *%s;\n" name
5525 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5526 | name, FUInt32 -> pr " uint32_t %s;\n" name
5527 | name, FInt32 -> pr " int32_t %s;\n" name
5528 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5529 | name, FInt64 -> pr " int64_t %s;\n" name
5530 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5534 pr "struct guestfs_%s_list {\n" typ;
5535 pr " uint32_t len;\n";
5536 pr " struct guestfs_%s *val;\n" typ;
5539 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5540 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5544 (* Generate the guestfs-actions.h file. *)
5545 and generate_actions_h () =
5546 generate_header CStyle LGPLv2plus;
5548 fun (shortname, style, _, _, _, _, _) ->
5549 let name = "guestfs_" ^ shortname in
5550 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5554 (* Generate the guestfs-internal-actions.h file. *)
5555 and generate_internal_actions_h () =
5556 generate_header CStyle LGPLv2plus;
5558 fun (shortname, style, _, _, _, _, _) ->
5559 let name = "guestfs__" ^ shortname in
5560 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5562 ) non_daemon_functions
5564 (* Generate the client-side dispatch stubs. *)
5565 and generate_client_actions () =
5566 generate_header CStyle LGPLv2plus;
5573 #include <inttypes.h>
5575 #include \"guestfs.h\"
5576 #include \"guestfs-internal.h\"
5577 #include \"guestfs-internal-actions.h\"
5578 #include \"guestfs_protocol.h\"
5580 #define error guestfs_error
5581 //#define perrorf guestfs_perrorf
5582 #define safe_malloc guestfs_safe_malloc
5583 #define safe_realloc guestfs_safe_realloc
5584 //#define safe_strdup guestfs_safe_strdup
5585 #define safe_memdup guestfs_safe_memdup
5587 /* Check the return message from a call for validity. */
5589 check_reply_header (guestfs_h *g,
5590 const struct guestfs_message_header *hdr,
5591 unsigned int proc_nr, unsigned int serial)
5593 if (hdr->prog != GUESTFS_PROGRAM) {
5594 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5597 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5598 error (g, \"wrong protocol version (%%d/%%d)\",
5599 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5602 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5603 error (g, \"unexpected message direction (%%d/%%d)\",
5604 hdr->direction, GUESTFS_DIRECTION_REPLY);
5607 if (hdr->proc != proc_nr) {
5608 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5611 if (hdr->serial != serial) {
5612 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5619 /* Check we are in the right state to run a high-level action. */
5621 check_state (guestfs_h *g, const char *caller)
5623 if (!guestfs__is_ready (g)) {
5624 if (guestfs__is_config (g) || guestfs__is_launching (g))
5625 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5628 error (g, \"%%s called from the wrong state, %%d != READY\",
5629 caller, guestfs__get_state (g));
5637 (* Generate code to generate guestfish call traces. *)
5638 let trace_call shortname style =
5639 pr " if (guestfs__get_trace (g)) {\n";
5642 List.exists (function
5643 | StringList _ | DeviceList _ -> true
5644 | _ -> false) (snd style) in
5650 pr " printf (\"%s\");\n" shortname;
5653 | String n (* strings *)
5659 (* guestfish doesn't support string escaping, so neither do we *)
5660 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5661 | OptString n -> (* string option *)
5662 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5663 pr " else printf (\" null\");\n"
5665 | DeviceList n -> (* string list *)
5666 pr " putchar (' ');\n";
5667 pr " putchar ('\"');\n";
5668 pr " for (i = 0; %s[i]; ++i) {\n" n;
5669 pr " if (i > 0) putchar (' ');\n";
5670 pr " fputs (%s[i], stdout);\n" n;
5672 pr " putchar ('\"');\n";
5673 | Bool n -> (* boolean *)
5674 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5675 | Int n -> (* int *)
5676 pr " printf (\" %%d\", %s);\n" n
5678 pr " printf (\" %%\" PRIi64, %s);\n" n
5680 pr " putchar ('\\n');\n";
5685 (* For non-daemon functions, generate a wrapper around each function. *)
5687 fun (shortname, style, _, _, _, _, _) ->
5688 let name = "guestfs_" ^ shortname in
5690 generate_prototype ~extern:false ~semicolon:false ~newline:true
5691 ~handle:"g" name style;
5693 trace_call shortname style;
5694 pr " return guestfs__%s " shortname;
5695 generate_c_call_args ~handle:"g" style;
5699 ) non_daemon_functions;
5701 (* Client-side stubs for each function. *)
5703 fun (shortname, style, _, _, _, _, _) ->
5704 let name = "guestfs_" ^ shortname in
5706 (* Generate the action stub. *)
5707 generate_prototype ~extern:false ~semicolon:false ~newline:true
5708 ~handle:"g" name style;
5711 match fst style with
5712 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5713 | RConstString _ | RConstOptString _ ->
5714 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5715 | RString _ | RStringList _
5716 | RStruct _ | RStructList _
5717 | RHashtable _ | RBufferOut _ ->
5722 (match snd style with
5724 | _ -> pr " struct %s_args args;\n" name
5727 pr " guestfs_message_header hdr;\n";
5728 pr " guestfs_message_error err;\n";
5730 match fst style with
5732 | RConstString _ | RConstOptString _ ->
5733 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5735 | RBool _ | RString _ | RStringList _
5736 | RStruct _ | RStructList _
5737 | RHashtable _ | RBufferOut _ ->
5738 pr " struct %s_ret ret;\n" name;
5741 pr " int serial;\n";
5744 trace_call shortname style;
5745 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5746 pr " guestfs___set_busy (g);\n";
5749 (* Send the main header and arguments. *)
5750 (match snd style with
5752 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5753 (String.uppercase shortname)
5757 | Pathname n | Device n | Dev_or_Path n | String n ->
5758 pr " args.%s = (char *) %s;\n" n n
5760 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5761 | StringList n | DeviceList n ->
5762 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5763 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5765 pr " args.%s = %s;\n" n n
5767 pr " args.%s = %s;\n" n n
5769 pr " args.%s = %s;\n" n n
5770 | FileIn _ | FileOut _ -> ()
5772 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5773 (String.uppercase shortname);
5774 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5777 pr " if (serial == -1) {\n";
5778 pr " guestfs___end_busy (g);\n";
5779 pr " return %s;\n" error_code;
5783 (* Send any additional files (FileIn) requested. *)
5784 let need_read_reply_label = ref false in
5788 pr " r = guestfs___send_file (g, %s);\n" n;
5789 pr " if (r == -1) {\n";
5790 pr " guestfs___end_busy (g);\n";
5791 pr " return %s;\n" error_code;
5793 pr " if (r == -2) /* daemon cancelled */\n";
5794 pr " goto read_reply;\n";
5795 need_read_reply_label := true;
5800 (* Wait for the reply from the remote end. *)
5801 if !need_read_reply_label then pr " read_reply:\n";
5802 pr " memset (&hdr, 0, sizeof hdr);\n";
5803 pr " memset (&err, 0, sizeof err);\n";
5804 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5806 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5810 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5813 pr " if (r == -1) {\n";
5814 pr " guestfs___end_busy (g);\n";
5815 pr " return %s;\n" error_code;
5819 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5820 (String.uppercase shortname);
5821 pr " guestfs___end_busy (g);\n";
5822 pr " return %s;\n" error_code;
5826 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5827 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5828 pr " free (err.error_message);\n";
5829 pr " guestfs___end_busy (g);\n";
5830 pr " return %s;\n" error_code;
5834 (* Expecting to receive further files (FileOut)? *)
5838 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5839 pr " guestfs___end_busy (g);\n";
5840 pr " return %s;\n" error_code;
5846 pr " guestfs___end_busy (g);\n";
5848 (match fst style with
5849 | RErr -> pr " return 0;\n"
5850 | RInt n | RInt64 n | RBool n ->
5851 pr " return ret.%s;\n" n
5852 | RConstString _ | RConstOptString _ ->
5853 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5855 pr " return ret.%s; /* caller will free */\n" n
5856 | RStringList n | RHashtable n ->
5857 pr " /* caller will free this, but we need to add a NULL entry */\n";
5858 pr " ret.%s.%s_val =\n" n n;
5859 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5860 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5862 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5863 pr " return ret.%s.%s_val;\n" n n
5865 pr " /* caller will free this */\n";
5866 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5867 | RStructList (n, _) ->
5868 pr " /* caller will free this */\n";
5869 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5871 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5872 pr " * _val might be NULL here. To make the API saner for\n";
5873 pr " * callers, we turn this case into a unique pointer (using\n";
5874 pr " * malloc(1)).\n";
5876 pr " if (ret.%s.%s_len > 0) {\n" n n;
5877 pr " *size_r = ret.%s.%s_len;\n" n n;
5878 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5880 pr " free (ret.%s.%s_val);\n" n n;
5881 pr " char *p = safe_malloc (g, 1);\n";
5882 pr " *size_r = ret.%s.%s_len;\n" n n;
5890 (* Functions to free structures. *)
5891 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5892 pr " * structure format is identical to the XDR format. See note in\n";
5893 pr " * generator.ml.\n";
5900 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5902 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5908 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5910 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5917 (* Generate daemon/actions.h. *)
5918 and generate_daemon_actions_h () =
5919 generate_header CStyle GPLv2plus;
5921 pr "#include \"../src/guestfs_protocol.h\"\n";
5925 fun (name, style, _, _, _, _, _) ->
5927 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5931 (* Generate the linker script which controls the visibility of
5932 * symbols in the public ABI and ensures no other symbols get
5933 * exported accidentally.
5935 and generate_linker_script () =
5936 generate_header HashStyle GPLv2plus;
5941 "guestfs_get_error_handler";
5942 "guestfs_get_out_of_memory_handler";
5943 "guestfs_last_error";
5944 "guestfs_set_error_handler";
5945 "guestfs_set_launch_done_callback";
5946 "guestfs_set_log_message_callback";
5947 "guestfs_set_out_of_memory_handler";
5948 "guestfs_set_subprocess_quit_callback";
5950 (* Unofficial parts of the API: the bindings code use these
5951 * functions, so it is useful to export them.
5953 "guestfs_safe_calloc";
5954 "guestfs_safe_malloc";
5955 "guestfs_safe_strdup";
5956 "guestfs_safe_memdup";
5959 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
5963 List.map (fun (typ, _) ->
5964 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
5967 let globals = List.sort compare (globals @ functions @ structs) in
5971 List.iter (pr " %s;\n") globals;
5978 (* Generate the server-side stubs. *)
5979 and generate_daemon_actions () =
5980 generate_header CStyle GPLv2plus;
5982 pr "#include <config.h>\n";
5984 pr "#include <stdio.h>\n";
5985 pr "#include <stdlib.h>\n";
5986 pr "#include <string.h>\n";
5987 pr "#include <inttypes.h>\n";
5988 pr "#include <rpc/types.h>\n";
5989 pr "#include <rpc/xdr.h>\n";
5991 pr "#include \"daemon.h\"\n";
5992 pr "#include \"c-ctype.h\"\n";
5993 pr "#include \"../src/guestfs_protocol.h\"\n";
5994 pr "#include \"actions.h\"\n";
5998 fun (name, style, _, _, _, _, _) ->
5999 (* Generate server-side stubs. *)
6000 pr "static void %s_stub (XDR *xdr_in)\n" name;
6003 match fst style with
6004 | RErr | RInt _ -> pr " int r;\n"; "-1"
6005 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6006 | RBool _ -> pr " int r;\n"; "-1"
6007 | RConstString _ | RConstOptString _ ->
6008 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6009 | RString _ -> pr " char *r;\n"; "NULL"
6010 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6011 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6012 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6014 pr " size_t size = 1;\n";
6018 (match snd style with
6021 pr " struct guestfs_%s_args args;\n" name;
6024 | Device n | Dev_or_Path n
6027 | OptString n -> pr " char *%s;\n" n
6028 | StringList n | DeviceList n -> pr " char **%s;\n" n
6029 | Bool n -> pr " int %s;\n" n
6030 | Int n -> pr " int %s;\n" n
6031 | Int64 n -> pr " int64_t %s;\n" n
6032 | FileIn _ | FileOut _ -> ()
6037 (match snd style with
6040 pr " memset (&args, 0, sizeof args);\n";
6042 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6043 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6047 pr " char *%s = args.%s;\n" n n
6049 let pr_list_handling_code n =
6050 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6051 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6052 pr " if (%s == NULL) {\n" n;
6053 pr " reply_with_perror (\"realloc\");\n";
6056 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6057 pr " args.%s.%s_val = %s;\n" n n n;
6063 pr " ABS_PATH (%s, goto done);\n" n;
6066 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
6069 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
6070 | String n -> pr_args n
6071 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6073 pr_list_handling_code n;
6075 pr_list_handling_code n;
6076 pr " /* Ensure that each is a device,\n";
6077 pr " * and perform device name translation.\n";
6081 pr " for (i = 0; %s[i] != NULL; ++i)\n" n;
6082 pr " RESOLVE_DEVICE (%s[i], goto done);\n" n;
6084 | Bool n -> pr " %s = args.%s;\n" n n
6085 | Int n -> pr " %s = args.%s;\n" n n
6086 | Int64 n -> pr " %s = args.%s;\n" n n
6087 | FileIn _ | FileOut _ -> ()
6093 (* this is used at least for do_equal *)
6094 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6095 (* Emit NEED_ROOT just once, even when there are two or
6096 more Pathname args *)
6097 pr " NEED_ROOT (goto done);\n";
6100 (* Don't want to call the impl with any FileIn or FileOut
6101 * parameters, since these go "outside" the RPC protocol.
6104 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6106 pr " r = do_%s " name;
6107 generate_c_call_args (fst style, args');
6110 (match fst style with
6111 | RErr | RInt _ | RInt64 _ | RBool _
6112 | RConstString _ | RConstOptString _
6113 | RString _ | RStringList _ | RHashtable _
6114 | RStruct (_, _) | RStructList (_, _) ->
6115 pr " if (r == %s)\n" error_code;
6116 pr " /* do_%s has already called reply_with_error */\n" name;
6120 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6121 pr " * an ordinary zero-length buffer), so be careful ...\n";
6123 pr " if (size == 1 && r == %s)\n" error_code;
6124 pr " /* do_%s has already called reply_with_error */\n" name;
6129 (* If there are any FileOut parameters, then the impl must
6130 * send its own reply.
6133 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6135 pr " /* do_%s has already sent a reply */\n" name
6137 match fst style with
6138 | RErr -> pr " reply (NULL, NULL);\n"
6139 | RInt n | RInt64 n | RBool n ->
6140 pr " struct guestfs_%s_ret ret;\n" name;
6141 pr " ret.%s = r;\n" n;
6142 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6144 | RConstString _ | RConstOptString _ ->
6145 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6147 pr " struct guestfs_%s_ret ret;\n" name;
6148 pr " ret.%s = r;\n" n;
6149 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6152 | RStringList n | RHashtable n ->
6153 pr " struct guestfs_%s_ret ret;\n" name;
6154 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6155 pr " ret.%s.%s_val = r;\n" n n;
6156 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6158 pr " free_strings (r);\n"
6160 pr " struct guestfs_%s_ret ret;\n" name;
6161 pr " ret.%s = *r;\n" n;
6162 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6164 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6166 | RStructList (n, _) ->
6167 pr " struct guestfs_%s_ret ret;\n" name;
6168 pr " ret.%s = *r;\n" n;
6169 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6171 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6174 pr " struct guestfs_%s_ret ret;\n" name;
6175 pr " ret.%s.%s_val = r;\n" n n;
6176 pr " ret.%s.%s_len = size;\n" n n;
6177 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6182 (* Free the args. *)
6183 (match snd style with
6188 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6195 (* Dispatch function. *)
6196 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6198 pr " switch (proc_nr) {\n";
6201 fun (name, style, _, _, _, _, _) ->
6202 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6203 pr " %s_stub (xdr_in);\n" name;
6208 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";
6213 (* LVM columns and tokenization functions. *)
6214 (* XXX This generates crap code. We should rethink how we
6220 pr "static const char *lvm_%s_cols = \"%s\";\n"
6221 typ (String.concat "," (List.map fst cols));
6224 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6226 pr " char *tok, *p, *next;\n";
6227 pr " size_t i, j;\n";
6230 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6233 pr " if (!str) {\n";
6234 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6237 pr " if (!*str || c_isspace (*str)) {\n";
6238 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6243 fun (name, coltype) ->
6244 pr " if (!tok) {\n";
6245 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6248 pr " p = strchrnul (tok, ',');\n";
6249 pr " if (*p) next = p+1; else next = NULL;\n";
6250 pr " *p = '\\0';\n";
6253 pr " r->%s = strdup (tok);\n" name;
6254 pr " if (r->%s == NULL) {\n" name;
6255 pr " perror (\"strdup\");\n";
6259 pr " for (i = j = 0; i < 32; ++j) {\n";
6260 pr " if (tok[j] == '\\0') {\n";
6261 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6263 pr " } else if (tok[j] != '-')\n";
6264 pr " r->%s[i++] = tok[j];\n" name;
6267 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6268 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6272 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6273 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6277 pr " if (tok[0] == '\\0')\n";
6278 pr " r->%s = -1;\n" name;
6279 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6280 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6283 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6284 assert false (* can never be an LVM column *)
6286 pr " tok = next;\n";
6289 pr " if (tok != NULL) {\n";
6290 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6297 pr "guestfs_int_lvm_%s_list *\n" typ;
6298 pr "parse_command_line_%ss (void)\n" typ;
6300 pr " char *out, *err;\n";
6301 pr " char *p, *pend;\n";
6303 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6304 pr " void *newp;\n";
6306 pr " ret = malloc (sizeof *ret);\n";
6307 pr " if (!ret) {\n";
6308 pr " reply_with_perror (\"malloc\");\n";
6309 pr " return NULL;\n";
6312 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6313 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6315 pr " r = command (&out, &err,\n";
6316 pr " \"lvm\", \"%ss\",\n" typ;
6317 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6318 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6319 pr " if (r == -1) {\n";
6320 pr " reply_with_error (\"%%s\", err);\n";
6321 pr " free (out);\n";
6322 pr " free (err);\n";
6323 pr " free (ret);\n";
6324 pr " return NULL;\n";
6327 pr " free (err);\n";
6329 pr " /* Tokenize each line of the output. */\n";
6332 pr " while (p) {\n";
6333 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6334 pr " if (pend) {\n";
6335 pr " *pend = '\\0';\n";
6339 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6342 pr " if (!*p) { /* Empty line? Skip it. */\n";
6347 pr " /* Allocate some space to store this next entry. */\n";
6348 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6349 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6350 pr " if (newp == NULL) {\n";
6351 pr " reply_with_perror (\"realloc\");\n";
6352 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6353 pr " free (ret);\n";
6354 pr " free (out);\n";
6355 pr " return NULL;\n";
6357 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6359 pr " /* Tokenize the next entry. */\n";
6360 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6361 pr " if (r == -1) {\n";
6362 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6363 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6364 pr " free (ret);\n";
6365 pr " free (out);\n";
6366 pr " return NULL;\n";
6373 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6375 pr " free (out);\n";
6376 pr " return ret;\n";
6379 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6381 (* Generate a list of function names, for debugging in the daemon.. *)
6382 and generate_daemon_names () =
6383 generate_header CStyle GPLv2plus;
6385 pr "#include <config.h>\n";
6387 pr "#include \"daemon.h\"\n";
6390 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6391 pr "const char *function_names[] = {\n";
6393 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6397 (* Generate the optional groups for the daemon to implement
6398 * guestfs_available.
6400 and generate_daemon_optgroups_c () =
6401 generate_header CStyle GPLv2plus;
6403 pr "#include <config.h>\n";
6405 pr "#include \"daemon.h\"\n";
6406 pr "#include \"optgroups.h\"\n";
6409 pr "struct optgroup optgroups[] = {\n";
6412 pr " { \"%s\", optgroup_%s_available },\n" group group
6414 pr " { NULL, NULL }\n";
6417 and generate_daemon_optgroups_h () =
6418 generate_header CStyle GPLv2plus;
6422 pr "extern int optgroup_%s_available (void);\n" group
6425 (* Generate the tests. *)
6426 and generate_tests () =
6427 generate_header CStyle GPLv2plus;
6434 #include <sys/types.h>
6437 #include \"guestfs.h\"
6438 #include \"guestfs-internal.h\"
6440 static guestfs_h *g;
6441 static int suppress_error = 0;
6443 static void print_error (guestfs_h *g, void *data, const char *msg)
6445 if (!suppress_error)
6446 fprintf (stderr, \"%%s\\n\", msg);
6449 /* FIXME: nearly identical code appears in fish.c */
6450 static void print_strings (char *const *argv)
6454 for (argc = 0; argv[argc] != NULL; ++argc)
6455 printf (\"\\t%%s\\n\", argv[argc]);
6459 static void print_table (char const *const *argv)
6463 for (i = 0; argv[i] != NULL; i += 2)
6464 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6469 is_available (const char *group)
6471 const char *groups[] = { group, NULL };
6475 r = guestfs_available (g, (char **) groups);
6483 (* Generate a list of commands which are not tested anywhere. *)
6484 pr "static void no_test_warnings (void)\n";
6487 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6489 fun (_, _, _, _, tests, _, _) ->
6490 let tests = filter_map (
6492 | (_, (Always|If _|Unless _|IfAvailable _), test) -> Some test
6493 | (_, Disabled, _) -> None
6495 let seq = List.concat (List.map seq_of_test tests) in
6496 let cmds_tested = List.map List.hd seq in
6497 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6501 fun (name, _, _, _, _, _, _) ->
6502 if not (Hashtbl.mem hash name) then
6503 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6509 (* Generate the actual tests. Note that we generate the tests
6510 * in reverse order, deliberately, so that (in general) the
6511 * newest tests run first. This makes it quicker and easier to
6516 fun (name, _, _, flags, tests, _, _) ->
6517 mapi (generate_one_test name flags) tests
6518 ) (List.rev all_functions) in
6519 let test_names = List.concat test_names in
6520 let nr_tests = List.length test_names in
6523 int main (int argc, char *argv[])
6526 unsigned long int n_failed = 0;
6527 const char *filename;
6529 int nr_tests, test_num = 0;
6531 setbuf (stdout, NULL);
6533 no_test_warnings ();
6535 g = guestfs_create ();
6537 printf (\"guestfs_create FAILED\\n\");
6538 exit (EXIT_FAILURE);
6541 guestfs_set_error_handler (g, print_error, NULL);
6543 guestfs_set_path (g, \"../appliance\");
6545 filename = \"test1.img\";
6546 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6549 exit (EXIT_FAILURE);
6551 if (lseek (fd, %d, SEEK_SET) == -1) {
6555 exit (EXIT_FAILURE);
6557 if (write (fd, &c, 1) == -1) {
6561 exit (EXIT_FAILURE);
6563 if (close (fd) == -1) {
6566 exit (EXIT_FAILURE);
6568 if (guestfs_add_drive (g, filename) == -1) {
6569 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6570 exit (EXIT_FAILURE);
6573 filename = \"test2.img\";
6574 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6577 exit (EXIT_FAILURE);
6579 if (lseek (fd, %d, SEEK_SET) == -1) {
6583 exit (EXIT_FAILURE);
6585 if (write (fd, &c, 1) == -1) {
6589 exit (EXIT_FAILURE);
6591 if (close (fd) == -1) {
6594 exit (EXIT_FAILURE);
6596 if (guestfs_add_drive (g, filename) == -1) {
6597 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6598 exit (EXIT_FAILURE);
6601 filename = \"test3.img\";
6602 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6605 exit (EXIT_FAILURE);
6607 if (lseek (fd, %d, SEEK_SET) == -1) {
6611 exit (EXIT_FAILURE);
6613 if (write (fd, &c, 1) == -1) {
6617 exit (EXIT_FAILURE);
6619 if (close (fd) == -1) {
6622 exit (EXIT_FAILURE);
6624 if (guestfs_add_drive (g, filename) == -1) {
6625 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6626 exit (EXIT_FAILURE);
6629 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6630 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6631 exit (EXIT_FAILURE);
6634 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6637 if (guestfs_launch (g) == -1) {
6638 printf (\"guestfs_launch FAILED\\n\");
6639 exit (EXIT_FAILURE);
6642 /* Cancel previous alarm. */
6647 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6651 pr " test_num++;\n";
6652 pr " if (guestfs_get_verbose (g))\n";
6653 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
6654 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6655 pr " if (%s () == -1) {\n" test_name;
6656 pr " printf (\"%s FAILED\\n\");\n" test_name;
6657 pr " n_failed++;\n";
6662 pr " guestfs_close (g);\n";
6663 pr " unlink (\"test1.img\");\n";
6664 pr " unlink (\"test2.img\");\n";
6665 pr " unlink (\"test3.img\");\n";
6668 pr " if (n_failed > 0) {\n";
6669 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6670 pr " exit (EXIT_FAILURE);\n";
6674 pr " exit (EXIT_SUCCESS);\n";
6677 and generate_one_test name flags i (init, prereq, test) =
6678 let test_name = sprintf "test_%s_%d" name i in
6681 static int %s_skip (void)
6685 str = getenv (\"TEST_ONLY\");
6687 return strstr (str, \"%s\") == NULL;
6688 str = getenv (\"SKIP_%s\");
6689 if (str && STREQ (str, \"1\")) return 1;
6690 str = getenv (\"SKIP_TEST_%s\");
6691 if (str && STREQ (str, \"1\")) return 1;
6695 " test_name name (String.uppercase test_name) (String.uppercase name);
6698 | Disabled | Always | IfAvailable _ -> ()
6699 | If code | Unless code ->
6700 pr "static int %s_prereq (void)\n" test_name;
6708 static int %s (void)
6711 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6715 " test_name test_name test_name;
6717 (* Optional functions should only be tested if the relevant
6718 * support is available in the daemon.
6723 pr " if (!is_available (\"%s\")) {\n" group;
6724 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", \"%s\");\n" test_name group;
6732 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6734 pr " if (! %s_prereq ()) {\n" test_name;
6735 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6739 generate_one_test_body name i test_name init test;
6741 pr " if (%s_prereq ()) {\n" test_name;
6742 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6746 generate_one_test_body name i test_name init test;
6747 | IfAvailable group ->
6748 pr " if (!is_available (\"%s\")) {\n" group;
6749 pr " printf (\" %%s skipped (reason: %%s not available)\\n\", \"%s\", \"%s\");\n" test_name group;
6753 generate_one_test_body name i test_name init test;
6755 generate_one_test_body name i test_name init test
6763 and generate_one_test_body name i test_name init test =
6765 | InitNone (* XXX at some point, InitNone and InitEmpty became
6766 * folded together as the same thing. Really we should
6767 * make InitNone do nothing at all, but the tests may
6768 * need to be checked to make sure this is OK.
6771 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6772 List.iter (generate_test_command_call test_name)
6773 [["blockdev_setrw"; "/dev/sda"];
6777 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6778 List.iter (generate_test_command_call test_name)
6779 [["blockdev_setrw"; "/dev/sda"];
6782 ["part_disk"; "/dev/sda"; "mbr"]]
6784 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6785 List.iter (generate_test_command_call test_name)
6786 [["blockdev_setrw"; "/dev/sda"];
6789 ["part_disk"; "/dev/sda"; "mbr"];
6790 ["mkfs"; "ext2"; "/dev/sda1"];
6791 ["mount_options"; ""; "/dev/sda1"; "/"]]
6792 | InitBasicFSonLVM ->
6793 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6795 List.iter (generate_test_command_call test_name)
6796 [["blockdev_setrw"; "/dev/sda"];
6799 ["part_disk"; "/dev/sda"; "mbr"];
6800 ["pvcreate"; "/dev/sda1"];
6801 ["vgcreate"; "VG"; "/dev/sda1"];
6802 ["lvcreate"; "LV"; "VG"; "8"];
6803 ["mkfs"; "ext2"; "/dev/VG/LV"];
6804 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
6806 pr " /* InitISOFS for %s */\n" test_name;
6807 List.iter (generate_test_command_call test_name)
6808 [["blockdev_setrw"; "/dev/sda"];
6811 ["mount_ro"; "/dev/sdd"; "/"]]
6814 let get_seq_last = function
6816 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6819 let seq = List.rev seq in
6820 List.rev (List.tl seq), List.hd seq
6825 pr " /* TestRun for %s (%d) */\n" name i;
6826 List.iter (generate_test_command_call test_name) seq
6827 | TestOutput (seq, expected) ->
6828 pr " /* TestOutput for %s (%d) */\n" name i;
6829 pr " const char *expected = \"%s\";\n" (c_quote expected);
6830 let seq, last = get_seq_last seq in
6832 pr " if (STRNEQ (r, expected)) {\n";
6833 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6837 List.iter (generate_test_command_call test_name) seq;
6838 generate_test_command_call ~test test_name last
6839 | TestOutputList (seq, expected) ->
6840 pr " /* TestOutputList for %s (%d) */\n" name i;
6841 let seq, last = get_seq_last seq in
6845 pr " if (!r[%d]) {\n" i;
6846 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6847 pr " print_strings (r);\n";
6851 pr " const char *expected = \"%s\";\n" (c_quote str);
6852 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6853 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6858 pr " if (r[%d] != NULL) {\n" (List.length expected);
6859 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6861 pr " print_strings (r);\n";
6865 List.iter (generate_test_command_call test_name) seq;
6866 generate_test_command_call ~test test_name last
6867 | TestOutputListOfDevices (seq, expected) ->
6868 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6869 let seq, last = get_seq_last seq in
6873 pr " if (!r[%d]) {\n" i;
6874 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6875 pr " print_strings (r);\n";
6879 pr " const char *expected = \"%s\";\n" (c_quote str);
6880 pr " r[%d][5] = 's';\n" i;
6881 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6882 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6887 pr " if (r[%d] != NULL) {\n" (List.length expected);
6888 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6890 pr " print_strings (r);\n";
6894 List.iter (generate_test_command_call test_name) seq;
6895 generate_test_command_call ~test test_name last
6896 | TestOutputInt (seq, expected) ->
6897 pr " /* TestOutputInt for %s (%d) */\n" name i;
6898 let seq, last = get_seq_last seq in
6900 pr " if (r != %d) {\n" expected;
6901 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6907 List.iter (generate_test_command_call test_name) seq;
6908 generate_test_command_call ~test test_name last
6909 | TestOutputIntOp (seq, op, expected) ->
6910 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6911 let seq, last = get_seq_last seq in
6913 pr " if (! (r %s %d)) {\n" op expected;
6914 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6915 test_name op expected;
6920 List.iter (generate_test_command_call test_name) seq;
6921 generate_test_command_call ~test test_name last
6922 | TestOutputTrue seq ->
6923 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6924 let seq, last = get_seq_last seq in
6927 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6932 List.iter (generate_test_command_call test_name) seq;
6933 generate_test_command_call ~test test_name last
6934 | TestOutputFalse seq ->
6935 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6936 let seq, last = get_seq_last seq in
6939 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6944 List.iter (generate_test_command_call test_name) seq;
6945 generate_test_command_call ~test test_name last
6946 | TestOutputLength (seq, expected) ->
6947 pr " /* TestOutputLength for %s (%d) */\n" name i;
6948 let seq, last = get_seq_last seq in
6951 pr " for (j = 0; j < %d; ++j)\n" expected;
6952 pr " if (r[j] == NULL) {\n";
6953 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6955 pr " print_strings (r);\n";
6958 pr " if (r[j] != NULL) {\n";
6959 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6961 pr " print_strings (r);\n";
6965 List.iter (generate_test_command_call test_name) seq;
6966 generate_test_command_call ~test test_name last
6967 | TestOutputBuffer (seq, expected) ->
6968 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6969 pr " const char *expected = \"%s\";\n" (c_quote expected);
6970 let seq, last = get_seq_last seq in
6971 let len = String.length expected in
6973 pr " if (size != %d) {\n" len;
6974 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6977 pr " if (STRNEQLEN (r, expected, size)) {\n";
6978 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6982 List.iter (generate_test_command_call test_name) seq;
6983 generate_test_command_call ~test test_name last
6984 | TestOutputStruct (seq, checks) ->
6985 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6986 let seq, last = get_seq_last seq in
6990 | CompareWithInt (field, expected) ->
6991 pr " if (r->%s != %d) {\n" field expected;
6992 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6993 test_name field expected;
6994 pr " (int) r->%s);\n" field;
6997 | CompareWithIntOp (field, op, expected) ->
6998 pr " if (!(r->%s %s %d)) {\n" field op expected;
6999 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7000 test_name field op expected;
7001 pr " (int) r->%s);\n" field;
7004 | CompareWithString (field, expected) ->
7005 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7006 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7007 test_name field expected;
7008 pr " r->%s);\n" field;
7011 | CompareFieldsIntEq (field1, field2) ->
7012 pr " if (r->%s != r->%s) {\n" field1 field2;
7013 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7014 test_name field1 field2;
7015 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7018 | CompareFieldsStrEq (field1, field2) ->
7019 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7020 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7021 test_name field1 field2;
7022 pr " r->%s, r->%s);\n" field1 field2;
7027 List.iter (generate_test_command_call test_name) seq;
7028 generate_test_command_call ~test test_name last
7029 | TestLastFail seq ->
7030 pr " /* TestLastFail for %s (%d) */\n" name i;
7031 let seq, last = get_seq_last seq in
7032 List.iter (generate_test_command_call test_name) seq;
7033 generate_test_command_call test_name ~expect_error:true last
7035 (* Generate the code to run a command, leaving the result in 'r'.
7036 * If you expect to get an error then you should set expect_error:true.
7038 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7040 | [] -> assert false
7042 (* Look up the command to find out what args/ret it has. *)
7045 let _, style, _, _, _, _, _ =
7046 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7049 failwithf "%s: in test, command %s was not found" test_name name in
7051 if List.length (snd style) <> List.length args then
7052 failwithf "%s: in test, wrong number of args given to %s"
7059 | OptString n, "NULL" -> ()
7062 | Dev_or_Path n, arg
7064 | OptString n, arg ->
7065 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7069 | FileIn _, _ | FileOut _, _ -> ()
7070 | StringList n, "" | DeviceList n, "" ->
7071 pr " const char *const %s[1] = { NULL };\n" n
7072 | StringList n, arg | DeviceList n, arg ->
7073 let strs = string_split " " arg in
7076 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7078 pr " const char *const %s[] = {\n" n;
7080 fun i _ -> pr " %s_%d,\n" n i
7084 ) (List.combine (snd style) args);
7087 match fst style with
7088 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7089 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7090 | RConstString _ | RConstOptString _ ->
7091 pr " const char *r;\n"; "NULL"
7092 | RString _ -> pr " char *r;\n"; "NULL"
7093 | RStringList _ | RHashtable _ ->
7097 | RStruct (_, typ) ->
7098 pr " struct guestfs_%s *r;\n" typ; "NULL"
7099 | RStructList (_, typ) ->
7100 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7103 pr " size_t size;\n";
7106 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7107 pr " r = guestfs_%s (g" name;
7109 (* Generate the parameters. *)
7112 | OptString _, "NULL" -> pr ", NULL"
7114 | Device n, _ | Dev_or_Path n, _
7118 | FileIn _, arg | FileOut _, arg ->
7119 pr ", \"%s\"" (c_quote arg)
7120 | StringList n, _ | DeviceList n, _ ->
7121 pr ", (char **) %s" n
7124 try int_of_string arg
7125 with Failure "int_of_string" ->
7126 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7130 try Int64.of_string arg
7131 with Failure "int_of_string" ->
7132 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7135 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7136 ) (List.combine (snd style) args);
7138 (match fst style with
7139 | RBufferOut _ -> pr ", &size"
7145 if not expect_error then
7146 pr " if (r == %s)\n" error_code
7148 pr " if (r != %s)\n" error_code;
7151 (* Insert the test code. *)
7157 (match fst style with
7158 | RErr | RInt _ | RInt64 _ | RBool _
7159 | RConstString _ | RConstOptString _ -> ()
7160 | RString _ | RBufferOut _ -> pr " free (r);\n"
7161 | RStringList _ | RHashtable _ ->
7162 pr " for (i = 0; r[i] != NULL; ++i)\n";
7163 pr " free (r[i]);\n";
7165 | RStruct (_, typ) ->
7166 pr " guestfs_free_%s (r);\n" typ
7167 | RStructList (_, typ) ->
7168 pr " guestfs_free_%s_list (r);\n" typ
7174 let str = replace_str str "\r" "\\r" in
7175 let str = replace_str str "\n" "\\n" in
7176 let str = replace_str str "\t" "\\t" in
7177 let str = replace_str str "\000" "\\0" in
7180 (* Generate a lot of different functions for guestfish. *)
7181 and generate_fish_cmds () =
7182 generate_header CStyle GPLv2plus;
7186 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7188 let all_functions_sorted =
7190 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7191 ) all_functions_sorted in
7193 pr "#include <config.h>\n";
7195 pr "#include <stdio.h>\n";
7196 pr "#include <stdlib.h>\n";
7197 pr "#include <string.h>\n";
7198 pr "#include <inttypes.h>\n";
7200 pr "#include <guestfs.h>\n";
7201 pr "#include \"c-ctype.h\"\n";
7202 pr "#include \"full-write.h\"\n";
7203 pr "#include \"xstrtol.h\"\n";
7204 pr "#include \"fish.h\"\n";
7207 (* list_commands function, which implements guestfish -h *)
7208 pr "void list_commands (void)\n";
7210 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7211 pr " list_builtin_commands ();\n";
7213 fun (name, _, _, flags, _, shortdesc, _) ->
7214 let name = replace_char name '_' '-' in
7215 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7217 ) all_functions_sorted;
7218 pr " printf (\" %%s\\n\",";
7219 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7223 (* display_command function, which implements guestfish -h cmd *)
7224 pr "int display_command (const char *cmd)\n";
7227 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7228 let name2 = replace_char name '_' '-' in
7230 try find_map (function FishAlias n -> Some n | _ -> None) flags
7231 with Not_found -> name in
7232 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7234 match snd style with
7238 name2 (String.concat " " (List.map name_of_argt args)) in
7241 if List.mem ProtocolLimitWarning flags then
7242 ("\n\n" ^ protocol_limit_warning)
7245 (* For DangerWillRobinson commands, we should probably have
7246 * guestfish prompt before allowing you to use them (especially
7247 * in interactive mode). XXX
7251 if List.mem DangerWillRobinson flags then
7252 ("\n\n" ^ danger_will_robinson)
7257 match deprecation_notice flags with
7259 | Some txt -> "\n\n" ^ txt in
7261 let describe_alias =
7262 if name <> alias then
7263 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7267 pr "STRCASEEQ (cmd, \"%s\")" name;
7268 if name <> name2 then
7269 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7270 if name <> alias then
7271 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7273 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7275 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7276 "=head1 DESCRIPTION\n\n" ^
7277 longdesc ^ warnings ^ describe_alias);
7282 pr " return display_builtin_command (cmd);\n";
7286 let emit_print_list_function typ =
7287 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7290 pr " unsigned int i;\n";
7292 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7293 pr " printf (\"[%%d] = {\\n\", i);\n";
7294 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7295 pr " printf (\"}\\n\");\n";
7301 (* print_* functions *)
7305 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7307 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7310 pr " unsigned int i;\n";
7316 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7318 pr " printf (\"%%s%s: \", indent);\n" name;
7319 pr " for (i = 0; i < 32; ++i)\n";
7320 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7321 pr " printf (\"\\n\");\n"
7323 pr " printf (\"%%s%s: \", indent);\n" name;
7324 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7325 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7326 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7328 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7329 pr " printf (\"\\n\");\n"
7330 | name, (FUInt64|FBytes) ->
7331 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7334 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7337 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7340 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7343 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7345 | name, FOptPercent ->
7346 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7347 typ name name typ name;
7348 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7354 (* Emit a print_TYPE_list function definition only if that function is used. *)
7357 | typ, (RStructListOnly | RStructAndList) ->
7358 (* generate the function for typ *)
7359 emit_print_list_function typ
7360 | typ, _ -> () (* empty *)
7361 ) (rstructs_used_by all_functions);
7363 (* Emit a print_TYPE function definition only if that function is used. *)
7366 | typ, (RStructOnly | RStructAndList) ->
7367 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7369 pr " print_%s_indent (%s, \"\");\n" typ typ;
7372 | typ, _ -> () (* empty *)
7373 ) (rstructs_used_by all_functions);
7375 (* run_<action> actions *)
7377 fun (name, style, _, flags, _, _, _) ->
7378 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7380 (match fst style with
7383 | RBool _ -> pr " int r;\n"
7384 | RInt64 _ -> pr " int64_t r;\n"
7385 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7386 | RString _ -> pr " char *r;\n"
7387 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7388 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7389 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7392 pr " size_t size;\n";
7400 | FileOut n -> pr " const char *%s;\n" n
7402 | Dev_or_Path n -> pr " char *%s;\n" n
7403 | StringList n | DeviceList n -> pr " char **%s;\n" n
7404 | Bool n -> pr " int %s;\n" n
7405 | Int n -> pr " int %s;\n" n
7406 | Int64 n -> pr " int64_t %s;\n" n
7409 (* Check and convert parameters. *)
7410 let argc_expected = List.length (snd style) in
7411 pr " if (argc != %d) {\n" argc_expected;
7412 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7414 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7418 let parse_integer fn fntyp rtyp range name i =
7420 pr " strtol_error xerr;\n";
7421 pr " %s r;\n" fntyp;
7423 pr " xerr = %s (argv[%d], NULL, 0, &r, \"\");\n" fn i;
7424 pr " if (xerr != LONGINT_OK) {\n";
7425 pr " fprintf (stderr,\n";
7426 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7427 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7432 | Some (min, max, comment) ->
7433 pr " /* %s */\n" comment;
7434 pr " if (r < %s || r > %s) {\n" min max;
7435 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7439 pr " /* The check above should ensure this assignment does not overflow. */\n";
7441 pr " %s = r;\n" name;
7450 pr " %s = argv[%d];\n" name i
7452 | Dev_or_Path name ->
7453 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7454 pr " if (%s == NULL) return -1;\n" name
7456 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7459 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7462 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7464 | StringList name | DeviceList name ->
7465 pr " %s = parse_string_list (argv[%d]);\n" name i;
7466 pr " if (%s == NULL) return -1;\n" name;
7468 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7471 let min = "(-(2LL<<30))"
7472 and max = "((2LL<<30)-1)"
7474 "The Int type in the generator is a signed 31 bit int." in
7475 Some (min, max, comment) in
7476 parse_integer "xstrtoll" "long long" "int" range name i
7478 parse_integer "xstrtoll" "long long" "int64_t" None name i
7481 (* Call C API function. *)
7483 try find_map (function FishAction n -> Some n | _ -> None) flags
7484 with Not_found -> sprintf "guestfs_%s" name in
7486 generate_c_call_args ~handle:"g" style;
7491 | Device _ | String _
7492 | OptString _ | Bool _
7494 | FileIn _ | FileOut _ -> ()
7495 | Pathname name | Dev_or_Path name ->
7496 pr " free (%s);\n" name
7497 | StringList name | DeviceList name ->
7498 pr " free_strings (%s);\n" name
7501 (* Check return value for errors and display command results. *)
7502 (match fst style with
7503 | RErr -> pr " return r;\n"
7505 pr " if (r == -1) return -1;\n";
7506 pr " printf (\"%%d\\n\", r);\n";
7509 pr " if (r == -1) return -1;\n";
7510 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7513 pr " if (r == -1) return -1;\n";
7514 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7517 pr " if (r == NULL) return -1;\n";
7518 pr " printf (\"%%s\\n\", r);\n";
7520 | RConstOptString _ ->
7521 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7524 pr " if (r == NULL) return -1;\n";
7525 pr " printf (\"%%s\\n\", r);\n";
7529 pr " if (r == NULL) return -1;\n";
7530 pr " print_strings (r);\n";
7531 pr " free_strings (r);\n";
7533 | RStruct (_, typ) ->
7534 pr " if (r == NULL) return -1;\n";
7535 pr " print_%s (r);\n" typ;
7536 pr " guestfs_free_%s (r);\n" typ;
7538 | RStructList (_, typ) ->
7539 pr " if (r == NULL) return -1;\n";
7540 pr " print_%s_list (r);\n" typ;
7541 pr " guestfs_free_%s_list (r);\n" typ;
7544 pr " if (r == NULL) return -1;\n";
7545 pr " print_table (r);\n";
7546 pr " free_strings (r);\n";
7549 pr " if (r == NULL) return -1;\n";
7550 pr " if (full_write (1, r, size) != size) {\n";
7551 pr " perror (\"write\");\n";
7562 (* run_action function *)
7563 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7566 fun (name, _, _, flags, _, _, _) ->
7567 let name2 = replace_char name '_' '-' in
7569 try find_map (function FishAlias n -> Some n | _ -> None) flags
7570 with Not_found -> name in
7572 pr "STRCASEEQ (cmd, \"%s\")" name;
7573 if name <> name2 then
7574 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7575 if name <> alias then
7576 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7578 pr " return run_%s (cmd, argc, argv);\n" name;
7582 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7583 pr " if (command_num == 1)\n";
7584 pr " extended_help_message ();\n";
7591 (* Readline completion for guestfish. *)
7592 and generate_fish_completion () =
7593 generate_header CStyle GPLv2plus;
7597 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7607 #ifdef HAVE_LIBREADLINE
7608 #include <readline/readline.h>
7613 #ifdef HAVE_LIBREADLINE
7615 static const char *const commands[] = {
7616 BUILTIN_COMMANDS_FOR_COMPLETION,
7619 (* Get the commands, including the aliases. They don't need to be
7620 * sorted - the generator() function just does a dumb linear search.
7624 fun (name, _, _, flags, _, _, _) ->
7625 let name2 = replace_char name '_' '-' in
7627 try find_map (function FishAlias n -> Some n | _ -> None) flags
7628 with Not_found -> name in
7630 if name <> alias then [name2; alias] else [name2]
7632 let commands = List.flatten commands in
7634 List.iter (pr " \"%s\",\n") commands;
7640 generator (const char *text, int state)
7642 static size_t index, len;
7647 len = strlen (text);
7650 rl_attempted_completion_over = 1;
7652 while ((name = commands[index]) != NULL) {
7654 if (STRCASEEQLEN (name, text, len))
7655 return strdup (name);
7661 #endif /* HAVE_LIBREADLINE */
7663 #ifdef HAVE_RL_COMPLETION_MATCHES
7664 #define RL_COMPLETION_MATCHES rl_completion_matches
7666 #ifdef HAVE_COMPLETION_MATCHES
7667 #define RL_COMPLETION_MATCHES completion_matches
7669 #endif /* else just fail if we don't have either symbol */
7672 do_completion (const char *text, int start, int end)
7674 char **matches = NULL;
7676 #ifdef HAVE_LIBREADLINE
7677 rl_completion_append_character = ' ';
7680 matches = RL_COMPLETION_MATCHES (text, generator);
7681 else if (complete_dest_paths)
7682 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7689 (* Generate the POD documentation for guestfish. *)
7690 and generate_fish_actions_pod () =
7691 let all_functions_sorted =
7693 fun (_, _, _, flags, _, _, _) ->
7694 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7695 ) all_functions_sorted in
7697 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7700 fun (name, style, _, flags, _, _, longdesc) ->
7702 Str.global_substitute rex (
7705 try Str.matched_group 1 s
7707 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7708 "C<" ^ replace_char sub '_' '-' ^ ">"
7710 let name = replace_char name '_' '-' in
7712 try find_map (function FishAlias n -> Some n | _ -> None) flags
7713 with Not_found -> name in
7715 pr "=head2 %s" name;
7716 if name <> alias then
7723 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7724 | OptString n -> pr " %s" n
7725 | StringList n | DeviceList n -> pr " '%s ...'" n
7726 | Bool _ -> pr " true|false"
7727 | Int n -> pr " %s" n
7728 | Int64 n -> pr " %s" n
7729 | FileIn n | FileOut n -> pr " (%s|-)" n
7733 pr "%s\n\n" longdesc;
7735 if List.exists (function FileIn _ | FileOut _ -> true
7736 | _ -> false) (snd style) then
7737 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7739 if List.mem ProtocolLimitWarning flags then
7740 pr "%s\n\n" protocol_limit_warning;
7742 if List.mem DangerWillRobinson flags then
7743 pr "%s\n\n" danger_will_robinson;
7745 match deprecation_notice flags with
7747 | Some txt -> pr "%s\n\n" txt
7748 ) all_functions_sorted
7750 (* Generate a C function prototype. *)
7751 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7752 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7754 ?handle name style =
7755 if extern then pr "extern ";
7756 if static then pr "static ";
7757 (match fst style with
7759 | RInt _ -> pr "int "
7760 | RInt64 _ -> pr "int64_t "
7761 | RBool _ -> pr "int "
7762 | RConstString _ | RConstOptString _ -> pr "const char *"
7763 | RString _ | RBufferOut _ -> pr "char *"
7764 | RStringList _ | RHashtable _ -> pr "char **"
7765 | RStruct (_, typ) ->
7766 if not in_daemon then pr "struct guestfs_%s *" typ
7767 else pr "guestfs_int_%s *" typ
7768 | RStructList (_, typ) ->
7769 if not in_daemon then pr "struct guestfs_%s_list *" typ
7770 else pr "guestfs_int_%s_list *" typ
7772 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7773 pr "%s%s (" prefix name;
7774 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7777 let comma = ref false in
7780 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7784 if single_line then pr ", " else pr ",\n\t\t"
7791 | Device n | Dev_or_Path n
7795 pr "const char *%s" n
7796 | StringList n | DeviceList n ->
7798 pr "char *const *%s" n
7799 | Bool n -> next (); pr "int %s" n
7800 | Int n -> next (); pr "int %s" n
7801 | Int64 n -> next (); pr "int64_t %s" n
7804 if not in_daemon then (next (); pr "const char *%s" n)
7806 if is_RBufferOut then (next (); pr "size_t *size_r");
7809 if semicolon then pr ";";
7810 if newline then pr "\n"
7812 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7813 and generate_c_call_args ?handle ?(decl = false) style =
7815 let comma = ref false in
7817 if !comma then pr ", ";
7822 | Some handle -> pr "%s" handle; comma := true
7827 pr "%s" (name_of_argt arg)
7829 (* For RBufferOut calls, add implicit &size parameter. *)
7831 match fst style with
7839 (* Generate the OCaml bindings interface. *)
7840 and generate_ocaml_mli () =
7841 generate_header OCamlStyle LGPLv2plus;
7844 (** For API documentation you should refer to the C API
7845 in the guestfs(3) manual page. The OCaml API uses almost
7846 exactly the same calls. *)
7849 (** A [guestfs_h] handle. *)
7851 exception Error of string
7852 (** This exception is raised when there is an error. *)
7854 exception Handle_closed of string
7855 (** This exception is raised if you use a {!Guestfs.t} handle
7856 after calling {!close} on it. The string is the name of
7859 val create : unit -> t
7860 (** Create a {!Guestfs.t} handle. *)
7862 val close : t -> unit
7863 (** Close the {!Guestfs.t} handle and free up all resources used
7866 Handles are closed by the garbage collector when they become
7867 unreferenced, but callers can call this in order to provide
7868 predictable cleanup. *)
7871 generate_ocaml_structure_decls ();
7875 fun (name, style, _, _, _, shortdesc, _) ->
7876 generate_ocaml_prototype name style;
7877 pr "(** %s *)\n" shortdesc;
7879 ) all_functions_sorted
7881 (* Generate the OCaml bindings implementation. *)
7882 and generate_ocaml_ml () =
7883 generate_header OCamlStyle LGPLv2plus;
7888 exception Error of string
7889 exception Handle_closed of string
7891 external create : unit -> t = \"ocaml_guestfs_create\"
7892 external close : t -> unit = \"ocaml_guestfs_close\"
7894 (* Give the exceptions names, so they can be raised from the C code. *)
7896 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7897 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7901 generate_ocaml_structure_decls ();
7905 fun (name, style, _, _, _, shortdesc, _) ->
7906 generate_ocaml_prototype ~is_external:true name style;
7907 ) all_functions_sorted
7909 (* Generate the OCaml bindings C implementation. *)
7910 and generate_ocaml_c () =
7911 generate_header CStyle LGPLv2plus;
7918 #include <caml/config.h>
7919 #include <caml/alloc.h>
7920 #include <caml/callback.h>
7921 #include <caml/fail.h>
7922 #include <caml/memory.h>
7923 #include <caml/mlvalues.h>
7924 #include <caml/signals.h>
7926 #include \"guestfs.h\"
7928 #include \"guestfs_c.h\"
7930 /* Copy a hashtable of string pairs into an assoc-list. We return
7931 * the list in reverse order, but hashtables aren't supposed to be
7934 static CAMLprim value
7935 copy_table (char * const * argv)
7938 CAMLlocal5 (rv, pairv, kv, vv, cons);
7942 for (i = 0; argv[i] != NULL; i += 2) {
7943 kv = caml_copy_string (argv[i]);
7944 vv = caml_copy_string (argv[i+1]);
7945 pairv = caml_alloc (2, 0);
7946 Store_field (pairv, 0, kv);
7947 Store_field (pairv, 1, vv);
7948 cons = caml_alloc (2, 0);
7949 Store_field (cons, 1, rv);
7951 Store_field (cons, 0, pairv);
7959 (* Struct copy functions. *)
7961 let emit_ocaml_copy_list_function typ =
7962 pr "static CAMLprim value\n";
7963 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7965 pr " CAMLparam0 ();\n";
7966 pr " CAMLlocal2 (rv, v);\n";
7967 pr " unsigned int i;\n";
7969 pr " if (%ss->len == 0)\n" typ;
7970 pr " CAMLreturn (Atom (0));\n";
7972 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7973 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7974 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7975 pr " caml_modify (&Field (rv, i), v);\n";
7977 pr " CAMLreturn (rv);\n";
7985 let has_optpercent_col =
7986 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7988 pr "static CAMLprim value\n";
7989 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7991 pr " CAMLparam0 ();\n";
7992 if has_optpercent_col then
7993 pr " CAMLlocal3 (rv, v, v2);\n"
7995 pr " CAMLlocal2 (rv, v);\n";
7997 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8002 pr " v = caml_copy_string (%s->%s);\n" typ name
8004 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8005 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8008 pr " v = caml_alloc_string (32);\n";
8009 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8010 | name, (FBytes|FInt64|FUInt64) ->
8011 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8012 | name, (FInt32|FUInt32) ->
8013 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8014 | name, FOptPercent ->
8015 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8016 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8017 pr " v = caml_alloc (1, 0);\n";
8018 pr " Store_field (v, 0, v2);\n";
8019 pr " } else /* None */\n";
8020 pr " v = Val_int (0);\n";
8022 pr " v = Val_int (%s->%s);\n" typ name
8024 pr " Store_field (rv, %d, v);\n" i
8026 pr " CAMLreturn (rv);\n";
8031 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8034 | typ, (RStructListOnly | RStructAndList) ->
8035 (* generate the function for typ *)
8036 emit_ocaml_copy_list_function typ
8037 | typ, _ -> () (* empty *)
8038 ) (rstructs_used_by all_functions);
8042 fun (name, style, _, _, _, _, _) ->
8043 pr "/* Automatically generated wrapper for function\n";
8045 generate_ocaml_prototype name style;
8050 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8052 let needs_extra_vs =
8053 match fst style with RConstOptString _ -> true | _ -> false in
8055 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8056 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8057 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8060 pr "CAMLprim value\n";
8061 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8062 List.iter (pr ", value %s") (List.tl params);
8067 | [p1; p2; p3; p4; p5] ->
8068 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8069 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8070 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8071 pr " CAMLxparam%d (%s);\n"
8072 (List.length rest) (String.concat ", " rest)
8074 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8076 if not needs_extra_vs then
8077 pr " CAMLlocal1 (rv);\n"
8079 pr " CAMLlocal3 (rv, v, v2);\n";
8082 pr " guestfs_h *g = Guestfs_val (gv);\n";
8083 pr " if (g == NULL)\n";
8084 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8090 | Device n | Dev_or_Path n
8094 (* Copy strings in case the GC moves them: RHBZ#604691 *)
8095 pr " char *%s = guestfs_safe_strdup (g, String_val (%sv));\n" n n
8097 pr " char *%s =\n" n;
8098 pr " %sv != Val_int (0) ?" n;
8099 pr " guestfs_safe_strdup (g, String_val (Field (%sv, 0))) : NULL;\n" n
8100 | StringList n | DeviceList n ->
8101 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8103 pr " int %s = Bool_val (%sv);\n" n n
8105 pr " int %s = Int_val (%sv);\n" n n
8107 pr " int64_t %s = Int64_val (%sv);\n" n n
8110 match fst style with
8111 | RErr -> pr " int r;\n"; "-1"
8112 | RInt _ -> pr " int r;\n"; "-1"
8113 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8114 | RBool _ -> pr " int r;\n"; "-1"
8115 | RConstString _ | RConstOptString _ ->
8116 pr " const char *r;\n"; "NULL"
8117 | RString _ -> pr " char *r;\n"; "NULL"
8122 | RStruct (_, typ) ->
8123 pr " struct guestfs_%s *r;\n" typ; "NULL"
8124 | RStructList (_, typ) ->
8125 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8132 pr " size_t size;\n";
8136 pr " caml_enter_blocking_section ();\n";
8137 pr " r = guestfs_%s " name;
8138 generate_c_call_args ~handle:"g" style;
8140 pr " caml_leave_blocking_section ();\n";
8142 (* Free strings if we copied them above. *)
8145 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
8146 | FileIn n | FileOut n ->
8147 pr " free (%s);\n" n
8148 | StringList n | DeviceList n ->
8149 pr " ocaml_guestfs_free_strings (%s);\n" n;
8150 | Bool _ | Int _ | Int64 _ -> ()
8153 pr " if (r == %s)\n" error_code;
8154 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8157 (match fst style with
8158 | RErr -> pr " rv = Val_unit;\n"
8159 | RInt _ -> pr " rv = Val_int (r);\n"
8161 pr " rv = caml_copy_int64 (r);\n"
8162 | RBool _ -> pr " rv = Val_bool (r);\n"
8164 pr " rv = caml_copy_string (r);\n"
8165 | RConstOptString _ ->
8166 pr " if (r) { /* Some string */\n";
8167 pr " v = caml_alloc (1, 0);\n";
8168 pr " v2 = caml_copy_string (r);\n";
8169 pr " Store_field (v, 0, v2);\n";
8170 pr " } else /* None */\n";
8171 pr " v = Val_int (0);\n";
8173 pr " rv = caml_copy_string (r);\n";
8176 pr " rv = caml_copy_string_array ((const char **) r);\n";
8177 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8179 | RStruct (_, typ) ->
8180 pr " rv = copy_%s (r);\n" typ;
8181 pr " guestfs_free_%s (r);\n" typ;
8182 | RStructList (_, typ) ->
8183 pr " rv = copy_%s_list (r);\n" typ;
8184 pr " guestfs_free_%s_list (r);\n" typ;
8186 pr " rv = copy_table (r);\n";
8187 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8190 pr " rv = caml_alloc_string (size);\n";
8191 pr " memcpy (String_val (rv), r, size);\n";
8194 pr " CAMLreturn (rv);\n";
8198 if List.length params > 5 then (
8199 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8200 pr "CAMLprim value ";
8201 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8202 pr "CAMLprim value\n";
8203 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8205 pr " return ocaml_guestfs_%s (argv[0]" name;
8206 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8211 ) all_functions_sorted
8213 and generate_ocaml_structure_decls () =
8216 pr "type %s = {\n" typ;
8219 | name, FString -> pr " %s : string;\n" name
8220 | name, FBuffer -> pr " %s : string;\n" name
8221 | name, FUUID -> pr " %s : string;\n" name
8222 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8223 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8224 | name, FChar -> pr " %s : char;\n" name
8225 | name, FOptPercent -> pr " %s : float option;\n" name
8231 and generate_ocaml_prototype ?(is_external = false) name style =
8232 if is_external then pr "external " else pr "val ";
8233 pr "%s : t -> " name;
8236 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
8237 | OptString _ -> pr "string option -> "
8238 | StringList _ | DeviceList _ -> pr "string array -> "
8239 | Bool _ -> pr "bool -> "
8240 | Int _ -> pr "int -> "
8241 | Int64 _ -> pr "int64 -> "
8243 (match fst style with
8244 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8245 | RInt _ -> pr "int"
8246 | RInt64 _ -> pr "int64"
8247 | RBool _ -> pr "bool"
8248 | RConstString _ -> pr "string"
8249 | RConstOptString _ -> pr "string option"
8250 | RString _ | RBufferOut _ -> pr "string"
8251 | RStringList _ -> pr "string array"
8252 | RStruct (_, typ) -> pr "%s" typ
8253 | RStructList (_, typ) -> pr "%s array" typ
8254 | RHashtable _ -> pr "(string * string) list"
8256 if is_external then (
8258 if List.length (snd style) + 1 > 5 then
8259 pr "\"ocaml_guestfs_%s_byte\" " name;
8260 pr "\"ocaml_guestfs_%s\"" name
8264 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8265 and generate_perl_xs () =
8266 generate_header CStyle LGPLv2plus;
8269 #include \"EXTERN.h\"
8273 #include <guestfs.h>
8276 #define PRId64 \"lld\"
8280 my_newSVll(long long val) {
8281 #ifdef USE_64_BIT_ALL
8282 return newSViv(val);
8286 len = snprintf(buf, 100, \"%%\" PRId64, val);
8287 return newSVpv(buf, len);
8292 #define PRIu64 \"llu\"
8296 my_newSVull(unsigned long long val) {
8297 #ifdef USE_64_BIT_ALL
8298 return newSVuv(val);
8302 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8303 return newSVpv(buf, len);
8307 /* http://www.perlmonks.org/?node_id=680842 */
8309 XS_unpack_charPtrPtr (SV *arg) {
8314 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8315 croak (\"array reference expected\");
8317 av = (AV *)SvRV (arg);
8318 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8320 croak (\"malloc failed\");
8322 for (i = 0; i <= av_len (av); i++) {
8323 SV **elem = av_fetch (av, i, 0);
8325 if (!elem || !*elem)
8326 croak (\"missing element in list\");
8328 ret[i] = SvPV_nolen (*elem);
8336 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8343 RETVAL = guestfs_create ();
8345 croak (\"could not create guestfs handle\");
8346 guestfs_set_error_handler (RETVAL, NULL, NULL);
8359 fun (name, style, _, _, _, _, _) ->
8360 (match fst style with
8361 | RErr -> pr "void\n"
8362 | RInt _ -> pr "SV *\n"
8363 | RInt64 _ -> pr "SV *\n"
8364 | RBool _ -> pr "SV *\n"
8365 | RConstString _ -> pr "SV *\n"
8366 | RConstOptString _ -> pr "SV *\n"
8367 | RString _ -> pr "SV *\n"
8368 | RBufferOut _ -> pr "SV *\n"
8370 | RStruct _ | RStructList _
8372 pr "void\n" (* all lists returned implictly on the stack *)
8374 (* Call and arguments. *)
8376 generate_c_call_args ~handle:"g" ~decl:true style;
8378 pr " guestfs_h *g;\n";
8382 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8385 (* http://www.perlmonks.org/?node_id=554277
8386 * Note that the implicit handle argument means we have
8387 * to add 1 to the ST(x) operator.
8389 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8390 | StringList n | DeviceList n -> pr " char **%s;\n" n
8391 | Bool n -> pr " int %s;\n" n
8392 | Int n -> pr " int %s;\n" n
8393 | Int64 n -> pr " int64_t %s;\n" n
8396 let do_cleanups () =
8399 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8400 | Bool _ | Int _ | Int64 _
8401 | FileIn _ | FileOut _ -> ()
8402 | StringList n | DeviceList n -> pr " free (%s);\n" n
8407 (match fst style with
8412 pr " r = guestfs_%s " name;
8413 generate_c_call_args ~handle:"g" style;
8416 pr " if (r == -1)\n";
8417 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8423 pr " %s = guestfs_%s " n name;
8424 generate_c_call_args ~handle:"g" style;
8427 pr " if (%s == -1)\n" n;
8428 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8429 pr " RETVAL = newSViv (%s);\n" n;
8434 pr " int64_t %s;\n" n;
8436 pr " %s = guestfs_%s " n name;
8437 generate_c_call_args ~handle:"g" style;
8440 pr " if (%s == -1)\n" n;
8441 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8442 pr " RETVAL = my_newSVll (%s);\n" n;
8447 pr " const char *%s;\n" n;
8449 pr " %s = guestfs_%s " n name;
8450 generate_c_call_args ~handle:"g" style;
8453 pr " if (%s == NULL)\n" n;
8454 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8455 pr " RETVAL = newSVpv (%s, 0);\n" n;
8458 | RConstOptString n ->
8460 pr " const char *%s;\n" n;
8462 pr " %s = guestfs_%s " n name;
8463 generate_c_call_args ~handle:"g" style;
8466 pr " if (%s == NULL)\n" n;
8467 pr " RETVAL = &PL_sv_undef;\n";
8469 pr " RETVAL = newSVpv (%s, 0);\n" n;
8474 pr " char *%s;\n" n;
8476 pr " %s = guestfs_%s " n name;
8477 generate_c_call_args ~handle:"g" style;
8480 pr " if (%s == NULL)\n" n;
8481 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8482 pr " RETVAL = newSVpv (%s, 0);\n" n;
8483 pr " free (%s);\n" n;
8486 | RStringList n | RHashtable n ->
8488 pr " char **%s;\n" n;
8489 pr " size_t i, n;\n";
8491 pr " %s = guestfs_%s " n name;
8492 generate_c_call_args ~handle:"g" style;
8495 pr " if (%s == NULL)\n" n;
8496 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8497 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8498 pr " EXTEND (SP, n);\n";
8499 pr " for (i = 0; i < n; ++i) {\n";
8500 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8501 pr " free (%s[i]);\n" n;
8503 pr " free (%s);\n" n;
8504 | RStruct (n, typ) ->
8505 let cols = cols_of_struct typ in
8506 generate_perl_struct_code typ cols name style n do_cleanups
8507 | RStructList (n, typ) ->
8508 let cols = cols_of_struct typ in
8509 generate_perl_struct_list_code typ cols name style n do_cleanups
8512 pr " char *%s;\n" n;
8513 pr " size_t size;\n";
8515 pr " %s = guestfs_%s " n name;
8516 generate_c_call_args ~handle:"g" style;
8519 pr " if (%s == NULL)\n" n;
8520 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8521 pr " RETVAL = newSVpvn (%s, size);\n" n;
8522 pr " free (%s);\n" n;
8530 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8532 pr " struct guestfs_%s_list *%s;\n" typ n;
8536 pr " %s = guestfs_%s " n name;
8537 generate_c_call_args ~handle:"g" style;
8540 pr " if (%s == NULL)\n" n;
8541 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8542 pr " EXTEND (SP, %s->len);\n" n;
8543 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8544 pr " hv = newHV ();\n";
8548 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8549 name (String.length name) n name
8551 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8552 name (String.length name) n name
8554 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8555 name (String.length name) n name n name
8556 | name, (FBytes|FUInt64) ->
8557 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8558 name (String.length name) n name
8560 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8561 name (String.length name) n name
8562 | name, (FInt32|FUInt32) ->
8563 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8564 name (String.length name) n name
8566 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8567 name (String.length name) n name
8568 | name, FOptPercent ->
8569 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8570 name (String.length name) n name
8572 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8574 pr " guestfs_free_%s_list (%s);\n" typ n
8576 and generate_perl_struct_code typ cols name style n do_cleanups =
8578 pr " struct guestfs_%s *%s;\n" typ n;
8580 pr " %s = guestfs_%s " n name;
8581 generate_c_call_args ~handle:"g" style;
8584 pr " if (%s == NULL)\n" n;
8585 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8586 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8588 fun ((name, _) as col) ->
8589 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8593 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8596 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8599 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8601 | name, (FBytes|FUInt64) ->
8602 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8605 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8607 | name, (FInt32|FUInt32) ->
8608 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8611 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8613 | name, FOptPercent ->
8614 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8617 pr " free (%s);\n" n
8619 (* Generate Sys/Guestfs.pm. *)
8620 and generate_perl_pm () =
8621 generate_header HashStyle LGPLv2plus;
8628 Sys::Guestfs - Perl bindings for libguestfs
8634 my $h = Sys::Guestfs->new ();
8635 $h->add_drive ('guest.img');
8637 $h->mount ('/dev/sda1', '/');
8638 $h->touch ('/hello');
8643 The C<Sys::Guestfs> module provides a Perl XS binding to the
8644 libguestfs API for examining and modifying virtual machine
8647 Amongst the things this is good for: making batch configuration
8648 changes to guests, getting disk used/free statistics (see also:
8649 virt-df), migrating between virtualization systems (see also:
8650 virt-p2v), performing partial backups, performing partial guest
8651 clones, cloning guests and changing registry/UUID/hostname info, and
8654 Libguestfs uses Linux kernel and qemu code, and can access any type of
8655 guest filesystem that Linux and qemu can, including but not limited
8656 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8657 schemes, qcow, qcow2, vmdk.
8659 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8660 LVs, what filesystem is in each LV, etc.). It can also run commands
8661 in the context of the guest. Also you can access filesystems over
8664 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8665 functions for using libguestfs from Perl, including integration
8670 All errors turn into calls to C<croak> (see L<Carp(3)>).
8678 package Sys::Guestfs;
8684 XSLoader::load ('Sys::Guestfs');
8686 =item $h = Sys::Guestfs->new ();
8688 Create a new guestfs handle.
8694 my $class = ref ($proto) || $proto;
8696 my $self = Sys::Guestfs::_create ();
8697 bless $self, $class;
8703 (* Actions. We only need to print documentation for these as
8704 * they are pulled in from the XS code automatically.
8707 fun (name, style, _, flags, _, _, longdesc) ->
8708 if not (List.mem NotInDocs flags) then (
8709 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8711 generate_perl_prototype name style;
8713 pr "%s\n\n" longdesc;
8714 if List.mem ProtocolLimitWarning flags then
8715 pr "%s\n\n" protocol_limit_warning;
8716 if List.mem DangerWillRobinson flags then
8717 pr "%s\n\n" danger_will_robinson;
8718 match deprecation_notice flags with
8720 | Some txt -> pr "%s\n\n" txt
8722 ) all_functions_sorted;
8734 Copyright (C) %s Red Hat Inc.
8738 Please see the file COPYING.LIB for the full license.
8744 L<http://libguestfs.org>,
8745 L<Sys::Guestfs::Lib(3)>.
8750 and generate_perl_prototype name style =
8751 (match fst style with
8759 | RBufferOut n -> pr "$%s = " n
8761 | RHashtable n -> pr "%%%s = " n
8763 | RStructList (n,_) -> pr "@%s = " n
8766 let comma = ref false in
8769 if !comma then pr ", ";
8772 | Pathname n | Device n | Dev_or_Path n | String n
8773 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8775 | StringList n | DeviceList n ->
8780 (* Generate Python C module. *)
8781 and generate_python_c () =
8782 generate_header CStyle LGPLv2plus;
8791 #include \"guestfs.h\"
8799 get_handle (PyObject *obj)
8802 assert (obj != Py_None);
8803 return ((Pyguestfs_Object *) obj)->g;
8807 put_handle (guestfs_h *g)
8811 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8814 /* This list should be freed (but not the strings) after use. */
8816 get_string_list (PyObject *obj)
8823 if (!PyList_Check (obj)) {
8824 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8828 Py_ssize_t slen = PyList_Size (obj);
8830 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: PyList_Size failure\");
8833 len = (size_t) slen;
8834 r = malloc (sizeof (char *) * (len+1));
8836 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8840 for (i = 0; i < len; ++i)
8841 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8848 put_string_list (char * const * const argv)
8853 for (argc = 0; argv[argc] != NULL; ++argc)
8856 list = PyList_New (argc);
8857 for (i = 0; i < argc; ++i)
8858 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8864 put_table (char * const * const argv)
8866 PyObject *list, *item;
8869 for (argc = 0; argv[argc] != NULL; ++argc)
8872 list = PyList_New (argc >> 1);
8873 for (i = 0; i < argc; i += 2) {
8874 item = PyTuple_New (2);
8875 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8876 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8877 PyList_SetItem (list, i >> 1, item);
8884 free_strings (char **argv)
8888 for (argc = 0; argv[argc] != NULL; ++argc)
8894 py_guestfs_create (PyObject *self, PyObject *args)
8898 g = guestfs_create ();
8900 PyErr_SetString (PyExc_RuntimeError,
8901 \"guestfs.create: failed to allocate handle\");
8904 guestfs_set_error_handler (g, NULL, NULL);
8905 return put_handle (g);
8909 py_guestfs_close (PyObject *self, PyObject *args)
8914 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8916 g = get_handle (py_g);
8920 Py_INCREF (Py_None);
8926 let emit_put_list_function typ =
8927 pr "static PyObject *\n";
8928 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8930 pr " PyObject *list;\n";
8933 pr " list = PyList_New (%ss->len);\n" typ;
8934 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8935 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8936 pr " return list;\n";
8941 (* Structures, turned into Python dictionaries. *)
8944 pr "static PyObject *\n";
8945 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8947 pr " PyObject *dict;\n";
8949 pr " dict = PyDict_New ();\n";
8953 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8954 pr " PyString_FromString (%s->%s));\n"
8957 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8958 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8961 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8962 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8964 | name, (FBytes|FUInt64) ->
8965 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8966 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8969 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8970 pr " PyLong_FromLongLong (%s->%s));\n"
8973 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8974 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8977 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8978 pr " PyLong_FromLong (%s->%s));\n"
8980 | name, FOptPercent ->
8981 pr " if (%s->%s >= 0)\n" typ name;
8982 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8983 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8986 pr " Py_INCREF (Py_None);\n";
8987 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8990 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8991 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8993 pr " return dict;\n";
8999 (* Emit a put_TYPE_list function definition only if that function is used. *)
9002 | typ, (RStructListOnly | RStructAndList) ->
9003 (* generate the function for typ *)
9004 emit_put_list_function typ
9005 | typ, _ -> () (* empty *)
9006 ) (rstructs_used_by all_functions);
9008 (* Python wrapper functions. *)
9010 fun (name, style, _, _, _, _, _) ->
9011 pr "static PyObject *\n";
9012 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9015 pr " PyObject *py_g;\n";
9016 pr " guestfs_h *g;\n";
9017 pr " PyObject *py_r;\n";
9020 match fst style with
9021 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9022 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9023 | RConstString _ | RConstOptString _ ->
9024 pr " const char *r;\n"; "NULL"
9025 | RString _ -> pr " char *r;\n"; "NULL"
9026 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9027 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9028 | RStructList (_, typ) ->
9029 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9032 pr " size_t size;\n";
9037 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9038 pr " const char *%s;\n" n
9039 | OptString n -> pr " const char *%s;\n" n
9040 | StringList n | DeviceList n ->
9041 pr " PyObject *py_%s;\n" n;
9042 pr " char **%s;\n" n
9043 | Bool n -> pr " int %s;\n" n
9044 | Int n -> pr " int %s;\n" n
9045 | Int64 n -> pr " long long %s;\n" n
9050 (* Convert the parameters. *)
9051 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9054 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9055 | OptString _ -> pr "z"
9056 | StringList _ | DeviceList _ -> pr "O"
9057 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9059 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9060 * emulate C's int/long/long long in Python?
9063 pr ":guestfs_%s\",\n" name;
9067 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9068 | OptString n -> pr ", &%s" n
9069 | StringList n | DeviceList n -> pr ", &py_%s" n
9070 | Bool n -> pr ", &%s" n
9071 | Int n -> pr ", &%s" n
9072 | Int64 n -> pr ", &%s" n
9076 pr " return NULL;\n";
9078 pr " g = get_handle (py_g);\n";
9081 | Pathname _ | Device _ | Dev_or_Path _ | String _
9082 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9083 | StringList n | DeviceList n ->
9084 pr " %s = get_string_list (py_%s);\n" n n;
9085 pr " if (!%s) return NULL;\n" n
9090 pr " r = guestfs_%s " name;
9091 generate_c_call_args ~handle:"g" style;
9096 | Pathname _ | Device _ | Dev_or_Path _ | String _
9097 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9098 | StringList n | DeviceList n ->
9099 pr " free (%s);\n" n
9102 pr " if (r == %s) {\n" error_code;
9103 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9104 pr " return NULL;\n";
9108 (match fst style with
9110 pr " Py_INCREF (Py_None);\n";
9111 pr " py_r = Py_None;\n"
9113 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9114 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9115 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9116 | RConstOptString _ ->
9118 pr " py_r = PyString_FromString (r);\n";
9120 pr " Py_INCREF (Py_None);\n";
9121 pr " py_r = Py_None;\n";
9124 pr " py_r = PyString_FromString (r);\n";
9127 pr " py_r = put_string_list (r);\n";
9128 pr " free_strings (r);\n"
9129 | RStruct (_, typ) ->
9130 pr " py_r = put_%s (r);\n" typ;
9131 pr " guestfs_free_%s (r);\n" typ
9132 | RStructList (_, typ) ->
9133 pr " py_r = put_%s_list (r);\n" typ;
9134 pr " guestfs_free_%s_list (r);\n" typ
9136 pr " py_r = put_table (r);\n";
9137 pr " free_strings (r);\n"
9139 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9143 pr " return py_r;\n";
9148 (* Table of functions. *)
9149 pr "static PyMethodDef methods[] = {\n";
9150 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9151 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9153 fun (name, _, _, _, _, _, _) ->
9154 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9157 pr " { NULL, NULL, 0, NULL }\n";
9161 (* Init function. *)
9164 initlibguestfsmod (void)
9166 static int initialized = 0;
9168 if (initialized) return;
9169 Py_InitModule ((char *) \"libguestfsmod\", methods);
9174 (* Generate Python module. *)
9175 and generate_python_py () =
9176 generate_header HashStyle LGPLv2plus;
9179 u\"\"\"Python bindings for libguestfs
9182 g = guestfs.GuestFS ()
9183 g.add_drive (\"guest.img\")
9185 parts = g.list_partitions ()
9187 The guestfs module provides a Python binding to the libguestfs API
9188 for examining and modifying virtual machine disk images.
9190 Amongst the things this is good for: making batch configuration
9191 changes to guests, getting disk used/free statistics (see also:
9192 virt-df), migrating between virtualization systems (see also:
9193 virt-p2v), performing partial backups, performing partial guest
9194 clones, cloning guests and changing registry/UUID/hostname info, and
9197 Libguestfs uses Linux kernel and qemu code, and can access any type of
9198 guest filesystem that Linux and qemu can, including but not limited
9199 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9200 schemes, qcow, qcow2, vmdk.
9202 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9203 LVs, what filesystem is in each LV, etc.). It can also run commands
9204 in the context of the guest. Also you can access filesystems over
9207 Errors which happen while using the API are turned into Python
9208 RuntimeError exceptions.
9210 To create a guestfs handle you usually have to perform the following
9213 # Create the handle, call add_drive at least once, and possibly
9214 # several times if the guest has multiple block devices:
9215 g = guestfs.GuestFS ()
9216 g.add_drive (\"guest.img\")
9218 # Launch the qemu subprocess and wait for it to become ready:
9221 # Now you can issue commands, for example:
9226 import libguestfsmod
9229 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9231 def __init__ (self):
9232 \"\"\"Create a new libguestfs handle.\"\"\"
9233 self._o = libguestfsmod.create ()
9236 libguestfsmod.close (self._o)
9241 fun (name, style, _, flags, _, _, longdesc) ->
9243 generate_py_call_args ~handle:"self" (snd style);
9246 if not (List.mem NotInDocs flags) then (
9247 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9249 match fst style with
9250 | RErr | RInt _ | RInt64 _ | RBool _
9251 | RConstOptString _ | RConstString _
9252 | RString _ | RBufferOut _ -> doc
9254 doc ^ "\n\nThis function returns a list of strings."
9255 | RStruct (_, typ) ->
9256 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9257 | RStructList (_, typ) ->
9258 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9260 doc ^ "\n\nThis function returns a dictionary." in
9262 if List.mem ProtocolLimitWarning flags then
9263 doc ^ "\n\n" ^ protocol_limit_warning
9266 if List.mem DangerWillRobinson flags then
9267 doc ^ "\n\n" ^ danger_will_robinson
9270 match deprecation_notice flags with
9272 | Some txt -> doc ^ "\n\n" ^ txt in
9273 let doc = pod2text ~width:60 name doc in
9274 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9275 let doc = String.concat "\n " doc in
9276 pr " u\"\"\"%s\"\"\"\n" doc;
9278 pr " return libguestfsmod.%s " name;
9279 generate_py_call_args ~handle:"self._o" (snd style);
9284 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9285 and generate_py_call_args ~handle args =
9287 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9290 (* Useful if you need the longdesc POD text as plain text. Returns a
9293 * Because this is very slow (the slowest part of autogeneration),
9294 * we memoize the results.
9296 and pod2text ~width name longdesc =
9297 let key = width, name, longdesc in
9298 try Hashtbl.find pod2text_memo key
9300 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9301 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9303 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9304 let chan = open_process_in cmd in
9305 let lines = ref [] in
9307 let line = input_line chan in
9308 if i = 1 then (* discard the first line of output *)
9311 let line = triml line in
9312 lines := line :: !lines;
9315 let lines = try loop 1 with End_of_file -> List.rev !lines in
9317 (match close_process_in chan with
9320 failwithf "pod2text: process exited with non-zero status (%d)" i
9321 | WSIGNALED i | WSTOPPED i ->
9322 failwithf "pod2text: process signalled or stopped by signal %d" i
9324 Hashtbl.add pod2text_memo key lines;
9325 pod2text_memo_updated ();
9328 (* Generate ruby bindings. *)
9329 and generate_ruby_c () =
9330 generate_header CStyle LGPLv2plus;
9338 #include \"guestfs.h\"
9340 #include \"extconf.h\"
9342 /* For Ruby < 1.9 */
9344 #define RARRAY_LEN(r) (RARRAY((r))->len)
9347 static VALUE m_guestfs; /* guestfs module */
9348 static VALUE c_guestfs; /* guestfs_h handle */
9349 static VALUE e_Error; /* used for all errors */
9351 static void ruby_guestfs_free (void *p)
9354 guestfs_close ((guestfs_h *) p);
9357 static VALUE ruby_guestfs_create (VALUE m)
9361 g = guestfs_create ();
9363 rb_raise (e_Error, \"failed to create guestfs handle\");
9365 /* Don't print error messages to stderr by default. */
9366 guestfs_set_error_handler (g, NULL, NULL);
9368 /* Wrap it, and make sure the close function is called when the
9371 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9374 static VALUE ruby_guestfs_close (VALUE gv)
9377 Data_Get_Struct (gv, guestfs_h, g);
9379 ruby_guestfs_free (g);
9380 DATA_PTR (gv) = NULL;
9388 fun (name, style, _, _, _, _, _) ->
9389 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9390 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9393 pr " guestfs_h *g;\n";
9394 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9396 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9402 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9403 pr " Check_Type (%sv, T_STRING);\n" n;
9404 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9406 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9407 pr " \"%s\", \"%s\");\n" n name
9409 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9410 | StringList n | DeviceList n ->
9411 pr " char **%s;\n" n;
9412 pr " Check_Type (%sv, T_ARRAY);\n" n;
9414 pr " size_t i, len;\n";
9415 pr " len = RARRAY_LEN (%sv);\n" n;
9416 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9418 pr " for (i = 0; i < len; ++i) {\n";
9419 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9420 pr " %s[i] = StringValueCStr (v);\n" n;
9422 pr " %s[len] = NULL;\n" n;
9425 pr " int %s = RTEST (%sv);\n" n n
9427 pr " int %s = NUM2INT (%sv);\n" n n
9429 pr " long long %s = NUM2LL (%sv);\n" n n
9434 match fst style with
9435 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9436 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9437 | RConstString _ | RConstOptString _ ->
9438 pr " const char *r;\n"; "NULL"
9439 | RString _ -> pr " char *r;\n"; "NULL"
9440 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9441 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9442 | RStructList (_, typ) ->
9443 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9446 pr " size_t size;\n";
9450 pr " r = guestfs_%s " name;
9451 generate_c_call_args ~handle:"g" style;
9456 | Pathname _ | Device _ | Dev_or_Path _ | String _
9457 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9458 | StringList n | DeviceList n ->
9459 pr " free (%s);\n" n
9462 pr " if (r == %s)\n" error_code;
9463 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9466 (match fst style with
9468 pr " return Qnil;\n"
9469 | RInt _ | RBool _ ->
9470 pr " return INT2NUM (r);\n"
9472 pr " return ULL2NUM (r);\n"
9474 pr " return rb_str_new2 (r);\n";
9475 | RConstOptString _ ->
9477 pr " return rb_str_new2 (r);\n";
9479 pr " return Qnil;\n";
9481 pr " VALUE rv = rb_str_new2 (r);\n";
9485 pr " size_t i, len = 0;\n";
9486 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9487 pr " VALUE rv = rb_ary_new2 (len);\n";
9488 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9489 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9490 pr " free (r[i]);\n";
9494 | RStruct (_, typ) ->
9495 let cols = cols_of_struct typ in
9496 generate_ruby_struct_code typ cols
9497 | RStructList (_, typ) ->
9498 let cols = cols_of_struct typ in
9499 generate_ruby_struct_list_code typ cols
9501 pr " VALUE rv = rb_hash_new ();\n";
9503 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9504 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9505 pr " free (r[i]);\n";
9506 pr " free (r[i+1]);\n";
9511 pr " VALUE rv = rb_str_new (r, size);\n";
9521 /* Initialize the module. */
9522 void Init__guestfs ()
9524 m_guestfs = rb_define_module (\"Guestfs\");
9525 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9526 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9528 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9529 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9532 (* Define the rest of the methods. *)
9534 fun (name, style, _, _, _, _, _) ->
9535 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9536 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9541 (* Ruby code to return a struct. *)
9542 and generate_ruby_struct_code typ cols =
9543 pr " VALUE rv = rb_hash_new ();\n";
9547 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9549 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9551 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9552 | name, (FBytes|FUInt64) ->
9553 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9555 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9557 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9559 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9560 | name, FOptPercent ->
9561 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9562 | name, FChar -> (* XXX wrong? *)
9563 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9565 pr " guestfs_free_%s (r);\n" typ;
9568 (* Ruby code to return a struct list. *)
9569 and generate_ruby_struct_list_code typ cols =
9570 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9572 pr " for (i = 0; i < r->len; ++i) {\n";
9573 pr " VALUE hv = rb_hash_new ();\n";
9577 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9579 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
9581 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9582 | name, (FBytes|FUInt64) ->
9583 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9585 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9587 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9589 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9590 | name, FOptPercent ->
9591 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9592 | name, FChar -> (* XXX wrong? *)
9593 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9595 pr " rb_ary_push (rv, hv);\n";
9597 pr " guestfs_free_%s_list (r);\n" typ;
9600 (* Generate Java bindings GuestFS.java file. *)
9601 and generate_java_java () =
9602 generate_header CStyle LGPLv2plus;
9605 package com.redhat.et.libguestfs;
9607 import java.util.HashMap;
9608 import com.redhat.et.libguestfs.LibGuestFSException;
9609 import com.redhat.et.libguestfs.PV;
9610 import com.redhat.et.libguestfs.VG;
9611 import com.redhat.et.libguestfs.LV;
9612 import com.redhat.et.libguestfs.Stat;
9613 import com.redhat.et.libguestfs.StatVFS;
9614 import com.redhat.et.libguestfs.IntBool;
9615 import com.redhat.et.libguestfs.Dirent;
9618 * The GuestFS object is a libguestfs handle.
9622 public class GuestFS {
9623 // Load the native code.
9625 System.loadLibrary (\"guestfs_jni\");
9629 * The native guestfs_h pointer.
9634 * Create a libguestfs handle.
9636 * @throws LibGuestFSException
9638 public GuestFS () throws LibGuestFSException
9642 private native long _create () throws LibGuestFSException;
9645 * Close a libguestfs handle.
9647 * You can also leave handles to be collected by the garbage
9648 * collector, but this method ensures that the resources used
9649 * by the handle are freed up immediately. If you call any
9650 * other methods after closing the handle, you will get an
9653 * @throws LibGuestFSException
9655 public void close () throws LibGuestFSException
9661 private native void _close (long g) throws LibGuestFSException;
9663 public void finalize () throws LibGuestFSException
9671 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9672 if not (List.mem NotInDocs flags); then (
9673 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9675 if List.mem ProtocolLimitWarning flags then
9676 doc ^ "\n\n" ^ protocol_limit_warning
9679 if List.mem DangerWillRobinson flags then
9680 doc ^ "\n\n" ^ danger_will_robinson
9683 match deprecation_notice flags with
9685 | Some txt -> doc ^ "\n\n" ^ txt in
9686 let doc = pod2text ~width:60 name doc in
9687 let doc = List.map ( (* RHBZ#501883 *)
9690 | nonempty -> nonempty
9692 let doc = String.concat "\n * " doc in
9695 pr " * %s\n" shortdesc;
9698 pr " * @throws LibGuestFSException\n";
9702 generate_java_prototype ~public:true ~semicolon:false name style;
9705 pr " if (g == 0)\n";
9706 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9709 if fst style <> RErr then pr "return ";
9711 generate_java_call_args ~handle:"g" (snd style);
9715 generate_java_prototype ~privat:true ~native:true name style;
9722 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9723 and generate_java_call_args ~handle args =
9725 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9728 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9729 ?(semicolon=true) name style =
9730 if privat then pr "private ";
9731 if public then pr "public ";
9732 if native then pr "native ";
9735 (match fst style with
9736 | RErr -> pr "void ";
9737 | RInt _ -> pr "int ";
9738 | RInt64 _ -> pr "long ";
9739 | RBool _ -> pr "boolean ";
9740 | RConstString _ | RConstOptString _ | RString _
9741 | RBufferOut _ -> pr "String ";
9742 | RStringList _ -> pr "String[] ";
9743 | RStruct (_, typ) ->
9744 let name = java_name_of_struct typ in
9746 | RStructList (_, typ) ->
9747 let name = java_name_of_struct typ in
9749 | RHashtable _ -> pr "HashMap<String,String> ";
9752 if native then pr "_%s " name else pr "%s " name;
9754 let needs_comma = ref false in
9763 if !needs_comma then pr ", ";
9764 needs_comma := true;
9768 | Device n | Dev_or_Path n
9774 | StringList n | DeviceList n ->
9785 pr " throws LibGuestFSException";
9786 if semicolon then pr ";"
9788 and generate_java_struct jtyp cols () =
9789 generate_header CStyle LGPLv2plus;
9792 package com.redhat.et.libguestfs;
9795 * Libguestfs %s structure.
9807 | name, FBuffer -> pr " public String %s;\n" name
9808 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9809 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9810 | name, FChar -> pr " public char %s;\n" name
9811 | name, FOptPercent ->
9812 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9813 pr " public float %s;\n" name
9818 and generate_java_c () =
9819 generate_header CStyle LGPLv2plus;
9826 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9827 #include \"guestfs.h\"
9829 /* Note that this function returns. The exception is not thrown
9830 * until after the wrapper function returns.
9833 throw_exception (JNIEnv *env, const char *msg)
9836 cl = (*env)->FindClass (env,
9837 \"com/redhat/et/libguestfs/LibGuestFSException\");
9838 (*env)->ThrowNew (env, cl, msg);
9841 JNIEXPORT jlong JNICALL
9842 Java_com_redhat_et_libguestfs_GuestFS__1create
9843 (JNIEnv *env, jobject obj)
9847 g = guestfs_create ();
9849 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9852 guestfs_set_error_handler (g, NULL, NULL);
9853 return (jlong) (long) g;
9856 JNIEXPORT void JNICALL
9857 Java_com_redhat_et_libguestfs_GuestFS__1close
9858 (JNIEnv *env, jobject obj, jlong jg)
9860 guestfs_h *g = (guestfs_h *) (long) jg;
9867 fun (name, style, _, _, _, _, _) ->
9869 (match fst style with
9870 | RErr -> pr "void ";
9871 | RInt _ -> pr "jint ";
9872 | RInt64 _ -> pr "jlong ";
9873 | RBool _ -> pr "jboolean ";
9874 | RConstString _ | RConstOptString _ | RString _
9875 | RBufferOut _ -> pr "jstring ";
9876 | RStruct _ | RHashtable _ ->
9878 | RStringList _ | RStructList _ ->
9882 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9883 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9885 pr " (JNIEnv *env, jobject obj, jlong jg";
9889 | Device n | Dev_or_Path n
9894 pr ", jstring j%s" n
9895 | StringList n | DeviceList n ->
9896 pr ", jobjectArray j%s" n
9898 pr ", jboolean j%s" n
9906 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9907 let error_code, no_ret =
9908 match fst style with
9909 | RErr -> pr " int r;\n"; "-1", ""
9911 | RInt _ -> pr " int r;\n"; "-1", "0"
9912 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9913 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9914 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9916 pr " jstring jr;\n";
9917 pr " char *r;\n"; "NULL", "NULL"
9919 pr " jobjectArray jr;\n";
9922 pr " jstring jstr;\n";
9923 pr " char **r;\n"; "NULL", "NULL"
9924 | RStruct (_, typ) ->
9925 pr " jobject jr;\n";
9927 pr " jfieldID fl;\n";
9928 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9929 | RStructList (_, typ) ->
9930 pr " jobjectArray jr;\n";
9932 pr " jfieldID fl;\n";
9933 pr " jobject jfl;\n";
9934 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9935 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9937 pr " jstring jr;\n";
9939 pr " size_t size;\n";
9944 | Device n | Dev_or_Path n
9949 pr " const char *%s;\n" n
9950 | StringList n | DeviceList n ->
9951 pr " int %s_len;\n" n;
9952 pr " const char **%s;\n" n
9957 pr " int64_t %s;\n" n
9961 (match fst style with
9962 | RStringList _ | RStructList _ -> true
9963 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9965 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9966 List.exists (function
9967 | StringList _ -> true
9968 | DeviceList _ -> true
9969 | _ -> false) (snd style) in
9975 (* Get the parameters. *)
9979 | Device n | Dev_or_Path n
9983 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9985 (* This is completely undocumented, but Java null becomes
9988 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9989 | StringList n | DeviceList n ->
9990 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9991 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9992 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9993 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9995 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9997 pr " %s[%s_len] = NULL;\n" n n;
10001 pr " %s = j%s;\n" n n
10004 (* Make the call. *)
10005 pr " r = guestfs_%s " name;
10006 generate_c_call_args ~handle:"g" style;
10009 (* Release the parameters. *)
10013 | Device n | Dev_or_Path n
10017 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10019 pr " if (j%s)\n" n;
10020 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10021 | StringList n | DeviceList n ->
10022 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10023 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10025 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10027 pr " free (%s);\n" n
10033 (* Check for errors. *)
10034 pr " if (r == %s) {\n" error_code;
10035 pr " throw_exception (env, guestfs_last_error (g));\n";
10036 pr " return %s;\n" no_ret;
10039 (* Return value. *)
10040 (match fst style with
10042 | RInt _ -> pr " return (jint) r;\n"
10043 | RBool _ -> pr " return (jboolean) r;\n"
10044 | RInt64 _ -> pr " return (jlong) r;\n"
10045 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10046 | RConstOptString _ ->
10047 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10049 pr " jr = (*env)->NewStringUTF (env, r);\n";
10053 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10054 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10055 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10056 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10057 pr " for (i = 0; i < r_len; ++i) {\n";
10058 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10059 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10060 pr " free (r[i]);\n";
10064 | RStruct (_, typ) ->
10065 let jtyp = java_name_of_struct typ in
10066 let cols = cols_of_struct typ in
10067 generate_java_struct_return typ jtyp cols
10068 | RStructList (_, typ) ->
10069 let jtyp = java_name_of_struct typ in
10070 let cols = cols_of_struct typ in
10071 generate_java_struct_list_return typ jtyp cols
10074 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10075 pr " return NULL;\n"
10077 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10086 and generate_java_struct_return typ jtyp cols =
10087 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10088 pr " jr = (*env)->AllocObject (env, cl);\n";
10092 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10093 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10096 pr " char s[33];\n";
10097 pr " memcpy (s, r->%s, 32);\n" name;
10098 pr " s[32] = 0;\n";
10099 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10100 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10104 pr " int len = r->%s_len;\n" name;
10105 pr " char s[len+1];\n";
10106 pr " memcpy (s, r->%s, len);\n" name;
10107 pr " s[len] = 0;\n";
10108 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10109 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10111 | name, (FBytes|FUInt64|FInt64) ->
10112 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10113 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10114 | name, (FUInt32|FInt32) ->
10115 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10116 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10117 | name, FOptPercent ->
10118 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10119 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10121 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10122 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10127 and generate_java_struct_list_return typ jtyp cols =
10128 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10129 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10130 pr " for (i = 0; i < r->len; ++i) {\n";
10131 pr " jfl = (*env)->AllocObject (env, cl);\n";
10135 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10136 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10139 pr " char s[33];\n";
10140 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10141 pr " s[32] = 0;\n";
10142 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10143 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10147 pr " int len = r->val[i].%s_len;\n" name;
10148 pr " char s[len+1];\n";
10149 pr " memcpy (s, r->val[i].%s, len);\n" name;
10150 pr " s[len] = 0;\n";
10151 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10152 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10154 | name, (FBytes|FUInt64|FInt64) ->
10155 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10156 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10157 | name, (FUInt32|FInt32) ->
10158 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10159 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10160 | name, FOptPercent ->
10161 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10162 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10164 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10165 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10167 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10169 pr " guestfs_free_%s_list (r);\n" typ;
10172 and generate_java_makefile_inc () =
10173 generate_header HashStyle GPLv2plus;
10175 pr "java_built_sources = \\\n";
10178 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10180 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10182 and generate_haskell_hs () =
10183 generate_header HaskellStyle LGPLv2plus;
10185 (* XXX We only know how to generate partial FFI for Haskell
10186 * at the moment. Please help out!
10188 let can_generate style =
10192 | RInt64 _, _ -> true
10194 | RConstString _, _
10195 | RConstOptString _, _
10201 | RBufferOut _, _ -> false in
10204 {-# INCLUDE <guestfs.h> #-}
10205 {-# LANGUAGE ForeignFunctionInterface #-}
10210 (* List out the names of the actions we want to export. *)
10212 fun (name, style, _, _, _, _, _) ->
10213 if can_generate style then pr ",\n %s" name
10219 -- Unfortunately some symbols duplicate ones already present
10220 -- in Prelude. We don't know which, so we hard-code a list
10222 import Prelude hiding (truncate)
10226 import Foreign.C.Types
10228 import Control.Exception
10229 import Data.Typeable
10231 data GuestfsS = GuestfsS -- represents the opaque C struct
10232 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10233 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10235 -- XXX define properly later XXX
10239 data IntBool = IntBool
10241 data StatVFS = StatVFS
10242 data Hashtable = Hashtable
10244 foreign import ccall unsafe \"guestfs_create\" c_create
10246 foreign import ccall unsafe \"&guestfs_close\" c_close
10247 :: FunPtr (GuestfsP -> IO ())
10248 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10249 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10251 create :: IO GuestfsH
10254 c_set_error_handler p nullPtr nullPtr
10255 h <- newForeignPtr c_close p
10258 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10259 :: GuestfsP -> IO CString
10261 -- last_error :: GuestfsH -> IO (Maybe String)
10262 -- last_error h = do
10263 -- str <- withForeignPtr h (\\p -> c_last_error p)
10264 -- maybePeek peekCString str
10266 last_error :: GuestfsH -> IO (String)
10268 str <- withForeignPtr h (\\p -> c_last_error p)
10269 if (str == nullPtr)
10270 then return \"no error\"
10271 else peekCString str
10275 (* Generate wrappers for each foreign function. *)
10277 fun (name, style, _, _, _, _, _) ->
10278 if can_generate style then (
10279 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10281 generate_haskell_prototype ~handle:"GuestfsP" style;
10285 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10287 pr "%s %s = do\n" name
10288 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10290 (* Convert pointer arguments using with* functions. *)
10295 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
10296 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10297 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10298 | Bool _ | Int _ | Int64 _ -> ()
10300 (* Convert integer arguments. *)
10304 | Bool n -> sprintf "(fromBool %s)" n
10305 | Int n -> sprintf "(fromIntegral %s)" n
10306 | Int64 n -> sprintf "(fromIntegral %s)" n
10307 | FileIn n | FileOut n
10308 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10310 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10311 (String.concat " " ("p" :: args));
10312 (match fst style with
10313 | RErr | RInt _ | RInt64 _ | RBool _ ->
10314 pr " if (r == -1)\n";
10316 pr " err <- last_error h\n";
10318 | RConstString _ | RConstOptString _ | RString _
10319 | RStringList _ | RStruct _
10320 | RStructList _ | RHashtable _ | RBufferOut _ ->
10321 pr " if (r == nullPtr)\n";
10323 pr " err <- last_error h\n";
10326 (match fst style with
10328 pr " else return ()\n"
10330 pr " else return (fromIntegral r)\n"
10332 pr " else return (fromIntegral r)\n"
10334 pr " else return (toBool r)\n"
10336 | RConstOptString _
10343 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10349 and generate_haskell_prototype ~handle ?(hs = false) style =
10350 pr "%s -> " handle;
10351 let string = if hs then "String" else "CString" in
10352 let int = if hs then "Int" else "CInt" in
10353 let bool = if hs then "Bool" else "CInt" in
10354 let int64 = if hs then "Integer" else "Int64" in
10358 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10359 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10360 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10361 | Bool _ -> pr "%s" bool
10362 | Int _ -> pr "%s" int
10363 | Int64 _ -> pr "%s" int
10364 | FileIn _ -> pr "%s" string
10365 | FileOut _ -> pr "%s" string
10370 (match fst style with
10371 | RErr -> if not hs then pr "CInt"
10372 | RInt _ -> pr "%s" int
10373 | RInt64 _ -> pr "%s" int64
10374 | RBool _ -> pr "%s" bool
10375 | RConstString _ -> pr "%s" string
10376 | RConstOptString _ -> pr "Maybe %s" string
10377 | RString _ -> pr "%s" string
10378 | RStringList _ -> pr "[%s]" string
10379 | RStruct (_, typ) ->
10380 let name = java_name_of_struct typ in
10382 | RStructList (_, typ) ->
10383 let name = java_name_of_struct typ in
10385 | RHashtable _ -> pr "Hashtable"
10386 | RBufferOut _ -> pr "%s" string
10390 and generate_csharp () =
10391 generate_header CPlusPlusStyle LGPLv2plus;
10393 (* XXX Make this configurable by the C# assembly users. *)
10394 let library = "libguestfs.so.0" in
10397 // These C# bindings are highly experimental at present.
10399 // Firstly they only work on Linux (ie. Mono). In order to get them
10400 // to work on Windows (ie. .Net) you would need to port the library
10401 // itself to Windows first.
10403 // The second issue is that some calls are known to be incorrect and
10404 // can cause Mono to segfault. Particularly: calls which pass or
10405 // return string[], or return any structure value. This is because
10406 // we haven't worked out the correct way to do this from C#.
10408 // The third issue is that when compiling you get a lot of warnings.
10409 // We are not sure whether the warnings are important or not.
10411 // Fourthly we do not routinely build or test these bindings as part
10412 // of the make && make check cycle, which means that regressions might
10415 // Suggestions and patches are welcome.
10419 // gmcs Libguestfs.cs
10420 // mono Libguestfs.exe
10422 // (You'll probably want to add a Test class / static main function
10423 // otherwise this won't do anything useful).
10427 using System.Runtime.InteropServices;
10428 using System.Runtime.Serialization;
10429 using System.Collections;
10433 class Error : System.ApplicationException
10435 public Error (string message) : base (message) {}
10436 protected Error (SerializationInfo info, StreamingContext context) {}
10443 [DllImport (\"%s\")]
10444 static extern IntPtr guestfs_create ();
10448 _handle = guestfs_create ();
10449 if (_handle == IntPtr.Zero)
10450 throw new Error (\"could not create guestfs handle\");
10453 [DllImport (\"%s\")]
10454 static extern void guestfs_close (IntPtr h);
10458 guestfs_close (_handle);
10461 [DllImport (\"%s\")]
10462 static extern string guestfs_last_error (IntPtr h);
10464 " library library library;
10466 (* Generate C# structure bindings. We prefix struct names with
10467 * underscore because C# cannot have conflicting struct names and
10468 * method names (eg. "class stat" and "stat").
10472 pr " [StructLayout (LayoutKind.Sequential)]\n";
10473 pr " public class _%s {\n" typ;
10476 | name, FChar -> pr " char %s;\n" name
10477 | name, FString -> pr " string %s;\n" name
10479 pr " uint %s_len;\n" name;
10480 pr " string %s;\n" name
10482 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10483 pr " string %s;\n" name
10484 | name, FUInt32 -> pr " uint %s;\n" name
10485 | name, FInt32 -> pr " int %s;\n" name
10486 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10487 | name, FInt64 -> pr " long %s;\n" name
10488 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10494 (* Generate C# function bindings. *)
10496 fun (name, style, _, _, _, shortdesc, _) ->
10497 let rec csharp_return_type () =
10498 match fst style with
10500 | RBool n -> "bool"
10502 | RInt64 n -> "long"
10504 | RConstOptString n
10506 | RBufferOut n -> "string"
10507 | RStruct (_,n) -> "_" ^ n
10508 | RHashtable n -> "Hashtable"
10509 | RStringList n -> "string[]"
10510 | RStructList (_,n) -> sprintf "_%s[]" n
10512 and c_return_type () =
10513 match fst style with
10517 | RInt64 _ -> "long"
10519 | RConstOptString _
10521 | RBufferOut _ -> "string"
10522 | RStruct (_,n) -> "_" ^ n
10524 | RStringList _ -> "string[]"
10525 | RStructList (_,n) -> sprintf "_%s[]" n
10527 and c_error_comparison () =
10528 match fst style with
10532 | RInt64 _ -> "== -1"
10534 | RConstOptString _
10540 | RStructList (_,_) -> "== null"
10542 and generate_extern_prototype () =
10543 pr " static extern %s guestfs_%s (IntPtr h"
10544 (c_return_type ()) name;
10547 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10548 | FileIn n | FileOut n ->
10549 pr ", [In] string %s" n
10550 | StringList n | DeviceList n ->
10551 pr ", [In] string[] %s" n
10561 and generate_public_prototype () =
10562 pr " public %s %s (" (csharp_return_type ()) name;
10563 let comma = ref false in
10565 if !comma then pr ", ";
10570 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10571 | FileIn n | FileOut n ->
10572 next (); pr "string %s" n
10573 | StringList n | DeviceList n ->
10574 next (); pr "string[] %s" n
10576 next (); pr "bool %s" n
10578 next (); pr "int %s" n
10580 next (); pr "long %s" n
10584 and generate_call () =
10585 pr "guestfs_%s (_handle" name;
10586 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10590 pr " [DllImport (\"%s\")]\n" library;
10591 generate_extern_prototype ();
10593 pr " /// <summary>\n";
10594 pr " /// %s\n" shortdesc;
10595 pr " /// </summary>\n";
10596 generate_public_prototype ();
10598 pr " %s r;\n" (c_return_type ());
10601 pr " if (r %s)\n" (c_error_comparison ());
10602 pr " throw new Error (guestfs_last_error (_handle));\n";
10603 (match fst style with
10606 pr " return r != 0 ? true : false;\n"
10608 pr " Hashtable rr = new Hashtable ();\n";
10609 pr " for (size_t i = 0; i < r.Length; i += 2)\n";
10610 pr " rr.Add (r[i], r[i+1]);\n";
10612 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10613 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10619 ) all_functions_sorted;
10625 and generate_bindtests () =
10626 generate_header CStyle LGPLv2plus;
10630 #include <stdlib.h>
10631 #include <inttypes.h>
10632 #include <string.h>
10634 #include \"guestfs.h\"
10635 #include \"guestfs-internal.h\"
10636 #include \"guestfs-internal-actions.h\"
10637 #include \"guestfs_protocol.h\"
10639 #define error guestfs_error
10640 #define safe_calloc guestfs_safe_calloc
10641 #define safe_malloc guestfs_safe_malloc
10644 print_strings (char *const *argv)
10649 for (argc = 0; argv[argc] != NULL; ++argc) {
10650 if (argc > 0) printf (\", \");
10651 printf (\"\\\"%%s\\\"\", argv[argc]);
10656 /* The test0 function prints its parameters to stdout. */
10660 match test_functions with
10661 | [] -> assert false
10662 | test0 :: tests -> test0, tests in
10665 let (name, style, _, _, _, _, _) = test0 in
10666 generate_prototype ~extern:false ~semicolon:false ~newline:true
10667 ~handle:"g" ~prefix:"guestfs__" name style;
10672 | Device n | Dev_or_Path n
10675 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10676 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10677 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10678 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10679 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10680 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10682 pr " /* Java changes stdout line buffering so we need this: */\n";
10683 pr " fflush (stdout);\n";
10689 fun (name, style, _, _, _, _, _) ->
10690 if String.sub name (String.length name - 3) 3 <> "err" then (
10691 pr "/* Test normal return. */\n";
10692 generate_prototype ~extern:false ~semicolon:false ~newline:true
10693 ~handle:"g" ~prefix:"guestfs__" name style;
10695 (match fst style with
10700 pr " sscanf (val, \"%%d\", &r);\n";
10703 pr " int64_t r;\n";
10704 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10707 pr " return STREQ (val, \"true\");\n"
10709 | RConstOptString _ ->
10710 (* Can't return the input string here. Return a static
10711 * string so we ensure we get a segfault if the caller
10712 * tries to free it.
10714 pr " return \"static string\";\n"
10716 pr " return strdup (val);\n"
10718 pr " char **strs;\n";
10720 pr " sscanf (val, \"%%d\", &n);\n";
10721 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10722 pr " for (i = 0; i < n; ++i) {\n";
10723 pr " strs[i] = safe_malloc (g, 16);\n";
10724 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10726 pr " strs[n] = NULL;\n";
10727 pr " return strs;\n"
10728 | RStruct (_, typ) ->
10729 pr " struct guestfs_%s *r;\n" typ;
10730 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10732 | RStructList (_, typ) ->
10733 pr " struct guestfs_%s_list *r;\n" typ;
10734 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10735 pr " sscanf (val, \"%%d\", &r->len);\n";
10736 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10739 pr " char **strs;\n";
10741 pr " sscanf (val, \"%%d\", &n);\n";
10742 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10743 pr " for (i = 0; i < n; ++i) {\n";
10744 pr " strs[i*2] = safe_malloc (g, 16);\n";
10745 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10746 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10747 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10749 pr " strs[n*2] = NULL;\n";
10750 pr " return strs;\n"
10752 pr " return strdup (val);\n"
10757 pr "/* Test error return. */\n";
10758 generate_prototype ~extern:false ~semicolon:false ~newline:true
10759 ~handle:"g" ~prefix:"guestfs__" name style;
10761 pr " error (g, \"error\");\n";
10762 (match fst style with
10763 | RErr | RInt _ | RInt64 _ | RBool _ ->
10765 | RConstString _ | RConstOptString _
10766 | RString _ | RStringList _ | RStruct _
10770 pr " return NULL;\n"
10777 and generate_ocaml_bindtests () =
10778 generate_header OCamlStyle GPLv2plus;
10782 let g = Guestfs.create () in
10786 String.concat " " (
10789 | CallString s -> "\"" ^ s ^ "\""
10790 | CallOptString None -> "None"
10791 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10792 | CallStringList xs ->
10793 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10794 | CallInt i when i >= 0 -> string_of_int i
10795 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10796 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10797 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10798 | CallBool b -> string_of_bool b
10803 generate_lang_bindtests (
10804 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10807 pr "print_endline \"EOF\"\n"
10809 and generate_perl_bindtests () =
10810 pr "#!/usr/bin/perl -w\n";
10811 generate_header HashStyle GPLv2plus;
10818 my $g = Sys::Guestfs->new ();
10822 String.concat ", " (
10825 | CallString s -> "\"" ^ s ^ "\""
10826 | CallOptString None -> "undef"
10827 | CallOptString (Some s) -> sprintf "\"%s\"" s
10828 | CallStringList xs ->
10829 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10830 | CallInt i -> string_of_int i
10831 | CallInt64 i -> Int64.to_string i
10832 | CallBool b -> if b then "1" else "0"
10837 generate_lang_bindtests (
10838 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10841 pr "print \"EOF\\n\"\n"
10843 and generate_python_bindtests () =
10844 generate_header HashStyle GPLv2plus;
10849 g = guestfs.GuestFS ()
10853 String.concat ", " (
10856 | CallString s -> "\"" ^ s ^ "\""
10857 | CallOptString None -> "None"
10858 | CallOptString (Some s) -> sprintf "\"%s\"" s
10859 | CallStringList xs ->
10860 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10861 | CallInt i -> string_of_int i
10862 | CallInt64 i -> Int64.to_string i
10863 | CallBool b -> if b then "1" else "0"
10868 generate_lang_bindtests (
10869 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10872 pr "print \"EOF\"\n"
10874 and generate_ruby_bindtests () =
10875 generate_header HashStyle GPLv2plus;
10880 g = Guestfs::create()
10884 String.concat ", " (
10887 | CallString s -> "\"" ^ s ^ "\""
10888 | CallOptString None -> "nil"
10889 | CallOptString (Some s) -> sprintf "\"%s\"" s
10890 | CallStringList xs ->
10891 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10892 | CallInt i -> string_of_int i
10893 | CallInt64 i -> Int64.to_string i
10894 | CallBool b -> string_of_bool b
10899 generate_lang_bindtests (
10900 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10903 pr "print \"EOF\\n\"\n"
10905 and generate_java_bindtests () =
10906 generate_header CStyle GPLv2plus;
10909 import com.redhat.et.libguestfs.*;
10911 public class Bindtests {
10912 public static void main (String[] argv)
10915 GuestFS g = new GuestFS ();
10919 String.concat ", " (
10922 | CallString s -> "\"" ^ s ^ "\""
10923 | CallOptString None -> "null"
10924 | CallOptString (Some s) -> sprintf "\"%s\"" s
10925 | CallStringList xs ->
10927 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10928 | CallInt i -> string_of_int i
10929 | CallInt64 i -> Int64.to_string i
10930 | CallBool b -> string_of_bool b
10935 generate_lang_bindtests (
10936 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10940 System.out.println (\"EOF\");
10942 catch (Exception exn) {
10943 System.err.println (exn);
10950 and generate_haskell_bindtests () =
10951 generate_header HaskellStyle GPLv2plus;
10954 module Bindtests where
10955 import qualified Guestfs
10958 g <- Guestfs.create
10962 String.concat " " (
10965 | CallString s -> "\"" ^ s ^ "\""
10966 | CallOptString None -> "Nothing"
10967 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10968 | CallStringList xs ->
10969 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10970 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10971 | CallInt i -> string_of_int i
10972 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10973 | CallInt64 i -> Int64.to_string i
10974 | CallBool true -> "True"
10975 | CallBool false -> "False"
10980 generate_lang_bindtests (
10981 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10984 pr " putStrLn \"EOF\"\n"
10986 (* Language-independent bindings tests - we do it this way to
10987 * ensure there is parity in testing bindings across all languages.
10989 and generate_lang_bindtests call =
10990 call "test0" [CallString "abc"; CallOptString (Some "def");
10991 CallStringList []; CallBool false;
10992 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10993 call "test0" [CallString "abc"; CallOptString None;
10994 CallStringList []; CallBool false;
10995 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10996 call "test0" [CallString ""; CallOptString (Some "def");
10997 CallStringList []; CallBool false;
10998 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10999 call "test0" [CallString ""; CallOptString (Some "");
11000 CallStringList []; CallBool false;
11001 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
11002 call "test0" [CallString "abc"; CallOptString (Some "def");
11003 CallStringList ["1"]; CallBool false;
11004 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
11005 call "test0" [CallString "abc"; CallOptString (Some "def");
11006 CallStringList ["1"; "2"]; CallBool false;
11007 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
11008 call "test0" [CallString "abc"; CallOptString (Some "def");
11009 CallStringList ["1"]; CallBool true;
11010 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
11011 call "test0" [CallString "abc"; CallOptString (Some "def");
11012 CallStringList ["1"]; CallBool false;
11013 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
11014 call "test0" [CallString "abc"; CallOptString (Some "def");
11015 CallStringList ["1"]; CallBool false;
11016 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
11017 call "test0" [CallString "abc"; CallOptString (Some "def");
11018 CallStringList ["1"]; CallBool false;
11019 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
11020 call "test0" [CallString "abc"; CallOptString (Some "def");
11021 CallStringList ["1"]; CallBool false;
11022 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
11023 call "test0" [CallString "abc"; CallOptString (Some "def");
11024 CallStringList ["1"]; CallBool false;
11025 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
11026 call "test0" [CallString "abc"; CallOptString (Some "def");
11027 CallStringList ["1"]; CallBool false;
11028 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
11030 (* XXX Add here tests of the return and error functions. *)
11032 (* Code to generator bindings for virt-inspector. Currently only
11033 * implemented for OCaml code (for virt-p2v 2.0).
11035 let rng_input = "inspector/virt-inspector.rng"
11037 (* Read the input file and parse it into internal structures. This is
11038 * by no means a complete RELAX NG parser, but is just enough to be
11039 * able to parse the specific input file.
11042 | Element of string * rng list (* <element name=name/> *)
11043 | Attribute of string * rng list (* <attribute name=name/> *)
11044 | Interleave of rng list (* <interleave/> *)
11045 | ZeroOrMore of rng (* <zeroOrMore/> *)
11046 | OneOrMore of rng (* <oneOrMore/> *)
11047 | Optional of rng (* <optional/> *)
11048 | Choice of string list (* <choice><value/>*</choice> *)
11049 | Value of string (* <value>str</value> *)
11050 | Text (* <text/> *)
11052 let rec string_of_rng = function
11053 | Element (name, xs) ->
11054 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11055 | Attribute (name, xs) ->
11056 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11057 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11058 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11059 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11060 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11061 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11062 | Value value -> "Value \"" ^ value ^ "\""
11065 and string_of_rng_list xs =
11066 String.concat ", " (List.map string_of_rng xs)
11068 let rec parse_rng ?defines context = function
11070 | Xml.Element ("element", ["name", name], children) :: rest ->
11071 Element (name, parse_rng ?defines context children)
11072 :: parse_rng ?defines context rest
11073 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11074 Attribute (name, parse_rng ?defines context children)
11075 :: parse_rng ?defines context rest
11076 | Xml.Element ("interleave", [], children) :: rest ->
11077 Interleave (parse_rng ?defines context children)
11078 :: parse_rng ?defines context rest
11079 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11080 let rng = parse_rng ?defines context [child] in
11082 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11084 failwithf "%s: <zeroOrMore> contains more than one child element"
11087 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11088 let rng = parse_rng ?defines context [child] in
11090 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11092 failwithf "%s: <oneOrMore> contains more than one child element"
11095 | Xml.Element ("optional", [], [child]) :: rest ->
11096 let rng = parse_rng ?defines context [child] in
11098 | [child] -> Optional child :: parse_rng ?defines context rest
11100 failwithf "%s: <optional> contains more than one child element"
11103 | Xml.Element ("choice", [], children) :: rest ->
11104 let values = List.map (
11105 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11107 failwithf "%s: can't handle anything except <value> in <choice>"
11111 :: parse_rng ?defines context rest
11112 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11113 Value value :: parse_rng ?defines context rest
11114 | Xml.Element ("text", [], []) :: rest ->
11115 Text :: parse_rng ?defines context rest
11116 | Xml.Element ("ref", ["name", name], []) :: rest ->
11117 (* Look up the reference. Because of limitations in this parser,
11118 * we can't handle arbitrarily nested <ref> yet. You can only
11119 * use <ref> from inside <start>.
11121 (match defines with
11123 failwithf "%s: contains <ref>, but no refs are defined yet" context
11125 let rng = StringMap.find name map in
11126 rng @ parse_rng ?defines context rest
11129 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11132 let xml = Xml.parse_file rng_input in
11134 | Xml.Element ("grammar", _,
11135 Xml.Element ("start", _, gram) :: defines) ->
11136 (* The <define/> elements are referenced in the <start> section,
11137 * so build a map of those first.
11139 let defines = List.fold_left (
11141 function Xml.Element ("define", ["name", name], defn) ->
11142 StringMap.add name defn map
11144 failwithf "%s: expected <define name=name/>" rng_input
11145 ) StringMap.empty defines in
11146 let defines = StringMap.mapi parse_rng defines in
11148 (* Parse the <start> clause, passing the defines. *)
11149 parse_rng ~defines "<start>" gram
11151 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11154 let name_of_field = function
11155 | Element (name, _) | Attribute (name, _)
11156 | ZeroOrMore (Element (name, _))
11157 | OneOrMore (Element (name, _))
11158 | Optional (Element (name, _)) -> name
11159 | Optional (Attribute (name, _)) -> name
11160 | Text -> (* an unnamed field in an element *)
11163 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11165 (* At the moment this function only generates OCaml types. However we
11166 * should parameterize it later so it can generate types/structs in a
11167 * variety of languages.
11169 let generate_types xs =
11170 (* A simple type is one that can be printed out directly, eg.
11171 * "string option". A complex type is one which has a name and has
11172 * to be defined via another toplevel definition, eg. a struct.
11174 * generate_type generates code for either simple or complex types.
11175 * In the simple case, it returns the string ("string option"). In
11176 * the complex case, it returns the name ("mountpoint"). In the
11177 * complex case it has to print out the definition before returning,
11178 * so it should only be called when we are at the beginning of a
11179 * new line (BOL context).
11181 let rec generate_type = function
11182 | Text -> (* string *)
11184 | Choice values -> (* [`val1|`val2|...] *)
11185 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11186 | ZeroOrMore rng -> (* <rng> list *)
11187 let t, is_simple = generate_type rng in
11188 t ^ " list (* 0 or more *)", is_simple
11189 | OneOrMore rng -> (* <rng> list *)
11190 let t, is_simple = generate_type rng in
11191 t ^ " list (* 1 or more *)", is_simple
11192 (* virt-inspector hack: bool *)
11193 | Optional (Attribute (name, [Value "1"])) ->
11195 | Optional rng -> (* <rng> list *)
11196 let t, is_simple = generate_type rng in
11197 t ^ " option", is_simple
11198 (* type name = { fields ... } *)
11199 | Element (name, fields) when is_attrs_interleave fields ->
11200 generate_type_struct name (get_attrs_interleave fields)
11201 | Element (name, [field]) (* type name = field *)
11202 | Attribute (name, [field]) ->
11203 let t, is_simple = generate_type field in
11204 if is_simple then (t, true)
11206 pr "type %s = %s\n" name t;
11209 | Element (name, fields) -> (* type name = { fields ... } *)
11210 generate_type_struct name fields
11212 failwithf "generate_type failed at: %s" (string_of_rng rng)
11214 and is_attrs_interleave = function
11215 | [Interleave _] -> true
11216 | Attribute _ :: fields -> is_attrs_interleave fields
11217 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11220 and get_attrs_interleave = function
11221 | [Interleave fields] -> fields
11222 | ((Attribute _) as field) :: fields
11223 | ((Optional (Attribute _)) as field) :: fields ->
11224 field :: get_attrs_interleave fields
11225 | _ -> assert false
11227 and generate_types xs =
11228 List.iter (fun x -> ignore (generate_type x)) xs
11230 and generate_type_struct name fields =
11231 (* Calculate the types of the fields first. We have to do this
11232 * before printing anything so we are still in BOL context.
11234 let types = List.map fst (List.map generate_type fields) in
11236 (* Special case of a struct containing just a string and another
11237 * field. Turn it into an assoc list.
11240 | ["string"; other] ->
11241 let fname1, fname2 =
11243 | [f1; f2] -> name_of_field f1, name_of_field f2
11244 | _ -> assert false in
11245 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11249 pr "type %s = {\n" name;
11251 fun (field, ftype) ->
11252 let fname = name_of_field field in
11253 pr " %s_%s : %s;\n" name fname ftype
11254 ) (List.combine fields types);
11256 (* Return the name of this type, and
11257 * false because it's not a simple type.
11264 let generate_parsers xs =
11265 (* As for generate_type above, generate_parser makes a parser for
11266 * some type, and returns the name of the parser it has generated.
11267 * Because it (may) need to print something, it should always be
11268 * called in BOL context.
11270 let rec generate_parser = function
11271 | Text -> (* string *)
11272 "string_child_or_empty"
11273 | Choice values -> (* [`val1|`val2|...] *)
11274 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11276 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11277 | ZeroOrMore rng -> (* <rng> list *)
11278 let pa = generate_parser rng in
11279 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11280 | OneOrMore rng -> (* <rng> list *)
11281 let pa = generate_parser rng in
11282 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11283 (* virt-inspector hack: bool *)
11284 | Optional (Attribute (name, [Value "1"])) ->
11285 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11286 | Optional rng -> (* <rng> list *)
11287 let pa = generate_parser rng in
11288 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11289 (* type name = { fields ... } *)
11290 | Element (name, fields) when is_attrs_interleave fields ->
11291 generate_parser_struct name (get_attrs_interleave fields)
11292 | Element (name, [field]) -> (* type name = field *)
11293 let pa = generate_parser field in
11294 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11295 pr "let %s =\n" parser_name;
11297 pr "let parse_%s = %s\n" name parser_name;
11299 | Attribute (name, [field]) ->
11300 let pa = generate_parser field in
11301 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11302 pr "let %s =\n" parser_name;
11304 pr "let parse_%s = %s\n" name parser_name;
11306 | Element (name, fields) -> (* type name = { fields ... } *)
11307 generate_parser_struct name ([], fields)
11309 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11311 and is_attrs_interleave = function
11312 | [Interleave _] -> true
11313 | Attribute _ :: fields -> is_attrs_interleave fields
11314 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11317 and get_attrs_interleave = function
11318 | [Interleave fields] -> [], fields
11319 | ((Attribute _) as field) :: fields
11320 | ((Optional (Attribute _)) as field) :: fields ->
11321 let attrs, interleaves = get_attrs_interleave fields in
11322 (field :: attrs), interleaves
11323 | _ -> assert false
11325 and generate_parsers xs =
11326 List.iter (fun x -> ignore (generate_parser x)) xs
11328 and generate_parser_struct name (attrs, interleaves) =
11329 (* Generate parsers for the fields first. We have to do this
11330 * before printing anything so we are still in BOL context.
11332 let fields = attrs @ interleaves in
11333 let pas = List.map generate_parser fields in
11335 (* Generate an intermediate tuple from all the fields first.
11336 * If the type is just a string + another field, then we will
11337 * return this directly, otherwise it is turned into a record.
11339 * RELAX NG note: This code treats <interleave> and plain lists of
11340 * fields the same. In other words, it doesn't bother enforcing
11341 * any ordering of fields in the XML.
11343 pr "let parse_%s x =\n" name;
11344 pr " let t = (\n ";
11345 let comma = ref false in
11348 if !comma then pr ",\n ";
11351 | Optional (Attribute (fname, [field])), pa ->
11353 | Optional (Element (fname, [field])), pa ->
11354 pr "%s (optional_child %S x)" pa fname
11355 | Attribute (fname, [Text]), _ ->
11356 pr "attribute %S x" fname
11357 | (ZeroOrMore _ | OneOrMore _), pa ->
11362 let fname = name_of_field field in
11363 pr "%s (child %S x)" pa fname
11364 ) (List.combine fields pas);
11368 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11372 pr " (Obj.magic t : %s)\n" name
11376 | (Optional (Attribute (fname, [field])), pa) ->
11377 pr " %s_%s =\n" name fname;
11379 | (Optional (Element (fname, [field])), pa) ->
11380 pr " %s_%s =\n" name fname;
11381 pr " (let x = optional_child %S x in\n" fname;
11384 let fname = name_of_field field in
11385 pr " %s_%s =\n" name fname;
11386 pr " (let x = child %S x in\n" fname;
11388 ) (List.combine fields pas);
11392 sprintf "parse_%s" name
11395 generate_parsers xs
11397 (* Generate ocaml/guestfs_inspector.mli. *)
11398 let generate_ocaml_inspector_mli () =
11399 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11402 (** This is an OCaml language binding to the external [virt-inspector]
11405 For more information, please read the man page [virt-inspector(1)].
11410 generate_types grammar;
11411 pr "(** The nested information returned from the {!inspect} function. *)\n";
11415 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11416 (** To inspect a libvirt domain called [name], pass a singleton
11417 list: [inspect [name]]. When using libvirt only, you may
11418 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11420 To inspect a disk image or images, pass a list of the filenames
11421 of the disk images: [inspect filenames]
11423 This function inspects the given guest or disk images and
11424 returns a list of operating system(s) found and a large amount
11425 of information about them. In the vast majority of cases,
11426 a virtual machine only contains a single operating system.
11428 If the optional [~xml] parameter is given, then this function
11429 skips running the external virt-inspector program and just
11430 parses the given XML directly (which is expected to be XML
11431 produced from a previous run of virt-inspector). The list of
11432 names and connect URI are ignored in this case.
11434 This function can throw a wide variety of exceptions, for example
11435 if the external virt-inspector program cannot be found, or if
11436 it doesn't generate valid XML.
11440 (* Generate ocaml/guestfs_inspector.ml. *)
11441 let generate_ocaml_inspector_ml () =
11442 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11447 generate_types grammar;
11451 (* Misc functions which are used by the parser code below. *)
11452 let first_child = function
11453 | Xml.Element (_, _, c::_) -> c
11454 | Xml.Element (name, _, []) ->
11455 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11456 | Xml.PCData str ->
11457 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11459 let string_child_or_empty = function
11460 | Xml.Element (_, _, [Xml.PCData s]) -> s
11461 | Xml.Element (_, _, []) -> \"\"
11462 | Xml.Element (x, _, _) ->
11463 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11465 | Xml.PCData str ->
11466 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11468 let optional_child name xml =
11469 let children = Xml.children xml in
11471 Some (List.find (function
11472 | Xml.Element (n, _, _) when n = name -> true
11473 | _ -> false) children)
11477 let child name xml =
11478 match optional_child name xml with
11481 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11483 let attribute name xml =
11484 try Xml.attrib xml name
11485 with Xml.No_attribute _ ->
11486 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11490 generate_parsers grammar;
11494 (* Run external virt-inspector, then use parser to parse the XML. *)
11495 let inspect ?connect ?xml names =
11499 if names = [] then invalid_arg \"inspect: no names given\";
11500 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11501 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11503 let cmd = List.map Filename.quote cmd in
11504 let cmd = String.concat \" \" cmd in
11505 let chan = open_process_in cmd in
11506 let xml = Xml.parse_in chan in
11507 (match close_process_in chan with
11509 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11510 | WSIGNALED i | WSTOPPED i ->
11511 failwith (\"external virt-inspector command died or stopped on sig \" ^
11516 Xml.parse_string doc in
11517 parse_operatingsystems xml
11520 (* This is used to generate the src/MAX_PROC_NR file which
11521 * contains the maximum procedure number, a surrogate for the
11522 * ABI version number. See src/Makefile.am for the details.
11524 and generate_max_proc_nr () =
11525 let proc_nrs = List.map (
11526 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11527 ) daemon_functions in
11529 let max_proc_nr = List.fold_left max 0 proc_nrs in
11531 pr "%d\n" max_proc_nr
11533 let output_to filename k =
11534 let filename_new = filename ^ ".new" in
11535 chan := open_out filename_new;
11538 chan := Pervasives.stdout;
11540 (* Is the new file different from the current file? *)
11541 if Sys.file_exists filename && files_equal filename filename_new then
11542 unlink filename_new (* same, so skip it *)
11544 (* different, overwrite old one *)
11545 (try chmod filename 0o644 with Unix_error _ -> ());
11546 rename filename_new filename;
11547 chmod filename 0o444;
11548 printf "written %s\n%!" filename;
11551 let perror msg = function
11552 | Unix_error (err, _, _) ->
11553 eprintf "%s: %s\n" msg (error_message err)
11555 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11557 (* Main program. *)
11560 try openfile "HACKING" [O_RDWR] 0
11562 | Unix_error (ENOENT, _, _) ->
11564 You are probably running this from the wrong directory.
11565 Run it from the top source directory using the command
11570 perror "open: HACKING" exn;
11573 (* Acquire a lock so parallel builds won't try to run the generator
11574 * twice at the same time. Subsequent builds will wait for the first
11575 * one to finish. Note the lock is released implicitly when the
11578 (try lockf lock_fd F_LOCK 1
11580 perror "lock: HACKING" exn;
11583 check_functions ();
11585 output_to "src/guestfs_protocol.x" generate_xdr;
11586 output_to "src/guestfs-structs.h" generate_structs_h;
11587 output_to "src/guestfs-actions.h" generate_actions_h;
11588 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11589 output_to "src/guestfs-actions.c" generate_client_actions;
11590 output_to "src/guestfs-bindtests.c" generate_bindtests;
11591 output_to "src/guestfs-structs.pod" generate_structs_pod;
11592 output_to "src/guestfs-actions.pod" generate_actions_pod;
11593 output_to "src/guestfs-availability.pod" generate_availability_pod;
11594 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11595 output_to "src/libguestfs.syms" generate_linker_script;
11596 output_to "daemon/actions.h" generate_daemon_actions_h;
11597 output_to "daemon/stubs.c" generate_daemon_actions;
11598 output_to "daemon/names.c" generate_daemon_names;
11599 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11600 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11601 output_to "capitests/tests.c" generate_tests;
11602 output_to "fish/cmds.c" generate_fish_cmds;
11603 output_to "fish/completion.c" generate_fish_completion;
11604 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11605 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11606 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11607 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11608 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11609 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11610 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11611 output_to "perl/Guestfs.xs" generate_perl_xs;
11612 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11613 output_to "perl/bindtests.pl" generate_perl_bindtests;
11614 output_to "python/guestfs-py.c" generate_python_c;
11615 output_to "python/guestfs.py" generate_python_py;
11616 output_to "python/bindtests.py" generate_python_bindtests;
11617 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11618 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11619 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11623 let cols = cols_of_struct typ in
11624 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11625 output_to filename (generate_java_struct jtyp cols);
11628 output_to "java/Makefile.inc" generate_java_makefile_inc;
11629 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11630 output_to "java/Bindtests.java" generate_java_bindtests;
11631 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11632 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11633 output_to "csharp/Libguestfs.cs" generate_csharp;
11635 (* Always generate this file last, and unconditionally. It's used
11636 * by the Makefile to know when we must re-run the generator.
11638 let chan = open_out "src/stamp-generator" in
11639 fprintf chan "1\n";
11642 printf "generated %d lines of code\n" !lines