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 #load "xml-light.cma";;
50 type style = ret * args
52 (* "RErr" as a return value means an int used as a simple error
53 * indication, ie. 0 or -1.
57 (* "RInt" as a return value means an int which is -1 for error
58 * or any value >= 0 on success. Only use this for smallish
59 * positive ints (0 <= i < 2^30).
63 (* "RInt64" is the same as RInt, but is guaranteed to be able
64 * to return a full 64 bit value, _except_ that -1 means error
65 * (so -1 cannot be a valid, non-error return value).
69 (* "RBool" is a bool return value which can be true/false or
74 (* "RConstString" is a string that refers to a constant value.
75 * The return value must NOT be NULL (since NULL indicates
78 * Try to avoid using this. In particular you cannot use this
79 * for values returned from the daemon, because there is no
80 * thread-safe way to return them in the C API.
82 | RConstString of string
84 (* "RConstOptString" is an even more broken version of
85 * "RConstString". The returned string may be NULL and there
86 * is no way to return an error indication. Avoid using this!
88 | RConstOptString of string
90 (* "RString" is a returned string. It must NOT be NULL, since
91 * a NULL return indicates an error. The caller frees this.
95 (* "RStringList" is a list of strings. No string in the list
96 * can be NULL. The caller frees the strings and the array.
98 | RStringList of string
100 (* "RStruct" is a function which returns a single named structure
101 * or an error indication (in C, a struct, and in other languages
102 * with varying representations, but usually very efficient). See
103 * after the function list below for the structures.
105 | RStruct of string * string (* name of retval, name of struct *)
107 (* "RStructList" is a function which returns either a list/array
108 * of structures (could be zero-length), or an error indication.
110 | RStructList of string * string (* name of retval, name of struct *)
112 (* Key-value pairs of untyped strings. Turns into a hashtable or
113 * dictionary in languages which support it. DON'T use this as a
114 * general "bucket" for results. Prefer a stronger typed return
115 * value if one is available, or write a custom struct. Don't use
116 * this if the list could potentially be very long, since it is
117 * inefficient. Keys should be unique. NULLs are not permitted.
119 | RHashtable of string
121 (* "RBufferOut" is handled almost exactly like RString, but
122 * it allows the string to contain arbitrary 8 bit data including
123 * ASCII NUL. In the C API this causes an implicit extra parameter
124 * to be added of type <size_t *size_r>. The extra parameter
125 * returns the actual size of the return buffer in bytes.
127 * Other programming languages support strings with arbitrary 8 bit
130 * At the RPC layer we have to use the opaque<> type instead of
131 * string<>. Returned data is still limited to the max message
134 | RBufferOut of string
136 and args = argt list (* Function parameters, guestfs handle is implicit. *)
138 (* Note in future we should allow a "variable args" parameter as
139 * the final parameter, to allow commands like
140 * chmod mode file [file(s)...]
141 * This is not implemented yet, but many commands (such as chmod)
142 * are currently defined with the argument order keeping this future
143 * possibility in mind.
146 | String of string (* const char *name, cannot be NULL *)
147 | Device of string (* /dev device name, cannot be NULL *)
148 | Pathname of string (* file name, cannot be NULL *)
149 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
150 | OptString of string (* const char *name, may be NULL *)
151 | StringList of string(* list of strings (each string cannot be NULL) *)
152 | DeviceList of string(* list of Device names (each cannot be NULL) *)
153 | Bool of string (* boolean *)
154 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
155 | Int64 of string (* any 64 bit int *)
156 (* These are treated as filenames (simple string parameters) in
157 * the C API and bindings. But in the RPC protocol, we transfer
158 * the actual file content up to or down from the daemon.
159 * FileIn: local machine -> daemon (in request)
160 * FileOut: daemon -> local machine (in reply)
161 * In guestfish (only), the special name "-" means read from
162 * stdin or write to stdout.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <char *, int> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
180 | ProtocolLimitWarning (* display warning about protocol size limits *)
181 | DangerWillRobinson (* flags particularly dangerous commands *)
182 | FishAlias of string (* provide an alias for this cmd in guestfish *)
183 | FishAction of string (* call this function in guestfish *)
184 | NotInFish (* do not export via guestfish *)
185 | NotInDocs (* do not add this function to documentation *)
186 | DeprecatedBy of string (* function is deprecated, use .. instead *)
187 | Optional of string (* function is part of an optional group *)
189 (* You can supply zero or as many tests as you want per API call.
191 * Note that the test environment has 3 block devices, of size 500MB,
192 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
193 * a fourth ISO block device with some known files on it (/dev/sdd).
195 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
196 * Number of cylinders was 63 for IDE emulated disks with precisely
197 * the same size. How exactly this is calculated is a mystery.
199 * The ISO block device (/dev/sdd) comes from images/test.iso.
201 * To be able to run the tests in a reasonable amount of time,
202 * the virtual machine and block devices are reused between tests.
203 * So don't try testing kill_subprocess :-x
205 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
207 * Don't assume anything about the previous contents of the block
208 * devices. Use 'Init*' to create some initial scenarios.
210 * You can add a prerequisite clause to any individual test. This
211 * is a run-time check, which, if it fails, causes the test to be
212 * skipped. Useful if testing a command which might not work on
213 * all variations of libguestfs builds. A test that has prerequisite
214 * of 'Always' is run unconditionally.
216 * In addition, packagers can skip individual tests by setting the
217 * environment variables: eg:
218 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
219 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
221 type tests = (test_init * test_prereq * test) list
223 (* Run the command sequence and just expect nothing to fail. *)
226 (* Run the command sequence and expect the output of the final
227 * command to be the string.
229 | TestOutput of seq * string
231 (* Run the command sequence and expect the output of the final
232 * command to be the list of strings.
234 | TestOutputList of seq * string list
236 (* Run the command sequence and expect the output of the final
237 * command to be the list of block devices (could be either
238 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
239 * character of each string).
241 | TestOutputListOfDevices of seq * string list
243 (* Run the command sequence and expect the output of the final
244 * command to be the integer.
246 | TestOutputInt of seq * int
248 (* Run the command sequence and expect the output of the final
249 * command to be <op> <int>, eg. ">=", "1".
251 | TestOutputIntOp of seq * string * int
253 (* Run the command sequence and expect the output of the final
254 * command to be a true value (!= 0 or != NULL).
256 | TestOutputTrue of seq
258 (* Run the command sequence and expect the output of the final
259 * command to be a false value (== 0 or == NULL, but not an error).
261 | TestOutputFalse of seq
263 (* Run the command sequence and expect the output of the final
264 * command to be a list of the given length (but don't care about
267 | TestOutputLength of seq * int
269 (* Run the command sequence and expect the output of the final
270 * command to be a buffer (RBufferOut), ie. string + size.
272 | TestOutputBuffer of seq * string
274 (* Run the command sequence and expect the output of the final
275 * command to be a structure.
277 | TestOutputStruct of seq * test_field_compare list
279 (* Run the command sequence and expect the final command (only)
282 | TestLastFail of seq
284 and test_field_compare =
285 | CompareWithInt of string * int
286 | CompareWithIntOp of string * string * int
287 | CompareWithString of string * string
288 | CompareFieldsIntEq of string * string
289 | CompareFieldsStrEq of string * string
291 (* Test prerequisites. *)
293 (* Test always runs. *)
296 (* Test is currently disabled - eg. it fails, or it tests some
297 * unimplemented feature.
301 (* 'string' is some C code (a function body) that should return
302 * true or false. The test will run if the code returns true.
306 (* As for 'If' but the test runs _unless_ the code returns true. *)
309 (* Some initial scenarios for testing. *)
311 (* Do nothing, block devices could contain random stuff including
312 * LVM PVs, and some filesystems might be mounted. This is usually
317 (* Block devices are empty and no filesystems are mounted. *)
320 (* /dev/sda contains a single partition /dev/sda1, with random
321 * content. /dev/sdb and /dev/sdc may have random content.
326 (* /dev/sda contains a single partition /dev/sda1, which is formatted
327 * as ext2, empty [except for lost+found] and mounted on /.
328 * /dev/sdb and /dev/sdc may have random content.
334 * /dev/sda1 (is a PV):
335 * /dev/VG/LV (size 8MB):
336 * formatted as ext2, empty [except for lost+found], mounted on /
337 * /dev/sdb and /dev/sdc may have random content.
341 (* /dev/sdd (the ISO, see images/ directory in source)
346 (* Sequence of commands for testing. *)
348 and cmd = string list
350 (* Note about long descriptions: When referring to another
351 * action, use the format C<guestfs_other> (ie. the full name of
352 * the C function). This will be replaced as appropriate in other
355 * Apart from that, long descriptions are just perldoc paragraphs.
358 (* Generate a random UUID (used in tests). *)
360 let chan = open_process_in "uuidgen" in
361 let uuid = input_line chan in
362 (match close_process_in chan with
365 failwith "uuidgen: process exited with non-zero status"
366 | WSIGNALED _ | WSTOPPED _ ->
367 failwith "uuidgen: process signalled or stopped by signal"
371 (* These test functions are used in the language binding tests. *)
373 let test_all_args = [
376 StringList "strlist";
384 let test_all_rets = [
385 (* except for RErr, which is tested thoroughly elsewhere *)
386 "test0rint", RInt "valout";
387 "test0rint64", RInt64 "valout";
388 "test0rbool", RBool "valout";
389 "test0rconststring", RConstString "valout";
390 "test0rconstoptstring", RConstOptString "valout";
391 "test0rstring", RString "valout";
392 "test0rstringlist", RStringList "valout";
393 "test0rstruct", RStruct ("valout", "lvm_pv");
394 "test0rstructlist", RStructList ("valout", "lvm_pv");
395 "test0rhashtable", RHashtable "valout";
398 let test_functions = [
399 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
401 "internal test function - do not use",
403 This is an internal test function which is used to test whether
404 the automatically generated bindings can handle every possible
405 parameter type correctly.
407 It echos the contents of each parameter to stdout.
409 You probably don't want to call this function.");
413 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
415 "internal test function - do not use",
417 This is an internal test function which is used to test whether
418 the automatically generated bindings can handle every possible
419 return type correctly.
421 It converts string C<val> to the return type.
423 You probably don't want to call this function.");
424 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
426 "internal test function - do not use",
428 This is an internal test function which is used to test whether
429 the automatically generated bindings can handle every possible
430 return type correctly.
432 This function always returns an error.
434 You probably don't want to call this function.")]
438 (* non_daemon_functions are any functions which don't get processed
439 * in the daemon, eg. functions for setting and getting local
440 * configuration values.
443 let non_daemon_functions = test_functions @ [
444 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
446 "launch the qemu subprocess",
448 Internally libguestfs is implemented by running a virtual machine
451 You should call this after configuring the handle
452 (eg. adding drives) but before performing any actions.");
454 ("wait_ready", (RErr, []), -1, [NotInFish],
456 "wait until the qemu subprocess launches (no op)",
458 This function is a no op.
460 In versions of the API E<lt> 1.0.71 you had to call this function
461 just after calling C<guestfs_launch> to wait for the launch
462 to complete. However this is no longer necessary because
463 C<guestfs_launch> now does the waiting.
465 If you see any calls to this function in code then you can just
466 remove them, unless you want to retain compatibility with older
467 versions of the API.");
469 ("kill_subprocess", (RErr, []), -1, [],
471 "kill the qemu subprocess",
473 This kills the qemu subprocess. You should never need to call this.");
475 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
477 "add an image to examine or modify",
479 This function adds a virtual machine disk image C<filename> to the
480 guest. The first time you call this function, the disk appears as IDE
481 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
484 You don't necessarily need to be root when using libguestfs. However
485 you obviously do need sufficient permissions to access the filename
486 for whatever operations you want to perform (ie. read access if you
487 just want to read the image or write access if you want to modify the
490 This is equivalent to the qemu parameter
491 C<-drive file=filename,cache=off,if=...>.
492 C<cache=off> is omitted in cases where it is not supported by
493 the underlying filesystem.
495 Note that this call checks for the existence of C<filename>. This
496 stops you from specifying other types of drive which are supported
497 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
498 the general C<guestfs_config> call instead.");
500 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
502 "add a CD-ROM disk image to examine",
504 This function adds a virtual CD-ROM disk image to the guest.
506 This is equivalent to the qemu parameter C<-cdrom filename>.
508 Note that this call checks for the existence of C<filename>. This
509 stops you from specifying other types of drive which are supported
510 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
511 the general C<guestfs_config> call instead.");
513 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
515 "add a drive in snapshot mode (read-only)",
517 This adds a drive in snapshot mode, making it effectively
520 Note that writes to the device are allowed, and will be seen for
521 the duration of the guestfs handle, but they are written
522 to a temporary file which is discarded as soon as the guestfs
523 handle is closed. We don't currently have any method to enable
524 changes to be committed, although qemu can support this.
526 This is equivalent to the qemu parameter
527 C<-drive file=filename,snapshot=on,if=...>.
529 Note that this call checks for the existence of C<filename>. This
530 stops you from specifying other types of drive which are supported
531 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
532 the general C<guestfs_config> call instead.");
534 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
536 "add qemu parameters",
538 This can be used to add arbitrary qemu command line parameters
539 of the form C<-param value>. Actually it's not quite arbitrary - we
540 prevent you from setting some parameters which would interfere with
541 parameters that we use.
543 The first character of C<param> string must be a C<-> (dash).
545 C<value> can be NULL.");
547 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
549 "set the qemu binary",
551 Set the qemu binary that we will use.
553 The default is chosen when the library was compiled by the
556 You can also override this by setting the C<LIBGUESTFS_QEMU>
557 environment variable.
559 Setting C<qemu> to C<NULL> restores the default qemu binary.");
561 ("get_qemu", (RConstString "qemu", []), -1, [],
562 [InitNone, Always, TestRun (
564 "get the qemu binary",
566 Return the current qemu binary.
568 This is always non-NULL. If it wasn't set already, then this will
569 return the default qemu binary name.");
571 ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
573 "set the search path",
575 Set the path that libguestfs searches for kernel and initrd.img.
577 The default is C<$libdir/guestfs> unless overridden by setting
578 C<LIBGUESTFS_PATH> environment variable.
580 Setting C<path> to C<NULL> restores the default path.");
582 ("get_path", (RConstString "path", []), -1, [],
583 [InitNone, Always, TestRun (
585 "get the search path",
587 Return the current search path.
589 This is always non-NULL. If it wasn't set already, then this will
590 return the default path.");
592 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
594 "add options to kernel command line",
596 This function is used to add additional options to the
597 guest kernel command line.
599 The default is C<NULL> unless overridden by setting
600 C<LIBGUESTFS_APPEND> environment variable.
602 Setting C<append> to C<NULL> means I<no> additional options
603 are passed (libguestfs always adds a few of its own).");
605 ("get_append", (RConstOptString "append", []), -1, [],
606 (* This cannot be tested with the current framework. The
607 * function can return NULL in normal operations, which the
608 * test framework interprets as an error.
611 "get the additional kernel options",
613 Return the additional kernel options which are added to the
614 guest kernel command line.
616 If C<NULL> then no options are added.");
618 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
622 If C<autosync> is true, this enables autosync. Libguestfs will make a
623 best effort attempt to run C<guestfs_umount_all> followed by
624 C<guestfs_sync> when the handle is closed
625 (also if the program exits without closing handles).
627 This is disabled by default (except in guestfish where it is
628 enabled by default).");
630 ("get_autosync", (RBool "autosync", []), -1, [],
631 [InitNone, Always, TestRun (
632 [["get_autosync"]])],
635 Get the autosync flag.");
637 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
641 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
643 Verbose messages are disabled unless the environment variable
644 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
646 ("get_verbose", (RBool "verbose", []), -1, [],
650 This returns the verbose messages flag.");
652 ("is_ready", (RBool "ready", []), -1, [],
653 [InitNone, Always, TestOutputTrue (
655 "is ready to accept commands",
657 This returns true iff this handle is ready to accept commands
658 (in the C<READY> state).
660 For more information on states, see L<guestfs(3)>.");
662 ("is_config", (RBool "config", []), -1, [],
663 [InitNone, Always, TestOutputFalse (
665 "is in configuration state",
667 This returns true iff this handle is being configured
668 (in the C<CONFIG> state).
670 For more information on states, see L<guestfs(3)>.");
672 ("is_launching", (RBool "launching", []), -1, [],
673 [InitNone, Always, TestOutputFalse (
674 [["is_launching"]])],
675 "is launching subprocess",
677 This returns true iff this handle is launching the subprocess
678 (in the C<LAUNCHING> state).
680 For more information on states, see L<guestfs(3)>.");
682 ("is_busy", (RBool "busy", []), -1, [],
683 [InitNone, Always, TestOutputFalse (
685 "is busy processing a command",
687 This returns true iff this handle is busy processing a command
688 (in the C<BUSY> state).
690 For more information on states, see L<guestfs(3)>.");
692 ("get_state", (RInt "state", []), -1, [],
694 "get the current state",
696 This returns the current state as an opaque integer. This is
697 only useful for printing debug and internal error messages.
699 For more information on states, see L<guestfs(3)>.");
701 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
702 [InitNone, Always, TestOutputInt (
703 [["set_memsize"; "500"];
704 ["get_memsize"]], 500)],
705 "set memory allocated to the qemu subprocess",
707 This sets the memory size in megabytes allocated to the
708 qemu subprocess. This only has any effect if called before
711 You can also change this by setting the environment
712 variable C<LIBGUESTFS_MEMSIZE> before the handle is
715 For more information on the architecture of libguestfs,
716 see L<guestfs(3)>.");
718 ("get_memsize", (RInt "memsize", []), -1, [],
719 [InitNone, Always, TestOutputIntOp (
720 [["get_memsize"]], ">=", 256)],
721 "get memory allocated to the qemu subprocess",
723 This gets the memory size in megabytes allocated to the
726 If C<guestfs_set_memsize> was not called
727 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
728 then this returns the compiled-in default value for memsize.
730 For more information on the architecture of libguestfs,
731 see L<guestfs(3)>.");
733 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
734 [InitNone, Always, TestOutputIntOp (
735 [["get_pid"]], ">=", 1)],
736 "get PID of qemu subprocess",
738 Return the process ID of the qemu subprocess. If there is no
739 qemu subprocess, then this will return an error.
741 This is an internal call used for debugging and testing.");
743 ("version", (RStruct ("version", "version"), []), -1, [],
744 [InitNone, Always, TestOutputStruct (
745 [["version"]], [CompareWithInt ("major", 1)])],
746 "get the library version number",
748 Return the libguestfs version number that the program is linked
751 Note that because of dynamic linking this is not necessarily
752 the version of libguestfs that you compiled against. You can
753 compile the program, and then at runtime dynamically link
754 against a completely different C<libguestfs.so> library.
756 This call was added in version C<1.0.58>. In previous
757 versions of libguestfs there was no way to get the version
758 number. From C code you can use ELF weak linking tricks to find out if
759 this symbol exists (if it doesn't, then it's an earlier version).
761 The call returns a structure with four elements. The first
762 three (C<major>, C<minor> and C<release>) are numbers and
763 correspond to the usual version triplet. The fourth element
764 (C<extra>) is a string and is normally empty, but may be
765 used for distro-specific information.
767 To construct the original version string:
768 C<$major.$minor.$release$extra>
770 I<Note:> Don't use this call to test for availability
771 of features. Distro backports makes this unreliable. Use
772 C<guestfs_available> instead.");
774 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
775 [InitNone, Always, TestOutputTrue (
776 [["set_selinux"; "true"];
778 "set SELinux enabled or disabled at appliance boot",
780 This sets the selinux flag that is passed to the appliance
781 at boot time. The default is C<selinux=0> (disabled).
783 Note that if SELinux is enabled, it is always in
784 Permissive mode (C<enforcing=0>).
786 For more information on the architecture of libguestfs,
787 see L<guestfs(3)>.");
789 ("get_selinux", (RBool "selinux", []), -1, [],
791 "get SELinux enabled flag",
793 This returns the current setting of the selinux flag which
794 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
796 For more information on the architecture of libguestfs,
797 see L<guestfs(3)>.");
799 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
800 [InitNone, Always, TestOutputFalse (
801 [["set_trace"; "false"];
803 "enable or disable command traces",
805 If the command trace flag is set to 1, then commands are
806 printed on stdout before they are executed in a format
807 which is very similar to the one used by guestfish. In
808 other words, you can run a program with this enabled, and
809 you will get out a script which you can feed to guestfish
810 to perform the same set of actions.
812 If you want to trace C API calls into libguestfs (and
813 other libraries) then possibly a better way is to use
814 the external ltrace(1) command.
816 Command traces are disabled unless the environment variable
817 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
819 ("get_trace", (RBool "trace", []), -1, [],
821 "get command trace enabled flag",
823 Return the command trace flag.");
825 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
826 [InitNone, Always, TestOutputFalse (
827 [["set_direct"; "false"];
829 "enable or disable direct appliance mode",
831 If the direct appliance mode flag is enabled, then stdin and
832 stdout are passed directly through to the appliance once it
835 One consequence of this is that log messages aren't caught
836 by the library and handled by C<guestfs_set_log_message_callback>,
837 but go straight to stdout.
839 You probably don't want to use this unless you know what you
842 The default is disabled.");
844 ("get_direct", (RBool "direct", []), -1, [],
846 "get direct appliance mode flag",
848 Return the direct appliance mode flag.");
850 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
851 [InitNone, Always, TestOutputTrue (
852 [["set_recovery_proc"; "true"];
853 ["get_recovery_proc"]])],
854 "enable or disable the recovery process",
856 If this is called with the parameter C<false> then
857 C<guestfs_launch> does not create a recovery process. The
858 purpose of the recovery process is to stop runaway qemu
859 processes in the case where the main program aborts abruptly.
861 This only has any effect if called before C<guestfs_launch>,
862 and the default is true.
864 About the only time when you would want to disable this is
865 if the main process will fork itself into the background
866 (\"daemonize\" itself). In this case the recovery process
867 thinks that the main program has disappeared and so kills
868 qemu, which is not very helpful.");
870 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
872 "get recovery process enabled flag",
874 Return the recovery process enabled flag.");
878 (* daemon_functions are any functions which cause some action
879 * to take place in the daemon.
882 let daemon_functions = [
883 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
884 [InitEmpty, Always, TestOutput (
885 [["part_disk"; "/dev/sda"; "mbr"];
886 ["mkfs"; "ext2"; "/dev/sda1"];
887 ["mount"; "/dev/sda1"; "/"];
888 ["write_file"; "/new"; "new file contents"; "0"];
889 ["cat"; "/new"]], "new file contents")],
890 "mount a guest disk at a position in the filesystem",
892 Mount a guest disk at a position in the filesystem. Block devices
893 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
894 the guest. If those block devices contain partitions, they will have
895 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
898 The rules are the same as for L<mount(2)>: A filesystem must
899 first be mounted on C</> before others can be mounted. Other
900 filesystems can only be mounted on directories which already
903 The mounted filesystem is writable, if we have sufficient permissions
904 on the underlying device.
906 The filesystem options C<sync> and C<noatime> are set with this
907 call, in order to improve reliability.");
909 ("sync", (RErr, []), 2, [],
910 [ InitEmpty, Always, TestRun [["sync"]]],
911 "sync disks, writes are flushed through to the disk image",
913 This syncs the disk, so that any writes are flushed through to the
914 underlying disk image.
916 You should always call this if you have modified a disk image, before
917 closing the handle.");
919 ("touch", (RErr, [Pathname "path"]), 3, [],
920 [InitBasicFS, Always, TestOutputTrue (
922 ["exists"; "/new"]])],
923 "update file timestamps or create a new file",
925 Touch acts like the L<touch(1)> command. It can be used to
926 update the timestamps on a file, or, if the file does not exist,
927 to create a new zero-length file.");
929 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
930 [InitISOFS, Always, TestOutput (
931 [["cat"; "/known-2"]], "abcdef\n")],
932 "list the contents of a file",
934 Return the contents of the file named C<path>.
936 Note that this function cannot correctly handle binary files
937 (specifically, files containing C<\\0> character which is treated
938 as end of string). For those you need to use the C<guestfs_read_file>
939 or C<guestfs_download> functions which have a more complex interface.");
941 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
942 [], (* XXX Tricky to test because it depends on the exact format
943 * of the 'ls -l' command, which changes between F10 and F11.
945 "list the files in a directory (long format)",
947 List the files in C<directory> (relative to the root directory,
948 there is no cwd) in the format of 'ls -la'.
950 This command is mostly useful for interactive sessions. It
951 is I<not> intended that you try to parse the output string.");
953 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
954 [InitBasicFS, Always, TestOutputList (
957 ["touch"; "/newest"];
958 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
959 "list the files in a directory",
961 List the files in C<directory> (relative to the root directory,
962 there is no cwd). The '.' and '..' entries are not returned, but
963 hidden files are shown.
965 This command is mostly useful for interactive sessions. Programs
966 should probably use C<guestfs_readdir> instead.");
968 ("list_devices", (RStringList "devices", []), 7, [],
969 [InitEmpty, Always, TestOutputListOfDevices (
970 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
971 "list the block devices",
973 List all the block devices.
975 The full block device names are returned, eg. C</dev/sda>");
977 ("list_partitions", (RStringList "partitions", []), 8, [],
978 [InitBasicFS, Always, TestOutputListOfDevices (
979 [["list_partitions"]], ["/dev/sda1"]);
980 InitEmpty, Always, TestOutputListOfDevices (
981 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
982 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
983 "list the partitions",
985 List all the partitions detected on all block devices.
987 The full partition device names are returned, eg. C</dev/sda1>
989 This does not return logical volumes. For that you will need to
990 call C<guestfs_lvs>.");
992 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
993 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
994 [["pvs"]], ["/dev/sda1"]);
995 InitEmpty, Always, TestOutputListOfDevices (
996 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
997 ["pvcreate"; "/dev/sda1"];
998 ["pvcreate"; "/dev/sda2"];
999 ["pvcreate"; "/dev/sda3"];
1000 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1001 "list the LVM physical volumes (PVs)",
1003 List all the physical volumes detected. This is the equivalent
1004 of the L<pvs(8)> command.
1006 This returns a list of just the device names that contain
1007 PVs (eg. C</dev/sda2>).
1009 See also C<guestfs_pvs_full>.");
1011 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1012 [InitBasicFSonLVM, Always, TestOutputList (
1014 InitEmpty, Always, TestOutputList (
1015 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1016 ["pvcreate"; "/dev/sda1"];
1017 ["pvcreate"; "/dev/sda2"];
1018 ["pvcreate"; "/dev/sda3"];
1019 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1020 ["vgcreate"; "VG2"; "/dev/sda3"];
1021 ["vgs"]], ["VG1"; "VG2"])],
1022 "list the LVM volume groups (VGs)",
1024 List all the volumes groups detected. This is the equivalent
1025 of the L<vgs(8)> command.
1027 This returns a list of just the volume group names that were
1028 detected (eg. C<VolGroup00>).
1030 See also C<guestfs_vgs_full>.");
1032 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1033 [InitBasicFSonLVM, Always, TestOutputList (
1034 [["lvs"]], ["/dev/VG/LV"]);
1035 InitEmpty, Always, TestOutputList (
1036 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1037 ["pvcreate"; "/dev/sda1"];
1038 ["pvcreate"; "/dev/sda2"];
1039 ["pvcreate"; "/dev/sda3"];
1040 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1041 ["vgcreate"; "VG2"; "/dev/sda3"];
1042 ["lvcreate"; "LV1"; "VG1"; "50"];
1043 ["lvcreate"; "LV2"; "VG1"; "50"];
1044 ["lvcreate"; "LV3"; "VG2"; "50"];
1045 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1046 "list the LVM logical volumes (LVs)",
1048 List all the logical volumes detected. This is the equivalent
1049 of the L<lvs(8)> command.
1051 This returns a list of the logical volume device names
1052 (eg. C</dev/VolGroup00/LogVol00>).
1054 See also C<guestfs_lvs_full>.");
1056 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1057 [], (* XXX how to test? *)
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. The \"full\" version includes all fields.");
1063 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1064 [], (* XXX how to test? *)
1065 "list the LVM volume groups (VGs)",
1067 List all the volumes groups detected. This is the equivalent
1068 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1070 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1071 [], (* XXX how to test? *)
1072 "list the LVM logical volumes (LVs)",
1074 List all the logical volumes detected. This is the equivalent
1075 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1077 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1078 [InitISOFS, Always, TestOutputList (
1079 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1080 InitISOFS, Always, TestOutputList (
1081 [["read_lines"; "/empty"]], [])],
1082 "read file as lines",
1084 Return the contents of the file named C<path>.
1086 The file contents are returned as a list of lines. Trailing
1087 C<LF> and C<CRLF> character sequences are I<not> returned.
1089 Note that this function cannot correctly handle binary files
1090 (specifically, files containing C<\\0> character which is treated
1091 as end of line). For those you need to use the C<guestfs_read_file>
1092 function which has a more complex interface.");
1094 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1095 [], (* XXX Augeas code needs tests. *)
1096 "create a new Augeas handle",
1098 Create a new Augeas handle for editing configuration files.
1099 If there was any previous Augeas handle associated with this
1100 guestfs session, then it is closed.
1102 You must call this before using any other C<guestfs_aug_*>
1105 C<root> is the filesystem root. C<root> must not be NULL,
1108 The flags are the same as the flags defined in
1109 E<lt>augeas.hE<gt>, the logical I<or> of the following
1114 =item C<AUG_SAVE_BACKUP> = 1
1116 Keep the original file with a C<.augsave> extension.
1118 =item C<AUG_SAVE_NEWFILE> = 2
1120 Save changes into a file with extension C<.augnew>, and
1121 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1123 =item C<AUG_TYPE_CHECK> = 4
1125 Typecheck lenses (can be expensive).
1127 =item C<AUG_NO_STDINC> = 8
1129 Do not use standard load path for modules.
1131 =item C<AUG_SAVE_NOOP> = 16
1133 Make save a no-op, just record what would have been changed.
1135 =item C<AUG_NO_LOAD> = 32
1137 Do not load the tree in C<guestfs_aug_init>.
1141 To close the handle, you can call C<guestfs_aug_close>.
1143 To find out more about Augeas, see L<http://augeas.net/>.");
1145 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1146 [], (* XXX Augeas code needs tests. *)
1147 "close the current Augeas handle",
1149 Close the current Augeas handle and free up any resources
1150 used by it. After calling this, you have to call
1151 C<guestfs_aug_init> again before you can use any other
1152 Augeas functions.");
1154 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1155 [], (* XXX Augeas code needs tests. *)
1156 "define an Augeas variable",
1158 Defines an Augeas variable C<name> whose value is the result
1159 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1162 On success this returns the number of nodes in C<expr>, or
1163 C<0> if C<expr> evaluates to something which is not a nodeset.");
1165 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1166 [], (* XXX Augeas code needs tests. *)
1167 "define an Augeas node",
1169 Defines a variable C<name> whose value is the result of
1172 If C<expr> evaluates to an empty nodeset, a node is created,
1173 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1174 C<name> will be the nodeset containing that single node.
1176 On success this returns a pair containing the
1177 number of nodes in the nodeset, and a boolean flag
1178 if a node was created.");
1180 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1181 [], (* XXX Augeas code needs tests. *)
1182 "look up the value of an Augeas path",
1184 Look up the value associated with C<path>. If C<path>
1185 matches exactly one node, the C<value> is returned.");
1187 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1188 [], (* XXX Augeas code needs tests. *)
1189 "set Augeas path to value",
1191 Set the value associated with C<path> to C<value>.");
1193 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1194 [], (* XXX Augeas code needs tests. *)
1195 "insert a sibling Augeas node",
1197 Create a new sibling C<label> for C<path>, inserting it into
1198 the tree before or after C<path> (depending on the boolean
1201 C<path> must match exactly one existing node in the tree, and
1202 C<label> must be a label, ie. not contain C</>, C<*> or end
1203 with a bracketed index C<[N]>.");
1205 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1206 [], (* XXX Augeas code needs tests. *)
1207 "remove an Augeas path",
1209 Remove C<path> and all of its children.
1211 On success this returns the number of entries which were removed.");
1213 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1214 [], (* XXX Augeas code needs tests. *)
1217 Move the node C<src> to C<dest>. C<src> must match exactly
1218 one node. C<dest> is overwritten if it exists.");
1220 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1221 [], (* XXX Augeas code needs tests. *)
1222 "return Augeas nodes which match augpath",
1224 Returns a list of paths which match the path expression C<path>.
1225 The returned paths are sufficiently qualified so that they match
1226 exactly one node in the current tree.");
1228 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1229 [], (* XXX Augeas code needs tests. *)
1230 "write all pending Augeas changes to disk",
1232 This writes all pending changes to disk.
1234 The flags which were passed to C<guestfs_aug_init> affect exactly
1235 how files are saved.");
1237 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1238 [], (* XXX Augeas code needs tests. *)
1239 "load files into the tree",
1241 Load files into the tree.
1243 See C<aug_load> in the Augeas documentation for the full gory
1246 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1247 [], (* XXX Augeas code needs tests. *)
1248 "list Augeas nodes under augpath",
1250 This is just a shortcut for listing C<guestfs_aug_match>
1251 C<path/*> and sorting the resulting nodes into alphabetical order.");
1253 ("rm", (RErr, [Pathname "path"]), 29, [],
1254 [InitBasicFS, Always, TestRun
1257 InitBasicFS, Always, TestLastFail
1259 InitBasicFS, Always, TestLastFail
1264 Remove the single file C<path>.");
1266 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1267 [InitBasicFS, Always, TestRun
1270 InitBasicFS, Always, TestLastFail
1271 [["rmdir"; "/new"]];
1272 InitBasicFS, Always, TestLastFail
1274 ["rmdir"; "/new"]]],
1275 "remove a directory",
1277 Remove the single directory C<path>.");
1279 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1280 [InitBasicFS, Always, TestOutputFalse
1282 ["mkdir"; "/new/foo"];
1283 ["touch"; "/new/foo/bar"];
1285 ["exists"; "/new"]]],
1286 "remove a file or directory recursively",
1288 Remove the file or directory C<path>, recursively removing the
1289 contents if its a directory. This is like the C<rm -rf> shell
1292 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1293 [InitBasicFS, Always, TestOutputTrue
1295 ["is_dir"; "/new"]];
1296 InitBasicFS, Always, TestLastFail
1297 [["mkdir"; "/new/foo/bar"]]],
1298 "create a directory",
1300 Create a directory named C<path>.");
1302 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1303 [InitBasicFS, Always, TestOutputTrue
1304 [["mkdir_p"; "/new/foo/bar"];
1305 ["is_dir"; "/new/foo/bar"]];
1306 InitBasicFS, Always, TestOutputTrue
1307 [["mkdir_p"; "/new/foo/bar"];
1308 ["is_dir"; "/new/foo"]];
1309 InitBasicFS, Always, TestOutputTrue
1310 [["mkdir_p"; "/new/foo/bar"];
1311 ["is_dir"; "/new"]];
1312 (* Regression tests for RHBZ#503133: *)
1313 InitBasicFS, Always, TestRun
1315 ["mkdir_p"; "/new"]];
1316 InitBasicFS, Always, TestLastFail
1318 ["mkdir_p"; "/new"]]],
1319 "create a directory and parents",
1321 Create a directory named C<path>, creating any parent directories
1322 as necessary. This is like the C<mkdir -p> shell command.");
1324 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1325 [], (* XXX Need stat command to test *)
1328 Change the mode (permissions) of C<path> to C<mode>. Only
1329 numeric modes are supported.");
1331 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1332 [], (* XXX Need stat command to test *)
1333 "change file owner and group",
1335 Change the file owner to C<owner> and group to C<group>.
1337 Only numeric uid and gid are supported. If you want to use
1338 names, you will need to locate and parse the password file
1339 yourself (Augeas support makes this relatively easy).");
1341 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1342 [InitISOFS, Always, TestOutputTrue (
1343 [["exists"; "/empty"]]);
1344 InitISOFS, Always, TestOutputTrue (
1345 [["exists"; "/directory"]])],
1346 "test if file or directory exists",
1348 This returns C<true> if and only if there is a file, directory
1349 (or anything) with the given C<path> name.
1351 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1353 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1354 [InitISOFS, Always, TestOutputTrue (
1355 [["is_file"; "/known-1"]]);
1356 InitISOFS, Always, TestOutputFalse (
1357 [["is_file"; "/directory"]])],
1358 "test if file exists",
1360 This returns C<true> if and only if there is a file
1361 with the given C<path> name. Note that it returns false for
1362 other objects like directories.
1364 See also C<guestfs_stat>.");
1366 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1367 [InitISOFS, Always, TestOutputFalse (
1368 [["is_dir"; "/known-3"]]);
1369 InitISOFS, Always, TestOutputTrue (
1370 [["is_dir"; "/directory"]])],
1371 "test if file exists",
1373 This returns C<true> if and only if there is a directory
1374 with the given C<path> name. Note that it returns false for
1375 other objects like files.
1377 See also C<guestfs_stat>.");
1379 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1380 [InitEmpty, Always, TestOutputListOfDevices (
1381 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1382 ["pvcreate"; "/dev/sda1"];
1383 ["pvcreate"; "/dev/sda2"];
1384 ["pvcreate"; "/dev/sda3"];
1385 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1386 "create an LVM physical volume",
1388 This creates an LVM physical volume on the named C<device>,
1389 where C<device> should usually be a partition name such
1392 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1393 [InitEmpty, Always, TestOutputList (
1394 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1395 ["pvcreate"; "/dev/sda1"];
1396 ["pvcreate"; "/dev/sda2"];
1397 ["pvcreate"; "/dev/sda3"];
1398 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1399 ["vgcreate"; "VG2"; "/dev/sda3"];
1400 ["vgs"]], ["VG1"; "VG2"])],
1401 "create an LVM volume group",
1403 This creates an LVM volume group called C<volgroup>
1404 from the non-empty list of physical volumes C<physvols>.");
1406 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1407 [InitEmpty, Always, TestOutputList (
1408 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1409 ["pvcreate"; "/dev/sda1"];
1410 ["pvcreate"; "/dev/sda2"];
1411 ["pvcreate"; "/dev/sda3"];
1412 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1413 ["vgcreate"; "VG2"; "/dev/sda3"];
1414 ["lvcreate"; "LV1"; "VG1"; "50"];
1415 ["lvcreate"; "LV2"; "VG1"; "50"];
1416 ["lvcreate"; "LV3"; "VG2"; "50"];
1417 ["lvcreate"; "LV4"; "VG2"; "50"];
1418 ["lvcreate"; "LV5"; "VG2"; "50"];
1420 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1421 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1422 "create an LVM volume group",
1424 This creates an LVM volume group called C<logvol>
1425 on the volume group C<volgroup>, with C<size> megabytes.");
1427 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1428 [InitEmpty, Always, TestOutput (
1429 [["part_disk"; "/dev/sda"; "mbr"];
1430 ["mkfs"; "ext2"; "/dev/sda1"];
1431 ["mount"; "/dev/sda1"; "/"];
1432 ["write_file"; "/new"; "new file contents"; "0"];
1433 ["cat"; "/new"]], "new file contents")],
1434 "make a filesystem",
1436 This creates a filesystem on C<device> (usually a partition
1437 or LVM logical volume). The filesystem type is C<fstype>, for
1440 ("sfdisk", (RErr, [Device "device";
1441 Int "cyls"; Int "heads"; Int "sectors";
1442 StringList "lines"]), 43, [DangerWillRobinson],
1444 "create partitions on a block device",
1446 This is a direct interface to the L<sfdisk(8)> program for creating
1447 partitions on block devices.
1449 C<device> should be a block device, for example C</dev/sda>.
1451 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1452 and sectors on the device, which are passed directly to sfdisk as
1453 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1454 of these, then the corresponding parameter is omitted. Usually for
1455 'large' disks, you can just pass C<0> for these, but for small
1456 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1457 out the right geometry and you will need to tell it.
1459 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1460 information refer to the L<sfdisk(8)> manpage.
1462 To create a single partition occupying the whole disk, you would
1463 pass C<lines> as a single element list, when the single element being
1464 the string C<,> (comma).
1466 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1467 C<guestfs_part_init>");
1469 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1470 [InitBasicFS, Always, TestOutput (
1471 [["write_file"; "/new"; "new file contents"; "0"];
1472 ["cat"; "/new"]], "new file contents");
1473 InitBasicFS, Always, TestOutput (
1474 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1475 ["cat"; "/new"]], "\nnew file contents\n");
1476 InitBasicFS, Always, TestOutput (
1477 [["write_file"; "/new"; "\n\n"; "0"];
1478 ["cat"; "/new"]], "\n\n");
1479 InitBasicFS, Always, TestOutput (
1480 [["write_file"; "/new"; ""; "0"];
1481 ["cat"; "/new"]], "");
1482 InitBasicFS, Always, TestOutput (
1483 [["write_file"; "/new"; "\n\n\n"; "0"];
1484 ["cat"; "/new"]], "\n\n\n");
1485 InitBasicFS, Always, TestOutput (
1486 [["write_file"; "/new"; "\n"; "0"];
1487 ["cat"; "/new"]], "\n")],
1490 This call creates a file called C<path>. The contents of the
1491 file is the string C<content> (which can contain any 8 bit data),
1492 with length C<size>.
1494 As a special case, if C<size> is C<0>
1495 then the length is calculated using C<strlen> (so in this case
1496 the content cannot contain embedded ASCII NULs).
1498 I<NB.> Owing to a bug, writing content containing ASCII NUL
1499 characters does I<not> work, even if the length is specified.
1500 We hope to resolve this bug in a future version. In the meantime
1501 use C<guestfs_upload>.");
1503 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1504 [InitEmpty, Always, TestOutputListOfDevices (
1505 [["part_disk"; "/dev/sda"; "mbr"];
1506 ["mkfs"; "ext2"; "/dev/sda1"];
1507 ["mount"; "/dev/sda1"; "/"];
1508 ["mounts"]], ["/dev/sda1"]);
1509 InitEmpty, Always, TestOutputList (
1510 [["part_disk"; "/dev/sda"; "mbr"];
1511 ["mkfs"; "ext2"; "/dev/sda1"];
1512 ["mount"; "/dev/sda1"; "/"];
1515 "unmount a filesystem",
1517 This unmounts the given filesystem. The filesystem may be
1518 specified either by its mountpoint (path) or the device which
1519 contains the filesystem.");
1521 ("mounts", (RStringList "devices", []), 46, [],
1522 [InitBasicFS, Always, TestOutputListOfDevices (
1523 [["mounts"]], ["/dev/sda1"])],
1524 "show mounted filesystems",
1526 This returns the list of currently mounted filesystems. It returns
1527 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1529 Some internal mounts are not shown.
1531 See also: C<guestfs_mountpoints>");
1533 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1534 [InitBasicFS, Always, TestOutputList (
1537 (* check that umount_all can unmount nested mounts correctly: *)
1538 InitEmpty, Always, TestOutputList (
1539 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1540 ["mkfs"; "ext2"; "/dev/sda1"];
1541 ["mkfs"; "ext2"; "/dev/sda2"];
1542 ["mkfs"; "ext2"; "/dev/sda3"];
1543 ["mount"; "/dev/sda1"; "/"];
1545 ["mount"; "/dev/sda2"; "/mp1"];
1546 ["mkdir"; "/mp1/mp2"];
1547 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1548 ["mkdir"; "/mp1/mp2/mp3"];
1551 "unmount all filesystems",
1553 This unmounts all mounted filesystems.
1555 Some internal mounts are not unmounted by this call.");
1557 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1559 "remove all LVM LVs, VGs and PVs",
1561 This command removes all LVM logical volumes, volume groups
1562 and physical volumes.");
1564 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1565 [InitISOFS, Always, TestOutput (
1566 [["file"; "/empty"]], "empty");
1567 InitISOFS, Always, TestOutput (
1568 [["file"; "/known-1"]], "ASCII text");
1569 InitISOFS, Always, TestLastFail (
1570 [["file"; "/notexists"]])],
1571 "determine file type",
1573 This call uses the standard L<file(1)> command to determine
1574 the type or contents of the file. This also works on devices,
1575 for example to find out whether a partition contains a filesystem.
1577 This call will also transparently look inside various types
1580 The exact command which runs is C<file -zbsL path>. Note in
1581 particular that the filename is not prepended to the output
1582 (the C<-b> option).");
1584 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1585 [InitBasicFS, Always, TestOutput (
1586 [["upload"; "test-command"; "/test-command"];
1587 ["chmod"; "0o755"; "/test-command"];
1588 ["command"; "/test-command 1"]], "Result1");
1589 InitBasicFS, Always, TestOutput (
1590 [["upload"; "test-command"; "/test-command"];
1591 ["chmod"; "0o755"; "/test-command"];
1592 ["command"; "/test-command 2"]], "Result2\n");
1593 InitBasicFS, Always, TestOutput (
1594 [["upload"; "test-command"; "/test-command"];
1595 ["chmod"; "0o755"; "/test-command"];
1596 ["command"; "/test-command 3"]], "\nResult3");
1597 InitBasicFS, Always, TestOutput (
1598 [["upload"; "test-command"; "/test-command"];
1599 ["chmod"; "0o755"; "/test-command"];
1600 ["command"; "/test-command 4"]], "\nResult4\n");
1601 InitBasicFS, Always, TestOutput (
1602 [["upload"; "test-command"; "/test-command"];
1603 ["chmod"; "0o755"; "/test-command"];
1604 ["command"; "/test-command 5"]], "\nResult5\n\n");
1605 InitBasicFS, Always, TestOutput (
1606 [["upload"; "test-command"; "/test-command"];
1607 ["chmod"; "0o755"; "/test-command"];
1608 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1609 InitBasicFS, Always, TestOutput (
1610 [["upload"; "test-command"; "/test-command"];
1611 ["chmod"; "0o755"; "/test-command"];
1612 ["command"; "/test-command 7"]], "");
1613 InitBasicFS, Always, TestOutput (
1614 [["upload"; "test-command"; "/test-command"];
1615 ["chmod"; "0o755"; "/test-command"];
1616 ["command"; "/test-command 8"]], "\n");
1617 InitBasicFS, Always, TestOutput (
1618 [["upload"; "test-command"; "/test-command"];
1619 ["chmod"; "0o755"; "/test-command"];
1620 ["command"; "/test-command 9"]], "\n\n");
1621 InitBasicFS, Always, TestOutput (
1622 [["upload"; "test-command"; "/test-command"];
1623 ["chmod"; "0o755"; "/test-command"];
1624 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1625 InitBasicFS, Always, TestOutput (
1626 [["upload"; "test-command"; "/test-command"];
1627 ["chmod"; "0o755"; "/test-command"];
1628 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1629 InitBasicFS, Always, TestLastFail (
1630 [["upload"; "test-command"; "/test-command"];
1631 ["chmod"; "0o755"; "/test-command"];
1632 ["command"; "/test-command"]])],
1633 "run a command from the guest filesystem",
1635 This call runs a command from the guest filesystem. The
1636 filesystem must be mounted, and must contain a compatible
1637 operating system (ie. something Linux, with the same
1638 or compatible processor architecture).
1640 The single parameter is an argv-style list of arguments.
1641 The first element is the name of the program to run.
1642 Subsequent elements are parameters. The list must be
1643 non-empty (ie. must contain a program name). Note that
1644 the command runs directly, and is I<not> invoked via
1645 the shell (see C<guestfs_sh>).
1647 The return value is anything printed to I<stdout> by
1650 If the command returns a non-zero exit status, then
1651 this function returns an error message. The error message
1652 string is the content of I<stderr> from the command.
1654 The C<$PATH> environment variable will contain at least
1655 C</usr/bin> and C</bin>. If you require a program from
1656 another location, you should provide the full path in the
1659 Shared libraries and data files required by the program
1660 must be available on filesystems which are mounted in the
1661 correct places. It is the caller's responsibility to ensure
1662 all filesystems that are needed are mounted at the right
1665 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1666 [InitBasicFS, Always, TestOutputList (
1667 [["upload"; "test-command"; "/test-command"];
1668 ["chmod"; "0o755"; "/test-command"];
1669 ["command_lines"; "/test-command 1"]], ["Result1"]);
1670 InitBasicFS, Always, TestOutputList (
1671 [["upload"; "test-command"; "/test-command"];
1672 ["chmod"; "0o755"; "/test-command"];
1673 ["command_lines"; "/test-command 2"]], ["Result2"]);
1674 InitBasicFS, Always, TestOutputList (
1675 [["upload"; "test-command"; "/test-command"];
1676 ["chmod"; "0o755"; "/test-command"];
1677 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1678 InitBasicFS, Always, TestOutputList (
1679 [["upload"; "test-command"; "/test-command"];
1680 ["chmod"; "0o755"; "/test-command"];
1681 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1682 InitBasicFS, Always, TestOutputList (
1683 [["upload"; "test-command"; "/test-command"];
1684 ["chmod"; "0o755"; "/test-command"];
1685 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1686 InitBasicFS, Always, TestOutputList (
1687 [["upload"; "test-command"; "/test-command"];
1688 ["chmod"; "0o755"; "/test-command"];
1689 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1690 InitBasicFS, Always, TestOutputList (
1691 [["upload"; "test-command"; "/test-command"];
1692 ["chmod"; "0o755"; "/test-command"];
1693 ["command_lines"; "/test-command 7"]], []);
1694 InitBasicFS, Always, TestOutputList (
1695 [["upload"; "test-command"; "/test-command"];
1696 ["chmod"; "0o755"; "/test-command"];
1697 ["command_lines"; "/test-command 8"]], [""]);
1698 InitBasicFS, Always, TestOutputList (
1699 [["upload"; "test-command"; "/test-command"];
1700 ["chmod"; "0o755"; "/test-command"];
1701 ["command_lines"; "/test-command 9"]], ["";""]);
1702 InitBasicFS, Always, TestOutputList (
1703 [["upload"; "test-command"; "/test-command"];
1704 ["chmod"; "0o755"; "/test-command"];
1705 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1706 InitBasicFS, Always, TestOutputList (
1707 [["upload"; "test-command"; "/test-command"];
1708 ["chmod"; "0o755"; "/test-command"];
1709 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1710 "run a command, returning lines",
1712 This is the same as C<guestfs_command>, but splits the
1713 result into a list of lines.
1715 See also: C<guestfs_sh_lines>");
1717 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1718 [InitISOFS, Always, TestOutputStruct (
1719 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1720 "get file information",
1722 Returns file information for the given C<path>.
1724 This is the same as the C<stat(2)> system call.");
1726 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1727 [InitISOFS, Always, TestOutputStruct (
1728 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1729 "get file information for a symbolic link",
1731 Returns file information for the given C<path>.
1733 This is the same as C<guestfs_stat> except that if C<path>
1734 is a symbolic link, then the link is stat-ed, not the file it
1737 This is the same as the C<lstat(2)> system call.");
1739 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1740 [InitISOFS, Always, TestOutputStruct (
1741 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1742 "get file system statistics",
1744 Returns file system statistics for any mounted file system.
1745 C<path> should be a file or directory in the mounted file system
1746 (typically it is the mount point itself, but it doesn't need to be).
1748 This is the same as the C<statvfs(2)> system call.");
1750 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1752 "get ext2/ext3/ext4 superblock details",
1754 This returns the contents of the ext2, ext3 or ext4 filesystem
1755 superblock on C<device>.
1757 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1758 manpage for more details. The list of fields returned isn't
1759 clearly defined, and depends on both the version of C<tune2fs>
1760 that libguestfs was built against, and the filesystem itself.");
1762 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1763 [InitEmpty, Always, TestOutputTrue (
1764 [["blockdev_setro"; "/dev/sda"];
1765 ["blockdev_getro"; "/dev/sda"]])],
1766 "set block device to read-only",
1768 Sets the block device named C<device> to read-only.
1770 This uses the L<blockdev(8)> command.");
1772 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1773 [InitEmpty, Always, TestOutputFalse (
1774 [["blockdev_setrw"; "/dev/sda"];
1775 ["blockdev_getro"; "/dev/sda"]])],
1776 "set block device to read-write",
1778 Sets the block device named C<device> to read-write.
1780 This uses the L<blockdev(8)> command.");
1782 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1783 [InitEmpty, Always, TestOutputTrue (
1784 [["blockdev_setro"; "/dev/sda"];
1785 ["blockdev_getro"; "/dev/sda"]])],
1786 "is block device set to read-only",
1788 Returns a boolean indicating if the block device is read-only
1789 (true if read-only, false if not).
1791 This uses the L<blockdev(8)> command.");
1793 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1794 [InitEmpty, Always, TestOutputInt (
1795 [["blockdev_getss"; "/dev/sda"]], 512)],
1796 "get sectorsize of block device",
1798 This returns the size of sectors on a block device.
1799 Usually 512, but can be larger for modern devices.
1801 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1804 This uses the L<blockdev(8)> command.");
1806 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1807 [InitEmpty, Always, TestOutputInt (
1808 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1809 "get blocksize of block device",
1811 This returns the block size of a device.
1813 (Note this is different from both I<size in blocks> and
1814 I<filesystem block size>).
1816 This uses the L<blockdev(8)> command.");
1818 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1820 "set blocksize of block device",
1822 This sets the block size of a device.
1824 (Note this is different from both I<size in blocks> and
1825 I<filesystem block size>).
1827 This uses the L<blockdev(8)> command.");
1829 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1830 [InitEmpty, Always, TestOutputInt (
1831 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1832 "get total size of device in 512-byte sectors",
1834 This returns the size of the device in units of 512-byte sectors
1835 (even if the sectorsize isn't 512 bytes ... weird).
1837 See also C<guestfs_blockdev_getss> for the real sector size of
1838 the device, and C<guestfs_blockdev_getsize64> for the more
1839 useful I<size in bytes>.
1841 This uses the L<blockdev(8)> command.");
1843 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1844 [InitEmpty, Always, TestOutputInt (
1845 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1846 "get total size of device in bytes",
1848 This returns the size of the device in bytes.
1850 See also C<guestfs_blockdev_getsz>.
1852 This uses the L<blockdev(8)> command.");
1854 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1855 [InitEmpty, Always, TestRun
1856 [["blockdev_flushbufs"; "/dev/sda"]]],
1857 "flush device buffers",
1859 This tells the kernel to flush internal buffers associated
1862 This uses the L<blockdev(8)> command.");
1864 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1865 [InitEmpty, Always, TestRun
1866 [["blockdev_rereadpt"; "/dev/sda"]]],
1867 "reread partition table",
1869 Reread the partition table on C<device>.
1871 This uses the L<blockdev(8)> command.");
1873 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1874 [InitBasicFS, Always, TestOutput (
1875 (* Pick a file from cwd which isn't likely to change. *)
1876 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1877 ["checksum"; "md5"; "/COPYING.LIB"]],
1878 Digest.to_hex (Digest.file "COPYING.LIB"))],
1879 "upload a file from the local machine",
1881 Upload local file C<filename> to C<remotefilename> on the
1884 C<filename> can also be a named pipe.
1886 See also C<guestfs_download>.");
1888 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1889 [InitBasicFS, Always, TestOutput (
1890 (* Pick a file from cwd which isn't likely to change. *)
1891 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1892 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1893 ["upload"; "testdownload.tmp"; "/upload"];
1894 ["checksum"; "md5"; "/upload"]],
1895 Digest.to_hex (Digest.file "COPYING.LIB"))],
1896 "download a file to the local machine",
1898 Download file C<remotefilename> and save it as C<filename>
1899 on the local machine.
1901 C<filename> can also be a named pipe.
1903 See also C<guestfs_upload>, C<guestfs_cat>.");
1905 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1906 [InitISOFS, Always, TestOutput (
1907 [["checksum"; "crc"; "/known-3"]], "2891671662");
1908 InitISOFS, Always, TestLastFail (
1909 [["checksum"; "crc"; "/notexists"]]);
1910 InitISOFS, Always, TestOutput (
1911 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1912 InitISOFS, Always, TestOutput (
1913 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1914 InitISOFS, Always, TestOutput (
1915 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1916 InitISOFS, Always, TestOutput (
1917 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1918 InitISOFS, Always, TestOutput (
1919 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1920 InitISOFS, Always, TestOutput (
1921 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1922 "compute MD5, SHAx or CRC checksum of file",
1924 This call computes the MD5, SHAx or CRC checksum of the
1927 The type of checksum to compute is given by the C<csumtype>
1928 parameter which must have one of the following values:
1934 Compute the cyclic redundancy check (CRC) specified by POSIX
1935 for the C<cksum> command.
1939 Compute the MD5 hash (using the C<md5sum> program).
1943 Compute the SHA1 hash (using the C<sha1sum> program).
1947 Compute the SHA224 hash (using the C<sha224sum> program).
1951 Compute the SHA256 hash (using the C<sha256sum> program).
1955 Compute the SHA384 hash (using the C<sha384sum> program).
1959 Compute the SHA512 hash (using the C<sha512sum> program).
1963 The checksum is returned as a printable string.");
1965 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1966 [InitBasicFS, Always, TestOutput (
1967 [["tar_in"; "../images/helloworld.tar"; "/"];
1968 ["cat"; "/hello"]], "hello\n")],
1969 "unpack tarfile to directory",
1971 This command uploads and unpacks local file C<tarfile> (an
1972 I<uncompressed> tar file) into C<directory>.
1974 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1976 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1978 "pack directory into tarfile",
1980 This command packs the contents of C<directory> and downloads
1981 it to local file C<tarfile>.
1983 To download a compressed tarball, use C<guestfs_tgz_out>.");
1985 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1986 [InitBasicFS, Always, TestOutput (
1987 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1988 ["cat"; "/hello"]], "hello\n")],
1989 "unpack compressed tarball to directory",
1991 This command uploads and unpacks local file C<tarball> (a
1992 I<gzip compressed> tar file) into C<directory>.
1994 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1996 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
1998 "pack directory into compressed tarball",
2000 This command packs the contents of C<directory> and downloads
2001 it to local file C<tarball>.
2003 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2005 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2006 [InitBasicFS, Always, TestLastFail (
2008 ["mount_ro"; "/dev/sda1"; "/"];
2009 ["touch"; "/new"]]);
2010 InitBasicFS, Always, TestOutput (
2011 [["write_file"; "/new"; "data"; "0"];
2013 ["mount_ro"; "/dev/sda1"; "/"];
2014 ["cat"; "/new"]], "data")],
2015 "mount a guest disk, read-only",
2017 This is the same as the C<guestfs_mount> command, but it
2018 mounts the filesystem with the read-only (I<-o ro>) flag.");
2020 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2022 "mount a guest disk with mount options",
2024 This is the same as the C<guestfs_mount> command, but it
2025 allows you to set the mount options as for the
2026 L<mount(8)> I<-o> flag.");
2028 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2030 "mount a guest disk with mount options and vfstype",
2032 This is the same as the C<guestfs_mount> command, but it
2033 allows you to set both the mount options and the vfstype
2034 as for the L<mount(8)> I<-o> and I<-t> flags.");
2036 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2038 "debugging and internals",
2040 The C<guestfs_debug> command exposes some internals of
2041 C<guestfsd> (the guestfs daemon) that runs inside the
2044 There is no comprehensive help for this command. You have
2045 to look at the file C<daemon/debug.c> in the libguestfs source
2046 to find out what you can do.");
2048 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2049 [InitEmpty, Always, TestOutputList (
2050 [["part_disk"; "/dev/sda"; "mbr"];
2051 ["pvcreate"; "/dev/sda1"];
2052 ["vgcreate"; "VG"; "/dev/sda1"];
2053 ["lvcreate"; "LV1"; "VG"; "50"];
2054 ["lvcreate"; "LV2"; "VG"; "50"];
2055 ["lvremove"; "/dev/VG/LV1"];
2056 ["lvs"]], ["/dev/VG/LV2"]);
2057 InitEmpty, Always, TestOutputList (
2058 [["part_disk"; "/dev/sda"; "mbr"];
2059 ["pvcreate"; "/dev/sda1"];
2060 ["vgcreate"; "VG"; "/dev/sda1"];
2061 ["lvcreate"; "LV1"; "VG"; "50"];
2062 ["lvcreate"; "LV2"; "VG"; "50"];
2063 ["lvremove"; "/dev/VG"];
2065 InitEmpty, Always, TestOutputList (
2066 [["part_disk"; "/dev/sda"; "mbr"];
2067 ["pvcreate"; "/dev/sda1"];
2068 ["vgcreate"; "VG"; "/dev/sda1"];
2069 ["lvcreate"; "LV1"; "VG"; "50"];
2070 ["lvcreate"; "LV2"; "VG"; "50"];
2071 ["lvremove"; "/dev/VG"];
2073 "remove an LVM logical volume",
2075 Remove an LVM logical volume C<device>, where C<device> is
2076 the path to the LV, such as C</dev/VG/LV>.
2078 You can also remove all LVs in a volume group by specifying
2079 the VG name, C</dev/VG>.");
2081 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2082 [InitEmpty, Always, TestOutputList (
2083 [["part_disk"; "/dev/sda"; "mbr"];
2084 ["pvcreate"; "/dev/sda1"];
2085 ["vgcreate"; "VG"; "/dev/sda1"];
2086 ["lvcreate"; "LV1"; "VG"; "50"];
2087 ["lvcreate"; "LV2"; "VG"; "50"];
2090 InitEmpty, Always, TestOutputList (
2091 [["part_disk"; "/dev/sda"; "mbr"];
2092 ["pvcreate"; "/dev/sda1"];
2093 ["vgcreate"; "VG"; "/dev/sda1"];
2094 ["lvcreate"; "LV1"; "VG"; "50"];
2095 ["lvcreate"; "LV2"; "VG"; "50"];
2098 "remove an LVM volume group",
2100 Remove an LVM volume group C<vgname>, (for example C<VG>).
2102 This also forcibly removes all logical volumes in the volume
2105 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2106 [InitEmpty, Always, TestOutputListOfDevices (
2107 [["part_disk"; "/dev/sda"; "mbr"];
2108 ["pvcreate"; "/dev/sda1"];
2109 ["vgcreate"; "VG"; "/dev/sda1"];
2110 ["lvcreate"; "LV1"; "VG"; "50"];
2111 ["lvcreate"; "LV2"; "VG"; "50"];
2113 ["pvremove"; "/dev/sda1"];
2115 InitEmpty, Always, TestOutputListOfDevices (
2116 [["part_disk"; "/dev/sda"; "mbr"];
2117 ["pvcreate"; "/dev/sda1"];
2118 ["vgcreate"; "VG"; "/dev/sda1"];
2119 ["lvcreate"; "LV1"; "VG"; "50"];
2120 ["lvcreate"; "LV2"; "VG"; "50"];
2122 ["pvremove"; "/dev/sda1"];
2124 InitEmpty, Always, TestOutputListOfDevices (
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"];
2131 ["pvremove"; "/dev/sda1"];
2133 "remove an LVM physical volume",
2135 This wipes a physical volume C<device> so that LVM will no longer
2138 The implementation uses the C<pvremove> command which refuses to
2139 wipe physical volumes that contain any volume groups, so you have
2140 to remove those first.");
2142 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2143 [InitBasicFS, Always, TestOutput (
2144 [["set_e2label"; "/dev/sda1"; "testlabel"];
2145 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2146 "set the ext2/3/4 filesystem label",
2148 This sets the ext2/3/4 filesystem label of the filesystem on
2149 C<device> to C<label>. Filesystem labels are limited to
2152 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2153 to return the existing label on a filesystem.");
2155 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2157 "get the ext2/3/4 filesystem label",
2159 This returns the ext2/3/4 filesystem label of the filesystem on
2162 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2163 (let uuid = uuidgen () in
2164 [InitBasicFS, Always, TestOutput (
2165 [["set_e2uuid"; "/dev/sda1"; uuid];
2166 ["get_e2uuid"; "/dev/sda1"]], uuid);
2167 InitBasicFS, Always, TestOutput (
2168 [["set_e2uuid"; "/dev/sda1"; "clear"];
2169 ["get_e2uuid"; "/dev/sda1"]], "");
2170 (* We can't predict what UUIDs will be, so just check the commands run. *)
2171 InitBasicFS, Always, TestRun (
2172 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2173 InitBasicFS, Always, TestRun (
2174 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2175 "set the ext2/3/4 filesystem UUID",
2177 This sets the ext2/3/4 filesystem UUID of the filesystem on
2178 C<device> to C<uuid>. The format of the UUID and alternatives
2179 such as C<clear>, C<random> and C<time> are described in the
2180 L<tune2fs(8)> manpage.
2182 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2183 to return the existing UUID of a filesystem.");
2185 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2187 "get the ext2/3/4 filesystem UUID",
2189 This returns the ext2/3/4 filesystem UUID of the filesystem on
2192 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2193 [InitBasicFS, Always, TestOutputInt (
2194 [["umount"; "/dev/sda1"];
2195 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2196 InitBasicFS, Always, TestOutputInt (
2197 [["umount"; "/dev/sda1"];
2198 ["zero"; "/dev/sda1"];
2199 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2200 "run the filesystem checker",
2202 This runs the filesystem checker (fsck) on C<device> which
2203 should have filesystem type C<fstype>.
2205 The returned integer is the status. See L<fsck(8)> for the
2206 list of status codes from C<fsck>.
2214 Multiple status codes can be summed together.
2218 A non-zero return code can mean \"success\", for example if
2219 errors have been corrected on the filesystem.
2223 Checking or repairing NTFS volumes is not supported
2228 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2230 ("zero", (RErr, [Device "device"]), 85, [],
2231 [InitBasicFS, Always, TestOutput (
2232 [["umount"; "/dev/sda1"];
2233 ["zero"; "/dev/sda1"];
2234 ["file"; "/dev/sda1"]], "data")],
2235 "write zeroes to the device",
2237 This command writes zeroes over the first few blocks of C<device>.
2239 How many blocks are zeroed isn't specified (but it's I<not> enough
2240 to securely wipe the device). It should be sufficient to remove
2241 any partition tables, filesystem superblocks and so on.
2243 See also: C<guestfs_scrub_device>.");
2245 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2246 (* Test disabled because grub-install incompatible with virtio-blk driver.
2247 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2249 [InitBasicFS, Disabled, TestOutputTrue (
2250 [["grub_install"; "/"; "/dev/sda1"];
2251 ["is_dir"; "/boot"]])],
2254 This command installs GRUB (the Grand Unified Bootloader) on
2255 C<device>, with the root directory being C<root>.");
2257 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2258 [InitBasicFS, Always, TestOutput (
2259 [["write_file"; "/old"; "file content"; "0"];
2260 ["cp"; "/old"; "/new"];
2261 ["cat"; "/new"]], "file content");
2262 InitBasicFS, Always, TestOutputTrue (
2263 [["write_file"; "/old"; "file content"; "0"];
2264 ["cp"; "/old"; "/new"];
2265 ["is_file"; "/old"]]);
2266 InitBasicFS, Always, TestOutput (
2267 [["write_file"; "/old"; "file content"; "0"];
2269 ["cp"; "/old"; "/dir/new"];
2270 ["cat"; "/dir/new"]], "file content")],
2273 This copies a file from C<src> to C<dest> where C<dest> is
2274 either a destination filename or destination directory.");
2276 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2277 [InitBasicFS, Always, TestOutput (
2278 [["mkdir"; "/olddir"];
2279 ["mkdir"; "/newdir"];
2280 ["write_file"; "/olddir/file"; "file content"; "0"];
2281 ["cp_a"; "/olddir"; "/newdir"];
2282 ["cat"; "/newdir/olddir/file"]], "file content")],
2283 "copy a file or directory recursively",
2285 This copies a file or directory from C<src> to C<dest>
2286 recursively using the C<cp -a> command.");
2288 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2289 [InitBasicFS, Always, TestOutput (
2290 [["write_file"; "/old"; "file content"; "0"];
2291 ["mv"; "/old"; "/new"];
2292 ["cat"; "/new"]], "file content");
2293 InitBasicFS, Always, TestOutputFalse (
2294 [["write_file"; "/old"; "file content"; "0"];
2295 ["mv"; "/old"; "/new"];
2296 ["is_file"; "/old"]])],
2299 This moves a file from C<src> to C<dest> where C<dest> is
2300 either a destination filename or destination directory.");
2302 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2303 [InitEmpty, Always, TestRun (
2304 [["drop_caches"; "3"]])],
2305 "drop kernel page cache, dentries and inodes",
2307 This instructs the guest kernel to drop its page cache,
2308 and/or dentries and inode caches. The parameter C<whattodrop>
2309 tells the kernel what precisely to drop, see
2310 L<http://linux-mm.org/Drop_Caches>
2312 Setting C<whattodrop> to 3 should drop everything.
2314 This automatically calls L<sync(2)> before the operation,
2315 so that the maximum guest memory is freed.");
2317 ("dmesg", (RString "kmsgs", []), 91, [],
2318 [InitEmpty, Always, TestRun (
2320 "return kernel messages",
2322 This returns the kernel messages (C<dmesg> output) from
2323 the guest kernel. This is sometimes useful for extended
2324 debugging of problems.
2326 Another way to get the same information is to enable
2327 verbose messages with C<guestfs_set_verbose> or by setting
2328 the environment variable C<LIBGUESTFS_DEBUG=1> before
2329 running the program.");
2331 ("ping_daemon", (RErr, []), 92, [],
2332 [InitEmpty, Always, TestRun (
2333 [["ping_daemon"]])],
2334 "ping the guest daemon",
2336 This is a test probe into the guestfs daemon running inside
2337 the qemu subprocess. Calling this function checks that the
2338 daemon responds to the ping message, without affecting the daemon
2339 or attached block device(s) in any other way.");
2341 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2342 [InitBasicFS, Always, TestOutputTrue (
2343 [["write_file"; "/file1"; "contents of a file"; "0"];
2344 ["cp"; "/file1"; "/file2"];
2345 ["equal"; "/file1"; "/file2"]]);
2346 InitBasicFS, Always, TestOutputFalse (
2347 [["write_file"; "/file1"; "contents of a file"; "0"];
2348 ["write_file"; "/file2"; "contents of another file"; "0"];
2349 ["equal"; "/file1"; "/file2"]]);
2350 InitBasicFS, Always, TestLastFail (
2351 [["equal"; "/file1"; "/file2"]])],
2352 "test if two files have equal contents",
2354 This compares the two files C<file1> and C<file2> and returns
2355 true if their content is exactly equal, or false otherwise.
2357 The external L<cmp(1)> program is used for the comparison.");
2359 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2360 [InitISOFS, Always, TestOutputList (
2361 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2362 InitISOFS, Always, TestOutputList (
2363 [["strings"; "/empty"]], [])],
2364 "print the printable strings in a file",
2366 This runs the L<strings(1)> command on a file and returns
2367 the list of printable strings found.");
2369 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2370 [InitISOFS, Always, TestOutputList (
2371 [["strings_e"; "b"; "/known-5"]], []);
2372 InitBasicFS, Disabled, TestOutputList (
2373 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2374 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2375 "print the printable strings in a file",
2377 This is like the C<guestfs_strings> command, but allows you to
2378 specify the encoding.
2380 See the L<strings(1)> manpage for the full list of encodings.
2382 Commonly useful encodings are C<l> (lower case L) which will
2383 show strings inside Windows/x86 files.
2385 The returned strings are transcoded to UTF-8.");
2387 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2388 [InitISOFS, Always, TestOutput (
2389 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2390 (* Test for RHBZ#501888c2 regression which caused large hexdump
2391 * commands to segfault.
2393 InitISOFS, Always, TestRun (
2394 [["hexdump"; "/100krandom"]])],
2395 "dump a file in hexadecimal",
2397 This runs C<hexdump -C> on the given C<path>. The result is
2398 the human-readable, canonical hex dump of the file.");
2400 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2401 [InitNone, Always, TestOutput (
2402 [["part_disk"; "/dev/sda"; "mbr"];
2403 ["mkfs"; "ext3"; "/dev/sda1"];
2404 ["mount"; "/dev/sda1"; "/"];
2405 ["write_file"; "/new"; "test file"; "0"];
2406 ["umount"; "/dev/sda1"];
2407 ["zerofree"; "/dev/sda1"];
2408 ["mount"; "/dev/sda1"; "/"];
2409 ["cat"; "/new"]], "test file")],
2410 "zero unused inodes and disk blocks on ext2/3 filesystem",
2412 This runs the I<zerofree> program on C<device>. This program
2413 claims to zero unused inodes and disk blocks on an ext2/3
2414 filesystem, thus making it possible to compress the filesystem
2417 You should B<not> run this program if the filesystem is
2420 It is possible that using this program can damage the filesystem
2421 or data on the filesystem.");
2423 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2425 "resize an LVM physical volume",
2427 This resizes (expands or shrinks) an existing LVM physical
2428 volume to match the new size of the underlying device.");
2430 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2431 Int "cyls"; Int "heads"; Int "sectors";
2432 String "line"]), 99, [DangerWillRobinson],
2434 "modify a single partition on a block device",
2436 This runs L<sfdisk(8)> option to modify just the single
2437 partition C<n> (note: C<n> counts from 1).
2439 For other parameters, see C<guestfs_sfdisk>. You should usually
2440 pass C<0> for the cyls/heads/sectors parameters.
2442 See also: C<guestfs_part_add>");
2444 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2446 "display the partition table",
2448 This displays the partition table on C<device>, in the
2449 human-readable output of the L<sfdisk(8)> command. It is
2450 not intended to be parsed.
2452 See also: C<guestfs_part_list>");
2454 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2456 "display the kernel geometry",
2458 This displays the kernel's idea of the geometry of C<device>.
2460 The result is in human-readable format, and not designed to
2463 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2465 "display the disk geometry from the partition table",
2467 This displays the disk geometry of C<device> read from the
2468 partition table. Especially in the case where the underlying
2469 block device has been resized, this can be different from the
2470 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2472 The result is in human-readable format, and not designed to
2475 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2477 "activate or deactivate all volume groups",
2479 This command activates or (if C<activate> is false) deactivates
2480 all logical volumes in all volume groups.
2481 If activated, then they are made known to the
2482 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2483 then those devices disappear.
2485 This command is the same as running C<vgchange -a y|n>");
2487 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2489 "activate or deactivate some volume groups",
2491 This command activates or (if C<activate> is false) deactivates
2492 all logical volumes in the listed volume groups C<volgroups>.
2493 If activated, then they are made known to the
2494 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2495 then those devices disappear.
2497 This command is the same as running C<vgchange -a y|n volgroups...>
2499 Note that if C<volgroups> is an empty list then B<all> volume groups
2500 are activated or deactivated.");
2502 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2503 [InitNone, Always, TestOutput (
2504 [["part_disk"; "/dev/sda"; "mbr"];
2505 ["pvcreate"; "/dev/sda1"];
2506 ["vgcreate"; "VG"; "/dev/sda1"];
2507 ["lvcreate"; "LV"; "VG"; "10"];
2508 ["mkfs"; "ext2"; "/dev/VG/LV"];
2509 ["mount"; "/dev/VG/LV"; "/"];
2510 ["write_file"; "/new"; "test content"; "0"];
2512 ["lvresize"; "/dev/VG/LV"; "20"];
2513 ["e2fsck_f"; "/dev/VG/LV"];
2514 ["resize2fs"; "/dev/VG/LV"];
2515 ["mount"; "/dev/VG/LV"; "/"];
2516 ["cat"; "/new"]], "test content")],
2517 "resize an LVM logical volume",
2519 This resizes (expands or shrinks) an existing LVM logical
2520 volume to C<mbytes>. When reducing, data in the reduced part
2523 ("resize2fs", (RErr, [Device "device"]), 106, [],
2524 [], (* lvresize tests this *)
2525 "resize an ext2/ext3 filesystem",
2527 This resizes an ext2 or ext3 filesystem to match the size of
2528 the underlying device.
2530 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2531 on the C<device> before calling this command. For unknown reasons
2532 C<resize2fs> sometimes gives an error about this and sometimes not.
2533 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2534 calling this function.");
2536 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2537 [InitBasicFS, Always, TestOutputList (
2538 [["find"; "/"]], ["lost+found"]);
2539 InitBasicFS, Always, TestOutputList (
2543 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2544 InitBasicFS, Always, TestOutputList (
2545 [["mkdir_p"; "/a/b/c"];
2546 ["touch"; "/a/b/c/d"];
2547 ["find"; "/a/b/"]], ["c"; "c/d"])],
2548 "find all files and directories",
2550 This command lists out all files and directories, recursively,
2551 starting at C<directory>. It is essentially equivalent to
2552 running the shell command C<find directory -print> but some
2553 post-processing happens on the output, described below.
2555 This returns a list of strings I<without any prefix>. Thus
2556 if the directory structure was:
2562 then the returned list from C<guestfs_find> C</tmp> would be
2570 If C<directory> is not a directory, then this command returns
2573 The returned list is sorted.
2575 See also C<guestfs_find0>.");
2577 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2578 [], (* lvresize tests this *)
2579 "check an ext2/ext3 filesystem",
2581 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2582 filesystem checker on C<device>, noninteractively (C<-p>),
2583 even if the filesystem appears to be clean (C<-f>).
2585 This command is only needed because of C<guestfs_resize2fs>
2586 (q.v.). Normally you should use C<guestfs_fsck>.");
2588 ("sleep", (RErr, [Int "secs"]), 109, [],
2589 [InitNone, Always, TestRun (
2591 "sleep for some seconds",
2593 Sleep for C<secs> seconds.");
2595 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2596 [InitNone, Always, TestOutputInt (
2597 [["part_disk"; "/dev/sda"; "mbr"];
2598 ["mkfs"; "ntfs"; "/dev/sda1"];
2599 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2600 InitNone, Always, TestOutputInt (
2601 [["part_disk"; "/dev/sda"; "mbr"];
2602 ["mkfs"; "ext2"; "/dev/sda1"];
2603 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2604 "probe NTFS volume",
2606 This command runs the L<ntfs-3g.probe(8)> command which probes
2607 an NTFS C<device> for mountability. (Not all NTFS volumes can
2608 be mounted read-write, and some cannot be mounted at all).
2610 C<rw> is a boolean flag. Set it to true if you want to test
2611 if the volume can be mounted read-write. Set it to false if
2612 you want to test if the volume can be mounted read-only.
2614 The return value is an integer which C<0> if the operation
2615 would succeed, or some non-zero value documented in the
2616 L<ntfs-3g.probe(8)> manual page.");
2618 ("sh", (RString "output", [String "command"]), 111, [],
2619 [], (* XXX needs tests *)
2620 "run a command via the shell",
2622 This call runs a command from the guest filesystem via the
2625 This is like C<guestfs_command>, but passes the command to:
2627 /bin/sh -c \"command\"
2629 Depending on the guest's shell, this usually results in
2630 wildcards being expanded, shell expressions being interpolated
2633 All the provisos about C<guestfs_command> apply to this call.");
2635 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2636 [], (* XXX needs tests *)
2637 "run a command via the shell returning lines",
2639 This is the same as C<guestfs_sh>, but splits the result
2640 into a list of lines.
2642 See also: C<guestfs_command_lines>");
2644 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2645 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2646 * code in stubs.c, since all valid glob patterns must start with "/".
2647 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2649 [InitBasicFS, Always, TestOutputList (
2650 [["mkdir_p"; "/a/b/c"];
2651 ["touch"; "/a/b/c/d"];
2652 ["touch"; "/a/b/c/e"];
2653 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2654 InitBasicFS, Always, TestOutputList (
2655 [["mkdir_p"; "/a/b/c"];
2656 ["touch"; "/a/b/c/d"];
2657 ["touch"; "/a/b/c/e"];
2658 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2659 InitBasicFS, Always, TestOutputList (
2660 [["mkdir_p"; "/a/b/c"];
2661 ["touch"; "/a/b/c/d"];
2662 ["touch"; "/a/b/c/e"];
2663 ["glob_expand"; "/a/*/x/*"]], [])],
2664 "expand a wildcard path",
2666 This command searches for all the pathnames matching
2667 C<pattern> according to the wildcard expansion rules
2670 If no paths match, then this returns an empty list
2671 (note: not an error).
2673 It is just a wrapper around the C L<glob(3)> function
2674 with flags C<GLOB_MARK|GLOB_BRACE>.
2675 See that manual page for more details.");
2677 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2678 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2679 [["scrub_device"; "/dev/sdc"]])],
2680 "scrub (securely wipe) a device",
2682 This command writes patterns over C<device> to make data retrieval
2685 It is an interface to the L<scrub(1)> program. See that
2686 manual page for more details.");
2688 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2689 [InitBasicFS, Always, TestRun (
2690 [["write_file"; "/file"; "content"; "0"];
2691 ["scrub_file"; "/file"]])],
2692 "scrub (securely wipe) a file",
2694 This command writes patterns over a file to make data retrieval
2697 The file is I<removed> after scrubbing.
2699 It is an interface to the L<scrub(1)> program. See that
2700 manual page for more details.");
2702 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2703 [], (* XXX needs testing *)
2704 "scrub (securely wipe) free space",
2706 This command creates the directory C<dir> and then fills it
2707 with files until the filesystem is full, and scrubs the files
2708 as for C<guestfs_scrub_file>, and deletes them.
2709 The intention is to scrub any free space on the partition
2712 It is an interface to the L<scrub(1)> program. See that
2713 manual page for more details.");
2715 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2716 [InitBasicFS, Always, TestRun (
2718 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2719 "create a temporary directory",
2721 This command creates a temporary directory. The
2722 C<template> parameter should be a full pathname for the
2723 temporary directory name with the final six characters being
2726 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2727 the second one being suitable for Windows filesystems.
2729 The name of the temporary directory that was created
2732 The temporary directory is created with mode 0700
2733 and is owned by root.
2735 The caller is responsible for deleting the temporary
2736 directory and its contents after use.
2738 See also: L<mkdtemp(3)>");
2740 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2741 [InitISOFS, Always, TestOutputInt (
2742 [["wc_l"; "/10klines"]], 10000)],
2743 "count lines in a file",
2745 This command counts the lines in a file, using the
2746 C<wc -l> external command.");
2748 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2749 [InitISOFS, Always, TestOutputInt (
2750 [["wc_w"; "/10klines"]], 10000)],
2751 "count words in a file",
2753 This command counts the words in a file, using the
2754 C<wc -w> external command.");
2756 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2757 [InitISOFS, Always, TestOutputInt (
2758 [["wc_c"; "/100kallspaces"]], 102400)],
2759 "count characters in a file",
2761 This command counts the characters in a file, using the
2762 C<wc -c> external command.");
2764 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2765 [InitISOFS, Always, TestOutputList (
2766 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2767 "return first 10 lines of a file",
2769 This command returns up to the first 10 lines of a file as
2770 a list of strings.");
2772 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2773 [InitISOFS, Always, TestOutputList (
2774 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2775 InitISOFS, Always, TestOutputList (
2776 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2777 InitISOFS, Always, TestOutputList (
2778 [["head_n"; "0"; "/10klines"]], [])],
2779 "return first N lines of a file",
2781 If the parameter C<nrlines> is a positive number, this returns the first
2782 C<nrlines> lines of the file C<path>.
2784 If the parameter C<nrlines> is a negative number, this returns lines
2785 from the file C<path>, excluding the last C<nrlines> lines.
2787 If the parameter C<nrlines> is zero, this returns an empty list.");
2789 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2790 [InitISOFS, Always, TestOutputList (
2791 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2792 "return last 10 lines of a file",
2794 This command returns up to the last 10 lines of a file as
2795 a list of strings.");
2797 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2798 [InitISOFS, Always, TestOutputList (
2799 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2800 InitISOFS, Always, TestOutputList (
2801 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2802 InitISOFS, Always, TestOutputList (
2803 [["tail_n"; "0"; "/10klines"]], [])],
2804 "return last N lines of a file",
2806 If the parameter C<nrlines> is a positive number, this returns the last
2807 C<nrlines> lines of the file C<path>.
2809 If the parameter C<nrlines> is a negative number, this returns lines
2810 from the file C<path>, starting with the C<-nrlines>th line.
2812 If the parameter C<nrlines> is zero, this returns an empty list.");
2814 ("df", (RString "output", []), 125, [],
2815 [], (* XXX Tricky to test because it depends on the exact format
2816 * of the 'df' command and other imponderables.
2818 "report file system disk space usage",
2820 This command runs the C<df> command to report disk space used.
2822 This command is mostly useful for interactive sessions. It
2823 is I<not> intended that you try to parse the output string.
2824 Use C<statvfs> from programs.");
2826 ("df_h", (RString "output", []), 126, [],
2827 [], (* XXX Tricky to test because it depends on the exact format
2828 * of the 'df' command and other imponderables.
2830 "report file system disk space usage (human readable)",
2832 This command runs the C<df -h> command to report disk space used
2833 in human-readable format.
2835 This command is mostly useful for interactive sessions. It
2836 is I<not> intended that you try to parse the output string.
2837 Use C<statvfs> from programs.");
2839 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2840 [InitISOFS, Always, TestOutputInt (
2841 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2842 "estimate file space usage",
2844 This command runs the C<du -s> command to estimate file space
2847 C<path> can be a file or a directory. If C<path> is a directory
2848 then the estimate includes the contents of the directory and all
2849 subdirectories (recursively).
2851 The result is the estimated size in I<kilobytes>
2852 (ie. units of 1024 bytes).");
2854 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2855 [InitISOFS, Always, TestOutputList (
2856 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2857 "list files in an initrd",
2859 This command lists out files contained in an initrd.
2861 The files are listed without any initial C</> character. The
2862 files are listed in the order they appear (not necessarily
2863 alphabetical). Directory names are listed as separate items.
2865 Old Linux kernels (2.4 and earlier) used a compressed ext2
2866 filesystem as initrd. We I<only> support the newer initramfs
2867 format (compressed cpio files).");
2869 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2871 "mount a file using the loop device",
2873 This command lets you mount C<file> (a filesystem image
2874 in a file) on a mount point. It is entirely equivalent to
2875 the command C<mount -o loop file mountpoint>.");
2877 ("mkswap", (RErr, [Device "device"]), 130, [],
2878 [InitEmpty, Always, TestRun (
2879 [["part_disk"; "/dev/sda"; "mbr"];
2880 ["mkswap"; "/dev/sda1"]])],
2881 "create a swap partition",
2883 Create a swap partition on C<device>.");
2885 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2886 [InitEmpty, Always, TestRun (
2887 [["part_disk"; "/dev/sda"; "mbr"];
2888 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2889 "create a swap partition with a label",
2891 Create a swap partition on C<device> with label C<label>.
2893 Note that you cannot attach a swap label to a block device
2894 (eg. C</dev/sda>), just to a partition. This appears to be
2895 a limitation of the kernel or swap tools.");
2897 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2898 (let uuid = uuidgen () in
2899 [InitEmpty, Always, TestRun (
2900 [["part_disk"; "/dev/sda"; "mbr"];
2901 ["mkswap_U"; uuid; "/dev/sda1"]])]),
2902 "create a swap partition with an explicit UUID",
2904 Create a swap partition on C<device> with UUID C<uuid>.");
2906 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2907 [InitBasicFS, Always, TestOutputStruct (
2908 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2909 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2910 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2911 InitBasicFS, Always, TestOutputStruct (
2912 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2913 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2914 "make block, character or FIFO devices",
2916 This call creates block or character special devices, or
2917 named pipes (FIFOs).
2919 The C<mode> parameter should be the mode, using the standard
2920 constants. C<devmajor> and C<devminor> are the
2921 device major and minor numbers, only used when creating block
2922 and character special devices.");
2924 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
2925 [InitBasicFS, Always, TestOutputStruct (
2926 [["mkfifo"; "0o777"; "/node"];
2927 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2928 "make FIFO (named pipe)",
2930 This call creates a FIFO (named pipe) called C<path> with
2931 mode C<mode>. It is just a convenient wrapper around
2932 C<guestfs_mknod>.");
2934 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
2935 [InitBasicFS, Always, TestOutputStruct (
2936 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2937 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2938 "make block device node",
2940 This call creates a block device node called C<path> with
2941 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2942 It is just a convenient wrapper around C<guestfs_mknod>.");
2944 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
2945 [InitBasicFS, Always, TestOutputStruct (
2946 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2947 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2948 "make char device node",
2950 This call creates a char device node called C<path> with
2951 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2952 It is just a convenient wrapper around C<guestfs_mknod>.");
2954 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2955 [], (* XXX umask is one of those stateful things that we should
2956 * reset between each test.
2958 "set file mode creation mask (umask)",
2960 This function sets the mask used for creating new files and
2961 device nodes to C<mask & 0777>.
2963 Typical umask values would be C<022> which creates new files
2964 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2965 C<002> which creates new files with permissions like
2966 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2968 The default umask is C<022>. This is important because it
2969 means that directories and device nodes will be created with
2970 C<0644> or C<0755> mode even if you specify C<0777>.
2972 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2974 This call returns the previous umask.");
2976 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
2978 "read directories entries",
2980 This returns the list of directory entries in directory C<dir>.
2982 All entries in the directory are returned, including C<.> and
2983 C<..>. The entries are I<not> sorted, but returned in the same
2984 order as the underlying filesystem.
2986 Also this call returns basic file type information about each
2987 file. The C<ftyp> field will contain one of the following characters:
3025 The L<readdir(3)> returned a C<d_type> field with an
3030 This function is primarily intended for use by programs. To
3031 get a simple list of names, use C<guestfs_ls>. To get a printable
3032 directory for human consumption, use C<guestfs_ll>.");
3034 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3036 "create partitions on a block device",
3038 This is a simplified interface to the C<guestfs_sfdisk>
3039 command, where partition sizes are specified in megabytes
3040 only (rounded to the nearest cylinder) and you don't need
3041 to specify the cyls, heads and sectors parameters which
3042 were rarely if ever used anyway.
3044 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3045 and C<guestfs_part_disk>");
3047 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3049 "determine file type inside a compressed file",
3051 This command runs C<file> after first decompressing C<path>
3054 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3056 Since 1.0.63, use C<guestfs_file> instead which can now
3057 process compressed files.");
3059 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3061 "list extended attributes of a file or directory",
3063 This call lists the extended attributes of the file or directory
3066 At the system call level, this is a combination of the
3067 L<listxattr(2)> and L<getxattr(2)> calls.
3069 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3071 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3073 "list extended attributes of a file or directory",
3075 This is the same as C<guestfs_getxattrs>, but if C<path>
3076 is a symbolic link, then it returns the extended attributes
3077 of the link itself.");
3079 ("setxattr", (RErr, [String "xattr";
3080 String "val"; Int "vallen"; (* will be BufferIn *)
3081 Pathname "path"]), 143, [Optional "linuxxattrs"],
3083 "set extended attribute of a file or directory",
3085 This call sets the extended attribute named C<xattr>
3086 of the file C<path> to the value C<val> (of length C<vallen>).
3087 The value is arbitrary 8 bit data.
3089 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3091 ("lsetxattr", (RErr, [String "xattr";
3092 String "val"; Int "vallen"; (* will be BufferIn *)
3093 Pathname "path"]), 144, [Optional "linuxxattrs"],
3095 "set extended attribute of a file or directory",
3097 This is the same as C<guestfs_setxattr>, but if C<path>
3098 is a symbolic link, then it sets an extended attribute
3099 of the link itself.");
3101 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3103 "remove extended attribute of a file or directory",
3105 This call removes the extended attribute named C<xattr>
3106 of the file C<path>.
3108 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3110 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3112 "remove extended attribute of a file or directory",
3114 This is the same as C<guestfs_removexattr>, but if C<path>
3115 is a symbolic link, then it removes an extended attribute
3116 of the link itself.");
3118 ("mountpoints", (RHashtable "mps", []), 147, [],
3122 This call is similar to C<guestfs_mounts>. That call returns
3123 a list of devices. This one returns a hash table (map) of
3124 device name to directory where the device is mounted.");
3126 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3127 (* This is a special case: while you would expect a parameter
3128 * of type "Pathname", that doesn't work, because it implies
3129 * NEED_ROOT in the generated calling code in stubs.c, and
3130 * this function cannot use NEED_ROOT.
3133 "create a mountpoint",
3135 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3136 specialized calls that can be used to create extra mountpoints
3137 before mounting the first filesystem.
3139 These calls are I<only> necessary in some very limited circumstances,
3140 mainly the case where you want to mount a mix of unrelated and/or
3141 read-only filesystems together.
3143 For example, live CDs often contain a \"Russian doll\" nest of
3144 filesystems, an ISO outer layer, with a squashfs image inside, with
3145 an ext2/3 image inside that. You can unpack this as follows
3148 add-ro Fedora-11-i686-Live.iso
3151 mkmountpoint /squash
3154 mount-loop /cd/LiveOS/squashfs.img /squash
3155 mount-loop /squash/LiveOS/ext3fs.img /ext3
3157 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3159 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3161 "remove a mountpoint",
3163 This calls removes a mountpoint that was previously created
3164 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3165 for full details.");
3167 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3168 [InitISOFS, Always, TestOutputBuffer (
3169 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3172 This calls returns the contents of the file C<path> as a
3175 Unlike C<guestfs_cat>, this function can correctly
3176 handle files that contain embedded ASCII NUL characters.
3177 However unlike C<guestfs_download>, this function is limited
3178 in the total size of file that can be handled.");
3180 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3181 [InitISOFS, Always, TestOutputList (
3182 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3183 InitISOFS, Always, TestOutputList (
3184 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3185 "return lines matching a pattern",
3187 This calls the external C<grep> program and returns the
3190 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3191 [InitISOFS, Always, TestOutputList (
3192 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3193 "return lines matching a pattern",
3195 This calls the external C<egrep> program and returns the
3198 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3199 [InitISOFS, Always, TestOutputList (
3200 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3201 "return lines matching a pattern",
3203 This calls the external C<fgrep> program and returns the
3206 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3207 [InitISOFS, Always, TestOutputList (
3208 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3209 "return lines matching a pattern",
3211 This calls the external C<grep -i> program and returns the
3214 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3215 [InitISOFS, Always, TestOutputList (
3216 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3217 "return lines matching a pattern",
3219 This calls the external C<egrep -i> program and returns the
3222 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3223 [InitISOFS, Always, TestOutputList (
3224 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3225 "return lines matching a pattern",
3227 This calls the external C<fgrep -i> program and returns the
3230 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3231 [InitISOFS, Always, TestOutputList (
3232 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3233 "return lines matching a pattern",
3235 This calls the external C<zgrep> program and returns the
3238 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3239 [InitISOFS, Always, TestOutputList (
3240 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3241 "return lines matching a pattern",
3243 This calls the external C<zegrep> program and returns the
3246 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3247 [InitISOFS, Always, TestOutputList (
3248 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3249 "return lines matching a pattern",
3251 This calls the external C<zfgrep> program and returns the
3254 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3255 [InitISOFS, Always, TestOutputList (
3256 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3257 "return lines matching a pattern",
3259 This calls the external C<zgrep -i> program and returns the
3262 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3263 [InitISOFS, Always, TestOutputList (
3264 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3265 "return lines matching a pattern",
3267 This calls the external C<zegrep -i> program and returns the
3270 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3271 [InitISOFS, Always, TestOutputList (
3272 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3273 "return lines matching a pattern",
3275 This calls the external C<zfgrep -i> program and returns the
3278 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3279 [InitISOFS, Always, TestOutput (
3280 [["realpath"; "/../directory"]], "/directory")],
3281 "canonicalized absolute pathname",
3283 Return the canonicalized absolute pathname of C<path>. The
3284 returned path has no C<.>, C<..> or symbolic link path elements.");
3286 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3287 [InitBasicFS, Always, TestOutputStruct (
3290 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3291 "create a hard link",
3293 This command creates a hard link using the C<ln> command.");
3295 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3296 [InitBasicFS, Always, TestOutputStruct (
3299 ["ln_f"; "/a"; "/b"];
3300 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3301 "create a hard link",
3303 This command creates a hard link using the C<ln -f> command.
3304 The C<-f> option removes the link (C<linkname>) if it exists already.");
3306 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3307 [InitBasicFS, Always, TestOutputStruct (
3309 ["ln_s"; "a"; "/b"];
3310 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3311 "create a symbolic link",
3313 This command creates a symbolic link using the C<ln -s> command.");
3315 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3316 [InitBasicFS, Always, TestOutput (
3317 [["mkdir_p"; "/a/b"];
3318 ["touch"; "/a/b/c"];
3319 ["ln_sf"; "../d"; "/a/b/c"];
3320 ["readlink"; "/a/b/c"]], "../d")],
3321 "create a symbolic link",
3323 This command creates a symbolic link using the C<ln -sf> command,
3324 The C<-f> option removes the link (C<linkname>) if it exists already.");
3326 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3327 [] (* XXX tested above *),
3328 "read the target of a symbolic link",
3330 This command reads the target of a symbolic link.");
3332 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3333 [InitBasicFS, Always, TestOutputStruct (
3334 [["fallocate"; "/a"; "1000000"];
3335 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3336 "preallocate a file in the guest filesystem",
3338 This command preallocates a file (containing zero bytes) named
3339 C<path> of size C<len> bytes. If the file exists already, it
3342 Do not confuse this with the guestfish-specific
3343 C<alloc> command which allocates a file in the host and
3344 attaches it as a device.");
3346 ("swapon_device", (RErr, [Device "device"]), 170, [],
3347 [InitPartition, Always, TestRun (
3348 [["mkswap"; "/dev/sda1"];
3349 ["swapon_device"; "/dev/sda1"];
3350 ["swapoff_device"; "/dev/sda1"]])],
3351 "enable swap on device",
3353 This command enables the libguestfs appliance to use the
3354 swap device or partition named C<device>. The increased
3355 memory is made available for all commands, for example
3356 those run using C<guestfs_command> or C<guestfs_sh>.
3358 Note that you should not swap to existing guest swap
3359 partitions unless you know what you are doing. They may
3360 contain hibernation information, or other information that
3361 the guest doesn't want you to trash. You also risk leaking
3362 information about the host to the guest this way. Instead,
3363 attach a new host device to the guest and swap on that.");
3365 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3366 [], (* XXX tested by swapon_device *)
3367 "disable swap on device",
3369 This command disables the libguestfs appliance swap
3370 device or partition named C<device>.
3371 See C<guestfs_swapon_device>.");
3373 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3374 [InitBasicFS, Always, TestRun (
3375 [["fallocate"; "/swap"; "8388608"];
3376 ["mkswap_file"; "/swap"];
3377 ["swapon_file"; "/swap"];
3378 ["swapoff_file"; "/swap"]])],
3379 "enable swap on file",
3381 This command enables swap to a file.
3382 See C<guestfs_swapon_device> for other notes.");
3384 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3385 [], (* XXX tested by swapon_file *)
3386 "disable swap on file",
3388 This command disables the libguestfs appliance swap on file.");
3390 ("swapon_label", (RErr, [String "label"]), 174, [],
3391 [InitEmpty, Always, TestRun (
3392 [["part_disk"; "/dev/sdb"; "mbr"];
3393 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3394 ["swapon_label"; "swapit"];
3395 ["swapoff_label"; "swapit"];
3396 ["zero"; "/dev/sdb"];
3397 ["blockdev_rereadpt"; "/dev/sdb"]])],
3398 "enable swap on labeled swap partition",
3400 This command enables swap to a labeled swap partition.
3401 See C<guestfs_swapon_device> for other notes.");
3403 ("swapoff_label", (RErr, [String "label"]), 175, [],
3404 [], (* XXX tested by swapon_label *)
3405 "disable swap on labeled swap partition",
3407 This command disables the libguestfs appliance swap on
3408 labeled swap partition.");
3410 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3411 (let uuid = uuidgen () in
3412 [InitEmpty, Always, TestRun (
3413 [["mkswap_U"; uuid; "/dev/sdb"];
3414 ["swapon_uuid"; uuid];
3415 ["swapoff_uuid"; uuid]])]),
3416 "enable swap on swap partition by UUID",
3418 This command enables swap to a swap partition with the given UUID.
3419 See C<guestfs_swapon_device> for other notes.");
3421 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3422 [], (* XXX tested by swapon_uuid *)
3423 "disable swap on swap partition by UUID",
3425 This command disables the libguestfs appliance swap partition
3426 with the given UUID.");
3428 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3429 [InitBasicFS, Always, TestRun (
3430 [["fallocate"; "/swap"; "8388608"];
3431 ["mkswap_file"; "/swap"]])],
3432 "create a swap file",
3436 This command just writes a swap file signature to an existing
3437 file. To create the file itself, use something like C<guestfs_fallocate>.");
3439 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3440 [InitISOFS, Always, TestRun (
3441 [["inotify_init"; "0"]])],
3442 "create an inotify handle",
3444 This command creates a new inotify handle.
3445 The inotify subsystem can be used to notify events which happen to
3446 objects in the guest filesystem.
3448 C<maxevents> is the maximum number of events which will be
3449 queued up between calls to C<guestfs_inotify_read> or
3450 C<guestfs_inotify_files>.
3451 If this is passed as C<0>, then the kernel (or previously set)
3452 default is used. For Linux 2.6.29 the default was 16384 events.
3453 Beyond this limit, the kernel throws away events, but records
3454 the fact that it threw them away by setting a flag
3455 C<IN_Q_OVERFLOW> in the returned structure list (see
3456 C<guestfs_inotify_read>).
3458 Before any events are generated, you have to add some
3459 watches to the internal watch list. See:
3460 C<guestfs_inotify_add_watch>,
3461 C<guestfs_inotify_rm_watch> and
3462 C<guestfs_inotify_watch_all>.
3464 Queued up events should be read periodically by calling
3465 C<guestfs_inotify_read>
3466 (or C<guestfs_inotify_files> which is just a helpful
3467 wrapper around C<guestfs_inotify_read>). If you don't
3468 read the events out often enough then you risk the internal
3471 The handle should be closed after use by calling
3472 C<guestfs_inotify_close>. This also removes any
3473 watches automatically.
3475 See also L<inotify(7)> for an overview of the inotify interface
3476 as exposed by the Linux kernel, which is roughly what we expose
3477 via libguestfs. Note that there is one global inotify handle
3478 per libguestfs instance.");
3480 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3481 [InitBasicFS, Always, TestOutputList (
3482 [["inotify_init"; "0"];
3483 ["inotify_add_watch"; "/"; "1073741823"];
3486 ["inotify_files"]], ["a"; "b"])],
3487 "add an inotify watch",
3489 Watch C<path> for the events listed in C<mask>.
3491 Note that if C<path> is a directory then events within that
3492 directory are watched, but this does I<not> happen recursively
3493 (in subdirectories).
3495 Note for non-C or non-Linux callers: the inotify events are
3496 defined by the Linux kernel ABI and are listed in
3497 C</usr/include/sys/inotify.h>.");
3499 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3501 "remove an inotify watch",
3503 Remove a previously defined inotify watch.
3504 See C<guestfs_inotify_add_watch>.");
3506 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3508 "return list of inotify events",
3510 Return the complete queue of events that have happened
3511 since the previous read call.
3513 If no events have happened, this returns an empty list.
3515 I<Note>: In order to make sure that all events have been
3516 read, you must call this function repeatedly until it
3517 returns an empty list. The reason is that the call will
3518 read events up to the maximum appliance-to-host message
3519 size and leave remaining events in the queue.");
3521 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3523 "return list of watched files that had events",
3525 This function is a helpful wrapper around C<guestfs_inotify_read>
3526 which just returns a list of pathnames of objects that were
3527 touched. The returned pathnames are sorted and deduplicated.");
3529 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3531 "close the inotify handle",
3533 This closes the inotify handle which was previously
3534 opened by inotify_init. It removes all watches, throws
3535 away any pending events, and deallocates all resources.");
3537 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3539 "set SELinux security context",
3541 This sets the SELinux security context of the daemon
3542 to the string C<context>.
3544 See the documentation about SELINUX in L<guestfs(3)>.");
3546 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3548 "get SELinux security context",
3550 This gets the SELinux security context of the daemon.
3552 See the documentation about SELINUX in L<guestfs(3)>,
3553 and C<guestfs_setcon>");
3555 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3556 [InitEmpty, Always, TestOutput (
3557 [["part_disk"; "/dev/sda"; "mbr"];
3558 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3559 ["mount"; "/dev/sda1"; "/"];
3560 ["write_file"; "/new"; "new file contents"; "0"];
3561 ["cat"; "/new"]], "new file contents")],
3562 "make a filesystem with block size",
3564 This call is similar to C<guestfs_mkfs>, but it allows you to
3565 control the block size of the resulting filesystem. Supported
3566 block sizes depend on the filesystem type, but typically they
3567 are C<1024>, C<2048> or C<4096> only.");
3569 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3570 [InitEmpty, Always, TestOutput (
3571 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3572 ["mke2journal"; "4096"; "/dev/sda1"];
3573 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3574 ["mount"; "/dev/sda2"; "/"];
3575 ["write_file"; "/new"; "new file contents"; "0"];
3576 ["cat"; "/new"]], "new file contents")],
3577 "make ext2/3/4 external journal",
3579 This creates an ext2 external journal on C<device>. It is equivalent
3582 mke2fs -O journal_dev -b blocksize device");
3584 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3585 [InitEmpty, Always, TestOutput (
3586 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3587 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3588 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3589 ["mount"; "/dev/sda2"; "/"];
3590 ["write_file"; "/new"; "new file contents"; "0"];
3591 ["cat"; "/new"]], "new file contents")],
3592 "make ext2/3/4 external journal with label",
3594 This creates an ext2 external journal on C<device> with label C<label>.");
3596 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3597 (let uuid = uuidgen () in
3598 [InitEmpty, Always, TestOutput (
3599 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3600 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3601 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3602 ["mount"; "/dev/sda2"; "/"];
3603 ["write_file"; "/new"; "new file contents"; "0"];
3604 ["cat"; "/new"]], "new file contents")]),
3605 "make ext2/3/4 external journal with UUID",
3607 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3609 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3611 "make ext2/3/4 filesystem with external journal",
3613 This creates an ext2/3/4 filesystem on C<device> with
3614 an external journal on C<journal>. It is equivalent
3617 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3619 See also C<guestfs_mke2journal>.");
3621 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3623 "make ext2/3/4 filesystem with external journal",
3625 This creates an ext2/3/4 filesystem on C<device> with
3626 an external journal on the journal labeled C<label>.
3628 See also C<guestfs_mke2journal_L>.");
3630 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3632 "make ext2/3/4 filesystem with external journal",
3634 This creates an ext2/3/4 filesystem on C<device> with
3635 an external journal on the journal with UUID C<uuid>.
3637 See also C<guestfs_mke2journal_U>.");
3639 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3640 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3641 "load a kernel module",
3643 This loads a kernel module in the appliance.
3645 The kernel module must have been whitelisted when libguestfs
3646 was built (see C<appliance/kmod.whitelist.in> in the source).");
3648 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3649 [InitNone, Always, TestOutput (
3650 [["echo_daemon"; "This is a test"]], "This is a test"
3652 "echo arguments back to the client",
3654 This command concatenate the list of C<words> passed with single spaces between
3655 them and returns the resulting string.
3657 You can use this command to test the connection through to the daemon.
3659 See also C<guestfs_ping_daemon>.");
3661 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3662 [], (* There is a regression test for this. *)
3663 "find all files and directories, returning NUL-separated list",
3665 This command lists out all files and directories, recursively,
3666 starting at C<directory>, placing the resulting list in the
3667 external file called C<files>.
3669 This command works the same way as C<guestfs_find> with the
3670 following exceptions:
3676 The resulting list is written to an external file.
3680 Items (filenames) in the result are separated
3681 by C<\\0> characters. See L<find(1)> option I<-print0>.
3685 This command is not limited in the number of names that it
3690 The result list is not sorted.
3694 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3695 [InitISOFS, Always, TestOutput (
3696 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3697 InitISOFS, Always, TestOutput (
3698 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3699 InitISOFS, Always, TestOutput (
3700 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3701 InitISOFS, Always, TestLastFail (
3702 [["case_sensitive_path"; "/Known-1/"]]);
3703 InitBasicFS, Always, TestOutput (
3705 ["mkdir"; "/a/bbb"];
3706 ["touch"; "/a/bbb/c"];
3707 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3708 InitBasicFS, Always, TestOutput (
3710 ["mkdir"; "/a/bbb"];
3711 ["touch"; "/a/bbb/c"];
3712 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3713 InitBasicFS, Always, TestLastFail (
3715 ["mkdir"; "/a/bbb"];
3716 ["touch"; "/a/bbb/c"];
3717 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3718 "return true path on case-insensitive filesystem",
3720 This can be used to resolve case insensitive paths on
3721 a filesystem which is case sensitive. The use case is
3722 to resolve paths which you have read from Windows configuration
3723 files or the Windows Registry, to the true path.
3725 The command handles a peculiarity of the Linux ntfs-3g
3726 filesystem driver (and probably others), which is that although
3727 the underlying filesystem is case-insensitive, the driver
3728 exports the filesystem to Linux as case-sensitive.
3730 One consequence of this is that special directories such
3731 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3732 (or other things) depending on the precise details of how
3733 they were created. In Windows itself this would not be
3736 Bug or feature? You decide:
3737 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3739 This function resolves the true case of each element in the
3740 path and returns the case-sensitive path.
3742 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3743 might return C<\"/WINDOWS/system32\"> (the exact return value
3744 would depend on details of how the directories were originally
3745 created under Windows).
3748 This function does not handle drive names, backslashes etc.
3750 See also C<guestfs_realpath>.");
3752 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3753 [InitBasicFS, Always, TestOutput (
3754 [["vfs_type"; "/dev/sda1"]], "ext2")],
3755 "get the Linux VFS type corresponding to a mounted device",
3757 This command gets the block device type corresponding to
3758 a mounted device called C<device>.
3760 Usually the result is the name of the Linux VFS module that
3761 is used to mount this device (probably determined automatically
3762 if you used the C<guestfs_mount> call).");
3764 ("truncate", (RErr, [Pathname "path"]), 199, [],
3765 [InitBasicFS, Always, TestOutputStruct (
3766 [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3767 ["truncate"; "/test"];
3768 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3769 "truncate a file to zero size",
3771 This command truncates C<path> to a zero-length file. The
3772 file must exist already.");
3774 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3775 [InitBasicFS, Always, TestOutputStruct (
3776 [["touch"; "/test"];
3777 ["truncate_size"; "/test"; "1000"];
3778 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3779 "truncate a file to a particular size",
3781 This command truncates C<path> to size C<size> bytes. The file
3782 must exist already. If the file is smaller than C<size> then
3783 the file is extended to the required size with null bytes.");
3785 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3786 [InitBasicFS, Always, TestOutputStruct (
3787 [["touch"; "/test"];
3788 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3789 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3790 "set timestamp of a file with nanosecond precision",
3792 This command sets the timestamps of a file with nanosecond
3795 C<atsecs, atnsecs> are the last access time (atime) in secs and
3796 nanoseconds from the epoch.
3798 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3799 secs and nanoseconds from the epoch.
3801 If the C<*nsecs> field contains the special value C<-1> then
3802 the corresponding timestamp is set to the current time. (The
3803 C<*secs> field is ignored in this case).
3805 If the C<*nsecs> field contains the special value C<-2> then
3806 the corresponding timestamp is left unchanged. (The
3807 C<*secs> field is ignored in this case).");
3809 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3810 [InitBasicFS, Always, TestOutputStruct (
3811 [["mkdir_mode"; "/test"; "0o111"];
3812 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3813 "create a directory with a particular mode",
3815 This command creates a directory, setting the initial permissions
3816 of the directory to C<mode>. See also C<guestfs_mkdir>.");
3818 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3820 "change file owner and group",
3822 Change the file owner to C<owner> and group to C<group>.
3823 This is like C<guestfs_chown> but if C<path> is a symlink then
3824 the link itself is changed, not the target.
3826 Only numeric uid and gid are supported. If you want to use
3827 names, you will need to locate and parse the password file
3828 yourself (Augeas support makes this relatively easy).");
3830 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3832 "lstat on multiple files",
3834 This call allows you to perform the C<guestfs_lstat> operation
3835 on multiple files, where all files are in the directory C<path>.
3836 C<names> is the list of files from this directory.
3838 On return you get a list of stat structs, with a one-to-one
3839 correspondence to the C<names> list. If any name did not exist
3840 or could not be lstat'd, then the C<ino> field of that structure
3843 This call is intended for programs that want to efficiently
3844 list a directory contents without making many round-trips.
3845 See also C<guestfs_lxattrlist> for a similarly efficient call
3846 for getting extended attributes. Very long directory listings
3847 might cause the protocol message size to be exceeded, causing
3848 this call to fail. The caller must split up such requests
3849 into smaller groups of names.");
3851 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3853 "lgetxattr on multiple files",
3855 This call allows you to get the extended attributes
3856 of multiple files, where all files are in the directory C<path>.
3857 C<names> is the list of files from this directory.
3859 On return you get a flat list of xattr structs which must be
3860 interpreted sequentially. The first xattr struct always has a zero-length
3861 C<attrname>. C<attrval> in this struct is zero-length
3862 to indicate there was an error doing C<lgetxattr> for this
3863 file, I<or> is a C string which is a decimal number
3864 (the number of following attributes for this file, which could
3865 be C<\"0\">). Then after the first xattr struct are the
3866 zero or more attributes for the first named file.
3867 This repeats for the second and subsequent files.
3869 This call is intended for programs that want to efficiently
3870 list a directory contents without making many round-trips.
3871 See also C<guestfs_lstatlist> for a similarly efficient call
3872 for getting standard stats. Very long directory listings
3873 might cause the protocol message size to be exceeded, causing
3874 this call to fail. The caller must split up such requests
3875 into smaller groups of names.");
3877 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3879 "readlink on multiple files",
3881 This call allows you to do a C<readlink> operation
3882 on multiple files, where all files are in the directory C<path>.
3883 C<names> is the list of files from this directory.
3885 On return you get a list of strings, with a one-to-one
3886 correspondence to the C<names> list. Each string is the
3887 value of the symbol link.
3889 If the C<readlink(2)> operation fails on any name, then
3890 the corresponding result string is the empty string C<\"\">.
3891 However the whole operation is completed even if there
3892 were C<readlink(2)> errors, and so you can call this
3893 function with names where you don't know if they are
3894 symbolic links already (albeit slightly less efficient).
3896 This call is intended for programs that want to efficiently
3897 list a directory contents without making many round-trips.
3898 Very long directory listings might cause the protocol
3899 message size to be exceeded, causing
3900 this call to fail. The caller must split up such requests
3901 into smaller groups of names.");
3903 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3904 [InitISOFS, Always, TestOutputBuffer (
3905 [["pread"; "/known-4"; "1"; "3"]], "\n");
3906 InitISOFS, Always, TestOutputBuffer (
3907 [["pread"; "/empty"; "0"; "100"]], "")],
3908 "read part of a file",
3910 This command lets you read part of a file. It reads C<count>
3911 bytes of the file, starting at C<offset>, from file C<path>.
3913 This may read fewer bytes than requested. For further details
3914 see the L<pread(2)> system call.");
3916 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3917 [InitEmpty, Always, TestRun (
3918 [["part_init"; "/dev/sda"; "gpt"]])],
3919 "create an empty partition table",
3921 This creates an empty partition table on C<device> of one of the
3922 partition types listed below. Usually C<parttype> should be
3923 either C<msdos> or C<gpt> (for large disks).
3925 Initially there are no partitions. Following this, you should
3926 call C<guestfs_part_add> for each partition required.
3928 Possible values for C<parttype> are:
3932 =item B<efi> | B<gpt>
3934 Intel EFI / GPT partition table.
3936 This is recommended for >= 2 TB partitions that will be accessed
3937 from Linux and Intel-based Mac OS X. It also has limited backwards
3938 compatibility with the C<mbr> format.
3940 =item B<mbr> | B<msdos>
3942 The standard PC \"Master Boot Record\" (MBR) format used
3943 by MS-DOS and Windows. This partition type will B<only> work
3944 for device sizes up to 2 TB. For large disks we recommend
3949 Other partition table types that may work but are not
3958 =item B<amiga> | B<rdb>
3960 Amiga \"Rigid Disk Block\" format.
3968 DASD, used on IBM mainframes.
3976 Old Mac partition format. Modern Macs use C<gpt>.
3980 NEC PC-98 format, common in Japan apparently.
3988 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
3989 [InitEmpty, Always, TestRun (
3990 [["part_init"; "/dev/sda"; "mbr"];
3991 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
3992 InitEmpty, Always, TestRun (
3993 [["part_init"; "/dev/sda"; "gpt"];
3994 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
3995 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
3996 InitEmpty, Always, TestRun (
3997 [["part_init"; "/dev/sda"; "mbr"];
3998 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
3999 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4000 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4001 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4002 "add a partition to the device",
4004 This command adds a partition to C<device>. If there is no partition
4005 table on the device, call C<guestfs_part_init> first.
4007 The C<prlogex> parameter is the type of partition. Normally you
4008 should pass C<p> or C<primary> here, but MBR partition tables also
4009 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4012 C<startsect> and C<endsect> are the start and end of the partition
4013 in I<sectors>. C<endsect> may be negative, which means it counts
4014 backwards from the end of the disk (C<-1> is the last sector).
4016 Creating a partition which covers the whole disk is not so easy.
4017 Use C<guestfs_part_disk> to do that.");
4019 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4020 [InitEmpty, Always, TestRun (
4021 [["part_disk"; "/dev/sda"; "mbr"]]);
4022 InitEmpty, Always, TestRun (
4023 [["part_disk"; "/dev/sda"; "gpt"]])],
4024 "partition whole disk with a single primary partition",
4026 This command is simply a combination of C<guestfs_part_init>
4027 followed by C<guestfs_part_add> to create a single primary partition
4028 covering the whole disk.
4030 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4031 but other possible values are described in C<guestfs_part_init>.");
4033 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4034 [InitEmpty, Always, TestRun (
4035 [["part_disk"; "/dev/sda"; "mbr"];
4036 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4037 "make a partition bootable",
4039 This sets the bootable flag on partition numbered C<partnum> on
4040 device C<device>. Note that partitions are numbered from 1.
4042 The bootable flag is used by some PC BIOSes to determine which
4043 partition to boot from. It is by no means universally recognized,
4044 and in any case if your operating system installed a boot
4045 sector on the device itself, then that takes precedence.");
4047 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4048 [InitEmpty, Always, TestRun (
4049 [["part_disk"; "/dev/sda"; "gpt"];
4050 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4051 "set partition name",
4053 This sets the partition name on partition numbered C<partnum> on
4054 device C<device>. Note that partitions are numbered from 1.
4056 The partition name can only be set on certain types of partition
4057 table. This works on C<gpt> but not on C<mbr> partitions.");
4059 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4060 [], (* XXX Add a regression test for this. *)
4061 "list partitions on a device",
4063 This command parses the partition table on C<device> and
4064 returns the list of partitions found.
4066 The fields in the returned structure are:
4072 Partition number, counting from 1.
4076 Start of the partition I<in bytes>. To get sectors you have to
4077 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4081 End of the partition in bytes.
4085 Size of the partition in bytes.
4089 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4090 [InitEmpty, Always, TestOutput (
4091 [["part_disk"; "/dev/sda"; "gpt"];
4092 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4093 "get the partition table type",
4095 This command examines the partition table on C<device> and
4096 returns the partition table type (format) being used.
4098 Common return values include: C<msdos> (a DOS/Windows style MBR
4099 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4100 values are possible, although unusual. See C<guestfs_part_init>
4103 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4104 [InitBasicFS, Always, TestOutputBuffer (
4105 [["fill"; "0x63"; "10"; "/test"];
4106 ["read_file"; "/test"]], "cccccccccc")],
4107 "fill a file with octets",
4109 This command creates a new file called C<path>. The initial
4110 content of the file is C<len> octets of C<c>, where C<c>
4111 must be a number in the range C<[0..255]>.
4113 To fill a file with zero bytes (sparsely), it is
4114 much more efficient to use C<guestfs_truncate_size>.");
4116 ("available", (RErr, [StringList "groups"]), 216, [],
4117 [InitNone, Always, TestRun [["available"; ""]]],
4118 "test availability of some parts of the API",
4120 This command is used to check the availability of some
4121 groups of functionality in the appliance, which not all builds of
4122 the libguestfs appliance will be able to provide.
4124 The libguestfs groups, and the functions that those
4125 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4127 The argument C<groups> is a list of group names, eg:
4128 C<[\"inotify\", \"augeas\"]> would check for the availability of
4129 the Linux inotify functions and Augeas (configuration file
4132 The command returns no error if I<all> requested groups are available.
4134 It fails with an error if one or more of the requested
4135 groups is unavailable in the appliance.
4137 If an unknown group name is included in the
4138 list of groups then an error is always returned.
4146 You must call C<guestfs_launch> before calling this function.
4148 The reason is because we don't know what groups are
4149 supported by the appliance/daemon until it is running and can
4154 If a group of functions is available, this does not necessarily
4155 mean that they will work. You still have to check for errors
4156 when calling individual API functions even if they are
4161 It is usually the job of distro packagers to build
4162 complete functionality into the libguestfs appliance.
4163 Upstream libguestfs, if built from source with all
4164 requirements satisfied, will support everything.
4168 This call was added in version C<1.0.80>. In previous
4169 versions of libguestfs all you could do would be to speculatively
4170 execute a command to find out if the daemon implemented it.
4171 See also C<guestfs_version>.
4175 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4176 [InitBasicFS, Always, TestOutputBuffer (
4177 [["write_file"; "/src"; "hello, world"; "0"];
4178 ["dd"; "/src"; "/dest"];
4179 ["read_file"; "/dest"]], "hello, world")],
4180 "copy from source to destination using dd",
4182 This command copies from one source device or file C<src>
4183 to another destination device or file C<dest>. Normally you
4184 would use this to copy to or from a device or partition, for
4185 example to duplicate a filesystem.
4187 If the destination is a device, it must be as large or larger
4188 than the source file or device, otherwise the copy will fail.
4189 This command cannot do partial copies.");
4193 let all_functions = non_daemon_functions @ daemon_functions
4195 (* In some places we want the functions to be displayed sorted
4196 * alphabetically, so this is useful:
4198 let all_functions_sorted =
4199 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4200 compare n1 n2) all_functions
4202 (* Field types for structures. *)
4204 | FChar (* C 'char' (really, a 7 bit byte). *)
4205 | FString (* nul-terminated ASCII string, NOT NULL. *)
4206 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4211 | FBytes (* Any int measure that counts bytes. *)
4212 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4213 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4215 (* Because we generate extra parsing code for LVM command line tools,
4216 * we have to pull out the LVM columns separately here.
4226 "pv_attr", FString (* XXX *);
4227 "pv_pe_count", FInt64;
4228 "pv_pe_alloc_count", FInt64;
4231 "pv_mda_count", FInt64;
4232 "pv_mda_free", FBytes;
4233 (* Not in Fedora 10:
4234 "pv_mda_size", FBytes;
4241 "vg_attr", FString (* XXX *);
4244 "vg_sysid", FString;
4245 "vg_extent_size", FBytes;
4246 "vg_extent_count", FInt64;
4247 "vg_free_count", FInt64;
4252 "snap_count", FInt64;
4255 "vg_mda_count", FInt64;
4256 "vg_mda_free", FBytes;
4257 (* Not in Fedora 10:
4258 "vg_mda_size", FBytes;
4264 "lv_attr", FString (* XXX *);
4267 "lv_kernel_major", FInt64;
4268 "lv_kernel_minor", FInt64;
4270 "seg_count", FInt64;
4272 "snap_percent", FOptPercent;
4273 "copy_percent", FOptPercent;
4276 "mirror_log", FString;
4280 (* Names and fields in all structures (in RStruct and RStructList)
4284 (* The old RIntBool return type, only ever used for aug_defnode. Do
4285 * not use this struct in any new code.
4288 "i", FInt32; (* for historical compatibility *)
4289 "b", FInt32; (* for historical compatibility *)
4292 (* LVM PVs, VGs, LVs. *)
4293 "lvm_pv", lvm_pv_cols;
4294 "lvm_vg", lvm_vg_cols;
4295 "lvm_lv", lvm_lv_cols;
4297 (* Column names and types from stat structures.
4298 * NB. Can't use things like 'st_atime' because glibc header files
4299 * define some of these as macros. Ugh.
4330 (* Column names in dirent structure. *)
4333 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4338 (* Version numbers. *)
4346 (* Extended attribute. *)
4348 "attrname", FString;
4352 (* Inotify events. *)
4356 "in_cookie", FUInt32;
4360 (* Partition table entry. *)
4363 "part_start", FBytes;
4365 "part_size", FBytes;
4367 ] (* end of structs *)
4369 (* Ugh, Java has to be different ..
4370 * These names are also used by the Haskell bindings.
4372 let java_structs = [
4373 "int_bool", "IntBool";
4378 "statvfs", "StatVFS";
4380 "version", "Version";
4382 "inotify_event", "INotifyEvent";
4383 "partition", "Partition";
4386 (* What structs are actually returned. *)
4387 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4389 (* Returns a list of RStruct/RStructList structs that are returned
4390 * by any function. Each element of returned list is a pair:
4392 * (structname, RStructOnly)
4393 * == there exists function which returns RStruct (_, structname)
4394 * (structname, RStructListOnly)
4395 * == there exists function which returns RStructList (_, structname)
4396 * (structname, RStructAndList)
4397 * == there are functions returning both RStruct (_, structname)
4398 * and RStructList (_, structname)
4400 let rstructs_used_by functions =
4401 (* ||| is a "logical OR" for rstructs_used_t *)
4405 | _, RStructAndList -> RStructAndList
4406 | RStructOnly, RStructListOnly
4407 | RStructListOnly, RStructOnly -> RStructAndList
4408 | RStructOnly, RStructOnly -> RStructOnly
4409 | RStructListOnly, RStructListOnly -> RStructListOnly
4412 let h = Hashtbl.create 13 in
4414 (* if elem->oldv exists, update entry using ||| operator,
4415 * else just add elem->newv to the hash
4417 let update elem newv =
4418 try let oldv = Hashtbl.find h elem in
4419 Hashtbl.replace h elem (newv ||| oldv)
4420 with Not_found -> Hashtbl.add h elem newv
4424 fun (_, style, _, _, _, _, _) ->
4425 match fst style with
4426 | RStruct (_, structname) -> update structname RStructOnly
4427 | RStructList (_, structname) -> update structname RStructListOnly
4431 (* return key->values as a list of (key,value) *)
4432 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4434 (* Used for testing language bindings. *)
4436 | CallString of string
4437 | CallOptString of string option
4438 | CallStringList of string list
4440 | CallInt64 of int64
4443 (* Used to memoize the result of pod2text. *)
4444 let pod2text_memo_filename = "src/.pod2text.data"
4445 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4447 let chan = open_in pod2text_memo_filename in
4448 let v = input_value chan in
4452 _ -> Hashtbl.create 13
4453 let pod2text_memo_updated () =
4454 let chan = open_out pod2text_memo_filename in
4455 output_value chan pod2text_memo;
4458 (* Useful functions.
4459 * Note we don't want to use any external OCaml libraries which
4460 * makes this a bit harder than it should be.
4462 module StringMap = Map.Make (String)
4464 let failwithf fs = ksprintf failwith fs
4466 let unique = let i = ref 0 in fun () -> incr i; !i
4468 let replace_char s c1 c2 =
4469 let s2 = String.copy s in
4470 let r = ref false in
4471 for i = 0 to String.length s2 - 1 do
4472 if String.unsafe_get s2 i = c1 then (
4473 String.unsafe_set s2 i c2;
4477 if not !r then s else s2
4481 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4483 let triml ?(test = isspace) str =
4485 let n = ref (String.length str) in
4486 while !n > 0 && test str.[!i]; do
4491 else String.sub str !i !n
4493 let trimr ?(test = isspace) str =
4494 let n = ref (String.length str) in
4495 while !n > 0 && test str.[!n-1]; do
4498 if !n = String.length str then str
4499 else String.sub str 0 !n
4501 let trim ?(test = isspace) str =
4502 trimr ~test (triml ~test str)
4504 let rec find s sub =
4505 let len = String.length s in
4506 let sublen = String.length sub in
4508 if i <= len-sublen then (
4510 if j < sublen then (
4511 if s.[i+j] = sub.[j] then loop2 (j+1)
4517 if r = -1 then loop (i+1) else r
4523 let rec replace_str s s1 s2 =
4524 let len = String.length s in
4525 let sublen = String.length s1 in
4526 let i = find s s1 in
4529 let s' = String.sub s 0 i in
4530 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4531 s' ^ s2 ^ replace_str s'' s1 s2
4534 let rec string_split sep str =
4535 let len = String.length str in
4536 let seplen = String.length sep in
4537 let i = find str sep in
4538 if i = -1 then [str]
4540 let s' = String.sub str 0 i in
4541 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4542 s' :: string_split sep s''
4545 let files_equal n1 n2 =
4546 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4547 match Sys.command cmd with
4550 | i -> failwithf "%s: failed with error code %d" cmd i
4552 let rec filter_map f = function
4556 | Some y -> y :: filter_map f xs
4557 | None -> filter_map f xs
4559 let rec find_map f = function
4560 | [] -> raise Not_found
4564 | None -> find_map f xs
4567 let rec loop i = function
4569 | x :: xs -> f i x; loop (i+1) xs
4574 let rec loop i = function
4576 | x :: xs -> let r = f i x in r :: loop (i+1) xs
4580 let count_chars c str =
4581 let count = ref 0 in
4582 for i = 0 to String.length str - 1 do
4583 if c = String.unsafe_get str i then incr count
4587 let name_of_argt = function
4588 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4589 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4590 | FileIn n | FileOut n -> n
4592 let java_name_of_struct typ =
4593 try List.assoc typ java_structs
4596 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4598 let cols_of_struct typ =
4599 try List.assoc typ structs
4601 failwithf "cols_of_struct: unknown struct %s" typ
4603 let seq_of_test = function
4604 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4605 | TestOutputListOfDevices (s, _)
4606 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4607 | TestOutputTrue s | TestOutputFalse s
4608 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4609 | TestOutputStruct (s, _)
4610 | TestLastFail s -> s
4612 (* Handling for function flags. *)
4613 let protocol_limit_warning =
4614 "Because of the message protocol, there is a transfer limit
4615 of somewhere between 2MB and 4MB. To transfer large files you should use
4618 let danger_will_robinson =
4619 "B<This command is dangerous. Without careful use you
4620 can easily destroy all your data>."
4622 let deprecation_notice flags =
4625 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4627 sprintf "This function is deprecated.
4628 In new code, use the C<%s> call instead.
4630 Deprecated functions will not be removed from the API, but the
4631 fact that they are deprecated indicates that there are problems
4632 with correct use of these functions." alt in
4637 (* Create list of optional groups. *)
4639 let h = Hashtbl.create 13 in
4641 fun (name, _, _, flags, _, _, _) ->
4645 let names = try Hashtbl.find h group with Not_found -> [] in
4646 Hashtbl.replace h group (name :: names)
4650 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4653 fun group -> group, List.sort compare (Hashtbl.find h group)
4655 List.sort (fun x y -> compare (fst x) (fst y)) groups
4657 (* Check function names etc. for consistency. *)
4658 let check_functions () =
4659 let contains_uppercase str =
4660 let len = String.length str in
4662 if i >= len then false
4665 if c >= 'A' && c <= 'Z' then true
4672 (* Check function names. *)
4674 fun (name, _, _, _, _, _, _) ->
4675 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4676 failwithf "function name %s does not need 'guestfs' prefix" name;
4678 failwithf "function name is empty";
4679 if name.[0] < 'a' || name.[0] > 'z' then
4680 failwithf "function name %s must start with lowercase a-z" name;
4681 if String.contains name '-' then
4682 failwithf "function name %s should not contain '-', use '_' instead."
4686 (* Check function parameter/return names. *)
4688 fun (name, style, _, _, _, _, _) ->
4689 let check_arg_ret_name n =
4690 if contains_uppercase n then
4691 failwithf "%s param/ret %s should not contain uppercase chars"
4693 if String.contains n '-' || String.contains n '_' then
4694 failwithf "%s param/ret %s should not contain '-' or '_'"
4697 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;
4698 if n = "int" || n = "char" || n = "short" || n = "long" then
4699 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4700 if n = "i" || n = "n" then
4701 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4702 if n = "argv" || n = "args" then
4703 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
4705 (* List Haskell, OCaml and C keywords here.
4706 * http://www.haskell.org/haskellwiki/Keywords
4707 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
4708 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
4709 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
4710 * |perl -pe 's/(.+)/"$1";/'|fmt -70
4711 * Omitting _-containing words, since they're handled above.
4712 * Omitting the OCaml reserved word, "val", is ok,
4713 * and saves us from renaming several parameters.
4716 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
4717 "char"; "class"; "const"; "constraint"; "continue"; "data";
4718 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
4719 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
4720 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
4721 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
4722 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
4723 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
4724 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
4725 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
4726 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
4727 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
4728 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
4729 "volatile"; "when"; "where"; "while";
4731 if List.mem n reserved then
4732 failwithf "%s has param/ret using reserved word %s" name n;
4735 (match fst style with
4737 | RInt n | RInt64 n | RBool n
4738 | RConstString n | RConstOptString n | RString n
4739 | RStringList n | RStruct (n, _) | RStructList (n, _)
4740 | RHashtable n | RBufferOut n ->
4741 check_arg_ret_name n
4743 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
4746 (* Check short descriptions. *)
4748 fun (name, _, _, _, _, shortdesc, _) ->
4749 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
4750 failwithf "short description of %s should begin with lowercase." name;
4751 let c = shortdesc.[String.length shortdesc-1] in
4752 if c = '\n' || c = '.' then
4753 failwithf "short description of %s should not end with . or \\n." name
4756 (* Check long dscriptions. *)
4758 fun (name, _, _, _, _, _, longdesc) ->
4759 if longdesc.[String.length longdesc-1] = '\n' then
4760 failwithf "long description of %s should not end with \\n." name
4763 (* Check proc_nrs. *)
4765 fun (name, _, proc_nr, _, _, _, _) ->
4766 if proc_nr <= 0 then
4767 failwithf "daemon function %s should have proc_nr > 0" name
4771 fun (name, _, proc_nr, _, _, _, _) ->
4772 if proc_nr <> -1 then
4773 failwithf "non-daemon function %s should have proc_nr -1" name
4774 ) non_daemon_functions;
4777 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
4780 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
4781 let rec loop = function
4784 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
4786 | (name1,nr1) :: (name2,nr2) :: _ ->
4787 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
4795 (* Ignore functions that have no tests. We generate a
4796 * warning when the user does 'make check' instead.
4798 | name, _, _, _, [], _, _ -> ()
4799 | name, _, _, _, tests, _, _ ->
4803 match seq_of_test test with
4805 failwithf "%s has a test containing an empty sequence" name
4806 | cmds -> List.map List.hd cmds
4808 let funcs = List.flatten funcs in
4810 let tested = List.mem name funcs in
4813 failwithf "function %s has tests but does not test itself" name
4816 (* 'pr' prints to the current output file. *)
4817 let chan = ref Pervasives.stdout
4822 let i = count_chars '\n' str in
4823 lines := !lines + i;
4824 output_string !chan str
4827 let copyright_years =
4828 let this_year = 1900 + (localtime (time ())).tm_year in
4829 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
4831 (* Generate a header block in a number of standard styles. *)
4832 type comment_style =
4833 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
4834 type license = GPLv2plus | LGPLv2plus
4836 let generate_header ?(extra_inputs = []) comment license =
4837 let inputs = "src/generator.ml" :: extra_inputs in
4838 let c = match comment with
4839 | CStyle -> pr "/* "; " *"
4840 | CPlusPlusStyle -> pr "// "; "//"
4841 | HashStyle -> pr "# "; "#"
4842 | OCamlStyle -> pr "(* "; " *"
4843 | HaskellStyle -> pr "{- "; " " in
4844 pr "libguestfs generated file\n";
4845 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
4846 List.iter (pr "%s %s\n" c) inputs;
4847 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
4849 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
4853 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
4854 pr "%s it under the terms of the GNU General Public License as published by\n" c;
4855 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
4856 pr "%s (at your option) any later version.\n" c;
4858 pr "%s This program is distributed in the hope that it will be useful,\n" c;
4859 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4860 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
4861 pr "%s GNU General Public License for more details.\n" c;
4863 pr "%s You should have received a copy of the GNU General Public License along\n" c;
4864 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
4865 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
4868 pr "%s This library is free software; you can redistribute it and/or\n" c;
4869 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
4870 pr "%s License as published by the Free Software Foundation; either\n" c;
4871 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
4873 pr "%s This library is distributed in the hope that it will be useful,\n" c;
4874 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4875 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
4876 pr "%s Lesser General Public License for more details.\n" c;
4878 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
4879 pr "%s License along with this library; if not, write to the Free Software\n" c;
4880 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
4883 | CStyle -> pr " */\n"
4886 | OCamlStyle -> pr " *)\n"
4887 | HaskellStyle -> pr "-}\n"
4891 (* Start of main code generation functions below this line. *)
4893 (* Generate the pod documentation for the C API. *)
4894 let rec generate_actions_pod () =
4896 fun (shortname, style, _, flags, _, _, longdesc) ->
4897 if not (List.mem NotInDocs flags) then (
4898 let name = "guestfs_" ^ shortname in
4899 pr "=head2 %s\n\n" name;
4901 generate_prototype ~extern:false ~handle:"handle" name style;
4903 pr "%s\n\n" longdesc;
4904 (match fst style with
4906 pr "This function returns 0 on success or -1 on error.\n\n"
4908 pr "On error this function returns -1.\n\n"
4910 pr "On error this function returns -1.\n\n"
4912 pr "This function returns a C truth value on success or -1 on error.\n\n"
4914 pr "This function returns a string, or NULL on error.
4915 The string is owned by the guest handle and must I<not> be freed.\n\n"
4916 | RConstOptString _ ->
4917 pr "This function returns a string which may be NULL.
4918 There is way to return an error from this function.
4919 The string is owned by the guest handle and must I<not> be freed.\n\n"
4921 pr "This function returns a string, or NULL on error.
4922 I<The caller must free the returned string after use>.\n\n"
4924 pr "This function returns a NULL-terminated array of strings
4925 (like L<environ(3)>), or NULL if there was an error.
4926 I<The caller must free the strings and the array after use>.\n\n"
4927 | RStruct (_, typ) ->
4928 pr "This function returns a C<struct guestfs_%s *>,
4929 or NULL if there was an error.
4930 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
4931 | RStructList (_, typ) ->
4932 pr "This function returns a C<struct guestfs_%s_list *>
4933 (see E<lt>guestfs-structs.hE<gt>),
4934 or NULL if there was an error.
4935 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4937 pr "This function returns a NULL-terminated array of
4938 strings, or NULL if there was an error.
4939 The array of strings will always have length C<2n+1>, where
4940 C<n> keys and values alternate, followed by the trailing NULL entry.
4941 I<The caller must free the strings and the array after use>.\n\n"
4943 pr "This function returns a buffer, or NULL on error.
4944 The size of the returned buffer is written to C<*size_r>.
4945 I<The caller must free the returned buffer after use>.\n\n"
4947 if List.mem ProtocolLimitWarning flags then
4948 pr "%s\n\n" protocol_limit_warning;
4949 if List.mem DangerWillRobinson flags then
4950 pr "%s\n\n" danger_will_robinson;
4951 match deprecation_notice flags with
4953 | Some txt -> pr "%s\n\n" txt
4955 ) all_functions_sorted
4957 and generate_structs_pod () =
4958 (* Structs documentation. *)
4961 pr "=head2 guestfs_%s\n" typ;
4963 pr " struct guestfs_%s {\n" typ;
4966 | name, FChar -> pr " char %s;\n" name
4967 | name, FUInt32 -> pr " uint32_t %s;\n" name
4968 | name, FInt32 -> pr " int32_t %s;\n" name
4969 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4970 | name, FInt64 -> pr " int64_t %s;\n" name
4971 | name, FString -> pr " char *%s;\n" name
4973 pr " /* The next two fields describe a byte array. */\n";
4974 pr " uint32_t %s_len;\n" name;
4975 pr " char *%s;\n" name
4977 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4978 pr " char %s[32];\n" name
4979 | name, FOptPercent ->
4980 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4981 pr " float %s;\n" name
4985 pr " struct guestfs_%s_list {\n" typ;
4986 pr " uint32_t len; /* Number of elements in list. */\n";
4987 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
4990 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
4991 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
4996 and generate_availability_pod () =
4997 (* Availability documentation. *)
5001 fun (group, functions) ->
5002 pr "=item B<%s>\n" group;
5004 pr "The following functions:\n";
5005 List.iter (pr "L</guestfs_%s>\n") functions;
5011 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5012 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5014 * We have to use an underscore instead of a dash because otherwise
5015 * rpcgen generates incorrect code.
5017 * This header is NOT exported to clients, but see also generate_structs_h.
5019 and generate_xdr () =
5020 generate_header CStyle LGPLv2plus;
5022 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5023 pr "typedef string str<>;\n";
5026 (* Internal structures. *)
5030 pr "struct guestfs_int_%s {\n" typ;
5032 | name, FChar -> pr " char %s;\n" name
5033 | name, FString -> pr " string %s<>;\n" name
5034 | name, FBuffer -> pr " opaque %s<>;\n" name
5035 | name, FUUID -> pr " opaque %s[32];\n" name
5036 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5037 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5038 | name, FOptPercent -> pr " float %s;\n" name
5042 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5047 fun (shortname, style, _, _, _, _, _) ->
5048 let name = "guestfs_" ^ shortname in
5050 (match snd style with
5053 pr "struct %s_args {\n" name;
5056 | Pathname n | Device n | Dev_or_Path n | String n ->
5057 pr " string %s<>;\n" n
5058 | OptString n -> pr " str *%s;\n" n
5059 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5060 | Bool n -> pr " bool %s;\n" n
5061 | Int n -> pr " int %s;\n" n
5062 | Int64 n -> pr " hyper %s;\n" n
5063 | FileIn _ | FileOut _ -> ()
5067 (match fst style with
5070 pr "struct %s_ret {\n" name;
5074 pr "struct %s_ret {\n" name;
5075 pr " hyper %s;\n" n;
5078 pr "struct %s_ret {\n" name;
5081 | RConstString _ | RConstOptString _ ->
5082 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5084 pr "struct %s_ret {\n" name;
5085 pr " string %s<>;\n" n;
5088 pr "struct %s_ret {\n" name;
5089 pr " str %s<>;\n" n;
5091 | RStruct (n, typ) ->
5092 pr "struct %s_ret {\n" name;
5093 pr " guestfs_int_%s %s;\n" typ n;
5095 | RStructList (n, typ) ->
5096 pr "struct %s_ret {\n" name;
5097 pr " guestfs_int_%s_list %s;\n" typ n;
5100 pr "struct %s_ret {\n" name;
5101 pr " str %s<>;\n" n;
5104 pr "struct %s_ret {\n" name;
5105 pr " opaque %s<>;\n" n;
5110 (* Table of procedure numbers. *)
5111 pr "enum guestfs_procedure {\n";
5113 fun (shortname, _, proc_nr, _, _, _, _) ->
5114 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5116 pr " GUESTFS_PROC_NR_PROCS\n";
5120 (* Having to choose a maximum message size is annoying for several
5121 * reasons (it limits what we can do in the API), but it (a) makes
5122 * the protocol a lot simpler, and (b) provides a bound on the size
5123 * of the daemon which operates in limited memory space. For large
5124 * file transfers you should use FTP.
5126 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5129 (* Message header, etc. *)
5131 /* The communication protocol is now documented in the guestfs(3)
5135 const GUESTFS_PROGRAM = 0x2000F5F5;
5136 const GUESTFS_PROTOCOL_VERSION = 1;
5138 /* These constants must be larger than any possible message length. */
5139 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5140 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5142 enum guestfs_message_direction {
5143 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5144 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5147 enum guestfs_message_status {
5148 GUESTFS_STATUS_OK = 0,
5149 GUESTFS_STATUS_ERROR = 1
5152 const GUESTFS_ERROR_LEN = 256;
5154 struct guestfs_message_error {
5155 string error_message<GUESTFS_ERROR_LEN>;
5158 struct guestfs_message_header {
5159 unsigned prog; /* GUESTFS_PROGRAM */
5160 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5161 guestfs_procedure proc; /* GUESTFS_PROC_x */
5162 guestfs_message_direction direction;
5163 unsigned serial; /* message serial number */
5164 guestfs_message_status status;
5167 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5169 struct guestfs_chunk {
5170 int cancel; /* if non-zero, transfer is cancelled */
5171 /* data size is 0 bytes if the transfer has finished successfully */
5172 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5176 (* Generate the guestfs-structs.h file. *)
5177 and generate_structs_h () =
5178 generate_header CStyle LGPLv2plus;
5180 (* This is a public exported header file containing various
5181 * structures. The structures are carefully written to have
5182 * exactly the same in-memory format as the XDR structures that
5183 * we use on the wire to the daemon. The reason for creating
5184 * copies of these structures here is just so we don't have to
5185 * export the whole of guestfs_protocol.h (which includes much
5186 * unrelated and XDR-dependent stuff that we don't want to be
5187 * public, or required by clients).
5189 * To reiterate, we will pass these structures to and from the
5190 * client with a simple assignment or memcpy, so the format
5191 * must be identical to what rpcgen / the RFC defines.
5194 (* Public structures. *)
5197 pr "struct guestfs_%s {\n" typ;
5200 | name, FChar -> pr " char %s;\n" name
5201 | name, FString -> pr " char *%s;\n" name
5203 pr " uint32_t %s_len;\n" name;
5204 pr " char *%s;\n" name
5205 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5206 | name, FUInt32 -> pr " uint32_t %s;\n" name
5207 | name, FInt32 -> pr " int32_t %s;\n" name
5208 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5209 | name, FInt64 -> pr " int64_t %s;\n" name
5210 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5214 pr "struct guestfs_%s_list {\n" typ;
5215 pr " uint32_t len;\n";
5216 pr " struct guestfs_%s *val;\n" typ;
5219 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5220 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5224 (* Generate the guestfs-actions.h file. *)
5225 and generate_actions_h () =
5226 generate_header CStyle LGPLv2plus;
5228 fun (shortname, style, _, _, _, _, _) ->
5229 let name = "guestfs_" ^ shortname in
5230 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5234 (* Generate the guestfs-internal-actions.h file. *)
5235 and generate_internal_actions_h () =
5236 generate_header CStyle LGPLv2plus;
5238 fun (shortname, style, _, _, _, _, _) ->
5239 let name = "guestfs__" ^ shortname in
5240 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5242 ) non_daemon_functions
5244 (* Generate the client-side dispatch stubs. *)
5245 and generate_client_actions () =
5246 generate_header CStyle LGPLv2plus;
5252 #include <inttypes.h>
5254 #include \"guestfs.h\"
5255 #include \"guestfs-internal.h\"
5256 #include \"guestfs-internal-actions.h\"
5257 #include \"guestfs_protocol.h\"
5259 #define error guestfs_error
5260 //#define perrorf guestfs_perrorf
5261 #define safe_malloc guestfs_safe_malloc
5262 #define safe_realloc guestfs_safe_realloc
5263 //#define safe_strdup guestfs_safe_strdup
5264 #define safe_memdup guestfs_safe_memdup
5266 /* Check the return message from a call for validity. */
5268 check_reply_header (guestfs_h *g,
5269 const struct guestfs_message_header *hdr,
5270 unsigned int proc_nr, unsigned int serial)
5272 if (hdr->prog != GUESTFS_PROGRAM) {
5273 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5276 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5277 error (g, \"wrong protocol version (%%d/%%d)\",
5278 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5281 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5282 error (g, \"unexpected message direction (%%d/%%d)\",
5283 hdr->direction, GUESTFS_DIRECTION_REPLY);
5286 if (hdr->proc != proc_nr) {
5287 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5290 if (hdr->serial != serial) {
5291 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5298 /* Check we are in the right state to run a high-level action. */
5300 check_state (guestfs_h *g, const char *caller)
5302 if (!guestfs__is_ready (g)) {
5303 if (guestfs__is_config (g) || guestfs__is_launching (g))
5304 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5307 error (g, \"%%s called from the wrong state, %%d != READY\",
5308 caller, guestfs__get_state (g));
5316 (* Generate code to generate guestfish call traces. *)
5317 let trace_call shortname style =
5318 pr " if (guestfs__get_trace (g)) {\n";
5321 List.exists (function
5322 | StringList _ | DeviceList _ -> true
5323 | _ -> false) (snd style) in
5329 pr " printf (\"%s\");\n" shortname;
5332 | String n (* strings *)
5338 (* guestfish doesn't support string escaping, so neither do we *)
5339 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5340 | OptString n -> (* string option *)
5341 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5342 pr " else printf (\" null\");\n"
5344 | DeviceList n -> (* string list *)
5345 pr " putchar (' ');\n";
5346 pr " putchar ('\"');\n";
5347 pr " for (i = 0; %s[i]; ++i) {\n" n;
5348 pr " if (i > 0) putchar (' ');\n";
5349 pr " fputs (%s[i], stdout);\n" n;
5351 pr " putchar ('\"');\n";
5352 | Bool n -> (* boolean *)
5353 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5354 | Int n -> (* int *)
5355 pr " printf (\" %%d\", %s);\n" n
5357 pr " printf (\" %%\" PRIi64, %s);\n" n
5359 pr " putchar ('\\n');\n";
5364 (* For non-daemon functions, generate a wrapper around each function. *)
5366 fun (shortname, style, _, _, _, _, _) ->
5367 let name = "guestfs_" ^ shortname in
5369 generate_prototype ~extern:false ~semicolon:false ~newline:true
5370 ~handle:"g" name style;
5372 trace_call shortname style;
5373 pr " return guestfs__%s " shortname;
5374 generate_c_call_args ~handle:"g" style;
5378 ) non_daemon_functions;
5380 (* Client-side stubs for each function. *)
5382 fun (shortname, style, _, _, _, _, _) ->
5383 let name = "guestfs_" ^ shortname in
5385 (* Generate the action stub. *)
5386 generate_prototype ~extern:false ~semicolon:false ~newline:true
5387 ~handle:"g" name style;
5390 match fst style with
5391 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5392 | RConstString _ | RConstOptString _ ->
5393 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5394 | RString _ | RStringList _
5395 | RStruct _ | RStructList _
5396 | RHashtable _ | RBufferOut _ ->
5401 (match snd style with
5403 | _ -> pr " struct %s_args args;\n" name
5406 pr " guestfs_message_header hdr;\n";
5407 pr " guestfs_message_error err;\n";
5409 match fst style with
5411 | RConstString _ | RConstOptString _ ->
5412 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5414 | RBool _ | RString _ | RStringList _
5415 | RStruct _ | RStructList _
5416 | RHashtable _ | RBufferOut _ ->
5417 pr " struct %s_ret ret;\n" name;
5420 pr " int serial;\n";
5423 trace_call shortname style;
5424 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5425 pr " guestfs___set_busy (g);\n";
5428 (* Send the main header and arguments. *)
5429 (match snd style with
5431 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5432 (String.uppercase shortname)
5436 | Pathname n | Device n | Dev_or_Path n | String n ->
5437 pr " args.%s = (char *) %s;\n" n n
5439 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5440 | StringList n | DeviceList n ->
5441 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5442 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5444 pr " args.%s = %s;\n" n n
5446 pr " args.%s = %s;\n" n n
5448 pr " args.%s = %s;\n" n n
5449 | FileIn _ | FileOut _ -> ()
5451 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5452 (String.uppercase shortname);
5453 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5456 pr " if (serial == -1) {\n";
5457 pr " guestfs___end_busy (g);\n";
5458 pr " return %s;\n" error_code;
5462 (* Send any additional files (FileIn) requested. *)
5463 let need_read_reply_label = ref false in
5467 pr " r = guestfs___send_file (g, %s);\n" n;
5468 pr " if (r == -1) {\n";
5469 pr " guestfs___end_busy (g);\n";
5470 pr " return %s;\n" error_code;
5472 pr " if (r == -2) /* daemon cancelled */\n";
5473 pr " goto read_reply;\n";
5474 need_read_reply_label := true;
5479 (* Wait for the reply from the remote end. *)
5480 if !need_read_reply_label then pr " read_reply:\n";
5481 pr " memset (&hdr, 0, sizeof hdr);\n";
5482 pr " memset (&err, 0, sizeof err);\n";
5483 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5485 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5489 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5492 pr " if (r == -1) {\n";
5493 pr " guestfs___end_busy (g);\n";
5494 pr " return %s;\n" error_code;
5498 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5499 (String.uppercase shortname);
5500 pr " guestfs___end_busy (g);\n";
5501 pr " return %s;\n" error_code;
5505 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5506 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5507 pr " free (err.error_message);\n";
5508 pr " guestfs___end_busy (g);\n";
5509 pr " return %s;\n" error_code;
5513 (* Expecting to receive further files (FileOut)? *)
5517 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5518 pr " guestfs___end_busy (g);\n";
5519 pr " return %s;\n" error_code;
5525 pr " guestfs___end_busy (g);\n";
5527 (match fst style with
5528 | RErr -> pr " return 0;\n"
5529 | RInt n | RInt64 n | RBool n ->
5530 pr " return ret.%s;\n" n
5531 | RConstString _ | RConstOptString _ ->
5532 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5534 pr " return ret.%s; /* caller will free */\n" n
5535 | RStringList n | RHashtable n ->
5536 pr " /* caller will free this, but we need to add a NULL entry */\n";
5537 pr " ret.%s.%s_val =\n" n n;
5538 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5539 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5541 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5542 pr " return ret.%s.%s_val;\n" n n
5544 pr " /* caller will free this */\n";
5545 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5546 | RStructList (n, _) ->
5547 pr " /* caller will free this */\n";
5548 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5550 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5551 pr " * _val might be NULL here. To make the API saner for\n";
5552 pr " * callers, we turn this case into a unique pointer (using\n";
5553 pr " * malloc(1)).\n";
5555 pr " if (ret.%s.%s_len > 0) {\n" n n;
5556 pr " *size_r = ret.%s.%s_len;\n" n n;
5557 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5559 pr " free (ret.%s.%s_val);\n" n n;
5560 pr " char *p = safe_malloc (g, 1);\n";
5561 pr " *size_r = ret.%s.%s_len;\n" n n;
5569 (* Functions to free structures. *)
5570 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5571 pr " * structure format is identical to the XDR format. See note in\n";
5572 pr " * generator.ml.\n";
5579 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5581 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5587 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5589 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5596 (* Generate daemon/actions.h. *)
5597 and generate_daemon_actions_h () =
5598 generate_header CStyle GPLv2plus;
5600 pr "#include \"../src/guestfs_protocol.h\"\n";
5604 fun (name, style, _, _, _, _, _) ->
5606 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5610 (* Generate the linker script which controls the visibility of
5611 * symbols in the public ABI and ensures no other symbols get
5612 * exported accidentally.
5614 and generate_linker_script () =
5615 generate_header HashStyle GPLv2plus;
5620 "guestfs_get_error_handler";
5621 "guestfs_get_out_of_memory_handler";
5622 "guestfs_last_error";
5623 "guestfs_set_error_handler";
5624 "guestfs_set_launch_done_callback";
5625 "guestfs_set_log_message_callback";
5626 "guestfs_set_out_of_memory_handler";
5627 "guestfs_set_subprocess_quit_callback";
5629 (* Unofficial parts of the API: the bindings code use these
5630 * functions, so it is useful to export them.
5632 "guestfs_safe_calloc";
5633 "guestfs_safe_malloc";
5636 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
5640 List.map (fun (typ, _) ->
5641 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
5644 let globals = List.sort compare (globals @ functions @ structs) in
5648 List.iter (pr " %s;\n") globals;
5655 (* Generate the server-side stubs. *)
5656 and generate_daemon_actions () =
5657 generate_header CStyle GPLv2plus;
5659 pr "#include <config.h>\n";
5661 pr "#include <stdio.h>\n";
5662 pr "#include <stdlib.h>\n";
5663 pr "#include <string.h>\n";
5664 pr "#include <inttypes.h>\n";
5665 pr "#include <rpc/types.h>\n";
5666 pr "#include <rpc/xdr.h>\n";
5668 pr "#include \"daemon.h\"\n";
5669 pr "#include \"c-ctype.h\"\n";
5670 pr "#include \"../src/guestfs_protocol.h\"\n";
5671 pr "#include \"actions.h\"\n";
5675 fun (name, style, _, _, _, _, _) ->
5676 (* Generate server-side stubs. *)
5677 pr "static void %s_stub (XDR *xdr_in)\n" name;
5680 match fst style with
5681 | RErr | RInt _ -> pr " int r;\n"; "-1"
5682 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5683 | RBool _ -> pr " int r;\n"; "-1"
5684 | RConstString _ | RConstOptString _ ->
5685 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5686 | RString _ -> pr " char *r;\n"; "NULL"
5687 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5688 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
5689 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
5691 pr " size_t size = 1;\n";
5695 (match snd style with
5698 pr " struct guestfs_%s_args args;\n" name;
5701 | Device n | Dev_or_Path n
5704 | OptString n -> pr " char *%s;\n" n
5705 | StringList n | DeviceList n -> pr " char **%s;\n" n
5706 | Bool n -> pr " int %s;\n" n
5707 | Int n -> pr " int %s;\n" n
5708 | Int64 n -> pr " int64_t %s;\n" n
5709 | FileIn _ | FileOut _ -> ()
5714 (match snd style with
5717 pr " memset (&args, 0, sizeof args);\n";
5719 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
5720 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
5724 pr " char *%s = args.%s;\n" n n
5726 let pr_list_handling_code n =
5727 pr " %s = realloc (args.%s.%s_val,\n" n n n;
5728 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
5729 pr " if (%s == NULL) {\n" n;
5730 pr " reply_with_perror (\"realloc\");\n";
5733 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
5734 pr " args.%s.%s_val = %s;\n" n n n;
5740 pr " ABS_PATH (%s, goto done);\n" n;
5743 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
5746 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
5747 | String n -> pr_args n
5748 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
5750 pr_list_handling_code n;
5752 pr_list_handling_code n;
5753 pr " /* Ensure that each is a device,\n";
5754 pr " * and perform device name translation. */\n";
5755 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
5756 pr " RESOLVE_DEVICE (physvols[pvi], goto done);\n";
5758 | Bool n -> pr " %s = args.%s;\n" n n
5759 | Int n -> pr " %s = args.%s;\n" n n
5760 | Int64 n -> pr " %s = args.%s;\n" n n
5761 | FileIn _ | FileOut _ -> ()
5767 (* this is used at least for do_equal *)
5768 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
5769 (* Emit NEED_ROOT just once, even when there are two or
5770 more Pathname args *)
5771 pr " NEED_ROOT (goto done);\n";
5774 (* Don't want to call the impl with any FileIn or FileOut
5775 * parameters, since these go "outside" the RPC protocol.
5778 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
5780 pr " r = do_%s " name;
5781 generate_c_call_args (fst style, args');
5784 (match fst style with
5785 | RErr | RInt _ | RInt64 _ | RBool _
5786 | RConstString _ | RConstOptString _
5787 | RString _ | RStringList _ | RHashtable _
5788 | RStruct (_, _) | RStructList (_, _) ->
5789 pr " if (r == %s)\n" error_code;
5790 pr " /* do_%s has already called reply_with_error */\n" name;
5794 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
5795 pr " * an ordinary zero-length buffer), so be careful ...\n";
5797 pr " if (size == 1 && r == %s)\n" error_code;
5798 pr " /* do_%s has already called reply_with_error */\n" name;
5803 (* If there are any FileOut parameters, then the impl must
5804 * send its own reply.
5807 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
5809 pr " /* do_%s has already sent a reply */\n" name
5811 match fst style with
5812 | RErr -> pr " reply (NULL, NULL);\n"
5813 | RInt n | RInt64 n | RBool n ->
5814 pr " struct guestfs_%s_ret ret;\n" name;
5815 pr " ret.%s = r;\n" n;
5816 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5818 | RConstString _ | RConstOptString _ ->
5819 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5821 pr " struct guestfs_%s_ret ret;\n" name;
5822 pr " ret.%s = r;\n" n;
5823 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5826 | RStringList n | RHashtable n ->
5827 pr " struct guestfs_%s_ret ret;\n" name;
5828 pr " ret.%s.%s_len = count_strings (r);\n" n n;
5829 pr " ret.%s.%s_val = r;\n" n n;
5830 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5832 pr " free_strings (r);\n"
5834 pr " struct guestfs_%s_ret ret;\n" name;
5835 pr " ret.%s = *r;\n" n;
5836 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5838 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5840 | RStructList (n, _) ->
5841 pr " struct guestfs_%s_ret ret;\n" name;
5842 pr " ret.%s = *r;\n" n;
5843 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5845 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5848 pr " struct guestfs_%s_ret ret;\n" name;
5849 pr " ret.%s.%s_val = r;\n" n n;
5850 pr " ret.%s.%s_len = size;\n" n n;
5851 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5856 (* Free the args. *)
5857 (match snd style with
5862 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
5869 (* Dispatch function. *)
5870 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
5872 pr " switch (proc_nr) {\n";
5875 fun (name, style, _, _, _, _, _) ->
5876 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
5877 pr " %s_stub (xdr_in);\n" name;
5882 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";
5887 (* LVM columns and tokenization functions. *)
5888 (* XXX This generates crap code. We should rethink how we
5894 pr "static const char *lvm_%s_cols = \"%s\";\n"
5895 typ (String.concat "," (List.map fst cols));
5898 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
5900 pr " char *tok, *p, *next;\n";
5904 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
5907 pr " if (!str) {\n";
5908 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
5911 pr " if (!*str || c_isspace (*str)) {\n";
5912 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
5917 fun (name, coltype) ->
5918 pr " if (!tok) {\n";
5919 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
5922 pr " p = strchrnul (tok, ',');\n";
5923 pr " if (*p) next = p+1; else next = NULL;\n";
5924 pr " *p = '\\0';\n";
5927 pr " r->%s = strdup (tok);\n" name;
5928 pr " if (r->%s == NULL) {\n" name;
5929 pr " perror (\"strdup\");\n";
5933 pr " for (i = j = 0; i < 32; ++j) {\n";
5934 pr " if (tok[j] == '\\0') {\n";
5935 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
5937 pr " } else if (tok[j] != '-')\n";
5938 pr " r->%s[i++] = tok[j];\n" name;
5941 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
5942 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5946 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
5947 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5951 pr " if (tok[0] == '\\0')\n";
5952 pr " r->%s = -1;\n" name;
5953 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
5954 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5957 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
5958 assert false (* can never be an LVM column *)
5960 pr " tok = next;\n";
5963 pr " if (tok != NULL) {\n";
5964 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
5971 pr "guestfs_int_lvm_%s_list *\n" typ;
5972 pr "parse_command_line_%ss (void)\n" typ;
5974 pr " char *out, *err;\n";
5975 pr " char *p, *pend;\n";
5977 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
5978 pr " void *newp;\n";
5980 pr " ret = malloc (sizeof *ret);\n";
5981 pr " if (!ret) {\n";
5982 pr " reply_with_perror (\"malloc\");\n";
5983 pr " return NULL;\n";
5986 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
5987 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
5989 pr " r = command (&out, &err,\n";
5990 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
5991 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
5992 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
5993 pr " if (r == -1) {\n";
5994 pr " reply_with_error (\"%%s\", err);\n";
5995 pr " free (out);\n";
5996 pr " free (err);\n";
5997 pr " free (ret);\n";
5998 pr " return NULL;\n";
6001 pr " free (err);\n";
6003 pr " /* Tokenize each line of the output. */\n";
6006 pr " while (p) {\n";
6007 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6008 pr " if (pend) {\n";
6009 pr " *pend = '\\0';\n";
6013 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6016 pr " if (!*p) { /* Empty line? Skip it. */\n";
6021 pr " /* Allocate some space to store this next entry. */\n";
6022 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6023 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6024 pr " if (newp == NULL) {\n";
6025 pr " reply_with_perror (\"realloc\");\n";
6026 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6027 pr " free (ret);\n";
6028 pr " free (out);\n";
6029 pr " return NULL;\n";
6031 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6033 pr " /* Tokenize the next entry. */\n";
6034 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6035 pr " if (r == -1) {\n";
6036 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6037 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6038 pr " free (ret);\n";
6039 pr " free (out);\n";
6040 pr " return NULL;\n";
6047 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6049 pr " free (out);\n";
6050 pr " return ret;\n";
6053 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6055 (* Generate a list of function names, for debugging in the daemon.. *)
6056 and generate_daemon_names () =
6057 generate_header CStyle GPLv2plus;
6059 pr "#include <config.h>\n";
6061 pr "#include \"daemon.h\"\n";
6064 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6065 pr "const char *function_names[] = {\n";
6067 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6071 (* Generate the optional groups for the daemon to implement
6072 * guestfs_available.
6074 and generate_daemon_optgroups_c () =
6075 generate_header CStyle GPLv2plus;
6077 pr "#include <config.h>\n";
6079 pr "#include \"daemon.h\"\n";
6080 pr "#include \"optgroups.h\"\n";
6083 pr "struct optgroup optgroups[] = {\n";
6086 pr " { \"%s\", optgroup_%s_available },\n" group group
6088 pr " { NULL, NULL }\n";
6091 and generate_daemon_optgroups_h () =
6092 generate_header CStyle GPLv2plus;
6096 pr "extern int optgroup_%s_available (void);\n" group
6099 (* Generate the tests. *)
6100 and generate_tests () =
6101 generate_header CStyle GPLv2plus;
6108 #include <sys/types.h>
6111 #include \"guestfs.h\"
6112 #include \"guestfs-internal.h\"
6114 static guestfs_h *g;
6115 static int suppress_error = 0;
6117 static void print_error (guestfs_h *g, void *data, const char *msg)
6119 if (!suppress_error)
6120 fprintf (stderr, \"%%s\\n\", msg);
6123 /* FIXME: nearly identical code appears in fish.c */
6124 static void print_strings (char *const *argv)
6128 for (argc = 0; argv[argc] != NULL; ++argc)
6129 printf (\"\\t%%s\\n\", argv[argc]);
6133 static void print_table (char const *const *argv)
6137 for (i = 0; argv[i] != NULL; i += 2)
6138 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6144 (* Generate a list of commands which are not tested anywhere. *)
6145 pr "static void no_test_warnings (void)\n";
6148 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6150 fun (_, _, _, _, tests, _, _) ->
6151 let tests = filter_map (
6153 | (_, (Always|If _|Unless _), test) -> Some test
6154 | (_, Disabled, _) -> None
6156 let seq = List.concat (List.map seq_of_test tests) in
6157 let cmds_tested = List.map List.hd seq in
6158 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6162 fun (name, _, _, _, _, _, _) ->
6163 if not (Hashtbl.mem hash name) then
6164 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6170 (* Generate the actual tests. Note that we generate the tests
6171 * in reverse order, deliberately, so that (in general) the
6172 * newest tests run first. This makes it quicker and easier to
6177 fun (name, _, _, flags, tests, _, _) ->
6178 mapi (generate_one_test name flags) tests
6179 ) (List.rev all_functions) in
6180 let test_names = List.concat test_names in
6181 let nr_tests = List.length test_names in
6184 int main (int argc, char *argv[])
6187 unsigned long int n_failed = 0;
6188 const char *filename;
6190 int nr_tests, test_num = 0;
6192 setbuf (stdout, NULL);
6194 no_test_warnings ();
6196 g = guestfs_create ();
6198 printf (\"guestfs_create FAILED\\n\");
6199 exit (EXIT_FAILURE);
6202 guestfs_set_error_handler (g, print_error, NULL);
6204 guestfs_set_path (g, \"../appliance\");
6206 filename = \"test1.img\";
6207 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6210 exit (EXIT_FAILURE);
6212 if (lseek (fd, %d, SEEK_SET) == -1) {
6216 exit (EXIT_FAILURE);
6218 if (write (fd, &c, 1) == -1) {
6222 exit (EXIT_FAILURE);
6224 if (close (fd) == -1) {
6227 exit (EXIT_FAILURE);
6229 if (guestfs_add_drive (g, filename) == -1) {
6230 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6231 exit (EXIT_FAILURE);
6234 filename = \"test2.img\";
6235 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6238 exit (EXIT_FAILURE);
6240 if (lseek (fd, %d, SEEK_SET) == -1) {
6244 exit (EXIT_FAILURE);
6246 if (write (fd, &c, 1) == -1) {
6250 exit (EXIT_FAILURE);
6252 if (close (fd) == -1) {
6255 exit (EXIT_FAILURE);
6257 if (guestfs_add_drive (g, filename) == -1) {
6258 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6259 exit (EXIT_FAILURE);
6262 filename = \"test3.img\";
6263 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6266 exit (EXIT_FAILURE);
6268 if (lseek (fd, %d, SEEK_SET) == -1) {
6272 exit (EXIT_FAILURE);
6274 if (write (fd, &c, 1) == -1) {
6278 exit (EXIT_FAILURE);
6280 if (close (fd) == -1) {
6283 exit (EXIT_FAILURE);
6285 if (guestfs_add_drive (g, filename) == -1) {
6286 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6287 exit (EXIT_FAILURE);
6290 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6291 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6292 exit (EXIT_FAILURE);
6295 if (guestfs_launch (g) == -1) {
6296 printf (\"guestfs_launch FAILED\\n\");
6297 exit (EXIT_FAILURE);
6300 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6303 /* Cancel previous alarm. */
6308 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6312 pr " test_num++;\n";
6313 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6314 pr " if (%s () == -1) {\n" test_name;
6315 pr " printf (\"%s FAILED\\n\");\n" test_name;
6316 pr " n_failed++;\n";
6321 pr " guestfs_close (g);\n";
6322 pr " unlink (\"test1.img\");\n";
6323 pr " unlink (\"test2.img\");\n";
6324 pr " unlink (\"test3.img\");\n";
6327 pr " if (n_failed > 0) {\n";
6328 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6329 pr " exit (EXIT_FAILURE);\n";
6333 pr " exit (EXIT_SUCCESS);\n";
6336 and generate_one_test name flags i (init, prereq, test) =
6337 let test_name = sprintf "test_%s_%d" name i in
6340 static int %s_skip (void)
6344 str = getenv (\"TEST_ONLY\");
6346 return strstr (str, \"%s\") == NULL;
6347 str = getenv (\"SKIP_%s\");
6348 if (str && STREQ (str, \"1\")) return 1;
6349 str = getenv (\"SKIP_TEST_%s\");
6350 if (str && STREQ (str, \"1\")) return 1;
6354 " test_name name (String.uppercase test_name) (String.uppercase name);
6357 | Disabled | Always -> ()
6358 | If code | Unless code ->
6359 pr "static int %s_prereq (void)\n" test_name;
6367 static int %s (void)
6370 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6374 " test_name test_name test_name;
6376 (* Optional functions should only be tested if the relevant
6377 * support is available in the daemon.
6383 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6385 pr " suppress_error = 1;\n";
6386 pr " r = guestfs_available (g, (char **) groups);\n";
6387 pr " suppress_error = 0;\n";
6388 pr " if (r == -1) {\n";
6389 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6398 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6400 pr " if (! %s_prereq ()) {\n" test_name;
6401 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6405 generate_one_test_body name i test_name init test;
6407 pr " if (%s_prereq ()) {\n" test_name;
6408 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6412 generate_one_test_body name i test_name init test;
6414 generate_one_test_body name i test_name init test
6422 and generate_one_test_body name i test_name init test =
6424 | InitNone (* XXX at some point, InitNone and InitEmpty became
6425 * folded together as the same thing. Really we should
6426 * make InitNone do nothing at all, but the tests may
6427 * need to be checked to make sure this is OK.
6430 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6431 List.iter (generate_test_command_call test_name)
6432 [["blockdev_setrw"; "/dev/sda"];
6436 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6437 List.iter (generate_test_command_call test_name)
6438 [["blockdev_setrw"; "/dev/sda"];
6441 ["part_disk"; "/dev/sda"; "mbr"]]
6443 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6444 List.iter (generate_test_command_call test_name)
6445 [["blockdev_setrw"; "/dev/sda"];
6448 ["part_disk"; "/dev/sda"; "mbr"];
6449 ["mkfs"; "ext2"; "/dev/sda1"];
6450 ["mount"; "/dev/sda1"; "/"]]
6451 | InitBasicFSonLVM ->
6452 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6454 List.iter (generate_test_command_call test_name)
6455 [["blockdev_setrw"; "/dev/sda"];
6458 ["part_disk"; "/dev/sda"; "mbr"];
6459 ["pvcreate"; "/dev/sda1"];
6460 ["vgcreate"; "VG"; "/dev/sda1"];
6461 ["lvcreate"; "LV"; "VG"; "8"];
6462 ["mkfs"; "ext2"; "/dev/VG/LV"];
6463 ["mount"; "/dev/VG/LV"; "/"]]
6465 pr " /* InitISOFS for %s */\n" test_name;
6466 List.iter (generate_test_command_call test_name)
6467 [["blockdev_setrw"; "/dev/sda"];
6470 ["mount_ro"; "/dev/sdd"; "/"]]
6473 let get_seq_last = function
6475 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6478 let seq = List.rev seq in
6479 List.rev (List.tl seq), List.hd seq
6484 pr " /* TestRun for %s (%d) */\n" name i;
6485 List.iter (generate_test_command_call test_name) seq
6486 | TestOutput (seq, expected) ->
6487 pr " /* TestOutput for %s (%d) */\n" name i;
6488 pr " const char *expected = \"%s\";\n" (c_quote expected);
6489 let seq, last = get_seq_last seq in
6491 pr " if (STRNEQ (r, expected)) {\n";
6492 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6496 List.iter (generate_test_command_call test_name) seq;
6497 generate_test_command_call ~test test_name last
6498 | TestOutputList (seq, expected) ->
6499 pr " /* TestOutputList for %s (%d) */\n" name i;
6500 let seq, last = get_seq_last seq in
6504 pr " if (!r[%d]) {\n" i;
6505 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6506 pr " print_strings (r);\n";
6510 pr " const char *expected = \"%s\";\n" (c_quote str);
6511 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6512 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6517 pr " if (r[%d] != NULL) {\n" (List.length expected);
6518 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6520 pr " print_strings (r);\n";
6524 List.iter (generate_test_command_call test_name) seq;
6525 generate_test_command_call ~test test_name last
6526 | TestOutputListOfDevices (seq, expected) ->
6527 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6528 let seq, last = get_seq_last seq in
6532 pr " if (!r[%d]) {\n" i;
6533 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6534 pr " print_strings (r);\n";
6538 pr " const char *expected = \"%s\";\n" (c_quote str);
6539 pr " r[%d][5] = 's';\n" i;
6540 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6541 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6546 pr " if (r[%d] != NULL) {\n" (List.length expected);
6547 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6549 pr " print_strings (r);\n";
6553 List.iter (generate_test_command_call test_name) seq;
6554 generate_test_command_call ~test test_name last
6555 | TestOutputInt (seq, expected) ->
6556 pr " /* TestOutputInt for %s (%d) */\n" name i;
6557 let seq, last = get_seq_last seq in
6559 pr " if (r != %d) {\n" expected;
6560 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6566 List.iter (generate_test_command_call test_name) seq;
6567 generate_test_command_call ~test test_name last
6568 | TestOutputIntOp (seq, op, expected) ->
6569 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6570 let seq, last = get_seq_last seq in
6572 pr " if (! (r %s %d)) {\n" op expected;
6573 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6574 test_name op expected;
6579 List.iter (generate_test_command_call test_name) seq;
6580 generate_test_command_call ~test test_name last
6581 | TestOutputTrue seq ->
6582 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6583 let seq, last = get_seq_last seq in
6586 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6591 List.iter (generate_test_command_call test_name) seq;
6592 generate_test_command_call ~test test_name last
6593 | TestOutputFalse seq ->
6594 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6595 let seq, last = get_seq_last seq in
6598 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6603 List.iter (generate_test_command_call test_name) seq;
6604 generate_test_command_call ~test test_name last
6605 | TestOutputLength (seq, expected) ->
6606 pr " /* TestOutputLength for %s (%d) */\n" name i;
6607 let seq, last = get_seq_last seq in
6610 pr " for (j = 0; j < %d; ++j)\n" expected;
6611 pr " if (r[j] == NULL) {\n";
6612 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6614 pr " print_strings (r);\n";
6617 pr " if (r[j] != NULL) {\n";
6618 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6620 pr " print_strings (r);\n";
6624 List.iter (generate_test_command_call test_name) seq;
6625 generate_test_command_call ~test test_name last
6626 | TestOutputBuffer (seq, expected) ->
6627 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6628 pr " const char *expected = \"%s\";\n" (c_quote expected);
6629 let seq, last = get_seq_last seq in
6630 let len = String.length expected in
6632 pr " if (size != %d) {\n" len;
6633 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6636 pr " if (STRNEQLEN (r, expected, size)) {\n";
6637 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6641 List.iter (generate_test_command_call test_name) seq;
6642 generate_test_command_call ~test test_name last
6643 | TestOutputStruct (seq, checks) ->
6644 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6645 let seq, last = get_seq_last seq in
6649 | CompareWithInt (field, expected) ->
6650 pr " if (r->%s != %d) {\n" field expected;
6651 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6652 test_name field expected;
6653 pr " (int) r->%s);\n" field;
6656 | CompareWithIntOp (field, op, expected) ->
6657 pr " if (!(r->%s %s %d)) {\n" field op expected;
6658 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
6659 test_name field op expected;
6660 pr " (int) r->%s);\n" field;
6663 | CompareWithString (field, expected) ->
6664 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
6665 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
6666 test_name field expected;
6667 pr " r->%s);\n" field;
6670 | CompareFieldsIntEq (field1, field2) ->
6671 pr " if (r->%s != r->%s) {\n" field1 field2;
6672 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
6673 test_name field1 field2;
6674 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
6677 | CompareFieldsStrEq (field1, field2) ->
6678 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
6679 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
6680 test_name field1 field2;
6681 pr " r->%s, r->%s);\n" field1 field2;
6686 List.iter (generate_test_command_call test_name) seq;
6687 generate_test_command_call ~test test_name last
6688 | TestLastFail seq ->
6689 pr " /* TestLastFail for %s (%d) */\n" name i;
6690 let seq, last = get_seq_last seq in
6691 List.iter (generate_test_command_call test_name) seq;
6692 generate_test_command_call test_name ~expect_error:true last
6694 (* Generate the code to run a command, leaving the result in 'r'.
6695 * If you expect to get an error then you should set expect_error:true.
6697 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
6699 | [] -> assert false
6701 (* Look up the command to find out what args/ret it has. *)
6704 let _, style, _, _, _, _, _ =
6705 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
6708 failwithf "%s: in test, command %s was not found" test_name name in
6710 if List.length (snd style) <> List.length args then
6711 failwithf "%s: in test, wrong number of args given to %s"
6718 | OptString n, "NULL" -> ()
6721 | Dev_or_Path n, arg
6723 | OptString n, arg ->
6724 pr " const char *%s = \"%s\";\n" n (c_quote arg);
6728 | FileIn _, _ | FileOut _, _ -> ()
6729 | StringList n, "" | DeviceList n, "" ->
6730 pr " const char *const %s[1] = { NULL };\n" n
6731 | StringList n, arg | DeviceList n, arg ->
6732 let strs = string_split " " arg in
6735 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
6737 pr " const char *const %s[] = {\n" n;
6739 fun i _ -> pr " %s_%d,\n" n i
6743 ) (List.combine (snd style) args);
6746 match fst style with
6747 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6748 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6749 | RConstString _ | RConstOptString _ ->
6750 pr " const char *r;\n"; "NULL"
6751 | RString _ -> pr " char *r;\n"; "NULL"
6752 | RStringList _ | RHashtable _ ->
6756 | RStruct (_, typ) ->
6757 pr " struct guestfs_%s *r;\n" typ; "NULL"
6758 | RStructList (_, typ) ->
6759 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6762 pr " size_t size;\n";
6765 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
6766 pr " r = guestfs_%s (g" name;
6768 (* Generate the parameters. *)
6771 | OptString _, "NULL" -> pr ", NULL"
6773 | Device n, _ | Dev_or_Path n, _
6777 | FileIn _, arg | FileOut _, arg ->
6778 pr ", \"%s\"" (c_quote arg)
6779 | StringList n, _ | DeviceList n, _ ->
6780 pr ", (char **) %s" n
6783 try int_of_string arg
6784 with Failure "int_of_string" ->
6785 failwithf "%s: expecting an int, but got '%s'" test_name arg in
6789 try Int64.of_string arg
6790 with Failure "int_of_string" ->
6791 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
6794 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
6795 ) (List.combine (snd style) args);
6797 (match fst style with
6798 | RBufferOut _ -> pr ", &size"
6804 if not expect_error then
6805 pr " if (r == %s)\n" error_code
6807 pr " if (r != %s)\n" error_code;
6810 (* Insert the test code. *)
6816 (match fst style with
6817 | RErr | RInt _ | RInt64 _ | RBool _
6818 | RConstString _ | RConstOptString _ -> ()
6819 | RString _ | RBufferOut _ -> pr " free (r);\n"
6820 | RStringList _ | RHashtable _ ->
6821 pr " for (i = 0; r[i] != NULL; ++i)\n";
6822 pr " free (r[i]);\n";
6824 | RStruct (_, typ) ->
6825 pr " guestfs_free_%s (r);\n" typ
6826 | RStructList (_, typ) ->
6827 pr " guestfs_free_%s_list (r);\n" typ
6833 let str = replace_str str "\r" "\\r" in
6834 let str = replace_str str "\n" "\\n" in
6835 let str = replace_str str "\t" "\\t" in
6836 let str = replace_str str "\000" "\\0" in
6839 (* Generate a lot of different functions for guestfish. *)
6840 and generate_fish_cmds () =
6841 generate_header CStyle GPLv2plus;
6845 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6847 let all_functions_sorted =
6849 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6850 ) all_functions_sorted in
6852 pr "#include <stdio.h>\n";
6853 pr "#include <stdlib.h>\n";
6854 pr "#include <string.h>\n";
6855 pr "#include <inttypes.h>\n";
6857 pr "#include <guestfs.h>\n";
6858 pr "#include \"c-ctype.h\"\n";
6859 pr "#include \"fish.h\"\n";
6862 (* list_commands function, which implements guestfish -h *)
6863 pr "void list_commands (void)\n";
6865 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
6866 pr " list_builtin_commands ();\n";
6868 fun (name, _, _, flags, _, shortdesc, _) ->
6869 let name = replace_char name '_' '-' in
6870 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
6872 ) all_functions_sorted;
6873 pr " printf (\" %%s\\n\",";
6874 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
6878 (* display_command function, which implements guestfish -h cmd *)
6879 pr "void display_command (const char *cmd)\n";
6882 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6883 let name2 = replace_char name '_' '-' in
6885 try find_map (function FishAlias n -> Some n | _ -> None) flags
6886 with Not_found -> name in
6887 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
6889 match snd style with
6893 name2 (String.concat " " (List.map name_of_argt args)) in
6896 if List.mem ProtocolLimitWarning flags then
6897 ("\n\n" ^ protocol_limit_warning)
6900 (* For DangerWillRobinson commands, we should probably have
6901 * guestfish prompt before allowing you to use them (especially
6902 * in interactive mode). XXX
6906 if List.mem DangerWillRobinson flags then
6907 ("\n\n" ^ danger_will_robinson)
6912 match deprecation_notice flags with
6914 | Some txt -> "\n\n" ^ txt in
6916 let describe_alias =
6917 if name <> alias then
6918 sprintf "\n\nYou can use '%s' as an alias for this command." alias
6922 pr "STRCASEEQ (cmd, \"%s\")" name;
6923 if name <> name2 then
6924 pr " || STRCASEEQ (cmd, \"%s\")" name2;
6925 if name <> alias then
6926 pr " || STRCASEEQ (cmd, \"%s\")" alias;
6928 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
6930 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
6931 "=head1 DESCRIPTION\n\n" ^
6932 longdesc ^ warnings ^ describe_alias);
6935 pr " display_builtin_command (cmd);\n";
6939 let emit_print_list_function typ =
6940 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
6943 pr " unsigned int i;\n";
6945 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6946 pr " printf (\"[%%d] = {\\n\", i);\n";
6947 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
6948 pr " printf (\"}\\n\");\n";
6954 (* print_* functions *)
6958 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
6960 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
6963 pr " unsigned int i;\n";
6969 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
6971 pr " printf (\"%%s%s: \", indent);\n" name;
6972 pr " for (i = 0; i < 32; ++i)\n";
6973 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
6974 pr " printf (\"\\n\");\n"
6976 pr " printf (\"%%s%s: \", indent);\n" name;
6977 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
6978 pr " if (c_isprint (%s->%s[i]))\n" typ name;
6979 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
6981 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
6982 pr " printf (\"\\n\");\n"
6983 | name, (FUInt64|FBytes) ->
6984 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
6987 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
6990 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
6993 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
6996 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
6998 | name, FOptPercent ->
6999 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7000 typ name name typ name;
7001 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7007 (* Emit a print_TYPE_list function definition only if that function is used. *)
7010 | typ, (RStructListOnly | RStructAndList) ->
7011 (* generate the function for typ *)
7012 emit_print_list_function typ
7013 | typ, _ -> () (* empty *)
7014 ) (rstructs_used_by all_functions);
7016 (* Emit a print_TYPE function definition only if that function is used. *)
7019 | typ, (RStructOnly | RStructAndList) ->
7020 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7022 pr " print_%s_indent (%s, \"\");\n" typ typ;
7025 | typ, _ -> () (* empty *)
7026 ) (rstructs_used_by all_functions);
7028 (* run_<action> actions *)
7030 fun (name, style, _, flags, _, _, _) ->
7031 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7033 (match fst style with
7036 | RBool _ -> pr " int r;\n"
7037 | RInt64 _ -> pr " int64_t r;\n"
7038 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7039 | RString _ -> pr " char *r;\n"
7040 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7041 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7042 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7045 pr " size_t size;\n";
7053 | FileOut n -> pr " const char *%s;\n" n
7055 | Dev_or_Path n -> pr " char *%s;\n" n
7056 | StringList n | DeviceList n -> pr " char **%s;\n" n
7057 | Bool n -> pr " int %s;\n" n
7058 | Int n -> pr " int %s;\n" n
7059 | Int64 n -> pr " int64_t %s;\n" n
7062 (* Check and convert parameters. *)
7063 let argc_expected = List.length (snd style) in
7064 pr " if (argc != %d) {\n" argc_expected;
7065 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7067 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7075 pr " %s = argv[%d];\n" name i
7077 | Dev_or_Path name ->
7078 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7079 pr " if (%s == NULL) return -1;\n" name
7081 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7084 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7087 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7089 | StringList name | DeviceList name ->
7090 pr " %s = parse_string_list (argv[%d]);\n" name i;
7091 pr " if (%s == NULL) return -1;\n" name;
7093 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7095 pr " %s = atoi (argv[%d]);\n" name i
7097 pr " %s = atoll (argv[%d]);\n" name i
7100 (* Call C API function. *)
7102 try find_map (function FishAction n -> Some n | _ -> None) flags
7103 with Not_found -> sprintf "guestfs_%s" name in
7105 generate_c_call_args ~handle:"g" style;
7110 | Device name | String name
7111 | OptString name | FileIn name | FileOut name | Bool name
7112 | Int name | Int64 name -> ()
7113 | Pathname name | Dev_or_Path name ->
7114 pr " free (%s);\n" name
7115 | StringList name | DeviceList name ->
7116 pr " free_strings (%s);\n" name
7119 (* Check return value for errors and display command results. *)
7120 (match fst style with
7121 | RErr -> pr " return r;\n"
7123 pr " if (r == -1) return -1;\n";
7124 pr " printf (\"%%d\\n\", r);\n";
7127 pr " if (r == -1) return -1;\n";
7128 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7131 pr " if (r == -1) return -1;\n";
7132 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7135 pr " if (r == NULL) return -1;\n";
7136 pr " printf (\"%%s\\n\", r);\n";
7138 | RConstOptString _ ->
7139 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7142 pr " if (r == NULL) return -1;\n";
7143 pr " printf (\"%%s\\n\", r);\n";
7147 pr " if (r == NULL) return -1;\n";
7148 pr " print_strings (r);\n";
7149 pr " free_strings (r);\n";
7151 | RStruct (_, typ) ->
7152 pr " if (r == NULL) return -1;\n";
7153 pr " print_%s (r);\n" typ;
7154 pr " guestfs_free_%s (r);\n" typ;
7156 | RStructList (_, typ) ->
7157 pr " if (r == NULL) return -1;\n";
7158 pr " print_%s_list (r);\n" typ;
7159 pr " guestfs_free_%s_list (r);\n" typ;
7162 pr " if (r == NULL) return -1;\n";
7163 pr " print_table (r);\n";
7164 pr " free_strings (r);\n";
7167 pr " if (r == NULL) return -1;\n";
7168 pr " fwrite (r, size, 1, stdout);\n";
7176 (* run_action function *)
7177 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7180 fun (name, _, _, flags, _, _, _) ->
7181 let name2 = replace_char name '_' '-' in
7183 try find_map (function FishAlias n -> Some n | _ -> None) flags
7184 with Not_found -> name in
7186 pr "STRCASEEQ (cmd, \"%s\")" name;
7187 if name <> name2 then
7188 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7189 if name <> alias then
7190 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7192 pr " return run_%s (cmd, argc, argv);\n" name;
7196 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7203 (* Readline completion for guestfish. *)
7204 and generate_fish_completion () =
7205 generate_header CStyle GPLv2plus;
7209 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7219 #ifdef HAVE_LIBREADLINE
7220 #include <readline/readline.h>
7225 #ifdef HAVE_LIBREADLINE
7227 static const char *const commands[] = {
7228 BUILTIN_COMMANDS_FOR_COMPLETION,
7231 (* Get the commands, including the aliases. They don't need to be
7232 * sorted - the generator() function just does a dumb linear search.
7236 fun (name, _, _, flags, _, _, _) ->
7237 let name2 = replace_char name '_' '-' in
7239 try find_map (function FishAlias n -> Some n | _ -> None) flags
7240 with Not_found -> name in
7242 if name <> alias then [name2; alias] else [name2]
7244 let commands = List.flatten commands in
7246 List.iter (pr " \"%s\",\n") commands;
7252 generator (const char *text, int state)
7254 static int index, len;
7259 len = strlen (text);
7262 rl_attempted_completion_over = 1;
7264 while ((name = commands[index]) != NULL) {
7266 if (STRCASEEQLEN (name, text, len))
7267 return strdup (name);
7273 #endif /* HAVE_LIBREADLINE */
7275 char **do_completion (const char *text, int start, int end)
7277 char **matches = NULL;
7279 #ifdef HAVE_LIBREADLINE
7280 rl_completion_append_character = ' ';
7283 matches = rl_completion_matches (text, generator);
7284 else if (complete_dest_paths)
7285 matches = rl_completion_matches (text, complete_dest_paths_generator);
7292 (* Generate the POD documentation for guestfish. *)
7293 and generate_fish_actions_pod () =
7294 let all_functions_sorted =
7296 fun (_, _, _, flags, _, _, _) ->
7297 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7298 ) all_functions_sorted in
7300 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7303 fun (name, style, _, flags, _, _, longdesc) ->
7305 Str.global_substitute rex (
7308 try Str.matched_group 1 s
7310 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7311 "C<" ^ replace_char sub '_' '-' ^ ">"
7313 let name = replace_char name '_' '-' in
7315 try find_map (function FishAlias n -> Some n | _ -> None) flags
7316 with Not_found -> name in
7318 pr "=head2 %s" name;
7319 if name <> alias then
7326 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7327 | OptString n -> pr " %s" n
7328 | StringList n | DeviceList n -> pr " '%s ...'" n
7329 | Bool _ -> pr " true|false"
7330 | Int n -> pr " %s" n
7331 | Int64 n -> pr " %s" n
7332 | FileIn n | FileOut n -> pr " (%s|-)" n
7336 pr "%s\n\n" longdesc;
7338 if List.exists (function FileIn _ | FileOut _ -> true
7339 | _ -> false) (snd style) then
7340 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7342 if List.mem ProtocolLimitWarning flags then
7343 pr "%s\n\n" protocol_limit_warning;
7345 if List.mem DangerWillRobinson flags then
7346 pr "%s\n\n" danger_will_robinson;
7348 match deprecation_notice flags with
7350 | Some txt -> pr "%s\n\n" txt
7351 ) all_functions_sorted
7353 (* Generate a C function prototype. *)
7354 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7355 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7357 ?handle name style =
7358 if extern then pr "extern ";
7359 if static then pr "static ";
7360 (match fst style with
7362 | RInt _ -> pr "int "
7363 | RInt64 _ -> pr "int64_t "
7364 | RBool _ -> pr "int "
7365 | RConstString _ | RConstOptString _ -> pr "const char *"
7366 | RString _ | RBufferOut _ -> pr "char *"
7367 | RStringList _ | RHashtable _ -> pr "char **"
7368 | RStruct (_, typ) ->
7369 if not in_daemon then pr "struct guestfs_%s *" typ
7370 else pr "guestfs_int_%s *" typ
7371 | RStructList (_, typ) ->
7372 if not in_daemon then pr "struct guestfs_%s_list *" typ
7373 else pr "guestfs_int_%s_list *" typ
7375 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7376 pr "%s%s (" prefix name;
7377 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7380 let comma = ref false in
7383 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7387 if single_line then pr ", " else pr ",\n\t\t"
7394 | Device n | Dev_or_Path n
7398 pr "const char *%s" n
7399 | StringList n | DeviceList n ->
7401 pr "char *const *%s" n
7402 | Bool n -> next (); pr "int %s" n
7403 | Int n -> next (); pr "int %s" n
7404 | Int64 n -> next (); pr "int64_t %s" n
7407 if not in_daemon then (next (); pr "const char *%s" n)
7409 if is_RBufferOut then (next (); pr "size_t *size_r");
7412 if semicolon then pr ";";
7413 if newline then pr "\n"
7415 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7416 and generate_c_call_args ?handle ?(decl = false) style =
7418 let comma = ref false in
7420 if !comma then pr ", ";
7425 | Some handle -> pr "%s" handle; comma := true
7430 pr "%s" (name_of_argt arg)
7432 (* For RBufferOut calls, add implicit &size parameter. *)
7434 match fst style with
7442 (* Generate the OCaml bindings interface. *)
7443 and generate_ocaml_mli () =
7444 generate_header OCamlStyle LGPLv2plus;
7447 (** For API documentation you should refer to the C API
7448 in the guestfs(3) manual page. The OCaml API uses almost
7449 exactly the same calls. *)
7452 (** A [guestfs_h] handle. *)
7454 exception Error of string
7455 (** This exception is raised when there is an error. *)
7457 exception Handle_closed of string
7458 (** This exception is raised if you use a {!Guestfs.t} handle
7459 after calling {!close} on it. The string is the name of
7462 val create : unit -> t
7463 (** Create a {!Guestfs.t} handle. *)
7465 val close : t -> unit
7466 (** Close the {!Guestfs.t} handle and free up all resources used
7469 Handles are closed by the garbage collector when they become
7470 unreferenced, but callers can call this in order to provide
7471 predictable cleanup. *)
7474 generate_ocaml_structure_decls ();
7478 fun (name, style, _, _, _, shortdesc, _) ->
7479 generate_ocaml_prototype name style;
7480 pr "(** %s *)\n" shortdesc;
7482 ) all_functions_sorted
7484 (* Generate the OCaml bindings implementation. *)
7485 and generate_ocaml_ml () =
7486 generate_header OCamlStyle LGPLv2plus;
7491 exception Error of string
7492 exception Handle_closed of string
7494 external create : unit -> t = \"ocaml_guestfs_create\"
7495 external close : t -> unit = \"ocaml_guestfs_close\"
7497 (* Give the exceptions names, so they can be raised from the C code. *)
7499 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7500 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7504 generate_ocaml_structure_decls ();
7508 fun (name, style, _, _, _, shortdesc, _) ->
7509 generate_ocaml_prototype ~is_external:true name style;
7510 ) all_functions_sorted
7512 (* Generate the OCaml bindings C implementation. *)
7513 and generate_ocaml_c () =
7514 generate_header CStyle LGPLv2plus;
7521 #include <caml/config.h>
7522 #include <caml/alloc.h>
7523 #include <caml/callback.h>
7524 #include <caml/fail.h>
7525 #include <caml/memory.h>
7526 #include <caml/mlvalues.h>
7527 #include <caml/signals.h>
7529 #include <guestfs.h>
7531 #include \"guestfs_c.h\"
7533 /* Copy a hashtable of string pairs into an assoc-list. We return
7534 * the list in reverse order, but hashtables aren't supposed to be
7537 static CAMLprim value
7538 copy_table (char * const * argv)
7541 CAMLlocal5 (rv, pairv, kv, vv, cons);
7545 for (i = 0; argv[i] != NULL; i += 2) {
7546 kv = caml_copy_string (argv[i]);
7547 vv = caml_copy_string (argv[i+1]);
7548 pairv = caml_alloc (2, 0);
7549 Store_field (pairv, 0, kv);
7550 Store_field (pairv, 1, vv);
7551 cons = caml_alloc (2, 0);
7552 Store_field (cons, 1, rv);
7554 Store_field (cons, 0, pairv);
7562 (* Struct copy functions. *)
7564 let emit_ocaml_copy_list_function typ =
7565 pr "static CAMLprim value\n";
7566 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7568 pr " CAMLparam0 ();\n";
7569 pr " CAMLlocal2 (rv, v);\n";
7570 pr " unsigned int i;\n";
7572 pr " if (%ss->len == 0)\n" typ;
7573 pr " CAMLreturn (Atom (0));\n";
7575 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7576 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7577 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7578 pr " caml_modify (&Field (rv, i), v);\n";
7580 pr " CAMLreturn (rv);\n";
7588 let has_optpercent_col =
7589 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7591 pr "static CAMLprim value\n";
7592 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7594 pr " CAMLparam0 ();\n";
7595 if has_optpercent_col then
7596 pr " CAMLlocal3 (rv, v, v2);\n"
7598 pr " CAMLlocal2 (rv, v);\n";
7600 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
7605 pr " v = caml_copy_string (%s->%s);\n" typ name
7607 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
7608 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
7611 pr " v = caml_alloc_string (32);\n";
7612 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
7613 | name, (FBytes|FInt64|FUInt64) ->
7614 pr " v = caml_copy_int64 (%s->%s);\n" typ name
7615 | name, (FInt32|FUInt32) ->
7616 pr " v = caml_copy_int32 (%s->%s);\n" typ name
7617 | name, FOptPercent ->
7618 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
7619 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
7620 pr " v = caml_alloc (1, 0);\n";
7621 pr " Store_field (v, 0, v2);\n";
7622 pr " } else /* None */\n";
7623 pr " v = Val_int (0);\n";
7625 pr " v = Val_int (%s->%s);\n" typ name
7627 pr " Store_field (rv, %d, v);\n" i
7629 pr " CAMLreturn (rv);\n";
7634 (* Emit a copy_TYPE_list function definition only if that function is used. *)
7637 | typ, (RStructListOnly | RStructAndList) ->
7638 (* generate the function for typ *)
7639 emit_ocaml_copy_list_function typ
7640 | typ, _ -> () (* empty *)
7641 ) (rstructs_used_by all_functions);
7645 fun (name, style, _, _, _, _, _) ->
7646 pr "/* Automatically generated wrapper for function\n";
7648 generate_ocaml_prototype name style;
7653 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
7655 let needs_extra_vs =
7656 match fst style with RConstOptString _ -> true | _ -> false in
7658 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7659 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
7660 List.iter (pr ", value %s") (List.tl params); pr ");\n";
7663 pr "CAMLprim value\n";
7664 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
7665 List.iter (pr ", value %s") (List.tl params);
7670 | [p1; p2; p3; p4; p5] ->
7671 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
7672 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
7673 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
7674 pr " CAMLxparam%d (%s);\n"
7675 (List.length rest) (String.concat ", " rest)
7677 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
7679 if not needs_extra_vs then
7680 pr " CAMLlocal1 (rv);\n"
7682 pr " CAMLlocal3 (rv, v, v2);\n";
7685 pr " guestfs_h *g = Guestfs_val (gv);\n";
7686 pr " if (g == NULL)\n";
7687 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
7693 | Device n | Dev_or_Path n
7697 pr " const char *%s = String_val (%sv);\n" n n
7699 pr " const char *%s =\n" n;
7700 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
7702 | StringList n | DeviceList n ->
7703 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
7705 pr " int %s = Bool_val (%sv);\n" n n
7707 pr " int %s = Int_val (%sv);\n" n n
7709 pr " int64_t %s = Int64_val (%sv);\n" n n
7712 match fst style with
7713 | RErr -> pr " int r;\n"; "-1"
7714 | RInt _ -> pr " int r;\n"; "-1"
7715 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7716 | RBool _ -> pr " int r;\n"; "-1"
7717 | RConstString _ | RConstOptString _ ->
7718 pr " const char *r;\n"; "NULL"
7719 | RString _ -> pr " char *r;\n"; "NULL"
7724 | RStruct (_, typ) ->
7725 pr " struct guestfs_%s *r;\n" typ; "NULL"
7726 | RStructList (_, typ) ->
7727 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7734 pr " size_t size;\n";
7738 pr " caml_enter_blocking_section ();\n";
7739 pr " r = guestfs_%s " name;
7740 generate_c_call_args ~handle:"g" style;
7742 pr " caml_leave_blocking_section ();\n";
7746 | StringList n | DeviceList n ->
7747 pr " ocaml_guestfs_free_strings (%s);\n" n;
7748 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
7749 | Bool _ | Int _ | Int64 _
7750 | FileIn _ | FileOut _ -> ()
7753 pr " if (r == %s)\n" error_code;
7754 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
7757 (match fst style with
7758 | RErr -> pr " rv = Val_unit;\n"
7759 | RInt _ -> pr " rv = Val_int (r);\n"
7761 pr " rv = caml_copy_int64 (r);\n"
7762 | RBool _ -> pr " rv = Val_bool (r);\n"
7764 pr " rv = caml_copy_string (r);\n"
7765 | RConstOptString _ ->
7766 pr " if (r) { /* Some string */\n";
7767 pr " v = caml_alloc (1, 0);\n";
7768 pr " v2 = caml_copy_string (r);\n";
7769 pr " Store_field (v, 0, v2);\n";
7770 pr " } else /* None */\n";
7771 pr " v = Val_int (0);\n";
7773 pr " rv = caml_copy_string (r);\n";
7776 pr " rv = caml_copy_string_array ((const char **) r);\n";
7777 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7779 | RStruct (_, typ) ->
7780 pr " rv = copy_%s (r);\n" typ;
7781 pr " guestfs_free_%s (r);\n" typ;
7782 | RStructList (_, typ) ->
7783 pr " rv = copy_%s_list (r);\n" typ;
7784 pr " guestfs_free_%s_list (r);\n" typ;
7786 pr " rv = copy_table (r);\n";
7787 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7790 pr " rv = caml_alloc_string (size);\n";
7791 pr " memcpy (String_val (rv), r, size);\n";
7794 pr " CAMLreturn (rv);\n";
7798 if List.length params > 5 then (
7799 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7800 pr "CAMLprim value ";
7801 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
7802 pr "CAMLprim value\n";
7803 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
7805 pr " return ocaml_guestfs_%s (argv[0]" name;
7806 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
7811 ) all_functions_sorted
7813 and generate_ocaml_structure_decls () =
7816 pr "type %s = {\n" typ;
7819 | name, FString -> pr " %s : string;\n" name
7820 | name, FBuffer -> pr " %s : string;\n" name
7821 | name, FUUID -> pr " %s : string;\n" name
7822 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
7823 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
7824 | name, FChar -> pr " %s : char;\n" name
7825 | name, FOptPercent -> pr " %s : float option;\n" name
7831 and generate_ocaml_prototype ?(is_external = false) name style =
7832 if is_external then pr "external " else pr "val ";
7833 pr "%s : t -> " name;
7836 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
7837 | OptString _ -> pr "string option -> "
7838 | StringList _ | DeviceList _ -> pr "string array -> "
7839 | Bool _ -> pr "bool -> "
7840 | Int _ -> pr "int -> "
7841 | Int64 _ -> pr "int64 -> "
7843 (match fst style with
7844 | RErr -> pr "unit" (* all errors are turned into exceptions *)
7845 | RInt _ -> pr "int"
7846 | RInt64 _ -> pr "int64"
7847 | RBool _ -> pr "bool"
7848 | RConstString _ -> pr "string"
7849 | RConstOptString _ -> pr "string option"
7850 | RString _ | RBufferOut _ -> pr "string"
7851 | RStringList _ -> pr "string array"
7852 | RStruct (_, typ) -> pr "%s" typ
7853 | RStructList (_, typ) -> pr "%s array" typ
7854 | RHashtable _ -> pr "(string * string) list"
7856 if is_external then (
7858 if List.length (snd style) + 1 > 5 then
7859 pr "\"ocaml_guestfs_%s_byte\" " name;
7860 pr "\"ocaml_guestfs_%s\"" name
7864 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
7865 and generate_perl_xs () =
7866 generate_header CStyle LGPLv2plus;
7869 #include \"EXTERN.h\"
7873 #include <guestfs.h>
7876 #define PRId64 \"lld\"
7880 my_newSVll(long long val) {
7881 #ifdef USE_64_BIT_ALL
7882 return newSViv(val);
7886 len = snprintf(buf, 100, \"%%\" PRId64, val);
7887 return newSVpv(buf, len);
7892 #define PRIu64 \"llu\"
7896 my_newSVull(unsigned long long val) {
7897 #ifdef USE_64_BIT_ALL
7898 return newSVuv(val);
7902 len = snprintf(buf, 100, \"%%\" PRIu64, val);
7903 return newSVpv(buf, len);
7907 /* http://www.perlmonks.org/?node_id=680842 */
7909 XS_unpack_charPtrPtr (SV *arg) {
7914 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
7915 croak (\"array reference expected\");
7917 av = (AV *)SvRV (arg);
7918 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
7920 croak (\"malloc failed\");
7922 for (i = 0; i <= av_len (av); i++) {
7923 SV **elem = av_fetch (av, i, 0);
7925 if (!elem || !*elem)
7926 croak (\"missing element in list\");
7928 ret[i] = SvPV_nolen (*elem);
7936 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
7943 RETVAL = guestfs_create ();
7945 croak (\"could not create guestfs handle\");
7946 guestfs_set_error_handler (RETVAL, NULL, NULL);
7959 fun (name, style, _, _, _, _, _) ->
7960 (match fst style with
7961 | RErr -> pr "void\n"
7962 | RInt _ -> pr "SV *\n"
7963 | RInt64 _ -> pr "SV *\n"
7964 | RBool _ -> pr "SV *\n"
7965 | RConstString _ -> pr "SV *\n"
7966 | RConstOptString _ -> pr "SV *\n"
7967 | RString _ -> pr "SV *\n"
7968 | RBufferOut _ -> pr "SV *\n"
7970 | RStruct _ | RStructList _
7972 pr "void\n" (* all lists returned implictly on the stack *)
7974 (* Call and arguments. *)
7976 generate_c_call_args ~handle:"g" ~decl:true style;
7978 pr " guestfs_h *g;\n";
7982 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
7985 (* http://www.perlmonks.org/?node_id=554277
7986 * Note that the implicit handle argument means we have
7987 * to add 1 to the ST(x) operator.
7989 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
7990 | StringList n | DeviceList n -> pr " char **%s;\n" n
7991 | Bool n -> pr " int %s;\n" n
7992 | Int n -> pr " int %s;\n" n
7993 | Int64 n -> pr " int64_t %s;\n" n
7996 let do_cleanups () =
7999 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8000 | Bool _ | Int _ | Int64 _
8001 | FileIn _ | FileOut _ -> ()
8002 | StringList n | DeviceList n -> pr " free (%s);\n" n
8007 (match fst style with
8012 pr " r = guestfs_%s " name;
8013 generate_c_call_args ~handle:"g" style;
8016 pr " if (r == -1)\n";
8017 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8023 pr " %s = guestfs_%s " n name;
8024 generate_c_call_args ~handle:"g" style;
8027 pr " if (%s == -1)\n" n;
8028 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8029 pr " RETVAL = newSViv (%s);\n" n;
8034 pr " int64_t %s;\n" n;
8036 pr " %s = guestfs_%s " n name;
8037 generate_c_call_args ~handle:"g" style;
8040 pr " if (%s == -1)\n" n;
8041 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8042 pr " RETVAL = my_newSVll (%s);\n" n;
8047 pr " const char *%s;\n" n;
8049 pr " %s = guestfs_%s " n name;
8050 generate_c_call_args ~handle:"g" style;
8053 pr " if (%s == NULL)\n" n;
8054 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8055 pr " RETVAL = newSVpv (%s, 0);\n" n;
8058 | RConstOptString n ->
8060 pr " const char *%s;\n" n;
8062 pr " %s = guestfs_%s " n name;
8063 generate_c_call_args ~handle:"g" style;
8066 pr " if (%s == NULL)\n" n;
8067 pr " RETVAL = &PL_sv_undef;\n";
8069 pr " RETVAL = newSVpv (%s, 0);\n" n;
8074 pr " char *%s;\n" n;
8076 pr " %s = guestfs_%s " n name;
8077 generate_c_call_args ~handle:"g" style;
8080 pr " if (%s == NULL)\n" n;
8081 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8082 pr " RETVAL = newSVpv (%s, 0);\n" n;
8083 pr " free (%s);\n" n;
8086 | RStringList n | RHashtable n ->
8088 pr " char **%s;\n" n;
8091 pr " %s = guestfs_%s " n name;
8092 generate_c_call_args ~handle:"g" style;
8095 pr " if (%s == NULL)\n" n;
8096 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8097 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8098 pr " EXTEND (SP, n);\n";
8099 pr " for (i = 0; i < n; ++i) {\n";
8100 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8101 pr " free (%s[i]);\n" n;
8103 pr " free (%s);\n" n;
8104 | RStruct (n, typ) ->
8105 let cols = cols_of_struct typ in
8106 generate_perl_struct_code typ cols name style n do_cleanups
8107 | RStructList (n, typ) ->
8108 let cols = cols_of_struct typ in
8109 generate_perl_struct_list_code typ cols name style n do_cleanups
8112 pr " char *%s;\n" n;
8113 pr " size_t size;\n";
8115 pr " %s = guestfs_%s " n name;
8116 generate_c_call_args ~handle:"g" style;
8119 pr " if (%s == NULL)\n" n;
8120 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8121 pr " RETVAL = newSVpv (%s, size);\n" n;
8122 pr " free (%s);\n" n;
8130 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8132 pr " struct guestfs_%s_list *%s;\n" typ n;
8136 pr " %s = guestfs_%s " n name;
8137 generate_c_call_args ~handle:"g" style;
8140 pr " if (%s == NULL)\n" n;
8141 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8142 pr " EXTEND (SP, %s->len);\n" n;
8143 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8144 pr " hv = newHV ();\n";
8148 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8149 name (String.length name) n name
8151 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8152 name (String.length name) n name
8154 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8155 name (String.length name) n name n name
8156 | name, (FBytes|FUInt64) ->
8157 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8158 name (String.length name) n name
8160 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8161 name (String.length name) n name
8162 | name, (FInt32|FUInt32) ->
8163 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8164 name (String.length name) n name
8166 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8167 name (String.length name) n name
8168 | name, FOptPercent ->
8169 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8170 name (String.length name) n name
8172 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8174 pr " guestfs_free_%s_list (%s);\n" typ n
8176 and generate_perl_struct_code typ cols name style n do_cleanups =
8178 pr " struct guestfs_%s *%s;\n" typ n;
8180 pr " %s = guestfs_%s " n name;
8181 generate_c_call_args ~handle:"g" style;
8184 pr " if (%s == NULL)\n" n;
8185 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8186 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8188 fun ((name, _) as col) ->
8189 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8193 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8196 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
8199 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8201 | name, (FBytes|FUInt64) ->
8202 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8205 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8207 | name, (FInt32|FUInt32) ->
8208 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8211 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8213 | name, FOptPercent ->
8214 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8217 pr " free (%s);\n" n
8219 (* Generate Sys/Guestfs.pm. *)
8220 and generate_perl_pm () =
8221 generate_header HashStyle LGPLv2plus;
8228 Sys::Guestfs - Perl bindings for libguestfs
8234 my $h = Sys::Guestfs->new ();
8235 $h->add_drive ('guest.img');
8237 $h->mount ('/dev/sda1', '/');
8238 $h->touch ('/hello');
8243 The C<Sys::Guestfs> module provides a Perl XS binding to the
8244 libguestfs API for examining and modifying virtual machine
8247 Amongst the things this is good for: making batch configuration
8248 changes to guests, getting disk used/free statistics (see also:
8249 virt-df), migrating between virtualization systems (see also:
8250 virt-p2v), performing partial backups, performing partial guest
8251 clones, cloning guests and changing registry/UUID/hostname info, and
8254 Libguestfs uses Linux kernel and qemu code, and can access any type of
8255 guest filesystem that Linux and qemu can, including but not limited
8256 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8257 schemes, qcow, qcow2, vmdk.
8259 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8260 LVs, what filesystem is in each LV, etc.). It can also run commands
8261 in the context of the guest. Also you can access filesystems over FTP.
8263 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8264 functions for using libguestfs from Perl, including integration
8269 All errors turn into calls to C<croak> (see L<Carp(3)>).
8277 package Sys::Guestfs;
8283 XSLoader::load ('Sys::Guestfs');
8285 =item $h = Sys::Guestfs->new ();
8287 Create a new guestfs handle.
8293 my $class = ref ($proto) || $proto;
8295 my $self = Sys::Guestfs::_create ();
8296 bless $self, $class;
8302 (* Actions. We only need to print documentation for these as
8303 * they are pulled in from the XS code automatically.
8306 fun (name, style, _, flags, _, _, longdesc) ->
8307 if not (List.mem NotInDocs flags) then (
8308 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8310 generate_perl_prototype name style;
8312 pr "%s\n\n" longdesc;
8313 if List.mem ProtocolLimitWarning flags then
8314 pr "%s\n\n" protocol_limit_warning;
8315 if List.mem DangerWillRobinson flags then
8316 pr "%s\n\n" danger_will_robinson;
8317 match deprecation_notice flags with
8319 | Some txt -> pr "%s\n\n" txt
8321 ) all_functions_sorted;
8333 Copyright (C) %s Red Hat Inc.
8337 Please see the file COPYING.LIB for the full license.
8343 L<http://libguestfs.org>,
8344 L<Sys::Guestfs::Lib(3)>.
8349 and generate_perl_prototype name style =
8350 (match fst style with
8358 | RBufferOut n -> pr "$%s = " n
8360 | RHashtable n -> pr "%%%s = " n
8362 | RStructList (n,_) -> pr "@%s = " n
8365 let comma = ref false in
8368 if !comma then pr ", ";
8371 | Pathname n | Device n | Dev_or_Path n | String n
8372 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8374 | StringList n | DeviceList n ->
8379 (* Generate Python C module. *)
8380 and generate_python_c () =
8381 generate_header CStyle LGPLv2plus;
8390 #include \"guestfs.h\"
8398 get_handle (PyObject *obj)
8401 assert (obj != Py_None);
8402 return ((Pyguestfs_Object *) obj)->g;
8406 put_handle (guestfs_h *g)
8410 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8413 /* This list should be freed (but not the strings) after use. */
8415 get_string_list (PyObject *obj)
8422 if (!PyList_Check (obj)) {
8423 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8427 len = PyList_Size (obj);
8428 r = malloc (sizeof (char *) * (len+1));
8430 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8434 for (i = 0; i < len; ++i)
8435 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8442 put_string_list (char * const * const argv)
8447 for (argc = 0; argv[argc] != NULL; ++argc)
8450 list = PyList_New (argc);
8451 for (i = 0; i < argc; ++i)
8452 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8458 put_table (char * const * const argv)
8460 PyObject *list, *item;
8463 for (argc = 0; argv[argc] != NULL; ++argc)
8466 list = PyList_New (argc >> 1);
8467 for (i = 0; i < argc; i += 2) {
8468 item = PyTuple_New (2);
8469 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8470 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8471 PyList_SetItem (list, i >> 1, item);
8478 free_strings (char **argv)
8482 for (argc = 0; argv[argc] != NULL; ++argc)
8488 py_guestfs_create (PyObject *self, PyObject *args)
8492 g = guestfs_create ();
8494 PyErr_SetString (PyExc_RuntimeError,
8495 \"guestfs.create: failed to allocate handle\");
8498 guestfs_set_error_handler (g, NULL, NULL);
8499 return put_handle (g);
8503 py_guestfs_close (PyObject *self, PyObject *args)
8508 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8510 g = get_handle (py_g);
8514 Py_INCREF (Py_None);
8520 let emit_put_list_function typ =
8521 pr "static PyObject *\n";
8522 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8524 pr " PyObject *list;\n";
8527 pr " list = PyList_New (%ss->len);\n" typ;
8528 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8529 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8530 pr " return list;\n";
8535 (* Structures, turned into Python dictionaries. *)
8538 pr "static PyObject *\n";
8539 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8541 pr " PyObject *dict;\n";
8543 pr " dict = PyDict_New ();\n";
8547 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8548 pr " PyString_FromString (%s->%s));\n"
8551 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8552 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8555 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8556 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8558 | name, (FBytes|FUInt64) ->
8559 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8560 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8563 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8564 pr " PyLong_FromLongLong (%s->%s));\n"
8567 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8568 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8571 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8572 pr " PyLong_FromLong (%s->%s));\n"
8574 | name, FOptPercent ->
8575 pr " if (%s->%s >= 0)\n" typ name;
8576 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8577 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8580 pr " Py_INCREF (Py_None);\n";
8581 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8584 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8585 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8587 pr " return dict;\n";
8593 (* Emit a put_TYPE_list function definition only if that function is used. *)
8596 | typ, (RStructListOnly | RStructAndList) ->
8597 (* generate the function for typ *)
8598 emit_put_list_function typ
8599 | typ, _ -> () (* empty *)
8600 ) (rstructs_used_by all_functions);
8602 (* Python wrapper functions. *)
8604 fun (name, style, _, _, _, _, _) ->
8605 pr "static PyObject *\n";
8606 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
8609 pr " PyObject *py_g;\n";
8610 pr " guestfs_h *g;\n";
8611 pr " PyObject *py_r;\n";
8614 match fst style with
8615 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8616 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8617 | RConstString _ | RConstOptString _ ->
8618 pr " const char *r;\n"; "NULL"
8619 | RString _ -> pr " char *r;\n"; "NULL"
8620 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8621 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8622 | RStructList (_, typ) ->
8623 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8626 pr " size_t size;\n";
8631 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8632 pr " const char *%s;\n" n
8633 | OptString n -> pr " const char *%s;\n" n
8634 | StringList n | DeviceList n ->
8635 pr " PyObject *py_%s;\n" n;
8636 pr " char **%s;\n" n
8637 | Bool n -> pr " int %s;\n" n
8638 | Int n -> pr " int %s;\n" n
8639 | Int64 n -> pr " long long %s;\n" n
8644 (* Convert the parameters. *)
8645 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
8648 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
8649 | OptString _ -> pr "z"
8650 | StringList _ | DeviceList _ -> pr "O"
8651 | Bool _ -> pr "i" (* XXX Python has booleans? *)
8653 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
8654 * emulate C's int/long/long long in Python?
8657 pr ":guestfs_%s\",\n" name;
8661 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
8662 | OptString n -> pr ", &%s" n
8663 | StringList n | DeviceList n -> pr ", &py_%s" n
8664 | Bool n -> pr ", &%s" n
8665 | Int n -> pr ", &%s" n
8666 | Int64 n -> pr ", &%s" n
8670 pr " return NULL;\n";
8672 pr " g = get_handle (py_g);\n";
8675 | Pathname _ | Device _ | Dev_or_Path _ | String _
8676 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8677 | StringList n | DeviceList n ->
8678 pr " %s = get_string_list (py_%s);\n" n n;
8679 pr " if (!%s) return NULL;\n" n
8684 pr " r = guestfs_%s " name;
8685 generate_c_call_args ~handle:"g" style;
8690 | Pathname _ | Device _ | Dev_or_Path _ | String _
8691 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8692 | StringList n | DeviceList n ->
8693 pr " free (%s);\n" n
8696 pr " if (r == %s) {\n" error_code;
8697 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
8698 pr " return NULL;\n";
8702 (match fst style with
8704 pr " Py_INCREF (Py_None);\n";
8705 pr " py_r = Py_None;\n"
8707 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
8708 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
8709 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
8710 | RConstOptString _ ->
8712 pr " py_r = PyString_FromString (r);\n";
8714 pr " Py_INCREF (Py_None);\n";
8715 pr " py_r = Py_None;\n";
8718 pr " py_r = PyString_FromString (r);\n";
8721 pr " py_r = put_string_list (r);\n";
8722 pr " free_strings (r);\n"
8723 | RStruct (_, typ) ->
8724 pr " py_r = put_%s (r);\n" typ;
8725 pr " guestfs_free_%s (r);\n" typ
8726 | RStructList (_, typ) ->
8727 pr " py_r = put_%s_list (r);\n" typ;
8728 pr " guestfs_free_%s_list (r);\n" typ
8730 pr " py_r = put_table (r);\n";
8731 pr " free_strings (r);\n"
8733 pr " py_r = PyString_FromStringAndSize (r, size);\n";
8737 pr " return py_r;\n";
8742 (* Table of functions. *)
8743 pr "static PyMethodDef methods[] = {\n";
8744 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
8745 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
8747 fun (name, _, _, _, _, _, _) ->
8748 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
8751 pr " { NULL, NULL, 0, NULL }\n";
8755 (* Init function. *)
8758 initlibguestfsmod (void)
8760 static int initialized = 0;
8762 if (initialized) return;
8763 Py_InitModule ((char *) \"libguestfsmod\", methods);
8768 (* Generate Python module. *)
8769 and generate_python_py () =
8770 generate_header HashStyle LGPLv2plus;
8773 u\"\"\"Python bindings for libguestfs
8776 g = guestfs.GuestFS ()
8777 g.add_drive (\"guest.img\")
8779 parts = g.list_partitions ()
8781 The guestfs module provides a Python binding to the libguestfs API
8782 for examining and modifying virtual machine disk images.
8784 Amongst the things this is good for: making batch configuration
8785 changes to guests, getting disk used/free statistics (see also:
8786 virt-df), migrating between virtualization systems (see also:
8787 virt-p2v), performing partial backups, performing partial guest
8788 clones, cloning guests and changing registry/UUID/hostname info, and
8791 Libguestfs uses Linux kernel and qemu code, and can access any type of
8792 guest filesystem that Linux and qemu can, including but not limited
8793 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8794 schemes, qcow, qcow2, vmdk.
8796 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8797 LVs, what filesystem is in each LV, etc.). It can also run commands
8798 in the context of the guest. Also you can access filesystems over FTP.
8800 Errors which happen while using the API are turned into Python
8801 RuntimeError exceptions.
8803 To create a guestfs handle you usually have to perform the following
8806 # Create the handle, call add_drive at least once, and possibly
8807 # several times if the guest has multiple block devices:
8808 g = guestfs.GuestFS ()
8809 g.add_drive (\"guest.img\")
8811 # Launch the qemu subprocess and wait for it to become ready:
8814 # Now you can issue commands, for example:
8819 import libguestfsmod
8822 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
8824 def __init__ (self):
8825 \"\"\"Create a new libguestfs handle.\"\"\"
8826 self._o = libguestfsmod.create ()
8829 libguestfsmod.close (self._o)
8834 fun (name, style, _, flags, _, _, longdesc) ->
8836 generate_py_call_args ~handle:"self" (snd style);
8839 if not (List.mem NotInDocs flags) then (
8840 let doc = replace_str longdesc "C<guestfs_" "C<g." in
8842 match fst style with
8843 | RErr | RInt _ | RInt64 _ | RBool _
8844 | RConstOptString _ | RConstString _
8845 | RString _ | RBufferOut _ -> doc
8847 doc ^ "\n\nThis function returns a list of strings."
8848 | RStruct (_, typ) ->
8849 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
8850 | RStructList (_, typ) ->
8851 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
8853 doc ^ "\n\nThis function returns a dictionary." in
8855 if List.mem ProtocolLimitWarning flags then
8856 doc ^ "\n\n" ^ protocol_limit_warning
8859 if List.mem DangerWillRobinson flags then
8860 doc ^ "\n\n" ^ danger_will_robinson
8863 match deprecation_notice flags with
8865 | Some txt -> doc ^ "\n\n" ^ txt in
8866 let doc = pod2text ~width:60 name doc in
8867 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
8868 let doc = String.concat "\n " doc in
8869 pr " u\"\"\"%s\"\"\"\n" doc;
8871 pr " return libguestfsmod.%s " name;
8872 generate_py_call_args ~handle:"self._o" (snd style);
8877 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
8878 and generate_py_call_args ~handle args =
8880 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
8883 (* Useful if you need the longdesc POD text as plain text. Returns a
8886 * Because this is very slow (the slowest part of autogeneration),
8887 * we memoize the results.
8889 and pod2text ~width name longdesc =
8890 let key = width, name, longdesc in
8891 try Hashtbl.find pod2text_memo key
8893 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
8894 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
8896 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
8897 let chan = open_process_in cmd in
8898 let lines = ref [] in
8900 let line = input_line chan in
8901 if i = 1 then (* discard the first line of output *)
8904 let line = triml line in
8905 lines := line :: !lines;
8908 let lines = try loop 1 with End_of_file -> List.rev !lines in
8910 (match close_process_in chan with
8913 failwithf "pod2text: process exited with non-zero status (%d)" i
8914 | WSIGNALED i | WSTOPPED i ->
8915 failwithf "pod2text: process signalled or stopped by signal %d" i
8917 Hashtbl.add pod2text_memo key lines;
8918 pod2text_memo_updated ();
8921 (* Generate ruby bindings. *)
8922 and generate_ruby_c () =
8923 generate_header CStyle LGPLv2plus;
8931 #include \"guestfs.h\"
8933 #include \"extconf.h\"
8935 /* For Ruby < 1.9 */
8937 #define RARRAY_LEN(r) (RARRAY((r))->len)
8940 static VALUE m_guestfs; /* guestfs module */
8941 static VALUE c_guestfs; /* guestfs_h handle */
8942 static VALUE e_Error; /* used for all errors */
8944 static void ruby_guestfs_free (void *p)
8947 guestfs_close ((guestfs_h *) p);
8950 static VALUE ruby_guestfs_create (VALUE m)
8954 g = guestfs_create ();
8956 rb_raise (e_Error, \"failed to create guestfs handle\");
8958 /* Don't print error messages to stderr by default. */
8959 guestfs_set_error_handler (g, NULL, NULL);
8961 /* Wrap it, and make sure the close function is called when the
8964 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
8967 static VALUE ruby_guestfs_close (VALUE gv)
8970 Data_Get_Struct (gv, guestfs_h, g);
8972 ruby_guestfs_free (g);
8973 DATA_PTR (gv) = NULL;
8981 fun (name, style, _, _, _, _, _) ->
8982 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
8983 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
8986 pr " guestfs_h *g;\n";
8987 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
8989 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
8995 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8996 pr " Check_Type (%sv, T_STRING);\n" n;
8997 pr " const char *%s = StringValueCStr (%sv);\n" n n;
8999 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9000 pr " \"%s\", \"%s\");\n" n name
9002 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9003 | StringList n | DeviceList n ->
9004 pr " char **%s;\n" n;
9005 pr " Check_Type (%sv, T_ARRAY);\n" n;
9007 pr " int i, len;\n";
9008 pr " len = RARRAY_LEN (%sv);\n" n;
9009 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9011 pr " for (i = 0; i < len; ++i) {\n";
9012 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9013 pr " %s[i] = StringValueCStr (v);\n" n;
9015 pr " %s[len] = NULL;\n" n;
9018 pr " int %s = RTEST (%sv);\n" n n
9020 pr " int %s = NUM2INT (%sv);\n" n n
9022 pr " long long %s = NUM2LL (%sv);\n" n n
9027 match fst style with
9028 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9029 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9030 | RConstString _ | RConstOptString _ ->
9031 pr " const char *r;\n"; "NULL"
9032 | RString _ -> pr " char *r;\n"; "NULL"
9033 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9034 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9035 | RStructList (_, typ) ->
9036 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9039 pr " size_t size;\n";
9043 pr " r = guestfs_%s " name;
9044 generate_c_call_args ~handle:"g" style;
9049 | Pathname _ | Device _ | Dev_or_Path _ | String _
9050 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9051 | StringList n | DeviceList n ->
9052 pr " free (%s);\n" n
9055 pr " if (r == %s)\n" error_code;
9056 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9059 (match fst style with
9061 pr " return Qnil;\n"
9062 | RInt _ | RBool _ ->
9063 pr " return INT2NUM (r);\n"
9065 pr " return ULL2NUM (r);\n"
9067 pr " return rb_str_new2 (r);\n";
9068 | RConstOptString _ ->
9070 pr " return rb_str_new2 (r);\n";
9072 pr " return Qnil;\n";
9074 pr " VALUE rv = rb_str_new2 (r);\n";
9078 pr " int i, len = 0;\n";
9079 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9080 pr " VALUE rv = rb_ary_new2 (len);\n";
9081 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9082 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9083 pr " free (r[i]);\n";
9087 | RStruct (_, typ) ->
9088 let cols = cols_of_struct typ in
9089 generate_ruby_struct_code typ cols
9090 | RStructList (_, typ) ->
9091 let cols = cols_of_struct typ in
9092 generate_ruby_struct_list_code typ cols
9094 pr " VALUE rv = rb_hash_new ();\n";
9096 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9097 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9098 pr " free (r[i]);\n";
9099 pr " free (r[i+1]);\n";
9104 pr " VALUE rv = rb_str_new (r, size);\n";
9114 /* Initialize the module. */
9115 void Init__guestfs ()
9117 m_guestfs = rb_define_module (\"Guestfs\");
9118 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9119 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9121 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9122 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9125 (* Define the rest of the methods. *)
9127 fun (name, style, _, _, _, _, _) ->
9128 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9129 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9134 (* Ruby code to return a struct. *)
9135 and generate_ruby_struct_code typ cols =
9136 pr " VALUE rv = rb_hash_new ();\n";
9140 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9142 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9144 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9145 | name, (FBytes|FUInt64) ->
9146 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9148 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9150 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9152 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9153 | name, FOptPercent ->
9154 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9155 | name, FChar -> (* XXX wrong? *)
9156 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9158 pr " guestfs_free_%s (r);\n" typ;
9161 (* Ruby code to return a struct list. *)
9162 and generate_ruby_struct_list_code typ cols =
9163 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9165 pr " for (i = 0; i < r->len; ++i) {\n";
9166 pr " VALUE hv = rb_hash_new ();\n";
9170 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9172 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
9174 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9175 | name, (FBytes|FUInt64) ->
9176 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9178 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9180 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9182 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9183 | name, FOptPercent ->
9184 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9185 | name, FChar -> (* XXX wrong? *)
9186 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9188 pr " rb_ary_push (rv, hv);\n";
9190 pr " guestfs_free_%s_list (r);\n" typ;
9193 (* Generate Java bindings GuestFS.java file. *)
9194 and generate_java_java () =
9195 generate_header CStyle LGPLv2plus;
9198 package com.redhat.et.libguestfs;
9200 import java.util.HashMap;
9201 import com.redhat.et.libguestfs.LibGuestFSException;
9202 import com.redhat.et.libguestfs.PV;
9203 import com.redhat.et.libguestfs.VG;
9204 import com.redhat.et.libguestfs.LV;
9205 import com.redhat.et.libguestfs.Stat;
9206 import com.redhat.et.libguestfs.StatVFS;
9207 import com.redhat.et.libguestfs.IntBool;
9208 import com.redhat.et.libguestfs.Dirent;
9211 * The GuestFS object is a libguestfs handle.
9215 public class GuestFS {
9216 // Load the native code.
9218 System.loadLibrary (\"guestfs_jni\");
9222 * The native guestfs_h pointer.
9227 * Create a libguestfs handle.
9229 * @throws LibGuestFSException
9231 public GuestFS () throws LibGuestFSException
9235 private native long _create () throws LibGuestFSException;
9238 * Close a libguestfs handle.
9240 * You can also leave handles to be collected by the garbage
9241 * collector, but this method ensures that the resources used
9242 * by the handle are freed up immediately. If you call any
9243 * other methods after closing the handle, you will get an
9246 * @throws LibGuestFSException
9248 public void close () throws LibGuestFSException
9254 private native void _close (long g) throws LibGuestFSException;
9256 public void finalize () throws LibGuestFSException
9264 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9265 if not (List.mem NotInDocs flags); then (
9266 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9268 if List.mem ProtocolLimitWarning flags then
9269 doc ^ "\n\n" ^ protocol_limit_warning
9272 if List.mem DangerWillRobinson flags then
9273 doc ^ "\n\n" ^ danger_will_robinson
9276 match deprecation_notice flags with
9278 | Some txt -> doc ^ "\n\n" ^ txt in
9279 let doc = pod2text ~width:60 name doc in
9280 let doc = List.map ( (* RHBZ#501883 *)
9283 | nonempty -> nonempty
9285 let doc = String.concat "\n * " doc in
9288 pr " * %s\n" shortdesc;
9291 pr " * @throws LibGuestFSException\n";
9295 generate_java_prototype ~public:true ~semicolon:false name style;
9298 pr " if (g == 0)\n";
9299 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9302 if fst style <> RErr then pr "return ";
9304 generate_java_call_args ~handle:"g" (snd style);
9308 generate_java_prototype ~privat:true ~native:true name style;
9315 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9316 and generate_java_call_args ~handle args =
9318 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9321 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9322 ?(semicolon=true) name style =
9323 if privat then pr "private ";
9324 if public then pr "public ";
9325 if native then pr "native ";
9328 (match fst style with
9329 | RErr -> pr "void ";
9330 | RInt _ -> pr "int ";
9331 | RInt64 _ -> pr "long ";
9332 | RBool _ -> pr "boolean ";
9333 | RConstString _ | RConstOptString _ | RString _
9334 | RBufferOut _ -> pr "String ";
9335 | RStringList _ -> pr "String[] ";
9336 | RStruct (_, typ) ->
9337 let name = java_name_of_struct typ in
9339 | RStructList (_, typ) ->
9340 let name = java_name_of_struct typ in
9342 | RHashtable _ -> pr "HashMap<String,String> ";
9345 if native then pr "_%s " name else pr "%s " name;
9347 let needs_comma = ref false in
9356 if !needs_comma then pr ", ";
9357 needs_comma := true;
9361 | Device n | Dev_or_Path n
9367 | StringList n | DeviceList n ->
9378 pr " throws LibGuestFSException";
9379 if semicolon then pr ";"
9381 and generate_java_struct jtyp cols () =
9382 generate_header CStyle LGPLv2plus;
9385 package com.redhat.et.libguestfs;
9388 * Libguestfs %s structure.
9400 | name, FBuffer -> pr " public String %s;\n" name
9401 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9402 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9403 | name, FChar -> pr " public char %s;\n" name
9404 | name, FOptPercent ->
9405 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9406 pr " public float %s;\n" name
9411 and generate_java_c () =
9412 generate_header CStyle LGPLv2plus;
9419 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9420 #include \"guestfs.h\"
9422 /* Note that this function returns. The exception is not thrown
9423 * until after the wrapper function returns.
9426 throw_exception (JNIEnv *env, const char *msg)
9429 cl = (*env)->FindClass (env,
9430 \"com/redhat/et/libguestfs/LibGuestFSException\");
9431 (*env)->ThrowNew (env, cl, msg);
9434 JNIEXPORT jlong JNICALL
9435 Java_com_redhat_et_libguestfs_GuestFS__1create
9436 (JNIEnv *env, jobject obj)
9440 g = guestfs_create ();
9442 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9445 guestfs_set_error_handler (g, NULL, NULL);
9446 return (jlong) (long) g;
9449 JNIEXPORT void JNICALL
9450 Java_com_redhat_et_libguestfs_GuestFS__1close
9451 (JNIEnv *env, jobject obj, jlong jg)
9453 guestfs_h *g = (guestfs_h *) (long) jg;
9460 fun (name, style, _, _, _, _, _) ->
9462 (match fst style with
9463 | RErr -> pr "void ";
9464 | RInt _ -> pr "jint ";
9465 | RInt64 _ -> pr "jlong ";
9466 | RBool _ -> pr "jboolean ";
9467 | RConstString _ | RConstOptString _ | RString _
9468 | RBufferOut _ -> pr "jstring ";
9469 | RStruct _ | RHashtable _ ->
9471 | RStringList _ | RStructList _ ->
9475 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9476 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9478 pr " (JNIEnv *env, jobject obj, jlong jg";
9482 | Device n | Dev_or_Path n
9487 pr ", jstring j%s" n
9488 | StringList n | DeviceList n ->
9489 pr ", jobjectArray j%s" n
9491 pr ", jboolean j%s" n
9499 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9500 let error_code, no_ret =
9501 match fst style with
9502 | RErr -> pr " int r;\n"; "-1", ""
9504 | RInt _ -> pr " int r;\n"; "-1", "0"
9505 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9506 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9507 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9509 pr " jstring jr;\n";
9510 pr " char *r;\n"; "NULL", "NULL"
9512 pr " jobjectArray jr;\n";
9515 pr " jstring jstr;\n";
9516 pr " char **r;\n"; "NULL", "NULL"
9517 | RStruct (_, typ) ->
9518 pr " jobject jr;\n";
9520 pr " jfieldID fl;\n";
9521 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9522 | RStructList (_, typ) ->
9523 pr " jobjectArray jr;\n";
9525 pr " jfieldID fl;\n";
9526 pr " jobject jfl;\n";
9527 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9528 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9530 pr " jstring jr;\n";
9532 pr " size_t size;\n";
9537 | Device n | Dev_or_Path n
9542 pr " const char *%s;\n" n
9543 | StringList n | DeviceList n ->
9544 pr " int %s_len;\n" n;
9545 pr " const char **%s;\n" n
9550 pr " int64_t %s;\n" n
9554 (match fst style with
9555 | RStringList _ | RStructList _ -> true
9556 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9558 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9559 List.exists (function
9560 | StringList _ -> true
9561 | DeviceList _ -> true
9562 | _ -> false) (snd style) in
9568 (* Get the parameters. *)
9572 | Device n | Dev_or_Path n
9576 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9578 (* This is completely undocumented, but Java null becomes
9581 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9582 | StringList n | DeviceList n ->
9583 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9584 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9585 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9586 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9588 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9590 pr " %s[%s_len] = NULL;\n" n n;
9594 pr " %s = j%s;\n" n n
9597 (* Make the call. *)
9598 pr " r = guestfs_%s " name;
9599 generate_c_call_args ~handle:"g" style;
9602 (* Release the parameters. *)
9606 | Device n | Dev_or_Path n
9610 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9613 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9614 | StringList n | DeviceList n ->
9615 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9616 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9618 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
9620 pr " free (%s);\n" n
9626 (* Check for errors. *)
9627 pr " if (r == %s) {\n" error_code;
9628 pr " throw_exception (env, guestfs_last_error (g));\n";
9629 pr " return %s;\n" no_ret;
9633 (match fst style with
9635 | RInt _ -> pr " return (jint) r;\n"
9636 | RBool _ -> pr " return (jboolean) r;\n"
9637 | RInt64 _ -> pr " return (jlong) r;\n"
9638 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
9639 | RConstOptString _ ->
9640 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
9642 pr " jr = (*env)->NewStringUTF (env, r);\n";
9646 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
9647 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
9648 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
9649 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
9650 pr " for (i = 0; i < r_len; ++i) {\n";
9651 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
9652 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
9653 pr " free (r[i]);\n";
9657 | RStruct (_, typ) ->
9658 let jtyp = java_name_of_struct typ in
9659 let cols = cols_of_struct typ in
9660 generate_java_struct_return typ jtyp cols
9661 | RStructList (_, typ) ->
9662 let jtyp = java_name_of_struct typ in
9663 let cols = cols_of_struct typ in
9664 generate_java_struct_list_return typ jtyp cols
9667 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
9668 pr " return NULL;\n"
9670 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
9679 and generate_java_struct_return typ jtyp cols =
9680 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9681 pr " jr = (*env)->AllocObject (env, cl);\n";
9685 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9686 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
9689 pr " char s[33];\n";
9690 pr " memcpy (s, r->%s, 32);\n" name;
9692 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9693 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9697 pr " int len = r->%s_len;\n" name;
9698 pr " char s[len+1];\n";
9699 pr " memcpy (s, r->%s, len);\n" name;
9700 pr " s[len] = 0;\n";
9701 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9702 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9704 | name, (FBytes|FUInt64|FInt64) ->
9705 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9706 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9707 | name, (FUInt32|FInt32) ->
9708 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9709 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9710 | name, FOptPercent ->
9711 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9712 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
9714 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9715 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9720 and generate_java_struct_list_return typ jtyp cols =
9721 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9722 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
9723 pr " for (i = 0; i < r->len; ++i) {\n";
9724 pr " jfl = (*env)->AllocObject (env, cl);\n";
9728 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9729 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
9732 pr " char s[33];\n";
9733 pr " memcpy (s, r->val[i].%s, 32);\n" name;
9735 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9736 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9740 pr " int len = r->val[i].%s_len;\n" name;
9741 pr " char s[len+1];\n";
9742 pr " memcpy (s, r->val[i].%s, len);\n" name;
9743 pr " s[len] = 0;\n";
9744 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9745 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9747 | name, (FBytes|FUInt64|FInt64) ->
9748 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9749 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9750 | name, (FUInt32|FInt32) ->
9751 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9752 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9753 | name, FOptPercent ->
9754 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9755 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
9757 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9758 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9760 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
9762 pr " guestfs_free_%s_list (r);\n" typ;
9765 and generate_java_makefile_inc () =
9766 generate_header HashStyle GPLv2plus;
9768 pr "java_built_sources = \\\n";
9771 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
9773 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
9775 and generate_haskell_hs () =
9776 generate_header HaskellStyle LGPLv2plus;
9778 (* XXX We only know how to generate partial FFI for Haskell
9779 * at the moment. Please help out!
9781 let can_generate style =
9785 | RInt64 _, _ -> true
9788 | RConstOptString _, _
9794 | RBufferOut _, _ -> false in
9797 {-# INCLUDE <guestfs.h> #-}
9798 {-# LANGUAGE ForeignFunctionInterface #-}
9803 (* List out the names of the actions we want to export. *)
9805 fun (name, style, _, _, _, _, _) ->
9806 if can_generate style then pr ",\n %s" name
9812 -- Unfortunately some symbols duplicate ones already present
9813 -- in Prelude. We don't know which, so we hard-code a list
9815 import Prelude hiding (truncate)
9819 import Foreign.C.Types
9821 import Control.Exception
9822 import Data.Typeable
9824 data GuestfsS = GuestfsS -- represents the opaque C struct
9825 type GuestfsP = Ptr GuestfsS -- guestfs_h *
9826 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
9828 -- XXX define properly later XXX
9832 data IntBool = IntBool
9834 data StatVFS = StatVFS
9835 data Hashtable = Hashtable
9837 foreign import ccall unsafe \"guestfs_create\" c_create
9839 foreign import ccall unsafe \"&guestfs_close\" c_close
9840 :: FunPtr (GuestfsP -> IO ())
9841 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
9842 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
9844 create :: IO GuestfsH
9847 c_set_error_handler p nullPtr nullPtr
9848 h <- newForeignPtr c_close p
9851 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
9852 :: GuestfsP -> IO CString
9854 -- last_error :: GuestfsH -> IO (Maybe String)
9855 -- last_error h = do
9856 -- str <- withForeignPtr h (\\p -> c_last_error p)
9857 -- maybePeek peekCString str
9859 last_error :: GuestfsH -> IO (String)
9861 str <- withForeignPtr h (\\p -> c_last_error p)
9863 then return \"no error\"
9864 else peekCString str
9868 (* Generate wrappers for each foreign function. *)
9870 fun (name, style, _, _, _, _, _) ->
9871 if can_generate style then (
9872 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
9874 generate_haskell_prototype ~handle:"GuestfsP" style;
9878 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
9880 pr "%s %s = do\n" name
9881 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
9883 (* Convert pointer arguments using with* functions. *)
9888 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
9889 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
9890 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
9891 | Bool _ | Int _ | Int64 _ -> ()
9893 (* Convert integer arguments. *)
9897 | Bool n -> sprintf "(fromBool %s)" n
9898 | Int n -> sprintf "(fromIntegral %s)" n
9899 | Int64 n -> sprintf "(fromIntegral %s)" n
9900 | FileIn n | FileOut n
9901 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
9903 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
9904 (String.concat " " ("p" :: args));
9905 (match fst style with
9906 | RErr | RInt _ | RInt64 _ | RBool _ ->
9907 pr " if (r == -1)\n";
9909 pr " err <- last_error h\n";
9911 | RConstString _ | RConstOptString _ | RString _
9912 | RStringList _ | RStruct _
9913 | RStructList _ | RHashtable _ | RBufferOut _ ->
9914 pr " if (r == nullPtr)\n";
9916 pr " err <- last_error h\n";
9919 (match fst style with
9921 pr " else return ()\n"
9923 pr " else return (fromIntegral r)\n"
9925 pr " else return (fromIntegral r)\n"
9927 pr " else return (toBool r)\n"
9936 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
9942 and generate_haskell_prototype ~handle ?(hs = false) style =
9944 let string = if hs then "String" else "CString" in
9945 let int = if hs then "Int" else "CInt" in
9946 let bool = if hs then "Bool" else "CInt" in
9947 let int64 = if hs then "Integer" else "Int64" in
9951 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
9952 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
9953 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
9954 | Bool _ -> pr "%s" bool
9955 | Int _ -> pr "%s" int
9956 | Int64 _ -> pr "%s" int
9957 | FileIn _ -> pr "%s" string
9958 | FileOut _ -> pr "%s" string
9963 (match fst style with
9964 | RErr -> if not hs then pr "CInt"
9965 | RInt _ -> pr "%s" int
9966 | RInt64 _ -> pr "%s" int64
9967 | RBool _ -> pr "%s" bool
9968 | RConstString _ -> pr "%s" string
9969 | RConstOptString _ -> pr "Maybe %s" string
9970 | RString _ -> pr "%s" string
9971 | RStringList _ -> pr "[%s]" string
9972 | RStruct (_, typ) ->
9973 let name = java_name_of_struct typ in
9975 | RStructList (_, typ) ->
9976 let name = java_name_of_struct typ in
9978 | RHashtable _ -> pr "Hashtable"
9979 | RBufferOut _ -> pr "%s" string
9983 and generate_csharp () =
9984 generate_header CPlusPlusStyle LGPLv2plus;
9986 (* XXX Make this configurable by the C# assembly users. *)
9987 let library = "libguestfs.so.0" in
9990 // These C# bindings are highly experimental at present.
9992 // Firstly they only work on Linux (ie. Mono). In order to get them
9993 // to work on Windows (ie. .Net) you would need to port the library
9994 // itself to Windows first.
9996 // The second issue is that some calls are known to be incorrect and
9997 // can cause Mono to segfault. Particularly: calls which pass or
9998 // return string[], or return any structure value. This is because
9999 // we haven't worked out the correct way to do this from C#.
10001 // The third issue is that when compiling you get a lot of warnings.
10002 // We are not sure whether the warnings are important or not.
10004 // Fourthly we do not routinely build or test these bindings as part
10005 // of the make && make check cycle, which means that regressions might
10008 // Suggestions and patches are welcome.
10012 // gmcs Libguestfs.cs
10013 // mono Libguestfs.exe
10015 // (You'll probably want to add a Test class / static main function
10016 // otherwise this won't do anything useful).
10020 using System.Runtime.InteropServices;
10021 using System.Runtime.Serialization;
10022 using System.Collections;
10026 class Error : System.ApplicationException
10028 public Error (string message) : base (message) {}
10029 protected Error (SerializationInfo info, StreamingContext context) {}
10036 [DllImport (\"%s\")]
10037 static extern IntPtr guestfs_create ();
10041 _handle = guestfs_create ();
10042 if (_handle == IntPtr.Zero)
10043 throw new Error (\"could not create guestfs handle\");
10046 [DllImport (\"%s\")]
10047 static extern void guestfs_close (IntPtr h);
10051 guestfs_close (_handle);
10054 [DllImport (\"%s\")]
10055 static extern string guestfs_last_error (IntPtr h);
10057 " library library library;
10059 (* Generate C# structure bindings. We prefix struct names with
10060 * underscore because C# cannot have conflicting struct names and
10061 * method names (eg. "class stat" and "stat").
10065 pr " [StructLayout (LayoutKind.Sequential)]\n";
10066 pr " public class _%s {\n" typ;
10069 | name, FChar -> pr " char %s;\n" name
10070 | name, FString -> pr " string %s;\n" name
10072 pr " uint %s_len;\n" name;
10073 pr " string %s;\n" name
10075 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10076 pr " string %s;\n" name
10077 | name, FUInt32 -> pr " uint %s;\n" name
10078 | name, FInt32 -> pr " int %s;\n" name
10079 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10080 | name, FInt64 -> pr " long %s;\n" name
10081 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10087 (* Generate C# function bindings. *)
10089 fun (name, style, _, _, _, shortdesc, _) ->
10090 let rec csharp_return_type () =
10091 match fst style with
10093 | RBool n -> "bool"
10095 | RInt64 n -> "long"
10097 | RConstOptString n
10099 | RBufferOut n -> "string"
10100 | RStruct (_,n) -> "_" ^ n
10101 | RHashtable n -> "Hashtable"
10102 | RStringList n -> "string[]"
10103 | RStructList (_,n) -> sprintf "_%s[]" n
10105 and c_return_type () =
10106 match fst style with
10110 | RInt64 _ -> "long"
10112 | RConstOptString _
10114 | RBufferOut _ -> "string"
10115 | RStruct (_,n) -> "_" ^ n
10117 | RStringList _ -> "string[]"
10118 | RStructList (_,n) -> sprintf "_%s[]" n
10120 and c_error_comparison () =
10121 match fst style with
10125 | RInt64 _ -> "== -1"
10127 | RConstOptString _
10133 | RStructList (_,_) -> "== null"
10135 and generate_extern_prototype () =
10136 pr " static extern %s guestfs_%s (IntPtr h"
10137 (c_return_type ()) name;
10140 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10141 | FileIn n | FileOut n ->
10142 pr ", [In] string %s" n
10143 | StringList n | DeviceList n ->
10144 pr ", [In] string[] %s" n
10154 and generate_public_prototype () =
10155 pr " public %s %s (" (csharp_return_type ()) name;
10156 let comma = ref false in
10158 if !comma then pr ", ";
10163 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10164 | FileIn n | FileOut n ->
10165 next (); pr "string %s" n
10166 | StringList n | DeviceList n ->
10167 next (); pr "string[] %s" n
10169 next (); pr "bool %s" n
10171 next (); pr "int %s" n
10173 next (); pr "long %s" n
10177 and generate_call () =
10178 pr "guestfs_%s (_handle" name;
10179 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10183 pr " [DllImport (\"%s\")]\n" library;
10184 generate_extern_prototype ();
10186 pr " /// <summary>\n";
10187 pr " /// %s\n" shortdesc;
10188 pr " /// </summary>\n";
10189 generate_public_prototype ();
10191 pr " %s r;\n" (c_return_type ());
10194 pr " if (r %s)\n" (c_error_comparison ());
10195 pr " throw new Error (\"%s: \" + guestfs_last_error (_handle));\n"
10197 (match fst style with
10200 pr " return r != 0 ? true : false;\n"
10202 pr " Hashtable rr = new Hashtable ();\n";
10203 pr " for (int i = 0; i < r.Length; i += 2)\n";
10204 pr " rr.Add (r[i], r[i+1]);\n";
10206 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10207 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10213 ) all_functions_sorted;
10219 and generate_bindtests () =
10220 generate_header CStyle LGPLv2plus;
10224 #include <stdlib.h>
10225 #include <inttypes.h>
10226 #include <string.h>
10228 #include \"guestfs.h\"
10229 #include \"guestfs-internal.h\"
10230 #include \"guestfs-internal-actions.h\"
10231 #include \"guestfs_protocol.h\"
10233 #define error guestfs_error
10234 #define safe_calloc guestfs_safe_calloc
10235 #define safe_malloc guestfs_safe_malloc
10238 print_strings (char *const *argv)
10243 for (argc = 0; argv[argc] != NULL; ++argc) {
10244 if (argc > 0) printf (\", \");
10245 printf (\"\\\"%%s\\\"\", argv[argc]);
10250 /* The test0 function prints its parameters to stdout. */
10254 match test_functions with
10255 | [] -> assert false
10256 | test0 :: tests -> test0, tests in
10259 let (name, style, _, _, _, _, _) = test0 in
10260 generate_prototype ~extern:false ~semicolon:false ~newline:true
10261 ~handle:"g" ~prefix:"guestfs__" name style;
10266 | Device n | Dev_or_Path n
10269 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10270 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10271 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10272 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10273 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10274 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10276 pr " /* Java changes stdout line buffering so we need this: */\n";
10277 pr " fflush (stdout);\n";
10283 fun (name, style, _, _, _, _, _) ->
10284 if String.sub name (String.length name - 3) 3 <> "err" then (
10285 pr "/* Test normal return. */\n";
10286 generate_prototype ~extern:false ~semicolon:false ~newline:true
10287 ~handle:"g" ~prefix:"guestfs__" name style;
10289 (match fst style with
10294 pr " sscanf (val, \"%%d\", &r);\n";
10297 pr " int64_t r;\n";
10298 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10301 pr " return STREQ (val, \"true\");\n"
10303 | RConstOptString _ ->
10304 (* Can't return the input string here. Return a static
10305 * string so we ensure we get a segfault if the caller
10306 * tries to free it.
10308 pr " return \"static string\";\n"
10310 pr " return strdup (val);\n"
10312 pr " char **strs;\n";
10314 pr " sscanf (val, \"%%d\", &n);\n";
10315 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10316 pr " for (i = 0; i < n; ++i) {\n";
10317 pr " strs[i] = safe_malloc (g, 16);\n";
10318 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10320 pr " strs[n] = NULL;\n";
10321 pr " return strs;\n"
10322 | RStruct (_, typ) ->
10323 pr " struct guestfs_%s *r;\n" typ;
10324 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10326 | RStructList (_, typ) ->
10327 pr " struct guestfs_%s_list *r;\n" typ;
10328 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10329 pr " sscanf (val, \"%%d\", &r->len);\n";
10330 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10333 pr " char **strs;\n";
10335 pr " sscanf (val, \"%%d\", &n);\n";
10336 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10337 pr " for (i = 0; i < n; ++i) {\n";
10338 pr " strs[i*2] = safe_malloc (g, 16);\n";
10339 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10340 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10341 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10343 pr " strs[n*2] = NULL;\n";
10344 pr " return strs;\n"
10346 pr " return strdup (val);\n"
10351 pr "/* Test error return. */\n";
10352 generate_prototype ~extern:false ~semicolon:false ~newline:true
10353 ~handle:"g" ~prefix:"guestfs__" name style;
10355 pr " error (g, \"error\");\n";
10356 (match fst style with
10357 | RErr | RInt _ | RInt64 _ | RBool _ ->
10359 | RConstString _ | RConstOptString _
10360 | RString _ | RStringList _ | RStruct _
10364 pr " return NULL;\n"
10371 and generate_ocaml_bindtests () =
10372 generate_header OCamlStyle GPLv2plus;
10376 let g = Guestfs.create () in
10380 String.concat " " (
10383 | CallString s -> "\"" ^ s ^ "\""
10384 | CallOptString None -> "None"
10385 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10386 | CallStringList xs ->
10387 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10388 | CallInt i when i >= 0 -> string_of_int i
10389 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10390 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10391 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10392 | CallBool b -> string_of_bool b
10397 generate_lang_bindtests (
10398 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10401 pr "print_endline \"EOF\"\n"
10403 and generate_perl_bindtests () =
10404 pr "#!/usr/bin/perl -w\n";
10405 generate_header HashStyle GPLv2plus;
10412 my $g = Sys::Guestfs->new ();
10416 String.concat ", " (
10419 | CallString s -> "\"" ^ s ^ "\""
10420 | CallOptString None -> "undef"
10421 | CallOptString (Some s) -> sprintf "\"%s\"" s
10422 | CallStringList xs ->
10423 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10424 | CallInt i -> string_of_int i
10425 | CallInt64 i -> Int64.to_string i
10426 | CallBool b -> if b then "1" else "0"
10431 generate_lang_bindtests (
10432 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10435 pr "print \"EOF\\n\"\n"
10437 and generate_python_bindtests () =
10438 generate_header HashStyle GPLv2plus;
10443 g = guestfs.GuestFS ()
10447 String.concat ", " (
10450 | CallString s -> "\"" ^ s ^ "\""
10451 | CallOptString None -> "None"
10452 | CallOptString (Some s) -> sprintf "\"%s\"" s
10453 | CallStringList xs ->
10454 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10455 | CallInt i -> string_of_int i
10456 | CallInt64 i -> Int64.to_string i
10457 | CallBool b -> if b then "1" else "0"
10462 generate_lang_bindtests (
10463 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10466 pr "print \"EOF\"\n"
10468 and generate_ruby_bindtests () =
10469 generate_header HashStyle GPLv2plus;
10474 g = Guestfs::create()
10478 String.concat ", " (
10481 | CallString s -> "\"" ^ s ^ "\""
10482 | CallOptString None -> "nil"
10483 | CallOptString (Some s) -> sprintf "\"%s\"" s
10484 | CallStringList xs ->
10485 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10486 | CallInt i -> string_of_int i
10487 | CallInt64 i -> Int64.to_string i
10488 | CallBool b -> string_of_bool b
10493 generate_lang_bindtests (
10494 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10497 pr "print \"EOF\\n\"\n"
10499 and generate_java_bindtests () =
10500 generate_header CStyle GPLv2plus;
10503 import com.redhat.et.libguestfs.*;
10505 public class Bindtests {
10506 public static void main (String[] argv)
10509 GuestFS g = new GuestFS ();
10513 String.concat ", " (
10516 | CallString s -> "\"" ^ s ^ "\""
10517 | CallOptString None -> "null"
10518 | CallOptString (Some s) -> sprintf "\"%s\"" s
10519 | CallStringList xs ->
10521 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10522 | CallInt i -> string_of_int i
10523 | CallInt64 i -> Int64.to_string i
10524 | CallBool b -> string_of_bool b
10529 generate_lang_bindtests (
10530 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10534 System.out.println (\"EOF\");
10536 catch (Exception exn) {
10537 System.err.println (exn);
10544 and generate_haskell_bindtests () =
10545 generate_header HaskellStyle GPLv2plus;
10548 module Bindtests where
10549 import qualified Guestfs
10552 g <- Guestfs.create
10556 String.concat " " (
10559 | CallString s -> "\"" ^ s ^ "\""
10560 | CallOptString None -> "Nothing"
10561 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10562 | CallStringList xs ->
10563 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10564 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10565 | CallInt i -> string_of_int i
10566 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10567 | CallInt64 i -> Int64.to_string i
10568 | CallBool true -> "True"
10569 | CallBool false -> "False"
10574 generate_lang_bindtests (
10575 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10578 pr " putStrLn \"EOF\"\n"
10580 (* Language-independent bindings tests - we do it this way to
10581 * ensure there is parity in testing bindings across all languages.
10583 and generate_lang_bindtests call =
10584 call "test0" [CallString "abc"; CallOptString (Some "def");
10585 CallStringList []; CallBool false;
10586 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10587 call "test0" [CallString "abc"; CallOptString None;
10588 CallStringList []; CallBool false;
10589 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10590 call "test0" [CallString ""; CallOptString (Some "def");
10591 CallStringList []; CallBool false;
10592 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10593 call "test0" [CallString ""; CallOptString (Some "");
10594 CallStringList []; CallBool false;
10595 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10596 call "test0" [CallString "abc"; CallOptString (Some "def");
10597 CallStringList ["1"]; CallBool false;
10598 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10599 call "test0" [CallString "abc"; CallOptString (Some "def");
10600 CallStringList ["1"; "2"]; CallBool false;
10601 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10602 call "test0" [CallString "abc"; CallOptString (Some "def");
10603 CallStringList ["1"]; CallBool true;
10604 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10605 call "test0" [CallString "abc"; CallOptString (Some "def");
10606 CallStringList ["1"]; CallBool false;
10607 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
10608 call "test0" [CallString "abc"; CallOptString (Some "def");
10609 CallStringList ["1"]; CallBool false;
10610 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
10611 call "test0" [CallString "abc"; CallOptString (Some "def");
10612 CallStringList ["1"]; CallBool false;
10613 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
10614 call "test0" [CallString "abc"; CallOptString (Some "def");
10615 CallStringList ["1"]; CallBool false;
10616 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
10617 call "test0" [CallString "abc"; CallOptString (Some "def");
10618 CallStringList ["1"]; CallBool false;
10619 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
10620 call "test0" [CallString "abc"; CallOptString (Some "def");
10621 CallStringList ["1"]; CallBool false;
10622 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
10624 (* XXX Add here tests of the return and error functions. *)
10626 (* Code to generator bindings for virt-inspector. Currently only
10627 * implemented for OCaml code (for virt-p2v 2.0).
10629 let rng_input = "inspector/virt-inspector.rng"
10631 (* Read the input file and parse it into internal structures. This is
10632 * by no means a complete RELAX NG parser, but is just enough to be
10633 * able to parse the specific input file.
10636 | Element of string * rng list (* <element name=name/> *)
10637 | Attribute of string * rng list (* <attribute name=name/> *)
10638 | Interleave of rng list (* <interleave/> *)
10639 | ZeroOrMore of rng (* <zeroOrMore/> *)
10640 | OneOrMore of rng (* <oneOrMore/> *)
10641 | Optional of rng (* <optional/> *)
10642 | Choice of string list (* <choice><value/>*</choice> *)
10643 | Value of string (* <value>str</value> *)
10644 | Text (* <text/> *)
10646 let rec string_of_rng = function
10647 | Element (name, xs) ->
10648 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10649 | Attribute (name, xs) ->
10650 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10651 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
10652 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
10653 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
10654 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
10655 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
10656 | Value value -> "Value \"" ^ value ^ "\""
10659 and string_of_rng_list xs =
10660 String.concat ", " (List.map string_of_rng xs)
10662 let rec parse_rng ?defines context = function
10664 | Xml.Element ("element", ["name", name], children) :: rest ->
10665 Element (name, parse_rng ?defines context children)
10666 :: parse_rng ?defines context rest
10667 | Xml.Element ("attribute", ["name", name], children) :: rest ->
10668 Attribute (name, parse_rng ?defines context children)
10669 :: parse_rng ?defines context rest
10670 | Xml.Element ("interleave", [], children) :: rest ->
10671 Interleave (parse_rng ?defines context children)
10672 :: parse_rng ?defines context rest
10673 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
10674 let rng = parse_rng ?defines context [child] in
10676 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
10678 failwithf "%s: <zeroOrMore> contains more than one child element"
10681 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
10682 let rng = parse_rng ?defines context [child] in
10684 | [child] -> OneOrMore child :: parse_rng ?defines context rest
10686 failwithf "%s: <oneOrMore> contains more than one child element"
10689 | Xml.Element ("optional", [], [child]) :: rest ->
10690 let rng = parse_rng ?defines context [child] in
10692 | [child] -> Optional child :: parse_rng ?defines context rest
10694 failwithf "%s: <optional> contains more than one child element"
10697 | Xml.Element ("choice", [], children) :: rest ->
10698 let values = List.map (
10699 function Xml.Element ("value", [], [Xml.PCData value]) -> value
10701 failwithf "%s: can't handle anything except <value> in <choice>"
10705 :: parse_rng ?defines context rest
10706 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
10707 Value value :: parse_rng ?defines context rest
10708 | Xml.Element ("text", [], []) :: rest ->
10709 Text :: parse_rng ?defines context rest
10710 | Xml.Element ("ref", ["name", name], []) :: rest ->
10711 (* Look up the reference. Because of limitations in this parser,
10712 * we can't handle arbitrarily nested <ref> yet. You can only
10713 * use <ref> from inside <start>.
10715 (match defines with
10717 failwithf "%s: contains <ref>, but no refs are defined yet" context
10719 let rng = StringMap.find name map in
10720 rng @ parse_rng ?defines context rest
10723 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
10726 let xml = Xml.parse_file rng_input in
10728 | Xml.Element ("grammar", _,
10729 Xml.Element ("start", _, gram) :: defines) ->
10730 (* The <define/> elements are referenced in the <start> section,
10731 * so build a map of those first.
10733 let defines = List.fold_left (
10735 function Xml.Element ("define", ["name", name], defn) ->
10736 StringMap.add name defn map
10738 failwithf "%s: expected <define name=name/>" rng_input
10739 ) StringMap.empty defines in
10740 let defines = StringMap.mapi parse_rng defines in
10742 (* Parse the <start> clause, passing the defines. *)
10743 parse_rng ~defines "<start>" gram
10745 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
10748 let name_of_field = function
10749 | Element (name, _) | Attribute (name, _)
10750 | ZeroOrMore (Element (name, _))
10751 | OneOrMore (Element (name, _))
10752 | Optional (Element (name, _)) -> name
10753 | Optional (Attribute (name, _)) -> name
10754 | Text -> (* an unnamed field in an element *)
10757 failwithf "name_of_field failed at: %s" (string_of_rng rng)
10759 (* At the moment this function only generates OCaml types. However we
10760 * should parameterize it later so it can generate types/structs in a
10761 * variety of languages.
10763 let generate_types xs =
10764 (* A simple type is one that can be printed out directly, eg.
10765 * "string option". A complex type is one which has a name and has
10766 * to be defined via another toplevel definition, eg. a struct.
10768 * generate_type generates code for either simple or complex types.
10769 * In the simple case, it returns the string ("string option"). In
10770 * the complex case, it returns the name ("mountpoint"). In the
10771 * complex case it has to print out the definition before returning,
10772 * so it should only be called when we are at the beginning of a
10773 * new line (BOL context).
10775 let rec generate_type = function
10776 | Text -> (* string *)
10778 | Choice values -> (* [`val1|`val2|...] *)
10779 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
10780 | ZeroOrMore rng -> (* <rng> list *)
10781 let t, is_simple = generate_type rng in
10782 t ^ " list (* 0 or more *)", is_simple
10783 | OneOrMore rng -> (* <rng> list *)
10784 let t, is_simple = generate_type rng in
10785 t ^ " list (* 1 or more *)", is_simple
10786 (* virt-inspector hack: bool *)
10787 | Optional (Attribute (name, [Value "1"])) ->
10789 | Optional rng -> (* <rng> list *)
10790 let t, is_simple = generate_type rng in
10791 t ^ " option", is_simple
10792 (* type name = { fields ... } *)
10793 | Element (name, fields) when is_attrs_interleave fields ->
10794 generate_type_struct name (get_attrs_interleave fields)
10795 | Element (name, [field]) (* type name = field *)
10796 | Attribute (name, [field]) ->
10797 let t, is_simple = generate_type field in
10798 if is_simple then (t, true)
10800 pr "type %s = %s\n" name t;
10803 | Element (name, fields) -> (* type name = { fields ... } *)
10804 generate_type_struct name fields
10806 failwithf "generate_type failed at: %s" (string_of_rng rng)
10808 and is_attrs_interleave = function
10809 | [Interleave _] -> true
10810 | Attribute _ :: fields -> is_attrs_interleave fields
10811 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
10814 and get_attrs_interleave = function
10815 | [Interleave fields] -> fields
10816 | ((Attribute _) as field) :: fields
10817 | ((Optional (Attribute _)) as field) :: fields ->
10818 field :: get_attrs_interleave fields
10819 | _ -> assert false
10821 and generate_types xs =
10822 List.iter (fun x -> ignore (generate_type x)) xs
10824 and generate_type_struct name fields =
10825 (* Calculate the types of the fields first. We have to do this
10826 * before printing anything so we are still in BOL context.
10828 let types = List.map fst (List.map generate_type fields) in
10830 (* Special case of a struct containing just a string and another
10831 * field. Turn it into an assoc list.
10834 | ["string"; other] ->
10835 let fname1, fname2 =
10837 | [f1; f2] -> name_of_field f1, name_of_field f2
10838 | _ -> assert false in
10839 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
10843 pr "type %s = {\n" name;
10845 fun (field, ftype) ->
10846 let fname = name_of_field field in
10847 pr " %s_%s : %s;\n" name fname ftype
10848 ) (List.combine fields types);
10850 (* Return the name of this type, and
10851 * false because it's not a simple type.
10858 let generate_parsers xs =
10859 (* As for generate_type above, generate_parser makes a parser for
10860 * some type, and returns the name of the parser it has generated.
10861 * Because it (may) need to print something, it should always be
10862 * called in BOL context.
10864 let rec generate_parser = function
10865 | Text -> (* string *)
10866 "string_child_or_empty"
10867 | Choice values -> (* [`val1|`val2|...] *)
10868 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
10870 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
10871 | ZeroOrMore rng -> (* <rng> list *)
10872 let pa = generate_parser rng in
10873 sprintf "(fun x -> List.map %s (Xml.children x))" pa
10874 | OneOrMore rng -> (* <rng> list *)
10875 let pa = generate_parser rng in
10876 sprintf "(fun x -> List.map %s (Xml.children x))" pa
10877 (* virt-inspector hack: bool *)
10878 | Optional (Attribute (name, [Value "1"])) ->
10879 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
10880 | Optional rng -> (* <rng> list *)
10881 let pa = generate_parser rng in
10882 sprintf "(function None -> None | Some x -> Some (%s x))" pa
10883 (* type name = { fields ... } *)
10884 | Element (name, fields) when is_attrs_interleave fields ->
10885 generate_parser_struct name (get_attrs_interleave fields)
10886 | Element (name, [field]) -> (* type name = field *)
10887 let pa = generate_parser field in
10888 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
10889 pr "let %s =\n" parser_name;
10891 pr "let parse_%s = %s\n" name parser_name;
10893 | Attribute (name, [field]) ->
10894 let pa = generate_parser field in
10895 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
10896 pr "let %s =\n" parser_name;
10898 pr "let parse_%s = %s\n" name parser_name;
10900 | Element (name, fields) -> (* type name = { fields ... } *)
10901 generate_parser_struct name ([], fields)
10903 failwithf "generate_parser failed at: %s" (string_of_rng rng)
10905 and is_attrs_interleave = function
10906 | [Interleave _] -> true
10907 | Attribute _ :: fields -> is_attrs_interleave fields
10908 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
10911 and get_attrs_interleave = function
10912 | [Interleave fields] -> [], fields
10913 | ((Attribute _) as field) :: fields
10914 | ((Optional (Attribute _)) as field) :: fields ->
10915 let attrs, interleaves = get_attrs_interleave fields in
10916 (field :: attrs), interleaves
10917 | _ -> assert false
10919 and generate_parsers xs =
10920 List.iter (fun x -> ignore (generate_parser x)) xs
10922 and generate_parser_struct name (attrs, interleaves) =
10923 (* Generate parsers for the fields first. We have to do this
10924 * before printing anything so we are still in BOL context.
10926 let fields = attrs @ interleaves in
10927 let pas = List.map generate_parser fields in
10929 (* Generate an intermediate tuple from all the fields first.
10930 * If the type is just a string + another field, then we will
10931 * return this directly, otherwise it is turned into a record.
10933 * RELAX NG note: This code treats <interleave> and plain lists of
10934 * fields the same. In other words, it doesn't bother enforcing
10935 * any ordering of fields in the XML.
10937 pr "let parse_%s x =\n" name;
10938 pr " let t = (\n ";
10939 let comma = ref false in
10942 if !comma then pr ",\n ";
10945 | Optional (Attribute (fname, [field])), pa ->
10947 | Optional (Element (fname, [field])), pa ->
10948 pr "%s (optional_child %S x)" pa fname
10949 | Attribute (fname, [Text]), _ ->
10950 pr "attribute %S x" fname
10951 | (ZeroOrMore _ | OneOrMore _), pa ->
10956 let fname = name_of_field field in
10957 pr "%s (child %S x)" pa fname
10958 ) (List.combine fields pas);
10962 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
10966 pr " (Obj.magic t : %s)\n" name
10970 | (Optional (Attribute (fname, [field])), pa) ->
10971 pr " %s_%s =\n" name fname;
10973 | (Optional (Element (fname, [field])), pa) ->
10974 pr " %s_%s =\n" name fname;
10975 pr " (let x = optional_child %S x in\n" fname;
10978 let fname = name_of_field field in
10979 pr " %s_%s =\n" name fname;
10980 pr " (let x = child %S x in\n" fname;
10982 ) (List.combine fields pas);
10986 sprintf "parse_%s" name
10989 generate_parsers xs
10991 (* Generate ocaml/guestfs_inspector.mli. *)
10992 let generate_ocaml_inspector_mli () =
10993 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
10996 (** This is an OCaml language binding to the external [virt-inspector]
10999 For more information, please read the man page [virt-inspector(1)].
11004 generate_types grammar;
11005 pr "(** The nested information returned from the {!inspect} function. *)\n";
11009 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11010 (** To inspect a libvirt domain called [name], pass a singleton
11011 list: [inspect [name]]. When using libvirt only, you may
11012 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11014 To inspect a disk image or images, pass a list of the filenames
11015 of the disk images: [inspect filenames]
11017 This function inspects the given guest or disk images and
11018 returns a list of operating system(s) found and a large amount
11019 of information about them. In the vast majority of cases,
11020 a virtual machine only contains a single operating system.
11022 If the optional [~xml] parameter is given, then this function
11023 skips running the external virt-inspector program and just
11024 parses the given XML directly (which is expected to be XML
11025 produced from a previous run of virt-inspector). The list of
11026 names and connect URI are ignored in this case.
11028 This function can throw a wide variety of exceptions, for example
11029 if the external virt-inspector program cannot be found, or if
11030 it doesn't generate valid XML.
11034 (* Generate ocaml/guestfs_inspector.ml. *)
11035 let generate_ocaml_inspector_ml () =
11036 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11041 generate_types grammar;
11045 (* Misc functions which are used by the parser code below. *)
11046 let first_child = function
11047 | Xml.Element (_, _, c::_) -> c
11048 | Xml.Element (name, _, []) ->
11049 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11050 | Xml.PCData str ->
11051 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11053 let string_child_or_empty = function
11054 | Xml.Element (_, _, [Xml.PCData s]) -> s
11055 | Xml.Element (_, _, []) -> \"\"
11056 | Xml.Element (x, _, _) ->
11057 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11059 | Xml.PCData str ->
11060 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11062 let optional_child name xml =
11063 let children = Xml.children xml in
11065 Some (List.find (function
11066 | Xml.Element (n, _, _) when n = name -> true
11067 | _ -> false) children)
11071 let child name xml =
11072 match optional_child name xml with
11075 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11077 let attribute name xml =
11078 try Xml.attrib xml name
11079 with Xml.No_attribute _ ->
11080 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11084 generate_parsers grammar;
11088 (* Run external virt-inspector, then use parser to parse the XML. *)
11089 let inspect ?connect ?xml names =
11093 if names = [] then invalid_arg \"inspect: no names given\";
11094 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11095 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11097 let cmd = List.map Filename.quote cmd in
11098 let cmd = String.concat \" \" cmd in
11099 let chan = open_process_in cmd in
11100 let xml = Xml.parse_in chan in
11101 (match close_process_in chan with
11103 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11104 | WSIGNALED i | WSTOPPED i ->
11105 failwith (\"external virt-inspector command died or stopped on sig \" ^
11110 Xml.parse_string doc in
11111 parse_operatingsystems xml
11114 (* This is used to generate the src/MAX_PROC_NR file which
11115 * contains the maximum procedure number, a surrogate for the
11116 * ABI version number. See src/Makefile.am for the details.
11118 and generate_max_proc_nr () =
11119 let proc_nrs = List.map (
11120 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11121 ) daemon_functions in
11123 let max_proc_nr = List.fold_left max 0 proc_nrs in
11125 pr "%d\n" max_proc_nr
11127 let output_to filename k =
11128 let filename_new = filename ^ ".new" in
11129 chan := open_out filename_new;
11132 chan := Pervasives.stdout;
11134 (* Is the new file different from the current file? *)
11135 if Sys.file_exists filename && files_equal filename filename_new then
11136 unlink filename_new (* same, so skip it *)
11138 (* different, overwrite old one *)
11139 (try chmod filename 0o644 with Unix_error _ -> ());
11140 rename filename_new filename;
11141 chmod filename 0o444;
11142 printf "written %s\n%!" filename;
11145 let perror msg = function
11146 | Unix_error (err, _, _) ->
11147 eprintf "%s: %s\n" msg (error_message err)
11149 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11151 (* Main program. *)
11154 try openfile "HACKING" [O_RDWR] 0
11156 | Unix_error (ENOENT, _, _) ->
11158 You are probably running this from the wrong directory.
11159 Run it from the top source directory using the command
11164 perror "open: HACKING" exn;
11167 (* Acquire a lock so parallel builds won't try to run the generator
11168 * twice at the same time. Subsequent builds will wait for the first
11169 * one to finish. Note the lock is released implicitly when the
11172 (try lockf lock_fd F_LOCK 1
11174 perror "lock: HACKING" exn;
11177 check_functions ();
11179 output_to "src/guestfs_protocol.x" generate_xdr;
11180 output_to "src/guestfs-structs.h" generate_structs_h;
11181 output_to "src/guestfs-actions.h" generate_actions_h;
11182 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11183 output_to "src/guestfs-actions.c" generate_client_actions;
11184 output_to "src/guestfs-bindtests.c" generate_bindtests;
11185 output_to "src/guestfs-structs.pod" generate_structs_pod;
11186 output_to "src/guestfs-actions.pod" generate_actions_pod;
11187 output_to "src/guestfs-availability.pod" generate_availability_pod;
11188 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11189 output_to "src/libguestfs.syms" generate_linker_script;
11190 output_to "daemon/actions.h" generate_daemon_actions_h;
11191 output_to "daemon/stubs.c" generate_daemon_actions;
11192 output_to "daemon/names.c" generate_daemon_names;
11193 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11194 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11195 output_to "capitests/tests.c" generate_tests;
11196 output_to "fish/cmds.c" generate_fish_cmds;
11197 output_to "fish/completion.c" generate_fish_completion;
11198 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11199 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11200 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11201 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11202 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11203 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11204 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11205 output_to "perl/Guestfs.xs" generate_perl_xs;
11206 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11207 output_to "perl/bindtests.pl" generate_perl_bindtests;
11208 output_to "python/guestfs-py.c" generate_python_c;
11209 output_to "python/guestfs.py" generate_python_py;
11210 output_to "python/bindtests.py" generate_python_bindtests;
11211 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11212 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11213 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11217 let cols = cols_of_struct typ in
11218 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11219 output_to filename (generate_java_struct jtyp cols);
11222 output_to "java/Makefile.inc" generate_java_makefile_inc;
11223 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11224 output_to "java/Bindtests.java" generate_java_bindtests;
11225 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11226 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11227 output_to "csharp/Libguestfs.cs" generate_csharp;
11229 (* Always generate this file last, and unconditionally. It's used
11230 * by the Makefile to know when we must re-run the generator.
11232 let chan = open_out "src/stamp-generator" in
11233 fprintf chan "1\n";
11236 printf "generated %d lines of code\n" !lines