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 name_of_argt = function
4581 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4582 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4583 | FileIn n | FileOut n -> n
4585 let java_name_of_struct typ =
4586 try List.assoc typ java_structs
4589 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4591 let cols_of_struct typ =
4592 try List.assoc typ structs
4594 failwithf "cols_of_struct: unknown struct %s" typ
4596 let seq_of_test = function
4597 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4598 | TestOutputListOfDevices (s, _)
4599 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4600 | TestOutputTrue s | TestOutputFalse s
4601 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4602 | TestOutputStruct (s, _)
4603 | TestLastFail s -> s
4605 (* Handling for function flags. *)
4606 let protocol_limit_warning =
4607 "Because of the message protocol, there is a transfer limit
4608 of somewhere between 2MB and 4MB. To transfer large files you should use
4611 let danger_will_robinson =
4612 "B<This command is dangerous. Without careful use you
4613 can easily destroy all your data>."
4615 let deprecation_notice flags =
4618 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4620 sprintf "This function is deprecated.
4621 In new code, use the C<%s> call instead.
4623 Deprecated functions will not be removed from the API, but the
4624 fact that they are deprecated indicates that there are problems
4625 with correct use of these functions." alt in
4630 (* Create list of optional groups. *)
4632 let h = Hashtbl.create 13 in
4634 fun (name, _, _, flags, _, _, _) ->
4638 let names = try Hashtbl.find h group with Not_found -> [] in
4639 Hashtbl.replace h group (name :: names)
4643 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4646 fun group -> group, List.sort compare (Hashtbl.find h group)
4648 List.sort (fun x y -> compare (fst x) (fst y)) groups
4650 (* Check function names etc. for consistency. *)
4651 let check_functions () =
4652 let contains_uppercase str =
4653 let len = String.length str in
4655 if i >= len then false
4658 if c >= 'A' && c <= 'Z' then true
4665 (* Check function names. *)
4667 fun (name, _, _, _, _, _, _) ->
4668 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4669 failwithf "function name %s does not need 'guestfs' prefix" name;
4671 failwithf "function name is empty";
4672 if name.[0] < 'a' || name.[0] > 'z' then
4673 failwithf "function name %s must start with lowercase a-z" name;
4674 if String.contains name '-' then
4675 failwithf "function name %s should not contain '-', use '_' instead."
4679 (* Check function parameter/return names. *)
4681 fun (name, style, _, _, _, _, _) ->
4682 let check_arg_ret_name n =
4683 if contains_uppercase n then
4684 failwithf "%s param/ret %s should not contain uppercase chars"
4686 if String.contains n '-' || String.contains n '_' then
4687 failwithf "%s param/ret %s should not contain '-' or '_'"
4690 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;
4691 if n = "int" || n = "char" || n = "short" || n = "long" then
4692 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4693 if n = "i" || n = "n" then
4694 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4695 if n = "argv" || n = "args" then
4696 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
4698 (* List Haskell, OCaml and C keywords here.
4699 * http://www.haskell.org/haskellwiki/Keywords
4700 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
4701 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
4702 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
4703 * |perl -pe 's/(.+)/"$1";/'|fmt -70
4704 * Omitting _-containing words, since they're handled above.
4705 * Omitting the OCaml reserved word, "val", is ok,
4706 * and saves us from renaming several parameters.
4709 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
4710 "char"; "class"; "const"; "constraint"; "continue"; "data";
4711 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
4712 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
4713 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
4714 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
4715 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
4716 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
4717 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
4718 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
4719 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
4720 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
4721 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
4722 "volatile"; "when"; "where"; "while";
4724 if List.mem n reserved then
4725 failwithf "%s has param/ret using reserved word %s" name n;
4728 (match fst style with
4730 | RInt n | RInt64 n | RBool n
4731 | RConstString n | RConstOptString n | RString n
4732 | RStringList n | RStruct (n, _) | RStructList (n, _)
4733 | RHashtable n | RBufferOut n ->
4734 check_arg_ret_name n
4736 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
4739 (* Check short descriptions. *)
4741 fun (name, _, _, _, _, shortdesc, _) ->
4742 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
4743 failwithf "short description of %s should begin with lowercase." name;
4744 let c = shortdesc.[String.length shortdesc-1] in
4745 if c = '\n' || c = '.' then
4746 failwithf "short description of %s should not end with . or \\n." name
4749 (* Check long dscriptions. *)
4751 fun (name, _, _, _, _, _, longdesc) ->
4752 if longdesc.[String.length longdesc-1] = '\n' then
4753 failwithf "long description of %s should not end with \\n." name
4756 (* Check proc_nrs. *)
4758 fun (name, _, proc_nr, _, _, _, _) ->
4759 if proc_nr <= 0 then
4760 failwithf "daemon function %s should have proc_nr > 0" name
4764 fun (name, _, proc_nr, _, _, _, _) ->
4765 if proc_nr <> -1 then
4766 failwithf "non-daemon function %s should have proc_nr -1" name
4767 ) non_daemon_functions;
4770 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
4773 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
4774 let rec loop = function
4777 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
4779 | (name1,nr1) :: (name2,nr2) :: _ ->
4780 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
4788 (* Ignore functions that have no tests. We generate a
4789 * warning when the user does 'make check' instead.
4791 | name, _, _, _, [], _, _ -> ()
4792 | name, _, _, _, tests, _, _ ->
4796 match seq_of_test test with
4798 failwithf "%s has a test containing an empty sequence" name
4799 | cmds -> List.map List.hd cmds
4801 let funcs = List.flatten funcs in
4803 let tested = List.mem name funcs in
4806 failwithf "function %s has tests but does not test itself" name
4809 (* 'pr' prints to the current output file. *)
4810 let chan = ref Pervasives.stdout
4811 let pr fs = ksprintf (output_string !chan) fs
4813 let copyright_years =
4814 let this_year = 1900 + (localtime (time ())).tm_year in
4815 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
4817 (* Generate a header block in a number of standard styles. *)
4818 type comment_style =
4819 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
4820 type license = GPLv2plus | LGPLv2plus
4822 let generate_header ?(extra_inputs = []) comment license =
4823 let inputs = "src/generator.ml" :: extra_inputs in
4824 let c = match comment with
4825 | CStyle -> pr "/* "; " *"
4826 | CPlusPlusStyle -> pr "// "; "//"
4827 | HashStyle -> pr "# "; "#"
4828 | OCamlStyle -> pr "(* "; " *"
4829 | HaskellStyle -> pr "{- "; " " in
4830 pr "libguestfs generated file\n";
4831 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
4832 List.iter (pr "%s %s\n" c) inputs;
4833 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
4835 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
4839 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
4840 pr "%s it under the terms of the GNU General Public License as published by\n" c;
4841 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
4842 pr "%s (at your option) any later version.\n" c;
4844 pr "%s This program is distributed in the hope that it will be useful,\n" c;
4845 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4846 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
4847 pr "%s GNU General Public License for more details.\n" c;
4849 pr "%s You should have received a copy of the GNU General Public License along\n" c;
4850 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
4851 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
4854 pr "%s This library is free software; you can redistribute it and/or\n" c;
4855 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
4856 pr "%s License as published by the Free Software Foundation; either\n" c;
4857 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
4859 pr "%s This library is distributed in the hope that it will be useful,\n" c;
4860 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4861 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
4862 pr "%s Lesser General Public License for more details.\n" c;
4864 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
4865 pr "%s License along with this library; if not, write to the Free Software\n" c;
4866 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
4869 | CStyle -> pr " */\n"
4872 | OCamlStyle -> pr " *)\n"
4873 | HaskellStyle -> pr "-}\n"
4877 (* Start of main code generation functions below this line. *)
4879 (* Generate the pod documentation for the C API. *)
4880 let rec generate_actions_pod () =
4882 fun (shortname, style, _, flags, _, _, longdesc) ->
4883 if not (List.mem NotInDocs flags) then (
4884 let name = "guestfs_" ^ shortname in
4885 pr "=head2 %s\n\n" name;
4887 generate_prototype ~extern:false ~handle:"handle" name style;
4889 pr "%s\n\n" longdesc;
4890 (match fst style with
4892 pr "This function returns 0 on success or -1 on error.\n\n"
4894 pr "On error this function returns -1.\n\n"
4896 pr "On error this function returns -1.\n\n"
4898 pr "This function returns a C truth value on success or -1 on error.\n\n"
4900 pr "This function returns a string, or NULL on error.
4901 The string is owned by the guest handle and must I<not> be freed.\n\n"
4902 | RConstOptString _ ->
4903 pr "This function returns a string which may be NULL.
4904 There is way to return an error from this function.
4905 The string is owned by the guest handle and must I<not> be freed.\n\n"
4907 pr "This function returns a string, or NULL on error.
4908 I<The caller must free the returned string after use>.\n\n"
4910 pr "This function returns a NULL-terminated array of strings
4911 (like L<environ(3)>), or NULL if there was an error.
4912 I<The caller must free the strings and the array after use>.\n\n"
4913 | RStruct (_, typ) ->
4914 pr "This function returns a C<struct guestfs_%s *>,
4915 or NULL if there was an error.
4916 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
4917 | RStructList (_, typ) ->
4918 pr "This function returns a C<struct guestfs_%s_list *>
4919 (see E<lt>guestfs-structs.hE<gt>),
4920 or NULL if there was an error.
4921 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4923 pr "This function returns a NULL-terminated array of
4924 strings, or NULL if there was an error.
4925 The array of strings will always have length C<2n+1>, where
4926 C<n> keys and values alternate, followed by the trailing NULL entry.
4927 I<The caller must free the strings and the array after use>.\n\n"
4929 pr "This function returns a buffer, or NULL on error.
4930 The size of the returned buffer is written to C<*size_r>.
4931 I<The caller must free the returned buffer after use>.\n\n"
4933 if List.mem ProtocolLimitWarning flags then
4934 pr "%s\n\n" protocol_limit_warning;
4935 if List.mem DangerWillRobinson flags then
4936 pr "%s\n\n" danger_will_robinson;
4937 match deprecation_notice flags with
4939 | Some txt -> pr "%s\n\n" txt
4941 ) all_functions_sorted
4943 and generate_structs_pod () =
4944 (* Structs documentation. *)
4947 pr "=head2 guestfs_%s\n" typ;
4949 pr " struct guestfs_%s {\n" typ;
4952 | name, FChar -> pr " char %s;\n" name
4953 | name, FUInt32 -> pr " uint32_t %s;\n" name
4954 | name, FInt32 -> pr " int32_t %s;\n" name
4955 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4956 | name, FInt64 -> pr " int64_t %s;\n" name
4957 | name, FString -> pr " char *%s;\n" name
4959 pr " /* The next two fields describe a byte array. */\n";
4960 pr " uint32_t %s_len;\n" name;
4961 pr " char *%s;\n" name
4963 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4964 pr " char %s[32];\n" name
4965 | name, FOptPercent ->
4966 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4967 pr " float %s;\n" name
4971 pr " struct guestfs_%s_list {\n" typ;
4972 pr " uint32_t len; /* Number of elements in list. */\n";
4973 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
4976 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
4977 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
4982 and generate_availability_pod () =
4983 (* Availability documentation. *)
4987 fun (group, functions) ->
4988 pr "=item B<%s>\n" group;
4990 pr "The following functions:\n";
4991 List.iter (pr "L</guestfs_%s>\n") functions;
4997 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
4998 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5000 * We have to use an underscore instead of a dash because otherwise
5001 * rpcgen generates incorrect code.
5003 * This header is NOT exported to clients, but see also generate_structs_h.
5005 and generate_xdr () =
5006 generate_header CStyle LGPLv2plus;
5008 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5009 pr "typedef string str<>;\n";
5012 (* Internal structures. *)
5016 pr "struct guestfs_int_%s {\n" typ;
5018 | name, FChar -> pr " char %s;\n" name
5019 | name, FString -> pr " string %s<>;\n" name
5020 | name, FBuffer -> pr " opaque %s<>;\n" name
5021 | name, FUUID -> pr " opaque %s[32];\n" name
5022 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5023 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5024 | name, FOptPercent -> pr " float %s;\n" name
5028 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5033 fun (shortname, style, _, _, _, _, _) ->
5034 let name = "guestfs_" ^ shortname in
5036 (match snd style with
5039 pr "struct %s_args {\n" name;
5042 | Pathname n | Device n | Dev_or_Path n | String n ->
5043 pr " string %s<>;\n" n
5044 | OptString n -> pr " str *%s;\n" n
5045 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5046 | Bool n -> pr " bool %s;\n" n
5047 | Int n -> pr " int %s;\n" n
5048 | Int64 n -> pr " hyper %s;\n" n
5049 | FileIn _ | FileOut _ -> ()
5053 (match fst style with
5056 pr "struct %s_ret {\n" name;
5060 pr "struct %s_ret {\n" name;
5061 pr " hyper %s;\n" n;
5064 pr "struct %s_ret {\n" name;
5067 | RConstString _ | RConstOptString _ ->
5068 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5070 pr "struct %s_ret {\n" name;
5071 pr " string %s<>;\n" n;
5074 pr "struct %s_ret {\n" name;
5075 pr " str %s<>;\n" n;
5077 | RStruct (n, typ) ->
5078 pr "struct %s_ret {\n" name;
5079 pr " guestfs_int_%s %s;\n" typ n;
5081 | RStructList (n, typ) ->
5082 pr "struct %s_ret {\n" name;
5083 pr " guestfs_int_%s_list %s;\n" typ n;
5086 pr "struct %s_ret {\n" name;
5087 pr " str %s<>;\n" n;
5090 pr "struct %s_ret {\n" name;
5091 pr " opaque %s<>;\n" n;
5096 (* Table of procedure numbers. *)
5097 pr "enum guestfs_procedure {\n";
5099 fun (shortname, _, proc_nr, _, _, _, _) ->
5100 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5102 pr " GUESTFS_PROC_NR_PROCS\n";
5106 (* Having to choose a maximum message size is annoying for several
5107 * reasons (it limits what we can do in the API), but it (a) makes
5108 * the protocol a lot simpler, and (b) provides a bound on the size
5109 * of the daemon which operates in limited memory space. For large
5110 * file transfers you should use FTP.
5112 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5115 (* Message header, etc. *)
5117 /* The communication protocol is now documented in the guestfs(3)
5121 const GUESTFS_PROGRAM = 0x2000F5F5;
5122 const GUESTFS_PROTOCOL_VERSION = 1;
5124 /* These constants must be larger than any possible message length. */
5125 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5126 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5128 enum guestfs_message_direction {
5129 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5130 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5133 enum guestfs_message_status {
5134 GUESTFS_STATUS_OK = 0,
5135 GUESTFS_STATUS_ERROR = 1
5138 const GUESTFS_ERROR_LEN = 256;
5140 struct guestfs_message_error {
5141 string error_message<GUESTFS_ERROR_LEN>;
5144 struct guestfs_message_header {
5145 unsigned prog; /* GUESTFS_PROGRAM */
5146 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5147 guestfs_procedure proc; /* GUESTFS_PROC_x */
5148 guestfs_message_direction direction;
5149 unsigned serial; /* message serial number */
5150 guestfs_message_status status;
5153 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5155 struct guestfs_chunk {
5156 int cancel; /* if non-zero, transfer is cancelled */
5157 /* data size is 0 bytes if the transfer has finished successfully */
5158 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5162 (* Generate the guestfs-structs.h file. *)
5163 and generate_structs_h () =
5164 generate_header CStyle LGPLv2plus;
5166 (* This is a public exported header file containing various
5167 * structures. The structures are carefully written to have
5168 * exactly the same in-memory format as the XDR structures that
5169 * we use on the wire to the daemon. The reason for creating
5170 * copies of these structures here is just so we don't have to
5171 * export the whole of guestfs_protocol.h (which includes much
5172 * unrelated and XDR-dependent stuff that we don't want to be
5173 * public, or required by clients).
5175 * To reiterate, we will pass these structures to and from the
5176 * client with a simple assignment or memcpy, so the format
5177 * must be identical to what rpcgen / the RFC defines.
5180 (* Public structures. *)
5183 pr "struct guestfs_%s {\n" typ;
5186 | name, FChar -> pr " char %s;\n" name
5187 | name, FString -> pr " char *%s;\n" name
5189 pr " uint32_t %s_len;\n" name;
5190 pr " char *%s;\n" name
5191 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5192 | name, FUInt32 -> pr " uint32_t %s;\n" name
5193 | name, FInt32 -> pr " int32_t %s;\n" name
5194 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5195 | name, FInt64 -> pr " int64_t %s;\n" name
5196 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5200 pr "struct guestfs_%s_list {\n" typ;
5201 pr " uint32_t len;\n";
5202 pr " struct guestfs_%s *val;\n" typ;
5205 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5206 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5210 (* Generate the guestfs-actions.h file. *)
5211 and generate_actions_h () =
5212 generate_header CStyle LGPLv2plus;
5214 fun (shortname, style, _, _, _, _, _) ->
5215 let name = "guestfs_" ^ shortname in
5216 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5220 (* Generate the guestfs-internal-actions.h file. *)
5221 and generate_internal_actions_h () =
5222 generate_header CStyle LGPLv2plus;
5224 fun (shortname, style, _, _, _, _, _) ->
5225 let name = "guestfs__" ^ shortname in
5226 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5228 ) non_daemon_functions
5230 (* Generate the client-side dispatch stubs. *)
5231 and generate_client_actions () =
5232 generate_header CStyle LGPLv2plus;
5238 #include <inttypes.h>
5240 #include \"guestfs.h\"
5241 #include \"guestfs-internal.h\"
5242 #include \"guestfs-internal-actions.h\"
5243 #include \"guestfs_protocol.h\"
5245 #define error guestfs_error
5246 //#define perrorf guestfs_perrorf
5247 #define safe_malloc guestfs_safe_malloc
5248 #define safe_realloc guestfs_safe_realloc
5249 //#define safe_strdup guestfs_safe_strdup
5250 #define safe_memdup guestfs_safe_memdup
5252 /* Check the return message from a call for validity. */
5254 check_reply_header (guestfs_h *g,
5255 const struct guestfs_message_header *hdr,
5256 unsigned int proc_nr, unsigned int serial)
5258 if (hdr->prog != GUESTFS_PROGRAM) {
5259 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5262 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5263 error (g, \"wrong protocol version (%%d/%%d)\",
5264 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5267 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5268 error (g, \"unexpected message direction (%%d/%%d)\",
5269 hdr->direction, GUESTFS_DIRECTION_REPLY);
5272 if (hdr->proc != proc_nr) {
5273 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5276 if (hdr->serial != serial) {
5277 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5284 /* Check we are in the right state to run a high-level action. */
5286 check_state (guestfs_h *g, const char *caller)
5288 if (!guestfs__is_ready (g)) {
5289 if (guestfs__is_config (g) || guestfs__is_launching (g))
5290 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5293 error (g, \"%%s called from the wrong state, %%d != READY\",
5294 caller, guestfs__get_state (g));
5302 (* Generate code to generate guestfish call traces. *)
5303 let trace_call shortname style =
5304 pr " if (guestfs__get_trace (g)) {\n";
5307 List.exists (function
5308 | StringList _ | DeviceList _ -> true
5309 | _ -> false) (snd style) in
5315 pr " printf (\"%s\");\n" shortname;
5318 | String n (* strings *)
5324 (* guestfish doesn't support string escaping, so neither do we *)
5325 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5326 | OptString n -> (* string option *)
5327 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5328 pr " else printf (\" null\");\n"
5330 | DeviceList n -> (* string list *)
5331 pr " putchar (' ');\n";
5332 pr " putchar ('\"');\n";
5333 pr " for (i = 0; %s[i]; ++i) {\n" n;
5334 pr " if (i > 0) putchar (' ');\n";
5335 pr " fputs (%s[i], stdout);\n" n;
5337 pr " putchar ('\"');\n";
5338 | Bool n -> (* boolean *)
5339 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5340 | Int n -> (* int *)
5341 pr " printf (\" %%d\", %s);\n" n
5343 pr " printf (\" %%\" PRIi64, %s);\n" n
5345 pr " putchar ('\\n');\n";
5350 (* For non-daemon functions, generate a wrapper around each function. *)
5352 fun (shortname, style, _, _, _, _, _) ->
5353 let name = "guestfs_" ^ shortname in
5355 generate_prototype ~extern:false ~semicolon:false ~newline:true
5356 ~handle:"g" name style;
5358 trace_call shortname style;
5359 pr " return guestfs__%s " shortname;
5360 generate_c_call_args ~handle:"g" style;
5364 ) non_daemon_functions;
5366 (* Client-side stubs for each function. *)
5368 fun (shortname, style, _, _, _, _, _) ->
5369 let name = "guestfs_" ^ shortname in
5371 (* Generate the action stub. *)
5372 generate_prototype ~extern:false ~semicolon:false ~newline:true
5373 ~handle:"g" name style;
5376 match fst style with
5377 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5378 | RConstString _ | RConstOptString _ ->
5379 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5380 | RString _ | RStringList _
5381 | RStruct _ | RStructList _
5382 | RHashtable _ | RBufferOut _ ->
5387 (match snd style with
5389 | _ -> pr " struct %s_args args;\n" name
5392 pr " guestfs_message_header hdr;\n";
5393 pr " guestfs_message_error err;\n";
5395 match fst style with
5397 | RConstString _ | RConstOptString _ ->
5398 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5400 | RBool _ | RString _ | RStringList _
5401 | RStruct _ | RStructList _
5402 | RHashtable _ | RBufferOut _ ->
5403 pr " struct %s_ret ret;\n" name;
5406 pr " int serial;\n";
5409 trace_call shortname style;
5410 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5411 pr " guestfs___set_busy (g);\n";
5414 (* Send the main header and arguments. *)
5415 (match snd style with
5417 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5418 (String.uppercase shortname)
5422 | Pathname n | Device n | Dev_or_Path n | String n ->
5423 pr " args.%s = (char *) %s;\n" n n
5425 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5426 | StringList n | DeviceList n ->
5427 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5428 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5430 pr " args.%s = %s;\n" n n
5432 pr " args.%s = %s;\n" n n
5434 pr " args.%s = %s;\n" n n
5435 | FileIn _ | FileOut _ -> ()
5437 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5438 (String.uppercase shortname);
5439 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5442 pr " if (serial == -1) {\n";
5443 pr " guestfs___end_busy (g);\n";
5444 pr " return %s;\n" error_code;
5448 (* Send any additional files (FileIn) requested. *)
5449 let need_read_reply_label = ref false in
5453 pr " r = guestfs___send_file (g, %s);\n" n;
5454 pr " if (r == -1) {\n";
5455 pr " guestfs___end_busy (g);\n";
5456 pr " return %s;\n" error_code;
5458 pr " if (r == -2) /* daemon cancelled */\n";
5459 pr " goto read_reply;\n";
5460 need_read_reply_label := true;
5465 (* Wait for the reply from the remote end. *)
5466 if !need_read_reply_label then pr " read_reply:\n";
5467 pr " memset (&hdr, 0, sizeof hdr);\n";
5468 pr " memset (&err, 0, sizeof err);\n";
5469 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5471 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5475 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5478 pr " if (r == -1) {\n";
5479 pr " guestfs___end_busy (g);\n";
5480 pr " return %s;\n" error_code;
5484 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5485 (String.uppercase shortname);
5486 pr " guestfs___end_busy (g);\n";
5487 pr " return %s;\n" error_code;
5491 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5492 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5493 pr " free (err.error_message);\n";
5494 pr " guestfs___end_busy (g);\n";
5495 pr " return %s;\n" error_code;
5499 (* Expecting to receive further files (FileOut)? *)
5503 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5504 pr " guestfs___end_busy (g);\n";
5505 pr " return %s;\n" error_code;
5511 pr " guestfs___end_busy (g);\n";
5513 (match fst style with
5514 | RErr -> pr " return 0;\n"
5515 | RInt n | RInt64 n | RBool n ->
5516 pr " return ret.%s;\n" n
5517 | RConstString _ | RConstOptString _ ->
5518 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5520 pr " return ret.%s; /* caller will free */\n" n
5521 | RStringList n | RHashtable n ->
5522 pr " /* caller will free this, but we need to add a NULL entry */\n";
5523 pr " ret.%s.%s_val =\n" n n;
5524 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5525 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5527 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5528 pr " return ret.%s.%s_val;\n" n n
5530 pr " /* caller will free this */\n";
5531 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5532 | RStructList (n, _) ->
5533 pr " /* caller will free this */\n";
5534 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5536 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5537 pr " * _val might be NULL here. To make the API saner for\n";
5538 pr " * callers, we turn this case into a unique pointer (using\n";
5539 pr " * malloc(1)).\n";
5541 pr " if (ret.%s.%s_len > 0) {\n" n n;
5542 pr " *size_r = ret.%s.%s_len;\n" n n;
5543 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5545 pr " free (ret.%s.%s_val);\n" n n;
5546 pr " char *p = safe_malloc (g, 1);\n";
5547 pr " *size_r = ret.%s.%s_len;\n" n n;
5555 (* Functions to free structures. *)
5556 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5557 pr " * structure format is identical to the XDR format. See note in\n";
5558 pr " * generator.ml.\n";
5565 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5567 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5573 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5575 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5582 (* Generate daemon/actions.h. *)
5583 and generate_daemon_actions_h () =
5584 generate_header CStyle GPLv2plus;
5586 pr "#include \"../src/guestfs_protocol.h\"\n";
5590 fun (name, style, _, _, _, _, _) ->
5592 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5596 (* Generate the server-side stubs. *)
5597 and generate_daemon_actions () =
5598 generate_header CStyle GPLv2plus;
5600 pr "#include <config.h>\n";
5602 pr "#include <stdio.h>\n";
5603 pr "#include <stdlib.h>\n";
5604 pr "#include <string.h>\n";
5605 pr "#include <inttypes.h>\n";
5606 pr "#include <rpc/types.h>\n";
5607 pr "#include <rpc/xdr.h>\n";
5609 pr "#include \"daemon.h\"\n";
5610 pr "#include \"c-ctype.h\"\n";
5611 pr "#include \"../src/guestfs_protocol.h\"\n";
5612 pr "#include \"actions.h\"\n";
5616 fun (name, style, _, _, _, _, _) ->
5617 (* Generate server-side stubs. *)
5618 pr "static void %s_stub (XDR *xdr_in)\n" name;
5621 match fst style with
5622 | RErr | RInt _ -> pr " int r;\n"; "-1"
5623 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5624 | RBool _ -> pr " int r;\n"; "-1"
5625 | RConstString _ | RConstOptString _ ->
5626 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5627 | RString _ -> pr " char *r;\n"; "NULL"
5628 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5629 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
5630 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
5632 pr " size_t size = 1;\n";
5636 (match snd style with
5639 pr " struct guestfs_%s_args args;\n" name;
5642 | Device n | Dev_or_Path n
5645 | OptString n -> pr " char *%s;\n" n
5646 | StringList n | DeviceList n -> pr " char **%s;\n" n
5647 | Bool n -> pr " int %s;\n" n
5648 | Int n -> pr " int %s;\n" n
5649 | Int64 n -> pr " int64_t %s;\n" n
5650 | FileIn _ | FileOut _ -> ()
5655 (match snd style with
5658 pr " memset (&args, 0, sizeof args);\n";
5660 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
5661 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
5665 pr " char *%s = args.%s;\n" n n
5667 let pr_list_handling_code n =
5668 pr " %s = realloc (args.%s.%s_val,\n" n n n;
5669 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
5670 pr " if (%s == NULL) {\n" n;
5671 pr " reply_with_perror (\"realloc\");\n";
5674 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
5675 pr " args.%s.%s_val = %s;\n" n n n;
5681 pr " ABS_PATH (%s, goto done);\n" n;
5684 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
5687 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
5688 | String n -> pr_args n
5689 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
5691 pr_list_handling_code n;
5693 pr_list_handling_code n;
5694 pr " /* Ensure that each is a device,\n";
5695 pr " * and perform device name translation. */\n";
5696 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
5697 pr " RESOLVE_DEVICE (physvols[pvi], goto done);\n";
5699 | Bool n -> pr " %s = args.%s;\n" n n
5700 | Int n -> pr " %s = args.%s;\n" n n
5701 | Int64 n -> pr " %s = args.%s;\n" n n
5702 | FileIn _ | FileOut _ -> ()
5708 (* this is used at least for do_equal *)
5709 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
5710 (* Emit NEED_ROOT just once, even when there are two or
5711 more Pathname args *)
5712 pr " NEED_ROOT (goto done);\n";
5715 (* Don't want to call the impl with any FileIn or FileOut
5716 * parameters, since these go "outside" the RPC protocol.
5719 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
5721 pr " r = do_%s " name;
5722 generate_c_call_args (fst style, args');
5725 (match fst style with
5726 | RErr | RInt _ | RInt64 _ | RBool _
5727 | RConstString _ | RConstOptString _
5728 | RString _ | RStringList _ | RHashtable _
5729 | RStruct (_, _) | RStructList (_, _) ->
5730 pr " if (r == %s)\n" error_code;
5731 pr " /* do_%s has already called reply_with_error */\n" name;
5735 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
5736 pr " * an ordinary zero-length buffer), so be careful ...\n";
5738 pr " if (size == 1 && r == %s)\n" error_code;
5739 pr " /* do_%s has already called reply_with_error */\n" name;
5744 (* If there are any FileOut parameters, then the impl must
5745 * send its own reply.
5748 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
5750 pr " /* do_%s has already sent a reply */\n" name
5752 match fst style with
5753 | RErr -> pr " reply (NULL, NULL);\n"
5754 | RInt n | RInt64 n | RBool n ->
5755 pr " struct guestfs_%s_ret ret;\n" name;
5756 pr " ret.%s = r;\n" n;
5757 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5759 | RConstString _ | RConstOptString _ ->
5760 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5762 pr " struct guestfs_%s_ret ret;\n" name;
5763 pr " ret.%s = r;\n" n;
5764 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5767 | RStringList n | RHashtable n ->
5768 pr " struct guestfs_%s_ret ret;\n" name;
5769 pr " ret.%s.%s_len = count_strings (r);\n" n n;
5770 pr " ret.%s.%s_val = r;\n" n n;
5771 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5773 pr " free_strings (r);\n"
5775 pr " struct guestfs_%s_ret ret;\n" name;
5776 pr " ret.%s = *r;\n" n;
5777 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5779 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5781 | RStructList (n, _) ->
5782 pr " struct guestfs_%s_ret ret;\n" name;
5783 pr " ret.%s = *r;\n" n;
5784 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5786 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5789 pr " struct guestfs_%s_ret ret;\n" name;
5790 pr " ret.%s.%s_val = r;\n" n n;
5791 pr " ret.%s.%s_len = size;\n" n n;
5792 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5797 (* Free the args. *)
5798 (match snd style with
5803 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
5810 (* Dispatch function. *)
5811 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
5813 pr " switch (proc_nr) {\n";
5816 fun (name, style, _, _, _, _, _) ->
5817 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
5818 pr " %s_stub (xdr_in);\n" name;
5823 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";
5828 (* LVM columns and tokenization functions. *)
5829 (* XXX This generates crap code. We should rethink how we
5835 pr "static const char *lvm_%s_cols = \"%s\";\n"
5836 typ (String.concat "," (List.map fst cols));
5839 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
5841 pr " char *tok, *p, *next;\n";
5845 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
5848 pr " if (!str) {\n";
5849 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
5852 pr " if (!*str || c_isspace (*str)) {\n";
5853 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
5858 fun (name, coltype) ->
5859 pr " if (!tok) {\n";
5860 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
5863 pr " p = strchrnul (tok, ',');\n";
5864 pr " if (*p) next = p+1; else next = NULL;\n";
5865 pr " *p = '\\0';\n";
5868 pr " r->%s = strdup (tok);\n" name;
5869 pr " if (r->%s == NULL) {\n" name;
5870 pr " perror (\"strdup\");\n";
5874 pr " for (i = j = 0; i < 32; ++j) {\n";
5875 pr " if (tok[j] == '\\0') {\n";
5876 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
5878 pr " } else if (tok[j] != '-')\n";
5879 pr " r->%s[i++] = tok[j];\n" name;
5882 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
5883 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5887 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
5888 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5892 pr " if (tok[0] == '\\0')\n";
5893 pr " r->%s = -1;\n" name;
5894 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
5895 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5898 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
5899 assert false (* can never be an LVM column *)
5901 pr " tok = next;\n";
5904 pr " if (tok != NULL) {\n";
5905 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
5912 pr "guestfs_int_lvm_%s_list *\n" typ;
5913 pr "parse_command_line_%ss (void)\n" typ;
5915 pr " char *out, *err;\n";
5916 pr " char *p, *pend;\n";
5918 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
5919 pr " void *newp;\n";
5921 pr " ret = malloc (sizeof *ret);\n";
5922 pr " if (!ret) {\n";
5923 pr " reply_with_perror (\"malloc\");\n";
5924 pr " return NULL;\n";
5927 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
5928 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
5930 pr " r = command (&out, &err,\n";
5931 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
5932 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
5933 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
5934 pr " if (r == -1) {\n";
5935 pr " reply_with_error (\"%%s\", err);\n";
5936 pr " free (out);\n";
5937 pr " free (err);\n";
5938 pr " free (ret);\n";
5939 pr " return NULL;\n";
5942 pr " free (err);\n";
5944 pr " /* Tokenize each line of the output. */\n";
5947 pr " while (p) {\n";
5948 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
5949 pr " if (pend) {\n";
5950 pr " *pend = '\\0';\n";
5954 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
5957 pr " if (!*p) { /* Empty line? Skip it. */\n";
5962 pr " /* Allocate some space to store this next entry. */\n";
5963 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
5964 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
5965 pr " if (newp == NULL) {\n";
5966 pr " reply_with_perror (\"realloc\");\n";
5967 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
5968 pr " free (ret);\n";
5969 pr " free (out);\n";
5970 pr " return NULL;\n";
5972 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
5974 pr " /* Tokenize the next entry. */\n";
5975 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
5976 pr " if (r == -1) {\n";
5977 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
5978 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
5979 pr " free (ret);\n";
5980 pr " free (out);\n";
5981 pr " return NULL;\n";
5988 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
5990 pr " free (out);\n";
5991 pr " return ret;\n";
5994 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
5996 (* Generate a list of function names, for debugging in the daemon.. *)
5997 and generate_daemon_names () =
5998 generate_header CStyle GPLv2plus;
6000 pr "#include <config.h>\n";
6002 pr "#include \"daemon.h\"\n";
6005 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6006 pr "const char *function_names[] = {\n";
6008 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6012 (* Generate the optional groups for the daemon to implement
6013 * guestfs_available.
6015 and generate_daemon_optgroups_c () =
6016 generate_header CStyle GPLv2plus;
6018 pr "#include <config.h>\n";
6020 pr "#include \"daemon.h\"\n";
6021 pr "#include \"optgroups.h\"\n";
6024 pr "struct optgroup optgroups[] = {\n";
6027 pr " { \"%s\", optgroup_%s_available },\n" group group
6029 pr " { NULL, NULL }\n";
6032 and generate_daemon_optgroups_h () =
6033 generate_header CStyle GPLv2plus;
6037 pr "extern int optgroup_%s_available (void);\n" group
6040 (* Generate the tests. *)
6041 and generate_tests () =
6042 generate_header CStyle GPLv2plus;
6049 #include <sys/types.h>
6052 #include \"guestfs.h\"
6053 #include \"guestfs-internal.h\"
6055 static guestfs_h *g;
6056 static int suppress_error = 0;
6058 static void print_error (guestfs_h *g, void *data, const char *msg)
6060 if (!suppress_error)
6061 fprintf (stderr, \"%%s\\n\", msg);
6064 /* FIXME: nearly identical code appears in fish.c */
6065 static void print_strings (char *const *argv)
6069 for (argc = 0; argv[argc] != NULL; ++argc)
6070 printf (\"\\t%%s\\n\", argv[argc]);
6074 static void print_table (char const *const *argv)
6078 for (i = 0; argv[i] != NULL; i += 2)
6079 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6085 (* Generate a list of commands which are not tested anywhere. *)
6086 pr "static void no_test_warnings (void)\n";
6089 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6091 fun (_, _, _, _, tests, _, _) ->
6092 let tests = filter_map (
6094 | (_, (Always|If _|Unless _), test) -> Some test
6095 | (_, Disabled, _) -> None
6097 let seq = List.concat (List.map seq_of_test tests) in
6098 let cmds_tested = List.map List.hd seq in
6099 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6103 fun (name, _, _, _, _, _, _) ->
6104 if not (Hashtbl.mem hash name) then
6105 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6111 (* Generate the actual tests. Note that we generate the tests
6112 * in reverse order, deliberately, so that (in general) the
6113 * newest tests run first. This makes it quicker and easier to
6118 fun (name, _, _, flags, tests, _, _) ->
6119 mapi (generate_one_test name flags) tests
6120 ) (List.rev all_functions) in
6121 let test_names = List.concat test_names in
6122 let nr_tests = List.length test_names in
6125 int main (int argc, char *argv[])
6128 unsigned long int n_failed = 0;
6129 const char *filename;
6131 int nr_tests, test_num = 0;
6133 setbuf (stdout, NULL);
6135 no_test_warnings ();
6137 g = guestfs_create ();
6139 printf (\"guestfs_create FAILED\\n\");
6140 exit (EXIT_FAILURE);
6143 guestfs_set_error_handler (g, print_error, NULL);
6145 guestfs_set_path (g, \"../appliance\");
6147 filename = \"test1.img\";
6148 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6151 exit (EXIT_FAILURE);
6153 if (lseek (fd, %d, SEEK_SET) == -1) {
6157 exit (EXIT_FAILURE);
6159 if (write (fd, &c, 1) == -1) {
6163 exit (EXIT_FAILURE);
6165 if (close (fd) == -1) {
6168 exit (EXIT_FAILURE);
6170 if (guestfs_add_drive (g, filename) == -1) {
6171 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6172 exit (EXIT_FAILURE);
6175 filename = \"test2.img\";
6176 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6179 exit (EXIT_FAILURE);
6181 if (lseek (fd, %d, SEEK_SET) == -1) {
6185 exit (EXIT_FAILURE);
6187 if (write (fd, &c, 1) == -1) {
6191 exit (EXIT_FAILURE);
6193 if (close (fd) == -1) {
6196 exit (EXIT_FAILURE);
6198 if (guestfs_add_drive (g, filename) == -1) {
6199 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6200 exit (EXIT_FAILURE);
6203 filename = \"test3.img\";
6204 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6207 exit (EXIT_FAILURE);
6209 if (lseek (fd, %d, SEEK_SET) == -1) {
6213 exit (EXIT_FAILURE);
6215 if (write (fd, &c, 1) == -1) {
6219 exit (EXIT_FAILURE);
6221 if (close (fd) == -1) {
6224 exit (EXIT_FAILURE);
6226 if (guestfs_add_drive (g, filename) == -1) {
6227 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6228 exit (EXIT_FAILURE);
6231 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6232 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6233 exit (EXIT_FAILURE);
6236 if (guestfs_launch (g) == -1) {
6237 printf (\"guestfs_launch FAILED\\n\");
6238 exit (EXIT_FAILURE);
6241 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6244 /* Cancel previous alarm. */
6249 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6253 pr " test_num++;\n";
6254 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6255 pr " if (%s () == -1) {\n" test_name;
6256 pr " printf (\"%s FAILED\\n\");\n" test_name;
6257 pr " n_failed++;\n";
6262 pr " guestfs_close (g);\n";
6263 pr " unlink (\"test1.img\");\n";
6264 pr " unlink (\"test2.img\");\n";
6265 pr " unlink (\"test3.img\");\n";
6268 pr " if (n_failed > 0) {\n";
6269 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6270 pr " exit (EXIT_FAILURE);\n";
6274 pr " exit (EXIT_SUCCESS);\n";
6277 and generate_one_test name flags i (init, prereq, test) =
6278 let test_name = sprintf "test_%s_%d" name i in
6281 static int %s_skip (void)
6285 str = getenv (\"TEST_ONLY\");
6287 return strstr (str, \"%s\") == NULL;
6288 str = getenv (\"SKIP_%s\");
6289 if (str && STREQ (str, \"1\")) return 1;
6290 str = getenv (\"SKIP_TEST_%s\");
6291 if (str && STREQ (str, \"1\")) return 1;
6295 " test_name name (String.uppercase test_name) (String.uppercase name);
6298 | Disabled | Always -> ()
6299 | If code | Unless code ->
6300 pr "static int %s_prereq (void)\n" test_name;
6308 static int %s (void)
6311 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6315 " test_name test_name test_name;
6317 (* Optional functions should only be tested if the relevant
6318 * support is available in the daemon.
6324 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6326 pr " suppress_error = 1;\n";
6327 pr " r = guestfs_available (g, (char **) groups);\n";
6328 pr " suppress_error = 0;\n";
6329 pr " if (r == -1) {\n";
6330 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6339 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6341 pr " if (! %s_prereq ()) {\n" test_name;
6342 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6346 generate_one_test_body name i test_name init test;
6348 pr " if (%s_prereq ()) {\n" test_name;
6349 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6353 generate_one_test_body name i test_name init test;
6355 generate_one_test_body name i test_name init test
6363 and generate_one_test_body name i test_name init test =
6365 | InitNone (* XXX at some point, InitNone and InitEmpty became
6366 * folded together as the same thing. Really we should
6367 * make InitNone do nothing at all, but the tests may
6368 * need to be checked to make sure this is OK.
6371 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6372 List.iter (generate_test_command_call test_name)
6373 [["blockdev_setrw"; "/dev/sda"];
6377 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6378 List.iter (generate_test_command_call test_name)
6379 [["blockdev_setrw"; "/dev/sda"];
6382 ["part_disk"; "/dev/sda"; "mbr"]]
6384 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6385 List.iter (generate_test_command_call test_name)
6386 [["blockdev_setrw"; "/dev/sda"];
6389 ["part_disk"; "/dev/sda"; "mbr"];
6390 ["mkfs"; "ext2"; "/dev/sda1"];
6391 ["mount"; "/dev/sda1"; "/"]]
6392 | InitBasicFSonLVM ->
6393 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6395 List.iter (generate_test_command_call test_name)
6396 [["blockdev_setrw"; "/dev/sda"];
6399 ["part_disk"; "/dev/sda"; "mbr"];
6400 ["pvcreate"; "/dev/sda1"];
6401 ["vgcreate"; "VG"; "/dev/sda1"];
6402 ["lvcreate"; "LV"; "VG"; "8"];
6403 ["mkfs"; "ext2"; "/dev/VG/LV"];
6404 ["mount"; "/dev/VG/LV"; "/"]]
6406 pr " /* InitISOFS for %s */\n" test_name;
6407 List.iter (generate_test_command_call test_name)
6408 [["blockdev_setrw"; "/dev/sda"];
6411 ["mount_ro"; "/dev/sdd"; "/"]]
6414 let get_seq_last = function
6416 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6419 let seq = List.rev seq in
6420 List.rev (List.tl seq), List.hd seq
6425 pr " /* TestRun for %s (%d) */\n" name i;
6426 List.iter (generate_test_command_call test_name) seq
6427 | TestOutput (seq, expected) ->
6428 pr " /* TestOutput for %s (%d) */\n" name i;
6429 pr " const char *expected = \"%s\";\n" (c_quote expected);
6430 let seq, last = get_seq_last seq in
6432 pr " if (STRNEQ (r, expected)) {\n";
6433 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6437 List.iter (generate_test_command_call test_name) seq;
6438 generate_test_command_call ~test test_name last
6439 | TestOutputList (seq, expected) ->
6440 pr " /* TestOutputList for %s (%d) */\n" name i;
6441 let seq, last = get_seq_last seq in
6445 pr " if (!r[%d]) {\n" i;
6446 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6447 pr " print_strings (r);\n";
6451 pr " const char *expected = \"%s\";\n" (c_quote str);
6452 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6453 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6458 pr " if (r[%d] != NULL) {\n" (List.length expected);
6459 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6461 pr " print_strings (r);\n";
6465 List.iter (generate_test_command_call test_name) seq;
6466 generate_test_command_call ~test test_name last
6467 | TestOutputListOfDevices (seq, expected) ->
6468 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6469 let seq, last = get_seq_last seq in
6473 pr " if (!r[%d]) {\n" i;
6474 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6475 pr " print_strings (r);\n";
6479 pr " const char *expected = \"%s\";\n" (c_quote str);
6480 pr " r[%d][5] = 's';\n" i;
6481 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6482 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6487 pr " if (r[%d] != NULL) {\n" (List.length expected);
6488 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6490 pr " print_strings (r);\n";
6494 List.iter (generate_test_command_call test_name) seq;
6495 generate_test_command_call ~test test_name last
6496 | TestOutputInt (seq, expected) ->
6497 pr " /* TestOutputInt for %s (%d) */\n" name i;
6498 let seq, last = get_seq_last seq in
6500 pr " if (r != %d) {\n" expected;
6501 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6507 List.iter (generate_test_command_call test_name) seq;
6508 generate_test_command_call ~test test_name last
6509 | TestOutputIntOp (seq, op, expected) ->
6510 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6511 let seq, last = get_seq_last seq in
6513 pr " if (! (r %s %d)) {\n" op expected;
6514 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6515 test_name op expected;
6520 List.iter (generate_test_command_call test_name) seq;
6521 generate_test_command_call ~test test_name last
6522 | TestOutputTrue seq ->
6523 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6524 let seq, last = get_seq_last seq in
6527 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6532 List.iter (generate_test_command_call test_name) seq;
6533 generate_test_command_call ~test test_name last
6534 | TestOutputFalse seq ->
6535 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6536 let seq, last = get_seq_last seq in
6539 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6544 List.iter (generate_test_command_call test_name) seq;
6545 generate_test_command_call ~test test_name last
6546 | TestOutputLength (seq, expected) ->
6547 pr " /* TestOutputLength for %s (%d) */\n" name i;
6548 let seq, last = get_seq_last seq in
6551 pr " for (j = 0; j < %d; ++j)\n" expected;
6552 pr " if (r[j] == NULL) {\n";
6553 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6555 pr " print_strings (r);\n";
6558 pr " if (r[j] != NULL) {\n";
6559 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6561 pr " print_strings (r);\n";
6565 List.iter (generate_test_command_call test_name) seq;
6566 generate_test_command_call ~test test_name last
6567 | TestOutputBuffer (seq, expected) ->
6568 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6569 pr " const char *expected = \"%s\";\n" (c_quote expected);
6570 let seq, last = get_seq_last seq in
6571 let len = String.length expected in
6573 pr " if (size != %d) {\n" len;
6574 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6577 pr " if (STRNEQLEN (r, expected, size)) {\n";
6578 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6582 List.iter (generate_test_command_call test_name) seq;
6583 generate_test_command_call ~test test_name last
6584 | TestOutputStruct (seq, checks) ->
6585 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6586 let seq, last = get_seq_last seq in
6590 | CompareWithInt (field, expected) ->
6591 pr " if (r->%s != %d) {\n" field expected;
6592 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6593 test_name field expected;
6594 pr " (int) r->%s);\n" field;
6597 | CompareWithIntOp (field, op, expected) ->
6598 pr " if (!(r->%s %s %d)) {\n" field op expected;
6599 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
6600 test_name field op expected;
6601 pr " (int) r->%s);\n" field;
6604 | CompareWithString (field, expected) ->
6605 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
6606 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
6607 test_name field expected;
6608 pr " r->%s);\n" field;
6611 | CompareFieldsIntEq (field1, field2) ->
6612 pr " if (r->%s != r->%s) {\n" field1 field2;
6613 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
6614 test_name field1 field2;
6615 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
6618 | CompareFieldsStrEq (field1, field2) ->
6619 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
6620 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
6621 test_name field1 field2;
6622 pr " r->%s, r->%s);\n" field1 field2;
6627 List.iter (generate_test_command_call test_name) seq;
6628 generate_test_command_call ~test test_name last
6629 | TestLastFail seq ->
6630 pr " /* TestLastFail for %s (%d) */\n" name i;
6631 let seq, last = get_seq_last seq in
6632 List.iter (generate_test_command_call test_name) seq;
6633 generate_test_command_call test_name ~expect_error:true last
6635 (* Generate the code to run a command, leaving the result in 'r'.
6636 * If you expect to get an error then you should set expect_error:true.
6638 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
6640 | [] -> assert false
6642 (* Look up the command to find out what args/ret it has. *)
6645 let _, style, _, _, _, _, _ =
6646 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
6649 failwithf "%s: in test, command %s was not found" test_name name in
6651 if List.length (snd style) <> List.length args then
6652 failwithf "%s: in test, wrong number of args given to %s"
6659 | OptString n, "NULL" -> ()
6662 | Dev_or_Path n, arg
6664 | OptString n, arg ->
6665 pr " const char *%s = \"%s\";\n" n (c_quote arg);
6669 | FileIn _, _ | FileOut _, _ -> ()
6670 | StringList n, "" | DeviceList n, "" ->
6671 pr " const char *const %s[1] = { NULL };\n" n
6672 | StringList n, arg | DeviceList n, arg ->
6673 let strs = string_split " " arg in
6676 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
6678 pr " const char *const %s[] = {\n" n;
6680 fun i _ -> pr " %s_%d,\n" n i
6684 ) (List.combine (snd style) args);
6687 match fst style with
6688 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6689 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6690 | RConstString _ | RConstOptString _ ->
6691 pr " const char *r;\n"; "NULL"
6692 | RString _ -> pr " char *r;\n"; "NULL"
6693 | RStringList _ | RHashtable _ ->
6697 | RStruct (_, typ) ->
6698 pr " struct guestfs_%s *r;\n" typ; "NULL"
6699 | RStructList (_, typ) ->
6700 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6703 pr " size_t size;\n";
6706 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
6707 pr " r = guestfs_%s (g" name;
6709 (* Generate the parameters. *)
6712 | OptString _, "NULL" -> pr ", NULL"
6714 | Device n, _ | Dev_or_Path n, _
6718 | FileIn _, arg | FileOut _, arg ->
6719 pr ", \"%s\"" (c_quote arg)
6720 | StringList n, _ | DeviceList n, _ ->
6721 pr ", (char **) %s" n
6724 try int_of_string arg
6725 with Failure "int_of_string" ->
6726 failwithf "%s: expecting an int, but got '%s'" test_name arg in
6730 try Int64.of_string arg
6731 with Failure "int_of_string" ->
6732 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
6735 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
6736 ) (List.combine (snd style) args);
6738 (match fst style with
6739 | RBufferOut _ -> pr ", &size"
6745 if not expect_error then
6746 pr " if (r == %s)\n" error_code
6748 pr " if (r != %s)\n" error_code;
6751 (* Insert the test code. *)
6757 (match fst style with
6758 | RErr | RInt _ | RInt64 _ | RBool _
6759 | RConstString _ | RConstOptString _ -> ()
6760 | RString _ | RBufferOut _ -> pr " free (r);\n"
6761 | RStringList _ | RHashtable _ ->
6762 pr " for (i = 0; r[i] != NULL; ++i)\n";
6763 pr " free (r[i]);\n";
6765 | RStruct (_, typ) ->
6766 pr " guestfs_free_%s (r);\n" typ
6767 | RStructList (_, typ) ->
6768 pr " guestfs_free_%s_list (r);\n" typ
6774 let str = replace_str str "\r" "\\r" in
6775 let str = replace_str str "\n" "\\n" in
6776 let str = replace_str str "\t" "\\t" in
6777 let str = replace_str str "\000" "\\0" in
6780 (* Generate a lot of different functions for guestfish. *)
6781 and generate_fish_cmds () =
6782 generate_header CStyle GPLv2plus;
6786 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6788 let all_functions_sorted =
6790 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6791 ) all_functions_sorted in
6793 pr "#include <stdio.h>\n";
6794 pr "#include <stdlib.h>\n";
6795 pr "#include <string.h>\n";
6796 pr "#include <inttypes.h>\n";
6798 pr "#include <guestfs.h>\n";
6799 pr "#include \"c-ctype.h\"\n";
6800 pr "#include \"fish.h\"\n";
6803 (* list_commands function, which implements guestfish -h *)
6804 pr "void list_commands (void)\n";
6806 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
6807 pr " list_builtin_commands ();\n";
6809 fun (name, _, _, flags, _, shortdesc, _) ->
6810 let name = replace_char name '_' '-' in
6811 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
6813 ) all_functions_sorted;
6814 pr " printf (\" %%s\\n\",";
6815 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
6819 (* display_command function, which implements guestfish -h cmd *)
6820 pr "void display_command (const char *cmd)\n";
6823 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6824 let name2 = replace_char name '_' '-' in
6826 try find_map (function FishAlias n -> Some n | _ -> None) flags
6827 with Not_found -> name in
6828 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
6830 match snd style with
6834 name2 (String.concat " " (List.map name_of_argt args)) in
6837 if List.mem ProtocolLimitWarning flags then
6838 ("\n\n" ^ protocol_limit_warning)
6841 (* For DangerWillRobinson commands, we should probably have
6842 * guestfish prompt before allowing you to use them (especially
6843 * in interactive mode). XXX
6847 if List.mem DangerWillRobinson flags then
6848 ("\n\n" ^ danger_will_robinson)
6853 match deprecation_notice flags with
6855 | Some txt -> "\n\n" ^ txt in
6857 let describe_alias =
6858 if name <> alias then
6859 sprintf "\n\nYou can use '%s' as an alias for this command." alias
6863 pr "STRCASEEQ (cmd, \"%s\")" name;
6864 if name <> name2 then
6865 pr " || STRCASEEQ (cmd, \"%s\")" name2;
6866 if name <> alias then
6867 pr " || STRCASEEQ (cmd, \"%s\")" alias;
6869 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
6871 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
6872 "=head1 DESCRIPTION\n\n" ^
6873 longdesc ^ warnings ^ describe_alias);
6876 pr " display_builtin_command (cmd);\n";
6880 let emit_print_list_function typ =
6881 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
6884 pr " unsigned int i;\n";
6886 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6887 pr " printf (\"[%%d] = {\\n\", i);\n";
6888 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
6889 pr " printf (\"}\\n\");\n";
6895 (* print_* functions *)
6899 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
6901 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
6904 pr " unsigned int i;\n";
6910 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
6912 pr " printf (\"%%s%s: \", indent);\n" name;
6913 pr " for (i = 0; i < 32; ++i)\n";
6914 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
6915 pr " printf (\"\\n\");\n"
6917 pr " printf (\"%%s%s: \", indent);\n" name;
6918 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
6919 pr " if (c_isprint (%s->%s[i]))\n" typ name;
6920 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
6922 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
6923 pr " printf (\"\\n\");\n"
6924 | name, (FUInt64|FBytes) ->
6925 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
6928 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
6931 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
6934 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
6937 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
6939 | name, FOptPercent ->
6940 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
6941 typ name name typ name;
6942 pr " else printf (\"%%s%s: \\n\", indent);\n" name
6948 (* Emit a print_TYPE_list function definition only if that function is used. *)
6951 | typ, (RStructListOnly | RStructAndList) ->
6952 (* generate the function for typ *)
6953 emit_print_list_function typ
6954 | typ, _ -> () (* empty *)
6955 ) (rstructs_used_by all_functions);
6957 (* Emit a print_TYPE function definition only if that function is used. *)
6960 | typ, (RStructOnly | RStructAndList) ->
6961 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
6963 pr " print_%s_indent (%s, \"\");\n" typ typ;
6966 | typ, _ -> () (* empty *)
6967 ) (rstructs_used_by all_functions);
6969 (* run_<action> actions *)
6971 fun (name, style, _, flags, _, _, _) ->
6972 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
6974 (match fst style with
6977 | RBool _ -> pr " int r;\n"
6978 | RInt64 _ -> pr " int64_t r;\n"
6979 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
6980 | RString _ -> pr " char *r;\n"
6981 | RStringList _ | RHashtable _ -> pr " char **r;\n"
6982 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
6983 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
6986 pr " size_t size;\n";
6994 | FileOut n -> pr " const char *%s;\n" n
6996 | Dev_or_Path n -> pr " char *%s;\n" n
6997 | StringList n | DeviceList n -> pr " char **%s;\n" n
6998 | Bool n -> pr " int %s;\n" n
6999 | Int n -> pr " int %s;\n" n
7000 | Int64 n -> pr " int64_t %s;\n" n
7003 (* Check and convert parameters. *)
7004 let argc_expected = List.length (snd style) in
7005 pr " if (argc != %d) {\n" argc_expected;
7006 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7008 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7016 pr " %s = argv[%d];\n" name i
7018 | Dev_or_Path name ->
7019 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7020 pr " if (%s == NULL) return -1;\n" name
7022 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7025 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7028 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7030 | StringList name | DeviceList name ->
7031 pr " %s = parse_string_list (argv[%d]);\n" name i;
7032 pr " if (%s == NULL) return -1;\n" name;
7034 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7036 pr " %s = atoi (argv[%d]);\n" name i
7038 pr " %s = atoll (argv[%d]);\n" name i
7041 (* Call C API function. *)
7043 try find_map (function FishAction n -> Some n | _ -> None) flags
7044 with Not_found -> sprintf "guestfs_%s" name in
7046 generate_c_call_args ~handle:"g" style;
7051 | Device name | String name
7052 | OptString name | FileIn name | FileOut name | Bool name
7053 | Int name | Int64 name -> ()
7054 | Pathname name | Dev_or_Path name ->
7055 pr " free (%s);\n" name
7056 | StringList name | DeviceList name ->
7057 pr " free_strings (%s);\n" name
7060 (* Check return value for errors and display command results. *)
7061 (match fst style with
7062 | RErr -> pr " return r;\n"
7064 pr " if (r == -1) return -1;\n";
7065 pr " printf (\"%%d\\n\", r);\n";
7068 pr " if (r == -1) return -1;\n";
7069 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7072 pr " if (r == -1) return -1;\n";
7073 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7076 pr " if (r == NULL) return -1;\n";
7077 pr " printf (\"%%s\\n\", r);\n";
7079 | RConstOptString _ ->
7080 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7083 pr " if (r == NULL) return -1;\n";
7084 pr " printf (\"%%s\\n\", r);\n";
7088 pr " if (r == NULL) return -1;\n";
7089 pr " print_strings (r);\n";
7090 pr " free_strings (r);\n";
7092 | RStruct (_, typ) ->
7093 pr " if (r == NULL) return -1;\n";
7094 pr " print_%s (r);\n" typ;
7095 pr " guestfs_free_%s (r);\n" typ;
7097 | RStructList (_, typ) ->
7098 pr " if (r == NULL) return -1;\n";
7099 pr " print_%s_list (r);\n" typ;
7100 pr " guestfs_free_%s_list (r);\n" typ;
7103 pr " if (r == NULL) return -1;\n";
7104 pr " print_table (r);\n";
7105 pr " free_strings (r);\n";
7108 pr " if (r == NULL) return -1;\n";
7109 pr " fwrite (r, size, 1, stdout);\n";
7117 (* run_action function *)
7118 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7121 fun (name, _, _, flags, _, _, _) ->
7122 let name2 = replace_char name '_' '-' in
7124 try find_map (function FishAlias n -> Some n | _ -> None) flags
7125 with Not_found -> name in
7127 pr "STRCASEEQ (cmd, \"%s\")" name;
7128 if name <> name2 then
7129 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7130 if name <> alias then
7131 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7133 pr " return run_%s (cmd, argc, argv);\n" name;
7137 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7144 (* Readline completion for guestfish. *)
7145 and generate_fish_completion () =
7146 generate_header CStyle GPLv2plus;
7150 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7160 #ifdef HAVE_LIBREADLINE
7161 #include <readline/readline.h>
7166 #ifdef HAVE_LIBREADLINE
7168 static const char *const commands[] = {
7169 BUILTIN_COMMANDS_FOR_COMPLETION,
7172 (* Get the commands, including the aliases. They don't need to be
7173 * sorted - the generator() function just does a dumb linear search.
7177 fun (name, _, _, flags, _, _, _) ->
7178 let name2 = replace_char name '_' '-' in
7180 try find_map (function FishAlias n -> Some n | _ -> None) flags
7181 with Not_found -> name in
7183 if name <> alias then [name2; alias] else [name2]
7185 let commands = List.flatten commands in
7187 List.iter (pr " \"%s\",\n") commands;
7193 generator (const char *text, int state)
7195 static int index, len;
7200 len = strlen (text);
7203 rl_attempted_completion_over = 1;
7205 while ((name = commands[index]) != NULL) {
7207 if (STRCASEEQLEN (name, text, len))
7208 return strdup (name);
7214 #endif /* HAVE_LIBREADLINE */
7216 char **do_completion (const char *text, int start, int end)
7218 char **matches = NULL;
7220 #ifdef HAVE_LIBREADLINE
7221 rl_completion_append_character = ' ';
7224 matches = rl_completion_matches (text, generator);
7225 else if (complete_dest_paths)
7226 matches = rl_completion_matches (text, complete_dest_paths_generator);
7233 (* Generate the POD documentation for guestfish. *)
7234 and generate_fish_actions_pod () =
7235 let all_functions_sorted =
7237 fun (_, _, _, flags, _, _, _) ->
7238 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7239 ) all_functions_sorted in
7241 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7244 fun (name, style, _, flags, _, _, longdesc) ->
7246 Str.global_substitute rex (
7249 try Str.matched_group 1 s
7251 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7252 "C<" ^ replace_char sub '_' '-' ^ ">"
7254 let name = replace_char name '_' '-' in
7256 try find_map (function FishAlias n -> Some n | _ -> None) flags
7257 with Not_found -> name in
7259 pr "=head2 %s" name;
7260 if name <> alias then
7267 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7268 | OptString n -> pr " %s" n
7269 | StringList n | DeviceList n -> pr " '%s ...'" n
7270 | Bool _ -> pr " true|false"
7271 | Int n -> pr " %s" n
7272 | Int64 n -> pr " %s" n
7273 | FileIn n | FileOut n -> pr " (%s|-)" n
7277 pr "%s\n\n" longdesc;
7279 if List.exists (function FileIn _ | FileOut _ -> true
7280 | _ -> false) (snd style) then
7281 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7283 if List.mem ProtocolLimitWarning flags then
7284 pr "%s\n\n" protocol_limit_warning;
7286 if List.mem DangerWillRobinson flags then
7287 pr "%s\n\n" danger_will_robinson;
7289 match deprecation_notice flags with
7291 | Some txt -> pr "%s\n\n" txt
7292 ) all_functions_sorted
7294 (* Generate a C function prototype. *)
7295 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7296 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7298 ?handle name style =
7299 if extern then pr "extern ";
7300 if static then pr "static ";
7301 (match fst style with
7303 | RInt _ -> pr "int "
7304 | RInt64 _ -> pr "int64_t "
7305 | RBool _ -> pr "int "
7306 | RConstString _ | RConstOptString _ -> pr "const char *"
7307 | RString _ | RBufferOut _ -> pr "char *"
7308 | RStringList _ | RHashtable _ -> pr "char **"
7309 | RStruct (_, typ) ->
7310 if not in_daemon then pr "struct guestfs_%s *" typ
7311 else pr "guestfs_int_%s *" typ
7312 | RStructList (_, typ) ->
7313 if not in_daemon then pr "struct guestfs_%s_list *" typ
7314 else pr "guestfs_int_%s_list *" typ
7316 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7317 pr "%s%s (" prefix name;
7318 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7321 let comma = ref false in
7324 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7328 if single_line then pr ", " else pr ",\n\t\t"
7335 | Device n | Dev_or_Path n
7339 pr "const char *%s" n
7340 | StringList n | DeviceList n ->
7342 pr "char *const *%s" n
7343 | Bool n -> next (); pr "int %s" n
7344 | Int n -> next (); pr "int %s" n
7345 | Int64 n -> next (); pr "int64_t %s" n
7348 if not in_daemon then (next (); pr "const char *%s" n)
7350 if is_RBufferOut then (next (); pr "size_t *size_r");
7353 if semicolon then pr ";";
7354 if newline then pr "\n"
7356 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7357 and generate_c_call_args ?handle ?(decl = false) style =
7359 let comma = ref false in
7361 if !comma then pr ", ";
7366 | Some handle -> pr "%s" handle; comma := true
7371 pr "%s" (name_of_argt arg)
7373 (* For RBufferOut calls, add implicit &size parameter. *)
7375 match fst style with
7383 (* Generate the OCaml bindings interface. *)
7384 and generate_ocaml_mli () =
7385 generate_header OCamlStyle LGPLv2plus;
7388 (** For API documentation you should refer to the C API
7389 in the guestfs(3) manual page. The OCaml API uses almost
7390 exactly the same calls. *)
7393 (** A [guestfs_h] handle. *)
7395 exception Error of string
7396 (** This exception is raised when there is an error. *)
7398 exception Handle_closed of string
7399 (** This exception is raised if you use a {!Guestfs.t} handle
7400 after calling {!close} on it. The string is the name of
7403 val create : unit -> t
7404 (** Create a {!Guestfs.t} handle. *)
7406 val close : t -> unit
7407 (** Close the {!Guestfs.t} handle and free up all resources used
7410 Handles are closed by the garbage collector when they become
7411 unreferenced, but callers can call this in order to provide
7412 predictable cleanup. *)
7415 generate_ocaml_structure_decls ();
7419 fun (name, style, _, _, _, shortdesc, _) ->
7420 generate_ocaml_prototype name style;
7421 pr "(** %s *)\n" shortdesc;
7423 ) all_functions_sorted
7425 (* Generate the OCaml bindings implementation. *)
7426 and generate_ocaml_ml () =
7427 generate_header OCamlStyle LGPLv2plus;
7432 exception Error of string
7433 exception Handle_closed of string
7435 external create : unit -> t = \"ocaml_guestfs_create\"
7436 external close : t -> unit = \"ocaml_guestfs_close\"
7438 (* Give the exceptions names, so they can be raised from the C code. *)
7440 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7441 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7445 generate_ocaml_structure_decls ();
7449 fun (name, style, _, _, _, shortdesc, _) ->
7450 generate_ocaml_prototype ~is_external:true name style;
7451 ) all_functions_sorted
7453 (* Generate the OCaml bindings C implementation. *)
7454 and generate_ocaml_c () =
7455 generate_header CStyle LGPLv2plus;
7462 #include <caml/config.h>
7463 #include <caml/alloc.h>
7464 #include <caml/callback.h>
7465 #include <caml/fail.h>
7466 #include <caml/memory.h>
7467 #include <caml/mlvalues.h>
7468 #include <caml/signals.h>
7470 #include <guestfs.h>
7472 #include \"guestfs_c.h\"
7474 /* Copy a hashtable of string pairs into an assoc-list. We return
7475 * the list in reverse order, but hashtables aren't supposed to be
7478 static CAMLprim value
7479 copy_table (char * const * argv)
7482 CAMLlocal5 (rv, pairv, kv, vv, cons);
7486 for (i = 0; argv[i] != NULL; i += 2) {
7487 kv = caml_copy_string (argv[i]);
7488 vv = caml_copy_string (argv[i+1]);
7489 pairv = caml_alloc (2, 0);
7490 Store_field (pairv, 0, kv);
7491 Store_field (pairv, 1, vv);
7492 cons = caml_alloc (2, 0);
7493 Store_field (cons, 1, rv);
7495 Store_field (cons, 0, pairv);
7503 (* Struct copy functions. *)
7505 let emit_ocaml_copy_list_function typ =
7506 pr "static CAMLprim value\n";
7507 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7509 pr " CAMLparam0 ();\n";
7510 pr " CAMLlocal2 (rv, v);\n";
7511 pr " unsigned int i;\n";
7513 pr " if (%ss->len == 0)\n" typ;
7514 pr " CAMLreturn (Atom (0));\n";
7516 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7517 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7518 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7519 pr " caml_modify (&Field (rv, i), v);\n";
7521 pr " CAMLreturn (rv);\n";
7529 let has_optpercent_col =
7530 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7532 pr "static CAMLprim value\n";
7533 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7535 pr " CAMLparam0 ();\n";
7536 if has_optpercent_col then
7537 pr " CAMLlocal3 (rv, v, v2);\n"
7539 pr " CAMLlocal2 (rv, v);\n";
7541 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
7546 pr " v = caml_copy_string (%s->%s);\n" typ name
7548 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
7549 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
7552 pr " v = caml_alloc_string (32);\n";
7553 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
7554 | name, (FBytes|FInt64|FUInt64) ->
7555 pr " v = caml_copy_int64 (%s->%s);\n" typ name
7556 | name, (FInt32|FUInt32) ->
7557 pr " v = caml_copy_int32 (%s->%s);\n" typ name
7558 | name, FOptPercent ->
7559 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
7560 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
7561 pr " v = caml_alloc (1, 0);\n";
7562 pr " Store_field (v, 0, v2);\n";
7563 pr " } else /* None */\n";
7564 pr " v = Val_int (0);\n";
7566 pr " v = Val_int (%s->%s);\n" typ name
7568 pr " Store_field (rv, %d, v);\n" i
7570 pr " CAMLreturn (rv);\n";
7575 (* Emit a copy_TYPE_list function definition only if that function is used. *)
7578 | typ, (RStructListOnly | RStructAndList) ->
7579 (* generate the function for typ *)
7580 emit_ocaml_copy_list_function typ
7581 | typ, _ -> () (* empty *)
7582 ) (rstructs_used_by all_functions);
7586 fun (name, style, _, _, _, _, _) ->
7587 pr "/* Automatically generated wrapper for function\n";
7589 generate_ocaml_prototype name style;
7594 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
7596 let needs_extra_vs =
7597 match fst style with RConstOptString _ -> true | _ -> false in
7599 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7600 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
7601 List.iter (pr ", value %s") (List.tl params); pr ");\n";
7604 pr "CAMLprim value\n";
7605 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
7606 List.iter (pr ", value %s") (List.tl params);
7611 | [p1; p2; p3; p4; p5] ->
7612 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
7613 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
7614 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
7615 pr " CAMLxparam%d (%s);\n"
7616 (List.length rest) (String.concat ", " rest)
7618 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
7620 if not needs_extra_vs then
7621 pr " CAMLlocal1 (rv);\n"
7623 pr " CAMLlocal3 (rv, v, v2);\n";
7626 pr " guestfs_h *g = Guestfs_val (gv);\n";
7627 pr " if (g == NULL)\n";
7628 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
7634 | Device n | Dev_or_Path n
7638 pr " const char *%s = String_val (%sv);\n" n n
7640 pr " const char *%s =\n" n;
7641 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
7643 | StringList n | DeviceList n ->
7644 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
7646 pr " int %s = Bool_val (%sv);\n" n n
7648 pr " int %s = Int_val (%sv);\n" n n
7650 pr " int64_t %s = Int64_val (%sv);\n" n n
7653 match fst style with
7654 | RErr -> pr " int r;\n"; "-1"
7655 | RInt _ -> pr " int r;\n"; "-1"
7656 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7657 | RBool _ -> pr " int r;\n"; "-1"
7658 | RConstString _ | RConstOptString _ ->
7659 pr " const char *r;\n"; "NULL"
7660 | RString _ -> pr " char *r;\n"; "NULL"
7665 | RStruct (_, typ) ->
7666 pr " struct guestfs_%s *r;\n" typ; "NULL"
7667 | RStructList (_, typ) ->
7668 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7675 pr " size_t size;\n";
7679 pr " caml_enter_blocking_section ();\n";
7680 pr " r = guestfs_%s " name;
7681 generate_c_call_args ~handle:"g" style;
7683 pr " caml_leave_blocking_section ();\n";
7687 | StringList n | DeviceList n ->
7688 pr " ocaml_guestfs_free_strings (%s);\n" n;
7689 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
7690 | Bool _ | Int _ | Int64 _
7691 | FileIn _ | FileOut _ -> ()
7694 pr " if (r == %s)\n" error_code;
7695 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
7698 (match fst style with
7699 | RErr -> pr " rv = Val_unit;\n"
7700 | RInt _ -> pr " rv = Val_int (r);\n"
7702 pr " rv = caml_copy_int64 (r);\n"
7703 | RBool _ -> pr " rv = Val_bool (r);\n"
7705 pr " rv = caml_copy_string (r);\n"
7706 | RConstOptString _ ->
7707 pr " if (r) { /* Some string */\n";
7708 pr " v = caml_alloc (1, 0);\n";
7709 pr " v2 = caml_copy_string (r);\n";
7710 pr " Store_field (v, 0, v2);\n";
7711 pr " } else /* None */\n";
7712 pr " v = Val_int (0);\n";
7714 pr " rv = caml_copy_string (r);\n";
7717 pr " rv = caml_copy_string_array ((const char **) r);\n";
7718 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7720 | RStruct (_, typ) ->
7721 pr " rv = copy_%s (r);\n" typ;
7722 pr " guestfs_free_%s (r);\n" typ;
7723 | RStructList (_, typ) ->
7724 pr " rv = copy_%s_list (r);\n" typ;
7725 pr " guestfs_free_%s_list (r);\n" typ;
7727 pr " rv = copy_table (r);\n";
7728 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7731 pr " rv = caml_alloc_string (size);\n";
7732 pr " memcpy (String_val (rv), r, size);\n";
7735 pr " CAMLreturn (rv);\n";
7739 if List.length params > 5 then (
7740 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7741 pr "CAMLprim value ";
7742 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
7743 pr "CAMLprim value\n";
7744 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
7746 pr " return ocaml_guestfs_%s (argv[0]" name;
7747 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
7752 ) all_functions_sorted
7754 and generate_ocaml_structure_decls () =
7757 pr "type %s = {\n" typ;
7760 | name, FString -> pr " %s : string;\n" name
7761 | name, FBuffer -> pr " %s : string;\n" name
7762 | name, FUUID -> pr " %s : string;\n" name
7763 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
7764 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
7765 | name, FChar -> pr " %s : char;\n" name
7766 | name, FOptPercent -> pr " %s : float option;\n" name
7772 and generate_ocaml_prototype ?(is_external = false) name style =
7773 if is_external then pr "external " else pr "val ";
7774 pr "%s : t -> " name;
7777 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
7778 | OptString _ -> pr "string option -> "
7779 | StringList _ | DeviceList _ -> pr "string array -> "
7780 | Bool _ -> pr "bool -> "
7781 | Int _ -> pr "int -> "
7782 | Int64 _ -> pr "int64 -> "
7784 (match fst style with
7785 | RErr -> pr "unit" (* all errors are turned into exceptions *)
7786 | RInt _ -> pr "int"
7787 | RInt64 _ -> pr "int64"
7788 | RBool _ -> pr "bool"
7789 | RConstString _ -> pr "string"
7790 | RConstOptString _ -> pr "string option"
7791 | RString _ | RBufferOut _ -> pr "string"
7792 | RStringList _ -> pr "string array"
7793 | RStruct (_, typ) -> pr "%s" typ
7794 | RStructList (_, typ) -> pr "%s array" typ
7795 | RHashtable _ -> pr "(string * string) list"
7797 if is_external then (
7799 if List.length (snd style) + 1 > 5 then
7800 pr "\"ocaml_guestfs_%s_byte\" " name;
7801 pr "\"ocaml_guestfs_%s\"" name
7805 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
7806 and generate_perl_xs () =
7807 generate_header CStyle LGPLv2plus;
7810 #include \"EXTERN.h\"
7814 #include <guestfs.h>
7817 #define PRId64 \"lld\"
7821 my_newSVll(long long val) {
7822 #ifdef USE_64_BIT_ALL
7823 return newSViv(val);
7827 len = snprintf(buf, 100, \"%%\" PRId64, val);
7828 return newSVpv(buf, len);
7833 #define PRIu64 \"llu\"
7837 my_newSVull(unsigned long long val) {
7838 #ifdef USE_64_BIT_ALL
7839 return newSVuv(val);
7843 len = snprintf(buf, 100, \"%%\" PRIu64, val);
7844 return newSVpv(buf, len);
7848 /* http://www.perlmonks.org/?node_id=680842 */
7850 XS_unpack_charPtrPtr (SV *arg) {
7855 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
7856 croak (\"array reference expected\");
7858 av = (AV *)SvRV (arg);
7859 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
7861 croak (\"malloc failed\");
7863 for (i = 0; i <= av_len (av); i++) {
7864 SV **elem = av_fetch (av, i, 0);
7866 if (!elem || !*elem)
7867 croak (\"missing element in list\");
7869 ret[i] = SvPV_nolen (*elem);
7877 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
7884 RETVAL = guestfs_create ();
7886 croak (\"could not create guestfs handle\");
7887 guestfs_set_error_handler (RETVAL, NULL, NULL);
7900 fun (name, style, _, _, _, _, _) ->
7901 (match fst style with
7902 | RErr -> pr "void\n"
7903 | RInt _ -> pr "SV *\n"
7904 | RInt64 _ -> pr "SV *\n"
7905 | RBool _ -> pr "SV *\n"
7906 | RConstString _ -> pr "SV *\n"
7907 | RConstOptString _ -> pr "SV *\n"
7908 | RString _ -> pr "SV *\n"
7909 | RBufferOut _ -> pr "SV *\n"
7911 | RStruct _ | RStructList _
7913 pr "void\n" (* all lists returned implictly on the stack *)
7915 (* Call and arguments. *)
7917 generate_c_call_args ~handle:"g" ~decl:true style;
7919 pr " guestfs_h *g;\n";
7923 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
7926 (* http://www.perlmonks.org/?node_id=554277
7927 * Note that the implicit handle argument means we have
7928 * to add 1 to the ST(x) operator.
7930 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
7931 | StringList n | DeviceList n -> pr " char **%s;\n" n
7932 | Bool n -> pr " int %s;\n" n
7933 | Int n -> pr " int %s;\n" n
7934 | Int64 n -> pr " int64_t %s;\n" n
7937 let do_cleanups () =
7940 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
7941 | Bool _ | Int _ | Int64 _
7942 | FileIn _ | FileOut _ -> ()
7943 | StringList n | DeviceList n -> pr " free (%s);\n" n
7948 (match fst style with
7953 pr " r = guestfs_%s " name;
7954 generate_c_call_args ~handle:"g" style;
7957 pr " if (r == -1)\n";
7958 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
7964 pr " %s = guestfs_%s " n name;
7965 generate_c_call_args ~handle:"g" style;
7968 pr " if (%s == -1)\n" n;
7969 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
7970 pr " RETVAL = newSViv (%s);\n" n;
7975 pr " int64_t %s;\n" n;
7977 pr " %s = guestfs_%s " n name;
7978 generate_c_call_args ~handle:"g" style;
7981 pr " if (%s == -1)\n" n;
7982 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
7983 pr " RETVAL = my_newSVll (%s);\n" n;
7988 pr " const char *%s;\n" n;
7990 pr " %s = guestfs_%s " n name;
7991 generate_c_call_args ~handle:"g" style;
7994 pr " if (%s == NULL)\n" n;
7995 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
7996 pr " RETVAL = newSVpv (%s, 0);\n" n;
7999 | RConstOptString n ->
8001 pr " const char *%s;\n" n;
8003 pr " %s = guestfs_%s " n name;
8004 generate_c_call_args ~handle:"g" style;
8007 pr " if (%s == NULL)\n" n;
8008 pr " RETVAL = &PL_sv_undef;\n";
8010 pr " RETVAL = newSVpv (%s, 0);\n" n;
8015 pr " char *%s;\n" n;
8017 pr " %s = guestfs_%s " n name;
8018 generate_c_call_args ~handle:"g" style;
8021 pr " if (%s == NULL)\n" n;
8022 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8023 pr " RETVAL = newSVpv (%s, 0);\n" n;
8024 pr " free (%s);\n" n;
8027 | RStringList n | RHashtable n ->
8029 pr " char **%s;\n" n;
8032 pr " %s = guestfs_%s " n name;
8033 generate_c_call_args ~handle:"g" style;
8036 pr " if (%s == NULL)\n" n;
8037 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8038 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8039 pr " EXTEND (SP, n);\n";
8040 pr " for (i = 0; i < n; ++i) {\n";
8041 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8042 pr " free (%s[i]);\n" n;
8044 pr " free (%s);\n" n;
8045 | RStruct (n, typ) ->
8046 let cols = cols_of_struct typ in
8047 generate_perl_struct_code typ cols name style n do_cleanups
8048 | RStructList (n, typ) ->
8049 let cols = cols_of_struct typ in
8050 generate_perl_struct_list_code typ cols name style n do_cleanups
8053 pr " char *%s;\n" n;
8054 pr " size_t size;\n";
8056 pr " %s = guestfs_%s " n name;
8057 generate_c_call_args ~handle:"g" style;
8060 pr " if (%s == NULL)\n" n;
8061 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8062 pr " RETVAL = newSVpv (%s, size);\n" n;
8063 pr " free (%s);\n" n;
8071 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8073 pr " struct guestfs_%s_list *%s;\n" typ n;
8077 pr " %s = guestfs_%s " n name;
8078 generate_c_call_args ~handle:"g" style;
8081 pr " if (%s == NULL)\n" n;
8082 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8083 pr " EXTEND (SP, %s->len);\n" n;
8084 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8085 pr " hv = newHV ();\n";
8089 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8090 name (String.length name) n name
8092 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8093 name (String.length name) n name
8095 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8096 name (String.length name) n name n name
8097 | name, (FBytes|FUInt64) ->
8098 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8099 name (String.length name) n name
8101 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8102 name (String.length name) n name
8103 | name, (FInt32|FUInt32) ->
8104 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8105 name (String.length name) n name
8107 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8108 name (String.length name) n name
8109 | name, FOptPercent ->
8110 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8111 name (String.length name) n name
8113 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8115 pr " guestfs_free_%s_list (%s);\n" typ n
8117 and generate_perl_struct_code typ cols name style n do_cleanups =
8119 pr " struct guestfs_%s *%s;\n" typ n;
8121 pr " %s = guestfs_%s " n name;
8122 generate_c_call_args ~handle:"g" style;
8125 pr " if (%s == NULL)\n" n;
8126 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8127 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8129 fun ((name, _) as col) ->
8130 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8134 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8137 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
8140 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8142 | name, (FBytes|FUInt64) ->
8143 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8146 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8148 | name, (FInt32|FUInt32) ->
8149 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8152 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8154 | name, FOptPercent ->
8155 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8158 pr " free (%s);\n" n
8160 (* Generate Sys/Guestfs.pm. *)
8161 and generate_perl_pm () =
8162 generate_header HashStyle LGPLv2plus;
8169 Sys::Guestfs - Perl bindings for libguestfs
8175 my $h = Sys::Guestfs->new ();
8176 $h->add_drive ('guest.img');
8178 $h->mount ('/dev/sda1', '/');
8179 $h->touch ('/hello');
8184 The C<Sys::Guestfs> module provides a Perl XS binding to the
8185 libguestfs API for examining and modifying virtual machine
8188 Amongst the things this is good for: making batch configuration
8189 changes to guests, getting disk used/free statistics (see also:
8190 virt-df), migrating between virtualization systems (see also:
8191 virt-p2v), performing partial backups, performing partial guest
8192 clones, cloning guests and changing registry/UUID/hostname info, and
8195 Libguestfs uses Linux kernel and qemu code, and can access any type of
8196 guest filesystem that Linux and qemu can, including but not limited
8197 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8198 schemes, qcow, qcow2, vmdk.
8200 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8201 LVs, what filesystem is in each LV, etc.). It can also run commands
8202 in the context of the guest. Also you can access filesystems over FTP.
8204 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8205 functions for using libguestfs from Perl, including integration
8210 All errors turn into calls to C<croak> (see L<Carp(3)>).
8218 package Sys::Guestfs;
8224 XSLoader::load ('Sys::Guestfs');
8226 =item $h = Sys::Guestfs->new ();
8228 Create a new guestfs handle.
8234 my $class = ref ($proto) || $proto;
8236 my $self = Sys::Guestfs::_create ();
8237 bless $self, $class;
8243 (* Actions. We only need to print documentation for these as
8244 * they are pulled in from the XS code automatically.
8247 fun (name, style, _, flags, _, _, longdesc) ->
8248 if not (List.mem NotInDocs flags) then (
8249 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8251 generate_perl_prototype name style;
8253 pr "%s\n\n" longdesc;
8254 if List.mem ProtocolLimitWarning flags then
8255 pr "%s\n\n" protocol_limit_warning;
8256 if List.mem DangerWillRobinson flags then
8257 pr "%s\n\n" danger_will_robinson;
8258 match deprecation_notice flags with
8260 | Some txt -> pr "%s\n\n" txt
8262 ) all_functions_sorted;
8274 Copyright (C) %s Red Hat Inc.
8278 Please see the file COPYING.LIB for the full license.
8284 L<http://libguestfs.org>,
8285 L<Sys::Guestfs::Lib(3)>.
8290 and generate_perl_prototype name style =
8291 (match fst style with
8299 | RBufferOut n -> pr "$%s = " n
8301 | RHashtable n -> pr "%%%s = " n
8303 | RStructList (n,_) -> pr "@%s = " n
8306 let comma = ref false in
8309 if !comma then pr ", ";
8312 | Pathname n | Device n | Dev_or_Path n | String n
8313 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8315 | StringList n | DeviceList n ->
8320 (* Generate Python C module. *)
8321 and generate_python_c () =
8322 generate_header CStyle LGPLv2plus;
8331 #include \"guestfs.h\"
8339 get_handle (PyObject *obj)
8342 assert (obj != Py_None);
8343 return ((Pyguestfs_Object *) obj)->g;
8347 put_handle (guestfs_h *g)
8351 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8354 /* This list should be freed (but not the strings) after use. */
8356 get_string_list (PyObject *obj)
8363 if (!PyList_Check (obj)) {
8364 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8368 len = PyList_Size (obj);
8369 r = malloc (sizeof (char *) * (len+1));
8371 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8375 for (i = 0; i < len; ++i)
8376 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8383 put_string_list (char * const * const argv)
8388 for (argc = 0; argv[argc] != NULL; ++argc)
8391 list = PyList_New (argc);
8392 for (i = 0; i < argc; ++i)
8393 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8399 put_table (char * const * const argv)
8401 PyObject *list, *item;
8404 for (argc = 0; argv[argc] != NULL; ++argc)
8407 list = PyList_New (argc >> 1);
8408 for (i = 0; i < argc; i += 2) {
8409 item = PyTuple_New (2);
8410 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8411 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8412 PyList_SetItem (list, i >> 1, item);
8419 free_strings (char **argv)
8423 for (argc = 0; argv[argc] != NULL; ++argc)
8429 py_guestfs_create (PyObject *self, PyObject *args)
8433 g = guestfs_create ();
8435 PyErr_SetString (PyExc_RuntimeError,
8436 \"guestfs.create: failed to allocate handle\");
8439 guestfs_set_error_handler (g, NULL, NULL);
8440 return put_handle (g);
8444 py_guestfs_close (PyObject *self, PyObject *args)
8449 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8451 g = get_handle (py_g);
8455 Py_INCREF (Py_None);
8461 let emit_put_list_function typ =
8462 pr "static PyObject *\n";
8463 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8465 pr " PyObject *list;\n";
8468 pr " list = PyList_New (%ss->len);\n" typ;
8469 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8470 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8471 pr " return list;\n";
8476 (* Structures, turned into Python dictionaries. *)
8479 pr "static PyObject *\n";
8480 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8482 pr " PyObject *dict;\n";
8484 pr " dict = PyDict_New ();\n";
8488 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8489 pr " PyString_FromString (%s->%s));\n"
8492 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8493 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8496 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8497 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8499 | name, (FBytes|FUInt64) ->
8500 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8501 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8504 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8505 pr " PyLong_FromLongLong (%s->%s));\n"
8508 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8509 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8512 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8513 pr " PyLong_FromLong (%s->%s));\n"
8515 | name, FOptPercent ->
8516 pr " if (%s->%s >= 0)\n" typ name;
8517 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8518 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8521 pr " Py_INCREF (Py_None);\n";
8522 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8525 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8526 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8528 pr " return dict;\n";
8534 (* Emit a put_TYPE_list function definition only if that function is used. *)
8537 | typ, (RStructListOnly | RStructAndList) ->
8538 (* generate the function for typ *)
8539 emit_put_list_function typ
8540 | typ, _ -> () (* empty *)
8541 ) (rstructs_used_by all_functions);
8543 (* Python wrapper functions. *)
8545 fun (name, style, _, _, _, _, _) ->
8546 pr "static PyObject *\n";
8547 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
8550 pr " PyObject *py_g;\n";
8551 pr " guestfs_h *g;\n";
8552 pr " PyObject *py_r;\n";
8555 match fst style with
8556 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8557 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8558 | RConstString _ | RConstOptString _ ->
8559 pr " const char *r;\n"; "NULL"
8560 | RString _ -> pr " char *r;\n"; "NULL"
8561 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8562 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8563 | RStructList (_, typ) ->
8564 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8567 pr " size_t size;\n";
8572 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8573 pr " const char *%s;\n" n
8574 | OptString n -> pr " const char *%s;\n" n
8575 | StringList n | DeviceList n ->
8576 pr " PyObject *py_%s;\n" n;
8577 pr " char **%s;\n" n
8578 | Bool n -> pr " int %s;\n" n
8579 | Int n -> pr " int %s;\n" n
8580 | Int64 n -> pr " long long %s;\n" n
8585 (* Convert the parameters. *)
8586 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
8589 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
8590 | OptString _ -> pr "z"
8591 | StringList _ | DeviceList _ -> pr "O"
8592 | Bool _ -> pr "i" (* XXX Python has booleans? *)
8594 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
8595 * emulate C's int/long/long long in Python?
8598 pr ":guestfs_%s\",\n" name;
8602 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
8603 | OptString n -> pr ", &%s" n
8604 | StringList n | DeviceList n -> pr ", &py_%s" n
8605 | Bool n -> pr ", &%s" n
8606 | Int n -> pr ", &%s" n
8607 | Int64 n -> pr ", &%s" n
8611 pr " return NULL;\n";
8613 pr " g = get_handle (py_g);\n";
8616 | Pathname _ | Device _ | Dev_or_Path _ | String _
8617 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8618 | StringList n | DeviceList n ->
8619 pr " %s = get_string_list (py_%s);\n" n n;
8620 pr " if (!%s) return NULL;\n" n
8625 pr " r = guestfs_%s " name;
8626 generate_c_call_args ~handle:"g" style;
8631 | Pathname _ | Device _ | Dev_or_Path _ | String _
8632 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8633 | StringList n | DeviceList n ->
8634 pr " free (%s);\n" n
8637 pr " if (r == %s) {\n" error_code;
8638 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
8639 pr " return NULL;\n";
8643 (match fst style with
8645 pr " Py_INCREF (Py_None);\n";
8646 pr " py_r = Py_None;\n"
8648 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
8649 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
8650 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
8651 | RConstOptString _ ->
8653 pr " py_r = PyString_FromString (r);\n";
8655 pr " Py_INCREF (Py_None);\n";
8656 pr " py_r = Py_None;\n";
8659 pr " py_r = PyString_FromString (r);\n";
8662 pr " py_r = put_string_list (r);\n";
8663 pr " free_strings (r);\n"
8664 | RStruct (_, typ) ->
8665 pr " py_r = put_%s (r);\n" typ;
8666 pr " guestfs_free_%s (r);\n" typ
8667 | RStructList (_, typ) ->
8668 pr " py_r = put_%s_list (r);\n" typ;
8669 pr " guestfs_free_%s_list (r);\n" typ
8671 pr " py_r = put_table (r);\n";
8672 pr " free_strings (r);\n"
8674 pr " py_r = PyString_FromStringAndSize (r, size);\n";
8678 pr " return py_r;\n";
8683 (* Table of functions. *)
8684 pr "static PyMethodDef methods[] = {\n";
8685 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
8686 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
8688 fun (name, _, _, _, _, _, _) ->
8689 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
8692 pr " { NULL, NULL, 0, NULL }\n";
8696 (* Init function. *)
8699 initlibguestfsmod (void)
8701 static int initialized = 0;
8703 if (initialized) return;
8704 Py_InitModule ((char *) \"libguestfsmod\", methods);
8709 (* Generate Python module. *)
8710 and generate_python_py () =
8711 generate_header HashStyle LGPLv2plus;
8714 u\"\"\"Python bindings for libguestfs
8717 g = guestfs.GuestFS ()
8718 g.add_drive (\"guest.img\")
8720 parts = g.list_partitions ()
8722 The guestfs module provides a Python binding to the libguestfs API
8723 for examining and modifying virtual machine disk images.
8725 Amongst the things this is good for: making batch configuration
8726 changes to guests, getting disk used/free statistics (see also:
8727 virt-df), migrating between virtualization systems (see also:
8728 virt-p2v), performing partial backups, performing partial guest
8729 clones, cloning guests and changing registry/UUID/hostname info, and
8732 Libguestfs uses Linux kernel and qemu code, and can access any type of
8733 guest filesystem that Linux and qemu can, including but not limited
8734 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8735 schemes, qcow, qcow2, vmdk.
8737 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8738 LVs, what filesystem is in each LV, etc.). It can also run commands
8739 in the context of the guest. Also you can access filesystems over FTP.
8741 Errors which happen while using the API are turned into Python
8742 RuntimeError exceptions.
8744 To create a guestfs handle you usually have to perform the following
8747 # Create the handle, call add_drive at least once, and possibly
8748 # several times if the guest has multiple block devices:
8749 g = guestfs.GuestFS ()
8750 g.add_drive (\"guest.img\")
8752 # Launch the qemu subprocess and wait for it to become ready:
8755 # Now you can issue commands, for example:
8760 import libguestfsmod
8763 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
8765 def __init__ (self):
8766 \"\"\"Create a new libguestfs handle.\"\"\"
8767 self._o = libguestfsmod.create ()
8770 libguestfsmod.close (self._o)
8775 fun (name, style, _, flags, _, _, longdesc) ->
8777 generate_py_call_args ~handle:"self" (snd style);
8780 if not (List.mem NotInDocs flags) then (
8781 let doc = replace_str longdesc "C<guestfs_" "C<g." in
8783 match fst style with
8784 | RErr | RInt _ | RInt64 _ | RBool _
8785 | RConstOptString _ | RConstString _
8786 | RString _ | RBufferOut _ -> doc
8788 doc ^ "\n\nThis function returns a list of strings."
8789 | RStruct (_, typ) ->
8790 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
8791 | RStructList (_, typ) ->
8792 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
8794 doc ^ "\n\nThis function returns a dictionary." in
8796 if List.mem ProtocolLimitWarning flags then
8797 doc ^ "\n\n" ^ protocol_limit_warning
8800 if List.mem DangerWillRobinson flags then
8801 doc ^ "\n\n" ^ danger_will_robinson
8804 match deprecation_notice flags with
8806 | Some txt -> doc ^ "\n\n" ^ txt in
8807 let doc = pod2text ~width:60 name doc in
8808 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
8809 let doc = String.concat "\n " doc in
8810 pr " u\"\"\"%s\"\"\"\n" doc;
8812 pr " return libguestfsmod.%s " name;
8813 generate_py_call_args ~handle:"self._o" (snd style);
8818 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
8819 and generate_py_call_args ~handle args =
8821 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
8824 (* Useful if you need the longdesc POD text as plain text. Returns a
8827 * Because this is very slow (the slowest part of autogeneration),
8828 * we memoize the results.
8830 and pod2text ~width name longdesc =
8831 let key = width, name, longdesc in
8832 try Hashtbl.find pod2text_memo key
8834 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
8835 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
8837 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
8838 let chan = open_process_in cmd in
8839 let lines = ref [] in
8841 let line = input_line chan in
8842 if i = 1 then (* discard the first line of output *)
8845 let line = triml line in
8846 lines := line :: !lines;
8849 let lines = try loop 1 with End_of_file -> List.rev !lines in
8851 (match close_process_in chan with
8854 failwithf "pod2text: process exited with non-zero status (%d)" i
8855 | WSIGNALED i | WSTOPPED i ->
8856 failwithf "pod2text: process signalled or stopped by signal %d" i
8858 Hashtbl.add pod2text_memo key lines;
8859 pod2text_memo_updated ();
8862 (* Generate ruby bindings. *)
8863 and generate_ruby_c () =
8864 generate_header CStyle LGPLv2plus;
8872 #include \"guestfs.h\"
8874 #include \"extconf.h\"
8876 /* For Ruby < 1.9 */
8878 #define RARRAY_LEN(r) (RARRAY((r))->len)
8881 static VALUE m_guestfs; /* guestfs module */
8882 static VALUE c_guestfs; /* guestfs_h handle */
8883 static VALUE e_Error; /* used for all errors */
8885 static void ruby_guestfs_free (void *p)
8888 guestfs_close ((guestfs_h *) p);
8891 static VALUE ruby_guestfs_create (VALUE m)
8895 g = guestfs_create ();
8897 rb_raise (e_Error, \"failed to create guestfs handle\");
8899 /* Don't print error messages to stderr by default. */
8900 guestfs_set_error_handler (g, NULL, NULL);
8902 /* Wrap it, and make sure the close function is called when the
8905 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
8908 static VALUE ruby_guestfs_close (VALUE gv)
8911 Data_Get_Struct (gv, guestfs_h, g);
8913 ruby_guestfs_free (g);
8914 DATA_PTR (gv) = NULL;
8922 fun (name, style, _, _, _, _, _) ->
8923 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
8924 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
8927 pr " guestfs_h *g;\n";
8928 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
8930 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
8936 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8937 pr " Check_Type (%sv, T_STRING);\n" n;
8938 pr " const char *%s = StringValueCStr (%sv);\n" n n;
8940 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
8941 pr " \"%s\", \"%s\");\n" n name
8943 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
8944 | StringList n | DeviceList n ->
8945 pr " char **%s;\n" n;
8946 pr " Check_Type (%sv, T_ARRAY);\n" n;
8948 pr " int i, len;\n";
8949 pr " len = RARRAY_LEN (%sv);\n" n;
8950 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
8952 pr " for (i = 0; i < len; ++i) {\n";
8953 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
8954 pr " %s[i] = StringValueCStr (v);\n" n;
8956 pr " %s[len] = NULL;\n" n;
8959 pr " int %s = RTEST (%sv);\n" n n
8961 pr " int %s = NUM2INT (%sv);\n" n n
8963 pr " long long %s = NUM2LL (%sv);\n" n n
8968 match fst style with
8969 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8970 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8971 | RConstString _ | RConstOptString _ ->
8972 pr " const char *r;\n"; "NULL"
8973 | RString _ -> pr " char *r;\n"; "NULL"
8974 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8975 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8976 | RStructList (_, typ) ->
8977 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8980 pr " size_t size;\n";
8984 pr " r = guestfs_%s " name;
8985 generate_c_call_args ~handle:"g" style;
8990 | Pathname _ | Device _ | Dev_or_Path _ | String _
8991 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8992 | StringList n | DeviceList n ->
8993 pr " free (%s);\n" n
8996 pr " if (r == %s)\n" error_code;
8997 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9000 (match fst style with
9002 pr " return Qnil;\n"
9003 | RInt _ | RBool _ ->
9004 pr " return INT2NUM (r);\n"
9006 pr " return ULL2NUM (r);\n"
9008 pr " return rb_str_new2 (r);\n";
9009 | RConstOptString _ ->
9011 pr " return rb_str_new2 (r);\n";
9013 pr " return Qnil;\n";
9015 pr " VALUE rv = rb_str_new2 (r);\n";
9019 pr " int i, len = 0;\n";
9020 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9021 pr " VALUE rv = rb_ary_new2 (len);\n";
9022 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9023 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9024 pr " free (r[i]);\n";
9028 | RStruct (_, typ) ->
9029 let cols = cols_of_struct typ in
9030 generate_ruby_struct_code typ cols
9031 | RStructList (_, typ) ->
9032 let cols = cols_of_struct typ in
9033 generate_ruby_struct_list_code typ cols
9035 pr " VALUE rv = rb_hash_new ();\n";
9037 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9038 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9039 pr " free (r[i]);\n";
9040 pr " free (r[i+1]);\n";
9045 pr " VALUE rv = rb_str_new (r, size);\n";
9055 /* Initialize the module. */
9056 void Init__guestfs ()
9058 m_guestfs = rb_define_module (\"Guestfs\");
9059 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9060 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9062 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9063 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9066 (* Define the rest of the methods. *)
9068 fun (name, style, _, _, _, _, _) ->
9069 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9070 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9075 (* Ruby code to return a struct. *)
9076 and generate_ruby_struct_code typ cols =
9077 pr " VALUE rv = rb_hash_new ();\n";
9081 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9083 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9085 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9086 | name, (FBytes|FUInt64) ->
9087 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9089 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9091 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9093 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9094 | name, FOptPercent ->
9095 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9096 | name, FChar -> (* XXX wrong? *)
9097 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9099 pr " guestfs_free_%s (r);\n" typ;
9102 (* Ruby code to return a struct list. *)
9103 and generate_ruby_struct_list_code typ cols =
9104 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9106 pr " for (i = 0; i < r->len; ++i) {\n";
9107 pr " VALUE hv = rb_hash_new ();\n";
9111 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9113 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
9115 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9116 | name, (FBytes|FUInt64) ->
9117 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9119 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9121 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9123 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9124 | name, FOptPercent ->
9125 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9126 | name, FChar -> (* XXX wrong? *)
9127 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9129 pr " rb_ary_push (rv, hv);\n";
9131 pr " guestfs_free_%s_list (r);\n" typ;
9134 (* Generate Java bindings GuestFS.java file. *)
9135 and generate_java_java () =
9136 generate_header CStyle LGPLv2plus;
9139 package com.redhat.et.libguestfs;
9141 import java.util.HashMap;
9142 import com.redhat.et.libguestfs.LibGuestFSException;
9143 import com.redhat.et.libguestfs.PV;
9144 import com.redhat.et.libguestfs.VG;
9145 import com.redhat.et.libguestfs.LV;
9146 import com.redhat.et.libguestfs.Stat;
9147 import com.redhat.et.libguestfs.StatVFS;
9148 import com.redhat.et.libguestfs.IntBool;
9149 import com.redhat.et.libguestfs.Dirent;
9152 * The GuestFS object is a libguestfs handle.
9156 public class GuestFS {
9157 // Load the native code.
9159 System.loadLibrary (\"guestfs_jni\");
9163 * The native guestfs_h pointer.
9168 * Create a libguestfs handle.
9170 * @throws LibGuestFSException
9172 public GuestFS () throws LibGuestFSException
9176 private native long _create () throws LibGuestFSException;
9179 * Close a libguestfs handle.
9181 * You can also leave handles to be collected by the garbage
9182 * collector, but this method ensures that the resources used
9183 * by the handle are freed up immediately. If you call any
9184 * other methods after closing the handle, you will get an
9187 * @throws LibGuestFSException
9189 public void close () throws LibGuestFSException
9195 private native void _close (long g) throws LibGuestFSException;
9197 public void finalize () throws LibGuestFSException
9205 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9206 if not (List.mem NotInDocs flags); then (
9207 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9209 if List.mem ProtocolLimitWarning flags then
9210 doc ^ "\n\n" ^ protocol_limit_warning
9213 if List.mem DangerWillRobinson flags then
9214 doc ^ "\n\n" ^ danger_will_robinson
9217 match deprecation_notice flags with
9219 | Some txt -> doc ^ "\n\n" ^ txt in
9220 let doc = pod2text ~width:60 name doc in
9221 let doc = List.map ( (* RHBZ#501883 *)
9224 | nonempty -> nonempty
9226 let doc = String.concat "\n * " doc in
9229 pr " * %s\n" shortdesc;
9232 pr " * @throws LibGuestFSException\n";
9236 generate_java_prototype ~public:true ~semicolon:false name style;
9239 pr " if (g == 0)\n";
9240 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9243 if fst style <> RErr then pr "return ";
9245 generate_java_call_args ~handle:"g" (snd style);
9249 generate_java_prototype ~privat:true ~native:true name style;
9256 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9257 and generate_java_call_args ~handle args =
9259 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9262 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9263 ?(semicolon=true) name style =
9264 if privat then pr "private ";
9265 if public then pr "public ";
9266 if native then pr "native ";
9269 (match fst style with
9270 | RErr -> pr "void ";
9271 | RInt _ -> pr "int ";
9272 | RInt64 _ -> pr "long ";
9273 | RBool _ -> pr "boolean ";
9274 | RConstString _ | RConstOptString _ | RString _
9275 | RBufferOut _ -> pr "String ";
9276 | RStringList _ -> pr "String[] ";
9277 | RStruct (_, typ) ->
9278 let name = java_name_of_struct typ in
9280 | RStructList (_, typ) ->
9281 let name = java_name_of_struct typ in
9283 | RHashtable _ -> pr "HashMap<String,String> ";
9286 if native then pr "_%s " name else pr "%s " name;
9288 let needs_comma = ref false in
9297 if !needs_comma then pr ", ";
9298 needs_comma := true;
9302 | Device n | Dev_or_Path n
9308 | StringList n | DeviceList n ->
9319 pr " throws LibGuestFSException";
9320 if semicolon then pr ";"
9322 and generate_java_struct jtyp cols () =
9323 generate_header CStyle LGPLv2plus;
9326 package com.redhat.et.libguestfs;
9329 * Libguestfs %s structure.
9341 | name, FBuffer -> pr " public String %s;\n" name
9342 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9343 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9344 | name, FChar -> pr " public char %s;\n" name
9345 | name, FOptPercent ->
9346 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9347 pr " public float %s;\n" name
9352 and generate_java_c () =
9353 generate_header CStyle LGPLv2plus;
9360 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9361 #include \"guestfs.h\"
9363 /* Note that this function returns. The exception is not thrown
9364 * until after the wrapper function returns.
9367 throw_exception (JNIEnv *env, const char *msg)
9370 cl = (*env)->FindClass (env,
9371 \"com/redhat/et/libguestfs/LibGuestFSException\");
9372 (*env)->ThrowNew (env, cl, msg);
9375 JNIEXPORT jlong JNICALL
9376 Java_com_redhat_et_libguestfs_GuestFS__1create
9377 (JNIEnv *env, jobject obj)
9381 g = guestfs_create ();
9383 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9386 guestfs_set_error_handler (g, NULL, NULL);
9387 return (jlong) (long) g;
9390 JNIEXPORT void JNICALL
9391 Java_com_redhat_et_libguestfs_GuestFS__1close
9392 (JNIEnv *env, jobject obj, jlong jg)
9394 guestfs_h *g = (guestfs_h *) (long) jg;
9401 fun (name, style, _, _, _, _, _) ->
9403 (match fst style with
9404 | RErr -> pr "void ";
9405 | RInt _ -> pr "jint ";
9406 | RInt64 _ -> pr "jlong ";
9407 | RBool _ -> pr "jboolean ";
9408 | RConstString _ | RConstOptString _ | RString _
9409 | RBufferOut _ -> pr "jstring ";
9410 | RStruct _ | RHashtable _ ->
9412 | RStringList _ | RStructList _ ->
9416 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9417 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9419 pr " (JNIEnv *env, jobject obj, jlong jg";
9423 | Device n | Dev_or_Path n
9428 pr ", jstring j%s" n
9429 | StringList n | DeviceList n ->
9430 pr ", jobjectArray j%s" n
9432 pr ", jboolean j%s" n
9440 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9441 let error_code, no_ret =
9442 match fst style with
9443 | RErr -> pr " int r;\n"; "-1", ""
9445 | RInt _ -> pr " int r;\n"; "-1", "0"
9446 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9447 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9448 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9450 pr " jstring jr;\n";
9451 pr " char *r;\n"; "NULL", "NULL"
9453 pr " jobjectArray jr;\n";
9456 pr " jstring jstr;\n";
9457 pr " char **r;\n"; "NULL", "NULL"
9458 | RStruct (_, typ) ->
9459 pr " jobject jr;\n";
9461 pr " jfieldID fl;\n";
9462 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9463 | RStructList (_, typ) ->
9464 pr " jobjectArray jr;\n";
9466 pr " jfieldID fl;\n";
9467 pr " jobject jfl;\n";
9468 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9469 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9471 pr " jstring jr;\n";
9473 pr " size_t size;\n";
9478 | Device n | Dev_or_Path n
9483 pr " const char *%s;\n" n
9484 | StringList n | DeviceList n ->
9485 pr " int %s_len;\n" n;
9486 pr " const char **%s;\n" n
9491 pr " int64_t %s;\n" n
9495 (match fst style with
9496 | RStringList _ | RStructList _ -> true
9497 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9499 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9500 List.exists (function
9501 | StringList _ -> true
9502 | DeviceList _ -> true
9503 | _ -> false) (snd style) in
9509 (* Get the parameters. *)
9513 | Device n | Dev_or_Path n
9517 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9519 (* This is completely undocumented, but Java null becomes
9522 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9523 | StringList n | DeviceList n ->
9524 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9525 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9526 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9527 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9529 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9531 pr " %s[%s_len] = NULL;\n" n n;
9535 pr " %s = j%s;\n" n n
9538 (* Make the call. *)
9539 pr " r = guestfs_%s " name;
9540 generate_c_call_args ~handle:"g" style;
9543 (* Release the parameters. *)
9547 | Device n | Dev_or_Path n
9551 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9554 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9555 | StringList n | DeviceList n ->
9556 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9557 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9559 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
9561 pr " free (%s);\n" n
9567 (* Check for errors. *)
9568 pr " if (r == %s) {\n" error_code;
9569 pr " throw_exception (env, guestfs_last_error (g));\n";
9570 pr " return %s;\n" no_ret;
9574 (match fst style with
9576 | RInt _ -> pr " return (jint) r;\n"
9577 | RBool _ -> pr " return (jboolean) r;\n"
9578 | RInt64 _ -> pr " return (jlong) r;\n"
9579 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
9580 | RConstOptString _ ->
9581 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
9583 pr " jr = (*env)->NewStringUTF (env, r);\n";
9587 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
9588 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
9589 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
9590 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
9591 pr " for (i = 0; i < r_len; ++i) {\n";
9592 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
9593 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
9594 pr " free (r[i]);\n";
9598 | RStruct (_, typ) ->
9599 let jtyp = java_name_of_struct typ in
9600 let cols = cols_of_struct typ in
9601 generate_java_struct_return typ jtyp cols
9602 | RStructList (_, typ) ->
9603 let jtyp = java_name_of_struct typ in
9604 let cols = cols_of_struct typ in
9605 generate_java_struct_list_return typ jtyp cols
9608 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
9609 pr " return NULL;\n"
9611 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
9620 and generate_java_struct_return typ jtyp cols =
9621 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9622 pr " jr = (*env)->AllocObject (env, cl);\n";
9626 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9627 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
9630 pr " char s[33];\n";
9631 pr " memcpy (s, r->%s, 32);\n" name;
9633 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9634 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9638 pr " int len = r->%s_len;\n" name;
9639 pr " char s[len+1];\n";
9640 pr " memcpy (s, r->%s, len);\n" name;
9641 pr " s[len] = 0;\n";
9642 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9643 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9645 | name, (FBytes|FUInt64|FInt64) ->
9646 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9647 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9648 | name, (FUInt32|FInt32) ->
9649 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9650 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9651 | name, FOptPercent ->
9652 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9653 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
9655 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9656 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9661 and generate_java_struct_list_return typ jtyp cols =
9662 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9663 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
9664 pr " for (i = 0; i < r->len; ++i) {\n";
9665 pr " jfl = (*env)->AllocObject (env, cl);\n";
9669 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9670 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
9673 pr " char s[33];\n";
9674 pr " memcpy (s, r->val[i].%s, 32);\n" name;
9676 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9677 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9681 pr " int len = r->val[i].%s_len;\n" name;
9682 pr " char s[len+1];\n";
9683 pr " memcpy (s, r->val[i].%s, len);\n" name;
9684 pr " s[len] = 0;\n";
9685 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9686 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9688 | name, (FBytes|FUInt64|FInt64) ->
9689 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9690 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9691 | name, (FUInt32|FInt32) ->
9692 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9693 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9694 | name, FOptPercent ->
9695 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9696 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
9698 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9699 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9701 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
9703 pr " guestfs_free_%s_list (r);\n" typ;
9706 and generate_java_makefile_inc () =
9707 generate_header HashStyle GPLv2plus;
9709 pr "java_built_sources = \\\n";
9712 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
9714 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
9716 and generate_haskell_hs () =
9717 generate_header HaskellStyle LGPLv2plus;
9719 (* XXX We only know how to generate partial FFI for Haskell
9720 * at the moment. Please help out!
9722 let can_generate style =
9726 | RInt64 _, _ -> true
9729 | RConstOptString _, _
9735 | RBufferOut _, _ -> false in
9738 {-# INCLUDE <guestfs.h> #-}
9739 {-# LANGUAGE ForeignFunctionInterface #-}
9744 (* List out the names of the actions we want to export. *)
9746 fun (name, style, _, _, _, _, _) ->
9747 if can_generate style then pr ",\n %s" name
9753 -- Unfortunately some symbols duplicate ones already present
9754 -- in Prelude. We don't know which, so we hard-code a list
9756 import Prelude hiding (truncate)
9760 import Foreign.C.Types
9762 import Control.Exception
9763 import Data.Typeable
9765 data GuestfsS = GuestfsS -- represents the opaque C struct
9766 type GuestfsP = Ptr GuestfsS -- guestfs_h *
9767 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
9769 -- XXX define properly later XXX
9773 data IntBool = IntBool
9775 data StatVFS = StatVFS
9776 data Hashtable = Hashtable
9778 foreign import ccall unsafe \"guestfs_create\" c_create
9780 foreign import ccall unsafe \"&guestfs_close\" c_close
9781 :: FunPtr (GuestfsP -> IO ())
9782 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
9783 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
9785 create :: IO GuestfsH
9788 c_set_error_handler p nullPtr nullPtr
9789 h <- newForeignPtr c_close p
9792 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
9793 :: GuestfsP -> IO CString
9795 -- last_error :: GuestfsH -> IO (Maybe String)
9796 -- last_error h = do
9797 -- str <- withForeignPtr h (\\p -> c_last_error p)
9798 -- maybePeek peekCString str
9800 last_error :: GuestfsH -> IO (String)
9802 str <- withForeignPtr h (\\p -> c_last_error p)
9804 then return \"no error\"
9805 else peekCString str
9809 (* Generate wrappers for each foreign function. *)
9811 fun (name, style, _, _, _, _, _) ->
9812 if can_generate style then (
9813 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
9815 generate_haskell_prototype ~handle:"GuestfsP" style;
9819 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
9821 pr "%s %s = do\n" name
9822 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
9824 (* Convert pointer arguments using with* functions. *)
9829 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
9830 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
9831 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
9832 | Bool _ | Int _ | Int64 _ -> ()
9834 (* Convert integer arguments. *)
9838 | Bool n -> sprintf "(fromBool %s)" n
9839 | Int n -> sprintf "(fromIntegral %s)" n
9840 | Int64 n -> sprintf "(fromIntegral %s)" n
9841 | FileIn n | FileOut n
9842 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
9844 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
9845 (String.concat " " ("p" :: args));
9846 (match fst style with
9847 | RErr | RInt _ | RInt64 _ | RBool _ ->
9848 pr " if (r == -1)\n";
9850 pr " err <- last_error h\n";
9852 | RConstString _ | RConstOptString _ | RString _
9853 | RStringList _ | RStruct _
9854 | RStructList _ | RHashtable _ | RBufferOut _ ->
9855 pr " if (r == nullPtr)\n";
9857 pr " err <- last_error h\n";
9860 (match fst style with
9862 pr " else return ()\n"
9864 pr " else return (fromIntegral r)\n"
9866 pr " else return (fromIntegral r)\n"
9868 pr " else return (toBool r)\n"
9877 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
9883 and generate_haskell_prototype ~handle ?(hs = false) style =
9885 let string = if hs then "String" else "CString" in
9886 let int = if hs then "Int" else "CInt" in
9887 let bool = if hs then "Bool" else "CInt" in
9888 let int64 = if hs then "Integer" else "Int64" in
9892 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
9893 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
9894 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
9895 | Bool _ -> pr "%s" bool
9896 | Int _ -> pr "%s" int
9897 | Int64 _ -> pr "%s" int
9898 | FileIn _ -> pr "%s" string
9899 | FileOut _ -> pr "%s" string
9904 (match fst style with
9905 | RErr -> if not hs then pr "CInt"
9906 | RInt _ -> pr "%s" int
9907 | RInt64 _ -> pr "%s" int64
9908 | RBool _ -> pr "%s" bool
9909 | RConstString _ -> pr "%s" string
9910 | RConstOptString _ -> pr "Maybe %s" string
9911 | RString _ -> pr "%s" string
9912 | RStringList _ -> pr "[%s]" string
9913 | RStruct (_, typ) ->
9914 let name = java_name_of_struct typ in
9916 | RStructList (_, typ) ->
9917 let name = java_name_of_struct typ in
9919 | RHashtable _ -> pr "Hashtable"
9920 | RBufferOut _ -> pr "%s" string
9924 and generate_csharp () =
9925 generate_header CPlusPlusStyle LGPLv2plus;
9927 (* XXX Make this configurable by the C# assembly users. *)
9928 let library = "libguestfs.so.0" in
9933 using System.Runtime.InteropServices;
9934 using System.Runtime.Serialization;
9935 using System.Collections;
9939 class Error : System.ApplicationException
9941 public Error (string message) : base (message) {}
9942 protected Error (SerializationInfo info, StreamingContext context) {}
9949 [DllImport (\"%s\")]
9950 static extern IntPtr guestfs_create ();
9954 _handle = guestfs_create ();
9955 if (_handle == IntPtr.Zero)
9956 throw new Error (\"could not create guestfs handle\");
9959 [DllImport (\"%s\")]
9960 static extern void guestfs_close (IntPtr h);
9964 guestfs_close (_handle);
9967 [DllImport (\"%s\")]
9968 static extern string guestfs_last_error (IntPtr h);
9970 " library library library;
9972 (* Generate C# structure bindings. We prefix struct names with
9973 * underscore because C# cannot have conflicting struct names and
9974 * method names (eg. "class stat" and "stat").
9978 pr " [StructLayout (LayoutKind.Sequential)]\n";
9979 pr " public class _%s {\n" typ;
9982 | name, FChar -> pr " char %s;\n" name
9983 | name, FString -> pr " string %s;\n" name
9985 pr " uint %s_len;\n" name;
9986 pr " string %s;\n" name
9988 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
9989 pr " string %s;\n" name
9990 | name, FUInt32 -> pr " uint %s;\n" name
9991 | name, FInt32 -> pr " int %s;\n" name
9992 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
9993 | name, FInt64 -> pr " long %s;\n" name
9994 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10000 (* Generate C# function bindings. *)
10002 fun (name, style, _, _, _, shortdesc, _) ->
10003 let rec csharp_return_type () =
10004 match fst style with
10006 | RBool n -> "bool"
10008 | RInt64 n -> "long"
10010 | RConstOptString n
10012 | RBufferOut n -> "string"
10013 | RStruct (_,n) -> "_" ^ n
10014 | RHashtable n -> "Hashtable"
10015 | RStringList n -> "string[]"
10016 | RStructList (_,n) -> sprintf "_%s[]" n
10018 and c_return_type () =
10019 match fst style with
10023 | RInt64 _ -> "long"
10025 | RConstOptString _
10027 | RBufferOut _ -> "string"
10028 | RStruct (_,n) -> "_" ^ n
10030 | RStringList _ -> "string[]"
10031 | RStructList (_,n) -> sprintf "_%s[]" n
10033 and c_error_comparison () =
10034 match fst style with
10038 | RInt64 _ -> "== -1"
10040 | RConstOptString _
10046 | RStructList (_,_) -> "== null"
10048 and generate_extern_prototype () =
10049 pr " static extern %s guestfs_%s (IntPtr h"
10050 (c_return_type ()) name;
10053 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10054 | FileIn n | FileOut n ->
10055 pr ", [In] string %s" n
10056 | StringList n | DeviceList n ->
10057 pr ", [In] string[] %s" n
10067 and generate_public_prototype () =
10068 pr " public %s %s (" (csharp_return_type ()) name;
10069 let comma = ref false in
10071 if !comma then pr ", ";
10076 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10077 | FileIn n | FileOut n ->
10078 next (); pr "string %s" n
10079 | StringList n | DeviceList n ->
10080 next (); pr "string[] %s" n
10082 next (); pr "bool %s" n
10084 next (); pr "int %s" n
10086 next (); pr "long %s" n
10090 and generate_call () =
10091 pr "guestfs_%s (_handle" name;
10092 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10096 pr " [DllImport (\"%s\")]\n" library;
10097 generate_extern_prototype ();
10099 pr " /// <summary>\n";
10100 pr " /// %s\n" shortdesc;
10101 pr " /// </summary>\n";
10102 generate_public_prototype ();
10104 pr " %s r;\n" (c_return_type ());
10107 pr " if (r %s)\n" (c_error_comparison ());
10108 pr " throw new Error (\"%s: \" + guestfs_last_error (_handle));\n"
10110 (match fst style with
10113 pr " return r != 0 ? true : false;\n"
10115 pr " Hashtable rr = new Hashtable ();\n";
10116 pr " for (int i = 0; i < r.Length; i += 2)\n";
10117 pr " rr.Add (r[i], r[i+1]);\n";
10119 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10120 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10126 ) all_functions_sorted;
10132 and generate_bindtests () =
10133 generate_header CStyle LGPLv2plus;
10137 #include <stdlib.h>
10138 #include <inttypes.h>
10139 #include <string.h>
10141 #include \"guestfs.h\"
10142 #include \"guestfs-internal.h\"
10143 #include \"guestfs-internal-actions.h\"
10144 #include \"guestfs_protocol.h\"
10146 #define error guestfs_error
10147 #define safe_calloc guestfs_safe_calloc
10148 #define safe_malloc guestfs_safe_malloc
10151 print_strings (char *const *argv)
10156 for (argc = 0; argv[argc] != NULL; ++argc) {
10157 if (argc > 0) printf (\", \");
10158 printf (\"\\\"%%s\\\"\", argv[argc]);
10163 /* The test0 function prints its parameters to stdout. */
10167 match test_functions with
10168 | [] -> assert false
10169 | test0 :: tests -> test0, tests in
10172 let (name, style, _, _, _, _, _) = test0 in
10173 generate_prototype ~extern:false ~semicolon:false ~newline:true
10174 ~handle:"g" ~prefix:"guestfs__" name style;
10179 | Device n | Dev_or_Path n
10182 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10183 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10184 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10185 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10186 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10187 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10189 pr " /* Java changes stdout line buffering so we need this: */\n";
10190 pr " fflush (stdout);\n";
10196 fun (name, style, _, _, _, _, _) ->
10197 if String.sub name (String.length name - 3) 3 <> "err" then (
10198 pr "/* Test normal return. */\n";
10199 generate_prototype ~extern:false ~semicolon:false ~newline:true
10200 ~handle:"g" ~prefix:"guestfs__" name style;
10202 (match fst style with
10207 pr " sscanf (val, \"%%d\", &r);\n";
10210 pr " int64_t r;\n";
10211 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10214 pr " return STREQ (val, \"true\");\n"
10216 | RConstOptString _ ->
10217 (* Can't return the input string here. Return a static
10218 * string so we ensure we get a segfault if the caller
10219 * tries to free it.
10221 pr " return \"static string\";\n"
10223 pr " return strdup (val);\n"
10225 pr " char **strs;\n";
10227 pr " sscanf (val, \"%%d\", &n);\n";
10228 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10229 pr " for (i = 0; i < n; ++i) {\n";
10230 pr " strs[i] = safe_malloc (g, 16);\n";
10231 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10233 pr " strs[n] = NULL;\n";
10234 pr " return strs;\n"
10235 | RStruct (_, typ) ->
10236 pr " struct guestfs_%s *r;\n" typ;
10237 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10239 | RStructList (_, typ) ->
10240 pr " struct guestfs_%s_list *r;\n" typ;
10241 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10242 pr " sscanf (val, \"%%d\", &r->len);\n";
10243 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10246 pr " char **strs;\n";
10248 pr " sscanf (val, \"%%d\", &n);\n";
10249 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10250 pr " for (i = 0; i < n; ++i) {\n";
10251 pr " strs[i*2] = safe_malloc (g, 16);\n";
10252 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10253 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10254 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10256 pr " strs[n*2] = NULL;\n";
10257 pr " return strs;\n"
10259 pr " return strdup (val);\n"
10264 pr "/* Test error return. */\n";
10265 generate_prototype ~extern:false ~semicolon:false ~newline:true
10266 ~handle:"g" ~prefix:"guestfs__" name style;
10268 pr " error (g, \"error\");\n";
10269 (match fst style with
10270 | RErr | RInt _ | RInt64 _ | RBool _ ->
10272 | RConstString _ | RConstOptString _
10273 | RString _ | RStringList _ | RStruct _
10277 pr " return NULL;\n"
10284 and generate_ocaml_bindtests () =
10285 generate_header OCamlStyle GPLv2plus;
10289 let g = Guestfs.create () in
10293 String.concat " " (
10296 | CallString s -> "\"" ^ s ^ "\""
10297 | CallOptString None -> "None"
10298 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10299 | CallStringList xs ->
10300 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10301 | CallInt i when i >= 0 -> string_of_int i
10302 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10303 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10304 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10305 | CallBool b -> string_of_bool b
10310 generate_lang_bindtests (
10311 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10314 pr "print_endline \"EOF\"\n"
10316 and generate_perl_bindtests () =
10317 pr "#!/usr/bin/perl -w\n";
10318 generate_header HashStyle GPLv2plus;
10325 my $g = Sys::Guestfs->new ();
10329 String.concat ", " (
10332 | CallString s -> "\"" ^ s ^ "\""
10333 | CallOptString None -> "undef"
10334 | CallOptString (Some s) -> sprintf "\"%s\"" s
10335 | CallStringList xs ->
10336 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10337 | CallInt i -> string_of_int i
10338 | CallInt64 i -> Int64.to_string i
10339 | CallBool b -> if b then "1" else "0"
10344 generate_lang_bindtests (
10345 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10348 pr "print \"EOF\\n\"\n"
10350 and generate_python_bindtests () =
10351 generate_header HashStyle GPLv2plus;
10356 g = guestfs.GuestFS ()
10360 String.concat ", " (
10363 | CallString s -> "\"" ^ s ^ "\""
10364 | CallOptString None -> "None"
10365 | CallOptString (Some s) -> sprintf "\"%s\"" s
10366 | CallStringList xs ->
10367 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10368 | CallInt i -> string_of_int i
10369 | CallInt64 i -> Int64.to_string i
10370 | CallBool b -> if b then "1" else "0"
10375 generate_lang_bindtests (
10376 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10379 pr "print \"EOF\"\n"
10381 and generate_ruby_bindtests () =
10382 generate_header HashStyle GPLv2plus;
10387 g = Guestfs::create()
10391 String.concat ", " (
10394 | CallString s -> "\"" ^ s ^ "\""
10395 | CallOptString None -> "nil"
10396 | CallOptString (Some s) -> sprintf "\"%s\"" s
10397 | CallStringList xs ->
10398 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10399 | CallInt i -> string_of_int i
10400 | CallInt64 i -> Int64.to_string i
10401 | CallBool b -> string_of_bool b
10406 generate_lang_bindtests (
10407 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10410 pr "print \"EOF\\n\"\n"
10412 and generate_java_bindtests () =
10413 generate_header CStyle GPLv2plus;
10416 import com.redhat.et.libguestfs.*;
10418 public class Bindtests {
10419 public static void main (String[] argv)
10422 GuestFS g = new GuestFS ();
10426 String.concat ", " (
10429 | CallString s -> "\"" ^ s ^ "\""
10430 | CallOptString None -> "null"
10431 | CallOptString (Some s) -> sprintf "\"%s\"" s
10432 | CallStringList xs ->
10434 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10435 | CallInt i -> string_of_int i
10436 | CallInt64 i -> Int64.to_string i
10437 | CallBool b -> string_of_bool b
10442 generate_lang_bindtests (
10443 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10447 System.out.println (\"EOF\");
10449 catch (Exception exn) {
10450 System.err.println (exn);
10457 and generate_haskell_bindtests () =
10458 generate_header HaskellStyle GPLv2plus;
10461 module Bindtests where
10462 import qualified Guestfs
10465 g <- Guestfs.create
10469 String.concat " " (
10472 | CallString s -> "\"" ^ s ^ "\""
10473 | CallOptString None -> "Nothing"
10474 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10475 | CallStringList xs ->
10476 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10477 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10478 | CallInt i -> string_of_int i
10479 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10480 | CallInt64 i -> Int64.to_string i
10481 | CallBool true -> "True"
10482 | CallBool false -> "False"
10487 generate_lang_bindtests (
10488 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10491 pr " putStrLn \"EOF\"\n"
10493 (* Language-independent bindings tests - we do it this way to
10494 * ensure there is parity in testing bindings across all languages.
10496 and generate_lang_bindtests call =
10497 call "test0" [CallString "abc"; CallOptString (Some "def");
10498 CallStringList []; CallBool false;
10499 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10500 call "test0" [CallString "abc"; CallOptString None;
10501 CallStringList []; CallBool false;
10502 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10503 call "test0" [CallString ""; CallOptString (Some "def");
10504 CallStringList []; CallBool false;
10505 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10506 call "test0" [CallString ""; CallOptString (Some "");
10507 CallStringList []; CallBool false;
10508 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10509 call "test0" [CallString "abc"; CallOptString (Some "def");
10510 CallStringList ["1"]; CallBool false;
10511 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10512 call "test0" [CallString "abc"; CallOptString (Some "def");
10513 CallStringList ["1"; "2"]; CallBool false;
10514 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10515 call "test0" [CallString "abc"; CallOptString (Some "def");
10516 CallStringList ["1"]; CallBool true;
10517 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10518 call "test0" [CallString "abc"; CallOptString (Some "def");
10519 CallStringList ["1"]; CallBool false;
10520 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
10521 call "test0" [CallString "abc"; CallOptString (Some "def");
10522 CallStringList ["1"]; CallBool false;
10523 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
10524 call "test0" [CallString "abc"; CallOptString (Some "def");
10525 CallStringList ["1"]; CallBool false;
10526 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
10527 call "test0" [CallString "abc"; CallOptString (Some "def");
10528 CallStringList ["1"]; CallBool false;
10529 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
10530 call "test0" [CallString "abc"; CallOptString (Some "def");
10531 CallStringList ["1"]; CallBool false;
10532 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
10533 call "test0" [CallString "abc"; CallOptString (Some "def");
10534 CallStringList ["1"]; CallBool false;
10535 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
10537 (* XXX Add here tests of the return and error functions. *)
10539 (* Code to generator bindings for virt-inspector. Currently only
10540 * implemented for OCaml code (for virt-p2v 2.0).
10542 let rng_input = "inspector/virt-inspector.rng"
10544 (* Read the input file and parse it into internal structures. This is
10545 * by no means a complete RELAX NG parser, but is just enough to be
10546 * able to parse the specific input file.
10549 | Element of string * rng list (* <element name=name/> *)
10550 | Attribute of string * rng list (* <attribute name=name/> *)
10551 | Interleave of rng list (* <interleave/> *)
10552 | ZeroOrMore of rng (* <zeroOrMore/> *)
10553 | OneOrMore of rng (* <oneOrMore/> *)
10554 | Optional of rng (* <optional/> *)
10555 | Choice of string list (* <choice><value/>*</choice> *)
10556 | Value of string (* <value>str</value> *)
10557 | Text (* <text/> *)
10559 let rec string_of_rng = function
10560 | Element (name, xs) ->
10561 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10562 | Attribute (name, xs) ->
10563 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10564 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
10565 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
10566 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
10567 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
10568 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
10569 | Value value -> "Value \"" ^ value ^ "\""
10572 and string_of_rng_list xs =
10573 String.concat ", " (List.map string_of_rng xs)
10575 let rec parse_rng ?defines context = function
10577 | Xml.Element ("element", ["name", name], children) :: rest ->
10578 Element (name, parse_rng ?defines context children)
10579 :: parse_rng ?defines context rest
10580 | Xml.Element ("attribute", ["name", name], children) :: rest ->
10581 Attribute (name, parse_rng ?defines context children)
10582 :: parse_rng ?defines context rest
10583 | Xml.Element ("interleave", [], children) :: rest ->
10584 Interleave (parse_rng ?defines context children)
10585 :: parse_rng ?defines context rest
10586 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
10587 let rng = parse_rng ?defines context [child] in
10589 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
10591 failwithf "%s: <zeroOrMore> contains more than one child element"
10594 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
10595 let rng = parse_rng ?defines context [child] in
10597 | [child] -> OneOrMore child :: parse_rng ?defines context rest
10599 failwithf "%s: <oneOrMore> contains more than one child element"
10602 | Xml.Element ("optional", [], [child]) :: rest ->
10603 let rng = parse_rng ?defines context [child] in
10605 | [child] -> Optional child :: parse_rng ?defines context rest
10607 failwithf "%s: <optional> contains more than one child element"
10610 | Xml.Element ("choice", [], children) :: rest ->
10611 let values = List.map (
10612 function Xml.Element ("value", [], [Xml.PCData value]) -> value
10614 failwithf "%s: can't handle anything except <value> in <choice>"
10618 :: parse_rng ?defines context rest
10619 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
10620 Value value :: parse_rng ?defines context rest
10621 | Xml.Element ("text", [], []) :: rest ->
10622 Text :: parse_rng ?defines context rest
10623 | Xml.Element ("ref", ["name", name], []) :: rest ->
10624 (* Look up the reference. Because of limitations in this parser,
10625 * we can't handle arbitrarily nested <ref> yet. You can only
10626 * use <ref> from inside <start>.
10628 (match defines with
10630 failwithf "%s: contains <ref>, but no refs are defined yet" context
10632 let rng = StringMap.find name map in
10633 rng @ parse_rng ?defines context rest
10636 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
10639 let xml = Xml.parse_file rng_input in
10641 | Xml.Element ("grammar", _,
10642 Xml.Element ("start", _, gram) :: defines) ->
10643 (* The <define/> elements are referenced in the <start> section,
10644 * so build a map of those first.
10646 let defines = List.fold_left (
10648 function Xml.Element ("define", ["name", name], defn) ->
10649 StringMap.add name defn map
10651 failwithf "%s: expected <define name=name/>" rng_input
10652 ) StringMap.empty defines in
10653 let defines = StringMap.mapi parse_rng defines in
10655 (* Parse the <start> clause, passing the defines. *)
10656 parse_rng ~defines "<start>" gram
10658 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
10661 let name_of_field = function
10662 | Element (name, _) | Attribute (name, _)
10663 | ZeroOrMore (Element (name, _))
10664 | OneOrMore (Element (name, _))
10665 | Optional (Element (name, _)) -> name
10666 | Optional (Attribute (name, _)) -> name
10667 | Text -> (* an unnamed field in an element *)
10670 failwithf "name_of_field failed at: %s" (string_of_rng rng)
10672 (* At the moment this function only generates OCaml types. However we
10673 * should parameterize it later so it can generate types/structs in a
10674 * variety of languages.
10676 let generate_types xs =
10677 (* A simple type is one that can be printed out directly, eg.
10678 * "string option". A complex type is one which has a name and has
10679 * to be defined via another toplevel definition, eg. a struct.
10681 * generate_type generates code for either simple or complex types.
10682 * In the simple case, it returns the string ("string option"). In
10683 * the complex case, it returns the name ("mountpoint"). In the
10684 * complex case it has to print out the definition before returning,
10685 * so it should only be called when we are at the beginning of a
10686 * new line (BOL context).
10688 let rec generate_type = function
10689 | Text -> (* string *)
10691 | Choice values -> (* [`val1|`val2|...] *)
10692 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
10693 | ZeroOrMore rng -> (* <rng> list *)
10694 let t, is_simple = generate_type rng in
10695 t ^ " list (* 0 or more *)", is_simple
10696 | OneOrMore rng -> (* <rng> list *)
10697 let t, is_simple = generate_type rng in
10698 t ^ " list (* 1 or more *)", is_simple
10699 (* virt-inspector hack: bool *)
10700 | Optional (Attribute (name, [Value "1"])) ->
10702 | Optional rng -> (* <rng> list *)
10703 let t, is_simple = generate_type rng in
10704 t ^ " option", is_simple
10705 (* type name = { fields ... } *)
10706 | Element (name, fields) when is_attrs_interleave fields ->
10707 generate_type_struct name (get_attrs_interleave fields)
10708 | Element (name, [field]) (* type name = field *)
10709 | Attribute (name, [field]) ->
10710 let t, is_simple = generate_type field in
10711 if is_simple then (t, true)
10713 pr "type %s = %s\n" name t;
10716 | Element (name, fields) -> (* type name = { fields ... } *)
10717 generate_type_struct name fields
10719 failwithf "generate_type failed at: %s" (string_of_rng rng)
10721 and is_attrs_interleave = function
10722 | [Interleave _] -> true
10723 | Attribute _ :: fields -> is_attrs_interleave fields
10724 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
10727 and get_attrs_interleave = function
10728 | [Interleave fields] -> fields
10729 | ((Attribute _) as field) :: fields
10730 | ((Optional (Attribute _)) as field) :: fields ->
10731 field :: get_attrs_interleave fields
10732 | _ -> assert false
10734 and generate_types xs =
10735 List.iter (fun x -> ignore (generate_type x)) xs
10737 and generate_type_struct name fields =
10738 (* Calculate the types of the fields first. We have to do this
10739 * before printing anything so we are still in BOL context.
10741 let types = List.map fst (List.map generate_type fields) in
10743 (* Special case of a struct containing just a string and another
10744 * field. Turn it into an assoc list.
10747 | ["string"; other] ->
10748 let fname1, fname2 =
10750 | [f1; f2] -> name_of_field f1, name_of_field f2
10751 | _ -> assert false in
10752 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
10756 pr "type %s = {\n" name;
10758 fun (field, ftype) ->
10759 let fname = name_of_field field in
10760 pr " %s_%s : %s;\n" name fname ftype
10761 ) (List.combine fields types);
10763 (* Return the name of this type, and
10764 * false because it's not a simple type.
10771 let generate_parsers xs =
10772 (* As for generate_type above, generate_parser makes a parser for
10773 * some type, and returns the name of the parser it has generated.
10774 * Because it (may) need to print something, it should always be
10775 * called in BOL context.
10777 let rec generate_parser = function
10778 | Text -> (* string *)
10779 "string_child_or_empty"
10780 | Choice values -> (* [`val1|`val2|...] *)
10781 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
10783 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
10784 | ZeroOrMore rng -> (* <rng> list *)
10785 let pa = generate_parser rng in
10786 sprintf "(fun x -> List.map %s (Xml.children x))" pa
10787 | OneOrMore rng -> (* <rng> list *)
10788 let pa = generate_parser rng in
10789 sprintf "(fun x -> List.map %s (Xml.children x))" pa
10790 (* virt-inspector hack: bool *)
10791 | Optional (Attribute (name, [Value "1"])) ->
10792 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
10793 | Optional rng -> (* <rng> list *)
10794 let pa = generate_parser rng in
10795 sprintf "(function None -> None | Some x -> Some (%s x))" pa
10796 (* type name = { fields ... } *)
10797 | Element (name, fields) when is_attrs_interleave fields ->
10798 generate_parser_struct name (get_attrs_interleave fields)
10799 | Element (name, [field]) -> (* type name = field *)
10800 let pa = generate_parser field in
10801 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
10802 pr "let %s =\n" parser_name;
10804 pr "let parse_%s = %s\n" name parser_name;
10806 | Attribute (name, [field]) ->
10807 let pa = generate_parser field in
10808 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
10809 pr "let %s =\n" parser_name;
10811 pr "let parse_%s = %s\n" name parser_name;
10813 | Element (name, fields) -> (* type name = { fields ... } *)
10814 generate_parser_struct name ([], fields)
10816 failwithf "generate_parser failed at: %s" (string_of_rng rng)
10818 and is_attrs_interleave = function
10819 | [Interleave _] -> true
10820 | Attribute _ :: fields -> is_attrs_interleave fields
10821 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
10824 and get_attrs_interleave = function
10825 | [Interleave fields] -> [], fields
10826 | ((Attribute _) as field) :: fields
10827 | ((Optional (Attribute _)) as field) :: fields ->
10828 let attrs, interleaves = get_attrs_interleave fields in
10829 (field :: attrs), interleaves
10830 | _ -> assert false
10832 and generate_parsers xs =
10833 List.iter (fun x -> ignore (generate_parser x)) xs
10835 and generate_parser_struct name (attrs, interleaves) =
10836 (* Generate parsers for the fields first. We have to do this
10837 * before printing anything so we are still in BOL context.
10839 let fields = attrs @ interleaves in
10840 let pas = List.map generate_parser fields in
10842 (* Generate an intermediate tuple from all the fields first.
10843 * If the type is just a string + another field, then we will
10844 * return this directly, otherwise it is turned into a record.
10846 * RELAX NG note: This code treats <interleave> and plain lists of
10847 * fields the same. In other words, it doesn't bother enforcing
10848 * any ordering of fields in the XML.
10850 pr "let parse_%s x =\n" name;
10851 pr " let t = (\n ";
10852 let comma = ref false in
10855 if !comma then pr ",\n ";
10858 | Optional (Attribute (fname, [field])), pa ->
10860 | Optional (Element (fname, [field])), pa ->
10861 pr "%s (optional_child %S x)" pa fname
10862 | Attribute (fname, [Text]), _ ->
10863 pr "attribute %S x" fname
10864 | (ZeroOrMore _ | OneOrMore _), pa ->
10869 let fname = name_of_field field in
10870 pr "%s (child %S x)" pa fname
10871 ) (List.combine fields pas);
10875 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
10879 pr " (Obj.magic t : %s)\n" name
10883 | (Optional (Attribute (fname, [field])), pa) ->
10884 pr " %s_%s =\n" name fname;
10886 | (Optional (Element (fname, [field])), pa) ->
10887 pr " %s_%s =\n" name fname;
10888 pr " (let x = optional_child %S x in\n" fname;
10891 let fname = name_of_field field in
10892 pr " %s_%s =\n" name fname;
10893 pr " (let x = child %S x in\n" fname;
10895 ) (List.combine fields pas);
10899 sprintf "parse_%s" name
10902 generate_parsers xs
10904 (* Generate ocaml/guestfs_inspector.mli. *)
10905 let generate_ocaml_inspector_mli () =
10906 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
10909 (** This is an OCaml language binding to the external [virt-inspector]
10912 For more information, please read the man page [virt-inspector(1)].
10917 generate_types grammar;
10918 pr "(** The nested information returned from the {!inspect} function. *)\n";
10922 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
10923 (** To inspect a libvirt domain called [name], pass a singleton
10924 list: [inspect [name]]. When using libvirt only, you may
10925 optionally pass a libvirt URI using [inspect ~connect:uri ...].
10927 To inspect a disk image or images, pass a list of the filenames
10928 of the disk images: [inspect filenames]
10930 This function inspects the given guest or disk images and
10931 returns a list of operating system(s) found and a large amount
10932 of information about them. In the vast majority of cases,
10933 a virtual machine only contains a single operating system.
10935 If the optional [~xml] parameter is given, then this function
10936 skips running the external virt-inspector program and just
10937 parses the given XML directly (which is expected to be XML
10938 produced from a previous run of virt-inspector). The list of
10939 names and connect URI are ignored in this case.
10941 This function can throw a wide variety of exceptions, for example
10942 if the external virt-inspector program cannot be found, or if
10943 it doesn't generate valid XML.
10947 (* Generate ocaml/guestfs_inspector.ml. *)
10948 let generate_ocaml_inspector_ml () =
10949 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
10954 generate_types grammar;
10958 (* Misc functions which are used by the parser code below. *)
10959 let first_child = function
10960 | Xml.Element (_, _, c::_) -> c
10961 | Xml.Element (name, _, []) ->
10962 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
10963 | Xml.PCData str ->
10964 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
10966 let string_child_or_empty = function
10967 | Xml.Element (_, _, [Xml.PCData s]) -> s
10968 | Xml.Element (_, _, []) -> \"\"
10969 | Xml.Element (x, _, _) ->
10970 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
10972 | Xml.PCData str ->
10973 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
10975 let optional_child name xml =
10976 let children = Xml.children xml in
10978 Some (List.find (function
10979 | Xml.Element (n, _, _) when n = name -> true
10980 | _ -> false) children)
10984 let child name xml =
10985 match optional_child name xml with
10988 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
10990 let attribute name xml =
10991 try Xml.attrib xml name
10992 with Xml.No_attribute _ ->
10993 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
10997 generate_parsers grammar;
11001 (* Run external virt-inspector, then use parser to parse the XML. *)
11002 let inspect ?connect ?xml names =
11006 if names = [] then invalid_arg \"inspect: no names given\";
11007 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11008 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11010 let cmd = List.map Filename.quote cmd in
11011 let cmd = String.concat \" \" cmd in
11012 let chan = open_process_in cmd in
11013 let xml = Xml.parse_in chan in
11014 (match close_process_in chan with
11016 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11017 | WSIGNALED i | WSTOPPED i ->
11018 failwith (\"external virt-inspector command died or stopped on sig \" ^
11023 Xml.parse_string doc in
11024 parse_operatingsystems xml
11027 (* This is used to generate the src/MAX_PROC_NR file which
11028 * contains the maximum procedure number, a surrogate for the
11029 * ABI version number. See src/Makefile.am for the details.
11031 and generate_max_proc_nr () =
11032 let proc_nrs = List.map (
11033 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11034 ) daemon_functions in
11036 let max_proc_nr = List.fold_left max 0 proc_nrs in
11038 pr "%d\n" max_proc_nr
11040 let output_to filename k =
11041 let filename_new = filename ^ ".new" in
11042 chan := open_out filename_new;
11045 chan := Pervasives.stdout;
11047 (* Is the new file different from the current file? *)
11048 if Sys.file_exists filename && files_equal filename filename_new then
11049 unlink filename_new (* same, so skip it *)
11051 (* different, overwrite old one *)
11052 (try chmod filename 0o644 with Unix_error _ -> ());
11053 rename filename_new filename;
11054 chmod filename 0o444;
11055 printf "written %s\n%!" filename;
11058 let perror msg = function
11059 | Unix_error (err, _, _) ->
11060 eprintf "%s: %s\n" msg (error_message err)
11062 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11064 (* Main program. *)
11067 try openfile "HACKING" [O_RDWR] 0
11069 | Unix_error (ENOENT, _, _) ->
11071 You are probably running this from the wrong directory.
11072 Run it from the top source directory using the command
11077 perror "open: HACKING" exn;
11080 (* Acquire a lock so parallel builds won't try to run the generator
11081 * twice at the same time. Subsequent builds will wait for the first
11082 * one to finish. Note the lock is released implicitly when the
11085 (try lockf lock_fd F_LOCK 1
11087 perror "lock: HACKING" exn;
11090 check_functions ();
11092 output_to "src/guestfs_protocol.x" generate_xdr;
11093 output_to "src/guestfs-structs.h" generate_structs_h;
11094 output_to "src/guestfs-actions.h" generate_actions_h;
11095 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11096 output_to "src/guestfs-actions.c" generate_client_actions;
11097 output_to "src/guestfs-bindtests.c" generate_bindtests;
11098 output_to "src/guestfs-structs.pod" generate_structs_pod;
11099 output_to "src/guestfs-actions.pod" generate_actions_pod;
11100 output_to "src/guestfs-availability.pod" generate_availability_pod;
11101 output_to "daemon/actions.h" generate_daemon_actions_h;
11102 output_to "daemon/stubs.c" generate_daemon_actions;
11103 output_to "daemon/names.c" generate_daemon_names;
11104 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11105 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11106 output_to "capitests/tests.c" generate_tests;
11107 output_to "fish/cmds.c" generate_fish_cmds;
11108 output_to "fish/completion.c" generate_fish_completion;
11109 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11110 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11111 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11112 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11113 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11114 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11115 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11116 output_to "perl/Guestfs.xs" generate_perl_xs;
11117 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11118 output_to "perl/bindtests.pl" generate_perl_bindtests;
11119 output_to "python/guestfs-py.c" generate_python_c;
11120 output_to "python/guestfs.py" generate_python_py;
11121 output_to "python/bindtests.py" generate_python_bindtests;
11122 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11123 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11124 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11128 let cols = cols_of_struct typ in
11129 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11130 output_to filename (generate_java_struct jtyp cols);
11133 output_to "java/Makefile.inc" generate_java_makefile_inc;
11134 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11135 output_to "java/Bindtests.java" generate_java_bindtests;
11136 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11137 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11138 output_to "csharp/Libguestfs.cs" generate_csharp;
11139 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11141 (* Always generate this file last, and unconditionally. It's used
11142 * by the Makefile to know when we must re-run the generator.
11144 let chan = open_out "src/stamp-generator" in
11145 fprintf chan "1\n";