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 (* Some initial scenarios for testing. *)
312 (* Do nothing, block devices could contain random stuff including
313 * LVM PVs, and some filesystems might be mounted. This is usually
318 (* Block devices are empty and no filesystems are mounted. *)
321 (* /dev/sda contains a single partition /dev/sda1, with random
322 * content. /dev/sdb and /dev/sdc may have random content.
327 (* /dev/sda contains a single partition /dev/sda1, which is formatted
328 * as ext2, empty [except for lost+found] and mounted on /.
329 * /dev/sdb and /dev/sdc may have random content.
335 * /dev/sda1 (is a PV):
336 * /dev/VG/LV (size 8MB):
337 * formatted as ext2, empty [except for lost+found], mounted on /
338 * /dev/sdb and /dev/sdc may have random content.
342 (* /dev/sdd (the ISO, see images/ directory in source)
347 (* Sequence of commands for testing. *)
349 and cmd = string list
351 (* Note about long descriptions: When referring to another
352 * action, use the format C<guestfs_other> (ie. the full name of
353 * the C function). This will be replaced as appropriate in other
356 * Apart from that, long descriptions are just perldoc paragraphs.
359 (* Generate a random UUID (used in tests). *)
361 let chan = open_process_in "uuidgen" in
362 let uuid = input_line chan in
363 (match close_process_in chan with
366 failwith "uuidgen: process exited with non-zero status"
367 | WSIGNALED _ | WSTOPPED _ ->
368 failwith "uuidgen: process signalled or stopped by signal"
372 (* These test functions are used in the language binding tests. *)
374 let test_all_args = [
377 StringList "strlist";
385 let test_all_rets = [
386 (* except for RErr, which is tested thoroughly elsewhere *)
387 "test0rint", RInt "valout";
388 "test0rint64", RInt64 "valout";
389 "test0rbool", RBool "valout";
390 "test0rconststring", RConstString "valout";
391 "test0rconstoptstring", RConstOptString "valout";
392 "test0rstring", RString "valout";
393 "test0rstringlist", RStringList "valout";
394 "test0rstruct", RStruct ("valout", "lvm_pv");
395 "test0rstructlist", RStructList ("valout", "lvm_pv");
396 "test0rhashtable", RHashtable "valout";
399 let test_functions = [
400 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
402 "internal test function - do not use",
404 This is an internal test function which is used to test whether
405 the automatically generated bindings can handle every possible
406 parameter type correctly.
408 It echos the contents of each parameter to stdout.
410 You probably don't want to call this function.");
414 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
416 "internal test function - do not use",
418 This is an internal test function which is used to test whether
419 the automatically generated bindings can handle every possible
420 return type correctly.
422 It converts string C<val> to the return type.
424 You probably don't want to call this function.");
425 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
427 "internal test function - do not use",
429 This is an internal test function which is used to test whether
430 the automatically generated bindings can handle every possible
431 return type correctly.
433 This function always returns an error.
435 You probably don't want to call this function.")]
439 (* non_daemon_functions are any functions which don't get processed
440 * in the daemon, eg. functions for setting and getting local
441 * configuration values.
444 let non_daemon_functions = test_functions @ [
445 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
447 "launch the qemu subprocess",
449 Internally libguestfs is implemented by running a virtual machine
452 You should call this after configuring the handle
453 (eg. adding drives) but before performing any actions.");
455 ("wait_ready", (RErr, []), -1, [NotInFish],
457 "wait until the qemu subprocess launches (no op)",
459 This function is a no op.
461 In versions of the API E<lt> 1.0.71 you had to call this function
462 just after calling C<guestfs_launch> to wait for the launch
463 to complete. However this is no longer necessary because
464 C<guestfs_launch> now does the waiting.
466 If you see any calls to this function in code then you can just
467 remove them, unless you want to retain compatibility with older
468 versions of the API.");
470 ("kill_subprocess", (RErr, []), -1, [],
472 "kill the qemu subprocess",
474 This kills the qemu subprocess. You should never need to call this.");
476 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
478 "add an image to examine or modify",
480 This function adds a virtual machine disk image C<filename> to the
481 guest. The first time you call this function, the disk appears as IDE
482 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
485 You don't necessarily need to be root when using libguestfs. However
486 you obviously do need sufficient permissions to access the filename
487 for whatever operations you want to perform (ie. read access if you
488 just want to read the image or write access if you want to modify the
491 This is equivalent to the qemu parameter
492 C<-drive file=filename,cache=off,if=...>.
494 C<cache=off> is omitted in cases where it is not supported by
495 the underlying filesystem.
497 C<if=...> is set at compile time by the configuration option
498 C<./configure --with-drive-if=...>. In the rare case where you
499 might need to change this at run time, use C<guestfs_add_drive_with_if>
500 or C<guestfs_add_drive_ro_with_if>.
502 Note that this call checks for the existence of C<filename>. This
503 stops you from specifying other types of drive which are supported
504 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
505 the general C<guestfs_config> call instead.");
507 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
509 "add a CD-ROM disk image to examine",
511 This function adds a virtual CD-ROM disk image to the guest.
513 This is equivalent to the qemu parameter C<-cdrom filename>.
521 This call checks for the existence of C<filename>. This
522 stops you from specifying other types of drive which are supported
523 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
524 the general C<guestfs_config> call instead.
528 If you just want to add an ISO file (often you use this as an
529 efficient way to transfer large files into the guest), then you
530 should probably use C<guestfs_add_drive_ro> instead.
534 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
536 "add a drive in snapshot mode (read-only)",
538 This adds a drive in snapshot mode, making it effectively
541 Note that writes to the device are allowed, and will be seen for
542 the duration of the guestfs handle, but they are written
543 to a temporary file which is discarded as soon as the guestfs
544 handle is closed. We don't currently have any method to enable
545 changes to be committed, although qemu can support this.
547 This is equivalent to the qemu parameter
548 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
550 C<if=...> is set at compile time by the configuration option
551 C<./configure --with-drive-if=...>. In the rare case where you
552 might need to change this at run time, use C<guestfs_add_drive_with_if>
553 or C<guestfs_add_drive_ro_with_if>.
555 C<readonly=on> is only added where qemu supports this option.
557 Note that this call checks for the existence of C<filename>. This
558 stops you from specifying other types of drive which are supported
559 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
560 the general C<guestfs_config> call instead.");
562 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
564 "add qemu parameters",
566 This can be used to add arbitrary qemu command line parameters
567 of the form C<-param value>. Actually it's not quite arbitrary - we
568 prevent you from setting some parameters which would interfere with
569 parameters that we use.
571 The first character of C<param> string must be a C<-> (dash).
573 C<value> can be NULL.");
575 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
577 "set the qemu binary",
579 Set the qemu binary that we will use.
581 The default is chosen when the library was compiled by the
584 You can also override this by setting the C<LIBGUESTFS_QEMU>
585 environment variable.
587 Setting C<qemu> to C<NULL> restores the default qemu binary.
589 Note that you should call this function as early as possible
590 after creating the handle. This is because some pre-launch
591 operations depend on testing qemu features (by running C<qemu -help>).
592 If the qemu binary changes, we don't retest features, and
593 so you might see inconsistent results. Using the environment
594 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
595 the qemu binary at the same time as the handle is created.");
597 ("get_qemu", (RConstString "qemu", []), -1, [],
598 [InitNone, Always, TestRun (
600 "get the qemu binary",
602 Return the current qemu binary.
604 This is always non-NULL. If it wasn't set already, then this will
605 return the default qemu binary name.");
607 ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
609 "set the search path",
611 Set the path that libguestfs searches for kernel and initrd.img.
613 The default is C<$libdir/guestfs> unless overridden by setting
614 C<LIBGUESTFS_PATH> environment variable.
616 Setting C<path> to C<NULL> restores the default path.");
618 ("get_path", (RConstString "path", []), -1, [],
619 [InitNone, Always, TestRun (
621 "get the search path",
623 Return the current search path.
625 This is always non-NULL. If it wasn't set already, then this will
626 return the default path.");
628 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
630 "add options to kernel command line",
632 This function is used to add additional options to the
633 guest kernel command line.
635 The default is C<NULL> unless overridden by setting
636 C<LIBGUESTFS_APPEND> environment variable.
638 Setting C<append> to C<NULL> means I<no> additional options
639 are passed (libguestfs always adds a few of its own).");
641 ("get_append", (RConstOptString "append", []), -1, [],
642 (* This cannot be tested with the current framework. The
643 * function can return NULL in normal operations, which the
644 * test framework interprets as an error.
647 "get the additional kernel options",
649 Return the additional kernel options which are added to the
650 guest kernel command line.
652 If C<NULL> then no options are added.");
654 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
658 If C<autosync> is true, this enables autosync. Libguestfs will make a
659 best effort attempt to run C<guestfs_umount_all> followed by
660 C<guestfs_sync> when the handle is closed
661 (also if the program exits without closing handles).
663 This is disabled by default (except in guestfish where it is
664 enabled by default).");
666 ("get_autosync", (RBool "autosync", []), -1, [],
667 [InitNone, Always, TestRun (
668 [["get_autosync"]])],
671 Get the autosync flag.");
673 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
677 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
679 Verbose messages are disabled unless the environment variable
680 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
682 ("get_verbose", (RBool "verbose", []), -1, [],
686 This returns the verbose messages flag.");
688 ("is_ready", (RBool "ready", []), -1, [],
689 [InitNone, Always, TestOutputTrue (
691 "is ready to accept commands",
693 This returns true iff this handle is ready to accept commands
694 (in the C<READY> state).
696 For more information on states, see L<guestfs(3)>.");
698 ("is_config", (RBool "config", []), -1, [],
699 [InitNone, Always, TestOutputFalse (
701 "is in configuration state",
703 This returns true iff this handle is being configured
704 (in the C<CONFIG> state).
706 For more information on states, see L<guestfs(3)>.");
708 ("is_launching", (RBool "launching", []), -1, [],
709 [InitNone, Always, TestOutputFalse (
710 [["is_launching"]])],
711 "is launching subprocess",
713 This returns true iff this handle is launching the subprocess
714 (in the C<LAUNCHING> state).
716 For more information on states, see L<guestfs(3)>.");
718 ("is_busy", (RBool "busy", []), -1, [],
719 [InitNone, Always, TestOutputFalse (
721 "is busy processing a command",
723 This returns true iff this handle is busy processing a command
724 (in the C<BUSY> state).
726 For more information on states, see L<guestfs(3)>.");
728 ("get_state", (RInt "state", []), -1, [],
730 "get the current state",
732 This returns the current state as an opaque integer. This is
733 only useful for printing debug and internal error messages.
735 For more information on states, see L<guestfs(3)>.");
737 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
738 [InitNone, Always, TestOutputInt (
739 [["set_memsize"; "500"];
740 ["get_memsize"]], 500)],
741 "set memory allocated to the qemu subprocess",
743 This sets the memory size in megabytes allocated to the
744 qemu subprocess. This only has any effect if called before
747 You can also change this by setting the environment
748 variable C<LIBGUESTFS_MEMSIZE> before the handle is
751 For more information on the architecture of libguestfs,
752 see L<guestfs(3)>.");
754 ("get_memsize", (RInt "memsize", []), -1, [],
755 [InitNone, Always, TestOutputIntOp (
756 [["get_memsize"]], ">=", 256)],
757 "get memory allocated to the qemu subprocess",
759 This gets the memory size in megabytes allocated to the
762 If C<guestfs_set_memsize> was not called
763 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
764 then this returns the compiled-in default value for memsize.
766 For more information on the architecture of libguestfs,
767 see L<guestfs(3)>.");
769 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
770 [InitNone, Always, TestOutputIntOp (
771 [["get_pid"]], ">=", 1)],
772 "get PID of qemu subprocess",
774 Return the process ID of the qemu subprocess. If there is no
775 qemu subprocess, then this will return an error.
777 This is an internal call used for debugging and testing.");
779 ("version", (RStruct ("version", "version"), []), -1, [],
780 [InitNone, Always, TestOutputStruct (
781 [["version"]], [CompareWithInt ("major", 1)])],
782 "get the library version number",
784 Return the libguestfs version number that the program is linked
787 Note that because of dynamic linking this is not necessarily
788 the version of libguestfs that you compiled against. You can
789 compile the program, and then at runtime dynamically link
790 against a completely different C<libguestfs.so> library.
792 This call was added in version C<1.0.58>. In previous
793 versions of libguestfs there was no way to get the version
794 number. From C code you can use ELF weak linking tricks to find out if
795 this symbol exists (if it doesn't, then it's an earlier version).
797 The call returns a structure with four elements. The first
798 three (C<major>, C<minor> and C<release>) are numbers and
799 correspond to the usual version triplet. The fourth element
800 (C<extra>) is a string and is normally empty, but may be
801 used for distro-specific information.
803 To construct the original version string:
804 C<$major.$minor.$release$extra>
806 I<Note:> Don't use this call to test for availability
807 of features. Distro backports makes this unreliable. Use
808 C<guestfs_available> instead.");
810 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
811 [InitNone, Always, TestOutputTrue (
812 [["set_selinux"; "true"];
814 "set SELinux enabled or disabled at appliance boot",
816 This sets the selinux flag that is passed to the appliance
817 at boot time. The default is C<selinux=0> (disabled).
819 Note that if SELinux is enabled, it is always in
820 Permissive mode (C<enforcing=0>).
822 For more information on the architecture of libguestfs,
823 see L<guestfs(3)>.");
825 ("get_selinux", (RBool "selinux", []), -1, [],
827 "get SELinux enabled flag",
829 This returns the current setting of the selinux flag which
830 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
832 For more information on the architecture of libguestfs,
833 see L<guestfs(3)>.");
835 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
836 [InitNone, Always, TestOutputFalse (
837 [["set_trace"; "false"];
839 "enable or disable command traces",
841 If the command trace flag is set to 1, then commands are
842 printed on stdout before they are executed in a format
843 which is very similar to the one used by guestfish. In
844 other words, you can run a program with this enabled, and
845 you will get out a script which you can feed to guestfish
846 to perform the same set of actions.
848 If you want to trace C API calls into libguestfs (and
849 other libraries) then possibly a better way is to use
850 the external ltrace(1) command.
852 Command traces are disabled unless the environment variable
853 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
855 ("get_trace", (RBool "trace", []), -1, [],
857 "get command trace enabled flag",
859 Return the command trace flag.");
861 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
862 [InitNone, Always, TestOutputFalse (
863 [["set_direct"; "false"];
865 "enable or disable direct appliance mode",
867 If the direct appliance mode flag is enabled, then stdin and
868 stdout are passed directly through to the appliance once it
871 One consequence of this is that log messages aren't caught
872 by the library and handled by C<guestfs_set_log_message_callback>,
873 but go straight to stdout.
875 You probably don't want to use this unless you know what you
878 The default is disabled.");
880 ("get_direct", (RBool "direct", []), -1, [],
882 "get direct appliance mode flag",
884 Return the direct appliance mode flag.");
886 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
887 [InitNone, Always, TestOutputTrue (
888 [["set_recovery_proc"; "true"];
889 ["get_recovery_proc"]])],
890 "enable or disable the recovery process",
892 If this is called with the parameter C<false> then
893 C<guestfs_launch> does not create a recovery process. The
894 purpose of the recovery process is to stop runaway qemu
895 processes in the case where the main program aborts abruptly.
897 This only has any effect if called before C<guestfs_launch>,
898 and the default is true.
900 About the only time when you would want to disable this is
901 if the main process will fork itself into the background
902 (\"daemonize\" itself). In this case the recovery process
903 thinks that the main program has disappeared and so kills
904 qemu, which is not very helpful.");
906 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
908 "get recovery process enabled flag",
910 Return the recovery process enabled flag.");
912 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
914 "add a drive specifying the QEMU block emulation to use",
916 This is the same as C<guestfs_add_drive> but it allows you
917 to specify the QEMU interface emulation to use at run time.");
919 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
921 "add a drive read-only specifying the QEMU block emulation to use",
923 This is the same as C<guestfs_add_drive_ro> but it allows you
924 to specify the QEMU interface emulation to use at run time.");
928 (* daemon_functions are any functions which cause some action
929 * to take place in the daemon.
932 let daemon_functions = [
933 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
934 [InitEmpty, Always, TestOutput (
935 [["part_disk"; "/dev/sda"; "mbr"];
936 ["mkfs"; "ext2"; "/dev/sda1"];
937 ["mount"; "/dev/sda1"; "/"];
938 ["write_file"; "/new"; "new file contents"; "0"];
939 ["cat"; "/new"]], "new file contents")],
940 "mount a guest disk at a position in the filesystem",
942 Mount a guest disk at a position in the filesystem. Block devices
943 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
944 the guest. If those block devices contain partitions, they will have
945 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
948 The rules are the same as for L<mount(2)>: A filesystem must
949 first be mounted on C</> before others can be mounted. Other
950 filesystems can only be mounted on directories which already
953 The mounted filesystem is writable, if we have sufficient permissions
954 on the underlying device.
956 The filesystem options C<sync> and C<noatime> are set with this
957 call, in order to improve reliability.");
959 ("sync", (RErr, []), 2, [],
960 [ InitEmpty, Always, TestRun [["sync"]]],
961 "sync disks, writes are flushed through to the disk image",
963 This syncs the disk, so that any writes are flushed through to the
964 underlying disk image.
966 You should always call this if you have modified a disk image, before
967 closing the handle.");
969 ("touch", (RErr, [Pathname "path"]), 3, [],
970 [InitBasicFS, Always, TestOutputTrue (
972 ["exists"; "/new"]])],
973 "update file timestamps or create a new file",
975 Touch acts like the L<touch(1)> command. It can be used to
976 update the timestamps on a file, or, if the file does not exist,
977 to create a new zero-length file.");
979 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
980 [InitISOFS, Always, TestOutput (
981 [["cat"; "/known-2"]], "abcdef\n")],
982 "list the contents of a file",
984 Return the contents of the file named C<path>.
986 Note that this function cannot correctly handle binary files
987 (specifically, files containing C<\\0> character which is treated
988 as end of string). For those you need to use the C<guestfs_read_file>
989 or C<guestfs_download> functions which have a more complex interface.");
991 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
992 [], (* XXX Tricky to test because it depends on the exact format
993 * of the 'ls -l' command, which changes between F10 and F11.
995 "list the files in a directory (long format)",
997 List the files in C<directory> (relative to the root directory,
998 there is no cwd) in the format of 'ls -la'.
1000 This command is mostly useful for interactive sessions. It
1001 is I<not> intended that you try to parse the output string.");
1003 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1004 [InitBasicFS, Always, TestOutputList (
1006 ["touch"; "/newer"];
1007 ["touch"; "/newest"];
1008 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1009 "list the files in a directory",
1011 List the files in C<directory> (relative to the root directory,
1012 there is no cwd). The '.' and '..' entries are not returned, but
1013 hidden files are shown.
1015 This command is mostly useful for interactive sessions. Programs
1016 should probably use C<guestfs_readdir> instead.");
1018 ("list_devices", (RStringList "devices", []), 7, [],
1019 [InitEmpty, Always, TestOutputListOfDevices (
1020 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1021 "list the block devices",
1023 List all the block devices.
1025 The full block device names are returned, eg. C</dev/sda>");
1027 ("list_partitions", (RStringList "partitions", []), 8, [],
1028 [InitBasicFS, Always, TestOutputListOfDevices (
1029 [["list_partitions"]], ["/dev/sda1"]);
1030 InitEmpty, Always, TestOutputListOfDevices (
1031 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1032 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1033 "list the partitions",
1035 List all the partitions detected on all block devices.
1037 The full partition device names are returned, eg. C</dev/sda1>
1039 This does not return logical volumes. For that you will need to
1040 call C<guestfs_lvs>.");
1042 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1043 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1044 [["pvs"]], ["/dev/sda1"]);
1045 InitEmpty, Always, TestOutputListOfDevices (
1046 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1047 ["pvcreate"; "/dev/sda1"];
1048 ["pvcreate"; "/dev/sda2"];
1049 ["pvcreate"; "/dev/sda3"];
1050 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1051 "list the LVM physical volumes (PVs)",
1053 List all the physical volumes detected. This is the equivalent
1054 of the L<pvs(8)> command.
1056 This returns a list of just the device names that contain
1057 PVs (eg. C</dev/sda2>).
1059 See also C<guestfs_pvs_full>.");
1061 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1062 [InitBasicFSonLVM, Always, TestOutputList (
1064 InitEmpty, Always, TestOutputList (
1065 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1066 ["pvcreate"; "/dev/sda1"];
1067 ["pvcreate"; "/dev/sda2"];
1068 ["pvcreate"; "/dev/sda3"];
1069 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1070 ["vgcreate"; "VG2"; "/dev/sda3"];
1071 ["vgs"]], ["VG1"; "VG2"])],
1072 "list the LVM volume groups (VGs)",
1074 List all the volumes groups detected. This is the equivalent
1075 of the L<vgs(8)> command.
1077 This returns a list of just the volume group names that were
1078 detected (eg. C<VolGroup00>).
1080 See also C<guestfs_vgs_full>.");
1082 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1083 [InitBasicFSonLVM, Always, TestOutputList (
1084 [["lvs"]], ["/dev/VG/LV"]);
1085 InitEmpty, Always, TestOutputList (
1086 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1087 ["pvcreate"; "/dev/sda1"];
1088 ["pvcreate"; "/dev/sda2"];
1089 ["pvcreate"; "/dev/sda3"];
1090 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1091 ["vgcreate"; "VG2"; "/dev/sda3"];
1092 ["lvcreate"; "LV1"; "VG1"; "50"];
1093 ["lvcreate"; "LV2"; "VG1"; "50"];
1094 ["lvcreate"; "LV3"; "VG2"; "50"];
1095 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1096 "list the LVM logical volumes (LVs)",
1098 List all the logical volumes detected. This is the equivalent
1099 of the L<lvs(8)> command.
1101 This returns a list of the logical volume device names
1102 (eg. C</dev/VolGroup00/LogVol00>).
1104 See also C<guestfs_lvs_full>.");
1106 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1107 [], (* XXX how to test? *)
1108 "list the LVM physical volumes (PVs)",
1110 List all the physical volumes detected. This is the equivalent
1111 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1113 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1114 [], (* XXX how to test? *)
1115 "list the LVM volume groups (VGs)",
1117 List all the volumes groups detected. This is the equivalent
1118 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1120 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1121 [], (* XXX how to test? *)
1122 "list the LVM logical volumes (LVs)",
1124 List all the logical volumes detected. This is the equivalent
1125 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1127 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1128 [InitISOFS, Always, TestOutputList (
1129 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1130 InitISOFS, Always, TestOutputList (
1131 [["read_lines"; "/empty"]], [])],
1132 "read file as lines",
1134 Return the contents of the file named C<path>.
1136 The file contents are returned as a list of lines. Trailing
1137 C<LF> and C<CRLF> character sequences are I<not> returned.
1139 Note that this function cannot correctly handle binary files
1140 (specifically, files containing C<\\0> character which is treated
1141 as end of line). For those you need to use the C<guestfs_read_file>
1142 function which has a more complex interface.");
1144 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1145 [], (* XXX Augeas code needs tests. *)
1146 "create a new Augeas handle",
1148 Create a new Augeas handle for editing configuration files.
1149 If there was any previous Augeas handle associated with this
1150 guestfs session, then it is closed.
1152 You must call this before using any other C<guestfs_aug_*>
1155 C<root> is the filesystem root. C<root> must not be NULL,
1158 The flags are the same as the flags defined in
1159 E<lt>augeas.hE<gt>, the logical I<or> of the following
1164 =item C<AUG_SAVE_BACKUP> = 1
1166 Keep the original file with a C<.augsave> extension.
1168 =item C<AUG_SAVE_NEWFILE> = 2
1170 Save changes into a file with extension C<.augnew>, and
1171 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1173 =item C<AUG_TYPE_CHECK> = 4
1175 Typecheck lenses (can be expensive).
1177 =item C<AUG_NO_STDINC> = 8
1179 Do not use standard load path for modules.
1181 =item C<AUG_SAVE_NOOP> = 16
1183 Make save a no-op, just record what would have been changed.
1185 =item C<AUG_NO_LOAD> = 32
1187 Do not load the tree in C<guestfs_aug_init>.
1191 To close the handle, you can call C<guestfs_aug_close>.
1193 To find out more about Augeas, see L<http://augeas.net/>.");
1195 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1196 [], (* XXX Augeas code needs tests. *)
1197 "close the current Augeas handle",
1199 Close the current Augeas handle and free up any resources
1200 used by it. After calling this, you have to call
1201 C<guestfs_aug_init> again before you can use any other
1202 Augeas functions.");
1204 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1205 [], (* XXX Augeas code needs tests. *)
1206 "define an Augeas variable",
1208 Defines an Augeas variable C<name> whose value is the result
1209 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1212 On success this returns the number of nodes in C<expr>, or
1213 C<0> if C<expr> evaluates to something which is not a nodeset.");
1215 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1216 [], (* XXX Augeas code needs tests. *)
1217 "define an Augeas node",
1219 Defines a variable C<name> whose value is the result of
1222 If C<expr> evaluates to an empty nodeset, a node is created,
1223 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1224 C<name> will be the nodeset containing that single node.
1226 On success this returns a pair containing the
1227 number of nodes in the nodeset, and a boolean flag
1228 if a node was created.");
1230 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1231 [], (* XXX Augeas code needs tests. *)
1232 "look up the value of an Augeas path",
1234 Look up the value associated with C<path>. If C<path>
1235 matches exactly one node, the C<value> is returned.");
1237 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1238 [], (* XXX Augeas code needs tests. *)
1239 "set Augeas path to value",
1241 Set the value associated with C<path> to C<value>.");
1243 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1244 [], (* XXX Augeas code needs tests. *)
1245 "insert a sibling Augeas node",
1247 Create a new sibling C<label> for C<path>, inserting it into
1248 the tree before or after C<path> (depending on the boolean
1251 C<path> must match exactly one existing node in the tree, and
1252 C<label> must be a label, ie. not contain C</>, C<*> or end
1253 with a bracketed index C<[N]>.");
1255 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1256 [], (* XXX Augeas code needs tests. *)
1257 "remove an Augeas path",
1259 Remove C<path> and all of its children.
1261 On success this returns the number of entries which were removed.");
1263 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1264 [], (* XXX Augeas code needs tests. *)
1267 Move the node C<src> to C<dest>. C<src> must match exactly
1268 one node. C<dest> is overwritten if it exists.");
1270 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1271 [], (* XXX Augeas code needs tests. *)
1272 "return Augeas nodes which match augpath",
1274 Returns a list of paths which match the path expression C<path>.
1275 The returned paths are sufficiently qualified so that they match
1276 exactly one node in the current tree.");
1278 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1279 [], (* XXX Augeas code needs tests. *)
1280 "write all pending Augeas changes to disk",
1282 This writes all pending changes to disk.
1284 The flags which were passed to C<guestfs_aug_init> affect exactly
1285 how files are saved.");
1287 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1288 [], (* XXX Augeas code needs tests. *)
1289 "load files into the tree",
1291 Load files into the tree.
1293 See C<aug_load> in the Augeas documentation for the full gory
1296 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1297 [], (* XXX Augeas code needs tests. *)
1298 "list Augeas nodes under augpath",
1300 This is just a shortcut for listing C<guestfs_aug_match>
1301 C<path/*> and sorting the resulting nodes into alphabetical order.");
1303 ("rm", (RErr, [Pathname "path"]), 29, [],
1304 [InitBasicFS, Always, TestRun
1307 InitBasicFS, Always, TestLastFail
1309 InitBasicFS, Always, TestLastFail
1314 Remove the single file C<path>.");
1316 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1317 [InitBasicFS, Always, TestRun
1320 InitBasicFS, Always, TestLastFail
1321 [["rmdir"; "/new"]];
1322 InitBasicFS, Always, TestLastFail
1324 ["rmdir"; "/new"]]],
1325 "remove a directory",
1327 Remove the single directory C<path>.");
1329 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1330 [InitBasicFS, Always, TestOutputFalse
1332 ["mkdir"; "/new/foo"];
1333 ["touch"; "/new/foo/bar"];
1335 ["exists"; "/new"]]],
1336 "remove a file or directory recursively",
1338 Remove the file or directory C<path>, recursively removing the
1339 contents if its a directory. This is like the C<rm -rf> shell
1342 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1343 [InitBasicFS, Always, TestOutputTrue
1345 ["is_dir"; "/new"]];
1346 InitBasicFS, Always, TestLastFail
1347 [["mkdir"; "/new/foo/bar"]]],
1348 "create a directory",
1350 Create a directory named C<path>.");
1352 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1353 [InitBasicFS, Always, TestOutputTrue
1354 [["mkdir_p"; "/new/foo/bar"];
1355 ["is_dir"; "/new/foo/bar"]];
1356 InitBasicFS, Always, TestOutputTrue
1357 [["mkdir_p"; "/new/foo/bar"];
1358 ["is_dir"; "/new/foo"]];
1359 InitBasicFS, Always, TestOutputTrue
1360 [["mkdir_p"; "/new/foo/bar"];
1361 ["is_dir"; "/new"]];
1362 (* Regression tests for RHBZ#503133: *)
1363 InitBasicFS, Always, TestRun
1365 ["mkdir_p"; "/new"]];
1366 InitBasicFS, Always, TestLastFail
1368 ["mkdir_p"; "/new"]]],
1369 "create a directory and parents",
1371 Create a directory named C<path>, creating any parent directories
1372 as necessary. This is like the C<mkdir -p> shell command.");
1374 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1375 [], (* XXX Need stat command to test *)
1378 Change the mode (permissions) of C<path> to C<mode>. Only
1379 numeric modes are supported.
1381 I<Note>: When using this command from guestfish, C<mode>
1382 by default would be decimal, unless you prefix it with
1383 C<0> to get octal, ie. use C<0700> not C<700>.");
1385 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1386 [], (* XXX Need stat command to test *)
1387 "change file owner and group",
1389 Change the file owner to C<owner> and group to C<group>.
1391 Only numeric uid and gid are supported. If you want to use
1392 names, you will need to locate and parse the password file
1393 yourself (Augeas support makes this relatively easy).");
1395 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1396 [InitISOFS, Always, TestOutputTrue (
1397 [["exists"; "/empty"]]);
1398 InitISOFS, Always, TestOutputTrue (
1399 [["exists"; "/directory"]])],
1400 "test if file or directory exists",
1402 This returns C<true> if and only if there is a file, directory
1403 (or anything) with the given C<path> name.
1405 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1407 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1408 [InitISOFS, Always, TestOutputTrue (
1409 [["is_file"; "/known-1"]]);
1410 InitISOFS, Always, TestOutputFalse (
1411 [["is_file"; "/directory"]])],
1412 "test if file exists",
1414 This returns C<true> if and only if there is a file
1415 with the given C<path> name. Note that it returns false for
1416 other objects like directories.
1418 See also C<guestfs_stat>.");
1420 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1421 [InitISOFS, Always, TestOutputFalse (
1422 [["is_dir"; "/known-3"]]);
1423 InitISOFS, Always, TestOutputTrue (
1424 [["is_dir"; "/directory"]])],
1425 "test if file exists",
1427 This returns C<true> if and only if there is a directory
1428 with the given C<path> name. Note that it returns false for
1429 other objects like files.
1431 See also C<guestfs_stat>.");
1433 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1434 [InitEmpty, Always, TestOutputListOfDevices (
1435 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1436 ["pvcreate"; "/dev/sda1"];
1437 ["pvcreate"; "/dev/sda2"];
1438 ["pvcreate"; "/dev/sda3"];
1439 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1440 "create an LVM physical volume",
1442 This creates an LVM physical volume on the named C<device>,
1443 where C<device> should usually be a partition name such
1446 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1447 [InitEmpty, Always, TestOutputList (
1448 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1449 ["pvcreate"; "/dev/sda1"];
1450 ["pvcreate"; "/dev/sda2"];
1451 ["pvcreate"; "/dev/sda3"];
1452 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1453 ["vgcreate"; "VG2"; "/dev/sda3"];
1454 ["vgs"]], ["VG1"; "VG2"])],
1455 "create an LVM volume group",
1457 This creates an LVM volume group called C<volgroup>
1458 from the non-empty list of physical volumes C<physvols>.");
1460 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1461 [InitEmpty, Always, TestOutputList (
1462 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1463 ["pvcreate"; "/dev/sda1"];
1464 ["pvcreate"; "/dev/sda2"];
1465 ["pvcreate"; "/dev/sda3"];
1466 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1467 ["vgcreate"; "VG2"; "/dev/sda3"];
1468 ["lvcreate"; "LV1"; "VG1"; "50"];
1469 ["lvcreate"; "LV2"; "VG1"; "50"];
1470 ["lvcreate"; "LV3"; "VG2"; "50"];
1471 ["lvcreate"; "LV4"; "VG2"; "50"];
1472 ["lvcreate"; "LV5"; "VG2"; "50"];
1474 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1475 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1476 "create an LVM volume group",
1478 This creates an LVM volume group called C<logvol>
1479 on the volume group C<volgroup>, with C<size> megabytes.");
1481 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1482 [InitEmpty, Always, TestOutput (
1483 [["part_disk"; "/dev/sda"; "mbr"];
1484 ["mkfs"; "ext2"; "/dev/sda1"];
1485 ["mount_options"; ""; "/dev/sda1"; "/"];
1486 ["write_file"; "/new"; "new file contents"; "0"];
1487 ["cat"; "/new"]], "new file contents")],
1488 "make a filesystem",
1490 This creates a filesystem on C<device> (usually a partition
1491 or LVM logical volume). The filesystem type is C<fstype>, for
1494 ("sfdisk", (RErr, [Device "device";
1495 Int "cyls"; Int "heads"; Int "sectors";
1496 StringList "lines"]), 43, [DangerWillRobinson],
1498 "create partitions on a block device",
1500 This is a direct interface to the L<sfdisk(8)> program for creating
1501 partitions on block devices.
1503 C<device> should be a block device, for example C</dev/sda>.
1505 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1506 and sectors on the device, which are passed directly to sfdisk as
1507 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1508 of these, then the corresponding parameter is omitted. Usually for
1509 'large' disks, you can just pass C<0> for these, but for small
1510 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1511 out the right geometry and you will need to tell it.
1513 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1514 information refer to the L<sfdisk(8)> manpage.
1516 To create a single partition occupying the whole disk, you would
1517 pass C<lines> as a single element list, when the single element being
1518 the string C<,> (comma).
1520 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1521 C<guestfs_part_init>");
1523 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1524 [InitBasicFS, Always, TestOutput (
1525 [["write_file"; "/new"; "new file contents"; "0"];
1526 ["cat"; "/new"]], "new file contents");
1527 InitBasicFS, Always, TestOutput (
1528 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1529 ["cat"; "/new"]], "\nnew file contents\n");
1530 InitBasicFS, Always, TestOutput (
1531 [["write_file"; "/new"; "\n\n"; "0"];
1532 ["cat"; "/new"]], "\n\n");
1533 InitBasicFS, Always, TestOutput (
1534 [["write_file"; "/new"; ""; "0"];
1535 ["cat"; "/new"]], "");
1536 InitBasicFS, Always, TestOutput (
1537 [["write_file"; "/new"; "\n\n\n"; "0"];
1538 ["cat"; "/new"]], "\n\n\n");
1539 InitBasicFS, Always, TestOutput (
1540 [["write_file"; "/new"; "\n"; "0"];
1541 ["cat"; "/new"]], "\n")],
1544 This call creates a file called C<path>. The contents of the
1545 file is the string C<content> (which can contain any 8 bit data),
1546 with length C<size>.
1548 As a special case, if C<size> is C<0>
1549 then the length is calculated using C<strlen> (so in this case
1550 the content cannot contain embedded ASCII NULs).
1552 I<NB.> Owing to a bug, writing content containing ASCII NUL
1553 characters does I<not> work, even if the length is specified.
1554 We hope to resolve this bug in a future version. In the meantime
1555 use C<guestfs_upload>.");
1557 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1558 [InitEmpty, Always, TestOutputListOfDevices (
1559 [["part_disk"; "/dev/sda"; "mbr"];
1560 ["mkfs"; "ext2"; "/dev/sda1"];
1561 ["mount_options"; ""; "/dev/sda1"; "/"];
1562 ["mounts"]], ["/dev/sda1"]);
1563 InitEmpty, Always, TestOutputList (
1564 [["part_disk"; "/dev/sda"; "mbr"];
1565 ["mkfs"; "ext2"; "/dev/sda1"];
1566 ["mount_options"; ""; "/dev/sda1"; "/"];
1569 "unmount a filesystem",
1571 This unmounts the given filesystem. The filesystem may be
1572 specified either by its mountpoint (path) or the device which
1573 contains the filesystem.");
1575 ("mounts", (RStringList "devices", []), 46, [],
1576 [InitBasicFS, Always, TestOutputListOfDevices (
1577 [["mounts"]], ["/dev/sda1"])],
1578 "show mounted filesystems",
1580 This returns the list of currently mounted filesystems. It returns
1581 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1583 Some internal mounts are not shown.
1585 See also: C<guestfs_mountpoints>");
1587 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1588 [InitBasicFS, Always, TestOutputList (
1591 (* check that umount_all can unmount nested mounts correctly: *)
1592 InitEmpty, Always, TestOutputList (
1593 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1594 ["mkfs"; "ext2"; "/dev/sda1"];
1595 ["mkfs"; "ext2"; "/dev/sda2"];
1596 ["mkfs"; "ext2"; "/dev/sda3"];
1597 ["mount_options"; ""; "/dev/sda1"; "/"];
1599 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1600 ["mkdir"; "/mp1/mp2"];
1601 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1602 ["mkdir"; "/mp1/mp2/mp3"];
1605 "unmount all filesystems",
1607 This unmounts all mounted filesystems.
1609 Some internal mounts are not unmounted by this call.");
1611 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1613 "remove all LVM LVs, VGs and PVs",
1615 This command removes all LVM logical volumes, volume groups
1616 and physical volumes.");
1618 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1619 [InitISOFS, Always, TestOutput (
1620 [["file"; "/empty"]], "empty");
1621 InitISOFS, Always, TestOutput (
1622 [["file"; "/known-1"]], "ASCII text");
1623 InitISOFS, Always, TestLastFail (
1624 [["file"; "/notexists"]])],
1625 "determine file type",
1627 This call uses the standard L<file(1)> command to determine
1628 the type or contents of the file. This also works on devices,
1629 for example to find out whether a partition contains a filesystem.
1631 This call will also transparently look inside various types
1634 The exact command which runs is C<file -zbsL path>. Note in
1635 particular that the filename is not prepended to the output
1636 (the C<-b> option).");
1638 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1639 [InitBasicFS, Always, TestOutput (
1640 [["upload"; "test-command"; "/test-command"];
1641 ["chmod"; "0o755"; "/test-command"];
1642 ["command"; "/test-command 1"]], "Result1");
1643 InitBasicFS, Always, TestOutput (
1644 [["upload"; "test-command"; "/test-command"];
1645 ["chmod"; "0o755"; "/test-command"];
1646 ["command"; "/test-command 2"]], "Result2\n");
1647 InitBasicFS, Always, TestOutput (
1648 [["upload"; "test-command"; "/test-command"];
1649 ["chmod"; "0o755"; "/test-command"];
1650 ["command"; "/test-command 3"]], "\nResult3");
1651 InitBasicFS, Always, TestOutput (
1652 [["upload"; "test-command"; "/test-command"];
1653 ["chmod"; "0o755"; "/test-command"];
1654 ["command"; "/test-command 4"]], "\nResult4\n");
1655 InitBasicFS, Always, TestOutput (
1656 [["upload"; "test-command"; "/test-command"];
1657 ["chmod"; "0o755"; "/test-command"];
1658 ["command"; "/test-command 5"]], "\nResult5\n\n");
1659 InitBasicFS, Always, TestOutput (
1660 [["upload"; "test-command"; "/test-command"];
1661 ["chmod"; "0o755"; "/test-command"];
1662 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1663 InitBasicFS, Always, TestOutput (
1664 [["upload"; "test-command"; "/test-command"];
1665 ["chmod"; "0o755"; "/test-command"];
1666 ["command"; "/test-command 7"]], "");
1667 InitBasicFS, Always, TestOutput (
1668 [["upload"; "test-command"; "/test-command"];
1669 ["chmod"; "0o755"; "/test-command"];
1670 ["command"; "/test-command 8"]], "\n");
1671 InitBasicFS, Always, TestOutput (
1672 [["upload"; "test-command"; "/test-command"];
1673 ["chmod"; "0o755"; "/test-command"];
1674 ["command"; "/test-command 9"]], "\n\n");
1675 InitBasicFS, Always, TestOutput (
1676 [["upload"; "test-command"; "/test-command"];
1677 ["chmod"; "0o755"; "/test-command"];
1678 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1679 InitBasicFS, Always, TestOutput (
1680 [["upload"; "test-command"; "/test-command"];
1681 ["chmod"; "0o755"; "/test-command"];
1682 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1683 InitBasicFS, Always, TestLastFail (
1684 [["upload"; "test-command"; "/test-command"];
1685 ["chmod"; "0o755"; "/test-command"];
1686 ["command"; "/test-command"]])],
1687 "run a command from the guest filesystem",
1689 This call runs a command from the guest filesystem. The
1690 filesystem must be mounted, and must contain a compatible
1691 operating system (ie. something Linux, with the same
1692 or compatible processor architecture).
1694 The single parameter is an argv-style list of arguments.
1695 The first element is the name of the program to run.
1696 Subsequent elements are parameters. The list must be
1697 non-empty (ie. must contain a program name). Note that
1698 the command runs directly, and is I<not> invoked via
1699 the shell (see C<guestfs_sh>).
1701 The return value is anything printed to I<stdout> by
1704 If the command returns a non-zero exit status, then
1705 this function returns an error message. The error message
1706 string is the content of I<stderr> from the command.
1708 The C<$PATH> environment variable will contain at least
1709 C</usr/bin> and C</bin>. If you require a program from
1710 another location, you should provide the full path in the
1713 Shared libraries and data files required by the program
1714 must be available on filesystems which are mounted in the
1715 correct places. It is the caller's responsibility to ensure
1716 all filesystems that are needed are mounted at the right
1719 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1720 [InitBasicFS, Always, TestOutputList (
1721 [["upload"; "test-command"; "/test-command"];
1722 ["chmod"; "0o755"; "/test-command"];
1723 ["command_lines"; "/test-command 1"]], ["Result1"]);
1724 InitBasicFS, Always, TestOutputList (
1725 [["upload"; "test-command"; "/test-command"];
1726 ["chmod"; "0o755"; "/test-command"];
1727 ["command_lines"; "/test-command 2"]], ["Result2"]);
1728 InitBasicFS, Always, TestOutputList (
1729 [["upload"; "test-command"; "/test-command"];
1730 ["chmod"; "0o755"; "/test-command"];
1731 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1732 InitBasicFS, Always, TestOutputList (
1733 [["upload"; "test-command"; "/test-command"];
1734 ["chmod"; "0o755"; "/test-command"];
1735 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1736 InitBasicFS, Always, TestOutputList (
1737 [["upload"; "test-command"; "/test-command"];
1738 ["chmod"; "0o755"; "/test-command"];
1739 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1740 InitBasicFS, Always, TestOutputList (
1741 [["upload"; "test-command"; "/test-command"];
1742 ["chmod"; "0o755"; "/test-command"];
1743 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1744 InitBasicFS, Always, TestOutputList (
1745 [["upload"; "test-command"; "/test-command"];
1746 ["chmod"; "0o755"; "/test-command"];
1747 ["command_lines"; "/test-command 7"]], []);
1748 InitBasicFS, Always, TestOutputList (
1749 [["upload"; "test-command"; "/test-command"];
1750 ["chmod"; "0o755"; "/test-command"];
1751 ["command_lines"; "/test-command 8"]], [""]);
1752 InitBasicFS, Always, TestOutputList (
1753 [["upload"; "test-command"; "/test-command"];
1754 ["chmod"; "0o755"; "/test-command"];
1755 ["command_lines"; "/test-command 9"]], ["";""]);
1756 InitBasicFS, Always, TestOutputList (
1757 [["upload"; "test-command"; "/test-command"];
1758 ["chmod"; "0o755"; "/test-command"];
1759 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1760 InitBasicFS, Always, TestOutputList (
1761 [["upload"; "test-command"; "/test-command"];
1762 ["chmod"; "0o755"; "/test-command"];
1763 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1764 "run a command, returning lines",
1766 This is the same as C<guestfs_command>, but splits the
1767 result into a list of lines.
1769 See also: C<guestfs_sh_lines>");
1771 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1772 [InitISOFS, Always, TestOutputStruct (
1773 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1774 "get file information",
1776 Returns file information for the given C<path>.
1778 This is the same as the C<stat(2)> system call.");
1780 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1781 [InitISOFS, Always, TestOutputStruct (
1782 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1783 "get file information for a symbolic link",
1785 Returns file information for the given C<path>.
1787 This is the same as C<guestfs_stat> except that if C<path>
1788 is a symbolic link, then the link is stat-ed, not the file it
1791 This is the same as the C<lstat(2)> system call.");
1793 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1794 [InitISOFS, Always, TestOutputStruct (
1795 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1796 "get file system statistics",
1798 Returns file system statistics for any mounted file system.
1799 C<path> should be a file or directory in the mounted file system
1800 (typically it is the mount point itself, but it doesn't need to be).
1802 This is the same as the C<statvfs(2)> system call.");
1804 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1806 "get ext2/ext3/ext4 superblock details",
1808 This returns the contents of the ext2, ext3 or ext4 filesystem
1809 superblock on C<device>.
1811 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1812 manpage for more details. The list of fields returned isn't
1813 clearly defined, and depends on both the version of C<tune2fs>
1814 that libguestfs was built against, and the filesystem itself.");
1816 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1817 [InitEmpty, Always, TestOutputTrue (
1818 [["blockdev_setro"; "/dev/sda"];
1819 ["blockdev_getro"; "/dev/sda"]])],
1820 "set block device to read-only",
1822 Sets the block device named C<device> to read-only.
1824 This uses the L<blockdev(8)> command.");
1826 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1827 [InitEmpty, Always, TestOutputFalse (
1828 [["blockdev_setrw"; "/dev/sda"];
1829 ["blockdev_getro"; "/dev/sda"]])],
1830 "set block device to read-write",
1832 Sets the block device named C<device> to read-write.
1834 This uses the L<blockdev(8)> command.");
1836 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1837 [InitEmpty, Always, TestOutputTrue (
1838 [["blockdev_setro"; "/dev/sda"];
1839 ["blockdev_getro"; "/dev/sda"]])],
1840 "is block device set to read-only",
1842 Returns a boolean indicating if the block device is read-only
1843 (true if read-only, false if not).
1845 This uses the L<blockdev(8)> command.");
1847 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1848 [InitEmpty, Always, TestOutputInt (
1849 [["blockdev_getss"; "/dev/sda"]], 512)],
1850 "get sectorsize of block device",
1852 This returns the size of sectors on a block device.
1853 Usually 512, but can be larger for modern devices.
1855 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1858 This uses the L<blockdev(8)> command.");
1860 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1861 [InitEmpty, Always, TestOutputInt (
1862 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1863 "get blocksize of block device",
1865 This returns the block size of a device.
1867 (Note this is different from both I<size in blocks> and
1868 I<filesystem block size>).
1870 This uses the L<blockdev(8)> command.");
1872 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1874 "set blocksize of block device",
1876 This sets the block size of a device.
1878 (Note this is different from both I<size in blocks> and
1879 I<filesystem block size>).
1881 This uses the L<blockdev(8)> command.");
1883 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1884 [InitEmpty, Always, TestOutputInt (
1885 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1886 "get total size of device in 512-byte sectors",
1888 This returns the size of the device in units of 512-byte sectors
1889 (even if the sectorsize isn't 512 bytes ... weird).
1891 See also C<guestfs_blockdev_getss> for the real sector size of
1892 the device, and C<guestfs_blockdev_getsize64> for the more
1893 useful I<size in bytes>.
1895 This uses the L<blockdev(8)> command.");
1897 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1898 [InitEmpty, Always, TestOutputInt (
1899 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1900 "get total size of device in bytes",
1902 This returns the size of the device in bytes.
1904 See also C<guestfs_blockdev_getsz>.
1906 This uses the L<blockdev(8)> command.");
1908 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1909 [InitEmpty, Always, TestRun
1910 [["blockdev_flushbufs"; "/dev/sda"]]],
1911 "flush device buffers",
1913 This tells the kernel to flush internal buffers associated
1916 This uses the L<blockdev(8)> command.");
1918 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1919 [InitEmpty, Always, TestRun
1920 [["blockdev_rereadpt"; "/dev/sda"]]],
1921 "reread partition table",
1923 Reread the partition table on C<device>.
1925 This uses the L<blockdev(8)> command.");
1927 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1928 [InitBasicFS, Always, TestOutput (
1929 (* Pick a file from cwd which isn't likely to change. *)
1930 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1931 ["checksum"; "md5"; "/COPYING.LIB"]],
1932 Digest.to_hex (Digest.file "COPYING.LIB"))],
1933 "upload a file from the local machine",
1935 Upload local file C<filename> to C<remotefilename> on the
1938 C<filename> can also be a named pipe.
1940 See also C<guestfs_download>.");
1942 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1943 [InitBasicFS, Always, TestOutput (
1944 (* Pick a file from cwd which isn't likely to change. *)
1945 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1946 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1947 ["upload"; "testdownload.tmp"; "/upload"];
1948 ["checksum"; "md5"; "/upload"]],
1949 Digest.to_hex (Digest.file "COPYING.LIB"))],
1950 "download a file to the local machine",
1952 Download file C<remotefilename> and save it as C<filename>
1953 on the local machine.
1955 C<filename> can also be a named pipe.
1957 See also C<guestfs_upload>, C<guestfs_cat>.");
1959 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1960 [InitISOFS, Always, TestOutput (
1961 [["checksum"; "crc"; "/known-3"]], "2891671662");
1962 InitISOFS, Always, TestLastFail (
1963 [["checksum"; "crc"; "/notexists"]]);
1964 InitISOFS, Always, TestOutput (
1965 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1966 InitISOFS, Always, TestOutput (
1967 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1968 InitISOFS, Always, TestOutput (
1969 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1970 InitISOFS, Always, TestOutput (
1971 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1972 InitISOFS, Always, TestOutput (
1973 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1974 InitISOFS, Always, TestOutput (
1975 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1976 "compute MD5, SHAx or CRC checksum of file",
1978 This call computes the MD5, SHAx or CRC checksum of the
1981 The type of checksum to compute is given by the C<csumtype>
1982 parameter which must have one of the following values:
1988 Compute the cyclic redundancy check (CRC) specified by POSIX
1989 for the C<cksum> command.
1993 Compute the MD5 hash (using the C<md5sum> program).
1997 Compute the SHA1 hash (using the C<sha1sum> program).
2001 Compute the SHA224 hash (using the C<sha224sum> program).
2005 Compute the SHA256 hash (using the C<sha256sum> program).
2009 Compute the SHA384 hash (using the C<sha384sum> program).
2013 Compute the SHA512 hash (using the C<sha512sum> program).
2017 The checksum is returned as a printable string.");
2019 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
2020 [InitBasicFS, Always, TestOutput (
2021 [["tar_in"; "../images/helloworld.tar"; "/"];
2022 ["cat"; "/hello"]], "hello\n")],
2023 "unpack tarfile to directory",
2025 This command uploads and unpacks local file C<tarfile> (an
2026 I<uncompressed> tar file) into C<directory>.
2028 To upload a compressed tarball, use C<guestfs_tgz_in>.");
2030 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2032 "pack directory into tarfile",
2034 This command packs the contents of C<directory> and downloads
2035 it to local file C<tarfile>.
2037 To download a compressed tarball, use C<guestfs_tgz_out>.");
2039 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
2040 [InitBasicFS, Always, TestOutput (
2041 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2042 ["cat"; "/hello"]], "hello\n")],
2043 "unpack compressed tarball to directory",
2045 This command uploads and unpacks local file C<tarball> (a
2046 I<gzip compressed> tar file) into C<directory>.
2048 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2050 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2052 "pack directory into compressed tarball",
2054 This command packs the contents of C<directory> and downloads
2055 it to local file C<tarball>.
2057 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2059 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2060 [InitBasicFS, Always, TestLastFail (
2062 ["mount_ro"; "/dev/sda1"; "/"];
2063 ["touch"; "/new"]]);
2064 InitBasicFS, Always, TestOutput (
2065 [["write_file"; "/new"; "data"; "0"];
2067 ["mount_ro"; "/dev/sda1"; "/"];
2068 ["cat"; "/new"]], "data")],
2069 "mount a guest disk, read-only",
2071 This is the same as the C<guestfs_mount> command, but it
2072 mounts the filesystem with the read-only (I<-o ro>) flag.");
2074 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2076 "mount a guest disk with mount options",
2078 This is the same as the C<guestfs_mount> command, but it
2079 allows you to set the mount options as for the
2080 L<mount(8)> I<-o> flag.");
2082 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2084 "mount a guest disk with mount options and vfstype",
2086 This is the same as the C<guestfs_mount> command, but it
2087 allows you to set both the mount options and the vfstype
2088 as for the L<mount(8)> I<-o> and I<-t> flags.");
2090 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2092 "debugging and internals",
2094 The C<guestfs_debug> command exposes some internals of
2095 C<guestfsd> (the guestfs daemon) that runs inside the
2098 There is no comprehensive help for this command. You have
2099 to look at the file C<daemon/debug.c> in the libguestfs source
2100 to find out what you can do.");
2102 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2103 [InitEmpty, Always, TestOutputList (
2104 [["part_disk"; "/dev/sda"; "mbr"];
2105 ["pvcreate"; "/dev/sda1"];
2106 ["vgcreate"; "VG"; "/dev/sda1"];
2107 ["lvcreate"; "LV1"; "VG"; "50"];
2108 ["lvcreate"; "LV2"; "VG"; "50"];
2109 ["lvremove"; "/dev/VG/LV1"];
2110 ["lvs"]], ["/dev/VG/LV2"]);
2111 InitEmpty, Always, TestOutputList (
2112 [["part_disk"; "/dev/sda"; "mbr"];
2113 ["pvcreate"; "/dev/sda1"];
2114 ["vgcreate"; "VG"; "/dev/sda1"];
2115 ["lvcreate"; "LV1"; "VG"; "50"];
2116 ["lvcreate"; "LV2"; "VG"; "50"];
2117 ["lvremove"; "/dev/VG"];
2119 InitEmpty, Always, TestOutputList (
2120 [["part_disk"; "/dev/sda"; "mbr"];
2121 ["pvcreate"; "/dev/sda1"];
2122 ["vgcreate"; "VG"; "/dev/sda1"];
2123 ["lvcreate"; "LV1"; "VG"; "50"];
2124 ["lvcreate"; "LV2"; "VG"; "50"];
2125 ["lvremove"; "/dev/VG"];
2127 "remove an LVM logical volume",
2129 Remove an LVM logical volume C<device>, where C<device> is
2130 the path to the LV, such as C</dev/VG/LV>.
2132 You can also remove all LVs in a volume group by specifying
2133 the VG name, C</dev/VG>.");
2135 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2136 [InitEmpty, Always, TestOutputList (
2137 [["part_disk"; "/dev/sda"; "mbr"];
2138 ["pvcreate"; "/dev/sda1"];
2139 ["vgcreate"; "VG"; "/dev/sda1"];
2140 ["lvcreate"; "LV1"; "VG"; "50"];
2141 ["lvcreate"; "LV2"; "VG"; "50"];
2144 InitEmpty, Always, TestOutputList (
2145 [["part_disk"; "/dev/sda"; "mbr"];
2146 ["pvcreate"; "/dev/sda1"];
2147 ["vgcreate"; "VG"; "/dev/sda1"];
2148 ["lvcreate"; "LV1"; "VG"; "50"];
2149 ["lvcreate"; "LV2"; "VG"; "50"];
2152 "remove an LVM volume group",
2154 Remove an LVM volume group C<vgname>, (for example C<VG>).
2156 This also forcibly removes all logical volumes in the volume
2159 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2160 [InitEmpty, Always, TestOutputListOfDevices (
2161 [["part_disk"; "/dev/sda"; "mbr"];
2162 ["pvcreate"; "/dev/sda1"];
2163 ["vgcreate"; "VG"; "/dev/sda1"];
2164 ["lvcreate"; "LV1"; "VG"; "50"];
2165 ["lvcreate"; "LV2"; "VG"; "50"];
2167 ["pvremove"; "/dev/sda1"];
2169 InitEmpty, Always, TestOutputListOfDevices (
2170 [["part_disk"; "/dev/sda"; "mbr"];
2171 ["pvcreate"; "/dev/sda1"];
2172 ["vgcreate"; "VG"; "/dev/sda1"];
2173 ["lvcreate"; "LV1"; "VG"; "50"];
2174 ["lvcreate"; "LV2"; "VG"; "50"];
2176 ["pvremove"; "/dev/sda1"];
2178 InitEmpty, Always, TestOutputListOfDevices (
2179 [["part_disk"; "/dev/sda"; "mbr"];
2180 ["pvcreate"; "/dev/sda1"];
2181 ["vgcreate"; "VG"; "/dev/sda1"];
2182 ["lvcreate"; "LV1"; "VG"; "50"];
2183 ["lvcreate"; "LV2"; "VG"; "50"];
2185 ["pvremove"; "/dev/sda1"];
2187 "remove an LVM physical volume",
2189 This wipes a physical volume C<device> so that LVM will no longer
2192 The implementation uses the C<pvremove> command which refuses to
2193 wipe physical volumes that contain any volume groups, so you have
2194 to remove those first.");
2196 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2197 [InitBasicFS, Always, TestOutput (
2198 [["set_e2label"; "/dev/sda1"; "testlabel"];
2199 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2200 "set the ext2/3/4 filesystem label",
2202 This sets the ext2/3/4 filesystem label of the filesystem on
2203 C<device> to C<label>. Filesystem labels are limited to
2206 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2207 to return the existing label on a filesystem.");
2209 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2211 "get the ext2/3/4 filesystem label",
2213 This returns the ext2/3/4 filesystem label of the filesystem on
2216 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2217 (let uuid = uuidgen () in
2218 [InitBasicFS, Always, TestOutput (
2219 [["set_e2uuid"; "/dev/sda1"; uuid];
2220 ["get_e2uuid"; "/dev/sda1"]], uuid);
2221 InitBasicFS, Always, TestOutput (
2222 [["set_e2uuid"; "/dev/sda1"; "clear"];
2223 ["get_e2uuid"; "/dev/sda1"]], "");
2224 (* We can't predict what UUIDs will be, so just check the commands run. *)
2225 InitBasicFS, Always, TestRun (
2226 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2227 InitBasicFS, Always, TestRun (
2228 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2229 "set the ext2/3/4 filesystem UUID",
2231 This sets the ext2/3/4 filesystem UUID of the filesystem on
2232 C<device> to C<uuid>. The format of the UUID and alternatives
2233 such as C<clear>, C<random> and C<time> are described in the
2234 L<tune2fs(8)> manpage.
2236 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2237 to return the existing UUID of a filesystem.");
2239 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2241 "get the ext2/3/4 filesystem UUID",
2243 This returns the ext2/3/4 filesystem UUID of the filesystem on
2246 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2247 [InitBasicFS, Always, TestOutputInt (
2248 [["umount"; "/dev/sda1"];
2249 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2250 InitBasicFS, Always, TestOutputInt (
2251 [["umount"; "/dev/sda1"];
2252 ["zero"; "/dev/sda1"];
2253 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2254 "run the filesystem checker",
2256 This runs the filesystem checker (fsck) on C<device> which
2257 should have filesystem type C<fstype>.
2259 The returned integer is the status. See L<fsck(8)> for the
2260 list of status codes from C<fsck>.
2268 Multiple status codes can be summed together.
2272 A non-zero return code can mean \"success\", for example if
2273 errors have been corrected on the filesystem.
2277 Checking or repairing NTFS volumes is not supported
2282 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2284 ("zero", (RErr, [Device "device"]), 85, [],
2285 [InitBasicFS, Always, TestOutput (
2286 [["umount"; "/dev/sda1"];
2287 ["zero"; "/dev/sda1"];
2288 ["file"; "/dev/sda1"]], "data")],
2289 "write zeroes to the device",
2291 This command writes zeroes over the first few blocks of C<device>.
2293 How many blocks are zeroed isn't specified (but it's I<not> enough
2294 to securely wipe the device). It should be sufficient to remove
2295 any partition tables, filesystem superblocks and so on.
2297 See also: C<guestfs_scrub_device>.");
2299 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2300 (* Test disabled because grub-install incompatible with virtio-blk driver.
2301 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2303 [InitBasicFS, Disabled, TestOutputTrue (
2304 [["grub_install"; "/"; "/dev/sda1"];
2305 ["is_dir"; "/boot"]])],
2308 This command installs GRUB (the Grand Unified Bootloader) on
2309 C<device>, with the root directory being C<root>.");
2311 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2312 [InitBasicFS, Always, TestOutput (
2313 [["write_file"; "/old"; "file content"; "0"];
2314 ["cp"; "/old"; "/new"];
2315 ["cat"; "/new"]], "file content");
2316 InitBasicFS, Always, TestOutputTrue (
2317 [["write_file"; "/old"; "file content"; "0"];
2318 ["cp"; "/old"; "/new"];
2319 ["is_file"; "/old"]]);
2320 InitBasicFS, Always, TestOutput (
2321 [["write_file"; "/old"; "file content"; "0"];
2323 ["cp"; "/old"; "/dir/new"];
2324 ["cat"; "/dir/new"]], "file content")],
2327 This copies a file from C<src> to C<dest> where C<dest> is
2328 either a destination filename or destination directory.");
2330 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2331 [InitBasicFS, Always, TestOutput (
2332 [["mkdir"; "/olddir"];
2333 ["mkdir"; "/newdir"];
2334 ["write_file"; "/olddir/file"; "file content"; "0"];
2335 ["cp_a"; "/olddir"; "/newdir"];
2336 ["cat"; "/newdir/olddir/file"]], "file content")],
2337 "copy a file or directory recursively",
2339 This copies a file or directory from C<src> to C<dest>
2340 recursively using the C<cp -a> command.");
2342 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2343 [InitBasicFS, Always, TestOutput (
2344 [["write_file"; "/old"; "file content"; "0"];
2345 ["mv"; "/old"; "/new"];
2346 ["cat"; "/new"]], "file content");
2347 InitBasicFS, Always, TestOutputFalse (
2348 [["write_file"; "/old"; "file content"; "0"];
2349 ["mv"; "/old"; "/new"];
2350 ["is_file"; "/old"]])],
2353 This moves a file from C<src> to C<dest> where C<dest> is
2354 either a destination filename or destination directory.");
2356 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2357 [InitEmpty, Always, TestRun (
2358 [["drop_caches"; "3"]])],
2359 "drop kernel page cache, dentries and inodes",
2361 This instructs the guest kernel to drop its page cache,
2362 and/or dentries and inode caches. The parameter C<whattodrop>
2363 tells the kernel what precisely to drop, see
2364 L<http://linux-mm.org/Drop_Caches>
2366 Setting C<whattodrop> to 3 should drop everything.
2368 This automatically calls L<sync(2)> before the operation,
2369 so that the maximum guest memory is freed.");
2371 ("dmesg", (RString "kmsgs", []), 91, [],
2372 [InitEmpty, Always, TestRun (
2374 "return kernel messages",
2376 This returns the kernel messages (C<dmesg> output) from
2377 the guest kernel. This is sometimes useful for extended
2378 debugging of problems.
2380 Another way to get the same information is to enable
2381 verbose messages with C<guestfs_set_verbose> or by setting
2382 the environment variable C<LIBGUESTFS_DEBUG=1> before
2383 running the program.");
2385 ("ping_daemon", (RErr, []), 92, [],
2386 [InitEmpty, Always, TestRun (
2387 [["ping_daemon"]])],
2388 "ping the guest daemon",
2390 This is a test probe into the guestfs daemon running inside
2391 the qemu subprocess. Calling this function checks that the
2392 daemon responds to the ping message, without affecting the daemon
2393 or attached block device(s) in any other way.");
2395 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2396 [InitBasicFS, Always, TestOutputTrue (
2397 [["write_file"; "/file1"; "contents of a file"; "0"];
2398 ["cp"; "/file1"; "/file2"];
2399 ["equal"; "/file1"; "/file2"]]);
2400 InitBasicFS, Always, TestOutputFalse (
2401 [["write_file"; "/file1"; "contents of a file"; "0"];
2402 ["write_file"; "/file2"; "contents of another file"; "0"];
2403 ["equal"; "/file1"; "/file2"]]);
2404 InitBasicFS, Always, TestLastFail (
2405 [["equal"; "/file1"; "/file2"]])],
2406 "test if two files have equal contents",
2408 This compares the two files C<file1> and C<file2> and returns
2409 true if their content is exactly equal, or false otherwise.
2411 The external L<cmp(1)> program is used for the comparison.");
2413 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2414 [InitISOFS, Always, TestOutputList (
2415 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2416 InitISOFS, Always, TestOutputList (
2417 [["strings"; "/empty"]], [])],
2418 "print the printable strings in a file",
2420 This runs the L<strings(1)> command on a file and returns
2421 the list of printable strings found.");
2423 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2424 [InitISOFS, Always, TestOutputList (
2425 [["strings_e"; "b"; "/known-5"]], []);
2426 InitBasicFS, Disabled, TestOutputList (
2427 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2428 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2429 "print the printable strings in a file",
2431 This is like the C<guestfs_strings> command, but allows you to
2432 specify the encoding.
2434 See the L<strings(1)> manpage for the full list of encodings.
2436 Commonly useful encodings are C<l> (lower case L) which will
2437 show strings inside Windows/x86 files.
2439 The returned strings are transcoded to UTF-8.");
2441 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2442 [InitISOFS, Always, TestOutput (
2443 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2444 (* Test for RHBZ#501888c2 regression which caused large hexdump
2445 * commands to segfault.
2447 InitISOFS, Always, TestRun (
2448 [["hexdump"; "/100krandom"]])],
2449 "dump a file in hexadecimal",
2451 This runs C<hexdump -C> on the given C<path>. The result is
2452 the human-readable, canonical hex dump of the file.");
2454 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2455 [InitNone, Always, TestOutput (
2456 [["part_disk"; "/dev/sda"; "mbr"];
2457 ["mkfs"; "ext3"; "/dev/sda1"];
2458 ["mount_options"; ""; "/dev/sda1"; "/"];
2459 ["write_file"; "/new"; "test file"; "0"];
2460 ["umount"; "/dev/sda1"];
2461 ["zerofree"; "/dev/sda1"];
2462 ["mount_options"; ""; "/dev/sda1"; "/"];
2463 ["cat"; "/new"]], "test file")],
2464 "zero unused inodes and disk blocks on ext2/3 filesystem",
2466 This runs the I<zerofree> program on C<device>. This program
2467 claims to zero unused inodes and disk blocks on an ext2/3
2468 filesystem, thus making it possible to compress the filesystem
2471 You should B<not> run this program if the filesystem is
2474 It is possible that using this program can damage the filesystem
2475 or data on the filesystem.");
2477 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2479 "resize an LVM physical volume",
2481 This resizes (expands or shrinks) an existing LVM physical
2482 volume to match the new size of the underlying device.");
2484 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2485 Int "cyls"; Int "heads"; Int "sectors";
2486 String "line"]), 99, [DangerWillRobinson],
2488 "modify a single partition on a block device",
2490 This runs L<sfdisk(8)> option to modify just the single
2491 partition C<n> (note: C<n> counts from 1).
2493 For other parameters, see C<guestfs_sfdisk>. You should usually
2494 pass C<0> for the cyls/heads/sectors parameters.
2496 See also: C<guestfs_part_add>");
2498 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2500 "display the partition table",
2502 This displays the partition table on C<device>, in the
2503 human-readable output of the L<sfdisk(8)> command. It is
2504 not intended to be parsed.
2506 See also: C<guestfs_part_list>");
2508 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2510 "display the kernel geometry",
2512 This displays the kernel's idea of the geometry of C<device>.
2514 The result is in human-readable format, and not designed to
2517 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2519 "display the disk geometry from the partition table",
2521 This displays the disk geometry of C<device> read from the
2522 partition table. Especially in the case where the underlying
2523 block device has been resized, this can be different from the
2524 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2526 The result is in human-readable format, and not designed to
2529 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2531 "activate or deactivate all volume groups",
2533 This command activates or (if C<activate> is false) deactivates
2534 all logical volumes in all volume groups.
2535 If activated, then they are made known to the
2536 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2537 then those devices disappear.
2539 This command is the same as running C<vgchange -a y|n>");
2541 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2543 "activate or deactivate some volume groups",
2545 This command activates or (if C<activate> is false) deactivates
2546 all logical volumes in the listed volume groups C<volgroups>.
2547 If activated, then they are made known to the
2548 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2549 then those devices disappear.
2551 This command is the same as running C<vgchange -a y|n volgroups...>
2553 Note that if C<volgroups> is an empty list then B<all> volume groups
2554 are activated or deactivated.");
2556 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2557 [InitNone, Always, TestOutput (
2558 [["part_disk"; "/dev/sda"; "mbr"];
2559 ["pvcreate"; "/dev/sda1"];
2560 ["vgcreate"; "VG"; "/dev/sda1"];
2561 ["lvcreate"; "LV"; "VG"; "10"];
2562 ["mkfs"; "ext2"; "/dev/VG/LV"];
2563 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2564 ["write_file"; "/new"; "test content"; "0"];
2566 ["lvresize"; "/dev/VG/LV"; "20"];
2567 ["e2fsck_f"; "/dev/VG/LV"];
2568 ["resize2fs"; "/dev/VG/LV"];
2569 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2570 ["cat"; "/new"]], "test content")],
2571 "resize an LVM logical volume",
2573 This resizes (expands or shrinks) an existing LVM logical
2574 volume to C<mbytes>. When reducing, data in the reduced part
2577 ("resize2fs", (RErr, [Device "device"]), 106, [],
2578 [], (* lvresize tests this *)
2579 "resize an ext2/ext3 filesystem",
2581 This resizes an ext2 or ext3 filesystem to match the size of
2582 the underlying device.
2584 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2585 on the C<device> before calling this command. For unknown reasons
2586 C<resize2fs> sometimes gives an error about this and sometimes not.
2587 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2588 calling this function.");
2590 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2591 [InitBasicFS, Always, TestOutputList (
2592 [["find"; "/"]], ["lost+found"]);
2593 InitBasicFS, Always, TestOutputList (
2597 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2598 InitBasicFS, Always, TestOutputList (
2599 [["mkdir_p"; "/a/b/c"];
2600 ["touch"; "/a/b/c/d"];
2601 ["find"; "/a/b/"]], ["c"; "c/d"])],
2602 "find all files and directories",
2604 This command lists out all files and directories, recursively,
2605 starting at C<directory>. It is essentially equivalent to
2606 running the shell command C<find directory -print> but some
2607 post-processing happens on the output, described below.
2609 This returns a list of strings I<without any prefix>. Thus
2610 if the directory structure was:
2616 then the returned list from C<guestfs_find> C</tmp> would be
2624 If C<directory> is not a directory, then this command returns
2627 The returned list is sorted.
2629 See also C<guestfs_find0>.");
2631 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2632 [], (* lvresize tests this *)
2633 "check an ext2/ext3 filesystem",
2635 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2636 filesystem checker on C<device>, noninteractively (C<-p>),
2637 even if the filesystem appears to be clean (C<-f>).
2639 This command is only needed because of C<guestfs_resize2fs>
2640 (q.v.). Normally you should use C<guestfs_fsck>.");
2642 ("sleep", (RErr, [Int "secs"]), 109, [],
2643 [InitNone, Always, TestRun (
2645 "sleep for some seconds",
2647 Sleep for C<secs> seconds.");
2649 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2650 [InitNone, Always, TestOutputInt (
2651 [["part_disk"; "/dev/sda"; "mbr"];
2652 ["mkfs"; "ntfs"; "/dev/sda1"];
2653 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2654 InitNone, Always, TestOutputInt (
2655 [["part_disk"; "/dev/sda"; "mbr"];
2656 ["mkfs"; "ext2"; "/dev/sda1"];
2657 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2658 "probe NTFS volume",
2660 This command runs the L<ntfs-3g.probe(8)> command which probes
2661 an NTFS C<device> for mountability. (Not all NTFS volumes can
2662 be mounted read-write, and some cannot be mounted at all).
2664 C<rw> is a boolean flag. Set it to true if you want to test
2665 if the volume can be mounted read-write. Set it to false if
2666 you want to test if the volume can be mounted read-only.
2668 The return value is an integer which C<0> if the operation
2669 would succeed, or some non-zero value documented in the
2670 L<ntfs-3g.probe(8)> manual page.");
2672 ("sh", (RString "output", [String "command"]), 111, [],
2673 [], (* XXX needs tests *)
2674 "run a command via the shell",
2676 This call runs a command from the guest filesystem via the
2679 This is like C<guestfs_command>, but passes the command to:
2681 /bin/sh -c \"command\"
2683 Depending on the guest's shell, this usually results in
2684 wildcards being expanded, shell expressions being interpolated
2687 All the provisos about C<guestfs_command> apply to this call.");
2689 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2690 [], (* XXX needs tests *)
2691 "run a command via the shell returning lines",
2693 This is the same as C<guestfs_sh>, but splits the result
2694 into a list of lines.
2696 See also: C<guestfs_command_lines>");
2698 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2699 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2700 * code in stubs.c, since all valid glob patterns must start with "/".
2701 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2703 [InitBasicFS, Always, TestOutputList (
2704 [["mkdir_p"; "/a/b/c"];
2705 ["touch"; "/a/b/c/d"];
2706 ["touch"; "/a/b/c/e"];
2707 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2708 InitBasicFS, Always, TestOutputList (
2709 [["mkdir_p"; "/a/b/c"];
2710 ["touch"; "/a/b/c/d"];
2711 ["touch"; "/a/b/c/e"];
2712 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2713 InitBasicFS, Always, TestOutputList (
2714 [["mkdir_p"; "/a/b/c"];
2715 ["touch"; "/a/b/c/d"];
2716 ["touch"; "/a/b/c/e"];
2717 ["glob_expand"; "/a/*/x/*"]], [])],
2718 "expand a wildcard path",
2720 This command searches for all the pathnames matching
2721 C<pattern> according to the wildcard expansion rules
2724 If no paths match, then this returns an empty list
2725 (note: not an error).
2727 It is just a wrapper around the C L<glob(3)> function
2728 with flags C<GLOB_MARK|GLOB_BRACE>.
2729 See that manual page for more details.");
2731 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2732 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2733 [["scrub_device"; "/dev/sdc"]])],
2734 "scrub (securely wipe) a device",
2736 This command writes patterns over C<device> to make data retrieval
2739 It is an interface to the L<scrub(1)> program. See that
2740 manual page for more details.");
2742 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2743 [InitBasicFS, Always, TestRun (
2744 [["write_file"; "/file"; "content"; "0"];
2745 ["scrub_file"; "/file"]])],
2746 "scrub (securely wipe) a file",
2748 This command writes patterns over a file to make data retrieval
2751 The file is I<removed> after scrubbing.
2753 It is an interface to the L<scrub(1)> program. See that
2754 manual page for more details.");
2756 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2757 [], (* XXX needs testing *)
2758 "scrub (securely wipe) free space",
2760 This command creates the directory C<dir> and then fills it
2761 with files until the filesystem is full, and scrubs the files
2762 as for C<guestfs_scrub_file>, and deletes them.
2763 The intention is to scrub any free space on the partition
2766 It is an interface to the L<scrub(1)> program. See that
2767 manual page for more details.");
2769 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2770 [InitBasicFS, Always, TestRun (
2772 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2773 "create a temporary directory",
2775 This command creates a temporary directory. The
2776 C<template> parameter should be a full pathname for the
2777 temporary directory name with the final six characters being
2780 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2781 the second one being suitable for Windows filesystems.
2783 The name of the temporary directory that was created
2786 The temporary directory is created with mode 0700
2787 and is owned by root.
2789 The caller is responsible for deleting the temporary
2790 directory and its contents after use.
2792 See also: L<mkdtemp(3)>");
2794 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2795 [InitISOFS, Always, TestOutputInt (
2796 [["wc_l"; "/10klines"]], 10000)],
2797 "count lines in a file",
2799 This command counts the lines in a file, using the
2800 C<wc -l> external command.");
2802 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2803 [InitISOFS, Always, TestOutputInt (
2804 [["wc_w"; "/10klines"]], 10000)],
2805 "count words in a file",
2807 This command counts the words in a file, using the
2808 C<wc -w> external command.");
2810 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2811 [InitISOFS, Always, TestOutputInt (
2812 [["wc_c"; "/100kallspaces"]], 102400)],
2813 "count characters in a file",
2815 This command counts the characters in a file, using the
2816 C<wc -c> external command.");
2818 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2819 [InitISOFS, Always, TestOutputList (
2820 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2821 "return first 10 lines of a file",
2823 This command returns up to the first 10 lines of a file as
2824 a list of strings.");
2826 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2827 [InitISOFS, Always, TestOutputList (
2828 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2829 InitISOFS, Always, TestOutputList (
2830 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2831 InitISOFS, Always, TestOutputList (
2832 [["head_n"; "0"; "/10klines"]], [])],
2833 "return first N lines of a file",
2835 If the parameter C<nrlines> is a positive number, this returns the first
2836 C<nrlines> lines of the file C<path>.
2838 If the parameter C<nrlines> is a negative number, this returns lines
2839 from the file C<path>, excluding the last C<nrlines> lines.
2841 If the parameter C<nrlines> is zero, this returns an empty list.");
2843 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2844 [InitISOFS, Always, TestOutputList (
2845 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2846 "return last 10 lines of a file",
2848 This command returns up to the last 10 lines of a file as
2849 a list of strings.");
2851 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2852 [InitISOFS, Always, TestOutputList (
2853 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2854 InitISOFS, Always, TestOutputList (
2855 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2856 InitISOFS, Always, TestOutputList (
2857 [["tail_n"; "0"; "/10klines"]], [])],
2858 "return last N lines of a file",
2860 If the parameter C<nrlines> is a positive number, this returns the last
2861 C<nrlines> lines of the file C<path>.
2863 If the parameter C<nrlines> is a negative number, this returns lines
2864 from the file C<path>, starting with the C<-nrlines>th line.
2866 If the parameter C<nrlines> is zero, this returns an empty list.");
2868 ("df", (RString "output", []), 125, [],
2869 [], (* XXX Tricky to test because it depends on the exact format
2870 * of the 'df' command and other imponderables.
2872 "report file system disk space usage",
2874 This command runs the C<df> command to report disk space used.
2876 This command is mostly useful for interactive sessions. It
2877 is I<not> intended that you try to parse the output string.
2878 Use C<statvfs> from programs.");
2880 ("df_h", (RString "output", []), 126, [],
2881 [], (* XXX Tricky to test because it depends on the exact format
2882 * of the 'df' command and other imponderables.
2884 "report file system disk space usage (human readable)",
2886 This command runs the C<df -h> command to report disk space used
2887 in human-readable format.
2889 This command is mostly useful for interactive sessions. It
2890 is I<not> intended that you try to parse the output string.
2891 Use C<statvfs> from programs.");
2893 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2894 [InitISOFS, Always, TestOutputInt (
2895 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2896 "estimate file space usage",
2898 This command runs the C<du -s> command to estimate file space
2901 C<path> can be a file or a directory. If C<path> is a directory
2902 then the estimate includes the contents of the directory and all
2903 subdirectories (recursively).
2905 The result is the estimated size in I<kilobytes>
2906 (ie. units of 1024 bytes).");
2908 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2909 [InitISOFS, Always, TestOutputList (
2910 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2911 "list files in an initrd",
2913 This command lists out files contained in an initrd.
2915 The files are listed without any initial C</> character. The
2916 files are listed in the order they appear (not necessarily
2917 alphabetical). Directory names are listed as separate items.
2919 Old Linux kernels (2.4 and earlier) used a compressed ext2
2920 filesystem as initrd. We I<only> support the newer initramfs
2921 format (compressed cpio files).");
2923 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2925 "mount a file using the loop device",
2927 This command lets you mount C<file> (a filesystem image
2928 in a file) on a mount point. It is entirely equivalent to
2929 the command C<mount -o loop file mountpoint>.");
2931 ("mkswap", (RErr, [Device "device"]), 130, [],
2932 [InitEmpty, Always, TestRun (
2933 [["part_disk"; "/dev/sda"; "mbr"];
2934 ["mkswap"; "/dev/sda1"]])],
2935 "create a swap partition",
2937 Create a swap partition on C<device>.");
2939 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2940 [InitEmpty, Always, TestRun (
2941 [["part_disk"; "/dev/sda"; "mbr"];
2942 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2943 "create a swap partition with a label",
2945 Create a swap partition on C<device> with label C<label>.
2947 Note that you cannot attach a swap label to a block device
2948 (eg. C</dev/sda>), just to a partition. This appears to be
2949 a limitation of the kernel or swap tools.");
2951 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2952 (let uuid = uuidgen () in
2953 [InitEmpty, Always, TestRun (
2954 [["part_disk"; "/dev/sda"; "mbr"];
2955 ["mkswap_U"; uuid; "/dev/sda1"]])]),
2956 "create a swap partition with an explicit UUID",
2958 Create a swap partition on C<device> with UUID C<uuid>.");
2960 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2961 [InitBasicFS, Always, TestOutputStruct (
2962 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2963 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2964 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2965 InitBasicFS, Always, TestOutputStruct (
2966 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2967 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2968 "make block, character or FIFO devices",
2970 This call creates block or character special devices, or
2971 named pipes (FIFOs).
2973 The C<mode> parameter should be the mode, using the standard
2974 constants. C<devmajor> and C<devminor> are the
2975 device major and minor numbers, only used when creating block
2976 and character special devices.");
2978 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
2979 [InitBasicFS, Always, TestOutputStruct (
2980 [["mkfifo"; "0o777"; "/node"];
2981 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2982 "make FIFO (named pipe)",
2984 This call creates a FIFO (named pipe) called C<path> with
2985 mode C<mode>. It is just a convenient wrapper around
2986 C<guestfs_mknod>.");
2988 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
2989 [InitBasicFS, Always, TestOutputStruct (
2990 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2991 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2992 "make block device node",
2994 This call creates a block device node called C<path> with
2995 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2996 It is just a convenient wrapper around C<guestfs_mknod>.");
2998 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
2999 [InitBasicFS, Always, TestOutputStruct (
3000 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3001 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3002 "make char device node",
3004 This call creates a char device node called C<path> with
3005 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3006 It is just a convenient wrapper around C<guestfs_mknod>.");
3008 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
3009 [], (* XXX umask is one of those stateful things that we should
3010 * reset between each test.
3012 "set file mode creation mask (umask)",
3014 This function sets the mask used for creating new files and
3015 device nodes to C<mask & 0777>.
3017 Typical umask values would be C<022> which creates new files
3018 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3019 C<002> which creates new files with permissions like
3020 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3022 The default umask is C<022>. This is important because it
3023 means that directories and device nodes will be created with
3024 C<0644> or C<0755> mode even if you specify C<0777>.
3026 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3028 This call returns the previous umask.");
3030 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3032 "read directories entries",
3034 This returns the list of directory entries in directory C<dir>.
3036 All entries in the directory are returned, including C<.> and
3037 C<..>. The entries are I<not> sorted, but returned in the same
3038 order as the underlying filesystem.
3040 Also this call returns basic file type information about each
3041 file. The C<ftyp> field will contain one of the following characters:
3079 The L<readdir(3)> returned a C<d_type> field with an
3084 This function is primarily intended for use by programs. To
3085 get a simple list of names, use C<guestfs_ls>. To get a printable
3086 directory for human consumption, use C<guestfs_ll>.");
3088 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3090 "create partitions on a block device",
3092 This is a simplified interface to the C<guestfs_sfdisk>
3093 command, where partition sizes are specified in megabytes
3094 only (rounded to the nearest cylinder) and you don't need
3095 to specify the cyls, heads and sectors parameters which
3096 were rarely if ever used anyway.
3098 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3099 and C<guestfs_part_disk>");
3101 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3103 "determine file type inside a compressed file",
3105 This command runs C<file> after first decompressing C<path>
3108 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3110 Since 1.0.63, use C<guestfs_file> instead which can now
3111 process compressed files.");
3113 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3115 "list extended attributes of a file or directory",
3117 This call lists the extended attributes of the file or directory
3120 At the system call level, this is a combination of the
3121 L<listxattr(2)> and L<getxattr(2)> calls.
3123 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3125 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3127 "list extended attributes of a file or directory",
3129 This is the same as C<guestfs_getxattrs>, but if C<path>
3130 is a symbolic link, then it returns the extended attributes
3131 of the link itself.");
3133 ("setxattr", (RErr, [String "xattr";
3134 String "val"; Int "vallen"; (* will be BufferIn *)
3135 Pathname "path"]), 143, [Optional "linuxxattrs"],
3137 "set extended attribute of a file or directory",
3139 This call sets the extended attribute named C<xattr>
3140 of the file C<path> to the value C<val> (of length C<vallen>).
3141 The value is arbitrary 8 bit data.
3143 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3145 ("lsetxattr", (RErr, [String "xattr";
3146 String "val"; Int "vallen"; (* will be BufferIn *)
3147 Pathname "path"]), 144, [Optional "linuxxattrs"],
3149 "set extended attribute of a file or directory",
3151 This is the same as C<guestfs_setxattr>, but if C<path>
3152 is a symbolic link, then it sets an extended attribute
3153 of the link itself.");
3155 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3157 "remove extended attribute of a file or directory",
3159 This call removes the extended attribute named C<xattr>
3160 of the file C<path>.
3162 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3164 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3166 "remove extended attribute of a file or directory",
3168 This is the same as C<guestfs_removexattr>, but if C<path>
3169 is a symbolic link, then it removes an extended attribute
3170 of the link itself.");
3172 ("mountpoints", (RHashtable "mps", []), 147, [],
3176 This call is similar to C<guestfs_mounts>. That call returns
3177 a list of devices. This one returns a hash table (map) of
3178 device name to directory where the device is mounted.");
3180 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3181 (* This is a special case: while you would expect a parameter
3182 * of type "Pathname", that doesn't work, because it implies
3183 * NEED_ROOT in the generated calling code in stubs.c, and
3184 * this function cannot use NEED_ROOT.
3187 "create a mountpoint",
3189 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3190 specialized calls that can be used to create extra mountpoints
3191 before mounting the first filesystem.
3193 These calls are I<only> necessary in some very limited circumstances,
3194 mainly the case where you want to mount a mix of unrelated and/or
3195 read-only filesystems together.
3197 For example, live CDs often contain a \"Russian doll\" nest of
3198 filesystems, an ISO outer layer, with a squashfs image inside, with
3199 an ext2/3 image inside that. You can unpack this as follows
3202 add-ro Fedora-11-i686-Live.iso
3205 mkmountpoint /squash
3208 mount-loop /cd/LiveOS/squashfs.img /squash
3209 mount-loop /squash/LiveOS/ext3fs.img /ext3
3211 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3213 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3215 "remove a mountpoint",
3217 This calls removes a mountpoint that was previously created
3218 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3219 for full details.");
3221 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3222 [InitISOFS, Always, TestOutputBuffer (
3223 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3226 This calls returns the contents of the file C<path> as a
3229 Unlike C<guestfs_cat>, this function can correctly
3230 handle files that contain embedded ASCII NUL characters.
3231 However unlike C<guestfs_download>, this function is limited
3232 in the total size of file that can be handled.");
3234 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3235 [InitISOFS, Always, TestOutputList (
3236 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3237 InitISOFS, Always, TestOutputList (
3238 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3239 "return lines matching a pattern",
3241 This calls the external C<grep> program and returns the
3244 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3245 [InitISOFS, Always, TestOutputList (
3246 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3247 "return lines matching a pattern",
3249 This calls the external C<egrep> program and returns the
3252 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3253 [InitISOFS, Always, TestOutputList (
3254 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3255 "return lines matching a pattern",
3257 This calls the external C<fgrep> program and returns the
3260 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3261 [InitISOFS, Always, TestOutputList (
3262 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3263 "return lines matching a pattern",
3265 This calls the external C<grep -i> program and returns the
3268 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3269 [InitISOFS, Always, TestOutputList (
3270 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3271 "return lines matching a pattern",
3273 This calls the external C<egrep -i> program and returns the
3276 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3277 [InitISOFS, Always, TestOutputList (
3278 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3279 "return lines matching a pattern",
3281 This calls the external C<fgrep -i> program and returns the
3284 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3285 [InitISOFS, Always, TestOutputList (
3286 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3287 "return lines matching a pattern",
3289 This calls the external C<zgrep> program and returns the
3292 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3293 [InitISOFS, Always, TestOutputList (
3294 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3295 "return lines matching a pattern",
3297 This calls the external C<zegrep> program and returns the
3300 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3301 [InitISOFS, Always, TestOutputList (
3302 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3303 "return lines matching a pattern",
3305 This calls the external C<zfgrep> program and returns the
3308 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3309 [InitISOFS, Always, TestOutputList (
3310 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3311 "return lines matching a pattern",
3313 This calls the external C<zgrep -i> program and returns the
3316 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3317 [InitISOFS, Always, TestOutputList (
3318 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3319 "return lines matching a pattern",
3321 This calls the external C<zegrep -i> program and returns the
3324 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3325 [InitISOFS, Always, TestOutputList (
3326 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3327 "return lines matching a pattern",
3329 This calls the external C<zfgrep -i> program and returns the
3332 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3333 [InitISOFS, Always, TestOutput (
3334 [["realpath"; "/../directory"]], "/directory")],
3335 "canonicalized absolute pathname",
3337 Return the canonicalized absolute pathname of C<path>. The
3338 returned path has no C<.>, C<..> or symbolic link path elements.");
3340 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3341 [InitBasicFS, Always, TestOutputStruct (
3344 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3345 "create a hard link",
3347 This command creates a hard link using the C<ln> command.");
3349 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3350 [InitBasicFS, Always, TestOutputStruct (
3353 ["ln_f"; "/a"; "/b"];
3354 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3355 "create a hard link",
3357 This command creates a hard link using the C<ln -f> command.
3358 The C<-f> option removes the link (C<linkname>) if it exists already.");
3360 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3361 [InitBasicFS, Always, TestOutputStruct (
3363 ["ln_s"; "a"; "/b"];
3364 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3365 "create a symbolic link",
3367 This command creates a symbolic link using the C<ln -s> command.");
3369 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3370 [InitBasicFS, Always, TestOutput (
3371 [["mkdir_p"; "/a/b"];
3372 ["touch"; "/a/b/c"];
3373 ["ln_sf"; "../d"; "/a/b/c"];
3374 ["readlink"; "/a/b/c"]], "../d")],
3375 "create a symbolic link",
3377 This command creates a symbolic link using the C<ln -sf> command,
3378 The C<-f> option removes the link (C<linkname>) if it exists already.");
3380 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3381 [] (* XXX tested above *),
3382 "read the target of a symbolic link",
3384 This command reads the target of a symbolic link.");
3386 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3387 [InitBasicFS, Always, TestOutputStruct (
3388 [["fallocate"; "/a"; "1000000"];
3389 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3390 "preallocate a file in the guest filesystem",
3392 This command preallocates a file (containing zero bytes) named
3393 C<path> of size C<len> bytes. If the file exists already, it
3396 Do not confuse this with the guestfish-specific
3397 C<alloc> command which allocates a file in the host and
3398 attaches it as a device.");
3400 ("swapon_device", (RErr, [Device "device"]), 170, [],
3401 [InitPartition, Always, TestRun (
3402 [["mkswap"; "/dev/sda1"];
3403 ["swapon_device"; "/dev/sda1"];
3404 ["swapoff_device"; "/dev/sda1"]])],
3405 "enable swap on device",
3407 This command enables the libguestfs appliance to use the
3408 swap device or partition named C<device>. The increased
3409 memory is made available for all commands, for example
3410 those run using C<guestfs_command> or C<guestfs_sh>.
3412 Note that you should not swap to existing guest swap
3413 partitions unless you know what you are doing. They may
3414 contain hibernation information, or other information that
3415 the guest doesn't want you to trash. You also risk leaking
3416 information about the host to the guest this way. Instead,
3417 attach a new host device to the guest and swap on that.");
3419 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3420 [], (* XXX tested by swapon_device *)
3421 "disable swap on device",
3423 This command disables the libguestfs appliance swap
3424 device or partition named C<device>.
3425 See C<guestfs_swapon_device>.");
3427 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3428 [InitBasicFS, Always, TestRun (
3429 [["fallocate"; "/swap"; "8388608"];
3430 ["mkswap_file"; "/swap"];
3431 ["swapon_file"; "/swap"];
3432 ["swapoff_file"; "/swap"]])],
3433 "enable swap on file",
3435 This command enables swap to a file.
3436 See C<guestfs_swapon_device> for other notes.");
3438 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3439 [], (* XXX tested by swapon_file *)
3440 "disable swap on file",
3442 This command disables the libguestfs appliance swap on file.");
3444 ("swapon_label", (RErr, [String "label"]), 174, [],
3445 [InitEmpty, Always, TestRun (
3446 [["part_disk"; "/dev/sdb"; "mbr"];
3447 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3448 ["swapon_label"; "swapit"];
3449 ["swapoff_label"; "swapit"];
3450 ["zero"; "/dev/sdb"];
3451 ["blockdev_rereadpt"; "/dev/sdb"]])],
3452 "enable swap on labeled swap partition",
3454 This command enables swap to a labeled swap partition.
3455 See C<guestfs_swapon_device> for other notes.");
3457 ("swapoff_label", (RErr, [String "label"]), 175, [],
3458 [], (* XXX tested by swapon_label *)
3459 "disable swap on labeled swap partition",
3461 This command disables the libguestfs appliance swap on
3462 labeled swap partition.");
3464 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3465 (let uuid = uuidgen () in
3466 [InitEmpty, Always, TestRun (
3467 [["mkswap_U"; uuid; "/dev/sdb"];
3468 ["swapon_uuid"; uuid];
3469 ["swapoff_uuid"; uuid]])]),
3470 "enable swap on swap partition by UUID",
3472 This command enables swap to a swap partition with the given UUID.
3473 See C<guestfs_swapon_device> for other notes.");
3475 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3476 [], (* XXX tested by swapon_uuid *)
3477 "disable swap on swap partition by UUID",
3479 This command disables the libguestfs appliance swap partition
3480 with the given UUID.");
3482 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3483 [InitBasicFS, Always, TestRun (
3484 [["fallocate"; "/swap"; "8388608"];
3485 ["mkswap_file"; "/swap"]])],
3486 "create a swap file",
3490 This command just writes a swap file signature to an existing
3491 file. To create the file itself, use something like C<guestfs_fallocate>.");
3493 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3494 [InitISOFS, Always, TestRun (
3495 [["inotify_init"; "0"]])],
3496 "create an inotify handle",
3498 This command creates a new inotify handle.
3499 The inotify subsystem can be used to notify events which happen to
3500 objects in the guest filesystem.
3502 C<maxevents> is the maximum number of events which will be
3503 queued up between calls to C<guestfs_inotify_read> or
3504 C<guestfs_inotify_files>.
3505 If this is passed as C<0>, then the kernel (or previously set)
3506 default is used. For Linux 2.6.29 the default was 16384 events.
3507 Beyond this limit, the kernel throws away events, but records
3508 the fact that it threw them away by setting a flag
3509 C<IN_Q_OVERFLOW> in the returned structure list (see
3510 C<guestfs_inotify_read>).
3512 Before any events are generated, you have to add some
3513 watches to the internal watch list. See:
3514 C<guestfs_inotify_add_watch>,
3515 C<guestfs_inotify_rm_watch> and
3516 C<guestfs_inotify_watch_all>.
3518 Queued up events should be read periodically by calling
3519 C<guestfs_inotify_read>
3520 (or C<guestfs_inotify_files> which is just a helpful
3521 wrapper around C<guestfs_inotify_read>). If you don't
3522 read the events out often enough then you risk the internal
3525 The handle should be closed after use by calling
3526 C<guestfs_inotify_close>. This also removes any
3527 watches automatically.
3529 See also L<inotify(7)> for an overview of the inotify interface
3530 as exposed by the Linux kernel, which is roughly what we expose
3531 via libguestfs. Note that there is one global inotify handle
3532 per libguestfs instance.");
3534 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3535 [InitBasicFS, Always, TestOutputList (
3536 [["inotify_init"; "0"];
3537 ["inotify_add_watch"; "/"; "1073741823"];
3540 ["inotify_files"]], ["a"; "b"])],
3541 "add an inotify watch",
3543 Watch C<path> for the events listed in C<mask>.
3545 Note that if C<path> is a directory then events within that
3546 directory are watched, but this does I<not> happen recursively
3547 (in subdirectories).
3549 Note for non-C or non-Linux callers: the inotify events are
3550 defined by the Linux kernel ABI and are listed in
3551 C</usr/include/sys/inotify.h>.");
3553 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3555 "remove an inotify watch",
3557 Remove a previously defined inotify watch.
3558 See C<guestfs_inotify_add_watch>.");
3560 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3562 "return list of inotify events",
3564 Return the complete queue of events that have happened
3565 since the previous read call.
3567 If no events have happened, this returns an empty list.
3569 I<Note>: In order to make sure that all events have been
3570 read, you must call this function repeatedly until it
3571 returns an empty list. The reason is that the call will
3572 read events up to the maximum appliance-to-host message
3573 size and leave remaining events in the queue.");
3575 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3577 "return list of watched files that had events",
3579 This function is a helpful wrapper around C<guestfs_inotify_read>
3580 which just returns a list of pathnames of objects that were
3581 touched. The returned pathnames are sorted and deduplicated.");
3583 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3585 "close the inotify handle",
3587 This closes the inotify handle which was previously
3588 opened by inotify_init. It removes all watches, throws
3589 away any pending events, and deallocates all resources.");
3591 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3593 "set SELinux security context",
3595 This sets the SELinux security context of the daemon
3596 to the string C<context>.
3598 See the documentation about SELINUX in L<guestfs(3)>.");
3600 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3602 "get SELinux security context",
3604 This gets the SELinux security context of the daemon.
3606 See the documentation about SELINUX in L<guestfs(3)>,
3607 and C<guestfs_setcon>");
3609 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3610 [InitEmpty, Always, TestOutput (
3611 [["part_disk"; "/dev/sda"; "mbr"];
3612 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3613 ["mount_options"; ""; "/dev/sda1"; "/"];
3614 ["write_file"; "/new"; "new file contents"; "0"];
3615 ["cat"; "/new"]], "new file contents")],
3616 "make a filesystem with block size",
3618 This call is similar to C<guestfs_mkfs>, but it allows you to
3619 control the block size of the resulting filesystem. Supported
3620 block sizes depend on the filesystem type, but typically they
3621 are C<1024>, C<2048> or C<4096> only.");
3623 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3624 [InitEmpty, Always, TestOutput (
3625 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3626 ["mke2journal"; "4096"; "/dev/sda1"];
3627 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3628 ["mount_options"; ""; "/dev/sda2"; "/"];
3629 ["write_file"; "/new"; "new file contents"; "0"];
3630 ["cat"; "/new"]], "new file contents")],
3631 "make ext2/3/4 external journal",
3633 This creates an ext2 external journal on C<device>. It is equivalent
3636 mke2fs -O journal_dev -b blocksize device");
3638 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3639 [InitEmpty, Always, TestOutput (
3640 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3641 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3642 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3643 ["mount_options"; ""; "/dev/sda2"; "/"];
3644 ["write_file"; "/new"; "new file contents"; "0"];
3645 ["cat"; "/new"]], "new file contents")],
3646 "make ext2/3/4 external journal with label",
3648 This creates an ext2 external journal on C<device> with label C<label>.");
3650 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3651 (let uuid = uuidgen () in
3652 [InitEmpty, Always, TestOutput (
3653 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3654 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3655 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3656 ["mount_options"; ""; "/dev/sda2"; "/"];
3657 ["write_file"; "/new"; "new file contents"; "0"];
3658 ["cat"; "/new"]], "new file contents")]),
3659 "make ext2/3/4 external journal with UUID",
3661 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3663 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3665 "make ext2/3/4 filesystem with external journal",
3667 This creates an ext2/3/4 filesystem on C<device> with
3668 an external journal on C<journal>. It is equivalent
3671 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3673 See also C<guestfs_mke2journal>.");
3675 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3677 "make ext2/3/4 filesystem with external journal",
3679 This creates an ext2/3/4 filesystem on C<device> with
3680 an external journal on the journal labeled C<label>.
3682 See also C<guestfs_mke2journal_L>.");
3684 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3686 "make ext2/3/4 filesystem with external journal",
3688 This creates an ext2/3/4 filesystem on C<device> with
3689 an external journal on the journal with UUID C<uuid>.
3691 See also C<guestfs_mke2journal_U>.");
3693 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3694 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3695 "load a kernel module",
3697 This loads a kernel module in the appliance.
3699 The kernel module must have been whitelisted when libguestfs
3700 was built (see C<appliance/kmod.whitelist.in> in the source).");
3702 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3703 [InitNone, Always, TestOutput (
3704 [["echo_daemon"; "This is a test"]], "This is a test"
3706 "echo arguments back to the client",
3708 This command concatenate the list of C<words> passed with single spaces between
3709 them and returns the resulting string.
3711 You can use this command to test the connection through to the daemon.
3713 See also C<guestfs_ping_daemon>.");
3715 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3716 [], (* There is a regression test for this. *)
3717 "find all files and directories, returning NUL-separated list",
3719 This command lists out all files and directories, recursively,
3720 starting at C<directory>, placing the resulting list in the
3721 external file called C<files>.
3723 This command works the same way as C<guestfs_find> with the
3724 following exceptions:
3730 The resulting list is written to an external file.
3734 Items (filenames) in the result are separated
3735 by C<\\0> characters. See L<find(1)> option I<-print0>.
3739 This command is not limited in the number of names that it
3744 The result list is not sorted.
3748 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3749 [InitISOFS, Always, TestOutput (
3750 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3751 InitISOFS, Always, TestOutput (
3752 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3753 InitISOFS, Always, TestOutput (
3754 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3755 InitISOFS, Always, TestLastFail (
3756 [["case_sensitive_path"; "/Known-1/"]]);
3757 InitBasicFS, Always, TestOutput (
3759 ["mkdir"; "/a/bbb"];
3760 ["touch"; "/a/bbb/c"];
3761 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3762 InitBasicFS, Always, TestOutput (
3764 ["mkdir"; "/a/bbb"];
3765 ["touch"; "/a/bbb/c"];
3766 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3767 InitBasicFS, Always, TestLastFail (
3769 ["mkdir"; "/a/bbb"];
3770 ["touch"; "/a/bbb/c"];
3771 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3772 "return true path on case-insensitive filesystem",
3774 This can be used to resolve case insensitive paths on
3775 a filesystem which is case sensitive. The use case is
3776 to resolve paths which you have read from Windows configuration
3777 files or the Windows Registry, to the true path.
3779 The command handles a peculiarity of the Linux ntfs-3g
3780 filesystem driver (and probably others), which is that although
3781 the underlying filesystem is case-insensitive, the driver
3782 exports the filesystem to Linux as case-sensitive.
3784 One consequence of this is that special directories such
3785 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3786 (or other things) depending on the precise details of how
3787 they were created. In Windows itself this would not be
3790 Bug or feature? You decide:
3791 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3793 This function resolves the true case of each element in the
3794 path and returns the case-sensitive path.
3796 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3797 might return C<\"/WINDOWS/system32\"> (the exact return value
3798 would depend on details of how the directories were originally
3799 created under Windows).
3802 This function does not handle drive names, backslashes etc.
3804 See also C<guestfs_realpath>.");
3806 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3807 [InitBasicFS, Always, TestOutput (
3808 [["vfs_type"; "/dev/sda1"]], "ext2")],
3809 "get the Linux VFS type corresponding to a mounted device",
3811 This command gets the block device type corresponding to
3812 a mounted device called C<device>.
3814 Usually the result is the name of the Linux VFS module that
3815 is used to mount this device (probably determined automatically
3816 if you used the C<guestfs_mount> call).");
3818 ("truncate", (RErr, [Pathname "path"]), 199, [],
3819 [InitBasicFS, Always, TestOutputStruct (
3820 [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3821 ["truncate"; "/test"];
3822 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3823 "truncate a file to zero size",
3825 This command truncates C<path> to a zero-length file. The
3826 file must exist already.");
3828 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3829 [InitBasicFS, Always, TestOutputStruct (
3830 [["touch"; "/test"];
3831 ["truncate_size"; "/test"; "1000"];
3832 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3833 "truncate a file to a particular size",
3835 This command truncates C<path> to size C<size> bytes. The file
3836 must exist already. If the file is smaller than C<size> then
3837 the file is extended to the required size with null bytes.");
3839 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3840 [InitBasicFS, Always, TestOutputStruct (
3841 [["touch"; "/test"];
3842 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3843 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3844 "set timestamp of a file with nanosecond precision",
3846 This command sets the timestamps of a file with nanosecond
3849 C<atsecs, atnsecs> are the last access time (atime) in secs and
3850 nanoseconds from the epoch.
3852 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3853 secs and nanoseconds from the epoch.
3855 If the C<*nsecs> field contains the special value C<-1> then
3856 the corresponding timestamp is set to the current time. (The
3857 C<*secs> field is ignored in this case).
3859 If the C<*nsecs> field contains the special value C<-2> then
3860 the corresponding timestamp is left unchanged. (The
3861 C<*secs> field is ignored in this case).");
3863 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3864 [InitBasicFS, Always, TestOutputStruct (
3865 [["mkdir_mode"; "/test"; "0o111"];
3866 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3867 "create a directory with a particular mode",
3869 This command creates a directory, setting the initial permissions
3870 of the directory to C<mode>. See also C<guestfs_mkdir>.");
3872 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3874 "change file owner and group",
3876 Change the file owner to C<owner> and group to C<group>.
3877 This is like C<guestfs_chown> but if C<path> is a symlink then
3878 the link itself is changed, not the target.
3880 Only numeric uid and gid are supported. If you want to use
3881 names, you will need to locate and parse the password file
3882 yourself (Augeas support makes this relatively easy).");
3884 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3886 "lstat on multiple files",
3888 This call allows you to perform the C<guestfs_lstat> operation
3889 on multiple files, where all files are in the directory C<path>.
3890 C<names> is the list of files from this directory.
3892 On return you get a list of stat structs, with a one-to-one
3893 correspondence to the C<names> list. If any name did not exist
3894 or could not be lstat'd, then the C<ino> field of that structure
3897 This call is intended for programs that want to efficiently
3898 list a directory contents without making many round-trips.
3899 See also C<guestfs_lxattrlist> for a similarly efficient call
3900 for getting extended attributes. Very long directory listings
3901 might cause the protocol message size to be exceeded, causing
3902 this call to fail. The caller must split up such requests
3903 into smaller groups of names.");
3905 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3907 "lgetxattr on multiple files",
3909 This call allows you to get the extended attributes
3910 of multiple files, where all files are in the directory C<path>.
3911 C<names> is the list of files from this directory.
3913 On return you get a flat list of xattr structs which must be
3914 interpreted sequentially. The first xattr struct always has a zero-length
3915 C<attrname>. C<attrval> in this struct is zero-length
3916 to indicate there was an error doing C<lgetxattr> for this
3917 file, I<or> is a C string which is a decimal number
3918 (the number of following attributes for this file, which could
3919 be C<\"0\">). Then after the first xattr struct are the
3920 zero or more attributes for the first named file.
3921 This repeats for the second and subsequent files.
3923 This call is intended for programs that want to efficiently
3924 list a directory contents without making many round-trips.
3925 See also C<guestfs_lstatlist> for a similarly efficient call
3926 for getting standard stats. Very long directory listings
3927 might cause the protocol message size to be exceeded, causing
3928 this call to fail. The caller must split up such requests
3929 into smaller groups of names.");
3931 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3933 "readlink on multiple files",
3935 This call allows you to do a C<readlink> operation
3936 on multiple files, where all files are in the directory C<path>.
3937 C<names> is the list of files from this directory.
3939 On return you get a list of strings, with a one-to-one
3940 correspondence to the C<names> list. Each string is the
3941 value of the symbol link.
3943 If the C<readlink(2)> operation fails on any name, then
3944 the corresponding result string is the empty string C<\"\">.
3945 However the whole operation is completed even if there
3946 were C<readlink(2)> errors, and so you can call this
3947 function with names where you don't know if they are
3948 symbolic links already (albeit slightly less efficient).
3950 This call is intended for programs that want to efficiently
3951 list a directory contents without making many round-trips.
3952 Very long directory listings might cause the protocol
3953 message size to be exceeded, causing
3954 this call to fail. The caller must split up such requests
3955 into smaller groups of names.");
3957 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3958 [InitISOFS, Always, TestOutputBuffer (
3959 [["pread"; "/known-4"; "1"; "3"]], "\n");
3960 InitISOFS, Always, TestOutputBuffer (
3961 [["pread"; "/empty"; "0"; "100"]], "")],
3962 "read part of a file",
3964 This command lets you read part of a file. It reads C<count>
3965 bytes of the file, starting at C<offset>, from file C<path>.
3967 This may read fewer bytes than requested. For further details
3968 see the L<pread(2)> system call.");
3970 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3971 [InitEmpty, Always, TestRun (
3972 [["part_init"; "/dev/sda"; "gpt"]])],
3973 "create an empty partition table",
3975 This creates an empty partition table on C<device> of one of the
3976 partition types listed below. Usually C<parttype> should be
3977 either C<msdos> or C<gpt> (for large disks).
3979 Initially there are no partitions. Following this, you should
3980 call C<guestfs_part_add> for each partition required.
3982 Possible values for C<parttype> are:
3986 =item B<efi> | B<gpt>
3988 Intel EFI / GPT partition table.
3990 This is recommended for >= 2 TB partitions that will be accessed
3991 from Linux and Intel-based Mac OS X. It also has limited backwards
3992 compatibility with the C<mbr> format.
3994 =item B<mbr> | B<msdos>
3996 The standard PC \"Master Boot Record\" (MBR) format used
3997 by MS-DOS and Windows. This partition type will B<only> work
3998 for device sizes up to 2 TB. For large disks we recommend
4003 Other partition table types that may work but are not
4012 =item B<amiga> | B<rdb>
4014 Amiga \"Rigid Disk Block\" format.
4022 DASD, used on IBM mainframes.
4030 Old Mac partition format. Modern Macs use C<gpt>.
4034 NEC PC-98 format, common in Japan apparently.
4042 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4043 [InitEmpty, Always, TestRun (
4044 [["part_init"; "/dev/sda"; "mbr"];
4045 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4046 InitEmpty, Always, TestRun (
4047 [["part_init"; "/dev/sda"; "gpt"];
4048 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4049 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4050 InitEmpty, Always, TestRun (
4051 [["part_init"; "/dev/sda"; "mbr"];
4052 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4053 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4054 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4055 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4056 "add a partition to the device",
4058 This command adds a partition to C<device>. If there is no partition
4059 table on the device, call C<guestfs_part_init> first.
4061 The C<prlogex> parameter is the type of partition. Normally you
4062 should pass C<p> or C<primary> here, but MBR partition tables also
4063 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4066 C<startsect> and C<endsect> are the start and end of the partition
4067 in I<sectors>. C<endsect> may be negative, which means it counts
4068 backwards from the end of the disk (C<-1> is the last sector).
4070 Creating a partition which covers the whole disk is not so easy.
4071 Use C<guestfs_part_disk> to do that.");
4073 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4074 [InitEmpty, Always, TestRun (
4075 [["part_disk"; "/dev/sda"; "mbr"]]);
4076 InitEmpty, Always, TestRun (
4077 [["part_disk"; "/dev/sda"; "gpt"]])],
4078 "partition whole disk with a single primary partition",
4080 This command is simply a combination of C<guestfs_part_init>
4081 followed by C<guestfs_part_add> to create a single primary partition
4082 covering the whole disk.
4084 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4085 but other possible values are described in C<guestfs_part_init>.");
4087 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4088 [InitEmpty, Always, TestRun (
4089 [["part_disk"; "/dev/sda"; "mbr"];
4090 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4091 "make a partition bootable",
4093 This sets the bootable flag on partition numbered C<partnum> on
4094 device C<device>. Note that partitions are numbered from 1.
4096 The bootable flag is used by some PC BIOSes to determine which
4097 partition to boot from. It is by no means universally recognized,
4098 and in any case if your operating system installed a boot
4099 sector on the device itself, then that takes precedence.");
4101 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4102 [InitEmpty, Always, TestRun (
4103 [["part_disk"; "/dev/sda"; "gpt"];
4104 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4105 "set partition name",
4107 This sets the partition name on partition numbered C<partnum> on
4108 device C<device>. Note that partitions are numbered from 1.
4110 The partition name can only be set on certain types of partition
4111 table. This works on C<gpt> but not on C<mbr> partitions.");
4113 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4114 [], (* XXX Add a regression test for this. *)
4115 "list partitions on a device",
4117 This command parses the partition table on C<device> and
4118 returns the list of partitions found.
4120 The fields in the returned structure are:
4126 Partition number, counting from 1.
4130 Start of the partition I<in bytes>. To get sectors you have to
4131 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4135 End of the partition in bytes.
4139 Size of the partition in bytes.
4143 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4144 [InitEmpty, Always, TestOutput (
4145 [["part_disk"; "/dev/sda"; "gpt"];
4146 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4147 "get the partition table type",
4149 This command examines the partition table on C<device> and
4150 returns the partition table type (format) being used.
4152 Common return values include: C<msdos> (a DOS/Windows style MBR
4153 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4154 values are possible, although unusual. See C<guestfs_part_init>
4157 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4158 [InitBasicFS, Always, TestOutputBuffer (
4159 [["fill"; "0x63"; "10"; "/test"];
4160 ["read_file"; "/test"]], "cccccccccc")],
4161 "fill a file with octets",
4163 This command creates a new file called C<path>. The initial
4164 content of the file is C<len> octets of C<c>, where C<c>
4165 must be a number in the range C<[0..255]>.
4167 To fill a file with zero bytes (sparsely), it is
4168 much more efficient to use C<guestfs_truncate_size>.");
4170 ("available", (RErr, [StringList "groups"]), 216, [],
4171 [InitNone, Always, TestRun [["available"; ""]]],
4172 "test availability of some parts of the API",
4174 This command is used to check the availability of some
4175 groups of functionality in the appliance, which not all builds of
4176 the libguestfs appliance will be able to provide.
4178 The libguestfs groups, and the functions that those
4179 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4181 The argument C<groups> is a list of group names, eg:
4182 C<[\"inotify\", \"augeas\"]> would check for the availability of
4183 the Linux inotify functions and Augeas (configuration file
4186 The command returns no error if I<all> requested groups are available.
4188 It fails with an error if one or more of the requested
4189 groups is unavailable in the appliance.
4191 If an unknown group name is included in the
4192 list of groups then an error is always returned.
4200 You must call C<guestfs_launch> before calling this function.
4202 The reason is because we don't know what groups are
4203 supported by the appliance/daemon until it is running and can
4208 If a group of functions is available, this does not necessarily
4209 mean that they will work. You still have to check for errors
4210 when calling individual API functions even if they are
4215 It is usually the job of distro packagers to build
4216 complete functionality into the libguestfs appliance.
4217 Upstream libguestfs, if built from source with all
4218 requirements satisfied, will support everything.
4222 This call was added in version C<1.0.80>. In previous
4223 versions of libguestfs all you could do would be to speculatively
4224 execute a command to find out if the daemon implemented it.
4225 See also C<guestfs_version>.
4229 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4230 [InitBasicFS, Always, TestOutputBuffer (
4231 [["write_file"; "/src"; "hello, world"; "0"];
4232 ["dd"; "/src"; "/dest"];
4233 ["read_file"; "/dest"]], "hello, world")],
4234 "copy from source to destination using dd",
4236 This command copies from one source device or file C<src>
4237 to another destination device or file C<dest>. Normally you
4238 would use this to copy to or from a device or partition, for
4239 example to duplicate a filesystem.
4241 If the destination is a device, it must be as large or larger
4242 than the source file or device, otherwise the copy will fail.
4243 This command cannot do partial copies (see C<guestfs_copy_size>).");
4245 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4246 [InitBasicFS, Always, TestOutputInt (
4247 [["write_file"; "/file"; "hello, world"; "0"];
4248 ["filesize"; "/file"]], 12)],
4249 "return the size of the file in bytes",
4251 This command returns the size of C<file> in bytes.
4253 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4254 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4255 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4257 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4258 [InitBasicFSonLVM, Always, TestOutputList (
4259 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4260 ["lvs"]], ["/dev/VG/LV2"])],
4261 "rename an LVM logical volume",
4263 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4265 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4266 [InitBasicFSonLVM, Always, TestOutputList (
4268 ["vg_activate"; "false"; "VG"];
4269 ["vgrename"; "VG"; "VG2"];
4270 ["vg_activate"; "true"; "VG2"];
4271 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4272 ["vgs"]], ["VG2"])],
4273 "rename an LVM volume group",
4275 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4277 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4278 [InitISOFS, Always, TestOutputBuffer (
4279 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4280 "list the contents of a single file in an initrd",
4282 This command unpacks the file C<filename> from the initrd file
4283 called C<initrdpath>. The filename must be given I<without> the
4284 initial C</> character.
4286 For example, in guestfish you could use the following command
4287 to examine the boot script (usually called C</init>)
4288 contained in a Linux initrd or initramfs image:
4290 initrd-cat /boot/initrd-<version>.img init
4292 See also C<guestfs_initrd_list>.");
4294 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4296 "get the UUID of a physical volume",
4298 This command returns the UUID of the LVM PV C<device>.");
4300 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4302 "get the UUID of a volume group",
4304 This command returns the UUID of the LVM VG named C<vgname>.");
4306 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4308 "get the UUID of a logical volume",
4310 This command returns the UUID of the LVM LV C<device>.");
4312 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4314 "get the PV UUIDs containing the volume group",
4316 Given a VG called C<vgname>, this returns the UUIDs of all
4317 the physical volumes that this volume group resides on.
4319 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4320 calls to associate physical volumes and volume groups.
4322 See also C<guestfs_vglvuuids>.");
4324 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4326 "get the LV UUIDs of all LVs in the volume group",
4328 Given a VG called C<vgname>, this returns the UUIDs of all
4329 the logical volumes created in this volume group.
4331 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4332 calls to associate logical volumes and volume groups.
4334 See also C<guestfs_vgpvuuids>.");
4336 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4337 [InitBasicFS, Always, TestOutputBuffer (
4338 [["write_file"; "/src"; "hello, world"; "0"];
4339 ["copy_size"; "/src"; "/dest"; "5"];
4340 ["read_file"; "/dest"]], "hello")],
4341 "copy size bytes from source to destination using dd",
4343 This command copies exactly C<size> bytes from one source device
4344 or file C<src> to another destination device or file C<dest>.
4346 Note this will fail if the source is too short or if the destination
4347 is not large enough.");
4351 let all_functions = non_daemon_functions @ daemon_functions
4353 (* In some places we want the functions to be displayed sorted
4354 * alphabetically, so this is useful:
4356 let all_functions_sorted =
4357 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4358 compare n1 n2) all_functions
4360 (* Field types for structures. *)
4362 | FChar (* C 'char' (really, a 7 bit byte). *)
4363 | FString (* nul-terminated ASCII string, NOT NULL. *)
4364 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4369 | FBytes (* Any int measure that counts bytes. *)
4370 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4371 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4373 (* Because we generate extra parsing code for LVM command line tools,
4374 * we have to pull out the LVM columns separately here.
4384 "pv_attr", FString (* XXX *);
4385 "pv_pe_count", FInt64;
4386 "pv_pe_alloc_count", FInt64;
4389 "pv_mda_count", FInt64;
4390 "pv_mda_free", FBytes;
4391 (* Not in Fedora 10:
4392 "pv_mda_size", FBytes;
4399 "vg_attr", FString (* XXX *);
4402 "vg_sysid", FString;
4403 "vg_extent_size", FBytes;
4404 "vg_extent_count", FInt64;
4405 "vg_free_count", FInt64;
4410 "snap_count", FInt64;
4413 "vg_mda_count", FInt64;
4414 "vg_mda_free", FBytes;
4415 (* Not in Fedora 10:
4416 "vg_mda_size", FBytes;
4422 "lv_attr", FString (* XXX *);
4425 "lv_kernel_major", FInt64;
4426 "lv_kernel_minor", FInt64;
4428 "seg_count", FInt64;
4430 "snap_percent", FOptPercent;
4431 "copy_percent", FOptPercent;
4434 "mirror_log", FString;
4438 (* Names and fields in all structures (in RStruct and RStructList)
4442 (* The old RIntBool return type, only ever used for aug_defnode. Do
4443 * not use this struct in any new code.
4446 "i", FInt32; (* for historical compatibility *)
4447 "b", FInt32; (* for historical compatibility *)
4450 (* LVM PVs, VGs, LVs. *)
4451 "lvm_pv", lvm_pv_cols;
4452 "lvm_vg", lvm_vg_cols;
4453 "lvm_lv", lvm_lv_cols;
4455 (* Column names and types from stat structures.
4456 * NB. Can't use things like 'st_atime' because glibc header files
4457 * define some of these as macros. Ugh.
4488 (* Column names in dirent structure. *)
4491 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4496 (* Version numbers. *)
4504 (* Extended attribute. *)
4506 "attrname", FString;
4510 (* Inotify events. *)
4514 "in_cookie", FUInt32;
4518 (* Partition table entry. *)
4521 "part_start", FBytes;
4523 "part_size", FBytes;
4525 ] (* end of structs *)
4527 (* Ugh, Java has to be different ..
4528 * These names are also used by the Haskell bindings.
4530 let java_structs = [
4531 "int_bool", "IntBool";
4536 "statvfs", "StatVFS";
4538 "version", "Version";
4540 "inotify_event", "INotifyEvent";
4541 "partition", "Partition";
4544 (* What structs are actually returned. *)
4545 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4547 (* Returns a list of RStruct/RStructList structs that are returned
4548 * by any function. Each element of returned list is a pair:
4550 * (structname, RStructOnly)
4551 * == there exists function which returns RStruct (_, structname)
4552 * (structname, RStructListOnly)
4553 * == there exists function which returns RStructList (_, structname)
4554 * (structname, RStructAndList)
4555 * == there are functions returning both RStruct (_, structname)
4556 * and RStructList (_, structname)
4558 let rstructs_used_by functions =
4559 (* ||| is a "logical OR" for rstructs_used_t *)
4563 | _, RStructAndList -> RStructAndList
4564 | RStructOnly, RStructListOnly
4565 | RStructListOnly, RStructOnly -> RStructAndList
4566 | RStructOnly, RStructOnly -> RStructOnly
4567 | RStructListOnly, RStructListOnly -> RStructListOnly
4570 let h = Hashtbl.create 13 in
4572 (* if elem->oldv exists, update entry using ||| operator,
4573 * else just add elem->newv to the hash
4575 let update elem newv =
4576 try let oldv = Hashtbl.find h elem in
4577 Hashtbl.replace h elem (newv ||| oldv)
4578 with Not_found -> Hashtbl.add h elem newv
4582 fun (_, style, _, _, _, _, _) ->
4583 match fst style with
4584 | RStruct (_, structname) -> update structname RStructOnly
4585 | RStructList (_, structname) -> update structname RStructListOnly
4589 (* return key->values as a list of (key,value) *)
4590 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4592 (* Used for testing language bindings. *)
4594 | CallString of string
4595 | CallOptString of string option
4596 | CallStringList of string list
4598 | CallInt64 of int64
4601 (* Used to memoize the result of pod2text. *)
4602 let pod2text_memo_filename = "src/.pod2text.data"
4603 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4605 let chan = open_in pod2text_memo_filename in
4606 let v = input_value chan in
4610 _ -> Hashtbl.create 13
4611 let pod2text_memo_updated () =
4612 let chan = open_out pod2text_memo_filename in
4613 output_value chan pod2text_memo;
4616 (* Useful functions.
4617 * Note we don't want to use any external OCaml libraries which
4618 * makes this a bit harder than it should be.
4620 module StringMap = Map.Make (String)
4622 let failwithf fs = ksprintf failwith fs
4624 let unique = let i = ref 0 in fun () -> incr i; !i
4626 let replace_char s c1 c2 =
4627 let s2 = String.copy s in
4628 let r = ref false in
4629 for i = 0 to String.length s2 - 1 do
4630 if String.unsafe_get s2 i = c1 then (
4631 String.unsafe_set s2 i c2;
4635 if not !r then s else s2
4639 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4641 let triml ?(test = isspace) str =
4643 let n = ref (String.length str) in
4644 while !n > 0 && test str.[!i]; do
4649 else String.sub str !i !n
4651 let trimr ?(test = isspace) str =
4652 let n = ref (String.length str) in
4653 while !n > 0 && test str.[!n-1]; do
4656 if !n = String.length str then str
4657 else String.sub str 0 !n
4659 let trim ?(test = isspace) str =
4660 trimr ~test (triml ~test str)
4662 let rec find s sub =
4663 let len = String.length s in
4664 let sublen = String.length sub in
4666 if i <= len-sublen then (
4668 if j < sublen then (
4669 if s.[i+j] = sub.[j] then loop2 (j+1)
4675 if r = -1 then loop (i+1) else r
4681 let rec replace_str s s1 s2 =
4682 let len = String.length s in
4683 let sublen = String.length s1 in
4684 let i = find s s1 in
4687 let s' = String.sub s 0 i in
4688 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4689 s' ^ s2 ^ replace_str s'' s1 s2
4692 let rec string_split sep str =
4693 let len = String.length str in
4694 let seplen = String.length sep in
4695 let i = find str sep in
4696 if i = -1 then [str]
4698 let s' = String.sub str 0 i in
4699 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4700 s' :: string_split sep s''
4703 let files_equal n1 n2 =
4704 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4705 match Sys.command cmd with
4708 | i -> failwithf "%s: failed with error code %d" cmd i
4710 let rec filter_map f = function
4714 | Some y -> y :: filter_map f xs
4715 | None -> filter_map f xs
4717 let rec find_map f = function
4718 | [] -> raise Not_found
4722 | None -> find_map f xs
4725 let rec loop i = function
4727 | x :: xs -> f i x; loop (i+1) xs
4732 let rec loop i = function
4734 | x :: xs -> let r = f i x in r :: loop (i+1) xs
4738 let count_chars c str =
4739 let count = ref 0 in
4740 for i = 0 to String.length str - 1 do
4741 if c = String.unsafe_get str i then incr count
4745 let name_of_argt = function
4746 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4747 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4748 | FileIn n | FileOut n -> n
4750 let java_name_of_struct typ =
4751 try List.assoc typ java_structs
4754 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4756 let cols_of_struct typ =
4757 try List.assoc typ structs
4759 failwithf "cols_of_struct: unknown struct %s" typ
4761 let seq_of_test = function
4762 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4763 | TestOutputListOfDevices (s, _)
4764 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4765 | TestOutputTrue s | TestOutputFalse s
4766 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4767 | TestOutputStruct (s, _)
4768 | TestLastFail s -> s
4770 (* Handling for function flags. *)
4771 let protocol_limit_warning =
4772 "Because of the message protocol, there is a transfer limit
4773 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4775 let danger_will_robinson =
4776 "B<This command is dangerous. Without careful use you
4777 can easily destroy all your data>."
4779 let deprecation_notice flags =
4782 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4784 sprintf "This function is deprecated.
4785 In new code, use the C<%s> call instead.
4787 Deprecated functions will not be removed from the API, but the
4788 fact that they are deprecated indicates that there are problems
4789 with correct use of these functions." alt in
4794 (* Create list of optional groups. *)
4796 let h = Hashtbl.create 13 in
4798 fun (name, _, _, flags, _, _, _) ->
4802 let names = try Hashtbl.find h group with Not_found -> [] in
4803 Hashtbl.replace h group (name :: names)
4807 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4810 fun group -> group, List.sort compare (Hashtbl.find h group)
4812 List.sort (fun x y -> compare (fst x) (fst y)) groups
4814 (* Check function names etc. for consistency. *)
4815 let check_functions () =
4816 let contains_uppercase str =
4817 let len = String.length str in
4819 if i >= len then false
4822 if c >= 'A' && c <= 'Z' then true
4829 (* Check function names. *)
4831 fun (name, _, _, _, _, _, _) ->
4832 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4833 failwithf "function name %s does not need 'guestfs' prefix" name;
4835 failwithf "function name is empty";
4836 if name.[0] < 'a' || name.[0] > 'z' then
4837 failwithf "function name %s must start with lowercase a-z" name;
4838 if String.contains name '-' then
4839 failwithf "function name %s should not contain '-', use '_' instead."
4843 (* Check function parameter/return names. *)
4845 fun (name, style, _, _, _, _, _) ->
4846 let check_arg_ret_name n =
4847 if contains_uppercase n then
4848 failwithf "%s param/ret %s should not contain uppercase chars"
4850 if String.contains n '-' || String.contains n '_' then
4851 failwithf "%s param/ret %s should not contain '-' or '_'"
4854 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;
4855 if n = "int" || n = "char" || n = "short" || n = "long" then
4856 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4857 if n = "i" || n = "n" then
4858 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4859 if n = "argv" || n = "args" then
4860 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
4862 (* List Haskell, OCaml and C keywords here.
4863 * http://www.haskell.org/haskellwiki/Keywords
4864 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
4865 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
4866 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
4867 * |perl -pe 's/(.+)/"$1";/'|fmt -70
4868 * Omitting _-containing words, since they're handled above.
4869 * Omitting the OCaml reserved word, "val", is ok,
4870 * and saves us from renaming several parameters.
4873 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
4874 "char"; "class"; "const"; "constraint"; "continue"; "data";
4875 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
4876 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
4877 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
4878 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
4879 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
4881 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
4882 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
4883 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
4884 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
4885 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
4886 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
4887 "volatile"; "when"; "where"; "while";
4889 if List.mem n reserved then
4890 failwithf "%s has param/ret using reserved word %s" name n;
4893 (match fst style with
4895 | RInt n | RInt64 n | RBool n
4896 | RConstString n | RConstOptString n | RString n
4897 | RStringList n | RStruct (n, _) | RStructList (n, _)
4898 | RHashtable n | RBufferOut n ->
4899 check_arg_ret_name n
4901 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
4904 (* Check short descriptions. *)
4906 fun (name, _, _, _, _, shortdesc, _) ->
4907 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
4908 failwithf "short description of %s should begin with lowercase." name;
4909 let c = shortdesc.[String.length shortdesc-1] in
4910 if c = '\n' || c = '.' then
4911 failwithf "short description of %s should not end with . or \\n." name
4914 (* Check long dscriptions. *)
4916 fun (name, _, _, _, _, _, longdesc) ->
4917 if longdesc.[String.length longdesc-1] = '\n' then
4918 failwithf "long description of %s should not end with \\n." name
4921 (* Check proc_nrs. *)
4923 fun (name, _, proc_nr, _, _, _, _) ->
4924 if proc_nr <= 0 then
4925 failwithf "daemon function %s should have proc_nr > 0" name
4929 fun (name, _, proc_nr, _, _, _, _) ->
4930 if proc_nr <> -1 then
4931 failwithf "non-daemon function %s should have proc_nr -1" name
4932 ) non_daemon_functions;
4935 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
4938 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
4939 let rec loop = function
4942 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
4944 | (name1,nr1) :: (name2,nr2) :: _ ->
4945 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
4953 (* Ignore functions that have no tests. We generate a
4954 * warning when the user does 'make check' instead.
4956 | name, _, _, _, [], _, _ -> ()
4957 | name, _, _, _, tests, _, _ ->
4961 match seq_of_test test with
4963 failwithf "%s has a test containing an empty sequence" name
4964 | cmds -> List.map List.hd cmds
4966 let funcs = List.flatten funcs in
4968 let tested = List.mem name funcs in
4971 failwithf "function %s has tests but does not test itself" name
4974 (* 'pr' prints to the current output file. *)
4975 let chan = ref Pervasives.stdout
4980 let i = count_chars '\n' str in
4981 lines := !lines + i;
4982 output_string !chan str
4985 let copyright_years =
4986 let this_year = 1900 + (localtime (time ())).tm_year in
4987 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
4989 (* Generate a header block in a number of standard styles. *)
4990 type comment_style =
4991 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
4992 type license = GPLv2plus | LGPLv2plus
4994 let generate_header ?(extra_inputs = []) comment license =
4995 let inputs = "src/generator.ml" :: extra_inputs in
4996 let c = match comment with
4997 | CStyle -> pr "/* "; " *"
4998 | CPlusPlusStyle -> pr "// "; "//"
4999 | HashStyle -> pr "# "; "#"
5000 | OCamlStyle -> pr "(* "; " *"
5001 | HaskellStyle -> pr "{- "; " " in
5002 pr "libguestfs generated file\n";
5003 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5004 List.iter (pr "%s %s\n" c) inputs;
5005 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5007 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5011 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5012 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5013 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5014 pr "%s (at your option) any later version.\n" c;
5016 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5017 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5018 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5019 pr "%s GNU General Public License for more details.\n" c;
5021 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5022 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5023 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5026 pr "%s This library is free software; you can redistribute it and/or\n" c;
5027 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5028 pr "%s License as published by the Free Software Foundation; either\n" c;
5029 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5031 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5032 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5033 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5034 pr "%s Lesser General Public License for more details.\n" c;
5036 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5037 pr "%s License along with this library; if not, write to the Free Software\n" c;
5038 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5041 | CStyle -> pr " */\n"
5044 | OCamlStyle -> pr " *)\n"
5045 | HaskellStyle -> pr "-}\n"
5049 (* Start of main code generation functions below this line. *)
5051 (* Generate the pod documentation for the C API. *)
5052 let rec generate_actions_pod () =
5054 fun (shortname, style, _, flags, _, _, longdesc) ->
5055 if not (List.mem NotInDocs flags) then (
5056 let name = "guestfs_" ^ shortname in
5057 pr "=head2 %s\n\n" name;
5059 generate_prototype ~extern:false ~handle:"handle" name style;
5061 pr "%s\n\n" longdesc;
5062 (match fst style with
5064 pr "This function returns 0 on success or -1 on error.\n\n"
5066 pr "On error this function returns -1.\n\n"
5068 pr "On error this function returns -1.\n\n"
5070 pr "This function returns a C truth value on success or -1 on error.\n\n"
5072 pr "This function returns a string, or NULL on error.
5073 The string is owned by the guest handle and must I<not> be freed.\n\n"
5074 | RConstOptString _ ->
5075 pr "This function returns a string which may be NULL.
5076 There is way to return an error from this function.
5077 The string is owned by the guest handle and must I<not> be freed.\n\n"
5079 pr "This function returns a string, or NULL on error.
5080 I<The caller must free the returned string after use>.\n\n"
5082 pr "This function returns a NULL-terminated array of strings
5083 (like L<environ(3)>), or NULL if there was an error.
5084 I<The caller must free the strings and the array after use>.\n\n"
5085 | RStruct (_, typ) ->
5086 pr "This function returns a C<struct guestfs_%s *>,
5087 or NULL if there was an error.
5088 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5089 | RStructList (_, typ) ->
5090 pr "This function returns a C<struct guestfs_%s_list *>
5091 (see E<lt>guestfs-structs.hE<gt>),
5092 or NULL if there was an error.
5093 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5095 pr "This function returns a NULL-terminated array of
5096 strings, or NULL if there was an error.
5097 The array of strings will always have length C<2n+1>, where
5098 C<n> keys and values alternate, followed by the trailing NULL entry.
5099 I<The caller must free the strings and the array after use>.\n\n"
5101 pr "This function returns a buffer, or NULL on error.
5102 The size of the returned buffer is written to C<*size_r>.
5103 I<The caller must free the returned buffer after use>.\n\n"
5105 if List.mem ProtocolLimitWarning flags then
5106 pr "%s\n\n" protocol_limit_warning;
5107 if List.mem DangerWillRobinson flags then
5108 pr "%s\n\n" danger_will_robinson;
5109 match deprecation_notice flags with
5111 | Some txt -> pr "%s\n\n" txt
5113 ) all_functions_sorted
5115 and generate_structs_pod () =
5116 (* Structs documentation. *)
5119 pr "=head2 guestfs_%s\n" typ;
5121 pr " struct guestfs_%s {\n" typ;
5124 | name, FChar -> pr " char %s;\n" name
5125 | name, FUInt32 -> pr " uint32_t %s;\n" name
5126 | name, FInt32 -> pr " int32_t %s;\n" name
5127 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5128 | name, FInt64 -> pr " int64_t %s;\n" name
5129 | name, FString -> pr " char *%s;\n" name
5131 pr " /* The next two fields describe a byte array. */\n";
5132 pr " uint32_t %s_len;\n" name;
5133 pr " char *%s;\n" name
5135 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5136 pr " char %s[32];\n" name
5137 | name, FOptPercent ->
5138 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5139 pr " float %s;\n" name
5143 pr " struct guestfs_%s_list {\n" typ;
5144 pr " uint32_t len; /* Number of elements in list. */\n";
5145 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5148 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5149 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5154 and generate_availability_pod () =
5155 (* Availability documentation. *)
5159 fun (group, functions) ->
5160 pr "=item B<%s>\n" group;
5162 pr "The following functions:\n";
5163 List.iter (pr "L</guestfs_%s>\n") functions;
5169 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5170 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5172 * We have to use an underscore instead of a dash because otherwise
5173 * rpcgen generates incorrect code.
5175 * This header is NOT exported to clients, but see also generate_structs_h.
5177 and generate_xdr () =
5178 generate_header CStyle LGPLv2plus;
5180 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5181 pr "typedef string str<>;\n";
5184 (* Internal structures. *)
5188 pr "struct guestfs_int_%s {\n" typ;
5190 | name, FChar -> pr " char %s;\n" name
5191 | name, FString -> pr " string %s<>;\n" name
5192 | name, FBuffer -> pr " opaque %s<>;\n" name
5193 | name, FUUID -> pr " opaque %s[32];\n" name
5194 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5195 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5196 | name, FOptPercent -> pr " float %s;\n" name
5200 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5205 fun (shortname, style, _, _, _, _, _) ->
5206 let name = "guestfs_" ^ shortname in
5208 (match snd style with
5211 pr "struct %s_args {\n" name;
5214 | Pathname n | Device n | Dev_or_Path n | String n ->
5215 pr " string %s<>;\n" n
5216 | OptString n -> pr " str *%s;\n" n
5217 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5218 | Bool n -> pr " bool %s;\n" n
5219 | Int n -> pr " int %s;\n" n
5220 | Int64 n -> pr " hyper %s;\n" n
5221 | FileIn _ | FileOut _ -> ()
5225 (match fst style with
5228 pr "struct %s_ret {\n" name;
5232 pr "struct %s_ret {\n" name;
5233 pr " hyper %s;\n" n;
5236 pr "struct %s_ret {\n" name;
5239 | RConstString _ | RConstOptString _ ->
5240 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5242 pr "struct %s_ret {\n" name;
5243 pr " string %s<>;\n" n;
5246 pr "struct %s_ret {\n" name;
5247 pr " str %s<>;\n" n;
5249 | RStruct (n, typ) ->
5250 pr "struct %s_ret {\n" name;
5251 pr " guestfs_int_%s %s;\n" typ n;
5253 | RStructList (n, typ) ->
5254 pr "struct %s_ret {\n" name;
5255 pr " guestfs_int_%s_list %s;\n" typ n;
5258 pr "struct %s_ret {\n" name;
5259 pr " str %s<>;\n" n;
5262 pr "struct %s_ret {\n" name;
5263 pr " opaque %s<>;\n" n;
5268 (* Table of procedure numbers. *)
5269 pr "enum guestfs_procedure {\n";
5271 fun (shortname, _, proc_nr, _, _, _, _) ->
5272 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5274 pr " GUESTFS_PROC_NR_PROCS\n";
5278 (* Having to choose a maximum message size is annoying for several
5279 * reasons (it limits what we can do in the API), but it (a) makes
5280 * the protocol a lot simpler, and (b) provides a bound on the size
5281 * of the daemon which operates in limited memory space.
5283 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5286 (* Message header, etc. *)
5288 /* The communication protocol is now documented in the guestfs(3)
5292 const GUESTFS_PROGRAM = 0x2000F5F5;
5293 const GUESTFS_PROTOCOL_VERSION = 1;
5295 /* These constants must be larger than any possible message length. */
5296 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5297 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5299 enum guestfs_message_direction {
5300 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5301 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5304 enum guestfs_message_status {
5305 GUESTFS_STATUS_OK = 0,
5306 GUESTFS_STATUS_ERROR = 1
5309 const GUESTFS_ERROR_LEN = 256;
5311 struct guestfs_message_error {
5312 string error_message<GUESTFS_ERROR_LEN>;
5315 struct guestfs_message_header {
5316 unsigned prog; /* GUESTFS_PROGRAM */
5317 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5318 guestfs_procedure proc; /* GUESTFS_PROC_x */
5319 guestfs_message_direction direction;
5320 unsigned serial; /* message serial number */
5321 guestfs_message_status status;
5324 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5326 struct guestfs_chunk {
5327 int cancel; /* if non-zero, transfer is cancelled */
5328 /* data size is 0 bytes if the transfer has finished successfully */
5329 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5333 (* Generate the guestfs-structs.h file. *)
5334 and generate_structs_h () =
5335 generate_header CStyle LGPLv2plus;
5337 (* This is a public exported header file containing various
5338 * structures. The structures are carefully written to have
5339 * exactly the same in-memory format as the XDR structures that
5340 * we use on the wire to the daemon. The reason for creating
5341 * copies of these structures here is just so we don't have to
5342 * export the whole of guestfs_protocol.h (which includes much
5343 * unrelated and XDR-dependent stuff that we don't want to be
5344 * public, or required by clients).
5346 * To reiterate, we will pass these structures to and from the
5347 * client with a simple assignment or memcpy, so the format
5348 * must be identical to what rpcgen / the RFC defines.
5351 (* Public structures. *)
5354 pr "struct guestfs_%s {\n" typ;
5357 | name, FChar -> pr " char %s;\n" name
5358 | name, FString -> pr " char *%s;\n" name
5360 pr " uint32_t %s_len;\n" name;
5361 pr " char *%s;\n" name
5362 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5363 | name, FUInt32 -> pr " uint32_t %s;\n" name
5364 | name, FInt32 -> pr " int32_t %s;\n" name
5365 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5366 | name, FInt64 -> pr " int64_t %s;\n" name
5367 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5371 pr "struct guestfs_%s_list {\n" typ;
5372 pr " uint32_t len;\n";
5373 pr " struct guestfs_%s *val;\n" typ;
5376 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5377 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5381 (* Generate the guestfs-actions.h file. *)
5382 and generate_actions_h () =
5383 generate_header CStyle LGPLv2plus;
5385 fun (shortname, style, _, _, _, _, _) ->
5386 let name = "guestfs_" ^ shortname in
5387 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5391 (* Generate the guestfs-internal-actions.h file. *)
5392 and generate_internal_actions_h () =
5393 generate_header CStyle LGPLv2plus;
5395 fun (shortname, style, _, _, _, _, _) ->
5396 let name = "guestfs__" ^ shortname in
5397 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5399 ) non_daemon_functions
5401 (* Generate the client-side dispatch stubs. *)
5402 and generate_client_actions () =
5403 generate_header CStyle LGPLv2plus;
5410 #include <inttypes.h>
5412 #include \"guestfs.h\"
5413 #include \"guestfs-internal.h\"
5414 #include \"guestfs-internal-actions.h\"
5415 #include \"guestfs_protocol.h\"
5417 #define error guestfs_error
5418 //#define perrorf guestfs_perrorf
5419 #define safe_malloc guestfs_safe_malloc
5420 #define safe_realloc guestfs_safe_realloc
5421 //#define safe_strdup guestfs_safe_strdup
5422 #define safe_memdup guestfs_safe_memdup
5424 /* Check the return message from a call for validity. */
5426 check_reply_header (guestfs_h *g,
5427 const struct guestfs_message_header *hdr,
5428 unsigned int proc_nr, unsigned int serial)
5430 if (hdr->prog != GUESTFS_PROGRAM) {
5431 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5434 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5435 error (g, \"wrong protocol version (%%d/%%d)\",
5436 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5439 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5440 error (g, \"unexpected message direction (%%d/%%d)\",
5441 hdr->direction, GUESTFS_DIRECTION_REPLY);
5444 if (hdr->proc != proc_nr) {
5445 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5448 if (hdr->serial != serial) {
5449 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5456 /* Check we are in the right state to run a high-level action. */
5458 check_state (guestfs_h *g, const char *caller)
5460 if (!guestfs__is_ready (g)) {
5461 if (guestfs__is_config (g) || guestfs__is_launching (g))
5462 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5465 error (g, \"%%s called from the wrong state, %%d != READY\",
5466 caller, guestfs__get_state (g));
5474 (* Generate code to generate guestfish call traces. *)
5475 let trace_call shortname style =
5476 pr " if (guestfs__get_trace (g)) {\n";
5479 List.exists (function
5480 | StringList _ | DeviceList _ -> true
5481 | _ -> false) (snd style) in
5487 pr " printf (\"%s\");\n" shortname;
5490 | String n (* strings *)
5496 (* guestfish doesn't support string escaping, so neither do we *)
5497 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5498 | OptString n -> (* string option *)
5499 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5500 pr " else printf (\" null\");\n"
5502 | DeviceList n -> (* string list *)
5503 pr " putchar (' ');\n";
5504 pr " putchar ('\"');\n";
5505 pr " for (i = 0; %s[i]; ++i) {\n" n;
5506 pr " if (i > 0) putchar (' ');\n";
5507 pr " fputs (%s[i], stdout);\n" n;
5509 pr " putchar ('\"');\n";
5510 | Bool n -> (* boolean *)
5511 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5512 | Int n -> (* int *)
5513 pr " printf (\" %%d\", %s);\n" n
5515 pr " printf (\" %%\" PRIi64, %s);\n" n
5517 pr " putchar ('\\n');\n";
5522 (* For non-daemon functions, generate a wrapper around each function. *)
5524 fun (shortname, style, _, _, _, _, _) ->
5525 let name = "guestfs_" ^ shortname in
5527 generate_prototype ~extern:false ~semicolon:false ~newline:true
5528 ~handle:"g" name style;
5530 trace_call shortname style;
5531 pr " return guestfs__%s " shortname;
5532 generate_c_call_args ~handle:"g" style;
5536 ) non_daemon_functions;
5538 (* Client-side stubs for each function. *)
5540 fun (shortname, style, _, _, _, _, _) ->
5541 let name = "guestfs_" ^ shortname in
5543 (* Generate the action stub. *)
5544 generate_prototype ~extern:false ~semicolon:false ~newline:true
5545 ~handle:"g" name style;
5548 match fst style with
5549 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5550 | RConstString _ | RConstOptString _ ->
5551 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5552 | RString _ | RStringList _
5553 | RStruct _ | RStructList _
5554 | RHashtable _ | RBufferOut _ ->
5559 (match snd style with
5561 | _ -> pr " struct %s_args args;\n" name
5564 pr " guestfs_message_header hdr;\n";
5565 pr " guestfs_message_error err;\n";
5567 match fst style with
5569 | RConstString _ | RConstOptString _ ->
5570 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5572 | RBool _ | RString _ | RStringList _
5573 | RStruct _ | RStructList _
5574 | RHashtable _ | RBufferOut _ ->
5575 pr " struct %s_ret ret;\n" name;
5578 pr " int serial;\n";
5581 trace_call shortname style;
5582 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5583 pr " guestfs___set_busy (g);\n";
5586 (* Send the main header and arguments. *)
5587 (match snd style with
5589 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5590 (String.uppercase shortname)
5594 | Pathname n | Device n | Dev_or_Path n | String n ->
5595 pr " args.%s = (char *) %s;\n" n n
5597 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5598 | StringList n | DeviceList n ->
5599 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5600 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5602 pr " args.%s = %s;\n" n n
5604 pr " args.%s = %s;\n" n n
5606 pr " args.%s = %s;\n" n n
5607 | FileIn _ | FileOut _ -> ()
5609 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5610 (String.uppercase shortname);
5611 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5614 pr " if (serial == -1) {\n";
5615 pr " guestfs___end_busy (g);\n";
5616 pr " return %s;\n" error_code;
5620 (* Send any additional files (FileIn) requested. *)
5621 let need_read_reply_label = ref false in
5625 pr " r = guestfs___send_file (g, %s);\n" n;
5626 pr " if (r == -1) {\n";
5627 pr " guestfs___end_busy (g);\n";
5628 pr " return %s;\n" error_code;
5630 pr " if (r == -2) /* daemon cancelled */\n";
5631 pr " goto read_reply;\n";
5632 need_read_reply_label := true;
5637 (* Wait for the reply from the remote end. *)
5638 if !need_read_reply_label then pr " read_reply:\n";
5639 pr " memset (&hdr, 0, sizeof hdr);\n";
5640 pr " memset (&err, 0, sizeof err);\n";
5641 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5643 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5647 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5650 pr " if (r == -1) {\n";
5651 pr " guestfs___end_busy (g);\n";
5652 pr " return %s;\n" error_code;
5656 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5657 (String.uppercase shortname);
5658 pr " guestfs___end_busy (g);\n";
5659 pr " return %s;\n" error_code;
5663 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5664 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5665 pr " free (err.error_message);\n";
5666 pr " guestfs___end_busy (g);\n";
5667 pr " return %s;\n" error_code;
5671 (* Expecting to receive further files (FileOut)? *)
5675 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5676 pr " guestfs___end_busy (g);\n";
5677 pr " return %s;\n" error_code;
5683 pr " guestfs___end_busy (g);\n";
5685 (match fst style with
5686 | RErr -> pr " return 0;\n"
5687 | RInt n | RInt64 n | RBool n ->
5688 pr " return ret.%s;\n" n
5689 | RConstString _ | RConstOptString _ ->
5690 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5692 pr " return ret.%s; /* caller will free */\n" n
5693 | RStringList n | RHashtable n ->
5694 pr " /* caller will free this, but we need to add a NULL entry */\n";
5695 pr " ret.%s.%s_val =\n" n n;
5696 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5697 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5699 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5700 pr " return ret.%s.%s_val;\n" n n
5702 pr " /* caller will free this */\n";
5703 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5704 | RStructList (n, _) ->
5705 pr " /* caller will free this */\n";
5706 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5708 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5709 pr " * _val might be NULL here. To make the API saner for\n";
5710 pr " * callers, we turn this case into a unique pointer (using\n";
5711 pr " * malloc(1)).\n";
5713 pr " if (ret.%s.%s_len > 0) {\n" n n;
5714 pr " *size_r = ret.%s.%s_len;\n" n n;
5715 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5717 pr " free (ret.%s.%s_val);\n" n n;
5718 pr " char *p = safe_malloc (g, 1);\n";
5719 pr " *size_r = ret.%s.%s_len;\n" n n;
5727 (* Functions to free structures. *)
5728 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5729 pr " * structure format is identical to the XDR format. See note in\n";
5730 pr " * generator.ml.\n";
5737 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5739 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5745 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5747 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5754 (* Generate daemon/actions.h. *)
5755 and generate_daemon_actions_h () =
5756 generate_header CStyle GPLv2plus;
5758 pr "#include \"../src/guestfs_protocol.h\"\n";
5762 fun (name, style, _, _, _, _, _) ->
5764 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5768 (* Generate the linker script which controls the visibility of
5769 * symbols in the public ABI and ensures no other symbols get
5770 * exported accidentally.
5772 and generate_linker_script () =
5773 generate_header HashStyle GPLv2plus;
5778 "guestfs_get_error_handler";
5779 "guestfs_get_out_of_memory_handler";
5780 "guestfs_last_error";
5781 "guestfs_set_error_handler";
5782 "guestfs_set_launch_done_callback";
5783 "guestfs_set_log_message_callback";
5784 "guestfs_set_out_of_memory_handler";
5785 "guestfs_set_subprocess_quit_callback";
5787 (* Unofficial parts of the API: the bindings code use these
5788 * functions, so it is useful to export them.
5790 "guestfs_safe_calloc";
5791 "guestfs_safe_malloc";
5794 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
5798 List.map (fun (typ, _) ->
5799 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
5802 let globals = List.sort compare (globals @ functions @ structs) in
5806 List.iter (pr " %s;\n") globals;
5813 (* Generate the server-side stubs. *)
5814 and generate_daemon_actions () =
5815 generate_header CStyle GPLv2plus;
5817 pr "#include <config.h>\n";
5819 pr "#include <stdio.h>\n";
5820 pr "#include <stdlib.h>\n";
5821 pr "#include <string.h>\n";
5822 pr "#include <inttypes.h>\n";
5823 pr "#include <rpc/types.h>\n";
5824 pr "#include <rpc/xdr.h>\n";
5826 pr "#include \"daemon.h\"\n";
5827 pr "#include \"c-ctype.h\"\n";
5828 pr "#include \"../src/guestfs_protocol.h\"\n";
5829 pr "#include \"actions.h\"\n";
5833 fun (name, style, _, _, _, _, _) ->
5834 (* Generate server-side stubs. *)
5835 pr "static void %s_stub (XDR *xdr_in)\n" name;
5838 match fst style with
5839 | RErr | RInt _ -> pr " int r;\n"; "-1"
5840 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5841 | RBool _ -> pr " int r;\n"; "-1"
5842 | RConstString _ | RConstOptString _ ->
5843 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5844 | RString _ -> pr " char *r;\n"; "NULL"
5845 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5846 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
5847 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
5849 pr " size_t size = 1;\n";
5853 (match snd style with
5856 pr " struct guestfs_%s_args args;\n" name;
5859 | Device n | Dev_or_Path n
5862 | OptString n -> pr " char *%s;\n" n
5863 | StringList n | DeviceList n -> pr " char **%s;\n" n
5864 | Bool n -> pr " int %s;\n" n
5865 | Int n -> pr " int %s;\n" n
5866 | Int64 n -> pr " int64_t %s;\n" n
5867 | FileIn _ | FileOut _ -> ()
5872 (match snd style with
5875 pr " memset (&args, 0, sizeof args);\n";
5877 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
5878 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
5882 pr " char *%s = args.%s;\n" n n
5884 let pr_list_handling_code n =
5885 pr " %s = realloc (args.%s.%s_val,\n" n n n;
5886 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
5887 pr " if (%s == NULL) {\n" n;
5888 pr " reply_with_perror (\"realloc\");\n";
5891 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
5892 pr " args.%s.%s_val = %s;\n" n n n;
5898 pr " ABS_PATH (%s, goto done);\n" n;
5901 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
5904 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
5905 | String n -> pr_args n
5906 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
5908 pr_list_handling_code n;
5910 pr_list_handling_code n;
5911 pr " /* Ensure that each is a device,\n";
5912 pr " * and perform device name translation. */\n";
5913 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
5914 pr " RESOLVE_DEVICE (physvols[pvi], goto done);\n";
5916 | Bool n -> pr " %s = args.%s;\n" n n
5917 | Int n -> pr " %s = args.%s;\n" n n
5918 | Int64 n -> pr " %s = args.%s;\n" n n
5919 | FileIn _ | FileOut _ -> ()
5925 (* this is used at least for do_equal *)
5926 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
5927 (* Emit NEED_ROOT just once, even when there are two or
5928 more Pathname args *)
5929 pr " NEED_ROOT (goto done);\n";
5932 (* Don't want to call the impl with any FileIn or FileOut
5933 * parameters, since these go "outside" the RPC protocol.
5936 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
5938 pr " r = do_%s " name;
5939 generate_c_call_args (fst style, args');
5942 (match fst style with
5943 | RErr | RInt _ | RInt64 _ | RBool _
5944 | RConstString _ | RConstOptString _
5945 | RString _ | RStringList _ | RHashtable _
5946 | RStruct (_, _) | RStructList (_, _) ->
5947 pr " if (r == %s)\n" error_code;
5948 pr " /* do_%s has already called reply_with_error */\n" name;
5952 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
5953 pr " * an ordinary zero-length buffer), so be careful ...\n";
5955 pr " if (size == 1 && r == %s)\n" error_code;
5956 pr " /* do_%s has already called reply_with_error */\n" name;
5961 (* If there are any FileOut parameters, then the impl must
5962 * send its own reply.
5965 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
5967 pr " /* do_%s has already sent a reply */\n" name
5969 match fst style with
5970 | RErr -> pr " reply (NULL, NULL);\n"
5971 | RInt n | RInt64 n | RBool n ->
5972 pr " struct guestfs_%s_ret ret;\n" name;
5973 pr " ret.%s = r;\n" n;
5974 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5976 | RConstString _ | RConstOptString _ ->
5977 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5979 pr " struct guestfs_%s_ret ret;\n" name;
5980 pr " ret.%s = r;\n" n;
5981 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5984 | RStringList n | RHashtable n ->
5985 pr " struct guestfs_%s_ret ret;\n" name;
5986 pr " ret.%s.%s_len = count_strings (r);\n" n n;
5987 pr " ret.%s.%s_val = r;\n" n n;
5988 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5990 pr " free_strings (r);\n"
5992 pr " struct guestfs_%s_ret ret;\n" name;
5993 pr " ret.%s = *r;\n" n;
5994 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5996 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5998 | RStructList (n, _) ->
5999 pr " struct guestfs_%s_ret ret;\n" name;
6000 pr " ret.%s = *r;\n" n;
6001 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6003 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6006 pr " struct guestfs_%s_ret ret;\n" name;
6007 pr " ret.%s.%s_val = r;\n" n n;
6008 pr " ret.%s.%s_len = size;\n" n n;
6009 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6014 (* Free the args. *)
6015 (match snd style with
6020 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6027 (* Dispatch function. *)
6028 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6030 pr " switch (proc_nr) {\n";
6033 fun (name, style, _, _, _, _, _) ->
6034 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6035 pr " %s_stub (xdr_in);\n" name;
6040 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";
6045 (* LVM columns and tokenization functions. *)
6046 (* XXX This generates crap code. We should rethink how we
6052 pr "static const char *lvm_%s_cols = \"%s\";\n"
6053 typ (String.concat "," (List.map fst cols));
6056 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6058 pr " char *tok, *p, *next;\n";
6062 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6065 pr " if (!str) {\n";
6066 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6069 pr " if (!*str || c_isspace (*str)) {\n";
6070 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6075 fun (name, coltype) ->
6076 pr " if (!tok) {\n";
6077 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6080 pr " p = strchrnul (tok, ',');\n";
6081 pr " if (*p) next = p+1; else next = NULL;\n";
6082 pr " *p = '\\0';\n";
6085 pr " r->%s = strdup (tok);\n" name;
6086 pr " if (r->%s == NULL) {\n" name;
6087 pr " perror (\"strdup\");\n";
6091 pr " for (i = j = 0; i < 32; ++j) {\n";
6092 pr " if (tok[j] == '\\0') {\n";
6093 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6095 pr " } else if (tok[j] != '-')\n";
6096 pr " r->%s[i++] = tok[j];\n" name;
6099 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6100 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6104 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6105 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6109 pr " if (tok[0] == '\\0')\n";
6110 pr " r->%s = -1;\n" name;
6111 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6112 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6115 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6116 assert false (* can never be an LVM column *)
6118 pr " tok = next;\n";
6121 pr " if (tok != NULL) {\n";
6122 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6129 pr "guestfs_int_lvm_%s_list *\n" typ;
6130 pr "parse_command_line_%ss (void)\n" typ;
6132 pr " char *out, *err;\n";
6133 pr " char *p, *pend;\n";
6135 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6136 pr " void *newp;\n";
6138 pr " ret = malloc (sizeof *ret);\n";
6139 pr " if (!ret) {\n";
6140 pr " reply_with_perror (\"malloc\");\n";
6141 pr " return NULL;\n";
6144 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6145 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6147 pr " r = command (&out, &err,\n";
6148 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
6149 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6150 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6151 pr " if (r == -1) {\n";
6152 pr " reply_with_error (\"%%s\", err);\n";
6153 pr " free (out);\n";
6154 pr " free (err);\n";
6155 pr " free (ret);\n";
6156 pr " return NULL;\n";
6159 pr " free (err);\n";
6161 pr " /* Tokenize each line of the output. */\n";
6164 pr " while (p) {\n";
6165 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6166 pr " if (pend) {\n";
6167 pr " *pend = '\\0';\n";
6171 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6174 pr " if (!*p) { /* Empty line? Skip it. */\n";
6179 pr " /* Allocate some space to store this next entry. */\n";
6180 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6181 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6182 pr " if (newp == NULL) {\n";
6183 pr " reply_with_perror (\"realloc\");\n";
6184 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6185 pr " free (ret);\n";
6186 pr " free (out);\n";
6187 pr " return NULL;\n";
6189 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6191 pr " /* Tokenize the next entry. */\n";
6192 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6193 pr " if (r == -1) {\n";
6194 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6195 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6196 pr " free (ret);\n";
6197 pr " free (out);\n";
6198 pr " return NULL;\n";
6205 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6207 pr " free (out);\n";
6208 pr " return ret;\n";
6211 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6213 (* Generate a list of function names, for debugging in the daemon.. *)
6214 and generate_daemon_names () =
6215 generate_header CStyle GPLv2plus;
6217 pr "#include <config.h>\n";
6219 pr "#include \"daemon.h\"\n";
6222 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6223 pr "const char *function_names[] = {\n";
6225 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6229 (* Generate the optional groups for the daemon to implement
6230 * guestfs_available.
6232 and generate_daemon_optgroups_c () =
6233 generate_header CStyle GPLv2plus;
6235 pr "#include <config.h>\n";
6237 pr "#include \"daemon.h\"\n";
6238 pr "#include \"optgroups.h\"\n";
6241 pr "struct optgroup optgroups[] = {\n";
6244 pr " { \"%s\", optgroup_%s_available },\n" group group
6246 pr " { NULL, NULL }\n";
6249 and generate_daemon_optgroups_h () =
6250 generate_header CStyle GPLv2plus;
6254 pr "extern int optgroup_%s_available (void);\n" group
6257 (* Generate the tests. *)
6258 and generate_tests () =
6259 generate_header CStyle GPLv2plus;
6266 #include <sys/types.h>
6269 #include \"guestfs.h\"
6270 #include \"guestfs-internal.h\"
6272 static guestfs_h *g;
6273 static int suppress_error = 0;
6275 static void print_error (guestfs_h *g, void *data, const char *msg)
6277 if (!suppress_error)
6278 fprintf (stderr, \"%%s\\n\", msg);
6281 /* FIXME: nearly identical code appears in fish.c */
6282 static void print_strings (char *const *argv)
6286 for (argc = 0; argv[argc] != NULL; ++argc)
6287 printf (\"\\t%%s\\n\", argv[argc]);
6291 static void print_table (char const *const *argv)
6295 for (i = 0; argv[i] != NULL; i += 2)
6296 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6302 (* Generate a list of commands which are not tested anywhere. *)
6303 pr "static void no_test_warnings (void)\n";
6306 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6308 fun (_, _, _, _, tests, _, _) ->
6309 let tests = filter_map (
6311 | (_, (Always|If _|Unless _), test) -> Some test
6312 | (_, Disabled, _) -> None
6314 let seq = List.concat (List.map seq_of_test tests) in
6315 let cmds_tested = List.map List.hd seq in
6316 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6320 fun (name, _, _, _, _, _, _) ->
6321 if not (Hashtbl.mem hash name) then
6322 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6328 (* Generate the actual tests. Note that we generate the tests
6329 * in reverse order, deliberately, so that (in general) the
6330 * newest tests run first. This makes it quicker and easier to
6335 fun (name, _, _, flags, tests, _, _) ->
6336 mapi (generate_one_test name flags) tests
6337 ) (List.rev all_functions) in
6338 let test_names = List.concat test_names in
6339 let nr_tests = List.length test_names in
6342 int main (int argc, char *argv[])
6345 unsigned long int n_failed = 0;
6346 const char *filename;
6348 int nr_tests, test_num = 0;
6350 setbuf (stdout, NULL);
6352 no_test_warnings ();
6354 g = guestfs_create ();
6356 printf (\"guestfs_create FAILED\\n\");
6357 exit (EXIT_FAILURE);
6360 guestfs_set_error_handler (g, print_error, NULL);
6362 guestfs_set_path (g, \"../appliance\");
6364 filename = \"test1.img\";
6365 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6368 exit (EXIT_FAILURE);
6370 if (lseek (fd, %d, SEEK_SET) == -1) {
6374 exit (EXIT_FAILURE);
6376 if (write (fd, &c, 1) == -1) {
6380 exit (EXIT_FAILURE);
6382 if (close (fd) == -1) {
6385 exit (EXIT_FAILURE);
6387 if (guestfs_add_drive (g, filename) == -1) {
6388 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6389 exit (EXIT_FAILURE);
6392 filename = \"test2.img\";
6393 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6396 exit (EXIT_FAILURE);
6398 if (lseek (fd, %d, SEEK_SET) == -1) {
6402 exit (EXIT_FAILURE);
6404 if (write (fd, &c, 1) == -1) {
6408 exit (EXIT_FAILURE);
6410 if (close (fd) == -1) {
6413 exit (EXIT_FAILURE);
6415 if (guestfs_add_drive (g, filename) == -1) {
6416 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6417 exit (EXIT_FAILURE);
6420 filename = \"test3.img\";
6421 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6424 exit (EXIT_FAILURE);
6426 if (lseek (fd, %d, SEEK_SET) == -1) {
6430 exit (EXIT_FAILURE);
6432 if (write (fd, &c, 1) == -1) {
6436 exit (EXIT_FAILURE);
6438 if (close (fd) == -1) {
6441 exit (EXIT_FAILURE);
6443 if (guestfs_add_drive (g, filename) == -1) {
6444 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6445 exit (EXIT_FAILURE);
6448 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6449 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6450 exit (EXIT_FAILURE);
6453 if (guestfs_launch (g) == -1) {
6454 printf (\"guestfs_launch FAILED\\n\");
6455 exit (EXIT_FAILURE);
6458 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6461 /* Cancel previous alarm. */
6466 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6470 pr " test_num++;\n";
6471 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6472 pr " if (%s () == -1) {\n" test_name;
6473 pr " printf (\"%s FAILED\\n\");\n" test_name;
6474 pr " n_failed++;\n";
6479 pr " guestfs_close (g);\n";
6480 pr " unlink (\"test1.img\");\n";
6481 pr " unlink (\"test2.img\");\n";
6482 pr " unlink (\"test3.img\");\n";
6485 pr " if (n_failed > 0) {\n";
6486 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6487 pr " exit (EXIT_FAILURE);\n";
6491 pr " exit (EXIT_SUCCESS);\n";
6494 and generate_one_test name flags i (init, prereq, test) =
6495 let test_name = sprintf "test_%s_%d" name i in
6498 static int %s_skip (void)
6502 str = getenv (\"TEST_ONLY\");
6504 return strstr (str, \"%s\") == NULL;
6505 str = getenv (\"SKIP_%s\");
6506 if (str && STREQ (str, \"1\")) return 1;
6507 str = getenv (\"SKIP_TEST_%s\");
6508 if (str && STREQ (str, \"1\")) return 1;
6512 " test_name name (String.uppercase test_name) (String.uppercase name);
6515 | Disabled | Always -> ()
6516 | If code | Unless code ->
6517 pr "static int %s_prereq (void)\n" test_name;
6525 static int %s (void)
6528 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6532 " test_name test_name test_name;
6534 (* Optional functions should only be tested if the relevant
6535 * support is available in the daemon.
6541 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6543 pr " suppress_error = 1;\n";
6544 pr " r = guestfs_available (g, (char **) groups);\n";
6545 pr " suppress_error = 0;\n";
6546 pr " if (r == -1) {\n";
6547 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6556 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6558 pr " if (! %s_prereq ()) {\n" test_name;
6559 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6563 generate_one_test_body name i test_name init test;
6565 pr " if (%s_prereq ()) {\n" test_name;
6566 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6570 generate_one_test_body name i test_name init test;
6572 generate_one_test_body name i test_name init test
6580 and generate_one_test_body name i test_name init test =
6582 | InitNone (* XXX at some point, InitNone and InitEmpty became
6583 * folded together as the same thing. Really we should
6584 * make InitNone do nothing at all, but the tests may
6585 * need to be checked to make sure this is OK.
6588 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6589 List.iter (generate_test_command_call test_name)
6590 [["blockdev_setrw"; "/dev/sda"];
6594 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6595 List.iter (generate_test_command_call test_name)
6596 [["blockdev_setrw"; "/dev/sda"];
6599 ["part_disk"; "/dev/sda"; "mbr"]]
6601 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6602 List.iter (generate_test_command_call test_name)
6603 [["blockdev_setrw"; "/dev/sda"];
6606 ["part_disk"; "/dev/sda"; "mbr"];
6607 ["mkfs"; "ext2"; "/dev/sda1"];
6608 ["mount_options"; ""; "/dev/sda1"; "/"]]
6609 | InitBasicFSonLVM ->
6610 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6612 List.iter (generate_test_command_call test_name)
6613 [["blockdev_setrw"; "/dev/sda"];
6616 ["part_disk"; "/dev/sda"; "mbr"];
6617 ["pvcreate"; "/dev/sda1"];
6618 ["vgcreate"; "VG"; "/dev/sda1"];
6619 ["lvcreate"; "LV"; "VG"; "8"];
6620 ["mkfs"; "ext2"; "/dev/VG/LV"];
6621 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
6623 pr " /* InitISOFS for %s */\n" test_name;
6624 List.iter (generate_test_command_call test_name)
6625 [["blockdev_setrw"; "/dev/sda"];
6628 ["mount_ro"; "/dev/sdd"; "/"]]
6631 let get_seq_last = function
6633 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6636 let seq = List.rev seq in
6637 List.rev (List.tl seq), List.hd seq
6642 pr " /* TestRun for %s (%d) */\n" name i;
6643 List.iter (generate_test_command_call test_name) seq
6644 | TestOutput (seq, expected) ->
6645 pr " /* TestOutput for %s (%d) */\n" name i;
6646 pr " const char *expected = \"%s\";\n" (c_quote expected);
6647 let seq, last = get_seq_last seq in
6649 pr " if (STRNEQ (r, expected)) {\n";
6650 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6654 List.iter (generate_test_command_call test_name) seq;
6655 generate_test_command_call ~test test_name last
6656 | TestOutputList (seq, expected) ->
6657 pr " /* TestOutputList for %s (%d) */\n" name i;
6658 let seq, last = get_seq_last seq in
6662 pr " if (!r[%d]) {\n" i;
6663 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6664 pr " print_strings (r);\n";
6668 pr " const char *expected = \"%s\";\n" (c_quote str);
6669 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6670 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6675 pr " if (r[%d] != NULL) {\n" (List.length expected);
6676 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6678 pr " print_strings (r);\n";
6682 List.iter (generate_test_command_call test_name) seq;
6683 generate_test_command_call ~test test_name last
6684 | TestOutputListOfDevices (seq, expected) ->
6685 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6686 let seq, last = get_seq_last seq in
6690 pr " if (!r[%d]) {\n" i;
6691 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6692 pr " print_strings (r);\n";
6696 pr " const char *expected = \"%s\";\n" (c_quote str);
6697 pr " r[%d][5] = 's';\n" i;
6698 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6699 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6704 pr " if (r[%d] != NULL) {\n" (List.length expected);
6705 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6707 pr " print_strings (r);\n";
6711 List.iter (generate_test_command_call test_name) seq;
6712 generate_test_command_call ~test test_name last
6713 | TestOutputInt (seq, expected) ->
6714 pr " /* TestOutputInt for %s (%d) */\n" name i;
6715 let seq, last = get_seq_last seq in
6717 pr " if (r != %d) {\n" expected;
6718 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6724 List.iter (generate_test_command_call test_name) seq;
6725 generate_test_command_call ~test test_name last
6726 | TestOutputIntOp (seq, op, expected) ->
6727 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6728 let seq, last = get_seq_last seq in
6730 pr " if (! (r %s %d)) {\n" op expected;
6731 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6732 test_name op expected;
6737 List.iter (generate_test_command_call test_name) seq;
6738 generate_test_command_call ~test test_name last
6739 | TestOutputTrue seq ->
6740 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6741 let seq, last = get_seq_last seq in
6744 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6749 List.iter (generate_test_command_call test_name) seq;
6750 generate_test_command_call ~test test_name last
6751 | TestOutputFalse seq ->
6752 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6753 let seq, last = get_seq_last seq in
6756 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6761 List.iter (generate_test_command_call test_name) seq;
6762 generate_test_command_call ~test test_name last
6763 | TestOutputLength (seq, expected) ->
6764 pr " /* TestOutputLength for %s (%d) */\n" name i;
6765 let seq, last = get_seq_last seq in
6768 pr " for (j = 0; j < %d; ++j)\n" expected;
6769 pr " if (r[j] == NULL) {\n";
6770 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6772 pr " print_strings (r);\n";
6775 pr " if (r[j] != NULL) {\n";
6776 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6778 pr " print_strings (r);\n";
6782 List.iter (generate_test_command_call test_name) seq;
6783 generate_test_command_call ~test test_name last
6784 | TestOutputBuffer (seq, expected) ->
6785 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6786 pr " const char *expected = \"%s\";\n" (c_quote expected);
6787 let seq, last = get_seq_last seq in
6788 let len = String.length expected in
6790 pr " if (size != %d) {\n" len;
6791 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6794 pr " if (STRNEQLEN (r, expected, size)) {\n";
6795 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6799 List.iter (generate_test_command_call test_name) seq;
6800 generate_test_command_call ~test test_name last
6801 | TestOutputStruct (seq, checks) ->
6802 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6803 let seq, last = get_seq_last seq in
6807 | CompareWithInt (field, expected) ->
6808 pr " if (r->%s != %d) {\n" field expected;
6809 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6810 test_name field expected;
6811 pr " (int) r->%s);\n" field;
6814 | CompareWithIntOp (field, op, expected) ->
6815 pr " if (!(r->%s %s %d)) {\n" field op expected;
6816 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
6817 test_name field op expected;
6818 pr " (int) r->%s);\n" field;
6821 | CompareWithString (field, expected) ->
6822 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
6823 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
6824 test_name field expected;
6825 pr " r->%s);\n" field;
6828 | CompareFieldsIntEq (field1, field2) ->
6829 pr " if (r->%s != r->%s) {\n" field1 field2;
6830 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
6831 test_name field1 field2;
6832 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
6835 | CompareFieldsStrEq (field1, field2) ->
6836 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
6837 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
6838 test_name field1 field2;
6839 pr " r->%s, r->%s);\n" field1 field2;
6844 List.iter (generate_test_command_call test_name) seq;
6845 generate_test_command_call ~test test_name last
6846 | TestLastFail seq ->
6847 pr " /* TestLastFail for %s (%d) */\n" name i;
6848 let seq, last = get_seq_last seq in
6849 List.iter (generate_test_command_call test_name) seq;
6850 generate_test_command_call test_name ~expect_error:true last
6852 (* Generate the code to run a command, leaving the result in 'r'.
6853 * If you expect to get an error then you should set expect_error:true.
6855 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
6857 | [] -> assert false
6859 (* Look up the command to find out what args/ret it has. *)
6862 let _, style, _, _, _, _, _ =
6863 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
6866 failwithf "%s: in test, command %s was not found" test_name name in
6868 if List.length (snd style) <> List.length args then
6869 failwithf "%s: in test, wrong number of args given to %s"
6876 | OptString n, "NULL" -> ()
6879 | Dev_or_Path n, arg
6881 | OptString n, arg ->
6882 pr " const char *%s = \"%s\";\n" n (c_quote arg);
6886 | FileIn _, _ | FileOut _, _ -> ()
6887 | StringList n, "" | DeviceList n, "" ->
6888 pr " const char *const %s[1] = { NULL };\n" n
6889 | StringList n, arg | DeviceList n, arg ->
6890 let strs = string_split " " arg in
6893 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
6895 pr " const char *const %s[] = {\n" n;
6897 fun i _ -> pr " %s_%d,\n" n i
6901 ) (List.combine (snd style) args);
6904 match fst style with
6905 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6906 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6907 | RConstString _ | RConstOptString _ ->
6908 pr " const char *r;\n"; "NULL"
6909 | RString _ -> pr " char *r;\n"; "NULL"
6910 | RStringList _ | RHashtable _ ->
6914 | RStruct (_, typ) ->
6915 pr " struct guestfs_%s *r;\n" typ; "NULL"
6916 | RStructList (_, typ) ->
6917 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6920 pr " size_t size;\n";
6923 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
6924 pr " r = guestfs_%s (g" name;
6926 (* Generate the parameters. *)
6929 | OptString _, "NULL" -> pr ", NULL"
6931 | Device n, _ | Dev_or_Path n, _
6935 | FileIn _, arg | FileOut _, arg ->
6936 pr ", \"%s\"" (c_quote arg)
6937 | StringList n, _ | DeviceList n, _ ->
6938 pr ", (char **) %s" n
6941 try int_of_string arg
6942 with Failure "int_of_string" ->
6943 failwithf "%s: expecting an int, but got '%s'" test_name arg in
6947 try Int64.of_string arg
6948 with Failure "int_of_string" ->
6949 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
6952 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
6953 ) (List.combine (snd style) args);
6955 (match fst style with
6956 | RBufferOut _ -> pr ", &size"
6962 if not expect_error then
6963 pr " if (r == %s)\n" error_code
6965 pr " if (r != %s)\n" error_code;
6968 (* Insert the test code. *)
6974 (match fst style with
6975 | RErr | RInt _ | RInt64 _ | RBool _
6976 | RConstString _ | RConstOptString _ -> ()
6977 | RString _ | RBufferOut _ -> pr " free (r);\n"
6978 | RStringList _ | RHashtable _ ->
6979 pr " for (i = 0; r[i] != NULL; ++i)\n";
6980 pr " free (r[i]);\n";
6982 | RStruct (_, typ) ->
6983 pr " guestfs_free_%s (r);\n" typ
6984 | RStructList (_, typ) ->
6985 pr " guestfs_free_%s_list (r);\n" typ
6991 let str = replace_str str "\r" "\\r" in
6992 let str = replace_str str "\n" "\\n" in
6993 let str = replace_str str "\t" "\\t" in
6994 let str = replace_str str "\000" "\\0" in
6997 (* Generate a lot of different functions for guestfish. *)
6998 and generate_fish_cmds () =
6999 generate_header CStyle GPLv2plus;
7003 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7005 let all_functions_sorted =
7007 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7008 ) all_functions_sorted in
7010 pr "#include <config.h>\n";
7012 pr "#include <stdio.h>\n";
7013 pr "#include <stdlib.h>\n";
7014 pr "#include <string.h>\n";
7015 pr "#include <inttypes.h>\n";
7017 pr "#include <guestfs.h>\n";
7018 pr "#include \"c-ctype.h\"\n";
7019 pr "#include \"full-write.h\"\n";
7020 pr "#include \"xstrtol.h\"\n";
7021 pr "#include \"fish.h\"\n";
7024 (* list_commands function, which implements guestfish -h *)
7025 pr "void list_commands (void)\n";
7027 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7028 pr " list_builtin_commands ();\n";
7030 fun (name, _, _, flags, _, shortdesc, _) ->
7031 let name = replace_char name '_' '-' in
7032 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7034 ) all_functions_sorted;
7035 pr " printf (\" %%s\\n\",";
7036 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7040 (* display_command function, which implements guestfish -h cmd *)
7041 pr "void display_command (const char *cmd)\n";
7044 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7045 let name2 = replace_char name '_' '-' in
7047 try find_map (function FishAlias n -> Some n | _ -> None) flags
7048 with Not_found -> name in
7049 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7051 match snd style with
7055 name2 (String.concat " " (List.map name_of_argt args)) in
7058 if List.mem ProtocolLimitWarning flags then
7059 ("\n\n" ^ protocol_limit_warning)
7062 (* For DangerWillRobinson commands, we should probably have
7063 * guestfish prompt before allowing you to use them (especially
7064 * in interactive mode). XXX
7068 if List.mem DangerWillRobinson flags then
7069 ("\n\n" ^ danger_will_robinson)
7074 match deprecation_notice flags with
7076 | Some txt -> "\n\n" ^ txt in
7078 let describe_alias =
7079 if name <> alias then
7080 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7084 pr "STRCASEEQ (cmd, \"%s\")" name;
7085 if name <> name2 then
7086 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7087 if name <> alias then
7088 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7090 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7092 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7093 "=head1 DESCRIPTION\n\n" ^
7094 longdesc ^ warnings ^ describe_alias);
7097 pr " display_builtin_command (cmd);\n";
7101 let emit_print_list_function typ =
7102 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7105 pr " unsigned int i;\n";
7107 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7108 pr " printf (\"[%%d] = {\\n\", i);\n";
7109 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7110 pr " printf (\"}\\n\");\n";
7116 (* print_* functions *)
7120 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7122 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7125 pr " unsigned int i;\n";
7131 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7133 pr " printf (\"%%s%s: \", indent);\n" name;
7134 pr " for (i = 0; i < 32; ++i)\n";
7135 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7136 pr " printf (\"\\n\");\n"
7138 pr " printf (\"%%s%s: \", indent);\n" name;
7139 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7140 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7141 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7143 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7144 pr " printf (\"\\n\");\n"
7145 | name, (FUInt64|FBytes) ->
7146 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7149 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7152 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7155 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7158 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7160 | name, FOptPercent ->
7161 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7162 typ name name typ name;
7163 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7169 (* Emit a print_TYPE_list function definition only if that function is used. *)
7172 | typ, (RStructListOnly | RStructAndList) ->
7173 (* generate the function for typ *)
7174 emit_print_list_function typ
7175 | typ, _ -> () (* empty *)
7176 ) (rstructs_used_by all_functions);
7178 (* Emit a print_TYPE function definition only if that function is used. *)
7181 | typ, (RStructOnly | RStructAndList) ->
7182 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7184 pr " print_%s_indent (%s, \"\");\n" typ typ;
7187 | typ, _ -> () (* empty *)
7188 ) (rstructs_used_by all_functions);
7190 (* run_<action> actions *)
7192 fun (name, style, _, flags, _, _, _) ->
7193 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7195 (match fst style with
7198 | RBool _ -> pr " int r;\n"
7199 | RInt64 _ -> pr " int64_t r;\n"
7200 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7201 | RString _ -> pr " char *r;\n"
7202 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7203 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7204 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7207 pr " size_t size;\n";
7215 | FileOut n -> pr " const char *%s;\n" n
7217 | Dev_or_Path n -> pr " char *%s;\n" n
7218 | StringList n | DeviceList n -> pr " char **%s;\n" n
7219 | Bool n -> pr " int %s;\n" n
7220 | Int n -> pr " int %s;\n" n
7221 | Int64 n -> pr " int64_t %s;\n" n
7224 (* Check and convert parameters. *)
7225 let argc_expected = List.length (snd style) in
7226 pr " if (argc != %d) {\n" argc_expected;
7227 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7229 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7233 let parse_integer fn fntyp rtyp range name i =
7235 pr " strtol_error xerr;\n";
7236 pr " %s r;\n" fntyp;
7238 pr " xerr = %s (argv[%d], NULL, 0, &r, \"\");\n" fn i;
7239 pr " if (xerr != LONGINT_OK) {\n";
7240 pr " fprintf (stderr,\n";
7241 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7242 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7247 | Some (min, max, comment) ->
7248 pr " /* %s */\n" comment;
7249 pr " if (r < %s || r > %s) {\n" min max;
7250 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7254 pr " /* The check above should ensure this assignment does not overflow. */\n";
7256 pr " %s = r;\n" name;
7265 pr " %s = argv[%d];\n" name i
7267 | Dev_or_Path name ->
7268 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7269 pr " if (%s == NULL) return -1;\n" name
7271 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7274 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7277 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7279 | StringList name | DeviceList name ->
7280 pr " %s = parse_string_list (argv[%d]);\n" name i;
7281 pr " if (%s == NULL) return -1;\n" name;
7283 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7286 let min = "(-(2LL<<30))"
7287 and max = "((2LL<<30)-1)"
7289 "The Int type in the generator is a signed 31 bit int." in
7290 Some (min, max, comment) in
7291 parse_integer "xstrtoll" "long long" "int" range name i
7293 parse_integer "xstrtoll" "long long" "int64_t" None name i
7296 (* Call C API function. *)
7298 try find_map (function FishAction n -> Some n | _ -> None) flags
7299 with Not_found -> sprintf "guestfs_%s" name in
7301 generate_c_call_args ~handle:"g" style;
7306 | Device name | String name
7307 | OptString name | FileIn name | FileOut name | Bool name
7308 | Int name | Int64 name -> ()
7309 | Pathname name | Dev_or_Path name ->
7310 pr " free (%s);\n" name
7311 | StringList name | DeviceList name ->
7312 pr " free_strings (%s);\n" name
7315 (* Check return value for errors and display command results. *)
7316 (match fst style with
7317 | RErr -> pr " return r;\n"
7319 pr " if (r == -1) return -1;\n";
7320 pr " printf (\"%%d\\n\", r);\n";
7323 pr " if (r == -1) return -1;\n";
7324 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7327 pr " if (r == -1) return -1;\n";
7328 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7331 pr " if (r == NULL) return -1;\n";
7332 pr " printf (\"%%s\\n\", r);\n";
7334 | RConstOptString _ ->
7335 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7338 pr " if (r == NULL) return -1;\n";
7339 pr " printf (\"%%s\\n\", r);\n";
7343 pr " if (r == NULL) return -1;\n";
7344 pr " print_strings (r);\n";
7345 pr " free_strings (r);\n";
7347 | RStruct (_, typ) ->
7348 pr " if (r == NULL) return -1;\n";
7349 pr " print_%s (r);\n" typ;
7350 pr " guestfs_free_%s (r);\n" typ;
7352 | RStructList (_, typ) ->
7353 pr " if (r == NULL) return -1;\n";
7354 pr " print_%s_list (r);\n" typ;
7355 pr " guestfs_free_%s_list (r);\n" typ;
7358 pr " if (r == NULL) return -1;\n";
7359 pr " print_table (r);\n";
7360 pr " free_strings (r);\n";
7363 pr " if (r == NULL) return -1;\n";
7364 pr " if (full_write (1, r, size) != size) {\n";
7365 pr " perror (\"write\");\n";
7376 (* run_action function *)
7377 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7380 fun (name, _, _, flags, _, _, _) ->
7381 let name2 = replace_char name '_' '-' in
7383 try find_map (function FishAlias n -> Some n | _ -> None) flags
7384 with Not_found -> name in
7386 pr "STRCASEEQ (cmd, \"%s\")" name;
7387 if name <> name2 then
7388 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7389 if name <> alias then
7390 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7392 pr " return run_%s (cmd, argc, argv);\n" name;
7396 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7403 (* Readline completion for guestfish. *)
7404 and generate_fish_completion () =
7405 generate_header CStyle GPLv2plus;
7409 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7419 #ifdef HAVE_LIBREADLINE
7420 #include <readline/readline.h>
7425 #ifdef HAVE_LIBREADLINE
7427 static const char *const commands[] = {
7428 BUILTIN_COMMANDS_FOR_COMPLETION,
7431 (* Get the commands, including the aliases. They don't need to be
7432 * sorted - the generator() function just does a dumb linear search.
7436 fun (name, _, _, flags, _, _, _) ->
7437 let name2 = replace_char name '_' '-' in
7439 try find_map (function FishAlias n -> Some n | _ -> None) flags
7440 with Not_found -> name in
7442 if name <> alias then [name2; alias] else [name2]
7444 let commands = List.flatten commands in
7446 List.iter (pr " \"%s\",\n") commands;
7452 generator (const char *text, int state)
7454 static int index, len;
7459 len = strlen (text);
7462 rl_attempted_completion_over = 1;
7464 while ((name = commands[index]) != NULL) {
7466 if (STRCASEEQLEN (name, text, len))
7467 return strdup (name);
7473 #endif /* HAVE_LIBREADLINE */
7475 #ifdef HAVE_RL_COMPLETION_MATCHES
7476 #define RL_COMPLETION_MATCHES rl_completion_matches
7478 #ifdef HAVE_COMPLETION_MATCHES
7479 #define RL_COMPLETION_MATCHES completion_matches
7481 #endif /* else just fail if we don't have either symbol */
7484 do_completion (const char *text, int start, int end)
7486 char **matches = NULL;
7488 #ifdef HAVE_LIBREADLINE
7489 rl_completion_append_character = ' ';
7492 matches = RL_COMPLETION_MATCHES (text, generator);
7493 else if (complete_dest_paths)
7494 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7501 (* Generate the POD documentation for guestfish. *)
7502 and generate_fish_actions_pod () =
7503 let all_functions_sorted =
7505 fun (_, _, _, flags, _, _, _) ->
7506 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7507 ) all_functions_sorted in
7509 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7512 fun (name, style, _, flags, _, _, longdesc) ->
7514 Str.global_substitute rex (
7517 try Str.matched_group 1 s
7519 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7520 "C<" ^ replace_char sub '_' '-' ^ ">"
7522 let name = replace_char name '_' '-' in
7524 try find_map (function FishAlias n -> Some n | _ -> None) flags
7525 with Not_found -> name in
7527 pr "=head2 %s" name;
7528 if name <> alias then
7535 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7536 | OptString n -> pr " %s" n
7537 | StringList n | DeviceList n -> pr " '%s ...'" n
7538 | Bool _ -> pr " true|false"
7539 | Int n -> pr " %s" n
7540 | Int64 n -> pr " %s" n
7541 | FileIn n | FileOut n -> pr " (%s|-)" n
7545 pr "%s\n\n" longdesc;
7547 if List.exists (function FileIn _ | FileOut _ -> true
7548 | _ -> false) (snd style) then
7549 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7551 if List.mem ProtocolLimitWarning flags then
7552 pr "%s\n\n" protocol_limit_warning;
7554 if List.mem DangerWillRobinson flags then
7555 pr "%s\n\n" danger_will_robinson;
7557 match deprecation_notice flags with
7559 | Some txt -> pr "%s\n\n" txt
7560 ) all_functions_sorted
7562 (* Generate a C function prototype. *)
7563 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7564 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7566 ?handle name style =
7567 if extern then pr "extern ";
7568 if static then pr "static ";
7569 (match fst style with
7571 | RInt _ -> pr "int "
7572 | RInt64 _ -> pr "int64_t "
7573 | RBool _ -> pr "int "
7574 | RConstString _ | RConstOptString _ -> pr "const char *"
7575 | RString _ | RBufferOut _ -> pr "char *"
7576 | RStringList _ | RHashtable _ -> pr "char **"
7577 | RStruct (_, typ) ->
7578 if not in_daemon then pr "struct guestfs_%s *" typ
7579 else pr "guestfs_int_%s *" typ
7580 | RStructList (_, typ) ->
7581 if not in_daemon then pr "struct guestfs_%s_list *" typ
7582 else pr "guestfs_int_%s_list *" typ
7584 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7585 pr "%s%s (" prefix name;
7586 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7589 let comma = ref false in
7592 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7596 if single_line then pr ", " else pr ",\n\t\t"
7603 | Device n | Dev_or_Path n
7607 pr "const char *%s" n
7608 | StringList n | DeviceList n ->
7610 pr "char *const *%s" n
7611 | Bool n -> next (); pr "int %s" n
7612 | Int n -> next (); pr "int %s" n
7613 | Int64 n -> next (); pr "int64_t %s" n
7616 if not in_daemon then (next (); pr "const char *%s" n)
7618 if is_RBufferOut then (next (); pr "size_t *size_r");
7621 if semicolon then pr ";";
7622 if newline then pr "\n"
7624 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7625 and generate_c_call_args ?handle ?(decl = false) style =
7627 let comma = ref false in
7629 if !comma then pr ", ";
7634 | Some handle -> pr "%s" handle; comma := true
7639 pr "%s" (name_of_argt arg)
7641 (* For RBufferOut calls, add implicit &size parameter. *)
7643 match fst style with
7651 (* Generate the OCaml bindings interface. *)
7652 and generate_ocaml_mli () =
7653 generate_header OCamlStyle LGPLv2plus;
7656 (** For API documentation you should refer to the C API
7657 in the guestfs(3) manual page. The OCaml API uses almost
7658 exactly the same calls. *)
7661 (** A [guestfs_h] handle. *)
7663 exception Error of string
7664 (** This exception is raised when there is an error. *)
7666 exception Handle_closed of string
7667 (** This exception is raised if you use a {!Guestfs.t} handle
7668 after calling {!close} on it. The string is the name of
7671 val create : unit -> t
7672 (** Create a {!Guestfs.t} handle. *)
7674 val close : t -> unit
7675 (** Close the {!Guestfs.t} handle and free up all resources used
7678 Handles are closed by the garbage collector when they become
7679 unreferenced, but callers can call this in order to provide
7680 predictable cleanup. *)
7683 generate_ocaml_structure_decls ();
7687 fun (name, style, _, _, _, shortdesc, _) ->
7688 generate_ocaml_prototype name style;
7689 pr "(** %s *)\n" shortdesc;
7691 ) all_functions_sorted
7693 (* Generate the OCaml bindings implementation. *)
7694 and generate_ocaml_ml () =
7695 generate_header OCamlStyle LGPLv2plus;
7700 exception Error of string
7701 exception Handle_closed of string
7703 external create : unit -> t = \"ocaml_guestfs_create\"
7704 external close : t -> unit = \"ocaml_guestfs_close\"
7706 (* Give the exceptions names, so they can be raised from the C code. *)
7708 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7709 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7713 generate_ocaml_structure_decls ();
7717 fun (name, style, _, _, _, shortdesc, _) ->
7718 generate_ocaml_prototype ~is_external:true name style;
7719 ) all_functions_sorted
7721 (* Generate the OCaml bindings C implementation. *)
7722 and generate_ocaml_c () =
7723 generate_header CStyle LGPLv2plus;
7730 #include <caml/config.h>
7731 #include <caml/alloc.h>
7732 #include <caml/callback.h>
7733 #include <caml/fail.h>
7734 #include <caml/memory.h>
7735 #include <caml/mlvalues.h>
7736 #include <caml/signals.h>
7738 #include <guestfs.h>
7740 #include \"guestfs_c.h\"
7742 /* Copy a hashtable of string pairs into an assoc-list. We return
7743 * the list in reverse order, but hashtables aren't supposed to be
7746 static CAMLprim value
7747 copy_table (char * const * argv)
7750 CAMLlocal5 (rv, pairv, kv, vv, cons);
7754 for (i = 0; argv[i] != NULL; i += 2) {
7755 kv = caml_copy_string (argv[i]);
7756 vv = caml_copy_string (argv[i+1]);
7757 pairv = caml_alloc (2, 0);
7758 Store_field (pairv, 0, kv);
7759 Store_field (pairv, 1, vv);
7760 cons = caml_alloc (2, 0);
7761 Store_field (cons, 1, rv);
7763 Store_field (cons, 0, pairv);
7771 (* Struct copy functions. *)
7773 let emit_ocaml_copy_list_function typ =
7774 pr "static CAMLprim value\n";
7775 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7777 pr " CAMLparam0 ();\n";
7778 pr " CAMLlocal2 (rv, v);\n";
7779 pr " unsigned int i;\n";
7781 pr " if (%ss->len == 0)\n" typ;
7782 pr " CAMLreturn (Atom (0));\n";
7784 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7785 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7786 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7787 pr " caml_modify (&Field (rv, i), v);\n";
7789 pr " CAMLreturn (rv);\n";
7797 let has_optpercent_col =
7798 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7800 pr "static CAMLprim value\n";
7801 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7803 pr " CAMLparam0 ();\n";
7804 if has_optpercent_col then
7805 pr " CAMLlocal3 (rv, v, v2);\n"
7807 pr " CAMLlocal2 (rv, v);\n";
7809 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
7814 pr " v = caml_copy_string (%s->%s);\n" typ name
7816 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
7817 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
7820 pr " v = caml_alloc_string (32);\n";
7821 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
7822 | name, (FBytes|FInt64|FUInt64) ->
7823 pr " v = caml_copy_int64 (%s->%s);\n" typ name
7824 | name, (FInt32|FUInt32) ->
7825 pr " v = caml_copy_int32 (%s->%s);\n" typ name
7826 | name, FOptPercent ->
7827 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
7828 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
7829 pr " v = caml_alloc (1, 0);\n";
7830 pr " Store_field (v, 0, v2);\n";
7831 pr " } else /* None */\n";
7832 pr " v = Val_int (0);\n";
7834 pr " v = Val_int (%s->%s);\n" typ name
7836 pr " Store_field (rv, %d, v);\n" i
7838 pr " CAMLreturn (rv);\n";
7843 (* Emit a copy_TYPE_list function definition only if that function is used. *)
7846 | typ, (RStructListOnly | RStructAndList) ->
7847 (* generate the function for typ *)
7848 emit_ocaml_copy_list_function typ
7849 | typ, _ -> () (* empty *)
7850 ) (rstructs_used_by all_functions);
7854 fun (name, style, _, _, _, _, _) ->
7855 pr "/* Automatically generated wrapper for function\n";
7857 generate_ocaml_prototype name style;
7862 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
7864 let needs_extra_vs =
7865 match fst style with RConstOptString _ -> true | _ -> false in
7867 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7868 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
7869 List.iter (pr ", value %s") (List.tl params); pr ");\n";
7872 pr "CAMLprim value\n";
7873 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
7874 List.iter (pr ", value %s") (List.tl params);
7879 | [p1; p2; p3; p4; p5] ->
7880 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
7881 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
7882 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
7883 pr " CAMLxparam%d (%s);\n"
7884 (List.length rest) (String.concat ", " rest)
7886 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
7888 if not needs_extra_vs then
7889 pr " CAMLlocal1 (rv);\n"
7891 pr " CAMLlocal3 (rv, v, v2);\n";
7894 pr " guestfs_h *g = Guestfs_val (gv);\n";
7895 pr " if (g == NULL)\n";
7896 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
7902 | Device n | Dev_or_Path n
7906 pr " const char *%s = String_val (%sv);\n" n n
7908 pr " const char *%s =\n" n;
7909 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
7911 | StringList n | DeviceList n ->
7912 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
7914 pr " int %s = Bool_val (%sv);\n" n n
7916 pr " int %s = Int_val (%sv);\n" n n
7918 pr " int64_t %s = Int64_val (%sv);\n" n n
7921 match fst style with
7922 | RErr -> pr " int r;\n"; "-1"
7923 | RInt _ -> pr " int r;\n"; "-1"
7924 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7925 | RBool _ -> pr " int r;\n"; "-1"
7926 | RConstString _ | RConstOptString _ ->
7927 pr " const char *r;\n"; "NULL"
7928 | RString _ -> pr " char *r;\n"; "NULL"
7933 | RStruct (_, typ) ->
7934 pr " struct guestfs_%s *r;\n" typ; "NULL"
7935 | RStructList (_, typ) ->
7936 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7943 pr " size_t size;\n";
7947 pr " caml_enter_blocking_section ();\n";
7948 pr " r = guestfs_%s " name;
7949 generate_c_call_args ~handle:"g" style;
7951 pr " caml_leave_blocking_section ();\n";
7955 | StringList n | DeviceList n ->
7956 pr " ocaml_guestfs_free_strings (%s);\n" n;
7957 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
7958 | Bool _ | Int _ | Int64 _
7959 | FileIn _ | FileOut _ -> ()
7962 pr " if (r == %s)\n" error_code;
7963 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
7966 (match fst style with
7967 | RErr -> pr " rv = Val_unit;\n"
7968 | RInt _ -> pr " rv = Val_int (r);\n"
7970 pr " rv = caml_copy_int64 (r);\n"
7971 | RBool _ -> pr " rv = Val_bool (r);\n"
7973 pr " rv = caml_copy_string (r);\n"
7974 | RConstOptString _ ->
7975 pr " if (r) { /* Some string */\n";
7976 pr " v = caml_alloc (1, 0);\n";
7977 pr " v2 = caml_copy_string (r);\n";
7978 pr " Store_field (v, 0, v2);\n";
7979 pr " } else /* None */\n";
7980 pr " v = Val_int (0);\n";
7982 pr " rv = caml_copy_string (r);\n";
7985 pr " rv = caml_copy_string_array ((const char **) r);\n";
7986 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7988 | RStruct (_, typ) ->
7989 pr " rv = copy_%s (r);\n" typ;
7990 pr " guestfs_free_%s (r);\n" typ;
7991 | RStructList (_, typ) ->
7992 pr " rv = copy_%s_list (r);\n" typ;
7993 pr " guestfs_free_%s_list (r);\n" typ;
7995 pr " rv = copy_table (r);\n";
7996 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7999 pr " rv = caml_alloc_string (size);\n";
8000 pr " memcpy (String_val (rv), r, size);\n";
8003 pr " CAMLreturn (rv);\n";
8007 if List.length params > 5 then (
8008 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8009 pr "CAMLprim value ";
8010 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8011 pr "CAMLprim value\n";
8012 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8014 pr " return ocaml_guestfs_%s (argv[0]" name;
8015 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8020 ) all_functions_sorted
8022 and generate_ocaml_structure_decls () =
8025 pr "type %s = {\n" typ;
8028 | name, FString -> pr " %s : string;\n" name
8029 | name, FBuffer -> pr " %s : string;\n" name
8030 | name, FUUID -> pr " %s : string;\n" name
8031 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8032 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8033 | name, FChar -> pr " %s : char;\n" name
8034 | name, FOptPercent -> pr " %s : float option;\n" name
8040 and generate_ocaml_prototype ?(is_external = false) name style =
8041 if is_external then pr "external " else pr "val ";
8042 pr "%s : t -> " name;
8045 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
8046 | OptString _ -> pr "string option -> "
8047 | StringList _ | DeviceList _ -> pr "string array -> "
8048 | Bool _ -> pr "bool -> "
8049 | Int _ -> pr "int -> "
8050 | Int64 _ -> pr "int64 -> "
8052 (match fst style with
8053 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8054 | RInt _ -> pr "int"
8055 | RInt64 _ -> pr "int64"
8056 | RBool _ -> pr "bool"
8057 | RConstString _ -> pr "string"
8058 | RConstOptString _ -> pr "string option"
8059 | RString _ | RBufferOut _ -> pr "string"
8060 | RStringList _ -> pr "string array"
8061 | RStruct (_, typ) -> pr "%s" typ
8062 | RStructList (_, typ) -> pr "%s array" typ
8063 | RHashtable _ -> pr "(string * string) list"
8065 if is_external then (
8067 if List.length (snd style) + 1 > 5 then
8068 pr "\"ocaml_guestfs_%s_byte\" " name;
8069 pr "\"ocaml_guestfs_%s\"" name
8073 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8074 and generate_perl_xs () =
8075 generate_header CStyle LGPLv2plus;
8078 #include \"EXTERN.h\"
8082 #include <guestfs.h>
8085 #define PRId64 \"lld\"
8089 my_newSVll(long long val) {
8090 #ifdef USE_64_BIT_ALL
8091 return newSViv(val);
8095 len = snprintf(buf, 100, \"%%\" PRId64, val);
8096 return newSVpv(buf, len);
8101 #define PRIu64 \"llu\"
8105 my_newSVull(unsigned long long val) {
8106 #ifdef USE_64_BIT_ALL
8107 return newSVuv(val);
8111 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8112 return newSVpv(buf, len);
8116 /* http://www.perlmonks.org/?node_id=680842 */
8118 XS_unpack_charPtrPtr (SV *arg) {
8123 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8124 croak (\"array reference expected\");
8126 av = (AV *)SvRV (arg);
8127 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8129 croak (\"malloc failed\");
8131 for (i = 0; i <= av_len (av); i++) {
8132 SV **elem = av_fetch (av, i, 0);
8134 if (!elem || !*elem)
8135 croak (\"missing element in list\");
8137 ret[i] = SvPV_nolen (*elem);
8145 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8152 RETVAL = guestfs_create ();
8154 croak (\"could not create guestfs handle\");
8155 guestfs_set_error_handler (RETVAL, NULL, NULL);
8168 fun (name, style, _, _, _, _, _) ->
8169 (match fst style with
8170 | RErr -> pr "void\n"
8171 | RInt _ -> pr "SV *\n"
8172 | RInt64 _ -> pr "SV *\n"
8173 | RBool _ -> pr "SV *\n"
8174 | RConstString _ -> pr "SV *\n"
8175 | RConstOptString _ -> pr "SV *\n"
8176 | RString _ -> pr "SV *\n"
8177 | RBufferOut _ -> pr "SV *\n"
8179 | RStruct _ | RStructList _
8181 pr "void\n" (* all lists returned implictly on the stack *)
8183 (* Call and arguments. *)
8185 generate_c_call_args ~handle:"g" ~decl:true style;
8187 pr " guestfs_h *g;\n";
8191 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8194 (* http://www.perlmonks.org/?node_id=554277
8195 * Note that the implicit handle argument means we have
8196 * to add 1 to the ST(x) operator.
8198 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8199 | StringList n | DeviceList n -> pr " char **%s;\n" n
8200 | Bool n -> pr " int %s;\n" n
8201 | Int n -> pr " int %s;\n" n
8202 | Int64 n -> pr " int64_t %s;\n" n
8205 let do_cleanups () =
8208 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8209 | Bool _ | Int _ | Int64 _
8210 | FileIn _ | FileOut _ -> ()
8211 | StringList n | DeviceList n -> pr " free (%s);\n" n
8216 (match fst style with
8221 pr " r = guestfs_%s " name;
8222 generate_c_call_args ~handle:"g" style;
8225 pr " if (r == -1)\n";
8226 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8232 pr " %s = guestfs_%s " n name;
8233 generate_c_call_args ~handle:"g" style;
8236 pr " if (%s == -1)\n" n;
8237 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8238 pr " RETVAL = newSViv (%s);\n" n;
8243 pr " int64_t %s;\n" n;
8245 pr " %s = guestfs_%s " n name;
8246 generate_c_call_args ~handle:"g" style;
8249 pr " if (%s == -1)\n" n;
8250 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8251 pr " RETVAL = my_newSVll (%s);\n" n;
8256 pr " const char *%s;\n" n;
8258 pr " %s = guestfs_%s " n name;
8259 generate_c_call_args ~handle:"g" style;
8262 pr " if (%s == NULL)\n" n;
8263 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8264 pr " RETVAL = newSVpv (%s, 0);\n" n;
8267 | RConstOptString n ->
8269 pr " const char *%s;\n" n;
8271 pr " %s = guestfs_%s " n name;
8272 generate_c_call_args ~handle:"g" style;
8275 pr " if (%s == NULL)\n" n;
8276 pr " RETVAL = &PL_sv_undef;\n";
8278 pr " RETVAL = newSVpv (%s, 0);\n" n;
8283 pr " char *%s;\n" n;
8285 pr " %s = guestfs_%s " n name;
8286 generate_c_call_args ~handle:"g" style;
8289 pr " if (%s == NULL)\n" n;
8290 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8291 pr " RETVAL = newSVpv (%s, 0);\n" n;
8292 pr " free (%s);\n" n;
8295 | RStringList n | RHashtable n ->
8297 pr " char **%s;\n" n;
8300 pr " %s = guestfs_%s " n name;
8301 generate_c_call_args ~handle:"g" style;
8304 pr " if (%s == NULL)\n" n;
8305 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8306 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8307 pr " EXTEND (SP, n);\n";
8308 pr " for (i = 0; i < n; ++i) {\n";
8309 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8310 pr " free (%s[i]);\n" n;
8312 pr " free (%s);\n" n;
8313 | RStruct (n, typ) ->
8314 let cols = cols_of_struct typ in
8315 generate_perl_struct_code typ cols name style n do_cleanups
8316 | RStructList (n, typ) ->
8317 let cols = cols_of_struct typ in
8318 generate_perl_struct_list_code typ cols name style n do_cleanups
8321 pr " char *%s;\n" n;
8322 pr " size_t size;\n";
8324 pr " %s = guestfs_%s " n name;
8325 generate_c_call_args ~handle:"g" style;
8328 pr " if (%s == NULL)\n" n;
8329 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8330 pr " RETVAL = newSVpv (%s, size);\n" n;
8331 pr " free (%s);\n" n;
8339 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8341 pr " struct guestfs_%s_list *%s;\n" typ n;
8345 pr " %s = guestfs_%s " n name;
8346 generate_c_call_args ~handle:"g" style;
8349 pr " if (%s == NULL)\n" n;
8350 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8351 pr " EXTEND (SP, %s->len);\n" n;
8352 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8353 pr " hv = newHV ();\n";
8357 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8358 name (String.length name) n name
8360 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8361 name (String.length name) n name
8363 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8364 name (String.length name) n name n name
8365 | name, (FBytes|FUInt64) ->
8366 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8367 name (String.length name) n name
8369 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8370 name (String.length name) n name
8371 | name, (FInt32|FUInt32) ->
8372 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8373 name (String.length name) n name
8375 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8376 name (String.length name) n name
8377 | name, FOptPercent ->
8378 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8379 name (String.length name) n name
8381 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8383 pr " guestfs_free_%s_list (%s);\n" typ n
8385 and generate_perl_struct_code typ cols name style n do_cleanups =
8387 pr " struct guestfs_%s *%s;\n" typ n;
8389 pr " %s = guestfs_%s " n name;
8390 generate_c_call_args ~handle:"g" style;
8393 pr " if (%s == NULL)\n" n;
8394 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8395 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8397 fun ((name, _) as col) ->
8398 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8402 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8405 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
8408 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8410 | name, (FBytes|FUInt64) ->
8411 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8414 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8416 | name, (FInt32|FUInt32) ->
8417 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8420 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8422 | name, FOptPercent ->
8423 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8426 pr " free (%s);\n" n
8428 (* Generate Sys/Guestfs.pm. *)
8429 and generate_perl_pm () =
8430 generate_header HashStyle LGPLv2plus;
8437 Sys::Guestfs - Perl bindings for libguestfs
8443 my $h = Sys::Guestfs->new ();
8444 $h->add_drive ('guest.img');
8446 $h->mount ('/dev/sda1', '/');
8447 $h->touch ('/hello');
8452 The C<Sys::Guestfs> module provides a Perl XS binding to the
8453 libguestfs API for examining and modifying virtual machine
8456 Amongst the things this is good for: making batch configuration
8457 changes to guests, getting disk used/free statistics (see also:
8458 virt-df), migrating between virtualization systems (see also:
8459 virt-p2v), performing partial backups, performing partial guest
8460 clones, cloning guests and changing registry/UUID/hostname info, and
8463 Libguestfs uses Linux kernel and qemu code, and can access any type of
8464 guest filesystem that Linux and qemu can, including but not limited
8465 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8466 schemes, qcow, qcow2, vmdk.
8468 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8469 LVs, what filesystem is in each LV, etc.). It can also run commands
8470 in the context of the guest. Also you can access filesystems over
8473 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8474 functions for using libguestfs from Perl, including integration
8479 All errors turn into calls to C<croak> (see L<Carp(3)>).
8487 package Sys::Guestfs;
8493 XSLoader::load ('Sys::Guestfs');
8495 =item $h = Sys::Guestfs->new ();
8497 Create a new guestfs handle.
8503 my $class = ref ($proto) || $proto;
8505 my $self = Sys::Guestfs::_create ();
8506 bless $self, $class;
8512 (* Actions. We only need to print documentation for these as
8513 * they are pulled in from the XS code automatically.
8516 fun (name, style, _, flags, _, _, longdesc) ->
8517 if not (List.mem NotInDocs flags) then (
8518 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8520 generate_perl_prototype name style;
8522 pr "%s\n\n" longdesc;
8523 if List.mem ProtocolLimitWarning flags then
8524 pr "%s\n\n" protocol_limit_warning;
8525 if List.mem DangerWillRobinson flags then
8526 pr "%s\n\n" danger_will_robinson;
8527 match deprecation_notice flags with
8529 | Some txt -> pr "%s\n\n" txt
8531 ) all_functions_sorted;
8543 Copyright (C) %s Red Hat Inc.
8547 Please see the file COPYING.LIB for the full license.
8553 L<http://libguestfs.org>,
8554 L<Sys::Guestfs::Lib(3)>.
8559 and generate_perl_prototype name style =
8560 (match fst style with
8568 | RBufferOut n -> pr "$%s = " n
8570 | RHashtable n -> pr "%%%s = " n
8572 | RStructList (n,_) -> pr "@%s = " n
8575 let comma = ref false in
8578 if !comma then pr ", ";
8581 | Pathname n | Device n | Dev_or_Path n | String n
8582 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8584 | StringList n | DeviceList n ->
8589 (* Generate Python C module. *)
8590 and generate_python_c () =
8591 generate_header CStyle LGPLv2plus;
8600 #include \"guestfs.h\"
8608 get_handle (PyObject *obj)
8611 assert (obj != Py_None);
8612 return ((Pyguestfs_Object *) obj)->g;
8616 put_handle (guestfs_h *g)
8620 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8623 /* This list should be freed (but not the strings) after use. */
8625 get_string_list (PyObject *obj)
8632 if (!PyList_Check (obj)) {
8633 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8637 len = PyList_Size (obj);
8638 r = malloc (sizeof (char *) * (len+1));
8640 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8644 for (i = 0; i < len; ++i)
8645 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8652 put_string_list (char * const * const argv)
8657 for (argc = 0; argv[argc] != NULL; ++argc)
8660 list = PyList_New (argc);
8661 for (i = 0; i < argc; ++i)
8662 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8668 put_table (char * const * const argv)
8670 PyObject *list, *item;
8673 for (argc = 0; argv[argc] != NULL; ++argc)
8676 list = PyList_New (argc >> 1);
8677 for (i = 0; i < argc; i += 2) {
8678 item = PyTuple_New (2);
8679 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8680 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8681 PyList_SetItem (list, i >> 1, item);
8688 free_strings (char **argv)
8692 for (argc = 0; argv[argc] != NULL; ++argc)
8698 py_guestfs_create (PyObject *self, PyObject *args)
8702 g = guestfs_create ();
8704 PyErr_SetString (PyExc_RuntimeError,
8705 \"guestfs.create: failed to allocate handle\");
8708 guestfs_set_error_handler (g, NULL, NULL);
8709 return put_handle (g);
8713 py_guestfs_close (PyObject *self, PyObject *args)
8718 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8720 g = get_handle (py_g);
8724 Py_INCREF (Py_None);
8730 let emit_put_list_function typ =
8731 pr "static PyObject *\n";
8732 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8734 pr " PyObject *list;\n";
8737 pr " list = PyList_New (%ss->len);\n" typ;
8738 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8739 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8740 pr " return list;\n";
8745 (* Structures, turned into Python dictionaries. *)
8748 pr "static PyObject *\n";
8749 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8751 pr " PyObject *dict;\n";
8753 pr " dict = PyDict_New ();\n";
8757 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8758 pr " PyString_FromString (%s->%s));\n"
8761 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8762 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8765 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8766 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8768 | name, (FBytes|FUInt64) ->
8769 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8770 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8773 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8774 pr " PyLong_FromLongLong (%s->%s));\n"
8777 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8778 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8781 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8782 pr " PyLong_FromLong (%s->%s));\n"
8784 | name, FOptPercent ->
8785 pr " if (%s->%s >= 0)\n" typ name;
8786 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8787 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8790 pr " Py_INCREF (Py_None);\n";
8791 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8794 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8795 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8797 pr " return dict;\n";
8803 (* Emit a put_TYPE_list function definition only if that function is used. *)
8806 | typ, (RStructListOnly | RStructAndList) ->
8807 (* generate the function for typ *)
8808 emit_put_list_function typ
8809 | typ, _ -> () (* empty *)
8810 ) (rstructs_used_by all_functions);
8812 (* Python wrapper functions. *)
8814 fun (name, style, _, _, _, _, _) ->
8815 pr "static PyObject *\n";
8816 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
8819 pr " PyObject *py_g;\n";
8820 pr " guestfs_h *g;\n";
8821 pr " PyObject *py_r;\n";
8824 match fst style with
8825 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8826 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8827 | RConstString _ | RConstOptString _ ->
8828 pr " const char *r;\n"; "NULL"
8829 | RString _ -> pr " char *r;\n"; "NULL"
8830 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8831 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8832 | RStructList (_, typ) ->
8833 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8836 pr " size_t size;\n";
8841 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8842 pr " const char *%s;\n" n
8843 | OptString n -> pr " const char *%s;\n" n
8844 | StringList n | DeviceList n ->
8845 pr " PyObject *py_%s;\n" n;
8846 pr " char **%s;\n" n
8847 | Bool n -> pr " int %s;\n" n
8848 | Int n -> pr " int %s;\n" n
8849 | Int64 n -> pr " long long %s;\n" n
8854 (* Convert the parameters. *)
8855 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
8858 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
8859 | OptString _ -> pr "z"
8860 | StringList _ | DeviceList _ -> pr "O"
8861 | Bool _ -> pr "i" (* XXX Python has booleans? *)
8863 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
8864 * emulate C's int/long/long long in Python?
8867 pr ":guestfs_%s\",\n" name;
8871 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
8872 | OptString n -> pr ", &%s" n
8873 | StringList n | DeviceList n -> pr ", &py_%s" n
8874 | Bool n -> pr ", &%s" n
8875 | Int n -> pr ", &%s" n
8876 | Int64 n -> pr ", &%s" n
8880 pr " return NULL;\n";
8882 pr " g = get_handle (py_g);\n";
8885 | Pathname _ | Device _ | Dev_or_Path _ | String _
8886 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8887 | StringList n | DeviceList n ->
8888 pr " %s = get_string_list (py_%s);\n" n n;
8889 pr " if (!%s) return NULL;\n" n
8894 pr " r = guestfs_%s " name;
8895 generate_c_call_args ~handle:"g" style;
8900 | Pathname _ | Device _ | Dev_or_Path _ | String _
8901 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8902 | StringList n | DeviceList n ->
8903 pr " free (%s);\n" n
8906 pr " if (r == %s) {\n" error_code;
8907 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
8908 pr " return NULL;\n";
8912 (match fst style with
8914 pr " Py_INCREF (Py_None);\n";
8915 pr " py_r = Py_None;\n"
8917 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
8918 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
8919 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
8920 | RConstOptString _ ->
8922 pr " py_r = PyString_FromString (r);\n";
8924 pr " Py_INCREF (Py_None);\n";
8925 pr " py_r = Py_None;\n";
8928 pr " py_r = PyString_FromString (r);\n";
8931 pr " py_r = put_string_list (r);\n";
8932 pr " free_strings (r);\n"
8933 | RStruct (_, typ) ->
8934 pr " py_r = put_%s (r);\n" typ;
8935 pr " guestfs_free_%s (r);\n" typ
8936 | RStructList (_, typ) ->
8937 pr " py_r = put_%s_list (r);\n" typ;
8938 pr " guestfs_free_%s_list (r);\n" typ
8940 pr " py_r = put_table (r);\n";
8941 pr " free_strings (r);\n"
8943 pr " py_r = PyString_FromStringAndSize (r, size);\n";
8947 pr " return py_r;\n";
8952 (* Table of functions. *)
8953 pr "static PyMethodDef methods[] = {\n";
8954 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
8955 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
8957 fun (name, _, _, _, _, _, _) ->
8958 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
8961 pr " { NULL, NULL, 0, NULL }\n";
8965 (* Init function. *)
8968 initlibguestfsmod (void)
8970 static int initialized = 0;
8972 if (initialized) return;
8973 Py_InitModule ((char *) \"libguestfsmod\", methods);
8978 (* Generate Python module. *)
8979 and generate_python_py () =
8980 generate_header HashStyle LGPLv2plus;
8983 u\"\"\"Python bindings for libguestfs
8986 g = guestfs.GuestFS ()
8987 g.add_drive (\"guest.img\")
8989 parts = g.list_partitions ()
8991 The guestfs module provides a Python binding to the libguestfs API
8992 for examining and modifying virtual machine disk images.
8994 Amongst the things this is good for: making batch configuration
8995 changes to guests, getting disk used/free statistics (see also:
8996 virt-df), migrating between virtualization systems (see also:
8997 virt-p2v), performing partial backups, performing partial guest
8998 clones, cloning guests and changing registry/UUID/hostname info, and
9001 Libguestfs uses Linux kernel and qemu code, and can access any type of
9002 guest filesystem that Linux and qemu can, including but not limited
9003 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9004 schemes, qcow, qcow2, vmdk.
9006 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9007 LVs, what filesystem is in each LV, etc.). It can also run commands
9008 in the context of the guest. Also you can access filesystems over
9011 Errors which happen while using the API are turned into Python
9012 RuntimeError exceptions.
9014 To create a guestfs handle you usually have to perform the following
9017 # Create the handle, call add_drive at least once, and possibly
9018 # several times if the guest has multiple block devices:
9019 g = guestfs.GuestFS ()
9020 g.add_drive (\"guest.img\")
9022 # Launch the qemu subprocess and wait for it to become ready:
9025 # Now you can issue commands, for example:
9030 import libguestfsmod
9033 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9035 def __init__ (self):
9036 \"\"\"Create a new libguestfs handle.\"\"\"
9037 self._o = libguestfsmod.create ()
9040 libguestfsmod.close (self._o)
9045 fun (name, style, _, flags, _, _, longdesc) ->
9047 generate_py_call_args ~handle:"self" (snd style);
9050 if not (List.mem NotInDocs flags) then (
9051 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9053 match fst style with
9054 | RErr | RInt _ | RInt64 _ | RBool _
9055 | RConstOptString _ | RConstString _
9056 | RString _ | RBufferOut _ -> doc
9058 doc ^ "\n\nThis function returns a list of strings."
9059 | RStruct (_, typ) ->
9060 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9061 | RStructList (_, typ) ->
9062 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9064 doc ^ "\n\nThis function returns a dictionary." in
9066 if List.mem ProtocolLimitWarning flags then
9067 doc ^ "\n\n" ^ protocol_limit_warning
9070 if List.mem DangerWillRobinson flags then
9071 doc ^ "\n\n" ^ danger_will_robinson
9074 match deprecation_notice flags with
9076 | Some txt -> doc ^ "\n\n" ^ txt in
9077 let doc = pod2text ~width:60 name doc in
9078 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9079 let doc = String.concat "\n " doc in
9080 pr " u\"\"\"%s\"\"\"\n" doc;
9082 pr " return libguestfsmod.%s " name;
9083 generate_py_call_args ~handle:"self._o" (snd style);
9088 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9089 and generate_py_call_args ~handle args =
9091 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9094 (* Useful if you need the longdesc POD text as plain text. Returns a
9097 * Because this is very slow (the slowest part of autogeneration),
9098 * we memoize the results.
9100 and pod2text ~width name longdesc =
9101 let key = width, name, longdesc in
9102 try Hashtbl.find pod2text_memo key
9104 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9105 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9107 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9108 let chan = open_process_in cmd in
9109 let lines = ref [] in
9111 let line = input_line chan in
9112 if i = 1 then (* discard the first line of output *)
9115 let line = triml line in
9116 lines := line :: !lines;
9119 let lines = try loop 1 with End_of_file -> List.rev !lines in
9121 (match close_process_in chan with
9124 failwithf "pod2text: process exited with non-zero status (%d)" i
9125 | WSIGNALED i | WSTOPPED i ->
9126 failwithf "pod2text: process signalled or stopped by signal %d" i
9128 Hashtbl.add pod2text_memo key lines;
9129 pod2text_memo_updated ();
9132 (* Generate ruby bindings. *)
9133 and generate_ruby_c () =
9134 generate_header CStyle LGPLv2plus;
9142 #include \"guestfs.h\"
9144 #include \"extconf.h\"
9146 /* For Ruby < 1.9 */
9148 #define RARRAY_LEN(r) (RARRAY((r))->len)
9151 static VALUE m_guestfs; /* guestfs module */
9152 static VALUE c_guestfs; /* guestfs_h handle */
9153 static VALUE e_Error; /* used for all errors */
9155 static void ruby_guestfs_free (void *p)
9158 guestfs_close ((guestfs_h *) p);
9161 static VALUE ruby_guestfs_create (VALUE m)
9165 g = guestfs_create ();
9167 rb_raise (e_Error, \"failed to create guestfs handle\");
9169 /* Don't print error messages to stderr by default. */
9170 guestfs_set_error_handler (g, NULL, NULL);
9172 /* Wrap it, and make sure the close function is called when the
9175 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9178 static VALUE ruby_guestfs_close (VALUE gv)
9181 Data_Get_Struct (gv, guestfs_h, g);
9183 ruby_guestfs_free (g);
9184 DATA_PTR (gv) = NULL;
9192 fun (name, style, _, _, _, _, _) ->
9193 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9194 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9197 pr " guestfs_h *g;\n";
9198 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9200 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9206 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9207 pr " Check_Type (%sv, T_STRING);\n" n;
9208 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9210 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9211 pr " \"%s\", \"%s\");\n" n name
9213 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9214 | StringList n | DeviceList n ->
9215 pr " char **%s;\n" n;
9216 pr " Check_Type (%sv, T_ARRAY);\n" n;
9218 pr " int i, len;\n";
9219 pr " len = RARRAY_LEN (%sv);\n" n;
9220 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9222 pr " for (i = 0; i < len; ++i) {\n";
9223 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9224 pr " %s[i] = StringValueCStr (v);\n" n;
9226 pr " %s[len] = NULL;\n" n;
9229 pr " int %s = RTEST (%sv);\n" n n
9231 pr " int %s = NUM2INT (%sv);\n" n n
9233 pr " long long %s = NUM2LL (%sv);\n" n n
9238 match fst style with
9239 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9240 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9241 | RConstString _ | RConstOptString _ ->
9242 pr " const char *r;\n"; "NULL"
9243 | RString _ -> pr " char *r;\n"; "NULL"
9244 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9245 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9246 | RStructList (_, typ) ->
9247 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9250 pr " size_t size;\n";
9254 pr " r = guestfs_%s " name;
9255 generate_c_call_args ~handle:"g" style;
9260 | Pathname _ | Device _ | Dev_or_Path _ | String _
9261 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9262 | StringList n | DeviceList n ->
9263 pr " free (%s);\n" n
9266 pr " if (r == %s)\n" error_code;
9267 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9270 (match fst style with
9272 pr " return Qnil;\n"
9273 | RInt _ | RBool _ ->
9274 pr " return INT2NUM (r);\n"
9276 pr " return ULL2NUM (r);\n"
9278 pr " return rb_str_new2 (r);\n";
9279 | RConstOptString _ ->
9281 pr " return rb_str_new2 (r);\n";
9283 pr " return Qnil;\n";
9285 pr " VALUE rv = rb_str_new2 (r);\n";
9289 pr " int i, len = 0;\n";
9290 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9291 pr " VALUE rv = rb_ary_new2 (len);\n";
9292 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9293 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9294 pr " free (r[i]);\n";
9298 | RStruct (_, typ) ->
9299 let cols = cols_of_struct typ in
9300 generate_ruby_struct_code typ cols
9301 | RStructList (_, typ) ->
9302 let cols = cols_of_struct typ in
9303 generate_ruby_struct_list_code typ cols
9305 pr " VALUE rv = rb_hash_new ();\n";
9307 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9308 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9309 pr " free (r[i]);\n";
9310 pr " free (r[i+1]);\n";
9315 pr " VALUE rv = rb_str_new (r, size);\n";
9325 /* Initialize the module. */
9326 void Init__guestfs ()
9328 m_guestfs = rb_define_module (\"Guestfs\");
9329 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9330 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9332 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9333 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9336 (* Define the rest of the methods. *)
9338 fun (name, style, _, _, _, _, _) ->
9339 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9340 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9345 (* Ruby code to return a struct. *)
9346 and generate_ruby_struct_code typ cols =
9347 pr " VALUE rv = rb_hash_new ();\n";
9351 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9353 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9355 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9356 | name, (FBytes|FUInt64) ->
9357 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9359 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9361 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9363 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9364 | name, FOptPercent ->
9365 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9366 | name, FChar -> (* XXX wrong? *)
9367 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9369 pr " guestfs_free_%s (r);\n" typ;
9372 (* Ruby code to return a struct list. *)
9373 and generate_ruby_struct_list_code typ cols =
9374 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9376 pr " for (i = 0; i < r->len; ++i) {\n";
9377 pr " VALUE hv = rb_hash_new ();\n";
9381 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9383 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
9385 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9386 | name, (FBytes|FUInt64) ->
9387 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9389 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9391 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9393 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9394 | name, FOptPercent ->
9395 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9396 | name, FChar -> (* XXX wrong? *)
9397 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9399 pr " rb_ary_push (rv, hv);\n";
9401 pr " guestfs_free_%s_list (r);\n" typ;
9404 (* Generate Java bindings GuestFS.java file. *)
9405 and generate_java_java () =
9406 generate_header CStyle LGPLv2plus;
9409 package com.redhat.et.libguestfs;
9411 import java.util.HashMap;
9412 import com.redhat.et.libguestfs.LibGuestFSException;
9413 import com.redhat.et.libguestfs.PV;
9414 import com.redhat.et.libguestfs.VG;
9415 import com.redhat.et.libguestfs.LV;
9416 import com.redhat.et.libguestfs.Stat;
9417 import com.redhat.et.libguestfs.StatVFS;
9418 import com.redhat.et.libguestfs.IntBool;
9419 import com.redhat.et.libguestfs.Dirent;
9422 * The GuestFS object is a libguestfs handle.
9426 public class GuestFS {
9427 // Load the native code.
9429 System.loadLibrary (\"guestfs_jni\");
9433 * The native guestfs_h pointer.
9438 * Create a libguestfs handle.
9440 * @throws LibGuestFSException
9442 public GuestFS () throws LibGuestFSException
9446 private native long _create () throws LibGuestFSException;
9449 * Close a libguestfs handle.
9451 * You can also leave handles to be collected by the garbage
9452 * collector, but this method ensures that the resources used
9453 * by the handle are freed up immediately. If you call any
9454 * other methods after closing the handle, you will get an
9457 * @throws LibGuestFSException
9459 public void close () throws LibGuestFSException
9465 private native void _close (long g) throws LibGuestFSException;
9467 public void finalize () throws LibGuestFSException
9475 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9476 if not (List.mem NotInDocs flags); then (
9477 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9479 if List.mem ProtocolLimitWarning flags then
9480 doc ^ "\n\n" ^ protocol_limit_warning
9483 if List.mem DangerWillRobinson flags then
9484 doc ^ "\n\n" ^ danger_will_robinson
9487 match deprecation_notice flags with
9489 | Some txt -> doc ^ "\n\n" ^ txt in
9490 let doc = pod2text ~width:60 name doc in
9491 let doc = List.map ( (* RHBZ#501883 *)
9494 | nonempty -> nonempty
9496 let doc = String.concat "\n * " doc in
9499 pr " * %s\n" shortdesc;
9502 pr " * @throws LibGuestFSException\n";
9506 generate_java_prototype ~public:true ~semicolon:false name style;
9509 pr " if (g == 0)\n";
9510 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9513 if fst style <> RErr then pr "return ";
9515 generate_java_call_args ~handle:"g" (snd style);
9519 generate_java_prototype ~privat:true ~native:true name style;
9526 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9527 and generate_java_call_args ~handle args =
9529 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9532 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9533 ?(semicolon=true) name style =
9534 if privat then pr "private ";
9535 if public then pr "public ";
9536 if native then pr "native ";
9539 (match fst style with
9540 | RErr -> pr "void ";
9541 | RInt _ -> pr "int ";
9542 | RInt64 _ -> pr "long ";
9543 | RBool _ -> pr "boolean ";
9544 | RConstString _ | RConstOptString _ | RString _
9545 | RBufferOut _ -> pr "String ";
9546 | RStringList _ -> pr "String[] ";
9547 | RStruct (_, typ) ->
9548 let name = java_name_of_struct typ in
9550 | RStructList (_, typ) ->
9551 let name = java_name_of_struct typ in
9553 | RHashtable _ -> pr "HashMap<String,String> ";
9556 if native then pr "_%s " name else pr "%s " name;
9558 let needs_comma = ref false in
9567 if !needs_comma then pr ", ";
9568 needs_comma := true;
9572 | Device n | Dev_or_Path n
9578 | StringList n | DeviceList n ->
9589 pr " throws LibGuestFSException";
9590 if semicolon then pr ";"
9592 and generate_java_struct jtyp cols () =
9593 generate_header CStyle LGPLv2plus;
9596 package com.redhat.et.libguestfs;
9599 * Libguestfs %s structure.
9611 | name, FBuffer -> pr " public String %s;\n" name
9612 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9613 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9614 | name, FChar -> pr " public char %s;\n" name
9615 | name, FOptPercent ->
9616 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9617 pr " public float %s;\n" name
9622 and generate_java_c () =
9623 generate_header CStyle LGPLv2plus;
9630 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9631 #include \"guestfs.h\"
9633 /* Note that this function returns. The exception is not thrown
9634 * until after the wrapper function returns.
9637 throw_exception (JNIEnv *env, const char *msg)
9640 cl = (*env)->FindClass (env,
9641 \"com/redhat/et/libguestfs/LibGuestFSException\");
9642 (*env)->ThrowNew (env, cl, msg);
9645 JNIEXPORT jlong JNICALL
9646 Java_com_redhat_et_libguestfs_GuestFS__1create
9647 (JNIEnv *env, jobject obj)
9651 g = guestfs_create ();
9653 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9656 guestfs_set_error_handler (g, NULL, NULL);
9657 return (jlong) (long) g;
9660 JNIEXPORT void JNICALL
9661 Java_com_redhat_et_libguestfs_GuestFS__1close
9662 (JNIEnv *env, jobject obj, jlong jg)
9664 guestfs_h *g = (guestfs_h *) (long) jg;
9671 fun (name, style, _, _, _, _, _) ->
9673 (match fst style with
9674 | RErr -> pr "void ";
9675 | RInt _ -> pr "jint ";
9676 | RInt64 _ -> pr "jlong ";
9677 | RBool _ -> pr "jboolean ";
9678 | RConstString _ | RConstOptString _ | RString _
9679 | RBufferOut _ -> pr "jstring ";
9680 | RStruct _ | RHashtable _ ->
9682 | RStringList _ | RStructList _ ->
9686 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9687 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9689 pr " (JNIEnv *env, jobject obj, jlong jg";
9693 | Device n | Dev_or_Path n
9698 pr ", jstring j%s" n
9699 | StringList n | DeviceList n ->
9700 pr ", jobjectArray j%s" n
9702 pr ", jboolean j%s" n
9710 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9711 let error_code, no_ret =
9712 match fst style with
9713 | RErr -> pr " int r;\n"; "-1", ""
9715 | RInt _ -> pr " int r;\n"; "-1", "0"
9716 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9717 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9718 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9720 pr " jstring jr;\n";
9721 pr " char *r;\n"; "NULL", "NULL"
9723 pr " jobjectArray jr;\n";
9726 pr " jstring jstr;\n";
9727 pr " char **r;\n"; "NULL", "NULL"
9728 | RStruct (_, typ) ->
9729 pr " jobject jr;\n";
9731 pr " jfieldID fl;\n";
9732 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9733 | RStructList (_, typ) ->
9734 pr " jobjectArray jr;\n";
9736 pr " jfieldID fl;\n";
9737 pr " jobject jfl;\n";
9738 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9739 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9741 pr " jstring jr;\n";
9743 pr " size_t size;\n";
9748 | Device n | Dev_or_Path n
9753 pr " const char *%s;\n" n
9754 | StringList n | DeviceList n ->
9755 pr " int %s_len;\n" n;
9756 pr " const char **%s;\n" n
9761 pr " int64_t %s;\n" n
9765 (match fst style with
9766 | RStringList _ | RStructList _ -> true
9767 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9769 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9770 List.exists (function
9771 | StringList _ -> true
9772 | DeviceList _ -> true
9773 | _ -> false) (snd style) in
9779 (* Get the parameters. *)
9783 | Device n | Dev_or_Path n
9787 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9789 (* This is completely undocumented, but Java null becomes
9792 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9793 | StringList n | DeviceList n ->
9794 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9795 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9796 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9797 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9799 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9801 pr " %s[%s_len] = NULL;\n" n n;
9805 pr " %s = j%s;\n" n n
9808 (* Make the call. *)
9809 pr " r = guestfs_%s " name;
9810 generate_c_call_args ~handle:"g" style;
9813 (* Release the parameters. *)
9817 | Device n | Dev_or_Path n
9821 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9824 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9825 | StringList n | DeviceList n ->
9826 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9827 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9829 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
9831 pr " free (%s);\n" n
9837 (* Check for errors. *)
9838 pr " if (r == %s) {\n" error_code;
9839 pr " throw_exception (env, guestfs_last_error (g));\n";
9840 pr " return %s;\n" no_ret;
9844 (match fst style with
9846 | RInt _ -> pr " return (jint) r;\n"
9847 | RBool _ -> pr " return (jboolean) r;\n"
9848 | RInt64 _ -> pr " return (jlong) r;\n"
9849 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
9850 | RConstOptString _ ->
9851 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
9853 pr " jr = (*env)->NewStringUTF (env, r);\n";
9857 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
9858 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
9859 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
9860 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
9861 pr " for (i = 0; i < r_len; ++i) {\n";
9862 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
9863 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
9864 pr " free (r[i]);\n";
9868 | RStruct (_, typ) ->
9869 let jtyp = java_name_of_struct typ in
9870 let cols = cols_of_struct typ in
9871 generate_java_struct_return typ jtyp cols
9872 | RStructList (_, typ) ->
9873 let jtyp = java_name_of_struct typ in
9874 let cols = cols_of_struct typ in
9875 generate_java_struct_list_return typ jtyp cols
9878 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
9879 pr " return NULL;\n"
9881 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
9890 and generate_java_struct_return typ jtyp cols =
9891 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9892 pr " jr = (*env)->AllocObject (env, cl);\n";
9896 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9897 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
9900 pr " char s[33];\n";
9901 pr " memcpy (s, r->%s, 32);\n" name;
9903 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9904 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9908 pr " int len = r->%s_len;\n" name;
9909 pr " char s[len+1];\n";
9910 pr " memcpy (s, r->%s, len);\n" name;
9911 pr " s[len] = 0;\n";
9912 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9913 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9915 | name, (FBytes|FUInt64|FInt64) ->
9916 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9917 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9918 | name, (FUInt32|FInt32) ->
9919 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9920 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9921 | name, FOptPercent ->
9922 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9923 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
9925 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9926 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9931 and generate_java_struct_list_return typ jtyp cols =
9932 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9933 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
9934 pr " for (i = 0; i < r->len; ++i) {\n";
9935 pr " jfl = (*env)->AllocObject (env, cl);\n";
9939 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9940 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
9943 pr " char s[33];\n";
9944 pr " memcpy (s, r->val[i].%s, 32);\n" name;
9946 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9947 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9951 pr " int len = r->val[i].%s_len;\n" name;
9952 pr " char s[len+1];\n";
9953 pr " memcpy (s, r->val[i].%s, len);\n" name;
9954 pr " s[len] = 0;\n";
9955 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9956 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9958 | name, (FBytes|FUInt64|FInt64) ->
9959 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9960 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9961 | name, (FUInt32|FInt32) ->
9962 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9963 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9964 | name, FOptPercent ->
9965 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9966 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
9968 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9969 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9971 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
9973 pr " guestfs_free_%s_list (r);\n" typ;
9976 and generate_java_makefile_inc () =
9977 generate_header HashStyle GPLv2plus;
9979 pr "java_built_sources = \\\n";
9982 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
9984 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
9986 and generate_haskell_hs () =
9987 generate_header HaskellStyle LGPLv2plus;
9989 (* XXX We only know how to generate partial FFI for Haskell
9990 * at the moment. Please help out!
9992 let can_generate style =
9996 | RInt64 _, _ -> true
9999 | RConstOptString _, _
10005 | RBufferOut _, _ -> false in
10008 {-# INCLUDE <guestfs.h> #-}
10009 {-# LANGUAGE ForeignFunctionInterface #-}
10014 (* List out the names of the actions we want to export. *)
10016 fun (name, style, _, _, _, _, _) ->
10017 if can_generate style then pr ",\n %s" name
10023 -- Unfortunately some symbols duplicate ones already present
10024 -- in Prelude. We don't know which, so we hard-code a list
10026 import Prelude hiding (truncate)
10030 import Foreign.C.Types
10032 import Control.Exception
10033 import Data.Typeable
10035 data GuestfsS = GuestfsS -- represents the opaque C struct
10036 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10037 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10039 -- XXX define properly later XXX
10043 data IntBool = IntBool
10045 data StatVFS = StatVFS
10046 data Hashtable = Hashtable
10048 foreign import ccall unsafe \"guestfs_create\" c_create
10050 foreign import ccall unsafe \"&guestfs_close\" c_close
10051 :: FunPtr (GuestfsP -> IO ())
10052 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10053 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10055 create :: IO GuestfsH
10058 c_set_error_handler p nullPtr nullPtr
10059 h <- newForeignPtr c_close p
10062 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10063 :: GuestfsP -> IO CString
10065 -- last_error :: GuestfsH -> IO (Maybe String)
10066 -- last_error h = do
10067 -- str <- withForeignPtr h (\\p -> c_last_error p)
10068 -- maybePeek peekCString str
10070 last_error :: GuestfsH -> IO (String)
10072 str <- withForeignPtr h (\\p -> c_last_error p)
10073 if (str == nullPtr)
10074 then return \"no error\"
10075 else peekCString str
10079 (* Generate wrappers for each foreign function. *)
10081 fun (name, style, _, _, _, _, _) ->
10082 if can_generate style then (
10083 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10085 generate_haskell_prototype ~handle:"GuestfsP" style;
10089 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10091 pr "%s %s = do\n" name
10092 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10094 (* Convert pointer arguments using with* functions. *)
10099 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
10100 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10101 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10102 | Bool _ | Int _ | Int64 _ -> ()
10104 (* Convert integer arguments. *)
10108 | Bool n -> sprintf "(fromBool %s)" n
10109 | Int n -> sprintf "(fromIntegral %s)" n
10110 | Int64 n -> sprintf "(fromIntegral %s)" n
10111 | FileIn n | FileOut n
10112 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10114 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10115 (String.concat " " ("p" :: args));
10116 (match fst style with
10117 | RErr | RInt _ | RInt64 _ | RBool _ ->
10118 pr " if (r == -1)\n";
10120 pr " err <- last_error h\n";
10122 | RConstString _ | RConstOptString _ | RString _
10123 | RStringList _ | RStruct _
10124 | RStructList _ | RHashtable _ | RBufferOut _ ->
10125 pr " if (r == nullPtr)\n";
10127 pr " err <- last_error h\n";
10130 (match fst style with
10132 pr " else return ()\n"
10134 pr " else return (fromIntegral r)\n"
10136 pr " else return (fromIntegral r)\n"
10138 pr " else return (toBool r)\n"
10140 | RConstOptString _
10147 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10153 and generate_haskell_prototype ~handle ?(hs = false) style =
10154 pr "%s -> " handle;
10155 let string = if hs then "String" else "CString" in
10156 let int = if hs then "Int" else "CInt" in
10157 let bool = if hs then "Bool" else "CInt" in
10158 let int64 = if hs then "Integer" else "Int64" in
10162 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10163 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10164 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10165 | Bool _ -> pr "%s" bool
10166 | Int _ -> pr "%s" int
10167 | Int64 _ -> pr "%s" int
10168 | FileIn _ -> pr "%s" string
10169 | FileOut _ -> pr "%s" string
10174 (match fst style with
10175 | RErr -> if not hs then pr "CInt"
10176 | RInt _ -> pr "%s" int
10177 | RInt64 _ -> pr "%s" int64
10178 | RBool _ -> pr "%s" bool
10179 | RConstString _ -> pr "%s" string
10180 | RConstOptString _ -> pr "Maybe %s" string
10181 | RString _ -> pr "%s" string
10182 | RStringList _ -> pr "[%s]" string
10183 | RStruct (_, typ) ->
10184 let name = java_name_of_struct typ in
10186 | RStructList (_, typ) ->
10187 let name = java_name_of_struct typ in
10189 | RHashtable _ -> pr "Hashtable"
10190 | RBufferOut _ -> pr "%s" string
10194 and generate_csharp () =
10195 generate_header CPlusPlusStyle LGPLv2plus;
10197 (* XXX Make this configurable by the C# assembly users. *)
10198 let library = "libguestfs.so.0" in
10201 // These C# bindings are highly experimental at present.
10203 // Firstly they only work on Linux (ie. Mono). In order to get them
10204 // to work on Windows (ie. .Net) you would need to port the library
10205 // itself to Windows first.
10207 // The second issue is that some calls are known to be incorrect and
10208 // can cause Mono to segfault. Particularly: calls which pass or
10209 // return string[], or return any structure value. This is because
10210 // we haven't worked out the correct way to do this from C#.
10212 // The third issue is that when compiling you get a lot of warnings.
10213 // We are not sure whether the warnings are important or not.
10215 // Fourthly we do not routinely build or test these bindings as part
10216 // of the make && make check cycle, which means that regressions might
10219 // Suggestions and patches are welcome.
10223 // gmcs Libguestfs.cs
10224 // mono Libguestfs.exe
10226 // (You'll probably want to add a Test class / static main function
10227 // otherwise this won't do anything useful).
10231 using System.Runtime.InteropServices;
10232 using System.Runtime.Serialization;
10233 using System.Collections;
10237 class Error : System.ApplicationException
10239 public Error (string message) : base (message) {}
10240 protected Error (SerializationInfo info, StreamingContext context) {}
10247 [DllImport (\"%s\")]
10248 static extern IntPtr guestfs_create ();
10252 _handle = guestfs_create ();
10253 if (_handle == IntPtr.Zero)
10254 throw new Error (\"could not create guestfs handle\");
10257 [DllImport (\"%s\")]
10258 static extern void guestfs_close (IntPtr h);
10262 guestfs_close (_handle);
10265 [DllImport (\"%s\")]
10266 static extern string guestfs_last_error (IntPtr h);
10268 " library library library;
10270 (* Generate C# structure bindings. We prefix struct names with
10271 * underscore because C# cannot have conflicting struct names and
10272 * method names (eg. "class stat" and "stat").
10276 pr " [StructLayout (LayoutKind.Sequential)]\n";
10277 pr " public class _%s {\n" typ;
10280 | name, FChar -> pr " char %s;\n" name
10281 | name, FString -> pr " string %s;\n" name
10283 pr " uint %s_len;\n" name;
10284 pr " string %s;\n" name
10286 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10287 pr " string %s;\n" name
10288 | name, FUInt32 -> pr " uint %s;\n" name
10289 | name, FInt32 -> pr " int %s;\n" name
10290 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10291 | name, FInt64 -> pr " long %s;\n" name
10292 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10298 (* Generate C# function bindings. *)
10300 fun (name, style, _, _, _, shortdesc, _) ->
10301 let rec csharp_return_type () =
10302 match fst style with
10304 | RBool n -> "bool"
10306 | RInt64 n -> "long"
10308 | RConstOptString n
10310 | RBufferOut n -> "string"
10311 | RStruct (_,n) -> "_" ^ n
10312 | RHashtable n -> "Hashtable"
10313 | RStringList n -> "string[]"
10314 | RStructList (_,n) -> sprintf "_%s[]" n
10316 and c_return_type () =
10317 match fst style with
10321 | RInt64 _ -> "long"
10323 | RConstOptString _
10325 | RBufferOut _ -> "string"
10326 | RStruct (_,n) -> "_" ^ n
10328 | RStringList _ -> "string[]"
10329 | RStructList (_,n) -> sprintf "_%s[]" n
10331 and c_error_comparison () =
10332 match fst style with
10336 | RInt64 _ -> "== -1"
10338 | RConstOptString _
10344 | RStructList (_,_) -> "== null"
10346 and generate_extern_prototype () =
10347 pr " static extern %s guestfs_%s (IntPtr h"
10348 (c_return_type ()) name;
10351 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10352 | FileIn n | FileOut n ->
10353 pr ", [In] string %s" n
10354 | StringList n | DeviceList n ->
10355 pr ", [In] string[] %s" n
10365 and generate_public_prototype () =
10366 pr " public %s %s (" (csharp_return_type ()) name;
10367 let comma = ref false in
10369 if !comma then pr ", ";
10374 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10375 | FileIn n | FileOut n ->
10376 next (); pr "string %s" n
10377 | StringList n | DeviceList n ->
10378 next (); pr "string[] %s" n
10380 next (); pr "bool %s" n
10382 next (); pr "int %s" n
10384 next (); pr "long %s" n
10388 and generate_call () =
10389 pr "guestfs_%s (_handle" name;
10390 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10394 pr " [DllImport (\"%s\")]\n" library;
10395 generate_extern_prototype ();
10397 pr " /// <summary>\n";
10398 pr " /// %s\n" shortdesc;
10399 pr " /// </summary>\n";
10400 generate_public_prototype ();
10402 pr " %s r;\n" (c_return_type ());
10405 pr " if (r %s)\n" (c_error_comparison ());
10406 pr " throw new Error (guestfs_last_error (_handle));\n";
10407 (match fst style with
10410 pr " return r != 0 ? true : false;\n"
10412 pr " Hashtable rr = new Hashtable ();\n";
10413 pr " for (int i = 0; i < r.Length; i += 2)\n";
10414 pr " rr.Add (r[i], r[i+1]);\n";
10416 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10417 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10423 ) all_functions_sorted;
10429 and generate_bindtests () =
10430 generate_header CStyle LGPLv2plus;
10434 #include <stdlib.h>
10435 #include <inttypes.h>
10436 #include <string.h>
10438 #include \"guestfs.h\"
10439 #include \"guestfs-internal.h\"
10440 #include \"guestfs-internal-actions.h\"
10441 #include \"guestfs_protocol.h\"
10443 #define error guestfs_error
10444 #define safe_calloc guestfs_safe_calloc
10445 #define safe_malloc guestfs_safe_malloc
10448 print_strings (char *const *argv)
10453 for (argc = 0; argv[argc] != NULL; ++argc) {
10454 if (argc > 0) printf (\", \");
10455 printf (\"\\\"%%s\\\"\", argv[argc]);
10460 /* The test0 function prints its parameters to stdout. */
10464 match test_functions with
10465 | [] -> assert false
10466 | test0 :: tests -> test0, tests in
10469 let (name, style, _, _, _, _, _) = test0 in
10470 generate_prototype ~extern:false ~semicolon:false ~newline:true
10471 ~handle:"g" ~prefix:"guestfs__" name style;
10476 | Device n | Dev_or_Path n
10479 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10480 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10481 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10482 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10483 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10484 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10486 pr " /* Java changes stdout line buffering so we need this: */\n";
10487 pr " fflush (stdout);\n";
10493 fun (name, style, _, _, _, _, _) ->
10494 if String.sub name (String.length name - 3) 3 <> "err" then (
10495 pr "/* Test normal return. */\n";
10496 generate_prototype ~extern:false ~semicolon:false ~newline:true
10497 ~handle:"g" ~prefix:"guestfs__" name style;
10499 (match fst style with
10504 pr " sscanf (val, \"%%d\", &r);\n";
10507 pr " int64_t r;\n";
10508 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10511 pr " return STREQ (val, \"true\");\n"
10513 | RConstOptString _ ->
10514 (* Can't return the input string here. Return a static
10515 * string so we ensure we get a segfault if the caller
10516 * tries to free it.
10518 pr " return \"static string\";\n"
10520 pr " return strdup (val);\n"
10522 pr " char **strs;\n";
10524 pr " sscanf (val, \"%%d\", &n);\n";
10525 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10526 pr " for (i = 0; i < n; ++i) {\n";
10527 pr " strs[i] = safe_malloc (g, 16);\n";
10528 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10530 pr " strs[n] = NULL;\n";
10531 pr " return strs;\n"
10532 | RStruct (_, typ) ->
10533 pr " struct guestfs_%s *r;\n" typ;
10534 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10536 | RStructList (_, typ) ->
10537 pr " struct guestfs_%s_list *r;\n" typ;
10538 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10539 pr " sscanf (val, \"%%d\", &r->len);\n";
10540 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10543 pr " char **strs;\n";
10545 pr " sscanf (val, \"%%d\", &n);\n";
10546 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10547 pr " for (i = 0; i < n; ++i) {\n";
10548 pr " strs[i*2] = safe_malloc (g, 16);\n";
10549 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10550 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10551 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10553 pr " strs[n*2] = NULL;\n";
10554 pr " return strs;\n"
10556 pr " return strdup (val);\n"
10561 pr "/* Test error return. */\n";
10562 generate_prototype ~extern:false ~semicolon:false ~newline:true
10563 ~handle:"g" ~prefix:"guestfs__" name style;
10565 pr " error (g, \"error\");\n";
10566 (match fst style with
10567 | RErr | RInt _ | RInt64 _ | RBool _ ->
10569 | RConstString _ | RConstOptString _
10570 | RString _ | RStringList _ | RStruct _
10574 pr " return NULL;\n"
10581 and generate_ocaml_bindtests () =
10582 generate_header OCamlStyle GPLv2plus;
10586 let g = Guestfs.create () in
10590 String.concat " " (
10593 | CallString s -> "\"" ^ s ^ "\""
10594 | CallOptString None -> "None"
10595 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10596 | CallStringList xs ->
10597 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10598 | CallInt i when i >= 0 -> string_of_int i
10599 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10600 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10601 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10602 | CallBool b -> string_of_bool b
10607 generate_lang_bindtests (
10608 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10611 pr "print_endline \"EOF\"\n"
10613 and generate_perl_bindtests () =
10614 pr "#!/usr/bin/perl -w\n";
10615 generate_header HashStyle GPLv2plus;
10622 my $g = Sys::Guestfs->new ();
10626 String.concat ", " (
10629 | CallString s -> "\"" ^ s ^ "\""
10630 | CallOptString None -> "undef"
10631 | CallOptString (Some s) -> sprintf "\"%s\"" s
10632 | CallStringList xs ->
10633 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10634 | CallInt i -> string_of_int i
10635 | CallInt64 i -> Int64.to_string i
10636 | CallBool b -> if b then "1" else "0"
10641 generate_lang_bindtests (
10642 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10645 pr "print \"EOF\\n\"\n"
10647 and generate_python_bindtests () =
10648 generate_header HashStyle GPLv2plus;
10653 g = guestfs.GuestFS ()
10657 String.concat ", " (
10660 | CallString s -> "\"" ^ s ^ "\""
10661 | CallOptString None -> "None"
10662 | CallOptString (Some s) -> sprintf "\"%s\"" s
10663 | CallStringList xs ->
10664 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10665 | CallInt i -> string_of_int i
10666 | CallInt64 i -> Int64.to_string i
10667 | CallBool b -> if b then "1" else "0"
10672 generate_lang_bindtests (
10673 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10676 pr "print \"EOF\"\n"
10678 and generate_ruby_bindtests () =
10679 generate_header HashStyle GPLv2plus;
10684 g = Guestfs::create()
10688 String.concat ", " (
10691 | CallString s -> "\"" ^ s ^ "\""
10692 | CallOptString None -> "nil"
10693 | CallOptString (Some s) -> sprintf "\"%s\"" s
10694 | CallStringList xs ->
10695 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10696 | CallInt i -> string_of_int i
10697 | CallInt64 i -> Int64.to_string i
10698 | CallBool b -> string_of_bool b
10703 generate_lang_bindtests (
10704 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10707 pr "print \"EOF\\n\"\n"
10709 and generate_java_bindtests () =
10710 generate_header CStyle GPLv2plus;
10713 import com.redhat.et.libguestfs.*;
10715 public class Bindtests {
10716 public static void main (String[] argv)
10719 GuestFS g = new GuestFS ();
10723 String.concat ", " (
10726 | CallString s -> "\"" ^ s ^ "\""
10727 | CallOptString None -> "null"
10728 | CallOptString (Some s) -> sprintf "\"%s\"" s
10729 | CallStringList xs ->
10731 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10732 | CallInt i -> string_of_int i
10733 | CallInt64 i -> Int64.to_string i
10734 | CallBool b -> string_of_bool b
10739 generate_lang_bindtests (
10740 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10744 System.out.println (\"EOF\");
10746 catch (Exception exn) {
10747 System.err.println (exn);
10754 and generate_haskell_bindtests () =
10755 generate_header HaskellStyle GPLv2plus;
10758 module Bindtests where
10759 import qualified Guestfs
10762 g <- Guestfs.create
10766 String.concat " " (
10769 | CallString s -> "\"" ^ s ^ "\""
10770 | CallOptString None -> "Nothing"
10771 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10772 | CallStringList xs ->
10773 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10774 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10775 | CallInt i -> string_of_int i
10776 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10777 | CallInt64 i -> Int64.to_string i
10778 | CallBool true -> "True"
10779 | CallBool false -> "False"
10784 generate_lang_bindtests (
10785 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10788 pr " putStrLn \"EOF\"\n"
10790 (* Language-independent bindings tests - we do it this way to
10791 * ensure there is parity in testing bindings across all languages.
10793 and generate_lang_bindtests call =
10794 call "test0" [CallString "abc"; CallOptString (Some "def");
10795 CallStringList []; CallBool false;
10796 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10797 call "test0" [CallString "abc"; CallOptString None;
10798 CallStringList []; CallBool false;
10799 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10800 call "test0" [CallString ""; CallOptString (Some "def");
10801 CallStringList []; CallBool false;
10802 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10803 call "test0" [CallString ""; CallOptString (Some "");
10804 CallStringList []; CallBool false;
10805 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10806 call "test0" [CallString "abc"; CallOptString (Some "def");
10807 CallStringList ["1"]; CallBool false;
10808 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10809 call "test0" [CallString "abc"; CallOptString (Some "def");
10810 CallStringList ["1"; "2"]; CallBool false;
10811 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10812 call "test0" [CallString "abc"; CallOptString (Some "def");
10813 CallStringList ["1"]; CallBool true;
10814 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10815 call "test0" [CallString "abc"; CallOptString (Some "def");
10816 CallStringList ["1"]; CallBool false;
10817 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
10818 call "test0" [CallString "abc"; CallOptString (Some "def");
10819 CallStringList ["1"]; CallBool false;
10820 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
10821 call "test0" [CallString "abc"; CallOptString (Some "def");
10822 CallStringList ["1"]; CallBool false;
10823 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
10824 call "test0" [CallString "abc"; CallOptString (Some "def");
10825 CallStringList ["1"]; CallBool false;
10826 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
10827 call "test0" [CallString "abc"; CallOptString (Some "def");
10828 CallStringList ["1"]; CallBool false;
10829 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
10830 call "test0" [CallString "abc"; CallOptString (Some "def");
10831 CallStringList ["1"]; CallBool false;
10832 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
10834 (* XXX Add here tests of the return and error functions. *)
10836 (* Code to generator bindings for virt-inspector. Currently only
10837 * implemented for OCaml code (for virt-p2v 2.0).
10839 let rng_input = "inspector/virt-inspector.rng"
10841 (* Read the input file and parse it into internal structures. This is
10842 * by no means a complete RELAX NG parser, but is just enough to be
10843 * able to parse the specific input file.
10846 | Element of string * rng list (* <element name=name/> *)
10847 | Attribute of string * rng list (* <attribute name=name/> *)
10848 | Interleave of rng list (* <interleave/> *)
10849 | ZeroOrMore of rng (* <zeroOrMore/> *)
10850 | OneOrMore of rng (* <oneOrMore/> *)
10851 | Optional of rng (* <optional/> *)
10852 | Choice of string list (* <choice><value/>*</choice> *)
10853 | Value of string (* <value>str</value> *)
10854 | Text (* <text/> *)
10856 let rec string_of_rng = function
10857 | Element (name, xs) ->
10858 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10859 | Attribute (name, xs) ->
10860 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10861 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
10862 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
10863 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
10864 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
10865 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
10866 | Value value -> "Value \"" ^ value ^ "\""
10869 and string_of_rng_list xs =
10870 String.concat ", " (List.map string_of_rng xs)
10872 let rec parse_rng ?defines context = function
10874 | Xml.Element ("element", ["name", name], children) :: rest ->
10875 Element (name, parse_rng ?defines context children)
10876 :: parse_rng ?defines context rest
10877 | Xml.Element ("attribute", ["name", name], children) :: rest ->
10878 Attribute (name, parse_rng ?defines context children)
10879 :: parse_rng ?defines context rest
10880 | Xml.Element ("interleave", [], children) :: rest ->
10881 Interleave (parse_rng ?defines context children)
10882 :: parse_rng ?defines context rest
10883 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
10884 let rng = parse_rng ?defines context [child] in
10886 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
10888 failwithf "%s: <zeroOrMore> contains more than one child element"
10891 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
10892 let rng = parse_rng ?defines context [child] in
10894 | [child] -> OneOrMore child :: parse_rng ?defines context rest
10896 failwithf "%s: <oneOrMore> contains more than one child element"
10899 | Xml.Element ("optional", [], [child]) :: rest ->
10900 let rng = parse_rng ?defines context [child] in
10902 | [child] -> Optional child :: parse_rng ?defines context rest
10904 failwithf "%s: <optional> contains more than one child element"
10907 | Xml.Element ("choice", [], children) :: rest ->
10908 let values = List.map (
10909 function Xml.Element ("value", [], [Xml.PCData value]) -> value
10911 failwithf "%s: can't handle anything except <value> in <choice>"
10915 :: parse_rng ?defines context rest
10916 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
10917 Value value :: parse_rng ?defines context rest
10918 | Xml.Element ("text", [], []) :: rest ->
10919 Text :: parse_rng ?defines context rest
10920 | Xml.Element ("ref", ["name", name], []) :: rest ->
10921 (* Look up the reference. Because of limitations in this parser,
10922 * we can't handle arbitrarily nested <ref> yet. You can only
10923 * use <ref> from inside <start>.
10925 (match defines with
10927 failwithf "%s: contains <ref>, but no refs are defined yet" context
10929 let rng = StringMap.find name map in
10930 rng @ parse_rng ?defines context rest
10933 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
10936 let xml = Xml.parse_file rng_input in
10938 | Xml.Element ("grammar", _,
10939 Xml.Element ("start", _, gram) :: defines) ->
10940 (* The <define/> elements are referenced in the <start> section,
10941 * so build a map of those first.
10943 let defines = List.fold_left (
10945 function Xml.Element ("define", ["name", name], defn) ->
10946 StringMap.add name defn map
10948 failwithf "%s: expected <define name=name/>" rng_input
10949 ) StringMap.empty defines in
10950 let defines = StringMap.mapi parse_rng defines in
10952 (* Parse the <start> clause, passing the defines. *)
10953 parse_rng ~defines "<start>" gram
10955 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
10958 let name_of_field = function
10959 | Element (name, _) | Attribute (name, _)
10960 | ZeroOrMore (Element (name, _))
10961 | OneOrMore (Element (name, _))
10962 | Optional (Element (name, _)) -> name
10963 | Optional (Attribute (name, _)) -> name
10964 | Text -> (* an unnamed field in an element *)
10967 failwithf "name_of_field failed at: %s" (string_of_rng rng)
10969 (* At the moment this function only generates OCaml types. However we
10970 * should parameterize it later so it can generate types/structs in a
10971 * variety of languages.
10973 let generate_types xs =
10974 (* A simple type is one that can be printed out directly, eg.
10975 * "string option". A complex type is one which has a name and has
10976 * to be defined via another toplevel definition, eg. a struct.
10978 * generate_type generates code for either simple or complex types.
10979 * In the simple case, it returns the string ("string option"). In
10980 * the complex case, it returns the name ("mountpoint"). In the
10981 * complex case it has to print out the definition before returning,
10982 * so it should only be called when we are at the beginning of a
10983 * new line (BOL context).
10985 let rec generate_type = function
10986 | Text -> (* string *)
10988 | Choice values -> (* [`val1|`val2|...] *)
10989 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
10990 | ZeroOrMore rng -> (* <rng> list *)
10991 let t, is_simple = generate_type rng in
10992 t ^ " list (* 0 or more *)", is_simple
10993 | OneOrMore rng -> (* <rng> list *)
10994 let t, is_simple = generate_type rng in
10995 t ^ " list (* 1 or more *)", is_simple
10996 (* virt-inspector hack: bool *)
10997 | Optional (Attribute (name, [Value "1"])) ->
10999 | Optional rng -> (* <rng> list *)
11000 let t, is_simple = generate_type rng in
11001 t ^ " option", is_simple
11002 (* type name = { fields ... } *)
11003 | Element (name, fields) when is_attrs_interleave fields ->
11004 generate_type_struct name (get_attrs_interleave fields)
11005 | Element (name, [field]) (* type name = field *)
11006 | Attribute (name, [field]) ->
11007 let t, is_simple = generate_type field in
11008 if is_simple then (t, true)
11010 pr "type %s = %s\n" name t;
11013 | Element (name, fields) -> (* type name = { fields ... } *)
11014 generate_type_struct name fields
11016 failwithf "generate_type failed at: %s" (string_of_rng rng)
11018 and is_attrs_interleave = function
11019 | [Interleave _] -> true
11020 | Attribute _ :: fields -> is_attrs_interleave fields
11021 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11024 and get_attrs_interleave = function
11025 | [Interleave fields] -> fields
11026 | ((Attribute _) as field) :: fields
11027 | ((Optional (Attribute _)) as field) :: fields ->
11028 field :: get_attrs_interleave fields
11029 | _ -> assert false
11031 and generate_types xs =
11032 List.iter (fun x -> ignore (generate_type x)) xs
11034 and generate_type_struct name fields =
11035 (* Calculate the types of the fields first. We have to do this
11036 * before printing anything so we are still in BOL context.
11038 let types = List.map fst (List.map generate_type fields) in
11040 (* Special case of a struct containing just a string and another
11041 * field. Turn it into an assoc list.
11044 | ["string"; other] ->
11045 let fname1, fname2 =
11047 | [f1; f2] -> name_of_field f1, name_of_field f2
11048 | _ -> assert false in
11049 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11053 pr "type %s = {\n" name;
11055 fun (field, ftype) ->
11056 let fname = name_of_field field in
11057 pr " %s_%s : %s;\n" name fname ftype
11058 ) (List.combine fields types);
11060 (* Return the name of this type, and
11061 * false because it's not a simple type.
11068 let generate_parsers xs =
11069 (* As for generate_type above, generate_parser makes a parser for
11070 * some type, and returns the name of the parser it has generated.
11071 * Because it (may) need to print something, it should always be
11072 * called in BOL context.
11074 let rec generate_parser = function
11075 | Text -> (* string *)
11076 "string_child_or_empty"
11077 | Choice values -> (* [`val1|`val2|...] *)
11078 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11080 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11081 | ZeroOrMore rng -> (* <rng> list *)
11082 let pa = generate_parser rng in
11083 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11084 | OneOrMore rng -> (* <rng> list *)
11085 let pa = generate_parser rng in
11086 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11087 (* virt-inspector hack: bool *)
11088 | Optional (Attribute (name, [Value "1"])) ->
11089 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11090 | Optional rng -> (* <rng> list *)
11091 let pa = generate_parser rng in
11092 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11093 (* type name = { fields ... } *)
11094 | Element (name, fields) when is_attrs_interleave fields ->
11095 generate_parser_struct name (get_attrs_interleave fields)
11096 | Element (name, [field]) -> (* type name = field *)
11097 let pa = generate_parser field in
11098 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11099 pr "let %s =\n" parser_name;
11101 pr "let parse_%s = %s\n" name parser_name;
11103 | Attribute (name, [field]) ->
11104 let pa = generate_parser field in
11105 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11106 pr "let %s =\n" parser_name;
11108 pr "let parse_%s = %s\n" name parser_name;
11110 | Element (name, fields) -> (* type name = { fields ... } *)
11111 generate_parser_struct name ([], fields)
11113 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11115 and is_attrs_interleave = function
11116 | [Interleave _] -> true
11117 | Attribute _ :: fields -> is_attrs_interleave fields
11118 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11121 and get_attrs_interleave = function
11122 | [Interleave fields] -> [], fields
11123 | ((Attribute _) as field) :: fields
11124 | ((Optional (Attribute _)) as field) :: fields ->
11125 let attrs, interleaves = get_attrs_interleave fields in
11126 (field :: attrs), interleaves
11127 | _ -> assert false
11129 and generate_parsers xs =
11130 List.iter (fun x -> ignore (generate_parser x)) xs
11132 and generate_parser_struct name (attrs, interleaves) =
11133 (* Generate parsers for the fields first. We have to do this
11134 * before printing anything so we are still in BOL context.
11136 let fields = attrs @ interleaves in
11137 let pas = List.map generate_parser fields in
11139 (* Generate an intermediate tuple from all the fields first.
11140 * If the type is just a string + another field, then we will
11141 * return this directly, otherwise it is turned into a record.
11143 * RELAX NG note: This code treats <interleave> and plain lists of
11144 * fields the same. In other words, it doesn't bother enforcing
11145 * any ordering of fields in the XML.
11147 pr "let parse_%s x =\n" name;
11148 pr " let t = (\n ";
11149 let comma = ref false in
11152 if !comma then pr ",\n ";
11155 | Optional (Attribute (fname, [field])), pa ->
11157 | Optional (Element (fname, [field])), pa ->
11158 pr "%s (optional_child %S x)" pa fname
11159 | Attribute (fname, [Text]), _ ->
11160 pr "attribute %S x" fname
11161 | (ZeroOrMore _ | OneOrMore _), pa ->
11166 let fname = name_of_field field in
11167 pr "%s (child %S x)" pa fname
11168 ) (List.combine fields pas);
11172 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11176 pr " (Obj.magic t : %s)\n" name
11180 | (Optional (Attribute (fname, [field])), pa) ->
11181 pr " %s_%s =\n" name fname;
11183 | (Optional (Element (fname, [field])), pa) ->
11184 pr " %s_%s =\n" name fname;
11185 pr " (let x = optional_child %S x in\n" fname;
11188 let fname = name_of_field field in
11189 pr " %s_%s =\n" name fname;
11190 pr " (let x = child %S x in\n" fname;
11192 ) (List.combine fields pas);
11196 sprintf "parse_%s" name
11199 generate_parsers xs
11201 (* Generate ocaml/guestfs_inspector.mli. *)
11202 let generate_ocaml_inspector_mli () =
11203 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11206 (** This is an OCaml language binding to the external [virt-inspector]
11209 For more information, please read the man page [virt-inspector(1)].
11214 generate_types grammar;
11215 pr "(** The nested information returned from the {!inspect} function. *)\n";
11219 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11220 (** To inspect a libvirt domain called [name], pass a singleton
11221 list: [inspect [name]]. When using libvirt only, you may
11222 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11224 To inspect a disk image or images, pass a list of the filenames
11225 of the disk images: [inspect filenames]
11227 This function inspects the given guest or disk images and
11228 returns a list of operating system(s) found and a large amount
11229 of information about them. In the vast majority of cases,
11230 a virtual machine only contains a single operating system.
11232 If the optional [~xml] parameter is given, then this function
11233 skips running the external virt-inspector program and just
11234 parses the given XML directly (which is expected to be XML
11235 produced from a previous run of virt-inspector). The list of
11236 names and connect URI are ignored in this case.
11238 This function can throw a wide variety of exceptions, for example
11239 if the external virt-inspector program cannot be found, or if
11240 it doesn't generate valid XML.
11244 (* Generate ocaml/guestfs_inspector.ml. *)
11245 let generate_ocaml_inspector_ml () =
11246 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11251 generate_types grammar;
11255 (* Misc functions which are used by the parser code below. *)
11256 let first_child = function
11257 | Xml.Element (_, _, c::_) -> c
11258 | Xml.Element (name, _, []) ->
11259 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11260 | Xml.PCData str ->
11261 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11263 let string_child_or_empty = function
11264 | Xml.Element (_, _, [Xml.PCData s]) -> s
11265 | Xml.Element (_, _, []) -> \"\"
11266 | Xml.Element (x, _, _) ->
11267 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11269 | Xml.PCData str ->
11270 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11272 let optional_child name xml =
11273 let children = Xml.children xml in
11275 Some (List.find (function
11276 | Xml.Element (n, _, _) when n = name -> true
11277 | _ -> false) children)
11281 let child name xml =
11282 match optional_child name xml with
11285 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11287 let attribute name xml =
11288 try Xml.attrib xml name
11289 with Xml.No_attribute _ ->
11290 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11294 generate_parsers grammar;
11298 (* Run external virt-inspector, then use parser to parse the XML. *)
11299 let inspect ?connect ?xml names =
11303 if names = [] then invalid_arg \"inspect: no names given\";
11304 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11305 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11307 let cmd = List.map Filename.quote cmd in
11308 let cmd = String.concat \" \" cmd in
11309 let chan = open_process_in cmd in
11310 let xml = Xml.parse_in chan in
11311 (match close_process_in chan with
11313 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11314 | WSIGNALED i | WSTOPPED i ->
11315 failwith (\"external virt-inspector command died or stopped on sig \" ^
11320 Xml.parse_string doc in
11321 parse_operatingsystems xml
11324 (* This is used to generate the src/MAX_PROC_NR file which
11325 * contains the maximum procedure number, a surrogate for the
11326 * ABI version number. See src/Makefile.am for the details.
11328 and generate_max_proc_nr () =
11329 let proc_nrs = List.map (
11330 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11331 ) daemon_functions in
11333 let max_proc_nr = List.fold_left max 0 proc_nrs in
11335 pr "%d\n" max_proc_nr
11337 let output_to filename k =
11338 let filename_new = filename ^ ".new" in
11339 chan := open_out filename_new;
11342 chan := Pervasives.stdout;
11344 (* Is the new file different from the current file? *)
11345 if Sys.file_exists filename && files_equal filename filename_new then
11346 unlink filename_new (* same, so skip it *)
11348 (* different, overwrite old one *)
11349 (try chmod filename 0o644 with Unix_error _ -> ());
11350 rename filename_new filename;
11351 chmod filename 0o444;
11352 printf "written %s\n%!" filename;
11355 let perror msg = function
11356 | Unix_error (err, _, _) ->
11357 eprintf "%s: %s\n" msg (error_message err)
11359 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11361 (* Main program. *)
11364 try openfile "HACKING" [O_RDWR] 0
11366 | Unix_error (ENOENT, _, _) ->
11368 You are probably running this from the wrong directory.
11369 Run it from the top source directory using the command
11374 perror "open: HACKING" exn;
11377 (* Acquire a lock so parallel builds won't try to run the generator
11378 * twice at the same time. Subsequent builds will wait for the first
11379 * one to finish. Note the lock is released implicitly when the
11382 (try lockf lock_fd F_LOCK 1
11384 perror "lock: HACKING" exn;
11387 check_functions ();
11389 output_to "src/guestfs_protocol.x" generate_xdr;
11390 output_to "src/guestfs-structs.h" generate_structs_h;
11391 output_to "src/guestfs-actions.h" generate_actions_h;
11392 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11393 output_to "src/guestfs-actions.c" generate_client_actions;
11394 output_to "src/guestfs-bindtests.c" generate_bindtests;
11395 output_to "src/guestfs-structs.pod" generate_structs_pod;
11396 output_to "src/guestfs-actions.pod" generate_actions_pod;
11397 output_to "src/guestfs-availability.pod" generate_availability_pod;
11398 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11399 output_to "src/libguestfs.syms" generate_linker_script;
11400 output_to "daemon/actions.h" generate_daemon_actions_h;
11401 output_to "daemon/stubs.c" generate_daemon_actions;
11402 output_to "daemon/names.c" generate_daemon_names;
11403 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11404 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11405 output_to "capitests/tests.c" generate_tests;
11406 output_to "fish/cmds.c" generate_fish_cmds;
11407 output_to "fish/completion.c" generate_fish_completion;
11408 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11409 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11410 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11411 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11412 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11413 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11414 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11415 output_to "perl/Guestfs.xs" generate_perl_xs;
11416 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11417 output_to "perl/bindtests.pl" generate_perl_bindtests;
11418 output_to "python/guestfs-py.c" generate_python_c;
11419 output_to "python/guestfs.py" generate_python_py;
11420 output_to "python/bindtests.py" generate_python_bindtests;
11421 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11422 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11423 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11427 let cols = cols_of_struct typ in
11428 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11429 output_to filename (generate_java_struct jtyp cols);
11432 output_to "java/Makefile.inc" generate_java_makefile_inc;
11433 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11434 output_to "java/Bindtests.java" generate_java_bindtests;
11435 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11436 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11437 output_to "csharp/Libguestfs.cs" generate_csharp;
11439 (* Always generate this file last, and unconditionally. It's used
11440 * by the Makefile to know when we must re-run the generator.
11442 let chan = open_out "src/stamp-generator" in
11443 fprintf chan "1\n";
11446 printf "generated %d lines of code\n" !lines