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, which is formatted
305 * as ext2, empty [except for lost+found] and mounted on /.
306 * /dev/sdb and /dev/sdc may have random content.
312 * /dev/sda1 (is a PV):
313 * /dev/VG/LV (size 8MB):
314 * formatted as ext2, empty [except for lost+found], mounted on /
315 * /dev/sdb and /dev/sdc may have random content.
319 (* /dev/sdd (the squashfs, see images/ directory in source)
324 (* Sequence of commands for testing. *)
326 and cmd = string list
328 (* Note about long descriptions: When referring to another
329 * action, use the format C<guestfs_other> (ie. the full name of
330 * the C function). This will be replaced as appropriate in other
333 * Apart from that, long descriptions are just perldoc paragraphs.
336 (* These test functions are used in the language binding tests. *)
338 let test_all_args = [
341 StringList "strlist";
348 let test_all_rets = [
349 (* except for RErr, which is tested thoroughly elsewhere *)
350 "test0rint", RInt "valout";
351 "test0rint64", RInt64 "valout";
352 "test0rbool", RBool "valout";
353 "test0rconststring", RConstString "valout";
354 "test0rconstoptstring", RConstOptString "valout";
355 "test0rstring", RString "valout";
356 "test0rstringlist", RStringList "valout";
357 "test0rstruct", RStruct ("valout", "lvm_pv");
358 "test0rstructlist", RStructList ("valout", "lvm_pv");
359 "test0rhashtable", RHashtable "valout";
362 let test_functions = [
363 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
365 "internal test function - do not use",
367 This is an internal test function which is used to test whether
368 the automatically generated bindings can handle every possible
369 parameter type correctly.
371 It echos the contents of each parameter to stdout.
373 You probably don't want to call this function.");
377 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
379 "internal test function - do not use",
381 This is an internal test function which is used to test whether
382 the automatically generated bindings can handle every possible
383 return type correctly.
385 It converts string C<val> to the return type.
387 You probably don't want to call this function.");
388 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
390 "internal test function - do not use",
392 This is an internal test function which is used to test whether
393 the automatically generated bindings can handle every possible
394 return type correctly.
396 This function always returns an error.
398 You probably don't want to call this function.")]
402 (* non_daemon_functions are any functions which don't get processed
403 * in the daemon, eg. functions for setting and getting local
404 * configuration values.
407 let non_daemon_functions = test_functions @ [
408 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
410 "launch the qemu subprocess",
412 Internally libguestfs is implemented by running a virtual machine
415 You should call this after configuring the handle
416 (eg. adding drives) but before performing any actions.");
418 ("wait_ready", (RErr, []), -1, [NotInFish],
420 "wait until the qemu subprocess launches",
422 Internally libguestfs is implemented by running a virtual machine
425 You should call this after C<guestfs_launch> to wait for the launch
428 ("kill_subprocess", (RErr, []), -1, [],
430 "kill the qemu subprocess",
432 This kills the qemu subprocess. You should never need to call this.");
434 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
436 "add an image to examine or modify",
438 This function adds a virtual machine disk image C<filename> to the
439 guest. The first time you call this function, the disk appears as IDE
440 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
443 You don't necessarily need to be root when using libguestfs. However
444 you obviously do need sufficient permissions to access the filename
445 for whatever operations you want to perform (ie. read access if you
446 just want to read the image or write access if you want to modify the
449 This is equivalent to the qemu parameter
450 C<-drive file=filename,cache=off,if=...>.
452 Note that this call checks for the existence of C<filename>. This
453 stops you from specifying other types of drive which are supported
454 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
455 the general C<guestfs_config> call instead.");
457 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
459 "add a CD-ROM disk image to examine",
461 This function adds a virtual CD-ROM disk image to the guest.
463 This is equivalent to the qemu parameter C<-cdrom filename>.
465 Note that this call checks for the existence of C<filename>. This
466 stops you from specifying other types of drive which are supported
467 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
468 the general C<guestfs_config> call instead.");
470 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
472 "add a drive in snapshot mode (read-only)",
474 This adds a drive in snapshot mode, making it effectively
477 Note that writes to the device are allowed, and will be seen for
478 the duration of the guestfs handle, but they are written
479 to a temporary file which is discarded as soon as the guestfs
480 handle is closed. We don't currently have any method to enable
481 changes to be committed, although qemu can support this.
483 This is equivalent to the qemu parameter
484 C<-drive file=filename,snapshot=on,if=...>.
486 Note that this call checks for the existence of C<filename>. This
487 stops you from specifying other types of drive which are supported
488 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
489 the general C<guestfs_config> call instead.");
491 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
493 "add qemu parameters",
495 This can be used to add arbitrary qemu command line parameters
496 of the form C<-param value>. Actually it's not quite arbitrary - we
497 prevent you from setting some parameters which would interfere with
498 parameters that we use.
500 The first character of C<param> string must be a C<-> (dash).
502 C<value> can be NULL.");
504 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
506 "set the qemu binary",
508 Set the qemu binary that we will use.
510 The default is chosen when the library was compiled by the
513 You can also override this by setting the C<LIBGUESTFS_QEMU>
514 environment variable.
516 Setting C<qemu> to C<NULL> restores the default qemu binary.");
518 ("get_qemu", (RConstString "qemu", []), -1, [],
519 [InitNone, Always, TestRun (
521 "get the qemu binary",
523 Return the current qemu binary.
525 This is always non-NULL. If it wasn't set already, then this will
526 return the default qemu binary name.");
528 ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
530 "set the search path",
532 Set the path that libguestfs searches for kernel and initrd.img.
534 The default is C<$libdir/guestfs> unless overridden by setting
535 C<LIBGUESTFS_PATH> environment variable.
537 Setting C<path> to C<NULL> restores the default path.");
539 ("get_path", (RConstString "path", []), -1, [],
540 [InitNone, Always, TestRun (
542 "get the search path",
544 Return the current search path.
546 This is always non-NULL. If it wasn't set already, then this will
547 return the default path.");
549 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
551 "add options to kernel command line",
553 This function is used to add additional options to the
554 guest kernel command line.
556 The default is C<NULL> unless overridden by setting
557 C<LIBGUESTFS_APPEND> environment variable.
559 Setting C<append> to C<NULL> means I<no> additional options
560 are passed (libguestfs always adds a few of its own).");
562 ("get_append", (RConstOptString "append", []), -1, [],
563 (* This cannot be tested with the current framework. The
564 * function can return NULL in normal operations, which the
565 * test framework interprets as an error.
568 "get the additional kernel options",
570 Return the additional kernel options which are added to the
571 guest kernel command line.
573 If C<NULL> then no options are added.");
575 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
579 If C<autosync> is true, this enables autosync. Libguestfs will make a
580 best effort attempt to run C<guestfs_umount_all> followed by
581 C<guestfs_sync> when the handle is closed
582 (also if the program exits without closing handles).
584 This is disabled by default (except in guestfish where it is
585 enabled by default).");
587 ("get_autosync", (RBool "autosync", []), -1, [],
588 [InitNone, Always, TestRun (
589 [["get_autosync"]])],
592 Get the autosync flag.");
594 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
598 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
600 Verbose messages are disabled unless the environment variable
601 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
603 ("get_verbose", (RBool "verbose", []), -1, [],
607 This returns the verbose messages flag.");
609 ("is_ready", (RBool "ready", []), -1, [],
610 [InitNone, Always, TestOutputTrue (
612 "is ready to accept commands",
614 This returns true iff this handle is ready to accept commands
615 (in the C<READY> state).
617 For more information on states, see L<guestfs(3)>.");
619 ("is_config", (RBool "config", []), -1, [],
620 [InitNone, Always, TestOutputFalse (
622 "is in configuration state",
624 This returns true iff this handle is being configured
625 (in the C<CONFIG> state).
627 For more information on states, see L<guestfs(3)>.");
629 ("is_launching", (RBool "launching", []), -1, [],
630 [InitNone, Always, TestOutputFalse (
631 [["is_launching"]])],
632 "is launching subprocess",
634 This returns true iff this handle is launching the subprocess
635 (in the C<LAUNCHING> state).
637 For more information on states, see L<guestfs(3)>.");
639 ("is_busy", (RBool "busy", []), -1, [],
640 [InitNone, Always, TestOutputFalse (
642 "is busy processing a command",
644 This returns true iff this handle is busy processing a command
645 (in the C<BUSY> state).
647 For more information on states, see L<guestfs(3)>.");
649 ("get_state", (RInt "state", []), -1, [],
651 "get the current state",
653 This returns the current state as an opaque integer. This is
654 only useful for printing debug and internal error messages.
656 For more information on states, see L<guestfs(3)>.");
658 ("set_busy", (RErr, []), -1, [NotInFish],
662 This sets the state to C<BUSY>. This is only used when implementing
663 actions using the low-level API.
665 For more information on states, see L<guestfs(3)>.");
667 ("set_ready", (RErr, []), -1, [NotInFish],
669 "set state to ready",
671 This sets the state to C<READY>. This is only used when implementing
672 actions using the low-level API.
674 For more information on states, see L<guestfs(3)>.");
676 ("end_busy", (RErr, []), -1, [NotInFish],
678 "leave the busy state",
680 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
681 state as is. This is only used when implementing
682 actions using the low-level API.
684 For more information on states, see L<guestfs(3)>.");
686 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
687 [InitNone, Always, TestOutputInt (
688 [["set_memsize"; "500"];
689 ["get_memsize"]], 500)],
690 "set memory allocated to the qemu subprocess",
692 This sets the memory size in megabytes allocated to the
693 qemu subprocess. This only has any effect if called before
696 You can also change this by setting the environment
697 variable C<LIBGUESTFS_MEMSIZE> before the handle is
700 For more information on the architecture of libguestfs,
701 see L<guestfs(3)>.");
703 ("get_memsize", (RInt "memsize", []), -1, [],
704 [InitNone, Always, TestOutputIntOp (
705 [["get_memsize"]], ">=", 256)],
706 "get memory allocated to the qemu subprocess",
708 This gets the memory size in megabytes allocated to the
711 If C<guestfs_set_memsize> was not called
712 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
713 then this returns the compiled-in default value for memsize.
715 For more information on the architecture of libguestfs,
716 see L<guestfs(3)>.");
718 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
719 [InitNone, Always, TestOutputIntOp (
720 [["get_pid"]], ">=", 1)],
721 "get PID of qemu subprocess",
723 Return the process ID of the qemu subprocess. If there is no
724 qemu subprocess, then this will return an error.
726 This is an internal call used for debugging and testing.");
728 ("version", (RStruct ("version", "version"), []), -1, [],
729 [InitNone, Always, TestOutputStruct (
730 [["version"]], [CompareWithInt ("major", 1)])],
731 "get the library version number",
733 Return the libguestfs version number that the program is linked
736 Note that because of dynamic linking this is not necessarily
737 the version of libguestfs that you compiled against. You can
738 compile the program, and then at runtime dynamically link
739 against a completely different C<libguestfs.so> library.
741 This call was added in version C<1.0.58>. In previous
742 versions of libguestfs there was no way to get the version
743 number. From C code you can use ELF weak linking tricks to find out if
744 this symbol exists (if it doesn't, then it's an earlier version).
746 The call returns a structure with four elements. The first
747 three (C<major>, C<minor> and C<release>) are numbers and
748 correspond to the usual version triplet. The fourth element
749 (C<extra>) is a string and is normally empty, but may be
750 used for distro-specific information.
752 To construct the original version string:
753 C<$major.$minor.$release$extra>
755 I<Note:> Don't use this call to test for availability
756 of features. Distro backports makes this unreliable.");
760 (* daemon_functions are any functions which cause some action
761 * to take place in the daemon.
764 let daemon_functions = [
765 ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
766 [InitEmpty, Always, TestOutput (
767 [["sfdiskM"; "/dev/sda"; ","];
768 ["mkfs"; "ext2"; "/dev/sda1"];
769 ["mount"; "/dev/sda1"; "/"];
770 ["write_file"; "/new"; "new file contents"; "0"];
771 ["cat"; "/new"]], "new file contents")],
772 "mount a guest disk at a position in the filesystem",
774 Mount a guest disk at a position in the filesystem. Block devices
775 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
776 the guest. If those block devices contain partitions, they will have
777 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
780 The rules are the same as for L<mount(2)>: A filesystem must
781 first be mounted on C</> before others can be mounted. Other
782 filesystems can only be mounted on directories which already
785 The mounted filesystem is writable, if we have sufficient permissions
786 on the underlying device.
788 The filesystem options C<sync> and C<noatime> are set with this
789 call, in order to improve reliability.");
791 ("sync", (RErr, []), 2, [],
792 [ InitEmpty, Always, TestRun [["sync"]]],
793 "sync disks, writes are flushed through to the disk image",
795 This syncs the disk, so that any writes are flushed through to the
796 underlying disk image.
798 You should always call this if you have modified a disk image, before
799 closing the handle.");
801 ("touch", (RErr, [String "path"]), 3, [],
802 [InitBasicFS, Always, TestOutputTrue (
804 ["exists"; "/new"]])],
805 "update file timestamps or create a new file",
807 Touch acts like the L<touch(1)> command. It can be used to
808 update the timestamps on a file, or, if the file does not exist,
809 to create a new zero-length file.");
811 ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
812 [InitSquashFS, Always, TestOutput (
813 [["cat"; "/known-2"]], "abcdef\n")],
814 "list the contents of a file",
816 Return the contents of the file named C<path>.
818 Note that this function cannot correctly handle binary files
819 (specifically, files containing C<\\0> character which is treated
820 as end of string). For those you need to use the C<guestfs_read_file>
821 or C<guestfs_download> functions which have a more complex interface.");
823 ("ll", (RString "listing", [String "directory"]), 5, [],
824 [], (* XXX Tricky to test because it depends on the exact format
825 * of the 'ls -l' command, which changes between F10 and F11.
827 "list the files in a directory (long format)",
829 List the files in C<directory> (relative to the root directory,
830 there is no cwd) in the format of 'ls -la'.
832 This command is mostly useful for interactive sessions. It
833 is I<not> intended that you try to parse the output string.");
835 ("ls", (RStringList "listing", [String "directory"]), 6, [],
836 [InitBasicFS, Always, TestOutputList (
839 ["touch"; "/newest"];
840 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
841 "list the files in a directory",
843 List the files in C<directory> (relative to the root directory,
844 there is no cwd). The '.' and '..' entries are not returned, but
845 hidden files are shown.
847 This command is mostly useful for interactive sessions. Programs
848 should probably use C<guestfs_readdir> instead.");
850 ("list_devices", (RStringList "devices", []), 7, [],
851 [InitEmpty, Always, TestOutputListOfDevices (
852 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
853 "list the block devices",
855 List all the block devices.
857 The full block device names are returned, eg. C</dev/sda>");
859 ("list_partitions", (RStringList "partitions", []), 8, [],
860 [InitBasicFS, Always, TestOutputListOfDevices (
861 [["list_partitions"]], ["/dev/sda1"]);
862 InitEmpty, Always, TestOutputListOfDevices (
863 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
864 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
865 "list the partitions",
867 List all the partitions detected on all block devices.
869 The full partition device names are returned, eg. C</dev/sda1>
871 This does not return logical volumes. For that you will need to
872 call C<guestfs_lvs>.");
874 ("pvs", (RStringList "physvols", []), 9, [],
875 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
876 [["pvs"]], ["/dev/sda1"]);
877 InitEmpty, Always, TestOutputListOfDevices (
878 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
879 ["pvcreate"; "/dev/sda1"];
880 ["pvcreate"; "/dev/sda2"];
881 ["pvcreate"; "/dev/sda3"];
882 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
883 "list the LVM physical volumes (PVs)",
885 List all the physical volumes detected. This is the equivalent
886 of the L<pvs(8)> command.
888 This returns a list of just the device names that contain
889 PVs (eg. C</dev/sda2>).
891 See also C<guestfs_pvs_full>.");
893 ("vgs", (RStringList "volgroups", []), 10, [],
894 [InitBasicFSonLVM, Always, TestOutputList (
896 InitEmpty, Always, TestOutputList (
897 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
898 ["pvcreate"; "/dev/sda1"];
899 ["pvcreate"; "/dev/sda2"];
900 ["pvcreate"; "/dev/sda3"];
901 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
902 ["vgcreate"; "VG2"; "/dev/sda3"];
903 ["vgs"]], ["VG1"; "VG2"])],
904 "list the LVM volume groups (VGs)",
906 List all the volumes groups detected. This is the equivalent
907 of the L<vgs(8)> command.
909 This returns a list of just the volume group names that were
910 detected (eg. C<VolGroup00>).
912 See also C<guestfs_vgs_full>.");
914 ("lvs", (RStringList "logvols", []), 11, [],
915 [InitBasicFSonLVM, Always, TestOutputList (
916 [["lvs"]], ["/dev/VG/LV"]);
917 InitEmpty, Always, TestOutputList (
918 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
919 ["pvcreate"; "/dev/sda1"];
920 ["pvcreate"; "/dev/sda2"];
921 ["pvcreate"; "/dev/sda3"];
922 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
923 ["vgcreate"; "VG2"; "/dev/sda3"];
924 ["lvcreate"; "LV1"; "VG1"; "50"];
925 ["lvcreate"; "LV2"; "VG1"; "50"];
926 ["lvcreate"; "LV3"; "VG2"; "50"];
927 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
928 "list the LVM logical volumes (LVs)",
930 List all the logical volumes detected. This is the equivalent
931 of the L<lvs(8)> command.
933 This returns a list of the logical volume device names
934 (eg. C</dev/VolGroup00/LogVol00>).
936 See also C<guestfs_lvs_full>.");
938 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
939 [], (* XXX how to test? *)
940 "list the LVM physical volumes (PVs)",
942 List all the physical volumes detected. This is the equivalent
943 of the L<pvs(8)> command. The \"full\" version includes all fields.");
945 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
946 [], (* XXX how to test? *)
947 "list the LVM volume groups (VGs)",
949 List all the volumes groups detected. This is the equivalent
950 of the L<vgs(8)> command. The \"full\" version includes all fields.");
952 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
953 [], (* XXX how to test? *)
954 "list the LVM logical volumes (LVs)",
956 List all the logical volumes detected. This is the equivalent
957 of the L<lvs(8)> command. The \"full\" version includes all fields.");
959 ("read_lines", (RStringList "lines", [String "path"]), 15, [],
960 [InitSquashFS, Always, TestOutputList (
961 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
962 InitSquashFS, Always, TestOutputList (
963 [["read_lines"; "/empty"]], [])],
964 "read file as lines",
966 Return the contents of the file named C<path>.
968 The file contents are returned as a list of lines. Trailing
969 C<LF> and C<CRLF> character sequences are I<not> returned.
971 Note that this function cannot correctly handle binary files
972 (specifically, files containing C<\\0> character which is treated
973 as end of line). For those you need to use the C<guestfs_read_file>
974 function which has a more complex interface.");
976 ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
977 [], (* XXX Augeas code needs tests. *)
978 "create a new Augeas handle",
980 Create a new Augeas handle for editing configuration files.
981 If there was any previous Augeas handle associated with this
982 guestfs session, then it is closed.
984 You must call this before using any other C<guestfs_aug_*>
987 C<root> is the filesystem root. C<root> must not be NULL,
990 The flags are the same as the flags defined in
991 E<lt>augeas.hE<gt>, the logical I<or> of the following
996 =item C<AUG_SAVE_BACKUP> = 1
998 Keep the original file with a C<.augsave> extension.
1000 =item C<AUG_SAVE_NEWFILE> = 2
1002 Save changes into a file with extension C<.augnew>, and
1003 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1005 =item C<AUG_TYPE_CHECK> = 4
1007 Typecheck lenses (can be expensive).
1009 =item C<AUG_NO_STDINC> = 8
1011 Do not use standard load path for modules.
1013 =item C<AUG_SAVE_NOOP> = 16
1015 Make save a no-op, just record what would have been changed.
1017 =item C<AUG_NO_LOAD> = 32
1019 Do not load the tree in C<guestfs_aug_init>.
1023 To close the handle, you can call C<guestfs_aug_close>.
1025 To find out more about Augeas, see L<http://augeas.net/>.");
1027 ("aug_close", (RErr, []), 26, [],
1028 [], (* XXX Augeas code needs tests. *)
1029 "close the current Augeas handle",
1031 Close the current Augeas handle and free up any resources
1032 used by it. After calling this, you have to call
1033 C<guestfs_aug_init> again before you can use any other
1034 Augeas functions.");
1036 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
1037 [], (* XXX Augeas code needs tests. *)
1038 "define an Augeas variable",
1040 Defines an Augeas variable C<name> whose value is the result
1041 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1044 On success this returns the number of nodes in C<expr>, or
1045 C<0> if C<expr> evaluates to something which is not a nodeset.");
1047 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1048 [], (* XXX Augeas code needs tests. *)
1049 "define an Augeas node",
1051 Defines a variable C<name> whose value is the result of
1054 If C<expr> evaluates to an empty nodeset, a node is created,
1055 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1056 C<name> will be the nodeset containing that single node.
1058 On success this returns a pair containing the
1059 number of nodes in the nodeset, and a boolean flag
1060 if a node was created.");
1062 ("aug_get", (RString "val", [String "path"]), 19, [],
1063 [], (* XXX Augeas code needs tests. *)
1064 "look up the value of an Augeas path",
1066 Look up the value associated with C<path>. If C<path>
1067 matches exactly one node, the C<value> is returned.");
1069 ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
1070 [], (* XXX Augeas code needs tests. *)
1071 "set Augeas path to value",
1073 Set the value associated with C<path> to C<value>.");
1075 ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
1076 [], (* XXX Augeas code needs tests. *)
1077 "insert a sibling Augeas node",
1079 Create a new sibling C<label> for C<path>, inserting it into
1080 the tree before or after C<path> (depending on the boolean
1083 C<path> must match exactly one existing node in the tree, and
1084 C<label> must be a label, ie. not contain C</>, C<*> or end
1085 with a bracketed index C<[N]>.");
1087 ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
1088 [], (* XXX Augeas code needs tests. *)
1089 "remove an Augeas path",
1091 Remove C<path> and all of its children.
1093 On success this returns the number of entries which were removed.");
1095 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1096 [], (* XXX Augeas code needs tests. *)
1099 Move the node C<src> to C<dest>. C<src> must match exactly
1100 one node. C<dest> is overwritten if it exists.");
1102 ("aug_match", (RStringList "matches", [String "path"]), 24, [],
1103 [], (* XXX Augeas code needs tests. *)
1104 "return Augeas nodes which match path",
1106 Returns a list of paths which match the path expression C<path>.
1107 The returned paths are sufficiently qualified so that they match
1108 exactly one node in the current tree.");
1110 ("aug_save", (RErr, []), 25, [],
1111 [], (* XXX Augeas code needs tests. *)
1112 "write all pending Augeas changes to disk",
1114 This writes all pending changes to disk.
1116 The flags which were passed to C<guestfs_aug_init> affect exactly
1117 how files are saved.");
1119 ("aug_load", (RErr, []), 27, [],
1120 [], (* XXX Augeas code needs tests. *)
1121 "load files into the tree",
1123 Load files into the tree.
1125 See C<aug_load> in the Augeas documentation for the full gory
1128 ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
1129 [], (* XXX Augeas code needs tests. *)
1130 "list Augeas nodes under a path",
1132 This is just a shortcut for listing C<guestfs_aug_match>
1133 C<path/*> and sorting the resulting nodes into alphabetical order.");
1135 ("rm", (RErr, [String "path"]), 29, [],
1136 [InitBasicFS, Always, TestRun
1139 InitBasicFS, Always, TestLastFail
1141 InitBasicFS, Always, TestLastFail
1146 Remove the single file C<path>.");
1148 ("rmdir", (RErr, [String "path"]), 30, [],
1149 [InitBasicFS, Always, TestRun
1152 InitBasicFS, Always, TestLastFail
1153 [["rmdir"; "/new"]];
1154 InitBasicFS, Always, TestLastFail
1156 ["rmdir"; "/new"]]],
1157 "remove a directory",
1159 Remove the single directory C<path>.");
1161 ("rm_rf", (RErr, [String "path"]), 31, [],
1162 [InitBasicFS, Always, TestOutputFalse
1164 ["mkdir"; "/new/foo"];
1165 ["touch"; "/new/foo/bar"];
1167 ["exists"; "/new"]]],
1168 "remove a file or directory recursively",
1170 Remove the file or directory C<path>, recursively removing the
1171 contents if its a directory. This is like the C<rm -rf> shell
1174 ("mkdir", (RErr, [String "path"]), 32, [],
1175 [InitBasicFS, Always, TestOutputTrue
1177 ["is_dir"; "/new"]];
1178 InitBasicFS, Always, TestLastFail
1179 [["mkdir"; "/new/foo/bar"]]],
1180 "create a directory",
1182 Create a directory named C<path>.");
1184 ("mkdir_p", (RErr, [String "path"]), 33, [],
1185 [InitBasicFS, Always, TestOutputTrue
1186 [["mkdir_p"; "/new/foo/bar"];
1187 ["is_dir"; "/new/foo/bar"]];
1188 InitBasicFS, Always, TestOutputTrue
1189 [["mkdir_p"; "/new/foo/bar"];
1190 ["is_dir"; "/new/foo"]];
1191 InitBasicFS, Always, TestOutputTrue
1192 [["mkdir_p"; "/new/foo/bar"];
1193 ["is_dir"; "/new"]];
1194 (* Regression tests for RHBZ#503133: *)
1195 InitBasicFS, Always, TestRun
1197 ["mkdir_p"; "/new"]];
1198 InitBasicFS, Always, TestLastFail
1200 ["mkdir_p"; "/new"]]],
1201 "create a directory and parents",
1203 Create a directory named C<path>, creating any parent directories
1204 as necessary. This is like the C<mkdir -p> shell command.");
1206 ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1207 [], (* XXX Need stat command to test *)
1210 Change the mode (permissions) of C<path> to C<mode>. Only
1211 numeric modes are supported.");
1213 ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1214 [], (* XXX Need stat command to test *)
1215 "change file owner and group",
1217 Change the file owner to C<owner> and group to C<group>.
1219 Only numeric uid and gid are supported. If you want to use
1220 names, you will need to locate and parse the password file
1221 yourself (Augeas support makes this relatively easy).");
1223 ("exists", (RBool "existsflag", [String "path"]), 36, [],
1224 [InitSquashFS, Always, TestOutputTrue (
1225 [["exists"; "/empty"]]);
1226 InitSquashFS, Always, TestOutputTrue (
1227 [["exists"; "/directory"]])],
1228 "test if file or directory exists",
1230 This returns C<true> if and only if there is a file, directory
1231 (or anything) with the given C<path> name.
1233 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1235 ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1236 [InitSquashFS, Always, TestOutputTrue (
1237 [["is_file"; "/known-1"]]);
1238 InitSquashFS, Always, TestOutputFalse (
1239 [["is_file"; "/directory"]])],
1240 "test if file exists",
1242 This returns C<true> if and only if there is a file
1243 with the given C<path> name. Note that it returns false for
1244 other objects like directories.
1246 See also C<guestfs_stat>.");
1248 ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1249 [InitSquashFS, Always, TestOutputFalse (
1250 [["is_dir"; "/known-3"]]);
1251 InitSquashFS, Always, TestOutputTrue (
1252 [["is_dir"; "/directory"]])],
1253 "test if file exists",
1255 This returns C<true> if and only if there is a directory
1256 with the given C<path> name. Note that it returns false for
1257 other objects like files.
1259 See also C<guestfs_stat>.");
1261 ("pvcreate", (RErr, [String "device"]), 39, [],
1262 [InitEmpty, Always, TestOutputListOfDevices (
1263 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1264 ["pvcreate"; "/dev/sda1"];
1265 ["pvcreate"; "/dev/sda2"];
1266 ["pvcreate"; "/dev/sda3"];
1267 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1268 "create an LVM physical volume",
1270 This creates an LVM physical volume on the named C<device>,
1271 where C<device> should usually be a partition name such
1274 ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1275 [InitEmpty, Always, TestOutputList (
1276 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1277 ["pvcreate"; "/dev/sda1"];
1278 ["pvcreate"; "/dev/sda2"];
1279 ["pvcreate"; "/dev/sda3"];
1280 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1281 ["vgcreate"; "VG2"; "/dev/sda3"];
1282 ["vgs"]], ["VG1"; "VG2"])],
1283 "create an LVM volume group",
1285 This creates an LVM volume group called C<volgroup>
1286 from the non-empty list of physical volumes C<physvols>.");
1288 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1289 [InitEmpty, Always, TestOutputList (
1290 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1291 ["pvcreate"; "/dev/sda1"];
1292 ["pvcreate"; "/dev/sda2"];
1293 ["pvcreate"; "/dev/sda3"];
1294 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1295 ["vgcreate"; "VG2"; "/dev/sda3"];
1296 ["lvcreate"; "LV1"; "VG1"; "50"];
1297 ["lvcreate"; "LV2"; "VG1"; "50"];
1298 ["lvcreate"; "LV3"; "VG2"; "50"];
1299 ["lvcreate"; "LV4"; "VG2"; "50"];
1300 ["lvcreate"; "LV5"; "VG2"; "50"];
1302 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1303 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1304 "create an LVM volume group",
1306 This creates an LVM volume group called C<logvol>
1307 on the volume group C<volgroup>, with C<size> megabytes.");
1309 ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1310 [InitEmpty, Always, TestOutput (
1311 [["sfdiskM"; "/dev/sda"; ","];
1312 ["mkfs"; "ext2"; "/dev/sda1"];
1313 ["mount"; "/dev/sda1"; "/"];
1314 ["write_file"; "/new"; "new file contents"; "0"];
1315 ["cat"; "/new"]], "new file contents")],
1316 "make a filesystem",
1318 This creates a filesystem on C<device> (usually a partition
1319 or LVM logical volume). The filesystem type is C<fstype>, for
1322 ("sfdisk", (RErr, [String "device";
1323 Int "cyls"; Int "heads"; Int "sectors";
1324 StringList "lines"]), 43, [DangerWillRobinson],
1326 "create partitions on a block device",
1328 This is a direct interface to the L<sfdisk(8)> program for creating
1329 partitions on block devices.
1331 C<device> should be a block device, for example C</dev/sda>.
1333 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1334 and sectors on the device, which are passed directly to sfdisk as
1335 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1336 of these, then the corresponding parameter is omitted. Usually for
1337 'large' disks, you can just pass C<0> for these, but for small
1338 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1339 out the right geometry and you will need to tell it.
1341 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1342 information refer to the L<sfdisk(8)> manpage.
1344 To create a single partition occupying the whole disk, you would
1345 pass C<lines> as a single element list, when the single element being
1346 the string C<,> (comma).
1348 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1350 ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1351 [InitBasicFS, Always, TestOutput (
1352 [["write_file"; "/new"; "new file contents"; "0"];
1353 ["cat"; "/new"]], "new file contents");
1354 InitBasicFS, Always, TestOutput (
1355 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1356 ["cat"; "/new"]], "\nnew file contents\n");
1357 InitBasicFS, Always, TestOutput (
1358 [["write_file"; "/new"; "\n\n"; "0"];
1359 ["cat"; "/new"]], "\n\n");
1360 InitBasicFS, Always, TestOutput (
1361 [["write_file"; "/new"; ""; "0"];
1362 ["cat"; "/new"]], "");
1363 InitBasicFS, Always, TestOutput (
1364 [["write_file"; "/new"; "\n\n\n"; "0"];
1365 ["cat"; "/new"]], "\n\n\n");
1366 InitBasicFS, Always, TestOutput (
1367 [["write_file"; "/new"; "\n"; "0"];
1368 ["cat"; "/new"]], "\n")],
1371 This call creates a file called C<path>. The contents of the
1372 file is the string C<content> (which can contain any 8 bit data),
1373 with length C<size>.
1375 As a special case, if C<size> is C<0>
1376 then the length is calculated using C<strlen> (so in this case
1377 the content cannot contain embedded ASCII NULs).
1379 I<NB.> Owing to a bug, writing content containing ASCII NUL
1380 characters does I<not> work, even if the length is specified.
1381 We hope to resolve this bug in a future version. In the meantime
1382 use C<guestfs_upload>.");
1384 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1385 [InitEmpty, Always, TestOutputListOfDevices (
1386 [["sfdiskM"; "/dev/sda"; ","];
1387 ["mkfs"; "ext2"; "/dev/sda1"];
1388 ["mount"; "/dev/sda1"; "/"];
1389 ["mounts"]], ["/dev/sda1"]);
1390 InitEmpty, Always, TestOutputList (
1391 [["sfdiskM"; "/dev/sda"; ","];
1392 ["mkfs"; "ext2"; "/dev/sda1"];
1393 ["mount"; "/dev/sda1"; "/"];
1396 "unmount a filesystem",
1398 This unmounts the given filesystem. The filesystem may be
1399 specified either by its mountpoint (path) or the device which
1400 contains the filesystem.");
1402 ("mounts", (RStringList "devices", []), 46, [],
1403 [InitBasicFS, Always, TestOutputListOfDevices (
1404 [["mounts"]], ["/dev/sda1"])],
1405 "show mounted filesystems",
1407 This returns the list of currently mounted filesystems. It returns
1408 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1410 Some internal mounts are not shown.
1412 See also: C<guestfs_mountpoints>");
1414 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1415 [InitBasicFS, Always, TestOutputList (
1418 (* check that umount_all can unmount nested mounts correctly: *)
1419 InitEmpty, Always, TestOutputList (
1420 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1421 ["mkfs"; "ext2"; "/dev/sda1"];
1422 ["mkfs"; "ext2"; "/dev/sda2"];
1423 ["mkfs"; "ext2"; "/dev/sda3"];
1424 ["mount"; "/dev/sda1"; "/"];
1426 ["mount"; "/dev/sda2"; "/mp1"];
1427 ["mkdir"; "/mp1/mp2"];
1428 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1429 ["mkdir"; "/mp1/mp2/mp3"];
1432 "unmount all filesystems",
1434 This unmounts all mounted filesystems.
1436 Some internal mounts are not unmounted by this call.");
1438 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1440 "remove all LVM LVs, VGs and PVs",
1442 This command removes all LVM logical volumes, volume groups
1443 and physical volumes.");
1445 ("file", (RString "description", [String "path"]), 49, [],
1446 [InitSquashFS, Always, TestOutput (
1447 [["file"; "/empty"]], "empty");
1448 InitSquashFS, Always, TestOutput (
1449 [["file"; "/known-1"]], "ASCII text");
1450 InitSquashFS, Always, TestLastFail (
1451 [["file"; "/notexists"]])],
1452 "determine file type",
1454 This call uses the standard L<file(1)> command to determine
1455 the type or contents of the file. This also works on devices,
1456 for example to find out whether a partition contains a filesystem.
1458 This call will also transparently look inside various types
1461 The exact command which runs is C<file -zbsL path>. Note in
1462 particular that the filename is not prepended to the output
1463 (the C<-b> option).");
1465 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1466 [InitBasicFS, Always, TestOutput (
1467 [["upload"; "test-command"; "/test-command"];
1468 ["chmod"; "0o755"; "/test-command"];
1469 ["command"; "/test-command 1"]], "Result1");
1470 InitBasicFS, Always, TestOutput (
1471 [["upload"; "test-command"; "/test-command"];
1472 ["chmod"; "0o755"; "/test-command"];
1473 ["command"; "/test-command 2"]], "Result2\n");
1474 InitBasicFS, Always, TestOutput (
1475 [["upload"; "test-command"; "/test-command"];
1476 ["chmod"; "0o755"; "/test-command"];
1477 ["command"; "/test-command 3"]], "\nResult3");
1478 InitBasicFS, Always, TestOutput (
1479 [["upload"; "test-command"; "/test-command"];
1480 ["chmod"; "0o755"; "/test-command"];
1481 ["command"; "/test-command 4"]], "\nResult4\n");
1482 InitBasicFS, Always, TestOutput (
1483 [["upload"; "test-command"; "/test-command"];
1484 ["chmod"; "0o755"; "/test-command"];
1485 ["command"; "/test-command 5"]], "\nResult5\n\n");
1486 InitBasicFS, Always, TestOutput (
1487 [["upload"; "test-command"; "/test-command"];
1488 ["chmod"; "0o755"; "/test-command"];
1489 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1490 InitBasicFS, Always, TestOutput (
1491 [["upload"; "test-command"; "/test-command"];
1492 ["chmod"; "0o755"; "/test-command"];
1493 ["command"; "/test-command 7"]], "");
1494 InitBasicFS, Always, TestOutput (
1495 [["upload"; "test-command"; "/test-command"];
1496 ["chmod"; "0o755"; "/test-command"];
1497 ["command"; "/test-command 8"]], "\n");
1498 InitBasicFS, Always, TestOutput (
1499 [["upload"; "test-command"; "/test-command"];
1500 ["chmod"; "0o755"; "/test-command"];
1501 ["command"; "/test-command 9"]], "\n\n");
1502 InitBasicFS, Always, TestOutput (
1503 [["upload"; "test-command"; "/test-command"];
1504 ["chmod"; "0o755"; "/test-command"];
1505 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1506 InitBasicFS, Always, TestOutput (
1507 [["upload"; "test-command"; "/test-command"];
1508 ["chmod"; "0o755"; "/test-command"];
1509 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1510 InitBasicFS, Always, TestLastFail (
1511 [["upload"; "test-command"; "/test-command"];
1512 ["chmod"; "0o755"; "/test-command"];
1513 ["command"; "/test-command"]])],
1514 "run a command from the guest filesystem",
1516 This call runs a command from the guest filesystem. The
1517 filesystem must be mounted, and must contain a compatible
1518 operating system (ie. something Linux, with the same
1519 or compatible processor architecture).
1521 The single parameter is an argv-style list of arguments.
1522 The first element is the name of the program to run.
1523 Subsequent elements are parameters. The list must be
1524 non-empty (ie. must contain a program name). Note that
1525 the command runs directly, and is I<not> invoked via
1526 the shell (see C<guestfs_sh>).
1528 The return value is anything printed to I<stdout> by
1531 If the command returns a non-zero exit status, then
1532 this function returns an error message. The error message
1533 string is the content of I<stderr> from the command.
1535 The C<$PATH> environment variable will contain at least
1536 C</usr/bin> and C</bin>. If you require a program from
1537 another location, you should provide the full path in the
1540 Shared libraries and data files required by the program
1541 must be available on filesystems which are mounted in the
1542 correct places. It is the caller's responsibility to ensure
1543 all filesystems that are needed are mounted at the right
1546 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1547 [InitBasicFS, Always, TestOutputList (
1548 [["upload"; "test-command"; "/test-command"];
1549 ["chmod"; "0o755"; "/test-command"];
1550 ["command_lines"; "/test-command 1"]], ["Result1"]);
1551 InitBasicFS, Always, TestOutputList (
1552 [["upload"; "test-command"; "/test-command"];
1553 ["chmod"; "0o755"; "/test-command"];
1554 ["command_lines"; "/test-command 2"]], ["Result2"]);
1555 InitBasicFS, Always, TestOutputList (
1556 [["upload"; "test-command"; "/test-command"];
1557 ["chmod"; "0o755"; "/test-command"];
1558 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1559 InitBasicFS, Always, TestOutputList (
1560 [["upload"; "test-command"; "/test-command"];
1561 ["chmod"; "0o755"; "/test-command"];
1562 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1563 InitBasicFS, Always, TestOutputList (
1564 [["upload"; "test-command"; "/test-command"];
1565 ["chmod"; "0o755"; "/test-command"];
1566 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1567 InitBasicFS, Always, TestOutputList (
1568 [["upload"; "test-command"; "/test-command"];
1569 ["chmod"; "0o755"; "/test-command"];
1570 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1571 InitBasicFS, Always, TestOutputList (
1572 [["upload"; "test-command"; "/test-command"];
1573 ["chmod"; "0o755"; "/test-command"];
1574 ["command_lines"; "/test-command 7"]], []);
1575 InitBasicFS, Always, TestOutputList (
1576 [["upload"; "test-command"; "/test-command"];
1577 ["chmod"; "0o755"; "/test-command"];
1578 ["command_lines"; "/test-command 8"]], [""]);
1579 InitBasicFS, Always, TestOutputList (
1580 [["upload"; "test-command"; "/test-command"];
1581 ["chmod"; "0o755"; "/test-command"];
1582 ["command_lines"; "/test-command 9"]], ["";""]);
1583 InitBasicFS, Always, TestOutputList (
1584 [["upload"; "test-command"; "/test-command"];
1585 ["chmod"; "0o755"; "/test-command"];
1586 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1587 InitBasicFS, Always, TestOutputList (
1588 [["upload"; "test-command"; "/test-command"];
1589 ["chmod"; "0o755"; "/test-command"];
1590 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1591 "run a command, returning lines",
1593 This is the same as C<guestfs_command>, but splits the
1594 result into a list of lines.
1596 See also: C<guestfs_sh_lines>");
1598 ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1599 [InitSquashFS, Always, TestOutputStruct (
1600 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1601 "get file information",
1603 Returns file information for the given C<path>.
1605 This is the same as the C<stat(2)> system call.");
1607 ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1608 [InitSquashFS, Always, TestOutputStruct (
1609 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1610 "get file information for a symbolic link",
1612 Returns file information for the given C<path>.
1614 This is the same as C<guestfs_stat> except that if C<path>
1615 is a symbolic link, then the link is stat-ed, not the file it
1618 This is the same as the C<lstat(2)> system call.");
1620 ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1621 [InitSquashFS, Always, TestOutputStruct (
1622 [["statvfs"; "/"]], [CompareWithInt ("namemax", 256)])],
1623 "get file system statistics",
1625 Returns file system statistics for any mounted file system.
1626 C<path> should be a file or directory in the mounted file system
1627 (typically it is the mount point itself, but it doesn't need to be).
1629 This is the same as the C<statvfs(2)> system call.");
1631 ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1633 "get ext2/ext3/ext4 superblock details",
1635 This returns the contents of the ext2, ext3 or ext4 filesystem
1636 superblock on C<device>.
1638 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1639 manpage for more details. The list of fields returned isn't
1640 clearly defined, and depends on both the version of C<tune2fs>
1641 that libguestfs was built against, and the filesystem itself.");
1643 ("blockdev_setro", (RErr, [String "device"]), 56, [],
1644 [InitEmpty, Always, TestOutputTrue (
1645 [["blockdev_setro"; "/dev/sda"];
1646 ["blockdev_getro"; "/dev/sda"]])],
1647 "set block device to read-only",
1649 Sets the block device named C<device> to read-only.
1651 This uses the L<blockdev(8)> command.");
1653 ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1654 [InitEmpty, Always, TestOutputFalse (
1655 [["blockdev_setrw"; "/dev/sda"];
1656 ["blockdev_getro"; "/dev/sda"]])],
1657 "set block device to read-write",
1659 Sets the block device named C<device> to read-write.
1661 This uses the L<blockdev(8)> command.");
1663 ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1664 [InitEmpty, Always, TestOutputTrue (
1665 [["blockdev_setro"; "/dev/sda"];
1666 ["blockdev_getro"; "/dev/sda"]])],
1667 "is block device set to read-only",
1669 Returns a boolean indicating if the block device is read-only
1670 (true if read-only, false if not).
1672 This uses the L<blockdev(8)> command.");
1674 ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1675 [InitEmpty, Always, TestOutputInt (
1676 [["blockdev_getss"; "/dev/sda"]], 512)],
1677 "get sectorsize of block device",
1679 This returns the size of sectors on a block device.
1680 Usually 512, but can be larger for modern devices.
1682 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1685 This uses the L<blockdev(8)> command.");
1687 ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1688 [InitEmpty, Always, TestOutputInt (
1689 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1690 "get blocksize of block device",
1692 This returns the block size of a device.
1694 (Note this is different from both I<size in blocks> and
1695 I<filesystem block size>).
1697 This uses the L<blockdev(8)> command.");
1699 ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1701 "set blocksize of block device",
1703 This sets the block size of a device.
1705 (Note this is different from both I<size in blocks> and
1706 I<filesystem block size>).
1708 This uses the L<blockdev(8)> command.");
1710 ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1711 [InitEmpty, Always, TestOutputInt (
1712 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1713 "get total size of device in 512-byte sectors",
1715 This returns the size of the device in units of 512-byte sectors
1716 (even if the sectorsize isn't 512 bytes ... weird).
1718 See also C<guestfs_blockdev_getss> for the real sector size of
1719 the device, and C<guestfs_blockdev_getsize64> for the more
1720 useful I<size in bytes>.
1722 This uses the L<blockdev(8)> command.");
1724 ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1725 [InitEmpty, Always, TestOutputInt (
1726 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1727 "get total size of device in bytes",
1729 This returns the size of the device in bytes.
1731 See also C<guestfs_blockdev_getsz>.
1733 This uses the L<blockdev(8)> command.");
1735 ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1736 [InitEmpty, Always, TestRun
1737 [["blockdev_flushbufs"; "/dev/sda"]]],
1738 "flush device buffers",
1740 This tells the kernel to flush internal buffers associated
1743 This uses the L<blockdev(8)> command.");
1745 ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1746 [InitEmpty, Always, TestRun
1747 [["blockdev_rereadpt"; "/dev/sda"]]],
1748 "reread partition table",
1750 Reread the partition table on C<device>.
1752 This uses the L<blockdev(8)> command.");
1754 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1755 [InitBasicFS, Always, TestOutput (
1756 (* Pick a file from cwd which isn't likely to change. *)
1757 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1758 ["checksum"; "md5"; "/COPYING.LIB"]],
1759 Digest.to_hex (Digest.file "COPYING.LIB"))],
1760 "upload a file from the local machine",
1762 Upload local file C<filename> to C<remotefilename> on the
1765 C<filename> can also be a named pipe.
1767 See also C<guestfs_download>.");
1769 ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1770 [InitBasicFS, Always, TestOutput (
1771 (* Pick a file from cwd which isn't likely to change. *)
1772 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1773 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1774 ["upload"; "testdownload.tmp"; "/upload"];
1775 ["checksum"; "md5"; "/upload"]],
1776 Digest.to_hex (Digest.file "COPYING.LIB"))],
1777 "download a file to the local machine",
1779 Download file C<remotefilename> and save it as C<filename>
1780 on the local machine.
1782 C<filename> can also be a named pipe.
1784 See also C<guestfs_upload>, C<guestfs_cat>.");
1786 ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1787 [InitSquashFS, Always, TestOutput (
1788 [["checksum"; "crc"; "/known-3"]], "2891671662");
1789 InitSquashFS, Always, TestLastFail (
1790 [["checksum"; "crc"; "/notexists"]]);
1791 InitSquashFS, Always, TestOutput (
1792 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1793 InitSquashFS, Always, TestOutput (
1794 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1795 InitSquashFS, Always, TestOutput (
1796 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1797 InitSquashFS, Always, TestOutput (
1798 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1799 InitSquashFS, Always, TestOutput (
1800 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1801 InitSquashFS, Always, TestOutput (
1802 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1803 "compute MD5, SHAx or CRC checksum of file",
1805 This call computes the MD5, SHAx or CRC checksum of the
1808 The type of checksum to compute is given by the C<csumtype>
1809 parameter which must have one of the following values:
1815 Compute the cyclic redundancy check (CRC) specified by POSIX
1816 for the C<cksum> command.
1820 Compute the MD5 hash (using the C<md5sum> program).
1824 Compute the SHA1 hash (using the C<sha1sum> program).
1828 Compute the SHA224 hash (using the C<sha224sum> program).
1832 Compute the SHA256 hash (using the C<sha256sum> program).
1836 Compute the SHA384 hash (using the C<sha384sum> program).
1840 Compute the SHA512 hash (using the C<sha512sum> program).
1844 The checksum is returned as a printable string.");
1846 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1847 [InitBasicFS, Always, TestOutput (
1848 [["tar_in"; "../images/helloworld.tar"; "/"];
1849 ["cat"; "/hello"]], "hello\n")],
1850 "unpack tarfile to directory",
1852 This command uploads and unpacks local file C<tarfile> (an
1853 I<uncompressed> tar file) into C<directory>.
1855 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1857 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1859 "pack directory into tarfile",
1861 This command packs the contents of C<directory> and downloads
1862 it to local file C<tarfile>.
1864 To download a compressed tarball, use C<guestfs_tgz_out>.");
1866 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1867 [InitBasicFS, Always, TestOutput (
1868 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1869 ["cat"; "/hello"]], "hello\n")],
1870 "unpack compressed tarball to directory",
1872 This command uploads and unpacks local file C<tarball> (a
1873 I<gzip compressed> tar file) into C<directory>.
1875 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1877 ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1879 "pack directory into compressed tarball",
1881 This command packs the contents of C<directory> and downloads
1882 it to local file C<tarball>.
1884 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1886 ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1887 [InitBasicFS, Always, TestLastFail (
1889 ["mount_ro"; "/dev/sda1"; "/"];
1890 ["touch"; "/new"]]);
1891 InitBasicFS, Always, TestOutput (
1892 [["write_file"; "/new"; "data"; "0"];
1894 ["mount_ro"; "/dev/sda1"; "/"];
1895 ["cat"; "/new"]], "data")],
1896 "mount a guest disk, read-only",
1898 This is the same as the C<guestfs_mount> command, but it
1899 mounts the filesystem with the read-only (I<-o ro>) flag.");
1901 ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1903 "mount a guest disk with mount options",
1905 This is the same as the C<guestfs_mount> command, but it
1906 allows you to set the mount options as for the
1907 L<mount(8)> I<-o> flag.");
1909 ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1911 "mount a guest disk with mount options and vfstype",
1913 This is the same as the C<guestfs_mount> command, but it
1914 allows you to set both the mount options and the vfstype
1915 as for the L<mount(8)> I<-o> and I<-t> flags.");
1917 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1919 "debugging and internals",
1921 The C<guestfs_debug> command exposes some internals of
1922 C<guestfsd> (the guestfs daemon) that runs inside the
1925 There is no comprehensive help for this command. You have
1926 to look at the file C<daemon/debug.c> in the libguestfs source
1927 to find out what you can do.");
1929 ("lvremove", (RErr, [String "device"]), 77, [],
1930 [InitEmpty, Always, TestOutputList (
1931 [["sfdiskM"; "/dev/sda"; ","];
1932 ["pvcreate"; "/dev/sda1"];
1933 ["vgcreate"; "VG"; "/dev/sda1"];
1934 ["lvcreate"; "LV1"; "VG"; "50"];
1935 ["lvcreate"; "LV2"; "VG"; "50"];
1936 ["lvremove"; "/dev/VG/LV1"];
1937 ["lvs"]], ["/dev/VG/LV2"]);
1938 InitEmpty, Always, TestOutputList (
1939 [["sfdiskM"; "/dev/sda"; ","];
1940 ["pvcreate"; "/dev/sda1"];
1941 ["vgcreate"; "VG"; "/dev/sda1"];
1942 ["lvcreate"; "LV1"; "VG"; "50"];
1943 ["lvcreate"; "LV2"; "VG"; "50"];
1944 ["lvremove"; "/dev/VG"];
1946 InitEmpty, Always, TestOutputList (
1947 [["sfdiskM"; "/dev/sda"; ","];
1948 ["pvcreate"; "/dev/sda1"];
1949 ["vgcreate"; "VG"; "/dev/sda1"];
1950 ["lvcreate"; "LV1"; "VG"; "50"];
1951 ["lvcreate"; "LV2"; "VG"; "50"];
1952 ["lvremove"; "/dev/VG"];
1954 "remove an LVM logical volume",
1956 Remove an LVM logical volume C<device>, where C<device> is
1957 the path to the LV, such as C</dev/VG/LV>.
1959 You can also remove all LVs in a volume group by specifying
1960 the VG name, C</dev/VG>.");
1962 ("vgremove", (RErr, [String "vgname"]), 78, [],
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"];
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"];
1979 "remove an LVM volume group",
1981 Remove an LVM volume group C<vgname>, (for example C<VG>).
1983 This also forcibly removes all logical volumes in the volume
1986 ("pvremove", (RErr, [String "device"]), 79, [],
1987 [InitEmpty, Always, TestOutputListOfDevices (
1988 [["sfdiskM"; "/dev/sda"; ","];
1989 ["pvcreate"; "/dev/sda1"];
1990 ["vgcreate"; "VG"; "/dev/sda1"];
1991 ["lvcreate"; "LV1"; "VG"; "50"];
1992 ["lvcreate"; "LV2"; "VG"; "50"];
1994 ["pvremove"; "/dev/sda1"];
1996 InitEmpty, Always, TestOutputListOfDevices (
1997 [["sfdiskM"; "/dev/sda"; ","];
1998 ["pvcreate"; "/dev/sda1"];
1999 ["vgcreate"; "VG"; "/dev/sda1"];
2000 ["lvcreate"; "LV1"; "VG"; "50"];
2001 ["lvcreate"; "LV2"; "VG"; "50"];
2003 ["pvremove"; "/dev/sda1"];
2005 InitEmpty, Always, TestOutputListOfDevices (
2006 [["sfdiskM"; "/dev/sda"; ","];
2007 ["pvcreate"; "/dev/sda1"];
2008 ["vgcreate"; "VG"; "/dev/sda1"];
2009 ["lvcreate"; "LV1"; "VG"; "50"];
2010 ["lvcreate"; "LV2"; "VG"; "50"];
2012 ["pvremove"; "/dev/sda1"];
2014 "remove an LVM physical volume",
2016 This wipes a physical volume C<device> so that LVM will no longer
2019 The implementation uses the C<pvremove> command which refuses to
2020 wipe physical volumes that contain any volume groups, so you have
2021 to remove those first.");
2023 ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
2024 [InitBasicFS, Always, TestOutput (
2025 [["set_e2label"; "/dev/sda1"; "testlabel"];
2026 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2027 "set the ext2/3/4 filesystem label",
2029 This sets the ext2/3/4 filesystem label of the filesystem on
2030 C<device> to C<label>. Filesystem labels are limited to
2033 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2034 to return the existing label on a filesystem.");
2036 ("get_e2label", (RString "label", [String "device"]), 81, [],
2038 "get the ext2/3/4 filesystem label",
2040 This returns the ext2/3/4 filesystem label of the filesystem on
2043 ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
2044 [InitBasicFS, Always, TestOutput (
2045 [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
2046 ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2047 InitBasicFS, Always, TestOutput (
2048 [["set_e2uuid"; "/dev/sda1"; "clear"];
2049 ["get_e2uuid"; "/dev/sda1"]], "");
2050 (* We can't predict what UUIDs will be, so just check the commands run. *)
2051 InitBasicFS, Always, TestRun (
2052 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2053 InitBasicFS, Always, TestRun (
2054 [["set_e2uuid"; "/dev/sda1"; "time"]])],
2055 "set the ext2/3/4 filesystem UUID",
2057 This sets the ext2/3/4 filesystem UUID of the filesystem on
2058 C<device> to C<uuid>. The format of the UUID and alternatives
2059 such as C<clear>, C<random> and C<time> are described in the
2060 L<tune2fs(8)> manpage.
2062 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2063 to return the existing UUID of a filesystem.");
2065 ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2067 "get the ext2/3/4 filesystem UUID",
2069 This returns the ext2/3/4 filesystem UUID of the filesystem on
2072 ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2073 [InitBasicFS, Always, TestOutputInt (
2074 [["umount"; "/dev/sda1"];
2075 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2076 InitBasicFS, Always, TestOutputInt (
2077 [["umount"; "/dev/sda1"];
2078 ["zero"; "/dev/sda1"];
2079 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2080 "run the filesystem checker",
2082 This runs the filesystem checker (fsck) on C<device> which
2083 should have filesystem type C<fstype>.
2085 The returned integer is the status. See L<fsck(8)> for the
2086 list of status codes from C<fsck>.
2094 Multiple status codes can be summed together.
2098 A non-zero return code can mean \"success\", for example if
2099 errors have been corrected on the filesystem.
2103 Checking or repairing NTFS volumes is not supported
2108 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2110 ("zero", (RErr, [String "device"]), 85, [],
2111 [InitBasicFS, Always, TestOutput (
2112 [["umount"; "/dev/sda1"];
2113 ["zero"; "/dev/sda1"];
2114 ["file"; "/dev/sda1"]], "data")],
2115 "write zeroes to the device",
2117 This command writes zeroes over the first few blocks of C<device>.
2119 How many blocks are zeroed isn't specified (but it's I<not> enough
2120 to securely wipe the device). It should be sufficient to remove
2121 any partition tables, filesystem superblocks and so on.
2123 See also: C<guestfs_scrub_device>.");
2125 ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2126 (* Test disabled because grub-install incompatible with virtio-blk driver.
2127 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2129 [InitBasicFS, Disabled, TestOutputTrue (
2130 [["grub_install"; "/"; "/dev/sda1"];
2131 ["is_dir"; "/boot"]])],
2134 This command installs GRUB (the Grand Unified Bootloader) on
2135 C<device>, with the root directory being C<root>.");
2137 ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2138 [InitBasicFS, Always, TestOutput (
2139 [["write_file"; "/old"; "file content"; "0"];
2140 ["cp"; "/old"; "/new"];
2141 ["cat"; "/new"]], "file content");
2142 InitBasicFS, Always, TestOutputTrue (
2143 [["write_file"; "/old"; "file content"; "0"];
2144 ["cp"; "/old"; "/new"];
2145 ["is_file"; "/old"]]);
2146 InitBasicFS, Always, TestOutput (
2147 [["write_file"; "/old"; "file content"; "0"];
2149 ["cp"; "/old"; "/dir/new"];
2150 ["cat"; "/dir/new"]], "file content")],
2153 This copies a file from C<src> to C<dest> where C<dest> is
2154 either a destination filename or destination directory.");
2156 ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2157 [InitBasicFS, Always, TestOutput (
2158 [["mkdir"; "/olddir"];
2159 ["mkdir"; "/newdir"];
2160 ["write_file"; "/olddir/file"; "file content"; "0"];
2161 ["cp_a"; "/olddir"; "/newdir"];
2162 ["cat"; "/newdir/olddir/file"]], "file content")],
2163 "copy a file or directory recursively",
2165 This copies a file or directory from C<src> to C<dest>
2166 recursively using the C<cp -a> command.");
2168 ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2169 [InitBasicFS, Always, TestOutput (
2170 [["write_file"; "/old"; "file content"; "0"];
2171 ["mv"; "/old"; "/new"];
2172 ["cat"; "/new"]], "file content");
2173 InitBasicFS, Always, TestOutputFalse (
2174 [["write_file"; "/old"; "file content"; "0"];
2175 ["mv"; "/old"; "/new"];
2176 ["is_file"; "/old"]])],
2179 This moves a file from C<src> to C<dest> where C<dest> is
2180 either a destination filename or destination directory.");
2182 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2183 [InitEmpty, Always, TestRun (
2184 [["drop_caches"; "3"]])],
2185 "drop kernel page cache, dentries and inodes",
2187 This instructs the guest kernel to drop its page cache,
2188 and/or dentries and inode caches. The parameter C<whattodrop>
2189 tells the kernel what precisely to drop, see
2190 L<http://linux-mm.org/Drop_Caches>
2192 Setting C<whattodrop> to 3 should drop everything.
2194 This automatically calls L<sync(2)> before the operation,
2195 so that the maximum guest memory is freed.");
2197 ("dmesg", (RString "kmsgs", []), 91, [],
2198 [InitEmpty, Always, TestRun (
2200 "return kernel messages",
2202 This returns the kernel messages (C<dmesg> output) from
2203 the guest kernel. This is sometimes useful for extended
2204 debugging of problems.
2206 Another way to get the same information is to enable
2207 verbose messages with C<guestfs_set_verbose> or by setting
2208 the environment variable C<LIBGUESTFS_DEBUG=1> before
2209 running the program.");
2211 ("ping_daemon", (RErr, []), 92, [],
2212 [InitEmpty, Always, TestRun (
2213 [["ping_daemon"]])],
2214 "ping the guest daemon",
2216 This is a test probe into the guestfs daemon running inside
2217 the qemu subprocess. Calling this function checks that the
2218 daemon responds to the ping message, without affecting the daemon
2219 or attached block device(s) in any other way.");
2221 ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2222 [InitBasicFS, Always, TestOutputTrue (
2223 [["write_file"; "/file1"; "contents of a file"; "0"];
2224 ["cp"; "/file1"; "/file2"];
2225 ["equal"; "/file1"; "/file2"]]);
2226 InitBasicFS, Always, TestOutputFalse (
2227 [["write_file"; "/file1"; "contents of a file"; "0"];
2228 ["write_file"; "/file2"; "contents of another file"; "0"];
2229 ["equal"; "/file1"; "/file2"]]);
2230 InitBasicFS, Always, TestLastFail (
2231 [["equal"; "/file1"; "/file2"]])],
2232 "test if two files have equal contents",
2234 This compares the two files C<file1> and C<file2> and returns
2235 true if their content is exactly equal, or false otherwise.
2237 The external L<cmp(1)> program is used for the comparison.");
2239 ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2240 [InitSquashFS, Always, TestOutputList (
2241 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2242 InitSquashFS, Always, TestOutputList (
2243 [["strings"; "/empty"]], [])],
2244 "print the printable strings in a file",
2246 This runs the L<strings(1)> command on a file and returns
2247 the list of printable strings found.");
2249 ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2250 [InitSquashFS, Always, TestOutputList (
2251 [["strings_e"; "b"; "/known-5"]], []);
2252 InitBasicFS, Disabled, TestOutputList (
2253 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2254 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2255 "print the printable strings in a file",
2257 This is like the C<guestfs_strings> command, but allows you to
2258 specify the encoding.
2260 See the L<strings(1)> manpage for the full list of encodings.
2262 Commonly useful encodings are C<l> (lower case L) which will
2263 show strings inside Windows/x86 files.
2265 The returned strings are transcoded to UTF-8.");
2267 ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2268 [InitSquashFS, Always, TestOutput (
2269 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2270 (* Test for RHBZ#501888c2 regression which caused large hexdump
2271 * commands to segfault.
2273 InitSquashFS, Always, TestRun (
2274 [["hexdump"; "/100krandom"]])],
2275 "dump a file in hexadecimal",
2277 This runs C<hexdump -C> on the given C<path>. The result is
2278 the human-readable, canonical hex dump of the file.");
2280 ("zerofree", (RErr, [String "device"]), 97, [],
2281 [InitNone, Always, TestOutput (
2282 [["sfdiskM"; "/dev/sda"; ","];
2283 ["mkfs"; "ext3"; "/dev/sda1"];
2284 ["mount"; "/dev/sda1"; "/"];
2285 ["write_file"; "/new"; "test file"; "0"];
2286 ["umount"; "/dev/sda1"];
2287 ["zerofree"; "/dev/sda1"];
2288 ["mount"; "/dev/sda1"; "/"];
2289 ["cat"; "/new"]], "test file")],
2290 "zero unused inodes and disk blocks on ext2/3 filesystem",
2292 This runs the I<zerofree> program on C<device>. This program
2293 claims to zero unused inodes and disk blocks on an ext2/3
2294 filesystem, thus making it possible to compress the filesystem
2297 You should B<not> run this program if the filesystem is
2300 It is possible that using this program can damage the filesystem
2301 or data on the filesystem.");
2303 ("pvresize", (RErr, [String "device"]), 98, [],
2305 "resize an LVM physical volume",
2307 This resizes (expands or shrinks) an existing LVM physical
2308 volume to match the new size of the underlying device.");
2310 ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2311 Int "cyls"; Int "heads"; Int "sectors";
2312 String "line"]), 99, [DangerWillRobinson],
2314 "modify a single partition on a block device",
2316 This runs L<sfdisk(8)> option to modify just the single
2317 partition C<n> (note: C<n> counts from 1).
2319 For other parameters, see C<guestfs_sfdisk>. You should usually
2320 pass C<0> for the cyls/heads/sectors parameters.");
2322 ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2324 "display the partition table",
2326 This displays the partition table on C<device>, in the
2327 human-readable output of the L<sfdisk(8)> command. It is
2328 not intended to be parsed.");
2330 ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2332 "display the kernel geometry",
2334 This displays the kernel's idea of the geometry of C<device>.
2336 The result is in human-readable format, and not designed to
2339 ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2341 "display the disk geometry from the partition table",
2343 This displays the disk geometry of C<device> read from the
2344 partition table. Especially in the case where the underlying
2345 block device has been resized, this can be different from the
2346 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2348 The result is in human-readable format, and not designed to
2351 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2353 "activate or deactivate all volume groups",
2355 This command activates or (if C<activate> is false) deactivates
2356 all logical volumes in all volume groups.
2357 If activated, then they are made known to the
2358 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2359 then those devices disappear.
2361 This command is the same as running C<vgchange -a y|n>");
2363 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2365 "activate or deactivate some volume groups",
2367 This command activates or (if C<activate> is false) deactivates
2368 all logical volumes in the listed volume groups C<volgroups>.
2369 If activated, then they are made known to the
2370 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2371 then those devices disappear.
2373 This command is the same as running C<vgchange -a y|n volgroups...>
2375 Note that if C<volgroups> is an empty list then B<all> volume groups
2376 are activated or deactivated.");
2378 ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2379 [InitNone, Always, TestOutput (
2380 [["sfdiskM"; "/dev/sda"; ","];
2381 ["pvcreate"; "/dev/sda1"];
2382 ["vgcreate"; "VG"; "/dev/sda1"];
2383 ["lvcreate"; "LV"; "VG"; "10"];
2384 ["mkfs"; "ext2"; "/dev/VG/LV"];
2385 ["mount"; "/dev/VG/LV"; "/"];
2386 ["write_file"; "/new"; "test content"; "0"];
2388 ["lvresize"; "/dev/VG/LV"; "20"];
2389 ["e2fsck_f"; "/dev/VG/LV"];
2390 ["resize2fs"; "/dev/VG/LV"];
2391 ["mount"; "/dev/VG/LV"; "/"];
2392 ["cat"; "/new"]], "test content")],
2393 "resize an LVM logical volume",
2395 This resizes (expands or shrinks) an existing LVM logical
2396 volume to C<mbytes>. When reducing, data in the reduced part
2399 ("resize2fs", (RErr, [String "device"]), 106, [],
2400 [], (* lvresize tests this *)
2401 "resize an ext2/ext3 filesystem",
2403 This resizes an ext2 or ext3 filesystem to match the size of
2404 the underlying device.
2406 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2407 on the C<device> before calling this command. For unknown reasons
2408 C<resize2fs> sometimes gives an error about this and sometimes not.
2409 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2410 calling this function.");
2412 ("find", (RStringList "names", [String "directory"]), 107, [],
2413 [InitBasicFS, Always, TestOutputList (
2414 [["find"; "/"]], ["lost+found"]);
2415 InitBasicFS, Always, TestOutputList (
2419 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2420 InitBasicFS, Always, TestOutputList (
2421 [["mkdir_p"; "/a/b/c"];
2422 ["touch"; "/a/b/c/d"];
2423 ["find"; "/a/b/"]], ["c"; "c/d"])],
2424 "find all files and directories",
2426 This command lists out all files and directories, recursively,
2427 starting at C<directory>. It is essentially equivalent to
2428 running the shell command C<find directory -print> but some
2429 post-processing happens on the output, described below.
2431 This returns a list of strings I<without any prefix>. Thus
2432 if the directory structure was:
2438 then the returned list from C<guestfs_find> C</tmp> would be
2446 If C<directory> is not a directory, then this command returns
2449 The returned list is sorted.");
2451 ("e2fsck_f", (RErr, [String "device"]), 108, [],
2452 [], (* lvresize tests this *)
2453 "check an ext2/ext3 filesystem",
2455 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2456 filesystem checker on C<device>, noninteractively (C<-p>),
2457 even if the filesystem appears to be clean (C<-f>).
2459 This command is only needed because of C<guestfs_resize2fs>
2460 (q.v.). Normally you should use C<guestfs_fsck>.");
2462 ("sleep", (RErr, [Int "secs"]), 109, [],
2463 [InitNone, Always, TestRun (
2465 "sleep for some seconds",
2467 Sleep for C<secs> seconds.");
2469 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2470 [InitNone, Always, TestOutputInt (
2471 [["sfdiskM"; "/dev/sda"; ","];
2472 ["mkfs"; "ntfs"; "/dev/sda1"];
2473 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2474 InitNone, Always, TestOutputInt (
2475 [["sfdiskM"; "/dev/sda"; ","];
2476 ["mkfs"; "ext2"; "/dev/sda1"];
2477 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2478 "probe NTFS volume",
2480 This command runs the L<ntfs-3g.probe(8)> command which probes
2481 an NTFS C<device> for mountability. (Not all NTFS volumes can
2482 be mounted read-write, and some cannot be mounted at all).
2484 C<rw> is a boolean flag. Set it to true if you want to test
2485 if the volume can be mounted read-write. Set it to false if
2486 you want to test if the volume can be mounted read-only.
2488 The return value is an integer which C<0> if the operation
2489 would succeed, or some non-zero value documented in the
2490 L<ntfs-3g.probe(8)> manual page.");
2492 ("sh", (RString "output", [String "command"]), 111, [],
2493 [], (* XXX needs tests *)
2494 "run a command via the shell",
2496 This call runs a command from the guest filesystem via the
2499 This is like C<guestfs_command>, but passes the command to:
2501 /bin/sh -c \"command\"
2503 Depending on the guest's shell, this usually results in
2504 wildcards being expanded, shell expressions being interpolated
2507 All the provisos about C<guestfs_command> apply to this call.");
2509 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2510 [], (* XXX needs tests *)
2511 "run a command via the shell returning lines",
2513 This is the same as C<guestfs_sh>, but splits the result
2514 into a list of lines.
2516 See also: C<guestfs_command_lines>");
2518 ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2519 [InitBasicFS, Always, TestOutputList (
2520 [["mkdir_p"; "/a/b/c"];
2521 ["touch"; "/a/b/c/d"];
2522 ["touch"; "/a/b/c/e"];
2523 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2524 InitBasicFS, Always, TestOutputList (
2525 [["mkdir_p"; "/a/b/c"];
2526 ["touch"; "/a/b/c/d"];
2527 ["touch"; "/a/b/c/e"];
2528 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2529 InitBasicFS, Always, TestOutputList (
2530 [["mkdir_p"; "/a/b/c"];
2531 ["touch"; "/a/b/c/d"];
2532 ["touch"; "/a/b/c/e"];
2533 ["glob_expand"; "/a/*/x/*"]], [])],
2534 "expand a wildcard path",
2536 This command searches for all the pathnames matching
2537 C<pattern> according to the wildcard expansion rules
2540 If no paths match, then this returns an empty list
2541 (note: not an error).
2543 It is just a wrapper around the C L<glob(3)> function
2544 with flags C<GLOB_MARK|GLOB_BRACE>.
2545 See that manual page for more details.");
2547 ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2548 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2549 [["scrub_device"; "/dev/sdc"]])],
2550 "scrub (securely wipe) a device",
2552 This command writes patterns over C<device> to make data retrieval
2555 It is an interface to the L<scrub(1)> program. See that
2556 manual page for more details.");
2558 ("scrub_file", (RErr, [String "file"]), 115, [],
2559 [InitBasicFS, Always, TestRun (
2560 [["write_file"; "/file"; "content"; "0"];
2561 ["scrub_file"; "/file"]])],
2562 "scrub (securely wipe) a file",
2564 This command writes patterns over a file to make data retrieval
2567 The file is I<removed> after scrubbing.
2569 It is an interface to the L<scrub(1)> program. See that
2570 manual page for more details.");
2572 ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2573 [], (* XXX needs testing *)
2574 "scrub (securely wipe) free space",
2576 This command creates the directory C<dir> and then fills it
2577 with files until the filesystem is full, and scrubs the files
2578 as for C<guestfs_scrub_file>, and deletes them.
2579 The intention is to scrub any free space on the partition
2582 It is an interface to the L<scrub(1)> program. See that
2583 manual page for more details.");
2585 ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2586 [InitBasicFS, Always, TestRun (
2588 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2589 "create a temporary directory",
2591 This command creates a temporary directory. The
2592 C<template> parameter should be a full pathname for the
2593 temporary directory name with the final six characters being
2596 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2597 the second one being suitable for Windows filesystems.
2599 The name of the temporary directory that was created
2602 The temporary directory is created with mode 0700
2603 and is owned by root.
2605 The caller is responsible for deleting the temporary
2606 directory and its contents after use.
2608 See also: L<mkdtemp(3)>");
2610 ("wc_l", (RInt "lines", [String "path"]), 118, [],
2611 [InitSquashFS, Always, TestOutputInt (
2612 [["wc_l"; "/10klines"]], 10000)],
2613 "count lines in a file",
2615 This command counts the lines in a file, using the
2616 C<wc -l> external command.");
2618 ("wc_w", (RInt "words", [String "path"]), 119, [],
2619 [InitSquashFS, Always, TestOutputInt (
2620 [["wc_w"; "/10klines"]], 10000)],
2621 "count words in a file",
2623 This command counts the words in a file, using the
2624 C<wc -w> external command.");
2626 ("wc_c", (RInt "chars", [String "path"]), 120, [],
2627 [InitSquashFS, Always, TestOutputInt (
2628 [["wc_c"; "/100kallspaces"]], 102400)],
2629 "count characters in a file",
2631 This command counts the characters in a file, using the
2632 C<wc -c> external command.");
2634 ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2635 [InitSquashFS, Always, TestOutputList (
2636 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2637 "return first 10 lines of a file",
2639 This command returns up to the first 10 lines of a file as
2640 a list of strings.");
2642 ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2643 [InitSquashFS, Always, TestOutputList (
2644 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2645 InitSquashFS, Always, TestOutputList (
2646 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2647 InitSquashFS, Always, TestOutputList (
2648 [["head_n"; "0"; "/10klines"]], [])],
2649 "return first N lines of a file",
2651 If the parameter C<nrlines> is a positive number, this returns the first
2652 C<nrlines> lines of the file C<path>.
2654 If the parameter C<nrlines> is a negative number, this returns lines
2655 from the file C<path>, excluding the last C<nrlines> lines.
2657 If the parameter C<nrlines> is zero, this returns an empty list.");
2659 ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2660 [InitSquashFS, Always, TestOutputList (
2661 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2662 "return last 10 lines of a file",
2664 This command returns up to the last 10 lines of a file as
2665 a list of strings.");
2667 ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2668 [InitSquashFS, Always, TestOutputList (
2669 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2670 InitSquashFS, Always, TestOutputList (
2671 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2672 InitSquashFS, Always, TestOutputList (
2673 [["tail_n"; "0"; "/10klines"]], [])],
2674 "return last N lines of a file",
2676 If the parameter C<nrlines> is a positive number, this returns the last
2677 C<nrlines> lines of the file C<path>.
2679 If the parameter C<nrlines> is a negative number, this returns lines
2680 from the file C<path>, starting with the C<-nrlines>th line.
2682 If the parameter C<nrlines> is zero, this returns an empty list.");
2684 ("df", (RString "output", []), 125, [],
2685 [], (* XXX Tricky to test because it depends on the exact format
2686 * of the 'df' command and other imponderables.
2688 "report file system disk space usage",
2690 This command runs the C<df> command to report disk space used.
2692 This command is mostly useful for interactive sessions. It
2693 is I<not> intended that you try to parse the output string.
2694 Use C<statvfs> from programs.");
2696 ("df_h", (RString "output", []), 126, [],
2697 [], (* XXX Tricky to test because it depends on the exact format
2698 * of the 'df' command and other imponderables.
2700 "report file system disk space usage (human readable)",
2702 This command runs the C<df -h> command to report disk space used
2703 in human-readable format.
2705 This command is mostly useful for interactive sessions. It
2706 is I<not> intended that you try to parse the output string.
2707 Use C<statvfs> from programs.");
2709 ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2710 [InitSquashFS, Always, TestOutputInt (
2711 [["du"; "/directory"]], 0 (* squashfs doesn't have blocks *))],
2712 "estimate file space usage",
2714 This command runs the C<du -s> command to estimate file space
2717 C<path> can be a file or a directory. If C<path> is a directory
2718 then the estimate includes the contents of the directory and all
2719 subdirectories (recursively).
2721 The result is the estimated size in I<kilobytes>
2722 (ie. units of 1024 bytes).");
2724 ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2725 [InitSquashFS, Always, TestOutputList (
2726 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2727 "list files in an initrd",
2729 This command lists out files contained in an initrd.
2731 The files are listed without any initial C</> character. The
2732 files are listed in the order they appear (not necessarily
2733 alphabetical). Directory names are listed as separate items.
2735 Old Linux kernels (2.4 and earlier) used a compressed ext2
2736 filesystem as initrd. We I<only> support the newer initramfs
2737 format (compressed cpio files).");
2739 ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2741 "mount a file using the loop device",
2743 This command lets you mount C<file> (a filesystem image
2744 in a file) on a mount point. It is entirely equivalent to
2745 the command C<mount -o loop file mountpoint>.");
2747 ("mkswap", (RErr, [String "device"]), 130, [],
2748 [InitEmpty, Always, TestRun (
2749 [["sfdiskM"; "/dev/sda"; ","];
2750 ["mkswap"; "/dev/sda1"]])],
2751 "create a swap partition",
2753 Create a swap partition on C<device>.");
2755 ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2756 [InitEmpty, Always, TestRun (
2757 [["sfdiskM"; "/dev/sda"; ","];
2758 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2759 "create a swap partition with a label",
2761 Create a swap partition on C<device> with label C<label>.
2763 Note that you cannot attach a swap label to a block device
2764 (eg. C</dev/sda>), just to a partition. This appears to be
2765 a limitation of the kernel or swap tools.");
2767 ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2768 [InitEmpty, Always, TestRun (
2769 [["sfdiskM"; "/dev/sda"; ","];
2770 ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2771 "create a swap partition with an explicit UUID",
2773 Create a swap partition on C<device> with UUID C<uuid>.");
2775 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2776 [InitBasicFS, Always, TestOutputStruct (
2777 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2778 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2779 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2780 InitBasicFS, Always, TestOutputStruct (
2781 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2782 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2783 "make block, character or FIFO devices",
2785 This call creates block or character special devices, or
2786 named pipes (FIFOs).
2788 The C<mode> parameter should be the mode, using the standard
2789 constants. C<devmajor> and C<devminor> are the
2790 device major and minor numbers, only used when creating block
2791 and character special devices.");
2793 ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2794 [InitBasicFS, Always, TestOutputStruct (
2795 [["mkfifo"; "0o777"; "/node"];
2796 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2797 "make FIFO (named pipe)",
2799 This call creates a FIFO (named pipe) called C<path> with
2800 mode C<mode>. It is just a convenient wrapper around
2801 C<guestfs_mknod>.");
2803 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2804 [InitBasicFS, Always, TestOutputStruct (
2805 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2806 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2807 "make block device node",
2809 This call creates a block device node called C<path> with
2810 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2811 It is just a convenient wrapper around C<guestfs_mknod>.");
2813 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2814 [InitBasicFS, Always, TestOutputStruct (
2815 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2816 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2817 "make char device node",
2819 This call creates a char device node called C<path> with
2820 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2821 It is just a convenient wrapper around C<guestfs_mknod>.");
2823 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2824 [], (* XXX umask is one of those stateful things that we should
2825 * reset between each test.
2827 "set file mode creation mask (umask)",
2829 This function sets the mask used for creating new files and
2830 device nodes to C<mask & 0777>.
2832 Typical umask values would be C<022> which creates new files
2833 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2834 C<002> which creates new files with permissions like
2835 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2837 The default umask is C<022>. This is important because it
2838 means that directories and device nodes will be created with
2839 C<0644> or C<0755> mode even if you specify C<0777>.
2841 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2843 This call returns the previous umask.");
2845 ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2847 "read directories entries",
2849 This returns the list of directory entries in directory C<dir>.
2851 All entries in the directory are returned, including C<.> and
2852 C<..>. The entries are I<not> sorted, but returned in the same
2853 order as the underlying filesystem.
2855 Also this call returns basic file type information about each
2856 file. The C<ftyp> field will contain one of the following characters:
2894 The L<readdir(3)> returned a C<d_type> field with an
2899 This function is primarily intended for use by programs. To
2900 get a simple list of names, use C<guestfs_ls>. To get a printable
2901 directory for human consumption, use C<guestfs_ll>.");
2903 ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2905 "create partitions on a block device",
2907 This is a simplified interface to the C<guestfs_sfdisk>
2908 command, where partition sizes are specified in megabytes
2909 only (rounded to the nearest cylinder) and you don't need
2910 to specify the cyls, heads and sectors parameters which
2911 were rarely if ever used anyway.
2913 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2915 ("zfile", (RString "description", [String "method"; String "path"]), 140, [DeprecatedBy "file"],
2917 "determine file type inside a compressed file",
2919 This command runs C<file> after first decompressing C<path>
2922 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
2924 Since 1.0.63, use C<guestfs_file> instead which can now
2925 process compressed files.");
2927 ("getxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 141, [],
2929 "list extended attributes of a file or directory",
2931 This call lists the extended attributes of the file or directory
2934 At the system call level, this is a combination of the
2935 L<listxattr(2)> and L<getxattr(2)> calls.
2937 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
2939 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [String "path"]), 142, [],
2941 "list extended attributes of a file or directory",
2943 This is the same as C<guestfs_getxattrs>, but if C<path>
2944 is a symbolic link, then it returns the extended attributes
2945 of the link itself.");
2947 ("setxattr", (RErr, [String "xattr";
2948 String "val"; Int "vallen"; (* will be BufferIn *)
2949 String "path"]), 143, [],
2951 "set extended attribute of a file or directory",
2953 This call sets the extended attribute named C<xattr>
2954 of the file C<path> to the value C<val> (of length C<vallen>).
2955 The value is arbitrary 8 bit data.
2957 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
2959 ("lsetxattr", (RErr, [String "xattr";
2960 String "val"; Int "vallen"; (* will be BufferIn *)
2961 String "path"]), 144, [],
2963 "set extended attribute of a file or directory",
2965 This is the same as C<guestfs_setxattr>, but if C<path>
2966 is a symbolic link, then it sets an extended attribute
2967 of the link itself.");
2969 ("removexattr", (RErr, [String "xattr"; String "path"]), 145, [],
2971 "remove extended attribute of a file or directory",
2973 This call removes the extended attribute named C<xattr>
2974 of the file C<path>.
2976 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
2978 ("lremovexattr", (RErr, [String "xattr"; String "path"]), 146, [],
2980 "remove extended attribute of a file or directory",
2982 This is the same as C<guestfs_removexattr>, but if C<path>
2983 is a symbolic link, then it removes an extended attribute
2984 of the link itself.");
2986 ("mountpoints", (RHashtable "mps", []), 147, [],
2990 This call is similar to C<guestfs_mounts>. That call returns
2991 a list of devices. This one returns a hash table (map) of
2992 device name to directory where the device is mounted.");
2994 ("mkmountpoint", (RErr, [String "path"]), 148, [],
2996 "create a mountpoint",
2998 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
2999 specialized calls that can be used to create extra mountpoints
3000 before mounting the first filesystem.
3002 These calls are I<only> necessary in some very limited circumstances,
3003 mainly the case where you want to mount a mix of unrelated and/or
3004 read-only filesystems together.
3006 For example, live CDs often contain a \"Russian doll\" nest of
3007 filesystems, an ISO outer layer, with a squashfs image inside, with
3008 an ext2/3 image inside that. You can unpack this as follows
3011 add-ro Fedora-11-i686-Live.iso
3014 mkmountpoint /squash
3017 mount-loop /cd/LiveOS/squashfs.img /squash
3018 mount-loop /squash/LiveOS/ext3fs.img /ext3
3020 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3022 ("rmmountpoint", (RErr, [String "path"]), 149, [],
3024 "remove a mountpoint",
3026 This calls removes a mountpoint that was previously created
3027 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3028 for full details.");
3030 ("read_file", (RBufferOut "content", [String "path"]), 150, [ProtocolLimitWarning],
3031 [InitSquashFS, Always, TestOutputBuffer (
3032 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3035 This calls returns the contents of the file C<path> as a
3038 Unlike C<guestfs_cat>, this function can correctly
3039 handle files that contain embedded ASCII NUL characters.
3040 However unlike C<guestfs_download>, this function is limited
3041 in the total size of file that can be handled.");
3043 ("grep", (RStringList "lines", [String "regex"; String "path"]), 151, [ProtocolLimitWarning],
3044 [InitSquashFS, Always, TestOutputList (
3045 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3046 InitSquashFS, Always, TestOutputList (
3047 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3048 "return lines matching a pattern",
3050 This calls the external C<grep> program and returns the
3053 ("egrep", (RStringList "lines", [String "regex"; String "path"]), 152, [ProtocolLimitWarning],
3054 [InitSquashFS, Always, TestOutputList (
3055 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3056 "return lines matching a pattern",
3058 This calls the external C<egrep> program and returns the
3061 ("fgrep", (RStringList "lines", [String "pattern"; String "path"]), 153, [ProtocolLimitWarning],
3062 [InitSquashFS, Always, TestOutputList (
3063 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3064 "return lines matching a pattern",
3066 This calls the external C<fgrep> program and returns the
3069 ("grepi", (RStringList "lines", [String "regex"; String "path"]), 154, [ProtocolLimitWarning],
3070 [InitSquashFS, Always, TestOutputList (
3071 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3072 "return lines matching a pattern",
3074 This calls the external C<grep -i> program and returns the
3077 ("egrepi", (RStringList "lines", [String "regex"; String "path"]), 155, [ProtocolLimitWarning],
3078 [InitSquashFS, Always, TestOutputList (
3079 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3080 "return lines matching a pattern",
3082 This calls the external C<egrep -i> program and returns the
3085 ("fgrepi", (RStringList "lines", [String "pattern"; String "path"]), 156, [ProtocolLimitWarning],
3086 [InitSquashFS, Always, TestOutputList (
3087 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3088 "return lines matching a pattern",
3090 This calls the external C<fgrep -i> program and returns the
3093 ("zgrep", (RStringList "lines", [String "regex"; String "path"]), 157, [ProtocolLimitWarning],
3094 [InitSquashFS, Always, TestOutputList (
3095 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3096 "return lines matching a pattern",
3098 This calls the external C<zgrep> program and returns the
3101 ("zegrep", (RStringList "lines", [String "regex"; String "path"]), 158, [ProtocolLimitWarning],
3102 [InitSquashFS, Always, TestOutputList (
3103 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3104 "return lines matching a pattern",
3106 This calls the external C<zegrep> program and returns the
3109 ("zfgrep", (RStringList "lines", [String "pattern"; String "path"]), 159, [ProtocolLimitWarning],
3110 [InitSquashFS, Always, TestOutputList (
3111 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3112 "return lines matching a pattern",
3114 This calls the external C<zfgrep> program and returns the
3117 ("zgrepi", (RStringList "lines", [String "regex"; String "path"]), 160, [ProtocolLimitWarning],
3118 [InitSquashFS, Always, TestOutputList (
3119 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3120 "return lines matching a pattern",
3122 This calls the external C<zgrep -i> program and returns the
3125 ("zegrepi", (RStringList "lines", [String "regex"; String "path"]), 161, [ProtocolLimitWarning],
3126 [InitSquashFS, Always, TestOutputList (
3127 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3128 "return lines matching a pattern",
3130 This calls the external C<zegrep -i> program and returns the
3133 ("zfgrepi", (RStringList "lines", [String "pattern"; String "path"]), 162, [ProtocolLimitWarning],
3134 [InitSquashFS, Always, TestOutputList (
3135 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3136 "return lines matching a pattern",
3138 This calls the external C<zfgrep -i> program and returns the
3141 ("realpath", (RString "rpath", [String "path"]), 163, [],
3142 [InitSquashFS, Always, TestOutput (
3143 [["realpath"; "/../directory"]], "/directory")],
3144 "canonicalized absolute pathname",
3146 Return the canonicalized absolute pathname of C<path>. The
3147 returned path has no C<.>, C<..> or symbolic link path elements.");
3149 ("ln", (RErr, [String "target"; String "linkname"]), 164, [],
3150 [InitBasicFS, Always, TestOutputStruct (
3153 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3154 "create a hard link",
3156 This command creates a hard link using the C<ln> command.");
3158 ("ln_f", (RErr, [String "target"; String "linkname"]), 165, [],
3159 [InitBasicFS, Always, TestOutputStruct (
3162 ["ln_f"; "/a"; "/b"];
3163 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3164 "create a hard link",
3166 This command creates a hard link using the C<ln -f> command.
3167 The C<-f> option removes the link (C<linkname>) if it exists already.");
3169 ("ln_s", (RErr, [String "target"; String "linkname"]), 166, [],
3170 [InitBasicFS, Always, TestOutputStruct (
3172 ["ln_s"; "a"; "/b"];
3173 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3174 "create a symbolic link",
3176 This command creates a symbolic link using the C<ln -s> command.");
3178 ("ln_sf", (RErr, [String "target"; String "linkname"]), 167, [],
3179 [InitBasicFS, Always, TestOutput (
3180 [["mkdir_p"; "/a/b"];
3181 ["touch"; "/a/b/c"];
3182 ["ln_sf"; "../d"; "/a/b/c"];
3183 ["readlink"; "/a/b/c"]], "../d")],
3184 "create a symbolic link",
3186 This command creates a symbolic link using the C<ln -sf> command,
3187 The C<-f> option removes the link (C<linkname>) if it exists already.");
3189 ("readlink", (RString "link", [String "path"]), 168, [],
3190 [] (* XXX tested above *),
3191 "read the target of a symbolic link",
3193 This command reads the target of a symbolic link.");
3195 ("fallocate", (RErr, [String "path"; Int "len"]), 169, [],
3196 [InitBasicFS, Always, TestOutputStruct (
3197 [["fallocate"; "/a"; "1000000"];
3198 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3199 "preallocate a file in the guest filesystem",
3201 This command preallocates a file (containing zero bytes) named
3202 C<path> of size C<len> bytes. If the file exists already, it
3205 Do not confuse this with the guestfish-specific
3206 C<alloc> command which allocates a file in the host and
3207 attaches it as a device.");
3209 ("swapon_device", (RErr, [String "device"]), 170, [],
3210 [InitNone, Always, TestRun (
3211 [["mkswap"; "/dev/sdb"];
3212 ["swapon_device"; "/dev/sdb"];
3213 ["swapoff_device"; "/dev/sdb"]])],
3214 "enable swap on device",
3216 This command enables the libguestfs appliance to use the
3217 swap device or partition named C<device>. The increased
3218 memory is made available for all commands, for example
3219 those run using C<guestfs_command> or C<guestfs_sh>.
3221 Note that you should not swap to existing guest swap
3222 partitions unless you know what you are doing. They may
3223 contain hibernation information, or other information that
3224 the guest doesn't want you to trash. You also risk leaking
3225 information about the host to the guest this way. Instead,
3226 attach a new host device to the guest and swap on that.");
3228 ("swapoff_device", (RErr, [String "device"]), 171, [],
3229 [], (* XXX tested by swapon_device *)
3230 "disable swap on device",
3232 This command disables the libguestfs appliance swap
3233 device or partition named C<device>.
3234 See C<guestfs_swapon_device>.");
3236 ("swapon_file", (RErr, [String "file"]), 172, [],
3237 [InitBasicFS, Always, TestRun (
3238 [["fallocate"; "/swap"; "8388608"];
3239 ["mkswap_file"; "/swap"];
3240 ["swapon_file"; "/swap"];
3241 ["swapoff_file"; "/swap"]])],
3242 "enable swap on file",
3244 This command enables swap to a file.
3245 See C<guestfs_swapon_device> for other notes.");
3247 ("swapoff_file", (RErr, [String "file"]), 173, [],
3248 [], (* XXX tested by swapon_file *)
3249 "disable swap on file",
3251 This command disables the libguestfs appliance swap on file.");
3253 ("swapon_label", (RErr, [String "label"]), 174, [],
3254 [InitEmpty, Always, TestRun (
3255 [["sfdiskM"; "/dev/sdb"; ","];
3256 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3257 ["swapon_label"; "swapit"];
3258 ["swapoff_label"; "swapit"];
3259 ["zero"; "/dev/sdb"];
3260 ["blockdev_rereadpt"; "/dev/sdb"]])],
3261 "enable swap on labelled swap partition",
3263 This command enables swap to a labelled swap partition.
3264 See C<guestfs_swapon_device> for other notes.");
3266 ("swapoff_label", (RErr, [String "label"]), 175, [],
3267 [], (* XXX tested by swapon_label *)
3268 "disable swap on labelled swap partition",
3270 This command disables the libguestfs appliance swap on
3271 labelled swap partition.");
3273 ("swapon_uuid", (RErr, [String "uuid"]), 176, [],
3274 [InitEmpty, Always, TestRun (
3275 [["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sdb"];
3276 ["swapon_uuid"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
3277 ["swapoff_uuid"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"]])],
3278 "enable swap on swap partition by UUID",
3280 This command enables swap to a swap partition with the given UUID.
3281 See C<guestfs_swapon_device> for other notes.");
3283 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [],
3284 [], (* XXX tested by swapon_uuid *)
3285 "disable swap on swap partition by UUID",
3287 This command disables the libguestfs appliance swap partition
3288 with the given UUID.");
3290 ("mkswap_file", (RErr, [String "path"]), 178, [],
3291 [InitBasicFS, Always, TestRun (
3292 [["fallocate"; "/swap"; "8388608"];
3293 ["mkswap_file"; "/swap"]])],
3294 "create a swap file",
3298 This command just writes a swap file signature to an existing
3299 file. To create the file itself, use something like C<guestfs_fallocate>.");
3301 ("inotify_init", (RErr, [Int "maxevents"]), 179, [],
3302 [InitSquashFS, Always, TestRun (
3303 [["inotify_init"; "0"]])],
3304 "create an inotify handle",
3306 This command creates a new inotify handle.
3307 The inotify subsystem can be used to notify events which happen to
3308 objects in the guest filesystem.
3310 C<maxevents> is the maximum number of events which will be
3311 queued up between calls to C<guestfs_inotify_read> or
3312 C<guestfs_inotify_files>.
3313 If this is passed as C<0>, then the kernel (or previously set)
3314 default is used. For Linux 2.6.29 the default was 16384 events.
3315 Beyond this limit, the kernel throws away events, but records
3316 the fact that it threw them away by setting a flag
3317 C<IN_Q_OVERFLOW> in the returned structure list (see
3318 C<guestfs_inotify_read>).
3320 Before any events are generated, you have to add some
3321 watches to the internal watch list. See:
3322 C<guestfs_inotify_add_watch>,
3323 C<guestfs_inotify_rm_watch> and
3324 C<guestfs_inotify_watch_all>.
3326 Queued up events should be read periodically by calling
3327 C<guestfs_inotify_read>
3328 (or C<guestfs_inotify_files> which is just a helpful
3329 wrapper around C<guestfs_inotify_read>). If you don't
3330 read the events out often enough then you risk the internal
3333 The handle should be closed after use by calling
3334 C<guestfs_inotify_close>. This also removes any
3335 watches automatically.
3337 See also L<inotify(7)> for an overview of the inotify interface
3338 as exposed by the Linux kernel, which is roughly what we expose
3339 via libguestfs. Note that there is one global inotify handle
3340 per libguestfs instance.");
3342 ("inotify_add_watch", (RInt64 "wd", [String "path"; Int "mask"]), 180, [],
3343 [InitBasicFS, Always, TestOutputList (
3344 [["inotify_init"; "0"];
3345 ["inotify_add_watch"; "/"; "1073741823"];
3348 ["inotify_files"]], ["a"; "b"])],
3349 "add an inotify watch",
3351 Watch C<path> for the events listed in C<mask>.
3353 Note that if C<path> is a directory then events within that
3354 directory are watched, but this does I<not> happen recursively
3355 (in subdirectories).
3357 Note for non-C or non-Linux callers: the inotify events are
3358 defined by the Linux kernel ABI and are listed in
3359 C</usr/include/sys/inotify.h>.");
3361 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [],
3363 "remove an inotify watch",
3365 Remove a previously defined inotify watch.
3366 See C<guestfs_inotify_add_watch>.");
3368 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [],
3370 "return list of inotify events",
3372 Return the complete queue of events that have happened
3373 since the previous read call.
3375 If no events have happened, this returns an empty list.
3377 I<Note>: In order to make sure that all events have been
3378 read, you must call this function repeatedly until it
3379 returns an empty list. The reason is that the call will
3380 read events up to the maximum appliance-to-host message
3381 size and leave remaining events in the queue.");
3383 ("inotify_files", (RStringList "paths", []), 183, [],
3385 "return list of watched files that had events",
3387 This function is a helpful wrapper around C<guestfs_inotify_read>
3388 which just returns a list of pathnames of objects that were
3389 touched. The returned pathnames are sorted and deduplicated.");
3391 ("inotify_close", (RErr, []), 184, [],
3393 "close the inotify handle",
3395 This closes the inotify handle which was previously
3396 opened by inotify_init. It removes all watches, throws
3397 away any pending events, and deallocates all resources.");
3401 let all_functions = non_daemon_functions @ daemon_functions
3403 (* In some places we want the functions to be displayed sorted
3404 * alphabetically, so this is useful:
3406 let all_functions_sorted =
3407 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3408 compare n1 n2) all_functions
3410 (* Field types for structures. *)
3412 | FChar (* C 'char' (really, a 7 bit byte). *)
3413 | FString (* nul-terminated ASCII string, NOT NULL. *)
3414 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3419 | FBytes (* Any int measure that counts bytes. *)
3420 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3421 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3423 (* Because we generate extra parsing code for LVM command line tools,
3424 * we have to pull out the LVM columns separately here.
3434 "pv_attr", FString (* XXX *);
3435 "pv_pe_count", FInt64;
3436 "pv_pe_alloc_count", FInt64;
3439 "pv_mda_count", FInt64;
3440 "pv_mda_free", FBytes;
3441 (* Not in Fedora 10:
3442 "pv_mda_size", FBytes;
3449 "vg_attr", FString (* XXX *);
3452 "vg_sysid", FString;
3453 "vg_extent_size", FBytes;
3454 "vg_extent_count", FInt64;
3455 "vg_free_count", FInt64;
3460 "snap_count", FInt64;
3463 "vg_mda_count", FInt64;
3464 "vg_mda_free", FBytes;
3465 (* Not in Fedora 10:
3466 "vg_mda_size", FBytes;
3472 "lv_attr", FString (* XXX *);
3475 "lv_kernel_major", FInt64;
3476 "lv_kernel_minor", FInt64;
3478 "seg_count", FInt64;
3480 "snap_percent", FOptPercent;
3481 "copy_percent", FOptPercent;
3484 "mirror_log", FString;
3488 (* Names and fields in all structures (in RStruct and RStructList)
3492 (* The old RIntBool return type, only ever used for aug_defnode. Do
3493 * not use this struct in any new code.
3496 "i", FInt32; (* for historical compatibility *)
3497 "b", FInt32; (* for historical compatibility *)
3500 (* LVM PVs, VGs, LVs. *)
3501 "lvm_pv", lvm_pv_cols;
3502 "lvm_vg", lvm_vg_cols;
3503 "lvm_lv", lvm_lv_cols;
3505 (* Column names and types from stat structures.
3506 * NB. Can't use things like 'st_atime' because glibc header files
3507 * define some of these as macros. Ugh.
3538 (* Column names in dirent structure. *)
3541 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3546 (* Version numbers. *)
3554 (* Extended attribute. *)
3556 "attrname", FString;
3560 (* Inotify events. *)
3564 "in_cookie", FUInt32;
3567 ] (* end of structs *)
3569 (* Ugh, Java has to be different ..
3570 * These names are also used by the Haskell bindings.
3572 let java_structs = [
3573 "int_bool", "IntBool";
3578 "statvfs", "StatVFS";
3580 "version", "Version";
3582 "inotify_event", "INotifyEvent";
3585 (* Used for testing language bindings. *)
3587 | CallString of string
3588 | CallOptString of string option
3589 | CallStringList of string list
3593 (* Used to memoize the result of pod2text. *)
3594 let pod2text_memo_filename = "src/.pod2text.data"
3595 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3597 let chan = open_in pod2text_memo_filename in
3598 let v = input_value chan in
3602 _ -> Hashtbl.create 13
3604 (* Useful functions.
3605 * Note we don't want to use any external OCaml libraries which
3606 * makes this a bit harder than it should be.
3608 let failwithf fs = ksprintf failwith fs
3610 let replace_char s c1 c2 =
3611 let s2 = String.copy s in
3612 let r = ref false in
3613 for i = 0 to String.length s2 - 1 do
3614 if String.unsafe_get s2 i = c1 then (
3615 String.unsafe_set s2 i c2;
3619 if not !r then s else s2
3623 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3625 let triml ?(test = isspace) str =
3627 let n = ref (String.length str) in
3628 while !n > 0 && test str.[!i]; do
3633 else String.sub str !i !n
3635 let trimr ?(test = isspace) str =
3636 let n = ref (String.length str) in
3637 while !n > 0 && test str.[!n-1]; do
3640 if !n = String.length str then str
3641 else String.sub str 0 !n
3643 let trim ?(test = isspace) str =
3644 trimr ~test (triml ~test str)
3646 let rec find s sub =
3647 let len = String.length s in
3648 let sublen = String.length sub in
3650 if i <= len-sublen then (
3652 if j < sublen then (
3653 if s.[i+j] = sub.[j] then loop2 (j+1)
3659 if r = -1 then loop (i+1) else r
3665 let rec replace_str s s1 s2 =
3666 let len = String.length s in
3667 let sublen = String.length s1 in
3668 let i = find s s1 in
3671 let s' = String.sub s 0 i in
3672 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3673 s' ^ s2 ^ replace_str s'' s1 s2
3676 let rec string_split sep str =
3677 let len = String.length str in
3678 let seplen = String.length sep in
3679 let i = find str sep in
3680 if i = -1 then [str]
3682 let s' = String.sub str 0 i in
3683 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3684 s' :: string_split sep s''
3687 let files_equal n1 n2 =
3688 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3689 match Sys.command cmd with
3692 | i -> failwithf "%s: failed with error code %d" cmd i
3694 let rec filter_map f = function
3698 | Some y -> y :: filter_map f xs
3699 | None -> filter_map f xs
3701 let rec find_map f = function
3702 | [] -> raise Not_found
3706 | None -> find_map f xs
3709 let rec loop i = function
3711 | x :: xs -> f i x; loop (i+1) xs
3716 let rec loop i = function
3718 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3722 let name_of_argt = function
3723 | String n | OptString n | StringList n | Bool n | Int n
3724 | FileIn n | FileOut n -> n
3726 let java_name_of_struct typ =
3727 try List.assoc typ java_structs
3730 "java_name_of_struct: no java_structs entry corresponding to %s" typ
3732 let cols_of_struct typ =
3733 try List.assoc typ structs
3735 failwithf "cols_of_struct: unknown struct %s" typ
3737 let seq_of_test = function
3738 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3739 | TestOutputListOfDevices (s, _)
3740 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
3741 | TestOutputTrue s | TestOutputFalse s
3742 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
3743 | TestOutputStruct (s, _)
3744 | TestLastFail s -> s
3746 (* Handling for function flags. *)
3747 let protocol_limit_warning =
3748 "Because of the message protocol, there is a transfer limit
3749 of somewhere between 2MB and 4MB. To transfer large files you should use
3752 let danger_will_robinson =
3753 "B<This command is dangerous. Without careful use you
3754 can easily destroy all your data>."
3756 let deprecation_notice flags =
3759 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
3761 sprintf "This function is deprecated.
3762 In new code, use the C<%s> call instead.
3764 Deprecated functions will not be removed from the API, but the
3765 fact that they are deprecated indicates that there are problems
3766 with correct use of these functions." alt in
3771 (* Check function names etc. for consistency. *)
3772 let check_functions () =
3773 let contains_uppercase str =
3774 let len = String.length str in
3776 if i >= len then false
3779 if c >= 'A' && c <= 'Z' then true
3786 (* Check function names. *)
3788 fun (name, _, _, _, _, _, _) ->
3789 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3790 failwithf "function name %s does not need 'guestfs' prefix" name;
3792 failwithf "function name is empty";
3793 if name.[0] < 'a' || name.[0] > 'z' then
3794 failwithf "function name %s must start with lowercase a-z" name;
3795 if String.contains name '-' then
3796 failwithf "function name %s should not contain '-', use '_' instead."
3800 (* Check function parameter/return names. *)
3802 fun (name, style, _, _, _, _, _) ->
3803 let check_arg_ret_name n =
3804 if contains_uppercase n then
3805 failwithf "%s param/ret %s should not contain uppercase chars"
3807 if String.contains n '-' || String.contains n '_' then
3808 failwithf "%s param/ret %s should not contain '-' or '_'"
3811 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;
3812 if n = "int" || n = "char" || n = "short" || n = "long" then
3813 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3814 if n = "i" || n = "n" then
3815 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3816 if n = "argv" || n = "args" then
3817 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3820 (match fst style with
3822 | RInt n | RInt64 n | RBool n
3823 | RConstString n | RConstOptString n | RString n
3824 | RStringList n | RStruct (n, _) | RStructList (n, _)
3825 | RHashtable n | RBufferOut n ->
3826 check_arg_ret_name n
3828 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3831 (* Check short descriptions. *)
3833 fun (name, _, _, _, _, shortdesc, _) ->
3834 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3835 failwithf "short description of %s should begin with lowercase." name;
3836 let c = shortdesc.[String.length shortdesc-1] in
3837 if c = '\n' || c = '.' then
3838 failwithf "short description of %s should not end with . or \\n." name
3841 (* Check long dscriptions. *)
3843 fun (name, _, _, _, _, _, longdesc) ->
3844 if longdesc.[String.length longdesc-1] = '\n' then
3845 failwithf "long description of %s should not end with \\n." name
3848 (* Check proc_nrs. *)
3850 fun (name, _, proc_nr, _, _, _, _) ->
3851 if proc_nr <= 0 then
3852 failwithf "daemon function %s should have proc_nr > 0" name
3856 fun (name, _, proc_nr, _, _, _, _) ->
3857 if proc_nr <> -1 then
3858 failwithf "non-daemon function %s should have proc_nr -1" name
3859 ) non_daemon_functions;
3862 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3865 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3866 let rec loop = function
3869 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3871 | (name1,nr1) :: (name2,nr2) :: _ ->
3872 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3880 (* Ignore functions that have no tests. We generate a
3881 * warning when the user does 'make check' instead.
3883 | name, _, _, _, [], _, _ -> ()
3884 | name, _, _, _, tests, _, _ ->
3888 match seq_of_test test with
3890 failwithf "%s has a test containing an empty sequence" name
3891 | cmds -> List.map List.hd cmds
3893 let funcs = List.flatten funcs in
3895 let tested = List.mem name funcs in
3898 failwithf "function %s has tests but does not test itself" name
3901 (* 'pr' prints to the current output file. *)
3902 let chan = ref stdout
3903 let pr fs = ksprintf (output_string !chan) fs
3905 (* Generate a header block in a number of standard styles. *)
3906 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3907 type license = GPLv2 | LGPLv2
3909 let generate_header comment license =
3910 let c = match comment with
3911 | CStyle -> pr "/* "; " *"
3912 | HashStyle -> pr "# "; "#"
3913 | OCamlStyle -> pr "(* "; " *"
3914 | HaskellStyle -> pr "{- "; " " in
3915 pr "libguestfs generated file\n";
3916 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3917 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3919 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3923 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3924 pr "%s it under the terms of the GNU General Public License as published by\n" c;
3925 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3926 pr "%s (at your option) any later version.\n" c;
3928 pr "%s This program is distributed in the hope that it will be useful,\n" c;
3929 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3930 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
3931 pr "%s GNU General Public License for more details.\n" c;
3933 pr "%s You should have received a copy of the GNU General Public License along\n" c;
3934 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3935 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3938 pr "%s This library is free software; you can redistribute it and/or\n" c;
3939 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3940 pr "%s License as published by the Free Software Foundation; either\n" c;
3941 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3943 pr "%s This library is distributed in the hope that it will be useful,\n" c;
3944 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3945 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
3946 pr "%s Lesser General Public License for more details.\n" c;
3948 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3949 pr "%s License along with this library; if not, write to the Free Software\n" c;
3950 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3953 | CStyle -> pr " */\n"
3955 | OCamlStyle -> pr " *)\n"
3956 | HaskellStyle -> pr "-}\n"
3960 (* Start of main code generation functions below this line. *)
3962 (* Generate the pod documentation for the C API. *)
3963 let rec generate_actions_pod () =
3965 fun (shortname, style, _, flags, _, _, longdesc) ->
3966 if not (List.mem NotInDocs flags) then (
3967 let name = "guestfs_" ^ shortname in
3968 pr "=head2 %s\n\n" name;
3970 generate_prototype ~extern:false ~handle:"handle" name style;
3972 pr "%s\n\n" longdesc;
3973 (match fst style with
3975 pr "This function returns 0 on success or -1 on error.\n\n"
3977 pr "On error this function returns -1.\n\n"
3979 pr "On error this function returns -1.\n\n"
3981 pr "This function returns a C truth value on success or -1 on error.\n\n"
3983 pr "This function returns a string, or NULL on error.
3984 The string is owned by the guest handle and must I<not> be freed.\n\n"
3985 | RConstOptString _ ->
3986 pr "This function returns a string which may be NULL.
3987 There is way to return an error from this function.
3988 The string is owned by the guest handle and must I<not> be freed.\n\n"
3990 pr "This function returns a string, or NULL on error.
3991 I<The caller must free the returned string after use>.\n\n"
3993 pr "This function returns a NULL-terminated array of strings
3994 (like L<environ(3)>), or NULL if there was an error.
3995 I<The caller must free the strings and the array after use>.\n\n"
3996 | RStruct (_, typ) ->
3997 pr "This function returns a C<struct guestfs_%s *>,
3998 or NULL if there was an error.
3999 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
4000 | RStructList (_, typ) ->
4001 pr "This function returns a C<struct guestfs_%s_list *>
4002 (see E<lt>guestfs-structs.hE<gt>),
4003 or NULL if there was an error.
4004 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4006 pr "This function returns a NULL-terminated array of
4007 strings, or NULL if there was an error.
4008 The array of strings will always have length C<2n+1>, where
4009 C<n> keys and values alternate, followed by the trailing NULL entry.
4010 I<The caller must free the strings and the array after use>.\n\n"
4012 pr "This function returns a buffer, or NULL on error.
4013 The size of the returned buffer is written to C<*size_r>.
4014 I<The caller must free the returned buffer after use>.\n\n"
4016 if List.mem ProtocolLimitWarning flags then
4017 pr "%s\n\n" protocol_limit_warning;
4018 if List.mem DangerWillRobinson flags then
4019 pr "%s\n\n" danger_will_robinson;
4020 match deprecation_notice flags with
4022 | Some txt -> pr "%s\n\n" txt
4024 ) all_functions_sorted
4026 and generate_structs_pod () =
4027 (* Structs documentation. *)
4030 pr "=head2 guestfs_%s\n" typ;
4032 pr " struct guestfs_%s {\n" typ;
4035 | name, FChar -> pr " char %s;\n" name
4036 | name, FUInt32 -> pr " uint32_t %s;\n" name
4037 | name, FInt32 -> pr " int32_t %s;\n" name
4038 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4039 | name, FInt64 -> pr " int64_t %s;\n" name
4040 | name, FString -> pr " char *%s;\n" name
4042 pr " /* The next two fields describe a byte array. */\n";
4043 pr " uint32_t %s_len;\n" name;
4044 pr " char *%s;\n" name
4046 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4047 pr " char %s[32];\n" name
4048 | name, FOptPercent ->
4049 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4050 pr " float %s;\n" name
4054 pr " struct guestfs_%s_list {\n" typ;
4055 pr " uint32_t len; /* Number of elements in list. */\n";
4056 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
4059 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
4060 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
4065 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
4066 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
4068 * We have to use an underscore instead of a dash because otherwise
4069 * rpcgen generates incorrect code.
4071 * This header is NOT exported to clients, but see also generate_structs_h.
4073 and generate_xdr () =
4074 generate_header CStyle LGPLv2;
4076 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
4077 pr "typedef string str<>;\n";
4080 (* Internal structures. *)
4084 pr "struct guestfs_int_%s {\n" typ;
4086 | name, FChar -> pr " char %s;\n" name
4087 | name, FString -> pr " string %s<>;\n" name
4088 | name, FBuffer -> pr " opaque %s<>;\n" name
4089 | name, FUUID -> pr " opaque %s[32];\n" name
4090 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
4091 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
4092 | name, FOptPercent -> pr " float %s;\n" name
4096 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
4101 fun (shortname, style, _, _, _, _, _) ->
4102 let name = "guestfs_" ^ shortname in
4104 (match snd style with
4107 pr "struct %s_args {\n" name;
4110 | String n -> pr " string %s<>;\n" n
4111 | OptString n -> pr " str *%s;\n" n
4112 | StringList n -> pr " str %s<>;\n" n
4113 | Bool n -> pr " bool %s;\n" n
4114 | Int n -> pr " int %s;\n" n
4115 | FileIn _ | FileOut _ -> ()
4119 (match fst style with
4122 pr "struct %s_ret {\n" name;
4126 pr "struct %s_ret {\n" name;
4127 pr " hyper %s;\n" n;
4130 pr "struct %s_ret {\n" name;
4133 | RConstString _ | RConstOptString _ ->
4134 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4136 pr "struct %s_ret {\n" name;
4137 pr " string %s<>;\n" n;
4140 pr "struct %s_ret {\n" name;
4141 pr " str %s<>;\n" n;
4143 | RStruct (n, typ) ->
4144 pr "struct %s_ret {\n" name;
4145 pr " guestfs_int_%s %s;\n" typ n;
4147 | RStructList (n, typ) ->
4148 pr "struct %s_ret {\n" name;
4149 pr " guestfs_int_%s_list %s;\n" typ n;
4152 pr "struct %s_ret {\n" name;
4153 pr " str %s<>;\n" n;
4156 pr "struct %s_ret {\n" name;
4157 pr " opaque %s<>;\n" n;
4162 (* Table of procedure numbers. *)
4163 pr "enum guestfs_procedure {\n";
4165 fun (shortname, _, proc_nr, _, _, _, _) ->
4166 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
4168 pr " GUESTFS_PROC_NR_PROCS\n";
4172 (* Having to choose a maximum message size is annoying for several
4173 * reasons (it limits what we can do in the API), but it (a) makes
4174 * the protocol a lot simpler, and (b) provides a bound on the size
4175 * of the daemon which operates in limited memory space. For large
4176 * file transfers you should use FTP.
4178 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
4181 (* Message header, etc. *)
4183 /* The communication protocol is now documented in the guestfs(3)
4187 const GUESTFS_PROGRAM = 0x2000F5F5;
4188 const GUESTFS_PROTOCOL_VERSION = 1;
4190 /* These constants must be larger than any possible message length. */
4191 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
4192 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
4194 enum guestfs_message_direction {
4195 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
4196 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
4199 enum guestfs_message_status {
4200 GUESTFS_STATUS_OK = 0,
4201 GUESTFS_STATUS_ERROR = 1
4204 const GUESTFS_ERROR_LEN = 256;
4206 struct guestfs_message_error {
4207 string error_message<GUESTFS_ERROR_LEN>;
4210 struct guestfs_message_header {
4211 unsigned prog; /* GUESTFS_PROGRAM */
4212 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
4213 guestfs_procedure proc; /* GUESTFS_PROC_x */
4214 guestfs_message_direction direction;
4215 unsigned serial; /* message serial number */
4216 guestfs_message_status status;
4219 const GUESTFS_MAX_CHUNK_SIZE = 8192;
4221 struct guestfs_chunk {
4222 int cancel; /* if non-zero, transfer is cancelled */
4223 /* data size is 0 bytes if the transfer has finished successfully */
4224 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
4228 (* Generate the guestfs-structs.h file. *)
4229 and generate_structs_h () =
4230 generate_header CStyle LGPLv2;
4232 (* This is a public exported header file containing various
4233 * structures. The structures are carefully written to have
4234 * exactly the same in-memory format as the XDR structures that
4235 * we use on the wire to the daemon. The reason for creating
4236 * copies of these structures here is just so we don't have to
4237 * export the whole of guestfs_protocol.h (which includes much
4238 * unrelated and XDR-dependent stuff that we don't want to be
4239 * public, or required by clients).
4241 * To reiterate, we will pass these structures to and from the
4242 * client with a simple assignment or memcpy, so the format
4243 * must be identical to what rpcgen / the RFC defines.
4246 (* Public structures. *)
4249 pr "struct guestfs_%s {\n" typ;
4252 | name, FChar -> pr " char %s;\n" name
4253 | name, FString -> pr " char *%s;\n" name
4255 pr " uint32_t %s_len;\n" name;
4256 pr " char *%s;\n" name
4257 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
4258 | name, FUInt32 -> pr " uint32_t %s;\n" name
4259 | name, FInt32 -> pr " int32_t %s;\n" name
4260 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4261 | name, FInt64 -> pr " int64_t %s;\n" name
4262 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
4266 pr "struct guestfs_%s_list {\n" typ;
4267 pr " uint32_t len;\n";
4268 pr " struct guestfs_%s *val;\n" typ;
4271 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
4272 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
4276 (* Generate the guestfs-actions.h file. *)
4277 and generate_actions_h () =
4278 generate_header CStyle LGPLv2;
4280 fun (shortname, style, _, _, _, _, _) ->
4281 let name = "guestfs_" ^ shortname in
4282 generate_prototype ~single_line:true ~newline:true ~handle:"handle"
4286 (* Generate the client-side dispatch stubs. *)
4287 and generate_client_actions () =
4288 generate_header CStyle LGPLv2;
4294 #include \"guestfs.h\"
4295 #include \"guestfs_protocol.h\"
4297 #define error guestfs_error
4298 #define perrorf guestfs_perrorf
4299 #define safe_malloc guestfs_safe_malloc
4300 #define safe_realloc guestfs_safe_realloc
4301 #define safe_strdup guestfs_safe_strdup
4302 #define safe_memdup guestfs_safe_memdup
4304 /* Check the return message from a call for validity. */
4306 check_reply_header (guestfs_h *g,
4307 const struct guestfs_message_header *hdr,
4308 int proc_nr, int serial)
4310 if (hdr->prog != GUESTFS_PROGRAM) {
4311 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
4314 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
4315 error (g, \"wrong protocol version (%%d/%%d)\",
4316 hdr->vers, GUESTFS_PROTOCOL_VERSION);
4319 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
4320 error (g, \"unexpected message direction (%%d/%%d)\",
4321 hdr->direction, GUESTFS_DIRECTION_REPLY);
4324 if (hdr->proc != proc_nr) {
4325 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
4328 if (hdr->serial != serial) {
4329 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
4336 /* Check we are in the right state to run a high-level action. */
4338 check_state (guestfs_h *g, const char *caller)
4340 if (!guestfs_is_ready (g)) {
4341 if (guestfs_is_config (g))
4342 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
4344 else if (guestfs_is_launching (g))
4345 error (g, \"%%s: call wait_ready() before using this function\",
4348 error (g, \"%%s called from the wrong state, %%d != READY\",
4349 caller, guestfs_get_state (g));
4357 (* Client-side stubs for each function. *)
4359 fun (shortname, style, _, _, _, _, _) ->
4360 let name = "guestfs_" ^ shortname in
4362 (* Generate the context struct which stores the high-level
4363 * state between callback functions.
4365 pr "struct %s_ctx {\n" shortname;
4366 pr " /* This flag is set by the callbacks, so we know we've done\n";
4367 pr " * the callbacks as expected, and in the right sequence.\n";
4368 pr " * 0 = not called, 1 = reply_cb called.\n";
4370 pr " int cb_sequence;\n";
4371 pr " struct guestfs_message_header hdr;\n";
4372 pr " struct guestfs_message_error err;\n";
4373 (match fst style with
4375 | RConstString _ | RConstOptString _ ->
4376 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4378 | RBool _ | RString _ | RStringList _
4379 | RStruct _ | RStructList _
4380 | RHashtable _ | RBufferOut _ ->
4381 pr " struct %s_ret ret;\n" name
4386 (* Generate the reply callback function. *)
4387 pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
4389 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4390 pr " struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
4392 pr " /* This should definitely not happen. */\n";
4393 pr " if (ctx->cb_sequence != 0) {\n";
4394 pr " ctx->cb_sequence = 9999;\n";
4395 pr " error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
4399 pr " ml->main_loop_quit (ml, g);\n";
4401 pr " if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
4402 pr " error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
4405 pr " if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
4406 pr " if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
4407 pr " error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
4414 (match fst style with
4416 | RConstString _ | RConstOptString _ ->
4417 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4419 | RBool _ | RString _ | RStringList _
4420 | RStruct _ | RStructList _
4421 | RHashtable _ | RBufferOut _ ->
4422 pr " if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
4423 pr " error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
4429 pr " ctx->cb_sequence = 1;\n";
4432 (* Generate the action stub. *)
4433 generate_prototype ~extern:false ~semicolon:false ~newline:true
4434 ~handle:"g" name style;
4437 match fst style with
4438 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
4439 | RConstString _ | RConstOptString _ ->
4440 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4441 | RString _ | RStringList _
4442 | RStruct _ | RStructList _
4443 | RHashtable _ | RBufferOut _ ->
4448 (match snd style with
4450 | _ -> pr " struct %s_args args;\n" name
4453 pr " struct %s_ctx ctx;\n" shortname;
4454 pr " guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
4455 pr " int serial;\n";
4457 pr " if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
4458 pr " guestfs_set_busy (g);\n";
4460 pr " memset (&ctx, 0, sizeof ctx);\n";
4463 (* Send the main header and arguments. *)
4464 (match snd style with
4466 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
4467 (String.uppercase shortname)
4472 pr " args.%s = (char *) %s;\n" n n
4474 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
4476 pr " args.%s.%s_val = (char **) %s;\n" n n n;
4477 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
4479 pr " args.%s = %s;\n" n n
4481 pr " args.%s = %s;\n" n n
4482 | FileIn _ | FileOut _ -> ()
4484 pr " serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
4485 (String.uppercase shortname);
4486 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
4489 pr " if (serial == -1) {\n";
4490 pr " guestfs_end_busy (g);\n";
4491 pr " return %s;\n" error_code;
4495 (* Send any additional files (FileIn) requested. *)
4496 let need_read_reply_label = ref false in
4503 pr " r = guestfs__send_file_sync (g, %s);\n" n;
4504 pr " if (r == -1) {\n";
4505 pr " guestfs_end_busy (g);\n";
4506 pr " return %s;\n" error_code;
4508 pr " if (r == -2) /* daemon cancelled */\n";
4509 pr " goto read_reply;\n";
4510 need_read_reply_label := true;
4516 (* Wait for the reply from the remote end. *)
4517 if !need_read_reply_label then pr " read_reply:\n";
4518 pr " guestfs__switch_to_receiving (g);\n";
4519 pr " ctx.cb_sequence = 0;\n";
4520 pr " guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
4521 pr " (void) ml->main_loop_run (ml, g);\n";
4522 pr " guestfs_set_reply_callback (g, NULL, NULL);\n";
4523 pr " if (ctx.cb_sequence != 1) {\n";
4524 pr " error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
4525 pr " guestfs_end_busy (g);\n";
4526 pr " return %s;\n" error_code;
4530 pr " if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
4531 (String.uppercase shortname);
4532 pr " guestfs_end_busy (g);\n";
4533 pr " return %s;\n" error_code;
4537 pr " if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
4538 pr " error (g, \"%%s\", ctx.err.error_message);\n";
4539 pr " free (ctx.err.error_message);\n";
4540 pr " guestfs_end_busy (g);\n";
4541 pr " return %s;\n" error_code;
4545 (* Expecting to receive further files (FileOut)? *)
4549 pr " if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
4550 pr " guestfs_end_busy (g);\n";
4551 pr " return %s;\n" error_code;
4557 pr " guestfs_end_busy (g);\n";
4559 (match fst style with
4560 | RErr -> pr " return 0;\n"
4561 | RInt n | RInt64 n | RBool n ->
4562 pr " return ctx.ret.%s;\n" n
4563 | RConstString _ | RConstOptString _ ->
4564 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4566 pr " return ctx.ret.%s; /* caller will free */\n" n
4567 | RStringList n | RHashtable n ->
4568 pr " /* caller will free this, but we need to add a NULL entry */\n";
4569 pr " ctx.ret.%s.%s_val =\n" n n;
4570 pr " safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
4571 pr " sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
4573 pr " ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
4574 pr " return ctx.ret.%s.%s_val;\n" n n
4576 pr " /* caller will free this */\n";
4577 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4578 | RStructList (n, _) ->
4579 pr " /* caller will free this */\n";
4580 pr " return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
4582 pr " *size_r = ctx.ret.%s.%s_len;\n" n n;
4583 pr " return ctx.ret.%s.%s_val; /* caller will free */\n" n n
4589 (* Functions to free structures. *)
4590 pr "/* Structure-freeing functions. These rely on the fact that the\n";
4591 pr " * structure format is identical to the XDR format. See note in\n";
4592 pr " * generator.ml.\n";
4599 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
4601 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
4607 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
4609 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
4616 (* Generate daemon/actions.h. *)
4617 and generate_daemon_actions_h () =
4618 generate_header CStyle GPLv2;
4620 pr "#include \"../src/guestfs_protocol.h\"\n";
4624 fun (name, style, _, _, _, _, _) ->
4626 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
4630 (* Generate the server-side stubs. *)
4631 and generate_daemon_actions () =
4632 generate_header CStyle GPLv2;
4634 pr "#include <config.h>\n";
4636 pr "#include <stdio.h>\n";
4637 pr "#include <stdlib.h>\n";
4638 pr "#include <string.h>\n";
4639 pr "#include <inttypes.h>\n";
4640 pr "#include <ctype.h>\n";
4641 pr "#include <rpc/types.h>\n";
4642 pr "#include <rpc/xdr.h>\n";
4644 pr "#include \"daemon.h\"\n";
4645 pr "#include \"../src/guestfs_protocol.h\"\n";
4646 pr "#include \"actions.h\"\n";
4650 fun (name, style, _, _, _, _, _) ->
4651 (* Generate server-side stubs. *)
4652 pr "static void %s_stub (XDR *xdr_in)\n" name;
4655 match fst style with
4656 | RErr | RInt _ -> pr " int r;\n"; "-1"
4657 | RInt64 _ -> pr " int64_t r;\n"; "-1"
4658 | RBool _ -> pr " int r;\n"; "-1"
4659 | RConstString _ | RConstOptString _ ->
4660 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4661 | RString _ -> pr " char *r;\n"; "NULL"
4662 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
4663 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
4664 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
4666 pr " size_t size;\n";
4670 (match snd style with
4673 pr " struct guestfs_%s_args args;\n" name;
4676 (* Note we allow the string to be writable, in order to
4677 * allow device name translation. This is safe because
4678 * we can modify the string (passed from RPC).
4681 | OptString n -> pr " char *%s;\n" n
4682 | StringList n -> pr " char **%s;\n" n
4683 | Bool n -> pr " int %s;\n" n
4684 | Int n -> pr " int %s;\n" n
4685 | FileIn _ | FileOut _ -> ()
4690 (match snd style with
4693 pr " memset (&args, 0, sizeof args);\n";
4695 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
4696 pr " reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
4701 | String n -> pr " %s = args.%s;\n" n n
4702 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
4704 pr " %s = realloc (args.%s.%s_val,\n" n n n;
4705 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
4706 pr " if (%s == NULL) {\n" n;
4707 pr " reply_with_perror (\"realloc\");\n";
4710 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
4711 pr " args.%s.%s_val = %s;\n" n n n;
4712 | Bool n -> pr " %s = args.%s;\n" n n
4713 | Int n -> pr " %s = args.%s;\n" n n
4714 | FileIn _ | FileOut _ -> ()
4719 (* Don't want to call the impl with any FileIn or FileOut
4720 * parameters, since these go "outside" the RPC protocol.
4723 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
4725 pr " r = do_%s " name;
4726 generate_c_call_args (fst style, args');
4729 pr " if (r == %s)\n" error_code;
4730 pr " /* do_%s has already called reply_with_error */\n" name;
4734 (* If there are any FileOut parameters, then the impl must
4735 * send its own reply.
4738 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
4740 pr " /* do_%s has already sent a reply */\n" name
4742 match fst style with
4743 | RErr -> pr " reply (NULL, NULL);\n"
4744 | RInt n | RInt64 n | RBool n ->
4745 pr " struct guestfs_%s_ret ret;\n" name;
4746 pr " ret.%s = r;\n" n;
4747 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4749 | RConstString _ | RConstOptString _ ->
4750 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
4752 pr " struct guestfs_%s_ret ret;\n" name;
4753 pr " ret.%s = r;\n" n;
4754 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4757 | RStringList n | RHashtable n ->
4758 pr " struct guestfs_%s_ret ret;\n" name;
4759 pr " ret.%s.%s_len = count_strings (r);\n" n n;
4760 pr " ret.%s.%s_val = r;\n" n n;
4761 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4763 pr " free_strings (r);\n"
4765 pr " struct guestfs_%s_ret ret;\n" name;
4766 pr " ret.%s = *r;\n" n;
4767 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4769 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4771 | RStructList (n, _) ->
4772 pr " struct guestfs_%s_ret ret;\n" name;
4773 pr " ret.%s = *r;\n" n;
4774 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4776 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
4779 pr " struct guestfs_%s_ret ret;\n" name;
4780 pr " ret.%s.%s_val = r;\n" n n;
4781 pr " ret.%s.%s_len = size;\n" n n;
4782 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
4787 (* Free the args. *)
4788 (match snd style with
4793 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
4800 (* Dispatch function. *)
4801 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
4803 pr " switch (proc_nr) {\n";
4806 fun (name, style, _, _, _, _, _) ->
4807 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
4808 pr " %s_stub (xdr_in);\n" name;
4813 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";
4818 (* LVM columns and tokenization functions. *)
4819 (* XXX This generates crap code. We should rethink how we
4825 pr "static const char *lvm_%s_cols = \"%s\";\n"
4826 typ (String.concat "," (List.map fst cols));
4829 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
4831 pr " char *tok, *p, *next;\n";
4835 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
4838 pr " if (!str) {\n";
4839 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
4842 pr " if (!*str || isspace (*str)) {\n";
4843 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
4848 fun (name, coltype) ->
4849 pr " if (!tok) {\n";
4850 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
4853 pr " p = strchrnul (tok, ',');\n";
4854 pr " if (*p) next = p+1; else next = NULL;\n";
4855 pr " *p = '\\0';\n";
4858 pr " r->%s = strdup (tok);\n" name;
4859 pr " if (r->%s == NULL) {\n" name;
4860 pr " perror (\"strdup\");\n";
4864 pr " for (i = j = 0; i < 32; ++j) {\n";
4865 pr " if (tok[j] == '\\0') {\n";
4866 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
4868 pr " } else if (tok[j] != '-')\n";
4869 pr " r->%s[i++] = tok[j];\n" name;
4872 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
4873 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4877 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
4878 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4882 pr " if (tok[0] == '\\0')\n";
4883 pr " r->%s = -1;\n" name;
4884 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
4885 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
4888 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
4889 assert false (* can never be an LVM column *)
4891 pr " tok = next;\n";
4894 pr " if (tok != NULL) {\n";
4895 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
4902 pr "guestfs_int_lvm_%s_list *\n" typ;
4903 pr "parse_command_line_%ss (void)\n" typ;
4905 pr " char *out, *err;\n";
4906 pr " char *p, *pend;\n";
4908 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
4909 pr " void *newp;\n";
4911 pr " ret = malloc (sizeof *ret);\n";
4912 pr " if (!ret) {\n";
4913 pr " reply_with_perror (\"malloc\");\n";
4914 pr " return NULL;\n";
4917 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
4918 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
4920 pr " r = command (&out, &err,\n";
4921 pr " \"/sbin/lvm\", \"%ss\",\n" typ;
4922 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
4923 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
4924 pr " if (r == -1) {\n";
4925 pr " reply_with_error (\"%%s\", err);\n";
4926 pr " free (out);\n";
4927 pr " free (err);\n";
4928 pr " free (ret);\n";
4929 pr " return NULL;\n";
4932 pr " free (err);\n";
4934 pr " /* Tokenize each line of the output. */\n";
4937 pr " while (p) {\n";
4938 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
4939 pr " if (pend) {\n";
4940 pr " *pend = '\\0';\n";
4944 pr " while (*p && isspace (*p)) /* Skip any leading whitespace. */\n";
4947 pr " if (!*p) { /* Empty line? Skip it. */\n";
4952 pr " /* Allocate some space to store this next entry. */\n";
4953 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
4954 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
4955 pr " if (newp == NULL) {\n";
4956 pr " reply_with_perror (\"realloc\");\n";
4957 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4958 pr " free (ret);\n";
4959 pr " free (out);\n";
4960 pr " return NULL;\n";
4962 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
4964 pr " /* Tokenize the next entry. */\n";
4965 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
4966 pr " if (r == -1) {\n";
4967 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
4968 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
4969 pr " free (ret);\n";
4970 pr " free (out);\n";
4971 pr " return NULL;\n";
4978 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
4980 pr " free (out);\n";
4981 pr " return ret;\n";
4984 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
4986 (* Generate a list of function names, for debugging in the daemon.. *)
4987 and generate_daemon_names () =
4988 generate_header CStyle GPLv2;
4990 pr "#include <config.h>\n";
4992 pr "#include \"daemon.h\"\n";
4995 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
4996 pr "const char *function_names[] = {\n";
4998 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
5002 (* Generate the tests. *)
5003 and generate_tests () =
5004 generate_header CStyle GPLv2;
5011 #include <sys/types.h>
5014 #include \"guestfs.h\"
5016 static guestfs_h *g;
5017 static int suppress_error = 0;
5019 static void print_error (guestfs_h *g, void *data, const char *msg)
5021 if (!suppress_error)
5022 fprintf (stderr, \"%%s\\n\", msg);
5025 static void print_strings (char * const * const argv)
5029 for (argc = 0; argv[argc] != NULL; ++argc)
5030 printf (\"\\t%%s\\n\", argv[argc]);
5034 static void print_table (char * const * const argv)
5038 for (i = 0; argv[i] != NULL; i += 2)
5039 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
5045 (* Generate a list of commands which are not tested anywhere. *)
5046 pr "static void no_test_warnings (void)\n";
5049 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
5051 fun (_, _, _, _, tests, _, _) ->
5052 let tests = filter_map (
5054 | (_, (Always|If _|Unless _), test) -> Some test
5055 | (_, Disabled, _) -> None
5057 let seq = List.concat (List.map seq_of_test tests) in
5058 let cmds_tested = List.map List.hd seq in
5059 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
5063 fun (name, _, _, _, _, _, _) ->
5064 if not (Hashtbl.mem hash name) then
5065 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
5071 (* Generate the actual tests. Note that we generate the tests
5072 * in reverse order, deliberately, so that (in general) the
5073 * newest tests run first. This makes it quicker and easier to
5078 fun (name, _, _, _, tests, _, _) ->
5079 mapi (generate_one_test name) tests
5080 ) (List.rev all_functions) in
5081 let test_names = List.concat test_names in
5082 let nr_tests = List.length test_names in
5085 int main (int argc, char *argv[])
5089 const char *filename;
5091 int nr_tests, test_num = 0;
5093 setbuf (stdout, NULL);
5095 no_test_warnings ();
5097 g = guestfs_create ();
5099 printf (\"guestfs_create FAILED\\n\");
5103 guestfs_set_error_handler (g, print_error, NULL);
5105 guestfs_set_path (g, \"../appliance\");
5107 filename = \"test1.img\";
5108 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5113 if (lseek (fd, %d, SEEK_SET) == -1) {
5119 if (write (fd, &c, 1) == -1) {
5125 if (close (fd) == -1) {
5130 if (guestfs_add_drive (g, filename) == -1) {
5131 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5135 filename = \"test2.img\";
5136 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5141 if (lseek (fd, %d, SEEK_SET) == -1) {
5147 if (write (fd, &c, 1) == -1) {
5153 if (close (fd) == -1) {
5158 if (guestfs_add_drive (g, filename) == -1) {
5159 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5163 filename = \"test3.img\";
5164 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
5169 if (lseek (fd, %d, SEEK_SET) == -1) {
5175 if (write (fd, &c, 1) == -1) {
5181 if (close (fd) == -1) {
5186 if (guestfs_add_drive (g, filename) == -1) {
5187 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
5191 if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
5192 printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
5196 if (guestfs_launch (g) == -1) {
5197 printf (\"guestfs_launch FAILED\\n\");
5201 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
5204 if (guestfs_wait_ready (g) == -1) {
5205 printf (\"guestfs_wait_ready FAILED\\n\");
5209 /* Cancel previous alarm. */
5214 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
5218 pr " test_num++;\n";
5219 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
5220 pr " if (%s () == -1) {\n" test_name;
5221 pr " printf (\"%s FAILED\\n\");\n" test_name;
5227 pr " guestfs_close (g);\n";
5228 pr " unlink (\"test1.img\");\n";
5229 pr " unlink (\"test2.img\");\n";
5230 pr " unlink (\"test3.img\");\n";
5233 pr " if (failed > 0) {\n";
5234 pr " printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
5242 and generate_one_test name i (init, prereq, test) =
5243 let test_name = sprintf "test_%s_%d" name i in
5246 static int %s_skip (void)
5250 str = getenv (\"TEST_ONLY\");
5252 return strstr (str, \"%s\") == NULL;
5253 str = getenv (\"SKIP_%s\");
5254 if (str && strcmp (str, \"1\") == 0) return 1;
5255 str = getenv (\"SKIP_TEST_%s\");
5256 if (str && strcmp (str, \"1\") == 0) return 1;
5260 " test_name name (String.uppercase test_name) (String.uppercase name);
5263 | Disabled | Always -> ()
5264 | If code | Unless code ->
5265 pr "static int %s_prereq (void)\n" test_name;
5273 static int %s (void)
5276 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
5280 " test_name test_name test_name;
5284 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
5286 pr " if (! %s_prereq ()) {\n" test_name;
5287 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5291 generate_one_test_body name i test_name init test;
5293 pr " if (%s_prereq ()) {\n" test_name;
5294 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
5298 generate_one_test_body name i test_name init test;
5300 generate_one_test_body name i test_name init test
5308 and generate_one_test_body name i test_name init test =
5310 | InitNone (* XXX at some point, InitNone and InitEmpty became
5311 * folded together as the same thing. Really we should
5312 * make InitNone do nothing at all, but the tests may
5313 * need to be checked to make sure this is OK.
5316 pr " /* InitNone|InitEmpty for %s */\n" test_name;
5317 List.iter (generate_test_command_call test_name)
5318 [["blockdev_setrw"; "/dev/sda"];
5322 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
5323 List.iter (generate_test_command_call test_name)
5324 [["blockdev_setrw"; "/dev/sda"];
5327 ["sfdiskM"; "/dev/sda"; ","];
5328 ["mkfs"; "ext2"; "/dev/sda1"];
5329 ["mount"; "/dev/sda1"; "/"]]
5330 | InitBasicFSonLVM ->
5331 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
5333 List.iter (generate_test_command_call test_name)
5334 [["blockdev_setrw"; "/dev/sda"];
5337 ["sfdiskM"; "/dev/sda"; ","];
5338 ["pvcreate"; "/dev/sda1"];
5339 ["vgcreate"; "VG"; "/dev/sda1"];
5340 ["lvcreate"; "LV"; "VG"; "8"];
5341 ["mkfs"; "ext2"; "/dev/VG/LV"];
5342 ["mount"; "/dev/VG/LV"; "/"]]
5344 pr " /* InitSquashFS for %s */\n" test_name;
5345 List.iter (generate_test_command_call test_name)
5346 [["blockdev_setrw"; "/dev/sda"];
5349 ["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"]]
5352 let get_seq_last = function
5354 failwithf "%s: you cannot use [] (empty list) when expecting a command"
5357 let seq = List.rev seq in
5358 List.rev (List.tl seq), List.hd seq
5363 pr " /* TestRun for %s (%d) */\n" name i;
5364 List.iter (generate_test_command_call test_name) seq
5365 | TestOutput (seq, expected) ->
5366 pr " /* TestOutput for %s (%d) */\n" name i;
5367 pr " const char *expected = \"%s\";\n" (c_quote expected);
5368 let seq, last = get_seq_last seq in
5370 pr " if (strcmp (r, expected) != 0) {\n";
5371 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5375 List.iter (generate_test_command_call test_name) seq;
5376 generate_test_command_call ~test test_name last
5377 | TestOutputList (seq, expected) ->
5378 pr " /* TestOutputList for %s (%d) */\n" name i;
5379 let seq, last = get_seq_last seq in
5383 pr " if (!r[%d]) {\n" i;
5384 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5385 pr " print_strings (r);\n";
5389 pr " const char *expected = \"%s\";\n" (c_quote str);
5390 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5391 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5396 pr " if (r[%d] != NULL) {\n" (List.length expected);
5397 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5399 pr " print_strings (r);\n";
5403 List.iter (generate_test_command_call test_name) seq;
5404 generate_test_command_call ~test test_name last
5405 | TestOutputListOfDevices (seq, expected) ->
5406 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
5407 let seq, last = get_seq_last seq in
5411 pr " if (!r[%d]) {\n" i;
5412 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
5413 pr " print_strings (r);\n";
5417 pr " const char *expected = \"%s\";\n" (c_quote str);
5418 pr " r[%d][5] = 's';\n" i;
5419 pr " if (strcmp (r[%d], expected) != 0) {\n" i;
5420 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
5425 pr " if (r[%d] != NULL) {\n" (List.length expected);
5426 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
5428 pr " print_strings (r);\n";
5432 List.iter (generate_test_command_call test_name) seq;
5433 generate_test_command_call ~test test_name last
5434 | TestOutputInt (seq, expected) ->
5435 pr " /* TestOutputInt for %s (%d) */\n" name i;
5436 let seq, last = get_seq_last seq in
5438 pr " if (r != %d) {\n" expected;
5439 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
5445 List.iter (generate_test_command_call test_name) seq;
5446 generate_test_command_call ~test test_name last
5447 | TestOutputIntOp (seq, op, expected) ->
5448 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
5449 let seq, last = get_seq_last seq in
5451 pr " if (! (r %s %d)) {\n" op expected;
5452 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
5453 test_name op expected;
5458 List.iter (generate_test_command_call test_name) seq;
5459 generate_test_command_call ~test test_name last
5460 | TestOutputTrue seq ->
5461 pr " /* TestOutputTrue for %s (%d) */\n" name i;
5462 let seq, last = get_seq_last seq in
5465 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
5470 List.iter (generate_test_command_call test_name) seq;
5471 generate_test_command_call ~test test_name last
5472 | TestOutputFalse seq ->
5473 pr " /* TestOutputFalse for %s (%d) */\n" name i;
5474 let seq, last = get_seq_last seq in
5477 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
5482 List.iter (generate_test_command_call test_name) seq;
5483 generate_test_command_call ~test test_name last
5484 | TestOutputLength (seq, expected) ->
5485 pr " /* TestOutputLength for %s (%d) */\n" name i;
5486 let seq, last = get_seq_last seq in
5489 pr " for (j = 0; j < %d; ++j)\n" expected;
5490 pr " if (r[j] == NULL) {\n";
5491 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
5493 pr " print_strings (r);\n";
5496 pr " if (r[j] != NULL) {\n";
5497 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
5499 pr " print_strings (r);\n";
5503 List.iter (generate_test_command_call test_name) seq;
5504 generate_test_command_call ~test test_name last
5505 | TestOutputBuffer (seq, expected) ->
5506 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
5507 pr " const char *expected = \"%s\";\n" (c_quote expected);
5508 let seq, last = get_seq_last seq in
5509 let len = String.length expected in
5511 pr " if (size != %d) {\n" len;
5512 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
5515 pr " if (strncmp (r, expected, size) != 0) {\n";
5516 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
5520 List.iter (generate_test_command_call test_name) seq;
5521 generate_test_command_call ~test test_name last
5522 | TestOutputStruct (seq, checks) ->
5523 pr " /* TestOutputStruct for %s (%d) */\n" name i;
5524 let seq, last = get_seq_last seq in
5528 | CompareWithInt (field, expected) ->
5529 pr " if (r->%s != %d) {\n" field expected;
5530 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
5531 test_name field expected;
5532 pr " (int) r->%s);\n" field;
5535 | CompareWithIntOp (field, op, expected) ->
5536 pr " if (!(r->%s %s %d)) {\n" field op expected;
5537 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
5538 test_name field op expected;
5539 pr " (int) r->%s);\n" field;
5542 | CompareWithString (field, expected) ->
5543 pr " if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
5544 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
5545 test_name field expected;
5546 pr " r->%s);\n" field;
5549 | CompareFieldsIntEq (field1, field2) ->
5550 pr " if (r->%s != r->%s) {\n" field1 field2;
5551 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
5552 test_name field1 field2;
5553 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
5556 | CompareFieldsStrEq (field1, field2) ->
5557 pr " if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
5558 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
5559 test_name field1 field2;
5560 pr " r->%s, r->%s);\n" field1 field2;
5565 List.iter (generate_test_command_call test_name) seq;
5566 generate_test_command_call ~test test_name last
5567 | TestLastFail seq ->
5568 pr " /* TestLastFail for %s (%d) */\n" name i;
5569 let seq, last = get_seq_last seq in
5570 List.iter (generate_test_command_call test_name) seq;
5571 generate_test_command_call test_name ~expect_error:true last
5573 (* Generate the code to run a command, leaving the result in 'r'.
5574 * If you expect to get an error then you should set expect_error:true.
5576 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
5578 | [] -> assert false
5580 (* Look up the command to find out what args/ret it has. *)
5583 let _, style, _, _, _, _, _ =
5584 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
5587 failwithf "%s: in test, command %s was not found" test_name name in
5589 if List.length (snd style) <> List.length args then
5590 failwithf "%s: in test, wrong number of args given to %s"
5597 | OptString n, "NULL" -> ()
5599 | OptString n, arg ->
5600 pr " const char *%s = \"%s\";\n" n (c_quote arg);
5603 | FileIn _, _ | FileOut _, _ -> ()
5604 | StringList n, arg ->
5605 let strs = string_split " " arg in
5608 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
5610 pr " const char *%s[] = {\n" n;
5612 fun i _ -> pr " %s_%d,\n" n i
5616 ) (List.combine (snd style) args);
5619 match fst style with
5620 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
5621 | RInt64 _ -> pr " int64_t r;\n"; "-1"
5622 | RConstString _ | RConstOptString _ ->
5623 pr " const char *r;\n"; "NULL"
5624 | RString _ -> pr " char *r;\n"; "NULL"
5625 | RStringList _ | RHashtable _ ->
5629 | RStruct (_, typ) ->
5630 pr " struct guestfs_%s *r;\n" typ; "NULL"
5631 | RStructList (_, typ) ->
5632 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
5635 pr " size_t size;\n";
5638 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
5639 pr " r = guestfs_%s (g" name;
5641 (* Generate the parameters. *)
5644 | OptString _, "NULL" -> pr ", NULL"
5648 | FileIn _, arg | FileOut _, arg ->
5649 pr ", \"%s\"" (c_quote arg)
5650 | StringList n, _ ->
5654 try int_of_string arg
5655 with Failure "int_of_string" ->
5656 failwithf "%s: expecting an int, but got '%s'" test_name arg in
5659 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
5660 ) (List.combine (snd style) args);
5662 (match fst style with
5663 | RBufferOut _ -> pr ", &size"
5669 if not expect_error then
5670 pr " if (r == %s)\n" error_code
5672 pr " if (r != %s)\n" error_code;
5675 (* Insert the test code. *)
5681 (match fst style with
5682 | RErr | RInt _ | RInt64 _ | RBool _
5683 | RConstString _ | RConstOptString _ -> ()
5684 | RString _ | RBufferOut _ -> pr " free (r);\n"
5685 | RStringList _ | RHashtable _ ->
5686 pr " for (i = 0; r[i] != NULL; ++i)\n";
5687 pr " free (r[i]);\n";
5689 | RStruct (_, typ) ->
5690 pr " guestfs_free_%s (r);\n" typ
5691 | RStructList (_, typ) ->
5692 pr " guestfs_free_%s_list (r);\n" typ
5698 let str = replace_str str "\r" "\\r" in
5699 let str = replace_str str "\n" "\\n" in
5700 let str = replace_str str "\t" "\\t" in
5701 let str = replace_str str "\000" "\\0" in
5704 (* Generate a lot of different functions for guestfish. *)
5705 and generate_fish_cmds () =
5706 generate_header CStyle GPLv2;
5710 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5712 let all_functions_sorted =
5714 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
5715 ) all_functions_sorted in
5717 pr "#include <stdio.h>\n";
5718 pr "#include <stdlib.h>\n";
5719 pr "#include <string.h>\n";
5720 pr "#include <inttypes.h>\n";
5721 pr "#include <ctype.h>\n";
5723 pr "#include <guestfs.h>\n";
5724 pr "#include \"fish.h\"\n";
5727 (* list_commands function, which implements guestfish -h *)
5728 pr "void list_commands (void)\n";
5730 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
5731 pr " list_builtin_commands ();\n";
5733 fun (name, _, _, flags, _, shortdesc, _) ->
5734 let name = replace_char name '_' '-' in
5735 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
5737 ) all_functions_sorted;
5738 pr " printf (\" %%s\\n\",";
5739 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
5743 (* display_command function, which implements guestfish -h cmd *)
5744 pr "void display_command (const char *cmd)\n";
5747 fun (name, style, _, flags, _, shortdesc, longdesc) ->
5748 let name2 = replace_char name '_' '-' in
5750 try find_map (function FishAlias n -> Some n | _ -> None) flags
5751 with Not_found -> name in
5752 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
5754 match snd style with
5758 name2 (String.concat "> <" (List.map name_of_argt args)) in
5761 if List.mem ProtocolLimitWarning flags then
5762 ("\n\n" ^ protocol_limit_warning)
5765 (* For DangerWillRobinson commands, we should probably have
5766 * guestfish prompt before allowing you to use them (especially
5767 * in interactive mode). XXX
5771 if List.mem DangerWillRobinson flags then
5772 ("\n\n" ^ danger_will_robinson)
5777 match deprecation_notice flags with
5779 | Some txt -> "\n\n" ^ txt in
5781 let describe_alias =
5782 if name <> alias then
5783 sprintf "\n\nYou can use '%s' as an alias for this command." alias
5787 pr "strcasecmp (cmd, \"%s\") == 0" name;
5788 if name <> name2 then
5789 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
5790 if name <> alias then
5791 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
5793 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
5795 (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
5798 pr " display_builtin_command (cmd);\n";
5802 (* print_* functions *)
5806 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
5808 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
5817 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
5819 pr " printf (\"%s: \");\n" name;
5820 pr " for (i = 0; i < 32; ++i)\n";
5821 pr " printf (\"%%s%%c\", indent, %s->%s[i]);\n" typ name;
5822 pr " printf (\"\\n\");\n"
5824 pr " printf (\"%%s%s: \", indent);\n" name;
5825 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
5826 pr " if (isprint (%s->%s[i]))\n" typ name;
5827 pr " printf (\"%%s%%c\", indent, %s->%s[i]);\n" typ name;
5829 pr " printf (\"%%s\\\\x%%02x\", indent, %s->%s[i]);\n" typ name;
5830 pr " printf (\"\\n\");\n"
5831 | name, (FUInt64|FBytes) ->
5832 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
5835 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
5838 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
5841 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
5844 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
5846 | name, FOptPercent ->
5847 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
5848 typ name name typ name;
5849 pr " else printf (\"%%s%s: \\n\", indent);\n" name
5853 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
5855 pr " print_%s_indent (%s, \"\");\n" typ typ;
5858 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
5863 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
5864 pr " printf (\"[%%d] = {\\n\", i);\n";
5865 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
5866 pr " printf (\"}\\n\");\n";
5872 (* run_<action> actions *)
5874 fun (name, style, _, flags, _, _, _) ->
5875 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
5877 (match fst style with
5880 | RBool _ -> pr " int r;\n"
5881 | RInt64 _ -> pr " int64_t r;\n"
5882 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
5883 | RString _ -> pr " char *r;\n"
5884 | RStringList _ | RHashtable _ -> pr " char **r;\n"
5885 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
5886 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
5889 pr " size_t size;\n";
5896 | FileOut n -> pr " const char *%s;\n" n
5897 | StringList n -> pr " char **%s;\n" n
5898 | Bool n -> pr " int %s;\n" n
5899 | Int n -> pr " int %s;\n" n
5902 (* Check and convert parameters. *)
5903 let argc_expected = List.length (snd style) in
5904 pr " if (argc != %d) {\n" argc_expected;
5905 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
5907 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
5913 | String name -> pr " %s = argv[%d];\n" name i
5915 pr " %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
5918 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
5921 pr " %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
5923 | StringList name ->
5924 pr " %s = parse_string_list (argv[%d]);\n" name i
5926 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
5928 pr " %s = atoi (argv[%d]);\n" name i
5931 (* Call C API function. *)
5933 try find_map (function FishAction n -> Some n | _ -> None) flags
5934 with Not_found -> sprintf "guestfs_%s" name in
5936 generate_c_call_args ~handle:"g" style;
5939 (* Check return value for errors and display command results. *)
5940 (match fst style with
5941 | RErr -> pr " return r;\n"
5943 pr " if (r == -1) return -1;\n";
5944 pr " printf (\"%%d\\n\", r);\n";
5947 pr " if (r == -1) return -1;\n";
5948 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
5951 pr " if (r == -1) return -1;\n";
5952 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
5955 pr " if (r == NULL) return -1;\n";
5956 pr " printf (\"%%s\\n\", r);\n";
5958 | RConstOptString _ ->
5959 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
5962 pr " if (r == NULL) return -1;\n";
5963 pr " printf (\"%%s\\n\", r);\n";
5967 pr " if (r == NULL) return -1;\n";
5968 pr " print_strings (r);\n";
5969 pr " free_strings (r);\n";
5971 | RStruct (_, typ) ->
5972 pr " if (r == NULL) return -1;\n";
5973 pr " print_%s (r);\n" typ;
5974 pr " guestfs_free_%s (r);\n" typ;
5976 | RStructList (_, typ) ->
5977 pr " if (r == NULL) return -1;\n";
5978 pr " print_%s_list (r);\n" typ;
5979 pr " guestfs_free_%s_list (r);\n" typ;
5982 pr " if (r == NULL) return -1;\n";
5983 pr " print_table (r);\n";
5984 pr " free_strings (r);\n";
5987 pr " if (r == NULL) return -1;\n";
5988 pr " fwrite (r, size, 1, stdout);\n";
5996 (* run_action function *)
5997 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
6000 fun (name, _, _, flags, _, _, _) ->
6001 let name2 = replace_char name '_' '-' in
6003 try find_map (function FishAlias n -> Some n | _ -> None) flags
6004 with Not_found -> name in
6006 pr "strcasecmp (cmd, \"%s\") == 0" name;
6007 if name <> name2 then
6008 pr " || strcasecmp (cmd, \"%s\") == 0" name2;
6009 if name <> alias then
6010 pr " || strcasecmp (cmd, \"%s\") == 0" alias;
6012 pr " return run_%s (cmd, argc, argv);\n" name;
6016 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
6023 (* Readline completion for guestfish. *)
6024 and generate_fish_completion () =
6025 generate_header CStyle GPLv2;
6029 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
6039 #ifdef HAVE_LIBREADLINE
6040 #include <readline/readline.h>
6045 #ifdef HAVE_LIBREADLINE
6047 static const char *const commands[] = {
6048 BUILTIN_COMMANDS_FOR_COMPLETION,
6051 (* Get the commands, including the aliases. They don't need to be
6052 * sorted - the generator() function just does a dumb linear search.
6056 fun (name, _, _, flags, _, _, _) ->
6057 let name2 = replace_char name '_' '-' in
6059 try find_map (function FishAlias n -> Some n | _ -> None) flags
6060 with Not_found -> name in
6062 if name <> alias then [name2; alias] else [name2]
6064 let commands = List.flatten commands in
6066 List.iter (pr " \"%s\",\n") commands;
6072 generator (const char *text, int state)
6074 static int index, len;
6079 len = strlen (text);
6082 rl_attempted_completion_over = 1;
6084 while ((name = commands[index]) != NULL) {
6086 if (strncasecmp (name, text, len) == 0)
6087 return strdup (name);
6093 #endif /* HAVE_LIBREADLINE */
6095 char **do_completion (const char *text, int start, int end)
6097 char **matches = NULL;
6099 #ifdef HAVE_LIBREADLINE
6100 rl_completion_append_character = ' ';
6103 matches = rl_completion_matches (text, generator);
6104 else if (complete_dest_paths)
6105 matches = rl_completion_matches (text, complete_dest_paths_generator);
6112 (* Generate the POD documentation for guestfish. *)
6113 and generate_fish_actions_pod () =
6114 let all_functions_sorted =
6116 fun (_, _, _, flags, _, _, _) ->
6117 not (List.mem NotInFish flags || List.mem NotInDocs flags)
6118 ) all_functions_sorted in
6120 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
6123 fun (name, style, _, flags, _, _, longdesc) ->
6125 Str.global_substitute rex (
6128 try Str.matched_group 1 s
6130 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
6131 "C<" ^ replace_char sub '_' '-' ^ ">"
6133 let name = replace_char name '_' '-' in
6135 try find_map (function FishAlias n -> Some n | _ -> None) flags
6136 with Not_found -> name in
6138 pr "=head2 %s" name;
6139 if name <> alias then
6146 | String n -> pr " %s" n
6147 | OptString n -> pr " %s" n
6148 | StringList n -> pr " '%s ...'" n
6149 | Bool _ -> pr " true|false"
6150 | Int n -> pr " %s" n
6151 | FileIn n | FileOut n -> pr " (%s|-)" n
6155 pr "%s\n\n" longdesc;
6157 if List.exists (function FileIn _ | FileOut _ -> true
6158 | _ -> false) (snd style) then
6159 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
6161 if List.mem ProtocolLimitWarning flags then
6162 pr "%s\n\n" protocol_limit_warning;
6164 if List.mem DangerWillRobinson flags then
6165 pr "%s\n\n" danger_will_robinson;
6167 match deprecation_notice flags with
6169 | Some txt -> pr "%s\n\n" txt
6170 ) all_functions_sorted
6172 (* Generate a C function prototype. *)
6173 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
6174 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
6176 ?handle name style =
6177 if extern then pr "extern ";
6178 if static then pr "static ";
6179 (match fst style with
6181 | RInt _ -> pr "int "
6182 | RInt64 _ -> pr "int64_t "
6183 | RBool _ -> pr "int "
6184 | RConstString _ | RConstOptString _ -> pr "const char *"
6185 | RString _ | RBufferOut _ -> pr "char *"
6186 | RStringList _ | RHashtable _ -> pr "char **"
6187 | RStruct (_, typ) ->
6188 if not in_daemon then pr "struct guestfs_%s *" typ
6189 else pr "guestfs_int_%s *" typ
6190 | RStructList (_, typ) ->
6191 if not in_daemon then pr "struct guestfs_%s_list *" typ
6192 else pr "guestfs_int_%s_list *" typ
6194 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
6195 pr "%s%s (" prefix name;
6196 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
6199 let comma = ref false in
6202 | Some handle -> pr "guestfs_h *%s" handle; comma := true
6206 if single_line then pr ", " else pr ",\n\t\t"
6215 if not in_daemon then pr "const char *%s" n
6216 else pr "char *%s" n
6219 if not in_daemon then pr "char * const* const %s" n
6220 else pr "char **%s" n
6221 | Bool n -> next (); pr "int %s" n
6222 | Int n -> next (); pr "int %s" n
6225 if not in_daemon then (next (); pr "const char *%s" n)
6227 if is_RBufferOut then (next (); pr "size_t *size_r");
6230 if semicolon then pr ";";
6231 if newline then pr "\n"
6233 (* Generate C call arguments, eg "(handle, foo, bar)" *)
6234 and generate_c_call_args ?handle ?(decl = false) style =
6236 let comma = ref false in
6238 if !comma then pr ", ";
6243 | Some handle -> pr "%s" handle; comma := true
6248 pr "%s" (name_of_argt arg)
6250 (* For RBufferOut calls, add implicit &size parameter. *)
6252 match fst style with
6260 (* Generate the OCaml bindings interface. *)
6261 and generate_ocaml_mli () =
6262 generate_header OCamlStyle LGPLv2;
6265 (** For API documentation you should refer to the C API
6266 in the guestfs(3) manual page. The OCaml API uses almost
6267 exactly the same calls. *)
6270 (** A [guestfs_h] handle. *)
6272 exception Error of string
6273 (** This exception is raised when there is an error. *)
6275 val create : unit -> t
6277 val close : t -> unit
6278 (** Handles are closed by the garbage collector when they become
6279 unreferenced, but callers can also call this in order to
6280 provide predictable cleanup. *)
6283 generate_ocaml_structure_decls ();
6287 fun (name, style, _, _, _, shortdesc, _) ->
6288 generate_ocaml_prototype name style;
6289 pr "(** %s *)\n" shortdesc;
6293 (* Generate the OCaml bindings implementation. *)
6294 and generate_ocaml_ml () =
6295 generate_header OCamlStyle LGPLv2;
6299 exception Error of string
6300 external create : unit -> t = \"ocaml_guestfs_create\"
6301 external close : t -> unit = \"ocaml_guestfs_close\"
6304 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
6308 generate_ocaml_structure_decls ();
6312 fun (name, style, _, _, _, shortdesc, _) ->
6313 generate_ocaml_prototype ~is_external:true name style;
6316 (* Generate the OCaml bindings C implementation. *)
6317 and generate_ocaml_c () =
6318 generate_header CStyle LGPLv2;
6325 #include <caml/config.h>
6326 #include <caml/alloc.h>
6327 #include <caml/callback.h>
6328 #include <caml/fail.h>
6329 #include <caml/memory.h>
6330 #include <caml/mlvalues.h>
6331 #include <caml/signals.h>
6333 #include <guestfs.h>
6335 #include \"guestfs_c.h\"
6337 /* Copy a hashtable of string pairs into an assoc-list. We return
6338 * the list in reverse order, but hashtables aren't supposed to be
6341 static CAMLprim value
6342 copy_table (char * const * argv)
6345 CAMLlocal5 (rv, pairv, kv, vv, cons);
6349 for (i = 0; argv[i] != NULL; i += 2) {
6350 kv = caml_copy_string (argv[i]);
6351 vv = caml_copy_string (argv[i+1]);
6352 pairv = caml_alloc (2, 0);
6353 Store_field (pairv, 0, kv);
6354 Store_field (pairv, 1, vv);
6355 cons = caml_alloc (2, 0);
6356 Store_field (cons, 1, rv);
6358 Store_field (cons, 0, pairv);
6366 (* Struct copy functions. *)
6369 let has_optpercent_col =
6370 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
6372 pr "static CAMLprim value\n";
6373 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
6375 pr " CAMLparam0 ();\n";
6376 if has_optpercent_col then
6377 pr " CAMLlocal3 (rv, v, v2);\n"
6379 pr " CAMLlocal2 (rv, v);\n";
6381 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
6386 pr " v = caml_copy_string (%s->%s);\n" typ name
6388 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
6389 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
6392 pr " v = caml_alloc_string (32);\n";
6393 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
6394 | name, (FBytes|FInt64|FUInt64) ->
6395 pr " v = caml_copy_int64 (%s->%s);\n" typ name
6396 | name, (FInt32|FUInt32) ->
6397 pr " v = caml_copy_int32 (%s->%s);\n" typ name
6398 | name, FOptPercent ->
6399 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
6400 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
6401 pr " v = caml_alloc (1, 0);\n";
6402 pr " Store_field (v, 0, v2);\n";
6403 pr " } else /* None */\n";
6404 pr " v = Val_int (0);\n";
6406 pr " v = Val_int (%s->%s);\n" typ name
6408 pr " Store_field (rv, %d, v);\n" i
6410 pr " CAMLreturn (rv);\n";
6414 pr "static CAMLprim value\n";
6415 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n"
6418 pr " CAMLparam0 ();\n";
6419 pr " CAMLlocal2 (rv, v);\n";
6422 pr " if (%ss->len == 0)\n" typ;
6423 pr " CAMLreturn (Atom (0));\n";
6425 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
6426 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
6427 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
6428 pr " caml_modify (&Field (rv, i), v);\n";
6430 pr " CAMLreturn (rv);\n";
6438 fun (name, style, _, _, _, _, _) ->
6440 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
6442 let needs_extra_vs =
6443 match fst style with RConstOptString _ -> true | _ -> false in
6445 pr "CAMLprim value\n";
6446 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
6447 List.iter (pr ", value %s") (List.tl params);
6452 | [p1; p2; p3; p4; p5] ->
6453 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
6454 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
6455 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
6456 pr " CAMLxparam%d (%s);\n"
6457 (List.length rest) (String.concat ", " rest)
6459 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
6461 if not needs_extra_vs then
6462 pr " CAMLlocal1 (rv);\n"
6464 pr " CAMLlocal3 (rv, v, v2);\n";
6467 pr " guestfs_h *g = Guestfs_val (gv);\n";
6468 pr " if (g == NULL)\n";
6469 pr " caml_failwith (\"%s: used handle after closing it\");\n" name;
6477 pr " const char *%s = String_val (%sv);\n" n n
6479 pr " const char *%s =\n" n;
6480 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
6483 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
6485 pr " int %s = Bool_val (%sv);\n" n n
6487 pr " int %s = Int_val (%sv);\n" n n
6490 match fst style with
6491 | RErr -> pr " int r;\n"; "-1"
6492 | RInt _ -> pr " int r;\n"; "-1"
6493 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6494 | RBool _ -> pr " int r;\n"; "-1"
6495 | RConstString _ | RConstOptString _ ->
6496 pr " const char *r;\n"; "NULL"
6497 | RString _ -> pr " char *r;\n"; "NULL"
6502 | RStruct (_, typ) ->
6503 pr " struct guestfs_%s *r;\n" typ; "NULL"
6504 | RStructList (_, typ) ->
6505 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
6512 pr " size_t size;\n";
6516 pr " caml_enter_blocking_section ();\n";
6517 pr " r = guestfs_%s " name;
6518 generate_c_call_args ~handle:"g" style;
6520 pr " caml_leave_blocking_section ();\n";
6525 pr " ocaml_guestfs_free_strings (%s);\n" n;
6526 | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
6529 pr " if (r == %s)\n" error_code;
6530 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
6533 (match fst style with
6534 | RErr -> pr " rv = Val_unit;\n"
6535 | RInt _ -> pr " rv = Val_int (r);\n"
6537 pr " rv = caml_copy_int64 (r);\n"
6538 | RBool _ -> pr " rv = Val_bool (r);\n"
6540 pr " rv = caml_copy_string (r);\n"
6541 | RConstOptString _ ->
6542 pr " if (r) { /* Some string */\n";
6543 pr " v = caml_alloc (1, 0);\n";
6544 pr " v2 = caml_copy_string (r);\n";
6545 pr " Store_field (v, 0, v2);\n";
6546 pr " } else /* None */\n";
6547 pr " v = Val_int (0);\n";
6549 pr " rv = caml_copy_string (r);\n";
6552 pr " rv = caml_copy_string_array ((const char **) r);\n";
6553 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6555 | RStruct (_, typ) ->
6556 pr " rv = copy_%s (r);\n" typ;
6557 pr " guestfs_free_%s (r);\n" typ;
6558 | RStructList (_, typ) ->
6559 pr " rv = copy_%s_list (r);\n" typ;
6560 pr " guestfs_free_%s_list (r);\n" typ;
6562 pr " rv = copy_table (r);\n";
6563 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
6566 pr " rv = caml_alloc_string (size);\n";
6567 pr " memcpy (String_val (rv), r, size);\n";
6570 pr " CAMLreturn (rv);\n";
6574 if List.length params > 5 then (
6575 pr "CAMLprim value\n";
6576 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
6578 pr " return ocaml_guestfs_%s (argv[0]" name;
6579 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
6586 and generate_ocaml_structure_decls () =
6589 pr "type %s = {\n" typ;
6592 | name, FString -> pr " %s : string;\n" name
6593 | name, FBuffer -> pr " %s : string;\n" name
6594 | name, FUUID -> pr " %s : string;\n" name
6595 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
6596 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
6597 | name, FChar -> pr " %s : char;\n" name
6598 | name, FOptPercent -> pr " %s : float option;\n" name
6604 and generate_ocaml_prototype ?(is_external = false) name style =
6605 if is_external then pr "external " else pr "val ";
6606 pr "%s : t -> " name;
6609 | String _ | FileIn _ | FileOut _ -> pr "string -> "
6610 | OptString _ -> pr "string option -> "
6611 | StringList _ -> pr "string array -> "
6612 | Bool _ -> pr "bool -> "
6613 | Int _ -> pr "int -> "
6615 (match fst style with
6616 | RErr -> pr "unit" (* all errors are turned into exceptions *)
6617 | RInt _ -> pr "int"
6618 | RInt64 _ -> pr "int64"
6619 | RBool _ -> pr "bool"
6620 | RConstString _ -> pr "string"
6621 | RConstOptString _ -> pr "string option"
6622 | RString _ | RBufferOut _ -> pr "string"
6623 | RStringList _ -> pr "string array"
6624 | RStruct (_, typ) -> pr "%s" typ
6625 | RStructList (_, typ) -> pr "%s array" typ
6626 | RHashtable _ -> pr "(string * string) list"
6628 if is_external then (
6630 if List.length (snd style) + 1 > 5 then
6631 pr "\"ocaml_guestfs_%s_byte\" " name;
6632 pr "\"ocaml_guestfs_%s\"" name
6636 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
6637 and generate_perl_xs () =
6638 generate_header CStyle LGPLv2;
6641 #include \"EXTERN.h\"
6645 #include <guestfs.h>
6648 #define PRId64 \"lld\"
6652 my_newSVll(long long val) {
6653 #ifdef USE_64_BIT_ALL
6654 return newSViv(val);
6658 len = snprintf(buf, 100, \"%%\" PRId64, val);
6659 return newSVpv(buf, len);
6664 #define PRIu64 \"llu\"
6668 my_newSVull(unsigned long long val) {
6669 #ifdef USE_64_BIT_ALL
6670 return newSVuv(val);
6674 len = snprintf(buf, 100, \"%%\" PRIu64, val);
6675 return newSVpv(buf, len);
6679 /* http://www.perlmonks.org/?node_id=680842 */
6681 XS_unpack_charPtrPtr (SV *arg) {
6686 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
6687 croak (\"array reference expected\");
6689 av = (AV *)SvRV (arg);
6690 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
6692 croak (\"malloc failed\");
6694 for (i = 0; i <= av_len (av); i++) {
6695 SV **elem = av_fetch (av, i, 0);
6697 if (!elem || !*elem)
6698 croak (\"missing element in list\");
6700 ret[i] = SvPV_nolen (*elem);
6708 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
6715 RETVAL = guestfs_create ();
6717 croak (\"could not create guestfs handle\");
6718 guestfs_set_error_handler (RETVAL, NULL, NULL);
6731 fun (name, style, _, _, _, _, _) ->
6732 (match fst style with
6733 | RErr -> pr "void\n"
6734 | RInt _ -> pr "SV *\n"
6735 | RInt64 _ -> pr "SV *\n"
6736 | RBool _ -> pr "SV *\n"
6737 | RConstString _ -> pr "SV *\n"
6738 | RConstOptString _ -> pr "SV *\n"
6739 | RString _ -> pr "SV *\n"
6740 | RBufferOut _ -> pr "SV *\n"
6742 | RStruct _ | RStructList _
6744 pr "void\n" (* all lists returned implictly on the stack *)
6746 (* Call and arguments. *)
6748 generate_c_call_args ~handle:"g" ~decl:true style;
6750 pr " guestfs_h *g;\n";
6754 | String n | FileIn n | FileOut n -> pr " char *%s;\n" n
6756 (* http://www.perlmonks.org/?node_id=554277
6757 * Note that the implicit handle argument means we have
6758 * to add 1 to the ST(x) operator.
6760 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
6761 | StringList n -> pr " char **%s;\n" n
6762 | Bool n -> pr " int %s;\n" n
6763 | Int n -> pr " int %s;\n" n
6766 let do_cleanups () =
6769 | String _ | OptString _ | Bool _ | Int _
6770 | FileIn _ | FileOut _ -> ()
6771 | StringList n -> pr " free (%s);\n" n
6776 (match fst style with
6781 pr " r = guestfs_%s " name;
6782 generate_c_call_args ~handle:"g" style;
6785 pr " if (r == -1)\n";
6786 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6792 pr " %s = guestfs_%s " n name;
6793 generate_c_call_args ~handle:"g" style;
6796 pr " if (%s == -1)\n" n;
6797 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6798 pr " RETVAL = newSViv (%s);\n" n;
6803 pr " int64_t %s;\n" n;
6805 pr " %s = guestfs_%s " n name;
6806 generate_c_call_args ~handle:"g" style;
6809 pr " if (%s == -1)\n" n;
6810 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6811 pr " RETVAL = my_newSVll (%s);\n" n;
6816 pr " const char *%s;\n" n;
6818 pr " %s = guestfs_%s " n name;
6819 generate_c_call_args ~handle:"g" style;
6822 pr " if (%s == NULL)\n" n;
6823 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6824 pr " RETVAL = newSVpv (%s, 0);\n" n;
6827 | RConstOptString n ->
6829 pr " const char *%s;\n" n;
6831 pr " %s = guestfs_%s " n name;
6832 generate_c_call_args ~handle:"g" style;
6835 pr " if (%s == NULL)\n" n;
6836 pr " RETVAL = &PL_sv_undef;\n";
6838 pr " RETVAL = newSVpv (%s, 0);\n" n;
6843 pr " char *%s;\n" n;
6845 pr " %s = guestfs_%s " n name;
6846 generate_c_call_args ~handle:"g" style;
6849 pr " if (%s == NULL)\n" n;
6850 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6851 pr " RETVAL = newSVpv (%s, 0);\n" n;
6852 pr " free (%s);\n" n;
6855 | RStringList n | RHashtable n ->
6857 pr " char **%s;\n" n;
6860 pr " %s = guestfs_%s " n name;
6861 generate_c_call_args ~handle:"g" style;
6864 pr " if (%s == NULL)\n" n;
6865 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6866 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
6867 pr " EXTEND (SP, n);\n";
6868 pr " for (i = 0; i < n; ++i) {\n";
6869 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
6870 pr " free (%s[i]);\n" n;
6872 pr " free (%s);\n" n;
6873 | RStruct (n, typ) ->
6874 let cols = cols_of_struct typ in
6875 generate_perl_struct_code typ cols name style n do_cleanups
6876 | RStructList (n, typ) ->
6877 let cols = cols_of_struct typ in
6878 generate_perl_struct_list_code typ cols name style n do_cleanups
6881 pr " char *%s;\n" n;
6882 pr " size_t size;\n";
6884 pr " %s = guestfs_%s " n name;
6885 generate_c_call_args ~handle:"g" style;
6888 pr " if (%s == NULL)\n" n;
6889 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6890 pr " RETVAL = newSVpv (%s, size);\n" n;
6891 pr " free (%s);\n" n;
6899 and generate_perl_struct_list_code typ cols name style n do_cleanups =
6901 pr " struct guestfs_%s_list *%s;\n" typ n;
6905 pr " %s = guestfs_%s " n name;
6906 generate_c_call_args ~handle:"g" style;
6909 pr " if (%s == NULL)\n" n;
6910 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6911 pr " EXTEND (SP, %s->len);\n" n;
6912 pr " for (i = 0; i < %s->len; ++i) {\n" n;
6913 pr " hv = newHV ();\n";
6917 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
6918 name (String.length name) n name
6920 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
6921 name (String.length name) n name
6923 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
6924 name (String.length name) n name n name
6925 | name, (FBytes|FUInt64) ->
6926 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
6927 name (String.length name) n name
6929 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
6930 name (String.length name) n name
6931 | name, (FInt32|FUInt32) ->
6932 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6933 name (String.length name) n name
6935 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
6936 name (String.length name) n name
6937 | name, FOptPercent ->
6938 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
6939 name (String.length name) n name
6941 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
6943 pr " guestfs_free_%s_list (%s);\n" typ n
6945 and generate_perl_struct_code typ cols name style n do_cleanups =
6947 pr " struct guestfs_%s *%s;\n" typ n;
6949 pr " %s = guestfs_%s " n name;
6950 generate_c_call_args ~handle:"g" style;
6953 pr " if (%s == NULL)\n" n;
6954 pr " croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
6955 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
6957 fun ((name, _) as col) ->
6958 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
6962 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
6965 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, %s->%s_len)));\n"
6968 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
6970 | name, (FBytes|FUInt64) ->
6971 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
6974 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
6976 | name, (FInt32|FUInt32) ->
6977 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6980 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
6982 | name, FOptPercent ->
6983 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
6986 pr " free (%s);\n" n
6988 (* Generate Sys/Guestfs.pm. *)
6989 and generate_perl_pm () =
6990 generate_header HashStyle LGPLv2;
6997 Sys::Guestfs - Perl bindings for libguestfs
7003 my $h = Sys::Guestfs->new ();
7004 $h->add_drive ('guest.img');
7007 $h->mount ('/dev/sda1', '/');
7008 $h->touch ('/hello');
7013 The C<Sys::Guestfs> module provides a Perl XS binding to the
7014 libguestfs API for examining and modifying virtual machine
7017 Amongst the things this is good for: making batch configuration
7018 changes to guests, getting disk used/free statistics (see also:
7019 virt-df), migrating between virtualization systems (see also:
7020 virt-p2v), performing partial backups, performing partial guest
7021 clones, cloning guests and changing registry/UUID/hostname info, and
7024 Libguestfs uses Linux kernel and qemu code, and can access any type of
7025 guest filesystem that Linux and qemu can, including but not limited
7026 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7027 schemes, qcow, qcow2, vmdk.
7029 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7030 LVs, what filesystem is in each LV, etc.). It can also run commands
7031 in the context of the guest. Also you can access filesystems over FTP.
7033 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
7034 functions for using libguestfs from Perl, including integration
7039 All errors turn into calls to C<croak> (see L<Carp(3)>).
7047 package Sys::Guestfs;
7053 XSLoader::load ('Sys::Guestfs');
7055 =item $h = Sys::Guestfs->new ();
7057 Create a new guestfs handle.
7063 my $class = ref ($proto) || $proto;
7065 my $self = Sys::Guestfs::_create ();
7066 bless $self, $class;
7072 (* Actions. We only need to print documentation for these as
7073 * they are pulled in from the XS code automatically.
7076 fun (name, style, _, flags, _, _, longdesc) ->
7077 if not (List.mem NotInDocs flags) then (
7078 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
7080 generate_perl_prototype name style;
7082 pr "%s\n\n" longdesc;
7083 if List.mem ProtocolLimitWarning flags then
7084 pr "%s\n\n" protocol_limit_warning;
7085 if List.mem DangerWillRobinson flags then
7086 pr "%s\n\n" danger_will_robinson;
7087 match deprecation_notice flags with
7089 | Some txt -> pr "%s\n\n" txt
7091 ) all_functions_sorted;
7103 Copyright (C) 2009 Red Hat Inc.
7107 Please see the file COPYING.LIB for the full license.
7113 L<http://libguestfs.org>,
7114 L<Sys::Guestfs::Lib(3)>.
7119 and generate_perl_prototype name style =
7120 (match fst style with
7128 | RBufferOut n -> pr "$%s = " n
7130 | RHashtable n -> pr "%%%s = " n
7132 | RStructList (n,_) -> pr "@%s = " n
7135 let comma = ref false in
7138 if !comma then pr ", ";
7141 | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
7148 (* Generate Python C module. *)
7149 and generate_python_c () =
7150 generate_header CStyle LGPLv2;
7159 #include \"guestfs.h\"
7167 get_handle (PyObject *obj)
7170 assert (obj != Py_None);
7171 return ((Pyguestfs_Object *) obj)->g;
7175 put_handle (guestfs_h *g)
7179 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
7182 /* This list should be freed (but not the strings) after use. */
7183 static const char **
7184 get_string_list (PyObject *obj)
7191 if (!PyList_Check (obj)) {
7192 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
7196 len = PyList_Size (obj);
7197 r = malloc (sizeof (char *) * (len+1));
7199 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
7203 for (i = 0; i < len; ++i)
7204 r[i] = PyString_AsString (PyList_GetItem (obj, i));
7211 put_string_list (char * const * const argv)
7216 for (argc = 0; argv[argc] != NULL; ++argc)
7219 list = PyList_New (argc);
7220 for (i = 0; i < argc; ++i)
7221 PyList_SetItem (list, i, PyString_FromString (argv[i]));
7227 put_table (char * const * const argv)
7229 PyObject *list, *item;
7232 for (argc = 0; argv[argc] != NULL; ++argc)
7235 list = PyList_New (argc >> 1);
7236 for (i = 0; i < argc; i += 2) {
7237 item = PyTuple_New (2);
7238 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
7239 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
7240 PyList_SetItem (list, i >> 1, item);
7247 free_strings (char **argv)
7251 for (argc = 0; argv[argc] != NULL; ++argc)
7257 py_guestfs_create (PyObject *self, PyObject *args)
7261 g = guestfs_create ();
7263 PyErr_SetString (PyExc_RuntimeError,
7264 \"guestfs.create: failed to allocate handle\");
7267 guestfs_set_error_handler (g, NULL, NULL);
7268 return put_handle (g);
7272 py_guestfs_close (PyObject *self, PyObject *args)
7277 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
7279 g = get_handle (py_g);
7283 Py_INCREF (Py_None);
7289 (* Structures, turned into Python dictionaries. *)
7292 pr "static PyObject *\n";
7293 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
7295 pr " PyObject *dict;\n";
7297 pr " dict = PyDict_New ();\n";
7301 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7302 pr " PyString_FromString (%s->%s));\n"
7305 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7306 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
7309 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7310 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
7312 | name, (FBytes|FUInt64) ->
7313 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7314 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
7317 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7318 pr " PyLong_FromLongLong (%s->%s));\n"
7321 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7322 pr " PyLong_FromUnsignedLong (%s->%s));\n"
7325 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7326 pr " PyLong_FromLong (%s->%s));\n"
7328 | name, FOptPercent ->
7329 pr " if (%s->%s >= 0)\n" typ name;
7330 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7331 pr " PyFloat_FromDouble ((double) %s->%s));\n"
7334 pr " Py_INCREF (Py_None);\n";
7335 pr " PyDict_SetItemString (dict, \"%s\", Py_None);" name;
7338 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
7339 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
7341 pr " return dict;\n";
7345 pr "static PyObject *\n";
7346 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
7348 pr " PyObject *list;\n";
7351 pr " list = PyList_New (%ss->len);\n" typ;
7352 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
7353 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
7354 pr " return list;\n";
7359 (* Python wrapper functions. *)
7361 fun (name, style, _, _, _, _, _) ->
7362 pr "static PyObject *\n";
7363 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
7366 pr " PyObject *py_g;\n";
7367 pr " guestfs_h *g;\n";
7368 pr " PyObject *py_r;\n";
7371 match fst style with
7372 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7373 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7374 | RConstString _ | RConstOptString _ ->
7375 pr " const char *r;\n"; "NULL"
7376 | RString _ -> pr " char *r;\n"; "NULL"
7377 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7378 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7379 | RStructList (_, typ) ->
7380 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7383 pr " size_t size;\n";
7388 | String n | FileIn n | FileOut n -> pr " const char *%s;\n" n
7389 | OptString n -> pr " const char *%s;\n" n
7391 pr " PyObject *py_%s;\n" n;
7392 pr " const char **%s;\n" n
7393 | Bool n -> pr " int %s;\n" n
7394 | Int n -> pr " int %s;\n" n
7399 (* Convert the parameters. *)
7400 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
7403 | String _ | FileIn _ | FileOut _ -> pr "s"
7404 | OptString _ -> pr "z"
7405 | StringList _ -> pr "O"
7406 | Bool _ -> pr "i" (* XXX Python has booleans? *)
7409 pr ":guestfs_%s\",\n" name;
7413 | String n | FileIn n | FileOut n -> pr ", &%s" n
7414 | OptString n -> pr ", &%s" n
7415 | StringList n -> pr ", &py_%s" n
7416 | Bool n -> pr ", &%s" n
7417 | Int n -> pr ", &%s" n
7421 pr " return NULL;\n";
7423 pr " g = get_handle (py_g);\n";
7426 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7428 pr " %s = get_string_list (py_%s);\n" n n;
7429 pr " if (!%s) return NULL;\n" n
7434 pr " r = guestfs_%s " name;
7435 generate_c_call_args ~handle:"g" style;
7440 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7442 pr " free (%s);\n" n
7445 pr " if (r == %s) {\n" error_code;
7446 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
7447 pr " return NULL;\n";
7451 (match fst style with
7453 pr " Py_INCREF (Py_None);\n";
7454 pr " py_r = Py_None;\n"
7456 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
7457 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
7458 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
7459 | RConstOptString _ ->
7461 pr " py_r = PyString_FromString (r);\n";
7463 pr " Py_INCREF (Py_None);\n";
7464 pr " py_r = Py_None;\n";
7467 pr " py_r = PyString_FromString (r);\n";
7470 pr " py_r = put_string_list (r);\n";
7471 pr " free_strings (r);\n"
7472 | RStruct (_, typ) ->
7473 pr " py_r = put_%s (r);\n" typ;
7474 pr " guestfs_free_%s (r);\n" typ
7475 | RStructList (_, typ) ->
7476 pr " py_r = put_%s_list (r);\n" typ;
7477 pr " guestfs_free_%s_list (r);\n" typ
7479 pr " py_r = put_table (r);\n";
7480 pr " free_strings (r);\n"
7482 pr " py_r = PyString_FromStringAndSize (r, size);\n";
7486 pr " return py_r;\n";
7491 (* Table of functions. *)
7492 pr "static PyMethodDef methods[] = {\n";
7493 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
7494 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
7496 fun (name, _, _, _, _, _, _) ->
7497 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
7500 pr " { NULL, NULL, 0, NULL }\n";
7504 (* Init function. *)
7507 initlibguestfsmod (void)
7509 static int initialized = 0;
7511 if (initialized) return;
7512 Py_InitModule ((char *) \"libguestfsmod\", methods);
7517 (* Generate Python module. *)
7518 and generate_python_py () =
7519 generate_header HashStyle LGPLv2;
7522 u\"\"\"Python bindings for libguestfs
7525 g = guestfs.GuestFS ()
7526 g.add_drive (\"guest.img\")
7529 parts = g.list_partitions ()
7531 The guestfs module provides a Python binding to the libguestfs API
7532 for examining and modifying virtual machine disk images.
7534 Amongst the things this is good for: making batch configuration
7535 changes to guests, getting disk used/free statistics (see also:
7536 virt-df), migrating between virtualization systems (see also:
7537 virt-p2v), performing partial backups, performing partial guest
7538 clones, cloning guests and changing registry/UUID/hostname info, and
7541 Libguestfs uses Linux kernel and qemu code, and can access any type of
7542 guest filesystem that Linux and qemu can, including but not limited
7543 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
7544 schemes, qcow, qcow2, vmdk.
7546 Libguestfs provides ways to enumerate guest storage (eg. partitions,
7547 LVs, what filesystem is in each LV, etc.). It can also run commands
7548 in the context of the guest. Also you can access filesystems over FTP.
7550 Errors which happen while using the API are turned into Python
7551 RuntimeError exceptions.
7553 To create a guestfs handle you usually have to perform the following
7556 # Create the handle, call add_drive at least once, and possibly
7557 # several times if the guest has multiple block devices:
7558 g = guestfs.GuestFS ()
7559 g.add_drive (\"guest.img\")
7561 # Launch the qemu subprocess and wait for it to become ready:
7565 # Now you can issue commands, for example:
7570 import libguestfsmod
7573 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
7575 def __init__ (self):
7576 \"\"\"Create a new libguestfs handle.\"\"\"
7577 self._o = libguestfsmod.create ()
7580 libguestfsmod.close (self._o)
7585 fun (name, style, _, flags, _, _, longdesc) ->
7587 generate_py_call_args ~handle:"self" (snd style);
7590 if not (List.mem NotInDocs flags) then (
7591 let doc = replace_str longdesc "C<guestfs_" "C<g." in
7593 match fst style with
7594 | RErr | RInt _ | RInt64 _ | RBool _
7595 | RConstOptString _ | RConstString _
7596 | RString _ | RBufferOut _ -> doc
7598 doc ^ "\n\nThis function returns a list of strings."
7599 | RStruct (_, typ) ->
7600 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
7601 | RStructList (_, typ) ->
7602 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
7604 doc ^ "\n\nThis function returns a dictionary." in
7606 if List.mem ProtocolLimitWarning flags then
7607 doc ^ "\n\n" ^ protocol_limit_warning
7610 if List.mem DangerWillRobinson flags then
7611 doc ^ "\n\n" ^ danger_will_robinson
7614 match deprecation_notice flags with
7616 | Some txt -> doc ^ "\n\n" ^ txt in
7617 let doc = pod2text ~width:60 name doc in
7618 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
7619 let doc = String.concat "\n " doc in
7620 pr " u\"\"\"%s\"\"\"\n" doc;
7622 pr " return libguestfsmod.%s " name;
7623 generate_py_call_args ~handle:"self._o" (snd style);
7628 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
7629 and generate_py_call_args ~handle args =
7631 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
7634 (* Useful if you need the longdesc POD text as plain text. Returns a
7637 * Because this is very slow (the slowest part of autogeneration),
7638 * we memoize the results.
7640 and pod2text ~width name longdesc =
7641 let key = width, name, longdesc in
7642 try Hashtbl.find pod2text_memo key
7644 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
7645 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
7647 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
7648 let chan = Unix.open_process_in cmd in
7649 let lines = ref [] in
7651 let line = input_line chan in
7652 if i = 1 then (* discard the first line of output *)
7655 let line = triml line in
7656 lines := line :: !lines;
7659 let lines = try loop 1 with End_of_file -> List.rev !lines in
7660 Unix.unlink filename;
7661 (match Unix.close_process_in chan with
7662 | Unix.WEXITED 0 -> ()
7664 failwithf "pod2text: process exited with non-zero status (%d)" i
7665 | Unix.WSIGNALED i | Unix.WSTOPPED i ->
7666 failwithf "pod2text: process signalled or stopped by signal %d" i
7668 Hashtbl.add pod2text_memo key lines;
7669 let chan = open_out pod2text_memo_filename in
7670 output_value chan pod2text_memo;
7674 (* Generate ruby bindings. *)
7675 and generate_ruby_c () =
7676 generate_header CStyle LGPLv2;
7684 #include \"guestfs.h\"
7686 #include \"extconf.h\"
7688 /* For Ruby < 1.9 */
7690 #define RARRAY_LEN(r) (RARRAY((r))->len)
7693 static VALUE m_guestfs; /* guestfs module */
7694 static VALUE c_guestfs; /* guestfs_h handle */
7695 static VALUE e_Error; /* used for all errors */
7697 static void ruby_guestfs_free (void *p)
7700 guestfs_close ((guestfs_h *) p);
7703 static VALUE ruby_guestfs_create (VALUE m)
7707 g = guestfs_create ();
7709 rb_raise (e_Error, \"failed to create guestfs handle\");
7711 /* Don't print error messages to stderr by default. */
7712 guestfs_set_error_handler (g, NULL, NULL);
7714 /* Wrap it, and make sure the close function is called when the
7717 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
7720 static VALUE ruby_guestfs_close (VALUE gv)
7723 Data_Get_Struct (gv, guestfs_h, g);
7725 ruby_guestfs_free (g);
7726 DATA_PTR (gv) = NULL;
7734 fun (name, style, _, _, _, _, _) ->
7735 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
7736 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
7739 pr " guestfs_h *g;\n";
7740 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
7742 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
7748 | String n | FileIn n | FileOut n ->
7749 pr " Check_Type (%sv, T_STRING);\n" n;
7750 pr " const char *%s = StringValueCStr (%sv);\n" n n;
7752 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
7753 pr " \"%s\", \"%s\");\n" n name
7755 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
7757 pr " char **%s;\n" n;
7758 pr " Check_Type (%sv, T_ARRAY);\n" n;
7760 pr " int i, len;\n";
7761 pr " len = RARRAY_LEN (%sv);\n" n;
7762 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
7764 pr " for (i = 0; i < len; ++i) {\n";
7765 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
7766 pr " %s[i] = StringValueCStr (v);\n" n;
7768 pr " %s[len] = NULL;\n" n;
7771 pr " int %s = RTEST (%sv);\n" n n
7773 pr " int %s = NUM2INT (%sv);\n" n n
7778 match fst style with
7779 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7780 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7781 | RConstString _ | RConstOptString _ ->
7782 pr " const char *r;\n"; "NULL"
7783 | RString _ -> pr " char *r;\n"; "NULL"
7784 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
7785 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
7786 | RStructList (_, typ) ->
7787 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7790 pr " size_t size;\n";
7794 pr " r = guestfs_%s " name;
7795 generate_c_call_args ~handle:"g" style;
7800 | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
7802 pr " free (%s);\n" n
7805 pr " if (r == %s)\n" error_code;
7806 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
7809 (match fst style with
7811 pr " return Qnil;\n"
7812 | RInt _ | RBool _ ->
7813 pr " return INT2NUM (r);\n"
7815 pr " return ULL2NUM (r);\n"
7817 pr " return rb_str_new2 (r);\n";
7818 | RConstOptString _ ->
7820 pr " return rb_str_new2 (r);\n";
7822 pr " return Qnil;\n";
7824 pr " VALUE rv = rb_str_new2 (r);\n";
7828 pr " int i, len = 0;\n";
7829 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
7830 pr " VALUE rv = rb_ary_new2 (len);\n";
7831 pr " for (i = 0; r[i] != NULL; ++i) {\n";
7832 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
7833 pr " free (r[i]);\n";
7837 | RStruct (_, typ) ->
7838 let cols = cols_of_struct typ in
7839 generate_ruby_struct_code typ cols
7840 | RStructList (_, typ) ->
7841 let cols = cols_of_struct typ in
7842 generate_ruby_struct_list_code typ cols
7844 pr " VALUE rv = rb_hash_new ();\n";
7846 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
7847 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
7848 pr " free (r[i]);\n";
7849 pr " free (r[i+1]);\n";
7854 pr " VALUE rv = rb_str_new (r, size);\n";
7864 /* Initialize the module. */
7865 void Init__guestfs ()
7867 m_guestfs = rb_define_module (\"Guestfs\");
7868 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
7869 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
7871 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
7872 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
7875 (* Define the rest of the methods. *)
7877 fun (name, style, _, _, _, _, _) ->
7878 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
7879 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
7884 (* Ruby code to return a struct. *)
7885 and generate_ruby_struct_code typ cols =
7886 pr " VALUE rv = rb_hash_new ();\n";
7890 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
7892 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
7894 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
7895 | name, (FBytes|FUInt64) ->
7896 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7898 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
7900 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
7902 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
7903 | name, FOptPercent ->
7904 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
7905 | name, FChar -> (* XXX wrong? *)
7906 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
7908 pr " guestfs_free_%s (r);\n" typ;
7911 (* Ruby code to return a struct list. *)
7912 and generate_ruby_struct_list_code typ cols =
7913 pr " VALUE rv = rb_ary_new2 (r->len);\n";
7915 pr " for (i = 0; i < r->len; ++i) {\n";
7916 pr " VALUE hv = rb_hash_new ();\n";
7920 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
7922 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
7924 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
7925 | name, (FBytes|FUInt64) ->
7926 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7928 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
7930 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
7932 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
7933 | name, FOptPercent ->
7934 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
7935 | name, FChar -> (* XXX wrong? *)
7936 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
7938 pr " rb_ary_push (rv, hv);\n";
7940 pr " guestfs_free_%s_list (r);\n" typ;
7943 (* Generate Java bindings GuestFS.java file. *)
7944 and generate_java_java () =
7945 generate_header CStyle LGPLv2;
7948 package com.redhat.et.libguestfs;
7950 import java.util.HashMap;
7951 import com.redhat.et.libguestfs.LibGuestFSException;
7952 import com.redhat.et.libguestfs.PV;
7953 import com.redhat.et.libguestfs.VG;
7954 import com.redhat.et.libguestfs.LV;
7955 import com.redhat.et.libguestfs.Stat;
7956 import com.redhat.et.libguestfs.StatVFS;
7957 import com.redhat.et.libguestfs.IntBool;
7958 import com.redhat.et.libguestfs.Dirent;
7961 * The GuestFS object is a libguestfs handle.
7965 public class GuestFS {
7966 // Load the native code.
7968 System.loadLibrary (\"guestfs_jni\");
7972 * The native guestfs_h pointer.
7977 * Create a libguestfs handle.
7979 * @throws LibGuestFSException
7981 public GuestFS () throws LibGuestFSException
7985 private native long _create () throws LibGuestFSException;
7988 * Close a libguestfs handle.
7990 * You can also leave handles to be collected by the garbage
7991 * collector, but this method ensures that the resources used
7992 * by the handle are freed up immediately. If you call any
7993 * other methods after closing the handle, you will get an
7996 * @throws LibGuestFSException
7998 public void close () throws LibGuestFSException
8004 private native void _close (long g) throws LibGuestFSException;
8006 public void finalize () throws LibGuestFSException
8014 fun (name, style, _, flags, _, shortdesc, longdesc) ->
8015 if not (List.mem NotInDocs flags); then (
8016 let doc = replace_str longdesc "C<guestfs_" "C<g." in
8018 if List.mem ProtocolLimitWarning flags then
8019 doc ^ "\n\n" ^ protocol_limit_warning
8022 if List.mem DangerWillRobinson flags then
8023 doc ^ "\n\n" ^ danger_will_robinson
8026 match deprecation_notice flags with
8028 | Some txt -> doc ^ "\n\n" ^ txt in
8029 let doc = pod2text ~width:60 name doc in
8030 let doc = List.map ( (* RHBZ#501883 *)
8033 | nonempty -> nonempty
8035 let doc = String.concat "\n * " doc in
8038 pr " * %s\n" shortdesc;
8041 pr " * @throws LibGuestFSException\n";
8045 generate_java_prototype ~public:true ~semicolon:false name style;
8048 pr " if (g == 0)\n";
8049 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
8052 if fst style <> RErr then pr "return ";
8054 generate_java_call_args ~handle:"g" (snd style);
8058 generate_java_prototype ~privat:true ~native:true name style;
8065 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
8066 and generate_java_call_args ~handle args =
8068 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
8071 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
8072 ?(semicolon=true) name style =
8073 if privat then pr "private ";
8074 if public then pr "public ";
8075 if native then pr "native ";
8078 (match fst style with
8079 | RErr -> pr "void ";
8080 | RInt _ -> pr "int ";
8081 | RInt64 _ -> pr "long ";
8082 | RBool _ -> pr "boolean ";
8083 | RConstString _ | RConstOptString _ | RString _
8084 | RBufferOut _ -> pr "String ";
8085 | RStringList _ -> pr "String[] ";
8086 | RStruct (_, typ) ->
8087 let name = java_name_of_struct typ in
8089 | RStructList (_, typ) ->
8090 let name = java_name_of_struct typ in
8092 | RHashtable _ -> pr "HashMap<String,String> ";
8095 if native then pr "_%s " name else pr "%s " name;
8097 let needs_comma = ref false in
8106 if !needs_comma then pr ", ";
8107 needs_comma := true;
8124 pr " throws LibGuestFSException";
8125 if semicolon then pr ";"
8127 and generate_java_struct jtyp cols =
8128 generate_header CStyle LGPLv2;
8131 package com.redhat.et.libguestfs;
8134 * Libguestfs %s structure.
8146 | name, FBuffer -> pr " public String %s;\n" name
8147 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
8148 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
8149 | name, FChar -> pr " public char %s;\n" name
8150 | name, FOptPercent ->
8151 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
8152 pr " public float %s;\n" name
8157 and generate_java_c () =
8158 generate_header CStyle LGPLv2;
8165 #include \"com_redhat_et_libguestfs_GuestFS.h\"
8166 #include \"guestfs.h\"
8168 /* Note that this function returns. The exception is not thrown
8169 * until after the wrapper function returns.
8172 throw_exception (JNIEnv *env, const char *msg)
8175 cl = (*env)->FindClass (env,
8176 \"com/redhat/et/libguestfs/LibGuestFSException\");
8177 (*env)->ThrowNew (env, cl, msg);
8180 JNIEXPORT jlong JNICALL
8181 Java_com_redhat_et_libguestfs_GuestFS__1create
8182 (JNIEnv *env, jobject obj)
8186 g = guestfs_create ();
8188 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
8191 guestfs_set_error_handler (g, NULL, NULL);
8192 return (jlong) (long) g;
8195 JNIEXPORT void JNICALL
8196 Java_com_redhat_et_libguestfs_GuestFS__1close
8197 (JNIEnv *env, jobject obj, jlong jg)
8199 guestfs_h *g = (guestfs_h *) (long) jg;
8206 fun (name, style, _, _, _, _, _) ->
8208 (match fst style with
8209 | RErr -> pr "void ";
8210 | RInt _ -> pr "jint ";
8211 | RInt64 _ -> pr "jlong ";
8212 | RBool _ -> pr "jboolean ";
8213 | RConstString _ | RConstOptString _ | RString _
8214 | RBufferOut _ -> pr "jstring ";
8215 | RStruct _ | RHashtable _ ->
8217 | RStringList _ | RStructList _ ->
8221 pr "Java_com_redhat_et_libguestfs_GuestFS_";
8222 pr "%s" (replace_str ("_" ^ name) "_" "_1");
8224 pr " (JNIEnv *env, jobject obj, jlong jg";
8231 pr ", jstring j%s" n
8233 pr ", jobjectArray j%s" n
8235 pr ", jboolean j%s" n
8241 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
8242 let error_code, no_ret =
8243 match fst style with
8244 | RErr -> pr " int r;\n"; "-1", ""
8246 | RInt _ -> pr " int r;\n"; "-1", "0"
8247 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
8248 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
8249 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
8251 pr " jstring jr;\n";
8252 pr " char *r;\n"; "NULL", "NULL"
8254 pr " jobjectArray jr;\n";
8257 pr " jstring jstr;\n";
8258 pr " char **r;\n"; "NULL", "NULL"
8259 | RStruct (_, typ) ->
8260 pr " jobject jr;\n";
8262 pr " jfieldID fl;\n";
8263 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
8264 | RStructList (_, typ) ->
8265 pr " jobjectArray jr;\n";
8267 pr " jfieldID fl;\n";
8268 pr " jobject jfl;\n";
8269 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
8270 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
8272 pr " jstring jr;\n";
8274 pr " size_t size;\n";
8282 pr " const char *%s;\n" n
8284 pr " int %s_len;\n" n;
8285 pr " const char **%s;\n" n
8292 (match fst style with
8293 | RStringList _ | RStructList _ -> true
8294 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
8296 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
8297 List.exists (function StringList _ -> true | _ -> false) (snd style) in
8303 (* Get the parameters. *)
8309 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
8311 (* This is completely undocumented, but Java null becomes
8314 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
8316 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
8317 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
8318 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8319 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8321 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
8323 pr " %s[%s_len] = NULL;\n" n n;
8326 pr " %s = j%s;\n" n n
8329 (* Make the call. *)
8330 pr " r = guestfs_%s " name;
8331 generate_c_call_args ~handle:"g" style;
8334 (* Release the parameters. *)
8340 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8343 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
8345 pr " for (i = 0; i < %s_len; ++i) {\n" n;
8346 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
8348 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
8350 pr " free (%s);\n" n
8355 (* Check for errors. *)
8356 pr " if (r == %s) {\n" error_code;
8357 pr " throw_exception (env, guestfs_last_error (g));\n";
8358 pr " return %s;\n" no_ret;
8362 (match fst style with
8364 | RInt _ -> pr " return (jint) r;\n"
8365 | RBool _ -> pr " return (jboolean) r;\n"
8366 | RInt64 _ -> pr " return (jlong) r;\n"
8367 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
8368 | RConstOptString _ ->
8369 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
8371 pr " jr = (*env)->NewStringUTF (env, r);\n";
8375 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
8376 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
8377 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
8378 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
8379 pr " for (i = 0; i < r_len; ++i) {\n";
8380 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
8381 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
8382 pr " free (r[i]);\n";
8386 | RStruct (_, typ) ->
8387 let jtyp = java_name_of_struct typ in
8388 let cols = cols_of_struct typ in
8389 generate_java_struct_return typ jtyp cols
8390 | RStructList (_, typ) ->
8391 let jtyp = java_name_of_struct typ in
8392 let cols = cols_of_struct typ in
8393 generate_java_struct_list_return typ jtyp cols
8396 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
8397 pr " return NULL;\n"
8399 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
8408 and generate_java_struct_return typ jtyp cols =
8409 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8410 pr " jr = (*env)->AllocObject (env, cl);\n";
8414 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8415 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
8418 pr " char s[33];\n";
8419 pr " memcpy (s, r->%s, 32);\n" name;
8421 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8422 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8426 pr " int len = r->%s_len;\n" name;
8427 pr " char s[len+1];\n";
8428 pr " memcpy (s, r->%s, len);\n" name;
8429 pr " s[len] = 0;\n";
8430 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8431 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
8433 | name, (FBytes|FUInt64|FInt64) ->
8434 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8435 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8436 | name, (FUInt32|FInt32) ->
8437 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8438 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8439 | name, FOptPercent ->
8440 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8441 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
8443 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8444 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
8449 and generate_java_struct_list_return typ jtyp cols =
8450 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
8451 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
8452 pr " for (i = 0; i < r->len; ++i) {\n";
8453 pr " jfl = (*env)->AllocObject (env, cl);\n";
8457 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8458 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
8461 pr " char s[33];\n";
8462 pr " memcpy (s, r->val[i].%s, 32);\n" name;
8464 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8465 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8469 pr " int len = r->val[i].%s_len;\n" name;
8470 pr " char s[len+1];\n";
8471 pr " memcpy (s, r->val[i].%s, len);\n" name;
8472 pr " s[len] = 0;\n";
8473 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
8474 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
8476 | name, (FBytes|FUInt64|FInt64) ->
8477 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
8478 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8479 | name, (FUInt32|FInt32) ->
8480 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
8481 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8482 | name, FOptPercent ->
8483 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
8484 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
8486 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
8487 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
8489 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
8491 pr " guestfs_free_%s_list (r);\n" typ;
8494 and generate_haskell_hs () =
8495 generate_header HaskellStyle LGPLv2;
8497 (* XXX We only know how to generate partial FFI for Haskell
8498 * at the moment. Please help out!
8500 let can_generate style =
8504 | RInt64 _, _ -> true
8507 | RConstOptString _, _
8513 | RBufferOut _, _ -> false in
8516 {-# INCLUDE <guestfs.h> #-}
8517 {-# LANGUAGE ForeignFunctionInterface #-}
8522 (* List out the names of the actions we want to export. *)
8524 fun (name, style, _, _, _, _, _) ->
8525 if can_generate style then pr ",\n %s" name
8532 import Foreign.C.Types
8534 import Control.Exception
8535 import Data.Typeable
8537 data GuestfsS = GuestfsS -- represents the opaque C struct
8538 type GuestfsP = Ptr GuestfsS -- guestfs_h *
8539 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
8541 -- XXX define properly later XXX
8545 data IntBool = IntBool
8547 data StatVFS = StatVFS
8548 data Hashtable = Hashtable
8550 foreign import ccall unsafe \"guestfs_create\" c_create
8552 foreign import ccall unsafe \"&guestfs_close\" c_close
8553 :: FunPtr (GuestfsP -> IO ())
8554 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
8555 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
8557 create :: IO GuestfsH
8560 c_set_error_handler p nullPtr nullPtr
8561 h <- newForeignPtr c_close p
8564 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
8565 :: GuestfsP -> IO CString
8567 -- last_error :: GuestfsH -> IO (Maybe String)
8568 -- last_error h = do
8569 -- str <- withForeignPtr h (\\p -> c_last_error p)
8570 -- maybePeek peekCString str
8572 last_error :: GuestfsH -> IO (String)
8574 str <- withForeignPtr h (\\p -> c_last_error p)
8576 then return \"no error\"
8577 else peekCString str
8581 (* Generate wrappers for each foreign function. *)
8583 fun (name, style, _, _, _, _, _) ->
8584 if can_generate style then (
8585 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
8587 generate_haskell_prototype ~handle:"GuestfsP" style;
8591 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
8593 pr "%s %s = do\n" name
8594 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
8596 (* Convert pointer arguments using with* functions. *)
8601 | String n -> pr "withCString %s $ \\%s -> " n n
8602 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
8603 | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
8604 | Bool _ | Int _ -> ()
8606 (* Convert integer arguments. *)
8610 | Bool n -> sprintf "(fromBool %s)" n
8611 | Int n -> sprintf "(fromIntegral %s)" n
8612 | FileIn n | FileOut n | String n | OptString n | StringList n -> n
8614 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
8615 (String.concat " " ("p" :: args));
8616 (match fst style with
8617 | RErr | RInt _ | RInt64 _ | RBool _ ->
8618 pr " if (r == -1)\n";
8620 pr " err <- last_error h\n";
8622 | RConstString _ | RConstOptString _ | RString _
8623 | RStringList _ | RStruct _
8624 | RStructList _ | RHashtable _ | RBufferOut _ ->
8625 pr " if (r == nullPtr)\n";
8627 pr " err <- last_error h\n";
8630 (match fst style with
8632 pr " else return ()\n"
8634 pr " else return (fromIntegral r)\n"
8636 pr " else return (fromIntegral r)\n"
8638 pr " else return (toBool r)\n"
8647 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
8653 and generate_haskell_prototype ~handle ?(hs = false) style =
8655 let string = if hs then "String" else "CString" in
8656 let int = if hs then "Int" else "CInt" in
8657 let bool = if hs then "Bool" else "CInt" in
8658 let int64 = if hs then "Integer" else "Int64" in
8662 | String _ -> pr "%s" string
8663 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
8664 | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
8665 | Bool _ -> pr "%s" bool
8666 | Int _ -> pr "%s" int
8667 | FileIn _ -> pr "%s" string
8668 | FileOut _ -> pr "%s" string
8673 (match fst style with
8674 | RErr -> if not hs then pr "CInt"
8675 | RInt _ -> pr "%s" int
8676 | RInt64 _ -> pr "%s" int64
8677 | RBool _ -> pr "%s" bool
8678 | RConstString _ -> pr "%s" string
8679 | RConstOptString _ -> pr "Maybe %s" string
8680 | RString _ -> pr "%s" string
8681 | RStringList _ -> pr "[%s]" string
8682 | RStruct (_, typ) ->
8683 let name = java_name_of_struct typ in
8685 | RStructList (_, typ) ->
8686 let name = java_name_of_struct typ in
8688 | RHashtable _ -> pr "Hashtable"
8689 | RBufferOut _ -> pr "%s" string
8693 and generate_bindtests () =
8694 generate_header CStyle LGPLv2;
8699 #include <inttypes.h>
8702 #include \"guestfs.h\"
8703 #include \"guestfs_protocol.h\"
8705 #define error guestfs_error
8706 #define safe_calloc guestfs_safe_calloc
8707 #define safe_malloc guestfs_safe_malloc
8710 print_strings (char * const* const argv)
8715 for (argc = 0; argv[argc] != NULL; ++argc) {
8716 if (argc > 0) printf (\", \");
8717 printf (\"\\\"%%s\\\"\", argv[argc]);
8722 /* The test0 function prints its parameters to stdout. */
8726 match test_functions with
8727 | [] -> assert false
8728 | test0 :: tests -> test0, tests in
8731 let (name, style, _, _, _, _, _) = test0 in
8732 generate_prototype ~extern:false ~semicolon:false ~newline:true
8733 ~handle:"g" ~prefix:"guestfs_" name style;
8739 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
8740 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
8741 | StringList n -> pr " print_strings (%s);\n" n
8742 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
8743 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
8745 pr " /* Java changes stdout line buffering so we need this: */\n";
8746 pr " fflush (stdout);\n";
8752 fun (name, style, _, _, _, _, _) ->
8753 if String.sub name (String.length name - 3) 3 <> "err" then (
8754 pr "/* Test normal return. */\n";
8755 generate_prototype ~extern:false ~semicolon:false ~newline:true
8756 ~handle:"g" ~prefix:"guestfs_" name style;
8758 (match fst style with
8763 pr " sscanf (val, \"%%d\", &r);\n";
8767 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
8770 pr " return strcmp (val, \"true\") == 0;\n"
8772 | RConstOptString _ ->
8773 (* Can't return the input string here. Return a static
8774 * string so we ensure we get a segfault if the caller
8777 pr " return \"static string\";\n"
8779 pr " return strdup (val);\n"
8781 pr " char **strs;\n";
8783 pr " sscanf (val, \"%%d\", &n);\n";
8784 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
8785 pr " for (i = 0; i < n; ++i) {\n";
8786 pr " strs[i] = safe_malloc (g, 16);\n";
8787 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
8789 pr " strs[n] = NULL;\n";
8790 pr " return strs;\n"
8791 | RStruct (_, typ) ->
8792 pr " struct guestfs_%s *r;\n" typ;
8793 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8795 | RStructList (_, typ) ->
8796 pr " struct guestfs_%s_list *r;\n" typ;
8797 pr " r = safe_calloc (g, sizeof *r, 1);\n";
8798 pr " sscanf (val, \"%%d\", &r->len);\n";
8799 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
8802 pr " char **strs;\n";
8804 pr " sscanf (val, \"%%d\", &n);\n";
8805 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
8806 pr " for (i = 0; i < n; ++i) {\n";
8807 pr " strs[i*2] = safe_malloc (g, 16);\n";
8808 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
8809 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
8810 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
8812 pr " strs[n*2] = NULL;\n";
8813 pr " return strs;\n"
8815 pr " return strdup (val);\n"
8820 pr "/* Test error return. */\n";
8821 generate_prototype ~extern:false ~semicolon:false ~newline:true
8822 ~handle:"g" ~prefix:"guestfs_" name style;
8824 pr " error (g, \"error\");\n";
8825 (match fst style with
8826 | RErr | RInt _ | RInt64 _ | RBool _ ->
8828 | RConstString _ | RConstOptString _
8829 | RString _ | RStringList _ | RStruct _
8833 pr " return NULL;\n"
8840 and generate_ocaml_bindtests () =
8841 generate_header OCamlStyle GPLv2;
8845 let g = Guestfs.create () in
8852 | CallString s -> "\"" ^ s ^ "\""
8853 | CallOptString None -> "None"
8854 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
8855 | CallStringList xs ->
8856 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
8857 | CallInt i when i >= 0 -> string_of_int i
8858 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
8859 | CallBool b -> string_of_bool b
8864 generate_lang_bindtests (
8865 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
8868 pr "print_endline \"EOF\"\n"
8870 and generate_perl_bindtests () =
8871 pr "#!/usr/bin/perl -w\n";
8872 generate_header HashStyle GPLv2;
8879 my $g = Sys::Guestfs->new ();
8883 String.concat ", " (
8886 | CallString s -> "\"" ^ s ^ "\""
8887 | CallOptString None -> "undef"
8888 | CallOptString (Some s) -> sprintf "\"%s\"" s
8889 | CallStringList xs ->
8890 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8891 | CallInt i -> string_of_int i
8892 | CallBool b -> if b then "1" else "0"
8897 generate_lang_bindtests (
8898 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
8901 pr "print \"EOF\\n\"\n"
8903 and generate_python_bindtests () =
8904 generate_header HashStyle GPLv2;
8909 g = guestfs.GuestFS ()
8913 String.concat ", " (
8916 | CallString s -> "\"" ^ s ^ "\""
8917 | CallOptString None -> "None"
8918 | CallOptString (Some s) -> sprintf "\"%s\"" s
8919 | CallStringList xs ->
8920 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8921 | CallInt i -> string_of_int i
8922 | CallBool b -> if b then "1" else "0"
8927 generate_lang_bindtests (
8928 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
8931 pr "print \"EOF\"\n"
8933 and generate_ruby_bindtests () =
8934 generate_header HashStyle GPLv2;
8939 g = Guestfs::create()
8943 String.concat ", " (
8946 | CallString s -> "\"" ^ s ^ "\""
8947 | CallOptString None -> "nil"
8948 | CallOptString (Some s) -> sprintf "\"%s\"" s
8949 | CallStringList xs ->
8950 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
8951 | CallInt i -> string_of_int i
8952 | CallBool b -> string_of_bool b
8957 generate_lang_bindtests (
8958 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
8961 pr "print \"EOF\\n\"\n"
8963 and generate_java_bindtests () =
8964 generate_header CStyle GPLv2;
8967 import com.redhat.et.libguestfs.*;
8969 public class Bindtests {
8970 public static void main (String[] argv)
8973 GuestFS g = new GuestFS ();
8977 String.concat ", " (
8980 | CallString s -> "\"" ^ s ^ "\""
8981 | CallOptString None -> "null"
8982 | CallOptString (Some s) -> sprintf "\"%s\"" s
8983 | CallStringList xs ->
8985 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
8986 | CallInt i -> string_of_int i
8987 | CallBool b -> string_of_bool b
8992 generate_lang_bindtests (
8993 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
8997 System.out.println (\"EOF\");
8999 catch (Exception exn) {
9000 System.err.println (exn);
9007 and generate_haskell_bindtests () =
9008 generate_header HaskellStyle GPLv2;
9011 module Bindtests where
9012 import qualified Guestfs
9022 | CallString s -> "\"" ^ s ^ "\""
9023 | CallOptString None -> "Nothing"
9024 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
9025 | CallStringList xs ->
9026 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
9027 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
9028 | CallInt i -> string_of_int i
9029 | CallBool true -> "True"
9030 | CallBool false -> "False"
9035 generate_lang_bindtests (
9036 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
9039 pr " putStrLn \"EOF\"\n"
9041 (* Language-independent bindings tests - we do it this way to
9042 * ensure there is parity in testing bindings across all languages.
9044 and generate_lang_bindtests call =
9045 call "test0" [CallString "abc"; CallOptString (Some "def");
9046 CallStringList []; CallBool false;
9047 CallInt 0; CallString "123"; CallString "456"];
9048 call "test0" [CallString "abc"; CallOptString None;
9049 CallStringList []; CallBool false;
9050 CallInt 0; CallString "123"; CallString "456"];
9051 call "test0" [CallString ""; CallOptString (Some "def");
9052 CallStringList []; CallBool false;
9053 CallInt 0; CallString "123"; CallString "456"];
9054 call "test0" [CallString ""; CallOptString (Some "");
9055 CallStringList []; CallBool false;
9056 CallInt 0; CallString "123"; CallString "456"];
9057 call "test0" [CallString "abc"; CallOptString (Some "def");
9058 CallStringList ["1"]; CallBool false;
9059 CallInt 0; CallString "123"; CallString "456"];
9060 call "test0" [CallString "abc"; CallOptString (Some "def");
9061 CallStringList ["1"; "2"]; CallBool false;
9062 CallInt 0; CallString "123"; CallString "456"];
9063 call "test0" [CallString "abc"; CallOptString (Some "def");
9064 CallStringList ["1"]; CallBool true;
9065 CallInt 0; CallString "123"; CallString "456"];
9066 call "test0" [CallString "abc"; CallOptString (Some "def");
9067 CallStringList ["1"]; CallBool false;
9068 CallInt (-1); CallString "123"; CallString "456"];
9069 call "test0" [CallString "abc"; CallOptString (Some "def");
9070 CallStringList ["1"]; CallBool false;
9071 CallInt (-2); CallString "123"; CallString "456"];
9072 call "test0" [CallString "abc"; CallOptString (Some "def");
9073 CallStringList ["1"]; CallBool false;
9074 CallInt 1; CallString "123"; CallString "456"];
9075 call "test0" [CallString "abc"; CallOptString (Some "def");
9076 CallStringList ["1"]; CallBool false;
9077 CallInt 2; CallString "123"; CallString "456"];
9078 call "test0" [CallString "abc"; CallOptString (Some "def");
9079 CallStringList ["1"]; CallBool false;
9080 CallInt 4095; CallString "123"; CallString "456"];
9081 call "test0" [CallString "abc"; CallOptString (Some "def");
9082 CallStringList ["1"]; CallBool false;
9083 CallInt 0; CallString ""; CallString ""]
9085 (* XXX Add here tests of the return and error functions. *)
9087 (* This is used to generate the src/MAX_PROC_NR file which
9088 * contains the maximum procedure number, a surrogate for the
9089 * ABI version number. See src/Makefile.am for the details.
9091 and generate_max_proc_nr () =
9092 let proc_nrs = List.map (
9093 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
9094 ) daemon_functions in
9096 let max_proc_nr = List.fold_left max 0 proc_nrs in
9098 pr "%d\n" max_proc_nr
9100 let output_to filename =
9101 let filename_new = filename ^ ".new" in
9102 chan := open_out filename_new;
9107 (* Is the new file different from the current file? *)
9108 if Sys.file_exists filename && files_equal filename filename_new then
9109 Unix.unlink filename_new (* same, so skip it *)
9111 (* different, overwrite old one *)
9112 (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
9113 Unix.rename filename_new filename;
9114 Unix.chmod filename 0o444;
9115 printf "written %s\n%!" filename;
9124 if not (Sys.file_exists "HACKING") then (
9126 You are probably running this from the wrong directory.
9127 Run it from the top source directory using the command
9133 let close = output_to "src/guestfs_protocol.x" in
9137 let close = output_to "src/guestfs-structs.h" in
9138 generate_structs_h ();
9141 let close = output_to "src/guestfs-actions.h" in
9142 generate_actions_h ();
9145 let close = output_to "src/guestfs-actions.c" in
9146 generate_client_actions ();
9149 let close = output_to "daemon/actions.h" in
9150 generate_daemon_actions_h ();
9153 let close = output_to "daemon/stubs.c" in
9154 generate_daemon_actions ();
9157 let close = output_to "daemon/names.c" in
9158 generate_daemon_names ();
9161 let close = output_to "capitests/tests.c" in
9165 let close = output_to "src/guestfs-bindtests.c" in
9166 generate_bindtests ();
9169 let close = output_to "fish/cmds.c" in
9170 generate_fish_cmds ();
9173 let close = output_to "fish/completion.c" in
9174 generate_fish_completion ();
9177 let close = output_to "guestfs-structs.pod" in
9178 generate_structs_pod ();
9181 let close = output_to "guestfs-actions.pod" in
9182 generate_actions_pod ();
9185 let close = output_to "guestfish-actions.pod" in
9186 generate_fish_actions_pod ();
9189 let close = output_to "ocaml/guestfs.mli" in
9190 generate_ocaml_mli ();
9193 let close = output_to "ocaml/guestfs.ml" in
9194 generate_ocaml_ml ();
9197 let close = output_to "ocaml/guestfs_c_actions.c" in
9198 generate_ocaml_c ();
9201 let close = output_to "ocaml/bindtests.ml" in
9202 generate_ocaml_bindtests ();
9205 let close = output_to "perl/Guestfs.xs" in
9206 generate_perl_xs ();
9209 let close = output_to "perl/lib/Sys/Guestfs.pm" in
9210 generate_perl_pm ();
9213 let close = output_to "perl/bindtests.pl" in
9214 generate_perl_bindtests ();
9217 let close = output_to "python/guestfs-py.c" in
9218 generate_python_c ();
9221 let close = output_to "python/guestfs.py" in
9222 generate_python_py ();
9225 let close = output_to "python/bindtests.py" in
9226 generate_python_bindtests ();
9229 let close = output_to "ruby/ext/guestfs/_guestfs.c" in
9233 let close = output_to "ruby/bindtests.rb" in
9234 generate_ruby_bindtests ();
9237 let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
9238 generate_java_java ();
9243 let cols = cols_of_struct typ in
9244 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
9245 let close = output_to filename in
9246 generate_java_struct jtyp cols;
9250 let close = output_to "java/Makefile.inc" in
9251 pr "java_built_sources =";
9254 pr " com/redhat/et/libguestfs/%s.java" jtyp;
9256 pr " com/redhat/et/libguestfs/GuestFS.java\n";
9259 let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
9263 let close = output_to "java/Bindtests.java" in
9264 generate_java_bindtests ();
9267 let close = output_to "haskell/Guestfs.hs" in
9268 generate_haskell_hs ();
9271 let close = output_to "haskell/Bindtests.hs" in
9272 generate_haskell_bindtests ();
9275 let close = output_to "src/MAX_PROC_NR" in
9276 generate_max_proc_nr ();
9279 (* Always generate this file last, and unconditionally. It's used
9280 * by the Makefile to know when we must re-run the generator.
9282 let chan = open_out "src/stamp-generator" in