3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
168 (* Opaque buffer which can contain arbitrary 8 bit data.
169 * In the C API, this is expressed as <char *, int> pair.
170 * Most other languages have a string type which can contain
171 * ASCII NUL. We use whatever type is appropriate for each
173 * Buffers are limited by the total message size. To transfer
174 * large blocks of data, use FileIn/FileOut parameters instead.
175 * To return an arbitrary buffer, use RBufferOut.
181 | ProtocolLimitWarning (* display warning about protocol size limits *)
182 | DangerWillRobinson (* flags particularly dangerous commands *)
183 | FishAlias of string (* provide an alias for this cmd in guestfish *)
184 | FishAction of string (* call this function in guestfish *)
185 | FishOutput of fish_output_t (* how to display output in guestfish *)
186 | NotInFish (* do not export via guestfish *)
187 | NotInDocs (* do not add this function to documentation *)
188 | DeprecatedBy of string (* function is deprecated, use .. instead *)
189 | Optional of string (* function is part of an optional group *)
192 | FishOutputOctal (* for int return, print in octal *)
193 | FishOutputHexadecimal (* for int return, print in hex *)
195 (* You can supply zero or as many tests as you want per API call.
197 * Note that the test environment has 3 block devices, of size 500MB,
198 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
199 * a fourth ISO block device with some known files on it (/dev/sdd).
201 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
202 * Number of cylinders was 63 for IDE emulated disks with precisely
203 * the same size. How exactly this is calculated is a mystery.
205 * The ISO block device (/dev/sdd) comes from images/test.iso.
207 * To be able to run the tests in a reasonable amount of time,
208 * the virtual machine and block devices are reused between tests.
209 * So don't try testing kill_subprocess :-x
211 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
213 * Don't assume anything about the previous contents of the block
214 * devices. Use 'Init*' to create some initial scenarios.
216 * You can add a prerequisite clause to any individual test. This
217 * is a run-time check, which, if it fails, causes the test to be
218 * skipped. Useful if testing a command which might not work on
219 * all variations of libguestfs builds. A test that has prerequisite
220 * of 'Always' is run unconditionally.
222 * In addition, packagers can skip individual tests by setting the
223 * environment variables: eg:
224 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
225 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
227 type tests = (test_init * test_prereq * test) list
229 (* Run the command sequence and just expect nothing to fail. *)
232 (* Run the command sequence and expect the output of the final
233 * command to be the string.
235 | TestOutput of seq * string
237 (* Run the command sequence and expect the output of the final
238 * command to be the list of strings.
240 | TestOutputList of seq * string list
242 (* Run the command sequence and expect the output of the final
243 * command to be the list of block devices (could be either
244 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
245 * character of each string).
247 | TestOutputListOfDevices of seq * string list
249 (* Run the command sequence and expect the output of the final
250 * command to be the integer.
252 | TestOutputInt of seq * int
254 (* Run the command sequence and expect the output of the final
255 * command to be <op> <int>, eg. ">=", "1".
257 | TestOutputIntOp of seq * string * int
259 (* Run the command sequence and expect the output of the final
260 * command to be a true value (!= 0 or != NULL).
262 | TestOutputTrue of seq
264 (* Run the command sequence and expect the output of the final
265 * command to be a false value (== 0 or == NULL, but not an error).
267 | TestOutputFalse of seq
269 (* Run the command sequence and expect the output of the final
270 * command to be a list of the given length (but don't care about
273 | TestOutputLength of seq * int
275 (* Run the command sequence and expect the output of the final
276 * command to be a buffer (RBufferOut), ie. string + size.
278 | TestOutputBuffer of seq * string
280 (* Run the command sequence and expect the output of the final
281 * command to be a structure.
283 | TestOutputStruct of seq * test_field_compare list
285 (* Run the command sequence and expect the final command (only)
288 | TestLastFail of seq
290 and test_field_compare =
291 | CompareWithInt of string * int
292 | CompareWithIntOp of string * string * int
293 | CompareWithString of string * string
294 | CompareFieldsIntEq of string * string
295 | CompareFieldsStrEq of string * string
297 (* Test prerequisites. *)
299 (* Test always runs. *)
302 (* Test is currently disabled - eg. it fails, or it tests some
303 * unimplemented feature.
307 (* 'string' is some C code (a function body) that should return
308 * true or false. The test will run if the code returns true.
312 (* As for 'If' but the test runs _unless_ the code returns true. *)
315 (* Some initial scenarios for testing. *)
317 (* Do nothing, block devices could contain random stuff including
318 * LVM PVs, and some filesystems might be mounted. This is usually
323 (* Block devices are empty and no filesystems are mounted. *)
326 (* /dev/sda contains a single partition /dev/sda1, with random
327 * content. /dev/sdb and /dev/sdc may have random content.
332 (* /dev/sda contains a single partition /dev/sda1, which is formatted
333 * as ext2, empty [except for lost+found] and mounted on /.
334 * /dev/sdb and /dev/sdc may have random content.
340 * /dev/sda1 (is a PV):
341 * /dev/VG/LV (size 8MB):
342 * formatted as ext2, empty [except for lost+found], mounted on /
343 * /dev/sdb and /dev/sdc may have random content.
347 (* /dev/sdd (the ISO, see images/ directory in source)
352 (* Sequence of commands for testing. *)
354 and cmd = string list
356 (* Note about long descriptions: When referring to another
357 * action, use the format C<guestfs_other> (ie. the full name of
358 * the C function). This will be replaced as appropriate in other
361 * Apart from that, long descriptions are just perldoc paragraphs.
364 (* Generate a random UUID (used in tests). *)
366 let chan = open_process_in "uuidgen" in
367 let uuid = input_line chan in
368 (match close_process_in chan with
371 failwith "uuidgen: process exited with non-zero status"
372 | WSIGNALED _ | WSTOPPED _ ->
373 failwith "uuidgen: process signalled or stopped by signal"
377 (* These test functions are used in the language binding tests. *)
379 let test_all_args = [
382 StringList "strlist";
390 let test_all_rets = [
391 (* except for RErr, which is tested thoroughly elsewhere *)
392 "test0rint", RInt "valout";
393 "test0rint64", RInt64 "valout";
394 "test0rbool", RBool "valout";
395 "test0rconststring", RConstString "valout";
396 "test0rconstoptstring", RConstOptString "valout";
397 "test0rstring", RString "valout";
398 "test0rstringlist", RStringList "valout";
399 "test0rstruct", RStruct ("valout", "lvm_pv");
400 "test0rstructlist", RStructList ("valout", "lvm_pv");
401 "test0rhashtable", RHashtable "valout";
404 let test_functions = [
405 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
407 "internal test function - do not use",
409 This is an internal test function which is used to test whether
410 the automatically generated bindings can handle every possible
411 parameter type correctly.
413 It echos the contents of each parameter to stdout.
415 You probably don't want to call this function.");
419 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
421 "internal test function - do not use",
423 This is an internal test function which is used to test whether
424 the automatically generated bindings can handle every possible
425 return type correctly.
427 It converts string C<val> to the return type.
429 You probably don't want to call this function.");
430 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
432 "internal test function - do not use",
434 This is an internal test function which is used to test whether
435 the automatically generated bindings can handle every possible
436 return type correctly.
438 This function always returns an error.
440 You probably don't want to call this function.")]
444 (* non_daemon_functions are any functions which don't get processed
445 * in the daemon, eg. functions for setting and getting local
446 * configuration values.
449 let non_daemon_functions = test_functions @ [
450 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
452 "launch the qemu subprocess",
454 Internally libguestfs is implemented by running a virtual machine
457 You should call this after configuring the handle
458 (eg. adding drives) but before performing any actions.");
460 ("wait_ready", (RErr, []), -1, [NotInFish],
462 "wait until the qemu subprocess launches (no op)",
464 This function is a no op.
466 In versions of the API E<lt> 1.0.71 you had to call this function
467 just after calling C<guestfs_launch> to wait for the launch
468 to complete. However this is no longer necessary because
469 C<guestfs_launch> now does the waiting.
471 If you see any calls to this function in code then you can just
472 remove them, unless you want to retain compatibility with older
473 versions of the API.");
475 ("kill_subprocess", (RErr, []), -1, [],
477 "kill the qemu subprocess",
479 This kills the qemu subprocess. You should never need to call this.");
481 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
483 "add an image to examine or modify",
485 This function adds a virtual machine disk image C<filename> to the
486 guest. The first time you call this function, the disk appears as IDE
487 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
490 You don't necessarily need to be root when using libguestfs. However
491 you obviously do need sufficient permissions to access the filename
492 for whatever operations you want to perform (ie. read access if you
493 just want to read the image or write access if you want to modify the
496 This is equivalent to the qemu parameter
497 C<-drive file=filename,cache=off,if=...>.
499 C<cache=off> is omitted in cases where it is not supported by
500 the underlying filesystem.
502 C<if=...> is set at compile time by the configuration option
503 C<./configure --with-drive-if=...>. In the rare case where you
504 might need to change this at run time, use C<guestfs_add_drive_with_if>
505 or C<guestfs_add_drive_ro_with_if>.
507 Note that this call checks for the existence of C<filename>. This
508 stops you from specifying other types of drive which are supported
509 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
510 the general C<guestfs_config> call instead.");
512 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
514 "add a CD-ROM disk image to examine",
516 This function adds a virtual CD-ROM disk image to the guest.
518 This is equivalent to the qemu parameter C<-cdrom filename>.
526 This call checks for the existence of C<filename>. This
527 stops you from specifying other types of drive which are supported
528 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
529 the general C<guestfs_config> call instead.
533 If you just want to add an ISO file (often you use this as an
534 efficient way to transfer large files into the guest), then you
535 should probably use C<guestfs_add_drive_ro> instead.
539 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
541 "add a drive in snapshot mode (read-only)",
543 This adds a drive in snapshot mode, making it effectively
546 Note that writes to the device are allowed, and will be seen for
547 the duration of the guestfs handle, but they are written
548 to a temporary file which is discarded as soon as the guestfs
549 handle is closed. We don't currently have any method to enable
550 changes to be committed, although qemu can support this.
552 This is equivalent to the qemu parameter
553 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
555 C<if=...> is set at compile time by the configuration option
556 C<./configure --with-drive-if=...>. In the rare case where you
557 might need to change this at run time, use C<guestfs_add_drive_with_if>
558 or C<guestfs_add_drive_ro_with_if>.
560 C<readonly=on> is only added where qemu supports this option.
562 Note that this call checks for the existence of C<filename>. This
563 stops you from specifying other types of drive which are supported
564 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
565 the general C<guestfs_config> call instead.");
567 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
569 "add qemu parameters",
571 This can be used to add arbitrary qemu command line parameters
572 of the form C<-param value>. Actually it's not quite arbitrary - we
573 prevent you from setting some parameters which would interfere with
574 parameters that we use.
576 The first character of C<param> string must be a C<-> (dash).
578 C<value> can be NULL.");
580 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
582 "set the qemu binary",
584 Set the qemu binary that we will use.
586 The default is chosen when the library was compiled by the
589 You can also override this by setting the C<LIBGUESTFS_QEMU>
590 environment variable.
592 Setting C<qemu> to C<NULL> restores the default qemu binary.
594 Note that you should call this function as early as possible
595 after creating the handle. This is because some pre-launch
596 operations depend on testing qemu features (by running C<qemu -help>).
597 If the qemu binary changes, we don't retest features, and
598 so you might see inconsistent results. Using the environment
599 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
600 the qemu binary at the same time as the handle is created.");
602 ("get_qemu", (RConstString "qemu", []), -1, [],
603 [InitNone, Always, TestRun (
605 "get the qemu binary",
607 Return the current qemu binary.
609 This is always non-NULL. If it wasn't set already, then this will
610 return the default qemu binary name.");
612 ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
614 "set the search path",
616 Set the path that libguestfs searches for kernel and initrd.img.
618 The default is C<$libdir/guestfs> unless overridden by setting
619 C<LIBGUESTFS_PATH> environment variable.
621 Setting C<path> to C<NULL> restores the default path.");
623 ("get_path", (RConstString "path", []), -1, [],
624 [InitNone, Always, TestRun (
626 "get the search path",
628 Return the current search path.
630 This is always non-NULL. If it wasn't set already, then this will
631 return the default path.");
633 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
635 "add options to kernel command line",
637 This function is used to add additional options to the
638 guest kernel command line.
640 The default is C<NULL> unless overridden by setting
641 C<LIBGUESTFS_APPEND> environment variable.
643 Setting C<append> to C<NULL> means I<no> additional options
644 are passed (libguestfs always adds a few of its own).");
646 ("get_append", (RConstOptString "append", []), -1, [],
647 (* This cannot be tested with the current framework. The
648 * function can return NULL in normal operations, which the
649 * test framework interprets as an error.
652 "get the additional kernel options",
654 Return the additional kernel options which are added to the
655 guest kernel command line.
657 If C<NULL> then no options are added.");
659 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
663 If C<autosync> is true, this enables autosync. Libguestfs will make a
664 best effort attempt to run C<guestfs_umount_all> followed by
665 C<guestfs_sync> when the handle is closed
666 (also if the program exits without closing handles).
668 This is disabled by default (except in guestfish where it is
669 enabled by default).");
671 ("get_autosync", (RBool "autosync", []), -1, [],
672 [InitNone, Always, TestRun (
673 [["get_autosync"]])],
676 Get the autosync flag.");
678 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
682 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
684 Verbose messages are disabled unless the environment variable
685 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
687 ("get_verbose", (RBool "verbose", []), -1, [],
691 This returns the verbose messages flag.");
693 ("is_ready", (RBool "ready", []), -1, [],
694 [InitNone, Always, TestOutputTrue (
696 "is ready to accept commands",
698 This returns true iff this handle is ready to accept commands
699 (in the C<READY> state).
701 For more information on states, see L<guestfs(3)>.");
703 ("is_config", (RBool "config", []), -1, [],
704 [InitNone, Always, TestOutputFalse (
706 "is in configuration state",
708 This returns true iff this handle is being configured
709 (in the C<CONFIG> state).
711 For more information on states, see L<guestfs(3)>.");
713 ("is_launching", (RBool "launching", []), -1, [],
714 [InitNone, Always, TestOutputFalse (
715 [["is_launching"]])],
716 "is launching subprocess",
718 This returns true iff this handle is launching the subprocess
719 (in the C<LAUNCHING> state).
721 For more information on states, see L<guestfs(3)>.");
723 ("is_busy", (RBool "busy", []), -1, [],
724 [InitNone, Always, TestOutputFalse (
726 "is busy processing a command",
728 This returns true iff this handle is busy processing a command
729 (in the C<BUSY> state).
731 For more information on states, see L<guestfs(3)>.");
733 ("get_state", (RInt "state", []), -1, [],
735 "get the current state",
737 This returns the current state as an opaque integer. This is
738 only useful for printing debug and internal error messages.
740 For more information on states, see L<guestfs(3)>.");
742 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
743 [InitNone, Always, TestOutputInt (
744 [["set_memsize"; "500"];
745 ["get_memsize"]], 500)],
746 "set memory allocated to the qemu subprocess",
748 This sets the memory size in megabytes allocated to the
749 qemu subprocess. This only has any effect if called before
752 You can also change this by setting the environment
753 variable C<LIBGUESTFS_MEMSIZE> before the handle is
756 For more information on the architecture of libguestfs,
757 see L<guestfs(3)>.");
759 ("get_memsize", (RInt "memsize", []), -1, [],
760 [InitNone, Always, TestOutputIntOp (
761 [["get_memsize"]], ">=", 256)],
762 "get memory allocated to the qemu subprocess",
764 This gets the memory size in megabytes allocated to the
767 If C<guestfs_set_memsize> was not called
768 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
769 then this returns the compiled-in default value for memsize.
771 For more information on the architecture of libguestfs,
772 see L<guestfs(3)>.");
774 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
775 [InitNone, Always, TestOutputIntOp (
776 [["get_pid"]], ">=", 1)],
777 "get PID of qemu subprocess",
779 Return the process ID of the qemu subprocess. If there is no
780 qemu subprocess, then this will return an error.
782 This is an internal call used for debugging and testing.");
784 ("version", (RStruct ("version", "version"), []), -1, [],
785 [InitNone, Always, TestOutputStruct (
786 [["version"]], [CompareWithInt ("major", 1)])],
787 "get the library version number",
789 Return the libguestfs version number that the program is linked
792 Note that because of dynamic linking this is not necessarily
793 the version of libguestfs that you compiled against. You can
794 compile the program, and then at runtime dynamically link
795 against a completely different C<libguestfs.so> library.
797 This call was added in version C<1.0.58>. In previous
798 versions of libguestfs there was no way to get the version
799 number. From C code you can use ELF weak linking tricks to find out if
800 this symbol exists (if it doesn't, then it's an earlier version).
802 The call returns a structure with four elements. The first
803 three (C<major>, C<minor> and C<release>) are numbers and
804 correspond to the usual version triplet. The fourth element
805 (C<extra>) is a string and is normally empty, but may be
806 used for distro-specific information.
808 To construct the original version string:
809 C<$major.$minor.$release$extra>
811 I<Note:> Don't use this call to test for availability
812 of features. Distro backports makes this unreliable. Use
813 C<guestfs_available> instead.");
815 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
816 [InitNone, Always, TestOutputTrue (
817 [["set_selinux"; "true"];
819 "set SELinux enabled or disabled at appliance boot",
821 This sets the selinux flag that is passed to the appliance
822 at boot time. The default is C<selinux=0> (disabled).
824 Note that if SELinux is enabled, it is always in
825 Permissive mode (C<enforcing=0>).
827 For more information on the architecture of libguestfs,
828 see L<guestfs(3)>.");
830 ("get_selinux", (RBool "selinux", []), -1, [],
832 "get SELinux enabled flag",
834 This returns the current setting of the selinux flag which
835 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
837 For more information on the architecture of libguestfs,
838 see L<guestfs(3)>.");
840 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
841 [InitNone, Always, TestOutputFalse (
842 [["set_trace"; "false"];
844 "enable or disable command traces",
846 If the command trace flag is set to 1, then commands are
847 printed on stdout before they are executed in a format
848 which is very similar to the one used by guestfish. In
849 other words, you can run a program with this enabled, and
850 you will get out a script which you can feed to guestfish
851 to perform the same set of actions.
853 If you want to trace C API calls into libguestfs (and
854 other libraries) then possibly a better way is to use
855 the external ltrace(1) command.
857 Command traces are disabled unless the environment variable
858 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
860 ("get_trace", (RBool "trace", []), -1, [],
862 "get command trace enabled flag",
864 Return the command trace flag.");
866 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
867 [InitNone, Always, TestOutputFalse (
868 [["set_direct"; "false"];
870 "enable or disable direct appliance mode",
872 If the direct appliance mode flag is enabled, then stdin and
873 stdout are passed directly through to the appliance once it
876 One consequence of this is that log messages aren't caught
877 by the library and handled by C<guestfs_set_log_message_callback>,
878 but go straight to stdout.
880 You probably don't want to use this unless you know what you
883 The default is disabled.");
885 ("get_direct", (RBool "direct", []), -1, [],
887 "get direct appliance mode flag",
889 Return the direct appliance mode flag.");
891 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
892 [InitNone, Always, TestOutputTrue (
893 [["set_recovery_proc"; "true"];
894 ["get_recovery_proc"]])],
895 "enable or disable the recovery process",
897 If this is called with the parameter C<false> then
898 C<guestfs_launch> does not create a recovery process. The
899 purpose of the recovery process is to stop runaway qemu
900 processes in the case where the main program aborts abruptly.
902 This only has any effect if called before C<guestfs_launch>,
903 and the default is true.
905 About the only time when you would want to disable this is
906 if the main process will fork itself into the background
907 (\"daemonize\" itself). In this case the recovery process
908 thinks that the main program has disappeared and so kills
909 qemu, which is not very helpful.");
911 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
913 "get recovery process enabled flag",
915 Return the recovery process enabled flag.");
917 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
919 "add a drive specifying the QEMU block emulation to use",
921 This is the same as C<guestfs_add_drive> but it allows you
922 to specify the QEMU interface emulation to use at run time.");
924 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
926 "add a drive read-only specifying the QEMU block emulation to use",
928 This is the same as C<guestfs_add_drive_ro> but it allows you
929 to specify the QEMU interface emulation to use at run time.");
933 (* daemon_functions are any functions which cause some action
934 * to take place in the daemon.
937 let daemon_functions = [
938 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
939 [InitEmpty, Always, TestOutput (
940 [["part_disk"; "/dev/sda"; "mbr"];
941 ["mkfs"; "ext2"; "/dev/sda1"];
942 ["mount"; "/dev/sda1"; "/"];
943 ["write_file"; "/new"; "new file contents"; "0"];
944 ["cat"; "/new"]], "new file contents")],
945 "mount a guest disk at a position in the filesystem",
947 Mount a guest disk at a position in the filesystem. Block devices
948 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
949 the guest. If those block devices contain partitions, they will have
950 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
953 The rules are the same as for L<mount(2)>: A filesystem must
954 first be mounted on C</> before others can be mounted. Other
955 filesystems can only be mounted on directories which already
958 The mounted filesystem is writable, if we have sufficient permissions
959 on the underlying device.
961 The filesystem options C<sync> and C<noatime> are set with this
962 call, in order to improve reliability.");
964 ("sync", (RErr, []), 2, [],
965 [ InitEmpty, Always, TestRun [["sync"]]],
966 "sync disks, writes are flushed through to the disk image",
968 This syncs the disk, so that any writes are flushed through to the
969 underlying disk image.
971 You should always call this if you have modified a disk image, before
972 closing the handle.");
974 ("touch", (RErr, [Pathname "path"]), 3, [],
975 [InitBasicFS, Always, TestOutputTrue (
977 ["exists"; "/new"]])],
978 "update file timestamps or create a new file",
980 Touch acts like the L<touch(1)> command. It can be used to
981 update the timestamps on a file, or, if the file does not exist,
982 to create a new zero-length file.");
984 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
985 [InitISOFS, Always, TestOutput (
986 [["cat"; "/known-2"]], "abcdef\n")],
987 "list the contents of a file",
989 Return the contents of the file named C<path>.
991 Note that this function cannot correctly handle binary files
992 (specifically, files containing C<\\0> character which is treated
993 as end of string). For those you need to use the C<guestfs_read_file>
994 or C<guestfs_download> functions which have a more complex interface.");
996 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
997 [], (* XXX Tricky to test because it depends on the exact format
998 * of the 'ls -l' command, which changes between F10 and F11.
1000 "list the files in a directory (long format)",
1002 List the files in C<directory> (relative to the root directory,
1003 there is no cwd) in the format of 'ls -la'.
1005 This command is mostly useful for interactive sessions. It
1006 is I<not> intended that you try to parse the output string.");
1008 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1009 [InitBasicFS, Always, TestOutputList (
1011 ["touch"; "/newer"];
1012 ["touch"; "/newest"];
1013 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1014 "list the files in a directory",
1016 List the files in C<directory> (relative to the root directory,
1017 there is no cwd). The '.' and '..' entries are not returned, but
1018 hidden files are shown.
1020 This command is mostly useful for interactive sessions. Programs
1021 should probably use C<guestfs_readdir> instead.");
1023 ("list_devices", (RStringList "devices", []), 7, [],
1024 [InitEmpty, Always, TestOutputListOfDevices (
1025 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1026 "list the block devices",
1028 List all the block devices.
1030 The full block device names are returned, eg. C</dev/sda>");
1032 ("list_partitions", (RStringList "partitions", []), 8, [],
1033 [InitBasicFS, Always, TestOutputListOfDevices (
1034 [["list_partitions"]], ["/dev/sda1"]);
1035 InitEmpty, Always, TestOutputListOfDevices (
1036 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1037 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1038 "list the partitions",
1040 List all the partitions detected on all block devices.
1042 The full partition device names are returned, eg. C</dev/sda1>
1044 This does not return logical volumes. For that you will need to
1045 call C<guestfs_lvs>.");
1047 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1048 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1049 [["pvs"]], ["/dev/sda1"]);
1050 InitEmpty, Always, TestOutputListOfDevices (
1051 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1052 ["pvcreate"; "/dev/sda1"];
1053 ["pvcreate"; "/dev/sda2"];
1054 ["pvcreate"; "/dev/sda3"];
1055 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1056 "list the LVM physical volumes (PVs)",
1058 List all the physical volumes detected. This is the equivalent
1059 of the L<pvs(8)> command.
1061 This returns a list of just the device names that contain
1062 PVs (eg. C</dev/sda2>).
1064 See also C<guestfs_pvs_full>.");
1066 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1067 [InitBasicFSonLVM, Always, TestOutputList (
1069 InitEmpty, Always, TestOutputList (
1070 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1071 ["pvcreate"; "/dev/sda1"];
1072 ["pvcreate"; "/dev/sda2"];
1073 ["pvcreate"; "/dev/sda3"];
1074 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1075 ["vgcreate"; "VG2"; "/dev/sda3"];
1076 ["vgs"]], ["VG1"; "VG2"])],
1077 "list the LVM volume groups (VGs)",
1079 List all the volumes groups detected. This is the equivalent
1080 of the L<vgs(8)> command.
1082 This returns a list of just the volume group names that were
1083 detected (eg. C<VolGroup00>).
1085 See also C<guestfs_vgs_full>.");
1087 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1088 [InitBasicFSonLVM, Always, TestOutputList (
1089 [["lvs"]], ["/dev/VG/LV"]);
1090 InitEmpty, Always, TestOutputList (
1091 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1092 ["pvcreate"; "/dev/sda1"];
1093 ["pvcreate"; "/dev/sda2"];
1094 ["pvcreate"; "/dev/sda3"];
1095 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1096 ["vgcreate"; "VG2"; "/dev/sda3"];
1097 ["lvcreate"; "LV1"; "VG1"; "50"];
1098 ["lvcreate"; "LV2"; "VG1"; "50"];
1099 ["lvcreate"; "LV3"; "VG2"; "50"];
1100 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1101 "list the LVM logical volumes (LVs)",
1103 List all the logical volumes detected. This is the equivalent
1104 of the L<lvs(8)> command.
1106 This returns a list of the logical volume device names
1107 (eg. C</dev/VolGroup00/LogVol00>).
1109 See also C<guestfs_lvs_full>.");
1111 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1112 [], (* XXX how to test? *)
1113 "list the LVM physical volumes (PVs)",
1115 List all the physical volumes detected. This is the equivalent
1116 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1118 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1119 [], (* XXX how to test? *)
1120 "list the LVM volume groups (VGs)",
1122 List all the volumes groups detected. This is the equivalent
1123 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1125 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1126 [], (* XXX how to test? *)
1127 "list the LVM logical volumes (LVs)",
1129 List all the logical volumes detected. This is the equivalent
1130 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1132 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1133 [InitISOFS, Always, TestOutputList (
1134 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1135 InitISOFS, Always, TestOutputList (
1136 [["read_lines"; "/empty"]], [])],
1137 "read file as lines",
1139 Return the contents of the file named C<path>.
1141 The file contents are returned as a list of lines. Trailing
1142 C<LF> and C<CRLF> character sequences are I<not> returned.
1144 Note that this function cannot correctly handle binary files
1145 (specifically, files containing C<\\0> character which is treated
1146 as end of line). For those you need to use the C<guestfs_read_file>
1147 function which has a more complex interface.");
1149 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1150 [], (* XXX Augeas code needs tests. *)
1151 "create a new Augeas handle",
1153 Create a new Augeas handle for editing configuration files.
1154 If there was any previous Augeas handle associated with this
1155 guestfs session, then it is closed.
1157 You must call this before using any other C<guestfs_aug_*>
1160 C<root> is the filesystem root. C<root> must not be NULL,
1163 The flags are the same as the flags defined in
1164 E<lt>augeas.hE<gt>, the logical I<or> of the following
1169 =item C<AUG_SAVE_BACKUP> = 1
1171 Keep the original file with a C<.augsave> extension.
1173 =item C<AUG_SAVE_NEWFILE> = 2
1175 Save changes into a file with extension C<.augnew>, and
1176 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1178 =item C<AUG_TYPE_CHECK> = 4
1180 Typecheck lenses (can be expensive).
1182 =item C<AUG_NO_STDINC> = 8
1184 Do not use standard load path for modules.
1186 =item C<AUG_SAVE_NOOP> = 16
1188 Make save a no-op, just record what would have been changed.
1190 =item C<AUG_NO_LOAD> = 32
1192 Do not load the tree in C<guestfs_aug_init>.
1196 To close the handle, you can call C<guestfs_aug_close>.
1198 To find out more about Augeas, see L<http://augeas.net/>.");
1200 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1201 [], (* XXX Augeas code needs tests. *)
1202 "close the current Augeas handle",
1204 Close the current Augeas handle and free up any resources
1205 used by it. After calling this, you have to call
1206 C<guestfs_aug_init> again before you can use any other
1207 Augeas functions.");
1209 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1210 [], (* XXX Augeas code needs tests. *)
1211 "define an Augeas variable",
1213 Defines an Augeas variable C<name> whose value is the result
1214 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1217 On success this returns the number of nodes in C<expr>, or
1218 C<0> if C<expr> evaluates to something which is not a nodeset.");
1220 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1221 [], (* XXX Augeas code needs tests. *)
1222 "define an Augeas node",
1224 Defines a variable C<name> whose value is the result of
1227 If C<expr> evaluates to an empty nodeset, a node is created,
1228 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1229 C<name> will be the nodeset containing that single node.
1231 On success this returns a pair containing the
1232 number of nodes in the nodeset, and a boolean flag
1233 if a node was created.");
1235 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1236 [], (* XXX Augeas code needs tests. *)
1237 "look up the value of an Augeas path",
1239 Look up the value associated with C<path>. If C<path>
1240 matches exactly one node, the C<value> is returned.");
1242 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1243 [], (* XXX Augeas code needs tests. *)
1244 "set Augeas path to value",
1246 Set the value associated with C<path> to C<val>.
1248 In the Augeas API, it is possible to clear a node by setting
1249 the value to NULL. Due to an oversight in the libguestfs API
1250 you cannot do that with this call. Instead you must use the
1251 C<guestfs_aug_clear> call.");
1253 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1254 [], (* XXX Augeas code needs tests. *)
1255 "insert a sibling Augeas node",
1257 Create a new sibling C<label> for C<path>, inserting it into
1258 the tree before or after C<path> (depending on the boolean
1261 C<path> must match exactly one existing node in the tree, and
1262 C<label> must be a label, ie. not contain C</>, C<*> or end
1263 with a bracketed index C<[N]>.");
1265 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1266 [], (* XXX Augeas code needs tests. *)
1267 "remove an Augeas path",
1269 Remove C<path> and all of its children.
1271 On success this returns the number of entries which were removed.");
1273 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1274 [], (* XXX Augeas code needs tests. *)
1277 Move the node C<src> to C<dest>. C<src> must match exactly
1278 one node. C<dest> is overwritten if it exists.");
1280 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1281 [], (* XXX Augeas code needs tests. *)
1282 "return Augeas nodes which match augpath",
1284 Returns a list of paths which match the path expression C<path>.
1285 The returned paths are sufficiently qualified so that they match
1286 exactly one node in the current tree.");
1288 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1289 [], (* XXX Augeas code needs tests. *)
1290 "write all pending Augeas changes to disk",
1292 This writes all pending changes to disk.
1294 The flags which were passed to C<guestfs_aug_init> affect exactly
1295 how files are saved.");
1297 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1298 [], (* XXX Augeas code needs tests. *)
1299 "load files into the tree",
1301 Load files into the tree.
1303 See C<aug_load> in the Augeas documentation for the full gory
1306 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1307 [], (* XXX Augeas code needs tests. *)
1308 "list Augeas nodes under augpath",
1310 This is just a shortcut for listing C<guestfs_aug_match>
1311 C<path/*> and sorting the resulting nodes into alphabetical order.");
1313 ("rm", (RErr, [Pathname "path"]), 29, [],
1314 [InitBasicFS, Always, TestRun
1317 InitBasicFS, Always, TestLastFail
1319 InitBasicFS, Always, TestLastFail
1324 Remove the single file C<path>.");
1326 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1327 [InitBasicFS, Always, TestRun
1330 InitBasicFS, Always, TestLastFail
1331 [["rmdir"; "/new"]];
1332 InitBasicFS, Always, TestLastFail
1334 ["rmdir"; "/new"]]],
1335 "remove a directory",
1337 Remove the single directory C<path>.");
1339 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1340 [InitBasicFS, Always, TestOutputFalse
1342 ["mkdir"; "/new/foo"];
1343 ["touch"; "/new/foo/bar"];
1345 ["exists"; "/new"]]],
1346 "remove a file or directory recursively",
1348 Remove the file or directory C<path>, recursively removing the
1349 contents if its a directory. This is like the C<rm -rf> shell
1352 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1353 [InitBasicFS, Always, TestOutputTrue
1355 ["is_dir"; "/new"]];
1356 InitBasicFS, Always, TestLastFail
1357 [["mkdir"; "/new/foo/bar"]]],
1358 "create a directory",
1360 Create a directory named C<path>.");
1362 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1363 [InitBasicFS, Always, TestOutputTrue
1364 [["mkdir_p"; "/new/foo/bar"];
1365 ["is_dir"; "/new/foo/bar"]];
1366 InitBasicFS, Always, TestOutputTrue
1367 [["mkdir_p"; "/new/foo/bar"];
1368 ["is_dir"; "/new/foo"]];
1369 InitBasicFS, Always, TestOutputTrue
1370 [["mkdir_p"; "/new/foo/bar"];
1371 ["is_dir"; "/new"]];
1372 (* Regression tests for RHBZ#503133: *)
1373 InitBasicFS, Always, TestRun
1375 ["mkdir_p"; "/new"]];
1376 InitBasicFS, Always, TestLastFail
1378 ["mkdir_p"; "/new"]]],
1379 "create a directory and parents",
1381 Create a directory named C<path>, creating any parent directories
1382 as necessary. This is like the C<mkdir -p> shell command.");
1384 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1385 [], (* XXX Need stat command to test *)
1388 Change the mode (permissions) of C<path> to C<mode>. Only
1389 numeric modes are supported.
1391 I<Note>: When using this command from guestfish, C<mode>
1392 by default would be decimal, unless you prefix it with
1393 C<0> to get octal, ie. use C<0700> not C<700>.");
1395 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1396 [], (* XXX Need stat command to test *)
1397 "change file owner and group",
1399 Change the file owner to C<owner> and group to C<group>.
1401 Only numeric uid and gid are supported. If you want to use
1402 names, you will need to locate and parse the password file
1403 yourself (Augeas support makes this relatively easy).");
1405 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1406 [InitISOFS, Always, TestOutputTrue (
1407 [["exists"; "/empty"]]);
1408 InitISOFS, Always, TestOutputTrue (
1409 [["exists"; "/directory"]])],
1410 "test if file or directory exists",
1412 This returns C<true> if and only if there is a file, directory
1413 (or anything) with the given C<path> name.
1415 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1417 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1418 [InitISOFS, Always, TestOutputTrue (
1419 [["is_file"; "/known-1"]]);
1420 InitISOFS, Always, TestOutputFalse (
1421 [["is_file"; "/directory"]])],
1422 "test if file exists",
1424 This returns C<true> if and only if there is a file
1425 with the given C<path> name. Note that it returns false for
1426 other objects like directories.
1428 See also C<guestfs_stat>.");
1430 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1431 [InitISOFS, Always, TestOutputFalse (
1432 [["is_dir"; "/known-3"]]);
1433 InitISOFS, Always, TestOutputTrue (
1434 [["is_dir"; "/directory"]])],
1435 "test if file exists",
1437 This returns C<true> if and only if there is a directory
1438 with the given C<path> name. Note that it returns false for
1439 other objects like files.
1441 See also C<guestfs_stat>.");
1443 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1444 [InitEmpty, Always, TestOutputListOfDevices (
1445 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1446 ["pvcreate"; "/dev/sda1"];
1447 ["pvcreate"; "/dev/sda2"];
1448 ["pvcreate"; "/dev/sda3"];
1449 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1450 "create an LVM physical volume",
1452 This creates an LVM physical volume on the named C<device>,
1453 where C<device> should usually be a partition name such
1456 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1457 [InitEmpty, Always, TestOutputList (
1458 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1459 ["pvcreate"; "/dev/sda1"];
1460 ["pvcreate"; "/dev/sda2"];
1461 ["pvcreate"; "/dev/sda3"];
1462 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1463 ["vgcreate"; "VG2"; "/dev/sda3"];
1464 ["vgs"]], ["VG1"; "VG2"])],
1465 "create an LVM volume group",
1467 This creates an LVM volume group called C<volgroup>
1468 from the non-empty list of physical volumes C<physvols>.");
1470 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1471 [InitEmpty, Always, TestOutputList (
1472 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1473 ["pvcreate"; "/dev/sda1"];
1474 ["pvcreate"; "/dev/sda2"];
1475 ["pvcreate"; "/dev/sda3"];
1476 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1477 ["vgcreate"; "VG2"; "/dev/sda3"];
1478 ["lvcreate"; "LV1"; "VG1"; "50"];
1479 ["lvcreate"; "LV2"; "VG1"; "50"];
1480 ["lvcreate"; "LV3"; "VG2"; "50"];
1481 ["lvcreate"; "LV4"; "VG2"; "50"];
1482 ["lvcreate"; "LV5"; "VG2"; "50"];
1484 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1485 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1486 "create an LVM logical volume",
1488 This creates an LVM logical volume called C<logvol>
1489 on the volume group C<volgroup>, with C<size> megabytes.");
1491 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1492 [InitEmpty, Always, TestOutput (
1493 [["part_disk"; "/dev/sda"; "mbr"];
1494 ["mkfs"; "ext2"; "/dev/sda1"];
1495 ["mount_options"; ""; "/dev/sda1"; "/"];
1496 ["write_file"; "/new"; "new file contents"; "0"];
1497 ["cat"; "/new"]], "new file contents")],
1498 "make a filesystem",
1500 This creates a filesystem on C<device> (usually a partition
1501 or LVM logical volume). The filesystem type is C<fstype>, for
1504 ("sfdisk", (RErr, [Device "device";
1505 Int "cyls"; Int "heads"; Int "sectors";
1506 StringList "lines"]), 43, [DangerWillRobinson],
1508 "create partitions on a block device",
1510 This is a direct interface to the L<sfdisk(8)> program for creating
1511 partitions on block devices.
1513 C<device> should be a block device, for example C</dev/sda>.
1515 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1516 and sectors on the device, which are passed directly to sfdisk as
1517 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1518 of these, then the corresponding parameter is omitted. Usually for
1519 'large' disks, you can just pass C<0> for these, but for small
1520 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1521 out the right geometry and you will need to tell it.
1523 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1524 information refer to the L<sfdisk(8)> manpage.
1526 To create a single partition occupying the whole disk, you would
1527 pass C<lines> as a single element list, when the single element being
1528 the string C<,> (comma).
1530 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1531 C<guestfs_part_init>");
1533 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1534 [InitBasicFS, Always, TestOutput (
1535 [["write_file"; "/new"; "new file contents"; "0"];
1536 ["cat"; "/new"]], "new file contents");
1537 InitBasicFS, Always, TestOutput (
1538 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1539 ["cat"; "/new"]], "\nnew file contents\n");
1540 InitBasicFS, Always, TestOutput (
1541 [["write_file"; "/new"; "\n\n"; "0"];
1542 ["cat"; "/new"]], "\n\n");
1543 InitBasicFS, Always, TestOutput (
1544 [["write_file"; "/new"; ""; "0"];
1545 ["cat"; "/new"]], "");
1546 InitBasicFS, Always, TestOutput (
1547 [["write_file"; "/new"; "\n\n\n"; "0"];
1548 ["cat"; "/new"]], "\n\n\n");
1549 InitBasicFS, Always, TestOutput (
1550 [["write_file"; "/new"; "\n"; "0"];
1551 ["cat"; "/new"]], "\n")],
1554 This call creates a file called C<path>. The contents of the
1555 file is the string C<content> (which can contain any 8 bit data),
1556 with length C<size>.
1558 As a special case, if C<size> is C<0>
1559 then the length is calculated using C<strlen> (so in this case
1560 the content cannot contain embedded ASCII NULs).
1562 I<NB.> Owing to a bug, writing content containing ASCII NUL
1563 characters does I<not> work, even if the length is specified.
1564 We hope to resolve this bug in a future version. In the meantime
1565 use C<guestfs_upload>.");
1567 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1568 [InitEmpty, Always, TestOutputListOfDevices (
1569 [["part_disk"; "/dev/sda"; "mbr"];
1570 ["mkfs"; "ext2"; "/dev/sda1"];
1571 ["mount_options"; ""; "/dev/sda1"; "/"];
1572 ["mounts"]], ["/dev/sda1"]);
1573 InitEmpty, Always, TestOutputList (
1574 [["part_disk"; "/dev/sda"; "mbr"];
1575 ["mkfs"; "ext2"; "/dev/sda1"];
1576 ["mount_options"; ""; "/dev/sda1"; "/"];
1579 "unmount a filesystem",
1581 This unmounts the given filesystem. The filesystem may be
1582 specified either by its mountpoint (path) or the device which
1583 contains the filesystem.");
1585 ("mounts", (RStringList "devices", []), 46, [],
1586 [InitBasicFS, Always, TestOutputListOfDevices (
1587 [["mounts"]], ["/dev/sda1"])],
1588 "show mounted filesystems",
1590 This returns the list of currently mounted filesystems. It returns
1591 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1593 Some internal mounts are not shown.
1595 See also: C<guestfs_mountpoints>");
1597 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1598 [InitBasicFS, Always, TestOutputList (
1601 (* check that umount_all can unmount nested mounts correctly: *)
1602 InitEmpty, Always, TestOutputList (
1603 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1604 ["mkfs"; "ext2"; "/dev/sda1"];
1605 ["mkfs"; "ext2"; "/dev/sda2"];
1606 ["mkfs"; "ext2"; "/dev/sda3"];
1607 ["mount_options"; ""; "/dev/sda1"; "/"];
1609 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1610 ["mkdir"; "/mp1/mp2"];
1611 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1612 ["mkdir"; "/mp1/mp2/mp3"];
1615 "unmount all filesystems",
1617 This unmounts all mounted filesystems.
1619 Some internal mounts are not unmounted by this call.");
1621 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1623 "remove all LVM LVs, VGs and PVs",
1625 This command removes all LVM logical volumes, volume groups
1626 and physical volumes.");
1628 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1629 [InitISOFS, Always, TestOutput (
1630 [["file"; "/empty"]], "empty");
1631 InitISOFS, Always, TestOutput (
1632 [["file"; "/known-1"]], "ASCII text");
1633 InitISOFS, Always, TestLastFail (
1634 [["file"; "/notexists"]])],
1635 "determine file type",
1637 This call uses the standard L<file(1)> command to determine
1638 the type or contents of the file. This also works on devices,
1639 for example to find out whether a partition contains a filesystem.
1641 This call will also transparently look inside various types
1644 The exact command which runs is C<file -zbsL path>. Note in
1645 particular that the filename is not prepended to the output
1646 (the C<-b> option).");
1648 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1649 [InitBasicFS, Always, TestOutput (
1650 [["upload"; "test-command"; "/test-command"];
1651 ["chmod"; "0o755"; "/test-command"];
1652 ["command"; "/test-command 1"]], "Result1");
1653 InitBasicFS, Always, TestOutput (
1654 [["upload"; "test-command"; "/test-command"];
1655 ["chmod"; "0o755"; "/test-command"];
1656 ["command"; "/test-command 2"]], "Result2\n");
1657 InitBasicFS, Always, TestOutput (
1658 [["upload"; "test-command"; "/test-command"];
1659 ["chmod"; "0o755"; "/test-command"];
1660 ["command"; "/test-command 3"]], "\nResult3");
1661 InitBasicFS, Always, TestOutput (
1662 [["upload"; "test-command"; "/test-command"];
1663 ["chmod"; "0o755"; "/test-command"];
1664 ["command"; "/test-command 4"]], "\nResult4\n");
1665 InitBasicFS, Always, TestOutput (
1666 [["upload"; "test-command"; "/test-command"];
1667 ["chmod"; "0o755"; "/test-command"];
1668 ["command"; "/test-command 5"]], "\nResult5\n\n");
1669 InitBasicFS, Always, TestOutput (
1670 [["upload"; "test-command"; "/test-command"];
1671 ["chmod"; "0o755"; "/test-command"];
1672 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1673 InitBasicFS, Always, TestOutput (
1674 [["upload"; "test-command"; "/test-command"];
1675 ["chmod"; "0o755"; "/test-command"];
1676 ["command"; "/test-command 7"]], "");
1677 InitBasicFS, Always, TestOutput (
1678 [["upload"; "test-command"; "/test-command"];
1679 ["chmod"; "0o755"; "/test-command"];
1680 ["command"; "/test-command 8"]], "\n");
1681 InitBasicFS, Always, TestOutput (
1682 [["upload"; "test-command"; "/test-command"];
1683 ["chmod"; "0o755"; "/test-command"];
1684 ["command"; "/test-command 9"]], "\n\n");
1685 InitBasicFS, Always, TestOutput (
1686 [["upload"; "test-command"; "/test-command"];
1687 ["chmod"; "0o755"; "/test-command"];
1688 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1689 InitBasicFS, Always, TestOutput (
1690 [["upload"; "test-command"; "/test-command"];
1691 ["chmod"; "0o755"; "/test-command"];
1692 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1693 InitBasicFS, Always, TestLastFail (
1694 [["upload"; "test-command"; "/test-command"];
1695 ["chmod"; "0o755"; "/test-command"];
1696 ["command"; "/test-command"]])],
1697 "run a command from the guest filesystem",
1699 This call runs a command from the guest filesystem. The
1700 filesystem must be mounted, and must contain a compatible
1701 operating system (ie. something Linux, with the same
1702 or compatible processor architecture).
1704 The single parameter is an argv-style list of arguments.
1705 The first element is the name of the program to run.
1706 Subsequent elements are parameters. The list must be
1707 non-empty (ie. must contain a program name). Note that
1708 the command runs directly, and is I<not> invoked via
1709 the shell (see C<guestfs_sh>).
1711 The return value is anything printed to I<stdout> by
1714 If the command returns a non-zero exit status, then
1715 this function returns an error message. The error message
1716 string is the content of I<stderr> from the command.
1718 The C<$PATH> environment variable will contain at least
1719 C</usr/bin> and C</bin>. If you require a program from
1720 another location, you should provide the full path in the
1723 Shared libraries and data files required by the program
1724 must be available on filesystems which are mounted in the
1725 correct places. It is the caller's responsibility to ensure
1726 all filesystems that are needed are mounted at the right
1729 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1730 [InitBasicFS, Always, TestOutputList (
1731 [["upload"; "test-command"; "/test-command"];
1732 ["chmod"; "0o755"; "/test-command"];
1733 ["command_lines"; "/test-command 1"]], ["Result1"]);
1734 InitBasicFS, Always, TestOutputList (
1735 [["upload"; "test-command"; "/test-command"];
1736 ["chmod"; "0o755"; "/test-command"];
1737 ["command_lines"; "/test-command 2"]], ["Result2"]);
1738 InitBasicFS, Always, TestOutputList (
1739 [["upload"; "test-command"; "/test-command"];
1740 ["chmod"; "0o755"; "/test-command"];
1741 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1742 InitBasicFS, Always, TestOutputList (
1743 [["upload"; "test-command"; "/test-command"];
1744 ["chmod"; "0o755"; "/test-command"];
1745 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1746 InitBasicFS, Always, TestOutputList (
1747 [["upload"; "test-command"; "/test-command"];
1748 ["chmod"; "0o755"; "/test-command"];
1749 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1750 InitBasicFS, Always, TestOutputList (
1751 [["upload"; "test-command"; "/test-command"];
1752 ["chmod"; "0o755"; "/test-command"];
1753 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1754 InitBasicFS, Always, TestOutputList (
1755 [["upload"; "test-command"; "/test-command"];
1756 ["chmod"; "0o755"; "/test-command"];
1757 ["command_lines"; "/test-command 7"]], []);
1758 InitBasicFS, Always, TestOutputList (
1759 [["upload"; "test-command"; "/test-command"];
1760 ["chmod"; "0o755"; "/test-command"];
1761 ["command_lines"; "/test-command 8"]], [""]);
1762 InitBasicFS, Always, TestOutputList (
1763 [["upload"; "test-command"; "/test-command"];
1764 ["chmod"; "0o755"; "/test-command"];
1765 ["command_lines"; "/test-command 9"]], ["";""]);
1766 InitBasicFS, Always, TestOutputList (
1767 [["upload"; "test-command"; "/test-command"];
1768 ["chmod"; "0o755"; "/test-command"];
1769 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1770 InitBasicFS, Always, TestOutputList (
1771 [["upload"; "test-command"; "/test-command"];
1772 ["chmod"; "0o755"; "/test-command"];
1773 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1774 "run a command, returning lines",
1776 This is the same as C<guestfs_command>, but splits the
1777 result into a list of lines.
1779 See also: C<guestfs_sh_lines>");
1781 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1782 [InitISOFS, Always, TestOutputStruct (
1783 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1784 "get file information",
1786 Returns file information for the given C<path>.
1788 This is the same as the C<stat(2)> system call.");
1790 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1791 [InitISOFS, Always, TestOutputStruct (
1792 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1793 "get file information for a symbolic link",
1795 Returns file information for the given C<path>.
1797 This is the same as C<guestfs_stat> except that if C<path>
1798 is a symbolic link, then the link is stat-ed, not the file it
1801 This is the same as the C<lstat(2)> system call.");
1803 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1804 [InitISOFS, Always, TestOutputStruct (
1805 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1806 "get file system statistics",
1808 Returns file system statistics for any mounted file system.
1809 C<path> should be a file or directory in the mounted file system
1810 (typically it is the mount point itself, but it doesn't need to be).
1812 This is the same as the C<statvfs(2)> system call.");
1814 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1816 "get ext2/ext3/ext4 superblock details",
1818 This returns the contents of the ext2, ext3 or ext4 filesystem
1819 superblock on C<device>.
1821 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1822 manpage for more details. The list of fields returned isn't
1823 clearly defined, and depends on both the version of C<tune2fs>
1824 that libguestfs was built against, and the filesystem itself.");
1826 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1827 [InitEmpty, Always, TestOutputTrue (
1828 [["blockdev_setro"; "/dev/sda"];
1829 ["blockdev_getro"; "/dev/sda"]])],
1830 "set block device to read-only",
1832 Sets the block device named C<device> to read-only.
1834 This uses the L<blockdev(8)> command.");
1836 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1837 [InitEmpty, Always, TestOutputFalse (
1838 [["blockdev_setrw"; "/dev/sda"];
1839 ["blockdev_getro"; "/dev/sda"]])],
1840 "set block device to read-write",
1842 Sets the block device named C<device> to read-write.
1844 This uses the L<blockdev(8)> command.");
1846 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1847 [InitEmpty, Always, TestOutputTrue (
1848 [["blockdev_setro"; "/dev/sda"];
1849 ["blockdev_getro"; "/dev/sda"]])],
1850 "is block device set to read-only",
1852 Returns a boolean indicating if the block device is read-only
1853 (true if read-only, false if not).
1855 This uses the L<blockdev(8)> command.");
1857 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1858 [InitEmpty, Always, TestOutputInt (
1859 [["blockdev_getss"; "/dev/sda"]], 512)],
1860 "get sectorsize of block device",
1862 This returns the size of sectors on a block device.
1863 Usually 512, but can be larger for modern devices.
1865 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1868 This uses the L<blockdev(8)> command.");
1870 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1871 [InitEmpty, Always, TestOutputInt (
1872 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1873 "get blocksize of block device",
1875 This returns the block size of a device.
1877 (Note this is different from both I<size in blocks> and
1878 I<filesystem block size>).
1880 This uses the L<blockdev(8)> command.");
1882 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1884 "set blocksize of block device",
1886 This sets the block size of a device.
1888 (Note this is different from both I<size in blocks> and
1889 I<filesystem block size>).
1891 This uses the L<blockdev(8)> command.");
1893 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1894 [InitEmpty, Always, TestOutputInt (
1895 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1896 "get total size of device in 512-byte sectors",
1898 This returns the size of the device in units of 512-byte sectors
1899 (even if the sectorsize isn't 512 bytes ... weird).
1901 See also C<guestfs_blockdev_getss> for the real sector size of
1902 the device, and C<guestfs_blockdev_getsize64> for the more
1903 useful I<size in bytes>.
1905 This uses the L<blockdev(8)> command.");
1907 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1908 [InitEmpty, Always, TestOutputInt (
1909 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1910 "get total size of device in bytes",
1912 This returns the size of the device in bytes.
1914 See also C<guestfs_blockdev_getsz>.
1916 This uses the L<blockdev(8)> command.");
1918 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1919 [InitEmpty, Always, TestRun
1920 [["blockdev_flushbufs"; "/dev/sda"]]],
1921 "flush device buffers",
1923 This tells the kernel to flush internal buffers associated
1926 This uses the L<blockdev(8)> command.");
1928 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1929 [InitEmpty, Always, TestRun
1930 [["blockdev_rereadpt"; "/dev/sda"]]],
1931 "reread partition table",
1933 Reread the partition table on C<device>.
1935 This uses the L<blockdev(8)> command.");
1937 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1938 [InitBasicFS, Always, TestOutput (
1939 (* Pick a file from cwd which isn't likely to change. *)
1940 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1941 ["checksum"; "md5"; "/COPYING.LIB"]],
1942 Digest.to_hex (Digest.file "COPYING.LIB"))],
1943 "upload a file from the local machine",
1945 Upload local file C<filename> to C<remotefilename> on the
1948 C<filename> can also be a named pipe.
1950 See also C<guestfs_download>.");
1952 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1953 [InitBasicFS, Always, TestOutput (
1954 (* Pick a file from cwd which isn't likely to change. *)
1955 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1956 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1957 ["upload"; "testdownload.tmp"; "/upload"];
1958 ["checksum"; "md5"; "/upload"]],
1959 Digest.to_hex (Digest.file "COPYING.LIB"))],
1960 "download a file to the local machine",
1962 Download file C<remotefilename> and save it as C<filename>
1963 on the local machine.
1965 C<filename> can also be a named pipe.
1967 See also C<guestfs_upload>, C<guestfs_cat>.");
1969 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1970 [InitISOFS, Always, TestOutput (
1971 [["checksum"; "crc"; "/known-3"]], "2891671662");
1972 InitISOFS, Always, TestLastFail (
1973 [["checksum"; "crc"; "/notexists"]]);
1974 InitISOFS, Always, TestOutput (
1975 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1976 InitISOFS, Always, TestOutput (
1977 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1978 InitISOFS, Always, TestOutput (
1979 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1980 InitISOFS, Always, TestOutput (
1981 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1982 InitISOFS, Always, TestOutput (
1983 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1984 InitISOFS, Always, TestOutput (
1985 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1986 "compute MD5, SHAx or CRC checksum of file",
1988 This call computes the MD5, SHAx or CRC checksum of the
1991 The type of checksum to compute is given by the C<csumtype>
1992 parameter which must have one of the following values:
1998 Compute the cyclic redundancy check (CRC) specified by POSIX
1999 for the C<cksum> command.
2003 Compute the MD5 hash (using the C<md5sum> program).
2007 Compute the SHA1 hash (using the C<sha1sum> program).
2011 Compute the SHA224 hash (using the C<sha224sum> program).
2015 Compute the SHA256 hash (using the C<sha256sum> program).
2019 Compute the SHA384 hash (using the C<sha384sum> program).
2023 Compute the SHA512 hash (using the C<sha512sum> program).
2027 The checksum is returned as a printable string.");
2029 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
2030 [InitBasicFS, Always, TestOutput (
2031 [["tar_in"; "../images/helloworld.tar"; "/"];
2032 ["cat"; "/hello"]], "hello\n")],
2033 "unpack tarfile to directory",
2035 This command uploads and unpacks local file C<tarfile> (an
2036 I<uncompressed> tar file) into C<directory>.
2038 To upload a compressed tarball, use C<guestfs_tgz_in>
2039 or C<guestfs_txz_in>.");
2041 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2043 "pack directory into tarfile",
2045 This command packs the contents of C<directory> and downloads
2046 it to local file C<tarfile>.
2048 To download a compressed tarball, use C<guestfs_tgz_out>
2049 or C<guestfs_txz_out>.");
2051 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
2052 [InitBasicFS, Always, TestOutput (
2053 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2054 ["cat"; "/hello"]], "hello\n")],
2055 "unpack compressed tarball to directory",
2057 This command uploads and unpacks local file C<tarball> (a
2058 I<gzip compressed> tar file) into C<directory>.
2060 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2062 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2064 "pack directory into compressed tarball",
2066 This command packs the contents of C<directory> and downloads
2067 it to local file C<tarball>.
2069 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2071 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2072 [InitBasicFS, Always, TestLastFail (
2074 ["mount_ro"; "/dev/sda1"; "/"];
2075 ["touch"; "/new"]]);
2076 InitBasicFS, Always, TestOutput (
2077 [["write_file"; "/new"; "data"; "0"];
2079 ["mount_ro"; "/dev/sda1"; "/"];
2080 ["cat"; "/new"]], "data")],
2081 "mount a guest disk, read-only",
2083 This is the same as the C<guestfs_mount> command, but it
2084 mounts the filesystem with the read-only (I<-o ro>) flag.");
2086 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2088 "mount a guest disk with mount options",
2090 This is the same as the C<guestfs_mount> command, but it
2091 allows you to set the mount options as for the
2092 L<mount(8)> I<-o> flag.");
2094 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2096 "mount a guest disk with mount options and vfstype",
2098 This is the same as the C<guestfs_mount> command, but it
2099 allows you to set both the mount options and the vfstype
2100 as for the L<mount(8)> I<-o> and I<-t> flags.");
2102 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2104 "debugging and internals",
2106 The C<guestfs_debug> command exposes some internals of
2107 C<guestfsd> (the guestfs daemon) that runs inside the
2110 There is no comprehensive help for this command. You have
2111 to look at the file C<daemon/debug.c> in the libguestfs source
2112 to find out what you can do.");
2114 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2115 [InitEmpty, Always, TestOutputList (
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"];
2121 ["lvremove"; "/dev/VG/LV1"];
2122 ["lvs"]], ["/dev/VG/LV2"]);
2123 InitEmpty, Always, TestOutputList (
2124 [["part_disk"; "/dev/sda"; "mbr"];
2125 ["pvcreate"; "/dev/sda1"];
2126 ["vgcreate"; "VG"; "/dev/sda1"];
2127 ["lvcreate"; "LV1"; "VG"; "50"];
2128 ["lvcreate"; "LV2"; "VG"; "50"];
2129 ["lvremove"; "/dev/VG"];
2131 InitEmpty, Always, TestOutputList (
2132 [["part_disk"; "/dev/sda"; "mbr"];
2133 ["pvcreate"; "/dev/sda1"];
2134 ["vgcreate"; "VG"; "/dev/sda1"];
2135 ["lvcreate"; "LV1"; "VG"; "50"];
2136 ["lvcreate"; "LV2"; "VG"; "50"];
2137 ["lvremove"; "/dev/VG"];
2139 "remove an LVM logical volume",
2141 Remove an LVM logical volume C<device>, where C<device> is
2142 the path to the LV, such as C</dev/VG/LV>.
2144 You can also remove all LVs in a volume group by specifying
2145 the VG name, C</dev/VG>.");
2147 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2148 [InitEmpty, Always, TestOutputList (
2149 [["part_disk"; "/dev/sda"; "mbr"];
2150 ["pvcreate"; "/dev/sda1"];
2151 ["vgcreate"; "VG"; "/dev/sda1"];
2152 ["lvcreate"; "LV1"; "VG"; "50"];
2153 ["lvcreate"; "LV2"; "VG"; "50"];
2156 InitEmpty, Always, TestOutputList (
2157 [["part_disk"; "/dev/sda"; "mbr"];
2158 ["pvcreate"; "/dev/sda1"];
2159 ["vgcreate"; "VG"; "/dev/sda1"];
2160 ["lvcreate"; "LV1"; "VG"; "50"];
2161 ["lvcreate"; "LV2"; "VG"; "50"];
2164 "remove an LVM volume group",
2166 Remove an LVM volume group C<vgname>, (for example C<VG>).
2168 This also forcibly removes all logical volumes in the volume
2171 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2172 [InitEmpty, Always, TestOutputListOfDevices (
2173 [["part_disk"; "/dev/sda"; "mbr"];
2174 ["pvcreate"; "/dev/sda1"];
2175 ["vgcreate"; "VG"; "/dev/sda1"];
2176 ["lvcreate"; "LV1"; "VG"; "50"];
2177 ["lvcreate"; "LV2"; "VG"; "50"];
2179 ["pvremove"; "/dev/sda1"];
2181 InitEmpty, Always, TestOutputListOfDevices (
2182 [["part_disk"; "/dev/sda"; "mbr"];
2183 ["pvcreate"; "/dev/sda1"];
2184 ["vgcreate"; "VG"; "/dev/sda1"];
2185 ["lvcreate"; "LV1"; "VG"; "50"];
2186 ["lvcreate"; "LV2"; "VG"; "50"];
2188 ["pvremove"; "/dev/sda1"];
2190 InitEmpty, Always, TestOutputListOfDevices (
2191 [["part_disk"; "/dev/sda"; "mbr"];
2192 ["pvcreate"; "/dev/sda1"];
2193 ["vgcreate"; "VG"; "/dev/sda1"];
2194 ["lvcreate"; "LV1"; "VG"; "50"];
2195 ["lvcreate"; "LV2"; "VG"; "50"];
2197 ["pvremove"; "/dev/sda1"];
2199 "remove an LVM physical volume",
2201 This wipes a physical volume C<device> so that LVM will no longer
2204 The implementation uses the C<pvremove> command which refuses to
2205 wipe physical volumes that contain any volume groups, so you have
2206 to remove those first.");
2208 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2209 [InitBasicFS, Always, TestOutput (
2210 [["set_e2label"; "/dev/sda1"; "testlabel"];
2211 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2212 "set the ext2/3/4 filesystem label",
2214 This sets the ext2/3/4 filesystem label of the filesystem on
2215 C<device> to C<label>. Filesystem labels are limited to
2218 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2219 to return the existing label on a filesystem.");
2221 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2223 "get the ext2/3/4 filesystem label",
2225 This returns the ext2/3/4 filesystem label of the filesystem on
2228 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2229 (let uuid = uuidgen () in
2230 [InitBasicFS, Always, TestOutput (
2231 [["set_e2uuid"; "/dev/sda1"; uuid];
2232 ["get_e2uuid"; "/dev/sda1"]], uuid);
2233 InitBasicFS, Always, TestOutput (
2234 [["set_e2uuid"; "/dev/sda1"; "clear"];
2235 ["get_e2uuid"; "/dev/sda1"]], "");
2236 (* We can't predict what UUIDs will be, so just check the commands run. *)
2237 InitBasicFS, Always, TestRun (
2238 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2239 InitBasicFS, Always, TestRun (
2240 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2241 "set the ext2/3/4 filesystem UUID",
2243 This sets the ext2/3/4 filesystem UUID of the filesystem on
2244 C<device> to C<uuid>. The format of the UUID and alternatives
2245 such as C<clear>, C<random> and C<time> are described in the
2246 L<tune2fs(8)> manpage.
2248 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2249 to return the existing UUID of a filesystem.");
2251 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2253 "get the ext2/3/4 filesystem UUID",
2255 This returns the ext2/3/4 filesystem UUID of the filesystem on
2258 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2259 [InitBasicFS, Always, TestOutputInt (
2260 [["umount"; "/dev/sda1"];
2261 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2262 InitBasicFS, Always, TestOutputInt (
2263 [["umount"; "/dev/sda1"];
2264 ["zero"; "/dev/sda1"];
2265 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2266 "run the filesystem checker",
2268 This runs the filesystem checker (fsck) on C<device> which
2269 should have filesystem type C<fstype>.
2271 The returned integer is the status. See L<fsck(8)> for the
2272 list of status codes from C<fsck>.
2280 Multiple status codes can be summed together.
2284 A non-zero return code can mean \"success\", for example if
2285 errors have been corrected on the filesystem.
2289 Checking or repairing NTFS volumes is not supported
2294 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2296 ("zero", (RErr, [Device "device"]), 85, [],
2297 [InitBasicFS, Always, TestOutput (
2298 [["umount"; "/dev/sda1"];
2299 ["zero"; "/dev/sda1"];
2300 ["file"; "/dev/sda1"]], "data")],
2301 "write zeroes to the device",
2303 This command writes zeroes over the first few blocks of C<device>.
2305 How many blocks are zeroed isn't specified (but it's I<not> enough
2306 to securely wipe the device). It should be sufficient to remove
2307 any partition tables, filesystem superblocks and so on.
2309 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2311 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2312 (* Test disabled because grub-install incompatible with virtio-blk driver.
2313 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2315 [InitBasicFS, Disabled, TestOutputTrue (
2316 [["grub_install"; "/"; "/dev/sda1"];
2317 ["is_dir"; "/boot"]])],
2320 This command installs GRUB (the Grand Unified Bootloader) on
2321 C<device>, with the root directory being C<root>.");
2323 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2324 [InitBasicFS, Always, TestOutput (
2325 [["write_file"; "/old"; "file content"; "0"];
2326 ["cp"; "/old"; "/new"];
2327 ["cat"; "/new"]], "file content");
2328 InitBasicFS, Always, TestOutputTrue (
2329 [["write_file"; "/old"; "file content"; "0"];
2330 ["cp"; "/old"; "/new"];
2331 ["is_file"; "/old"]]);
2332 InitBasicFS, Always, TestOutput (
2333 [["write_file"; "/old"; "file content"; "0"];
2335 ["cp"; "/old"; "/dir/new"];
2336 ["cat"; "/dir/new"]], "file content")],
2339 This copies a file from C<src> to C<dest> where C<dest> is
2340 either a destination filename or destination directory.");
2342 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2343 [InitBasicFS, Always, TestOutput (
2344 [["mkdir"; "/olddir"];
2345 ["mkdir"; "/newdir"];
2346 ["write_file"; "/olddir/file"; "file content"; "0"];
2347 ["cp_a"; "/olddir"; "/newdir"];
2348 ["cat"; "/newdir/olddir/file"]], "file content")],
2349 "copy a file or directory recursively",
2351 This copies a file or directory from C<src> to C<dest>
2352 recursively using the C<cp -a> command.");
2354 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2355 [InitBasicFS, Always, TestOutput (
2356 [["write_file"; "/old"; "file content"; "0"];
2357 ["mv"; "/old"; "/new"];
2358 ["cat"; "/new"]], "file content");
2359 InitBasicFS, Always, TestOutputFalse (
2360 [["write_file"; "/old"; "file content"; "0"];
2361 ["mv"; "/old"; "/new"];
2362 ["is_file"; "/old"]])],
2365 This moves a file from C<src> to C<dest> where C<dest> is
2366 either a destination filename or destination directory.");
2368 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2369 [InitEmpty, Always, TestRun (
2370 [["drop_caches"; "3"]])],
2371 "drop kernel page cache, dentries and inodes",
2373 This instructs the guest kernel to drop its page cache,
2374 and/or dentries and inode caches. The parameter C<whattodrop>
2375 tells the kernel what precisely to drop, see
2376 L<http://linux-mm.org/Drop_Caches>
2378 Setting C<whattodrop> to 3 should drop everything.
2380 This automatically calls L<sync(2)> before the operation,
2381 so that the maximum guest memory is freed.");
2383 ("dmesg", (RString "kmsgs", []), 91, [],
2384 [InitEmpty, Always, TestRun (
2386 "return kernel messages",
2388 This returns the kernel messages (C<dmesg> output) from
2389 the guest kernel. This is sometimes useful for extended
2390 debugging of problems.
2392 Another way to get the same information is to enable
2393 verbose messages with C<guestfs_set_verbose> or by setting
2394 the environment variable C<LIBGUESTFS_DEBUG=1> before
2395 running the program.");
2397 ("ping_daemon", (RErr, []), 92, [],
2398 [InitEmpty, Always, TestRun (
2399 [["ping_daemon"]])],
2400 "ping the guest daemon",
2402 This is a test probe into the guestfs daemon running inside
2403 the qemu subprocess. Calling this function checks that the
2404 daemon responds to the ping message, without affecting the daemon
2405 or attached block device(s) in any other way.");
2407 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2408 [InitBasicFS, Always, TestOutputTrue (
2409 [["write_file"; "/file1"; "contents of a file"; "0"];
2410 ["cp"; "/file1"; "/file2"];
2411 ["equal"; "/file1"; "/file2"]]);
2412 InitBasicFS, Always, TestOutputFalse (
2413 [["write_file"; "/file1"; "contents of a file"; "0"];
2414 ["write_file"; "/file2"; "contents of another file"; "0"];
2415 ["equal"; "/file1"; "/file2"]]);
2416 InitBasicFS, Always, TestLastFail (
2417 [["equal"; "/file1"; "/file2"]])],
2418 "test if two files have equal contents",
2420 This compares the two files C<file1> and C<file2> and returns
2421 true if their content is exactly equal, or false otherwise.
2423 The external L<cmp(1)> program is used for the comparison.");
2425 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2426 [InitISOFS, Always, TestOutputList (
2427 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2428 InitISOFS, Always, TestOutputList (
2429 [["strings"; "/empty"]], [])],
2430 "print the printable strings in a file",
2432 This runs the L<strings(1)> command on a file and returns
2433 the list of printable strings found.");
2435 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2436 [InitISOFS, Always, TestOutputList (
2437 [["strings_e"; "b"; "/known-5"]], []);
2438 InitBasicFS, Disabled, TestOutputList (
2439 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2440 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2441 "print the printable strings in a file",
2443 This is like the C<guestfs_strings> command, but allows you to
2444 specify the encoding.
2446 See the L<strings(1)> manpage for the full list of encodings.
2448 Commonly useful encodings are C<l> (lower case L) which will
2449 show strings inside Windows/x86 files.
2451 The returned strings are transcoded to UTF-8.");
2453 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2454 [InitISOFS, Always, TestOutput (
2455 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2456 (* Test for RHBZ#501888c2 regression which caused large hexdump
2457 * commands to segfault.
2459 InitISOFS, Always, TestRun (
2460 [["hexdump"; "/100krandom"]])],
2461 "dump a file in hexadecimal",
2463 This runs C<hexdump -C> on the given C<path>. The result is
2464 the human-readable, canonical hex dump of the file.");
2466 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2467 [InitNone, Always, TestOutput (
2468 [["part_disk"; "/dev/sda"; "mbr"];
2469 ["mkfs"; "ext3"; "/dev/sda1"];
2470 ["mount_options"; ""; "/dev/sda1"; "/"];
2471 ["write_file"; "/new"; "test file"; "0"];
2472 ["umount"; "/dev/sda1"];
2473 ["zerofree"; "/dev/sda1"];
2474 ["mount_options"; ""; "/dev/sda1"; "/"];
2475 ["cat"; "/new"]], "test file")],
2476 "zero unused inodes and disk blocks on ext2/3 filesystem",
2478 This runs the I<zerofree> program on C<device>. This program
2479 claims to zero unused inodes and disk blocks on an ext2/3
2480 filesystem, thus making it possible to compress the filesystem
2483 You should B<not> run this program if the filesystem is
2486 It is possible that using this program can damage the filesystem
2487 or data on the filesystem.");
2489 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2491 "resize an LVM physical volume",
2493 This resizes (expands or shrinks) an existing LVM physical
2494 volume to match the new size of the underlying device.");
2496 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2497 Int "cyls"; Int "heads"; Int "sectors";
2498 String "line"]), 99, [DangerWillRobinson],
2500 "modify a single partition on a block device",
2502 This runs L<sfdisk(8)> option to modify just the single
2503 partition C<n> (note: C<n> counts from 1).
2505 For other parameters, see C<guestfs_sfdisk>. You should usually
2506 pass C<0> for the cyls/heads/sectors parameters.
2508 See also: C<guestfs_part_add>");
2510 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2512 "display the partition table",
2514 This displays the partition table on C<device>, in the
2515 human-readable output of the L<sfdisk(8)> command. It is
2516 not intended to be parsed.
2518 See also: C<guestfs_part_list>");
2520 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2522 "display the kernel geometry",
2524 This displays the kernel's idea of the geometry of C<device>.
2526 The result is in human-readable format, and not designed to
2529 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2531 "display the disk geometry from the partition table",
2533 This displays the disk geometry of C<device> read from the
2534 partition table. Especially in the case where the underlying
2535 block device has been resized, this can be different from the
2536 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2538 The result is in human-readable format, and not designed to
2541 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2543 "activate or deactivate all volume groups",
2545 This command activates or (if C<activate> is false) deactivates
2546 all logical volumes in all volume groups.
2547 If activated, then they are made known to the
2548 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2549 then those devices disappear.
2551 This command is the same as running C<vgchange -a y|n>");
2553 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2555 "activate or deactivate some volume groups",
2557 This command activates or (if C<activate> is false) deactivates
2558 all logical volumes in the listed volume groups C<volgroups>.
2559 If activated, then they are made known to the
2560 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2561 then those devices disappear.
2563 This command is the same as running C<vgchange -a y|n volgroups...>
2565 Note that if C<volgroups> is an empty list then B<all> volume groups
2566 are activated or deactivated.");
2568 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2569 [InitNone, Always, TestOutput (
2570 [["part_disk"; "/dev/sda"; "mbr"];
2571 ["pvcreate"; "/dev/sda1"];
2572 ["vgcreate"; "VG"; "/dev/sda1"];
2573 ["lvcreate"; "LV"; "VG"; "10"];
2574 ["mkfs"; "ext2"; "/dev/VG/LV"];
2575 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2576 ["write_file"; "/new"; "test content"; "0"];
2578 ["lvresize"; "/dev/VG/LV"; "20"];
2579 ["e2fsck_f"; "/dev/VG/LV"];
2580 ["resize2fs"; "/dev/VG/LV"];
2581 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2582 ["cat"; "/new"]], "test content")],
2583 "resize an LVM logical volume",
2585 This resizes (expands or shrinks) an existing LVM logical
2586 volume to C<mbytes>. When reducing, data in the reduced part
2589 ("resize2fs", (RErr, [Device "device"]), 106, [],
2590 [], (* lvresize tests this *)
2591 "resize an ext2/ext3 filesystem",
2593 This resizes an ext2 or ext3 filesystem to match the size of
2594 the underlying device.
2596 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2597 on the C<device> before calling this command. For unknown reasons
2598 C<resize2fs> sometimes gives an error about this and sometimes not.
2599 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2600 calling this function.");
2602 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2603 [InitBasicFS, Always, TestOutputList (
2604 [["find"; "/"]], ["lost+found"]);
2605 InitBasicFS, Always, TestOutputList (
2609 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2610 InitBasicFS, Always, TestOutputList (
2611 [["mkdir_p"; "/a/b/c"];
2612 ["touch"; "/a/b/c/d"];
2613 ["find"; "/a/b/"]], ["c"; "c/d"])],
2614 "find all files and directories",
2616 This command lists out all files and directories, recursively,
2617 starting at C<directory>. It is essentially equivalent to
2618 running the shell command C<find directory -print> but some
2619 post-processing happens on the output, described below.
2621 This returns a list of strings I<without any prefix>. Thus
2622 if the directory structure was:
2628 then the returned list from C<guestfs_find> C</tmp> would be
2636 If C<directory> is not a directory, then this command returns
2639 The returned list is sorted.
2641 See also C<guestfs_find0>.");
2643 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2644 [], (* lvresize tests this *)
2645 "check an ext2/ext3 filesystem",
2647 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2648 filesystem checker on C<device>, noninteractively (C<-p>),
2649 even if the filesystem appears to be clean (C<-f>).
2651 This command is only needed because of C<guestfs_resize2fs>
2652 (q.v.). Normally you should use C<guestfs_fsck>.");
2654 ("sleep", (RErr, [Int "secs"]), 109, [],
2655 [InitNone, Always, TestRun (
2657 "sleep for some seconds",
2659 Sleep for C<secs> seconds.");
2661 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2662 [InitNone, Always, TestOutputInt (
2663 [["part_disk"; "/dev/sda"; "mbr"];
2664 ["mkfs"; "ntfs"; "/dev/sda1"];
2665 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2666 InitNone, Always, TestOutputInt (
2667 [["part_disk"; "/dev/sda"; "mbr"];
2668 ["mkfs"; "ext2"; "/dev/sda1"];
2669 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2670 "probe NTFS volume",
2672 This command runs the L<ntfs-3g.probe(8)> command which probes
2673 an NTFS C<device> for mountability. (Not all NTFS volumes can
2674 be mounted read-write, and some cannot be mounted at all).
2676 C<rw> is a boolean flag. Set it to true if you want to test
2677 if the volume can be mounted read-write. Set it to false if
2678 you want to test if the volume can be mounted read-only.
2680 The return value is an integer which C<0> if the operation
2681 would succeed, or some non-zero value documented in the
2682 L<ntfs-3g.probe(8)> manual page.");
2684 ("sh", (RString "output", [String "command"]), 111, [],
2685 [], (* XXX needs tests *)
2686 "run a command via the shell",
2688 This call runs a command from the guest filesystem via the
2691 This is like C<guestfs_command>, but passes the command to:
2693 /bin/sh -c \"command\"
2695 Depending on the guest's shell, this usually results in
2696 wildcards being expanded, shell expressions being interpolated
2699 All the provisos about C<guestfs_command> apply to this call.");
2701 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2702 [], (* XXX needs tests *)
2703 "run a command via the shell returning lines",
2705 This is the same as C<guestfs_sh>, but splits the result
2706 into a list of lines.
2708 See also: C<guestfs_command_lines>");
2710 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2711 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2712 * code in stubs.c, since all valid glob patterns must start with "/".
2713 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2715 [InitBasicFS, Always, TestOutputList (
2716 [["mkdir_p"; "/a/b/c"];
2717 ["touch"; "/a/b/c/d"];
2718 ["touch"; "/a/b/c/e"];
2719 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2720 InitBasicFS, Always, TestOutputList (
2721 [["mkdir_p"; "/a/b/c"];
2722 ["touch"; "/a/b/c/d"];
2723 ["touch"; "/a/b/c/e"];
2724 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2725 InitBasicFS, Always, TestOutputList (
2726 [["mkdir_p"; "/a/b/c"];
2727 ["touch"; "/a/b/c/d"];
2728 ["touch"; "/a/b/c/e"];
2729 ["glob_expand"; "/a/*/x/*"]], [])],
2730 "expand a wildcard path",
2732 This command searches for all the pathnames matching
2733 C<pattern> according to the wildcard expansion rules
2736 If no paths match, then this returns an empty list
2737 (note: not an error).
2739 It is just a wrapper around the C L<glob(3)> function
2740 with flags C<GLOB_MARK|GLOB_BRACE>.
2741 See that manual page for more details.");
2743 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2744 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2745 [["scrub_device"; "/dev/sdc"]])],
2746 "scrub (securely wipe) a device",
2748 This command writes patterns over C<device> to make data retrieval
2751 It is an interface to the L<scrub(1)> program. See that
2752 manual page for more details.");
2754 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2755 [InitBasicFS, Always, TestRun (
2756 [["write_file"; "/file"; "content"; "0"];
2757 ["scrub_file"; "/file"]])],
2758 "scrub (securely wipe) a file",
2760 This command writes patterns over a file to make data retrieval
2763 The file is I<removed> after scrubbing.
2765 It is an interface to the L<scrub(1)> program. See that
2766 manual page for more details.");
2768 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2769 [], (* XXX needs testing *)
2770 "scrub (securely wipe) free space",
2772 This command creates the directory C<dir> and then fills it
2773 with files until the filesystem is full, and scrubs the files
2774 as for C<guestfs_scrub_file>, and deletes them.
2775 The intention is to scrub any free space on the partition
2778 It is an interface to the L<scrub(1)> program. See that
2779 manual page for more details.");
2781 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2782 [InitBasicFS, Always, TestRun (
2784 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2785 "create a temporary directory",
2787 This command creates a temporary directory. The
2788 C<template> parameter should be a full pathname for the
2789 temporary directory name with the final six characters being
2792 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2793 the second one being suitable for Windows filesystems.
2795 The name of the temporary directory that was created
2798 The temporary directory is created with mode 0700
2799 and is owned by root.
2801 The caller is responsible for deleting the temporary
2802 directory and its contents after use.
2804 See also: L<mkdtemp(3)>");
2806 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2807 [InitISOFS, Always, TestOutputInt (
2808 [["wc_l"; "/10klines"]], 10000)],
2809 "count lines in a file",
2811 This command counts the lines in a file, using the
2812 C<wc -l> external command.");
2814 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2815 [InitISOFS, Always, TestOutputInt (
2816 [["wc_w"; "/10klines"]], 10000)],
2817 "count words in a file",
2819 This command counts the words in a file, using the
2820 C<wc -w> external command.");
2822 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2823 [InitISOFS, Always, TestOutputInt (
2824 [["wc_c"; "/100kallspaces"]], 102400)],
2825 "count characters in a file",
2827 This command counts the characters in a file, using the
2828 C<wc -c> external command.");
2830 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2831 [InitISOFS, Always, TestOutputList (
2832 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2833 "return first 10 lines of a file",
2835 This command returns up to the first 10 lines of a file as
2836 a list of strings.");
2838 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2839 [InitISOFS, Always, TestOutputList (
2840 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2841 InitISOFS, Always, TestOutputList (
2842 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2843 InitISOFS, Always, TestOutputList (
2844 [["head_n"; "0"; "/10klines"]], [])],
2845 "return first N lines of a file",
2847 If the parameter C<nrlines> is a positive number, this returns the first
2848 C<nrlines> lines of the file C<path>.
2850 If the parameter C<nrlines> is a negative number, this returns lines
2851 from the file C<path>, excluding the last C<nrlines> lines.
2853 If the parameter C<nrlines> is zero, this returns an empty list.");
2855 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2856 [InitISOFS, Always, TestOutputList (
2857 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2858 "return last 10 lines of a file",
2860 This command returns up to the last 10 lines of a file as
2861 a list of strings.");
2863 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2864 [InitISOFS, Always, TestOutputList (
2865 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2866 InitISOFS, Always, TestOutputList (
2867 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2868 InitISOFS, Always, TestOutputList (
2869 [["tail_n"; "0"; "/10klines"]], [])],
2870 "return last N lines of a file",
2872 If the parameter C<nrlines> is a positive number, this returns the last
2873 C<nrlines> lines of the file C<path>.
2875 If the parameter C<nrlines> is a negative number, this returns lines
2876 from the file C<path>, starting with the C<-nrlines>th line.
2878 If the parameter C<nrlines> is zero, this returns an empty list.");
2880 ("df", (RString "output", []), 125, [],
2881 [], (* XXX Tricky to test because it depends on the exact format
2882 * of the 'df' command and other imponderables.
2884 "report file system disk space usage",
2886 This command runs the C<df> command to report disk space used.
2888 This command is mostly useful for interactive sessions. It
2889 is I<not> intended that you try to parse the output string.
2890 Use C<statvfs> from programs.");
2892 ("df_h", (RString "output", []), 126, [],
2893 [], (* XXX Tricky to test because it depends on the exact format
2894 * of the 'df' command and other imponderables.
2896 "report file system disk space usage (human readable)",
2898 This command runs the C<df -h> command to report disk space used
2899 in human-readable format.
2901 This command is mostly useful for interactive sessions. It
2902 is I<not> intended that you try to parse the output string.
2903 Use C<statvfs> from programs.");
2905 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2906 [InitISOFS, Always, TestOutputInt (
2907 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2908 "estimate file space usage",
2910 This command runs the C<du -s> command to estimate file space
2913 C<path> can be a file or a directory. If C<path> is a directory
2914 then the estimate includes the contents of the directory and all
2915 subdirectories (recursively).
2917 The result is the estimated size in I<kilobytes>
2918 (ie. units of 1024 bytes).");
2920 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2921 [InitISOFS, Always, TestOutputList (
2922 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2923 "list files in an initrd",
2925 This command lists out files contained in an initrd.
2927 The files are listed without any initial C</> character. The
2928 files are listed in the order they appear (not necessarily
2929 alphabetical). Directory names are listed as separate items.
2931 Old Linux kernels (2.4 and earlier) used a compressed ext2
2932 filesystem as initrd. We I<only> support the newer initramfs
2933 format (compressed cpio files).");
2935 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2937 "mount a file using the loop device",
2939 This command lets you mount C<file> (a filesystem image
2940 in a file) on a mount point. It is entirely equivalent to
2941 the command C<mount -o loop file mountpoint>.");
2943 ("mkswap", (RErr, [Device "device"]), 130, [],
2944 [InitEmpty, Always, TestRun (
2945 [["part_disk"; "/dev/sda"; "mbr"];
2946 ["mkswap"; "/dev/sda1"]])],
2947 "create a swap partition",
2949 Create a swap partition on C<device>.");
2951 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2952 [InitEmpty, Always, TestRun (
2953 [["part_disk"; "/dev/sda"; "mbr"];
2954 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2955 "create a swap partition with a label",
2957 Create a swap partition on C<device> with label C<label>.
2959 Note that you cannot attach a swap label to a block device
2960 (eg. C</dev/sda>), just to a partition. This appears to be
2961 a limitation of the kernel or swap tools.");
2963 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2964 (let uuid = uuidgen () in
2965 [InitEmpty, Always, TestRun (
2966 [["part_disk"; "/dev/sda"; "mbr"];
2967 ["mkswap_U"; uuid; "/dev/sda1"]])]),
2968 "create a swap partition with an explicit UUID",
2970 Create a swap partition on C<device> with UUID C<uuid>.");
2972 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2973 [InitBasicFS, Always, TestOutputStruct (
2974 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2975 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2976 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2977 InitBasicFS, Always, TestOutputStruct (
2978 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2979 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2980 "make block, character or FIFO devices",
2982 This call creates block or character special devices, or
2983 named pipes (FIFOs).
2985 The C<mode> parameter should be the mode, using the standard
2986 constants. C<devmajor> and C<devminor> are the
2987 device major and minor numbers, only used when creating block
2988 and character special devices.");
2990 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
2991 [InitBasicFS, Always, TestOutputStruct (
2992 [["mkfifo"; "0o777"; "/node"];
2993 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2994 "make FIFO (named pipe)",
2996 This call creates a FIFO (named pipe) called C<path> with
2997 mode C<mode>. It is just a convenient wrapper around
2998 C<guestfs_mknod>.");
3000 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3001 [InitBasicFS, Always, TestOutputStruct (
3002 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3003 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3004 "make block device node",
3006 This call creates a block device node called C<path> with
3007 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3008 It is just a convenient wrapper around C<guestfs_mknod>.");
3010 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3011 [InitBasicFS, Always, TestOutputStruct (
3012 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3013 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3014 "make char device node",
3016 This call creates a char device node called C<path> with
3017 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3018 It is just a convenient wrapper around C<guestfs_mknod>.");
3020 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3021 [InitEmpty, Always, TestOutputInt (
3022 [["umask"; "0o22"]], 0o22)],
3023 "set file mode creation mask (umask)",
3025 This function sets the mask used for creating new files and
3026 device nodes to C<mask & 0777>.
3028 Typical umask values would be C<022> which creates new files
3029 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3030 C<002> which creates new files with permissions like
3031 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3033 The default umask is C<022>. This is important because it
3034 means that directories and device nodes will be created with
3035 C<0644> or C<0755> mode even if you specify C<0777>.
3037 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3039 This call returns the previous umask.");
3041 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3043 "read directories entries",
3045 This returns the list of directory entries in directory C<dir>.
3047 All entries in the directory are returned, including C<.> and
3048 C<..>. The entries are I<not> sorted, but returned in the same
3049 order as the underlying filesystem.
3051 Also this call returns basic file type information about each
3052 file. The C<ftyp> field will contain one of the following characters:
3090 The L<readdir(3)> returned a C<d_type> field with an
3095 This function is primarily intended for use by programs. To
3096 get a simple list of names, use C<guestfs_ls>. To get a printable
3097 directory for human consumption, use C<guestfs_ll>.");
3099 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3101 "create partitions on a block device",
3103 This is a simplified interface to the C<guestfs_sfdisk>
3104 command, where partition sizes are specified in megabytes
3105 only (rounded to the nearest cylinder) and you don't need
3106 to specify the cyls, heads and sectors parameters which
3107 were rarely if ever used anyway.
3109 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3110 and C<guestfs_part_disk>");
3112 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3114 "determine file type inside a compressed file",
3116 This command runs C<file> after first decompressing C<path>
3119 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3121 Since 1.0.63, use C<guestfs_file> instead which can now
3122 process compressed files.");
3124 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3126 "list extended attributes of a file or directory",
3128 This call lists the extended attributes of the file or directory
3131 At the system call level, this is a combination of the
3132 L<listxattr(2)> and L<getxattr(2)> calls.
3134 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3136 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3138 "list extended attributes of a file or directory",
3140 This is the same as C<guestfs_getxattrs>, but if C<path>
3141 is a symbolic link, then it returns the extended attributes
3142 of the link itself.");
3144 ("setxattr", (RErr, [String "xattr";
3145 String "val"; Int "vallen"; (* will be BufferIn *)
3146 Pathname "path"]), 143, [Optional "linuxxattrs"],
3148 "set extended attribute of a file or directory",
3150 This call sets the extended attribute named C<xattr>
3151 of the file C<path> to the value C<val> (of length C<vallen>).
3152 The value is arbitrary 8 bit data.
3154 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3156 ("lsetxattr", (RErr, [String "xattr";
3157 String "val"; Int "vallen"; (* will be BufferIn *)
3158 Pathname "path"]), 144, [Optional "linuxxattrs"],
3160 "set extended attribute of a file or directory",
3162 This is the same as C<guestfs_setxattr>, but if C<path>
3163 is a symbolic link, then it sets an extended attribute
3164 of the link itself.");
3166 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3168 "remove extended attribute of a file or directory",
3170 This call removes the extended attribute named C<xattr>
3171 of the file C<path>.
3173 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3175 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3177 "remove extended attribute of a file or directory",
3179 This is the same as C<guestfs_removexattr>, but if C<path>
3180 is a symbolic link, then it removes an extended attribute
3181 of the link itself.");
3183 ("mountpoints", (RHashtable "mps", []), 147, [],
3187 This call is similar to C<guestfs_mounts>. That call returns
3188 a list of devices. This one returns a hash table (map) of
3189 device name to directory where the device is mounted.");
3191 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3192 (* This is a special case: while you would expect a parameter
3193 * of type "Pathname", that doesn't work, because it implies
3194 * NEED_ROOT in the generated calling code in stubs.c, and
3195 * this function cannot use NEED_ROOT.
3198 "create a mountpoint",
3200 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3201 specialized calls that can be used to create extra mountpoints
3202 before mounting the first filesystem.
3204 These calls are I<only> necessary in some very limited circumstances,
3205 mainly the case where you want to mount a mix of unrelated and/or
3206 read-only filesystems together.
3208 For example, live CDs often contain a \"Russian doll\" nest of
3209 filesystems, an ISO outer layer, with a squashfs image inside, with
3210 an ext2/3 image inside that. You can unpack this as follows
3213 add-ro Fedora-11-i686-Live.iso
3216 mkmountpoint /squash
3219 mount-loop /cd/LiveOS/squashfs.img /squash
3220 mount-loop /squash/LiveOS/ext3fs.img /ext3
3222 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3224 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3226 "remove a mountpoint",
3228 This calls removes a mountpoint that was previously created
3229 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3230 for full details.");
3232 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3233 [InitISOFS, Always, TestOutputBuffer (
3234 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3237 This calls returns the contents of the file C<path> as a
3240 Unlike C<guestfs_cat>, this function can correctly
3241 handle files that contain embedded ASCII NUL characters.
3242 However unlike C<guestfs_download>, this function is limited
3243 in the total size of file that can be handled.");
3245 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3246 [InitISOFS, Always, TestOutputList (
3247 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3248 InitISOFS, Always, TestOutputList (
3249 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3250 "return lines matching a pattern",
3252 This calls the external C<grep> program and returns the
3255 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3256 [InitISOFS, Always, TestOutputList (
3257 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3258 "return lines matching a pattern",
3260 This calls the external C<egrep> program and returns the
3263 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3264 [InitISOFS, Always, TestOutputList (
3265 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3266 "return lines matching a pattern",
3268 This calls the external C<fgrep> program and returns the
3271 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3272 [InitISOFS, Always, TestOutputList (
3273 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3274 "return lines matching a pattern",
3276 This calls the external C<grep -i> program and returns the
3279 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3280 [InitISOFS, Always, TestOutputList (
3281 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3282 "return lines matching a pattern",
3284 This calls the external C<egrep -i> program and returns the
3287 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3288 [InitISOFS, Always, TestOutputList (
3289 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3290 "return lines matching a pattern",
3292 This calls the external C<fgrep -i> program and returns the
3295 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3296 [InitISOFS, Always, TestOutputList (
3297 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3298 "return lines matching a pattern",
3300 This calls the external C<zgrep> program and returns the
3303 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3304 [InitISOFS, Always, TestOutputList (
3305 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3306 "return lines matching a pattern",
3308 This calls the external C<zegrep> program and returns the
3311 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3312 [InitISOFS, Always, TestOutputList (
3313 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3314 "return lines matching a pattern",
3316 This calls the external C<zfgrep> program and returns the
3319 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3320 [InitISOFS, Always, TestOutputList (
3321 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3322 "return lines matching a pattern",
3324 This calls the external C<zgrep -i> program and returns the
3327 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3328 [InitISOFS, Always, TestOutputList (
3329 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3330 "return lines matching a pattern",
3332 This calls the external C<zegrep -i> program and returns the
3335 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3336 [InitISOFS, Always, TestOutputList (
3337 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3338 "return lines matching a pattern",
3340 This calls the external C<zfgrep -i> program and returns the
3343 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3344 [InitISOFS, Always, TestOutput (
3345 [["realpath"; "/../directory"]], "/directory")],
3346 "canonicalized absolute pathname",
3348 Return the canonicalized absolute pathname of C<path>. The
3349 returned path has no C<.>, C<..> or symbolic link path elements.");
3351 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3352 [InitBasicFS, Always, TestOutputStruct (
3355 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3356 "create a hard link",
3358 This command creates a hard link using the C<ln> command.");
3360 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3361 [InitBasicFS, Always, TestOutputStruct (
3364 ["ln_f"; "/a"; "/b"];
3365 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3366 "create a hard link",
3368 This command creates a hard link using the C<ln -f> command.
3369 The C<-f> option removes the link (C<linkname>) if it exists already.");
3371 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3372 [InitBasicFS, Always, TestOutputStruct (
3374 ["ln_s"; "a"; "/b"];
3375 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3376 "create a symbolic link",
3378 This command creates a symbolic link using the C<ln -s> command.");
3380 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3381 [InitBasicFS, Always, TestOutput (
3382 [["mkdir_p"; "/a/b"];
3383 ["touch"; "/a/b/c"];
3384 ["ln_sf"; "../d"; "/a/b/c"];
3385 ["readlink"; "/a/b/c"]], "../d")],
3386 "create a symbolic link",
3388 This command creates a symbolic link using the C<ln -sf> command,
3389 The C<-f> option removes the link (C<linkname>) if it exists already.");
3391 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3392 [] (* XXX tested above *),
3393 "read the target of a symbolic link",
3395 This command reads the target of a symbolic link.");
3397 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3398 [InitBasicFS, Always, TestOutputStruct (
3399 [["fallocate"; "/a"; "1000000"];
3400 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3401 "preallocate a file in the guest filesystem",
3403 This command preallocates a file (containing zero bytes) named
3404 C<path> of size C<len> bytes. If the file exists already, it
3407 Do not confuse this with the guestfish-specific
3408 C<alloc> command which allocates a file in the host and
3409 attaches it as a device.");
3411 ("swapon_device", (RErr, [Device "device"]), 170, [],
3412 [InitPartition, Always, TestRun (
3413 [["mkswap"; "/dev/sda1"];
3414 ["swapon_device"; "/dev/sda1"];
3415 ["swapoff_device"; "/dev/sda1"]])],
3416 "enable swap on device",
3418 This command enables the libguestfs appliance to use the
3419 swap device or partition named C<device>. The increased
3420 memory is made available for all commands, for example
3421 those run using C<guestfs_command> or C<guestfs_sh>.
3423 Note that you should not swap to existing guest swap
3424 partitions unless you know what you are doing. They may
3425 contain hibernation information, or other information that
3426 the guest doesn't want you to trash. You also risk leaking
3427 information about the host to the guest this way. Instead,
3428 attach a new host device to the guest and swap on that.");
3430 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3431 [], (* XXX tested by swapon_device *)
3432 "disable swap on device",
3434 This command disables the libguestfs appliance swap
3435 device or partition named C<device>.
3436 See C<guestfs_swapon_device>.");
3438 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3439 [InitBasicFS, Always, TestRun (
3440 [["fallocate"; "/swap"; "8388608"];
3441 ["mkswap_file"; "/swap"];
3442 ["swapon_file"; "/swap"];
3443 ["swapoff_file"; "/swap"]])],
3444 "enable swap on file",
3446 This command enables swap to a file.
3447 See C<guestfs_swapon_device> for other notes.");
3449 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3450 [], (* XXX tested by swapon_file *)
3451 "disable swap on file",
3453 This command disables the libguestfs appliance swap on file.");
3455 ("swapon_label", (RErr, [String "label"]), 174, [],
3456 [InitEmpty, Always, TestRun (
3457 [["part_disk"; "/dev/sdb"; "mbr"];
3458 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3459 ["swapon_label"; "swapit"];
3460 ["swapoff_label"; "swapit"];
3461 ["zero"; "/dev/sdb"];
3462 ["blockdev_rereadpt"; "/dev/sdb"]])],
3463 "enable swap on labeled swap partition",
3465 This command enables swap to a labeled swap partition.
3466 See C<guestfs_swapon_device> for other notes.");
3468 ("swapoff_label", (RErr, [String "label"]), 175, [],
3469 [], (* XXX tested by swapon_label *)
3470 "disable swap on labeled swap partition",
3472 This command disables the libguestfs appliance swap on
3473 labeled swap partition.");
3475 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3476 (let uuid = uuidgen () in
3477 [InitEmpty, Always, TestRun (
3478 [["mkswap_U"; uuid; "/dev/sdb"];
3479 ["swapon_uuid"; uuid];
3480 ["swapoff_uuid"; uuid]])]),
3481 "enable swap on swap partition by UUID",
3483 This command enables swap to a swap partition with the given UUID.
3484 See C<guestfs_swapon_device> for other notes.");
3486 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3487 [], (* XXX tested by swapon_uuid *)
3488 "disable swap on swap partition by UUID",
3490 This command disables the libguestfs appliance swap partition
3491 with the given UUID.");
3493 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3494 [InitBasicFS, Always, TestRun (
3495 [["fallocate"; "/swap"; "8388608"];
3496 ["mkswap_file"; "/swap"]])],
3497 "create a swap file",
3501 This command just writes a swap file signature to an existing
3502 file. To create the file itself, use something like C<guestfs_fallocate>.");
3504 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3505 [InitISOFS, Always, TestRun (
3506 [["inotify_init"; "0"]])],
3507 "create an inotify handle",
3509 This command creates a new inotify handle.
3510 The inotify subsystem can be used to notify events which happen to
3511 objects in the guest filesystem.
3513 C<maxevents> is the maximum number of events which will be
3514 queued up between calls to C<guestfs_inotify_read> or
3515 C<guestfs_inotify_files>.
3516 If this is passed as C<0>, then the kernel (or previously set)
3517 default is used. For Linux 2.6.29 the default was 16384 events.
3518 Beyond this limit, the kernel throws away events, but records
3519 the fact that it threw them away by setting a flag
3520 C<IN_Q_OVERFLOW> in the returned structure list (see
3521 C<guestfs_inotify_read>).
3523 Before any events are generated, you have to add some
3524 watches to the internal watch list. See:
3525 C<guestfs_inotify_add_watch>,
3526 C<guestfs_inotify_rm_watch> and
3527 C<guestfs_inotify_watch_all>.
3529 Queued up events should be read periodically by calling
3530 C<guestfs_inotify_read>
3531 (or C<guestfs_inotify_files> which is just a helpful
3532 wrapper around C<guestfs_inotify_read>). If you don't
3533 read the events out often enough then you risk the internal
3536 The handle should be closed after use by calling
3537 C<guestfs_inotify_close>. This also removes any
3538 watches automatically.
3540 See also L<inotify(7)> for an overview of the inotify interface
3541 as exposed by the Linux kernel, which is roughly what we expose
3542 via libguestfs. Note that there is one global inotify handle
3543 per libguestfs instance.");
3545 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3546 [InitBasicFS, Always, TestOutputList (
3547 [["inotify_init"; "0"];
3548 ["inotify_add_watch"; "/"; "1073741823"];
3551 ["inotify_files"]], ["a"; "b"])],
3552 "add an inotify watch",
3554 Watch C<path> for the events listed in C<mask>.
3556 Note that if C<path> is a directory then events within that
3557 directory are watched, but this does I<not> happen recursively
3558 (in subdirectories).
3560 Note for non-C or non-Linux callers: the inotify events are
3561 defined by the Linux kernel ABI and are listed in
3562 C</usr/include/sys/inotify.h>.");
3564 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3566 "remove an inotify watch",
3568 Remove a previously defined inotify watch.
3569 See C<guestfs_inotify_add_watch>.");
3571 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3573 "return list of inotify events",
3575 Return the complete queue of events that have happened
3576 since the previous read call.
3578 If no events have happened, this returns an empty list.
3580 I<Note>: In order to make sure that all events have been
3581 read, you must call this function repeatedly until it
3582 returns an empty list. The reason is that the call will
3583 read events up to the maximum appliance-to-host message
3584 size and leave remaining events in the queue.");
3586 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3588 "return list of watched files that had events",
3590 This function is a helpful wrapper around C<guestfs_inotify_read>
3591 which just returns a list of pathnames of objects that were
3592 touched. The returned pathnames are sorted and deduplicated.");
3594 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3596 "close the inotify handle",
3598 This closes the inotify handle which was previously
3599 opened by inotify_init. It removes all watches, throws
3600 away any pending events, and deallocates all resources.");
3602 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3604 "set SELinux security context",
3606 This sets the SELinux security context of the daemon
3607 to the string C<context>.
3609 See the documentation about SELINUX in L<guestfs(3)>.");
3611 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3613 "get SELinux security context",
3615 This gets the SELinux security context of the daemon.
3617 See the documentation about SELINUX in L<guestfs(3)>,
3618 and C<guestfs_setcon>");
3620 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3621 [InitEmpty, Always, TestOutput (
3622 [["part_disk"; "/dev/sda"; "mbr"];
3623 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3624 ["mount_options"; ""; "/dev/sda1"; "/"];
3625 ["write_file"; "/new"; "new file contents"; "0"];
3626 ["cat"; "/new"]], "new file contents")],
3627 "make a filesystem with block size",
3629 This call is similar to C<guestfs_mkfs>, but it allows you to
3630 control the block size of the resulting filesystem. Supported
3631 block sizes depend on the filesystem type, but typically they
3632 are C<1024>, C<2048> or C<4096> only.");
3634 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3635 [InitEmpty, Always, TestOutput (
3636 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3637 ["mke2journal"; "4096"; "/dev/sda1"];
3638 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3639 ["mount_options"; ""; "/dev/sda2"; "/"];
3640 ["write_file"; "/new"; "new file contents"; "0"];
3641 ["cat"; "/new"]], "new file contents")],
3642 "make ext2/3/4 external journal",
3644 This creates an ext2 external journal on C<device>. It is equivalent
3647 mke2fs -O journal_dev -b blocksize device");
3649 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3650 [InitEmpty, Always, TestOutput (
3651 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3652 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3653 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3654 ["mount_options"; ""; "/dev/sda2"; "/"];
3655 ["write_file"; "/new"; "new file contents"; "0"];
3656 ["cat"; "/new"]], "new file contents")],
3657 "make ext2/3/4 external journal with label",
3659 This creates an ext2 external journal on C<device> with label C<label>.");
3661 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3662 (let uuid = uuidgen () in
3663 [InitEmpty, Always, TestOutput (
3664 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3665 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3666 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3667 ["mount_options"; ""; "/dev/sda2"; "/"];
3668 ["write_file"; "/new"; "new file contents"; "0"];
3669 ["cat"; "/new"]], "new file contents")]),
3670 "make ext2/3/4 external journal with UUID",
3672 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3674 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3676 "make ext2/3/4 filesystem with external journal",
3678 This creates an ext2/3/4 filesystem on C<device> with
3679 an external journal on C<journal>. It is equivalent
3682 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3684 See also C<guestfs_mke2journal>.");
3686 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3688 "make ext2/3/4 filesystem with external journal",
3690 This creates an ext2/3/4 filesystem on C<device> with
3691 an external journal on the journal labeled C<label>.
3693 See also C<guestfs_mke2journal_L>.");
3695 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3697 "make ext2/3/4 filesystem with external journal",
3699 This creates an ext2/3/4 filesystem on C<device> with
3700 an external journal on the journal with UUID C<uuid>.
3702 See also C<guestfs_mke2journal_U>.");
3704 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3705 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3706 "load a kernel module",
3708 This loads a kernel module in the appliance.
3710 The kernel module must have been whitelisted when libguestfs
3711 was built (see C<appliance/kmod.whitelist.in> in the source).");
3713 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3714 [InitNone, Always, TestOutput (
3715 [["echo_daemon"; "This is a test"]], "This is a test"
3717 "echo arguments back to the client",
3719 This command concatenate the list of C<words> passed with single spaces between
3720 them and returns the resulting string.
3722 You can use this command to test the connection through to the daemon.
3724 See also C<guestfs_ping_daemon>.");
3726 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3727 [], (* There is a regression test for this. *)
3728 "find all files and directories, returning NUL-separated list",
3730 This command lists out all files and directories, recursively,
3731 starting at C<directory>, placing the resulting list in the
3732 external file called C<files>.
3734 This command works the same way as C<guestfs_find> with the
3735 following exceptions:
3741 The resulting list is written to an external file.
3745 Items (filenames) in the result are separated
3746 by C<\\0> characters. See L<find(1)> option I<-print0>.
3750 This command is not limited in the number of names that it
3755 The result list is not sorted.
3759 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3760 [InitISOFS, Always, TestOutput (
3761 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3762 InitISOFS, Always, TestOutput (
3763 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3764 InitISOFS, Always, TestOutput (
3765 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3766 InitISOFS, Always, TestLastFail (
3767 [["case_sensitive_path"; "/Known-1/"]]);
3768 InitBasicFS, Always, TestOutput (
3770 ["mkdir"; "/a/bbb"];
3771 ["touch"; "/a/bbb/c"];
3772 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3773 InitBasicFS, Always, TestOutput (
3775 ["mkdir"; "/a/bbb"];
3776 ["touch"; "/a/bbb/c"];
3777 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3778 InitBasicFS, Always, TestLastFail (
3780 ["mkdir"; "/a/bbb"];
3781 ["touch"; "/a/bbb/c"];
3782 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3783 "return true path on case-insensitive filesystem",
3785 This can be used to resolve case insensitive paths on
3786 a filesystem which is case sensitive. The use case is
3787 to resolve paths which you have read from Windows configuration
3788 files or the Windows Registry, to the true path.
3790 The command handles a peculiarity of the Linux ntfs-3g
3791 filesystem driver (and probably others), which is that although
3792 the underlying filesystem is case-insensitive, the driver
3793 exports the filesystem to Linux as case-sensitive.
3795 One consequence of this is that special directories such
3796 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3797 (or other things) depending on the precise details of how
3798 they were created. In Windows itself this would not be
3801 Bug or feature? You decide:
3802 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3804 This function resolves the true case of each element in the
3805 path and returns the case-sensitive path.
3807 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3808 might return C<\"/WINDOWS/system32\"> (the exact return value
3809 would depend on details of how the directories were originally
3810 created under Windows).
3813 This function does not handle drive names, backslashes etc.
3815 See also C<guestfs_realpath>.");
3817 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3818 [InitBasicFS, Always, TestOutput (
3819 [["vfs_type"; "/dev/sda1"]], "ext2")],
3820 "get the Linux VFS type corresponding to a mounted device",
3822 This command gets the block device type corresponding to
3823 a mounted device called C<device>.
3825 Usually the result is the name of the Linux VFS module that
3826 is used to mount this device (probably determined automatically
3827 if you used the C<guestfs_mount> call).");
3829 ("truncate", (RErr, [Pathname "path"]), 199, [],
3830 [InitBasicFS, Always, TestOutputStruct (
3831 [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3832 ["truncate"; "/test"];
3833 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3834 "truncate a file to zero size",
3836 This command truncates C<path> to a zero-length file. The
3837 file must exist already.");
3839 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3840 [InitBasicFS, Always, TestOutputStruct (
3841 [["touch"; "/test"];
3842 ["truncate_size"; "/test"; "1000"];
3843 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3844 "truncate a file to a particular size",
3846 This command truncates C<path> to size C<size> bytes. The file
3847 must exist already. If the file is smaller than C<size> then
3848 the file is extended to the required size with null bytes.");
3850 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3851 [InitBasicFS, Always, TestOutputStruct (
3852 [["touch"; "/test"];
3853 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3854 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3855 "set timestamp of a file with nanosecond precision",
3857 This command sets the timestamps of a file with nanosecond
3860 C<atsecs, atnsecs> are the last access time (atime) in secs and
3861 nanoseconds from the epoch.
3863 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3864 secs and nanoseconds from the epoch.
3866 If the C<*nsecs> field contains the special value C<-1> then
3867 the corresponding timestamp is set to the current time. (The
3868 C<*secs> field is ignored in this case).
3870 If the C<*nsecs> field contains the special value C<-2> then
3871 the corresponding timestamp is left unchanged. (The
3872 C<*secs> field is ignored in this case).");
3874 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3875 [InitBasicFS, Always, TestOutputStruct (
3876 [["mkdir_mode"; "/test"; "0o111"];
3877 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3878 "create a directory with a particular mode",
3880 This command creates a directory, setting the initial permissions
3881 of the directory to C<mode>. See also C<guestfs_mkdir>.");
3883 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3885 "change file owner and group",
3887 Change the file owner to C<owner> and group to C<group>.
3888 This is like C<guestfs_chown> but if C<path> is a symlink then
3889 the link itself is changed, not the target.
3891 Only numeric uid and gid are supported. If you want to use
3892 names, you will need to locate and parse the password file
3893 yourself (Augeas support makes this relatively easy).");
3895 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3897 "lstat on multiple files",
3899 This call allows you to perform the C<guestfs_lstat> operation
3900 on multiple files, where all files are in the directory C<path>.
3901 C<names> is the list of files from this directory.
3903 On return you get a list of stat structs, with a one-to-one
3904 correspondence to the C<names> list. If any name did not exist
3905 or could not be lstat'd, then the C<ino> field of that structure
3908 This call is intended for programs that want to efficiently
3909 list a directory contents without making many round-trips.
3910 See also C<guestfs_lxattrlist> for a similarly efficient call
3911 for getting extended attributes. Very long directory listings
3912 might cause the protocol message size to be exceeded, causing
3913 this call to fail. The caller must split up such requests
3914 into smaller groups of names.");
3916 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3918 "lgetxattr on multiple files",
3920 This call allows you to get the extended attributes
3921 of multiple files, where all files are in the directory C<path>.
3922 C<names> is the list of files from this directory.
3924 On return you get a flat list of xattr structs which must be
3925 interpreted sequentially. The first xattr struct always has a zero-length
3926 C<attrname>. C<attrval> in this struct is zero-length
3927 to indicate there was an error doing C<lgetxattr> for this
3928 file, I<or> is a C string which is a decimal number
3929 (the number of following attributes for this file, which could
3930 be C<\"0\">). Then after the first xattr struct are the
3931 zero or more attributes for the first named file.
3932 This repeats for the second and subsequent files.
3934 This call is intended for programs that want to efficiently
3935 list a directory contents without making many round-trips.
3936 See also C<guestfs_lstatlist> for a similarly efficient call
3937 for getting standard stats. Very long directory listings
3938 might cause the protocol message size to be exceeded, causing
3939 this call to fail. The caller must split up such requests
3940 into smaller groups of names.");
3942 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3944 "readlink on multiple files",
3946 This call allows you to do a C<readlink> operation
3947 on multiple files, where all files are in the directory C<path>.
3948 C<names> is the list of files from this directory.
3950 On return you get a list of strings, with a one-to-one
3951 correspondence to the C<names> list. Each string is the
3952 value of the symbol link.
3954 If the C<readlink(2)> operation fails on any name, then
3955 the corresponding result string is the empty string C<\"\">.
3956 However the whole operation is completed even if there
3957 were C<readlink(2)> errors, and so you can call this
3958 function with names where you don't know if they are
3959 symbolic links already (albeit slightly less efficient).
3961 This call is intended for programs that want to efficiently
3962 list a directory contents without making many round-trips.
3963 Very long directory listings might cause the protocol
3964 message size to be exceeded, causing
3965 this call to fail. The caller must split up such requests
3966 into smaller groups of names.");
3968 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3969 [InitISOFS, Always, TestOutputBuffer (
3970 [["pread"; "/known-4"; "1"; "3"]], "\n");
3971 InitISOFS, Always, TestOutputBuffer (
3972 [["pread"; "/empty"; "0"; "100"]], "")],
3973 "read part of a file",
3975 This command lets you read part of a file. It reads C<count>
3976 bytes of the file, starting at C<offset>, from file C<path>.
3978 This may read fewer bytes than requested. For further details
3979 see the L<pread(2)> system call.");
3981 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3982 [InitEmpty, Always, TestRun (
3983 [["part_init"; "/dev/sda"; "gpt"]])],
3984 "create an empty partition table",
3986 This creates an empty partition table on C<device> of one of the
3987 partition types listed below. Usually C<parttype> should be
3988 either C<msdos> or C<gpt> (for large disks).
3990 Initially there are no partitions. Following this, you should
3991 call C<guestfs_part_add> for each partition required.
3993 Possible values for C<parttype> are:
3997 =item B<efi> | B<gpt>
3999 Intel EFI / GPT partition table.
4001 This is recommended for >= 2 TB partitions that will be accessed
4002 from Linux and Intel-based Mac OS X. It also has limited backwards
4003 compatibility with the C<mbr> format.
4005 =item B<mbr> | B<msdos>
4007 The standard PC \"Master Boot Record\" (MBR) format used
4008 by MS-DOS and Windows. This partition type will B<only> work
4009 for device sizes up to 2 TB. For large disks we recommend
4014 Other partition table types that may work but are not
4023 =item B<amiga> | B<rdb>
4025 Amiga \"Rigid Disk Block\" format.
4033 DASD, used on IBM mainframes.
4041 Old Mac partition format. Modern Macs use C<gpt>.
4045 NEC PC-98 format, common in Japan apparently.
4053 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4054 [InitEmpty, Always, TestRun (
4055 [["part_init"; "/dev/sda"; "mbr"];
4056 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4057 InitEmpty, Always, TestRun (
4058 [["part_init"; "/dev/sda"; "gpt"];
4059 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4060 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4061 InitEmpty, Always, TestRun (
4062 [["part_init"; "/dev/sda"; "mbr"];
4063 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4064 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4065 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4066 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4067 "add a partition to the device",
4069 This command adds a partition to C<device>. If there is no partition
4070 table on the device, call C<guestfs_part_init> first.
4072 The C<prlogex> parameter is the type of partition. Normally you
4073 should pass C<p> or C<primary> here, but MBR partition tables also
4074 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4077 C<startsect> and C<endsect> are the start and end of the partition
4078 in I<sectors>. C<endsect> may be negative, which means it counts
4079 backwards from the end of the disk (C<-1> is the last sector).
4081 Creating a partition which covers the whole disk is not so easy.
4082 Use C<guestfs_part_disk> to do that.");
4084 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4085 [InitEmpty, Always, TestRun (
4086 [["part_disk"; "/dev/sda"; "mbr"]]);
4087 InitEmpty, Always, TestRun (
4088 [["part_disk"; "/dev/sda"; "gpt"]])],
4089 "partition whole disk with a single primary partition",
4091 This command is simply a combination of C<guestfs_part_init>
4092 followed by C<guestfs_part_add> to create a single primary partition
4093 covering the whole disk.
4095 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4096 but other possible values are described in C<guestfs_part_init>.");
4098 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4099 [InitEmpty, Always, TestRun (
4100 [["part_disk"; "/dev/sda"; "mbr"];
4101 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4102 "make a partition bootable",
4104 This sets the bootable flag on partition numbered C<partnum> on
4105 device C<device>. Note that partitions are numbered from 1.
4107 The bootable flag is used by some operating systems (notably
4108 Windows) to determine which partition to boot from. It is by
4109 no means universally recognized.");
4111 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4112 [InitEmpty, Always, TestRun (
4113 [["part_disk"; "/dev/sda"; "gpt"];
4114 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4115 "set partition name",
4117 This sets the partition name on partition numbered C<partnum> on
4118 device C<device>. Note that partitions are numbered from 1.
4120 The partition name can only be set on certain types of partition
4121 table. This works on C<gpt> but not on C<mbr> partitions.");
4123 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4124 [], (* XXX Add a regression test for this. *)
4125 "list partitions on a device",
4127 This command parses the partition table on C<device> and
4128 returns the list of partitions found.
4130 The fields in the returned structure are:
4136 Partition number, counting from 1.
4140 Start of the partition I<in bytes>. To get sectors you have to
4141 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4145 End of the partition in bytes.
4149 Size of the partition in bytes.
4153 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4154 [InitEmpty, Always, TestOutput (
4155 [["part_disk"; "/dev/sda"; "gpt"];
4156 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4157 "get the partition table type",
4159 This command examines the partition table on C<device> and
4160 returns the partition table type (format) being used.
4162 Common return values include: C<msdos> (a DOS/Windows style MBR
4163 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4164 values are possible, although unusual. See C<guestfs_part_init>
4167 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4168 [InitBasicFS, Always, TestOutputBuffer (
4169 [["fill"; "0x63"; "10"; "/test"];
4170 ["read_file"; "/test"]], "cccccccccc")],
4171 "fill a file with octets",
4173 This command creates a new file called C<path>. The initial
4174 content of the file is C<len> octets of C<c>, where C<c>
4175 must be a number in the range C<[0..255]>.
4177 To fill a file with zero bytes (sparsely), it is
4178 much more efficient to use C<guestfs_truncate_size>.");
4180 ("available", (RErr, [StringList "groups"]), 216, [],
4181 [InitNone, Always, TestRun [["available"; ""]]],
4182 "test availability of some parts of the API",
4184 This command is used to check the availability of some
4185 groups of functionality in the appliance, which not all builds of
4186 the libguestfs appliance will be able to provide.
4188 The libguestfs groups, and the functions that those
4189 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4191 The argument C<groups> is a list of group names, eg:
4192 C<[\"inotify\", \"augeas\"]> would check for the availability of
4193 the Linux inotify functions and Augeas (configuration file
4196 The command returns no error if I<all> requested groups are available.
4198 It fails with an error if one or more of the requested
4199 groups is unavailable in the appliance.
4201 If an unknown group name is included in the
4202 list of groups then an error is always returned.
4210 You must call C<guestfs_launch> before calling this function.
4212 The reason is because we don't know what groups are
4213 supported by the appliance/daemon until it is running and can
4218 If a group of functions is available, this does not necessarily
4219 mean that they will work. You still have to check for errors
4220 when calling individual API functions even if they are
4225 It is usually the job of distro packagers to build
4226 complete functionality into the libguestfs appliance.
4227 Upstream libguestfs, if built from source with all
4228 requirements satisfied, will support everything.
4232 This call was added in version C<1.0.80>. In previous
4233 versions of libguestfs all you could do would be to speculatively
4234 execute a command to find out if the daemon implemented it.
4235 See also C<guestfs_version>.
4239 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4240 [InitBasicFS, Always, TestOutputBuffer (
4241 [["write_file"; "/src"; "hello, world"; "0"];
4242 ["dd"; "/src"; "/dest"];
4243 ["read_file"; "/dest"]], "hello, world")],
4244 "copy from source to destination using dd",
4246 This command copies from one source device or file C<src>
4247 to another destination device or file C<dest>. Normally you
4248 would use this to copy to or from a device or partition, for
4249 example to duplicate a filesystem.
4251 If the destination is a device, it must be as large or larger
4252 than the source file or device, otherwise the copy will fail.
4253 This command cannot do partial copies (see C<guestfs_copy_size>).");
4255 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4256 [InitBasicFS, Always, TestOutputInt (
4257 [["write_file"; "/file"; "hello, world"; "0"];
4258 ["filesize"; "/file"]], 12)],
4259 "return the size of the file in bytes",
4261 This command returns the size of C<file> in bytes.
4263 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4264 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4265 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4267 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4268 [InitBasicFSonLVM, Always, TestOutputList (
4269 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4270 ["lvs"]], ["/dev/VG/LV2"])],
4271 "rename an LVM logical volume",
4273 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4275 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4276 [InitBasicFSonLVM, Always, TestOutputList (
4278 ["vg_activate"; "false"; "VG"];
4279 ["vgrename"; "VG"; "VG2"];
4280 ["vg_activate"; "true"; "VG2"];
4281 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4282 ["vgs"]], ["VG2"])],
4283 "rename an LVM volume group",
4285 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4287 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4288 [InitISOFS, Always, TestOutputBuffer (
4289 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4290 "list the contents of a single file in an initrd",
4292 This command unpacks the file C<filename> from the initrd file
4293 called C<initrdpath>. The filename must be given I<without> the
4294 initial C</> character.
4296 For example, in guestfish you could use the following command
4297 to examine the boot script (usually called C</init>)
4298 contained in a Linux initrd or initramfs image:
4300 initrd-cat /boot/initrd-<version>.img init
4302 See also C<guestfs_initrd_list>.");
4304 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4306 "get the UUID of a physical volume",
4308 This command returns the UUID of the LVM PV C<device>.");
4310 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4312 "get the UUID of a volume group",
4314 This command returns the UUID of the LVM VG named C<vgname>.");
4316 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4318 "get the UUID of a logical volume",
4320 This command returns the UUID of the LVM LV C<device>.");
4322 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4324 "get the PV UUIDs containing the volume group",
4326 Given a VG called C<vgname>, this returns the UUIDs of all
4327 the physical volumes that this volume group resides on.
4329 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4330 calls to associate physical volumes and volume groups.
4332 See also C<guestfs_vglvuuids>.");
4334 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4336 "get the LV UUIDs of all LVs in the volume group",
4338 Given a VG called C<vgname>, this returns the UUIDs of all
4339 the logical volumes created in this volume group.
4341 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4342 calls to associate logical volumes and volume groups.
4344 See also C<guestfs_vgpvuuids>.");
4346 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4347 [InitBasicFS, Always, TestOutputBuffer (
4348 [["write_file"; "/src"; "hello, world"; "0"];
4349 ["copy_size"; "/src"; "/dest"; "5"];
4350 ["read_file"; "/dest"]], "hello")],
4351 "copy size bytes from source to destination using dd",
4353 This command copies exactly C<size> bytes from one source device
4354 or file C<src> to another destination device or file C<dest>.
4356 Note this will fail if the source is too short or if the destination
4357 is not large enough.");
4359 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4360 [InitBasicFSonLVM, Always, TestRun (
4361 [["zero_device"; "/dev/VG/LV"]])],
4362 "write zeroes to an entire device",
4364 This command writes zeroes over the entire C<device>. Compare
4365 with C<guestfs_zero> which just zeroes the first few blocks of
4368 ("txz_in", (RErr, [FileIn "tarball"; String "directory"]), 229, [],
4369 [InitBasicFS, Always, TestOutput (
4370 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4371 ["cat"; "/hello"]], "hello\n")],
4372 "unpack compressed tarball to directory",
4374 This command uploads and unpacks local file C<tarball> (an
4375 I<xz compressed> tar file) into C<directory>.");
4377 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [],
4379 "pack directory into compressed tarball",
4381 This command packs the contents of C<directory> and downloads
4382 it to local file C<tarball> (as an xz compressed tar archive).");
4384 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4386 "resize an NTFS filesystem",
4388 This command resizes an NTFS filesystem, expanding or
4389 shrinking it to the size of the underlying device.
4390 See also L<ntfsresize(8)>.");
4392 ("vgscan", (RErr, []), 232, [],
4393 [InitEmpty, Always, TestRun (
4395 "rescan for LVM physical volumes, volume groups and logical volumes",
4397 This rescans all block devices and rebuilds the list of LVM
4398 physical volumes, volume groups and logical volumes.");
4400 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4401 [InitEmpty, Always, TestRun (
4402 [["part_init"; "/dev/sda"; "mbr"];
4403 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4404 ["part_del"; "/dev/sda"; "1"]])],
4405 "delete a partition",
4407 This command deletes the partition numbered C<partnum> on C<device>.
4409 Note that in the case of MBR partitioning, deleting an
4410 extended partition also deletes any logical partitions
4413 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4414 [InitEmpty, Always, TestOutputTrue (
4415 [["part_init"; "/dev/sda"; "mbr"];
4416 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4417 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4418 ["part_get_bootable"; "/dev/sda"; "1"]])],
4419 "return true if a partition is bootable",
4421 This command returns true if the partition C<partnum> on
4422 C<device> has the bootable flag set.
4424 See also C<guestfs_part_set_bootable>.");
4426 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4427 [InitEmpty, Always, TestOutputInt (
4428 [["part_init"; "/dev/sda"; "mbr"];
4429 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4430 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4431 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4432 "get the MBR type byte (ID byte) from a partition",
4434 Returns the MBR type byte (also known as the ID byte) from
4435 the numbered partition C<partnum>.
4437 Note that only MBR (old DOS-style) partitions have type bytes.
4438 You will get undefined results for other partition table
4439 types (see C<guestfs_part_get_parttype>).");
4441 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4442 [], (* tested by part_get_mbr_id *)
4443 "set the MBR type byte (ID byte) of a partition",
4445 Sets the MBR type byte (also known as the ID byte) of
4446 the numbered partition C<partnum> to C<idbyte>. Note
4447 that the type bytes quoted in most documentation are
4448 in fact hexadecimal numbers, but usually documented
4449 without any leading \"0x\" which might be confusing.
4451 Note that only MBR (old DOS-style) partitions have type bytes.
4452 You will get undefined results for other partition table
4453 types (see C<guestfs_part_get_parttype>).");
4455 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4456 [InitISOFS, Always, TestOutput (
4457 [["checksum_device"; "md5"; "/dev/sdd"]],
4458 (Digest.to_hex (Digest.file "images/test.iso")))],
4459 "compute MD5, SHAx or CRC checksum of the contents of a device",
4461 This call computes the MD5, SHAx or CRC checksum of the
4462 contents of the device named C<device>. For the types of
4463 checksums supported see the C<guestfs_checksum> command.");
4465 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4466 [InitNone, Always, TestRun (
4467 [["part_disk"; "/dev/sda"; "mbr"];
4468 ["pvcreate"; "/dev/sda1"];
4469 ["vgcreate"; "VG"; "/dev/sda1"];
4470 ["lvcreate"; "LV"; "VG"; "10"];
4471 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4472 "expand an LV to fill free space",
4474 This expands an existing logical volume C<lv> so that it fills
4475 C<pc>% of the remaining free space in the volume group. Commonly
4476 you would call this with pc = 100 which expands the logical volume
4477 as much as possible, using all remaining free space in the volume
4480 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4481 [], (* XXX Augeas code needs tests. *)
4482 "clear Augeas path",
4484 Set the value associated with C<path> to C<NULL>. This
4485 is the same as the L<augtool(1)> C<clear> command.");
4489 let all_functions = non_daemon_functions @ daemon_functions
4491 (* In some places we want the functions to be displayed sorted
4492 * alphabetically, so this is useful:
4494 let all_functions_sorted =
4495 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4496 compare n1 n2) all_functions
4498 (* Field types for structures. *)
4500 | FChar (* C 'char' (really, a 7 bit byte). *)
4501 | FString (* nul-terminated ASCII string, NOT NULL. *)
4502 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4507 | FBytes (* Any int measure that counts bytes. *)
4508 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4509 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4511 (* Because we generate extra parsing code for LVM command line tools,
4512 * we have to pull out the LVM columns separately here.
4522 "pv_attr", FString (* XXX *);
4523 "pv_pe_count", FInt64;
4524 "pv_pe_alloc_count", FInt64;
4527 "pv_mda_count", FInt64;
4528 "pv_mda_free", FBytes;
4529 (* Not in Fedora 10:
4530 "pv_mda_size", FBytes;
4537 "vg_attr", FString (* XXX *);
4540 "vg_sysid", FString;
4541 "vg_extent_size", FBytes;
4542 "vg_extent_count", FInt64;
4543 "vg_free_count", FInt64;
4548 "snap_count", FInt64;
4551 "vg_mda_count", FInt64;
4552 "vg_mda_free", FBytes;
4553 (* Not in Fedora 10:
4554 "vg_mda_size", FBytes;
4560 "lv_attr", FString (* XXX *);
4563 "lv_kernel_major", FInt64;
4564 "lv_kernel_minor", FInt64;
4566 "seg_count", FInt64;
4568 "snap_percent", FOptPercent;
4569 "copy_percent", FOptPercent;
4572 "mirror_log", FString;
4576 (* Names and fields in all structures (in RStruct and RStructList)
4580 (* The old RIntBool return type, only ever used for aug_defnode. Do
4581 * not use this struct in any new code.
4584 "i", FInt32; (* for historical compatibility *)
4585 "b", FInt32; (* for historical compatibility *)
4588 (* LVM PVs, VGs, LVs. *)
4589 "lvm_pv", lvm_pv_cols;
4590 "lvm_vg", lvm_vg_cols;
4591 "lvm_lv", lvm_lv_cols;
4593 (* Column names and types from stat structures.
4594 * NB. Can't use things like 'st_atime' because glibc header files
4595 * define some of these as macros. Ugh.
4626 (* Column names in dirent structure. *)
4629 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4634 (* Version numbers. *)
4642 (* Extended attribute. *)
4644 "attrname", FString;
4648 (* Inotify events. *)
4652 "in_cookie", FUInt32;
4656 (* Partition table entry. *)
4659 "part_start", FBytes;
4661 "part_size", FBytes;
4663 ] (* end of structs *)
4665 (* Ugh, Java has to be different ..
4666 * These names are also used by the Haskell bindings.
4668 let java_structs = [
4669 "int_bool", "IntBool";
4674 "statvfs", "StatVFS";
4676 "version", "Version";
4678 "inotify_event", "INotifyEvent";
4679 "partition", "Partition";
4682 (* What structs are actually returned. *)
4683 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4685 (* Returns a list of RStruct/RStructList structs that are returned
4686 * by any function. Each element of returned list is a pair:
4688 * (structname, RStructOnly)
4689 * == there exists function which returns RStruct (_, structname)
4690 * (structname, RStructListOnly)
4691 * == there exists function which returns RStructList (_, structname)
4692 * (structname, RStructAndList)
4693 * == there are functions returning both RStruct (_, structname)
4694 * and RStructList (_, structname)
4696 let rstructs_used_by functions =
4697 (* ||| is a "logical OR" for rstructs_used_t *)
4701 | _, RStructAndList -> RStructAndList
4702 | RStructOnly, RStructListOnly
4703 | RStructListOnly, RStructOnly -> RStructAndList
4704 | RStructOnly, RStructOnly -> RStructOnly
4705 | RStructListOnly, RStructListOnly -> RStructListOnly
4708 let h = Hashtbl.create 13 in
4710 (* if elem->oldv exists, update entry using ||| operator,
4711 * else just add elem->newv to the hash
4713 let update elem newv =
4714 try let oldv = Hashtbl.find h elem in
4715 Hashtbl.replace h elem (newv ||| oldv)
4716 with Not_found -> Hashtbl.add h elem newv
4720 fun (_, style, _, _, _, _, _) ->
4721 match fst style with
4722 | RStruct (_, structname) -> update structname RStructOnly
4723 | RStructList (_, structname) -> update structname RStructListOnly
4727 (* return key->values as a list of (key,value) *)
4728 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4730 (* Used for testing language bindings. *)
4732 | CallString of string
4733 | CallOptString of string option
4734 | CallStringList of string list
4736 | CallInt64 of int64
4739 (* Used to memoize the result of pod2text. *)
4740 let pod2text_memo_filename = "src/.pod2text.data"
4741 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4743 let chan = open_in pod2text_memo_filename in
4744 let v = input_value chan in
4748 _ -> Hashtbl.create 13
4749 let pod2text_memo_updated () =
4750 let chan = open_out pod2text_memo_filename in
4751 output_value chan pod2text_memo;
4754 (* Useful functions.
4755 * Note we don't want to use any external OCaml libraries which
4756 * makes this a bit harder than it should be.
4758 module StringMap = Map.Make (String)
4760 let failwithf fs = ksprintf failwith fs
4762 let unique = let i = ref 0 in fun () -> incr i; !i
4764 let replace_char s c1 c2 =
4765 let s2 = String.copy s in
4766 let r = ref false in
4767 for i = 0 to String.length s2 - 1 do
4768 if String.unsafe_get s2 i = c1 then (
4769 String.unsafe_set s2 i c2;
4773 if not !r then s else s2
4777 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4779 let triml ?(test = isspace) str =
4781 let n = ref (String.length str) in
4782 while !n > 0 && test str.[!i]; do
4787 else String.sub str !i !n
4789 let trimr ?(test = isspace) str =
4790 let n = ref (String.length str) in
4791 while !n > 0 && test str.[!n-1]; do
4794 if !n = String.length str then str
4795 else String.sub str 0 !n
4797 let trim ?(test = isspace) str =
4798 trimr ~test (triml ~test str)
4800 let rec find s sub =
4801 let len = String.length s in
4802 let sublen = String.length sub in
4804 if i <= len-sublen then (
4806 if j < sublen then (
4807 if s.[i+j] = sub.[j] then loop2 (j+1)
4813 if r = -1 then loop (i+1) else r
4819 let rec replace_str s s1 s2 =
4820 let len = String.length s in
4821 let sublen = String.length s1 in
4822 let i = find s s1 in
4825 let s' = String.sub s 0 i in
4826 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4827 s' ^ s2 ^ replace_str s'' s1 s2
4830 let rec string_split sep str =
4831 let len = String.length str in
4832 let seplen = String.length sep in
4833 let i = find str sep in
4834 if i = -1 then [str]
4836 let s' = String.sub str 0 i in
4837 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4838 s' :: string_split sep s''
4841 let files_equal n1 n2 =
4842 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4843 match Sys.command cmd with
4846 | i -> failwithf "%s: failed with error code %d" cmd i
4848 let rec filter_map f = function
4852 | Some y -> y :: filter_map f xs
4853 | None -> filter_map f xs
4855 let rec find_map f = function
4856 | [] -> raise Not_found
4860 | None -> find_map f xs
4863 let rec loop i = function
4865 | x :: xs -> f i x; loop (i+1) xs
4870 let rec loop i = function
4872 | x :: xs -> let r = f i x in r :: loop (i+1) xs
4876 let count_chars c str =
4877 let count = ref 0 in
4878 for i = 0 to String.length str - 1 do
4879 if c = String.unsafe_get str i then incr count
4883 let name_of_argt = function
4884 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4885 | StringList n | DeviceList n | Bool n | Int n | Int64 n
4886 | FileIn n | FileOut n -> n
4888 let java_name_of_struct typ =
4889 try List.assoc typ java_structs
4892 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4894 let cols_of_struct typ =
4895 try List.assoc typ structs
4897 failwithf "cols_of_struct: unknown struct %s" typ
4899 let seq_of_test = function
4900 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4901 | TestOutputListOfDevices (s, _)
4902 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4903 | TestOutputTrue s | TestOutputFalse s
4904 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4905 | TestOutputStruct (s, _)
4906 | TestLastFail s -> s
4908 (* Handling for function flags. *)
4909 let protocol_limit_warning =
4910 "Because of the message protocol, there is a transfer limit
4911 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4913 let danger_will_robinson =
4914 "B<This command is dangerous. Without careful use you
4915 can easily destroy all your data>."
4917 let deprecation_notice flags =
4920 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4922 sprintf "This function is deprecated.
4923 In new code, use the C<%s> call instead.
4925 Deprecated functions will not be removed from the API, but the
4926 fact that they are deprecated indicates that there are problems
4927 with correct use of these functions." alt in
4932 (* Create list of optional groups. *)
4934 let h = Hashtbl.create 13 in
4936 fun (name, _, _, flags, _, _, _) ->
4940 let names = try Hashtbl.find h group with Not_found -> [] in
4941 Hashtbl.replace h group (name :: names)
4945 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
4948 fun group -> group, List.sort compare (Hashtbl.find h group)
4950 List.sort (fun x y -> compare (fst x) (fst y)) groups
4952 (* Check function names etc. for consistency. *)
4953 let check_functions () =
4954 let contains_uppercase str =
4955 let len = String.length str in
4957 if i >= len then false
4960 if c >= 'A' && c <= 'Z' then true
4967 (* Check function names. *)
4969 fun (name, _, _, _, _, _, _) ->
4970 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4971 failwithf "function name %s does not need 'guestfs' prefix" name;
4973 failwithf "function name is empty";
4974 if name.[0] < 'a' || name.[0] > 'z' then
4975 failwithf "function name %s must start with lowercase a-z" name;
4976 if String.contains name '-' then
4977 failwithf "function name %s should not contain '-', use '_' instead."
4981 (* Check function parameter/return names. *)
4983 fun (name, style, _, _, _, _, _) ->
4984 let check_arg_ret_name n =
4985 if contains_uppercase n then
4986 failwithf "%s param/ret %s should not contain uppercase chars"
4988 if String.contains n '-' || String.contains n '_' then
4989 failwithf "%s param/ret %s should not contain '-' or '_'"
4992 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;
4993 if n = "int" || n = "char" || n = "short" || n = "long" then
4994 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4995 if n = "i" || n = "n" then
4996 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4997 if n = "argv" || n = "args" then
4998 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5000 (* List Haskell, OCaml and C keywords here.
5001 * http://www.haskell.org/haskellwiki/Keywords
5002 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5003 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5004 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5005 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5006 * Omitting _-containing words, since they're handled above.
5007 * Omitting the OCaml reserved word, "val", is ok,
5008 * and saves us from renaming several parameters.
5011 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5012 "char"; "class"; "const"; "constraint"; "continue"; "data";
5013 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5014 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5015 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5016 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5017 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5019 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5020 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5021 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5022 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5023 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5024 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5025 "volatile"; "when"; "where"; "while";
5027 if List.mem n reserved then
5028 failwithf "%s has param/ret using reserved word %s" name n;
5031 (match fst style with
5033 | RInt n | RInt64 n | RBool n
5034 | RConstString n | RConstOptString n | RString n
5035 | RStringList n | RStruct (n, _) | RStructList (n, _)
5036 | RHashtable n | RBufferOut n ->
5037 check_arg_ret_name n
5039 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5042 (* Check short descriptions. *)
5044 fun (name, _, _, _, _, shortdesc, _) ->
5045 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5046 failwithf "short description of %s should begin with lowercase." name;
5047 let c = shortdesc.[String.length shortdesc-1] in
5048 if c = '\n' || c = '.' then
5049 failwithf "short description of %s should not end with . or \\n." name
5052 (* Check long dscriptions. *)
5054 fun (name, _, _, _, _, _, longdesc) ->
5055 if longdesc.[String.length longdesc-1] = '\n' then
5056 failwithf "long description of %s should not end with \\n." name
5059 (* Check proc_nrs. *)
5061 fun (name, _, proc_nr, _, _, _, _) ->
5062 if proc_nr <= 0 then
5063 failwithf "daemon function %s should have proc_nr > 0" name
5067 fun (name, _, proc_nr, _, _, _, _) ->
5068 if proc_nr <> -1 then
5069 failwithf "non-daemon function %s should have proc_nr -1" name
5070 ) non_daemon_functions;
5073 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5076 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5077 let rec loop = function
5080 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5082 | (name1,nr1) :: (name2,nr2) :: _ ->
5083 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5091 (* Ignore functions that have no tests. We generate a
5092 * warning when the user does 'make check' instead.
5094 | name, _, _, _, [], _, _ -> ()
5095 | name, _, _, _, tests, _, _ ->
5099 match seq_of_test test with
5101 failwithf "%s has a test containing an empty sequence" name
5102 | cmds -> List.map List.hd cmds
5104 let funcs = List.flatten funcs in
5106 let tested = List.mem name funcs in
5109 failwithf "function %s has tests but does not test itself" name
5112 (* 'pr' prints to the current output file. *)
5113 let chan = ref Pervasives.stdout
5118 let i = count_chars '\n' str in
5119 lines := !lines + i;
5120 output_string !chan str
5123 let copyright_years =
5124 let this_year = 1900 + (localtime (time ())).tm_year in
5125 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5127 (* Generate a header block in a number of standard styles. *)
5128 type comment_style =
5129 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5130 type license = GPLv2plus | LGPLv2plus
5132 let generate_header ?(extra_inputs = []) comment license =
5133 let inputs = "src/generator.ml" :: extra_inputs in
5134 let c = match comment with
5135 | CStyle -> pr "/* "; " *"
5136 | CPlusPlusStyle -> pr "// "; "//"
5137 | HashStyle -> pr "# "; "#"
5138 | OCamlStyle -> pr "(* "; " *"
5139 | HaskellStyle -> pr "{- "; " " in
5140 pr "libguestfs generated file\n";
5141 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5142 List.iter (pr "%s %s\n" c) inputs;
5143 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5145 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5149 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5150 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5151 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5152 pr "%s (at your option) any later version.\n" c;
5154 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5155 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5156 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5157 pr "%s GNU General Public License for more details.\n" c;
5159 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5160 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5161 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5164 pr "%s This library is free software; you can redistribute it and/or\n" c;
5165 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5166 pr "%s License as published by the Free Software Foundation; either\n" c;
5167 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5169 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5170 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5171 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5172 pr "%s Lesser General Public License for more details.\n" c;
5174 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5175 pr "%s License along with this library; if not, write to the Free Software\n" c;
5176 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5179 | CStyle -> pr " */\n"
5182 | OCamlStyle -> pr " *)\n"
5183 | HaskellStyle -> pr "-}\n"
5187 (* Start of main code generation functions below this line. *)
5189 (* Generate the pod documentation for the C API. *)
5190 let rec generate_actions_pod () =
5192 fun (shortname, style, _, flags, _, _, longdesc) ->
5193 if not (List.mem NotInDocs flags) then (
5194 let name = "guestfs_" ^ shortname in
5195 pr "=head2 %s\n\n" name;
5197 generate_prototype ~extern:false ~handle:"handle" name style;
5199 pr "%s\n\n" longdesc;
5200 (match fst style with
5202 pr "This function returns 0 on success or -1 on error.\n\n"
5204 pr "On error this function returns -1.\n\n"
5206 pr "On error this function returns -1.\n\n"
5208 pr "This function returns a C truth value on success or -1 on error.\n\n"
5210 pr "This function returns a string, or NULL on error.
5211 The string is owned by the guest handle and must I<not> be freed.\n\n"
5212 | RConstOptString _ ->
5213 pr "This function returns a string which may be NULL.
5214 There is way to return an error from this function.
5215 The string is owned by the guest handle and must I<not> be freed.\n\n"
5217 pr "This function returns a string, or NULL on error.
5218 I<The caller must free the returned string after use>.\n\n"
5220 pr "This function returns a NULL-terminated array of strings
5221 (like L<environ(3)>), or NULL if there was an error.
5222 I<The caller must free the strings and the array after use>.\n\n"
5223 | RStruct (_, typ) ->
5224 pr "This function returns a C<struct guestfs_%s *>,
5225 or NULL if there was an error.
5226 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5227 | RStructList (_, typ) ->
5228 pr "This function returns a C<struct guestfs_%s_list *>
5229 (see E<lt>guestfs-structs.hE<gt>),
5230 or NULL if there was an error.
5231 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5233 pr "This function returns a NULL-terminated array of
5234 strings, or NULL if there was an error.
5235 The array of strings will always have length C<2n+1>, where
5236 C<n> keys and values alternate, followed by the trailing NULL entry.
5237 I<The caller must free the strings and the array after use>.\n\n"
5239 pr "This function returns a buffer, or NULL on error.
5240 The size of the returned buffer is written to C<*size_r>.
5241 I<The caller must free the returned buffer after use>.\n\n"
5243 if List.mem ProtocolLimitWarning flags then
5244 pr "%s\n\n" protocol_limit_warning;
5245 if List.mem DangerWillRobinson flags then
5246 pr "%s\n\n" danger_will_robinson;
5247 match deprecation_notice flags with
5249 | Some txt -> pr "%s\n\n" txt
5251 ) all_functions_sorted
5253 and generate_structs_pod () =
5254 (* Structs documentation. *)
5257 pr "=head2 guestfs_%s\n" typ;
5259 pr " struct guestfs_%s {\n" typ;
5262 | name, FChar -> pr " char %s;\n" name
5263 | name, FUInt32 -> pr " uint32_t %s;\n" name
5264 | name, FInt32 -> pr " int32_t %s;\n" name
5265 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5266 | name, FInt64 -> pr " int64_t %s;\n" name
5267 | name, FString -> pr " char *%s;\n" name
5269 pr " /* The next two fields describe a byte array. */\n";
5270 pr " uint32_t %s_len;\n" name;
5271 pr " char *%s;\n" name
5273 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5274 pr " char %s[32];\n" name
5275 | name, FOptPercent ->
5276 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5277 pr " float %s;\n" name
5281 pr " struct guestfs_%s_list {\n" typ;
5282 pr " uint32_t len; /* Number of elements in list. */\n";
5283 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5286 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5287 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5292 and generate_availability_pod () =
5293 (* Availability documentation. *)
5297 fun (group, functions) ->
5298 pr "=item B<%s>\n" group;
5300 pr "The following functions:\n";
5301 List.iter (pr "L</guestfs_%s>\n") functions;
5307 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5308 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5310 * We have to use an underscore instead of a dash because otherwise
5311 * rpcgen generates incorrect code.
5313 * This header is NOT exported to clients, but see also generate_structs_h.
5315 and generate_xdr () =
5316 generate_header CStyle LGPLv2plus;
5318 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5319 pr "typedef string str<>;\n";
5322 (* Internal structures. *)
5326 pr "struct guestfs_int_%s {\n" typ;
5328 | name, FChar -> pr " char %s;\n" name
5329 | name, FString -> pr " string %s<>;\n" name
5330 | name, FBuffer -> pr " opaque %s<>;\n" name
5331 | name, FUUID -> pr " opaque %s[32];\n" name
5332 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5333 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5334 | name, FOptPercent -> pr " float %s;\n" name
5338 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5343 fun (shortname, style, _, _, _, _, _) ->
5344 let name = "guestfs_" ^ shortname in
5346 (match snd style with
5349 pr "struct %s_args {\n" name;
5352 | Pathname n | Device n | Dev_or_Path n | String n ->
5353 pr " string %s<>;\n" n
5354 | OptString n -> pr " str *%s;\n" n
5355 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5356 | Bool n -> pr " bool %s;\n" n
5357 | Int n -> pr " int %s;\n" n
5358 | Int64 n -> pr " hyper %s;\n" n
5359 | FileIn _ | FileOut _ -> ()
5363 (match fst style with
5366 pr "struct %s_ret {\n" name;
5370 pr "struct %s_ret {\n" name;
5371 pr " hyper %s;\n" n;
5374 pr "struct %s_ret {\n" name;
5377 | RConstString _ | RConstOptString _ ->
5378 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5380 pr "struct %s_ret {\n" name;
5381 pr " string %s<>;\n" n;
5384 pr "struct %s_ret {\n" name;
5385 pr " str %s<>;\n" n;
5387 | RStruct (n, typ) ->
5388 pr "struct %s_ret {\n" name;
5389 pr " guestfs_int_%s %s;\n" typ n;
5391 | RStructList (n, typ) ->
5392 pr "struct %s_ret {\n" name;
5393 pr " guestfs_int_%s_list %s;\n" typ n;
5396 pr "struct %s_ret {\n" name;
5397 pr " str %s<>;\n" n;
5400 pr "struct %s_ret {\n" name;
5401 pr " opaque %s<>;\n" n;
5406 (* Table of procedure numbers. *)
5407 pr "enum guestfs_procedure {\n";
5409 fun (shortname, _, proc_nr, _, _, _, _) ->
5410 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5412 pr " GUESTFS_PROC_NR_PROCS\n";
5416 (* Having to choose a maximum message size is annoying for several
5417 * reasons (it limits what we can do in the API), but it (a) makes
5418 * the protocol a lot simpler, and (b) provides a bound on the size
5419 * of the daemon which operates in limited memory space.
5421 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5424 (* Message header, etc. *)
5426 /* The communication protocol is now documented in the guestfs(3)
5430 const GUESTFS_PROGRAM = 0x2000F5F5;
5431 const GUESTFS_PROTOCOL_VERSION = 1;
5433 /* These constants must be larger than any possible message length. */
5434 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5435 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5437 enum guestfs_message_direction {
5438 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5439 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5442 enum guestfs_message_status {
5443 GUESTFS_STATUS_OK = 0,
5444 GUESTFS_STATUS_ERROR = 1
5447 const GUESTFS_ERROR_LEN = 256;
5449 struct guestfs_message_error {
5450 string error_message<GUESTFS_ERROR_LEN>;
5453 struct guestfs_message_header {
5454 unsigned prog; /* GUESTFS_PROGRAM */
5455 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5456 guestfs_procedure proc; /* GUESTFS_PROC_x */
5457 guestfs_message_direction direction;
5458 unsigned serial; /* message serial number */
5459 guestfs_message_status status;
5462 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5464 struct guestfs_chunk {
5465 int cancel; /* if non-zero, transfer is cancelled */
5466 /* data size is 0 bytes if the transfer has finished successfully */
5467 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5471 (* Generate the guestfs-structs.h file. *)
5472 and generate_structs_h () =
5473 generate_header CStyle LGPLv2plus;
5475 (* This is a public exported header file containing various
5476 * structures. The structures are carefully written to have
5477 * exactly the same in-memory format as the XDR structures that
5478 * we use on the wire to the daemon. The reason for creating
5479 * copies of these structures here is just so we don't have to
5480 * export the whole of guestfs_protocol.h (which includes much
5481 * unrelated and XDR-dependent stuff that we don't want to be
5482 * public, or required by clients).
5484 * To reiterate, we will pass these structures to and from the
5485 * client with a simple assignment or memcpy, so the format
5486 * must be identical to what rpcgen / the RFC defines.
5489 (* Public structures. *)
5492 pr "struct guestfs_%s {\n" typ;
5495 | name, FChar -> pr " char %s;\n" name
5496 | name, FString -> pr " char *%s;\n" name
5498 pr " uint32_t %s_len;\n" name;
5499 pr " char *%s;\n" name
5500 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5501 | name, FUInt32 -> pr " uint32_t %s;\n" name
5502 | name, FInt32 -> pr " int32_t %s;\n" name
5503 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5504 | name, FInt64 -> pr " int64_t %s;\n" name
5505 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5509 pr "struct guestfs_%s_list {\n" typ;
5510 pr " uint32_t len;\n";
5511 pr " struct guestfs_%s *val;\n" typ;
5514 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5515 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5519 (* Generate the guestfs-actions.h file. *)
5520 and generate_actions_h () =
5521 generate_header CStyle LGPLv2plus;
5523 fun (shortname, style, _, _, _, _, _) ->
5524 let name = "guestfs_" ^ shortname in
5525 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5529 (* Generate the guestfs-internal-actions.h file. *)
5530 and generate_internal_actions_h () =
5531 generate_header CStyle LGPLv2plus;
5533 fun (shortname, style, _, _, _, _, _) ->
5534 let name = "guestfs__" ^ shortname in
5535 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
5537 ) non_daemon_functions
5539 (* Generate the client-side dispatch stubs. *)
5540 and generate_client_actions () =
5541 generate_header CStyle LGPLv2plus;
5548 #include <inttypes.h>
5550 #include \"guestfs.h\"
5551 #include \"guestfs-internal.h\"
5552 #include \"guestfs-internal-actions.h\"
5553 #include \"guestfs_protocol.h\"
5555 #define error guestfs_error
5556 //#define perrorf guestfs_perrorf
5557 #define safe_malloc guestfs_safe_malloc
5558 #define safe_realloc guestfs_safe_realloc
5559 //#define safe_strdup guestfs_safe_strdup
5560 #define safe_memdup guestfs_safe_memdup
5562 /* Check the return message from a call for validity. */
5564 check_reply_header (guestfs_h *g,
5565 const struct guestfs_message_header *hdr,
5566 unsigned int proc_nr, unsigned int serial)
5568 if (hdr->prog != GUESTFS_PROGRAM) {
5569 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5572 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5573 error (g, \"wrong protocol version (%%d/%%d)\",
5574 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5577 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5578 error (g, \"unexpected message direction (%%d/%%d)\",
5579 hdr->direction, GUESTFS_DIRECTION_REPLY);
5582 if (hdr->proc != proc_nr) {
5583 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5586 if (hdr->serial != serial) {
5587 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5594 /* Check we are in the right state to run a high-level action. */
5596 check_state (guestfs_h *g, const char *caller)
5598 if (!guestfs__is_ready (g)) {
5599 if (guestfs__is_config (g) || guestfs__is_launching (g))
5600 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5603 error (g, \"%%s called from the wrong state, %%d != READY\",
5604 caller, guestfs__get_state (g));
5612 (* Generate code to generate guestfish call traces. *)
5613 let trace_call shortname style =
5614 pr " if (guestfs__get_trace (g)) {\n";
5617 List.exists (function
5618 | StringList _ | DeviceList _ -> true
5619 | _ -> false) (snd style) in
5625 pr " printf (\"%s\");\n" shortname;
5628 | String n (* strings *)
5634 (* guestfish doesn't support string escaping, so neither do we *)
5635 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5636 | OptString n -> (* string option *)
5637 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5638 pr " else printf (\" null\");\n"
5640 | DeviceList n -> (* string list *)
5641 pr " putchar (' ');\n";
5642 pr " putchar ('\"');\n";
5643 pr " for (i = 0; %s[i]; ++i) {\n" n;
5644 pr " if (i > 0) putchar (' ');\n";
5645 pr " fputs (%s[i], stdout);\n" n;
5647 pr " putchar ('\"');\n";
5648 | Bool n -> (* boolean *)
5649 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5650 | Int n -> (* int *)
5651 pr " printf (\" %%d\", %s);\n" n
5653 pr " printf (\" %%\" PRIi64, %s);\n" n
5655 pr " putchar ('\\n');\n";
5660 (* For non-daemon functions, generate a wrapper around each function. *)
5662 fun (shortname, style, _, _, _, _, _) ->
5663 let name = "guestfs_" ^ shortname in
5665 generate_prototype ~extern:false ~semicolon:false ~newline:true
5666 ~handle:"g" name style;
5668 trace_call shortname style;
5669 pr " return guestfs__%s " shortname;
5670 generate_c_call_args ~handle:"g" style;
5674 ) non_daemon_functions;
5676 (* Client-side stubs for each function. *)
5678 fun (shortname, style, _, _, _, _, _) ->
5679 let name = "guestfs_" ^ shortname in
5681 (* Generate the action stub. *)
5682 generate_prototype ~extern:false ~semicolon:false ~newline:true
5683 ~handle:"g" name style;
5686 match fst style with
5687 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5688 | RConstString _ | RConstOptString _ ->
5689 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5690 | RString _ | RStringList _
5691 | RStruct _ | RStructList _
5692 | RHashtable _ | RBufferOut _ ->
5697 (match snd style with
5699 | _ -> pr " struct %s_args args;\n" name
5702 pr " guestfs_message_header hdr;\n";
5703 pr " guestfs_message_error err;\n";
5705 match fst style with
5707 | RConstString _ | RConstOptString _ ->
5708 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5710 | RBool _ | RString _ | RStringList _
5711 | RStruct _ | RStructList _
5712 | RHashtable _ | RBufferOut _ ->
5713 pr " struct %s_ret ret;\n" name;
5716 pr " int serial;\n";
5719 trace_call shortname style;
5720 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
5721 pr " guestfs___set_busy (g);\n";
5724 (* Send the main header and arguments. *)
5725 (match snd style with
5727 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5728 (String.uppercase shortname)
5732 | Pathname n | Device n | Dev_or_Path n | String n ->
5733 pr " args.%s = (char *) %s;\n" n n
5735 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5736 | StringList n | DeviceList n ->
5737 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5738 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5740 pr " args.%s = %s;\n" n n
5742 pr " args.%s = %s;\n" n n
5744 pr " args.%s = %s;\n" n n
5745 | FileIn _ | FileOut _ -> ()
5747 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5748 (String.uppercase shortname);
5749 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5752 pr " if (serial == -1) {\n";
5753 pr " guestfs___end_busy (g);\n";
5754 pr " return %s;\n" error_code;
5758 (* Send any additional files (FileIn) requested. *)
5759 let need_read_reply_label = ref false in
5763 pr " r = guestfs___send_file (g, %s);\n" n;
5764 pr " if (r == -1) {\n";
5765 pr " guestfs___end_busy (g);\n";
5766 pr " return %s;\n" error_code;
5768 pr " if (r == -2) /* daemon cancelled */\n";
5769 pr " goto read_reply;\n";
5770 need_read_reply_label := true;
5775 (* Wait for the reply from the remote end. *)
5776 if !need_read_reply_label then pr " read_reply:\n";
5777 pr " memset (&hdr, 0, sizeof hdr);\n";
5778 pr " memset (&err, 0, sizeof err);\n";
5779 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
5781 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
5785 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
5788 pr " if (r == -1) {\n";
5789 pr " guestfs___end_busy (g);\n";
5790 pr " return %s;\n" error_code;
5794 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
5795 (String.uppercase shortname);
5796 pr " guestfs___end_busy (g);\n";
5797 pr " return %s;\n" error_code;
5801 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
5802 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
5803 pr " free (err.error_message);\n";
5804 pr " guestfs___end_busy (g);\n";
5805 pr " return %s;\n" error_code;
5809 (* Expecting to receive further files (FileOut)? *)
5813 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
5814 pr " guestfs___end_busy (g);\n";
5815 pr " return %s;\n" error_code;
5821 pr " guestfs___end_busy (g);\n";
5823 (match fst style with
5824 | RErr -> pr " return 0;\n"
5825 | RInt n | RInt64 n | RBool n ->
5826 pr " return ret.%s;\n" n
5827 | RConstString _ | RConstOptString _ ->
5828 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5830 pr " return ret.%s; /* caller will free */\n" n
5831 | RStringList n | RHashtable n ->
5832 pr " /* caller will free this, but we need to add a NULL entry */\n";
5833 pr " ret.%s.%s_val =\n" n n;
5834 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
5835 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
5837 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
5838 pr " return ret.%s.%s_val;\n" n n
5840 pr " /* caller will free this */\n";
5841 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5842 | RStructList (n, _) ->
5843 pr " /* caller will free this */\n";
5844 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
5846 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
5847 pr " * _val might be NULL here. To make the API saner for\n";
5848 pr " * callers, we turn this case into a unique pointer (using\n";
5849 pr " * malloc(1)).\n";
5851 pr " if (ret.%s.%s_len > 0) {\n" n n;
5852 pr " *size_r = ret.%s.%s_len;\n" n n;
5853 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
5855 pr " free (ret.%s.%s_val);\n" n n;
5856 pr " char *p = safe_malloc (g, 1);\n";
5857 pr " *size_r = ret.%s.%s_len;\n" n n;
5865 (* Functions to free structures. *)
5866 pr "/* Structure-freeing functions. These rely on the fact that the\n";
5867 pr " * structure format is identical to the XDR format. See note in\n";
5868 pr " * generator.ml.\n";
5875 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
5877 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
5883 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
5885 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
5892 (* Generate daemon/actions.h. *)
5893 and generate_daemon_actions_h () =
5894 generate_header CStyle GPLv2plus;
5896 pr "#include \"../src/guestfs_protocol.h\"\n";
5900 fun (name, style, _, _, _, _, _) ->
5902 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
5906 (* Generate the linker script which controls the visibility of
5907 * symbols in the public ABI and ensures no other symbols get
5908 * exported accidentally.
5910 and generate_linker_script () =
5911 generate_header HashStyle GPLv2plus;
5916 "guestfs_get_error_handler";
5917 "guestfs_get_out_of_memory_handler";
5918 "guestfs_last_error";
5919 "guestfs_set_error_handler";
5920 "guestfs_set_launch_done_callback";
5921 "guestfs_set_log_message_callback";
5922 "guestfs_set_out_of_memory_handler";
5923 "guestfs_set_subprocess_quit_callback";
5925 (* Unofficial parts of the API: the bindings code use these
5926 * functions, so it is useful to export them.
5928 "guestfs_safe_calloc";
5929 "guestfs_safe_malloc";
5932 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
5936 List.map (fun (typ, _) ->
5937 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
5940 let globals = List.sort compare (globals @ functions @ structs) in
5944 List.iter (pr " %s;\n") globals;
5951 (* Generate the server-side stubs. *)
5952 and generate_daemon_actions () =
5953 generate_header CStyle GPLv2plus;
5955 pr "#include <config.h>\n";
5957 pr "#include <stdio.h>\n";
5958 pr "#include <stdlib.h>\n";
5959 pr "#include <string.h>\n";
5960 pr "#include <inttypes.h>\n";
5961 pr "#include <rpc/types.h>\n";
5962 pr "#include <rpc/xdr.h>\n";
5964 pr "#include \"daemon.h\"\n";
5965 pr "#include \"c-ctype.h\"\n";
5966 pr "#include \"../src/guestfs_protocol.h\"\n";
5967 pr "#include \"actions.h\"\n";
5971 fun (name, style, _, _, _, _, _) ->
5972 (* Generate server-side stubs. *)
5973 pr "static void %s_stub (XDR *xdr_in)\n" name;
5976 match fst style with
5977 | RErr | RInt _ -> pr " int r;\n"; "-1"
5978 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5979 | RBool _ -> pr " int r;\n"; "-1"
5980 | RConstString _ | RConstOptString _ ->
5981 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5982 | RString _ -> pr " char *r;\n"; "NULL"
5983 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
5984 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
5985 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
5987 pr " size_t size = 1;\n";
5991 (match snd style with
5994 pr " struct guestfs_%s_args args;\n" name;
5997 | Device n | Dev_or_Path n
6000 | OptString n -> pr " char *%s;\n" n
6001 | StringList n | DeviceList n -> pr " char **%s;\n" n
6002 | Bool n -> pr " int %s;\n" n
6003 | Int n -> pr " int %s;\n" n
6004 | Int64 n -> pr " int64_t %s;\n" n
6005 | FileIn _ | FileOut _ -> ()
6010 (match snd style with
6013 pr " memset (&args, 0, sizeof args);\n";
6015 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6016 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6020 pr " char *%s = args.%s;\n" n n
6022 let pr_list_handling_code n =
6023 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6024 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6025 pr " if (%s == NULL) {\n" n;
6026 pr " reply_with_perror (\"realloc\");\n";
6029 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6030 pr " args.%s.%s_val = %s;\n" n n n;
6036 pr " ABS_PATH (%s, goto done);\n" n;
6039 pr " RESOLVE_DEVICE (%s, goto done);\n" n;
6042 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, goto done);\n" n;
6043 | String n -> pr_args n
6044 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6046 pr_list_handling_code n;
6048 pr_list_handling_code n;
6049 pr " /* Ensure that each is a device,\n";
6050 pr " * and perform device name translation. */\n";
6051 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6052 pr " RESOLVE_DEVICE (physvols[pvi], goto done);\n";
6054 | Bool n -> pr " %s = args.%s;\n" n n
6055 | Int n -> pr " %s = args.%s;\n" n n
6056 | Int64 n -> pr " %s = args.%s;\n" n n
6057 | FileIn _ | FileOut _ -> ()
6063 (* this is used at least for do_equal *)
6064 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6065 (* Emit NEED_ROOT just once, even when there are two or
6066 more Pathname args *)
6067 pr " NEED_ROOT (goto done);\n";
6070 (* Don't want to call the impl with any FileIn or FileOut
6071 * parameters, since these go "outside" the RPC protocol.
6074 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6076 pr " r = do_%s " name;
6077 generate_c_call_args (fst style, args');
6080 (match fst style with
6081 | RErr | RInt _ | RInt64 _ | RBool _
6082 | RConstString _ | RConstOptString _
6083 | RString _ | RStringList _ | RHashtable _
6084 | RStruct (_, _) | RStructList (_, _) ->
6085 pr " if (r == %s)\n" error_code;
6086 pr " /* do_%s has already called reply_with_error */\n" name;
6090 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6091 pr " * an ordinary zero-length buffer), so be careful ...\n";
6093 pr " if (size == 1 && r == %s)\n" error_code;
6094 pr " /* do_%s has already called reply_with_error */\n" name;
6099 (* If there are any FileOut parameters, then the impl must
6100 * send its own reply.
6103 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6105 pr " /* do_%s has already sent a reply */\n" name
6107 match fst style with
6108 | RErr -> pr " reply (NULL, NULL);\n"
6109 | RInt n | RInt64 n | RBool n ->
6110 pr " struct guestfs_%s_ret ret;\n" name;
6111 pr " ret.%s = r;\n" n;
6112 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6114 | RConstString _ | RConstOptString _ ->
6115 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6117 pr " struct guestfs_%s_ret ret;\n" name;
6118 pr " ret.%s = r;\n" n;
6119 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6122 | RStringList n | RHashtable n ->
6123 pr " struct guestfs_%s_ret ret;\n" name;
6124 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6125 pr " ret.%s.%s_val = r;\n" n n;
6126 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6128 pr " free_strings (r);\n"
6130 pr " struct guestfs_%s_ret ret;\n" name;
6131 pr " ret.%s = *r;\n" n;
6132 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6134 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6136 | RStructList (n, _) ->
6137 pr " struct guestfs_%s_ret ret;\n" name;
6138 pr " ret.%s = *r;\n" n;
6139 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6141 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6144 pr " struct guestfs_%s_ret ret;\n" name;
6145 pr " ret.%s.%s_val = r;\n" n n;
6146 pr " ret.%s.%s_len = size;\n" n n;
6147 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6152 (* Free the args. *)
6153 (match snd style with
6158 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6165 (* Dispatch function. *)
6166 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6168 pr " switch (proc_nr) {\n";
6171 fun (name, style, _, _, _, _, _) ->
6172 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6173 pr " %s_stub (xdr_in);\n" name;
6178 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";
6183 (* LVM columns and tokenization functions. *)
6184 (* XXX This generates crap code. We should rethink how we
6190 pr "static const char *lvm_%s_cols = \"%s\";\n"
6191 typ (String.concat "," (List.map fst cols));
6194 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6196 pr " char *tok, *p, *next;\n";
6200 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6203 pr " if (!str) {\n";
6204 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6207 pr " if (!*str || c_isspace (*str)) {\n";
6208 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6213 fun (name, coltype) ->
6214 pr " if (!tok) {\n";
6215 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6218 pr " p = strchrnul (tok, ',');\n";
6219 pr " if (*p) next = p+1; else next = NULL;\n";
6220 pr " *p = '\\0';\n";
6223 pr " r->%s = strdup (tok);\n" name;
6224 pr " if (r->%s == NULL) {\n" name;
6225 pr " perror (\"strdup\");\n";
6229 pr " for (i = j = 0; i < 32; ++j) {\n";
6230 pr " if (tok[j] == '\\0') {\n";
6231 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6233 pr " } else if (tok[j] != '-')\n";
6234 pr " r->%s[i++] = tok[j];\n" name;
6237 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6238 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6242 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6243 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6247 pr " if (tok[0] == '\\0')\n";
6248 pr " r->%s = -1;\n" name;
6249 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6250 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6253 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6254 assert false (* can never be an LVM column *)
6256 pr " tok = next;\n";
6259 pr " if (tok != NULL) {\n";
6260 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6267 pr "guestfs_int_lvm_%s_list *\n" typ;
6268 pr "parse_command_line_%ss (void)\n" typ;
6270 pr " char *out, *err;\n";
6271 pr " char *p, *pend;\n";
6273 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6274 pr " void *newp;\n";
6276 pr " ret = malloc (sizeof *ret);\n";
6277 pr " if (!ret) {\n";
6278 pr " reply_with_perror (\"malloc\");\n";
6279 pr " return NULL;\n";
6282 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6283 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6285 pr " r = command (&out, &err,\n";
6286 pr " \"lvm\", \"%ss\",\n" typ;
6287 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6288 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6289 pr " if (r == -1) {\n";
6290 pr " reply_with_error (\"%%s\", err);\n";
6291 pr " free (out);\n";
6292 pr " free (err);\n";
6293 pr " free (ret);\n";
6294 pr " return NULL;\n";
6297 pr " free (err);\n";
6299 pr " /* Tokenize each line of the output. */\n";
6302 pr " while (p) {\n";
6303 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6304 pr " if (pend) {\n";
6305 pr " *pend = '\\0';\n";
6309 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6312 pr " if (!*p) { /* Empty line? Skip it. */\n";
6317 pr " /* Allocate some space to store this next entry. */\n";
6318 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6319 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6320 pr " if (newp == NULL) {\n";
6321 pr " reply_with_perror (\"realloc\");\n";
6322 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6323 pr " free (ret);\n";
6324 pr " free (out);\n";
6325 pr " return NULL;\n";
6327 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6329 pr " /* Tokenize the next entry. */\n";
6330 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6331 pr " if (r == -1) {\n";
6332 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6333 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6334 pr " free (ret);\n";
6335 pr " free (out);\n";
6336 pr " return NULL;\n";
6343 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6345 pr " free (out);\n";
6346 pr " return ret;\n";
6349 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6351 (* Generate a list of function names, for debugging in the daemon.. *)
6352 and generate_daemon_names () =
6353 generate_header CStyle GPLv2plus;
6355 pr "#include <config.h>\n";
6357 pr "#include \"daemon.h\"\n";
6360 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6361 pr "const char *function_names[] = {\n";
6363 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6367 (* Generate the optional groups for the daemon to implement
6368 * guestfs_available.
6370 and generate_daemon_optgroups_c () =
6371 generate_header CStyle GPLv2plus;
6373 pr "#include <config.h>\n";
6375 pr "#include \"daemon.h\"\n";
6376 pr "#include \"optgroups.h\"\n";
6379 pr "struct optgroup optgroups[] = {\n";
6382 pr " { \"%s\", optgroup_%s_available },\n" group group
6384 pr " { NULL, NULL }\n";
6387 and generate_daemon_optgroups_h () =
6388 generate_header CStyle GPLv2plus;
6392 pr "extern int optgroup_%s_available (void);\n" group
6395 (* Generate the tests. *)
6396 and generate_tests () =
6397 generate_header CStyle GPLv2plus;
6404 #include <sys/types.h>
6407 #include \"guestfs.h\"
6408 #include \"guestfs-internal.h\"
6410 static guestfs_h *g;
6411 static int suppress_error = 0;
6413 static void print_error (guestfs_h *g, void *data, const char *msg)
6415 if (!suppress_error)
6416 fprintf (stderr, \"%%s\\n\", msg);
6419 /* FIXME: nearly identical code appears in fish.c */
6420 static void print_strings (char *const *argv)
6424 for (argc = 0; argv[argc] != NULL; ++argc)
6425 printf (\"\\t%%s\\n\", argv[argc]);
6429 static void print_table (char const *const *argv)
6433 for (i = 0; argv[i] != NULL; i += 2)
6434 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6440 (* Generate a list of commands which are not tested anywhere. *)
6441 pr "static void no_test_warnings (void)\n";
6444 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6446 fun (_, _, _, _, tests, _, _) ->
6447 let tests = filter_map (
6449 | (_, (Always|If _|Unless _), test) -> Some test
6450 | (_, Disabled, _) -> None
6452 let seq = List.concat (List.map seq_of_test tests) in
6453 let cmds_tested = List.map List.hd seq in
6454 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6458 fun (name, _, _, _, _, _, _) ->
6459 if not (Hashtbl.mem hash name) then
6460 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6466 (* Generate the actual tests. Note that we generate the tests
6467 * in reverse order, deliberately, so that (in general) the
6468 * newest tests run first. This makes it quicker and easier to
6473 fun (name, _, _, flags, tests, _, _) ->
6474 mapi (generate_one_test name flags) tests
6475 ) (List.rev all_functions) in
6476 let test_names = List.concat test_names in
6477 let nr_tests = List.length test_names in
6480 int main (int argc, char *argv[])
6483 unsigned long int n_failed = 0;
6484 const char *filename;
6486 int nr_tests, test_num = 0;
6488 setbuf (stdout, NULL);
6490 no_test_warnings ();
6492 g = guestfs_create ();
6494 printf (\"guestfs_create FAILED\\n\");
6495 exit (EXIT_FAILURE);
6498 guestfs_set_error_handler (g, print_error, NULL);
6500 guestfs_set_path (g, \"../appliance\");
6502 filename = \"test1.img\";
6503 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6506 exit (EXIT_FAILURE);
6508 if (lseek (fd, %d, SEEK_SET) == -1) {
6512 exit (EXIT_FAILURE);
6514 if (write (fd, &c, 1) == -1) {
6518 exit (EXIT_FAILURE);
6520 if (close (fd) == -1) {
6523 exit (EXIT_FAILURE);
6525 if (guestfs_add_drive (g, filename) == -1) {
6526 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6527 exit (EXIT_FAILURE);
6530 filename = \"test2.img\";
6531 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6534 exit (EXIT_FAILURE);
6536 if (lseek (fd, %d, SEEK_SET) == -1) {
6540 exit (EXIT_FAILURE);
6542 if (write (fd, &c, 1) == -1) {
6546 exit (EXIT_FAILURE);
6548 if (close (fd) == -1) {
6551 exit (EXIT_FAILURE);
6553 if (guestfs_add_drive (g, filename) == -1) {
6554 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6555 exit (EXIT_FAILURE);
6558 filename = \"test3.img\";
6559 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6562 exit (EXIT_FAILURE);
6564 if (lseek (fd, %d, SEEK_SET) == -1) {
6568 exit (EXIT_FAILURE);
6570 if (write (fd, &c, 1) == -1) {
6574 exit (EXIT_FAILURE);
6576 if (close (fd) == -1) {
6579 exit (EXIT_FAILURE);
6581 if (guestfs_add_drive (g, filename) == -1) {
6582 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6583 exit (EXIT_FAILURE);
6586 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6587 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6588 exit (EXIT_FAILURE);
6591 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6594 if (guestfs_launch (g) == -1) {
6595 printf (\"guestfs_launch FAILED\\n\");
6596 exit (EXIT_FAILURE);
6599 /* Cancel previous alarm. */
6604 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6608 pr " test_num++;\n";
6609 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6610 pr " if (%s () == -1) {\n" test_name;
6611 pr " printf (\"%s FAILED\\n\");\n" test_name;
6612 pr " n_failed++;\n";
6617 pr " guestfs_close (g);\n";
6618 pr " unlink (\"test1.img\");\n";
6619 pr " unlink (\"test2.img\");\n";
6620 pr " unlink (\"test3.img\");\n";
6623 pr " if (n_failed > 0) {\n";
6624 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6625 pr " exit (EXIT_FAILURE);\n";
6629 pr " exit (EXIT_SUCCESS);\n";
6632 and generate_one_test name flags i (init, prereq, test) =
6633 let test_name = sprintf "test_%s_%d" name i in
6636 static int %s_skip (void)
6640 str = getenv (\"TEST_ONLY\");
6642 return strstr (str, \"%s\") == NULL;
6643 str = getenv (\"SKIP_%s\");
6644 if (str && STREQ (str, \"1\")) return 1;
6645 str = getenv (\"SKIP_TEST_%s\");
6646 if (str && STREQ (str, \"1\")) return 1;
6650 " test_name name (String.uppercase test_name) (String.uppercase name);
6653 | Disabled | Always -> ()
6654 | If code | Unless code ->
6655 pr "static int %s_prereq (void)\n" test_name;
6663 static int %s (void)
6666 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6670 " test_name test_name test_name;
6672 (* Optional functions should only be tested if the relevant
6673 * support is available in the daemon.
6679 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6681 pr " suppress_error = 1;\n";
6682 pr " r = guestfs_available (g, (char **) groups);\n";
6683 pr " suppress_error = 0;\n";
6684 pr " if (r == -1) {\n";
6685 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6694 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6696 pr " if (! %s_prereq ()) {\n" test_name;
6697 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6701 generate_one_test_body name i test_name init test;
6703 pr " if (%s_prereq ()) {\n" test_name;
6704 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6708 generate_one_test_body name i test_name init test;
6710 generate_one_test_body name i test_name init test
6718 and generate_one_test_body name i test_name init test =
6720 | InitNone (* XXX at some point, InitNone and InitEmpty became
6721 * folded together as the same thing. Really we should
6722 * make InitNone do nothing at all, but the tests may
6723 * need to be checked to make sure this is OK.
6726 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6727 List.iter (generate_test_command_call test_name)
6728 [["blockdev_setrw"; "/dev/sda"];
6732 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6733 List.iter (generate_test_command_call test_name)
6734 [["blockdev_setrw"; "/dev/sda"];
6737 ["part_disk"; "/dev/sda"; "mbr"]]
6739 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6740 List.iter (generate_test_command_call test_name)
6741 [["blockdev_setrw"; "/dev/sda"];
6744 ["part_disk"; "/dev/sda"; "mbr"];
6745 ["mkfs"; "ext2"; "/dev/sda1"];
6746 ["mount_options"; ""; "/dev/sda1"; "/"]]
6747 | InitBasicFSonLVM ->
6748 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
6750 List.iter (generate_test_command_call test_name)
6751 [["blockdev_setrw"; "/dev/sda"];
6754 ["part_disk"; "/dev/sda"; "mbr"];
6755 ["pvcreate"; "/dev/sda1"];
6756 ["vgcreate"; "VG"; "/dev/sda1"];
6757 ["lvcreate"; "LV"; "VG"; "8"];
6758 ["mkfs"; "ext2"; "/dev/VG/LV"];
6759 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
6761 pr " /* InitISOFS for %s */\n" test_name;
6762 List.iter (generate_test_command_call test_name)
6763 [["blockdev_setrw"; "/dev/sda"];
6766 ["mount_ro"; "/dev/sdd"; "/"]]
6769 let get_seq_last = function
6771 failwithf "%s: you cannot use [] (empty list) when expecting a command"
6774 let seq = List.rev seq in
6775 List.rev (List.tl seq), List.hd seq
6780 pr " /* TestRun for %s (%d) */\n" name i;
6781 List.iter (generate_test_command_call test_name) seq
6782 | TestOutput (seq, expected) ->
6783 pr " /* TestOutput for %s (%d) */\n" name i;
6784 pr " const char *expected = \"%s\";\n" (c_quote expected);
6785 let seq, last = get_seq_last seq in
6787 pr " if (STRNEQ (r, expected)) {\n";
6788 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6792 List.iter (generate_test_command_call test_name) seq;
6793 generate_test_command_call ~test test_name last
6794 | TestOutputList (seq, expected) ->
6795 pr " /* TestOutputList for %s (%d) */\n" name i;
6796 let seq, last = get_seq_last seq in
6800 pr " if (!r[%d]) {\n" i;
6801 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6802 pr " print_strings (r);\n";
6806 pr " const char *expected = \"%s\";\n" (c_quote str);
6807 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6808 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6813 pr " if (r[%d] != NULL) {\n" (List.length expected);
6814 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6816 pr " print_strings (r);\n";
6820 List.iter (generate_test_command_call test_name) seq;
6821 generate_test_command_call ~test test_name last
6822 | TestOutputListOfDevices (seq, expected) ->
6823 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
6824 let seq, last = get_seq_last seq in
6828 pr " if (!r[%d]) {\n" i;
6829 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
6830 pr " print_strings (r);\n";
6834 pr " const char *expected = \"%s\";\n" (c_quote str);
6835 pr " r[%d][5] = 's';\n" i;
6836 pr " if (STRNEQ (r[%d], expected)) {\n" i;
6837 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
6842 pr " if (r[%d] != NULL) {\n" (List.length expected);
6843 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
6845 pr " print_strings (r);\n";
6849 List.iter (generate_test_command_call test_name) seq;
6850 generate_test_command_call ~test test_name last
6851 | TestOutputInt (seq, expected) ->
6852 pr " /* TestOutputInt for %s (%d) */\n" name i;
6853 let seq, last = get_seq_last seq in
6855 pr " if (r != %d) {\n" expected;
6856 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
6862 List.iter (generate_test_command_call test_name) seq;
6863 generate_test_command_call ~test test_name last
6864 | TestOutputIntOp (seq, op, expected) ->
6865 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
6866 let seq, last = get_seq_last seq in
6868 pr " if (! (r %s %d)) {\n" op expected;
6869 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
6870 test_name op expected;
6875 List.iter (generate_test_command_call test_name) seq;
6876 generate_test_command_call ~test test_name last
6877 | TestOutputTrue seq ->
6878 pr " /* TestOutputTrue for %s (%d) */\n" name i;
6879 let seq, last = get_seq_last seq in
6882 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
6887 List.iter (generate_test_command_call test_name) seq;
6888 generate_test_command_call ~test test_name last
6889 | TestOutputFalse seq ->
6890 pr " /* TestOutputFalse for %s (%d) */\n" name i;
6891 let seq, last = get_seq_last seq in
6894 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
6899 List.iter (generate_test_command_call test_name) seq;
6900 generate_test_command_call ~test test_name last
6901 | TestOutputLength (seq, expected) ->
6902 pr " /* TestOutputLength for %s (%d) */\n" name i;
6903 let seq, last = get_seq_last seq in
6906 pr " for (j = 0; j < %d; ++j)\n" expected;
6907 pr " if (r[j] == NULL) {\n";
6908 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
6910 pr " print_strings (r);\n";
6913 pr " if (r[j] != NULL) {\n";
6914 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
6916 pr " print_strings (r);\n";
6920 List.iter (generate_test_command_call test_name) seq;
6921 generate_test_command_call ~test test_name last
6922 | TestOutputBuffer (seq, expected) ->
6923 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
6924 pr " const char *expected = \"%s\";\n" (c_quote expected);
6925 let seq, last = get_seq_last seq in
6926 let len = String.length expected in
6928 pr " if (size != %d) {\n" len;
6929 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
6932 pr " if (STRNEQLEN (r, expected, size)) {\n";
6933 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
6937 List.iter (generate_test_command_call test_name) seq;
6938 generate_test_command_call ~test test_name last
6939 | TestOutputStruct (seq, checks) ->
6940 pr " /* TestOutputStruct for %s (%d) */\n" name i;
6941 let seq, last = get_seq_last seq in
6945 | CompareWithInt (field, expected) ->
6946 pr " if (r->%s != %d) {\n" field expected;
6947 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
6948 test_name field expected;
6949 pr " (int) r->%s);\n" field;
6952 | CompareWithIntOp (field, op, expected) ->
6953 pr " if (!(r->%s %s %d)) {\n" field op expected;
6954 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
6955 test_name field op expected;
6956 pr " (int) r->%s);\n" field;
6959 | CompareWithString (field, expected) ->
6960 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
6961 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
6962 test_name field expected;
6963 pr " r->%s);\n" field;
6966 | CompareFieldsIntEq (field1, field2) ->
6967 pr " if (r->%s != r->%s) {\n" field1 field2;
6968 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
6969 test_name field1 field2;
6970 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
6973 | CompareFieldsStrEq (field1, field2) ->
6974 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
6975 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
6976 test_name field1 field2;
6977 pr " r->%s, r->%s);\n" field1 field2;
6982 List.iter (generate_test_command_call test_name) seq;
6983 generate_test_command_call ~test test_name last
6984 | TestLastFail seq ->
6985 pr " /* TestLastFail for %s (%d) */\n" name i;
6986 let seq, last = get_seq_last seq in
6987 List.iter (generate_test_command_call test_name) seq;
6988 generate_test_command_call test_name ~expect_error:true last
6990 (* Generate the code to run a command, leaving the result in 'r'.
6991 * If you expect to get an error then you should set expect_error:true.
6993 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
6995 | [] -> assert false
6997 (* Look up the command to find out what args/ret it has. *)
7000 let _, style, _, _, _, _, _ =
7001 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7004 failwithf "%s: in test, command %s was not found" test_name name in
7006 if List.length (snd style) <> List.length args then
7007 failwithf "%s: in test, wrong number of args given to %s"
7014 | OptString n, "NULL" -> ()
7017 | Dev_or_Path n, arg
7019 | OptString n, arg ->
7020 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7024 | FileIn _, _ | FileOut _, _ -> ()
7025 | StringList n, "" | DeviceList n, "" ->
7026 pr " const char *const %s[1] = { NULL };\n" n
7027 | StringList n, arg | DeviceList n, arg ->
7028 let strs = string_split " " arg in
7031 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7033 pr " const char *const %s[] = {\n" n;
7035 fun i _ -> pr " %s_%d,\n" n i
7039 ) (List.combine (snd style) args);
7042 match fst style with
7043 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7044 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7045 | RConstString _ | RConstOptString _ ->
7046 pr " const char *r;\n"; "NULL"
7047 | RString _ -> pr " char *r;\n"; "NULL"
7048 | RStringList _ | RHashtable _ ->
7052 | RStruct (_, typ) ->
7053 pr " struct guestfs_%s *r;\n" typ; "NULL"
7054 | RStructList (_, typ) ->
7055 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7058 pr " size_t size;\n";
7061 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7062 pr " r = guestfs_%s (g" name;
7064 (* Generate the parameters. *)
7067 | OptString _, "NULL" -> pr ", NULL"
7069 | Device n, _ | Dev_or_Path n, _
7073 | FileIn _, arg | FileOut _, arg ->
7074 pr ", \"%s\"" (c_quote arg)
7075 | StringList n, _ | DeviceList n, _ ->
7076 pr ", (char **) %s" n
7079 try int_of_string arg
7080 with Failure "int_of_string" ->
7081 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7085 try Int64.of_string arg
7086 with Failure "int_of_string" ->
7087 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7090 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7091 ) (List.combine (snd style) args);
7093 (match fst style with
7094 | RBufferOut _ -> pr ", &size"
7100 if not expect_error then
7101 pr " if (r == %s)\n" error_code
7103 pr " if (r != %s)\n" error_code;
7106 (* Insert the test code. *)
7112 (match fst style with
7113 | RErr | RInt _ | RInt64 _ | RBool _
7114 | RConstString _ | RConstOptString _ -> ()
7115 | RString _ | RBufferOut _ -> pr " free (r);\n"
7116 | RStringList _ | RHashtable _ ->
7117 pr " for (i = 0; r[i] != NULL; ++i)\n";
7118 pr " free (r[i]);\n";
7120 | RStruct (_, typ) ->
7121 pr " guestfs_free_%s (r);\n" typ
7122 | RStructList (_, typ) ->
7123 pr " guestfs_free_%s_list (r);\n" typ
7129 let str = replace_str str "\r" "\\r" in
7130 let str = replace_str str "\n" "\\n" in
7131 let str = replace_str str "\t" "\\t" in
7132 let str = replace_str str "\000" "\\0" in
7135 (* Generate a lot of different functions for guestfish. *)
7136 and generate_fish_cmds () =
7137 generate_header CStyle GPLv2plus;
7141 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7143 let all_functions_sorted =
7145 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7146 ) all_functions_sorted in
7148 pr "#include <config.h>\n";
7150 pr "#include <stdio.h>\n";
7151 pr "#include <stdlib.h>\n";
7152 pr "#include <string.h>\n";
7153 pr "#include <inttypes.h>\n";
7155 pr "#include <guestfs.h>\n";
7156 pr "#include \"c-ctype.h\"\n";
7157 pr "#include \"full-write.h\"\n";
7158 pr "#include \"xstrtol.h\"\n";
7159 pr "#include \"fish.h\"\n";
7162 (* list_commands function, which implements guestfish -h *)
7163 pr "void list_commands (void)\n";
7165 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7166 pr " list_builtin_commands ();\n";
7168 fun (name, _, _, flags, _, shortdesc, _) ->
7169 let name = replace_char name '_' '-' in
7170 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7172 ) all_functions_sorted;
7173 pr " printf (\" %%s\\n\",";
7174 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7178 (* display_command function, which implements guestfish -h cmd *)
7179 pr "void display_command (const char *cmd)\n";
7182 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7183 let name2 = replace_char name '_' '-' in
7185 try find_map (function FishAlias n -> Some n | _ -> None) flags
7186 with Not_found -> name in
7187 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7189 match snd style with
7193 name2 (String.concat " " (List.map name_of_argt args)) in
7196 if List.mem ProtocolLimitWarning flags then
7197 ("\n\n" ^ protocol_limit_warning)
7200 (* For DangerWillRobinson commands, we should probably have
7201 * guestfish prompt before allowing you to use them (especially
7202 * in interactive mode). XXX
7206 if List.mem DangerWillRobinson flags then
7207 ("\n\n" ^ danger_will_robinson)
7212 match deprecation_notice flags with
7214 | Some txt -> "\n\n" ^ txt in
7216 let describe_alias =
7217 if name <> alias then
7218 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7222 pr "STRCASEEQ (cmd, \"%s\")" name;
7223 if name <> name2 then
7224 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7225 if name <> alias then
7226 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7228 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7230 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7231 "=head1 DESCRIPTION\n\n" ^
7232 longdesc ^ warnings ^ describe_alias);
7235 pr " display_builtin_command (cmd);\n";
7239 let emit_print_list_function typ =
7240 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7243 pr " unsigned int i;\n";
7245 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7246 pr " printf (\"[%%d] = {\\n\", i);\n";
7247 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7248 pr " printf (\"}\\n\");\n";
7254 (* print_* functions *)
7258 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7260 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7263 pr " unsigned int i;\n";
7269 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7271 pr " printf (\"%%s%s: \", indent);\n" name;
7272 pr " for (i = 0; i < 32; ++i)\n";
7273 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7274 pr " printf (\"\\n\");\n"
7276 pr " printf (\"%%s%s: \", indent);\n" name;
7277 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7278 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7279 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7281 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7282 pr " printf (\"\\n\");\n"
7283 | name, (FUInt64|FBytes) ->
7284 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7287 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7290 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7293 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7296 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7298 | name, FOptPercent ->
7299 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7300 typ name name typ name;
7301 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7307 (* Emit a print_TYPE_list function definition only if that function is used. *)
7310 | typ, (RStructListOnly | RStructAndList) ->
7311 (* generate the function for typ *)
7312 emit_print_list_function typ
7313 | typ, _ -> () (* empty *)
7314 ) (rstructs_used_by all_functions);
7316 (* Emit a print_TYPE function definition only if that function is used. *)
7319 | typ, (RStructOnly | RStructAndList) ->
7320 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7322 pr " print_%s_indent (%s, \"\");\n" typ typ;
7325 | typ, _ -> () (* empty *)
7326 ) (rstructs_used_by all_functions);
7328 (* run_<action> actions *)
7330 fun (name, style, _, flags, _, _, _) ->
7331 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7333 (match fst style with
7336 | RBool _ -> pr " int r;\n"
7337 | RInt64 _ -> pr " int64_t r;\n"
7338 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7339 | RString _ -> pr " char *r;\n"
7340 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7341 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7342 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7345 pr " size_t size;\n";
7353 | FileOut n -> pr " const char *%s;\n" n
7355 | Dev_or_Path n -> pr " char *%s;\n" n
7356 | StringList n | DeviceList n -> pr " char **%s;\n" n
7357 | Bool n -> pr " int %s;\n" n
7358 | Int n -> pr " int %s;\n" n
7359 | Int64 n -> pr " int64_t %s;\n" n
7362 (* Check and convert parameters. *)
7363 let argc_expected = List.length (snd style) in
7364 pr " if (argc != %d) {\n" argc_expected;
7365 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7367 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7371 let parse_integer fn fntyp rtyp range name i =
7373 pr " strtol_error xerr;\n";
7374 pr " %s r;\n" fntyp;
7376 pr " xerr = %s (argv[%d], NULL, 0, &r, \"\");\n" fn i;
7377 pr " if (xerr != LONGINT_OK) {\n";
7378 pr " fprintf (stderr,\n";
7379 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7380 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7385 | Some (min, max, comment) ->
7386 pr " /* %s */\n" comment;
7387 pr " if (r < %s || r > %s) {\n" min max;
7388 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7392 pr " /* The check above should ensure this assignment does not overflow. */\n";
7394 pr " %s = r;\n" name;
7403 pr " %s = argv[%d];\n" name i
7405 | Dev_or_Path name ->
7406 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7407 pr " if (%s == NULL) return -1;\n" name
7409 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7412 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdin\";\n"
7415 pr " %s = STRNEQ (argv[%d], \"-\") ? argv[%d] : \"/dev/stdout\";\n"
7417 | StringList name | DeviceList name ->
7418 pr " %s = parse_string_list (argv[%d]);\n" name i;
7419 pr " if (%s == NULL) return -1;\n" name;
7421 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7424 let min = "(-(2LL<<30))"
7425 and max = "((2LL<<30)-1)"
7427 "The Int type in the generator is a signed 31 bit int." in
7428 Some (min, max, comment) in
7429 parse_integer "xstrtoll" "long long" "int" range name i
7431 parse_integer "xstrtoll" "long long" "int64_t" None name i
7434 (* Call C API function. *)
7436 try find_map (function FishAction n -> Some n | _ -> None) flags
7437 with Not_found -> sprintf "guestfs_%s" name in
7439 generate_c_call_args ~handle:"g" style;
7444 | Device name | String name
7445 | OptString name | FileIn name | FileOut name | Bool name
7446 | Int name | Int64 name -> ()
7447 | Pathname name | Dev_or_Path name ->
7448 pr " free (%s);\n" name
7449 | StringList name | DeviceList name ->
7450 pr " free_strings (%s);\n" name
7453 (* Any output flags? *)
7455 let flags = filter_map (
7456 function FishOutput flag -> Some flag | _ -> None
7462 failwithf "%s: more than one FishOutput flag is not allowed" name in
7464 (* Check return value for errors and display command results. *)
7465 (match fst style with
7466 | RErr -> pr " return r;\n"
7468 pr " if (r == -1) return -1;\n";
7469 (match fish_output with
7471 pr " printf (\"%%d\\n\", r);\n";
7472 | Some FishOutputOctal ->
7473 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7474 | Some FishOutputHexadecimal ->
7475 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7478 pr " if (r == -1) return -1;\n";
7479 (match fish_output with
7481 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7482 | Some FishOutputOctal ->
7483 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7484 | Some FishOutputHexadecimal ->
7485 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7488 pr " if (r == -1) return -1;\n";
7489 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7492 pr " if (r == NULL) return -1;\n";
7493 pr " printf (\"%%s\\n\", r);\n";
7495 | RConstOptString _ ->
7496 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7499 pr " if (r == NULL) return -1;\n";
7500 pr " printf (\"%%s\\n\", r);\n";
7504 pr " if (r == NULL) return -1;\n";
7505 pr " print_strings (r);\n";
7506 pr " free_strings (r);\n";
7508 | RStruct (_, typ) ->
7509 pr " if (r == NULL) return -1;\n";
7510 pr " print_%s (r);\n" typ;
7511 pr " guestfs_free_%s (r);\n" typ;
7513 | RStructList (_, typ) ->
7514 pr " if (r == NULL) return -1;\n";
7515 pr " print_%s_list (r);\n" typ;
7516 pr " guestfs_free_%s_list (r);\n" typ;
7519 pr " if (r == NULL) return -1;\n";
7520 pr " print_table (r);\n";
7521 pr " free_strings (r);\n";
7524 pr " if (r == NULL) return -1;\n";
7525 pr " if (full_write (1, r, size) != size) {\n";
7526 pr " perror (\"write\");\n";
7537 (* run_action function *)
7538 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7541 fun (name, _, _, flags, _, _, _) ->
7542 let name2 = replace_char name '_' '-' in
7544 try find_map (function FishAlias n -> Some n | _ -> None) flags
7545 with Not_found -> name in
7547 pr "STRCASEEQ (cmd, \"%s\")" name;
7548 if name <> name2 then
7549 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7550 if name <> alias then
7551 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7553 pr " return run_%s (cmd, argc, argv);\n" name;
7557 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7558 pr " if (command_num == 1)\n";
7559 pr " extended_help_message ();\n";
7566 (* Readline completion for guestfish. *)
7567 and generate_fish_completion () =
7568 generate_header CStyle GPLv2plus;
7572 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7582 #ifdef HAVE_LIBREADLINE
7583 #include <readline/readline.h>
7588 #ifdef HAVE_LIBREADLINE
7590 static const char *const commands[] = {
7591 BUILTIN_COMMANDS_FOR_COMPLETION,
7594 (* Get the commands, including the aliases. They don't need to be
7595 * sorted - the generator() function just does a dumb linear search.
7599 fun (name, _, _, flags, _, _, _) ->
7600 let name2 = replace_char name '_' '-' in
7602 try find_map (function FishAlias n -> Some n | _ -> None) flags
7603 with Not_found -> name in
7605 if name <> alias then [name2; alias] else [name2]
7607 let commands = List.flatten commands in
7609 List.iter (pr " \"%s\",\n") commands;
7615 generator (const char *text, int state)
7617 static int index, len;
7622 len = strlen (text);
7625 rl_attempted_completion_over = 1;
7627 while ((name = commands[index]) != NULL) {
7629 if (STRCASEEQLEN (name, text, len))
7630 return strdup (name);
7636 #endif /* HAVE_LIBREADLINE */
7638 #ifdef HAVE_RL_COMPLETION_MATCHES
7639 #define RL_COMPLETION_MATCHES rl_completion_matches
7641 #ifdef HAVE_COMPLETION_MATCHES
7642 #define RL_COMPLETION_MATCHES completion_matches
7644 #endif /* else just fail if we don't have either symbol */
7647 do_completion (const char *text, int start, int end)
7649 char **matches = NULL;
7651 #ifdef HAVE_LIBREADLINE
7652 rl_completion_append_character = ' ';
7655 matches = RL_COMPLETION_MATCHES (text, generator);
7656 else if (complete_dest_paths)
7657 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7664 (* Generate the POD documentation for guestfish. *)
7665 and generate_fish_actions_pod () =
7666 let all_functions_sorted =
7668 fun (_, _, _, flags, _, _, _) ->
7669 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7670 ) all_functions_sorted in
7672 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7675 fun (name, style, _, flags, _, _, longdesc) ->
7677 Str.global_substitute rex (
7680 try Str.matched_group 1 s
7682 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7683 "C<" ^ replace_char sub '_' '-' ^ ">"
7685 let name = replace_char name '_' '-' in
7687 try find_map (function FishAlias n -> Some n | _ -> None) flags
7688 with Not_found -> name in
7690 pr "=head2 %s" name;
7691 if name <> alias then
7698 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7699 | OptString n -> pr " %s" n
7700 | StringList n | DeviceList n -> pr " '%s ...'" n
7701 | Bool _ -> pr " true|false"
7702 | Int n -> pr " %s" n
7703 | Int64 n -> pr " %s" n
7704 | FileIn n | FileOut n -> pr " (%s|-)" n
7708 pr "%s\n\n" longdesc;
7710 if List.exists (function FileIn _ | FileOut _ -> true
7711 | _ -> false) (snd style) then
7712 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7714 if List.mem ProtocolLimitWarning flags then
7715 pr "%s\n\n" protocol_limit_warning;
7717 if List.mem DangerWillRobinson flags then
7718 pr "%s\n\n" danger_will_robinson;
7720 match deprecation_notice flags with
7722 | Some txt -> pr "%s\n\n" txt
7723 ) all_functions_sorted
7725 (* Generate a C function prototype. *)
7726 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7727 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7729 ?handle name style =
7730 if extern then pr "extern ";
7731 if static then pr "static ";
7732 (match fst style with
7734 | RInt _ -> pr "int "
7735 | RInt64 _ -> pr "int64_t "
7736 | RBool _ -> pr "int "
7737 | RConstString _ | RConstOptString _ -> pr "const char *"
7738 | RString _ | RBufferOut _ -> pr "char *"
7739 | RStringList _ | RHashtable _ -> pr "char **"
7740 | RStruct (_, typ) ->
7741 if not in_daemon then pr "struct guestfs_%s *" typ
7742 else pr "guestfs_int_%s *" typ
7743 | RStructList (_, typ) ->
7744 if not in_daemon then pr "struct guestfs_%s_list *" typ
7745 else pr "guestfs_int_%s_list *" typ
7747 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
7748 pr "%s%s (" prefix name;
7749 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
7752 let comma = ref false in
7755 | Some handle -> pr "guestfs_h *%s" handle; comma := true
7759 if single_line then pr ", " else pr ",\n\t\t"
7766 | Device n | Dev_or_Path n
7770 pr "const char *%s" n
7771 | StringList n | DeviceList n ->
7773 pr "char *const *%s" n
7774 | Bool n -> next (); pr "int %s" n
7775 | Int n -> next (); pr "int %s" n
7776 | Int64 n -> next (); pr "int64_t %s" n
7779 if not in_daemon then (next (); pr "const char *%s" n)
7781 if is_RBufferOut then (next (); pr "size_t *size_r");
7784 if semicolon then pr ";";
7785 if newline then pr "\n"
7787 (* Generate C call arguments, eg "(handle, foo, bar)" *)
7788 and generate_c_call_args ?handle ?(decl = false) style =
7790 let comma = ref false in
7792 if !comma then pr ", ";
7797 | Some handle -> pr "%s" handle; comma := true
7802 pr "%s" (name_of_argt arg)
7804 (* For RBufferOut calls, add implicit &size parameter. *)
7806 match fst style with
7814 (* Generate the OCaml bindings interface. *)
7815 and generate_ocaml_mli () =
7816 generate_header OCamlStyle LGPLv2plus;
7819 (** For API documentation you should refer to the C API
7820 in the guestfs(3) manual page. The OCaml API uses almost
7821 exactly the same calls. *)
7824 (** A [guestfs_h] handle. *)
7826 exception Error of string
7827 (** This exception is raised when there is an error. *)
7829 exception Handle_closed of string
7830 (** This exception is raised if you use a {!Guestfs.t} handle
7831 after calling {!close} on it. The string is the name of
7834 val create : unit -> t
7835 (** Create a {!Guestfs.t} handle. *)
7837 val close : t -> unit
7838 (** Close the {!Guestfs.t} handle and free up all resources used
7841 Handles are closed by the garbage collector when they become
7842 unreferenced, but callers can call this in order to provide
7843 predictable cleanup. *)
7846 generate_ocaml_structure_decls ();
7850 fun (name, style, _, _, _, shortdesc, _) ->
7851 generate_ocaml_prototype name style;
7852 pr "(** %s *)\n" shortdesc;
7854 ) all_functions_sorted
7856 (* Generate the OCaml bindings implementation. *)
7857 and generate_ocaml_ml () =
7858 generate_header OCamlStyle LGPLv2plus;
7863 exception Error of string
7864 exception Handle_closed of string
7866 external create : unit -> t = \"ocaml_guestfs_create\"
7867 external close : t -> unit = \"ocaml_guestfs_close\"
7869 (* Give the exceptions names, so they can be raised from the C code. *)
7871 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
7872 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
7876 generate_ocaml_structure_decls ();
7880 fun (name, style, _, _, _, shortdesc, _) ->
7881 generate_ocaml_prototype ~is_external:true name style;
7882 ) all_functions_sorted
7884 (* Generate the OCaml bindings C implementation. *)
7885 and generate_ocaml_c () =
7886 generate_header CStyle LGPLv2plus;
7893 #include <caml/config.h>
7894 #include <caml/alloc.h>
7895 #include <caml/callback.h>
7896 #include <caml/fail.h>
7897 #include <caml/memory.h>
7898 #include <caml/mlvalues.h>
7899 #include <caml/signals.h>
7901 #include <guestfs.h>
7903 #include \"guestfs_c.h\"
7905 /* Copy a hashtable of string pairs into an assoc-list. We return
7906 * the list in reverse order, but hashtables aren't supposed to be
7909 static CAMLprim value
7910 copy_table (char * const * argv)
7913 CAMLlocal5 (rv, pairv, kv, vv, cons);
7917 for (i = 0; argv[i] != NULL; i += 2) {
7918 kv = caml_copy_string (argv[i]);
7919 vv = caml_copy_string (argv[i+1]);
7920 pairv = caml_alloc (2, 0);
7921 Store_field (pairv, 0, kv);
7922 Store_field (pairv, 1, vv);
7923 cons = caml_alloc (2, 0);
7924 Store_field (cons, 1, rv);
7926 Store_field (cons, 0, pairv);
7934 (* Struct copy functions. *)
7936 let emit_ocaml_copy_list_function typ =
7937 pr "static CAMLprim value\n";
7938 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
7940 pr " CAMLparam0 ();\n";
7941 pr " CAMLlocal2 (rv, v);\n";
7942 pr " unsigned int i;\n";
7944 pr " if (%ss->len == 0)\n" typ;
7945 pr " CAMLreturn (Atom (0));\n";
7947 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
7948 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7949 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
7950 pr " caml_modify (&Field (rv, i), v);\n";
7952 pr " CAMLreturn (rv);\n";
7960 let has_optpercent_col =
7961 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
7963 pr "static CAMLprim value\n";
7964 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
7966 pr " CAMLparam0 ();\n";
7967 if has_optpercent_col then
7968 pr " CAMLlocal3 (rv, v, v2);\n"
7970 pr " CAMLlocal2 (rv, v);\n";
7972 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
7977 pr " v = caml_copy_string (%s->%s);\n" typ name
7979 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
7980 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
7983 pr " v = caml_alloc_string (32);\n";
7984 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
7985 | name, (FBytes|FInt64|FUInt64) ->
7986 pr " v = caml_copy_int64 (%s->%s);\n" typ name
7987 | name, (FInt32|FUInt32) ->
7988 pr " v = caml_copy_int32 (%s->%s);\n" typ name
7989 | name, FOptPercent ->
7990 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
7991 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
7992 pr " v = caml_alloc (1, 0);\n";
7993 pr " Store_field (v, 0, v2);\n";
7994 pr " } else /* None */\n";
7995 pr " v = Val_int (0);\n";
7997 pr " v = Val_int (%s->%s);\n" typ name
7999 pr " Store_field (rv, %d, v);\n" i
8001 pr " CAMLreturn (rv);\n";
8006 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8009 | typ, (RStructListOnly | RStructAndList) ->
8010 (* generate the function for typ *)
8011 emit_ocaml_copy_list_function typ
8012 | typ, _ -> () (* empty *)
8013 ) (rstructs_used_by all_functions);
8017 fun (name, style, _, _, _, _, _) ->
8018 pr "/* Automatically generated wrapper for function\n";
8020 generate_ocaml_prototype name style;
8025 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8027 let needs_extra_vs =
8028 match fst style with RConstOptString _ -> true | _ -> false in
8030 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8031 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8032 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8035 pr "CAMLprim value\n";
8036 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8037 List.iter (pr ", value %s") (List.tl params);
8042 | [p1; p2; p3; p4; p5] ->
8043 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8044 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8045 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8046 pr " CAMLxparam%d (%s);\n"
8047 (List.length rest) (String.concat ", " rest)
8049 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8051 if not needs_extra_vs then
8052 pr " CAMLlocal1 (rv);\n"
8054 pr " CAMLlocal3 (rv, v, v2);\n";
8057 pr " guestfs_h *g = Guestfs_val (gv);\n";
8058 pr " if (g == NULL)\n";
8059 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8065 | Device n | Dev_or_Path n
8069 pr " const char *%s = String_val (%sv);\n" n n
8071 pr " const char *%s =\n" n;
8072 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8074 | StringList n | DeviceList n ->
8075 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8077 pr " int %s = Bool_val (%sv);\n" n n
8079 pr " int %s = Int_val (%sv);\n" n n
8081 pr " int64_t %s = Int64_val (%sv);\n" n n
8084 match fst style with
8085 | RErr -> pr " int r;\n"; "-1"
8086 | RInt _ -> pr " int r;\n"; "-1"
8087 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8088 | RBool _ -> pr " int r;\n"; "-1"
8089 | RConstString _ | RConstOptString _ ->
8090 pr " const char *r;\n"; "NULL"
8091 | RString _ -> pr " char *r;\n"; "NULL"
8096 | RStruct (_, typ) ->
8097 pr " struct guestfs_%s *r;\n" typ; "NULL"
8098 | RStructList (_, typ) ->
8099 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8106 pr " size_t size;\n";
8110 pr " caml_enter_blocking_section ();\n";
8111 pr " r = guestfs_%s " name;
8112 generate_c_call_args ~handle:"g" style;
8114 pr " caml_leave_blocking_section ();\n";
8118 | StringList n | DeviceList n ->
8119 pr " ocaml_guestfs_free_strings (%s);\n" n;
8120 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8121 | Bool _ | Int _ | Int64 _
8122 | FileIn _ | FileOut _ -> ()
8125 pr " if (r == %s)\n" error_code;
8126 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8129 (match fst style with
8130 | RErr -> pr " rv = Val_unit;\n"
8131 | RInt _ -> pr " rv = Val_int (r);\n"
8133 pr " rv = caml_copy_int64 (r);\n"
8134 | RBool _ -> pr " rv = Val_bool (r);\n"
8136 pr " rv = caml_copy_string (r);\n"
8137 | RConstOptString _ ->
8138 pr " if (r) { /* Some string */\n";
8139 pr " v = caml_alloc (1, 0);\n";
8140 pr " v2 = caml_copy_string (r);\n";
8141 pr " Store_field (v, 0, v2);\n";
8142 pr " } else /* None */\n";
8143 pr " v = Val_int (0);\n";
8145 pr " rv = caml_copy_string (r);\n";
8148 pr " rv = caml_copy_string_array ((const char **) r);\n";
8149 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8151 | RStruct (_, typ) ->
8152 pr " rv = copy_%s (r);\n" typ;
8153 pr " guestfs_free_%s (r);\n" typ;
8154 | RStructList (_, typ) ->
8155 pr " rv = copy_%s_list (r);\n" typ;
8156 pr " guestfs_free_%s_list (r);\n" typ;
8158 pr " rv = copy_table (r);\n";
8159 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8162 pr " rv = caml_alloc_string (size);\n";
8163 pr " memcpy (String_val (rv), r, size);\n";
8166 pr " CAMLreturn (rv);\n";
8170 if List.length params > 5 then (
8171 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8172 pr "CAMLprim value ";
8173 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8174 pr "CAMLprim value\n";
8175 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8177 pr " return ocaml_guestfs_%s (argv[0]" name;
8178 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8183 ) all_functions_sorted
8185 and generate_ocaml_structure_decls () =
8188 pr "type %s = {\n" typ;
8191 | name, FString -> pr " %s : string;\n" name
8192 | name, FBuffer -> pr " %s : string;\n" name
8193 | name, FUUID -> pr " %s : string;\n" name
8194 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8195 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8196 | name, FChar -> pr " %s : char;\n" name
8197 | name, FOptPercent -> pr " %s : float option;\n" name
8203 and generate_ocaml_prototype ?(is_external = false) name style =
8204 if is_external then pr "external " else pr "val ";
8205 pr "%s : t -> " name;
8208 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "string -> "
8209 | OptString _ -> pr "string option -> "
8210 | StringList _ | DeviceList _ -> pr "string array -> "
8211 | Bool _ -> pr "bool -> "
8212 | Int _ -> pr "int -> "
8213 | Int64 _ -> pr "int64 -> "
8215 (match fst style with
8216 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8217 | RInt _ -> pr "int"
8218 | RInt64 _ -> pr "int64"
8219 | RBool _ -> pr "bool"
8220 | RConstString _ -> pr "string"
8221 | RConstOptString _ -> pr "string option"
8222 | RString _ | RBufferOut _ -> pr "string"
8223 | RStringList _ -> pr "string array"
8224 | RStruct (_, typ) -> pr "%s" typ
8225 | RStructList (_, typ) -> pr "%s array" typ
8226 | RHashtable _ -> pr "(string * string) list"
8228 if is_external then (
8230 if List.length (snd style) + 1 > 5 then
8231 pr "\"ocaml_guestfs_%s_byte\" " name;
8232 pr "\"ocaml_guestfs_%s\"" name
8236 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8237 and generate_perl_xs () =
8238 generate_header CStyle LGPLv2plus;
8241 #include \"EXTERN.h\"
8245 #include <guestfs.h>
8248 #define PRId64 \"lld\"
8252 my_newSVll(long long val) {
8253 #ifdef USE_64_BIT_ALL
8254 return newSViv(val);
8258 len = snprintf(buf, 100, \"%%\" PRId64, val);
8259 return newSVpv(buf, len);
8264 #define PRIu64 \"llu\"
8268 my_newSVull(unsigned long long val) {
8269 #ifdef USE_64_BIT_ALL
8270 return newSVuv(val);
8274 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8275 return newSVpv(buf, len);
8279 /* http://www.perlmonks.org/?node_id=680842 */
8281 XS_unpack_charPtrPtr (SV *arg) {
8286 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8287 croak (\"array reference expected\");
8289 av = (AV *)SvRV (arg);
8290 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8292 croak (\"malloc failed\");
8294 for (i = 0; i <= av_len (av); i++) {
8295 SV **elem = av_fetch (av, i, 0);
8297 if (!elem || !*elem)
8298 croak (\"missing element in list\");
8300 ret[i] = SvPV_nolen (*elem);
8308 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8315 RETVAL = guestfs_create ();
8317 croak (\"could not create guestfs handle\");
8318 guestfs_set_error_handler (RETVAL, NULL, NULL);
8331 fun (name, style, _, _, _, _, _) ->
8332 (match fst style with
8333 | RErr -> pr "void\n"
8334 | RInt _ -> pr "SV *\n"
8335 | RInt64 _ -> pr "SV *\n"
8336 | RBool _ -> pr "SV *\n"
8337 | RConstString _ -> pr "SV *\n"
8338 | RConstOptString _ -> pr "SV *\n"
8339 | RString _ -> pr "SV *\n"
8340 | RBufferOut _ -> pr "SV *\n"
8342 | RStruct _ | RStructList _
8344 pr "void\n" (* all lists returned implictly on the stack *)
8346 (* Call and arguments. *)
8348 generate_c_call_args ~handle:"g" ~decl:true style;
8350 pr " guestfs_h *g;\n";
8354 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
8357 (* http://www.perlmonks.org/?node_id=554277
8358 * Note that the implicit handle argument means we have
8359 * to add 1 to the ST(x) operator.
8361 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8362 | StringList n | DeviceList n -> pr " char **%s;\n" n
8363 | Bool n -> pr " int %s;\n" n
8364 | Int n -> pr " int %s;\n" n
8365 | Int64 n -> pr " int64_t %s;\n" n
8368 let do_cleanups () =
8371 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8372 | Bool _ | Int _ | Int64 _
8373 | FileIn _ | FileOut _ -> ()
8374 | StringList n | DeviceList n -> pr " free (%s);\n" n
8379 (match fst style with
8384 pr " r = guestfs_%s " name;
8385 generate_c_call_args ~handle:"g" style;
8388 pr " if (r == -1)\n";
8389 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8395 pr " %s = guestfs_%s " n name;
8396 generate_c_call_args ~handle:"g" style;
8399 pr " if (%s == -1)\n" n;
8400 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8401 pr " RETVAL = newSViv (%s);\n" n;
8406 pr " int64_t %s;\n" n;
8408 pr " %s = guestfs_%s " n name;
8409 generate_c_call_args ~handle:"g" style;
8412 pr " if (%s == -1)\n" n;
8413 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8414 pr " RETVAL = my_newSVll (%s);\n" n;
8419 pr " const char *%s;\n" n;
8421 pr " %s = guestfs_%s " n name;
8422 generate_c_call_args ~handle:"g" style;
8425 pr " if (%s == NULL)\n" n;
8426 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8427 pr " RETVAL = newSVpv (%s, 0);\n" n;
8430 | RConstOptString n ->
8432 pr " const char *%s;\n" n;
8434 pr " %s = guestfs_%s " n name;
8435 generate_c_call_args ~handle:"g" style;
8438 pr " if (%s == NULL)\n" n;
8439 pr " RETVAL = &PL_sv_undef;\n";
8441 pr " RETVAL = newSVpv (%s, 0);\n" n;
8446 pr " char *%s;\n" n;
8448 pr " %s = guestfs_%s " n name;
8449 generate_c_call_args ~handle:"g" style;
8452 pr " if (%s == NULL)\n" n;
8453 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8454 pr " RETVAL = newSVpv (%s, 0);\n" n;
8455 pr " free (%s);\n" n;
8458 | RStringList n | RHashtable n ->
8460 pr " char **%s;\n" n;
8463 pr " %s = guestfs_%s " n name;
8464 generate_c_call_args ~handle:"g" style;
8467 pr " if (%s == NULL)\n" n;
8468 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8469 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8470 pr " EXTEND (SP, n);\n";
8471 pr " for (i = 0; i < n; ++i) {\n";
8472 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8473 pr " free (%s[i]);\n" n;
8475 pr " free (%s);\n" n;
8476 | RStruct (n, typ) ->
8477 let cols = cols_of_struct typ in
8478 generate_perl_struct_code typ cols name style n do_cleanups
8479 | RStructList (n, typ) ->
8480 let cols = cols_of_struct typ in
8481 generate_perl_struct_list_code typ cols name style n do_cleanups
8484 pr " char *%s;\n" n;
8485 pr " size_t size;\n";
8487 pr " %s = guestfs_%s " n name;
8488 generate_c_call_args ~handle:"g" style;
8491 pr " if (%s == NULL)\n" n;
8492 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8493 pr " RETVAL = newSVpvn (%s, size);\n" n;
8494 pr " free (%s);\n" n;
8502 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8504 pr " struct guestfs_%s_list *%s;\n" typ n;
8508 pr " %s = guestfs_%s " n name;
8509 generate_c_call_args ~handle:"g" style;
8512 pr " if (%s == NULL)\n" n;
8513 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8514 pr " EXTEND (SP, %s->len);\n" n;
8515 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8516 pr " hv = newHV ();\n";
8520 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8521 name (String.length name) n name
8523 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8524 name (String.length name) n name
8526 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8527 name (String.length name) n name n name
8528 | name, (FBytes|FUInt64) ->
8529 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8530 name (String.length name) n name
8532 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8533 name (String.length name) n name
8534 | name, (FInt32|FUInt32) ->
8535 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8536 name (String.length name) n name
8538 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8539 name (String.length name) n name
8540 | name, FOptPercent ->
8541 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8542 name (String.length name) n name
8544 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8546 pr " guestfs_free_%s_list (%s);\n" typ n
8548 and generate_perl_struct_code typ cols name style n do_cleanups =
8550 pr " struct guestfs_%s *%s;\n" typ n;
8552 pr " %s = guestfs_%s " n name;
8553 generate_c_call_args ~handle:"g" style;
8556 pr " if (%s == NULL)\n" n;
8557 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8558 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8560 fun ((name, _) as col) ->
8561 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8565 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8568 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8571 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8573 | name, (FBytes|FUInt64) ->
8574 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8577 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8579 | name, (FInt32|FUInt32) ->
8580 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8583 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8585 | name, FOptPercent ->
8586 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8589 pr " free (%s);\n" n
8591 (* Generate Sys/Guestfs.pm. *)
8592 and generate_perl_pm () =
8593 generate_header HashStyle LGPLv2plus;
8600 Sys::Guestfs - Perl bindings for libguestfs
8606 my $h = Sys::Guestfs->new ();
8607 $h->add_drive ('guest.img');
8609 $h->mount ('/dev/sda1', '/');
8610 $h->touch ('/hello');
8615 The C<Sys::Guestfs> module provides a Perl XS binding to the
8616 libguestfs API for examining and modifying virtual machine
8619 Amongst the things this is good for: making batch configuration
8620 changes to guests, getting disk used/free statistics (see also:
8621 virt-df), migrating between virtualization systems (see also:
8622 virt-p2v), performing partial backups, performing partial guest
8623 clones, cloning guests and changing registry/UUID/hostname info, and
8626 Libguestfs uses Linux kernel and qemu code, and can access any type of
8627 guest filesystem that Linux and qemu can, including but not limited
8628 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8629 schemes, qcow, qcow2, vmdk.
8631 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8632 LVs, what filesystem is in each LV, etc.). It can also run commands
8633 in the context of the guest. Also you can access filesystems over
8636 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8637 functions for using libguestfs from Perl, including integration
8642 All errors turn into calls to C<croak> (see L<Carp(3)>).
8650 package Sys::Guestfs;
8656 XSLoader::load ('Sys::Guestfs');
8658 =item $h = Sys::Guestfs->new ();
8660 Create a new guestfs handle.
8666 my $class = ref ($proto) || $proto;
8668 my $self = Sys::Guestfs::_create ();
8669 bless $self, $class;
8675 (* Actions. We only need to print documentation for these as
8676 * they are pulled in from the XS code automatically.
8679 fun (name, style, _, flags, _, _, longdesc) ->
8680 if not (List.mem NotInDocs flags) then (
8681 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8683 generate_perl_prototype name style;
8685 pr "%s\n\n" longdesc;
8686 if List.mem ProtocolLimitWarning flags then
8687 pr "%s\n\n" protocol_limit_warning;
8688 if List.mem DangerWillRobinson flags then
8689 pr "%s\n\n" danger_will_robinson;
8690 match deprecation_notice flags with
8692 | Some txt -> pr "%s\n\n" txt
8694 ) all_functions_sorted;
8706 Copyright (C) %s Red Hat Inc.
8710 Please see the file COPYING.LIB for the full license.
8716 L<http://libguestfs.org>,
8717 L<Sys::Guestfs::Lib(3)>.
8722 and generate_perl_prototype name style =
8723 (match fst style with
8731 | RBufferOut n -> pr "$%s = " n
8733 | RHashtable n -> pr "%%%s = " n
8735 | RStructList (n,_) -> pr "@%s = " n
8738 let comma = ref false in
8741 if !comma then pr ", ";
8744 | Pathname n | Device n | Dev_or_Path n | String n
8745 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n ->
8747 | StringList n | DeviceList n ->
8752 (* Generate Python C module. *)
8753 and generate_python_c () =
8754 generate_header CStyle LGPLv2plus;
8763 #include \"guestfs.h\"
8771 get_handle (PyObject *obj)
8774 assert (obj != Py_None);
8775 return ((Pyguestfs_Object *) obj)->g;
8779 put_handle (guestfs_h *g)
8783 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
8786 /* This list should be freed (but not the strings) after use. */
8788 get_string_list (PyObject *obj)
8795 if (!PyList_Check (obj)) {
8796 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
8800 len = PyList_Size (obj);
8801 r = malloc (sizeof (char *) * (len+1));
8803 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
8807 for (i = 0; i < len; ++i)
8808 r[i] = PyString_AsString (PyList_GetItem (obj, i));
8815 put_string_list (char * const * const argv)
8820 for (argc = 0; argv[argc] != NULL; ++argc)
8823 list = PyList_New (argc);
8824 for (i = 0; i < argc; ++i)
8825 PyList_SetItem (list, i, PyString_FromString (argv[i]));
8831 put_table (char * const * const argv)
8833 PyObject *list, *item;
8836 for (argc = 0; argv[argc] != NULL; ++argc)
8839 list = PyList_New (argc >> 1);
8840 for (i = 0; i < argc; i += 2) {
8841 item = PyTuple_New (2);
8842 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
8843 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
8844 PyList_SetItem (list, i >> 1, item);
8851 free_strings (char **argv)
8855 for (argc = 0; argv[argc] != NULL; ++argc)
8861 py_guestfs_create (PyObject *self, PyObject *args)
8865 g = guestfs_create ();
8867 PyErr_SetString (PyExc_RuntimeError,
8868 \"guestfs.create: failed to allocate handle\");
8871 guestfs_set_error_handler (g, NULL, NULL);
8872 return put_handle (g);
8876 py_guestfs_close (PyObject *self, PyObject *args)
8881 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
8883 g = get_handle (py_g);
8887 Py_INCREF (Py_None);
8893 let emit_put_list_function typ =
8894 pr "static PyObject *\n";
8895 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
8897 pr " PyObject *list;\n";
8900 pr " list = PyList_New (%ss->len);\n" typ;
8901 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
8902 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
8903 pr " return list;\n";
8908 (* Structures, turned into Python dictionaries. *)
8911 pr "static PyObject *\n";
8912 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
8914 pr " PyObject *dict;\n";
8916 pr " dict = PyDict_New ();\n";
8920 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8921 pr " PyString_FromString (%s->%s));\n"
8924 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8925 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
8928 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8929 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
8931 | name, (FBytes|FUInt64) ->
8932 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8933 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
8936 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8937 pr " PyLong_FromLongLong (%s->%s));\n"
8940 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8941 pr " PyLong_FromUnsignedLong (%s->%s));\n"
8944 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8945 pr " PyLong_FromLong (%s->%s));\n"
8947 | name, FOptPercent ->
8948 pr " if (%s->%s >= 0)\n" typ name;
8949 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8950 pr " PyFloat_FromDouble ((double) %s->%s));\n"
8953 pr " Py_INCREF (Py_None);\n";
8954 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
8957 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
8958 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
8960 pr " return dict;\n";
8966 (* Emit a put_TYPE_list function definition only if that function is used. *)
8969 | typ, (RStructListOnly | RStructAndList) ->
8970 (* generate the function for typ *)
8971 emit_put_list_function typ
8972 | typ, _ -> () (* empty *)
8973 ) (rstructs_used_by all_functions);
8975 (* Python wrapper functions. *)
8977 fun (name, style, _, _, _, _, _) ->
8978 pr "static PyObject *\n";
8979 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
8982 pr " PyObject *py_g;\n";
8983 pr " guestfs_h *g;\n";
8984 pr " PyObject *py_r;\n";
8987 match fst style with
8988 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8989 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8990 | RConstString _ | RConstOptString _ ->
8991 pr " const char *r;\n"; "NULL"
8992 | RString _ -> pr " char *r;\n"; "NULL"
8993 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
8994 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
8995 | RStructList (_, typ) ->
8996 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8999 pr " size_t size;\n";
9004 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9005 pr " const char *%s;\n" n
9006 | OptString n -> pr " const char *%s;\n" n
9007 | StringList n | DeviceList n ->
9008 pr " PyObject *py_%s;\n" n;
9009 pr " char **%s;\n" n
9010 | Bool n -> pr " int %s;\n" n
9011 | Int n -> pr " int %s;\n" n
9012 | Int64 n -> pr " long long %s;\n" n
9017 (* Convert the parameters. *)
9018 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9021 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9022 | OptString _ -> pr "z"
9023 | StringList _ | DeviceList _ -> pr "O"
9024 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9026 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9027 * emulate C's int/long/long long in Python?
9030 pr ":guestfs_%s\",\n" name;
9034 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9035 | OptString n -> pr ", &%s" n
9036 | StringList n | DeviceList n -> pr ", &py_%s" n
9037 | Bool n -> pr ", &%s" n
9038 | Int n -> pr ", &%s" n
9039 | Int64 n -> pr ", &%s" n
9043 pr " return NULL;\n";
9045 pr " g = get_handle (py_g);\n";
9048 | Pathname _ | Device _ | Dev_or_Path _ | String _
9049 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9050 | StringList n | DeviceList n ->
9051 pr " %s = get_string_list (py_%s);\n" n n;
9052 pr " if (!%s) return NULL;\n" n
9057 pr " r = guestfs_%s " name;
9058 generate_c_call_args ~handle:"g" style;
9063 | Pathname _ | Device _ | Dev_or_Path _ | String _
9064 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9065 | StringList n | DeviceList n ->
9066 pr " free (%s);\n" n
9069 pr " if (r == %s) {\n" error_code;
9070 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9071 pr " return NULL;\n";
9075 (match fst style with
9077 pr " Py_INCREF (Py_None);\n";
9078 pr " py_r = Py_None;\n"
9080 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9081 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9082 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9083 | RConstOptString _ ->
9085 pr " py_r = PyString_FromString (r);\n";
9087 pr " Py_INCREF (Py_None);\n";
9088 pr " py_r = Py_None;\n";
9091 pr " py_r = PyString_FromString (r);\n";
9094 pr " py_r = put_string_list (r);\n";
9095 pr " free_strings (r);\n"
9096 | RStruct (_, typ) ->
9097 pr " py_r = put_%s (r);\n" typ;
9098 pr " guestfs_free_%s (r);\n" typ
9099 | RStructList (_, typ) ->
9100 pr " py_r = put_%s_list (r);\n" typ;
9101 pr " guestfs_free_%s_list (r);\n" typ
9103 pr " py_r = put_table (r);\n";
9104 pr " free_strings (r);\n"
9106 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9110 pr " return py_r;\n";
9115 (* Table of functions. *)
9116 pr "static PyMethodDef methods[] = {\n";
9117 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9118 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9120 fun (name, _, _, _, _, _, _) ->
9121 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9124 pr " { NULL, NULL, 0, NULL }\n";
9128 (* Init function. *)
9131 initlibguestfsmod (void)
9133 static int initialized = 0;
9135 if (initialized) return;
9136 Py_InitModule ((char *) \"libguestfsmod\", methods);
9141 (* Generate Python module. *)
9142 and generate_python_py () =
9143 generate_header HashStyle LGPLv2plus;
9146 u\"\"\"Python bindings for libguestfs
9149 g = guestfs.GuestFS ()
9150 g.add_drive (\"guest.img\")
9152 parts = g.list_partitions ()
9154 The guestfs module provides a Python binding to the libguestfs API
9155 for examining and modifying virtual machine disk images.
9157 Amongst the things this is good for: making batch configuration
9158 changes to guests, getting disk used/free statistics (see also:
9159 virt-df), migrating between virtualization systems (see also:
9160 virt-p2v), performing partial backups, performing partial guest
9161 clones, cloning guests and changing registry/UUID/hostname info, and
9164 Libguestfs uses Linux kernel and qemu code, and can access any type of
9165 guest filesystem that Linux and qemu can, including but not limited
9166 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9167 schemes, qcow, qcow2, vmdk.
9169 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9170 LVs, what filesystem is in each LV, etc.). It can also run commands
9171 in the context of the guest. Also you can access filesystems over
9174 Errors which happen while using the API are turned into Python
9175 RuntimeError exceptions.
9177 To create a guestfs handle you usually have to perform the following
9180 # Create the handle, call add_drive at least once, and possibly
9181 # several times if the guest has multiple block devices:
9182 g = guestfs.GuestFS ()
9183 g.add_drive (\"guest.img\")
9185 # Launch the qemu subprocess and wait for it to become ready:
9188 # Now you can issue commands, for example:
9193 import libguestfsmod
9196 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9198 def __init__ (self):
9199 \"\"\"Create a new libguestfs handle.\"\"\"
9200 self._o = libguestfsmod.create ()
9203 libguestfsmod.close (self._o)
9208 fun (name, style, _, flags, _, _, longdesc) ->
9210 generate_py_call_args ~handle:"self" (snd style);
9213 if not (List.mem NotInDocs flags) then (
9214 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9216 match fst style with
9217 | RErr | RInt _ | RInt64 _ | RBool _
9218 | RConstOptString _ | RConstString _
9219 | RString _ | RBufferOut _ -> doc
9221 doc ^ "\n\nThis function returns a list of strings."
9222 | RStruct (_, typ) ->
9223 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9224 | RStructList (_, typ) ->
9225 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9227 doc ^ "\n\nThis function returns a dictionary." in
9229 if List.mem ProtocolLimitWarning flags then
9230 doc ^ "\n\n" ^ protocol_limit_warning
9233 if List.mem DangerWillRobinson flags then
9234 doc ^ "\n\n" ^ danger_will_robinson
9237 match deprecation_notice flags with
9239 | Some txt -> doc ^ "\n\n" ^ txt in
9240 let doc = pod2text ~width:60 name doc in
9241 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9242 let doc = String.concat "\n " doc in
9243 pr " u\"\"\"%s\"\"\"\n" doc;
9245 pr " return libguestfsmod.%s " name;
9246 generate_py_call_args ~handle:"self._o" (snd style);
9251 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9252 and generate_py_call_args ~handle args =
9254 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9257 (* Useful if you need the longdesc POD text as plain text. Returns a
9260 * Because this is very slow (the slowest part of autogeneration),
9261 * we memoize the results.
9263 and pod2text ~width name longdesc =
9264 let key = width, name, longdesc in
9265 try Hashtbl.find pod2text_memo key
9267 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9268 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9270 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9271 let chan = open_process_in cmd in
9272 let lines = ref [] in
9274 let line = input_line chan in
9275 if i = 1 then (* discard the first line of output *)
9278 let line = triml line in
9279 lines := line :: !lines;
9282 let lines = try loop 1 with End_of_file -> List.rev !lines in
9284 (match close_process_in chan with
9287 failwithf "pod2text: process exited with non-zero status (%d)" i
9288 | WSIGNALED i | WSTOPPED i ->
9289 failwithf "pod2text: process signalled or stopped by signal %d" i
9291 Hashtbl.add pod2text_memo key lines;
9292 pod2text_memo_updated ();
9295 (* Generate ruby bindings. *)
9296 and generate_ruby_c () =
9297 generate_header CStyle LGPLv2plus;
9305 #include \"guestfs.h\"
9307 #include \"extconf.h\"
9309 /* For Ruby < 1.9 */
9311 #define RARRAY_LEN(r) (RARRAY((r))->len)
9314 static VALUE m_guestfs; /* guestfs module */
9315 static VALUE c_guestfs; /* guestfs_h handle */
9316 static VALUE e_Error; /* used for all errors */
9318 static void ruby_guestfs_free (void *p)
9321 guestfs_close ((guestfs_h *) p);
9324 static VALUE ruby_guestfs_create (VALUE m)
9328 g = guestfs_create ();
9330 rb_raise (e_Error, \"failed to create guestfs handle\");
9332 /* Don't print error messages to stderr by default. */
9333 guestfs_set_error_handler (g, NULL, NULL);
9335 /* Wrap it, and make sure the close function is called when the
9338 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9341 static VALUE ruby_guestfs_close (VALUE gv)
9344 Data_Get_Struct (gv, guestfs_h, g);
9346 ruby_guestfs_free (g);
9347 DATA_PTR (gv) = NULL;
9355 fun (name, style, _, _, _, _, _) ->
9356 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9357 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9360 pr " guestfs_h *g;\n";
9361 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9363 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9369 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9370 pr " Check_Type (%sv, T_STRING);\n" n;
9371 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9373 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9374 pr " \"%s\", \"%s\");\n" n name
9376 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9377 | StringList n | DeviceList n ->
9378 pr " char **%s;\n" n;
9379 pr " Check_Type (%sv, T_ARRAY);\n" n;
9381 pr " int i, len;\n";
9382 pr " len = RARRAY_LEN (%sv);\n" n;
9383 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9385 pr " for (i = 0; i < len; ++i) {\n";
9386 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9387 pr " %s[i] = StringValueCStr (v);\n" n;
9389 pr " %s[len] = NULL;\n" n;
9392 pr " int %s = RTEST (%sv);\n" n n
9394 pr " int %s = NUM2INT (%sv);\n" n n
9396 pr " long long %s = NUM2LL (%sv);\n" n n
9401 match fst style with
9402 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9403 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9404 | RConstString _ | RConstOptString _ ->
9405 pr " const char *r;\n"; "NULL"
9406 | RString _ -> pr " char *r;\n"; "NULL"
9407 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9408 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9409 | RStructList (_, typ) ->
9410 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9413 pr " size_t size;\n";
9417 pr " r = guestfs_%s " name;
9418 generate_c_call_args ~handle:"g" style;
9423 | Pathname _ | Device _ | Dev_or_Path _ | String _
9424 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _ -> ()
9425 | StringList n | DeviceList n ->
9426 pr " free (%s);\n" n
9429 pr " if (r == %s)\n" error_code;
9430 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9433 (match fst style with
9435 pr " return Qnil;\n"
9436 | RInt _ | RBool _ ->
9437 pr " return INT2NUM (r);\n"
9439 pr " return ULL2NUM (r);\n"
9441 pr " return rb_str_new2 (r);\n";
9442 | RConstOptString _ ->
9444 pr " return rb_str_new2 (r);\n";
9446 pr " return Qnil;\n";
9448 pr " VALUE rv = rb_str_new2 (r);\n";
9452 pr " int i, len = 0;\n";
9453 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9454 pr " VALUE rv = rb_ary_new2 (len);\n";
9455 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9456 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9457 pr " free (r[i]);\n";
9461 | RStruct (_, typ) ->
9462 let cols = cols_of_struct typ in
9463 generate_ruby_struct_code typ cols
9464 | RStructList (_, typ) ->
9465 let cols = cols_of_struct typ in
9466 generate_ruby_struct_list_code typ cols
9468 pr " VALUE rv = rb_hash_new ();\n";
9470 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9471 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9472 pr " free (r[i]);\n";
9473 pr " free (r[i+1]);\n";
9478 pr " VALUE rv = rb_str_new (r, size);\n";
9488 /* Initialize the module. */
9489 void Init__guestfs ()
9491 m_guestfs = rb_define_module (\"Guestfs\");
9492 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9493 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9495 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9496 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9499 (* Define the rest of the methods. *)
9501 fun (name, style, _, _, _, _, _) ->
9502 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9503 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9508 (* Ruby code to return a struct. *)
9509 and generate_ruby_struct_code typ cols =
9510 pr " VALUE rv = rb_hash_new ();\n";
9514 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9516 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9518 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9519 | name, (FBytes|FUInt64) ->
9520 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9522 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9524 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9526 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9527 | name, FOptPercent ->
9528 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9529 | name, FChar -> (* XXX wrong? *)
9530 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9532 pr " guestfs_free_%s (r);\n" typ;
9535 (* Ruby code to return a struct list. *)
9536 and generate_ruby_struct_list_code typ cols =
9537 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9539 pr " for (i = 0; i < r->len; ++i) {\n";
9540 pr " VALUE hv = rb_hash_new ();\n";
9544 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9546 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
9548 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9549 | name, (FBytes|FUInt64) ->
9550 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9552 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9554 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9556 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9557 | name, FOptPercent ->
9558 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9559 | name, FChar -> (* XXX wrong? *)
9560 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9562 pr " rb_ary_push (rv, hv);\n";
9564 pr " guestfs_free_%s_list (r);\n" typ;
9567 (* Generate Java bindings GuestFS.java file. *)
9568 and generate_java_java () =
9569 generate_header CStyle LGPLv2plus;
9572 package com.redhat.et.libguestfs;
9574 import java.util.HashMap;
9575 import com.redhat.et.libguestfs.LibGuestFSException;
9576 import com.redhat.et.libguestfs.PV;
9577 import com.redhat.et.libguestfs.VG;
9578 import com.redhat.et.libguestfs.LV;
9579 import com.redhat.et.libguestfs.Stat;
9580 import com.redhat.et.libguestfs.StatVFS;
9581 import com.redhat.et.libguestfs.IntBool;
9582 import com.redhat.et.libguestfs.Dirent;
9585 * The GuestFS object is a libguestfs handle.
9589 public class GuestFS {
9590 // Load the native code.
9592 System.loadLibrary (\"guestfs_jni\");
9596 * The native guestfs_h pointer.
9601 * Create a libguestfs handle.
9603 * @throws LibGuestFSException
9605 public GuestFS () throws LibGuestFSException
9609 private native long _create () throws LibGuestFSException;
9612 * Close a libguestfs handle.
9614 * You can also leave handles to be collected by the garbage
9615 * collector, but this method ensures that the resources used
9616 * by the handle are freed up immediately. If you call any
9617 * other methods after closing the handle, you will get an
9620 * @throws LibGuestFSException
9622 public void close () throws LibGuestFSException
9628 private native void _close (long g) throws LibGuestFSException;
9630 public void finalize () throws LibGuestFSException
9638 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9639 if not (List.mem NotInDocs flags); then (
9640 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9642 if List.mem ProtocolLimitWarning flags then
9643 doc ^ "\n\n" ^ protocol_limit_warning
9646 if List.mem DangerWillRobinson flags then
9647 doc ^ "\n\n" ^ danger_will_robinson
9650 match deprecation_notice flags with
9652 | Some txt -> doc ^ "\n\n" ^ txt in
9653 let doc = pod2text ~width:60 name doc in
9654 let doc = List.map ( (* RHBZ#501883 *)
9657 | nonempty -> nonempty
9659 let doc = String.concat "\n * " doc in
9662 pr " * %s\n" shortdesc;
9665 pr " * @throws LibGuestFSException\n";
9669 generate_java_prototype ~public:true ~semicolon:false name style;
9672 pr " if (g == 0)\n";
9673 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9676 if fst style <> RErr then pr "return ";
9678 generate_java_call_args ~handle:"g" (snd style);
9682 generate_java_prototype ~privat:true ~native:true name style;
9689 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
9690 and generate_java_call_args ~handle args =
9692 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9695 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
9696 ?(semicolon=true) name style =
9697 if privat then pr "private ";
9698 if public then pr "public ";
9699 if native then pr "native ";
9702 (match fst style with
9703 | RErr -> pr "void ";
9704 | RInt _ -> pr "int ";
9705 | RInt64 _ -> pr "long ";
9706 | RBool _ -> pr "boolean ";
9707 | RConstString _ | RConstOptString _ | RString _
9708 | RBufferOut _ -> pr "String ";
9709 | RStringList _ -> pr "String[] ";
9710 | RStruct (_, typ) ->
9711 let name = java_name_of_struct typ in
9713 | RStructList (_, typ) ->
9714 let name = java_name_of_struct typ in
9716 | RHashtable _ -> pr "HashMap<String,String> ";
9719 if native then pr "_%s " name else pr "%s " name;
9721 let needs_comma = ref false in
9730 if !needs_comma then pr ", ";
9731 needs_comma := true;
9735 | Device n | Dev_or_Path n
9741 | StringList n | DeviceList n ->
9752 pr " throws LibGuestFSException";
9753 if semicolon then pr ";"
9755 and generate_java_struct jtyp cols () =
9756 generate_header CStyle LGPLv2plus;
9759 package com.redhat.et.libguestfs;
9762 * Libguestfs %s structure.
9774 | name, FBuffer -> pr " public String %s;\n" name
9775 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
9776 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
9777 | name, FChar -> pr " public char %s;\n" name
9778 | name, FOptPercent ->
9779 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
9780 pr " public float %s;\n" name
9785 and generate_java_c () =
9786 generate_header CStyle LGPLv2plus;
9793 #include \"com_redhat_et_libguestfs_GuestFS.h\"
9794 #include \"guestfs.h\"
9796 /* Note that this function returns. The exception is not thrown
9797 * until after the wrapper function returns.
9800 throw_exception (JNIEnv *env, const char *msg)
9803 cl = (*env)->FindClass (env,
9804 \"com/redhat/et/libguestfs/LibGuestFSException\");
9805 (*env)->ThrowNew (env, cl, msg);
9808 JNIEXPORT jlong JNICALL
9809 Java_com_redhat_et_libguestfs_GuestFS__1create
9810 (JNIEnv *env, jobject obj)
9814 g = guestfs_create ();
9816 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
9819 guestfs_set_error_handler (g, NULL, NULL);
9820 return (jlong) (long) g;
9823 JNIEXPORT void JNICALL
9824 Java_com_redhat_et_libguestfs_GuestFS__1close
9825 (JNIEnv *env, jobject obj, jlong jg)
9827 guestfs_h *g = (guestfs_h *) (long) jg;
9834 fun (name, style, _, _, _, _, _) ->
9836 (match fst style with
9837 | RErr -> pr "void ";
9838 | RInt _ -> pr "jint ";
9839 | RInt64 _ -> pr "jlong ";
9840 | RBool _ -> pr "jboolean ";
9841 | RConstString _ | RConstOptString _ | RString _
9842 | RBufferOut _ -> pr "jstring ";
9843 | RStruct _ | RHashtable _ ->
9845 | RStringList _ | RStructList _ ->
9849 pr "Java_com_redhat_et_libguestfs_GuestFS_";
9850 pr "%s" (replace_str ("_" ^ name) "_" "_1");
9852 pr " (JNIEnv *env, jobject obj, jlong jg";
9856 | Device n | Dev_or_Path n
9861 pr ", jstring j%s" n
9862 | StringList n | DeviceList n ->
9863 pr ", jobjectArray j%s" n
9865 pr ", jboolean j%s" n
9873 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
9874 let error_code, no_ret =
9875 match fst style with
9876 | RErr -> pr " int r;\n"; "-1", ""
9878 | RInt _ -> pr " int r;\n"; "-1", "0"
9879 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
9880 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
9881 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
9883 pr " jstring jr;\n";
9884 pr " char *r;\n"; "NULL", "NULL"
9886 pr " jobjectArray jr;\n";
9889 pr " jstring jstr;\n";
9890 pr " char **r;\n"; "NULL", "NULL"
9891 | RStruct (_, typ) ->
9892 pr " jobject jr;\n";
9894 pr " jfieldID fl;\n";
9895 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
9896 | RStructList (_, typ) ->
9897 pr " jobjectArray jr;\n";
9899 pr " jfieldID fl;\n";
9900 pr " jobject jfl;\n";
9901 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
9902 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
9904 pr " jstring jr;\n";
9906 pr " size_t size;\n";
9911 | Device n | Dev_or_Path n
9916 pr " const char *%s;\n" n
9917 | StringList n | DeviceList n ->
9918 pr " int %s_len;\n" n;
9919 pr " const char **%s;\n" n
9924 pr " int64_t %s;\n" n
9928 (match fst style with
9929 | RStringList _ | RStructList _ -> true
9930 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
9932 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
9933 List.exists (function
9934 | StringList _ -> true
9935 | DeviceList _ -> true
9936 | _ -> false) (snd style) in
9942 (* Get the parameters. *)
9946 | Device n | Dev_or_Path n
9950 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
9952 (* This is completely undocumented, but Java null becomes
9955 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
9956 | StringList n | DeviceList n ->
9957 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
9958 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
9959 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9960 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9962 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
9964 pr " %s[%s_len] = NULL;\n" n n;
9968 pr " %s = j%s;\n" n n
9971 (* Make the call. *)
9972 pr " r = guestfs_%s " name;
9973 generate_c_call_args ~handle:"g" style;
9976 (* Release the parameters. *)
9980 | Device n | Dev_or_Path n
9984 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9987 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
9988 | StringList n | DeviceList n ->
9989 pr " for (i = 0; i < %s_len; ++i) {\n" n;
9990 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
9992 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
9994 pr " free (%s);\n" n
10000 (* Check for errors. *)
10001 pr " if (r == %s) {\n" error_code;
10002 pr " throw_exception (env, guestfs_last_error (g));\n";
10003 pr " return %s;\n" no_ret;
10006 (* Return value. *)
10007 (match fst style with
10009 | RInt _ -> pr " return (jint) r;\n"
10010 | RBool _ -> pr " return (jboolean) r;\n"
10011 | RInt64 _ -> pr " return (jlong) r;\n"
10012 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10013 | RConstOptString _ ->
10014 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10016 pr " jr = (*env)->NewStringUTF (env, r);\n";
10020 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10021 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10022 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10023 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10024 pr " for (i = 0; i < r_len; ++i) {\n";
10025 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10026 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10027 pr " free (r[i]);\n";
10031 | RStruct (_, typ) ->
10032 let jtyp = java_name_of_struct typ in
10033 let cols = cols_of_struct typ in
10034 generate_java_struct_return typ jtyp cols
10035 | RStructList (_, typ) ->
10036 let jtyp = java_name_of_struct typ in
10037 let cols = cols_of_struct typ in
10038 generate_java_struct_list_return typ jtyp cols
10041 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10042 pr " return NULL;\n"
10044 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10053 and generate_java_struct_return typ jtyp cols =
10054 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10055 pr " jr = (*env)->AllocObject (env, cl);\n";
10059 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10060 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10063 pr " char s[33];\n";
10064 pr " memcpy (s, r->%s, 32);\n" name;
10065 pr " s[32] = 0;\n";
10066 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10067 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10071 pr " int len = r->%s_len;\n" name;
10072 pr " char s[len+1];\n";
10073 pr " memcpy (s, r->%s, len);\n" name;
10074 pr " s[len] = 0;\n";
10075 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10076 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10078 | name, (FBytes|FUInt64|FInt64) ->
10079 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10080 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10081 | name, (FUInt32|FInt32) ->
10082 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10083 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10084 | name, FOptPercent ->
10085 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10086 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10088 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10089 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10094 and generate_java_struct_list_return typ jtyp cols =
10095 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10096 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10097 pr " for (i = 0; i < r->len; ++i) {\n";
10098 pr " jfl = (*env)->AllocObject (env, cl);\n";
10102 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10103 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10106 pr " char s[33];\n";
10107 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10108 pr " s[32] = 0;\n";
10109 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10110 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10114 pr " int len = r->val[i].%s_len;\n" name;
10115 pr " char s[len+1];\n";
10116 pr " memcpy (s, r->val[i].%s, len);\n" name;
10117 pr " s[len] = 0;\n";
10118 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10119 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10121 | name, (FBytes|FUInt64|FInt64) ->
10122 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10123 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10124 | name, (FUInt32|FInt32) ->
10125 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10126 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10127 | name, FOptPercent ->
10128 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10129 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10131 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10132 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10134 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10136 pr " guestfs_free_%s_list (r);\n" typ;
10139 and generate_java_makefile_inc () =
10140 generate_header HashStyle GPLv2plus;
10142 pr "java_built_sources = \\\n";
10145 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10147 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10149 and generate_haskell_hs () =
10150 generate_header HaskellStyle LGPLv2plus;
10152 (* XXX We only know how to generate partial FFI for Haskell
10153 * at the moment. Please help out!
10155 let can_generate style =
10159 | RInt64 _, _ -> true
10161 | RConstString _, _
10162 | RConstOptString _, _
10168 | RBufferOut _, _ -> false in
10171 {-# INCLUDE <guestfs.h> #-}
10172 {-# LANGUAGE ForeignFunctionInterface #-}
10177 (* List out the names of the actions we want to export. *)
10179 fun (name, style, _, _, _, _, _) ->
10180 if can_generate style then pr ",\n %s" name
10186 -- Unfortunately some symbols duplicate ones already present
10187 -- in Prelude. We don't know which, so we hard-code a list
10189 import Prelude hiding (truncate)
10193 import Foreign.C.Types
10195 import Control.Exception
10196 import Data.Typeable
10198 data GuestfsS = GuestfsS -- represents the opaque C struct
10199 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10200 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10202 -- XXX define properly later XXX
10206 data IntBool = IntBool
10208 data StatVFS = StatVFS
10209 data Hashtable = Hashtable
10211 foreign import ccall unsafe \"guestfs_create\" c_create
10213 foreign import ccall unsafe \"&guestfs_close\" c_close
10214 :: FunPtr (GuestfsP -> IO ())
10215 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10216 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10218 create :: IO GuestfsH
10221 c_set_error_handler p nullPtr nullPtr
10222 h <- newForeignPtr c_close p
10225 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10226 :: GuestfsP -> IO CString
10228 -- last_error :: GuestfsH -> IO (Maybe String)
10229 -- last_error h = do
10230 -- str <- withForeignPtr h (\\p -> c_last_error p)
10231 -- maybePeek peekCString str
10233 last_error :: GuestfsH -> IO (String)
10235 str <- withForeignPtr h (\\p -> c_last_error p)
10236 if (str == nullPtr)
10237 then return \"no error\"
10238 else peekCString str
10242 (* Generate wrappers for each foreign function. *)
10244 fun (name, style, _, _, _, _, _) ->
10245 if can_generate style then (
10246 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10248 generate_haskell_prototype ~handle:"GuestfsP" style;
10252 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10254 pr "%s %s = do\n" name
10255 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10257 (* Convert pointer arguments using with* functions. *)
10262 | Pathname n | Device n | Dev_or_Path n | String n -> pr "withCString %s $ \\%s -> " n n
10263 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10264 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10265 | Bool _ | Int _ | Int64 _ -> ()
10267 (* Convert integer arguments. *)
10271 | Bool n -> sprintf "(fromBool %s)" n
10272 | Int n -> sprintf "(fromIntegral %s)" n
10273 | Int64 n -> sprintf "(fromIntegral %s)" n
10274 | FileIn n | FileOut n
10275 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10277 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10278 (String.concat " " ("p" :: args));
10279 (match fst style with
10280 | RErr | RInt _ | RInt64 _ | RBool _ ->
10281 pr " if (r == -1)\n";
10283 pr " err <- last_error h\n";
10285 | RConstString _ | RConstOptString _ | RString _
10286 | RStringList _ | RStruct _
10287 | RStructList _ | RHashtable _ | RBufferOut _ ->
10288 pr " if (r == nullPtr)\n";
10290 pr " err <- last_error h\n";
10293 (match fst style with
10295 pr " else return ()\n"
10297 pr " else return (fromIntegral r)\n"
10299 pr " else return (fromIntegral r)\n"
10301 pr " else return (toBool r)\n"
10303 | RConstOptString _
10310 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10316 and generate_haskell_prototype ~handle ?(hs = false) style =
10317 pr "%s -> " handle;
10318 let string = if hs then "String" else "CString" in
10319 let int = if hs then "Int" else "CInt" in
10320 let bool = if hs then "Bool" else "CInt" in
10321 let int64 = if hs then "Integer" else "Int64" in
10325 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10326 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10327 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10328 | Bool _ -> pr "%s" bool
10329 | Int _ -> pr "%s" int
10330 | Int64 _ -> pr "%s" int
10331 | FileIn _ -> pr "%s" string
10332 | FileOut _ -> pr "%s" string
10337 (match fst style with
10338 | RErr -> if not hs then pr "CInt"
10339 | RInt _ -> pr "%s" int
10340 | RInt64 _ -> pr "%s" int64
10341 | RBool _ -> pr "%s" bool
10342 | RConstString _ -> pr "%s" string
10343 | RConstOptString _ -> pr "Maybe %s" string
10344 | RString _ -> pr "%s" string
10345 | RStringList _ -> pr "[%s]" string
10346 | RStruct (_, typ) ->
10347 let name = java_name_of_struct typ in
10349 | RStructList (_, typ) ->
10350 let name = java_name_of_struct typ in
10352 | RHashtable _ -> pr "Hashtable"
10353 | RBufferOut _ -> pr "%s" string
10357 and generate_csharp () =
10358 generate_header CPlusPlusStyle LGPLv2plus;
10360 (* XXX Make this configurable by the C# assembly users. *)
10361 let library = "libguestfs.so.0" in
10364 // These C# bindings are highly experimental at present.
10366 // Firstly they only work on Linux (ie. Mono). In order to get them
10367 // to work on Windows (ie. .Net) you would need to port the library
10368 // itself to Windows first.
10370 // The second issue is that some calls are known to be incorrect and
10371 // can cause Mono to segfault. Particularly: calls which pass or
10372 // return string[], or return any structure value. This is because
10373 // we haven't worked out the correct way to do this from C#.
10375 // The third issue is that when compiling you get a lot of warnings.
10376 // We are not sure whether the warnings are important or not.
10378 // Fourthly we do not routinely build or test these bindings as part
10379 // of the make && make check cycle, which means that regressions might
10382 // Suggestions and patches are welcome.
10386 // gmcs Libguestfs.cs
10387 // mono Libguestfs.exe
10389 // (You'll probably want to add a Test class / static main function
10390 // otherwise this won't do anything useful).
10394 using System.Runtime.InteropServices;
10395 using System.Runtime.Serialization;
10396 using System.Collections;
10400 class Error : System.ApplicationException
10402 public Error (string message) : base (message) {}
10403 protected Error (SerializationInfo info, StreamingContext context) {}
10410 [DllImport (\"%s\")]
10411 static extern IntPtr guestfs_create ();
10415 _handle = guestfs_create ();
10416 if (_handle == IntPtr.Zero)
10417 throw new Error (\"could not create guestfs handle\");
10420 [DllImport (\"%s\")]
10421 static extern void guestfs_close (IntPtr h);
10425 guestfs_close (_handle);
10428 [DllImport (\"%s\")]
10429 static extern string guestfs_last_error (IntPtr h);
10431 " library library library;
10433 (* Generate C# structure bindings. We prefix struct names with
10434 * underscore because C# cannot have conflicting struct names and
10435 * method names (eg. "class stat" and "stat").
10439 pr " [StructLayout (LayoutKind.Sequential)]\n";
10440 pr " public class _%s {\n" typ;
10443 | name, FChar -> pr " char %s;\n" name
10444 | name, FString -> pr " string %s;\n" name
10446 pr " uint %s_len;\n" name;
10447 pr " string %s;\n" name
10449 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10450 pr " string %s;\n" name
10451 | name, FUInt32 -> pr " uint %s;\n" name
10452 | name, FInt32 -> pr " int %s;\n" name
10453 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10454 | name, FInt64 -> pr " long %s;\n" name
10455 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10461 (* Generate C# function bindings. *)
10463 fun (name, style, _, _, _, shortdesc, _) ->
10464 let rec csharp_return_type () =
10465 match fst style with
10467 | RBool n -> "bool"
10469 | RInt64 n -> "long"
10471 | RConstOptString n
10473 | RBufferOut n -> "string"
10474 | RStruct (_,n) -> "_" ^ n
10475 | RHashtable n -> "Hashtable"
10476 | RStringList n -> "string[]"
10477 | RStructList (_,n) -> sprintf "_%s[]" n
10479 and c_return_type () =
10480 match fst style with
10484 | RInt64 _ -> "long"
10486 | RConstOptString _
10488 | RBufferOut _ -> "string"
10489 | RStruct (_,n) -> "_" ^ n
10491 | RStringList _ -> "string[]"
10492 | RStructList (_,n) -> sprintf "_%s[]" n
10494 and c_error_comparison () =
10495 match fst style with
10499 | RInt64 _ -> "== -1"
10501 | RConstOptString _
10507 | RStructList (_,_) -> "== null"
10509 and generate_extern_prototype () =
10510 pr " static extern %s guestfs_%s (IntPtr h"
10511 (c_return_type ()) name;
10514 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10515 | FileIn n | FileOut n ->
10516 pr ", [In] string %s" n
10517 | StringList n | DeviceList n ->
10518 pr ", [In] string[] %s" n
10528 and generate_public_prototype () =
10529 pr " public %s %s (" (csharp_return_type ()) name;
10530 let comma = ref false in
10532 if !comma then pr ", ";
10537 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10538 | FileIn n | FileOut n ->
10539 next (); pr "string %s" n
10540 | StringList n | DeviceList n ->
10541 next (); pr "string[] %s" n
10543 next (); pr "bool %s" n
10545 next (); pr "int %s" n
10547 next (); pr "long %s" n
10551 and generate_call () =
10552 pr "guestfs_%s (_handle" name;
10553 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10557 pr " [DllImport (\"%s\")]\n" library;
10558 generate_extern_prototype ();
10560 pr " /// <summary>\n";
10561 pr " /// %s\n" shortdesc;
10562 pr " /// </summary>\n";
10563 generate_public_prototype ();
10565 pr " %s r;\n" (c_return_type ());
10568 pr " if (r %s)\n" (c_error_comparison ());
10569 pr " throw new Error (guestfs_last_error (_handle));\n";
10570 (match fst style with
10573 pr " return r != 0 ? true : false;\n"
10575 pr " Hashtable rr = new Hashtable ();\n";
10576 pr " for (int i = 0; i < r.Length; i += 2)\n";
10577 pr " rr.Add (r[i], r[i+1]);\n";
10579 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10580 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10586 ) all_functions_sorted;
10592 and generate_bindtests () =
10593 generate_header CStyle LGPLv2plus;
10597 #include <stdlib.h>
10598 #include <inttypes.h>
10599 #include <string.h>
10601 #include \"guestfs.h\"
10602 #include \"guestfs-internal.h\"
10603 #include \"guestfs-internal-actions.h\"
10604 #include \"guestfs_protocol.h\"
10606 #define error guestfs_error
10607 #define safe_calloc guestfs_safe_calloc
10608 #define safe_malloc guestfs_safe_malloc
10611 print_strings (char *const *argv)
10616 for (argc = 0; argv[argc] != NULL; ++argc) {
10617 if (argc > 0) printf (\", \");
10618 printf (\"\\\"%%s\\\"\", argv[argc]);
10623 /* The test0 function prints its parameters to stdout. */
10627 match test_functions with
10628 | [] -> assert false
10629 | test0 :: tests -> test0, tests in
10632 let (name, style, _, _, _, _, _) = test0 in
10633 generate_prototype ~extern:false ~semicolon:false ~newline:true
10634 ~handle:"g" ~prefix:"guestfs__" name style;
10639 | Device n | Dev_or_Path n
10642 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10643 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10644 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10645 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10646 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10647 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10649 pr " /* Java changes stdout line buffering so we need this: */\n";
10650 pr " fflush (stdout);\n";
10656 fun (name, style, _, _, _, _, _) ->
10657 if String.sub name (String.length name - 3) 3 <> "err" then (
10658 pr "/* Test normal return. */\n";
10659 generate_prototype ~extern:false ~semicolon:false ~newline:true
10660 ~handle:"g" ~prefix:"guestfs__" name style;
10662 (match fst style with
10667 pr " sscanf (val, \"%%d\", &r);\n";
10670 pr " int64_t r;\n";
10671 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
10674 pr " return STREQ (val, \"true\");\n"
10676 | RConstOptString _ ->
10677 (* Can't return the input string here. Return a static
10678 * string so we ensure we get a segfault if the caller
10679 * tries to free it.
10681 pr " return \"static string\";\n"
10683 pr " return strdup (val);\n"
10685 pr " char **strs;\n";
10687 pr " sscanf (val, \"%%d\", &n);\n";
10688 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
10689 pr " for (i = 0; i < n; ++i) {\n";
10690 pr " strs[i] = safe_malloc (g, 16);\n";
10691 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
10693 pr " strs[n] = NULL;\n";
10694 pr " return strs;\n"
10695 | RStruct (_, typ) ->
10696 pr " struct guestfs_%s *r;\n" typ;
10697 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10699 | RStructList (_, typ) ->
10700 pr " struct guestfs_%s_list *r;\n" typ;
10701 pr " r = safe_calloc (g, sizeof *r, 1);\n";
10702 pr " sscanf (val, \"%%d\", &r->len);\n";
10703 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
10706 pr " char **strs;\n";
10708 pr " sscanf (val, \"%%d\", &n);\n";
10709 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
10710 pr " for (i = 0; i < n; ++i) {\n";
10711 pr " strs[i*2] = safe_malloc (g, 16);\n";
10712 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
10713 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
10714 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
10716 pr " strs[n*2] = NULL;\n";
10717 pr " return strs;\n"
10719 pr " return strdup (val);\n"
10724 pr "/* Test error return. */\n";
10725 generate_prototype ~extern:false ~semicolon:false ~newline:true
10726 ~handle:"g" ~prefix:"guestfs__" name style;
10728 pr " error (g, \"error\");\n";
10729 (match fst style with
10730 | RErr | RInt _ | RInt64 _ | RBool _ ->
10732 | RConstString _ | RConstOptString _
10733 | RString _ | RStringList _ | RStruct _
10737 pr " return NULL;\n"
10744 and generate_ocaml_bindtests () =
10745 generate_header OCamlStyle GPLv2plus;
10749 let g = Guestfs.create () in
10753 String.concat " " (
10756 | CallString s -> "\"" ^ s ^ "\""
10757 | CallOptString None -> "None"
10758 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
10759 | CallStringList xs ->
10760 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
10761 | CallInt i when i >= 0 -> string_of_int i
10762 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
10763 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
10764 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
10765 | CallBool b -> string_of_bool b
10770 generate_lang_bindtests (
10771 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
10774 pr "print_endline \"EOF\"\n"
10776 and generate_perl_bindtests () =
10777 pr "#!/usr/bin/perl -w\n";
10778 generate_header HashStyle GPLv2plus;
10785 my $g = Sys::Guestfs->new ();
10789 String.concat ", " (
10792 | CallString s -> "\"" ^ s ^ "\""
10793 | CallOptString None -> "undef"
10794 | CallOptString (Some s) -> sprintf "\"%s\"" s
10795 | CallStringList xs ->
10796 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10797 | CallInt i -> string_of_int i
10798 | CallInt64 i -> Int64.to_string i
10799 | CallBool b -> if b then "1" else "0"
10804 generate_lang_bindtests (
10805 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
10808 pr "print \"EOF\\n\"\n"
10810 and generate_python_bindtests () =
10811 generate_header HashStyle GPLv2plus;
10816 g = guestfs.GuestFS ()
10820 String.concat ", " (
10823 | CallString s -> "\"" ^ s ^ "\""
10824 | CallOptString None -> "None"
10825 | CallOptString (Some s) -> sprintf "\"%s\"" s
10826 | CallStringList xs ->
10827 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10828 | CallInt i -> string_of_int i
10829 | CallInt64 i -> Int64.to_string i
10830 | CallBool b -> if b then "1" else "0"
10835 generate_lang_bindtests (
10836 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
10839 pr "print \"EOF\"\n"
10841 and generate_ruby_bindtests () =
10842 generate_header HashStyle GPLv2plus;
10847 g = Guestfs::create()
10851 String.concat ", " (
10854 | CallString s -> "\"" ^ s ^ "\""
10855 | CallOptString None -> "nil"
10856 | CallOptString (Some s) -> sprintf "\"%s\"" s
10857 | CallStringList xs ->
10858 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10859 | CallInt i -> string_of_int i
10860 | CallInt64 i -> Int64.to_string i
10861 | CallBool b -> string_of_bool b
10866 generate_lang_bindtests (
10867 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
10870 pr "print \"EOF\\n\"\n"
10872 and generate_java_bindtests () =
10873 generate_header CStyle GPLv2plus;
10876 import com.redhat.et.libguestfs.*;
10878 public class Bindtests {
10879 public static void main (String[] argv)
10882 GuestFS g = new GuestFS ();
10886 String.concat ", " (
10889 | CallString s -> "\"" ^ s ^ "\""
10890 | CallOptString None -> "null"
10891 | CallOptString (Some s) -> sprintf "\"%s\"" s
10892 | CallStringList xs ->
10894 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
10895 | CallInt i -> string_of_int i
10896 | CallInt64 i -> Int64.to_string i
10897 | CallBool b -> string_of_bool b
10902 generate_lang_bindtests (
10903 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
10907 System.out.println (\"EOF\");
10909 catch (Exception exn) {
10910 System.err.println (exn);
10917 and generate_haskell_bindtests () =
10918 generate_header HaskellStyle GPLv2plus;
10921 module Bindtests where
10922 import qualified Guestfs
10925 g <- Guestfs.create
10929 String.concat " " (
10932 | CallString s -> "\"" ^ s ^ "\""
10933 | CallOptString None -> "Nothing"
10934 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
10935 | CallStringList xs ->
10936 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
10937 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
10938 | CallInt i -> string_of_int i
10939 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
10940 | CallInt64 i -> Int64.to_string i
10941 | CallBool true -> "True"
10942 | CallBool false -> "False"
10947 generate_lang_bindtests (
10948 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
10951 pr " putStrLn \"EOF\"\n"
10953 (* Language-independent bindings tests - we do it this way to
10954 * ensure there is parity in testing bindings across all languages.
10956 and generate_lang_bindtests call =
10957 call "test0" [CallString "abc"; CallOptString (Some "def");
10958 CallStringList []; CallBool false;
10959 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10960 call "test0" [CallString "abc"; CallOptString None;
10961 CallStringList []; CallBool false;
10962 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10963 call "test0" [CallString ""; CallOptString (Some "def");
10964 CallStringList []; CallBool false;
10965 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10966 call "test0" [CallString ""; CallOptString (Some "");
10967 CallStringList []; CallBool false;
10968 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10969 call "test0" [CallString "abc"; CallOptString (Some "def");
10970 CallStringList ["1"]; CallBool false;
10971 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10972 call "test0" [CallString "abc"; CallOptString (Some "def");
10973 CallStringList ["1"; "2"]; CallBool false;
10974 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10975 call "test0" [CallString "abc"; CallOptString (Some "def");
10976 CallStringList ["1"]; CallBool true;
10977 CallInt 0; CallInt64 0L; CallString "123"; CallString "456"];
10978 call "test0" [CallString "abc"; CallOptString (Some "def");
10979 CallStringList ["1"]; CallBool false;
10980 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456"];
10981 call "test0" [CallString "abc"; CallOptString (Some "def");
10982 CallStringList ["1"]; CallBool false;
10983 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456"];
10984 call "test0" [CallString "abc"; CallOptString (Some "def");
10985 CallStringList ["1"]; CallBool false;
10986 CallInt 1; CallInt64 1L; CallString "123"; CallString "456"];
10987 call "test0" [CallString "abc"; CallOptString (Some "def");
10988 CallStringList ["1"]; CallBool false;
10989 CallInt 2; CallInt64 2L; CallString "123"; CallString "456"];
10990 call "test0" [CallString "abc"; CallOptString (Some "def");
10991 CallStringList ["1"]; CallBool false;
10992 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456"];
10993 call "test0" [CallString "abc"; CallOptString (Some "def");
10994 CallStringList ["1"]; CallBool false;
10995 CallInt 0; CallInt64 0L; CallString ""; CallString ""]
10997 (* XXX Add here tests of the return and error functions. *)
10999 (* Code to generator bindings for virt-inspector. Currently only
11000 * implemented for OCaml code (for virt-p2v 2.0).
11002 let rng_input = "inspector/virt-inspector.rng"
11004 (* Read the input file and parse it into internal structures. This is
11005 * by no means a complete RELAX NG parser, but is just enough to be
11006 * able to parse the specific input file.
11009 | Element of string * rng list (* <element name=name/> *)
11010 | Attribute of string * rng list (* <attribute name=name/> *)
11011 | Interleave of rng list (* <interleave/> *)
11012 | ZeroOrMore of rng (* <zeroOrMore/> *)
11013 | OneOrMore of rng (* <oneOrMore/> *)
11014 | Optional of rng (* <optional/> *)
11015 | Choice of string list (* <choice><value/>*</choice> *)
11016 | Value of string (* <value>str</value> *)
11017 | Text (* <text/> *)
11019 let rec string_of_rng = function
11020 | Element (name, xs) ->
11021 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11022 | Attribute (name, xs) ->
11023 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11024 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11025 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11026 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11027 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11028 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11029 | Value value -> "Value \"" ^ value ^ "\""
11032 and string_of_rng_list xs =
11033 String.concat ", " (List.map string_of_rng xs)
11035 let rec parse_rng ?defines context = function
11037 | Xml.Element ("element", ["name", name], children) :: rest ->
11038 Element (name, parse_rng ?defines context children)
11039 :: parse_rng ?defines context rest
11040 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11041 Attribute (name, parse_rng ?defines context children)
11042 :: parse_rng ?defines context rest
11043 | Xml.Element ("interleave", [], children) :: rest ->
11044 Interleave (parse_rng ?defines context children)
11045 :: parse_rng ?defines context rest
11046 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11047 let rng = parse_rng ?defines context [child] in
11049 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11051 failwithf "%s: <zeroOrMore> contains more than one child element"
11054 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11055 let rng = parse_rng ?defines context [child] in
11057 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11059 failwithf "%s: <oneOrMore> contains more than one child element"
11062 | Xml.Element ("optional", [], [child]) :: rest ->
11063 let rng = parse_rng ?defines context [child] in
11065 | [child] -> Optional child :: parse_rng ?defines context rest
11067 failwithf "%s: <optional> contains more than one child element"
11070 | Xml.Element ("choice", [], children) :: rest ->
11071 let values = List.map (
11072 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11074 failwithf "%s: can't handle anything except <value> in <choice>"
11078 :: parse_rng ?defines context rest
11079 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11080 Value value :: parse_rng ?defines context rest
11081 | Xml.Element ("text", [], []) :: rest ->
11082 Text :: parse_rng ?defines context rest
11083 | Xml.Element ("ref", ["name", name], []) :: rest ->
11084 (* Look up the reference. Because of limitations in this parser,
11085 * we can't handle arbitrarily nested <ref> yet. You can only
11086 * use <ref> from inside <start>.
11088 (match defines with
11090 failwithf "%s: contains <ref>, but no refs are defined yet" context
11092 let rng = StringMap.find name map in
11093 rng @ parse_rng ?defines context rest
11096 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11099 let xml = Xml.parse_file rng_input in
11101 | Xml.Element ("grammar", _,
11102 Xml.Element ("start", _, gram) :: defines) ->
11103 (* The <define/> elements are referenced in the <start> section,
11104 * so build a map of those first.
11106 let defines = List.fold_left (
11108 function Xml.Element ("define", ["name", name], defn) ->
11109 StringMap.add name defn map
11111 failwithf "%s: expected <define name=name/>" rng_input
11112 ) StringMap.empty defines in
11113 let defines = StringMap.mapi parse_rng defines in
11115 (* Parse the <start> clause, passing the defines. *)
11116 parse_rng ~defines "<start>" gram
11118 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11121 let name_of_field = function
11122 | Element (name, _) | Attribute (name, _)
11123 | ZeroOrMore (Element (name, _))
11124 | OneOrMore (Element (name, _))
11125 | Optional (Element (name, _)) -> name
11126 | Optional (Attribute (name, _)) -> name
11127 | Text -> (* an unnamed field in an element *)
11130 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11132 (* At the moment this function only generates OCaml types. However we
11133 * should parameterize it later so it can generate types/structs in a
11134 * variety of languages.
11136 let generate_types xs =
11137 (* A simple type is one that can be printed out directly, eg.
11138 * "string option". A complex type is one which has a name and has
11139 * to be defined via another toplevel definition, eg. a struct.
11141 * generate_type generates code for either simple or complex types.
11142 * In the simple case, it returns the string ("string option"). In
11143 * the complex case, it returns the name ("mountpoint"). In the
11144 * complex case it has to print out the definition before returning,
11145 * so it should only be called when we are at the beginning of a
11146 * new line (BOL context).
11148 let rec generate_type = function
11149 | Text -> (* string *)
11151 | Choice values -> (* [`val1|`val2|...] *)
11152 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11153 | ZeroOrMore rng -> (* <rng> list *)
11154 let t, is_simple = generate_type rng in
11155 t ^ " list (* 0 or more *)", is_simple
11156 | OneOrMore rng -> (* <rng> list *)
11157 let t, is_simple = generate_type rng in
11158 t ^ " list (* 1 or more *)", is_simple
11159 (* virt-inspector hack: bool *)
11160 | Optional (Attribute (name, [Value "1"])) ->
11162 | Optional rng -> (* <rng> list *)
11163 let t, is_simple = generate_type rng in
11164 t ^ " option", is_simple
11165 (* type name = { fields ... } *)
11166 | Element (name, fields) when is_attrs_interleave fields ->
11167 generate_type_struct name (get_attrs_interleave fields)
11168 | Element (name, [field]) (* type name = field *)
11169 | Attribute (name, [field]) ->
11170 let t, is_simple = generate_type field in
11171 if is_simple then (t, true)
11173 pr "type %s = %s\n" name t;
11176 | Element (name, fields) -> (* type name = { fields ... } *)
11177 generate_type_struct name fields
11179 failwithf "generate_type failed at: %s" (string_of_rng rng)
11181 and is_attrs_interleave = function
11182 | [Interleave _] -> true
11183 | Attribute _ :: fields -> is_attrs_interleave fields
11184 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11187 and get_attrs_interleave = function
11188 | [Interleave fields] -> fields
11189 | ((Attribute _) as field) :: fields
11190 | ((Optional (Attribute _)) as field) :: fields ->
11191 field :: get_attrs_interleave fields
11192 | _ -> assert false
11194 and generate_types xs =
11195 List.iter (fun x -> ignore (generate_type x)) xs
11197 and generate_type_struct name fields =
11198 (* Calculate the types of the fields first. We have to do this
11199 * before printing anything so we are still in BOL context.
11201 let types = List.map fst (List.map generate_type fields) in
11203 (* Special case of a struct containing just a string and another
11204 * field. Turn it into an assoc list.
11207 | ["string"; other] ->
11208 let fname1, fname2 =
11210 | [f1; f2] -> name_of_field f1, name_of_field f2
11211 | _ -> assert false in
11212 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11216 pr "type %s = {\n" name;
11218 fun (field, ftype) ->
11219 let fname = name_of_field field in
11220 pr " %s_%s : %s;\n" name fname ftype
11221 ) (List.combine fields types);
11223 (* Return the name of this type, and
11224 * false because it's not a simple type.
11231 let generate_parsers xs =
11232 (* As for generate_type above, generate_parser makes a parser for
11233 * some type, and returns the name of the parser it has generated.
11234 * Because it (may) need to print something, it should always be
11235 * called in BOL context.
11237 let rec generate_parser = function
11238 | Text -> (* string *)
11239 "string_child_or_empty"
11240 | Choice values -> (* [`val1|`val2|...] *)
11241 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11243 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11244 | ZeroOrMore rng -> (* <rng> list *)
11245 let pa = generate_parser rng in
11246 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11247 | OneOrMore rng -> (* <rng> list *)
11248 let pa = generate_parser rng in
11249 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11250 (* virt-inspector hack: bool *)
11251 | Optional (Attribute (name, [Value "1"])) ->
11252 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11253 | Optional rng -> (* <rng> list *)
11254 let pa = generate_parser rng in
11255 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11256 (* type name = { fields ... } *)
11257 | Element (name, fields) when is_attrs_interleave fields ->
11258 generate_parser_struct name (get_attrs_interleave fields)
11259 | Element (name, [field]) -> (* type name = field *)
11260 let pa = generate_parser field in
11261 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11262 pr "let %s =\n" parser_name;
11264 pr "let parse_%s = %s\n" name parser_name;
11266 | Attribute (name, [field]) ->
11267 let pa = generate_parser field in
11268 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11269 pr "let %s =\n" parser_name;
11271 pr "let parse_%s = %s\n" name parser_name;
11273 | Element (name, fields) -> (* type name = { fields ... } *)
11274 generate_parser_struct name ([], fields)
11276 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11278 and is_attrs_interleave = function
11279 | [Interleave _] -> true
11280 | Attribute _ :: fields -> is_attrs_interleave fields
11281 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11284 and get_attrs_interleave = function
11285 | [Interleave fields] -> [], fields
11286 | ((Attribute _) as field) :: fields
11287 | ((Optional (Attribute _)) as field) :: fields ->
11288 let attrs, interleaves = get_attrs_interleave fields in
11289 (field :: attrs), interleaves
11290 | _ -> assert false
11292 and generate_parsers xs =
11293 List.iter (fun x -> ignore (generate_parser x)) xs
11295 and generate_parser_struct name (attrs, interleaves) =
11296 (* Generate parsers for the fields first. We have to do this
11297 * before printing anything so we are still in BOL context.
11299 let fields = attrs @ interleaves in
11300 let pas = List.map generate_parser fields in
11302 (* Generate an intermediate tuple from all the fields first.
11303 * If the type is just a string + another field, then we will
11304 * return this directly, otherwise it is turned into a record.
11306 * RELAX NG note: This code treats <interleave> and plain lists of
11307 * fields the same. In other words, it doesn't bother enforcing
11308 * any ordering of fields in the XML.
11310 pr "let parse_%s x =\n" name;
11311 pr " let t = (\n ";
11312 let comma = ref false in
11315 if !comma then pr ",\n ";
11318 | Optional (Attribute (fname, [field])), pa ->
11320 | Optional (Element (fname, [field])), pa ->
11321 pr "%s (optional_child %S x)" pa fname
11322 | Attribute (fname, [Text]), _ ->
11323 pr "attribute %S x" fname
11324 | (ZeroOrMore _ | OneOrMore _), pa ->
11329 let fname = name_of_field field in
11330 pr "%s (child %S x)" pa fname
11331 ) (List.combine fields pas);
11335 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11339 pr " (Obj.magic t : %s)\n" name
11343 | (Optional (Attribute (fname, [field])), pa) ->
11344 pr " %s_%s =\n" name fname;
11346 | (Optional (Element (fname, [field])), pa) ->
11347 pr " %s_%s =\n" name fname;
11348 pr " (let x = optional_child %S x in\n" fname;
11351 let fname = name_of_field field in
11352 pr " %s_%s =\n" name fname;
11353 pr " (let x = child %S x in\n" fname;
11355 ) (List.combine fields pas);
11359 sprintf "parse_%s" name
11362 generate_parsers xs
11364 (* Generate ocaml/guestfs_inspector.mli. *)
11365 let generate_ocaml_inspector_mli () =
11366 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11369 (** This is an OCaml language binding to the external [virt-inspector]
11372 For more information, please read the man page [virt-inspector(1)].
11377 generate_types grammar;
11378 pr "(** The nested information returned from the {!inspect} function. *)\n";
11382 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11383 (** To inspect a libvirt domain called [name], pass a singleton
11384 list: [inspect [name]]. When using libvirt only, you may
11385 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11387 To inspect a disk image or images, pass a list of the filenames
11388 of the disk images: [inspect filenames]
11390 This function inspects the given guest or disk images and
11391 returns a list of operating system(s) found and a large amount
11392 of information about them. In the vast majority of cases,
11393 a virtual machine only contains a single operating system.
11395 If the optional [~xml] parameter is given, then this function
11396 skips running the external virt-inspector program and just
11397 parses the given XML directly (which is expected to be XML
11398 produced from a previous run of virt-inspector). The list of
11399 names and connect URI are ignored in this case.
11401 This function can throw a wide variety of exceptions, for example
11402 if the external virt-inspector program cannot be found, or if
11403 it doesn't generate valid XML.
11407 (* Generate ocaml/guestfs_inspector.ml. *)
11408 let generate_ocaml_inspector_ml () =
11409 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11414 generate_types grammar;
11418 (* Misc functions which are used by the parser code below. *)
11419 let first_child = function
11420 | Xml.Element (_, _, c::_) -> c
11421 | Xml.Element (name, _, []) ->
11422 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11423 | Xml.PCData str ->
11424 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11426 let string_child_or_empty = function
11427 | Xml.Element (_, _, [Xml.PCData s]) -> s
11428 | Xml.Element (_, _, []) -> \"\"
11429 | Xml.Element (x, _, _) ->
11430 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11432 | Xml.PCData str ->
11433 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11435 let optional_child name xml =
11436 let children = Xml.children xml in
11438 Some (List.find (function
11439 | Xml.Element (n, _, _) when n = name -> true
11440 | _ -> false) children)
11444 let child name xml =
11445 match optional_child name xml with
11448 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11450 let attribute name xml =
11451 try Xml.attrib xml name
11452 with Xml.No_attribute _ ->
11453 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11457 generate_parsers grammar;
11461 (* Run external virt-inspector, then use parser to parse the XML. *)
11462 let inspect ?connect ?xml names =
11466 if names = [] then invalid_arg \"inspect: no names given\";
11467 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11468 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11470 let cmd = List.map Filename.quote cmd in
11471 let cmd = String.concat \" \" cmd in
11472 let chan = open_process_in cmd in
11473 let xml = Xml.parse_in chan in
11474 (match close_process_in chan with
11476 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11477 | WSIGNALED i | WSTOPPED i ->
11478 failwith (\"external virt-inspector command died or stopped on sig \" ^
11483 Xml.parse_string doc in
11484 parse_operatingsystems xml
11487 (* This is used to generate the src/MAX_PROC_NR file which
11488 * contains the maximum procedure number, a surrogate for the
11489 * ABI version number. See src/Makefile.am for the details.
11491 and generate_max_proc_nr () =
11492 let proc_nrs = List.map (
11493 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
11494 ) daemon_functions in
11496 let max_proc_nr = List.fold_left max 0 proc_nrs in
11498 pr "%d\n" max_proc_nr
11500 let output_to filename k =
11501 let filename_new = filename ^ ".new" in
11502 chan := open_out filename_new;
11505 chan := Pervasives.stdout;
11507 (* Is the new file different from the current file? *)
11508 if Sys.file_exists filename && files_equal filename filename_new then
11509 unlink filename_new (* same, so skip it *)
11511 (* different, overwrite old one *)
11512 (try chmod filename 0o644 with Unix_error _ -> ());
11513 rename filename_new filename;
11514 chmod filename 0o444;
11515 printf "written %s\n%!" filename;
11518 let perror msg = function
11519 | Unix_error (err, _, _) ->
11520 eprintf "%s: %s\n" msg (error_message err)
11522 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11524 (* Main program. *)
11527 try openfile "HACKING" [O_RDWR] 0
11529 | Unix_error (ENOENT, _, _) ->
11531 You are probably running this from the wrong directory.
11532 Run it from the top source directory using the command
11537 perror "open: HACKING" exn;
11540 (* Acquire a lock so parallel builds won't try to run the generator
11541 * twice at the same time. Subsequent builds will wait for the first
11542 * one to finish. Note the lock is released implicitly when the
11545 (try lockf lock_fd F_LOCK 1
11547 perror "lock: HACKING" exn;
11550 check_functions ();
11552 output_to "src/guestfs_protocol.x" generate_xdr;
11553 output_to "src/guestfs-structs.h" generate_structs_h;
11554 output_to "src/guestfs-actions.h" generate_actions_h;
11555 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11556 output_to "src/guestfs-actions.c" generate_client_actions;
11557 output_to "src/guestfs-bindtests.c" generate_bindtests;
11558 output_to "src/guestfs-structs.pod" generate_structs_pod;
11559 output_to "src/guestfs-actions.pod" generate_actions_pod;
11560 output_to "src/guestfs-availability.pod" generate_availability_pod;
11561 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11562 output_to "src/libguestfs.syms" generate_linker_script;
11563 output_to "daemon/actions.h" generate_daemon_actions_h;
11564 output_to "daemon/stubs.c" generate_daemon_actions;
11565 output_to "daemon/names.c" generate_daemon_names;
11566 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11567 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11568 output_to "capitests/tests.c" generate_tests;
11569 output_to "fish/cmds.c" generate_fish_cmds;
11570 output_to "fish/completion.c" generate_fish_completion;
11571 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11572 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11573 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11574 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11575 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11576 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11577 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11578 output_to "perl/Guestfs.xs" generate_perl_xs;
11579 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11580 output_to "perl/bindtests.pl" generate_perl_bindtests;
11581 output_to "python/guestfs-py.c" generate_python_c;
11582 output_to "python/guestfs.py" generate_python_py;
11583 output_to "python/bindtests.py" generate_python_bindtests;
11584 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11585 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11586 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11590 let cols = cols_of_struct typ in
11591 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11592 output_to filename (generate_java_struct jtyp cols);
11595 output_to "java/Makefile.inc" generate_java_makefile_inc;
11596 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11597 output_to "java/Bindtests.java" generate_java_bindtests;
11598 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11599 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11600 output_to "csharp/Libguestfs.cs" generate_csharp;
11602 (* Always generate this file last, and unconditionally. It's used
11603 * by the Makefile to know when we must re-run the generator.
11605 let chan = open_out "src/stamp-generator" in
11606 fprintf chan "1\n";
11609 printf "generated %d lines of code\n" !lines