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.");
4191 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4192 [InitBasicFS, Always, TestOutputInt (
4193 [["write_file"; "/file"; "hello, world"; "0"];
4194 ["filesize"; "/file"]], 12)],
4195 "return the size of the file in bytes",
4197 This command returns the size of C<file> in bytes.
4199 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4200 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4201 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4205 let all_functions = non_daemon_functions @ daemon_functions
4207 (* In some places we want the functions to be displayed sorted
4208 * alphabetically, so this is useful:
4210 let all_functions_sorted =
4211 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4212 compare n1 n2) all_functions
4214 (* Field types for structures. *)
4216 | FChar (* C 'char' (really, a 7 bit byte). *)
4217 | FString (* nul-terminated ASCII string, NOT NULL. *)
4218 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4223 | FBytes (* Any int measure that counts bytes. *)
4224 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4225 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4227 (* Because we generate extra parsing code for LVM command line tools,
4228 * we have to pull out the LVM columns separately here.
4238 "pv_attr", FString (* XXX *);
4239 "pv_pe_count", FInt64;
4240 "pv_pe_alloc_count", FInt64;
4243 "pv_mda_count", FInt64;
4244 "pv_mda_free", FBytes;
4245 (* Not in Fedora 10:
4246 "pv_mda_size", FBytes;
4253 "vg_attr", FString (* XXX *);
4256 "vg_sysid", FString;
4257 "vg_extent_size", FBytes;
4258 "vg_extent_count", FInt64;
4259 "vg_free_count", FInt64;
4264 "snap_count", FInt64;
4267 "vg_mda_count", FInt64;
4268 "vg_mda_free", FBytes;
4269 (* Not in Fedora 10:
4270 "vg_mda_size", FBytes;
4276 "lv_attr", FString (* XXX *);
4279 "lv_kernel_major", FInt64;
4280 "lv_kernel_minor", FInt64;
4282 "seg_count", FInt64;
4284 "snap_percent", FOptPercent;
4285 "copy_percent", FOptPercent;
4288 "mirror_log", FString;
4292 (* Names and fields in all structures (in RStruct and RStructList)
4296 (* The old RIntBool return type, only ever used for aug_defnode. Do
4297 * not use this struct in any new code.
4300 "i", FInt32; (* for historical compatibility *)
4301 "b", FInt32; (* for historical compatibility *)
4304 (* LVM PVs, VGs, LVs. *)
4305 "lvm_pv", lvm_pv_cols;
4306 "lvm_vg", lvm_vg_cols;
4307 "lvm_lv", lvm_lv_cols;
4309 (* Column names and types from stat structures.
4310 * NB. Can't use things like 'st_atime' because glibc header files
4311 * define some of these as macros. Ugh.
4342 (* Column names in dirent structure. *)
4345 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4350 (* Version numbers. *)
4358 (* Extended attribute. *)
4360 "attrname", FString;
4364 (* Inotify events. *)
4368 "in_cookie", FUInt32;
4372 (* Partition table entry. *)
4375 "part_start", FBytes;
4377 "part_size", FBytes;
4379 ] (* end of structs *)
4381 (* Ugh, Java has to be different ..
4382 * These names are also used by the Haskell bindings.
4384 let java_structs = [
4385 "int_bool", "IntBool";
4390 "statvfs", "StatVFS";
4392 "version", "Version";
4394 "inotify_event", "INotifyEvent";
4395 "partition", "Partition";
4398 (* What structs are actually returned. *)
4399 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4401 (* Returns a list of RStruct/RStructList structs that are returned
4402 * by any function. Each element of returned list is a pair:
4404 * (structname, RStructOnly)
4405 * == there exists function which returns RStruct (_, structname)
4406 * (structname, RStructListOnly)
4407 * == there exists function which returns RStructList (_, structname)
4408 * (structname, RStructAndList)
4409 * == there are functions returning both RStruct (_, structname)
4410 * and RStructList (_, structname)
4412 let rstructs_used_by functions =
4413 (* ||| is a "logical OR" for rstructs_used_t *)
4417 | _, RStructAndList -> RStructAndList
4418 | RStructOnly, RStructListOnly
4419 | RStructListOnly, RStructOnly -> RStructAndList
4420 | RStructOnly, RStructOnly -> RStructOnly
4421 | RStructListOnly, RStructListOnly -> RStructListOnly
4424 let h = Hashtbl.create 13 in
4426 (* if elem->oldv exists, update entry using ||| operator,
4427 * else just add elem->newv to the hash
4429 let update elem newv =
4430 try let oldv = Hashtbl.find h elem in
4431 Hashtbl.replace h elem (newv ||| oldv)
4432 with Not_found -> Hashtbl.add h elem newv
4436 fun (_, style, _, _, _, _, _) ->
4437 match fst style with
4438 | RStruct (_, structname) -> update structname RStructOnly
4439 | RStructList (_, structname) -> update structname RStructListOnly
4443 (* return key->values as a list of (key,value) *)
4444 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4446 (* Used for testing language bindings. *)
4448 | CallString of string
4449 | CallOptString of string option
4450 | CallStringList of string list
4452 | CallInt64 of int64
4455 (* Used to memoize the result of pod2text. *)
4456 let pod2text_memo_filename = "src/.pod2text.data"
4457 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4459 let chan = open_in pod2text_memo_filename in
4460 let v = input_value chan in
4464 _ -> Hashtbl.create 13
4465 let pod2text_memo_updated () =
4466 let chan = open_out pod2text_memo_filename in
4467 output_value chan pod2text_memo;
4470 (* Useful functions.
4471 * Note we don't want to use any external OCaml libraries which
4472 * makes this a bit harder than it should be.
4474 module StringMap = Map.Make (String)
4476 let failwithf fs = ksprintf failwith fs
4478 let unique = let i = ref 0 in fun () -> incr i; !i
4480 let replace_char s c1 c2 =
4481 let s2 = String.copy s in
4482 let r = ref false in
4483 for i = 0 to String.length s2 - 1 do
4484 if String.unsafe_get s2 i = c1 then (
4485 String.unsafe_set s2 i c2;
4489 if not !r then s else s2
4493 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4495 let triml ?(test = isspace) str =
4497 let n = ref (String.length str) in
4498 while !n > 0 && test str.[!i]; do
4503 else String.sub str !i !n
4505 let trimr ?(test = isspace) str =
4506 let n = ref (String.length str) in
4507 while !n > 0 && test str.[!n-1]; do
4510 if !n = String.length str then str
4511 else String.sub str 0 !n
4513 let trim ?(test = isspace) str =
4514 trimr ~test (triml ~test str)
4516 let rec find s sub =
4517 let len = String.length s in
4518 let sublen = String.length sub in
4520 if i <= len-sublen then (
4522 if j < sublen then (
4523 if s.[i+j] = sub.[j] then loop2 (j+1)
4529 if r = -1 then loop (i+1) else r
4535 let rec replace_str s s1 s2 =
4536 let len = String.length s in
4537 let sublen = String.length s1 in
4538 let i = find s s1 in
4541 let s' = String.sub s 0 i in
4542 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4543 s' ^ s2 ^ replace_str s'' s1 s2
4546 let rec string_split sep str =
4547 let len = String.length str in
4548 let seplen = String.length sep in
4549 let i = find str sep in
4550 if i = -1 then [str]
4552 let s' = String.sub str 0 i in
4553 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4554 s' :: string_split sep s''
4557 let files_equal n1 n2 =
4558 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4559 match Sys.command cmd with
4562 | i -> failwithf "%s: failed with error code %d" cmd i
4564 let rec filter_map f = function
4568 | Some y -> y :: filter_map f xs
4569 | None -> filter_map f xs
4571 let rec find_map f = function
4572 | [] -> raise Not_found
4576 | None -> find_map f xs
4579 let rec loop i = function
4581 | x :: xs -> f i x; loop (i+1) xs
4586 let rec loop i = function
4588 | x :: xs -> let r = f i x in r :: loop (i+1) xs
4592 let count_chars c str =
4593 let count = ref 0 in
4594 for i = 0 to String.length str - 1 do
4595 if c = String.unsafe_get str i then incr count
4599 let name_of_argt = function
4600 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4601 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4602 | FileIn n | FileOut n -> n
4604 let java_name_of_struct typ =
4605 try List.assoc typ java_structs
4608 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4610 let cols_of_struct typ =
4611 try List.assoc typ structs
4613 failwithf "cols_of_struct: unknown struct %s" typ
4615 let seq_of_test = function
4616 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4617 | TestOutputListOfDevices (s, _)
4618 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4619 | TestOutputTrue s | TestOutputFalse s
4620 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4621 | TestOutputStruct (s, _)
4622 | TestLastFail s -> s
4624 (* Handling for function flags. *)
4625 let protocol_limit_warning =
4626 "Because of the message protocol, there is a transfer limit
4627 of somewhere between 2MB and 4MB. To transfer large files you should use
4630 let danger_will_robinson =
4631 "B<This command is dangerous. Without careful use you
4632 can easily destroy all your data>."
4634 let deprecation_notice flags =
4637 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4639 sprintf "This function is deprecated.
4640 In new code, use the C<%s> call instead.
4642 Deprecated functions will not be removed from the API, but the
4643 fact that they are deprecated indicates that there are problems
4644 with correct use of these functions." alt in
4649 (* Create list of optional groups. *)
4651 let h = Hashtbl.create 13 in
4653 fun (name, _, _, flags, _, _, _) ->
4657 let names = try Hashtbl.find h group with Not_found -> [] in
4658 Hashtbl.replace h group (name :: names)
4662 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4665 fun group -> group, List.sort compare (Hashtbl.find h group)
4667 List.sort (fun x y -> compare (fst x) (fst y)) groups
4669 (* Check function names etc. for consistency. *)
4670 let check_functions () =
4671 let contains_uppercase str =
4672 let len = String.length str in
4674 if i >= len then false
4677 if c >= 'A' && c <= 'Z' then true
4684 (* Check function names. *)
4686 fun (name, _, _, _, _, _, _) ->
4687 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4688 failwithf "function name %s does not need 'guestfs' prefix" name;
4690 failwithf "function name is empty";
4691 if name.[0] < 'a' || name.[0] > 'z' then
4692 failwithf "function name %s must start with lowercase a-z" name;
4693 if String.contains name '-' then
4694 failwithf "function name %s should not contain '-', use '_' instead."
4698 (* Check function parameter/return names. *)
4700 fun (name, style, _, _, _, _, _) ->
4701 let check_arg_ret_name n =
4702 if contains_uppercase n then
4703 failwithf "%s param/ret %s should not contain uppercase chars"
4705 if String.contains n '-' || String.contains n '_' then
4706 failwithf "%s param/ret %s should not contain '-' or '_'"
4709 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;
4710 if n = "int" || n = "char" || n = "short" || n = "long" then
4711 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4712 if n = "i" || n = "n" then
4713 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4714 if n = "argv" || n = "args" then
4715 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
4717 (* List Haskell, OCaml and C keywords here.
4718 * http://www.haskell.org/haskellwiki/Keywords
4719 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
4720 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
4721 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
4722 * |perl -pe 's/(.+)/"$1";/'|fmt -70
4723 * Omitting _-containing words, since they're handled above.
4724 * Omitting the OCaml reserved word, "val", is ok,
4725 * and saves us from renaming several parameters.
4728 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
4729 "char"; "class"; "const"; "constraint"; "continue"; "data";
4730 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
4731 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
4732 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
4733 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
4734 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
4735 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
4736 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
4737 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
4738 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
4739 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
4740 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
4741 "volatile"; "when"; "where"; "while";
4743 if List.mem n reserved then
4744 failwithf "%s has param/ret using reserved word %s" name n;
4747 (match fst style with
4749 | RInt n | RInt64 n | RBool n
4750 | RConstString n | RConstOptString n | RString n
4751 | RStringList n | RStruct (n, _) | RStructList (n, _)
4752 | RHashtable n | RBufferOut n ->
4753 check_arg_ret_name n
4755 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
4758 (* Check short descriptions. *)
4760 fun (name, _, _, _, _, shortdesc, _) ->
4761 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
4762 failwithf "short description of %s should begin with lowercase." name;
4763 let c = shortdesc.[String.length shortdesc-1] in
4764 if c = '\n' || c = '.' then
4765 failwithf "short description of %s should not end with . or \\n." name
4768 (* Check long dscriptions. *)
4770 fun (name, _, _, _, _, _, longdesc) ->
4771 if longdesc.[String.length longdesc-1] = '\n' then
4772 failwithf "long description of %s should not end with \\n." name
4775 (* Check proc_nrs. *)
4777 fun (name, _, proc_nr, _, _, _, _) ->
4778 if proc_nr <= 0 then
4779 failwithf "daemon function %s should have proc_nr > 0" name
4783 fun (name, _, proc_nr, _, _, _, _) ->
4784 if proc_nr <> -1 then
4785 failwithf "non-daemon function %s should have proc_nr -1" name
4786 ) non_daemon_functions;
4789 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
4792 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
4793 let rec loop = function
4796 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
4798 | (name1,nr1) :: (name2,nr2) :: _ ->
4799 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
4807 (* Ignore functions that have no tests. We generate a
4808 * warning when the user does 'make check' instead.
4810 | name, _, _, _, [], _, _ -> ()
4811 | name, _, _, _, tests, _, _ ->
4815 match seq_of_test test with
4817 failwithf "%s has a test containing an empty sequence" name
4818 | cmds -> List.map List.hd cmds
4820 let funcs = List.flatten funcs in
4822 let tested = List.mem name funcs in
4825 failwithf "function %s has tests but does not test itself" name
4828 (* 'pr' prints to the current output file. *)
4829 let chan = ref Pervasives.stdout
4834 let i = count_chars '\n' str in
4835 lines := !lines + i;
4836 output_string !chan str
4839 let copyright_years =
4840 let this_year = 1900 + (localtime (time ())).tm_year in
4841 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
4843 (* Generate a header block in a number of standard styles. *)
4844 type comment_style =
4845 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
4846 type license = GPLv2plus | LGPLv2plus
4848 let generate_header ?(extra_inputs = []) comment license =
4849 let inputs = "src/generator.ml" :: extra_inputs in
4850 let c = match comment with
4851 | CStyle -> pr "/* "; " *"
4852 | CPlusPlusStyle -> pr "// "; "//"
4853 | HashStyle -> pr "# "; "#"
4854 | OCamlStyle -> pr "(* "; " *"
4855 | HaskellStyle -> pr "{- "; " " in
4856 pr "libguestfs generated file\n";
4857 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
4858 List.iter (pr "%s %s\n" c) inputs;
4859 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
4861 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
4865 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
4866 pr "%s it under the terms of the GNU General Public License as published by\n" c;
4867 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
4868 pr "%s (at your option) any later version.\n" c;
4870 pr "%s This program is distributed in the hope that it will be useful,\n" c;
4871 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4872 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
4873 pr "%s GNU General Public License for more details.\n" c;
4875 pr "%s You should have received a copy of the GNU General Public License along\n" c;
4876 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
4877 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
4880 pr "%s This library is free software; you can redistribute it and/or\n" c;
4881 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
4882 pr "%s License as published by the Free Software Foundation; either\n" c;
4883 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
4885 pr "%s This library is distributed in the hope that it will be useful,\n" c;
4886 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4887 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
4888 pr "%s Lesser General Public License for more details.\n" c;
4890 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
4891 pr "%s License along with this library; if not, write to the Free Software\n" c;
4892 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
4895 | CStyle -> pr " */\n"
4898 | OCamlStyle -> pr " *)\n"
4899 | HaskellStyle -> pr "-}\n"
4903 (* Start of main code generation functions below this line. *)
4905 (* Generate the pod documentation for the C API. *)
4906 let rec generate_actions_pod () =
4908 fun (shortname, style, _, flags, _, _, longdesc) ->
4909 if not (List.mem NotInDocs flags) then (
4910 let name = "guestfs_" ^ shortname in
4911 pr "=head2 %s\n\n" name;
4913 generate_prototype ~extern:false ~handle:"handle" name style;
4915 pr "%s\n\n" longdesc;
4916 (match fst style with
4918 pr "This function returns 0 on success or -1 on error.\n\n"
4920 pr "On error this function returns -1.\n\n"
4922 pr "On error this function returns -1.\n\n"
4924 pr "This function returns a C truth value on success or -1 on error.\n\n"
4926 pr "This function returns a string, or NULL on error.
4927 The string is owned by the guest handle and must I<not> be freed.\n\n"
4928 | RConstOptString _ ->
4929 pr "This function returns a string which may be NULL.
4930 There is way to return an error from this function.
4931 The string is owned by the guest handle and must I<not> be freed.\n\n"
4933 pr "This function returns a string, or NULL on error.
4934 I<The caller must free the returned string after use>.\n\n"
4936 pr "This function returns a NULL-terminated array of strings
4937 (like L<environ(3)>), or NULL if there was an error.
4938 I<The caller must free the strings and the array after use>.\n\n"
4939 | RStruct (_, typ) ->
4940 pr "This function returns a C<struct guestfs_%s *>,
4941 or NULL if there was an error.
4942 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
4943 | RStructList (_, typ) ->
4944 pr "This function returns a C<struct guestfs_%s_list *>
4945 (see E<lt>guestfs-structs.hE<gt>),
4946 or NULL if there was an error.
4947 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4949 pr "This function returns a NULL-terminated array of
4950 strings, or NULL if there was an error.
4951 The array of strings will always have length C<2n+1>, where
4952 C<n> keys and values alternate, followed by the trailing NULL entry.
4953 I<The caller must free the strings and the array after use>.\n\n"
4955 pr "This function returns a buffer, or NULL on error.
4956 The size of the returned buffer is written to C<*size_r>.
4957 I<The caller must free the returned buffer after use>.\n\n"
4959 if List.mem ProtocolLimitWarning flags then
4960 pr "%s\n\n" protocol_limit_warning;
4961 if List.mem DangerWillRobinson flags then
4962 pr "%s\n\n" danger_will_robinson;
4963 match deprecation_notice flags with
4965 | Some txt -> pr "%s\n\n" txt
4967 ) all_functions_sorted
4969 and generate_structs_pod () =
4970 (* Structs documentation. *)
4973 pr "=head2 guestfs_%s\n" typ;
4975 pr " struct guestfs_%s {\n" typ;
4978 | name, FChar -> pr " char %s;\n" name
4979 | name, FUInt32 -> pr " uint32_t %s;\n" name
4980 | name, FInt32 -> pr " int32_t %s;\n" name
4981 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4982 | name, FInt64 -> pr " int64_t %s;\n" name
4983 | name, FString -> pr " char *%s;\n" name
4985 pr " /* The next two fields describe a byte array. */\n";
4986 pr " uint32_t %s_len;\n" name;
4987 pr " char *%s;\n" name
4989 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4990 pr " char %s[32];\n" name
4991 | name, FOptPercent ->
4992 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4993 pr " float %s;\n" name
4997 pr " struct guestfs_%s_list {\n" typ;
4998 pr " uint32_t len; /* Number of elements in list. */\n";
4999 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5002 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5003 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5008 and generate_availability_pod () =
5009 (* Availability documentation. *)
5013 fun (group, functions) ->
5014 pr "=item B<%s>\n" group;
5016 pr "The following functions:\n";
5017 List.iter (pr "L</guestfs_%s>\n") functions;
5023 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5024 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5026 * We have to use an underscore instead of a dash because otherwise
5027 * rpcgen generates incorrect code.
5029 * This header is NOT exported to clients, but see also generate_structs_h.
5031 and generate_xdr () =
5032 generate_header CStyle LGPLv2plus;
5034 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5035 pr "typedef string str<>;\n";
5038 (* Internal structures. *)
5042 pr "struct guestfs_int_%s {\n" typ;
5044 | name, FChar -> pr " char %s;\n" name
5045 | name, FString -> pr " string %s<>;\n" name
5046 | name, FBuffer -> pr " opaque %s<>;\n" name
5047 | name, FUUID -> pr " opaque %s[32];\n" name
5048 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5049 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5050 | name, FOptPercent -> pr " float %s;\n" name
5054 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5059 fun (shortname, style, _, _, _, _, _) ->
5060 let name = "guestfs_" ^ shortname in
5062 (match snd style with
5065 pr "struct %s_args {\n" name;
5068 | Pathname n | Device n | Dev_or_Path n | String n ->
5069 pr " string %s<>;\n" n
5070 | OptString n -> pr " str *%s;\n" n
5071 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5072 | Bool n -> pr " bool %s;\n" n
5073 | Int n -> pr " int %s;\n" n
5074 | Int64 n -> pr " hyper %s;\n" n
5075 | FileIn _ | FileOut _ -> ()
5079 (match fst style with
5082 pr "struct %s_ret {\n" name;
5086 pr "struct %s_ret {\n" name;
5087 pr " hyper %s;\n" n;
5090 pr "struct %s_ret {\n" name;
5093 | RConstString _ | RConstOptString _ ->
5094 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5096 pr "struct %s_ret {\n" name;
5097 pr " string %s<>;\n" n;
5100 pr "struct %s_ret {\n" name;
5101 pr " str %s<>;\n" n;
5103 | RStruct (n, typ) ->
5104 pr "struct %s_ret {\n" name;
5105 pr " guestfs_int_%s %s;\n" typ n;
5107 | RStructList (n, typ) ->
5108 pr "struct %s_ret {\n" name;
5109 pr " guestfs_int_%s_list %s;\n" typ n;
5112 pr "struct %s_ret {\n" name;
5113 pr " str %s<>;\n" n;
5116 pr "struct %s_ret {\n" name;
5117 pr " opaque %s<>;\n" n;
5122 (* Table of procedure numbers. *)
5123 pr "enum guestfs_procedure {\n";
5125 fun (shortname, _, proc_nr, _, _, _, _) ->
5126 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5128 pr " GUESTFS_PROC_NR_PROCS\n";
5132 (* Having to choose a maximum message size is annoying for several
5133 * reasons (it limits what we can do in the API), but it (a) makes
5134 * the protocol a lot simpler, and (b) provides a bound on the size
5135 * of the daemon which operates in limited memory space. For large
5136 * file transfers you should use FTP.
5138 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5141 (* Message header, etc. *)
5143 /* The communication protocol is now documented in the guestfs(3)
5147 const GUESTFS_PROGRAM = 0x2000F5F5;
5148 const GUESTFS_PROTOCOL_VERSION = 1;
5150 /* These constants must be larger than any possible message length. */
5151 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5152 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5154 enum guestfs_message_direction {
5155 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5156 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5159 enum guestfs_message_status {
5160 GUESTFS_STATUS_OK = 0,
5161 GUESTFS_STATUS_ERROR = 1
5164 const GUESTFS_ERROR_LEN = 256;
5166 struct guestfs_message_error {
5167 string error_message<GUESTFS_ERROR_LEN>;
5170 struct guestfs_message_header {
5171 unsigned prog; /* GUESTFS_PROGRAM */
5172 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5173 guestfs_procedure proc; /* GUESTFS_PROC_x */
5174 guestfs_message_direction direction;
5175 unsigned serial; /* message serial number */
5176 guestfs_message_status status;
5179 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5181 struct guestfs_chunk {
5182 int cancel; /* if non-zero, transfer is cancelled */
5183 /* data size is 0 bytes if the transfer has finished successfully */
5184 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5188 (* Generate the guestfs-structs.h file. *)
5189 and generate_structs_h () =
5190 generate_header CStyle LGPLv2plus;
5192 (* This is a public exported header file containing various
5193 * structures. The structures are carefully written to have
5194 * exactly the same in-memory format as the XDR structures that
5195 * we use on the wire to the daemon. The reason for creating
5196 * copies of these structures here is just so we don't have to
5197 * export the whole of guestfs_protocol.h (which includes much
5198 * unrelated and XDR-dependent stuff that we don't want to be
5199 * public, or required by clients).
5201 * To reiterate, we will pass these structures to and from the
5202 * client with a simple assignment or memcpy, so the format
5203 * must be identical to what rpcgen / the RFC defines.
5206 (* Public structures. *)
5209 pr "struct guestfs_%s {\n" typ;
5212 | name, FChar -> pr " char %s;\n" name
5213 | name, FString -> pr " char *%s;\n" name
5215 pr " uint32_t %s_len;\n" name;
5216 pr " char *%s;\n" name
5217 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5218 | name, FUInt32 -> pr " uint32_t %s;\n" name
5219 | name, FInt32 -> pr " int32_t %s;\n" name
5220 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5221 | name, FInt64 -> pr " int64_t %s;\n" name
5222 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5226 pr "struct guestfs_%s_list {\n" typ;
5227 pr " uint32_t len;\n";
5228 pr " struct guestfs_%s *val;\n" typ;
5231 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5232 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5236 (* Generate the guestfs-actions.h file. *)
5237 and generate_actions_h () =
5238 generate_header CStyle LGPLv2plus;
5240 fun (shortname, style, _, _, _, _, _) ->
5241 let name = "guestfs_" ^ shortname in
5242 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5246 (* Generate the guestfs-internal-actions.h file. *)
5247 and generate_internal_actions_h () =
5248 generate_header CStyle LGPLv2plus;
5250 fun (shortname, style, _, _, _, _, _) ->
5251 let name = "guestfs__" ^ shortname in
5252 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5254 ) non_daemon_functions
5256 (* Generate the client-side dispatch stubs. *)
5257 and generate_client_actions () =
5258 generate_header CStyle LGPLv2plus;
5264 #include <inttypes.h>
5266 #include \"guestfs.h\"
5267 #include \"guestfs-internal.h\"
5268 #include \"guestfs-internal-actions.h\"
5269 #include \"guestfs_protocol.h\"
5271 #define error guestfs_error
5272 //#define perrorf guestfs_perrorf
5273 #define safe_malloc guestfs_safe_malloc
5274 #define safe_realloc guestfs_safe_realloc
5275 //#define safe_strdup guestfs_safe_strdup
5276 #define safe_memdup guestfs_safe_memdup
5278 /* Check the return message from a call for validity. */
5280 check_reply_header (guestfs_h *g,
5281 const struct guestfs_message_header *hdr,
5282 unsigned int proc_nr, unsigned int serial)
5284 if (hdr->prog != GUESTFS_PROGRAM) {
5285 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5288 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5289 error (g, \"wrong protocol version (%%d/%%d)\",
5290 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5293 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5294 error (g, \"unexpected message direction (%%d/%%d)\",
5295 hdr->direction, GUESTFS_DIRECTION_REPLY);
5298 if (hdr->proc != proc_nr) {
5299 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5302 if (hdr->serial != serial) {
5303 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5310 /* Check we are in the right state to run a high-level action. */
5312 check_state (guestfs_h *g, const char *caller)
5314 if (!guestfs__is_ready (g)) {
5315 if (guestfs__is_config (g) || guestfs__is_launching (g))
5316 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5319 error (g, \"%%s called from the wrong state, %%d != READY\",
5320 caller, guestfs__get_state (g));
5328 (* Generate code to generate guestfish call traces. *)
5329 let trace_call shortname style =
5330 pr " if (guestfs__get_trace (g)) {\n";
5333 List.exists (function
5334 | StringList _ | DeviceList _ -> true
5335 | _ -> false) (snd style) in
5341 pr " printf (\"%s\");\n" shortname;
5344 | String n (* strings *)
5350 (* guestfish doesn't support string escaping, so neither do we *)
5351 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5352 | OptString n -> (* string option *)
5353 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5354 pr " else printf (\" null\");\n"
5356 | DeviceList n -> (* string list *)
5357 pr " putchar (' ');\n";
5358 pr " putchar ('\"');\n";
5359 pr " for (i = 0; %s[i]; ++i) {\n" n;
5360 pr " if (i > 0) putchar (' ');\n";
5361 pr " fputs (%s[i], stdout);\n" n;
5363 pr " putchar ('\"');\n";
5364 | Bool n -> (* boolean *)
5365 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5366 | Int n -> (* int *)
5367 pr " printf (\" %%d\", %s);\n" n
5369 pr " printf (\" %%\" PRIi64, %s);\n" n
5371 pr " putchar ('\\n');\n";
5376 (* For non-daemon functions, generate a wrapper around each function. *)
5378 fun (shortname, style, _, _, _, _, _) ->
5379 let name = "guestfs_" ^ shortname in
5381 generate_prototype ~extern:false ~semicolon:false ~newline:true
5382 ~handle:"g" name style;
5384 trace_call shortname style;
5385 pr " return guestfs__%s " shortname;
5386 generate_c_call_args ~handle:"g" style;
5390 ) non_daemon_functions;
5392 (* Client-side stubs for each function. *)
5394 fun (shortname, style, _, _, _, _, _) ->
5395 let name = "guestfs_" ^ shortname in
5397 (* Generate the action stub. *)
5398 generate_prototype ~extern:false ~semicolon:false ~newline:true
5399 ~handle:"g" name style;
5402 match fst style with
5403 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5404 | RConstString _ | RConstOptString _ ->
5405 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5406 | RString _ | RStringList _
5407 | RStruct _ | RStructList _
5408 | RHashtable _ | RBufferOut _ ->
5413 (match snd style with
5415 | _ -> pr " struct %s_args args;\n" name
5418 pr " guestfs_message_header hdr;\n";
5419 pr " guestfs_message_error err;\n";
5421 match fst style with
5423 | RConstString _ | RConstOptString _ ->
5424 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5426 | RBool _ | RString _ | RStringList _
5427 | RStruct _ | RStructList _
5428 | RHashtable _ | RBufferOut _ ->
5429 pr " struct %s_ret ret;\n" name;
5432 pr " int serial;\n";
5435 trace_call shortname style;
5436 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5437 pr " guestfs___set_busy (g);\n";
5440 (* Send the main header and arguments. *)
5441 (match snd style with
5443 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5444 (String.uppercase shortname)
5448 | Pathname n | Device n | Dev_or_Path n | String n ->
5449 pr " args.%s = (char *) %s;\n" n n
5451 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5452 | StringList n | DeviceList n ->
5453 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5454 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5456 pr " args.%s = %s;\n" n n
5458 pr " args.%s = %s;\n" n n
5460 pr " args.%s = %s;\n" n n
5461 | FileIn _ | FileOut _ -> ()
5463 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5464 (String.uppercase shortname);
5465 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5468 pr " if (serial == -1) {\n";
5469 pr " guestfs___end_busy (g);\n";
5470 pr " return %s;\n" error_code;
5474 (* Send any additional files (FileIn) requested. *)
5475 let need_read_reply_label = ref false in
5479 pr " r = guestfs___send_file (g, %s);\n" n;
5480 pr " if (r == -1) {\n";
5481 pr " guestfs___end_busy (g);\n";
5482 pr " return %s;\n" error_code;
5484 pr " if (r == -2) /* daemon cancelled */\n";
5485 pr " goto read_reply;\n";
5486 need_read_reply_label := true;
5491 (* Wait for the reply from the remote end. *)
5492 if !need_read_reply_label then pr " read_reply:\n";
5493 pr " memset (&hdr, 0, sizeof hdr);\n";
5494 pr " memset (&err, 0, sizeof err);\n";
5495 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5497 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5501 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5504 pr " if (r == -1) {\n";
5505 pr " guestfs___end_busy (g);\n";
5506 pr " return %s;\n" error_code;
5510 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5511 (String.uppercase shortname);
5512 pr " guestfs___end_busy (g);\n";
5513 pr " return %s;\n" error_code;
5517 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5518 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5519 pr " free (err.error_message);\n";
5520 pr " guestfs___end_busy (g);\n";
5521 pr " return %s;\n" error_code;
5525 (* Expecting to receive further files (FileOut)? *)
5529 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5530 pr " guestfs___end_busy (g);\n";
5531 pr " return %s;\n" error_code;
5537 pr " guestfs___end_busy (g);\n";
5539 (match fst style with
5540 | RErr -> pr " return 0;\n"
5541 | RInt n | RInt64 n | RBool n ->
5542 pr " return ret.%s;\n" n
5543 | RConstString _ | RConstOptString _ ->
5544 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5546 pr " return ret.%s; /* caller will free */\n" n
5547 | RStringList n | RHashtable n ->
5548 pr " /* caller will free this, but we need to add a NULL entry */\n";
5549 pr " ret.%s.%s_val =\n" n n;
5550 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5551 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5553 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5554 pr " return ret.%s.%s_val;\n" n n
5556 pr " /* caller will free this */\n";
5557 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5558 | RStructList (n, _) ->
5559 pr " /* caller will free this */\n";
5560 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5562 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5563 pr " * _val might be NULL here. To make the API saner for\n";
5564 pr " * callers, we turn this case into a unique pointer (using\n";
5565 pr " * malloc(1)).\n";
5567 pr " if (ret.%s.%s_len > 0) {\n" n n;
5568 pr " *size_r = ret.%s.%s_len;\n" n n;
5569 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5571 pr " free (ret.%s.%s_val);\n" n n;
5572 pr " char *p = safe_malloc (g, 1);\n";
5573 pr " *size_r = ret.%s.%s_len;\n" n n;
5581 (* Functions to free structures. *)
5582 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5583 pr " * structure format is identical to the XDR format. See note in\n";
5584 pr " * generator.ml.\n";
5591 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5593 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5599 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5601 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5608 (* Generate daemon/actions.h. *)
5609 and generate_daemon_actions_h () =
5610 generate_header CStyle GPLv2plus;
5612 pr "#include \"../src/guestfs_protocol.h\"\n";
5616 fun (name, style, _, _, _, _, _) ->
5618 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5622 (* Generate the linker script which controls the visibility of
5623 * symbols in the public ABI and ensures no other symbols get
5624 * exported accidentally.
5626 and generate_linker_script () =
5627 generate_header HashStyle GPLv2plus;
5632 "guestfs_get_error_handler";
5633 "guestfs_get_out_of_memory_handler";
5634 "guestfs_last_error";
5635 "guestfs_set_error_handler";
5636 "guestfs_set_launch_done_callback";
5637 "guestfs_set_log_message_callback";
5638 "guestfs_set_out_of_memory_handler";
5639 "guestfs_set_subprocess_quit_callback";
5641 (* Unofficial parts of the API: the bindings code use these
5642 * functions, so it is useful to export them.
5644 "guestfs_safe_calloc";
5645 "guestfs_safe_malloc";
5648 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
5652 List.map (fun (typ, _) ->
5653 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
5656 let globals = List.sort compare (globals @ functions @ structs) in
5660 List.iter (pr " %s;\n") globals;
5667 (* Generate the server-side stubs. *)
5668 and generate_daemon_actions () =
5669 generate_header CStyle GPLv2plus;
5671 pr "#include <config.h>\n";
5673 pr "#include <stdio.h>\n";
5674 pr "#include <stdlib.h>\n";
5675 pr "#include <string.h>\n";
5676 pr "#include <inttypes.h>\n";
5677 pr "#include <rpc/types.h>\n";
5678 pr "#include <rpc/xdr.h>\n";
5680 pr "#include \"daemon.h\"\n";
5681 pr "#include \"c-ctype.h\"\n";
5682 pr "#include \"../src/guestfs_protocol.h\"\n";
5683 pr "#include \"actions.h\"\n";
5687 fun (name, style, _, _, _, _, _) ->
5688 (* Generate server-side stubs. *)
5689 pr "static void %s_stub (XDR *xdr_in)\n" name;
5692 match fst style with
5693 | RErr | RInt _ -> pr " int r;\n"; "-1"
5694 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5695 | RBool _ -> pr " int r;\n"; "-1"
5696 | RConstString _ | RConstOptString _ ->
5697 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5698 | RString _ -> pr " char *r;\n"; "NULL"
5699 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5700 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
5701 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
5703 pr " size_t size = 1;\n";
5707 (match snd style with
5710 pr " struct guestfs_%s_args args;\n" name;
5713 | Device n | Dev_or_Path n
5716 | OptString n -> pr " char *%s;\n" n
5717 | StringList n | DeviceList n -> pr " char **%s;\n" n
5718 | Bool n -> pr " int %s;\n" n
5719 | Int n -> pr " int %s;\n" n
5720 | Int64 n -> pr " int64_t %s;\n" n
5721 | FileIn _ | FileOut _ -> ()
5726 (match snd style with
5729 pr " memset (&args, 0, sizeof args);\n";
5731 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
5732 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
5736 pr " char *%s = args.%s;\n" n n
5738 let pr_list_handling_code n =
5739 pr " %s = realloc (args.%s.%s_val,\n" n n n;
5740 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
5741 pr " if (%s == NULL) {\n" n;
5742 pr " reply_with_perror (\"realloc\");\n";
5745 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
5746 pr " args.%s.%s_val = %s;\n" n n n;
5752 pr " ABS_PATH (%s, goto done);\n" n;
5755 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
5758 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
5759 | String n -> pr_args n
5760 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
5762 pr_list_handling_code n;
5764 pr_list_handling_code n;
5765 pr " /* Ensure that each is a device,\n";
5766 pr " * and perform device name translation. */\n";
5767 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
5768 pr " RESOLVE_DEVICE (physvols[pvi], goto done);\n";
5770 | Bool n -> pr " %s = args.%s;\n" n n
5771 | Int n -> pr " %s = args.%s;\n" n n
5772 | Int64 n -> pr " %s = args.%s;\n" n n
5773 | FileIn _ | FileOut _ -> ()
5779 (* this is used at least for do_equal *)
5780 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
5781 (* Emit NEED_ROOT just once, even when there are two or
5782 more Pathname args *)
5783 pr " NEED_ROOT (goto done);\n";
5786 (* Don't want to call the impl with any FileIn or FileOut
5787 * parameters, since these go "outside" the RPC protocol.
5790 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
5792 pr " r = do_%s " name;
5793 generate_c_call_args (fst style, args');
5796 (match fst style with
5797 | RErr | RInt _ | RInt64 _ | RBool _
5798 | RConstString _ | RConstOptString _
5799 | RString _ | RStringList _ | RHashtable _
5800 | RStruct (_, _) | RStructList (_, _) ->
5801 pr " if (r == %s)\n" error_code;
5802 pr " /* do_%s has already called reply_with_error */\n" name;
5806 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
5807 pr " * an ordinary zero-length buffer), so be careful ...\n";
5809 pr " if (size == 1 && r == %s)\n" error_code;
5810 pr " /* do_%s has already called reply_with_error */\n" name;
5815 (* If there are any FileOut parameters, then the impl must
5816 * send its own reply.
5819 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
5821 pr " /* do_%s has already sent a reply */\n" name
5823 match fst style with
5824 | RErr -> pr " reply (NULL, NULL);\n"
5825 | RInt n | RInt64 n | RBool n ->
5826 pr " struct guestfs_%s_ret ret;\n" name;
5827 pr " ret.%s = r;\n" n;
5828 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5830 | RConstString _ | RConstOptString _ ->
5831 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5833 pr " struct guestfs_%s_ret ret;\n" name;
5834 pr " ret.%s = r;\n" n;
5835 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5838 | RStringList n | RHashtable n ->
5839 pr " struct guestfs_%s_ret ret;\n" name;
5840 pr " ret.%s.%s_len = count_strings (r);\n" n n;
5841 pr " ret.%s.%s_val = r;\n" n n;
5842 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5844 pr " free_strings (r);\n"
5846 pr " struct guestfs_%s_ret ret;\n" name;
5847 pr " ret.%s = *r;\n" n;
5848 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5850 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5852 | RStructList (n, _) ->
5853 pr " struct guestfs_%s_ret ret;\n" name;
5854 pr " ret.%s = *r;\n" n;
5855 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5857 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
5860 pr " struct guestfs_%s_ret ret;\n" name;
5861 pr " ret.%s.%s_val = r;\n" n n;
5862 pr " ret.%s.%s_len = size;\n" n n;
5863 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
5868 (* Free the args. *)
5869 (match snd style with
5874 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
5881 (* Dispatch function. *)
5882 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
5884 pr " switch (proc_nr) {\n";
5887 fun (name, style, _, _, _, _, _) ->
5888 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
5889 pr " %s_stub (xdr_in);\n" name;
5894 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";
5899 (* LVM columns and tokenization functions. *)
5900 (* XXX This generates crap code. We should rethink how we
5906 pr "static const char *lvm_%s_cols = \"%s\";\n"
5907 typ (String.concat "," (List.map fst cols));
5910 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
5912 pr " char *tok, *p, *next;\n";
5916 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
5919 pr " if (!str) {\n";
5920 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
5923 pr " if (!*str || c_isspace (*str)) {\n";
5924 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
5929 fun (name, coltype) ->
5930 pr " if (!tok) {\n";
5931 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
5934 pr " p = strchrnul (tok, ',');\n";
5935 pr " if (*p) next = p+1; else next = NULL;\n";
5936 pr " *p = '\\0';\n";
5939 pr " r->%s = strdup (tok);\n" name;
5940 pr " if (r->%s == NULL) {\n" name;
5941 pr " perror (\"strdup\");\n";
5945 pr " for (i = j = 0; i < 32; ++j) {\n";
5946 pr " if (tok[j] == '\\0') {\n";
5947 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
5949 pr " } else if (tok[j] != '-')\n";
5950 pr " r->%s[i++] = tok[j];\n" name;
5953 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
5954 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5958 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
5959 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5963 pr " if (tok[0] == '\\0')\n";
5964 pr " r->%s = -1;\n" name;
5965 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
5966 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
5969 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
5970 assert false (* can never be an LVM column *)
5972 pr " tok = next;\n";
5975 pr " if (tok != NULL) {\n";
5976 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
5983 pr "guestfs_int_lvm_%s_list *\n" typ;
5984 pr "parse_command_line_%ss (void)\n" typ;
5986 pr " char *out, *err;\n";
5987 pr " char *p, *pend;\n";
5989 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
5990 pr " void *newp;\n";
5992 pr " ret = malloc (sizeof *ret);\n";
5993 pr " if (!ret) {\n";
5994 pr " reply_with_perror (\"malloc\");\n";
5995 pr " return NULL;\n";
5998 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
5999 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6001 pr " r = command (&out, &err,\n";
6002 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
6003 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6004 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6005 pr " if (r == -1) {\n";
6006 pr " reply_with_error (\"%%s\", err);\n";
6007 pr " free (out);\n";
6008 pr " free (err);\n";
6009 pr " free (ret);\n";
6010 pr " return NULL;\n";
6013 pr " free (err);\n";
6015 pr " /* Tokenize each line of the output. */\n";
6018 pr " while (p) {\n";
6019 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6020 pr " if (pend) {\n";
6021 pr " *pend = '\\0';\n";
6025 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6028 pr " if (!*p) { /* Empty line? Skip it. */\n";
6033 pr " /* Allocate some space to store this next entry. */\n";
6034 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6035 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6036 pr " if (newp == NULL) {\n";
6037 pr " reply_with_perror (\"realloc\");\n";
6038 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6039 pr " free (ret);\n";
6040 pr " free (out);\n";
6041 pr " return NULL;\n";
6043 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6045 pr " /* Tokenize the next entry. */\n";
6046 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6047 pr " if (r == -1) {\n";
6048 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6049 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6050 pr " free (ret);\n";
6051 pr " free (out);\n";
6052 pr " return NULL;\n";
6059 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6061 pr " free (out);\n";
6062 pr " return ret;\n";
6065 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6067 (* Generate a list of function names, for debugging in the daemon.. *)
6068 and generate_daemon_names () =
6069 generate_header CStyle GPLv2plus;
6071 pr "#include <config.h>\n";
6073 pr "#include \"daemon.h\"\n";
6076 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6077 pr "const char *function_names[] = {\n";
6079 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6083 (* Generate the optional groups for the daemon to implement
6084 * guestfs_available.
6086 and generate_daemon_optgroups_c () =
6087 generate_header CStyle GPLv2plus;
6089 pr "#include <config.h>\n";
6091 pr "#include \"daemon.h\"\n";
6092 pr "#include \"optgroups.h\"\n";
6095 pr "struct optgroup optgroups[] = {\n";
6098 pr " { \"%s\", optgroup_%s_available },\n" group group
6100 pr " { NULL, NULL }\n";
6103 and generate_daemon_optgroups_h () =
6104 generate_header CStyle GPLv2plus;
6108 pr "extern int optgroup_%s_available (void);\n" group
6111 (* Generate the tests. *)
6112 and generate_tests () =
6113 generate_header CStyle GPLv2plus;
6120 #include <sys/types.h>
6123 #include \"guestfs.h\"
6124 #include \"guestfs-internal.h\"
6126 static guestfs_h *g;
6127 static int suppress_error = 0;
6129 static void print_error (guestfs_h *g, void *data, const char *msg)
6131 if (!suppress_error)
6132 fprintf (stderr, \"%%s\\n\", msg);
6135 /* FIXME: nearly identical code appears in fish.c */
6136 static void print_strings (char *const *argv)
6140 for (argc = 0; argv[argc] != NULL; ++argc)
6141 printf (\"\\t%%s\\n\", argv[argc]);
6145 static void print_table (char const *const *argv)
6149 for (i = 0; argv[i] != NULL; i += 2)
6150 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6156 (* Generate a list of commands which are not tested anywhere. *)
6157 pr "static void no_test_warnings (void)\n";
6160 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6162 fun (_, _, _, _, tests, _, _) ->
6163 let tests = filter_map (
6165 | (_, (Always|If _|Unless _), test) -> Some test
6166 | (_, Disabled, _) -> None
6168 let seq = List.concat (List.map seq_of_test tests) in
6169 let cmds_tested = List.map List.hd seq in
6170 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6174 fun (name, _, _, _, _, _, _) ->
6175 if not (Hashtbl.mem hash name) then
6176 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6182 (* Generate the actual tests. Note that we generate the tests
6183 * in reverse order, deliberately, so that (in general) the
6184 * newest tests run first. This makes it quicker and easier to
6189 fun (name, _, _, flags, tests, _, _) ->
6190 mapi (generate_one_test name flags) tests
6191 ) (List.rev all_functions) in
6192 let test_names = List.concat test_names in
6193 let nr_tests = List.length test_names in
6196 int main (int argc, char *argv[])
6199 unsigned long int n_failed = 0;
6200 const char *filename;
6202 int nr_tests, test_num = 0;
6204 setbuf (stdout, NULL);
6206 no_test_warnings ();
6208 g = guestfs_create ();
6210 printf (\"guestfs_create FAILED\\n\");
6211 exit (EXIT_FAILURE);
6214 guestfs_set_error_handler (g, print_error, NULL);
6216 guestfs_set_path (g, \"../appliance\");
6218 filename = \"test1.img\";
6219 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6222 exit (EXIT_FAILURE);
6224 if (lseek (fd, %d, SEEK_SET) == -1) {
6228 exit (EXIT_FAILURE);
6230 if (write (fd, &c, 1) == -1) {
6234 exit (EXIT_FAILURE);
6236 if (close (fd) == -1) {
6239 exit (EXIT_FAILURE);
6241 if (guestfs_add_drive (g, filename) == -1) {
6242 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6243 exit (EXIT_FAILURE);
6246 filename = \"test2.img\";
6247 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6250 exit (EXIT_FAILURE);
6252 if (lseek (fd, %d, SEEK_SET) == -1) {
6256 exit (EXIT_FAILURE);
6258 if (write (fd, &c, 1) == -1) {
6262 exit (EXIT_FAILURE);
6264 if (close (fd) == -1) {
6267 exit (EXIT_FAILURE);
6269 if (guestfs_add_drive (g, filename) == -1) {
6270 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6271 exit (EXIT_FAILURE);
6274 filename = \"test3.img\";
6275 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6278 exit (EXIT_FAILURE);
6280 if (lseek (fd, %d, SEEK_SET) == -1) {
6284 exit (EXIT_FAILURE);
6286 if (write (fd, &c, 1) == -1) {
6290 exit (EXIT_FAILURE);
6292 if (close (fd) == -1) {
6295 exit (EXIT_FAILURE);
6297 if (guestfs_add_drive (g, filename) == -1) {
6298 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6299 exit (EXIT_FAILURE);
6302 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6303 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6304 exit (EXIT_FAILURE);
6307 if (guestfs_launch (g) == -1) {
6308 printf (\"guestfs_launch FAILED\\n\");
6309 exit (EXIT_FAILURE);
6312 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6315 /* Cancel previous alarm. */
6320 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6324 pr " test_num++;\n";
6325 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6326 pr " if (%s () == -1) {\n" test_name;
6327 pr " printf (\"%s FAILED\\n\");\n" test_name;
6328 pr " n_failed++;\n";
6333 pr " guestfs_close (g);\n";
6334 pr " unlink (\"test1.img\");\n";
6335 pr " unlink (\"test2.img\");\n";
6336 pr " unlink (\"test3.img\");\n";
6339 pr " if (n_failed > 0) {\n";
6340 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6341 pr " exit (EXIT_FAILURE);\n";
6345 pr " exit (EXIT_SUCCESS);\n";
6348 and generate_one_test name flags i (init, prereq, test) =
6349 let test_name = sprintf "test_%s_%d" name i in
6352 static int %s_skip (void)
6356 str = getenv (\"TEST_ONLY\");
6358 return strstr (str, \"%s\") == NULL;
6359 str = getenv (\"SKIP_%s\");
6360 if (str && STREQ (str, \"1\")) return 1;
6361 str = getenv (\"SKIP_TEST_%s\");
6362 if (str && STREQ (str, \"1\")) return 1;
6366 " test_name name (String.uppercase test_name) (String.uppercase name);
6369 | Disabled | Always -> ()
6370 | If code | Unless code ->
6371 pr "static int %s_prereq (void)\n" test_name;
6379 static int %s (void)
6382 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6386 " test_name test_name test_name;
6388 (* Optional functions should only be tested if the relevant
6389 * support is available in the daemon.
6395 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6397 pr " suppress_error = 1;\n";
6398 pr " r = guestfs_available (g, (char **) groups);\n";
6399 pr " suppress_error = 0;\n";
6400 pr " if (r == -1) {\n";
6401 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6410 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6412 pr " if (! %s_prereq ()) {\n" test_name;
6413 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6417 generate_one_test_body name i test_name init test;
6419 pr " if (%s_prereq ()) {\n" test_name;
6420 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6424 generate_one_test_body name i test_name init test;
6426 generate_one_test_body name i test_name init test
6434 and generate_one_test_body name i test_name init test =
6436 | InitNone (* XXX at some point, InitNone and InitEmpty became
6437 * folded together as the same thing. Really we should
6438 * make InitNone do nothing at all, but the tests may
6439 * need to be checked to make sure this is OK.
6442 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6443 List.iter (generate_test_command_call test_name)
6444 [["blockdev_setrw"; "/dev/sda"];
6448 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6449 List.iter (generate_test_command_call test_name)
6450 [["blockdev_setrw"; "/dev/sda"];
6453 ["part_disk"; "/dev/sda"; "mbr"]]
6455 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6456 List.iter (generate_test_command_call test_name)
6457 [["blockdev_setrw"; "/dev/sda"];
6460 ["part_disk"; "/dev/sda"; "mbr"];
6461 ["mkfs"; "ext2"; "/dev/sda1"];
6462 ["mount"; "/dev/sda1"; "/"]]
6463 | InitBasicFSonLVM ->
6464 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6466 List.iter (generate_test_command_call test_name)
6467 [["blockdev_setrw"; "/dev/sda"];
6470 ["part_disk"; "/dev/sda"; "mbr"];
6471 ["pvcreate"; "/dev/sda1"];
6472 ["vgcreate"; "VG"; "/dev/sda1"];
6473 ["lvcreate"; "LV"; "VG"; "8"];
6474 ["mkfs"; "ext2"; "/dev/VG/LV"];
6475 ["mount"; "/dev/VG/LV"; "/"]]
6477 pr " /* InitISOFS for %s */\n" test_name;
6478 List.iter (generate_test_command_call test_name)
6479 [["blockdev_setrw"; "/dev/sda"];
6482 ["mount_ro"; "/dev/sdd"; "/"]]
6485 let get_seq_last = function
6487 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6490 let seq = List.rev seq in
6491 List.rev (List.tl seq), List.hd seq
6496 pr " /* TestRun for %s (%d) */\n" name i;
6497 List.iter (generate_test_command_call test_name) seq
6498 | TestOutput (seq, expected) ->
6499 pr " /* TestOutput for %s (%d) */\n" name i;
6500 pr " const char *expected = \"%s\";\n" (c_quote expected);
6501 let seq, last = get_seq_last seq in
6503 pr " if (STRNEQ (r, expected)) {\n";
6504 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6508 List.iter (generate_test_command_call test_name) seq;
6509 generate_test_command_call ~test test_name last
6510 | TestOutputList (seq, expected) ->
6511 pr " /* TestOutputList for %s (%d) */\n" name i;
6512 let seq, last = get_seq_last seq in
6516 pr " if (!r[%d]) {\n" i;
6517 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6518 pr " print_strings (r);\n";
6522 pr " const char *expected = \"%s\";\n" (c_quote str);
6523 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6524 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6529 pr " if (r[%d] != NULL) {\n" (List.length expected);
6530 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6532 pr " print_strings (r);\n";
6536 List.iter (generate_test_command_call test_name) seq;
6537 generate_test_command_call ~test test_name last
6538 | TestOutputListOfDevices (seq, expected) ->
6539 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6540 let seq, last = get_seq_last seq in
6544 pr " if (!r[%d]) {\n" i;
6545 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6546 pr " print_strings (r);\n";
6550 pr " const char *expected = \"%s\";\n" (c_quote str);
6551 pr " r[%d][5] = 's';\n" i;
6552 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6553 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6558 pr " if (r[%d] != NULL) {\n" (List.length expected);
6559 pr " fprintf (stderr, \"%s: extra elements returned from command\\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 | TestOutputInt (seq, expected) ->
6568 pr " /* TestOutputInt for %s (%d) */\n" name i;
6569 let seq, last = get_seq_last seq in
6571 pr " if (r != %d) {\n" expected;
6572 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6578 List.iter (generate_test_command_call test_name) seq;
6579 generate_test_command_call ~test test_name last
6580 | TestOutputIntOp (seq, op, expected) ->
6581 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6582 let seq, last = get_seq_last seq in
6584 pr " if (! (r %s %d)) {\n" op expected;
6585 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6586 test_name op expected;
6591 List.iter (generate_test_command_call test_name) seq;
6592 generate_test_command_call ~test test_name last
6593 | TestOutputTrue seq ->
6594 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6595 let seq, last = get_seq_last seq in
6598 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6603 List.iter (generate_test_command_call test_name) seq;
6604 generate_test_command_call ~test test_name last
6605 | TestOutputFalse seq ->
6606 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6607 let seq, last = get_seq_last seq in
6610 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6615 List.iter (generate_test_command_call test_name) seq;
6616 generate_test_command_call ~test test_name last
6617 | TestOutputLength (seq, expected) ->
6618 pr " /* TestOutputLength for %s (%d) */\n" name i;
6619 let seq, last = get_seq_last seq in
6622 pr " for (j = 0; j < %d; ++j)\n" expected;
6623 pr " if (r[j] == NULL) {\n";
6624 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6626 pr " print_strings (r);\n";
6629 pr " if (r[j] != NULL) {\n";
6630 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6632 pr " print_strings (r);\n";
6636 List.iter (generate_test_command_call test_name) seq;
6637 generate_test_command_call ~test test_name last
6638 | TestOutputBuffer (seq, expected) ->
6639 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6640 pr " const char *expected = \"%s\";\n" (c_quote expected);
6641 let seq, last = get_seq_last seq in
6642 let len = String.length expected in
6644 pr " if (size != %d) {\n" len;
6645 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6648 pr " if (STRNEQLEN (r, expected, size)) {\n";
6649 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6653 List.iter (generate_test_command_call test_name) seq;
6654 generate_test_command_call ~test test_name last
6655 | TestOutputStruct (seq, checks) ->
6656 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6657 let seq, last = get_seq_last seq in
6661 | CompareWithInt (field, expected) ->
6662 pr " if (r->%s != %d) {\n" field expected;
6663 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6664 test_name field expected;
6665 pr " (int) r->%s);\n" field;
6668 | CompareWithIntOp (field, op, expected) ->
6669 pr " if (!(r->%s %s %d)) {\n" field op expected;
6670 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
6671 test_name field op expected;
6672 pr " (int) r->%s);\n" field;
6675 | CompareWithString (field, expected) ->
6676 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
6677 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
6678 test_name field expected;
6679 pr " r->%s);\n" field;
6682 | CompareFieldsIntEq (field1, field2) ->
6683 pr " if (r->%s != r->%s) {\n" field1 field2;
6684 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
6685 test_name field1 field2;
6686 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
6689 | CompareFieldsStrEq (field1, field2) ->
6690 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
6691 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
6692 test_name field1 field2;
6693 pr " r->%s, r->%s);\n" field1 field2;
6698 List.iter (generate_test_command_call test_name) seq;
6699 generate_test_command_call ~test test_name last
6700 | TestLastFail seq ->
6701 pr " /* TestLastFail for %s (%d) */\n" name i;
6702 let seq, last = get_seq_last seq in
6703 List.iter (generate_test_command_call test_name) seq;
6704 generate_test_command_call test_name ~expect_error:true last
6706 (* Generate the code to run a command, leaving the result in 'r'.
6707 * If you expect to get an error then you should set expect_error:true.
6709 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
6711 | [] -> assert false
6713 (* Look up the command to find out what args/ret it has. *)
6716 let _, style, _, _, _, _, _ =
6717 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
6720 failwithf "%s: in test, command %s was not found" test_name name in
6722 if List.length (snd style) <> List.length args then
6723 failwithf "%s: in test, wrong number of args given to %s"
6730 | OptString n, "NULL" -> ()
6733 | Dev_or_Path n, arg
6735 | OptString n, arg ->
6736 pr " const char *%s = \"%s\";\n" n (c_quote arg);
6740 | FileIn _, _ | FileOut _, _ -> ()
6741 | StringList n, "" | DeviceList n, "" ->
6742 pr " const char *const %s[1] = { NULL };\n" n
6743 | StringList n, arg | DeviceList n, arg ->
6744 let strs = string_split " " arg in
6747 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
6749 pr " const char *const %s[] = {\n" n;
6751 fun i _ -> pr " %s_%d,\n" n i
6755 ) (List.combine (snd style) args);
6758 match fst style with
6759 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
6760 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6761 | RConstString _ | RConstOptString _ ->
6762 pr " const char *r;\n"; "NULL"
6763 | RString _ -> pr " char *r;\n"; "NULL"
6764 | RStringList _ | RHashtable _ ->
6768 | RStruct (_, typ) ->
6769 pr " struct guestfs_%s *r;\n" typ; "NULL"
6770 | RStructList (_, typ) ->
6771 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6774 pr " size_t size;\n";
6777 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
6778 pr " r = guestfs_%s (g" name;
6780 (* Generate the parameters. *)
6783 | OptString _, "NULL" -> pr ", NULL"
6785 | Device n, _ | Dev_or_Path n, _
6789 | FileIn _, arg | FileOut _, arg ->
6790 pr ", \"%s\"" (c_quote arg)
6791 | StringList n, _ | DeviceList n, _ ->
6792 pr ", (char **) %s" n
6795 try int_of_string arg
6796 with Failure "int_of_string" ->
6797 failwithf "%s: expecting an int, but got '%s'" test_name arg in
6801 try Int64.of_string arg
6802 with Failure "int_of_string" ->
6803 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
6806 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
6807 ) (List.combine (snd style) args);
6809 (match fst style with
6810 | RBufferOut _ -> pr ", &size"
6816 if not expect_error then
6817 pr " if (r == %s)\n" error_code
6819 pr " if (r != %s)\n" error_code;
6822 (* Insert the test code. *)
6828 (match fst style with
6829 | RErr | RInt _ | RInt64 _ | RBool _
6830 | RConstString _ | RConstOptString _ -> ()
6831 | RString _ | RBufferOut _ -> pr " free (r);\n"
6832 | RStringList _ | RHashtable _ ->
6833 pr " for (i = 0; r[i] != NULL; ++i)\n";
6834 pr " free (r[i]);\n";
6836 | RStruct (_, typ) ->
6837 pr " guestfs_free_%s (r);\n" typ
6838 | RStructList (_, typ) ->
6839 pr " guestfs_free_%s_list (r);\n" typ
6845 let str = replace_str str "\r" "\\r" in
6846 let str = replace_str str "\n" "\\n" in
6847 let str = replace_str str "\t" "\\t" in
6848 let str = replace_str str "\000" "\\0" in
6851 (* Generate a lot of different functions for guestfish. *)
6852 and generate_fish_cmds () =
6853 generate_header CStyle GPLv2plus;
6857 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6859 let all_functions_sorted =
6861 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6862 ) all_functions_sorted in
6864 pr "#include <stdio.h>\n";
6865 pr "#include <stdlib.h>\n";
6866 pr "#include <string.h>\n";
6867 pr "#include <inttypes.h>\n";
6869 pr "#include <guestfs.h>\n";
6870 pr "#include \"c-ctype.h\"\n";
6871 pr "#include \"fish.h\"\n";
6874 (* list_commands function, which implements guestfish -h *)
6875 pr "void list_commands (void)\n";
6877 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
6878 pr " list_builtin_commands ();\n";
6880 fun (name, _, _, flags, _, shortdesc, _) ->
6881 let name = replace_char name '_' '-' in
6882 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
6884 ) all_functions_sorted;
6885 pr " printf (\" %%s\\n\",";
6886 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
6890 (* display_command function, which implements guestfish -h cmd *)
6891 pr "void display_command (const char *cmd)\n";
6894 fun (name, style, _, flags, _, shortdesc, longdesc) ->
6895 let name2 = replace_char name '_' '-' in
6897 try find_map (function FishAlias n -> Some n | _ -> None) flags
6898 with Not_found -> name in
6899 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
6901 match snd style with
6905 name2 (String.concat " " (List.map name_of_argt args)) in
6908 if List.mem ProtocolLimitWarning flags then
6909 ("\n\n" ^ protocol_limit_warning)
6912 (* For DangerWillRobinson commands, we should probably have
6913 * guestfish prompt before allowing you to use them (especially
6914 * in interactive mode). XXX
6918 if List.mem DangerWillRobinson flags then
6919 ("\n\n" ^ danger_will_robinson)
6924 match deprecation_notice flags with
6926 | Some txt -> "\n\n" ^ txt in
6928 let describe_alias =
6929 if name <> alias then
6930 sprintf "\n\nYou can use '%s' as an alias for this command." alias
6934 pr "STRCASEEQ (cmd, \"%s\")" name;
6935 if name <> name2 then
6936 pr " || STRCASEEQ (cmd, \"%s\")" name2;
6937 if name <> alias then
6938 pr " || STRCASEEQ (cmd, \"%s\")" alias;
6940 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
6942 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
6943 "=head1 DESCRIPTION\n\n" ^
6944 longdesc ^ warnings ^ describe_alias);
6947 pr " display_builtin_command (cmd);\n";
6951 let emit_print_list_function typ =
6952 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
6955 pr " unsigned int i;\n";
6957 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6958 pr " printf (\"[%%d] = {\\n\", i);\n";
6959 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
6960 pr " printf (\"}\\n\");\n";
6966 (* print_* functions *)
6970 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
6972 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
6975 pr " unsigned int i;\n";
6981 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
6983 pr " printf (\"%%s%s: \", indent);\n" name;
6984 pr " for (i = 0; i < 32; ++i)\n";
6985 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
6986 pr " printf (\"\\n\");\n"
6988 pr " printf (\"%%s%s: \", indent);\n" name;
6989 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
6990 pr " if (c_isprint (%s->%s[i]))\n" typ name;
6991 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
6993 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
6994 pr " printf (\"\\n\");\n"
6995 | name, (FUInt64|FBytes) ->
6996 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
6999 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7002 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7005 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7008 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7010 | name, FOptPercent ->
7011 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7012 typ name name typ name;
7013 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7019 (* Emit a print_TYPE_list function definition only if that function is used. *)
7022 | typ, (RStructListOnly | RStructAndList) ->
7023 (* generate the function for typ *)
7024 emit_print_list_function typ
7025 | typ, _ -> () (* empty *)
7026 ) (rstructs_used_by all_functions);
7028 (* Emit a print_TYPE function definition only if that function is used. *)
7031 | typ, (RStructOnly | RStructAndList) ->
7032 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7034 pr " print_%s_indent (%s, \"\");\n" typ typ;
7037 | typ, _ -> () (* empty *)
7038 ) (rstructs_used_by all_functions);
7040 (* run_<action> actions *)
7042 fun (name, style, _, flags, _, _, _) ->
7043 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7045 (match fst style with
7048 | RBool _ -> pr " int r;\n"
7049 | RInt64 _ -> pr " int64_t r;\n"
7050 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7051 | RString _ -> pr " char *r;\n"
7052 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7053 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7054 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7057 pr " size_t size;\n";
7065 | FileOut n -> pr " const char *%s;\n" n
7067 | Dev_or_Path n -> pr " char *%s;\n" n
7068 | StringList n | DeviceList n -> pr " char **%s;\n" n
7069 | Bool n -> pr " int %s;\n" n
7070 | Int n -> pr " int %s;\n" n
7071 | Int64 n -> pr " int64_t %s;\n" n
7074 (* Check and convert parameters. *)
7075 let argc_expected = List.length (snd style) in
7076 pr " if (argc != %d) {\n" argc_expected;
7077 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7079 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7087 pr " %s = argv[%d];\n" name i
7089 | Dev_or_Path name ->
7090 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7091 pr " if (%s == NULL) return -1;\n" name
7093 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7096 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7099 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7101 | StringList name | DeviceList name ->
7102 pr " %s = parse_string_list (argv[%d]);\n" name i;
7103 pr " if (%s == NULL) return -1;\n" name;
7105 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7107 pr " %s = atoi (argv[%d]);\n" name i
7109 pr " %s = atoll (argv[%d]);\n" name i
7112 (* Call C API function. *)
7114 try find_map (function FishAction n -> Some n | _ -> None) flags
7115 with Not_found -> sprintf "guestfs_%s" name in
7117 generate_c_call_args ~handle:"g" style;
7122 | Device name | String name
7123 | OptString name | FileIn name | FileOut name | Bool name
7124 | Int name | Int64 name -> ()
7125 | Pathname name | Dev_or_Path name ->
7126 pr " free (%s);\n" name
7127 | StringList name | DeviceList name ->
7128 pr " free_strings (%s);\n" name
7131 (* Check return value for errors and display command results. *)
7132 (match fst style with
7133 | RErr -> pr " return r;\n"
7135 pr " if (r == -1) return -1;\n";
7136 pr " printf (\"%%d\\n\", r);\n";
7139 pr " if (r == -1) return -1;\n";
7140 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7143 pr " if (r == -1) return -1;\n";
7144 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7147 pr " if (r == NULL) return -1;\n";
7148 pr " printf (\"%%s\\n\", r);\n";
7150 | RConstOptString _ ->
7151 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7154 pr " if (r == NULL) return -1;\n";
7155 pr " printf (\"%%s\\n\", r);\n";
7159 pr " if (r == NULL) return -1;\n";
7160 pr " print_strings (r);\n";
7161 pr " free_strings (r);\n";
7163 | RStruct (_, typ) ->
7164 pr " if (r == NULL) return -1;\n";
7165 pr " print_%s (r);\n" typ;
7166 pr " guestfs_free_%s (r);\n" typ;
7168 | RStructList (_, typ) ->
7169 pr " if (r == NULL) return -1;\n";
7170 pr " print_%s_list (r);\n" typ;
7171 pr " guestfs_free_%s_list (r);\n" typ;
7174 pr " if (r == NULL) return -1;\n";
7175 pr " print_table (r);\n";
7176 pr " free_strings (r);\n";
7179 pr " if (r == NULL) return -1;\n";
7180 pr " fwrite (r, size, 1, stdout);\n";
7188 (* run_action function *)
7189 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7192 fun (name, _, _, flags, _, _, _) ->
7193 let name2 = replace_char name '_' '-' in
7195 try find_map (function FishAlias n -> Some n | _ -> None) flags
7196 with Not_found -> name in
7198 pr "STRCASEEQ (cmd, \"%s\")" name;
7199 if name <> name2 then
7200 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7201 if name <> alias then
7202 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7204 pr " return run_%s (cmd, argc, argv);\n" name;
7208 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7215 (* Readline completion for guestfish. *)
7216 and generate_fish_completion () =
7217 generate_header CStyle GPLv2plus;
7221 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7231 #ifdef HAVE_LIBREADLINE
7232 #include <readline/readline.h>
7237 #ifdef HAVE_LIBREADLINE
7239 static const char *const commands[] = {
7240 BUILTIN_COMMANDS_FOR_COMPLETION,
7243 (* Get the commands, including the aliases. They don't need to be
7244 * sorted - the generator() function just does a dumb linear search.
7248 fun (name, _, _, flags, _, _, _) ->
7249 let name2 = replace_char name '_' '-' in
7251 try find_map (function FishAlias n -> Some n | _ -> None) flags
7252 with Not_found -> name in
7254 if name <> alias then [name2; alias] else [name2]
7256 let commands = List.flatten commands in
7258 List.iter (pr " \"%s\",\n") commands;
7264 generator (const char *text, int state)
7266 static int index, len;
7271 len = strlen (text);
7274 rl_attempted_completion_over = 1;
7276 while ((name = commands[index]) != NULL) {
7278 if (STRCASEEQLEN (name, text, len))
7279 return strdup (name);
7285 #endif /* HAVE_LIBREADLINE */
7287 char **do_completion (const char *text, int start, int end)
7289 char **matches = NULL;
7291 #ifdef HAVE_LIBREADLINE
7292 rl_completion_append_character = ' ';
7295 matches = rl_completion_matches (text, generator);
7296 else if (complete_dest_paths)
7297 matches = rl_completion_matches (text, complete_dest_paths_generator);
7304 (* Generate the POD documentation for guestfish. *)
7305 and generate_fish_actions_pod () =
7306 let all_functions_sorted =
7308 fun (_, _, _, flags, _, _, _) ->
7309 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7310 ) all_functions_sorted in
7312 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7315 fun (name, style, _, flags, _, _, longdesc) ->
7317 Str.global_substitute rex (
7320 try Str.matched_group 1 s
7322 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7323 "C<" ^ replace_char sub '_' '-' ^ ">"
7325 let name = replace_char name '_' '-' in
7327 try find_map (function FishAlias n -> Some n | _ -> None) flags
7328 with Not_found -> name in
7330 pr "=head2 %s" name;
7331 if name <> alias then
7338 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7339 | OptString n -> pr " %s" n
7340 | StringList n | DeviceList n -> pr " '%s ...'" n
7341 | Bool _ -> pr " true|false"
7342 | Int n -> pr " %s" n
7343 | Int64 n -> pr " %s" n
7344 | FileIn n | FileOut n -> pr " (%s|-)" n
7348 pr "%s\n\n" longdesc;
7350 if List.exists (function FileIn _ | FileOut _ -> true
7351 | _ -> false) (snd style) then
7352 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7354 if List.mem ProtocolLimitWarning flags then
7355 pr "%s\n\n" protocol_limit_warning;
7357 if List.mem DangerWillRobinson flags then
7358 pr "%s\n\n" danger_will_robinson;
7360 match deprecation_notice flags with
7362 | Some txt -> pr "%s\n\n" txt
7363 ) all_functions_sorted
7365 (* Generate a C function prototype. *)
7366 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7367 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7369 ?handle name style =
7370 if extern then pr "extern ";
7371 if static then pr "static ";
7372 (match fst style with
7374 | RInt _ -> pr "int "
7375 | RInt64 _ -> pr "int64_t "
7376 | RBool _ -> pr "int "
7377 | RConstString _ | RConstOptString _ -> pr "const char *"
7378 | RString _ | RBufferOut _ -> pr "char *"
7379 | RStringList _ | RHashtable _ -> pr "char **"
7380 | RStruct (_, typ) ->
7381 if not in_daemon then pr "struct guestfs_%s *" typ
7382 else pr "guestfs_int_%s *" typ
7383 | RStructList (_, typ) ->
7384 if not in_daemon then pr "struct guestfs_%s_list *" typ
7385 else pr "guestfs_int_%s_list *" typ
7387 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7388 pr "%s%s (" prefix name;
7389 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7392 let comma = ref false in
7395 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7399 if single_line then pr ", " else pr ",\n\t\t"
7406 | Device n | Dev_or_Path n
7410 pr "const char *%s" n
7411 | StringList n | DeviceList n ->
7413 pr "char *const *%s" n
7414 | Bool n -> next (); pr "int %s" n
7415 | Int n -> next (); pr "int %s" n
7416 | Int64 n -> next (); pr "int64_t %s" n
7419 if not in_daemon then (next (); pr "const char *%s" n)
7421 if is_RBufferOut then (next (); pr "size_t *size_r");
7424 if semicolon then pr ";";
7425 if newline then pr "\n"
7427 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7428 and generate_c_call_args ?handle ?(decl = false) style =
7430 let comma = ref false in
7432 if !comma then pr ", ";
7437 | Some handle -> pr "%s" handle; comma := true
7442 pr "%s" (name_of_argt arg)
7444 (* For RBufferOut calls, add implicit &size parameter. *)
7446 match fst style with
7454 (* Generate the OCaml bindings interface. *)
7455 and generate_ocaml_mli () =
7456 generate_header OCamlStyle LGPLv2plus;
7459 (** For API documentation you should refer to the C API
7460 in the guestfs(3) manual page. The OCaml API uses almost
7461 exactly the same calls. *)
7464 (** A [guestfs_h] handle. *)
7466 exception Error of string
7467 (** This exception is raised when there is an error. *)
7469 exception Handle_closed of string
7470 (** This exception is raised if you use a {!Guestfs.t} handle
7471 after calling {!close} on it. The string is the name of
7474 val create : unit -> t
7475 (** Create a {!Guestfs.t} handle. *)
7477 val close : t -> unit
7478 (** Close the {!Guestfs.t} handle and free up all resources used
7481 Handles are closed by the garbage collector when they become
7482 unreferenced, but callers can call this in order to provide
7483 predictable cleanup. *)
7486 generate_ocaml_structure_decls ();
7490 fun (name, style, _, _, _, shortdesc, _) ->
7491 generate_ocaml_prototype name style;
7492 pr "(** %s *)\n" shortdesc;
7494 ) all_functions_sorted
7496 (* Generate the OCaml bindings implementation. *)
7497 and generate_ocaml_ml () =
7498 generate_header OCamlStyle LGPLv2plus;
7503 exception Error of string
7504 exception Handle_closed of string
7506 external create : unit -> t = \"ocaml_guestfs_create\"
7507 external close : t -> unit = \"ocaml_guestfs_close\"
7509 (* Give the exceptions names, so they can be raised from the C code. *)
7511 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7512 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7516 generate_ocaml_structure_decls ();
7520 fun (name, style, _, _, _, shortdesc, _) ->
7521 generate_ocaml_prototype ~is_external:true name style;
7522 ) all_functions_sorted
7524 (* Generate the OCaml bindings C implementation. *)
7525 and generate_ocaml_c () =
7526 generate_header CStyle LGPLv2plus;
7533 #include <caml/config.h>
7534 #include <caml/alloc.h>
7535 #include <caml/callback.h>
7536 #include <caml/fail.h>
7537 #include <caml/memory.h>
7538 #include <caml/mlvalues.h>
7539 #include <caml/signals.h>
7541 #include <guestfs.h>
7543 #include \"guestfs_c.h\"
7545 /* Copy a hashtable of string pairs into an assoc-list. We return
7546 * the list in reverse order, but hashtables aren't supposed to be
7549 static CAMLprim value
7550 copy_table (char * const * argv)
7553 CAMLlocal5 (rv, pairv, kv, vv, cons);
7557 for (i = 0; argv[i] != NULL; i += 2) {
7558 kv = caml_copy_string (argv[i]);
7559 vv = caml_copy_string (argv[i+1]);
7560 pairv = caml_alloc (2, 0);
7561 Store_field (pairv, 0, kv);
7562 Store_field (pairv, 1, vv);
7563 cons = caml_alloc (2, 0);
7564 Store_field (cons, 1, rv);
7566 Store_field (cons, 0, pairv);
7574 (* Struct copy functions. *)
7576 let emit_ocaml_copy_list_function typ =
7577 pr "static CAMLprim value\n";
7578 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7580 pr " CAMLparam0 ();\n";
7581 pr " CAMLlocal2 (rv, v);\n";
7582 pr " unsigned int i;\n";
7584 pr " if (%ss->len == 0)\n" typ;
7585 pr " CAMLreturn (Atom (0));\n";
7587 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7588 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7589 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7590 pr " caml_modify (&Field (rv, i), v);\n";
7592 pr " CAMLreturn (rv);\n";
7600 let has_optpercent_col =
7601 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7603 pr "static CAMLprim value\n";
7604 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7606 pr " CAMLparam0 ();\n";
7607 if has_optpercent_col then
7608 pr " CAMLlocal3 (rv, v, v2);\n"
7610 pr " CAMLlocal2 (rv, v);\n";
7612 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
7617 pr " v = caml_copy_string (%s->%s);\n" typ name
7619 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
7620 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
7623 pr " v = caml_alloc_string (32);\n";
7624 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
7625 | name, (FBytes|FInt64|FUInt64) ->
7626 pr " v = caml_copy_int64 (%s->%s);\n" typ name
7627 | name, (FInt32|FUInt32) ->
7628 pr " v = caml_copy_int32 (%s->%s);\n" typ name
7629 | name, FOptPercent ->
7630 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
7631 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
7632 pr " v = caml_alloc (1, 0);\n";
7633 pr " Store_field (v, 0, v2);\n";
7634 pr " } else /* None */\n";
7635 pr " v = Val_int (0);\n";
7637 pr " v = Val_int (%s->%s);\n" typ name
7639 pr " Store_field (rv, %d, v);\n" i
7641 pr " CAMLreturn (rv);\n";
7646 (* Emit a copy_TYPE_list function definition only if that function is used. *)
7649 | typ, (RStructListOnly | RStructAndList) ->
7650 (* generate the function for typ *)
7651 emit_ocaml_copy_list_function typ
7652 | typ, _ -> () (* empty *)
7653 ) (rstructs_used_by all_functions);
7657 fun (name, style, _, _, _, _, _) ->
7658 pr "/* Automatically generated wrapper for function\n";
7660 generate_ocaml_prototype name style;
7665 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
7667 let needs_extra_vs =
7668 match fst style with RConstOptString _ -> true | _ -> false in
7670 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7671 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
7672 List.iter (pr ", value %s") (List.tl params); pr ");\n";
7675 pr "CAMLprim value\n";
7676 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
7677 List.iter (pr ", value %s") (List.tl params);
7682 | [p1; p2; p3; p4; p5] ->
7683 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
7684 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
7685 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
7686 pr " CAMLxparam%d (%s);\n"
7687 (List.length rest) (String.concat ", " rest)
7689 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
7691 if not needs_extra_vs then
7692 pr " CAMLlocal1 (rv);\n"
7694 pr " CAMLlocal3 (rv, v, v2);\n";
7697 pr " guestfs_h *g = Guestfs_val (gv);\n";
7698 pr " if (g == NULL)\n";
7699 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
7705 | Device n | Dev_or_Path n
7709 pr " const char *%s = String_val (%sv);\n" n n
7711 pr " const char *%s =\n" n;
7712 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
7714 | StringList n | DeviceList n ->
7715 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
7717 pr " int %s = Bool_val (%sv);\n" n n
7719 pr " int %s = Int_val (%sv);\n" n n
7721 pr " int64_t %s = Int64_val (%sv);\n" n n
7724 match fst style with
7725 | RErr -> pr " int r;\n"; "-1"
7726 | RInt _ -> pr " int r;\n"; "-1"
7727 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7728 | RBool _ -> pr " int r;\n"; "-1"
7729 | RConstString _ | RConstOptString _ ->
7730 pr " const char *r;\n"; "NULL"
7731 | RString _ -> pr " char *r;\n"; "NULL"
7736 | RStruct (_, typ) ->
7737 pr " struct guestfs_%s *r;\n" typ; "NULL"
7738 | RStructList (_, typ) ->
7739 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7746 pr " size_t size;\n";
7750 pr " caml_enter_blocking_section ();\n";
7751 pr " r = guestfs_%s " name;
7752 generate_c_call_args ~handle:"g" style;
7754 pr " caml_leave_blocking_section ();\n";
7758 | StringList n | DeviceList n ->
7759 pr " ocaml_guestfs_free_strings (%s);\n" n;
7760 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
7761 | Bool _ | Int _ | Int64 _
7762 | FileIn _ | FileOut _ -> ()
7765 pr " if (r == %s)\n" error_code;
7766 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
7769 (match fst style with
7770 | RErr -> pr " rv = Val_unit;\n"
7771 | RInt _ -> pr " rv = Val_int (r);\n"
7773 pr " rv = caml_copy_int64 (r);\n"
7774 | RBool _ -> pr " rv = Val_bool (r);\n"
7776 pr " rv = caml_copy_string (r);\n"
7777 | RConstOptString _ ->
7778 pr " if (r) { /* Some string */\n";
7779 pr " v = caml_alloc (1, 0);\n";
7780 pr " v2 = caml_copy_string (r);\n";
7781 pr " Store_field (v, 0, v2);\n";
7782 pr " } else /* None */\n";
7783 pr " v = Val_int (0);\n";
7785 pr " rv = caml_copy_string (r);\n";
7788 pr " rv = caml_copy_string_array ((const char **) r);\n";
7789 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7791 | RStruct (_, typ) ->
7792 pr " rv = copy_%s (r);\n" typ;
7793 pr " guestfs_free_%s (r);\n" typ;
7794 | RStructList (_, typ) ->
7795 pr " rv = copy_%s_list (r);\n" typ;
7796 pr " guestfs_free_%s_list (r);\n" typ;
7798 pr " rv = copy_table (r);\n";
7799 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
7802 pr " rv = caml_alloc_string (size);\n";
7803 pr " memcpy (String_val (rv), r, size);\n";
7806 pr " CAMLreturn (rv);\n";
7810 if List.length params > 5 then (
7811 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
7812 pr "CAMLprim value ";
7813 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
7814 pr "CAMLprim value\n";
7815 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
7817 pr " return ocaml_guestfs_%s (argv[0]" name;
7818 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
7823 ) all_functions_sorted
7825 and generate_ocaml_structure_decls () =
7828 pr "type %s = {\n" typ;
7831 | name, FString -> pr " %s : string;\n" name
7832 | name, FBuffer -> pr " %s : string;\n" name
7833 | name, FUUID -> pr " %s : string;\n" name
7834 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
7835 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
7836 | name, FChar -> pr " %s : char;\n" name
7837 | name, FOptPercent -> pr " %s : float option;\n" name
7843 and generate_ocaml_prototype ?(is_external = false) name style =
7844 if is_external then pr "external " else pr "val ";
7845 pr "%s : t -> " name;
7848 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
7849 | OptString _ -> pr "string option -> "
7850 | StringList _ | DeviceList _ -> pr "string array -> "
7851 | Bool _ -> pr "bool -> "
7852 | Int _ -> pr "int -> "
7853 | Int64 _ -> pr "int64 -> "
7855 (match fst style with
7856 | RErr -> pr "unit" (* all errors are turned into exceptions *)
7857 | RInt _ -> pr "int"
7858 | RInt64 _ -> pr "int64"
7859 | RBool _ -> pr "bool"
7860 | RConstString _ -> pr "string"
7861 | RConstOptString _ -> pr "string option"
7862 | RString _ | RBufferOut _ -> pr "string"
7863 | RStringList _ -> pr "string array"
7864 | RStruct (_, typ) -> pr "%s" typ
7865 | RStructList (_, typ) -> pr "%s array" typ
7866 | RHashtable _ -> pr "(string * string) list"
7868 if is_external then (
7870 if List.length (snd style) + 1 > 5 then
7871 pr "\"ocaml_guestfs_%s_byte\" " name;
7872 pr "\"ocaml_guestfs_%s\"" name
7876 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
7877 and generate_perl_xs () =
7878 generate_header CStyle LGPLv2plus;
7881 #include \"EXTERN.h\"
7885 #include <guestfs.h>
7888 #define PRId64 \"lld\"
7892 my_newSVll(long long val) {
7893 #ifdef USE_64_BIT_ALL
7894 return newSViv(val);
7898 len = snprintf(buf, 100, \"%%\" PRId64, val);
7899 return newSVpv(buf, len);
7904 #define PRIu64 \"llu\"
7908 my_newSVull(unsigned long long val) {
7909 #ifdef USE_64_BIT_ALL
7910 return newSVuv(val);
7914 len = snprintf(buf, 100, \"%%\" PRIu64, val);
7915 return newSVpv(buf, len);
7919 /* http://www.perlmonks.org/?node_id=680842 */
7921 XS_unpack_charPtrPtr (SV *arg) {
7926 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
7927 croak (\"array reference expected\");
7929 av = (AV *)SvRV (arg);
7930 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
7932 croak (\"malloc failed\");
7934 for (i = 0; i <= av_len (av); i++) {
7935 SV **elem = av_fetch (av, i, 0);
7937 if (!elem || !*elem)
7938 croak (\"missing element in list\");
7940 ret[i] = SvPV_nolen (*elem);
7948 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
7955 RETVAL = guestfs_create ();
7957 croak (\"could not create guestfs handle\");
7958 guestfs_set_error_handler (RETVAL, NULL, NULL);
7971 fun (name, style, _, _, _, _, _) ->
7972 (match fst style with
7973 | RErr -> pr "void\n"
7974 | RInt _ -> pr "SV *\n"
7975 | RInt64 _ -> pr "SV *\n"
7976 | RBool _ -> pr "SV *\n"
7977 | RConstString _ -> pr "SV *\n"
7978 | RConstOptString _ -> pr "SV *\n"
7979 | RString _ -> pr "SV *\n"
7980 | RBufferOut _ -> pr "SV *\n"
7982 | RStruct _ | RStructList _
7984 pr "void\n" (* all lists returned implictly on the stack *)
7986 (* Call and arguments. *)
7988 generate_c_call_args ~handle:"g" ~decl:true style;
7990 pr " guestfs_h *g;\n";
7994 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
7997 (* http://www.perlmonks.org/?node_id=554277
7998 * Note that the implicit handle argument means we have
7999 * to add 1 to the ST(x) operator.
8001 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8002 | StringList n | DeviceList n -> pr " char **%s;\n" n
8003 | Bool n -> pr " int %s;\n" n
8004 | Int n -> pr " int %s;\n" n
8005 | Int64 n -> pr " int64_t %s;\n" n
8008 let do_cleanups () =
8011 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8012 | Bool _ | Int _ | Int64 _
8013 | FileIn _ | FileOut _ -> ()
8014 | StringList n | DeviceList n -> pr " free (%s);\n" n
8019 (match fst style with
8024 pr " r = guestfs_%s " name;
8025 generate_c_call_args ~handle:"g" style;
8028 pr " if (r == -1)\n";
8029 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8035 pr " %s = guestfs_%s " n name;
8036 generate_c_call_args ~handle:"g" style;
8039 pr " if (%s == -1)\n" n;
8040 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8041 pr " RETVAL = newSViv (%s);\n" n;
8046 pr " int64_t %s;\n" n;
8048 pr " %s = guestfs_%s " n name;
8049 generate_c_call_args ~handle:"g" style;
8052 pr " if (%s == -1)\n" n;
8053 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8054 pr " RETVAL = my_newSVll (%s);\n" n;
8059 pr " const char *%s;\n" n;
8061 pr " %s = guestfs_%s " n name;
8062 generate_c_call_args ~handle:"g" style;
8065 pr " if (%s == NULL)\n" n;
8066 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8067 pr " RETVAL = newSVpv (%s, 0);\n" n;
8070 | RConstOptString n ->
8072 pr " const char *%s;\n" n;
8074 pr " %s = guestfs_%s " n name;
8075 generate_c_call_args ~handle:"g" style;
8078 pr " if (%s == NULL)\n" n;
8079 pr " RETVAL = &PL_sv_undef;\n";
8081 pr " RETVAL = newSVpv (%s, 0);\n" n;
8086 pr " char *%s;\n" n;
8088 pr " %s = guestfs_%s " n name;
8089 generate_c_call_args ~handle:"g" style;
8092 pr " if (%s == NULL)\n" n;
8093 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8094 pr " RETVAL = newSVpv (%s, 0);\n" n;
8095 pr " free (%s);\n" n;
8098 | RStringList n | RHashtable n ->
8100 pr " char **%s;\n" n;
8103 pr " %s = guestfs_%s " n name;
8104 generate_c_call_args ~handle:"g" style;
8107 pr " if (%s == NULL)\n" n;
8108 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8109 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8110 pr " EXTEND (SP, n);\n";
8111 pr " for (i = 0; i < n; ++i) {\n";
8112 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8113 pr " free (%s[i]);\n" n;
8115 pr " free (%s);\n" n;
8116 | RStruct (n, typ) ->
8117 let cols = cols_of_struct typ in
8118 generate_perl_struct_code typ cols name style n do_cleanups
8119 | RStructList (n, typ) ->
8120 let cols = cols_of_struct typ in
8121 generate_perl_struct_list_code typ cols name style n do_cleanups
8124 pr " char *%s;\n" n;
8125 pr " size_t size;\n";
8127 pr " %s = guestfs_%s " n name;
8128 generate_c_call_args ~handle:"g" style;
8131 pr " if (%s == NULL)\n" n;
8132 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8133 pr " RETVAL = newSVpv (%s, size);\n" n;
8134 pr " free (%s);\n" n;
8142 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8144 pr " struct guestfs_%s_list *%s;\n" typ n;
8148 pr " %s = guestfs_%s " n name;
8149 generate_c_call_args ~handle:"g" style;
8152 pr " if (%s == NULL)\n" n;
8153 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8154 pr " EXTEND (SP, %s->len);\n" n;
8155 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8156 pr " hv = newHV ();\n";
8160 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8161 name (String.length name) n name
8163 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8164 name (String.length name) n name
8166 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8167 name (String.length name) n name n name
8168 | name, (FBytes|FUInt64) ->
8169 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8170 name (String.length name) n name
8172 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8173 name (String.length name) n name
8174 | name, (FInt32|FUInt32) ->
8175 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8176 name (String.length name) n name
8178 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8179 name (String.length name) n name
8180 | name, FOptPercent ->
8181 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8182 name (String.length name) n name
8184 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8186 pr " guestfs_free_%s_list (%s);\n" typ n
8188 and generate_perl_struct_code typ cols name style n do_cleanups =
8190 pr " struct guestfs_%s *%s;\n" typ n;
8192 pr " %s = guestfs_%s " n name;
8193 generate_c_call_args ~handle:"g" style;
8196 pr " if (%s == NULL)\n" n;
8197 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
8198 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8200 fun ((name, _) as col) ->
8201 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8205 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8208 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
8211 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8213 | name, (FBytes|FUInt64) ->
8214 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8217 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8219 | name, (FInt32|FUInt32) ->
8220 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8223 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8225 | name, FOptPercent ->
8226 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8229 pr " free (%s);\n" n
8231 (* Generate Sys/Guestfs.pm. *)
8232 and generate_perl_pm () =
8233 generate_header HashStyle LGPLv2plus;
8240 Sys::Guestfs - Perl bindings for libguestfs
8246 my $h = Sys::Guestfs->new ();
8247 $h->add_drive ('guest.img');
8249 $h->mount ('/dev/sda1', '/');
8250 $h->touch ('/hello');
8255 The C<Sys::Guestfs> module provides a Perl XS binding to the
8256 libguestfs API for examining and modifying virtual machine
8259 Amongst the things this is good for: making batch configuration
8260 changes to guests, getting disk used/free statistics (see also:
8261 virt-df), migrating between virtualization systems (see also:
8262 virt-p2v), performing partial backups, performing partial guest
8263 clones, cloning guests and changing registry/UUID/hostname info, and
8266 Libguestfs uses Linux kernel and qemu code, and can access any type of
8267 guest filesystem that Linux and qemu can, including but not limited
8268 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8269 schemes, qcow, qcow2, vmdk.
8271 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8272 LVs, what filesystem is in each LV, etc.). It can also run commands
8273 in the context of the guest. Also you can access filesystems over FTP.
8275 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8276 functions for using libguestfs from Perl, including integration
8281 All errors turn into calls to C<croak> (see L<Carp(3)>).
8289 package Sys::Guestfs;
8295 XSLoader::load ('Sys::Guestfs');
8297 =item $h = Sys::Guestfs->new ();
8299 Create a new guestfs handle.
8305 my $class = ref ($proto) || $proto;
8307 my $self = Sys::Guestfs::_create ();
8308 bless $self, $class;
8314 (* Actions. We only need to print documentation for these as
8315 * they are pulled in from the XS code automatically.
8318 fun (name, style, _, flags, _, _, longdesc) ->
8319 if not (List.mem NotInDocs flags) then (
8320 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8322 generate_perl_prototype name style;
8324 pr "%s\n\n" longdesc;
8325 if List.mem ProtocolLimitWarning flags then
8326 pr "%s\n\n" protocol_limit_warning;
8327 if List.mem DangerWillRobinson flags then
8328 pr "%s\n\n" danger_will_robinson;
8329 match deprecation_notice flags with
8331 | Some txt -> pr "%s\n\n" txt
8333 ) all_functions_sorted;
8345 Copyright (C) %s Red Hat Inc.
8349 Please see the file COPYING.LIB for the full license.
8355 L<http://libguestfs.org>,
8356 L<Sys::Guestfs::Lib(3)>.
8361 and generate_perl_prototype name style =
8362 (match fst style with
8370 | RBufferOut n -> pr "$%s = " n
8372 | RHashtable n -> pr "%%%s = " n
8374 | RStructList (n,_) -> pr "@%s = " n
8377 let comma = ref false in
8380 if !comma then pr ", ";
8383 | Pathname n | Device n | Dev_or_Path n | String n
8384 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8386 | StringList n | DeviceList n ->
8391 (* Generate Python C module. *)
8392 and generate_python_c () =
8393 generate_header CStyle LGPLv2plus;
8402 #include \"guestfs.h\"
8410 get_handle (PyObject *obj)
8413 assert (obj != Py_None);
8414 return ((Pyguestfs_Object *) obj)->g;
8418 put_handle (guestfs_h *g)
8422 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8425 /* This list should be freed (but not the strings) after use. */
8427 get_string_list (PyObject *obj)
8434 if (!PyList_Check (obj)) {
8435 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8439 len = PyList_Size (obj);
8440 r = malloc (sizeof (char *) * (len+1));
8442 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8446 for (i = 0; i < len; ++i)
8447 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8454 put_string_list (char * const * const argv)
8459 for (argc = 0; argv[argc] != NULL; ++argc)
8462 list = PyList_New (argc);
8463 for (i = 0; i < argc; ++i)
8464 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8470 put_table (char * const * const argv)
8472 PyObject *list, *item;
8475 for (argc = 0; argv[argc] != NULL; ++argc)
8478 list = PyList_New (argc >> 1);
8479 for (i = 0; i < argc; i += 2) {
8480 item = PyTuple_New (2);
8481 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8482 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8483 PyList_SetItem (list, i >> 1, item);
8490 free_strings (char **argv)
8494 for (argc = 0; argv[argc] != NULL; ++argc)
8500 py_guestfs_create (PyObject *self, PyObject *args)
8504 g = guestfs_create ();
8506 PyErr_SetString (PyExc_RuntimeError,
8507 \"guestfs.create: failed to allocate handle\");
8510 guestfs_set_error_handler (g, NULL, NULL);
8511 return put_handle (g);
8515 py_guestfs_close (PyObject *self, PyObject *args)
8520 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8522 g = get_handle (py_g);
8526 Py_INCREF (Py_None);
8532 let emit_put_list_function typ =
8533 pr "static PyObject *\n";
8534 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8536 pr " PyObject *list;\n";
8539 pr " list = PyList_New (%ss->len);\n" typ;
8540 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8541 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8542 pr " return list;\n";
8547 (* Structures, turned into Python dictionaries. *)
8550 pr "static PyObject *\n";
8551 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8553 pr " PyObject *dict;\n";
8555 pr " dict = PyDict_New ();\n";
8559 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8560 pr " PyString_FromString (%s->%s));\n"
8563 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8564 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8567 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8568 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8570 | name, (FBytes|FUInt64) ->
8571 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8572 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8575 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8576 pr " PyLong_FromLongLong (%s->%s));\n"
8579 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8580 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8583 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8584 pr " PyLong_FromLong (%s->%s));\n"
8586 | name, FOptPercent ->
8587 pr " if (%s->%s >= 0)\n" typ name;
8588 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8589 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8592 pr " Py_INCREF (Py_None);\n";
8593 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8596 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8597 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8599 pr " return dict;\n";
8605 (* Emit a put_TYPE_list function definition only if that function is used. *)
8608 | typ, (RStructListOnly | RStructAndList) ->
8609 (* generate the function for typ *)
8610 emit_put_list_function typ
8611 | typ, _ -> () (* empty *)
8612 ) (rstructs_used_by all_functions);
8614 (* Python wrapper functions. *)
8616 fun (name, style, _, _, _, _, _) ->
8617 pr "static PyObject *\n";
8618 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
8621 pr " PyObject *py_g;\n";
8622 pr " guestfs_h *g;\n";
8623 pr " PyObject *py_r;\n";
8626 match fst style with
8627 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8628 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8629 | RConstString _ | RConstOptString _ ->
8630 pr " const char *r;\n"; "NULL"
8631 | RString _ -> pr " char *r;\n"; "NULL"
8632 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8633 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8634 | RStructList (_, typ) ->
8635 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8638 pr " size_t size;\n";
8643 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8644 pr " const char *%s;\n" n
8645 | OptString n -> pr " const char *%s;\n" n
8646 | StringList n | DeviceList n ->
8647 pr " PyObject *py_%s;\n" n;
8648 pr " char **%s;\n" n
8649 | Bool n -> pr " int %s;\n" n
8650 | Int n -> pr " int %s;\n" n
8651 | Int64 n -> pr " long long %s;\n" n
8656 (* Convert the parameters. *)
8657 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
8660 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
8661 | OptString _ -> pr "z"
8662 | StringList _ | DeviceList _ -> pr "O"
8663 | Bool _ -> pr "i" (* XXX Python has booleans? *)
8665 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
8666 * emulate C's int/long/long long in Python?
8669 pr ":guestfs_%s\",\n" name;
8673 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
8674 | OptString n -> pr ", &%s" n
8675 | StringList n | DeviceList n -> pr ", &py_%s" n
8676 | Bool n -> pr ", &%s" n
8677 | Int n -> pr ", &%s" n
8678 | Int64 n -> pr ", &%s" n
8682 pr " return NULL;\n";
8684 pr " g = get_handle (py_g);\n";
8687 | Pathname _ | Device _ | Dev_or_Path _ | String _
8688 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8689 | StringList n | DeviceList n ->
8690 pr " %s = get_string_list (py_%s);\n" n n;
8691 pr " if (!%s) return NULL;\n" n
8696 pr " r = guestfs_%s " name;
8697 generate_c_call_args ~handle:"g" style;
8702 | Pathname _ | Device _ | Dev_or_Path _ | String _
8703 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
8704 | StringList n | DeviceList n ->
8705 pr " free (%s);\n" n
8708 pr " if (r == %s) {\n" error_code;
8709 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
8710 pr " return NULL;\n";
8714 (match fst style with
8716 pr " Py_INCREF (Py_None);\n";
8717 pr " py_r = Py_None;\n"
8719 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
8720 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
8721 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
8722 | RConstOptString _ ->
8724 pr " py_r = PyString_FromString (r);\n";
8726 pr " Py_INCREF (Py_None);\n";
8727 pr " py_r = Py_None;\n";
8730 pr " py_r = PyString_FromString (r);\n";
8733 pr " py_r = put_string_list (r);\n";
8734 pr " free_strings (r);\n"
8735 | RStruct (_, typ) ->
8736 pr " py_r = put_%s (r);\n" typ;
8737 pr " guestfs_free_%s (r);\n" typ
8738 | RStructList (_, typ) ->
8739 pr " py_r = put_%s_list (r);\n" typ;
8740 pr " guestfs_free_%s_list (r);\n" typ
8742 pr " py_r = put_table (r);\n";
8743 pr " free_strings (r);\n"
8745 pr " py_r = PyString_FromStringAndSize (r, size);\n";
8749 pr " return py_r;\n";
8754 (* Table of functions. *)
8755 pr "static PyMethodDef methods[] = {\n";
8756 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
8757 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
8759 fun (name, _, _, _, _, _, _) ->
8760 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
8763 pr " { NULL, NULL, 0, NULL }\n";
8767 (* Init function. *)
8770 initlibguestfsmod (void)
8772 static int initialized = 0;
8774 if (initialized) return;
8775 Py_InitModule ((char *) \"libguestfsmod\", methods);
8780 (* Generate Python module. *)
8781 and generate_python_py () =
8782 generate_header HashStyle LGPLv2plus;
8785 u\"\"\"Python bindings for libguestfs
8788 g = guestfs.GuestFS ()
8789 g.add_drive (\"guest.img\")
8791 parts = g.list_partitions ()
8793 The guestfs module provides a Python binding to the libguestfs API
8794 for examining and modifying virtual machine disk images.
8796 Amongst the things this is good for: making batch configuration
8797 changes to guests, getting disk used/free statistics (see also:
8798 virt-df), migrating between virtualization systems (see also:
8799 virt-p2v), performing partial backups, performing partial guest
8800 clones, cloning guests and changing registry/UUID/hostname info, and
8803 Libguestfs uses Linux kernel and qemu code, and can access any type of
8804 guest filesystem that Linux and qemu can, including but not limited
8805 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8806 schemes, qcow, qcow2, vmdk.
8808 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8809 LVs, what filesystem is in each LV, etc.). It can also run commands
8810 in the context of the guest. Also you can access filesystems over FTP.
8812 Errors which happen while using the API are turned into Python
8813 RuntimeError exceptions.
8815 To create a guestfs handle you usually have to perform the following
8818 # Create the handle, call add_drive at least once, and possibly
8819 # several times if the guest has multiple block devices:
8820 g = guestfs.GuestFS ()
8821 g.add_drive (\"guest.img\")
8823 # Launch the qemu subprocess and wait for it to become ready:
8826 # Now you can issue commands, for example:
8831 import libguestfsmod
8834 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
8836 def __init__ (self):
8837 \"\"\"Create a new libguestfs handle.\"\"\"
8838 self._o = libguestfsmod.create ()
8841 libguestfsmod.close (self._o)
8846 fun (name, style, _, flags, _, _, longdesc) ->
8848 generate_py_call_args ~handle:"self" (snd style);
8851 if not (List.mem NotInDocs flags) then (
8852 let doc = replace_str longdesc "C<guestfs_" "C<g." in
8854 match fst style with
8855 | RErr | RInt _ | RInt64 _ | RBool _
8856 | RConstOptString _ | RConstString _
8857 | RString _ | RBufferOut _ -> doc
8859 doc ^ "\n\nThis function returns a list of strings."
8860 | RStruct (_, typ) ->
8861 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
8862 | RStructList (_, typ) ->
8863 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
8865 doc ^ "\n\nThis function returns a dictionary." in
8867 if List.mem ProtocolLimitWarning flags then
8868 doc ^ "\n\n" ^ protocol_limit_warning
8871 if List.mem DangerWillRobinson flags then
8872 doc ^ "\n\n" ^ danger_will_robinson
8875 match deprecation_notice flags with
8877 | Some txt -> doc ^ "\n\n" ^ txt in
8878 let doc = pod2text ~width:60 name doc in
8879 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
8880 let doc = String.concat "\n " doc in
8881 pr " u\"\"\"%s\"\"\"\n" doc;
8883 pr " return libguestfsmod.%s " name;
8884 generate_py_call_args ~handle:"self._o" (snd style);
8889 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
8890 and generate_py_call_args ~handle args =
8892 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
8895 (* Useful if you need the longdesc POD text as plain text. Returns a
8898 * Because this is very slow (the slowest part of autogeneration),
8899 * we memoize the results.
8901 and pod2text ~width name longdesc =
8902 let key = width, name, longdesc in
8903 try Hashtbl.find pod2text_memo key
8905 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
8906 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
8908 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
8909 let chan = open_process_in cmd in
8910 let lines = ref [] in
8912 let line = input_line chan in
8913 if i = 1 then (* discard the first line of output *)
8916 let line = triml line in
8917 lines := line :: !lines;
8920 let lines = try loop 1 with End_of_file -> List.rev !lines in
8922 (match close_process_in chan with
8925 failwithf "pod2text: process exited with non-zero status (%d)" i
8926 | WSIGNALED i | WSTOPPED i ->
8927 failwithf "pod2text: process signalled or stopped by signal %d" i
8929 Hashtbl.add pod2text_memo key lines;
8930 pod2text_memo_updated ();
8933 (* Generate ruby bindings. *)
8934 and generate_ruby_c () =
8935 generate_header CStyle LGPLv2plus;
8943 #include \"guestfs.h\"
8945 #include \"extconf.h\"
8947 /* For Ruby < 1.9 */
8949 #define RARRAY_LEN(r) (RARRAY((r))->len)
8952 static VALUE m_guestfs; /* guestfs module */
8953 static VALUE c_guestfs; /* guestfs_h handle */
8954 static VALUE e_Error; /* used for all errors */
8956 static void ruby_guestfs_free (void *p)
8959 guestfs_close ((guestfs_h *) p);
8962 static VALUE ruby_guestfs_create (VALUE m)
8966 g = guestfs_create ();
8968 rb_raise (e_Error, \"failed to create guestfs handle\");
8970 /* Don't print error messages to stderr by default. */
8971 guestfs_set_error_handler (g, NULL, NULL);
8973 /* Wrap it, and make sure the close function is called when the
8976 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
8979 static VALUE ruby_guestfs_close (VALUE gv)
8982 Data_Get_Struct (gv, guestfs_h, g);
8984 ruby_guestfs_free (g);
8985 DATA_PTR (gv) = NULL;
8993 fun (name, style, _, _, _, _, _) ->
8994 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
8995 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
8998 pr " guestfs_h *g;\n";
8999 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9001 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9007 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9008 pr " Check_Type (%sv, T_STRING);\n" n;
9009 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9011 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9012 pr " \"%s\", \"%s\");\n" n name
9014 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9015 | StringList n | DeviceList n ->
9016 pr " char **%s;\n" n;
9017 pr " Check_Type (%sv, T_ARRAY);\n" n;
9019 pr " int i, len;\n";
9020 pr " len = RARRAY_LEN (%sv);\n" n;
9021 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9023 pr " for (i = 0; i < len; ++i) {\n";
9024 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9025 pr " %s[i] = StringValueCStr (v);\n" n;
9027 pr " %s[len] = NULL;\n" n;
9030 pr " int %s = RTEST (%sv);\n" n n
9032 pr " int %s = NUM2INT (%sv);\n" n n
9034 pr " long long %s = NUM2LL (%sv);\n" n n
9039 match fst style with
9040 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9041 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9042 | RConstString _ | RConstOptString _ ->
9043 pr " const char *r;\n"; "NULL"
9044 | RString _ -> pr " char *r;\n"; "NULL"
9045 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9046 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9047 | RStructList (_, typ) ->
9048 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9051 pr " size_t size;\n";
9055 pr " r = guestfs_%s " name;
9056 generate_c_call_args ~handle:"g" style;
9061 | Pathname _ | Device _ | Dev_or_Path _ | String _
9062 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9063 | StringList n | DeviceList n ->
9064 pr " free (%s);\n" n
9067 pr " if (r == %s)\n" error_code;
9068 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9071 (match fst style with
9073 pr " return Qnil;\n"
9074 | RInt _ | RBool _ ->
9075 pr " return INT2NUM (r);\n"
9077 pr " return ULL2NUM (r);\n"
9079 pr " return rb_str_new2 (r);\n";
9080 | RConstOptString _ ->
9082 pr " return rb_str_new2 (r);\n";
9084 pr " return Qnil;\n";
9086 pr " VALUE rv = rb_str_new2 (r);\n";
9090 pr " int i, len = 0;\n";
9091 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9092 pr " VALUE rv = rb_ary_new2 (len);\n";
9093 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9094 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9095 pr " free (r[i]);\n";
9099 | RStruct (_, typ) ->
9100 let cols = cols_of_struct typ in
9101 generate_ruby_struct_code typ cols
9102 | RStructList (_, typ) ->
9103 let cols = cols_of_struct typ in
9104 generate_ruby_struct_list_code typ cols
9106 pr " VALUE rv = rb_hash_new ();\n";
9108 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9109 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9110 pr " free (r[i]);\n";
9111 pr " free (r[i+1]);\n";
9116 pr " VALUE rv = rb_str_new (r, size);\n";
9126 /* Initialize the module. */
9127 void Init__guestfs ()
9129 m_guestfs = rb_define_module (\"Guestfs\");
9130 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9131 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9133 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9134 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9137 (* Define the rest of the methods. *)
9139 fun (name, style, _, _, _, _, _) ->
9140 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9141 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9146 (* Ruby code to return a struct. *)
9147 and generate_ruby_struct_code typ cols =
9148 pr " VALUE rv = rb_hash_new ();\n";
9152 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9154 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9156 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9157 | name, (FBytes|FUInt64) ->
9158 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9160 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9162 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9164 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9165 | name, FOptPercent ->
9166 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9167 | name, FChar -> (* XXX wrong? *)
9168 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9170 pr " guestfs_free_%s (r);\n" typ;
9173 (* Ruby code to return a struct list. *)
9174 and generate_ruby_struct_list_code typ cols =
9175 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9177 pr " for (i = 0; i < r->len; ++i) {\n";
9178 pr " VALUE hv = rb_hash_new ();\n";
9182 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9184 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
9186 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9187 | name, (FBytes|FUInt64) ->
9188 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9190 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9192 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9194 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9195 | name, FOptPercent ->
9196 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9197 | name, FChar -> (* XXX wrong? *)
9198 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9200 pr " rb_ary_push (rv, hv);\n";
9202 pr " guestfs_free_%s_list (r);\n" typ;
9205 (* Generate Java bindings GuestFS.java file. *)
9206 and generate_java_java () =
9207 generate_header CStyle LGPLv2plus;
9210 package com.redhat.et.libguestfs;
9212 import java.util.HashMap;
9213 import com.redhat.et.libguestfs.LibGuestFSException;
9214 import com.redhat.et.libguestfs.PV;
9215 import com.redhat.et.libguestfs.VG;
9216 import com.redhat.et.libguestfs.LV;
9217 import com.redhat.et.libguestfs.Stat;
9218 import com.redhat.et.libguestfs.StatVFS;
9219 import com.redhat.et.libguestfs.IntBool;
9220 import com.redhat.et.libguestfs.Dirent;
9223 * The GuestFS object is a libguestfs handle.
9227 public class GuestFS {
9228 // Load the native code.
9230 System.loadLibrary (\"guestfs_jni\");
9234 * The native guestfs_h pointer.
9239 * Create a libguestfs handle.
9241 * @throws LibGuestFSException
9243 public GuestFS () throws LibGuestFSException
9247 private native long _create () throws LibGuestFSException;
9250 * Close a libguestfs handle.
9252 * You can also leave handles to be collected by the garbage
9253 * collector, but this method ensures that the resources used
9254 * by the handle are freed up immediately. If you call any
9255 * other methods after closing the handle, you will get an
9258 * @throws LibGuestFSException
9260 public void close () throws LibGuestFSException
9266 private native void _close (long g) throws LibGuestFSException;
9268 public void finalize () throws LibGuestFSException
9276 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9277 if not (List.mem NotInDocs flags); then (
9278 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9280 if List.mem ProtocolLimitWarning flags then
9281 doc ^ "\n\n" ^ protocol_limit_warning
9284 if List.mem DangerWillRobinson flags then
9285 doc ^ "\n\n" ^ danger_will_robinson
9288 match deprecation_notice flags with
9290 | Some txt -> doc ^ "\n\n" ^ txt in
9291 let doc = pod2text ~width:60 name doc in
9292 let doc = List.map ( (* RHBZ#501883 *)
9295 | nonempty -> nonempty
9297 let doc = String.concat "\n * " doc in
9300 pr " * %s\n" shortdesc;
9303 pr " * @throws LibGuestFSException\n";
9307 generate_java_prototype ~public:true ~semicolon:false name style;
9310 pr " if (g == 0)\n";
9311 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9314 if fst style <> RErr then pr "return ";
9316 generate_java_call_args ~handle:"g" (snd style);
9320 generate_java_prototype ~privat:true ~native:true name style;
9327 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9328 and generate_java_call_args ~handle args =
9330 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9333 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9334 ?(semicolon=true) name style =
9335 if privat then pr "private ";
9336 if public then pr "public ";
9337 if native then pr "native ";
9340 (match fst style with
9341 | RErr -> pr "void ";
9342 | RInt _ -> pr "int ";
9343 | RInt64 _ -> pr "long ";
9344 | RBool _ -> pr "boolean ";
9345 | RConstString _ | RConstOptString _ | RString _
9346 | RBufferOut _ -> pr "String ";
9347 | RStringList _ -> pr "String[] ";
9348 | RStruct (_, typ) ->
9349 let name = java_name_of_struct typ in
9351 | RStructList (_, typ) ->
9352 let name = java_name_of_struct typ in
9354 | RHashtable _ -> pr "HashMap<String,String> ";
9357 if native then pr "_%s " name else pr "%s " name;
9359 let needs_comma = ref false in
9368 if !needs_comma then pr ", ";
9369 needs_comma := true;
9373 | Device n | Dev_or_Path n
9379 | StringList n | DeviceList n ->
9390 pr " throws LibGuestFSException";
9391 if semicolon then pr ";"
9393 and generate_java_struct jtyp cols () =
9394 generate_header CStyle LGPLv2plus;
9397 package com.redhat.et.libguestfs;
9400 * Libguestfs %s structure.
9412 | name, FBuffer -> pr " public String %s;\n" name
9413 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9414 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9415 | name, FChar -> pr " public char %s;\n" name
9416 | name, FOptPercent ->
9417 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9418 pr " public float %s;\n" name
9423 and generate_java_c () =
9424 generate_header CStyle LGPLv2plus;
9431 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9432 #include \"guestfs.h\"
9434 /* Note that this function returns. The exception is not thrown
9435 * until after the wrapper function returns.
9438 throw_exception (JNIEnv *env, const char *msg)
9441 cl = (*env)->FindClass (env,
9442 \"com/redhat/et/libguestfs/LibGuestFSException\");
9443 (*env)->ThrowNew (env, cl, msg);
9446 JNIEXPORT jlong JNICALL
9447 Java_com_redhat_et_libguestfs_GuestFS__1create
9448 (JNIEnv *env, jobject obj)
9452 g = guestfs_create ();
9454 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9457 guestfs_set_error_handler (g, NULL, NULL);
9458 return (jlong) (long) g;
9461 JNIEXPORT void JNICALL
9462 Java_com_redhat_et_libguestfs_GuestFS__1close
9463 (JNIEnv *env, jobject obj, jlong jg)
9465 guestfs_h *g = (guestfs_h *) (long) jg;
9472 fun (name, style, _, _, _, _, _) ->
9474 (match fst style with
9475 | RErr -> pr "void ";
9476 | RInt _ -> pr "jint ";
9477 | RInt64 _ -> pr "jlong ";
9478 | RBool _ -> pr "jboolean ";
9479 | RConstString _ | RConstOptString _ | RString _
9480 | RBufferOut _ -> pr "jstring ";
9481 | RStruct _ | RHashtable _ ->
9483 | RStringList _ | RStructList _ ->
9487 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9488 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9490 pr " (JNIEnv *env, jobject obj, jlong jg";
9494 | Device n | Dev_or_Path n
9499 pr ", jstring j%s" n
9500 | StringList n | DeviceList n ->
9501 pr ", jobjectArray j%s" n
9503 pr ", jboolean j%s" n
9511 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9512 let error_code, no_ret =
9513 match fst style with
9514 | RErr -> pr " int r;\n"; "-1", ""
9516 | RInt _ -> pr " int r;\n"; "-1", "0"
9517 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9518 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9519 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9521 pr " jstring jr;\n";
9522 pr " char *r;\n"; "NULL", "NULL"
9524 pr " jobjectArray jr;\n";
9527 pr " jstring jstr;\n";
9528 pr " char **r;\n"; "NULL", "NULL"
9529 | RStruct (_, typ) ->
9530 pr " jobject jr;\n";
9532 pr " jfieldID fl;\n";
9533 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9534 | RStructList (_, typ) ->
9535 pr " jobjectArray jr;\n";
9537 pr " jfieldID fl;\n";
9538 pr " jobject jfl;\n";
9539 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9540 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9542 pr " jstring jr;\n";
9544 pr " size_t size;\n";
9549 | Device n | Dev_or_Path n
9554 pr " const char *%s;\n" n
9555 | StringList n | DeviceList n ->
9556 pr " int %s_len;\n" n;
9557 pr " const char **%s;\n" n
9562 pr " int64_t %s;\n" n
9566 (match fst style with
9567 | RStringList _ | RStructList _ -> true
9568 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9570 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9571 List.exists (function
9572 | StringList _ -> true
9573 | DeviceList _ -> true
9574 | _ -> false) (snd style) in
9580 (* Get the parameters. *)
9584 | Device n | Dev_or_Path n
9588 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9590 (* This is completely undocumented, but Java null becomes
9593 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9594 | StringList n | DeviceList n ->
9595 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9596 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9597 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9598 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9600 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9602 pr " %s[%s_len] = NULL;\n" n n;
9606 pr " %s = j%s;\n" n n
9609 (* Make the call. *)
9610 pr " r = guestfs_%s " name;
9611 generate_c_call_args ~handle:"g" style;
9614 (* Release the parameters. *)
9618 | Device n | Dev_or_Path n
9622 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9625 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9626 | StringList n | DeviceList n ->
9627 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9628 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9630 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
9632 pr " free (%s);\n" n
9638 (* Check for errors. *)
9639 pr " if (r == %s) {\n" error_code;
9640 pr " throw_exception (env, guestfs_last_error (g));\n";
9641 pr " return %s;\n" no_ret;
9645 (match fst style with
9647 | RInt _ -> pr " return (jint) r;\n"
9648 | RBool _ -> pr " return (jboolean) r;\n"
9649 | RInt64 _ -> pr " return (jlong) r;\n"
9650 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
9651 | RConstOptString _ ->
9652 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
9654 pr " jr = (*env)->NewStringUTF (env, r);\n";
9658 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
9659 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
9660 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
9661 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
9662 pr " for (i = 0; i < r_len; ++i) {\n";
9663 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
9664 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
9665 pr " free (r[i]);\n";
9669 | RStruct (_, typ) ->
9670 let jtyp = java_name_of_struct typ in
9671 let cols = cols_of_struct typ in
9672 generate_java_struct_return typ jtyp cols
9673 | RStructList (_, typ) ->
9674 let jtyp = java_name_of_struct typ in
9675 let cols = cols_of_struct typ in
9676 generate_java_struct_list_return typ jtyp cols
9679 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
9680 pr " return NULL;\n"
9682 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
9691 and generate_java_struct_return typ jtyp cols =
9692 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9693 pr " jr = (*env)->AllocObject (env, cl);\n";
9697 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9698 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
9701 pr " char s[33];\n";
9702 pr " memcpy (s, r->%s, 32);\n" name;
9704 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9705 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9709 pr " int len = r->%s_len;\n" name;
9710 pr " char s[len+1];\n";
9711 pr " memcpy (s, r->%s, len);\n" name;
9712 pr " s[len] = 0;\n";
9713 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9714 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
9716 | name, (FBytes|FUInt64|FInt64) ->
9717 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9718 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9719 | name, (FUInt32|FInt32) ->
9720 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9721 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9722 | name, FOptPercent ->
9723 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9724 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
9726 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9727 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
9732 and generate_java_struct_list_return typ jtyp cols =
9733 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
9734 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
9735 pr " for (i = 0; i < r->len; ++i) {\n";
9736 pr " jfl = (*env)->AllocObject (env, cl);\n";
9740 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9741 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
9744 pr " char s[33];\n";
9745 pr " memcpy (s, r->val[i].%s, 32);\n" name;
9747 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9748 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9752 pr " int len = r->val[i].%s_len;\n" name;
9753 pr " char s[len+1];\n";
9754 pr " memcpy (s, r->val[i].%s, len);\n" name;
9755 pr " s[len] = 0;\n";
9756 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
9757 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
9759 | name, (FBytes|FUInt64|FInt64) ->
9760 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
9761 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9762 | name, (FUInt32|FInt32) ->
9763 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
9764 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9765 | name, FOptPercent ->
9766 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
9767 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
9769 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
9770 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
9772 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
9774 pr " guestfs_free_%s_list (r);\n" typ;
9777 and generate_java_makefile_inc () =
9778 generate_header HashStyle GPLv2plus;
9780 pr "java_built_sources = \\\n";
9783 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
9785 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
9787 and generate_haskell_hs () =
9788 generate_header HaskellStyle LGPLv2plus;
9790 (* XXX We only know how to generate partial FFI for Haskell
9791 * at the moment. Please help out!
9793 let can_generate style =
9797 | RInt64 _, _ -> true
9800 | RConstOptString _, _
9806 | RBufferOut _, _ -> false in
9809 {-# INCLUDE <guestfs.h> #-}
9810 {-# LANGUAGE ForeignFunctionInterface #-}
9815 (* List out the names of the actions we want to export. *)
9817 fun (name, style, _, _, _, _, _) ->
9818 if can_generate style then pr ",\n %s" name
9824 -- Unfortunately some symbols duplicate ones already present
9825 -- in Prelude. We don't know which, so we hard-code a list
9827 import Prelude hiding (truncate)
9831 import Foreign.C.Types
9833 import Control.Exception
9834 import Data.Typeable
9836 data GuestfsS = GuestfsS -- represents the opaque C struct
9837 type GuestfsP = Ptr GuestfsS -- guestfs_h *
9838 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
9840 -- XXX define properly later XXX
9844 data IntBool = IntBool
9846 data StatVFS = StatVFS
9847 data Hashtable = Hashtable
9849 foreign import ccall unsafe \"guestfs_create\" c_create
9851 foreign import ccall unsafe \"&guestfs_close\" c_close
9852 :: FunPtr (GuestfsP -> IO ())
9853 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
9854 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
9856 create :: IO GuestfsH
9859 c_set_error_handler p nullPtr nullPtr
9860 h <- newForeignPtr c_close p
9863 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
9864 :: GuestfsP -> IO CString
9866 -- last_error :: GuestfsH -> IO (Maybe String)
9867 -- last_error h = do
9868 -- str <- withForeignPtr h (\\p -> c_last_error p)
9869 -- maybePeek peekCString str
9871 last_error :: GuestfsH -> IO (String)
9873 str <- withForeignPtr h (\\p -> c_last_error p)
9875 then return \"no error\"
9876 else peekCString str
9880 (* Generate wrappers for each foreign function. *)
9882 fun (name, style, _, _, _, _, _) ->
9883 if can_generate style then (
9884 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
9886 generate_haskell_prototype ~handle:"GuestfsP" style;
9890 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
9892 pr "%s %s = do\n" name
9893 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
9895 (* Convert pointer arguments using with* functions. *)
9900 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
9901 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
9902 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
9903 | Bool _ | Int _ | Int64 _ -> ()
9905 (* Convert integer arguments. *)
9909 | Bool n -> sprintf "(fromBool %s)" n
9910 | Int n -> sprintf "(fromIntegral %s)" n
9911 | Int64 n -> sprintf "(fromIntegral %s)" n
9912 | FileIn n | FileOut n
9913 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
9915 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
9916 (String.concat " " ("p" :: args));
9917 (match fst style with
9918 | RErr | RInt _ | RInt64 _ | RBool _ ->
9919 pr " if (r == -1)\n";
9921 pr " err <- last_error h\n";
9923 | RConstString _ | RConstOptString _ | RString _
9924 | RStringList _ | RStruct _
9925 | RStructList _ | RHashtable _ | RBufferOut _ ->
9926 pr " if (r == nullPtr)\n";
9928 pr " err <- last_error h\n";
9931 (match fst style with
9933 pr " else return ()\n"
9935 pr " else return (fromIntegral r)\n"
9937 pr " else return (fromIntegral r)\n"
9939 pr " else return (toBool r)\n"
9948 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
9954 and generate_haskell_prototype ~handle ?(hs = false) style =
9956 let string = if hs then "String" else "CString" in
9957 let int = if hs then "Int" else "CInt" in
9958 let bool = if hs then "Bool" else "CInt" in
9959 let int64 = if hs then "Integer" else "Int64" in
9963 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
9964 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
9965 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
9966 | Bool _ -> pr "%s" bool
9967 | Int _ -> pr "%s" int
9968 | Int64 _ -> pr "%s" int
9969 | FileIn _ -> pr "%s" string
9970 | FileOut _ -> pr "%s" string
9975 (match fst style with
9976 | RErr -> if not hs then pr "CInt"
9977 | RInt _ -> pr "%s" int
9978 | RInt64 _ -> pr "%s" int64
9979 | RBool _ -> pr "%s" bool
9980 | RConstString _ -> pr "%s" string
9981 | RConstOptString _ -> pr "Maybe %s" string
9982 | RString _ -> pr "%s" string
9983 | RStringList _ -> pr "[%s]" string
9984 | RStruct (_, typ) ->
9985 let name = java_name_of_struct typ in
9987 | RStructList (_, typ) ->
9988 let name = java_name_of_struct typ in
9990 | RHashtable _ -> pr "Hashtable"
9991 | RBufferOut _ -> pr "%s" string
9995 and generate_csharp () =
9996 generate_header CPlusPlusStyle LGPLv2plus;
9998 (* XXX Make this configurable by the C# assembly users. *)
9999 let library = "libguestfs.so.0" in
10002 // These C# bindings are highly experimental at present.
10004 // Firstly they only work on Linux (ie. Mono). In order to get them
10005 // to work on Windows (ie. .Net) you would need to port the library
10006 // itself to Windows first.
10008 // The second issue is that some calls are known to be incorrect and
10009 // can cause Mono to segfault. Particularly: calls which pass or
10010 // return string[], or return any structure value. This is because
10011 // we haven't worked out the correct way to do this from C#.
10013 // The third issue is that when compiling you get a lot of warnings.
10014 // We are not sure whether the warnings are important or not.
10016 // Fourthly we do not routinely build or test these bindings as part
10017 // of the make && make check cycle, which means that regressions might
10020 // Suggestions and patches are welcome.
10024 // gmcs Libguestfs.cs
10025 // mono Libguestfs.exe
10027 // (You'll probably want to add a Test class / static main function
10028 // otherwise this won't do anything useful).
10032 using System.Runtime.InteropServices;
10033 using System.Runtime.Serialization;
10034 using System.Collections;
10038 class Error : System.ApplicationException
10040 public Error (string message) : base (message) {}
10041 protected Error (SerializationInfo info, StreamingContext context) {}
10048 [DllImport (\"%s\")]
10049 static extern IntPtr guestfs_create ();
10053 _handle = guestfs_create ();
10054 if (_handle == IntPtr.Zero)
10055 throw new Error (\"could not create guestfs handle\");
10058 [DllImport (\"%s\")]
10059 static extern void guestfs_close (IntPtr h);
10063 guestfs_close (_handle);
10066 [DllImport (\"%s\")]
10067 static extern string guestfs_last_error (IntPtr h);
10069 " library library library;
10071 (* Generate C# structure bindings. We prefix struct names with
10072 * underscore because C# cannot have conflicting struct names and
10073 * method names (eg. "class stat" and "stat").
10077 pr " [StructLayout (LayoutKind.Sequential)]\n";
10078 pr " public class _%s {\n" typ;
10081 | name, FChar -> pr " char %s;\n" name
10082 | name, FString -> pr " string %s;\n" name
10084 pr " uint %s_len;\n" name;
10085 pr " string %s;\n" name
10087 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10088 pr " string %s;\n" name
10089 | name, FUInt32 -> pr " uint %s;\n" name
10090 | name, FInt32 -> pr " int %s;\n" name
10091 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10092 | name, FInt64 -> pr " long %s;\n" name
10093 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10099 (* Generate C# function bindings. *)
10101 fun (name, style, _, _, _, shortdesc, _) ->
10102 let rec csharp_return_type () =
10103 match fst style with
10105 | RBool n -> "bool"
10107 | RInt64 n -> "long"
10109 | RConstOptString n
10111 | RBufferOut n -> "string"
10112 | RStruct (_,n) -> "_" ^ n
10113 | RHashtable n -> "Hashtable"
10114 | RStringList n -> "string[]"
10115 | RStructList (_,n) -> sprintf "_%s[]" n
10117 and c_return_type () =
10118 match fst style with
10122 | RInt64 _ -> "long"
10124 | RConstOptString _
10126 | RBufferOut _ -> "string"
10127 | RStruct (_,n) -> "_" ^ n
10129 | RStringList _ -> "string[]"
10130 | RStructList (_,n) -> sprintf "_%s[]" n
10132 and c_error_comparison () =
10133 match fst style with
10137 | RInt64 _ -> "== -1"
10139 | RConstOptString _
10145 | RStructList (_,_) -> "== null"
10147 and generate_extern_prototype () =
10148 pr " static extern %s guestfs_%s (IntPtr h"
10149 (c_return_type ()) name;
10152 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10153 | FileIn n | FileOut n ->
10154 pr ", [In] string %s" n
10155 | StringList n | DeviceList n ->
10156 pr ", [In] string[] %s" n
10166 and generate_public_prototype () =
10167 pr " public %s %s (" (csharp_return_type ()) name;
10168 let comma = ref false in
10170 if !comma then pr ", ";
10175 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10176 | FileIn n | FileOut n ->
10177 next (); pr "string %s" n
10178 | StringList n | DeviceList n ->
10179 next (); pr "string[] %s" n
10181 next (); pr "bool %s" n
10183 next (); pr "int %s" n
10185 next (); pr "long %s" n
10189 and generate_call () =
10190 pr "guestfs_%s (_handle" name;
10191 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10195 pr " [DllImport (\"%s\")]\n" library;
10196 generate_extern_prototype ();
10198 pr " /// <summary>\n";
10199 pr " /// %s\n" shortdesc;
10200 pr " /// </summary>\n";
10201 generate_public_prototype ();
10203 pr " %s r;\n" (c_return_type ());
10206 pr " if (r %s)\n" (c_error_comparison ());
10207 pr " throw new Error (\"%s: \" + guestfs_last_error (_handle));\n"
10209 (match fst style with
10212 pr " return r != 0 ? true : false;\n"
10214 pr " Hashtable rr = new Hashtable ();\n";
10215 pr " for (int i = 0; i < r.Length; i += 2)\n";
10216 pr " rr.Add (r[i], r[i+1]);\n";
10218 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10219 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10225 ) all_functions_sorted;
10231 and generate_bindtests () =
10232 generate_header CStyle LGPLv2plus;
10236 #include <stdlib.h>
10237 #include <inttypes.h>
10238 #include <string.h>
10240 #include \"guestfs.h\"
10241 #include \"guestfs-internal.h\"
10242 #include \"guestfs-internal-actions.h\"
10243 #include \"guestfs_protocol.h\"
10245 #define error guestfs_error
10246 #define safe_calloc guestfs_safe_calloc
10247 #define safe_malloc guestfs_safe_malloc
10250 print_strings (char *const *argv)
10255 for (argc = 0; argv[argc] != NULL; ++argc) {
10256 if (argc > 0) printf (\", \");
10257 printf (\"\\\"%%s\\\"\", argv[argc]);
10262 /* The test0 function prints its parameters to stdout. */
10266 match test_functions with
10267 | [] -> assert false
10268 | test0 :: tests -> test0, tests in
10271 let (name, style, _, _, _, _, _) = test0 in
10272 generate_prototype ~extern:false ~semicolon:false ~newline:true
10273 ~handle:"g" ~prefix:"guestfs__" name style;
10278 | Device n | Dev_or_Path n
10281 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10282 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10283 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10284 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10285 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10286 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10288 pr " /* Java changes stdout line buffering so we need this: */\n";
10289 pr " fflush (stdout);\n";
10295 fun (name, style, _, _, _, _, _) ->
10296 if String.sub name (String.length name - 3) 3 <> "err" then (
10297 pr "/* Test normal return. */\n";
10298 generate_prototype ~extern:false ~semicolon:false ~newline:true
10299 ~handle:"g" ~prefix:"guestfs__" name style;
10301 (match fst style with
10306 pr " sscanf (val, \"%%d\", &r);\n";
10309 pr " int64_t r;\n";
10310 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10313 pr " return STREQ (val, \"true\");\n"
10315 | RConstOptString _ ->
10316 (* Can't return the input string here. Return a static
10317 * string so we ensure we get a segfault if the caller
10318 * tries to free it.
10320 pr " return \"static string\";\n"
10322 pr " return strdup (val);\n"
10324 pr " char **strs;\n";
10326 pr " sscanf (val, \"%%d\", &n);\n";
10327 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10328 pr " for (i = 0; i < n; ++i) {\n";
10329 pr " strs[i] = safe_malloc (g, 16);\n";
10330 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10332 pr " strs[n] = NULL;\n";
10333 pr " return strs;\n"
10334 | RStruct (_, typ) ->
10335 pr " struct guestfs_%s *r;\n" typ;
10336 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10338 | RStructList (_, typ) ->
10339 pr " struct guestfs_%s_list *r;\n" typ;
10340 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10341 pr " sscanf (val, \"%%d\", &r->len);\n";
10342 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10345 pr " char **strs;\n";
10347 pr " sscanf (val, \"%%d\", &n);\n";
10348 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10349 pr " for (i = 0; i < n; ++i) {\n";
10350 pr " strs[i*2] = safe_malloc (g, 16);\n";
10351 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10352 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10353 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10355 pr " strs[n*2] = NULL;\n";
10356 pr " return strs;\n"
10358 pr " return strdup (val);\n"
10363 pr "/* Test error return. */\n";
10364 generate_prototype ~extern:false ~semicolon:false ~newline:true
10365 ~handle:"g" ~prefix:"guestfs__" name style;
10367 pr " error (g, \"error\");\n";
10368 (match fst style with
10369 | RErr | RInt _ | RInt64 _ | RBool _ ->
10371 | RConstString _ | RConstOptString _
10372 | RString _ | RStringList _ | RStruct _
10376 pr " return NULL;\n"
10383 and generate_ocaml_bindtests () =
10384 generate_header OCamlStyle GPLv2plus;
10388 let g = Guestfs.create () in
10392 String.concat " " (
10395 | CallString s -> "\"" ^ s ^ "\""
10396 | CallOptString None -> "None"
10397 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10398 | CallStringList xs ->
10399 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10400 | CallInt i when i >= 0 -> string_of_int i
10401 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10402 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10403 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10404 | CallBool b -> string_of_bool b
10409 generate_lang_bindtests (
10410 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10413 pr "print_endline \"EOF\"\n"
10415 and generate_perl_bindtests () =
10416 pr "#!/usr/bin/perl -w\n";
10417 generate_header HashStyle GPLv2plus;
10424 my $g = Sys::Guestfs->new ();
10428 String.concat ", " (
10431 | CallString s -> "\"" ^ s ^ "\""
10432 | CallOptString None -> "undef"
10433 | CallOptString (Some s) -> sprintf "\"%s\"" s
10434 | CallStringList xs ->
10435 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10436 | CallInt i -> string_of_int i
10437 | CallInt64 i -> Int64.to_string i
10438 | CallBool b -> if b then "1" else "0"
10443 generate_lang_bindtests (
10444 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10447 pr "print \"EOF\\n\"\n"
10449 and generate_python_bindtests () =
10450 generate_header HashStyle GPLv2plus;
10455 g = guestfs.GuestFS ()
10459 String.concat ", " (
10462 | CallString s -> "\"" ^ s ^ "\""
10463 | CallOptString None -> "None"
10464 | CallOptString (Some s) -> sprintf "\"%s\"" s
10465 | CallStringList xs ->
10466 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10467 | CallInt i -> string_of_int i
10468 | CallInt64 i -> Int64.to_string i
10469 | CallBool b -> if b then "1" else "0"
10474 generate_lang_bindtests (
10475 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10478 pr "print \"EOF\"\n"
10480 and generate_ruby_bindtests () =
10481 generate_header HashStyle GPLv2plus;
10486 g = Guestfs::create()
10490 String.concat ", " (
10493 | CallString s -> "\"" ^ s ^ "\""
10494 | CallOptString None -> "nil"
10495 | CallOptString (Some s) -> sprintf "\"%s\"" s
10496 | CallStringList xs ->
10497 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10498 | CallInt i -> string_of_int i
10499 | CallInt64 i -> Int64.to_string i
10500 | CallBool b -> string_of_bool b
10505 generate_lang_bindtests (
10506 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10509 pr "print \"EOF\\n\"\n"
10511 and generate_java_bindtests () =
10512 generate_header CStyle GPLv2plus;
10515 import com.redhat.et.libguestfs.*;
10517 public class Bindtests {
10518 public static void main (String[] argv)
10521 GuestFS g = new GuestFS ();
10525 String.concat ", " (
10528 | CallString s -> "\"" ^ s ^ "\""
10529 | CallOptString None -> "null"
10530 | CallOptString (Some s) -> sprintf "\"%s\"" s
10531 | CallStringList xs ->
10533 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10534 | CallInt i -> string_of_int i
10535 | CallInt64 i -> Int64.to_string i
10536 | CallBool b -> string_of_bool b
10541 generate_lang_bindtests (
10542 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10546 System.out.println (\"EOF\");
10548 catch (Exception exn) {
10549 System.err.println (exn);
10556 and generate_haskell_bindtests () =
10557 generate_header HaskellStyle GPLv2plus;
10560 module Bindtests where
10561 import qualified Guestfs
10564 g <- Guestfs.create
10568 String.concat " " (
10571 | CallString s -> "\"" ^ s ^ "\""
10572 | CallOptString None -> "Nothing"
10573 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10574 | CallStringList xs ->
10575 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10576 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10577 | CallInt i -> string_of_int i
10578 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10579 | CallInt64 i -> Int64.to_string i
10580 | CallBool true -> "True"
10581 | CallBool false -> "False"
10586 generate_lang_bindtests (
10587 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10590 pr " putStrLn \"EOF\"\n"
10592 (* Language-independent bindings tests - we do it this way to
10593 * ensure there is parity in testing bindings across all languages.
10595 and generate_lang_bindtests call =
10596 call "test0" [CallString "abc"; CallOptString (Some "def");
10597 CallStringList []; CallBool false;
10598 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10599 call "test0" [CallString "abc"; CallOptString None;
10600 CallStringList []; CallBool false;
10601 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10602 call "test0" [CallString ""; CallOptString (Some "def");
10603 CallStringList []; CallBool false;
10604 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10605 call "test0" [CallString ""; CallOptString (Some "");
10606 CallStringList []; CallBool false;
10607 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10608 call "test0" [CallString "abc"; CallOptString (Some "def");
10609 CallStringList ["1"]; CallBool false;
10610 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10611 call "test0" [CallString "abc"; CallOptString (Some "def");
10612 CallStringList ["1"; "2"]; CallBool false;
10613 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10614 call "test0" [CallString "abc"; CallOptString (Some "def");
10615 CallStringList ["1"]; CallBool true;
10616 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10617 call "test0" [CallString "abc"; CallOptString (Some "def");
10618 CallStringList ["1"]; CallBool false;
10619 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
10620 call "test0" [CallString "abc"; CallOptString (Some "def");
10621 CallStringList ["1"]; CallBool false;
10622 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
10623 call "test0" [CallString "abc"; CallOptString (Some "def");
10624 CallStringList ["1"]; CallBool false;
10625 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
10626 call "test0" [CallString "abc"; CallOptString (Some "def");
10627 CallStringList ["1"]; CallBool false;
10628 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
10629 call "test0" [CallString "abc"; CallOptString (Some "def");
10630 CallStringList ["1"]; CallBool false;
10631 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
10632 call "test0" [CallString "abc"; CallOptString (Some "def");
10633 CallStringList ["1"]; CallBool false;
10634 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
10636 (* XXX Add here tests of the return and error functions. *)
10638 (* Code to generator bindings for virt-inspector. Currently only
10639 * implemented for OCaml code (for virt-p2v 2.0).
10641 let rng_input = "inspector/virt-inspector.rng"
10643 (* Read the input file and parse it into internal structures. This is
10644 * by no means a complete RELAX NG parser, but is just enough to be
10645 * able to parse the specific input file.
10648 | Element of string * rng list (* <element name=name/> *)
10649 | Attribute of string * rng list (* <attribute name=name/> *)
10650 | Interleave of rng list (* <interleave/> *)
10651 | ZeroOrMore of rng (* <zeroOrMore/> *)
10652 | OneOrMore of rng (* <oneOrMore/> *)
10653 | Optional of rng (* <optional/> *)
10654 | Choice of string list (* <choice><value/>*</choice> *)
10655 | Value of string (* <value>str</value> *)
10656 | Text (* <text/> *)
10658 let rec string_of_rng = function
10659 | Element (name, xs) ->
10660 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10661 | Attribute (name, xs) ->
10662 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
10663 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
10664 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
10665 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
10666 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
10667 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
10668 | Value value -> "Value \"" ^ value ^ "\""
10671 and string_of_rng_list xs =
10672 String.concat ", " (List.map string_of_rng xs)
10674 let rec parse_rng ?defines context = function
10676 | Xml.Element ("element", ["name", name], children) :: rest ->
10677 Element (name, parse_rng ?defines context children)
10678 :: parse_rng ?defines context rest
10679 | Xml.Element ("attribute", ["name", name], children) :: rest ->
10680 Attribute (name, parse_rng ?defines context children)
10681 :: parse_rng ?defines context rest
10682 | Xml.Element ("interleave", [], children) :: rest ->
10683 Interleave (parse_rng ?defines context children)
10684 :: parse_rng ?defines context rest
10685 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
10686 let rng = parse_rng ?defines context [child] in
10688 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
10690 failwithf "%s: <zeroOrMore> contains more than one child element"
10693 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
10694 let rng = parse_rng ?defines context [child] in
10696 | [child] -> OneOrMore child :: parse_rng ?defines context rest
10698 failwithf "%s: <oneOrMore> contains more than one child element"
10701 | Xml.Element ("optional", [], [child]) :: rest ->
10702 let rng = parse_rng ?defines context [child] in
10704 | [child] -> Optional child :: parse_rng ?defines context rest
10706 failwithf "%s: <optional> contains more than one child element"
10709 | Xml.Element ("choice", [], children) :: rest ->
10710 let values = List.map (
10711 function Xml.Element ("value", [], [Xml.PCData value]) -> value
10713 failwithf "%s: can't handle anything except <value> in <choice>"
10717 :: parse_rng ?defines context rest
10718 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
10719 Value value :: parse_rng ?defines context rest
10720 | Xml.Element ("text", [], []) :: rest ->
10721 Text :: parse_rng ?defines context rest
10722 | Xml.Element ("ref", ["name", name], []) :: rest ->
10723 (* Look up the reference. Because of limitations in this parser,
10724 * we can't handle arbitrarily nested <ref> yet. You can only
10725 * use <ref> from inside <start>.
10727 (match defines with
10729 failwithf "%s: contains <ref>, but no refs are defined yet" context
10731 let rng = StringMap.find name map in
10732 rng @ parse_rng ?defines context rest
10735 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
10738 let xml = Xml.parse_file rng_input in
10740 | Xml.Element ("grammar", _,
10741 Xml.Element ("start", _, gram) :: defines) ->
10742 (* The <define/> elements are referenced in the <start> section,
10743 * so build a map of those first.
10745 let defines = List.fold_left (
10747 function Xml.Element ("define", ["name", name], defn) ->
10748 StringMap.add name defn map
10750 failwithf "%s: expected <define name=name/>" rng_input
10751 ) StringMap.empty defines in
10752 let defines = StringMap.mapi parse_rng defines in
10754 (* Parse the <start> clause, passing the defines. *)
10755 parse_rng ~defines "<start>" gram
10757 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
10760 let name_of_field = function
10761 | Element (name, _) | Attribute (name, _)
10762 | ZeroOrMore (Element (name, _))
10763 | OneOrMore (Element (name, _))
10764 | Optional (Element (name, _)) -> name
10765 | Optional (Attribute (name, _)) -> name
10766 | Text -> (* an unnamed field in an element *)
10769 failwithf "name_of_field failed at: %s" (string_of_rng rng)
10771 (* At the moment this function only generates OCaml types. However we
10772 * should parameterize it later so it can generate types/structs in a
10773 * variety of languages.
10775 let generate_types xs =
10776 (* A simple type is one that can be printed out directly, eg.
10777 * "string option". A complex type is one which has a name and has
10778 * to be defined via another toplevel definition, eg. a struct.
10780 * generate_type generates code for either simple or complex types.
10781 * In the simple case, it returns the string ("string option"). In
10782 * the complex case, it returns the name ("mountpoint"). In the
10783 * complex case it has to print out the definition before returning,
10784 * so it should only be called when we are at the beginning of a
10785 * new line (BOL context).
10787 let rec generate_type = function
10788 | Text -> (* string *)
10790 | Choice values -> (* [`val1|`val2|...] *)
10791 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
10792 | ZeroOrMore rng -> (* <rng> list *)
10793 let t, is_simple = generate_type rng in
10794 t ^ " list (* 0 or more *)", is_simple
10795 | OneOrMore rng -> (* <rng> list *)
10796 let t, is_simple = generate_type rng in
10797 t ^ " list (* 1 or more *)", is_simple
10798 (* virt-inspector hack: bool *)
10799 | Optional (Attribute (name, [Value "1"])) ->
10801 | Optional rng -> (* <rng> list *)
10802 let t, is_simple = generate_type rng in
10803 t ^ " option", is_simple
10804 (* type name = { fields ... } *)
10805 | Element (name, fields) when is_attrs_interleave fields ->
10806 generate_type_struct name (get_attrs_interleave fields)
10807 | Element (name, [field]) (* type name = field *)
10808 | Attribute (name, [field]) ->
10809 let t, is_simple = generate_type field in
10810 if is_simple then (t, true)
10812 pr "type %s = %s\n" name t;
10815 | Element (name, fields) -> (* type name = { fields ... } *)
10816 generate_type_struct name fields
10818 failwithf "generate_type failed at: %s" (string_of_rng rng)
10820 and is_attrs_interleave = function
10821 | [Interleave _] -> true
10822 | Attribute _ :: fields -> is_attrs_interleave fields
10823 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
10826 and get_attrs_interleave = function
10827 | [Interleave fields] -> fields
10828 | ((Attribute _) as field) :: fields
10829 | ((Optional (Attribute _)) as field) :: fields ->
10830 field :: get_attrs_interleave fields
10831 | _ -> assert false
10833 and generate_types xs =
10834 List.iter (fun x -> ignore (generate_type x)) xs
10836 and generate_type_struct name fields =
10837 (* Calculate the types of the fields first. We have to do this
10838 * before printing anything so we are still in BOL context.
10840 let types = List.map fst (List.map generate_type fields) in
10842 (* Special case of a struct containing just a string and another
10843 * field. Turn it into an assoc list.
10846 | ["string"; other] ->
10847 let fname1, fname2 =
10849 | [f1; f2] -> name_of_field f1, name_of_field f2
10850 | _ -> assert false in
10851 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
10855 pr "type %s = {\n" name;
10857 fun (field, ftype) ->
10858 let fname = name_of_field field in
10859 pr " %s_%s : %s;\n" name fname ftype
10860 ) (List.combine fields types);
10862 (* Return the name of this type, and
10863 * false because it's not a simple type.
10870 let generate_parsers xs =
10871 (* As for generate_type above, generate_parser makes a parser for
10872 * some type, and returns the name of the parser it has generated.
10873 * Because it (may) need to print something, it should always be
10874 * called in BOL context.
10876 let rec generate_parser = function
10877 | Text -> (* string *)
10878 "string_child_or_empty"
10879 | Choice values -> (* [`val1|`val2|...] *)
10880 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
10882 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
10883 | ZeroOrMore rng -> (* <rng> list *)
10884 let pa = generate_parser rng in
10885 sprintf "(fun x -> List.map %s (Xml.children x))" pa
10886 | OneOrMore rng -> (* <rng> list *)
10887 let pa = generate_parser rng in
10888 sprintf "(fun x -> List.map %s (Xml.children x))" pa
10889 (* virt-inspector hack: bool *)
10890 | Optional (Attribute (name, [Value "1"])) ->
10891 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
10892 | Optional rng -> (* <rng> list *)
10893 let pa = generate_parser rng in
10894 sprintf "(function None -> None | Some x -> Some (%s x))" pa
10895 (* type name = { fields ... } *)
10896 | Element (name, fields) when is_attrs_interleave fields ->
10897 generate_parser_struct name (get_attrs_interleave fields)
10898 | Element (name, [field]) -> (* type name = field *)
10899 let pa = generate_parser field in
10900 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
10901 pr "let %s =\n" parser_name;
10903 pr "let parse_%s = %s\n" name parser_name;
10905 | Attribute (name, [field]) ->
10906 let pa = generate_parser field in
10907 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
10908 pr "let %s =\n" parser_name;
10910 pr "let parse_%s = %s\n" name parser_name;
10912 | Element (name, fields) -> (* type name = { fields ... } *)
10913 generate_parser_struct name ([], fields)
10915 failwithf "generate_parser failed at: %s" (string_of_rng rng)
10917 and is_attrs_interleave = function
10918 | [Interleave _] -> true
10919 | Attribute _ :: fields -> is_attrs_interleave fields
10920 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
10923 and get_attrs_interleave = function
10924 | [Interleave fields] -> [], fields
10925 | ((Attribute _) as field) :: fields
10926 | ((Optional (Attribute _)) as field) :: fields ->
10927 let attrs, interleaves = get_attrs_interleave fields in
10928 (field :: attrs), interleaves
10929 | _ -> assert false
10931 and generate_parsers xs =
10932 List.iter (fun x -> ignore (generate_parser x)) xs
10934 and generate_parser_struct name (attrs, interleaves) =
10935 (* Generate parsers for the fields first. We have to do this
10936 * before printing anything so we are still in BOL context.
10938 let fields = attrs @ interleaves in
10939 let pas = List.map generate_parser fields in
10941 (* Generate an intermediate tuple from all the fields first.
10942 * If the type is just a string + another field, then we will
10943 * return this directly, otherwise it is turned into a record.
10945 * RELAX NG note: This code treats <interleave> and plain lists of
10946 * fields the same. In other words, it doesn't bother enforcing
10947 * any ordering of fields in the XML.
10949 pr "let parse_%s x =\n" name;
10950 pr " let t = (\n ";
10951 let comma = ref false in
10954 if !comma then pr ",\n ";
10957 | Optional (Attribute (fname, [field])), pa ->
10959 | Optional (Element (fname, [field])), pa ->
10960 pr "%s (optional_child %S x)" pa fname
10961 | Attribute (fname, [Text]), _ ->
10962 pr "attribute %S x" fname
10963 | (ZeroOrMore _ | OneOrMore _), pa ->
10968 let fname = name_of_field field in
10969 pr "%s (child %S x)" pa fname
10970 ) (List.combine fields pas);
10974 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
10978 pr " (Obj.magic t : %s)\n" name
10982 | (Optional (Attribute (fname, [field])), pa) ->
10983 pr " %s_%s =\n" name fname;
10985 | (Optional (Element (fname, [field])), pa) ->
10986 pr " %s_%s =\n" name fname;
10987 pr " (let x = optional_child %S x in\n" fname;
10990 let fname = name_of_field field in
10991 pr " %s_%s =\n" name fname;
10992 pr " (let x = child %S x in\n" fname;
10994 ) (List.combine fields pas);
10998 sprintf "parse_%s" name
11001 generate_parsers xs
11003 (* Generate ocaml/guestfs_inspector.mli. *)
11004 let generate_ocaml_inspector_mli () =
11005 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11008 (** This is an OCaml language binding to the external [virt-inspector]
11011 For more information, please read the man page [virt-inspector(1)].
11016 generate_types grammar;
11017 pr "(** The nested information returned from the {!inspect} function. *)\n";
11021 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11022 (** To inspect a libvirt domain called [name], pass a singleton
11023 list: [inspect [name]]. When using libvirt only, you may
11024 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11026 To inspect a disk image or images, pass a list of the filenames
11027 of the disk images: [inspect filenames]
11029 This function inspects the given guest or disk images and
11030 returns a list of operating system(s) found and a large amount
11031 of information about them. In the vast majority of cases,
11032 a virtual machine only contains a single operating system.
11034 If the optional [~xml] parameter is given, then this function
11035 skips running the external virt-inspector program and just
11036 parses the given XML directly (which is expected to be XML
11037 produced from a previous run of virt-inspector). The list of
11038 names and connect URI are ignored in this case.
11040 This function can throw a wide variety of exceptions, for example
11041 if the external virt-inspector program cannot be found, or if
11042 it doesn't generate valid XML.
11046 (* Generate ocaml/guestfs_inspector.ml. *)
11047 let generate_ocaml_inspector_ml () =
11048 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11053 generate_types grammar;
11057 (* Misc functions which are used by the parser code below. *)
11058 let first_child = function
11059 | Xml.Element (_, _, c::_) -> c
11060 | Xml.Element (name, _, []) ->
11061 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11062 | Xml.PCData str ->
11063 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11065 let string_child_or_empty = function
11066 | Xml.Element (_, _, [Xml.PCData s]) -> s
11067 | Xml.Element (_, _, []) -> \"\"
11068 | Xml.Element (x, _, _) ->
11069 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11071 | Xml.PCData str ->
11072 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11074 let optional_child name xml =
11075 let children = Xml.children xml in
11077 Some (List.find (function
11078 | Xml.Element (n, _, _) when n = name -> true
11079 | _ -> false) children)
11083 let child name xml =
11084 match optional_child name xml with
11087 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11089 let attribute name xml =
11090 try Xml.attrib xml name
11091 with Xml.No_attribute _ ->
11092 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11096 generate_parsers grammar;
11100 (* Run external virt-inspector, then use parser to parse the XML. *)
11101 let inspect ?connect ?xml names =
11105 if names = [] then invalid_arg \"inspect: no names given\";
11106 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11107 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11109 let cmd = List.map Filename.quote cmd in
11110 let cmd = String.concat \" \" cmd in
11111 let chan = open_process_in cmd in
11112 let xml = Xml.parse_in chan in
11113 (match close_process_in chan with
11115 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11116 | WSIGNALED i | WSTOPPED i ->
11117 failwith (\"external virt-inspector command died or stopped on sig \" ^
11122 Xml.parse_string doc in
11123 parse_operatingsystems xml
11126 (* This is used to generate the src/MAX_PROC_NR file which
11127 * contains the maximum procedure number, a surrogate for the
11128 * ABI version number. See src/Makefile.am for the details.
11130 and generate_max_proc_nr () =
11131 let proc_nrs = List.map (
11132 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11133 ) daemon_functions in
11135 let max_proc_nr = List.fold_left max 0 proc_nrs in
11137 pr "%d\n" max_proc_nr
11139 let output_to filename k =
11140 let filename_new = filename ^ ".new" in
11141 chan := open_out filename_new;
11144 chan := Pervasives.stdout;
11146 (* Is the new file different from the current file? *)
11147 if Sys.file_exists filename && files_equal filename filename_new then
11148 unlink filename_new (* same, so skip it *)
11150 (* different, overwrite old one *)
11151 (try chmod filename 0o644 with Unix_error _ -> ());
11152 rename filename_new filename;
11153 chmod filename 0o444;
11154 printf "written %s\n%!" filename;
11157 let perror msg = function
11158 | Unix_error (err, _, _) ->
11159 eprintf "%s: %s\n" msg (error_message err)
11161 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11163 (* Main program. *)
11166 try openfile "HACKING" [O_RDWR] 0
11168 | Unix_error (ENOENT, _, _) ->
11170 You are probably running this from the wrong directory.
11171 Run it from the top source directory using the command
11176 perror "open: HACKING" exn;
11179 (* Acquire a lock so parallel builds won't try to run the generator
11180 * twice at the same time. Subsequent builds will wait for the first
11181 * one to finish. Note the lock is released implicitly when the
11184 (try lockf lock_fd F_LOCK 1
11186 perror "lock: HACKING" exn;
11189 check_functions ();
11191 output_to "src/guestfs_protocol.x" generate_xdr;
11192 output_to "src/guestfs-structs.h" generate_structs_h;
11193 output_to "src/guestfs-actions.h" generate_actions_h;
11194 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11195 output_to "src/guestfs-actions.c" generate_client_actions;
11196 output_to "src/guestfs-bindtests.c" generate_bindtests;
11197 output_to "src/guestfs-structs.pod" generate_structs_pod;
11198 output_to "src/guestfs-actions.pod" generate_actions_pod;
11199 output_to "src/guestfs-availability.pod" generate_availability_pod;
11200 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11201 output_to "src/libguestfs.syms" generate_linker_script;
11202 output_to "daemon/actions.h" generate_daemon_actions_h;
11203 output_to "daemon/stubs.c" generate_daemon_actions;
11204 output_to "daemon/names.c" generate_daemon_names;
11205 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11206 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11207 output_to "capitests/tests.c" generate_tests;
11208 output_to "fish/cmds.c" generate_fish_cmds;
11209 output_to "fish/completion.c" generate_fish_completion;
11210 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11211 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11212 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11213 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11214 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11215 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11216 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11217 output_to "perl/Guestfs.xs" generate_perl_xs;
11218 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11219 output_to "perl/bindtests.pl" generate_perl_bindtests;
11220 output_to "python/guestfs-py.c" generate_python_c;
11221 output_to "python/guestfs.py" generate_python_py;
11222 output_to "python/bindtests.py" generate_python_bindtests;
11223 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11224 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11225 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11229 let cols = cols_of_struct typ in
11230 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11231 output_to filename (generate_java_struct jtyp cols);
11234 output_to "java/Makefile.inc" generate_java_makefile_inc;
11235 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11236 output_to "java/Bindtests.java" generate_java_bindtests;
11237 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11238 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11239 output_to "csharp/Libguestfs.cs" generate_csharp;
11241 (* Always generate this file last, and unconditionally. It's used
11242 * by the Makefile to know when we must re-run the generator.
11244 let chan = open_out "src/stamp-generator" in
11245 fprintf chan "1\n";
11248 printf "generated %d lines of code\n" !lines