3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
168 (* Opaque buffer which can contain arbitrary 8 bit data.
169 * In the C API, this is expressed as <char *, int> pair.
170 * Most other languages have a string type which can contain
171 * ASCII NUL. We use whatever type is appropriate for each
173 * Buffers are limited by the total message size. To transfer
174 * large blocks of data, use FileIn/FileOut parameters instead.
175 * To return an arbitrary buffer, use RBufferOut.
181 | ProtocolLimitWarning (* display warning about protocol size limits *)
182 | DangerWillRobinson (* flags particularly dangerous commands *)
183 | FishAlias of string (* provide an alias for this cmd in guestfish *)
184 | FishAction of string (* call this function in guestfish *)
185 | NotInFish (* do not export via guestfish *)
186 | NotInDocs (* do not add this function to documentation *)
187 | DeprecatedBy of string (* function is deprecated, use .. instead *)
188 | Optional of string (* function is part of an optional group *)
190 (* You can supply zero or as many tests as you want per API call.
192 * Note that the test environment has 3 block devices, of size 500MB,
193 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
194 * a fourth ISO block device with some known files on it (/dev/sdd).
196 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
197 * Number of cylinders was 63 for IDE emulated disks with precisely
198 * the same size. How exactly this is calculated is a mystery.
200 * The ISO block device (/dev/sdd) comes from images/test.iso.
202 * To be able to run the tests in a reasonable amount of time,
203 * the virtual machine and block devices are reused between tests.
204 * So don't try testing kill_subprocess :-x
206 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
208 * Don't assume anything about the previous contents of the block
209 * devices. Use 'Init*' to create some initial scenarios.
211 * You can add a prerequisite clause to any individual test. This
212 * is a run-time check, which, if it fails, causes the test to be
213 * skipped. Useful if testing a command which might not work on
214 * all variations of libguestfs builds. A test that has prerequisite
215 * of 'Always' is run unconditionally.
217 * In addition, packagers can skip individual tests by setting the
218 * environment variables: eg:
219 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
220 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
222 type tests = (test_init * test_prereq * test) list
224 (* Run the command sequence and just expect nothing to fail. *)
227 (* Run the command sequence and expect the output of the final
228 * command to be the string.
230 | TestOutput of seq * string
232 (* Run the command sequence and expect the output of the final
233 * command to be the list of strings.
235 | TestOutputList of seq * string list
237 (* Run the command sequence and expect the output of the final
238 * command to be the list of block devices (could be either
239 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
240 * character of each string).
242 | TestOutputListOfDevices of seq * string list
244 (* Run the command sequence and expect the output of the final
245 * command to be the integer.
247 | TestOutputInt of seq * int
249 (* Run the command sequence and expect the output of the final
250 * command to be <op> <int>, eg. ">=", "1".
252 | TestOutputIntOp of seq * string * int
254 (* Run the command sequence and expect the output of the final
255 * command to be a true value (!= 0 or != NULL).
257 | TestOutputTrue of seq
259 (* Run the command sequence and expect the output of the final
260 * command to be a false value (== 0 or == NULL, but not an error).
262 | TestOutputFalse of seq
264 (* Run the command sequence and expect the output of the final
265 * command to be a list of the given length (but don't care about
268 | TestOutputLength of seq * int
270 (* Run the command sequence and expect the output of the final
271 * command to be a buffer (RBufferOut), ie. string + size.
273 | TestOutputBuffer of seq * string
275 (* Run the command sequence and expect the output of the final
276 * command to be a structure.
278 | TestOutputStruct of seq * test_field_compare list
280 (* Run the command sequence and expect the final command (only)
283 | TestLastFail of seq
285 and test_field_compare =
286 | CompareWithInt of string * int
287 | CompareWithIntOp of string * string * int
288 | CompareWithString of string * string
289 | CompareFieldsIntEq of string * string
290 | CompareFieldsStrEq of string * string
292 (* Test prerequisites. *)
294 (* Test always runs. *)
297 (* Test is currently disabled - eg. it fails, or it tests some
298 * unimplemented feature.
302 (* 'string' is some C code (a function body) that should return
303 * true or false. The test will run if the code returns true.
307 (* As for 'If' but the test runs _unless_ the code returns true. *)
310 (* Some initial scenarios for testing. *)
312 (* Do nothing, block devices could contain random stuff including
313 * LVM PVs, and some filesystems might be mounted. This is usually
318 (* Block devices are empty and no filesystems are mounted. *)
321 (* /dev/sda contains a single partition /dev/sda1, with random
322 * content. /dev/sdb and /dev/sdc may have random content.
327 (* /dev/sda contains a single partition /dev/sda1, which is formatted
328 * as ext2, empty [except for lost+found] and mounted on /.
329 * /dev/sdb and /dev/sdc may have random content.
335 * /dev/sda1 (is a PV):
336 * /dev/VG/LV (size 8MB):
337 * formatted as ext2, empty [except for lost+found], mounted on /
338 * /dev/sdb and /dev/sdc may have random content.
342 (* /dev/sdd (the ISO, see images/ directory in source)
347 (* Sequence of commands for testing. *)
349 and cmd = string list
351 (* Note about long descriptions: When referring to another
352 * action, use the format C<guestfs_other> (ie. the full name of
353 * the C function). This will be replaced as appropriate in other
356 * Apart from that, long descriptions are just perldoc paragraphs.
359 (* Generate a random UUID (used in tests). *)
361 let chan = open_process_in "uuidgen" in
362 let uuid = input_line chan in
363 (match close_process_in chan with
366 failwith "uuidgen: process exited with non-zero status"
367 | WSIGNALED _ | WSTOPPED _ ->
368 failwith "uuidgen: process signalled or stopped by signal"
372 (* These test functions are used in the language binding tests. *)
374 let test_all_args = [
377 StringList "strlist";
385 let test_all_rets = [
386 (* except for RErr, which is tested thoroughly elsewhere *)
387 "test0rint", RInt "valout";
388 "test0rint64", RInt64 "valout";
389 "test0rbool", RBool "valout";
390 "test0rconststring", RConstString "valout";
391 "test0rconstoptstring", RConstOptString "valout";
392 "test0rstring", RString "valout";
393 "test0rstringlist", RStringList "valout";
394 "test0rstruct", RStruct ("valout", "lvm_pv");
395 "test0rstructlist", RStructList ("valout", "lvm_pv");
396 "test0rhashtable", RHashtable "valout";
399 let test_functions = [
400 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
402 "internal test function - do not use",
404 This is an internal test function which is used to test whether
405 the automatically generated bindings can handle every possible
406 parameter type correctly.
408 It echos the contents of each parameter to stdout.
410 You probably don't want to call this function.");
414 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
416 "internal test function - do not use",
418 This is an internal test function which is used to test whether
419 the automatically generated bindings can handle every possible
420 return type correctly.
422 It converts string C<val> to the return type.
424 You probably don't want to call this function.");
425 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
427 "internal test function - do not use",
429 This is an internal test function which is used to test whether
430 the automatically generated bindings can handle every possible
431 return type correctly.
433 This function always returns an error.
435 You probably don't want to call this function.")]
439 (* non_daemon_functions are any functions which don't get processed
440 * in the daemon, eg. functions for setting and getting local
441 * configuration values.
444 let non_daemon_functions = test_functions @ [
445 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
447 "launch the qemu subprocess",
449 Internally libguestfs is implemented by running a virtual machine
452 You should call this after configuring the handle
453 (eg. adding drives) but before performing any actions.");
455 ("wait_ready", (RErr, []), -1, [NotInFish],
457 "wait until the qemu subprocess launches (no op)",
459 This function is a no op.
461 In versions of the API E<lt> 1.0.71 you had to call this function
462 just after calling C<guestfs_launch> to wait for the launch
463 to complete. However this is no longer necessary because
464 C<guestfs_launch> now does the waiting.
466 If you see any calls to this function in code then you can just
467 remove them, unless you want to retain compatibility with older
468 versions of the API.");
470 ("kill_subprocess", (RErr, []), -1, [],
472 "kill the qemu subprocess",
474 This kills the qemu subprocess. You should never need to call this.");
476 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
478 "add an image to examine or modify",
480 This function adds a virtual machine disk image C<filename> to the
481 guest. The first time you call this function, the disk appears as IDE
482 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
485 You don't necessarily need to be root when using libguestfs. However
486 you obviously do need sufficient permissions to access the filename
487 for whatever operations you want to perform (ie. read access if you
488 just want to read the image or write access if you want to modify the
491 This is equivalent to the qemu parameter
492 C<-drive file=filename,cache=off,if=...>.
494 C<cache=off> is omitted in cases where it is not supported by
495 the underlying filesystem.
497 C<if=...> is set at compile time by the configuration option
498 C<./configure --with-drive-if=...>. In the rare case where you
499 might need to change this at run time, use C<guestfs_add_drive_with_if>
500 or C<guestfs_add_drive_ro_with_if>.
502 Note that this call checks for the existence of C<filename>. This
503 stops you from specifying other types of drive which are supported
504 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
505 the general C<guestfs_config> call instead.");
507 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
509 "add a CD-ROM disk image to examine",
511 This function adds a virtual CD-ROM disk image to the guest.
513 This is equivalent to the qemu parameter C<-cdrom filename>.
521 This call checks for the existence of C<filename>. This
522 stops you from specifying other types of drive which are supported
523 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
524 the general C<guestfs_config> call instead.
528 If you just want to add an ISO file (often you use this as an
529 efficient way to transfer large files into the guest), then you
530 should probably use C<guestfs_add_drive_ro> instead.
534 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
536 "add a drive in snapshot mode (read-only)",
538 This adds a drive in snapshot mode, making it effectively
541 Note that writes to the device are allowed, and will be seen for
542 the duration of the guestfs handle, but they are written
543 to a temporary file which is discarded as soon as the guestfs
544 handle is closed. We don't currently have any method to enable
545 changes to be committed, although qemu can support this.
547 This is equivalent to the qemu parameter
548 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
550 C<if=...> is set at compile time by the configuration option
551 C<./configure --with-drive-if=...>. In the rare case where you
552 might need to change this at run time, use C<guestfs_add_drive_with_if>
553 or C<guestfs_add_drive_ro_with_if>.
555 C<readonly=on> is only added where qemu supports this option.
557 Note that this call checks for the existence of C<filename>. This
558 stops you from specifying other types of drive which are supported
559 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
560 the general C<guestfs_config> call instead.");
562 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
564 "add qemu parameters",
566 This can be used to add arbitrary qemu command line parameters
567 of the form C<-param value>. Actually it's not quite arbitrary - we
568 prevent you from setting some parameters which would interfere with
569 parameters that we use.
571 The first character of C<param> string must be a C<-> (dash).
573 C<value> can be NULL.");
575 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
577 "set the qemu binary",
579 Set the qemu binary that we will use.
581 The default is chosen when the library was compiled by the
584 You can also override this by setting the C<LIBGUESTFS_QEMU>
585 environment variable.
587 Setting C<qemu> to C<NULL> restores the default qemu binary.
589 Note that you should call this function as early as possible
590 after creating the handle. This is because some pre-launch
591 operations depend on testing qemu features (by running C<qemu -help>).
592 If the qemu binary changes, we don't retest features, and
593 so you might see inconsistent results. Using the environment
594 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
595 the qemu binary at the same time as the handle is created.");
597 ("get_qemu", (RConstString "qemu", []), -1, [],
598 [InitNone, Always, TestRun (
600 "get the qemu binary",
602 Return the current qemu binary.
604 This is always non-NULL. If it wasn't set already, then this will
605 return the default qemu binary name.");
607 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
609 "set the search path",
611 Set the path that libguestfs searches for kernel and initrd.img.
613 The default is C<$libdir/guestfs> unless overridden by setting
614 C<LIBGUESTFS_PATH> environment variable.
616 Setting C<path> to C<NULL> restores the default path.");
618 ("get_path", (RConstString "path", []), -1, [],
619 [InitNone, Always, TestRun (
621 "get the search path",
623 Return the current search path.
625 This is always non-NULL. If it wasn't set already, then this will
626 return the default path.");
628 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
630 "add options to kernel command line",
632 This function is used to add additional options to the
633 guest kernel command line.
635 The default is C<NULL> unless overridden by setting
636 C<LIBGUESTFS_APPEND> environment variable.
638 Setting C<append> to C<NULL> means I<no> additional options
639 are passed (libguestfs always adds a few of its own).");
641 ("get_append", (RConstOptString "append", []), -1, [],
642 (* This cannot be tested with the current framework. The
643 * function can return NULL in normal operations, which the
644 * test framework interprets as an error.
647 "get the additional kernel options",
649 Return the additional kernel options which are added to the
650 guest kernel command line.
652 If C<NULL> then no options are added.");
654 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
658 If C<autosync> is true, this enables autosync. Libguestfs will make a
659 best effort attempt to run C<guestfs_umount_all> followed by
660 C<guestfs_sync> when the handle is closed
661 (also if the program exits without closing handles).
663 This is disabled by default (except in guestfish where it is
664 enabled by default).");
666 ("get_autosync", (RBool "autosync", []), -1, [],
667 [InitNone, Always, TestRun (
668 [["get_autosync"]])],
671 Get the autosync flag.");
673 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
677 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
679 Verbose messages are disabled unless the environment variable
680 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
682 ("get_verbose", (RBool "verbose", []), -1, [],
686 This returns the verbose messages flag.");
688 ("is_ready", (RBool "ready", []), -1, [],
689 [InitNone, Always, TestOutputTrue (
691 "is ready to accept commands",
693 This returns true iff this handle is ready to accept commands
694 (in the C<READY> state).
696 For more information on states, see L<guestfs(3)>.");
698 ("is_config", (RBool "config", []), -1, [],
699 [InitNone, Always, TestOutputFalse (
701 "is in configuration state",
703 This returns true iff this handle is being configured
704 (in the C<CONFIG> state).
706 For more information on states, see L<guestfs(3)>.");
708 ("is_launching", (RBool "launching", []), -1, [],
709 [InitNone, Always, TestOutputFalse (
710 [["is_launching"]])],
711 "is launching subprocess",
713 This returns true iff this handle is launching the subprocess
714 (in the C<LAUNCHING> state).
716 For more information on states, see L<guestfs(3)>.");
718 ("is_busy", (RBool "busy", []), -1, [],
719 [InitNone, Always, TestOutputFalse (
721 "is busy processing a command",
723 This returns true iff this handle is busy processing a command
724 (in the C<BUSY> state).
726 For more information on states, see L<guestfs(3)>.");
728 ("get_state", (RInt "state", []), -1, [],
730 "get the current state",
732 This returns the current state as an opaque integer. This is
733 only useful for printing debug and internal error messages.
735 For more information on states, see L<guestfs(3)>.");
737 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
738 [InitNone, Always, TestOutputInt (
739 [["set_memsize"; "500"];
740 ["get_memsize"]], 500)],
741 "set memory allocated to the qemu subprocess",
743 This sets the memory size in megabytes allocated to the
744 qemu subprocess. This only has any effect if called before
747 You can also change this by setting the environment
748 variable C<LIBGUESTFS_MEMSIZE> before the handle is
751 For more information on the architecture of libguestfs,
752 see L<guestfs(3)>.");
754 ("get_memsize", (RInt "memsize", []), -1, [],
755 [InitNone, Always, TestOutputIntOp (
756 [["get_memsize"]], ">=", 256)],
757 "get memory allocated to the qemu subprocess",
759 This gets the memory size in megabytes allocated to the
762 If C<guestfs_set_memsize> was not called
763 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
764 then this returns the compiled-in default value for memsize.
766 For more information on the architecture of libguestfs,
767 see L<guestfs(3)>.");
769 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
770 [InitNone, Always, TestOutputIntOp (
771 [["get_pid"]], ">=", 1)],
772 "get PID of qemu subprocess",
774 Return the process ID of the qemu subprocess. If there is no
775 qemu subprocess, then this will return an error.
777 This is an internal call used for debugging and testing.");
779 ("version", (RStruct ("version", "version"), []), -1, [],
780 [InitNone, Always, TestOutputStruct (
781 [["version"]], [CompareWithInt ("major", 1)])],
782 "get the library version number",
784 Return the libguestfs version number that the program is linked
787 Note that because of dynamic linking this is not necessarily
788 the version of libguestfs that you compiled against. You can
789 compile the program, and then at runtime dynamically link
790 against a completely different C<libguestfs.so> library.
792 This call was added in version C<1.0.58>. In previous
793 versions of libguestfs there was no way to get the version
794 number. From C code you can use ELF weak linking tricks to find out if
795 this symbol exists (if it doesn't, then it's an earlier version).
797 The call returns a structure with four elements. The first
798 three (C<major>, C<minor> and C<release>) are numbers and
799 correspond to the usual version triplet. The fourth element
800 (C<extra>) is a string and is normally empty, but may be
801 used for distro-specific information.
803 To construct the original version string:
804 C<$major.$minor.$release$extra>
806 I<Note:> Don't use this call to test for availability
807 of features. Distro backports makes this unreliable. Use
808 C<guestfs_available> instead.");
810 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
811 [InitNone, Always, TestOutputTrue (
812 [["set_selinux"; "true"];
814 "set SELinux enabled or disabled at appliance boot",
816 This sets the selinux flag that is passed to the appliance
817 at boot time. The default is C<selinux=0> (disabled).
819 Note that if SELinux is enabled, it is always in
820 Permissive mode (C<enforcing=0>).
822 For more information on the architecture of libguestfs,
823 see L<guestfs(3)>.");
825 ("get_selinux", (RBool "selinux", []), -1, [],
827 "get SELinux enabled flag",
829 This returns the current setting of the selinux flag which
830 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
832 For more information on the architecture of libguestfs,
833 see L<guestfs(3)>.");
835 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
836 [InitNone, Always, TestOutputFalse (
837 [["set_trace"; "false"];
839 "enable or disable command traces",
841 If the command trace flag is set to 1, then commands are
842 printed on stdout before they are executed in a format
843 which is very similar to the one used by guestfish. In
844 other words, you can run a program with this enabled, and
845 you will get out a script which you can feed to guestfish
846 to perform the same set of actions.
848 If you want to trace C API calls into libguestfs (and
849 other libraries) then possibly a better way is to use
850 the external ltrace(1) command.
852 Command traces are disabled unless the environment variable
853 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
855 ("get_trace", (RBool "trace", []), -1, [],
857 "get command trace enabled flag",
859 Return the command trace flag.");
861 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
862 [InitNone, Always, TestOutputFalse (
863 [["set_direct"; "false"];
865 "enable or disable direct appliance mode",
867 If the direct appliance mode flag is enabled, then stdin and
868 stdout are passed directly through to the appliance once it
871 One consequence of this is that log messages aren't caught
872 by the library and handled by C<guestfs_set_log_message_callback>,
873 but go straight to stdout.
875 You probably don't want to use this unless you know what you
878 The default is disabled.");
880 ("get_direct", (RBool "direct", []), -1, [],
882 "get direct appliance mode flag",
884 Return the direct appliance mode flag.");
886 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
887 [InitNone, Always, TestOutputTrue (
888 [["set_recovery_proc"; "true"];
889 ["get_recovery_proc"]])],
890 "enable or disable the recovery process",
892 If this is called with the parameter C<false> then
893 C<guestfs_launch> does not create a recovery process. The
894 purpose of the recovery process is to stop runaway qemu
895 processes in the case where the main program aborts abruptly.
897 This only has any effect if called before C<guestfs_launch>,
898 and the default is true.
900 About the only time when you would want to disable this is
901 if the main process will fork itself into the background
902 (\"daemonize\" itself). In this case the recovery process
903 thinks that the main program has disappeared and so kills
904 qemu, which is not very helpful.");
906 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
908 "get recovery process enabled flag",
910 Return the recovery process enabled flag.");
912 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
914 "add a drive specifying the QEMU block emulation to use",
916 This is the same as C<guestfs_add_drive> but it allows you
917 to specify the QEMU interface emulation to use at run time.");
919 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
921 "add a drive read-only specifying the QEMU block emulation to use",
923 This is the same as C<guestfs_add_drive_ro> but it allows you
924 to specify the QEMU interface emulation to use at run time.");
928 (* daemon_functions are any functions which cause some action
929 * to take place in the daemon.
932 let daemon_functions = [
933 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
934 [InitEmpty, Always, TestOutput (
935 [["part_disk"; "/dev/sda"; "mbr"];
936 ["mkfs"; "ext2"; "/dev/sda1"];
937 ["mount"; "/dev/sda1"; "/"];
938 ["write_file"; "/new"; "new file contents"; "0"];
939 ["cat"; "/new"]], "new file contents")],
940 "mount a guest disk at a position in the filesystem",
942 Mount a guest disk at a position in the filesystem. Block devices
943 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
944 the guest. If those block devices contain partitions, they will have
945 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
948 The rules are the same as for L<mount(2)>: A filesystem must
949 first be mounted on C</> before others can be mounted. Other
950 filesystems can only be mounted on directories which already
953 The mounted filesystem is writable, if we have sufficient permissions
954 on the underlying device.
957 When you use this call, the filesystem options C<sync> and C<noatime>
958 are set implicitly. This was originally done because we thought it
959 would improve reliability, but it turns out that I<-o sync> has a
960 very large negative performance impact and negligible effect on
961 reliability. Therefore we recommend that you avoid using
962 C<guestfs_mount> in any code that needs performance, and instead
963 use C<guestfs_mount_options> (use an empty string for the first
964 parameter if you don't want any options).");
966 ("sync", (RErr, []), 2, [],
967 [ InitEmpty, Always, TestRun [["sync"]]],
968 "sync disks, writes are flushed through to the disk image",
970 This syncs the disk, so that any writes are flushed through to the
971 underlying disk image.
973 You should always call this if you have modified a disk image, before
974 closing the handle.");
976 ("touch", (RErr, [Pathname "path"]), 3, [],
977 [InitBasicFS, Always, TestOutputTrue (
979 ["exists"; "/new"]])],
980 "update file timestamps or create a new file",
982 Touch acts like the L<touch(1)> command. It can be used to
983 update the timestamps on a file, or, if the file does not exist,
984 to create a new zero-length file.");
986 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
987 [InitISOFS, Always, TestOutput (
988 [["cat"; "/known-2"]], "abcdef\n")],
989 "list the contents of a file",
991 Return the contents of the file named C<path>.
993 Note that this function cannot correctly handle binary files
994 (specifically, files containing C<\\0> character which is treated
995 as end of string). For those you need to use the C<guestfs_read_file>
996 or C<guestfs_download> functions which have a more complex interface.");
998 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
999 [], (* XXX Tricky to test because it depends on the exact format
1000 * of the 'ls -l' command, which changes between F10 and F11.
1002 "list the files in a directory (long format)",
1004 List the files in C<directory> (relative to the root directory,
1005 there is no cwd) in the format of 'ls -la'.
1007 This command is mostly useful for interactive sessions. It
1008 is I<not> intended that you try to parse the output string.");
1010 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1011 [InitBasicFS, Always, TestOutputList (
1013 ["touch"; "/newer"];
1014 ["touch"; "/newest"];
1015 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1016 "list the files in a directory",
1018 List the files in C<directory> (relative to the root directory,
1019 there is no cwd). The '.' and '..' entries are not returned, but
1020 hidden files are shown.
1022 This command is mostly useful for interactive sessions. Programs
1023 should probably use C<guestfs_readdir> instead.");
1025 ("list_devices", (RStringList "devices", []), 7, [],
1026 [InitEmpty, Always, TestOutputListOfDevices (
1027 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1028 "list the block devices",
1030 List all the block devices.
1032 The full block device names are returned, eg. C</dev/sda>");
1034 ("list_partitions", (RStringList "partitions", []), 8, [],
1035 [InitBasicFS, Always, TestOutputListOfDevices (
1036 [["list_partitions"]], ["/dev/sda1"]);
1037 InitEmpty, Always, TestOutputListOfDevices (
1038 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1039 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1040 "list the partitions",
1042 List all the partitions detected on all block devices.
1044 The full partition device names are returned, eg. C</dev/sda1>
1046 This does not return logical volumes. For that you will need to
1047 call C<guestfs_lvs>.");
1049 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1050 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1051 [["pvs"]], ["/dev/sda1"]);
1052 InitEmpty, Always, TestOutputListOfDevices (
1053 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1054 ["pvcreate"; "/dev/sda1"];
1055 ["pvcreate"; "/dev/sda2"];
1056 ["pvcreate"; "/dev/sda3"];
1057 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1058 "list the LVM physical volumes (PVs)",
1060 List all the physical volumes detected. This is the equivalent
1061 of the L<pvs(8)> command.
1063 This returns a list of just the device names that contain
1064 PVs (eg. C</dev/sda2>).
1066 See also C<guestfs_pvs_full>.");
1068 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1069 [InitBasicFSonLVM, Always, TestOutputList (
1071 InitEmpty, Always, TestOutputList (
1072 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1073 ["pvcreate"; "/dev/sda1"];
1074 ["pvcreate"; "/dev/sda2"];
1075 ["pvcreate"; "/dev/sda3"];
1076 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1077 ["vgcreate"; "VG2"; "/dev/sda3"];
1078 ["vgs"]], ["VG1"; "VG2"])],
1079 "list the LVM volume groups (VGs)",
1081 List all the volumes groups detected. This is the equivalent
1082 of the L<vgs(8)> command.
1084 This returns a list of just the volume group names that were
1085 detected (eg. C<VolGroup00>).
1087 See also C<guestfs_vgs_full>.");
1089 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1090 [InitBasicFSonLVM, Always, TestOutputList (
1091 [["lvs"]], ["/dev/VG/LV"]);
1092 InitEmpty, Always, TestOutputList (
1093 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1094 ["pvcreate"; "/dev/sda1"];
1095 ["pvcreate"; "/dev/sda2"];
1096 ["pvcreate"; "/dev/sda3"];
1097 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1098 ["vgcreate"; "VG2"; "/dev/sda3"];
1099 ["lvcreate"; "LV1"; "VG1"; "50"];
1100 ["lvcreate"; "LV2"; "VG1"; "50"];
1101 ["lvcreate"; "LV3"; "VG2"; "50"];
1102 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1103 "list the LVM logical volumes (LVs)",
1105 List all the logical volumes detected. This is the equivalent
1106 of the L<lvs(8)> command.
1108 This returns a list of the logical volume device names
1109 (eg. C</dev/VolGroup00/LogVol00>).
1111 See also C<guestfs_lvs_full>.");
1113 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1114 [], (* XXX how to test? *)
1115 "list the LVM physical volumes (PVs)",
1117 List all the physical volumes detected. This is the equivalent
1118 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1120 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1121 [], (* XXX how to test? *)
1122 "list the LVM volume groups (VGs)",
1124 List all the volumes groups detected. This is the equivalent
1125 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1127 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1128 [], (* XXX how to test? *)
1129 "list the LVM logical volumes (LVs)",
1131 List all the logical volumes detected. This is the equivalent
1132 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1134 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1135 [InitISOFS, Always, TestOutputList (
1136 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1137 InitISOFS, Always, TestOutputList (
1138 [["read_lines"; "/empty"]], [])],
1139 "read file as lines",
1141 Return the contents of the file named C<path>.
1143 The file contents are returned as a list of lines. Trailing
1144 C<LF> and C<CRLF> character sequences are I<not> returned.
1146 Note that this function cannot correctly handle binary files
1147 (specifically, files containing C<\\0> character which is treated
1148 as end of line). For those you need to use the C<guestfs_read_file>
1149 function which has a more complex interface.");
1151 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1152 [], (* XXX Augeas code needs tests. *)
1153 "create a new Augeas handle",
1155 Create a new Augeas handle for editing configuration files.
1156 If there was any previous Augeas handle associated with this
1157 guestfs session, then it is closed.
1159 You must call this before using any other C<guestfs_aug_*>
1162 C<root> is the filesystem root. C<root> must not be NULL,
1165 The flags are the same as the flags defined in
1166 E<lt>augeas.hE<gt>, the logical I<or> of the following
1171 =item C<AUG_SAVE_BACKUP> = 1
1173 Keep the original file with a C<.augsave> extension.
1175 =item C<AUG_SAVE_NEWFILE> = 2
1177 Save changes into a file with extension C<.augnew>, and
1178 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1180 =item C<AUG_TYPE_CHECK> = 4
1182 Typecheck lenses (can be expensive).
1184 =item C<AUG_NO_STDINC> = 8
1186 Do not use standard load path for modules.
1188 =item C<AUG_SAVE_NOOP> = 16
1190 Make save a no-op, just record what would have been changed.
1192 =item C<AUG_NO_LOAD> = 32
1194 Do not load the tree in C<guestfs_aug_init>.
1198 To close the handle, you can call C<guestfs_aug_close>.
1200 To find out more about Augeas, see L<http://augeas.net/>.");
1202 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1203 [], (* XXX Augeas code needs tests. *)
1204 "close the current Augeas handle",
1206 Close the current Augeas handle and free up any resources
1207 used by it. After calling this, you have to call
1208 C<guestfs_aug_init> again before you can use any other
1209 Augeas functions.");
1211 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1212 [], (* XXX Augeas code needs tests. *)
1213 "define an Augeas variable",
1215 Defines an Augeas variable C<name> whose value is the result
1216 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1219 On success this returns the number of nodes in C<expr>, or
1220 C<0> if C<expr> evaluates to something which is not a nodeset.");
1222 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1223 [], (* XXX Augeas code needs tests. *)
1224 "define an Augeas node",
1226 Defines a variable C<name> whose value is the result of
1229 If C<expr> evaluates to an empty nodeset, a node is created,
1230 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1231 C<name> will be the nodeset containing that single node.
1233 On success this returns a pair containing the
1234 number of nodes in the nodeset, and a boolean flag
1235 if a node was created.");
1237 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1238 [], (* XXX Augeas code needs tests. *)
1239 "look up the value of an Augeas path",
1241 Look up the value associated with C<path>. If C<path>
1242 matches exactly one node, the C<value> is returned.");
1244 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1245 [], (* XXX Augeas code needs tests. *)
1246 "set Augeas path to value",
1248 Set the value associated with C<path> to C<value>.");
1250 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1251 [], (* XXX Augeas code needs tests. *)
1252 "insert a sibling Augeas node",
1254 Create a new sibling C<label> for C<path>, inserting it into
1255 the tree before or after C<path> (depending on the boolean
1258 C<path> must match exactly one existing node in the tree, and
1259 C<label> must be a label, ie. not contain C</>, C<*> or end
1260 with a bracketed index C<[N]>.");
1262 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1263 [], (* XXX Augeas code needs tests. *)
1264 "remove an Augeas path",
1266 Remove C<path> and all of its children.
1268 On success this returns the number of entries which were removed.");
1270 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1271 [], (* XXX Augeas code needs tests. *)
1274 Move the node C<src> to C<dest>. C<src> must match exactly
1275 one node. C<dest> is overwritten if it exists.");
1277 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1278 [], (* XXX Augeas code needs tests. *)
1279 "return Augeas nodes which match augpath",
1281 Returns a list of paths which match the path expression C<path>.
1282 The returned paths are sufficiently qualified so that they match
1283 exactly one node in the current tree.");
1285 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1286 [], (* XXX Augeas code needs tests. *)
1287 "write all pending Augeas changes to disk",
1289 This writes all pending changes to disk.
1291 The flags which were passed to C<guestfs_aug_init> affect exactly
1292 how files are saved.");
1294 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1295 [], (* XXX Augeas code needs tests. *)
1296 "load files into the tree",
1298 Load files into the tree.
1300 See C<aug_load> in the Augeas documentation for the full gory
1303 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1304 [], (* XXX Augeas code needs tests. *)
1305 "list Augeas nodes under augpath",
1307 This is just a shortcut for listing C<guestfs_aug_match>
1308 C<path/*> and sorting the resulting nodes into alphabetical order.");
1310 ("rm", (RErr, [Pathname "path"]), 29, [],
1311 [InitBasicFS, Always, TestRun
1314 InitBasicFS, Always, TestLastFail
1316 InitBasicFS, Always, TestLastFail
1321 Remove the single file C<path>.");
1323 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1324 [InitBasicFS, Always, TestRun
1327 InitBasicFS, Always, TestLastFail
1328 [["rmdir"; "/new"]];
1329 InitBasicFS, Always, TestLastFail
1331 ["rmdir"; "/new"]]],
1332 "remove a directory",
1334 Remove the single directory C<path>.");
1336 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1337 [InitBasicFS, Always, TestOutputFalse
1339 ["mkdir"; "/new/foo"];
1340 ["touch"; "/new/foo/bar"];
1342 ["exists"; "/new"]]],
1343 "remove a file or directory recursively",
1345 Remove the file or directory C<path>, recursively removing the
1346 contents if its a directory. This is like the C<rm -rf> shell
1349 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1350 [InitBasicFS, Always, TestOutputTrue
1352 ["is_dir"; "/new"]];
1353 InitBasicFS, Always, TestLastFail
1354 [["mkdir"; "/new/foo/bar"]]],
1355 "create a directory",
1357 Create a directory named C<path>.");
1359 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1360 [InitBasicFS, Always, TestOutputTrue
1361 [["mkdir_p"; "/new/foo/bar"];
1362 ["is_dir"; "/new/foo/bar"]];
1363 InitBasicFS, Always, TestOutputTrue
1364 [["mkdir_p"; "/new/foo/bar"];
1365 ["is_dir"; "/new/foo"]];
1366 InitBasicFS, Always, TestOutputTrue
1367 [["mkdir_p"; "/new/foo/bar"];
1368 ["is_dir"; "/new"]];
1369 (* Regression tests for RHBZ#503133: *)
1370 InitBasicFS, Always, TestRun
1372 ["mkdir_p"; "/new"]];
1373 InitBasicFS, Always, TestLastFail
1375 ["mkdir_p"; "/new"]]],
1376 "create a directory and parents",
1378 Create a directory named C<path>, creating any parent directories
1379 as necessary. This is like the C<mkdir -p> shell command.");
1381 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1382 [], (* XXX Need stat command to test *)
1385 Change the mode (permissions) of C<path> to C<mode>. Only
1386 numeric modes are supported.
1388 I<Note>: When using this command from guestfish, C<mode>
1389 by default would be decimal, unless you prefix it with
1390 C<0> to get octal, ie. use C<0700> not C<700>.
1392 The mode actually set is affected by the umask.");
1394 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1395 [], (* XXX Need stat command to test *)
1396 "change file owner and group",
1398 Change the file owner to C<owner> and group to C<group>.
1400 Only numeric uid and gid are supported. If you want to use
1401 names, you will need to locate and parse the password file
1402 yourself (Augeas support makes this relatively easy).");
1404 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1405 [InitISOFS, Always, TestOutputTrue (
1406 [["exists"; "/empty"]]);
1407 InitISOFS, Always, TestOutputTrue (
1408 [["exists"; "/directory"]])],
1409 "test if file or directory exists",
1411 This returns C<true> if and only if there is a file, directory
1412 (or anything) with the given C<path> name.
1414 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1416 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1417 [InitISOFS, Always, TestOutputTrue (
1418 [["is_file"; "/known-1"]]);
1419 InitISOFS, Always, TestOutputFalse (
1420 [["is_file"; "/directory"]])],
1421 "test if file exists",
1423 This returns C<true> if and only if there is a file
1424 with the given C<path> name. Note that it returns false for
1425 other objects like directories.
1427 See also C<guestfs_stat>.");
1429 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1430 [InitISOFS, Always, TestOutputFalse (
1431 [["is_dir"; "/known-3"]]);
1432 InitISOFS, Always, TestOutputTrue (
1433 [["is_dir"; "/directory"]])],
1434 "test if file exists",
1436 This returns C<true> if and only if there is a directory
1437 with the given C<path> name. Note that it returns false for
1438 other objects like files.
1440 See also C<guestfs_stat>.");
1442 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1443 [InitEmpty, Always, TestOutputListOfDevices (
1444 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1445 ["pvcreate"; "/dev/sda1"];
1446 ["pvcreate"; "/dev/sda2"];
1447 ["pvcreate"; "/dev/sda3"];
1448 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1449 "create an LVM physical volume",
1451 This creates an LVM physical volume on the named C<device>,
1452 where C<device> should usually be a partition name such
1455 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1456 [InitEmpty, Always, TestOutputList (
1457 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1458 ["pvcreate"; "/dev/sda1"];
1459 ["pvcreate"; "/dev/sda2"];
1460 ["pvcreate"; "/dev/sda3"];
1461 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1462 ["vgcreate"; "VG2"; "/dev/sda3"];
1463 ["vgs"]], ["VG1"; "VG2"])],
1464 "create an LVM volume group",
1466 This creates an LVM volume group called C<volgroup>
1467 from the non-empty list of physical volumes C<physvols>.");
1469 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1470 [InitEmpty, Always, TestOutputList (
1471 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1472 ["pvcreate"; "/dev/sda1"];
1473 ["pvcreate"; "/dev/sda2"];
1474 ["pvcreate"; "/dev/sda3"];
1475 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1476 ["vgcreate"; "VG2"; "/dev/sda3"];
1477 ["lvcreate"; "LV1"; "VG1"; "50"];
1478 ["lvcreate"; "LV2"; "VG1"; "50"];
1479 ["lvcreate"; "LV3"; "VG2"; "50"];
1480 ["lvcreate"; "LV4"; "VG2"; "50"];
1481 ["lvcreate"; "LV5"; "VG2"; "50"];
1483 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1484 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1485 "create an LVM logical volume",
1487 This creates an LVM logical volume called C<logvol>
1488 on the volume group C<volgroup>, with C<size> megabytes.");
1490 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1491 [InitEmpty, Always, TestOutput (
1492 [["part_disk"; "/dev/sda"; "mbr"];
1493 ["mkfs"; "ext2"; "/dev/sda1"];
1494 ["mount_options"; ""; "/dev/sda1"; "/"];
1495 ["write_file"; "/new"; "new file contents"; "0"];
1496 ["cat"; "/new"]], "new file contents")],
1497 "make a filesystem",
1499 This creates a filesystem on C<device> (usually a partition
1500 or LVM logical volume). The filesystem type is C<fstype>, for
1503 ("sfdisk", (RErr, [Device "device";
1504 Int "cyls"; Int "heads"; Int "sectors";
1505 StringList "lines"]), 43, [DangerWillRobinson],
1507 "create partitions on a block device",
1509 This is a direct interface to the L<sfdisk(8)> program for creating
1510 partitions on block devices.
1512 C<device> should be a block device, for example C</dev/sda>.
1514 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1515 and sectors on the device, which are passed directly to sfdisk as
1516 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1517 of these, then the corresponding parameter is omitted. Usually for
1518 'large' disks, you can just pass C<0> for these, but for small
1519 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1520 out the right geometry and you will need to tell it.
1522 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1523 information refer to the L<sfdisk(8)> manpage.
1525 To create a single partition occupying the whole disk, you would
1526 pass C<lines> as a single element list, when the single element being
1527 the string C<,> (comma).
1529 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1530 C<guestfs_part_init>");
1532 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1533 [InitBasicFS, Always, TestOutput (
1534 [["write_file"; "/new"; "new file contents"; "0"];
1535 ["cat"; "/new"]], "new file contents");
1536 InitBasicFS, Always, TestOutput (
1537 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1538 ["cat"; "/new"]], "\nnew file contents\n");
1539 InitBasicFS, Always, TestOutput (
1540 [["write_file"; "/new"; "\n\n"; "0"];
1541 ["cat"; "/new"]], "\n\n");
1542 InitBasicFS, Always, TestOutput (
1543 [["write_file"; "/new"; ""; "0"];
1544 ["cat"; "/new"]], "");
1545 InitBasicFS, Always, TestOutput (
1546 [["write_file"; "/new"; "\n\n\n"; "0"];
1547 ["cat"; "/new"]], "\n\n\n");
1548 InitBasicFS, Always, TestOutput (
1549 [["write_file"; "/new"; "\n"; "0"];
1550 ["cat"; "/new"]], "\n")],
1553 This call creates a file called C<path>. The contents of the
1554 file is the string C<content> (which can contain any 8 bit data),
1555 with length C<size>.
1557 As a special case, if C<size> is C<0>
1558 then the length is calculated using C<strlen> (so in this case
1559 the content cannot contain embedded ASCII NULs).
1561 I<NB.> Owing to a bug, writing content containing ASCII NUL
1562 characters does I<not> work, even if the length is specified.
1563 We hope to resolve this bug in a future version. In the meantime
1564 use C<guestfs_upload>.");
1566 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1567 [InitEmpty, Always, TestOutputListOfDevices (
1568 [["part_disk"; "/dev/sda"; "mbr"];
1569 ["mkfs"; "ext2"; "/dev/sda1"];
1570 ["mount_options"; ""; "/dev/sda1"; "/"];
1571 ["mounts"]], ["/dev/sda1"]);
1572 InitEmpty, Always, TestOutputList (
1573 [["part_disk"; "/dev/sda"; "mbr"];
1574 ["mkfs"; "ext2"; "/dev/sda1"];
1575 ["mount_options"; ""; "/dev/sda1"; "/"];
1578 "unmount a filesystem",
1580 This unmounts the given filesystem. The filesystem may be
1581 specified either by its mountpoint (path) or the device which
1582 contains the filesystem.");
1584 ("mounts", (RStringList "devices", []), 46, [],
1585 [InitBasicFS, Always, TestOutputListOfDevices (
1586 [["mounts"]], ["/dev/sda1"])],
1587 "show mounted filesystems",
1589 This returns the list of currently mounted filesystems. It returns
1590 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1592 Some internal mounts are not shown.
1594 See also: C<guestfs_mountpoints>");
1596 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1597 [InitBasicFS, Always, TestOutputList (
1600 (* check that umount_all can unmount nested mounts correctly: *)
1601 InitEmpty, Always, TestOutputList (
1602 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1603 ["mkfs"; "ext2"; "/dev/sda1"];
1604 ["mkfs"; "ext2"; "/dev/sda2"];
1605 ["mkfs"; "ext2"; "/dev/sda3"];
1606 ["mount_options"; ""; "/dev/sda1"; "/"];
1608 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1609 ["mkdir"; "/mp1/mp2"];
1610 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1611 ["mkdir"; "/mp1/mp2/mp3"];
1614 "unmount all filesystems",
1616 This unmounts all mounted filesystems.
1618 Some internal mounts are not unmounted by this call.");
1620 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1622 "remove all LVM LVs, VGs and PVs",
1624 This command removes all LVM logical volumes, volume groups
1625 and physical volumes.");
1627 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1628 [InitISOFS, Always, TestOutput (
1629 [["file"; "/empty"]], "empty");
1630 InitISOFS, Always, TestOutput (
1631 [["file"; "/known-1"]], "ASCII text");
1632 InitISOFS, Always, TestLastFail (
1633 [["file"; "/notexists"]])],
1634 "determine file type",
1636 This call uses the standard L<file(1)> command to determine
1637 the type or contents of the file. This also works on devices,
1638 for example to find out whether a partition contains a filesystem.
1640 This call will also transparently look inside various types
1643 The exact command which runs is C<file -zbsL path>. Note in
1644 particular that the filename is not prepended to the output
1645 (the C<-b> option).");
1647 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1648 [InitBasicFS, Always, TestOutput (
1649 [["upload"; "test-command"; "/test-command"];
1650 ["chmod"; "0o755"; "/test-command"];
1651 ["command"; "/test-command 1"]], "Result1");
1652 InitBasicFS, Always, TestOutput (
1653 [["upload"; "test-command"; "/test-command"];
1654 ["chmod"; "0o755"; "/test-command"];
1655 ["command"; "/test-command 2"]], "Result2\n");
1656 InitBasicFS, Always, TestOutput (
1657 [["upload"; "test-command"; "/test-command"];
1658 ["chmod"; "0o755"; "/test-command"];
1659 ["command"; "/test-command 3"]], "\nResult3");
1660 InitBasicFS, Always, TestOutput (
1661 [["upload"; "test-command"; "/test-command"];
1662 ["chmod"; "0o755"; "/test-command"];
1663 ["command"; "/test-command 4"]], "\nResult4\n");
1664 InitBasicFS, Always, TestOutput (
1665 [["upload"; "test-command"; "/test-command"];
1666 ["chmod"; "0o755"; "/test-command"];
1667 ["command"; "/test-command 5"]], "\nResult5\n\n");
1668 InitBasicFS, Always, TestOutput (
1669 [["upload"; "test-command"; "/test-command"];
1670 ["chmod"; "0o755"; "/test-command"];
1671 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1672 InitBasicFS, Always, TestOutput (
1673 [["upload"; "test-command"; "/test-command"];
1674 ["chmod"; "0o755"; "/test-command"];
1675 ["command"; "/test-command 7"]], "");
1676 InitBasicFS, Always, TestOutput (
1677 [["upload"; "test-command"; "/test-command"];
1678 ["chmod"; "0o755"; "/test-command"];
1679 ["command"; "/test-command 8"]], "\n");
1680 InitBasicFS, Always, TestOutput (
1681 [["upload"; "test-command"; "/test-command"];
1682 ["chmod"; "0o755"; "/test-command"];
1683 ["command"; "/test-command 9"]], "\n\n");
1684 InitBasicFS, Always, TestOutput (
1685 [["upload"; "test-command"; "/test-command"];
1686 ["chmod"; "0o755"; "/test-command"];
1687 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1688 InitBasicFS, Always, TestOutput (
1689 [["upload"; "test-command"; "/test-command"];
1690 ["chmod"; "0o755"; "/test-command"];
1691 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1692 InitBasicFS, Always, TestLastFail (
1693 [["upload"; "test-command"; "/test-command"];
1694 ["chmod"; "0o755"; "/test-command"];
1695 ["command"; "/test-command"]])],
1696 "run a command from the guest filesystem",
1698 This call runs a command from the guest filesystem. The
1699 filesystem must be mounted, and must contain a compatible
1700 operating system (ie. something Linux, with the same
1701 or compatible processor architecture).
1703 The single parameter is an argv-style list of arguments.
1704 The first element is the name of the program to run.
1705 Subsequent elements are parameters. The list must be
1706 non-empty (ie. must contain a program name). Note that
1707 the command runs directly, and is I<not> invoked via
1708 the shell (see C<guestfs_sh>).
1710 The return value is anything printed to I<stdout> by
1713 If the command returns a non-zero exit status, then
1714 this function returns an error message. The error message
1715 string is the content of I<stderr> from the command.
1717 The C<$PATH> environment variable will contain at least
1718 C</usr/bin> and C</bin>. If you require a program from
1719 another location, you should provide the full path in the
1722 Shared libraries and data files required by the program
1723 must be available on filesystems which are mounted in the
1724 correct places. It is the caller's responsibility to ensure
1725 all filesystems that are needed are mounted at the right
1728 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1729 [InitBasicFS, Always, TestOutputList (
1730 [["upload"; "test-command"; "/test-command"];
1731 ["chmod"; "0o755"; "/test-command"];
1732 ["command_lines"; "/test-command 1"]], ["Result1"]);
1733 InitBasicFS, Always, TestOutputList (
1734 [["upload"; "test-command"; "/test-command"];
1735 ["chmod"; "0o755"; "/test-command"];
1736 ["command_lines"; "/test-command 2"]], ["Result2"]);
1737 InitBasicFS, Always, TestOutputList (
1738 [["upload"; "test-command"; "/test-command"];
1739 ["chmod"; "0o755"; "/test-command"];
1740 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1741 InitBasicFS, Always, TestOutputList (
1742 [["upload"; "test-command"; "/test-command"];
1743 ["chmod"; "0o755"; "/test-command"];
1744 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1745 InitBasicFS, Always, TestOutputList (
1746 [["upload"; "test-command"; "/test-command"];
1747 ["chmod"; "0o755"; "/test-command"];
1748 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1749 InitBasicFS, Always, TestOutputList (
1750 [["upload"; "test-command"; "/test-command"];
1751 ["chmod"; "0o755"; "/test-command"];
1752 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1753 InitBasicFS, Always, TestOutputList (
1754 [["upload"; "test-command"; "/test-command"];
1755 ["chmod"; "0o755"; "/test-command"];
1756 ["command_lines"; "/test-command 7"]], []);
1757 InitBasicFS, Always, TestOutputList (
1758 [["upload"; "test-command"; "/test-command"];
1759 ["chmod"; "0o755"; "/test-command"];
1760 ["command_lines"; "/test-command 8"]], [""]);
1761 InitBasicFS, Always, TestOutputList (
1762 [["upload"; "test-command"; "/test-command"];
1763 ["chmod"; "0o755"; "/test-command"];
1764 ["command_lines"; "/test-command 9"]], ["";""]);
1765 InitBasicFS, Always, TestOutputList (
1766 [["upload"; "test-command"; "/test-command"];
1767 ["chmod"; "0o755"; "/test-command"];
1768 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1769 InitBasicFS, Always, TestOutputList (
1770 [["upload"; "test-command"; "/test-command"];
1771 ["chmod"; "0o755"; "/test-command"];
1772 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1773 "run a command, returning lines",
1775 This is the same as C<guestfs_command>, but splits the
1776 result into a list of lines.
1778 See also: C<guestfs_sh_lines>");
1780 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1781 [InitISOFS, Always, TestOutputStruct (
1782 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1783 "get file information",
1785 Returns file information for the given C<path>.
1787 This is the same as the C<stat(2)> system call.");
1789 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1790 [InitISOFS, Always, TestOutputStruct (
1791 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1792 "get file information for a symbolic link",
1794 Returns file information for the given C<path>.
1796 This is the same as C<guestfs_stat> except that if C<path>
1797 is a symbolic link, then the link is stat-ed, not the file it
1800 This is the same as the C<lstat(2)> system call.");
1802 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1803 [InitISOFS, Always, TestOutputStruct (
1804 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1805 "get file system statistics",
1807 Returns file system statistics for any mounted file system.
1808 C<path> should be a file or directory in the mounted file system
1809 (typically it is the mount point itself, but it doesn't need to be).
1811 This is the same as the C<statvfs(2)> system call.");
1813 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1815 "get ext2/ext3/ext4 superblock details",
1817 This returns the contents of the ext2, ext3 or ext4 filesystem
1818 superblock on C<device>.
1820 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1821 manpage for more details. The list of fields returned isn't
1822 clearly defined, and depends on both the version of C<tune2fs>
1823 that libguestfs was built against, and the filesystem itself.");
1825 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1826 [InitEmpty, Always, TestOutputTrue (
1827 [["blockdev_setro"; "/dev/sda"];
1828 ["blockdev_getro"; "/dev/sda"]])],
1829 "set block device to read-only",
1831 Sets the block device named C<device> to read-only.
1833 This uses the L<blockdev(8)> command.");
1835 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1836 [InitEmpty, Always, TestOutputFalse (
1837 [["blockdev_setrw"; "/dev/sda"];
1838 ["blockdev_getro"; "/dev/sda"]])],
1839 "set block device to read-write",
1841 Sets the block device named C<device> to read-write.
1843 This uses the L<blockdev(8)> command.");
1845 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1846 [InitEmpty, Always, TestOutputTrue (
1847 [["blockdev_setro"; "/dev/sda"];
1848 ["blockdev_getro"; "/dev/sda"]])],
1849 "is block device set to read-only",
1851 Returns a boolean indicating if the block device is read-only
1852 (true if read-only, false if not).
1854 This uses the L<blockdev(8)> command.");
1856 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1857 [InitEmpty, Always, TestOutputInt (
1858 [["blockdev_getss"; "/dev/sda"]], 512)],
1859 "get sectorsize of block device",
1861 This returns the size of sectors on a block device.
1862 Usually 512, but can be larger for modern devices.
1864 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1867 This uses the L<blockdev(8)> command.");
1869 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1870 [InitEmpty, Always, TestOutputInt (
1871 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1872 "get blocksize of block device",
1874 This returns 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_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1883 "set blocksize of block device",
1885 This sets the block size of a device.
1887 (Note this is different from both I<size in blocks> and
1888 I<filesystem block size>).
1890 This uses the L<blockdev(8)> command.");
1892 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1893 [InitEmpty, Always, TestOutputInt (
1894 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1895 "get total size of device in 512-byte sectors",
1897 This returns the size of the device in units of 512-byte sectors
1898 (even if the sectorsize isn't 512 bytes ... weird).
1900 See also C<guestfs_blockdev_getss> for the real sector size of
1901 the device, and C<guestfs_blockdev_getsize64> for the more
1902 useful I<size in bytes>.
1904 This uses the L<blockdev(8)> command.");
1906 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1907 [InitEmpty, Always, TestOutputInt (
1908 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1909 "get total size of device in bytes",
1911 This returns the size of the device in bytes.
1913 See also C<guestfs_blockdev_getsz>.
1915 This uses the L<blockdev(8)> command.");
1917 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1918 [InitEmpty, Always, TestRun
1919 [["blockdev_flushbufs"; "/dev/sda"]]],
1920 "flush device buffers",
1922 This tells the kernel to flush internal buffers associated
1925 This uses the L<blockdev(8)> command.");
1927 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1928 [InitEmpty, Always, TestRun
1929 [["blockdev_rereadpt"; "/dev/sda"]]],
1930 "reread partition table",
1932 Reread the partition table on C<device>.
1934 This uses the L<blockdev(8)> command.");
1936 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1937 [InitBasicFS, Always, TestOutput (
1938 (* Pick a file from cwd which isn't likely to change. *)
1939 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1940 ["checksum"; "md5"; "/COPYING.LIB"]],
1941 Digest.to_hex (Digest.file "COPYING.LIB"))],
1942 "upload a file from the local machine",
1944 Upload local file C<filename> to C<remotefilename> on the
1947 C<filename> can also be a named pipe.
1949 See also C<guestfs_download>.");
1951 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1952 [InitBasicFS, Always, TestOutput (
1953 (* Pick a file from cwd which isn't likely to change. *)
1954 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1955 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1956 ["upload"; "testdownload.tmp"; "/upload"];
1957 ["checksum"; "md5"; "/upload"]],
1958 Digest.to_hex (Digest.file "COPYING.LIB"))],
1959 "download a file to the local machine",
1961 Download file C<remotefilename> and save it as C<filename>
1962 on the local machine.
1964 C<filename> can also be a named pipe.
1966 See also C<guestfs_upload>, C<guestfs_cat>.");
1968 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1969 [InitISOFS, Always, TestOutput (
1970 [["checksum"; "crc"; "/known-3"]], "2891671662");
1971 InitISOFS, Always, TestLastFail (
1972 [["checksum"; "crc"; "/notexists"]]);
1973 InitISOFS, Always, TestOutput (
1974 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1975 InitISOFS, Always, TestOutput (
1976 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1977 InitISOFS, Always, TestOutput (
1978 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1979 InitISOFS, Always, TestOutput (
1980 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1981 InitISOFS, Always, TestOutput (
1982 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1983 InitISOFS, Always, TestOutput (
1984 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1985 "compute MD5, SHAx or CRC checksum of file",
1987 This call computes the MD5, SHAx or CRC checksum of the
1990 The type of checksum to compute is given by the C<csumtype>
1991 parameter which must have one of the following values:
1997 Compute the cyclic redundancy check (CRC) specified by POSIX
1998 for the C<cksum> command.
2002 Compute the MD5 hash (using the C<md5sum> program).
2006 Compute the SHA1 hash (using the C<sha1sum> program).
2010 Compute the SHA224 hash (using the C<sha224sum> program).
2014 Compute the SHA256 hash (using the C<sha256sum> program).
2018 Compute the SHA384 hash (using the C<sha384sum> program).
2022 Compute the SHA512 hash (using the C<sha512sum> program).
2026 The checksum is returned as a printable string.");
2028 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
2029 [InitBasicFS, Always, TestOutput (
2030 [["tar_in"; "../images/helloworld.tar"; "/"];
2031 ["cat"; "/hello"]], "hello\n")],
2032 "unpack tarfile to directory",
2034 This command uploads and unpacks local file C<tarfile> (an
2035 I<uncompressed> tar file) into C<directory>.
2037 To upload a compressed tarball, use C<guestfs_tgz_in>.");
2039 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2041 "pack directory into tarfile",
2043 This command packs the contents of C<directory> and downloads
2044 it to local file C<tarfile>.
2046 To download a compressed tarball, use C<guestfs_tgz_out>.");
2048 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
2049 [InitBasicFS, Always, TestOutput (
2050 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2051 ["cat"; "/hello"]], "hello\n")],
2052 "unpack compressed tarball to directory",
2054 This command uploads and unpacks local file C<tarball> (a
2055 I<gzip compressed> tar file) into C<directory>.
2057 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2059 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2061 "pack directory into compressed tarball",
2063 This command packs the contents of C<directory> and downloads
2064 it to local file C<tarball>.
2066 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2068 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2069 [InitBasicFS, Always, TestLastFail (
2071 ["mount_ro"; "/dev/sda1"; "/"];
2072 ["touch"; "/new"]]);
2073 InitBasicFS, Always, TestOutput (
2074 [["write_file"; "/new"; "data"; "0"];
2076 ["mount_ro"; "/dev/sda1"; "/"];
2077 ["cat"; "/new"]], "data")],
2078 "mount a guest disk, read-only",
2080 This is the same as the C<guestfs_mount> command, but it
2081 mounts the filesystem with the read-only (I<-o ro>) flag.");
2083 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2085 "mount a guest disk with mount options",
2087 This is the same as the C<guestfs_mount> command, but it
2088 allows you to set the mount options as for the
2089 L<mount(8)> I<-o> flag.
2091 If the C<options> parameter is an empty string, then
2092 no options are passed (all options default to whatever
2093 the filesystem uses).");
2095 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2097 "mount a guest disk with mount options and vfstype",
2099 This is the same as the C<guestfs_mount> command, but it
2100 allows you to set both the mount options and the vfstype
2101 as for the L<mount(8)> I<-o> and I<-t> flags.");
2103 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2105 "debugging and internals",
2107 The C<guestfs_debug> command exposes some internals of
2108 C<guestfsd> (the guestfs daemon) that runs inside the
2111 There is no comprehensive help for this command. You have
2112 to look at the file C<daemon/debug.c> in the libguestfs source
2113 to find out what you can do.");
2115 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2116 [InitEmpty, Always, TestOutputList (
2117 [["part_disk"; "/dev/sda"; "mbr"];
2118 ["pvcreate"; "/dev/sda1"];
2119 ["vgcreate"; "VG"; "/dev/sda1"];
2120 ["lvcreate"; "LV1"; "VG"; "50"];
2121 ["lvcreate"; "LV2"; "VG"; "50"];
2122 ["lvremove"; "/dev/VG/LV1"];
2123 ["lvs"]], ["/dev/VG/LV2"]);
2124 InitEmpty, Always, TestOutputList (
2125 [["part_disk"; "/dev/sda"; "mbr"];
2126 ["pvcreate"; "/dev/sda1"];
2127 ["vgcreate"; "VG"; "/dev/sda1"];
2128 ["lvcreate"; "LV1"; "VG"; "50"];
2129 ["lvcreate"; "LV2"; "VG"; "50"];
2130 ["lvremove"; "/dev/VG"];
2132 InitEmpty, Always, TestOutputList (
2133 [["part_disk"; "/dev/sda"; "mbr"];
2134 ["pvcreate"; "/dev/sda1"];
2135 ["vgcreate"; "VG"; "/dev/sda1"];
2136 ["lvcreate"; "LV1"; "VG"; "50"];
2137 ["lvcreate"; "LV2"; "VG"; "50"];
2138 ["lvremove"; "/dev/VG"];
2140 "remove an LVM logical volume",
2142 Remove an LVM logical volume C<device>, where C<device> is
2143 the path to the LV, such as C</dev/VG/LV>.
2145 You can also remove all LVs in a volume group by specifying
2146 the VG name, C</dev/VG>.");
2148 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2149 [InitEmpty, Always, TestOutputList (
2150 [["part_disk"; "/dev/sda"; "mbr"];
2151 ["pvcreate"; "/dev/sda1"];
2152 ["vgcreate"; "VG"; "/dev/sda1"];
2153 ["lvcreate"; "LV1"; "VG"; "50"];
2154 ["lvcreate"; "LV2"; "VG"; "50"];
2157 InitEmpty, Always, TestOutputList (
2158 [["part_disk"; "/dev/sda"; "mbr"];
2159 ["pvcreate"; "/dev/sda1"];
2160 ["vgcreate"; "VG"; "/dev/sda1"];
2161 ["lvcreate"; "LV1"; "VG"; "50"];
2162 ["lvcreate"; "LV2"; "VG"; "50"];
2165 "remove an LVM volume group",
2167 Remove an LVM volume group C<vgname>, (for example C<VG>).
2169 This also forcibly removes all logical volumes in the volume
2172 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2173 [InitEmpty, Always, TestOutputListOfDevices (
2174 [["part_disk"; "/dev/sda"; "mbr"];
2175 ["pvcreate"; "/dev/sda1"];
2176 ["vgcreate"; "VG"; "/dev/sda1"];
2177 ["lvcreate"; "LV1"; "VG"; "50"];
2178 ["lvcreate"; "LV2"; "VG"; "50"];
2180 ["pvremove"; "/dev/sda1"];
2182 InitEmpty, Always, TestOutputListOfDevices (
2183 [["part_disk"; "/dev/sda"; "mbr"];
2184 ["pvcreate"; "/dev/sda1"];
2185 ["vgcreate"; "VG"; "/dev/sda1"];
2186 ["lvcreate"; "LV1"; "VG"; "50"];
2187 ["lvcreate"; "LV2"; "VG"; "50"];
2189 ["pvremove"; "/dev/sda1"];
2191 InitEmpty, Always, TestOutputListOfDevices (
2192 [["part_disk"; "/dev/sda"; "mbr"];
2193 ["pvcreate"; "/dev/sda1"];
2194 ["vgcreate"; "VG"; "/dev/sda1"];
2195 ["lvcreate"; "LV1"; "VG"; "50"];
2196 ["lvcreate"; "LV2"; "VG"; "50"];
2198 ["pvremove"; "/dev/sda1"];
2200 "remove an LVM physical volume",
2202 This wipes a physical volume C<device> so that LVM will no longer
2205 The implementation uses the C<pvremove> command which refuses to
2206 wipe physical volumes that contain any volume groups, so you have
2207 to remove those first.");
2209 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2210 [InitBasicFS, Always, TestOutput (
2211 [["set_e2label"; "/dev/sda1"; "testlabel"];
2212 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2213 "set the ext2/3/4 filesystem label",
2215 This sets the ext2/3/4 filesystem label of the filesystem on
2216 C<device> to C<label>. Filesystem labels are limited to
2219 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2220 to return the existing label on a filesystem.");
2222 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2224 "get the ext2/3/4 filesystem label",
2226 This returns the ext2/3/4 filesystem label of the filesystem on
2229 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2230 (let uuid = uuidgen () in
2231 [InitBasicFS, Always, TestOutput (
2232 [["set_e2uuid"; "/dev/sda1"; uuid];
2233 ["get_e2uuid"; "/dev/sda1"]], uuid);
2234 InitBasicFS, Always, TestOutput (
2235 [["set_e2uuid"; "/dev/sda1"; "clear"];
2236 ["get_e2uuid"; "/dev/sda1"]], "");
2237 (* We can't predict what UUIDs will be, so just check the commands run. *)
2238 InitBasicFS, Always, TestRun (
2239 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2240 InitBasicFS, Always, TestRun (
2241 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2242 "set the ext2/3/4 filesystem UUID",
2244 This sets the ext2/3/4 filesystem UUID of the filesystem on
2245 C<device> to C<uuid>. The format of the UUID and alternatives
2246 such as C<clear>, C<random> and C<time> are described in the
2247 L<tune2fs(8)> manpage.
2249 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2250 to return the existing UUID of a filesystem.");
2252 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2254 "get the ext2/3/4 filesystem UUID",
2256 This returns the ext2/3/4 filesystem UUID of the filesystem on
2259 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2260 [InitBasicFS, Always, TestOutputInt (
2261 [["umount"; "/dev/sda1"];
2262 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2263 InitBasicFS, Always, TestOutputInt (
2264 [["umount"; "/dev/sda1"];
2265 ["zero"; "/dev/sda1"];
2266 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2267 "run the filesystem checker",
2269 This runs the filesystem checker (fsck) on C<device> which
2270 should have filesystem type C<fstype>.
2272 The returned integer is the status. See L<fsck(8)> for the
2273 list of status codes from C<fsck>.
2281 Multiple status codes can be summed together.
2285 A non-zero return code can mean \"success\", for example if
2286 errors have been corrected on the filesystem.
2290 Checking or repairing NTFS volumes is not supported
2295 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2297 ("zero", (RErr, [Device "device"]), 85, [],
2298 [InitBasicFS, Always, TestOutput (
2299 [["umount"; "/dev/sda1"];
2300 ["zero"; "/dev/sda1"];
2301 ["file"; "/dev/sda1"]], "data")],
2302 "write zeroes to the device",
2304 This command writes zeroes over the first few blocks of C<device>.
2306 How many blocks are zeroed isn't specified (but it's I<not> enough
2307 to securely wipe the device). It should be sufficient to remove
2308 any partition tables, filesystem superblocks and so on.
2310 See also: C<guestfs_scrub_device>.");
2312 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2313 (* Test disabled because grub-install incompatible with virtio-blk driver.
2314 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2316 [InitBasicFS, Disabled, TestOutputTrue (
2317 [["grub_install"; "/"; "/dev/sda1"];
2318 ["is_dir"; "/boot"]])],
2321 This command installs GRUB (the Grand Unified Bootloader) on
2322 C<device>, with the root directory being C<root>.");
2324 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2325 [InitBasicFS, Always, TestOutput (
2326 [["write_file"; "/old"; "file content"; "0"];
2327 ["cp"; "/old"; "/new"];
2328 ["cat"; "/new"]], "file content");
2329 InitBasicFS, Always, TestOutputTrue (
2330 [["write_file"; "/old"; "file content"; "0"];
2331 ["cp"; "/old"; "/new"];
2332 ["is_file"; "/old"]]);
2333 InitBasicFS, Always, TestOutput (
2334 [["write_file"; "/old"; "file content"; "0"];
2336 ["cp"; "/old"; "/dir/new"];
2337 ["cat"; "/dir/new"]], "file content")],
2340 This copies a file from C<src> to C<dest> where C<dest> is
2341 either a destination filename or destination directory.");
2343 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2344 [InitBasicFS, Always, TestOutput (
2345 [["mkdir"; "/olddir"];
2346 ["mkdir"; "/newdir"];
2347 ["write_file"; "/olddir/file"; "file content"; "0"];
2348 ["cp_a"; "/olddir"; "/newdir"];
2349 ["cat"; "/newdir/olddir/file"]], "file content")],
2350 "copy a file or directory recursively",
2352 This copies a file or directory from C<src> to C<dest>
2353 recursively using the C<cp -a> command.");
2355 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2356 [InitBasicFS, Always, TestOutput (
2357 [["write_file"; "/old"; "file content"; "0"];
2358 ["mv"; "/old"; "/new"];
2359 ["cat"; "/new"]], "file content");
2360 InitBasicFS, Always, TestOutputFalse (
2361 [["write_file"; "/old"; "file content"; "0"];
2362 ["mv"; "/old"; "/new"];
2363 ["is_file"; "/old"]])],
2366 This moves a file from C<src> to C<dest> where C<dest> is
2367 either a destination filename or destination directory.");
2369 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2370 [InitEmpty, Always, TestRun (
2371 [["drop_caches"; "3"]])],
2372 "drop kernel page cache, dentries and inodes",
2374 This instructs the guest kernel to drop its page cache,
2375 and/or dentries and inode caches. The parameter C<whattodrop>
2376 tells the kernel what precisely to drop, see
2377 L<http://linux-mm.org/Drop_Caches>
2379 Setting C<whattodrop> to 3 should drop everything.
2381 This automatically calls L<sync(2)> before the operation,
2382 so that the maximum guest memory is freed.");
2384 ("dmesg", (RString "kmsgs", []), 91, [],
2385 [InitEmpty, Always, TestRun (
2387 "return kernel messages",
2389 This returns the kernel messages (C<dmesg> output) from
2390 the guest kernel. This is sometimes useful for extended
2391 debugging of problems.
2393 Another way to get the same information is to enable
2394 verbose messages with C<guestfs_set_verbose> or by setting
2395 the environment variable C<LIBGUESTFS_DEBUG=1> before
2396 running the program.");
2398 ("ping_daemon", (RErr, []), 92, [],
2399 [InitEmpty, Always, TestRun (
2400 [["ping_daemon"]])],
2401 "ping the guest daemon",
2403 This is a test probe into the guestfs daemon running inside
2404 the qemu subprocess. Calling this function checks that the
2405 daemon responds to the ping message, without affecting the daemon
2406 or attached block device(s) in any other way.");
2408 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2409 [InitBasicFS, Always, TestOutputTrue (
2410 [["write_file"; "/file1"; "contents of a file"; "0"];
2411 ["cp"; "/file1"; "/file2"];
2412 ["equal"; "/file1"; "/file2"]]);
2413 InitBasicFS, Always, TestOutputFalse (
2414 [["write_file"; "/file1"; "contents of a file"; "0"];
2415 ["write_file"; "/file2"; "contents of another file"; "0"];
2416 ["equal"; "/file1"; "/file2"]]);
2417 InitBasicFS, Always, TestLastFail (
2418 [["equal"; "/file1"; "/file2"]])],
2419 "test if two files have equal contents",
2421 This compares the two files C<file1> and C<file2> and returns
2422 true if their content is exactly equal, or false otherwise.
2424 The external L<cmp(1)> program is used for the comparison.");
2426 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2427 [InitISOFS, Always, TestOutputList (
2428 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2429 InitISOFS, Always, TestOutputList (
2430 [["strings"; "/empty"]], [])],
2431 "print the printable strings in a file",
2433 This runs the L<strings(1)> command on a file and returns
2434 the list of printable strings found.");
2436 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2437 [InitISOFS, Always, TestOutputList (
2438 [["strings_e"; "b"; "/known-5"]], []);
2439 InitBasicFS, Disabled, TestOutputList (
2440 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2441 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2442 "print the printable strings in a file",
2444 This is like the C<guestfs_strings> command, but allows you to
2445 specify the encoding of strings that are looked for in
2446 the source file C<path>.
2448 Allowed encodings are:
2454 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2455 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2459 Single 8-bit-byte characters.
2463 16-bit big endian strings such as those encoded in
2464 UTF-16BE or UCS-2BE.
2466 =item l (lower case letter L)
2468 16-bit little endian such as UTF-16LE and UCS-2LE.
2469 This is useful for examining binaries in Windows guests.
2473 32-bit big endian such as UCS-4BE.
2477 32-bit little endian such as UCS-4LE.
2481 The returned strings are transcoded to UTF-8.");
2483 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2484 [InitISOFS, Always, TestOutput (
2485 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2486 (* Test for RHBZ#501888c2 regression which caused large hexdump
2487 * commands to segfault.
2489 InitISOFS, Always, TestRun (
2490 [["hexdump"; "/100krandom"]])],
2491 "dump a file in hexadecimal",
2493 This runs C<hexdump -C> on the given C<path>. The result is
2494 the human-readable, canonical hex dump of the file.");
2496 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2497 [InitNone, Always, TestOutput (
2498 [["part_disk"; "/dev/sda"; "mbr"];
2499 ["mkfs"; "ext3"; "/dev/sda1"];
2500 ["mount_options"; ""; "/dev/sda1"; "/"];
2501 ["write_file"; "/new"; "test file"; "0"];
2502 ["umount"; "/dev/sda1"];
2503 ["zerofree"; "/dev/sda1"];
2504 ["mount_options"; ""; "/dev/sda1"; "/"];
2505 ["cat"; "/new"]], "test file")],
2506 "zero unused inodes and disk blocks on ext2/3 filesystem",
2508 This runs the I<zerofree> program on C<device>. This program
2509 claims to zero unused inodes and disk blocks on an ext2/3
2510 filesystem, thus making it possible to compress the filesystem
2513 You should B<not> run this program if the filesystem is
2516 It is possible that using this program can damage the filesystem
2517 or data on the filesystem.");
2519 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2521 "resize an LVM physical volume",
2523 This resizes (expands or shrinks) an existing LVM physical
2524 volume to match the new size of the underlying device.");
2526 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2527 Int "cyls"; Int "heads"; Int "sectors";
2528 String "line"]), 99, [DangerWillRobinson],
2530 "modify a single partition on a block device",
2532 This runs L<sfdisk(8)> option to modify just the single
2533 partition C<n> (note: C<n> counts from 1).
2535 For other parameters, see C<guestfs_sfdisk>. You should usually
2536 pass C<0> for the cyls/heads/sectors parameters.
2538 See also: C<guestfs_part_add>");
2540 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2542 "display the partition table",
2544 This displays the partition table on C<device>, in the
2545 human-readable output of the L<sfdisk(8)> command. It is
2546 not intended to be parsed.
2548 See also: C<guestfs_part_list>");
2550 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2552 "display the kernel geometry",
2554 This displays the kernel's idea of the geometry of C<device>.
2556 The result is in human-readable format, and not designed to
2559 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2561 "display the disk geometry from the partition table",
2563 This displays the disk geometry of C<device> read from the
2564 partition table. Especially in the case where the underlying
2565 block device has been resized, this can be different from the
2566 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2568 The result is in human-readable format, and not designed to
2571 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2573 "activate or deactivate all volume groups",
2575 This command activates or (if C<activate> is false) deactivates
2576 all logical volumes in all volume groups.
2577 If activated, then they are made known to the
2578 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2579 then those devices disappear.
2581 This command is the same as running C<vgchange -a y|n>");
2583 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2585 "activate or deactivate some volume groups",
2587 This command activates or (if C<activate> is false) deactivates
2588 all logical volumes in the listed volume groups C<volgroups>.
2589 If activated, then they are made known to the
2590 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2591 then those devices disappear.
2593 This command is the same as running C<vgchange -a y|n volgroups...>
2595 Note that if C<volgroups> is an empty list then B<all> volume groups
2596 are activated or deactivated.");
2598 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2599 [InitNone, Always, TestOutput (
2600 [["part_disk"; "/dev/sda"; "mbr"];
2601 ["pvcreate"; "/dev/sda1"];
2602 ["vgcreate"; "VG"; "/dev/sda1"];
2603 ["lvcreate"; "LV"; "VG"; "10"];
2604 ["mkfs"; "ext2"; "/dev/VG/LV"];
2605 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2606 ["write_file"; "/new"; "test content"; "0"];
2608 ["lvresize"; "/dev/VG/LV"; "20"];
2609 ["e2fsck_f"; "/dev/VG/LV"];
2610 ["resize2fs"; "/dev/VG/LV"];
2611 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2612 ["cat"; "/new"]], "test content");
2613 InitNone, Always, TestRun (
2614 (* Make an LV smaller to test RHBZ#587484. *)
2615 [["part_disk"; "/dev/sda"; "mbr"];
2616 ["pvcreate"; "/dev/sda1"];
2617 ["vgcreate"; "VG"; "/dev/sda1"];
2618 ["lvcreate"; "LV"; "VG"; "20"];
2619 ["lvresize"; "/dev/VG/LV"; "10"]])],
2620 "resize an LVM logical volume",
2622 This resizes (expands or shrinks) an existing LVM logical
2623 volume to C<mbytes>. When reducing, data in the reduced part
2626 ("resize2fs", (RErr, [Device "device"]), 106, [],
2627 [], (* lvresize tests this *)
2628 "resize an ext2/ext3 filesystem",
2630 This resizes an ext2 or ext3 filesystem to match the size of
2631 the underlying device.
2633 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2634 on the C<device> before calling this command. For unknown reasons
2635 C<resize2fs> sometimes gives an error about this and sometimes not.
2636 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2637 calling this function.");
2639 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2640 [InitBasicFS, Always, TestOutputList (
2641 [["find"; "/"]], ["lost+found"]);
2642 InitBasicFS, Always, TestOutputList (
2646 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2647 InitBasicFS, Always, TestOutputList (
2648 [["mkdir_p"; "/a/b/c"];
2649 ["touch"; "/a/b/c/d"];
2650 ["find"; "/a/b/"]], ["c"; "c/d"])],
2651 "find all files and directories",
2653 This command lists out all files and directories, recursively,
2654 starting at C<directory>. It is essentially equivalent to
2655 running the shell command C<find directory -print> but some
2656 post-processing happens on the output, described below.
2658 This returns a list of strings I<without any prefix>. Thus
2659 if the directory structure was:
2665 then the returned list from C<guestfs_find> C</tmp> would be
2673 If C<directory> is not a directory, then this command returns
2676 The returned list is sorted.
2678 See also C<guestfs_find0>.");
2680 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2681 [], (* lvresize tests this *)
2682 "check an ext2/ext3 filesystem",
2684 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2685 filesystem checker on C<device>, noninteractively (C<-p>),
2686 even if the filesystem appears to be clean (C<-f>).
2688 This command is only needed because of C<guestfs_resize2fs>
2689 (q.v.). Normally you should use C<guestfs_fsck>.");
2691 ("sleep", (RErr, [Int "secs"]), 109, [],
2692 [InitNone, Always, TestRun (
2694 "sleep for some seconds",
2696 Sleep for C<secs> seconds.");
2698 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2699 [InitNone, Always, TestOutputInt (
2700 [["part_disk"; "/dev/sda"; "mbr"];
2701 ["mkfs"; "ntfs"; "/dev/sda1"];
2702 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2703 InitNone, Always, TestOutputInt (
2704 [["part_disk"; "/dev/sda"; "mbr"];
2705 ["mkfs"; "ext2"; "/dev/sda1"];
2706 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2707 "probe NTFS volume",
2709 This command runs the L<ntfs-3g.probe(8)> command which probes
2710 an NTFS C<device> for mountability. (Not all NTFS volumes can
2711 be mounted read-write, and some cannot be mounted at all).
2713 C<rw> is a boolean flag. Set it to true if you want to test
2714 if the volume can be mounted read-write. Set it to false if
2715 you want to test if the volume can be mounted read-only.
2717 The return value is an integer which C<0> if the operation
2718 would succeed, or some non-zero value documented in the
2719 L<ntfs-3g.probe(8)> manual page.");
2721 ("sh", (RString "output", [String "command"]), 111, [],
2722 [], (* XXX needs tests *)
2723 "run a command via the shell",
2725 This call runs a command from the guest filesystem via the
2728 This is like C<guestfs_command>, but passes the command to:
2730 /bin/sh -c \"command\"
2732 Depending on the guest's shell, this usually results in
2733 wildcards being expanded, shell expressions being interpolated
2736 All the provisos about C<guestfs_command> apply to this call.");
2738 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2739 [], (* XXX needs tests *)
2740 "run a command via the shell returning lines",
2742 This is the same as C<guestfs_sh>, but splits the result
2743 into a list of lines.
2745 See also: C<guestfs_command_lines>");
2747 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2748 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2749 * code in stubs.c, since all valid glob patterns must start with "/".
2750 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2752 [InitBasicFS, Always, TestOutputList (
2753 [["mkdir_p"; "/a/b/c"];
2754 ["touch"; "/a/b/c/d"];
2755 ["touch"; "/a/b/c/e"];
2756 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2757 InitBasicFS, Always, TestOutputList (
2758 [["mkdir_p"; "/a/b/c"];
2759 ["touch"; "/a/b/c/d"];
2760 ["touch"; "/a/b/c/e"];
2761 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2762 InitBasicFS, Always, TestOutputList (
2763 [["mkdir_p"; "/a/b/c"];
2764 ["touch"; "/a/b/c/d"];
2765 ["touch"; "/a/b/c/e"];
2766 ["glob_expand"; "/a/*/x/*"]], [])],
2767 "expand a wildcard path",
2769 This command searches for all the pathnames matching
2770 C<pattern> according to the wildcard expansion rules
2773 If no paths match, then this returns an empty list
2774 (note: not an error).
2776 It is just a wrapper around the C L<glob(3)> function
2777 with flags C<GLOB_MARK|GLOB_BRACE>.
2778 See that manual page for more details.");
2780 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2781 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2782 [["scrub_device"; "/dev/sdc"]])],
2783 "scrub (securely wipe) a device",
2785 This command writes patterns over C<device> to make data retrieval
2788 It is an interface to the L<scrub(1)> program. See that
2789 manual page for more details.");
2791 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2792 [InitBasicFS, Always, TestRun (
2793 [["write_file"; "/file"; "content"; "0"];
2794 ["scrub_file"; "/file"]])],
2795 "scrub (securely wipe) a file",
2797 This command writes patterns over a file to make data retrieval
2800 The file is I<removed> after scrubbing.
2802 It is an interface to the L<scrub(1)> program. See that
2803 manual page for more details.");
2805 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2806 [], (* XXX needs testing *)
2807 "scrub (securely wipe) free space",
2809 This command creates the directory C<dir> and then fills it
2810 with files until the filesystem is full, and scrubs the files
2811 as for C<guestfs_scrub_file>, and deletes them.
2812 The intention is to scrub any free space on the partition
2815 It is an interface to the L<scrub(1)> program. See that
2816 manual page for more details.");
2818 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2819 [InitBasicFS, Always, TestRun (
2821 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2822 "create a temporary directory",
2824 This command creates a temporary directory. The
2825 C<template> parameter should be a full pathname for the
2826 temporary directory name with the final six characters being
2829 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2830 the second one being suitable for Windows filesystems.
2832 The name of the temporary directory that was created
2835 The temporary directory is created with mode 0700
2836 and is owned by root.
2838 The caller is responsible for deleting the temporary
2839 directory and its contents after use.
2841 See also: L<mkdtemp(3)>");
2843 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2844 [InitISOFS, Always, TestOutputInt (
2845 [["wc_l"; "/10klines"]], 10000)],
2846 "count lines in a file",
2848 This command counts the lines in a file, using the
2849 C<wc -l> external command.");
2851 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2852 [InitISOFS, Always, TestOutputInt (
2853 [["wc_w"; "/10klines"]], 10000)],
2854 "count words in a file",
2856 This command counts the words in a file, using the
2857 C<wc -w> external command.");
2859 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2860 [InitISOFS, Always, TestOutputInt (
2861 [["wc_c"; "/100kallspaces"]], 102400)],
2862 "count characters in a file",
2864 This command counts the characters in a file, using the
2865 C<wc -c> external command.");
2867 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2868 [InitISOFS, Always, TestOutputList (
2869 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2870 "return first 10 lines of a file",
2872 This command returns up to the first 10 lines of a file as
2873 a list of strings.");
2875 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2876 [InitISOFS, Always, TestOutputList (
2877 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2878 InitISOFS, Always, TestOutputList (
2879 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2880 InitISOFS, Always, TestOutputList (
2881 [["head_n"; "0"; "/10klines"]], [])],
2882 "return first N lines of a file",
2884 If the parameter C<nrlines> is a positive number, this returns the first
2885 C<nrlines> lines of the file C<path>.
2887 If the parameter C<nrlines> is a negative number, this returns lines
2888 from the file C<path>, excluding the last C<nrlines> lines.
2890 If the parameter C<nrlines> is zero, this returns an empty list.");
2892 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2893 [InitISOFS, Always, TestOutputList (
2894 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2895 "return last 10 lines of a file",
2897 This command returns up to the last 10 lines of a file as
2898 a list of strings.");
2900 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2901 [InitISOFS, Always, TestOutputList (
2902 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2903 InitISOFS, Always, TestOutputList (
2904 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2905 InitISOFS, Always, TestOutputList (
2906 [["tail_n"; "0"; "/10klines"]], [])],
2907 "return last N lines of a file",
2909 If the parameter C<nrlines> is a positive number, this returns the last
2910 C<nrlines> lines of the file C<path>.
2912 If the parameter C<nrlines> is a negative number, this returns lines
2913 from the file C<path>, starting with the C<-nrlines>th line.
2915 If the parameter C<nrlines> is zero, this returns an empty list.");
2917 ("df", (RString "output", []), 125, [],
2918 [], (* XXX Tricky to test because it depends on the exact format
2919 * of the 'df' command and other imponderables.
2921 "report file system disk space usage",
2923 This command runs the C<df> command to report disk space used.
2925 This command is mostly useful for interactive sessions. It
2926 is I<not> intended that you try to parse the output string.
2927 Use C<statvfs> from programs.");
2929 ("df_h", (RString "output", []), 126, [],
2930 [], (* XXX Tricky to test because it depends on the exact format
2931 * of the 'df' command and other imponderables.
2933 "report file system disk space usage (human readable)",
2935 This command runs the C<df -h> command to report disk space used
2936 in human-readable format.
2938 This command is mostly useful for interactive sessions. It
2939 is I<not> intended that you try to parse the output string.
2940 Use C<statvfs> from programs.");
2942 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2943 [InitISOFS, Always, TestOutputInt (
2944 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2945 "estimate file space usage",
2947 This command runs the C<du -s> command to estimate file space
2950 C<path> can be a file or a directory. If C<path> is a directory
2951 then the estimate includes the contents of the directory and all
2952 subdirectories (recursively).
2954 The result is the estimated size in I<kilobytes>
2955 (ie. units of 1024 bytes).");
2957 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2958 [InitISOFS, Always, TestOutputList (
2959 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2960 "list files in an initrd",
2962 This command lists out files contained in an initrd.
2964 The files are listed without any initial C</> character. The
2965 files are listed in the order they appear (not necessarily
2966 alphabetical). Directory names are listed as separate items.
2968 Old Linux kernels (2.4 and earlier) used a compressed ext2
2969 filesystem as initrd. We I<only> support the newer initramfs
2970 format (compressed cpio files).");
2972 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2974 "mount a file using the loop device",
2976 This command lets you mount C<file> (a filesystem image
2977 in a file) on a mount point. It is entirely equivalent to
2978 the command C<mount -o loop file mountpoint>.");
2980 ("mkswap", (RErr, [Device "device"]), 130, [],
2981 [InitEmpty, Always, TestRun (
2982 [["part_disk"; "/dev/sda"; "mbr"];
2983 ["mkswap"; "/dev/sda1"]])],
2984 "create a swap partition",
2986 Create a swap partition on C<device>.");
2988 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2989 [InitEmpty, Always, TestRun (
2990 [["part_disk"; "/dev/sda"; "mbr"];
2991 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2992 "create a swap partition with a label",
2994 Create a swap partition on C<device> with label C<label>.
2996 Note that you cannot attach a swap label to a block device
2997 (eg. C</dev/sda>), just to a partition. This appears to be
2998 a limitation of the kernel or swap tools.");
3000 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3001 (let uuid = uuidgen () in
3002 [InitEmpty, Always, TestRun (
3003 [["part_disk"; "/dev/sda"; "mbr"];
3004 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3005 "create a swap partition with an explicit UUID",
3007 Create a swap partition on C<device> with UUID C<uuid>.");
3009 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3010 [InitBasicFS, Always, TestOutputStruct (
3011 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3012 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3013 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3014 InitBasicFS, Always, TestOutputStruct (
3015 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3016 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3017 "make block, character or FIFO devices",
3019 This call creates block or character special devices, or
3020 named pipes (FIFOs).
3022 The C<mode> parameter should be the mode, using the standard
3023 constants. C<devmajor> and C<devminor> are the
3024 device major and minor numbers, only used when creating block
3025 and character special devices.
3027 Note that, just like L<mknod(2)>, the mode must be bitwise
3028 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3029 just creates a regular file). These constants are
3030 available in the standard Linux header files, or you can use
3031 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3032 which are wrappers around this command which bitwise OR
3033 in the appropriate constant for you.
3035 The mode actually set is affected by the umask.");
3037 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3038 [InitBasicFS, Always, TestOutputStruct (
3039 [["mkfifo"; "0o777"; "/node"];
3040 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3041 "make FIFO (named pipe)",
3043 This call creates a FIFO (named pipe) called C<path> with
3044 mode C<mode>. It is just a convenient wrapper around
3047 The mode actually set is affected by the umask.");
3049 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3050 [InitBasicFS, Always, TestOutputStruct (
3051 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3052 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3053 "make block device node",
3055 This call creates a block device node called C<path> with
3056 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3057 It is just a convenient wrapper around C<guestfs_mknod>.
3059 The mode actually set is affected by the umask.");
3061 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3062 [InitBasicFS, Always, TestOutputStruct (
3063 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3064 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3065 "make char device node",
3067 This call creates a char device node called C<path> with
3068 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3069 It is just a convenient wrapper around C<guestfs_mknod>.
3071 The mode actually set is affected by the umask.");
3073 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
3074 [InitEmpty, Always, TestOutputInt (
3075 [["umask"; "0o22"]], 0o22)],
3076 "set file mode creation mask (umask)",
3078 This function sets the mask used for creating new files and
3079 device nodes to C<mask & 0777>.
3081 Typical umask values would be C<022> which creates new files
3082 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3083 C<002> which creates new files with permissions like
3084 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3086 The default umask is C<022>. This is important because it
3087 means that directories and device nodes will be created with
3088 C<0644> or C<0755> mode even if you specify C<0777>.
3090 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3092 This call returns the previous umask.");
3094 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3096 "read directories entries",
3098 This returns the list of directory entries in directory C<dir>.
3100 All entries in the directory are returned, including C<.> and
3101 C<..>. The entries are I<not> sorted, but returned in the same
3102 order as the underlying filesystem.
3104 Also this call returns basic file type information about each
3105 file. The C<ftyp> field will contain one of the following characters:
3143 The L<readdir(3)> returned a C<d_type> field with an
3148 This function is primarily intended for use by programs. To
3149 get a simple list of names, use C<guestfs_ls>. To get a printable
3150 directory for human consumption, use C<guestfs_ll>.");
3152 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3154 "create partitions on a block device",
3156 This is a simplified interface to the C<guestfs_sfdisk>
3157 command, where partition sizes are specified in megabytes
3158 only (rounded to the nearest cylinder) and you don't need
3159 to specify the cyls, heads and sectors parameters which
3160 were rarely if ever used anyway.
3162 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3163 and C<guestfs_part_disk>");
3165 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3167 "determine file type inside a compressed file",
3169 This command runs C<file> after first decompressing C<path>
3172 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3174 Since 1.0.63, use C<guestfs_file> instead which can now
3175 process compressed files.");
3177 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3179 "list extended attributes of a file or directory",
3181 This call lists the extended attributes of the file or directory
3184 At the system call level, this is a combination of the
3185 L<listxattr(2)> and L<getxattr(2)> calls.
3187 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3189 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3191 "list extended attributes of a file or directory",
3193 This is the same as C<guestfs_getxattrs>, but if C<path>
3194 is a symbolic link, then it returns the extended attributes
3195 of the link itself.");
3197 ("setxattr", (RErr, [String "xattr";
3198 String "val"; Int "vallen"; (* will be BufferIn *)
3199 Pathname "path"]), 143, [Optional "linuxxattrs"],
3201 "set extended attribute of a file or directory",
3203 This call sets the extended attribute named C<xattr>
3204 of the file C<path> to the value C<val> (of length C<vallen>).
3205 The value is arbitrary 8 bit data.
3207 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3209 ("lsetxattr", (RErr, [String "xattr";
3210 String "val"; Int "vallen"; (* will be BufferIn *)
3211 Pathname "path"]), 144, [Optional "linuxxattrs"],
3213 "set extended attribute of a file or directory",
3215 This is the same as C<guestfs_setxattr>, but if C<path>
3216 is a symbolic link, then it sets an extended attribute
3217 of the link itself.");
3219 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3221 "remove extended attribute of a file or directory",
3223 This call removes the extended attribute named C<xattr>
3224 of the file C<path>.
3226 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3228 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3230 "remove extended attribute of a file or directory",
3232 This is the same as C<guestfs_removexattr>, but if C<path>
3233 is a symbolic link, then it removes an extended attribute
3234 of the link itself.");
3236 ("mountpoints", (RHashtable "mps", []), 147, [],
3240 This call is similar to C<guestfs_mounts>. That call returns
3241 a list of devices. This one returns a hash table (map) of
3242 device name to directory where the device is mounted.");
3244 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3245 (* This is a special case: while you would expect a parameter
3246 * of type "Pathname", that doesn't work, because it implies
3247 * NEED_ROOT in the generated calling code in stubs.c, and
3248 * this function cannot use NEED_ROOT.
3251 "create a mountpoint",
3253 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3254 specialized calls that can be used to create extra mountpoints
3255 before mounting the first filesystem.
3257 These calls are I<only> necessary in some very limited circumstances,
3258 mainly the case where you want to mount a mix of unrelated and/or
3259 read-only filesystems together.
3261 For example, live CDs often contain a \"Russian doll\" nest of
3262 filesystems, an ISO outer layer, with a squashfs image inside, with
3263 an ext2/3 image inside that. You can unpack this as follows
3266 add-ro Fedora-11-i686-Live.iso
3269 mkmountpoint /squash
3272 mount-loop /cd/LiveOS/squashfs.img /squash
3273 mount-loop /squash/LiveOS/ext3fs.img /ext3
3275 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3277 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3279 "remove a mountpoint",
3281 This calls removes a mountpoint that was previously created
3282 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3283 for full details.");
3285 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3286 [InitISOFS, Always, TestOutputBuffer (
3287 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3288 (* Test various near large, large and too large files (RHBZ#589039). *)
3289 InitBasicFS, Always, TestLastFail (
3291 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3292 ["read_file"; "/a"]]);
3293 InitBasicFS, Always, TestLastFail (
3295 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3296 ["read_file"; "/a"]]);
3297 InitBasicFS, Always, TestLastFail (
3299 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3300 ["read_file"; "/a"]])],
3303 This calls returns the contents of the file C<path> as a
3306 Unlike C<guestfs_cat>, this function can correctly
3307 handle files that contain embedded ASCII NUL characters.
3308 However unlike C<guestfs_download>, this function is limited
3309 in the total size of file that can be handled.");
3311 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3312 [InitISOFS, Always, TestOutputList (
3313 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3314 InitISOFS, Always, TestOutputList (
3315 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3316 "return lines matching a pattern",
3318 This calls the external C<grep> program and returns the
3321 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3322 [InitISOFS, Always, TestOutputList (
3323 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3324 "return lines matching a pattern",
3326 This calls the external C<egrep> program and returns the
3329 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3330 [InitISOFS, Always, TestOutputList (
3331 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3332 "return lines matching a pattern",
3334 This calls the external C<fgrep> program and returns the
3337 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3338 [InitISOFS, Always, TestOutputList (
3339 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3340 "return lines matching a pattern",
3342 This calls the external C<grep -i> program and returns the
3345 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3346 [InitISOFS, Always, TestOutputList (
3347 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3348 "return lines matching a pattern",
3350 This calls the external C<egrep -i> program and returns the
3353 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3354 [InitISOFS, Always, TestOutputList (
3355 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3356 "return lines matching a pattern",
3358 This calls the external C<fgrep -i> program and returns the
3361 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3362 [InitISOFS, Always, TestOutputList (
3363 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3364 "return lines matching a pattern",
3366 This calls the external C<zgrep> program and returns the
3369 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3370 [InitISOFS, Always, TestOutputList (
3371 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3372 "return lines matching a pattern",
3374 This calls the external C<zegrep> program and returns the
3377 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3378 [InitISOFS, Always, TestOutputList (
3379 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3380 "return lines matching a pattern",
3382 This calls the external C<zfgrep> program and returns the
3385 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3386 [InitISOFS, Always, TestOutputList (
3387 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3388 "return lines matching a pattern",
3390 This calls the external C<zgrep -i> program and returns the
3393 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3394 [InitISOFS, Always, TestOutputList (
3395 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3396 "return lines matching a pattern",
3398 This calls the external C<zegrep -i> program and returns the
3401 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3402 [InitISOFS, Always, TestOutputList (
3403 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3404 "return lines matching a pattern",
3406 This calls the external C<zfgrep -i> program and returns the
3409 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3410 [InitISOFS, Always, TestOutput (
3411 [["realpath"; "/../directory"]], "/directory")],
3412 "canonicalized absolute pathname",
3414 Return the canonicalized absolute pathname of C<path>. The
3415 returned path has no C<.>, C<..> or symbolic link path elements.");
3417 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3418 [InitBasicFS, Always, TestOutputStruct (
3421 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3422 "create a hard link",
3424 This command creates a hard link using the C<ln> command.");
3426 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3427 [InitBasicFS, Always, TestOutputStruct (
3430 ["ln_f"; "/a"; "/b"];
3431 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3432 "create a hard link",
3434 This command creates a hard link using the C<ln -f> command.
3435 The C<-f> option removes the link (C<linkname>) if it exists already.");
3437 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3438 [InitBasicFS, Always, TestOutputStruct (
3440 ["ln_s"; "a"; "/b"];
3441 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3442 "create a symbolic link",
3444 This command creates a symbolic link using the C<ln -s> command.");
3446 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3447 [InitBasicFS, Always, TestOutput (
3448 [["mkdir_p"; "/a/b"];
3449 ["touch"; "/a/b/c"];
3450 ["ln_sf"; "../d"; "/a/b/c"];
3451 ["readlink"; "/a/b/c"]], "../d")],
3452 "create a symbolic link",
3454 This command creates a symbolic link using the C<ln -sf> command,
3455 The C<-f> option removes the link (C<linkname>) if it exists already.");
3457 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3458 [] (* XXX tested above *),
3459 "read the target of a symbolic link",
3461 This command reads the target of a symbolic link.");
3463 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3464 [InitBasicFS, Always, TestOutputStruct (
3465 [["fallocate"; "/a"; "1000000"];
3466 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3467 "preallocate a file in the guest filesystem",
3469 This command preallocates a file (containing zero bytes) named
3470 C<path> of size C<len> bytes. If the file exists already, it
3473 Do not confuse this with the guestfish-specific
3474 C<alloc> command which allocates a file in the host and
3475 attaches it as a device.");
3477 ("swapon_device", (RErr, [Device "device"]), 170, [],
3478 [InitPartition, Always, TestRun (
3479 [["mkswap"; "/dev/sda1"];
3480 ["swapon_device"; "/dev/sda1"];
3481 ["swapoff_device"; "/dev/sda1"]])],
3482 "enable swap on device",
3484 This command enables the libguestfs appliance to use the
3485 swap device or partition named C<device>. The increased
3486 memory is made available for all commands, for example
3487 those run using C<guestfs_command> or C<guestfs_sh>.
3489 Note that you should not swap to existing guest swap
3490 partitions unless you know what you are doing. They may
3491 contain hibernation information, or other information that
3492 the guest doesn't want you to trash. You also risk leaking
3493 information about the host to the guest this way. Instead,
3494 attach a new host device to the guest and swap on that.");
3496 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3497 [], (* XXX tested by swapon_device *)
3498 "disable swap on device",
3500 This command disables the libguestfs appliance swap
3501 device or partition named C<device>.
3502 See C<guestfs_swapon_device>.");
3504 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3505 [InitBasicFS, Always, TestRun (
3506 [["fallocate"; "/swap"; "8388608"];
3507 ["mkswap_file"; "/swap"];
3508 ["swapon_file"; "/swap"];
3509 ["swapoff_file"; "/swap"]])],
3510 "enable swap on file",
3512 This command enables swap to a file.
3513 See C<guestfs_swapon_device> for other notes.");
3515 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3516 [], (* XXX tested by swapon_file *)
3517 "disable swap on file",
3519 This command disables the libguestfs appliance swap on file.");
3521 ("swapon_label", (RErr, [String "label"]), 174, [],
3522 [InitEmpty, Always, TestRun (
3523 [["part_disk"; "/dev/sdb"; "mbr"];
3524 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3525 ["swapon_label"; "swapit"];
3526 ["swapoff_label"; "swapit"];
3527 ["zero"; "/dev/sdb"];
3528 ["blockdev_rereadpt"; "/dev/sdb"]])],
3529 "enable swap on labeled swap partition",
3531 This command enables swap to a labeled swap partition.
3532 See C<guestfs_swapon_device> for other notes.");
3534 ("swapoff_label", (RErr, [String "label"]), 175, [],
3535 [], (* XXX tested by swapon_label *)
3536 "disable swap on labeled swap partition",
3538 This command disables the libguestfs appliance swap on
3539 labeled swap partition.");
3541 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3542 (let uuid = uuidgen () in
3543 [InitEmpty, Always, TestRun (
3544 [["mkswap_U"; uuid; "/dev/sdb"];
3545 ["swapon_uuid"; uuid];
3546 ["swapoff_uuid"; uuid]])]),
3547 "enable swap on swap partition by UUID",
3549 This command enables swap to a swap partition with the given UUID.
3550 See C<guestfs_swapon_device> for other notes.");
3552 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3553 [], (* XXX tested by swapon_uuid *)
3554 "disable swap on swap partition by UUID",
3556 This command disables the libguestfs appliance swap partition
3557 with the given UUID.");
3559 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3560 [InitBasicFS, Always, TestRun (
3561 [["fallocate"; "/swap"; "8388608"];
3562 ["mkswap_file"; "/swap"]])],
3563 "create a swap file",
3567 This command just writes a swap file signature to an existing
3568 file. To create the file itself, use something like C<guestfs_fallocate>.");
3570 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3571 [InitISOFS, Always, TestRun (
3572 [["inotify_init"; "0"]])],
3573 "create an inotify handle",
3575 This command creates a new inotify handle.
3576 The inotify subsystem can be used to notify events which happen to
3577 objects in the guest filesystem.
3579 C<maxevents> is the maximum number of events which will be
3580 queued up between calls to C<guestfs_inotify_read> or
3581 C<guestfs_inotify_files>.
3582 If this is passed as C<0>, then the kernel (or previously set)
3583 default is used. For Linux 2.6.29 the default was 16384 events.
3584 Beyond this limit, the kernel throws away events, but records
3585 the fact that it threw them away by setting a flag
3586 C<IN_Q_OVERFLOW> in the returned structure list (see
3587 C<guestfs_inotify_read>).
3589 Before any events are generated, you have to add some
3590 watches to the internal watch list. See:
3591 C<guestfs_inotify_add_watch>,
3592 C<guestfs_inotify_rm_watch> and
3593 C<guestfs_inotify_watch_all>.
3595 Queued up events should be read periodically by calling
3596 C<guestfs_inotify_read>
3597 (or C<guestfs_inotify_files> which is just a helpful
3598 wrapper around C<guestfs_inotify_read>). If you don't
3599 read the events out often enough then you risk the internal
3602 The handle should be closed after use by calling
3603 C<guestfs_inotify_close>. This also removes any
3604 watches automatically.
3606 See also L<inotify(7)> for an overview of the inotify interface
3607 as exposed by the Linux kernel, which is roughly what we expose
3608 via libguestfs. Note that there is one global inotify handle
3609 per libguestfs instance.");
3611 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3612 [InitBasicFS, Always, TestOutputList (
3613 [["inotify_init"; "0"];
3614 ["inotify_add_watch"; "/"; "1073741823"];
3617 ["inotify_files"]], ["a"; "b"])],
3618 "add an inotify watch",
3620 Watch C<path> for the events listed in C<mask>.
3622 Note that if C<path> is a directory then events within that
3623 directory are watched, but this does I<not> happen recursively
3624 (in subdirectories).
3626 Note for non-C or non-Linux callers: the inotify events are
3627 defined by the Linux kernel ABI and are listed in
3628 C</usr/include/sys/inotify.h>.");
3630 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3632 "remove an inotify watch",
3634 Remove a previously defined inotify watch.
3635 See C<guestfs_inotify_add_watch>.");
3637 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3639 "return list of inotify events",
3641 Return the complete queue of events that have happened
3642 since the previous read call.
3644 If no events have happened, this returns an empty list.
3646 I<Note>: In order to make sure that all events have been
3647 read, you must call this function repeatedly until it
3648 returns an empty list. The reason is that the call will
3649 read events up to the maximum appliance-to-host message
3650 size and leave remaining events in the queue.");
3652 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3654 "return list of watched files that had events",
3656 This function is a helpful wrapper around C<guestfs_inotify_read>
3657 which just returns a list of pathnames of objects that were
3658 touched. The returned pathnames are sorted and deduplicated.");
3660 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3662 "close the inotify handle",
3664 This closes the inotify handle which was previously
3665 opened by inotify_init. It removes all watches, throws
3666 away any pending events, and deallocates all resources.");
3668 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3670 "set SELinux security context",
3672 This sets the SELinux security context of the daemon
3673 to the string C<context>.
3675 See the documentation about SELINUX in L<guestfs(3)>.");
3677 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3679 "get SELinux security context",
3681 This gets the SELinux security context of the daemon.
3683 See the documentation about SELINUX in L<guestfs(3)>,
3684 and C<guestfs_setcon>");
3686 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3687 [InitEmpty, Always, TestOutput (
3688 [["part_disk"; "/dev/sda"; "mbr"];
3689 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3690 ["mount_options"; ""; "/dev/sda1"; "/"];
3691 ["write_file"; "/new"; "new file contents"; "0"];
3692 ["cat"; "/new"]], "new file contents")],
3693 "make a filesystem with block size",
3695 This call is similar to C<guestfs_mkfs>, but it allows you to
3696 control the block size of the resulting filesystem. Supported
3697 block sizes depend on the filesystem type, but typically they
3698 are C<1024>, C<2048> or C<4096> only.");
3700 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3701 [InitEmpty, Always, TestOutput (
3702 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3703 ["mke2journal"; "4096"; "/dev/sda1"];
3704 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3705 ["mount_options"; ""; "/dev/sda2"; "/"];
3706 ["write_file"; "/new"; "new file contents"; "0"];
3707 ["cat"; "/new"]], "new file contents")],
3708 "make ext2/3/4 external journal",
3710 This creates an ext2 external journal on C<device>. It is equivalent
3713 mke2fs -O journal_dev -b blocksize device");
3715 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3716 [InitEmpty, Always, TestOutput (
3717 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3718 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3719 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3720 ["mount_options"; ""; "/dev/sda2"; "/"];
3721 ["write_file"; "/new"; "new file contents"; "0"];
3722 ["cat"; "/new"]], "new file contents")],
3723 "make ext2/3/4 external journal with label",
3725 This creates an ext2 external journal on C<device> with label C<label>.");
3727 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3728 (let uuid = uuidgen () in
3729 [InitEmpty, Always, TestOutput (
3730 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3731 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3732 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3733 ["mount_options"; ""; "/dev/sda2"; "/"];
3734 ["write_file"; "/new"; "new file contents"; "0"];
3735 ["cat"; "/new"]], "new file contents")]),
3736 "make ext2/3/4 external journal with UUID",
3738 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3740 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3742 "make ext2/3/4 filesystem with external journal",
3744 This creates an ext2/3/4 filesystem on C<device> with
3745 an external journal on C<journal>. It is equivalent
3748 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3750 See also C<guestfs_mke2journal>.");
3752 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3754 "make ext2/3/4 filesystem with external journal",
3756 This creates an ext2/3/4 filesystem on C<device> with
3757 an external journal on the journal labeled C<label>.
3759 See also C<guestfs_mke2journal_L>.");
3761 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3763 "make ext2/3/4 filesystem with external journal",
3765 This creates an ext2/3/4 filesystem on C<device> with
3766 an external journal on the journal with UUID C<uuid>.
3768 See also C<guestfs_mke2journal_U>.");
3770 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3771 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3772 "load a kernel module",
3774 This loads a kernel module in the appliance.
3776 The kernel module must have been whitelisted when libguestfs
3777 was built (see C<appliance/kmod.whitelist.in> in the source).");
3779 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3780 [InitNone, Always, TestOutput (
3781 [["echo_daemon"; "This is a test"]], "This is a test"
3783 "echo arguments back to the client",
3785 This command concatenate the list of C<words> passed with single spaces between
3786 them and returns the resulting string.
3788 You can use this command to test the connection through to the daemon.
3790 See also C<guestfs_ping_daemon>.");
3792 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3793 [], (* There is a regression test for this. *)
3794 "find all files and directories, returning NUL-separated list",
3796 This command lists out all files and directories, recursively,
3797 starting at C<directory>, placing the resulting list in the
3798 external file called C<files>.
3800 This command works the same way as C<guestfs_find> with the
3801 following exceptions:
3807 The resulting list is written to an external file.
3811 Items (filenames) in the result are separated
3812 by C<\\0> characters. See L<find(1)> option I<-print0>.
3816 This command is not limited in the number of names that it
3821 The result list is not sorted.
3825 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3826 [InitISOFS, Always, TestOutput (
3827 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3828 InitISOFS, Always, TestOutput (
3829 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3830 InitISOFS, Always, TestOutput (
3831 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3832 InitISOFS, Always, TestLastFail (
3833 [["case_sensitive_path"; "/Known-1/"]]);
3834 InitBasicFS, Always, TestOutput (
3836 ["mkdir"; "/a/bbb"];
3837 ["touch"; "/a/bbb/c"];
3838 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3839 InitBasicFS, Always, TestOutput (
3841 ["mkdir"; "/a/bbb"];
3842 ["touch"; "/a/bbb/c"];
3843 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3844 InitBasicFS, Always, TestLastFail (
3846 ["mkdir"; "/a/bbb"];
3847 ["touch"; "/a/bbb/c"];
3848 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3849 "return true path on case-insensitive filesystem",
3851 This can be used to resolve case insensitive paths on
3852 a filesystem which is case sensitive. The use case is
3853 to resolve paths which you have read from Windows configuration
3854 files or the Windows Registry, to the true path.
3856 The command handles a peculiarity of the Linux ntfs-3g
3857 filesystem driver (and probably others), which is that although
3858 the underlying filesystem is case-insensitive, the driver
3859 exports the filesystem to Linux as case-sensitive.
3861 One consequence of this is that special directories such
3862 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3863 (or other things) depending on the precise details of how
3864 they were created. In Windows itself this would not be
3867 Bug or feature? You decide:
3868 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3870 This function resolves the true case of each element in the
3871 path and returns the case-sensitive path.
3873 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3874 might return C<\"/WINDOWS/system32\"> (the exact return value
3875 would depend on details of how the directories were originally
3876 created under Windows).
3879 This function does not handle drive names, backslashes etc.
3881 See also C<guestfs_realpath>.");
3883 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3884 [InitBasicFS, Always, TestOutput (
3885 [["vfs_type"; "/dev/sda1"]], "ext2")],
3886 "get the Linux VFS type corresponding to a mounted device",
3888 This command gets the block device type corresponding to
3889 a mounted device called C<device>.
3891 Usually the result is the name of the Linux VFS module that
3892 is used to mount this device (probably determined automatically
3893 if you used the C<guestfs_mount> call).");
3895 ("truncate", (RErr, [Pathname "path"]), 199, [],
3896 [InitBasicFS, Always, TestOutputStruct (
3897 [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3898 ["truncate"; "/test"];
3899 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3900 "truncate a file to zero size",
3902 This command truncates C<path> to a zero-length file. The
3903 file must exist already.");
3905 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3906 [InitBasicFS, Always, TestOutputStruct (
3907 [["touch"; "/test"];
3908 ["truncate_size"; "/test"; "1000"];
3909 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3910 "truncate a file to a particular size",
3912 This command truncates C<path> to size C<size> bytes. The file
3913 must exist already. If the file is smaller than C<size> then
3914 the file is extended to the required size with null bytes.");
3916 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3917 [InitBasicFS, Always, TestOutputStruct (
3918 [["touch"; "/test"];
3919 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3920 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3921 "set timestamp of a file with nanosecond precision",
3923 This command sets the timestamps of a file with nanosecond
3926 C<atsecs, atnsecs> are the last access time (atime) in secs and
3927 nanoseconds from the epoch.
3929 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3930 secs and nanoseconds from the epoch.
3932 If the C<*nsecs> field contains the special value C<-1> then
3933 the corresponding timestamp is set to the current time. (The
3934 C<*secs> field is ignored in this case).
3936 If the C<*nsecs> field contains the special value C<-2> then
3937 the corresponding timestamp is left unchanged. (The
3938 C<*secs> field is ignored in this case).");
3940 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3941 [InitBasicFS, Always, TestOutputStruct (
3942 [["mkdir_mode"; "/test"; "0o111"];
3943 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3944 "create a directory with a particular mode",
3946 This command creates a directory, setting the initial permissions
3947 of the directory to C<mode>.
3949 For common Linux filesystems, the actual mode which is set will
3950 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
3951 interpret the mode in other ways.
3953 See also C<guestfs_mkdir>, C<guestfs_umask>");
3955 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3957 "change file owner and group",
3959 Change the file owner to C<owner> and group to C<group>.
3960 This is like C<guestfs_chown> but if C<path> is a symlink then
3961 the link itself is changed, not the target.
3963 Only numeric uid and gid are supported. If you want to use
3964 names, you will need to locate and parse the password file
3965 yourself (Augeas support makes this relatively easy).");
3967 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3969 "lstat on multiple files",
3971 This call allows you to perform the C<guestfs_lstat> operation
3972 on multiple files, where all files are in the directory C<path>.
3973 C<names> is the list of files from this directory.
3975 On return you get a list of stat structs, with a one-to-one
3976 correspondence to the C<names> list. If any name did not exist
3977 or could not be lstat'd, then the C<ino> field of that structure
3980 This call is intended for programs that want to efficiently
3981 list a directory contents without making many round-trips.
3982 See also C<guestfs_lxattrlist> for a similarly efficient call
3983 for getting extended attributes. Very long directory listings
3984 might cause the protocol message size to be exceeded, causing
3985 this call to fail. The caller must split up such requests
3986 into smaller groups of names.");
3988 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3990 "lgetxattr on multiple files",
3992 This call allows you to get the extended attributes
3993 of multiple files, where all files are in the directory C<path>.
3994 C<names> is the list of files from this directory.
3996 On return you get a flat list of xattr structs which must be
3997 interpreted sequentially. The first xattr struct always has a zero-length
3998 C<attrname>. C<attrval> in this struct is zero-length
3999 to indicate there was an error doing C<lgetxattr> for this
4000 file, I<or> is a C string which is a decimal number
4001 (the number of following attributes for this file, which could
4002 be C<\"0\">). Then after the first xattr struct are the
4003 zero or more attributes for the first named file.
4004 This repeats for the second and subsequent files.
4006 This call is intended for programs that want to efficiently
4007 list a directory contents without making many round-trips.
4008 See also C<guestfs_lstatlist> for a similarly efficient call
4009 for getting standard stats. Very long directory listings
4010 might cause the protocol message size to be exceeded, causing
4011 this call to fail. The caller must split up such requests
4012 into smaller groups of names.");
4014 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4016 "readlink on multiple files",
4018 This call allows you to do a C<readlink> operation
4019 on multiple files, where all files are in the directory C<path>.
4020 C<names> is the list of files from this directory.
4022 On return you get a list of strings, with a one-to-one
4023 correspondence to the C<names> list. Each string is the
4024 value of the symbol link.
4026 If the C<readlink(2)> operation fails on any name, then
4027 the corresponding result string is the empty string C<\"\">.
4028 However the whole operation is completed even if there
4029 were C<readlink(2)> errors, and so you can call this
4030 function with names where you don't know if they are
4031 symbolic links already (albeit slightly less efficient).
4033 This call is intended for programs that want to efficiently
4034 list a directory contents without making many round-trips.
4035 Very long directory listings might cause the protocol
4036 message size to be exceeded, causing
4037 this call to fail. The caller must split up such requests
4038 into smaller groups of names.");
4040 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4041 [InitISOFS, Always, TestOutputBuffer (
4042 [["pread"; "/known-4"; "1"; "3"]], "\n");
4043 InitISOFS, Always, TestOutputBuffer (
4044 [["pread"; "/empty"; "0"; "100"]], "")],
4045 "read part of a file",
4047 This command lets you read part of a file. It reads C<count>
4048 bytes of the file, starting at C<offset>, from file C<path>.
4050 This may read fewer bytes than requested. For further details
4051 see the L<pread(2)> system call.");
4053 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4054 [InitEmpty, Always, TestRun (
4055 [["part_init"; "/dev/sda"; "gpt"]])],
4056 "create an empty partition table",
4058 This creates an empty partition table on C<device> of one of the
4059 partition types listed below. Usually C<parttype> should be
4060 either C<msdos> or C<gpt> (for large disks).
4062 Initially there are no partitions. Following this, you should
4063 call C<guestfs_part_add> for each partition required.
4065 Possible values for C<parttype> are:
4069 =item B<efi> | B<gpt>
4071 Intel EFI / GPT partition table.
4073 This is recommended for >= 2 TB partitions that will be accessed
4074 from Linux and Intel-based Mac OS X. It also has limited backwards
4075 compatibility with the C<mbr> format.
4077 =item B<mbr> | B<msdos>
4079 The standard PC \"Master Boot Record\" (MBR) format used
4080 by MS-DOS and Windows. This partition type will B<only> work
4081 for device sizes up to 2 TB. For large disks we recommend
4086 Other partition table types that may work but are not
4095 =item B<amiga> | B<rdb>
4097 Amiga \"Rigid Disk Block\" format.
4105 DASD, used on IBM mainframes.
4113 Old Mac partition format. Modern Macs use C<gpt>.
4117 NEC PC-98 format, common in Japan apparently.
4125 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4126 [InitEmpty, Always, TestRun (
4127 [["part_init"; "/dev/sda"; "mbr"];
4128 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4129 InitEmpty, Always, TestRun (
4130 [["part_init"; "/dev/sda"; "gpt"];
4131 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4132 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4133 InitEmpty, Always, TestRun (
4134 [["part_init"; "/dev/sda"; "mbr"];
4135 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4136 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4137 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4138 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4139 "add a partition to the device",
4141 This command adds a partition to C<device>. If there is no partition
4142 table on the device, call C<guestfs_part_init> first.
4144 The C<prlogex> parameter is the type of partition. Normally you
4145 should pass C<p> or C<primary> here, but MBR partition tables also
4146 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4149 C<startsect> and C<endsect> are the start and end of the partition
4150 in I<sectors>. C<endsect> may be negative, which means it counts
4151 backwards from the end of the disk (C<-1> is the last sector).
4153 Creating a partition which covers the whole disk is not so easy.
4154 Use C<guestfs_part_disk> to do that.");
4156 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4157 [InitEmpty, Always, TestRun (
4158 [["part_disk"; "/dev/sda"; "mbr"]]);
4159 InitEmpty, Always, TestRun (
4160 [["part_disk"; "/dev/sda"; "gpt"]])],
4161 "partition whole disk with a single primary partition",
4163 This command is simply a combination of C<guestfs_part_init>
4164 followed by C<guestfs_part_add> to create a single primary partition
4165 covering the whole disk.
4167 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4168 but other possible values are described in C<guestfs_part_init>.");
4170 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4171 [InitEmpty, Always, TestRun (
4172 [["part_disk"; "/dev/sda"; "mbr"];
4173 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4174 "make a partition bootable",
4176 This sets the bootable flag on partition numbered C<partnum> on
4177 device C<device>. Note that partitions are numbered from 1.
4179 The bootable flag is used by some operating systems (notably
4180 Windows) to determine which partition to boot from. It is by
4181 no means universally recognized.");
4183 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4184 [InitEmpty, Always, TestRun (
4185 [["part_disk"; "/dev/sda"; "gpt"];
4186 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4187 "set partition name",
4189 This sets the partition name on partition numbered C<partnum> on
4190 device C<device>. Note that partitions are numbered from 1.
4192 The partition name can only be set on certain types of partition
4193 table. This works on C<gpt> but not on C<mbr> partitions.");
4195 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4196 [], (* XXX Add a regression test for this. *)
4197 "list partitions on a device",
4199 This command parses the partition table on C<device> and
4200 returns the list of partitions found.
4202 The fields in the returned structure are:
4208 Partition number, counting from 1.
4212 Start of the partition I<in bytes>. To get sectors you have to
4213 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4217 End of the partition in bytes.
4221 Size of the partition in bytes.
4225 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4226 [InitEmpty, Always, TestOutput (
4227 [["part_disk"; "/dev/sda"; "gpt"];
4228 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4229 "get the partition table type",
4231 This command examines the partition table on C<device> and
4232 returns the partition table type (format) being used.
4234 Common return values include: C<msdos> (a DOS/Windows style MBR
4235 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4236 values are possible, although unusual. See C<guestfs_part_init>
4239 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4240 [InitBasicFS, Always, TestOutputBuffer (
4241 [["fill"; "0x63"; "10"; "/test"];
4242 ["read_file"; "/test"]], "cccccccccc")],
4243 "fill a file with octets",
4245 This command creates a new file called C<path>. The initial
4246 content of the file is C<len> octets of C<c>, where C<c>
4247 must be a number in the range C<[0..255]>.
4249 To fill a file with zero bytes (sparsely), it is
4250 much more efficient to use C<guestfs_truncate_size>.");
4252 ("available", (RErr, [StringList "groups"]), 216, [],
4253 [InitNone, Always, TestRun [["available"; ""]]],
4254 "test availability of some parts of the API",
4256 This command is used to check the availability of some
4257 groups of functionality in the appliance, which not all builds of
4258 the libguestfs appliance will be able to provide.
4260 The libguestfs groups, and the functions that those
4261 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4263 The argument C<groups> is a list of group names, eg:
4264 C<[\"inotify\", \"augeas\"]> would check for the availability of
4265 the Linux inotify functions and Augeas (configuration file
4268 The command returns no error if I<all> requested groups are available.
4270 It fails with an error if one or more of the requested
4271 groups is unavailable in the appliance.
4273 If an unknown group name is included in the
4274 list of groups then an error is always returned.
4282 You must call C<guestfs_launch> before calling this function.
4284 The reason is because we don't know what groups are
4285 supported by the appliance/daemon until it is running and can
4290 If a group of functions is available, this does not necessarily
4291 mean that they will work. You still have to check for errors
4292 when calling individual API functions even if they are
4297 It is usually the job of distro packagers to build
4298 complete functionality into the libguestfs appliance.
4299 Upstream libguestfs, if built from source with all
4300 requirements satisfied, will support everything.
4304 This call was added in version C<1.0.80>. In previous
4305 versions of libguestfs all you could do would be to speculatively
4306 execute a command to find out if the daemon implemented it.
4307 See also C<guestfs_version>.
4311 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4312 [InitBasicFS, Always, TestOutputBuffer (
4313 [["write_file"; "/src"; "hello, world"; "0"];
4314 ["dd"; "/src"; "/dest"];
4315 ["read_file"; "/dest"]], "hello, world")],
4316 "copy from source to destination using dd",
4318 This command copies from one source device or file C<src>
4319 to another destination device or file C<dest>. Normally you
4320 would use this to copy to or from a device or partition, for
4321 example to duplicate a filesystem.
4323 If the destination is a device, it must be as large or larger
4324 than the source file or device, otherwise the copy will fail.
4325 This command cannot do partial copies (see C<guestfs_copy_size>).");
4327 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4328 [InitBasicFS, Always, TestOutputInt (
4329 [["write_file"; "/file"; "hello, world"; "0"];
4330 ["filesize"; "/file"]], 12)],
4331 "return the size of the file in bytes",
4333 This command returns the size of C<file> in bytes.
4335 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4336 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4337 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4339 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4340 [InitBasicFSonLVM, Always, TestOutputList (
4341 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4342 ["lvs"]], ["/dev/VG/LV2"])],
4343 "rename an LVM logical volume",
4345 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4347 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4348 [InitBasicFSonLVM, Always, TestOutputList (
4350 ["vg_activate"; "false"; "VG"];
4351 ["vgrename"; "VG"; "VG2"];
4352 ["vg_activate"; "true"; "VG2"];
4353 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4354 ["vgs"]], ["VG2"])],
4355 "rename an LVM volume group",
4357 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4359 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4360 [InitISOFS, Always, TestOutputBuffer (
4361 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4362 "list the contents of a single file in an initrd",
4364 This command unpacks the file C<filename> from the initrd file
4365 called C<initrdpath>. The filename must be given I<without> the
4366 initial C</> character.
4368 For example, in guestfish you could use the following command
4369 to examine the boot script (usually called C</init>)
4370 contained in a Linux initrd or initramfs image:
4372 initrd-cat /boot/initrd-<version>.img init
4374 See also C<guestfs_initrd_list>.");
4376 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4378 "get the UUID of a physical volume",
4380 This command returns the UUID of the LVM PV C<device>.");
4382 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4384 "get the UUID of a volume group",
4386 This command returns the UUID of the LVM VG named C<vgname>.");
4388 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4390 "get the UUID of a logical volume",
4392 This command returns the UUID of the LVM LV C<device>.");
4394 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4396 "get the PV UUIDs containing the volume group",
4398 Given a VG called C<vgname>, this returns the UUIDs of all
4399 the physical volumes that this volume group resides on.
4401 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4402 calls to associate physical volumes and volume groups.
4404 See also C<guestfs_vglvuuids>.");
4406 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4408 "get the LV UUIDs of all LVs in the volume group",
4410 Given a VG called C<vgname>, this returns the UUIDs of all
4411 the logical volumes created in this volume group.
4413 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4414 calls to associate logical volumes and volume groups.
4416 See also C<guestfs_vgpvuuids>.");
4418 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4419 [InitBasicFS, Always, TestOutputBuffer (
4420 [["write_file"; "/src"; "hello, world"; "0"];
4421 ["copy_size"; "/src"; "/dest"; "5"];
4422 ["read_file"; "/dest"]], "hello")],
4423 "copy size bytes from source to destination using dd",
4425 This command copies exactly C<size> bytes from one source device
4426 or file C<src> to another destination device or file C<dest>.
4428 Note this will fail if the source is too short or if the destination
4429 is not large enough.");
4431 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4432 [InitEmpty, Always, TestRun (
4433 [["part_init"; "/dev/sda"; "mbr"];
4434 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4435 ["part_del"; "/dev/sda"; "1"]])],
4436 "delete a partition",
4438 This command deletes the partition numbered C<partnum> on C<device>.
4440 Note that in the case of MBR partitioning, deleting an
4441 extended partition also deletes any logical partitions
4444 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4445 [InitEmpty, Always, TestOutputTrue (
4446 [["part_init"; "/dev/sda"; "mbr"];
4447 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4448 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4449 ["part_get_bootable"; "/dev/sda"; "1"]])],
4450 "return true if a partition is bootable",
4452 This command returns true if the partition C<partnum> on
4453 C<device> has the bootable flag set.
4455 See also C<guestfs_part_set_bootable>.");
4457 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [],
4458 [InitEmpty, Always, TestOutputInt (
4459 [["part_init"; "/dev/sda"; "mbr"];
4460 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4461 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4462 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4463 "get the MBR type byte (ID byte) from a partition",
4465 Returns the MBR type byte (also known as the ID byte) from
4466 the numbered partition C<partnum>.
4468 Note that only MBR (old DOS-style) partitions have type bytes.
4469 You will get undefined results for other partition table
4470 types (see C<guestfs_part_get_parttype>).");
4472 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4473 [], (* tested by part_get_mbr_id *)
4474 "set the MBR type byte (ID byte) of a partition",
4476 Sets the MBR type byte (also known as the ID byte) of
4477 the numbered partition C<partnum> to C<idbyte>. Note
4478 that the type bytes quoted in most documentation are
4479 in fact hexadecimal numbers, but usually documented
4480 without any leading \"0x\" which might be confusing.
4482 Note that only MBR (old DOS-style) partitions have type bytes.
4483 You will get undefined results for other partition table
4484 types (see C<guestfs_part_get_parttype>).");
4488 let all_functions = non_daemon_functions @ daemon_functions
4490 (* In some places we want the functions to be displayed sorted
4491 * alphabetically, so this is useful:
4493 let all_functions_sorted =
4494 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4495 compare n1 n2) all_functions
4497 (* Field types for structures. *)
4499 | FChar (* C 'char' (really, a 7 bit byte). *)
4500 | FString (* nul-terminated ASCII string, NOT NULL. *)
4501 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4506 | FBytes (* Any int measure that counts bytes. *)
4507 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4508 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4510 (* Because we generate extra parsing code for LVM command line tools,
4511 * we have to pull out the LVM columns separately here.
4521 "pv_attr", FString (* XXX *);
4522 "pv_pe_count", FInt64;
4523 "pv_pe_alloc_count", FInt64;
4526 "pv_mda_count", FInt64;
4527 "pv_mda_free", FBytes;
4528 (* Not in Fedora 10:
4529 "pv_mda_size", FBytes;
4536 "vg_attr", FString (* XXX *);
4539 "vg_sysid", FString;
4540 "vg_extent_size", FBytes;
4541 "vg_extent_count", FInt64;
4542 "vg_free_count", FInt64;
4547 "snap_count", FInt64;
4550 "vg_mda_count", FInt64;
4551 "vg_mda_free", FBytes;
4552 (* Not in Fedora 10:
4553 "vg_mda_size", FBytes;
4559 "lv_attr", FString (* XXX *);
4562 "lv_kernel_major", FInt64;
4563 "lv_kernel_minor", FInt64;
4565 "seg_count", FInt64;
4567 "snap_percent", FOptPercent;
4568 "copy_percent", FOptPercent;
4571 "mirror_log", FString;
4575 (* Names and fields in all structures (in RStruct and RStructList)
4579 (* The old RIntBool return type, only ever used for aug_defnode. Do
4580 * not use this struct in any new code.
4583 "i", FInt32; (* for historical compatibility *)
4584 "b", FInt32; (* for historical compatibility *)
4587 (* LVM PVs, VGs, LVs. *)
4588 "lvm_pv", lvm_pv_cols;
4589 "lvm_vg", lvm_vg_cols;
4590 "lvm_lv", lvm_lv_cols;
4592 (* Column names and types from stat structures.
4593 * NB. Can't use things like 'st_atime' because glibc header files
4594 * define some of these as macros. Ugh.
4625 (* Column names in dirent structure. *)
4628 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4633 (* Version numbers. *)
4641 (* Extended attribute. *)
4643 "attrname", FString;
4647 (* Inotify events. *)
4651 "in_cookie", FUInt32;
4655 (* Partition table entry. *)
4658 "part_start", FBytes;
4660 "part_size", FBytes;
4662 ] (* end of structs *)
4664 (* Ugh, Java has to be different ..
4665 * These names are also used by the Haskell bindings.
4667 let java_structs = [
4668 "int_bool", "IntBool";
4673 "statvfs", "StatVFS";
4675 "version", "Version";
4677 "inotify_event", "INotifyEvent";
4678 "partition", "Partition";
4681 (* What structs are actually returned. *)
4682 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4684 (* Returns a list of RStruct/RStructList structs that are returned
4685 * by any function. Each element of returned list is a pair:
4687 * (structname, RStructOnly)
4688 * == there exists function which returns RStruct (_, structname)
4689 * (structname, RStructListOnly)
4690 * == there exists function which returns RStructList (_, structname)
4691 * (structname, RStructAndList)
4692 * == there are functions returning both RStruct (_, structname)
4693 * and RStructList (_, structname)
4695 let rstructs_used_by functions =
4696 (* ||| is a "logical OR" for rstructs_used_t *)
4700 | _, RStructAndList -> RStructAndList
4701 | RStructOnly, RStructListOnly
4702 | RStructListOnly, RStructOnly -> RStructAndList
4703 | RStructOnly, RStructOnly -> RStructOnly
4704 | RStructListOnly, RStructListOnly -> RStructListOnly
4707 let h = Hashtbl.create 13 in
4709 (* if elem->oldv exists, update entry using ||| operator,
4710 * else just add elem->newv to the hash
4712 let update elem newv =
4713 try let oldv = Hashtbl.find h elem in
4714 Hashtbl.replace h elem (newv ||| oldv)
4715 with Not_found -> Hashtbl.add h elem newv
4719 fun (_, style, _, _, _, _, _) ->
4720 match fst style with
4721 | RStruct (_, structname) -> update structname RStructOnly
4722 | RStructList (_, structname) -> update structname RStructListOnly
4726 (* return key->values as a list of (key,value) *)
4727 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4729 (* Used for testing language bindings. *)
4731 | CallString of string
4732 | CallOptString of string option
4733 | CallStringList of string list
4735 | CallInt64 of int64
4738 (* Used to memoize the result of pod2text. *)
4739 let pod2text_memo_filename = "src/.pod2text.data"
4740 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4742 let chan = open_in pod2text_memo_filename in
4743 let v = input_value chan in
4747 _ -> Hashtbl.create 13
4748 let pod2text_memo_updated () =
4749 let chan = open_out pod2text_memo_filename in
4750 output_value chan pod2text_memo;
4753 (* Useful functions.
4754 * Note we don't want to use any external OCaml libraries which
4755 * makes this a bit harder than it should be.
4757 module StringMap = Map.Make (String)
4759 let failwithf fs = ksprintf failwith fs
4761 let unique = let i = ref 0 in fun () -> incr i; !i
4763 let replace_char s c1 c2 =
4764 let s2 = String.copy s in
4765 let r = ref false in
4766 for i = 0 to String.length s2 - 1 do
4767 if String.unsafe_get s2 i = c1 then (
4768 String.unsafe_set s2 i c2;
4772 if not !r then s else s2
4776 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4778 let triml ?(test = isspace) str =
4780 let n = ref (String.length str) in
4781 while !n > 0 && test str.[!i]; do
4786 else String.sub str !i !n
4788 let trimr ?(test = isspace) str =
4789 let n = ref (String.length str) in
4790 while !n > 0 && test str.[!n-1]; do
4793 if !n = String.length str then str
4794 else String.sub str 0 !n
4796 let trim ?(test = isspace) str =
4797 trimr ~test (triml ~test str)
4799 let rec find s sub =
4800 let len = String.length s in
4801 let sublen = String.length sub in
4803 if i <= len-sublen then (
4805 if j < sublen then (
4806 if s.[i+j] = sub.[j] then loop2 (j+1)
4812 if r = -1 then loop (i+1) else r
4818 let rec replace_str s s1 s2 =
4819 let len = String.length s in
4820 let sublen = String.length s1 in
4821 let i = find s s1 in
4824 let s' = String.sub s 0 i in
4825 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4826 s' ^ s2 ^ replace_str s'' s1 s2
4829 let rec string_split sep str =
4830 let len = String.length str in
4831 let seplen = String.length sep in
4832 let i = find str sep in
4833 if i = -1 then [str]
4835 let s' = String.sub str 0 i in
4836 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4837 s' :: string_split sep s''
4840 let files_equal n1 n2 =
4841 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4842 match Sys.command cmd with
4845 | i -> failwithf "%s: failed with error code %d" cmd i
4847 let rec filter_map f = function
4851 | Some y -> y :: filter_map f xs
4852 | None -> filter_map f xs
4854 let rec find_map f = function
4855 | [] -> raise Not_found
4859 | None -> find_map f xs
4862 let rec loop i = function
4864 | x :: xs -> f i x; loop (i+1) xs
4869 let rec loop i = function
4871 | x :: xs -> let r = f i x in r :: loop (i+1) xs
4875 let count_chars c str =
4876 let count = ref 0 in
4877 for i = 0 to String.length str - 1 do
4878 if c = String.unsafe_get str i then incr count
4882 let name_of_argt = function
4883 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4884 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4885 | FileIn n | FileOut n -> n
4887 let java_name_of_struct typ =
4888 try List.assoc typ java_structs
4891 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4893 let cols_of_struct typ =
4894 try List.assoc typ structs
4896 failwithf "cols_of_struct: unknown struct %s" typ
4898 let seq_of_test = function
4899 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4900 | TestOutputListOfDevices (s, _)
4901 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4902 | TestOutputTrue s | TestOutputFalse s
4903 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4904 | TestOutputStruct (s, _)
4905 | TestLastFail s -> s
4907 (* Handling for function flags. *)
4908 let protocol_limit_warning =
4909 "Because of the message protocol, there is a transfer limit
4910 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4912 let danger_will_robinson =
4913 "B<This command is dangerous. Without careful use you
4914 can easily destroy all your data>."
4916 let deprecation_notice flags =
4919 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4921 sprintf "This function is deprecated.
4922 In new code, use the C<%s> call instead.
4924 Deprecated functions will not be removed from the API, but the
4925 fact that they are deprecated indicates that there are problems
4926 with correct use of these functions." alt in
4931 (* Create list of optional groups. *)
4933 let h = Hashtbl.create 13 in
4935 fun (name, _, _, flags, _, _, _) ->
4939 let names = try Hashtbl.find h group with Not_found -> [] in
4940 Hashtbl.replace h group (name :: names)
4944 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4947 fun group -> group, List.sort compare (Hashtbl.find h group)
4949 List.sort (fun x y -> compare (fst x) (fst y)) groups
4951 (* Check function names etc. for consistency. *)
4952 let check_functions () =
4953 let contains_uppercase str =
4954 let len = String.length str in
4956 if i >= len then false
4959 if c >= 'A' && c <= 'Z' then true
4966 (* Check function names. *)
4968 fun (name, _, _, _, _, _, _) ->
4969 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4970 failwithf "function name %s does not need 'guestfs' prefix" name;
4972 failwithf "function name is empty";
4973 if name.[0] < 'a' || name.[0] > 'z' then
4974 failwithf "function name %s must start with lowercase a-z" name;
4975 if String.contains name '-' then
4976 failwithf "function name %s should not contain '-', use '_' instead."
4980 (* Check function parameter/return names. *)
4982 fun (name, style, _, _, _, _, _) ->
4983 let check_arg_ret_name n =
4984 if contains_uppercase n then
4985 failwithf "%s param/ret %s should not contain uppercase chars"
4987 if String.contains n '-' || String.contains n '_' then
4988 failwithf "%s param/ret %s should not contain '-' or '_'"
4991 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;
4992 if n = "int" || n = "char" || n = "short" || n = "long" then
4993 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4994 if n = "i" || n = "n" then
4995 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4996 if n = "argv" || n = "args" then
4997 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
4999 (* List Haskell, OCaml and C keywords here.
5000 * http://www.haskell.org/haskellwiki/Keywords
5001 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5002 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5003 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5004 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5005 * Omitting _-containing words, since they're handled above.
5006 * Omitting the OCaml reserved word, "val", is ok,
5007 * and saves us from renaming several parameters.
5010 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5011 "char"; "class"; "const"; "constraint"; "continue"; "data";
5012 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5013 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5014 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5015 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5016 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5018 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5019 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5020 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5021 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5022 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5023 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5024 "volatile"; "when"; "where"; "while";
5026 if List.mem n reserved then
5027 failwithf "%s has param/ret using reserved word %s" name n;
5030 (match fst style with
5032 | RInt n | RInt64 n | RBool n
5033 | RConstString n | RConstOptString n | RString n
5034 | RStringList n | RStruct (n, _) | RStructList (n, _)
5035 | RHashtable n | RBufferOut n ->
5036 check_arg_ret_name n
5038 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5041 (* Check short descriptions. *)
5043 fun (name, _, _, _, _, shortdesc, _) ->
5044 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5045 failwithf "short description of %s should begin with lowercase." name;
5046 let c = shortdesc.[String.length shortdesc-1] in
5047 if c = '\n' || c = '.' then
5048 failwithf "short description of %s should not end with . or \\n." name
5051 (* Check long descriptions. *)
5053 fun (name, _, _, _, _, _, longdesc) ->
5054 if longdesc.[String.length longdesc-1] = '\n' then
5055 failwithf "long description of %s should not end with \\n." name
5058 (* Check proc_nrs. *)
5060 fun (name, _, proc_nr, _, _, _, _) ->
5061 if proc_nr <= 0 then
5062 failwithf "daemon function %s should have proc_nr > 0" name
5066 fun (name, _, proc_nr, _, _, _, _) ->
5067 if proc_nr <> -1 then
5068 failwithf "non-daemon function %s should have proc_nr -1" name
5069 ) non_daemon_functions;
5072 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5075 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5076 let rec loop = function
5079 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5081 | (name1,nr1) :: (name2,nr2) :: _ ->
5082 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5090 (* Ignore functions that have no tests. We generate a
5091 * warning when the user does 'make check' instead.
5093 | name, _, _, _, [], _, _ -> ()
5094 | name, _, _, _, tests, _, _ ->
5098 match seq_of_test test with
5100 failwithf "%s has a test containing an empty sequence" name
5101 | cmds -> List.map List.hd cmds
5103 let funcs = List.flatten funcs in
5105 let tested = List.mem name funcs in
5108 failwithf "function %s has tests but does not test itself" name
5111 (* 'pr' prints to the current output file. *)
5112 let chan = ref Pervasives.stdout
5117 let i = count_chars '\n' str in
5118 lines := !lines + i;
5119 output_string !chan str
5122 let copyright_years =
5123 let this_year = 1900 + (localtime (time ())).tm_year in
5124 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5126 (* Generate a header block in a number of standard styles. *)
5127 type comment_style =
5128 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5129 type license = GPLv2plus | LGPLv2plus
5131 let generate_header ?(extra_inputs = []) comment license =
5132 let inputs = "src/generator.ml" :: extra_inputs in
5133 let c = match comment with
5134 | CStyle -> pr "/* "; " *"
5135 | CPlusPlusStyle -> pr "// "; "//"
5136 | HashStyle -> pr "# "; "#"
5137 | OCamlStyle -> pr "(* "; " *"
5138 | HaskellStyle -> pr "{- "; " " in
5139 pr "libguestfs generated file\n";
5140 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5141 List.iter (pr "%s %s\n" c) inputs;
5142 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5144 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5148 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5149 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5150 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5151 pr "%s (at your option) any later version.\n" c;
5153 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5154 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5155 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5156 pr "%s GNU General Public License for more details.\n" c;
5158 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5159 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5160 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5163 pr "%s This library is free software; you can redistribute it and/or\n" c;
5164 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5165 pr "%s License as published by the Free Software Foundation; either\n" c;
5166 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5168 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5169 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5170 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5171 pr "%s Lesser General Public License for more details.\n" c;
5173 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5174 pr "%s License along with this library; if not, write to the Free Software\n" c;
5175 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5178 | CStyle -> pr " */\n"
5181 | OCamlStyle -> pr " *)\n"
5182 | HaskellStyle -> pr "-}\n"
5186 (* Start of main code generation functions below this line. *)
5188 (* Generate the pod documentation for the C API. *)
5189 let rec generate_actions_pod () =
5191 fun (shortname, style, _, flags, _, _, longdesc) ->
5192 if not (List.mem NotInDocs flags) then (
5193 let name = "guestfs_" ^ shortname in
5194 pr "=head2 %s\n\n" name;
5196 generate_prototype ~extern:false ~handle:"g" name style;
5198 pr "%s\n\n" longdesc;
5199 (match fst style with
5201 pr "This function returns 0 on success or -1 on error.\n\n"
5203 pr "On error this function returns -1.\n\n"
5205 pr "On error this function returns -1.\n\n"
5207 pr "This function returns a C truth value on success or -1 on error.\n\n"
5209 pr "This function returns a string, or NULL on error.
5210 The string is owned by the guest handle and must I<not> be freed.\n\n"
5211 | RConstOptString _ ->
5212 pr "This function returns a string which may be NULL.
5213 There is way to return an error from this function.
5214 The string is owned by the guest handle and must I<not> be freed.\n\n"
5216 pr "This function returns a string, or NULL on error.
5217 I<The caller must free the returned string after use>.\n\n"
5219 pr "This function returns a NULL-terminated array of strings
5220 (like L<environ(3)>), or NULL if there was an error.
5221 I<The caller must free the strings and the array after use>.\n\n"
5222 | RStruct (_, typ) ->
5223 pr "This function returns a C<struct guestfs_%s *>,
5224 or NULL if there was an error.
5225 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5226 | RStructList (_, typ) ->
5227 pr "This function returns a C<struct guestfs_%s_list *>
5228 (see E<lt>guestfs-structs.hE<gt>),
5229 or NULL if there was an error.
5230 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5232 pr "This function returns a NULL-terminated array of
5233 strings, or NULL if there was an error.
5234 The array of strings will always have length C<2n+1>, where
5235 C<n> keys and values alternate, followed by the trailing NULL entry.
5236 I<The caller must free the strings and the array after use>.\n\n"
5238 pr "This function returns a buffer, or NULL on error.
5239 The size of the returned buffer is written to C<*size_r>.
5240 I<The caller must free the returned buffer after use>.\n\n"
5242 if List.mem ProtocolLimitWarning flags then
5243 pr "%s\n\n" protocol_limit_warning;
5244 if List.mem DangerWillRobinson flags then
5245 pr "%s\n\n" danger_will_robinson;
5246 match deprecation_notice flags with
5248 | Some txt -> pr "%s\n\n" txt
5250 ) all_functions_sorted
5252 and generate_structs_pod () =
5253 (* Structs documentation. *)
5256 pr "=head2 guestfs_%s\n" typ;
5258 pr " struct guestfs_%s {\n" typ;
5261 | name, FChar -> pr " char %s;\n" name
5262 | name, FUInt32 -> pr " uint32_t %s;\n" name
5263 | name, FInt32 -> pr " int32_t %s;\n" name
5264 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5265 | name, FInt64 -> pr " int64_t %s;\n" name
5266 | name, FString -> pr " char *%s;\n" name
5268 pr " /* The next two fields describe a byte array. */\n";
5269 pr " uint32_t %s_len;\n" name;
5270 pr " char *%s;\n" name
5272 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5273 pr " char %s[32];\n" name
5274 | name, FOptPercent ->
5275 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5276 pr " float %s;\n" name
5280 pr " struct guestfs_%s_list {\n" typ;
5281 pr " uint32_t len; /* Number of elements in list. */\n";
5282 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5285 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5286 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5291 and generate_availability_pod () =
5292 (* Availability documentation. *)
5296 fun (group, functions) ->
5297 pr "=item B<%s>\n" group;
5299 pr "The following functions:\n";
5300 List.iter (pr "L</guestfs_%s>\n") functions;
5306 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5307 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5309 * We have to use an underscore instead of a dash because otherwise
5310 * rpcgen generates incorrect code.
5312 * This header is NOT exported to clients, but see also generate_structs_h.
5314 and generate_xdr () =
5315 generate_header CStyle LGPLv2plus;
5317 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5318 pr "typedef string str<>;\n";
5321 (* Internal structures. *)
5325 pr "struct guestfs_int_%s {\n" typ;
5327 | name, FChar -> pr " char %s;\n" name
5328 | name, FString -> pr " string %s<>;\n" name
5329 | name, FBuffer -> pr " opaque %s<>;\n" name
5330 | name, FUUID -> pr " opaque %s[32];\n" name
5331 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5332 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5333 | name, FOptPercent -> pr " float %s;\n" name
5337 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5342 fun (shortname, style, _, _, _, _, _) ->
5343 let name = "guestfs_" ^ shortname in
5345 (match snd style with
5348 pr "struct %s_args {\n" name;
5351 | Pathname n | Device n | Dev_or_Path n | String n ->
5352 pr " string %s<>;\n" n
5353 | OptString n -> pr " str *%s;\n" n
5354 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5355 | Bool n -> pr " bool %s;\n" n
5356 | Int n -> pr " int %s;\n" n
5357 | Int64 n -> pr " hyper %s;\n" n
5358 | FileIn _ | FileOut _ -> ()
5362 (match fst style with
5365 pr "struct %s_ret {\n" name;
5369 pr "struct %s_ret {\n" name;
5370 pr " hyper %s;\n" n;
5373 pr "struct %s_ret {\n" name;
5376 | RConstString _ | RConstOptString _ ->
5377 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5379 pr "struct %s_ret {\n" name;
5380 pr " string %s<>;\n" n;
5383 pr "struct %s_ret {\n" name;
5384 pr " str %s<>;\n" n;
5386 | RStruct (n, typ) ->
5387 pr "struct %s_ret {\n" name;
5388 pr " guestfs_int_%s %s;\n" typ n;
5390 | RStructList (n, typ) ->
5391 pr "struct %s_ret {\n" name;
5392 pr " guestfs_int_%s_list %s;\n" typ n;
5395 pr "struct %s_ret {\n" name;
5396 pr " str %s<>;\n" n;
5399 pr "struct %s_ret {\n" name;
5400 pr " opaque %s<>;\n" n;
5405 (* Table of procedure numbers. *)
5406 pr "enum guestfs_procedure {\n";
5408 fun (shortname, _, proc_nr, _, _, _, _) ->
5409 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5411 pr " GUESTFS_PROC_NR_PROCS\n";
5415 (* Having to choose a maximum message size is annoying for several
5416 * reasons (it limits what we can do in the API), but it (a) makes
5417 * the protocol a lot simpler, and (b) provides a bound on the size
5418 * of the daemon which operates in limited memory space.
5420 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5423 (* Message header, etc. *)
5425 /* The communication protocol is now documented in the guestfs(3)
5429 const GUESTFS_PROGRAM = 0x2000F5F5;
5430 const GUESTFS_PROTOCOL_VERSION = 1;
5432 /* These constants must be larger than any possible message length. */
5433 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5434 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5436 enum guestfs_message_direction {
5437 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5438 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5441 enum guestfs_message_status {
5442 GUESTFS_STATUS_OK = 0,
5443 GUESTFS_STATUS_ERROR = 1
5446 const GUESTFS_ERROR_LEN = 256;
5448 struct guestfs_message_error {
5449 string error_message<GUESTFS_ERROR_LEN>;
5452 struct guestfs_message_header {
5453 unsigned prog; /* GUESTFS_PROGRAM */
5454 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5455 guestfs_procedure proc; /* GUESTFS_PROC_x */
5456 guestfs_message_direction direction;
5457 unsigned serial; /* message serial number */
5458 guestfs_message_status status;
5461 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5463 struct guestfs_chunk {
5464 int cancel; /* if non-zero, transfer is cancelled */
5465 /* data size is 0 bytes if the transfer has finished successfully */
5466 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5470 (* Generate the guestfs-structs.h file. *)
5471 and generate_structs_h () =
5472 generate_header CStyle LGPLv2plus;
5474 (* This is a public exported header file containing various
5475 * structures. The structures are carefully written to have
5476 * exactly the same in-memory format as the XDR structures that
5477 * we use on the wire to the daemon. The reason for creating
5478 * copies of these structures here is just so we don't have to
5479 * export the whole of guestfs_protocol.h (which includes much
5480 * unrelated and XDR-dependent stuff that we don't want to be
5481 * public, or required by clients).
5483 * To reiterate, we will pass these structures to and from the
5484 * client with a simple assignment or memcpy, so the format
5485 * must be identical to what rpcgen / the RFC defines.
5488 (* Public structures. *)
5491 pr "struct guestfs_%s {\n" typ;
5494 | name, FChar -> pr " char %s;\n" name
5495 | name, FString -> pr " char *%s;\n" name
5497 pr " uint32_t %s_len;\n" name;
5498 pr " char *%s;\n" name
5499 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5500 | name, FUInt32 -> pr " uint32_t %s;\n" name
5501 | name, FInt32 -> pr " int32_t %s;\n" name
5502 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5503 | name, FInt64 -> pr " int64_t %s;\n" name
5504 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5508 pr "struct guestfs_%s_list {\n" typ;
5509 pr " uint32_t len;\n";
5510 pr " struct guestfs_%s *val;\n" typ;
5513 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5514 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5518 (* Generate the guestfs-actions.h file. *)
5519 and generate_actions_h () =
5520 generate_header CStyle LGPLv2plus;
5522 fun (shortname, style, _, _, _, _, _) ->
5523 let name = "guestfs_" ^ shortname in
5524 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5528 (* Generate the guestfs-internal-actions.h file. *)
5529 and generate_internal_actions_h () =
5530 generate_header CStyle LGPLv2plus;
5532 fun (shortname, style, _, _, _, _, _) ->
5533 let name = "guestfs__" ^ shortname in
5534 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5536 ) non_daemon_functions
5538 (* Generate the client-side dispatch stubs. *)
5539 and generate_client_actions () =
5540 generate_header CStyle LGPLv2plus;
5547 #include <inttypes.h>
5549 #include \"guestfs.h\"
5550 #include \"guestfs-internal.h\"
5551 #include \"guestfs-internal-actions.h\"
5552 #include \"guestfs_protocol.h\"
5554 #define error guestfs_error
5555 //#define perrorf guestfs_perrorf
5556 #define safe_malloc guestfs_safe_malloc
5557 #define safe_realloc guestfs_safe_realloc
5558 //#define safe_strdup guestfs_safe_strdup
5559 #define safe_memdup guestfs_safe_memdup
5561 /* Check the return message from a call for validity. */
5563 check_reply_header (guestfs_h *g,
5564 const struct guestfs_message_header *hdr,
5565 unsigned int proc_nr, unsigned int serial)
5567 if (hdr->prog != GUESTFS_PROGRAM) {
5568 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5571 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5572 error (g, \"wrong protocol version (%%d/%%d)\",
5573 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5576 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5577 error (g, \"unexpected message direction (%%d/%%d)\",
5578 hdr->direction, GUESTFS_DIRECTION_REPLY);
5581 if (hdr->proc != proc_nr) {
5582 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5585 if (hdr->serial != serial) {
5586 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5593 /* Check we are in the right state to run a high-level action. */
5595 check_state (guestfs_h *g, const char *caller)
5597 if (!guestfs__is_ready (g)) {
5598 if (guestfs__is_config (g) || guestfs__is_launching (g))
5599 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5602 error (g, \"%%s called from the wrong state, %%d != READY\",
5603 caller, guestfs__get_state (g));
5611 (* Generate code to generate guestfish call traces. *)
5612 let trace_call shortname style =
5613 pr " if (guestfs__get_trace (g)) {\n";
5616 List.exists (function
5617 | StringList _ | DeviceList _ -> true
5618 | _ -> false) (snd style) in
5624 pr " printf (\"%s\");\n" shortname;
5627 | String n (* strings *)
5633 (* guestfish doesn't support string escaping, so neither do we *)
5634 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5635 | OptString n -> (* string option *)
5636 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5637 pr " else printf (\" null\");\n"
5639 | DeviceList n -> (* string list *)
5640 pr " putchar (' ');\n";
5641 pr " putchar ('\"');\n";
5642 pr " for (i = 0; %s[i]; ++i) {\n" n;
5643 pr " if (i > 0) putchar (' ');\n";
5644 pr " fputs (%s[i], stdout);\n" n;
5646 pr " putchar ('\"');\n";
5647 | Bool n -> (* boolean *)
5648 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5649 | Int n -> (* int *)
5650 pr " printf (\" %%d\", %s);\n" n
5652 pr " printf (\" %%\" PRIi64, %s);\n" n
5654 pr " putchar ('\\n');\n";
5659 (* For non-daemon functions, generate a wrapper around each function. *)
5661 fun (shortname, style, _, _, _, _, _) ->
5662 let name = "guestfs_" ^ shortname in
5664 generate_prototype ~extern:false ~semicolon:false ~newline:true
5665 ~handle:"g" name style;
5667 trace_call shortname style;
5668 pr " return guestfs__%s " shortname;
5669 generate_c_call_args ~handle:"g" style;
5673 ) non_daemon_functions;
5675 (* Client-side stubs for each function. *)
5677 fun (shortname, style, _, _, _, _, _) ->
5678 let name = "guestfs_" ^ shortname in
5680 (* Generate the action stub. *)
5681 generate_prototype ~extern:false ~semicolon:false ~newline:true
5682 ~handle:"g" name style;
5685 match fst style with
5686 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5687 | RConstString _ | RConstOptString _ ->
5688 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5689 | RString _ | RStringList _
5690 | RStruct _ | RStructList _
5691 | RHashtable _ | RBufferOut _ ->
5696 (match snd style with
5698 | _ -> pr " struct %s_args args;\n" name
5701 pr " guestfs_message_header hdr;\n";
5702 pr " guestfs_message_error err;\n";
5704 match fst style with
5706 | RConstString _ | RConstOptString _ ->
5707 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5709 | RBool _ | RString _ | RStringList _
5710 | RStruct _ | RStructList _
5711 | RHashtable _ | RBufferOut _ ->
5712 pr " struct %s_ret ret;\n" name;
5715 pr " int serial;\n";
5718 trace_call shortname style;
5719 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5720 pr " guestfs___set_busy (g);\n";
5723 (* Send the main header and arguments. *)
5724 (match snd style with
5726 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5727 (String.uppercase shortname)
5731 | Pathname n | Device n | Dev_or_Path n | String n ->
5732 pr " args.%s = (char *) %s;\n" n n
5734 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5735 | StringList n | DeviceList n ->
5736 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5737 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5739 pr " args.%s = %s;\n" n n
5741 pr " args.%s = %s;\n" n n
5743 pr " args.%s = %s;\n" n n
5744 | FileIn _ | FileOut _ -> ()
5746 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5747 (String.uppercase shortname);
5748 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5751 pr " if (serial == -1) {\n";
5752 pr " guestfs___end_busy (g);\n";
5753 pr " return %s;\n" error_code;
5757 (* Send any additional files (FileIn) requested. *)
5758 let need_read_reply_label = ref false in
5762 pr " r = guestfs___send_file (g, %s);\n" n;
5763 pr " if (r == -1) {\n";
5764 pr " guestfs___end_busy (g);\n";
5765 pr " return %s;\n" error_code;
5767 pr " if (r == -2) /* daemon cancelled */\n";
5768 pr " goto read_reply;\n";
5769 need_read_reply_label := true;
5774 (* Wait for the reply from the remote end. *)
5775 if !need_read_reply_label then pr " read_reply:\n";
5776 pr " memset (&hdr, 0, sizeof hdr);\n";
5777 pr " memset (&err, 0, sizeof err);\n";
5778 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5780 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5784 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5787 pr " if (r == -1) {\n";
5788 pr " guestfs___end_busy (g);\n";
5789 pr " return %s;\n" error_code;
5793 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5794 (String.uppercase shortname);
5795 pr " guestfs___end_busy (g);\n";
5796 pr " return %s;\n" error_code;
5800 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5801 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5802 pr " free (err.error_message);\n";
5803 pr " guestfs___end_busy (g);\n";
5804 pr " return %s;\n" error_code;
5808 (* Expecting to receive further files (FileOut)? *)
5812 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5813 pr " guestfs___end_busy (g);\n";
5814 pr " return %s;\n" error_code;
5820 pr " guestfs___end_busy (g);\n";
5822 (match fst style with
5823 | RErr -> pr " return 0;\n"
5824 | RInt n | RInt64 n | RBool n ->
5825 pr " return ret.%s;\n" n
5826 | RConstString _ | RConstOptString _ ->
5827 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5829 pr " return ret.%s; /* caller will free */\n" n
5830 | RStringList n | RHashtable n ->
5831 pr " /* caller will free this, but we need to add a NULL entry */\n";
5832 pr " ret.%s.%s_val =\n" n n;
5833 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5834 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5836 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5837 pr " return ret.%s.%s_val;\n" n n
5839 pr " /* caller will free this */\n";
5840 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5841 | RStructList (n, _) ->
5842 pr " /* caller will free this */\n";
5843 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5845 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5846 pr " * _val might be NULL here. To make the API saner for\n";
5847 pr " * callers, we turn this case into a unique pointer (using\n";
5848 pr " * malloc(1)).\n";
5850 pr " if (ret.%s.%s_len > 0) {\n" n n;
5851 pr " *size_r = ret.%s.%s_len;\n" n n;
5852 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5854 pr " free (ret.%s.%s_val);\n" n n;
5855 pr " char *p = safe_malloc (g, 1);\n";
5856 pr " *size_r = ret.%s.%s_len;\n" n n;
5864 (* Functions to free structures. *)
5865 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5866 pr " * structure format is identical to the XDR format. See note in\n";
5867 pr " * generator.ml.\n";
5874 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5876 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5882 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5884 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5891 (* Generate daemon/actions.h. *)
5892 and generate_daemon_actions_h () =
5893 generate_header CStyle GPLv2plus;
5895 pr "#include \"../src/guestfs_protocol.h\"\n";
5899 fun (name, style, _, _, _, _, _) ->
5901 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5905 (* Generate the linker script which controls the visibility of
5906 * symbols in the public ABI and ensures no other symbols get
5907 * exported accidentally.
5909 and generate_linker_script () =
5910 generate_header HashStyle GPLv2plus;
5915 "guestfs_get_error_handler";
5916 "guestfs_get_out_of_memory_handler";
5917 "guestfs_last_error";
5918 "guestfs_set_error_handler";
5919 "guestfs_set_launch_done_callback";
5920 "guestfs_set_log_message_callback";
5921 "guestfs_set_out_of_memory_handler";
5922 "guestfs_set_subprocess_quit_callback";
5924 (* Unofficial parts of the API: the bindings code use these
5925 * functions, so it is useful to export them.
5927 "guestfs_safe_calloc";
5928 "guestfs_safe_malloc";
5931 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
5935 List.map (fun (typ, _) ->
5936 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
5939 let globals = List.sort compare (globals @ functions @ structs) in
5943 List.iter (pr " %s;\n") globals;
5950 (* Generate the server-side stubs. *)
5951 and generate_daemon_actions () =
5952 generate_header CStyle GPLv2plus;
5954 pr "#include <config.h>\n";
5956 pr "#include <stdio.h>\n";
5957 pr "#include <stdlib.h>\n";
5958 pr "#include <string.h>\n";
5959 pr "#include <inttypes.h>\n";
5960 pr "#include <rpc/types.h>\n";
5961 pr "#include <rpc/xdr.h>\n";
5963 pr "#include \"daemon.h\"\n";
5964 pr "#include \"c-ctype.h\"\n";
5965 pr "#include \"../src/guestfs_protocol.h\"\n";
5966 pr "#include \"actions.h\"\n";
5970 fun (name, style, _, _, _, _, _) ->
5971 (* Generate server-side stubs. *)
5972 pr "static void %s_stub (XDR *xdr_in)\n" name;
5975 match fst style with
5976 | RErr | RInt _ -> pr " int r;\n"; "-1"
5977 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5978 | RBool _ -> pr " int r;\n"; "-1"
5979 | RConstString _ | RConstOptString _ ->
5980 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5981 | RString _ -> pr " char *r;\n"; "NULL"
5982 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5983 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
5984 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
5986 pr " size_t size = 1;\n";
5990 (match snd style with
5993 pr " struct guestfs_%s_args args;\n" name;
5996 | Device n | Dev_or_Path n
5999 | OptString n -> pr " char *%s;\n" n
6000 | StringList n | DeviceList n -> pr " char **%s;\n" n
6001 | Bool n -> pr " int %s;\n" n
6002 | Int n -> pr " int %s;\n" n
6003 | Int64 n -> pr " int64_t %s;\n" n
6004 | FileIn _ | FileOut _ -> ()
6009 (match snd style with
6012 pr " memset (&args, 0, sizeof args);\n";
6014 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6015 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6019 pr " char *%s = args.%s;\n" n n
6021 let pr_list_handling_code n =
6022 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6023 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6024 pr " if (%s == NULL) {\n" n;
6025 pr " reply_with_perror (\"realloc\");\n";
6028 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6029 pr " args.%s.%s_val = %s;\n" n n n;
6035 pr " ABS_PATH (%s, goto done);\n" n;
6038 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
6041 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
6042 | String n -> pr_args n
6043 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6045 pr_list_handling_code n;
6047 pr_list_handling_code n;
6048 pr " /* Ensure that each is a device,\n";
6049 pr " * and perform device name translation. */\n";
6050 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6051 pr " RESOLVE_DEVICE (physvols[pvi], goto done);\n";
6053 | Bool n -> pr " %s = args.%s;\n" n n
6054 | Int n -> pr " %s = args.%s;\n" n n
6055 | Int64 n -> pr " %s = args.%s;\n" n n
6056 | FileIn _ | FileOut _ -> ()
6062 (* this is used at least for do_equal *)
6063 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6064 (* Emit NEED_ROOT just once, even when there are two or
6065 more Pathname args *)
6066 pr " NEED_ROOT (goto done);\n";
6069 (* Don't want to call the impl with any FileIn or FileOut
6070 * parameters, since these go "outside" the RPC protocol.
6073 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6075 pr " r = do_%s " name;
6076 generate_c_call_args (fst style, args');
6079 (match fst style with
6080 | RErr | RInt _ | RInt64 _ | RBool _
6081 | RConstString _ | RConstOptString _
6082 | RString _ | RStringList _ | RHashtable _
6083 | RStruct (_, _) | RStructList (_, _) ->
6084 pr " if (r == %s)\n" error_code;
6085 pr " /* do_%s has already called reply_with_error */\n" name;
6089 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6090 pr " * an ordinary zero-length buffer), so be careful ...\n";
6092 pr " if (size == 1 && r == %s)\n" error_code;
6093 pr " /* do_%s has already called reply_with_error */\n" name;
6098 (* If there are any FileOut parameters, then the impl must
6099 * send its own reply.
6102 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6104 pr " /* do_%s has already sent a reply */\n" name
6106 match fst style with
6107 | RErr -> pr " reply (NULL, NULL);\n"
6108 | RInt n | RInt64 n | RBool n ->
6109 pr " struct guestfs_%s_ret ret;\n" name;
6110 pr " ret.%s = r;\n" n;
6111 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6113 | RConstString _ | RConstOptString _ ->
6114 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6116 pr " struct guestfs_%s_ret ret;\n" name;
6117 pr " ret.%s = r;\n" n;
6118 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6121 | RStringList n | RHashtable n ->
6122 pr " struct guestfs_%s_ret ret;\n" name;
6123 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6124 pr " ret.%s.%s_val = r;\n" n n;
6125 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6127 pr " free_strings (r);\n"
6129 pr " struct guestfs_%s_ret ret;\n" name;
6130 pr " ret.%s = *r;\n" n;
6131 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6133 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6135 | RStructList (n, _) ->
6136 pr " struct guestfs_%s_ret ret;\n" name;
6137 pr " ret.%s = *r;\n" n;
6138 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6140 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6143 pr " struct guestfs_%s_ret ret;\n" name;
6144 pr " ret.%s.%s_val = r;\n" n n;
6145 pr " ret.%s.%s_len = size;\n" n n;
6146 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6151 (* Free the args. *)
6152 (match snd style with
6157 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6164 (* Dispatch function. *)
6165 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6167 pr " switch (proc_nr) {\n";
6170 fun (name, style, _, _, _, _, _) ->
6171 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6172 pr " %s_stub (xdr_in);\n" name;
6177 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";
6182 (* LVM columns and tokenization functions. *)
6183 (* XXX This generates crap code. We should rethink how we
6189 pr "static const char *lvm_%s_cols = \"%s\";\n"
6190 typ (String.concat "," (List.map fst cols));
6193 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6195 pr " char *tok, *p, *next;\n";
6199 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6202 pr " if (!str) {\n";
6203 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6206 pr " if (!*str || c_isspace (*str)) {\n";
6207 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6212 fun (name, coltype) ->
6213 pr " if (!tok) {\n";
6214 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6217 pr " p = strchrnul (tok, ',');\n";
6218 pr " if (*p) next = p+1; else next = NULL;\n";
6219 pr " *p = '\\0';\n";
6222 pr " r->%s = strdup (tok);\n" name;
6223 pr " if (r->%s == NULL) {\n" name;
6224 pr " perror (\"strdup\");\n";
6228 pr " for (i = j = 0; i < 32; ++j) {\n";
6229 pr " if (tok[j] == '\\0') {\n";
6230 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6232 pr " } else if (tok[j] != '-')\n";
6233 pr " r->%s[i++] = tok[j];\n" name;
6236 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6237 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6241 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6242 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6246 pr " if (tok[0] == '\\0')\n";
6247 pr " r->%s = -1;\n" name;
6248 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6249 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6252 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6253 assert false (* can never be an LVM column *)
6255 pr " tok = next;\n";
6258 pr " if (tok != NULL) {\n";
6259 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6266 pr "guestfs_int_lvm_%s_list *\n" typ;
6267 pr "parse_command_line_%ss (void)\n" typ;
6269 pr " char *out, *err;\n";
6270 pr " char *p, *pend;\n";
6272 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6273 pr " void *newp;\n";
6275 pr " ret = malloc (sizeof *ret);\n";
6276 pr " if (!ret) {\n";
6277 pr " reply_with_perror (\"malloc\");\n";
6278 pr " return NULL;\n";
6281 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6282 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6284 pr " r = command (&out, &err,\n";
6285 pr " \"lvm\", \"%ss\",\n" typ;
6286 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6287 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6288 pr " if (r == -1) {\n";
6289 pr " reply_with_error (\"%%s\", err);\n";
6290 pr " free (out);\n";
6291 pr " free (err);\n";
6292 pr " free (ret);\n";
6293 pr " return NULL;\n";
6296 pr " free (err);\n";
6298 pr " /* Tokenize each line of the output. */\n";
6301 pr " while (p) {\n";
6302 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6303 pr " if (pend) {\n";
6304 pr " *pend = '\\0';\n";
6308 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6311 pr " if (!*p) { /* Empty line? Skip it. */\n";
6316 pr " /* Allocate some space to store this next entry. */\n";
6317 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6318 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6319 pr " if (newp == NULL) {\n";
6320 pr " reply_with_perror (\"realloc\");\n";
6321 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6322 pr " free (ret);\n";
6323 pr " free (out);\n";
6324 pr " return NULL;\n";
6326 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6328 pr " /* Tokenize the next entry. */\n";
6329 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6330 pr " if (r == -1) {\n";
6331 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6332 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6333 pr " free (ret);\n";
6334 pr " free (out);\n";
6335 pr " return NULL;\n";
6342 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6344 pr " free (out);\n";
6345 pr " return ret;\n";
6348 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6350 (* Generate a list of function names, for debugging in the daemon.. *)
6351 and generate_daemon_names () =
6352 generate_header CStyle GPLv2plus;
6354 pr "#include <config.h>\n";
6356 pr "#include \"daemon.h\"\n";
6359 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6360 pr "const char *function_names[] = {\n";
6362 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6366 (* Generate the optional groups for the daemon to implement
6367 * guestfs_available.
6369 and generate_daemon_optgroups_c () =
6370 generate_header CStyle GPLv2plus;
6372 pr "#include <config.h>\n";
6374 pr "#include \"daemon.h\"\n";
6375 pr "#include \"optgroups.h\"\n";
6378 pr "struct optgroup optgroups[] = {\n";
6381 pr " { \"%s\", optgroup_%s_available },\n" group group
6383 pr " { NULL, NULL }\n";
6386 and generate_daemon_optgroups_h () =
6387 generate_header CStyle GPLv2plus;
6391 pr "extern int optgroup_%s_available (void);\n" group
6394 (* Generate the tests. *)
6395 and generate_tests () =
6396 generate_header CStyle GPLv2plus;
6403 #include <sys/types.h>
6406 #include \"guestfs.h\"
6407 #include \"guestfs-internal.h\"
6409 static guestfs_h *g;
6410 static int suppress_error = 0;
6412 static void print_error (guestfs_h *g, void *data, const char *msg)
6414 if (!suppress_error)
6415 fprintf (stderr, \"%%s\\n\", msg);
6418 /* FIXME: nearly identical code appears in fish.c */
6419 static void print_strings (char *const *argv)
6423 for (argc = 0; argv[argc] != NULL; ++argc)
6424 printf (\"\\t%%s\\n\", argv[argc]);
6428 static void print_table (char const *const *argv)
6432 for (i = 0; argv[i] != NULL; i += 2)
6433 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6439 (* Generate a list of commands which are not tested anywhere. *)
6440 pr "static void no_test_warnings (void)\n";
6443 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6445 fun (_, _, _, _, tests, _, _) ->
6446 let tests = filter_map (
6448 | (_, (Always|If _|Unless _), test) -> Some test
6449 | (_, Disabled, _) -> None
6451 let seq = List.concat (List.map seq_of_test tests) in
6452 let cmds_tested = List.map List.hd seq in
6453 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6457 fun (name, _, _, _, _, _, _) ->
6458 if not (Hashtbl.mem hash name) then
6459 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6465 (* Generate the actual tests. Note that we generate the tests
6466 * in reverse order, deliberately, so that (in general) the
6467 * newest tests run first. This makes it quicker and easier to
6472 fun (name, _, _, flags, tests, _, _) ->
6473 mapi (generate_one_test name flags) tests
6474 ) (List.rev all_functions) in
6475 let test_names = List.concat test_names in
6476 let nr_tests = List.length test_names in
6479 int main (int argc, char *argv[])
6482 unsigned long int n_failed = 0;
6483 const char *filename;
6485 int nr_tests, test_num = 0;
6487 setbuf (stdout, NULL);
6489 no_test_warnings ();
6491 g = guestfs_create ();
6493 printf (\"guestfs_create FAILED\\n\");
6494 exit (EXIT_FAILURE);
6497 guestfs_set_error_handler (g, print_error, NULL);
6499 guestfs_set_path (g, \"../appliance\");
6501 filename = \"test1.img\";
6502 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6505 exit (EXIT_FAILURE);
6507 if (lseek (fd, %d, SEEK_SET) == -1) {
6511 exit (EXIT_FAILURE);
6513 if (write (fd, &c, 1) == -1) {
6517 exit (EXIT_FAILURE);
6519 if (close (fd) == -1) {
6522 exit (EXIT_FAILURE);
6524 if (guestfs_add_drive (g, filename) == -1) {
6525 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6526 exit (EXIT_FAILURE);
6529 filename = \"test2.img\";
6530 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6533 exit (EXIT_FAILURE);
6535 if (lseek (fd, %d, SEEK_SET) == -1) {
6539 exit (EXIT_FAILURE);
6541 if (write (fd, &c, 1) == -1) {
6545 exit (EXIT_FAILURE);
6547 if (close (fd) == -1) {
6550 exit (EXIT_FAILURE);
6552 if (guestfs_add_drive (g, filename) == -1) {
6553 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6554 exit (EXIT_FAILURE);
6557 filename = \"test3.img\";
6558 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6561 exit (EXIT_FAILURE);
6563 if (lseek (fd, %d, SEEK_SET) == -1) {
6567 exit (EXIT_FAILURE);
6569 if (write (fd, &c, 1) == -1) {
6573 exit (EXIT_FAILURE);
6575 if (close (fd) == -1) {
6578 exit (EXIT_FAILURE);
6580 if (guestfs_add_drive (g, filename) == -1) {
6581 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6582 exit (EXIT_FAILURE);
6585 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6586 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6587 exit (EXIT_FAILURE);
6590 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6593 if (guestfs_launch (g) == -1) {
6594 printf (\"guestfs_launch FAILED\\n\");
6595 exit (EXIT_FAILURE);
6598 /* Cancel previous alarm. */
6603 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6607 pr " test_num++;\n";
6608 pr " if (guestfs_get_verbose (g))\n";
6609 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
6610 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6611 pr " if (%s () == -1) {\n" test_name;
6612 pr " printf (\"%s FAILED\\n\");\n" test_name;
6613 pr " n_failed++;\n";
6618 pr " guestfs_close (g);\n";
6619 pr " unlink (\"test1.img\");\n";
6620 pr " unlink (\"test2.img\");\n";
6621 pr " unlink (\"test3.img\");\n";
6624 pr " if (n_failed > 0) {\n";
6625 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6626 pr " exit (EXIT_FAILURE);\n";
6630 pr " exit (EXIT_SUCCESS);\n";
6633 and generate_one_test name flags i (init, prereq, test) =
6634 let test_name = sprintf "test_%s_%d" name i in
6637 static int %s_skip (void)
6641 str = getenv (\"TEST_ONLY\");
6643 return strstr (str, \"%s\") == NULL;
6644 str = getenv (\"SKIP_%s\");
6645 if (str && STREQ (str, \"1\")) return 1;
6646 str = getenv (\"SKIP_TEST_%s\");
6647 if (str && STREQ (str, \"1\")) return 1;
6651 " test_name name (String.uppercase test_name) (String.uppercase name);
6654 | Disabled | Always -> ()
6655 | If code | Unless code ->
6656 pr "static int %s_prereq (void)\n" test_name;
6664 static int %s (void)
6667 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6671 " test_name test_name test_name;
6673 (* Optional functions should only be tested if the relevant
6674 * support is available in the daemon.
6680 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6682 pr " suppress_error = 1;\n";
6683 pr " r = guestfs_available (g, (char **) groups);\n";
6684 pr " suppress_error = 0;\n";
6685 pr " if (r == -1) {\n";
6686 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6695 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6697 pr " if (! %s_prereq ()) {\n" test_name;
6698 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6702 generate_one_test_body name i test_name init test;
6704 pr " if (%s_prereq ()) {\n" test_name;
6705 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6709 generate_one_test_body name i test_name init test;
6711 generate_one_test_body name i test_name init test
6719 and generate_one_test_body name i test_name init test =
6721 | InitNone (* XXX at some point, InitNone and InitEmpty became
6722 * folded together as the same thing. Really we should
6723 * make InitNone do nothing at all, but the tests may
6724 * need to be checked to make sure this is OK.
6727 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6728 List.iter (generate_test_command_call test_name)
6729 [["blockdev_setrw"; "/dev/sda"];
6733 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6734 List.iter (generate_test_command_call test_name)
6735 [["blockdev_setrw"; "/dev/sda"];
6738 ["part_disk"; "/dev/sda"; "mbr"]]
6740 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6741 List.iter (generate_test_command_call test_name)
6742 [["blockdev_setrw"; "/dev/sda"];
6745 ["part_disk"; "/dev/sda"; "mbr"];
6746 ["mkfs"; "ext2"; "/dev/sda1"];
6747 ["mount_options"; ""; "/dev/sda1"; "/"]]
6748 | InitBasicFSonLVM ->
6749 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6751 List.iter (generate_test_command_call test_name)
6752 [["blockdev_setrw"; "/dev/sda"];
6755 ["part_disk"; "/dev/sda"; "mbr"];
6756 ["pvcreate"; "/dev/sda1"];
6757 ["vgcreate"; "VG"; "/dev/sda1"];
6758 ["lvcreate"; "LV"; "VG"; "8"];
6759 ["mkfs"; "ext2"; "/dev/VG/LV"];
6760 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
6762 pr " /* InitISOFS for %s */\n" test_name;
6763 List.iter (generate_test_command_call test_name)
6764 [["blockdev_setrw"; "/dev/sda"];
6767 ["mount_ro"; "/dev/sdd"; "/"]]
6770 let get_seq_last = function
6772 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6775 let seq = List.rev seq in
6776 List.rev (List.tl seq), List.hd seq
6781 pr " /* TestRun for %s (%d) */\n" name i;
6782 List.iter (generate_test_command_call test_name) seq
6783 | TestOutput (seq, expected) ->
6784 pr " /* TestOutput for %s (%d) */\n" name i;
6785 pr " const char *expected = \"%s\";\n" (c_quote expected);
6786 let seq, last = get_seq_last seq in
6788 pr " if (STRNEQ (r, expected)) {\n";
6789 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6793 List.iter (generate_test_command_call test_name) seq;
6794 generate_test_command_call ~test test_name last
6795 | TestOutputList (seq, expected) ->
6796 pr " /* TestOutputList for %s (%d) */\n" name i;
6797 let seq, last = get_seq_last seq in
6801 pr " if (!r[%d]) {\n" i;
6802 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6803 pr " print_strings (r);\n";
6807 pr " const char *expected = \"%s\";\n" (c_quote str);
6808 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6809 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6814 pr " if (r[%d] != NULL) {\n" (List.length expected);
6815 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6817 pr " print_strings (r);\n";
6821 List.iter (generate_test_command_call test_name) seq;
6822 generate_test_command_call ~test test_name last
6823 | TestOutputListOfDevices (seq, expected) ->
6824 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6825 let seq, last = get_seq_last seq in
6829 pr " if (!r[%d]) {\n" i;
6830 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6831 pr " print_strings (r);\n";
6835 pr " const char *expected = \"%s\";\n" (c_quote str);
6836 pr " r[%d][5] = 's';\n" i;
6837 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6838 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6843 pr " if (r[%d] != NULL) {\n" (List.length expected);
6844 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6846 pr " print_strings (r);\n";
6850 List.iter (generate_test_command_call test_name) seq;
6851 generate_test_command_call ~test test_name last
6852 | TestOutputInt (seq, expected) ->
6853 pr " /* TestOutputInt for %s (%d) */\n" name i;
6854 let seq, last = get_seq_last seq in
6856 pr " if (r != %d) {\n" expected;
6857 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6863 List.iter (generate_test_command_call test_name) seq;
6864 generate_test_command_call ~test test_name last
6865 | TestOutputIntOp (seq, op, expected) ->
6866 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6867 let seq, last = get_seq_last seq in
6869 pr " if (! (r %s %d)) {\n" op expected;
6870 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6871 test_name op expected;
6876 List.iter (generate_test_command_call test_name) seq;
6877 generate_test_command_call ~test test_name last
6878 | TestOutputTrue seq ->
6879 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6880 let seq, last = get_seq_last seq in
6883 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6888 List.iter (generate_test_command_call test_name) seq;
6889 generate_test_command_call ~test test_name last
6890 | TestOutputFalse seq ->
6891 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6892 let seq, last = get_seq_last seq in
6895 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6900 List.iter (generate_test_command_call test_name) seq;
6901 generate_test_command_call ~test test_name last
6902 | TestOutputLength (seq, expected) ->
6903 pr " /* TestOutputLength for %s (%d) */\n" name i;
6904 let seq, last = get_seq_last seq in
6907 pr " for (j = 0; j < %d; ++j)\n" expected;
6908 pr " if (r[j] == NULL) {\n";
6909 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6911 pr " print_strings (r);\n";
6914 pr " if (r[j] != NULL) {\n";
6915 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6917 pr " print_strings (r);\n";
6921 List.iter (generate_test_command_call test_name) seq;
6922 generate_test_command_call ~test test_name last
6923 | TestOutputBuffer (seq, expected) ->
6924 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6925 pr " const char *expected = \"%s\";\n" (c_quote expected);
6926 let seq, last = get_seq_last seq in
6927 let len = String.length expected in
6929 pr " if (size != %d) {\n" len;
6930 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6933 pr " if (STRNEQLEN (r, expected, size)) {\n";
6934 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6938 List.iter (generate_test_command_call test_name) seq;
6939 generate_test_command_call ~test test_name last
6940 | TestOutputStruct (seq, checks) ->
6941 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6942 let seq, last = get_seq_last seq in
6946 | CompareWithInt (field, expected) ->
6947 pr " if (r->%s != %d) {\n" field expected;
6948 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6949 test_name field expected;
6950 pr " (int) r->%s);\n" field;
6953 | CompareWithIntOp (field, op, expected) ->
6954 pr " if (!(r->%s %s %d)) {\n" field op expected;
6955 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
6956 test_name field op expected;
6957 pr " (int) r->%s);\n" field;
6960 | CompareWithString (field, expected) ->
6961 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
6962 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
6963 test_name field expected;
6964 pr " r->%s);\n" field;
6967 | CompareFieldsIntEq (field1, field2) ->
6968 pr " if (r->%s != r->%s) {\n" field1 field2;
6969 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
6970 test_name field1 field2;
6971 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
6974 | CompareFieldsStrEq (field1, field2) ->
6975 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
6976 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
6977 test_name field1 field2;
6978 pr " r->%s, r->%s);\n" field1 field2;
6983 List.iter (generate_test_command_call test_name) seq;
6984 generate_test_command_call ~test test_name last
6985 | TestLastFail seq ->
6986 pr " /* TestLastFail for %s (%d) */\n" name i;
6987 let seq, last = get_seq_last seq in
6988 List.iter (generate_test_command_call test_name) seq;
6989 generate_test_command_call test_name ~expect_error:true last
6991 (* Generate the code to run a command, leaving the result in 'r'.
6992 * If you expect to get an error then you should set expect_error:true.
6994 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
6996 | [] -> assert false
6998 (* Look up the command to find out what args/ret it has. *)
7001 let _, style, _, _, _, _, _ =
7002 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7005 failwithf "%s: in test, command %s was not found" test_name name in
7007 if List.length (snd style) <> List.length args then
7008 failwithf "%s: in test, wrong number of args given to %s"
7015 | OptString n, "NULL" -> ()
7018 | Dev_or_Path n, arg
7020 | OptString n, arg ->
7021 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7025 | FileIn _, _ | FileOut _, _ -> ()
7026 | StringList n, "" | DeviceList n, "" ->
7027 pr " const char *const %s[1] = { NULL };\n" n
7028 | StringList n, arg | DeviceList n, arg ->
7029 let strs = string_split " " arg in
7032 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7034 pr " const char *const %s[] = {\n" n;
7036 fun i _ -> pr " %s_%d,\n" n i
7040 ) (List.combine (snd style) args);
7043 match fst style with
7044 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7045 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7046 | RConstString _ | RConstOptString _ ->
7047 pr " const char *r;\n"; "NULL"
7048 | RString _ -> pr " char *r;\n"; "NULL"
7049 | RStringList _ | RHashtable _ ->
7053 | RStruct (_, typ) ->
7054 pr " struct guestfs_%s *r;\n" typ; "NULL"
7055 | RStructList (_, typ) ->
7056 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7059 pr " size_t size;\n";
7062 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7063 pr " r = guestfs_%s (g" name;
7065 (* Generate the parameters. *)
7068 | OptString _, "NULL" -> pr ", NULL"
7070 | Device n, _ | Dev_or_Path n, _
7074 | FileIn _, arg | FileOut _, arg ->
7075 pr ", \"%s\"" (c_quote arg)
7076 | StringList n, _ | DeviceList n, _ ->
7077 pr ", (char **) %s" n
7080 try int_of_string arg
7081 with Failure "int_of_string" ->
7082 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7086 try Int64.of_string arg
7087 with Failure "int_of_string" ->
7088 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7091 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7092 ) (List.combine (snd style) args);
7094 (match fst style with
7095 | RBufferOut _ -> pr ", &size"
7101 if not expect_error then
7102 pr " if (r == %s)\n" error_code
7104 pr " if (r != %s)\n" error_code;
7107 (* Insert the test code. *)
7113 (match fst style with
7114 | RErr | RInt _ | RInt64 _ | RBool _
7115 | RConstString _ | RConstOptString _ -> ()
7116 | RString _ | RBufferOut _ -> pr " free (r);\n"
7117 | RStringList _ | RHashtable _ ->
7118 pr " for (i = 0; r[i] != NULL; ++i)\n";
7119 pr " free (r[i]);\n";
7121 | RStruct (_, typ) ->
7122 pr " guestfs_free_%s (r);\n" typ
7123 | RStructList (_, typ) ->
7124 pr " guestfs_free_%s_list (r);\n" typ
7130 let str = replace_str str "\r" "\\r" in
7131 let str = replace_str str "\n" "\\n" in
7132 let str = replace_str str "\t" "\\t" in
7133 let str = replace_str str "\000" "\\0" in
7136 (* Generate a lot of different functions for guestfish. *)
7137 and generate_fish_cmds () =
7138 generate_header CStyle GPLv2plus;
7142 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7144 let all_functions_sorted =
7146 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7147 ) all_functions_sorted in
7149 pr "#include <config.h>\n";
7151 pr "#include <stdio.h>\n";
7152 pr "#include <stdlib.h>\n";
7153 pr "#include <string.h>\n";
7154 pr "#include <inttypes.h>\n";
7156 pr "#include <guestfs.h>\n";
7157 pr "#include \"c-ctype.h\"\n";
7158 pr "#include \"full-write.h\"\n";
7159 pr "#include \"xstrtol.h\"\n";
7160 pr "#include \"fish.h\"\n";
7163 (* list_commands function, which implements guestfish -h *)
7164 pr "void list_commands (void)\n";
7166 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7167 pr " list_builtin_commands ();\n";
7169 fun (name, _, _, flags, _, shortdesc, _) ->
7170 let name = replace_char name '_' '-' in
7171 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7173 ) all_functions_sorted;
7174 pr " printf (\" %%s\\n\",";
7175 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7179 (* display_command function, which implements guestfish -h cmd *)
7180 pr "void display_command (const char *cmd)\n";
7183 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7184 let name2 = replace_char name '_' '-' in
7186 try find_map (function FishAlias n -> Some n | _ -> None) flags
7187 with Not_found -> name in
7188 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7190 match snd style with
7194 name2 (String.concat " " (List.map name_of_argt args)) in
7197 if List.mem ProtocolLimitWarning flags then
7198 ("\n\n" ^ protocol_limit_warning)
7201 (* For DangerWillRobinson commands, we should probably have
7202 * guestfish prompt before allowing you to use them (especially
7203 * in interactive mode). XXX
7207 if List.mem DangerWillRobinson flags then
7208 ("\n\n" ^ danger_will_robinson)
7213 match deprecation_notice flags with
7215 | Some txt -> "\n\n" ^ txt in
7217 let describe_alias =
7218 if name <> alias then
7219 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7223 pr "STRCASEEQ (cmd, \"%s\")" name;
7224 if name <> name2 then
7225 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7226 if name <> alias then
7227 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7229 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7231 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7232 "=head1 DESCRIPTION\n\n" ^
7233 longdesc ^ warnings ^ describe_alias);
7236 pr " display_builtin_command (cmd);\n";
7240 let emit_print_list_function typ =
7241 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7244 pr " unsigned int i;\n";
7246 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7247 pr " printf (\"[%%d] = {\\n\", i);\n";
7248 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7249 pr " printf (\"}\\n\");\n";
7255 (* print_* functions *)
7259 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7261 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7264 pr " unsigned int i;\n";
7270 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7272 pr " printf (\"%%s%s: \", indent);\n" name;
7273 pr " for (i = 0; i < 32; ++i)\n";
7274 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7275 pr " printf (\"\\n\");\n"
7277 pr " printf (\"%%s%s: \", indent);\n" name;
7278 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7279 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7280 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7282 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7283 pr " printf (\"\\n\");\n"
7284 | name, (FUInt64|FBytes) ->
7285 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7288 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7291 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7294 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7297 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7299 | name, FOptPercent ->
7300 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7301 typ name name typ name;
7302 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7308 (* Emit a print_TYPE_list function definition only if that function is used. *)
7311 | typ, (RStructListOnly | RStructAndList) ->
7312 (* generate the function for typ *)
7313 emit_print_list_function typ
7314 | typ, _ -> () (* empty *)
7315 ) (rstructs_used_by all_functions);
7317 (* Emit a print_TYPE function definition only if that function is used. *)
7320 | typ, (RStructOnly | RStructAndList) ->
7321 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7323 pr " print_%s_indent (%s, \"\");\n" typ typ;
7326 | typ, _ -> () (* empty *)
7327 ) (rstructs_used_by all_functions);
7329 (* run_<action> actions *)
7331 fun (name, style, _, flags, _, _, _) ->
7332 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7334 (match fst style with
7337 | RBool _ -> pr " int r;\n"
7338 | RInt64 _ -> pr " int64_t r;\n"
7339 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7340 | RString _ -> pr " char *r;\n"
7341 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7342 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7343 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7346 pr " size_t size;\n";
7354 | FileOut n -> pr " const char *%s;\n" n
7356 | Dev_or_Path n -> pr " char *%s;\n" n
7357 | StringList n | DeviceList n -> pr " char **%s;\n" n
7358 | Bool n -> pr " int %s;\n" n
7359 | Int n -> pr " int %s;\n" n
7360 | Int64 n -> pr " int64_t %s;\n" n
7363 (* Check and convert parameters. *)
7364 let argc_expected = List.length (snd style) in
7365 pr " if (argc != %d) {\n" argc_expected;
7366 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7368 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7372 let parse_integer fn fntyp rtyp range name i =
7374 pr " strtol_error xerr;\n";
7375 pr " %s r;\n" fntyp;
7377 pr " xerr = %s (argv[%d], NULL, 0, &r, \"\");\n" fn i;
7378 pr " if (xerr != LONGINT_OK) {\n";
7379 pr " fprintf (stderr,\n";
7380 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7381 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7386 | Some (min, max, comment) ->
7387 pr " /* %s */\n" comment;
7388 pr " if (r < %s || r > %s) {\n" min max;
7389 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7393 pr " /* The check above should ensure this assignment does not overflow. */\n";
7395 pr " %s = r;\n" name;
7404 pr " %s = argv[%d];\n" name i
7406 | Dev_or_Path name ->
7407 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7408 pr " if (%s == NULL) return -1;\n" name
7410 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7413 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7416 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7418 | StringList name | DeviceList name ->
7419 pr " %s = parse_string_list (argv[%d]);\n" name i;
7420 pr " if (%s == NULL) return -1;\n" name;
7422 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7425 let min = "(-(2LL<<30))"
7426 and max = "((2LL<<30)-1)"
7428 "The Int type in the generator is a signed 31 bit int." in
7429 Some (min, max, comment) in
7430 parse_integer "xstrtoll" "long long" "int" range name i
7432 parse_integer "xstrtoll" "long long" "int64_t" None name i
7435 (* Call C API function. *)
7437 try find_map (function FishAction n -> Some n | _ -> None) flags
7438 with Not_found -> sprintf "guestfs_%s" name in
7440 generate_c_call_args ~handle:"g" style;
7445 | Device name | String name
7446 | OptString name | FileIn name | FileOut name | Bool name
7447 | Int name | Int64 name -> ()
7448 | Pathname name | Dev_or_Path name ->
7449 pr " free (%s);\n" name
7450 | StringList name | DeviceList name ->
7451 pr " free_strings (%s);\n" name
7454 (* Check return value for errors and display command results. *)
7455 (match fst style with
7456 | RErr -> pr " return r;\n"
7458 pr " if (r == -1) return -1;\n";
7459 pr " printf (\"%%d\\n\", r);\n";
7462 pr " if (r == -1) return -1;\n";
7463 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7466 pr " if (r == -1) return -1;\n";
7467 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7470 pr " if (r == NULL) return -1;\n";
7471 pr " printf (\"%%s\\n\", r);\n";
7473 | RConstOptString _ ->
7474 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7477 pr " if (r == NULL) return -1;\n";
7478 pr " printf (\"%%s\\n\", r);\n";
7482 pr " if (r == NULL) return -1;\n";
7483 pr " print_strings (r);\n";
7484 pr " free_strings (r);\n";
7486 | RStruct (_, typ) ->
7487 pr " if (r == NULL) return -1;\n";
7488 pr " print_%s (r);\n" typ;
7489 pr " guestfs_free_%s (r);\n" typ;
7491 | RStructList (_, typ) ->
7492 pr " if (r == NULL) return -1;\n";
7493 pr " print_%s_list (r);\n" typ;
7494 pr " guestfs_free_%s_list (r);\n" typ;
7497 pr " if (r == NULL) return -1;\n";
7498 pr " print_table (r);\n";
7499 pr " free_strings (r);\n";
7502 pr " if (r == NULL) return -1;\n";
7503 pr " if (full_write (1, r, size) != size) {\n";
7504 pr " perror (\"write\");\n";
7515 (* run_action function *)
7516 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7519 fun (name, _, _, flags, _, _, _) ->
7520 let name2 = replace_char name '_' '-' in
7522 try find_map (function FishAlias n -> Some n | _ -> None) flags
7523 with Not_found -> name in
7525 pr "STRCASEEQ (cmd, \"%s\")" name;
7526 if name <> name2 then
7527 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7528 if name <> alias then
7529 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7531 pr " return run_%s (cmd, argc, argv);\n" name;
7535 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7536 pr " if (command_num == 1)\n";
7537 pr " extended_help_message ();\n";
7544 (* Readline completion for guestfish. *)
7545 and generate_fish_completion () =
7546 generate_header CStyle GPLv2plus;
7550 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7560 #ifdef HAVE_LIBREADLINE
7561 #include <readline/readline.h>
7566 #ifdef HAVE_LIBREADLINE
7568 static const char *const commands[] = {
7569 BUILTIN_COMMANDS_FOR_COMPLETION,
7572 (* Get the commands, including the aliases. They don't need to be
7573 * sorted - the generator() function just does a dumb linear search.
7577 fun (name, _, _, flags, _, _, _) ->
7578 let name2 = replace_char name '_' '-' in
7580 try find_map (function FishAlias n -> Some n | _ -> None) flags
7581 with Not_found -> name in
7583 if name <> alias then [name2; alias] else [name2]
7585 let commands = List.flatten commands in
7587 List.iter (pr " \"%s\",\n") commands;
7593 generator (const char *text, int state)
7595 static int index, len;
7600 len = strlen (text);
7603 rl_attempted_completion_over = 1;
7605 while ((name = commands[index]) != NULL) {
7607 if (STRCASEEQLEN (name, text, len))
7608 return strdup (name);
7614 #endif /* HAVE_LIBREADLINE */
7616 #ifdef HAVE_RL_COMPLETION_MATCHES
7617 #define RL_COMPLETION_MATCHES rl_completion_matches
7619 #ifdef HAVE_COMPLETION_MATCHES
7620 #define RL_COMPLETION_MATCHES completion_matches
7622 #endif /* else just fail if we don't have either symbol */
7625 do_completion (const char *text, int start, int end)
7627 char **matches = NULL;
7629 #ifdef HAVE_LIBREADLINE
7630 rl_completion_append_character = ' ';
7633 matches = RL_COMPLETION_MATCHES (text, generator);
7634 else if (complete_dest_paths)
7635 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7642 (* Generate the POD documentation for guestfish. *)
7643 and generate_fish_actions_pod () =
7644 let all_functions_sorted =
7646 fun (_, _, _, flags, _, _, _) ->
7647 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7648 ) all_functions_sorted in
7650 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7653 fun (name, style, _, flags, _, _, longdesc) ->
7655 Str.global_substitute rex (
7658 try Str.matched_group 1 s
7660 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7661 "C<" ^ replace_char sub '_' '-' ^ ">"
7663 let name = replace_char name '_' '-' in
7665 try find_map (function FishAlias n -> Some n | _ -> None) flags
7666 with Not_found -> name in
7668 pr "=head2 %s" name;
7669 if name <> alias then
7676 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7677 | OptString n -> pr " %s" n
7678 | StringList n | DeviceList n -> pr " '%s ...'" n
7679 | Bool _ -> pr " true|false"
7680 | Int n -> pr " %s" n
7681 | Int64 n -> pr " %s" n
7682 | FileIn n | FileOut n -> pr " (%s|-)" n
7686 pr "%s\n\n" longdesc;
7688 if List.exists (function FileIn _ | FileOut _ -> true
7689 | _ -> false) (snd style) then
7690 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7692 if List.mem ProtocolLimitWarning flags then
7693 pr "%s\n\n" protocol_limit_warning;
7695 if List.mem DangerWillRobinson flags then
7696 pr "%s\n\n" danger_will_robinson;
7698 match deprecation_notice flags with
7700 | Some txt -> pr "%s\n\n" txt
7701 ) all_functions_sorted
7703 (* Generate a C function prototype. *)
7704 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7705 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7707 ?handle name style =
7708 if extern then pr "extern ";
7709 if static then pr "static ";
7710 (match fst style with
7712 | RInt _ -> pr "int "
7713 | RInt64 _ -> pr "int64_t "
7714 | RBool _ -> pr "int "
7715 | RConstString _ | RConstOptString _ -> pr "const char *"
7716 | RString _ | RBufferOut _ -> pr "char *"
7717 | RStringList _ | RHashtable _ -> pr "char **"
7718 | RStruct (_, typ) ->
7719 if not in_daemon then pr "struct guestfs_%s *" typ
7720 else pr "guestfs_int_%s *" typ
7721 | RStructList (_, typ) ->
7722 if not in_daemon then pr "struct guestfs_%s_list *" typ
7723 else pr "guestfs_int_%s_list *" typ
7725 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7726 pr "%s%s (" prefix name;
7727 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7730 let comma = ref false in
7733 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7737 if single_line then pr ", " else pr ",\n\t\t"
7744 | Device n | Dev_or_Path n
7748 pr "const char *%s" n
7749 | StringList n | DeviceList n ->
7751 pr "char *const *%s" n
7752 | Bool n -> next (); pr "int %s" n
7753 | Int n -> next (); pr "int %s" n
7754 | Int64 n -> next (); pr "int64_t %s" n
7757 if not in_daemon then (next (); pr "const char *%s" n)
7759 if is_RBufferOut then (next (); pr "size_t *size_r");
7762 if semicolon then pr ";";
7763 if newline then pr "\n"
7765 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7766 and generate_c_call_args ?handle ?(decl = false) style =
7768 let comma = ref false in
7770 if !comma then pr ", ";
7775 | Some handle -> pr "%s" handle; comma := true
7780 pr "%s" (name_of_argt arg)
7782 (* For RBufferOut calls, add implicit &size parameter. *)
7784 match fst style with
7792 (* Generate the OCaml bindings interface. *)
7793 and generate_ocaml_mli () =
7794 generate_header OCamlStyle LGPLv2plus;
7797 (** For API documentation you should refer to the C API
7798 in the guestfs(3) manual page. The OCaml API uses almost
7799 exactly the same calls. *)
7802 (** A [guestfs_h] handle. *)
7804 exception Error of string
7805 (** This exception is raised when there is an error. *)
7807 exception Handle_closed of string
7808 (** This exception is raised if you use a {!Guestfs.t} handle
7809 after calling {!close} on it. The string is the name of
7812 val create : unit -> t
7813 (** Create a {!Guestfs.t} handle. *)
7815 val close : t -> unit
7816 (** Close the {!Guestfs.t} handle and free up all resources used
7819 Handles are closed by the garbage collector when they become
7820 unreferenced, but callers can call this in order to provide
7821 predictable cleanup. *)
7824 generate_ocaml_structure_decls ();
7828 fun (name, style, _, _, _, shortdesc, _) ->
7829 generate_ocaml_prototype name style;
7830 pr "(** %s *)\n" shortdesc;
7832 ) all_functions_sorted
7834 (* Generate the OCaml bindings implementation. *)
7835 and generate_ocaml_ml () =
7836 generate_header OCamlStyle LGPLv2plus;
7841 exception Error of string
7842 exception Handle_closed of string
7844 external create : unit -> t = \"ocaml_guestfs_create\"
7845 external close : t -> unit = \"ocaml_guestfs_close\"
7847 (* Give the exceptions names, so they can be raised from the C code. *)
7849 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7850 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7854 generate_ocaml_structure_decls ();
7858 fun (name, style, _, _, _, shortdesc, _) ->
7859 generate_ocaml_prototype ~is_external:true name style;
7860 ) all_functions_sorted
7862 (* Generate the OCaml bindings C implementation. *)
7863 and generate_ocaml_c () =
7864 generate_header CStyle LGPLv2plus;
7871 #include <caml/config.h>
7872 #include <caml/alloc.h>
7873 #include <caml/callback.h>
7874 #include <caml/fail.h>
7875 #include <caml/memory.h>
7876 #include <caml/mlvalues.h>
7877 #include <caml/signals.h>
7879 #include <guestfs.h>
7881 #include \"guestfs_c.h\"
7883 /* Copy a hashtable of string pairs into an assoc-list. We return
7884 * the list in reverse order, but hashtables aren't supposed to be
7887 static CAMLprim value
7888 copy_table (char * const * argv)
7891 CAMLlocal5 (rv, pairv, kv, vv, cons);
7895 for (i = 0; argv[i] != NULL; i += 2) {
7896 kv = caml_copy_string (argv[i]);
7897 vv = caml_copy_string (argv[i+1]);
7898 pairv = caml_alloc (2, 0);
7899 Store_field (pairv, 0, kv);
7900 Store_field (pairv, 1, vv);
7901 cons = caml_alloc (2, 0);
7902 Store_field (cons, 1, rv);
7904 Store_field (cons, 0, pairv);
7912 (* Struct copy functions. *)
7914 let emit_ocaml_copy_list_function typ =
7915 pr "static CAMLprim value\n";
7916 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7918 pr " CAMLparam0 ();\n";
7919 pr " CAMLlocal2 (rv, v);\n";
7920 pr " unsigned int i;\n";
7922 pr " if (%ss->len == 0)\n" typ;
7923 pr " CAMLreturn (Atom (0));\n";
7925 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7926 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7927 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7928 pr " caml_modify (&Field (rv, i), v);\n";
7930 pr " CAMLreturn (rv);\n";
7938 let has_optpercent_col =
7939 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7941 pr "static CAMLprim value\n";
7942 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7944 pr " CAMLparam0 ();\n";
7945 if has_optpercent_col then
7946 pr " CAMLlocal3 (rv, v, v2);\n"
7948 pr " CAMLlocal2 (rv, v);\n";
7950 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
7955 pr " v = caml_copy_string (%s->%s);\n" typ name
7957 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
7958 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
7961 pr " v = caml_alloc_string (32);\n";
7962 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
7963 | name, (FBytes|FInt64|FUInt64) ->
7964 pr " v = caml_copy_int64 (%s->%s);\n" typ name
7965 | name, (FInt32|FUInt32) ->
7966 pr " v = caml_copy_int32 (%s->%s);\n" typ name
7967 | name, FOptPercent ->
7968 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
7969 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
7970 pr " v = caml_alloc (1, 0);\n";
7971 pr " Store_field (v, 0, v2);\n";
7972 pr " } else /* None */\n";
7973 pr " v = Val_int (0);\n";
7975 pr " v = Val_int (%s->%s);\n" typ name
7977 pr " Store_field (rv, %d, v);\n" i
7979 pr " CAMLreturn (rv);\n";
7984 (* Emit a copy_TYPE_list function definition only if that function is used. *)
7987 | typ, (RStructListOnly | RStructAndList) ->
7988 (* generate the function for typ *)
7989 emit_ocaml_copy_list_function typ
7990 | typ, _ -> () (* empty *)
7991 ) (rstructs_used_by all_functions);
7995 fun (name, style, _, _, _, _, _) ->
7996 pr "/* Automatically generated wrapper for function\n";
7998 generate_ocaml_prototype name style;
8003 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8005 let needs_extra_vs =
8006 match fst style with RConstOptString _ -> true | _ -> false in
8008 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8009 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8010 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8013 pr "CAMLprim value\n";
8014 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8015 List.iter (pr ", value %s") (List.tl params);
8020 | [p1; p2; p3; p4; p5] ->
8021 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8022 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8023 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8024 pr " CAMLxparam%d (%s);\n"
8025 (List.length rest) (String.concat ", " rest)
8027 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8029 if not needs_extra_vs then
8030 pr " CAMLlocal1 (rv);\n"
8032 pr " CAMLlocal3 (rv, v, v2);\n";
8035 pr " guestfs_h *g = Guestfs_val (gv);\n";
8036 pr " if (g == NULL)\n";
8037 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8043 | Device n | Dev_or_Path n
8047 pr " const char *%s = String_val (%sv);\n" n n
8049 pr " const char *%s =\n" n;
8050 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8052 | StringList n | DeviceList n ->
8053 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8055 pr " int %s = Bool_val (%sv);\n" n n
8057 pr " int %s = Int_val (%sv);\n" n n
8059 pr " int64_t %s = Int64_val (%sv);\n" n n
8062 match fst style with
8063 | RErr -> pr " int r;\n"; "-1"
8064 | RInt _ -> pr " int r;\n"; "-1"
8065 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8066 | RBool _ -> pr " int r;\n"; "-1"
8067 | RConstString _ | RConstOptString _ ->
8068 pr " const char *r;\n"; "NULL"
8069 | RString _ -> pr " char *r;\n"; "NULL"
8074 | RStruct (_, typ) ->
8075 pr " struct guestfs_%s *r;\n" typ; "NULL"
8076 | RStructList (_, typ) ->
8077 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8084 pr " size_t size;\n";
8088 pr " caml_enter_blocking_section ();\n";
8089 pr " r = guestfs_%s " name;
8090 generate_c_call_args ~handle:"g" style;
8092 pr " caml_leave_blocking_section ();\n";
8096 | StringList n | DeviceList n ->
8097 pr " ocaml_guestfs_free_strings (%s);\n" n;
8098 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8099 | Bool _ | Int _ | Int64 _
8100 | FileIn _ | FileOut _ -> ()
8103 pr " if (r == %s)\n" error_code;
8104 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8107 (match fst style with
8108 | RErr -> pr " rv = Val_unit;\n"
8109 | RInt _ -> pr " rv = Val_int (r);\n"
8111 pr " rv = caml_copy_int64 (r);\n"
8112 | RBool _ -> pr " rv = Val_bool (r);\n"
8114 pr " rv = caml_copy_string (r);\n"
8115 | RConstOptString _ ->
8116 pr " if (r) { /* Some string */\n";
8117 pr " v = caml_alloc (1, 0);\n";
8118 pr " v2 = caml_copy_string (r);\n";
8119 pr " Store_field (v, 0, v2);\n";
8120 pr " } else /* None */\n";
8121 pr " v = Val_int (0);\n";
8123 pr " rv = caml_copy_string (r);\n";
8126 pr " rv = caml_copy_string_array ((const char **) r);\n";
8127 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8129 | RStruct (_, typ) ->
8130 pr " rv = copy_%s (r);\n" typ;
8131 pr " guestfs_free_%s (r);\n" typ;
8132 | RStructList (_, typ) ->
8133 pr " rv = copy_%s_list (r);\n" typ;
8134 pr " guestfs_free_%s_list (r);\n" typ;
8136 pr " rv = copy_table (r);\n";
8137 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8140 pr " rv = caml_alloc_string (size);\n";
8141 pr " memcpy (String_val (rv), r, size);\n";
8144 pr " CAMLreturn (rv);\n";
8148 if List.length params > 5 then (
8149 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8150 pr "CAMLprim value ";
8151 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8152 pr "CAMLprim value\n";
8153 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8155 pr " return ocaml_guestfs_%s (argv[0]" name;
8156 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8161 ) all_functions_sorted
8163 and generate_ocaml_structure_decls () =
8166 pr "type %s = {\n" typ;
8169 | name, FString -> pr " %s : string;\n" name
8170 | name, FBuffer -> pr " %s : string;\n" name
8171 | name, FUUID -> pr " %s : string;\n" name
8172 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8173 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8174 | name, FChar -> pr " %s : char;\n" name
8175 | name, FOptPercent -> pr " %s : float option;\n" name
8181 and generate_ocaml_prototype ?(is_external = false) name style =
8182 if is_external then pr "external " else pr "val ";
8183 pr "%s : t -> " name;
8186 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
8187 | OptString _ -> pr "string option -> "
8188 | StringList _ | DeviceList _ -> pr "string array -> "
8189 | Bool _ -> pr "bool -> "
8190 | Int _ -> pr "int -> "
8191 | Int64 _ -> pr "int64 -> "
8193 (match fst style with
8194 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8195 | RInt _ -> pr "int"
8196 | RInt64 _ -> pr "int64"
8197 | RBool _ -> pr "bool"
8198 | RConstString _ -> pr "string"
8199 | RConstOptString _ -> pr "string option"
8200 | RString _ | RBufferOut _ -> pr "string"
8201 | RStringList _ -> pr "string array"
8202 | RStruct (_, typ) -> pr "%s" typ
8203 | RStructList (_, typ) -> pr "%s array" typ
8204 | RHashtable _ -> pr "(string * string) list"
8206 if is_external then (
8208 if List.length (snd style) + 1 > 5 then
8209 pr "\"ocaml_guestfs_%s_byte\" " name;
8210 pr "\"ocaml_guestfs_%s\"" name
8214 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8215 and generate_perl_xs () =
8216 generate_header CStyle LGPLv2plus;
8219 #include \"EXTERN.h\"
8223 #include <guestfs.h>
8226 #define PRId64 \"lld\"
8230 my_newSVll(long long val) {
8231 #ifdef USE_64_BIT_ALL
8232 return newSViv(val);
8236 len = snprintf(buf, 100, \"%%\" PRId64, val);
8237 return newSVpv(buf, len);
8242 #define PRIu64 \"llu\"
8246 my_newSVull(unsigned long long val) {
8247 #ifdef USE_64_BIT_ALL
8248 return newSVuv(val);
8252 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8253 return newSVpv(buf, len);
8257 /* http://www.perlmonks.org/?node_id=680842 */
8259 XS_unpack_charPtrPtr (SV *arg) {
8264 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8265 croak (\"array reference expected\");
8267 av = (AV *)SvRV (arg);
8268 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8270 croak (\"malloc failed\");
8272 for (i = 0; i <= av_len (av); i++) {
8273 SV **elem = av_fetch (av, i, 0);
8275 if (!elem || !*elem)
8276 croak (\"missing element in list\");
8278 ret[i] = SvPV_nolen (*elem);
8286 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8293 RETVAL = guestfs_create ();
8295 croak (\"could not create guestfs handle\");
8296 guestfs_set_error_handler (RETVAL, NULL, NULL);
8309 fun (name, style, _, _, _, _, _) ->
8310 (match fst style with
8311 | RErr -> pr "void\n"
8312 | RInt _ -> pr "SV *\n"
8313 | RInt64 _ -> pr "SV *\n"
8314 | RBool _ -> pr "SV *\n"
8315 | RConstString _ -> pr "SV *\n"
8316 | RConstOptString _ -> pr "SV *\n"
8317 | RString _ -> pr "SV *\n"
8318 | RBufferOut _ -> pr "SV *\n"
8320 | RStruct _ | RStructList _
8322 pr "void\n" (* all lists returned implictly on the stack *)
8324 (* Call and arguments. *)
8326 generate_c_call_args ~handle:"g" ~decl:true style;
8328 pr " guestfs_h *g;\n";
8332 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8335 (* http://www.perlmonks.org/?node_id=554277
8336 * Note that the implicit handle argument means we have
8337 * to add 1 to the ST(x) operator.
8339 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8340 | StringList n | DeviceList n -> pr " char **%s;\n" n
8341 | Bool n -> pr " int %s;\n" n
8342 | Int n -> pr " int %s;\n" n
8343 | Int64 n -> pr " int64_t %s;\n" n
8346 let do_cleanups () =
8349 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8350 | Bool _ | Int _ | Int64 _
8351 | FileIn _ | FileOut _ -> ()
8352 | StringList n | DeviceList n -> pr " free (%s);\n" n
8357 (match fst style with
8362 pr " r = guestfs_%s " name;
8363 generate_c_call_args ~handle:"g" style;
8366 pr " if (r == -1)\n";
8367 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8373 pr " %s = guestfs_%s " n name;
8374 generate_c_call_args ~handle:"g" style;
8377 pr " if (%s == -1)\n" n;
8378 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8379 pr " RETVAL = newSViv (%s);\n" n;
8384 pr " int64_t %s;\n" n;
8386 pr " %s = guestfs_%s " n name;
8387 generate_c_call_args ~handle:"g" style;
8390 pr " if (%s == -1)\n" n;
8391 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8392 pr " RETVAL = my_newSVll (%s);\n" n;
8397 pr " const char *%s;\n" n;
8399 pr " %s = guestfs_%s " n name;
8400 generate_c_call_args ~handle:"g" style;
8403 pr " if (%s == NULL)\n" n;
8404 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8405 pr " RETVAL = newSVpv (%s, 0);\n" n;
8408 | RConstOptString n ->
8410 pr " const char *%s;\n" n;
8412 pr " %s = guestfs_%s " n name;
8413 generate_c_call_args ~handle:"g" style;
8416 pr " if (%s == NULL)\n" n;
8417 pr " RETVAL = &PL_sv_undef;\n";
8419 pr " RETVAL = newSVpv (%s, 0);\n" n;
8424 pr " char *%s;\n" n;
8426 pr " %s = guestfs_%s " n name;
8427 generate_c_call_args ~handle:"g" style;
8430 pr " if (%s == NULL)\n" n;
8431 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8432 pr " RETVAL = newSVpv (%s, 0);\n" n;
8433 pr " free (%s);\n" n;
8436 | RStringList n | RHashtable n ->
8438 pr " char **%s;\n" n;
8441 pr " %s = guestfs_%s " n name;
8442 generate_c_call_args ~handle:"g" style;
8445 pr " if (%s == NULL)\n" n;
8446 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8447 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8448 pr " EXTEND (SP, n);\n";
8449 pr " for (i = 0; i < n; ++i) {\n";
8450 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8451 pr " free (%s[i]);\n" n;
8453 pr " free (%s);\n" n;
8454 | RStruct (n, typ) ->
8455 let cols = cols_of_struct typ in
8456 generate_perl_struct_code typ cols name style n do_cleanups
8457 | RStructList (n, typ) ->
8458 let cols = cols_of_struct typ in
8459 generate_perl_struct_list_code typ cols name style n do_cleanups
8462 pr " char *%s;\n" n;
8463 pr " size_t size;\n";
8465 pr " %s = guestfs_%s " n name;
8466 generate_c_call_args ~handle:"g" style;
8469 pr " if (%s == NULL)\n" n;
8470 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8471 pr " RETVAL = newSVpvn (%s, size);\n" n;
8472 pr " free (%s);\n" n;
8480 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8482 pr " struct guestfs_%s_list *%s;\n" typ n;
8486 pr " %s = guestfs_%s " n name;
8487 generate_c_call_args ~handle:"g" style;
8490 pr " if (%s == NULL)\n" n;
8491 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8492 pr " EXTEND (SP, %s->len);\n" n;
8493 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8494 pr " hv = newHV ();\n";
8498 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8499 name (String.length name) n name
8501 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8502 name (String.length name) n name
8504 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8505 name (String.length name) n name n name
8506 | name, (FBytes|FUInt64) ->
8507 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8508 name (String.length name) n name
8510 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8511 name (String.length name) n name
8512 | name, (FInt32|FUInt32) ->
8513 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8514 name (String.length name) n name
8516 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8517 name (String.length name) n name
8518 | name, FOptPercent ->
8519 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8520 name (String.length name) n name
8522 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8524 pr " guestfs_free_%s_list (%s);\n" typ n
8526 and generate_perl_struct_code typ cols name style n do_cleanups =
8528 pr " struct guestfs_%s *%s;\n" typ n;
8530 pr " %s = guestfs_%s " n name;
8531 generate_c_call_args ~handle:"g" style;
8534 pr " if (%s == NULL)\n" n;
8535 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8536 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8538 fun ((name, _) as col) ->
8539 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8543 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8546 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8549 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8551 | name, (FBytes|FUInt64) ->
8552 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8555 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8557 | name, (FInt32|FUInt32) ->
8558 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8561 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8563 | name, FOptPercent ->
8564 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8567 pr " free (%s);\n" n
8569 (* Generate Sys/Guestfs.pm. *)
8570 and generate_perl_pm () =
8571 generate_header HashStyle LGPLv2plus;
8578 Sys::Guestfs - Perl bindings for libguestfs
8584 my $h = Sys::Guestfs->new ();
8585 $h->add_drive ('guest.img');
8587 $h->mount ('/dev/sda1', '/');
8588 $h->touch ('/hello');
8593 The C<Sys::Guestfs> module provides a Perl XS binding to the
8594 libguestfs API for examining and modifying virtual machine
8597 Amongst the things this is good for: making batch configuration
8598 changes to guests, getting disk used/free statistics (see also:
8599 virt-df), migrating between virtualization systems (see also:
8600 virt-p2v), performing partial backups, performing partial guest
8601 clones, cloning guests and changing registry/UUID/hostname info, and
8604 Libguestfs uses Linux kernel and qemu code, and can access any type of
8605 guest filesystem that Linux and qemu can, including but not limited
8606 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8607 schemes, qcow, qcow2, vmdk.
8609 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8610 LVs, what filesystem is in each LV, etc.). It can also run commands
8611 in the context of the guest. Also you can access filesystems over
8614 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8615 functions for using libguestfs from Perl, including integration
8620 All errors turn into calls to C<croak> (see L<Carp(3)>).
8628 package Sys::Guestfs;
8634 XSLoader::load ('Sys::Guestfs');
8636 =item $h = Sys::Guestfs->new ();
8638 Create a new guestfs handle.
8644 my $class = ref ($proto) || $proto;
8646 my $self = Sys::Guestfs::_create ();
8647 bless $self, $class;
8653 (* Actions. We only need to print documentation for these as
8654 * they are pulled in from the XS code automatically.
8657 fun (name, style, _, flags, _, _, longdesc) ->
8658 if not (List.mem NotInDocs flags) then (
8659 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8661 generate_perl_prototype name style;
8663 pr "%s\n\n" longdesc;
8664 if List.mem ProtocolLimitWarning flags then
8665 pr "%s\n\n" protocol_limit_warning;
8666 if List.mem DangerWillRobinson flags then
8667 pr "%s\n\n" danger_will_robinson;
8668 match deprecation_notice flags with
8670 | Some txt -> pr "%s\n\n" txt
8672 ) all_functions_sorted;
8684 Copyright (C) %s Red Hat Inc.
8688 Please see the file COPYING.LIB for the full license.
8694 L<http://libguestfs.org>,
8695 L<Sys::Guestfs::Lib(3)>.
8700 and generate_perl_prototype name style =
8701 (match fst style with
8709 | RBufferOut n -> pr "$%s = " n
8711 | RHashtable n -> pr "%%%s = " n
8713 | RStructList (n,_) -> pr "@%s = " n
8716 let comma = ref false in
8719 if !comma then pr ", ";
8722 | Pathname n | Device n | Dev_or_Path n | String n
8723 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8725 | StringList n | DeviceList n ->
8730 (* Generate Python C module. *)
8731 and generate_python_c () =
8732 generate_header CStyle LGPLv2plus;
8741 #include \"guestfs.h\"
8749 get_handle (PyObject *obj)
8752 assert (obj != Py_None);
8753 return ((Pyguestfs_Object *) obj)->g;
8757 put_handle (guestfs_h *g)
8761 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8764 /* This list should be freed (but not the strings) after use. */
8766 get_string_list (PyObject *obj)
8773 if (!PyList_Check (obj)) {
8774 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8778 len = PyList_Size (obj);
8779 r = malloc (sizeof (char *) * (len+1));
8781 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8785 for (i = 0; i < len; ++i)
8786 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8793 put_string_list (char * const * const argv)
8798 for (argc = 0; argv[argc] != NULL; ++argc)
8801 list = PyList_New (argc);
8802 for (i = 0; i < argc; ++i)
8803 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8809 put_table (char * const * const argv)
8811 PyObject *list, *item;
8814 for (argc = 0; argv[argc] != NULL; ++argc)
8817 list = PyList_New (argc >> 1);
8818 for (i = 0; i < argc; i += 2) {
8819 item = PyTuple_New (2);
8820 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8821 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8822 PyList_SetItem (list, i >> 1, item);
8829 free_strings (char **argv)
8833 for (argc = 0; argv[argc] != NULL; ++argc)
8839 py_guestfs_create (PyObject *self, PyObject *args)
8843 g = guestfs_create ();
8845 PyErr_SetString (PyExc_RuntimeError,
8846 \"guestfs.create: failed to allocate handle\");
8849 guestfs_set_error_handler (g, NULL, NULL);
8850 return put_handle (g);
8854 py_guestfs_close (PyObject *self, PyObject *args)
8859 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8861 g = get_handle (py_g);
8865 Py_INCREF (Py_None);
8871 let emit_put_list_function typ =
8872 pr "static PyObject *\n";
8873 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8875 pr " PyObject *list;\n";
8878 pr " list = PyList_New (%ss->len);\n" typ;
8879 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8880 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8881 pr " return list;\n";
8886 (* Structures, turned into Python dictionaries. *)
8889 pr "static PyObject *\n";
8890 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8892 pr " PyObject *dict;\n";
8894 pr " dict = PyDict_New ();\n";
8898 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8899 pr " PyString_FromString (%s->%s));\n"
8902 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8903 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8906 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8907 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8909 | name, (FBytes|FUInt64) ->
8910 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8911 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8914 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8915 pr " PyLong_FromLongLong (%s->%s));\n"
8918 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8919 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8922 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8923 pr " PyLong_FromLong (%s->%s));\n"
8925 | name, FOptPercent ->
8926 pr " if (%s->%s >= 0)\n" typ name;
8927 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8928 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8931 pr " Py_INCREF (Py_None);\n";
8932 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8935 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8936 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8938 pr " return dict;\n";
8944 (* Emit a put_TYPE_list function definition only if that function is used. *)
8947 | typ, (RStructListOnly | RStructAndList) ->
8948 (* generate the function for typ *)
8949 emit_put_list_function typ
8950 | typ, _ -> () (* empty *)
8951 ) (rstructs_used_by all_functions);
8953 (* Python wrapper functions. *)
8955 fun (name, style, _, _, _, _, _) ->
8956 pr "static PyObject *\n";
8957 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
8960 pr " PyObject *py_g;\n";
8961 pr " guestfs_h *g;\n";
8962 pr " PyObject *py_r;\n";
8965 match fst style with
8966 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8967 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8968 | RConstString _ | RConstOptString _ ->
8969 pr " const char *r;\n"; "NULL"
8970 | RString _ -> pr " char *r;\n"; "NULL"
8971 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8972 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8973 | RStructList (_, typ) ->
8974 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8977 pr " size_t size;\n";
8982 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8983 pr " const char *%s;\n" n
8984 | OptString n -> pr " const char *%s;\n" n
8985 | StringList n | DeviceList n ->
8986 pr " PyObject *py_%s;\n" n;
8987 pr " char **%s;\n" n
8988 | Bool n -> pr " int %s;\n" n
8989 | Int n -> pr " int %s;\n" n
8990 | Int64 n -> pr " long long %s;\n" n
8995 (* Convert the parameters. *)
8996 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
8999 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9000 | OptString _ -> pr "z"
9001 | StringList _ | DeviceList _ -> pr "O"
9002 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9004 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9005 * emulate C's int/long/long long in Python?
9008 pr ":guestfs_%s\",\n" name;
9012 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9013 | OptString n -> pr ", &%s" n
9014 | StringList n | DeviceList n -> pr ", &py_%s" n
9015 | Bool n -> pr ", &%s" n
9016 | Int n -> pr ", &%s" n
9017 | Int64 n -> pr ", &%s" n
9021 pr " return NULL;\n";
9023 pr " g = get_handle (py_g);\n";
9026 | Pathname _ | Device _ | Dev_or_Path _ | String _
9027 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9028 | StringList n | DeviceList n ->
9029 pr " %s = get_string_list (py_%s);\n" n n;
9030 pr " if (!%s) return NULL;\n" n
9035 pr " r = guestfs_%s " name;
9036 generate_c_call_args ~handle:"g" style;
9041 | Pathname _ | Device _ | Dev_or_Path _ | String _
9042 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9043 | StringList n | DeviceList n ->
9044 pr " free (%s);\n" n
9047 pr " if (r == %s) {\n" error_code;
9048 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9049 pr " return NULL;\n";
9053 (match fst style with
9055 pr " Py_INCREF (Py_None);\n";
9056 pr " py_r = Py_None;\n"
9058 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9059 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9060 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9061 | RConstOptString _ ->
9063 pr " py_r = PyString_FromString (r);\n";
9065 pr " Py_INCREF (Py_None);\n";
9066 pr " py_r = Py_None;\n";
9069 pr " py_r = PyString_FromString (r);\n";
9072 pr " py_r = put_string_list (r);\n";
9073 pr " free_strings (r);\n"
9074 | RStruct (_, typ) ->
9075 pr " py_r = put_%s (r);\n" typ;
9076 pr " guestfs_free_%s (r);\n" typ
9077 | RStructList (_, typ) ->
9078 pr " py_r = put_%s_list (r);\n" typ;
9079 pr " guestfs_free_%s_list (r);\n" typ
9081 pr " py_r = put_table (r);\n";
9082 pr " free_strings (r);\n"
9084 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9088 pr " return py_r;\n";
9093 (* Table of functions. *)
9094 pr "static PyMethodDef methods[] = {\n";
9095 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9096 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9098 fun (name, _, _, _, _, _, _) ->
9099 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9102 pr " { NULL, NULL, 0, NULL }\n";
9106 (* Init function. *)
9109 initlibguestfsmod (void)
9111 static int initialized = 0;
9113 if (initialized) return;
9114 Py_InitModule ((char *) \"libguestfsmod\", methods);
9119 (* Generate Python module. *)
9120 and generate_python_py () =
9121 generate_header HashStyle LGPLv2plus;
9124 u\"\"\"Python bindings for libguestfs
9127 g = guestfs.GuestFS ()
9128 g.add_drive (\"guest.img\")
9130 parts = g.list_partitions ()
9132 The guestfs module provides a Python binding to the libguestfs API
9133 for examining and modifying virtual machine disk images.
9135 Amongst the things this is good for: making batch configuration
9136 changes to guests, getting disk used/free statistics (see also:
9137 virt-df), migrating between virtualization systems (see also:
9138 virt-p2v), performing partial backups, performing partial guest
9139 clones, cloning guests and changing registry/UUID/hostname info, and
9142 Libguestfs uses Linux kernel and qemu code, and can access any type of
9143 guest filesystem that Linux and qemu can, including but not limited
9144 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9145 schemes, qcow, qcow2, vmdk.
9147 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9148 LVs, what filesystem is in each LV, etc.). It can also run commands
9149 in the context of the guest. Also you can access filesystems over
9152 Errors which happen while using the API are turned into Python
9153 RuntimeError exceptions.
9155 To create a guestfs handle you usually have to perform the following
9158 # Create the handle, call add_drive at least once, and possibly
9159 # several times if the guest has multiple block devices:
9160 g = guestfs.GuestFS ()
9161 g.add_drive (\"guest.img\")
9163 # Launch the qemu subprocess and wait for it to become ready:
9166 # Now you can issue commands, for example:
9171 import libguestfsmod
9174 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9176 def __init__ (self):
9177 \"\"\"Create a new libguestfs handle.\"\"\"
9178 self._o = libguestfsmod.create ()
9181 libguestfsmod.close (self._o)
9186 fun (name, style, _, flags, _, _, longdesc) ->
9188 generate_py_call_args ~handle:"self" (snd style);
9191 if not (List.mem NotInDocs flags) then (
9192 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9194 match fst style with
9195 | RErr | RInt _ | RInt64 _ | RBool _
9196 | RConstOptString _ | RConstString _
9197 | RString _ | RBufferOut _ -> doc
9199 doc ^ "\n\nThis function returns a list of strings."
9200 | RStruct (_, typ) ->
9201 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9202 | RStructList (_, typ) ->
9203 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9205 doc ^ "\n\nThis function returns a dictionary." in
9207 if List.mem ProtocolLimitWarning flags then
9208 doc ^ "\n\n" ^ protocol_limit_warning
9211 if List.mem DangerWillRobinson flags then
9212 doc ^ "\n\n" ^ danger_will_robinson
9215 match deprecation_notice flags with
9217 | Some txt -> doc ^ "\n\n" ^ txt in
9218 let doc = pod2text ~width:60 name doc in
9219 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9220 let doc = String.concat "\n " doc in
9221 pr " u\"\"\"%s\"\"\"\n" doc;
9223 pr " return libguestfsmod.%s " name;
9224 generate_py_call_args ~handle:"self._o" (snd style);
9229 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9230 and generate_py_call_args ~handle args =
9232 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9235 (* Useful if you need the longdesc POD text as plain text. Returns a
9238 * Because this is very slow (the slowest part of autogeneration),
9239 * we memoize the results.
9241 and pod2text ~width name longdesc =
9242 let key = width, name, longdesc in
9243 try Hashtbl.find pod2text_memo key
9245 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9246 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9248 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9249 let chan = open_process_in cmd in
9250 let lines = ref [] in
9252 let line = input_line chan in
9253 if i = 1 then (* discard the first line of output *)
9256 let line = triml line in
9257 lines := line :: !lines;
9260 let lines = try loop 1 with End_of_file -> List.rev !lines in
9262 (match close_process_in chan with
9265 failwithf "pod2text: process exited with non-zero status (%d)" i
9266 | WSIGNALED i | WSTOPPED i ->
9267 failwithf "pod2text: process signalled or stopped by signal %d" i
9269 Hashtbl.add pod2text_memo key lines;
9270 pod2text_memo_updated ();
9273 (* Generate ruby bindings. *)
9274 and generate_ruby_c () =
9275 generate_header CStyle LGPLv2plus;
9283 #include \"guestfs.h\"
9285 #include \"extconf.h\"
9287 /* For Ruby < 1.9 */
9289 #define RARRAY_LEN(r) (RARRAY((r))->len)
9292 static VALUE m_guestfs; /* guestfs module */
9293 static VALUE c_guestfs; /* guestfs_h handle */
9294 static VALUE e_Error; /* used for all errors */
9296 static void ruby_guestfs_free (void *p)
9299 guestfs_close ((guestfs_h *) p);
9302 static VALUE ruby_guestfs_create (VALUE m)
9306 g = guestfs_create ();
9308 rb_raise (e_Error, \"failed to create guestfs handle\");
9310 /* Don't print error messages to stderr by default. */
9311 guestfs_set_error_handler (g, NULL, NULL);
9313 /* Wrap it, and make sure the close function is called when the
9316 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9319 static VALUE ruby_guestfs_close (VALUE gv)
9322 Data_Get_Struct (gv, guestfs_h, g);
9324 ruby_guestfs_free (g);
9325 DATA_PTR (gv) = NULL;
9333 fun (name, style, _, _, _, _, _) ->
9334 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9335 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9338 pr " guestfs_h *g;\n";
9339 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9341 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9347 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9348 pr " Check_Type (%sv, T_STRING);\n" n;
9349 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9351 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9352 pr " \"%s\", \"%s\");\n" n name
9354 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9355 | StringList n | DeviceList n ->
9356 pr " char **%s;\n" n;
9357 pr " Check_Type (%sv, T_ARRAY);\n" n;
9359 pr " int i, len;\n";
9360 pr " len = RARRAY_LEN (%sv);\n" n;
9361 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9363 pr " for (i = 0; i < len; ++i) {\n";
9364 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9365 pr " %s[i] = StringValueCStr (v);\n" n;
9367 pr " %s[len] = NULL;\n" n;
9370 pr " int %s = RTEST (%sv);\n" n n
9372 pr " int %s = NUM2INT (%sv);\n" n n
9374 pr " long long %s = NUM2LL (%sv);\n" n n
9379 match fst style with
9380 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9381 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9382 | RConstString _ | RConstOptString _ ->
9383 pr " const char *r;\n"; "NULL"
9384 | RString _ -> pr " char *r;\n"; "NULL"
9385 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9386 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9387 | RStructList (_, typ) ->
9388 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9391 pr " size_t size;\n";
9395 pr " r = guestfs_%s " name;
9396 generate_c_call_args ~handle:"g" style;
9401 | Pathname _ | Device _ | Dev_or_Path _ | String _
9402 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9403 | StringList n | DeviceList n ->
9404 pr " free (%s);\n" n
9407 pr " if (r == %s)\n" error_code;
9408 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9411 (match fst style with
9413 pr " return Qnil;\n"
9414 | RInt _ | RBool _ ->
9415 pr " return INT2NUM (r);\n"
9417 pr " return ULL2NUM (r);\n"
9419 pr " return rb_str_new2 (r);\n";
9420 | RConstOptString _ ->
9422 pr " return rb_str_new2 (r);\n";
9424 pr " return Qnil;\n";
9426 pr " VALUE rv = rb_str_new2 (r);\n";
9430 pr " int i, len = 0;\n";
9431 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9432 pr " VALUE rv = rb_ary_new2 (len);\n";
9433 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9434 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9435 pr " free (r[i]);\n";
9439 | RStruct (_, typ) ->
9440 let cols = cols_of_struct typ in
9441 generate_ruby_struct_code typ cols
9442 | RStructList (_, typ) ->
9443 let cols = cols_of_struct typ in
9444 generate_ruby_struct_list_code typ cols
9446 pr " VALUE rv = rb_hash_new ();\n";
9448 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9449 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9450 pr " free (r[i]);\n";
9451 pr " free (r[i+1]);\n";
9456 pr " VALUE rv = rb_str_new (r, size);\n";
9466 /* Initialize the module. */
9467 void Init__guestfs ()
9469 m_guestfs = rb_define_module (\"Guestfs\");
9470 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9471 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9473 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9474 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9477 (* Define the rest of the methods. *)
9479 fun (name, style, _, _, _, _, _) ->
9480 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9481 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9486 (* Ruby code to return a struct. *)
9487 and generate_ruby_struct_code typ cols =
9488 pr " VALUE rv = rb_hash_new ();\n";
9492 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9494 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9496 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9497 | name, (FBytes|FUInt64) ->
9498 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9500 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9502 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9504 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9505 | name, FOptPercent ->
9506 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9507 | name, FChar -> (* XXX wrong? *)
9508 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9510 pr " guestfs_free_%s (r);\n" typ;
9513 (* Ruby code to return a struct list. *)
9514 and generate_ruby_struct_list_code typ cols =
9515 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9517 pr " for (i = 0; i < r->len; ++i) {\n";
9518 pr " VALUE hv = rb_hash_new ();\n";
9522 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9524 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
9526 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9527 | name, (FBytes|FUInt64) ->
9528 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9530 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9532 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9534 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9535 | name, FOptPercent ->
9536 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9537 | name, FChar -> (* XXX wrong? *)
9538 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9540 pr " rb_ary_push (rv, hv);\n";
9542 pr " guestfs_free_%s_list (r);\n" typ;
9545 (* Generate Java bindings GuestFS.java file. *)
9546 and generate_java_java () =
9547 generate_header CStyle LGPLv2plus;
9550 package com.redhat.et.libguestfs;
9552 import java.util.HashMap;
9553 import com.redhat.et.libguestfs.LibGuestFSException;
9554 import com.redhat.et.libguestfs.PV;
9555 import com.redhat.et.libguestfs.VG;
9556 import com.redhat.et.libguestfs.LV;
9557 import com.redhat.et.libguestfs.Stat;
9558 import com.redhat.et.libguestfs.StatVFS;
9559 import com.redhat.et.libguestfs.IntBool;
9560 import com.redhat.et.libguestfs.Dirent;
9563 * The GuestFS object is a libguestfs handle.
9567 public class GuestFS {
9568 // Load the native code.
9570 System.loadLibrary (\"guestfs_jni\");
9574 * The native guestfs_h pointer.
9579 * Create a libguestfs handle.
9581 * @throws LibGuestFSException
9583 public GuestFS () throws LibGuestFSException
9587 private native long _create () throws LibGuestFSException;
9590 * Close a libguestfs handle.
9592 * You can also leave handles to be collected by the garbage
9593 * collector, but this method ensures that the resources used
9594 * by the handle are freed up immediately. If you call any
9595 * other methods after closing the handle, you will get an
9598 * @throws LibGuestFSException
9600 public void close () throws LibGuestFSException
9606 private native void _close (long g) throws LibGuestFSException;
9608 public void finalize () throws LibGuestFSException
9616 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9617 if not (List.mem NotInDocs flags); then (
9618 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9620 if List.mem ProtocolLimitWarning flags then
9621 doc ^ "\n\n" ^ protocol_limit_warning
9624 if List.mem DangerWillRobinson flags then
9625 doc ^ "\n\n" ^ danger_will_robinson
9628 match deprecation_notice flags with
9630 | Some txt -> doc ^ "\n\n" ^ txt in
9631 let doc = pod2text ~width:60 name doc in
9632 let doc = List.map ( (* RHBZ#501883 *)
9635 | nonempty -> nonempty
9637 let doc = String.concat "\n * " doc in
9640 pr " * %s\n" shortdesc;
9643 pr " * @throws LibGuestFSException\n";
9647 generate_java_prototype ~public:true ~semicolon:false name style;
9650 pr " if (g == 0)\n";
9651 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9654 if fst style <> RErr then pr "return ";
9656 generate_java_call_args ~handle:"g" (snd style);
9660 generate_java_prototype ~privat:true ~native:true name style;
9667 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9668 and generate_java_call_args ~handle args =
9670 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9673 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9674 ?(semicolon=true) name style =
9675 if privat then pr "private ";
9676 if public then pr "public ";
9677 if native then pr "native ";
9680 (match fst style with
9681 | RErr -> pr "void ";
9682 | RInt _ -> pr "int ";
9683 | RInt64 _ -> pr "long ";
9684 | RBool _ -> pr "boolean ";
9685 | RConstString _ | RConstOptString _ | RString _
9686 | RBufferOut _ -> pr "String ";
9687 | RStringList _ -> pr "String[] ";
9688 | RStruct (_, typ) ->
9689 let name = java_name_of_struct typ in
9691 | RStructList (_, typ) ->
9692 let name = java_name_of_struct typ in
9694 | RHashtable _ -> pr "HashMap<String,String> ";
9697 if native then pr "_%s " name else pr "%s " name;
9699 let needs_comma = ref false in
9708 if !needs_comma then pr ", ";
9709 needs_comma := true;
9713 | Device n | Dev_or_Path n
9719 | StringList n | DeviceList n ->
9730 pr " throws LibGuestFSException";
9731 if semicolon then pr ";"
9733 and generate_java_struct jtyp cols () =
9734 generate_header CStyle LGPLv2plus;
9737 package com.redhat.et.libguestfs;
9740 * Libguestfs %s structure.
9752 | name, FBuffer -> pr " public String %s;\n" name
9753 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9754 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9755 | name, FChar -> pr " public char %s;\n" name
9756 | name, FOptPercent ->
9757 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9758 pr " public float %s;\n" name
9763 and generate_java_c () =
9764 generate_header CStyle LGPLv2plus;
9771 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9772 #include \"guestfs.h\"
9774 /* Note that this function returns. The exception is not thrown
9775 * until after the wrapper function returns.
9778 throw_exception (JNIEnv *env, const char *msg)
9781 cl = (*env)->FindClass (env,
9782 \"com/redhat/et/libguestfs/LibGuestFSException\");
9783 (*env)->ThrowNew (env, cl, msg);
9786 JNIEXPORT jlong JNICALL
9787 Java_com_redhat_et_libguestfs_GuestFS__1create
9788 (JNIEnv *env, jobject obj)
9792 g = guestfs_create ();
9794 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9797 guestfs_set_error_handler (g, NULL, NULL);
9798 return (jlong) (long) g;
9801 JNIEXPORT void JNICALL
9802 Java_com_redhat_et_libguestfs_GuestFS__1close
9803 (JNIEnv *env, jobject obj, jlong jg)
9805 guestfs_h *g = (guestfs_h *) (long) jg;
9812 fun (name, style, _, _, _, _, _) ->
9814 (match fst style with
9815 | RErr -> pr "void ";
9816 | RInt _ -> pr "jint ";
9817 | RInt64 _ -> pr "jlong ";
9818 | RBool _ -> pr "jboolean ";
9819 | RConstString _ | RConstOptString _ | RString _
9820 | RBufferOut _ -> pr "jstring ";
9821 | RStruct _ | RHashtable _ ->
9823 | RStringList _ | RStructList _ ->
9827 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9828 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9830 pr " (JNIEnv *env, jobject obj, jlong jg";
9834 | Device n | Dev_or_Path n
9839 pr ", jstring j%s" n
9840 | StringList n | DeviceList n ->
9841 pr ", jobjectArray j%s" n
9843 pr ", jboolean j%s" n
9851 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9852 let error_code, no_ret =
9853 match fst style with
9854 | RErr -> pr " int r;\n"; "-1", ""
9856 | RInt _ -> pr " int r;\n"; "-1", "0"
9857 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9858 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9859 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9861 pr " jstring jr;\n";
9862 pr " char *r;\n"; "NULL", "NULL"
9864 pr " jobjectArray jr;\n";
9867 pr " jstring jstr;\n";
9868 pr " char **r;\n"; "NULL", "NULL"
9869 | RStruct (_, typ) ->
9870 pr " jobject jr;\n";
9872 pr " jfieldID fl;\n";
9873 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9874 | RStructList (_, typ) ->
9875 pr " jobjectArray jr;\n";
9877 pr " jfieldID fl;\n";
9878 pr " jobject jfl;\n";
9879 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9880 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9882 pr " jstring jr;\n";
9884 pr " size_t size;\n";
9889 | Device n | Dev_or_Path n
9894 pr " const char *%s;\n" n
9895 | StringList n | DeviceList n ->
9896 pr " int %s_len;\n" n;
9897 pr " const char **%s;\n" n
9902 pr " int64_t %s;\n" n
9906 (match fst style with
9907 | RStringList _ | RStructList _ -> true
9908 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9910 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9911 List.exists (function
9912 | StringList _ -> true
9913 | DeviceList _ -> true
9914 | _ -> false) (snd style) in
9920 (* Get the parameters. *)
9924 | Device n | Dev_or_Path n
9928 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9930 (* This is completely undocumented, but Java null becomes
9933 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9934 | StringList n | DeviceList n ->
9935 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9936 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9937 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9938 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9940 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9942 pr " %s[%s_len] = NULL;\n" n n;
9946 pr " %s = j%s;\n" n n
9949 (* Make the call. *)
9950 pr " r = guestfs_%s " name;
9951 generate_c_call_args ~handle:"g" style;
9954 (* Release the parameters. *)
9958 | Device n | Dev_or_Path n
9962 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9965 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9966 | StringList n | DeviceList n ->
9967 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9968 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9970 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
9972 pr " free (%s);\n" n
9978 (* Check for errors. *)
9979 pr " if (r == %s) {\n" error_code;
9980 pr " throw_exception (env, guestfs_last_error (g));\n";
9981 pr " return %s;\n" no_ret;
9985 (match fst style with
9987 | RInt _ -> pr " return (jint) r;\n"
9988 | RBool _ -> pr " return (jboolean) r;\n"
9989 | RInt64 _ -> pr " return (jlong) r;\n"
9990 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
9991 | RConstOptString _ ->
9992 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
9994 pr " jr = (*env)->NewStringUTF (env, r);\n";
9998 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
9999 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10000 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10001 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10002 pr " for (i = 0; i < r_len; ++i) {\n";
10003 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10004 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10005 pr " free (r[i]);\n";
10009 | RStruct (_, typ) ->
10010 let jtyp = java_name_of_struct typ in
10011 let cols = cols_of_struct typ in
10012 generate_java_struct_return typ jtyp cols
10013 | RStructList (_, typ) ->
10014 let jtyp = java_name_of_struct typ in
10015 let cols = cols_of_struct typ in
10016 generate_java_struct_list_return typ jtyp cols
10019 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10020 pr " return NULL;\n"
10022 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10031 and generate_java_struct_return typ jtyp cols =
10032 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10033 pr " jr = (*env)->AllocObject (env, cl);\n";
10037 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10038 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10041 pr " char s[33];\n";
10042 pr " memcpy (s, r->%s, 32);\n" name;
10043 pr " s[32] = 0;\n";
10044 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10045 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10049 pr " int len = r->%s_len;\n" name;
10050 pr " char s[len+1];\n";
10051 pr " memcpy (s, r->%s, len);\n" name;
10052 pr " s[len] = 0;\n";
10053 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10054 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10056 | name, (FBytes|FUInt64|FInt64) ->
10057 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10058 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10059 | name, (FUInt32|FInt32) ->
10060 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10061 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10062 | name, FOptPercent ->
10063 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10064 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10066 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10067 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10072 and generate_java_struct_list_return typ jtyp cols =
10073 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10074 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10075 pr " for (i = 0; i < r->len; ++i) {\n";
10076 pr " jfl = (*env)->AllocObject (env, cl);\n";
10080 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10081 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10084 pr " char s[33];\n";
10085 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10086 pr " s[32] = 0;\n";
10087 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10088 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10092 pr " int len = r->val[i].%s_len;\n" name;
10093 pr " char s[len+1];\n";
10094 pr " memcpy (s, r->val[i].%s, len);\n" name;
10095 pr " s[len] = 0;\n";
10096 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10097 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10099 | name, (FBytes|FUInt64|FInt64) ->
10100 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10101 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10102 | name, (FUInt32|FInt32) ->
10103 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10104 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10105 | name, FOptPercent ->
10106 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10107 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10109 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10110 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10112 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10114 pr " guestfs_free_%s_list (r);\n" typ;
10117 and generate_java_makefile_inc () =
10118 generate_header HashStyle GPLv2plus;
10120 pr "java_built_sources = \\\n";
10123 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10125 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10127 and generate_haskell_hs () =
10128 generate_header HaskellStyle LGPLv2plus;
10130 (* XXX We only know how to generate partial FFI for Haskell
10131 * at the moment. Please help out!
10133 let can_generate style =
10137 | RInt64 _, _ -> true
10139 | RConstString _, _
10140 | RConstOptString _, _
10146 | RBufferOut _, _ -> false in
10149 {-# INCLUDE <guestfs.h> #-}
10150 {-# LANGUAGE ForeignFunctionInterface #-}
10155 (* List out the names of the actions we want to export. *)
10157 fun (name, style, _, _, _, _, _) ->
10158 if can_generate style then pr ",\n %s" name
10164 -- Unfortunately some symbols duplicate ones already present
10165 -- in Prelude. We don't know which, so we hard-code a list
10167 import Prelude hiding (truncate)
10171 import Foreign.C.Types
10173 import Control.Exception
10174 import Data.Typeable
10176 data GuestfsS = GuestfsS -- represents the opaque C struct
10177 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10178 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10180 -- XXX define properly later XXX
10184 data IntBool = IntBool
10186 data StatVFS = StatVFS
10187 data Hashtable = Hashtable
10189 foreign import ccall unsafe \"guestfs_create\" c_create
10191 foreign import ccall unsafe \"&guestfs_close\" c_close
10192 :: FunPtr (GuestfsP -> IO ())
10193 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10194 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10196 create :: IO GuestfsH
10199 c_set_error_handler p nullPtr nullPtr
10200 h <- newForeignPtr c_close p
10203 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10204 :: GuestfsP -> IO CString
10206 -- last_error :: GuestfsH -> IO (Maybe String)
10207 -- last_error h = do
10208 -- str <- withForeignPtr h (\\p -> c_last_error p)
10209 -- maybePeek peekCString str
10211 last_error :: GuestfsH -> IO (String)
10213 str <- withForeignPtr h (\\p -> c_last_error p)
10214 if (str == nullPtr)
10215 then return \"no error\"
10216 else peekCString str
10220 (* Generate wrappers for each foreign function. *)
10222 fun (name, style, _, _, _, _, _) ->
10223 if can_generate style then (
10224 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10226 generate_haskell_prototype ~handle:"GuestfsP" style;
10230 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10232 pr "%s %s = do\n" name
10233 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10235 (* Convert pointer arguments using with* functions. *)
10240 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
10241 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10242 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10243 | Bool _ | Int _ | Int64 _ -> ()
10245 (* Convert integer arguments. *)
10249 | Bool n -> sprintf "(fromBool %s)" n
10250 | Int n -> sprintf "(fromIntegral %s)" n
10251 | Int64 n -> sprintf "(fromIntegral %s)" n
10252 | FileIn n | FileOut n
10253 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10255 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10256 (String.concat " " ("p" :: args));
10257 (match fst style with
10258 | RErr | RInt _ | RInt64 _ | RBool _ ->
10259 pr " if (r == -1)\n";
10261 pr " err <- last_error h\n";
10263 | RConstString _ | RConstOptString _ | RString _
10264 | RStringList _ | RStruct _
10265 | RStructList _ | RHashtable _ | RBufferOut _ ->
10266 pr " if (r == nullPtr)\n";
10268 pr " err <- last_error h\n";
10271 (match fst style with
10273 pr " else return ()\n"
10275 pr " else return (fromIntegral r)\n"
10277 pr " else return (fromIntegral r)\n"
10279 pr " else return (toBool r)\n"
10281 | RConstOptString _
10288 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10294 and generate_haskell_prototype ~handle ?(hs = false) style =
10295 pr "%s -> " handle;
10296 let string = if hs then "String" else "CString" in
10297 let int = if hs then "Int" else "CInt" in
10298 let bool = if hs then "Bool" else "CInt" in
10299 let int64 = if hs then "Integer" else "Int64" in
10303 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10304 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10305 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10306 | Bool _ -> pr "%s" bool
10307 | Int _ -> pr "%s" int
10308 | Int64 _ -> pr "%s" int
10309 | FileIn _ -> pr "%s" string
10310 | FileOut _ -> pr "%s" string
10315 (match fst style with
10316 | RErr -> if not hs then pr "CInt"
10317 | RInt _ -> pr "%s" int
10318 | RInt64 _ -> pr "%s" int64
10319 | RBool _ -> pr "%s" bool
10320 | RConstString _ -> pr "%s" string
10321 | RConstOptString _ -> pr "Maybe %s" string
10322 | RString _ -> pr "%s" string
10323 | RStringList _ -> pr "[%s]" string
10324 | RStruct (_, typ) ->
10325 let name = java_name_of_struct typ in
10327 | RStructList (_, typ) ->
10328 let name = java_name_of_struct typ in
10330 | RHashtable _ -> pr "Hashtable"
10331 | RBufferOut _ -> pr "%s" string
10335 and generate_csharp () =
10336 generate_header CPlusPlusStyle LGPLv2plus;
10338 (* XXX Make this configurable by the C# assembly users. *)
10339 let library = "libguestfs.so.0" in
10342 // These C# bindings are highly experimental at present.
10344 // Firstly they only work on Linux (ie. Mono). In order to get them
10345 // to work on Windows (ie. .Net) you would need to port the library
10346 // itself to Windows first.
10348 // The second issue is that some calls are known to be incorrect and
10349 // can cause Mono to segfault. Particularly: calls which pass or
10350 // return string[], or return any structure value. This is because
10351 // we haven't worked out the correct way to do this from C#.
10353 // The third issue is that when compiling you get a lot of warnings.
10354 // We are not sure whether the warnings are important or not.
10356 // Fourthly we do not routinely build or test these bindings as part
10357 // of the make && make check cycle, which means that regressions might
10360 // Suggestions and patches are welcome.
10364 // gmcs Libguestfs.cs
10365 // mono Libguestfs.exe
10367 // (You'll probably want to add a Test class / static main function
10368 // otherwise this won't do anything useful).
10372 using System.Runtime.InteropServices;
10373 using System.Runtime.Serialization;
10374 using System.Collections;
10378 class Error : System.ApplicationException
10380 public Error (string message) : base (message) {}
10381 protected Error (SerializationInfo info, StreamingContext context) {}
10388 [DllImport (\"%s\")]
10389 static extern IntPtr guestfs_create ();
10393 _handle = guestfs_create ();
10394 if (_handle == IntPtr.Zero)
10395 throw new Error (\"could not create guestfs handle\");
10398 [DllImport (\"%s\")]
10399 static extern void guestfs_close (IntPtr h);
10403 guestfs_close (_handle);
10406 [DllImport (\"%s\")]
10407 static extern string guestfs_last_error (IntPtr h);
10409 " library library library;
10411 (* Generate C# structure bindings. We prefix struct names with
10412 * underscore because C# cannot have conflicting struct names and
10413 * method names (eg. "class stat" and "stat").
10417 pr " [StructLayout (LayoutKind.Sequential)]\n";
10418 pr " public class _%s {\n" typ;
10421 | name, FChar -> pr " char %s;\n" name
10422 | name, FString -> pr " string %s;\n" name
10424 pr " uint %s_len;\n" name;
10425 pr " string %s;\n" name
10427 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10428 pr " string %s;\n" name
10429 | name, FUInt32 -> pr " uint %s;\n" name
10430 | name, FInt32 -> pr " int %s;\n" name
10431 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10432 | name, FInt64 -> pr " long %s;\n" name
10433 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10439 (* Generate C# function bindings. *)
10441 fun (name, style, _, _, _, shortdesc, _) ->
10442 let rec csharp_return_type () =
10443 match fst style with
10445 | RBool n -> "bool"
10447 | RInt64 n -> "long"
10449 | RConstOptString n
10451 | RBufferOut n -> "string"
10452 | RStruct (_,n) -> "_" ^ n
10453 | RHashtable n -> "Hashtable"
10454 | RStringList n -> "string[]"
10455 | RStructList (_,n) -> sprintf "_%s[]" n
10457 and c_return_type () =
10458 match fst style with
10462 | RInt64 _ -> "long"
10464 | RConstOptString _
10466 | RBufferOut _ -> "string"
10467 | RStruct (_,n) -> "_" ^ n
10469 | RStringList _ -> "string[]"
10470 | RStructList (_,n) -> sprintf "_%s[]" n
10472 and c_error_comparison () =
10473 match fst style with
10477 | RInt64 _ -> "== -1"
10479 | RConstOptString _
10485 | RStructList (_,_) -> "== null"
10487 and generate_extern_prototype () =
10488 pr " static extern %s guestfs_%s (IntPtr h"
10489 (c_return_type ()) name;
10492 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10493 | FileIn n | FileOut n ->
10494 pr ", [In] string %s" n
10495 | StringList n | DeviceList n ->
10496 pr ", [In] string[] %s" n
10506 and generate_public_prototype () =
10507 pr " public %s %s (" (csharp_return_type ()) name;
10508 let comma = ref false in
10510 if !comma then pr ", ";
10515 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10516 | FileIn n | FileOut n ->
10517 next (); pr "string %s" n
10518 | StringList n | DeviceList n ->
10519 next (); pr "string[] %s" n
10521 next (); pr "bool %s" n
10523 next (); pr "int %s" n
10525 next (); pr "long %s" n
10529 and generate_call () =
10530 pr "guestfs_%s (_handle" name;
10531 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10535 pr " [DllImport (\"%s\")]\n" library;
10536 generate_extern_prototype ();
10538 pr " /// <summary>\n";
10539 pr " /// %s\n" shortdesc;
10540 pr " /// </summary>\n";
10541 generate_public_prototype ();
10543 pr " %s r;\n" (c_return_type ());
10546 pr " if (r %s)\n" (c_error_comparison ());
10547 pr " throw new Error (guestfs_last_error (_handle));\n";
10548 (match fst style with
10551 pr " return r != 0 ? true : false;\n"
10553 pr " Hashtable rr = new Hashtable ();\n";
10554 pr " for (int i = 0; i < r.Length; i += 2)\n";
10555 pr " rr.Add (r[i], r[i+1]);\n";
10557 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10558 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10564 ) all_functions_sorted;
10570 and generate_bindtests () =
10571 generate_header CStyle LGPLv2plus;
10575 #include <stdlib.h>
10576 #include <inttypes.h>
10577 #include <string.h>
10579 #include \"guestfs.h\"
10580 #include \"guestfs-internal.h\"
10581 #include \"guestfs-internal-actions.h\"
10582 #include \"guestfs_protocol.h\"
10584 #define error guestfs_error
10585 #define safe_calloc guestfs_safe_calloc
10586 #define safe_malloc guestfs_safe_malloc
10589 print_strings (char *const *argv)
10594 for (argc = 0; argv[argc] != NULL; ++argc) {
10595 if (argc > 0) printf (\", \");
10596 printf (\"\\\"%%s\\\"\", argv[argc]);
10601 /* The test0 function prints its parameters to stdout. */
10605 match test_functions with
10606 | [] -> assert false
10607 | test0 :: tests -> test0, tests in
10610 let (name, style, _, _, _, _, _) = test0 in
10611 generate_prototype ~extern:false ~semicolon:false ~newline:true
10612 ~handle:"g" ~prefix:"guestfs__" name style;
10617 | Device n | Dev_or_Path n
10620 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10621 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10622 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10623 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10624 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10625 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10627 pr " /* Java changes stdout line buffering so we need this: */\n";
10628 pr " fflush (stdout);\n";
10634 fun (name, style, _, _, _, _, _) ->
10635 if String.sub name (String.length name - 3) 3 <> "err" then (
10636 pr "/* Test normal return. */\n";
10637 generate_prototype ~extern:false ~semicolon:false ~newline:true
10638 ~handle:"g" ~prefix:"guestfs__" name style;
10640 (match fst style with
10645 pr " sscanf (val, \"%%d\", &r);\n";
10648 pr " int64_t r;\n";
10649 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10652 pr " return STREQ (val, \"true\");\n"
10654 | RConstOptString _ ->
10655 (* Can't return the input string here. Return a static
10656 * string so we ensure we get a segfault if the caller
10657 * tries to free it.
10659 pr " return \"static string\";\n"
10661 pr " return strdup (val);\n"
10663 pr " char **strs;\n";
10665 pr " sscanf (val, \"%%d\", &n);\n";
10666 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10667 pr " for (i = 0; i < n; ++i) {\n";
10668 pr " strs[i] = safe_malloc (g, 16);\n";
10669 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10671 pr " strs[n] = NULL;\n";
10672 pr " return strs;\n"
10673 | RStruct (_, typ) ->
10674 pr " struct guestfs_%s *r;\n" typ;
10675 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10677 | RStructList (_, typ) ->
10678 pr " struct guestfs_%s_list *r;\n" typ;
10679 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10680 pr " sscanf (val, \"%%d\", &r->len);\n";
10681 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10684 pr " char **strs;\n";
10686 pr " sscanf (val, \"%%d\", &n);\n";
10687 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10688 pr " for (i = 0; i < n; ++i) {\n";
10689 pr " strs[i*2] = safe_malloc (g, 16);\n";
10690 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10691 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10692 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10694 pr " strs[n*2] = NULL;\n";
10695 pr " return strs;\n"
10697 pr " return strdup (val);\n"
10702 pr "/* Test error return. */\n";
10703 generate_prototype ~extern:false ~semicolon:false ~newline:true
10704 ~handle:"g" ~prefix:"guestfs__" name style;
10706 pr " error (g, \"error\");\n";
10707 (match fst style with
10708 | RErr | RInt _ | RInt64 _ | RBool _ ->
10710 | RConstString _ | RConstOptString _
10711 | RString _ | RStringList _ | RStruct _
10715 pr " return NULL;\n"
10722 and generate_ocaml_bindtests () =
10723 generate_header OCamlStyle GPLv2plus;
10727 let g = Guestfs.create () in
10731 String.concat " " (
10734 | CallString s -> "\"" ^ s ^ "\""
10735 | CallOptString None -> "None"
10736 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10737 | CallStringList xs ->
10738 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10739 | CallInt i when i >= 0 -> string_of_int i
10740 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10741 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10742 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10743 | CallBool b -> string_of_bool b
10748 generate_lang_bindtests (
10749 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10752 pr "print_endline \"EOF\"\n"
10754 and generate_perl_bindtests () =
10755 pr "#!/usr/bin/perl -w\n";
10756 generate_header HashStyle GPLv2plus;
10763 my $g = Sys::Guestfs->new ();
10767 String.concat ", " (
10770 | CallString s -> "\"" ^ s ^ "\""
10771 | CallOptString None -> "undef"
10772 | CallOptString (Some s) -> sprintf "\"%s\"" s
10773 | CallStringList xs ->
10774 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10775 | CallInt i -> string_of_int i
10776 | CallInt64 i -> Int64.to_string i
10777 | CallBool b -> if b then "1" else "0"
10782 generate_lang_bindtests (
10783 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10786 pr "print \"EOF\\n\"\n"
10788 and generate_python_bindtests () =
10789 generate_header HashStyle GPLv2plus;
10794 g = guestfs.GuestFS ()
10798 String.concat ", " (
10801 | CallString s -> "\"" ^ s ^ "\""
10802 | CallOptString None -> "None"
10803 | CallOptString (Some s) -> sprintf "\"%s\"" s
10804 | CallStringList xs ->
10805 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10806 | CallInt i -> string_of_int i
10807 | CallInt64 i -> Int64.to_string i
10808 | CallBool b -> if b then "1" else "0"
10813 generate_lang_bindtests (
10814 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10817 pr "print \"EOF\"\n"
10819 and generate_ruby_bindtests () =
10820 generate_header HashStyle GPLv2plus;
10825 g = Guestfs::create()
10829 String.concat ", " (
10832 | CallString s -> "\"" ^ s ^ "\""
10833 | CallOptString None -> "nil"
10834 | CallOptString (Some s) -> sprintf "\"%s\"" s
10835 | CallStringList xs ->
10836 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10837 | CallInt i -> string_of_int i
10838 | CallInt64 i -> Int64.to_string i
10839 | CallBool b -> string_of_bool b
10844 generate_lang_bindtests (
10845 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10848 pr "print \"EOF\\n\"\n"
10850 and generate_java_bindtests () =
10851 generate_header CStyle GPLv2plus;
10854 import com.redhat.et.libguestfs.*;
10856 public class Bindtests {
10857 public static void main (String[] argv)
10860 GuestFS g = new GuestFS ();
10864 String.concat ", " (
10867 | CallString s -> "\"" ^ s ^ "\""
10868 | CallOptString None -> "null"
10869 | CallOptString (Some s) -> sprintf "\"%s\"" s
10870 | CallStringList xs ->
10872 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10873 | CallInt i -> string_of_int i
10874 | CallInt64 i -> Int64.to_string i
10875 | CallBool b -> string_of_bool b
10880 generate_lang_bindtests (
10881 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10885 System.out.println (\"EOF\");
10887 catch (Exception exn) {
10888 System.err.println (exn);
10895 and generate_haskell_bindtests () =
10896 generate_header HaskellStyle GPLv2plus;
10899 module Bindtests where
10900 import qualified Guestfs
10903 g <- Guestfs.create
10907 String.concat " " (
10910 | CallString s -> "\"" ^ s ^ "\""
10911 | CallOptString None -> "Nothing"
10912 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10913 | CallStringList xs ->
10914 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10915 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10916 | CallInt i -> string_of_int i
10917 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10918 | CallInt64 i -> Int64.to_string i
10919 | CallBool true -> "True"
10920 | CallBool false -> "False"
10925 generate_lang_bindtests (
10926 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10929 pr " putStrLn \"EOF\"\n"
10931 (* Language-independent bindings tests - we do it this way to
10932 * ensure there is parity in testing bindings across all languages.
10934 and generate_lang_bindtests call =
10935 call "test0" [CallString "abc"; CallOptString (Some "def");
10936 CallStringList []; CallBool false;
10937 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10938 call "test0" [CallString "abc"; CallOptString None;
10939 CallStringList []; CallBool false;
10940 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10941 call "test0" [CallString ""; CallOptString (Some "def");
10942 CallStringList []; CallBool false;
10943 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10944 call "test0" [CallString ""; CallOptString (Some "");
10945 CallStringList []; CallBool false;
10946 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10947 call "test0" [CallString "abc"; CallOptString (Some "def");
10948 CallStringList ["1"]; CallBool false;
10949 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10950 call "test0" [CallString "abc"; CallOptString (Some "def");
10951 CallStringList ["1"; "2"]; CallBool false;
10952 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10953 call "test0" [CallString "abc"; CallOptString (Some "def");
10954 CallStringList ["1"]; CallBool true;
10955 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10956 call "test0" [CallString "abc"; CallOptString (Some "def");
10957 CallStringList ["1"]; CallBool false;
10958 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
10959 call "test0" [CallString "abc"; CallOptString (Some "def");
10960 CallStringList ["1"]; CallBool false;
10961 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
10962 call "test0" [CallString "abc"; CallOptString (Some "def");
10963 CallStringList ["1"]; CallBool false;
10964 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
10965 call "test0" [CallString "abc"; CallOptString (Some "def");
10966 CallStringList ["1"]; CallBool false;
10967 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
10968 call "test0" [CallString "abc"; CallOptString (Some "def");
10969 CallStringList ["1"]; CallBool false;
10970 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
10971 call "test0" [CallString "abc"; CallOptString (Some "def");
10972 CallStringList ["1"]; CallBool false;
10973 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
10975 (* XXX Add here tests of the return and error functions. *)
10977 (* Code to generator bindings for virt-inspector. Currently only
10978 * implemented for OCaml code (for virt-p2v 2.0).
10980 let rng_input = "inspector/virt-inspector.rng"
10982 (* Read the input file and parse it into internal structures. This is
10983 * by no means a complete RELAX NG parser, but is just enough to be
10984 * able to parse the specific input file.
10987 | Element of string * rng list (* <element name=name/> *)
10988 | Attribute of string * rng list (* <attribute name=name/> *)
10989 | Interleave of rng list (* <interleave/> *)
10990 | ZeroOrMore of rng (* <zeroOrMore/> *)
10991 | OneOrMore of rng (* <oneOrMore/> *)
10992 | Optional of rng (* <optional/> *)
10993 | Choice of string list (* <choice><value/>*</choice> *)
10994 | Value of string (* <value>str</value> *)
10995 | Text (* <text/> *)
10997 let rec string_of_rng = function
10998 | Element (name, xs) ->
10999 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11000 | Attribute (name, xs) ->
11001 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11002 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11003 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11004 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11005 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11006 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11007 | Value value -> "Value \"" ^ value ^ "\""
11010 and string_of_rng_list xs =
11011 String.concat ", " (List.map string_of_rng xs)
11013 let rec parse_rng ?defines context = function
11015 | Xml.Element ("element", ["name", name], children) :: rest ->
11016 Element (name, parse_rng ?defines context children)
11017 :: parse_rng ?defines context rest
11018 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11019 Attribute (name, parse_rng ?defines context children)
11020 :: parse_rng ?defines context rest
11021 | Xml.Element ("interleave", [], children) :: rest ->
11022 Interleave (parse_rng ?defines context children)
11023 :: parse_rng ?defines context rest
11024 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11025 let rng = parse_rng ?defines context [child] in
11027 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11029 failwithf "%s: <zeroOrMore> contains more than one child element"
11032 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11033 let rng = parse_rng ?defines context [child] in
11035 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11037 failwithf "%s: <oneOrMore> contains more than one child element"
11040 | Xml.Element ("optional", [], [child]) :: rest ->
11041 let rng = parse_rng ?defines context [child] in
11043 | [child] -> Optional child :: parse_rng ?defines context rest
11045 failwithf "%s: <optional> contains more than one child element"
11048 | Xml.Element ("choice", [], children) :: rest ->
11049 let values = List.map (
11050 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11052 failwithf "%s: can't handle anything except <value> in <choice>"
11056 :: parse_rng ?defines context rest
11057 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11058 Value value :: parse_rng ?defines context rest
11059 | Xml.Element ("text", [], []) :: rest ->
11060 Text :: parse_rng ?defines context rest
11061 | Xml.Element ("ref", ["name", name], []) :: rest ->
11062 (* Look up the reference. Because of limitations in this parser,
11063 * we can't handle arbitrarily nested <ref> yet. You can only
11064 * use <ref> from inside <start>.
11066 (match defines with
11068 failwithf "%s: contains <ref>, but no refs are defined yet" context
11070 let rng = StringMap.find name map in
11071 rng @ parse_rng ?defines context rest
11074 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11077 let xml = Xml.parse_file rng_input in
11079 | Xml.Element ("grammar", _,
11080 Xml.Element ("start", _, gram) :: defines) ->
11081 (* The <define/> elements are referenced in the <start> section,
11082 * so build a map of those first.
11084 let defines = List.fold_left (
11086 function Xml.Element ("define", ["name", name], defn) ->
11087 StringMap.add name defn map
11089 failwithf "%s: expected <define name=name/>" rng_input
11090 ) StringMap.empty defines in
11091 let defines = StringMap.mapi parse_rng defines in
11093 (* Parse the <start> clause, passing the defines. *)
11094 parse_rng ~defines "<start>" gram
11096 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11099 let name_of_field = function
11100 | Element (name, _) | Attribute (name, _)
11101 | ZeroOrMore (Element (name, _))
11102 | OneOrMore (Element (name, _))
11103 | Optional (Element (name, _)) -> name
11104 | Optional (Attribute (name, _)) -> name
11105 | Text -> (* an unnamed field in an element *)
11108 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11110 (* At the moment this function only generates OCaml types. However we
11111 * should parameterize it later so it can generate types/structs in a
11112 * variety of languages.
11114 let generate_types xs =
11115 (* A simple type is one that can be printed out directly, eg.
11116 * "string option". A complex type is one which has a name and has
11117 * to be defined via another toplevel definition, eg. a struct.
11119 * generate_type generates code for either simple or complex types.
11120 * In the simple case, it returns the string ("string option"). In
11121 * the complex case, it returns the name ("mountpoint"). In the
11122 * complex case it has to print out the definition before returning,
11123 * so it should only be called when we are at the beginning of a
11124 * new line (BOL context).
11126 let rec generate_type = function
11127 | Text -> (* string *)
11129 | Choice values -> (* [`val1|`val2|...] *)
11130 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11131 | ZeroOrMore rng -> (* <rng> list *)
11132 let t, is_simple = generate_type rng in
11133 t ^ " list (* 0 or more *)", is_simple
11134 | OneOrMore rng -> (* <rng> list *)
11135 let t, is_simple = generate_type rng in
11136 t ^ " list (* 1 or more *)", is_simple
11137 (* virt-inspector hack: bool *)
11138 | Optional (Attribute (name, [Value "1"])) ->
11140 | Optional rng -> (* <rng> list *)
11141 let t, is_simple = generate_type rng in
11142 t ^ " option", is_simple
11143 (* type name = { fields ... } *)
11144 | Element (name, fields) when is_attrs_interleave fields ->
11145 generate_type_struct name (get_attrs_interleave fields)
11146 | Element (name, [field]) (* type name = field *)
11147 | Attribute (name, [field]) ->
11148 let t, is_simple = generate_type field in
11149 if is_simple then (t, true)
11151 pr "type %s = %s\n" name t;
11154 | Element (name, fields) -> (* type name = { fields ... } *)
11155 generate_type_struct name fields
11157 failwithf "generate_type failed at: %s" (string_of_rng rng)
11159 and is_attrs_interleave = function
11160 | [Interleave _] -> true
11161 | Attribute _ :: fields -> is_attrs_interleave fields
11162 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11165 and get_attrs_interleave = function
11166 | [Interleave fields] -> fields
11167 | ((Attribute _) as field) :: fields
11168 | ((Optional (Attribute _)) as field) :: fields ->
11169 field :: get_attrs_interleave fields
11170 | _ -> assert false
11172 and generate_types xs =
11173 List.iter (fun x -> ignore (generate_type x)) xs
11175 and generate_type_struct name fields =
11176 (* Calculate the types of the fields first. We have to do this
11177 * before printing anything so we are still in BOL context.
11179 let types = List.map fst (List.map generate_type fields) in
11181 (* Special case of a struct containing just a string and another
11182 * field. Turn it into an assoc list.
11185 | ["string"; other] ->
11186 let fname1, fname2 =
11188 | [f1; f2] -> name_of_field f1, name_of_field f2
11189 | _ -> assert false in
11190 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11194 pr "type %s = {\n" name;
11196 fun (field, ftype) ->
11197 let fname = name_of_field field in
11198 pr " %s_%s : %s;\n" name fname ftype
11199 ) (List.combine fields types);
11201 (* Return the name of this type, and
11202 * false because it's not a simple type.
11209 let generate_parsers xs =
11210 (* As for generate_type above, generate_parser makes a parser for
11211 * some type, and returns the name of the parser it has generated.
11212 * Because it (may) need to print something, it should always be
11213 * called in BOL context.
11215 let rec generate_parser = function
11216 | Text -> (* string *)
11217 "string_child_or_empty"
11218 | Choice values -> (* [`val1|`val2|...] *)
11219 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11221 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11222 | ZeroOrMore rng -> (* <rng> list *)
11223 let pa = generate_parser rng in
11224 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11225 | OneOrMore rng -> (* <rng> list *)
11226 let pa = generate_parser rng in
11227 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11228 (* virt-inspector hack: bool *)
11229 | Optional (Attribute (name, [Value "1"])) ->
11230 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11231 | Optional rng -> (* <rng> list *)
11232 let pa = generate_parser rng in
11233 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11234 (* type name = { fields ... } *)
11235 | Element (name, fields) when is_attrs_interleave fields ->
11236 generate_parser_struct name (get_attrs_interleave fields)
11237 | Element (name, [field]) -> (* type name = field *)
11238 let pa = generate_parser field in
11239 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11240 pr "let %s =\n" parser_name;
11242 pr "let parse_%s = %s\n" name parser_name;
11244 | Attribute (name, [field]) ->
11245 let pa = generate_parser field in
11246 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11247 pr "let %s =\n" parser_name;
11249 pr "let parse_%s = %s\n" name parser_name;
11251 | Element (name, fields) -> (* type name = { fields ... } *)
11252 generate_parser_struct name ([], fields)
11254 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11256 and is_attrs_interleave = function
11257 | [Interleave _] -> true
11258 | Attribute _ :: fields -> is_attrs_interleave fields
11259 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11262 and get_attrs_interleave = function
11263 | [Interleave fields] -> [], fields
11264 | ((Attribute _) as field) :: fields
11265 | ((Optional (Attribute _)) as field) :: fields ->
11266 let attrs, interleaves = get_attrs_interleave fields in
11267 (field :: attrs), interleaves
11268 | _ -> assert false
11270 and generate_parsers xs =
11271 List.iter (fun x -> ignore (generate_parser x)) xs
11273 and generate_parser_struct name (attrs, interleaves) =
11274 (* Generate parsers for the fields first. We have to do this
11275 * before printing anything so we are still in BOL context.
11277 let fields = attrs @ interleaves in
11278 let pas = List.map generate_parser fields in
11280 (* Generate an intermediate tuple from all the fields first.
11281 * If the type is just a string + another field, then we will
11282 * return this directly, otherwise it is turned into a record.
11284 * RELAX NG note: This code treats <interleave> and plain lists of
11285 * fields the same. In other words, it doesn't bother enforcing
11286 * any ordering of fields in the XML.
11288 pr "let parse_%s x =\n" name;
11289 pr " let t = (\n ";
11290 let comma = ref false in
11293 if !comma then pr ",\n ";
11296 | Optional (Attribute (fname, [field])), pa ->
11298 | Optional (Element (fname, [field])), pa ->
11299 pr "%s (optional_child %S x)" pa fname
11300 | Attribute (fname, [Text]), _ ->
11301 pr "attribute %S x" fname
11302 | (ZeroOrMore _ | OneOrMore _), pa ->
11307 let fname = name_of_field field in
11308 pr "%s (child %S x)" pa fname
11309 ) (List.combine fields pas);
11313 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11317 pr " (Obj.magic t : %s)\n" name
11321 | (Optional (Attribute (fname, [field])), pa) ->
11322 pr " %s_%s =\n" name fname;
11324 | (Optional (Element (fname, [field])), pa) ->
11325 pr " %s_%s =\n" name fname;
11326 pr " (let x = optional_child %S x in\n" fname;
11329 let fname = name_of_field field in
11330 pr " %s_%s =\n" name fname;
11331 pr " (let x = child %S x in\n" fname;
11333 ) (List.combine fields pas);
11337 sprintf "parse_%s" name
11340 generate_parsers xs
11342 (* Generate ocaml/guestfs_inspector.mli. *)
11343 let generate_ocaml_inspector_mli () =
11344 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11347 (** This is an OCaml language binding to the external [virt-inspector]
11350 For more information, please read the man page [virt-inspector(1)].
11355 generate_types grammar;
11356 pr "(** The nested information returned from the {!inspect} function. *)\n";
11360 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11361 (** To inspect a libvirt domain called [name], pass a singleton
11362 list: [inspect [name]]. When using libvirt only, you may
11363 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11365 To inspect a disk image or images, pass a list of the filenames
11366 of the disk images: [inspect filenames]
11368 This function inspects the given guest or disk images and
11369 returns a list of operating system(s) found and a large amount
11370 of information about them. In the vast majority of cases,
11371 a virtual machine only contains a single operating system.
11373 If the optional [~xml] parameter is given, then this function
11374 skips running the external virt-inspector program and just
11375 parses the given XML directly (which is expected to be XML
11376 produced from a previous run of virt-inspector). The list of
11377 names and connect URI are ignored in this case.
11379 This function can throw a wide variety of exceptions, for example
11380 if the external virt-inspector program cannot be found, or if
11381 it doesn't generate valid XML.
11385 (* Generate ocaml/guestfs_inspector.ml. *)
11386 let generate_ocaml_inspector_ml () =
11387 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11392 generate_types grammar;
11396 (* Misc functions which are used by the parser code below. *)
11397 let first_child = function
11398 | Xml.Element (_, _, c::_) -> c
11399 | Xml.Element (name, _, []) ->
11400 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11401 | Xml.PCData str ->
11402 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11404 let string_child_or_empty = function
11405 | Xml.Element (_, _, [Xml.PCData s]) -> s
11406 | Xml.Element (_, _, []) -> \"\"
11407 | Xml.Element (x, _, _) ->
11408 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11410 | Xml.PCData str ->
11411 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11413 let optional_child name xml =
11414 let children = Xml.children xml in
11416 Some (List.find (function
11417 | Xml.Element (n, _, _) when n = name -> true
11418 | _ -> false) children)
11422 let child name xml =
11423 match optional_child name xml with
11426 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11428 let attribute name xml =
11429 try Xml.attrib xml name
11430 with Xml.No_attribute _ ->
11431 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11435 generate_parsers grammar;
11439 (* Run external virt-inspector, then use parser to parse the XML. *)
11440 let inspect ?connect ?xml names =
11444 if names = [] then invalid_arg \"inspect: no names given\";
11445 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11446 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11448 let cmd = List.map Filename.quote cmd in
11449 let cmd = String.concat \" \" cmd in
11450 let chan = open_process_in cmd in
11451 let xml = Xml.parse_in chan in
11452 (match close_process_in chan with
11454 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11455 | WSIGNALED i | WSTOPPED i ->
11456 failwith (\"external virt-inspector command died or stopped on sig \" ^
11461 Xml.parse_string doc in
11462 parse_operatingsystems xml
11465 (* This is used to generate the src/MAX_PROC_NR file which
11466 * contains the maximum procedure number, a surrogate for the
11467 * ABI version number. See src/Makefile.am for the details.
11469 and generate_max_proc_nr () =
11470 let proc_nrs = List.map (
11471 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11472 ) daemon_functions in
11474 let max_proc_nr = List.fold_left max 0 proc_nrs in
11476 pr "%d\n" max_proc_nr
11478 let output_to filename k =
11479 let filename_new = filename ^ ".new" in
11480 chan := open_out filename_new;
11483 chan := Pervasives.stdout;
11485 (* Is the new file different from the current file? *)
11486 if Sys.file_exists filename && files_equal filename filename_new then
11487 unlink filename_new (* same, so skip it *)
11489 (* different, overwrite old one *)
11490 (try chmod filename 0o644 with Unix_error _ -> ());
11491 rename filename_new filename;
11492 chmod filename 0o444;
11493 printf "written %s\n%!" filename;
11496 let perror msg = function
11497 | Unix_error (err, _, _) ->
11498 eprintf "%s: %s\n" msg (error_message err)
11500 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11502 (* Main program. *)
11505 try openfile "HACKING" [O_RDWR] 0
11507 | Unix_error (ENOENT, _, _) ->
11509 You are probably running this from the wrong directory.
11510 Run it from the top source directory using the command
11515 perror "open: HACKING" exn;
11518 (* Acquire a lock so parallel builds won't try to run the generator
11519 * twice at the same time. Subsequent builds will wait for the first
11520 * one to finish. Note the lock is released implicitly when the
11523 (try lockf lock_fd F_LOCK 1
11525 perror "lock: HACKING" exn;
11528 check_functions ();
11530 output_to "src/guestfs_protocol.x" generate_xdr;
11531 output_to "src/guestfs-structs.h" generate_structs_h;
11532 output_to "src/guestfs-actions.h" generate_actions_h;
11533 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11534 output_to "src/guestfs-actions.c" generate_client_actions;
11535 output_to "src/guestfs-bindtests.c" generate_bindtests;
11536 output_to "src/guestfs-structs.pod" generate_structs_pod;
11537 output_to "src/guestfs-actions.pod" generate_actions_pod;
11538 output_to "src/guestfs-availability.pod" generate_availability_pod;
11539 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11540 output_to "src/libguestfs.syms" generate_linker_script;
11541 output_to "daemon/actions.h" generate_daemon_actions_h;
11542 output_to "daemon/stubs.c" generate_daemon_actions;
11543 output_to "daemon/names.c" generate_daemon_names;
11544 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11545 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11546 output_to "capitests/tests.c" generate_tests;
11547 output_to "fish/cmds.c" generate_fish_cmds;
11548 output_to "fish/completion.c" generate_fish_completion;
11549 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11550 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11551 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11552 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11553 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11554 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11555 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11556 output_to "perl/Guestfs.xs" generate_perl_xs;
11557 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11558 output_to "perl/bindtests.pl" generate_perl_bindtests;
11559 output_to "python/guestfs-py.c" generate_python_c;
11560 output_to "python/guestfs.py" generate_python_py;
11561 output_to "python/bindtests.py" generate_python_bindtests;
11562 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11563 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11564 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11568 let cols = cols_of_struct typ in
11569 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11570 output_to filename (generate_java_struct jtyp cols);
11573 output_to "java/Makefile.inc" generate_java_makefile_inc;
11574 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11575 output_to "java/Bindtests.java" generate_java_bindtests;
11576 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11577 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11578 output_to "csharp/Libguestfs.cs" generate_csharp;
11580 (* Always generate this file last, and unconditionally. It's used
11581 * by the Makefile to know when we must re-run the generator.
11583 let chan = open_out "src/stamp-generator" in
11584 fprintf chan "1\n";
11587 printf "generated %d lines of code\n" !lines