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.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
179 | ProtocolLimitWarning (* display warning about protocol size limits *)
180 | DangerWillRobinson (* flags particularly dangerous commands *)
181 | FishAlias of string (* provide an alias for this cmd in guestfish *)
182 | FishOutput of fish_output_t (* how to display output in guestfish *)
183 | NotInFish (* do not export via guestfish *)
184 | NotInDocs (* do not add this function to documentation *)
185 | DeprecatedBy of string (* function is deprecated, use .. instead *)
186 | Optional of string (* function is part of an optional group *)
189 | FishOutputOctal (* for int return, print in octal *)
190 | FishOutputHexadecimal (* for int return, print in hex *)
192 (* You can supply zero or as many tests as you want per API call.
194 * Note that the test environment has 3 block devices, of size 500MB,
195 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
196 * a fourth ISO block device with some known files on it (/dev/sdd).
198 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
199 * Number of cylinders was 63 for IDE emulated disks with precisely
200 * the same size. How exactly this is calculated is a mystery.
202 * The ISO block device (/dev/sdd) comes from images/test.iso.
204 * To be able to run the tests in a reasonable amount of time,
205 * the virtual machine and block devices are reused between tests.
206 * So don't try testing kill_subprocess :-x
208 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
210 * Don't assume anything about the previous contents of the block
211 * devices. Use 'Init*' to create some initial scenarios.
213 * You can add a prerequisite clause to any individual test. This
214 * is a run-time check, which, if it fails, causes the test to be
215 * skipped. Useful if testing a command which might not work on
216 * all variations of libguestfs builds. A test that has prerequisite
217 * of 'Always' is run unconditionally.
219 * In addition, packagers can skip individual tests by setting the
220 * environment variables: eg:
221 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
222 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
224 type tests = (test_init * test_prereq * test) list
226 (* Run the command sequence and just expect nothing to fail. *)
229 (* Run the command sequence and expect the output of the final
230 * command to be the string.
232 | TestOutput of seq * string
234 (* Run the command sequence and expect the output of the final
235 * command to be the list of strings.
237 | TestOutputList of seq * string list
239 (* Run the command sequence and expect the output of the final
240 * command to be the list of block devices (could be either
241 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
242 * character of each string).
244 | TestOutputListOfDevices of seq * string list
246 (* Run the command sequence and expect the output of the final
247 * command to be the integer.
249 | TestOutputInt of seq * int
251 (* Run the command sequence and expect the output of the final
252 * command to be <op> <int>, eg. ">=", "1".
254 | TestOutputIntOp of seq * string * int
256 (* Run the command sequence and expect the output of the final
257 * command to be a true value (!= 0 or != NULL).
259 | TestOutputTrue of seq
261 (* Run the command sequence and expect the output of the final
262 * command to be a false value (== 0 or == NULL, but not an error).
264 | TestOutputFalse of seq
266 (* Run the command sequence and expect the output of the final
267 * command to be a list of the given length (but don't care about
270 | TestOutputLength of seq * int
272 (* Run the command sequence and expect the output of the final
273 * command to be a buffer (RBufferOut), ie. string + size.
275 | TestOutputBuffer of seq * string
277 (* Run the command sequence and expect the output of the final
278 * command to be a structure.
280 | TestOutputStruct of seq * test_field_compare list
282 (* Run the command sequence and expect the final command (only)
285 | TestLastFail of seq
287 and test_field_compare =
288 | CompareWithInt of string * int
289 | CompareWithIntOp of string * string * int
290 | CompareWithString of string * string
291 | CompareFieldsIntEq of string * string
292 | CompareFieldsStrEq of string * string
294 (* Test prerequisites. *)
296 (* Test always runs. *)
299 (* Test is currently disabled - eg. it fails, or it tests some
300 * unimplemented feature.
304 (* 'string' is some C code (a function body) that should return
305 * true or false. The test will run if the code returns true.
309 (* As for 'If' but the test runs _unless_ the code returns true. *)
312 (* Some initial scenarios for testing. *)
314 (* Do nothing, block devices could contain random stuff including
315 * LVM PVs, and some filesystems might be mounted. This is usually
320 (* Block devices are empty and no filesystems are mounted. *)
323 (* /dev/sda contains a single partition /dev/sda1, with random
324 * content. /dev/sdb and /dev/sdc may have random content.
329 (* /dev/sda contains a single partition /dev/sda1, which is formatted
330 * as ext2, empty [except for lost+found] and mounted on /.
331 * /dev/sdb and /dev/sdc may have random content.
337 * /dev/sda1 (is a PV):
338 * /dev/VG/LV (size 8MB):
339 * formatted as ext2, empty [except for lost+found], mounted on /
340 * /dev/sdb and /dev/sdc may have random content.
344 (* /dev/sdd (the ISO, see images/ directory in source)
349 (* Sequence of commands for testing. *)
351 and cmd = string list
353 (* Note about long descriptions: When referring to another
354 * action, use the format C<guestfs_other> (ie. the full name of
355 * the C function). This will be replaced as appropriate in other
358 * Apart from that, long descriptions are just perldoc paragraphs.
361 (* Generate a random UUID (used in tests). *)
363 let chan = open_process_in "uuidgen" in
364 let uuid = input_line chan in
365 (match close_process_in chan with
368 failwith "uuidgen: process exited with non-zero status"
369 | WSIGNALED _ | WSTOPPED _ ->
370 failwith "uuidgen: process signalled or stopped by signal"
374 (* These test functions are used in the language binding tests. *)
376 let test_all_args = [
379 StringList "strlist";
388 let test_all_rets = [
389 (* except for RErr, which is tested thoroughly elsewhere *)
390 "test0rint", RInt "valout";
391 "test0rint64", RInt64 "valout";
392 "test0rbool", RBool "valout";
393 "test0rconststring", RConstString "valout";
394 "test0rconstoptstring", RConstOptString "valout";
395 "test0rstring", RString "valout";
396 "test0rstringlist", RStringList "valout";
397 "test0rstruct", RStruct ("valout", "lvm_pv");
398 "test0rstructlist", RStructList ("valout", "lvm_pv");
399 "test0rhashtable", RHashtable "valout";
402 let test_functions = [
403 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
405 "internal test function - do not use",
407 This is an internal test function which is used to test whether
408 the automatically generated bindings can handle every possible
409 parameter type correctly.
411 It echos the contents of each parameter to stdout.
413 You probably don't want to call this function.");
417 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
419 "internal test function - do not use",
421 This is an internal test function which is used to test whether
422 the automatically generated bindings can handle every possible
423 return type correctly.
425 It converts string C<val> to the return type.
427 You probably don't want to call this function.");
428 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 This function always returns an error.
438 You probably don't want to call this function.")]
442 (* non_daemon_functions are any functions which don't get processed
443 * in the daemon, eg. functions for setting and getting local
444 * configuration values.
447 let non_daemon_functions = test_functions @ [
448 ("launch", (RErr, []), -1, [FishAlias "run"],
450 "launch the qemu subprocess",
452 Internally libguestfs is implemented by running a virtual machine
455 You should call this after configuring the handle
456 (eg. adding drives) but before performing any actions.");
458 ("wait_ready", (RErr, []), -1, [NotInFish],
460 "wait until the qemu subprocess launches (no op)",
462 This function is a no op.
464 In versions of the API E<lt> 1.0.71 you had to call this function
465 just after calling C<guestfs_launch> to wait for the launch
466 to complete. However this is no longer necessary because
467 C<guestfs_launch> now does the waiting.
469 If you see any calls to this function in code then you can just
470 remove them, unless you want to retain compatibility with older
471 versions of the API.");
473 ("kill_subprocess", (RErr, []), -1, [],
475 "kill the qemu subprocess",
477 This kills the qemu subprocess. You should never need to call this.");
479 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
481 "add an image to examine or modify",
483 This function adds a virtual machine disk image C<filename> to the
484 guest. The first time you call this function, the disk appears as IDE
485 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
488 You don't necessarily need to be root when using libguestfs. However
489 you obviously do need sufficient permissions to access the filename
490 for whatever operations you want to perform (ie. read access if you
491 just want to read the image or write access if you want to modify the
494 This is equivalent to the qemu parameter
495 C<-drive file=filename,cache=off,if=...>.
497 C<cache=off> is omitted in cases where it is not supported by
498 the underlying filesystem.
500 C<if=...> is set at compile time by the configuration option
501 C<./configure --with-drive-if=...>. In the rare case where you
502 might need to change this at run time, use C<guestfs_add_drive_with_if>
503 or C<guestfs_add_drive_ro_with_if>.
505 Note that this call checks for the existence of C<filename>. This
506 stops you from specifying other types of drive which are supported
507 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
508 the general C<guestfs_config> call instead.");
510 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
512 "add a CD-ROM disk image to examine",
514 This function adds a virtual CD-ROM disk image to the guest.
516 This is equivalent to the qemu parameter C<-cdrom filename>.
524 This call checks for the existence of C<filename>. This
525 stops you from specifying other types of drive which are supported
526 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
527 the general C<guestfs_config> call instead.
531 If you just want to add an ISO file (often you use this as an
532 efficient way to transfer large files into the guest), then you
533 should probably use C<guestfs_add_drive_ro> instead.
537 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
539 "add a drive in snapshot mode (read-only)",
541 This adds a drive in snapshot mode, making it effectively
544 Note that writes to the device are allowed, and will be seen for
545 the duration of the guestfs handle, but they are written
546 to a temporary file which is discarded as soon as the guestfs
547 handle is closed. We don't currently have any method to enable
548 changes to be committed, although qemu can support this.
550 This is equivalent to the qemu parameter
551 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
553 C<if=...> is set at compile time by the configuration option
554 C<./configure --with-drive-if=...>. In the rare case where you
555 might need to change this at run time, use C<guestfs_add_drive_with_if>
556 or C<guestfs_add_drive_ro_with_if>.
558 C<readonly=on> is only added where qemu supports this option.
560 Note that this call checks for the existence of C<filename>. This
561 stops you from specifying other types of drive which are supported
562 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
563 the general C<guestfs_config> call instead.");
565 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
567 "add qemu parameters",
569 This can be used to add arbitrary qemu command line parameters
570 of the form C<-param value>. Actually it's not quite arbitrary - we
571 prevent you from setting some parameters which would interfere with
572 parameters that we use.
574 The first character of C<param> string must be a C<-> (dash).
576 C<value> can be NULL.");
578 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
580 "set the qemu binary",
582 Set the qemu binary that we will use.
584 The default is chosen when the library was compiled by the
587 You can also override this by setting the C<LIBGUESTFS_QEMU>
588 environment variable.
590 Setting C<qemu> to C<NULL> restores the default qemu binary.
592 Note that you should call this function as early as possible
593 after creating the handle. This is because some pre-launch
594 operations depend on testing qemu features (by running C<qemu -help>).
595 If the qemu binary changes, we don't retest features, and
596 so you might see inconsistent results. Using the environment
597 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
598 the qemu binary at the same time as the handle is created.");
600 ("get_qemu", (RConstString "qemu", []), -1, [],
601 [InitNone, Always, TestRun (
603 "get the qemu binary",
605 Return the current qemu binary.
607 This is always non-NULL. If it wasn't set already, then this will
608 return the default qemu binary name.");
610 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
612 "set the search path",
614 Set the path that libguestfs searches for kernel and initrd.img.
616 The default is C<$libdir/guestfs> unless overridden by setting
617 C<LIBGUESTFS_PATH> environment variable.
619 Setting C<path> to C<NULL> restores the default path.");
621 ("get_path", (RConstString "path", []), -1, [],
622 [InitNone, Always, TestRun (
624 "get the search path",
626 Return the current search path.
628 This is always non-NULL. If it wasn't set already, then this will
629 return the default path.");
631 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
633 "add options to kernel command line",
635 This function is used to add additional options to the
636 guest kernel command line.
638 The default is C<NULL> unless overridden by setting
639 C<LIBGUESTFS_APPEND> environment variable.
641 Setting C<append> to C<NULL> means I<no> additional options
642 are passed (libguestfs always adds a few of its own).");
644 ("get_append", (RConstOptString "append", []), -1, [],
645 (* This cannot be tested with the current framework. The
646 * function can return NULL in normal operations, which the
647 * test framework interprets as an error.
650 "get the additional kernel options",
652 Return the additional kernel options which are added to the
653 guest kernel command line.
655 If C<NULL> then no options are added.");
657 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
661 If C<autosync> is true, this enables autosync. Libguestfs will make a
662 best effort attempt to run C<guestfs_umount_all> followed by
663 C<guestfs_sync> when the handle is closed
664 (also if the program exits without closing handles).
666 This is disabled by default (except in guestfish where it is
667 enabled by default).");
669 ("get_autosync", (RBool "autosync", []), -1, [],
670 [InitNone, Always, TestRun (
671 [["get_autosync"]])],
674 Get the autosync flag.");
676 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
680 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
682 Verbose messages are disabled unless the environment variable
683 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
685 ("get_verbose", (RBool "verbose", []), -1, [],
689 This returns the verbose messages flag.");
691 ("is_ready", (RBool "ready", []), -1, [],
692 [InitNone, Always, TestOutputTrue (
694 "is ready to accept commands",
696 This returns true iff this handle is ready to accept commands
697 (in the C<READY> state).
699 For more information on states, see L<guestfs(3)>.");
701 ("is_config", (RBool "config", []), -1, [],
702 [InitNone, Always, TestOutputFalse (
704 "is in configuration state",
706 This returns true iff this handle is being configured
707 (in the C<CONFIG> state).
709 For more information on states, see L<guestfs(3)>.");
711 ("is_launching", (RBool "launching", []), -1, [],
712 [InitNone, Always, TestOutputFalse (
713 [["is_launching"]])],
714 "is launching subprocess",
716 This returns true iff this handle is launching the subprocess
717 (in the C<LAUNCHING> state).
719 For more information on states, see L<guestfs(3)>.");
721 ("is_busy", (RBool "busy", []), -1, [],
722 [InitNone, Always, TestOutputFalse (
724 "is busy processing a command",
726 This returns true iff this handle is busy processing a command
727 (in the C<BUSY> state).
729 For more information on states, see L<guestfs(3)>.");
731 ("get_state", (RInt "state", []), -1, [],
733 "get the current state",
735 This returns the current state as an opaque integer. This is
736 only useful for printing debug and internal error messages.
738 For more information on states, see L<guestfs(3)>.");
740 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
741 [InitNone, Always, TestOutputInt (
742 [["set_memsize"; "500"];
743 ["get_memsize"]], 500)],
744 "set memory allocated to the qemu subprocess",
746 This sets the memory size in megabytes allocated to the
747 qemu subprocess. This only has any effect if called before
750 You can also change this by setting the environment
751 variable C<LIBGUESTFS_MEMSIZE> before the handle is
754 For more information on the architecture of libguestfs,
755 see L<guestfs(3)>.");
757 ("get_memsize", (RInt "memsize", []), -1, [],
758 [InitNone, Always, TestOutputIntOp (
759 [["get_memsize"]], ">=", 256)],
760 "get memory allocated to the qemu subprocess",
762 This gets the memory size in megabytes allocated to the
765 If C<guestfs_set_memsize> was not called
766 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
767 then this returns the compiled-in default value for memsize.
769 For more information on the architecture of libguestfs,
770 see L<guestfs(3)>.");
772 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
773 [InitNone, Always, TestOutputIntOp (
774 [["get_pid"]], ">=", 1)],
775 "get PID of qemu subprocess",
777 Return the process ID of the qemu subprocess. If there is no
778 qemu subprocess, then this will return an error.
780 This is an internal call used for debugging and testing.");
782 ("version", (RStruct ("version", "version"), []), -1, [],
783 [InitNone, Always, TestOutputStruct (
784 [["version"]], [CompareWithInt ("major", 1)])],
785 "get the library version number",
787 Return the libguestfs version number that the program is linked
790 Note that because of dynamic linking this is not necessarily
791 the version of libguestfs that you compiled against. You can
792 compile the program, and then at runtime dynamically link
793 against a completely different C<libguestfs.so> library.
795 This call was added in version C<1.0.58>. In previous
796 versions of libguestfs there was no way to get the version
797 number. From C code you can use ELF weak linking tricks to find out if
798 this symbol exists (if it doesn't, then it's an earlier version).
800 The call returns a structure with four elements. The first
801 three (C<major>, C<minor> and C<release>) are numbers and
802 correspond to the usual version triplet. The fourth element
803 (C<extra>) is a string and is normally empty, but may be
804 used for distro-specific information.
806 To construct the original version string:
807 C<$major.$minor.$release$extra>
809 I<Note:> Don't use this call to test for availability
810 of features. Distro backports makes this unreliable. Use
811 C<guestfs_available> instead.");
813 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
814 [InitNone, Always, TestOutputTrue (
815 [["set_selinux"; "true"];
817 "set SELinux enabled or disabled at appliance boot",
819 This sets the selinux flag that is passed to the appliance
820 at boot time. The default is C<selinux=0> (disabled).
822 Note that if SELinux is enabled, it is always in
823 Permissive mode (C<enforcing=0>).
825 For more information on the architecture of libguestfs,
826 see L<guestfs(3)>.");
828 ("get_selinux", (RBool "selinux", []), -1, [],
830 "get SELinux enabled flag",
832 This returns the current setting of the selinux flag which
833 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
835 For more information on the architecture of libguestfs,
836 see L<guestfs(3)>.");
838 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
839 [InitNone, Always, TestOutputFalse (
840 [["set_trace"; "false"];
842 "enable or disable command traces",
844 If the command trace flag is set to 1, then commands are
845 printed on stdout before they are executed in a format
846 which is very similar to the one used by guestfish. In
847 other words, you can run a program with this enabled, and
848 you will get out a script which you can feed to guestfish
849 to perform the same set of actions.
851 If you want to trace C API calls into libguestfs (and
852 other libraries) then possibly a better way is to use
853 the external ltrace(1) command.
855 Command traces are disabled unless the environment variable
856 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
858 ("get_trace", (RBool "trace", []), -1, [],
860 "get command trace enabled flag",
862 Return the command trace flag.");
864 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
865 [InitNone, Always, TestOutputFalse (
866 [["set_direct"; "false"];
868 "enable or disable direct appliance mode",
870 If the direct appliance mode flag is enabled, then stdin and
871 stdout are passed directly through to the appliance once it
874 One consequence of this is that log messages aren't caught
875 by the library and handled by C<guestfs_set_log_message_callback>,
876 but go straight to stdout.
878 You probably don't want to use this unless you know what you
881 The default is disabled.");
883 ("get_direct", (RBool "direct", []), -1, [],
885 "get direct appliance mode flag",
887 Return the direct appliance mode flag.");
889 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
890 [InitNone, Always, TestOutputTrue (
891 [["set_recovery_proc"; "true"];
892 ["get_recovery_proc"]])],
893 "enable or disable the recovery process",
895 If this is called with the parameter C<false> then
896 C<guestfs_launch> does not create a recovery process. The
897 purpose of the recovery process is to stop runaway qemu
898 processes in the case where the main program aborts abruptly.
900 This only has any effect if called before C<guestfs_launch>,
901 and the default is true.
903 About the only time when you would want to disable this is
904 if the main process will fork itself into the background
905 (\"daemonize\" itself). In this case the recovery process
906 thinks that the main program has disappeared and so kills
907 qemu, which is not very helpful.");
909 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
911 "get recovery process enabled flag",
913 Return the recovery process enabled flag.");
915 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
917 "add a drive specifying the QEMU block emulation to use",
919 This is the same as C<guestfs_add_drive> but it allows you
920 to specify the QEMU interface emulation to use at run time.");
922 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
924 "add a drive read-only specifying the QEMU block emulation to use",
926 This is the same as C<guestfs_add_drive_ro> but it allows you
927 to specify the QEMU interface emulation to use at run time.");
931 (* daemon_functions are any functions which cause some action
932 * to take place in the daemon.
935 let daemon_functions = [
936 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
937 [InitEmpty, Always, TestOutput (
938 [["part_disk"; "/dev/sda"; "mbr"];
939 ["mkfs"; "ext2"; "/dev/sda1"];
940 ["mount"; "/dev/sda1"; "/"];
941 ["write"; "/new"; "new file contents"];
942 ["cat"; "/new"]], "new file contents")],
943 "mount a guest disk at a position in the filesystem",
945 Mount a guest disk at a position in the filesystem. Block devices
946 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
947 the guest. If those block devices contain partitions, they will have
948 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
951 The rules are the same as for L<mount(2)>: A filesystem must
952 first be mounted on C</> before others can be mounted. Other
953 filesystems can only be mounted on directories which already
956 The mounted filesystem is writable, if we have sufficient permissions
957 on the underlying device.
960 When you use this call, the filesystem options C<sync> and C<noatime>
961 are set implicitly. This was originally done because we thought it
962 would improve reliability, but it turns out that I<-o sync> has a
963 very large negative performance impact and negligible effect on
964 reliability. Therefore we recommend that you avoid using
965 C<guestfs_mount> in any code that needs performance, and instead
966 use C<guestfs_mount_options> (use an empty string for the first
967 parameter if you don't want any options).");
969 ("sync", (RErr, []), 2, [],
970 [ InitEmpty, Always, TestRun [["sync"]]],
971 "sync disks, writes are flushed through to the disk image",
973 This syncs the disk, so that any writes are flushed through to the
974 underlying disk image.
976 You should always call this if you have modified a disk image, before
977 closing the handle.");
979 ("touch", (RErr, [Pathname "path"]), 3, [],
980 [InitBasicFS, Always, TestOutputTrue (
982 ["exists"; "/new"]])],
983 "update file timestamps or create a new file",
985 Touch acts like the L<touch(1)> command. It can be used to
986 update the timestamps on a file, or, if the file does not exist,
987 to create a new zero-length file.");
989 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
990 [InitISOFS, Always, TestOutput (
991 [["cat"; "/known-2"]], "abcdef\n")],
992 "list the contents of a file",
994 Return the contents of the file named C<path>.
996 Note that this function cannot correctly handle binary files
997 (specifically, files containing C<\\0> character which is treated
998 as end of string). For those you need to use the C<guestfs_read_file>
999 or C<guestfs_download> functions which have a more complex interface.");
1001 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1002 [], (* XXX Tricky to test because it depends on the exact format
1003 * of the 'ls -l' command, which changes between F10 and F11.
1005 "list the files in a directory (long format)",
1007 List the files in C<directory> (relative to the root directory,
1008 there is no cwd) in the format of 'ls -la'.
1010 This command is mostly useful for interactive sessions. It
1011 is I<not> intended that you try to parse the output string.");
1013 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1014 [InitBasicFS, Always, TestOutputList (
1016 ["touch"; "/newer"];
1017 ["touch"; "/newest"];
1018 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1019 "list the files in a directory",
1021 List the files in C<directory> (relative to the root directory,
1022 there is no cwd). The '.' and '..' entries are not returned, but
1023 hidden files are shown.
1025 This command is mostly useful for interactive sessions. Programs
1026 should probably use C<guestfs_readdir> instead.");
1028 ("list_devices", (RStringList "devices", []), 7, [],
1029 [InitEmpty, Always, TestOutputListOfDevices (
1030 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1031 "list the block devices",
1033 List all the block devices.
1035 The full block device names are returned, eg. C</dev/sda>");
1037 ("list_partitions", (RStringList "partitions", []), 8, [],
1038 [InitBasicFS, Always, TestOutputListOfDevices (
1039 [["list_partitions"]], ["/dev/sda1"]);
1040 InitEmpty, Always, TestOutputListOfDevices (
1041 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1042 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1043 "list the partitions",
1045 List all the partitions detected on all block devices.
1047 The full partition device names are returned, eg. C</dev/sda1>
1049 This does not return logical volumes. For that you will need to
1050 call C<guestfs_lvs>.");
1052 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1053 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1054 [["pvs"]], ["/dev/sda1"]);
1055 InitEmpty, Always, TestOutputListOfDevices (
1056 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1057 ["pvcreate"; "/dev/sda1"];
1058 ["pvcreate"; "/dev/sda2"];
1059 ["pvcreate"; "/dev/sda3"];
1060 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1061 "list the LVM physical volumes (PVs)",
1063 List all the physical volumes detected. This is the equivalent
1064 of the L<pvs(8)> command.
1066 This returns a list of just the device names that contain
1067 PVs (eg. C</dev/sda2>).
1069 See also C<guestfs_pvs_full>.");
1071 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1072 [InitBasicFSonLVM, Always, TestOutputList (
1074 InitEmpty, Always, TestOutputList (
1075 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1076 ["pvcreate"; "/dev/sda1"];
1077 ["pvcreate"; "/dev/sda2"];
1078 ["pvcreate"; "/dev/sda3"];
1079 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1080 ["vgcreate"; "VG2"; "/dev/sda3"];
1081 ["vgs"]], ["VG1"; "VG2"])],
1082 "list the LVM volume groups (VGs)",
1084 List all the volumes groups detected. This is the equivalent
1085 of the L<vgs(8)> command.
1087 This returns a list of just the volume group names that were
1088 detected (eg. C<VolGroup00>).
1090 See also C<guestfs_vgs_full>.");
1092 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1093 [InitBasicFSonLVM, Always, TestOutputList (
1094 [["lvs"]], ["/dev/VG/LV"]);
1095 InitEmpty, Always, TestOutputList (
1096 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1097 ["pvcreate"; "/dev/sda1"];
1098 ["pvcreate"; "/dev/sda2"];
1099 ["pvcreate"; "/dev/sda3"];
1100 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1101 ["vgcreate"; "VG2"; "/dev/sda3"];
1102 ["lvcreate"; "LV1"; "VG1"; "50"];
1103 ["lvcreate"; "LV2"; "VG1"; "50"];
1104 ["lvcreate"; "LV3"; "VG2"; "50"];
1105 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1106 "list the LVM logical volumes (LVs)",
1108 List all the logical volumes detected. This is the equivalent
1109 of the L<lvs(8)> command.
1111 This returns a list of the logical volume device names
1112 (eg. C</dev/VolGroup00/LogVol00>).
1114 See also C<guestfs_lvs_full>.");
1116 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1117 [], (* XXX how to test? *)
1118 "list the LVM physical volumes (PVs)",
1120 List all the physical volumes detected. This is the equivalent
1121 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1123 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1124 [], (* XXX how to test? *)
1125 "list the LVM volume groups (VGs)",
1127 List all the volumes groups detected. This is the equivalent
1128 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1130 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1131 [], (* XXX how to test? *)
1132 "list the LVM logical volumes (LVs)",
1134 List all the logical volumes detected. This is the equivalent
1135 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1137 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1138 [InitISOFS, Always, TestOutputList (
1139 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1140 InitISOFS, Always, TestOutputList (
1141 [["read_lines"; "/empty"]], [])],
1142 "read file as lines",
1144 Return the contents of the file named C<path>.
1146 The file contents are returned as a list of lines. Trailing
1147 C<LF> and C<CRLF> character sequences are I<not> returned.
1149 Note that this function cannot correctly handle binary files
1150 (specifically, files containing C<\\0> character which is treated
1151 as end of line). For those you need to use the C<guestfs_read_file>
1152 function which has a more complex interface.");
1154 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1155 [], (* XXX Augeas code needs tests. *)
1156 "create a new Augeas handle",
1158 Create a new Augeas handle for editing configuration files.
1159 If there was any previous Augeas handle associated with this
1160 guestfs session, then it is closed.
1162 You must call this before using any other C<guestfs_aug_*>
1165 C<root> is the filesystem root. C<root> must not be NULL,
1168 The flags are the same as the flags defined in
1169 E<lt>augeas.hE<gt>, the logical I<or> of the following
1174 =item C<AUG_SAVE_BACKUP> = 1
1176 Keep the original file with a C<.augsave> extension.
1178 =item C<AUG_SAVE_NEWFILE> = 2
1180 Save changes into a file with extension C<.augnew>, and
1181 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1183 =item C<AUG_TYPE_CHECK> = 4
1185 Typecheck lenses (can be expensive).
1187 =item C<AUG_NO_STDINC> = 8
1189 Do not use standard load path for modules.
1191 =item C<AUG_SAVE_NOOP> = 16
1193 Make save a no-op, just record what would have been changed.
1195 =item C<AUG_NO_LOAD> = 32
1197 Do not load the tree in C<guestfs_aug_init>.
1201 To close the handle, you can call C<guestfs_aug_close>.
1203 To find out more about Augeas, see L<http://augeas.net/>.");
1205 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1206 [], (* XXX Augeas code needs tests. *)
1207 "close the current Augeas handle",
1209 Close the current Augeas handle and free up any resources
1210 used by it. After calling this, you have to call
1211 C<guestfs_aug_init> again before you can use any other
1212 Augeas functions.");
1214 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1215 [], (* XXX Augeas code needs tests. *)
1216 "define an Augeas variable",
1218 Defines an Augeas variable C<name> whose value is the result
1219 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1222 On success this returns the number of nodes in C<expr>, or
1223 C<0> if C<expr> evaluates to something which is not a nodeset.");
1225 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1226 [], (* XXX Augeas code needs tests. *)
1227 "define an Augeas node",
1229 Defines a variable C<name> whose value is the result of
1232 If C<expr> evaluates to an empty nodeset, a node is created,
1233 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1234 C<name> will be the nodeset containing that single node.
1236 On success this returns a pair containing the
1237 number of nodes in the nodeset, and a boolean flag
1238 if a node was created.");
1240 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1241 [], (* XXX Augeas code needs tests. *)
1242 "look up the value of an Augeas path",
1244 Look up the value associated with C<path>. If C<path>
1245 matches exactly one node, the C<value> is returned.");
1247 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1248 [], (* XXX Augeas code needs tests. *)
1249 "set Augeas path to value",
1251 Set the value associated with C<path> to C<val>.
1253 In the Augeas API, it is possible to clear a node by setting
1254 the value to NULL. Due to an oversight in the libguestfs API
1255 you cannot do that with this call. Instead you must use the
1256 C<guestfs_aug_clear> call.");
1258 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1259 [], (* XXX Augeas code needs tests. *)
1260 "insert a sibling Augeas node",
1262 Create a new sibling C<label> for C<path>, inserting it into
1263 the tree before or after C<path> (depending on the boolean
1266 C<path> must match exactly one existing node in the tree, and
1267 C<label> must be a label, ie. not contain C</>, C<*> or end
1268 with a bracketed index C<[N]>.");
1270 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1271 [], (* XXX Augeas code needs tests. *)
1272 "remove an Augeas path",
1274 Remove C<path> and all of its children.
1276 On success this returns the number of entries which were removed.");
1278 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1279 [], (* XXX Augeas code needs tests. *)
1282 Move the node C<src> to C<dest>. C<src> must match exactly
1283 one node. C<dest> is overwritten if it exists.");
1285 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1286 [], (* XXX Augeas code needs tests. *)
1287 "return Augeas nodes which match augpath",
1289 Returns a list of paths which match the path expression C<path>.
1290 The returned paths are sufficiently qualified so that they match
1291 exactly one node in the current tree.");
1293 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1294 [], (* XXX Augeas code needs tests. *)
1295 "write all pending Augeas changes to disk",
1297 This writes all pending changes to disk.
1299 The flags which were passed to C<guestfs_aug_init> affect exactly
1300 how files are saved.");
1302 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1303 [], (* XXX Augeas code needs tests. *)
1304 "load files into the tree",
1306 Load files into the tree.
1308 See C<aug_load> in the Augeas documentation for the full gory
1311 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1312 [], (* XXX Augeas code needs tests. *)
1313 "list Augeas nodes under augpath",
1315 This is just a shortcut for listing C<guestfs_aug_match>
1316 C<path/*> and sorting the resulting nodes into alphabetical order.");
1318 ("rm", (RErr, [Pathname "path"]), 29, [],
1319 [InitBasicFS, Always, TestRun
1322 InitBasicFS, Always, TestLastFail
1324 InitBasicFS, Always, TestLastFail
1329 Remove the single file C<path>.");
1331 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1332 [InitBasicFS, Always, TestRun
1335 InitBasicFS, Always, TestLastFail
1336 [["rmdir"; "/new"]];
1337 InitBasicFS, Always, TestLastFail
1339 ["rmdir"; "/new"]]],
1340 "remove a directory",
1342 Remove the single directory C<path>.");
1344 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1345 [InitBasicFS, Always, TestOutputFalse
1347 ["mkdir"; "/new/foo"];
1348 ["touch"; "/new/foo/bar"];
1350 ["exists"; "/new"]]],
1351 "remove a file or directory recursively",
1353 Remove the file or directory C<path>, recursively removing the
1354 contents if its a directory. This is like the C<rm -rf> shell
1357 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1358 [InitBasicFS, Always, TestOutputTrue
1360 ["is_dir"; "/new"]];
1361 InitBasicFS, Always, TestLastFail
1362 [["mkdir"; "/new/foo/bar"]]],
1363 "create a directory",
1365 Create a directory named C<path>.");
1367 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1368 [InitBasicFS, Always, TestOutputTrue
1369 [["mkdir_p"; "/new/foo/bar"];
1370 ["is_dir"; "/new/foo/bar"]];
1371 InitBasicFS, Always, TestOutputTrue
1372 [["mkdir_p"; "/new/foo/bar"];
1373 ["is_dir"; "/new/foo"]];
1374 InitBasicFS, Always, TestOutputTrue
1375 [["mkdir_p"; "/new/foo/bar"];
1376 ["is_dir"; "/new"]];
1377 (* Regression tests for RHBZ#503133: *)
1378 InitBasicFS, Always, TestRun
1380 ["mkdir_p"; "/new"]];
1381 InitBasicFS, Always, TestLastFail
1383 ["mkdir_p"; "/new"]]],
1384 "create a directory and parents",
1386 Create a directory named C<path>, creating any parent directories
1387 as necessary. This is like the C<mkdir -p> shell command.");
1389 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1390 [], (* XXX Need stat command to test *)
1393 Change the mode (permissions) of C<path> to C<mode>. Only
1394 numeric modes are supported.
1396 I<Note>: When using this command from guestfish, C<mode>
1397 by default would be decimal, unless you prefix it with
1398 C<0> to get octal, ie. use C<0700> not C<700>.
1400 The mode actually set is affected by the umask.");
1402 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1403 [], (* XXX Need stat command to test *)
1404 "change file owner and group",
1406 Change the file owner to C<owner> and group to C<group>.
1408 Only numeric uid and gid are supported. If you want to use
1409 names, you will need to locate and parse the password file
1410 yourself (Augeas support makes this relatively easy).");
1412 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1413 [InitISOFS, Always, TestOutputTrue (
1414 [["exists"; "/empty"]]);
1415 InitISOFS, Always, TestOutputTrue (
1416 [["exists"; "/directory"]])],
1417 "test if file or directory exists",
1419 This returns C<true> if and only if there is a file, directory
1420 (or anything) with the given C<path> name.
1422 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1424 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1425 [InitISOFS, Always, TestOutputTrue (
1426 [["is_file"; "/known-1"]]);
1427 InitISOFS, Always, TestOutputFalse (
1428 [["is_file"; "/directory"]])],
1429 "test if file exists",
1431 This returns C<true> if and only if there is a file
1432 with the given C<path> name. Note that it returns false for
1433 other objects like directories.
1435 See also C<guestfs_stat>.");
1437 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1438 [InitISOFS, Always, TestOutputFalse (
1439 [["is_dir"; "/known-3"]]);
1440 InitISOFS, Always, TestOutputTrue (
1441 [["is_dir"; "/directory"]])],
1442 "test if file exists",
1444 This returns C<true> if and only if there is a directory
1445 with the given C<path> name. Note that it returns false for
1446 other objects like files.
1448 See also C<guestfs_stat>.");
1450 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1451 [InitEmpty, Always, TestOutputListOfDevices (
1452 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1453 ["pvcreate"; "/dev/sda1"];
1454 ["pvcreate"; "/dev/sda2"];
1455 ["pvcreate"; "/dev/sda3"];
1456 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1457 "create an LVM physical volume",
1459 This creates an LVM physical volume on the named C<device>,
1460 where C<device> should usually be a partition name such
1463 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1464 [InitEmpty, Always, TestOutputList (
1465 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1466 ["pvcreate"; "/dev/sda1"];
1467 ["pvcreate"; "/dev/sda2"];
1468 ["pvcreate"; "/dev/sda3"];
1469 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1470 ["vgcreate"; "VG2"; "/dev/sda3"];
1471 ["vgs"]], ["VG1"; "VG2"])],
1472 "create an LVM volume group",
1474 This creates an LVM volume group called C<volgroup>
1475 from the non-empty list of physical volumes C<physvols>.");
1477 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1478 [InitEmpty, Always, TestOutputList (
1479 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1480 ["pvcreate"; "/dev/sda1"];
1481 ["pvcreate"; "/dev/sda2"];
1482 ["pvcreate"; "/dev/sda3"];
1483 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1484 ["vgcreate"; "VG2"; "/dev/sda3"];
1485 ["lvcreate"; "LV1"; "VG1"; "50"];
1486 ["lvcreate"; "LV2"; "VG1"; "50"];
1487 ["lvcreate"; "LV3"; "VG2"; "50"];
1488 ["lvcreate"; "LV4"; "VG2"; "50"];
1489 ["lvcreate"; "LV5"; "VG2"; "50"];
1491 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1492 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1493 "create an LVM logical volume",
1495 This creates an LVM logical volume called C<logvol>
1496 on the volume group C<volgroup>, with C<size> megabytes.");
1498 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1499 [InitEmpty, Always, TestOutput (
1500 [["part_disk"; "/dev/sda"; "mbr"];
1501 ["mkfs"; "ext2"; "/dev/sda1"];
1502 ["mount_options"; ""; "/dev/sda1"; "/"];
1503 ["write"; "/new"; "new file contents"];
1504 ["cat"; "/new"]], "new file contents")],
1505 "make a filesystem",
1507 This creates a filesystem on C<device> (usually a partition
1508 or LVM logical volume). The filesystem type is C<fstype>, for
1511 ("sfdisk", (RErr, [Device "device";
1512 Int "cyls"; Int "heads"; Int "sectors";
1513 StringList "lines"]), 43, [DangerWillRobinson],
1515 "create partitions on a block device",
1517 This is a direct interface to the L<sfdisk(8)> program for creating
1518 partitions on block devices.
1520 C<device> should be a block device, for example C</dev/sda>.
1522 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1523 and sectors on the device, which are passed directly to sfdisk as
1524 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1525 of these, then the corresponding parameter is omitted. Usually for
1526 'large' disks, you can just pass C<0> for these, but for small
1527 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1528 out the right geometry and you will need to tell it.
1530 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1531 information refer to the L<sfdisk(8)> manpage.
1533 To create a single partition occupying the whole disk, you would
1534 pass C<lines> as a single element list, when the single element being
1535 the string C<,> (comma).
1537 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1538 C<guestfs_part_init>");
1540 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
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.");
1555 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1556 [InitEmpty, Always, TestOutputListOfDevices (
1557 [["part_disk"; "/dev/sda"; "mbr"];
1558 ["mkfs"; "ext2"; "/dev/sda1"];
1559 ["mount_options"; ""; "/dev/sda1"; "/"];
1560 ["mounts"]], ["/dev/sda1"]);
1561 InitEmpty, Always, TestOutputList (
1562 [["part_disk"; "/dev/sda"; "mbr"];
1563 ["mkfs"; "ext2"; "/dev/sda1"];
1564 ["mount_options"; ""; "/dev/sda1"; "/"];
1567 "unmount a filesystem",
1569 This unmounts the given filesystem. The filesystem may be
1570 specified either by its mountpoint (path) or the device which
1571 contains the filesystem.");
1573 ("mounts", (RStringList "devices", []), 46, [],
1574 [InitBasicFS, Always, TestOutputListOfDevices (
1575 [["mounts"]], ["/dev/sda1"])],
1576 "show mounted filesystems",
1578 This returns the list of currently mounted filesystems. It returns
1579 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1581 Some internal mounts are not shown.
1583 See also: C<guestfs_mountpoints>");
1585 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1586 [InitBasicFS, Always, TestOutputList (
1589 (* check that umount_all can unmount nested mounts correctly: *)
1590 InitEmpty, Always, TestOutputList (
1591 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1592 ["mkfs"; "ext2"; "/dev/sda1"];
1593 ["mkfs"; "ext2"; "/dev/sda2"];
1594 ["mkfs"; "ext2"; "/dev/sda3"];
1595 ["mount_options"; ""; "/dev/sda1"; "/"];
1597 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1598 ["mkdir"; "/mp1/mp2"];
1599 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1600 ["mkdir"; "/mp1/mp2/mp3"];
1603 "unmount all filesystems",
1605 This unmounts all mounted filesystems.
1607 Some internal mounts are not unmounted by this call.");
1609 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1611 "remove all LVM LVs, VGs and PVs",
1613 This command removes all LVM logical volumes, volume groups
1614 and physical volumes.");
1616 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1617 [InitISOFS, Always, TestOutput (
1618 [["file"; "/empty"]], "empty");
1619 InitISOFS, Always, TestOutput (
1620 [["file"; "/known-1"]], "ASCII text");
1621 InitISOFS, Always, TestLastFail (
1622 [["file"; "/notexists"]])],
1623 "determine file type",
1625 This call uses the standard L<file(1)> command to determine
1626 the type or contents of the file. This also works on devices,
1627 for example to find out whether a partition contains a filesystem.
1629 This call will also transparently look inside various types
1632 The exact command which runs is C<file -zbsL path>. Note in
1633 particular that the filename is not prepended to the output
1634 (the C<-b> option).");
1636 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1637 [InitBasicFS, Always, TestOutput (
1638 [["upload"; "test-command"; "/test-command"];
1639 ["chmod"; "0o755"; "/test-command"];
1640 ["command"; "/test-command 1"]], "Result1");
1641 InitBasicFS, Always, TestOutput (
1642 [["upload"; "test-command"; "/test-command"];
1643 ["chmod"; "0o755"; "/test-command"];
1644 ["command"; "/test-command 2"]], "Result2\n");
1645 InitBasicFS, Always, TestOutput (
1646 [["upload"; "test-command"; "/test-command"];
1647 ["chmod"; "0o755"; "/test-command"];
1648 ["command"; "/test-command 3"]], "\nResult3");
1649 InitBasicFS, Always, TestOutput (
1650 [["upload"; "test-command"; "/test-command"];
1651 ["chmod"; "0o755"; "/test-command"];
1652 ["command"; "/test-command 4"]], "\nResult4\n");
1653 InitBasicFS, Always, TestOutput (
1654 [["upload"; "test-command"; "/test-command"];
1655 ["chmod"; "0o755"; "/test-command"];
1656 ["command"; "/test-command 5"]], "\nResult5\n\n");
1657 InitBasicFS, Always, TestOutput (
1658 [["upload"; "test-command"; "/test-command"];
1659 ["chmod"; "0o755"; "/test-command"];
1660 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1661 InitBasicFS, Always, TestOutput (
1662 [["upload"; "test-command"; "/test-command"];
1663 ["chmod"; "0o755"; "/test-command"];
1664 ["command"; "/test-command 7"]], "");
1665 InitBasicFS, Always, TestOutput (
1666 [["upload"; "test-command"; "/test-command"];
1667 ["chmod"; "0o755"; "/test-command"];
1668 ["command"; "/test-command 8"]], "\n");
1669 InitBasicFS, Always, TestOutput (
1670 [["upload"; "test-command"; "/test-command"];
1671 ["chmod"; "0o755"; "/test-command"];
1672 ["command"; "/test-command 9"]], "\n\n");
1673 InitBasicFS, Always, TestOutput (
1674 [["upload"; "test-command"; "/test-command"];
1675 ["chmod"; "0o755"; "/test-command"];
1676 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1677 InitBasicFS, Always, TestOutput (
1678 [["upload"; "test-command"; "/test-command"];
1679 ["chmod"; "0o755"; "/test-command"];
1680 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1681 InitBasicFS, Always, TestLastFail (
1682 [["upload"; "test-command"; "/test-command"];
1683 ["chmod"; "0o755"; "/test-command"];
1684 ["command"; "/test-command"]])],
1685 "run a command from the guest filesystem",
1687 This call runs a command from the guest filesystem. The
1688 filesystem must be mounted, and must contain a compatible
1689 operating system (ie. something Linux, with the same
1690 or compatible processor architecture).
1692 The single parameter is an argv-style list of arguments.
1693 The first element is the name of the program to run.
1694 Subsequent elements are parameters. The list must be
1695 non-empty (ie. must contain a program name). Note that
1696 the command runs directly, and is I<not> invoked via
1697 the shell (see C<guestfs_sh>).
1699 The return value is anything printed to I<stdout> by
1702 If the command returns a non-zero exit status, then
1703 this function returns an error message. The error message
1704 string is the content of I<stderr> from the command.
1706 The C<$PATH> environment variable will contain at least
1707 C</usr/bin> and C</bin>. If you require a program from
1708 another location, you should provide the full path in the
1711 Shared libraries and data files required by the program
1712 must be available on filesystems which are mounted in the
1713 correct places. It is the caller's responsibility to ensure
1714 all filesystems that are needed are mounted at the right
1717 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1718 [InitBasicFS, Always, TestOutputList (
1719 [["upload"; "test-command"; "/test-command"];
1720 ["chmod"; "0o755"; "/test-command"];
1721 ["command_lines"; "/test-command 1"]], ["Result1"]);
1722 InitBasicFS, Always, TestOutputList (
1723 [["upload"; "test-command"; "/test-command"];
1724 ["chmod"; "0o755"; "/test-command"];
1725 ["command_lines"; "/test-command 2"]], ["Result2"]);
1726 InitBasicFS, Always, TestOutputList (
1727 [["upload"; "test-command"; "/test-command"];
1728 ["chmod"; "0o755"; "/test-command"];
1729 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1730 InitBasicFS, Always, TestOutputList (
1731 [["upload"; "test-command"; "/test-command"];
1732 ["chmod"; "0o755"; "/test-command"];
1733 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1734 InitBasicFS, Always, TestOutputList (
1735 [["upload"; "test-command"; "/test-command"];
1736 ["chmod"; "0o755"; "/test-command"];
1737 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1738 InitBasicFS, Always, TestOutputList (
1739 [["upload"; "test-command"; "/test-command"];
1740 ["chmod"; "0o755"; "/test-command"];
1741 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1742 InitBasicFS, Always, TestOutputList (
1743 [["upload"; "test-command"; "/test-command"];
1744 ["chmod"; "0o755"; "/test-command"];
1745 ["command_lines"; "/test-command 7"]], []);
1746 InitBasicFS, Always, TestOutputList (
1747 [["upload"; "test-command"; "/test-command"];
1748 ["chmod"; "0o755"; "/test-command"];
1749 ["command_lines"; "/test-command 8"]], [""]);
1750 InitBasicFS, Always, TestOutputList (
1751 [["upload"; "test-command"; "/test-command"];
1752 ["chmod"; "0o755"; "/test-command"];
1753 ["command_lines"; "/test-command 9"]], ["";""]);
1754 InitBasicFS, Always, TestOutputList (
1755 [["upload"; "test-command"; "/test-command"];
1756 ["chmod"; "0o755"; "/test-command"];
1757 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1758 InitBasicFS, Always, TestOutputList (
1759 [["upload"; "test-command"; "/test-command"];
1760 ["chmod"; "0o755"; "/test-command"];
1761 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1762 "run a command, returning lines",
1764 This is the same as C<guestfs_command>, but splits the
1765 result into a list of lines.
1767 See also: C<guestfs_sh_lines>");
1769 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1770 [InitISOFS, Always, TestOutputStruct (
1771 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1772 "get file information",
1774 Returns file information for the given C<path>.
1776 This is the same as the C<stat(2)> system call.");
1778 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1779 [InitISOFS, Always, TestOutputStruct (
1780 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1781 "get file information for a symbolic link",
1783 Returns file information for the given C<path>.
1785 This is the same as C<guestfs_stat> except that if C<path>
1786 is a symbolic link, then the link is stat-ed, not the file it
1789 This is the same as the C<lstat(2)> system call.");
1791 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1792 [InitISOFS, Always, TestOutputStruct (
1793 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1794 "get file system statistics",
1796 Returns file system statistics for any mounted file system.
1797 C<path> should be a file or directory in the mounted file system
1798 (typically it is the mount point itself, but it doesn't need to be).
1800 This is the same as the C<statvfs(2)> system call.");
1802 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1804 "get ext2/ext3/ext4 superblock details",
1806 This returns the contents of the ext2, ext3 or ext4 filesystem
1807 superblock on C<device>.
1809 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1810 manpage for more details. The list of fields returned isn't
1811 clearly defined, and depends on both the version of C<tune2fs>
1812 that libguestfs was built against, and the filesystem itself.");
1814 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1815 [InitEmpty, Always, TestOutputTrue (
1816 [["blockdev_setro"; "/dev/sda"];
1817 ["blockdev_getro"; "/dev/sda"]])],
1818 "set block device to read-only",
1820 Sets the block device named C<device> to read-only.
1822 This uses the L<blockdev(8)> command.");
1824 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1825 [InitEmpty, Always, TestOutputFalse (
1826 [["blockdev_setrw"; "/dev/sda"];
1827 ["blockdev_getro"; "/dev/sda"]])],
1828 "set block device to read-write",
1830 Sets the block device named C<device> to read-write.
1832 This uses the L<blockdev(8)> command.");
1834 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1835 [InitEmpty, Always, TestOutputTrue (
1836 [["blockdev_setro"; "/dev/sda"];
1837 ["blockdev_getro"; "/dev/sda"]])],
1838 "is block device set to read-only",
1840 Returns a boolean indicating if the block device is read-only
1841 (true if read-only, false if not).
1843 This uses the L<blockdev(8)> command.");
1845 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1846 [InitEmpty, Always, TestOutputInt (
1847 [["blockdev_getss"; "/dev/sda"]], 512)],
1848 "get sectorsize of block device",
1850 This returns the size of sectors on a block device.
1851 Usually 512, but can be larger for modern devices.
1853 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1856 This uses the L<blockdev(8)> command.");
1858 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1859 [InitEmpty, Always, TestOutputInt (
1860 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1861 "get blocksize of block device",
1863 This returns the block size of a device.
1865 (Note this is different from both I<size in blocks> and
1866 I<filesystem block size>).
1868 This uses the L<blockdev(8)> command.");
1870 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1872 "set blocksize of block device",
1874 This sets the block size of a device.
1876 (Note this is different from both I<size in blocks> and
1877 I<filesystem block size>).
1879 This uses the L<blockdev(8)> command.");
1881 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1882 [InitEmpty, Always, TestOutputInt (
1883 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1884 "get total size of device in 512-byte sectors",
1886 This returns the size of the device in units of 512-byte sectors
1887 (even if the sectorsize isn't 512 bytes ... weird).
1889 See also C<guestfs_blockdev_getss> for the real sector size of
1890 the device, and C<guestfs_blockdev_getsize64> for the more
1891 useful I<size in bytes>.
1893 This uses the L<blockdev(8)> command.");
1895 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1896 [InitEmpty, Always, TestOutputInt (
1897 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1898 "get total size of device in bytes",
1900 This returns the size of the device in bytes.
1902 See also C<guestfs_blockdev_getsz>.
1904 This uses the L<blockdev(8)> command.");
1906 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1907 [InitEmpty, Always, TestRun
1908 [["blockdev_flushbufs"; "/dev/sda"]]],
1909 "flush device buffers",
1911 This tells the kernel to flush internal buffers associated
1914 This uses the L<blockdev(8)> command.");
1916 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1917 [InitEmpty, Always, TestRun
1918 [["blockdev_rereadpt"; "/dev/sda"]]],
1919 "reread partition table",
1921 Reread the partition table on C<device>.
1923 This uses the L<blockdev(8)> command.");
1925 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1926 [InitBasicFS, Always, TestOutput (
1927 (* Pick a file from cwd which isn't likely to change. *)
1928 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1929 ["checksum"; "md5"; "/COPYING.LIB"]],
1930 Digest.to_hex (Digest.file "COPYING.LIB"))],
1931 "upload a file from the local machine",
1933 Upload local file C<filename> to C<remotefilename> on the
1936 C<filename> can also be a named pipe.
1938 See also C<guestfs_download>.");
1940 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1941 [InitBasicFS, Always, TestOutput (
1942 (* Pick a file from cwd which isn't likely to change. *)
1943 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1944 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1945 ["upload"; "testdownload.tmp"; "/upload"];
1946 ["checksum"; "md5"; "/upload"]],
1947 Digest.to_hex (Digest.file "COPYING.LIB"))],
1948 "download a file to the local machine",
1950 Download file C<remotefilename> and save it as C<filename>
1951 on the local machine.
1953 C<filename> can also be a named pipe.
1955 See also C<guestfs_upload>, C<guestfs_cat>.");
1957 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1958 [InitISOFS, Always, TestOutput (
1959 [["checksum"; "crc"; "/known-3"]], "2891671662");
1960 InitISOFS, Always, TestLastFail (
1961 [["checksum"; "crc"; "/notexists"]]);
1962 InitISOFS, Always, TestOutput (
1963 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1964 InitISOFS, Always, TestOutput (
1965 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1966 InitISOFS, Always, TestOutput (
1967 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1968 InitISOFS, Always, TestOutput (
1969 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1970 InitISOFS, Always, TestOutput (
1971 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1972 InitISOFS, Always, TestOutput (
1973 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
1974 (* Test for RHBZ#579608, absolute symbolic links. *)
1975 InitISOFS, Always, TestOutput (
1976 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
1977 "compute MD5, SHAx or CRC checksum of file",
1979 This call computes the MD5, SHAx or CRC checksum of the
1982 The type of checksum to compute is given by the C<csumtype>
1983 parameter which must have one of the following values:
1989 Compute the cyclic redundancy check (CRC) specified by POSIX
1990 for the C<cksum> command.
1994 Compute the MD5 hash (using the C<md5sum> program).
1998 Compute the SHA1 hash (using the C<sha1sum> program).
2002 Compute the SHA224 hash (using the C<sha224sum> program).
2006 Compute the SHA256 hash (using the C<sha256sum> program).
2010 Compute the SHA384 hash (using the C<sha384sum> program).
2014 Compute the SHA512 hash (using the C<sha512sum> program).
2018 The checksum is returned as a printable string.
2020 To get the checksum for a device, use C<guestfs_checksum_device>.
2022 To get the checksums for many files, use C<guestfs_checksums_out>.");
2024 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2025 [InitBasicFS, Always, TestOutput (
2026 [["tar_in"; "../images/helloworld.tar"; "/"];
2027 ["cat"; "/hello"]], "hello\n")],
2028 "unpack tarfile to directory",
2030 This command uploads and unpacks local file C<tarfile> (an
2031 I<uncompressed> tar file) into C<directory>.
2033 To upload a compressed tarball, use C<guestfs_tgz_in>
2034 or C<guestfs_txz_in>.");
2036 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2038 "pack directory into tarfile",
2040 This command packs the contents of C<directory> and downloads
2041 it to local file C<tarfile>.
2043 To download a compressed tarball, use C<guestfs_tgz_out>
2044 or C<guestfs_txz_out>.");
2046 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2047 [InitBasicFS, Always, TestOutput (
2048 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2049 ["cat"; "/hello"]], "hello\n")],
2050 "unpack compressed tarball to directory",
2052 This command uploads and unpacks local file C<tarball> (a
2053 I<gzip compressed> tar file) into C<directory>.
2055 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2057 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2059 "pack directory into compressed tarball",
2061 This command packs the contents of C<directory> and downloads
2062 it to local file C<tarball>.
2064 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2066 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2067 [InitBasicFS, Always, TestLastFail (
2069 ["mount_ro"; "/dev/sda1"; "/"];
2070 ["touch"; "/new"]]);
2071 InitBasicFS, Always, TestOutput (
2072 [["write"; "/new"; "data"];
2074 ["mount_ro"; "/dev/sda1"; "/"];
2075 ["cat"; "/new"]], "data")],
2076 "mount a guest disk, read-only",
2078 This is the same as the C<guestfs_mount> command, but it
2079 mounts the filesystem with the read-only (I<-o ro>) flag.");
2081 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2083 "mount a guest disk with mount options",
2085 This is the same as the C<guestfs_mount> command, but it
2086 allows you to set the mount options as for the
2087 L<mount(8)> I<-o> flag.
2089 If the C<options> parameter is an empty string, then
2090 no options are passed (all options default to whatever
2091 the filesystem uses).");
2093 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2095 "mount a guest disk with mount options and vfstype",
2097 This is the same as the C<guestfs_mount> command, but it
2098 allows you to set both the mount options and the vfstype
2099 as for the L<mount(8)> I<-o> and I<-t> flags.");
2101 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2103 "debugging and internals",
2105 The C<guestfs_debug> command exposes some internals of
2106 C<guestfsd> (the guestfs daemon) that runs inside the
2109 There is no comprehensive help for this command. You have
2110 to look at the file C<daemon/debug.c> in the libguestfs source
2111 to find out what you can do.");
2113 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2114 [InitEmpty, Always, TestOutputList (
2115 [["part_disk"; "/dev/sda"; "mbr"];
2116 ["pvcreate"; "/dev/sda1"];
2117 ["vgcreate"; "VG"; "/dev/sda1"];
2118 ["lvcreate"; "LV1"; "VG"; "50"];
2119 ["lvcreate"; "LV2"; "VG"; "50"];
2120 ["lvremove"; "/dev/VG/LV1"];
2121 ["lvs"]], ["/dev/VG/LV2"]);
2122 InitEmpty, Always, TestOutputList (
2123 [["part_disk"; "/dev/sda"; "mbr"];
2124 ["pvcreate"; "/dev/sda1"];
2125 ["vgcreate"; "VG"; "/dev/sda1"];
2126 ["lvcreate"; "LV1"; "VG"; "50"];
2127 ["lvcreate"; "LV2"; "VG"; "50"];
2128 ["lvremove"; "/dev/VG"];
2130 InitEmpty, Always, TestOutputList (
2131 [["part_disk"; "/dev/sda"; "mbr"];
2132 ["pvcreate"; "/dev/sda1"];
2133 ["vgcreate"; "VG"; "/dev/sda1"];
2134 ["lvcreate"; "LV1"; "VG"; "50"];
2135 ["lvcreate"; "LV2"; "VG"; "50"];
2136 ["lvremove"; "/dev/VG"];
2138 "remove an LVM logical volume",
2140 Remove an LVM logical volume C<device>, where C<device> is
2141 the path to the LV, such as C</dev/VG/LV>.
2143 You can also remove all LVs in a volume group by specifying
2144 the VG name, C</dev/VG>.");
2146 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2147 [InitEmpty, Always, TestOutputList (
2148 [["part_disk"; "/dev/sda"; "mbr"];
2149 ["pvcreate"; "/dev/sda1"];
2150 ["vgcreate"; "VG"; "/dev/sda1"];
2151 ["lvcreate"; "LV1"; "VG"; "50"];
2152 ["lvcreate"; "LV2"; "VG"; "50"];
2155 InitEmpty, Always, TestOutputList (
2156 [["part_disk"; "/dev/sda"; "mbr"];
2157 ["pvcreate"; "/dev/sda1"];
2158 ["vgcreate"; "VG"; "/dev/sda1"];
2159 ["lvcreate"; "LV1"; "VG"; "50"];
2160 ["lvcreate"; "LV2"; "VG"; "50"];
2163 "remove an LVM volume group",
2165 Remove an LVM volume group C<vgname>, (for example C<VG>).
2167 This also forcibly removes all logical volumes in the volume
2170 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2171 [InitEmpty, Always, TestOutputListOfDevices (
2172 [["part_disk"; "/dev/sda"; "mbr"];
2173 ["pvcreate"; "/dev/sda1"];
2174 ["vgcreate"; "VG"; "/dev/sda1"];
2175 ["lvcreate"; "LV1"; "VG"; "50"];
2176 ["lvcreate"; "LV2"; "VG"; "50"];
2178 ["pvremove"; "/dev/sda1"];
2180 InitEmpty, Always, TestOutputListOfDevices (
2181 [["part_disk"; "/dev/sda"; "mbr"];
2182 ["pvcreate"; "/dev/sda1"];
2183 ["vgcreate"; "VG"; "/dev/sda1"];
2184 ["lvcreate"; "LV1"; "VG"; "50"];
2185 ["lvcreate"; "LV2"; "VG"; "50"];
2187 ["pvremove"; "/dev/sda1"];
2189 InitEmpty, Always, TestOutputListOfDevices (
2190 [["part_disk"; "/dev/sda"; "mbr"];
2191 ["pvcreate"; "/dev/sda1"];
2192 ["vgcreate"; "VG"; "/dev/sda1"];
2193 ["lvcreate"; "LV1"; "VG"; "50"];
2194 ["lvcreate"; "LV2"; "VG"; "50"];
2196 ["pvremove"; "/dev/sda1"];
2198 "remove an LVM physical volume",
2200 This wipes a physical volume C<device> so that LVM will no longer
2203 The implementation uses the C<pvremove> command which refuses to
2204 wipe physical volumes that contain any volume groups, so you have
2205 to remove those first.");
2207 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2208 [InitBasicFS, Always, TestOutput (
2209 [["set_e2label"; "/dev/sda1"; "testlabel"];
2210 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2211 "set the ext2/3/4 filesystem label",
2213 This sets the ext2/3/4 filesystem label of the filesystem on
2214 C<device> to C<label>. Filesystem labels are limited to
2217 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2218 to return the existing label on a filesystem.");
2220 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2222 "get the ext2/3/4 filesystem label",
2224 This returns the ext2/3/4 filesystem label of the filesystem on
2227 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2228 (let uuid = uuidgen () in
2229 [InitBasicFS, Always, TestOutput (
2230 [["set_e2uuid"; "/dev/sda1"; uuid];
2231 ["get_e2uuid"; "/dev/sda1"]], uuid);
2232 InitBasicFS, Always, TestOutput (
2233 [["set_e2uuid"; "/dev/sda1"; "clear"];
2234 ["get_e2uuid"; "/dev/sda1"]], "");
2235 (* We can't predict what UUIDs will be, so just check the commands run. *)
2236 InitBasicFS, Always, TestRun (
2237 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2238 InitBasicFS, Always, TestRun (
2239 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2240 "set the ext2/3/4 filesystem UUID",
2242 This sets the ext2/3/4 filesystem UUID of the filesystem on
2243 C<device> to C<uuid>. The format of the UUID and alternatives
2244 such as C<clear>, C<random> and C<time> are described in the
2245 L<tune2fs(8)> manpage.
2247 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2248 to return the existing UUID of a filesystem.");
2250 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2252 "get the ext2/3/4 filesystem UUID",
2254 This returns the ext2/3/4 filesystem UUID of the filesystem on
2257 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2258 [InitBasicFS, Always, TestOutputInt (
2259 [["umount"; "/dev/sda1"];
2260 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2261 InitBasicFS, Always, TestOutputInt (
2262 [["umount"; "/dev/sda1"];
2263 ["zero"; "/dev/sda1"];
2264 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2265 "run the filesystem checker",
2267 This runs the filesystem checker (fsck) on C<device> which
2268 should have filesystem type C<fstype>.
2270 The returned integer is the status. See L<fsck(8)> for the
2271 list of status codes from C<fsck>.
2279 Multiple status codes can be summed together.
2283 A non-zero return code can mean \"success\", for example if
2284 errors have been corrected on the filesystem.
2288 Checking or repairing NTFS volumes is not supported
2293 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2295 ("zero", (RErr, [Device "device"]), 85, [],
2296 [InitBasicFS, Always, TestOutput (
2297 [["umount"; "/dev/sda1"];
2298 ["zero"; "/dev/sda1"];
2299 ["file"; "/dev/sda1"]], "data")],
2300 "write zeroes to the device",
2302 This command writes zeroes over the first few blocks of C<device>.
2304 How many blocks are zeroed isn't specified (but it's I<not> enough
2305 to securely wipe the device). It should be sufficient to remove
2306 any partition tables, filesystem superblocks and so on.
2308 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2310 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2311 (* Test disabled because grub-install incompatible with virtio-blk driver.
2312 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2314 [InitBasicFS, Disabled, TestOutputTrue (
2315 [["grub_install"; "/"; "/dev/sda1"];
2316 ["is_dir"; "/boot"]])],
2319 This command installs GRUB (the Grand Unified Bootloader) on
2320 C<device>, with the root directory being C<root>.");
2322 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2323 [InitBasicFS, Always, TestOutput (
2324 [["write"; "/old"; "file content"];
2325 ["cp"; "/old"; "/new"];
2326 ["cat"; "/new"]], "file content");
2327 InitBasicFS, Always, TestOutputTrue (
2328 [["write"; "/old"; "file content"];
2329 ["cp"; "/old"; "/new"];
2330 ["is_file"; "/old"]]);
2331 InitBasicFS, Always, TestOutput (
2332 [["write"; "/old"; "file content"];
2334 ["cp"; "/old"; "/dir/new"];
2335 ["cat"; "/dir/new"]], "file content")],
2338 This copies a file from C<src> to C<dest> where C<dest> is
2339 either a destination filename or destination directory.");
2341 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2342 [InitBasicFS, Always, TestOutput (
2343 [["mkdir"; "/olddir"];
2344 ["mkdir"; "/newdir"];
2345 ["write"; "/olddir/file"; "file content"];
2346 ["cp_a"; "/olddir"; "/newdir"];
2347 ["cat"; "/newdir/olddir/file"]], "file content")],
2348 "copy a file or directory recursively",
2350 This copies a file or directory from C<src> to C<dest>
2351 recursively using the C<cp -a> command.");
2353 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2354 [InitBasicFS, Always, TestOutput (
2355 [["write"; "/old"; "file content"];
2356 ["mv"; "/old"; "/new"];
2357 ["cat"; "/new"]], "file content");
2358 InitBasicFS, Always, TestOutputFalse (
2359 [["write"; "/old"; "file content"];
2360 ["mv"; "/old"; "/new"];
2361 ["is_file"; "/old"]])],
2364 This moves a file from C<src> to C<dest> where C<dest> is
2365 either a destination filename or destination directory.");
2367 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2368 [InitEmpty, Always, TestRun (
2369 [["drop_caches"; "3"]])],
2370 "drop kernel page cache, dentries and inodes",
2372 This instructs the guest kernel to drop its page cache,
2373 and/or dentries and inode caches. The parameter C<whattodrop>
2374 tells the kernel what precisely to drop, see
2375 L<http://linux-mm.org/Drop_Caches>
2377 Setting C<whattodrop> to 3 should drop everything.
2379 This automatically calls L<sync(2)> before the operation,
2380 so that the maximum guest memory is freed.");
2382 ("dmesg", (RString "kmsgs", []), 91, [],
2383 [InitEmpty, Always, TestRun (
2385 "return kernel messages",
2387 This returns the kernel messages (C<dmesg> output) from
2388 the guest kernel. This is sometimes useful for extended
2389 debugging of problems.
2391 Another way to get the same information is to enable
2392 verbose messages with C<guestfs_set_verbose> or by setting
2393 the environment variable C<LIBGUESTFS_DEBUG=1> before
2394 running the program.");
2396 ("ping_daemon", (RErr, []), 92, [],
2397 [InitEmpty, Always, TestRun (
2398 [["ping_daemon"]])],
2399 "ping the guest daemon",
2401 This is a test probe into the guestfs daemon running inside
2402 the qemu subprocess. Calling this function checks that the
2403 daemon responds to the ping message, without affecting the daemon
2404 or attached block device(s) in any other way.");
2406 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2407 [InitBasicFS, Always, TestOutputTrue (
2408 [["write"; "/file1"; "contents of a file"];
2409 ["cp"; "/file1"; "/file2"];
2410 ["equal"; "/file1"; "/file2"]]);
2411 InitBasicFS, Always, TestOutputFalse (
2412 [["write"; "/file1"; "contents of a file"];
2413 ["write"; "/file2"; "contents of another file"];
2414 ["equal"; "/file1"; "/file2"]]);
2415 InitBasicFS, Always, TestLastFail (
2416 [["equal"; "/file1"; "/file2"]])],
2417 "test if two files have equal contents",
2419 This compares the two files C<file1> and C<file2> and returns
2420 true if their content is exactly equal, or false otherwise.
2422 The external L<cmp(1)> program is used for the comparison.");
2424 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2425 [InitISOFS, Always, TestOutputList (
2426 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2427 InitISOFS, Always, TestOutputList (
2428 [["strings"; "/empty"]], []);
2429 (* Test for RHBZ#579608, absolute symbolic links. *)
2430 InitISOFS, Always, TestRun (
2431 [["strings"; "/abssymlink"]])],
2432 "print the printable strings in a file",
2434 This runs the L<strings(1)> command on a file and returns
2435 the list of printable strings found.");
2437 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2438 [InitISOFS, Always, TestOutputList (
2439 [["strings_e"; "b"; "/known-5"]], []);
2440 InitBasicFS, Always, TestOutputList (
2441 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2442 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2443 "print the printable strings in a file",
2445 This is like the C<guestfs_strings> command, but allows you to
2446 specify the encoding of strings that are looked for in
2447 the source file C<path>.
2449 Allowed encodings are:
2455 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2456 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2460 Single 8-bit-byte characters.
2464 16-bit big endian strings such as those encoded in
2465 UTF-16BE or UCS-2BE.
2467 =item l (lower case letter L)
2469 16-bit little endian such as UTF-16LE and UCS-2LE.
2470 This is useful for examining binaries in Windows guests.
2474 32-bit big endian such as UCS-4BE.
2478 32-bit little endian such as UCS-4LE.
2482 The returned strings are transcoded to UTF-8.");
2484 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2485 [InitISOFS, Always, TestOutput (
2486 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2487 (* Test for RHBZ#501888c2 regression which caused large hexdump
2488 * commands to segfault.
2490 InitISOFS, Always, TestRun (
2491 [["hexdump"; "/100krandom"]]);
2492 (* Test for RHBZ#579608, absolute symbolic links. *)
2493 InitISOFS, Always, TestRun (
2494 [["hexdump"; "/abssymlink"]])],
2495 "dump a file in hexadecimal",
2497 This runs C<hexdump -C> on the given C<path>. The result is
2498 the human-readable, canonical hex dump of the file.");
2500 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2501 [InitNone, Always, TestOutput (
2502 [["part_disk"; "/dev/sda"; "mbr"];
2503 ["mkfs"; "ext3"; "/dev/sda1"];
2504 ["mount_options"; ""; "/dev/sda1"; "/"];
2505 ["write"; "/new"; "test file"];
2506 ["umount"; "/dev/sda1"];
2507 ["zerofree"; "/dev/sda1"];
2508 ["mount_options"; ""; "/dev/sda1"; "/"];
2509 ["cat"; "/new"]], "test file")],
2510 "zero unused inodes and disk blocks on ext2/3 filesystem",
2512 This runs the I<zerofree> program on C<device>. This program
2513 claims to zero unused inodes and disk blocks on an ext2/3
2514 filesystem, thus making it possible to compress the filesystem
2517 You should B<not> run this program if the filesystem is
2520 It is possible that using this program can damage the filesystem
2521 or data on the filesystem.");
2523 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2525 "resize an LVM physical volume",
2527 This resizes (expands or shrinks) an existing LVM physical
2528 volume to match the new size of the underlying device.");
2530 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2531 Int "cyls"; Int "heads"; Int "sectors";
2532 String "line"]), 99, [DangerWillRobinson],
2534 "modify a single partition on a block device",
2536 This runs L<sfdisk(8)> option to modify just the single
2537 partition C<n> (note: C<n> counts from 1).
2539 For other parameters, see C<guestfs_sfdisk>. You should usually
2540 pass C<0> for the cyls/heads/sectors parameters.
2542 See also: C<guestfs_part_add>");
2544 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2546 "display the partition table",
2548 This displays the partition table on C<device>, in the
2549 human-readable output of the L<sfdisk(8)> command. It is
2550 not intended to be parsed.
2552 See also: C<guestfs_part_list>");
2554 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2556 "display the kernel geometry",
2558 This displays the kernel's idea of the geometry of C<device>.
2560 The result is in human-readable format, and not designed to
2563 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2565 "display the disk geometry from the partition table",
2567 This displays the disk geometry of C<device> read from the
2568 partition table. Especially in the case where the underlying
2569 block device has been resized, this can be different from the
2570 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2572 The result is in human-readable format, and not designed to
2575 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2577 "activate or deactivate all volume groups",
2579 This command activates or (if C<activate> is false) deactivates
2580 all logical volumes in all volume groups.
2581 If activated, then they are made known to the
2582 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2583 then those devices disappear.
2585 This command is the same as running C<vgchange -a y|n>");
2587 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2589 "activate or deactivate some volume groups",
2591 This command activates or (if C<activate> is false) deactivates
2592 all logical volumes in the listed volume groups C<volgroups>.
2593 If activated, then they are made known to the
2594 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2595 then those devices disappear.
2597 This command is the same as running C<vgchange -a y|n volgroups...>
2599 Note that if C<volgroups> is an empty list then B<all> volume groups
2600 are activated or deactivated.");
2602 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2603 [InitNone, Always, TestOutput (
2604 [["part_disk"; "/dev/sda"; "mbr"];
2605 ["pvcreate"; "/dev/sda1"];
2606 ["vgcreate"; "VG"; "/dev/sda1"];
2607 ["lvcreate"; "LV"; "VG"; "10"];
2608 ["mkfs"; "ext2"; "/dev/VG/LV"];
2609 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2610 ["write"; "/new"; "test content"];
2612 ["lvresize"; "/dev/VG/LV"; "20"];
2613 ["e2fsck_f"; "/dev/VG/LV"];
2614 ["resize2fs"; "/dev/VG/LV"];
2615 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2616 ["cat"; "/new"]], "test content");
2617 InitNone, Always, TestRun (
2618 (* Make an LV smaller to test RHBZ#587484. *)
2619 [["part_disk"; "/dev/sda"; "mbr"];
2620 ["pvcreate"; "/dev/sda1"];
2621 ["vgcreate"; "VG"; "/dev/sda1"];
2622 ["lvcreate"; "LV"; "VG"; "20"];
2623 ["lvresize"; "/dev/VG/LV"; "10"]])],
2624 "resize an LVM logical volume",
2626 This resizes (expands or shrinks) an existing LVM logical
2627 volume to C<mbytes>. When reducing, data in the reduced part
2630 ("resize2fs", (RErr, [Device "device"]), 106, [],
2631 [], (* lvresize tests this *)
2632 "resize an ext2/ext3 filesystem",
2634 This resizes an ext2 or ext3 filesystem to match the size of
2635 the underlying device.
2637 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2638 on the C<device> before calling this command. For unknown reasons
2639 C<resize2fs> sometimes gives an error about this and sometimes not.
2640 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2641 calling this function.");
2643 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2644 [InitBasicFS, Always, TestOutputList (
2645 [["find"; "/"]], ["lost+found"]);
2646 InitBasicFS, Always, TestOutputList (
2650 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2651 InitBasicFS, Always, TestOutputList (
2652 [["mkdir_p"; "/a/b/c"];
2653 ["touch"; "/a/b/c/d"];
2654 ["find"; "/a/b/"]], ["c"; "c/d"])],
2655 "find all files and directories",
2657 This command lists out all files and directories, recursively,
2658 starting at C<directory>. It is essentially equivalent to
2659 running the shell command C<find directory -print> but some
2660 post-processing happens on the output, described below.
2662 This returns a list of strings I<without any prefix>. Thus
2663 if the directory structure was:
2669 then the returned list from C<guestfs_find> C</tmp> would be
2677 If C<directory> is not a directory, then this command returns
2680 The returned list is sorted.
2682 See also C<guestfs_find0>.");
2684 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2685 [], (* lvresize tests this *)
2686 "check an ext2/ext3 filesystem",
2688 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2689 filesystem checker on C<device>, noninteractively (C<-p>),
2690 even if the filesystem appears to be clean (C<-f>).
2692 This command is only needed because of C<guestfs_resize2fs>
2693 (q.v.). Normally you should use C<guestfs_fsck>.");
2695 ("sleep", (RErr, [Int "secs"]), 109, [],
2696 [InitNone, Always, TestRun (
2698 "sleep for some seconds",
2700 Sleep for C<secs> seconds.");
2702 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2703 [InitNone, Always, TestOutputInt (
2704 [["part_disk"; "/dev/sda"; "mbr"];
2705 ["mkfs"; "ntfs"; "/dev/sda1"];
2706 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2707 InitNone, Always, TestOutputInt (
2708 [["part_disk"; "/dev/sda"; "mbr"];
2709 ["mkfs"; "ext2"; "/dev/sda1"];
2710 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2711 "probe NTFS volume",
2713 This command runs the L<ntfs-3g.probe(8)> command which probes
2714 an NTFS C<device> for mountability. (Not all NTFS volumes can
2715 be mounted read-write, and some cannot be mounted at all).
2717 C<rw> is a boolean flag. Set it to true if you want to test
2718 if the volume can be mounted read-write. Set it to false if
2719 you want to test if the volume can be mounted read-only.
2721 The return value is an integer which C<0> if the operation
2722 would succeed, or some non-zero value documented in the
2723 L<ntfs-3g.probe(8)> manual page.");
2725 ("sh", (RString "output", [String "command"]), 111, [],
2726 [], (* XXX needs tests *)
2727 "run a command via the shell",
2729 This call runs a command from the guest filesystem via the
2732 This is like C<guestfs_command>, but passes the command to:
2734 /bin/sh -c \"command\"
2736 Depending on the guest's shell, this usually results in
2737 wildcards being expanded, shell expressions being interpolated
2740 All the provisos about C<guestfs_command> apply to this call.");
2742 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2743 [], (* XXX needs tests *)
2744 "run a command via the shell returning lines",
2746 This is the same as C<guestfs_sh>, but splits the result
2747 into a list of lines.
2749 See also: C<guestfs_command_lines>");
2751 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2752 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2753 * code in stubs.c, since all valid glob patterns must start with "/".
2754 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2756 [InitBasicFS, Always, TestOutputList (
2757 [["mkdir_p"; "/a/b/c"];
2758 ["touch"; "/a/b/c/d"];
2759 ["touch"; "/a/b/c/e"];
2760 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2761 InitBasicFS, Always, TestOutputList (
2762 [["mkdir_p"; "/a/b/c"];
2763 ["touch"; "/a/b/c/d"];
2764 ["touch"; "/a/b/c/e"];
2765 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2766 InitBasicFS, Always, TestOutputList (
2767 [["mkdir_p"; "/a/b/c"];
2768 ["touch"; "/a/b/c/d"];
2769 ["touch"; "/a/b/c/e"];
2770 ["glob_expand"; "/a/*/x/*"]], [])],
2771 "expand a wildcard path",
2773 This command searches for all the pathnames matching
2774 C<pattern> according to the wildcard expansion rules
2777 If no paths match, then this returns an empty list
2778 (note: not an error).
2780 It is just a wrapper around the C L<glob(3)> function
2781 with flags C<GLOB_MARK|GLOB_BRACE>.
2782 See that manual page for more details.");
2784 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2785 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2786 [["scrub_device"; "/dev/sdc"]])],
2787 "scrub (securely wipe) a device",
2789 This command writes patterns over C<device> to make data retrieval
2792 It is an interface to the L<scrub(1)> program. See that
2793 manual page for more details.");
2795 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2796 [InitBasicFS, Always, TestRun (
2797 [["write"; "/file"; "content"];
2798 ["scrub_file"; "/file"]])],
2799 "scrub (securely wipe) a file",
2801 This command writes patterns over a file to make data retrieval
2804 The file is I<removed> after scrubbing.
2806 It is an interface to the L<scrub(1)> program. See that
2807 manual page for more details.");
2809 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2810 [], (* XXX needs testing *)
2811 "scrub (securely wipe) free space",
2813 This command creates the directory C<dir> and then fills it
2814 with files until the filesystem is full, and scrubs the files
2815 as for C<guestfs_scrub_file>, and deletes them.
2816 The intention is to scrub any free space on the partition
2819 It is an interface to the L<scrub(1)> program. See that
2820 manual page for more details.");
2822 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2823 [InitBasicFS, Always, TestRun (
2825 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2826 "create a temporary directory",
2828 This command creates a temporary directory. The
2829 C<template> parameter should be a full pathname for the
2830 temporary directory name with the final six characters being
2833 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2834 the second one being suitable for Windows filesystems.
2836 The name of the temporary directory that was created
2839 The temporary directory is created with mode 0700
2840 and is owned by root.
2842 The caller is responsible for deleting the temporary
2843 directory and its contents after use.
2845 See also: L<mkdtemp(3)>");
2847 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2848 [InitISOFS, Always, TestOutputInt (
2849 [["wc_l"; "/10klines"]], 10000);
2850 (* Test for RHBZ#579608, absolute symbolic links. *)
2851 InitISOFS, Always, TestOutputInt (
2852 [["wc_l"; "/abssymlink"]], 10000)],
2853 "count lines in a file",
2855 This command counts the lines in a file, using the
2856 C<wc -l> external command.");
2858 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2859 [InitISOFS, Always, TestOutputInt (
2860 [["wc_w"; "/10klines"]], 10000)],
2861 "count words in a file",
2863 This command counts the words in a file, using the
2864 C<wc -w> external command.");
2866 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2867 [InitISOFS, Always, TestOutputInt (
2868 [["wc_c"; "/100kallspaces"]], 102400)],
2869 "count characters in a file",
2871 This command counts the characters in a file, using the
2872 C<wc -c> external command.");
2874 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2875 [InitISOFS, Always, TestOutputList (
2876 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2877 (* Test for RHBZ#579608, absolute symbolic links. *)
2878 InitISOFS, Always, TestOutputList (
2879 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2880 "return first 10 lines of a file",
2882 This command returns up to the first 10 lines of a file as
2883 a list of strings.");
2885 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2886 [InitISOFS, Always, TestOutputList (
2887 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2888 InitISOFS, Always, TestOutputList (
2889 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2890 InitISOFS, Always, TestOutputList (
2891 [["head_n"; "0"; "/10klines"]], [])],
2892 "return first N lines of a file",
2894 If the parameter C<nrlines> is a positive number, this returns the first
2895 C<nrlines> lines of the file C<path>.
2897 If the parameter C<nrlines> is a negative number, this returns lines
2898 from the file C<path>, excluding the last C<nrlines> lines.
2900 If the parameter C<nrlines> is zero, this returns an empty list.");
2902 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2903 [InitISOFS, Always, TestOutputList (
2904 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2905 "return last 10 lines of a file",
2907 This command returns up to the last 10 lines of a file as
2908 a list of strings.");
2910 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2911 [InitISOFS, Always, TestOutputList (
2912 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2913 InitISOFS, Always, TestOutputList (
2914 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2915 InitISOFS, Always, TestOutputList (
2916 [["tail_n"; "0"; "/10klines"]], [])],
2917 "return last N lines of a file",
2919 If the parameter C<nrlines> is a positive number, this returns the last
2920 C<nrlines> lines of the file C<path>.
2922 If the parameter C<nrlines> is a negative number, this returns lines
2923 from the file C<path>, starting with the C<-nrlines>th line.
2925 If the parameter C<nrlines> is zero, this returns an empty list.");
2927 ("df", (RString "output", []), 125, [],
2928 [], (* XXX Tricky to test because it depends on the exact format
2929 * of the 'df' command and other imponderables.
2931 "report file system disk space usage",
2933 This command runs the C<df> command to report disk space used.
2935 This command is mostly useful for interactive sessions. It
2936 is I<not> intended that you try to parse the output string.
2937 Use C<statvfs> from programs.");
2939 ("df_h", (RString "output", []), 126, [],
2940 [], (* XXX Tricky to test because it depends on the exact format
2941 * of the 'df' command and other imponderables.
2943 "report file system disk space usage (human readable)",
2945 This command runs the C<df -h> command to report disk space used
2946 in human-readable format.
2948 This command is mostly useful for interactive sessions. It
2949 is I<not> intended that you try to parse the output string.
2950 Use C<statvfs> from programs.");
2952 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2953 [InitISOFS, Always, TestOutputInt (
2954 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2955 "estimate file space usage",
2957 This command runs the C<du -s> command to estimate file space
2960 C<path> can be a file or a directory. If C<path> is a directory
2961 then the estimate includes the contents of the directory and all
2962 subdirectories (recursively).
2964 The result is the estimated size in I<kilobytes>
2965 (ie. units of 1024 bytes).");
2967 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2968 [InitISOFS, Always, TestOutputList (
2969 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2970 "list files in an initrd",
2972 This command lists out files contained in an initrd.
2974 The files are listed without any initial C</> character. The
2975 files are listed in the order they appear (not necessarily
2976 alphabetical). Directory names are listed as separate items.
2978 Old Linux kernels (2.4 and earlier) used a compressed ext2
2979 filesystem as initrd. We I<only> support the newer initramfs
2980 format (compressed cpio files).");
2982 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2984 "mount a file using the loop device",
2986 This command lets you mount C<file> (a filesystem image
2987 in a file) on a mount point. It is entirely equivalent to
2988 the command C<mount -o loop file mountpoint>.");
2990 ("mkswap", (RErr, [Device "device"]), 130, [],
2991 [InitEmpty, Always, TestRun (
2992 [["part_disk"; "/dev/sda"; "mbr"];
2993 ["mkswap"; "/dev/sda1"]])],
2994 "create a swap partition",
2996 Create a swap partition on C<device>.");
2998 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2999 [InitEmpty, Always, TestRun (
3000 [["part_disk"; "/dev/sda"; "mbr"];
3001 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3002 "create a swap partition with a label",
3004 Create a swap partition on C<device> with label C<label>.
3006 Note that you cannot attach a swap label to a block device
3007 (eg. C</dev/sda>), just to a partition. This appears to be
3008 a limitation of the kernel or swap tools.");
3010 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3011 (let uuid = uuidgen () in
3012 [InitEmpty, Always, TestRun (
3013 [["part_disk"; "/dev/sda"; "mbr"];
3014 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3015 "create a swap partition with an explicit UUID",
3017 Create a swap partition on C<device> with UUID C<uuid>.");
3019 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3020 [InitBasicFS, Always, TestOutputStruct (
3021 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3022 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3023 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3024 InitBasicFS, Always, TestOutputStruct (
3025 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3026 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3027 "make block, character or FIFO devices",
3029 This call creates block or character special devices, or
3030 named pipes (FIFOs).
3032 The C<mode> parameter should be the mode, using the standard
3033 constants. C<devmajor> and C<devminor> are the
3034 device major and minor numbers, only used when creating block
3035 and character special devices.
3037 Note that, just like L<mknod(2)>, the mode must be bitwise
3038 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3039 just creates a regular file). These constants are
3040 available in the standard Linux header files, or you can use
3041 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3042 which are wrappers around this command which bitwise OR
3043 in the appropriate constant for you.
3045 The mode actually set is affected by the umask.");
3047 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3048 [InitBasicFS, Always, TestOutputStruct (
3049 [["mkfifo"; "0o777"; "/node"];
3050 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3051 "make FIFO (named pipe)",
3053 This call creates a FIFO (named pipe) called C<path> with
3054 mode C<mode>. It is just a convenient wrapper around
3057 The mode actually set is affected by the umask.");
3059 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3060 [InitBasicFS, Always, TestOutputStruct (
3061 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3062 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3063 "make block device node",
3065 This call creates a block device node called C<path> with
3066 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3067 It is just a convenient wrapper around C<guestfs_mknod>.
3069 The mode actually set is affected by the umask.");
3071 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3072 [InitBasicFS, Always, TestOutputStruct (
3073 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3074 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3075 "make char device node",
3077 This call creates a char device node called C<path> with
3078 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3079 It is just a convenient wrapper around C<guestfs_mknod>.
3081 The mode actually set is affected by the umask.");
3083 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3084 [InitEmpty, Always, TestOutputInt (
3085 [["umask"; "0o22"]], 0o22)],
3086 "set file mode creation mask (umask)",
3088 This function sets the mask used for creating new files and
3089 device nodes to C<mask & 0777>.
3091 Typical umask values would be C<022> which creates new files
3092 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3093 C<002> which creates new files with permissions like
3094 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3096 The default umask is C<022>. This is important because it
3097 means that directories and device nodes will be created with
3098 C<0644> or C<0755> mode even if you specify C<0777>.
3100 See also C<guestfs_get_umask>,
3101 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3103 This call returns the previous umask.");
3105 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3107 "read directories entries",
3109 This returns the list of directory entries in directory C<dir>.
3111 All entries in the directory are returned, including C<.> and
3112 C<..>. The entries are I<not> sorted, but returned in the same
3113 order as the underlying filesystem.
3115 Also this call returns basic file type information about each
3116 file. The C<ftyp> field will contain one of the following characters:
3154 The L<readdir(3)> returned a C<d_type> field with an
3159 This function is primarily intended for use by programs. To
3160 get a simple list of names, use C<guestfs_ls>. To get a printable
3161 directory for human consumption, use C<guestfs_ll>.");
3163 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3165 "create partitions on a block device",
3167 This is a simplified interface to the C<guestfs_sfdisk>
3168 command, where partition sizes are specified in megabytes
3169 only (rounded to the nearest cylinder) and you don't need
3170 to specify the cyls, heads and sectors parameters which
3171 were rarely if ever used anyway.
3173 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3174 and C<guestfs_part_disk>");
3176 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3178 "determine file type inside a compressed file",
3180 This command runs C<file> after first decompressing C<path>
3183 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3185 Since 1.0.63, use C<guestfs_file> instead which can now
3186 process compressed files.");
3188 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3190 "list extended attributes of a file or directory",
3192 This call lists the extended attributes of the file or directory
3195 At the system call level, this is a combination of the
3196 L<listxattr(2)> and L<getxattr(2)> calls.
3198 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3200 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3202 "list extended attributes of a file or directory",
3204 This is the same as C<guestfs_getxattrs>, but if C<path>
3205 is a symbolic link, then it returns the extended attributes
3206 of the link itself.");
3208 ("setxattr", (RErr, [String "xattr";
3209 String "val"; Int "vallen"; (* will be BufferIn *)
3210 Pathname "path"]), 143, [Optional "linuxxattrs"],
3212 "set extended attribute of a file or directory",
3214 This call sets the extended attribute named C<xattr>
3215 of the file C<path> to the value C<val> (of length C<vallen>).
3216 The value is arbitrary 8 bit data.
3218 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3220 ("lsetxattr", (RErr, [String "xattr";
3221 String "val"; Int "vallen"; (* will be BufferIn *)
3222 Pathname "path"]), 144, [Optional "linuxxattrs"],
3224 "set extended attribute of a file or directory",
3226 This is the same as C<guestfs_setxattr>, but if C<path>
3227 is a symbolic link, then it sets an extended attribute
3228 of the link itself.");
3230 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3232 "remove extended attribute of a file or directory",
3234 This call removes the extended attribute named C<xattr>
3235 of the file C<path>.
3237 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3239 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3241 "remove extended attribute of a file or directory",
3243 This is the same as C<guestfs_removexattr>, but if C<path>
3244 is a symbolic link, then it removes an extended attribute
3245 of the link itself.");
3247 ("mountpoints", (RHashtable "mps", []), 147, [],
3251 This call is similar to C<guestfs_mounts>. That call returns
3252 a list of devices. This one returns a hash table (map) of
3253 device name to directory where the device is mounted.");
3255 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3256 (* This is a special case: while you would expect a parameter
3257 * of type "Pathname", that doesn't work, because it implies
3258 * NEED_ROOT in the generated calling code in stubs.c, and
3259 * this function cannot use NEED_ROOT.
3262 "create a mountpoint",
3264 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3265 specialized calls that can be used to create extra mountpoints
3266 before mounting the first filesystem.
3268 These calls are I<only> necessary in some very limited circumstances,
3269 mainly the case where you want to mount a mix of unrelated and/or
3270 read-only filesystems together.
3272 For example, live CDs often contain a \"Russian doll\" nest of
3273 filesystems, an ISO outer layer, with a squashfs image inside, with
3274 an ext2/3 image inside that. You can unpack this as follows
3277 add-ro Fedora-11-i686-Live.iso
3280 mkmountpoint /squash
3283 mount-loop /cd/LiveOS/squashfs.img /squash
3284 mount-loop /squash/LiveOS/ext3fs.img /ext3
3286 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3288 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3290 "remove a mountpoint",
3292 This calls removes a mountpoint that was previously created
3293 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3294 for full details.");
3296 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3297 [InitISOFS, Always, TestOutputBuffer (
3298 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3299 (* Test various near large, large and too large files (RHBZ#589039). *)
3300 InitBasicFS, Always, TestLastFail (
3302 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3303 ["read_file"; "/a"]]);
3304 InitBasicFS, Always, TestLastFail (
3306 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3307 ["read_file"; "/a"]]);
3308 InitBasicFS, Always, TestLastFail (
3310 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3311 ["read_file"; "/a"]])],
3314 This calls returns the contents of the file C<path> as a
3317 Unlike C<guestfs_cat>, this function can correctly
3318 handle files that contain embedded ASCII NUL characters.
3319 However unlike C<guestfs_download>, this function is limited
3320 in the total size of file that can be handled.");
3322 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3323 [InitISOFS, Always, TestOutputList (
3324 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3325 InitISOFS, Always, TestOutputList (
3326 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3327 (* Test for RHBZ#579608, absolute symbolic links. *)
3328 InitISOFS, Always, TestOutputList (
3329 [["grep"; "nomatch"; "/abssymlink"]], [])],
3330 "return lines matching a pattern",
3332 This calls the external C<grep> program and returns the
3335 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3336 [InitISOFS, Always, TestOutputList (
3337 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3338 "return lines matching a pattern",
3340 This calls the external C<egrep> program and returns the
3343 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3344 [InitISOFS, Always, TestOutputList (
3345 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3346 "return lines matching a pattern",
3348 This calls the external C<fgrep> program and returns the
3351 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3352 [InitISOFS, Always, TestOutputList (
3353 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3354 "return lines matching a pattern",
3356 This calls the external C<grep -i> program and returns the
3359 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3360 [InitISOFS, Always, TestOutputList (
3361 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3362 "return lines matching a pattern",
3364 This calls the external C<egrep -i> program and returns the
3367 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3368 [InitISOFS, Always, TestOutputList (
3369 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3370 "return lines matching a pattern",
3372 This calls the external C<fgrep -i> program and returns the
3375 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3376 [InitISOFS, Always, TestOutputList (
3377 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3378 "return lines matching a pattern",
3380 This calls the external C<zgrep> program and returns the
3383 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3384 [InitISOFS, Always, TestOutputList (
3385 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3386 "return lines matching a pattern",
3388 This calls the external C<zegrep> program and returns the
3391 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3392 [InitISOFS, Always, TestOutputList (
3393 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3394 "return lines matching a pattern",
3396 This calls the external C<zfgrep> program and returns the
3399 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3400 [InitISOFS, Always, TestOutputList (
3401 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3402 "return lines matching a pattern",
3404 This calls the external C<zgrep -i> program and returns the
3407 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3408 [InitISOFS, Always, TestOutputList (
3409 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3410 "return lines matching a pattern",
3412 This calls the external C<zegrep -i> program and returns the
3415 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3416 [InitISOFS, Always, TestOutputList (
3417 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3418 "return lines matching a pattern",
3420 This calls the external C<zfgrep -i> program and returns the
3423 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3424 [InitISOFS, Always, TestOutput (
3425 [["realpath"; "/../directory"]], "/directory")],
3426 "canonicalized absolute pathname",
3428 Return the canonicalized absolute pathname of C<path>. The
3429 returned path has no C<.>, C<..> or symbolic link path elements.");
3431 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3432 [InitBasicFS, Always, TestOutputStruct (
3435 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3436 "create a hard link",
3438 This command creates a hard link using the C<ln> command.");
3440 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3441 [InitBasicFS, Always, TestOutputStruct (
3444 ["ln_f"; "/a"; "/b"];
3445 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3446 "create a hard link",
3448 This command creates a hard link using the C<ln -f> command.
3449 The C<-f> option removes the link (C<linkname>) if it exists already.");
3451 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3452 [InitBasicFS, Always, TestOutputStruct (
3454 ["ln_s"; "a"; "/b"];
3455 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3456 "create a symbolic link",
3458 This command creates a symbolic link using the C<ln -s> command.");
3460 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3461 [InitBasicFS, Always, TestOutput (
3462 [["mkdir_p"; "/a/b"];
3463 ["touch"; "/a/b/c"];
3464 ["ln_sf"; "../d"; "/a/b/c"];
3465 ["readlink"; "/a/b/c"]], "../d")],
3466 "create a symbolic link",
3468 This command creates a symbolic link using the C<ln -sf> command,
3469 The C<-f> option removes the link (C<linkname>) if it exists already.");
3471 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3472 [] (* XXX tested above *),
3473 "read the target of a symbolic link",
3475 This command reads the target of a symbolic link.");
3477 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3478 [InitBasicFS, Always, TestOutputStruct (
3479 [["fallocate"; "/a"; "1000000"];
3480 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3481 "preallocate a file in the guest filesystem",
3483 This command preallocates a file (containing zero bytes) named
3484 C<path> of size C<len> bytes. If the file exists already, it
3487 Do not confuse this with the guestfish-specific
3488 C<alloc> command which allocates a file in the host and
3489 attaches it as a device.");
3491 ("swapon_device", (RErr, [Device "device"]), 170, [],
3492 [InitPartition, Always, TestRun (
3493 [["mkswap"; "/dev/sda1"];
3494 ["swapon_device"; "/dev/sda1"];
3495 ["swapoff_device"; "/dev/sda1"]])],
3496 "enable swap on device",
3498 This command enables the libguestfs appliance to use the
3499 swap device or partition named C<device>. The increased
3500 memory is made available for all commands, for example
3501 those run using C<guestfs_command> or C<guestfs_sh>.
3503 Note that you should not swap to existing guest swap
3504 partitions unless you know what you are doing. They may
3505 contain hibernation information, or other information that
3506 the guest doesn't want you to trash. You also risk leaking
3507 information about the host to the guest this way. Instead,
3508 attach a new host device to the guest and swap on that.");
3510 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3511 [], (* XXX tested by swapon_device *)
3512 "disable swap on device",
3514 This command disables the libguestfs appliance swap
3515 device or partition named C<device>.
3516 See C<guestfs_swapon_device>.");
3518 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3519 [InitBasicFS, Always, TestRun (
3520 [["fallocate"; "/swap"; "8388608"];
3521 ["mkswap_file"; "/swap"];
3522 ["swapon_file"; "/swap"];
3523 ["swapoff_file"; "/swap"]])],
3524 "enable swap on file",
3526 This command enables swap to a file.
3527 See C<guestfs_swapon_device> for other notes.");
3529 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3530 [], (* XXX tested by swapon_file *)
3531 "disable swap on file",
3533 This command disables the libguestfs appliance swap on file.");
3535 ("swapon_label", (RErr, [String "label"]), 174, [],
3536 [InitEmpty, Always, TestRun (
3537 [["part_disk"; "/dev/sdb"; "mbr"];
3538 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3539 ["swapon_label"; "swapit"];
3540 ["swapoff_label"; "swapit"];
3541 ["zero"; "/dev/sdb"];
3542 ["blockdev_rereadpt"; "/dev/sdb"]])],
3543 "enable swap on labeled swap partition",
3545 This command enables swap to a labeled swap partition.
3546 See C<guestfs_swapon_device> for other notes.");
3548 ("swapoff_label", (RErr, [String "label"]), 175, [],
3549 [], (* XXX tested by swapon_label *)
3550 "disable swap on labeled swap partition",
3552 This command disables the libguestfs appliance swap on
3553 labeled swap partition.");
3555 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3556 (let uuid = uuidgen () in
3557 [InitEmpty, Always, TestRun (
3558 [["mkswap_U"; uuid; "/dev/sdb"];
3559 ["swapon_uuid"; uuid];
3560 ["swapoff_uuid"; uuid]])]),
3561 "enable swap on swap partition by UUID",
3563 This command enables swap to a swap partition with the given UUID.
3564 See C<guestfs_swapon_device> for other notes.");
3566 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3567 [], (* XXX tested by swapon_uuid *)
3568 "disable swap on swap partition by UUID",
3570 This command disables the libguestfs appliance swap partition
3571 with the given UUID.");
3573 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3574 [InitBasicFS, Always, TestRun (
3575 [["fallocate"; "/swap"; "8388608"];
3576 ["mkswap_file"; "/swap"]])],
3577 "create a swap file",
3581 This command just writes a swap file signature to an existing
3582 file. To create the file itself, use something like C<guestfs_fallocate>.");
3584 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3585 [InitISOFS, Always, TestRun (
3586 [["inotify_init"; "0"]])],
3587 "create an inotify handle",
3589 This command creates a new inotify handle.
3590 The inotify subsystem can be used to notify events which happen to
3591 objects in the guest filesystem.
3593 C<maxevents> is the maximum number of events which will be
3594 queued up between calls to C<guestfs_inotify_read> or
3595 C<guestfs_inotify_files>.
3596 If this is passed as C<0>, then the kernel (or previously set)
3597 default is used. For Linux 2.6.29 the default was 16384 events.
3598 Beyond this limit, the kernel throws away events, but records
3599 the fact that it threw them away by setting a flag
3600 C<IN_Q_OVERFLOW> in the returned structure list (see
3601 C<guestfs_inotify_read>).
3603 Before any events are generated, you have to add some
3604 watches to the internal watch list. See:
3605 C<guestfs_inotify_add_watch>,
3606 C<guestfs_inotify_rm_watch> and
3607 C<guestfs_inotify_watch_all>.
3609 Queued up events should be read periodically by calling
3610 C<guestfs_inotify_read>
3611 (or C<guestfs_inotify_files> which is just a helpful
3612 wrapper around C<guestfs_inotify_read>). If you don't
3613 read the events out often enough then you risk the internal
3616 The handle should be closed after use by calling
3617 C<guestfs_inotify_close>. This also removes any
3618 watches automatically.
3620 See also L<inotify(7)> for an overview of the inotify interface
3621 as exposed by the Linux kernel, which is roughly what we expose
3622 via libguestfs. Note that there is one global inotify handle
3623 per libguestfs instance.");
3625 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3626 [InitBasicFS, Always, TestOutputList (
3627 [["inotify_init"; "0"];
3628 ["inotify_add_watch"; "/"; "1073741823"];
3631 ["inotify_files"]], ["a"; "b"])],
3632 "add an inotify watch",
3634 Watch C<path> for the events listed in C<mask>.
3636 Note that if C<path> is a directory then events within that
3637 directory are watched, but this does I<not> happen recursively
3638 (in subdirectories).
3640 Note for non-C or non-Linux callers: the inotify events are
3641 defined by the Linux kernel ABI and are listed in
3642 C</usr/include/sys/inotify.h>.");
3644 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3646 "remove an inotify watch",
3648 Remove a previously defined inotify watch.
3649 See C<guestfs_inotify_add_watch>.");
3651 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3653 "return list of inotify events",
3655 Return the complete queue of events that have happened
3656 since the previous read call.
3658 If no events have happened, this returns an empty list.
3660 I<Note>: In order to make sure that all events have been
3661 read, you must call this function repeatedly until it
3662 returns an empty list. The reason is that the call will
3663 read events up to the maximum appliance-to-host message
3664 size and leave remaining events in the queue.");
3666 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3668 "return list of watched files that had events",
3670 This function is a helpful wrapper around C<guestfs_inotify_read>
3671 which just returns a list of pathnames of objects that were
3672 touched. The returned pathnames are sorted and deduplicated.");
3674 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3676 "close the inotify handle",
3678 This closes the inotify handle which was previously
3679 opened by inotify_init. It removes all watches, throws
3680 away any pending events, and deallocates all resources.");
3682 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3684 "set SELinux security context",
3686 This sets the SELinux security context of the daemon
3687 to the string C<context>.
3689 See the documentation about SELINUX in L<guestfs(3)>.");
3691 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3693 "get SELinux security context",
3695 This gets the SELinux security context of the daemon.
3697 See the documentation about SELINUX in L<guestfs(3)>,
3698 and C<guestfs_setcon>");
3700 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3701 [InitEmpty, Always, TestOutput (
3702 [["part_disk"; "/dev/sda"; "mbr"];
3703 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3704 ["mount_options"; ""; "/dev/sda1"; "/"];
3705 ["write"; "/new"; "new file contents"];
3706 ["cat"; "/new"]], "new file contents")],
3707 "make a filesystem with block size",
3709 This call is similar to C<guestfs_mkfs>, but it allows you to
3710 control the block size of the resulting filesystem. Supported
3711 block sizes depend on the filesystem type, but typically they
3712 are C<1024>, C<2048> or C<4096> only.");
3714 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3715 [InitEmpty, Always, TestOutput (
3716 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3717 ["mke2journal"; "4096"; "/dev/sda1"];
3718 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3719 ["mount_options"; ""; "/dev/sda2"; "/"];
3720 ["write"; "/new"; "new file contents"];
3721 ["cat"; "/new"]], "new file contents")],
3722 "make ext2/3/4 external journal",
3724 This creates an ext2 external journal on C<device>. It is equivalent
3727 mke2fs -O journal_dev -b blocksize device");
3729 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3730 [InitEmpty, Always, TestOutput (
3731 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3732 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3733 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3734 ["mount_options"; ""; "/dev/sda2"; "/"];
3735 ["write"; "/new"; "new file contents"];
3736 ["cat"; "/new"]], "new file contents")],
3737 "make ext2/3/4 external journal with label",
3739 This creates an ext2 external journal on C<device> with label C<label>.");
3741 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3742 (let uuid = uuidgen () in
3743 [InitEmpty, Always, TestOutput (
3744 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3745 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3746 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3747 ["mount_options"; ""; "/dev/sda2"; "/"];
3748 ["write"; "/new"; "new file contents"];
3749 ["cat"; "/new"]], "new file contents")]),
3750 "make ext2/3/4 external journal with UUID",
3752 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3754 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3756 "make ext2/3/4 filesystem with external journal",
3758 This creates an ext2/3/4 filesystem on C<device> with
3759 an external journal on C<journal>. It is equivalent
3762 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3764 See also C<guestfs_mke2journal>.");
3766 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3768 "make ext2/3/4 filesystem with external journal",
3770 This creates an ext2/3/4 filesystem on C<device> with
3771 an external journal on the journal labeled C<label>.
3773 See also C<guestfs_mke2journal_L>.");
3775 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3777 "make ext2/3/4 filesystem with external journal",
3779 This creates an ext2/3/4 filesystem on C<device> with
3780 an external journal on the journal with UUID C<uuid>.
3782 See also C<guestfs_mke2journal_U>.");
3784 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3785 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3786 "load a kernel module",
3788 This loads a kernel module in the appliance.
3790 The kernel module must have been whitelisted when libguestfs
3791 was built (see C<appliance/kmod.whitelist.in> in the source).");
3793 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3794 [InitNone, Always, TestOutput (
3795 [["echo_daemon"; "This is a test"]], "This is a test"
3797 "echo arguments back to the client",
3799 This command concatenate the list of C<words> passed with single spaces between
3800 them and returns the resulting string.
3802 You can use this command to test the connection through to the daemon.
3804 See also C<guestfs_ping_daemon>.");
3806 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3807 [], (* There is a regression test for this. *)
3808 "find all files and directories, returning NUL-separated list",
3810 This command lists out all files and directories, recursively,
3811 starting at C<directory>, placing the resulting list in the
3812 external file called C<files>.
3814 This command works the same way as C<guestfs_find> with the
3815 following exceptions:
3821 The resulting list is written to an external file.
3825 Items (filenames) in the result are separated
3826 by C<\\0> characters. See L<find(1)> option I<-print0>.
3830 This command is not limited in the number of names that it
3835 The result list is not sorted.
3839 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3840 [InitISOFS, Always, TestOutput (
3841 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3842 InitISOFS, Always, TestOutput (
3843 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3844 InitISOFS, Always, TestOutput (
3845 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3846 InitISOFS, Always, TestLastFail (
3847 [["case_sensitive_path"; "/Known-1/"]]);
3848 InitBasicFS, Always, TestOutput (
3850 ["mkdir"; "/a/bbb"];
3851 ["touch"; "/a/bbb/c"];
3852 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3853 InitBasicFS, Always, TestOutput (
3855 ["mkdir"; "/a/bbb"];
3856 ["touch"; "/a/bbb/c"];
3857 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3858 InitBasicFS, Always, TestLastFail (
3860 ["mkdir"; "/a/bbb"];
3861 ["touch"; "/a/bbb/c"];
3862 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3863 "return true path on case-insensitive filesystem",
3865 This can be used to resolve case insensitive paths on
3866 a filesystem which is case sensitive. The use case is
3867 to resolve paths which you have read from Windows configuration
3868 files or the Windows Registry, to the true path.
3870 The command handles a peculiarity of the Linux ntfs-3g
3871 filesystem driver (and probably others), which is that although
3872 the underlying filesystem is case-insensitive, the driver
3873 exports the filesystem to Linux as case-sensitive.
3875 One consequence of this is that special directories such
3876 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3877 (or other things) depending on the precise details of how
3878 they were created. In Windows itself this would not be
3881 Bug or feature? You decide:
3882 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3884 This function resolves the true case of each element in the
3885 path and returns the case-sensitive path.
3887 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3888 might return C<\"/WINDOWS/system32\"> (the exact return value
3889 would depend on details of how the directories were originally
3890 created under Windows).
3893 This function does not handle drive names, backslashes etc.
3895 See also C<guestfs_realpath>.");
3897 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3898 [InitBasicFS, Always, TestOutput (
3899 [["vfs_type"; "/dev/sda1"]], "ext2")],
3900 "get the Linux VFS type corresponding to a mounted device",
3902 This command gets the block device type corresponding to
3903 a mounted device called C<device>.
3905 Usually the result is the name of the Linux VFS module that
3906 is used to mount this device (probably determined automatically
3907 if you used the C<guestfs_mount> call).");
3909 ("truncate", (RErr, [Pathname "path"]), 199, [],
3910 [InitBasicFS, Always, TestOutputStruct (
3911 [["write"; "/test"; "some stuff so size is not zero"];
3912 ["truncate"; "/test"];
3913 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3914 "truncate a file to zero size",
3916 This command truncates C<path> to a zero-length file. The
3917 file must exist already.");
3919 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3920 [InitBasicFS, Always, TestOutputStruct (
3921 [["touch"; "/test"];
3922 ["truncate_size"; "/test"; "1000"];
3923 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3924 "truncate a file to a particular size",
3926 This command truncates C<path> to size C<size> bytes. The file
3927 must exist already. If the file is smaller than C<size> then
3928 the file is extended to the required size with null bytes.");
3930 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3931 [InitBasicFS, Always, TestOutputStruct (
3932 [["touch"; "/test"];
3933 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3934 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3935 "set timestamp of a file with nanosecond precision",
3937 This command sets the timestamps of a file with nanosecond
3940 C<atsecs, atnsecs> are the last access time (atime) in secs and
3941 nanoseconds from the epoch.
3943 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3944 secs and nanoseconds from the epoch.
3946 If the C<*nsecs> field contains the special value C<-1> then
3947 the corresponding timestamp is set to the current time. (The
3948 C<*secs> field is ignored in this case).
3950 If the C<*nsecs> field contains the special value C<-2> then
3951 the corresponding timestamp is left unchanged. (The
3952 C<*secs> field is ignored in this case).");
3954 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3955 [InitBasicFS, Always, TestOutputStruct (
3956 [["mkdir_mode"; "/test"; "0o111"];
3957 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3958 "create a directory with a particular mode",
3960 This command creates a directory, setting the initial permissions
3961 of the directory to C<mode>.
3963 For common Linux filesystems, the actual mode which is set will
3964 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
3965 interpret the mode in other ways.
3967 See also C<guestfs_mkdir>, C<guestfs_umask>");
3969 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3971 "change file owner and group",
3973 Change the file owner to C<owner> and group to C<group>.
3974 This is like C<guestfs_chown> but if C<path> is a symlink then
3975 the link itself is changed, not the target.
3977 Only numeric uid and gid are supported. If you want to use
3978 names, you will need to locate and parse the password file
3979 yourself (Augeas support makes this relatively easy).");
3981 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3983 "lstat on multiple files",
3985 This call allows you to perform the C<guestfs_lstat> operation
3986 on multiple files, where all files are in the directory C<path>.
3987 C<names> is the list of files from this directory.
3989 On return you get a list of stat structs, with a one-to-one
3990 correspondence to the C<names> list. If any name did not exist
3991 or could not be lstat'd, then the C<ino> field of that structure
3994 This call is intended for programs that want to efficiently
3995 list a directory contents without making many round-trips.
3996 See also C<guestfs_lxattrlist> for a similarly efficient call
3997 for getting extended attributes. Very long directory listings
3998 might cause the protocol message size to be exceeded, causing
3999 this call to fail. The caller must split up such requests
4000 into smaller groups of names.");
4002 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4004 "lgetxattr on multiple files",
4006 This call allows you to get the extended attributes
4007 of multiple files, where all files are in the directory C<path>.
4008 C<names> is the list of files from this directory.
4010 On return you get a flat list of xattr structs which must be
4011 interpreted sequentially. The first xattr struct always has a zero-length
4012 C<attrname>. C<attrval> in this struct is zero-length
4013 to indicate there was an error doing C<lgetxattr> for this
4014 file, I<or> is a C string which is a decimal number
4015 (the number of following attributes for this file, which could
4016 be C<\"0\">). Then after the first xattr struct are the
4017 zero or more attributes for the first named file.
4018 This repeats for the second and subsequent files.
4020 This call is intended for programs that want to efficiently
4021 list a directory contents without making many round-trips.
4022 See also C<guestfs_lstatlist> for a similarly efficient call
4023 for getting standard stats. Very long directory listings
4024 might cause the protocol message size to be exceeded, causing
4025 this call to fail. The caller must split up such requests
4026 into smaller groups of names.");
4028 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4030 "readlink on multiple files",
4032 This call allows you to do a C<readlink> operation
4033 on multiple files, where all files are in the directory C<path>.
4034 C<names> is the list of files from this directory.
4036 On return you get a list of strings, with a one-to-one
4037 correspondence to the C<names> list. Each string is the
4038 value of the symbol link.
4040 If the C<readlink(2)> operation fails on any name, then
4041 the corresponding result string is the empty string C<\"\">.
4042 However the whole operation is completed even if there
4043 were C<readlink(2)> errors, and so you can call this
4044 function with names where you don't know if they are
4045 symbolic links already (albeit slightly less efficient).
4047 This call is intended for programs that want to efficiently
4048 list a directory contents without making many round-trips.
4049 Very long directory listings might cause the protocol
4050 message size to be exceeded, causing
4051 this call to fail. The caller must split up such requests
4052 into smaller groups of names.");
4054 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4055 [InitISOFS, Always, TestOutputBuffer (
4056 [["pread"; "/known-4"; "1"; "3"]], "\n");
4057 InitISOFS, Always, TestOutputBuffer (
4058 [["pread"; "/empty"; "0"; "100"]], "")],
4059 "read part of a file",
4061 This command lets you read part of a file. It reads C<count>
4062 bytes of the file, starting at C<offset>, from file C<path>.
4064 This may read fewer bytes than requested. For further details
4065 see the L<pread(2)> system call.
4067 See also C<guestfs_pwrite>.");
4069 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4070 [InitEmpty, Always, TestRun (
4071 [["part_init"; "/dev/sda"; "gpt"]])],
4072 "create an empty partition table",
4074 This creates an empty partition table on C<device> of one of the
4075 partition types listed below. Usually C<parttype> should be
4076 either C<msdos> or C<gpt> (for large disks).
4078 Initially there are no partitions. Following this, you should
4079 call C<guestfs_part_add> for each partition required.
4081 Possible values for C<parttype> are:
4085 =item B<efi> | B<gpt>
4087 Intel EFI / GPT partition table.
4089 This is recommended for >= 2 TB partitions that will be accessed
4090 from Linux and Intel-based Mac OS X. It also has limited backwards
4091 compatibility with the C<mbr> format.
4093 =item B<mbr> | B<msdos>
4095 The standard PC \"Master Boot Record\" (MBR) format used
4096 by MS-DOS and Windows. This partition type will B<only> work
4097 for device sizes up to 2 TB. For large disks we recommend
4102 Other partition table types that may work but are not
4111 =item B<amiga> | B<rdb>
4113 Amiga \"Rigid Disk Block\" format.
4121 DASD, used on IBM mainframes.
4129 Old Mac partition format. Modern Macs use C<gpt>.
4133 NEC PC-98 format, common in Japan apparently.
4141 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4142 [InitEmpty, Always, TestRun (
4143 [["part_init"; "/dev/sda"; "mbr"];
4144 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4145 InitEmpty, Always, TestRun (
4146 [["part_init"; "/dev/sda"; "gpt"];
4147 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4148 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4149 InitEmpty, Always, TestRun (
4150 [["part_init"; "/dev/sda"; "mbr"];
4151 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4152 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4153 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4154 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4155 "add a partition to the device",
4157 This command adds a partition to C<device>. If there is no partition
4158 table on the device, call C<guestfs_part_init> first.
4160 The C<prlogex> parameter is the type of partition. Normally you
4161 should pass C<p> or C<primary> here, but MBR partition tables also
4162 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4165 C<startsect> and C<endsect> are the start and end of the partition
4166 in I<sectors>. C<endsect> may be negative, which means it counts
4167 backwards from the end of the disk (C<-1> is the last sector).
4169 Creating a partition which covers the whole disk is not so easy.
4170 Use C<guestfs_part_disk> to do that.");
4172 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4173 [InitEmpty, Always, TestRun (
4174 [["part_disk"; "/dev/sda"; "mbr"]]);
4175 InitEmpty, Always, TestRun (
4176 [["part_disk"; "/dev/sda"; "gpt"]])],
4177 "partition whole disk with a single primary partition",
4179 This command is simply a combination of C<guestfs_part_init>
4180 followed by C<guestfs_part_add> to create a single primary partition
4181 covering the whole disk.
4183 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4184 but other possible values are described in C<guestfs_part_init>.");
4186 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4187 [InitEmpty, Always, TestRun (
4188 [["part_disk"; "/dev/sda"; "mbr"];
4189 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4190 "make a partition bootable",
4192 This sets the bootable flag on partition numbered C<partnum> on
4193 device C<device>. Note that partitions are numbered from 1.
4195 The bootable flag is used by some operating systems (notably
4196 Windows) to determine which partition to boot from. It is by
4197 no means universally recognized.");
4199 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4200 [InitEmpty, Always, TestRun (
4201 [["part_disk"; "/dev/sda"; "gpt"];
4202 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4203 "set partition name",
4205 This sets the partition name on partition numbered C<partnum> on
4206 device C<device>. Note that partitions are numbered from 1.
4208 The partition name can only be set on certain types of partition
4209 table. This works on C<gpt> but not on C<mbr> partitions.");
4211 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4212 [], (* XXX Add a regression test for this. *)
4213 "list partitions on a device",
4215 This command parses the partition table on C<device> and
4216 returns the list of partitions found.
4218 The fields in the returned structure are:
4224 Partition number, counting from 1.
4228 Start of the partition I<in bytes>. To get sectors you have to
4229 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4233 End of the partition in bytes.
4237 Size of the partition in bytes.
4241 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4242 [InitEmpty, Always, TestOutput (
4243 [["part_disk"; "/dev/sda"; "gpt"];
4244 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4245 "get the partition table type",
4247 This command examines the partition table on C<device> and
4248 returns the partition table type (format) being used.
4250 Common return values include: C<msdos> (a DOS/Windows style MBR
4251 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4252 values are possible, although unusual. See C<guestfs_part_init>
4255 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4256 [InitBasicFS, Always, TestOutputBuffer (
4257 [["fill"; "0x63"; "10"; "/test"];
4258 ["read_file"; "/test"]], "cccccccccc")],
4259 "fill a file with octets",
4261 This command creates a new file called C<path>. The initial
4262 content of the file is C<len> octets of C<c>, where C<c>
4263 must be a number in the range C<[0..255]>.
4265 To fill a file with zero bytes (sparsely), it is
4266 much more efficient to use C<guestfs_truncate_size>.
4267 To create a file with a pattern of repeating bytes
4268 use C<guestfs_fill_pattern>.");
4270 ("available", (RErr, [StringList "groups"]), 216, [],
4271 [InitNone, Always, TestRun [["available"; ""]]],
4272 "test availability of some parts of the API",
4274 This command is used to check the availability of some
4275 groups of functionality in the appliance, which not all builds of
4276 the libguestfs appliance will be able to provide.
4278 The libguestfs groups, and the functions that those
4279 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4281 The argument C<groups> is a list of group names, eg:
4282 C<[\"inotify\", \"augeas\"]> would check for the availability of
4283 the Linux inotify functions and Augeas (configuration file
4286 The command returns no error if I<all> requested groups are available.
4288 It fails with an error if one or more of the requested
4289 groups is unavailable in the appliance.
4291 If an unknown group name is included in the
4292 list of groups then an error is always returned.
4300 You must call C<guestfs_launch> before calling this function.
4302 The reason is because we don't know what groups are
4303 supported by the appliance/daemon until it is running and can
4308 If a group of functions is available, this does not necessarily
4309 mean that they will work. You still have to check for errors
4310 when calling individual API functions even if they are
4315 It is usually the job of distro packagers to build
4316 complete functionality into the libguestfs appliance.
4317 Upstream libguestfs, if built from source with all
4318 requirements satisfied, will support everything.
4322 This call was added in version C<1.0.80>. In previous
4323 versions of libguestfs all you could do would be to speculatively
4324 execute a command to find out if the daemon implemented it.
4325 See also C<guestfs_version>.
4329 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4330 [InitBasicFS, Always, TestOutputBuffer (
4331 [["write"; "/src"; "hello, world"];
4332 ["dd"; "/src"; "/dest"];
4333 ["read_file"; "/dest"]], "hello, world")],
4334 "copy from source to destination using dd",
4336 This command copies from one source device or file C<src>
4337 to another destination device or file C<dest>. Normally you
4338 would use this to copy to or from a device or partition, for
4339 example to duplicate a filesystem.
4341 If the destination is a device, it must be as large or larger
4342 than the source file or device, otherwise the copy will fail.
4343 This command cannot do partial copies (see C<guestfs_copy_size>).");
4345 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4346 [InitBasicFS, Always, TestOutputInt (
4347 [["write"; "/file"; "hello, world"];
4348 ["filesize"; "/file"]], 12)],
4349 "return the size of the file in bytes",
4351 This command returns the size of C<file> in bytes.
4353 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4354 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4355 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4357 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4358 [InitBasicFSonLVM, Always, TestOutputList (
4359 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4360 ["lvs"]], ["/dev/VG/LV2"])],
4361 "rename an LVM logical volume",
4363 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4365 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4366 [InitBasicFSonLVM, Always, TestOutputList (
4368 ["vg_activate"; "false"; "VG"];
4369 ["vgrename"; "VG"; "VG2"];
4370 ["vg_activate"; "true"; "VG2"];
4371 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4372 ["vgs"]], ["VG2"])],
4373 "rename an LVM volume group",
4375 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4377 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4378 [InitISOFS, Always, TestOutputBuffer (
4379 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4380 "list the contents of a single file in an initrd",
4382 This command unpacks the file C<filename> from the initrd file
4383 called C<initrdpath>. The filename must be given I<without> the
4384 initial C</> character.
4386 For example, in guestfish you could use the following command
4387 to examine the boot script (usually called C</init>)
4388 contained in a Linux initrd or initramfs image:
4390 initrd-cat /boot/initrd-<version>.img init
4392 See also C<guestfs_initrd_list>.");
4394 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4396 "get the UUID of a physical volume",
4398 This command returns the UUID of the LVM PV C<device>.");
4400 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4402 "get the UUID of a volume group",
4404 This command returns the UUID of the LVM VG named C<vgname>.");
4406 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4408 "get the UUID of a logical volume",
4410 This command returns the UUID of the LVM LV C<device>.");
4412 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4414 "get the PV UUIDs containing the volume group",
4416 Given a VG called C<vgname>, this returns the UUIDs of all
4417 the physical volumes that this volume group resides on.
4419 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4420 calls to associate physical volumes and volume groups.
4422 See also C<guestfs_vglvuuids>.");
4424 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4426 "get the LV UUIDs of all LVs in the volume group",
4428 Given a VG called C<vgname>, this returns the UUIDs of all
4429 the logical volumes created in this volume group.
4431 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4432 calls to associate logical volumes and volume groups.
4434 See also C<guestfs_vgpvuuids>.");
4436 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4437 [InitBasicFS, Always, TestOutputBuffer (
4438 [["write"; "/src"; "hello, world"];
4439 ["copy_size"; "/src"; "/dest"; "5"];
4440 ["read_file"; "/dest"]], "hello")],
4441 "copy size bytes from source to destination using dd",
4443 This command copies exactly C<size> bytes from one source device
4444 or file C<src> to another destination device or file C<dest>.
4446 Note this will fail if the source is too short or if the destination
4447 is not large enough.");
4449 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4450 [InitBasicFSonLVM, Always, TestRun (
4451 [["zero_device"; "/dev/VG/LV"]])],
4452 "write zeroes to an entire device",
4454 This command writes zeroes over the entire C<device>. Compare
4455 with C<guestfs_zero> which just zeroes the first few blocks of
4458 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4459 [InitBasicFS, Always, TestOutput (
4460 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4461 ["cat"; "/hello"]], "hello\n")],
4462 "unpack compressed tarball to directory",
4464 This command uploads and unpacks local file C<tarball> (an
4465 I<xz compressed> tar file) into C<directory>.");
4467 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4469 "pack directory into compressed tarball",
4471 This command packs the contents of C<directory> and downloads
4472 it to local file C<tarball> (as an xz compressed tar archive).");
4474 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4476 "resize an NTFS filesystem",
4478 This command resizes an NTFS filesystem, expanding or
4479 shrinking it to the size of the underlying device.
4480 See also L<ntfsresize(8)>.");
4482 ("vgscan", (RErr, []), 232, [],
4483 [InitEmpty, Always, TestRun (
4485 "rescan for LVM physical volumes, volume groups and logical volumes",
4487 This rescans all block devices and rebuilds the list of LVM
4488 physical volumes, volume groups and logical volumes.");
4490 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4491 [InitEmpty, Always, TestRun (
4492 [["part_init"; "/dev/sda"; "mbr"];
4493 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4494 ["part_del"; "/dev/sda"; "1"]])],
4495 "delete a partition",
4497 This command deletes the partition numbered C<partnum> on C<device>.
4499 Note that in the case of MBR partitioning, deleting an
4500 extended partition also deletes any logical partitions
4503 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4504 [InitEmpty, Always, TestOutputTrue (
4505 [["part_init"; "/dev/sda"; "mbr"];
4506 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4507 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4508 ["part_get_bootable"; "/dev/sda"; "1"]])],
4509 "return true if a partition is bootable",
4511 This command returns true if the partition C<partnum> on
4512 C<device> has the bootable flag set.
4514 See also C<guestfs_part_set_bootable>.");
4516 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4517 [InitEmpty, Always, TestOutputInt (
4518 [["part_init"; "/dev/sda"; "mbr"];
4519 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4520 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4521 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4522 "get the MBR type byte (ID byte) from a partition",
4524 Returns the MBR type byte (also known as the ID byte) from
4525 the numbered partition C<partnum>.
4527 Note that only MBR (old DOS-style) partitions have type bytes.
4528 You will get undefined results for other partition table
4529 types (see C<guestfs_part_get_parttype>).");
4531 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4532 [], (* tested by part_get_mbr_id *)
4533 "set the MBR type byte (ID byte) of a partition",
4535 Sets the MBR type byte (also known as the ID byte) of
4536 the numbered partition C<partnum> to C<idbyte>. Note
4537 that the type bytes quoted in most documentation are
4538 in fact hexadecimal numbers, but usually documented
4539 without any leading \"0x\" which might be confusing.
4541 Note that only MBR (old DOS-style) partitions have type bytes.
4542 You will get undefined results for other partition table
4543 types (see C<guestfs_part_get_parttype>).");
4545 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4546 [InitISOFS, Always, TestOutput (
4547 [["checksum_device"; "md5"; "/dev/sdd"]],
4548 (Digest.to_hex (Digest.file "images/test.iso")))],
4549 "compute MD5, SHAx or CRC checksum of the contents of a device",
4551 This call computes the MD5, SHAx or CRC checksum of the
4552 contents of the device named C<device>. For the types of
4553 checksums supported see the C<guestfs_checksum> command.");
4555 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4556 [InitNone, Always, TestRun (
4557 [["part_disk"; "/dev/sda"; "mbr"];
4558 ["pvcreate"; "/dev/sda1"];
4559 ["vgcreate"; "VG"; "/dev/sda1"];
4560 ["lvcreate"; "LV"; "VG"; "10"];
4561 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4562 "expand an LV to fill free space",
4564 This expands an existing logical volume C<lv> so that it fills
4565 C<pc>% of the remaining free space in the volume group. Commonly
4566 you would call this with pc = 100 which expands the logical volume
4567 as much as possible, using all remaining free space in the volume
4570 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4571 [], (* XXX Augeas code needs tests. *)
4572 "clear Augeas path",
4574 Set the value associated with C<path> to C<NULL>. This
4575 is the same as the L<augtool(1)> C<clear> command.");
4577 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4578 [InitEmpty, Always, TestOutputInt (
4579 [["get_umask"]], 0o22)],
4580 "get the current umask",
4582 Return the current umask. By default the umask is C<022>
4583 unless it has been set by calling C<guestfs_umask>.");
4585 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4587 "upload a file to the appliance (internal use only)",
4589 The C<guestfs_debug_upload> command uploads a file to
4590 the libguestfs appliance.
4592 There is no comprehensive help for this command. You have
4593 to look at the file C<daemon/debug.c> in the libguestfs source
4594 to find out what it is for.");
4596 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4597 [InitBasicFS, Always, TestOutput (
4598 [["base64_in"; "../images/hello.b64"; "/hello"];
4599 ["cat"; "/hello"]], "hello\n")],
4600 "upload base64-encoded data to file",
4602 This command uploads base64-encoded data from C<base64file>
4605 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4607 "download file and encode as base64",
4609 This command downloads the contents of C<filename>, writing
4610 it out to local file C<base64file> encoded as base64.");
4612 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4614 "compute MD5, SHAx or CRC checksum of files in a directory",
4616 This command computes the checksums of all regular files in
4617 C<directory> and then emits a list of those checksums to
4618 the local output file C<sumsfile>.
4620 This can be used for verifying the integrity of a virtual
4621 machine. However to be properly secure you should pay
4622 attention to the output of the checksum command (it uses
4623 the ones from GNU coreutils). In particular when the
4624 filename is not printable, coreutils uses a special
4625 backslash syntax. For more information, see the GNU
4626 coreutils info file.");
4628 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4629 [InitBasicFS, Always, TestOutputBuffer (
4630 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4631 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4632 "fill a file with a repeating pattern of bytes",
4634 This function is like C<guestfs_fill> except that it creates
4635 a new file of length C<len> containing the repeating pattern
4636 of bytes in C<pattern>. The pattern is truncated if necessary
4637 to ensure the length of the file is exactly C<len> bytes.");
4639 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4640 [InitBasicFS, Always, TestOutput (
4641 [["write"; "/new"; "new file contents"];
4642 ["cat"; "/new"]], "new file contents");
4643 InitBasicFS, Always, TestOutput (
4644 [["write"; "/new"; "\nnew file contents\n"];
4645 ["cat"; "/new"]], "\nnew file contents\n");
4646 InitBasicFS, Always, TestOutput (
4647 [["write"; "/new"; "\n\n"];
4648 ["cat"; "/new"]], "\n\n");
4649 InitBasicFS, Always, TestOutput (
4650 [["write"; "/new"; ""];
4651 ["cat"; "/new"]], "");
4652 InitBasicFS, Always, TestOutput (
4653 [["write"; "/new"; "\n\n\n"];
4654 ["cat"; "/new"]], "\n\n\n");
4655 InitBasicFS, Always, TestOutput (
4656 [["write"; "/new"; "\n"];
4657 ["cat"; "/new"]], "\n")],
4658 "create a new file",
4660 This call creates a file called C<path>. The content of the
4661 file is the string C<content> (which can contain any 8 bit data).");
4663 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4664 [InitBasicFS, Always, TestOutput (
4665 [["write"; "/new"; "new file contents"];
4666 ["pwrite"; "/new"; "data"; "4"];
4667 ["cat"; "/new"]], "new data contents");
4668 InitBasicFS, Always, TestOutput (
4669 [["write"; "/new"; "new file contents"];
4670 ["pwrite"; "/new"; "is extended"; "9"];
4671 ["cat"; "/new"]], "new file is extended");
4672 InitBasicFS, Always, TestOutput (
4673 [["write"; "/new"; "new file contents"];
4674 ["pwrite"; "/new"; ""; "4"];
4675 ["cat"; "/new"]], "new file contents")],
4676 "write to part of a file",
4678 This command writes to part of a file. It writes the data
4679 buffer C<content> to the file C<path> starting at offset C<offset>.
4681 This command implements the L<pwrite(2)> system call, and like
4682 that system call it may not write the full data requested. The
4683 return value is the number of bytes that were actually written
4684 to the file. This could even be 0, although short writes are
4685 unlikely for regular files in ordinary circumstances.
4687 See also C<guestfs_pread>.");
4689 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4691 "resize an ext2/ext3 filesystem (with size)",
4693 This command is the same as C<guestfs_resize2fs> except that it
4694 allows you to specify the new size (in bytes) explicitly.");
4696 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4698 "resize an LVM physical volume (with size)",
4700 This command is the same as C<guestfs_pvresize> except that it
4701 allows you to specify the new size (in bytes) explicitly.");
4705 let all_functions = non_daemon_functions @ daemon_functions
4707 (* In some places we want the functions to be displayed sorted
4708 * alphabetically, so this is useful:
4710 let all_functions_sorted =
4711 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4712 compare n1 n2) all_functions
4714 (* This is used to generate the src/MAX_PROC_NR file which
4715 * contains the maximum procedure number, a surrogate for the
4716 * ABI version number. See src/Makefile.am for the details.
4719 let proc_nrs = List.map (
4720 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4721 ) daemon_functions in
4722 List.fold_left max 0 proc_nrs
4724 (* Field types for structures. *)
4726 | FChar (* C 'char' (really, a 7 bit byte). *)
4727 | FString (* nul-terminated ASCII string, NOT NULL. *)
4728 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4733 | FBytes (* Any int measure that counts bytes. *)
4734 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4735 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4737 (* Because we generate extra parsing code for LVM command line tools,
4738 * we have to pull out the LVM columns separately here.
4748 "pv_attr", FString (* XXX *);
4749 "pv_pe_count", FInt64;
4750 "pv_pe_alloc_count", FInt64;
4753 "pv_mda_count", FInt64;
4754 "pv_mda_free", FBytes;
4755 (* Not in Fedora 10:
4756 "pv_mda_size", FBytes;
4763 "vg_attr", FString (* XXX *);
4766 "vg_sysid", FString;
4767 "vg_extent_size", FBytes;
4768 "vg_extent_count", FInt64;
4769 "vg_free_count", FInt64;
4774 "snap_count", FInt64;
4777 "vg_mda_count", FInt64;
4778 "vg_mda_free", FBytes;
4779 (* Not in Fedora 10:
4780 "vg_mda_size", FBytes;
4786 "lv_attr", FString (* XXX *);
4789 "lv_kernel_major", FInt64;
4790 "lv_kernel_minor", FInt64;
4792 "seg_count", FInt64;
4794 "snap_percent", FOptPercent;
4795 "copy_percent", FOptPercent;
4798 "mirror_log", FString;
4802 (* Names and fields in all structures (in RStruct and RStructList)
4806 (* The old RIntBool return type, only ever used for aug_defnode. Do
4807 * not use this struct in any new code.
4810 "i", FInt32; (* for historical compatibility *)
4811 "b", FInt32; (* for historical compatibility *)
4814 (* LVM PVs, VGs, LVs. *)
4815 "lvm_pv", lvm_pv_cols;
4816 "lvm_vg", lvm_vg_cols;
4817 "lvm_lv", lvm_lv_cols;
4819 (* Column names and types from stat structures.
4820 * NB. Can't use things like 'st_atime' because glibc header files
4821 * define some of these as macros. Ugh.
4852 (* Column names in dirent structure. *)
4855 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4860 (* Version numbers. *)
4868 (* Extended attribute. *)
4870 "attrname", FString;
4874 (* Inotify events. *)
4878 "in_cookie", FUInt32;
4882 (* Partition table entry. *)
4885 "part_start", FBytes;
4887 "part_size", FBytes;
4889 ] (* end of structs *)
4891 (* Ugh, Java has to be different ..
4892 * These names are also used by the Haskell bindings.
4894 let java_structs = [
4895 "int_bool", "IntBool";
4900 "statvfs", "StatVFS";
4902 "version", "Version";
4904 "inotify_event", "INotifyEvent";
4905 "partition", "Partition";
4908 (* What structs are actually returned. *)
4909 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4911 (* Returns a list of RStruct/RStructList structs that are returned
4912 * by any function. Each element of returned list is a pair:
4914 * (structname, RStructOnly)
4915 * == there exists function which returns RStruct (_, structname)
4916 * (structname, RStructListOnly)
4917 * == there exists function which returns RStructList (_, structname)
4918 * (structname, RStructAndList)
4919 * == there are functions returning both RStruct (_, structname)
4920 * and RStructList (_, structname)
4922 let rstructs_used_by functions =
4923 (* ||| is a "logical OR" for rstructs_used_t *)
4927 | _, RStructAndList -> RStructAndList
4928 | RStructOnly, RStructListOnly
4929 | RStructListOnly, RStructOnly -> RStructAndList
4930 | RStructOnly, RStructOnly -> RStructOnly
4931 | RStructListOnly, RStructListOnly -> RStructListOnly
4934 let h = Hashtbl.create 13 in
4936 (* if elem->oldv exists, update entry using ||| operator,
4937 * else just add elem->newv to the hash
4939 let update elem newv =
4940 try let oldv = Hashtbl.find h elem in
4941 Hashtbl.replace h elem (newv ||| oldv)
4942 with Not_found -> Hashtbl.add h elem newv
4946 fun (_, style, _, _, _, _, _) ->
4947 match fst style with
4948 | RStruct (_, structname) -> update structname RStructOnly
4949 | RStructList (_, structname) -> update structname RStructListOnly
4953 (* return key->values as a list of (key,value) *)
4954 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4956 (* Used for testing language bindings. *)
4958 | CallString of string
4959 | CallOptString of string option
4960 | CallStringList of string list
4962 | CallInt64 of int64
4964 | CallBuffer of string
4966 (* Used to memoize the result of pod2text. *)
4967 let pod2text_memo_filename = "src/.pod2text.data"
4968 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4970 let chan = open_in pod2text_memo_filename in
4971 let v = input_value chan in
4975 _ -> Hashtbl.create 13
4976 let pod2text_memo_updated () =
4977 let chan = open_out pod2text_memo_filename in
4978 output_value chan pod2text_memo;
4981 (* Useful functions.
4982 * Note we don't want to use any external OCaml libraries which
4983 * makes this a bit harder than it should be.
4985 module StringMap = Map.Make (String)
4987 let failwithf fs = ksprintf failwith fs
4989 let unique = let i = ref 0 in fun () -> incr i; !i
4991 let replace_char s c1 c2 =
4992 let s2 = String.copy s in
4993 let r = ref false in
4994 for i = 0 to String.length s2 - 1 do
4995 if String.unsafe_get s2 i = c1 then (
4996 String.unsafe_set s2 i c2;
5000 if not !r then s else s2
5004 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5006 let triml ?(test = isspace) str =
5008 let n = ref (String.length str) in
5009 while !n > 0 && test str.[!i]; do
5014 else String.sub str !i !n
5016 let trimr ?(test = isspace) str =
5017 let n = ref (String.length str) in
5018 while !n > 0 && test str.[!n-1]; do
5021 if !n = String.length str then str
5022 else String.sub str 0 !n
5024 let trim ?(test = isspace) str =
5025 trimr ~test (triml ~test str)
5027 let rec find s sub =
5028 let len = String.length s in
5029 let sublen = String.length sub in
5031 if i <= len-sublen then (
5033 if j < sublen then (
5034 if s.[i+j] = sub.[j] then loop2 (j+1)
5040 if r = -1 then loop (i+1) else r
5046 let rec replace_str s s1 s2 =
5047 let len = String.length s in
5048 let sublen = String.length s1 in
5049 let i = find s s1 in
5052 let s' = String.sub s 0 i in
5053 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5054 s' ^ s2 ^ replace_str s'' s1 s2
5057 let rec string_split sep str =
5058 let len = String.length str in
5059 let seplen = String.length sep in
5060 let i = find str sep in
5061 if i = -1 then [str]
5063 let s' = String.sub str 0 i in
5064 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5065 s' :: string_split sep s''
5068 let files_equal n1 n2 =
5069 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5070 match Sys.command cmd with
5073 | i -> failwithf "%s: failed with error code %d" cmd i
5075 let rec filter_map f = function
5079 | Some y -> y :: filter_map f xs
5080 | None -> filter_map f xs
5082 let rec find_map f = function
5083 | [] -> raise Not_found
5087 | None -> find_map f xs
5090 let rec loop i = function
5092 | x :: xs -> f i x; loop (i+1) xs
5097 let rec loop i = function
5099 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5103 let count_chars c str =
5104 let count = ref 0 in
5105 for i = 0 to String.length str - 1 do
5106 if c = String.unsafe_get str i then incr count
5112 for i = 0 to String.length str - 1 do
5113 let c = String.unsafe_get str i in
5118 let map_chars f str =
5119 List.map f (explode str)
5121 let name_of_argt = function
5122 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5123 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5124 | FileIn n | FileOut n | BufferIn n -> n
5126 let java_name_of_struct typ =
5127 try List.assoc typ java_structs
5130 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5132 let cols_of_struct typ =
5133 try List.assoc typ structs
5135 failwithf "cols_of_struct: unknown struct %s" typ
5137 let seq_of_test = function
5138 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5139 | TestOutputListOfDevices (s, _)
5140 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5141 | TestOutputTrue s | TestOutputFalse s
5142 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5143 | TestOutputStruct (s, _)
5144 | TestLastFail s -> s
5146 (* Handling for function flags. *)
5147 let protocol_limit_warning =
5148 "Because of the message protocol, there is a transfer limit
5149 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5151 let danger_will_robinson =
5152 "B<This command is dangerous. Without careful use you
5153 can easily destroy all your data>."
5155 let deprecation_notice flags =
5158 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5160 sprintf "This function is deprecated.
5161 In new code, use the C<%s> call instead.
5163 Deprecated functions will not be removed from the API, but the
5164 fact that they are deprecated indicates that there are problems
5165 with correct use of these functions." alt in
5170 (* Create list of optional groups. *)
5172 let h = Hashtbl.create 13 in
5174 fun (name, _, _, flags, _, _, _) ->
5178 let names = try Hashtbl.find h group with Not_found -> [] in
5179 Hashtbl.replace h group (name :: names)
5183 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5186 fun group -> group, List.sort compare (Hashtbl.find h group)
5188 List.sort (fun x y -> compare (fst x) (fst y)) groups
5190 (* Check function names etc. for consistency. *)
5191 let check_functions () =
5192 let contains_uppercase str =
5193 let len = String.length str in
5195 if i >= len then false
5198 if c >= 'A' && c <= 'Z' then true
5205 (* Check function names. *)
5207 fun (name, _, _, _, _, _, _) ->
5208 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5209 failwithf "function name %s does not need 'guestfs' prefix" name;
5211 failwithf "function name is empty";
5212 if name.[0] < 'a' || name.[0] > 'z' then
5213 failwithf "function name %s must start with lowercase a-z" name;
5214 if String.contains name '-' then
5215 failwithf "function name %s should not contain '-', use '_' instead."
5219 (* Check function parameter/return names. *)
5221 fun (name, style, _, _, _, _, _) ->
5222 let check_arg_ret_name n =
5223 if contains_uppercase n then
5224 failwithf "%s param/ret %s should not contain uppercase chars"
5226 if String.contains n '-' || String.contains n '_' then
5227 failwithf "%s param/ret %s should not contain '-' or '_'"
5230 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;
5231 if n = "int" || n = "char" || n = "short" || n = "long" then
5232 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5233 if n = "i" || n = "n" then
5234 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5235 if n = "argv" || n = "args" then
5236 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5238 (* List Haskell, OCaml and C keywords here.
5239 * http://www.haskell.org/haskellwiki/Keywords
5240 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5241 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5242 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5243 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5244 * Omitting _-containing words, since they're handled above.
5245 * Omitting the OCaml reserved word, "val", is ok,
5246 * and saves us from renaming several parameters.
5249 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5250 "char"; "class"; "const"; "constraint"; "continue"; "data";
5251 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5252 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5253 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5254 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5255 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5257 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5258 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5259 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5260 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5261 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5262 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5263 "volatile"; "when"; "where"; "while";
5265 if List.mem n reserved then
5266 failwithf "%s has param/ret using reserved word %s" name n;
5269 (match fst style with
5271 | RInt n | RInt64 n | RBool n
5272 | RConstString n | RConstOptString n | RString n
5273 | RStringList n | RStruct (n, _) | RStructList (n, _)
5274 | RHashtable n | RBufferOut n ->
5275 check_arg_ret_name n
5277 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5280 (* Check short descriptions. *)
5282 fun (name, _, _, _, _, shortdesc, _) ->
5283 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5284 failwithf "short description of %s should begin with lowercase." name;
5285 let c = shortdesc.[String.length shortdesc-1] in
5286 if c = '\n' || c = '.' then
5287 failwithf "short description of %s should not end with . or \\n." name
5290 (* Check long descriptions. *)
5292 fun (name, _, _, _, _, _, longdesc) ->
5293 if longdesc.[String.length longdesc-1] = '\n' then
5294 failwithf "long description of %s should not end with \\n." name
5297 (* Check proc_nrs. *)
5299 fun (name, _, proc_nr, _, _, _, _) ->
5300 if proc_nr <= 0 then
5301 failwithf "daemon function %s should have proc_nr > 0" name
5305 fun (name, _, proc_nr, _, _, _, _) ->
5306 if proc_nr <> -1 then
5307 failwithf "non-daemon function %s should have proc_nr -1" name
5308 ) non_daemon_functions;
5311 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5314 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5315 let rec loop = function
5318 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5320 | (name1,nr1) :: (name2,nr2) :: _ ->
5321 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5329 (* Ignore functions that have no tests. We generate a
5330 * warning when the user does 'make check' instead.
5332 | name, _, _, _, [], _, _ -> ()
5333 | name, _, _, _, tests, _, _ ->
5337 match seq_of_test test with
5339 failwithf "%s has a test containing an empty sequence" name
5340 | cmds -> List.map List.hd cmds
5342 let funcs = List.flatten funcs in
5344 let tested = List.mem name funcs in
5347 failwithf "function %s has tests but does not test itself" name
5350 (* 'pr' prints to the current output file. *)
5351 let chan = ref Pervasives.stdout
5356 let i = count_chars '\n' str in
5357 lines := !lines + i;
5358 output_string !chan str
5361 let copyright_years =
5362 let this_year = 1900 + (localtime (time ())).tm_year in
5363 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5365 (* Generate a header block in a number of standard styles. *)
5366 type comment_style =
5367 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5368 type license = GPLv2plus | LGPLv2plus
5370 let generate_header ?(extra_inputs = []) comment license =
5371 let inputs = "src/generator.ml" :: extra_inputs in
5372 let c = match comment with
5373 | CStyle -> pr "/* "; " *"
5374 | CPlusPlusStyle -> pr "// "; "//"
5375 | HashStyle -> pr "# "; "#"
5376 | OCamlStyle -> pr "(* "; " *"
5377 | HaskellStyle -> pr "{- "; " " in
5378 pr "libguestfs generated file\n";
5379 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5380 List.iter (pr "%s %s\n" c) inputs;
5381 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5383 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5387 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5388 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5389 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5390 pr "%s (at your option) any later version.\n" c;
5392 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5393 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5394 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5395 pr "%s GNU General Public License for more details.\n" c;
5397 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5398 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5399 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5402 pr "%s This library is free software; you can redistribute it and/or\n" c;
5403 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5404 pr "%s License as published by the Free Software Foundation; either\n" c;
5405 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5407 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5408 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5409 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5410 pr "%s Lesser General Public License for more details.\n" c;
5412 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5413 pr "%s License along with this library; if not, write to the Free Software\n" c;
5414 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5417 | CStyle -> pr " */\n"
5420 | OCamlStyle -> pr " *)\n"
5421 | HaskellStyle -> pr "-}\n"
5425 (* Start of main code generation functions below this line. *)
5427 (* Generate the pod documentation for the C API. *)
5428 let rec generate_actions_pod () =
5430 fun (shortname, style, _, flags, _, _, longdesc) ->
5431 if not (List.mem NotInDocs flags) then (
5432 let name = "guestfs_" ^ shortname in
5433 pr "=head2 %s\n\n" name;
5435 generate_prototype ~extern:false ~handle:"g" name style;
5437 pr "%s\n\n" longdesc;
5438 (match fst style with
5440 pr "This function returns 0 on success or -1 on error.\n\n"
5442 pr "On error this function returns -1.\n\n"
5444 pr "On error this function returns -1.\n\n"
5446 pr "This function returns a C truth value on success or -1 on error.\n\n"
5448 pr "This function returns a string, or NULL on error.
5449 The string is owned by the guest handle and must I<not> be freed.\n\n"
5450 | RConstOptString _ ->
5451 pr "This function returns a string which may be NULL.
5452 There is way to return an error from this function.
5453 The string is owned by the guest handle and must I<not> be freed.\n\n"
5455 pr "This function returns a string, or NULL on error.
5456 I<The caller must free the returned string after use>.\n\n"
5458 pr "This function returns a NULL-terminated array of strings
5459 (like L<environ(3)>), or NULL if there was an error.
5460 I<The caller must free the strings and the array after use>.\n\n"
5461 | RStruct (_, typ) ->
5462 pr "This function returns a C<struct guestfs_%s *>,
5463 or NULL if there was an error.
5464 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5465 | RStructList (_, typ) ->
5466 pr "This function returns a C<struct guestfs_%s_list *>
5467 (see E<lt>guestfs-structs.hE<gt>),
5468 or NULL if there was an error.
5469 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5471 pr "This function returns a NULL-terminated array of
5472 strings, or NULL if there was an error.
5473 The array of strings will always have length C<2n+1>, where
5474 C<n> keys and values alternate, followed by the trailing NULL entry.
5475 I<The caller must free the strings and the array after use>.\n\n"
5477 pr "This function returns a buffer, or NULL on error.
5478 The size of the returned buffer is written to C<*size_r>.
5479 I<The caller must free the returned buffer after use>.\n\n"
5481 if List.mem ProtocolLimitWarning flags then
5482 pr "%s\n\n" protocol_limit_warning;
5483 if List.mem DangerWillRobinson flags then
5484 pr "%s\n\n" danger_will_robinson;
5485 match deprecation_notice flags with
5487 | Some txt -> pr "%s\n\n" txt
5489 ) all_functions_sorted
5491 and generate_structs_pod () =
5492 (* Structs documentation. *)
5495 pr "=head2 guestfs_%s\n" typ;
5497 pr " struct guestfs_%s {\n" typ;
5500 | name, FChar -> pr " char %s;\n" name
5501 | name, FUInt32 -> pr " uint32_t %s;\n" name
5502 | name, FInt32 -> pr " int32_t %s;\n" name
5503 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5504 | name, FInt64 -> pr " int64_t %s;\n" name
5505 | name, FString -> pr " char *%s;\n" name
5507 pr " /* The next two fields describe a byte array. */\n";
5508 pr " uint32_t %s_len;\n" name;
5509 pr " char *%s;\n" name
5511 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5512 pr " char %s[32];\n" name
5513 | name, FOptPercent ->
5514 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5515 pr " float %s;\n" name
5519 pr " struct guestfs_%s_list {\n" typ;
5520 pr " uint32_t len; /* Number of elements in list. */\n";
5521 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5524 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5525 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5530 and generate_availability_pod () =
5531 (* Availability documentation. *)
5535 fun (group, functions) ->
5536 pr "=item B<%s>\n" group;
5538 pr "The following functions:\n";
5539 List.iter (pr "L</guestfs_%s>\n") functions;
5545 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5546 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5548 * We have to use an underscore instead of a dash because otherwise
5549 * rpcgen generates incorrect code.
5551 * This header is NOT exported to clients, but see also generate_structs_h.
5553 and generate_xdr () =
5554 generate_header CStyle LGPLv2plus;
5556 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5557 pr "typedef string str<>;\n";
5560 (* Internal structures. *)
5564 pr "struct guestfs_int_%s {\n" typ;
5566 | name, FChar -> pr " char %s;\n" name
5567 | name, FString -> pr " string %s<>;\n" name
5568 | name, FBuffer -> pr " opaque %s<>;\n" name
5569 | name, FUUID -> pr " opaque %s[32];\n" name
5570 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5571 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5572 | name, FOptPercent -> pr " float %s;\n" name
5576 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5581 fun (shortname, style, _, _, _, _, _) ->
5582 let name = "guestfs_" ^ shortname in
5584 (match snd style with
5587 pr "struct %s_args {\n" name;
5590 | Pathname n | Device n | Dev_or_Path n | String n ->
5591 pr " string %s<>;\n" n
5592 | OptString n -> pr " str *%s;\n" n
5593 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5594 | Bool n -> pr " bool %s;\n" n
5595 | Int n -> pr " int %s;\n" n
5596 | Int64 n -> pr " hyper %s;\n" n
5598 pr " opaque %s<>;\n" n
5599 | FileIn _ | FileOut _ -> ()
5603 (match fst style with
5606 pr "struct %s_ret {\n" name;
5610 pr "struct %s_ret {\n" name;
5611 pr " hyper %s;\n" n;
5614 pr "struct %s_ret {\n" name;
5617 | RConstString _ | RConstOptString _ ->
5618 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5620 pr "struct %s_ret {\n" name;
5621 pr " string %s<>;\n" n;
5624 pr "struct %s_ret {\n" name;
5625 pr " str %s<>;\n" n;
5627 | RStruct (n, typ) ->
5628 pr "struct %s_ret {\n" name;
5629 pr " guestfs_int_%s %s;\n" typ n;
5631 | RStructList (n, typ) ->
5632 pr "struct %s_ret {\n" name;
5633 pr " guestfs_int_%s_list %s;\n" typ n;
5636 pr "struct %s_ret {\n" name;
5637 pr " str %s<>;\n" n;
5640 pr "struct %s_ret {\n" name;
5641 pr " opaque %s<>;\n" n;
5646 (* Table of procedure numbers. *)
5647 pr "enum guestfs_procedure {\n";
5649 fun (shortname, _, proc_nr, _, _, _, _) ->
5650 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5652 pr " GUESTFS_PROC_NR_PROCS\n";
5656 (* Having to choose a maximum message size is annoying for several
5657 * reasons (it limits what we can do in the API), but it (a) makes
5658 * the protocol a lot simpler, and (b) provides a bound on the size
5659 * of the daemon which operates in limited memory space.
5661 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5664 (* Message header, etc. *)
5666 /* The communication protocol is now documented in the guestfs(3)
5670 const GUESTFS_PROGRAM = 0x2000F5F5;
5671 const GUESTFS_PROTOCOL_VERSION = 1;
5673 /* These constants must be larger than any possible message length. */
5674 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5675 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5677 enum guestfs_message_direction {
5678 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5679 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5682 enum guestfs_message_status {
5683 GUESTFS_STATUS_OK = 0,
5684 GUESTFS_STATUS_ERROR = 1
5687 const GUESTFS_ERROR_LEN = 256;
5689 struct guestfs_message_error {
5690 string error_message<GUESTFS_ERROR_LEN>;
5693 struct guestfs_message_header {
5694 unsigned prog; /* GUESTFS_PROGRAM */
5695 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5696 guestfs_procedure proc; /* GUESTFS_PROC_x */
5697 guestfs_message_direction direction;
5698 unsigned serial; /* message serial number */
5699 guestfs_message_status status;
5702 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5704 struct guestfs_chunk {
5705 int cancel; /* if non-zero, transfer is cancelled */
5706 /* data size is 0 bytes if the transfer has finished successfully */
5707 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5711 (* Generate the guestfs-structs.h file. *)
5712 and generate_structs_h () =
5713 generate_header CStyle LGPLv2plus;
5715 (* This is a public exported header file containing various
5716 * structures. The structures are carefully written to have
5717 * exactly the same in-memory format as the XDR structures that
5718 * we use on the wire to the daemon. The reason for creating
5719 * copies of these structures here is just so we don't have to
5720 * export the whole of guestfs_protocol.h (which includes much
5721 * unrelated and XDR-dependent stuff that we don't want to be
5722 * public, or required by clients).
5724 * To reiterate, we will pass these structures to and from the
5725 * client with a simple assignment or memcpy, so the format
5726 * must be identical to what rpcgen / the RFC defines.
5729 (* Public structures. *)
5732 pr "struct guestfs_%s {\n" typ;
5735 | name, FChar -> pr " char %s;\n" name
5736 | name, FString -> pr " char *%s;\n" name
5738 pr " uint32_t %s_len;\n" name;
5739 pr " char *%s;\n" name
5740 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5741 | name, FUInt32 -> pr " uint32_t %s;\n" name
5742 | name, FInt32 -> pr " int32_t %s;\n" name
5743 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5744 | name, FInt64 -> pr " int64_t %s;\n" name
5745 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5749 pr "struct guestfs_%s_list {\n" typ;
5750 pr " uint32_t len;\n";
5751 pr " struct guestfs_%s *val;\n" typ;
5754 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5755 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5759 (* Generate the guestfs-actions.h file. *)
5760 and generate_actions_h () =
5761 generate_header CStyle LGPLv2plus;
5763 fun (shortname, style, _, _, _, _, _) ->
5764 let name = "guestfs_" ^ shortname in
5765 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5769 (* Generate the guestfs-internal-actions.h file. *)
5770 and generate_internal_actions_h () =
5771 generate_header CStyle LGPLv2plus;
5773 fun (shortname, style, _, _, _, _, _) ->
5774 let name = "guestfs__" ^ shortname in
5775 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5777 ) non_daemon_functions
5779 (* Generate the client-side dispatch stubs. *)
5780 and generate_client_actions () =
5781 generate_header CStyle LGPLv2plus;
5788 #include <inttypes.h>
5790 #include \"guestfs.h\"
5791 #include \"guestfs-internal.h\"
5792 #include \"guestfs-internal-actions.h\"
5793 #include \"guestfs_protocol.h\"
5795 #define error guestfs_error
5796 //#define perrorf guestfs_perrorf
5797 #define safe_malloc guestfs_safe_malloc
5798 #define safe_realloc guestfs_safe_realloc
5799 //#define safe_strdup guestfs_safe_strdup
5800 #define safe_memdup guestfs_safe_memdup
5802 /* Check the return message from a call for validity. */
5804 check_reply_header (guestfs_h *g,
5805 const struct guestfs_message_header *hdr,
5806 unsigned int proc_nr, unsigned int serial)
5808 if (hdr->prog != GUESTFS_PROGRAM) {
5809 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5812 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5813 error (g, \"wrong protocol version (%%d/%%d)\",
5814 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5817 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5818 error (g, \"unexpected message direction (%%d/%%d)\",
5819 hdr->direction, GUESTFS_DIRECTION_REPLY);
5822 if (hdr->proc != proc_nr) {
5823 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5826 if (hdr->serial != serial) {
5827 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5834 /* Check we are in the right state to run a high-level action. */
5836 check_state (guestfs_h *g, const char *caller)
5838 if (!guestfs__is_ready (g)) {
5839 if (guestfs__is_config (g) || guestfs__is_launching (g))
5840 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5843 error (g, \"%%s called from the wrong state, %%d != READY\",
5844 caller, guestfs__get_state (g));
5852 let error_code_of = function
5853 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5854 | RConstString _ | RConstOptString _
5855 | RString _ | RStringList _
5856 | RStruct _ | RStructList _
5857 | RHashtable _ | RBufferOut _ -> "NULL"
5860 (* Generate code to check String-like parameters are not passed in
5861 * as NULL (returning an error if they are).
5863 let check_null_strings shortname style =
5864 let pr_newline = ref false in
5867 (* parameters which should not be NULL *)
5877 pr " if (%s == NULL) {\n" n;
5878 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
5879 pr " \"%s\", \"%s\");\n" shortname n;
5880 pr " return %s;\n" (error_code_of (fst style));
5887 (* not applicable *)
5893 if !pr_newline then pr "\n";
5896 (* Generate code to generate guestfish call traces. *)
5897 let trace_call shortname style =
5898 pr " if (guestfs__get_trace (g)) {\n";
5901 List.exists (function
5902 | StringList _ | DeviceList _ -> true
5903 | _ -> false) (snd style) in
5909 pr " printf (\"%s\");\n" shortname;
5912 | String n (* strings *)
5919 (* guestfish doesn't support string escaping, so neither do we *)
5920 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5921 | OptString n -> (* string option *)
5922 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5923 pr " else printf (\" null\");\n"
5925 | DeviceList n -> (* string list *)
5926 pr " putchar (' ');\n";
5927 pr " putchar ('\"');\n";
5928 pr " for (i = 0; %s[i]; ++i) {\n" n;
5929 pr " if (i > 0) putchar (' ');\n";
5930 pr " fputs (%s[i], stdout);\n" n;
5932 pr " putchar ('\"');\n";
5933 | Bool n -> (* boolean *)
5934 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5935 | Int n -> (* int *)
5936 pr " printf (\" %%d\", %s);\n" n
5938 pr " printf (\" %%\" PRIi64, %s);\n" n
5940 pr " putchar ('\\n');\n";
5945 (* For non-daemon functions, generate a wrapper around each function. *)
5947 fun (shortname, style, _, _, _, _, _) ->
5948 let name = "guestfs_" ^ shortname in
5950 generate_prototype ~extern:false ~semicolon:false ~newline:true
5951 ~handle:"g" name style;
5953 check_null_strings shortname style;
5954 trace_call shortname style;
5955 pr " return guestfs__%s " shortname;
5956 generate_c_call_args ~handle:"g" style;
5960 ) non_daemon_functions;
5962 (* Client-side stubs for each function. *)
5964 fun (shortname, style, _, _, _, _, _) ->
5965 let name = "guestfs_" ^ shortname in
5966 let error_code = error_code_of (fst style) in
5968 (* Generate the action stub. *)
5969 generate_prototype ~extern:false ~semicolon:false ~newline:true
5970 ~handle:"g" name style;
5974 (match snd style with
5976 | _ -> pr " struct %s_args args;\n" name
5979 pr " guestfs_message_header hdr;\n";
5980 pr " guestfs_message_error err;\n";
5982 match fst style with
5984 | RConstString _ | RConstOptString _ ->
5985 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5987 | RBool _ | RString _ | RStringList _
5988 | RStruct _ | RStructList _
5989 | RHashtable _ | RBufferOut _ ->
5990 pr " struct %s_ret ret;\n" name;
5993 pr " int serial;\n";
5996 check_null_strings shortname style;
5997 trace_call shortname style;
5998 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
5999 shortname error_code;
6000 pr " guestfs___set_busy (g);\n";
6003 (* Send the main header and arguments. *)
6004 (match snd style with
6006 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6007 (String.uppercase shortname)
6011 | Pathname n | Device n | Dev_or_Path n | String n ->
6012 pr " args.%s = (char *) %s;\n" n n
6014 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6015 | StringList n | DeviceList n ->
6016 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6017 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6019 pr " args.%s = %s;\n" n n
6021 pr " args.%s = %s;\n" n n
6023 pr " args.%s = %s;\n" n n
6024 | FileIn _ | FileOut _ -> ()
6026 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6027 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6028 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6030 pr " guestfs___end_busy (g);\n";
6031 pr " return %s;\n" error_code;
6033 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6034 pr " args.%s.%s_len = %s_size;\n" n n n
6036 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6037 (String.uppercase shortname);
6038 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6041 pr " if (serial == -1) {\n";
6042 pr " guestfs___end_busy (g);\n";
6043 pr " return %s;\n" error_code;
6047 (* Send any additional files (FileIn) requested. *)
6048 let need_read_reply_label = ref false in
6052 pr " r = guestfs___send_file (g, %s);\n" n;
6053 pr " if (r == -1) {\n";
6054 pr " guestfs___end_busy (g);\n";
6055 pr " return %s;\n" error_code;
6057 pr " if (r == -2) /* daemon cancelled */\n";
6058 pr " goto read_reply;\n";
6059 need_read_reply_label := true;
6064 (* Wait for the reply from the remote end. *)
6065 if !need_read_reply_label then pr " read_reply:\n";
6066 pr " memset (&hdr, 0, sizeof hdr);\n";
6067 pr " memset (&err, 0, sizeof err);\n";
6068 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6070 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6074 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6077 pr " if (r == -1) {\n";
6078 pr " guestfs___end_busy (g);\n";
6079 pr " return %s;\n" error_code;
6083 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6084 (String.uppercase shortname);
6085 pr " guestfs___end_busy (g);\n";
6086 pr " return %s;\n" error_code;
6090 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6091 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6092 pr " free (err.error_message);\n";
6093 pr " guestfs___end_busy (g);\n";
6094 pr " return %s;\n" error_code;
6098 (* Expecting to receive further files (FileOut)? *)
6102 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6103 pr " guestfs___end_busy (g);\n";
6104 pr " return %s;\n" error_code;
6110 pr " guestfs___end_busy (g);\n";
6112 (match fst style with
6113 | RErr -> pr " return 0;\n"
6114 | RInt n | RInt64 n | RBool n ->
6115 pr " return ret.%s;\n" n
6116 | RConstString _ | RConstOptString _ ->
6117 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6119 pr " return ret.%s; /* caller will free */\n" n
6120 | RStringList n | RHashtable n ->
6121 pr " /* caller will free this, but we need to add a NULL entry */\n";
6122 pr " ret.%s.%s_val =\n" n n;
6123 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6124 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6126 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6127 pr " return ret.%s.%s_val;\n" n n
6129 pr " /* caller will free this */\n";
6130 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6131 | RStructList (n, _) ->
6132 pr " /* caller will free this */\n";
6133 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6135 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6136 pr " * _val might be NULL here. To make the API saner for\n";
6137 pr " * callers, we turn this case into a unique pointer (using\n";
6138 pr " * malloc(1)).\n";
6140 pr " if (ret.%s.%s_len > 0) {\n" n n;
6141 pr " *size_r = ret.%s.%s_len;\n" n n;
6142 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6144 pr " free (ret.%s.%s_val);\n" n n;
6145 pr " char *p = safe_malloc (g, 1);\n";
6146 pr " *size_r = ret.%s.%s_len;\n" n n;
6154 (* Functions to free structures. *)
6155 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6156 pr " * structure format is identical to the XDR format. See note in\n";
6157 pr " * generator.ml.\n";
6164 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6166 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6172 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6174 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6181 (* Generate daemon/actions.h. *)
6182 and generate_daemon_actions_h () =
6183 generate_header CStyle GPLv2plus;
6185 pr "#include \"../src/guestfs_protocol.h\"\n";
6189 fun (name, style, _, _, _, _, _) ->
6191 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6195 (* Generate the linker script which controls the visibility of
6196 * symbols in the public ABI and ensures no other symbols get
6197 * exported accidentally.
6199 and generate_linker_script () =
6200 generate_header HashStyle GPLv2plus;
6205 "guestfs_get_error_handler";
6206 "guestfs_get_out_of_memory_handler";
6207 "guestfs_last_error";
6208 "guestfs_set_error_handler";
6209 "guestfs_set_launch_done_callback";
6210 "guestfs_set_log_message_callback";
6211 "guestfs_set_out_of_memory_handler";
6212 "guestfs_set_subprocess_quit_callback";
6214 (* Unofficial parts of the API: the bindings code use these
6215 * functions, so it is useful to export them.
6217 "guestfs_safe_calloc";
6218 "guestfs_safe_malloc";
6221 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6225 List.map (fun (typ, _) ->
6226 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6229 let globals = List.sort compare (globals @ functions @ structs) in
6233 List.iter (pr " %s;\n") globals;
6240 (* Generate the server-side stubs. *)
6241 and generate_daemon_actions () =
6242 generate_header CStyle GPLv2plus;
6244 pr "#include <config.h>\n";
6246 pr "#include <stdio.h>\n";
6247 pr "#include <stdlib.h>\n";
6248 pr "#include <string.h>\n";
6249 pr "#include <inttypes.h>\n";
6250 pr "#include <rpc/types.h>\n";
6251 pr "#include <rpc/xdr.h>\n";
6253 pr "#include \"daemon.h\"\n";
6254 pr "#include \"c-ctype.h\"\n";
6255 pr "#include \"../src/guestfs_protocol.h\"\n";
6256 pr "#include \"actions.h\"\n";
6260 fun (name, style, _, _, _, _, _) ->
6261 (* Generate server-side stubs. *)
6262 pr "static void %s_stub (XDR *xdr_in)\n" name;
6265 match fst style with
6266 | RErr | RInt _ -> pr " int r;\n"; "-1"
6267 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6268 | RBool _ -> pr " int r;\n"; "-1"
6269 | RConstString _ | RConstOptString _ ->
6270 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6271 | RString _ -> pr " char *r;\n"; "NULL"
6272 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6273 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6274 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6276 pr " size_t size = 1;\n";
6280 (match snd style with
6283 pr " struct guestfs_%s_args args;\n" name;
6286 | Device n | Dev_or_Path n
6289 | OptString n -> pr " char *%s;\n" n
6290 | StringList n | DeviceList n -> pr " char **%s;\n" n
6291 | Bool n -> pr " int %s;\n" n
6292 | Int n -> pr " int %s;\n" n
6293 | Int64 n -> pr " int64_t %s;\n" n
6294 | FileIn _ | FileOut _ -> ()
6296 pr " const char *%s;\n" n;
6297 pr " size_t %s_size;\n" n
6303 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6305 (match snd style with
6308 pr " memset (&args, 0, sizeof args);\n";
6310 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6312 pr " if (cancel_receive () != -2)\n";
6313 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6317 pr " char *%s = args.%s;\n" n n
6319 let pr_list_handling_code n =
6320 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6321 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6322 pr " if (%s == NULL) {\n" n;
6324 pr " if (cancel_receive () != -2)\n";
6325 pr " reply_with_perror (\"realloc\");\n";
6328 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6329 pr " args.%s.%s_val = %s;\n" n n n;
6335 pr " ABS_PATH (%s, %s, goto done);\n"
6336 n (if is_filein then "cancel_receive ()" else "0");
6339 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6340 n (if is_filein then "cancel_receive ()" else "0");
6343 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6344 n (if is_filein then "cancel_receive ()" else "0");
6345 | String n -> pr_args n
6346 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6348 pr_list_handling_code n;
6350 pr_list_handling_code n;
6351 pr " /* Ensure that each is a device,\n";
6352 pr " * and perform device name translation. */\n";
6353 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6354 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6355 (if is_filein then "cancel_receive ()" else "0");
6357 | Bool n -> pr " %s = args.%s;\n" n n
6358 | Int n -> pr " %s = args.%s;\n" n n
6359 | Int64 n -> pr " %s = args.%s;\n" n n
6360 | FileIn _ | FileOut _ -> ()
6362 pr " %s = args.%s.%s_val;\n" n n n;
6363 pr " %s_size = args.%s.%s_len;\n" n n n
6368 (* this is used at least for do_equal *)
6369 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6370 (* Emit NEED_ROOT just once, even when there are two or
6371 more Pathname args *)
6372 pr " NEED_ROOT (%s, goto done);\n"
6373 (if is_filein then "cancel_receive ()" else "0");
6376 (* Don't want to call the impl with any FileIn or FileOut
6377 * parameters, since these go "outside" the RPC protocol.
6380 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6382 pr " r = do_%s " name;
6383 generate_c_call_args (fst style, args');
6386 (match fst style with
6387 | RErr | RInt _ | RInt64 _ | RBool _
6388 | RConstString _ | RConstOptString _
6389 | RString _ | RStringList _ | RHashtable _
6390 | RStruct (_, _) | RStructList (_, _) ->
6391 pr " if (r == %s)\n" error_code;
6392 pr " /* do_%s has already called reply_with_error */\n" name;
6396 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6397 pr " * an ordinary zero-length buffer), so be careful ...\n";
6399 pr " if (size == 1 && r == %s)\n" error_code;
6400 pr " /* do_%s has already called reply_with_error */\n" name;
6405 (* If there are any FileOut parameters, then the impl must
6406 * send its own reply.
6409 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6411 pr " /* do_%s has already sent a reply */\n" name
6413 match fst style with
6414 | RErr -> pr " reply (NULL, NULL);\n"
6415 | RInt n | RInt64 n | RBool n ->
6416 pr " struct guestfs_%s_ret ret;\n" name;
6417 pr " ret.%s = r;\n" n;
6418 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6420 | RConstString _ | RConstOptString _ ->
6421 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6423 pr " struct guestfs_%s_ret ret;\n" name;
6424 pr " ret.%s = r;\n" n;
6425 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6428 | RStringList n | RHashtable n ->
6429 pr " struct guestfs_%s_ret ret;\n" name;
6430 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6431 pr " ret.%s.%s_val = r;\n" n n;
6432 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6434 pr " free_strings (r);\n"
6436 pr " struct guestfs_%s_ret ret;\n" name;
6437 pr " ret.%s = *r;\n" n;
6438 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6440 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6442 | RStructList (n, _) ->
6443 pr " struct guestfs_%s_ret ret;\n" name;
6444 pr " ret.%s = *r;\n" n;
6445 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6447 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6450 pr " struct guestfs_%s_ret ret;\n" name;
6451 pr " ret.%s.%s_val = r;\n" n n;
6452 pr " ret.%s.%s_len = size;\n" n n;
6453 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6458 (* Free the args. *)
6460 (match snd style with
6463 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6470 (* Dispatch function. *)
6471 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6473 pr " switch (proc_nr) {\n";
6476 fun (name, style, _, _, _, _, _) ->
6477 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6478 pr " %s_stub (xdr_in);\n" name;
6483 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";
6488 (* LVM columns and tokenization functions. *)
6489 (* XXX This generates crap code. We should rethink how we
6495 pr "static const char *lvm_%s_cols = \"%s\";\n"
6496 typ (String.concat "," (List.map fst cols));
6499 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6501 pr " char *tok, *p, *next;\n";
6505 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6508 pr " if (!str) {\n";
6509 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6512 pr " if (!*str || c_isspace (*str)) {\n";
6513 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6518 fun (name, coltype) ->
6519 pr " if (!tok) {\n";
6520 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6523 pr " p = strchrnul (tok, ',');\n";
6524 pr " if (*p) next = p+1; else next = NULL;\n";
6525 pr " *p = '\\0';\n";
6528 pr " r->%s = strdup (tok);\n" name;
6529 pr " if (r->%s == NULL) {\n" name;
6530 pr " perror (\"strdup\");\n";
6534 pr " for (i = j = 0; i < 32; ++j) {\n";
6535 pr " if (tok[j] == '\\0') {\n";
6536 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6538 pr " } else if (tok[j] != '-')\n";
6539 pr " r->%s[i++] = tok[j];\n" name;
6542 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6543 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6547 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6548 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6552 pr " if (tok[0] == '\\0')\n";
6553 pr " r->%s = -1;\n" name;
6554 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6555 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6558 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6559 assert false (* can never be an LVM column *)
6561 pr " tok = next;\n";
6564 pr " if (tok != NULL) {\n";
6565 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6572 pr "guestfs_int_lvm_%s_list *\n" typ;
6573 pr "parse_command_line_%ss (void)\n" typ;
6575 pr " char *out, *err;\n";
6576 pr " char *p, *pend;\n";
6578 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6579 pr " void *newp;\n";
6581 pr " ret = malloc (sizeof *ret);\n";
6582 pr " if (!ret) {\n";
6583 pr " reply_with_perror (\"malloc\");\n";
6584 pr " return NULL;\n";
6587 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6588 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6590 pr " r = command (&out, &err,\n";
6591 pr " \"lvm\", \"%ss\",\n" typ;
6592 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6593 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6594 pr " if (r == -1) {\n";
6595 pr " reply_with_error (\"%%s\", err);\n";
6596 pr " free (out);\n";
6597 pr " free (err);\n";
6598 pr " free (ret);\n";
6599 pr " return NULL;\n";
6602 pr " free (err);\n";
6604 pr " /* Tokenize each line of the output. */\n";
6607 pr " while (p) {\n";
6608 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6609 pr " if (pend) {\n";
6610 pr " *pend = '\\0';\n";
6614 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6617 pr " if (!*p) { /* Empty line? Skip it. */\n";
6622 pr " /* Allocate some space to store this next entry. */\n";
6623 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6624 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6625 pr " if (newp == NULL) {\n";
6626 pr " reply_with_perror (\"realloc\");\n";
6627 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6628 pr " free (ret);\n";
6629 pr " free (out);\n";
6630 pr " return NULL;\n";
6632 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6634 pr " /* Tokenize the next entry. */\n";
6635 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6636 pr " if (r == -1) {\n";
6637 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6638 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6639 pr " free (ret);\n";
6640 pr " free (out);\n";
6641 pr " return NULL;\n";
6648 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6650 pr " free (out);\n";
6651 pr " return ret;\n";
6654 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6656 (* Generate a list of function names, for debugging in the daemon.. *)
6657 and generate_daemon_names () =
6658 generate_header CStyle GPLv2plus;
6660 pr "#include <config.h>\n";
6662 pr "#include \"daemon.h\"\n";
6665 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6666 pr "const char *function_names[] = {\n";
6668 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6672 (* Generate the optional groups for the daemon to implement
6673 * guestfs_available.
6675 and generate_daemon_optgroups_c () =
6676 generate_header CStyle GPLv2plus;
6678 pr "#include <config.h>\n";
6680 pr "#include \"daemon.h\"\n";
6681 pr "#include \"optgroups.h\"\n";
6684 pr "struct optgroup optgroups[] = {\n";
6687 pr " { \"%s\", optgroup_%s_available },\n" group group
6689 pr " { NULL, NULL }\n";
6692 and generate_daemon_optgroups_h () =
6693 generate_header CStyle GPLv2plus;
6697 pr "extern int optgroup_%s_available (void);\n" group
6700 (* Generate the tests. *)
6701 and generate_tests () =
6702 generate_header CStyle GPLv2plus;
6709 #include <sys/types.h>
6712 #include \"guestfs.h\"
6713 #include \"guestfs-internal.h\"
6715 static guestfs_h *g;
6716 static int suppress_error = 0;
6718 static void print_error (guestfs_h *g, void *data, const char *msg)
6720 if (!suppress_error)
6721 fprintf (stderr, \"%%s\\n\", msg);
6724 /* FIXME: nearly identical code appears in fish.c */
6725 static void print_strings (char *const *argv)
6729 for (argc = 0; argv[argc] != NULL; ++argc)
6730 printf (\"\\t%%s\\n\", argv[argc]);
6734 static void print_table (char const *const *argv)
6738 for (i = 0; argv[i] != NULL; i += 2)
6739 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6745 (* Generate a list of commands which are not tested anywhere. *)
6746 pr "static void no_test_warnings (void)\n";
6749 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6751 fun (_, _, _, _, tests, _, _) ->
6752 let tests = filter_map (
6754 | (_, (Always|If _|Unless _), test) -> Some test
6755 | (_, Disabled, _) -> None
6757 let seq = List.concat (List.map seq_of_test tests) in
6758 let cmds_tested = List.map List.hd seq in
6759 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6763 fun (name, _, _, _, _, _, _) ->
6764 if not (Hashtbl.mem hash name) then
6765 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6771 (* Generate the actual tests. Note that we generate the tests
6772 * in reverse order, deliberately, so that (in general) the
6773 * newest tests run first. This makes it quicker and easier to
6778 fun (name, _, _, flags, tests, _, _) ->
6779 mapi (generate_one_test name flags) tests
6780 ) (List.rev all_functions) in
6781 let test_names = List.concat test_names in
6782 let nr_tests = List.length test_names in
6785 int main (int argc, char *argv[])
6788 unsigned long int n_failed = 0;
6789 const char *filename;
6791 int nr_tests, test_num = 0;
6793 setbuf (stdout, NULL);
6795 no_test_warnings ();
6797 g = guestfs_create ();
6799 printf (\"guestfs_create FAILED\\n\");
6800 exit (EXIT_FAILURE);
6803 guestfs_set_error_handler (g, print_error, NULL);
6805 guestfs_set_path (g, \"../appliance\");
6807 filename = \"test1.img\";
6808 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6811 exit (EXIT_FAILURE);
6813 if (lseek (fd, %d, SEEK_SET) == -1) {
6817 exit (EXIT_FAILURE);
6819 if (write (fd, &c, 1) == -1) {
6823 exit (EXIT_FAILURE);
6825 if (close (fd) == -1) {
6828 exit (EXIT_FAILURE);
6830 if (guestfs_add_drive (g, filename) == -1) {
6831 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6832 exit (EXIT_FAILURE);
6835 filename = \"test2.img\";
6836 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6839 exit (EXIT_FAILURE);
6841 if (lseek (fd, %d, SEEK_SET) == -1) {
6845 exit (EXIT_FAILURE);
6847 if (write (fd, &c, 1) == -1) {
6851 exit (EXIT_FAILURE);
6853 if (close (fd) == -1) {
6856 exit (EXIT_FAILURE);
6858 if (guestfs_add_drive (g, filename) == -1) {
6859 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6860 exit (EXIT_FAILURE);
6863 filename = \"test3.img\";
6864 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6867 exit (EXIT_FAILURE);
6869 if (lseek (fd, %d, SEEK_SET) == -1) {
6873 exit (EXIT_FAILURE);
6875 if (write (fd, &c, 1) == -1) {
6879 exit (EXIT_FAILURE);
6881 if (close (fd) == -1) {
6884 exit (EXIT_FAILURE);
6886 if (guestfs_add_drive (g, filename) == -1) {
6887 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6888 exit (EXIT_FAILURE);
6891 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6892 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6893 exit (EXIT_FAILURE);
6896 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6899 if (guestfs_launch (g) == -1) {
6900 printf (\"guestfs_launch FAILED\\n\");
6901 exit (EXIT_FAILURE);
6904 /* Cancel previous alarm. */
6909 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6913 pr " test_num++;\n";
6914 pr " if (guestfs_get_verbose (g))\n";
6915 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
6916 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6917 pr " if (%s () == -1) {\n" test_name;
6918 pr " printf (\"%s FAILED\\n\");\n" test_name;
6919 pr " n_failed++;\n";
6924 pr " guestfs_close (g);\n";
6925 pr " unlink (\"test1.img\");\n";
6926 pr " unlink (\"test2.img\");\n";
6927 pr " unlink (\"test3.img\");\n";
6930 pr " if (n_failed > 0) {\n";
6931 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6932 pr " exit (EXIT_FAILURE);\n";
6936 pr " exit (EXIT_SUCCESS);\n";
6939 and generate_one_test name flags i (init, prereq, test) =
6940 let test_name = sprintf "test_%s_%d" name i in
6943 static int %s_skip (void)
6947 str = getenv (\"TEST_ONLY\");
6949 return strstr (str, \"%s\") == NULL;
6950 str = getenv (\"SKIP_%s\");
6951 if (str && STREQ (str, \"1\")) return 1;
6952 str = getenv (\"SKIP_TEST_%s\");
6953 if (str && STREQ (str, \"1\")) return 1;
6957 " test_name name (String.uppercase test_name) (String.uppercase name);
6960 | Disabled | Always -> ()
6961 | If code | Unless code ->
6962 pr "static int %s_prereq (void)\n" test_name;
6970 static int %s (void)
6973 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6977 " test_name test_name test_name;
6979 (* Optional functions should only be tested if the relevant
6980 * support is available in the daemon.
6986 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6988 pr " suppress_error = 1;\n";
6989 pr " r = guestfs_available (g, (char **) groups);\n";
6990 pr " suppress_error = 0;\n";
6991 pr " if (r == -1) {\n";
6992 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
7001 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7003 pr " if (! %s_prereq ()) {\n" test_name;
7004 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7008 generate_one_test_body name i test_name init test;
7010 pr " if (%s_prereq ()) {\n" test_name;
7011 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7015 generate_one_test_body name i test_name init test;
7017 generate_one_test_body name i test_name init test
7025 and generate_one_test_body name i test_name init test =
7027 | InitNone (* XXX at some point, InitNone and InitEmpty became
7028 * folded together as the same thing. Really we should
7029 * make InitNone do nothing at all, but the tests may
7030 * need to be checked to make sure this is OK.
7033 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7034 List.iter (generate_test_command_call test_name)
7035 [["blockdev_setrw"; "/dev/sda"];
7039 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7040 List.iter (generate_test_command_call test_name)
7041 [["blockdev_setrw"; "/dev/sda"];
7044 ["part_disk"; "/dev/sda"; "mbr"]]
7046 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7047 List.iter (generate_test_command_call test_name)
7048 [["blockdev_setrw"; "/dev/sda"];
7051 ["part_disk"; "/dev/sda"; "mbr"];
7052 ["mkfs"; "ext2"; "/dev/sda1"];
7053 ["mount_options"; ""; "/dev/sda1"; "/"]]
7054 | InitBasicFSonLVM ->
7055 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7057 List.iter (generate_test_command_call test_name)
7058 [["blockdev_setrw"; "/dev/sda"];
7061 ["part_disk"; "/dev/sda"; "mbr"];
7062 ["pvcreate"; "/dev/sda1"];
7063 ["vgcreate"; "VG"; "/dev/sda1"];
7064 ["lvcreate"; "LV"; "VG"; "8"];
7065 ["mkfs"; "ext2"; "/dev/VG/LV"];
7066 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7068 pr " /* InitISOFS for %s */\n" test_name;
7069 List.iter (generate_test_command_call test_name)
7070 [["blockdev_setrw"; "/dev/sda"];
7073 ["mount_ro"; "/dev/sdd"; "/"]]
7076 let get_seq_last = function
7078 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7081 let seq = List.rev seq in
7082 List.rev (List.tl seq), List.hd seq
7087 pr " /* TestRun for %s (%d) */\n" name i;
7088 List.iter (generate_test_command_call test_name) seq
7089 | TestOutput (seq, expected) ->
7090 pr " /* TestOutput for %s (%d) */\n" name i;
7091 pr " const char *expected = \"%s\";\n" (c_quote expected);
7092 let seq, last = get_seq_last seq in
7094 pr " if (STRNEQ (r, expected)) {\n";
7095 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7099 List.iter (generate_test_command_call test_name) seq;
7100 generate_test_command_call ~test test_name last
7101 | TestOutputList (seq, expected) ->
7102 pr " /* TestOutputList for %s (%d) */\n" name i;
7103 let seq, last = get_seq_last seq in
7107 pr " if (!r[%d]) {\n" i;
7108 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7109 pr " print_strings (r);\n";
7113 pr " const char *expected = \"%s\";\n" (c_quote str);
7114 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7115 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7120 pr " if (r[%d] != NULL) {\n" (List.length expected);
7121 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7123 pr " print_strings (r);\n";
7127 List.iter (generate_test_command_call test_name) seq;
7128 generate_test_command_call ~test test_name last
7129 | TestOutputListOfDevices (seq, expected) ->
7130 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7131 let seq, last = get_seq_last seq in
7135 pr " if (!r[%d]) {\n" i;
7136 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7137 pr " print_strings (r);\n";
7141 pr " const char *expected = \"%s\";\n" (c_quote str);
7142 pr " r[%d][5] = 's';\n" i;
7143 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7144 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7149 pr " if (r[%d] != NULL) {\n" (List.length expected);
7150 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7152 pr " print_strings (r);\n";
7156 List.iter (generate_test_command_call test_name) seq;
7157 generate_test_command_call ~test test_name last
7158 | TestOutputInt (seq, expected) ->
7159 pr " /* TestOutputInt for %s (%d) */\n" name i;
7160 let seq, last = get_seq_last seq in
7162 pr " if (r != %d) {\n" expected;
7163 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7169 List.iter (generate_test_command_call test_name) seq;
7170 generate_test_command_call ~test test_name last
7171 | TestOutputIntOp (seq, op, expected) ->
7172 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7173 let seq, last = get_seq_last seq in
7175 pr " if (! (r %s %d)) {\n" op expected;
7176 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7177 test_name op expected;
7182 List.iter (generate_test_command_call test_name) seq;
7183 generate_test_command_call ~test test_name last
7184 | TestOutputTrue seq ->
7185 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7186 let seq, last = get_seq_last seq in
7189 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7194 List.iter (generate_test_command_call test_name) seq;
7195 generate_test_command_call ~test test_name last
7196 | TestOutputFalse seq ->
7197 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7198 let seq, last = get_seq_last seq in
7201 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7206 List.iter (generate_test_command_call test_name) seq;
7207 generate_test_command_call ~test test_name last
7208 | TestOutputLength (seq, expected) ->
7209 pr " /* TestOutputLength for %s (%d) */\n" name i;
7210 let seq, last = get_seq_last seq in
7213 pr " for (j = 0; j < %d; ++j)\n" expected;
7214 pr " if (r[j] == NULL) {\n";
7215 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7217 pr " print_strings (r);\n";
7220 pr " if (r[j] != NULL) {\n";
7221 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7223 pr " print_strings (r);\n";
7227 List.iter (generate_test_command_call test_name) seq;
7228 generate_test_command_call ~test test_name last
7229 | TestOutputBuffer (seq, expected) ->
7230 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7231 pr " const char *expected = \"%s\";\n" (c_quote expected);
7232 let seq, last = get_seq_last seq in
7233 let len = String.length expected in
7235 pr " if (size != %d) {\n" len;
7236 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7239 pr " if (STRNEQLEN (r, expected, size)) {\n";
7240 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7244 List.iter (generate_test_command_call test_name) seq;
7245 generate_test_command_call ~test test_name last
7246 | TestOutputStruct (seq, checks) ->
7247 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7248 let seq, last = get_seq_last seq in
7252 | CompareWithInt (field, expected) ->
7253 pr " if (r->%s != %d) {\n" field expected;
7254 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7255 test_name field expected;
7256 pr " (int) r->%s);\n" field;
7259 | CompareWithIntOp (field, op, expected) ->
7260 pr " if (!(r->%s %s %d)) {\n" field op expected;
7261 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7262 test_name field op expected;
7263 pr " (int) r->%s);\n" field;
7266 | CompareWithString (field, expected) ->
7267 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7268 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7269 test_name field expected;
7270 pr " r->%s);\n" field;
7273 | CompareFieldsIntEq (field1, field2) ->
7274 pr " if (r->%s != r->%s) {\n" field1 field2;
7275 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7276 test_name field1 field2;
7277 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7280 | CompareFieldsStrEq (field1, field2) ->
7281 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7282 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7283 test_name field1 field2;
7284 pr " r->%s, r->%s);\n" field1 field2;
7289 List.iter (generate_test_command_call test_name) seq;
7290 generate_test_command_call ~test test_name last
7291 | TestLastFail seq ->
7292 pr " /* TestLastFail for %s (%d) */\n" name i;
7293 let seq, last = get_seq_last seq in
7294 List.iter (generate_test_command_call test_name) seq;
7295 generate_test_command_call test_name ~expect_error:true last
7297 (* Generate the code to run a command, leaving the result in 'r'.
7298 * If you expect to get an error then you should set expect_error:true.
7300 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7302 | [] -> assert false
7304 (* Look up the command to find out what args/ret it has. *)
7307 let _, style, _, _, _, _, _ =
7308 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7311 failwithf "%s: in test, command %s was not found" test_name name in
7313 if List.length (snd style) <> List.length args then
7314 failwithf "%s: in test, wrong number of args given to %s"
7321 | OptString n, "NULL" -> ()
7324 | Dev_or_Path n, arg
7326 | OptString n, arg ->
7327 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7328 | BufferIn n, arg ->
7329 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7330 pr " size_t %s_size = %d;\n" n (String.length arg)
7334 | FileIn _, _ | FileOut _, _ -> ()
7335 | StringList n, "" | DeviceList n, "" ->
7336 pr " const char *const %s[1] = { NULL };\n" n
7337 | StringList n, arg | DeviceList n, arg ->
7338 let strs = string_split " " arg in
7341 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7343 pr " const char *const %s[] = {\n" n;
7345 fun i _ -> pr " %s_%d,\n" n i
7349 ) (List.combine (snd style) args);
7352 match fst style with
7353 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7354 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7355 | RConstString _ | RConstOptString _ ->
7356 pr " const char *r;\n"; "NULL"
7357 | RString _ -> pr " char *r;\n"; "NULL"
7358 | RStringList _ | RHashtable _ ->
7362 | RStruct (_, typ) ->
7363 pr " struct guestfs_%s *r;\n" typ; "NULL"
7364 | RStructList (_, typ) ->
7365 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7368 pr " size_t size;\n";
7371 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7372 pr " r = guestfs_%s (g" name;
7374 (* Generate the parameters. *)
7377 | OptString _, "NULL" -> pr ", NULL"
7379 | Device n, _ | Dev_or_Path n, _
7384 pr ", %s, %s_size" n n
7385 | FileIn _, arg | FileOut _, arg ->
7386 pr ", \"%s\"" (c_quote arg)
7387 | StringList n, _ | DeviceList n, _ ->
7388 pr ", (char **) %s" n
7391 try int_of_string arg
7392 with Failure "int_of_string" ->
7393 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7397 try Int64.of_string arg
7398 with Failure "int_of_string" ->
7399 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7402 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7403 ) (List.combine (snd style) args);
7405 (match fst style with
7406 | RBufferOut _ -> pr ", &size"
7412 if not expect_error then
7413 pr " if (r == %s)\n" error_code
7415 pr " if (r != %s)\n" error_code;
7418 (* Insert the test code. *)
7424 (match fst style with
7425 | RErr | RInt _ | RInt64 _ | RBool _
7426 | RConstString _ | RConstOptString _ -> ()
7427 | RString _ | RBufferOut _ -> pr " free (r);\n"
7428 | RStringList _ | RHashtable _ ->
7429 pr " for (i = 0; r[i] != NULL; ++i)\n";
7430 pr " free (r[i]);\n";
7432 | RStruct (_, typ) ->
7433 pr " guestfs_free_%s (r);\n" typ
7434 | RStructList (_, typ) ->
7435 pr " guestfs_free_%s_list (r);\n" typ
7441 let str = replace_str str "\r" "\\r" in
7442 let str = replace_str str "\n" "\\n" in
7443 let str = replace_str str "\t" "\\t" in
7444 let str = replace_str str "\000" "\\0" in
7447 (* Generate a lot of different functions for guestfish. *)
7448 and generate_fish_cmds () =
7449 generate_header CStyle GPLv2plus;
7453 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7455 let all_functions_sorted =
7457 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7458 ) all_functions_sorted in
7460 pr "#include <config.h>\n";
7462 pr "#include <stdio.h>\n";
7463 pr "#include <stdlib.h>\n";
7464 pr "#include <string.h>\n";
7465 pr "#include <inttypes.h>\n";
7467 pr "#include <guestfs.h>\n";
7468 pr "#include \"c-ctype.h\"\n";
7469 pr "#include \"full-write.h\"\n";
7470 pr "#include \"xstrtol.h\"\n";
7471 pr "#include \"fish.h\"\n";
7473 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7474 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7477 (* list_commands function, which implements guestfish -h *)
7478 pr "void list_commands (void)\n";
7480 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7481 pr " list_builtin_commands ();\n";
7483 fun (name, _, _, flags, _, shortdesc, _) ->
7484 let name = replace_char name '_' '-' in
7485 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7487 ) all_functions_sorted;
7488 pr " printf (\" %%s\\n\",";
7489 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7493 (* display_command function, which implements guestfish -h cmd *)
7494 pr "void display_command (const char *cmd)\n";
7497 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7498 let name2 = replace_char name '_' '-' in
7500 try find_map (function FishAlias n -> Some n | _ -> None) flags
7501 with Not_found -> name in
7502 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7504 match snd style with
7508 name2 (String.concat " " (List.map name_of_argt args)) in
7511 if List.mem ProtocolLimitWarning flags then
7512 ("\n\n" ^ protocol_limit_warning)
7515 (* For DangerWillRobinson commands, we should probably have
7516 * guestfish prompt before allowing you to use them (especially
7517 * in interactive mode). XXX
7521 if List.mem DangerWillRobinson flags then
7522 ("\n\n" ^ danger_will_robinson)
7527 match deprecation_notice flags with
7529 | Some txt -> "\n\n" ^ txt in
7531 let describe_alias =
7532 if name <> alias then
7533 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7537 pr "STRCASEEQ (cmd, \"%s\")" name;
7538 if name <> name2 then
7539 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7540 if name <> alias then
7541 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7543 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7545 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7546 "=head1 DESCRIPTION\n\n" ^
7547 longdesc ^ warnings ^ describe_alias);
7550 pr " display_builtin_command (cmd);\n";
7554 let emit_print_list_function typ =
7555 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7558 pr " unsigned int i;\n";
7560 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7561 pr " printf (\"[%%d] = {\\n\", i);\n";
7562 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7563 pr " printf (\"}\\n\");\n";
7569 (* print_* functions *)
7573 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7575 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7578 pr " unsigned int i;\n";
7584 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7586 pr " printf (\"%%s%s: \", indent);\n" name;
7587 pr " for (i = 0; i < 32; ++i)\n";
7588 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7589 pr " printf (\"\\n\");\n"
7591 pr " printf (\"%%s%s: \", indent);\n" name;
7592 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7593 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7594 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7596 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7597 pr " printf (\"\\n\");\n"
7598 | name, (FUInt64|FBytes) ->
7599 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7602 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7605 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7608 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7611 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7613 | name, FOptPercent ->
7614 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7615 typ name name typ name;
7616 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7622 (* Emit a print_TYPE_list function definition only if that function is used. *)
7625 | typ, (RStructListOnly | RStructAndList) ->
7626 (* generate the function for typ *)
7627 emit_print_list_function typ
7628 | typ, _ -> () (* empty *)
7629 ) (rstructs_used_by all_functions);
7631 (* Emit a print_TYPE function definition only if that function is used. *)
7634 | typ, (RStructOnly | RStructAndList) ->
7635 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7637 pr " print_%s_indent (%s, \"\");\n" typ typ;
7640 | typ, _ -> () (* empty *)
7641 ) (rstructs_used_by all_functions);
7643 (* run_<action> actions *)
7645 fun (name, style, _, flags, _, _, _) ->
7646 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7648 (match fst style with
7651 | RBool _ -> pr " int r;\n"
7652 | RInt64 _ -> pr " int64_t r;\n"
7653 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7654 | RString _ -> pr " char *r;\n"
7655 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7656 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7657 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7660 pr " size_t size;\n";
7666 | OptString n -> pr " const char *%s;\n" n
7670 | FileOut n -> pr " char *%s;\n" n
7672 pr " const char *%s;\n" n;
7673 pr " size_t %s_size;\n" n
7674 | StringList n | DeviceList n -> pr " char **%s;\n" n
7675 | Bool n -> pr " int %s;\n" n
7676 | Int n -> pr " int %s;\n" n
7677 | Int64 n -> pr " int64_t %s;\n" n
7680 (* Check and convert parameters. *)
7681 let argc_expected = List.length (snd style) in
7682 pr " if (argc != %d) {\n" argc_expected;
7683 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7685 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7689 let parse_integer fn fntyp rtyp range name i =
7691 pr " strtol_error xerr;\n";
7692 pr " %s r;\n" fntyp;
7694 pr " xerr = %s (argv[%d], NULL, 0, &r, xstrtol_suffixes);\n" fn i;
7695 pr " if (xerr != LONGINT_OK) {\n";
7696 pr " fprintf (stderr,\n";
7697 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7698 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7703 | Some (min, max, comment) ->
7704 pr " /* %s */\n" comment;
7705 pr " if (r < %s || r > %s) {\n" min max;
7706 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7710 pr " /* The check above should ensure this assignment does not overflow. */\n";
7712 pr " %s = r;\n" name;
7721 pr " %s = argv[%d];\n" name i
7723 | Dev_or_Path name ->
7724 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7725 pr " if (%s == NULL) return -1;\n" name
7727 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7730 pr " %s = argv[%d];\n" name i;
7731 pr " %s_size = strlen (argv[%d]);\n" name i
7733 pr " %s = file_in (argv[%d]);\n" name i;
7734 pr " if (%s == NULL) return -1;\n" name
7736 pr " %s = file_out (argv[%d]);\n" name i;
7737 pr " if (%s == NULL) return -1;\n" name
7738 | StringList name | DeviceList name ->
7739 pr " %s = parse_string_list (argv[%d]);\n" name i;
7740 pr " if (%s == NULL) return -1;\n" name;
7742 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7745 let min = "(-(2LL<<30))"
7746 and max = "((2LL<<30)-1)"
7748 "The Int type in the generator is a signed 31 bit int." in
7749 Some (min, max, comment) in
7750 parse_integer "xstrtoll" "long long" "int" range name i
7752 parse_integer "xstrtoll" "long long" "int64_t" None name i
7755 (* Call C API function. *)
7756 pr " r = guestfs_%s " name;
7757 generate_c_call_args ~handle:"g" style;
7762 | Device name | String name
7763 | OptString name | Bool name
7764 | Int name | Int64 name
7765 | BufferIn name -> ()
7766 | Pathname name | Dev_or_Path name | FileOut name ->
7767 pr " free (%s);\n" name
7769 pr " free_file_in (%s);\n" name
7770 | StringList name | DeviceList name ->
7771 pr " free_strings (%s);\n" name
7774 (* Any output flags? *)
7776 let flags = filter_map (
7777 function FishOutput flag -> Some flag | _ -> None
7783 failwithf "%s: more than one FishOutput flag is not allowed" name in
7785 (* Check return value for errors and display command results. *)
7786 (match fst style with
7787 | RErr -> pr " return r;\n"
7789 pr " if (r == -1) return -1;\n";
7790 (match fish_output with
7792 pr " printf (\"%%d\\n\", r);\n";
7793 | Some FishOutputOctal ->
7794 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7795 | Some FishOutputHexadecimal ->
7796 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7799 pr " if (r == -1) return -1;\n";
7800 (match fish_output with
7802 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7803 | Some FishOutputOctal ->
7804 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7805 | Some FishOutputHexadecimal ->
7806 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7809 pr " if (r == -1) return -1;\n";
7810 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7813 pr " if (r == NULL) return -1;\n";
7814 pr " printf (\"%%s\\n\", r);\n";
7816 | RConstOptString _ ->
7817 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7820 pr " if (r == NULL) return -1;\n";
7821 pr " printf (\"%%s\\n\", r);\n";
7825 pr " if (r == NULL) return -1;\n";
7826 pr " print_strings (r);\n";
7827 pr " free_strings (r);\n";
7829 | RStruct (_, typ) ->
7830 pr " if (r == NULL) return -1;\n";
7831 pr " print_%s (r);\n" typ;
7832 pr " guestfs_free_%s (r);\n" typ;
7834 | RStructList (_, typ) ->
7835 pr " if (r == NULL) return -1;\n";
7836 pr " print_%s_list (r);\n" typ;
7837 pr " guestfs_free_%s_list (r);\n" typ;
7840 pr " if (r == NULL) return -1;\n";
7841 pr " print_table (r);\n";
7842 pr " free_strings (r);\n";
7845 pr " if (r == NULL) return -1;\n";
7846 pr " if (full_write (1, r, size) != size) {\n";
7847 pr " perror (\"write\");\n";
7858 (* run_action function *)
7859 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7862 fun (name, _, _, flags, _, _, _) ->
7863 let name2 = replace_char name '_' '-' in
7865 try find_map (function FishAlias n -> Some n | _ -> None) flags
7866 with Not_found -> name in
7868 pr "STRCASEEQ (cmd, \"%s\")" name;
7869 if name <> name2 then
7870 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7871 if name <> alias then
7872 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7874 pr " return run_%s (cmd, argc, argv);\n" name;
7878 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7879 pr " if (command_num == 1)\n";
7880 pr " extended_help_message ();\n";
7887 (* Readline completion for guestfish. *)
7888 and generate_fish_completion () =
7889 generate_header CStyle GPLv2plus;
7893 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7903 #ifdef HAVE_LIBREADLINE
7904 #include <readline/readline.h>
7909 #ifdef HAVE_LIBREADLINE
7911 static const char *const commands[] = {
7912 BUILTIN_COMMANDS_FOR_COMPLETION,
7915 (* Get the commands, including the aliases. They don't need to be
7916 * sorted - the generator() function just does a dumb linear search.
7920 fun (name, _, _, flags, _, _, _) ->
7921 let name2 = replace_char name '_' '-' in
7923 try find_map (function FishAlias n -> Some n | _ -> None) flags
7924 with Not_found -> name in
7926 if name <> alias then [name2; alias] else [name2]
7928 let commands = List.flatten commands in
7930 List.iter (pr " \"%s\",\n") commands;
7936 generator (const char *text, int state)
7938 static int index, len;
7943 len = strlen (text);
7946 rl_attempted_completion_over = 1;
7948 while ((name = commands[index]) != NULL) {
7950 if (STRCASEEQLEN (name, text, len))
7951 return strdup (name);
7957 #endif /* HAVE_LIBREADLINE */
7959 #ifdef HAVE_RL_COMPLETION_MATCHES
7960 #define RL_COMPLETION_MATCHES rl_completion_matches
7962 #ifdef HAVE_COMPLETION_MATCHES
7963 #define RL_COMPLETION_MATCHES completion_matches
7965 #endif /* else just fail if we don't have either symbol */
7968 do_completion (const char *text, int start, int end)
7970 char **matches = NULL;
7972 #ifdef HAVE_LIBREADLINE
7973 rl_completion_append_character = ' ';
7976 matches = RL_COMPLETION_MATCHES (text, generator);
7977 else if (complete_dest_paths)
7978 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7985 (* Generate the POD documentation for guestfish. *)
7986 and generate_fish_actions_pod () =
7987 let all_functions_sorted =
7989 fun (_, _, _, flags, _, _, _) ->
7990 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7991 ) all_functions_sorted in
7993 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7996 fun (name, style, _, flags, _, _, longdesc) ->
7998 Str.global_substitute rex (
8001 try Str.matched_group 1 s
8003 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8004 "C<" ^ replace_char sub '_' '-' ^ ">"
8006 let name = replace_char name '_' '-' in
8008 try find_map (function FishAlias n -> Some n | _ -> None) flags
8009 with Not_found -> name in
8011 pr "=head2 %s" name;
8012 if name <> alias then
8019 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
8020 | OptString n -> pr " %s" n
8021 | StringList n | DeviceList n -> pr " '%s ...'" n
8022 | Bool _ -> pr " true|false"
8023 | Int n -> pr " %s" n
8024 | Int64 n -> pr " %s" n
8025 | FileIn n | FileOut n -> pr " (%s|-)" n
8026 | BufferIn n -> pr " %s" n
8030 pr "%s\n\n" longdesc;
8032 if List.exists (function FileIn _ | FileOut _ -> true
8033 | _ -> false) (snd style) then
8034 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8036 if List.mem ProtocolLimitWarning flags then
8037 pr "%s\n\n" protocol_limit_warning;
8039 if List.mem DangerWillRobinson flags then
8040 pr "%s\n\n" danger_will_robinson;
8042 match deprecation_notice flags with
8044 | Some txt -> pr "%s\n\n" txt
8045 ) all_functions_sorted
8047 (* Generate a C function prototype. *)
8048 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8049 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8051 ?handle name style =
8052 if extern then pr "extern ";
8053 if static then pr "static ";
8054 (match fst style with
8056 | RInt _ -> pr "int "
8057 | RInt64 _ -> pr "int64_t "
8058 | RBool _ -> pr "int "
8059 | RConstString _ | RConstOptString _ -> pr "const char *"
8060 | RString _ | RBufferOut _ -> pr "char *"
8061 | RStringList _ | RHashtable _ -> pr "char **"
8062 | RStruct (_, typ) ->
8063 if not in_daemon then pr "struct guestfs_%s *" typ
8064 else pr "guestfs_int_%s *" typ
8065 | RStructList (_, typ) ->
8066 if not in_daemon then pr "struct guestfs_%s_list *" typ
8067 else pr "guestfs_int_%s_list *" typ
8069 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8070 pr "%s%s (" prefix name;
8071 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8074 let comma = ref false in
8077 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8081 if single_line then pr ", " else pr ",\n\t\t"
8088 | Device n | Dev_or_Path n
8092 pr "const char *%s" n
8093 | StringList n | DeviceList n ->
8095 pr "char *const *%s" n
8096 | Bool n -> next (); pr "int %s" n
8097 | Int n -> next (); pr "int %s" n
8098 | Int64 n -> next (); pr "int64_t %s" n
8101 if not in_daemon then (next (); pr "const char *%s" n)
8104 pr "const char *%s" n;
8106 pr "size_t %s_size" n
8108 if is_RBufferOut then (next (); pr "size_t *size_r");
8111 if semicolon then pr ";";
8112 if newline then pr "\n"
8114 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8115 and generate_c_call_args ?handle ?(decl = false) style =
8117 let comma = ref false in
8119 if !comma then pr ", ";
8124 | Some handle -> pr "%s" handle; comma := true
8130 pr "%s, %s_size" n n
8133 pr "%s" (name_of_argt arg)
8135 (* For RBufferOut calls, add implicit &size parameter. *)
8137 match fst style with
8145 (* Generate the OCaml bindings interface. *)
8146 and generate_ocaml_mli () =
8147 generate_header OCamlStyle LGPLv2plus;
8150 (** For API documentation you should refer to the C API
8151 in the guestfs(3) manual page. The OCaml API uses almost
8152 exactly the same calls. *)
8155 (** A [guestfs_h] handle. *)
8157 exception Error of string
8158 (** This exception is raised when there is an error. *)
8160 exception Handle_closed of string
8161 (** This exception is raised if you use a {!Guestfs.t} handle
8162 after calling {!close} on it. The string is the name of
8165 val create : unit -> t
8166 (** Create a {!Guestfs.t} handle. *)
8168 val close : t -> unit
8169 (** Close the {!Guestfs.t} handle and free up all resources used
8172 Handles are closed by the garbage collector when they become
8173 unreferenced, but callers can call this in order to provide
8174 predictable cleanup. *)
8177 generate_ocaml_structure_decls ();
8181 fun (name, style, _, _, _, shortdesc, _) ->
8182 generate_ocaml_prototype name style;
8183 pr "(** %s *)\n" shortdesc;
8185 ) all_functions_sorted
8187 (* Generate the OCaml bindings implementation. *)
8188 and generate_ocaml_ml () =
8189 generate_header OCamlStyle LGPLv2plus;
8194 exception Error of string
8195 exception Handle_closed of string
8197 external create : unit -> t = \"ocaml_guestfs_create\"
8198 external close : t -> unit = \"ocaml_guestfs_close\"
8200 (* Give the exceptions names, so they can be raised from the C code. *)
8202 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8203 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8207 generate_ocaml_structure_decls ();
8211 fun (name, style, _, _, _, shortdesc, _) ->
8212 generate_ocaml_prototype ~is_external:true name style;
8213 ) all_functions_sorted
8215 (* Generate the OCaml bindings C implementation. *)
8216 and generate_ocaml_c () =
8217 generate_header CStyle LGPLv2plus;
8224 #include <caml/config.h>
8225 #include <caml/alloc.h>
8226 #include <caml/callback.h>
8227 #include <caml/fail.h>
8228 #include <caml/memory.h>
8229 #include <caml/mlvalues.h>
8230 #include <caml/signals.h>
8232 #include <guestfs.h>
8234 #include \"guestfs_c.h\"
8236 /* Copy a hashtable of string pairs into an assoc-list. We return
8237 * the list in reverse order, but hashtables aren't supposed to be
8240 static CAMLprim value
8241 copy_table (char * const * argv)
8244 CAMLlocal5 (rv, pairv, kv, vv, cons);
8248 for (i = 0; argv[i] != NULL; i += 2) {
8249 kv = caml_copy_string (argv[i]);
8250 vv = caml_copy_string (argv[i+1]);
8251 pairv = caml_alloc (2, 0);
8252 Store_field (pairv, 0, kv);
8253 Store_field (pairv, 1, vv);
8254 cons = caml_alloc (2, 0);
8255 Store_field (cons, 1, rv);
8257 Store_field (cons, 0, pairv);
8265 (* Struct copy functions. *)
8267 let emit_ocaml_copy_list_function typ =
8268 pr "static CAMLprim value\n";
8269 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8271 pr " CAMLparam0 ();\n";
8272 pr " CAMLlocal2 (rv, v);\n";
8273 pr " unsigned int i;\n";
8275 pr " if (%ss->len == 0)\n" typ;
8276 pr " CAMLreturn (Atom (0));\n";
8278 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8279 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8280 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8281 pr " caml_modify (&Field (rv, i), v);\n";
8283 pr " CAMLreturn (rv);\n";
8291 let has_optpercent_col =
8292 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8294 pr "static CAMLprim value\n";
8295 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8297 pr " CAMLparam0 ();\n";
8298 if has_optpercent_col then
8299 pr " CAMLlocal3 (rv, v, v2);\n"
8301 pr " CAMLlocal2 (rv, v);\n";
8303 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8308 pr " v = caml_copy_string (%s->%s);\n" typ name
8310 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8311 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8314 pr " v = caml_alloc_string (32);\n";
8315 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8316 | name, (FBytes|FInt64|FUInt64) ->
8317 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8318 | name, (FInt32|FUInt32) ->
8319 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8320 | name, FOptPercent ->
8321 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8322 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8323 pr " v = caml_alloc (1, 0);\n";
8324 pr " Store_field (v, 0, v2);\n";
8325 pr " } else /* None */\n";
8326 pr " v = Val_int (0);\n";
8328 pr " v = Val_int (%s->%s);\n" typ name
8330 pr " Store_field (rv, %d, v);\n" i
8332 pr " CAMLreturn (rv);\n";
8337 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8340 | typ, (RStructListOnly | RStructAndList) ->
8341 (* generate the function for typ *)
8342 emit_ocaml_copy_list_function typ
8343 | typ, _ -> () (* empty *)
8344 ) (rstructs_used_by all_functions);
8348 fun (name, style, _, _, _, _, _) ->
8349 pr "/* Automatically generated wrapper for function\n";
8351 generate_ocaml_prototype name style;
8356 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8358 let needs_extra_vs =
8359 match fst style with RConstOptString _ -> true | _ -> false in
8361 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8362 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8363 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8366 pr "CAMLprim value\n";
8367 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8368 List.iter (pr ", value %s") (List.tl params);
8373 | [p1; p2; p3; p4; p5] ->
8374 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8375 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8376 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8377 pr " CAMLxparam%d (%s);\n"
8378 (List.length rest) (String.concat ", " rest)
8380 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8382 if not needs_extra_vs then
8383 pr " CAMLlocal1 (rv);\n"
8385 pr " CAMLlocal3 (rv, v, v2);\n";
8388 pr " guestfs_h *g = Guestfs_val (gv);\n";
8389 pr " if (g == NULL)\n";
8390 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8396 | Device n | Dev_or_Path n
8400 pr " const char *%s = String_val (%sv);\n" n n
8402 pr " const char *%s =\n" n;
8403 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8406 pr " const char *%s = String_val (%sv);\n" n n;
8407 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8408 | StringList n | DeviceList n ->
8409 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8411 pr " int %s = Bool_val (%sv);\n" n n
8413 pr " int %s = Int_val (%sv);\n" n n
8415 pr " int64_t %s = Int64_val (%sv);\n" n n
8418 match fst style with
8419 | RErr -> pr " int r;\n"; "-1"
8420 | RInt _ -> pr " int r;\n"; "-1"
8421 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8422 | RBool _ -> pr " int r;\n"; "-1"
8423 | RConstString _ | RConstOptString _ ->
8424 pr " const char *r;\n"; "NULL"
8425 | RString _ -> pr " char *r;\n"; "NULL"
8430 | RStruct (_, typ) ->
8431 pr " struct guestfs_%s *r;\n" typ; "NULL"
8432 | RStructList (_, typ) ->
8433 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8440 pr " size_t size;\n";
8444 pr " caml_enter_blocking_section ();\n";
8445 pr " r = guestfs_%s " name;
8446 generate_c_call_args ~handle:"g" style;
8448 pr " caml_leave_blocking_section ();\n";
8452 | StringList n | DeviceList n ->
8453 pr " ocaml_guestfs_free_strings (%s);\n" n;
8454 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8455 | Bool _ | Int _ | Int64 _
8456 | FileIn _ | FileOut _ | BufferIn _ -> ()
8459 pr " if (r == %s)\n" error_code;
8460 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8463 (match fst style with
8464 | RErr -> pr " rv = Val_unit;\n"
8465 | RInt _ -> pr " rv = Val_int (r);\n"
8467 pr " rv = caml_copy_int64 (r);\n"
8468 | RBool _ -> pr " rv = Val_bool (r);\n"
8470 pr " rv = caml_copy_string (r);\n"
8471 | RConstOptString _ ->
8472 pr " if (r) { /* Some string */\n";
8473 pr " v = caml_alloc (1, 0);\n";
8474 pr " v2 = caml_copy_string (r);\n";
8475 pr " Store_field (v, 0, v2);\n";
8476 pr " } else /* None */\n";
8477 pr " v = Val_int (0);\n";
8479 pr " rv = caml_copy_string (r);\n";
8482 pr " rv = caml_copy_string_array ((const char **) r);\n";
8483 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8485 | RStruct (_, typ) ->
8486 pr " rv = copy_%s (r);\n" typ;
8487 pr " guestfs_free_%s (r);\n" typ;
8488 | RStructList (_, typ) ->
8489 pr " rv = copy_%s_list (r);\n" typ;
8490 pr " guestfs_free_%s_list (r);\n" typ;
8492 pr " rv = copy_table (r);\n";
8493 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8496 pr " rv = caml_alloc_string (size);\n";
8497 pr " memcpy (String_val (rv), r, size);\n";
8500 pr " CAMLreturn (rv);\n";
8504 if List.length params > 5 then (
8505 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8506 pr "CAMLprim value ";
8507 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8508 pr "CAMLprim value\n";
8509 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8511 pr " return ocaml_guestfs_%s (argv[0]" name;
8512 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8517 ) all_functions_sorted
8519 and generate_ocaml_structure_decls () =
8522 pr "type %s = {\n" typ;
8525 | name, FString -> pr " %s : string;\n" name
8526 | name, FBuffer -> pr " %s : string;\n" name
8527 | name, FUUID -> pr " %s : string;\n" name
8528 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8529 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8530 | name, FChar -> pr " %s : char;\n" name
8531 | name, FOptPercent -> pr " %s : float option;\n" name
8537 and generate_ocaml_prototype ?(is_external = false) name style =
8538 if is_external then pr "external " else pr "val ";
8539 pr "%s : t -> " name;
8542 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8543 | BufferIn _ -> pr "string -> "
8544 | OptString _ -> pr "string option -> "
8545 | StringList _ | DeviceList _ -> pr "string array -> "
8546 | Bool _ -> pr "bool -> "
8547 | Int _ -> pr "int -> "
8548 | Int64 _ -> pr "int64 -> "
8550 (match fst style with
8551 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8552 | RInt _ -> pr "int"
8553 | RInt64 _ -> pr "int64"
8554 | RBool _ -> pr "bool"
8555 | RConstString _ -> pr "string"
8556 | RConstOptString _ -> pr "string option"
8557 | RString _ | RBufferOut _ -> pr "string"
8558 | RStringList _ -> pr "string array"
8559 | RStruct (_, typ) -> pr "%s" typ
8560 | RStructList (_, typ) -> pr "%s array" typ
8561 | RHashtable _ -> pr "(string * string) list"
8563 if is_external then (
8565 if List.length (snd style) + 1 > 5 then
8566 pr "\"ocaml_guestfs_%s_byte\" " name;
8567 pr "\"ocaml_guestfs_%s\"" name
8571 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8572 and generate_perl_xs () =
8573 generate_header CStyle LGPLv2plus;
8576 #include \"EXTERN.h\"
8580 #include <guestfs.h>
8583 #define PRId64 \"lld\"
8587 my_newSVll(long long val) {
8588 #ifdef USE_64_BIT_ALL
8589 return newSViv(val);
8593 len = snprintf(buf, 100, \"%%\" PRId64, val);
8594 return newSVpv(buf, len);
8599 #define PRIu64 \"llu\"
8603 my_newSVull(unsigned long long val) {
8604 #ifdef USE_64_BIT_ALL
8605 return newSVuv(val);
8609 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8610 return newSVpv(buf, len);
8614 /* http://www.perlmonks.org/?node_id=680842 */
8616 XS_unpack_charPtrPtr (SV *arg) {
8621 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8622 croak (\"array reference expected\");
8624 av = (AV *)SvRV (arg);
8625 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8627 croak (\"malloc failed\");
8629 for (i = 0; i <= av_len (av); i++) {
8630 SV **elem = av_fetch (av, i, 0);
8632 if (!elem || !*elem)
8633 croak (\"missing element in list\");
8635 ret[i] = SvPV_nolen (*elem);
8643 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8650 RETVAL = guestfs_create ();
8652 croak (\"could not create guestfs handle\");
8653 guestfs_set_error_handler (RETVAL, NULL, NULL);
8666 fun (name, style, _, _, _, _, _) ->
8667 (match fst style with
8668 | RErr -> pr "void\n"
8669 | RInt _ -> pr "SV *\n"
8670 | RInt64 _ -> pr "SV *\n"
8671 | RBool _ -> pr "SV *\n"
8672 | RConstString _ -> pr "SV *\n"
8673 | RConstOptString _ -> pr "SV *\n"
8674 | RString _ -> pr "SV *\n"
8675 | RBufferOut _ -> pr "SV *\n"
8677 | RStruct _ | RStructList _
8679 pr "void\n" (* all lists returned implictly on the stack *)
8681 (* Call and arguments. *)
8684 fun arg -> pr ", %s" (name_of_argt arg)
8687 pr " guestfs_h *g;\n";
8691 | Pathname n | Device n | Dev_or_Path n | String n
8692 | FileIn n | FileOut n ->
8695 pr " char *%s;\n" n;
8696 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8698 (* http://www.perlmonks.org/?node_id=554277
8699 * Note that the implicit handle argument means we have
8700 * to add 1 to the ST(x) operator.
8702 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8703 | StringList n | DeviceList n -> pr " char **%s;\n" n
8704 | Bool n -> pr " int %s;\n" n
8705 | Int n -> pr " int %s;\n" n
8706 | Int64 n -> pr " int64_t %s;\n" n
8709 let do_cleanups () =
8712 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8713 | Bool _ | Int _ | Int64 _
8714 | FileIn _ | FileOut _
8716 | StringList n | DeviceList n -> pr " free (%s);\n" n
8721 (match fst style with
8726 pr " r = guestfs_%s " name;
8727 generate_c_call_args ~handle:"g" style;
8730 pr " if (r == -1)\n";
8731 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8737 pr " %s = guestfs_%s " n name;
8738 generate_c_call_args ~handle:"g" style;
8741 pr " if (%s == -1)\n" n;
8742 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8743 pr " RETVAL = newSViv (%s);\n" n;
8748 pr " int64_t %s;\n" n;
8750 pr " %s = guestfs_%s " n name;
8751 generate_c_call_args ~handle:"g" style;
8754 pr " if (%s == -1)\n" n;
8755 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8756 pr " RETVAL = my_newSVll (%s);\n" n;
8761 pr " const char *%s;\n" n;
8763 pr " %s = guestfs_%s " n name;
8764 generate_c_call_args ~handle:"g" style;
8767 pr " if (%s == NULL)\n" n;
8768 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8769 pr " RETVAL = newSVpv (%s, 0);\n" n;
8772 | RConstOptString n ->
8774 pr " const char *%s;\n" n;
8776 pr " %s = guestfs_%s " n name;
8777 generate_c_call_args ~handle:"g" style;
8780 pr " if (%s == NULL)\n" n;
8781 pr " RETVAL = &PL_sv_undef;\n";
8783 pr " RETVAL = newSVpv (%s, 0);\n" n;
8788 pr " char *%s;\n" n;
8790 pr " %s = guestfs_%s " n name;
8791 generate_c_call_args ~handle:"g" style;
8794 pr " if (%s == NULL)\n" n;
8795 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8796 pr " RETVAL = newSVpv (%s, 0);\n" n;
8797 pr " free (%s);\n" n;
8800 | RStringList n | RHashtable n ->
8802 pr " char **%s;\n" n;
8805 pr " %s = guestfs_%s " n name;
8806 generate_c_call_args ~handle:"g" style;
8809 pr " if (%s == NULL)\n" n;
8810 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8811 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8812 pr " EXTEND (SP, n);\n";
8813 pr " for (i = 0; i < n; ++i) {\n";
8814 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8815 pr " free (%s[i]);\n" n;
8817 pr " free (%s);\n" n;
8818 | RStruct (n, typ) ->
8819 let cols = cols_of_struct typ in
8820 generate_perl_struct_code typ cols name style n do_cleanups
8821 | RStructList (n, typ) ->
8822 let cols = cols_of_struct typ in
8823 generate_perl_struct_list_code typ cols name style n do_cleanups
8826 pr " char *%s;\n" n;
8827 pr " size_t size;\n";
8829 pr " %s = guestfs_%s " n name;
8830 generate_c_call_args ~handle:"g" style;
8833 pr " if (%s == NULL)\n" n;
8834 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8835 pr " RETVAL = newSVpvn (%s, size);\n" n;
8836 pr " free (%s);\n" n;
8844 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8846 pr " struct guestfs_%s_list *%s;\n" typ n;
8850 pr " %s = guestfs_%s " n name;
8851 generate_c_call_args ~handle:"g" style;
8854 pr " if (%s == NULL)\n" n;
8855 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8856 pr " EXTEND (SP, %s->len);\n" n;
8857 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8858 pr " hv = newHV ();\n";
8862 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8863 name (String.length name) n name
8865 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8866 name (String.length name) n name
8868 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8869 name (String.length name) n name n name
8870 | name, (FBytes|FUInt64) ->
8871 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8872 name (String.length name) n name
8874 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8875 name (String.length name) n name
8876 | name, (FInt32|FUInt32) ->
8877 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8878 name (String.length name) n name
8880 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8881 name (String.length name) n name
8882 | name, FOptPercent ->
8883 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8884 name (String.length name) n name
8886 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8888 pr " guestfs_free_%s_list (%s);\n" typ n
8890 and generate_perl_struct_code typ cols name style n do_cleanups =
8892 pr " struct guestfs_%s *%s;\n" typ n;
8894 pr " %s = guestfs_%s " n name;
8895 generate_c_call_args ~handle:"g" style;
8898 pr " if (%s == NULL)\n" n;
8899 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8900 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8902 fun ((name, _) as col) ->
8903 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8907 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8910 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8913 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8915 | name, (FBytes|FUInt64) ->
8916 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8919 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8921 | name, (FInt32|FUInt32) ->
8922 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8925 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8927 | name, FOptPercent ->
8928 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8931 pr " free (%s);\n" n
8933 (* Generate Sys/Guestfs.pm. *)
8934 and generate_perl_pm () =
8935 generate_header HashStyle LGPLv2plus;
8942 Sys::Guestfs - Perl bindings for libguestfs
8948 my $h = Sys::Guestfs->new ();
8949 $h->add_drive ('guest.img');
8951 $h->mount ('/dev/sda1', '/');
8952 $h->touch ('/hello');
8957 The C<Sys::Guestfs> module provides a Perl XS binding to the
8958 libguestfs API for examining and modifying virtual machine
8961 Amongst the things this is good for: making batch configuration
8962 changes to guests, getting disk used/free statistics (see also:
8963 virt-df), migrating between virtualization systems (see also:
8964 virt-p2v), performing partial backups, performing partial guest
8965 clones, cloning guests and changing registry/UUID/hostname info, and
8968 Libguestfs uses Linux kernel and qemu code, and can access any type of
8969 guest filesystem that Linux and qemu can, including but not limited
8970 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8971 schemes, qcow, qcow2, vmdk.
8973 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8974 LVs, what filesystem is in each LV, etc.). It can also run commands
8975 in the context of the guest. Also you can access filesystems over
8978 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8979 functions for using libguestfs from Perl, including integration
8984 All errors turn into calls to C<croak> (see L<Carp(3)>).
8992 package Sys::Guestfs;
8997 # This version number changes whenever a new function
8998 # is added to the libguestfs API. It is not directly
8999 # related to the libguestfs version number.
9000 use vars qw($VERSION);
9004 XSLoader::load ('Sys::Guestfs');
9006 =item $h = Sys::Guestfs->new ();
9008 Create a new guestfs handle.
9014 my $class = ref ($proto) || $proto;
9016 my $self = Sys::Guestfs::_create ();
9017 bless $self, $class;
9023 (* Actions. We only need to print documentation for these as
9024 * they are pulled in from the XS code automatically.
9027 fun (name, style, _, flags, _, _, longdesc) ->
9028 if not (List.mem NotInDocs flags) then (
9029 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9031 generate_perl_prototype name style;
9033 pr "%s\n\n" longdesc;
9034 if List.mem ProtocolLimitWarning flags then
9035 pr "%s\n\n" protocol_limit_warning;
9036 if List.mem DangerWillRobinson flags then
9037 pr "%s\n\n" danger_will_robinson;
9038 match deprecation_notice flags with
9040 | Some txt -> pr "%s\n\n" txt
9042 ) all_functions_sorted;
9054 Copyright (C) %s Red Hat Inc.
9058 Please see the file COPYING.LIB for the full license.
9064 L<http://libguestfs.org>,
9065 L<Sys::Guestfs::Lib(3)>.
9070 and generate_perl_prototype name style =
9071 (match fst style with
9079 | RBufferOut n -> pr "$%s = " n
9081 | RHashtable n -> pr "%%%s = " n
9083 | RStructList (n,_) -> pr "@%s = " n
9086 let comma = ref false in
9089 if !comma then pr ", ";
9092 | Pathname n | Device n | Dev_or_Path n | String n
9093 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9096 | StringList n | DeviceList n ->
9101 (* Generate Python C module. *)
9102 and generate_python_c () =
9103 generate_header CStyle LGPLv2plus;
9106 #define PY_SSIZE_T_CLEAN 1
9113 #include \"guestfs.h\"
9121 get_handle (PyObject *obj)
9124 assert (obj != Py_None);
9125 return ((Pyguestfs_Object *) obj)->g;
9129 put_handle (guestfs_h *g)
9133 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9136 /* This list should be freed (but not the strings) after use. */
9138 get_string_list (PyObject *obj)
9145 if (!PyList_Check (obj)) {
9146 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9150 len = PyList_Size (obj);
9151 r = malloc (sizeof (char *) * (len+1));
9153 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9157 for (i = 0; i < len; ++i)
9158 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9165 put_string_list (char * const * const argv)
9170 for (argc = 0; argv[argc] != NULL; ++argc)
9173 list = PyList_New (argc);
9174 for (i = 0; i < argc; ++i)
9175 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9181 put_table (char * const * const argv)
9183 PyObject *list, *item;
9186 for (argc = 0; argv[argc] != NULL; ++argc)
9189 list = PyList_New (argc >> 1);
9190 for (i = 0; i < argc; i += 2) {
9191 item = PyTuple_New (2);
9192 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9193 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9194 PyList_SetItem (list, i >> 1, item);
9201 free_strings (char **argv)
9205 for (argc = 0; argv[argc] != NULL; ++argc)
9211 py_guestfs_create (PyObject *self, PyObject *args)
9215 g = guestfs_create ();
9217 PyErr_SetString (PyExc_RuntimeError,
9218 \"guestfs.create: failed to allocate handle\");
9221 guestfs_set_error_handler (g, NULL, NULL);
9222 return put_handle (g);
9226 py_guestfs_close (PyObject *self, PyObject *args)
9231 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9233 g = get_handle (py_g);
9237 Py_INCREF (Py_None);
9243 let emit_put_list_function typ =
9244 pr "static PyObject *\n";
9245 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9247 pr " PyObject *list;\n";
9250 pr " list = PyList_New (%ss->len);\n" typ;
9251 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9252 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9253 pr " return list;\n";
9258 (* Structures, turned into Python dictionaries. *)
9261 pr "static PyObject *\n";
9262 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9264 pr " PyObject *dict;\n";
9266 pr " dict = PyDict_New ();\n";
9270 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9271 pr " PyString_FromString (%s->%s));\n"
9274 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9275 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9278 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9279 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9281 | name, (FBytes|FUInt64) ->
9282 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9283 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9286 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9287 pr " PyLong_FromLongLong (%s->%s));\n"
9290 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9291 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9294 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9295 pr " PyLong_FromLong (%s->%s));\n"
9297 | name, FOptPercent ->
9298 pr " if (%s->%s >= 0)\n" typ name;
9299 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9300 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9303 pr " Py_INCREF (Py_None);\n";
9304 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9307 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9308 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9310 pr " return dict;\n";
9316 (* Emit a put_TYPE_list function definition only if that function is used. *)
9319 | typ, (RStructListOnly | RStructAndList) ->
9320 (* generate the function for typ *)
9321 emit_put_list_function typ
9322 | typ, _ -> () (* empty *)
9323 ) (rstructs_used_by all_functions);
9325 (* Python wrapper functions. *)
9327 fun (name, style, _, _, _, _, _) ->
9328 pr "static PyObject *\n";
9329 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9332 pr " PyObject *py_g;\n";
9333 pr " guestfs_h *g;\n";
9334 pr " PyObject *py_r;\n";
9337 match fst style with
9338 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9339 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9340 | RConstString _ | RConstOptString _ ->
9341 pr " const char *r;\n"; "NULL"
9342 | RString _ -> pr " char *r;\n"; "NULL"
9343 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9344 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9345 | RStructList (_, typ) ->
9346 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9349 pr " size_t size;\n";
9354 | Pathname n | Device n | Dev_or_Path n | String n
9355 | FileIn n | FileOut n ->
9356 pr " const char *%s;\n" n
9357 | OptString n -> pr " const char *%s;\n" n
9359 pr " const char *%s;\n" n;
9360 pr " Py_ssize_t %s_size;\n" n
9361 | StringList n | DeviceList n ->
9362 pr " PyObject *py_%s;\n" n;
9363 pr " char **%s;\n" n
9364 | Bool n -> pr " int %s;\n" n
9365 | Int n -> pr " int %s;\n" n
9366 | Int64 n -> pr " long long %s;\n" n
9371 (* Convert the parameters. *)
9372 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9375 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9376 | OptString _ -> pr "z"
9377 | StringList _ | DeviceList _ -> pr "O"
9378 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9380 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9381 * emulate C's int/long/long long in Python?
9383 | BufferIn _ -> pr "s#"
9385 pr ":guestfs_%s\",\n" name;
9389 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9390 | OptString n -> pr ", &%s" n
9391 | StringList n | DeviceList n -> pr ", &py_%s" n
9392 | Bool n -> pr ", &%s" n
9393 | Int n -> pr ", &%s" n
9394 | Int64 n -> pr ", &%s" n
9395 | BufferIn n -> pr ", &%s, &%s_size" n n
9399 pr " return NULL;\n";
9401 pr " g = get_handle (py_g);\n";
9404 | Pathname _ | Device _ | Dev_or_Path _ | String _
9405 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9407 | StringList n | DeviceList n ->
9408 pr " %s = get_string_list (py_%s);\n" n n;
9409 pr " if (!%s) return NULL;\n" n
9414 pr " r = guestfs_%s " name;
9415 generate_c_call_args ~handle:"g" style;
9420 | Pathname _ | Device _ | Dev_or_Path _ | String _
9421 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9423 | StringList n | DeviceList n ->
9424 pr " free (%s);\n" n
9427 pr " if (r == %s) {\n" error_code;
9428 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9429 pr " return NULL;\n";
9433 (match fst style with
9435 pr " Py_INCREF (Py_None);\n";
9436 pr " py_r = Py_None;\n"
9438 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9439 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9440 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9441 | RConstOptString _ ->
9443 pr " py_r = PyString_FromString (r);\n";
9445 pr " Py_INCREF (Py_None);\n";
9446 pr " py_r = Py_None;\n";
9449 pr " py_r = PyString_FromString (r);\n";
9452 pr " py_r = put_string_list (r);\n";
9453 pr " free_strings (r);\n"
9454 | RStruct (_, typ) ->
9455 pr " py_r = put_%s (r);\n" typ;
9456 pr " guestfs_free_%s (r);\n" typ
9457 | RStructList (_, typ) ->
9458 pr " py_r = put_%s_list (r);\n" typ;
9459 pr " guestfs_free_%s_list (r);\n" typ
9461 pr " py_r = put_table (r);\n";
9462 pr " free_strings (r);\n"
9464 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9468 pr " return py_r;\n";
9473 (* Table of functions. *)
9474 pr "static PyMethodDef methods[] = {\n";
9475 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9476 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9478 fun (name, _, _, _, _, _, _) ->
9479 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9482 pr " { NULL, NULL, 0, NULL }\n";
9486 (* Init function. *)
9489 initlibguestfsmod (void)
9491 static int initialized = 0;
9493 if (initialized) return;
9494 Py_InitModule ((char *) \"libguestfsmod\", methods);
9499 (* Generate Python module. *)
9500 and generate_python_py () =
9501 generate_header HashStyle LGPLv2plus;
9504 u\"\"\"Python bindings for libguestfs
9507 g = guestfs.GuestFS ()
9508 g.add_drive (\"guest.img\")
9510 parts = g.list_partitions ()
9512 The guestfs module provides a Python binding to the libguestfs API
9513 for examining and modifying virtual machine disk images.
9515 Amongst the things this is good for: making batch configuration
9516 changes to guests, getting disk used/free statistics (see also:
9517 virt-df), migrating between virtualization systems (see also:
9518 virt-p2v), performing partial backups, performing partial guest
9519 clones, cloning guests and changing registry/UUID/hostname info, and
9522 Libguestfs uses Linux kernel and qemu code, and can access any type of
9523 guest filesystem that Linux and qemu can, including but not limited
9524 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9525 schemes, qcow, qcow2, vmdk.
9527 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9528 LVs, what filesystem is in each LV, etc.). It can also run commands
9529 in the context of the guest. Also you can access filesystems over
9532 Errors which happen while using the API are turned into Python
9533 RuntimeError exceptions.
9535 To create a guestfs handle you usually have to perform the following
9538 # Create the handle, call add_drive at least once, and possibly
9539 # several times if the guest has multiple block devices:
9540 g = guestfs.GuestFS ()
9541 g.add_drive (\"guest.img\")
9543 # Launch the qemu subprocess and wait for it to become ready:
9546 # Now you can issue commands, for example:
9551 import libguestfsmod
9554 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9556 def __init__ (self):
9557 \"\"\"Create a new libguestfs handle.\"\"\"
9558 self._o = libguestfsmod.create ()
9561 libguestfsmod.close (self._o)
9566 fun (name, style, _, flags, _, _, longdesc) ->
9568 generate_py_call_args ~handle:"self" (snd style);
9571 if not (List.mem NotInDocs flags) then (
9572 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9574 match fst style with
9575 | RErr | RInt _ | RInt64 _ | RBool _
9576 | RConstOptString _ | RConstString _
9577 | RString _ | RBufferOut _ -> doc
9579 doc ^ "\n\nThis function returns a list of strings."
9580 | RStruct (_, typ) ->
9581 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9582 | RStructList (_, typ) ->
9583 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9585 doc ^ "\n\nThis function returns a dictionary." in
9587 if List.mem ProtocolLimitWarning flags then
9588 doc ^ "\n\n" ^ protocol_limit_warning
9591 if List.mem DangerWillRobinson flags then
9592 doc ^ "\n\n" ^ danger_will_robinson
9595 match deprecation_notice flags with
9597 | Some txt -> doc ^ "\n\n" ^ txt in
9598 let doc = pod2text ~width:60 name doc in
9599 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9600 let doc = String.concat "\n " doc in
9601 pr " u\"\"\"%s\"\"\"\n" doc;
9603 pr " return libguestfsmod.%s " name;
9604 generate_py_call_args ~handle:"self._o" (snd style);
9609 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9610 and generate_py_call_args ~handle args =
9612 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9615 (* Useful if you need the longdesc POD text as plain text. Returns a
9618 * Because this is very slow (the slowest part of autogeneration),
9619 * we memoize the results.
9621 and pod2text ~width name longdesc =
9622 let key = width, name, longdesc in
9623 try Hashtbl.find pod2text_memo key
9625 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9626 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9628 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9629 let chan = open_process_in cmd in
9630 let lines = ref [] in
9632 let line = input_line chan in
9633 if i = 1 then (* discard the first line of output *)
9636 let line = triml line in
9637 lines := line :: !lines;
9640 let lines = try loop 1 with End_of_file -> List.rev !lines in
9642 (match close_process_in chan with
9645 failwithf "pod2text: process exited with non-zero status (%d)" i
9646 | WSIGNALED i | WSTOPPED i ->
9647 failwithf "pod2text: process signalled or stopped by signal %d" i
9649 Hashtbl.add pod2text_memo key lines;
9650 pod2text_memo_updated ();
9653 (* Generate ruby bindings. *)
9654 and generate_ruby_c () =
9655 generate_header CStyle LGPLv2plus;
9663 #include \"guestfs.h\"
9665 #include \"extconf.h\"
9667 /* For Ruby < 1.9 */
9669 #define RARRAY_LEN(r) (RARRAY((r))->len)
9672 static VALUE m_guestfs; /* guestfs module */
9673 static VALUE c_guestfs; /* guestfs_h handle */
9674 static VALUE e_Error; /* used for all errors */
9676 static void ruby_guestfs_free (void *p)
9679 guestfs_close ((guestfs_h *) p);
9682 static VALUE ruby_guestfs_create (VALUE m)
9686 g = guestfs_create ();
9688 rb_raise (e_Error, \"failed to create guestfs handle\");
9690 /* Don't print error messages to stderr by default. */
9691 guestfs_set_error_handler (g, NULL, NULL);
9693 /* Wrap it, and make sure the close function is called when the
9696 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9699 static VALUE ruby_guestfs_close (VALUE gv)
9702 Data_Get_Struct (gv, guestfs_h, g);
9704 ruby_guestfs_free (g);
9705 DATA_PTR (gv) = NULL;
9713 fun (name, style, _, _, _, _, _) ->
9714 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9715 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9718 pr " guestfs_h *g;\n";
9719 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9721 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9727 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9728 pr " Check_Type (%sv, T_STRING);\n" n;
9729 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9731 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9732 pr " \"%s\", \"%s\");\n" n name
9734 pr " Check_Type (%sv, T_STRING);\n" n;
9735 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9737 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9738 pr " \"%s\", \"%s\");\n" n name;
9739 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9741 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9742 | StringList n | DeviceList n ->
9743 pr " char **%s;\n" n;
9744 pr " Check_Type (%sv, T_ARRAY);\n" n;
9746 pr " int i, len;\n";
9747 pr " len = RARRAY_LEN (%sv);\n" n;
9748 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9750 pr " for (i = 0; i < len; ++i) {\n";
9751 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9752 pr " %s[i] = StringValueCStr (v);\n" n;
9754 pr " %s[len] = NULL;\n" n;
9757 pr " int %s = RTEST (%sv);\n" n n
9759 pr " int %s = NUM2INT (%sv);\n" n n
9761 pr " long long %s = NUM2LL (%sv);\n" n n
9766 match fst style with
9767 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9768 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9769 | RConstString _ | RConstOptString _ ->
9770 pr " const char *r;\n"; "NULL"
9771 | RString _ -> pr " char *r;\n"; "NULL"
9772 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9773 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9774 | RStructList (_, typ) ->
9775 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9778 pr " size_t size;\n";
9782 pr " r = guestfs_%s " name;
9783 generate_c_call_args ~handle:"g" style;
9788 | Pathname _ | Device _ | Dev_or_Path _ | String _
9789 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9791 | StringList n | DeviceList n ->
9792 pr " free (%s);\n" n
9795 pr " if (r == %s)\n" error_code;
9796 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9799 (match fst style with
9801 pr " return Qnil;\n"
9802 | RInt _ | RBool _ ->
9803 pr " return INT2NUM (r);\n"
9805 pr " return ULL2NUM (r);\n"
9807 pr " return rb_str_new2 (r);\n";
9808 | RConstOptString _ ->
9810 pr " return rb_str_new2 (r);\n";
9812 pr " return Qnil;\n";
9814 pr " VALUE rv = rb_str_new2 (r);\n";
9818 pr " int i, len = 0;\n";
9819 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9820 pr " VALUE rv = rb_ary_new2 (len);\n";
9821 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9822 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9823 pr " free (r[i]);\n";
9827 | RStruct (_, typ) ->
9828 let cols = cols_of_struct typ in
9829 generate_ruby_struct_code typ cols
9830 | RStructList (_, typ) ->
9831 let cols = cols_of_struct typ in
9832 generate_ruby_struct_list_code typ cols
9834 pr " VALUE rv = rb_hash_new ();\n";
9836 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9837 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9838 pr " free (r[i]);\n";
9839 pr " free (r[i+1]);\n";
9844 pr " VALUE rv = rb_str_new (r, size);\n";
9854 /* Initialize the module. */
9855 void Init__guestfs ()
9857 m_guestfs = rb_define_module (\"Guestfs\");
9858 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9859 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9861 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9862 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9865 (* Define the rest of the methods. *)
9867 fun (name, style, _, _, _, _, _) ->
9868 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9869 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9874 (* Ruby code to return a struct. *)
9875 and generate_ruby_struct_code typ cols =
9876 pr " VALUE rv = rb_hash_new ();\n";
9880 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9882 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9884 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9885 | name, (FBytes|FUInt64) ->
9886 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9888 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9890 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9892 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9893 | name, FOptPercent ->
9894 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9895 | name, FChar -> (* XXX wrong? *)
9896 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9898 pr " guestfs_free_%s (r);\n" typ;
9901 (* Ruby code to return a struct list. *)
9902 and generate_ruby_struct_list_code typ cols =
9903 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9905 pr " for (i = 0; i < r->len; ++i) {\n";
9906 pr " VALUE hv = rb_hash_new ();\n";
9910 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9912 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
9914 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9915 | name, (FBytes|FUInt64) ->
9916 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9918 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9920 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9922 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9923 | name, FOptPercent ->
9924 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9925 | name, FChar -> (* XXX wrong? *)
9926 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9928 pr " rb_ary_push (rv, hv);\n";
9930 pr " guestfs_free_%s_list (r);\n" typ;
9933 (* Generate Java bindings GuestFS.java file. *)
9934 and generate_java_java () =
9935 generate_header CStyle LGPLv2plus;
9938 package com.redhat.et.libguestfs;
9940 import java.util.HashMap;
9941 import com.redhat.et.libguestfs.LibGuestFSException;
9942 import com.redhat.et.libguestfs.PV;
9943 import com.redhat.et.libguestfs.VG;
9944 import com.redhat.et.libguestfs.LV;
9945 import com.redhat.et.libguestfs.Stat;
9946 import com.redhat.et.libguestfs.StatVFS;
9947 import com.redhat.et.libguestfs.IntBool;
9948 import com.redhat.et.libguestfs.Dirent;
9951 * The GuestFS object is a libguestfs handle.
9955 public class GuestFS {
9956 // Load the native code.
9958 System.loadLibrary (\"guestfs_jni\");
9962 * The native guestfs_h pointer.
9967 * Create a libguestfs handle.
9969 * @throws LibGuestFSException
9971 public GuestFS () throws LibGuestFSException
9975 private native long _create () throws LibGuestFSException;
9978 * Close a libguestfs handle.
9980 * You can also leave handles to be collected by the garbage
9981 * collector, but this method ensures that the resources used
9982 * by the handle are freed up immediately. If you call any
9983 * other methods after closing the handle, you will get an
9986 * @throws LibGuestFSException
9988 public void close () throws LibGuestFSException
9994 private native void _close (long g) throws LibGuestFSException;
9996 public void finalize () throws LibGuestFSException
10004 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10005 if not (List.mem NotInDocs flags); then (
10006 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10008 if List.mem ProtocolLimitWarning flags then
10009 doc ^ "\n\n" ^ protocol_limit_warning
10012 if List.mem DangerWillRobinson flags then
10013 doc ^ "\n\n" ^ danger_will_robinson
10016 match deprecation_notice flags with
10018 | Some txt -> doc ^ "\n\n" ^ txt in
10019 let doc = pod2text ~width:60 name doc in
10020 let doc = List.map ( (* RHBZ#501883 *)
10023 | nonempty -> nonempty
10025 let doc = String.concat "\n * " doc in
10028 pr " * %s\n" shortdesc;
10031 pr " * @throws LibGuestFSException\n";
10035 generate_java_prototype ~public:true ~semicolon:false name style;
10038 pr " if (g == 0)\n";
10039 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10042 if fst style <> RErr then pr "return ";
10044 generate_java_call_args ~handle:"g" (snd style);
10048 generate_java_prototype ~privat:true ~native:true name style;
10055 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10056 and generate_java_call_args ~handle args =
10058 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10061 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10062 ?(semicolon=true) name style =
10063 if privat then pr "private ";
10064 if public then pr "public ";
10065 if native then pr "native ";
10068 (match fst style with
10069 | RErr -> pr "void ";
10070 | RInt _ -> pr "int ";
10071 | RInt64 _ -> pr "long ";
10072 | RBool _ -> pr "boolean ";
10073 | RConstString _ | RConstOptString _ | RString _
10074 | RBufferOut _ -> pr "String ";
10075 | RStringList _ -> pr "String[] ";
10076 | RStruct (_, typ) ->
10077 let name = java_name_of_struct typ in
10079 | RStructList (_, typ) ->
10080 let name = java_name_of_struct typ in
10082 | RHashtable _ -> pr "HashMap<String,String> ";
10085 if native then pr "_%s " name else pr "%s " name;
10087 let needs_comma = ref false in
10090 needs_comma := true
10096 if !needs_comma then pr ", ";
10097 needs_comma := true;
10101 | Device n | Dev_or_Path n
10109 | StringList n | DeviceList n ->
10120 pr " throws LibGuestFSException";
10121 if semicolon then pr ";"
10123 and generate_java_struct jtyp cols () =
10124 generate_header CStyle LGPLv2plus;
10127 package com.redhat.et.libguestfs;
10130 * Libguestfs %s structure.
10142 | name, FBuffer -> pr " public String %s;\n" name
10143 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10144 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10145 | name, FChar -> pr " public char %s;\n" name
10146 | name, FOptPercent ->
10147 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10148 pr " public float %s;\n" name
10153 and generate_java_c () =
10154 generate_header CStyle LGPLv2plus;
10158 #include <stdlib.h>
10159 #include <string.h>
10161 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10162 #include \"guestfs.h\"
10164 /* Note that this function returns. The exception is not thrown
10165 * until after the wrapper function returns.
10168 throw_exception (JNIEnv *env, const char *msg)
10171 cl = (*env)->FindClass (env,
10172 \"com/redhat/et/libguestfs/LibGuestFSException\");
10173 (*env)->ThrowNew (env, cl, msg);
10176 JNIEXPORT jlong JNICALL
10177 Java_com_redhat_et_libguestfs_GuestFS__1create
10178 (JNIEnv *env, jobject obj)
10182 g = guestfs_create ();
10184 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10187 guestfs_set_error_handler (g, NULL, NULL);
10188 return (jlong) (long) g;
10191 JNIEXPORT void JNICALL
10192 Java_com_redhat_et_libguestfs_GuestFS__1close
10193 (JNIEnv *env, jobject obj, jlong jg)
10195 guestfs_h *g = (guestfs_h *) (long) jg;
10202 fun (name, style, _, _, _, _, _) ->
10204 (match fst style with
10205 | RErr -> pr "void ";
10206 | RInt _ -> pr "jint ";
10207 | RInt64 _ -> pr "jlong ";
10208 | RBool _ -> pr "jboolean ";
10209 | RConstString _ | RConstOptString _ | RString _
10210 | RBufferOut _ -> pr "jstring ";
10211 | RStruct _ | RHashtable _ ->
10213 | RStringList _ | RStructList _ ->
10214 pr "jobjectArray ";
10217 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10218 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10220 pr " (JNIEnv *env, jobject obj, jlong jg";
10224 | Device n | Dev_or_Path n
10229 pr ", jstring j%s" n
10231 pr ", jbyteArray j%s" n
10232 | StringList n | DeviceList n ->
10233 pr ", jobjectArray j%s" n
10235 pr ", jboolean j%s" n
10243 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10244 let error_code, no_ret =
10245 match fst style with
10246 | RErr -> pr " int r;\n"; "-1", ""
10248 | RInt _ -> pr " int r;\n"; "-1", "0"
10249 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10250 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10251 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10253 pr " jstring jr;\n";
10254 pr " char *r;\n"; "NULL", "NULL"
10256 pr " jobjectArray jr;\n";
10257 pr " int r_len;\n";
10258 pr " jclass cl;\n";
10259 pr " jstring jstr;\n";
10260 pr " char **r;\n"; "NULL", "NULL"
10261 | RStruct (_, typ) ->
10262 pr " jobject jr;\n";
10263 pr " jclass cl;\n";
10264 pr " jfieldID fl;\n";
10265 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10266 | RStructList (_, typ) ->
10267 pr " jobjectArray jr;\n";
10268 pr " jclass cl;\n";
10269 pr " jfieldID fl;\n";
10270 pr " jobject jfl;\n";
10271 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10272 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10274 pr " jstring jr;\n";
10276 pr " size_t size;\n";
10281 | Device n | Dev_or_Path n
10286 pr " const char *%s;\n" n
10288 pr " jbyte *%s;\n" n;
10289 pr " size_t %s_size;\n" n
10290 | StringList n | DeviceList n ->
10291 pr " int %s_len;\n" n;
10292 pr " const char **%s;\n" n
10297 pr " int64_t %s;\n" n
10301 (match fst style with
10302 | RStringList _ | RStructList _ -> true
10303 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10304 | RConstOptString _
10305 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10306 List.exists (function
10307 | StringList _ -> true
10308 | DeviceList _ -> true
10309 | _ -> false) (snd style) in
10315 (* Get the parameters. *)
10319 | Device n | Dev_or_Path n
10323 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10325 (* This is completely undocumented, but Java null becomes
10326 * a NULL parameter.
10328 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10330 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10331 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10332 | StringList n | DeviceList n ->
10333 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10334 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10335 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10336 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10338 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10340 pr " %s[%s_len] = NULL;\n" n n;
10344 pr " %s = j%s;\n" n n
10347 (* Make the call. *)
10348 pr " r = guestfs_%s " name;
10349 generate_c_call_args ~handle:"g" style;
10352 (* Release the parameters. *)
10356 | Device n | Dev_or_Path n
10360 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10362 pr " if (j%s)\n" n;
10363 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10365 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10366 | StringList n | DeviceList n ->
10367 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10368 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10370 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10372 pr " free (%s);\n" n
10378 (* Check for errors. *)
10379 pr " if (r == %s) {\n" error_code;
10380 pr " throw_exception (env, guestfs_last_error (g));\n";
10381 pr " return %s;\n" no_ret;
10384 (* Return value. *)
10385 (match fst style with
10387 | RInt _ -> pr " return (jint) r;\n"
10388 | RBool _ -> pr " return (jboolean) r;\n"
10389 | RInt64 _ -> pr " return (jlong) r;\n"
10390 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10391 | RConstOptString _ ->
10392 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10394 pr " jr = (*env)->NewStringUTF (env, r);\n";
10398 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10399 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10400 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10401 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10402 pr " for (i = 0; i < r_len; ++i) {\n";
10403 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10404 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10405 pr " free (r[i]);\n";
10409 | RStruct (_, typ) ->
10410 let jtyp = java_name_of_struct typ in
10411 let cols = cols_of_struct typ in
10412 generate_java_struct_return typ jtyp cols
10413 | RStructList (_, typ) ->
10414 let jtyp = java_name_of_struct typ in
10415 let cols = cols_of_struct typ in
10416 generate_java_struct_list_return typ jtyp cols
10419 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10420 pr " return NULL;\n"
10422 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10431 and generate_java_struct_return typ jtyp cols =
10432 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10433 pr " jr = (*env)->AllocObject (env, cl);\n";
10437 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10438 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10441 pr " char s[33];\n";
10442 pr " memcpy (s, r->%s, 32);\n" name;
10443 pr " s[32] = 0;\n";
10444 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10445 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10449 pr " int len = r->%s_len;\n" name;
10450 pr " char s[len+1];\n";
10451 pr " memcpy (s, r->%s, len);\n" name;
10452 pr " s[len] = 0;\n";
10453 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10454 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10456 | name, (FBytes|FUInt64|FInt64) ->
10457 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10458 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10459 | name, (FUInt32|FInt32) ->
10460 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10461 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10462 | name, FOptPercent ->
10463 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10464 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10466 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10467 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10472 and generate_java_struct_list_return typ jtyp cols =
10473 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10474 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10475 pr " for (i = 0; i < r->len; ++i) {\n";
10476 pr " jfl = (*env)->AllocObject (env, cl);\n";
10480 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10481 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10484 pr " char s[33];\n";
10485 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10486 pr " s[32] = 0;\n";
10487 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10488 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10492 pr " int len = r->val[i].%s_len;\n" name;
10493 pr " char s[len+1];\n";
10494 pr " memcpy (s, r->val[i].%s, len);\n" name;
10495 pr " s[len] = 0;\n";
10496 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10497 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10499 | name, (FBytes|FUInt64|FInt64) ->
10500 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10501 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10502 | name, (FUInt32|FInt32) ->
10503 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10504 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10505 | name, FOptPercent ->
10506 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10507 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10509 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10510 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10512 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10514 pr " guestfs_free_%s_list (r);\n" typ;
10517 and generate_java_makefile_inc () =
10518 generate_header HashStyle GPLv2plus;
10520 pr "java_built_sources = \\\n";
10523 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10525 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10527 and generate_haskell_hs () =
10528 generate_header HaskellStyle LGPLv2plus;
10530 (* XXX We only know how to generate partial FFI for Haskell
10531 * at the moment. Please help out!
10533 let can_generate style =
10537 | RInt64 _, _ -> true
10539 | RConstString _, _
10540 | RConstOptString _, _
10546 | RBufferOut _, _ -> false in
10549 {-# INCLUDE <guestfs.h> #-}
10550 {-# LANGUAGE ForeignFunctionInterface #-}
10555 (* List out the names of the actions we want to export. *)
10557 fun (name, style, _, _, _, _, _) ->
10558 if can_generate style then pr ",\n %s" name
10564 -- Unfortunately some symbols duplicate ones already present
10565 -- in Prelude. We don't know which, so we hard-code a list
10567 import Prelude hiding (truncate)
10571 import Foreign.C.Types
10573 import Control.Exception
10574 import Data.Typeable
10576 data GuestfsS = GuestfsS -- represents the opaque C struct
10577 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10578 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10580 -- XXX define properly later XXX
10584 data IntBool = IntBool
10586 data StatVFS = StatVFS
10587 data Hashtable = Hashtable
10589 foreign import ccall unsafe \"guestfs_create\" c_create
10591 foreign import ccall unsafe \"&guestfs_close\" c_close
10592 :: FunPtr (GuestfsP -> IO ())
10593 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10594 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10596 create :: IO GuestfsH
10599 c_set_error_handler p nullPtr nullPtr
10600 h <- newForeignPtr c_close p
10603 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10604 :: GuestfsP -> IO CString
10606 -- last_error :: GuestfsH -> IO (Maybe String)
10607 -- last_error h = do
10608 -- str <- withForeignPtr h (\\p -> c_last_error p)
10609 -- maybePeek peekCString str
10611 last_error :: GuestfsH -> IO (String)
10613 str <- withForeignPtr h (\\p -> c_last_error p)
10614 if (str == nullPtr)
10615 then return \"no error\"
10616 else peekCString str
10620 (* Generate wrappers for each foreign function. *)
10622 fun (name, style, _, _, _, _, _) ->
10623 if can_generate style then (
10624 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10626 generate_haskell_prototype ~handle:"GuestfsP" style;
10630 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10632 pr "%s %s = do\n" name
10633 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10635 (* Convert pointer arguments using with* functions. *)
10640 | Pathname n | Device n | Dev_or_Path n | String n ->
10641 pr "withCString %s $ \\%s -> " n n
10643 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10644 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10645 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10646 | Bool _ | Int _ | Int64 _ -> ()
10648 (* Convert integer arguments. *)
10652 | Bool n -> sprintf "(fromBool %s)" n
10653 | Int n -> sprintf "(fromIntegral %s)" n
10654 | Int64 n -> sprintf "(fromIntegral %s)" n
10655 | FileIn n | FileOut n
10656 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10657 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10659 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10660 (String.concat " " ("p" :: args));
10661 (match fst style with
10662 | RErr | RInt _ | RInt64 _ | RBool _ ->
10663 pr " if (r == -1)\n";
10665 pr " err <- last_error h\n";
10667 | RConstString _ | RConstOptString _ | RString _
10668 | RStringList _ | RStruct _
10669 | RStructList _ | RHashtable _ | RBufferOut _ ->
10670 pr " if (r == nullPtr)\n";
10672 pr " err <- last_error h\n";
10675 (match fst style with
10677 pr " else return ()\n"
10679 pr " else return (fromIntegral r)\n"
10681 pr " else return (fromIntegral r)\n"
10683 pr " else return (toBool r)\n"
10685 | RConstOptString _
10692 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10698 and generate_haskell_prototype ~handle ?(hs = false) style =
10699 pr "%s -> " handle;
10700 let string = if hs then "String" else "CString" in
10701 let int = if hs then "Int" else "CInt" in
10702 let bool = if hs then "Bool" else "CInt" in
10703 let int64 = if hs then "Integer" else "Int64" in
10707 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10709 if hs then pr "String"
10710 else pr "CString -> CInt"
10711 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10712 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10713 | Bool _ -> pr "%s" bool
10714 | Int _ -> pr "%s" int
10715 | Int64 _ -> pr "%s" int
10716 | FileIn _ -> pr "%s" string
10717 | FileOut _ -> pr "%s" string
10722 (match fst style with
10723 | RErr -> if not hs then pr "CInt"
10724 | RInt _ -> pr "%s" int
10725 | RInt64 _ -> pr "%s" int64
10726 | RBool _ -> pr "%s" bool
10727 | RConstString _ -> pr "%s" string
10728 | RConstOptString _ -> pr "Maybe %s" string
10729 | RString _ -> pr "%s" string
10730 | RStringList _ -> pr "[%s]" string
10731 | RStruct (_, typ) ->
10732 let name = java_name_of_struct typ in
10734 | RStructList (_, typ) ->
10735 let name = java_name_of_struct typ in
10737 | RHashtable _ -> pr "Hashtable"
10738 | RBufferOut _ -> pr "%s" string
10742 and generate_csharp () =
10743 generate_header CPlusPlusStyle LGPLv2plus;
10745 (* XXX Make this configurable by the C# assembly users. *)
10746 let library = "libguestfs.so.0" in
10749 // These C# bindings are highly experimental at present.
10751 // Firstly they only work on Linux (ie. Mono). In order to get them
10752 // to work on Windows (ie. .Net) you would need to port the library
10753 // itself to Windows first.
10755 // The second issue is that some calls are known to be incorrect and
10756 // can cause Mono to segfault. Particularly: calls which pass or
10757 // return string[], or return any structure value. This is because
10758 // we haven't worked out the correct way to do this from C#.
10760 // The third issue is that when compiling you get a lot of warnings.
10761 // We are not sure whether the warnings are important or not.
10763 // Fourthly we do not routinely build or test these bindings as part
10764 // of the make && make check cycle, which means that regressions might
10767 // Suggestions and patches are welcome.
10771 // gmcs Libguestfs.cs
10772 // mono Libguestfs.exe
10774 // (You'll probably want to add a Test class / static main function
10775 // otherwise this won't do anything useful).
10779 using System.Runtime.InteropServices;
10780 using System.Runtime.Serialization;
10781 using System.Collections;
10785 class Error : System.ApplicationException
10787 public Error (string message) : base (message) {}
10788 protected Error (SerializationInfo info, StreamingContext context) {}
10795 [DllImport (\"%s\")]
10796 static extern IntPtr guestfs_create ();
10800 _handle = guestfs_create ();
10801 if (_handle == IntPtr.Zero)
10802 throw new Error (\"could not create guestfs handle\");
10805 [DllImport (\"%s\")]
10806 static extern void guestfs_close (IntPtr h);
10810 guestfs_close (_handle);
10813 [DllImport (\"%s\")]
10814 static extern string guestfs_last_error (IntPtr h);
10816 " library library library;
10818 (* Generate C# structure bindings. We prefix struct names with
10819 * underscore because C# cannot have conflicting struct names and
10820 * method names (eg. "class stat" and "stat").
10824 pr " [StructLayout (LayoutKind.Sequential)]\n";
10825 pr " public class _%s {\n" typ;
10828 | name, FChar -> pr " char %s;\n" name
10829 | name, FString -> pr " string %s;\n" name
10831 pr " uint %s_len;\n" name;
10832 pr " string %s;\n" name
10834 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10835 pr " string %s;\n" name
10836 | name, FUInt32 -> pr " uint %s;\n" name
10837 | name, FInt32 -> pr " int %s;\n" name
10838 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10839 | name, FInt64 -> pr " long %s;\n" name
10840 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10846 (* Generate C# function bindings. *)
10848 fun (name, style, _, _, _, shortdesc, _) ->
10849 let rec csharp_return_type () =
10850 match fst style with
10852 | RBool n -> "bool"
10854 | RInt64 n -> "long"
10856 | RConstOptString n
10858 | RBufferOut n -> "string"
10859 | RStruct (_,n) -> "_" ^ n
10860 | RHashtable n -> "Hashtable"
10861 | RStringList n -> "string[]"
10862 | RStructList (_,n) -> sprintf "_%s[]" n
10864 and c_return_type () =
10865 match fst style with
10869 | RInt64 _ -> "long"
10871 | RConstOptString _
10873 | RBufferOut _ -> "string"
10874 | RStruct (_,n) -> "_" ^ n
10876 | RStringList _ -> "string[]"
10877 | RStructList (_,n) -> sprintf "_%s[]" n
10879 and c_error_comparison () =
10880 match fst style with
10884 | RInt64 _ -> "== -1"
10886 | RConstOptString _
10892 | RStructList (_,_) -> "== null"
10894 and generate_extern_prototype () =
10895 pr " static extern %s guestfs_%s (IntPtr h"
10896 (c_return_type ()) name;
10899 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10900 | FileIn n | FileOut n
10902 pr ", [In] string %s" n
10903 | StringList n | DeviceList n ->
10904 pr ", [In] string[] %s" n
10914 and generate_public_prototype () =
10915 pr " public %s %s (" (csharp_return_type ()) name;
10916 let comma = ref false in
10918 if !comma then pr ", ";
10923 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10924 | FileIn n | FileOut n
10926 next (); pr "string %s" n
10927 | StringList n | DeviceList n ->
10928 next (); pr "string[] %s" n
10930 next (); pr "bool %s" n
10932 next (); pr "int %s" n
10934 next (); pr "long %s" n
10938 and generate_call () =
10939 pr "guestfs_%s (_handle" name;
10940 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10944 pr " [DllImport (\"%s\")]\n" library;
10945 generate_extern_prototype ();
10947 pr " /// <summary>\n";
10948 pr " /// %s\n" shortdesc;
10949 pr " /// </summary>\n";
10950 generate_public_prototype ();
10952 pr " %s r;\n" (c_return_type ());
10955 pr " if (r %s)\n" (c_error_comparison ());
10956 pr " throw new Error (guestfs_last_error (_handle));\n";
10957 (match fst style with
10960 pr " return r != 0 ? true : false;\n"
10962 pr " Hashtable rr = new Hashtable ();\n";
10963 pr " for (int i = 0; i < r.Length; i += 2)\n";
10964 pr " rr.Add (r[i], r[i+1]);\n";
10966 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10967 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10973 ) all_functions_sorted;
10979 and generate_bindtests () =
10980 generate_header CStyle LGPLv2plus;
10984 #include <stdlib.h>
10985 #include <inttypes.h>
10986 #include <string.h>
10988 #include \"guestfs.h\"
10989 #include \"guestfs-internal.h\"
10990 #include \"guestfs-internal-actions.h\"
10991 #include \"guestfs_protocol.h\"
10993 #define error guestfs_error
10994 #define safe_calloc guestfs_safe_calloc
10995 #define safe_malloc guestfs_safe_malloc
10998 print_strings (char *const *argv)
11003 for (argc = 0; argv[argc] != NULL; ++argc) {
11004 if (argc > 0) printf (\", \");
11005 printf (\"\\\"%%s\\\"\", argv[argc]);
11010 /* The test0 function prints its parameters to stdout. */
11014 match test_functions with
11015 | [] -> assert false
11016 | test0 :: tests -> test0, tests in
11019 let (name, style, _, _, _, _, _) = test0 in
11020 generate_prototype ~extern:false ~semicolon:false ~newline:true
11021 ~handle:"g" ~prefix:"guestfs__" name style;
11026 | Device n | Dev_or_Path n
11029 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
11031 pr " for (size_t i = 0; i < %s_size; ++i)\n" n;
11032 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11033 pr " printf (\"\\n\");\n"
11034 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11035 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11036 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11037 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11038 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11040 pr " /* Java changes stdout line buffering so we need this: */\n";
11041 pr " fflush (stdout);\n";
11047 fun (name, style, _, _, _, _, _) ->
11048 if String.sub name (String.length name - 3) 3 <> "err" then (
11049 pr "/* Test normal return. */\n";
11050 generate_prototype ~extern:false ~semicolon:false ~newline:true
11051 ~handle:"g" ~prefix:"guestfs__" name style;
11053 (match fst style with
11058 pr " sscanf (val, \"%%d\", &r);\n";
11061 pr " int64_t r;\n";
11062 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11065 pr " return STREQ (val, \"true\");\n"
11067 | RConstOptString _ ->
11068 (* Can't return the input string here. Return a static
11069 * string so we ensure we get a segfault if the caller
11070 * tries to free it.
11072 pr " return \"static string\";\n"
11074 pr " return strdup (val);\n"
11076 pr " char **strs;\n";
11078 pr " sscanf (val, \"%%d\", &n);\n";
11079 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11080 pr " for (i = 0; i < n; ++i) {\n";
11081 pr " strs[i] = safe_malloc (g, 16);\n";
11082 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11084 pr " strs[n] = NULL;\n";
11085 pr " return strs;\n"
11086 | RStruct (_, typ) ->
11087 pr " struct guestfs_%s *r;\n" typ;
11088 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11090 | RStructList (_, typ) ->
11091 pr " struct guestfs_%s_list *r;\n" typ;
11092 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11093 pr " sscanf (val, \"%%d\", &r->len);\n";
11094 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11097 pr " char **strs;\n";
11099 pr " sscanf (val, \"%%d\", &n);\n";
11100 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11101 pr " for (i = 0; i < n; ++i) {\n";
11102 pr " strs[i*2] = safe_malloc (g, 16);\n";
11103 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11104 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11105 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11107 pr " strs[n*2] = NULL;\n";
11108 pr " return strs;\n"
11110 pr " return strdup (val);\n"
11115 pr "/* Test error return. */\n";
11116 generate_prototype ~extern:false ~semicolon:false ~newline:true
11117 ~handle:"g" ~prefix:"guestfs__" name style;
11119 pr " error (g, \"error\");\n";
11120 (match fst style with
11121 | RErr | RInt _ | RInt64 _ | RBool _ ->
11123 | RConstString _ | RConstOptString _
11124 | RString _ | RStringList _ | RStruct _
11128 pr " return NULL;\n"
11135 and generate_ocaml_bindtests () =
11136 generate_header OCamlStyle GPLv2plus;
11140 let g = Guestfs.create () in
11144 String.concat " " (
11147 | CallString s -> "\"" ^ s ^ "\""
11148 | CallOptString None -> "None"
11149 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11150 | CallStringList xs ->
11151 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11152 | CallInt i when i >= 0 -> string_of_int i
11153 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11154 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11155 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11156 | CallBool b -> string_of_bool b
11157 | CallBuffer s -> sprintf "%S" s
11162 generate_lang_bindtests (
11163 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11166 pr "print_endline \"EOF\"\n"
11168 and generate_perl_bindtests () =
11169 pr "#!/usr/bin/perl -w\n";
11170 generate_header HashStyle GPLv2plus;
11177 my $g = Sys::Guestfs->new ();
11181 String.concat ", " (
11184 | CallString s -> "\"" ^ s ^ "\""
11185 | CallOptString None -> "undef"
11186 | CallOptString (Some s) -> sprintf "\"%s\"" s
11187 | CallStringList xs ->
11188 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11189 | CallInt i -> string_of_int i
11190 | CallInt64 i -> Int64.to_string i
11191 | CallBool b -> if b then "1" else "0"
11192 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11197 generate_lang_bindtests (
11198 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11201 pr "print \"EOF\\n\"\n"
11203 and generate_python_bindtests () =
11204 generate_header HashStyle GPLv2plus;
11209 g = guestfs.GuestFS ()
11213 String.concat ", " (
11216 | CallString s -> "\"" ^ s ^ "\""
11217 | CallOptString None -> "None"
11218 | CallOptString (Some s) -> sprintf "\"%s\"" s
11219 | CallStringList xs ->
11220 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11221 | CallInt i -> string_of_int i
11222 | CallInt64 i -> Int64.to_string i
11223 | CallBool b -> if b then "1" else "0"
11224 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11229 generate_lang_bindtests (
11230 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11233 pr "print \"EOF\"\n"
11235 and generate_ruby_bindtests () =
11236 generate_header HashStyle GPLv2plus;
11241 g = Guestfs::create()
11245 String.concat ", " (
11248 | CallString s -> "\"" ^ s ^ "\""
11249 | CallOptString None -> "nil"
11250 | CallOptString (Some s) -> sprintf "\"%s\"" s
11251 | CallStringList xs ->
11252 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11253 | CallInt i -> string_of_int i
11254 | CallInt64 i -> Int64.to_string i
11255 | CallBool b -> string_of_bool b
11256 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11261 generate_lang_bindtests (
11262 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11265 pr "print \"EOF\\n\"\n"
11267 and generate_java_bindtests () =
11268 generate_header CStyle GPLv2plus;
11271 import com.redhat.et.libguestfs.*;
11273 public class Bindtests {
11274 public static void main (String[] argv)
11277 GuestFS g = new GuestFS ();
11281 String.concat ", " (
11284 | CallString s -> "\"" ^ s ^ "\""
11285 | CallOptString None -> "null"
11286 | CallOptString (Some s) -> sprintf "\"%s\"" s
11287 | CallStringList xs ->
11289 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11290 | CallInt i -> string_of_int i
11291 | CallInt64 i -> Int64.to_string i
11292 | CallBool b -> string_of_bool b
11294 "new byte[] { " ^ String.concat "," (
11295 map_chars (fun c -> string_of_int (Char.code c)) s
11301 generate_lang_bindtests (
11302 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11306 System.out.println (\"EOF\");
11308 catch (Exception exn) {
11309 System.err.println (exn);
11316 and generate_haskell_bindtests () =
11317 generate_header HaskellStyle GPLv2plus;
11320 module Bindtests where
11321 import qualified Guestfs
11324 g <- Guestfs.create
11328 String.concat " " (
11331 | CallString s -> "\"" ^ s ^ "\""
11332 | CallOptString None -> "Nothing"
11333 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11334 | CallStringList xs ->
11335 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11336 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11337 | CallInt i -> string_of_int i
11338 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11339 | CallInt64 i -> Int64.to_string i
11340 | CallBool true -> "True"
11341 | CallBool false -> "False"
11342 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11347 generate_lang_bindtests (
11348 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11351 pr " putStrLn \"EOF\"\n"
11353 (* Language-independent bindings tests - we do it this way to
11354 * ensure there is parity in testing bindings across all languages.
11356 and generate_lang_bindtests call =
11357 call "test0" [CallString "abc"; CallOptString (Some "def");
11358 CallStringList []; CallBool false;
11359 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11360 CallBuffer "abc\000abc"];
11361 call "test0" [CallString "abc"; CallOptString None;
11362 CallStringList []; CallBool false;
11363 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11364 CallBuffer "abc\000abc"];
11365 call "test0" [CallString ""; CallOptString (Some "def");
11366 CallStringList []; CallBool false;
11367 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11368 CallBuffer "abc\000abc"];
11369 call "test0" [CallString ""; CallOptString (Some "");
11370 CallStringList []; CallBool false;
11371 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11372 CallBuffer "abc\000abc"];
11373 call "test0" [CallString "abc"; CallOptString (Some "def");
11374 CallStringList ["1"]; CallBool false;
11375 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11376 CallBuffer "abc\000abc"];
11377 call "test0" [CallString "abc"; CallOptString (Some "def");
11378 CallStringList ["1"; "2"]; CallBool false;
11379 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11380 CallBuffer "abc\000abc"];
11381 call "test0" [CallString "abc"; CallOptString (Some "def");
11382 CallStringList ["1"]; CallBool true;
11383 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11384 CallBuffer "abc\000abc"];
11385 call "test0" [CallString "abc"; CallOptString (Some "def");
11386 CallStringList ["1"]; CallBool false;
11387 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11388 CallBuffer "abc\000abc"];
11389 call "test0" [CallString "abc"; CallOptString (Some "def");
11390 CallStringList ["1"]; CallBool false;
11391 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11392 CallBuffer "abc\000abc"];
11393 call "test0" [CallString "abc"; CallOptString (Some "def");
11394 CallStringList ["1"]; CallBool false;
11395 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11396 CallBuffer "abc\000abc"];
11397 call "test0" [CallString "abc"; CallOptString (Some "def");
11398 CallStringList ["1"]; CallBool false;
11399 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11400 CallBuffer "abc\000abc"];
11401 call "test0" [CallString "abc"; CallOptString (Some "def");
11402 CallStringList ["1"]; CallBool false;
11403 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11404 CallBuffer "abc\000abc"];
11405 call "test0" [CallString "abc"; CallOptString (Some "def");
11406 CallStringList ["1"]; CallBool false;
11407 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11408 CallBuffer "abc\000abc"]
11410 (* XXX Add here tests of the return and error functions. *)
11412 (* Code to generator bindings for virt-inspector. Currently only
11413 * implemented for OCaml code (for virt-p2v 2.0).
11415 let rng_input = "inspector/virt-inspector.rng"
11417 (* Read the input file and parse it into internal structures. This is
11418 * by no means a complete RELAX NG parser, but is just enough to be
11419 * able to parse the specific input file.
11422 | Element of string * rng list (* <element name=name/> *)
11423 | Attribute of string * rng list (* <attribute name=name/> *)
11424 | Interleave of rng list (* <interleave/> *)
11425 | ZeroOrMore of rng (* <zeroOrMore/> *)
11426 | OneOrMore of rng (* <oneOrMore/> *)
11427 | Optional of rng (* <optional/> *)
11428 | Choice of string list (* <choice><value/>*</choice> *)
11429 | Value of string (* <value>str</value> *)
11430 | Text (* <text/> *)
11432 let rec string_of_rng = function
11433 | Element (name, xs) ->
11434 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11435 | Attribute (name, xs) ->
11436 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11437 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11438 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11439 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11440 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11441 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11442 | Value value -> "Value \"" ^ value ^ "\""
11445 and string_of_rng_list xs =
11446 String.concat ", " (List.map string_of_rng xs)
11448 let rec parse_rng ?defines context = function
11450 | Xml.Element ("element", ["name", name], children) :: rest ->
11451 Element (name, parse_rng ?defines context children)
11452 :: parse_rng ?defines context rest
11453 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11454 Attribute (name, parse_rng ?defines context children)
11455 :: parse_rng ?defines context rest
11456 | Xml.Element ("interleave", [], children) :: rest ->
11457 Interleave (parse_rng ?defines context children)
11458 :: parse_rng ?defines context rest
11459 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11460 let rng = parse_rng ?defines context [child] in
11462 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11464 failwithf "%s: <zeroOrMore> contains more than one child element"
11467 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11468 let rng = parse_rng ?defines context [child] in
11470 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11472 failwithf "%s: <oneOrMore> contains more than one child element"
11475 | Xml.Element ("optional", [], [child]) :: rest ->
11476 let rng = parse_rng ?defines context [child] in
11478 | [child] -> Optional child :: parse_rng ?defines context rest
11480 failwithf "%s: <optional> contains more than one child element"
11483 | Xml.Element ("choice", [], children) :: rest ->
11484 let values = List.map (
11485 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11487 failwithf "%s: can't handle anything except <value> in <choice>"
11491 :: parse_rng ?defines context rest
11492 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11493 Value value :: parse_rng ?defines context rest
11494 | Xml.Element ("text", [], []) :: rest ->
11495 Text :: parse_rng ?defines context rest
11496 | Xml.Element ("ref", ["name", name], []) :: rest ->
11497 (* Look up the reference. Because of limitations in this parser,
11498 * we can't handle arbitrarily nested <ref> yet. You can only
11499 * use <ref> from inside <start>.
11501 (match defines with
11503 failwithf "%s: contains <ref>, but no refs are defined yet" context
11505 let rng = StringMap.find name map in
11506 rng @ parse_rng ?defines context rest
11509 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11512 let xml = Xml.parse_file rng_input in
11514 | Xml.Element ("grammar", _,
11515 Xml.Element ("start", _, gram) :: defines) ->
11516 (* The <define/> elements are referenced in the <start> section,
11517 * so build a map of those first.
11519 let defines = List.fold_left (
11521 function Xml.Element ("define", ["name", name], defn) ->
11522 StringMap.add name defn map
11524 failwithf "%s: expected <define name=name/>" rng_input
11525 ) StringMap.empty defines in
11526 let defines = StringMap.mapi parse_rng defines in
11528 (* Parse the <start> clause, passing the defines. *)
11529 parse_rng ~defines "<start>" gram
11531 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11534 let name_of_field = function
11535 | Element (name, _) | Attribute (name, _)
11536 | ZeroOrMore (Element (name, _))
11537 | OneOrMore (Element (name, _))
11538 | Optional (Element (name, _)) -> name
11539 | Optional (Attribute (name, _)) -> name
11540 | Text -> (* an unnamed field in an element *)
11543 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11545 (* At the moment this function only generates OCaml types. However we
11546 * should parameterize it later so it can generate types/structs in a
11547 * variety of languages.
11549 let generate_types xs =
11550 (* A simple type is one that can be printed out directly, eg.
11551 * "string option". A complex type is one which has a name and has
11552 * to be defined via another toplevel definition, eg. a struct.
11554 * generate_type generates code for either simple or complex types.
11555 * In the simple case, it returns the string ("string option"). In
11556 * the complex case, it returns the name ("mountpoint"). In the
11557 * complex case it has to print out the definition before returning,
11558 * so it should only be called when we are at the beginning of a
11559 * new line (BOL context).
11561 let rec generate_type = function
11562 | Text -> (* string *)
11564 | Choice values -> (* [`val1|`val2|...] *)
11565 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11566 | ZeroOrMore rng -> (* <rng> list *)
11567 let t, is_simple = generate_type rng in
11568 t ^ " list (* 0 or more *)", is_simple
11569 | OneOrMore rng -> (* <rng> list *)
11570 let t, is_simple = generate_type rng in
11571 t ^ " list (* 1 or more *)", is_simple
11572 (* virt-inspector hack: bool *)
11573 | Optional (Attribute (name, [Value "1"])) ->
11575 | Optional rng -> (* <rng> list *)
11576 let t, is_simple = generate_type rng in
11577 t ^ " option", is_simple
11578 (* type name = { fields ... } *)
11579 | Element (name, fields) when is_attrs_interleave fields ->
11580 generate_type_struct name (get_attrs_interleave fields)
11581 | Element (name, [field]) (* type name = field *)
11582 | Attribute (name, [field]) ->
11583 let t, is_simple = generate_type field in
11584 if is_simple then (t, true)
11586 pr "type %s = %s\n" name t;
11589 | Element (name, fields) -> (* type name = { fields ... } *)
11590 generate_type_struct name fields
11592 failwithf "generate_type failed at: %s" (string_of_rng rng)
11594 and is_attrs_interleave = function
11595 | [Interleave _] -> true
11596 | Attribute _ :: fields -> is_attrs_interleave fields
11597 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11600 and get_attrs_interleave = function
11601 | [Interleave fields] -> fields
11602 | ((Attribute _) as field) :: fields
11603 | ((Optional (Attribute _)) as field) :: fields ->
11604 field :: get_attrs_interleave fields
11605 | _ -> assert false
11607 and generate_types xs =
11608 List.iter (fun x -> ignore (generate_type x)) xs
11610 and generate_type_struct name fields =
11611 (* Calculate the types of the fields first. We have to do this
11612 * before printing anything so we are still in BOL context.
11614 let types = List.map fst (List.map generate_type fields) in
11616 (* Special case of a struct containing just a string and another
11617 * field. Turn it into an assoc list.
11620 | ["string"; other] ->
11621 let fname1, fname2 =
11623 | [f1; f2] -> name_of_field f1, name_of_field f2
11624 | _ -> assert false in
11625 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11629 pr "type %s = {\n" name;
11631 fun (field, ftype) ->
11632 let fname = name_of_field field in
11633 pr " %s_%s : %s;\n" name fname ftype
11634 ) (List.combine fields types);
11636 (* Return the name of this type, and
11637 * false because it's not a simple type.
11644 let generate_parsers xs =
11645 (* As for generate_type above, generate_parser makes a parser for
11646 * some type, and returns the name of the parser it has generated.
11647 * Because it (may) need to print something, it should always be
11648 * called in BOL context.
11650 let rec generate_parser = function
11651 | Text -> (* string *)
11652 "string_child_or_empty"
11653 | Choice values -> (* [`val1|`val2|...] *)
11654 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11656 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11657 | ZeroOrMore rng -> (* <rng> list *)
11658 let pa = generate_parser rng in
11659 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11660 | OneOrMore rng -> (* <rng> list *)
11661 let pa = generate_parser rng in
11662 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11663 (* virt-inspector hack: bool *)
11664 | Optional (Attribute (name, [Value "1"])) ->
11665 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11666 | Optional rng -> (* <rng> list *)
11667 let pa = generate_parser rng in
11668 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11669 (* type name = { fields ... } *)
11670 | Element (name, fields) when is_attrs_interleave fields ->
11671 generate_parser_struct name (get_attrs_interleave fields)
11672 | Element (name, [field]) -> (* type name = field *)
11673 let pa = generate_parser field in
11674 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11675 pr "let %s =\n" parser_name;
11677 pr "let parse_%s = %s\n" name parser_name;
11679 | Attribute (name, [field]) ->
11680 let pa = generate_parser field in
11681 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11682 pr "let %s =\n" parser_name;
11684 pr "let parse_%s = %s\n" name parser_name;
11686 | Element (name, fields) -> (* type name = { fields ... } *)
11687 generate_parser_struct name ([], fields)
11689 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11691 and is_attrs_interleave = function
11692 | [Interleave _] -> true
11693 | Attribute _ :: fields -> is_attrs_interleave fields
11694 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11697 and get_attrs_interleave = function
11698 | [Interleave fields] -> [], fields
11699 | ((Attribute _) as field) :: fields
11700 | ((Optional (Attribute _)) as field) :: fields ->
11701 let attrs, interleaves = get_attrs_interleave fields in
11702 (field :: attrs), interleaves
11703 | _ -> assert false
11705 and generate_parsers xs =
11706 List.iter (fun x -> ignore (generate_parser x)) xs
11708 and generate_parser_struct name (attrs, interleaves) =
11709 (* Generate parsers for the fields first. We have to do this
11710 * before printing anything so we are still in BOL context.
11712 let fields = attrs @ interleaves in
11713 let pas = List.map generate_parser fields in
11715 (* Generate an intermediate tuple from all the fields first.
11716 * If the type is just a string + another field, then we will
11717 * return this directly, otherwise it is turned into a record.
11719 * RELAX NG note: This code treats <interleave> and plain lists of
11720 * fields the same. In other words, it doesn't bother enforcing
11721 * any ordering of fields in the XML.
11723 pr "let parse_%s x =\n" name;
11724 pr " let t = (\n ";
11725 let comma = ref false in
11728 if !comma then pr ",\n ";
11731 | Optional (Attribute (fname, [field])), pa ->
11733 | Optional (Element (fname, [field])), pa ->
11734 pr "%s (optional_child %S x)" pa fname
11735 | Attribute (fname, [Text]), _ ->
11736 pr "attribute %S x" fname
11737 | (ZeroOrMore _ | OneOrMore _), pa ->
11742 let fname = name_of_field field in
11743 pr "%s (child %S x)" pa fname
11744 ) (List.combine fields pas);
11748 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11752 pr " (Obj.magic t : %s)\n" name
11756 | (Optional (Attribute (fname, [field])), pa) ->
11757 pr " %s_%s =\n" name fname;
11759 | (Optional (Element (fname, [field])), pa) ->
11760 pr " %s_%s =\n" name fname;
11761 pr " (let x = optional_child %S x in\n" fname;
11764 let fname = name_of_field field in
11765 pr " %s_%s =\n" name fname;
11766 pr " (let x = child %S x in\n" fname;
11768 ) (List.combine fields pas);
11772 sprintf "parse_%s" name
11775 generate_parsers xs
11777 (* Generate ocaml/guestfs_inspector.mli. *)
11778 let generate_ocaml_inspector_mli () =
11779 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11782 (** This is an OCaml language binding to the external [virt-inspector]
11785 For more information, please read the man page [virt-inspector(1)].
11790 generate_types grammar;
11791 pr "(** The nested information returned from the {!inspect} function. *)\n";
11795 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11796 (** To inspect a libvirt domain called [name], pass a singleton
11797 list: [inspect [name]]. When using libvirt only, you may
11798 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11800 To inspect a disk image or images, pass a list of the filenames
11801 of the disk images: [inspect filenames]
11803 This function inspects the given guest or disk images and
11804 returns a list of operating system(s) found and a large amount
11805 of information about them. In the vast majority of cases,
11806 a virtual machine only contains a single operating system.
11808 If the optional [~xml] parameter is given, then this function
11809 skips running the external virt-inspector program and just
11810 parses the given XML directly (which is expected to be XML
11811 produced from a previous run of virt-inspector). The list of
11812 names and connect URI are ignored in this case.
11814 This function can throw a wide variety of exceptions, for example
11815 if the external virt-inspector program cannot be found, or if
11816 it doesn't generate valid XML.
11820 (* Generate ocaml/guestfs_inspector.ml. *)
11821 let generate_ocaml_inspector_ml () =
11822 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11827 generate_types grammar;
11831 (* Misc functions which are used by the parser code below. *)
11832 let first_child = function
11833 | Xml.Element (_, _, c::_) -> c
11834 | Xml.Element (name, _, []) ->
11835 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11836 | Xml.PCData str ->
11837 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11839 let string_child_or_empty = function
11840 | Xml.Element (_, _, [Xml.PCData s]) -> s
11841 | Xml.Element (_, _, []) -> \"\"
11842 | Xml.Element (x, _, _) ->
11843 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11845 | Xml.PCData str ->
11846 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11848 let optional_child name xml =
11849 let children = Xml.children xml in
11851 Some (List.find (function
11852 | Xml.Element (n, _, _) when n = name -> true
11853 | _ -> false) children)
11857 let child name xml =
11858 match optional_child name xml with
11861 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11863 let attribute name xml =
11864 try Xml.attrib xml name
11865 with Xml.No_attribute _ ->
11866 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11870 generate_parsers grammar;
11874 (* Run external virt-inspector, then use parser to parse the XML. *)
11875 let inspect ?connect ?xml names =
11879 if names = [] then invalid_arg \"inspect: no names given\";
11880 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11881 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11883 let cmd = List.map Filename.quote cmd in
11884 let cmd = String.concat \" \" cmd in
11885 let chan = open_process_in cmd in
11886 let xml = Xml.parse_in chan in
11887 (match close_process_in chan with
11889 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11890 | WSIGNALED i | WSTOPPED i ->
11891 failwith (\"external virt-inspector command died or stopped on sig \" ^
11896 Xml.parse_string doc in
11897 parse_operatingsystems xml
11900 and generate_max_proc_nr () =
11901 pr "%d\n" max_proc_nr
11903 let output_to filename k =
11904 let filename_new = filename ^ ".new" in
11905 chan := open_out filename_new;
11908 chan := Pervasives.stdout;
11910 (* Is the new file different from the current file? *)
11911 if Sys.file_exists filename && files_equal filename filename_new then
11912 unlink filename_new (* same, so skip it *)
11914 (* different, overwrite old one *)
11915 (try chmod filename 0o644 with Unix_error _ -> ());
11916 rename filename_new filename;
11917 chmod filename 0o444;
11918 printf "written %s\n%!" filename;
11921 let perror msg = function
11922 | Unix_error (err, _, _) ->
11923 eprintf "%s: %s\n" msg (error_message err)
11925 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11927 (* Main program. *)
11930 try openfile "HACKING" [O_RDWR] 0
11932 | Unix_error (ENOENT, _, _) ->
11934 You are probably running this from the wrong directory.
11935 Run it from the top source directory using the command
11940 perror "open: HACKING" exn;
11943 (* Acquire a lock so parallel builds won't try to run the generator
11944 * twice at the same time. Subsequent builds will wait for the first
11945 * one to finish. Note the lock is released implicitly when the
11948 (try lockf lock_fd F_LOCK 1
11950 perror "lock: HACKING" exn;
11953 check_functions ();
11955 output_to "src/guestfs_protocol.x" generate_xdr;
11956 output_to "src/guestfs-structs.h" generate_structs_h;
11957 output_to "src/guestfs-actions.h" generate_actions_h;
11958 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11959 output_to "src/guestfs-actions.c" generate_client_actions;
11960 output_to "src/guestfs-bindtests.c" generate_bindtests;
11961 output_to "src/guestfs-structs.pod" generate_structs_pod;
11962 output_to "src/guestfs-actions.pod" generate_actions_pod;
11963 output_to "src/guestfs-availability.pod" generate_availability_pod;
11964 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11965 output_to "src/libguestfs.syms" generate_linker_script;
11966 output_to "daemon/actions.h" generate_daemon_actions_h;
11967 output_to "daemon/stubs.c" generate_daemon_actions;
11968 output_to "daemon/names.c" generate_daemon_names;
11969 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11970 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11971 output_to "capitests/tests.c" generate_tests;
11972 output_to "fish/cmds.c" generate_fish_cmds;
11973 output_to "fish/completion.c" generate_fish_completion;
11974 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11975 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11976 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11977 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11978 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11979 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11980 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11981 output_to "perl/Guestfs.xs" generate_perl_xs;
11982 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11983 output_to "perl/bindtests.pl" generate_perl_bindtests;
11984 output_to "python/guestfs-py.c" generate_python_c;
11985 output_to "python/guestfs.py" generate_python_py;
11986 output_to "python/bindtests.py" generate_python_bindtests;
11987 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11988 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11989 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11993 let cols = cols_of_struct typ in
11994 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11995 output_to filename (generate_java_struct jtyp cols);
11998 output_to "java/Makefile.inc" generate_java_makefile_inc;
11999 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12000 output_to "java/Bindtests.java" generate_java_bindtests;
12001 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12002 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12003 output_to "csharp/Libguestfs.cs" generate_csharp;
12005 (* Always generate this file last, and unconditionally. It's used
12006 * by the Makefile to know when we must re-run the generator.
12008 let chan = open_out "src/stamp-generator" in
12009 fprintf chan "1\n";
12012 printf "generated %d lines of code\n" !lines