3 * Copyright (C) 2009 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 below), and
25 * daemon/<somefile>.c to write the implementation.
27 * After editing this file, run it (./src/generator.ml) to regenerate all the
28 * output files. Note that if you are using a separate build directory you
29 * must run generator.ml from the _source_ directory.
31 * IMPORTANT: This script should NOT print any warnings. If it prints
32 * warnings, you should treat them as errors.
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
47 (* "RInt" as a return value means an int which is -1 for error
48 * or any value >= 0 on success. Only use this for smallish
49 * positive ints (0 <= i < 2^30).
53 (* "RInt64" is the same as RInt, but is guaranteed to be able
54 * to return a full 64 bit value, _except_ that -1 means error
55 * (so -1 cannot be a valid, non-error return value).
59 (* "RBool" is a bool return value which can be true/false or
64 (* "RConstString" is a string that refers to a constant value.
65 * The return value must NOT be NULL (since NULL indicates
68 * Try to avoid using this. In particular you cannot use this
69 * for values returned from the daemon, because there is no
70 * thread-safe way to return them in the C API.
72 | RConstString of string
74 (* "RConstOptString" is an even more broken version of
75 * "RConstString". The returned string may be NULL and there
76 * is no way to return an error indication. Avoid using this!
78 | RConstOptString of string
80 (* "RString" is a returned string. It must NOT be NULL, since
81 * a NULL return indicates an error. The caller frees this.
85 (* "RStringList" is a list of strings. No string in the list
86 * can be NULL. The caller frees the strings and the array.
88 | RStringList of string
90 (* "RStruct" is a function which returns a single named structure
91 * or an error indication (in C, a struct, and in other languages
92 * with varying representations, but usually very efficient). See
93 * after the function list below for the structures.
95 | RStruct of string * string (* name of retval, name of struct *)
97 (* "RStructList" is a function which returns either a list/array
98 * of structures (could be zero-length), or an error indication.
100 | RStructList of string * string (* name of retval, name of struct *)
102 (* Key-value pairs of untyped strings. Turns into a hashtable or
103 * dictionary in languages which support it. DON'T use this as a
104 * general "bucket" for results. Prefer a stronger typed return
105 * value if one is available, or write a custom struct. Don't use
106 * this if the list could potentially be very long, since it is
107 * inefficient. Keys should be unique. NULLs are not permitted.
109 | RHashtable of string
111 (* "RBufferOut" is handled almost exactly like RString, but
112 * it allows the string to contain arbitrary 8 bit data including
113 * ASCII NUL. In the C API this causes an implicit extra parameter
114 * to be added of type <size_t *size_r>. The extra parameter
115 * returns the actual size of the return buffer in bytes.
117 * Other programming languages support strings with arbitrary 8 bit
120 * At the RPC layer we have to use the opaque<> type instead of
121 * string<>. Returned data is still limited to the max message
124 | RBufferOut of string
126 and args = argt list (* Function parameters, guestfs handle is implicit. *)
128 (* Note in future we should allow a "variable args" parameter as
129 * the final parameter, to allow commands like
130 * chmod mode file [file(s)...]
131 * This is not implemented yet, but many commands (such as chmod)
132 * are currently defined with the argument order keeping this future
133 * possibility in mind.
136 | String of string (* const char *name, cannot be NULL *)
137 | OptString of string (* const char *name, may be NULL *)
138 | StringList of string(* list of strings (each string cannot be NULL) *)
139 | Bool of string (* boolean *)
140 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
141 (* These are treated as filenames (simple string parameters) in
142 * the C API and bindings. But in the RPC protocol, we transfer
143 * the actual file content up to or down from the daemon.
144 * FileIn: local machine -> daemon (in request)
145 * FileOut: daemon -> local machine (in reply)
146 * In guestfish (only), the special name "-" means read from
147 * stdin or write to stdout.
152 (* Opaque buffer which can contain arbitrary 8 bit data.
153 * In the C API, this is expressed as <char *, int> pair.
154 * Most other languages have a string type which can contain
155 * ASCII NUL. We use whatever type is appropriate for each
157 * Buffers are limited by the total message size. To transfer
158 * large blocks of data, use FileIn/FileOut parameters instead.
159 * To return an arbitrary buffer, use RBufferOut.
165 | ProtocolLimitWarning (* display warning about protocol size limits *)
166 | DangerWillRobinson (* flags particularly dangerous commands *)
167 | FishAlias of string (* provide an alias for this cmd in guestfish *)
168 | FishAction of string (* call this function in guestfish *)
169 | NotInFish (* do not export via guestfish *)
170 | NotInDocs (* do not add this function to documentation *)
171 | DeprecatedBy of string (* function is deprecated, use .. instead *)
173 (* You can supply zero or as many tests as you want per API call.
175 * Note that the test environment has 3 block devices, of size 500MB,
176 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
177 * a fourth squashfs block device with some known files on it (/dev/sdd).
179 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
180 * Number of cylinders was 63 for IDE emulated disks with precisely
181 * the same size. How exactly this is calculated is a mystery.
183 * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
185 * To be able to run the tests in a reasonable amount of time,
186 * the virtual machine and block devices are reused between tests.
187 * So don't try testing kill_subprocess :-x
189 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
191 * Don't assume anything about the previous contents of the block
192 * devices. Use 'Init*' to create some initial scenarios.
194 * You can add a prerequisite clause to any individual test. This
195 * is a run-time check, which, if it fails, causes the test to be
196 * skipped. Useful if testing a command which might not work on
197 * all variations of libguestfs builds. A test that has prerequisite
198 * of 'Always' is run unconditionally.
200 * In addition, packagers can skip individual tests by setting the
201 * environment variables: eg:
202 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
203 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
205 type tests = (test_init * test_prereq * test) list
207 (* Run the command sequence and just expect nothing to fail. *)
210 (* Run the command sequence and expect the output of the final
211 * command to be the string.
213 | TestOutput of seq * string
215 (* Run the command sequence and expect the output of the final
216 * command to be the list of strings.
218 | TestOutputList of seq * string list
220 (* Run the command sequence and expect the output of the final
221 * command to be the list of block devices (could be either
222 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
223 * character of each string).
225 | TestOutputListOfDevices of seq * string list
227 (* Run the command sequence and expect the output of the final
228 * command to be the integer.
230 | TestOutputInt of seq * int
232 (* Run the command sequence and expect the output of the final
233 * command to be <op> <int>, eg. ">=", "1".
235 | TestOutputIntOp of seq * string * int
237 (* Run the command sequence and expect the output of the final
238 * command to be a true value (!= 0 or != NULL).
240 | TestOutputTrue of seq
242 (* Run the command sequence and expect the output of the final
243 * command to be a false value (== 0 or == NULL, but not an error).
245 | TestOutputFalse of seq
247 (* Run the command sequence and expect the output of the final
248 * command to be a list of the given length (but don't care about
251 | TestOutputLength of seq * int
253 (* Run the command sequence and expect the output of the final
254 * command to be a buffer (RBufferOut), ie. string + size.
256 | TestOutputBuffer of seq * string
258 (* Run the command sequence and expect the output of the final
259 * command to be a structure.
261 | TestOutputStruct of seq * test_field_compare list
263 (* Run the command sequence and expect the final command (only)
266 | TestLastFail of seq
268 and test_field_compare =
269 | CompareWithInt of string * int
270 | CompareWithIntOp of string * string * int
271 | CompareWithString of string * string
272 | CompareFieldsIntEq of string * string
273 | CompareFieldsStrEq of string * string
275 (* Test prerequisites. *)
277 (* Test always runs. *)
280 (* Test is currently disabled - eg. it fails, or it tests some
281 * unimplemented feature.
285 (* 'string' is some C code (a function body) that should return
286 * true or false. The test will run if the code returns true.
290 (* As for 'If' but the test runs _unless_ the code returns true. *)
293 (* Some initial scenarios for testing. *)
295 (* Do nothing, block devices could contain random stuff including
296 * LVM PVs, and some filesystems might be mounted. This is usually
301 (* Block devices are empty and no filesystems are mounted. *)
304 (* /dev/sda contains a single partition /dev/sda1, with random
305 * content. /dev/sdb and /dev/sdc may have random content.
310 (* /dev/sda contains a single partition /dev/sda1, which is formatted
311 * as ext2, empty [except for lost+found] and mounted on /.
312 * /dev/sdb and /dev/sdc may have random content.
318 * /dev/sda1 (is a PV):
319 * /dev/VG/LV (size 8MB):
320 * formatted as ext2, empty [except for lost+found], mounted on /
321 * /dev/sdb and /dev/sdc may have random content.
325 (* /dev/sdd (the squashfs, see images/ directory in source)
330 (* Sequence of commands for testing. *)
332 and cmd = string list
334 (* Note about long descriptions: When referring to another
335 * action, use the format C<guestfs_other> (ie. the full name of
336 * the C function). This will be replaced as appropriate in other
339 * Apart from that, long descriptions are just perldoc paragraphs.
342 (* These test functions are used in the language binding tests. *)
344 let test_all_args = [
347 StringList "strlist";
354 let test_all_rets = [
355 (* except for RErr, which is tested thoroughly elsewhere *)
356 "test0rint", RInt "valout";
357 "test0rint64", RInt64 "valout";
358 "test0rbool", RBool "valout";
359 "test0rconststring", RConstString "valout";
360 "test0rconstoptstring", RConstOptString "valout";
361 "test0rstring", RString "valout";
362 "test0rstringlist", RStringList "valout";
363 "test0rstruct", RStruct ("valout", "lvm_pv");
364 "test0rstructlist", RStructList ("valout", "lvm_pv");
365 "test0rhashtable", RHashtable "valout";
368 let test_functions = [
369 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
371 "internal test function - do not use",
373 This is an internal test function which is used to test whether
374 the automatically generated bindings can handle every possible
375 parameter type correctly.
377 It echos the contents of each parameter to stdout.
379 You probably don't want to call this function.");
383 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
385 "internal test function - do not use",
387 This is an internal test function which is used to test whether
388 the automatically generated bindings can handle every possible
389 return type correctly.
391 It converts string C<val> to the return type.
393 You probably don't want to call this function.");
394 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
396 "internal test function - do not use",
398 This is an internal test function which is used to test whether
399 the automatically generated bindings can handle every possible
400 return type correctly.
402 This function always returns an error.
404 You probably don't want to call this function.")]
408 (* non_daemon_functions are any functions which don't get processed
409 * in the daemon, eg. functions for setting and getting local
410 * configuration values.
413 let non_daemon_functions = test_functions @ [
414 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
416 "launch the qemu subprocess",
418 Internally libguestfs is implemented by running a virtual machine
421 You should call this after configuring the handle
422 (eg. adding drives) but before performing any actions.");
424 ("wait_ready", (RErr, []), -1, [NotInFish],
426 "wait until the qemu subprocess launches",
428 Internally libguestfs is implemented by running a virtual machine
431 You should call this after C<guestfs_launch> to wait for the launch
434 ("kill_subprocess", (RErr, []), -1, [],
436 "kill the qemu subprocess",
438 This kills the qemu subprocess. You should never need to call this.");
440 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
442 "add an image to examine or modify",
444 This function adds a virtual machine disk image C<filename> to the
445 guest. The first time you call this function, the disk appears as IDE
446 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
449 You don't necessarily need to be root when using libguestfs. However
450 you obviously do need sufficient permissions to access the filename
451 for whatever operations you want to perform (ie. read access if you
452 just want to read the image or write access if you want to modify the
455 This is equivalent to the qemu parameter
456 C<-drive file=filename,cache=off,if=...>.
457 C<cache=off> is omitted in cases where it is not supported by
458 the underlying filesystem.
460 Note that this call checks for the existence of C<filename>. This
461 stops you from specifying other types of drive which are supported
462 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
463 the general C<guestfs_config> call instead.");
465 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
467 "add a CD-ROM disk image to examine",
469 This function adds a virtual CD-ROM disk image to the guest.
471 This is equivalent to the qemu parameter C<-cdrom filename>.
473 Note that this call checks for the existence of C<filename>. This
474 stops you from specifying other types of drive which are supported
475 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
476 the general C<guestfs_config> call instead.");
478 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
480 "add a drive in snapshot mode (read-only)",
482 This adds a drive in snapshot mode, making it effectively
485 Note that writes to the device are allowed, and will be seen for
486 the duration of the guestfs handle, but they are written
487 to a temporary file which is discarded as soon as the guestfs
488 handle is closed. We don't currently have any method to enable
489 changes to be committed, although qemu can support this.
491 This is equivalent to the qemu parameter
492 C<-drive file=filename,snapshot=on,if=...>.
494 Note that this call checks for the existence of C<filename>. This
495 stops you from specifying other types of drive which are supported
496 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
497 the general C<guestfs_config> call instead.");
499 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
501 "add qemu parameters",
503 This can be used to add arbitrary qemu command line parameters
504 of the form C<-param value>. Actually it's not quite arbitrary - we
505 prevent you from setting some parameters which would interfere with
506 parameters that we use.
508 The first character of C<param> string must be a C<-> (dash).
510 C<value> can be NULL.");
512 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
514 "set the qemu binary",
516 Set the qemu binary that we will use.
518 The default is chosen when the library was compiled by the
521 You can also override this by setting the C<LIBGUESTFS_QEMU>
522 environment variable.
524 Setting C<qemu> to C<NULL> restores the default qemu binary.");
526 ("get_qemu", (RConstString "qemu", []), -1, [],
527 [InitNone, Always, TestRun (
529 "get the qemu binary",
531 Return the current qemu binary.
533 This is always non-NULL. If it wasn't set already, then this will
534 return the default qemu binary name.");
536 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
538 "set the search path",
540 Set the path that libguestfs searches for kernel and initrd.img.
542 The default is C<$libdir/guestfs> unless overridden by setting
543 C<LIBGUESTFS_PATH> environment variable.
545 Setting C<path> to C<NULL> restores the default path.");
547 ("get_path", (RConstString "path", []), -1, [],
548 [InitNone, Always, TestRun (
550 "get the search path",
552 Return the current search path.
554 This is always non-NULL. If it wasn't set already, then this will
555 return the default path.");
557 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
559 "add options to kernel command line",
561 This function is used to add additional options to the
562 guest kernel command line.
564 The default is C<NULL> unless overridden by setting
565 C<LIBGUESTFS_APPEND> environment variable.
567 Setting C<append> to C<NULL> means I<no> additional options
568 are passed (libguestfs always adds a few of its own).");
570 ("get_append", (RConstOptString "append", []), -1, [],
571 (* This cannot be tested with the current framework. The
572 * function can return NULL in normal operations, which the
573 * test framework interprets as an error.
576 "get the additional kernel options",
578 Return the additional kernel options which are added to the
579 guest kernel command line.
581 If C<NULL> then no options are added.");
583 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
587 If C<autosync> is true, this enables autosync. Libguestfs will make a
588 best effort attempt to run C<guestfs_umount_all> followed by
589 C<guestfs_sync> when the handle is closed
590 (also if the program exits without closing handles).
592 This is disabled by default (except in guestfish where it is
593 enabled by default).");
595 ("get_autosync", (RBool "autosync", []), -1, [],
596 [InitNone, Always, TestRun (
597 [["get_autosync"]])],
600 Get the autosync flag.");
602 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
606 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
608 Verbose messages are disabled unless the environment variable
609 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
611 ("get_verbose", (RBool "verbose", []), -1, [],
615 This returns the verbose messages flag.");
617 ("is_ready", (RBool "ready", []), -1, [],
618 [InitNone, Always, TestOutputTrue (
620 "is ready to accept commands",
622 This returns true iff this handle is ready to accept commands
623 (in the C<READY> state).
625 For more information on states, see L<guestfs(3)>.");
627 ("is_config", (RBool "config", []), -1, [],
628 [InitNone, Always, TestOutputFalse (
630 "is in configuration state",
632 This returns true iff this handle is being configured
633 (in the C<CONFIG> state).
635 For more information on states, see L<guestfs(3)>.");
637 ("is_launching", (RBool "launching", []), -1, [],
638 [InitNone, Always, TestOutputFalse (
639 [["is_launching"]])],
640 "is launching subprocess",
642 This returns true iff this handle is launching the subprocess
643 (in the C<LAUNCHING> state).
645 For more information on states, see L<guestfs(3)>.");
647 ("is_busy", (RBool "busy", []), -1, [],
648 [InitNone, Always, TestOutputFalse (
650 "is busy processing a command",
652 This returns true iff this handle is busy processing a command
653 (in the C<BUSY> state).
655 For more information on states, see L<guestfs(3)>.");
657 ("get_state", (RInt "state", []), -1, [],
659 "get the current state",
661 This returns the current state as an opaque integer. This is
662 only useful for printing debug and internal error messages.
664 For more information on states, see L<guestfs(3)>.");
666 ("set_busy", (RErr, []), -1, [NotInFish],
670 This sets the state to C<BUSY>. This is only used when implementing
671 actions using the low-level API.
673 For more information on states, see L<guestfs(3)>.");
675 ("set_ready", (RErr, []), -1, [NotInFish],
677 "set state to ready",
679 This sets the state to C<READY>. This is only used when implementing
680 actions using the low-level API.
682 For more information on states, see L<guestfs(3)>.");
684 ("end_busy", (RErr, []), -1, [NotInFish],
686 "leave the busy state",
688 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
689 state as is. This is only used when implementing
690 actions using the low-level API.
692 For more information on states, see L<guestfs(3)>.");
694 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
695 [InitNone, Always, TestOutputInt (
696 [["set_memsize"; "500"];
697 ["get_memsize"]], 500)],
698 "set memory allocated to the qemu subprocess",
700 This sets the memory size in megabytes allocated to the
701 qemu subprocess. This only has any effect if called before
704 You can also change this by setting the environment
705 variable C<LIBGUESTFS_MEMSIZE> before the handle is
708 For more information on the architecture of libguestfs,
709 see L<guestfs(3)>.");
711 ("get_memsize", (RInt "memsize", []), -1, [],
712 [InitNone, Always, TestOutputIntOp (
713 [["get_memsize"]], ">=", 256)],
714 "get memory allocated to the qemu subprocess",
716 This gets the memory size in megabytes allocated to the
719 If C<guestfs_set_memsize> was not called
720 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
721 then this returns the compiled-in default value for memsize.
723 For more information on the architecture of libguestfs,
724 see L<guestfs(3)>.");
726 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
727 [InitNone, Always, TestOutputIntOp (
728 [["get_pid"]], ">=", 1)],
729 "get PID of qemu subprocess",
731 Return the process ID of the qemu subprocess. If there is no
732 qemu subprocess, then this will return an error.
734 This is an internal call used for debugging and testing.");
736 ("version", (RStruct ("version", "version"), []), -1, [],
737 [InitNone, Always, TestOutputStruct (
738 [["version"]], [CompareWithInt ("major", 1)])],
739 "get the library version number",
741 Return the libguestfs version number that the program is linked
744 Note that because of dynamic linking this is not necessarily
745 the version of libguestfs that you compiled against. You can
746 compile the program, and then at runtime dynamically link
747 against a completely different C<libguestfs.so> library.
749 This call was added in version C<1.0.58>. In previous
750 versions of libguestfs there was no way to get the version
751 number. From C code you can use ELF weak linking tricks to find out if
752 this symbol exists (if it doesn't, then it's an earlier version).
754 The call returns a structure with four elements. The first
755 three (C<major>, C<minor> and C<release>) are numbers and
756 correspond to the usual version triplet. The fourth element
757 (C<extra>) is a string and is normally empty, but may be
758 used for distro-specific information.
760 To construct the original version string:
761 C<$major.$minor.$release$extra>
763 I<Note:> Don't use this call to test for availability
764 of features. Distro backports makes this unreliable.");
766 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
767 [InitNone, Always, TestOutputTrue (
768 [["set_selinux"; "true"];
770 "set SELinux enabled or disabled at appliance boot",
772 This sets the selinux flag that is passed to the appliance
773 at boot time. The default is C<selinux=0> (disabled).
775 Note that if SELinux is enabled, it is always in
776 Permissive mode (C<enforcing=0>).
778 For more information on the architecture of libguestfs,
779 see L<guestfs(3)>.");
781 ("get_selinux", (RBool "selinux", []), -1, [],
783 "get SELinux enabled flag",
785 This returns the current setting of the selinux flag which
786 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
788 For more information on the architecture of libguestfs,
789 see L<guestfs(3)>.");
793 (* daemon_functions are any functions which cause some action
794 * to take place in the daemon.
797 let daemon_functions = [
798 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
799 [InitEmpty, Always, TestOutput (
800 [["sfdiskM"; "/dev/sda"; ","];
801 ["mkfs"; "ext2"; "/dev/sda1"];
802 ["mount"; "/dev/sda1"; "/"];
803 ["write_file"; "/new"; "new file contents"; "0"];
804 ["cat"; "/new"]], "new file contents")],
805 "mount a guest disk at a position in the filesystem",
807 Mount a guest disk at a position in the filesystem. Block devices
808 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
809 the guest. If those block devices contain partitions, they will have
810 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
813 The rules are the same as for L<mount(2)>: A filesystem must
814 first be mounted on C</> before others can be mounted. Other
815 filesystems can only be mounted on directories which already
818 The mounted filesystem is writable, if we have sufficient permissions
819 on the underlying device.
821 The filesystem options C<sync> and C<noatime> are set with this
822 call, in order to improve reliability.");
824 ("sync", (RErr, []), 2, [],
825 [ InitEmpty, Always, TestRun [["sync"]]],
826 "sync disks, writes are flushed through to the disk image",
828 This syncs the disk, so that any writes are flushed through to the
829 underlying disk image.
831 You should always call this if you have modified a disk image, before
832 closing the handle.");
834 ("touch", (RErr, [String "path"]), 3, [],
835 [InitBasicFS, Always, TestOutputTrue (
837 ["exists"; "/new"]])],
838 "update file timestamps or create a new file",
840 Touch acts like the L<touch(1)> command. It can be used to
841 update the timestamps on a file, or, if the file does not exist,
842 to create a new zero-length file.");
844 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
845 [InitSquashFS, Always, TestOutput (
846 [["cat"; "/known-2"]], "abcdef\n")],
847 "list the contents of a file",
849 Return the contents of the file named C<path>.
851 Note that this function cannot correctly handle binary files
852 (specifically, files containing C<\\0> character which is treated
853 as end of string). For those you need to use the C<guestfs_read_file>
854 or C<guestfs_download> functions which have a more complex interface.");
856 ("ll", (RString "listing", [String "directory"]), 5, [],
857 [], (* XXX Tricky to test because it depends on the exact format
858 * of the 'ls -l' command, which changes between F10 and F11.
860 "list the files in a directory (long format)",
862 List the files in C<directory> (relative to the root directory,
863 there is no cwd) in the format of 'ls -la'.
865 This command is mostly useful for interactive sessions. It
866 is I<not> intended that you try to parse the output string.");
868 ("ls", (RStringList "listing", [String "directory"]), 6, [],
869 [InitBasicFS, Always, TestOutputList (
872 ["touch"; "/newest"];
873 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
874 "list the files in a directory",
876 List the files in C<directory> (relative to the root directory,
877 there is no cwd). The '.' and '..' entries are not returned, but
878 hidden files are shown.
880 This command is mostly useful for interactive sessions. Programs
881 should probably use C<guestfs_readdir> instead.");
883 ("list_devices", (RStringList "devices", []), 7, [],
884 [InitEmpty, Always, TestOutputListOfDevices (
885 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
886 "list the block devices",
888 List all the block devices.
890 The full block device names are returned, eg. C</dev/sda>");
892 ("list_partitions", (RStringList "partitions", []), 8, [],
893 [InitBasicFS, Always, TestOutputListOfDevices (
894 [["list_partitions"]], ["/dev/sda1"]);
895 InitEmpty, Always, TestOutputListOfDevices (
896 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
897 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
898 "list the partitions",
900 List all the partitions detected on all block devices.
902 The full partition device names are returned, eg. C</dev/sda1>
904 This does not return logical volumes. For that you will need to
905 call C<guestfs_lvs>.");
907 ("pvs", (RStringList "physvols", []), 9, [],
908 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
909 [["pvs"]], ["/dev/sda1"]);
910 InitEmpty, Always, TestOutputListOfDevices (
911 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
912 ["pvcreate"; "/dev/sda1"];
913 ["pvcreate"; "/dev/sda2"];
914 ["pvcreate"; "/dev/sda3"];
915 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
916 "list the LVM physical volumes (PVs)",
918 List all the physical volumes detected. This is the equivalent
919 of the L<pvs(8)> command.
921 This returns a list of just the device names that contain
922 PVs (eg. C</dev/sda2>).
924 See also C<guestfs_pvs_full>.");
926 ("vgs", (RStringList "volgroups", []), 10, [],
927 [InitBasicFSonLVM, Always, TestOutputList (
929 InitEmpty, Always, TestOutputList (
930 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
931 ["pvcreate"; "/dev/sda1"];
932 ["pvcreate"; "/dev/sda2"];
933 ["pvcreate"; "/dev/sda3"];
934 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
935 ["vgcreate"; "VG2"; "/dev/sda3"];
936 ["vgs"]], ["VG1"; "VG2"])],
937 "list the LVM volume groups (VGs)",
939 List all the volumes groups detected. This is the equivalent
940 of the L<vgs(8)> command.
942 This returns a list of just the volume group names that were
943 detected (eg. C<VolGroup00>).
945 See also C<guestfs_vgs_full>.");
947 ("lvs", (RStringList "logvols", []), 11, [],
948 [InitBasicFSonLVM, Always, TestOutputList (
949 [["lvs"]], ["/dev/VG/LV"]);
950 InitEmpty, Always, TestOutputList (
951 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
952 ["pvcreate"; "/dev/sda1"];
953 ["pvcreate"; "/dev/sda2"];
954 ["pvcreate"; "/dev/sda3"];
955 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
956 ["vgcreate"; "VG2"; "/dev/sda3"];
957 ["lvcreate"; "LV1"; "VG1"; "50"];
958 ["lvcreate"; "LV2"; "VG1"; "50"];
959 ["lvcreate"; "LV3"; "VG2"; "50"];
960 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
961 "list the LVM logical volumes (LVs)",
963 List all the logical volumes detected. This is the equivalent
964 of the L<lvs(8)> command.
966 This returns a list of the logical volume device names
967 (eg. C</dev/VolGroup00/LogVol00>).
969 See also C<guestfs_lvs_full>.");
971 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
972 [], (* XXX how to test? *)
973 "list the LVM physical volumes (PVs)",
975 List all the physical volumes detected. This is the equivalent
976 of the L<pvs(8)> command. The \"full\" version includes all fields.");
978 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
979 [], (* XXX how to test? *)
980 "list the LVM volume groups (VGs)",
982 List all the volumes groups detected. This is the equivalent
983 of the L<vgs(8)> command. The \"full\" version includes all fields.");
985 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
986 [], (* XXX how to test? *)
987 "list the LVM logical volumes (LVs)",
989 List all the logical volumes detected. This is the equivalent
990 of the L<lvs(8)> command. The \"full\" version includes all fields.");
992 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
993 [InitSquashFS, Always, TestOutputList (
994 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
995 InitSquashFS, Always, TestOutputList (
996 [["read_lines"; "/empty"]], [])],
997 "read file as lines",
999 Return the contents of the file named C<path>.
1001 The file contents are returned as a list of lines. Trailing
1002 C<LF> and C<CRLF> character sequences are I<not> returned.
1004 Note that this function cannot correctly handle binary files
1005 (specifically, files containing C<\\0> character which is treated
1006 as end of line). For those you need to use the C<guestfs_read_file>
1007 function which has a more complex interface.");
1009 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
1010 [], (* XXX Augeas code needs tests. *)
1011 "create a new Augeas handle",
1013 Create a new Augeas handle for editing configuration files.
1014 If there was any previous Augeas handle associated with this
1015 guestfs session, then it is closed.
1017 You must call this before using any other C<guestfs_aug_*>
1020 C<root> is the filesystem root. C<root> must not be NULL,
1023 The flags are the same as the flags defined in
1024 E<lt>augeas.hE<gt>, the logical I<or> of the following
1029 =item C<AUG_SAVE_BACKUP> = 1
1031 Keep the original file with a C<.augsave> extension.
1033 =item C<AUG_SAVE_NEWFILE> = 2
1035 Save changes into a file with extension C<.augnew>, and
1036 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1038 =item C<AUG_TYPE_CHECK> = 4
1040 Typecheck lenses (can be expensive).
1042 =item C<AUG_NO_STDINC> = 8
1044 Do not use standard load path for modules.
1046 =item C<AUG_SAVE_NOOP> = 16
1048 Make save a no-op, just record what would have been changed.
1050 =item C<AUG_NO_LOAD> = 32
1052 Do not load the tree in C<guestfs_aug_init>.
1056 To close the handle, you can call C<guestfs_aug_close>.
1058 To find out more about Augeas, see L<http://augeas.net/>.");
1060 ("aug_close", (RErr, []), 26, [],
1061 [], (* XXX Augeas code needs tests. *)
1062 "close the current Augeas handle",
1064 Close the current Augeas handle and free up any resources
1065 used by it. After calling this, you have to call
1066 C<guestfs_aug_init> again before you can use any other
1067 Augeas functions.");
1069 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
1070 [], (* XXX Augeas code needs tests. *)
1071 "define an Augeas variable",
1073 Defines an Augeas variable C<name> whose value is the result
1074 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1077 On success this returns the number of nodes in C<expr>, or
1078 C<0> if C<expr> evaluates to something which is not a nodeset.");
1080 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1081 [], (* XXX Augeas code needs tests. *)
1082 "define an Augeas node",
1084 Defines a variable C<name> whose value is the result of
1087 If C<expr> evaluates to an empty nodeset, a node is created,
1088 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1089 C<name> will be the nodeset containing that single node.
1091 On success this returns a pair containing the
1092 number of nodes in the nodeset, and a boolean flag
1093 if a node was created.");
1095 ("aug_get", (RString "val", [String "path"]), 19, [],
1096 [], (* XXX Augeas code needs tests. *)
1097 "look up the value of an Augeas path",
1099 Look up the value associated with C<path>. If C<path>
1100 matches exactly one node, the C<value> is returned.");
1102 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
1103 [], (* XXX Augeas code needs tests. *)
1104 "set Augeas path to value",
1106 Set the value associated with C<path> to C<value>.");
1108 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
1109 [], (* XXX Augeas code needs tests. *)
1110 "insert a sibling Augeas node",
1112 Create a new sibling C<label> for C<path>, inserting it into
1113 the tree before or after C<path> (depending on the boolean
1116 C<path> must match exactly one existing node in the tree, and
1117 C<label> must be a label, ie. not contain C</>, C<*> or end
1118 with a bracketed index C<[N]>.");
1120 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
1121 [], (* XXX Augeas code needs tests. *)
1122 "remove an Augeas path",
1124 Remove C<path> and all of its children.
1126 On success this returns the number of entries which were removed.");
1128 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1129 [], (* XXX Augeas code needs tests. *)
1132 Move the node C<src> to C<dest>. C<src> must match exactly
1133 one node. C<dest> is overwritten if it exists.");
1135 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
1136 [], (* XXX Augeas code needs tests. *)
1137 "return Augeas nodes which match path",
1139 Returns a list of paths which match the path expression C<path>.
1140 The returned paths are sufficiently qualified so that they match
1141 exactly one node in the current tree.");
1143 ("aug_save", (RErr, []), 25, [],
1144 [], (* XXX Augeas code needs tests. *)
1145 "write all pending Augeas changes to disk",
1147 This writes all pending changes to disk.
1149 The flags which were passed to C<guestfs_aug_init> affect exactly
1150 how files are saved.");
1152 ("aug_load", (RErr, []), 27, [],
1153 [], (* XXX Augeas code needs tests. *)
1154 "load files into the tree",
1156 Load files into the tree.
1158 See C<aug_load> in the Augeas documentation for the full gory
1161 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
1162 [], (* XXX Augeas code needs tests. *)
1163 "list Augeas nodes under a path",
1165 This is just a shortcut for listing C<guestfs_aug_match>
1166 C<path/*> and sorting the resulting nodes into alphabetical order.");
1168 ("rm", (RErr, [String "path"]), 29, [],
1169 [InitBasicFS, Always, TestRun
1172 InitBasicFS, Always, TestLastFail
1174 InitBasicFS, Always, TestLastFail
1179 Remove the single file C<path>.");
1181 ("rmdir", (RErr, [String "path"]), 30, [],
1182 [InitBasicFS, Always, TestRun
1185 InitBasicFS, Always, TestLastFail
1186 [["rmdir"; "/new"]];
1187 InitBasicFS, Always, TestLastFail
1189 ["rmdir"; "/new"]]],
1190 "remove a directory",
1192 Remove the single directory C<path>.");
1194 ("rm_rf", (RErr, [String "path"]), 31, [],
1195 [InitBasicFS, Always, TestOutputFalse
1197 ["mkdir"; "/new/foo"];
1198 ["touch"; "/new/foo/bar"];
1200 ["exists"; "/new"]]],
1201 "remove a file or directory recursively",
1203 Remove the file or directory C<path>, recursively removing the
1204 contents if its a directory. This is like the C<rm -rf> shell
1207 ("mkdir", (RErr, [String "path"]), 32, [],
1208 [InitBasicFS, Always, TestOutputTrue
1210 ["is_dir"; "/new"]];
1211 InitBasicFS, Always, TestLastFail
1212 [["mkdir"; "/new/foo/bar"]]],
1213 "create a directory",
1215 Create a directory named C<path>.");
1217 ("mkdir_p", (RErr, [String "path"]), 33, [],
1218 [InitBasicFS, Always, TestOutputTrue
1219 [["mkdir_p"; "/new/foo/bar"];
1220 ["is_dir"; "/new/foo/bar"]];
1221 InitBasicFS, Always, TestOutputTrue
1222 [["mkdir_p"; "/new/foo/bar"];
1223 ["is_dir"; "/new/foo"]];
1224 InitBasicFS, Always, TestOutputTrue
1225 [["mkdir_p"; "/new/foo/bar"];
1226 ["is_dir"; "/new"]];
1227 (* Regression tests for RHBZ#503133: *)
1228 InitBasicFS, Always, TestRun
1230 ["mkdir_p"; "/new"]];
1231 InitBasicFS, Always, TestLastFail
1233 ["mkdir_p"; "/new"]]],
1234 "create a directory and parents",
1236 Create a directory named C<path>, creating any parent directories
1237 as necessary. This is like the C<mkdir -p> shell command.");
1239 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1240 [], (* XXX Need stat command to test *)
1243 Change the mode (permissions) of C<path> to C<mode>. Only
1244 numeric modes are supported.");
1246 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1247 [], (* XXX Need stat command to test *)
1248 "change file owner and group",
1250 Change the file owner to C<owner> and group to C<group>.
1252 Only numeric uid and gid are supported. If you want to use
1253 names, you will need to locate and parse the password file
1254 yourself (Augeas support makes this relatively easy).");
1256 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1257 [InitSquashFS, Always, TestOutputTrue (
1258 [["exists"; "/empty"]]);
1259 InitSquashFS, Always, TestOutputTrue (
1260 [["exists"; "/directory"]])],
1261 "test if file or directory exists",
1263 This returns C<true> if and only if there is a file, directory
1264 (or anything) with the given C<path> name.
1266 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1268 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1269 [InitSquashFS, Always, TestOutputTrue (
1270 [["is_file"; "/known-1"]]);
1271 InitSquashFS, Always, TestOutputFalse (
1272 [["is_file"; "/directory"]])],
1273 "test if file exists",
1275 This returns C<true> if and only if there is a file
1276 with the given C<path> name. Note that it returns false for
1277 other objects like directories.
1279 See also C<guestfs_stat>.");
1281 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1282 [InitSquashFS, Always, TestOutputFalse (
1283 [["is_dir"; "/known-3"]]);
1284 InitSquashFS, Always, TestOutputTrue (
1285 [["is_dir"; "/directory"]])],
1286 "test if file exists",
1288 This returns C<true> if and only if there is a directory
1289 with the given C<path> name. Note that it returns false for
1290 other objects like files.
1292 See also C<guestfs_stat>.");
1294 ("pvcreate", (RErr, [String "device"]), 39, [],
1295 [InitEmpty, Always, TestOutputListOfDevices (
1296 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1297 ["pvcreate"; "/dev/sda1"];
1298 ["pvcreate"; "/dev/sda2"];
1299 ["pvcreate"; "/dev/sda3"];
1300 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1301 "create an LVM physical volume",
1303 This creates an LVM physical volume on the named C<device>,
1304 where C<device> should usually be a partition name such
1307 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1308 [InitEmpty, Always, TestOutputList (
1309 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1310 ["pvcreate"; "/dev/sda1"];
1311 ["pvcreate"; "/dev/sda2"];
1312 ["pvcreate"; "/dev/sda3"];
1313 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1314 ["vgcreate"; "VG2"; "/dev/sda3"];
1315 ["vgs"]], ["VG1"; "VG2"])],
1316 "create an LVM volume group",
1318 This creates an LVM volume group called C<volgroup>
1319 from the non-empty list of physical volumes C<physvols>.");
1321 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1322 [InitEmpty, Always, TestOutputList (
1323 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1324 ["pvcreate"; "/dev/sda1"];
1325 ["pvcreate"; "/dev/sda2"];
1326 ["pvcreate"; "/dev/sda3"];
1327 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1328 ["vgcreate"; "VG2"; "/dev/sda3"];
1329 ["lvcreate"; "LV1"; "VG1"; "50"];
1330 ["lvcreate"; "LV2"; "VG1"; "50"];
1331 ["lvcreate"; "LV3"; "VG2"; "50"];
1332 ["lvcreate"; "LV4"; "VG2"; "50"];
1333 ["lvcreate"; "LV5"; "VG2"; "50"];
1335 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1336 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1337 "create an LVM volume group",
1339 This creates an LVM volume group called C<logvol>
1340 on the volume group C<volgroup>, with C<size> megabytes.");
1342 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1343 [InitEmpty, Always, TestOutput (
1344 [["sfdiskM"; "/dev/sda"; ","];
1345 ["mkfs"; "ext2"; "/dev/sda1"];
1346 ["mount"; "/dev/sda1"; "/"];
1347 ["write_file"; "/new"; "new file contents"; "0"];
1348 ["cat"; "/new"]], "new file contents")],
1349 "make a filesystem",
1351 This creates a filesystem on C<device> (usually a partition
1352 or LVM logical volume). The filesystem type is C<fstype>, for
1355 ("sfdisk", (RErr, [String "device";
1356 Int "cyls"; Int "heads"; Int "sectors";
1357 StringList "lines"]), 43, [DangerWillRobinson],
1359 "create partitions on a block device",
1361 This is a direct interface to the L<sfdisk(8)> program for creating
1362 partitions on block devices.
1364 C<device> should be a block device, for example C</dev/sda>.
1366 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1367 and sectors on the device, which are passed directly to sfdisk as
1368 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1369 of these, then the corresponding parameter is omitted. Usually for
1370 'large' disks, you can just pass C<0> for these, but for small
1371 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1372 out the right geometry and you will need to tell it.
1374 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1375 information refer to the L<sfdisk(8)> manpage.
1377 To create a single partition occupying the whole disk, you would
1378 pass C<lines> as a single element list, when the single element being
1379 the string C<,> (comma).
1381 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1383 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1384 [InitBasicFS, Always, TestOutput (
1385 [["write_file"; "/new"; "new file contents"; "0"];
1386 ["cat"; "/new"]], "new file contents");
1387 InitBasicFS, Always, TestOutput (
1388 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1389 ["cat"; "/new"]], "\nnew file contents\n");
1390 InitBasicFS, Always, TestOutput (
1391 [["write_file"; "/new"; "\n\n"; "0"];
1392 ["cat"; "/new"]], "\n\n");
1393 InitBasicFS, Always, TestOutput (
1394 [["write_file"; "/new"; ""; "0"];
1395 ["cat"; "/new"]], "");
1396 InitBasicFS, Always, TestOutput (
1397 [["write_file"; "/new"; "\n\n\n"; "0"];
1398 ["cat"; "/new"]], "\n\n\n");
1399 InitBasicFS, Always, TestOutput (
1400 [["write_file"; "/new"; "\n"; "0"];
1401 ["cat"; "/new"]], "\n")],
1404 This call creates a file called C<path>. The contents of the
1405 file is the string C<content> (which can contain any 8 bit data),
1406 with length C<size>.
1408 As a special case, if C<size> is C<0>
1409 then the length is calculated using C<strlen> (so in this case
1410 the content cannot contain embedded ASCII NULs).
1412 I<NB.> Owing to a bug, writing content containing ASCII NUL
1413 characters does I<not> work, even if the length is specified.
1414 We hope to resolve this bug in a future version. In the meantime
1415 use C<guestfs_upload>.");
1417 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1418 [InitEmpty, Always, TestOutputListOfDevices (
1419 [["sfdiskM"; "/dev/sda"; ","];
1420 ["mkfs"; "ext2"; "/dev/sda1"];
1421 ["mount"; "/dev/sda1"; "/"];
1422 ["mounts"]], ["/dev/sda1"]);
1423 InitEmpty, Always, TestOutputList (
1424 [["sfdiskM"; "/dev/sda"; ","];
1425 ["mkfs"; "ext2"; "/dev/sda1"];
1426 ["mount"; "/dev/sda1"; "/"];
1429 "unmount a filesystem",
1431 This unmounts the given filesystem. The filesystem may be
1432 specified either by its mountpoint (path) or the device which
1433 contains the filesystem.");
1435 ("mounts", (RStringList "devices", []), 46, [],
1436 [InitBasicFS, Always, TestOutputListOfDevices (
1437 [["mounts"]], ["/dev/sda1"])],
1438 "show mounted filesystems",
1440 This returns the list of currently mounted filesystems. It returns
1441 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1443 Some internal mounts are not shown.
1445 See also: C<guestfs_mountpoints>");
1447 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1448 [InitBasicFS, Always, TestOutputList (
1451 (* check that umount_all can unmount nested mounts correctly: *)
1452 InitEmpty, Always, TestOutputList (
1453 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1454 ["mkfs"; "ext2"; "/dev/sda1"];
1455 ["mkfs"; "ext2"; "/dev/sda2"];
1456 ["mkfs"; "ext2"; "/dev/sda3"];
1457 ["mount"; "/dev/sda1"; "/"];
1459 ["mount"; "/dev/sda2"; "/mp1"];
1460 ["mkdir"; "/mp1/mp2"];
1461 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1462 ["mkdir"; "/mp1/mp2/mp3"];
1465 "unmount all filesystems",
1467 This unmounts all mounted filesystems.
1469 Some internal mounts are not unmounted by this call.");
1471 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1473 "remove all LVM LVs, VGs and PVs",
1475 This command removes all LVM logical volumes, volume groups
1476 and physical volumes.");
1478 ("file", (RString "description", [String "path"]), 49, [],
1479 [InitSquashFS, Always, TestOutput (
1480 [["file"; "/empty"]], "empty");
1481 InitSquashFS, Always, TestOutput (
1482 [["file"; "/known-1"]], "ASCII text");
1483 InitSquashFS, Always, TestLastFail (
1484 [["file"; "/notexists"]])],
1485 "determine file type",
1487 This call uses the standard L<file(1)> command to determine
1488 the type or contents of the file. This also works on devices,
1489 for example to find out whether a partition contains a filesystem.
1491 This call will also transparently look inside various types
1494 The exact command which runs is C<file -zbsL path>. Note in
1495 particular that the filename is not prepended to the output
1496 (the C<-b> option).");
1498 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1499 [InitBasicFS, Always, TestOutput (
1500 [["upload"; "test-command"; "/test-command"];
1501 ["chmod"; "0o755"; "/test-command"];
1502 ["command"; "/test-command 1"]], "Result1");
1503 InitBasicFS, Always, TestOutput (
1504 [["upload"; "test-command"; "/test-command"];
1505 ["chmod"; "0o755"; "/test-command"];
1506 ["command"; "/test-command 2"]], "Result2\n");
1507 InitBasicFS, Always, TestOutput (
1508 [["upload"; "test-command"; "/test-command"];
1509 ["chmod"; "0o755"; "/test-command"];
1510 ["command"; "/test-command 3"]], "\nResult3");
1511 InitBasicFS, Always, TestOutput (
1512 [["upload"; "test-command"; "/test-command"];
1513 ["chmod"; "0o755"; "/test-command"];
1514 ["command"; "/test-command 4"]], "\nResult4\n");
1515 InitBasicFS, Always, TestOutput (
1516 [["upload"; "test-command"; "/test-command"];
1517 ["chmod"; "0o755"; "/test-command"];
1518 ["command"; "/test-command 5"]], "\nResult5\n\n");
1519 InitBasicFS, Always, TestOutput (
1520 [["upload"; "test-command"; "/test-command"];
1521 ["chmod"; "0o755"; "/test-command"];
1522 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1523 InitBasicFS, Always, TestOutput (
1524 [["upload"; "test-command"; "/test-command"];
1525 ["chmod"; "0o755"; "/test-command"];
1526 ["command"; "/test-command 7"]], "");
1527 InitBasicFS, Always, TestOutput (
1528 [["upload"; "test-command"; "/test-command"];
1529 ["chmod"; "0o755"; "/test-command"];
1530 ["command"; "/test-command 8"]], "\n");
1531 InitBasicFS, Always, TestOutput (
1532 [["upload"; "test-command"; "/test-command"];
1533 ["chmod"; "0o755"; "/test-command"];
1534 ["command"; "/test-command 9"]], "\n\n");
1535 InitBasicFS, Always, TestOutput (
1536 [["upload"; "test-command"; "/test-command"];
1537 ["chmod"; "0o755"; "/test-command"];
1538 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1539 InitBasicFS, Always, TestOutput (
1540 [["upload"; "test-command"; "/test-command"];
1541 ["chmod"; "0o755"; "/test-command"];
1542 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1543 InitBasicFS, Always, TestLastFail (
1544 [["upload"; "test-command"; "/test-command"];
1545 ["chmod"; "0o755"; "/test-command"];
1546 ["command"; "/test-command"]])],
1547 "run a command from the guest filesystem",
1549 This call runs a command from the guest filesystem. The
1550 filesystem must be mounted, and must contain a compatible
1551 operating system (ie. something Linux, with the same
1552 or compatible processor architecture).
1554 The single parameter is an argv-style list of arguments.
1555 The first element is the name of the program to run.
1556 Subsequent elements are parameters. The list must be
1557 non-empty (ie. must contain a program name). Note that
1558 the command runs directly, and is I<not> invoked via
1559 the shell (see C<guestfs_sh>).
1561 The return value is anything printed to I<stdout> by
1564 If the command returns a non-zero exit status, then
1565 this function returns an error message. The error message
1566 string is the content of I<stderr> from the command.
1568 The C<$PATH> environment variable will contain at least
1569 C</usr/bin> and C</bin>. If you require a program from
1570 another location, you should provide the full path in the
1573 Shared libraries and data files required by the program
1574 must be available on filesystems which are mounted in the
1575 correct places. It is the caller's responsibility to ensure
1576 all filesystems that are needed are mounted at the right
1579 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1580 [InitBasicFS, Always, TestOutputList (
1581 [["upload"; "test-command"; "/test-command"];
1582 ["chmod"; "0o755"; "/test-command"];
1583 ["command_lines"; "/test-command 1"]], ["Result1"]);
1584 InitBasicFS, Always, TestOutputList (
1585 [["upload"; "test-command"; "/test-command"];
1586 ["chmod"; "0o755"; "/test-command"];
1587 ["command_lines"; "/test-command 2"]], ["Result2"]);
1588 InitBasicFS, Always, TestOutputList (
1589 [["upload"; "test-command"; "/test-command"];
1590 ["chmod"; "0o755"; "/test-command"];
1591 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1592 InitBasicFS, Always, TestOutputList (
1593 [["upload"; "test-command"; "/test-command"];
1594 ["chmod"; "0o755"; "/test-command"];
1595 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1596 InitBasicFS, Always, TestOutputList (
1597 [["upload"; "test-command"; "/test-command"];
1598 ["chmod"; "0o755"; "/test-command"];
1599 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1600 InitBasicFS, Always, TestOutputList (
1601 [["upload"; "test-command"; "/test-command"];
1602 ["chmod"; "0o755"; "/test-command"];
1603 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1604 InitBasicFS, Always, TestOutputList (
1605 [["upload"; "test-command"; "/test-command"];
1606 ["chmod"; "0o755"; "/test-command"];
1607 ["command_lines"; "/test-command 7"]], []);
1608 InitBasicFS, Always, TestOutputList (
1609 [["upload"; "test-command"; "/test-command"];
1610 ["chmod"; "0o755"; "/test-command"];
1611 ["command_lines"; "/test-command 8"]], [""]);
1612 InitBasicFS, Always, TestOutputList (
1613 [["upload"; "test-command"; "/test-command"];
1614 ["chmod"; "0o755"; "/test-command"];
1615 ["command_lines"; "/test-command 9"]], ["";""]);
1616 InitBasicFS, Always, TestOutputList (
1617 [["upload"; "test-command"; "/test-command"];
1618 ["chmod"; "0o755"; "/test-command"];
1619 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1620 InitBasicFS, Always, TestOutputList (
1621 [["upload"; "test-command"; "/test-command"];
1622 ["chmod"; "0o755"; "/test-command"];
1623 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1624 "run a command, returning lines",
1626 This is the same as C<guestfs_command>, but splits the
1627 result into a list of lines.
1629 See also: C<guestfs_sh_lines>");
1631 ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1632 [InitSquashFS, Always, TestOutputStruct (
1633 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1634 "get file information",
1636 Returns file information for the given C<path>.
1638 This is the same as the C<stat(2)> system call.");
1640 ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1641 [InitSquashFS, Always, TestOutputStruct (
1642 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1643 "get file information for a symbolic link",
1645 Returns file information for the given C<path>.
1647 This is the same as C<guestfs_stat> except that if C<path>
1648 is a symbolic link, then the link is stat-ed, not the file it
1651 This is the same as the C<lstat(2)> system call.");
1653 ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1654 [InitSquashFS, Always, TestOutputStruct (
1655 [["statvfs"; "/"]], [CompareWithInt ("namemax", 256)])],
1656 "get file system statistics",
1658 Returns file system statistics for any mounted file system.
1659 C<path> should be a file or directory in the mounted file system
1660 (typically it is the mount point itself, but it doesn't need to be).
1662 This is the same as the C<statvfs(2)> system call.");
1664 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1666 "get ext2/ext3/ext4 superblock details",
1668 This returns the contents of the ext2, ext3 or ext4 filesystem
1669 superblock on C<device>.
1671 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1672 manpage for more details. The list of fields returned isn't
1673 clearly defined, and depends on both the version of C<tune2fs>
1674 that libguestfs was built against, and the filesystem itself.");
1676 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1677 [InitEmpty, Always, TestOutputTrue (
1678 [["blockdev_setro"; "/dev/sda"];
1679 ["blockdev_getro"; "/dev/sda"]])],
1680 "set block device to read-only",
1682 Sets the block device named C<device> to read-only.
1684 This uses the L<blockdev(8)> command.");
1686 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1687 [InitEmpty, Always, TestOutputFalse (
1688 [["blockdev_setrw"; "/dev/sda"];
1689 ["blockdev_getro"; "/dev/sda"]])],
1690 "set block device to read-write",
1692 Sets the block device named C<device> to read-write.
1694 This uses the L<blockdev(8)> command.");
1696 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1697 [InitEmpty, Always, TestOutputTrue (
1698 [["blockdev_setro"; "/dev/sda"];
1699 ["blockdev_getro"; "/dev/sda"]])],
1700 "is block device set to read-only",
1702 Returns a boolean indicating if the block device is read-only
1703 (true if read-only, false if not).
1705 This uses the L<blockdev(8)> command.");
1707 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1708 [InitEmpty, Always, TestOutputInt (
1709 [["blockdev_getss"; "/dev/sda"]], 512)],
1710 "get sectorsize of block device",
1712 This returns the size of sectors on a block device.
1713 Usually 512, but can be larger for modern devices.
1715 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1718 This uses the L<blockdev(8)> command.");
1720 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1721 [InitEmpty, Always, TestOutputInt (
1722 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1723 "get blocksize of block device",
1725 This returns the block size of a device.
1727 (Note this is different from both I<size in blocks> and
1728 I<filesystem block size>).
1730 This uses the L<blockdev(8)> command.");
1732 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1734 "set blocksize of block device",
1736 This sets the block size of a device.
1738 (Note this is different from both I<size in blocks> and
1739 I<filesystem block size>).
1741 This uses the L<blockdev(8)> command.");
1743 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1744 [InitEmpty, Always, TestOutputInt (
1745 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1746 "get total size of device in 512-byte sectors",
1748 This returns the size of the device in units of 512-byte sectors
1749 (even if the sectorsize isn't 512 bytes ... weird).
1751 See also C<guestfs_blockdev_getss> for the real sector size of
1752 the device, and C<guestfs_blockdev_getsize64> for the more
1753 useful I<size in bytes>.
1755 This uses the L<blockdev(8)> command.");
1757 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1758 [InitEmpty, Always, TestOutputInt (
1759 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1760 "get total size of device in bytes",
1762 This returns the size of the device in bytes.
1764 See also C<guestfs_blockdev_getsz>.
1766 This uses the L<blockdev(8)> command.");
1768 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1769 [InitEmpty, Always, TestRun
1770 [["blockdev_flushbufs"; "/dev/sda"]]],
1771 "flush device buffers",
1773 This tells the kernel to flush internal buffers associated
1776 This uses the L<blockdev(8)> command.");
1778 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1779 [InitEmpty, Always, TestRun
1780 [["blockdev_rereadpt"; "/dev/sda"]]],
1781 "reread partition table",
1783 Reread the partition table on C<device>.
1785 This uses the L<blockdev(8)> command.");
1787 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1788 [InitBasicFS, Always, TestOutput (
1789 (* Pick a file from cwd which isn't likely to change. *)
1790 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1791 ["checksum"; "md5"; "/COPYING.LIB"]],
1792 Digest.to_hex (Digest.file "COPYING.LIB"))],
1793 "upload a file from the local machine",
1795 Upload local file C<filename> to C<remotefilename> on the
1798 C<filename> can also be a named pipe.
1800 See also C<guestfs_download>.");
1802 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1803 [InitBasicFS, Always, TestOutput (
1804 (* Pick a file from cwd which isn't likely to change. *)
1805 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1806 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1807 ["upload"; "testdownload.tmp"; "/upload"];
1808 ["checksum"; "md5"; "/upload"]],
1809 Digest.to_hex (Digest.file "COPYING.LIB"))],
1810 "download a file to the local machine",
1812 Download file C<remotefilename> and save it as C<filename>
1813 on the local machine.
1815 C<filename> can also be a named pipe.
1817 See also C<guestfs_upload>, C<guestfs_cat>.");
1819 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1820 [InitSquashFS, Always, TestOutput (
1821 [["checksum"; "crc"; "/known-3"]], "2891671662");
1822 InitSquashFS, Always, TestLastFail (
1823 [["checksum"; "crc"; "/notexists"]]);
1824 InitSquashFS, Always, TestOutput (
1825 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1826 InitSquashFS, Always, TestOutput (
1827 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1828 InitSquashFS, Always, TestOutput (
1829 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1830 InitSquashFS, Always, TestOutput (
1831 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1832 InitSquashFS, Always, TestOutput (
1833 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1834 InitSquashFS, Always, TestOutput (
1835 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1836 "compute MD5, SHAx or CRC checksum of file",
1838 This call computes the MD5, SHAx or CRC checksum of the
1841 The type of checksum to compute is given by the C<csumtype>
1842 parameter which must have one of the following values:
1848 Compute the cyclic redundancy check (CRC) specified by POSIX
1849 for the C<cksum> command.
1853 Compute the MD5 hash (using the C<md5sum> program).
1857 Compute the SHA1 hash (using the C<sha1sum> program).
1861 Compute the SHA224 hash (using the C<sha224sum> program).
1865 Compute the SHA256 hash (using the C<sha256sum> program).
1869 Compute the SHA384 hash (using the C<sha384sum> program).
1873 Compute the SHA512 hash (using the C<sha512sum> program).
1877 The checksum is returned as a printable string.");
1879 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1880 [InitBasicFS, Always, TestOutput (
1881 [["tar_in"; "../images/helloworld.tar"; "/"];
1882 ["cat"; "/hello"]], "hello\n")],
1883 "unpack tarfile to directory",
1885 This command uploads and unpacks local file C<tarfile> (an
1886 I<uncompressed> tar file) into C<directory>.
1888 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1890 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1892 "pack directory into tarfile",
1894 This command packs the contents of C<directory> and downloads
1895 it to local file C<tarfile>.
1897 To download a compressed tarball, use C<guestfs_tgz_out>.");
1899 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1900 [InitBasicFS, Always, TestOutput (
1901 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1902 ["cat"; "/hello"]], "hello\n")],
1903 "unpack compressed tarball to directory",
1905 This command uploads and unpacks local file C<tarball> (a
1906 I<gzip compressed> tar file) into C<directory>.
1908 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1910 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1912 "pack directory into compressed tarball",
1914 This command packs the contents of C<directory> and downloads
1915 it to local file C<tarball>.
1917 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1919 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1920 [InitBasicFS, Always, TestLastFail (
1922 ["mount_ro"; "/dev/sda1"; "/"];
1923 ["touch"; "/new"]]);
1924 InitBasicFS, Always, TestOutput (
1925 [["write_file"; "/new"; "data"; "0"];
1927 ["mount_ro"; "/dev/sda1"; "/"];
1928 ["cat"; "/new"]], "data")],
1929 "mount a guest disk, read-only",
1931 This is the same as the C<guestfs_mount> command, but it
1932 mounts the filesystem with the read-only (I<-o ro>) flag.");
1934 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1936 "mount a guest disk with mount options",
1938 This is the same as the C<guestfs_mount> command, but it
1939 allows you to set the mount options as for the
1940 L<mount(8)> I<-o> flag.");
1942 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1944 "mount a guest disk with mount options and vfstype",
1946 This is the same as the C<guestfs_mount> command, but it
1947 allows you to set both the mount options and the vfstype
1948 as for the L<mount(8)> I<-o> and I<-t> flags.");
1950 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1952 "debugging and internals",
1954 The C<guestfs_debug> command exposes some internals of
1955 C<guestfsd> (the guestfs daemon) that runs inside the
1958 There is no comprehensive help for this command. You have
1959 to look at the file C<daemon/debug.c> in the libguestfs source
1960 to find out what you can do.");
1962 ("lvremove", (RErr, [String "device"]), 77, [],
1963 [InitEmpty, Always, TestOutputList (
1964 [["sfdiskM"; "/dev/sda"; ","];
1965 ["pvcreate"; "/dev/sda1"];
1966 ["vgcreate"; "VG"; "/dev/sda1"];
1967 ["lvcreate"; "LV1"; "VG"; "50"];
1968 ["lvcreate"; "LV2"; "VG"; "50"];
1969 ["lvremove"; "/dev/VG/LV1"];
1970 ["lvs"]], ["/dev/VG/LV2"]);
1971 InitEmpty, Always, TestOutputList (
1972 [["sfdiskM"; "/dev/sda"; ","];
1973 ["pvcreate"; "/dev/sda1"];
1974 ["vgcreate"; "VG"; "/dev/sda1"];
1975 ["lvcreate"; "LV1"; "VG"; "50"];
1976 ["lvcreate"; "LV2"; "VG"; "50"];
1977 ["lvremove"; "/dev/VG"];
1979 InitEmpty, Always, TestOutputList (
1980 [["sfdiskM"; "/dev/sda"; ","];
1981 ["pvcreate"; "/dev/sda1"];
1982 ["vgcreate"; "VG"; "/dev/sda1"];
1983 ["lvcreate"; "LV1"; "VG"; "50"];
1984 ["lvcreate"; "LV2"; "VG"; "50"];
1985 ["lvremove"; "/dev/VG"];
1987 "remove an LVM logical volume",
1989 Remove an LVM logical volume C<device>, where C<device> is
1990 the path to the LV, such as C</dev/VG/LV>.
1992 You can also remove all LVs in a volume group by specifying
1993 the VG name, C</dev/VG>.");
1995 ("vgremove", (RErr, [String "vgname"]), 78, [],
1996 [InitEmpty, Always, TestOutputList (
1997 [["sfdiskM"; "/dev/sda"; ","];
1998 ["pvcreate"; "/dev/sda1"];
1999 ["vgcreate"; "VG"; "/dev/sda1"];
2000 ["lvcreate"; "LV1"; "VG"; "50"];
2001 ["lvcreate"; "LV2"; "VG"; "50"];
2004 InitEmpty, Always, TestOutputList (
2005 [["sfdiskM"; "/dev/sda"; ","];
2006 ["pvcreate"; "/dev/sda1"];
2007 ["vgcreate"; "VG"; "/dev/sda1"];
2008 ["lvcreate"; "LV1"; "VG"; "50"];
2009 ["lvcreate"; "LV2"; "VG"; "50"];
2012 "remove an LVM volume group",
2014 Remove an LVM volume group C<vgname>, (for example C<VG>).
2016 This also forcibly removes all logical volumes in the volume
2019 ("pvremove", (RErr, [String "device"]), 79, [],
2020 [InitEmpty, Always, TestOutputListOfDevices (
2021 [["sfdiskM"; "/dev/sda"; ","];
2022 ["pvcreate"; "/dev/sda1"];
2023 ["vgcreate"; "VG"; "/dev/sda1"];
2024 ["lvcreate"; "LV1"; "VG"; "50"];
2025 ["lvcreate"; "LV2"; "VG"; "50"];
2027 ["pvremove"; "/dev/sda1"];
2029 InitEmpty, Always, TestOutputListOfDevices (
2030 [["sfdiskM"; "/dev/sda"; ","];
2031 ["pvcreate"; "/dev/sda1"];
2032 ["vgcreate"; "VG"; "/dev/sda1"];
2033 ["lvcreate"; "LV1"; "VG"; "50"];
2034 ["lvcreate"; "LV2"; "VG"; "50"];
2036 ["pvremove"; "/dev/sda1"];
2038 InitEmpty, Always, TestOutputListOfDevices (
2039 [["sfdiskM"; "/dev/sda"; ","];
2040 ["pvcreate"; "/dev/sda1"];
2041 ["vgcreate"; "VG"; "/dev/sda1"];
2042 ["lvcreate"; "LV1"; "VG"; "50"];
2043 ["lvcreate"; "LV2"; "VG"; "50"];
2045 ["pvremove"; "/dev/sda1"];
2047 "remove an LVM physical volume",
2049 This wipes a physical volume C<device> so that LVM will no longer
2052 The implementation uses the C<pvremove> command which refuses to
2053 wipe physical volumes that contain any volume groups, so you have
2054 to remove those first.");
2056 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
2057 [InitBasicFS, Always, TestOutput (
2058 [["set_e2label"; "/dev/sda1"; "testlabel"];
2059 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2060 "set the ext2/3/4 filesystem label",
2062 This sets the ext2/3/4 filesystem label of the filesystem on
2063 C<device> to C<label>. Filesystem labels are limited to
2066 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2067 to return the existing label on a filesystem.");
2069 ("get_e2label", (RString "label", [String "device"]), 81, [],
2071 "get the ext2/3/4 filesystem label",
2073 This returns the ext2/3/4 filesystem label of the filesystem on
2076 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2077 [InitBasicFS, Always, TestOutput (
2078 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2079 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2080 InitBasicFS, Always, TestOutput (
2081 [["set_e2uuid"; "/dev/sda1"; "clear"];
2082 ["get_e2uuid"; "/dev/sda1"]], "");
2083 (* We can't predict what UUIDs will be, so just check the commands run. *)
2084 InitBasicFS, Always, TestRun (
2085 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2086 InitBasicFS, Always, TestRun (
2087 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2088 "set the ext2/3/4 filesystem UUID",
2090 This sets the ext2/3/4 filesystem UUID of the filesystem on
2091 C<device> to C<uuid>. The format of the UUID and alternatives
2092 such as C<clear>, C<random> and C<time> are described in the
2093 L<tune2fs(8)> manpage.
2095 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2096 to return the existing UUID of a filesystem.");
2098 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2100 "get the ext2/3/4 filesystem UUID",
2102 This returns the ext2/3/4 filesystem UUID of the filesystem on
2105 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2106 [InitBasicFS, Always, TestOutputInt (
2107 [["umount"; "/dev/sda1"];
2108 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2109 InitBasicFS, Always, TestOutputInt (
2110 [["umount"; "/dev/sda1"];
2111 ["zero"; "/dev/sda1"];
2112 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2113 "run the filesystem checker",
2115 This runs the filesystem checker (fsck) on C<device> which
2116 should have filesystem type C<fstype>.
2118 The returned integer is the status. See L<fsck(8)> for the
2119 list of status codes from C<fsck>.
2127 Multiple status codes can be summed together.
2131 A non-zero return code can mean \"success\", for example if
2132 errors have been corrected on the filesystem.
2136 Checking or repairing NTFS volumes is not supported
2141 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2143 ("zero", (RErr, [String "device"]), 85, [],
2144 [InitBasicFS, Always, TestOutput (
2145 [["umount"; "/dev/sda1"];
2146 ["zero"; "/dev/sda1"];
2147 ["file"; "/dev/sda1"]], "data")],
2148 "write zeroes to the device",
2150 This command writes zeroes over the first few blocks of C<device>.
2152 How many blocks are zeroed isn't specified (but it's I<not> enough
2153 to securely wipe the device). It should be sufficient to remove
2154 any partition tables, filesystem superblocks and so on.
2156 See also: C<guestfs_scrub_device>.");
2158 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2159 (* Test disabled because grub-install incompatible with virtio-blk driver.
2160 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2162 [InitBasicFS, Disabled, TestOutputTrue (
2163 [["grub_install"; "/"; "/dev/sda1"];
2164 ["is_dir"; "/boot"]])],
2167 This command installs GRUB (the Grand Unified Bootloader) on
2168 C<device>, with the root directory being C<root>.");
2170 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2171 [InitBasicFS, Always, TestOutput (
2172 [["write_file"; "/old"; "file content"; "0"];
2173 ["cp"; "/old"; "/new"];
2174 ["cat"; "/new"]], "file content");
2175 InitBasicFS, Always, TestOutputTrue (
2176 [["write_file"; "/old"; "file content"; "0"];
2177 ["cp"; "/old"; "/new"];
2178 ["is_file"; "/old"]]);
2179 InitBasicFS, Always, TestOutput (
2180 [["write_file"; "/old"; "file content"; "0"];
2182 ["cp"; "/old"; "/dir/new"];
2183 ["cat"; "/dir/new"]], "file content")],
2186 This copies a file from C<src> to C<dest> where C<dest> is
2187 either a destination filename or destination directory.");
2189 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2190 [InitBasicFS, Always, TestOutput (
2191 [["mkdir"; "/olddir"];
2192 ["mkdir"; "/newdir"];
2193 ["write_file"; "/olddir/file"; "file content"; "0"];
2194 ["cp_a"; "/olddir"; "/newdir"];
2195 ["cat"; "/newdir/olddir/file"]], "file content")],
2196 "copy a file or directory recursively",
2198 This copies a file or directory from C<src> to C<dest>
2199 recursively using the C<cp -a> command.");
2201 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2202 [InitBasicFS, Always, TestOutput (
2203 [["write_file"; "/old"; "file content"; "0"];
2204 ["mv"; "/old"; "/new"];
2205 ["cat"; "/new"]], "file content");
2206 InitBasicFS, Always, TestOutputFalse (
2207 [["write_file"; "/old"; "file content"; "0"];
2208 ["mv"; "/old"; "/new"];
2209 ["is_file"; "/old"]])],
2212 This moves a file from C<src> to C<dest> where C<dest> is
2213 either a destination filename or destination directory.");
2215 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2216 [InitEmpty, Always, TestRun (
2217 [["drop_caches"; "3"]])],
2218 "drop kernel page cache, dentries and inodes",
2220 This instructs the guest kernel to drop its page cache,
2221 and/or dentries and inode caches. The parameter C<whattodrop>
2222 tells the kernel what precisely to drop, see
2223 L<http://linux-mm.org/Drop_Caches>
2225 Setting C<whattodrop> to 3 should drop everything.
2227 This automatically calls L<sync(2)> before the operation,
2228 so that the maximum guest memory is freed.");
2230 ("dmesg", (RString "kmsgs", []), 91, [],
2231 [InitEmpty, Always, TestRun (
2233 "return kernel messages",
2235 This returns the kernel messages (C<dmesg> output) from
2236 the guest kernel. This is sometimes useful for extended
2237 debugging of problems.
2239 Another way to get the same information is to enable
2240 verbose messages with C<guestfs_set_verbose> or by setting
2241 the environment variable C<LIBGUESTFS_DEBUG=1> before
2242 running the program.");
2244 ("ping_daemon", (RErr, []), 92, [],
2245 [InitEmpty, Always, TestRun (
2246 [["ping_daemon"]])],
2247 "ping the guest daemon",
2249 This is a test probe into the guestfs daemon running inside
2250 the qemu subprocess. Calling this function checks that the
2251 daemon responds to the ping message, without affecting the daemon
2252 or attached block device(s) in any other way.");
2254 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2255 [InitBasicFS, Always, TestOutputTrue (
2256 [["write_file"; "/file1"; "contents of a file"; "0"];
2257 ["cp"; "/file1"; "/file2"];
2258 ["equal"; "/file1"; "/file2"]]);
2259 InitBasicFS, Always, TestOutputFalse (
2260 [["write_file"; "/file1"; "contents of a file"; "0"];
2261 ["write_file"; "/file2"; "contents of another file"; "0"];
2262 ["equal"; "/file1"; "/file2"]]);
2263 InitBasicFS, Always, TestLastFail (
2264 [["equal"; "/file1"; "/file2"]])],
2265 "test if two files have equal contents",
2267 This compares the two files C<file1> and C<file2> and returns
2268 true if their content is exactly equal, or false otherwise.
2270 The external L<cmp(1)> program is used for the comparison.");
2272 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2273 [InitSquashFS, Always, TestOutputList (
2274 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2275 InitSquashFS, Always, TestOutputList (
2276 [["strings"; "/empty"]], [])],
2277 "print the printable strings in a file",
2279 This runs the L<strings(1)> command on a file and returns
2280 the list of printable strings found.");
2282 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2283 [InitSquashFS, Always, TestOutputList (
2284 [["strings_e"; "b"; "/known-5"]], []);
2285 InitBasicFS, Disabled, TestOutputList (
2286 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2287 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2288 "print the printable strings in a file",
2290 This is like the C<guestfs_strings> command, but allows you to
2291 specify the encoding.
2293 See the L<strings(1)> manpage for the full list of encodings.
2295 Commonly useful encodings are C<l> (lower case L) which will
2296 show strings inside Windows/x86 files.
2298 The returned strings are transcoded to UTF-8.");
2300 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2301 [InitSquashFS, Always, TestOutput (
2302 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2303 (* Test for RHBZ#501888c2 regression which caused large hexdump
2304 * commands to segfault.
2306 InitSquashFS, Always, TestRun (
2307 [["hexdump"; "/100krandom"]])],
2308 "dump a file in hexadecimal",
2310 This runs C<hexdump -C> on the given C<path>. The result is
2311 the human-readable, canonical hex dump of the file.");
2313 ("zerofree", (RErr, [String "device"]), 97, [],
2314 [InitNone, Always, TestOutput (
2315 [["sfdiskM"; "/dev/sda"; ","];
2316 ["mkfs"; "ext3"; "/dev/sda1"];
2317 ["mount"; "/dev/sda1"; "/"];
2318 ["write_file"; "/new"; "test file"; "0"];
2319 ["umount"; "/dev/sda1"];
2320 ["zerofree"; "/dev/sda1"];
2321 ["mount"; "/dev/sda1"; "/"];
2322 ["cat"; "/new"]], "test file")],
2323 "zero unused inodes and disk blocks on ext2/3 filesystem",
2325 This runs the I<zerofree> program on C<device>. This program
2326 claims to zero unused inodes and disk blocks on an ext2/3
2327 filesystem, thus making it possible to compress the filesystem
2330 You should B<not> run this program if the filesystem is
2333 It is possible that using this program can damage the filesystem
2334 or data on the filesystem.");
2336 ("pvresize", (RErr, [String "device"]), 98, [],
2338 "resize an LVM physical volume",
2340 This resizes (expands or shrinks) an existing LVM physical
2341 volume to match the new size of the underlying device.");
2343 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2344 Int "cyls"; Int "heads"; Int "sectors";
2345 String "line"]), 99, [DangerWillRobinson],
2347 "modify a single partition on a block device",
2349 This runs L<sfdisk(8)> option to modify just the single
2350 partition C<n> (note: C<n> counts from 1).
2352 For other parameters, see C<guestfs_sfdisk>. You should usually
2353 pass C<0> for the cyls/heads/sectors parameters.");
2355 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2357 "display the partition table",
2359 This displays the partition table on C<device>, in the
2360 human-readable output of the L<sfdisk(8)> command. It is
2361 not intended to be parsed.");
2363 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2365 "display the kernel geometry",
2367 This displays the kernel's idea of the geometry of C<device>.
2369 The result is in human-readable format, and not designed to
2372 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2374 "display the disk geometry from the partition table",
2376 This displays the disk geometry of C<device> read from the
2377 partition table. Especially in the case where the underlying
2378 block device has been resized, this can be different from the
2379 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2381 The result is in human-readable format, and not designed to
2384 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2386 "activate or deactivate all volume groups",
2388 This command activates or (if C<activate> is false) deactivates
2389 all logical volumes in all volume groups.
2390 If activated, then they are made known to the
2391 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2392 then those devices disappear.
2394 This command is the same as running C<vgchange -a y|n>");
2396 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2398 "activate or deactivate some volume groups",
2400 This command activates or (if C<activate> is false) deactivates
2401 all logical volumes in the listed volume groups C<volgroups>.
2402 If activated, then they are made known to the
2403 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2404 then those devices disappear.
2406 This command is the same as running C<vgchange -a y|n volgroups...>
2408 Note that if C<volgroups> is an empty list then B<all> volume groups
2409 are activated or deactivated.");
2411 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2412 [InitNone, Always, TestOutput (
2413 [["sfdiskM"; "/dev/sda"; ","];
2414 ["pvcreate"; "/dev/sda1"];
2415 ["vgcreate"; "VG"; "/dev/sda1"];
2416 ["lvcreate"; "LV"; "VG"; "10"];
2417 ["mkfs"; "ext2"; "/dev/VG/LV"];
2418 ["mount"; "/dev/VG/LV"; "/"];
2419 ["write_file"; "/new"; "test content"; "0"];
2421 ["lvresize"; "/dev/VG/LV"; "20"];
2422 ["e2fsck_f"; "/dev/VG/LV"];
2423 ["resize2fs"; "/dev/VG/LV"];
2424 ["mount"; "/dev/VG/LV"; "/"];
2425 ["cat"; "/new"]], "test content")],
2426 "resize an LVM logical volume",
2428 This resizes (expands or shrinks) an existing LVM logical
2429 volume to C<mbytes>. When reducing, data in the reduced part
2432 ("resize2fs", (RErr, [String "device"]), 106, [],
2433 [], (* lvresize tests this *)
2434 "resize an ext2/ext3 filesystem",
2436 This resizes an ext2 or ext3 filesystem to match the size of
2437 the underlying device.
2439 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2440 on the C<device> before calling this command. For unknown reasons
2441 C<resize2fs> sometimes gives an error about this and sometimes not.
2442 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2443 calling this function.");
2445 ("find", (RStringList "names", [String "directory"]), 107, [],
2446 [InitBasicFS, Always, TestOutputList (
2447 [["find"; "/"]], ["lost+found"]);
2448 InitBasicFS, Always, TestOutputList (
2452 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2453 InitBasicFS, Always, TestOutputList (
2454 [["mkdir_p"; "/a/b/c"];
2455 ["touch"; "/a/b/c/d"];
2456 ["find"; "/a/b/"]], ["c"; "c/d"])],
2457 "find all files and directories",
2459 This command lists out all files and directories, recursively,
2460 starting at C<directory>. It is essentially equivalent to
2461 running the shell command C<find directory -print> but some
2462 post-processing happens on the output, described below.
2464 This returns a list of strings I<without any prefix>. Thus
2465 if the directory structure was:
2471 then the returned list from C<guestfs_find> C</tmp> would be
2479 If C<directory> is not a directory, then this command returns
2482 The returned list is sorted.");
2484 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2485 [], (* lvresize tests this *)
2486 "check an ext2/ext3 filesystem",
2488 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2489 filesystem checker on C<device>, noninteractively (C<-p>),
2490 even if the filesystem appears to be clean (C<-f>).
2492 This command is only needed because of C<guestfs_resize2fs>
2493 (q.v.). Normally you should use C<guestfs_fsck>.");
2495 ("sleep", (RErr, [Int "secs"]), 109, [],
2496 [InitNone, Always, TestRun (
2498 "sleep for some seconds",
2500 Sleep for C<secs> seconds.");
2502 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2503 [InitNone, Always, TestOutputInt (
2504 [["sfdiskM"; "/dev/sda"; ","];
2505 ["mkfs"; "ntfs"; "/dev/sda1"];
2506 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2507 InitNone, Always, TestOutputInt (
2508 [["sfdiskM"; "/dev/sda"; ","];
2509 ["mkfs"; "ext2"; "/dev/sda1"];
2510 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2511 "probe NTFS volume",
2513 This command runs the L<ntfs-3g.probe(8)> command which probes
2514 an NTFS C<device> for mountability. (Not all NTFS volumes can
2515 be mounted read-write, and some cannot be mounted at all).
2517 C<rw> is a boolean flag. Set it to true if you want to test
2518 if the volume can be mounted read-write. Set it to false if
2519 you want to test if the volume can be mounted read-only.
2521 The return value is an integer which C<0> if the operation
2522 would succeed, or some non-zero value documented in the
2523 L<ntfs-3g.probe(8)> manual page.");
2525 ("sh", (RString "output", [String "command"]), 111, [],
2526 [], (* XXX needs tests *)
2527 "run a command via the shell",
2529 This call runs a command from the guest filesystem via the
2532 This is like C<guestfs_command>, but passes the command to:
2534 /bin/sh -c \"command\"
2536 Depending on the guest's shell, this usually results in
2537 wildcards being expanded, shell expressions being interpolated
2540 All the provisos about C<guestfs_command> apply to this call.");
2542 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2543 [], (* XXX needs tests *)
2544 "run a command via the shell returning lines",
2546 This is the same as C<guestfs_sh>, but splits the result
2547 into a list of lines.
2549 See also: C<guestfs_command_lines>");
2551 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2552 [InitBasicFS, Always, TestOutputList (
2553 [["mkdir_p"; "/a/b/c"];
2554 ["touch"; "/a/b/c/d"];
2555 ["touch"; "/a/b/c/e"];
2556 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2557 InitBasicFS, Always, TestOutputList (
2558 [["mkdir_p"; "/a/b/c"];
2559 ["touch"; "/a/b/c/d"];
2560 ["touch"; "/a/b/c/e"];
2561 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2562 InitBasicFS, Always, TestOutputList (
2563 [["mkdir_p"; "/a/b/c"];
2564 ["touch"; "/a/b/c/d"];
2565 ["touch"; "/a/b/c/e"];
2566 ["glob_expand"; "/a/*/x/*"]], [])],
2567 "expand a wildcard path",
2569 This command searches for all the pathnames matching
2570 C<pattern> according to the wildcard expansion rules
2573 If no paths match, then this returns an empty list
2574 (note: not an error).
2576 It is just a wrapper around the C L<glob(3)> function
2577 with flags C<GLOB_MARK|GLOB_BRACE>.
2578 See that manual page for more details.");
2580 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2581 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2582 [["scrub_device"; "/dev/sdc"]])],
2583 "scrub (securely wipe) a device",
2585 This command writes patterns over C<device> to make data retrieval
2588 It is an interface to the L<scrub(1)> program. See that
2589 manual page for more details.");
2591 ("scrub_file", (RErr, [String "file"]), 115, [],
2592 [InitBasicFS, Always, TestRun (
2593 [["write_file"; "/file"; "content"; "0"];
2594 ["scrub_file"; "/file"]])],
2595 "scrub (securely wipe) a file",
2597 This command writes patterns over a file to make data retrieval
2600 The file is I<removed> after scrubbing.
2602 It is an interface to the L<scrub(1)> program. See that
2603 manual page for more details.");
2605 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2606 [], (* XXX needs testing *)
2607 "scrub (securely wipe) free space",
2609 This command creates the directory C<dir> and then fills it
2610 with files until the filesystem is full, and scrubs the files
2611 as for C<guestfs_scrub_file>, and deletes them.
2612 The intention is to scrub any free space on the partition
2615 It is an interface to the L<scrub(1)> program. See that
2616 manual page for more details.");
2618 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2619 [InitBasicFS, Always, TestRun (
2621 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2622 "create a temporary directory",
2624 This command creates a temporary directory. The
2625 C<template> parameter should be a full pathname for the
2626 temporary directory name with the final six characters being
2629 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2630 the second one being suitable for Windows filesystems.
2632 The name of the temporary directory that was created
2635 The temporary directory is created with mode 0700
2636 and is owned by root.
2638 The caller is responsible for deleting the temporary
2639 directory and its contents after use.
2641 See also: L<mkdtemp(3)>");
2643 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2644 [InitSquashFS, Always, TestOutputInt (
2645 [["wc_l"; "/10klines"]], 10000)],
2646 "count lines in a file",
2648 This command counts the lines in a file, using the
2649 C<wc -l> external command.");
2651 ("wc_w", (RInt "words", [String "path"]), 119, [],
2652 [InitSquashFS, Always, TestOutputInt (
2653 [["wc_w"; "/10klines"]], 10000)],
2654 "count words in a file",
2656 This command counts the words in a file, using the
2657 C<wc -w> external command.");
2659 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2660 [InitSquashFS, Always, TestOutputInt (
2661 [["wc_c"; "/100kallspaces"]], 102400)],
2662 "count characters in a file",
2664 This command counts the characters in a file, using the
2665 C<wc -c> external command.");
2667 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2668 [InitSquashFS, Always, TestOutputList (
2669 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2670 "return first 10 lines of a file",
2672 This command returns up to the first 10 lines of a file as
2673 a list of strings.");
2675 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2676 [InitSquashFS, Always, TestOutputList (
2677 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2678 InitSquashFS, Always, TestOutputList (
2679 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2680 InitSquashFS, Always, TestOutputList (
2681 [["head_n"; "0"; "/10klines"]], [])],
2682 "return first N lines of a file",
2684 If the parameter C<nrlines> is a positive number, this returns the first
2685 C<nrlines> lines of the file C<path>.
2687 If the parameter C<nrlines> is a negative number, this returns lines
2688 from the file C<path>, excluding the last C<nrlines> lines.
2690 If the parameter C<nrlines> is zero, this returns an empty list.");
2692 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2693 [InitSquashFS, Always, TestOutputList (
2694 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2695 "return last 10 lines of a file",
2697 This command returns up to the last 10 lines of a file as
2698 a list of strings.");
2700 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2701 [InitSquashFS, Always, TestOutputList (
2702 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2703 InitSquashFS, Always, TestOutputList (
2704 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2705 InitSquashFS, Always, TestOutputList (
2706 [["tail_n"; "0"; "/10klines"]], [])],
2707 "return last N lines of a file",
2709 If the parameter C<nrlines> is a positive number, this returns the last
2710 C<nrlines> lines of the file C<path>.
2712 If the parameter C<nrlines> is a negative number, this returns lines
2713 from the file C<path>, starting with the C<-nrlines>th line.
2715 If the parameter C<nrlines> is zero, this returns an empty list.");
2717 ("df", (RString "output", []), 125, [],
2718 [], (* XXX Tricky to test because it depends on the exact format
2719 * of the 'df' command and other imponderables.
2721 "report file system disk space usage",
2723 This command runs the C<df> command to report disk space used.
2725 This command is mostly useful for interactive sessions. It
2726 is I<not> intended that you try to parse the output string.
2727 Use C<statvfs> from programs.");
2729 ("df_h", (RString "output", []), 126, [],
2730 [], (* XXX Tricky to test because it depends on the exact format
2731 * of the 'df' command and other imponderables.
2733 "report file system disk space usage (human readable)",
2735 This command runs the C<df -h> command to report disk space used
2736 in human-readable format.
2738 This command is mostly useful for interactive sessions. It
2739 is I<not> intended that you try to parse the output string.
2740 Use C<statvfs> from programs.");
2742 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2743 [InitSquashFS, Always, TestOutputInt (
2744 [["du"; "/directory"]], 0 (* squashfs doesn't have blocks *))],
2745 "estimate file space usage",
2747 This command runs the C<du -s> command to estimate file space
2750 C<path> can be a file or a directory. If C<path> is a directory
2751 then the estimate includes the contents of the directory and all
2752 subdirectories (recursively).
2754 The result is the estimated size in I<kilobytes>
2755 (ie. units of 1024 bytes).");
2757 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2758 [InitSquashFS, Always, TestOutputList (
2759 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2760 "list files in an initrd",
2762 This command lists out files contained in an initrd.
2764 The files are listed without any initial C</> character. The
2765 files are listed in the order they appear (not necessarily
2766 alphabetical). Directory names are listed as separate items.
2768 Old Linux kernels (2.4 and earlier) used a compressed ext2
2769 filesystem as initrd. We I<only> support the newer initramfs
2770 format (compressed cpio files).");
2772 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2774 "mount a file using the loop device",
2776 This command lets you mount C<file> (a filesystem image
2777 in a file) on a mount point. It is entirely equivalent to
2778 the command C<mount -o loop file mountpoint>.");
2780 ("mkswap", (RErr, [String "device"]), 130, [],
2781 [InitEmpty, Always, TestRun (
2782 [["sfdiskM"; "/dev/sda"; ","];
2783 ["mkswap"; "/dev/sda1"]])],
2784 "create a swap partition",
2786 Create a swap partition on C<device>.");
2788 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2789 [InitEmpty, Always, TestRun (
2790 [["sfdiskM"; "/dev/sda"; ","];
2791 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2792 "create a swap partition with a label",
2794 Create a swap partition on C<device> with label C<label>.
2796 Note that you cannot attach a swap label to a block device
2797 (eg. C</dev/sda>), just to a partition. This appears to be
2798 a limitation of the kernel or swap tools.");
2800 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2801 [InitEmpty, Always, TestRun (
2802 [["sfdiskM"; "/dev/sda"; ","];
2803 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2804 "create a swap partition with an explicit UUID",
2806 Create a swap partition on C<device> with UUID C<uuid>.");
2808 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2809 [InitBasicFS, Always, TestOutputStruct (
2810 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2811 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2812 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2813 InitBasicFS, Always, TestOutputStruct (
2814 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2815 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2816 "make block, character or FIFO devices",
2818 This call creates block or character special devices, or
2819 named pipes (FIFOs).
2821 The C<mode> parameter should be the mode, using the standard
2822 constants. C<devmajor> and C<devminor> are the
2823 device major and minor numbers, only used when creating block
2824 and character special devices.");
2826 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2827 [InitBasicFS, Always, TestOutputStruct (
2828 [["mkfifo"; "0o777"; "/node"];
2829 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2830 "make FIFO (named pipe)",
2832 This call creates a FIFO (named pipe) called C<path> with
2833 mode C<mode>. It is just a convenient wrapper around
2834 C<guestfs_mknod>.");
2836 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2837 [InitBasicFS, Always, TestOutputStruct (
2838 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2839 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2840 "make block device node",
2842 This call creates a block device node called C<path> with
2843 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2844 It is just a convenient wrapper around C<guestfs_mknod>.");
2846 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2847 [InitBasicFS, Always, TestOutputStruct (
2848 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2849 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2850 "make char device node",
2852 This call creates a char device node called C<path> with
2853 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2854 It is just a convenient wrapper around C<guestfs_mknod>.");
2856 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2857 [], (* XXX umask is one of those stateful things that we should
2858 * reset between each test.
2860 "set file mode creation mask (umask)",
2862 This function sets the mask used for creating new files and
2863 device nodes to C<mask & 0777>.
2865 Typical umask values would be C<022> which creates new files
2866 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2867 C<002> which creates new files with permissions like
2868 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2870 The default umask is C<022>. This is important because it
2871 means that directories and device nodes will be created with
2872 C<0644> or C<0755> mode even if you specify C<0777>.
2874 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2876 This call returns the previous umask.");
2878 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2880 "read directories entries",
2882 This returns the list of directory entries in directory C<dir>.
2884 All entries in the directory are returned, including C<.> and
2885 C<..>. The entries are I<not> sorted, but returned in the same
2886 order as the underlying filesystem.
2888 Also this call returns basic file type information about each
2889 file. The C<ftyp> field will contain one of the following characters:
2927 The L<readdir(3)> returned a C<d_type> field with an
2932 This function is primarily intended for use by programs. To
2933 get a simple list of names, use C<guestfs_ls>. To get a printable
2934 directory for human consumption, use C<guestfs_ll>.");
2936 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2938 "create partitions on a block device",
2940 This is a simplified interface to the C<guestfs_sfdisk>
2941 command, where partition sizes are specified in megabytes
2942 only (rounded to the nearest cylinder) and you don't need
2943 to specify the cyls, heads and sectors parameters which
2944 were rarely if ever used anyway.
2946 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2948 ("zfile", (RString "description", [String "method"; String "path"]), 140, [DeprecatedBy "file"],
2950 "determine file type inside a compressed file",
2952 This command runs C<file> after first decompressing C<path>
2955 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
2957 Since 1.0.63, use C<guestfs_file> instead which can now
2958 process compressed files.");
2960 ("getxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 141, [],
2962 "list extended attributes of a file or directory",
2964 This call lists the extended attributes of the file or directory
2967 At the system call level, this is a combination of the
2968 L<listxattr(2)> and L<getxattr(2)> calls.
2970 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
2972 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 142, [],
2974 "list extended attributes of a file or directory",
2976 This is the same as C<guestfs_getxattrs>, but if C<path>
2977 is a symbolic link, then it returns the extended attributes
2978 of the link itself.");
2980 ("setxattr", (RErr, [String "xattr";
2981 String "val"; Int "vallen"; (* will be BufferIn *)
2982 String "path"]), 143, [],
2984 "set extended attribute of a file or directory",
2986 This call sets the extended attribute named C<xattr>
2987 of the file C<path> to the value C<val> (of length C<vallen>).
2988 The value is arbitrary 8 bit data.
2990 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
2992 ("lsetxattr", (RErr, [String "xattr";
2993 String "val"; Int "vallen"; (* will be BufferIn *)
2994 String "path"]), 144, [],
2996 "set extended attribute of a file or directory",
2998 This is the same as C<guestfs_setxattr>, but if C<path>
2999 is a symbolic link, then it sets an extended attribute
3000 of the link itself.");
3002 ("removexattr", (RErr, [String "xattr"; String "path"]), 145, [],
3004 "remove extended attribute of a file or directory",
3006 This call removes the extended attribute named C<xattr>
3007 of the file C<path>.
3009 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3011 ("lremovexattr", (RErr, [String "xattr"; String "path"]), 146, [],
3013 "remove extended attribute of a file or directory",
3015 This is the same as C<guestfs_removexattr>, but if C<path>
3016 is a symbolic link, then it removes an extended attribute
3017 of the link itself.");
3019 ("mountpoints", (RHashtable "mps", []), 147, [],
3023 This call is similar to C<guestfs_mounts>. That call returns
3024 a list of devices. This one returns a hash table (map) of
3025 device name to directory where the device is mounted.");
3027 ("mkmountpoint", (RErr, [String "path"]), 148, [],
3029 "create a mountpoint",
3031 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3032 specialized calls that can be used to create extra mountpoints
3033 before mounting the first filesystem.
3035 These calls are I<only> necessary in some very limited circumstances,
3036 mainly the case where you want to mount a mix of unrelated and/or
3037 read-only filesystems together.
3039 For example, live CDs often contain a \"Russian doll\" nest of
3040 filesystems, an ISO outer layer, with a squashfs image inside, with
3041 an ext2/3 image inside that. You can unpack this as follows
3044 add-ro Fedora-11-i686-Live.iso
3047 mkmountpoint /squash
3050 mount-loop /cd/LiveOS/squashfs.img /squash
3051 mount-loop /squash/LiveOS/ext3fs.img /ext3
3053 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3055 ("rmmountpoint", (RErr, [String "path"]), 149, [],
3057 "remove a mountpoint",
3059 This calls removes a mountpoint that was previously created
3060 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3061 for full details.");
3063 ("read_file", (RBufferOut "content", [String "path"]), 150, [ProtocolLimitWarning],
3064 [InitSquashFS, Always, TestOutputBuffer (
3065 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3068 This calls returns the contents of the file C<path> as a
3071 Unlike C<guestfs_cat>, this function can correctly
3072 handle files that contain embedded ASCII NUL characters.
3073 However unlike C<guestfs_download>, this function is limited
3074 in the total size of file that can be handled.");
3076 ("grep", (RStringList "lines", [String "regex"; String "path"]), 151, [ProtocolLimitWarning],
3077 [InitSquashFS, Always, TestOutputList (
3078 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3079 InitSquashFS, Always, TestOutputList (
3080 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3081 "return lines matching a pattern",
3083 This calls the external C<grep> program and returns the
3086 ("egrep", (RStringList "lines", [String "regex"; String "path"]), 152, [ProtocolLimitWarning],
3087 [InitSquashFS, Always, TestOutputList (
3088 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3089 "return lines matching a pattern",
3091 This calls the external C<egrep> program and returns the
3094 ("fgrep", (RStringList "lines", [String "pattern"; String "path"]), 153, [ProtocolLimitWarning],
3095 [InitSquashFS, Always, TestOutputList (
3096 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3097 "return lines matching a pattern",
3099 This calls the external C<fgrep> program and returns the
3102 ("grepi", (RStringList "lines", [String "regex"; String "path"]), 154, [ProtocolLimitWarning],
3103 [InitSquashFS, Always, TestOutputList (
3104 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3105 "return lines matching a pattern",
3107 This calls the external C<grep -i> program and returns the
3110 ("egrepi", (RStringList "lines", [String "regex"; String "path"]), 155, [ProtocolLimitWarning],
3111 [InitSquashFS, Always, TestOutputList (
3112 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3113 "return lines matching a pattern",
3115 This calls the external C<egrep -i> program and returns the
3118 ("fgrepi", (RStringList "lines", [String "pattern"; String "path"]), 156, [ProtocolLimitWarning],
3119 [InitSquashFS, Always, TestOutputList (
3120 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3121 "return lines matching a pattern",
3123 This calls the external C<fgrep -i> program and returns the
3126 ("zgrep", (RStringList "lines", [String "regex"; String "path"]), 157, [ProtocolLimitWarning],
3127 [InitSquashFS, Always, TestOutputList (
3128 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3129 "return lines matching a pattern",
3131 This calls the external C<zgrep> program and returns the
3134 ("zegrep", (RStringList "lines", [String "regex"; String "path"]), 158, [ProtocolLimitWarning],
3135 [InitSquashFS, Always, TestOutputList (
3136 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3137 "return lines matching a pattern",
3139 This calls the external C<zegrep> program and returns the
3142 ("zfgrep", (RStringList "lines", [String "pattern"; String "path"]), 159, [ProtocolLimitWarning],
3143 [InitSquashFS, Always, TestOutputList (
3144 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3145 "return lines matching a pattern",
3147 This calls the external C<zfgrep> program and returns the
3150 ("zgrepi", (RStringList "lines", [String "regex"; String "path"]), 160, [ProtocolLimitWarning],
3151 [InitSquashFS, Always, TestOutputList (
3152 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3153 "return lines matching a pattern",
3155 This calls the external C<zgrep -i> program and returns the
3158 ("zegrepi", (RStringList "lines", [String "regex"; String "path"]), 161, [ProtocolLimitWarning],
3159 [InitSquashFS, Always, TestOutputList (
3160 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3161 "return lines matching a pattern",
3163 This calls the external C<zegrep -i> program and returns the
3166 ("zfgrepi", (RStringList "lines", [String "pattern"; String "path"]), 162, [ProtocolLimitWarning],
3167 [InitSquashFS, Always, TestOutputList (
3168 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3169 "return lines matching a pattern",
3171 This calls the external C<zfgrep -i> program and returns the
3174 ("realpath", (RString "rpath", [String "path"]), 163, [],
3175 [InitSquashFS, Always, TestOutput (
3176 [["realpath"; "/../directory"]], "/directory")],
3177 "canonicalized absolute pathname",
3179 Return the canonicalized absolute pathname of C<path>. The
3180 returned path has no C<.>, C<..> or symbolic link path elements.");
3182 ("ln", (RErr, [String "target"; String "linkname"]), 164, [],
3183 [InitBasicFS, Always, TestOutputStruct (
3186 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3187 "create a hard link",
3189 This command creates a hard link using the C<ln> command.");
3191 ("ln_f", (RErr, [String "target"; String "linkname"]), 165, [],
3192 [InitBasicFS, Always, TestOutputStruct (
3195 ["ln_f"; "/a"; "/b"];
3196 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3197 "create a hard link",
3199 This command creates a hard link using the C<ln -f> command.
3200 The C<-f> option removes the link (C<linkname>) if it exists already.");
3202 ("ln_s", (RErr, [String "target"; String "linkname"]), 166, [],
3203 [InitBasicFS, Always, TestOutputStruct (
3205 ["ln_s"; "a"; "/b"];
3206 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3207 "create a symbolic link",
3209 This command creates a symbolic link using the C<ln -s> command.");
3211 ("ln_sf", (RErr, [String "target"; String "linkname"]), 167, [],
3212 [InitBasicFS, Always, TestOutput (
3213 [["mkdir_p"; "/a/b"];
3214 ["touch"; "/a/b/c"];
3215 ["ln_sf"; "../d"; "/a/b/c"];
3216 ["readlink"; "/a/b/c"]], "../d")],
3217 "create a symbolic link",
3219 This command creates a symbolic link using the C<ln -sf> command,
3220 The C<-f> option removes the link (C<linkname>) if it exists already.");
3222 ("readlink", (RString "link", [String "path"]), 168, [],
3223 [] (* XXX tested above *),
3224 "read the target of a symbolic link",
3226 This command reads the target of a symbolic link.");
3228 ("fallocate", (RErr, [String "path"; Int "len"]), 169, [],
3229 [InitBasicFS, Always, TestOutputStruct (
3230 [["fallocate"; "/a"; "1000000"];
3231 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3232 "preallocate a file in the guest filesystem",
3234 This command preallocates a file (containing zero bytes) named
3235 C<path> of size C<len> bytes. If the file exists already, it
3238 Do not confuse this with the guestfish-specific
3239 C<alloc> command which allocates a file in the host and
3240 attaches it as a device.");
3242 ("swapon_device", (RErr, [String "device"]), 170, [],
3243 [InitPartition, Always, TestRun (
3244 [["mkswap"; "/dev/sda1"];
3245 ["swapon_device"; "/dev/sda1"];
3246 ["swapoff_device"; "/dev/sda1"]])],
3247 "enable swap on device",
3249 This command enables the libguestfs appliance to use the
3250 swap device or partition named C<device>. The increased
3251 memory is made available for all commands, for example
3252 those run using C<guestfs_command> or C<guestfs_sh>.
3254 Note that you should not swap to existing guest swap
3255 partitions unless you know what you are doing. They may
3256 contain hibernation information, or other information that
3257 the guest doesn't want you to trash. You also risk leaking
3258 information about the host to the guest this way. Instead,
3259 attach a new host device to the guest and swap on that.");
3261 ("swapoff_device", (RErr, [String "device"]), 171, [],
3262 [], (* XXX tested by swapon_device *)
3263 "disable swap on device",
3265 This command disables the libguestfs appliance swap
3266 device or partition named C<device>.
3267 See C<guestfs_swapon_device>.");
3269 ("swapon_file", (RErr, [String "file"]), 172, [],
3270 [InitBasicFS, Always, TestRun (
3271 [["fallocate"; "/swap"; "8388608"];
3272 ["mkswap_file"; "/swap"];
3273 ["swapon_file"; "/swap"];
3274 ["swapoff_file"; "/swap"]])],
3275 "enable swap on file",
3277 This command enables swap to a file.
3278 See C<guestfs_swapon_device> for other notes.");
3280 ("swapoff_file", (RErr, [String "file"]), 173, [],
3281 [], (* XXX tested by swapon_file *)
3282 "disable swap on file",
3284 This command disables the libguestfs appliance swap on file.");
3286 ("swapon_label", (RErr, [String "label"]), 174, [],
3287 [InitEmpty, Always, TestRun (
3288 [["sfdiskM"; "/dev/sdb"; ","];
3289 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3290 ["swapon_label"; "swapit"];
3291 ["swapoff_label"; "swapit"];
3292 ["zero"; "/dev/sdb"];
3293 ["blockdev_rereadpt"; "/dev/sdb"]])],
3294 "enable swap on labeled swap partition",
3296 This command enables swap to a labeled swap partition.
3297 See C<guestfs_swapon_device> for other notes.");
3299 ("swapoff_label", (RErr, [String "label"]), 175, [],
3300 [], (* XXX tested by swapon_label *)
3301 "disable swap on labeled swap partition",
3303 This command disables the libguestfs appliance swap on
3304 labeled swap partition.");
3306 ("swapon_uuid", (RErr, [String "uuid"]), 176, [],
3307 [InitEmpty, Always, TestRun (
3308 [["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sdb"];
3309 ["swapon_uuid"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
3310 ["swapoff_uuid"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"]])],
3311 "enable swap on swap partition by UUID",
3313 This command enables swap to a swap partition with the given UUID.
3314 See C<guestfs_swapon_device> for other notes.");
3316 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [],
3317 [], (* XXX tested by swapon_uuid *)
3318 "disable swap on swap partition by UUID",
3320 This command disables the libguestfs appliance swap partition
3321 with the given UUID.");
3323 ("mkswap_file", (RErr, [String "path"]), 178, [],
3324 [InitBasicFS, Always, TestRun (
3325 [["fallocate"; "/swap"; "8388608"];
3326 ["mkswap_file"; "/swap"]])],
3327 "create a swap file",
3331 This command just writes a swap file signature to an existing
3332 file. To create the file itself, use something like C<guestfs_fallocate>.");
3334 ("inotify_init", (RErr, [Int "maxevents"]), 179, [],
3335 [InitSquashFS, Always, TestRun (
3336 [["inotify_init"; "0"]])],
3337 "create an inotify handle",
3339 This command creates a new inotify handle.
3340 The inotify subsystem can be used to notify events which happen to
3341 objects in the guest filesystem.
3343 C<maxevents> is the maximum number of events which will be
3344 queued up between calls to C<guestfs_inotify_read> or
3345 C<guestfs_inotify_files>.
3346 If this is passed as C<0>, then the kernel (or previously set)
3347 default is used. For Linux 2.6.29 the default was 16384 events.
3348 Beyond this limit, the kernel throws away events, but records
3349 the fact that it threw them away by setting a flag
3350 C<IN_Q_OVERFLOW> in the returned structure list (see
3351 C<guestfs_inotify_read>).
3353 Before any events are generated, you have to add some
3354 watches to the internal watch list. See:
3355 C<guestfs_inotify_add_watch>,
3356 C<guestfs_inotify_rm_watch> and
3357 C<guestfs_inotify_watch_all>.
3359 Queued up events should be read periodically by calling
3360 C<guestfs_inotify_read>
3361 (or C<guestfs_inotify_files> which is just a helpful
3362 wrapper around C<guestfs_inotify_read>). If you don't
3363 read the events out often enough then you risk the internal
3366 The handle should be closed after use by calling
3367 C<guestfs_inotify_close>. This also removes any
3368 watches automatically.
3370 See also L<inotify(7)> for an overview of the inotify interface
3371 as exposed by the Linux kernel, which is roughly what we expose
3372 via libguestfs. Note that there is one global inotify handle
3373 per libguestfs instance.");
3375 ("inotify_add_watch", (RInt64 "wd", [String "path"; Int "mask"]), 180, [],
3376 [InitBasicFS, Always, TestOutputList (
3377 [["inotify_init"; "0"];
3378 ["inotify_add_watch"; "/"; "1073741823"];
3381 ["inotify_files"]], ["a"; "b"])],
3382 "add an inotify watch",
3384 Watch C<path> for the events listed in C<mask>.
3386 Note that if C<path> is a directory then events within that
3387 directory are watched, but this does I<not> happen recursively
3388 (in subdirectories).
3390 Note for non-C or non-Linux callers: the inotify events are
3391 defined by the Linux kernel ABI and are listed in
3392 C</usr/include/sys/inotify.h>.");
3394 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [],
3396 "remove an inotify watch",
3398 Remove a previously defined inotify watch.
3399 See C<guestfs_inotify_add_watch>.");
3401 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [],
3403 "return list of inotify events",
3405 Return the complete queue of events that have happened
3406 since the previous read call.
3408 If no events have happened, this returns an empty list.
3410 I<Note>: In order to make sure that all events have been
3411 read, you must call this function repeatedly until it
3412 returns an empty list. The reason is that the call will
3413 read events up to the maximum appliance-to-host message
3414 size and leave remaining events in the queue.");
3416 ("inotify_files", (RStringList "paths", []), 183, [],
3418 "return list of watched files that had events",
3420 This function is a helpful wrapper around C<guestfs_inotify_read>
3421 which just returns a list of pathnames of objects that were
3422 touched. The returned pathnames are sorted and deduplicated.");
3424 ("inotify_close", (RErr, []), 184, [],
3426 "close the inotify handle",
3428 This closes the inotify handle which was previously
3429 opened by inotify_init. It removes all watches, throws
3430 away any pending events, and deallocates all resources.");
3432 ("setcon", (RErr, [String "context"]), 185, [],
3434 "set SELinux security context",
3436 This sets the SELinux security context of the daemon
3437 to the string C<context>.
3439 See the documentation about SELINUX in L<guestfs(3)>.");
3441 ("getcon", (RString "context", []), 186, [],
3443 "get SELinux security context",
3445 This gets the SELinux security context of the daemon.
3447 See the documentation about SELINUX in L<guestfs(3)>,
3448 and C<guestfs_setcon>");
3452 let all_functions = non_daemon_functions @ daemon_functions
3454 (* In some places we want the functions to be displayed sorted
3455 * alphabetically, so this is useful:
3457 let all_functions_sorted =
3458 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3459 compare n1 n2) all_functions
3461 (* Field types for structures. *)
3463 | FChar (* C 'char' (really, a 7 bit byte). *)
3464 | FString (* nul-terminated ASCII string, NOT NULL. *)
3465 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3470 | FBytes (* Any int measure that counts bytes. *)
3471 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3472 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3474 (* Because we generate extra parsing code for LVM command line tools,
3475 * we have to pull out the LVM columns separately here.
3485 "pv_attr", FString (* XXX *);
3486 "pv_pe_count", FInt64;
3487 "pv_pe_alloc_count", FInt64;
3490 "pv_mda_count", FInt64;
3491 "pv_mda_free", FBytes;
3492 (* Not in Fedora 10:
3493 "pv_mda_size", FBytes;
3500 "vg_attr", FString (* XXX *);
3503 "vg_sysid", FString;
3504 "vg_extent_size", FBytes;
3505 "vg_extent_count", FInt64;
3506 "vg_free_count", FInt64;
3511 "snap_count", FInt64;
3514 "vg_mda_count", FInt64;
3515 "vg_mda_free", FBytes;
3516 (* Not in Fedora 10:
3517 "vg_mda_size", FBytes;
3523 "lv_attr", FString (* XXX *);
3526 "lv_kernel_major", FInt64;
3527 "lv_kernel_minor", FInt64;
3529 "seg_count", FInt64;
3531 "snap_percent", FOptPercent;
3532 "copy_percent", FOptPercent;
3535 "mirror_log", FString;
3539 (* Names and fields in all structures (in RStruct and RStructList)
3543 (* The old RIntBool return type, only ever used for aug_defnode. Do
3544 * not use this struct in any new code.
3547 "i", FInt32; (* for historical compatibility *)
3548 "b", FInt32; (* for historical compatibility *)
3551 (* LVM PVs, VGs, LVs. *)
3552 "lvm_pv", lvm_pv_cols;
3553 "lvm_vg", lvm_vg_cols;
3554 "lvm_lv", lvm_lv_cols;
3556 (* Column names and types from stat structures.
3557 * NB. Can't use things like 'st_atime' because glibc header files
3558 * define some of these as macros. Ugh.
3589 (* Column names in dirent structure. *)
3592 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3597 (* Version numbers. *)
3605 (* Extended attribute. *)
3607 "attrname", FString;
3611 (* Inotify events. *)
3615 "in_cookie", FUInt32;
3618 ] (* end of structs *)
3620 (* Ugh, Java has to be different ..
3621 * These names are also used by the Haskell bindings.
3623 let java_structs = [
3624 "int_bool", "IntBool";
3629 "statvfs", "StatVFS";
3631 "version", "Version";
3633 "inotify_event", "INotifyEvent";
3636 (* Used for testing language bindings. *)
3638 | CallString of string
3639 | CallOptString of string option
3640 | CallStringList of string list
3644 (* Used to memoize the result of pod2text. *)
3645 let pod2text_memo_filename = "src/.pod2text.data"
3646 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3648 let chan = open_in pod2text_memo_filename in
3649 let v = input_value chan in
3653 _ -> Hashtbl.create 13
3655 (* Useful functions.
3656 * Note we don't want to use any external OCaml libraries which
3657 * makes this a bit harder than it should be.
3659 let failwithf fs = ksprintf failwith fs
3661 let replace_char s c1 c2 =
3662 let s2 = String.copy s in
3663 let r = ref false in
3664 for i = 0 to String.length s2 - 1 do
3665 if String.unsafe_get s2 i = c1 then (
3666 String.unsafe_set s2 i c2;
3670 if not !r then s else s2
3674 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3676 let triml ?(test = isspace) str =
3678 let n = ref (String.length str) in
3679 while !n > 0 && test str.[!i]; do
3684 else String.sub str !i !n
3686 let trimr ?(test = isspace) str =
3687 let n = ref (String.length str) in
3688 while !n > 0 && test str.[!n-1]; do
3691 if !n = String.length str then str
3692 else String.sub str 0 !n
3694 let trim ?(test = isspace) str =
3695 trimr ~test (triml ~test str)
3697 let rec find s sub =
3698 let len = String.length s in
3699 let sublen = String.length sub in
3701 if i <= len-sublen then (
3703 if j < sublen then (
3704 if s.[i+j] = sub.[j] then loop2 (j+1)
3710 if r = -1 then loop (i+1) else r
3716 let rec replace_str s s1 s2 =
3717 let len = String.length s in
3718 let sublen = String.length s1 in
3719 let i = find s s1 in
3722 let s' = String.sub s 0 i in
3723 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3724 s' ^ s2 ^ replace_str s'' s1 s2
3727 let rec string_split sep str =
3728 let len = String.length str in
3729 let seplen = String.length sep in
3730 let i = find str sep in
3731 if i = -1 then [str]
3733 let s' = String.sub str 0 i in
3734 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3735 s' :: string_split sep s''
3738 let files_equal n1 n2 =
3739 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3740 match Sys.command cmd with
3743 | i -> failwithf "%s: failed with error code %d" cmd i
3745 let rec filter_map f = function
3749 | Some y -> y :: filter_map f xs
3750 | None -> filter_map f xs
3752 let rec find_map f = function
3753 | [] -> raise Not_found
3757 | None -> find_map f xs
3760 let rec loop i = function
3762 | x :: xs -> f i x; loop (i+1) xs
3767 let rec loop i = function
3769 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3773 let name_of_argt = function
3774 | String n | OptString n | StringList n | Bool n | Int n
3775 | FileIn n | FileOut n -> n
3777 let java_name_of_struct typ =
3778 try List.assoc typ java_structs
3781 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3783 let cols_of_struct typ =
3784 try List.assoc typ structs
3786 failwithf "cols_of_struct: unknown struct %s" typ
3788 let seq_of_test = function
3789 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3790 | TestOutputListOfDevices (s, _)
3791 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3792 | TestOutputTrue s | TestOutputFalse s
3793 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
3794 | TestOutputStruct (s, _)
3795 | TestLastFail s -> s
3797 (* Handling for function flags. *)
3798 let protocol_limit_warning =
3799 "Because of the message protocol, there is a transfer limit
3800 of somewhere between 2MB and 4MB. To transfer large files you should use
3803 let danger_will_robinson =
3804 "B<This command is dangerous. Without careful use you
3805 can easily destroy all your data>."
3807 let deprecation_notice flags =
3810 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
3812 sprintf "This function is deprecated.
3813 In new code, use the C<%s> call instead.
3815 Deprecated functions will not be removed from the API, but the
3816 fact that they are deprecated indicates that there are problems
3817 with correct use of these functions." alt in
3822 (* Check function names etc. for consistency. *)
3823 let check_functions () =
3824 let contains_uppercase str =
3825 let len = String.length str in
3827 if i >= len then false
3830 if c >= 'A' && c <= 'Z' then true
3837 (* Check function names. *)
3839 fun (name, _, _, _, _, _, _) ->
3840 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3841 failwithf "function name %s does not need 'guestfs' prefix" name;
3843 failwithf "function name is empty";
3844 if name.[0] < 'a' || name.[0] > 'z' then
3845 failwithf "function name %s must start with lowercase a-z" name;
3846 if String.contains name '-' then
3847 failwithf "function name %s should not contain '-', use '_' instead."
3851 (* Check function parameter/return names. *)
3853 fun (name, style, _, _, _, _, _) ->
3854 let check_arg_ret_name n =
3855 if contains_uppercase n then
3856 failwithf "%s param/ret %s should not contain uppercase chars"
3858 if String.contains n '-' || String.contains n '_' then
3859 failwithf "%s param/ret %s should not contain '-' or '_'"
3862 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;
3863 if n = "int" || n = "char" || n = "short" || n = "long" then
3864 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3865 if n = "i" || n = "n" then
3866 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3867 if n = "argv" || n = "args" then
3868 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3871 (match fst style with
3873 | RInt n | RInt64 n | RBool n
3874 | RConstString n | RConstOptString n | RString n
3875 | RStringList n | RStruct (n, _) | RStructList (n, _)
3876 | RHashtable n | RBufferOut n ->
3877 check_arg_ret_name n
3879 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3882 (* Check short descriptions. *)
3884 fun (name, _, _, _, _, shortdesc, _) ->
3885 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3886 failwithf "short description of %s should begin with lowercase." name;
3887 let c = shortdesc.[String.length shortdesc-1] in
3888 if c = '\n' || c = '.' then
3889 failwithf "short description of %s should not end with . or \\n." name
3892 (* Check long dscriptions. *)
3894 fun (name, _, _, _, _, _, longdesc) ->
3895 if longdesc.[String.length longdesc-1] = '\n' then
3896 failwithf "long description of %s should not end with \\n." name
3899 (* Check proc_nrs. *)
3901 fun (name, _, proc_nr, _, _, _, _) ->
3902 if proc_nr <= 0 then
3903 failwithf "daemon function %s should have proc_nr > 0" name
3907 fun (name, _, proc_nr, _, _, _, _) ->
3908 if proc_nr <> -1 then
3909 failwithf "non-daemon function %s should have proc_nr -1" name
3910 ) non_daemon_functions;
3913 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3916 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3917 let rec loop = function
3920 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3922 | (name1,nr1) :: (name2,nr2) :: _ ->
3923 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3931 (* Ignore functions that have no tests. We generate a
3932 * warning when the user does 'make check' instead.
3934 | name, _, _, _, [], _, _ -> ()
3935 | name, _, _, _, tests, _, _ ->
3939 match seq_of_test test with
3941 failwithf "%s has a test containing an empty sequence" name
3942 | cmds -> List.map List.hd cmds
3944 let funcs = List.flatten funcs in
3946 let tested = List.mem name funcs in
3949 failwithf "function %s has tests but does not test itself" name
3952 (* 'pr' prints to the current output file. *)
3953 let chan = ref stdout
3954 let pr fs = ksprintf (output_string !chan) fs
3956 (* Generate a header block in a number of standard styles. *)
3957 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3958 type license = GPLv2 | LGPLv2
3960 let generate_header comment license =
3961 let c = match comment with
3962 | CStyle -> pr "/* "; " *"
3963 | HashStyle -> pr "# "; "#"
3964 | OCamlStyle -> pr "(* "; " *"
3965 | HaskellStyle -> pr "{- "; " " in
3966 pr "libguestfs generated file\n";
3967 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3968 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3970 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3974 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3975 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3976 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3977 pr "%s (at your option) any later version.\n" c;
3979 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3980 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3981 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3982 pr "%s GNU General Public License for more details.\n" c;
3984 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3985 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3986 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3989 pr "%s This library is free software; you can redistribute it and/or\n" c;
3990 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3991 pr "%s License as published by the Free Software Foundation; either\n" c;
3992 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3994 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3995 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3996 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3997 pr "%s Lesser General Public License for more details.\n" c;
3999 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
4000 pr "%s License along with this library; if not, write to the Free Software\n" c;
4001 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
4004 | CStyle -> pr " */\n"
4006 | OCamlStyle -> pr " *)\n"
4007 | HaskellStyle -> pr "-}\n"
4011 (* Start of main code generation functions below this line. *)
4013 (* Generate the pod documentation for the C API. *)
4014 let rec generate_actions_pod () =
4016 fun (shortname, style, _, flags, _, _, longdesc) ->
4017 if not (List.mem NotInDocs flags) then (
4018 let name = "guestfs_" ^ shortname in
4019 pr "=head2 %s\n\n" name;
4021 generate_prototype ~extern:false ~handle:"handle" name style;
4023 pr "%s\n\n" longdesc;
4024 (match fst style with
4026 pr "This function returns 0 on success or -1 on error.\n\n"
4028 pr "On error this function returns -1.\n\n"
4030 pr "On error this function returns -1.\n\n"
4032 pr "This function returns a C truth value on success or -1 on error.\n\n"
4034 pr "This function returns a string, or NULL on error.
4035 The string is owned by the guest handle and must I<not> be freed.\n\n"
4036 | RConstOptString _ ->
4037 pr "This function returns a string which may be NULL.
4038 There is way to return an error from this function.
4039 The string is owned by the guest handle and must I<not> be freed.\n\n"
4041 pr "This function returns a string, or NULL on error.
4042 I<The caller must free the returned string after use>.\n\n"
4044 pr "This function returns a NULL-terminated array of strings
4045 (like L<environ(3)>), or NULL if there was an error.
4046 I<The caller must free the strings and the array after use>.\n\n"
4047 | RStruct (_, typ) ->
4048 pr "This function returns a C<struct guestfs_%s *>,
4049 or NULL if there was an error.
4050 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
4051 | RStructList (_, typ) ->
4052 pr "This function returns a C<struct guestfs_%s_list *>
4053 (see E<lt>guestfs-structs.hE<gt>),
4054 or NULL if there was an error.
4055 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4057 pr "This function returns a NULL-terminated array of
4058 strings, or NULL if there was an error.
4059 The array of strings will always have length C<2n+1>, where
4060 C<n> keys and values alternate, followed by the trailing NULL entry.
4061 I<The caller must free the strings and the array after use>.\n\n"
4063 pr "This function returns a buffer, or NULL on error.
4064 The size of the returned buffer is written to C<*size_r>.
4065 I<The caller must free the returned buffer after use>.\n\n"
4067 if List.mem ProtocolLimitWarning flags then
4068 pr "%s\n\n" protocol_limit_warning;
4069 if List.mem DangerWillRobinson flags then
4070 pr "%s\n\n" danger_will_robinson;
4071 match deprecation_notice flags with
4073 | Some txt -> pr "%s\n\n" txt
4075 ) all_functions_sorted
4077 and generate_structs_pod () =
4078 (* Structs documentation. *)
4081 pr "=head2 guestfs_%s\n" typ;
4083 pr " struct guestfs_%s {\n" typ;
4086 | name, FChar -> pr " char %s;\n" name
4087 | name, FUInt32 -> pr " uint32_t %s;\n" name
4088 | name, FInt32 -> pr " int32_t %s;\n" name
4089 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4090 | name, FInt64 -> pr " int64_t %s;\n" name
4091 | name, FString -> pr " char *%s;\n" name
4093 pr " /* The next two fields describe a byte array. */\n";
4094 pr " uint32_t %s_len;\n" name;
4095 pr " char *%s;\n" name
4097 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4098 pr " char %s[32];\n" name
4099 | name, FOptPercent ->
4100 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4101 pr " float %s;\n" name
4105 pr " struct guestfs_%s_list {\n" typ;
4106 pr " uint32_t len; /* Number of elements in list. */\n";
4107 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
4110 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
4111 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
4116 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
4117 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
4119 * We have to use an underscore instead of a dash because otherwise
4120 * rpcgen generates incorrect code.
4122 * This header is NOT exported to clients, but see also generate_structs_h.
4124 and generate_xdr () =
4125 generate_header CStyle LGPLv2;
4127 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
4128 pr "typedef string str<>;\n";
4131 (* Internal structures. *)
4135 pr "struct guestfs_int_%s {\n" typ;
4137 | name, FChar -> pr " char %s;\n" name
4138 | name, FString -> pr " string %s<>;\n" name
4139 | name, FBuffer -> pr " opaque %s<>;\n" name
4140 | name, FUUID -> pr " opaque %s[32];\n" name
4141 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
4142 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
4143 | name, FOptPercent -> pr " float %s;\n" name
4147 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
4152 fun (shortname, style, _, _, _, _, _) ->
4153 let name = "guestfs_" ^ shortname in
4155 (match snd style with
4158 pr "struct %s_args {\n" name;
4161 | String n -> pr " string %s<>;\n" n
4162 | OptString n -> pr " str *%s;\n" n
4163 | StringList n -> pr " str %s<>;\n" n
4164 | Bool n -> pr " bool %s;\n" n
4165 | Int n -> pr " int %s;\n" n
4166 | FileIn _ | FileOut _ -> ()
4170 (match fst style with
4173 pr "struct %s_ret {\n" name;
4177 pr "struct %s_ret {\n" name;
4178 pr " hyper %s;\n" n;
4181 pr "struct %s_ret {\n" name;
4184 | RConstString _ | RConstOptString _ ->
4185 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4187 pr "struct %s_ret {\n" name;
4188 pr " string %s<>;\n" n;
4191 pr "struct %s_ret {\n" name;
4192 pr " str %s<>;\n" n;
4194 | RStruct (n, typ) ->
4195 pr "struct %s_ret {\n" name;
4196 pr " guestfs_int_%s %s;\n" typ n;
4198 | RStructList (n, typ) ->
4199 pr "struct %s_ret {\n" name;
4200 pr " guestfs_int_%s_list %s;\n" typ n;
4203 pr "struct %s_ret {\n" name;
4204 pr " str %s<>;\n" n;
4207 pr "struct %s_ret {\n" name;
4208 pr " opaque %s<>;\n" n;
4213 (* Table of procedure numbers. *)
4214 pr "enum guestfs_procedure {\n";
4216 fun (shortname, _, proc_nr, _, _, _, _) ->
4217 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
4219 pr " GUESTFS_PROC_NR_PROCS\n";
4223 (* Having to choose a maximum message size is annoying for several
4224 * reasons (it limits what we can do in the API), but it (a) makes
4225 * the protocol a lot simpler, and (b) provides a bound on the size
4226 * of the daemon which operates in limited memory space. For large
4227 * file transfers you should use FTP.
4229 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
4232 (* Message header, etc. *)
4234 /* The communication protocol is now documented in the guestfs(3)
4238 const GUESTFS_PROGRAM = 0x2000F5F5;
4239 const GUESTFS_PROTOCOL_VERSION = 1;
4241 /* These constants must be larger than any possible message length. */
4242 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
4243 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
4245 enum guestfs_message_direction {
4246 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
4247 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
4250 enum guestfs_message_status {
4251 GUESTFS_STATUS_OK = 0,
4252 GUESTFS_STATUS_ERROR = 1
4255 const GUESTFS_ERROR_LEN = 256;
4257 struct guestfs_message_error {
4258 string error_message<GUESTFS_ERROR_LEN>;
4261 struct guestfs_message_header {
4262 unsigned prog; /* GUESTFS_PROGRAM */
4263 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
4264 guestfs_procedure proc; /* GUESTFS_PROC_x */
4265 guestfs_message_direction direction;
4266 unsigned serial; /* message serial number */
4267 guestfs_message_status status;
4270 const GUESTFS_MAX_CHUNK_SIZE = 8192;
4272 struct guestfs_chunk {
4273 int cancel; /* if non-zero, transfer is cancelled */
4274 /* data size is 0 bytes if the transfer has finished successfully */
4275 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
4279 (* Generate the guestfs-structs.h file. *)
4280 and generate_structs_h () =
4281 generate_header CStyle LGPLv2;
4283 (* This is a public exported header file containing various
4284 * structures. The structures are carefully written to have
4285 * exactly the same in-memory format as the XDR structures that
4286 * we use on the wire to the daemon. The reason for creating
4287 * copies of these structures here is just so we don't have to
4288 * export the whole of guestfs_protocol.h (which includes much
4289 * unrelated and XDR-dependent stuff that we don't want to be
4290 * public, or required by clients).
4292 * To reiterate, we will pass these structures to and from the
4293 * client with a simple assignment or memcpy, so the format
4294 * must be identical to what rpcgen / the RFC defines.
4297 (* Public structures. *)
4300 pr "struct guestfs_%s {\n" typ;
4303 | name, FChar -> pr " char %s;\n" name
4304 | name, FString -> pr " char *%s;\n" name
4306 pr " uint32_t %s_len;\n" name;
4307 pr " char *%s;\n" name
4308 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
4309 | name, FUInt32 -> pr " uint32_t %s;\n" name
4310 | name, FInt32 -> pr " int32_t %s;\n" name
4311 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4312 | name, FInt64 -> pr " int64_t %s;\n" name
4313 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
4317 pr "struct guestfs_%s_list {\n" typ;
4318 pr " uint32_t len;\n";
4319 pr " struct guestfs_%s *val;\n" typ;
4322 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
4323 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
4327 (* Generate the guestfs-actions.h file. *)
4328 and generate_actions_h () =
4329 generate_header CStyle LGPLv2;
4331 fun (shortname, style, _, _, _, _, _) ->
4332 let name = "guestfs_" ^ shortname in
4333 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
4337 (* Generate the client-side dispatch stubs. *)
4338 and generate_client_actions () =
4339 generate_header CStyle LGPLv2;
4345 #include \"guestfs.h\"
4346 #include \"guestfs_protocol.h\"
4348 #define error guestfs_error
4349 #define perrorf guestfs_perrorf
4350 #define safe_malloc guestfs_safe_malloc
4351 #define safe_realloc guestfs_safe_realloc
4352 #define safe_strdup guestfs_safe_strdup
4353 #define safe_memdup guestfs_safe_memdup
4355 /* Check the return message from a call for validity. */
4357 check_reply_header (guestfs_h *g,
4358 const struct guestfs_message_header *hdr,
4359 int proc_nr, int serial)
4361 if (hdr->prog != GUESTFS_PROGRAM) {
4362 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
4365 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
4366 error (g, \"wrong protocol version (%%d/%%d)\",
4367 hdr->vers, GUESTFS_PROTOCOL_VERSION);
4370 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
4371 error (g, \"unexpected message direction (%%d/%%d)\",
4372 hdr->direction, GUESTFS_DIRECTION_REPLY);
4375 if (hdr->proc != proc_nr) {
4376 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
4379 if (hdr->serial != serial) {
4380 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
4387 /* Check we are in the right state to run a high-level action. */
4389 check_state (guestfs_h *g, const char *caller)
4391 if (!guestfs_is_ready (g)) {
4392 if (guestfs_is_config (g))
4393 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
4395 else if (guestfs_is_launching (g))
4396 error (g, \"%%s: call wait_ready() before using this function\",
4399 error (g, \"%%s called from the wrong state, %%d != READY\",
4400 caller, guestfs_get_state (g));
4408 (* Client-side stubs for each function. *)
4410 fun (shortname, style, _, _, _, _, _) ->
4411 let name = "guestfs_" ^ shortname in
4413 (* Generate the context struct which stores the high-level
4414 * state between callback functions.
4416 pr "struct %s_ctx {\n" shortname;
4417 pr " /* This flag is set by the callbacks, so we know we've done\n";
4418 pr " * the callbacks as expected, and in the right sequence.\n";
4419 pr " * 0 = not called, 1 = reply_cb called.\n";
4421 pr " int cb_sequence;\n";
4422 pr " struct guestfs_message_header hdr;\n";
4423 pr " struct guestfs_message_error err;\n";
4424 (match fst style with
4426 | RConstString _ | RConstOptString _ ->
4427 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4429 | RBool _ | RString _ | RStringList _
4430 | RStruct _ | RStructList _
4431 | RHashtable _ | RBufferOut _ ->
4432 pr " struct %s_ret ret;\n" name
4437 (* Generate the reply callback function. *)
4438 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4440 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4441 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4443 pr " /* This should definitely not happen. */\n";
4444 pr " if (ctx->cb_sequence != 0) {\n";
4445 pr " ctx->cb_sequence = 9999;\n";
4446 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4450 pr " ml->main_loop_quit (ml, g);\n";
4452 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4453 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4456 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4457 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4458 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4465 (match fst style with
4467 | RConstString _ | RConstOptString _ ->
4468 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4470 | RBool _ | RString _ | RStringList _
4471 | RStruct _ | RStructList _
4472 | RHashtable _ | RBufferOut _ ->
4473 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4474 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4480 pr " ctx->cb_sequence = 1;\n";
4483 (* Generate the action stub. *)
4484 generate_prototype ~extern:false ~semicolon:false ~newline:true
4485 ~handle:"g" name style;
4488 match fst style with
4489 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4490 | RConstString _ | RConstOptString _ ->
4491 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4492 | RString _ | RStringList _
4493 | RStruct _ | RStructList _
4494 | RHashtable _ | RBufferOut _ ->
4499 (match snd style with
4501 | _ -> pr " struct %s_args args;\n" name
4504 pr " struct %s_ctx ctx;\n" shortname;
4505 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4506 pr " int serial;\n";
4508 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4509 pr " guestfs_set_busy (g);\n";
4511 pr " memset (&ctx, 0, sizeof ctx);\n";
4514 (* Send the main header and arguments. *)
4515 (match snd style with
4517 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4518 (String.uppercase shortname)
4523 pr " args.%s = (char *) %s;\n" n n
4525 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4527 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4528 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4530 pr " args.%s = %s;\n" n n
4532 pr " args.%s = %s;\n" n n
4533 | FileIn _ | FileOut _ -> ()
4535 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4536 (String.uppercase shortname);
4537 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4540 pr " if (serial == -1) {\n";
4541 pr " guestfs_end_busy (g);\n";
4542 pr " return %s;\n" error_code;
4546 (* Send any additional files (FileIn) requested. *)
4547 let need_read_reply_label = ref false in
4554 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4555 pr " if (r == -1) {\n";
4556 pr " guestfs_end_busy (g);\n";
4557 pr " return %s;\n" error_code;
4559 pr " if (r == -2) /* daemon cancelled */\n";
4560 pr " goto read_reply;\n";
4561 need_read_reply_label := true;
4567 (* Wait for the reply from the remote end. *)
4568 if !need_read_reply_label then pr " read_reply:\n";
4569 pr " guestfs__switch_to_receiving (g);\n";
4570 pr " ctx.cb_sequence = 0;\n";
4571 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4572 pr " (void) ml->main_loop_run (ml, g);\n";
4573 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4574 pr " if (ctx.cb_sequence != 1) {\n";
4575 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4576 pr " guestfs_end_busy (g);\n";
4577 pr " return %s;\n" error_code;
4581 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4582 (String.uppercase shortname);
4583 pr " guestfs_end_busy (g);\n";
4584 pr " return %s;\n" error_code;
4588 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4589 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4590 pr " free (ctx.err.error_message);\n";
4591 pr " guestfs_end_busy (g);\n";
4592 pr " return %s;\n" error_code;
4596 (* Expecting to receive further files (FileOut)? *)
4600 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4601 pr " guestfs_end_busy (g);\n";
4602 pr " return %s;\n" error_code;
4608 pr " guestfs_end_busy (g);\n";
4610 (match fst style with
4611 | RErr -> pr " return 0;\n"
4612 | RInt n | RInt64 n | RBool n ->
4613 pr " return ctx.ret.%s;\n" n
4614 | RConstString _ | RConstOptString _ ->
4615 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4617 pr " return ctx.ret.%s; /* caller will free */\n" n
4618 | RStringList n | RHashtable n ->
4619 pr " /* caller will free this, but we need to add a NULL entry */\n";
4620 pr " ctx.ret.%s.%s_val =\n" n n;
4621 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4622 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4624 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4625 pr " return ctx.ret.%s.%s_val;\n" n n
4627 pr " /* caller will free this */\n";
4628 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4629 | RStructList (n, _) ->
4630 pr " /* caller will free this */\n";
4631 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4633 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4634 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4640 (* Functions to free structures. *)
4641 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4642 pr " * structure format is identical to the XDR format. See note in\n";
4643 pr " * generator.ml.\n";
4650 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4652 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4658 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4660 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4667 (* Generate daemon/actions.h. *)
4668 and generate_daemon_actions_h () =
4669 generate_header CStyle GPLv2;
4671 pr "#include \"../src/guestfs_protocol.h\"\n";
4675 fun (name, style, _, _, _, _, _) ->
4677 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4681 (* Generate the server-side stubs. *)
4682 and generate_daemon_actions () =
4683 generate_header CStyle GPLv2;
4685 pr "#include <config.h>\n";
4687 pr "#include <stdio.h>\n";
4688 pr "#include <stdlib.h>\n";
4689 pr "#include <string.h>\n";
4690 pr "#include <inttypes.h>\n";
4691 pr "#include <ctype.h>\n";
4692 pr "#include <rpc/types.h>\n";
4693 pr "#include <rpc/xdr.h>\n";
4695 pr "#include \"daemon.h\"\n";
4696 pr "#include \"../src/guestfs_protocol.h\"\n";
4697 pr "#include \"actions.h\"\n";
4701 fun (name, style, _, _, _, _, _) ->
4702 (* Generate server-side stubs. *)
4703 pr "static void %s_stub (XDR *xdr_in)\n" name;
4706 match fst style with
4707 | RErr | RInt _ -> pr " int r;\n"; "-1"
4708 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4709 | RBool _ -> pr " int r;\n"; "-1"
4710 | RConstString _ | RConstOptString _ ->
4711 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4712 | RString _ -> pr " char *r;\n"; "NULL"
4713 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4714 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4715 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4717 pr " size_t size;\n";
4721 (match snd style with
4724 pr " struct guestfs_%s_args args;\n" name;
4727 (* Note we allow the string to be writable, in order to
4728 * allow device name translation. This is safe because
4729 * we can modify the string (passed from RPC).
4732 | OptString n -> pr " char *%s;\n" n
4733 | StringList n -> pr " char **%s;\n" n
4734 | Bool n -> pr " int %s;\n" n
4735 | Int n -> pr " int %s;\n" n
4736 | FileIn _ | FileOut _ -> ()
4741 (match snd style with
4744 pr " memset (&args, 0, sizeof args);\n";
4746 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4747 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4752 | String n -> pr " %s = args.%s;\n" n n
4753 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4755 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4756 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4757 pr " if (%s == NULL) {\n" n;
4758 pr " reply_with_perror (\"realloc\");\n";
4761 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4762 pr " args.%s.%s_val = %s;\n" n n n;
4763 | Bool n -> pr " %s = args.%s;\n" n n
4764 | Int n -> pr " %s = args.%s;\n" n n
4765 | FileIn _ | FileOut _ -> ()
4770 (* Don't want to call the impl with any FileIn or FileOut
4771 * parameters, since these go "outside" the RPC protocol.
4774 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4776 pr " r = do_%s " name;
4777 generate_c_call_args (fst style, args');
4780 pr " if (r == %s)\n" error_code;
4781 pr " /* do_%s has already called reply_with_error */\n" name;
4785 (* If there are any FileOut parameters, then the impl must
4786 * send its own reply.
4789 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4791 pr " /* do_%s has already sent a reply */\n" name
4793 match fst style with
4794 | RErr -> pr " reply (NULL, NULL);\n"
4795 | RInt n | RInt64 n | RBool n ->
4796 pr " struct guestfs_%s_ret ret;\n" name;
4797 pr " ret.%s = r;\n" n;
4798 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4800 | RConstString _ | RConstOptString _ ->
4801 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4803 pr " struct guestfs_%s_ret ret;\n" name;
4804 pr " ret.%s = r;\n" n;
4805 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4808 | RStringList n | RHashtable n ->
4809 pr " struct guestfs_%s_ret ret;\n" name;
4810 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4811 pr " ret.%s.%s_val = r;\n" n n;
4812 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4814 pr " free_strings (r);\n"
4816 pr " struct guestfs_%s_ret ret;\n" name;
4817 pr " ret.%s = *r;\n" n;
4818 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4820 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4822 | RStructList (n, _) ->
4823 pr " struct guestfs_%s_ret ret;\n" name;
4824 pr " ret.%s = *r;\n" n;
4825 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4827 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4830 pr " struct guestfs_%s_ret ret;\n" name;
4831 pr " ret.%s.%s_val = r;\n" n n;
4832 pr " ret.%s.%s_len = size;\n" n n;
4833 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4838 (* Free the args. *)
4839 (match snd style with
4844 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4851 (* Dispatch function. *)
4852 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4854 pr " switch (proc_nr) {\n";
4857 fun (name, style, _, _, _, _, _) ->
4858 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4859 pr " %s_stub (xdr_in);\n" name;
4864 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";
4869 (* LVM columns and tokenization functions. *)
4870 (* XXX This generates crap code. We should rethink how we
4876 pr "static const char *lvm_%s_cols = \"%s\";\n"
4877 typ (String.concat "," (List.map fst cols));
4880 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4882 pr " char *tok, *p, *next;\n";
4886 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4889 pr " if (!str) {\n";
4890 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4893 pr " if (!*str || isspace (*str)) {\n";
4894 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4899 fun (name, coltype) ->
4900 pr " if (!tok) {\n";
4901 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4904 pr " p = strchrnul (tok, ',');\n";
4905 pr " if (*p) next = p+1; else next = NULL;\n";
4906 pr " *p = '\\0';\n";
4909 pr " r->%s = strdup (tok);\n" name;
4910 pr " if (r->%s == NULL) {\n" name;
4911 pr " perror (\"strdup\");\n";
4915 pr " for (i = j = 0; i < 32; ++j) {\n";
4916 pr " if (tok[j] == '\\0') {\n";
4917 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4919 pr " } else if (tok[j] != '-')\n";
4920 pr " r->%s[i++] = tok[j];\n" name;
4923 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4924 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4928 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4929 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4933 pr " if (tok[0] == '\\0')\n";
4934 pr " r->%s = -1;\n" name;
4935 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4936 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4939 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4940 assert false (* can never be an LVM column *)
4942 pr " tok = next;\n";
4945 pr " if (tok != NULL) {\n";
4946 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4953 pr "guestfs_int_lvm_%s_list *\n" typ;
4954 pr "parse_command_line_%ss (void)\n" typ;
4956 pr " char *out, *err;\n";
4957 pr " char *p, *pend;\n";
4959 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4960 pr " void *newp;\n";
4962 pr " ret = malloc (sizeof *ret);\n";
4963 pr " if (!ret) {\n";
4964 pr " reply_with_perror (\"malloc\");\n";
4965 pr " return NULL;\n";
4968 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4969 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4971 pr " r = command (&out, &err,\n";
4972 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4973 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4974 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4975 pr " if (r == -1) {\n";
4976 pr " reply_with_error (\"%%s\", err);\n";
4977 pr " free (out);\n";
4978 pr " free (err);\n";
4979 pr " free (ret);\n";
4980 pr " return NULL;\n";
4983 pr " free (err);\n";
4985 pr " /* Tokenize each line of the output. */\n";
4988 pr " while (p) {\n";
4989 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4990 pr " if (pend) {\n";
4991 pr " *pend = '\\0';\n";
4995 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4998 pr " if (!*p) { /* Empty line? Skip it. */\n";
5003 pr " /* Allocate some space to store this next entry. */\n";
5004 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
5005 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
5006 pr " if (newp == NULL) {\n";
5007 pr " reply_with_perror (\"realloc\");\n";
5008 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
5009 pr " free (ret);\n";
5010 pr " free (out);\n";
5011 pr " return NULL;\n";
5013 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
5015 pr " /* Tokenize the next entry. */\n";
5016 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
5017 pr " if (r == -1) {\n";
5018 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
5019 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
5020 pr " free (ret);\n";
5021 pr " free (out);\n";
5022 pr " return NULL;\n";
5029 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
5031 pr " free (out);\n";
5032 pr " return ret;\n";
5035 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
5037 (* Generate a list of function names, for debugging in the daemon.. *)
5038 and generate_daemon_names () =
5039 generate_header CStyle GPLv2;
5041 pr "#include <config.h>\n";
5043 pr "#include \"daemon.h\"\n";
5046 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
5047 pr "const char *function_names[] = {\n";
5049 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
5053 (* Generate the tests. *)
5054 and generate_tests () =
5055 generate_header CStyle GPLv2;
5062 #include <sys/types.h>
5065 #include \"guestfs.h\"
5067 static guestfs_h *g;
5068 static int suppress_error = 0;
5070 static void print_error (guestfs_h *g, void *data, const char *msg)
5072 if (!suppress_error)
5073 fprintf (stderr, \"%%s\\n\", msg);
5076 static void print_strings (char * const * const argv)
5080 for (argc = 0; argv[argc] != NULL; ++argc)
5081 printf (\"\\t%%s\\n\", argv[argc]);
5085 static void print_table (char * const * const argv)
5089 for (i = 0; argv[i] != NULL; i += 2)
5090 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
5096 (* Generate a list of commands which are not tested anywhere. *)
5097 pr "static void no_test_warnings (void)\n";
5100 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
5102 fun (_, _, _, _, tests, _, _) ->
5103 let tests = filter_map (
5105 | (_, (Always|If _|Unless _), test) -> Some test
5106 | (_, Disabled, _) -> None
5108 let seq = List.concat (List.map seq_of_test tests) in
5109 let cmds_tested = List.map List.hd seq in
5110 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
5114 fun (name, _, _, _, _, _, _) ->
5115 if not (Hashtbl.mem hash name) then
5116 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
5122 (* Generate the actual tests. Note that we generate the tests
5123 * in reverse order, deliberately, so that (in general) the
5124 * newest tests run first. This makes it quicker and easier to
5129 fun (name, _, _, _, tests, _, _) ->
5130 mapi (generate_one_test name) tests
5131 ) (List.rev all_functions) in
5132 let test_names = List.concat test_names in
5133 let nr_tests = List.length test_names in
5136 int main (int argc, char *argv[])
5140 const char *filename;
5142 int nr_tests, test_num = 0;
5144 setbuf (stdout, NULL);
5146 no_test_warnings ();
5148 g = guestfs_create ();
5150 printf (\"guestfs_create FAILED\\n\");
5154 guestfs_set_error_handler (g, print_error, NULL);
5156 guestfs_set_path (g, \"../appliance\");
5158 filename = \"test1.img\";
5159 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5164 if (lseek (fd, %d, SEEK_SET) == -1) {
5170 if (write (fd, &c, 1) == -1) {
5176 if (close (fd) == -1) {
5181 if (guestfs_add_drive (g, filename) == -1) {
5182 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5186 filename = \"test2.img\";
5187 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5192 if (lseek (fd, %d, SEEK_SET) == -1) {
5198 if (write (fd, &c, 1) == -1) {
5204 if (close (fd) == -1) {
5209 if (guestfs_add_drive (g, filename) == -1) {
5210 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5214 filename = \"test3.img\";
5215 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5220 if (lseek (fd, %d, SEEK_SET) == -1) {
5226 if (write (fd, &c, 1) == -1) {
5232 if (close (fd) == -1) {
5237 if (guestfs_add_drive (g, filename) == -1) {
5238 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5242 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
5243 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
5247 if (guestfs_launch (g) == -1) {
5248 printf (\"guestfs_launch FAILED\\n\");
5252 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
5255 if (guestfs_wait_ready (g) == -1) {
5256 printf (\"guestfs_wait_ready FAILED\\n\");
5260 /* Cancel previous alarm. */
5265 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
5269 pr " test_num++;\n";
5270 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
5271 pr " if (%s () == -1) {\n" test_name;
5272 pr " printf (\"%s FAILED\\n\");\n" test_name;
5278 pr " guestfs_close (g);\n";
5279 pr " unlink (\"test1.img\");\n";
5280 pr " unlink (\"test2.img\");\n";
5281 pr " unlink (\"test3.img\");\n";
5284 pr " if (failed > 0) {\n";
5285 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
5293 and generate_one_test name i (init, prereq, test) =
5294 let test_name = sprintf "test_%s_%d" name i in
5297 static int %s_skip (void)
5301 str = getenv (\"TEST_ONLY\");
5303 return strstr (str, \"%s\") == NULL;
5304 str = getenv (\"SKIP_%s\");
5305 if (str && strcmp (str, \"1\") == 0) return 1;
5306 str = getenv (\"SKIP_TEST_%s\");
5307 if (str && strcmp (str, \"1\") == 0) return 1;
5311 " test_name name (String.uppercase test_name) (String.uppercase name);
5314 | Disabled | Always -> ()
5315 | If code | Unless code ->
5316 pr "static int %s_prereq (void)\n" test_name;
5324 static int %s (void)
5327 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
5331 " test_name test_name test_name;
5335 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
5337 pr " if (! %s_prereq ()) {\n" test_name;
5338 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5342 generate_one_test_body name i test_name init test;
5344 pr " if (%s_prereq ()) {\n" test_name;
5345 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5349 generate_one_test_body name i test_name init test;
5351 generate_one_test_body name i test_name init test
5359 and generate_one_test_body name i test_name init test =
5361 | InitNone (* XXX at some point, InitNone and InitEmpty became
5362 * folded together as the same thing. Really we should
5363 * make InitNone do nothing at all, but the tests may
5364 * need to be checked to make sure this is OK.
5367 pr " /* InitNone|InitEmpty for %s */\n" test_name;
5368 List.iter (generate_test_command_call test_name)
5369 [["blockdev_setrw"; "/dev/sda"];
5373 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
5374 List.iter (generate_test_command_call test_name)
5375 [["blockdev_setrw"; "/dev/sda"];
5378 ["sfdiskM"; "/dev/sda"; ","]]
5380 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
5381 List.iter (generate_test_command_call test_name)
5382 [["blockdev_setrw"; "/dev/sda"];
5385 ["sfdiskM"; "/dev/sda"; ","];
5386 ["mkfs"; "ext2"; "/dev/sda1"];
5387 ["mount"; "/dev/sda1"; "/"]]
5388 | InitBasicFSonLVM ->
5389 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
5391 List.iter (generate_test_command_call test_name)
5392 [["blockdev_setrw"; "/dev/sda"];
5395 ["sfdiskM"; "/dev/sda"; ","];
5396 ["pvcreate"; "/dev/sda1"];
5397 ["vgcreate"; "VG"; "/dev/sda1"];
5398 ["lvcreate"; "LV"; "VG"; "8"];
5399 ["mkfs"; "ext2"; "/dev/VG/LV"];
5400 ["mount"; "/dev/VG/LV"; "/"]]
5402 pr " /* InitSquashFS for %s */\n" test_name;
5403 List.iter (generate_test_command_call test_name)
5404 [["blockdev_setrw"; "/dev/sda"];
5407 ["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"]]
5410 let get_seq_last = function
5412 failwithf "%s: you cannot use [] (empty list) when expecting a command"
5415 let seq = List.rev seq in
5416 List.rev (List.tl seq), List.hd seq
5421 pr " /* TestRun for %s (%d) */\n" name i;
5422 List.iter (generate_test_command_call test_name) seq
5423 | TestOutput (seq, expected) ->
5424 pr " /* TestOutput for %s (%d) */\n" name i;
5425 pr " const char *expected = \"%s\";\n" (c_quote expected);
5426 let seq, last = get_seq_last seq in
5428 pr " if (strcmp (r, expected) != 0) {\n";
5429 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5433 List.iter (generate_test_command_call test_name) seq;
5434 generate_test_command_call ~test test_name last
5435 | TestOutputList (seq, expected) ->
5436 pr " /* TestOutputList for %s (%d) */\n" name i;
5437 let seq, last = get_seq_last seq in
5441 pr " if (!r[%d]) {\n" i;
5442 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5443 pr " print_strings (r);\n";
5447 pr " const char *expected = \"%s\";\n" (c_quote str);
5448 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5449 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5454 pr " if (r[%d] != NULL) {\n" (List.length expected);
5455 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5457 pr " print_strings (r);\n";
5461 List.iter (generate_test_command_call test_name) seq;
5462 generate_test_command_call ~test test_name last
5463 | TestOutputListOfDevices (seq, expected) ->
5464 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5465 let seq, last = get_seq_last seq in
5469 pr " if (!r[%d]) {\n" i;
5470 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5471 pr " print_strings (r);\n";
5475 pr " const char *expected = \"%s\";\n" (c_quote str);
5476 pr " r[%d][5] = 's';\n" i;
5477 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5478 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5483 pr " if (r[%d] != NULL) {\n" (List.length expected);
5484 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5486 pr " print_strings (r);\n";
5490 List.iter (generate_test_command_call test_name) seq;
5491 generate_test_command_call ~test test_name last
5492 | TestOutputInt (seq, expected) ->
5493 pr " /* TestOutputInt for %s (%d) */\n" name i;
5494 let seq, last = get_seq_last seq in
5496 pr " if (r != %d) {\n" expected;
5497 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5503 List.iter (generate_test_command_call test_name) seq;
5504 generate_test_command_call ~test test_name last
5505 | TestOutputIntOp (seq, op, expected) ->
5506 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5507 let seq, last = get_seq_last seq in
5509 pr " if (! (r %s %d)) {\n" op expected;
5510 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5511 test_name op expected;
5516 List.iter (generate_test_command_call test_name) seq;
5517 generate_test_command_call ~test test_name last
5518 | TestOutputTrue seq ->
5519 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5520 let seq, last = get_seq_last seq in
5523 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5528 List.iter (generate_test_command_call test_name) seq;
5529 generate_test_command_call ~test test_name last
5530 | TestOutputFalse seq ->
5531 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5532 let seq, last = get_seq_last seq in
5535 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5540 List.iter (generate_test_command_call test_name) seq;
5541 generate_test_command_call ~test test_name last
5542 | TestOutputLength (seq, expected) ->
5543 pr " /* TestOutputLength for %s (%d) */\n" name i;
5544 let seq, last = get_seq_last seq in
5547 pr " for (j = 0; j < %d; ++j)\n" expected;
5548 pr " if (r[j] == NULL) {\n";
5549 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5551 pr " print_strings (r);\n";
5554 pr " if (r[j] != NULL) {\n";
5555 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5557 pr " print_strings (r);\n";
5561 List.iter (generate_test_command_call test_name) seq;
5562 generate_test_command_call ~test test_name last
5563 | TestOutputBuffer (seq, expected) ->
5564 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
5565 pr " const char *expected = \"%s\";\n" (c_quote expected);
5566 let seq, last = get_seq_last seq in
5567 let len = String.length expected in
5569 pr " if (size != %d) {\n" len;
5570 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
5573 pr " if (strncmp (r, expected, size) != 0) {\n";
5574 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5578 List.iter (generate_test_command_call test_name) seq;
5579 generate_test_command_call ~test test_name last
5580 | TestOutputStruct (seq, checks) ->
5581 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5582 let seq, last = get_seq_last seq in
5586 | CompareWithInt (field, expected) ->
5587 pr " if (r->%s != %d) {\n" field expected;
5588 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5589 test_name field expected;
5590 pr " (int) r->%s);\n" field;
5593 | CompareWithIntOp (field, op, expected) ->
5594 pr " if (!(r->%s %s %d)) {\n" field op expected;
5595 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5596 test_name field op expected;
5597 pr " (int) r->%s);\n" field;
5600 | CompareWithString (field, expected) ->
5601 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5602 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5603 test_name field expected;
5604 pr " r->%s);\n" field;
5607 | CompareFieldsIntEq (field1, field2) ->
5608 pr " if (r->%s != r->%s) {\n" field1 field2;
5609 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5610 test_name field1 field2;
5611 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5614 | CompareFieldsStrEq (field1, field2) ->
5615 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5616 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5617 test_name field1 field2;
5618 pr " r->%s, r->%s);\n" field1 field2;
5623 List.iter (generate_test_command_call test_name) seq;
5624 generate_test_command_call ~test test_name last
5625 | TestLastFail seq ->
5626 pr " /* TestLastFail for %s (%d) */\n" name i;
5627 let seq, last = get_seq_last seq in
5628 List.iter (generate_test_command_call test_name) seq;
5629 generate_test_command_call test_name ~expect_error:true last
5631 (* Generate the code to run a command, leaving the result in 'r'.
5632 * If you expect to get an error then you should set expect_error:true.
5634 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5636 | [] -> assert false
5638 (* Look up the command to find out what args/ret it has. *)
5641 let _, style, _, _, _, _, _ =
5642 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5645 failwithf "%s: in test, command %s was not found" test_name name in
5647 if List.length (snd style) <> List.length args then
5648 failwithf "%s: in test, wrong number of args given to %s"
5655 | OptString n, "NULL" -> ()
5657 | OptString n, arg ->
5658 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5661 | FileIn _, _ | FileOut _, _ -> ()
5662 | StringList n, arg ->
5663 let strs = string_split " " arg in
5666 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5668 pr " const char *%s[] = {\n" n;
5670 fun i _ -> pr " %s_%d,\n" n i
5674 ) (List.combine (snd style) args);
5677 match fst style with
5678 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5679 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5680 | RConstString _ | RConstOptString _ ->
5681 pr " const char *r;\n"; "NULL"
5682 | RString _ -> pr " char *r;\n"; "NULL"
5683 | RStringList _ | RHashtable _ ->
5687 | RStruct (_, typ) ->
5688 pr " struct guestfs_%s *r;\n" typ; "NULL"
5689 | RStructList (_, typ) ->
5690 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5693 pr " size_t size;\n";
5696 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5697 pr " r = guestfs_%s (g" name;
5699 (* Generate the parameters. *)
5702 | OptString _, "NULL" -> pr ", NULL"
5706 | FileIn _, arg | FileOut _, arg ->
5707 pr ", \"%s\"" (c_quote arg)
5708 | StringList n, _ ->
5712 try int_of_string arg
5713 with Failure "int_of_string" ->
5714 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5717 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5718 ) (List.combine (snd style) args);
5720 (match fst style with
5721 | RBufferOut _ -> pr ", &size"
5727 if not expect_error then
5728 pr " if (r == %s)\n" error_code
5730 pr " if (r != %s)\n" error_code;
5733 (* Insert the test code. *)
5739 (match fst style with
5740 | RErr | RInt _ | RInt64 _ | RBool _
5741 | RConstString _ | RConstOptString _ -> ()
5742 | RString _ | RBufferOut _ -> pr " free (r);\n"
5743 | RStringList _ | RHashtable _ ->
5744 pr " for (i = 0; r[i] != NULL; ++i)\n";
5745 pr " free (r[i]);\n";
5747 | RStruct (_, typ) ->
5748 pr " guestfs_free_%s (r);\n" typ
5749 | RStructList (_, typ) ->
5750 pr " guestfs_free_%s_list (r);\n" typ
5756 let str = replace_str str "\r" "\\r" in
5757 let str = replace_str str "\n" "\\n" in
5758 let str = replace_str str "\t" "\\t" in
5759 let str = replace_str str "\000" "\\0" in
5762 (* Generate a lot of different functions for guestfish. *)
5763 and generate_fish_cmds () =
5764 generate_header CStyle GPLv2;
5768 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5770 let all_functions_sorted =
5772 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5773 ) all_functions_sorted in
5775 pr "#include <stdio.h>\n";
5776 pr "#include <stdlib.h>\n";
5777 pr "#include <string.h>\n";
5778 pr "#include <inttypes.h>\n";
5779 pr "#include <ctype.h>\n";
5781 pr "#include <guestfs.h>\n";
5782 pr "#include \"fish.h\"\n";
5785 (* list_commands function, which implements guestfish -h *)
5786 pr "void list_commands (void)\n";
5788 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
5789 pr " list_builtin_commands ();\n";
5791 fun (name, _, _, flags, _, shortdesc, _) ->
5792 let name = replace_char name '_' '-' in
5793 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
5795 ) all_functions_sorted;
5796 pr " printf (\" %%s\\n\",";
5797 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
5801 (* display_command function, which implements guestfish -h cmd *)
5802 pr "void display_command (const char *cmd)\n";
5805 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5806 let name2 = replace_char name '_' '-' in
5808 try find_map (function FishAlias n -> Some n | _ -> None) flags
5809 with Not_found -> name in
5810 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5812 match snd style with
5816 name2 (String.concat "> <" (List.map name_of_argt args)) in
5819 if List.mem ProtocolLimitWarning flags then
5820 ("\n\n" ^ protocol_limit_warning)
5823 (* For DangerWillRobinson commands, we should probably have
5824 * guestfish prompt before allowing you to use them (especially
5825 * in interactive mode). XXX
5829 if List.mem DangerWillRobinson flags then
5830 ("\n\n" ^ danger_will_robinson)
5835 match deprecation_notice flags with
5837 | Some txt -> "\n\n" ^ txt in
5839 let describe_alias =
5840 if name <> alias then
5841 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5845 pr "strcasecmp (cmd, \"%s\") == 0" name;
5846 if name <> name2 then
5847 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5848 if name <> alias then
5849 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5851 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
5853 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5856 pr " display_builtin_command (cmd);\n";
5860 (* print_* functions *)
5864 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5866 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
5875 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
5877 pr " printf (\"%s: \");\n" name;
5878 pr " for (i = 0; i < 32; ++i)\n";
5879 pr " printf (\"%%s%%c\", indent, %s->%s[i]);\n" typ name;
5880 pr " printf (\"\\n\");\n"
5882 pr " printf (\"%%s%s: \", indent);\n" name;
5883 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5884 pr " if (isprint (%s->%s[i]))\n" typ name;
5885 pr " printf (\"%%s%%c\", indent, %s->%s[i]);\n" typ name;
5887 pr " printf (\"%%s\\\\x%%02x\", indent, %s->%s[i]);\n" typ name;
5888 pr " printf (\"\\n\");\n"
5889 | name, (FUInt64|FBytes) ->
5890 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
5893 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
5896 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
5899 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
5902 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
5904 | name, FOptPercent ->
5905 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
5906 typ name name typ name;
5907 pr " else printf (\"%%s%s: \\n\", indent);\n" name
5911 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5913 pr " print_%s_indent (%s, \"\");\n" typ typ;
5916 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5921 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5922 pr " printf (\"[%%d] = {\\n\", i);\n";
5923 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
5924 pr " printf (\"}\\n\");\n";
5930 (* run_<action> actions *)
5932 fun (name, style, _, flags, _, _, _) ->
5933 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5935 (match fst style with
5938 | RBool _ -> pr " int r;\n"
5939 | RInt64 _ -> pr " int64_t r;\n"
5940 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5941 | RString _ -> pr " char *r;\n"
5942 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5943 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5944 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5947 pr " size_t size;\n";
5954 | FileOut n -> pr " const char *%s;\n" n
5955 | StringList n -> pr " char **%s;\n" n
5956 | Bool n -> pr " int %s;\n" n
5957 | Int n -> pr " int %s;\n" n
5960 (* Check and convert parameters. *)
5961 let argc_expected = List.length (snd style) in
5962 pr " if (argc != %d) {\n" argc_expected;
5963 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
5965 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
5971 | String name -> pr " %s = argv[%d];\n" name i
5973 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5976 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5979 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5981 | StringList name ->
5982 pr " %s = parse_string_list (argv[%d]);\n" name i
5984 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5986 pr " %s = atoi (argv[%d]);\n" name i
5989 (* Call C API function. *)
5991 try find_map (function FishAction n -> Some n | _ -> None) flags
5992 with Not_found -> sprintf "guestfs_%s" name in
5994 generate_c_call_args ~handle:"g" style;
5997 (* Check return value for errors and display command results. *)
5998 (match fst style with
5999 | RErr -> pr " return r;\n"
6001 pr " if (r == -1) return -1;\n";
6002 pr " printf (\"%%d\\n\", r);\n";
6005 pr " if (r == -1) return -1;\n";
6006 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
6009 pr " if (r == -1) return -1;\n";
6010 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
6013 pr " if (r == NULL) return -1;\n";
6014 pr " printf (\"%%s\\n\", r);\n";
6016 | RConstOptString _ ->
6017 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
6020 pr " if (r == NULL) return -1;\n";
6021 pr " printf (\"%%s\\n\", r);\n";
6025 pr " if (r == NULL) return -1;\n";
6026 pr " print_strings (r);\n";
6027 pr " free_strings (r);\n";
6029 | RStruct (_, typ) ->
6030 pr " if (r == NULL) return -1;\n";
6031 pr " print_%s (r);\n" typ;
6032 pr " guestfs_free_%s (r);\n" typ;
6034 | RStructList (_, typ) ->
6035 pr " if (r == NULL) return -1;\n";
6036 pr " print_%s_list (r);\n" typ;
6037 pr " guestfs_free_%s_list (r);\n" typ;
6040 pr " if (r == NULL) return -1;\n";
6041 pr " print_table (r);\n";
6042 pr " free_strings (r);\n";
6045 pr " if (r == NULL) return -1;\n";
6046 pr " fwrite (r, size, 1, stdout);\n";
6054 (* run_action function *)
6055 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
6058 fun (name, _, _, flags, _, _, _) ->
6059 let name2 = replace_char name '_' '-' in
6061 try find_map (function FishAlias n -> Some n | _ -> None) flags
6062 with Not_found -> name in
6064 pr "strcasecmp (cmd, \"%s\") == 0" name;
6065 if name <> name2 then
6066 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
6067 if name <> alias then
6068 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
6070 pr " return run_%s (cmd, argc, argv);\n" name;
6074 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
6081 (* Readline completion for guestfish. *)
6082 and generate_fish_completion () =
6083 generate_header CStyle GPLv2;
6087 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6097 #ifdef HAVE_LIBREADLINE
6098 #include <readline/readline.h>
6103 #ifdef HAVE_LIBREADLINE
6105 static const char *const commands[] = {
6106 BUILTIN_COMMANDS_FOR_COMPLETION,
6109 (* Get the commands, including the aliases. They don't need to be
6110 * sorted - the generator() function just does a dumb linear search.
6114 fun (name, _, _, flags, _, _, _) ->
6115 let name2 = replace_char name '_' '-' in
6117 try find_map (function FishAlias n -> Some n | _ -> None) flags
6118 with Not_found -> name in
6120 if name <> alias then [name2; alias] else [name2]
6122 let commands = List.flatten commands in
6124 List.iter (pr " \"%s\",\n") commands;
6130 generator (const char *text, int state)
6132 static int index, len;
6137 len = strlen (text);
6140 rl_attempted_completion_over = 1;
6142 while ((name = commands[index]) != NULL) {
6144 if (strncasecmp (name, text, len) == 0)
6145 return strdup (name);
6151 #endif /* HAVE_LIBREADLINE */
6153 char **do_completion (const char *text, int start, int end)
6155 char **matches = NULL;
6157 #ifdef HAVE_LIBREADLINE
6158 rl_completion_append_character = ' ';
6161 matches = rl_completion_matches (text, generator);
6162 else if (complete_dest_paths)
6163 matches = rl_completion_matches (text, complete_dest_paths_generator);
6170 (* Generate the POD documentation for guestfish. *)
6171 and generate_fish_actions_pod () =
6172 let all_functions_sorted =
6174 fun (_, _, _, flags, _, _, _) ->
6175 not (List.mem NotInFish flags || List.mem NotInDocs flags)
6176 ) all_functions_sorted in
6178 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
6181 fun (name, style, _, flags, _, _, longdesc) ->
6183 Str.global_substitute rex (
6186 try Str.matched_group 1 s
6188 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
6189 "C<" ^ replace_char sub '_' '-' ^ ">"
6191 let name = replace_char name '_' '-' in
6193 try find_map (function FishAlias n -> Some n | _ -> None) flags
6194 with Not_found -> name in
6196 pr "=head2 %s" name;
6197 if name <> alias then
6204 | String n -> pr " %s" n
6205 | OptString n -> pr " %s" n
6206 | StringList n -> pr " '%s ...'" n
6207 | Bool _ -> pr " true|false"
6208 | Int n -> pr " %s" n
6209 | FileIn n | FileOut n -> pr " (%s|-)" n
6213 pr "%s\n\n" longdesc;
6215 if List.exists (function FileIn _ | FileOut _ -> true
6216 | _ -> false) (snd style) then
6217 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
6219 if List.mem ProtocolLimitWarning flags then
6220 pr "%s\n\n" protocol_limit_warning;
6222 if List.mem DangerWillRobinson flags then
6223 pr "%s\n\n" danger_will_robinson;
6225 match deprecation_notice flags with
6227 | Some txt -> pr "%s\n\n" txt
6228 ) all_functions_sorted
6230 (* Generate a C function prototype. *)
6231 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
6232 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
6234 ?handle name style =
6235 if extern then pr "extern ";
6236 if static then pr "static ";
6237 (match fst style with
6239 | RInt _ -> pr "int "
6240 | RInt64 _ -> pr "int64_t "
6241 | RBool _ -> pr "int "
6242 | RConstString _ | RConstOptString _ -> pr "const char *"
6243 | RString _ | RBufferOut _ -> pr "char *"
6244 | RStringList _ | RHashtable _ -> pr "char **"
6245 | RStruct (_, typ) ->
6246 if not in_daemon then pr "struct guestfs_%s *" typ
6247 else pr "guestfs_int_%s *" typ
6248 | RStructList (_, typ) ->
6249 if not in_daemon then pr "struct guestfs_%s_list *" typ
6250 else pr "guestfs_int_%s_list *" typ
6252 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
6253 pr "%s%s (" prefix name;
6254 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
6257 let comma = ref false in
6260 | Some handle -> pr "guestfs_h *%s" handle; comma := true
6264 if single_line then pr ", " else pr ",\n\t\t"
6273 if not in_daemon then pr "const char *%s" n
6274 else pr "char *%s" n
6277 if not in_daemon then pr "char * const* const %s" n
6278 else pr "char **%s" n
6279 | Bool n -> next (); pr "int %s" n
6280 | Int n -> next (); pr "int %s" n
6283 if not in_daemon then (next (); pr "const char *%s" n)
6285 if is_RBufferOut then (next (); pr "size_t *size_r");
6288 if semicolon then pr ";";
6289 if newline then pr "\n"
6291 (* Generate C call arguments, eg "(handle, foo, bar)" *)
6292 and generate_c_call_args ?handle ?(decl = false) style =
6294 let comma = ref false in
6296 if !comma then pr ", ";
6301 | Some handle -> pr "%s" handle; comma := true
6306 pr "%s" (name_of_argt arg)
6308 (* For RBufferOut calls, add implicit &size parameter. *)
6310 match fst style with
6318 (* Generate the OCaml bindings interface. *)
6319 and generate_ocaml_mli () =
6320 generate_header OCamlStyle LGPLv2;
6323 (** For API documentation you should refer to the C API
6324 in the guestfs(3) manual page. The OCaml API uses almost
6325 exactly the same calls. *)
6328 (** A [guestfs_h] handle. *)
6330 exception Error of string
6331 (** This exception is raised when there is an error. *)
6333 val create : unit -> t
6335 val close : t -> unit
6336 (** Handles are closed by the garbage collector when they become
6337 unreferenced, but callers can also call this in order to
6338 provide predictable cleanup. *)
6341 generate_ocaml_structure_decls ();
6345 fun (name, style, _, _, _, shortdesc, _) ->
6346 generate_ocaml_prototype name style;
6347 pr "(** %s *)\n" shortdesc;
6351 (* Generate the OCaml bindings implementation. *)
6352 and generate_ocaml_ml () =
6353 generate_header OCamlStyle LGPLv2;
6357 exception Error of string
6358 external create : unit -> t = \"ocaml_guestfs_create\"
6359 external close : t -> unit = \"ocaml_guestfs_close\"
6362 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
6366 generate_ocaml_structure_decls ();
6370 fun (name, style, _, _, _, shortdesc, _) ->
6371 generate_ocaml_prototype ~is_external:true name style;
6374 (* Generate the OCaml bindings C implementation. *)
6375 and generate_ocaml_c () =
6376 generate_header CStyle LGPLv2;
6383 #include <caml/config.h>
6384 #include <caml/alloc.h>
6385 #include <caml/callback.h>
6386 #include <caml/fail.h>
6387 #include <caml/memory.h>
6388 #include <caml/mlvalues.h>
6389 #include <caml/signals.h>
6391 #include <guestfs.h>
6393 #include \"guestfs_c.h\"
6395 /* Copy a hashtable of string pairs into an assoc-list. We return
6396 * the list in reverse order, but hashtables aren't supposed to be
6399 static CAMLprim value
6400 copy_table (char * const * argv)
6403 CAMLlocal5 (rv, pairv, kv, vv, cons);
6407 for (i = 0; argv[i] != NULL; i += 2) {
6408 kv = caml_copy_string (argv[i]);
6409 vv = caml_copy_string (argv[i+1]);
6410 pairv = caml_alloc (2, 0);
6411 Store_field (pairv, 0, kv);
6412 Store_field (pairv, 1, vv);
6413 cons = caml_alloc (2, 0);
6414 Store_field (cons, 1, rv);
6416 Store_field (cons, 0, pairv);
6424 (* Struct copy functions. *)
6427 let has_optpercent_col =
6428 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
6430 pr "static CAMLprim value\n";
6431 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
6433 pr " CAMLparam0 ();\n";
6434 if has_optpercent_col then
6435 pr " CAMLlocal3 (rv, v, v2);\n"
6437 pr " CAMLlocal2 (rv, v);\n";
6439 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
6444 pr " v = caml_copy_string (%s->%s);\n" typ name
6446 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
6447 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
6450 pr " v = caml_alloc_string (32);\n";
6451 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
6452 | name, (FBytes|FInt64|FUInt64) ->
6453 pr " v = caml_copy_int64 (%s->%s);\n" typ name
6454 | name, (FInt32|FUInt32) ->
6455 pr " v = caml_copy_int32 (%s->%s);\n" typ name
6456 | name, FOptPercent ->
6457 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
6458 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
6459 pr " v = caml_alloc (1, 0);\n";
6460 pr " Store_field (v, 0, v2);\n";
6461 pr " } else /* None */\n";
6462 pr " v = Val_int (0);\n";
6464 pr " v = Val_int (%s->%s);\n" typ name
6466 pr " Store_field (rv, %d, v);\n" i
6468 pr " CAMLreturn (rv);\n";
6472 pr "static CAMLprim value\n";
6473 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
6476 pr " CAMLparam0 ();\n";
6477 pr " CAMLlocal2 (rv, v);\n";
6480 pr " if (%ss->len == 0)\n" typ;
6481 pr " CAMLreturn (Atom (0));\n";
6483 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
6484 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6485 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
6486 pr " caml_modify (&Field (rv, i), v);\n";
6488 pr " CAMLreturn (rv);\n";
6496 fun (name, style, _, _, _, _, _) ->
6498 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
6500 let needs_extra_vs =
6501 match fst style with RConstOptString _ -> true | _ -> false in
6503 pr "CAMLprim value\n";
6504 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6505 List.iter (pr ", value %s") (List.tl params);
6510 | [p1; p2; p3; p4; p5] ->
6511 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6512 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6513 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6514 pr " CAMLxparam%d (%s);\n"
6515 (List.length rest) (String.concat ", " rest)
6517 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6519 if not needs_extra_vs then
6520 pr " CAMLlocal1 (rv);\n"
6522 pr " CAMLlocal3 (rv, v, v2);\n";
6525 pr " guestfs_h *g = Guestfs_val (gv);\n";
6526 pr " if (g == NULL)\n";
6527 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6535 pr " const char *%s = String_val (%sv);\n" n n
6537 pr " const char *%s =\n" n;
6538 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6541 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6543 pr " int %s = Bool_val (%sv);\n" n n
6545 pr " int %s = Int_val (%sv);\n" n n
6548 match fst style with
6549 | RErr -> pr " int r;\n"; "-1"
6550 | RInt _ -> pr " int r;\n"; "-1"
6551 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6552 | RBool _ -> pr " int r;\n"; "-1"
6553 | RConstString _ | RConstOptString _ ->
6554 pr " const char *r;\n"; "NULL"
6555 | RString _ -> pr " char *r;\n"; "NULL"
6560 | RStruct (_, typ) ->
6561 pr " struct guestfs_%s *r;\n" typ; "NULL"
6562 | RStructList (_, typ) ->
6563 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6570 pr " size_t size;\n";
6574 pr " caml_enter_blocking_section ();\n";
6575 pr " r = guestfs_%s " name;
6576 generate_c_call_args ~handle:"g" style;
6578 pr " caml_leave_blocking_section ();\n";
6583 pr " ocaml_guestfs_free_strings (%s);\n" n;
6584 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6587 pr " if (r == %s)\n" error_code;
6588 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6591 (match fst style with
6592 | RErr -> pr " rv = Val_unit;\n"
6593 | RInt _ -> pr " rv = Val_int (r);\n"
6595 pr " rv = caml_copy_int64 (r);\n"
6596 | RBool _ -> pr " rv = Val_bool (r);\n"
6598 pr " rv = caml_copy_string (r);\n"
6599 | RConstOptString _ ->
6600 pr " if (r) { /* Some string */\n";
6601 pr " v = caml_alloc (1, 0);\n";
6602 pr " v2 = caml_copy_string (r);\n";
6603 pr " Store_field (v, 0, v2);\n";
6604 pr " } else /* None */\n";
6605 pr " v = Val_int (0);\n";
6607 pr " rv = caml_copy_string (r);\n";
6610 pr " rv = caml_copy_string_array ((const char **) r);\n";
6611 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6613 | RStruct (_, typ) ->
6614 pr " rv = copy_%s (r);\n" typ;
6615 pr " guestfs_free_%s (r);\n" typ;
6616 | RStructList (_, typ) ->
6617 pr " rv = copy_%s_list (r);\n" typ;
6618 pr " guestfs_free_%s_list (r);\n" typ;
6620 pr " rv = copy_table (r);\n";
6621 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6624 pr " rv = caml_alloc_string (size);\n";
6625 pr " memcpy (String_val (rv), r, size);\n";
6628 pr " CAMLreturn (rv);\n";
6632 if List.length params > 5 then (
6633 pr "CAMLprim value\n";
6634 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6636 pr " return ocaml_guestfs_%s (argv[0]" name;
6637 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6644 and generate_ocaml_structure_decls () =
6647 pr "type %s = {\n" typ;
6650 | name, FString -> pr " %s : string;\n" name
6651 | name, FBuffer -> pr " %s : string;\n" name
6652 | name, FUUID -> pr " %s : string;\n" name
6653 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6654 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6655 | name, FChar -> pr " %s : char;\n" name
6656 | name, FOptPercent -> pr " %s : float option;\n" name
6662 and generate_ocaml_prototype ?(is_external = false) name style =
6663 if is_external then pr "external " else pr "val ";
6664 pr "%s : t -> " name;
6667 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6668 | OptString _ -> pr "string option -> "
6669 | StringList _ -> pr "string array -> "
6670 | Bool _ -> pr "bool -> "
6671 | Int _ -> pr "int -> "
6673 (match fst style with
6674 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6675 | RInt _ -> pr "int"
6676 | RInt64 _ -> pr "int64"
6677 | RBool _ -> pr "bool"
6678 | RConstString _ -> pr "string"
6679 | RConstOptString _ -> pr "string option"
6680 | RString _ | RBufferOut _ -> pr "string"
6681 | RStringList _ -> pr "string array"
6682 | RStruct (_, typ) -> pr "%s" typ
6683 | RStructList (_, typ) -> pr "%s array" typ
6684 | RHashtable _ -> pr "(string * string) list"
6686 if is_external then (
6688 if List.length (snd style) + 1 > 5 then
6689 pr "\"ocaml_guestfs_%s_byte\" " name;
6690 pr "\"ocaml_guestfs_%s\"" name
6694 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6695 and generate_perl_xs () =
6696 generate_header CStyle LGPLv2;
6699 #include \"EXTERN.h\"
6703 #include <guestfs.h>
6706 #define PRId64 \"lld\"
6710 my_newSVll(long long val) {
6711 #ifdef USE_64_BIT_ALL
6712 return newSViv(val);
6716 len = snprintf(buf, 100, \"%%\" PRId64, val);
6717 return newSVpv(buf, len);
6722 #define PRIu64 \"llu\"
6726 my_newSVull(unsigned long long val) {
6727 #ifdef USE_64_BIT_ALL
6728 return newSVuv(val);
6732 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6733 return newSVpv(buf, len);
6737 /* http://www.perlmonks.org/?node_id=680842 */
6739 XS_unpack_charPtrPtr (SV *arg) {
6744 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6745 croak (\"array reference expected\");
6747 av = (AV *)SvRV (arg);
6748 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6750 croak (\"malloc failed\");
6752 for (i = 0; i <= av_len (av); i++) {
6753 SV **elem = av_fetch (av, i, 0);
6755 if (!elem || !*elem)
6756 croak (\"missing element in list\");
6758 ret[i] = SvPV_nolen (*elem);
6766 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6773 RETVAL = guestfs_create ();
6775 croak (\"could not create guestfs handle\");
6776 guestfs_set_error_handler (RETVAL, NULL, NULL);
6789 fun (name, style, _, _, _, _, _) ->
6790 (match fst style with
6791 | RErr -> pr "void\n"
6792 | RInt _ -> pr "SV *\n"
6793 | RInt64 _ -> pr "SV *\n"
6794 | RBool _ -> pr "SV *\n"
6795 | RConstString _ -> pr "SV *\n"
6796 | RConstOptString _ -> pr "SV *\n"
6797 | RString _ -> pr "SV *\n"
6798 | RBufferOut _ -> pr "SV *\n"
6800 | RStruct _ | RStructList _
6802 pr "void\n" (* all lists returned implictly on the stack *)
6804 (* Call and arguments. *)
6806 generate_c_call_args ~handle:"g" ~decl:true style;
6808 pr " guestfs_h *g;\n";
6812 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6814 (* http://www.perlmonks.org/?node_id=554277
6815 * Note that the implicit handle argument means we have
6816 * to add 1 to the ST(x) operator.
6818 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6819 | StringList n -> pr " char **%s;\n" n
6820 | Bool n -> pr " int %s;\n" n
6821 | Int n -> pr " int %s;\n" n
6824 let do_cleanups () =
6827 | String _ | OptString _ | Bool _ | Int _
6828 | FileIn _ | FileOut _ -> ()
6829 | StringList n -> pr " free (%s);\n" n
6834 (match fst style with
6839 pr " r = guestfs_%s " name;
6840 generate_c_call_args ~handle:"g" style;
6843 pr " if (r == -1)\n";
6844 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6850 pr " %s = guestfs_%s " n name;
6851 generate_c_call_args ~handle:"g" style;
6854 pr " if (%s == -1)\n" n;
6855 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6856 pr " RETVAL = newSViv (%s);\n" n;
6861 pr " int64_t %s;\n" n;
6863 pr " %s = guestfs_%s " n name;
6864 generate_c_call_args ~handle:"g" style;
6867 pr " if (%s == -1)\n" n;
6868 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6869 pr " RETVAL = my_newSVll (%s);\n" n;
6874 pr " const char *%s;\n" n;
6876 pr " %s = guestfs_%s " n name;
6877 generate_c_call_args ~handle:"g" style;
6880 pr " if (%s == NULL)\n" n;
6881 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6882 pr " RETVAL = newSVpv (%s, 0);\n" n;
6885 | RConstOptString n ->
6887 pr " const char *%s;\n" n;
6889 pr " %s = guestfs_%s " n name;
6890 generate_c_call_args ~handle:"g" style;
6893 pr " if (%s == NULL)\n" n;
6894 pr " RETVAL = &PL_sv_undef;\n";
6896 pr " RETVAL = newSVpv (%s, 0);\n" n;
6901 pr " char *%s;\n" n;
6903 pr " %s = guestfs_%s " n name;
6904 generate_c_call_args ~handle:"g" style;
6907 pr " if (%s == NULL)\n" n;
6908 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6909 pr " RETVAL = newSVpv (%s, 0);\n" n;
6910 pr " free (%s);\n" n;
6913 | RStringList n | RHashtable n ->
6915 pr " char **%s;\n" n;
6918 pr " %s = guestfs_%s " n name;
6919 generate_c_call_args ~handle:"g" style;
6922 pr " if (%s == NULL)\n" n;
6923 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6924 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6925 pr " EXTEND (SP, n);\n";
6926 pr " for (i = 0; i < n; ++i) {\n";
6927 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6928 pr " free (%s[i]);\n" n;
6930 pr " free (%s);\n" n;
6931 | RStruct (n, typ) ->
6932 let cols = cols_of_struct typ in
6933 generate_perl_struct_code typ cols name style n do_cleanups
6934 | RStructList (n, typ) ->
6935 let cols = cols_of_struct typ in
6936 generate_perl_struct_list_code typ cols name style n do_cleanups
6939 pr " char *%s;\n" n;
6940 pr " size_t size;\n";
6942 pr " %s = guestfs_%s " n name;
6943 generate_c_call_args ~handle:"g" style;
6946 pr " if (%s == NULL)\n" n;
6947 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6948 pr " RETVAL = newSVpv (%s, size);\n" n;
6949 pr " free (%s);\n" n;
6957 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6959 pr " struct guestfs_%s_list *%s;\n" typ n;
6963 pr " %s = guestfs_%s " n name;
6964 generate_c_call_args ~handle:"g" style;
6967 pr " if (%s == NULL)\n" n;
6968 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6969 pr " EXTEND (SP, %s->len);\n" n;
6970 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6971 pr " hv = newHV ();\n";
6975 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6976 name (String.length name) n name
6978 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6979 name (String.length name) n name
6981 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6982 name (String.length name) n name n name
6983 | name, (FBytes|FUInt64) ->
6984 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6985 name (String.length name) n name
6987 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6988 name (String.length name) n name
6989 | name, (FInt32|FUInt32) ->
6990 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6991 name (String.length name) n name
6993 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6994 name (String.length name) n name
6995 | name, FOptPercent ->
6996 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6997 name (String.length name) n name
6999 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
7001 pr " guestfs_free_%s_list (%s);\n" typ n
7003 and generate_perl_struct_code typ cols name style n do_cleanups =
7005 pr " struct guestfs_%s *%s;\n" typ n;
7007 pr " %s = guestfs_%s " n name;
7008 generate_c_call_args ~handle:"g" style;
7011 pr " if (%s == NULL)\n" n;
7012 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
7013 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
7015 fun ((name, _) as col) ->
7016 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
7020 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
7023 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
7026 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
7028 | name, (FBytes|FUInt64) ->
7029 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
7032 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
7034 | name, (FInt32|FUInt32) ->
7035 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
7038 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
7040 | name, FOptPercent ->
7041 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
7044 pr " free (%s);\n" n
7046 (* Generate Sys/Guestfs.pm. *)
7047 and generate_perl_pm () =
7048 generate_header HashStyle LGPLv2;
7055 Sys::Guestfs - Perl bindings for libguestfs
7061 my $h = Sys::Guestfs->new ();
7062 $h->add_drive ('guest.img');
7065 $h->mount ('/dev/sda1', '/');
7066 $h->touch ('/hello');
7071 The C<Sys::Guestfs> module provides a Perl XS binding to the
7072 libguestfs API for examining and modifying virtual machine
7075 Amongst the things this is good for: making batch configuration
7076 changes to guests, getting disk used/free statistics (see also:
7077 virt-df), migrating between virtualization systems (see also:
7078 virt-p2v), performing partial backups, performing partial guest
7079 clones, cloning guests and changing registry/UUID/hostname info, and
7082 Libguestfs uses Linux kernel and qemu code, and can access any type of
7083 guest filesystem that Linux and qemu can, including but not limited
7084 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7085 schemes, qcow, qcow2, vmdk.
7087 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7088 LVs, what filesystem is in each LV, etc.). It can also run commands
7089 in the context of the guest. Also you can access filesystems over FTP.
7091 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
7092 functions for using libguestfs from Perl, including integration
7097 All errors turn into calls to C<croak> (see L<Carp(3)>).
7105 package Sys::Guestfs;
7111 XSLoader::load ('Sys::Guestfs');
7113 =item $h = Sys::Guestfs->new ();
7115 Create a new guestfs handle.
7121 my $class = ref ($proto) || $proto;
7123 my $self = Sys::Guestfs::_create ();
7124 bless $self, $class;
7130 (* Actions. We only need to print documentation for these as
7131 * they are pulled in from the XS code automatically.
7134 fun (name, style, _, flags, _, _, longdesc) ->
7135 if not (List.mem NotInDocs flags) then (
7136 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
7138 generate_perl_prototype name style;
7140 pr "%s\n\n" longdesc;
7141 if List.mem ProtocolLimitWarning flags then
7142 pr "%s\n\n" protocol_limit_warning;
7143 if List.mem DangerWillRobinson flags then
7144 pr "%s\n\n" danger_will_robinson;
7145 match deprecation_notice flags with
7147 | Some txt -> pr "%s\n\n" txt
7149 ) all_functions_sorted;
7161 Copyright (C) 2009 Red Hat Inc.
7165 Please see the file COPYING.LIB for the full license.
7171 L<http://libguestfs.org>,
7172 L<Sys::Guestfs::Lib(3)>.
7177 and generate_perl_prototype name style =
7178 (match fst style with
7186 | RBufferOut n -> pr "$%s = " n
7188 | RHashtable n -> pr "%%%s = " n
7190 | RStructList (n,_) -> pr "@%s = " n
7193 let comma = ref false in
7196 if !comma then pr ", ";
7199 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
7206 (* Generate Python C module. *)
7207 and generate_python_c () =
7208 generate_header CStyle LGPLv2;
7217 #include \"guestfs.h\"
7225 get_handle (PyObject *obj)
7228 assert (obj != Py_None);
7229 return ((Pyguestfs_Object *) obj)->g;
7233 put_handle (guestfs_h *g)
7237 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
7240 /* This list should be freed (but not the strings) after use. */
7241 static const char **
7242 get_string_list (PyObject *obj)
7249 if (!PyList_Check (obj)) {
7250 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
7254 len = PyList_Size (obj);
7255 r = malloc (sizeof (char *) * (len+1));
7257 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
7261 for (i = 0; i < len; ++i)
7262 r[i] = PyString_AsString (PyList_GetItem (obj, i));
7269 put_string_list (char * const * const argv)
7274 for (argc = 0; argv[argc] != NULL; ++argc)
7277 list = PyList_New (argc);
7278 for (i = 0; i < argc; ++i)
7279 PyList_SetItem (list, i, PyString_FromString (argv[i]));
7285 put_table (char * const * const argv)
7287 PyObject *list, *item;
7290 for (argc = 0; argv[argc] != NULL; ++argc)
7293 list = PyList_New (argc >> 1);
7294 for (i = 0; i < argc; i += 2) {
7295 item = PyTuple_New (2);
7296 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
7297 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
7298 PyList_SetItem (list, i >> 1, item);
7305 free_strings (char **argv)
7309 for (argc = 0; argv[argc] != NULL; ++argc)
7315 py_guestfs_create (PyObject *self, PyObject *args)
7319 g = guestfs_create ();
7321 PyErr_SetString (PyExc_RuntimeError,
7322 \"guestfs.create: failed to allocate handle\");
7325 guestfs_set_error_handler (g, NULL, NULL);
7326 return put_handle (g);
7330 py_guestfs_close (PyObject *self, PyObject *args)
7335 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
7337 g = get_handle (py_g);
7341 Py_INCREF (Py_None);
7347 (* Structures, turned into Python dictionaries. *)
7350 pr "static PyObject *\n";
7351 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
7353 pr " PyObject *dict;\n";
7355 pr " dict = PyDict_New ();\n";
7359 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7360 pr " PyString_FromString (%s->%s));\n"
7363 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7364 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
7367 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7368 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
7370 | name, (FBytes|FUInt64) ->
7371 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7372 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
7375 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7376 pr " PyLong_FromLongLong (%s->%s));\n"
7379 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7380 pr " PyLong_FromUnsignedLong (%s->%s));\n"
7383 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7384 pr " PyLong_FromLong (%s->%s));\n"
7386 | name, FOptPercent ->
7387 pr " if (%s->%s >= 0)\n" typ name;
7388 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7389 pr " PyFloat_FromDouble ((double) %s->%s));\n"
7392 pr " Py_INCREF (Py_None);\n";
7393 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
7396 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7397 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
7399 pr " return dict;\n";
7403 pr "static PyObject *\n";
7404 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
7406 pr " PyObject *list;\n";
7409 pr " list = PyList_New (%ss->len);\n" typ;
7410 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
7411 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
7412 pr " return list;\n";
7417 (* Python wrapper functions. *)
7419 fun (name, style, _, _, _, _, _) ->
7420 pr "static PyObject *\n";
7421 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
7424 pr " PyObject *py_g;\n";
7425 pr " guestfs_h *g;\n";
7426 pr " PyObject *py_r;\n";
7429 match fst style with
7430 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7431 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7432 | RConstString _ | RConstOptString _ ->
7433 pr " const char *r;\n"; "NULL"
7434 | RString _ -> pr " char *r;\n"; "NULL"
7435 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7436 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7437 | RStructList (_, typ) ->
7438 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7441 pr " size_t size;\n";
7446 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
7447 | OptString n -> pr " const char *%s;\n" n
7449 pr " PyObject *py_%s;\n" n;
7450 pr " const char **%s;\n" n
7451 | Bool n -> pr " int %s;\n" n
7452 | Int n -> pr " int %s;\n" n
7457 (* Convert the parameters. *)
7458 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
7461 | String _ | FileIn _ | FileOut _ -> pr "s"
7462 | OptString _ -> pr "z"
7463 | StringList _ -> pr "O"
7464 | Bool _ -> pr "i" (* XXX Python has booleans? *)
7467 pr ":guestfs_%s\",\n" name;
7471 | String n | FileIn n | FileOut n -> pr ", &%s" n
7472 | OptString n -> pr ", &%s" n
7473 | StringList n -> pr ", &py_%s" n
7474 | Bool n -> pr ", &%s" n
7475 | Int n -> pr ", &%s" n
7479 pr " return NULL;\n";
7481 pr " g = get_handle (py_g);\n";
7484 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7486 pr " %s = get_string_list (py_%s);\n" n n;
7487 pr " if (!%s) return NULL;\n" n
7492 pr " r = guestfs_%s " name;
7493 generate_c_call_args ~handle:"g" style;
7498 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7500 pr " free (%s);\n" n
7503 pr " if (r == %s) {\n" error_code;
7504 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7505 pr " return NULL;\n";
7509 (match fst style with
7511 pr " Py_INCREF (Py_None);\n";
7512 pr " py_r = Py_None;\n"
7514 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7515 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7516 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7517 | RConstOptString _ ->
7519 pr " py_r = PyString_FromString (r);\n";
7521 pr " Py_INCREF (Py_None);\n";
7522 pr " py_r = Py_None;\n";
7525 pr " py_r = PyString_FromString (r);\n";
7528 pr " py_r = put_string_list (r);\n";
7529 pr " free_strings (r);\n"
7530 | RStruct (_, typ) ->
7531 pr " py_r = put_%s (r);\n" typ;
7532 pr " guestfs_free_%s (r);\n" typ
7533 | RStructList (_, typ) ->
7534 pr " py_r = put_%s_list (r);\n" typ;
7535 pr " guestfs_free_%s_list (r);\n" typ
7537 pr " py_r = put_table (r);\n";
7538 pr " free_strings (r);\n"
7540 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7544 pr " return py_r;\n";
7549 (* Table of functions. *)
7550 pr "static PyMethodDef methods[] = {\n";
7551 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7552 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7554 fun (name, _, _, _, _, _, _) ->
7555 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7558 pr " { NULL, NULL, 0, NULL }\n";
7562 (* Init function. *)
7565 initlibguestfsmod (void)
7567 static int initialized = 0;
7569 if (initialized) return;
7570 Py_InitModule ((char *) \"libguestfsmod\", methods);
7575 (* Generate Python module. *)
7576 and generate_python_py () =
7577 generate_header HashStyle LGPLv2;
7580 u\"\"\"Python bindings for libguestfs
7583 g = guestfs.GuestFS ()
7584 g.add_drive (\"guest.img\")
7587 parts = g.list_partitions ()
7589 The guestfs module provides a Python binding to the libguestfs API
7590 for examining and modifying virtual machine disk images.
7592 Amongst the things this is good for: making batch configuration
7593 changes to guests, getting disk used/free statistics (see also:
7594 virt-df), migrating between virtualization systems (see also:
7595 virt-p2v), performing partial backups, performing partial guest
7596 clones, cloning guests and changing registry/UUID/hostname info, and
7599 Libguestfs uses Linux kernel and qemu code, and can access any type of
7600 guest filesystem that Linux and qemu can, including but not limited
7601 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7602 schemes, qcow, qcow2, vmdk.
7604 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7605 LVs, what filesystem is in each LV, etc.). It can also run commands
7606 in the context of the guest. Also you can access filesystems over FTP.
7608 Errors which happen while using the API are turned into Python
7609 RuntimeError exceptions.
7611 To create a guestfs handle you usually have to perform the following
7614 # Create the handle, call add_drive at least once, and possibly
7615 # several times if the guest has multiple block devices:
7616 g = guestfs.GuestFS ()
7617 g.add_drive (\"guest.img\")
7619 # Launch the qemu subprocess and wait for it to become ready:
7623 # Now you can issue commands, for example:
7628 import libguestfsmod
7631 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7633 def __init__ (self):
7634 \"\"\"Create a new libguestfs handle.\"\"\"
7635 self._o = libguestfsmod.create ()
7638 libguestfsmod.close (self._o)
7643 fun (name, style, _, flags, _, _, longdesc) ->
7645 generate_py_call_args ~handle:"self" (snd style);
7648 if not (List.mem NotInDocs flags) then (
7649 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7651 match fst style with
7652 | RErr | RInt _ | RInt64 _ | RBool _
7653 | RConstOptString _ | RConstString _
7654 | RString _ | RBufferOut _ -> doc
7656 doc ^ "\n\nThis function returns a list of strings."
7657 | RStruct (_, typ) ->
7658 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7659 | RStructList (_, typ) ->
7660 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7662 doc ^ "\n\nThis function returns a dictionary." in
7664 if List.mem ProtocolLimitWarning flags then
7665 doc ^ "\n\n" ^ protocol_limit_warning
7668 if List.mem DangerWillRobinson flags then
7669 doc ^ "\n\n" ^ danger_will_robinson
7672 match deprecation_notice flags with
7674 | Some txt -> doc ^ "\n\n" ^ txt in
7675 let doc = pod2text ~width:60 name doc in
7676 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7677 let doc = String.concat "\n " doc in
7678 pr " u\"\"\"%s\"\"\"\n" doc;
7680 pr " return libguestfsmod.%s " name;
7681 generate_py_call_args ~handle:"self._o" (snd style);
7686 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7687 and generate_py_call_args ~handle args =
7689 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7692 (* Useful if you need the longdesc POD text as plain text. Returns a
7695 * Because this is very slow (the slowest part of autogeneration),
7696 * we memoize the results.
7698 and pod2text ~width name longdesc =
7699 let key = width, name, longdesc in
7700 try Hashtbl.find pod2text_memo key
7702 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7703 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7705 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7706 let chan = Unix.open_process_in cmd in
7707 let lines = ref [] in
7709 let line = input_line chan in
7710 if i = 1 then (* discard the first line of output *)
7713 let line = triml line in
7714 lines := line :: !lines;
7717 let lines = try loop 1 with End_of_file -> List.rev !lines in
7718 Unix.unlink filename;
7719 (match Unix.close_process_in chan with
7720 | Unix.WEXITED 0 -> ()
7722 failwithf "pod2text: process exited with non-zero status (%d)" i
7723 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7724 failwithf "pod2text: process signalled or stopped by signal %d" i
7726 Hashtbl.add pod2text_memo key lines;
7727 let chan = open_out pod2text_memo_filename in
7728 output_value chan pod2text_memo;
7732 (* Generate ruby bindings. *)
7733 and generate_ruby_c () =
7734 generate_header CStyle LGPLv2;
7742 #include \"guestfs.h\"
7744 #include \"extconf.h\"
7746 /* For Ruby < 1.9 */
7748 #define RARRAY_LEN(r) (RARRAY((r))->len)
7751 static VALUE m_guestfs; /* guestfs module */
7752 static VALUE c_guestfs; /* guestfs_h handle */
7753 static VALUE e_Error; /* used for all errors */
7755 static void ruby_guestfs_free (void *p)
7758 guestfs_close ((guestfs_h *) p);
7761 static VALUE ruby_guestfs_create (VALUE m)
7765 g = guestfs_create ();
7767 rb_raise (e_Error, \"failed to create guestfs handle\");
7769 /* Don't print error messages to stderr by default. */
7770 guestfs_set_error_handler (g, NULL, NULL);
7772 /* Wrap it, and make sure the close function is called when the
7775 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7778 static VALUE ruby_guestfs_close (VALUE gv)
7781 Data_Get_Struct (gv, guestfs_h, g);
7783 ruby_guestfs_free (g);
7784 DATA_PTR (gv) = NULL;
7792 fun (name, style, _, _, _, _, _) ->
7793 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7794 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7797 pr " guestfs_h *g;\n";
7798 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7800 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7806 | String n | FileIn n | FileOut n ->
7807 pr " Check_Type (%sv, T_STRING);\n" n;
7808 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7810 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7811 pr " \"%s\", \"%s\");\n" n name
7813 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7815 pr " char **%s;\n" n;
7816 pr " Check_Type (%sv, T_ARRAY);\n" n;
7818 pr " int i, len;\n";
7819 pr " len = RARRAY_LEN (%sv);\n" n;
7820 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7822 pr " for (i = 0; i < len; ++i) {\n";
7823 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7824 pr " %s[i] = StringValueCStr (v);\n" n;
7826 pr " %s[len] = NULL;\n" n;
7829 pr " int %s = RTEST (%sv);\n" n n
7831 pr " int %s = NUM2INT (%sv);\n" n n
7836 match fst style with
7837 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7838 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7839 | RConstString _ | RConstOptString _ ->
7840 pr " const char *r;\n"; "NULL"
7841 | RString _ -> pr " char *r;\n"; "NULL"
7842 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7843 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7844 | RStructList (_, typ) ->
7845 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7848 pr " size_t size;\n";
7852 pr " r = guestfs_%s " name;
7853 generate_c_call_args ~handle:"g" style;
7858 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7860 pr " free (%s);\n" n
7863 pr " if (r == %s)\n" error_code;
7864 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7867 (match fst style with
7869 pr " return Qnil;\n"
7870 | RInt _ | RBool _ ->
7871 pr " return INT2NUM (r);\n"
7873 pr " return ULL2NUM (r);\n"
7875 pr " return rb_str_new2 (r);\n";
7876 | RConstOptString _ ->
7878 pr " return rb_str_new2 (r);\n";
7880 pr " return Qnil;\n";
7882 pr " VALUE rv = rb_str_new2 (r);\n";
7886 pr " int i, len = 0;\n";
7887 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7888 pr " VALUE rv = rb_ary_new2 (len);\n";
7889 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7890 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7891 pr " free (r[i]);\n";
7895 | RStruct (_, typ) ->
7896 let cols = cols_of_struct typ in
7897 generate_ruby_struct_code typ cols
7898 | RStructList (_, typ) ->
7899 let cols = cols_of_struct typ in
7900 generate_ruby_struct_list_code typ cols
7902 pr " VALUE rv = rb_hash_new ();\n";
7904 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7905 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7906 pr " free (r[i]);\n";
7907 pr " free (r[i+1]);\n";
7912 pr " VALUE rv = rb_str_new (r, size);\n";
7922 /* Initialize the module. */
7923 void Init__guestfs ()
7925 m_guestfs = rb_define_module (\"Guestfs\");
7926 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7927 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7929 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7930 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7933 (* Define the rest of the methods. *)
7935 fun (name, style, _, _, _, _, _) ->
7936 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7937 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7942 (* Ruby code to return a struct. *)
7943 and generate_ruby_struct_code typ cols =
7944 pr " VALUE rv = rb_hash_new ();\n";
7948 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7950 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7952 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7953 | name, (FBytes|FUInt64) ->
7954 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7956 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7958 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7960 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7961 | name, FOptPercent ->
7962 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7963 | name, FChar -> (* XXX wrong? *)
7964 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7966 pr " guestfs_free_%s (r);\n" typ;
7969 (* Ruby code to return a struct list. *)
7970 and generate_ruby_struct_list_code typ cols =
7971 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7973 pr " for (i = 0; i < r->len; ++i) {\n";
7974 pr " VALUE hv = rb_hash_new ();\n";
7978 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7980 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
7982 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7983 | name, (FBytes|FUInt64) ->
7984 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7986 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7988 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7990 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7991 | name, FOptPercent ->
7992 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7993 | name, FChar -> (* XXX wrong? *)
7994 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7996 pr " rb_ary_push (rv, hv);\n";
7998 pr " guestfs_free_%s_list (r);\n" typ;
8001 (* Generate Java bindings GuestFS.java file. *)
8002 and generate_java_java () =
8003 generate_header CStyle LGPLv2;
8006 package com.redhat.et.libguestfs;
8008 import java.util.HashMap;
8009 import com.redhat.et.libguestfs.LibGuestFSException;
8010 import com.redhat.et.libguestfs.PV;
8011 import com.redhat.et.libguestfs.VG;
8012 import com.redhat.et.libguestfs.LV;
8013 import com.redhat.et.libguestfs.Stat;
8014 import com.redhat.et.libguestfs.StatVFS;
8015 import com.redhat.et.libguestfs.IntBool;
8016 import com.redhat.et.libguestfs.Dirent;
8019 * The GuestFS object is a libguestfs handle.
8023 public class GuestFS {
8024 // Load the native code.
8026 System.loadLibrary (\"guestfs_jni\");
8030 * The native guestfs_h pointer.
8035 * Create a libguestfs handle.
8037 * @throws LibGuestFSException
8039 public GuestFS () throws LibGuestFSException
8043 private native long _create () throws LibGuestFSException;
8046 * Close a libguestfs handle.
8048 * You can also leave handles to be collected by the garbage
8049 * collector, but this method ensures that the resources used
8050 * by the handle are freed up immediately. If you call any
8051 * other methods after closing the handle, you will get an
8054 * @throws LibGuestFSException
8056 public void close () throws LibGuestFSException
8062 private native void _close (long g) throws LibGuestFSException;
8064 public void finalize () throws LibGuestFSException
8072 fun (name, style, _, flags, _, shortdesc, longdesc) ->
8073 if not (List.mem NotInDocs flags); then (
8074 let doc = replace_str longdesc "C<guestfs_" "C<g." in
8076 if List.mem ProtocolLimitWarning flags then
8077 doc ^ "\n\n" ^ protocol_limit_warning
8080 if List.mem DangerWillRobinson flags then
8081 doc ^ "\n\n" ^ danger_will_robinson
8084 match deprecation_notice flags with
8086 | Some txt -> doc ^ "\n\n" ^ txt in
8087 let doc = pod2text ~width:60 name doc in
8088 let doc = List.map ( (* RHBZ#501883 *)
8091 | nonempty -> nonempty
8093 let doc = String.concat "\n * " doc in
8096 pr " * %s\n" shortdesc;
8099 pr " * @throws LibGuestFSException\n";
8103 generate_java_prototype ~public:true ~semicolon:false name style;
8106 pr " if (g == 0)\n";
8107 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
8110 if fst style <> RErr then pr "return ";
8112 generate_java_call_args ~handle:"g" (snd style);
8116 generate_java_prototype ~privat:true ~native:true name style;
8123 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
8124 and generate_java_call_args ~handle args =
8126 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
8129 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
8130 ?(semicolon=true) name style =
8131 if privat then pr "private ";
8132 if public then pr "public ";
8133 if native then pr "native ";
8136 (match fst style with
8137 | RErr -> pr "void ";
8138 | RInt _ -> pr "int ";
8139 | RInt64 _ -> pr "long ";
8140 | RBool _ -> pr "boolean ";
8141 | RConstString _ | RConstOptString _ | RString _
8142 | RBufferOut _ -> pr "String ";
8143 | RStringList _ -> pr "String[] ";
8144 | RStruct (_, typ) ->
8145 let name = java_name_of_struct typ in
8147 | RStructList (_, typ) ->
8148 let name = java_name_of_struct typ in
8150 | RHashtable _ -> pr "HashMap<String,String> ";
8153 if native then pr "_%s " name else pr "%s " name;
8155 let needs_comma = ref false in
8164 if !needs_comma then pr ", ";
8165 needs_comma := true;
8182 pr " throws LibGuestFSException";
8183 if semicolon then pr ";"
8185 and generate_java_struct jtyp cols =
8186 generate_header CStyle LGPLv2;
8189 package com.redhat.et.libguestfs;
8192 * Libguestfs %s structure.
8204 | name, FBuffer -> pr " public String %s;\n" name
8205 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
8206 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
8207 | name, FChar -> pr " public char %s;\n" name
8208 | name, FOptPercent ->
8209 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
8210 pr " public float %s;\n" name
8215 and generate_java_c () =
8216 generate_header CStyle LGPLv2;
8223 #include \"com_redhat_et_libguestfs_GuestFS.h\"
8224 #include \"guestfs.h\"
8226 /* Note that this function returns. The exception is not thrown
8227 * until after the wrapper function returns.
8230 throw_exception (JNIEnv *env, const char *msg)
8233 cl = (*env)->FindClass (env,
8234 \"com/redhat/et/libguestfs/LibGuestFSException\");
8235 (*env)->ThrowNew (env, cl, msg);
8238 JNIEXPORT jlong JNICALL
8239 Java_com_redhat_et_libguestfs_GuestFS__1create
8240 (JNIEnv *env, jobject obj)
8244 g = guestfs_create ();
8246 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
8249 guestfs_set_error_handler (g, NULL, NULL);
8250 return (jlong) (long) g;
8253 JNIEXPORT void JNICALL
8254 Java_com_redhat_et_libguestfs_GuestFS__1close
8255 (JNIEnv *env, jobject obj, jlong jg)
8257 guestfs_h *g = (guestfs_h *) (long) jg;
8264 fun (name, style, _, _, _, _, _) ->
8266 (match fst style with
8267 | RErr -> pr "void ";
8268 | RInt _ -> pr "jint ";
8269 | RInt64 _ -> pr "jlong ";
8270 | RBool _ -> pr "jboolean ";
8271 | RConstString _ | RConstOptString _ | RString _
8272 | RBufferOut _ -> pr "jstring ";
8273 | RStruct _ | RHashtable _ ->
8275 | RStringList _ | RStructList _ ->
8279 pr "Java_com_redhat_et_libguestfs_GuestFS_";
8280 pr "%s" (replace_str ("_" ^ name) "_" "_1");
8282 pr " (JNIEnv *env, jobject obj, jlong jg";
8289 pr ", jstring j%s" n
8291 pr ", jobjectArray j%s" n
8293 pr ", jboolean j%s" n
8299 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
8300 let error_code, no_ret =
8301 match fst style with
8302 | RErr -> pr " int r;\n"; "-1", ""
8304 | RInt _ -> pr " int r;\n"; "-1", "0"
8305 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
8306 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
8307 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
8309 pr " jstring jr;\n";
8310 pr " char *r;\n"; "NULL", "NULL"
8312 pr " jobjectArray jr;\n";
8315 pr " jstring jstr;\n";
8316 pr " char **r;\n"; "NULL", "NULL"
8317 | RStruct (_, typ) ->
8318 pr " jobject jr;\n";
8320 pr " jfieldID fl;\n";
8321 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
8322 | RStructList (_, typ) ->
8323 pr " jobjectArray jr;\n";
8325 pr " jfieldID fl;\n";
8326 pr " jobject jfl;\n";
8327 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
8328 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
8330 pr " jstring jr;\n";
8332 pr " size_t size;\n";
8340 pr " const char *%s;\n" n
8342 pr " int %s_len;\n" n;
8343 pr " const char **%s;\n" n
8350 (match fst style with
8351 | RStringList _ | RStructList _ -> true
8352 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
8354 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
8355 List.exists (function StringList _ -> true | _ -> false) (snd style) in
8361 (* Get the parameters. *)
8367 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
8369 (* This is completely undocumented, but Java null becomes
8372 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
8374 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
8375 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
8376 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8377 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8379 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
8381 pr " %s[%s_len] = NULL;\n" n n;
8384 pr " %s = j%s;\n" n n
8387 (* Make the call. *)
8388 pr " r = guestfs_%s " name;
8389 generate_c_call_args ~handle:"g" style;
8392 (* Release the parameters. *)
8398 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8401 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8403 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8404 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8406 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
8408 pr " free (%s);\n" n
8413 (* Check for errors. *)
8414 pr " if (r == %s) {\n" error_code;
8415 pr " throw_exception (env, guestfs_last_error (g));\n";
8416 pr " return %s;\n" no_ret;
8420 (match fst style with
8422 | RInt _ -> pr " return (jint) r;\n"
8423 | RBool _ -> pr " return (jboolean) r;\n"
8424 | RInt64 _ -> pr " return (jlong) r;\n"
8425 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
8426 | RConstOptString _ ->
8427 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
8429 pr " jr = (*env)->NewStringUTF (env, r);\n";
8433 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
8434 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
8435 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
8436 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
8437 pr " for (i = 0; i < r_len; ++i) {\n";
8438 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
8439 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
8440 pr " free (r[i]);\n";
8444 | RStruct (_, typ) ->
8445 let jtyp = java_name_of_struct typ in
8446 let cols = cols_of_struct typ in
8447 generate_java_struct_return typ jtyp cols
8448 | RStructList (_, typ) ->
8449 let jtyp = java_name_of_struct typ in
8450 let cols = cols_of_struct typ in
8451 generate_java_struct_list_return typ jtyp cols
8454 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
8455 pr " return NULL;\n"
8457 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
8466 and generate_java_struct_return typ jtyp cols =
8467 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8468 pr " jr = (*env)->AllocObject (env, cl);\n";
8472 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8473 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
8476 pr " char s[33];\n";
8477 pr " memcpy (s, r->%s, 32);\n" name;
8479 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8480 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8484 pr " int len = r->%s_len;\n" name;
8485 pr " char s[len+1];\n";
8486 pr " memcpy (s, r->%s, len);\n" name;
8487 pr " s[len] = 0;\n";
8488 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8489 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8491 | name, (FBytes|FUInt64|FInt64) ->
8492 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8493 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8494 | name, (FUInt32|FInt32) ->
8495 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8496 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8497 | name, FOptPercent ->
8498 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8499 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
8501 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8502 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8507 and generate_java_struct_list_return typ jtyp cols =
8508 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8509 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
8510 pr " for (i = 0; i < r->len; ++i) {\n";
8511 pr " jfl = (*env)->AllocObject (env, cl);\n";
8515 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8516 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8519 pr " char s[33];\n";
8520 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8522 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8523 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8527 pr " int len = r->val[i].%s_len;\n" name;
8528 pr " char s[len+1];\n";
8529 pr " memcpy (s, r->val[i].%s, len);\n" name;
8530 pr " s[len] = 0;\n";
8531 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8532 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8534 | name, (FBytes|FUInt64|FInt64) ->
8535 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8536 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8537 | name, (FUInt32|FInt32) ->
8538 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8539 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8540 | name, FOptPercent ->
8541 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8542 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8544 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8545 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8547 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8549 pr " guestfs_free_%s_list (r);\n" typ;
8552 and generate_java_makefile_inc () =
8553 generate_header HashStyle GPLv2;
8555 pr "java_built_sources = \\\n";
8558 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
8560 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
8562 and generate_haskell_hs () =
8563 generate_header HaskellStyle LGPLv2;
8565 (* XXX We only know how to generate partial FFI for Haskell
8566 * at the moment. Please help out!
8568 let can_generate style =
8572 | RInt64 _, _ -> true
8575 | RConstOptString _, _
8581 | RBufferOut _, _ -> false in
8584 {-# INCLUDE <guestfs.h> #-}
8585 {-# LANGUAGE ForeignFunctionInterface #-}
8590 (* List out the names of the actions we want to export. *)
8592 fun (name, style, _, _, _, _, _) ->
8593 if can_generate style then pr ",\n %s" name
8600 import Foreign.C.Types
8602 import Control.Exception
8603 import Data.Typeable
8605 data GuestfsS = GuestfsS -- represents the opaque C struct
8606 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8607 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8609 -- XXX define properly later XXX
8613 data IntBool = IntBool
8615 data StatVFS = StatVFS
8616 data Hashtable = Hashtable
8618 foreign import ccall unsafe \"guestfs_create\" c_create
8620 foreign import ccall unsafe \"&guestfs_close\" c_close
8621 :: FunPtr (GuestfsP -> IO ())
8622 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8623 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8625 create :: IO GuestfsH
8628 c_set_error_handler p nullPtr nullPtr
8629 h <- newForeignPtr c_close p
8632 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8633 :: GuestfsP -> IO CString
8635 -- last_error :: GuestfsH -> IO (Maybe String)
8636 -- last_error h = do
8637 -- str <- withForeignPtr h (\\p -> c_last_error p)
8638 -- maybePeek peekCString str
8640 last_error :: GuestfsH -> IO (String)
8642 str <- withForeignPtr h (\\p -> c_last_error p)
8644 then return \"no error\"
8645 else peekCString str
8649 (* Generate wrappers for each foreign function. *)
8651 fun (name, style, _, _, _, _, _) ->
8652 if can_generate style then (
8653 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8655 generate_haskell_prototype ~handle:"GuestfsP" style;
8659 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8661 pr "%s %s = do\n" name
8662 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8664 (* Convert pointer arguments using with* functions. *)
8669 | String n -> pr "withCString %s $ \\%s -> " n n
8670 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8671 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8672 | Bool _ | Int _ -> ()
8674 (* Convert integer arguments. *)
8678 | Bool n -> sprintf "(fromBool %s)" n
8679 | Int n -> sprintf "(fromIntegral %s)" n
8680 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8682 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8683 (String.concat " " ("p" :: args));
8684 (match fst style with
8685 | RErr | RInt _ | RInt64 _ | RBool _ ->
8686 pr " if (r == -1)\n";
8688 pr " err <- last_error h\n";
8690 | RConstString _ | RConstOptString _ | RString _
8691 | RStringList _ | RStruct _
8692 | RStructList _ | RHashtable _ | RBufferOut _ ->
8693 pr " if (r == nullPtr)\n";
8695 pr " err <- last_error h\n";
8698 (match fst style with
8700 pr " else return ()\n"
8702 pr " else return (fromIntegral r)\n"
8704 pr " else return (fromIntegral r)\n"
8706 pr " else return (toBool r)\n"
8715 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8721 and generate_haskell_prototype ~handle ?(hs = false) style =
8723 let string = if hs then "String" else "CString" in
8724 let int = if hs then "Int" else "CInt" in
8725 let bool = if hs then "Bool" else "CInt" in
8726 let int64 = if hs then "Integer" else "Int64" in
8730 | String _ -> pr "%s" string
8731 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8732 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8733 | Bool _ -> pr "%s" bool
8734 | Int _ -> pr "%s" int
8735 | FileIn _ -> pr "%s" string
8736 | FileOut _ -> pr "%s" string
8741 (match fst style with
8742 | RErr -> if not hs then pr "CInt"
8743 | RInt _ -> pr "%s" int
8744 | RInt64 _ -> pr "%s" int64
8745 | RBool _ -> pr "%s" bool
8746 | RConstString _ -> pr "%s" string
8747 | RConstOptString _ -> pr "Maybe %s" string
8748 | RString _ -> pr "%s" string
8749 | RStringList _ -> pr "[%s]" string
8750 | RStruct (_, typ) ->
8751 let name = java_name_of_struct typ in
8753 | RStructList (_, typ) ->
8754 let name = java_name_of_struct typ in
8756 | RHashtable _ -> pr "Hashtable"
8757 | RBufferOut _ -> pr "%s" string
8761 and generate_bindtests () =
8762 generate_header CStyle LGPLv2;
8767 #include <inttypes.h>
8770 #include \"guestfs.h\"
8771 #include \"guestfs_protocol.h\"
8773 #define error guestfs_error
8774 #define safe_calloc guestfs_safe_calloc
8775 #define safe_malloc guestfs_safe_malloc
8778 print_strings (char * const* const argv)
8783 for (argc = 0; argv[argc] != NULL; ++argc) {
8784 if (argc > 0) printf (\", \");
8785 printf (\"\\\"%%s\\\"\", argv[argc]);
8790 /* The test0 function prints its parameters to stdout. */
8794 match test_functions with
8795 | [] -> assert false
8796 | test0 :: tests -> test0, tests in
8799 let (name, style, _, _, _, _, _) = test0 in
8800 generate_prototype ~extern:false ~semicolon:false ~newline:true
8801 ~handle:"g" ~prefix:"guestfs_" name style;
8807 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8808 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8809 | StringList n -> pr " print_strings (%s);\n" n
8810 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8811 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8813 pr " /* Java changes stdout line buffering so we need this: */\n";
8814 pr " fflush (stdout);\n";
8820 fun (name, style, _, _, _, _, _) ->
8821 if String.sub name (String.length name - 3) 3 <> "err" then (
8822 pr "/* Test normal return. */\n";
8823 generate_prototype ~extern:false ~semicolon:false ~newline:true
8824 ~handle:"g" ~prefix:"guestfs_" name style;
8826 (match fst style with
8831 pr " sscanf (val, \"%%d\", &r);\n";
8835 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8838 pr " return strcmp (val, \"true\") == 0;\n"
8840 | RConstOptString _ ->
8841 (* Can't return the input string here. Return a static
8842 * string so we ensure we get a segfault if the caller
8845 pr " return \"static string\";\n"
8847 pr " return strdup (val);\n"
8849 pr " char **strs;\n";
8851 pr " sscanf (val, \"%%d\", &n);\n";
8852 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8853 pr " for (i = 0; i < n; ++i) {\n";
8854 pr " strs[i] = safe_malloc (g, 16);\n";
8855 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8857 pr " strs[n] = NULL;\n";
8858 pr " return strs;\n"
8859 | RStruct (_, typ) ->
8860 pr " struct guestfs_%s *r;\n" typ;
8861 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8863 | RStructList (_, typ) ->
8864 pr " struct guestfs_%s_list *r;\n" typ;
8865 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8866 pr " sscanf (val, \"%%d\", &r->len);\n";
8867 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8870 pr " char **strs;\n";
8872 pr " sscanf (val, \"%%d\", &n);\n";
8873 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8874 pr " for (i = 0; i < n; ++i) {\n";
8875 pr " strs[i*2] = safe_malloc (g, 16);\n";
8876 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8877 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8878 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8880 pr " strs[n*2] = NULL;\n";
8881 pr " return strs;\n"
8883 pr " return strdup (val);\n"
8888 pr "/* Test error return. */\n";
8889 generate_prototype ~extern:false ~semicolon:false ~newline:true
8890 ~handle:"g" ~prefix:"guestfs_" name style;
8892 pr " error (g, \"error\");\n";
8893 (match fst style with
8894 | RErr | RInt _ | RInt64 _ | RBool _ ->
8896 | RConstString _ | RConstOptString _
8897 | RString _ | RStringList _ | RStruct _
8901 pr " return NULL;\n"
8908 and generate_ocaml_bindtests () =
8909 generate_header OCamlStyle GPLv2;
8913 let g = Guestfs.create () in
8920 | CallString s -> "\"" ^ s ^ "\""
8921 | CallOptString None -> "None"
8922 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8923 | CallStringList xs ->
8924 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8925 | CallInt i when i >= 0 -> string_of_int i
8926 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8927 | CallBool b -> string_of_bool b
8932 generate_lang_bindtests (
8933 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8936 pr "print_endline \"EOF\"\n"
8938 and generate_perl_bindtests () =
8939 pr "#!/usr/bin/perl -w\n";
8940 generate_header HashStyle GPLv2;
8947 my $g = Sys::Guestfs->new ();
8951 String.concat ", " (
8954 | CallString s -> "\"" ^ s ^ "\""
8955 | CallOptString None -> "undef"
8956 | CallOptString (Some s) -> sprintf "\"%s\"" s
8957 | CallStringList xs ->
8958 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8959 | CallInt i -> string_of_int i
8960 | CallBool b -> if b then "1" else "0"
8965 generate_lang_bindtests (
8966 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8969 pr "print \"EOF\\n\"\n"
8971 and generate_python_bindtests () =
8972 generate_header HashStyle GPLv2;
8977 g = guestfs.GuestFS ()
8981 String.concat ", " (
8984 | CallString s -> "\"" ^ s ^ "\""
8985 | CallOptString None -> "None"
8986 | CallOptString (Some s) -> sprintf "\"%s\"" s
8987 | CallStringList xs ->
8988 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8989 | CallInt i -> string_of_int i
8990 | CallBool b -> if b then "1" else "0"
8995 generate_lang_bindtests (
8996 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8999 pr "print \"EOF\"\n"
9001 and generate_ruby_bindtests () =
9002 generate_header HashStyle GPLv2;
9007 g = Guestfs::create()
9011 String.concat ", " (
9014 | CallString s -> "\"" ^ s ^ "\""
9015 | CallOptString None -> "nil"
9016 | CallOptString (Some s) -> sprintf "\"%s\"" s
9017 | CallStringList xs ->
9018 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
9019 | CallInt i -> string_of_int i
9020 | CallBool b -> string_of_bool b
9025 generate_lang_bindtests (
9026 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
9029 pr "print \"EOF\\n\"\n"
9031 and generate_java_bindtests () =
9032 generate_header CStyle GPLv2;
9035 import com.redhat.et.libguestfs.*;
9037 public class Bindtests {
9038 public static void main (String[] argv)
9041 GuestFS g = new GuestFS ();
9045 String.concat ", " (
9048 | CallString s -> "\"" ^ s ^ "\""
9049 | CallOptString None -> "null"
9050 | CallOptString (Some s) -> sprintf "\"%s\"" s
9051 | CallStringList xs ->
9053 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
9054 | CallInt i -> string_of_int i
9055 | CallBool b -> string_of_bool b
9060 generate_lang_bindtests (
9061 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
9065 System.out.println (\"EOF\");
9067 catch (Exception exn) {
9068 System.err.println (exn);
9075 and generate_haskell_bindtests () =
9076 generate_header HaskellStyle GPLv2;
9079 module Bindtests where
9080 import qualified Guestfs
9090 | CallString s -> "\"" ^ s ^ "\""
9091 | CallOptString None -> "Nothing"
9092 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
9093 | CallStringList xs ->
9094 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
9095 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
9096 | CallInt i -> string_of_int i
9097 | CallBool true -> "True"
9098 | CallBool false -> "False"
9103 generate_lang_bindtests (
9104 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
9107 pr " putStrLn \"EOF\"\n"
9109 (* Language-independent bindings tests - we do it this way to
9110 * ensure there is parity in testing bindings across all languages.
9112 and generate_lang_bindtests call =
9113 call "test0" [CallString "abc"; CallOptString (Some "def");
9114 CallStringList []; CallBool false;
9115 CallInt 0; CallString "123"; CallString "456"];
9116 call "test0" [CallString "abc"; CallOptString None;
9117 CallStringList []; CallBool false;
9118 CallInt 0; CallString "123"; CallString "456"];
9119 call "test0" [CallString ""; CallOptString (Some "def");
9120 CallStringList []; CallBool false;
9121 CallInt 0; CallString "123"; CallString "456"];
9122 call "test0" [CallString ""; CallOptString (Some "");
9123 CallStringList []; CallBool false;
9124 CallInt 0; CallString "123"; CallString "456"];
9125 call "test0" [CallString "abc"; CallOptString (Some "def");
9126 CallStringList ["1"]; CallBool false;
9127 CallInt 0; CallString "123"; CallString "456"];
9128 call "test0" [CallString "abc"; CallOptString (Some "def");
9129 CallStringList ["1"; "2"]; CallBool false;
9130 CallInt 0; CallString "123"; CallString "456"];
9131 call "test0" [CallString "abc"; CallOptString (Some "def");
9132 CallStringList ["1"]; CallBool true;
9133 CallInt 0; CallString "123"; CallString "456"];
9134 call "test0" [CallString "abc"; CallOptString (Some "def");
9135 CallStringList ["1"]; CallBool false;
9136 CallInt (-1); CallString "123"; CallString "456"];
9137 call "test0" [CallString "abc"; CallOptString (Some "def");
9138 CallStringList ["1"]; CallBool false;
9139 CallInt (-2); CallString "123"; CallString "456"];
9140 call "test0" [CallString "abc"; CallOptString (Some "def");
9141 CallStringList ["1"]; CallBool false;
9142 CallInt 1; CallString "123"; CallString "456"];
9143 call "test0" [CallString "abc"; CallOptString (Some "def");
9144 CallStringList ["1"]; CallBool false;
9145 CallInt 2; CallString "123"; CallString "456"];
9146 call "test0" [CallString "abc"; CallOptString (Some "def");
9147 CallStringList ["1"]; CallBool false;
9148 CallInt 4095; CallString "123"; CallString "456"];
9149 call "test0" [CallString "abc"; CallOptString (Some "def");
9150 CallStringList ["1"]; CallBool false;
9151 CallInt 0; CallString ""; CallString ""]
9153 (* XXX Add here tests of the return and error functions. *)
9155 (* This is used to generate the src/MAX_PROC_NR file which
9156 * contains the maximum procedure number, a surrogate for the
9157 * ABI version number. See src/Makefile.am for the details.
9159 and generate_max_proc_nr () =
9160 let proc_nrs = List.map (
9161 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
9162 ) daemon_functions in
9164 let max_proc_nr = List.fold_left max 0 proc_nrs in
9166 pr "%d\n" max_proc_nr
9168 let output_to filename =
9169 let filename_new = filename ^ ".new" in
9170 chan := open_out filename_new;
9175 (* Is the new file different from the current file? *)
9176 if Sys.file_exists filename && files_equal filename filename_new then
9177 Unix.unlink filename_new (* same, so skip it *)
9179 (* different, overwrite old one *)
9180 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
9181 Unix.rename filename_new filename;
9182 Unix.chmod filename 0o444;
9183 printf "written %s\n%!" filename;
9192 if not (Sys.file_exists "HACKING") then (
9194 You are probably running this from the wrong directory.
9195 Run it from the top source directory using the command
9201 let close = output_to "src/guestfs_protocol.x" in
9205 let close = output_to "src/guestfs-structs.h" in
9206 generate_structs_h ();
9209 let close = output_to "src/guestfs-actions.h" in
9210 generate_actions_h ();
9213 let close = output_to "src/guestfs-actions.c" in
9214 generate_client_actions ();
9217 let close = output_to "daemon/actions.h" in
9218 generate_daemon_actions_h ();
9221 let close = output_to "daemon/stubs.c" in
9222 generate_daemon_actions ();
9225 let close = output_to "daemon/names.c" in
9226 generate_daemon_names ();
9229 let close = output_to "capitests/tests.c" in
9233 let close = output_to "src/guestfs-bindtests.c" in
9234 generate_bindtests ();
9237 let close = output_to "fish/cmds.c" in
9238 generate_fish_cmds ();
9241 let close = output_to "fish/completion.c" in
9242 generate_fish_completion ();
9245 let close = output_to "guestfs-structs.pod" in
9246 generate_structs_pod ();
9249 let close = output_to "guestfs-actions.pod" in
9250 generate_actions_pod ();
9253 let close = output_to "guestfish-actions.pod" in
9254 generate_fish_actions_pod ();
9257 let close = output_to "ocaml/guestfs.mli" in
9258 generate_ocaml_mli ();
9261 let close = output_to "ocaml/guestfs.ml" in
9262 generate_ocaml_ml ();
9265 let close = output_to "ocaml/guestfs_c_actions.c" in
9266 generate_ocaml_c ();
9269 let close = output_to "ocaml/bindtests.ml" in
9270 generate_ocaml_bindtests ();
9273 let close = output_to "perl/Guestfs.xs" in
9274 generate_perl_xs ();
9277 let close = output_to "perl/lib/Sys/Guestfs.pm" in
9278 generate_perl_pm ();
9281 let close = output_to "perl/bindtests.pl" in
9282 generate_perl_bindtests ();
9285 let close = output_to "python/guestfs-py.c" in
9286 generate_python_c ();
9289 let close = output_to "python/guestfs.py" in
9290 generate_python_py ();
9293 let close = output_to "python/bindtests.py" in
9294 generate_python_bindtests ();
9297 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
9301 let close = output_to "ruby/bindtests.rb" in
9302 generate_ruby_bindtests ();
9305 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
9306 generate_java_java ();
9311 let cols = cols_of_struct typ in
9312 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
9313 let close = output_to filename in
9314 generate_java_struct jtyp cols;
9318 let close = output_to "java/Makefile.inc" in
9319 generate_java_makefile_inc ();
9322 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
9326 let close = output_to "java/Bindtests.java" in
9327 generate_java_bindtests ();
9330 let close = output_to "haskell/Guestfs.hs" in
9331 generate_haskell_hs ();
9334 let close = output_to "haskell/Bindtests.hs" in
9335 generate_haskell_bindtests ();
9338 let close = output_to "src/MAX_PROC_NR" in
9339 generate_max_proc_nr ();
9342 (* Always generate this file last, and unconditionally. It's used
9343 * by the Makefile to know when we must re-run the generator.
9345 let chan = open_out "src/stamp-generator" in